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/ADT/Optional.h"
17 #include "llvm/ADT/Triple.h"
18 #include "llvm/BinaryFormat/Swift.h"
19 #include "llvm/Support/VersionTuple.h"
20 
21 #include <array>
22 
23 namespace llvm {
24 class MCContext;
25 class MCSection;
26 
27 class MCObjectFileInfo {
28 protected:
29   /// True if .comm supports alignment.  This is a hack for as long as we
30   /// support 10.4 Tiger, whose assembler doesn't support alignment on comm.
31   bool CommDirectiveSupportsAlignment = false;
32 
33   /// True if target object file supports a weak_definition of constant 0 for an
34   /// omitted EH frame.
35   bool SupportsWeakOmittedEHFrame = false;
36 
37   /// True if the target object file supports emitting a compact unwind section
38   /// without an associated EH frame section.
39   bool SupportsCompactUnwindWithoutEHFrame = false;
40 
41   /// OmitDwarfIfHaveCompactUnwind - True if the target object file
42   /// supports having some functions with compact unwind and other with
43   /// dwarf unwind.
44   bool OmitDwarfIfHaveCompactUnwind = false;
45 
46   /// FDE CFI encoding. Controls the encoding of the begin label in the
47   /// .eh_frame section. Unlike the LSDA encoding, personality encoding, and
48   /// type encodings, this is something that the assembler just "knows" about
49   /// its target
50   unsigned FDECFIEncoding = 0;
51 
52   /// Compact unwind encoding indicating that we should emit only an EH frame.
53   unsigned CompactUnwindDwarfEHFrameOnly = 0;
54 
55   /// Section directive for standard text.
56   MCSection *TextSection = nullptr;
57 
58   /// Section directive for standard data.
59   MCSection *DataSection = nullptr;
60 
61   /// Section that is default initialized to zero.
62   MCSection *BSSSection = nullptr;
63 
64   /// Section that is readonly and can contain arbitrary initialized data.
65   /// Targets are not required to have a readonly section. If they don't,
66   /// various bits of code will fall back to using the data section for
67   /// constants.
68   MCSection *ReadOnlySection = nullptr;
69 
70   /// If exception handling is supported by the target, this is the section the
71   /// Language Specific Data Area information is emitted to.
72   MCSection *LSDASection = nullptr;
73 
74   /// If exception handling is supported by the target and the target can
75   /// support a compact representation of the CIE and FDE, this is the section
76   /// to emit them into.
77   MCSection *CompactUnwindSection = nullptr;
78 
79   // Dwarf sections for debug info.  If a target supports debug info, these must
80   // be set.
81   MCSection *DwarfAbbrevSection = nullptr;
82   MCSection *DwarfInfoSection = nullptr;
83   MCSection *DwarfLineSection = nullptr;
84   MCSection *DwarfLineStrSection = nullptr;
85   MCSection *DwarfFrameSection = nullptr;
86   MCSection *DwarfPubTypesSection = nullptr;
87   const MCSection *DwarfDebugInlineSection = nullptr;
88   MCSection *DwarfStrSection = nullptr;
89   MCSection *DwarfLocSection = nullptr;
90   MCSection *DwarfARangesSection = nullptr;
91   MCSection *DwarfRangesSection = nullptr;
92   MCSection *DwarfMacinfoSection = nullptr;
93   MCSection *DwarfMacroSection = nullptr;
94   // The pubnames section is no longer generated by default.  The generation
95   // can be enabled by a compiler flag.
96   MCSection *DwarfPubNamesSection = nullptr;
97 
98   /// Accelerator table sections. DwarfDebugNamesSection is the DWARF v5
99   /// accelerator table, while DwarfAccelNamesSection, DwarfAccelObjCSection,
100   /// DwarfAccelNamespaceSection, DwarfAccelTypesSection are pre-DWARF v5
101   /// extensions.
102   MCSection *DwarfDebugNamesSection = nullptr;
103   MCSection *DwarfAccelNamesSection = nullptr;
104   MCSection *DwarfAccelObjCSection = nullptr;
105   MCSection *DwarfAccelNamespaceSection = nullptr;
106   MCSection *DwarfAccelTypesSection = nullptr;
107 
108   // These are used for the Fission separate debug information files.
109   MCSection *DwarfInfoDWOSection = nullptr;
110   MCSection *DwarfTypesDWOSection = nullptr;
111   MCSection *DwarfAbbrevDWOSection = nullptr;
112   MCSection *DwarfStrDWOSection = nullptr;
113   MCSection *DwarfLineDWOSection = nullptr;
114   MCSection *DwarfLocDWOSection = nullptr;
115   MCSection *DwarfStrOffDWOSection = nullptr;
116   MCSection *DwarfMacinfoDWOSection = nullptr;
117   MCSection *DwarfMacroDWOSection = nullptr;
118 
119   /// The DWARF v5 string offset and address table sections.
120   MCSection *DwarfStrOffSection = nullptr;
121   MCSection *DwarfAddrSection = nullptr;
122   /// The DWARF v5 range list section.
123   MCSection *DwarfRnglistsSection = nullptr;
124   /// The DWARF v5 locations list section.
125   MCSection *DwarfLoclistsSection = nullptr;
126 
127   /// The DWARF v5 range and location list sections for fission.
128   MCSection *DwarfRnglistsDWOSection = nullptr;
129   MCSection *DwarfLoclistsDWOSection = nullptr;
130 
131   // These are for Fission DWP files.
132   MCSection *DwarfCUIndexSection = nullptr;
133   MCSection *DwarfTUIndexSection = nullptr;
134 
135   /// Section for newer gnu pubnames.
136   MCSection *DwarfGnuPubNamesSection = nullptr;
137   /// Section for newer gnu pubtypes.
138   MCSection *DwarfGnuPubTypesSection = nullptr;
139 
140   // Section for Swift AST
141   MCSection *DwarfSwiftASTSection = nullptr;
142 
143   MCSection *COFFDebugSymbolsSection = nullptr;
144   MCSection *COFFDebugTypesSection = nullptr;
145   MCSection *COFFGlobalTypeHashesSection = nullptr;
146 
147   /// Extra TLS Variable Data section.
148   ///
149   /// If the target needs to put additional information for a TLS variable,
150   /// it'll go here.
151   MCSection *TLSExtraDataSection = nullptr;
152 
153   /// Section directive for Thread Local data. ELF, MachO, COFF, and Wasm.
154   MCSection *TLSDataSection = nullptr; // Defaults to ".tdata".
155 
156   /// Section directive for Thread Local uninitialized data.
157   ///
158   /// Null if this target doesn't support a BSS section. ELF and MachO only.
159   MCSection *TLSBSSSection = nullptr; // Defaults to ".tbss".
160 
161   /// StackMap section.
162   MCSection *StackMapSection = nullptr;
163 
164   /// FaultMap section.
165   MCSection *FaultMapSection = nullptr;
166 
167   /// Remarks section.
168   MCSection *RemarksSection = nullptr;
169 
170   /// EH frame section.
171   ///
172   /// It is initialized on demand so it can be overwritten (with uniquing).
173   MCSection *EHFrameSection = nullptr;
174 
175   /// Section containing metadata on function stack sizes.
176   MCSection *StackSizesSection = nullptr;
177 
178   /// Section for pseudo probe information used by AutoFDO
179   MCSection *PseudoProbeSection = nullptr;
180   MCSection *PseudoProbeDescSection = 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 
231   // XCOFF specific sections
232   MCSection *TOCBaseSection = nullptr;
233   MCSection *ReadOnly8Section = nullptr;
234   MCSection *ReadOnly16Section = nullptr;
235 
236   // Swift5 Reflection Data Sections
237   std::array<MCSection *, binaryformat::Swift5ReflectionSectionKind::last>
238       Swift5ReflectionSections = {};
239 
240 public:
241   void initMCObjectFileInfo(MCContext &MCCtx, bool PIC,
242                             bool LargeCodeModel = false);
243   virtual ~MCObjectFileInfo();
244   MCContext &getContext() const { return *Ctx; }
245 
246   bool getSupportsWeakOmittedEHFrame() const {
247     return SupportsWeakOmittedEHFrame;
248   }
249   bool getSupportsCompactUnwindWithoutEHFrame() const {
250     return SupportsCompactUnwindWithoutEHFrame;
251   }
252   bool getOmitDwarfIfHaveCompactUnwind() const {
253     return OmitDwarfIfHaveCompactUnwind;
254   }
255 
256   bool getCommDirectiveSupportsAlignment() const {
257     return CommDirectiveSupportsAlignment;
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(".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(".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 *getPseudoProbeSection(const MCSection *TextSec) const;
363 
364   MCSection *getPseudoProbeDescSection(StringRef FuncName) const;
365 
366   // ELF specific sections.
367   MCSection *getDataRelROSection() const { return DataRelROSection; }
368   const MCSection *getMergeableConst4Section() const {
369     return MergeableConst4Section;
370   }
371   const MCSection *getMergeableConst8Section() const {
372     return MergeableConst8Section;
373   }
374   const MCSection *getMergeableConst16Section() const {
375     return MergeableConst16Section;
376   }
377   const MCSection *getMergeableConst32Section() const {
378     return MergeableConst32Section;
379   }
380 
381   // MachO specific sections.
382   const MCSection *getTLSTLVSection() const { return TLSTLVSection; }
383   const MCSection *getTLSThreadInitSection() const {
384     return TLSThreadInitSection;
385   }
386   const MCSection *getCStringSection() const { return CStringSection; }
387   const MCSection *getUStringSection() const { return UStringSection; }
388   MCSection *getTextCoalSection() const { return TextCoalSection; }
389   const MCSection *getConstTextCoalSection() const {
390     return ConstTextCoalSection;
391   }
392   const MCSection *getConstDataSection() const { return ConstDataSection; }
393   const MCSection *getDataCoalSection() const { return DataCoalSection; }
394   const MCSection *getConstDataCoalSection() const {
395     return ConstDataCoalSection;
396   }
397   const MCSection *getDataCommonSection() const { return DataCommonSection; }
398   MCSection *getDataBSSSection() const { return DataBSSSection; }
399   const MCSection *getFourByteConstantSection() const {
400     return FourByteConstantSection;
401   }
402   const MCSection *getEightByteConstantSection() const {
403     return EightByteConstantSection;
404   }
405   const MCSection *getSixteenByteConstantSection() const {
406     return SixteenByteConstantSection;
407   }
408   MCSection *getLazySymbolPointerSection() const {
409     return LazySymbolPointerSection;
410   }
411   MCSection *getNonLazySymbolPointerSection() const {
412     return NonLazySymbolPointerSection;
413   }
414   MCSection *getThreadLocalPointerSection() const {
415     return ThreadLocalPointerSection;
416   }
417   MCSection *getAddrSigSection() const { return AddrSigSection; }
418 
419   // COFF specific sections.
420   MCSection *getDrectveSection() const { return DrectveSection; }
421   MCSection *getPDataSection() const { return PDataSection; }
422   MCSection *getXDataSection() const { return XDataSection; }
423   MCSection *getSXDataSection() const { return SXDataSection; }
424   MCSection *getGEHContSection() const { return GEHContSection; }
425   MCSection *getGFIDsSection() const { return GFIDsSection; }
426   MCSection *getGIATsSection() const { return GIATsSection; }
427   MCSection *getGLJMPSection() const { return GLJMPSection; }
428 
429   // GOFF specific sections.
430   MCSection *getPPA1Section() const { return PPA1Section; }
431 
432   // XCOFF specific sections
433   MCSection *getTOCBaseSection() const { return TOCBaseSection; }
434 
435   MCSection *getEHFrameSection() const { return EHFrameSection; }
436 
437   bool isPositionIndependent() const { return PositionIndependent; }
438 
439   // Swift5 Reflection Data Sections
440   MCSection *getSwift5ReflectionSection(
441       llvm::binaryformat::Swift5ReflectionSectionKind ReflSectionKind) {
442     return ReflSectionKind !=
443                    llvm::binaryformat::Swift5ReflectionSectionKind::unknown
444                ? Swift5ReflectionSections[ReflSectionKind]
445                : nullptr;
446   }
447 
448 private:
449   bool PositionIndependent = false;
450   MCContext *Ctx = nullptr;
451   VersionTuple SDKVersion;
452   Optional<Triple> DarwinTargetVariantTriple;
453   VersionTuple DarwinTargetVariantSDKVersion;
454 
455   void initMachOMCObjectFileInfo(const Triple &T);
456   void initELFMCObjectFileInfo(const Triple &T, bool Large);
457   void initGOFFMCObjectFileInfo(const Triple &T);
458   void initCOFFMCObjectFileInfo(const Triple &T);
459   void initSPIRVMCObjectFileInfo(const Triple &T);
460   void initWasmMCObjectFileInfo(const Triple &T);
461   void initXCOFFMCObjectFileInfo(const Triple &T);
462   void initDXContainerObjectFileInfo(const Triple &T);
463   MCSection *getDwarfComdatSection(const char *Name, uint64_t Hash) const;
464 
465 public:
466   void setSDKVersion(const VersionTuple &TheSDKVersion) {
467     SDKVersion = TheSDKVersion;
468   }
469 
470   const VersionTuple &getSDKVersion() const { return SDKVersion; }
471 
472   void setDarwinTargetVariantTriple(const Triple &T) {
473     DarwinTargetVariantTriple = T;
474   }
475 
476   const Triple *getDarwinTargetVariantTriple() const {
477     return DarwinTargetVariantTriple ? DarwinTargetVariantTriple.getPointer()
478                                      : nullptr;
479   }
480 
481   void setDarwinTargetVariantSDKVersion(const VersionTuple &TheSDKVersion) {
482     DarwinTargetVariantSDKVersion = TheSDKVersion;
483   }
484 
485   const VersionTuple &getDarwinTargetVariantSDKVersion() const {
486     return DarwinTargetVariantSDKVersion;
487   }
488 };
489 
490 } // end namespace llvm
491 
492 #endif
493