xref: /illumos-gate/usr/src/cmd/sgs/include/i386/machdep_x86.h (revision e44e85a7f9935f0428e188393e3da61b17e83884)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  *	Copyright (c) 1988 AT&T
24  *	  All Rights Reserved
25  *
26  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
27  * Use is subject to license terms.
28  *
29  * Global include file for all sgs ia32 based machine dependent macros,
30  * constants and declarations.
31  */
32 
33 #ifndef	_MACHDEP_X86_H
34 #define	_MACHDEP_X86_H
35 
36 #include <link.h>
37 #include <sys/machelf.h>
38 
39 #ifdef	__cplusplus
40 extern "C" {
41 #endif
42 
43 /*
44  * Elf header information.
45  */
46 #define	M_MACH_32		EM_386
47 #define	M_MACH_64		EM_AMD64
48 
49 #ifdef _ELF64
50 #define	M_MACH			EM_AMD64
51 #define	M_CLASS			ELFCLASS64
52 #else
53 #define	M_MACH			EM_386
54 #define	M_CLASS			ELFCLASS32
55 #endif
56 
57 #define	M_MACHPLUS		M_MACH
58 #define	M_DATA			ELFDATA2LSB
59 #define	M_FLAGSPLUS		0
60 
61 /*
62  * Page boundary Macros: truncate to previous page boundary and round to
63  * next page boundary (refer to generic macros in ../sgs.h also).
64  */
65 #define	M_PTRUNC(X)	((X) & ~(syspagsz - 1))
66 #define	M_PROUND(X)	(((X) + syspagsz - 1) & ~(syspagsz - 1))
67 
68 /*
69  * Segment boundary macros: truncate to previous segment boundary and round
70  * to next page boundary.
71  */
72 #if	defined(_ELF64)
73 #define	M_SEGSIZE	ELF_AMD64_MAXPGSZ
74 #else
75 #define	M_SEGSIZE	ELF_386_MAXPGSZ
76 #endif
77 
78 #define	M_STRUNC(X)	((X) & ~(M_SEGSIZE - 1))
79 #define	M_SROUND(X)	(((X) + M_SEGSIZE - 1) & ~(M_SEGSIZE - 1))
80 
81 /*
82  * Relocation type macros.
83  */
84 #if	defined(_ELF64)
85 #define	M_RELOC		Rela
86 #else
87 #define	M_RELOC		Rel
88 #endif
89 
90 /*
91  * TLS static segments must be rounded to the following requirements,
92  * due to libthread stack allocation.
93  */
94 #if	defined(_ELF64)
95 #define	M_TLSSTATALIGN	0x10
96 #else
97 #define	M_TLSSTATALIGN	0x08
98 #endif
99 
100 /*
101  * Other machine dependent entities
102  */
103 #if	defined(_ELF64)
104 #define	M_SEGM_ALIGN	0x00010000
105 #else
106 #define	M_SEGM_ALIGN	ELF_386_MAXPGSZ
107 #endif
108 
109 /*
110  * Values for IA32 objects
111  */
112 
113 /*
114  * Instruction encodings.
115  */
116 #define	M_INST_JMP		0xe9
117 #define	M_INST_PUSHL		0x68
118 #define	M_SPECIAL_INST		0xff
119 #define	M_PUSHL_DISP		0x35
120 #define	M_PUSHL_REG_DISP	0xb3
121 #define	M_JMP_DISP_IND		0x25
122 #define	M_JMP_REG_DISP_IND	0xa3
123 #define	M_NOP			0x90
124 
125 #define	M_BIND_ADJ	1		/* adjustment for end of */
126 					/*	elf_rtbndr() address */
127 #ifdef _ELF64
128 /*
129  * Provide default starting addresses.  64-bit programs can also be restricted
130  * to a 32-bit address space (SF1_SUNW_ADDR32), and these programs provide an
131  * alternative origin.
132  */
133 #define	M_SEGM_ORIGIN	(Addr)0x400000ULL	/* default 1st segment origin */
134 #define	M_SEGM_AORIGIN	(Addr)0x10000ULL	/* alternative 1st segment */
135 						/*    origin */
136 #define	M_WORD_ALIGN	8
137 #else
138 #define	M_STACK_GAP	(0x08000000)
139 #define	M_STACK_PGS	(0x00048000)
140 #define	M_SEGM_ORIGIN	(Addr)(M_STACK_GAP + M_STACK_PGS)
141 #define	M_SEGM_AORIGIN	M_SEGM_ORIGIN
142 #define	M_WORD_ALIGN	4
143 #endif
144 
145 
146 /*
147  * Plt and Got information; the first few .got and .plt entries are reserved
148  *	PLT[0]	jump to dynamic linker
149  *	GOT[0]	address of _DYNAMIC
150  */
151 #define	M_PLT_ENTSIZE	16		/* plt entry size in bytes */
152 #define	M_PLT_ALIGN	M_WORD_ALIGN	/* alignment of .plt section */
153 #define	M_PLT_INSSIZE	6		/* single plt instruction size */
154 #define	M_PLT_RESERVSZ	M_PLT_ENTSIZE	/* PLT[0] reserved */
155 
156 #define	M_GOT_XDYNAMIC	0		/* got index for _DYNAMIC */
157 #define	M_GOT_XLINKMAP	1		/* got index for link map */
158 #define	M_GOT_XRTLD	2		/* got index for rtbinder */
159 #define	M_GOT_XNumber	3		/* reserved no. of got entries */
160 
161 #ifdef	_ELF64
162 #define	M_GOT_ENTSIZE	8		/* got entry size in bytes */
163 #else /* ELF32 */
164 #define	M_GOT_ENTSIZE	4		/* got entry size in bytes */
165 #endif
166 
167 /*
168  * Make common relocation information transparent to the common code
169  */
170 #if	defined(_ELF64)
171 #define	M_REL_DT_TYPE	DT_RELA		/* .dynamic entry */
172 #define	M_REL_DT_SIZE	DT_RELASZ	/* .dynamic entry */
173 #define	M_REL_DT_ENT	DT_RELAENT	/* .dynamic entry */
174 #define	M_REL_DT_COUNT	DT_RELACOUNT	/* .dynamic entry */
175 #define	M_REL_SHT_TYPE	SHT_RELA	/* section header type */
176 #define	M_REL_ELF_TYPE	ELF_T_RELA	/* data buffer type */
177 
178 #else /* _ELF32 */
179 #define	M_REL_DT_TYPE	DT_REL		/* .dynamic entry */
180 #define	M_REL_DT_SIZE	DT_RELSZ	/* .dynamic entry */
181 #define	M_REL_DT_ENT	DT_RELENT	/* .dynamic entry */
182 #define	M_REL_DT_COUNT	DT_RELCOUNT	/* .dynamic entry */
183 #define	M_REL_SHT_TYPE	SHT_REL		/* section header type */
184 #define	M_REL_ELF_TYPE	ELF_T_REL	/* data buffer type */
185 
186 #endif /* ELF32 */
187 
188 /*
189  * Make common relocation types transparent to the common code
190  */
191 #if	defined(_ELF64)
192 #define	M_R_NONE	R_AMD64_NONE
193 #define	M_R_GLOB_DAT	R_AMD64_GLOB_DAT
194 #define	M_R_COPY	R_AMD64_COPY
195 #define	M_R_RELATIVE	R_AMD64_RELATIVE
196 #define	M_R_JMP_SLOT	R_AMD64_JUMP_SLOT
197 #define	M_R_FPTR	R_AMD64_NONE
198 #define	M_R_ARRAYADDR	R_AMD64_GLOB_DAT
199 #define	M_R_NUM		R_AMD64_NUM
200 #else
201 #define	M_R_NONE	R_386_NONE
202 #define	M_R_GLOB_DAT	R_386_GLOB_DAT
203 #define	M_R_COPY	R_386_COPY
204 #define	M_R_RELATIVE	R_386_RELATIVE
205 #define	M_R_JMP_SLOT	R_386_JMP_SLOT
206 #define	M_R_FPTR	R_386_NONE
207 #define	M_R_ARRAYADDR	R_386_GLOB_DAT
208 #define	M_R_NUM		R_386_NUM
209 #endif
210 
211 /*
212  * The following are defined as M_R_NONE so that checks
213  * for these relocations can be performed in common code - although
214  * the checks are really only relevant to SPARC.
215  */
216 #define	M_R_REGISTER	M_R_NONE
217 
218 /*
219  * DT_REGISTER is not valid on i386 or amd64
220  */
221 #define	M_DT_REGISTER	0xffffffff
222 
223 /*
224  * Make plt section information transparent to the common code.
225  */
226 #define	M_PLT_SHF_FLAGS	(SHF_ALLOC | SHF_EXECINSTR)
227 
228 /*
229  * Make data segment information transparent to the common code.
230  */
231 #ifdef _ELF64
232 #define	M_DATASEG_PERM	(PF_R | PF_W)
233 #else
234 #define	M_DATASEG_PERM	(PF_R | PF_W | PF_X)
235 #endif
236 
237 /*
238  * Define a set of identifies for special sections.  These allow the sections
239  * to be ordered within the output file image.  These values should be
240  * maintained consistently, where appropriate, in each platform specific header
241  * file.
242  *
243  *  o	null identifies that this section does not need to be added to the
244  *	output image (ie. shared object sections or sections we're going to
245  *	recreate (sym tables, string tables, relocations, etc.)).
246  *
247  *  o	any user defined section will be first in the associated segment.
248  *
249  *  o	interp and capabilities sections are next, as these are accessed
250  *	immediately the first page of the image is mapped.
251  *
252  *  o	the syminfo, hash, dynsym, dynstr and rel's are grouped together as
253  *	these will all be accessed first by ld.so.1 to perform relocations.
254  *
255  *  o	the got and dynamic are grouped together as these may also be
256  *	accessed first by ld.so.1 to perform relocations, fill in DT_DEBUG
257  *	(executables only), and .got[0].
258  *
259  *  o	unknown sections (stabs, comments, etc.) go at the end.
260  *
261  * Note that .tlsbss/.bss are given the largest identifiers.  This insures that
262  * if any unknown sections become associated to the same segment as the .bss,
263  * the .bss sections are always the last section in the segment.
264  */
265 #define	M_ID_NULL	0x00
266 #define	M_ID_USER	0x01
267 
268 #define	M_ID_INTERP	0x03			/* SHF_ALLOC */
269 #define	M_ID_CAP	0x04
270 #define	M_ID_UNWINDHDR	0x06
271 #define	M_ID_UNWIND	0x07
272 #define	M_ID_SYMINFO	0x08
273 #define	M_ID_HASH	0x09
274 #define	M_ID_LDYNSYM	0x0a			/* always right before DYNSYM */
275 #define	M_ID_DYNSYM	0x0b
276 #define	M_ID_DYNSTR	0x0c
277 #define	M_ID_VERSION	0x0d
278 #define	M_ID_DYNSORT	0x0e
279 #define	M_ID_REL	0x0f
280 #define	M_ID_PLT	0x10			/* SHF_ALLOC + SHF_EXECISNTR */
281 #define	M_ID_TEXT	0x11
282 #define	M_ID_DATA	0x20
283 
284 /*	M_ID_USER	0x01			dual entry - listed above */
285 #define	M_ID_GOT	0x03			/* SHF_ALLOC + SHF_WRITE */
286 #define	M_ID_DYNAMIC	0x05
287 #define	M_ID_ARRAY	0x06
288 /*	M_ID_UNWIND	0x07			dual entry - listed above */
289 
290 #define	M_ID_UNKNOWN	0xfb			/* just before TLS */
291 
292 #define	M_ID_TLS	0xfc			/* just before bss */
293 #define	M_ID_TLSBSS	0xfd
294 #define	M_ID_BSS	0xfe
295 #define	M_ID_LBSS	0xff
296 
297 #define	M_ID_SYMTAB_NDX	0x02			/* ! SHF_ALLOC */
298 #define	M_ID_SYMTAB	0x03
299 #define	M_ID_STRTAB	0x04
300 #define	M_ID_DYNSYM_NDX	0x05
301 #define	M_ID_NOTE	0x06
302 
303 
304 #ifdef	__cplusplus
305 }
306 #endif
307 
308 #endif /* _MACHDEP_X86_H */
309