PSARC 2005/374 Share management improvements

6281048 NFS needs simplified administration

--HG--
rename : usr/src/cmd/dfs.cmds/share/Makefile => deleted_files/usr/src/cmd/dfs.cmds/share/Makefile
rename : usr/src/cmd/dfs.cmds/share/share.c => deleted_files/usr/src/cmd/dfs.cmds/share/share.c
rename : usr/src/cmd/fs.d/nfs/share/share.c => deleted_files/usr/src/cmd/fs.d/nfs/share/share.c
rename : usr/src/cmd/fs.d/nfs/unshare/Makefile => deleted_files/usr/src/cmd/fs.d/nfs/unshare/Makefile
rename : usr/src/cmd/fs.d/nfs/unshare/unshare.c => deleted_files/usr/src/cmd/fs.d/nfs/unshare/unshare.c
rename : usr/src/cmd/fs.d/nfs/share/issubdir.c => usr/src/lib/libshare/common/issubdir.c

1 files changed, 458 insertions, 0 deletions

diff --git a/usr/src/lib/libshare/common/plugin.c b/usr/src/lib/libshare/common/plugin.c
new file mode 100644
index 0000000000..54b95d8fbb
--- /dev/null
+++ b/usr/src/lib/libshare/common/plugin.c
@@ -0,0 +1,458 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
+ * or http://www.opensolaris.org/os/licensing.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
+ * Use is subject to license terms.
+ */
+
+#pragma ident	"%Z%%M%	%I%	%E% SMI"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <libshare.h>
+#include "libshare_impl.h"
+#include <dlfcn.h>
+#include <link.h>
+#include <sys/types.h>
+#include <sys/param.h>
+#include <sys/stat.h>
+#include <dirent.h>
+#include <libintl.h>
+
+/*
+ * protocol plugin interface
+ *
+ * finds plugins and makes them accessible. This is only "used" by
+ * libshare.so.
+ */
+
+struct sa_proto_plugin *sap_proto_list;
+
+static struct sa_proto_handle sa_proto_handle;
+
+void proto_plugin_fini();
+
+/*
+ * proto_plugin_init()
+ *
+ * Initialize the protocol specific plugin modules.
+ *
+ * Walk /usr/lib/fs/\* for libshare_*.so modules. That is,
+ * /usr/lib/fs/nfs/libshare_nfs.so. The protocol specific directory
+ * would have a modules with name libshare_<proto>.so. If one is
+ * found, initialize it and add to the internal list of
+ * protocols. These are used for protocol specifici operations.
+ */
+
+int
+proto_plugin_init()
+{
+	struct sa_proto_plugin *proto;
+	int num_protos = 0;
+	int err;
+	struct sa_plugin_ops *plugin_ops;
+	void *dlhandle;
+	DIR *dir;
+	struct dirent *dent;
+	int ret = SA_OK;
+	struct stat st;
+
+	/*
+	 * should walk "/usr/lib/fs/" for files of the form:
+	 * libshare_*.so
+	 */
+	dir = opendir(SA_LIB_DIR);
+	if (dir != NULL) {
+	    while (ret == SA_OK && (dent = readdir(dir)) != NULL) {
+		char path[MAXPATHLEN];
+		(void) snprintf(path, MAXPATHLEN,
+				"%s/%s/libshare_%s.so",	SA_LIB_DIR,
+				dent->d_name, dent->d_name);
+		if (stat(path, &st) < 0) {
+		    /* file doesn't exist, so don't try to map it */
+		    continue;
+		}
+		dlhandle = dlopen(path, RTLD_NOW|RTLD_GLOBAL|RTLD_WORLD);
+		if (dlhandle != NULL) {
+		    plugin_ops = (struct sa_plugin_ops *)
+					dlsym(dlhandle,	"sa_plugin_ops");
+		    proto = (struct sa_proto_plugin *)
+			calloc(1, sizeof (struct sa_proto_plugin));
+		    if (proto != NULL) {
+			proto->plugin_ops = plugin_ops;
+			proto->plugin_handle = dlhandle;
+			num_protos++;
+			proto->plugin_next = sap_proto_list;
+			sap_proto_list = proto;
+		    } else {
+			ret = SA_NO_MEMORY;
+		    }
+		} else {
+		    (void) fprintf(stderr,
+			    gettext("Error in plugin for protocol %s: %s\n"),
+			    dent->d_name, dlerror());
+		}
+	    }
+	    (void) closedir(dir);
+	}
+	if (ret == SA_OK) {
+	    sa_proto_handle.sa_proto =
+			(char **)calloc(num_protos, sizeof (char *));
+	    sa_proto_handle.sa_ops =
+			(struct sa_plugin_ops **)calloc(num_protos,
+					    sizeof (struct sa_plugin_ops *));
+	    if (sa_proto_handle.sa_proto != NULL &&
+		sa_proto_handle.sa_ops != NULL) {
+		int i;
+		struct sa_proto_plugin *tmp;
+		for (i = 0, tmp = sap_proto_list; i < num_protos;
+		    tmp = tmp->plugin_next) {
+		    err = 0;
+		    if (tmp->plugin_ops->sa_init != NULL)
+			err = tmp->plugin_ops->sa_init();
+		    if (err == SA_OK) {
+			/* only include if the init succeeded or was NULL */
+			sa_proto_handle.sa_num_proto++;
+			sa_proto_handle.sa_ops[i] = tmp->plugin_ops;
+			sa_proto_handle.sa_proto[i] =
+					tmp->plugin_ops->sa_protocol;
+			i++;
+		    }
+		}
+	    }
+	} else {
+	    /* there was an error, so cleanup prior to return of failure. */
+	    proto_plugin_fini();
+	}
+	return (ret);
+}
+
+/*
+ * proto_plugin_fini()
+ *
+ * uninitialize all the plugin modules.
+ */
+
+void
+proto_plugin_fini()
+{
+	/*
+	 * free up all the protocols, calling their fini, if there is
+	 * one.
+	 */
+	while (sap_proto_list != NULL) {
+	    struct sa_proto_plugin *next;
+	    next = sap_proto_list->plugin_next;
+	    sap_proto_list->plugin_ops->sa_fini();
+	    if (sap_proto_list->plugin_handle != NULL)
+		(void) dlclose(sap_proto_list->plugin_handle);
+	    free(sap_proto_list);
+	    sap_proto_list = next;
+	}
+	if (sa_proto_handle.sa_ops != NULL) {
+	    free(sa_proto_handle.sa_ops);
+	    sa_proto_handle.sa_ops = NULL;
+	}
+	if (sa_proto_handle.sa_proto != NULL) {
+	    free(sa_proto_handle.sa_proto);
+	    sa_proto_handle.sa_proto = NULL;
+	}
+	sa_proto_handle.sa_num_proto = 0;
+}
+
+/*
+ * find_protocol(proto)
+ *
+ * Search the plugin list for the specified protocol and return the
+ * ops vector.  NULL if protocol is not defined.
+ */
+
+static struct sa_plugin_ops *
+find_protocol(char *proto)
+{
+	int i;
+
+	if (proto != NULL) {
+	    for (i = 0; i < sa_proto_handle.sa_num_proto; i++) {
+		if (strcmp(proto, sa_proto_handle.sa_proto[i]) == 0)
+		    return (sa_proto_handle.sa_ops[i]);
+	    }
+	}
+	return (NULL);
+}
+
+/*
+ * sa_proto_share(proto, share)
+ *
+ * Activate a share for the specified protocol.
+ */
+
+int
+sa_proto_share(char *proto, sa_share_t share)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = SA_INVALID_PROTOCOL;
+
+	if (ops != NULL && ops->sa_share != NULL)
+	    ret = ops->sa_share(share);
+	return (ret);
+}
+
+/*
+ * sa_proto_unshare(proto, path)
+ *
+ * Deactivate (unshare) the path for this protocol.
+ */
+
+int
+sa_proto_unshare(char *proto, char *path)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = SA_INVALID_PROTOCOL;
+
+	if (ops != NULL && ops->sa_unshare != NULL)
+	    ret = ops->sa_unshare(path);
+	return (ret);
+}
+
+/*
+ * sa_proto_valid_prop(proto, prop, opt)
+ *
+ * check to see if the specified prop is valid for this protocol.
+ */
+
+int
+sa_proto_valid_prop(char *proto, sa_property_t prop, sa_optionset_t opt)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = 0;
+
+	if (ops != NULL && ops->sa_valid_prop != NULL)
+	    ret = ops->sa_valid_prop(prop, opt);
+	return (ret);
+}
+
+/*
+ * sa_proto_valid_space(proto, space)
+ *
+ * check if space is valid optionspace for proto.
+ * Protocols that don't implement this don't support spaces.
+ */
+int
+sa_proto_valid_space(char *proto, char *token)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = 0;
+
+	if (ops != NULL && ops->sa_valid_space != NULL)
+	    ret = ops->sa_valid_space(token);
+	return (ret);
+}
+
+/*
+ * sa_proto_space_alias(proto, space)
+ *
+ * if the name for space is an alias, return its proper name.  This is
+ * used to translate "default" values into proper form.
+ */
+char *
+sa_proto_space_alias(char *proto, char *space)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	char *ret = space;
+
+	if (ops != NULL && ops->sa_space_alias != NULL)
+	    ret = ops->sa_space_alias(space);
+	return (ret);
+}
+
+/*
+ * sa_proto_security_prop(proto, token)
+ *
+ * Check to see if the property name in token is a valid named
+ * optionset property.
+ */
+
+int
+sa_proto_security_prop(char *proto, char *token)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = 0;
+
+	if (ops != NULL && ops->sa_security_prop != NULL)
+	    ret = ops->sa_security_prop(token);
+	return (ret);
+}
+
+/*
+ * sa_proto_legacy_opts(proto, grouup, options)
+ *
+ * Have the protocol specific parser parse the options string and add
+ * an appropriate optionset to group.
+ */
+
+int
+sa_proto_legacy_opts(char *proto, sa_group_t group, char *options)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = SA_INVALID_PROTOCOL;
+
+	if (ops != NULL && ops->sa_legacy_opts != NULL)
+	    ret = ops->sa_legacy_opts(group, options);
+	return (ret);
+}
+
+/*
+ * sa_proto_legacy_format(proto, group, hier)
+ *
+ * Return a legacy format string representing either the group's
+ * properties or the groups hierarchical properties.
+ */
+
+char *
+sa_proto_legacy_format(char *proto, sa_group_t group, int hier)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	char *ret = NULL;
+
+	if (ops != NULL && ops->sa_legacy_format != NULL)
+	    ret = ops->sa_legacy_format(group, hier);
+	return (ret);
+}
+
+void
+sa_format_free(char *str)
+{
+	free(str);
+}
+
+/*
+ * sharectl related API functions
+ */
+
+/*
+ * sa_proto_get_properties(proto)
+ *
+ * Return the set of properties that are specific to the
+ * protocol. These are usually in /etc/dfs/<proto> and related files,
+ * but only the protocol module knows which ones for sure.
+ */
+
+sa_protocol_properties_t
+sa_proto_get_properties(char *proto)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	sa_protocol_properties_t props = NULL;
+
+	if (ops != NULL && ops->sa_get_proto_set != NULL)
+	    props = ops->sa_get_proto_set();
+	return (props);
+}
+
+/*
+ * sa_proto_set_property(proto, prop)
+ *
+ * Update the protocol specifiec property.
+ */
+
+int
+sa_proto_set_property(char *proto, sa_property_t prop)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = SA_OK;
+	if (ops != NULL && ops->sa_set_proto_prop != NULL)
+	    ret = ops->sa_set_proto_prop(prop);
+	return (ret);
+}
+
+/*
+ * sa_valid_protocol(proto)
+ *
+ * check to see if the protocol specified is defined by a
+ * plugin. Returns true (1) or false (0)
+ */
+
+int
+sa_valid_protocol(char *proto)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	return (ops != NULL);
+}
+
+/*
+ * Return the current operational status of the protocol
+ */
+
+char *
+sa_get_protocol_status(char *proto)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	char *ret = NULL;
+	if (ops != NULL && ops->sa_get_proto_status != NULL)
+	    ret = ops->sa_get_proto_status(proto);
+	return (ret);
+}
+
+/*
+ * sa_proto_update_legacy(proto, share)
+ *
+ * Update the protocol specific legacy files if necessary for the
+ * specified share.
+ */
+
+int
+sa_proto_update_legacy(char *proto, sa_share_t share)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = SA_NOT_IMPLEMENTED;
+
+	if (ops != NULL) {
+	    if (ops->sa_update_legacy != NULL)
+		ret = ops->sa_update_legacy(share);
+	}
+	return (ret);
+}
+
+/*
+ * sa_delete_legacy(proto, share)
+ *
+ * remove the specified share from the protocol specific legacy files.
+ */
+
+int
+sa_proto_delete_legacy(char *proto, sa_share_t share)
+{
+	struct sa_plugin_ops *ops = find_protocol(proto);
+	int ret = SA_OK;
+
+	if (ops != NULL) {
+	    if (ops->sa_delete_legacy != NULL)
+		ret = ops->sa_delete_legacy(share);
+	} else {
+	    if (proto != NULL)
+		ret = SA_NOT_IMPLEMENTED;
+	    else
+		ret = SA_INVALID_PROTOCOL;
+	}
+	return (ret);
+}