xref: /titanic_51/usr/src/head/libzonecfg.h (revision dfd653818fb0fee04fba883d52c3fef8e4103a69)
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 	char	zone_nwif_defrouter[INET6_ADDRSTRLEN];
189 };
190 
191 struct zone_devtab {
192 	char	zone_dev_match[MAXPATHLEN];
193 };
194 
195 struct zone_rctlvaltab {
196 	char	zone_rctlval_priv[MAXNAMELEN];
197 	char	zone_rctlval_limit[MAXNAMELEN];
198 	char	zone_rctlval_action[MAXNAMELEN];
199 	struct zone_rctlvaltab *zone_rctlval_next;
200 };
201 
202 struct zone_rctltab {
203 	char	zone_rctl_name[MAXNAMELEN];
204 	struct zone_rctlvaltab *zone_rctl_valptr;
205 };
206 
207 struct zone_attrtab {
208 	char	zone_attr_name[MAXNAMELEN];
209 	char	zone_attr_type[MAXNAMELEN];
210 	char	zone_attr_value[2 * BUFSIZ];
211 };
212 
213 struct zone_dstab {
214 	char	zone_dataset_name[MAXNAMELEN];
215 };
216 
217 struct zone_psettab {
218 	char	zone_ncpu_min[MAXNAMELEN];
219 	char	zone_ncpu_max[MAXNAMELEN];
220 	char	zone_importance[MAXNAMELEN];
221 };
222 
223 struct zone_mcaptab {
224 	char	zone_physmem_cap[MAXNAMELEN];
225 };
226 
227 struct zone_pkgtab {
228 	char	zone_pkg_name[MAXNAMELEN];
229 	char	zone_pkg_version[ZONE_PKG_VERSMAX];
230 };
231 
232 struct zone_patchtab {
233 	char	zone_patch_id[MAXNAMELEN];
234 };
235 
236 struct zone_devpermtab {
237 	char	zone_devperm_name[MAXPATHLEN];
238 	uid_t	zone_devperm_uid;
239 	gid_t	zone_devperm_gid;
240 	mode_t	zone_devperm_mode;
241 	char	*zone_devperm_acl;
242 };
243 
244 typedef struct {
245 	uu_avl_node_t	zpe_entry;
246 	char		*zpe_name;
247 	char		*zpe_vers;
248 	uu_avl_t	*zpe_patches_avl;
249 } zone_pkg_entry_t;
250 
251 typedef enum zone_iptype {
252 	ZS_SHARED,
253 	ZS_EXCLUSIVE
254 } zone_iptype_t;
255 
256 /*
257  * Basic configuration management routines.
258  */
259 extern	zone_dochandle_t	zonecfg_init_handle(void);
260 extern	int	zonecfg_get_handle(const char *, zone_dochandle_t);
261 extern	int	zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
262 extern	int	zonecfg_get_template_handle(const char *, const char *,
263     zone_dochandle_t);
264 extern	int	zonecfg_get_xml_handle(const char *, zone_dochandle_t);
265 extern	int	zonecfg_check_handle(zone_dochandle_t);
266 extern	void	zonecfg_fini_handle(zone_dochandle_t);
267 extern	int	zonecfg_destroy(const char *, boolean_t);
268 extern	int	zonecfg_destroy_snapshot(const char *);
269 extern	int	zonecfg_save(zone_dochandle_t);
270 extern	int	zonecfg_create_snapshot(const char *);
271 extern	char	*zonecfg_strerror(int);
272 extern	int	zonecfg_access(const char *, int);
273 extern	void	zonecfg_set_root(const char *);
274 extern	const char *zonecfg_get_root(void);
275 extern	boolean_t zonecfg_in_alt_root(void);
276 extern	int	zonecfg_num_resources(zone_dochandle_t, char *);
277 extern	int	zonecfg_del_all_resources(zone_dochandle_t, char *);
278 extern	boolean_t zonecfg_valid_ncpus(char *, char *);
279 extern	boolean_t zonecfg_valid_importance(char *);
280 extern	int	zonecfg_str_to_bytes(char *, uint64_t *);
281 extern	boolean_t zonecfg_valid_memlimit(char *, uint64_t *);
282 extern	boolean_t zonecfg_valid_alias_limit(char *, char *, uint64_t *);
283 
284 /*
285  * Zone name, path to zone directory, autoboot setting, pool, boot
286  * arguments, and scheduling-class.
287  */
288 extern	int	zonecfg_validate_zonename(const char *);
289 extern	int	zonecfg_get_name(zone_dochandle_t, char *, size_t);
290 extern	int	zonecfg_set_name(zone_dochandle_t, char *);
291 extern	int	zonecfg_get_zonepath(zone_dochandle_t, char *, size_t);
292 extern	int	zonecfg_set_zonepath(zone_dochandle_t, char *);
293 extern	int	zonecfg_get_autoboot(zone_dochandle_t, boolean_t *);
294 extern	int	zonecfg_set_autoboot(zone_dochandle_t, boolean_t);
295 extern	int	zonecfg_get_iptype(zone_dochandle_t, zone_iptype_t *);
296 extern	int	zonecfg_set_iptype(zone_dochandle_t, zone_iptype_t);
297 extern	int	zonecfg_get_pool(zone_dochandle_t, char *, size_t);
298 extern	int	zonecfg_set_pool(zone_dochandle_t, char *);
299 extern	int	zonecfg_get_bootargs(zone_dochandle_t, char *, size_t);
300 extern	int	zonecfg_set_bootargs(zone_dochandle_t, char *);
301 extern	int	zonecfg_get_sched_class(zone_dochandle_t, char *, size_t);
302 extern	int	zonecfg_set_sched(zone_dochandle_t, char *);
303 extern	int	zonecfg_get_dflt_sched_class(zone_dochandle_t, char *, int);
304 
305 /*
306  * Set/retrieve the brand for the zone
307  */
308 extern	int	zonecfg_get_brand(zone_dochandle_t, char *, size_t);
309 extern	int	zonecfg_set_brand(zone_dochandle_t, char *);
310 
311 /*
312  * Filesystem configuration.
313  */
314 extern	int	zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *);
315 extern	int	zonecfg_delete_filesystem(zone_dochandle_t,
316     struct zone_fstab *);
317 extern	int	zonecfg_modify_filesystem(zone_dochandle_t,
318     struct zone_fstab *, struct zone_fstab *);
319 extern	int	zonecfg_lookup_filesystem(zone_dochandle_t,
320     struct zone_fstab *);
321 extern	int	zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *);
322 extern	int	zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *);
323 extern	int	zonecfg_modify_ipd(zone_dochandle_t,
324     struct zone_fstab *, struct zone_fstab *);
325 extern	int	zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *);
326 extern	int	zonecfg_add_fs_option(struct zone_fstab *, char *);
327 extern	int	zonecfg_remove_fs_option(struct zone_fstab *, char *);
328 extern	void	zonecfg_free_fs_option_list(zone_fsopt_t *);
329 extern	int 	zonecfg_find_mounts(char *, int(*)(const char *, void *),
330     void *);
331 
332 /*
333  * Network interface configuration.
334  */
335 extern	int	zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *);
336 extern	int	zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *);
337 extern	int	zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *,
338     struct zone_nwiftab *);
339 extern	int	zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *);
340 
341 /*
342  * Device configuration and rule matching.
343  */
344 extern	int	zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *);
345 extern	int	zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *);
346 extern	int	zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *,
347     struct zone_devtab *);
348 extern	int	zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *);
349 
350 /*
351  * Resource control configuration.
352  */
353 extern	int	zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *);
354 extern	int	zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *);
355 extern	int	zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *,
356     struct zone_rctltab *);
357 extern	int	zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *);
358 extern	int	zonecfg_add_rctl_value(struct zone_rctltab *,
359     struct zone_rctlvaltab *);
360 extern	int	zonecfg_remove_rctl_value(struct zone_rctltab *,
361     struct zone_rctlvaltab *);
362 extern	void	zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
363 extern	boolean_t zonecfg_aliased_rctl_ok(zone_dochandle_t, char *);
364 extern	int	zonecfg_set_aliased_rctl(zone_dochandle_t, char *, uint64_t);
365 extern	int	zonecfg_get_aliased_rctl(zone_dochandle_t, char *, uint64_t *);
366 extern	int	zonecfg_rm_aliased_rctl(zone_dochandle_t, char *);
367 extern	int	zonecfg_apply_rctls(char *, zone_dochandle_t);
368 
369 /*
370  * Generic attribute configuration and type/value extraction.
371  */
372 extern	int	zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *);
373 extern	int	zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *);
374 extern	int	zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *,
375     struct zone_attrtab *);
376 extern	int	zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *);
377 extern	int	zonecfg_get_attr_boolean(const struct zone_attrtab *,
378     boolean_t *);
379 extern	int	zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *);
380 extern	int	zonecfg_get_attr_string(const struct zone_attrtab *, char *,
381     size_t);
382 extern	int	zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *);
383 
384 /*
385  * ZFS configuration.
386  */
387 extern	int	zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *);
388 extern	int	zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *);
389 extern	int	zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *,
390     struct zone_dstab *);
391 extern	int	zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *);
392 
393 /*
394  * cpu-set configuration.
395  */
396 extern	int	zonecfg_add_pset(zone_dochandle_t, struct zone_psettab *);
397 extern	int	zonecfg_delete_pset(zone_dochandle_t);
398 extern	int	zonecfg_modify_pset(zone_dochandle_t, struct zone_psettab *);
399 extern	int	zonecfg_lookup_pset(zone_dochandle_t, struct zone_psettab *);
400 
401 /*
402  * mem-cap configuration.
403  */
404 extern	int	zonecfg_delete_mcap(zone_dochandle_t);
405 extern	int	zonecfg_modify_mcap(zone_dochandle_t, struct zone_mcaptab *);
406 extern	int	zonecfg_lookup_mcap(zone_dochandle_t, struct zone_mcaptab *);
407 
408 /*
409  * Temporary pool support functions.
410  */
411 extern	int	zonecfg_destroy_tmp_pool(char *, char *, int);
412 extern	int	zonecfg_bind_tmp_pool(zone_dochandle_t, zoneid_t, char *, int);
413 extern	int	zonecfg_bind_pool(zone_dochandle_t, zoneid_t, char *, int);
414 extern	boolean_t zonecfg_warn_poold(zone_dochandle_t);
415 
416 /*
417  * Miscellaneous utility functions.
418  */
419 extern	int	zonecfg_enable_rcapd(char *, int);
420 
421 /*
422  * attach/detach support.
423  */
424 extern	int	zonecfg_get_attach_handle(const char *, const char *,
425     boolean_t, zone_dochandle_t);
426 extern	int	zonecfg_attach_manifest(int, zone_dochandle_t,
427     zone_dochandle_t);
428 extern	int	zonecfg_detach_save(zone_dochandle_t, uint_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_dev_manifest(zone_dochandle_t);
432 extern	int	zonecfg_devperms_apply(zone_dochandle_t, const char *,
433     uid_t, gid_t, mode_t, const char *);
434 extern	void	zonecfg_set_swinv(zone_dochandle_t);
435 extern	int	zonecfg_add_pkg(zone_dochandle_t, char *, char *);
436 extern	int	zonecfg_add_patch(zone_dochandle_t, char *, void **);
437 extern	int	zonecfg_add_patch_obs(char *, void *);
438 
439 /*
440  * External zone verification support.
441  */
442 extern	int	zonecfg_verify_save(zone_dochandle_t, char *);
443 
444 /*
445  * '*ent' iterator routines.
446  */
447 extern	int	zonecfg_setfsent(zone_dochandle_t);
448 extern	int	zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *);
449 extern	int	zonecfg_endfsent(zone_dochandle_t);
450 extern	int	zonecfg_setipdent(zone_dochandle_t);
451 extern	int	zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *);
452 extern	int	zonecfg_endipdent(zone_dochandle_t);
453 extern	int	zonecfg_setnwifent(zone_dochandle_t);
454 extern	int	zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *);
455 extern	int	zonecfg_endnwifent(zone_dochandle_t);
456 extern	int	zonecfg_setdevent(zone_dochandle_t);
457 extern	int	zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *);
458 extern	int	zonecfg_enddevent(zone_dochandle_t);
459 extern	int	zonecfg_setattrent(zone_dochandle_t);
460 extern	int	zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *);
461 extern	int	zonecfg_endattrent(zone_dochandle_t);
462 extern	int	zonecfg_setrctlent(zone_dochandle_t);
463 extern	int	zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *);
464 extern	int	zonecfg_endrctlent(zone_dochandle_t);
465 extern	int	zonecfg_setdsent(zone_dochandle_t);
466 extern	int	zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *);
467 extern	int	zonecfg_enddsent(zone_dochandle_t);
468 extern	int	zonecfg_getpsetent(zone_dochandle_t, struct zone_psettab *);
469 extern	int	zonecfg_getmcapent(zone_dochandle_t, struct zone_mcaptab *);
470 extern	int	zonecfg_getpkgdata(zone_dochandle_t, uu_avl_pool_t *,
471     uu_avl_t *);
472 extern	int	zonecfg_setdevperment(zone_dochandle_t);
473 extern	int	zonecfg_getdevperment(zone_dochandle_t,
474     struct zone_devpermtab *);
475 extern	int	zonecfg_enddevperment(zone_dochandle_t);
476 
477 /*
478  * Privilege-related functions.
479  */
480 extern	int	zonecfg_default_privset(priv_set_t *, const char *);
481 extern	int	zonecfg_get_privset(zone_dochandle_t, priv_set_t *,
482     char **);
483 extern	int	zonecfg_get_limitpriv(zone_dochandle_t, char **);
484 extern	int	zonecfg_set_limitpriv(zone_dochandle_t, char *);
485 
486 /*
487  * Higher-level routines.
488  */
489 extern  int	zone_get_brand(char *, char *, size_t);
490 extern	int	zone_get_rootpath(char *, char *, size_t);
491 extern	int	zone_get_devroot(char *, char *, size_t);
492 extern	int	zone_get_zonepath(char *, char *, size_t);
493 extern	int	zone_get_state(char *, zone_state_t *);
494 extern	int	zone_set_state(char *, zone_state_t);
495 extern	char	*zone_state_str(zone_state_t);
496 extern	int	zonecfg_get_name_by_uuid(const uuid_t, char *, size_t);
497 extern	int	zonecfg_get_uuid(const char *, uuid_t);
498 
499 /*
500  * Iterator for configured zones.
501  */
502 extern FILE		*setzoneent(void);
503 extern char		*getzoneent(FILE *);
504 extern struct zoneent	*getzoneent_private(FILE *);
505 extern void		endzoneent(FILE *);
506 
507 /*
508  * File-system-related convenience functions.
509  */
510 extern boolean_t zonecfg_valid_fs_type(const char *);
511 
512 /*
513  * Network-related convenience functions.
514  */
515 extern boolean_t zonecfg_same_net_address(char *, char *);
516 extern int zonecfg_valid_net_address(char *, struct lifreq *);
517 extern boolean_t zonecfg_ifname_exists(sa_family_t, char *);
518 
519 /*
520  * Rctl-related common functions.
521  */
522 extern boolean_t zonecfg_is_rctl(const char *);
523 extern boolean_t zonecfg_valid_rctlname(const char *);
524 extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *);
525 extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *);
526 extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
527     rctlblk_t *);
528 
529 /*
530  * Live Upgrade support functions.  Shared between ON and install gate.
531  */
532 extern FILE *zonecfg_open_scratch(const char *, boolean_t);
533 extern int zonecfg_lock_scratch(FILE *);
534 extern void zonecfg_close_scratch(FILE *);
535 extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *,
536     size_t);
537 extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
538     size_t);
539 extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t,
540     char *, size_t);
541 extern int zonecfg_add_scratch(FILE *, const char *, const char *,
542     const char *);
543 extern int zonecfg_delete_scratch(FILE *, const char *);
544 extern boolean_t zonecfg_is_scratch(const char *);
545 
546 /*
547  * zoneadmd support functions.  Shared between zoneadm and brand hook code.
548  */
549 extern void zonecfg_init_lock_file(const char *, char **);
550 extern void zonecfg_release_lock_file(const char *, int);
551 extern int zonecfg_grab_lock_file(const char *, int *);
552 extern int zonecfg_ping_zoneadmd(const char *);
553 extern int zonecfg_call_zoneadmd(const char *, zone_cmd_arg_t *, char *,
554     boolean_t);
555 
556 #ifdef __cplusplus
557 }
558 #endif
559 
560 #endif	/* _LIBZONECFG_H */
561