xref: /illumos-gate/usr/src/head/libzonecfg.h (revision 575a742678105d588b7c8e1653b57a7e3d78440b)
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 2008 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 #include <libuutil.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 
104 /*
105  * Warning: these are shared with the admin/install consolidation.
106  * Do not insert states between any of the currently defined states,
107  * and any new states must be evaluated for impact on range comparisons.
108  */
109 #define	ZONE_STATE_CONFIGURED		0
110 #define	ZONE_STATE_INCOMPLETE		1
111 #define	ZONE_STATE_INSTALLED		2
112 #define	ZONE_STATE_READY		3
113 #define	ZONE_STATE_RUNNING		4
114 #define	ZONE_STATE_SHUTTING_DOWN	5
115 #define	ZONE_STATE_DOWN			6
116 #define	ZONE_STATE_MOUNTED		7
117 
118 #define	ZONE_STATE_MAXSTRLEN	14
119 
120 #define	LIBZONECFG_PATH		"libzonecfg.so.1"
121 
122 #define	ZONE_CONFIG_ROOT	"/etc/zones"
123 #define	ZONE_INDEX_FILE		ZONE_CONFIG_ROOT "/index"
124 
125 /* Owner, group, and mode (defined by packaging) for the config directory */
126 #define	ZONE_CONFIG_UID		0		/* root */
127 #define	ZONE_CONFIG_GID		3		/* sys */
128 #define	ZONE_CONFIG_MODE	0755
129 
130 /* Owner, group, and mode (defined by packaging) for the index file */
131 #define	ZONE_INDEX_UID		0		/* root */
132 #define	ZONE_INDEX_GID		3		/* sys */
133 #define	ZONE_INDEX_MODE		0644
134 
135 /* The maximum length of the VERSION string in the pkginfo(4) file. */
136 #define	ZONE_PKG_VERSMAX	256
137 
138 /*
139  * Shortened alias names for the zones rctls.
140  */
141 #define	ALIAS_MAXLWPS		"max-lwps"
142 #define	ALIAS_MAXSHMMEM		"max-shm-memory"
143 #define	ALIAS_MAXSHMIDS		"max-shm-ids"
144 #define	ALIAS_MAXMSGIDS		"max-msg-ids"
145 #define	ALIAS_MAXSEMIDS		"max-sem-ids"
146 #define	ALIAS_MAXLOCKEDMEM	"locked"
147 #define	ALIAS_MAXSWAP		"swap"
148 #define	ALIAS_SHARES		"cpu-shares"
149 #define	ALIAS_CPUCAP		"cpu-cap"
150 
151 /*
152  * Bit flag definitions for passing into libzonecfg functions.
153  */
154 #define	ZONE_DRY_RUN		0x01
155 
156 /*
157  * The integer field expresses the current values on a get.
158  * On a put, it represents the new values if >= 0 or "don't change" if < 0.
159  */
160 struct zoneent {
161 	char	zone_name[ZONENAME_MAX];	/* name of the zone */
162 	int	zone_state;	/* configured | incomplete | installed */
163 	char	zone_path[MAXPATHLEN];		/* path to zone storage */
164 	uuid_t	zone_uuid;			/* unique ID for zone */
165 	char	zone_newname[ZONENAME_MAX];	/* for doing renames */
166 };
167 
168 typedef struct zone_dochandle *zone_dochandle_t;	/* opaque handle */
169 
170 typedef uint_t zone_state_t;
171 
172 typedef struct zone_fsopt {
173 	struct zone_fsopt *zone_fsopt_next;
174 	char		   zone_fsopt_opt[MAX_MNTOPT_STR];
175 } zone_fsopt_t;
176 
177 struct zone_fstab {
178 	char		zone_fs_special[MAXPATHLEN]; 	/* special file */
179 	char		zone_fs_dir[MAXPATHLEN];	/* mount point */
180 	char		zone_fs_type[FSTYPSZ];		/* e.g. ufs */
181 	zone_fsopt_t   *zone_fs_options;		/* mount options */
182 	char		zone_fs_raw[MAXPATHLEN];	/* device to fsck */
183 };
184 
185 struct zone_nwiftab {
186 	char	zone_nwif_address[INET6_ADDRSTRLEN];
187 	char	zone_nwif_physical[LIFNAMSIZ];
188 };
189 
190 struct zone_devtab {
191 	char	zone_dev_match[MAXPATHLEN];
192 };
193 
194 struct zone_rctlvaltab {
195 	char	zone_rctlval_priv[MAXNAMELEN];
196 	char	zone_rctlval_limit[MAXNAMELEN];
197 	char	zone_rctlval_action[MAXNAMELEN];
198 	struct zone_rctlvaltab *zone_rctlval_next;
199 };
200 
201 struct zone_rctltab {
202 	char	zone_rctl_name[MAXNAMELEN];
203 	struct zone_rctlvaltab *zone_rctl_valptr;
204 };
205 
206 struct zone_attrtab {
207 	char	zone_attr_name[MAXNAMELEN];
208 	char	zone_attr_type[MAXNAMELEN];
209 	char	zone_attr_value[2 * BUFSIZ];
210 };
211 
212 struct zone_dstab {
213 	char	zone_dataset_name[MAXNAMELEN];
214 };
215 
216 struct zone_psettab {
217 	char	zone_ncpu_min[MAXNAMELEN];
218 	char	zone_ncpu_max[MAXNAMELEN];
219 	char	zone_importance[MAXNAMELEN];
220 };
221 
222 struct zone_mcaptab {
223 	char	zone_physmem_cap[MAXNAMELEN];
224 };
225 
226 struct zone_pkgtab {
227 	char	zone_pkg_name[MAXNAMELEN];
228 	char	zone_pkg_version[ZONE_PKG_VERSMAX];
229 };
230 
231 struct zone_patchtab {
232 	char	zone_patch_id[MAXNAMELEN];
233 };
234 
235 struct zone_devpermtab {
236 	char	zone_devperm_name[MAXPATHLEN];
237 	uid_t	zone_devperm_uid;
238 	gid_t	zone_devperm_gid;
239 	mode_t	zone_devperm_mode;
240 	char	*zone_devperm_acl;
241 };
242 
243 typedef struct {
244 	uu_avl_node_t	zpe_entry;
245 	char		*zpe_name;
246 	char		*zpe_vers;
247 	uu_avl_t	*zpe_patches_avl;
248 } zone_pkg_entry_t;
249 
250 typedef enum zone_iptype {
251 	ZS_SHARED,
252 	ZS_EXCLUSIVE
253 } zone_iptype_t;
254 
255 /*
256  * Basic configuration management routines.
257  */
258 extern	zone_dochandle_t	zonecfg_init_handle(void);
259 extern	int	zonecfg_get_handle(const char *, zone_dochandle_t);
260 extern	int	zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
261 extern	int	zonecfg_get_template_handle(const char *, const char *,
262     zone_dochandle_t);
263 extern	int	zonecfg_get_xml_handle(const char *, zone_dochandle_t);
264 extern	int	zonecfg_check_handle(zone_dochandle_t);
265 extern	void	zonecfg_fini_handle(zone_dochandle_t);
266 extern	int	zonecfg_destroy(const char *, boolean_t);
267 extern	int	zonecfg_destroy_snapshot(const char *);
268 extern	int	zonecfg_save(zone_dochandle_t);
269 extern	int	zonecfg_create_snapshot(const char *);
270 extern	char	*zonecfg_strerror(int);
271 extern	int	zonecfg_access(const char *, int);
272 extern	void	zonecfg_set_root(const char *);
273 extern	const char *zonecfg_get_root(void);
274 extern	boolean_t zonecfg_in_alt_root(void);
275 extern	int	zonecfg_num_resources(zone_dochandle_t, char *);
276 extern	int	zonecfg_del_all_resources(zone_dochandle_t, char *);
277 extern	boolean_t zonecfg_valid_ncpus(char *, char *);
278 extern	boolean_t zonecfg_valid_importance(char *);
279 extern	int	zonecfg_str_to_bytes(char *, uint64_t *);
280 extern	boolean_t zonecfg_valid_memlimit(char *, uint64_t *);
281 extern	boolean_t zonecfg_valid_alias_limit(char *, char *, uint64_t *);
282 
283 /*
284  * Zone name, path to zone directory, autoboot setting, pool, boot
285  * arguments, and scheduling-class.
286  */
287 extern	int	zonecfg_validate_zonename(const char *);
288 extern	int	zonecfg_get_name(zone_dochandle_t, char *, size_t);
289 extern	int	zonecfg_set_name(zone_dochandle_t, char *);
290 extern	int	zonecfg_get_zonepath(zone_dochandle_t, char *, size_t);
291 extern	int	zonecfg_set_zonepath(zone_dochandle_t, char *);
292 extern	int	zonecfg_get_autoboot(zone_dochandle_t, boolean_t *);
293 extern	int	zonecfg_set_autoboot(zone_dochandle_t, boolean_t);
294 extern	int	zonecfg_get_iptype(zone_dochandle_t, zone_iptype_t *);
295 extern	int	zonecfg_set_iptype(zone_dochandle_t, zone_iptype_t);
296 extern	int	zonecfg_get_pool(zone_dochandle_t, char *, size_t);
297 extern	int	zonecfg_set_pool(zone_dochandle_t, char *);
298 extern	int	zonecfg_get_bootargs(zone_dochandle_t, char *, size_t);
299 extern	int	zonecfg_set_bootargs(zone_dochandle_t, char *);
300 extern	int	zonecfg_get_sched_class(zone_dochandle_t, char *, size_t);
301 extern	int	zonecfg_set_sched(zone_dochandle_t, char *);
302 extern	int	zonecfg_get_dflt_sched_class(zone_dochandle_t, char *, int);
303 
304 /*
305  * Set/retrieve the brand for the zone
306  */
307 extern	int	zonecfg_get_brand(zone_dochandle_t, char *, size_t);
308 extern	int	zonecfg_set_brand(zone_dochandle_t, char *);
309 
310 /*
311  * Filesystem configuration.
312  */
313 extern	int	zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *);
314 extern	int	zonecfg_delete_filesystem(zone_dochandle_t,
315     struct zone_fstab *);
316 extern	int	zonecfg_modify_filesystem(zone_dochandle_t,
317     struct zone_fstab *, struct zone_fstab *);
318 extern	int	zonecfg_lookup_filesystem(zone_dochandle_t,
319     struct zone_fstab *);
320 extern	int	zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *);
321 extern	int	zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *);
322 extern	int	zonecfg_modify_ipd(zone_dochandle_t,
323     struct zone_fstab *, struct zone_fstab *);
324 extern	int	zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *);
325 extern	int	zonecfg_add_fs_option(struct zone_fstab *, char *);
326 extern	int	zonecfg_remove_fs_option(struct zone_fstab *, char *);
327 extern	void	zonecfg_free_fs_option_list(zone_fsopt_t *);
328 extern	int 	zonecfg_find_mounts(char *, int(*)(const char *, void *),
329     void *);
330 
331 /*
332  * Network interface configuration.
333  */
334 extern	int	zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *);
335 extern	int	zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *);
336 extern	int	zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *,
337     struct zone_nwiftab *);
338 extern	int	zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *);
339 
340 /*
341  * Device configuration and rule matching.
342  */
343 extern	int	zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *);
344 extern	int	zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *);
345 extern	int	zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *,
346     struct zone_devtab *);
347 extern	int	zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *);
348 
349 /*
350  * Resource control configuration.
351  */
352 extern	int	zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *);
353 extern	int	zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *);
354 extern	int	zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *,
355     struct zone_rctltab *);
356 extern	int	zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *);
357 extern	int	zonecfg_add_rctl_value(struct zone_rctltab *,
358     struct zone_rctlvaltab *);
359 extern	int	zonecfg_remove_rctl_value(struct zone_rctltab *,
360     struct zone_rctlvaltab *);
361 extern	void	zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
362 extern	boolean_t zonecfg_aliased_rctl_ok(zone_dochandle_t, char *);
363 extern	int	zonecfg_set_aliased_rctl(zone_dochandle_t, char *, uint64_t);
364 extern	int	zonecfg_get_aliased_rctl(zone_dochandle_t, char *, uint64_t *);
365 extern	int	zonecfg_rm_aliased_rctl(zone_dochandle_t, char *);
366 extern	int	zonecfg_apply_rctls(char *, zone_dochandle_t);
367 
368 /*
369  * Generic attribute configuration and type/value extraction.
370  */
371 extern	int	zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *);
372 extern	int	zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *);
373 extern	int	zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *,
374     struct zone_attrtab *);
375 extern	int	zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *);
376 extern	int	zonecfg_get_attr_boolean(const struct zone_attrtab *,
377     boolean_t *);
378 extern	int	zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *);
379 extern	int	zonecfg_get_attr_string(const struct zone_attrtab *, char *,
380     size_t);
381 extern	int	zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *);
382 
383 /*
384  * ZFS configuration.
385  */
386 extern	int	zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *);
387 extern	int	zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *);
388 extern	int	zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *,
389     struct zone_dstab *);
390 extern	int	zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *);
391 
392 /*
393  * cpu-set configuration.
394  */
395 extern	int	zonecfg_add_pset(zone_dochandle_t, struct zone_psettab *);
396 extern	int	zonecfg_delete_pset(zone_dochandle_t);
397 extern	int	zonecfg_modify_pset(zone_dochandle_t, struct zone_psettab *);
398 extern	int	zonecfg_lookup_pset(zone_dochandle_t, struct zone_psettab *);
399 
400 /*
401  * mem-cap configuration.
402  */
403 extern	int	zonecfg_delete_mcap(zone_dochandle_t);
404 extern	int	zonecfg_modify_mcap(zone_dochandle_t, struct zone_mcaptab *);
405 extern	int	zonecfg_lookup_mcap(zone_dochandle_t, struct zone_mcaptab *);
406 
407 /*
408  * Temporary pool support functions.
409  */
410 extern	int	zonecfg_destroy_tmp_pool(char *, char *, int);
411 extern	int	zonecfg_bind_tmp_pool(zone_dochandle_t, zoneid_t, char *, int);
412 extern	int	zonecfg_bind_pool(zone_dochandle_t, zoneid_t, char *, int);
413 extern	boolean_t zonecfg_warn_poold(zone_dochandle_t);
414 
415 /*
416  * Miscellaneous utility functions.
417  */
418 extern	int	zonecfg_enable_rcapd(char *, int);
419 
420 /*
421  * attach/detach support.
422  */
423 extern	int	zonecfg_get_attach_handle(const char *, const char *,
424     boolean_t, zone_dochandle_t);
425 extern	int	zonecfg_attach_manifest(int, zone_dochandle_t,
426     zone_dochandle_t);
427 extern	int	zonecfg_detach_save(zone_dochandle_t, uint_t);
428 extern	int	zonecfg_get_detach_info(zone_dochandle_t, boolean_t);
429 extern	boolean_t zonecfg_detached(const char *);
430 extern	void	zonecfg_rm_detached(zone_dochandle_t, boolean_t forced);
431 extern	int	zonecfg_devwalk(zone_dochandle_t handle,
432     int (*cb)(const char *, uid_t, gid_t, mode_t, const char *, void *),
433     void *data);
434 extern	int	zonecfg_devperms_apply(zone_dochandle_t, const char *,
435     uid_t, gid_t, mode_t, const char *);
436 
437 /*
438  * External zone verification support.
439  */
440 extern	int	zonecfg_verify_save(zone_dochandle_t, char *);
441 
442 /*
443  * '*ent' iterator routines.
444  */
445 extern	int	zonecfg_setfsent(zone_dochandle_t);
446 extern	int	zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *);
447 extern	int	zonecfg_endfsent(zone_dochandle_t);
448 extern	int	zonecfg_setipdent(zone_dochandle_t);
449 extern	int	zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *);
450 extern	int	zonecfg_endipdent(zone_dochandle_t);
451 extern	int	zonecfg_setnwifent(zone_dochandle_t);
452 extern	int	zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *);
453 extern	int	zonecfg_endnwifent(zone_dochandle_t);
454 extern	int	zonecfg_setdevent(zone_dochandle_t);
455 extern	int	zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *);
456 extern	int	zonecfg_enddevent(zone_dochandle_t);
457 extern	int	zonecfg_setattrent(zone_dochandle_t);
458 extern	int	zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *);
459 extern	int	zonecfg_endattrent(zone_dochandle_t);
460 extern	int	zonecfg_setrctlent(zone_dochandle_t);
461 extern	int	zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *);
462 extern	int	zonecfg_endrctlent(zone_dochandle_t);
463 extern	int	zonecfg_setdsent(zone_dochandle_t);
464 extern	int	zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *);
465 extern	int	zonecfg_enddsent(zone_dochandle_t);
466 extern	int	zonecfg_getpsetent(zone_dochandle_t, struct zone_psettab *);
467 extern	int	zonecfg_getmcapent(zone_dochandle_t, struct zone_mcaptab *);
468 extern	int	zonecfg_getpkgdata(zone_dochandle_t, uu_avl_pool_t *,
469     uu_avl_t *);
470 extern	int	zonecfg_setdevperment(zone_dochandle_t);
471 extern	int	zonecfg_getdevperment(zone_dochandle_t,
472     struct zone_devpermtab *);
473 extern	int	zonecfg_enddevperment(zone_dochandle_t);
474 
475 /*
476  * Privilege-related functions.
477  */
478 extern	int	zonecfg_default_privset(priv_set_t *, const char *);
479 extern	int	zonecfg_get_privset(zone_dochandle_t, priv_set_t *,
480     char **);
481 extern	int	zonecfg_get_limitpriv(zone_dochandle_t, char **);
482 extern	int	zonecfg_set_limitpriv(zone_dochandle_t, char *);
483 
484 /*
485  * Higher-level routines.
486  */
487 extern  int	zone_get_brand(char *, char *, size_t);
488 extern	int	zone_get_rootpath(char *, char *, size_t);
489 extern	int	zone_get_devroot(char *, char *, size_t);
490 extern	int	zone_get_zonepath(char *, char *, size_t);
491 extern	int	zone_get_state(char *, zone_state_t *);
492 extern	int	zone_set_state(char *, zone_state_t);
493 extern	char	*zone_state_str(zone_state_t);
494 extern	int	zonecfg_get_name_by_uuid(const uuid_t, char *, size_t);
495 extern	int	zonecfg_get_uuid(const char *, uuid_t);
496 
497 /*
498  * Iterator for configured zones.
499  */
500 extern FILE		*setzoneent(void);
501 extern char		*getzoneent(FILE *);
502 extern struct zoneent	*getzoneent_private(FILE *);
503 extern void		endzoneent(FILE *);
504 
505 /*
506  * File-system-related convenience functions.
507  */
508 extern boolean_t zonecfg_valid_fs_type(const char *);
509 
510 /*
511  * Network-related convenience functions.
512  */
513 extern boolean_t zonecfg_same_net_address(char *, char *);
514 extern int zonecfg_valid_net_address(char *, struct lifreq *);
515 extern boolean_t zonecfg_ifname_exists(sa_family_t, char *);
516 
517 /*
518  * Rctl-related common functions.
519  */
520 extern boolean_t zonecfg_is_rctl(const char *);
521 extern boolean_t zonecfg_valid_rctlname(const char *);
522 extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *);
523 extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *);
524 extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
525     rctlblk_t *);
526 
527 /*
528  * Live Upgrade support functions.  Shared between ON and install gate.
529  */
530 extern FILE *zonecfg_open_scratch(const char *, boolean_t);
531 extern int zonecfg_lock_scratch(FILE *);
532 extern void zonecfg_close_scratch(FILE *);
533 extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *,
534     size_t);
535 extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
536     size_t);
537 extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t,
538     char *, size_t);
539 extern int zonecfg_add_scratch(FILE *, const char *, const char *,
540     const char *);
541 extern int zonecfg_delete_scratch(FILE *, const char *);
542 extern boolean_t zonecfg_is_scratch(const char *);
543 
544 #ifdef __cplusplus
545 }
546 #endif
547 
548 #endif	/* _LIBZONECFG_H */
549