Change sendfile() to use the new m_ext callback scheme for cleaning up after
[dragonfly.git] / 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: src/sys/sys/elf_common.h,v 1.5.2.3 2001/02/28 02:30:46 obrien Exp $
27  * $DragonFly: src/sys/sys/elf_common.h,v 1.2 2003/06/17 04:28:58 dillon Exp $
28  */
29
30 #ifndef _SYS_ELF_COMMON_H_
31 #define _SYS_ELF_COMMON_H_ 1
32
33 /*
34  * ELF definitions that are independent of architecture or word size.
35  */
36
37 /*
38  * Note header.  The ".note" section contains an array of notes.  Each
39  * begins with this header, aligned to a word boundary.  Immediately
40  * following the note header is n_namesz bytes of name, padded to the
41  * next word boundary.  Then comes n_descsz bytes of descriptor, again
42  * padded to a word boundary.  The values of n_namesz and n_descsz do
43  * not include the padding.
44  */
45
46 typedef struct {
47         u_int32_t       n_namesz;       /* Length of name. */
48         u_int32_t       n_descsz;       /* Length of descriptor. */
49         u_int32_t       n_type;         /* Type of this note. */
50 } Elf_Note;
51
52 /* Indexes into the e_ident array.  Keep synced with 
53    http://www.sco.com/developer/gabi/ch4.eheader.html */
54 #define EI_MAG0         0       /* Magic number, byte 0. */
55 #define EI_MAG1         1       /* Magic number, byte 1. */
56 #define EI_MAG2         2       /* Magic number, byte 2. */
57 #define EI_MAG3         3       /* Magic number, byte 3. */
58 #define EI_CLASS        4       /* Class of machine. */
59 #define EI_DATA         5       /* Data format. */
60 #define EI_VERSION      6       /* ELF format version. */
61 #define EI_OSABI        7       /* Operating system / ABI identification */
62 #define EI_ABIVERSION   8       /* ABI version */
63 #define OLD_EI_BRAND    8       /* Start of architecture identification. */
64 #define EI_PAD          9       /* Start of padding (per SVR4 ABI). */
65 #define EI_NIDENT       16      /* Size of e_ident array. */
66
67 /* Values for the magic number bytes. */
68 #define ELFMAG0         0x7f
69 #define ELFMAG1         'E'
70 #define ELFMAG2         'L'
71 #define ELFMAG3         'F'
72
73 /* Values for e_ident[EI_VERSION] and e_version. */
74 #define EV_NONE         0
75 #define EV_CURRENT      1
76
77 /* Values for e_ident[EI_CLASS]. */
78 #define ELFCLASSNONE    0       /* Unknown class. */
79 #define ELFCLASS32      1       /* 32-bit architecture. */
80 #define ELFCLASS64      2       /* 64-bit architecture. */
81
82 /* Values for e_ident[EI_DATA]. */
83 #define ELFDATANONE     0       /* Unknown data format. */
84 #define ELFDATA2LSB     1       /* 2's complement little-endian. */
85 #define ELFDATA2MSB     2       /* 2's complement big-endian. */
86
87 /* Values for e_ident[EI_OSABI]. */
88 #define ELFOSABI_SYSV           0       /* UNIX System V ABI */
89 #define ELFOSABI_NONE           ELFOSABI_SYSV   /* symbol used in old spec */
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_MONTEREY       7       /* Monterey */
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_ARM            97      /* ARM */
103 #define ELFOSABI_STANDALONE     255     /* Standalone (embedded) application */
104
105 /* e_ident */
106 #define IS_ELF(ehdr)    ((ehdr).e_ident[EI_MAG0] == ELFMAG0 && \
107                          (ehdr).e_ident[EI_MAG1] == ELFMAG1 && \
108                          (ehdr).e_ident[EI_MAG2] == ELFMAG2 && \
109                          (ehdr).e_ident[EI_MAG3] == ELFMAG3)
110
111 /* Values for e_type. */
112 #define ET_NONE         0       /* Unknown type. */
113 #define ET_REL          1       /* Relocatable. */
114 #define ET_EXEC         2       /* Executable. */
115 #define ET_DYN          3       /* Shared object. */
116 #define ET_CORE         4       /* Core file. */
117
118 /* Values for e_machine. */
119 #define EM_NONE         0       /* Unknown machine. */
120 #define EM_M32          1       /* AT&T WE32100. */
121 #define EM_SPARC        2       /* Sun SPARC. */
122 #define EM_386          3       /* Intel i386. */
123 #define EM_68K          4       /* Motorola 68000. */
124 #define EM_88K          5       /* Motorola 88000. */
125 #define EM_486          6       /* Intel i486. */
126 #define EM_860          7       /* Intel i860. */
127 #define EM_MIPS         8       /* MIPS R3000 Big-Endian only */
128
129 /* Extensions.  This list is not complete. */
130 #define EM_S370         9       /* IBM System/370 */
131 #define EM_MIPS_RS4_BE  10      /* MIPS R4000 Big-Endian */ /* Depreciated */
132 #define EM_PARISC       15      /* HPPA */
133 #define EM_SPARC32PLUS  18      /* SPARC v8plus */
134 #define EM_PPC          20      /* PowerPC 32-bit */
135 #define EM_PPC64        21      /* PowerPC 64-bit */
136 #define EM_ARM          40      /* ARM */
137 #define EM_SPARCV9      43      /* SPARC v9 64-bit */
138 #define EM_IA_64        50      /* Intel IA-46 Processor */
139 #define EM_X86_64       62      /* Advanced Micro Devices x86-64 */
140 #define EM_ALPHA        0x9026  /* Alpha (written in the absence of an ABI */
141
142 /* Special section indexes. */
143 #define SHN_UNDEF            0          /* Undefined, missing, irrelevant. */
144 #define SHN_LORESERVE   0xff00          /* First of reserved range. */
145 #define SHN_LOPROC      0xff00          /* First processor-specific. */
146 #define SHN_HIPROC      0xff1f          /* Last processor-specific. */
147 #define SHN_ABS         0xfff1          /* Absolute values. */
148 #define SHN_COMMON      0xfff2          /* Common data. */
149 #define SHN_HIRESERVE   0xffff          /* Last of reserved range. */
150
151 /* sh_type */
152 #define SHT_NULL        0               /* inactive */
153 #define SHT_PROGBITS    1               /* program defined information */
154 #define SHT_SYMTAB      2               /* symbol table section */
155 #define SHT_STRTAB      3               /* string table section */
156 #define SHT_RELA        4               /* relocation section with addends*/
157 #define SHT_HASH        5               /* symbol hash table section */
158 #define SHT_DYNAMIC     6               /* dynamic section */ 
159 #define SHT_NOTE        7               /* note section */
160 #define SHT_NOBITS      8               /* no space section */
161 #define SHT_REL         9               /* relation section without addends */
162 #define SHT_SHLIB       10              /* reserved - purpose unknown */
163 #define SHT_DYNSYM      11              /* dynamic symbol table section */ 
164 #define SHT_LOPROC      0x70000000      /* reserved range for processor */
165 #define SHT_HIPROC      0x7fffffff      /* specific section header types */
166 #define SHT_LOUSER      0x80000000      /* reserved range for application */
167 #define SHT_HIUSER      0xffffffff      /* specific indexes */
168
169 /* Flags for sh_flags. */
170 #define SHF_WRITE       0x1             /* Section contains writable data. */
171 #define SHF_ALLOC       0x2             /* Section occupies memory. */
172 #define SHF_EXECINSTR   0x4             /* Section contains instructions. */
173 #define SHF_MASKPROC    0xf0000000      /* Reserved for processor-specific. */
174
175 /* Values for p_type. */
176 #define PT_NULL         0       /* Unused entry. */
177 #define PT_LOAD         1       /* Loadable segment. */
178 #define PT_DYNAMIC      2       /* Dynamic linking information segment. */
179 #define PT_INTERP       3       /* Pathname of interpreter. */
180 #define PT_NOTE         4       /* Auxiliary information. */
181 #define PT_SHLIB        5       /* Reserved (not used). */
182 #define PT_PHDR         6       /* Location of program header itself. */
183
184 #define PT_COUNT        7       /* Number of defined p_type values. */
185
186 #define PT_LOPROC       0x70000000      /* First processor-specific type. */
187 #define PT_HIPROC       0x7fffffff      /* Last processor-specific type. */
188
189 /* Values for p_flags. */
190 #define PF_X            0x1     /* Executable. */
191 #define PF_W            0x2     /* Writable. */
192 #define PF_R            0x4     /* Readable. */
193
194 /* Values for d_tag. */
195 #define DT_NULL         0       /* Terminating entry. */
196 #define DT_NEEDED       1       /* String table offset of a needed shared
197                                    library. */
198 #define DT_PLTRELSZ     2       /* Total size in bytes of PLT relocations. */
199 #define DT_PLTGOT       3       /* Processor-dependent address. */
200 #define DT_HASH         4       /* Address of symbol hash table. */
201 #define DT_STRTAB       5       /* Address of string table. */
202 #define DT_SYMTAB       6       /* Address of symbol table. */
203 #define DT_RELA         7       /* Address of ElfNN_Rela relocations. */
204 #define DT_RELASZ       8       /* Total size of ElfNN_Rela relocations. */
205 #define DT_RELAENT      9       /* Size of each ElfNN_Rela relocation entry. */
206 #define DT_STRSZ        10      /* Size of string table. */
207 #define DT_SYMENT       11      /* Size of each symbol table entry. */
208 #define DT_INIT         12      /* Address of initialization function. */
209 #define DT_FINI         13      /* Address of finalization function. */
210 #define DT_SONAME       14      /* String table offset of shared object
211                                    name. */
212 #define DT_RPATH        15      /* String table offset of library path. */
213 #define DT_SYMBOLIC     16      /* Indicates "symbolic" linking. */
214 #define DT_REL          17      /* Address of ElfNN_Rel relocations. */
215 #define DT_RELSZ        18      /* Total size of ElfNN_Rel relocations. */
216 #define DT_RELENT       19      /* Size of each ElfNN_Rel relocation. */
217 #define DT_PLTREL       20      /* Type of relocation used for PLT. */
218 #define DT_DEBUG        21      /* Reserved (not used). */
219 #define DT_TEXTREL      22      /* Indicates there may be relocations in
220                                    non-writable segments. */
221 #define DT_JMPREL       23      /* Address of PLT relocations. */
222
223 #define DT_COUNT        24      /* Number of defined d_tag values. */
224
225 /* Values for n_type.  Used in core files. */
226 #define NT_PRSTATUS     1       /* Process status. */
227 #define NT_FPREGSET     2       /* Floating point registers. */
228 #define NT_PRPSINFO     3       /* Process state info. */
229
230 /* Symbol Binding - ELFNN_ST_BIND - st_info */
231 #define STB_LOCAL       0       /* Local symbol */
232 #define STB_GLOBAL      1       /* Global symbol */
233 #define STB_WEAK        2       /* like global - lower precedence */
234 #define STB_LOPROC      13      /* reserved range for processor */
235 #define STB_HIPROC      15      /*  specific symbol bindings */
236
237 /* Symbol type - ELFNN_ST_TYPE - st_info */
238 #define STT_NOTYPE      0       /* Unspecified type. */
239 #define STT_OBJECT      1       /* Data object. */
240 #define STT_FUNC        2       /* Function. */
241 #define STT_SECTION     3       /* Section. */
242 #define STT_FILE        4       /* Source file. */
243 #define STT_LOPROC      13      /* reserved range for processor */
244 #define STT_HIPROC      15      /*  specific symbol types */
245
246 /* Special symbol table indexes. */
247 #define STN_UNDEF       0       /* Undefined symbol index. */
248
249 #endif /* !_SYS_ELF_COMMON_H_ */