add comments about magic numbers
[deliverable/binutils-gdb.git] / include / elf / common.h
1 /* ELF support for BFD.
2 Copyright (C) 1991, 1992, 1993, 1994, 1996 Free Software Foundation, Inc.
3
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".
7
8 This file is part of BFD, the Binary File Descriptor library.
9
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.
14
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.
19
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. */
23
24
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. */
29
30 #ifndef _ELF_COMMON_H
31 #define _ELF_COMMON_H
32
33 /* Fields in e_ident[] */
34
35 #define EI_MAG0 0 /* File identification byte 0 index */
36 #define ELFMAG0 0x7F /* Magic number byte 0 */
37
38 #define EI_MAG1 1 /* File identification byte 1 index */
39 #define ELFMAG1 'E' /* Magic number byte 1 */
40
41 #define EI_MAG2 2 /* File identification byte 2 index */
42 #define ELFMAG2 'L' /* Magic number byte 2 */
43
44 #define EI_MAG3 3 /* File identification byte 3 index */
45 #define ELFMAG3 'F' /* Magic number byte 3 */
46
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 */
51
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 */
56
57 #define EI_VERSION 6 /* File version */
58
59 #define EI_PAD 7 /* Start of padding bytes */
60
61
62 /* Values for e_type, which identifies the object file type */
63
64 #define ET_NONE 0 /* No file type */
65 #define ET_REL 1 /* Relocatable file */
66 #define ET_EXEC 2 /* Executable file */
67 #define ET_DYN 3 /* Shared object file */
68 #define ET_CORE 4 /* Core file */
69 #define ET_LOPROC 0xFF00 /* Processor-specific */
70 #define ET_HIPROC 0xFFFF /* Processor-specific */
71
72 /* Values for e_machine, which identifies the architecture */
73
74 #define EM_NONE 0 /* No machine */
75 #define EM_M32 1 /* AT&T WE 32100 */
76 #define EM_SPARC 2 /* SUN SPARC */
77 #define EM_386 3 /* Intel 80386 */
78 #define EM_68K 4 /* Motorola m68k family */
79 #define EM_88K 5 /* Motorola m88k family */
80 #define EM_860 7 /* Intel 80860 */
81 #define EM_MIPS 8 /* MIPS R3000 (officially, big-endian only) */
82
83 #define EM_MIPS_RS4_BE 10 /* MIPS R4000 big-endian */
84
85 #define EM_SPARC64 11 /* SPARC v9 (not official) 64-bit */
86
87 #define EM_PARISC 15 /* HPPA */
88
89 #define EM_SPARC32PLUS 18 /* Sun's "v8plus" */
90
91 #define EM_PPC 20 /* PowerPC */
92
93 /* If it is necessary to assign new unofficial EM_* values, please pick large
94 random numbers (0x8523, 0xa7f2, etc.) to minimize the chances of collision
95 with official or non-GNU unofficial values.
96
97 NOTE: Do not just increment the most recent number by one.
98 Somebody else somewhere will do exactly the same thing, and you
99 will have a collision. Instead, pick a random number. */
100
101 /* Cygnus PowerPC ELF backend. Written in the absence of an ABI. */
102 #define EM_CYGNUS_POWERPC 0x9025
103
104 /* Old version of PowerPC, this should be removed shortly. */
105 #define EM_PPC_OLD 17
106
107 /* start-sanitize-arc */
108 /* Cygnus ARC ELF backend. Written in the absence of an ABI. */
109 #define EM_CYGNUS_ARC 0x9040
110 /* end-sanitize-arc */
111
112 /* Alpha backend magic number. Written in the absence of an ABI. */
113 #define EM_ALPHA 0x9026
114
115 /* start-sanitize-d10v */
116 /* D10V backend magic number. Written in the absence of an ABI. */
117 #define EM_CYGNUS_D10V 0x9027
118 /* end-sanitize-d10v */
119
120 /* See the above comment before you add a new EM_* value here. */
121
122 /* Values for e_version */
123
124 #define EV_NONE 0 /* Invalid ELF version */
125 #define EV_CURRENT 1 /* Current version */
126
127 /* Values for program header, p_type field */
128
129 #define PT_NULL 0 /* Program header table entry unused */
130 #define PT_LOAD 1 /* Loadable program segment */
131 #define PT_DYNAMIC 2 /* Dynamic linking information */
132 #define PT_INTERP 3 /* Program interpreter */
133 #define PT_NOTE 4 /* Auxiliary information */
134 #define PT_SHLIB 5 /* Reserved, unspecified semantics */
135 #define PT_PHDR 6 /* Entry for header table itself */
136 #define PT_LOPROC 0x70000000 /* Processor-specific */
137 #define PT_HIPROC 0x7FFFFFFF /* Processor-specific */
138
139 /* Program segment permissions, in program header p_flags field */
140
141 #define PF_X (1 << 0) /* Segment is executable */
142 #define PF_W (1 << 1) /* Segment is writable */
143 #define PF_R (1 << 2) /* Segment is readable */
144 #define PF_MASKPROC 0xF0000000 /* Processor-specific reserved bits */
145
146 /* Values for section header, sh_type field */
147
148 #define SHT_NULL 0 /* Section header table entry unused */
149 #define SHT_PROGBITS 1 /* Program specific (private) data */
150 #define SHT_SYMTAB 2 /* Link editing symbol table */
151 #define SHT_STRTAB 3 /* A string table */
152 #define SHT_RELA 4 /* Relocation entries with addends */
153 #define SHT_HASH 5 /* A symbol hash table */
154 #define SHT_DYNAMIC 6 /* Information for dynamic linking */
155 #define SHT_NOTE 7 /* Information that marks file */
156 #define SHT_NOBITS 8 /* Section occupies no space in file */
157 #define SHT_REL 9 /* Relocation entries, no addends */
158 #define SHT_SHLIB 10 /* Reserved, unspecified semantics */
159 #define SHT_DYNSYM 11 /* Dynamic linking symbol table */
160 #define SHT_LOPROC 0x70000000 /* Processor-specific semantics, lo */
161 #define SHT_HIPROC 0x7FFFFFFF /* Processor-specific semantics, hi */
162 #define SHT_LOUSER 0x80000000 /* Application-specific semantics */
163 #define SHT_HIUSER 0x8FFFFFFF /* Application-specific semantics */
164
165 /* Values for section header, sh_flags field */
166
167 #define SHF_WRITE (1 << 0) /* Writable data during execution */
168 #define SHF_ALLOC (1 << 1) /* Occupies memory during execution */
169 #define SHF_EXECINSTR (1 << 2) /* Executable machine instructions */
170 #define SHF_MASKPROC 0xF0000000 /* Processor-specific semantics */
171
172 /* Values of note segment descriptor types for core files. */
173
174 #define NT_PRSTATUS 1 /* Contains copy of prstatus struct */
175 #define NT_FPREGSET 2 /* Contains copy of fpregset struct */
176 #define NT_PRPSINFO 3 /* Contains copy of prpsinfo struct */
177
178 /* Values of note segment descriptor types for object files. */
179 /* (Only for hppa right now. Should this be moved elsewhere?) */
180
181 #define NT_VERSION 1 /* Contains a version string. */
182
183 /* These three macros disassemble and assemble a symbol table st_info field,
184 which contains the symbol binding and symbol type. The STB_ and STT_
185 defines identify the binding and type. */
186
187 #define ELF_ST_BIND(val) (((unsigned int)(val)) >> 4)
188 #define ELF_ST_TYPE(val) ((val) & 0xF)
189 #define ELF_ST_INFO(bind,type) (((bind) << 4) + ((type) & 0xF))
190
191 #define STN_UNDEF 0 /* undefined symbol index */
192
193 #define STB_LOCAL 0 /* Symbol not visible outside obj */
194 #define STB_GLOBAL 1 /* Symbol visible outside obj */
195 #define STB_WEAK 2 /* Like globals, lower precedence */
196 #define STB_LOPROC 13 /* Application-specific semantics */
197 #define STB_HIPROC 15 /* Application-specific semantics */
198
199 #define STT_NOTYPE 0 /* Symbol type is unspecified */
200 #define STT_OBJECT 1 /* Symbol is a data object */
201 #define STT_FUNC 2 /* Symbol is a code object */
202 #define STT_SECTION 3 /* Symbol associated with a section */
203 #define STT_FILE 4 /* Symbol gives a file name */
204 #define STT_LOPROC 13 /* Application-specific semantics */
205 #define STT_HIPROC 15 /* Application-specific semantics */
206
207 /* Special section indices, which may show up in st_shndx fields, among
208 other places. */
209
210 #define SHN_UNDEF 0 /* Undefined section reference */
211 #define SHN_LORESERVE 0xFF00 /* Begin range of reserved indices */
212 #define SHN_LOPROC 0xFF00 /* Begin range of appl-specific */
213 #define SHN_HIPROC 0xFF1F /* End range of appl-specific */
214 #define SHN_ABS 0xFFF1 /* Associated symbol is absolute */
215 #define SHN_COMMON 0xFFF2 /* Associated symbol is in common */
216 #define SHN_HIRESERVE 0xFFFF /* End range of reserved indices */
217
218 /* relocation info handling macros */
219
220 #define ELF32_R_SYM(i) ((i) >> 8)
221 #define ELF32_R_TYPE(i) ((i) & 0xff)
222 #define ELF32_R_INFO(s,t) (((s) << 8) + ((t) & 0xff))
223
224 #define ELF64_R_SYM(i) ((i) >> 32)
225 #define ELF64_R_TYPE(i) ((i) & 0xffffffff)
226 #define ELF64_R_INFO(s,t) (((bfd_vma) (s) << 32) + (bfd_vma) (t))
227
228 /* Dynamic section tags */
229
230 #define DT_NULL 0
231 #define DT_NEEDED 1
232 #define DT_PLTRELSZ 2
233 #define DT_PLTGOT 3
234 #define DT_HASH 4
235 #define DT_STRTAB 5
236 #define DT_SYMTAB 6
237 #define DT_RELA 7
238 #define DT_RELASZ 8
239 #define DT_RELAENT 9
240 #define DT_STRSZ 10
241 #define DT_SYMENT 11
242 #define DT_INIT 12
243 #define DT_FINI 13
244 #define DT_SONAME 14
245 #define DT_RPATH 15
246 #define DT_SYMBOLIC 16
247 #define DT_REL 17
248 #define DT_RELSZ 18
249 #define DT_RELENT 19
250 #define DT_PLTREL 20
251 #define DT_DEBUG 21
252 #define DT_TEXTREL 22
253 #define DT_JMPREL 23
254 #define DT_LOPROC 0x70000000
255 #define DT_HIPROC 0x7fffffff
256
257 #endif /* _ELF_COMMON_H */
This page took 0.035054 seconds and 5 git commands to generate.