xref: /titanic_51/usr/src/head/libzonecfg.h (revision bf1d7e28fd966a3f7e92b40aa301efdedc81ef7b)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5ee519a1fSgjelinek  * Common Development and Distribution License (the "License").
6ee519a1fSgjelinek  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
21ffbafc53Scomay 
227c478bd9Sstevel@tonic-gate /*
23f4b3ec61Sdh155122  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
247c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
257c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate 
277c478bd9Sstevel@tonic-gate #ifndef _LIBZONECFG_H
287c478bd9Sstevel@tonic-gate #define	_LIBZONECFG_H
297c478bd9Sstevel@tonic-gate 
307c478bd9Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
317c478bd9Sstevel@tonic-gate 
327c478bd9Sstevel@tonic-gate /*
337c478bd9Sstevel@tonic-gate  * Zone configuration header file.
347c478bd9Sstevel@tonic-gate  */
357c478bd9Sstevel@tonic-gate 
367c478bd9Sstevel@tonic-gate #ifdef __cplusplus
377c478bd9Sstevel@tonic-gate extern "C" {
387c478bd9Sstevel@tonic-gate #endif
397c478bd9Sstevel@tonic-gate 
407c478bd9Sstevel@tonic-gate /* sys/socket.h is required by net/if.h, which has a constant needed here */
417c478bd9Sstevel@tonic-gate #include <sys/param.h>
427c478bd9Sstevel@tonic-gate #include <sys/fstyp.h>
437c478bd9Sstevel@tonic-gate #include <sys/mount.h>
447c478bd9Sstevel@tonic-gate #include <priv.h>
457c478bd9Sstevel@tonic-gate #include <netinet/in.h>
467c478bd9Sstevel@tonic-gate #include <sys/socket.h>
477c478bd9Sstevel@tonic-gate #include <net/if.h>
487c478bd9Sstevel@tonic-gate #include <stdio.h>
497c478bd9Sstevel@tonic-gate #include <rctl.h>
507c478bd9Sstevel@tonic-gate #include <zone.h>
519acbbeafSnn35248 #include <libbrand.h>
52108322fbScarlsonj #include <sys/uuid.h>
537c478bd9Sstevel@tonic-gate 
547c478bd9Sstevel@tonic-gate #define	ZONE_ID_UNDEFINED	-1
557c478bd9Sstevel@tonic-gate 
567c478bd9Sstevel@tonic-gate #define	Z_OK			0
577c478bd9Sstevel@tonic-gate #define	Z_EMPTY_DOCUMENT	1	/* XML doc root element is null */
587c478bd9Sstevel@tonic-gate #define	Z_WRONG_DOC_TYPE	2	/* top-level XML doc element != zone */
597c478bd9Sstevel@tonic-gate #define	Z_BAD_PROPERTY		3	/* libxml-level property problem */
607c478bd9Sstevel@tonic-gate #define	Z_TEMP_FILE		4	/* problem creating temporary file */
617c478bd9Sstevel@tonic-gate #define	Z_SAVING_FILE		5	/* libxml error saving or validating */
627c478bd9Sstevel@tonic-gate #define	Z_NO_ENTRY		6	/* no such entry */
637c478bd9Sstevel@tonic-gate #define	Z_BOGUS_ZONE_NAME	7	/* illegal zone name */
647c478bd9Sstevel@tonic-gate #define	Z_REQD_RESOURCE_MISSING	8	/* required resource missing */
657c478bd9Sstevel@tonic-gate #define	Z_REQD_PROPERTY_MISSING	9	/* required property missing */
667c478bd9Sstevel@tonic-gate #define	Z_BAD_HANDLE		10	/* bad document handle */
677c478bd9Sstevel@tonic-gate #define	Z_NOMEM			11	/* out of memory (like ENOMEM) */
687c478bd9Sstevel@tonic-gate #define	Z_INVAL			12	/* invalid argument (like EINVAL) */
697c478bd9Sstevel@tonic-gate #define	Z_ACCES			13	/* permission denied (like EACCES) */
707c478bd9Sstevel@tonic-gate #define	Z_TOO_BIG		14	/* string won't fit in char array */
717c478bd9Sstevel@tonic-gate #define	Z_MISC_FS		15	/* miscellaneous file-system error */
727c478bd9Sstevel@tonic-gate #define	Z_NO_ZONE		16	/* no such zone */
737c478bd9Sstevel@tonic-gate #define	Z_NO_RESOURCE_TYPE	17	/* no/wrong resource type */
747c478bd9Sstevel@tonic-gate #define	Z_NO_RESOURCE_ID	18	/* no/wrong resource id */
757c478bd9Sstevel@tonic-gate #define	Z_NO_PROPERTY_TYPE	19	/* no/wrong property type */
767c478bd9Sstevel@tonic-gate #define	Z_NO_PROPERTY_ID	20	/* no/wrong property id */
77087719fdSdp #define	Z_BAD_ZONE_STATE	21	/* zone state invalid for given task */
787c478bd9Sstevel@tonic-gate #define	Z_INVALID_DOCUMENT	22	/* libxml can't validate against DTD */
79087719fdSdp #define	Z_NAME_IN_USE		23	/* zone name already in use (rename) */
807c478bd9Sstevel@tonic-gate #define	Z_NO_SUCH_ID		24	/* delete_index: no old ID */
817c478bd9Sstevel@tonic-gate #define	Z_UPDATING_INDEX	25	/* add/modify/delete_index problem */
827c478bd9Sstevel@tonic-gate #define	Z_LOCKING_FILE		26	/* problem locking index file */
837c478bd9Sstevel@tonic-gate #define	Z_UNLOCKING_FILE	27	/* problem unlocking index file */
847c478bd9Sstevel@tonic-gate #define	Z_SYSTEM		28	/* consult errno instead */
857c478bd9Sstevel@tonic-gate #define	Z_INSUFFICIENT_SPEC	29	/* resource insufficiently specified */
867c478bd9Sstevel@tonic-gate #define	Z_RESOLVED_PATH		34	/* resolved path mismatch */
877c478bd9Sstevel@tonic-gate #define	Z_IPV6_ADDR_PREFIX_LEN	35	/* IPv6 address prefix length needed */
887c478bd9Sstevel@tonic-gate #define	Z_BOGUS_ADDRESS		36	/* not IPv[4|6] address or host name */
89ffbafc53Scomay #define	Z_PRIV_PROHIBITED	37	/* specified privilege is prohibited */
90ffbafc53Scomay #define	Z_PRIV_REQUIRED		38	/* required privilege is missing */
91ffbafc53Scomay #define	Z_PRIV_UNKNOWN		39	/* specified privilege is unknown */
929acbbeafSnn35248 #define	Z_BRAND_ERROR		40	/* brand-specific error */
930209230bSgjelinek #define	Z_INCOMPATIBLE		41	/* incompatible settings */
940209230bSgjelinek #define	Z_ALIAS_DISALLOW	42	/* rctl alias disallowed */
950209230bSgjelinek #define	Z_CLEAR_DISALLOW	43	/* clear property disallowed */
960209230bSgjelinek #define	Z_POOL			44	/* generic libpool error */
970209230bSgjelinek #define	Z_POOLS_NOT_ACTIVE	45	/* pool service not enabled */
980209230bSgjelinek #define	Z_POOL_ENABLE		46	/* pools enable failed */
990209230bSgjelinek #define	Z_NO_POOL		47	/* no such pool configured */
1000209230bSgjelinek #define	Z_POOL_CREATE		48	/* pool create failed */
1010209230bSgjelinek #define	Z_POOL_BIND		49	/* pool bind failed */
1027c478bd9Sstevel@tonic-gate 
1033e9f28f0Scarlsonj /*
1043e9f28f0Scarlsonj  * Warning: these are shared with the admin/install consolidation.
1053e9f28f0Scarlsonj  * Do not insert states between any of the currently defined states,
1063e9f28f0Scarlsonj  * and any new states must be evaluated for impact on range comparisons.
1073e9f28f0Scarlsonj  */
1087c478bd9Sstevel@tonic-gate #define	ZONE_STATE_CONFIGURED		0
1097c478bd9Sstevel@tonic-gate #define	ZONE_STATE_INCOMPLETE		1
1107c478bd9Sstevel@tonic-gate #define	ZONE_STATE_INSTALLED		2
1117c478bd9Sstevel@tonic-gate #define	ZONE_STATE_READY		3
1123e9f28f0Scarlsonj #define	ZONE_STATE_RUNNING		4
1133e9f28f0Scarlsonj #define	ZONE_STATE_SHUTTING_DOWN	5
1143e9f28f0Scarlsonj #define	ZONE_STATE_DOWN			6
1153e9f28f0Scarlsonj #define	ZONE_STATE_MOUNTED		7
1167c478bd9Sstevel@tonic-gate 
1177c478bd9Sstevel@tonic-gate #define	ZONE_STATE_MAXSTRLEN	14
1187c478bd9Sstevel@tonic-gate 
1197c478bd9Sstevel@tonic-gate #define	LIBZONECFG_PATH		"libzonecfg.so.1"
1207c478bd9Sstevel@tonic-gate 
1217c478bd9Sstevel@tonic-gate #define	ZONE_CONFIG_ROOT	"/etc/zones"
1227c478bd9Sstevel@tonic-gate #define	ZONE_INDEX_FILE		ZONE_CONFIG_ROOT "/index"
1237c478bd9Sstevel@tonic-gate 
124555afedfScarlsonj /* Owner, group, and mode (defined by packaging) for the config directory */
125555afedfScarlsonj #define	ZONE_CONFIG_UID		0		/* root */
126555afedfScarlsonj #define	ZONE_CONFIG_GID		3		/* sys */
127555afedfScarlsonj #define	ZONE_CONFIG_MODE	0755
128555afedfScarlsonj 
129555afedfScarlsonj /* Owner, group, and mode (defined by packaging) for the index file */
130555afedfScarlsonj #define	ZONE_INDEX_UID		0		/* root */
131555afedfScarlsonj #define	ZONE_INDEX_GID		3		/* sys */
132555afedfScarlsonj #define	ZONE_INDEX_MODE		0644
133555afedfScarlsonj 
134ee519a1fSgjelinek /* The maximum length of the VERSION string in the pkginfo(4) file. */
135ee519a1fSgjelinek #define	ZONE_PKG_VERSMAX	256
136ee519a1fSgjelinek 
1377c478bd9Sstevel@tonic-gate /*
1380209230bSgjelinek  * Shortened alias names for the zones rctls.
1390209230bSgjelinek  */
1400209230bSgjelinek #define	ALIAS_MAXLWPS		"max-lwps"
1410209230bSgjelinek #define	ALIAS_MAXSHMMEM		"max-shm-memory"
1420209230bSgjelinek #define	ALIAS_MAXSHMIDS		"max-shm-ids"
1430209230bSgjelinek #define	ALIAS_MAXMSGIDS		"max-msg-ids"
1440209230bSgjelinek #define	ALIAS_MAXSEMIDS		"max-sem-ids"
1450209230bSgjelinek #define	ALIAS_MAXLOCKEDMEM	"locked"
1460209230bSgjelinek #define	ALIAS_MAXSWAP		"swap"
1470209230bSgjelinek #define	ALIAS_SHARES		"cpu-shares"
1480209230bSgjelinek 
1490209230bSgjelinek /*
1508cd327d5Sgjelinek  * Bit flag definitions for passing into libzonecfg functions.
1518cd327d5Sgjelinek  */
1528cd327d5Sgjelinek #define	ZONE_DRY_RUN		0x01
1538cd327d5Sgjelinek 
1548cd327d5Sgjelinek /*
1557c478bd9Sstevel@tonic-gate  * The integer field expresses the current values on a get.
1567c478bd9Sstevel@tonic-gate  * On a put, it represents the new values if >= 0 or "don't change" if < 0.
1577c478bd9Sstevel@tonic-gate  */
1587c478bd9Sstevel@tonic-gate struct zoneent {
1597c478bd9Sstevel@tonic-gate 	char	zone_name[ZONENAME_MAX];	/* name of the zone */
1607c478bd9Sstevel@tonic-gate 	int	zone_state;	/* configured | incomplete | installed */
161108322fbScarlsonj 	char	zone_path[MAXPATHLEN];		/* path to zone storage */
162108322fbScarlsonj 	uuid_t	zone_uuid;			/* unique ID for zone */
163087719fdSdp 	char	zone_newname[ZONENAME_MAX];	/* for doing renames */
1647c478bd9Sstevel@tonic-gate };
1657c478bd9Sstevel@tonic-gate 
1667c478bd9Sstevel@tonic-gate typedef struct zone_dochandle *zone_dochandle_t;	/* opaque handle */
1677c478bd9Sstevel@tonic-gate 
1687c478bd9Sstevel@tonic-gate typedef uint_t zone_state_t;
1697c478bd9Sstevel@tonic-gate 
1707c478bd9Sstevel@tonic-gate typedef struct zone_fsopt {
1717c478bd9Sstevel@tonic-gate 	struct zone_fsopt *zone_fsopt_next;
1727c478bd9Sstevel@tonic-gate 	char		   zone_fsopt_opt[MAX_MNTOPT_STR];
1737c478bd9Sstevel@tonic-gate } zone_fsopt_t;
1747c478bd9Sstevel@tonic-gate 
1757c478bd9Sstevel@tonic-gate struct zone_fstab {
1767c478bd9Sstevel@tonic-gate 	char		zone_fs_special[MAXPATHLEN]; 	/* special file */
1777c478bd9Sstevel@tonic-gate 	char		zone_fs_dir[MAXPATHLEN];	/* mount point */
1787c478bd9Sstevel@tonic-gate 	char		zone_fs_type[FSTYPSZ];		/* e.g. ufs */
1797c478bd9Sstevel@tonic-gate 	zone_fsopt_t   *zone_fs_options;		/* mount options */
1807c478bd9Sstevel@tonic-gate 	char		zone_fs_raw[MAXPATHLEN];	/* device to fsck */
1817c478bd9Sstevel@tonic-gate };
1827c478bd9Sstevel@tonic-gate 
1837c478bd9Sstevel@tonic-gate struct zone_nwiftab {
1847c478bd9Sstevel@tonic-gate 	char	zone_nwif_address[INET6_ADDRSTRLEN];
1857c478bd9Sstevel@tonic-gate 	char	zone_nwif_physical[LIFNAMSIZ];
1867c478bd9Sstevel@tonic-gate };
1877c478bd9Sstevel@tonic-gate 
1887c478bd9Sstevel@tonic-gate struct zone_devtab {
1897c478bd9Sstevel@tonic-gate 	char	zone_dev_match[MAXPATHLEN];
1907c478bd9Sstevel@tonic-gate };
1917c478bd9Sstevel@tonic-gate 
1927c478bd9Sstevel@tonic-gate struct zone_rctlvaltab {
1937c478bd9Sstevel@tonic-gate 	char	zone_rctlval_priv[MAXNAMELEN];
1947c478bd9Sstevel@tonic-gate 	char	zone_rctlval_limit[MAXNAMELEN];
1957c478bd9Sstevel@tonic-gate 	char	zone_rctlval_action[MAXNAMELEN];
1967c478bd9Sstevel@tonic-gate 	struct zone_rctlvaltab *zone_rctlval_next;
1977c478bd9Sstevel@tonic-gate };
1987c478bd9Sstevel@tonic-gate 
1997c478bd9Sstevel@tonic-gate struct zone_rctltab {
2007c478bd9Sstevel@tonic-gate 	char	zone_rctl_name[MAXNAMELEN];
2017c478bd9Sstevel@tonic-gate 	struct zone_rctlvaltab *zone_rctl_valptr;
2027c478bd9Sstevel@tonic-gate };
2037c478bd9Sstevel@tonic-gate 
2047c478bd9Sstevel@tonic-gate struct zone_attrtab {
2057c478bd9Sstevel@tonic-gate 	char	zone_attr_name[MAXNAMELEN];
2067c478bd9Sstevel@tonic-gate 	char	zone_attr_type[MAXNAMELEN];
2077c478bd9Sstevel@tonic-gate 	char	zone_attr_value[2 * BUFSIZ];
2087c478bd9Sstevel@tonic-gate };
2097c478bd9Sstevel@tonic-gate 
210fa9e4066Sahrens struct zone_dstab {
211fa9e4066Sahrens 	char	zone_dataset_name[MAXNAMELEN];
212fa9e4066Sahrens };
213fa9e4066Sahrens 
2140209230bSgjelinek struct zone_psettab {
2150209230bSgjelinek 	char	zone_ncpu_min[MAXNAMELEN];
2160209230bSgjelinek 	char	zone_ncpu_max[MAXNAMELEN];
2170209230bSgjelinek 	char	zone_importance[MAXNAMELEN];
2180209230bSgjelinek };
2190209230bSgjelinek 
2200209230bSgjelinek struct zone_mcaptab {
2210209230bSgjelinek 	char	zone_physmem_cap[MAXNAMELEN];
2220209230bSgjelinek };
2230209230bSgjelinek 
224ee519a1fSgjelinek struct zone_pkgtab {
225ee519a1fSgjelinek 	char	zone_pkg_name[MAXNAMELEN];
226ee519a1fSgjelinek 	char	zone_pkg_version[ZONE_PKG_VERSMAX];
227ee519a1fSgjelinek };
228ee519a1fSgjelinek 
229ee519a1fSgjelinek struct zone_patchtab {
230ee519a1fSgjelinek 	char	zone_patch_id[MAXNAMELEN];
231ee519a1fSgjelinek };
232ee519a1fSgjelinek 
233ee519a1fSgjelinek struct zone_devpermtab {
234ee519a1fSgjelinek 	char	zone_devperm_name[MAXPATHLEN];
235ee519a1fSgjelinek 	uid_t	zone_devperm_uid;
236ee519a1fSgjelinek 	gid_t	zone_devperm_gid;
237ee519a1fSgjelinek 	mode_t	zone_devperm_mode;
238ee519a1fSgjelinek 	char	*zone_devperm_acl;
239ee519a1fSgjelinek };
240ee519a1fSgjelinek 
241f4b3ec61Sdh155122 typedef enum zone_iptype {
242f4b3ec61Sdh155122 	ZS_SHARED,
243f4b3ec61Sdh155122 	ZS_EXCLUSIVE
244f4b3ec61Sdh155122 } zone_iptype_t;
245f4b3ec61Sdh155122 
2467c478bd9Sstevel@tonic-gate /*
2477c478bd9Sstevel@tonic-gate  * Basic configuration management routines.
2487c478bd9Sstevel@tonic-gate  */
2497c478bd9Sstevel@tonic-gate extern	zone_dochandle_t	zonecfg_init_handle(void);
250108322fbScarlsonj extern	int	zonecfg_get_handle(const char *, zone_dochandle_t);
251108322fbScarlsonj extern	int	zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
252108322fbScarlsonj extern	int	zonecfg_get_template_handle(const char *, const char *,
253108322fbScarlsonj     zone_dochandle_t);
2549acbbeafSnn35248 extern	int	zonecfg_get_xml_handle(const char *, zone_dochandle_t);
2557c478bd9Sstevel@tonic-gate extern	int	zonecfg_check_handle(zone_dochandle_t);
2567c478bd9Sstevel@tonic-gate extern	void	zonecfg_fini_handle(zone_dochandle_t);
257087719fdSdp extern	int	zonecfg_destroy(const char *, boolean_t);
258108322fbScarlsonj extern	int	zonecfg_destroy_snapshot(const char *);
2597c478bd9Sstevel@tonic-gate extern	int	zonecfg_save(zone_dochandle_t);
260108322fbScarlsonj extern	int	zonecfg_create_snapshot(const char *);
2617c478bd9Sstevel@tonic-gate extern	char	*zonecfg_strerror(int);
2627c478bd9Sstevel@tonic-gate extern	int	zonecfg_access(const char *, int);
263108322fbScarlsonj extern	void	zonecfg_set_root(const char *);
264108322fbScarlsonj extern	const char *zonecfg_get_root(void);
265108322fbScarlsonj extern	boolean_t zonecfg_in_alt_root(void);
2660209230bSgjelinek extern	int	zonecfg_num_resources(zone_dochandle_t, char *);
2670209230bSgjelinek extern	int	zonecfg_del_all_resources(zone_dochandle_t, char *);
2680209230bSgjelinek extern	boolean_t zonecfg_valid_ncpus(char *, char *);
2690209230bSgjelinek extern	boolean_t zonecfg_valid_importance(char *);
2700209230bSgjelinek extern	int	zonecfg_str_to_bytes(char *, uint64_t *);
2710209230bSgjelinek extern	boolean_t zonecfg_valid_memlimit(char *, uint64_t *);
2720209230bSgjelinek extern	boolean_t zonecfg_valid_alias_limit(char *, char *, uint64_t *);
2737c478bd9Sstevel@tonic-gate 
2747c478bd9Sstevel@tonic-gate /*
2750209230bSgjelinek  * Zone name, path to zone directory, autoboot setting, pool, boot
2760209230bSgjelinek  * arguments, and scheduling-class.
2777c478bd9Sstevel@tonic-gate  */
278108322fbScarlsonj extern	int	zonecfg_validate_zonename(const char *);
2797c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_name(zone_dochandle_t, char *, size_t);
2807c478bd9Sstevel@tonic-gate extern	int	zonecfg_set_name(zone_dochandle_t, char *);
2817c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_zonepath(zone_dochandle_t, char *, size_t);
2827c478bd9Sstevel@tonic-gate extern	int	zonecfg_set_zonepath(zone_dochandle_t, char *);
2837c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_autoboot(zone_dochandle_t, boolean_t *);
2847c478bd9Sstevel@tonic-gate extern	int	zonecfg_set_autoboot(zone_dochandle_t, boolean_t);
285f4b3ec61Sdh155122 extern	int	zonecfg_get_iptype(zone_dochandle_t, zone_iptype_t *);
286f4b3ec61Sdh155122 extern	int	zonecfg_set_iptype(zone_dochandle_t, zone_iptype_t);
2877c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_pool(zone_dochandle_t, char *, size_t);
2887c478bd9Sstevel@tonic-gate extern	int	zonecfg_set_pool(zone_dochandle_t, char *);
2893f2f09c1Sdp extern	int	zonecfg_get_bootargs(zone_dochandle_t, char *, size_t);
2903f2f09c1Sdp extern	int	zonecfg_set_bootargs(zone_dochandle_t, char *);
2910209230bSgjelinek extern	int	zonecfg_get_sched_class(zone_dochandle_t, char *, size_t);
2920209230bSgjelinek extern	int	zonecfg_set_sched(zone_dochandle_t, char *);
2930209230bSgjelinek extern	int	zonecfg_get_dflt_sched_class(zone_dochandle_t, char *, int);
2947c478bd9Sstevel@tonic-gate 
2957c478bd9Sstevel@tonic-gate /*
2969acbbeafSnn35248  * Set/retrieve the brand for the zone
2979acbbeafSnn35248  */
2989acbbeafSnn35248 extern	int	zonecfg_get_brand(zone_dochandle_t, char *, size_t);
2999acbbeafSnn35248 extern	int	zonecfg_set_brand(zone_dochandle_t, char *);
3009acbbeafSnn35248 
3019acbbeafSnn35248 /*
3027c478bd9Sstevel@tonic-gate  * Filesystem configuration.
3037c478bd9Sstevel@tonic-gate  */
3047c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *);
3057c478bd9Sstevel@tonic-gate extern	int	zonecfg_delete_filesystem(zone_dochandle_t,
3067c478bd9Sstevel@tonic-gate     struct zone_fstab *);
3077c478bd9Sstevel@tonic-gate extern	int	zonecfg_modify_filesystem(zone_dochandle_t,
3087c478bd9Sstevel@tonic-gate     struct zone_fstab *, struct zone_fstab *);
3097c478bd9Sstevel@tonic-gate extern	int	zonecfg_lookup_filesystem(zone_dochandle_t,
3107c478bd9Sstevel@tonic-gate     struct zone_fstab *);
3117c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *);
3127c478bd9Sstevel@tonic-gate extern	int	zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *);
3137c478bd9Sstevel@tonic-gate extern	int	zonecfg_modify_ipd(zone_dochandle_t,
3147c478bd9Sstevel@tonic-gate     struct zone_fstab *, struct zone_fstab *);
3157c478bd9Sstevel@tonic-gate extern	int	zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *);
3167c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_fs_option(struct zone_fstab *, char *);
3177c478bd9Sstevel@tonic-gate extern	int	zonecfg_remove_fs_option(struct zone_fstab *, char *);
3187c478bd9Sstevel@tonic-gate extern	void	zonecfg_free_fs_option_list(zone_fsopt_t *);
3197c478bd9Sstevel@tonic-gate extern	int 	zonecfg_find_mounts(char *, int(*)(const char *, void *),
3207c478bd9Sstevel@tonic-gate     void *);
3217c478bd9Sstevel@tonic-gate 
3227c478bd9Sstevel@tonic-gate /*
3237c478bd9Sstevel@tonic-gate  * Network interface configuration.
3247c478bd9Sstevel@tonic-gate  */
3257c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *);
3267c478bd9Sstevel@tonic-gate extern	int	zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *);
3277c478bd9Sstevel@tonic-gate extern	int	zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *,
3287c478bd9Sstevel@tonic-gate     struct zone_nwiftab *);
3297c478bd9Sstevel@tonic-gate extern	int	zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *);
3307c478bd9Sstevel@tonic-gate 
3317c478bd9Sstevel@tonic-gate /*
3327c478bd9Sstevel@tonic-gate  * Device configuration and rule matching.
3337c478bd9Sstevel@tonic-gate  */
3347c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *);
3357c478bd9Sstevel@tonic-gate extern	int	zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *);
3367c478bd9Sstevel@tonic-gate extern	int	zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *,
3377c478bd9Sstevel@tonic-gate     struct zone_devtab *);
3387c478bd9Sstevel@tonic-gate extern	int	zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *);
3397c478bd9Sstevel@tonic-gate 
3407c478bd9Sstevel@tonic-gate /*
3417c478bd9Sstevel@tonic-gate  * Resource control configuration.
3427c478bd9Sstevel@tonic-gate  */
3437c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *);
3447c478bd9Sstevel@tonic-gate extern	int	zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *);
3457c478bd9Sstevel@tonic-gate extern	int	zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *,
3467c478bd9Sstevel@tonic-gate     struct zone_rctltab *);
3477c478bd9Sstevel@tonic-gate extern	int	zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *);
3487c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_rctl_value(struct zone_rctltab *,
3497c478bd9Sstevel@tonic-gate     struct zone_rctlvaltab *);
3507c478bd9Sstevel@tonic-gate extern	int	zonecfg_remove_rctl_value(struct zone_rctltab *,
3517c478bd9Sstevel@tonic-gate     struct zone_rctlvaltab *);
3527c478bd9Sstevel@tonic-gate extern	void	zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
3530209230bSgjelinek extern	boolean_t zonecfg_aliased_rctl_ok(zone_dochandle_t, char *);
3540209230bSgjelinek extern	int	zonecfg_set_aliased_rctl(zone_dochandle_t, char *, uint64_t);
3550209230bSgjelinek extern	int	zonecfg_get_aliased_rctl(zone_dochandle_t, char *, uint64_t *);
3560209230bSgjelinek extern	int	zonecfg_rm_aliased_rctl(zone_dochandle_t, char *);
3570209230bSgjelinek extern	int	zonecfg_apply_rctls(char *, zone_dochandle_t);
3587c478bd9Sstevel@tonic-gate 
3597c478bd9Sstevel@tonic-gate /*
3607c478bd9Sstevel@tonic-gate  * Generic attribute configuration and type/value extraction.
3617c478bd9Sstevel@tonic-gate  */
3627c478bd9Sstevel@tonic-gate extern	int	zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *);
3637c478bd9Sstevel@tonic-gate extern	int	zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *);
3647c478bd9Sstevel@tonic-gate extern	int	zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *,
3657c478bd9Sstevel@tonic-gate     struct zone_attrtab *);
3667c478bd9Sstevel@tonic-gate extern	int	zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *);
3677c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_attr_boolean(const struct zone_attrtab *,
3687c478bd9Sstevel@tonic-gate     boolean_t *);
3697c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *);
3707c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_attr_string(const struct zone_attrtab *, char *,
3717c478bd9Sstevel@tonic-gate     size_t);
3727c478bd9Sstevel@tonic-gate extern	int	zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *);
3737c478bd9Sstevel@tonic-gate 
3747c478bd9Sstevel@tonic-gate /*
375fa9e4066Sahrens  * ZFS configuration.
376fa9e4066Sahrens  */
377fa9e4066Sahrens extern	int	zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *);
378fa9e4066Sahrens extern	int	zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *);
379fa9e4066Sahrens extern	int	zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *,
380fa9e4066Sahrens     struct zone_dstab *);
381fa9e4066Sahrens extern	int	zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *);
382fa9e4066Sahrens 
383fa9e4066Sahrens /*
3840209230bSgjelinek  * cpu-set configuration.
3850209230bSgjelinek  */
3860209230bSgjelinek extern	int	zonecfg_add_pset(zone_dochandle_t, struct zone_psettab *);
3870209230bSgjelinek extern	int	zonecfg_delete_pset(zone_dochandle_t);
3880209230bSgjelinek extern	int	zonecfg_modify_pset(zone_dochandle_t, struct zone_psettab *);
3890209230bSgjelinek extern	int	zonecfg_lookup_pset(zone_dochandle_t, struct zone_psettab *);
3900209230bSgjelinek 
3910209230bSgjelinek /*
3920209230bSgjelinek  * mem-cap configuration.
3930209230bSgjelinek  */
3940209230bSgjelinek extern	int	zonecfg_delete_mcap(zone_dochandle_t);
3950209230bSgjelinek extern	int	zonecfg_modify_mcap(zone_dochandle_t, struct zone_mcaptab *);
3960209230bSgjelinek extern	int	zonecfg_lookup_mcap(zone_dochandle_t, struct zone_mcaptab *);
3970209230bSgjelinek 
3980209230bSgjelinek /*
3990209230bSgjelinek  * Temporary pool support functions.
4000209230bSgjelinek  */
4010209230bSgjelinek extern	int	zonecfg_destroy_tmp_pool(char *, char *, int);
4020209230bSgjelinek extern	int	zonecfg_bind_tmp_pool(zone_dochandle_t, zoneid_t, char *, int);
4030209230bSgjelinek extern	int	zonecfg_bind_pool(zone_dochandle_t, zoneid_t, char *, int);
4040209230bSgjelinek extern	boolean_t zonecfg_warn_poold(zone_dochandle_t);
4050209230bSgjelinek 
4060209230bSgjelinek /*
4070209230bSgjelinek  * Miscellaneous utility functions.
4080209230bSgjelinek  */
4090209230bSgjelinek extern	int	zonecfg_enable_rcapd(char *, int);
4100209230bSgjelinek 
4110209230bSgjelinek /*
412ee519a1fSgjelinek  * attach/detach support.
413ee519a1fSgjelinek  */
414ee519a1fSgjelinek extern	int	zonecfg_get_attach_handle(const char *, const char *,
415ee519a1fSgjelinek     boolean_t, zone_dochandle_t);
4168cd327d5Sgjelinek extern	int	zonecfg_attach_manifest(int, zone_dochandle_t,
4178cd327d5Sgjelinek     zone_dochandle_t);
4188cd327d5Sgjelinek extern	int	zonecfg_detach_save(zone_dochandle_t, uint_t);
419ee519a1fSgjelinek extern	int	zonecfg_get_detach_info(zone_dochandle_t, boolean_t);
420ee519a1fSgjelinek extern	boolean_t zonecfg_detached(const char *);
421ee519a1fSgjelinek extern	void	zonecfg_rm_detached(zone_dochandle_t, boolean_t forced);
422ee519a1fSgjelinek extern	int	zonecfg_devwalk(zone_dochandle_t handle,
423ee519a1fSgjelinek     int (*cb)(const char *, uid_t, gid_t, mode_t, const char *, void *),
424ee519a1fSgjelinek     void *data);
425ee519a1fSgjelinek extern	int	zonecfg_devperms_apply(zone_dochandle_t, const char *,
426ee519a1fSgjelinek     uid_t, gid_t, mode_t, const char *);
427ee519a1fSgjelinek 
4289acbbeafSnn35248 /*
4299acbbeafSnn35248  * External zone verification support.
4309acbbeafSnn35248  */
4319acbbeafSnn35248 extern	int	zonecfg_verify_save(zone_dochandle_t, char *);
432ee519a1fSgjelinek 
433ee519a1fSgjelinek /*
4347c478bd9Sstevel@tonic-gate  * '*ent' iterator routines.
4357c478bd9Sstevel@tonic-gate  */
4367c478bd9Sstevel@tonic-gate extern	int	zonecfg_setfsent(zone_dochandle_t);
4377c478bd9Sstevel@tonic-gate extern	int	zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *);
4387c478bd9Sstevel@tonic-gate extern	int	zonecfg_endfsent(zone_dochandle_t);
4397c478bd9Sstevel@tonic-gate extern	int	zonecfg_setipdent(zone_dochandle_t);
4407c478bd9Sstevel@tonic-gate extern	int	zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *);
4417c478bd9Sstevel@tonic-gate extern	int	zonecfg_endipdent(zone_dochandle_t);
4427c478bd9Sstevel@tonic-gate extern	int	zonecfg_setnwifent(zone_dochandle_t);
4437c478bd9Sstevel@tonic-gate extern	int	zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *);
4447c478bd9Sstevel@tonic-gate extern	int	zonecfg_endnwifent(zone_dochandle_t);
4457c478bd9Sstevel@tonic-gate extern	int	zonecfg_setdevent(zone_dochandle_t);
4467c478bd9Sstevel@tonic-gate extern	int	zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *);
4477c478bd9Sstevel@tonic-gate extern	int	zonecfg_enddevent(zone_dochandle_t);
4487c478bd9Sstevel@tonic-gate extern	int	zonecfg_setattrent(zone_dochandle_t);
4497c478bd9Sstevel@tonic-gate extern	int	zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *);
4507c478bd9Sstevel@tonic-gate extern	int	zonecfg_endattrent(zone_dochandle_t);
4517c478bd9Sstevel@tonic-gate extern	int	zonecfg_setrctlent(zone_dochandle_t);
4527c478bd9Sstevel@tonic-gate extern	int	zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *);
4537c478bd9Sstevel@tonic-gate extern	int	zonecfg_endrctlent(zone_dochandle_t);
454fa9e4066Sahrens extern	int	zonecfg_setdsent(zone_dochandle_t);
455fa9e4066Sahrens extern	int	zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *);
456fa9e4066Sahrens extern	int	zonecfg_enddsent(zone_dochandle_t);
4570209230bSgjelinek extern	int	zonecfg_getpsetent(zone_dochandle_t, struct zone_psettab *);
4580209230bSgjelinek extern	int	zonecfg_getmcapent(zone_dochandle_t, struct zone_mcaptab *);
459ee519a1fSgjelinek extern	int	zonecfg_setpkgent(zone_dochandle_t);
460ee519a1fSgjelinek extern	int	zonecfg_getpkgent(zone_dochandle_t, struct zone_pkgtab *);
461ee519a1fSgjelinek extern	int	zonecfg_endpkgent(zone_dochandle_t);
462ee519a1fSgjelinek extern	int	zonecfg_setpatchent(zone_dochandle_t);
463ee519a1fSgjelinek extern	int	zonecfg_getpatchent(zone_dochandle_t, struct zone_patchtab *);
464ee519a1fSgjelinek extern	int	zonecfg_endpatchent(zone_dochandle_t);
465ee519a1fSgjelinek extern	int	zonecfg_setdevperment(zone_dochandle_t);
466ee519a1fSgjelinek extern	int	zonecfg_getdevperment(zone_dochandle_t,
467ee519a1fSgjelinek     struct zone_devpermtab *);
468ee519a1fSgjelinek extern	int	zonecfg_enddevperment(zone_dochandle_t);
4697c478bd9Sstevel@tonic-gate 
4707c478bd9Sstevel@tonic-gate /*
4717c478bd9Sstevel@tonic-gate  * Privilege-related functions.
4727c478bd9Sstevel@tonic-gate  */
473*bf1d7e28Sdh155122 extern	int	zonecfg_default_privset(priv_set_t *, const char *);
474ffbafc53Scomay extern	int	zonecfg_get_privset(zone_dochandle_t, priv_set_t *,
475ffbafc53Scomay     char **);
476ffbafc53Scomay extern	int	zonecfg_get_limitpriv(zone_dochandle_t, char **);
477ffbafc53Scomay extern	int	zonecfg_set_limitpriv(zone_dochandle_t, char *);
4787c478bd9Sstevel@tonic-gate 
4797c478bd9Sstevel@tonic-gate /*
4807c478bd9Sstevel@tonic-gate  * Higher-level routines.
4817c478bd9Sstevel@tonic-gate  */
4829acbbeafSnn35248 extern  int	zone_get_brand(char *, char *, size_t);
4837c478bd9Sstevel@tonic-gate extern	int	zone_get_rootpath(char *, char *, size_t);
484facf4a8dSllai1 extern	int	zone_get_devroot(char *, char *, size_t);
4857c478bd9Sstevel@tonic-gate extern	int	zone_get_zonepath(char *, char *, size_t);
4867c478bd9Sstevel@tonic-gate extern	int	zone_get_state(char *, zone_state_t *);
4877c478bd9Sstevel@tonic-gate extern	int	zone_set_state(char *, zone_state_t);
4887c478bd9Sstevel@tonic-gate extern	char	*zone_state_str(zone_state_t);
489108322fbScarlsonj extern	int	zonecfg_get_name_by_uuid(const uuid_t, char *, size_t);
490108322fbScarlsonj extern	int	zonecfg_get_uuid(const char *, uuid_t);
4917c478bd9Sstevel@tonic-gate 
4927c478bd9Sstevel@tonic-gate /*
4937c478bd9Sstevel@tonic-gate  * Iterator for configured zones.
4947c478bd9Sstevel@tonic-gate  */
4957c478bd9Sstevel@tonic-gate extern FILE		*setzoneent(void);
4967c478bd9Sstevel@tonic-gate extern char		*getzoneent(FILE *);
4977c478bd9Sstevel@tonic-gate extern struct zoneent	*getzoneent_private(FILE *);
4987c478bd9Sstevel@tonic-gate extern void		endzoneent(FILE *);
4997c478bd9Sstevel@tonic-gate 
5007c478bd9Sstevel@tonic-gate /*
5017c478bd9Sstevel@tonic-gate  * File-system-related convenience functions.
5027c478bd9Sstevel@tonic-gate  */
5037c478bd9Sstevel@tonic-gate extern boolean_t zonecfg_valid_fs_type(const char *);
5047c478bd9Sstevel@tonic-gate 
5057c478bd9Sstevel@tonic-gate /*
5067c478bd9Sstevel@tonic-gate  * Network-related convenience functions.
5077c478bd9Sstevel@tonic-gate  */
5087c478bd9Sstevel@tonic-gate extern boolean_t zonecfg_same_net_address(char *, char *);
5097c478bd9Sstevel@tonic-gate extern int zonecfg_valid_net_address(char *, struct lifreq *);
510f4b3ec61Sdh155122 extern boolean_t zonecfg_ifname_exists(sa_family_t, char *);
5117c478bd9Sstevel@tonic-gate 
5127c478bd9Sstevel@tonic-gate /*
5137c478bd9Sstevel@tonic-gate  * Rctl-related common functions.
5147c478bd9Sstevel@tonic-gate  */
5157c478bd9Sstevel@tonic-gate extern boolean_t zonecfg_is_rctl(const char *);
5167c478bd9Sstevel@tonic-gate extern boolean_t zonecfg_valid_rctlname(const char *);
5177c478bd9Sstevel@tonic-gate extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *);
5187c478bd9Sstevel@tonic-gate extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *);
5197c478bd9Sstevel@tonic-gate extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
5207c478bd9Sstevel@tonic-gate     rctlblk_t *);
5217c478bd9Sstevel@tonic-gate 
522108322fbScarlsonj /*
523108322fbScarlsonj  * Live Upgrade support functions.  Shared between ON and install gate.
524108322fbScarlsonj  */
525108322fbScarlsonj extern FILE *zonecfg_open_scratch(const char *, boolean_t);
526108322fbScarlsonj extern int zonecfg_lock_scratch(FILE *);
527108322fbScarlsonj extern void zonecfg_close_scratch(FILE *);
528108322fbScarlsonj extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *,
529108322fbScarlsonj     size_t);
530108322fbScarlsonj extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
531108322fbScarlsonj     size_t);
532108322fbScarlsonj extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t,
533108322fbScarlsonj     char *, size_t);
534108322fbScarlsonj extern int zonecfg_add_scratch(FILE *, const char *, const char *,
535108322fbScarlsonj     const char *);
536108322fbScarlsonj extern int zonecfg_delete_scratch(FILE *, const char *);
537108322fbScarlsonj extern boolean_t zonecfg_is_scratch(const char *);
538108322fbScarlsonj 
5397c478bd9Sstevel@tonic-gate #ifdef __cplusplus
5407c478bd9Sstevel@tonic-gate }
5417c478bd9Sstevel@tonic-gate #endif
5427c478bd9Sstevel@tonic-gate 
5437c478bd9Sstevel@tonic-gate #endif	/* _LIBZONECFG_H */
544