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 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* 28 * basic API declarations for share management 29 */ 30 31 #ifndef _LIBSHARE_H 32 #define _LIBSHARE_H 33 34 #pragma ident "%Z%%M% %I% %E% SMI" 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /* 41 * Basic datatypes for most functions 42 */ 43 typedef void *sa_group_t; 44 typedef void *sa_share_t; 45 typedef void *sa_property_t; 46 typedef void *sa_optionset_t; 47 typedef void *sa_security_t; 48 typedef void *sa_protocol_properties_t; 49 50 typedef void *sa_handle_t; /* opaque handle to access core functions */ 51 52 /* 53 * defined error values 54 */ 55 56 #define SA_OK 0 57 #define SA_NO_SUCH_PATH 1 /* provided path doesn't exist */ 58 #define SA_NO_MEMORY 2 /* no memory for data structures */ 59 #define SA_DUPLICATE_NAME 3 /* object name is already in use */ 60 #define SA_BAD_PATH 4 /* not a full path */ 61 #define SA_NO_SUCH_GROUP 5 /* group is not defined */ 62 #define SA_CONFIG_ERR 6 /* system configuration error */ 63 #define SA_SYSTEM_ERR 7 /* system error, use errno */ 64 #define SA_SYNTAX_ERR 8 /* syntax error on command line */ 65 #define SA_NO_PERMISSION 9 /* no permission for operation */ 66 #define SA_BUSY 10 /* resource is busy */ 67 #define SA_NO_SUCH_PROP 11 /* property doesn't exist */ 68 #define SA_INVALID_NAME 12 /* name of object is invalid */ 69 #define SA_INVALID_PROTOCOL 13 /* specified protocol not valid */ 70 #define SA_NOT_ALLOWED 14 /* operation not allowed */ 71 #define SA_BAD_VALUE 15 /* bad value for property */ 72 #define SA_INVALID_SECURITY 16 /* invalid security type */ 73 #define SA_NO_SUCH_SECURITY 17 /* security set not found */ 74 #define SA_VALUE_CONFLICT 18 /* property value conflict */ 75 #define SA_NOT_IMPLEMENTED 19 /* plugin interface not implemented */ 76 #define SA_INVALID_PATH 20 /* path is sub-dir of existing share */ 77 #define SA_NOT_SUPPORTED 21 /* operation not supported for proto */ 78 #define SA_PROP_SHARE_ONLY 22 /* property valid on share only */ 79 #define SA_NOT_SHARED 23 /* path is not shared */ 80 81 /* API Initialization */ 82 #define SA_INIT_SHARE_API 0x0001 /* init share specific interface */ 83 #define SA_INIT_CONTROL_API 0x0002 /* init control specific interface */ 84 85 /* not part of API returns */ 86 #define SA_LEGACY_ERR 32 /* share/unshare error return */ 87 88 /* 89 * other defined values 90 */ 91 92 #define SA_MAX_NAME_LEN 100 /* must fit service instance name */ 93 #define SA_SHARE_PERMANENT 2 /* share goes to repository */ 94 #define SA_SHARE_LEGACY 1 /* share is in dfstab only */ 95 #define SA_SHARE_TRANSIENT 0 /* shared but not across reboot */ 96 97 /* RBAC related */ 98 #define SA_RBAC_MANAGE "solaris.smf.manage.shares" 99 #define SA_RBAC_VALUE "solaris.smf.value.shares" 100 101 /* 102 * legacy files 103 */ 104 105 #define SA_LEGACY_DFSTAB "/etc/dfs/dfstab" 106 #define SA_LEGACY_SHARETAB "/etc/dfs/sharetab" 107 108 /* 109 * SMF related 110 */ 111 112 #define SA_SVC_FMRI_BASE "svc:/network/shares/group" 113 114 /* initialization */ 115 extern void sa_init(int); 116 extern void sa_fini(void); 117 extern int sa_update_config(void); 118 extern char *sa_errorstr(int); 119 120 /* protocol names */ 121 extern int sa_get_protocols(char ***); 122 extern int sa_valid_protocol(char *); 123 124 /* group control (create, remove, etc) */ 125 extern sa_group_t sa_create_group(char *, int *); 126 extern int sa_remove_group(sa_group_t); 127 extern sa_group_t sa_get_group(char *); 128 extern sa_group_t sa_get_next_group(sa_group_t); 129 extern char *sa_get_group_attr(sa_group_t, char *); 130 extern int sa_set_group_attr(sa_group_t, char *, char *); 131 extern sa_group_t sa_get_sub_group(sa_group_t); 132 extern int sa_valid_group_name(char *); 133 134 /* share control */ 135 extern sa_share_t sa_add_share(sa_group_t, char *, int, int *); 136 extern int sa_check_path(sa_group_t, char *); 137 extern int sa_move_share(sa_group_t, sa_share_t); 138 extern int sa_remove_share(sa_share_t); 139 extern sa_share_t sa_get_share(sa_group_t, char *); 140 extern sa_share_t sa_get_resource(sa_group_t, char *); 141 extern sa_share_t sa_find_share(char *); 142 extern sa_share_t sa_get_next_share(sa_share_t); 143 extern char *sa_get_share_attr(sa_share_t, char *); 144 extern char *sa_get_share_description(sa_share_t); 145 extern sa_group_t sa_get_parent_group(sa_share_t); 146 extern int sa_set_share_attr(sa_share_t, char *, char *); 147 extern int sa_set_share_description(sa_share_t, char *); 148 extern int sa_enable_share(sa_group_t, char *); 149 extern int sa_disable_share(sa_group_t, char *); 150 extern int sa_is_share(void *); 151 152 /* data structure free calls */ 153 extern void sa_free_attr_string(char *); 154 extern void sa_free_share_description(char *); 155 156 /* optionset control */ 157 extern sa_optionset_t sa_get_optionset(sa_group_t, char *); 158 extern sa_optionset_t sa_get_next_optionset(sa_group_t); 159 extern char *sa_get_optionset_attr(sa_optionset_t, char *); 160 extern void sa_set_optionset_attr(sa_optionset_t, char *, char *); 161 extern sa_optionset_t sa_create_optionset(sa_group_t, char *); 162 extern int sa_destroy_optionset(sa_optionset_t); 163 extern sa_optionset_t sa_get_derived_optionset(void *, char *, int); 164 extern void sa_free_derived_optionset(sa_optionset_t); 165 166 /* property functions */ 167 extern sa_optionset_t sa_get_property(sa_optionset_t, char *); 168 extern sa_optionset_t sa_get_next_property(sa_group_t); 169 extern char *sa_get_property_attr(sa_property_t, char *); 170 extern sa_property_t sa_create_property(char *, char *); 171 extern int sa_add_property(void *, sa_property_t); 172 extern int sa_update_property(sa_property_t, char *); 173 extern int sa_remove_property(sa_property_t); 174 extern int sa_commit_properties(sa_optionset_t, int); 175 extern int sa_valid_property(void *, char *, sa_property_t); 176 177 /* security control */ 178 extern sa_security_t sa_get_security(sa_group_t, char *, char *); 179 extern sa_security_t sa_get_next_security(sa_security_t); 180 extern char *sa_get_security_attr(sa_optionset_t, char *); 181 extern sa_security_t sa_create_security(sa_group_t, char *, char *); 182 extern int sa_destroy_security(sa_security_t); 183 extern void sa_set_security_attr(sa_security_t, char *, char *); 184 extern sa_optionset_t sa_get_all_security_types(void *, char *, int); 185 extern sa_security_t sa_get_derived_security(void *, char *, char *, int); 186 extern void sa_free_derived_security(sa_security_t); 187 188 /* protocol specific interfaces */ 189 extern int sa_parse_legacy_options(sa_group_t, char *, char *); 190 extern char *sa_proto_legacy_format(char *, sa_group_t, int); 191 extern int sa_is_security(char *, char *); 192 extern sa_protocol_properties_t sa_proto_get_properties(char *); 193 extern sa_property_t sa_get_protocol_property(sa_protocol_properties_t, char *); 194 extern sa_property_t sa_get_next_protocol_property(sa_property_t); 195 extern int sa_set_protocol_property(sa_property_t, char *); 196 extern char *sa_get_protocol_status(char *); 197 extern void sa_format_free(char *); 198 extern sa_protocol_properties_t sa_create_protocol_properties(char *); 199 extern int sa_add_protocol_property(sa_protocol_properties_t, sa_property_t); 200 extern int sa_proto_valid_prop(char *, sa_property_t, sa_optionset_t); 201 extern int sa_proto_valid_space(char *, char *); 202 extern char *sa_proto_space_alias(char *, char *); 203 204 /* handle legacy (dfstab/sharetab) files */ 205 extern int sa_delete_legacy(sa_share_t); 206 extern int sa_update_legacy(sa_share_t, char *); 207 extern int sa_update_sharetab(sa_share_t, char *); 208 extern int sa_delete_sharetab(char *, char *); 209 210 /* ZFS functions */ 211 extern int sa_zfs_is_shared(char *); 212 extern int sa_group_is_zfs(sa_group_t); 213 #ifdef __cplusplus 214 } 215 #endif 216 217 #endif /* _LIBSHARE_H */ 218