include/llvm/BinaryFormat/XCOFF.h

   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 <cstdint>
  17
  18 namespace llvm {
  19 namespace XCOFF {
  20
  21 // Constants used in the XCOFF definition.
  22 enum { FileNamePadSize = 6, NameSize = 8, SymbolTableEntrySize = 18 };
  23
  24 enum ReservedSectionNum { N_DEBUG = -2, N_ABS = -1, N_UNDEF = 0 };
  25
  26 // x_smclas field of x_csect from system header: /usr/include/syms.h
  27 /// Storage Mapping Class definitions.
  28 enum StorageMappingClass : uint8_t {
  29   //     READ ONLY CLASSES
  30   XMC_PR = 0,      ///< Program Code
  31   XMC_RO = 1,      ///< Read Only Constant
  32   XMC_DB = 2,      ///< Debug Dictionary Table
  33   XMC_GL = 6,      ///< Global Linkage (Interfile Interface Code)
  34   XMC_XO = 7,      ///< Extended Operation (Pseudo Machine Instruction)
  35   XMC_SV = 8,      ///< Supervisor Call (32-bit process only)
  36   XMC_SV64 = 17,   ///< Supervisor Call for 64-bit process
  37   XMC_SV3264 = 18, ///< Supervisor Call for both 32- and 64-bit processes
  38   XMC_TI = 12,     ///< Traceback Index csect
  39   XMC_TB = 13,     ///< Traceback Table csect
  40
  41   //       READ WRITE CLASSES
  42   XMC_RW = 5,   ///< Read Write Data
  43   XMC_TC0 = 15, ///< TOC Anchor for TOC Addressability
  44   XMC_TC = 3,   ///< General TOC item
  45   XMC_TD = 16,  ///< Scalar data item in the TOC
  46   XMC_DS = 10,  ///< Descriptor csect
  47   XMC_UA = 4,   ///< Unclassified - Treated as Read Write
  48   XMC_BS = 9,   ///< BSS class (uninitialized static internal)
  49   XMC_UC = 11,  ///< Un-named Fortran Common
  50
  51   XMC_TL = 20, ///< Initialized thread-local variable
  52   XMC_UL = 21, ///< Uninitialized thread-local variable
  53   XMC_TE = 22  ///< Symbol mapped at the end of TOC
  54 };
  55
  56 // Flags for defining the section type. Used for the s_flags field of
  57 // the section header structure. Defined in the system header `scnhdr.h`.
  58 enum SectionTypeFlags {
  59   STYP_PAD = 0x0008,
  60   STYP_DWARF = 0x0010,
  61   STYP_TEXT = 0x0020,
  62   STYP_DATA = 0x0040,
  63   STYP_BSS = 0x0080,
  64   STYP_EXCEPT = 0x0100,
  65   STYP_INFO = 0x0200,
  66   STYP_TDATA = 0x0400,
  67   STYP_TBSS = 0x0800,
  68   STYP_LOADER = 0x1000,
  69   STYP_DEBUG = 0x2000,
  70   STYP_TYPCHK = 0x4000,
  71   STYP_OVRFLO = 0x8000
  72 };
  73
  74 // STORAGE CLASSES, n_sclass field of syment.
  75 // The values come from `storclass.h` and `dbxstclass.h`.
  76 enum StorageClass : uint8_t {
  77   // Storage classes used for symbolic debugging symbols.
  78   C_FILE = 103,  // File name
  79   C_BINCL = 108, // Beginning of include file
  80   C_EINCL = 109, // Ending of include file
  81   C_GSYM = 128,  // Global variable
  82   C_STSYM = 133, // Statically allocated symbol
  83   C_BCOMM = 135, // Beginning of common block
  84   C_ECOMM = 137, // End of common block
  85   C_ENTRY = 141, // Alternate entry
  86   C_BSTAT = 143, // Beginning of static block
  87   C_ESTAT = 144, // End of static block
  88   C_GTLS = 145,  // Global thread-local variable
  89   C_STTLS = 146, // Static thread-local variable
  90
  91   // Storage classes used for DWARF symbols.
  92   C_DWARF = 112, // DWARF section symbol
  93
  94   // Storage classes used for absolute symbols.
  95   C_LSYM = 129,  // Automatic variable allocated on stack
  96   C_PSYM = 130,  // Argument to subroutine allocated on stack
  97   C_RSYM = 131,  // Register variable
  98   C_RPSYM = 132, // Argument to function or procedure stored in register
  99   C_ECOML = 136, // Local member of common block
 100   C_FUN = 142,   // Function or procedure
 101
 102   // Storage classes used for undefined external symbols or
 103   // symbols of general sections.
 104   C_EXT = 2,       // External symbol
 105   C_WEAKEXT = 111, // Weak external symbol
 106
 107   // Storage classes used for symbols of general sections.
 108   C_NULL = 0,
 109   C_STAT = 3,     // Static
 110   C_BLOCK = 100,  // ".bb" or ".eb"
 111   C_FCN = 101,    // ".bf" or ".ef"
 112   C_HIDEXT = 107, // Un-named external symbol
 113   C_INFO = 110,   // Comment string in .info section
 114   C_DECL = 140,   // Declaration of object (type)
 115
 116   // Storage classes - Obsolete/Undocumented.
 117   C_AUTO = 1,     // Automatic variable
 118   C_REG = 4,      // Register variable
 119   C_EXTDEF = 5,   // External definition
 120   C_LABEL = 6,    // Label
 121   C_ULABEL = 7,   // Undefined label
 122   C_MOS = 8,      // Member of structure
 123   C_ARG = 9,      // Function argument
 124   C_STRTAG = 10,  // Structure tag
 125   C_MOU = 11,     // Member of union
 126   C_UNTAG = 12,   // Union tag
 127   C_TPDEF = 13,   // Type definition
 128   C_USTATIC = 14, // Undefined static
 129   C_ENTAG = 15,   // Enumeration tag
 130   C_MOE = 16,     // Member of enumeration
 131   C_REGPARM = 17, // Register parameter
 132   C_FIELD = 18,   // Bit field
 133   C_EOS = 102,    // End of structure
 134   C_LINE = 104,
 135   C_ALIAS = 105,  // Duplicate tag
 136   C_HIDDEN = 106, // Special storage class for external
 137   C_EFCN = 255,   // Physical end of function
 138
 139   // Storage classes - reserved
 140   C_TCSYM = 134 // Reserved
 141 };
 142
 143 enum SymbolType {
 144   XTY_ER = 0, ///< External reference.
 145   XTY_SD = 1, ///< Csect definition for initialized storage.
 146   XTY_LD = 2, ///< Label definition.
 147               ///< Defines an entry point to an initialized csect.
 148   XTY_CM = 3  ///< Common csect definition. For uninitialized storage.
 149 };
 150
 151 // Relocation types, defined in `/usr/include/reloc.h`.
 152 enum RelocationType : uint8_t {
 153   R_POS = 0x00, ///< Positive relocation. Provides the address of the referenced
 154                 ///< symbol.
 155   R_RL = 0x0c,  ///< Positive indirect load relocation. Modifiable instruction.
 156   R_RLA = 0x0d, ///< Positive load address relocation. Modifiable instruction.
 157
 158   R_NEG = 0x01, ///< Negative relocation. Provides the negative of the address
 159                 ///< of the referenced symbol.
 160   R_REL = 0x02, ///< Relative to self relocation. Provides a displacement value
 161                 ///< between the address of the referenced symbol and the
 162                 ///< address being relocated.
 163
 164   R_TOC = 0x03, ///< Relative to the TOC relocation. Provides a displacement
 165                 ///< that is the difference between the address of the
 166                 ///< referenced symbol and the TOC anchor csect.
 167   R_TRL = 0x12, ///< TOC relative indirect load relocation. Similar to R_TOC,
 168                 ///< but not modifiable instruction.
 169
 170   R_TRLA =
 171       0x13, ///< Relative to the TOC or to the thread-local storage base
 172             ///< relocation. Compilers are not permitted to generate this
 173             ///< relocation type. It is the result of a reversible
 174             ///< transformation by the linker of an R_TOC relation that turned a
 175             ///< load instruction into an add-immediate instruction.
 176
 177   R_GL = 0x05, ///< Global linkage-external TOC address relocation. Provides the
 178                ///< address of the external TOC associated with a defined
 179                ///< external symbol.
 180   R_TCL = 0x06, ///< Local object TOC address relocation. Provides the address
 181                 ///< of the local TOC entry of a defined external symbol.
 182
 183   R_REF = 0x0f, ///< A non-relocating relocation. Used to prevent the binder
 184                 ///< from garbage collecting a csect (such as code used for
 185                 ///< dynamic initialization of non-local statics) for which
 186                 ///< another csect has an implicit dependency.
 187
 188   R_BA = 0x08, ///< Branch absolute relocation. Provides the address of the
 189                ///< referenced symbol. References a non-modifiable instruction.
 190   R_BR = 0x0a, ///< Branch relative to self relocation. Provides the
 191                ///< displacement that is the difference between the address of
 192                ///< the referenced symbol and the address of the referenced
 193                ///< branch instruction. References a non-modifiable instruction.
 194   R_RBA = 0x18, ///< Branch absolute relocation. Similar to R_BA but
 195                 ///< references a modifiable instruction.
 196   R_RBR = 0x1a, ///< Branch relative to self relocation. Similar to the R_BR
 197                 ///< relocation type, but references a modifiable instruction.
 198
 199   R_TLS = 0x20,    ///< General-dynamic reference to TLS symbol.
 200   R_TLS_IE = 0x21, ///< Initial-exec reference to TLS symbol.
 201   R_TLS_LD = 0x22, ///< Local-dynamic reference to TLS symbol.
 202   R_TLS_LE = 0x23, ///< Local-exec reference to TLS symbol.
 203   R_TLSM = 0x24,  ///< Module reference to TLS. Provides a handle for the module
 204                   ///< containing the referenced symbol.
 205   R_TLSML = 0x25, ///< Module reference to the local TLS storage.
 206
 207   R_TOCU = 0x30, ///< Relative to TOC upper. Specifies the high-order 16 bits of
 208                  ///< a large code model TOC-relative relocation.
 209   R_TOCL = 0x31 ///< Relative to TOC lower. Specifies the low-order 16 bits of a
 210                 ///< large code model TOC-relative relocation.
 211 };
 212
 213 struct FileHeader32 {
 214   uint16_t Magic;
 215   uint16_t NumberOfSections;
 216   int32_t TimeStamp;
 217   uint32_t SymbolTableFileOffset;
 218   int32_t NumberOfSymbolTableEntries;
 219   uint16_t AuxiliaryHeaderSize;
 220   uint16_t Flags;
 221 };
 222
 223 struct SectionHeader32 {
 224   char Name[XCOFF::NameSize];
 225   uint32_t PhysicalAddress;
 226   uint32_t VirtualAddress;
 227   uint32_t Size;
 228   uint32_t FileOffsetToData;
 229   uint32_t FileOffsetToRelocations;
 230   uint32_t FileOffsetToLineNumbers;
 231   uint16_t NumberOfRelocations;
 232   uint16_t NumberOfLineNumbers;
 233   int32_t Flags;
 234 };
 235
 236 enum CFileStringType : uint8_t {
 237   XFT_FN = 0,  ///< Specifies the source-file name.
 238   XFT_CT = 1,  ///< Specifies the compiler time stamp.
 239   XFT_CV = 2,  ///< Specifies the compiler version number.
 240   XFT_CD = 128 ///< Specifies compiler-defined information.
 241 };
 242
 243 enum CFileLangId : uint8_t {
 244   TB_C = 0,        ///< C language.
 245   TB_CPLUSPLUS = 9 ///< C++ language.
 246 };
 247
 248 enum CFileCpuId : uint8_t {
 249   TCPU_PPC64 = 2, ///< PowerPC common architecture 64-bit mode.
 250   TCPU_COM = 3,   ///< POWER and PowerPC architecture common.
 251   TCPU_970 = 19   ///< PPC970 - PowerPC 64-bit architecture.
 252 };
 253
 254 } // end namespace XCOFF
 255 } // end namespace llvm
 256
 257 #endif