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