Allow 'zpool replace' to use short device names
[zfs.git] / lib / libshare / nfs.c
index b42064d..53691eb 100644 (file)
@@ -22,6 +22,7 @@
 /*
  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2011 Gunnar Beutner
+ * Copyright (c) 2012 Cyril Plisko. All rights reserved.
  */
 
 #include <stdio.h>
@@ -33,8 +34,9 @@
 #include <libshare.h>
 #include "libshare_impl.h"
 
+static boolean_t nfs_available(void);
+
 static sa_fstype_t *nfs_fstype;
-static boolean_t nfs_available;
 
 /*
  * nfs_exportfs_temp_fd refers to a temporary copy of the output
@@ -48,6 +50,10 @@ typedef int (*nfs_shareopt_callback_t)(const char *opt, const char *value,
 typedef int (*nfs_host_callback_t)(const char *sharepath, const char *host,
     const char *security, const char *access, void *cookie);
 
+/**
+ * Invokes the specified callback function for each Solaris share option
+ * listed in the specified string.
+ */
 static int
 foreach_nfs_shareopt(const char *shareopts,
     nfs_shareopt_callback_t callback, void *cookie)
@@ -111,6 +117,11 @@ typedef struct nfs_host_cookie_s {
        const char *security;
 } nfs_host_cookie_t;
 
+/**
+ * Helper function for foreach_nfs_host. This function checks whether the
+ * current share option is a host specification and invokes a callback
+ * function with information about the host.
+ */
 static int
 foreach_nfs_host_cb(const char *opt, const char *value, void *pcookie)
 {
@@ -164,6 +175,9 @@ foreach_nfs_host_cb(const char *opt, const char *value, void *pcookie)
        return SA_OK;
 }
 
+/**
+ * Invokes a callback function for all NFS hosts that are set for a share.
+ */
 static int
 foreach_nfs_host(sa_share_impl_t impl_share, nfs_host_callback_t callback,
     void *cookie)
@@ -182,6 +196,9 @@ foreach_nfs_host(sa_share_impl_t impl_share, nfs_host_callback_t callback,
            &udata);
 }
 
+/**
+ * Converts a Solaris NFS host specification to its Linux equivalent.
+ */
 static int
 get_linux_hostspec(const char *solaris_hostspec, char **plinux_hostspec)
 {
@@ -206,6 +223,9 @@ get_linux_hostspec(const char *solaris_hostspec, char **plinux_hostspec)
        return SA_OK;
 }
 
+/**
+ * Used internally by nfs_enable_share to enable sharing for a single host.
+ */
 static int
 nfs_enable_share_one(const char *sharepath, const char *host,
     const char *security, const char *access, void *pcookie)
@@ -266,6 +286,9 @@ nfs_enable_share_one(const char *sharepath, const char *host,
                return SA_OK;
 }
 
+/**
+ * Adds a Linux share option to an array of NFS options.
+ */
 static int
 add_linux_shareopt(char **plinux_opts, const char *key, const char *value)
 {
@@ -298,6 +321,10 @@ add_linux_shareopt(char **plinux_opts, const char *key, const char *value)
        return SA_OK;
 }
 
+/**
+ * Validates and converts a single Solaris share option to its Linux
+ * equivalent.
+ */
 static int
 get_linux_shareopts_cb(const char *key, const char *value, void *cookie)
 {
@@ -335,7 +362,7 @@ get_linux_shareopts_cb(const char *key, const char *value, void *cookie)
            strcmp(key, "root_squash") != 0 &&
            strcmp(key, "no_root_squash") != 0 &&
            strcmp(key, "all_squash") != 0 &&
-           strcmp(key, "no_all_squash") != 0 &&
+           strcmp(key, "no_all_squash") != 0 && strcmp(key, "fsid") != 0 &&
            strcmp(key, "anonuid") != 0 && strcmp(key, "anongid") != 0) {
                return SA_SYNTAX_ERR;
        }
@@ -345,6 +372,10 @@ get_linux_shareopts_cb(const char *key, const char *value, void *cookie)
        return SA_OK;
 }
 
+/**
+ * Takes a string containing Solaris share options (e.g. "sync,no_acl") and
+ * converts them to a NULL-terminated array of Linux NFS options.
+ */
 static int
 get_linux_shareopts(const char *shareopts, char **plinux_opts)
 {
@@ -369,13 +400,16 @@ get_linux_shareopts(const char *shareopts, char **plinux_opts)
        return rc;
 }
 
+/**
+ * Enables NFS sharing for the specified share.
+ */
 static int
 nfs_enable_share(sa_share_impl_t impl_share)
 {
        char *shareopts, *linux_opts;
        int rc;
 
-       if (!nfs_available) {
+       if (!nfs_available()) {
                return SA_SYSTEM_ERR;
        }
 
@@ -396,6 +430,9 @@ nfs_enable_share(sa_share_impl_t impl_share)
        return rc;
 }
 
+/**
+ * Used internally by nfs_disable_share to disable sharing for a single host.
+ */
 static int
 nfs_disable_share_one(const char *sharepath, const char *host,
     const char *security, const char *access, void *cookie)
@@ -439,10 +476,13 @@ nfs_disable_share_one(const char *sharepath, const char *host,
                return SA_OK;
 }
 
+/**
+ * Disables NFS sharing for the specified share.
+ */
 static int
 nfs_disable_share(sa_share_impl_t impl_share)
 {
-       if (!nfs_available) {
+       if (!nfs_available()) {
                /*
                 * The share can't possibly be active, so nothing
                 * needs to be done to disable it.
@@ -453,6 +493,9 @@ nfs_disable_share(sa_share_impl_t impl_share)
        return foreach_nfs_host(impl_share, nfs_disable_share_one, NULL);
 }
 
+/**
+ * Checks whether the specified NFS share options are syntactically correct.
+ */
 static int
 nfs_validate_shareopts(const char *shareopts)
 {
@@ -469,6 +512,9 @@ nfs_validate_shareopts(const char *shareopts)
        return SA_OK;
 }
 
+/**
+ * Checks whether a share is currently active.
+ */
 static boolean_t
 is_share_active(sa_share_impl_t impl_share)
 {
@@ -476,7 +522,7 @@ is_share_active(sa_share_impl_t impl_share)
        char *tab, *cur;
        FILE *nfs_exportfs_temp_fp;
 
-       if (nfs_exportfs_temp_fd < 0)
+       if (!nfs_available())
                return B_FALSE;
 
        nfs_exportfs_temp_fp = fdopen(dup(nfs_exportfs_temp_fd), "r");
@@ -527,6 +573,12 @@ is_share_active(sa_share_impl_t impl_share)
        return B_FALSE;
 }
 
+/**
+ * Called to update a share's options. A share's options might be out of
+ * date if the share was loaded from disk (i.e. /etc/dfs/sharetab) and the
+ * "sharenfs" dataset property has changed in the meantime. This function
+ * also takes care of re-enabling the share if necessary.
+ */
 static int
 nfs_update_shareopts(sa_share_impl_t impl_share, const char *resource,
     const char *shareopts)
@@ -564,7 +616,10 @@ nfs_update_shareopts(sa_share_impl_t impl_share, const char *resource,
        return SA_OK;
 }
 
-
+/**
+ * Clears a share's NFS options. Used by libshare to
+ * clean up shares that are about to be free()'d.
+ */
 static void
 nfs_clear_shareopts(sa_share_impl_t impl_share)
 {
@@ -618,18 +673,27 @@ nfs_check_exportfs(void)
 
        pid = fork();
 
-       if (pid < 0)
+       if (pid < 0) {
+               (void) close(nfs_exportfs_temp_fd);
+               nfs_exportfs_temp_fd = -1;
                return SA_SYSTEM_ERR;
+       }
 
        if (pid > 0) {
                while ((rc = waitpid(pid, &status, 0)) <= 0 && errno == EINTR)
                        ; /* empty loop body */
 
-               if (rc <= 0)
+               if (rc <= 0) {
+                       (void) close(nfs_exportfs_temp_fd);
+                       nfs_exportfs_temp_fd = -1;
                        return SA_SYSTEM_ERR;
+               }
 
-               if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
+               if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
+                       (void) close(nfs_exportfs_temp_fd);
+                       nfs_exportfs_temp_fd = -1;
                        return SA_CONFIG_ERR;
+               }
 
                return SA_OK;
        }
@@ -650,10 +714,23 @@ nfs_check_exportfs(void)
        exit(0);
 }
 
+/*
+ * Provides a convenient wrapper for determing nfs availability
+ */
+static boolean_t
+nfs_available(void)
+{
+       if (nfs_exportfs_temp_fd == -1)
+               (void) nfs_check_exportfs();
+
+       return (nfs_exportfs_temp_fd != -1) ? B_TRUE : B_FALSE;
+}
+
+/**
+ * Initializes the NFS functionality of libshare.
+ */
 void
 libshare_nfs_init(void)
 {
-       nfs_available = (nfs_check_exportfs() == SA_OK);
-
        nfs_fstype = register_fstype("nfs", &nfs_shareops);
 }