elf_common.h revision 46656 
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 *      $Id: elf_common.h,v 1.3 1998/09/14 20:30:13 jdp Exp $
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
45typedef 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. */
52#define EI_MAG0		0	/* Magic number, byte 0. */
53#define EI_MAG1		1	/* Magic number, byte 1. */
54#define EI_MAG2		2	/* Magic number, byte 2. */
55#define EI_MAG3		3	/* Magic number, byte 3. */
56#define EI_CLASS	4	/* Class of machine. */
57#define EI_DATA		5	/* Data format. */
58#define EI_VERSION	6	/* ELF format version. */
59#define EI_PAD		7	/* Start of padding (per SVR4 ABI). */
60#define EI_BRAND	8	/* Start of architecture identification. */
61#define EI_NIDENT	16	/* Size of e_ident array. */
62
63/* Values for the magic number bytes. */
64#define ELFMAG0		0x7f
65#define ELFMAG1		'E'
66#define ELFMAG2		'L'
67#define ELFMAG3		'F'
68
69/* Values for e_ident[EI_VERSION] and e_version. */
70#define EV_NONE		0
71#define EV_CURRENT	1
72
73/* Values for e_ident[EI_CLASS]. */
74#define ELFCLASSNONE	0	/* Unknown class. */
75#define ELFCLASS32	1	/* 32-bit architecture. */
76#define ELFCLASS64	2	/* 64-bit architecture. */
77
78/* Values for e_ident[EI_DATA]. */
79#define ELFDATANONE	0	/* Unknown data format. */
80#define ELFDATA2LSB	1	/* 2's complement little-endian. */
81#define ELFDATA2MSB	2	/* 2's complement big-endian. */
82
83/* e_ident */
84#define IS_ELF(ehdr)	((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
85			 (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
86			 (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
87			 (ehdr).e_ident[EI_MAG3] == ELFMAG3)
88
89/* Values for e_type. */
90#define ET_NONE		0	/* Unknown type. */
91#define ET_REL		1	/* Relocatable. */
92#define ET_EXEC		2	/* Executable. */
93#define ET_DYN		3	/* Shared object. */
94#define ET_CORE		4	/* Core file. */
95
96/* Values for e_machine. */
97#define EM_NONE		0	/* Unknown machine. */
98#define EM_M32		1	/* AT&T WE32100. */
99#define EM_SPARC	2	/* Sun SPARC. */
100#define EM_386		3	/* Intel i386. */
101#define EM_68K		4	/* Motorola 68000. */
102#define EM_88K		5	/* Motorola 88000. */
103#define EM_486		6	/* Intel i486. */
104#define EM_860		7	/* Intel i860. */
105#define EM_MIPS		8	/* MIPS R3000 Big-Endian only */
106
107/* Extensions */
108#define EM_MIPS_RS4_BE	10	/* MIPS R4000 Big-Endian */
109#define EM_SPARC64	11	/* SPARC v9 64-bit unoffical */
110#define EM_PARISC	15	/* HPPA */
111#define EM_PPC		20	/* PowerPC */
112#define EM_ALPHA	0x9026	/* Alpha */
113
114/* Special section indexes. */
115#define SHN_UNDEF	     0		/* Undefined, missing, irrelevant. */
116#define SHN_LORESERVE	0xff00		/* First of reserved range. */
117#define SHN_LOPROC	0xff00		/* First processor-specific. */
118#define SHN_HIPROC	0xff1f		/* Last processor-specific. */
119#define SHN_ABS		0xfff1		/* Absolute values. */
120#define SHN_COMMON	0xfff2		/* Common data. */
121#define SHN_HIRESERVE	0xffff		/* Last of reserved range. */
122
123/* sh_type */
124#define SHT_NULL	0		/* inactive */
125#define SHT_PROGBITS	1		/* program defined information */
126#define SHT_SYMTAB	2		/* symbol table section */
127#define SHT_STRTAB	3		/* string table section */
128#define SHT_RELA	4		/* relocation section with addends*/
129#define SHT_HASH	5		/* symbol hash table section */
130#define SHT_DYNAMIC	6		/* dynamic section */
131#define SHT_NOTE	7		/* note section */
132#define SHT_NOBITS	8		/* no space section */
133#define SHT_REL		9		/* relation section without addends */
134#define SHT_SHLIB	10		/* reserved - purpose unknown */
135#define SHT_DYNSYM	11		/* dynamic symbol table section */
136#define SHT_LOPROC	0x70000000	/* reserved range for processor */
137#define SHT_HIPROC	0x7fffffff	/* specific section header types */
138#define SHT_LOUSER	0x80000000	/* reserved range for application */
139#define SHT_HIUSER	0xffffffff	/* specific indexes */
140
141/* Flags for sh_flags. */
142#define SHF_WRITE	0x1		/* Section contains writable data. */
143#define SHF_ALLOC	0x2		/* Section occupies memory. */
144#define SHF_EXECINSTR	0x4		/* Section contains instructions. */
145#define SHF_MASKPROC	0xf0000000	/* Reserved for processor-specific. */
146
147/* Values for p_type. */
148#define PT_NULL		0	/* Unused entry. */
149#define PT_LOAD		1	/* Loadable segment. */
150#define PT_DYNAMIC	2	/* Dynamic linking information segment. */
151#define PT_INTERP	3	/* Pathname of interpreter. */
152#define PT_NOTE		4	/* Auxiliary information. */
153#define PT_SHLIB	5	/* Reserved (not used). */
154#define PT_PHDR		6	/* Location of program header itself. */
155
156#define PT_COUNT	7	/* Number of defined p_type values. */
157
158#define PT_LOPROC	0x70000000	/* First processor-specific type. */
159#define PT_HIPROC	0x7fffffff	/* Last processor-specific type. */
160
161/* Values for p_flags. */
162#define PF_X		0x1	/* Executable. */
163#define PF_W		0x2	/* Writable. */
164#define PF_R		0x4	/* Readable. */
165
166/* Values for d_tag. */
167#define DT_NULL		0	/* Terminating entry. */
168#define DT_NEEDED	1	/* String table offset of a needed shared
169				   library. */
170#define DT_PLTRELSZ	2	/* Total size in bytes of PLT relocations. */
171#define DT_PLTGOT	3	/* Processor-dependent address. */
172#define DT_HASH		4	/* Address of symbol hash table. */
173#define DT_STRTAB	5	/* Address of string table. */
174#define DT_SYMTAB	6	/* Address of symbol table. */
175#define DT_RELA		7	/* Address of ElfNN_Rela relocations. */
176#define DT_RELASZ	8	/* Total size of ElfNN_Rela relocations. */
177#define DT_RELAENT	9	/* Size of each ElfNN_Rela relocation entry. */
178#define DT_STRSZ	10	/* Size of string table. */
179#define DT_SYMENT	11	/* Size of each symbol table entry. */
180#define DT_INIT		12	/* Address of initialization function. */
181#define DT_FINI		13	/* Address of finalization function. */
182#define DT_SONAME	14	/* String table offset of shared object
183				   name. */
184#define DT_RPATH	15	/* String table offset of library path. */
185#define DT_SYMBOLIC	16	/* Indicates "symbolic" linking. */
186#define DT_REL		17	/* Address of ElfNN_Rel relocations. */
187#define DT_RELSZ	18	/* Total size of ElfNN_Rel relocations. */
188#define DT_RELENT	19	/* Size of each ElfNN_Rel relocation. */
189#define DT_PLTREL	20	/* Type of relocation used for PLT. */
190#define DT_DEBUG	21	/* Reserved (not used). */
191#define DT_TEXTREL	22	/* Indicates there may be relocations in
192				   non-writable segments. */
193#define DT_JMPREL	23	/* Address of PLT relocations. */
194
195#define DT_COUNT	24	/* Number of defined d_tag values. */
196
197/* Values for n_type.  Used in core files. */
198#define NT_PRSTATUS	1	/* Process status. */
199#define NT_FPREGSET	2	/* Floating point registers. */
200#define NT_PRPSINFO	3	/* Process state info. */
201
202/* Symbol Binding - ELFNN_ST_BIND - st_info */
203#define STB_LOCAL	0	/* Local symbol */
204#define STB_GLOBAL	1	/* Global symbol */
205#define STB_WEAK	2	/* like global - lower precedence */
206#define STB_LOPROC	13	/* reserved range for processor */
207#define STB_HIPROC	15	/*  specific symbol bindings */
208
209/* Symbol type - ELFNN_ST_TYPE - st_info */
210#define STT_NOTYPE	0	/* Unspecified type. */
211#define STT_OBJECT	1	/* Data object. */
212#define STT_FUNC	2	/* Function. */
213#define STT_SECTION	3	/* Section. */
214#define STT_FILE	4	/* Source file. */
215#define STT_LOPROC	13	/* reserved range for processor */
216#define STT_HIPROC	15	/*  specific symbol types */
217
218/* Special symbol table indexes. */
219#define STN_UNDEF	0	/* Undefined symbol index. */
220
221#endif /* !_SYS_ELF_COMMON_H_ */
222