xref: /titanic_51/usr/src/head/libzonecfg.h (revision a31148363f598def767ac48c5d82e1572e44b935)
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 2010 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 /*
31  * Zone configuration header file.
32  */
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /* sys/socket.h is required by net/if.h, which has a constant needed here */
39 #include <sys/param.h>
40 #include <sys/fstyp.h>
41 #include <sys/mount.h>
42 #include <priv.h>
43 #include <netinet/in.h>
44 #include <sys/socket.h>
45 #include <net/if.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 
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 #define	Z_HOSTID_FUBAR		50	/* invalid hostid provided */
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 /* Default name for zone detached manifest */
152 #define	ZONE_DETACHED	"SUNWdetached.xml"
153 
154 /*
155  * Bit flag definitions for passing into libzonecfg functions.
156  */
157 #define	ZONE_DRY_RUN		0x01
158 
159 /*
160  * The integer field expresses the current values on a get.
161  * On a put, it represents the new values if >= 0 or "don't change" if < 0.
162  */
163 struct zoneent {
164 	char	zone_name[ZONENAME_MAX];	/* name of the zone */
165 	int	zone_state;	/* configured | incomplete | installed */
166 	char	zone_path[MAXPATHLEN];		/* path to zone storage */
167 	uuid_t	zone_uuid;			/* unique ID for zone */
168 	char	zone_newname[ZONENAME_MAX];	/* for doing renames */
169 };
170 
171 typedef struct zone_dochandle *zone_dochandle_t;	/* opaque handle */
172 
173 typedef uint_t zone_state_t;
174 
175 typedef struct zone_fsopt {
176 	struct zone_fsopt *zone_fsopt_next;
177 	char		   zone_fsopt_opt[MAX_MNTOPT_STR];
178 } zone_fsopt_t;
179 
180 struct zone_fstab {
181 	char		zone_fs_special[MAXPATHLEN]; 	/* special file */
182 	char		zone_fs_dir[MAXPATHLEN];	/* mount point */
183 	char		zone_fs_type[FSTYPSZ];		/* e.g. ufs */
184 	zone_fsopt_t   *zone_fs_options;		/* mount options */
185 	char		zone_fs_raw[MAXPATHLEN];	/* device to fsck */
186 };
187 
188 struct zone_nwiftab {
189 	char	zone_nwif_address[INET6_ADDRSTRLEN];
190 	char	zone_nwif_physical[LIFNAMSIZ];
191 	char	zone_nwif_defrouter[INET6_ADDRSTRLEN];
192 };
193 
194 struct zone_devtab {
195 	char	zone_dev_match[MAXPATHLEN];
196 };
197 
198 struct zone_rctlvaltab {
199 	char	zone_rctlval_priv[MAXNAMELEN];
200 	char	zone_rctlval_limit[MAXNAMELEN];
201 	char	zone_rctlval_action[MAXNAMELEN];
202 	struct zone_rctlvaltab *zone_rctlval_next;
203 };
204 
205 struct zone_rctltab {
206 	char	zone_rctl_name[MAXNAMELEN];
207 	struct zone_rctlvaltab *zone_rctl_valptr;
208 };
209 
210 struct zone_attrtab {
211 	char	zone_attr_name[MAXNAMELEN];
212 	char	zone_attr_type[MAXNAMELEN];
213 	char	zone_attr_value[2 * BUFSIZ];
214 };
215 
216 struct zone_dstab {
217 	char	zone_dataset_name[MAXNAMELEN];
218 };
219 
220 struct zone_psettab {
221 	char	zone_ncpu_min[MAXNAMELEN];
222 	char	zone_ncpu_max[MAXNAMELEN];
223 	char	zone_importance[MAXNAMELEN];
224 };
225 
226 struct zone_mcaptab {
227 	char	zone_physmem_cap[MAXNAMELEN];
228 };
229 
230 struct zone_pkgtab {
231 	char	zone_pkg_name[MAXNAMELEN];
232 	char	zone_pkg_version[ZONE_PKG_VERSMAX];
233 };
234 
235 struct zone_patchtab {
236 	char	zone_patch_id[MAXNAMELEN];
237 };
238 
239 struct zone_devpermtab {
240 	char	zone_devperm_name[MAXPATHLEN];
241 	uid_t	zone_devperm_uid;
242 	gid_t	zone_devperm_gid;
243 	mode_t	zone_devperm_mode;
244 	char	*zone_devperm_acl;
245 };
246 
247 typedef struct {
248 	uu_avl_node_t	zpe_entry;
249 	char		*zpe_name;
250 	char		*zpe_vers;
251 	uu_avl_t	*zpe_patches_avl;
252 } zone_pkg_entry_t;
253 
254 typedef enum zone_iptype {
255 	ZS_SHARED,
256 	ZS_EXCLUSIVE
257 } zone_iptype_t;
258 
259 /*
260  * Basic configuration management routines.
261  */
262 extern	zone_dochandle_t	zonecfg_init_handle(void);
263 extern	int	zonecfg_get_handle(const char *, zone_dochandle_t);
264 extern	int	zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
265 extern	int	zonecfg_get_template_handle(const char *, const char *,
266     zone_dochandle_t);
267 extern	int	zonecfg_get_xml_handle(const char *, zone_dochandle_t);
268 extern	int	zonecfg_check_handle(zone_dochandle_t);
269 extern	void	zonecfg_fini_handle(zone_dochandle_t);
270 extern	int	zonecfg_destroy(const char *, boolean_t);
271 extern	int	zonecfg_destroy_snapshot(const char *);
272 extern	int	zonecfg_save(zone_dochandle_t);
273 extern	int	zonecfg_create_snapshot(const char *);
274 extern	char	*zonecfg_strerror(int);
275 extern	int	zonecfg_access(const char *, int);
276 extern	void	zonecfg_set_root(const char *);
277 extern	const char *zonecfg_get_root(void);
278 extern	boolean_t zonecfg_in_alt_root(void);
279 extern	int	zonecfg_num_resources(zone_dochandle_t, char *);
280 extern	int	zonecfg_del_all_resources(zone_dochandle_t, char *);
281 extern	boolean_t zonecfg_valid_ncpus(char *, char *);
282 extern	boolean_t zonecfg_valid_importance(char *);
283 extern	int	zonecfg_str_to_bytes(char *, uint64_t *);
284 extern	boolean_t zonecfg_valid_memlimit(char *, uint64_t *);
285 extern	boolean_t zonecfg_valid_alias_limit(char *, char *, uint64_t *);
286 
287 /*
288  * Zone name, path to zone directory, autoboot setting, pool, boot
289  * arguments, and scheduling-class.
290  */
291 extern	int	zonecfg_validate_zonename(const char *);
292 extern	int	zonecfg_get_name(zone_dochandle_t, char *, size_t);
293 extern	int	zonecfg_set_name(zone_dochandle_t, char *);
294 extern	int	zonecfg_get_zonepath(zone_dochandle_t, char *, size_t);
295 extern	int	zonecfg_set_zonepath(zone_dochandle_t, char *);
296 extern	int	zonecfg_get_autoboot(zone_dochandle_t, boolean_t *);
297 extern	int	zonecfg_set_autoboot(zone_dochandle_t, boolean_t);
298 extern	int	zonecfg_get_iptype(zone_dochandle_t, zone_iptype_t *);
299 extern	int	zonecfg_set_iptype(zone_dochandle_t, zone_iptype_t);
300 extern	int	zonecfg_get_pool(zone_dochandle_t, char *, size_t);
301 extern	int	zonecfg_set_pool(zone_dochandle_t, char *);
302 extern	int	zonecfg_get_bootargs(zone_dochandle_t, char *, size_t);
303 extern	int	zonecfg_set_bootargs(zone_dochandle_t, char *);
304 extern	int	zonecfg_get_sched_class(zone_dochandle_t, char *, size_t);
305 extern	int	zonecfg_set_sched(zone_dochandle_t, char *);
306 extern	int	zonecfg_get_dflt_sched_class(zone_dochandle_t, char *, int);
307 
308 /*
309  * Set/retrieve the brand for the zone
310  */
311 extern	int	zonecfg_get_brand(zone_dochandle_t, char *, size_t);
312 extern	int	zonecfg_set_brand(zone_dochandle_t, char *);
313 
314 /*
315  * Filesystem configuration.
316  */
317 extern	int	zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *);
318 extern	int	zonecfg_delete_filesystem(zone_dochandle_t,
319     struct zone_fstab *);
320 extern	int	zonecfg_modify_filesystem(zone_dochandle_t,
321     struct zone_fstab *, struct zone_fstab *);
322 extern	int	zonecfg_lookup_filesystem(zone_dochandle_t,
323     struct zone_fstab *);
324 extern	int	zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *);
325 extern	int	zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *);
326 extern	int	zonecfg_modify_ipd(zone_dochandle_t,
327     struct zone_fstab *, struct zone_fstab *);
328 extern	int	zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *);
329 extern	int	zonecfg_add_fs_option(struct zone_fstab *, char *);
330 extern	int	zonecfg_remove_fs_option(struct zone_fstab *, char *);
331 extern	void	zonecfg_free_fs_option_list(zone_fsopt_t *);
332 extern	int 	zonecfg_find_mounts(char *, int(*)(const struct mnttab *,
333     void *), void *);
334 
335 /*
336  * Network interface configuration.
337  */
338 extern	int	zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *);
339 extern	int	zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *);
340 extern	int	zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *,
341     struct zone_nwiftab *);
342 extern	int	zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *);
343 
344 /*
345  * Hostid emulation configuration.
346  */
347 extern	int	zonecfg_get_hostid(zone_dochandle_t, char *, size_t);
348 extern	int	zonecfg_set_hostid(zone_dochandle_t, const char *);
349 extern	int	zonecfg_valid_hostid(const char *);
350 
351 /*
352  * Device configuration and rule matching.
353  */
354 extern	int	zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *);
355 extern	int	zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *);
356 extern	int	zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *,
357     struct zone_devtab *);
358 extern	int	zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *);
359 
360 /*
361  * Resource control configuration.
362  */
363 extern	int	zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *);
364 extern	int	zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *);
365 extern	int	zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *,
366     struct zone_rctltab *);
367 extern	int	zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *);
368 extern	int	zonecfg_add_rctl_value(struct zone_rctltab *,
369     struct zone_rctlvaltab *);
370 extern	int	zonecfg_remove_rctl_value(struct zone_rctltab *,
371     struct zone_rctlvaltab *);
372 extern	void	zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
373 extern	boolean_t zonecfg_aliased_rctl_ok(zone_dochandle_t, char *);
374 extern	int	zonecfg_set_aliased_rctl(zone_dochandle_t, char *, uint64_t);
375 extern	int	zonecfg_get_aliased_rctl(zone_dochandle_t, char *, uint64_t *);
376 extern	int	zonecfg_rm_aliased_rctl(zone_dochandle_t, char *);
377 extern	int	zonecfg_apply_rctls(char *, zone_dochandle_t);
378 
379 /*
380  * Generic attribute configuration and type/value extraction.
381  */
382 extern	int	zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *);
383 extern	int	zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *);
384 extern	int	zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *,
385     struct zone_attrtab *);
386 extern	int	zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *);
387 extern	int	zonecfg_get_attr_boolean(const struct zone_attrtab *,
388     boolean_t *);
389 extern	int	zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *);
390 extern	int	zonecfg_get_attr_string(const struct zone_attrtab *, char *,
391     size_t);
392 extern	int	zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *);
393 
394 /*
395  * ZFS configuration.
396  */
397 extern	int	zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *);
398 extern	int	zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *);
399 extern	int	zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *,
400     struct zone_dstab *);
401 extern	int	zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *);
402 
403 /*
404  * cpu-set configuration.
405  */
406 extern	int	zonecfg_add_pset(zone_dochandle_t, struct zone_psettab *);
407 extern	int	zonecfg_delete_pset(zone_dochandle_t);
408 extern	int	zonecfg_modify_pset(zone_dochandle_t, struct zone_psettab *);
409 extern	int	zonecfg_lookup_pset(zone_dochandle_t, struct zone_psettab *);
410 
411 /*
412  * mem-cap configuration.
413  */
414 extern	int	zonecfg_delete_mcap(zone_dochandle_t);
415 extern	int	zonecfg_modify_mcap(zone_dochandle_t, struct zone_mcaptab *);
416 extern	int	zonecfg_lookup_mcap(zone_dochandle_t, struct zone_mcaptab *);
417 
418 /*
419  * Temporary pool support functions.
420  */
421 extern	int	zonecfg_destroy_tmp_pool(char *, char *, int);
422 extern	int	zonecfg_bind_tmp_pool(zone_dochandle_t, zoneid_t, char *, int);
423 extern	int	zonecfg_bind_pool(zone_dochandle_t, zoneid_t, char *, int);
424 extern	boolean_t zonecfg_warn_poold(zone_dochandle_t);
425 extern	int	zonecfg_get_poolname(zone_dochandle_t, char *, char *, size_t);
426 
427 /*
428  * Miscellaneous utility functions.
429  */
430 extern	int	zonecfg_enable_rcapd(char *, int);
431 
432 /*
433  * attach/detach support.
434  */
435 extern	int	zonecfg_get_attach_handle(const char *, const char *,
436     const char *, boolean_t, zone_dochandle_t);
437 extern	int	zonecfg_attach_manifest(int, zone_dochandle_t,
438     zone_dochandle_t);
439 extern	int	zonecfg_detach_save(zone_dochandle_t, uint_t);
440 extern	boolean_t zonecfg_detached(const char *);
441 extern	void	zonecfg_rm_detached(zone_dochandle_t, boolean_t forced);
442 extern	int	zonecfg_dev_manifest(zone_dochandle_t);
443 extern	int	zonecfg_devperms_apply(zone_dochandle_t, const char *,
444     uid_t, gid_t, mode_t, const char *);
445 extern	void	zonecfg_set_swinv(zone_dochandle_t);
446 extern	int	zonecfg_add_pkg(zone_dochandle_t, char *, char *);
447 extern	int	zonecfg_add_patch(zone_dochandle_t, char *, void **);
448 extern	int	zonecfg_add_patch_obs(char *, void *);
449 
450 /*
451  * External zone verification support.
452  */
453 extern	int	zonecfg_verify_save(zone_dochandle_t, char *);
454 
455 /*
456  * '*ent' iterator routines.
457  */
458 extern	int	zonecfg_setfsent(zone_dochandle_t);
459 extern	int	zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *);
460 extern	int	zonecfg_endfsent(zone_dochandle_t);
461 extern	int	zonecfg_setipdent(zone_dochandle_t);
462 extern	int	zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *);
463 extern	int	zonecfg_endipdent(zone_dochandle_t);
464 extern	int	zonecfg_setnwifent(zone_dochandle_t);
465 extern	int	zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *);
466 extern	int	zonecfg_endnwifent(zone_dochandle_t);
467 extern	int	zonecfg_setdevent(zone_dochandle_t);
468 extern	int	zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *);
469 extern	int	zonecfg_enddevent(zone_dochandle_t);
470 extern	int	zonecfg_setattrent(zone_dochandle_t);
471 extern	int	zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *);
472 extern	int	zonecfg_endattrent(zone_dochandle_t);
473 extern	int	zonecfg_setrctlent(zone_dochandle_t);
474 extern	int	zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *);
475 extern	int	zonecfg_endrctlent(zone_dochandle_t);
476 extern	int	zonecfg_setdsent(zone_dochandle_t);
477 extern	int	zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *);
478 extern	int	zonecfg_enddsent(zone_dochandle_t);
479 extern	int	zonecfg_getpsetent(zone_dochandle_t, struct zone_psettab *);
480 extern	int	zonecfg_getmcapent(zone_dochandle_t, struct zone_mcaptab *);
481 extern	int	zonecfg_getpkgdata(zone_dochandle_t, uu_avl_pool_t *,
482     uu_avl_t *);
483 extern	int	zonecfg_setdevperment(zone_dochandle_t);
484 extern	int	zonecfg_getdevperment(zone_dochandle_t,
485     struct zone_devpermtab *);
486 extern	int	zonecfg_enddevperment(zone_dochandle_t);
487 
488 /*
489  * Privilege-related functions.
490  */
491 extern	int	zonecfg_default_privset(priv_set_t *, const char *);
492 extern	int	zonecfg_get_privset(zone_dochandle_t, priv_set_t *,
493     char **);
494 extern	int	zonecfg_get_limitpriv(zone_dochandle_t, char **);
495 extern	int	zonecfg_set_limitpriv(zone_dochandle_t, char *);
496 
497 /*
498  * Higher-level routines.
499  */
500 extern  int	zone_get_brand(char *, char *, size_t);
501 extern	int	zone_get_rootpath(char *, char *, size_t);
502 extern	int	zone_get_devroot(char *, char *, size_t);
503 extern	int	zone_get_zonepath(char *, char *, size_t);
504 extern	int	zone_get_state(char *, zone_state_t *);
505 extern	int	zone_set_state(char *, zone_state_t);
506 extern	char	*zone_state_str(zone_state_t);
507 extern	int	zonecfg_get_name_by_uuid(const uuid_t, char *, size_t);
508 extern	int	zonecfg_get_uuid(const char *, uuid_t);
509 extern	int	zonecfg_default_brand(char *, size_t);
510 
511 /*
512  * Iterator for configured zones.
513  */
514 extern FILE		*setzoneent(void);
515 extern char		*getzoneent(FILE *);
516 extern struct zoneent	*getzoneent_private(FILE *);
517 extern void		endzoneent(FILE *);
518 
519 /*
520  * File-system-related convenience functions.
521  */
522 extern boolean_t zonecfg_valid_fs_type(const char *);
523 
524 /*
525  * Network-related convenience functions.
526  */
527 extern boolean_t zonecfg_same_net_address(char *, char *);
528 extern int zonecfg_valid_net_address(char *, struct lifreq *);
529 extern boolean_t zonecfg_ifname_exists(sa_family_t, char *);
530 
531 /*
532  * Rctl-related common functions.
533  */
534 extern boolean_t zonecfg_is_rctl(const char *);
535 extern boolean_t zonecfg_valid_rctlname(const char *);
536 extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *);
537 extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *);
538 extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
539     rctlblk_t *);
540 
541 /*
542  * Live Upgrade support functions.  Shared between ON and install gate.
543  */
544 extern FILE *zonecfg_open_scratch(const char *, boolean_t);
545 extern int zonecfg_lock_scratch(FILE *);
546 extern void zonecfg_close_scratch(FILE *);
547 extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *,
548     size_t);
549 extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
550     size_t);
551 extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t,
552     char *, size_t);
553 extern int zonecfg_add_scratch(FILE *, const char *, const char *,
554     const char *);
555 extern int zonecfg_delete_scratch(FILE *, const char *);
556 extern boolean_t zonecfg_is_scratch(const char *);
557 
558 /*
559  * zoneadmd support functions.  Shared between zoneadm and brand hook code.
560  */
561 extern void zonecfg_init_lock_file(const char *, char **);
562 extern void zonecfg_release_lock_file(const char *, int);
563 extern int zonecfg_grab_lock_file(const char *, int *);
564 extern boolean_t zonecfg_lock_file_held(int *);
565 extern int zonecfg_ping_zoneadmd(const char *);
566 extern int zonecfg_call_zoneadmd(const char *, zone_cmd_arg_t *, char *,
567     boolean_t);
568 
569 #ifdef __cplusplus
570 }
571 #endif
572 
573 #endif	/* _LIBZONECFG_H */
574