]> git.decadent.org.uk Git - nfs-utils.git/blobdiff - utils/mount/stropts.c
Fix error reporting when probe_bothports() fails while rewriting mount
[nfs-utils.git] / utils / mount / stropts.c
index 72480b7e0d279429b870d5b0a3db2107b95081cf..967fd69531f7a338b13fe7b7775ea3d991bf2af2 100644 (file)
  *
  */
 
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
 #include <ctype.h>
 #include <unistd.h>
 #include <stdio.h>
 #define NFS_MAXPATHNAME                (1024)
 #endif
 
+#ifndef NFS_DEF_FG_TIMEOUT_MINUTES
+#define NFS_DEF_FG_TIMEOUT_MINUTES     (2u)
+#endif
+
+#ifndef NFS_DEF_BG_TIMEOUT_MINUTES
+#define NFS_DEF_BG_TIMEOUT_MINUTES     (10000u)
+#endif
+
 extern int nfs_mount_data_version;
 extern char *progname;
 extern int verbose;
 
-static int parse_devname(const char *spec, char **hostname)
+struct nfsmount_info {
+       const char              *spec,          /* server:/path */
+                               *node,          /* mounted-on dir */
+                               *type;          /* "nfs" or "nfs4" */
+       char                    *hostname;      /* server's hostname */
+
+       struct mount_options    *options;       /* parsed mount options */
+       char                    **extra_opts;   /* string for /etc/mtab */
+
+       int                     flags,          /* MS_ flags */
+                               fake,           /* actually do the mount? */
+                               child;          /* forked bg child? */
+};
+
+static int nfs_parse_devname(struct nfsmount_info *mi)
 {
        int ret = 0;
        char *dev, *pathname, *s;
 
-       dev = xstrdup(spec);
+       dev = xstrdup(mi->spec);
 
        if (!(pathname = strchr(dev, ':'))) {
                nfs_error(_("%s: remote share not in 'host:dir' format"),
@@ -101,11 +127,12 @@ static int parse_devname(const char *spec, char **hostname)
                nfs_error(_("%s: ignoring hostnames that follow the first one"),
                                progname);
        }
-       *hostname = xstrdup(dev);
-       if (strlen(*hostname) > NFS_MAXHOSTNAME) {
+       mi->hostname = xstrdup(dev);
+       if (strlen(mi->hostname) > NFS_MAXHOSTNAME) {
                nfs_error(_("%s: server hostname is too long"),
                                progname);
-               free(*hostname);
+               free(mi->hostname);
+               mi->hostname = NULL;
                goto out;
        }
 
@@ -136,6 +163,32 @@ static int fill_ipv4_sockaddr(const char *hostname, struct sockaddr_in *addr)
        return 1;
 }
 
+/*
+ * Obtain a retry timeout value based on the value of the "retry=" option.
+ *
+ * Returns a time_t timeout timestamp, in seconds.
+ */
+static time_t nfs_parse_retry_option(struct mount_options *options,
+                                    unsigned int timeout_minutes)
+{
+       char *retry_option, *endptr;
+
+       retry_option = po_get(options, "retry");
+       if (retry_option) {
+               long tmp;
+
+               errno = 0;
+               tmp = strtol(retry_option, &endptr, 10);
+               if (errno == 0 && endptr != retry_option && tmp >= 0)
+                       timeout_minutes = tmp;
+               else if (verbose)
+                       nfs_error(_("%s: invalid retry timeout was specified; "
+                                       "using default timeout"), progname);
+       }
+
+       return time(NULL) + (time_t)(timeout_minutes * 60);
+}
+
 /*
  * Append the 'addr=' option to the options string to pass a resolved
  * server address to the kernel.  After a successful mount, this address
@@ -215,25 +268,50 @@ static int fix_mounthost_option(struct mount_options *options)
 }
 
 /*
- * Set up mandatory mount options.
+ * Returns zero if the "lock" option is in effect, but statd
+ * can't be started.  Otherwise, returns 1.
+ */
+static int verify_lock_option(struct mount_options *options)
+{
+       if (po_rightmost(options, "nolock", "lock") == PO_KEY1_RIGHTMOST)
+               return 1;
+
+       if (!start_statd()) {
+               nfs_error(_("%s: rpc.statd is not running but is "
+                           "required for remote locking."), progname);
+               nfs_error(_("%s: Either use '-o nolock' to keep "
+                           "locks local, or start statd."), progname);
+               return 0;
+       }
+
+       return 1;
+}
+
+/*
+ * Set up mandatory NFS mount options.
  *
  * Returns 1 if successful; otherwise zero.
  */
-static int set_mandatory_options(const char *type,
-                                struct sockaddr_in *saddr,
-                                struct mount_options *options)
+static int nfs_validate_options(struct nfsmount_info *mi)
 {
-       if (!append_addr_option(saddr, options))
+       struct sockaddr_in saddr;
+
+       if (!fill_ipv4_sockaddr(mi->hostname, &saddr))
                return 0;
 
-       if (strncmp(type, "nfs4", 4) == 0) {
-               if (!append_clientaddr_option(saddr, options))
+       if (strncmp(mi->type, "nfs4", 4) == 0) {
+               if (!append_clientaddr_option(&saddr, mi->options))
                        return 0;
        } else {
-               if (!fix_mounthost_option(options))
+               if (!fix_mounthost_option(mi->options))
+                       return 0;
+               if (!mi->fake && !verify_lock_option(mi->options))
                        return 0;
        }
 
+       if (!append_addr_option(&saddr, mi->options))
+               return 0;
+
        return 1;
 }
 
@@ -248,7 +326,6 @@ static int set_mandatory_options(const char *type,
 static int is_permanent_error(int error)
 {
        switch (error) {
-       case EACCES:
        case ESTALE:
        case ETIMEDOUT:
        case ECONNREFUSED:
@@ -279,6 +356,8 @@ static struct mount_options *rewrite_mount_options(char *str)
        clnt_addr_t nfs_server = { };
        int p;
 
+       errno = EIO;
+
        options = po_split(str);
        if (!options)
                return NULL;
@@ -304,9 +383,6 @@ static struct mount_options *rewrite_mount_options(char *str)
        if (option)
                mnt_server.pmap.pm_port = atoi(option);
        mnt_server.pmap.pm_prog = MOUNTPROG;
-       option = po_get(options, "mountprog");
-       if (option)
-               mnt_server.pmap.pm_prog = atoi(option);
        option = po_get(options, "mountvers");
        if (option)
                mnt_server.pmap.pm_vers = atoi(option);
@@ -317,9 +393,6 @@ static struct mount_options *rewrite_mount_options(char *str)
                po_remove_all(options, "port");
        }
        nfs_server.pmap.pm_prog = NFS_PROGRAM;
-       option = po_get(options, "nfsprog");
-       if (option)
-               nfs_server.pmap.pm_prog = atoi(option);
 
        option = po_get(options, "nfsvers");
        if (option) {
@@ -355,7 +428,7 @@ static struct mount_options *rewrite_mount_options(char *str)
        po_remove_all(options, "udp");
 
        if (!probe_bothports(&mnt_server, &nfs_server)) {
-               rpc_mount_errors("rpcbind", 0, 0);
+               errno = ESPIPE;
                goto err;
        }
 
@@ -381,6 +454,7 @@ static struct mount_options *rewrite_mount_options(char *str)
 
        }
 
+       errno = 0;
        return options;
 
 err:
@@ -388,6 +462,27 @@ err:
        return NULL;
 }
 
+/*
+ * Do the mount(2) system call.
+ *
+ * Returns 1 if successful, otherwise zero.
+ * "errno" is set to reflect the individual error.
+ */
+static int nfs_sys_mount(const struct nfsmount_info *mi, const char *type,
+                        const char *options)
+{
+       int result;
+
+       result = mount(mi->spec, mi->node, type,
+                               mi->flags & ~(MS_USER|MS_USERS), options);
+       if (verbose && result) {
+               int save = errno;
+               nfs_error(_("%s: mount(2): %s"), progname, strerror(save));
+               errno = save;
+       }
+       return !result;
+}
+
 /*
  * Retry an NFS mount that failed because the requested service isn't
  * available on the server.
@@ -399,18 +494,15 @@ err:
  * 'extra_opts' are updated to reflect the mount options that worked.
  * If the retry fails, 'options' and 'extra_opts' are left unchanged.
  */
-static int retry_nfsmount(const char *spec, const char *node,
-                       int flags, struct mount_options *options,
-                       int fake, char **extra_opts)
+static int nfs_retry_nfs23mount(struct nfsmount_info *mi)
 {
        struct mount_options *retry_options;
        char *retry_str = NULL;
+       char **extra_opts = mi->extra_opts;
 
        retry_options = rewrite_mount_options(*extra_opts);
-       if (!retry_options) {
-               errno = EIO;
+       if (!retry_options)
                return 0;
-       }
 
        if (po_join(retry_options, &retry_str) == PO_FAILED) {
                po_destroy(retry_options);
@@ -422,17 +514,16 @@ static int retry_nfsmount(const char *spec, const char *node,
                printf(_("%s: text-based options (retry): '%s'\n"),
                        progname, retry_str);
 
-       if (!mount(spec, node, "nfs",
-                               flags & ~(MS_USER|MS_USERS), retry_str)) {
-               free(*extra_opts);
-               *extra_opts = retry_str;
-               po_replace(options, retry_options);
-               return 1;
+       if (!nfs_sys_mount(mi, "nfs", retry_str)) {
+               po_destroy(retry_options);
+               free(retry_str);
+               return 0;
        }
 
-       po_destroy(retry_options);
-       free(retry_str);
-       return 0;
+       free(*extra_opts);
+       *extra_opts = retry_str;
+       po_replace(mi->options, retry_options);
+       return 1;
 }
 
 /*
@@ -448,11 +539,11 @@ static int retry_nfsmount(const char *spec, const char *node,
  * 'extra_opts' are updated to reflect the mount options that worked.
  * If the retry fails, 'options' and 'extra_opts' are left unchanged.
  */
-static int try_nfs23mount(const char *spec, const char *node,
-                         int flags, struct mount_options *options,
-                         int fake, char **extra_opts)
+static int nfs_try_nfs23mount(struct nfsmount_info *mi)
 {
-       if (po_join(options, extra_opts) == PO_FAILED) {
+       char **extra_opts = mi->extra_opts;
+
+       if (po_join(mi->options, extra_opts) == PO_FAILED) {
                errno = EIO;
                return 0;
        }
@@ -461,11 +552,10 @@ static int try_nfs23mount(const char *spec, const char *node,
                printf(_("%s: text-based options: '%s'\n"),
                        progname, *extra_opts);
 
-       if (fake)
+       if (mi->fake)
                return 1;
 
-       if (!mount(spec, node, "nfs",
-                               flags & ~(MS_USER|MS_USERS), *extra_opts))
+       if (nfs_sys_mount(mi, "nfs", *extra_opts))
                return 1;
 
        /*
@@ -475,7 +565,7 @@ static int try_nfs23mount(const char *spec, const char *node,
        if (errno != EOPNOTSUPP && errno != EPROTONOSUPPORT)
                return 0;
 
-       return retry_nfsmount(spec, node, flags, options, fake, extra_opts);
+       return nfs_retry_nfs23mount(mi);
 }
 
 /*
@@ -484,11 +574,11 @@ static int try_nfs23mount(const char *spec, const char *node,
  * Returns 1 if successful.  Otherwise, returns zero.
  * "errno" is set to reflect the individual error.
  */
-static int try_nfs4mount(const char *spec, const char *node,
-                        int flags, struct mount_options *options,
-                        int fake, char **extra_opts)
+static int nfs_try_nfs4mount(struct nfsmount_info *mi)
 {
-       if (po_join(options, extra_opts) == PO_FAILED) {
+       char **extra_opts = mi->extra_opts;
+
+       if (po_join(mi->options, extra_opts) == PO_FAILED) {
                errno = EIO;
                return 0;
        }
@@ -497,31 +587,24 @@ static int try_nfs4mount(const char *spec, const char *node,
                printf(_("%s: text-based options: '%s'\n"),
                        progname, *extra_opts);
 
-       if (fake)
+       if (mi->fake)
                return 1;
 
-       if (!mount(spec, node, "nfs4",
-                               flags & ~(MS_USER|MS_USERS), *extra_opts))
-               return 1;
-       return 0;
+       return nfs_sys_mount(mi, "nfs4", *extra_opts);
 }
 
 /*
- * Try the mount(2) system call.
+ * Perform either an NFSv2/3 mount, or an NFSv4 mount system call.
  *
  * Returns 1 if successful.  Otherwise, returns zero.
  * "errno" is set to reflect the individual error.
  */
-static int try_mount(const char *spec, const char *node, const char *type,
-                    int flags, struct mount_options *options, int fake,
-                    char **extra_opts)
+static int nfs_try_mount(struct nfsmount_info *mi)
 {
-       if (strncmp(type, "nfs4", 4) == 0)
-               return try_nfs4mount(spec, node, flags,
-                                       options, fake, extra_opts);
+       if (strncmp(mi->type, "nfs4", 4) == 0)
+               return nfs_try_nfs4mount(mi);
        else
-               return try_nfs23mount(spec, node, flags,
-                                       options, fake, extra_opts);
+               return nfs_try_nfs23mount(mi);
 }
 
 /*
@@ -531,27 +614,19 @@ static int try_mount(const char *spec, const char *node, const char *type,
  *
  * Returns a valid mount command exit code.
  */
-static int nfsmount_fg(const char *spec, const char *node,
-                      const char *type, int flags,
-                      struct mount_options *options, int fake,
-                      char **extra_opts)
+static int nfsmount_fg(struct nfsmount_info *mi)
 {
        unsigned int secs = 1;
-       time_t timeout = time(NULL);
-       char *retry;
-
-       timeout += 60 * 2;              /* default: 2 minutes */
-       retry = po_get(options, "retry");
-       if (retry)
-               timeout += 60 * atoi(retry);
+       time_t timeout;
 
+       timeout = nfs_parse_retry_option(mi->options,
+                                        NFS_DEF_FG_TIMEOUT_MINUTES);
        if (verbose)
                printf(_("%s: timeout set for %s"),
                        progname, ctime(&timeout));
 
        for (;;) {
-               if (try_mount(spec, node, type, flags,
-                                       options, fake, extra_opts))
+               if (nfs_try_mount(mi))
                        return EX_SUCCESS;
 
                if (is_permanent_error(errno))
@@ -571,10 +646,99 @@ static int nfsmount_fg(const char *spec, const char *node,
                }
        };
 
-       mount_error(spec, node, errno);
+       mount_error(mi->spec, mi->node, errno);
        return EX_FAIL;
 }
 
+/*
+ * Handle "background" NFS mount [first try]
+ *
+ * Returns a valid mount command exit code.
+ *
+ * EX_BG should cause the caller to fork and invoke nfsmount_child.
+ */
+static int nfsmount_parent(struct nfsmount_info *mi)
+{
+       if (nfs_try_mount(mi))
+               return EX_SUCCESS;
+
+       if (is_permanent_error(errno)) {
+               mount_error(mi->spec, mi->node, errno);
+               return EX_FAIL;
+       }
+
+       sys_mount_errors(mi->hostname, errno, 1, 1);
+       return EX_BG;
+}
+
+/*
+ * Handle "background" NFS mount [retry daemon]
+ *
+ * Returns a valid mount command exit code: EX_SUCCESS if successful,
+ * EX_FAIL if a failure occurred.  There's nothing to catch the
+ * error return, though, so we use sys_mount_errors to log the
+ * failure.
+ */
+static int nfsmount_child(struct nfsmount_info *mi)
+{
+       unsigned int secs = 1;
+       time_t timeout;
+
+       timeout = nfs_parse_retry_option(mi->options,
+                                        NFS_DEF_BG_TIMEOUT_MINUTES);
+
+       for (;;) {
+               if (sleep(secs))
+                       break;
+               secs <<= 1;
+               if (secs > 120)
+                       secs = 120;
+
+               if (nfs_try_mount(mi))
+                       return EX_SUCCESS;
+
+               if (is_permanent_error(errno))
+                       break;
+
+               if (time(NULL) > timeout)
+                       break;
+
+               sys_mount_errors(mi->hostname, errno, 1, 1);
+       };
+
+       sys_mount_errors(mi->hostname, errno, 1, 0);
+       return EX_FAIL;
+}
+
+/*
+ * Handle "background" NFS mount
+ *
+ * Returns a valid mount command exit code.
+ */
+static int nfsmount_bg(struct nfsmount_info *mi)
+{
+       if (!mi->child)
+               return nfsmount_parent(mi);
+       else
+               return nfsmount_child(mi);
+}
+
+/*
+ * Process mount options and try a mount system call.
+ *
+ * Returns a valid mount command exit code.
+ */
+static int nfsmount_start(struct nfsmount_info *mi)
+{
+       if (!nfs_validate_options(mi))
+               return EX_FAIL;
+
+       if (po_rightmost(mi->options, "bg", "fg") == PO_KEY1_RIGHTMOST)
+               return nfsmount_bg(mi);
+       else
+               return nfsmount_fg(mi);
+}
+
 /**
  * nfsmount_string - Mount an NFS file system using C string options
  * @spec: C string specifying remote share to mount ("hostname:path")
@@ -589,35 +753,27 @@ static int nfsmount_fg(const char *spec, const char *node,
 int nfsmount_string(const char *spec, const char *node, const char *type,
                    int flags, char **extra_opts, int fake, int child)
 {
-       struct mount_options *options = NULL;
-       struct sockaddr_in saddr;
-       char *hostname;
-       int err, retval = EX_FAIL;
+       struct nfsmount_info mi = {
+               .spec           = spec,
+               .node           = node,
+               .type           = type,
+               .extra_opts     = extra_opts,
+               .flags          = flags,
+               .fake           = fake,
+               .child          = child,
+       };
+       int retval = EX_FAIL;
 
-       if (!parse_devname(spec, &hostname))
-               goto out;
-       err = fill_ipv4_sockaddr(hostname, &saddr);
-       free(hostname);
-       if (!err)
-               goto out;
+       if (!nfs_parse_devname(&mi))
+               return retval;
 
-       options = po_split(*extra_opts);
-       if (!options) {
+       mi.options = po_split(*extra_opts);
+       if (mi.options) {
+               retval = nfsmount_start(&mi);
+               po_destroy(mi.options);
+       } else
                nfs_error(_("%s: internal option parsing error"), progname);
-               goto out;
-       }
 
-       if (!set_mandatory_options(type, &saddr, options))
-               goto out;
-
-       if (try_mount(spec, node, type, flags, options, fake, extra_opts)) {
-               mount_error(spec, node, errno);
-               goto out;
-       }
-
-       retval = EX_SUCCESS;
-
-out:
-       po_destroy(options);
+       free(mi.hostname);
        return retval;
 }