xref: /illumos-gate/usr/src/boot/sys/x86/include/elf.h (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
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 
104 #define	AT_COUNT	24	/* Count of defined aux entry types. */
105 
106 /*
107  * Relocation types.
108  */
109 
110 #define	R_386_COUNT	38	/* Count of defined relocation types. */
111 
112 /* Define "machine" characteristics */
113 #define	ELF_TARG_CLASS	ELFCLASS32
114 #define	ELF_TARG_DATA	ELFDATA2LSB
115 #define	ELF_TARG_MACH	EM_386
116 #define	ELF_TARG_VER	1
117 
118 #define	ET_DYN_LOAD_ADDR 0x01001000
119 
120 #elif defined(__amd64__)
121 
122 /*
123  * ELF definitions for the AMD64 architecture.
124  */
125 
126 #ifndef __ELF_WORD_SIZE
127 #define	__ELF_WORD_SIZE	64	/* Used by <sys/elf_generic.h> */
128 #endif
129 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
130 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
131 #include <sys/elf_generic.h>
132 
133 #define	ELF_ARCH	EM_X86_64
134 #define	ELF_ARCH32	EM_386
135 
136 #define	ELF_MACHINE_OK(x) ((x) == EM_X86_64)
137 
138 /*
139  * Auxiliary vector entries for passing information to the interpreter.
140  *
141  * The i386 supplement to the SVR4 ABI specification names this "auxv_t",
142  * but POSIX lays claim to all symbols ending with "_t".
143  */
144 typedef struct {	/* Auxiliary vector entry on initial stack */
145 	int	a_type;			/* Entry type. */
146 	union {
147 		int	a_val;		/* Integer value. */
148 	} a_un;
149 } Elf32_Auxinfo;
150 
151 
152 typedef struct {	/* Auxiliary vector entry on initial stack */
153 	long	a_type;			/* Entry type. */
154 	union {
155 		long	a_val;		/* Integer value. */
156 		void	*a_ptr;		/* Address. */
157 		void	(*a_fcn)(void);	/* Function pointer (not used). */
158 	} a_un;
159 } Elf64_Auxinfo;
160 
161 __ElfType(Auxinfo);
162 
163 /* Values for a_type. */
164 #define	AT_NULL		0	/* Terminates the vector. */
165 #define	AT_IGNORE	1	/* Ignored entry. */
166 #define	AT_EXECFD	2	/* File descriptor of program to load. */
167 #define	AT_PHDR		3	/* Program header of program already loaded. */
168 #define	AT_PHENT	4	/* Size of each program header entry. */
169 #define	AT_PHNUM	5	/* Number of program header entries. */
170 #define	AT_PAGESZ	6	/* Page size in bytes. */
171 #define	AT_BASE		7	/* Interpreter's base address. */
172 #define	AT_FLAGS	8	/* Flags (unused for i386). */
173 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
174 #define	AT_NOTELF	10	/* Program is not ELF ?? */
175 #define	AT_UID		11	/* Real uid. */
176 #define	AT_EUID		12	/* Effective uid. */
177 #define	AT_GID		13	/* Real gid. */
178 #define	AT_EGID		14	/* Effective gid. */
179 #define	AT_EXECPATH	15	/* Path to the executable. */
180 #define	AT_CANARY	16	/* Canary for SSP */
181 #define	AT_CANARYLEN	17	/* Length of the canary. */
182 #define	AT_OSRELDATE	18	/* OSRELDATE. */
183 #define	AT_NCPUS	19	/* Number of CPUs. */
184 #define	AT_PAGESIZES	20	/* Pagesizes. */
185 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
186 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
187 #define	AT_STACKPROT	23	/* Initial stack protection. */
188 
189 #define	AT_COUNT	24	/* Count of defined aux entry types. */
190 
191 /*
192  * Relocation types.
193  */
194 
195 #define	R_X86_64_COUNT	24	/* Count of defined relocation types. */
196 
197 /* Define "machine" characteristics */
198 #if __ELF_WORD_SIZE == 32
199 #define ELF_TARG_CLASS  ELFCLASS32
200 #else
201 #define ELF_TARG_CLASS  ELFCLASS64
202 #endif
203 #define	ELF_TARG_DATA	ELFDATA2LSB
204 #define	ELF_TARG_MACH	EM_X86_64
205 #define	ELF_TARG_VER	1
206 
207 #if __ELF_WORD_SIZE == 32
208 #define	ET_DYN_LOAD_ADDR 0x01001000
209 #else
210 #define	ET_DYN_LOAD_ADDR 0x01021000
211 #endif
212 
213 #endif /* __i386__, __amd64__ */
214 
215 #endif /* !_MACHINE_ELF_H_ */
216