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 (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  */
  25 
  26 #ifndef _LIBZONECFG_H
  27 #define _LIBZONECFG_H
  28 
  29 /*
  30  * Zone configuration header file.
  31  */
  32 
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36 
  37 /* sys/socket.h is required by net/if.h, which has a constant needed here */
  38 #include <sys/param.h>
  39 #include <sys/fstyp.h>
  40 #include <sys/mount.h>
  41 #include <priv.h>
  42 #include <netinet/in.h>
  43 #include <sys/socket.h>
  44 #include <net/if.h>
  45 #include <stdio.h>
  46 #include <rctl.h>
  47 #include <zone.h>
  48 #include <libbrand.h>
  49 #include <sys/uuid.h>
  50 #include <libuutil.h>
  51 #include <sys/mnttab.h>
  52 #include <limits.h>
  53 #include <utmpx.h>
  54 
  55 #define ZONE_ID_UNDEFINED       -1
  56 
  57 #define Z_OK                    0
  58 #define Z_EMPTY_DOCUMENT        1       /* XML doc root element is null */
  59 #define Z_WRONG_DOC_TYPE        2       /* top-level XML doc element != zone */
  60 #define Z_BAD_PROPERTY          3       /* libxml-level property problem */
  61 #define Z_TEMP_FILE             4       /* problem creating temporary file */
  62 #define Z_SAVING_FILE           5       /* libxml error saving or validating */
  63 #define Z_NO_ENTRY              6       /* no such entry */
  64 #define Z_BOGUS_ZONE_NAME       7       /* illegal zone name */
  65 #define Z_REQD_RESOURCE_MISSING 8       /* required resource missing */
  66 #define Z_REQD_PROPERTY_MISSING 9       /* required property missing */
  67 #define Z_BAD_HANDLE            10      /* bad document handle */
  68 #define Z_NOMEM                 11      /* out of memory (like ENOMEM) */
  69 #define Z_INVAL                 12      /* invalid argument (like EINVAL) */
  70 #define Z_ACCES                 13      /* permission denied (like EACCES) */
  71 #define Z_TOO_BIG               14      /* string won't fit in char array */
  72 #define Z_MISC_FS               15      /* miscellaneous file-system error */
  73 #define Z_NO_ZONE               16      /* no such zone */
  74 #define Z_NO_RESOURCE_TYPE      17      /* no/wrong resource type */
  75 #define Z_NO_RESOURCE_ID        18      /* no/wrong resource id */
  76 #define Z_NO_PROPERTY_TYPE      19      /* no/wrong property type */
  77 #define Z_NO_PROPERTY_ID        20      /* no/wrong property id */
  78 #define Z_BAD_ZONE_STATE        21      /* zone state invalid for given task */
  79 #define Z_INVALID_DOCUMENT      22      /* libxml can't validate against DTD */
  80 #define Z_NAME_IN_USE           23      /* zone name already in use (rename) */
  81 #define Z_NO_SUCH_ID            24      /* delete_index: no old ID */
  82 #define Z_UPDATING_INDEX        25      /* add/modify/delete_index problem */
  83 #define Z_LOCKING_FILE          26      /* problem locking index file */
  84 #define Z_UNLOCKING_FILE        27      /* problem unlocking index file */
  85 #define Z_SYSTEM                28      /* consult errno instead */
  86 #define Z_INSUFFICIENT_SPEC     29      /* resource insufficiently specified */
  87 #define Z_RESOLVED_PATH         34      /* resolved path mismatch */
  88 #define Z_IPV6_ADDR_PREFIX_LEN  35      /* IPv6 address prefix length needed */
  89 #define Z_BOGUS_ADDRESS         36      /* not IPv[4|6] address or host name */
  90 #define Z_PRIV_PROHIBITED       37      /* specified privilege is prohibited */
  91 #define Z_PRIV_REQUIRED         38      /* required privilege is missing */
  92 #define Z_PRIV_UNKNOWN          39      /* specified privilege is unknown */
  93 #define Z_BRAND_ERROR           40      /* brand-specific error */
  94 #define Z_INCOMPATIBLE          41      /* incompatible settings */
  95 #define Z_ALIAS_DISALLOW        42      /* rctl alias disallowed */
  96 #define Z_CLEAR_DISALLOW        43      /* clear property disallowed */
  97 #define Z_POOL                  44      /* generic libpool error */
  98 #define Z_POOLS_NOT_ACTIVE      45      /* pool service not enabled */
  99 #define Z_POOL_ENABLE           46      /* pools enable failed */
 100 #define Z_NO_POOL               47      /* no such pool configured */
 101 #define Z_POOL_CREATE           48      /* pool create failed */
 102 #define Z_POOL_BIND             49      /* pool bind failed */
 103 #define Z_INVALID_PROPERTY      50      /* invalid property value */
 104 
 105 /*
 106  * Warning: these are shared with the admin/install consolidation.
 107  * Do not insert states between any of the currently defined states,
 108  * and any new states must be evaluated for impact on range comparisons.
 109  */
 110 #define ZONE_STATE_CONFIGURED           0
 111 #define ZONE_STATE_INCOMPLETE           1
 112 #define ZONE_STATE_INSTALLED            2
 113 #define ZONE_STATE_READY                3
 114 #define ZONE_STATE_RUNNING              4
 115 #define ZONE_STATE_SHUTTING_DOWN        5
 116 #define ZONE_STATE_DOWN                 6
 117 #define ZONE_STATE_MOUNTED              7
 118 
 119 #define ZONE_STATE_MAXSTRLEN    14
 120 
 121 #define LIBZONECFG_PATH         "libzonecfg.so.1"
 122 
 123 #define ZONE_CONFIG_ROOT        "/etc/zones"
 124 #define ZONE_INDEX_FILE         ZONE_CONFIG_ROOT "/index"
 125 
 126 #define MAXUSERNAME             (sizeof (((struct utmpx *)0)->ut_name))
 127 #define MAXAUTHS                4096
 128 #define ZONE_MGMT_PROF          "Zone Management"
 129 
 130 /* Owner, group, and mode (defined by packaging) for the config directory */
 131 #define ZONE_CONFIG_UID         0               /* root */
 132 #define ZONE_CONFIG_GID         3               /* sys */
 133 #define ZONE_CONFIG_MODE        0755
 134 
 135 /* Owner, group, and mode (defined by packaging) for the index file */
 136 #define ZONE_INDEX_UID          0               /* root */
 137 #define ZONE_INDEX_GID          3               /* sys */
 138 #define ZONE_INDEX_MODE         0644
 139 
 140 /* The maximum length of the VERSION string in the pkginfo(4) file. */
 141 #define ZONE_PKG_VERSMAX        256
 142 
 143 /*
 144  * Shortened alias names for the zones rctls.
 145  */
 146 #define ALIAS_MAXLWPS           "max-lwps"
 147 #define ALIAS_MAXSHMMEM         "max-shm-memory"
 148 #define ALIAS_MAXSHMIDS         "max-shm-ids"
 149 #define ALIAS_MAXMSGIDS         "max-msg-ids"
 150 #define ALIAS_MAXSEMIDS         "max-sem-ids"
 151 #define ALIAS_MAXLOCKEDMEM      "locked"
 152 #define ALIAS_MAXSWAP           "swap"
 153 #define ALIAS_MAXPHYSMEM        "physical"
 154 #define ALIAS_SHARES            "cpu-shares"
 155 #define ALIAS_CPUCAP            "cpu-cap"
 156 #define ALIAS_MAXPROCS          "max-processes"
 157 
 158 /* Default name for zone detached manifest */
 159 #define ZONE_DETACHED   "SUNWdetached.xml"
 160 
 161 /*
 162  * Bit flag definitions for passing into libzonecfg functions.
 163  */
 164 #define ZONE_DRY_RUN            0x01
 165 
 166 /*
 167  * The integer field expresses the current values on a get.
 168  * On a put, it represents the new values if >= 0 or "don't change" if < 0.
 169  */
 170 struct zoneent {
 171         char    zone_name[ZONENAME_MAX];        /* name of the zone */
 172         int     zone_state;     /* configured | incomplete | installed */
 173         char    zone_path[MAXPATHLEN];          /* path to zone storage */
 174         uuid_t  zone_uuid;                      /* unique ID for zone */
 175         char    zone_newname[ZONENAME_MAX];     /* for doing renames */
 176 };
 177 
 178 typedef struct zone_dochandle *zone_dochandle_t;        /* opaque handle */
 179 
 180 typedef uint_t zone_state_t;
 181 
 182 typedef struct zone_fsopt {
 183         struct zone_fsopt *zone_fsopt_next;
 184         char               zone_fsopt_opt[MAX_MNTOPT_STR];
 185 } zone_fsopt_t;
 186 
 187 struct zone_fstab {
 188         char            zone_fs_special[MAXPATHLEN];    /* special file */
 189         char            zone_fs_dir[MAXPATHLEN];        /* mount point */
 190         char            zone_fs_type[FSTYPSZ];          /* e.g. ufs */
 191         zone_fsopt_t   *zone_fs_options;                /* mount options */
 192         char            zone_fs_raw[MAXPATHLEN];        /* device to fsck */
 193 };
 194 
 195 struct zone_nwiftab {
 196         char    zone_nwif_address[INET6_ADDRSTRLEN]; /* shared-ip only */
 197         char    zone_nwif_allowed_address[INET6_ADDRSTRLEN]; /* excl-ip only */
 198         char    zone_nwif_physical[LIFNAMSIZ];
 199         char    zone_nwif_defrouter[INET6_ADDRSTRLEN];
 200 };
 201 
 202 struct zone_devtab {
 203         char    zone_dev_match[MAXPATHLEN];
 204 };
 205 
 206 struct zone_rctlvaltab {
 207         char    zone_rctlval_priv[MAXNAMELEN];
 208         char    zone_rctlval_limit[MAXNAMELEN];
 209         char    zone_rctlval_action[MAXNAMELEN];
 210         struct zone_rctlvaltab *zone_rctlval_next;
 211 };
 212 
 213 struct zone_rctltab {
 214         char    zone_rctl_name[MAXNAMELEN];
 215         struct zone_rctlvaltab *zone_rctl_valptr;
 216 };
 217 
 218 struct zone_attrtab {
 219         char    zone_attr_name[MAXNAMELEN];
 220         char    zone_attr_type[MAXNAMELEN];
 221         char    zone_attr_value[2 * BUFSIZ];
 222 };
 223 
 224 struct zone_dstab {
 225         char    zone_dataset_name[MAXNAMELEN];
 226 };
 227 
 228 struct zone_psettab {
 229         char    zone_ncpu_min[MAXNAMELEN];
 230         char    zone_ncpu_max[MAXNAMELEN];
 231         char    zone_importance[MAXNAMELEN];
 232 };
 233 
 234 struct zone_pkgtab {
 235         char    zone_pkg_name[MAXNAMELEN];
 236         char    zone_pkg_version[ZONE_PKG_VERSMAX];
 237 };
 238 
 239 struct zone_devpermtab {
 240         char    zone_devperm_name[MAXPATHLEN];
 241         uid_t   zone_devperm_uid;
 242         gid_t   zone_devperm_gid;
 243         mode_t  zone_devperm_mode;
 244         char    *zone_devperm_acl;
 245 };
 246 
 247 struct zone_admintab {
 248         char    zone_admin_user[MAXUSERNAME];
 249         char    zone_admin_auths[MAXAUTHS];
 250 };
 251 
 252 typedef struct zone_userauths {
 253         char                    user[MAXUSERNAME];
 254         char                    zonename[ZONENAME_MAX];
 255         struct zone_userauths   *next;
 256 } zone_userauths_t;
 257 
 258 typedef struct {
 259         uu_avl_node_t   zpe_entry;
 260         char            *zpe_name;
 261         char            *zpe_vers;
 262 } zone_pkg_entry_t;
 263 
 264 typedef enum zone_iptype {
 265         ZS_SHARED,
 266         ZS_EXCLUSIVE
 267 } zone_iptype_t;
 268 
 269 /*
 270  * Basic configuration management routines.
 271  */
 272 extern  zone_dochandle_t        zonecfg_init_handle(void);
 273 extern  int     zonecfg_get_handle(const char *, zone_dochandle_t);
 274 extern  int     zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
 275 extern  int     zonecfg_get_template_handle(const char *, const char *,
 276     zone_dochandle_t);
 277 extern  int     zonecfg_get_xml_handle(const char *, zone_dochandle_t);
 278 extern  int     zonecfg_check_handle(zone_dochandle_t);
 279 extern  void    zonecfg_fini_handle(zone_dochandle_t);
 280 extern  int     zonecfg_destroy(const char *, boolean_t);
 281 extern  int     zonecfg_destroy_snapshot(const char *);
 282 extern  int     zonecfg_save(zone_dochandle_t);
 283 extern  int     zonecfg_create_snapshot(const char *);
 284 extern  char    *zonecfg_strerror(int);
 285 extern  int     zonecfg_access(const char *, int);
 286 extern  void    zonecfg_set_root(const char *);
 287 extern  const char *zonecfg_get_root(void);
 288 extern  boolean_t zonecfg_in_alt_root(void);
 289 extern  int     zonecfg_num_resources(zone_dochandle_t, char *);
 290 extern  int     zonecfg_del_all_resources(zone_dochandle_t, char *);
 291 extern  boolean_t zonecfg_valid_ncpus(char *, char *);
 292 extern  boolean_t zonecfg_valid_importance(char *);
 293 extern  int     zonecfg_str_to_bytes(char *, uint64_t *);
 294 extern  boolean_t zonecfg_valid_memlimit(char *, uint64_t *);
 295 extern  boolean_t zonecfg_valid_alias_limit(char *, char *, uint64_t *);
 296 
 297 /*
 298  * Zone name, path to zone directory, autoboot setting, pool, boot
 299  * arguments, and scheduling-class.
 300  */
 301 extern  int     zonecfg_validate_zonename(const char *);
 302 extern  int     zonecfg_get_name(zone_dochandle_t, char *, size_t);
 303 extern  int     zonecfg_set_name(zone_dochandle_t, char *);
 304 extern  int     zonecfg_get_zonepath(zone_dochandle_t, char *, size_t);
 305 extern  int     zonecfg_set_zonepath(zone_dochandle_t, char *);
 306 extern  int     zonecfg_get_autoboot(zone_dochandle_t, boolean_t *);
 307 extern  int     zonecfg_set_autoboot(zone_dochandle_t, boolean_t);
 308 extern  int     zonecfg_get_iptype(zone_dochandle_t, zone_iptype_t *);
 309 extern  int     zonecfg_set_iptype(zone_dochandle_t, zone_iptype_t);
 310 extern  int     zonecfg_get_pool(zone_dochandle_t, char *, size_t);
 311 extern  int     zonecfg_set_pool(zone_dochandle_t, char *);
 312 extern  int     zonecfg_get_bootargs(zone_dochandle_t, char *, size_t);
 313 extern  int     zonecfg_set_bootargs(zone_dochandle_t, char *);
 314 extern  int     zonecfg_get_sched_class(zone_dochandle_t, char *, size_t);
 315 extern  int     zonecfg_set_sched(zone_dochandle_t, char *);
 316 extern  int     zonecfg_get_dflt_sched_class(zone_dochandle_t, char *, int);
 317 
 318 /*
 319  * Set/retrieve the brand for the zone
 320  */
 321 extern  int     zonecfg_get_brand(zone_dochandle_t, char *, size_t);
 322 extern  int     zonecfg_set_brand(zone_dochandle_t, char *);
 323 
 324 /*
 325  * Filesystem configuration.
 326  */
 327 extern  int     zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *);
 328 extern  int     zonecfg_delete_filesystem(zone_dochandle_t,
 329     struct zone_fstab *);
 330 extern  int     zonecfg_modify_filesystem(zone_dochandle_t,
 331     struct zone_fstab *, struct zone_fstab *);
 332 extern  int     zonecfg_lookup_filesystem(zone_dochandle_t,
 333     struct zone_fstab *);
 334 extern  int     zonecfg_add_fs_option(struct zone_fstab *, char *);
 335 extern  int     zonecfg_remove_fs_option(struct zone_fstab *, char *);
 336 extern  void    zonecfg_free_fs_option_list(zone_fsopt_t *);
 337 extern  int     zonecfg_find_mounts(char *, int(*)(const struct mnttab *,
 338     void *), void *);
 339 
 340 /*
 341  * Network interface configuration.
 342  */
 343 extern  int     zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *);
 344 extern  int     zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *);
 345 extern  int     zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *,
 346     struct zone_nwiftab *);
 347 extern  int     zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *);
 348 
 349 /*
 350  * Hostid emulation configuration.
 351  */
 352 extern  int     zonecfg_get_hostid(zone_dochandle_t, char *, size_t);
 353 extern  int     zonecfg_set_hostid(zone_dochandle_t, const char *);
 354 
 355 /*
 356  * Allowed FS mounts configuration.
 357  */
 358 extern int      zonecfg_get_fs_allowed(zone_dochandle_t, char *, size_t);
 359 extern int      zonecfg_set_fs_allowed(zone_dochandle_t, const char *);
 360 
 361 /*
 362  * Device configuration and rule matching.
 363  */
 364 extern  int     zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *);
 365 extern  int     zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *);
 366 extern  int     zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *,
 367     struct zone_devtab *);
 368 extern  int     zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *);
 369 
 370 /*
 371  * Resource control configuration.
 372  */
 373 extern  int     zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *);
 374 extern  int     zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *);
 375 extern  int     zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *,
 376     struct zone_rctltab *);
 377 extern  int     zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *);
 378 extern  int     zonecfg_add_rctl_value(struct zone_rctltab *,
 379     struct zone_rctlvaltab *);
 380 extern  int     zonecfg_remove_rctl_value(struct zone_rctltab *,
 381     struct zone_rctlvaltab *);
 382 extern  void    zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
 383 extern  boolean_t zonecfg_aliased_rctl_ok(zone_dochandle_t, char *);
 384 extern  int     zonecfg_set_aliased_rctl(zone_dochandle_t, char *, uint64_t);
 385 extern  int     zonecfg_get_aliased_rctl(zone_dochandle_t, char *, uint64_t *);
 386 extern  int     zonecfg_rm_aliased_rctl(zone_dochandle_t, char *);
 387 extern  int     zonecfg_apply_rctls(char *, zone_dochandle_t);
 388 
 389 /*
 390  * Generic attribute configuration and type/value extraction.
 391  */
 392 extern  int     zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *);
 393 extern  int     zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *);
 394 extern  int     zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *,
 395     struct zone_attrtab *);
 396 extern  int     zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *);
 397 extern  int     zonecfg_get_attr_boolean(const struct zone_attrtab *,
 398     boolean_t *);
 399 extern  int     zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *);
 400 extern  int     zonecfg_get_attr_string(const struct zone_attrtab *, char *,
 401     size_t);
 402 extern  int     zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *);
 403 
 404 /*
 405  * ZFS configuration.
 406  */
 407 extern  int     zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *);
 408 extern  int     zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *);
 409 extern  int     zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *,
 410     struct zone_dstab *);
 411 extern  int     zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *);
 412 
 413 /*
 414  * cpu-set configuration.
 415  */
 416 extern  int     zonecfg_add_pset(zone_dochandle_t, struct zone_psettab *);
 417 extern  int     zonecfg_delete_pset(zone_dochandle_t);
 418 extern  int     zonecfg_modify_pset(zone_dochandle_t, struct zone_psettab *);
 419 extern  int     zonecfg_lookup_pset(zone_dochandle_t, struct zone_psettab *);
 420 
 421 /*
 422  * Temporary pool support functions.
 423  */
 424 extern  int     zonecfg_destroy_tmp_pool(char *, char *, int);
 425 extern  int     zonecfg_bind_tmp_pool(zone_dochandle_t, zoneid_t, char *, int);
 426 extern  int     zonecfg_bind_pool(zone_dochandle_t, zoneid_t, char *, int);
 427 extern  boolean_t zonecfg_warn_poold(zone_dochandle_t);
 428 extern  int     zonecfg_get_poolname(zone_dochandle_t, char *, char *, size_t);
 429 
 430 /*
 431  * Miscellaneous utility functions.
 432  */
 433 extern  int     zonecfg_enable_rcapd(char *, int);
 434 
 435 /*
 436  * attach/detach support.
 437  */
 438 extern  int     zonecfg_get_attach_handle(const char *, const char *,
 439     const char *, boolean_t, zone_dochandle_t);
 440 extern  int     zonecfg_attach_manifest(int, zone_dochandle_t,
 441     zone_dochandle_t);
 442 extern  int     zonecfg_detach_save(zone_dochandle_t, uint_t);
 443 extern  boolean_t zonecfg_detached(const char *);
 444 extern  void    zonecfg_rm_detached(zone_dochandle_t, boolean_t forced);
 445 extern  int     zonecfg_dev_manifest(zone_dochandle_t);
 446 extern  int     zonecfg_devperms_apply(zone_dochandle_t, const char *,
 447     uid_t, gid_t, mode_t, const char *);
 448 extern  void    zonecfg_set_swinv(zone_dochandle_t);
 449 extern  int     zonecfg_add_pkg(zone_dochandle_t, char *, char *);
 450 
 451 /*
 452  * External zone verification support.
 453  */
 454 extern  int     zonecfg_verify_save(zone_dochandle_t, char *);
 455 
 456 /*
 457  * '*ent' iterator routines.
 458  */
 459 extern  int     zonecfg_setfsent(zone_dochandle_t);
 460 extern  int     zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *);
 461 extern  int     zonecfg_endfsent(zone_dochandle_t);
 462 extern  int     zonecfg_setnwifent(zone_dochandle_t);
 463 extern  int     zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *);
 464 extern  int     zonecfg_endnwifent(zone_dochandle_t);
 465 extern  int     zonecfg_setdevent(zone_dochandle_t);
 466 extern  int     zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *);
 467 extern  int     zonecfg_enddevent(zone_dochandle_t);
 468 extern  int     zonecfg_setattrent(zone_dochandle_t);
 469 extern  int     zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *);
 470 extern  int     zonecfg_endattrent(zone_dochandle_t);
 471 extern  int     zonecfg_setrctlent(zone_dochandle_t);
 472 extern  int     zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *);
 473 extern  int     zonecfg_endrctlent(zone_dochandle_t);
 474 extern  int     zonecfg_setdsent(zone_dochandle_t);
 475 extern  int     zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *);
 476 extern  int     zonecfg_enddsent(zone_dochandle_t);
 477 extern  int     zonecfg_getpsetent(zone_dochandle_t, struct zone_psettab *);
 478 extern  int     zonecfg_getpkgdata(zone_dochandle_t, uu_avl_pool_t *,
 479     uu_avl_t *);
 480 extern  int     zonecfg_setdevperment(zone_dochandle_t);
 481 extern  int     zonecfg_getdevperment(zone_dochandle_t,
 482     struct zone_devpermtab *);
 483 extern  int     zonecfg_enddevperment(zone_dochandle_t);
 484 extern  int     zonecfg_setadminent(zone_dochandle_t);
 485 extern  int     zonecfg_getadminent(zone_dochandle_t, struct zone_admintab *);
 486 extern  int     zonecfg_endadminent(zone_dochandle_t);
 487 
 488 /*
 489  * Privilege-related functions.
 490  */
 491 extern  int     zonecfg_default_privset(priv_set_t *, const char *);
 492 extern  int     zonecfg_get_privset(zone_dochandle_t, priv_set_t *,
 493     char **);
 494 extern  int     zonecfg_get_limitpriv(zone_dochandle_t, char **);
 495 extern  int     zonecfg_set_limitpriv(zone_dochandle_t, char *);
 496 
 497 /*
 498  * Higher-level routines.
 499  */
 500 extern  int     zone_get_brand(char *, char *, size_t);
 501 extern  int     zone_get_rootpath(char *, char *, size_t);
 502 extern  int     zone_get_devroot(char *, char *, size_t);
 503 extern  int     zone_get_zonepath(char *, char *, size_t);
 504 extern  int     zone_get_state(char *, zone_state_t *);
 505 extern  int     zone_set_state(char *, zone_state_t);
 506 extern  char    *zone_state_str(zone_state_t);
 507 extern  int     zonecfg_get_name_by_uuid(const uuid_t, char *, size_t);
 508 extern  int     zonecfg_get_uuid(const char *, uuid_t);
 509 extern  int     zonecfg_default_brand(char *, size_t);
 510 extern  int     zonecfg_fix_obsolete(zone_dochandle_t);
 511 
 512 /*
 513  * Iterator for configured zones.
 514  */
 515 extern FILE             *setzoneent(void);
 516 extern char             *getzoneent(FILE *);
 517 extern struct zoneent   *getzoneent_private(FILE *);
 518 extern void             endzoneent(FILE *);
 519 
 520 /*
 521  * File-system-related convenience functions.
 522  */
 523 extern boolean_t zonecfg_valid_fs_type(const char *);
 524 
 525 /*
 526  * Network-related convenience functions.
 527  */
 528 extern boolean_t zonecfg_same_net_address(char *, char *);
 529 extern int zonecfg_valid_net_address(char *, struct lifreq *);
 530 extern boolean_t zonecfg_ifname_exists(sa_family_t, char *);
 531 
 532 /*
 533  * Rctl-related common functions.
 534  */
 535 extern boolean_t zonecfg_is_rctl(const char *);
 536 extern boolean_t zonecfg_valid_rctlname(const char *);
 537 extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *);
 538 extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *);
 539 extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
 540     rctlblk_t *);
 541 
 542 /*
 543  * Live Upgrade support functions.  Shared between ON and install gate.
 544  */
 545 extern FILE *zonecfg_open_scratch(const char *, boolean_t);
 546 extern int zonecfg_lock_scratch(FILE *);
 547 extern void zonecfg_close_scratch(FILE *);
 548 extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *,
 549     size_t);
 550 extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
 551     size_t);
 552 extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t,
 553     char *, size_t);
 554 extern int zonecfg_add_scratch(FILE *, const char *, const char *,
 555     const char *);
 556 extern int zonecfg_delete_scratch(FILE *, const char *);
 557 extern boolean_t zonecfg_is_scratch(const char *);
 558 
 559 /*
 560  * zoneadmd support functions.  Shared between zoneadm and brand hook code.
 561  */
 562 extern void zonecfg_init_lock_file(const char *, char **);
 563 extern void zonecfg_release_lock_file(const char *, int);
 564 extern int zonecfg_grab_lock_file(const char *, int *);
 565 extern boolean_t zonecfg_lock_file_held(int *);
 566 extern int zonecfg_ping_zoneadmd(const char *);
 567 extern int zonecfg_call_zoneadmd(const char *, zone_cmd_arg_t *, char *,
 568     boolean_t);
 569 extern int zonecfg_insert_userauths(zone_dochandle_t, char *, char *);
 570 extern int zonecfg_remove_userauths(zone_dochandle_t, char *, char *,
 571     boolean_t);
 572 extern int zonecfg_add_admin(zone_dochandle_t, struct zone_admintab *,
 573     char *);
 574 extern int zonecfg_delete_admin(zone_dochandle_t,
 575     struct zone_admintab *, char *);
 576 extern int zonecfg_modify_admin(zone_dochandle_t, struct zone_admintab *,
 577     struct zone_admintab *, char *);
 578 extern int zonecfg_delete_admins(zone_dochandle_t, char *);
 579 extern int zonecfg_lookup_admin(zone_dochandle_t, struct zone_admintab *);
 580 extern int zonecfg_authorize_users(zone_dochandle_t, char *);
 581 extern int zonecfg_update_userauths(zone_dochandle_t, char *);
 582 extern int zonecfg_deauthorize_user(zone_dochandle_t, char *, char *);
 583 extern int zonecfg_deauthorize_users(zone_dochandle_t, char *);
 584 extern boolean_t zonecfg_valid_auths(const char *, const char *);
 585 
 586 #ifdef __cplusplus
 587 }
 588 #endif
 589 
 590 #endif  /* _LIBZONECFG_H */