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