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 (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright 2018 Nexenta Systems, Inc. All rights reserved. 25 * Copyright (c) 2016 by Delphix. All rights reserved. 26 */ 27 28 /* 29 * basic API declarations for share management 30 */ 31 32 #ifndef _LIBSHARE_H 33 #define _LIBSHARE_H 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #include <sys/types.h> 40 #include <sys/nvpair.h> 41 #include <libzfs.h> 42 43 /* 44 * Basic datatypes for most functions 45 */ 46 typedef void *sa_group_t; 47 typedef void *sa_share_t; 48 typedef void *sa_property_t; 49 typedef void *sa_optionset_t; 50 typedef void *sa_security_t; 51 typedef void *sa_protocol_properties_t; 52 typedef void *sa_resource_t; 53 54 typedef void *sa_handle_t; /* opaque handle to access core functions */ 55 56 /* 57 * defined error values 58 */ 59 60 #define SA_OK 0 61 #define SA_NO_SUCH_PATH 1 /* provided path doesn't exist */ 62 #define SA_NO_MEMORY 2 /* no memory for data structures */ 63 #define SA_DUPLICATE_NAME 3 /* object name is already in use */ 64 #define SA_BAD_PATH 4 /* not a full path */ 65 #define SA_NO_SUCH_GROUP 5 /* group is not defined */ 66 #define SA_CONFIG_ERR 6 /* system configuration error */ 67 #define SA_SYSTEM_ERR 7 /* system error, use errno */ 68 #define SA_SYNTAX_ERR 8 /* syntax error on command line */ 69 #define SA_NO_PERMISSION 9 /* no permission for operation */ 70 #define SA_BUSY 10 /* resource is busy */ 71 #define SA_NO_SUCH_PROP 11 /* property doesn't exist */ 72 #define SA_INVALID_NAME 12 /* name of object is invalid */ 73 #define SA_INVALID_PROTOCOL 13 /* specified protocol not valid */ 74 #define SA_NOT_ALLOWED 14 /* operation not allowed */ 75 #define SA_BAD_VALUE 15 /* bad value for property */ 76 #define SA_INVALID_SECURITY 16 /* invalid security type */ 77 #define SA_NO_SUCH_SECURITY 17 /* security set not found */ 78 #define SA_VALUE_CONFLICT 18 /* property value conflict */ 79 #define SA_NOT_IMPLEMENTED 19 /* plugin interface not implemented */ 80 #define SA_INVALID_PATH 20 /* path is sub-dir of existing share */ 81 #define SA_NOT_SUPPORTED 21 /* operation not supported for proto */ 82 #define SA_PROP_SHARE_ONLY 22 /* property valid on share only */ 83 #define SA_NOT_SHARED 23 /* path is not shared */ 84 #define SA_NO_SUCH_RESOURCE 24 /* resource not found */ 85 #define SA_RESOURCE_REQUIRED 25 /* resource name is required */ 86 #define SA_MULTIPLE_ERROR 26 /* multiple protocols reported error */ 87 #define SA_PATH_IS_SUBDIR 27 /* check_path found path is subdir */ 88 #define SA_PATH_IS_PARENTDIR 28 /* check_path found path is parent */ 89 #define SA_NO_SECTION 29 /* protocol requires section info */ 90 #define SA_NO_SUCH_SECTION 30 /* no section found */ 91 #define SA_NO_PROPERTIES 31 /* no properties found */ 92 #define SA_PASSWORD_ENC 32 /* passwords must be encrypted */ 93 #define SA_SHARE_EXISTS 33 /* path or file is already shared */ 94 95 /* API Initialization */ 96 /* Both of these do not care about the value of arg in sa_init_arg */ 97 #define SA_INIT_SHARE_API 0x0001 /* init share specific interface */ 98 #define SA_INIT_CONTROL_API 0x0002 /* init control specific interface */ 99 100 /* expects an sa_init_selective_arg_t as an argument */ 101 #define SA_INIT_SHARE_API_SELECTIVE 0x0004 /* only some shares */ 102 struct sa_init_selective_arg { 103 zfs_handle_t **zhandle_arr; 104 size_t zhandle_len; 105 }; 106 typedef struct sa_init_selective_arg sa_init_selective_arg_t; 107 108 109 /* 110 * The SA_INIT_ONE_SHARE* initialization options to sa_init* will cause 111 * sa_needs_refrsh() to return true even if nothing else in the system has 112 * changed. If writing code that could possibly need to share/unshare multiple 113 * shares, it is recommended to use SA_INIT_SHARE_API_SELECTIVE. 114 */ 115 /* Expects a single char * as input, the name of the share. */ 116 #define SA_INIT_ONE_SHARE_FROM_NAME 0x0008 117 118 /* Expects a single zfs_handle_t as input, the handle of the share. */ 119 #define SA_INIT_ONE_SHARE_FROM_HANDLE 0x0010 120 121 /* not part of API returns */ 122 #define SA_LEGACY_ERR 32 /* share/unshare error return */ 123 124 /* 125 * other defined values 126 */ 127 128 #define SA_MAX_NAME_LEN 100 /* must fit service instance name */ 129 #define SA_MAX_RESOURCE_NAME 255 /* Maximum length of resource name */ 130 131 /* Used in calls to sa_add_share() and sa_add_resource() */ 132 #define SA_SHARE_TRANSIENT 0 /* shared but not across reboot */ 133 #define SA_SHARE_LEGACY 1 /* share is in dfstab only */ 134 #define SA_SHARE_PERMANENT 2 /* share goes to repository */ 135 136 /* sa_check_path() related */ 137 #define SA_CHECK_NORMAL 0 /* only check against active shares */ 138 #define SA_CHECK_STRICT 1 /* check against all shares */ 139 140 /* RBAC related */ 141 #define SA_RBAC_MANAGE "solaris.smf.manage.shares" 142 #define SA_RBAC_VALUE "solaris.smf.value.shares" 143 144 /* 145 * Feature set bit definitions 146 */ 147 148 #define SA_FEATURE_NONE 0x0000 /* no feature flags set */ 149 #define SA_FEATURE_RESOURCE 0x0001 /* resource names are required */ 150 #define SA_FEATURE_DFSTAB 0x0002 /* need to manage in dfstab */ 151 #define SA_FEATURE_ALLOWSUBDIRS 0x0004 /* allow subdirs to be shared */ 152 #define SA_FEATURE_ALLOWPARDIRS 0x0008 /* allow parent dirs to be shared */ 153 #define SA_FEATURE_HAS_SECTIONS 0x0010 /* protocol supports sections */ 154 #define SA_FEATURE_ADD_PROPERTIES 0x0020 /* can add properties */ 155 #define SA_FEATURE_SERVER 0x0040 /* protocol supports server mode */ 156 157 /* 158 * legacy files 159 */ 160 161 #define SA_LEGACY_DFSTAB "/etc/dfs/dfstab" 162 #define SA_LEGACY_SHARETAB "/etc/dfs/sharetab" 163 164 /* 165 * SMF related 166 */ 167 168 #define SA_SVC_FMRI_BASE "svc:/network/shares/group" 169 170 /* initialization */ 171 extern sa_handle_t sa_init(int); 172 extern sa_handle_t sa_init_arg(int, void *); 173 extern void sa_fini(sa_handle_t); 174 extern int sa_service(sa_handle_t); 175 176 extern int sa_update_config(sa_handle_t); 177 extern boolean_t sa_needs_refresh(sa_handle_t); 178 extern char *sa_errorstr(int); 179 180 /* protocol names */ 181 extern int sa_get_protocols(char ***); 182 extern int sa_valid_protocol(char *); 183 184 /* group control (create, remove, etc) */ 185 extern sa_group_t sa_create_group(sa_handle_t, char *, int *); 186 extern int sa_remove_group(sa_group_t); 187 extern sa_group_t sa_get_group(sa_handle_t, char *); 188 extern sa_group_t sa_get_next_group(sa_group_t); 189 extern char *sa_get_group_attr(sa_group_t, char *); 190 extern int sa_set_group_attr(sa_group_t, char *, char *); 191 extern sa_group_t sa_get_sub_group(sa_group_t); 192 extern int sa_valid_group_name(char *); 193 194 /* share control */ 195 extern sa_share_t sa_add_share(sa_group_t, char *, int, int *); 196 extern int sa_check_path(sa_group_t, char *, int); 197 extern int sa_move_share(sa_group_t, sa_share_t); 198 extern int sa_remove_share(sa_share_t); 199 extern sa_share_t sa_get_share(sa_group_t, char *); 200 extern sa_share_t sa_find_share(sa_handle_t, char *); 201 extern sa_share_t sa_get_next_share(sa_share_t); 202 extern char *sa_get_share_attr(sa_share_t, char *); 203 extern char *sa_get_share_description(sa_share_t); 204 extern sa_group_t sa_get_parent_group(sa_share_t); 205 extern int sa_set_share_attr(sa_share_t, char *, char *); 206 extern int sa_set_share_description(sa_share_t, char *); 207 extern int sa_enable_share(sa_group_t, char *); 208 extern int sa_disable_share(sa_share_t, char *); 209 extern int sa_is_share(void *); 210 211 /* resource name related */ 212 extern sa_resource_t sa_find_resource(sa_handle_t, char *); 213 extern sa_resource_t sa_get_resource(sa_group_t, char *); 214 extern sa_resource_t sa_get_next_resource(sa_resource_t); 215 extern sa_share_t sa_get_resource_parent(sa_resource_t); 216 extern sa_resource_t sa_get_share_resource(sa_share_t, char *); 217 extern sa_resource_t sa_add_resource(sa_share_t, char *, int, int *); 218 extern int sa_remove_resource(sa_resource_t); 219 extern char *sa_get_resource_attr(sa_resource_t, char *); 220 extern int sa_set_resource_attr(sa_resource_t, char *, char *); 221 extern int sa_set_resource_description(sa_resource_t, char *); 222 extern char *sa_get_resource_description(sa_resource_t); 223 extern int sa_enable_resource(sa_resource_t, char *); 224 extern int sa_disable_resource(sa_resource_t, char *); 225 extern int sa_rename_resource(sa_resource_t, char *); 226 extern void sa_fix_resource_name(char *); 227 228 /* data structure free calls */ 229 extern void sa_free_attr_string(char *); 230 extern void sa_free_share_description(char *); 231 232 /* optionset control */ 233 extern sa_optionset_t sa_get_optionset(sa_group_t, char *); 234 extern sa_optionset_t sa_get_next_optionset(sa_group_t); 235 extern char *sa_get_optionset_attr(sa_optionset_t, char *); 236 extern void sa_set_optionset_attr(sa_optionset_t, char *, char *); 237 extern sa_optionset_t sa_create_optionset(sa_group_t, char *); 238 extern int sa_destroy_optionset(sa_optionset_t); 239 extern sa_optionset_t sa_get_derived_optionset(void *, char *, int); 240 extern void sa_free_derived_optionset(sa_optionset_t); 241 242 /* property functions */ 243 extern sa_property_t sa_get_property(sa_optionset_t, char *); 244 extern sa_property_t sa_get_next_property(sa_group_t); 245 extern char *sa_get_property_attr(sa_property_t, char *); 246 extern sa_property_t sa_create_section(char *, char *); 247 extern void sa_set_section_attr(sa_property_t, char *, char *); 248 extern sa_property_t sa_create_property(char *, char *); 249 extern int sa_add_property(void *, sa_property_t); 250 extern int sa_update_property(sa_property_t, char *); 251 extern int sa_remove_property(sa_property_t); 252 extern int sa_commit_properties(sa_optionset_t, int); 253 extern int sa_valid_property(sa_handle_t, void *, char *, sa_property_t); 254 extern int sa_is_persistent(void *); 255 256 /* security control */ 257 extern sa_security_t sa_get_security(sa_group_t, char *, char *); 258 extern sa_security_t sa_get_next_security(sa_security_t); 259 extern char *sa_get_security_attr(sa_optionset_t, char *); 260 extern sa_security_t sa_create_security(sa_group_t, char *, char *); 261 extern int sa_destroy_security(sa_security_t); 262 extern void sa_set_security_attr(sa_security_t, char *, char *); 263 extern sa_optionset_t sa_get_all_security_types(void *, char *, int); 264 extern sa_security_t sa_get_derived_security(void *, char *, char *, int); 265 extern void sa_free_derived_security(sa_security_t); 266 267 /* protocol specific interfaces */ 268 extern int sa_parse_legacy_options(sa_group_t, char *, char *); 269 extern char *sa_proto_legacy_format(char *, sa_group_t, int); 270 extern int sa_is_security(char *, char *); 271 extern sa_protocol_properties_t sa_proto_get_properties(char *); 272 extern uint64_t sa_proto_get_featureset(char *); 273 extern sa_property_t sa_get_protocol_section(sa_protocol_properties_t, char *); 274 extern sa_property_t sa_get_next_protocol_section(sa_property_t, char *); 275 extern sa_property_t sa_get_protocol_property(sa_protocol_properties_t, char *); 276 extern sa_property_t sa_get_next_protocol_property(sa_property_t, char *); 277 extern int sa_set_protocol_property(sa_property_t, char *, char *); 278 extern char *sa_get_protocol_status(char *); 279 extern void sa_format_free(char *); 280 extern sa_protocol_properties_t sa_create_protocol_properties(char *); 281 extern int sa_add_protocol_property(sa_protocol_properties_t, sa_property_t); 282 extern int sa_proto_valid_prop(sa_handle_t, char *, sa_property_t, 283 sa_optionset_t); 284 extern int sa_proto_valid_space(char *, char *); 285 extern char *sa_proto_space_alias(char *, char *); 286 extern int sa_proto_get_transients(sa_handle_t, char *); 287 extern int sa_proto_notify_resource(sa_resource_t, char *); 288 extern int sa_proto_change_notify(sa_share_t, char *); 289 extern int sa_proto_delete_section(char *, char *); 290 291 /* handle legacy (dfstab/sharetab) files */ 292 extern int sa_delete_legacy(sa_share_t, char *); 293 extern int sa_update_legacy(sa_share_t, char *); 294 extern int sa_update_sharetab(sa_share_t, char *); 295 extern int sa_delete_sharetab(sa_handle_t, char *, char *); 296 297 /* ZFS functions */ 298 extern int sa_zfs_is_shared(sa_handle_t, char *); 299 extern int sa_group_is_zfs(sa_group_t); 300 extern int sa_path_is_zfs(char *); 301 extern int sa_zfs_setprop(sa_handle_t, char *, nvlist_t *); 302 303 /* SA Handle specific functions */ 304 extern sa_handle_t sa_find_group_handle(sa_group_t); 305 306 #ifdef __cplusplus 307 } 308 #endif 309 310 #endif /* _LIBSHARE_H */ 311