xref: /illumos-gate/usr/src/cmd/sgs/include/i386/machdep_x86.h (revision 1f6352c601b7f3c744b4684ff673c813927da24c)
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  * TLS static segments must be rounded to the following requirements,
83  * due to libthread stack allocation.
84  */
85 #if	defined(_ELF64)
86 #define	M_TLSSTATALIGN	0x10
87 #else
88 #define	M_TLSSTATALIGN	0x08
89 #endif
90 
91 
92 /*
93  * Other machine dependent entities
94  */
95 #if	defined(_ELF64)
96 #define	M_SEGM_ALIGN	0x00010000
97 #else
98 #define	M_SEGM_ALIGN	ELF_386_MAXPGSZ
99 #endif
100 
101 /*
102  * Values for IA32 objects
103  */
104 
105 /*
106  * Instruction encodings.
107  */
108 #define	M_INST_JMP		0xe9
109 #define	M_INST_PUSHL		0x68
110 #define	M_SPECIAL_INST		0xff
111 #define	M_PUSHL_DISP		0x35
112 #define	M_PUSHL_REG_DISP	0xb3
113 #define	M_JMP_DISP_IND		0x25
114 #define	M_JMP_REG_DISP_IND	0xa3
115 #define	M_NOP			0x90
116 
117 #define	M_BIND_ADJ	1		/* adjustment for end of */
118 					/*	elf_rtbndr() address */
119 #ifdef _ELF64
120 /*
121  * Provide default starting addresses.  64-bit programs can also be restricted
122  * to a 32-bit address space (SF1_SUNW_ADDR32), and these programs provide an
123  * alternative origin.
124  */
125 #define	M_SEGM_ORIGIN	(Addr)0x400000ULL	/* default 1st segment origin */
126 #define	M_SEGM_AORIGIN	(Addr)0x10000ULL	/* alternative 1st segment */
127 						/*    origin */
128 #define	M_WORD_ALIGN	8
129 #else
130 #define	M_STACK_GAP	(0x08000000)
131 #define	M_STACK_PGS	(0x00048000)
132 #define	M_SEGM_ORIGIN	(Addr)(M_STACK_GAP + M_STACK_PGS)
133 #define	M_SEGM_AORIGIN	M_SEGM_ORIGIN
134 #define	M_WORD_ALIGN	4
135 #endif
136 
137 
138 /*
139  * Plt and Got information; the first few .got and .plt entries are reserved
140  *	PLT[0]	jump to dynamic linker
141  *	GOT[0]	address of _DYNAMIC
142  */
143 #define	M_PLT_ENTSIZE	16		/* plt entry size in bytes */
144 #define	M_PLT_ALIGN	M_WORD_ALIGN	/* alignment of .plt section */
145 #define	M_PLT_INSSIZE	6		/* single plt instruction size */
146 #define	M_PLT_RESERVSZ	M_PLT_ENTSIZE	/* PLT[0] reserved */
147 
148 #define	M_GOT_XDYNAMIC	0		/* got index for _DYNAMIC */
149 #define	M_GOT_XLINKMAP	1		/* got index for link map */
150 #define	M_GOT_XRTLD	2		/* got index for rtbinder */
151 #define	M_GOT_XNumber	3		/* reserved no. of got entries */
152 
153 #ifdef	_ELF64
154 #define	M_GOT_ENTSIZE	8		/* got entry size in bytes */
155 #else /* ELF32 */
156 #define	M_GOT_ENTSIZE	4		/* got entry size in bytes */
157 #endif
158 
159 /*
160  * Make common relocation information transparent to the common code
161  */
162 #if	defined(_ELF64)
163 #define	M_REL_DT_TYPE	DT_RELA		/* .dynamic entry */
164 #define	M_REL_DT_SIZE	DT_RELASZ	/* .dynamic entry */
165 #define	M_REL_DT_ENT	DT_RELAENT	/* .dynamic entry */
166 #define	M_REL_DT_COUNT	DT_RELACOUNT	/* .dynamic entry */
167 #define	M_REL_SHT_TYPE	SHT_RELA	/* section header type */
168 #define	M_REL_ELF_TYPE	ELF_T_RELA	/* data buffer type */
169 
170 #else /* _ELF32 */
171 #define	M_REL_DT_TYPE	DT_REL		/* .dynamic entry */
172 #define	M_REL_DT_SIZE	DT_RELSZ	/* .dynamic entry */
173 #define	M_REL_DT_ENT	DT_RELENT	/* .dynamic entry */
174 #define	M_REL_DT_COUNT	DT_RELCOUNT	/* .dynamic entry */
175 #define	M_REL_SHT_TYPE	SHT_REL		/* section header type */
176 #define	M_REL_ELF_TYPE	ELF_T_REL	/* data buffer type */
177 
178 #endif /* ELF32 */
179 
180 /*
181  * Make common relocation types transparent to the common code
182  */
183 #if	defined(_ELF64)
184 #define	M_R_NONE	R_AMD64_NONE
185 #define	M_R_GLOB_DAT	R_AMD64_GLOB_DAT
186 #define	M_R_COPY	R_AMD64_COPY
187 #define	M_R_RELATIVE	R_AMD64_RELATIVE
188 #define	M_R_JMP_SLOT	R_AMD64_JUMP_SLOT
189 #define	M_R_FPTR	R_AMD64_NONE
190 #define	M_R_ARRAYADDR	R_AMD64_GLOB_DAT
191 #define	M_R_NUM		R_AMD64_NUM
192 #else
193 #define	M_R_NONE	R_386_NONE
194 #define	M_R_GLOB_DAT	R_386_GLOB_DAT
195 #define	M_R_COPY	R_386_COPY
196 #define	M_R_RELATIVE	R_386_RELATIVE
197 #define	M_R_JMP_SLOT	R_386_JMP_SLOT
198 #define	M_R_FPTR	R_386_NONE
199 #define	M_R_ARRAYADDR	R_386_GLOB_DAT
200 #define	M_R_NUM		R_386_NUM
201 #endif
202 
203 /*
204  * The following are defined as M_R_NONE so that checks
205  * for these relocations can be performed in common code - although
206  * the checks are really only relevant to SPARC.
207  */
208 #define	M_R_REGISTER	M_R_NONE
209 
210 /*
211  * DT_REGISTER is not valid on i386 or amd64
212  */
213 #define	M_DT_REGISTER	0xffffffff
214 
215 /*
216  * Make plt section information transparent to the common code.
217  */
218 #define	M_PLT_SHF_FLAGS	(SHF_ALLOC | SHF_EXECINSTR)
219 
220 /*
221  * Make data segment information transparent to the common code.
222  */
223 #ifdef _ELF64
224 #define	M_DATASEG_PERM	(PF_R | PF_W)
225 #else
226 #define	M_DATASEG_PERM	(PF_R | PF_W | PF_X)
227 #endif
228 
229 /*
230  * Define a set of identifies for special sections.  These allow the sections
231  * to be ordered within the output file image.  These values should be
232  * maintained consistently, where appropriate, in each platform specific header
233  * file.
234  *
235  *  o	null identifies that this section does not need to be added to the
236  *	output image (ie. shared object sections or sections we're going to
237  *	recreate (sym tables, string tables, relocations, etc.)).
238  *
239  *  o	any user defined section will be first in the associated segment.
240  *
241  *  o	interp and capabilities sections are next, as these are accessed
242  *	immediately the first page of the image is mapped.
243  *
244  *  o	the syminfo, hash, dynsym, dynstr and rel's are grouped together as
245  *	these will all be accessed first by ld.so.1 to perform relocations.
246  *
247  *  o	the got and dynamic are grouped together as these may also be
248  *	accessed first by ld.so.1 to perform relocations, fill in DT_DEBUG
249  *	(executables only), and .got[0].
250  *
251  *  o	unknown sections (stabs, comments, etc.) go at the end.
252  *
253  * Note that .tlsbss/.bss are given the largest identifiers.  This insures that
254  * if any unknown sections become associated to the same segment as the .bss,
255  * the .bss sections are always the last section in the segment.
256  */
257 #define	M_ID_NULL	0x00
258 #define	M_ID_USER	0x01
259 
260 #define	M_ID_INTERP	0x03			/* SHF_ALLOC */
261 #define	M_ID_CAP	0x04
262 #define	M_ID_UNWINDHDR	0x05
263 #define	M_ID_UNWIND	0x06
264 #define	M_ID_SYMINFO	0x07
265 #define	M_ID_HASH	0x08
266 #define	M_ID_LDYNSYM	0x09			/* always right before DYNSYM */
267 #define	M_ID_DYNSYM	0x0a
268 #define	M_ID_DYNSTR	0x0b
269 #define	M_ID_VERSION	0x0c
270 #define	M_ID_DYNSORT	0x0d
271 #define	M_ID_REL	0x0e
272 #define	M_ID_PLT	0x0f			/* SHF_ALLOC + SHF_EXECISNTR */
273 #define	M_ID_TEXT	0x10
274 #define	M_ID_DATA	0x20
275 
276 /*	M_ID_USER	0x02			dual entry - listed above */
277 #define	M_ID_GOT	0x03			/* SHF_ALLOC + SHF_WRITE */
278 #define	M_ID_DYNAMIC	0x05
279 #define	M_ID_ARRAY	0x06
280 
281 #define	M_ID_UNKNOWN	0xfb			/* just before TLS */
282 
283 #define	M_ID_TLS	0xfc			/* just before bss */
284 #define	M_ID_TLSBSS	0xfd
285 #define	M_ID_BSS	0xfe
286 #define	M_ID_LBSS	0xff
287 
288 #define	M_ID_SYMTAB_NDX	0x02			/* ! SHF_ALLOC */
289 #define	M_ID_SYMTAB	0x03
290 #define	M_ID_STRTAB	0x04
291 #define	M_ID_DYNSYM_NDX	0x05
292 #define	M_ID_NOTE	0x06
293 
294 
295 #ifdef	__cplusplus
296 }
297 #endif
298 
299 #endif /* _MACHDEP_X86_H */
300