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