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