xref: /illumos-gate/usr/src/uts/common/sys/zone.h (revision e6f8def1ace27f327240a0b4b090911007f71137)
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 (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24 
25 #ifndef _SYS_ZONE_H
26 #define	_SYS_ZONE_H
27 
28 #include <sys/types.h>
29 #include <sys/mutex.h>
30 #include <sys/param.h>
31 #include <sys/rctl.h>
32 #include <sys/ipc_rctl.h>
33 #include <sys/pset.h>
34 #include <sys/tsol/label.h>
35 #include <sys/cred.h>
36 #include <sys/netstack.h>
37 #include <sys/uadmin.h>
38 #include <sys/ksynch.h>
39 
40 #ifdef	__cplusplus
41 extern "C" {
42 #endif
43 
44 /*
45  * NOTE
46  *
47  * The contents of this file are private to the implementation of
48  * Solaris and are subject to change at any time without notice.
49  * Applications and drivers using these interfaces may fail to
50  * run on future releases.
51  */
52 
53 /* Available both in kernel and for user space */
54 
55 /* zone id restrictions and special ids */
56 #define	MAX_ZONEID	9999
57 #define	MIN_USERZONEID	1	/* lowest user-creatable zone ID */
58 #define	MIN_ZONEID	0	/* minimum zone ID on system */
59 #define	GLOBAL_ZONEID	0
60 #define	ZONEID_WIDTH	4	/* for printf */
61 
62 /*
63  * Special zoneid_t token to refer to all zones.
64  */
65 #define	ALL_ZONES	(-1)
66 
67 /* system call subcodes */
68 #define	ZONE_CREATE		0
69 #define	ZONE_DESTROY		1
70 #define	ZONE_GETATTR		2
71 #define	ZONE_ENTER		3
72 #define	ZONE_LIST		4
73 #define	ZONE_SHUTDOWN		5
74 #define	ZONE_LOOKUP		6
75 #define	ZONE_BOOT		7
76 #define	ZONE_VERSION		8
77 #define	ZONE_SETATTR		9
78 #define	ZONE_ADD_DATALINK	10
79 #define	ZONE_DEL_DATALINK	11
80 #define	ZONE_CHECK_DATALINK	12
81 #define	ZONE_LIST_DATALINK	13
82 
83 /* zone attributes */
84 #define	ZONE_ATTR_ROOT		1
85 #define	ZONE_ATTR_NAME		2
86 #define	ZONE_ATTR_STATUS	3
87 #define	ZONE_ATTR_PRIVSET	4
88 #define	ZONE_ATTR_UNIQID	5
89 #define	ZONE_ATTR_POOLID	6
90 #define	ZONE_ATTR_INITPID	7
91 #define	ZONE_ATTR_SLBL		8
92 #define	ZONE_ATTR_INITNAME	9
93 #define	ZONE_ATTR_BOOTARGS	10
94 #define	ZONE_ATTR_BRAND		11
95 #define	ZONE_ATTR_PHYS_MCAP	12
96 #define	ZONE_ATTR_SCHED_CLASS	13
97 #define	ZONE_ATTR_FLAGS		14
98 #define	ZONE_ATTR_HOSTID	15
99 
100 /* Start of the brand-specific attribute namespace */
101 #define	ZONE_ATTR_BRAND_ATTRS	32768
102 
103 #define	ZONE_EVENT_CHANNEL	"com.sun:zones:status"
104 #define	ZONE_EVENT_STATUS_CLASS	"status"
105 #define	ZONE_EVENT_STATUS_SUBCLASS	"change"
106 
107 #define	ZONE_EVENT_UNINITIALIZED	"uninitialized"
108 #define	ZONE_EVENT_INITIALIZED		"initialized"
109 #define	ZONE_EVENT_READY		"ready"
110 #define	ZONE_EVENT_RUNNING		"running"
111 #define	ZONE_EVENT_SHUTTING_DOWN	"shutting_down"
112 
113 #define	ZONE_CB_NAME		"zonename"
114 #define	ZONE_CB_NEWSTATE	"newstate"
115 #define	ZONE_CB_OLDSTATE	"oldstate"
116 #define	ZONE_CB_TIMESTAMP	"when"
117 #define	ZONE_CB_ZONEID		"zoneid"
118 
119 /*
120  * Exit values that may be returned by scripts or programs invoked by various
121  * zone commands.
122  *
123  * These are defined as:
124  *
125  *	ZONE_SUBPROC_OK
126  *	===============
127  *	The subprocess completed successfully.
128  *
129  *	ZONE_SUBPROC_USAGE
130  *	==================
131  *	The subprocess failed with a usage message, or a usage message should
132  *	be output in its behalf.
133  *
134  *	ZONE_SUBPROC_NOTCOMPLETE
135  *	========================
136  *	The subprocess did not complete, but the actions performed by the
137  *	subprocess require no recovery actions by the user.
138  *
139  *	For example, if the subprocess were called by "zoneadm install," the
140  *	installation of the zone did not succeed but the user need not perform
141  *	a "zoneadm uninstall" before attempting another install.
142  *
143  *	ZONE_SUBPROC_FATAL
144  *	==================
145  *	The subprocess failed in a fatal manner, usually one that will require
146  *	some type of recovery action by the user.
147  *
148  *	For example, if the subprocess were called by "zoneadm install," the
149  *	installation of the zone did not succeed and the user will need to
150  *	perform a "zoneadm uninstall" before another install attempt is
151  *	possible.
152  *
153  *	The non-success exit values are large to avoid accidental collision
154  *	with values used internally by some commands (e.g. "Z_ERR" and
155  *	"Z_USAGE" as used by zoneadm.)
156  */
157 #define	ZONE_SUBPROC_OK			0
158 #define	ZONE_SUBPROC_USAGE		253
159 #define	ZONE_SUBPROC_NOTCOMPLETE	254
160 #define	ZONE_SUBPROC_FATAL		255
161 
162 #ifdef _SYSCALL32
163 typedef struct {
164 	caddr32_t zone_name;
165 	caddr32_t zone_root;
166 	caddr32_t zone_privs;
167 	size32_t zone_privssz;
168 	caddr32_t rctlbuf;
169 	size32_t rctlbufsz;
170 	caddr32_t extended_error;
171 	caddr32_t zfsbuf;
172 	size32_t  zfsbufsz;
173 	int match;			/* match level */
174 	uint32_t doi;			/* DOI for label */
175 	caddr32_t label;		/* label associated with zone */
176 	int flags;
177 } zone_def32;
178 #endif
179 typedef struct {
180 	const char *zone_name;
181 	const char *zone_root;
182 	const struct priv_set *zone_privs;
183 	size_t zone_privssz;
184 	const char *rctlbuf;
185 	size_t rctlbufsz;
186 	int *extended_error;
187 	const char *zfsbuf;
188 	size_t zfsbufsz;
189 	int match;			/* match level */
190 	uint32_t doi;			/* DOI for label */
191 	const bslabel_t *label;		/* label associated with zone */
192 	int flags;
193 } zone_def;
194 
195 /* extended error information */
196 #define	ZE_UNKNOWN	0	/* No extended error info */
197 #define	ZE_CHROOTED	1	/* tried to zone_create from chroot */
198 #define	ZE_AREMOUNTS	2	/* there are mounts within the zone */
199 #define	ZE_LABELINUSE	3	/* label is already in use by some other zone */
200 
201 /* zone_status */
202 typedef enum {
203 	ZONE_IS_UNINITIALIZED = 0,
204 	ZONE_IS_INITIALIZED,
205 	ZONE_IS_READY,
206 	ZONE_IS_BOOTING,
207 	ZONE_IS_RUNNING,
208 	ZONE_IS_SHUTTING_DOWN,
209 	ZONE_IS_EMPTY,
210 	ZONE_IS_DOWN,
211 	ZONE_IS_DYING,
212 	ZONE_IS_DEAD
213 } zone_status_t;
214 #define	ZONE_MIN_STATE		ZONE_IS_UNINITIALIZED
215 #define	ZONE_MAX_STATE		ZONE_IS_DEAD
216 
217 /*
218  * Valid commands which may be issued by zoneadm to zoneadmd.  The kernel also
219  * communicates with zoneadmd, but only uses Z_REBOOT and Z_HALT.
220  */
221 typedef enum zone_cmd {
222 	Z_READY, Z_BOOT, Z_FORCEBOOT, Z_REBOOT, Z_HALT, Z_NOTE_UNINSTALLING,
223 	Z_MOUNT, Z_FORCEMOUNT, Z_UNMOUNT
224 } zone_cmd_t;
225 
226 /*
227  * The structure of a request to zoneadmd.
228  */
229 typedef struct zone_cmd_arg {
230 	uint64_t	uniqid;		/* unique "generation number" */
231 	zone_cmd_t	cmd;		/* requested action */
232 	uint32_t	_pad;		/* need consistent 32/64 bit alignmt */
233 	char locale[MAXPATHLEN];	/* locale in which to render messages */
234 	char bootbuf[BOOTARGS_MAX];	/* arguments passed to zone_boot() */
235 } zone_cmd_arg_t;
236 
237 /*
238  * Structure of zoneadmd's response to a request.  A NULL return value means
239  * the caller should attempt to restart zoneadmd and retry.
240  */
241 typedef struct zone_cmd_rval {
242 	int rval;			/* return value of request */
243 	char errbuf[1];	/* variable-sized buffer containing error messages */
244 } zone_cmd_rval_t;
245 
246 /*
247  * The zone support infrastructure uses the zone name as a component
248  * of unix domain (AF_UNIX) sockets, which are limited to 108 characters
249  * in length, so ZONENAME_MAX is limited by that.
250  */
251 #define	ZONENAME_MAX		64
252 
253 #define	GLOBAL_ZONENAME		"global"
254 
255 /*
256  * Extended Regular expression (see regex(5)) which matches all valid zone
257  * names.
258  */
259 #define	ZONENAME_REGEXP		"[a-zA-Z0-9][-_.a-zA-Z0-9]{0,62}"
260 
261 /*
262  * Where the zones support infrastructure places temporary files.
263  */
264 #define	ZONES_TMPDIR		"/var/run/zones"
265 
266 /*
267  * The path to the door used by clients to communicate with zoneadmd.
268  */
269 #define	ZONE_DOOR_PATH		ZONES_TMPDIR "/%s.zoneadmd_door"
270 
271 /* zone_flags */
272 #define	ZF_HASHED_LABEL		0x2	/* zone has a unique label */
273 #define	ZF_IS_SCRATCH		0x4	/* scratch zone */
274 #define	ZF_NET_EXCL		0x8	/* Zone has an exclusive IP stack */
275 
276 /* zone_create flags */
277 #define	ZCF_NET_EXCL		0x1	/* Create a zone with exclusive IP */
278 
279 #ifdef _KERNEL
280 /*
281  * We need to protect the definition of 'list_t' from userland applications and
282  * libraries which may be defining ther own versions.
283  */
284 #include <sys/list.h>
285 
286 #define	GLOBAL_ZONEUNIQID	0	/* uniqid of the global zone */
287 
288 struct pool;
289 struct brand;
290 
291 /*
292  * Structure to record list of ZFS datasets exported to a zone.
293  */
294 typedef struct zone_dataset {
295 	char		*zd_dataset;
296 	list_node_t	zd_linkage;
297 } zone_dataset_t;
298 
299 /*
300  * structure for zone kstats
301  */
302 typedef struct zone_kstat {
303 	kstat_named_t zk_zonename;
304 	kstat_named_t zk_usage;
305 	kstat_named_t zk_value;
306 } zone_kstat_t;
307 
308 struct cpucap;
309 
310 typedef struct zone {
311 	/*
312 	 * zone_name is never modified once set.
313 	 */
314 	char		*zone_name;	/* zone's configuration name */
315 	/*
316 	 * zone_nodename and zone_domain are never freed once allocated.
317 	 */
318 	char		*zone_nodename;	/* utsname.nodename equivalent */
319 	char		*zone_domain;	/* srpc_domain equivalent */
320 	/*
321 	 * zone_hostid is used for per-zone hostid emulation.
322 	 * Currently it isn't modified after it's set (so no locks protect
323 	 * accesses), but that might have to change when we allow
324 	 * administrators to change running zones' properties.
325 	 *
326 	 * The global zone's zone_hostid must always be HW_INVALID_HOSTID so
327 	 * that zone_get_hostid() will function correctly.
328 	 */
329 	uint32_t	zone_hostid;	/* zone's hostid, HW_INVALID_HOSTID */
330 					/* if not emulated */
331 	/*
332 	 * zone_lock protects the following fields of a zone_t:
333 	 * 	zone_ref
334 	 * 	zone_cred_ref
335 	 * 	zone_ntasks
336 	 * 	zone_flags
337 	 * 	zone_zsd
338 	 *	zone_pfexecd
339 	 */
340 	kmutex_t	zone_lock;
341 	/*
342 	 * zone_linkage is the zone's linkage into the active or
343 	 * death-row list.  The field is protected by zonehash_lock.
344 	 */
345 	list_node_t	zone_linkage;
346 	zoneid_t	zone_id;	/* ID of zone */
347 	uint_t		zone_ref;	/* count of zone_hold()s on zone */
348 	uint_t		zone_cred_ref;	/* count of zone_hold_cred()s on zone */
349 	/*
350 	 * zone_rootvp and zone_rootpath can never be modified once set.
351 	 */
352 	struct vnode	*zone_rootvp;	/* zone's root vnode */
353 	char		*zone_rootpath;	/* Path to zone's root + '/' */
354 	ushort_t	zone_flags;	/* misc flags */
355 	zone_status_t	zone_status;	/* protected by zone_status_lock */
356 	uint_t		zone_ntasks;	/* number of tasks executing in zone */
357 	kmutex_t	zone_nlwps_lock; /* protects zone_nlwps, and *_nlwps */
358 					/* counters in projects and tasks */
359 					/* that are within the zone */
360 	rctl_qty_t	zone_nlwps;	/* number of lwps in zone */
361 	rctl_qty_t	zone_nlwps_ctl; /* protected by zone_rctls->rcs_lock */
362 	rctl_qty_t	zone_shmmax;	/* System V shared memory usage */
363 	ipc_rqty_t	zone_ipc;	/* System V IPC id resource usage */
364 
365 	uint_t		zone_rootpathlen; /* strlen(zone_rootpath) + 1 */
366 	uint32_t	zone_shares;	/* FSS shares allocated to zone */
367 	rctl_set_t	*zone_rctls;	/* zone-wide (zone.*) rctls */
368 	kmutex_t	zone_mem_lock;	/* protects zone_locked_mem and */
369 					/* kpd_locked_mem for all */
370 					/* projects in zone. */
371 					/* Also protects zone_max_swap */
372 					/* grab after p_lock, before rcs_lock */
373 	rctl_qty_t	zone_locked_mem;	/* bytes of locked memory in */
374 						/* zone */
375 	rctl_qty_t	zone_locked_mem_ctl;	/* Current locked memory */
376 						/* limit.  Protected by */
377 						/* zone_rctls->rcs_lock */
378 	rctl_qty_t	zone_max_swap; /* bytes of swap reserved by zone */
379 	rctl_qty_t	zone_max_swap_ctl;	/* current swap limit. */
380 						/* Protected by */
381 						/* zone_rctls->rcs_lock */
382 	list_t		zone_zsd;	/* list of Zone-Specific Data values */
383 	kcondvar_t	zone_cv;	/* used to signal state changes */
384 	struct proc	*zone_zsched;	/* Dummy kernel "zsched" process */
385 	pid_t		zone_proc_initpid; /* pid of "init" for this zone */
386 	char		*zone_initname;	/* fs path to 'init' */
387 	int		zone_boot_err;  /* for zone_boot() if boot fails */
388 	char		*zone_bootargs;	/* arguments passed via zone_boot() */
389 	uint64_t	zone_phys_mcap;	/* physical memory cap */
390 	/*
391 	 * zone_kthreads is protected by zone_status_lock.
392 	 */
393 	kthread_t	*zone_kthreads;	/* kernel threads in zone */
394 	struct priv_set	*zone_privset;	/* limit set for zone */
395 	/*
396 	 * zone_vfslist is protected by vfs_list_lock().
397 	 */
398 	struct vfs	*zone_vfslist;	/* list of FS's mounted in zone */
399 	uint64_t	zone_uniqid;	/* unique zone generation number */
400 	struct cred	*zone_kcred;	/* kcred-like, zone-limited cred */
401 	/*
402 	 * zone_pool is protected by pool_lock().
403 	 */
404 	struct pool	*zone_pool;	/* pool the zone is bound to */
405 	hrtime_t	zone_pool_mod;	/* last pool bind modification time */
406 	/* zone_psetid is protected by cpu_lock */
407 	psetid_t	zone_psetid;	/* pset the zone is bound to */
408 	/*
409 	 * The following two can be read without holding any locks.  They are
410 	 * updated under cpu_lock.
411 	 */
412 	int		zone_ncpus;  /* zone's idea of ncpus */
413 	int		zone_ncpus_online; /* zone's idea of ncpus_online */
414 	/*
415 	 * List of ZFS datasets exported to this zone.
416 	 */
417 	list_t		zone_datasets;	/* list of datasets */
418 
419 	ts_label_t	*zone_slabel;	/* zone sensitivity label */
420 	int		zone_match;	/* require label match for packets */
421 	tsol_mlp_list_t zone_mlps;	/* MLPs on zone-private addresses */
422 
423 	boolean_t	zone_restart_init;	/* Restart init if it dies? */
424 	struct brand	*zone_brand;		/* zone's brand */
425 	void 		*zone_brand_data;	/* store brand specific data */
426 	id_t		zone_defaultcid;	/* dflt scheduling class id */
427 	kstat_t		*zone_swapresv_kstat;
428 	kstat_t		*zone_lockedmem_kstat;
429 	/*
430 	 * zone_dl_list is protected by zone_lock
431 	 */
432 	list_t		zone_dl_list;
433 	netstack_t	*zone_netstack;
434 	struct cpucap	*zone_cpucap;	/* CPU caps data */
435 	/*
436 	 * Solaris Auditing per-zone audit context
437 	 */
438 	struct au_kcontext	*zone_audit_kctxt;
439 	/*
440 	 * For private use by mntfs.
441 	 */
442 	struct mntelem	*zone_mntfs_db;
443 	krwlock_t	zone_mntfs_db_lock;
444 
445 	struct klpd_reg		*zone_pfexecd;
446 } zone_t;
447 
448 /*
449  * Special value of zone_psetid to indicate that pools are disabled.
450  */
451 #define	ZONE_PS_INVAL	PS_MYID
452 
453 
454 extern zone_t zone0;
455 extern zone_t *global_zone;
456 extern uint_t maxzones;
457 extern rctl_hndl_t rc_zone_nlwps;
458 
459 extern long zone(int, void *, void *, void *, void *);
460 extern void zone_zsd_init(void);
461 extern void zone_init(void);
462 extern void zone_hold(zone_t *);
463 extern void zone_rele(zone_t *);
464 extern void zone_cred_hold(zone_t *);
465 extern void zone_cred_rele(zone_t *);
466 extern void zone_task_hold(zone_t *);
467 extern void zone_task_rele(zone_t *);
468 extern zone_t *zone_find_by_id(zoneid_t);
469 extern zone_t *zone_find_by_label(const ts_label_t *);
470 extern zone_t *zone_find_by_name(char *);
471 extern zone_t *zone_find_by_any_path(const char *, boolean_t);
472 extern zone_t *zone_find_by_path(const char *);
473 extern zoneid_t getzoneid(void);
474 extern zone_t *zone_find_by_id_nolock(zoneid_t);
475 extern int zone_datalink_walk(zoneid_t, int (*)(datalink_id_t, void *), void *);
476 extern int zone_check_datalink(zoneid_t *, datalink_id_t);
477 
478 /*
479  * Zone-specific data (ZSD) APIs
480  */
481 /*
482  * The following is what code should be initializing its zone_key_t to if it
483  * calls zone_getspecific() without necessarily knowing that zone_key_create()
484  * has been called on the key.
485  */
486 #define	ZONE_KEY_UNINITIALIZED	0
487 
488 typedef uint_t zone_key_t;
489 
490 extern void	zone_key_create(zone_key_t *, void *(*)(zoneid_t),
491     void (*)(zoneid_t, void *), void (*)(zoneid_t, void *));
492 extern int 	zone_key_delete(zone_key_t);
493 extern void	*zone_getspecific(zone_key_t, zone_t *);
494 extern int	zone_setspecific(zone_key_t, zone_t *, const void *);
495 
496 /*
497  * The definition of a zsd_entry is truly private to zone.c and is only
498  * placed here so it can be shared with mdb.
499  *
500  * State maintained for each zone times each registered key, which tracks
501  * the state of the create, shutdown and destroy callbacks.
502  *
503  * zsd_flags is used to keep track of pending actions to avoid holding locks
504  * when calling the create/shutdown/destroy callbacks, since doing so
505  * could lead to deadlocks.
506  */
507 struct zsd_entry {
508 	zone_key_t		zsd_key;	/* Key used to lookup value */
509 	void			*zsd_data;	/* Caller-managed value */
510 	/*
511 	 * Callbacks to be executed when a zone is created, shutdown, and
512 	 * destroyed, respectively.
513 	 */
514 	void			*(*zsd_create)(zoneid_t);
515 	void			(*zsd_shutdown)(zoneid_t, void *);
516 	void			(*zsd_destroy)(zoneid_t, void *);
517 	list_node_t		zsd_linkage;
518 	uint16_t 		zsd_flags;	/* See below */
519 	kcondvar_t		zsd_cv;
520 };
521 
522 /*
523  * zsd_flags
524  */
525 #define	ZSD_CREATE_NEEDED	0x0001
526 #define	ZSD_CREATE_INPROGRESS	0x0002
527 #define	ZSD_CREATE_COMPLETED	0x0004
528 #define	ZSD_SHUTDOWN_NEEDED	0x0010
529 #define	ZSD_SHUTDOWN_INPROGRESS	0x0020
530 #define	ZSD_SHUTDOWN_COMPLETED	0x0040
531 #define	ZSD_DESTROY_NEEDED	0x0100
532 #define	ZSD_DESTROY_INPROGRESS	0x0200
533 #define	ZSD_DESTROY_COMPLETED	0x0400
534 
535 #define	ZSD_CREATE_ALL	\
536 	(ZSD_CREATE_NEEDED|ZSD_CREATE_INPROGRESS|ZSD_CREATE_COMPLETED)
537 #define	ZSD_SHUTDOWN_ALL	\
538 	(ZSD_SHUTDOWN_NEEDED|ZSD_SHUTDOWN_INPROGRESS|ZSD_SHUTDOWN_COMPLETED)
539 #define	ZSD_DESTROY_ALL	\
540 	(ZSD_DESTROY_NEEDED|ZSD_DESTROY_INPROGRESS|ZSD_DESTROY_COMPLETED)
541 
542 #define	ZSD_ALL_INPROGRESS \
543 	(ZSD_CREATE_INPROGRESS|ZSD_SHUTDOWN_INPROGRESS|ZSD_DESTROY_INPROGRESS)
544 
545 /*
546  * Macros to help with zone visibility restrictions.
547  */
548 
549 /*
550  * Is process in the global zone?
551  */
552 #define	INGLOBALZONE(p) \
553 	((p)->p_zone == global_zone)
554 
555 /*
556  * Can process view objects in given zone?
557  */
558 #define	HASZONEACCESS(p, zoneid) \
559 	((p)->p_zone->zone_id == (zoneid) || INGLOBALZONE(p))
560 
561 /*
562  * Convenience macro to see if a resolved path is visible from within a
563  * given zone.
564  *
565  * The basic idea is that the first (zone_rootpathlen - 1) bytes of the
566  * two strings must be equal.  Since the rootpathlen has a trailing '/',
567  * we want to skip everything in the path up to (but not including) the
568  * trailing '/'.
569  */
570 #define	ZONE_PATH_VISIBLE(path, zone) \
571 	(strncmp((path), (zone)->zone_rootpath,		\
572 	    (zone)->zone_rootpathlen - 1) == 0)
573 
574 /*
575  * Convenience macro to go from the global view of a path to that seen
576  * from within said zone.  It is the responsibility of the caller to
577  * ensure that the path is a resolved one (ie, no '..'s or '.'s), and is
578  * in fact visible from within the zone.
579  */
580 #define	ZONE_PATH_TRANSLATE(path, zone)	\
581 	(ASSERT(ZONE_PATH_VISIBLE(path, zone)),	\
582 	(path) + (zone)->zone_rootpathlen - 2)
583 
584 /*
585  * Special processes visible in all zones.
586  */
587 #define	ZONE_SPECIALPID(x)	 ((x) == 0 || (x) == 1)
588 
589 /*
590  * Zone-safe version of thread_create() to be used when the caller wants to
591  * create a kernel thread to run within the current zone's context.
592  */
593 extern kthread_t *zthread_create(caddr_t, size_t, void (*)(), void *, size_t,
594     pri_t);
595 extern void zthread_exit(void);
596 
597 /*
598  * Functions for an external observer to register interest in a zone's status
599  * change.  Observers will be woken up when the zone status equals the status
600  * argument passed in (in the case of zone_status_timedwait, the function may
601  * also return because of a timeout; zone_status_wait_sig may return early due
602  * to a signal being delivered; zone_status_timedwait_sig may return for any of
603  * the above reasons).
604  *
605  * Otherwise these behave identically to cv_timedwait(), cv_wait(), and
606  * cv_wait_sig() respectively.
607  */
608 extern clock_t zone_status_timedwait(zone_t *, clock_t, zone_status_t);
609 extern clock_t zone_status_timedwait_sig(zone_t *, clock_t, zone_status_t);
610 extern void zone_status_wait(zone_t *, zone_status_t);
611 extern int zone_status_wait_sig(zone_t *, zone_status_t);
612 
613 /*
614  * Get the status  of the zone (at the time it was called).  The state may
615  * have progressed by the time it is returned.
616  */
617 extern zone_status_t zone_status_get(zone_t *);
618 
619 /*
620  * Safely get the hostid of the specified zone (defaults to machine's hostid
621  * if the specified zone doesn't emulate a hostid).  Passing NULL retrieves
622  * the global zone's (i.e., physical system's) hostid.
623  */
624 extern uint32_t zone_get_hostid(zone_t *);
625 
626 /*
627  * Get the "kcred" credentials corresponding to the given zone.
628  */
629 extern struct cred *zone_get_kcred(zoneid_t);
630 
631 /*
632  * Get/set the pool the zone is currently bound to.
633  */
634 extern struct pool *zone_pool_get(zone_t *);
635 extern void zone_pool_set(zone_t *, struct pool *);
636 
637 /*
638  * Get/set the pset the zone is currently using.
639  */
640 extern psetid_t zone_pset_get(zone_t *);
641 extern void zone_pset_set(zone_t *, psetid_t);
642 
643 /*
644  * Get the number of cpus/online-cpus visible from the given zone.
645  */
646 extern int zone_ncpus_get(zone_t *);
647 extern int zone_ncpus_online_get(zone_t *);
648 
649 /*
650  * Returns true if the named pool/dataset is visible in the current zone.
651  */
652 extern int zone_dataset_visible(const char *, int *);
653 
654 /*
655  * zone version of kadmin()
656  */
657 extern int zone_kadmin(int, int, const char *, cred_t *);
658 extern void zone_shutdown_global(void);
659 
660 extern void mount_in_progress(void);
661 extern void mount_completed(void);
662 
663 extern int zone_walk(int (*)(zone_t *, void *), void *);
664 
665 extern rctl_hndl_t rc_zone_locked_mem;
666 extern rctl_hndl_t rc_zone_max_swap;
667 
668 #endif	/* _KERNEL */
669 
670 #ifdef	__cplusplus
671 }
672 #endif
673 
674 #endif	/* _SYS_ZONE_H */
675