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