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 SPARC machine dependent macros, constants
30  * and declarations.
31  */
32 
33 #ifndef	_MACHDEP_SPARC_H
34 #define	_MACHDEP_SPARC_H
35 
36 #pragma ident	"%Z%%M%	%I%	%E% SMI"
37 
38 #include <link.h>
39 #include <sys/machelf.h>
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 /*
46  * Elf header information.
47  */
48 #define	M_MACH_32		EM_SPARC
49 #define	M_MACH_64		EM_SPARCV9
50 
51 #ifdef _ELF64
52 #define	M_MACH			EM_SPARCV9
53 #define	M_CLASS			ELFCLASS64
54 #else
55 #define	M_MACH			EM_SPARC
56 #define	M_CLASS			ELFCLASS32
57 #endif
58 #define	M_MACHPLUS		EM_SPARC32PLUS
59 #define	M_DATA			ELFDATA2MSB
60 #define	M_FLAGSPLUS		EF_SPARC_32PLUS
61 
62 /*
63  * Page boundary Macros: truncate to previous page boundary and round to
64  * next page boundary (refer to generic macros in ../sgs.h also).
65  */
66 #define	M_PTRUNC(X)	((X) & ~(syspagsz - 1))
67 #define	M_PROUND(X)	(((X) + syspagsz - 1) & ~(syspagsz - 1))
68 
69 /*
70  * Segment boundary macros: truncate to previous segment boundary and round
71  * to next page boundary.
72  */
73 #ifndef	M_SEGSIZE
74 #define	M_SEGSIZE	ELF_SPARC_MAXPGSZ
75 #endif
76 #define	M_STRUNC(X)	((X) & ~(M_SEGSIZE - 1))
77 #define	M_SROUND(X)	(((X) + M_SEGSIZE - 1) & ~(M_SEGSIZE - 1))
78 
79 
80 /*
81  * TLS static segments must be rounded to the following requirements,
82  * due to libthread stack allocation.
83  */
84 #if	defined(_ELF64)
85 #define	M_TLSSTATALIGN	0x10
86 #else
87 #define	M_TLSSTATALIGN	0x08
88 #endif
89 
90 
91 /*
92  * Instruction encodings.
93  */
94 #define	M_SAVESP64	0x9de3bfc0	/* save %sp, -64, %sp */
95 #define	M_CALL		0x40000000
96 #define	M_JMPL		0x81c06000	/* jmpl %g1 + simm13, %g0 */
97 #define	M_SETHIG0	0x01000000	/* sethi %hi(val), %g0 */
98 #define	M_SETHIG1	0x03000000	/* sethi %hi(val), %g1 */
99 #define	M_STO7G1IM	0xde206000	/* st	 %o7,[%g1 + %lo(val)] */
100 #define	M_SUBFPSPG1	0x8227800e	/* sub	%fp,%sp,%g1 */
101 #define	M_NOP		0x01000000	/* sethi 0, %o0 (nop) */
102 #define	M_BA_A		0x30800000	/* ba,a */
103 #define	M_BA_A_PT	0x30480000	/* ba,a %icc, <dst> */
104 #define	M_MOVO7TOG1	0x8210000f	/* mov %o7, %g1 */
105 #define	M_MOVO7TOG5	0x8a10000f	/* mov %o7, %g5 */
106 #define	M_MOVI7TOG1	0x8210001f	/* mov %i7, %g1 */
107 #define	M_BA_A_XCC	0x30680000	/* ba,a %xcc */
108 #define	M_JMPL_G5G0	0x81c16000	/* jmpl %g5 + 0, %g0 */
109 #define	M_XNOR_G5G1	0x82396000	/* xnor	%g5, 0, %g1 */
110 
111 
112 #define	M_BIND_ADJ	4		/* adjustment for end of */
113 					/*	elf_rtbndr() address */
114 
115 
116 /*
117  * Plt and Got information; the first few .got and .plt entries are reserved
118  *	PLT[0]	jump to dynamic linker
119  *	GOT[0]	address of _DYNAMIC
120  */
121 #define	M_PLT_INSSIZE	4		/* single plt instruction size */
122 #define	M_GOT_XDYNAMIC	0		/* got index for _DYNAMIC */
123 #define	M_GOT_XNumber	1		/* reserved no. of got entries */
124 
125 /*
126  * ELF32 bit PLT constants
127  */
128 #define	M32_PLT_ENTSIZE		12	/* 32bit plt entry size in bytes */
129 
130 /*
131  * ELF64 bit PLT constants
132  */
133 #define	M64_PLT_NEARPLTS	0x8000	/* # of NEAR PLTS we can have */
134 #define	M64_PLT_ENTSIZE		32	/* plt entry size in bytes */
135 #define	M64_PLT_FENTSIZE	24	/* size of far plt is 6 instructions */
136 					/*	x 4bytes */
137 #define	M64_PLT_PSIZE		8		/* size of PLTP pointer */
138 #define	M64_PLT_FBLKCNTS	160	/* # of plts in far PLT blocks */
139 #define	M64_PLT_FBLOCKSZ	(M64_PLT_FBLKCNTS *\
140 				M64_PLT_ENTSIZE) /* size of far PLT block */
141 
142 
143 #ifdef _ELF64
144 #define	M_PLT_ENTSIZE	M64_PLT_ENTSIZE	/* plt entry size in bytes */
145 #define	M_PLT_XNumber	4		/* reserved no. of plt entries */
146 #define	M_PLT_ALIGN	256		/* alignment of .plt section */
147 #define	M_PLT_RESERVSZ	(M_PLT_XNumber * \
148 			M_PLT_ENTSIZE)	/* first 4 plt's reserved */
149 #define	M_GOT_ENTSIZE	8		/* got entry size in bytes */
150 #define	M_GOT_MAXSMALL	1024		/* maximum no. of small gots */
151 #else /* Elf32 */
152 #define	M_PLT_ENTSIZE	M32_PLT_ENTSIZE	/* plt entry size in bytes */
153 #define	M_PLT_XNumber	4		/* reserved no. of plt entries */
154 #define	M_PLT_ALIGN	M_WORD_ALIGN	/* alignment of .plt section */
155 #define	M_PLT_RESERVSZ	(M_PLT_XNumber * \
156 			M_PLT_ENTSIZE)	/* first 4 plt's reserved */
157 #define	M_GOT_ENTSIZE	4		/* got entry size in bytes */
158 #define	M_GOT_MAXSMALL	2048		/* maximum no. of small gots */
159 #endif /* _ELF64 */
160 					/* transition flags for got sizing */
161 #define	M_GOT_LARGE	(Sword)(-M_GOT_MAXSMALL - 1)
162 #define	M_GOT_SMALL	(Sword)(-M_GOT_MAXSMALL - 2)
163 #define	M_GOT_MIXED	(Sword)(-M_GOT_MAXSMALL - 3)
164 
165 
166 /*
167  * Other machine dependent entities
168  */
169 #ifdef _ELF64
170 #define	M_SEGM_ALIGN	ELF_SPARCV9_MAXPGSZ
171 /*
172  * Put 64-bit programs above 4 gigabytes to help insure correctness,
173  * so any 64-bit programs that truncate pointers will fault now instead of
174  * corrupting itself and dying mysteriously.
175  */
176 #define	M_SEGM_ORIGIN	(Addr)0x100000000ULL  /* default first segment offset */
177 #define	M_WORD_ALIGN	8
178 #else
179 #define	M_SEGM_ALIGN	ELF_SPARC_MAXPGSZ
180 #define	M_SEGM_ORIGIN	(Addr)0x10000	/* default first segment offset */
181 #define	M_WORD_ALIGN	4
182 #endif
183 
184 /*
185  * Make common relocation information transparent to the common code
186  */
187 #define	M_REL_DT_TYPE	DT_RELA		/* .dynamic entry */
188 #define	M_REL_DT_SIZE	DT_RELASZ	/* .dynamic entry */
189 #define	M_REL_DT_ENT	DT_RELAENT	/* .dynamic entry */
190 #define	M_REL_DT_COUNT	DT_RELACOUNT	/* .dynamic entry */
191 #define	M_REL_SHT_TYPE	SHT_RELA	/* section header type */
192 #define	M_REL_ELF_TYPE	ELF_T_RELA	/* data buffer type */
193 
194 /*
195  * Make common relocation types transparent to the common code
196  */
197 #define	M_R_NONE	R_SPARC_NONE
198 #define	M_R_GLOB_DAT	R_SPARC_GLOB_DAT
199 #define	M_R_COPY	R_SPARC_COPY
200 #define	M_R_RELATIVE	R_SPARC_RELATIVE
201 #define	M_R_JMP_SLOT	R_SPARC_JMP_SLOT
202 #define	M_R_REGISTER	R_SPARC_REGISTER
203 #define	M_R_FPTR	R_SPARC_NONE
204 #define	M_R_NUM		R_SPARC_NUM
205 
206 #ifdef	_ELF64
207 #define	M_R_ARRAYADDR	R_SPARC_64
208 #define	M_R_DTPMOD	R_SPARC_TLS_DTPMOD64
209 #define	M_R_DTPOFF	R_SPARC_TLS_DTPOFF64
210 #define	M_R_TPOFF	R_SPARC_TLS_TPOFF64
211 #else	/* _ELF32 */
212 #define	M_R_ARRAYADDR	R_SPARC_32
213 #define	M_R_DTPMOD	R_SPARC_TLS_DTPMOD32
214 #define	M_R_DTPOFF	R_SPARC_TLS_DTPOFF32
215 #define	M_R_TPOFF	R_SPARC_TLS_TPOFF32
216 #endif	/* _ELF64 */
217 
218 
219 /*
220  * Make register symbols transparent to common code
221  */
222 #define	M_DT_REGISTER	DT_SPARC_REGISTER
223 
224 /*
225  * PLTRESERVE is not relevant on sparc
226  */
227 #define	M_DT_PLTRESERVE	0xffffffff
228 
229 
230 /*
231  * Make plt section information transparent to the common code.
232  */
233 #define	M_PLT_SHF_FLAGS	(SHF_ALLOC | SHF_WRITE | SHF_EXECINSTR)
234 
235 /*
236  * Make data segment information transparent to the common code.
237  */
238 #define	M_DATASEG_PERM	(PF_R | PF_W | PF_X)
239 
240 /*
241  * Define a set of identifies for special sections.  These allow the sections
242  * to be ordered within the output file image.  These values should be
243  * maintained consistently, where appropriate, in each platform specific header
244  * file.
245  *
246  *  o	null identifies that this section does not need to be added to the
247  *	output image (ie. shared object sections or sections we're going to
248  *	recreate (sym tables, string tables, relocations, etc.)).
249  *
250  *  o	any user defined section will be first in the associated segment.
251  *
252  *  o	interp and capabilities sections are next, as these are accessed
253  *	immediately the first page of the image is mapped.
254  *
255  *  o	the syminfo, hash, dynsym, dynstr and rel's are grouped together as
256  *	these will all be accessed first by ld.so.1 to perform relocations.
257  *
258  *  o	the got, dynamic, and plt are grouped together as these may also be
259  *	accessed first by ld.so.1 to perform relocations, fill in DT_DEBUG
260  *	(executables only), and .plt[0].
261  *
262  *  o	unknown sections (stabs, comments etc.) go at the end.
263  *
264  * Note that .tlsbss/.bss are given the largest identifiers.  This insures that
265  * if any unknown sections become associated to the same segment as the .bss,
266  * the .bss sections are always the last section in the segment.
267  */
268 #define	M_ID_NULL	0x00
269 #define	M_ID_USER	0x01
270 
271 #define	M_ID_INTERP	0x02			/* SHF_ALLOC */
272 #define	M_ID_CAP	0x03
273 #define	M_ID_SYMINFO	0x04
274 #define	M_ID_HASH	0x05
275 #define	M_ID_LDYNSYM	0x06			/* always right before DYNSYM */
276 #define	M_ID_DYNSYM	0x07
277 #define	M_ID_DYNSTR	0x08
278 #define	M_ID_VERSION	0x09
279 #define	M_ID_DYNSORT	0x0a
280 #define	M_ID_REL	0x0b
281 #define	M_ID_TEXT	0x0c			/* SHF_ALLOC + SHF_EXECINSTR */
282 #define	M_ID_DATA	0x0d
283 
284 /*	M_ID_USER	0x01			dual entry - listed above */
285 #define	M_ID_GOTDATA	0x02			/* SHF_ALLOC + SHF_WRITE */
286 #define	M_ID_GOT	0x03
287 #define	M_ID_PLT	0x04
288 #define	M_ID_DYNAMIC	0x05
289 #define	M_ID_ARRAY	0x06
290 
291 #define	M_ID_UNKNOWN	0xfc			/* just before TLS */
292 
293 #define	M_ID_TLS	0xfd			/* just before bss */
294 #define	M_ID_TLSBSS	0xfe
295 #define	M_ID_BSS	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_SPARC_H */
309