1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _LIBZONECFG_H 28 #define _LIBZONECFG_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 /* 33 * Zone configuration header file. 34 */ 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /* sys/socket.h is required by net/if.h, which has a constant needed here */ 41 #include <sys/param.h> 42 #include <sys/fstyp.h> 43 #include <sys/mount.h> 44 #include <priv.h> 45 #include <netinet/in.h> 46 #include <sys/socket.h> 47 #include <net/if.h> 48 #include <stdio.h> 49 #include <rctl.h> 50 #include <zone.h> 51 #include <libbrand.h> 52 #include <sys/uuid.h> 53 54 #define ZONE_ID_UNDEFINED -1 55 56 #define Z_OK 0 57 #define Z_EMPTY_DOCUMENT 1 /* XML doc root element is null */ 58 #define Z_WRONG_DOC_TYPE 2 /* top-level XML doc element != zone */ 59 #define Z_BAD_PROPERTY 3 /* libxml-level property problem */ 60 #define Z_TEMP_FILE 4 /* problem creating temporary file */ 61 #define Z_SAVING_FILE 5 /* libxml error saving or validating */ 62 #define Z_NO_ENTRY 6 /* no such entry */ 63 #define Z_BOGUS_ZONE_NAME 7 /* illegal zone name */ 64 #define Z_REQD_RESOURCE_MISSING 8 /* required resource missing */ 65 #define Z_REQD_PROPERTY_MISSING 9 /* required property missing */ 66 #define Z_BAD_HANDLE 10 /* bad document handle */ 67 #define Z_NOMEM 11 /* out of memory (like ENOMEM) */ 68 #define Z_INVAL 12 /* invalid argument (like EINVAL) */ 69 #define Z_ACCES 13 /* permission denied (like EACCES) */ 70 #define Z_TOO_BIG 14 /* string won't fit in char array */ 71 #define Z_MISC_FS 15 /* miscellaneous file-system error */ 72 #define Z_NO_ZONE 16 /* no such zone */ 73 #define Z_NO_RESOURCE_TYPE 17 /* no/wrong resource type */ 74 #define Z_NO_RESOURCE_ID 18 /* no/wrong resource id */ 75 #define Z_NO_PROPERTY_TYPE 19 /* no/wrong property type */ 76 #define Z_NO_PROPERTY_ID 20 /* no/wrong property id */ 77 #define Z_BAD_ZONE_STATE 21 /* zone state invalid for given task */ 78 #define Z_INVALID_DOCUMENT 22 /* libxml can't validate against DTD */ 79 #define Z_NAME_IN_USE 23 /* zone name already in use (rename) */ 80 #define Z_NO_SUCH_ID 24 /* delete_index: no old ID */ 81 #define Z_UPDATING_INDEX 25 /* add/modify/delete_index problem */ 82 #define Z_LOCKING_FILE 26 /* problem locking index file */ 83 #define Z_UNLOCKING_FILE 27 /* problem unlocking index file */ 84 #define Z_SYSTEM 28 /* consult errno instead */ 85 #define Z_INSUFFICIENT_SPEC 29 /* resource insufficiently specified */ 86 #define Z_RESOLVED_PATH 34 /* resolved path mismatch */ 87 #define Z_IPV6_ADDR_PREFIX_LEN 35 /* IPv6 address prefix length needed */ 88 #define Z_BOGUS_ADDRESS 36 /* not IPv[4|6] address or host name */ 89 #define Z_PRIV_PROHIBITED 37 /* specified privilege is prohibited */ 90 #define Z_PRIV_REQUIRED 38 /* required privilege is missing */ 91 #define Z_PRIV_UNKNOWN 39 /* specified privilege is unknown */ 92 #define Z_BRAND_ERROR 40 /* brand-specific error */ 93 94 /* 95 * Warning: these are shared with the admin/install consolidation. 96 * Do not insert states between any of the currently defined states, 97 * and any new states must be evaluated for impact on range comparisons. 98 */ 99 #define ZONE_STATE_CONFIGURED 0 100 #define ZONE_STATE_INCOMPLETE 1 101 #define ZONE_STATE_INSTALLED 2 102 #define ZONE_STATE_READY 3 103 #define ZONE_STATE_RUNNING 4 104 #define ZONE_STATE_SHUTTING_DOWN 5 105 #define ZONE_STATE_DOWN 6 106 #define ZONE_STATE_MOUNTED 7 107 108 #define ZONE_STATE_MAXSTRLEN 14 109 110 #define LIBZONECFG_PATH "libzonecfg.so.1" 111 112 #define ZONE_CONFIG_ROOT "/etc/zones" 113 #define ZONE_INDEX_FILE ZONE_CONFIG_ROOT "/index" 114 115 /* Owner, group, and mode (defined by packaging) for the config directory */ 116 #define ZONE_CONFIG_UID 0 /* root */ 117 #define ZONE_CONFIG_GID 3 /* sys */ 118 #define ZONE_CONFIG_MODE 0755 119 120 /* Owner, group, and mode (defined by packaging) for the index file */ 121 #define ZONE_INDEX_UID 0 /* root */ 122 #define ZONE_INDEX_GID 3 /* sys */ 123 #define ZONE_INDEX_MODE 0644 124 125 /* The maximum length of the VERSION string in the pkginfo(4) file. */ 126 #define ZONE_PKG_VERSMAX 256 127 128 /* 129 * Bit flag definitions for passing into libzonecfg functions. 130 */ 131 #define ZONE_DRY_RUN 0x01 132 133 /* 134 * The integer field expresses the current values on a get. 135 * On a put, it represents the new values if >= 0 or "don't change" if < 0. 136 */ 137 struct zoneent { 138 char zone_name[ZONENAME_MAX]; /* name of the zone */ 139 int zone_state; /* configured | incomplete | installed */ 140 char zone_path[MAXPATHLEN]; /* path to zone storage */ 141 uuid_t zone_uuid; /* unique ID for zone */ 142 char zone_newname[ZONENAME_MAX]; /* for doing renames */ 143 }; 144 145 typedef struct zone_dochandle *zone_dochandle_t; /* opaque handle */ 146 147 typedef uint_t zone_state_t; 148 149 typedef struct zone_fsopt { 150 struct zone_fsopt *zone_fsopt_next; 151 char zone_fsopt_opt[MAX_MNTOPT_STR]; 152 } zone_fsopt_t; 153 154 struct zone_fstab { 155 char zone_fs_special[MAXPATHLEN]; /* special file */ 156 char zone_fs_dir[MAXPATHLEN]; /* mount point */ 157 char zone_fs_type[FSTYPSZ]; /* e.g. ufs */ 158 zone_fsopt_t *zone_fs_options; /* mount options */ 159 char zone_fs_raw[MAXPATHLEN]; /* device to fsck */ 160 }; 161 162 struct zone_nwiftab { 163 char zone_nwif_address[INET6_ADDRSTRLEN]; 164 char zone_nwif_physical[LIFNAMSIZ]; 165 }; 166 167 struct zone_devtab { 168 char zone_dev_match[MAXPATHLEN]; 169 }; 170 171 struct zone_rctlvaltab { 172 char zone_rctlval_priv[MAXNAMELEN]; 173 char zone_rctlval_limit[MAXNAMELEN]; 174 char zone_rctlval_action[MAXNAMELEN]; 175 struct zone_rctlvaltab *zone_rctlval_next; 176 }; 177 178 struct zone_rctltab { 179 char zone_rctl_name[MAXNAMELEN]; 180 struct zone_rctlvaltab *zone_rctl_valptr; 181 }; 182 183 struct zone_attrtab { 184 char zone_attr_name[MAXNAMELEN]; 185 char zone_attr_type[MAXNAMELEN]; 186 char zone_attr_value[2 * BUFSIZ]; 187 }; 188 189 struct zone_dstab { 190 char zone_dataset_name[MAXNAMELEN]; 191 }; 192 193 struct zone_pkgtab { 194 char zone_pkg_name[MAXNAMELEN]; 195 char zone_pkg_version[ZONE_PKG_VERSMAX]; 196 }; 197 198 struct zone_patchtab { 199 char zone_patch_id[MAXNAMELEN]; 200 }; 201 202 struct zone_devpermtab { 203 char zone_devperm_name[MAXPATHLEN]; 204 uid_t zone_devperm_uid; 205 gid_t zone_devperm_gid; 206 mode_t zone_devperm_mode; 207 char *zone_devperm_acl; 208 }; 209 210 /* 211 * Basic configuration management routines. 212 */ 213 extern zone_dochandle_t zonecfg_init_handle(void); 214 extern int zonecfg_get_handle(const char *, zone_dochandle_t); 215 extern int zonecfg_get_snapshot_handle(const char *, zone_dochandle_t); 216 extern int zonecfg_get_template_handle(const char *, const char *, 217 zone_dochandle_t); 218 extern int zonecfg_get_xml_handle(const char *, zone_dochandle_t); 219 extern int zonecfg_check_handle(zone_dochandle_t); 220 extern void zonecfg_fini_handle(zone_dochandle_t); 221 extern int zonecfg_destroy(const char *, boolean_t); 222 extern int zonecfg_destroy_snapshot(const char *); 223 extern int zonecfg_save(zone_dochandle_t); 224 extern int zonecfg_create_snapshot(const char *); 225 extern char *zonecfg_strerror(int); 226 extern int zonecfg_access(const char *, int); 227 extern void zonecfg_set_root(const char *); 228 extern const char *zonecfg_get_root(void); 229 extern boolean_t zonecfg_in_alt_root(void); 230 231 /* 232 * Zone name, path to zone directory, autoboot setting, pool and boot 233 * arguments. 234 */ 235 extern int zonecfg_validate_zonename(const char *); 236 extern int zonecfg_get_name(zone_dochandle_t, char *, size_t); 237 extern int zonecfg_set_name(zone_dochandle_t, char *); 238 extern int zonecfg_get_zonepath(zone_dochandle_t, char *, size_t); 239 extern int zonecfg_set_zonepath(zone_dochandle_t, char *); 240 extern int zonecfg_get_autoboot(zone_dochandle_t, boolean_t *); 241 extern int zonecfg_set_autoboot(zone_dochandle_t, boolean_t); 242 extern int zonecfg_get_pool(zone_dochandle_t, char *, size_t); 243 extern int zonecfg_set_pool(zone_dochandle_t, char *); 244 extern int zonecfg_get_bootargs(zone_dochandle_t, char *, size_t); 245 extern int zonecfg_set_bootargs(zone_dochandle_t, char *); 246 247 /* 248 * Set/retrieve the brand for the zone 249 */ 250 extern int zonecfg_get_brand(zone_dochandle_t, char *, size_t); 251 extern int zonecfg_set_brand(zone_dochandle_t, char *); 252 253 /* 254 * Filesystem configuration. 255 */ 256 extern int zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *); 257 extern int zonecfg_delete_filesystem(zone_dochandle_t, 258 struct zone_fstab *); 259 extern int zonecfg_modify_filesystem(zone_dochandle_t, 260 struct zone_fstab *, struct zone_fstab *); 261 extern int zonecfg_lookup_filesystem(zone_dochandle_t, 262 struct zone_fstab *); 263 extern int zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *); 264 extern int zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *); 265 extern int zonecfg_modify_ipd(zone_dochandle_t, 266 struct zone_fstab *, struct zone_fstab *); 267 extern int zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *); 268 extern int zonecfg_add_fs_option(struct zone_fstab *, char *); 269 extern int zonecfg_remove_fs_option(struct zone_fstab *, char *); 270 extern void zonecfg_free_fs_option_list(zone_fsopt_t *); 271 extern int zonecfg_find_mounts(char *, int(*)(const char *, void *), 272 void *); 273 274 /* 275 * Network interface configuration. 276 */ 277 extern int zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *); 278 extern int zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *); 279 extern int zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *, 280 struct zone_nwiftab *); 281 extern int zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *); 282 283 /* 284 * Device configuration and rule matching. 285 */ 286 extern int zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *); 287 extern int zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *); 288 extern int zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *, 289 struct zone_devtab *); 290 extern int zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *); 291 292 /* 293 * Resource control configuration. 294 */ 295 extern int zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *); 296 extern int zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *); 297 extern int zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *, 298 struct zone_rctltab *); 299 extern int zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *); 300 extern int zonecfg_add_rctl_value(struct zone_rctltab *, 301 struct zone_rctlvaltab *); 302 extern int zonecfg_remove_rctl_value(struct zone_rctltab *, 303 struct zone_rctlvaltab *); 304 extern void zonecfg_free_rctl_value_list(struct zone_rctlvaltab *); 305 306 /* 307 * Generic attribute configuration and type/value extraction. 308 */ 309 extern int zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *); 310 extern int zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *); 311 extern int zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *, 312 struct zone_attrtab *); 313 extern int zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *); 314 extern int zonecfg_get_attr_boolean(const struct zone_attrtab *, 315 boolean_t *); 316 extern int zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *); 317 extern int zonecfg_get_attr_string(const struct zone_attrtab *, char *, 318 size_t); 319 extern int zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *); 320 321 /* 322 * ZFS configuration. 323 */ 324 extern int zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *); 325 extern int zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *); 326 extern int zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *, 327 struct zone_dstab *); 328 extern int zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *); 329 330 /* 331 * attach/detach support. 332 */ 333 extern int zonecfg_get_attach_handle(const char *, const char *, 334 boolean_t, zone_dochandle_t); 335 extern int zonecfg_attach_manifest(int, zone_dochandle_t, 336 zone_dochandle_t); 337 extern int zonecfg_detach_save(zone_dochandle_t, uint_t); 338 extern int zonecfg_get_detach_info(zone_dochandle_t, boolean_t); 339 extern boolean_t zonecfg_detached(const char *); 340 extern void zonecfg_rm_detached(zone_dochandle_t, boolean_t forced); 341 extern int zonecfg_devwalk(zone_dochandle_t handle, 342 int (*cb)(const char *, uid_t, gid_t, mode_t, const char *, void *), 343 void *data); 344 extern int zonecfg_devperms_apply(zone_dochandle_t, const char *, 345 uid_t, gid_t, mode_t, const char *); 346 347 /* 348 * External zone verification support. 349 */ 350 extern int zonecfg_verify_save(zone_dochandle_t, char *); 351 352 /* 353 * '*ent' iterator routines. 354 */ 355 extern int zonecfg_setfsent(zone_dochandle_t); 356 extern int zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *); 357 extern int zonecfg_endfsent(zone_dochandle_t); 358 extern int zonecfg_setipdent(zone_dochandle_t); 359 extern int zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *); 360 extern int zonecfg_endipdent(zone_dochandle_t); 361 extern int zonecfg_setnwifent(zone_dochandle_t); 362 extern int zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *); 363 extern int zonecfg_endnwifent(zone_dochandle_t); 364 extern int zonecfg_setdevent(zone_dochandle_t); 365 extern int zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *); 366 extern int zonecfg_enddevent(zone_dochandle_t); 367 extern int zonecfg_setattrent(zone_dochandle_t); 368 extern int zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *); 369 extern int zonecfg_endattrent(zone_dochandle_t); 370 extern int zonecfg_setrctlent(zone_dochandle_t); 371 extern int zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *); 372 extern int zonecfg_endrctlent(zone_dochandle_t); 373 extern int zonecfg_setdsent(zone_dochandle_t); 374 extern int zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *); 375 extern int zonecfg_enddsent(zone_dochandle_t); 376 extern int zonecfg_setpkgent(zone_dochandle_t); 377 extern int zonecfg_getpkgent(zone_dochandle_t, struct zone_pkgtab *); 378 extern int zonecfg_endpkgent(zone_dochandle_t); 379 extern int zonecfg_setpatchent(zone_dochandle_t); 380 extern int zonecfg_getpatchent(zone_dochandle_t, struct zone_patchtab *); 381 extern int zonecfg_endpatchent(zone_dochandle_t); 382 extern int zonecfg_setdevperment(zone_dochandle_t); 383 extern int zonecfg_getdevperment(zone_dochandle_t, 384 struct zone_devpermtab *); 385 extern int zonecfg_enddevperment(zone_dochandle_t); 386 387 /* 388 * Privilege-related functions. 389 */ 390 extern int zonecfg_default_privset(priv_set_t *); 391 extern int zonecfg_get_privset(zone_dochandle_t, priv_set_t *, 392 char **); 393 extern int zonecfg_get_limitpriv(zone_dochandle_t, char **); 394 extern int zonecfg_set_limitpriv(zone_dochandle_t, char *); 395 396 /* 397 * Higher-level routines. 398 */ 399 extern int zone_get_brand(char *, char *, size_t); 400 extern int zone_get_rootpath(char *, char *, size_t); 401 extern int zone_get_devroot(char *, char *, size_t); 402 extern int zone_get_zonepath(char *, char *, size_t); 403 extern int zone_get_state(char *, zone_state_t *); 404 extern int zone_set_state(char *, zone_state_t); 405 extern char *zone_state_str(zone_state_t); 406 extern int zonecfg_get_name_by_uuid(const uuid_t, char *, size_t); 407 extern int zonecfg_get_uuid(const char *, uuid_t); 408 409 /* 410 * Iterator for configured zones. 411 */ 412 extern FILE *setzoneent(void); 413 extern char *getzoneent(FILE *); 414 extern struct zoneent *getzoneent_private(FILE *); 415 extern void endzoneent(FILE *); 416 417 /* 418 * File-system-related convenience functions. 419 */ 420 extern boolean_t zonecfg_valid_fs_type(const char *); 421 422 /* 423 * Network-related convenience functions. 424 */ 425 extern boolean_t zonecfg_same_net_address(char *, char *); 426 extern int zonecfg_valid_net_address(char *, struct lifreq *); 427 428 /* 429 * Rctl-related common functions. 430 */ 431 extern boolean_t zonecfg_is_rctl(const char *); 432 extern boolean_t zonecfg_valid_rctlname(const char *); 433 extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *); 434 extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *); 435 extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *, 436 rctlblk_t *); 437 438 /* 439 * Live Upgrade support functions. Shared between ON and install gate. 440 */ 441 extern FILE *zonecfg_open_scratch(const char *, boolean_t); 442 extern int zonecfg_lock_scratch(FILE *); 443 extern void zonecfg_close_scratch(FILE *); 444 extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *, 445 size_t); 446 extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *, 447 size_t); 448 extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t, 449 char *, size_t); 450 extern int zonecfg_add_scratch(FILE *, const char *, const char *, 451 const char *); 452 extern int zonecfg_delete_scratch(FILE *, const char *); 453 extern boolean_t zonecfg_is_scratch(const char *); 454 455 #ifdef __cplusplus 456 } 457 #endif 458 459 #endif /* _LIBZONECFG_H */ 460