libzonecfg.h revision c97ad5cdc75eb73e3cc38542ca3ba783574b0a7a
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _LIBZONECFG_H
#define _LIBZONECFG_H
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Zone configuration header file.
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <priv.h>
#include <stdio.h>
#include <rctl.h>
#include <zone.h>
#include <libbrand.h>
#define ZONE_ID_UNDEFINED -1
#define Z_OK 0
/*
* Do not insert states between any of the currently defined states,
* and any new states must be evaluated for impact on range comparisons.
*/
#define ZONE_STATE_CONFIGURED 0
#define ZONE_STATE_INCOMPLETE 1
#define ZONE_STATE_INSTALLED 2
#define ZONE_STATE_READY 3
#define ZONE_STATE_RUNNING 4
#define ZONE_STATE_SHUTTING_DOWN 5
#define ZONE_STATE_DOWN 6
#define ZONE_STATE_MOUNTED 7
#define ZONE_STATE_MAXSTRLEN 14
#define LIBZONECFG_PATH "libzonecfg.so.1"
#define ZONE_CONFIG_ROOT "/etc/zones"
/* Owner, group, and mode (defined by packaging) for the config directory */
#define ZONE_CONFIG_UID 0 /* root */
#define ZONE_CONFIG_MODE 0755
/* Owner, group, and mode (defined by packaging) for the index file */
#define ZONE_INDEX_UID 0 /* root */
#define ZONE_INDEX_MODE 0644
/* The maximum length of the VERSION string in the pkginfo(4) file. */
#define ZONE_PKG_VERSMAX 256
/*
* Shortened alias names for the zones rctls.
*/
#define ALIAS_MAXLWPS "max-lwps"
#define ALIAS_MAXSHMMEM "max-shm-memory"
#define ALIAS_MAXSHMIDS "max-shm-ids"
#define ALIAS_MAXMSGIDS "max-msg-ids"
#define ALIAS_MAXSEMIDS "max-sem-ids"
#define ALIAS_MAXLOCKEDMEM "locked"
#define ALIAS_MAXSWAP "swap"
#define ALIAS_SHARES "cpu-shares"
#define ALIAS_CPUCAP "cpu-cap"
/*
* Bit flag definitions for passing into libzonecfg functions.
*/
#define ZONE_DRY_RUN 0x01
/*
* The integer field expresses the current values on a get.
* On a put, it represents the new values if >= 0 or "don't change" if < 0.
*/
struct zoneent {
int zone_state; /* configured | incomplete | installed */
};
typedef uint_t zone_state_t;
typedef struct zone_fsopt {
struct zone_fsopt *zone_fsopt_next;
char zone_fsopt_opt[MAX_MNTOPT_STR];
} zone_fsopt_t;
struct zone_fstab {
};
struct zone_nwiftab {
char zone_nwif_physical[LIFNAMSIZ];
};
struct zone_devtab {
char zone_dev_match[MAXPATHLEN];
};
struct zone_rctlvaltab {
char zone_rctlval_priv[MAXNAMELEN];
char zone_rctlval_limit[MAXNAMELEN];
char zone_rctlval_action[MAXNAMELEN];
struct zone_rctlvaltab *zone_rctlval_next;
};
struct zone_rctltab {
char zone_rctl_name[MAXNAMELEN];
struct zone_rctlvaltab *zone_rctl_valptr;
};
struct zone_attrtab {
char zone_attr_name[MAXNAMELEN];
char zone_attr_type[MAXNAMELEN];
};
struct zone_dstab {
char zone_dataset_name[MAXNAMELEN];
};
struct zone_psettab {
char zone_ncpu_min[MAXNAMELEN];
char zone_ncpu_max[MAXNAMELEN];
char zone_importance[MAXNAMELEN];
};
struct zone_mcaptab {
char zone_physmem_cap[MAXNAMELEN];
};
struct zone_pkgtab {
char zone_pkg_name[MAXNAMELEN];
char zone_pkg_version[ZONE_PKG_VERSMAX];
};
struct zone_patchtab {
char zone_patch_id[MAXNAMELEN];
};
struct zone_devpermtab {
char zone_devperm_name[MAXPATHLEN];
char *zone_devperm_acl;
};
typedef enum zone_iptype {
/*
* Basic configuration management routines.
*/
extern zone_dochandle_t zonecfg_init_handle(void);
extern int zonecfg_get_handle(const char *, zone_dochandle_t);
extern int zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
extern int zonecfg_get_template_handle(const char *, const char *,
extern int zonecfg_get_xml_handle(const char *, zone_dochandle_t);
extern int zonecfg_check_handle(zone_dochandle_t);
extern void zonecfg_fini_handle(zone_dochandle_t);
extern int zonecfg_destroy(const char *, boolean_t);
extern int zonecfg_destroy_snapshot(const char *);
extern int zonecfg_save(zone_dochandle_t);
extern int zonecfg_create_snapshot(const char *);
extern char *zonecfg_strerror(int);
extern int zonecfg_access(const char *, int);
extern void zonecfg_set_root(const char *);
extern const char *zonecfg_get_root(void);
extern boolean_t zonecfg_in_alt_root(void);
extern int zonecfg_num_resources(zone_dochandle_t, char *);
extern int zonecfg_del_all_resources(zone_dochandle_t, char *);
extern boolean_t zonecfg_valid_ncpus(char *, char *);
extern boolean_t zonecfg_valid_importance(char *);
extern int zonecfg_str_to_bytes(char *, uint64_t *);
/*
* Zone name, path to zone directory, autoboot setting, pool, boot
* arguments, and scheduling-class.
*/
extern int zonecfg_validate_zonename(const char *);
extern int zonecfg_set_name(zone_dochandle_t, char *);
extern int zonecfg_set_zonepath(zone_dochandle_t, char *);
extern int zonecfg_set_pool(zone_dochandle_t, char *);
extern int zonecfg_set_bootargs(zone_dochandle_t, char *);
extern int zonecfg_set_sched(zone_dochandle_t, char *);
extern int zonecfg_get_dflt_sched_class(zone_dochandle_t, char *, int);
/*
*/
extern int zonecfg_set_brand(zone_dochandle_t, char *);
/*
* Filesystem configuration.
*/
extern int zonecfg_delete_filesystem(zone_dochandle_t,
struct zone_fstab *);
extern int zonecfg_modify_filesystem(zone_dochandle_t,
struct zone_fstab *, struct zone_fstab *);
extern int zonecfg_lookup_filesystem(zone_dochandle_t,
struct zone_fstab *);
extern int zonecfg_modify_ipd(zone_dochandle_t,
struct zone_fstab *, struct zone_fstab *);
extern int zonecfg_add_fs_option(struct zone_fstab *, char *);
extern int zonecfg_remove_fs_option(struct zone_fstab *, char *);
extern void zonecfg_free_fs_option_list(zone_fsopt_t *);
extern int zonecfg_find_mounts(char *, int(*)(const char *, void *),
void *);
/*
* Network interface configuration.
*/
struct zone_nwiftab *);
/*
* Device configuration and rule matching.
*/
struct zone_devtab *);
/*
* Resource control configuration.
*/
struct zone_rctltab *);
extern int zonecfg_add_rctl_value(struct zone_rctltab *,
struct zone_rctlvaltab *);
extern int zonecfg_remove_rctl_value(struct zone_rctltab *,
struct zone_rctlvaltab *);
extern void zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
extern int zonecfg_rm_aliased_rctl(zone_dochandle_t, char *);
extern int zonecfg_apply_rctls(char *, zone_dochandle_t);
/*
*/
struct zone_attrtab *);
extern int zonecfg_get_attr_boolean(const struct zone_attrtab *,
boolean_t *);
extern int zonecfg_get_attr_string(const struct zone_attrtab *, char *,
size_t);
/*
* ZFS configuration.
*/
struct zone_dstab *);
/*
* cpu-set configuration.
*/
extern int zonecfg_delete_pset(zone_dochandle_t);
/*
* mem-cap configuration.
*/
extern int zonecfg_delete_mcap(zone_dochandle_t);
/*
* Temporary pool support functions.
*/
extern int zonecfg_destroy_tmp_pool(char *, char *, int);
/*
* Miscellaneous utility functions.
*/
extern int zonecfg_enable_rcapd(char *, int);
/*
*/
extern int zonecfg_get_attach_handle(const char *, const char *,
extern int zonecfg_attach_manifest(int, zone_dochandle_t,
extern boolean_t zonecfg_detached(const char *);
void *data);
extern int zonecfg_devperms_apply(zone_dochandle_t, const char *,
/*
* External zone verification support.
*/
extern int zonecfg_verify_save(zone_dochandle_t, char *);
/*
* '*ent' iterator routines.
*/
extern int zonecfg_setfsent(zone_dochandle_t);
extern int zonecfg_endfsent(zone_dochandle_t);
extern int zonecfg_setipdent(zone_dochandle_t);
extern int zonecfg_endipdent(zone_dochandle_t);
extern int zonecfg_setnwifent(zone_dochandle_t);
extern int zonecfg_endnwifent(zone_dochandle_t);
extern int zonecfg_setdevent(zone_dochandle_t);
extern int zonecfg_enddevent(zone_dochandle_t);
extern int zonecfg_setattrent(zone_dochandle_t);
extern int zonecfg_endattrent(zone_dochandle_t);
extern int zonecfg_setrctlent(zone_dochandle_t);
extern int zonecfg_endrctlent(zone_dochandle_t);
extern int zonecfg_setdsent(zone_dochandle_t);
extern int zonecfg_enddsent(zone_dochandle_t);
extern int zonecfg_setpkgent(zone_dochandle_t);
extern int zonecfg_endpkgent(zone_dochandle_t);
extern int zonecfg_setpatchent(zone_dochandle_t);
extern int zonecfg_endpatchent(zone_dochandle_t);
extern int zonecfg_setdevperment(zone_dochandle_t);
extern int zonecfg_getdevperment(zone_dochandle_t,
struct zone_devpermtab *);
extern int zonecfg_enddevperment(zone_dochandle_t);
/*
* Privilege-related functions.
*/
extern int zonecfg_default_privset(priv_set_t *, const char *);
char **);
extern int zonecfg_get_limitpriv(zone_dochandle_t, char **);
extern int zonecfg_set_limitpriv(zone_dochandle_t, char *);
/*
* Higher-level routines.
*/
extern int zone_get_brand(char *, char *, size_t);
extern int zone_get_rootpath(char *, char *, size_t);
extern int zone_get_devroot(char *, char *, size_t);
extern int zone_get_zonepath(char *, char *, size_t);
extern int zone_get_state(char *, zone_state_t *);
extern int zone_set_state(char *, zone_state_t);
extern char *zone_state_str(zone_state_t);
extern int zonecfg_get_uuid(const char *, uuid_t);
/*
* Iterator for configured zones.
*/
extern FILE *setzoneent(void);
extern char *getzoneent(FILE *);
extern void endzoneent(FILE *);
/*
* File-system-related convenience functions.
*/
extern boolean_t zonecfg_valid_fs_type(const char *);
/*
* Network-related convenience functions.
*/
extern boolean_t zonecfg_same_net_address(char *, char *);
extern int zonecfg_valid_net_address(char *, struct lifreq *);
/*
* Rctl-related common functions.
*/
extern boolean_t zonecfg_is_rctl(const char *);
extern boolean_t zonecfg_valid_rctlname(const char *);
extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
rctlblk_t *);
/*
* Live Upgrade support functions. Shared between ON and install gate.
*/
extern int zonecfg_lock_scratch(FILE *);
extern void zonecfg_close_scratch(FILE *);
size_t);
extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
size_t);
char *, size_t);
extern int zonecfg_add_scratch(FILE *, const char *, const char *,
const char *);
extern int zonecfg_delete_scratch(FILE *, const char *);
extern boolean_t zonecfg_is_scratch(const char *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBZONECFG_H */