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 2009 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
25 */
26
27 /*
28 * Copyright (c) 2013 RackTop Systems.
29 */
30
31 /*
32 * basic declarations for implementation of the share management
33 * libraries.
34 */
35
36 #ifndef _LIBSHARE_IMPL_H
37 #define _LIBSHARE_IMPL_H
38
39 #include <libshare.h>
40 #include <libscf.h>
41 #include <scfutil.h>
42 #include <libzfs.h>
43 #include <sharefs/share.h>
44 #include <sharefs/sharetab.h>
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 /* directory to find plugin modules in */
51 #define SA_LIB_DIR "/usr/lib/fs"
52
53 /* default group name for dfstab file */
54 #define SA_DEFAULT_FILE_GRP "sys"
55
56 typedef void *sa_phandle_t;
57
58 #define SA_PLUGIN_VERSION 1
59 struct sa_plugin_ops {
60 int sa_version; /* version number */
61 char *sa_protocol; /* protocol name */
62 int (*sa_init)();
63 void (*sa_fini)();
64 int (*sa_share)(sa_share_t); /* start sharing */
65 int (*sa_unshare)(sa_share_t, char *); /* stop sharing */
66 int (*sa_valid_prop)(sa_handle_t, sa_property_t,
67 sa_optionset_t); /* validate */
68 int (*sa_valid_space)(char *); /* is name valid optionspace? */
69 int (*sa_security_prop)(char *); /* property is security */
70 int (*sa_legacy_opts)(sa_group_t, char *); /* parse legacy opts */
71 char *(*sa_legacy_format)(sa_group_t, int);
72 int (*sa_set_proto_prop)(sa_property_t); /* set a property */
73 sa_protocol_properties_t (*sa_get_proto_set)(); /* get properties */
74 char *(*sa_get_proto_status)();
75 char *(*sa_space_alias)(char *);
76 int (*sa_update_legacy)(sa_share_t);
77 int (*sa_delete_legacy)(sa_share_t);
78 int (*sa_change_notify)(sa_share_t);
79 int (*sa_enable_resource)(sa_resource_t);
80 int (*sa_disable_resource)(sa_resource_t);
81 uint64_t (*sa_features)(void);
82 int (*sa_get_transient_shares)(sa_handle_t); /* add transients */
83 int (*sa_notify_resource)(sa_resource_t);
84 int (*sa_rename_resource)(sa_handle_t, sa_resource_t, char *);
85 int (*sa_run_command)(int, int, char **); /* proto specific */
86 int (*sa_command_help)();
87 int (*sa_delete_proto_section)(char *);
88 };
89
90 struct sa_proto_handle {
91 int sa_num_proto;
92 char **sa_proto;
93 struct sa_plugin_ops **sa_ops;
94 };
95
96 typedef struct propertylist {
97 struct propertylist *pl_next;
98 int pl_type;
99 union propval {
100 sa_optionset_t pl_optionset;
101 sa_security_t pl_security;
102 void *pl_void;
103 } pl_value;
104 } property_list_t;
105
106 /* internal version of sa_handle_t */
107 struct sa_handle {
108 uint64_t flags;
109 scfutilhandle_t *scfhandle;
110 libzfs_handle_t *zfs_libhandle;
111 zfs_handle_t **zfs_list;
112 size_t zfs_list_count;
113 xmlNodePtr tree;
114 xmlDocPtr doc;
115 uint64_t tssharetab;
116 uint64_t tstrans;
117 };
118
119 extern int sa_proto_share(char *, sa_share_t);
120 extern int sa_proto_unshare(sa_share_t, char *, char *);
121 extern int sa_proto_valid_prop(sa_handle_t, char *, sa_property_t,
122 sa_optionset_t);
123 extern int sa_proto_security_prop(char *, char *);
124 extern int sa_proto_legacy_opts(char *, sa_group_t, char *);
125 extern int sa_proto_share_resource(char *, sa_resource_t);
126 extern int sa_proto_unshare_resource(char *, sa_resource_t);
127
128 /* internal utility functions */
129 extern sa_optionset_t sa_get_derived_optionset(sa_group_t, char *, int);
130 extern void sa_free_derived_optionset(sa_optionset_t);
131 extern sa_optionset_t sa_get_all_security_types(void *, char *, int);
132 extern sa_security_t sa_get_derived_security(void *, char *, char *, int);
133 extern void sa_free_derived_security(sa_security_t);
134 extern sa_protocol_properties_t sa_create_protocol_properties(char *);
135 extern int sa_start_transaction(scfutilhandle_t *, char *);
136 extern int sa_end_transaction(scfutilhandle_t *, sa_handle_t);
137 extern void sa_abort_transaction(scfutilhandle_t *);
138 extern int sa_commit_share(scfutilhandle_t *, sa_group_t, sa_share_t);
139 extern int sa_set_property(scfutilhandle_t *, char *, char *);
140 extern void sa_free_fstype(char *fstyp);
141 extern int sa_delete_share(scfutilhandle_t *, sa_group_t, sa_share_t);
142 extern int sa_delete_instance(scfutilhandle_t *, char *);
143 extern int sa_create_pgroup(scfutilhandle_t *, char *);
144 extern int sa_delete_pgroup(scfutilhandle_t *, char *);
145 extern void sa_fillshare(sa_share_t share, char *proto, struct share *sh);
146 extern void sa_emptyshare(struct share *sh);
147
148 /* ZFS functions */
149 extern int sa_get_zfs_shares(sa_handle_t, char *);
150 extern int sa_zfs_update(sa_share_t);
151 extern int sa_share_zfs(sa_share_t, sa_resource_t, char *, share_t *,
152 void *, zfs_share_op_t);
153 extern int sa_sharetab_fill_zfs(sa_share_t share, struct share *sh,
154 char *proto);
155
156 /* plugin specific functions */
157 extern int proto_plugin_init();
158 extern void proto_plugin_fini();
159 extern int sa_proto_set_property(char *, sa_property_t);
160 extern int sa_proto_delete_legacy(char *, sa_share_t);
161 extern int sa_proto_update_legacy(char *, sa_share_t);
162 extern int sa_proto_rename_resource(sa_handle_t, char *,
163 sa_resource_t, char *);
164
165 #define PL_TYPE_PROPERTY 0
166 #define PL_TYPE_SECURITY 1
167
168 /* values only used by the internal dfstab/sharetab parser */
169 #define SA_SHARE_PARSER 0x1000
170
171 /* plugin handler only */
172 struct sa_proto_plugin {
173 struct sa_proto_plugin *plugin_next;
174 struct sa_plugin_ops *plugin_ops;
175 void *plugin_handle;
176 };
177
178 #define TSTAMP(tm) (uint64_t)(((uint64_t)tm.tv_sec << 32) | \
179 (tm.tv_nsec & 0xffffffff))
180
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif /* _LIBSHARE_IMPL_H */