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