]> git.decadent.org.uk Git - nfs-utils.git/blobdiff - utils/mount/stropts.c
text-based mount.nfs: Implement falling back to NFSv2 and UDP
[nfs-utils.git] / utils / mount / stropts.c
index e43bbf48d356772c2bfa255edbebb4388138a3fd..1d2cde6d0386d4bfc702134b8f62b420289543bb 100644 (file)
@@ -40,6 +40,7 @@
 #include "stropts.h"
 #include "error.h"
 #include "network.h"
+#include "parse_opt.h"
 
 #ifdef HAVE_RPCSVC_NFS_PROT_H
 #include <rpcsvc/nfs_prot.h>
 #define NFS_PORT 2049
 #endif
 
+#ifndef NFS_MAXHOSTNAME
+#define NFS_MAXHOSTNAME                (255)
+#endif
+
+#ifndef NFS_MAXPATHNAME
+#define NFS_MAXPATHNAME                (1024)
+#endif
+
 extern int nfs_mount_data_version;
 extern char *progname;
 extern int verbose;
 
-static int retry_opt = 10000;          /* 10,000 minutes ~= 1 week */
-static int bg_opt = 0;
-static int addr_opt = 0;
-static int ca_opt = 0;
-
-static int parse_devname(char *hostdir, char **hostname, char **dirname)
+static int parse_devname(const char *spec, char **hostname)
 {
-       char *s;
+       int ret = 0;
+       char *dev, *pathname, *s;
+
+       dev = xstrdup(spec);
 
-       if (!(s = strchr(hostdir, ':'))) {
-               nfs_error(_("%s: directory to mount not in host:dir format"),
+       if (!(pathname = strchr(dev, ':'))) {
+               nfs_error(_("%s: remote share not in 'host:dir' format"),
+                               progname);
+               goto out;
+       }
+       *pathname = '\0';
+       pathname++;
+
+       /*
+        * We don't need a copy of the pathname, but let's
+        * sanity check it anyway.
+        */
+       if (strlen(pathname) > NFS_MAXPATHNAME) {
+               nfs_error(_("%s: export pathname is too long"),
                                progname);
-               return -1;
+               goto out;
        }
-       *hostname = hostdir;
-       *dirname = s + 1;
-       *s = '\0';
-       /* Ignore all but first hostname in replicated mounts
-          until they can be fully supported. (mack@sgi.com) */
-       if ((s = strchr(hostdir, ','))) {
+
+       /*
+        * Ignore all but first hostname in replicated mounts
+        * until they can be fully supported. (mack@sgi.com)
+        */
+       if ((s = strchr(dev, ','))) {
                *s = '\0';
                nfs_error(_("%s: warning: multiple hostnames not supported"),
                                progname);
+               nfs_error(_("%s: ignoring hostnames that follow the first one"),
+                               progname);
        }
-       return 0;
+       *hostname = xstrdup(dev);
+       if (strlen(*hostname) > NFS_MAXHOSTNAME) {
+               nfs_error(_("%s: server hostname is too long"),
+                               progname);
+               free(*hostname);
+               goto out;
+       }
+
+       ret = 1;
+
+out:
+       free(dev);
+       return ret;
 }
 
 static int fill_ipv4_sockaddr(const char *hostname, struct sockaddr_in *addr)
@@ -104,237 +137,427 @@ static int fill_ipv4_sockaddr(const char *hostname, struct sockaddr_in *addr)
 }
 
 /*
- * XXX: This should really use the technique neil recently added
- * to get the address off the local end of a socket connected to
- * the server -- to get the right address to use on multi-homed
- * clients
+ * Append the 'addr=' option to the options string to pass a resolved
+ * server address to the kernel.  After a successful mount, this address
+ * is also added to /etc/mtab for use when unmounting.
+ *
+ * If 'addr=' is already present, we strip it out.  This prevents users
+ * from setting a bogus 'addr=' option themselves, and also allows bg
+ * retries to recompute the server's address, in case it has changed.
+ *
+ * Returns 1 if 'addr=' option appended successfully;
+ * otherwise zero.
  */
-static int get_my_ipv4addr(char *ip_addr, int len)
+static int append_addr_option(struct sockaddr_in *saddr,
+                          struct mount_options *options)
 {
-       char myname[1024];
-       struct sockaddr_in myaddr;
+       char new_option[24];
 
-       if (gethostname(myname, sizeof(myname))) {
-               nfs_error(_("%s: can't determine client address\n"),
-                               progname);
-               return 0;
-       }
-       if (!fill_ipv4_sockaddr(myname, &myaddr))
-               return 0;
+       po_remove_all(options, "addr");
 
-       snprintf(ip_addr, len, "%s", inet_ntoa(myaddr.sin_addr));
-       ip_addr[len - 1] = '\0';
+       snprintf(new_option, sizeof(new_option) - 1,
+                       "addr=%s", inet_ntoa(saddr->sin_addr));
 
-       return 1;
+       if (po_append(options, new_option) == PO_SUCCEEDED)
+               return 1;
+       return 0;
 }
 
 /*
- * Walk through our mount options string, and indicate the presence
- * of 'bg', 'retry=', 'addr=', and 'clientaddr='.
+ * Called to discover our address and append an appropriate 'clientaddr='
+ * option to the options string.
+ *
+ * Returns 1 if 'clientaddr=' option created successfully or if
+ * 'clientaddr=' option is already present; otherwise zero.
  */
-static void extract_interesting_options(char *opts)
+static int append_clientaddr_option(struct sockaddr_in *saddr,
+                                   struct mount_options *options)
 {
-       char *opt, *opteq;
-       int val;
-
-       opts = xstrdup(opts);
-
-       for (opt = strtok(opts, ","); opt; opt = strtok(NULL, ",")) {
-               if ((opteq = strchr(opt, '='))) {
-                       val = atoi(opteq + 1);
-                       *opteq = '\0';
-                       if (strcmp(opt, "bg") == 0)
-                               bg_opt++;
-                       else if (strcmp(opt, "retry") == 0)
-                               retry_opt = val;
-                       else if (strcmp(opt, "addr") == 0)
-                               addr_opt++;
-                       else if (strcmp(opt, "clientaddr") == 0)
-                               ca_opt++;
-               } else {
-                       if (strcmp(opt, "bg") == 0)
-                               bg_opt++;
-               }
-       }
+       struct sockaddr_in my_addr;
+       char new_option[32];
+
+       if (po_contains(options, "clientaddr") == PO_SUCCEEDED)
+               return 1;
+
+       if (!get_client_address(saddr, &my_addr))
+               return 0;
 
-       free(opts);
+       snprintf(new_option, sizeof(new_option) - 1,
+                       "clientaddr=%s", inet_ntoa(my_addr.sin_addr));
+
+       if (po_append(options, new_option) == PO_SUCCEEDED)
+               return 1;
+       return 0;
 }
 
 /*
- * Append the 'addr=' option to the options string.
- *
- * Returns 1 if 'addr=' option created successfully;
- * otherwise zero.
+ * Resolve the 'mounthost=' hostname and append a new option using
+ * the resulting IPv4 address.
  */
-static int append_addr_opt(const char *spec, char **extra_opts)
+static int fix_mounthost_option(struct mount_options *options)
 {
-       static char hostdir[1024], new_opts[1024], ip_addr[255];
-       char *hostname, *dirname, *s, *old_opts;
-       struct sockaddr_in addr;
+       struct sockaddr_in maddr;
+       char *mounthost, new_option[32];
 
-       if (strlen(spec) >= sizeof(hostdir)) {
-               nfs_error(_("%s: excessively long host:dir argument\n"),
-                               progname);
-               return 0;
-       }
-       strcpy(hostdir, spec);
-       if (parse_devname(hostdir, &hostname, &dirname)) {
-               nfs_error(_("%s: parsing host:dir argument failed\n"),
-                               progname);
-               return 0;
-       }
+       mounthost = po_get(options, "mounthost");
+       if (!mounthost)
+               return 1;
 
-       if (!fill_ipv4_sockaddr(hostname, &addr))
-               return 0;
-       if (!get_my_ipv4addr(ip_addr, sizeof(ip_addr)))
+       if (!fill_ipv4_sockaddr(mounthost, &maddr))
                return 0;
 
-       /* add IP address to mtab options for use when unmounting */
-       s = inet_ntoa(addr.sin_addr);
-       old_opts = *extra_opts;
-       if (!old_opts)
-               old_opts = "";
-       if (strlen(old_opts) + strlen(s) + 10 >= sizeof(new_opts)) {
-               nfs_error(_("%s: excessively long option argument\n"),
-                               progname);
+       snprintf(new_option, sizeof(new_option) - 1,
+                       "mountaddr=%s", inet_ntoa(maddr.sin_addr));
+
+       if (po_append(options, new_option) == PO_SUCCEEDED)
+               return 1;
+       return 0;
+}
+
+/*
+ * Set up mandatory mount options.
+ *
+ * Returns 1 if successful; otherwise zero.
+ */
+static int set_mandatory_options(const char *type,
+                                struct sockaddr_in *saddr,
+                                struct mount_options *options)
+{
+       if (!append_addr_option(saddr, options))
                return 0;
+
+       if (strncmp(type, "nfs4", 4) == 0) {
+               if (!append_clientaddr_option(saddr, options))
+                       return 0;
+       } else {
+               if (!fix_mounthost_option(options))
+                       return 0;
        }
-       snprintf(new_opts, sizeof(new_opts), "%s%saddr=%s",
-                old_opts, *old_opts ? "," : "", s);
-       *extra_opts = xstrdup(new_opts);
 
        return 1;
 }
 
 /*
- * Append the 'clientaddr=' option to the options string.
+ * Reconstruct the mount option string based on a portmapper probe
+ * of the server.  Returns one if the server's portmapper returned
+ * something we can use, otherwise zero.
  *
- * Returns 1 if 'clientaddr=' option created successfully;
- * otherwise zero.
+ * To handle version and transport protocol fallback properly, we
+ * need to parse some of the mount options in order to set up a
+ * portmap probe.  Mount options that rewrite_mount_options()
+ * doesn't recognize are left alone.
+ *
+ * Returns a new group of mount options if successful; otherwise
+ * NULL is returned if some failure occurred.
  */
-static int append_clientaddr_opt(const char *spec, char **extra_opts)
+static struct mount_options *rewrite_mount_options(char *str)
 {
-       static char new_opts[1024], cbuf[1024];
-       static char ip_addr[16] = "127.0.0.1";
-
-       if (!get_my_ipv4addr(ip_addr, sizeof(ip_addr)))
-               return 0;
+       struct mount_options *options;
+       char *option, new_option[64];
+       clnt_addr_t mnt_server = { };
+       clnt_addr_t nfs_server = { };
+       int p;
+
+       options = po_split(str);
+       if (!options)
+               return NULL;
+
+       option = po_get(options, "addr");
+       if (option) {
+               nfs_server.saddr.sin_family = AF_INET;
+               if (!inet_aton((const char *)option, &nfs_server.saddr.sin_addr))
+                       goto err;
+       } else
+               goto err;
+
+       option = po_get(options, "mountaddr");
+       if (option) {
+               mnt_server.saddr.sin_family = AF_INET;
+               if (!inet_aton((const char *)option, &mnt_server.saddr.sin_addr))
+                       goto err;
+       } else
+               memcpy(&mnt_server.saddr, &nfs_server.saddr,
+                               sizeof(mnt_server.saddr));
+
+       option = po_get(options, "mountport");
+       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);
+
+       option = po_get(options, "port");
+       if (option) {
+               nfs_server.pmap.pm_port = atoi(option);
+               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) {
+               nfs_server.pmap.pm_vers = atoi(option);
+               po_remove_all(options, "nfsvers");
+       }
+       option = po_get(options, "vers");
+       if (option) {
+               nfs_server.pmap.pm_vers = atoi(option);
+               po_remove_all(options, "vers");
+       }
+       option = po_get(options, "proto");
+       if (option) {
+               if (strcmp(option, "tcp") == 0) {
+                       nfs_server.pmap.pm_prot = IPPROTO_TCP;
+                       po_remove_all(options, "proto");
+               }
+               if (strcmp(option, "udp") == 0) {
+                       nfs_server.pmap.pm_prot = IPPROTO_UDP;
+                       po_remove_all(options, "proto");
+               }
+       }
+       p = po_rightmost(options, "tcp", "udp");
+       switch (p) {
+       case PO_KEY2_RIGHTMOST:
+               nfs_server.pmap.pm_prot = IPPROTO_UDP;
+               break;
+       case PO_KEY1_RIGHTMOST:
+               nfs_server.pmap.pm_prot = IPPROTO_TCP;
+               break;
+       }
+       po_remove_all(options, "tcp");
+       po_remove_all(options, "udp");
 
-       /* Ensure we have enough padding for the following strcat()s */
-       if (strlen(*extra_opts) + strlen(ip_addr) + 10 >= sizeof(new_opts)) {
-               nfs_error(_("%s: excessively long option argument"),
-                               progname);
-               return 0;
+       if (!probe_bothports(&mnt_server, &nfs_server)) {
+               rpc_mount_errors("rpcbind", 0, 0);
+               goto err;
        }
 
-       strcat(new_opts, *extra_opts);
+       snprintf(new_option, sizeof(new_option) - 1,
+                "nfsvers=%lu", nfs_server.pmap.pm_vers);
+       if (po_append(options, new_option) == PO_FAILED)
+               goto err;
+
+       if (nfs_server.pmap.pm_prot == IPPROTO_TCP)
+               snprintf(new_option, sizeof(new_option) - 1,
+                        "proto=tcp");
+       else
+               snprintf(new_option, sizeof(new_option) - 1,
+                        "proto=udp");
+       if (po_append(options, new_option) == PO_FAILED)
+               goto err;
+
+       if (nfs_server.pmap.pm_port != NFS_PORT) {
+               snprintf(new_option, sizeof(new_option) - 1,
+                        "port=%lu", nfs_server.pmap.pm_port);
+               if (po_append(options, new_option) == PO_FAILED)
+                       goto err;
 
-       snprintf(cbuf, sizeof(cbuf) - 1, "%sclientaddr=%s",
-                       *extra_opts ? "," : "", ip_addr);
-       strcat(new_opts, cbuf);
+       }
 
-       *extra_opts = xstrdup(new_opts);
+       return options;
 
-       return 1;
+err:
+       po_destroy(options);
+       return NULL;
 }
 
 /*
- * nfsmount_s - Mount an NFSv2 or v3 file system using C string options
+ * Retry an NFS mount that failed because the requested service isn't
+ * available on the server.
  *
- * @spec:      C string hostname:path specifying remoteshare to mount
- * @node:      C string pathname of local mounted on directory
- * @flags:     MS_ style flags
- * @extra_opts:        pointer to C string containing fs-specific mount options
- *             (possibly also a return argument)
- * @fake:      flag indicating whether to carry out the whole operation
- * @bg:                one if this is a backgrounded mount attempt
+ * Returns 1 if successful.  Otherwise, returns zero.
+ * "errno" is set to reflect the individual error.
  *
- * XXX: need to handle bg, fg, and retry options.
+ * Side effect: If the retry is successful, both 'options' and
+ * 'extra_opts' are updated to reflect the mount options that worked.
+ * If the retry fails, 'options' and 'extra_opts' are left unchanged.
  */
-int nfsmount_s(const char *spec, const char *node, int flags,
-               char **extra_opts, int fake, int bg)
+static int retry_nfsmount(const char *spec, const char *node,
+                       int flags, struct mount_options *options,
+                       int fake, char **extra_opts)
 {
-       int retval = EX_FAIL;
+       struct mount_options *retry_options;
+       char *retry_str = NULL;
 
-       extract_interesting_options(*extra_opts);
+       retry_options = rewrite_mount_options(*extra_opts);
+       if (!retry_options) {
+               errno = EIO;
+               return 0;
+       }
 
-       if (!bg && addr_opt) {
-               nfs_error(_("%s: Illegal option: 'addr='"), progname);
-               goto fail;
+       if (po_join(retry_options, &retry_str) == PO_FAILED) {
+               po_destroy(retry_options);
+               errno = EIO;
+               return 0;
        }
 
-       if (!append_addr_opt(spec, extra_opts))
-               goto fail;
+       if (verbose)
+               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;
+       }
+
+       po_destroy(retry_options);
+       free(retry_str);
+       return 0;
+}
+
+/*
+ * Attempt an NFSv2/3 mount via a mount(2) system call.  If the kernel
+ * claims the requested service isn't supported on the server, probe
+ * the server to see what's supported, rewrite the mount options,
+ * and retry the request.
+ *
+ * Returns 1 if successful.  Otherwise, returns zero.
+ * "errno" is set to reflect the individual error.
+ *
+ * Side effect: If the retry is successful, both 'options' and
+ * '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)
+{
+       if (po_join(options, extra_opts) == PO_FAILED) {
+               errno = EIO;
+               return 0;
+       }
 
        if (verbose)
                printf(_("%s: text-based options: '%s'\n"),
                        progname, *extra_opts);
 
-       if (!fake) {
-               if (mount(spec, node, "nfs",
-                               flags & ~(MS_USER|MS_USERS), *extra_opts)) {
-                       mount_error(spec, node, errno);
-                       goto fail;
-               }
-       }
+       if (fake)
+               return 1;
 
-       return 0;
+       if (!mount(spec, node, "nfs",
+                               flags & ~(MS_USER|MS_USERS), *extra_opts))
+               return 1;
 
-fail:
-       return retval;
+       /*
+        * The kernel returns EOPNOTSUPP if the RPC bind failed,
+        * and EPROTONOSUPPORT if the version isn't supported.
+        */
+       if (errno != EOPNOTSUPP && errno != EPROTONOSUPPORT)
+               return 0;
+
+       return retry_nfsmount(spec, node, flags, options, fake, extra_opts);
 }
 
 /*
- * nfs4mount_s - Mount an NFSv4 file system using C string options
- *
- * @spec:      C string hostname:path specifying remoteshare to mount
- * @node:      C string pathname of local mounted on directory
- * @flags:     MS_ style flags
- * @extra_opts:        pointer to C string containing fs-specific mount options
- *             (possibly also a return argument)
- * @fake:      flag indicating whether to carry out the whole operation
- * @child:     one if this is a backgrounded mount
- *
- * XXX: need to handle bg, fg, and retry options.
+ * Attempt an NFS v4 mount via a mount(2) system call.
  *
+ * Returns 1 if successful.  Otherwise, returns zero.
+ * "errno" is set to reflect the individual error.
  */
-int nfs4mount_s(const char *spec, const char *node, int flags,
-               char **extra_opts, int fake, int child)
+static int try_nfs4mount(const char *spec, const char *node,
+                        int flags, struct mount_options *options,
+                        int fake, char **extra_opts)
 {
-       int retval = EX_FAIL;
+       if (po_join(options, extra_opts) == PO_FAILED) {
+               errno = EIO;
+               return 0;
+       }
 
-       extract_interesting_options(*extra_opts);
+       if (verbose)
+               printf(_("%s: text-based options: '%s'\n"),
+                       progname, *extra_opts);
 
-       if (addr_opt) {
-               nfs_error(_("%s: Illegal option: 'addr='"), progname);
-               goto fail;
-       }
+       if (fake)
+               return 1;
 
-       if (ca_opt) {
-               nfs_error(_("%s: Illegal option: 'clientaddr='"), progname);
-               goto fail;
+       if (!mount(spec, node, "nfs4",
+                               flags & ~(MS_USER|MS_USERS), *extra_opts))
+               return 1;
+       return 0;
+}
+
+/*
+ * Try the mount(2) 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)
+{
+       if (strncmp(type, "nfs4", 4) == 0)
+               return try_nfs4mount(spec, node, flags,
+                                       options, fake, extra_opts);
+       else
+               return try_nfs23mount(spec, node, flags,
+                                       options, fake, extra_opts);
+}
+
+/**
+ * nfsmount_string - Mount an NFS file system using C string options
+ * @spec: C string specifying remote share to mount ("hostname:path")
+ * @node: C string pathname of local mounted-on directory
+ * @type: C string that represents file system type ("nfs" or "nfs4")
+ * @flags: MS_ style mount flags
+ * @extra_opts:        pointer to C string containing fs-specific mount options
+ *             (input and output argument)
+ * @fake: flag indicating whether to carry out the whole operation
+ * @child: one if this is a mount daemon (bg)
+ */
+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;
+
+       if (!parse_devname(spec, &hostname))
+               goto out;
+       err = fill_ipv4_sockaddr(hostname, &saddr);
+       free(hostname);
+       if (!err)
+               goto out;
+
+       options = po_split(*extra_opts);
+       if (!options) {
+               nfs_error(_("%s: internal option parsing error"), progname);
+               goto out;
        }
 
-       if (!append_addr_opt(spec, extra_opts))
-               goto fail;
+       if (!set_mandatory_options(type, &saddr, options))
+               goto out;
 
-       if (!append_clientaddr_opt(spec, extra_opts))
-               goto fail;
+       if (po_join(options, extra_opts) == PO_FAILED) {
+               nfs_error(_("%s: internal option parsing error"), progname);
+               goto out;
+       }
 
        if (verbose)
                printf(_("%s: text-based options: '%s'\n"),
                        progname, *extra_opts);
 
        if (!fake) {
-               if (mount(spec, node, "nfs4",
+               if (mount(spec, node, type,
                                flags & ~(MS_USER|MS_USERS), *extra_opts)) {
                        mount_error(spec, node, errno);
-                       goto fail;
+                       goto out;
                }
        }
 
-       return 0;
+       retval = EX_SUCCESS;
 
-fail:
+out:
+       po_destroy(options);
        return retval;
 }