xref: /freebsd/sys/x86/include/elf.h (revision c2c014f24c10f90d85126ac5fbd4d8524de32b1c)
1 /*-
2  * Copyright (c) 1996-1997 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$
27  */
28 
29 #ifndef _MACHINE_ELF_H_
30 #define	_MACHINE_ELF_H_ 1
31 
32 #if defined(__i386__) || defined(_MACHINE_ELF_WANT_32BIT)
33 
34 /*
35  * ELF definitions for the i386 architecture.
36  */
37 
38 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
39 #if defined(__ELF_WORD_SIZE) && __ELF_WORD_SIZE == 64
40 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
41 #endif
42 
43 #ifndef __ELF_WORD_SIZE
44 #define	__ELF_WORD_SIZE	32	/* Used by <sys/elf_generic.h> */
45 #endif
46 
47 #include <sys/elf_generic.h>
48 
49 #define	ELF_ARCH	EM_386
50 
51 #define	ELF_MACHINE_OK(x) ((x) == EM_386 || (x) == EM_486)
52 
53 /*
54  * Auxiliary vector entries for passing information to the interpreter.
55  *
56  * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
57  * but POSIX lays claim to all symbols ending with "_t".
58  */
59 
60 typedef struct {	/* Auxiliary vector entry on initial stack */
61 	int	a_type;			/* Entry type. */
62 	union {
63 		long	a_val;		/* Integer value. */
64 		void	*a_ptr;		/* Address. */
65 		void	(*a_fcn)(void);	/* Function pointer (not used). */
66 	} a_un;
67 } Elf32_Auxinfo;
68 
69 #if __ELF_WORD_SIZE == 64
70 /* Fake for amd64 loader support */
71 typedef struct {
72 	int fake;
73 } Elf64_Auxinfo;
74 #endif
75 
76 __ElfType(Auxinfo);
77 
78 /* Values for a_type. */
79 #define	AT_NULL		0	/* Terminates the vector. */
80 #define	AT_IGNORE	1	/* Ignored entry. */
81 #define	AT_EXECFD	2	/* File descriptor of program to load. */
82 #define	AT_PHDR		3	/* Program header of program already loaded. */
83 #define	AT_PHENT	4	/* Size of each program header entry. */
84 #define	AT_PHNUM	5	/* Number of program header entries. */
85 #define	AT_PAGESZ	6	/* Page size in bytes. */
86 #define	AT_BASE		7	/* Interpreter's base address. */
87 #define	AT_FLAGS	8	/* Flags (unused for i386). */
88 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
89 #define	AT_NOTELF	10	/* Program is not ELF ?? */
90 #define	AT_UID		11	/* Real uid. */
91 #define	AT_EUID		12	/* Effective uid. */
92 #define	AT_GID		13	/* Real gid. */
93 #define	AT_EGID		14	/* Effective gid. */
94 #define	AT_EXECPATH	15	/* Path to the executable. */
95 #define	AT_CANARY	16	/* Canary for SSP. */
96 #define	AT_CANARYLEN	17	/* Length of the canary. */
97 #define	AT_OSRELDATE	18	/* OSRELDATE. */
98 #define	AT_NCPUS	19	/* Number of CPUs. */
99 #define	AT_PAGESIZES	20	/* Pagesizes. */
100 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
101 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
102 #define	AT_STACKPROT	23	/* Initial stack protection. */
103 #define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
104 #define	AT_HWCAP	25	/* CPU feature flags. */
105 #define	AT_HWCAP2	26	/* CPU feature flags 2. */
106 
107 #define	AT_COUNT	27	/* Count of defined aux entry types. */
108 
109 /*
110  * Relocation types.
111  */
112 
113 #define	R_386_COUNT	38	/* Count of defined relocation types. */
114 
115 /* Define "machine" characteristics */
116 #define	ELF_TARG_CLASS	ELFCLASS32
117 #define	ELF_TARG_DATA	ELFDATA2LSB
118 #define	ELF_TARG_MACH	EM_386
119 #define	ELF_TARG_VER	1
120 
121 #define	ET_DYN_LOAD_ADDR 0x01001000
122 
123 #elif defined(__amd64__)
124 
125 /*
126  * ELF definitions for the AMD64 architecture.
127  */
128 
129 #ifndef __ELF_WORD_SIZE
130 #define	__ELF_WORD_SIZE	64	/* Used by <sys/elf_generic.h> */
131 #endif
132 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
133 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
134 #include <sys/elf_generic.h>
135 
136 #define	ELF_ARCH	EM_X86_64
137 #define	ELF_ARCH32	EM_386
138 
139 #define	ELF_MACHINE_OK(x) ((x) == EM_X86_64)
140 
141 /*
142  * Auxiliary vector entries for passing information to the interpreter.
143  *
144  * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
145  * but POSIX lays claim to all symbols ending with "_t".
146  */
147 typedef struct {	/* Auxiliary vector entry on initial stack */
148 	int	a_type;			/* Entry type. */
149 	union {
150 		int	a_val;		/* Integer value. */
151 	} a_un;
152 } Elf32_Auxinfo;
153 
154 
155 typedef struct {	/* Auxiliary vector entry on initial stack */
156 	long	a_type;			/* Entry type. */
157 	union {
158 		long	a_val;		/* Integer value. */
159 		void	*a_ptr;		/* Address. */
160 		void	(*a_fcn)(void);	/* Function pointer (not used). */
161 	} a_un;
162 } Elf64_Auxinfo;
163 
164 __ElfType(Auxinfo);
165 
166 /* Values for a_type. */
167 #define	AT_NULL		0	/* Terminates the vector. */
168 #define	AT_IGNORE	1	/* Ignored entry. */
169 #define	AT_EXECFD	2	/* File descriptor of program to load. */
170 #define	AT_PHDR		3	/* Program header of program already loaded. */
171 #define	AT_PHENT	4	/* Size of each program header entry. */
172 #define	AT_PHNUM	5	/* Number of program header entries. */
173 #define	AT_PAGESZ	6	/* Page size in bytes. */
174 #define	AT_BASE		7	/* Interpreter's base address. */
175 #define	AT_FLAGS	8	/* Flags (unused for i386). */
176 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
177 #define	AT_NOTELF	10	/* Program is not ELF ?? */
178 #define	AT_UID		11	/* Real uid. */
179 #define	AT_EUID		12	/* Effective uid. */
180 #define	AT_GID		13	/* Real gid. */
181 #define	AT_EGID		14	/* Effective gid. */
182 #define	AT_EXECPATH	15	/* Path to the executable. */
183 #define	AT_CANARY	16	/* Canary for SSP */
184 #define	AT_CANARYLEN	17	/* Length of the canary. */
185 #define	AT_OSRELDATE	18	/* OSRELDATE. */
186 #define	AT_NCPUS	19	/* Number of CPUs. */
187 #define	AT_PAGESIZES	20	/* Pagesizes. */
188 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
189 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
190 #define	AT_STACKPROT	23	/* Initial stack protection. */
191 #define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
192 #define	AT_HWCAP	25	/* CPU feature flags. */
193 #define	AT_HWCAP2	26	/* CPU feature flags 2. */
194 
195 #define	AT_COUNT	27	/* Count of defined aux entry types. */
196 
197 /*
198  * Relocation types.
199  */
200 
201 #define	R_X86_64_COUNT	24	/* Count of defined relocation types. */
202 
203 /* Define "machine" characteristics */
204 #if __ELF_WORD_SIZE == 32
205 #define ELF_TARG_CLASS  ELFCLASS32
206 #else
207 #define ELF_TARG_CLASS  ELFCLASS64
208 #endif
209 #define	ELF_TARG_DATA	ELFDATA2LSB
210 #define	ELF_TARG_MACH	EM_X86_64
211 #define	ELF_TARG_VER	1
212 
213 #if __ELF_WORD_SIZE == 32
214 #define	ET_DYN_LOAD_ADDR 0x01001000
215 #else
216 #define	ET_DYN_LOAD_ADDR 0x01021000
217 #endif
218 
219 #endif /* __i386__, __amd64__ */
220 
221 #endif /* !_MACHINE_ELF_H_ */
222