1//===-- llvm/MC/MCObjectFileInfo.h - Object File Info -----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file describes common object file formats.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_MC_MCOBJECTFILEINFO_H
14#define LLVM_MC_MCOBJECTFILEINFO_H
15
16#include "llvm/BinaryFormat/Swift.h"
17#include "llvm/MC/MCSection.h"
18#include "llvm/Support/VersionTuple.h"
19#include "llvm/TargetParser/Triple.h"
20
21#include <array>
22#include <optional>
23
24namespace llvm {
25class MCContext;
26class MCSection;
27
28class MCObjectFileInfo {
29protected:
30 /// True if target object file supports a weak_definition of constant 0 for an
31 /// omitted EH frame.
32 bool SupportsWeakOmittedEHFrame = false;
33
34 /// True if the target object file supports emitting a compact unwind section
35 /// without an associated EH frame section.
36 bool SupportsCompactUnwindWithoutEHFrame = false;
37
38 /// OmitDwarfIfHaveCompactUnwind - True if the target object file
39 /// supports having some functions with compact unwind and other with
40 /// dwarf unwind.
41 bool OmitDwarfIfHaveCompactUnwind = false;
42
43 /// FDE CFI encoding. Controls the encoding of the begin label in the
44 /// .eh_frame section. Unlike the LSDA encoding, personality encoding, and
45 /// type encodings, this is something that the assembler just "knows" about
46 /// its target
47 unsigned FDECFIEncoding = 0;
48
49 /// Compact unwind encoding indicating that we should emit only an EH frame.
50 unsigned CompactUnwindDwarfEHFrameOnly = 0;
51
52 /// Section directive for standard text.
53 MCSection *TextSection = nullptr;
54
55 /// Section directive for standard data.
56 MCSection *DataSection = nullptr;
57
58 /// Section that is default initialized to zero.
59 MCSection *BSSSection = nullptr;
60
61 /// Section that is readonly and can contain arbitrary initialized data.
62 /// Targets are not required to have a readonly section. If they don't,
63 /// various bits of code will fall back to using the data section for
64 /// constants.
65 MCSection *ReadOnlySection = nullptr;
66
67 /// If exception handling is supported by the target, this is the section the
68 /// Language Specific Data Area information is emitted to.
69 MCSection *LSDASection = nullptr;
70
71 /// If exception handling is supported by the target and the target can
72 /// support a compact representation of the CIE and FDE, this is the section
73 /// to emit them into.
74 MCSection *CompactUnwindSection = nullptr;
75
76 // Dwarf sections for debug info. If a target supports debug info, these must
77 // be set.
78 MCSection *DwarfAbbrevSection = nullptr;
79 MCSection *DwarfInfoSection = nullptr;
80 MCSection *DwarfLineSection = nullptr;
81 MCSection *DwarfLineStrSection = nullptr;
82 MCSection *DwarfFrameSection = nullptr;
83 MCSection *DwarfPubTypesSection = nullptr;
84 const MCSection *DwarfDebugInlineSection = nullptr;
85 MCSection *DwarfStrSection = nullptr;
86 MCSection *DwarfLocSection = nullptr;
87 MCSection *DwarfARangesSection = nullptr;
88 MCSection *DwarfRangesSection = nullptr;
89 MCSection *DwarfMacinfoSection = nullptr;
90 MCSection *DwarfMacroSection = nullptr;
91 // The pubnames section is no longer generated by default. The generation
92 // can be enabled by a compiler flag.
93 MCSection *DwarfPubNamesSection = nullptr;
94
95 /// Accelerator table sections. DwarfDebugNamesSection is the DWARF v5
96 /// accelerator table, while DwarfAccelNamesSection, DwarfAccelObjCSection,
97 /// DwarfAccelNamespaceSection, DwarfAccelTypesSection are pre-DWARF v5
98 /// extensions.
99 MCSection *DwarfDebugNamesSection = nullptr;
100 MCSection *DwarfAccelNamesSection = nullptr;
101 MCSection *DwarfAccelObjCSection = nullptr;
102 MCSection *DwarfAccelNamespaceSection = nullptr;
103 MCSection *DwarfAccelTypesSection = nullptr;
104
105 // These are used for the Fission separate debug information files.
106 MCSection *DwarfInfoDWOSection = nullptr;
107 MCSection *DwarfTypesDWOSection = nullptr;
108 MCSection *DwarfAbbrevDWOSection = nullptr;
109 MCSection *DwarfStrDWOSection = nullptr;
110 MCSection *DwarfLineDWOSection = nullptr;
111 MCSection *DwarfLocDWOSection = nullptr;
112 MCSection *DwarfStrOffDWOSection = nullptr;
113 MCSection *DwarfMacinfoDWOSection = nullptr;
114 MCSection *DwarfMacroDWOSection = nullptr;
115
116 /// The DWARF v5 string offset and address table sections.
117 MCSection *DwarfStrOffSection = nullptr;
118 MCSection *DwarfAddrSection = nullptr;
119 /// The DWARF v5 range list section.
120 MCSection *DwarfRnglistsSection = nullptr;
121 /// The DWARF v5 locations list section.
122 MCSection *DwarfLoclistsSection = nullptr;
123
124 /// The DWARF v5 range and location list sections for fission.
125 MCSection *DwarfRnglistsDWOSection = nullptr;
126 MCSection *DwarfLoclistsDWOSection = nullptr;
127
128 // These are for Fission DWP files.
129 MCSection *DwarfCUIndexSection = nullptr;
130 MCSection *DwarfTUIndexSection = nullptr;
131
132 /// Section for newer gnu pubnames.
133 MCSection *DwarfGnuPubNamesSection = nullptr;
134 /// Section for newer gnu pubtypes.
135 MCSection *DwarfGnuPubTypesSection = nullptr;
136
137 // Section for Swift AST
138 MCSection *DwarfSwiftASTSection = nullptr;
139
140 MCSection *COFFDebugSymbolsSection = nullptr;
141 MCSection *COFFDebugTypesSection = nullptr;
142 MCSection *COFFGlobalTypeHashesSection = nullptr;
143
144 /// Extra TLS Variable Data section.
145 ///
146 /// If the target needs to put additional information for a TLS variable,
147 /// it'll go here.
148 MCSection *TLSExtraDataSection = nullptr;
149
150 /// Section directive for Thread Local data. ELF, MachO, COFF, and Wasm.
151 MCSection *TLSDataSection = nullptr; // Defaults to ".tdata".
152
153 /// Section directive for Thread Local uninitialized data.
154 ///
155 /// Null if this target doesn't support a BSS section. ELF and MachO only.
156 MCSection *TLSBSSSection = nullptr; // Defaults to ".tbss".
157
158 /// StackMap section.
159 MCSection *StackMapSection = nullptr;
160
161 /// FaultMap section.
162 MCSection *FaultMapSection = nullptr;
163
164 /// Remarks section.
165 MCSection *RemarksSection = nullptr;
166
167 /// EH frame section.
168 ///
169 /// It is initialized on demand so it can be overwritten (with uniquing).
170 MCSection *EHFrameSection = nullptr;
171
172 /// Section containing metadata on function stack sizes.
173 MCSection *StackSizesSection = nullptr;
174
175 /// Section for pseudo probe information used by AutoFDO
176 MCSection *PseudoProbeSection = nullptr;
177 MCSection *PseudoProbeDescSection = nullptr;
178
179 // Section for metadata of llvm statistics.
180 MCSection *LLVMStatsSection = nullptr;
181
182 // ELF specific sections.
183 MCSection *DataRelROSection = nullptr;
184 MCSection *MergeableConst4Section = nullptr;
185 MCSection *MergeableConst8Section = nullptr;
186 MCSection *MergeableConst16Section = nullptr;
187 MCSection *MergeableConst32Section = nullptr;
188
189 // MachO specific sections.
190
191 /// Section for thread local structure information.
192 ///
193 /// Contains the source code name of the variable, visibility and a pointer to
194 /// the initial value (.tdata or .tbss).
195 MCSection *TLSTLVSection = nullptr; // Defaults to ".tlv".
196
197 /// Section for thread local data initialization functions.
198 // Defaults to ".thread_init_func".
199 const MCSection *TLSThreadInitSection = nullptr;
200
201 MCSection *CStringSection = nullptr;
202 MCSection *UStringSection = nullptr;
203 MCSection *TextCoalSection = nullptr;
204 MCSection *ConstTextCoalSection = nullptr;
205 MCSection *ConstDataSection = nullptr;
206 MCSection *DataCoalSection = nullptr;
207 MCSection *ConstDataCoalSection = nullptr;
208 MCSection *DataCommonSection = nullptr;
209 MCSection *DataBSSSection = nullptr;
210 MCSection *FourByteConstantSection = nullptr;
211 MCSection *EightByteConstantSection = nullptr;
212 MCSection *SixteenByteConstantSection = nullptr;
213 MCSection *LazySymbolPointerSection = nullptr;
214 MCSection *NonLazySymbolPointerSection = nullptr;
215 MCSection *ThreadLocalPointerSection = nullptr;
216 MCSection *AddrSigSection = nullptr;
217
218 /// COFF specific sections.
219 MCSection *DrectveSection = nullptr;
220 MCSection *PDataSection = nullptr;
221 MCSection *XDataSection = nullptr;
222 MCSection *SXDataSection = nullptr;
223 MCSection *GEHContSection = nullptr;
224 MCSection *GFIDsSection = nullptr;
225 MCSection *GIATsSection = nullptr;
226 MCSection *GLJMPSection = nullptr;
227
228 // GOFF specific sections.
229 MCSection *PPA1Section = nullptr;
230 MCSection *PPA2Section = nullptr;
231 MCSection *PPA2ListSection = nullptr;
232 MCSection *ADASection = nullptr;
233 MCSection *IDRLSection = nullptr;
234
235 // XCOFF specific sections
236 MCSection *TOCBaseSection = nullptr;
237 MCSection *ReadOnly8Section = nullptr;
238 MCSection *ReadOnly16Section = nullptr;
239
240 // Swift5 Reflection Data Sections
241 std::array<MCSection *, binaryformat::Swift5ReflectionSectionKind::last>
242 Swift5ReflectionSections = {};
243
244public:
245 void initMCObjectFileInfo(MCContext &MCCtx, bool PIC,
246 bool LargeCodeModel = false);
247 virtual ~MCObjectFileInfo();
248 MCContext &getContext() const { return *Ctx; }
249
250 bool getSupportsWeakOmittedEHFrame() const {
251 return SupportsWeakOmittedEHFrame;
252 }
253 bool getSupportsCompactUnwindWithoutEHFrame() const {
254 return SupportsCompactUnwindWithoutEHFrame;
255 }
256 bool getOmitDwarfIfHaveCompactUnwind() const {
257 return OmitDwarfIfHaveCompactUnwind;
258 }
259
260 unsigned getFDEEncoding() const { return FDECFIEncoding; }
261
262 unsigned getCompactUnwindDwarfEHFrameOnly() const {
263 return CompactUnwindDwarfEHFrameOnly;
264 }
265
266 virtual unsigned getTextSectionAlignment() const { return 4; }
267 MCSection *getTextSection() const { return TextSection; }
268 MCSection *getDataSection() const { return DataSection; }
269 MCSection *getBSSSection() const { return BSSSection; }
270 MCSection *getReadOnlySection() const { return ReadOnlySection; }
271 MCSection *getLSDASection() const { return LSDASection; }
272 MCSection *getCompactUnwindSection() const { return CompactUnwindSection; }
273 MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
274 MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
275 MCSection *getDwarfInfoSection(uint64_t Hash) const {
276 return getDwarfComdatSection(Name: ".debug_info", Hash);
277 }
278 MCSection *getDwarfLineSection() const { return DwarfLineSection; }
279 MCSection *getDwarfLineStrSection() const { return DwarfLineStrSection; }
280 MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
281 MCSection *getDwarfPubNamesSection() const { return DwarfPubNamesSection; }
282 MCSection *getDwarfPubTypesSection() const { return DwarfPubTypesSection; }
283 MCSection *getDwarfGnuPubNamesSection() const {
284 return DwarfGnuPubNamesSection;
285 }
286 MCSection *getDwarfGnuPubTypesSection() const {
287 return DwarfGnuPubTypesSection;
288 }
289 const MCSection *getDwarfDebugInlineSection() const {
290 return DwarfDebugInlineSection;
291 }
292 MCSection *getDwarfStrSection() const { return DwarfStrSection; }
293 MCSection *getDwarfLocSection() const { return DwarfLocSection; }
294 MCSection *getDwarfARangesSection() const { return DwarfARangesSection; }
295 MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
296 MCSection *getDwarfRnglistsSection() const { return DwarfRnglistsSection; }
297 MCSection *getDwarfLoclistsSection() const { return DwarfLoclistsSection; }
298 MCSection *getDwarfMacinfoSection() const { return DwarfMacinfoSection; }
299 MCSection *getDwarfMacroSection() const { return DwarfMacroSection; }
300
301 MCSection *getDwarfDebugNamesSection() const {
302 return DwarfDebugNamesSection;
303 }
304 MCSection *getDwarfAccelNamesSection() const {
305 return DwarfAccelNamesSection;
306 }
307 MCSection *getDwarfAccelObjCSection() const { return DwarfAccelObjCSection; }
308 MCSection *getDwarfAccelNamespaceSection() const {
309 return DwarfAccelNamespaceSection;
310 }
311 MCSection *getDwarfAccelTypesSection() const {
312 return DwarfAccelTypesSection;
313 }
314 MCSection *getDwarfInfoDWOSection() const { return DwarfInfoDWOSection; }
315 MCSection *getDwarfTypesSection(uint64_t Hash) const {
316 return getDwarfComdatSection(Name: ".debug_types", Hash);
317 }
318 MCSection *getDwarfTypesDWOSection() const { return DwarfTypesDWOSection; }
319 MCSection *getDwarfAbbrevDWOSection() const { return DwarfAbbrevDWOSection; }
320 MCSection *getDwarfStrDWOSection() const { return DwarfStrDWOSection; }
321 MCSection *getDwarfLineDWOSection() const { return DwarfLineDWOSection; }
322 MCSection *getDwarfLocDWOSection() const { return DwarfLocDWOSection; }
323 MCSection *getDwarfStrOffDWOSection() const { return DwarfStrOffDWOSection; }
324 MCSection *getDwarfStrOffSection() const { return DwarfStrOffSection; }
325 MCSection *getDwarfAddrSection() const { return DwarfAddrSection; }
326 MCSection *getDwarfRnglistsDWOSection() const {
327 return DwarfRnglistsDWOSection;
328 }
329 MCSection *getDwarfLoclistsDWOSection() const {
330 return DwarfLoclistsDWOSection;
331 }
332 MCSection *getDwarfMacroDWOSection() const { return DwarfMacroDWOSection; }
333 MCSection *getDwarfMacinfoDWOSection() const {
334 return DwarfMacinfoDWOSection;
335 }
336 MCSection *getDwarfCUIndexSection() const { return DwarfCUIndexSection; }
337 MCSection *getDwarfTUIndexSection() const { return DwarfTUIndexSection; }
338 MCSection *getDwarfSwiftASTSection() const { return DwarfSwiftASTSection; }
339
340 MCSection *getCOFFDebugSymbolsSection() const {
341 return COFFDebugSymbolsSection;
342 }
343 MCSection *getCOFFDebugTypesSection() const {
344 return COFFDebugTypesSection;
345 }
346 MCSection *getCOFFGlobalTypeHashesSection() const {
347 return COFFGlobalTypeHashesSection;
348 }
349
350 MCSection *getTLSExtraDataSection() const { return TLSExtraDataSection; }
351 const MCSection *getTLSDataSection() const { return TLSDataSection; }
352 MCSection *getTLSBSSSection() const { return TLSBSSSection; }
353
354 MCSection *getStackMapSection() const { return StackMapSection; }
355 MCSection *getFaultMapSection() const { return FaultMapSection; }
356 MCSection *getRemarksSection() const { return RemarksSection; }
357
358 MCSection *getStackSizesSection(const MCSection &TextSec) const;
359
360 MCSection *getBBAddrMapSection(const MCSection &TextSec) const;
361
362 MCSection *getKCFITrapSection(const MCSection &TextSec) const;
363
364 MCSection *getPseudoProbeSection(const MCSection &TextSec) const;
365
366 MCSection *getPseudoProbeDescSection(StringRef FuncName) const;
367
368 MCSection *getLLVMStatsSection() const;
369
370 MCSection *getPCSection(StringRef Name, const MCSection *TextSec) const;
371
372 // ELF specific sections.
373 MCSection *getDataRelROSection() const { return DataRelROSection; }
374 const MCSection *getMergeableConst4Section() const {
375 return MergeableConst4Section;
376 }
377 const MCSection *getMergeableConst8Section() const {
378 return MergeableConst8Section;
379 }
380 const MCSection *getMergeableConst16Section() const {
381 return MergeableConst16Section;
382 }
383 const MCSection *getMergeableConst32Section() const {
384 return MergeableConst32Section;
385 }
386
387 // MachO specific sections.
388 const MCSection *getTLSTLVSection() const { return TLSTLVSection; }
389 const MCSection *getTLSThreadInitSection() const {
390 return TLSThreadInitSection;
391 }
392 const MCSection *getCStringSection() const { return CStringSection; }
393 const MCSection *getUStringSection() const { return UStringSection; }
394 MCSection *getTextCoalSection() const { return TextCoalSection; }
395 const MCSection *getConstTextCoalSection() const {
396 return ConstTextCoalSection;
397 }
398 const MCSection *getConstDataSection() const { return ConstDataSection; }
399 const MCSection *getDataCoalSection() const { return DataCoalSection; }
400 const MCSection *getConstDataCoalSection() const {
401 return ConstDataCoalSection;
402 }
403 const MCSection *getDataCommonSection() const { return DataCommonSection; }
404 MCSection *getDataBSSSection() const { return DataBSSSection; }
405 const MCSection *getFourByteConstantSection() const {
406 return FourByteConstantSection;
407 }
408 const MCSection *getEightByteConstantSection() const {
409 return EightByteConstantSection;
410 }
411 const MCSection *getSixteenByteConstantSection() const {
412 return SixteenByteConstantSection;
413 }
414 MCSection *getLazySymbolPointerSection() const {
415 return LazySymbolPointerSection;
416 }
417 MCSection *getNonLazySymbolPointerSection() const {
418 return NonLazySymbolPointerSection;
419 }
420 MCSection *getThreadLocalPointerSection() const {
421 return ThreadLocalPointerSection;
422 }
423 MCSection *getAddrSigSection() const { return AddrSigSection; }
424
425 // COFF specific sections.
426 MCSection *getDrectveSection() const { return DrectveSection; }
427 MCSection *getPDataSection() const { return PDataSection; }
428 MCSection *getXDataSection() const { return XDataSection; }
429 MCSection *getSXDataSection() const { return SXDataSection; }
430 MCSection *getGEHContSection() const { return GEHContSection; }
431 MCSection *getGFIDsSection() const { return GFIDsSection; }
432 MCSection *getGIATsSection() const { return GIATsSection; }
433 MCSection *getGLJMPSection() const { return GLJMPSection; }
434
435 // GOFF specific sections.
436 MCSection *getPPA1Section() const { return PPA1Section; }
437 MCSection *getPPA2Section() const { return PPA2Section; }
438 MCSection *getPPA2ListSection() const { return PPA2ListSection; }
439 MCSection *getADASection() const { return ADASection; }
440 MCSection *getIDRLSection() const { return IDRLSection; }
441
442 // XCOFF specific sections
443 MCSection *getTOCBaseSection() const { return TOCBaseSection; }
444
445 MCSection *getEHFrameSection() const { return EHFrameSection; }
446
447 bool isPositionIndependent() const { return PositionIndependent; }
448
449 // Swift5 Reflection Data Sections
450 MCSection *getSwift5ReflectionSection(
451 llvm::binaryformat::Swift5ReflectionSectionKind ReflSectionKind) {
452 return ReflSectionKind !=
453 llvm::binaryformat::Swift5ReflectionSectionKind::unknown
454 ? Swift5ReflectionSections[ReflSectionKind]
455 : nullptr;
456 }
457
458private:
459 bool PositionIndependent = false;
460 MCContext *Ctx = nullptr;
461 VersionTuple SDKVersion;
462 std::optional<Triple> DarwinTargetVariantTriple;
463 VersionTuple DarwinTargetVariantSDKVersion;
464
465 void initMachOMCObjectFileInfo(const Triple &T);
466 void initELFMCObjectFileInfo(const Triple &T, bool Large);
467 void initGOFFMCObjectFileInfo(const Triple &T);
468 void initCOFFMCObjectFileInfo(const Triple &T);
469 void initSPIRVMCObjectFileInfo(const Triple &T);
470 void initWasmMCObjectFileInfo(const Triple &T);
471 void initXCOFFMCObjectFileInfo(const Triple &T);
472 void initDXContainerObjectFileInfo(const Triple &T);
473 MCSection *getDwarfComdatSection(const char *Name, uint64_t Hash) const;
474
475public:
476 void setSDKVersion(const VersionTuple &TheSDKVersion) {
477 SDKVersion = TheSDKVersion;
478 }
479
480 const VersionTuple &getSDKVersion() const { return SDKVersion; }
481
482 void setDarwinTargetVariantTriple(const Triple &T) {
483 DarwinTargetVariantTriple = T;
484 }
485
486 const Triple *getDarwinTargetVariantTriple() const {
487 return DarwinTargetVariantTriple ? &*DarwinTargetVariantTriple : nullptr;
488 }
489
490 void setDarwinTargetVariantSDKVersion(const VersionTuple &TheSDKVersion) {
491 DarwinTargetVariantSDKVersion = TheSDKVersion;
492 }
493
494 const VersionTuple &getDarwinTargetVariantSDKVersion() const {
495 return DarwinTargetVariantSDKVersion;
496 }
497};
498
499} // end namespace llvm
500
501#endif
502

source code of llvm/include/llvm/MC/MCObjectFileInfo.h