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 Z_MOUNT, Z_UNMOUNT 125 } zone_cmd_t; 126 127 #define ZONEBOOTARGS_MAX 257 /* uadmin()'s buffer is 257 bytes. */ 128 129 /* 130 * The structure of a request to zoneadmd. 131 */ 132 typedef struct zone_cmd_arg { 133 uint64_t uniqid; /* unique "generation number" */ 134 zone_cmd_t cmd; /* requested action */ 135 char locale[MAXPATHLEN]; /* locale in which to render messages */ 136 char bootbuf[ZONEBOOTARGS_MAX]; /* arguments passed to zone_boot() */ 137 } zone_cmd_arg_t; 138 139 /* 140 * Structure of zoneadmd's response to a request. A NULL return value means 141 * the caller should attempt to restart zoneadmd and retry. 142 */ 143 typedef struct zone_cmd_rval { 144 int rval; /* return value of request */ 145 char errbuf[1]; /* variable-sized buffer containing error messages */ 146 } zone_cmd_rval_t; 147 148 /* 149 * The zone support infrastructure uses the zone name as a component 150 * of unix domain (AF_UNIX) sockets, which are limited to 108 characters 151 * in length, so ZONENAME_MAX is limited by that. 152 */ 153 #define ZONENAME_MAX 64 154 155 #define GLOBAL_ZONENAME "global" 156 157 /* 158 * Extended Regular expression (see regex(5)) which matches all valid zone 159 * names. 160 */ 161 #define ZONENAME_REGEXP "[a-zA-Z0-9][-_.a-zA-Z0-9]{0,62}" 162 163 /* 164 * Where the zones support infrastructure places temporary files. 165 */ 166 #define ZONES_TMPDIR "/var/run/zones" 167 168 /* 169 * The path to the door used by clients to communicate with zoneadmd. 170 */ 171 #define ZONE_DOOR_PATH ZONES_TMPDIR "/%s.zoneadmd_door" 172 173 174 #ifdef _KERNEL 175 /* 176 * We need to protect the definition of 'list_t' from userland applications and 177 * libraries which may be defining ther own versions. 178 */ 179 #include <sys/list.h> 180 181 #define GLOBAL_ZONEUNIQID 0 /* uniqid of the global zone */ 182 183 /* zone_flags */ 184 #define ZF_DESTROYED 0x1 /* ZSD destructor callbacks run */ 185 186 struct pool; 187 188 typedef struct zone { 189 /* 190 * zone_name is never modified once set. 191 */ 192 char *zone_name; /* zone's configuration name */ 193 /* 194 * zone_nodename and zone_domain are never freed once allocated. 195 */ 196 char *zone_nodename; /* utsname.nodename equivalent */ 197 char *zone_domain; /* srpc_domain equivalent */ 198 /* 199 * zone_lock protects the following fields of a zone_t: 200 * zone_ref 201 * zone_cred_ref 202 * zone_ntasks 203 * zone_flags 204 * zone_zsd 205 */ 206 kmutex_t zone_lock; 207 /* 208 * zone_linkage is the zone's linkage into the active or 209 * death-row list. The field is protected by zonehash_lock. 210 */ 211 list_node_t zone_linkage; 212 zoneid_t zone_id; /* ID of zone */ 213 uint_t zone_ref; /* count of zone_hold()s on zone */ 214 uint_t zone_cred_ref; /* count of zone_hold_cred()s on zone */ 215 /* 216 * zone_rootvp and zone_rootpath can never be modified once set. 217 */ 218 struct vnode *zone_rootvp; /* zone's root vnode */ 219 char *zone_rootpath; /* Path to zone's root + '/' */ 220 ushort_t zone_flags; /* misc flags */ 221 zone_status_t zone_status; /* protected by zone_status_lock */ 222 uint_t zone_ntasks; /* number of tasks executing in zone */ 223 kmutex_t zone_nlwps_lock; /* protects zone_nlwps, and *_nlwps */ 224 /* counters in projects and tasks */ 225 /* that are within the zone */ 226 rctl_qty_t zone_nlwps; /* number of lwps in zone */ 227 rctl_qty_t zone_nlwps_ctl; /* protected by zone_rctls->rcs_lock */ 228 229 uint_t zone_rootpathlen; /* strlen(zone_rootpath) + 1 */ 230 uint32_t zone_shares; /* FSS shares allocated to zone */ 231 rctl_set_t *zone_rctls; /* zone-wide (zone.*) rctls */ 232 list_t zone_zsd; /* list of Zone-Specific Data values */ 233 kcondvar_t zone_cv; /* used to signal state changes */ 234 struct proc *zone_zsched; /* Dummy kernel "zsched" process */ 235 pid_t zone_proc_initpid; /* pid of "init" for this zone */ 236 int zone_boot_err; /* for zone_boot() if boot fails */ 237 char *zone_bootargs; /* arguments passed via zone_boot() */ 238 /* 239 * zone_kthreads is protected by zone_status_lock. 240 */ 241 kthread_t *zone_kthreads; /* kernel threads in zone */ 242 struct priv_set *zone_privset; /* limit set for zone */ 243 /* 244 * zone_vfslist is protected by vfs_list_lock(). 245 */ 246 struct vfs *zone_vfslist; /* list of FS's mounted in zone */ 247 uint64_t zone_uniqid; /* unique zone generation number */ 248 struct cred *zone_kcred; /* kcred-like, zone-limited cred */ 249 /* 250 * zone_pool is protected by pool_lock(). 251 */ 252 struct pool *zone_pool; /* pool the zone is bound to */ 253 hrtime_t zone_pool_mod; /* last pool bind modification time */ 254 /* zone_psetid is protected by cpu_lock */ 255 psetid_t zone_psetid; /* pset the zone is bound to */ 256 /* 257 * The following two can be read without holding any locks. They are 258 * updated under cpu_lock. 259 */ 260 int zone_ncpus; /* zone's idea of ncpus */ 261 int zone_ncpus_online; /* zone's idea of ncpus_online */ 262 } zone_t; 263 264 /* 265 * Special value of zone_psetid to indicate that pools are disabled. 266 */ 267 #define ZONE_PS_INVAL PS_MYID 268 269 extern zone_t zone0; 270 extern zone_t *global_zone; 271 extern uint_t maxzones; 272 extern rctl_hndl_t rc_zone_nlwps; 273 274 extern const char * const zone_initname; 275 276 extern long zone(int, void *, void *, void *, void *, void *); 277 extern void zone_zsd_init(void); 278 extern void zone_init(void); 279 extern void zone_hold(zone_t *); 280 extern void zone_rele(zone_t *); 281 extern void zone_cred_hold(zone_t *); 282 extern void zone_cred_rele(zone_t *); 283 extern void zone_task_hold(zone_t *); 284 extern void zone_task_rele(zone_t *); 285 extern zone_t *zone_find_by_id(zoneid_t); 286 extern zone_t *zone_find_by_name(char *); 287 extern zone_t *zone_find_by_path(const char *); 288 extern zoneid_t getzoneid(void); 289 290 /* 291 * Zone-specific data (ZSD) APIs 292 */ 293 /* 294 * The following is what code should be initializing its zone_key_t to if it 295 * calls zone_getspecific() without necessarily knowing that zone_key_create() 296 * has been called on the key. 297 */ 298 #define ZONE_KEY_UNINITIALIZED 0 299 300 typedef uint_t zone_key_t; 301 302 extern void zone_key_create(zone_key_t *, void *(*)(zoneid_t), 303 void (*)(zoneid_t, void *), void (*)(zoneid_t, void *)); 304 extern int zone_key_delete(zone_key_t); 305 extern void *zone_getspecific(zone_key_t, zone_t *); 306 extern int zone_setspecific(zone_key_t, zone_t *, const void *); 307 308 /* 309 * The definition of a zsd_entry is truly private to zone.c and is only 310 * placed here so it can be shared with mdb. 311 */ 312 struct zsd_entry { 313 zone_key_t zsd_key; /* Key used to lookup value */ 314 void *zsd_data; /* Caller-managed value */ 315 /* 316 * Callbacks to be executed when a zone is created, shutdown, and 317 * destroyed, respectively. 318 */ 319 void *(*zsd_create)(zoneid_t); 320 void (*zsd_shutdown)(zoneid_t, void *); 321 void (*zsd_destroy)(zoneid_t, void *); 322 list_node_t zsd_linkage; 323 }; 324 325 /* 326 * Macros to help with zone visibility restrictions. 327 */ 328 329 /* 330 * Is process in the global zone? 331 */ 332 #define INGLOBALZONE(p) \ 333 ((p)->p_zone == global_zone) 334 335 /* 336 * Can process view objects in given zone? 337 */ 338 #define HASZONEACCESS(p, zoneid) \ 339 ((p)->p_zone->zone_id == (zoneid) || INGLOBALZONE(p)) 340 341 /* 342 * Convenience macro to see if a resolved path is visible from within a 343 * given zone. 344 * 345 * The basic idea is that the first (zone_rootpathlen - 1) bytes of the 346 * two strings must be equal. Since the rootpathlen has a trailing '/', 347 * we want to skip everything in the path up to (but not including) the 348 * trailing '/'. 349 */ 350 #define ZONE_PATH_VISIBLE(path, zone) \ 351 (strncmp((path), (zone)->zone_rootpath, \ 352 (zone)->zone_rootpathlen - 1) == 0) 353 354 /* 355 * Convenience macro to go from the global view of a path to that seen 356 * from within said zone. It is the responsibility of the caller to 357 * ensure that the path is a resolved one (ie, no '..'s or '.'s), and is 358 * in fact visible from within the zone. 359 */ 360 #define ZONE_PATH_TRANSLATE(path, zone) \ 361 (ASSERT(ZONE_PATH_VISIBLE(path, zone)), \ 362 (path) + (zone)->zone_rootpathlen - 2) 363 364 /* 365 * Special processes visible in all zones. 366 */ 367 #define ZONE_SPECIALPID(x) ((x) == 0 || (x) == 1) 368 369 /* 370 * Special zoneid_t token to refer to all zones. 371 */ 372 #define ALL_ZONES (-1) 373 374 /* 375 * Zone-safe version of thread_create() to be used when the caller wants to 376 * create a kernel thread to run within the current zone's context. 377 */ 378 extern kthread_t *zthread_create(caddr_t, size_t, void (*)(), void *, size_t, 379 pri_t); 380 extern void zthread_exit(void); 381 382 /* 383 * Functions for an external observer to register interest in a zone's status 384 * change. Observers will be woken up when the zone status equals the status 385 * argument passed in (in the case of zone_status_timedwait, the function may 386 * also return because of a timeout; zone_status_wait_sig may return early due 387 * to a signal being delivered; zone_status_timedwait_sig may return for any of 388 * the above reasons). 389 * 390 * Otherwise these behave identically to cv_timedwait(), cv_wait(), and 391 * cv_wait_sig() respectively. 392 */ 393 extern clock_t zone_status_timedwait(zone_t *, clock_t, zone_status_t); 394 extern clock_t zone_status_timedwait_sig(zone_t *, clock_t, zone_status_t); 395 extern void zone_status_wait(zone_t *, zone_status_t); 396 extern int zone_status_wait_sig(zone_t *, zone_status_t); 397 398 /* 399 * Get the status of the zone (at the time it was called). The state may 400 * have progressed by the time it is returned. 401 */ 402 extern zone_status_t zone_status_get(zone_t *); 403 404 /* 405 * Get the "kcred" credentials corresponding to the given zone. 406 */ 407 extern struct cred *zone_get_kcred(zoneid_t); 408 409 /* 410 * Get/set the pool the zone is currently bound to. 411 */ 412 extern struct pool *zone_pool_get(zone_t *); 413 extern void zone_pool_set(zone_t *, struct pool *); 414 415 /* 416 * Get/set the pset the zone is currently using. 417 */ 418 extern psetid_t zone_pset_get(zone_t *); 419 extern void zone_pset_set(zone_t *, psetid_t); 420 421 /* 422 * Get the number of cpus/online-cpus visible from the given zone. 423 */ 424 extern int zone_ncpus_get(zone_t *); 425 extern int zone_ncpus_online_get(zone_t *); 426 427 /* 428 * zone version of uadmin() 429 */ 430 extern int zone_uadmin(int, int, struct cred *); 431 extern void zone_shutdown_global(void); 432 433 extern void mount_in_progress(void); 434 extern void mount_completed(void); 435 436 extern int zone_walk(int (*)(zone_t *, void *), void *); 437 438 #endif /* _KERNEL */ 439 440 #ifdef __cplusplus 441 } 442 #endif 443 444 #endif /* _SYS_ZONE_H */ 445