xref: /illumos-gate/usr/src/uts/common/sys/zone.h (revision 86ad481c)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
545916cd2Sjpk  * Common Development and Distribution License (the "License").
645916cd2Sjpk  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
22134a1f4eSCasper H.S. Dik  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
237c478bd9Sstevel@tonic-gate  */
247c478bd9Sstevel@tonic-gate 
257c478bd9Sstevel@tonic-gate #ifndef _SYS_ZONE_H
267c478bd9Sstevel@tonic-gate #define	_SYS_ZONE_H
277c478bd9Sstevel@tonic-gate 
287c478bd9Sstevel@tonic-gate #include <sys/types.h>
297c478bd9Sstevel@tonic-gate #include <sys/mutex.h>
307c478bd9Sstevel@tonic-gate #include <sys/param.h>
317c478bd9Sstevel@tonic-gate #include <sys/rctl.h>
32824c205fSml #include <sys/ipc_rctl.h>
337c478bd9Sstevel@tonic-gate #include <sys/pset.h>
3445916cd2Sjpk #include <sys/tsol/label.h>
35f4b3ec61Sdh #include <sys/cred.h>
36f4b3ec61Sdh #include <sys/netstack.h>
373f2f09c1Sdp #include <sys/uadmin.h>
38835ee219SRobert Harris #include <sys/ksynch.h>
39550b6e40SSowmini Varadhan #include <sys/socket_impl.h>
40550b6e40SSowmini Varadhan #include <netinet/in.h>
417c478bd9Sstevel@tonic-gate 
427c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
437c478bd9Sstevel@tonic-gate extern "C" {
447c478bd9Sstevel@tonic-gate #endif
457c478bd9Sstevel@tonic-gate 
467c478bd9Sstevel@tonic-gate /*
477c478bd9Sstevel@tonic-gate  * NOTE
487c478bd9Sstevel@tonic-gate  *
497c478bd9Sstevel@tonic-gate  * The contents of this file are private to the implementation of
507c478bd9Sstevel@tonic-gate  * Solaris and are subject to change at any time without notice.
517c478bd9Sstevel@tonic-gate  * Applications and drivers using these interfaces may fail to
527c478bd9Sstevel@tonic-gate  * run on future releases.
537c478bd9Sstevel@tonic-gate  */
547c478bd9Sstevel@tonic-gate 
557c478bd9Sstevel@tonic-gate /* Available both in kernel and for user space */
567c478bd9Sstevel@tonic-gate 
577c478bd9Sstevel@tonic-gate /* zone id restrictions and special ids */
587c478bd9Sstevel@tonic-gate #define	MAX_ZONEID	9999
597c478bd9Sstevel@tonic-gate #define	MIN_USERZONEID	1	/* lowest user-creatable zone ID */
607c478bd9Sstevel@tonic-gate #define	MIN_ZONEID	0	/* minimum zone ID on system */
617c478bd9Sstevel@tonic-gate #define	GLOBAL_ZONEID	0
627c478bd9Sstevel@tonic-gate #define	ZONEID_WIDTH	4	/* for printf */
637c478bd9Sstevel@tonic-gate 
6445916cd2Sjpk /*
6545916cd2Sjpk  * Special zoneid_t token to refer to all zones.
6645916cd2Sjpk  */
6745916cd2Sjpk #define	ALL_ZONES	(-1)
6845916cd2Sjpk 
697c478bd9Sstevel@tonic-gate /* system call subcodes */
70f4b3ec61Sdh #define	ZONE_CREATE		0
71f4b3ec61Sdh #define	ZONE_DESTROY		1
72f4b3ec61Sdh #define	ZONE_GETATTR		2
73f4b3ec61Sdh #define	ZONE_ENTER		3
74f4b3ec61Sdh #define	ZONE_LIST		4
75f4b3ec61Sdh #define	ZONE_SHUTDOWN		5
76f4b3ec61Sdh #define	ZONE_LOOKUP		6
77f4b3ec61Sdh #define	ZONE_BOOT		7
78f4b3ec61Sdh #define	ZONE_VERSION		8
79f4b3ec61Sdh #define	ZONE_SETATTR		9
80f4b3ec61Sdh #define	ZONE_ADD_DATALINK	10
81f4b3ec61Sdh #define	ZONE_DEL_DATALINK	11
82f4b3ec61Sdh #define	ZONE_CHECK_DATALINK	12
83f4b3ec61Sdh #define	ZONE_LIST_DATALINK	13
847c478bd9Sstevel@tonic-gate 
857c478bd9Sstevel@tonic-gate /* zone attributes */
867c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_ROOT		1
877c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_NAME		2
887c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_STATUS	3
897c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_PRIVSET	4
907c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_UNIQID	5
917c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_POOLID	6
927c478bd9Sstevel@tonic-gate #define	ZONE_ATTR_INITPID	7
9345916cd2Sjpk #define	ZONE_ATTR_SLBL		8
943f2f09c1Sdp #define	ZONE_ATTR_INITNAME	9
953f2f09c1Sdp #define	ZONE_ATTR_BOOTARGS	10
969acbbeafSnn #define	ZONE_ATTR_BRAND		11
970209230bSgjelinek #define	ZONE_ATTR_PHYS_MCAP	12
980209230bSgjelinek #define	ZONE_ATTR_SCHED_CLASS	13
99f4b3ec61Sdh #define	ZONE_ATTR_FLAGS		14
1005679c89fSjv #define	ZONE_ATTR_HOSTID	15
1010fbb751dSJohn Levon #define	ZONE_ATTR_FS_ALLOWED	16
102550b6e40SSowmini Varadhan #define	ZONE_ATTR_NETWORK	17
1039acbbeafSnn 
1049acbbeafSnn /* Start of the brand-specific attribute namespace */
1059acbbeafSnn #define	ZONE_ATTR_BRAND_ATTRS	32768
1067c478bd9Sstevel@tonic-gate 
1070fbb751dSJohn Levon #define	ZONE_FS_ALLOWED_MAX	1024
1080fbb751dSJohn Levon 
109cf8f45c7Sdstaff #define	ZONE_EVENT_CHANNEL	"com.sun:zones:status"
110cf8f45c7Sdstaff #define	ZONE_EVENT_STATUS_CLASS	"status"
111cf8f45c7Sdstaff #define	ZONE_EVENT_STATUS_SUBCLASS	"change"
112cf8f45c7Sdstaff 
113cf8f45c7Sdstaff #define	ZONE_EVENT_UNINITIALIZED	"uninitialized"
114bd41d0a8Snordmark #define	ZONE_EVENT_INITIALIZED		"initialized"
115cf8f45c7Sdstaff #define	ZONE_EVENT_READY		"ready"
116cf8f45c7Sdstaff #define	ZONE_EVENT_RUNNING		"running"
117cf8f45c7Sdstaff #define	ZONE_EVENT_SHUTTING_DOWN	"shutting_down"
118cf8f45c7Sdstaff 
119cf8f45c7Sdstaff #define	ZONE_CB_NAME		"zonename"
120cf8f45c7Sdstaff #define	ZONE_CB_NEWSTATE	"newstate"
121cf8f45c7Sdstaff #define	ZONE_CB_OLDSTATE	"oldstate"
122cf8f45c7Sdstaff #define	ZONE_CB_TIMESTAMP	"when"
123cf8f45c7Sdstaff #define	ZONE_CB_ZONEID		"zoneid"
124cf8f45c7Sdstaff 
1259acbbeafSnn /*
1269acbbeafSnn  * Exit values that may be returned by scripts or programs invoked by various
1279acbbeafSnn  * zone commands.
1289acbbeafSnn  *
1299acbbeafSnn  * These are defined as:
1309acbbeafSnn  *
1319acbbeafSnn  *	ZONE_SUBPROC_OK
1329acbbeafSnn  *	===============
1339acbbeafSnn  *	The subprocess completed successfully.
1349acbbeafSnn  *
1359acbbeafSnn  *	ZONE_SUBPROC_USAGE
1369acbbeafSnn  *	==================
1379acbbeafSnn  *	The subprocess failed with a usage message, or a usage message should
1389acbbeafSnn  *	be output in its behalf.
1399acbbeafSnn  *
1409acbbeafSnn  *	ZONE_SUBPROC_NOTCOMPLETE
1419acbbeafSnn  *	========================
1429acbbeafSnn  *	The subprocess did not complete, but the actions performed by the
1439acbbeafSnn  *	subprocess require no recovery actions by the user.
1449acbbeafSnn  *
1459acbbeafSnn  *	For example, if the subprocess were called by "zoneadm install," the
1469acbbeafSnn  *	installation of the zone did not succeed but the user need not perform
1479acbbeafSnn  *	a "zoneadm uninstall" before attempting another install.
1489acbbeafSnn  *
1499acbbeafSnn  *	ZONE_SUBPROC_FATAL
1509acbbeafSnn  *	==================
1519acbbeafSnn  *	The subprocess failed in a fatal manner, usually one that will require
1529acbbeafSnn  *	some type of recovery action by the user.
1539acbbeafSnn  *
1549acbbeafSnn  *	For example, if the subprocess were called by "zoneadm install," the
1559acbbeafSnn  *	installation of the zone did not succeed and the user will need to
1569acbbeafSnn  *	perform a "zoneadm uninstall" before another install attempt is
1579acbbeafSnn  *	possible.
1589acbbeafSnn  *
1599acbbeafSnn  *	The non-success exit values are large to avoid accidental collision
1609acbbeafSnn  *	with values used internally by some commands (e.g. "Z_ERR" and
1619acbbeafSnn  *	"Z_USAGE" as used by zoneadm.)
1629acbbeafSnn  */
1639acbbeafSnn #define	ZONE_SUBPROC_OK			0
1649acbbeafSnn #define	ZONE_SUBPROC_USAGE		253
1659acbbeafSnn #define	ZONE_SUBPROC_NOTCOMPLETE	254
1669acbbeafSnn #define	ZONE_SUBPROC_FATAL		255
1679acbbeafSnn 
1687c478bd9Sstevel@tonic-gate #ifdef _SYSCALL32
1697c478bd9Sstevel@tonic-gate typedef struct {
1707c478bd9Sstevel@tonic-gate 	caddr32_t zone_name;
1717c478bd9Sstevel@tonic-gate 	caddr32_t zone_root;
1727c478bd9Sstevel@tonic-gate 	caddr32_t zone_privs;
173821c4a97Sdp 	size32_t zone_privssz;
1747c478bd9Sstevel@tonic-gate 	caddr32_t rctlbuf;
1757c478bd9Sstevel@tonic-gate 	size32_t rctlbufsz;
1767c478bd9Sstevel@tonic-gate 	caddr32_t extended_error;
177fa9e4066Sahrens 	caddr32_t zfsbuf;
178fa9e4066Sahrens 	size32_t  zfsbufsz;
17942bc57c4Srica 	int match;			/* match level */
18042bc57c4Srica 	uint32_t doi;			/* DOI for label */
18142bc57c4Srica 	caddr32_t label;		/* label associated with zone */
182f4b3ec61Sdh 	int flags;
1837c478bd9Sstevel@tonic-gate } zone_def32;
1847c478bd9Sstevel@tonic-gate #endif
1857c478bd9Sstevel@tonic-gate typedef struct {
1867c478bd9Sstevel@tonic-gate 	const char *zone_name;
1877c478bd9Sstevel@tonic-gate 	const char *zone_root;
1887c478bd9Sstevel@tonic-gate 	const struct priv_set *zone_privs;
189821c4a97Sdp 	size_t zone_privssz;
1907c478bd9Sstevel@tonic-gate 	const char *rctlbuf;
1917c478bd9Sstevel@tonic-gate 	size_t rctlbufsz;
1927c478bd9Sstevel@tonic-gate 	int *extended_error;
193fa9e4066Sahrens 	const char *zfsbuf;
194fa9e4066Sahrens 	size_t zfsbufsz;
19545916cd2Sjpk 	int match;			/* match level */
19642bc57c4Srica 	uint32_t doi;			/* DOI for label */
19745916cd2Sjpk 	const bslabel_t *label;		/* label associated with zone */
198f4b3ec61Sdh 	int flags;
1997c478bd9Sstevel@tonic-gate } zone_def;
2007c478bd9Sstevel@tonic-gate 
2017c478bd9Sstevel@tonic-gate /* extended error information */
2027c478bd9Sstevel@tonic-gate #define	ZE_UNKNOWN	0	/* No extended error info */
2037c478bd9Sstevel@tonic-gate #define	ZE_CHROOTED	1	/* tried to zone_create from chroot */
2047c478bd9Sstevel@tonic-gate #define	ZE_AREMOUNTS	2	/* there are mounts within the zone */
2058c55461bSton #define	ZE_LABELINUSE	3	/* label is already in use by some other zone */
2067c478bd9Sstevel@tonic-gate 
207a19609f8Sjv /*
208a19609f8Sjv  * zone_status values
209a19609f8Sjv  *
210a19609f8Sjv  * You must modify zone_status_names in mdb(1M)'s genunix module
211a19609f8Sjv  * (genunix/zone.c) when you modify this enum.
212a19609f8Sjv  */
2137c478bd9Sstevel@tonic-gate typedef enum {
2147c478bd9Sstevel@tonic-gate 	ZONE_IS_UNINITIALIZED = 0,
215bd41d0a8Snordmark 	ZONE_IS_INITIALIZED,
2167c478bd9Sstevel@tonic-gate 	ZONE_IS_READY,
2177c478bd9Sstevel@tonic-gate 	ZONE_IS_BOOTING,
2187c478bd9Sstevel@tonic-gate 	ZONE_IS_RUNNING,
2197c478bd9Sstevel@tonic-gate 	ZONE_IS_SHUTTING_DOWN,
2207c478bd9Sstevel@tonic-gate 	ZONE_IS_EMPTY,
2217c478bd9Sstevel@tonic-gate 	ZONE_IS_DOWN,
2227c478bd9Sstevel@tonic-gate 	ZONE_IS_DYING,
2237c478bd9Sstevel@tonic-gate 	ZONE_IS_DEAD
2247c478bd9Sstevel@tonic-gate } zone_status_t;
2257c478bd9Sstevel@tonic-gate #define	ZONE_MIN_STATE		ZONE_IS_UNINITIALIZED
2267c478bd9Sstevel@tonic-gate #define	ZONE_MAX_STATE		ZONE_IS_DEAD
2277c478bd9Sstevel@tonic-gate 
2287c478bd9Sstevel@tonic-gate /*
2297c478bd9Sstevel@tonic-gate  * Valid commands which may be issued by zoneadm to zoneadmd.  The kernel also
2307c478bd9Sstevel@tonic-gate  * communicates with zoneadmd, but only uses Z_REBOOT and Z_HALT.
2317c478bd9Sstevel@tonic-gate  */
2327c478bd9Sstevel@tonic-gate typedef enum zone_cmd {
2339acbbeafSnn 	Z_READY, Z_BOOT, Z_FORCEBOOT, Z_REBOOT, Z_HALT, Z_NOTE_UNINSTALLING,
2349acbbeafSnn 	Z_MOUNT, Z_FORCEMOUNT, Z_UNMOUNT
2357c478bd9Sstevel@tonic-gate } zone_cmd_t;
2367c478bd9Sstevel@tonic-gate 
2377c478bd9Sstevel@tonic-gate /*
2387c478bd9Sstevel@tonic-gate  * The structure of a request to zoneadmd.
2397c478bd9Sstevel@tonic-gate  */
2407c478bd9Sstevel@tonic-gate typedef struct zone_cmd_arg {
2417c478bd9Sstevel@tonic-gate 	uint64_t	uniqid;		/* unique "generation number" */
2427c478bd9Sstevel@tonic-gate 	zone_cmd_t	cmd;		/* requested action */
2433f2f09c1Sdp 	uint32_t	_pad;		/* need consistent 32/64 bit alignmt */
2447c478bd9Sstevel@tonic-gate 	char locale[MAXPATHLEN];	/* locale in which to render messages */
2453f2f09c1Sdp 	char bootbuf[BOOTARGS_MAX];	/* arguments passed to zone_boot() */
2467c478bd9Sstevel@tonic-gate } zone_cmd_arg_t;
2477c478bd9Sstevel@tonic-gate 
2487c478bd9Sstevel@tonic-gate /*
2497c478bd9Sstevel@tonic-gate  * Structure of zoneadmd's response to a request.  A NULL return value means
2507c478bd9Sstevel@tonic-gate  * the caller should attempt to restart zoneadmd and retry.
2517c478bd9Sstevel@tonic-gate  */
2527c478bd9Sstevel@tonic-gate typedef struct zone_cmd_rval {
2537c478bd9Sstevel@tonic-gate 	int rval;			/* return value of request */
2547c478bd9Sstevel@tonic-gate 	char errbuf[1];	/* variable-sized buffer containing error messages */
2557c478bd9Sstevel@tonic-gate } zone_cmd_rval_t;
2567c478bd9Sstevel@tonic-gate 
2577c478bd9Sstevel@tonic-gate /*
2587c478bd9Sstevel@tonic-gate  * The zone support infrastructure uses the zone name as a component
2597c478bd9Sstevel@tonic-gate  * of unix domain (AF_UNIX) sockets, which are limited to 108 characters
2607c478bd9Sstevel@tonic-gate  * in length, so ZONENAME_MAX is limited by that.
2617c478bd9Sstevel@tonic-gate  */
2627c478bd9Sstevel@tonic-gate #define	ZONENAME_MAX		64
2637c478bd9Sstevel@tonic-gate 
2647c478bd9Sstevel@tonic-gate #define	GLOBAL_ZONENAME		"global"
2657c478bd9Sstevel@tonic-gate 
2667c478bd9Sstevel@tonic-gate /*
2677c478bd9Sstevel@tonic-gate  * Extended Regular expression (see regex(5)) which matches all valid zone
2687c478bd9Sstevel@tonic-gate  * names.
2697c478bd9Sstevel@tonic-gate  */
2707c478bd9Sstevel@tonic-gate #define	ZONENAME_REGEXP		"[a-zA-Z0-9][-_.a-zA-Z0-9]{0,62}"
2717c478bd9Sstevel@tonic-gate 
2727c478bd9Sstevel@tonic-gate /*
2737c478bd9Sstevel@tonic-gate  * Where the zones support infrastructure places temporary files.
2747c478bd9Sstevel@tonic-gate  */
2757c478bd9Sstevel@tonic-gate #define	ZONES_TMPDIR		"/var/run/zones"
2767c478bd9Sstevel@tonic-gate 
2777c478bd9Sstevel@tonic-gate /*
2787c478bd9Sstevel@tonic-gate  * The path to the door used by clients to communicate with zoneadmd.
2797c478bd9Sstevel@tonic-gate  */
2807c478bd9Sstevel@tonic-gate #define	ZONE_DOOR_PATH		ZONES_TMPDIR "/%s.zoneadmd_door"
2817c478bd9Sstevel@tonic-gate 
282a19609f8Sjv 
283f4b3ec61Sdh /* zone_flags */
284a19609f8Sjv /*
285a19609f8Sjv  * Threads that read or write the following flag must hold zone_lock.
286a19609f8Sjv  */
287a19609f8Sjv #define	ZF_REFCOUNTS_LOGGED	0x1	/* a thread logged the zone's refs */
288a19609f8Sjv 
289a19609f8Sjv /*
290a19609f8Sjv  * The following threads are set when the zone is created and never changed.
291a19609f8Sjv  * Threads that test for these flags don't have to hold zone_lock.
292a19609f8Sjv  */
293f4b3ec61Sdh #define	ZF_HASHED_LABEL		0x2	/* zone has a unique label */
294f4b3ec61Sdh #define	ZF_IS_SCRATCH		0x4	/* scratch zone */
295f4b3ec61Sdh #define	ZF_NET_EXCL		0x8	/* Zone has an exclusive IP stack */
296f4b3ec61Sdh 
297a19609f8Sjv 
298f4b3ec61Sdh /* zone_create flags */
299f4b3ec61Sdh #define	ZCF_NET_EXCL		0x1	/* Create a zone with exclusive IP */
300f4b3ec61Sdh 
301550b6e40SSowmini Varadhan /* zone network properties */
302550b6e40SSowmini Varadhan #define	ZONE_NETWORK_ADDRESS	1
303550b6e40SSowmini Varadhan #define	ZONE_NETWORK_DEFROUTER	2
304550b6e40SSowmini Varadhan 
305550b6e40SSowmini Varadhan #define	ZONE_NET_ADDRNAME	"address"
306550b6e40SSowmini Varadhan #define	ZONE_NET_RTRNAME	"route"
307550b6e40SSowmini Varadhan 
308550b6e40SSowmini Varadhan typedef struct zone_net_data {
309550b6e40SSowmini Varadhan 	int zn_type;
310550b6e40SSowmini Varadhan 	int zn_len;
311550b6e40SSowmini Varadhan 	datalink_id_t zn_linkid;
312550b6e40SSowmini Varadhan 	uint8_t zn_val[1];
313550b6e40SSowmini Varadhan } zone_net_data_t;
314550b6e40SSowmini Varadhan 
315550b6e40SSowmini Varadhan 
3167c478bd9Sstevel@tonic-gate #ifdef _KERNEL
317a19609f8Sjv 
3187c478bd9Sstevel@tonic-gate /*
3197c478bd9Sstevel@tonic-gate  * We need to protect the definition of 'list_t' from userland applications and
3207c478bd9Sstevel@tonic-gate  * libraries which may be defining ther own versions.
3217c478bd9Sstevel@tonic-gate  */
3227c478bd9Sstevel@tonic-gate #include <sys/list.h>
3237c478bd9Sstevel@tonic-gate 
3247c478bd9Sstevel@tonic-gate #define	GLOBAL_ZONEUNIQID	0	/* uniqid of the global zone */
3257c478bd9Sstevel@tonic-gate 
3267c478bd9Sstevel@tonic-gate struct pool;
3279acbbeafSnn struct brand;
3287c478bd9Sstevel@tonic-gate 
329a19609f8Sjv /*
330a19609f8Sjv  * Each of these constants identifies a kernel subsystem that acquires and
331a19609f8Sjv  * releases zone references.  Each subsystem that invokes
332a19609f8Sjv  * zone_hold_ref() and zone_rele_ref() should specify the
333a19609f8Sjv  * zone_ref_subsys_t constant associated with the subsystem.  Tracked holds
334a19609f8Sjv  * help users and developers quickly identify subsystems that stall zone
335a19609f8Sjv  * shutdowns indefinitely.
336a19609f8Sjv  *
337a19609f8Sjv  * NOTE: You must modify zone_ref_subsys_names in usr/src/uts/common/os/zone.c
338a19609f8Sjv  * when you modify this enumeration.
339a19609f8Sjv  */
340a19609f8Sjv typedef enum zone_ref_subsys {
341a19609f8Sjv 	ZONE_REF_NFS,			/* NFS */
342a19609f8Sjv 	ZONE_REF_NFSV4,			/* NFSv4 */
343a19609f8Sjv 	ZONE_REF_SMBFS,			/* SMBFS */
344a19609f8Sjv 	ZONE_REF_MNTFS,			/* MNTFS */
345a19609f8Sjv 	ZONE_REF_LOFI,			/* LOFI devices */
346a19609f8Sjv 	ZONE_REF_VFS,			/* VFS infrastructure */
347a19609f8Sjv 	ZONE_REF_IPC,			/* IPC infrastructure */
348a19609f8Sjv 	ZONE_REF_NUM_SUBSYS		/* This must be the last entry. */
349a19609f8Sjv } zone_ref_subsys_t;
350a19609f8Sjv 
351a19609f8Sjv /*
352a19609f8Sjv  * zone_ref represents a general-purpose references to a zone.  Each zone's
353a19609f8Sjv  * references are linked into the zone's zone_t::zone_ref_list.  This allows
354a19609f8Sjv  * debuggers to walk zones' references.
355a19609f8Sjv  */
356a19609f8Sjv typedef struct zone_ref {
357a19609f8Sjv 	struct zone	*zref_zone; /* the zone to which the reference refers */
358a19609f8Sjv 	list_node_t	zref_linkage; /* linkage for zone_t::zone_ref_list */
359a19609f8Sjv } zone_ref_t;
360a19609f8Sjv 
361fa9e4066Sahrens /*
362fa9e4066Sahrens  * Structure to record list of ZFS datasets exported to a zone.
363fa9e4066Sahrens  */
364fa9e4066Sahrens typedef struct zone_dataset {
365fa9e4066Sahrens 	char		*zd_dataset;
366fa9e4066Sahrens 	list_node_t	zd_linkage;
367fa9e4066Sahrens } zone_dataset_t;
368fa9e4066Sahrens 
3690209230bSgjelinek /*
3700209230bSgjelinek  * structure for zone kstats
3710209230bSgjelinek  */
3720209230bSgjelinek typedef struct zone_kstat {
3730209230bSgjelinek 	kstat_named_t zk_zonename;
3740209230bSgjelinek 	kstat_named_t zk_usage;
3750209230bSgjelinek 	kstat_named_t zk_value;
3760209230bSgjelinek } zone_kstat_t;
3770209230bSgjelinek 
378c97ad5cdSakolb struct cpucap;
379c97ad5cdSakolb 
3807c478bd9Sstevel@tonic-gate typedef struct zone {
3817c478bd9Sstevel@tonic-gate 	/*
3827c478bd9Sstevel@tonic-gate 	 * zone_name is never modified once set.
3837c478bd9Sstevel@tonic-gate 	 */
3847c478bd9Sstevel@tonic-gate 	char		*zone_name;	/* zone's configuration name */
3857c478bd9Sstevel@tonic-gate 	/*
3867c478bd9Sstevel@tonic-gate 	 * zone_nodename and zone_domain are never freed once allocated.
3877c478bd9Sstevel@tonic-gate 	 */
3887c478bd9Sstevel@tonic-gate 	char		*zone_nodename;	/* utsname.nodename equivalent */
3897c478bd9Sstevel@tonic-gate 	char		*zone_domain;	/* srpc_domain equivalent */
3905679c89fSjv 	/*
3915679c89fSjv 	 * zone_hostid is used for per-zone hostid emulation.
3925679c89fSjv 	 * Currently it isn't modified after it's set (so no locks protect
3935679c89fSjv 	 * accesses), but that might have to change when we allow
3945679c89fSjv 	 * administrators to change running zones' properties.
3955679c89fSjv 	 *
3965679c89fSjv 	 * The global zone's zone_hostid must always be HW_INVALID_HOSTID so
3975679c89fSjv 	 * that zone_get_hostid() will function correctly.
3985679c89fSjv 	 */
3995679c89fSjv 	uint32_t	zone_hostid;	/* zone's hostid, HW_INVALID_HOSTID */
4005679c89fSjv 					/* if not emulated */
4017c478bd9Sstevel@tonic-gate 	/*
4027c478bd9Sstevel@tonic-gate 	 * zone_lock protects the following fields of a zone_t:
4037c478bd9Sstevel@tonic-gate 	 * 	zone_ref
4047c478bd9Sstevel@tonic-gate 	 * 	zone_cred_ref
405a19609f8Sjv 	 * 	zone_subsys_ref
406a19609f8Sjv 	 * 	zone_ref_list
4077c478bd9Sstevel@tonic-gate 	 * 	zone_ntasks
4087c478bd9Sstevel@tonic-gate 	 * 	zone_flags
4097c478bd9Sstevel@tonic-gate 	 * 	zone_zsd
410134a1f4eSCasper H.S. Dik 	 *	zone_pfexecd
4117c478bd9Sstevel@tonic-gate 	 */
4127c478bd9Sstevel@tonic-gate 	kmutex_t	zone_lock;
4137c478bd9Sstevel@tonic-gate 	/*
4147c478bd9Sstevel@tonic-gate 	 * zone_linkage is the zone's linkage into the active or
4157c478bd9Sstevel@tonic-gate 	 * death-row list.  The field is protected by zonehash_lock.
4167c478bd9Sstevel@tonic-gate 	 */
4177c478bd9Sstevel@tonic-gate 	list_node_t	zone_linkage;
4187c478bd9Sstevel@tonic-gate 	zoneid_t	zone_id;	/* ID of zone */
4197c478bd9Sstevel@tonic-gate 	uint_t		zone_ref;	/* count of zone_hold()s on zone */
4207c478bd9Sstevel@tonic-gate 	uint_t		zone_cred_ref;	/* count of zone_hold_cred()s on zone */
421a19609f8Sjv 	/*
422a19609f8Sjv 	 * Fixed-sized array of subsystem-specific reference counts
423a19609f8Sjv 	 * The sum of all of the counts must be less than or equal to zone_ref.
424a19609f8Sjv 	 * The array is indexed by the counts' subsystems' zone_ref_subsys_t
425a19609f8Sjv 	 * constants.
426a19609f8Sjv 	 */
427a19609f8Sjv 	uint_t		zone_subsys_ref[ZONE_REF_NUM_SUBSYS];
428a19609f8Sjv 	list_t		zone_ref_list;	/* list of zone_ref_t structs */
4297c478bd9Sstevel@tonic-gate 	/*
4307c478bd9Sstevel@tonic-gate 	 * zone_rootvp and zone_rootpath can never be modified once set.
4317c478bd9Sstevel@tonic-gate 	 */
4327c478bd9Sstevel@tonic-gate 	struct vnode	*zone_rootvp;	/* zone's root vnode */
4337c478bd9Sstevel@tonic-gate 	char		*zone_rootpath;	/* Path to zone's root + '/' */
4347c478bd9Sstevel@tonic-gate 	ushort_t	zone_flags;	/* misc flags */
4357c478bd9Sstevel@tonic-gate 	zone_status_t	zone_status;	/* protected by zone_status_lock */
4367c478bd9Sstevel@tonic-gate 	uint_t		zone_ntasks;	/* number of tasks executing in zone */
4377c478bd9Sstevel@tonic-gate 	kmutex_t	zone_nlwps_lock; /* protects zone_nlwps, and *_nlwps */
4387c478bd9Sstevel@tonic-gate 					/* counters in projects and tasks */
4397c478bd9Sstevel@tonic-gate 					/* that are within the zone */
4407c478bd9Sstevel@tonic-gate 	rctl_qty_t	zone_nlwps;	/* number of lwps in zone */
4417c478bd9Sstevel@tonic-gate 	rctl_qty_t	zone_nlwps_ctl; /* protected by zone_rctls->rcs_lock */
442824c205fSml 	rctl_qty_t	zone_shmmax;	/* System V shared memory usage */
443824c205fSml 	ipc_rqty_t	zone_ipc;	/* System V IPC id resource usage */
4447c478bd9Sstevel@tonic-gate 
4457c478bd9Sstevel@tonic-gate 	uint_t		zone_rootpathlen; /* strlen(zone_rootpath) + 1 */
4467c478bd9Sstevel@tonic-gate 	uint32_t	zone_shares;	/* FSS shares allocated to zone */
4477c478bd9Sstevel@tonic-gate 	rctl_set_t	*zone_rctls;	/* zone-wide (zone.*) rctls */
4480209230bSgjelinek 	kmutex_t	zone_mem_lock;	/* protects zone_locked_mem and */
449c6939658Ssl 					/* kpd_locked_mem for all */
4500209230bSgjelinek 					/* projects in zone. */
4510209230bSgjelinek 					/* Also protects zone_max_swap */
452c6939658Ssl 					/* grab after p_lock, before rcs_lock */
4530209230bSgjelinek 	rctl_qty_t	zone_locked_mem;	/* bytes of locked memory in */
4540209230bSgjelinek 						/* zone */
4550209230bSgjelinek 	rctl_qty_t	zone_locked_mem_ctl;	/* Current locked memory */
456c6939658Ssl 						/* limit.  Protected by */
457c6939658Ssl 						/* zone_rctls->rcs_lock */
4580209230bSgjelinek 	rctl_qty_t	zone_max_swap; /* bytes of swap reserved by zone */
4590209230bSgjelinek 	rctl_qty_t	zone_max_swap_ctl;	/* current swap limit. */
4600209230bSgjelinek 						/* Protected by */
4610209230bSgjelinek 						/* zone_rctls->rcs_lock */
4620fbb751dSJohn Levon 	kmutex_t	zone_rctl_lock;	/* protects zone_max_lofi */
4630fbb751dSJohn Levon 	rctl_qty_t	zone_max_lofi; /* lofi devs for zone */
4640fbb751dSJohn Levon 	rctl_qty_t	zone_max_lofi_ctl;	/* current lofi limit. */
4650fbb751dSJohn Levon 						/* Protected by */
4660fbb751dSJohn Levon 						/* zone_rctls->rcs_lock */
4677c478bd9Sstevel@tonic-gate 	list_t		zone_zsd;	/* list of Zone-Specific Data values */
4687c478bd9Sstevel@tonic-gate 	kcondvar_t	zone_cv;	/* used to signal state changes */
4697c478bd9Sstevel@tonic-gate 	struct proc	*zone_zsched;	/* Dummy kernel "zsched" process */
4707c478bd9Sstevel@tonic-gate 	pid_t		zone_proc_initpid; /* pid of "init" for this zone */
4713f2f09c1Sdp 	char		*zone_initname;	/* fs path to 'init' */
4727c478bd9Sstevel@tonic-gate 	int		zone_boot_err;  /* for zone_boot() if boot fails */
4737c478bd9Sstevel@tonic-gate 	char		*zone_bootargs;	/* arguments passed via zone_boot() */
4740209230bSgjelinek 	uint64_t	zone_phys_mcap;	/* physical memory cap */
4757c478bd9Sstevel@tonic-gate 	/*
4767c478bd9Sstevel@tonic-gate 	 * zone_kthreads is protected by zone_status_lock.
4777c478bd9Sstevel@tonic-gate 	 */
4787c478bd9Sstevel@tonic-gate 	kthread_t	*zone_kthreads;	/* kernel threads in zone */
4797c478bd9Sstevel@tonic-gate 	struct priv_set	*zone_privset;	/* limit set for zone */
4807c478bd9Sstevel@tonic-gate 	/*
4817c478bd9Sstevel@tonic-gate 	 * zone_vfslist is protected by vfs_list_lock().
4827c478bd9Sstevel@tonic-gate 	 */
4837c478bd9Sstevel@tonic-gate 	struct vfs	*zone_vfslist;	/* list of FS's mounted in zone */
4847c478bd9Sstevel@tonic-gate 	uint64_t	zone_uniqid;	/* unique zone generation number */
4857c478bd9Sstevel@tonic-gate 	struct cred	*zone_kcred;	/* kcred-like, zone-limited cred */
4867c478bd9Sstevel@tonic-gate 	/*
4877c478bd9Sstevel@tonic-gate 	 * zone_pool is protected by pool_lock().
4887c478bd9Sstevel@tonic-gate 	 */
4897c478bd9Sstevel@tonic-gate 	struct pool	*zone_pool;	/* pool the zone is bound to */
4907c478bd9Sstevel@tonic-gate 	hrtime_t	zone_pool_mod;	/* last pool bind modification time */
4917c478bd9Sstevel@tonic-gate 	/* zone_psetid is protected by cpu_lock */
4927c478bd9Sstevel@tonic-gate 	psetid_t	zone_psetid;	/* pset the zone is bound to */
493*86ad481cSJerry Jelinek 
494*86ad481cSJerry Jelinek 	time_t		zone_boot_time;	/* Similar to boot_time */
495*86ad481cSJerry Jelinek 
4967c478bd9Sstevel@tonic-gate 	/*
4977c478bd9Sstevel@tonic-gate 	 * The following two can be read without holding any locks.  They are
4987c478bd9Sstevel@tonic-gate 	 * updated under cpu_lock.
4997c478bd9Sstevel@tonic-gate 	 */
5007c478bd9Sstevel@tonic-gate 	int		zone_ncpus;  /* zone's idea of ncpus */
5017c478bd9Sstevel@tonic-gate 	int		zone_ncpus_online; /* zone's idea of ncpus_online */
502fa9e4066Sahrens 	/*
503fa9e4066Sahrens 	 * List of ZFS datasets exported to this zone.
504fa9e4066Sahrens 	 */
505fa9e4066Sahrens 	list_t		zone_datasets;	/* list of datasets */
50645916cd2Sjpk 
50742bc57c4Srica 	ts_label_t	*zone_slabel;	/* zone sensitivity label */
50842bc57c4Srica 	int		zone_match;	/* require label match for packets */
50945916cd2Sjpk 	tsol_mlp_list_t zone_mlps;	/* MLPs on zone-private addresses */
5103f2f09c1Sdp 
5119acbbeafSnn 	boolean_t	zone_restart_init;	/* Restart init if it dies? */
5129acbbeafSnn 	struct brand	*zone_brand;		/* zone's brand */
513319378d9Seh 	void 		*zone_brand_data;	/* store brand specific data */
5140209230bSgjelinek 	id_t		zone_defaultcid;	/* dflt scheduling class id */
5150209230bSgjelinek 	kstat_t		*zone_swapresv_kstat;
5160209230bSgjelinek 	kstat_t		*zone_lockedmem_kstat;
517f4b3ec61Sdh 	/*
518f4b3ec61Sdh 	 * zone_dl_list is protected by zone_lock
519f4b3ec61Sdh 	 */
5202b24ab6bSSebastien Roy 	list_t		zone_dl_list;
521f4b3ec61Sdh 	netstack_t	*zone_netstack;
522c97ad5cdSakolb 	struct cpucap	*zone_cpucap;	/* CPU caps data */
5239e9e6ab8Spaulson 	/*
5249e9e6ab8Spaulson 	 * Solaris Auditing per-zone audit context
5259e9e6ab8Spaulson 	 */
5269e9e6ab8Spaulson 	struct au_kcontext	*zone_audit_kctxt;
527835ee219SRobert Harris 	/*
528835ee219SRobert Harris 	 * For private use by mntfs.
529835ee219SRobert Harris 	 */
530835ee219SRobert Harris 	struct mntelem	*zone_mntfs_db;
531835ee219SRobert Harris 	krwlock_t	zone_mntfs_db_lock;
532134a1f4eSCasper H.S. Dik 
533134a1f4eSCasper H.S. Dik 	struct klpd_reg		*zone_pfexecd;
5340fbb751dSJohn Levon 
5350fbb751dSJohn Levon 	char		*zone_fs_allowed;
536ff19e029SMenno Lageman 	rctl_qty_t	zone_nprocs;	/* number of processes in the zone */
537ff19e029SMenno Lageman 	rctl_qty_t	zone_nprocs_ctl;	/* current limit protected by */
538ff19e029SMenno Lageman 						/* zone_rctls->rcs_lock */
539ff19e029SMenno Lageman 	kstat_t		*zone_nprocs_kstat;
5407c478bd9Sstevel@tonic-gate } zone_t;
5417c478bd9Sstevel@tonic-gate 
5427c478bd9Sstevel@tonic-gate /*
5437c478bd9Sstevel@tonic-gate  * Special value of zone_psetid to indicate that pools are disabled.
5447c478bd9Sstevel@tonic-gate  */
5457c478bd9Sstevel@tonic-gate #define	ZONE_PS_INVAL	PS_MYID
5467c478bd9Sstevel@tonic-gate 
547f4b3ec61Sdh 
5487c478bd9Sstevel@tonic-gate extern zone_t zone0;
5497c478bd9Sstevel@tonic-gate extern zone_t *global_zone;
5507c478bd9Sstevel@tonic-gate extern uint_t maxzones;
5517c478bd9Sstevel@tonic-gate extern rctl_hndl_t rc_zone_nlwps;
552ff19e029SMenno Lageman extern rctl_hndl_t rc_zone_nprocs;
5537c478bd9Sstevel@tonic-gate 
554fa9e4066Sahrens extern long zone(int, void *, void *, void *, void *);
5557c478bd9Sstevel@tonic-gate extern void zone_zsd_init(void);
5567c478bd9Sstevel@tonic-gate extern void zone_init(void);
5577c478bd9Sstevel@tonic-gate extern void zone_hold(zone_t *);
5587c478bd9Sstevel@tonic-gate extern void zone_rele(zone_t *);
559a19609f8Sjv extern void zone_init_ref(zone_ref_t *);
560a19609f8Sjv extern void zone_hold_ref(zone_t *, zone_ref_t *, zone_ref_subsys_t);
561a19609f8Sjv extern void zone_rele_ref(zone_ref_t *, zone_ref_subsys_t);
5627c478bd9Sstevel@tonic-gate extern void zone_cred_hold(zone_t *);
5637c478bd9Sstevel@tonic-gate extern void zone_cred_rele(zone_t *);
5647c478bd9Sstevel@tonic-gate extern void zone_task_hold(zone_t *);
5657c478bd9Sstevel@tonic-gate extern void zone_task_rele(zone_t *);
5667c478bd9Sstevel@tonic-gate extern zone_t *zone_find_by_id(zoneid_t);
56745916cd2Sjpk extern zone_t *zone_find_by_label(const ts_label_t *);
5687c478bd9Sstevel@tonic-gate extern zone_t *zone_find_by_name(char *);
56945916cd2Sjpk extern zone_t *zone_find_by_any_path(const char *, boolean_t);
57048451833Scarlsonj extern zone_t *zone_find_by_path(const char *);
5717c478bd9Sstevel@tonic-gate extern zoneid_t getzoneid(void);
572f4b3ec61Sdh extern zone_t *zone_find_by_id_nolock(zoneid_t);
5732b24ab6bSSebastien Roy extern int zone_datalink_walk(zoneid_t, int (*)(datalink_id_t, void *), void *);
5742b24ab6bSSebastien Roy extern int zone_check_datalink(zoneid_t *, datalink_id_t);
5757c478bd9Sstevel@tonic-gate 
5767c478bd9Sstevel@tonic-gate /*
5777c478bd9Sstevel@tonic-gate  * Zone-specific data (ZSD) APIs
5787c478bd9Sstevel@tonic-gate  */
5797c478bd9Sstevel@tonic-gate /*
5807c478bd9Sstevel@tonic-gate  * The following is what code should be initializing its zone_key_t to if it
5817c478bd9Sstevel@tonic-gate  * calls zone_getspecific() without necessarily knowing that zone_key_create()
5827c478bd9Sstevel@tonic-gate  * has been called on the key.
5837c478bd9Sstevel@tonic-gate  */
5847c478bd9Sstevel@tonic-gate #define	ZONE_KEY_UNINITIALIZED	0
5857c478bd9Sstevel@tonic-gate 
5867c478bd9Sstevel@tonic-gate typedef uint_t zone_key_t;
5877c478bd9Sstevel@tonic-gate 
5887c478bd9Sstevel@tonic-gate extern void	zone_key_create(zone_key_t *, void *(*)(zoneid_t),
5897c478bd9Sstevel@tonic-gate     void (*)(zoneid_t, void *), void (*)(zoneid_t, void *));
5907c478bd9Sstevel@tonic-gate extern int 	zone_key_delete(zone_key_t);
5917c478bd9Sstevel@tonic-gate extern void	*zone_getspecific(zone_key_t, zone_t *);
5927c478bd9Sstevel@tonic-gate extern int	zone_setspecific(zone_key_t, zone_t *, const void *);
5937c478bd9Sstevel@tonic-gate 
5947c478bd9Sstevel@tonic-gate /*
5957c478bd9Sstevel@tonic-gate  * The definition of a zsd_entry is truly private to zone.c and is only
5967c478bd9Sstevel@tonic-gate  * placed here so it can be shared with mdb.
597bd41d0a8Snordmark  *
598bd41d0a8Snordmark  * State maintained for each zone times each registered key, which tracks
599bd41d0a8Snordmark  * the state of the create, shutdown and destroy callbacks.
600bd41d0a8Snordmark  *
601bd41d0a8Snordmark  * zsd_flags is used to keep track of pending actions to avoid holding locks
602bd41d0a8Snordmark  * when calling the create/shutdown/destroy callbacks, since doing so
603bd41d0a8Snordmark  * could lead to deadlocks.
6047c478bd9Sstevel@tonic-gate  */
6057c478bd9Sstevel@tonic-gate struct zsd_entry {
6067c478bd9Sstevel@tonic-gate 	zone_key_t		zsd_key;	/* Key used to lookup value */
6077c478bd9Sstevel@tonic-gate 	void			*zsd_data;	/* Caller-managed value */
6087c478bd9Sstevel@tonic-gate 	/*
6097c478bd9Sstevel@tonic-gate 	 * Callbacks to be executed when a zone is created, shutdown, and
6107c478bd9Sstevel@tonic-gate 	 * destroyed, respectively.
6117c478bd9Sstevel@tonic-gate 	 */
6127c478bd9Sstevel@tonic-gate 	void			*(*zsd_create)(zoneid_t);
6137c478bd9Sstevel@tonic-gate 	void			(*zsd_shutdown)(zoneid_t, void *);
6147c478bd9Sstevel@tonic-gate 	void			(*zsd_destroy)(zoneid_t, void *);
6157c478bd9Sstevel@tonic-gate 	list_node_t		zsd_linkage;
616bd41d0a8Snordmark 	uint16_t 		zsd_flags;	/* See below */
617bd41d0a8Snordmark 	kcondvar_t		zsd_cv;
6187c478bd9Sstevel@tonic-gate };
6197c478bd9Sstevel@tonic-gate 
620bd41d0a8Snordmark /*
621bd41d0a8Snordmark  * zsd_flags
622bd41d0a8Snordmark  */
623bd41d0a8Snordmark #define	ZSD_CREATE_NEEDED	0x0001
624bd41d0a8Snordmark #define	ZSD_CREATE_INPROGRESS	0x0002
625bd41d0a8Snordmark #define	ZSD_CREATE_COMPLETED	0x0004
626bd41d0a8Snordmark #define	ZSD_SHUTDOWN_NEEDED	0x0010
627bd41d0a8Snordmark #define	ZSD_SHUTDOWN_INPROGRESS	0x0020
628bd41d0a8Snordmark #define	ZSD_SHUTDOWN_COMPLETED	0x0040
629bd41d0a8Snordmark #define	ZSD_DESTROY_NEEDED	0x0100
630bd41d0a8Snordmark #define	ZSD_DESTROY_INPROGRESS	0x0200
631bd41d0a8Snordmark #define	ZSD_DESTROY_COMPLETED	0x0400
632bd41d0a8Snordmark 
633bd41d0a8Snordmark #define	ZSD_CREATE_ALL	\
634bd41d0a8Snordmark 	(ZSD_CREATE_NEEDED|ZSD_CREATE_INPROGRESS|ZSD_CREATE_COMPLETED)
635bd41d0a8Snordmark #define	ZSD_SHUTDOWN_ALL	\
636bd41d0a8Snordmark 	(ZSD_SHUTDOWN_NEEDED|ZSD_SHUTDOWN_INPROGRESS|ZSD_SHUTDOWN_COMPLETED)
637bd41d0a8Snordmark #define	ZSD_DESTROY_ALL	\
638bd41d0a8Snordmark 	(ZSD_DESTROY_NEEDED|ZSD_DESTROY_INPROGRESS|ZSD_DESTROY_COMPLETED)
639bd41d0a8Snordmark 
640bd41d0a8Snordmark #define	ZSD_ALL_INPROGRESS \
641bd41d0a8Snordmark 	(ZSD_CREATE_INPROGRESS|ZSD_SHUTDOWN_INPROGRESS|ZSD_DESTROY_INPROGRESS)
642bd41d0a8Snordmark 
6437c478bd9Sstevel@tonic-gate /*
6447c478bd9Sstevel@tonic-gate  * Macros to help with zone visibility restrictions.
6457c478bd9Sstevel@tonic-gate  */
6467c478bd9Sstevel@tonic-gate 
6477c478bd9Sstevel@tonic-gate /*
6487c478bd9Sstevel@tonic-gate  * Is process in the global zone?
6497c478bd9Sstevel@tonic-gate  */
6507c478bd9Sstevel@tonic-gate #define	INGLOBALZONE(p) \
6517c478bd9Sstevel@tonic-gate 	((p)->p_zone == global_zone)
6527c478bd9Sstevel@tonic-gate 
6537c478bd9Sstevel@tonic-gate /*
6547c478bd9Sstevel@tonic-gate  * Can process view objects in given zone?
6557c478bd9Sstevel@tonic-gate  */
6567c478bd9Sstevel@tonic-gate #define	HASZONEACCESS(p, zoneid) \
6577c478bd9Sstevel@tonic-gate 	((p)->p_zone->zone_id == (zoneid) || INGLOBALZONE(p))
6587c478bd9Sstevel@tonic-gate 
6597c478bd9Sstevel@tonic-gate /*
6607c478bd9Sstevel@tonic-gate  * Convenience macro to see if a resolved path is visible from within a
6617c478bd9Sstevel@tonic-gate  * given zone.
6627c478bd9Sstevel@tonic-gate  *
6637c478bd9Sstevel@tonic-gate  * The basic idea is that the first (zone_rootpathlen - 1) bytes of the
6647c478bd9Sstevel@tonic-gate  * two strings must be equal.  Since the rootpathlen has a trailing '/',
6657c478bd9Sstevel@tonic-gate  * we want to skip everything in the path up to (but not including) the
6667c478bd9Sstevel@tonic-gate  * trailing '/'.
6677c478bd9Sstevel@tonic-gate  */
6687c478bd9Sstevel@tonic-gate #define	ZONE_PATH_VISIBLE(path, zone) \
6697c478bd9Sstevel@tonic-gate 	(strncmp((path), (zone)->zone_rootpath,		\
6707c478bd9Sstevel@tonic-gate 	    (zone)->zone_rootpathlen - 1) == 0)
6717c478bd9Sstevel@tonic-gate 
6727c478bd9Sstevel@tonic-gate /*
6737c478bd9Sstevel@tonic-gate  * Convenience macro to go from the global view of a path to that seen
6747c478bd9Sstevel@tonic-gate  * from within said zone.  It is the responsibility of the caller to
6757c478bd9Sstevel@tonic-gate  * ensure that the path is a resolved one (ie, no '..'s or '.'s), and is
6767c478bd9Sstevel@tonic-gate  * in fact visible from within the zone.
6777c478bd9Sstevel@tonic-gate  */
6787c478bd9Sstevel@tonic-gate #define	ZONE_PATH_TRANSLATE(path, zone)	\
6797c478bd9Sstevel@tonic-gate 	(ASSERT(ZONE_PATH_VISIBLE(path, zone)),	\
6807c478bd9Sstevel@tonic-gate 	(path) + (zone)->zone_rootpathlen - 2)
6817c478bd9Sstevel@tonic-gate 
6827c478bd9Sstevel@tonic-gate /*
6837c478bd9Sstevel@tonic-gate  * Special processes visible in all zones.
6847c478bd9Sstevel@tonic-gate  */
6857c478bd9Sstevel@tonic-gate #define	ZONE_SPECIALPID(x)	 ((x) == 0 || (x) == 1)
6867c478bd9Sstevel@tonic-gate 
6877c478bd9Sstevel@tonic-gate /*
6887c478bd9Sstevel@tonic-gate  * Zone-safe version of thread_create() to be used when the caller wants to
6897c478bd9Sstevel@tonic-gate  * create a kernel thread to run within the current zone's context.
6907c478bd9Sstevel@tonic-gate  */
6917c478bd9Sstevel@tonic-gate extern kthread_t *zthread_create(caddr_t, size_t, void (*)(), void *, size_t,
6927c478bd9Sstevel@tonic-gate     pri_t);
6937c478bd9Sstevel@tonic-gate extern void zthread_exit(void);
6947c478bd9Sstevel@tonic-gate 
6957c478bd9Sstevel@tonic-gate /*
6967c478bd9Sstevel@tonic-gate  * Functions for an external observer to register interest in a zone's status
6977c478bd9Sstevel@tonic-gate  * change.  Observers will be woken up when the zone status equals the status
6987c478bd9Sstevel@tonic-gate  * argument passed in (in the case of zone_status_timedwait, the function may
6997c478bd9Sstevel@tonic-gate  * also return because of a timeout; zone_status_wait_sig may return early due
7007c478bd9Sstevel@tonic-gate  * to a signal being delivered; zone_status_timedwait_sig may return for any of
7017c478bd9Sstevel@tonic-gate  * the above reasons).
7027c478bd9Sstevel@tonic-gate  *
7037c478bd9Sstevel@tonic-gate  * Otherwise these behave identically to cv_timedwait(), cv_wait(), and
7047c478bd9Sstevel@tonic-gate  * cv_wait_sig() respectively.
7057c478bd9Sstevel@tonic-gate  */
7067c478bd9Sstevel@tonic-gate extern clock_t zone_status_timedwait(zone_t *, clock_t, zone_status_t);
7077c478bd9Sstevel@tonic-gate extern clock_t zone_status_timedwait_sig(zone_t *, clock_t, zone_status_t);
7087c478bd9Sstevel@tonic-gate extern void zone_status_wait(zone_t *, zone_status_t);
7097c478bd9Sstevel@tonic-gate extern int zone_status_wait_sig(zone_t *, zone_status_t);
7107c478bd9Sstevel@tonic-gate 
7117c478bd9Sstevel@tonic-gate /*
7127c478bd9Sstevel@tonic-gate  * Get the status  of the zone (at the time it was called).  The state may
7137c478bd9Sstevel@tonic-gate  * have progressed by the time it is returned.
7147c478bd9Sstevel@tonic-gate  */
7157c478bd9Sstevel@tonic-gate extern zone_status_t zone_status_get(zone_t *);
7167c478bd9Sstevel@tonic-gate 
7175679c89fSjv /*
7185679c89fSjv  * Safely get the hostid of the specified zone (defaults to machine's hostid
7195679c89fSjv  * if the specified zone doesn't emulate a hostid).  Passing NULL retrieves
7205679c89fSjv  * the global zone's (i.e., physical system's) hostid.
7215679c89fSjv  */
7225679c89fSjv extern uint32_t zone_get_hostid(zone_t *);
7235679c89fSjv 
7247c478bd9Sstevel@tonic-gate /*
7257c478bd9Sstevel@tonic-gate  * Get the "kcred" credentials corresponding to the given zone.
7267c478bd9Sstevel@tonic-gate  */
7277c478bd9Sstevel@tonic-gate extern struct cred *zone_get_kcred(zoneid_t);
7287c478bd9Sstevel@tonic-gate 
7297c478bd9Sstevel@tonic-gate /*
7307c478bd9Sstevel@tonic-gate  * Get/set the pool the zone is currently bound to.
7317c478bd9Sstevel@tonic-gate  */
7327c478bd9Sstevel@tonic-gate extern struct pool *zone_pool_get(zone_t *);
7337c478bd9Sstevel@tonic-gate extern void zone_pool_set(zone_t *, struct pool *);
7347c478bd9Sstevel@tonic-gate 
7357c478bd9Sstevel@tonic-gate /*
7367c478bd9Sstevel@tonic-gate  * Get/set the pset the zone is currently using.
7377c478bd9Sstevel@tonic-gate  */
7387c478bd9Sstevel@tonic-gate extern psetid_t zone_pset_get(zone_t *);
7397c478bd9Sstevel@tonic-gate extern void zone_pset_set(zone_t *, psetid_t);
7407c478bd9Sstevel@tonic-gate 
7417c478bd9Sstevel@tonic-gate /*
7427c478bd9Sstevel@tonic-gate  * Get the number of cpus/online-cpus visible from the given zone.
7437c478bd9Sstevel@tonic-gate  */
7447c478bd9Sstevel@tonic-gate extern int zone_ncpus_get(zone_t *);
7457c478bd9Sstevel@tonic-gate extern int zone_ncpus_online_get(zone_t *);
7467c478bd9Sstevel@tonic-gate 
747fa9e4066Sahrens /*
748fa9e4066Sahrens  * Returns true if the named pool/dataset is visible in the current zone.
749fa9e4066Sahrens  */
750fa9e4066Sahrens extern int zone_dataset_visible(const char *, int *);
751fa9e4066Sahrens 
7527c478bd9Sstevel@tonic-gate /*
7533f2f09c1Sdp  * zone version of kadmin()
7547c478bd9Sstevel@tonic-gate  */
7553f2f09c1Sdp extern int zone_kadmin(int, int, const char *, cred_t *);
7567c478bd9Sstevel@tonic-gate extern void zone_shutdown_global(void);
7577c478bd9Sstevel@tonic-gate 
7587c478bd9Sstevel@tonic-gate extern void mount_in_progress(void);
7597c478bd9Sstevel@tonic-gate extern void mount_completed(void);
7607c478bd9Sstevel@tonic-gate 
7617c478bd9Sstevel@tonic-gate extern int zone_walk(int (*)(zone_t *, void *), void *);
7627c478bd9Sstevel@tonic-gate 
763c6939658Ssl extern rctl_hndl_t rc_zone_locked_mem;
7640209230bSgjelinek extern rctl_hndl_t rc_zone_max_swap;
7650fbb751dSJohn Levon extern rctl_hndl_t rc_zone_max_lofi;
766c6939658Ssl 
7677c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
7687c478bd9Sstevel@tonic-gate 
7697c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
7707c478bd9Sstevel@tonic-gate }
7717c478bd9Sstevel@tonic-gate #endif
7727c478bd9Sstevel@tonic-gate 
7737c478bd9Sstevel@tonic-gate #endif	/* _SYS_ZONE_H */
774