xref: /freebsd/sys/x86/include/elf.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1996-1997 John D. Polstra.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _MACHINE_ELF_H_
32 #define	_MACHINE_ELF_H_ 1
33 
34 #if defined(__i386__) || defined(_MACHINE_ELF_WANT_32BIT)
35 
36 /*
37  * ELF definitions for the i386 architecture.
38  */
39 
40 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
41 #if defined(__ELF_WORD_SIZE) && __ELF_WORD_SIZE == 64
42 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
43 #endif
44 
45 #ifndef __ELF_WORD_SIZE
46 #define	__ELF_WORD_SIZE	32	/* Used by <sys/elf_generic.h> */
47 #endif
48 
49 #include <sys/elf_generic.h>
50 
51 #define	ELF_ARCH	EM_386
52 
53 #define	ELF_MACHINE_OK(x) ((x) == EM_386 || (x) == EM_486)
54 
55 /*
56  * Auxiliary vector entries for passing information to the interpreter.
57  *
58  * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
59  * but POSIX lays claim to all symbols ending with "_t".
60  */
61 
62 typedef struct {	/* Auxiliary vector entry on initial stack */
63 	int	a_type;			/* Entry type. */
64 	union {
65 		long	a_val;		/* Integer value. */
66 		void	*a_ptr;		/* Address. */
67 		void	(*a_fcn)(void);	/* Function pointer (not used). */
68 	} a_un;
69 } Elf32_Auxinfo;
70 
71 #if __ELF_WORD_SIZE == 64
72 /* Fake for amd64 loader support */
73 typedef struct {
74 	int fake;
75 } Elf64_Auxinfo;
76 #endif
77 
78 __ElfType(Auxinfo);
79 
80 /* Values for a_type. */
81 #define	AT_NULL		0	/* Terminates the vector. */
82 #define	AT_IGNORE	1	/* Ignored entry. */
83 #define	AT_EXECFD	2	/* File descriptor of program to load. */
84 #define	AT_PHDR		3	/* Program header of program already loaded. */
85 #define	AT_PHENT	4	/* Size of each program header entry. */
86 #define	AT_PHNUM	5	/* Number of program header entries. */
87 #define	AT_PAGESZ	6	/* Page size in bytes. */
88 #define	AT_BASE		7	/* Interpreter's base address. */
89 #define	AT_FLAGS	8	/* Flags (unused for i386). */
90 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
91 #define	AT_NOTELF	10	/* Program is not ELF ?? */
92 #define	AT_UID		11	/* Real uid. */
93 #define	AT_EUID		12	/* Effective uid. */
94 #define	AT_GID		13	/* Real gid. */
95 #define	AT_EGID		14	/* Effective gid. */
96 #define	AT_EXECPATH	15	/* Path to the executable. */
97 #define	AT_CANARY	16	/* Canary for SSP. */
98 #define	AT_CANARYLEN	17	/* Length of the canary. */
99 #define	AT_OSRELDATE	18	/* OSRELDATE. */
100 #define	AT_NCPUS	19	/* Number of CPUs. */
101 #define	AT_PAGESIZES	20	/* Pagesizes. */
102 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
103 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
104 #define	AT_STACKPROT	23	/* Initial stack protection. */
105 #define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
106 #define	AT_HWCAP	25	/* CPU feature flags. */
107 #define	AT_HWCAP2	26	/* CPU feature flags 2. */
108 
109 #define	AT_COUNT	27	/* Count of defined aux entry types. */
110 
111 /*
112  * Relocation types.
113  */
114 
115 #define	R_386_COUNT	38	/* Count of defined relocation types. */
116 
117 /* Define "machine" characteristics */
118 #define	ELF_TARG_CLASS	ELFCLASS32
119 #define	ELF_TARG_DATA	ELFDATA2LSB
120 #define	ELF_TARG_MACH	EM_386
121 #define	ELF_TARG_VER	1
122 
123 #define	ET_DYN_LOAD_ADDR 0x01001000
124 
125 #elif defined(__amd64__)
126 
127 /*
128  * ELF definitions for the AMD64 architecture.
129  */
130 
131 #ifndef __ELF_WORD_SIZE
132 #define	__ELF_WORD_SIZE	64	/* Used by <sys/elf_generic.h> */
133 #endif
134 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
135 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
136 #include <sys/elf_generic.h>
137 
138 #define	ELF_ARCH	EM_X86_64
139 #define	ELF_ARCH32	EM_386
140 
141 #define	ELF_MACHINE_OK(x) ((x) == EM_X86_64)
142 
143 /*
144  * Auxiliary vector entries for passing information to the interpreter.
145  *
146  * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
147  * but POSIX lays claim to all symbols ending with "_t".
148  */
149 typedef struct {	/* Auxiliary vector entry on initial stack */
150 	int	a_type;			/* Entry type. */
151 	union {
152 		int	a_val;		/* Integer value. */
153 	} a_un;
154 } Elf32_Auxinfo;
155 
156 
157 typedef struct {	/* Auxiliary vector entry on initial stack */
158 	long	a_type;			/* Entry type. */
159 	union {
160 		long	a_val;		/* Integer value. */
161 		void	*a_ptr;		/* Address. */
162 		void	(*a_fcn)(void);	/* Function pointer (not used). */
163 	} a_un;
164 } Elf64_Auxinfo;
165 
166 __ElfType(Auxinfo);
167 
168 /* Values for a_type. */
169 #define	AT_NULL		0	/* Terminates the vector. */
170 #define	AT_IGNORE	1	/* Ignored entry. */
171 #define	AT_EXECFD	2	/* File descriptor of program to load. */
172 #define	AT_PHDR		3	/* Program header of program already loaded. */
173 #define	AT_PHENT	4	/* Size of each program header entry. */
174 #define	AT_PHNUM	5	/* Number of program header entries. */
175 #define	AT_PAGESZ	6	/* Page size in bytes. */
176 #define	AT_BASE		7	/* Interpreter's base address. */
177 #define	AT_FLAGS	8	/* Flags (unused for i386). */
178 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
179 #define	AT_NOTELF	10	/* Program is not ELF ?? */
180 #define	AT_UID		11	/* Real uid. */
181 #define	AT_EUID		12	/* Effective uid. */
182 #define	AT_GID		13	/* Real gid. */
183 #define	AT_EGID		14	/* Effective gid. */
184 #define	AT_EXECPATH	15	/* Path to the executable. */
185 #define	AT_CANARY	16	/* Canary for SSP */
186 #define	AT_CANARYLEN	17	/* Length of the canary. */
187 #define	AT_OSRELDATE	18	/* OSRELDATE. */
188 #define	AT_NCPUS	19	/* Number of CPUs. */
189 #define	AT_PAGESIZES	20	/* Pagesizes. */
190 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
191 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
192 #define	AT_STACKPROT	23	/* Initial stack protection. */
193 #define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
194 #define	AT_HWCAP	25	/* CPU feature flags. */
195 #define	AT_HWCAP2	26	/* CPU feature flags 2. */
196 
197 #define	AT_COUNT	27	/* Count of defined aux entry types. */
198 
199 /*
200  * Relocation types.
201  */
202 
203 #define	R_X86_64_COUNT	24	/* Count of defined relocation types. */
204 
205 /* Define "machine" characteristics */
206 #if __ELF_WORD_SIZE == 32
207 #define ELF_TARG_CLASS  ELFCLASS32
208 #else
209 #define ELF_TARG_CLASS  ELFCLASS64
210 #endif
211 #define	ELF_TARG_DATA	ELFDATA2LSB
212 #define	ELF_TARG_MACH	EM_X86_64
213 #define	ELF_TARG_VER	1
214 
215 #if __ELF_WORD_SIZE == 32
216 #define	ET_DYN_LOAD_ADDR 0x01001000
217 #else
218 #define	ET_DYN_LOAD_ADDR 0x01021000
219 #endif
220 
221 #endif /* __i386__, __amd64__ */
222 
223 #endif /* !_MACHINE_ELF_H_ */
224