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. 23*2918c4a3SJohn Levon * Copyright 2018 Joyent, Inc. 243c7284bdSAlexander Eremin * Copyright 2014 Nexenta Systems, Inc. All rights reserved. 256481fd49SIgor Kozhukhov * Copyright 2014 Igor Kozhukhov <ikozhukhov@gmail.com>. 267c478bd9Sstevel@tonic-gate */ 277c478bd9Sstevel@tonic-gate 287c478bd9Sstevel@tonic-gate #ifndef _SYS_ZONE_H 297c478bd9Sstevel@tonic-gate #define _SYS_ZONE_H 307c478bd9Sstevel@tonic-gate 317c478bd9Sstevel@tonic-gate #include <sys/types.h> 327c478bd9Sstevel@tonic-gate #include <sys/mutex.h> 337c478bd9Sstevel@tonic-gate #include <sys/param.h> 347c478bd9Sstevel@tonic-gate #include <sys/rctl.h> 35824c205fSml #include <sys/ipc_rctl.h> 367c478bd9Sstevel@tonic-gate #include <sys/pset.h> 3745916cd2Sjpk #include <sys/tsol/label.h> 38f4b3ec61Sdh #include <sys/cred.h> 39f4b3ec61Sdh #include <sys/netstack.h> 403f2f09c1Sdp #include <sys/uadmin.h> 41835ee219SRobert Harris #include <sys/ksynch.h> 42550b6e40SSowmini Varadhan #include <sys/socket_impl.h> 43d2a70789SRichard Lowe #include <sys/secflags.h> 44550b6e40SSowmini Varadhan #include <netinet/in.h> 45*2918c4a3SJohn Levon #include <sys/cpu_uarray.h> 467c478bd9Sstevel@tonic-gate 477c478bd9Sstevel@tonic-gate #ifdef __cplusplus 487c478bd9Sstevel@tonic-gate extern "C" { 497c478bd9Sstevel@tonic-gate #endif 507c478bd9Sstevel@tonic-gate 517c478bd9Sstevel@tonic-gate /* 527c478bd9Sstevel@tonic-gate * NOTE 537c478bd9Sstevel@tonic-gate * 547c478bd9Sstevel@tonic-gate * The contents of this file are private to the implementation of 557c478bd9Sstevel@tonic-gate * Solaris and are subject to change at any time without notice. 567c478bd9Sstevel@tonic-gate * Applications and drivers using these interfaces may fail to 577c478bd9Sstevel@tonic-gate * run on future releases. 587c478bd9Sstevel@tonic-gate */ 597c478bd9Sstevel@tonic-gate 607c478bd9Sstevel@tonic-gate /* Available both in kernel and for user space */ 617c478bd9Sstevel@tonic-gate 627c478bd9Sstevel@tonic-gate /* zone id restrictions and special ids */ 637c478bd9Sstevel@tonic-gate #define MAX_ZONEID 9999 647c478bd9Sstevel@tonic-gate #define MIN_USERZONEID 1 /* lowest user-creatable zone ID */ 657c478bd9Sstevel@tonic-gate #define MIN_ZONEID 0 /* minimum zone ID on system */ 667c478bd9Sstevel@tonic-gate #define GLOBAL_ZONEID 0 677c478bd9Sstevel@tonic-gate #define ZONEID_WIDTH 4 /* for printf */ 687c478bd9Sstevel@tonic-gate 6945916cd2Sjpk /* 7045916cd2Sjpk * Special zoneid_t token to refer to all zones. 7145916cd2Sjpk */ 7245916cd2Sjpk #define ALL_ZONES (-1) 7345916cd2Sjpk 747c478bd9Sstevel@tonic-gate /* system call subcodes */ 75f4b3ec61Sdh #define ZONE_CREATE 0 76f4b3ec61Sdh #define ZONE_DESTROY 1 77f4b3ec61Sdh #define ZONE_GETATTR 2 78f4b3ec61Sdh #define ZONE_ENTER 3 79f4b3ec61Sdh #define ZONE_LIST 4 80f4b3ec61Sdh #define ZONE_SHUTDOWN 5 81f4b3ec61Sdh #define ZONE_LOOKUP 6 82f4b3ec61Sdh #define ZONE_BOOT 7 83f4b3ec61Sdh #define ZONE_VERSION 8 84f4b3ec61Sdh #define ZONE_SETATTR 9 85f4b3ec61Sdh #define ZONE_ADD_DATALINK 10 86f4b3ec61Sdh #define ZONE_DEL_DATALINK 11 87f4b3ec61Sdh #define ZONE_CHECK_DATALINK 12 88f4b3ec61Sdh #define ZONE_LIST_DATALINK 13 897c478bd9Sstevel@tonic-gate 907c478bd9Sstevel@tonic-gate /* zone attributes */ 917c478bd9Sstevel@tonic-gate #define ZONE_ATTR_ROOT 1 927c478bd9Sstevel@tonic-gate #define ZONE_ATTR_NAME 2 937c478bd9Sstevel@tonic-gate #define ZONE_ATTR_STATUS 3 947c478bd9Sstevel@tonic-gate #define ZONE_ATTR_PRIVSET 4 957c478bd9Sstevel@tonic-gate #define ZONE_ATTR_UNIQID 5 967c478bd9Sstevel@tonic-gate #define ZONE_ATTR_POOLID 6 977c478bd9Sstevel@tonic-gate #define ZONE_ATTR_INITPID 7 9845916cd2Sjpk #define ZONE_ATTR_SLBL 8 993f2f09c1Sdp #define ZONE_ATTR_INITNAME 9 1003f2f09c1Sdp #define ZONE_ATTR_BOOTARGS 10 1019acbbeafSnn #define ZONE_ATTR_BRAND 11 1020209230bSgjelinek #define ZONE_ATTR_PHYS_MCAP 12 1030209230bSgjelinek #define ZONE_ATTR_SCHED_CLASS 13 104f4b3ec61Sdh #define ZONE_ATTR_FLAGS 14 1055679c89fSjv #define ZONE_ATTR_HOSTID 15 1060fbb751dSJohn Levon #define ZONE_ATTR_FS_ALLOWED 16 107550b6e40SSowmini Varadhan #define ZONE_ATTR_NETWORK 17 108bafd1f14SJerry Jelinek #define ZONE_ATTR_INITNORESTART 20 109d2a70789SRichard Lowe #define ZONE_ATTR_SECFLAGS 21 1109acbbeafSnn 1119acbbeafSnn /* Start of the brand-specific attribute namespace */ 1129acbbeafSnn #define ZONE_ATTR_BRAND_ATTRS 32768 1137c478bd9Sstevel@tonic-gate 1140fbb751dSJohn Levon #define ZONE_FS_ALLOWED_MAX 1024 1150fbb751dSJohn Levon 116cf8f45c7Sdstaff #define ZONE_EVENT_CHANNEL "com.sun:zones:status" 117cf8f45c7Sdstaff #define ZONE_EVENT_STATUS_CLASS "status" 118cf8f45c7Sdstaff #define ZONE_EVENT_STATUS_SUBCLASS "change" 119cf8f45c7Sdstaff 120cf8f45c7Sdstaff #define ZONE_EVENT_UNINITIALIZED "uninitialized" 121bd41d0a8Snordmark #define ZONE_EVENT_INITIALIZED "initialized" 122cf8f45c7Sdstaff #define ZONE_EVENT_READY "ready" 123cf8f45c7Sdstaff #define ZONE_EVENT_RUNNING "running" 124cf8f45c7Sdstaff #define ZONE_EVENT_SHUTTING_DOWN "shutting_down" 125cf8f45c7Sdstaff 126cf8f45c7Sdstaff #define ZONE_CB_NAME "zonename" 127cf8f45c7Sdstaff #define ZONE_CB_NEWSTATE "newstate" 128cf8f45c7Sdstaff #define ZONE_CB_OLDSTATE "oldstate" 129cf8f45c7Sdstaff #define ZONE_CB_TIMESTAMP "when" 130cf8f45c7Sdstaff #define ZONE_CB_ZONEID "zoneid" 131cf8f45c7Sdstaff 1329acbbeafSnn /* 1339acbbeafSnn * Exit values that may be returned by scripts or programs invoked by various 1349acbbeafSnn * zone commands. 1359acbbeafSnn * 1369acbbeafSnn * These are defined as: 1379acbbeafSnn * 1389acbbeafSnn * ZONE_SUBPROC_OK 1399acbbeafSnn * =============== 1409acbbeafSnn * The subprocess completed successfully. 1419acbbeafSnn * 1429acbbeafSnn * ZONE_SUBPROC_USAGE 1439acbbeafSnn * ================== 1449acbbeafSnn * The subprocess failed with a usage message, or a usage message should 1459acbbeafSnn * be output in its behalf. 1469acbbeafSnn * 1479acbbeafSnn * ZONE_SUBPROC_NOTCOMPLETE 1489acbbeafSnn * ======================== 1499acbbeafSnn * The subprocess did not complete, but the actions performed by the 1509acbbeafSnn * subprocess require no recovery actions by the user. 1519acbbeafSnn * 1529acbbeafSnn * For example, if the subprocess were called by "zoneadm install," the 1539acbbeafSnn * installation of the zone did not succeed but the user need not perform 1549acbbeafSnn * a "zoneadm uninstall" before attempting another install. 1559acbbeafSnn * 1569acbbeafSnn * ZONE_SUBPROC_FATAL 1579acbbeafSnn * ================== 1589acbbeafSnn * The subprocess failed in a fatal manner, usually one that will require 1599acbbeafSnn * some type of recovery action by the user. 1609acbbeafSnn * 1619acbbeafSnn * For example, if the subprocess were called by "zoneadm install," the 1629acbbeafSnn * installation of the zone did not succeed and the user will need to 1639acbbeafSnn * perform a "zoneadm uninstall" before another install attempt is 1649acbbeafSnn * possible. 1659acbbeafSnn * 1669acbbeafSnn * The non-success exit values are large to avoid accidental collision 1679acbbeafSnn * with values used internally by some commands (e.g. "Z_ERR" and 1689acbbeafSnn * "Z_USAGE" as used by zoneadm.) 1699acbbeafSnn */ 1709acbbeafSnn #define ZONE_SUBPROC_OK 0 1719acbbeafSnn #define ZONE_SUBPROC_USAGE 253 1729acbbeafSnn #define ZONE_SUBPROC_NOTCOMPLETE 254 1739acbbeafSnn #define ZONE_SUBPROC_FATAL 255 1749acbbeafSnn 1757c478bd9Sstevel@tonic-gate #ifdef _SYSCALL32 1767c478bd9Sstevel@tonic-gate typedef struct { 1777c478bd9Sstevel@tonic-gate caddr32_t zone_name; 1787c478bd9Sstevel@tonic-gate caddr32_t zone_root; 1797c478bd9Sstevel@tonic-gate caddr32_t zone_privs; 180821c4a97Sdp size32_t zone_privssz; 1817c478bd9Sstevel@tonic-gate caddr32_t rctlbuf; 1827c478bd9Sstevel@tonic-gate size32_t rctlbufsz; 1837c478bd9Sstevel@tonic-gate caddr32_t extended_error; 184fa9e4066Sahrens caddr32_t zfsbuf; 185fa9e4066Sahrens size32_t zfsbufsz; 18642bc57c4Srica int match; /* match level */ 18742bc57c4Srica uint32_t doi; /* DOI for label */ 18842bc57c4Srica caddr32_t label; /* label associated with zone */ 189f4b3ec61Sdh int flags; 1907c478bd9Sstevel@tonic-gate } zone_def32; 1917c478bd9Sstevel@tonic-gate #endif 1927c478bd9Sstevel@tonic-gate typedef struct { 1937c478bd9Sstevel@tonic-gate const char *zone_name; 1947c478bd9Sstevel@tonic-gate const char *zone_root; 1957c478bd9Sstevel@tonic-gate const struct priv_set *zone_privs; 196821c4a97Sdp size_t zone_privssz; 1977c478bd9Sstevel@tonic-gate const char *rctlbuf; 1987c478bd9Sstevel@tonic-gate size_t rctlbufsz; 1997c478bd9Sstevel@tonic-gate int *extended_error; 200fa9e4066Sahrens const char *zfsbuf; 201fa9e4066Sahrens size_t zfsbufsz; 20245916cd2Sjpk int match; /* match level */ 20342bc57c4Srica uint32_t doi; /* DOI for label */ 20445916cd2Sjpk const bslabel_t *label; /* label associated with zone */ 205f4b3ec61Sdh int flags; 2067c478bd9Sstevel@tonic-gate } zone_def; 2077c478bd9Sstevel@tonic-gate 2087c478bd9Sstevel@tonic-gate /* extended error information */ 2097c478bd9Sstevel@tonic-gate #define ZE_UNKNOWN 0 /* No extended error info */ 2107c478bd9Sstevel@tonic-gate #define ZE_CHROOTED 1 /* tried to zone_create from chroot */ 2117c478bd9Sstevel@tonic-gate #define ZE_AREMOUNTS 2 /* there are mounts within the zone */ 2128c55461bSton #define ZE_LABELINUSE 3 /* label is already in use by some other zone */ 2137c478bd9Sstevel@tonic-gate 214a19609f8Sjv /* 215a19609f8Sjv * zone_status values 216a19609f8Sjv * 217a19609f8Sjv * You must modify zone_status_names in mdb(1M)'s genunix module 218a19609f8Sjv * (genunix/zone.c) when you modify this enum. 219a19609f8Sjv */ 2207c478bd9Sstevel@tonic-gate typedef enum { 2217c478bd9Sstevel@tonic-gate ZONE_IS_UNINITIALIZED = 0, 222bd41d0a8Snordmark ZONE_IS_INITIALIZED, 2237c478bd9Sstevel@tonic-gate ZONE_IS_READY, 2247c478bd9Sstevel@tonic-gate ZONE_IS_BOOTING, 2257c478bd9Sstevel@tonic-gate ZONE_IS_RUNNING, 2267c478bd9Sstevel@tonic-gate ZONE_IS_SHUTTING_DOWN, 2277c478bd9Sstevel@tonic-gate ZONE_IS_EMPTY, 2287c478bd9Sstevel@tonic-gate ZONE_IS_DOWN, 2297c478bd9Sstevel@tonic-gate ZONE_IS_DYING, 2307c478bd9Sstevel@tonic-gate ZONE_IS_DEAD 2317c478bd9Sstevel@tonic-gate } zone_status_t; 2327c478bd9Sstevel@tonic-gate #define ZONE_MIN_STATE ZONE_IS_UNINITIALIZED 2337c478bd9Sstevel@tonic-gate #define ZONE_MAX_STATE ZONE_IS_DEAD 2347c478bd9Sstevel@tonic-gate 2357c478bd9Sstevel@tonic-gate /* 2367c478bd9Sstevel@tonic-gate * Valid commands which may be issued by zoneadm to zoneadmd. The kernel also 2377c478bd9Sstevel@tonic-gate * communicates with zoneadmd, but only uses Z_REBOOT and Z_HALT. 2387c478bd9Sstevel@tonic-gate */ 2397c478bd9Sstevel@tonic-gate typedef enum zone_cmd { 2409acbbeafSnn Z_READY, Z_BOOT, Z_FORCEBOOT, Z_REBOOT, Z_HALT, Z_NOTE_UNINSTALLING, 2413c7284bdSAlexander Eremin Z_MOUNT, Z_FORCEMOUNT, Z_UNMOUNT, Z_SHUTDOWN 2427c478bd9Sstevel@tonic-gate } zone_cmd_t; 2437c478bd9Sstevel@tonic-gate 2447c478bd9Sstevel@tonic-gate /* 2457c478bd9Sstevel@tonic-gate * The structure of a request to zoneadmd. 2467c478bd9Sstevel@tonic-gate */ 2477c478bd9Sstevel@tonic-gate typedef struct zone_cmd_arg { 2487c478bd9Sstevel@tonic-gate uint64_t uniqid; /* unique "generation number" */ 2497c478bd9Sstevel@tonic-gate zone_cmd_t cmd; /* requested action */ 2503f2f09c1Sdp uint32_t _pad; /* need consistent 32/64 bit alignmt */ 2517c478bd9Sstevel@tonic-gate char locale[MAXPATHLEN]; /* locale in which to render messages */ 2523f2f09c1Sdp char bootbuf[BOOTARGS_MAX]; /* arguments passed to zone_boot() */ 2537c478bd9Sstevel@tonic-gate } zone_cmd_arg_t; 2547c478bd9Sstevel@tonic-gate 2557c478bd9Sstevel@tonic-gate /* 2567c478bd9Sstevel@tonic-gate * Structure of zoneadmd's response to a request. A NULL return value means 2577c478bd9Sstevel@tonic-gate * the caller should attempt to restart zoneadmd and retry. 2587c478bd9Sstevel@tonic-gate */ 2597c478bd9Sstevel@tonic-gate typedef struct zone_cmd_rval { 2607c478bd9Sstevel@tonic-gate int rval; /* return value of request */ 2617c478bd9Sstevel@tonic-gate char errbuf[1]; /* variable-sized buffer containing error messages */ 2627c478bd9Sstevel@tonic-gate } zone_cmd_rval_t; 2637c478bd9Sstevel@tonic-gate 2647c478bd9Sstevel@tonic-gate /* 2657c478bd9Sstevel@tonic-gate * The zone support infrastructure uses the zone name as a component 2667c478bd9Sstevel@tonic-gate * of unix domain (AF_UNIX) sockets, which are limited to 108 characters 2677c478bd9Sstevel@tonic-gate * in length, so ZONENAME_MAX is limited by that. 2687c478bd9Sstevel@tonic-gate */ 2697c478bd9Sstevel@tonic-gate #define ZONENAME_MAX 64 2707c478bd9Sstevel@tonic-gate 2717c478bd9Sstevel@tonic-gate #define GLOBAL_ZONENAME "global" 2727c478bd9Sstevel@tonic-gate 2737c478bd9Sstevel@tonic-gate /* 2747c478bd9Sstevel@tonic-gate * Extended Regular expression (see regex(5)) which matches all valid zone 2757c478bd9Sstevel@tonic-gate * names. 2767c478bd9Sstevel@tonic-gate */ 2777c478bd9Sstevel@tonic-gate #define ZONENAME_REGEXP "[a-zA-Z0-9][-_.a-zA-Z0-9]{0,62}" 2787c478bd9Sstevel@tonic-gate 2797c478bd9Sstevel@tonic-gate /* 2807c478bd9Sstevel@tonic-gate * Where the zones support infrastructure places temporary files. 2817c478bd9Sstevel@tonic-gate */ 2827c478bd9Sstevel@tonic-gate #define ZONES_TMPDIR "/var/run/zones" 2837c478bd9Sstevel@tonic-gate 2847c478bd9Sstevel@tonic-gate /* 2857c478bd9Sstevel@tonic-gate * The path to the door used by clients to communicate with zoneadmd. 2867c478bd9Sstevel@tonic-gate */ 2877c478bd9Sstevel@tonic-gate #define ZONE_DOOR_PATH ZONES_TMPDIR "/%s.zoneadmd_door" 2887c478bd9Sstevel@tonic-gate 289a19609f8Sjv 290f4b3ec61Sdh /* zone_flags */ 291a19609f8Sjv /* 292a19609f8Sjv * Threads that read or write the following flag must hold zone_lock. 293a19609f8Sjv */ 294a19609f8Sjv #define ZF_REFCOUNTS_LOGGED 0x1 /* a thread logged the zone's refs */ 295a19609f8Sjv 296a19609f8Sjv /* 297a19609f8Sjv * The following threads are set when the zone is created and never changed. 298a19609f8Sjv * Threads that test for these flags don't have to hold zone_lock. 299a19609f8Sjv */ 300f4b3ec61Sdh #define ZF_HASHED_LABEL 0x2 /* zone has a unique label */ 301f4b3ec61Sdh #define ZF_IS_SCRATCH 0x4 /* scratch zone */ 302f4b3ec61Sdh #define ZF_NET_EXCL 0x8 /* Zone has an exclusive IP stack */ 303f4b3ec61Sdh 304a19609f8Sjv 305f4b3ec61Sdh /* zone_create flags */ 306f4b3ec61Sdh #define ZCF_NET_EXCL 0x1 /* Create a zone with exclusive IP */ 307f4b3ec61Sdh 308550b6e40SSowmini Varadhan /* zone network properties */ 309550b6e40SSowmini Varadhan #define ZONE_NETWORK_ADDRESS 1 310550b6e40SSowmini Varadhan #define ZONE_NETWORK_DEFROUTER 2 311550b6e40SSowmini Varadhan 312550b6e40SSowmini Varadhan #define ZONE_NET_ADDRNAME "address" 313550b6e40SSowmini Varadhan #define ZONE_NET_RTRNAME "route" 314550b6e40SSowmini Varadhan 315550b6e40SSowmini Varadhan typedef struct zone_net_data { 316550b6e40SSowmini Varadhan int zn_type; 317550b6e40SSowmini Varadhan int zn_len; 318550b6e40SSowmini Varadhan datalink_id_t zn_linkid; 319550b6e40SSowmini Varadhan uint8_t zn_val[1]; 320550b6e40SSowmini Varadhan } zone_net_data_t; 321550b6e40SSowmini Varadhan 322550b6e40SSowmini Varadhan 3237c478bd9Sstevel@tonic-gate #ifdef _KERNEL 324a19609f8Sjv 3257c478bd9Sstevel@tonic-gate /* 3267c478bd9Sstevel@tonic-gate * We need to protect the definition of 'list_t' from userland applications and 3277c478bd9Sstevel@tonic-gate * libraries which may be defining ther own versions. 3287c478bd9Sstevel@tonic-gate */ 3297c478bd9Sstevel@tonic-gate #include <sys/list.h> 3306481fd49SIgor Kozhukhov #include <sys/loadavg.h> 3317c478bd9Sstevel@tonic-gate 3327c478bd9Sstevel@tonic-gate #define GLOBAL_ZONEUNIQID 0 /* uniqid of the global zone */ 3337c478bd9Sstevel@tonic-gate 334*2918c4a3SJohn Levon /* 335*2918c4a3SJohn Levon * Indexes into ->zone_ustate array, summing the micro state of all threads in a 336*2918c4a3SJohn Levon * particular zone. 337*2918c4a3SJohn Levon */ 338*2918c4a3SJohn Levon #define ZONE_USTATE_STIME (0) 339*2918c4a3SJohn Levon #define ZONE_USTATE_UTIME (1) 340*2918c4a3SJohn Levon #define ZONE_USTATE_WTIME (2) 341*2918c4a3SJohn Levon #define ZONE_USTATE_MAX (3) 342*2918c4a3SJohn Levon 3437c478bd9Sstevel@tonic-gate struct pool; 3449acbbeafSnn struct brand; 3457c478bd9Sstevel@tonic-gate 346a19609f8Sjv /* 347a19609f8Sjv * Each of these constants identifies a kernel subsystem that acquires and 348a19609f8Sjv * releases zone references. Each subsystem that invokes 349a19609f8Sjv * zone_hold_ref() and zone_rele_ref() should specify the 350a19609f8Sjv * zone_ref_subsys_t constant associated with the subsystem. Tracked holds 351a19609f8Sjv * help users and developers quickly identify subsystems that stall zone 352a19609f8Sjv * shutdowns indefinitely. 353a19609f8Sjv * 354a19609f8Sjv * NOTE: You must modify zone_ref_subsys_names in usr/src/uts/common/os/zone.c 355a19609f8Sjv * when you modify this enumeration. 356a19609f8Sjv */ 357a19609f8Sjv typedef enum zone_ref_subsys { 358a19609f8Sjv ZONE_REF_NFS, /* NFS */ 359a19609f8Sjv ZONE_REF_NFSV4, /* NFSv4 */ 360a19609f8Sjv ZONE_REF_SMBFS, /* SMBFS */ 361a19609f8Sjv ZONE_REF_MNTFS, /* MNTFS */ 362a19609f8Sjv ZONE_REF_LOFI, /* LOFI devices */ 363a19609f8Sjv ZONE_REF_VFS, /* VFS infrastructure */ 364a19609f8Sjv ZONE_REF_IPC, /* IPC infrastructure */ 365a19609f8Sjv ZONE_REF_NUM_SUBSYS /* This must be the last entry. */ 366a19609f8Sjv } zone_ref_subsys_t; 367a19609f8Sjv 368a19609f8Sjv /* 369a19609f8Sjv * zone_ref represents a general-purpose references to a zone. Each zone's 370a19609f8Sjv * references are linked into the zone's zone_t::zone_ref_list. This allows 371a19609f8Sjv * debuggers to walk zones' references. 372a19609f8Sjv */ 373a19609f8Sjv typedef struct zone_ref { 374a19609f8Sjv struct zone *zref_zone; /* the zone to which the reference refers */ 375a19609f8Sjv list_node_t zref_linkage; /* linkage for zone_t::zone_ref_list */ 376a19609f8Sjv } zone_ref_t; 377a19609f8Sjv 378fa9e4066Sahrens /* 379fa9e4066Sahrens * Structure to record list of ZFS datasets exported to a zone. 380fa9e4066Sahrens */ 381fa9e4066Sahrens typedef struct zone_dataset { 382fa9e4066Sahrens char *zd_dataset; 383fa9e4066Sahrens list_node_t zd_linkage; 384fa9e4066Sahrens } zone_dataset_t; 385fa9e4066Sahrens 3860209230bSgjelinek /* 3870209230bSgjelinek * structure for zone kstats 3880209230bSgjelinek */ 3890209230bSgjelinek typedef struct zone_kstat { 3900209230bSgjelinek kstat_named_t zk_zonename; 3910209230bSgjelinek kstat_named_t zk_usage; 3920209230bSgjelinek kstat_named_t zk_value; 3930209230bSgjelinek } zone_kstat_t; 3940209230bSgjelinek 395c97ad5cdSakolb struct cpucap; 396c97ad5cdSakolb 3979468939eSJerry Jelinek typedef struct { 3989468939eSJerry Jelinek kstat_named_t zm_zonename; 3999468939eSJerry Jelinek kstat_named_t zm_pgpgin; 4009468939eSJerry Jelinek kstat_named_t zm_anonpgin; 4019468939eSJerry Jelinek kstat_named_t zm_execpgin; 4029468939eSJerry Jelinek kstat_named_t zm_fspgin; 403d14b1d19SJerry Jelinek kstat_named_t zm_anon_alloc_fail; 4049468939eSJerry Jelinek } zone_mcap_kstat_t; 4059468939eSJerry Jelinek 406542a813cSJerry Jelinek typedef struct { 407542a813cSJerry Jelinek kstat_named_t zm_zonename; /* full name, kstat truncates name */ 408542a813cSJerry Jelinek kstat_named_t zm_utime; 409542a813cSJerry Jelinek kstat_named_t zm_stime; 410542a813cSJerry Jelinek kstat_named_t zm_wtime; 41181d43577SJerry Jelinek kstat_named_t zm_avenrun1; 41281d43577SJerry Jelinek kstat_named_t zm_avenrun5; 41381d43577SJerry Jelinek kstat_named_t zm_avenrun15; 4142dc692e0SJerry Jelinek kstat_named_t zm_ffcap; 4152dc692e0SJerry Jelinek kstat_named_t zm_ffnoproc; 4162dc692e0SJerry Jelinek kstat_named_t zm_ffnomem; 4172dc692e0SJerry Jelinek kstat_named_t zm_ffmisc; 41893cf283aSJerry Jelinek kstat_named_t zm_nested_intp; 419a48d8120SJerry Jelinek kstat_named_t zm_init_pid; 420a48d8120SJerry Jelinek kstat_named_t zm_boot_time; 421542a813cSJerry Jelinek } zone_misc_kstat_t; 422542a813cSJerry Jelinek 4237c478bd9Sstevel@tonic-gate typedef struct zone { 4247c478bd9Sstevel@tonic-gate /* 4257c478bd9Sstevel@tonic-gate * zone_name is never modified once set. 4267c478bd9Sstevel@tonic-gate */ 4277c478bd9Sstevel@tonic-gate char *zone_name; /* zone's configuration name */ 4287c478bd9Sstevel@tonic-gate /* 4297c478bd9Sstevel@tonic-gate * zone_nodename and zone_domain are never freed once allocated. 4307c478bd9Sstevel@tonic-gate */ 4317c478bd9Sstevel@tonic-gate char *zone_nodename; /* utsname.nodename equivalent */ 4327c478bd9Sstevel@tonic-gate char *zone_domain; /* srpc_domain equivalent */ 4335679c89fSjv /* 4345679c89fSjv * zone_hostid is used for per-zone hostid emulation. 4355679c89fSjv * Currently it isn't modified after it's set (so no locks protect 4365679c89fSjv * accesses), but that might have to change when we allow 4375679c89fSjv * administrators to change running zones' properties. 4385679c89fSjv * 4395679c89fSjv * The global zone's zone_hostid must always be HW_INVALID_HOSTID so 4405679c89fSjv * that zone_get_hostid() will function correctly. 4415679c89fSjv */ 4425679c89fSjv uint32_t zone_hostid; /* zone's hostid, HW_INVALID_HOSTID */ 4435679c89fSjv /* if not emulated */ 4447c478bd9Sstevel@tonic-gate /* 4457c478bd9Sstevel@tonic-gate * zone_lock protects the following fields of a zone_t: 446*2918c4a3SJohn Levon * zone_ref 447*2918c4a3SJohn Levon * zone_cred_ref 448*2918c4a3SJohn Levon * zone_subsys_ref 449*2918c4a3SJohn Levon * zone_ref_list 450*2918c4a3SJohn Levon * zone_ntasks 451*2918c4a3SJohn Levon * zone_flags 452*2918c4a3SJohn Levon * zone_zsd 453134a1f4eSCasper H.S. Dik * zone_pfexecd 4547c478bd9Sstevel@tonic-gate */ 4557c478bd9Sstevel@tonic-gate kmutex_t zone_lock; 4567c478bd9Sstevel@tonic-gate /* 4577c478bd9Sstevel@tonic-gate * zone_linkage is the zone's linkage into the active or 4587c478bd9Sstevel@tonic-gate * death-row list. The field is protected by zonehash_lock. 4597c478bd9Sstevel@tonic-gate */ 4607c478bd9Sstevel@tonic-gate list_node_t zone_linkage; 4617c478bd9Sstevel@tonic-gate zoneid_t zone_id; /* ID of zone */ 4627c478bd9Sstevel@tonic-gate uint_t zone_ref; /* count of zone_hold()s on zone */ 4637c478bd9Sstevel@tonic-gate uint_t zone_cred_ref; /* count of zone_hold_cred()s on zone */ 464a19609f8Sjv /* 465a19609f8Sjv * Fixed-sized array of subsystem-specific reference counts 466a19609f8Sjv * The sum of all of the counts must be less than or equal to zone_ref. 467a19609f8Sjv * The array is indexed by the counts' subsystems' zone_ref_subsys_t 468a19609f8Sjv * constants. 469a19609f8Sjv */ 470a19609f8Sjv uint_t zone_subsys_ref[ZONE_REF_NUM_SUBSYS]; 471a19609f8Sjv list_t zone_ref_list; /* list of zone_ref_t structs */ 4727c478bd9Sstevel@tonic-gate /* 4737c478bd9Sstevel@tonic-gate * zone_rootvp and zone_rootpath can never be modified once set. 4747c478bd9Sstevel@tonic-gate */ 4757c478bd9Sstevel@tonic-gate struct vnode *zone_rootvp; /* zone's root vnode */ 4767c478bd9Sstevel@tonic-gate char *zone_rootpath; /* Path to zone's root + '/' */ 4777c478bd9Sstevel@tonic-gate ushort_t zone_flags; /* misc flags */ 4787c478bd9Sstevel@tonic-gate zone_status_t zone_status; /* protected by zone_status_lock */ 4797c478bd9Sstevel@tonic-gate uint_t zone_ntasks; /* number of tasks executing in zone */ 4807c478bd9Sstevel@tonic-gate kmutex_t zone_nlwps_lock; /* protects zone_nlwps, and *_nlwps */ 4817c478bd9Sstevel@tonic-gate /* counters in projects and tasks */ 4827c478bd9Sstevel@tonic-gate /* that are within the zone */ 4837c478bd9Sstevel@tonic-gate rctl_qty_t zone_nlwps; /* number of lwps in zone */ 4847c478bd9Sstevel@tonic-gate rctl_qty_t zone_nlwps_ctl; /* protected by zone_rctls->rcs_lock */ 485824c205fSml rctl_qty_t zone_shmmax; /* System V shared memory usage */ 486824c205fSml ipc_rqty_t zone_ipc; /* System V IPC id resource usage */ 4877c478bd9Sstevel@tonic-gate 4887c478bd9Sstevel@tonic-gate uint_t zone_rootpathlen; /* strlen(zone_rootpath) + 1 */ 4897c478bd9Sstevel@tonic-gate uint32_t zone_shares; /* FSS shares allocated to zone */ 4907c478bd9Sstevel@tonic-gate rctl_set_t *zone_rctls; /* zone-wide (zone.*) rctls */ 4910209230bSgjelinek kmutex_t zone_mem_lock; /* protects zone_locked_mem and */ 492c6939658Ssl /* kpd_locked_mem for all */ 4930209230bSgjelinek /* projects in zone. */ 4940209230bSgjelinek /* Also protects zone_max_swap */ 495c6939658Ssl /* grab after p_lock, before rcs_lock */ 4960209230bSgjelinek rctl_qty_t zone_locked_mem; /* bytes of locked memory in */ 4970209230bSgjelinek /* zone */ 4980209230bSgjelinek rctl_qty_t zone_locked_mem_ctl; /* Current locked memory */ 499c6939658Ssl /* limit. Protected by */ 500c6939658Ssl /* zone_rctls->rcs_lock */ 5010209230bSgjelinek rctl_qty_t zone_max_swap; /* bytes of swap reserved by zone */ 5020209230bSgjelinek rctl_qty_t zone_max_swap_ctl; /* current swap limit. */ 5030209230bSgjelinek /* Protected by */ 5040209230bSgjelinek /* zone_rctls->rcs_lock */ 5050fbb751dSJohn Levon kmutex_t zone_rctl_lock; /* protects zone_max_lofi */ 5060fbb751dSJohn Levon rctl_qty_t zone_max_lofi; /* lofi devs for zone */ 5070fbb751dSJohn Levon rctl_qty_t zone_max_lofi_ctl; /* current lofi limit. */ 5080fbb751dSJohn Levon /* Protected by */ 5090fbb751dSJohn Levon /* zone_rctls->rcs_lock */ 5107c478bd9Sstevel@tonic-gate list_t zone_zsd; /* list of Zone-Specific Data values */ 5117c478bd9Sstevel@tonic-gate kcondvar_t zone_cv; /* used to signal state changes */ 5127c478bd9Sstevel@tonic-gate struct proc *zone_zsched; /* Dummy kernel "zsched" process */ 5137c478bd9Sstevel@tonic-gate pid_t zone_proc_initpid; /* pid of "init" for this zone */ 5143f2f09c1Sdp char *zone_initname; /* fs path to 'init' */ 5157c478bd9Sstevel@tonic-gate int zone_boot_err; /* for zone_boot() if boot fails */ 5167c478bd9Sstevel@tonic-gate char *zone_bootargs; /* arguments passed via zone_boot() */ 5170209230bSgjelinek uint64_t zone_phys_mcap; /* physical memory cap */ 5187c478bd9Sstevel@tonic-gate /* 5197c478bd9Sstevel@tonic-gate * zone_kthreads is protected by zone_status_lock. 5207c478bd9Sstevel@tonic-gate */ 5217c478bd9Sstevel@tonic-gate kthread_t *zone_kthreads; /* kernel threads in zone */ 5227c478bd9Sstevel@tonic-gate struct priv_set *zone_privset; /* limit set for zone */ 5237c478bd9Sstevel@tonic-gate /* 5247c478bd9Sstevel@tonic-gate * zone_vfslist is protected by vfs_list_lock(). 5257c478bd9Sstevel@tonic-gate */ 5267c478bd9Sstevel@tonic-gate struct vfs *zone_vfslist; /* list of FS's mounted in zone */ 5277c478bd9Sstevel@tonic-gate uint64_t zone_uniqid; /* unique zone generation number */ 5287c478bd9Sstevel@tonic-gate struct cred *zone_kcred; /* kcred-like, zone-limited cred */ 5297c478bd9Sstevel@tonic-gate /* 5307c478bd9Sstevel@tonic-gate * zone_pool is protected by pool_lock(). 5317c478bd9Sstevel@tonic-gate */ 5327c478bd9Sstevel@tonic-gate struct pool *zone_pool; /* pool the zone is bound to */ 5337c478bd9Sstevel@tonic-gate hrtime_t zone_pool_mod; /* last pool bind modification time */ 5347c478bd9Sstevel@tonic-gate /* zone_psetid is protected by cpu_lock */ 5357c478bd9Sstevel@tonic-gate psetid_t zone_psetid; /* pset the zone is bound to */ 53686ad481cSJerry Jelinek 53786ad481cSJerry Jelinek time_t zone_boot_time; /* Similar to boot_time */ 53886ad481cSJerry Jelinek 5397c478bd9Sstevel@tonic-gate /* 5407c478bd9Sstevel@tonic-gate * The following two can be read without holding any locks. They are 5417c478bd9Sstevel@tonic-gate * updated under cpu_lock. 5427c478bd9Sstevel@tonic-gate */ 5437c478bd9Sstevel@tonic-gate int zone_ncpus; /* zone's idea of ncpus */ 5447c478bd9Sstevel@tonic-gate int zone_ncpus_online; /* zone's idea of ncpus_online */ 545fa9e4066Sahrens /* 546fa9e4066Sahrens * List of ZFS datasets exported to this zone. 547fa9e4066Sahrens */ 548fa9e4066Sahrens list_t zone_datasets; /* list of datasets */ 54945916cd2Sjpk 55042bc57c4Srica ts_label_t *zone_slabel; /* zone sensitivity label */ 55142bc57c4Srica int zone_match; /* require label match for packets */ 55245916cd2Sjpk tsol_mlp_list_t zone_mlps; /* MLPs on zone-private addresses */ 5533f2f09c1Sdp 5549acbbeafSnn boolean_t zone_restart_init; /* Restart init if it dies? */ 5559acbbeafSnn struct brand *zone_brand; /* zone's brand */ 556*2918c4a3SJohn Levon void *zone_brand_data; /* store brand specific data */ 5570209230bSgjelinek id_t zone_defaultcid; /* dflt scheduling class id */ 5580209230bSgjelinek kstat_t *zone_swapresv_kstat; 5590209230bSgjelinek kstat_t *zone_lockedmem_kstat; 560f4b3ec61Sdh /* 561f4b3ec61Sdh * zone_dl_list is protected by zone_lock 562f4b3ec61Sdh */ 5632b24ab6bSSebastien Roy list_t zone_dl_list; 564f4b3ec61Sdh netstack_t *zone_netstack; 565c97ad5cdSakolb struct cpucap *zone_cpucap; /* CPU caps data */ 5669e9e6ab8Spaulson /* 5679e9e6ab8Spaulson * Solaris Auditing per-zone audit context 5689e9e6ab8Spaulson */ 5699e9e6ab8Spaulson struct au_kcontext *zone_audit_kctxt; 570835ee219SRobert Harris /* 571835ee219SRobert Harris * For private use by mntfs. 572835ee219SRobert Harris */ 573835ee219SRobert Harris struct mntelem *zone_mntfs_db; 574835ee219SRobert Harris krwlock_t zone_mntfs_db_lock; 575134a1f4eSCasper H.S. Dik 576134a1f4eSCasper H.S. Dik struct klpd_reg *zone_pfexecd; 5770fbb751dSJohn Levon 5780fbb751dSJohn Levon char *zone_fs_allowed; 579ff19e029SMenno Lageman rctl_qty_t zone_nprocs; /* number of processes in the zone */ 580ff19e029SMenno Lageman rctl_qty_t zone_nprocs_ctl; /* current limit protected by */ 581ff19e029SMenno Lageman /* zone_rctls->rcs_lock */ 582ff19e029SMenno Lageman kstat_t *zone_nprocs_kstat; 583b0f673c4SBryan Cantrill 5849468939eSJerry Jelinek kmutex_t zone_mcap_lock; /* protects mcap statistics */ 5859468939eSJerry Jelinek kstat_t *zone_mcap_ksp; 5869468939eSJerry Jelinek zone_mcap_kstat_t *zone_mcap_stats; 5879468939eSJerry Jelinek uint64_t zone_pgpgin; /* pages paged in */ 5889468939eSJerry Jelinek uint64_t zone_anonpgin; /* anon pages paged in */ 5899468939eSJerry Jelinek uint64_t zone_execpgin; /* exec pages paged in */ 5909468939eSJerry Jelinek uint64_t zone_fspgin; /* fs pages paged in */ 591d14b1d19SJerry Jelinek uint64_t zone_anon_alloc_fail; /* cnt of anon alloc fails */ 5929468939eSJerry Jelinek 593d2a70789SRichard Lowe psecflags_t zone_secflags; /* default zone security-flags */ 594d2a70789SRichard Lowe 595542a813cSJerry Jelinek /* 596542a813cSJerry Jelinek * Misc. kstats and counters for zone cpu-usage aggregation. 597542a813cSJerry Jelinek */ 598542a813cSJerry Jelinek kmutex_t zone_misc_lock; /* protects misc statistics */ 599542a813cSJerry Jelinek kstat_t *zone_misc_ksp; 600542a813cSJerry Jelinek zone_misc_kstat_t *zone_misc_stats; 601*2918c4a3SJohn Levon /* Accumulated microstate for all threads in this zone. */ 602*2918c4a3SJohn Levon cpu_uarray_t *zone_ustate; 6032dc692e0SJerry Jelinek /* fork-fail kstat tracking */ 6042dc692e0SJerry Jelinek uint32_t zone_ffcap; /* hit an rctl cap */ 6052dc692e0SJerry Jelinek uint32_t zone_ffnoproc; /* get proc/lwp error */ 6062dc692e0SJerry Jelinek uint32_t zone_ffnomem; /* as_dup/memory error */ 6072dc692e0SJerry Jelinek uint32_t zone_ffmisc; /* misc. other error */ 608542a813cSJerry Jelinek 60993cf283aSJerry Jelinek uint32_t zone_nested_intp; /* nested interp. kstat */ 61093cf283aSJerry Jelinek 61181d43577SJerry Jelinek struct loadavg_s zone_loadavg; /* loadavg for this zone */ 61281d43577SJerry Jelinek uint64_t zone_hp_avenrun[3]; /* high-precision avenrun */ 61381d43577SJerry Jelinek int zone_avenrun[3]; /* FSCALED avg. run queue len */ 61481d43577SJerry Jelinek 615482a7749SJerry Jelinek /* 616482a7749SJerry Jelinek * FSS stats updated once per second by fss_decay_usage. 617482a7749SJerry Jelinek */ 618482a7749SJerry Jelinek uint32_t zone_fss_gen; /* FSS generation cntr */ 619482a7749SJerry Jelinek uint64_t zone_run_ticks; /* tot # of ticks running */ 620482a7749SJerry Jelinek 621b0f673c4SBryan Cantrill /* 622b0f673c4SBryan Cantrill * DTrace-private per-zone state 623b0f673c4SBryan Cantrill */ 624b0f673c4SBryan Cantrill int zone_dtrace_getf; /* # of unprivileged getf()s */ 6255fd5c689SJerry Jelinek 6265fd5c689SJerry Jelinek /* 6275fd5c689SJerry Jelinek * Synchronization primitives used to synchronize between mounts and 6285fd5c689SJerry Jelinek * zone creation/destruction. 6295fd5c689SJerry Jelinek */ 6305fd5c689SJerry Jelinek int zone_mounts_in_progress; 6315fd5c689SJerry Jelinek kcondvar_t zone_mount_cv; 6325fd5c689SJerry Jelinek kmutex_t zone_mount_lock; 6337c478bd9Sstevel@tonic-gate } zone_t; 6347c478bd9Sstevel@tonic-gate 6357c478bd9Sstevel@tonic-gate /* 6367c478bd9Sstevel@tonic-gate * Special value of zone_psetid to indicate that pools are disabled. 6377c478bd9Sstevel@tonic-gate */ 6387c478bd9Sstevel@tonic-gate #define ZONE_PS_INVAL PS_MYID 6397c478bd9Sstevel@tonic-gate 640f4b3ec61Sdh 6417c478bd9Sstevel@tonic-gate extern zone_t zone0; 6427c478bd9Sstevel@tonic-gate extern zone_t *global_zone; 6437c478bd9Sstevel@tonic-gate extern uint_t maxzones; 6447c478bd9Sstevel@tonic-gate extern rctl_hndl_t rc_zone_nlwps; 645ff19e029SMenno Lageman extern rctl_hndl_t rc_zone_nprocs; 6467c478bd9Sstevel@tonic-gate 647fa9e4066Sahrens extern long zone(int, void *, void *, void *, void *); 6487c478bd9Sstevel@tonic-gate extern void zone_zsd_init(void); 6497c478bd9Sstevel@tonic-gate extern void zone_init(void); 6507c478bd9Sstevel@tonic-gate extern void zone_hold(zone_t *); 6517c478bd9Sstevel@tonic-gate extern void zone_rele(zone_t *); 652a19609f8Sjv extern void zone_init_ref(zone_ref_t *); 653a19609f8Sjv extern void zone_hold_ref(zone_t *, zone_ref_t *, zone_ref_subsys_t); 654a19609f8Sjv extern void zone_rele_ref(zone_ref_t *, zone_ref_subsys_t); 6557c478bd9Sstevel@tonic-gate extern void zone_cred_hold(zone_t *); 6567c478bd9Sstevel@tonic-gate extern void zone_cred_rele(zone_t *); 6577c478bd9Sstevel@tonic-gate extern void zone_task_hold(zone_t *); 6587c478bd9Sstevel@tonic-gate extern void zone_task_rele(zone_t *); 6597c478bd9Sstevel@tonic-gate extern zone_t *zone_find_by_id(zoneid_t); 66045916cd2Sjpk extern zone_t *zone_find_by_label(const ts_label_t *); 6617c478bd9Sstevel@tonic-gate extern zone_t *zone_find_by_name(char *); 66245916cd2Sjpk extern zone_t *zone_find_by_any_path(const char *, boolean_t); 66348451833Scarlsonj extern zone_t *zone_find_by_path(const char *); 6647c478bd9Sstevel@tonic-gate extern zoneid_t getzoneid(void); 665f4b3ec61Sdh extern zone_t *zone_find_by_id_nolock(zoneid_t); 6662b24ab6bSSebastien Roy extern int zone_datalink_walk(zoneid_t, int (*)(datalink_id_t, void *), void *); 6672b24ab6bSSebastien Roy extern int zone_check_datalink(zoneid_t *, datalink_id_t); 66881d43577SJerry Jelinek extern void zone_loadavg_update(); 6697c478bd9Sstevel@tonic-gate 6707c478bd9Sstevel@tonic-gate /* 6717c478bd9Sstevel@tonic-gate * Zone-specific data (ZSD) APIs 6727c478bd9Sstevel@tonic-gate */ 6737c478bd9Sstevel@tonic-gate /* 6747c478bd9Sstevel@tonic-gate * The following is what code should be initializing its zone_key_t to if it 6757c478bd9Sstevel@tonic-gate * calls zone_getspecific() without necessarily knowing that zone_key_create() 6767c478bd9Sstevel@tonic-gate * has been called on the key. 6777c478bd9Sstevel@tonic-gate */ 6787c478bd9Sstevel@tonic-gate #define ZONE_KEY_UNINITIALIZED 0 6797c478bd9Sstevel@tonic-gate 6807c478bd9Sstevel@tonic-gate typedef uint_t zone_key_t; 6817c478bd9Sstevel@tonic-gate 6827c478bd9Sstevel@tonic-gate extern void zone_key_create(zone_key_t *, void *(*)(zoneid_t), 6837c478bd9Sstevel@tonic-gate void (*)(zoneid_t, void *), void (*)(zoneid_t, void *)); 684*2918c4a3SJohn Levon extern int zone_key_delete(zone_key_t); 6857c478bd9Sstevel@tonic-gate extern void *zone_getspecific(zone_key_t, zone_t *); 6867c478bd9Sstevel@tonic-gate extern int zone_setspecific(zone_key_t, zone_t *, const void *); 6877c478bd9Sstevel@tonic-gate 6887c478bd9Sstevel@tonic-gate /* 6897c478bd9Sstevel@tonic-gate * The definition of a zsd_entry is truly private to zone.c and is only 6907c478bd9Sstevel@tonic-gate * placed here so it can be shared with mdb. 691bd41d0a8Snordmark * 692bd41d0a8Snordmark * State maintained for each zone times each registered key, which tracks 693bd41d0a8Snordmark * the state of the create, shutdown and destroy callbacks. 694bd41d0a8Snordmark * 695bd41d0a8Snordmark * zsd_flags is used to keep track of pending actions to avoid holding locks 696bd41d0a8Snordmark * when calling the create/shutdown/destroy callbacks, since doing so 697bd41d0a8Snordmark * could lead to deadlocks. 6987c478bd9Sstevel@tonic-gate */ 6997c478bd9Sstevel@tonic-gate struct zsd_entry { 7007c478bd9Sstevel@tonic-gate zone_key_t zsd_key; /* Key used to lookup value */ 7017c478bd9Sstevel@tonic-gate void *zsd_data; /* Caller-managed value */ 7027c478bd9Sstevel@tonic-gate /* 7037c478bd9Sstevel@tonic-gate * Callbacks to be executed when a zone is created, shutdown, and 7047c478bd9Sstevel@tonic-gate * destroyed, respectively. 7057c478bd9Sstevel@tonic-gate */ 7067c478bd9Sstevel@tonic-gate void *(*zsd_create)(zoneid_t); 7077c478bd9Sstevel@tonic-gate void (*zsd_shutdown)(zoneid_t, void *); 7087c478bd9Sstevel@tonic-gate void (*zsd_destroy)(zoneid_t, void *); 7097c478bd9Sstevel@tonic-gate list_node_t zsd_linkage; 710*2918c4a3SJohn Levon uint16_t zsd_flags; /* See below */ 711bd41d0a8Snordmark kcondvar_t zsd_cv; 7127c478bd9Sstevel@tonic-gate }; 7137c478bd9Sstevel@tonic-gate 714bd41d0a8Snordmark /* 715bd41d0a8Snordmark * zsd_flags 716bd41d0a8Snordmark */ 717bd41d0a8Snordmark #define ZSD_CREATE_NEEDED 0x0001 718bd41d0a8Snordmark #define ZSD_CREATE_INPROGRESS 0x0002 719bd41d0a8Snordmark #define ZSD_CREATE_COMPLETED 0x0004 720bd41d0a8Snordmark #define ZSD_SHUTDOWN_NEEDED 0x0010 721bd41d0a8Snordmark #define ZSD_SHUTDOWN_INPROGRESS 0x0020 722bd41d0a8Snordmark #define ZSD_SHUTDOWN_COMPLETED 0x0040 723bd41d0a8Snordmark #define ZSD_DESTROY_NEEDED 0x0100 724bd41d0a8Snordmark #define ZSD_DESTROY_INPROGRESS 0x0200 725bd41d0a8Snordmark #define ZSD_DESTROY_COMPLETED 0x0400 726bd41d0a8Snordmark 727bd41d0a8Snordmark #define ZSD_CREATE_ALL \ 728bd41d0a8Snordmark (ZSD_CREATE_NEEDED|ZSD_CREATE_INPROGRESS|ZSD_CREATE_COMPLETED) 729bd41d0a8Snordmark #define ZSD_SHUTDOWN_ALL \ 730bd41d0a8Snordmark (ZSD_SHUTDOWN_NEEDED|ZSD_SHUTDOWN_INPROGRESS|ZSD_SHUTDOWN_COMPLETED) 731bd41d0a8Snordmark #define ZSD_DESTROY_ALL \ 732bd41d0a8Snordmark (ZSD_DESTROY_NEEDED|ZSD_DESTROY_INPROGRESS|ZSD_DESTROY_COMPLETED) 733bd41d0a8Snordmark 734bd41d0a8Snordmark #define ZSD_ALL_INPROGRESS \ 735bd41d0a8Snordmark (ZSD_CREATE_INPROGRESS|ZSD_SHUTDOWN_INPROGRESS|ZSD_DESTROY_INPROGRESS) 736bd41d0a8Snordmark 7377c478bd9Sstevel@tonic-gate /* 7387c478bd9Sstevel@tonic-gate * Macros to help with zone visibility restrictions. 7397c478bd9Sstevel@tonic-gate */ 7407c478bd9Sstevel@tonic-gate 7417c478bd9Sstevel@tonic-gate /* 7427c478bd9Sstevel@tonic-gate * Is process in the global zone? 7437c478bd9Sstevel@tonic-gate */ 7447c478bd9Sstevel@tonic-gate #define INGLOBALZONE(p) \ 7457c478bd9Sstevel@tonic-gate ((p)->p_zone == global_zone) 7467c478bd9Sstevel@tonic-gate 7477c478bd9Sstevel@tonic-gate /* 7487c478bd9Sstevel@tonic-gate * Can process view objects in given zone? 7497c478bd9Sstevel@tonic-gate */ 7507c478bd9Sstevel@tonic-gate #define HASZONEACCESS(p, zoneid) \ 7517c478bd9Sstevel@tonic-gate ((p)->p_zone->zone_id == (zoneid) || INGLOBALZONE(p)) 7527c478bd9Sstevel@tonic-gate 7537c478bd9Sstevel@tonic-gate /* 7547c478bd9Sstevel@tonic-gate * Convenience macro to see if a resolved path is visible from within a 7557c478bd9Sstevel@tonic-gate * given zone. 7567c478bd9Sstevel@tonic-gate * 7577c478bd9Sstevel@tonic-gate * The basic idea is that the first (zone_rootpathlen - 1) bytes of the 7587c478bd9Sstevel@tonic-gate * two strings must be equal. Since the rootpathlen has a trailing '/', 7597c478bd9Sstevel@tonic-gate * we want to skip everything in the path up to (but not including) the 7607c478bd9Sstevel@tonic-gate * trailing '/'. 7617c478bd9Sstevel@tonic-gate */ 7627c478bd9Sstevel@tonic-gate #define ZONE_PATH_VISIBLE(path, zone) \ 7637c478bd9Sstevel@tonic-gate (strncmp((path), (zone)->zone_rootpath, \ 7647c478bd9Sstevel@tonic-gate (zone)->zone_rootpathlen - 1) == 0) 7657c478bd9Sstevel@tonic-gate 7667c478bd9Sstevel@tonic-gate /* 7677c478bd9Sstevel@tonic-gate * Convenience macro to go from the global view of a path to that seen 7687c478bd9Sstevel@tonic-gate * from within said zone. It is the responsibility of the caller to 7697c478bd9Sstevel@tonic-gate * ensure that the path is a resolved one (ie, no '..'s or '.'s), and is 7707c478bd9Sstevel@tonic-gate * in fact visible from within the zone. 7717c478bd9Sstevel@tonic-gate */ 7727c478bd9Sstevel@tonic-gate #define ZONE_PATH_TRANSLATE(path, zone) \ 7737c478bd9Sstevel@tonic-gate (ASSERT(ZONE_PATH_VISIBLE(path, zone)), \ 7747c478bd9Sstevel@tonic-gate (path) + (zone)->zone_rootpathlen - 2) 7757c478bd9Sstevel@tonic-gate 7767c478bd9Sstevel@tonic-gate /* 7777c478bd9Sstevel@tonic-gate * Special processes visible in all zones. 7787c478bd9Sstevel@tonic-gate */ 7797c478bd9Sstevel@tonic-gate #define ZONE_SPECIALPID(x) ((x) == 0 || (x) == 1) 7807c478bd9Sstevel@tonic-gate 7817c478bd9Sstevel@tonic-gate /* 7827c478bd9Sstevel@tonic-gate * Zone-safe version of thread_create() to be used when the caller wants to 7837c478bd9Sstevel@tonic-gate * create a kernel thread to run within the current zone's context. 7847c478bd9Sstevel@tonic-gate */ 7857c478bd9Sstevel@tonic-gate extern kthread_t *zthread_create(caddr_t, size_t, void (*)(), void *, size_t, 7867c478bd9Sstevel@tonic-gate pri_t); 7877c478bd9Sstevel@tonic-gate extern void zthread_exit(void); 7887c478bd9Sstevel@tonic-gate 7897c478bd9Sstevel@tonic-gate /* 7907c478bd9Sstevel@tonic-gate * Functions for an external observer to register interest in a zone's status 7917c478bd9Sstevel@tonic-gate * change. Observers will be woken up when the zone status equals the status 7927c478bd9Sstevel@tonic-gate * argument passed in (in the case of zone_status_timedwait, the function may 7937c478bd9Sstevel@tonic-gate * also return because of a timeout; zone_status_wait_sig may return early due 7947c478bd9Sstevel@tonic-gate * to a signal being delivered; zone_status_timedwait_sig may return for any of 7957c478bd9Sstevel@tonic-gate * the above reasons). 7967c478bd9Sstevel@tonic-gate * 7977c478bd9Sstevel@tonic-gate * Otherwise these behave identically to cv_timedwait(), cv_wait(), and 7987c478bd9Sstevel@tonic-gate * cv_wait_sig() respectively. 7997c478bd9Sstevel@tonic-gate */ 8007c478bd9Sstevel@tonic-gate extern clock_t zone_status_timedwait(zone_t *, clock_t, zone_status_t); 8017c478bd9Sstevel@tonic-gate extern clock_t zone_status_timedwait_sig(zone_t *, clock_t, zone_status_t); 8027c478bd9Sstevel@tonic-gate extern void zone_status_wait(zone_t *, zone_status_t); 8037c478bd9Sstevel@tonic-gate extern int zone_status_wait_sig(zone_t *, zone_status_t); 8047c478bd9Sstevel@tonic-gate 8057c478bd9Sstevel@tonic-gate /* 8067c478bd9Sstevel@tonic-gate * Get the status of the zone (at the time it was called). The state may 8077c478bd9Sstevel@tonic-gate * have progressed by the time it is returned. 8087c478bd9Sstevel@tonic-gate */ 8097c478bd9Sstevel@tonic-gate extern zone_status_t zone_status_get(zone_t *); 8107c478bd9Sstevel@tonic-gate 8115679c89fSjv /* 8125679c89fSjv * Safely get the hostid of the specified zone (defaults to machine's hostid 8135679c89fSjv * if the specified zone doesn't emulate a hostid). Passing NULL retrieves 8145679c89fSjv * the global zone's (i.e., physical system's) hostid. 8155679c89fSjv */ 8165679c89fSjv extern uint32_t zone_get_hostid(zone_t *); 8175679c89fSjv 8187c478bd9Sstevel@tonic-gate /* 8197c478bd9Sstevel@tonic-gate * Get the "kcred" credentials corresponding to the given zone. 8207c478bd9Sstevel@tonic-gate */ 8217c478bd9Sstevel@tonic-gate extern struct cred *zone_get_kcred(zoneid_t); 8227c478bd9Sstevel@tonic-gate 8237c478bd9Sstevel@tonic-gate /* 8247c478bd9Sstevel@tonic-gate * Get/set the pool the zone is currently bound to. 8257c478bd9Sstevel@tonic-gate */ 8267c478bd9Sstevel@tonic-gate extern struct pool *zone_pool_get(zone_t *); 8277c478bd9Sstevel@tonic-gate extern void zone_pool_set(zone_t *, struct pool *); 8287c478bd9Sstevel@tonic-gate 8297c478bd9Sstevel@tonic-gate /* 8307c478bd9Sstevel@tonic-gate * Get/set the pset the zone is currently using. 8317c478bd9Sstevel@tonic-gate */ 8327c478bd9Sstevel@tonic-gate extern psetid_t zone_pset_get(zone_t *); 8337c478bd9Sstevel@tonic-gate extern void zone_pset_set(zone_t *, psetid_t); 8347c478bd9Sstevel@tonic-gate 8357c478bd9Sstevel@tonic-gate /* 8367c478bd9Sstevel@tonic-gate * Get the number of cpus/online-cpus visible from the given zone. 8377c478bd9Sstevel@tonic-gate */ 8387c478bd9Sstevel@tonic-gate extern int zone_ncpus_get(zone_t *); 8397c478bd9Sstevel@tonic-gate extern int zone_ncpus_online_get(zone_t *); 8407c478bd9Sstevel@tonic-gate 841fa9e4066Sahrens /* 842fa9e4066Sahrens * Returns true if the named pool/dataset is visible in the current zone. 843fa9e4066Sahrens */ 844fa9e4066Sahrens extern int zone_dataset_visible(const char *, int *); 845fa9e4066Sahrens 8467c478bd9Sstevel@tonic-gate /* 8473f2f09c1Sdp * zone version of kadmin() 8487c478bd9Sstevel@tonic-gate */ 8493f2f09c1Sdp extern int zone_kadmin(int, int, const char *, cred_t *); 8507c478bd9Sstevel@tonic-gate extern void zone_shutdown_global(void); 8517c478bd9Sstevel@tonic-gate 8525fd5c689SJerry Jelinek extern void mount_in_progress(zone_t *); 8535fd5c689SJerry Jelinek extern void mount_completed(zone_t *); 8547c478bd9Sstevel@tonic-gate 8557c478bd9Sstevel@tonic-gate extern int zone_walk(int (*)(zone_t *, void *), void *); 8567c478bd9Sstevel@tonic-gate 857c6939658Ssl extern rctl_hndl_t rc_zone_locked_mem; 8580209230bSgjelinek extern rctl_hndl_t rc_zone_max_swap; 8590fbb751dSJohn Levon extern rctl_hndl_t rc_zone_max_lofi; 860c6939658Ssl 8617c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 8627c478bd9Sstevel@tonic-gate 8637c478bd9Sstevel@tonic-gate #ifdef __cplusplus 8647c478bd9Sstevel@tonic-gate } 8657c478bd9Sstevel@tonic-gate #endif 8667c478bd9Sstevel@tonic-gate 8677c478bd9Sstevel@tonic-gate #endif /* _SYS_ZONE_H */ 868