Initial revision
[binutils.git] / include / elf / common.h
blobcda3ba0d9d53c2ea04b512df2ab43d3d45875b87
1 /* ELF support for BFD.
2 Copyright (C) 1991,92,93,94,95,96,97,98,99 Free Software Foundation, Inc.
4 Written by Fred Fish @ Cygnus Support, from information published
5 in "UNIX System V Release 4, Programmers Guide: ANSI C and
6 Programming Support Tools".
8 This file is part of BFD, the Binary File Descriptor library.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
25 /* This file is part of ELF support for BFD, and contains the portions
26 that are common to both the internal and external representations.
27 For example, ELFMAG0 is the byte 0x7F in both the internal (in-memory)
28 and external (in-file) representations. */
30 #ifndef _ELF_COMMON_H
31 #define _ELF_COMMON_H
33 /* Fields in e_ident[] */
35 #define EI_MAG0 0 /* File identification byte 0 index */
36 #define ELFMAG0 0x7F /* Magic number byte 0 */
38 #define EI_MAG1 1 /* File identification byte 1 index */
39 #define ELFMAG1 'E' /* Magic number byte 1 */
41 #define EI_MAG2 2 /* File identification byte 2 index */
42 #define ELFMAG2 'L' /* Magic number byte 2 */
44 #define EI_MAG3 3 /* File identification byte 3 index */
45 #define ELFMAG3 'F' /* Magic number byte 3 */
47 #define EI_CLASS 4 /* File class */
48 #define ELFCLASSNONE 0 /* Invalid class */
49 #define ELFCLASS32 1 /* 32-bit objects */
50 #define ELFCLASS64 2 /* 64-bit objects */
52 #define EI_DATA 5 /* Data encoding */
53 #define ELFDATANONE 0 /* Invalid data encoding */
54 #define ELFDATA2LSB 1 /* 2's complement, little endian */
55 #define ELFDATA2MSB 2 /* 2's complement, big endian */
57 #define EI_VERSION 6 /* File version */
59 #define EI_OSABI 7 /* Operating System/ABI indication */
60 #define ELFOSABI_SYSV 0 /* UNIX System V ABI */
61 #define ELFOSABI_HPUX 1 /* HP-UX operating system */
62 #define ELFOSABI_STANDALONE 255 /* Standalone (embedded) application */
64 #define EI_ABIVERSION 8 /* ABI version */
66 #define EI_PAD 9 /* Start of padding bytes */
69 /* Values for e_type, which identifies the object file type */
71 #define ET_NONE 0 /* No file type */
72 #define ET_REL 1 /* Relocatable file */
73 #define ET_EXEC 2 /* Executable file */
74 #define ET_DYN 3 /* Shared object file */
75 #define ET_CORE 4 /* Core file */
76 #define ET_LOOS 0xFE00 /* Operating system-specific */
77 #define ET_HIOS 0xFEFF /* Operating system-specific */
78 #define ET_LOPROC 0xFF00 /* Processor-specific */
79 #define ET_HIPROC 0xFFFF /* Processor-specific */
81 /* Values for e_machine, which identifies the architecture */
83 #define EM_NONE 0 /* No machine */
84 #define EM_M32 1 /* AT&T WE 32100 */
85 #define EM_SPARC 2 /* SUN SPARC */
86 #define EM_386 3 /* Intel 80386 */
87 #define EM_68K 4 /* Motorola m68k family */
88 #define EM_88K 5 /* Motorola m88k family */
89 #define EM_486 6 /* Intel 80486 */
90 #define EM_860 7 /* Intel 80860 */
91 #define EM_MIPS 8 /* MIPS R3000 (officially, big-endian only) */
92 #define EM_S370 9 /* Amdahl */
93 #define EM_MIPS_RS4_BE 10 /* MIPS R4000 big-endian */
95 #define EM_PARISC 15 /* HPPA */
96 #define EM_VPP550 17 /* Fujitsu VPP500 */
97 #define EM_SPARC32PLUS 18 /* Sun's "v8plus" */
98 #define EM_960 19 /* Intel 80960 */
99 #define EM_PPC 20 /* PowerPC */
101 #define EM_V800 36 /* NEC V800 series */
102 #define EM_FR20 37 /* Fujitsu FR20 */
103 #define EM_RH32 38 /* TRW RH32 */
104 #define EM_MCORE 39 /* Motorolla MCore */ /* May also be taken by Fujitsu MMA */
105 #define EM_ARM 40 /* ARM */
106 #define EM_OLD_ALPHA 41 /* Digital Alpha */
107 #define EM_SH 42 /* Hitachi SH */
108 #define EM_SPARCV9 43 /* SPARC v9 64-bit */
109 #define EM_TRICORE 44 /* Siemens Tricore embedded processor */
110 #define EM_ARC 45 /* Argonaut RISC Core, Argonaut Technologies Inc. */
111 #define EM_H8_300 46 /* Hitachi H8/300 */
112 #define EM_H8_300H 47 /* Hitachi H8/300H */
113 #define EM_H8S 48 /* Hitachi H8S */
114 #define EM_H8_500 49 /* Hitachi H8/500 */
115 #define EM_IA_64 50 /* Intel MercedTM Processor */
116 #define EM_MIPS_X 51 /* Stanford MIPS-X */
117 #define EM_COLDFIRE 52 /* Motorola Coldfire */
118 #define EM_68HC12 53 /* Motorola M68HC12 */
120 /* If it is necessary to assign new unofficial EM_* values, please pick large
121 random numbers (0x8523, 0xa7f2, etc.) to minimize the chances of collision
122 with official or non-GNU unofficial values.
124 NOTE: Do not just increment the most recent number by one.
125 Somebody else somewhere will do exactly the same thing, and you
126 will have a collision. Instead, pick a random number. */
128 /* Cygnus PowerPC ELF backend. Written in the absence of an ABI. */
129 #define EM_CYGNUS_POWERPC 0x9025
131 /* Old version of Sparc v9, from before the ABI; this should be
132 removed shortly. */
133 #define EM_OLD_SPARCV9 11
135 /* Old version of PowerPC, this should be removed shortly. */
136 #define EM_PPC_OLD 17
138 /* Cygnus ARC ELF backend. Written in the absence of an ABI. */
139 #define EM_CYGNUS_ARC 0x9040
141 /* Cygnus M32R ELF backend. Written in the absence of an ABI. */
142 #define EM_CYGNUS_M32R 0x9041
144 /* Alpha backend magic number. Written in the absence of an ABI. */
145 #define EM_ALPHA 0x9026
147 /* D10V backend magic number. Written in the absence of an ABI. */
148 #define EM_CYGNUS_D10V 0x7650
150 /* D30V backend magic number. Written in the absence of an ABI. */
151 #define EM_CYGNUS_D30V 0x7676
153 /* V850 backend magic number. Written in the absense of an ABI. */
154 #define EM_CYGNUS_V850 0x9080
156 /* mn10200 and mn10300 backend magic numbers.
157 Written in the absense of an ABI. */
158 #define EM_CYGNUS_MN10200 0xdead
159 #define EM_CYGNUS_MN10300 0xbeef
161 /* FR30 magic number - no EABI available. */
162 #define EM_CYGNUS_FR30 0x3330
164 /* See the above comment before you add a new EM_* value here. */
166 /* Values for e_version */
168 #define EV_NONE 0 /* Invalid ELF version */
169 #define EV_CURRENT 1 /* Current version */
171 /* Values for program header, p_type field */
173 #define PT_NULL 0 /* Program header table entry unused */
174 #define PT_LOAD 1 /* Loadable program segment */
175 #define PT_DYNAMIC 2 /* Dynamic linking information */
176 #define PT_INTERP 3 /* Program interpreter */
177 #define PT_NOTE 4 /* Auxiliary information */
178 #define PT_SHLIB 5 /* Reserved, unspecified semantics */
179 #define PT_PHDR 6 /* Entry for header table itself */
180 #define PT_LOOS 0x60000000 /* OS-specific */
181 #define PT_HIOS 0x6fffffff /* OS-specific */
182 #define PT_LOPROC 0x70000000 /* Processor-specific */
183 #define PT_HIPROC 0x7FFFFFFF /* Processor-specific */
185 /* Program segment permissions, in program header p_flags field */
187 #define PF_X (1 << 0) /* Segment is executable */
188 #define PF_W (1 << 1) /* Segment is writable */
189 #define PF_R (1 << 2) /* Segment is readable */
190 #define PF_MASKOS 0x0F000000 /* OS-specific reserved bits */
191 #define PF_MASKPROC 0xF0000000 /* Processor-specific reserved bits */
193 /* Values for section header, sh_type field */
195 #define SHT_NULL 0 /* Section header table entry unused */
196 #define SHT_PROGBITS 1 /* Program specific (private) data */
197 #define SHT_SYMTAB 2 /* Link editing symbol table */
198 #define SHT_STRTAB 3 /* A string table */
199 #define SHT_RELA 4 /* Relocation entries with addends */
200 #define SHT_HASH 5 /* A symbol hash table */
201 #define SHT_DYNAMIC 6 /* Information for dynamic linking */
202 #define SHT_NOTE 7 /* Information that marks file */
203 #define SHT_NOBITS 8 /* Section occupies no space in file */
204 #define SHT_REL 9 /* Relocation entries, no addends */
205 #define SHT_SHLIB 10 /* Reserved, unspecified semantics */
206 #define SHT_DYNSYM 11 /* Dynamic linking symbol table */
208 #define SHT_LOOS 0x60000000 /* Operating system specific semantics, lo */
209 #define SHT_HIOS 0x6fffffff /* Operating system specific semantics, hi */
211 /* The next three section types are defined by Solaris, and are named
212 SHT_SUNW*. We use them in GNU code, so we also define SHT_GNU*
213 versions. */
214 #define SHT_SUNW_verdef 0x6ffffffd /* Versions defined by file */
215 #define SHT_SUNW_verneed 0x6ffffffe /* Versions needed by file */
216 #define SHT_SUNW_versym 0x6fffffff /* Symbol versions */
218 #define SHT_GNU_verdef SHT_SUNW_verdef
219 #define SHT_GNU_verneed SHT_SUNW_verneed
220 #define SHT_GNU_versym SHT_SUNW_versym
222 #define SHT_LOPROC 0x70000000 /* Processor-specific semantics, lo */
223 #define SHT_HIPROC 0x7FFFFFFF /* Processor-specific semantics, hi */
224 #define SHT_LOUSER 0x80000000 /* Application-specific semantics */
225 #define SHT_HIUSER 0x8FFFFFFF /* Application-specific semantics */
227 /* Values for section header, sh_flags field */
229 #define SHF_WRITE (1 << 0) /* Writable data during execution */
230 #define SHF_ALLOC (1 << 1) /* Occupies memory during execution */
231 #define SHF_EXECINSTR (1 << 2) /* Executable machine instructions */
232 #define SHF_MASKOS 0x0F000000 /* OS-specific semantics */
233 #define SHF_MASKPROC 0xF0000000 /* Processor-specific semantics */
235 /* Values of note segment descriptor types for core files. */
237 #define NT_PRSTATUS 1 /* Contains copy of prstatus struct */
238 #define NT_FPREGSET 2 /* Contains copy of fpregset struct */
239 #define NT_PRPSINFO 3 /* Contains copy of prpsinfo struct */
241 /* Note segments for core files on dir-style procfs systems. */
243 #define NT_PSTATUS 10 /* Has a struct pstatus */
244 #define NT_FPREGS 12 /* Has a struct fpregset */
245 #define NT_PSINFO 13 /* Has a struct psinfo */
246 #define NT_LWPSTATUS 16 /* Has a struct lwpstatus_t */
247 #define NT_LWPSINFO 17 /* Has a struct lwpsinfo_t */
249 /* Values of note segment descriptor types for object files. */
250 /* (Only for hppa right now. Should this be moved elsewhere?) */
252 #define NT_VERSION 1 /* Contains a version string. */
254 /* These three macros disassemble and assemble a symbol table st_info field,
255 which contains the symbol binding and symbol type. The STB_ and STT_
256 defines identify the binding and type. */
258 #define ELF_ST_BIND(val) (((unsigned int)(val)) >> 4)
259 #define ELF_ST_TYPE(val) ((val) & 0xF)
260 #define ELF_ST_INFO(bind,type) (((bind) << 4) + ((type) & 0xF))
262 #define STN_UNDEF 0 /* undefined symbol index */
264 #define STB_LOCAL 0 /* Symbol not visible outside obj */
265 #define STB_GLOBAL 1 /* Symbol visible outside obj */
266 #define STB_WEAK 2 /* Like globals, lower precedence */
267 #define STB_LOOS 10 /* OS-specific semantics */
268 #define STB_HIOS 12 /* OS-specific semantics */
269 #define STB_LOPROC 13 /* Application-specific semantics */
270 #define STB_HIPROC 15 /* Application-specific semantics */
272 #define STT_NOTYPE 0 /* Symbol type is unspecified */
273 #define STT_OBJECT 1 /* Symbol is a data object */
274 #define STT_FUNC 2 /* Symbol is a code object */
275 #define STT_SECTION 3 /* Symbol associated with a section */
276 #define STT_FILE 4 /* Symbol gives a file name */
277 #define STT_LOOS 10 /* OS-specific semantics */
278 #define STT_HIOS 12 /* OS-specific semantics */
279 #define STT_LOPROC 13 /* Application-specific semantics */
280 #define STT_HIPROC 15 /* Application-specific semantics */
282 /* Special section indices, which may show up in st_shndx fields, among
283 other places. */
285 #define SHN_UNDEF 0 /* Undefined section reference */
286 #define SHN_LORESERVE 0xFF00 /* Begin range of reserved indices */
287 #define SHN_LOPROC 0xFF00 /* Begin range of appl-specific */
288 #define SHN_HIPROC 0xFF1F /* End range of appl-specific */
289 #define SHN_LOOS 0xFF20 /* OS specific semantics, lo */
290 #define SHN_HIOS 0xFF3F /* OS specific semantics, hi */
291 #define SHN_ABS 0xFFF1 /* Associated symbol is absolute */
292 #define SHN_COMMON 0xFFF2 /* Associated symbol is in common */
293 #define SHN_HIRESERVE 0xFFFF /* End range of reserved indices */
295 /* relocation info handling macros */
297 #define ELF32_R_SYM(i) ((i) >> 8)
298 #define ELF32_R_TYPE(i) ((i) & 0xff)
299 #define ELF32_R_INFO(s,t) (((s) << 8) + ((t) & 0xff))
301 #define ELF64_R_SYM(i) ((i) >> 32)
302 #define ELF64_R_TYPE(i) ((i) & 0xffffffff)
303 #define ELF64_R_INFO(s,t) (((bfd_vma) (s) << 32) + (bfd_vma) (t))
305 /* Dynamic section tags */
307 #define DT_NULL 0
308 #define DT_NEEDED 1
309 #define DT_PLTRELSZ 2
310 #define DT_PLTGOT 3
311 #define DT_HASH 4
312 #define DT_STRTAB 5
313 #define DT_SYMTAB 6
314 #define DT_RELA 7
315 #define DT_RELASZ 8
316 #define DT_RELAENT 9
317 #define DT_STRSZ 10
318 #define DT_SYMENT 11
319 #define DT_INIT 12
320 #define DT_FINI 13
321 #define DT_SONAME 14
322 #define DT_RPATH 15
323 #define DT_SYMBOLIC 16
324 #define DT_REL 17
325 #define DT_RELSZ 18
326 #define DT_RELENT 19
327 #define DT_PLTREL 20
328 #define DT_DEBUG 21
329 #define DT_TEXTREL 22
330 #define DT_JMPREL 23
331 #define DT_BIND_NOW 24
332 #define DT_INIT_ARRAY 25
333 #define DT_FINI_ARRAY 26
334 #define DT_INIT_ARRAYSZ 27
335 #define DT_FINI_ARRAYSZ 28
337 #define DT_LOOS 0x60000000
338 #define DT_HIOS 0x6fffffff
340 /* The next four dynamic tags are used on Solaris. We support them
341 everywhere. */
342 #define DT_VALRNGLO 0x6ffffd00
343 #define DT_PLTPADSZ 0x6ffffdf9
344 #define DT_MOVEENT 0x6ffffdfa
345 #define DT_MOVESZ 0x6ffffdfb
346 #define DT_FEATURE_1 0x6ffffdfc
347 #define DT_POSFLAG_1 0x6ffffdfd
348 #define DT_SYMINSZ 0x6ffffdfe
349 #define DT_SYMINENT 0x6ffffdff
350 #define DT_VALRNGHI 0x6ffffdff
352 #define DT_ADDRRNGLO 0x6ffffe00
353 #define DT_SYMINFO 0x6ffffeff
354 #define DT_ADDRRNGHI 0x6ffffeff
356 #define DT_RELACOUNT 0x6ffffff9
357 #define DT_RELCOUNT 0x6ffffffa
358 #define DT_FLAGS_1 0x6ffffffb
359 #define DT_VERDEF 0x6ffffffc
360 #define DT_VERDEFNUM 0x6ffffffd
361 #define DT_VERNEED 0x6ffffffe
362 #define DT_VERNEEDNUM 0x6fffffff
364 /* This tag is a GNU extension to the Solaris version scheme. */
365 #define DT_VERSYM 0x6ffffff0
367 #define DT_LOPROC 0x70000000
368 #define DT_HIPROC 0x7fffffff
370 /* These section tags are used on Solaris. We support them
371 everywhere, and hope they do not conflict. */
373 #define DT_AUXILIARY 0x7ffffffd
374 #define DT_USED 0x7ffffffe
375 #define DT_FILTER 0x7fffffff
377 /* Values used in DT_FEATURE_1 .dynamic entry. */
378 #define DTF_1_PARINIT 0x00000001
380 /* Flag values used in the DT_POSFLAG_1 .dynamic entry. */
381 #define DF_P1_LAZYLOAD 0x00000001
382 #define DF_P1_GROUPPERM 0x00000002
384 /* Flag value in in the DT_1_FLAGS .dynamic entry. */
385 #define DF_1_NOW 0x00000001
386 #define DF_1_GLOBAL 0x00000002
387 #define DF_1_GROUP 0x00000004
388 #define DF_1_NODELETE 0x00000008
389 #define DF_1_LOADFLTR 0x00000010
390 #define DF_1_INITFIRST 0x00000020
391 #define DF_1_NOOPEN 0x00000040
392 #define DF_1_ORIGIN 0x00000080
393 #define DF_1_DIRECT 0x00000100
394 #define DF_1_TRANS 0x00000200
395 #define DF_1_INTERPOSE 0x00000400
397 /* These constants are used for the version number of a Elf32_Verdef
398 structure. */
400 #define VER_DEF_NONE 0
401 #define VER_DEF_CURRENT 1
403 /* These constants appear in the vd_flags field of a Elf32_Verdef
404 structure. */
406 #define VER_FLG_BASE 0x1
407 #define VER_FLG_WEAK 0x2
409 /* These special constants can be found in an Elf32_Versym field. */
411 #define VER_NDX_LOCAL 0
412 #define VER_NDX_GLOBAL 1
414 /* These constants are used for the version number of a Elf32_Verneed
415 structure. */
417 #define VER_NEED_NONE 0
418 #define VER_NEED_CURRENT 1
420 /* This flag appears in a Versym structure. It means that the symbol
421 is hidden, and is only visible with an explicit version number.
422 This is a GNU extension. */
424 #define VERSYM_HIDDEN 0x8000
426 /* This is the mask for the rest of the Versym information. */
428 #define VERSYM_VERSION 0x7fff
430 /* This is a special token which appears as part of a symbol name. It
431 indictes that the rest of the name is actually the name of a
432 version node, and is not part of the actual name. This is a GNU
433 extension. For example, the symbol name `stat@ver2' is taken to
434 mean the symbol `stat' in version `ver2'. */
436 #define ELF_VER_CHR '@'
438 /* Possible values for si_boundto. */
439 #define SYMINFO_BT_SELF 0xffff /* Symbol bound to self */
440 #define SYMINFO_BT_PARENT 0xfffe /* Symbol bound to parent */
441 #define SYMINFO_BT_LOWRESERVE 0xff00 /* Beginning of reserved entries */
443 /* Possible bitmasks for si_flags. */
444 #define SYMINFO_FLG_DIRECT 0x0001 /* Direct bound symbol */
445 #define SYMINFO_FLG_PASSTHRU 0x0002 /* Pass-thru symbol for translator */
446 #define SYMINFO_FLG_COPY 0x0004 /* Symbol is a copy-reloc */
447 #define SYMINFO_FLG_LAZYLOAD 0x0008 /* Symbol bound to object to be lazy
448 loaded */
449 /* Syminfo version values. */
450 #define SYMINFO_NONE 0
451 #define SYMINFO_CURRENT 1
452 #define SYMINFO_NUM 2
454 #endif /* _ELF_COMMON_H */