bfd:
[external/binutils.git] / include / elf / common.h
1 /* ELF support for BFD.
2    Copyright (C) 1991,92,93,94,95,96,97,98 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_486          6       /* Intel 80486 */
81 #define EM_860          7       /* Intel 80860 */
82 #define EM_MIPS         8       /* MIPS R3000 (officially, big-endian only) */
83 #define EM_S370         9       /* Amdahl */
84 #define EM_MIPS_RS4_BE 10       /* MIPS R4000 big-endian */
85
86 #define EM_PARISC      15       /* HPPA */
87
88 #define EM_SPARC32PLUS 18       /* Sun's "v8plus" */
89 #define EM_960         19       /* Intel 80960 */
90 #define EM_PPC         20       /* PowerPC */
91
92 #define EM_V800        36       /* NEC V800 series */
93 #define EM_FR20        37       /* Fujitsu FR20 */
94 #define EM_RH32        38       /* TRW RH32 */
95 #define EM_MMA         39       /* Fujitsu MMA */
96 #define EM_ARM         40       /* ARM */
97 #define EM_OLD_ALPHA   41       /* Digital Alpha */
98 #define EM_SH          42       /* Hitachi SH */
99 #define EM_SPARCV9     43       /* SPARC v9 64-bit */
100
101 /* If it is necessary to assign new unofficial EM_* values, please pick large
102    random numbers (0x8523, 0xa7f2, etc.) to minimize the chances of collision
103    with official or non-GNU unofficial values.
104
105    NOTE: Do not just increment the most recent number by one.
106    Somebody else somewhere will do exactly the same thing, and you
107    will have a collision.  Instead, pick a random number.  */
108
109 /* Cygnus PowerPC ELF backend.  Written in the absence of an ABI.  */
110 #define EM_CYGNUS_POWERPC 0x9025
111
112 /* Old version of Sparc v9, from before the ABI; this should be
113    removed shortly.  */
114 #define EM_OLD_SPARCV9  11
115
116 /* Old version of PowerPC, this should be removed shortly. */
117 #define EM_PPC_OLD      17
118
119 /* Cygnus ARC ELF backend.  Written in the absence of an ABI.  */
120 #define EM_CYGNUS_ARC 0x9040
121
122 /* Cygnus M32R ELF backend.  Written in the absence of an ABI.  */
123 #define EM_CYGNUS_M32R 0x9041
124
125 /* Alpha backend magic number.  Written in the absence of an ABI.  */
126 #define EM_ALPHA        0x9026
127
128 /* D10V backend magic number.  Written in the absence of an ABI.  */
129 #define EM_CYGNUS_D10V  0x7650
130
131 /* D30V backend magic number.  Written in the absence of an ABI.  */
132 #define EM_CYGNUS_D30V  0x7676
133
134 /* V850 backend magic number.  Written in the absense of an ABI.  */
135 #define EM_CYGNUS_V850  0x9080
136
137 /* mn10200 and mn10300 backend magic numbers.
138    Written in the absense of an ABI.  */
139 #define EM_CYGNUS_MN10200       0xdead
140 #define EM_CYGNUS_MN10300       0xbeef
141
142 /* See the above comment before you add a new EM_* value here.  */
143
144 /* Values for e_version */
145
146 #define EV_NONE         0               /* Invalid ELF version */
147 #define EV_CURRENT      1               /* Current version */
148
149 /* Values for program header, p_type field */
150
151 #define PT_NULL         0               /* Program header table entry unused */
152 #define PT_LOAD         1               /* Loadable program segment */
153 #define PT_DYNAMIC      2               /* Dynamic linking information */
154 #define PT_INTERP       3               /* Program interpreter */
155 #define PT_NOTE         4               /* Auxiliary information */
156 #define PT_SHLIB        5               /* Reserved, unspecified semantics */
157 #define PT_PHDR         6               /* Entry for header table itself */
158 #define PT_LOPROC       0x70000000      /* Processor-specific */
159 #define PT_HIPROC       0x7FFFFFFF      /* Processor-specific */
160
161 /* Program segment permissions, in program header p_flags field */
162
163 #define PF_X            (1 << 0)        /* Segment is executable */
164 #define PF_W            (1 << 1)        /* Segment is writable */
165 #define PF_R            (1 << 2)        /* Segment is readable */
166 #define PF_MASKPROC     0xF0000000      /* Processor-specific reserved bits */
167
168 /* Values for section header, sh_type field */
169
170 #define SHT_NULL        0               /* Section header table entry unused */
171 #define SHT_PROGBITS    1               /* Program specific (private) data */
172 #define SHT_SYMTAB      2               /* Link editing symbol table */
173 #define SHT_STRTAB      3               /* A string table */
174 #define SHT_RELA        4               /* Relocation entries with addends */
175 #define SHT_HASH        5               /* A symbol hash table */
176 #define SHT_DYNAMIC     6               /* Information for dynamic linking */
177 #define SHT_NOTE        7               /* Information that marks file */
178 #define SHT_NOBITS      8               /* Section occupies no space in file */
179 #define SHT_REL         9               /* Relocation entries, no addends */
180 #define SHT_SHLIB       10              /* Reserved, unspecified semantics */
181 #define SHT_DYNSYM      11              /* Dynamic linking symbol table */
182
183 /* The next three section types are defined by Solaris, and are named
184    SHT_SUNW*.  We use them in GNU code, so we also define SHT_GNU*
185    versions.  */
186 #define SHT_SUNW_verdef 0x6ffffffd      /* Versions defined by file */
187 #define SHT_SUNW_verneed 0x6ffffffe     /* Versions needed by file */
188 #define SHT_SUNW_versym 0x6fffffff      /* Symbol versions */
189
190 #define SHT_GNU_verdef  SHT_SUNW_verdef
191 #define SHT_GNU_verneed SHT_SUNW_verneed
192 #define SHT_GNU_versym  SHT_SUNW_versym
193
194 #define SHT_LOPROC      0x70000000      /* Processor-specific semantics, lo */
195 #define SHT_HIPROC      0x7FFFFFFF      /* Processor-specific semantics, hi */
196 #define SHT_LOUSER      0x80000000      /* Application-specific semantics */
197 #define SHT_HIUSER      0x8FFFFFFF      /* Application-specific semantics */
198
199 /* Values for section header, sh_flags field */
200
201 #define SHF_WRITE       (1 << 0)        /* Writable data during execution */
202 #define SHF_ALLOC       (1 << 1)        /* Occupies memory during execution */
203 #define SHF_EXECINSTR   (1 << 2)        /* Executable machine instructions */
204 #define SHF_MASKPROC    0xF0000000      /* Processor-specific semantics */
205
206 /* Values of note segment descriptor types for core files. */
207
208 #define NT_PRSTATUS     1               /* Contains copy of prstatus struct */
209 #define NT_FPREGSET     2               /* Contains copy of fpregset struct */
210 #define NT_PRPSINFO     3               /* Contains copy of prpsinfo struct */
211
212 /* Note segments for core files on dir-style procfs systems. */
213
214 #define NT_PSTATUS      10              /* Has a struct pstatus */
215 #define NT_FPREGS       12              /* Has a struct fpregset */
216 #define NT_PSINFO       13              /* Has a struct psinfo */
217 #define NT_LWPSTATUS    16              /* Has a struct lwpstatus_t
218 #define NT_LWPSINFO     17              /* Has a struct lwpsinfo_t */
219
220 /* Values of note segment descriptor types for object files.  */
221 /* (Only for hppa right now.  Should this be moved elsewhere?)  */
222
223 #define NT_VERSION      1               /* Contains a version string.  */
224
225 /* These three macros disassemble and assemble a symbol table st_info field,
226    which contains the symbol binding and symbol type.  The STB_ and STT_
227    defines identify the binding and type. */
228
229 #define ELF_ST_BIND(val)                (((unsigned int)(val)) >> 4)
230 #define ELF_ST_TYPE(val)                ((val) & 0xF)
231 #define ELF_ST_INFO(bind,type)          (((bind) << 4) + ((type) & 0xF))
232
233 #define STN_UNDEF       0               /* undefined symbol index */
234
235 #define STB_LOCAL       0               /* Symbol not visible outside obj */
236 #define STB_GLOBAL      1               /* Symbol visible outside obj */
237 #define STB_WEAK        2               /* Like globals, lower precedence */
238 #define STB_LOPROC      13              /* Application-specific semantics */
239 #define STB_HIPROC      15              /* Application-specific semantics */
240
241 #define STT_NOTYPE      0               /* Symbol type is unspecified */
242 #define STT_OBJECT      1               /* Symbol is a data object */
243 #define STT_FUNC        2               /* Symbol is a code object */
244 #define STT_SECTION     3               /* Symbol associated with a section */
245 #define STT_FILE        4               /* Symbol gives a file name */
246 #define STT_LOPROC      13              /* Application-specific semantics */
247 #define STT_HIPROC      15              /* Application-specific semantics */
248
249 /* Special section indices, which may show up in st_shndx fields, among
250    other places. */
251
252 #define SHN_UNDEF       0               /* Undefined section reference */
253 #define SHN_LORESERVE   0xFF00          /* Begin range of reserved indices */
254 #define SHN_LOPROC      0xFF00          /* Begin range of appl-specific */
255 #define SHN_HIPROC      0xFF1F          /* End range of appl-specific */
256 #define SHN_ABS         0xFFF1          /* Associated symbol is absolute */
257 #define SHN_COMMON      0xFFF2          /* Associated symbol is in common */
258 #define SHN_HIRESERVE   0xFFFF          /* End range of reserved indices */
259
260 /* relocation info handling macros */
261
262 #define ELF32_R_SYM(i)          ((i) >> 8)
263 #define ELF32_R_TYPE(i)         ((i) & 0xff)
264 #define ELF32_R_INFO(s,t)       (((s) << 8) + ((t) & 0xff))
265
266 #define ELF64_R_SYM(i)          ((i) >> 32)
267 #define ELF64_R_TYPE(i)         ((i) & 0xffffffff)
268 #define ELF64_R_INFO(s,t)       (((bfd_vma) (s) << 32) + (bfd_vma) (t))
269
270 /* Dynamic section tags */
271
272 #define DT_NULL         0
273 #define DT_NEEDED       1
274 #define DT_PLTRELSZ     2
275 #define DT_PLTGOT       3
276 #define DT_HASH         4
277 #define DT_STRTAB       5
278 #define DT_SYMTAB       6
279 #define DT_RELA         7
280 #define DT_RELASZ       8
281 #define DT_RELAENT      9
282 #define DT_STRSZ        10
283 #define DT_SYMENT       11
284 #define DT_INIT         12
285 #define DT_FINI         13
286 #define DT_SONAME       14
287 #define DT_RPATH        15
288 #define DT_SYMBOLIC     16
289 #define DT_REL          17
290 #define DT_RELSZ        18
291 #define DT_RELENT       19
292 #define DT_PLTREL       20
293 #define DT_DEBUG        21
294 #define DT_TEXTREL      22
295 #define DT_JMPREL       23
296
297 /* The next four dynamic tags are used on Solaris.  We support them
298    everywhere.  */
299 #define DT_VALRNGLO     0x6ffffd00
300 #define DT_POSFLAG_1    0x6ffffdfd
301 #define DT_SYMINSZ      0x6ffffdfe
302 #define DT_SYMINENT     0x6ffffdff
303 #define DT_VALRNGHI     0x6ffffdff
304
305 #define DT_ADDRRNGLO    0x6ffffe00
306 #define DT_SYMINFO      0x6ffffeff
307 #define DT_ADDRRNGHI    0x6ffffeff
308
309 #define DT_RELACOUNT    0x6ffffff9
310 #define DT_RELCOUNT     0x6ffffffa
311 #define DT_FLAGS_1      0x6ffffffb
312 #define DT_VERDEF       0x6ffffffc
313 #define DT_VERDEFNUM    0x6ffffffd
314 #define DT_VERNEED      0x6ffffffe
315 #define DT_VERNEEDNUM   0x6fffffff
316
317 /* This tag is a GNU extension to the Solaris version scheme.  */
318 #define DT_VERSYM       0x6ffffff0
319
320 #define DT_LOPROC       0x70000000
321 #define DT_HIPROC       0x7fffffff
322
323 /* These section tags are used on Solaris.  We support them
324    everywhere, and hope they do not conflict.  */
325
326 #define DT_AUXILIARY    0x7ffffffd
327 #define DT_USED         0x7ffffffe
328 #define DT_FILTER       0x7fffffff
329
330 /* Flag values used in the DT_POSFLAG_1 .dynamic entry.  */
331 #define DF_P1_LAZYLOAD  0x00000001
332 #define DF_P1_GROUPPERM 0x00000002
333
334 /* Flag value in in the DT_1_FLAGS .dynamic entry.  */
335 #define DF_1_NOW        0x00000001
336 #define DF_1_GLOBAL     0x00000002
337 #define DF_1_GROUP      0x00000004
338 #define DF_1_NODELETE   0x00000008
339 #define DF_1_LOADFLTR   0x00000010
340 #define DF_1_INITFIRST  0x00000020
341 #define DF_1_NOOPEN     0x00000040
342 #define DF_1_ORIGIN     0x00000080
343 #define DF_1_DIRECT     0x00000100
344 #define DF_1_TRANS      0x00000200
345 #define DF_1_INTERPOSE  0x00000400
346
347 /* These constants are used for the version number of a Elf32_Verdef
348    structure.  */
349
350 #define VER_DEF_NONE            0
351 #define VER_DEF_CURRENT         1
352
353 /* These constants appear in the vd_flags field of a Elf32_Verdef
354    structure.  */
355
356 #define VER_FLG_BASE            0x1
357 #define VER_FLG_WEAK            0x2
358
359 /* These special constants can be found in an Elf32_Versym field.  */
360
361 #define VER_NDX_LOCAL           0
362 #define VER_NDX_GLOBAL          1
363
364 /* These constants are used for the version number of a Elf32_Verneed
365    structure.  */
366
367 #define VER_NEED_NONE           0
368 #define VER_NEED_CURRENT        1
369
370 /* This flag appears in a Versym structure.  It means that the symbol
371    is hidden, and is only visible with an explicit version number.
372    This is a GNU extension.  */
373
374 #define VERSYM_HIDDEN           0x8000
375
376 /* This is the mask for the rest of the Versym information.  */
377
378 #define VERSYM_VERSION          0x7fff
379
380 /* This is a special token which appears as part of a symbol name.  It
381    indictes that the rest of the name is actually the name of a
382    version node, and is not part of the actual name.  This is a GNU
383    extension.  For example, the symbol name `stat@ver2' is taken to
384    mean the symbol `stat' in version `ver2'.  */
385
386 #define ELF_VER_CHR     '@'
387
388 /* Possible values for si_boundto.  */
389 #define SYMINFO_BT_SELF         0xffff  /* Symbol bound to self */
390 #define SYMINFO_BT_PARENT       0xfffe  /* Symbol bound to parent */
391 #define SYMINFO_BT_LOWRESERVE   0xff00  /* Beginning of reserved entries */
392
393 /* Possible bitmasks for si_flags.  */
394 #define SYMINFO_FLG_DIRECT      0x0001  /* Direct bound symbol */
395 #define SYMINFO_FLG_PASSTHRU    0x0002  /* Pass-thru symbol for translator */
396 #define SYMINFO_FLG_COPY        0x0004  /* Symbol is a copy-reloc */
397 #define SYMINFO_FLG_LAZYLOAD    0x0008  /* Symbol bound to object to be lazy
398                                            loaded */
399 /* Syminfo version values.  */
400 #define SYMINFO_NONE            0
401 #define SYMINFO_CURRENT         1
402 #define SYMINFO_NUM             2
403
404 #endif /* _ELF_COMMON_H */