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 /* The maximum length of the VERSION string in the pkginfo(4) file. */ 114 #define ZONE_PKG_VERSMAX 256 115 116 /* 117 * Bit flag definitions for passing into libzonecfg functions. 118 */ 119 #define ZONE_DRY_RUN 0x01 120 121 /* 122 * The integer field expresses the current values on a get. 123 * On a put, it represents the new values if >= 0 or "don't change" if < 0. 124 */ 125 struct zoneent { 126 char zone_name[ZONENAME_MAX]; /* name of the zone */ 127 int zone_state; /* configured | incomplete | installed */ 128 char zone_path[MAXPATHLEN]; /* path to zone storage */ 129 uuid_t zone_uuid; /* unique ID for zone */ 130 char zone_newname[ZONENAME_MAX]; /* for doing renames */ 131 }; 132 133 typedef struct zone_dochandle *zone_dochandle_t; /* opaque handle */ 134 135 typedef uint_t zone_state_t; 136 137 typedef struct zone_fsopt { 138 struct zone_fsopt *zone_fsopt_next; 139 char zone_fsopt_opt[MAX_MNTOPT_STR]; 140 } zone_fsopt_t; 141 142 struct zone_fstab { 143 char zone_fs_special[MAXPATHLEN]; /* special file */ 144 char zone_fs_dir[MAXPATHLEN]; /* mount point */ 145 char zone_fs_type[FSTYPSZ]; /* e.g. ufs */ 146 zone_fsopt_t *zone_fs_options; /* mount options */ 147 char zone_fs_raw[MAXPATHLEN]; /* device to fsck */ 148 }; 149 150 struct zone_nwiftab { 151 char zone_nwif_address[INET6_ADDRSTRLEN]; 152 char zone_nwif_physical[LIFNAMSIZ]; 153 }; 154 155 struct zone_devtab { 156 char zone_dev_match[MAXPATHLEN]; 157 }; 158 159 struct zone_rctlvaltab { 160 char zone_rctlval_priv[MAXNAMELEN]; 161 char zone_rctlval_limit[MAXNAMELEN]; 162 char zone_rctlval_action[MAXNAMELEN]; 163 struct zone_rctlvaltab *zone_rctlval_next; 164 }; 165 166 struct zone_rctltab { 167 char zone_rctl_name[MAXNAMELEN]; 168 struct zone_rctlvaltab *zone_rctl_valptr; 169 }; 170 171 struct zone_attrtab { 172 char zone_attr_name[MAXNAMELEN]; 173 char zone_attr_type[MAXNAMELEN]; 174 char zone_attr_value[2 * BUFSIZ]; 175 }; 176 177 struct zone_dstab { 178 char zone_dataset_name[MAXNAMELEN]; 179 }; 180 181 struct zone_pkgtab { 182 char zone_pkg_name[MAXNAMELEN]; 183 char zone_pkg_version[ZONE_PKG_VERSMAX]; 184 }; 185 186 struct zone_patchtab { 187 char zone_patch_id[MAXNAMELEN]; 188 }; 189 190 struct zone_devpermtab { 191 char zone_devperm_name[MAXPATHLEN]; 192 uid_t zone_devperm_uid; 193 gid_t zone_devperm_gid; 194 mode_t zone_devperm_mode; 195 char *zone_devperm_acl; 196 }; 197 198 /* 199 * Basic configuration management routines. 200 */ 201 extern zone_dochandle_t zonecfg_init_handle(void); 202 extern int zonecfg_get_handle(const char *, zone_dochandle_t); 203 extern int zonecfg_get_snapshot_handle(const char *, zone_dochandle_t); 204 extern int zonecfg_get_template_handle(const char *, const char *, 205 zone_dochandle_t); 206 extern int zonecfg_check_handle(zone_dochandle_t); 207 extern void zonecfg_fini_handle(zone_dochandle_t); 208 extern int zonecfg_destroy(const char *, boolean_t); 209 extern int zonecfg_destroy_snapshot(const char *); 210 extern int zonecfg_save(zone_dochandle_t); 211 extern int zonecfg_create_snapshot(const char *); 212 extern char *zonecfg_strerror(int); 213 extern int zonecfg_access(const char *, int); 214 extern void zonecfg_set_root(const char *); 215 extern const char *zonecfg_get_root(void); 216 extern boolean_t zonecfg_in_alt_root(void); 217 218 /* 219 * Zone name, path to zone directory, autoboot setting and pool. 220 */ 221 extern int zonecfg_validate_zonename(const char *); 222 extern int zonecfg_get_name(zone_dochandle_t, char *, size_t); 223 extern int zonecfg_set_name(zone_dochandle_t, char *); 224 extern int zonecfg_get_zonepath(zone_dochandle_t, char *, size_t); 225 extern int zonecfg_set_zonepath(zone_dochandle_t, char *); 226 extern int zonecfg_get_autoboot(zone_dochandle_t, boolean_t *); 227 extern int zonecfg_set_autoboot(zone_dochandle_t, boolean_t); 228 extern int zonecfg_get_pool(zone_dochandle_t, char *, size_t); 229 extern int zonecfg_set_pool(zone_dochandle_t, char *); 230 231 /* 232 * Filesystem configuration. 233 */ 234 extern int zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *); 235 extern int zonecfg_delete_filesystem(zone_dochandle_t, 236 struct zone_fstab *); 237 extern int zonecfg_modify_filesystem(zone_dochandle_t, 238 struct zone_fstab *, struct zone_fstab *); 239 extern int zonecfg_lookup_filesystem(zone_dochandle_t, 240 struct zone_fstab *); 241 extern int zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *); 242 extern int zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *); 243 extern int zonecfg_modify_ipd(zone_dochandle_t, 244 struct zone_fstab *, struct zone_fstab *); 245 extern int zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *); 246 extern int zonecfg_add_fs_option(struct zone_fstab *, char *); 247 extern int zonecfg_remove_fs_option(struct zone_fstab *, char *); 248 extern void zonecfg_free_fs_option_list(zone_fsopt_t *); 249 extern int zonecfg_find_mounts(char *, int(*)(const char *, void *), 250 void *); 251 252 /* 253 * Network interface configuration. 254 */ 255 extern int zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *); 256 extern int zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *); 257 extern int zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *, 258 struct zone_nwiftab *); 259 extern int zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *); 260 261 /* 262 * Device configuration and rule matching. 263 */ 264 extern int zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *); 265 extern int zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *); 266 extern int zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *, 267 struct zone_devtab *); 268 extern int zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *); 269 extern int zonecfg_match_dev(zone_dochandle_t, char *, 270 struct zone_devtab *); 271 272 /* 273 * Resource control configuration. 274 */ 275 extern int zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *); 276 extern int zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *); 277 extern int zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *, 278 struct zone_rctltab *); 279 extern int zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *); 280 extern int zonecfg_add_rctl_value(struct zone_rctltab *, 281 struct zone_rctlvaltab *); 282 extern int zonecfg_remove_rctl_value(struct zone_rctltab *, 283 struct zone_rctlvaltab *); 284 extern void zonecfg_free_rctl_value_list(struct zone_rctlvaltab *); 285 286 /* 287 * Generic attribute configuration and type/value extraction. 288 */ 289 extern int zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *); 290 extern int zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *); 291 extern int zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *, 292 struct zone_attrtab *); 293 extern int zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *); 294 extern int zonecfg_get_attr_boolean(const struct zone_attrtab *, 295 boolean_t *); 296 extern int zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *); 297 extern int zonecfg_get_attr_string(const struct zone_attrtab *, char *, 298 size_t); 299 extern int zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *); 300 301 /* 302 * ZFS configuration. 303 */ 304 extern int zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *); 305 extern int zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *); 306 extern int zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *, 307 struct zone_dstab *); 308 extern int zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *); 309 310 /* 311 * attach/detach support. 312 */ 313 extern int zonecfg_get_attach_handle(const char *, const char *, 314 boolean_t, zone_dochandle_t); 315 extern int zonecfg_attach_manifest(int, zone_dochandle_t, 316 zone_dochandle_t); 317 extern int zonecfg_detach_save(zone_dochandle_t, uint_t); 318 extern int zonecfg_get_detach_info(zone_dochandle_t, boolean_t); 319 extern boolean_t zonecfg_detached(const char *); 320 extern void zonecfg_rm_detached(zone_dochandle_t, boolean_t forced); 321 extern int zonecfg_devwalk(zone_dochandle_t handle, 322 int (*cb)(const char *, uid_t, gid_t, mode_t, const char *, void *), 323 void *data); 324 extern int zonecfg_devperms_apply(zone_dochandle_t, const char *, 325 uid_t, gid_t, mode_t, const char *); 326 327 328 /* 329 * '*ent' iterator routines. 330 */ 331 extern int zonecfg_setfsent(zone_dochandle_t); 332 extern int zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *); 333 extern int zonecfg_endfsent(zone_dochandle_t); 334 extern int zonecfg_setipdent(zone_dochandle_t); 335 extern int zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *); 336 extern int zonecfg_endipdent(zone_dochandle_t); 337 extern int zonecfg_setnwifent(zone_dochandle_t); 338 extern int zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *); 339 extern int zonecfg_endnwifent(zone_dochandle_t); 340 extern int zonecfg_setdevent(zone_dochandle_t); 341 extern int zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *); 342 extern int zonecfg_enddevent(zone_dochandle_t); 343 extern int zonecfg_setattrent(zone_dochandle_t); 344 extern int zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *); 345 extern int zonecfg_endattrent(zone_dochandle_t); 346 extern int zonecfg_setrctlent(zone_dochandle_t); 347 extern int zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *); 348 extern int zonecfg_endrctlent(zone_dochandle_t); 349 extern int zonecfg_setdsent(zone_dochandle_t); 350 extern int zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *); 351 extern int zonecfg_enddsent(zone_dochandle_t); 352 extern int zonecfg_setpkgent(zone_dochandle_t); 353 extern int zonecfg_getpkgent(zone_dochandle_t, struct zone_pkgtab *); 354 extern int zonecfg_endpkgent(zone_dochandle_t); 355 extern int zonecfg_setpatchent(zone_dochandle_t); 356 extern int zonecfg_getpatchent(zone_dochandle_t, struct zone_patchtab *); 357 extern int zonecfg_endpatchent(zone_dochandle_t); 358 extern int zonecfg_setdevperment(zone_dochandle_t); 359 extern int zonecfg_getdevperment(zone_dochandle_t, 360 struct zone_devpermtab *); 361 extern int zonecfg_enddevperment(zone_dochandle_t); 362 363 /* 364 * Privilege-related functions. 365 */ 366 extern int zonecfg_default_privset(priv_set_t *); 367 extern int zonecfg_get_privset(zone_dochandle_t, priv_set_t *, 368 char **); 369 extern int zonecfg_get_limitpriv(zone_dochandle_t, char **); 370 extern int zonecfg_set_limitpriv(zone_dochandle_t, char *); 371 372 /* 373 * Higher-level routines. 374 */ 375 extern int zone_get_rootpath(char *, char *, size_t); 376 extern int zone_get_zonepath(char *, char *, size_t); 377 extern int zone_get_state(char *, zone_state_t *); 378 extern int zone_set_state(char *, zone_state_t); 379 extern char *zone_state_str(zone_state_t); 380 extern int zonecfg_get_name_by_uuid(const uuid_t, char *, size_t); 381 extern int zonecfg_get_uuid(const char *, uuid_t); 382 383 /* 384 * Iterator for configured zones. 385 */ 386 extern FILE *setzoneent(void); 387 extern char *getzoneent(FILE *); 388 extern struct zoneent *getzoneent_private(FILE *); 389 extern void endzoneent(FILE *); 390 391 /* 392 * File-system-related convenience functions. 393 */ 394 extern boolean_t zonecfg_valid_fs_type(const char *); 395 396 /* 397 * Network-related convenience functions. 398 */ 399 extern boolean_t zonecfg_same_net_address(char *, char *); 400 extern int zonecfg_valid_net_address(char *, struct lifreq *); 401 402 /* 403 * Rctl-related common functions. 404 */ 405 extern boolean_t zonecfg_is_rctl(const char *); 406 extern boolean_t zonecfg_valid_rctlname(const char *); 407 extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *); 408 extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *); 409 extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *, 410 rctlblk_t *); 411 412 /* 413 * Live Upgrade support functions. Shared between ON and install gate. 414 */ 415 extern FILE *zonecfg_open_scratch(const char *, boolean_t); 416 extern int zonecfg_lock_scratch(FILE *); 417 extern void zonecfg_close_scratch(FILE *); 418 extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *, 419 size_t); 420 extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *, 421 size_t); 422 extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t, 423 char *, size_t); 424 extern int zonecfg_add_scratch(FILE *, const char *, const char *, 425 const char *); 426 extern int zonecfg_delete_scratch(FILE *, const char *); 427 extern boolean_t zonecfg_is_scratch(const char *); 428 429 #ifdef __cplusplus 430 } 431 #endif 432 433 #endif /* _LIBZONECFG_H */ 434