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