xref: /illumos-gate/usr/src/uts/common/brand/solaris10/s10_brand.h (revision e9af4bc0b1cc30cea75d6ad4aa2fde97d985e9be)
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  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _S10_BRAND_H
27 #define	_S10_BRAND_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #include <sys/types.h>
34 
35 #define	S10_BRANDNAME		"solaris10"
36 
37 #define	S10_VERSION_1		1
38 #define	S10_VERSION		S10_VERSION_1
39 
40 #define	S10_NATIVE_DIR		"/.SUNWnative/"
41 #define	S10_LIB_NAME		"s10_brand.so.1"
42 #define	S10_LINKER_NAME		"ld.so.1"
43 
44 #define	S10_LIB32		S10_NATIVE_DIR "usr/lib/" S10_LIB_NAME
45 #define	S10_LINKER32		"/lib/" S10_LINKER_NAME
46 #define	S10_NATIVE_LINKER32	S10_NATIVE_DIR "lib/" S10_LINKER_NAME
47 
48 #define	S10_LIB64		S10_NATIVE_DIR "usr/lib/64/" S10_LIB_NAME
49 #define	S10_LINKER64		"/lib/64/" S10_LINKER_NAME
50 #define	S10_NATIVE_LINKER64	S10_NATIVE_DIR "lib/64/" S10_LINKER_NAME
51 
52 #if defined(_LP64)
53 #define	S10_LIB		S10_LIB64
54 #define	S10_LINKER	S10_LINKER64
55 #else /* !_LP64 */
56 #define	S10_LIB		S10_LIB32
57 #define	S10_LINKER	S10_LINKER32
58 #endif /* !_LP64 */
59 
60 /*
61  * Brand system call subcodes.  0-127 are reserved for generic subcodes.
62  */
63 #define	B_S10_PIDINFO		128
64 #define	B_S10_TRUSS_POINT	129
65 #define	B_S10_NATIVE		130
66 #define	B_S10_FSREGCORRECTION	131
67 #define	B_S10_ISFDXATTRDIR	132
68 
69 /*
70  * Versioning flags
71  *
72  * The first enum value must be zero.  Place new enum values at the end of the
73  * list but before S10_NUM_EMUL_FEATURES, which must always come last.
74  * Enum values should start with "S10_FEATURE_" and be named after the
75  * fixes/backports that they represent.  For example, an enum value representing
76  * a backport that changes a MNTFS ioctl could be named
77  * "S10_FEATURE_ALTERED_MNTFS_IOCTL".
78  */
79 enum s10_emulated_features {
80 	S10_FEATURE_ALTERED_MNTFS_IOCTL,
81 	S10_NUM_EMUL_FEATURES		/* This must be the last entry! */
82 };
83 
84 /*
85  * This string constant represents the path of the Solaris 10 directory
86  * containing emulation feature files.
87  */
88 #define	S10_REQ_EMULATION_DIR	"/usr/lib/brand/solaris10"
89 
90 /*
91  * s10_brand_syscall_callback_common() needs to save 4 local registers so it
92  * can free them up for its own use.
93  */
94 #define	S10_CPU_REG_SAVE_SIZE	(sizeof (ulong_t) * 4)
95 
96 /*
97  * Aux vector containing lddata pointer of brand library linkmap.
98  * Used by s10_librtld_db.
99  */
100 #define	AT_SUN_BRAND_S10_LDDATA		AT_SUN_BRAND_AUX1
101 
102 /*
103  * S10 system call codes for S10 traps that have been removed or
104  * re-assigned.
105  */
106 #define	S10_SYS_issetugid	75
107 
108 /*
109  * solaris10-brand-specific attributes
110  * These must start at ZONE_ATTR_BRAND_ATTRS.
111  */
112 #define	S10_EMUL_BITMAP		ZONE_ATTR_BRAND_ATTRS
113 
114 /*
115  * Information needed by the s10 library to launch an executable.
116  */
117 typedef struct s10_elf_data {
118 	ulong_t		sed_phdr;
119 	ulong_t		sed_phent;
120 	ulong_t		sed_phnum;
121 	ulong_t		sed_entry;
122 	ulong_t		sed_base;
123 	ulong_t		sed_ldentry;
124 	ulong_t		sed_lddata;
125 } s10_elf_data_t;
126 
127 /*
128  * Structure used to register a branded processes
129  */
130 typedef struct s10_brand_reg {
131 	uint_t		sbr_version;	/* version number */
132 	caddr_t		sbr_handler;	/* base address of handler */
133 } s10_brand_reg_t;
134 
135 /*
136  * s10_emul_bitmap represents an emulation feature bitmap.  Each constant
137  * in s10_emulated_features defines a bit index in this bitmap.  If a bit is
138  * set, then the feature associated with the s10_emulated_features constant
139  * whose value is the bit's index is present in the associated zone's hosted
140  * Solaris 10 environment.
141  *
142  * NOTE: There must be at least one byte in the bitmap.
143  *
144  * We don't use the bitmap macros provided by usr/src/uts/common/sys/bitmap.h
145  * because they operate on ulong_t arrays.  The size of a ulong_t depends on
146  * the data model in which the code that declares the ulong_t is compiled:
147  * four bytes on 32-bit architectures and eight bytes 64-bit architectures.
148  * If the kernel is 64-bit and a 32-bit process executes in a solaris10-
149  * branded zone, then if the process' emulation library, which is 32-bit,
150  * queries the kernel for the zone's emulation bitmap, then the kernel will
151  * refuse because the library will request a bitmap that's half as big
152  * as the bitmap the kernel provides.  The 32-bit emulation library would need
153  * its own macros to define and operate on bitmaps with 64-bit array elements.
154  * Thus using the sys/bitmap.h macros is probably more troublesome than
155  * defining and using our own constants and macros for bitmap manipulations.
156  */
157 typedef uint8_t s10_emul_bitmap_t[(S10_NUM_EMUL_FEATURES >> 3) + 1];
158 
159 #if defined(_KERNEL)
160 #if defined(_SYSCALL32)
161 typedef struct s10_elf_data32 {
162 	uint32_t	sed_phdr;
163 	uint32_t	sed_phent;
164 	uint32_t	sed_phnum;
165 	uint32_t	sed_entry;
166 	uint32_t	sed_base;
167 	uint32_t	sed_ldentry;
168 	uint32_t	sed_lddata;
169 } s10_elf_data32_t;
170 
171 typedef struct s10_brand_reg32 {
172 	uint32_t	sbr_version;	/* version number */
173 	caddr32_t	sbr_handler;	/* base address of handler */
174 } s10_brand_reg32_t;
175 #endif /* _SYSCALL32 */
176 
177 /*
178  * Information associated with all s10 branded processes
179  */
180 typedef struct s10_proc_data {
181 	caddr_t		spd_handler;	/* address of user-space handler */
182 	s10_elf_data_t	spd_elf_data;	/* ELF data for s10 application */
183 } s10_proc_data_t;
184 
185 /* brand specific data */
186 typedef struct s10_zone_data {
187 	/*
188 	 * emul_bitmap specifies the features that are present in the
189 	 * associated zone.
190 	 */
191 	s10_emul_bitmap_t	emul_bitmap;
192 } s10_zone_data_t;
193 
194 void s10_brand_syscall_callback(void);
195 void s10_brand_syscall32_callback(void);
196 
197 #if !defined(sparc)
198 void s10_brand_sysenter_callback(void);
199 #endif /* !sparc */
200 
201 #if defined(__amd64)
202 void s10_brand_int91_callback(void);
203 #endif /* __amd64 */
204 #endif /* _KERNEL */
205 
206 #ifdef	__cplusplus
207 }
208 #endif
209 
210 #endif	/* _S10_BRAND_H */
211