Home | History | Annotate | Download | only in MC 
      1 //===-- llvm/MC/MCObjectFileInfo.h - Object File Info -----------*- C++ -*-===//
      2 //
      3 //                     The LLVM Compiler Infrastructure
      4 //
      5 // This file is distributed under the University of Illinois Open Source
      6 // License. See LICENSE.TXT for details.
      7 //
      8 //===----------------------------------------------------------------------===//
      9 //
     10 // This file describes common object file formats.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_MC_MCOBJECTFILEINFO_H
     15 #define LLVM_MC_MCOBJECTFILEINFO_H
     16 
     17 #include "llvm/ADT/Triple.h"
     18 #include "llvm/Support/CodeGen.h"
     19 
     20 namespace llvm {
     21 class MCContext;
     22 class MCSection;
     23 
     24 class MCObjectFileInfo {
     25 protected:
     26   /// True if .comm supports alignment.  This is a hack for as long as we
     27   /// support 10.4 Tiger, whose assembler doesn't support alignment on comm.
     28   bool CommDirectiveSupportsAlignment;
     29 
     30   /// True if target object file supports a weak_definition of constant 0 for an
     31   /// omitted EH frame.
     32   bool SupportsWeakOmittedEHFrame;
     33 
     34   /// True if the target object file supports emitting a compact unwind section
     35   /// without an associated EH frame section.
     36   bool SupportsCompactUnwindWithoutEHFrame;
     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;
     42 
     43   /// PersonalityEncoding, LSDAEncoding, TTypeEncoding - Some encoding values
     44   /// for EH.
     45   unsigned PersonalityEncoding;
     46   unsigned LSDAEncoding;
     47   unsigned FDECFIEncoding;
     48   unsigned TTypeEncoding;
     49 
     50   /// Compact unwind encoding indicating that we should emit only an EH frame.
     51   unsigned CompactUnwindDwarfEHFrameOnly;
     52 
     53   /// Section directive for standard text.
     54   MCSection *TextSection;
     55 
     56   /// Section directive for standard data.
     57   MCSection *DataSection;
     58 
     59   /// Section that is default initialized to zero.
     60   MCSection *BSSSection;
     61 
     62   /// Section that is readonly and can contain arbitrary initialized data.
     63   /// Targets are not required to have a readonly section. If they don't,
     64   /// various bits of code will fall back to using the data section for
     65   /// constants.
     66   MCSection *ReadOnlySection;
     67 
     68   /// If exception handling is supported by the target, this is the section the
     69   /// Language Specific Data Area information is emitted to.
     70   MCSection *LSDASection;
     71 
     72   /// If exception handling is supported by the target and the target can
     73   /// support a compact representation of the CIE and FDE, this is the section
     74   /// to emit them into.
     75   MCSection *CompactUnwindSection;
     76 
     77   // Dwarf sections for debug info.  If a target supports debug info, these must
     78   // be set.
     79   MCSection *DwarfAbbrevSection;
     80   MCSection *DwarfInfoSection;
     81   MCSection *DwarfLineSection;
     82   MCSection *DwarfFrameSection;
     83   MCSection *DwarfPubTypesSection;
     84   const MCSection *DwarfDebugInlineSection;
     85   MCSection *DwarfStrSection;
     86   MCSection *DwarfLocSection;
     87   MCSection *DwarfARangesSection;
     88   MCSection *DwarfRangesSection;
     89   MCSection *DwarfMacinfoSection;
     90   // The pubnames section is no longer generated by default.  The generation
     91   // can be enabled by a compiler flag.
     92   MCSection *DwarfPubNamesSection;
     93 
     94   /// DWARF5 Experimental Debug Info Sections
     95   /// DwarfAccelNamesSection, DwarfAccelObjCSection,
     96   /// DwarfAccelNamespaceSection, DwarfAccelTypesSection -
     97   /// If we use the DWARF accelerated hash tables then we want to emit these
     98   /// sections.
     99   MCSection *DwarfAccelNamesSection;
    100   MCSection *DwarfAccelObjCSection;
    101   MCSection *DwarfAccelNamespaceSection;
    102   MCSection *DwarfAccelTypesSection;
    103 
    104   // These are used for the Fission separate debug information files.
    105   MCSection *DwarfInfoDWOSection;
    106   MCSection *DwarfTypesDWOSection;
    107   MCSection *DwarfAbbrevDWOSection;
    108   MCSection *DwarfStrDWOSection;
    109   MCSection *DwarfLineDWOSection;
    110   MCSection *DwarfLocDWOSection;
    111   MCSection *DwarfStrOffDWOSection;
    112 
    113   /// The DWARF v5 string offset and address table sections.
    114   MCSection *DwarfStrOffSection;
    115   MCSection *DwarfAddrSection;
    116 
    117   // These are for Fission DWP files.
    118   MCSection *DwarfCUIndexSection;
    119   MCSection *DwarfTUIndexSection;
    120 
    121   /// Section for newer gnu pubnames.
    122   MCSection *DwarfGnuPubNamesSection;
    123   /// Section for newer gnu pubtypes.
    124   MCSection *DwarfGnuPubTypesSection;
    125 
    126   // Section for Swift AST
    127   MCSection *DwarfSwiftASTSection;
    128 
    129   MCSection *COFFDebugSymbolsSection;
    130   MCSection *COFFDebugTypesSection;
    131 
    132   /// Extra TLS Variable Data section.
    133   ///
    134   /// If the target needs to put additional information for a TLS variable,
    135   /// it'll go here.
    136   MCSection *TLSExtraDataSection;
    137 
    138   /// Section directive for Thread Local data. ELF, MachO, COFF, and Wasm.
    139   MCSection *TLSDataSection; // Defaults to ".tdata".
    140 
    141   /// Section directive for Thread Local uninitialized data.
    142   ///
    143   /// Null if this target doesn't support a BSS section. ELF and MachO only.
    144   MCSection *TLSBSSSection; // Defaults to ".tbss".
    145 
    146   /// StackMap section.
    147   MCSection *StackMapSection;
    148 
    149   /// FaultMap section.
    150   MCSection *FaultMapSection;
    151 
    152   /// EH frame section.
    153   ///
    154   /// It is initialized on demand so it can be overwritten (with uniquing).
    155   MCSection *EHFrameSection;
    156 
    157   // ELF specific sections.
    158   MCSection *DataRelROSection;
    159   MCSection *MergeableConst4Section;
    160   MCSection *MergeableConst8Section;
    161   MCSection *MergeableConst16Section;
    162   MCSection *MergeableConst32Section;
    163 
    164   // MachO specific sections.
    165 
    166   /// Section for thread local structure information.
    167   ///
    168   /// Contains the source code name of the variable, visibility and a pointer to
    169   /// the initial value (.tdata or .tbss).
    170   MCSection *TLSTLVSection; // Defaults to ".tlv".
    171 
    172   /// Section for thread local data initialization functions.
    173   const MCSection *TLSThreadInitSection; // Defaults to ".thread_init_func".
    174 
    175   MCSection *CStringSection;
    176   MCSection *UStringSection;
    177   MCSection *TextCoalSection;
    178   MCSection *ConstTextCoalSection;
    179   MCSection *ConstDataSection;
    180   MCSection *DataCoalSection;
    181   MCSection *DataCommonSection;
    182   MCSection *DataBSSSection;
    183   MCSection *FourByteConstantSection;
    184   MCSection *EightByteConstantSection;
    185   MCSection *SixteenByteConstantSection;
    186   MCSection *LazySymbolPointerSection;
    187   MCSection *NonLazySymbolPointerSection;
    188   MCSection *ThreadLocalPointerSection;
    189 
    190   /// COFF specific sections.
    191   MCSection *DrectveSection;
    192   MCSection *PDataSection;
    193   MCSection *XDataSection;
    194   MCSection *SXDataSection;
    195 
    196 public:
    197   void InitMCObjectFileInfo(const Triple &TT, bool PIC, MCContext &ctx,
    198                             bool LargeCodeModel = false);
    199 
    200   bool getSupportsWeakOmittedEHFrame() const {
    201     return SupportsWeakOmittedEHFrame;
    202   }
    203   bool getSupportsCompactUnwindWithoutEHFrame() const {
    204     return SupportsCompactUnwindWithoutEHFrame;
    205   }
    206   bool getOmitDwarfIfHaveCompactUnwind() const {
    207     return OmitDwarfIfHaveCompactUnwind;
    208   }
    209 
    210   bool getCommDirectiveSupportsAlignment() const {
    211     return CommDirectiveSupportsAlignment;
    212   }
    213 
    214   unsigned getPersonalityEncoding() const { return PersonalityEncoding; }
    215   unsigned getLSDAEncoding() const { return LSDAEncoding; }
    216   unsigned getFDEEncoding() const { return FDECFIEncoding; }
    217   unsigned getTTypeEncoding() const { return TTypeEncoding; }
    218 
    219   unsigned getCompactUnwindDwarfEHFrameOnly() const {
    220     return CompactUnwindDwarfEHFrameOnly;
    221   }
    222 
    223   MCSection *getTextSection() const { return TextSection; }
    224   MCSection *getDataSection() const { return DataSection; }
    225   MCSection *getBSSSection() const { return BSSSection; }
    226   MCSection *getReadOnlySection() const { return ReadOnlySection; }
    227   MCSection *getLSDASection() const { return LSDASection; }
    228   MCSection *getCompactUnwindSection() const { return CompactUnwindSection; }
    229   MCSection *getDwarfAbbrevSection() const { return DwarfAbbrevSection; }
    230   MCSection *getDwarfInfoSection() const { return DwarfInfoSection; }
    231   MCSection *getDwarfLineSection() const { return DwarfLineSection; }
    232   MCSection *getDwarfFrameSection() const { return DwarfFrameSection; }
    233   MCSection *getDwarfPubNamesSection() const { return DwarfPubNamesSection; }
    234   MCSection *getDwarfPubTypesSection() const { return DwarfPubTypesSection; }
    235   MCSection *getDwarfGnuPubNamesSection() const {
    236     return DwarfGnuPubNamesSection;
    237   }
    238   MCSection *getDwarfGnuPubTypesSection() const {
    239     return DwarfGnuPubTypesSection;
    240   }
    241   const MCSection *getDwarfDebugInlineSection() const {
    242     return DwarfDebugInlineSection;
    243   }
    244   MCSection *getDwarfStrSection() const { return DwarfStrSection; }
    245   MCSection *getDwarfLocSection() const { return DwarfLocSection; }
    246   MCSection *getDwarfARangesSection() const { return DwarfARangesSection; }
    247   MCSection *getDwarfRangesSection() const { return DwarfRangesSection; }
    248   MCSection *getDwarfMacinfoSection() const { return DwarfMacinfoSection; }
    249 
    250   // DWARF5 Experimental Debug Info Sections
    251   MCSection *getDwarfAccelNamesSection() const {
    252     return DwarfAccelNamesSection;
    253   }
    254   MCSection *getDwarfAccelObjCSection() const { return DwarfAccelObjCSection; }
    255   MCSection *getDwarfAccelNamespaceSection() const {
    256     return DwarfAccelNamespaceSection;
    257   }
    258   MCSection *getDwarfAccelTypesSection() const {
    259     return DwarfAccelTypesSection;
    260   }
    261   MCSection *getDwarfInfoDWOSection() const { return DwarfInfoDWOSection; }
    262   MCSection *getDwarfTypesSection(uint64_t Hash) const;
    263   MCSection *getDwarfTypesDWOSection() const { return DwarfTypesDWOSection; }
    264   MCSection *getDwarfAbbrevDWOSection() const { return DwarfAbbrevDWOSection; }
    265   MCSection *getDwarfStrDWOSection() const { return DwarfStrDWOSection; }
    266   MCSection *getDwarfLineDWOSection() const { return DwarfLineDWOSection; }
    267   MCSection *getDwarfLocDWOSection() const { return DwarfLocDWOSection; }
    268   MCSection *getDwarfStrOffDWOSection() const { return DwarfStrOffDWOSection; }
    269   MCSection *getDwarfStrOffSection() const { return DwarfStrOffSection; }
    270   MCSection *getDwarfAddrSection() const { return DwarfAddrSection; }
    271   MCSection *getDwarfCUIndexSection() const { return DwarfCUIndexSection; }
    272   MCSection *getDwarfTUIndexSection() const { return DwarfTUIndexSection; }
    273   MCSection *getDwarfSwiftASTSection() const { return DwarfSwiftASTSection; }
    274 
    275   MCSection *getCOFFDebugSymbolsSection() const {
    276     return COFFDebugSymbolsSection;
    277   }
    278   MCSection *getCOFFDebugTypesSection() const {
    279     return COFFDebugTypesSection;
    280   }
    281 
    282 
    283   MCSection *getTLSExtraDataSection() const { return TLSExtraDataSection; }
    284   const MCSection *getTLSDataSection() const { return TLSDataSection; }
    285   MCSection *getTLSBSSSection() const { return TLSBSSSection; }
    286 
    287   MCSection *getStackMapSection() const { return StackMapSection; }
    288   MCSection *getFaultMapSection() const { return FaultMapSection; }
    289 
    290   // ELF specific sections.
    291   MCSection *getDataRelROSection() const { return DataRelROSection; }
    292   const MCSection *getMergeableConst4Section() const {
    293     return MergeableConst4Section;
    294   }
    295   const MCSection *getMergeableConst8Section() const {
    296     return MergeableConst8Section;
    297   }
    298   const MCSection *getMergeableConst16Section() const {
    299     return MergeableConst16Section;
    300   }
    301   const MCSection *getMergeableConst32Section() const {
    302     return MergeableConst32Section;
    303   }
    304 
    305   // MachO specific sections.
    306   const MCSection *getTLSTLVSection() const { return TLSTLVSection; }
    307   const MCSection *getTLSThreadInitSection() const {
    308     return TLSThreadInitSection;
    309   }
    310   const MCSection *getCStringSection() const { return CStringSection; }
    311   const MCSection *getUStringSection() const { return UStringSection; }
    312   MCSection *getTextCoalSection() const { return TextCoalSection; }
    313   const MCSection *getConstTextCoalSection() const {
    314     return ConstTextCoalSection;
    315   }
    316   const MCSection *getConstDataSection() const { return ConstDataSection; }
    317   const MCSection *getDataCoalSection() const { return DataCoalSection; }
    318   const MCSection *getDataCommonSection() const { return DataCommonSection; }
    319   MCSection *getDataBSSSection() const { return DataBSSSection; }
    320   const MCSection *getFourByteConstantSection() const {
    321     return FourByteConstantSection;
    322   }
    323   const MCSection *getEightByteConstantSection() const {
    324     return EightByteConstantSection;
    325   }
    326   const MCSection *getSixteenByteConstantSection() const {
    327     return SixteenByteConstantSection;
    328   }
    329   MCSection *getLazySymbolPointerSection() const {
    330     return LazySymbolPointerSection;
    331   }
    332   MCSection *getNonLazySymbolPointerSection() const {
    333     return NonLazySymbolPointerSection;
    334   }
    335   MCSection *getThreadLocalPointerSection() const {
    336     return ThreadLocalPointerSection;
    337   }
    338 
    339   // COFF specific sections.
    340   MCSection *getDrectveSection() const { return DrectveSection; }
    341   MCSection *getPDataSection() const { return PDataSection; }
    342   MCSection *getXDataSection() const { return XDataSection; }
    343   MCSection *getSXDataSection() const { return SXDataSection; }
    344 
    345   MCSection *getEHFrameSection() {
    346     return EHFrameSection;
    347   }
    348 
    349   enum Environment { IsMachO, IsELF, IsCOFF, IsWasm };
    350   Environment getObjectFileType() const { return Env; }
    351 
    352   bool isPositionIndependent() const { return PositionIndependent; }
    353 
    354 private:
    355   Environment Env;
    356   bool PositionIndependent;
    357   MCContext *Ctx;
    358   Triple TT;
    359 
    360   void initMachOMCObjectFileInfo(const Triple &T);
    361   void initELFMCObjectFileInfo(const Triple &T, bool Large);
    362   void initCOFFMCObjectFileInfo(const Triple &T);
    363   void initWasmMCObjectFileInfo(const Triple &T);
    364 
    365 public:
    366   const Triple &getTargetTriple() const { return TT; }
    367 };
    368 
    369 } // end namespace llvm
    370 
    371 #endif
    372