xref: /llvm-project/llvm/include/llvm/MC/MCObjectFileInfo.h (revision 283dca56f8dddbf2f144730a01675c94b04f57cb) 
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 
24 namespace llvm {
25 class MCContext;
26 class MCSection;
27 
28 class MCObjectFileInfo {
29 protected:
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   /// If import call optimization is supported by the target, this is the
77   /// section to emit import call data to.
78   MCSection *ImportCallSection = nullptr;
79 
80   // Dwarf sections for debug info.  If a target supports debug info, these must
81   // be set.
82   MCSection *DwarfAbbrevSection = nullptr;
83   MCSection *DwarfInfoSection = nullptr;
84   MCSection *DwarfLineSection = nullptr;
85   MCSection *DwarfLineStrSection = nullptr;
86   MCSection *DwarfFrameSection = nullptr;
87   MCSection *DwarfPubTypesSection = nullptr;
88   const MCSection *DwarfDebugInlineSection = nullptr;
89   MCSection *DwarfStrSection = nullptr;
90   MCSection *DwarfLocSection = nullptr;
91   MCSection *DwarfARangesSection = nullptr;
92   MCSection *DwarfRangesSection = nullptr;
93   MCSection *DwarfMacinfoSection = nullptr;
94   MCSection *DwarfMacroSection = nullptr;
95   // The pubnames section is no longer generated by default.  The generation
96   // can be enabled by a compiler flag.
97   MCSection *DwarfPubNamesSection = nullptr;
98 
99   /// Accelerator table sections. DwarfDebugNamesSection is the DWARF v5
100   /// accelerator table, while DwarfAccelNamesSection, DwarfAccelObjCSection,
101   /// DwarfAccelNamespaceSection, DwarfAccelTypesSection are pre-DWARF v5
102   /// extensions.
103   MCSection *DwarfDebugNamesSection = nullptr;
104   MCSection *DwarfAccelNamesSection = nullptr;
105   MCSection *DwarfAccelObjCSection = nullptr;
106   MCSection *DwarfAccelNamespaceSection = nullptr;
107   MCSection *DwarfAccelTypesSection = nullptr;
108 
109   // These are used for the Fission separate debug information files.
110   MCSection *DwarfInfoDWOSection = nullptr;
111   MCSection *DwarfTypesDWOSection = nullptr;
112   MCSection *DwarfAbbrevDWOSection = nullptr;
113   MCSection *DwarfStrDWOSection = nullptr;
114   MCSection *DwarfLineDWOSection = nullptr;
115   MCSection *DwarfLocDWOSection = nullptr;
116   MCSection *DwarfStrOffDWOSection = nullptr;
117   MCSection *DwarfMacinfoDWOSection = nullptr;
118   MCSection *DwarfMacroDWOSection = nullptr;
119 
120   /// The DWARF v5 string offset and address table sections.
121   MCSection *DwarfStrOffSection = nullptr;
122   MCSection *DwarfAddrSection = nullptr;
123   /// The DWARF v5 range list section.
124   MCSection *DwarfRnglistsSection = nullptr;
125   /// The DWARF v5 locations list section.
126   MCSection *DwarfLoclistsSection = nullptr;
127 
128   /// The DWARF v5 range and location list sections for fission.
129   MCSection *DwarfRnglistsDWOSection = nullptr;
130   MCSection *DwarfLoclistsDWOSection = nullptr;
131 
132   // These are for Fission DWP files.
133   MCSection *DwarfCUIndexSection = nullptr;
134   MCSection *DwarfTUIndexSection = nullptr;
135 
136   /// Section for newer gnu pubnames.
137   MCSection *DwarfGnuPubNamesSection = nullptr;
138   /// Section for newer gnu pubtypes.
139   MCSection *DwarfGnuPubTypesSection = nullptr;
140 
141   // Section for Swift AST
142   MCSection *DwarfSwiftASTSection = nullptr;
143 
144   MCSection *COFFDebugSymbolsSection = nullptr;
145   MCSection *COFFDebugTypesSection = nullptr;
146   MCSection *COFFGlobalTypeHashesSection = nullptr;
147 
148   /// Extra TLS Variable Data section.
149   ///
150   /// If the target needs to put additional information for a TLS variable,
151   /// it'll go here.
152   MCSection *TLSExtraDataSection = nullptr;
153 
154   /// Section directive for Thread Local data. ELF, MachO, COFF, and Wasm.
155   MCSection *TLSDataSection = nullptr; // Defaults to ".tdata".
156 
157   /// Section directive for Thread Local uninitialized data.
158   ///
159   /// Null if this target doesn't support a BSS section. ELF and MachO only.
160   MCSection *TLSBSSSection = nullptr; // Defaults to ".tbss".
161 
162   /// StackMap section.
163   MCSection *StackMapSection = nullptr;
164 
165   /// FaultMap section.
166   MCSection *FaultMapSection = nullptr;
167 
168   /// Remarks section.
169   MCSection *RemarksSection = nullptr;
170 
171   /// EH frame section.
172   ///
173   /// It is initialized on demand so it can be overwritten (with uniquing).
174   MCSection *EHFrameSection = nullptr;
175 
176   /// Section containing metadata on function stack sizes.
177   MCSection *StackSizesSection = nullptr;
178 
179   /// Section for pseudo probe information used by AutoFDO
180   MCSection *PseudoProbeSection = nullptr;
181   MCSection *PseudoProbeDescSection = nullptr;
182 
183   // Section for metadata of llvm statistics.
184   MCSection *LLVMStatsSection = nullptr;
185 
186   // ELF specific sections.
187   MCSection *DataRelROSection = nullptr;
188   MCSection *MergeableConst4Section = nullptr;
189   MCSection *MergeableConst8Section = nullptr;
190   MCSection *MergeableConst16Section = nullptr;
191   MCSection *MergeableConst32Section = nullptr;
192 
193   // MachO specific sections.
194 
195   /// Section for thread local structure information.
196   ///
197   /// Contains the source code name of the variable, visibility and a pointer to
198   /// the initial value (.tdata or .tbss).
199   MCSection *TLSTLVSection = nullptr; // Defaults to ".tlv".
200 
201   /// Section for thread local data initialization functions.
202    // Defaults to ".thread_init_func".
203   const MCSection *TLSThreadInitSection = nullptr;
204 
205   MCSection *CStringSection = nullptr;
206   MCSection *UStringSection = nullptr;
207   MCSection *TextCoalSection = nullptr;
208   MCSection *ConstTextCoalSection = nullptr;
209   MCSection *ConstDataSection = nullptr;
210   MCSection *DataCoalSection = nullptr;
211   MCSection *ConstDataCoalSection = nullptr;
212   MCSection *DataCommonSection = nullptr;
213   MCSection *DataBSSSection = nullptr;
214   MCSection *FourByteConstantSection = nullptr;
215   MCSection *EightByteConstantSection = nullptr;
216   MCSection *SixteenByteConstantSection = nullptr;
217   MCSection *LazySymbolPointerSection = nullptr;
218   MCSection *NonLazySymbolPointerSection = nullptr;
219   MCSection *ThreadLocalPointerSection = nullptr;
220   MCSection *AddrSigSection = nullptr;
221 
222   /// COFF specific sections.
223   MCSection *DrectveSection = nullptr;
224   MCSection *PDataSection = nullptr;
225   MCSection *XDataSection = nullptr;
226   MCSection *SXDataSection = nullptr;
227   MCSection *GEHContSection = nullptr;
228   MCSection *GFIDsSection = nullptr;
229   MCSection *GIATsSection = nullptr;
230   MCSection *GLJMPSection = nullptr;
231 
232   // GOFF specific sections.
233   MCSection *PPA1Section = nullptr;
234   MCSection *PPA2Section = nullptr;
235   MCSection *PPA2ListSection = nullptr;
236   MCSection *ADASection = nullptr;
237   MCSection *IDRLSection = nullptr;
238 
239   // XCOFF specific sections
240   MCSection *TOCBaseSection = nullptr;
241   MCSection *ReadOnly8Section = nullptr;
242   MCSection *ReadOnly16Section = nullptr;
243 
244   // Swift5 Reflection Data Sections
245   std::array<MCSection *, binaryformat::Swift5ReflectionSectionKind::last>
246       Swift5ReflectionSections = {};
247 
248 public:
249   void initMCObjectFileInfo(MCContext &MCCtx, bool PIC,
250                             bool LargeCodeModel = false);
251   virtual ~MCObjectFileInfo();
252   MCContext &getContext() const { return *Ctx; }
253 
254   bool getSupportsWeakOmittedEHFrame() const {
255     return SupportsWeakOmittedEHFrame;
256   }
257   bool getSupportsCompactUnwindWithoutEHFrame() const {
258     return SupportsCompactUnwindWithoutEHFrame;
259   }
260   bool getOmitDwarfIfHaveCompactUnwind() const {
261     return OmitDwarfIfHaveCompactUnwind;
262   }
263 
264   unsigned getFDEEncoding() const { return FDECFIEncoding; }
265 
266   unsigned getCompactUnwindDwarfEHFrameOnly() const {
267     return CompactUnwindDwarfEHFrameOnly;
268   }
269 
270   virtual unsigned getTextSectionAlignment() const { return 4; }
271   MCSection *getTextSection() const { return TextSection; }
272   MCSection *getDataSection() const { return DataSection; }
273   MCSection *getBSSSection() const { return BSSSection; }
274   MCSection *getReadOnlySection() const { return ReadOnlySection; }
275   MCSection *getLSDASection() const { return LSDASection; }
276   MCSection *getImportCallSection() const { return ImportCallSection; }
277   MCSection *getCompactUnwindSection() const { return CompactUnwindSection; }
278   MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
279   MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
280   MCSection *getDwarfInfoSection(uint64_t Hash) const {
281     return getDwarfComdatSection(".debug_info", Hash);
282   }
283   MCSection *getDwarfLineSection() const { return DwarfLineSection; }
284   MCSection *getDwarfLineStrSection() const { return DwarfLineStrSection; }
285   MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
286   MCSection *getDwarfPubNamesSection() const { return DwarfPubNamesSection; }
287   MCSection *getDwarfPubTypesSection() const { return DwarfPubTypesSection; }
288   MCSection *getDwarfGnuPubNamesSection() const {
289     return DwarfGnuPubNamesSection;
290   }
291   MCSection *getDwarfGnuPubTypesSection() const {
292     return DwarfGnuPubTypesSection;
293   }
294   const MCSection *getDwarfDebugInlineSection() const {
295     return DwarfDebugInlineSection;
296   }
297   MCSection *getDwarfStrSection() const { return DwarfStrSection; }
298   MCSection *getDwarfLocSection() const { return DwarfLocSection; }
299   MCSection *getDwarfARangesSection() const { return DwarfARangesSection; }
300   MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
301   MCSection *getDwarfRnglistsSection() const { return DwarfRnglistsSection; }
302   MCSection *getDwarfLoclistsSection() const { return DwarfLoclistsSection; }
303   MCSection *getDwarfMacinfoSection() const { return DwarfMacinfoSection; }
304   MCSection *getDwarfMacroSection() const { return DwarfMacroSection; }
305 
306   MCSection *getDwarfDebugNamesSection() const {
307     return DwarfDebugNamesSection;
308   }
309   MCSection *getDwarfAccelNamesSection() const {
310     return DwarfAccelNamesSection;
311   }
312   MCSection *getDwarfAccelObjCSection() const { return DwarfAccelObjCSection; }
313   MCSection *getDwarfAccelNamespaceSection() const {
314     return DwarfAccelNamespaceSection;
315   }
316   MCSection *getDwarfAccelTypesSection() const {
317     return DwarfAccelTypesSection;
318   }
319   MCSection *getDwarfInfoDWOSection() const { return DwarfInfoDWOSection; }
320   MCSection *getDwarfTypesSection(uint64_t Hash) const {
321     return getDwarfComdatSection(".debug_types", Hash);
322   }
323   MCSection *getDwarfTypesDWOSection() const { return DwarfTypesDWOSection; }
324   MCSection *getDwarfAbbrevDWOSection() const { return DwarfAbbrevDWOSection; }
325   MCSection *getDwarfStrDWOSection() const { return DwarfStrDWOSection; }
326   MCSection *getDwarfLineDWOSection() const { return DwarfLineDWOSection; }
327   MCSection *getDwarfLocDWOSection() const { return DwarfLocDWOSection; }
328   MCSection *getDwarfStrOffDWOSection() const { return DwarfStrOffDWOSection; }
329   MCSection *getDwarfStrOffSection() const { return DwarfStrOffSection; }
330   MCSection *getDwarfAddrSection() const { return DwarfAddrSection; }
331   MCSection *getDwarfRnglistsDWOSection() const {
332     return DwarfRnglistsDWOSection;
333   }
334   MCSection *getDwarfLoclistsDWOSection() const {
335     return DwarfLoclistsDWOSection;
336   }
337   MCSection *getDwarfMacroDWOSection() const { return DwarfMacroDWOSection; }
338   MCSection *getDwarfMacinfoDWOSection() const {
339     return DwarfMacinfoDWOSection;
340   }
341   MCSection *getDwarfCUIndexSection() const { return DwarfCUIndexSection; }
342   MCSection *getDwarfTUIndexSection() const { return DwarfTUIndexSection; }
343   MCSection *getDwarfSwiftASTSection() const { return DwarfSwiftASTSection; }
344 
345   MCSection *getCOFFDebugSymbolsSection() const {
346     return COFFDebugSymbolsSection;
347   }
348   MCSection *getCOFFDebugTypesSection() const {
349     return COFFDebugTypesSection;
350   }
351   MCSection *getCOFFGlobalTypeHashesSection() const {
352     return COFFGlobalTypeHashesSection;
353   }
354 
355   MCSection *getTLSExtraDataSection() const { return TLSExtraDataSection; }
356   const MCSection *getTLSDataSection() const { return TLSDataSection; }
357   MCSection *getTLSBSSSection() const { return TLSBSSSection; }
358 
359   MCSection *getStackMapSection() const { return StackMapSection; }
360   MCSection *getFaultMapSection() const { return FaultMapSection; }
361   MCSection *getRemarksSection() const { return RemarksSection; }
362 
363   MCSection *getStackSizesSection(const MCSection &TextSec) const;
364 
365   MCSection *getBBAddrMapSection(const MCSection &TextSec) const;
366 
367   MCSection *getKCFITrapSection(const MCSection &TextSec) const;
368 
369   MCSection *getPseudoProbeSection(const MCSection &TextSec) const;
370 
371   MCSection *getPseudoProbeDescSection(StringRef FuncName) const;
372 
373   MCSection *getLLVMStatsSection() const;
374 
375   MCSection *getPCSection(StringRef Name, const MCSection *TextSec) const;
376 
377   // ELF specific sections.
378   MCSection *getDataRelROSection() const { return DataRelROSection; }
379   const MCSection *getMergeableConst4Section() const {
380     return MergeableConst4Section;
381   }
382   const MCSection *getMergeableConst8Section() const {
383     return MergeableConst8Section;
384   }
385   const MCSection *getMergeableConst16Section() const {
386     return MergeableConst16Section;
387   }
388   const MCSection *getMergeableConst32Section() const {
389     return MergeableConst32Section;
390   }
391 
392   // MachO specific sections.
393   const MCSection *getTLSTLVSection() const { return TLSTLVSection; }
394   const MCSection *getTLSThreadInitSection() const {
395     return TLSThreadInitSection;
396   }
397   const MCSection *getCStringSection() const { return CStringSection; }
398   const MCSection *getUStringSection() const { return UStringSection; }
399   MCSection *getTextCoalSection() const { return TextCoalSection; }
400   const MCSection *getConstTextCoalSection() const {
401     return ConstTextCoalSection;
402   }
403   const MCSection *getConstDataSection() const { return ConstDataSection; }
404   const MCSection *getDataCoalSection() const { return DataCoalSection; }
405   const MCSection *getConstDataCoalSection() const {
406     return ConstDataCoalSection;
407   }
408   const MCSection *getDataCommonSection() const { return DataCommonSection; }
409   MCSection *getDataBSSSection() const { return DataBSSSection; }
410   const MCSection *getFourByteConstantSection() const {
411     return FourByteConstantSection;
412   }
413   const MCSection *getEightByteConstantSection() const {
414     return EightByteConstantSection;
415   }
416   const MCSection *getSixteenByteConstantSection() const {
417     return SixteenByteConstantSection;
418   }
419   MCSection *getLazySymbolPointerSection() const {
420     return LazySymbolPointerSection;
421   }
422   MCSection *getNonLazySymbolPointerSection() const {
423     return NonLazySymbolPointerSection;
424   }
425   MCSection *getThreadLocalPointerSection() const {
426     return ThreadLocalPointerSection;
427   }
428   MCSection *getAddrSigSection() const { return AddrSigSection; }
429 
430   // COFF specific sections.
431   MCSection *getDrectveSection() const { return DrectveSection; }
432   MCSection *getPDataSection() const { return PDataSection; }
433   MCSection *getXDataSection() const { return XDataSection; }
434   MCSection *getSXDataSection() const { return SXDataSection; }
435   MCSection *getGEHContSection() const { return GEHContSection; }
436   MCSection *getGFIDsSection() const { return GFIDsSection; }
437   MCSection *getGIATsSection() const { return GIATsSection; }
438   MCSection *getGLJMPSection() const { return GLJMPSection; }
439 
440   // GOFF specific sections.
441   MCSection *getPPA1Section() const { return PPA1Section; }
442   MCSection *getPPA2Section() const { return PPA2Section; }
443   MCSection *getPPA2ListSection() const { return PPA2ListSection; }
444   MCSection *getADASection() const { return ADASection; }
445   MCSection *getIDRLSection() const { return IDRLSection; }
446 
447   // XCOFF specific sections
448   MCSection *getTOCBaseSection() const { return TOCBaseSection; }
449 
450   MCSection *getEHFrameSection() const { return EHFrameSection; }
451 
452   bool isPositionIndependent() const { return PositionIndependent; }
453 
454   // Swift5 Reflection Data Sections
455   MCSection *getSwift5ReflectionSection(
456       llvm::binaryformat::Swift5ReflectionSectionKind ReflSectionKind) {
457     return ReflSectionKind !=
458                    llvm::binaryformat::Swift5ReflectionSectionKind::unknown
459                ? Swift5ReflectionSections[ReflSectionKind]
460                : nullptr;
461   }
462 
463 private:
464   bool PositionIndependent = false;
465   MCContext *Ctx = nullptr;
466 
467   void initMachOMCObjectFileInfo(const Triple &T);
468   void initELFMCObjectFileInfo(const Triple &T, bool Large);
469   void initGOFFMCObjectFileInfo(const Triple &T);
470   void initCOFFMCObjectFileInfo(const Triple &T);
471   void initSPIRVMCObjectFileInfo(const Triple &T);
472   void initWasmMCObjectFileInfo(const Triple &T);
473   void initXCOFFMCObjectFileInfo(const Triple &T);
474   void initDXContainerObjectFileInfo(const Triple &T);
475   MCSection *getDwarfComdatSection(const char *Name, uint64_t Hash) const;
476 };
477 
478 } // end namespace llvm
479 
480 #endif
481