xref: /onnv-gate/usr/src/uts/common/sys/zone.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_ZONE_H
28*0Sstevel@tonic-gate #define	_SYS_ZONE_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <sys/mutex.h>
34*0Sstevel@tonic-gate #include <sys/param.h>
35*0Sstevel@tonic-gate #include <sys/rctl.h>
36*0Sstevel@tonic-gate #include <sys/pset.h>
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate #ifdef	__cplusplus
39*0Sstevel@tonic-gate extern "C" {
40*0Sstevel@tonic-gate #endif
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate /*
43*0Sstevel@tonic-gate  * NOTE
44*0Sstevel@tonic-gate  *
45*0Sstevel@tonic-gate  * The contents of this file are private to the implementation of
46*0Sstevel@tonic-gate  * Solaris and are subject to change at any time without notice.
47*0Sstevel@tonic-gate  * Applications and drivers using these interfaces may fail to
48*0Sstevel@tonic-gate  * run on future releases.
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate /* Available both in kernel and for user space */
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate /* zone id restrictions and special ids */
54*0Sstevel@tonic-gate #define	MAX_ZONEID	9999
55*0Sstevel@tonic-gate #define	MIN_USERZONEID	1	/* lowest user-creatable zone ID */
56*0Sstevel@tonic-gate #define	MIN_ZONEID	0	/* minimum zone ID on system */
57*0Sstevel@tonic-gate #define	GLOBAL_ZONEID	0
58*0Sstevel@tonic-gate #define	ZONEID_WIDTH	4	/* for printf */
59*0Sstevel@tonic-gate 
60*0Sstevel@tonic-gate /* system call subcodes */
61*0Sstevel@tonic-gate #define	ZONE_CREATE	0
62*0Sstevel@tonic-gate #define	ZONE_DESTROY	1
63*0Sstevel@tonic-gate #define	ZONE_GETATTR	2
64*0Sstevel@tonic-gate #define	ZONE_ENTER	3
65*0Sstevel@tonic-gate #define	ZONE_LIST	4
66*0Sstevel@tonic-gate #define	ZONE_SHUTDOWN	5
67*0Sstevel@tonic-gate #define	ZONE_LOOKUP	6
68*0Sstevel@tonic-gate #define	ZONE_BOOT	7
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate /* zone attributes */
71*0Sstevel@tonic-gate #define	ZONE_ATTR_ROOT		1
72*0Sstevel@tonic-gate #define	ZONE_ATTR_NAME		2
73*0Sstevel@tonic-gate #define	ZONE_ATTR_STATUS	3
74*0Sstevel@tonic-gate #define	ZONE_ATTR_PRIVSET	4
75*0Sstevel@tonic-gate #define	ZONE_ATTR_UNIQID	5
76*0Sstevel@tonic-gate #define	ZONE_ATTR_POOLID	6
77*0Sstevel@tonic-gate #define	ZONE_ATTR_INITPID	7
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate #ifdef _SYSCALL32
80*0Sstevel@tonic-gate typedef struct {
81*0Sstevel@tonic-gate 	caddr32_t zone_name;
82*0Sstevel@tonic-gate 	caddr32_t zone_root;
83*0Sstevel@tonic-gate 	caddr32_t zone_privs;
84*0Sstevel@tonic-gate 	caddr32_t rctlbuf;
85*0Sstevel@tonic-gate 	size32_t rctlbufsz;
86*0Sstevel@tonic-gate 	caddr32_t extended_error;
87*0Sstevel@tonic-gate } zone_def32;
88*0Sstevel@tonic-gate #endif
89*0Sstevel@tonic-gate typedef struct {
90*0Sstevel@tonic-gate 	const char *zone_name;
91*0Sstevel@tonic-gate 	const char *zone_root;
92*0Sstevel@tonic-gate 	const struct priv_set *zone_privs;
93*0Sstevel@tonic-gate 	const char *rctlbuf;
94*0Sstevel@tonic-gate 	size_t rctlbufsz;
95*0Sstevel@tonic-gate 	int *extended_error;
96*0Sstevel@tonic-gate } zone_def;
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate /* extended error information */
99*0Sstevel@tonic-gate #define	ZE_UNKNOWN	0	/* No extended error info */
100*0Sstevel@tonic-gate #define	ZE_CHROOTED	1	/* tried to zone_create from chroot */
101*0Sstevel@tonic-gate #define	ZE_AREMOUNTS	2	/* there are mounts within the zone */
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate /* zone_status */
104*0Sstevel@tonic-gate typedef enum {
105*0Sstevel@tonic-gate 	ZONE_IS_UNINITIALIZED = 0,
106*0Sstevel@tonic-gate 	ZONE_IS_READY,
107*0Sstevel@tonic-gate 	ZONE_IS_BOOTING,
108*0Sstevel@tonic-gate 	ZONE_IS_RUNNING,
109*0Sstevel@tonic-gate 	ZONE_IS_SHUTTING_DOWN,
110*0Sstevel@tonic-gate 	ZONE_IS_EMPTY,
111*0Sstevel@tonic-gate 	ZONE_IS_DOWN,
112*0Sstevel@tonic-gate 	ZONE_IS_DYING,
113*0Sstevel@tonic-gate 	ZONE_IS_DEAD
114*0Sstevel@tonic-gate } zone_status_t;
115*0Sstevel@tonic-gate #define	ZONE_MIN_STATE		ZONE_IS_UNINITIALIZED
116*0Sstevel@tonic-gate #define	ZONE_MAX_STATE		ZONE_IS_DEAD
117*0Sstevel@tonic-gate 
118*0Sstevel@tonic-gate /*
119*0Sstevel@tonic-gate  * Valid commands which may be issued by zoneadm to zoneadmd.  The kernel also
120*0Sstevel@tonic-gate  * communicates with zoneadmd, but only uses Z_REBOOT and Z_HALT.
121*0Sstevel@tonic-gate  */
122*0Sstevel@tonic-gate typedef enum zone_cmd {
123*0Sstevel@tonic-gate 	Z_READY, Z_BOOT, Z_REBOOT, Z_HALT, Z_NOTE_UNINSTALLING
124*0Sstevel@tonic-gate } zone_cmd_t;
125*0Sstevel@tonic-gate 
126*0Sstevel@tonic-gate #define	ZONEBOOTARGS_MAX	257	/* uadmin()'s buffer is 257 bytes. */
127*0Sstevel@tonic-gate 
128*0Sstevel@tonic-gate /*
129*0Sstevel@tonic-gate  * The structure of a request to zoneadmd.
130*0Sstevel@tonic-gate  */
131*0Sstevel@tonic-gate typedef struct zone_cmd_arg {
132*0Sstevel@tonic-gate 	uint64_t	uniqid;		/* unique "generation number" */
133*0Sstevel@tonic-gate 	zone_cmd_t	cmd;		/* requested action */
134*0Sstevel@tonic-gate 	char locale[MAXPATHLEN];	/* locale in which to render messages */
135*0Sstevel@tonic-gate 	char bootbuf[ZONEBOOTARGS_MAX];	/* arguments passed to zone_boot() */
136*0Sstevel@tonic-gate } zone_cmd_arg_t;
137*0Sstevel@tonic-gate 
138*0Sstevel@tonic-gate /*
139*0Sstevel@tonic-gate  * Structure of zoneadmd's response to a request.  A NULL return value means
140*0Sstevel@tonic-gate  * the caller should attempt to restart zoneadmd and retry.
141*0Sstevel@tonic-gate  */
142*0Sstevel@tonic-gate typedef struct zone_cmd_rval {
143*0Sstevel@tonic-gate 	int rval;			/* return value of request */
144*0Sstevel@tonic-gate 	char errbuf[1];	/* variable-sized buffer containing error messages */
145*0Sstevel@tonic-gate } zone_cmd_rval_t;
146*0Sstevel@tonic-gate 
147*0Sstevel@tonic-gate /*
148*0Sstevel@tonic-gate  * The zone support infrastructure uses the zone name as a component
149*0Sstevel@tonic-gate  * of unix domain (AF_UNIX) sockets, which are limited to 108 characters
150*0Sstevel@tonic-gate  * in length, so ZONENAME_MAX is limited by that.
151*0Sstevel@tonic-gate  */
152*0Sstevel@tonic-gate #define	ZONENAME_MAX		64
153*0Sstevel@tonic-gate 
154*0Sstevel@tonic-gate #define	GLOBAL_ZONENAME		"global"
155*0Sstevel@tonic-gate 
156*0Sstevel@tonic-gate /*
157*0Sstevel@tonic-gate  * Extended Regular expression (see regex(5)) which matches all valid zone
158*0Sstevel@tonic-gate  * names.
159*0Sstevel@tonic-gate  */
160*0Sstevel@tonic-gate #define	ZONENAME_REGEXP		"[a-zA-Z0-9][-_.a-zA-Z0-9]{0,62}"
161*0Sstevel@tonic-gate 
162*0Sstevel@tonic-gate /*
163*0Sstevel@tonic-gate  * Where the zones support infrastructure places temporary files.
164*0Sstevel@tonic-gate  */
165*0Sstevel@tonic-gate #define	ZONES_TMPDIR		"/var/run/zones"
166*0Sstevel@tonic-gate 
167*0Sstevel@tonic-gate /*
168*0Sstevel@tonic-gate  * The path to the door used by clients to communicate with zoneadmd.
169*0Sstevel@tonic-gate  */
170*0Sstevel@tonic-gate #define	ZONE_DOOR_PATH		ZONES_TMPDIR "/%s.zoneadmd_door"
171*0Sstevel@tonic-gate 
172*0Sstevel@tonic-gate 
173*0Sstevel@tonic-gate #ifdef _KERNEL
174*0Sstevel@tonic-gate /*
175*0Sstevel@tonic-gate  * We need to protect the definition of 'list_t' from userland applications and
176*0Sstevel@tonic-gate  * libraries which may be defining ther own versions.
177*0Sstevel@tonic-gate  */
178*0Sstevel@tonic-gate #include <sys/list.h>
179*0Sstevel@tonic-gate 
180*0Sstevel@tonic-gate #define	GLOBAL_ZONEUNIQID	0	/* uniqid of the global zone */
181*0Sstevel@tonic-gate 
182*0Sstevel@tonic-gate /* zone_flags */
183*0Sstevel@tonic-gate #define	ZF_DESTROYED		0x1	/* ZSD destructor callbacks run */
184*0Sstevel@tonic-gate 
185*0Sstevel@tonic-gate struct pool;
186*0Sstevel@tonic-gate 
187*0Sstevel@tonic-gate typedef struct zone {
188*0Sstevel@tonic-gate 	/*
189*0Sstevel@tonic-gate 	 * zone_name is never modified once set.
190*0Sstevel@tonic-gate 	 */
191*0Sstevel@tonic-gate 	char		*zone_name;	/* zone's configuration name */
192*0Sstevel@tonic-gate 	/*
193*0Sstevel@tonic-gate 	 * zone_nodename and zone_domain are never freed once allocated.
194*0Sstevel@tonic-gate 	 */
195*0Sstevel@tonic-gate 	char		*zone_nodename;	/* utsname.nodename equivalent */
196*0Sstevel@tonic-gate 	char		*zone_domain;	/* srpc_domain equivalent */
197*0Sstevel@tonic-gate 	/*
198*0Sstevel@tonic-gate 	 * zone_lock protects the following fields of a zone_t:
199*0Sstevel@tonic-gate 	 * 	zone_ref
200*0Sstevel@tonic-gate 	 * 	zone_cred_ref
201*0Sstevel@tonic-gate 	 * 	zone_ntasks
202*0Sstevel@tonic-gate 	 * 	zone_flags
203*0Sstevel@tonic-gate 	 * 	zone_zsd
204*0Sstevel@tonic-gate 	 */
205*0Sstevel@tonic-gate 	kmutex_t	zone_lock;
206*0Sstevel@tonic-gate 	/*
207*0Sstevel@tonic-gate 	 * zone_linkage is the zone's linkage into the active or
208*0Sstevel@tonic-gate 	 * death-row list.  The field is protected by zonehash_lock.
209*0Sstevel@tonic-gate 	 */
210*0Sstevel@tonic-gate 	list_node_t	zone_linkage;
211*0Sstevel@tonic-gate 	zoneid_t	zone_id;	/* ID of zone */
212*0Sstevel@tonic-gate 	uint_t		zone_ref;	/* count of zone_hold()s on zone */
213*0Sstevel@tonic-gate 	uint_t		zone_cred_ref;	/* count of zone_hold_cred()s on zone */
214*0Sstevel@tonic-gate 	/*
215*0Sstevel@tonic-gate 	 * zone_rootvp and zone_rootpath can never be modified once set.
216*0Sstevel@tonic-gate 	 */
217*0Sstevel@tonic-gate 	struct vnode	*zone_rootvp;	/* zone's root vnode */
218*0Sstevel@tonic-gate 	char		*zone_rootpath;	/* Path to zone's root + '/' */
219*0Sstevel@tonic-gate 	ushort_t	zone_flags;	/* misc flags */
220*0Sstevel@tonic-gate 	zone_status_t	zone_status;	/* protected by zone_status_lock */
221*0Sstevel@tonic-gate 	uint_t		zone_ntasks;	/* number of tasks executing in zone */
222*0Sstevel@tonic-gate 	kmutex_t	zone_nlwps_lock; /* protects zone_nlwps, and *_nlwps */
223*0Sstevel@tonic-gate 					/* counters in projects and tasks */
224*0Sstevel@tonic-gate 					/* that are within the zone */
225*0Sstevel@tonic-gate 	rctl_qty_t	zone_nlwps;	/* number of lwps in zone */
226*0Sstevel@tonic-gate 	rctl_qty_t	zone_nlwps_ctl; /* protected by zone_rctls->rcs_lock */
227*0Sstevel@tonic-gate 
228*0Sstevel@tonic-gate 	uint_t		zone_rootpathlen; /* strlen(zone_rootpath) + 1 */
229*0Sstevel@tonic-gate 	uint32_t	zone_shares;	/* FSS shares allocated to zone */
230*0Sstevel@tonic-gate 	rctl_set_t	*zone_rctls;	/* zone-wide (zone.*) rctls */
231*0Sstevel@tonic-gate 	list_t		zone_zsd;	/* list of Zone-Specific Data values */
232*0Sstevel@tonic-gate 	kcondvar_t	zone_cv;	/* used to signal state changes */
233*0Sstevel@tonic-gate 	struct proc	*zone_zsched;	/* Dummy kernel "zsched" process */
234*0Sstevel@tonic-gate 	pid_t		zone_proc_initpid; /* pid of "init" for this zone */
235*0Sstevel@tonic-gate 	int		zone_boot_err;  /* for zone_boot() if boot fails */
236*0Sstevel@tonic-gate 	char		*zone_bootargs;	/* arguments passed via zone_boot() */
237*0Sstevel@tonic-gate 	/*
238*0Sstevel@tonic-gate 	 * zone_kthreads is protected by zone_status_lock.
239*0Sstevel@tonic-gate 	 */
240*0Sstevel@tonic-gate 	kthread_t	*zone_kthreads;	/* kernel threads in zone */
241*0Sstevel@tonic-gate 	struct priv_set	*zone_privset;	/* limit set for zone */
242*0Sstevel@tonic-gate 	/*
243*0Sstevel@tonic-gate 	 * zone_vfslist is protected by vfs_list_lock().
244*0Sstevel@tonic-gate 	 */
245*0Sstevel@tonic-gate 	struct vfs	*zone_vfslist;	/* list of FS's mounted in zone */
246*0Sstevel@tonic-gate 	uint64_t	zone_uniqid;	/* unique zone generation number */
247*0Sstevel@tonic-gate 	struct cred	*zone_kcred;	/* kcred-like, zone-limited cred */
248*0Sstevel@tonic-gate 	/*
249*0Sstevel@tonic-gate 	 * zone_pool is protected by pool_lock().
250*0Sstevel@tonic-gate 	 */
251*0Sstevel@tonic-gate 	struct pool	*zone_pool;	/* pool the zone is bound to */
252*0Sstevel@tonic-gate 	hrtime_t	zone_pool_mod;	/* last pool bind modification time */
253*0Sstevel@tonic-gate 	/* zone_psetid is protected by cpu_lock */
254*0Sstevel@tonic-gate 	psetid_t	zone_psetid;	/* pset the zone is bound to */
255*0Sstevel@tonic-gate 	/*
256*0Sstevel@tonic-gate 	 * The following two can be read without holding any locks.  They are
257*0Sstevel@tonic-gate 	 * updated under cpu_lock.
258*0Sstevel@tonic-gate 	 */
259*0Sstevel@tonic-gate 	int		zone_ncpus;  /* zone's idea of ncpus */
260*0Sstevel@tonic-gate 	int		zone_ncpus_online; /* zone's idea of ncpus_online */
261*0Sstevel@tonic-gate } zone_t;
262*0Sstevel@tonic-gate 
263*0Sstevel@tonic-gate /*
264*0Sstevel@tonic-gate  * Special value of zone_psetid to indicate that pools are disabled.
265*0Sstevel@tonic-gate  */
266*0Sstevel@tonic-gate #define	ZONE_PS_INVAL	PS_MYID
267*0Sstevel@tonic-gate 
268*0Sstevel@tonic-gate extern zone_t zone0;
269*0Sstevel@tonic-gate extern zone_t *global_zone;
270*0Sstevel@tonic-gate extern uint_t maxzones;
271*0Sstevel@tonic-gate extern rctl_hndl_t rc_zone_nlwps;
272*0Sstevel@tonic-gate 
273*0Sstevel@tonic-gate extern const char * const zone_initname;
274*0Sstevel@tonic-gate 
275*0Sstevel@tonic-gate extern long zone(int, void *, void *, void *, void *, void *);
276*0Sstevel@tonic-gate extern void zone_zsd_init(void);
277*0Sstevel@tonic-gate extern void zone_init(void);
278*0Sstevel@tonic-gate extern void zone_hold(zone_t *);
279*0Sstevel@tonic-gate extern void zone_rele(zone_t *);
280*0Sstevel@tonic-gate extern void zone_cred_hold(zone_t *);
281*0Sstevel@tonic-gate extern void zone_cred_rele(zone_t *);
282*0Sstevel@tonic-gate extern void zone_task_hold(zone_t *);
283*0Sstevel@tonic-gate extern void zone_task_rele(zone_t *);
284*0Sstevel@tonic-gate extern zone_t *zone_find_by_id(zoneid_t);
285*0Sstevel@tonic-gate extern zone_t *zone_find_by_name(char *);
286*0Sstevel@tonic-gate extern zone_t *zone_find_by_path(const char *);
287*0Sstevel@tonic-gate extern zoneid_t getzoneid(void);
288*0Sstevel@tonic-gate 
289*0Sstevel@tonic-gate /*
290*0Sstevel@tonic-gate  * Zone-specific data (ZSD) APIs
291*0Sstevel@tonic-gate  */
292*0Sstevel@tonic-gate /*
293*0Sstevel@tonic-gate  * The following is what code should be initializing its zone_key_t to if it
294*0Sstevel@tonic-gate  * calls zone_getspecific() without necessarily knowing that zone_key_create()
295*0Sstevel@tonic-gate  * has been called on the key.
296*0Sstevel@tonic-gate  */
297*0Sstevel@tonic-gate #define	ZONE_KEY_UNINITIALIZED	0
298*0Sstevel@tonic-gate 
299*0Sstevel@tonic-gate typedef uint_t zone_key_t;
300*0Sstevel@tonic-gate 
301*0Sstevel@tonic-gate extern void	zone_key_create(zone_key_t *, void *(*)(zoneid_t),
302*0Sstevel@tonic-gate     void (*)(zoneid_t, void *), void (*)(zoneid_t, void *));
303*0Sstevel@tonic-gate extern int 	zone_key_delete(zone_key_t);
304*0Sstevel@tonic-gate extern void	*zone_getspecific(zone_key_t, zone_t *);
305*0Sstevel@tonic-gate extern int	zone_setspecific(zone_key_t, zone_t *, const void *);
306*0Sstevel@tonic-gate 
307*0Sstevel@tonic-gate /*
308*0Sstevel@tonic-gate  * The definition of a zsd_entry is truly private to zone.c and is only
309*0Sstevel@tonic-gate  * placed here so it can be shared with mdb.
310*0Sstevel@tonic-gate  */
311*0Sstevel@tonic-gate struct zsd_entry {
312*0Sstevel@tonic-gate 	zone_key_t		zsd_key;	/* Key used to lookup value */
313*0Sstevel@tonic-gate 	void			*zsd_data;	/* Caller-managed value */
314*0Sstevel@tonic-gate 	/*
315*0Sstevel@tonic-gate 	 * Callbacks to be executed when a zone is created, shutdown, and
316*0Sstevel@tonic-gate 	 * destroyed, respectively.
317*0Sstevel@tonic-gate 	 */
318*0Sstevel@tonic-gate 	void			*(*zsd_create)(zoneid_t);
319*0Sstevel@tonic-gate 	void			(*zsd_shutdown)(zoneid_t, void *);
320*0Sstevel@tonic-gate 	void			(*zsd_destroy)(zoneid_t, void *);
321*0Sstevel@tonic-gate 	list_node_t		zsd_linkage;
322*0Sstevel@tonic-gate };
323*0Sstevel@tonic-gate 
324*0Sstevel@tonic-gate /*
325*0Sstevel@tonic-gate  * Macros to help with zone visibility restrictions.
326*0Sstevel@tonic-gate  */
327*0Sstevel@tonic-gate 
328*0Sstevel@tonic-gate /*
329*0Sstevel@tonic-gate  * Is process in the global zone?
330*0Sstevel@tonic-gate  */
331*0Sstevel@tonic-gate #define	INGLOBALZONE(p) \
332*0Sstevel@tonic-gate 	((p)->p_zone == global_zone)
333*0Sstevel@tonic-gate 
334*0Sstevel@tonic-gate /*
335*0Sstevel@tonic-gate  * Can process view objects in given zone?
336*0Sstevel@tonic-gate  */
337*0Sstevel@tonic-gate #define	HASZONEACCESS(p, zoneid) \
338*0Sstevel@tonic-gate 	((p)->p_zone->zone_id == (zoneid) || INGLOBALZONE(p))
339*0Sstevel@tonic-gate 
340*0Sstevel@tonic-gate /*
341*0Sstevel@tonic-gate  * Convenience macro to see if a resolved path is visible from within a
342*0Sstevel@tonic-gate  * given zone.
343*0Sstevel@tonic-gate  *
344*0Sstevel@tonic-gate  * The basic idea is that the first (zone_rootpathlen - 1) bytes of the
345*0Sstevel@tonic-gate  * two strings must be equal.  Since the rootpathlen has a trailing '/',
346*0Sstevel@tonic-gate  * we want to skip everything in the path up to (but not including) the
347*0Sstevel@tonic-gate  * trailing '/'.
348*0Sstevel@tonic-gate  */
349*0Sstevel@tonic-gate #define	ZONE_PATH_VISIBLE(path, zone) \
350*0Sstevel@tonic-gate 	(strncmp((path), (zone)->zone_rootpath,		\
351*0Sstevel@tonic-gate 	    (zone)->zone_rootpathlen - 1) == 0)
352*0Sstevel@tonic-gate 
353*0Sstevel@tonic-gate /*
354*0Sstevel@tonic-gate  * Convenience macro to go from the global view of a path to that seen
355*0Sstevel@tonic-gate  * from within said zone.  It is the responsibility of the caller to
356*0Sstevel@tonic-gate  * ensure that the path is a resolved one (ie, no '..'s or '.'s), and is
357*0Sstevel@tonic-gate  * in fact visible from within the zone.
358*0Sstevel@tonic-gate  */
359*0Sstevel@tonic-gate #define	ZONE_PATH_TRANSLATE(path, zone)	\
360*0Sstevel@tonic-gate 	(ASSERT(ZONE_PATH_VISIBLE(path, zone)),	\
361*0Sstevel@tonic-gate 	(path) + (zone)->zone_rootpathlen - 2)
362*0Sstevel@tonic-gate 
363*0Sstevel@tonic-gate /*
364*0Sstevel@tonic-gate  * Special processes visible in all zones.
365*0Sstevel@tonic-gate  */
366*0Sstevel@tonic-gate #define	ZONE_SPECIALPID(x)	 ((x) == 0 || (x) == 1)
367*0Sstevel@tonic-gate 
368*0Sstevel@tonic-gate /*
369*0Sstevel@tonic-gate  * Special zoneid_t token to refer to all zones.
370*0Sstevel@tonic-gate  */
371*0Sstevel@tonic-gate #define	ALL_ZONES	(-1)
372*0Sstevel@tonic-gate 
373*0Sstevel@tonic-gate /*
374*0Sstevel@tonic-gate  * Zone-safe version of thread_create() to be used when the caller wants to
375*0Sstevel@tonic-gate  * create a kernel thread to run within the current zone's context.
376*0Sstevel@tonic-gate  */
377*0Sstevel@tonic-gate extern kthread_t *zthread_create(caddr_t, size_t, void (*)(), void *, size_t,
378*0Sstevel@tonic-gate     pri_t);
379*0Sstevel@tonic-gate extern void zthread_exit(void);
380*0Sstevel@tonic-gate 
381*0Sstevel@tonic-gate /*
382*0Sstevel@tonic-gate  * Functions for an external observer to register interest in a zone's status
383*0Sstevel@tonic-gate  * change.  Observers will be woken up when the zone status equals the status
384*0Sstevel@tonic-gate  * argument passed in (in the case of zone_status_timedwait, the function may
385*0Sstevel@tonic-gate  * also return because of a timeout; zone_status_wait_sig may return early due
386*0Sstevel@tonic-gate  * to a signal being delivered; zone_status_timedwait_sig may return for any of
387*0Sstevel@tonic-gate  * the above reasons).
388*0Sstevel@tonic-gate  *
389*0Sstevel@tonic-gate  * Otherwise these behave identically to cv_timedwait(), cv_wait(), and
390*0Sstevel@tonic-gate  * cv_wait_sig() respectively.
391*0Sstevel@tonic-gate  */
392*0Sstevel@tonic-gate extern clock_t zone_status_timedwait(zone_t *, clock_t, zone_status_t);
393*0Sstevel@tonic-gate extern clock_t zone_status_timedwait_sig(zone_t *, clock_t, zone_status_t);
394*0Sstevel@tonic-gate extern void zone_status_wait(zone_t *, zone_status_t);
395*0Sstevel@tonic-gate extern int zone_status_wait_sig(zone_t *, zone_status_t);
396*0Sstevel@tonic-gate 
397*0Sstevel@tonic-gate /*
398*0Sstevel@tonic-gate  * Get the status  of the zone (at the time it was called).  The state may
399*0Sstevel@tonic-gate  * have progressed by the time it is returned.
400*0Sstevel@tonic-gate  */
401*0Sstevel@tonic-gate extern zone_status_t zone_status_get(zone_t *);
402*0Sstevel@tonic-gate 
403*0Sstevel@tonic-gate /*
404*0Sstevel@tonic-gate  * Get the "kcred" credentials corresponding to the given zone.
405*0Sstevel@tonic-gate  */
406*0Sstevel@tonic-gate extern struct cred *zone_get_kcred(zoneid_t);
407*0Sstevel@tonic-gate 
408*0Sstevel@tonic-gate /*
409*0Sstevel@tonic-gate  * Get/set the pool the zone is currently bound to.
410*0Sstevel@tonic-gate  */
411*0Sstevel@tonic-gate extern struct pool *zone_pool_get(zone_t *);
412*0Sstevel@tonic-gate extern void zone_pool_set(zone_t *, struct pool *);
413*0Sstevel@tonic-gate 
414*0Sstevel@tonic-gate /*
415*0Sstevel@tonic-gate  * Get/set the pset the zone is currently using.
416*0Sstevel@tonic-gate  */
417*0Sstevel@tonic-gate extern psetid_t zone_pset_get(zone_t *);
418*0Sstevel@tonic-gate extern void zone_pset_set(zone_t *, psetid_t);
419*0Sstevel@tonic-gate 
420*0Sstevel@tonic-gate /*
421*0Sstevel@tonic-gate  * Get the number of cpus/online-cpus visible from the given zone.
422*0Sstevel@tonic-gate  */
423*0Sstevel@tonic-gate extern int zone_ncpus_get(zone_t *);
424*0Sstevel@tonic-gate extern int zone_ncpus_online_get(zone_t *);
425*0Sstevel@tonic-gate 
426*0Sstevel@tonic-gate /*
427*0Sstevel@tonic-gate  * zone version of uadmin()
428*0Sstevel@tonic-gate  */
429*0Sstevel@tonic-gate extern int zone_uadmin(int, int, struct cred *);
430*0Sstevel@tonic-gate extern void zone_shutdown_global(void);
431*0Sstevel@tonic-gate 
432*0Sstevel@tonic-gate extern void mount_in_progress(void);
433*0Sstevel@tonic-gate extern void mount_completed(void);
434*0Sstevel@tonic-gate 
435*0Sstevel@tonic-gate extern int zone_walk(int (*)(zone_t *, void *), void *);
436*0Sstevel@tonic-gate 
437*0Sstevel@tonic-gate #endif	/* _KERNEL */
438*0Sstevel@tonic-gate 
439*0Sstevel@tonic-gate #ifdef	__cplusplus
440*0Sstevel@tonic-gate }
441*0Sstevel@tonic-gate #endif
442*0Sstevel@tonic-gate 
443*0Sstevel@tonic-gate #endif	/* _SYS_ZONE_H */
444