1 //===-- llvm/BinaryFormat/XCOFF.h - The XCOFF file format -------*- 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 defines manifest constants for the XCOFF object file format. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #ifndef LLVM_BINARYFORMAT_XCOFF_H 14 #define LLVM_BINARYFORMAT_XCOFF_H 15 16 #include <stddef.h> 17 #include <stdint.h> 18 19 namespace llvm { 20 class StringRef; 21 template <unsigned> class SmallString; 22 template <typename T> class Expected; 23 24 namespace XCOFF { 25 26 // Constants used in the XCOFF definition. 27 28 constexpr size_t FileNamePadSize = 6; 29 constexpr size_t NameSize = 8; 30 constexpr size_t FileHeaderSize32 = 20; 31 constexpr size_t FileHeaderSize64 = 24; 32 constexpr size_t AuxFileHeaderSize32 = 72; 33 constexpr size_t AuxFileHeaderSize64 = 110; 34 constexpr size_t SectionHeaderSize32 = 40; 35 constexpr size_t SectionHeaderSize64 = 72; 36 constexpr size_t SymbolTableEntrySize = 18; 37 constexpr size_t RelocationSerializationSize32 = 10; 38 constexpr size_t RelocationSerializationSize64 = 14; 39 constexpr uint16_t RelocOverflow = 65535; 40 constexpr uint8_t AllocRegNo = 31; 41 42 enum ReservedSectionNum : int16_t { N_DEBUG = -2, N_ABS = -1, N_UNDEF = 0 }; 43 44 enum MagicNumber : uint16_t { XCOFF32 = 0x01DF, XCOFF64 = 0x01F7 }; 45 46 // This field only exists in the XCOFF64 definition. 47 enum AuxHeaderFlags64 : uint16_t { 48 SHR_SYMTAB = 0x8000, ///< At exec time, create shared symbol table for program 49 ///< (main program only). 50 FORK_POLICY = 0x4000, ///< Forktree policy specified (main program only). 51 FORK_COR = 0x2000 ///< If _AOUT_FORK_POLICY is set, specify copy-on-reference 52 ///< if this bit is set. Specify copy-on- write otherwise. 53 ///< If _AOUT_FORK_POLICY is 0, this bit is reserved for 54 ///< future use and should be set to 0. 55 }; 56 57 enum XCOFFInterpret : uint16_t { 58 OLD_XCOFF_INTERPRET = 1, 59 NEW_XCOFF_INTERPRET = 2 60 }; 61 62 enum FileFlag : uint16_t { 63 F_RELFLG = 0x0001, ///< relocation info stripped from file 64 F_EXEC = 0x0002, ///< file is executable (i.e., it 65 ///< has a loader section) 66 F_LNNO = 0x0004, ///< line numbers stripped from file 67 F_LSYMS = 0x0008, ///< local symbols stripped from file 68 F_FDPR_PROF = 0x0010, ///< file was profiled with FDPR 69 F_FDPR_OPTI = 0x0020, ///< file was reordered with FDPR 70 F_DSA = 0x0040, ///< file uses Dynamic Segment Allocation (32-bit 71 ///< only) 72 F_DEP_1 = 0x0080, ///< Data Execution Protection bit 1 73 F_VARPG = 0x0100, ///< executable requests using variable size pages 74 F_LPTEXT = 0x0400, ///< executable requires large pages for text 75 F_LPDATA = 0x0800, ///< executable requires large pages for data 76 F_DYNLOAD = 0x1000, ///< file is dynamically loadable and 77 ///< executable (equivalent to F_EXEC on AIX) 78 F_SHROBJ = 0x2000, ///< file is a shared object 79 F_LOADONLY = 80 0x4000, ///< file can be loaded by the system loader, but it is 81 ///< ignored by the linker if it is a member of an archive. 82 F_DEP_2 = 0x8000 ///< Data Execution Protection bit 2 83 }; 84 85 // x_smclas field of x_csect from system header: /usr/include/syms.h 86 /// Storage Mapping Class definitions. 87 enum StorageMappingClass : uint8_t { 88 // READ ONLY CLASSES 89 XMC_PR = 0, ///< Program Code 90 XMC_RO = 1, ///< Read Only Constant 91 XMC_DB = 2, ///< Debug Dictionary Table 92 XMC_GL = 6, ///< Global Linkage (Interfile Interface Code) 93 XMC_XO = 7, ///< Extended Operation (Pseudo Machine Instruction) 94 XMC_SV = 8, ///< Supervisor Call (32-bit process only) 95 XMC_SV64 = 17, ///< Supervisor Call for 64-bit process 96 XMC_SV3264 = 18, ///< Supervisor Call for both 32- and 64-bit processes 97 XMC_TI = 12, ///< Traceback Index csect 98 XMC_TB = 13, ///< Traceback Table csect 99 100 // READ WRITE CLASSES 101 XMC_RW = 5, ///< Read Write Data 102 XMC_TC0 = 15, ///< TOC Anchor for TOC Addressability 103 XMC_TC = 3, ///< General TOC item 104 XMC_TD = 16, ///< Scalar data item in the TOC 105 XMC_DS = 10, ///< Descriptor csect 106 XMC_UA = 4, ///< Unclassified - Treated as Read Write 107 XMC_BS = 9, ///< BSS class (uninitialized static internal) 108 XMC_UC = 11, ///< Un-named Fortran Common 109 110 XMC_TL = 20, ///< Initialized thread-local variable 111 XMC_UL = 21, ///< Uninitialized thread-local variable 112 XMC_TE = 22 ///< Symbol mapped at the end of TOC 113 }; 114 115 // Flags for defining the section type. Masks for use with the (signed, 32-bit) 116 // s_flags field of the section header structure, selecting for values in the 117 // lower 16 bits. Defined in the system header `scnhdr.h`. 118 enum SectionTypeFlags : int32_t { 119 STYP_PAD = 0x0008, 120 STYP_DWARF = 0x0010, 121 STYP_TEXT = 0x0020, 122 STYP_DATA = 0x0040, 123 STYP_BSS = 0x0080, 124 STYP_EXCEPT = 0x0100, 125 STYP_INFO = 0x0200, 126 STYP_TDATA = 0x0400, 127 STYP_TBSS = 0x0800, 128 STYP_LOADER = 0x1000, 129 STYP_DEBUG = 0x2000, 130 STYP_TYPCHK = 0x4000, 131 STYP_OVRFLO = 0x8000 132 }; 133 134 /// Values for defining the section subtype of sections of type STYP_DWARF as 135 /// they would appear in the (signed, 32-bit) s_flags field of the section 136 /// header structure, contributing to the 16 most significant bits. Defined in 137 /// the system header `scnhdr.h`. 138 enum DwarfSectionSubtypeFlags : int32_t { 139 SSUBTYP_DWINFO = 0x1'0000, ///< DWARF info section 140 SSUBTYP_DWLINE = 0x2'0000, ///< DWARF line section 141 SSUBTYP_DWPBNMS = 0x3'0000, ///< DWARF pubnames section 142 SSUBTYP_DWPBTYP = 0x4'0000, ///< DWARF pubtypes section 143 SSUBTYP_DWARNGE = 0x5'0000, ///< DWARF aranges section 144 SSUBTYP_DWABREV = 0x6'0000, ///< DWARF abbrev section 145 SSUBTYP_DWSTR = 0x7'0000, ///< DWARF str section 146 SSUBTYP_DWRNGES = 0x8'0000, ///< DWARF ranges section 147 SSUBTYP_DWLOC = 0x9'0000, ///< DWARF loc section 148 SSUBTYP_DWFRAME = 0xA'0000, ///< DWARF frame section 149 SSUBTYP_DWMAC = 0xB'0000 ///< DWARF macinfo section 150 }; 151 152 // STORAGE CLASSES, n_sclass field of syment. 153 // The values come from `storclass.h` and `dbxstclass.h`. 154 enum StorageClass : uint8_t { 155 // Storage classes used for symbolic debugging symbols. 156 C_FILE = 103, // File name 157 C_BINCL = 108, // Beginning of include file 158 C_EINCL = 109, // Ending of include file 159 C_GSYM = 128, // Global variable 160 C_STSYM = 133, // Statically allocated symbol 161 C_BCOMM = 135, // Beginning of common block 162 C_ECOMM = 137, // End of common block 163 C_ENTRY = 141, // Alternate entry 164 C_BSTAT = 143, // Beginning of static block 165 C_ESTAT = 144, // End of static block 166 C_GTLS = 145, // Global thread-local variable 167 C_STTLS = 146, // Static thread-local variable 168 169 // Storage classes used for DWARF symbols. 170 C_DWARF = 112, // DWARF section symbol 171 172 // Storage classes used for absolute symbols. 173 C_LSYM = 129, // Automatic variable allocated on stack 174 C_PSYM = 130, // Argument to subroutine allocated on stack 175 C_RSYM = 131, // Register variable 176 C_RPSYM = 132, // Argument to function or procedure stored in register 177 C_ECOML = 136, // Local member of common block 178 C_FUN = 142, // Function or procedure 179 180 // Storage classes used for undefined external symbols or 181 // symbols of general sections. 182 C_EXT = 2, // External symbol 183 C_WEAKEXT = 111, // Weak external symbol 184 185 // Storage classes used for symbols of general sections. 186 C_NULL = 0, 187 C_STAT = 3, // Static 188 C_BLOCK = 100, // ".bb" or ".eb" 189 C_FCN = 101, // ".bf" or ".ef" 190 C_HIDEXT = 107, // Un-named external symbol 191 C_INFO = 110, // Comment string in .info section 192 C_DECL = 140, // Declaration of object (type) 193 194 // Storage classes - Obsolete/Undocumented. 195 C_AUTO = 1, // Automatic variable 196 C_REG = 4, // Register variable 197 C_EXTDEF = 5, // External definition 198 C_LABEL = 6, // Label 199 C_ULABEL = 7, // Undefined label 200 C_MOS = 8, // Member of structure 201 C_ARG = 9, // Function argument 202 C_STRTAG = 10, // Structure tag 203 C_MOU = 11, // Member of union 204 C_UNTAG = 12, // Union tag 205 C_TPDEF = 13, // Type definition 206 C_USTATIC = 14, // Undefined static 207 C_ENTAG = 15, // Enumeration tag 208 C_MOE = 16, // Member of enumeration 209 C_REGPARM = 17, // Register parameter 210 C_FIELD = 18, // Bit field 211 C_EOS = 102, // End of structure 212 C_LINE = 104, 213 C_ALIAS = 105, // Duplicate tag 214 C_HIDDEN = 106, // Special storage class for external 215 C_EFCN = 255, // Physical end of function 216 217 // Storage classes - reserved 218 C_TCSYM = 134 // Reserved 219 }; 220 221 // Flags for defining the symbol type. Values to be encoded into the lower 3 222 // bits of the (unsigned, 8-bit) x_smtyp field of csect auxiliary symbol table 223 // entries. Defined in the system header `syms.h`. 224 enum SymbolType : uint8_t { 225 XTY_ER = 0, ///< External reference. 226 XTY_SD = 1, ///< Csect definition for initialized storage. 227 XTY_LD = 2, ///< Label definition. 228 ///< Defines an entry point to an initialized csect. 229 XTY_CM = 3 ///< Common csect definition. For uninitialized storage. 230 }; 231 232 /// Values for visibility as they would appear when encoded in the high 4 bits 233 /// of the 16-bit unsigned n_type field of symbol table entries. Valid for 234 /// 32-bit XCOFF only when the vstamp in the auxiliary header is greater than 1. 235 enum VisibilityType : uint16_t { 236 SYM_V_UNSPECIFIED = 0x0000, 237 SYM_V_INTERNAL = 0x1000, 238 SYM_V_HIDDEN = 0x2000, 239 SYM_V_PROTECTED = 0x3000, 240 SYM_V_EXPORTED = 0x4000 241 }; 242 243 constexpr uint16_t VISIBILITY_MASK = 0x7000; 244 245 // Relocation types, defined in `/usr/include/reloc.h`. 246 enum RelocationType : uint8_t { 247 R_POS = 0x00, ///< Positive relocation. Provides the address of the referenced 248 ///< symbol. 249 R_RL = 0x0c, ///< Positive indirect load relocation. Modifiable instruction. 250 R_RLA = 0x0d, ///< Positive load address relocation. Modifiable instruction. 251 252 R_NEG = 0x01, ///< Negative relocation. Provides the negative of the address 253 ///< of the referenced symbol. 254 R_REL = 0x02, ///< Relative to self relocation. Provides a displacement value 255 ///< between the address of the referenced symbol and the 256 ///< address being relocated. 257 258 R_TOC = 0x03, ///< Relative to the TOC relocation. Provides a displacement 259 ///< that is the difference between the address of the 260 ///< referenced symbol and the TOC anchor csect. 261 R_TRL = 0x12, ///< TOC relative indirect load relocation. Similar to R_TOC, 262 ///< but not modifiable instruction. 263 264 R_TRLA = 265 0x13, ///< Relative to the TOC or to the thread-local storage base 266 ///< relocation. Compilers are not permitted to generate this 267 ///< relocation type. It is the result of a reversible 268 ///< transformation by the linker of an R_TOC relation that turned a 269 ///< load instruction into an add-immediate instruction. 270 271 R_GL = 0x05, ///< Global linkage-external TOC address relocation. Provides the 272 ///< address of the external TOC associated with a defined 273 ///< external symbol. 274 R_TCL = 0x06, ///< Local object TOC address relocation. Provides the address 275 ///< of the local TOC entry of a defined external symbol. 276 277 R_REF = 0x0f, ///< A non-relocating relocation. Used to prevent the binder 278 ///< from garbage collecting a csect (such as code used for 279 ///< dynamic initialization of non-local statics) for which 280 ///< another csect has an implicit dependency. 281 282 R_BA = 0x08, ///< Branch absolute relocation. Provides the address of the 283 ///< referenced symbol. References a non-modifiable instruction. 284 R_BR = 0x0a, ///< Branch relative to self relocation. Provides the 285 ///< displacement that is the difference between the address of 286 ///< the referenced symbol and the address of the referenced 287 ///< branch instruction. References a non-modifiable instruction. 288 R_RBA = 0x18, ///< Branch absolute relocation. Similar to R_BA but 289 ///< references a modifiable instruction. 290 R_RBR = 0x1a, ///< Branch relative to self relocation. Similar to the R_BR 291 ///< relocation type, but references a modifiable instruction. 292 293 R_TLS = 0x20, ///< General-dynamic reference to TLS symbol. 294 R_TLS_IE = 0x21, ///< Initial-exec reference to TLS symbol. 295 R_TLS_LD = 0x22, ///< Local-dynamic reference to TLS symbol. 296 R_TLS_LE = 0x23, ///< Local-exec reference to TLS symbol. 297 R_TLSM = 0x24, ///< Module reference to TLS. Provides a handle for the module 298 ///< containing the referenced symbol. 299 R_TLSML = 0x25, ///< Module reference to the local TLS storage. 300 301 R_TOCU = 0x30, ///< Relative to TOC upper. Specifies the high-order 16 bits of 302 ///< a large code model TOC-relative relocation. 303 R_TOCL = 0x31 ///< Relative to TOC lower. Specifies the low-order 16 bits of a 304 ///< large code model TOC-relative relocation. 305 }; 306 307 enum CFileStringType : uint8_t { 308 XFT_FN = 0, ///< Specifies the source-file name. 309 XFT_CT = 1, ///< Specifies the compiler time stamp. 310 XFT_CV = 2, ///< Specifies the compiler version number. 311 XFT_CD = 128 ///< Specifies compiler-defined information. 312 }; 313 314 enum CFileLangId : uint8_t { 315 TB_C = 0, ///< C language. 316 TB_CPLUSPLUS = 9 ///< C++ language. 317 }; 318 319 enum CFileCpuId : uint8_t { 320 TCPU_PPC64 = 2, ///< PowerPC common architecture 64-bit mode. 321 TCPU_COM = 3, ///< POWER and PowerPC architecture common. 322 TCPU_970 = 19 ///< PPC970 - PowerPC 64-bit architecture. 323 }; 324 325 enum SymbolAuxType : uint8_t { 326 AUX_EXCEPT = 255, ///< Identifies an exception auxiliary entry. 327 AUX_FCN = 254, ///< Identifies a function auxiliary entry. 328 AUX_SYM = 253, ///< Identifies a symbol auxiliary entry. 329 AUX_FILE = 252, ///< Identifies a file auxiliary entry. 330 AUX_CSECT = 251, ///< Identifies a csect auxiliary entry. 331 AUX_SECT = 250 ///< Identifies a SECT auxiliary entry. 332 }; // 64-bit XCOFF file only. 333 334 StringRef getMappingClassString(XCOFF::StorageMappingClass SMC); 335 StringRef getRelocationTypeString(XCOFF::RelocationType Type); 336 Expected<SmallString<32>> parseParmsType(uint32_t Value, unsigned FixedParmsNum, 337 unsigned FloatingParmsNum); 338 Expected<SmallString<32>> parseParmsTypeWithVecInfo(uint32_t Value, 339 unsigned FixedParmsNum, 340 unsigned FloatingParmsNum, 341 unsigned VectorParmsNum); 342 Expected<SmallString<32>> parseVectorParmsType(uint32_t Value, 343 unsigned ParmsNum); 344 345 struct TracebackTable { 346 enum LanguageID : uint8_t { 347 C, 348 Fortran, 349 Pascal, 350 Ada, 351 PL1, 352 Basic, 353 Lisp, 354 Cobol, 355 Modula2, 356 CPlusPlus, 357 Rpg, 358 PL8, 359 PLIX = PL8, 360 Assembly, 361 Java, 362 ObjectiveC 363 }; 364 // Byte 1 365 static constexpr uint32_t VersionMask = 0xFF00'0000; 366 static constexpr uint8_t VersionShift = 24; 367 368 // Byte 2 369 static constexpr uint32_t LanguageIdMask = 0x00FF'0000; 370 static constexpr uint8_t LanguageIdShift = 16; 371 372 // Byte 3 373 static constexpr uint32_t IsGlobaLinkageMask = 0x0000'8000; 374 static constexpr uint32_t IsOutOfLineEpilogOrPrologueMask = 0x0000'4000; 375 static constexpr uint32_t HasTraceBackTableOffsetMask = 0x0000'2000; 376 static constexpr uint32_t IsInternalProcedureMask = 0x0000'1000; 377 static constexpr uint32_t HasControlledStorageMask = 0x0000'0800; 378 static constexpr uint32_t IsTOClessMask = 0x0000'0400; 379 static constexpr uint32_t IsFloatingPointPresentMask = 0x0000'0200; 380 static constexpr uint32_t IsFloatingPointOperationLogOrAbortEnabledMask = 381 0x0000'0100; 382 383 // Byte 4 384 static constexpr uint32_t IsInterruptHandlerMask = 0x0000'0080; 385 static constexpr uint32_t IsFunctionNamePresentMask = 0x0000'0040; 386 static constexpr uint32_t IsAllocaUsedMask = 0x0000'0020; 387 static constexpr uint32_t OnConditionDirectiveMask = 0x0000'001C; 388 static constexpr uint32_t IsCRSavedMask = 0x0000'0002; 389 static constexpr uint32_t IsLRSavedMask = 0x0000'0001; 390 static constexpr uint8_t OnConditionDirectiveShift = 2; 391 392 // Byte 5 393 static constexpr uint32_t IsBackChainStoredMask = 0x8000'0000; 394 static constexpr uint32_t IsFixupMask = 0x4000'0000; 395 static constexpr uint32_t FPRSavedMask = 0x3F00'0000; 396 static constexpr uint32_t FPRSavedShift = 24; 397 398 // Byte 6 399 static constexpr uint32_t HasExtensionTableMask = 0x0080'0000; 400 static constexpr uint32_t HasVectorInfoMask = 0x0040'0000; 401 static constexpr uint32_t GPRSavedMask = 0x003F'0000; 402 static constexpr uint32_t GPRSavedShift = 16; 403 404 // Byte 7 405 static constexpr uint32_t NumberOfFixedParmsMask = 0x0000'FF00; 406 static constexpr uint8_t NumberOfFixedParmsShift = 8; 407 408 // Byte 8 409 static constexpr uint32_t NumberOfFloatingPointParmsMask = 0x0000'00FE; 410 static constexpr uint32_t HasParmsOnStackMask = 0x0000'0001; 411 static constexpr uint8_t NumberOfFloatingPointParmsShift = 1; 412 413 // Masks to select leftmost bits for decoding parameter type information. 414 // Bit to use when vector info is not presented. 415 static constexpr uint32_t ParmTypeIsFloatingBit = 0x8000'0000; 416 static constexpr uint32_t ParmTypeFloatingIsDoubleBit = 0x4000'0000; 417 // Bits to use when vector info is presented. 418 static constexpr uint32_t ParmTypeIsFixedBits = 0x0000'0000; 419 static constexpr uint32_t ParmTypeIsVectorBits = 0x4000'0000; 420 static constexpr uint32_t ParmTypeIsFloatingBits = 0x8000'0000; 421 static constexpr uint32_t ParmTypeIsDoubleBits = 0xC000'0000; 422 static constexpr uint32_t ParmTypeMask = 0xC000'0000; 423 424 // Vector extension 425 static constexpr uint16_t NumberOfVRSavedMask = 0xFC00; 426 static constexpr uint16_t IsVRSavedOnStackMask = 0x0200; 427 static constexpr uint16_t HasVarArgsMask = 0x0100; 428 static constexpr uint8_t NumberOfVRSavedShift = 10; 429 430 static constexpr uint16_t NumberOfVectorParmsMask = 0x00FE; 431 static constexpr uint16_t HasVMXInstructionMask = 0x0001; 432 static constexpr uint8_t NumberOfVectorParmsShift = 1; 433 434 static constexpr uint32_t ParmTypeIsVectorCharBit = 0x0000'0000; 435 static constexpr uint32_t ParmTypeIsVectorShortBit = 0x4000'0000; 436 static constexpr uint32_t ParmTypeIsVectorIntBit = 0x8000'0000; 437 static constexpr uint32_t ParmTypeIsVectorFloatBit = 0xC000'0000; 438 439 static constexpr uint8_t WidthOfParamType = 2; 440 }; 441 442 // Extended Traceback table flags. 443 enum ExtendedTBTableFlag : uint8_t { 444 TB_OS1 = 0x80, ///< Reserved for OS use. 445 TB_RESERVED = 0x40, ///< Reserved for compiler. 446 TB_SSP_CANARY = 0x20, ///< stack smasher canary present on stack. 447 TB_OS2 = 0x10, ///< Reserved for OS use. 448 TB_EH_INFO = 0x08, ///< Exception handling info present. 449 TB_LONGTBTABLE2 = 0x01 ///< Additional tbtable extension exists. 450 }; 451 452 StringRef getNameForTracebackTableLanguageId(TracebackTable::LanguageID LangId); 453 SmallString<32> getExtendedTBTableFlagString(uint8_t Flag); 454 455 struct CsectProperties { 456 CsectProperties(StorageMappingClass SMC, SymbolType ST) 457 : MappingClass(SMC), Type(ST) {} 458 StorageMappingClass MappingClass; 459 SymbolType Type; 460 }; 461 462 } // end namespace XCOFF 463 } // end namespace llvm 464 465 #endif 466