libshare.h revision 6733190958bbcc0bd6d1d601e7ae0a6994dafb45
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * CDDL HEADER START
6185db853e024a486ff8837e6784dd290d866112dougm *
6185db853e024a486ff8837e6784dd290d866112dougm * The contents of this file are subject to the terms of the
6185db853e024a486ff8837e6784dd290d866112dougm * Common Development and Distribution License (the "License").
6185db853e024a486ff8837e6784dd290d866112dougm * You may not use this file except in compliance with the License.
6185db853e024a486ff8837e6784dd290d866112dougm *
6185db853e024a486ff8837e6784dd290d866112dougm * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
6185db853e024a486ff8837e6784dd290d866112dougm * or http://www.opensolaris.org/os/licensing.
6185db853e024a486ff8837e6784dd290d866112dougm * See the License for the specific language governing permissions
6185db853e024a486ff8837e6784dd290d866112dougm * and limitations under the License.
6185db853e024a486ff8837e6784dd290d866112dougm *
6185db853e024a486ff8837e6784dd290d866112dougm * When distributing Covered Code, include this CDDL HEADER in each
6185db853e024a486ff8837e6784dd290d866112dougm * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
6185db853e024a486ff8837e6784dd290d866112dougm * If applicable, add the following below this CDDL HEADER, with the
6185db853e024a486ff8837e6784dd290d866112dougm * fields enclosed by brackets "[]" replaced with your own identifying
6185db853e024a486ff8837e6784dd290d866112dougm * information: Portions Copyright [yyyy] [name of copyright owner]
6185db853e024a486ff8837e6784dd290d866112dougm *
6185db853e024a486ff8837e6784dd290d866112dougm * CDDL HEADER END
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
f345c0beb4c8f75cb54c2e070498e56febd468acdougm * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
6185db853e024a486ff8837e6784dd290d866112dougm * Use is subject to license terms.
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * basic API declarations for share management
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#ifndef _LIBSHARE_H
6185db853e024a486ff8837e6784dd290d866112dougm#define _LIBSHARE_H
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#pragma ident "%Z%%M% %I% %E% SMI"
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#ifdef __cplusplus
6185db853e024a486ff8837e6784dd290d866112dougmextern "C" {
6185db853e024a486ff8837e6784dd290d866112dougm#endif
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * Basic datatypes for most functions
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_group_t;
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_share_t;
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_property_t;
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_optionset_t;
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_security_t;
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_protocol_properties_t;
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougmtypedef void *sa_handle_t; /* opaque handle to access core functions */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * defined error values
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_OK 0
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NO_SUCH_PATH 1 /* provided path doesn't exist */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NO_MEMORY 2 /* no memory for data structures */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_DUPLICATE_NAME 3 /* object name is already in use */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_BAD_PATH 4 /* not a full path */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NO_SUCH_GROUP 5 /* group is not defined */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_CONFIG_ERR 6 /* system configuration error */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_SYSTEM_ERR 7 /* system error, use errno */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_SYNTAX_ERR 8 /* syntax error on command line */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NO_PERMISSION 9 /* no permission for operation */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_BUSY 10 /* resource is busy */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NO_SUCH_PROP 11 /* property doesn't exist */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_INVALID_NAME 12 /* name of object is invalid */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_INVALID_PROTOCOL 13 /* specified protocol not valid */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NOT_ALLOWED 14 /* operation not allowed */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_BAD_VALUE 15 /* bad value for property */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_INVALID_SECURITY 16 /* invalid security type */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NO_SUCH_SECURITY 17 /* security set not found */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_VALUE_CONFLICT 18 /* property value conflict */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NOT_IMPLEMENTED 19 /* plugin interface not implemented */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_INVALID_PATH 20 /* path is sub-dir of existing share */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NOT_SUPPORTED 21 /* operation not supported for proto */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_PROP_SHARE_ONLY 22 /* property valid on share only */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_NOT_SHARED 23 /* path is not shared */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* API Initialization */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_INIT_SHARE_API 0x0001 /* init share specific interface */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_INIT_CONTROL_API 0x0002 /* init control specific interface */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* not part of API returns */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_LEGACY_ERR 32 /* share/unshare error return */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * other defined values
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_MAX_NAME_LEN 100 /* must fit service instance name */
f345c0beb4c8f75cb54c2e070498e56febd468acdougm
f345c0beb4c8f75cb54c2e070498e56febd468acdougm/* Used in calls to sa_add_share() */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_SHARE_TRANSIENT 0 /* shared but not across reboot */
f345c0beb4c8f75cb54c2e070498e56febd468acdougm#define SA_SHARE_LEGACY 1 /* share is in dfstab only */
f345c0beb4c8f75cb54c2e070498e56febd468acdougm#define SA_SHARE_PERMANENT 2 /* share goes to repository */
f345c0beb4c8f75cb54c2e070498e56febd468acdougm
f345c0beb4c8f75cb54c2e070498e56febd468acdougm/* sa_check_path() related */
f345c0beb4c8f75cb54c2e070498e56febd468acdougm#define SA_CHECK_NORMAL 0 /* only check against active shares */
f345c0beb4c8f75cb54c2e070498e56febd468acdougm#define SA_CHECK_STRICT 1 /* check against all shares */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* RBAC related */
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_RBAC_MANAGE "solaris.smf.manage.shares"
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_RBAC_VALUE "solaris.smf.value.shares"
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * legacy files
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_LEGACY_DFSTAB "/etc/dfs/dfstab"
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_LEGACY_SHARETAB "/etc/dfs/sharetab"
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/*
6185db853e024a486ff8837e6784dd290d866112dougm * SMF related
6185db853e024a486ff8837e6784dd290d866112dougm */
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#define SA_SVC_FMRI_BASE "svc:/network/shares/group"
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* initialization */
549ec3fff108310966327d1dc9004551b63210b7dougmextern sa_handle_t sa_init(int);
549ec3fff108310966327d1dc9004551b63210b7dougmextern void sa_fini(sa_handle_t);
549ec3fff108310966327d1dc9004551b63210b7dougmextern int sa_update_config(sa_handle_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_errorstr(int);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* protocol names */
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_get_protocols(char ***);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_valid_protocol(char *);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* group control (create, remove, etc) */
549ec3fff108310966327d1dc9004551b63210b7dougmextern sa_group_t sa_create_group(sa_handle_t, char *, int *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_remove_group(sa_group_t);
549ec3fff108310966327d1dc9004551b63210b7dougmextern sa_group_t sa_get_group(sa_handle_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_group_t sa_get_next_group(sa_group_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_group_attr(sa_group_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_set_group_attr(sa_group_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_group_t sa_get_sub_group(sa_group_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_valid_group_name(char *);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* share control */
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_share_t sa_add_share(sa_group_t, char *, int, int *);
f345c0beb4c8f75cb54c2e070498e56febd468acdougmextern int sa_check_path(sa_group_t, char *, int);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_move_share(sa_group_t, sa_share_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_remove_share(sa_share_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_share_t sa_get_share(sa_group_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_share_t sa_get_resource(sa_group_t, char *);
549ec3fff108310966327d1dc9004551b63210b7dougmextern sa_share_t sa_find_share(sa_handle_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_share_t sa_get_next_share(sa_share_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_share_attr(sa_share_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_share_description(sa_share_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_group_t sa_get_parent_group(sa_share_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_set_share_attr(sa_share_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_set_share_description(sa_share_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_enable_share(sa_group_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_disable_share(sa_group_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_is_share(void *);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* data structure free calls */
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_free_attr_string(char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_free_share_description(char *);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* optionset control */
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_optionset_t sa_get_optionset(sa_group_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_optionset_t sa_get_next_optionset(sa_group_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_optionset_attr(sa_optionset_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_set_optionset_attr(sa_optionset_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_optionset_t sa_create_optionset(sa_group_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_destroy_optionset(sa_optionset_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_optionset_t sa_get_derived_optionset(void *, char *, int);
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_free_derived_optionset(sa_optionset_t);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* property functions */
6733190958bbcc0bd6d1d601e7ae0a6994dafb45dougmextern sa_property_t sa_get_property(sa_optionset_t, char *);
6733190958bbcc0bd6d1d601e7ae0a6994dafb45dougmextern sa_property_t sa_get_next_property(sa_group_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_property_attr(sa_property_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_property_t sa_create_property(char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_add_property(void *, sa_property_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_update_property(sa_property_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_remove_property(sa_property_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_commit_properties(sa_optionset_t, int);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_valid_property(void *, char *, sa_property_t);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* security control */
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_security_t sa_get_security(sa_group_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_security_t sa_get_next_security(sa_security_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_security_attr(sa_optionset_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_security_t sa_create_security(sa_group_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_destroy_security(sa_security_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_set_security_attr(sa_security_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_optionset_t sa_get_all_security_types(void *, char *, int);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_security_t sa_get_derived_security(void *, char *, char *, int);
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_free_derived_security(sa_security_t);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* protocol specific interfaces */
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_parse_legacy_options(sa_group_t, char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_proto_legacy_format(char *, sa_group_t, int);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_is_security(char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_protocol_properties_t sa_proto_get_properties(char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_property_t sa_get_protocol_property(sa_protocol_properties_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_property_t sa_get_next_protocol_property(sa_property_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_set_protocol_property(sa_property_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_get_protocol_status(char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern void sa_format_free(char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern sa_protocol_properties_t sa_create_protocol_properties(char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_add_protocol_property(sa_protocol_properties_t, sa_property_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_proto_valid_prop(char *, sa_property_t, sa_optionset_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_proto_valid_space(char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern char *sa_proto_space_alias(char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* handle legacy (dfstab/sharetab) files */
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_delete_legacy(sa_share_t);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_update_legacy(sa_share_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_update_sharetab(sa_share_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_delete_sharetab(char *, char *);
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm/* ZFS functions */
549ec3fff108310966327d1dc9004551b63210b7dougmextern int sa_zfs_is_shared(sa_handle_t, char *);
6185db853e024a486ff8837e6784dd290d866112dougmextern int sa_group_is_zfs(sa_group_t);
549ec3fff108310966327d1dc9004551b63210b7dougm
549ec3fff108310966327d1dc9004551b63210b7dougm
549ec3fff108310966327d1dc9004551b63210b7dougm/* SA Handle specific functions */
549ec3fff108310966327d1dc9004551b63210b7dougmextern sa_handle_t sa_find_group_handle(sa_group_t);
549ec3fff108310966327d1dc9004551b63210b7dougm
6185db853e024a486ff8837e6784dd290d866112dougm#ifdef __cplusplus
6185db853e024a486ff8837e6784dd290d866112dougm}
6185db853e024a486ff8837e6784dd290d866112dougm#endif
6185db853e024a486ff8837e6784dd290d866112dougm
6185db853e024a486ff8837e6784dd290d866112dougm#endif /* _LIBSHARE_H */