1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
* Copyright 2019 Joyent, Inc.
*/
#ifndef _SYS_BRAND_H
#define _SYS_BRAND_H
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/proc.h>
#include <sys/exec.h>
#include <sys/modctl.h>
#include <sys/types.h>
/*
* All Brands supported by this kernel must use BRAND_VER_1.
*/
#define BRAND_VER_1 1
/*
* sub-commands to brandsys.
* 1 - 128 are for common commands
* 128+ are available for brand-specific commands.
*/
#define B_REGISTER 1
#define B_TTYMODES 2
#define B_ELFDATA 3
#define B_EXEC_NATIVE 4
#define B_EXEC_BRAND 5
#define B_TRUSS_POINT 6
/*
* Structure used by zoneadmd to communicate the name of a brand and the
* supporting brand module into the kernel.
*/
struct brand_attr {
char ba_brandname[MAXNAMELEN];
char ba_modname[MAXPATHLEN];
};
/* What we call the native brand. */
#define NATIVE_BRAND_NAME "native"
/* What we call the labeled brand. */
#define LABELED_BRAND_NAME "labeled"
/*
* Aux vector containing lddata pointer of brand library linkmap.
* Used by common {brand}_librtld_db.
*/
#define AT_SUN_BRAND_COMMON_LDDATA AT_SUN_BRAND_AUX1
/*
* Information needed by the brand library to launch an executable.
*/
typedef struct brand_elf_data {
ulong_t sed_phdr;
ulong_t sed_phent;
ulong_t sed_phnum;
ulong_t sed_entry;
ulong_t sed_base;
ulong_t sed_ldentry;
ulong_t sed_lddata;
} brand_elf_data_t;
/*
* Common structure used to register a branded processes
*/
typedef struct brand_proc_reg {
uint_t sbr_version; /* version number */
caddr_t sbr_handler; /* base address of handler */
} brand_proc_reg_t;
#ifdef _KERNEL
struct proc;
struct uarg;
struct brand_mach_ops;
struct intpdata;
struct execa;
/*
* Common structure to define hooks for brand operation.
*
* Required Fields:
* b_init_brand_data - Setup zone brand data during zone_setbrand
* b_free_brand_data - Free zone brand data during zone_destroy
* b_brandsys - Syscall handler for brandsys
* b_setbrand - Initialize process brand data
* b_getattr - Get brand-custom zone attribute
* b_setattr - Set brand-custom zone attribute
* b_copy_procdata - Copy process brand data during fork
* b_proc_exit - Perform process brand exit processing
* b_exec - Reset branded process state on exec
* b_lwp_setrval - Set return code for forked child
* b_initlwp - Initialize lwp brand data (cannot drop p->p_lock)
* b_forklwp - Copy lwp brand data during fork
* b_freelwp - Free lwp brand data
* b_lwpexit - Perform lwp-specific brand exit processing
* b_elfexec - Load and execute ELF binary
* b_sigset_native_to_brand - Convert sigset native->brand
* b_sigset_brand_to_native - Convert sigset brand->native
* b_nsig - Maxiumum signal number
* b_sendsig - Update process state after sendsig
*
* Optional Fields:
* b_lwpdata_alloc - Speculatively allocate data for use in b_initlwp
* b_lwpdata_free - Free data from allocated by b_lwpdata_alloc if errors occur
* during lwp creation before b_initlwp could be called.
* b_initlwp_post - Complete lwp branding (can temporarily drop p->p_lock)
* b_exit_with_sig - Instead of sending SIGCLD, exit with custom behavior
* b_psig_to_proc - Custom additional behavior during psig
* b_wait_filter - Filter processes from being matched by waitid
* b_native_exec - Provide interpreter path prefix for executables
* b_ptrace_exectrap - Custom behavior for legacy ptrace traps
* b_map32limit - Specify alternate limit for MAP_32BIT mappings
* b_stop_notify - Hook process stop events
* b_waitid_helper - Generate synthetic results for waitid
* b_sigcld_repost - Post synthetic SIGCLD signals
* b_issig_stop - Alter/suppress signal delivery during issig
* b_sig_ignorable - Disallow discarding of signals
* b_savecontext - Alter context during savecontext
* b_restorecontext - Alter context during restorecontext
* b_sendsig_stack - Override stack used for signal delivery
* b_setid_clear - Override setid_clear behavior
* b_pagefault - Trap pagefault events
* b_intp_parse_arg - Controls interpreter argument handling (allow 1 or all)
* b_clearbrand - Perform any actions necessary when clearing the brand.
* b_rpc_statd - Upcall to rpc.statd running within the zone
* b_acct_out - Output properly formatted accounting record
*/
struct brand_ops {
void (*b_init_brand_data)(zone_t *, kmutex_t *);
void (*b_free_brand_data)(zone_t *);
int (*b_brandsys)(int, int64_t *, uintptr_t, uintptr_t, uintptr_t,
uintptr_t);
void (*b_setbrand)(struct proc *);
int (*b_getattr)(zone_t *, int, void *, size_t *);
int (*b_setattr)(zone_t *, int, void *, size_t);
void (*b_copy_procdata)(struct proc *, struct proc *);
void (*b_proc_exit)(struct proc *);
void (*b_exec)();
void (*b_lwp_setrval)(klwp_t *, int, int);
void *(*b_lwpdata_alloc)(struct proc *);
void (*b_lwpdata_free)(void *);
void (*b_initlwp)(klwp_t *, void *);
void (*b_initlwp_post)(klwp_t *);
void (*b_forklwp)(klwp_t *, klwp_t *);
void (*b_freelwp)(klwp_t *);
void (*b_lwpexit)(klwp_t *);
int (*b_elfexec)(struct vnode *, struct execa *, struct uarg *,
struct intpdata *, int, size_t *, int, caddr_t, struct cred *,
int *);
void (*b_sigset_native_to_brand)(sigset_t *);
void (*b_sigset_brand_to_native)(sigset_t *);
void (*b_sigfd_translate)(k_siginfo_t *);
int b_nsig;
void (*b_exit_with_sig)(proc_t *, sigqueue_t *);
boolean_t (*b_wait_filter)(proc_t *, proc_t *);
boolean_t (*b_native_exec)(uint8_t, const char **);
uint32_t (*b_map32limit)(proc_t *);
void (*b_stop_notify)(proc_t *, klwp_t *, ushort_t, ushort_t);
int (*b_waitid_helper)(idtype_t, id_t, k_siginfo_t *, int,
boolean_t *, int *);
int (*b_sigcld_repost)(proc_t *, sigqueue_t *);
int (*b_issig_stop)(proc_t *, klwp_t *);
boolean_t (*b_sig_ignorable)(proc_t *, klwp_t *, int);
void (*b_savecontext)(ucontext_t *);
#if defined(_SYSCALL32_IMPL)
void (*b_savecontext32)(ucontext32_t *);
#endif
void (*b_restorecontext)(ucontext_t *);
caddr_t (*b_sendsig_stack)(int);
void (*b_sendsig)(int);
int (*b_setid_clear)(vattr_t *vap, cred_t *cr);
int (*b_pagefault)(proc_t *, klwp_t *, caddr_t, enum fault_type,
enum seg_rw);
boolean_t b_intp_parse_arg;
void (*b_clearbrand)(proc_t *, boolean_t);
void (*b_rpc_statd)(int, void *, void *);
void (*b_acct_out)(struct vnode *, int);
};
/*
* The b_version field must always be the first entry in this struct.
*/
typedef struct brand {
int b_version;
char *b_name;
struct brand_ops *b_ops;
struct brand_mach_ops *b_machops;
size_t b_data_size;
} brand_t;
extern brand_t native_brand;
/*
* Convenience macros
*/
#define lwptolwpbrand(l) ((l)->lwp_brand)
#define ttolwpbrand(t) (lwptolwpbrand(ttolwp(t)))
#define PROC_IS_BRANDED(p) ((p)->p_brand != &native_brand)
#define ZONE_IS_BRANDED(z) ((z)->zone_brand != &native_brand)
#define BROP(p) ((p)->p_brand->b_ops)
#define ZBROP(z) ((z)->zone_brand->b_ops)
#define BRMOP(p) ((p)->p_brand->b_machops)
#define SIGSET_NATIVE_TO_BRAND(sigset) \
if (PROC_IS_BRANDED(curproc) && \
BROP(curproc)->b_sigset_native_to_brand) \
BROP(curproc)->b_sigset_native_to_brand(sigset)
#define SIGSET_BRAND_TO_NATIVE(sigset) \
if (PROC_IS_BRANDED(curproc) && \
BROP(curproc)->b_sigset_brand_to_native) \
BROP(curproc)->b_sigset_brand_to_native(sigset)
extern void brand_init();
extern int brand_register(brand_t *);
extern int brand_unregister(brand_t *);
extern brand_t *brand_register_zone(struct brand_attr *);
extern brand_t *brand_find_name(char *);
extern void brand_unregister_zone(brand_t *);
extern int brand_zone_count(brand_t *);
extern int brand_setbrand(proc_t *, boolean_t);
extern void brand_clearbrand(proc_t *, boolean_t);
/*
* The following functions can be shared among kernel brand modules which
* implement Solaris-derived brands, all of which need to do similar tasks to
* manage the brand.
*/
extern int brand_solaris_cmd(int, uintptr_t, uintptr_t, uintptr_t,
struct brand *, int);
extern void brand_solaris_copy_procdata(proc_t *, proc_t *,
struct brand *);
extern int brand_solaris_elfexec(vnode_t *, execa_t *, uarg_t *,
intpdata_t *, int, size_t *, int, caddr_t, cred_t *, int *,
struct brand *, char *, char *, char *);
extern void brand_solaris_exec(struct brand *);
extern int brand_solaris_fini(char **, struct modlinkage *,
struct brand *);
extern void brand_solaris_forklwp(klwp_t *, klwp_t *, struct brand *);
extern void brand_solaris_freelwp(klwp_t *, struct brand *);
extern void brand_solaris_initlwp(klwp_t *, struct brand *);
extern void brand_solaris_lwpexit(klwp_t *, struct brand *);
extern void brand_solaris_proc_exit(struct proc *, struct brand *);
extern void brand_solaris_setbrand(proc_t *, struct brand *);
#if defined(_SYSCALL32)
typedef struct brand_elf_data32 {
uint32_t sed_phdr;
uint32_t sed_phent;
uint32_t sed_phnum;
uint32_t sed_entry;
uint32_t sed_base;
uint32_t sed_ldentry;
uint32_t sed_lddata;
} brand_elf_data32_t;
typedef struct brand_common_reg32 {
uint32_t sbr_version; /* version number */
caddr32_t sbr_handler; /* base address of handler */
} brand_common_reg32_t;
#endif /* _SYSCALL32 */
/*
* Common information associated with all branded processes
*/
typedef struct brand_proc_data {
caddr_t spd_handler; /* address of user-space handler */
brand_elf_data_t spd_elf_data; /* common ELF data for branded app. */
} brand_proc_data_t;
#define BRAND_NATIVE_DIR "/.SUNWnative/"
#define BRAND_NATIVE_LINKER32 BRAND_NATIVE_DIR "lib/ld.so.1"
#define BRAND_NATIVE_LINKER64 BRAND_NATIVE_DIR "lib/64/ld.so.1"
#endif /* _KERNEL */
#ifdef __cplusplus
}
#endif
#endif /* _SYS_BRAND_H */
|