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