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$
  27  */
  28
  29 #ifndef _SYS_ELF_COMMON_H_
  30 #define _SYS_ELF_COMMON_H_ 1
  31
  32 /*
  33  * ELF definitions that are independent of architecture or word size.
  34  */
  35
  36 /*
  37  * Note header.  The ".note" section contains an array of notes.  Each
  38  * begins with this header, aligned to a word boundary.  Immediately
  39  * following the note header is n_namesz bytes of name, padded to the
  40  * next word boundary.  Then comes n_descsz bytes of descriptor, again
  41  * padded to a word boundary.  The values of n_namesz and n_descsz do
  42  * not include the padding.
  43  */
  44
  45 typedef struct {
  46         u_int32_t       n_namesz;       /* Length of name. */
  47         u_int32_t       n_descsz;       /* Length of descriptor. */
  48         u_int32_t       n_type;         /* Type of this note. */
  49 } Elf_Note;
  50
  51 /* Indexes into the e_ident array.  Keep synced with
  52    http://www.sco.com/developer/gabi/ch4.eheader.html */
  53 #define EI_MAG0         0       /* Magic number, byte 0. */
  54 #define EI_MAG1         1       /* Magic number, byte 1. */
  55 #define EI_MAG2         2       /* Magic number, byte 2. */
  56 #define EI_MAG3         3       /* Magic number, byte 3. */
  57 #define EI_CLASS        4       /* Class of machine. */
  58 #define EI_DATA         5       /* Data format. */
  59 #define EI_VERSION      6       /* ELF format version. */
  60 #define EI_OSABI        7       /* Operating system / ABI identification */
  61 #define EI_ABIVERSION   8       /* ABI version */
  62 #define OLD_EI_BRAND    8       /* Start of architecture identification. */
  63 #define EI_PAD          9       /* Start of padding (per SVR4 ABI). */
  64 #define EI_NIDENT       16      /* Size of e_ident array. */
  65
  66 /* Values for the magic number bytes. */
  67 #define ELFMAG0         0x7f
  68 #define ELFMAG1         'E'
  69 #define ELFMAG2         'L'
  70 #define ELFMAG3         'F'
  71 #define ELFMAG          "\177ELF"       /* magic string */
  72 #define SELFMAG         4               /* magic string size */
  73
  74 /* Values for e_ident[EI_VERSION] and e_version. */
  75 #define EV_NONE         0
  76 #define EV_CURRENT      1
  77
  78 /* Values for e_ident[EI_CLASS]. */
  79 #define ELFCLASSNONE    0       /* Unknown class. */
  80 #define ELFCLASS32      1       /* 32-bit architecture. */
  81 #define ELFCLASS64      2       /* 64-bit architecture. */
  82
  83 /* Values for e_ident[EI_DATA]. */
  84 #define ELFDATANONE     0       /* Unknown data format. */
  85 #define ELFDATA2LSB     1       /* 2's complement little-endian. */
  86 #define ELFDATA2MSB     2       /* 2's complement big-endian. */
  87
  88 /* Values for e_ident[EI_OSABI]. */
  89 #define ELFOSABI_NONE           0       /* UNIX System V ABI */
  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_AIX            7       /* AIX */
  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_OPENVMS        13      /* Open VMS */
 103 #define ELFOSABI_NSK            14      /* HP Non-Stop Kernel */
 104 #define ELFOSABI_ARM            97      /* ARM */
 105 #define ELFOSABI_STANDALONE     255     /* Standalone (embedded) application */
 106
 107 #define ELFOSABI_SYSV           ELFOSABI_NONE   /* symbol used in old spec */
 108 #define ELFOSABI_MONTEREY       ELFOSABI_AIX    /* Monterey */
 109
 110 /* e_ident */
 111 #define IS_ELF(ehdr)    ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
 112                          (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
 113                          (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
 114                          (ehdr).e_ident[EI_MAG3] == ELFMAG3)
 115
 116 /* Values for e_type. */
 117 #define ET_NONE         0       /* Unknown type. */
 118 #define ET_REL          1       /* Relocatable. */
 119 #define ET_EXEC         2       /* Executable. */
 120 #define ET_DYN          3       /* Shared object. */
 121 #define ET_CORE         4       /* Core file. */
 122 #define ET_LOOS         0xfe00  /* First operating system specific. */
 123 #define ET_HIOS         0xfeff  /* Last operating system-specific. */
 124 #define ET_LOPROC       0xff00  /* First processor-specific. */
 125 #define ET_HIPROC       0xffff  /* Last processor-specific. */
 126
 127 /* Values for e_machine. */
 128 #define EM_NONE         0       /* Unknown machine. */
 129 #define EM_M32          1       /* AT&T WE32100. */
 130 #define EM_SPARC        2       /* Sun SPARC. */
 131 #define EM_386          3       /* Intel i386. */
 132 #define EM_68K          4       /* Motorola 68000. */
 133 #define EM_88K          5       /* Motorola 88000. */
 134 #define EM_860          7       /* Intel i860. */
 135 #define EM_MIPS         8       /* MIPS R3000 Big-Endian only. */
 136 #define EM_S370         9       /* IBM System/370. */
 137 #define EM_MIPS_RS3_LE  10      /* MIPS R3000 Little-Endian. */
 138 #define EM_PARISC       15      /* HP PA-RISC. */
 139 #define EM_VPP500       17      /* Fujitsu VPP500. */
 140 #define EM_SPARC32PLUS  18      /* SPARC v8plus. */
 141 #define EM_960          19      /* Intel 80960. */
 142 #define EM_PPC          20      /* PowerPC 32-bit. */
 143 #define EM_PPC64        21      /* PowerPC 64-bit. */
 144 #define EM_S390         22      /* IBM System/390. */
 145 #define EM_V800         36      /* NEC V800. */
 146 #define EM_FR20         37      /* Fujitsu FR20. */
 147 #define EM_RH32         38      /* TRW RH-32. */
 148 #define EM_RCE          39      /* Motorola RCE. */
 149 #define EM_ARM          40      /* ARM. */
 150 #define EM_SH           42      /* Hitachi SH. */
 151 #define EM_SPARCV9      43      /* SPARC v9 64-bit. */
 152 #define EM_TRICORE      44      /* Siemens TriCore embedded processor. */
 153 #define EM_ARC          45      /* Argonaut RISC Core. */
 154 #define EM_H8_300       46      /* Hitachi H8/300. */
 155 #define EM_H8_300H      47      /* Hitachi H8/300H. */
 156 #define EM_H8S          48      /* Hitachi H8S. */
 157 #define EM_H8_500       49      /* Hitachi H8/500. */
 158 #define EM_IA_64        50      /* Intel IA-64 Processor. */
 159 #define EM_MIPS_X       51      /* Stanford MIPS-X. */
 160 #define EM_COLDFIRE     52      /* Motorola ColdFire. */
 161 #define EM_68HC12       53      /* Motorola M68HC12. */
 162 #define EM_MMA          54      /* Fujitsu MMA. */
 163 #define EM_PCP          55      /* Siemens PCP. */
 164 #define EM_NCPU         56      /* Sony nCPU. */
 165 #define EM_NDR1         57      /* Denso NDR1 microprocessor. */
 166 #define EM_STARCORE     58      /* Motorola Star*Core processor. */
 167 #define EM_ME16         59      /* Toyota ME16 processor. */
 168 #define EM_ST100        60      /* STMicroelectronics ST100 processor. */
 169 #define EM_TINYJ        61      /* Advanced Logic Corp. TinyJ processor. */
 170 #define EM_X86_64       62      /* Advanced Micro Devices x86-64 */
 171
 172 /* Non-standard or deprecated. */
 173 #define EM_486          6       /* Intel i486. */
 174 #define EM_MIPS_RS4_BE  10      /* MIPS R4000 Big-Endian */
 175 #define EM_ALPHA_STD    41      /* Digital Alpha (standard value). */
 176 #define EM_ALPHA        0x9026  /* Alpha (written in the absence of an ABI) */
 177
 178 /* Special section indexes. */
 179 #define SHN_UNDEF            0          /* Undefined, missing, irrelevant. */
 180 #define SHN_LORESERVE   0xff00          /* First of reserved range. */
 181 #define SHN_LOPROC      0xff00          /* First processor-specific. */
 182 #define SHN_HIPROC      0xff1f          /* Last processor-specific. */
 183 #define SHN_LOOS        0xff20          /* First operating system-specific. */
 184 #define SHN_HIOS        0xff3f          /* Last operating system-specific. */
 185 #define SHN_ABS         0xfff1          /* Absolute values. */
 186 #define SHN_COMMON      0xfff2          /* Common data. */
 187 #define SHN_XINDEX      0xffff          /* Escape -- index stored elsewhere. */
 188 #define SHN_HIRESERVE   0xffff          /* Last of reserved range. */
 189
 190 /* sh_type */
 191 #define SHT_NULL                0       /* inactive */
 192 #define SHT_PROGBITS            1       /* program defined information */
 193 #define SHT_SYMTAB              2       /* symbol table section */
 194 #define SHT_STRTAB              3       /* string table section */
 195 #define SHT_RELA                4       /* relocation section with addends */
 196 #define SHT_HASH                5       /* symbol hash table section */
 197 #define SHT_DYNAMIC             6       /* dynamic section */
 198 #define SHT_NOTE                7       /* note section */
 199 #define SHT_NOBITS              8       /* no space section */
 200 #define SHT_REL                 9       /* relocation section - no addends */
 201 #define SHT_SHLIB               10      /* reserved - purpose unknown */
 202 #define SHT_DYNSYM              11      /* dynamic symbol table section */
 203 #define SHT_INIT_ARRAY          14      /* Initialization function pointers. */
 204 #define SHT_FINI_ARRAY          15      /* Termination function pointers. */
 205 #define SHT_PREINIT_ARRAY       16      /* Pre-initialization function ptrs. */
 206 #define SHT_GROUP               17      /* Section group. */
 207 #define SHT_SYMTAB_SHNDX        18      /* Section indexes (see SHN_XINDEX). */
 208 #define SHT_LOOS        0x60000000      /* First of OS specific semantics */
 209 #define SHT_GNU_verdef  0x6ffffffd      /* Symbol versions provided */
 210 #define SHT_GNU_verneed 0x6ffffffe      /* Symbol versions required */
 211 #define SHT_GNU_versym  0x6fffffff      /* Symbol version table */
 212 #define SHT_HIOS        0x6fffffff      /* Last of OS specific semantics */
 213 #define SHT_LOPROC      0x70000000      /* reserved range for processor */
 214 #define SHT_HIPROC      0x7fffffff      /* specific section header types */
 215 #define SHT_LOUSER      0x80000000      /* reserved range for application */
 216 #define SHT_HIUSER      0xffffffff      /* specific indexes */
 217
 218 /* Flags for sh_flags. */
 219 #define SHF_WRITE               0x1     /* Section contains writable data. */
 220 #define SHF_ALLOC               0x2     /* Section occupies memory. */
 221 #define SHF_EXECINSTR           0x4     /* Section contains instructions. */
 222 #define SHF_MERGE               0x10    /* Section may be merged. */
 223 #define SHF_STRINGS             0x20    /* Section contains strings. */
 224 #define SHF_INFO_LINK           0x40    /* sh_info holds section index. */
 225 #define SHF_LINK_ORDER          0x80    /* Special ordering requirements. */
 226 #define SHF_OS_NONCONFORMING    0x100   /* OS-specific processing required. */
 227 #define SHF_GROUP               0x200   /* Member of section group. */
 228 #define SHF_TLS                 0x400   /* Section contains TLS data. */
 229 #define SHF_MASKOS      0x0ff00000      /* OS-specific semantics. */
 230 #define SHF_MASKPROC    0xf0000000      /* Processor-specific semantics. */
 231
 232 /* Values for p_type. */
 233 #define PT_NULL         0       /* Unused entry. */
 234 #define PT_LOAD         1       /* Loadable segment. */
 235 #define PT_DYNAMIC      2       /* Dynamic linking information segment. */
 236 #define PT_INTERP       3       /* Pathname of interpreter. */
 237 #define PT_NOTE         4       /* Auxiliary information. */
 238 #define PT_SHLIB        5       /* Reserved (not used). */
 239 #define PT_PHDR         6       /* Location of program header itself. */
 240 #define PT_TLS          7       /* Thread local storage segment */
 241 #define PT_LOOS         0x60000000      /* First OS-specific. */
 242 #define PT_HIOS         0x6fffffff      /* Last OS-specific. */
 243 #define PT_LOPROC       0x70000000      /* First processor-specific type. */
 244 #define PT_HIPROC       0x7fffffff      /* Last processor-specific type. */
 245
 246 /* Values for p_flags. */
 247 #define PF_X            0x1             /* Executable. */
 248 #define PF_W            0x2             /* Writable. */
 249 #define PF_R            0x4             /* Readable. */
 250 #define PF_MASKOS       0x0ff00000      /* Operating system-specific. */
 251 #define PF_MASKPROC     0xf0000000      /* Processor-specific. */
 252
 253 /* Values for d_tag. */
 254 #define DT_NULL         0       /* Terminating entry. */
 255 #define DT_NEEDED       1       /* String table offset of a needed shared
 256                                    library. */
 257 #define DT_PLTRELSZ     2       /* Total size in bytes of PLT relocations. */
 258 #define DT_PLTGOT       3       /* Processor-dependent address. */
 259 #define DT_HASH         4       /* Address of symbol hash table. */
 260 #define DT_STRTAB       5       /* Address of string table. */
 261 #define DT_SYMTAB       6       /* Address of symbol table. */
 262 #define DT_RELA         7       /* Address of ElfNN_Rela relocations. */
 263 #define DT_RELASZ       8       /* Total size of ElfNN_Rela relocations. */
 264 #define DT_RELAENT      9       /* Size of each ElfNN_Rela relocation entry. */
 265 #define DT_STRSZ        10      /* Size of string table. */
 266 #define DT_SYMENT       11      /* Size of each symbol table entry. */
 267 #define DT_INIT         12      /* Address of initialization function. */
 268 #define DT_FINI         13      /* Address of finalization function. */
 269 #define DT_SONAME       14      /* String table offset of shared object
 270                                    name. */
 271 #define DT_RPATH        15      /* String table offset of library path. [sup] */
 272 #define DT_SYMBOLIC     16      /* Indicates "symbolic" linking. [sup] */
 273 #define DT_REL          17      /* Address of ElfNN_Rel relocations. */
 274 #define DT_RELSZ        18      /* Total size of ElfNN_Rel relocations. */
 275 #define DT_RELENT       19      /* Size of each ElfNN_Rel relocation. */
 276 #define DT_PLTREL       20      /* Type of relocation used for PLT. */
 277 #define DT_DEBUG        21      /* Reserved (not used). */
 278 #define DT_TEXTREL      22      /* Indicates there may be relocations in
 279                                    non-writable segments. [sup] */
 280 #define DT_JMPREL       23      /* Address of PLT relocations. */
 281 #define DT_BIND_NOW     24      /* [sup] */
 282 #define DT_INIT_ARRAY   25      /* Address of the array of pointers to
 283                                    initialization functions */
 284 #define DT_FINI_ARRAY   26      /* Address of the array of pointers to
 285                                    termination functions */
 286 #define DT_INIT_ARRAYSZ 27      /* Size in bytes of the array of
 287                                    initialization functions. */
 288 #define DT_FINI_ARRAYSZ 28      /* Size in bytes of the array of
 289                                    terminationfunctions. */
 290 #define DT_RUNPATH      29      /* String table offset of a null-terminated
 291                                    library search path string. */
 292 #define DT_FLAGS        30      /* Object specific flag values. */
 293 #define DT_ENCODING     32      /* Values greater than or equal to DT_ENCODING
 294                                    and less than DT_LOOS follow the rules for
 295                                    the interpretation of the d_un union
 296                                    as follows: even == 'd_ptr', even == 'd_val'
 297                                    or none */
 298 #define DT_PREINIT_ARRAY 32     /* Address of the array of pointers to
 299                                    pre-initialization functions. */
 300 #define DT_PREINIT_ARRAYSZ 33   /* Size in bytes of the array of
 301                                    pre-initialization functions. */
 302 #define DT_LOOS         0x6000000d      /* First OS-specific */
 303 #define DT_HIOS         0x6ffff000      /* Last OS-specific */
 304 #define DT_LOPROC       0x70000000      /* First processor-specific type. */
 305 #define DT_HIPROC       0x7fffffff      /* Last processor-specific type. */
 306
 307 #define DT_VERSYM       0x6ffffff0      /* Address of versym section. */
 308 #define DT_VERDEF       0x6ffffffc      /* Address of verdef section. */
 309 #define DT_VERDEFNUM    0x6ffffffd      /* Number of elems in verdef section */
 310 #define DT_VERNEED      0x6ffffffe      /* Address of verneed section. */
 311 #define DT_VERNEEDNUM   0x6fffffff      /* Number of elems in verneed section */
 312
 313 /* Values for DT_FLAGS */
 314 #define DF_ORIGIN       0x0001  /* Indicates that the object being loaded may
 315                                    make reference to the $ORIGIN substitution
 316                                    string */
 317 #define DF_SYMBOLIC     0x0002  /* Indicates "symbolic" linking. */
 318 #define DF_TEXTREL      0x0004  /* Indicates there may be relocations in
 319                                    non-writable segments. */
 320 #define DF_BIND_NOW     0x0008  /* Indicates that the dynamic linker should
 321                                    process all relocations for the object
 322                                    containing this entry before transferring
 323                                    control to the program. */
 324 #define DF_STATIC_TLS   0x0010  /* Indicates that the shared object or
 325                                    executable contains code using a static
 326                                    thread-local storage scheme. */
 327
 328 /* Values for n_type.  Used in core files. */
 329 #define NT_PRSTATUS     1       /* Process status. */
 330 #define NT_FPREGSET     2       /* Floating point registers. */
 331 #define NT_PRPSINFO     3       /* Process state info. */
 332
 333 /* Symbol Binding - ELFNN_ST_BIND - st_info */
 334 #define STB_LOCAL       0       /* Local symbol */
 335 #define STB_GLOBAL      1       /* Global symbol */
 336 #define STB_WEAK        2       /* like global - lower precedence */
 337 #define STB_LOOS        10      /* Reserved range for operating system */
 338 #define STB_HIOS        12      /*   specific semantics. */
 339 #define STB_LOPROC      13      /* reserved range for processor */
 340 #define STB_HIPROC      15      /*   specific semantics. */
 341
 342 /* Symbol type - ELFNN_ST_TYPE - st_info */
 343 #define STT_NOTYPE      0       /* Unspecified type. */
 344 #define STT_OBJECT      1       /* Data object. */
 345 #define STT_FUNC        2       /* Function. */
 346 #define STT_SECTION     3       /* Section. */
 347 #define STT_FILE        4       /* Source file. */
 348 #define STT_COMMON      5       /* Uninitialized common block. */
 349 #define STT_TLS         6       /* TLS object. */
 350 #define STT_LOOS        10      /* Reserved range for operating system */
 351 #define STT_HIOS        12      /*   specific semantics. */
 352 #define STT_LOPROC      13      /* reserved range for processor */
 353 #define STT_HIPROC      15      /*   specific semantics. */
 354
 355 /* Symbol visibility - ELFNN_ST_VISIBILITY - st_other */
 356 #define STV_DEFAULT     0x0     /* Default visibility (see binding). */
 357 #define STV_INTERNAL    0x1     /* Special meaning in relocatable objects. */
 358 #define STV_HIDDEN      0x2     /* Not visible. */
 359 #define STV_PROTECTED   0x3     /* Visible but not preemptible. */
 360
 361 /* Special symbol table indexes. */
 362 #define STN_UNDEF       0       /* Undefined symbol index. */
 363
 364 /* Symbol versioning flags. */
 365 #define VER_DEF_CURRENT 1
 366 #define VER_DEF_IDX(x)  VER_NDX(x)
 367
 368 #define VER_FLG_BASE    0x01
 369 #define VER_FLG_WEAK    0x02
 370
 371 #define VER_NEED_CURRENT        1
 372 #define VER_NEED_WEAK   (1u << 15)
 373 #define VER_NEED_HIDDEN VER_NDX_HIDDEN
 374 #define VER_NEED_IDX(x) VER_NDX(x)
 375
 376 #define VER_NDX_LOCAL   0
 377 #define VER_NDX_GLOBAL  1
 378 #define VER_NDX_GIVEN   2
 379
 380 #define VER_NDX_HIDDEN  (1u << 15)
 381 #define VER_NDX(x)      ((x) & ~(1u << 15))
 382
 383 #endif /* !_SYS_ELF_COMMON_H_ */