16185db85Sdougm /* 26185db85Sdougm * CDDL HEADER START 36185db85Sdougm * 46185db85Sdougm * The contents of this file are subject to the terms of the 56185db85Sdougm * Common Development and Distribution License (the "License"). 66185db85Sdougm * You may not use this file except in compliance with the License. 76185db85Sdougm * 86185db85Sdougm * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 96185db85Sdougm * or http://www.opensolaris.org/os/licensing. 106185db85Sdougm * See the License for the specific language governing permissions 116185db85Sdougm * and limitations under the License. 126185db85Sdougm * 136185db85Sdougm * When distributing Covered Code, include this CDDL HEADER in each 146185db85Sdougm * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 156185db85Sdougm * If applicable, add the following below this CDDL HEADER, with the 166185db85Sdougm * fields enclosed by brackets "[]" replaced with your own identifying 176185db85Sdougm * information: Portions Copyright [yyyy] [name of copyright owner] 186185db85Sdougm * 196185db85Sdougm * CDDL HEADER END 206185db85Sdougm */ 216185db85Sdougm 226185db85Sdougm /* 23743a77edSAlan Wright * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 246185db85Sdougm * Use is subject to license terms. 25*8a981c33SDaniel Hoffman * Copyright (c) 2016 by Delphix. All rights reserved. 266185db85Sdougm */ 276185db85Sdougm 286185db85Sdougm /* 296185db85Sdougm * basic declarations for implementation of the share management 306185db85Sdougm * libraries. 316185db85Sdougm */ 326185db85Sdougm 336185db85Sdougm #ifndef _LIBSHARE_IMPL_H 346185db85Sdougm #define _LIBSHARE_IMPL_H 356185db85Sdougm 366185db85Sdougm #include <libshare.h> 376185db85Sdougm #include <libscf.h> 386185db85Sdougm #include <scfutil.h> 39549ec3ffSdougm #include <libzfs.h> 40ecd6cf80Smarks #include <sharefs/share.h> 41d7634289Smarks #include <sharefs/sharetab.h> 426185db85Sdougm 436185db85Sdougm #ifdef __cplusplus 446185db85Sdougm extern "C" { 456185db85Sdougm #endif 466185db85Sdougm 476185db85Sdougm /* directory to find plugin modules in */ 486185db85Sdougm #define SA_LIB_DIR "/usr/lib/fs" 496185db85Sdougm 506185db85Sdougm /* default group name for dfstab file */ 516185db85Sdougm #define SA_DEFAULT_FILE_GRP "sys" 526185db85Sdougm 536185db85Sdougm typedef void *sa_phandle_t; 546185db85Sdougm 556185db85Sdougm #define SA_PLUGIN_VERSION 1 566185db85Sdougm struct sa_plugin_ops { 574bff34e3Sthurlow int sa_version; /* version number */ 586185db85Sdougm char *sa_protocol; /* protocol name */ 596185db85Sdougm int (*sa_init)(); 606185db85Sdougm void (*sa_fini)(); 616185db85Sdougm int (*sa_share)(sa_share_t); /* start sharing */ 62743a77edSAlan Wright int (*sa_unshare)(sa_share_t, char *); /* stop sharing */ 63687915e9Sdougm int (*sa_valid_prop)(sa_handle_t, sa_property_t, 64687915e9Sdougm sa_optionset_t); /* validate */ 656185db85Sdougm int (*sa_valid_space)(char *); /* is name valid optionspace? */ 666185db85Sdougm int (*sa_security_prop)(char *); /* property is security */ 676185db85Sdougm int (*sa_legacy_opts)(sa_group_t, char *); /* parse legacy opts */ 686185db85Sdougm char *(*sa_legacy_format)(sa_group_t, int); 694bff34e3Sthurlow int (*sa_set_proto_prop)(sa_property_t); /* set a property */ 704bff34e3Sthurlow sa_protocol_properties_t (*sa_get_proto_set)(); /* get properties */ 716185db85Sdougm char *(*sa_get_proto_status)(); 726185db85Sdougm char *(*sa_space_alias)(char *); 736185db85Sdougm int (*sa_update_legacy)(sa_share_t); 746185db85Sdougm int (*sa_delete_legacy)(sa_share_t); 75da6c28aaSamw int (*sa_change_notify)(sa_share_t); 76da6c28aaSamw int (*sa_enable_resource)(sa_resource_t); 77da6c28aaSamw int (*sa_disable_resource)(sa_resource_t); 78da6c28aaSamw uint64_t (*sa_features)(void); 79da6c28aaSamw int (*sa_get_transient_shares)(sa_handle_t); /* add transients */ 80da6c28aaSamw int (*sa_notify_resource)(sa_resource_t); 81da6c28aaSamw int (*sa_rename_resource)(sa_handle_t, sa_resource_t, char *); 826185db85Sdougm int (*sa_run_command)(int, int, char **); /* proto specific */ 836185db85Sdougm int (*sa_command_help)(); 844bff34e3Sthurlow int (*sa_delete_proto_section)(char *); 856185db85Sdougm }; 866185db85Sdougm 876185db85Sdougm struct sa_proto_handle { 886185db85Sdougm int sa_num_proto; 896185db85Sdougm char **sa_proto; 906185db85Sdougm struct sa_plugin_ops **sa_ops; 916185db85Sdougm }; 926185db85Sdougm 936185db85Sdougm typedef struct propertylist { 946185db85Sdougm struct propertylist *pl_next; 956185db85Sdougm int pl_type; 966185db85Sdougm union propval { 976185db85Sdougm sa_optionset_t pl_optionset; 986185db85Sdougm sa_security_t pl_security; 996185db85Sdougm void *pl_void; 1006185db85Sdougm } pl_value; 1016185db85Sdougm } property_list_t; 1026185db85Sdougm 1035b6e0c46Sdougm /* internal version of sa_handle_t */ 1045b6e0c46Sdougm typedef struct sa_handle_impl { 1055b6e0c46Sdougm uint64_t flags; 1065b6e0c46Sdougm scfutilhandle_t *scfhandle; 1075b6e0c46Sdougm libzfs_handle_t *zfs_libhandle; 1085b6e0c46Sdougm zfs_handle_t **zfs_list; 1095b6e0c46Sdougm size_t zfs_list_count; 1105b6e0c46Sdougm xmlNodePtr tree; 1115b6e0c46Sdougm xmlDocPtr doc; 1125b6e0c46Sdougm uint64_t tssharetab; 1135b6e0c46Sdougm uint64_t tstrans; 114*8a981c33SDaniel Hoffman int sa_service; 1155b6e0c46Sdougm } *sa_handle_impl_t; 1165b6e0c46Sdougm 1176185db85Sdougm extern int sa_proto_share(char *, sa_share_t); 118ecd6cf80Smarks extern int sa_proto_unshare(sa_share_t, char *, char *); 119687915e9Sdougm extern int sa_proto_valid_prop(sa_handle_t, char *, sa_property_t, 120687915e9Sdougm sa_optionset_t); 1216185db85Sdougm extern int sa_proto_security_prop(char *, char *); 1226185db85Sdougm extern int sa_proto_legacy_opts(char *, sa_group_t, char *); 123da6c28aaSamw extern int sa_proto_share_resource(char *, sa_resource_t); 124da6c28aaSamw extern int sa_proto_unshare_resource(char *, sa_resource_t); 1256185db85Sdougm 1266185db85Sdougm /* internal utility functions */ 1276185db85Sdougm extern sa_optionset_t sa_get_derived_optionset(sa_group_t, char *, int); 1286185db85Sdougm extern void sa_free_derived_optionset(sa_optionset_t); 1296185db85Sdougm extern sa_optionset_t sa_get_all_security_types(void *, char *, int); 1306185db85Sdougm extern sa_security_t sa_get_derived_security(void *, char *, char *, int); 1316185db85Sdougm extern void sa_free_derived_security(sa_security_t); 1326185db85Sdougm extern sa_protocol_properties_t sa_create_protocol_properties(char *); 1336185db85Sdougm extern int sa_start_transaction(scfutilhandle_t *, char *); 1345b6e0c46Sdougm extern int sa_end_transaction(scfutilhandle_t *, sa_handle_impl_t); 1356185db85Sdougm extern void sa_abort_transaction(scfutilhandle_t *); 1366185db85Sdougm extern int sa_commit_share(scfutilhandle_t *, sa_group_t, sa_share_t); 1376185db85Sdougm extern int sa_set_property(scfutilhandle_t *, char *, char *); 1386185db85Sdougm extern void sa_free_fstype(char *fstyp); 1396185db85Sdougm extern int sa_delete_share(scfutilhandle_t *, sa_group_t, sa_share_t); 1406185db85Sdougm extern int sa_delete_instance(scfutilhandle_t *, char *); 1416185db85Sdougm extern int sa_create_pgroup(scfutilhandle_t *, char *); 1426185db85Sdougm extern int sa_delete_pgroup(scfutilhandle_t *, char *); 143ecd6cf80Smarks extern void sa_fillshare(sa_share_t share, char *proto, struct share *sh); 144ecd6cf80Smarks extern void sa_emptyshare(struct share *sh); 1456185db85Sdougm 1466185db85Sdougm /* ZFS functions */ 147*8a981c33SDaniel Hoffman extern int sa_get_one_zfs_share(sa_handle_t, char *, sa_init_selective_arg_t *, 148*8a981c33SDaniel Hoffman char ***, size_t *); 149549ec3ffSdougm extern int sa_get_zfs_shares(sa_handle_t, char *); 150*8a981c33SDaniel Hoffman extern int sa_get_zfs_share_for_name(sa_handle_t, char *, const char *, char *); 1516185db85Sdougm extern int sa_zfs_update(sa_share_t); 152743a77edSAlan Wright extern int sa_share_zfs(sa_share_t, sa_resource_t, char *, share_t *, 153743a77edSAlan Wright void *, zfs_share_op_t); 154ecd6cf80Smarks extern int sa_sharetab_fill_zfs(sa_share_t share, struct share *sh, 155ecd6cf80Smarks char *proto); 1566185db85Sdougm 1576185db85Sdougm /* plugin specific functions */ 1586185db85Sdougm extern int proto_plugin_init(); 159549ec3ffSdougm extern void proto_plugin_fini(); 1606185db85Sdougm extern int sa_proto_set_property(char *, sa_property_t); 1616185db85Sdougm extern int sa_proto_delete_legacy(char *, sa_share_t); 1626185db85Sdougm extern int sa_proto_update_legacy(char *, sa_share_t); 163da6c28aaSamw extern int sa_proto_rename_resource(sa_handle_t, char *, 164da6c28aaSamw sa_resource_t, char *); 1656185db85Sdougm 1666185db85Sdougm #define PL_TYPE_PROPERTY 0 1676185db85Sdougm #define PL_TYPE_SECURITY 1 1686185db85Sdougm 1696185db85Sdougm /* values only used by the internal dfstab/sharetab parser */ 1706185db85Sdougm #define SA_SHARE_PARSER 0x1000 1716185db85Sdougm 1726185db85Sdougm /* plugin handler only */ 1736185db85Sdougm struct sa_proto_plugin { 1746185db85Sdougm struct sa_proto_plugin *plugin_next; 1756185db85Sdougm struct sa_plugin_ops *plugin_ops; 1766185db85Sdougm void *plugin_handle; 1776185db85Sdougm }; 1786185db85Sdougm 1795b6e0c46Sdougm #define TSTAMP(tm) (uint64_t)(((uint64_t)tm.tv_sec << 32) | \ 1805b6e0c46Sdougm (tm.tv_nsec & 0xffffffff)) 1815b6e0c46Sdougm 182549ec3ffSdougm 1836185db85Sdougm #ifdef __cplusplus 1846185db85Sdougm } 1856185db85Sdougm #endif 1866185db85Sdougm 1876185db85Sdougm #endif /* _LIBSHARE_IMPL_H */ 188