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 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* 28 * basic declarations for implementation of the share management 29 * libraries. 30 */ 31 32 #ifndef _LIBSHARE_IMPL_H 33 #define _LIBSHARE_IMPL_H 34 35 #pragma ident "%Z%%M% %I% %E% SMI" 36 37 #include <libshare.h> 38 #include <libscf.h> 39 #include <scfutil.h> 40 #include <libzfs.h> 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 /* directory to find plugin modules in */ 47 #define SA_LIB_DIR "/usr/lib/fs" 48 49 /* default group name for dfstab file */ 50 #define SA_DEFAULT_FILE_GRP "sys" 51 52 typedef void *sa_phandle_t; 53 54 #define SA_PLUGIN_VERSION 1 55 struct sa_plugin_ops { 56 int sa_version; 57 char *sa_protocol; /* protocol name */ 58 int (*sa_init)(); 59 void (*sa_fini)(); 60 int (*sa_share)(sa_share_t); /* start sharing */ 61 int (*sa_unshare)(char *); /* stop sharing */ 62 int (*sa_valid_prop)(sa_property_t, sa_optionset_t); 63 int (*sa_valid_space)(char *); /* is name valid optionspace? */ 64 int (*sa_security_prop)(char *); /* property is security */ 65 int (*sa_legacy_opts)(sa_group_t, char *); /* parse legacy opts */ 66 char *(*sa_legacy_format)(sa_group_t, int); 67 int (*sa_set_proto_prop)(sa_property_t); 68 sa_protocol_properties_t (*sa_get_proto_set)(); 69 char *(*sa_get_proto_status)(); 70 char *(*sa_space_alias)(char *); 71 int (*sa_update_legacy)(sa_share_t); 72 int (*sa_delete_legacy)(sa_share_t); 73 int (*sa_run_command)(int, int, char **); /* proto specific */ 74 int (*sa_command_help)(); 75 }; 76 77 struct sa_proto_handle { 78 int sa_num_proto; 79 char **sa_proto; 80 struct sa_plugin_ops **sa_ops; 81 }; 82 83 typedef struct propertylist { 84 struct propertylist *pl_next; 85 int pl_type; 86 union propval { 87 sa_optionset_t pl_optionset; 88 sa_security_t pl_security; 89 void *pl_void; 90 } pl_value; 91 } property_list_t; 92 93 extern int sa_proto_share(char *, sa_share_t); 94 extern int sa_proto_unshare(char *, char *); 95 extern int sa_proto_valid_prop(char *, sa_property_t, sa_optionset_t); 96 extern int sa_proto_security_prop(char *, char *); 97 extern int sa_proto_legacy_opts(char *, sa_group_t, char *); 98 99 /* internal utility functions */ 100 extern sa_optionset_t sa_get_derived_optionset(sa_group_t, char *, int); 101 extern void sa_free_derived_optionset(sa_optionset_t); 102 extern sa_optionset_t sa_get_all_security_types(void *, char *, int); 103 extern sa_security_t sa_get_derived_security(void *, char *, char *, int); 104 extern void sa_free_derived_security(sa_security_t); 105 extern sa_protocol_properties_t sa_create_protocol_properties(char *); 106 extern int sa_start_transaction(scfutilhandle_t *, char *); 107 extern int sa_end_transaction(scfutilhandle_t *); 108 extern void sa_abort_transaction(scfutilhandle_t *); 109 extern int sa_commit_share(scfutilhandle_t *, sa_group_t, sa_share_t); 110 extern int sa_set_property(scfutilhandle_t *, char *, char *); 111 extern void sa_free_fstype(char *fstyp); 112 extern int sa_delete_share(scfutilhandle_t *, sa_group_t, sa_share_t); 113 extern int sa_delete_instance(scfutilhandle_t *, char *); 114 extern int sa_create_pgroup(scfutilhandle_t *, char *); 115 extern int sa_delete_pgroup(scfutilhandle_t *, char *); 116 117 /* ZFS functions */ 118 extern int sa_get_zfs_shares(sa_handle_t, char *); 119 extern int sa_zfs_update(sa_share_t); 120 121 /* plugin specific functions */ 122 extern int proto_plugin_init(); 123 extern void proto_plugin_fini(); 124 extern int sa_proto_set_property(char *, sa_property_t); 125 extern int sa_proto_delete_legacy(char *, sa_share_t); 126 extern int sa_proto_update_legacy(char *, sa_share_t); 127 128 #define PL_TYPE_PROPERTY 0 129 #define PL_TYPE_SECURITY 1 130 131 /* values only used by the internal dfstab/sharetab parser */ 132 #define SA_SHARE_PARSER 0x1000 133 134 /* plugin handler only */ 135 struct sa_proto_plugin { 136 struct sa_proto_plugin *plugin_next; 137 struct sa_plugin_ops *plugin_ops; 138 void *plugin_handle; 139 }; 140 141 /* internal version of sa_handle_t */ 142 typedef struct sa_handle_impl { 143 uint64_t flags; 144 scfutilhandle_t *scfhandle; 145 libzfs_handle_t *zfs_libhandle; 146 zfs_handle_t **zfs_list; 147 size_t zfs_list_count; 148 xmlNodePtr tree; 149 xmlDocPtr doc; 150 } *sa_handle_impl_t; 151 152 #ifdef __cplusplus 153 } 154 #endif 155 156 #endif /* _LIBSHARE_IMPL_H */ 157