sys/sys/elf_common.h

   1 /*-
   2  * Copyright (c) 1998 John D. Polstra.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/sys/elf_common.h,v 1.5.2.3 2001/02/28 02:30:46 obrien Exp $
  27  * $DragonFly: src/sys/sys/elf_common.h,v 1.7 2005/07/13 18:06:21 asmodai Exp $
  28  */
  29
  30 #ifndef _SYS_ELF_COMMON_H_
  31 #define _SYS_ELF_COMMON_H_ 1
  32
  33 /*
  34  * ELF definitions that are independent of architecture or word size.
  35  */
  36
  37 /*
  38  * Note header.  The ".note" section contains an array of notes.  Each
  39  * begins with this header, aligned to a word boundary.  Immediately
  40  * following the note header is n_namesz bytes of name, padded to the
  41  * next word boundary.  Then comes n_descsz bytes of descriptor, again
  42  * padded to a word boundary.  The values of n_namesz and n_descsz do
  43  * not include the padding.
  44  */
  45
  46 typedef struct {
  47         u_int32_t       n_namesz;       /* Length of name. */
  48         u_int32_t       n_descsz;       /* Length of descriptor. */
  49         u_int32_t       n_type;         /* Type of this note. */
  50 } Elf_Note;
  51
  52 /* Indexes into the e_ident array.  Keep synced with
  53    http://www.sco.com/developer/gabi/ch4.eheader.html */
  54 #define EI_MAG0         0       /* Magic number, byte 0. */
  55 #define EI_MAG1         1       /* Magic number, byte 1. */
  56 #define EI_MAG2         2       /* Magic number, byte 2. */
  57 #define EI_MAG3         3       /* Magic number, byte 3. */
  58 #define EI_CLASS        4       /* Class of machine. */
  59 #define EI_DATA         5       /* Data format. */
  60 #define EI_VERSION      6       /* ELF format version. */
  61 #define EI_OSABI        7       /* Operating system / ABI identification */
  62 #define EI_ABIVERSION   8       /* ABI version */
  63 #define OLD_EI_BRAND    8       /* Start of architecture identification. */
  64 #define EI_PAD          9       /* Start of padding (per SVR4 ABI). */
  65 #define EI_NIDENT       16      /* Size of e_ident array. */
  66
  67 /* Values for the magic number bytes. */
  68 #define ELFMAG0         0x7f
  69 #define ELFMAG1         'E'
  70 #define ELFMAG2         'L'
  71 #define ELFMAG3         'F'
  72
  73 /* Values for e_ident[EI_VERSION] and e_version. */
  74 #define EV_NONE         0
  75 #define EV_CURRENT      1
  76
  77 /* Values for e_ident[EI_CLASS]. */
  78 #define ELFCLASSNONE    0       /* Unknown class. */
  79 #define ELFCLASS32      1       /* 32-bit architecture. */
  80 #define ELFCLASS64      2       /* 64-bit architecture. */
  81
  82 /* Values for e_ident[EI_DATA]. */
  83 #define ELFDATANONE     0       /* Unknown data format. */
  84 #define ELFDATA2LSB     1       /* 2's complement little-endian. */
  85 #define ELFDATA2MSB     2       /* 2's complement big-endian. */
  86
  87 /* Values for e_ident[EI_OSABI]. */
  88 #define ELFOSABI_SYSV           0       /* UNIX System V ABI */
  89 #define ELFOSABI_NONE           ELFOSABI_SYSV   /* symbol used in old spec */
  90 #define ELFOSABI_HPUX           1       /* HP-UX operating system */
  91 #define ELFOSABI_NETBSD         2       /* NetBSD */
  92 #define ELFOSABI_LINUX          3       /* GNU/Linux */
  93 #define ELFOSABI_HURD           4       /* GNU/Hurd */
  94 #define ELFOSABI_86OPEN         5       /* 86Open common IA32 ABI */
  95 #define ELFOSABI_SOLARIS        6       /* Solaris */
  96 #define ELFOSABI_MONTEREY       7       /* Monterey */
  97 #define ELFOSABI_IRIX           8       /* IRIX */
  98 #define ELFOSABI_FREEBSD        9       /* FreeBSD */
  99 #define ELFOSABI_TRU64          10      /* TRU64 UNIX */
 100 #define ELFOSABI_MODESTO        11      /* Novell Modesto */
 101 #define ELFOSABI_OPENBSD        12      /* OpenBSD */
 102 #define ELFOSABI_ARM            97      /* ARM */
 103 #define ELFOSABI_STANDALONE     255     /* Standalone (embedded) application */
 104
 105 /* e_ident */
 106 #define IS_ELF(ehdr)    ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
 107                          (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
 108                          (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
 109                          (ehdr).e_ident[EI_MAG3] == ELFMAG3)
 110
 111 /* Values for e_type. */
 112 #define ET_NONE         0       /* Unknown type. */
 113 #define ET_REL          1       /* Relocatable. */
 114 #define ET_EXEC         2       /* Executable. */
 115 #define ET_DYN          3       /* Shared object. */
 116 #define ET_CORE         4       /* Core file. */
 117 #define ET_LOOS         0xfe00  /* OS-specific range start. */
 118 #define ET_HIOS         0xfeff  /* OS-specific range end. */
 119 #define ET_LIPROC       0xff00  /* Processor-specific range start. */
 120 #define ET_HIPROC       0xffff  /* Processor-specific range end. */
 121
 122 /* Values for e_machine. */
 123 #define EM_NONE         0       /* Unknown machine. */
 124 #define EM_M32          1       /* AT&T WE32100. */
 125 #define EM_SPARC        2       /* Sun SPARC. */
 126 #define EM_386          3       /* Intel i386. */
 127 #define EM_68K          4       /* Motorola 68000. */
 128 #define EM_88K          5       /* Motorola 88000. */
 129 #define EM_486          6       /* Intel i486. */
 130 #define EM_860          7       /* Intel i860. */
 131 #define EM_MIPS         8       /* MIPS R3000 Big-Endian only */
 132
 133 /* Extensions. */
 134 #define EM_S370         9       /* IBM System/370 */
 135 #define EM_MIPS_RS4_BE  10      /* MIPS R4000 Big-Endian */ /* Depreciated */
 136 #define EM_PARISC       15      /* HPPA */
 137 #define EM_VPP500       17      /* Fujitsu VPP500 */
 138 #define EM_SPARC32PLUS  18      /* SPARC v8plus */
 139 #define EM_960          19      /* Intel 80960 */
 140 #define EM_PPC          20      /* PowerPC 32-bit */
 141 #define EM_PPC64        21      /* PowerPC 64-bit */
 142 #define EM_S390         22      /* IBM S390 */
 143 #define EM_V800         36      /* NEC V800 series */
 144 #define EM_FR20         37      /* Fujitsu FR20 */
 145 #define EM_RH32         38      /* TRW RH-32 */
 146 #define EM_RCE          39      /* Motorola RCE */
 147 #define EM_ARM          40      /* ARM */
 148 #define EM_SH           42      /* Hitachi SH */
 149 #define EM_SPARCV9      43      /* SPARC v9 64-bit */
 150 #define EM_TRICORE      44      /* Siemens Tricore */
 151 #define EM_ARC          45      /* Argonaut RISC Core */
 152 #define EM_H8_300       46      /* Hitachi H8/300 */
 153 #define EM_H8_300H      47      /* Hitachi H8/300H */
 154 #define EM_H8S          48      /* Hitachi H8S */
 155 #define EM_H8_500       49      /* Hitachi H8/500 */
 156 #define EM_IA_64        50      /* Intel IA-46 Processor */
 157 #define EM_MIPS_X       51      /* Stanford MIPS-X */
 158 #define EM_COLDFIRE     52      /* Motorola Coldfire */
 159 #define EM_68HC12       53      /* Motorola M68HC12 */
 160 #define EM_MMA          54      /* Fujitsu MMA Multimedia Accelerator*/
 161 #define EM_PCP          55      /* Siemens PCP */
 162 #define EM_NCPU         56      /* Sony nCPU embeeded RISC */
 163 #define EM_NDR1         57      /* Denso NDR1 microprocessor */
 164 #define EM_STARCORE     58      /* Motorola Start*Core processor */
 165 #define EM_ME16         59      /* Toyota ME16 processor */
 166 #define EM_ST100        60      /* STMicroelectronic ST100 processor */
 167 #define EM_TINYJ        61      /* Advanced Logic Corp. Tinyj emb.fam*/
 168 #define EM_X86_64       62      /* Advanced Micro Devices x86-64 */
 169 #define EM_PDSP         63      /* Sony DSP Processor */
 170 #define EM_FX66         66      /* Siemens FX66 microcontroller */
 171 #define EM_ST9PLUS      67      /* STMicroelectronics ST9+ 8/16 mc */
 172 #define EM_ST7          68      /* STmicroelectronics ST7 8 bit mc */
 173 #define EM_68HC16       69      /* Motorola MC68HC16 microcontroller */
 174 #define EM_68HC11       70      /* Motorola MC68HC11 microcontroller */
 175 #define EM_68HC08       71      /* Motorola MC68HC08 microcontroller */
 176 #define EM_68HC05       72      /* Motorola MC68HC05 microcontroller */
 177 #define EM_SVX          73      /* Silicon Graphics SVx */
 178 #define EM_ST19         74      /* STMicroelectronics ST19 8 bit mc */
 179 #define EM_VAX          75      /* Digital VAX */
 180 #define EM_CRIS         76      /* Axis Comm. 32-bit embedded processor */
 181 #define EM_JAVELIN      77      /* Infineon Tech. 32-bit embedded processor */
 182 #define EM_FIREPATH     78      /* Element 14 64-bit DSP Processor */
 183 #define EM_ZSP          79      /* LSI Logic 16-bit DSP Processor */
 184 #define EM_MMIX         80      /* Donald Knuth's educational 64-bit proc */
 185 #define EM_HUANY        81      /* Harvard Uni. machine-independent obj files */
 186 #define EM_PRISM        82      /* SiTera Prism */
 187 #define EM_AVR          83      /* Atmel AVR 8-bit microcontroller */
 188 #define EM_FR30         84      /* Fujitsu FR30 */
 189 #define EM_D10V         85      /* Mitsubishi D10V */
 190 #define EM_D30V         86      /* Mitsubishi D30V */
 191 #define EM_V850         87      /* NEC v850 */
 192 #define EM_M32R         88      /* Mitsubishi M32R */
 193 #define EM_MN10300      89      /* Matsushita MN10300 */
 194 #define EM_MN10200      90      /* Matsushita MN10200 */
 195 #define EM_PJ           91      /* picoJava */
 196 #define EM_OPENRISC     92      /* OpenRISC 32-bit embedded processor */
 197 #define EM_ARC_A5       93      /* ARC Cores Tangent-A5 */
 198 #define EM_XTENSA       94      /* Tensilica Xtensa Architecture */
 199 #define EM_NUM          95
 200 #define EM_ALPHA        0x9026  /* Alpha (written in the absence of an ABI */
 201
 202 /* Special section indexes. */
 203 #define SHN_UNDEF            0          /* Undefined, missing, irrelevant. */
 204 #define SHN_LORESERVE   0xff00          /* First of reserved range. */
 205 #define SHN_LOPROC      0xff00          /* First processor-specific. */
 206 #define SHN_HIPROC      0xff1f          /* Last processor-specific. */
 207 #define SHN_ABS         0xfff1          /* Absolute values. */
 208 #define SHN_COMMON      0xfff2          /* Common data. */
 209 #define SHN_HIRESERVE   0xffff          /* Last of reserved range. */
 210
 211 /* sh_type */
 212 #define SHT_NULL        0               /* inactive */
 213 #define SHT_PROGBITS    1               /* program defined information */
 214 #define SHT_SYMTAB      2               /* symbol table section */
 215 #define SHT_STRTAB      3               /* string table section */
 216 #define SHT_RELA        4               /* relocation section with addends*/
 217 #define SHT_HASH        5               /* symbol hash table section */
 218 #define SHT_DYNAMIC     6               /* dynamic section */
 219 #define SHT_NOTE        7               /* note section */
 220 #define SHT_NOBITS      8               /* no space section */
 221 #define SHT_REL         9               /* relation section without addends */
 222 #define SHT_SHLIB       10              /* reserved - purpose unknown */
 223 #define SHT_DYNSYM      11              /* dynamic symbol table section */
 224 #define SHT_NUM         12              /* number of section types */
 225 #define SHT_LOOS        0x60000000      /* First of OS specific semantics */
 226 #define SHT_HIOS        0x6fffffff      /* Last of OS specific semantics */
 227 #define SHT_LOPROC      0x70000000      /* reserved range for processor */
 228 #define SHT_HIPROC      0x7fffffff      /* specific section header types */
 229 #define SHT_LOUSER      0x80000000      /* reserved range for application */
 230 #define SHT_HIUSER      0xffffffff      /* specific indexes */
 231
 232 /* Flags for sh_flags. */
 233 #define SHF_WRITE       0x1             /* Section contains writable data. */
 234 #define SHF_ALLOC       0x2             /* Section occupies memory. */
 235 #define SHF_EXECINSTR   0x4             /* Section contains instructions. */
 236 #define SHF_TLS         0x400           /* Section contains TLS data. */
 237 #define SHF_MASKPROC    0xf0000000      /* Reserved for processor-specific. */
 238
 239 /* Values for p_type. */
 240 #define PT_NULL         0       /* Unused entry. */
 241 #define PT_LOAD         1       /* Loadable segment. */
 242 #define PT_DYNAMIC      2       /* Dynamic linking information segment. */
 243 #define PT_INTERP       3       /* Pathname of interpreter. */
 244 #define PT_NOTE         4       /* Auxiliary information. */
 245 #define PT_SHLIB        5       /* Reserved (not used). */
 246 #define PT_PHDR         6       /* Location of program header itself. */
 247 #define PT_TLS          7       /* Thread local storage segment */
 248
 249 #define PT_COUNT        8       /* Number of defined p_type values. */
 250
 251 #define PT_LOOS         0x60000000      /* OS-specific */
 252 #define PT_HIOS         0x6fffffff      /* OS-specific */
 253 #define PT_LOPROC       0x70000000      /* First processor-specific type. */
 254 #define PT_HIPROC       0x7fffffff      /* Last processor-specific type. */
 255
 256 /* Values for p_flags. */
 257 #define PF_X            0x1     /* Executable. */
 258 #define PF_W            0x2     /* Writable. */
 259 #define PF_R            0x4     /* Readable. */
 260
 261 /* Values for d_tag. */
 262 #define DT_NULL         0       /* Terminating entry. */
 263 #define DT_NEEDED       1       /* String table offset of a needed shared
 264                                    library. */
 265 #define DT_PLTRELSZ     2       /* Total size in bytes of PLT relocations. */
 266 #define DT_PLTGOT       3       /* Processor-dependent address. */
 267 #define DT_HASH         4       /* Address of symbol hash table. */
 268 #define DT_STRTAB       5       /* Address of string table. */
 269 #define DT_SYMTAB       6       /* Address of symbol table. */
 270 #define DT_RELA         7       /* Address of ElfNN_Rela relocations. */
 271 #define DT_RELASZ       8       /* Total size of ElfNN_Rela relocations. */
 272 #define DT_RELAENT      9       /* Size of each ElfNN_Rela relocation entry. */
 273 #define DT_STRSZ        10      /* Size of string table. */
 274 #define DT_SYMENT       11      /* Size of each symbol table entry. */
 275 #define DT_INIT         12      /* Address of initialization function. */
 276 #define DT_FINI         13      /* Address of finalization function. */
 277 #define DT_SONAME       14      /* String table offset of shared object
 278                                    name. */
 279 #define DT_RPATH        15      /* String table offset of library path. [sup] */
 280 #define DT_SYMBOLIC     16      /* Indicates "symbolic" linking. [sup] */
 281 #define DT_REL          17      /* Address of ElfNN_Rel relocations. */
 282 #define DT_RELSZ        18      /* Total size of ElfNN_Rel relocations. */
 283 #define DT_RELENT       19      /* Size of each ElfNN_Rel relocation. */
 284 #define DT_PLTREL       20      /* Type of relocation used for PLT. */
 285 #define DT_DEBUG        21      /* Reserved (not used). */
 286 #define DT_TEXTREL      22      /* Indicates there may be relocations in
 287                                    non-writable segments. [sup] */
 288 #define DT_JMPREL       23      /* Address of PLT relocations. */
 289 #define DT_BIND_NOW     24      /* [sup] */
 290 #define DT_INIT_ARRAY   25      /* Address of the array of pointers to
 291                                    initialization functions */
 292 #define DT_FINI_ARRAY   26      /* Address of the array of pointers to
 293                                    termination functions */
 294 #define DT_INIT_ARRAYSZ 27      /* Size in bytes of the array of
 295                                    initialization functions. */
 296 #define DT_FINI_ARRAYSZ 28      /* Size in bytes of the array of
 297                                    terminationfunctions. */
 298 #define DT_RUNPATH      29      /* String table offset of a null-terminated
 299                                    library search path string. */
 300 #define DT_FLAGS        30      /* Object specific flag values. */
 301 #define DT_ENCODING     32      /* Values greater than or equal to DT_ENCODING
 302                                    and less than DT_LOOS follow the rules for
 303                                    the interpretation of the d_un union
 304                                    as follows: even == 'd_ptr', even == 'd_val'
 305                                    or none */
 306 #define DT_PREINIT_ARRAY 32     /* Address of the array of pointers to
 307                                    pre-initialization functions. */
 308 #define DT_PREINIT_ARRAYSZ 33   /* Size in bytes of the array of
 309                                    pre-initialization functions. */
 310
 311 #define DT_COUNT        33      /* Number of defined d_tag values. */
 312
 313 #define DT_LOOS         0x6000000d      /* First OS-specific */
 314 #define DT_HIOS         0x6fff0000      /* Last OS-specific */
 315 #define DT_LOPROC       0x70000000      /* First processor-specific type. */
 316 #define DT_HIPROC       0x7fffffff      /* Last processor-specific type. */
 317
 318 /* Values for DT_FLAGS */
 319 #define DF_ORIGIN       0x0001  /* Indicates that the object being loaded may
 320                                    make reference to the $ORIGIN substitution
 321                                    string */
 322 #define DF_SYMBOLIC     0x0002  /* Indicates "symbolic" linking. */
 323 #define DF_TEXTREL      0x0004  /* Indicates there may be relocations in
 324                                    non-writable segments. */
 325 #define DF_BIND_NOW     0x0008  /* Indicates that the dynamic linker should
 326                                    process all relocations for the object
 327                                    containing this entry before transferring
 328                                    control to the program. */
 329 #define DF_STATIC_TLS   0x0010  /* Indicates that the shared object or
 330                                    executable contains code using a static
 331                                    thread-local storage scheme. */
 332
 333 /* Values for n_type.  Used in core files. */
 334 #define NT_PRSTATUS     1       /* Process status. */
 335 #define NT_FPREGSET     2       /* Floating point registers. */
 336 #define NT_PRPSINFO     3       /* Process state info. */
 337
 338 /* Symbol Binding - ELFNN_ST_BIND - st_info */
 339 #define STB_LOCAL       0       /* Local symbol */
 340 #define STB_GLOBAL      1       /* Global symbol */
 341 #define STB_WEAK        2       /* like global - lower precedence */
 342 #define STB_LOPROC      13      /* reserved range for processor */
 343 #define STB_HIPROC      15      /*  specific symbol bindings */
 344
 345 /* Symbol type - ELFNN_ST_TYPE - st_info */
 346 #define STT_NOTYPE      0       /* Unspecified type. */
 347 #define STT_OBJECT      1       /* Data object. */
 348 #define STT_FUNC        2       /* Function. */
 349 #define STT_SECTION     3       /* Section. */
 350 #define STT_FILE        4       /* Source file. */
 351 #define STT_TLS         6       /* TLS object. */
 352 #define STT_LOPROC      13      /* reserved range for processor */
 353 #define STT_HIPROC      15      /*  specific symbol types */
 354
 355 /* Special symbol table indexes. */
 356 #define STN_UNDEF       0       /* Undefined symbol index. */
 357
 358 #endif /* !_SYS_ELF_COMMON_H_ */