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