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