utils/mount/stropts.c

   1 /*
   2  * stropts.c -- NFS mount using C string to pass options to kernel
   3  *
   4  * Copyright (C) 2007 Oracle.  All rights reserved.
   5  * Copyright (C) 2007 Chuck Lever <chuck.lever@oracle.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public
  18  * License along with this program; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 021110-1307, USA.
  21  *
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <ctype.h>
  29 #include <unistd.h>
  30 #include <stdio.h>
  31 #include <string.h>
  32 #include <stdlib.h>
  33 #include <errno.h>
  34 #include <netdb.h>
  35 #include <time.h>
  36 #include <sys/socket.h>
  37 #include <sys/mount.h>
  38
  39 #include "xcommon.h"
  40 #include "mount.h"
  41 #include "nls.h"
  42 #include "nfs_mount.h"
  43 #include "mount_constants.h"
  44 #include "stropts.h"
  45 #include "error.h"
  46 #include "network.h"
  47 #include "parse_opt.h"
  48
  49 #ifdef HAVE_RPCSVC_NFS_PROT_H
  50 #include <rpcsvc/nfs_prot.h>
  51 #else
  52 #include <linux/nfs.h>
  53 #define nfsstat nfs_stat
  54 #endif
  55
  56 #ifndef NFS_PORT
  57 #define NFS_PORT 2049
  58 #endif
  59
  60 #ifndef NFS_MAXHOSTNAME
  61 #define NFS_MAXHOSTNAME         (255)
  62 #endif
  63
  64 #ifndef NFS_MAXPATHNAME
  65 #define NFS_MAXPATHNAME         (1024)
  66 #endif
  67
  68 extern int nfs_mount_data_version;
  69 extern char *progname;
  70 extern int verbose;
  71
  72 static int parse_devname(const char *spec, char **hostname)
  73 {
  74         int ret = 0;
  75         char *dev, *pathname, *s;
  76
  77         dev = xstrdup(spec);
  78
  79         if (!(pathname = strchr(dev, ':'))) {
  80                 nfs_error(_("%s: remote share not in 'host:dir' format"),
  81                                 progname);
  82                 goto out;
  83         }
  84         *pathname = '\0';
  85         pathname++;
  86
  87         /*
  88          * We don't need a copy of the pathname, but let's
  89          * sanity check it anyway.
  90          */
  91         if (strlen(pathname) > NFS_MAXPATHNAME) {
  92                 nfs_error(_("%s: export pathname is too long"),
  93                                 progname);
  94                 goto out;
  95         }
  96
  97         /*
  98          * Ignore all but first hostname in replicated mounts
  99          * until they can be fully supported. (mack@sgi.com)
 100          */
 101         if ((s = strchr(dev, ','))) {
 102                 *s = '\0';
 103                 nfs_error(_("%s: warning: multiple hostnames not supported"),
 104                                 progname);
 105                 nfs_error(_("%s: ignoring hostnames that follow the first one"),
 106                                 progname);
 107         }
 108         *hostname = xstrdup(dev);
 109         if (strlen(*hostname) > NFS_MAXHOSTNAME) {
 110                 nfs_error(_("%s: server hostname is too long"),
 111                                 progname);
 112                 free(*hostname);
 113                 goto out;
 114         }
 115
 116         ret = 1;
 117
 118 out:
 119         free(dev);
 120         return ret;
 121 }
 122
 123 static int fill_ipv4_sockaddr(const char *hostname, struct sockaddr_in *addr)
 124 {
 125         struct hostent *hp;
 126         addr->sin_family = AF_INET;
 127
 128         if (inet_aton(hostname, &addr->sin_addr))
 129                 return 1;
 130         if ((hp = gethostbyname(hostname)) == NULL) {
 131                 nfs_error(_("%s: can't get address for %s\n"),
 132                                 progname, hostname);
 133                 return 0;
 134         }
 135         if (hp->h_length > sizeof(struct in_addr)) {
 136                 nfs_error(_("%s: got bad hp->h_length"), progname);
 137                 hp->h_length = sizeof(struct in_addr);
 138         }
 139         memcpy(&addr->sin_addr, hp->h_addr, hp->h_length);
 140         return 1;
 141 }
 142
 143 /*
 144  * Append the 'addr=' option to the options string to pass a resolved
 145  * server address to the kernel.  After a successful mount, this address
 146  * is also added to /etc/mtab for use when unmounting.
 147  *
 148  * If 'addr=' is already present, we strip it out.  This prevents users
 149  * from setting a bogus 'addr=' option themselves, and also allows bg
 150  * retries to recompute the server's address, in case it has changed.
 151  *
 152  * Returns 1 if 'addr=' option appended successfully;
 153  * otherwise zero.
 154  */
 155 static int append_addr_option(struct sockaddr_in *saddr,
 156                            struct mount_options *options)
 157 {
 158         char new_option[24];
 159
 160         po_remove_all(options, "addr");
 161
 162         snprintf(new_option, sizeof(new_option) - 1,
 163                         "addr=%s", inet_ntoa(saddr->sin_addr));
 164
 165         if (po_append(options, new_option) == PO_SUCCEEDED)
 166                 return 1;
 167         return 0;
 168 }
 169
 170 /*
 171  * Called to discover our address and append an appropriate 'clientaddr='
 172  * option to the options string.
 173  *
 174  * Returns 1 if 'clientaddr=' option created successfully or if
 175  * 'clientaddr=' option is already present; otherwise zero.
 176  */
 177 static int append_clientaddr_option(struct sockaddr_in *saddr,
 178                                     struct mount_options *options)
 179 {
 180         struct sockaddr_in my_addr;
 181         char new_option[32];
 182
 183         if (po_contains(options, "clientaddr") == PO_SUCCEEDED)
 184                 return 1;
 185
 186         if (!get_client_address(saddr, &my_addr))
 187                 return 0;
 188
 189         snprintf(new_option, sizeof(new_option) - 1,
 190                         "clientaddr=%s", inet_ntoa(my_addr.sin_addr));
 191
 192         if (po_append(options, new_option) == PO_SUCCEEDED)
 193                 return 1;
 194         return 0;
 195 }
 196
 197 /*
 198  * Resolve the 'mounthost=' hostname and append a new option using
 199  * the resulting IPv4 address.
 200  */
 201 static int fix_mounthost_option(struct mount_options *options)
 202 {
 203         struct sockaddr_in maddr;
 204         char *mounthost, new_option[32];
 205
 206         mounthost = po_get(options, "mounthost");
 207         if (!mounthost)
 208                 return 1;
 209
 210         if (!fill_ipv4_sockaddr(mounthost, &maddr))
 211                 return 0;
 212
 213         snprintf(new_option, sizeof(new_option) - 1,
 214                         "mountaddr=%s", inet_ntoa(maddr.sin_addr));
 215
 216         if (po_append(options, new_option) == PO_SUCCEEDED)
 217                 return 1;
 218         return 0;
 219 }
 220
 221 /*
 222  * Set up mandatory mount options.
 223  *
 224  * Returns 1 if successful; otherwise zero.
 225  */
 226 static int set_mandatory_options(const char *type,
 227                                  struct sockaddr_in *saddr,
 228                                  struct mount_options *options)
 229 {
 230         if (!append_addr_option(saddr, options))
 231                 return 0;
 232
 233         if (strncmp(type, "nfs4", 4) == 0) {
 234                 if (!append_clientaddr_option(saddr, options))
 235                         return 0;
 236         } else {
 237                 if (!fix_mounthost_option(options))
 238                         return 0;
 239         }
 240
 241         return 1;
 242 }
 243
 244 /*
 245  * Distinguish between permanent and temporary errors.
 246  *
 247  * Returns 0 if the passed-in error is temporary, thus the
 248  * mount system call should be retried; returns one if the
 249  * passed-in error is permanent, thus the mount system call
 250  * should not be retried.
 251  */
 252 static int is_permanent_error(int error)
 253 {
 254         switch (error) {
 255         case ESTALE:
 256         case ETIMEDOUT:
 257         case ECONNREFUSED:
 258                 return 0;       /* temporary */
 259         default:
 260                 return 1;       /* permanent */
 261         }
 262 }
 263
 264 /*
 265  * Reconstruct the mount option string based on a portmapper probe
 266  * of the server.  Returns one if the server's portmapper returned
 267  * something we can use, otherwise zero.
 268  *
 269  * To handle version and transport protocol fallback properly, we
 270  * need to parse some of the mount options in order to set up a
 271  * portmap probe.  Mount options that rewrite_mount_options()
 272  * doesn't recognize are left alone.
 273  *
 274  * Returns a new group of mount options if successful; otherwise
 275  * NULL is returned if some failure occurred.
 276  */
 277 static struct mount_options *rewrite_mount_options(char *str)
 278 {
 279         struct mount_options *options;
 280         char *option, new_option[64];
 281         clnt_addr_t mnt_server = { };
 282         clnt_addr_t nfs_server = { };
 283         int p;
 284
 285         options = po_split(str);
 286         if (!options)
 287                 return NULL;
 288
 289         option = po_get(options, "addr");
 290         if (option) {
 291                 nfs_server.saddr.sin_family = AF_INET;
 292                 if (!inet_aton((const char *)option, &nfs_server.saddr.sin_addr))
 293                         goto err;
 294         } else
 295                 goto err;
 296
 297         option = po_get(options, "mountaddr");
 298         if (option) {
 299                 mnt_server.saddr.sin_family = AF_INET;
 300                 if (!inet_aton((const char *)option, &mnt_server.saddr.sin_addr))
 301                         goto err;
 302         } else
 303                 memcpy(&mnt_server.saddr, &nfs_server.saddr,
 304                                 sizeof(mnt_server.saddr));
 305
 306         option = po_get(options, "mountport");
 307         if (option)
 308                 mnt_server.pmap.pm_port = atoi(option);
 309         mnt_server.pmap.pm_prog = MOUNTPROG;
 310         option = po_get(options, "mountvers");
 311         if (option)
 312                 mnt_server.pmap.pm_vers = atoi(option);
 313
 314         option = po_get(options, "port");
 315         if (option) {
 316                 nfs_server.pmap.pm_port = atoi(option);
 317                 po_remove_all(options, "port");
 318         }
 319         nfs_server.pmap.pm_prog = NFS_PROGRAM;
 320
 321         option = po_get(options, "nfsvers");
 322         if (option) {
 323                 nfs_server.pmap.pm_vers = atoi(option);
 324                 po_remove_all(options, "nfsvers");
 325         }
 326         option = po_get(options, "vers");
 327         if (option) {
 328                 nfs_server.pmap.pm_vers = atoi(option);
 329                 po_remove_all(options, "vers");
 330         }
 331         option = po_get(options, "proto");
 332         if (option) {
 333                 if (strcmp(option, "tcp") == 0) {
 334                         nfs_server.pmap.pm_prot = IPPROTO_TCP;
 335                         po_remove_all(options, "proto");
 336                 }
 337                 if (strcmp(option, "udp") == 0) {
 338                         nfs_server.pmap.pm_prot = IPPROTO_UDP;
 339                         po_remove_all(options, "proto");
 340                 }
 341         }
 342         p = po_rightmost(options, "tcp", "udp");
 343         switch (p) {
 344         case PO_KEY2_RIGHTMOST:
 345                 nfs_server.pmap.pm_prot = IPPROTO_UDP;
 346                 break;
 347         case PO_KEY1_RIGHTMOST:
 348                 nfs_server.pmap.pm_prot = IPPROTO_TCP;
 349                 break;
 350         }
 351         po_remove_all(options, "tcp");
 352         po_remove_all(options, "udp");
 353
 354         if (!probe_bothports(&mnt_server, &nfs_server)) {
 355                 rpc_mount_errors("rpcbind", 0, 0);
 356                 goto err;
 357         }
 358
 359         snprintf(new_option, sizeof(new_option) - 1,
 360                  "nfsvers=%lu", nfs_server.pmap.pm_vers);
 361         if (po_append(options, new_option) == PO_FAILED)
 362                 goto err;
 363
 364         if (nfs_server.pmap.pm_prot == IPPROTO_TCP)
 365                 snprintf(new_option, sizeof(new_option) - 1,
 366                          "proto=tcp");
 367         else
 368                 snprintf(new_option, sizeof(new_option) - 1,
 369                          "proto=udp");
 370         if (po_append(options, new_option) == PO_FAILED)
 371                 goto err;
 372
 373         if (nfs_server.pmap.pm_port != NFS_PORT) {
 374                 snprintf(new_option, sizeof(new_option) - 1,
 375                          "port=%lu", nfs_server.pmap.pm_port);
 376                 if (po_append(options, new_option) == PO_FAILED)
 377                         goto err;
 378
 379         }
 380
 381         return options;
 382
 383 err:
 384         po_destroy(options);
 385         return NULL;
 386 }
 387
 388 /*
 389  * Retry an NFS mount that failed because the requested service isn't
 390  * available on the server.
 391  *
 392  * Returns 1 if successful.  Otherwise, returns zero.
 393  * "errno" is set to reflect the individual error.
 394  *
 395  * Side effect: If the retry is successful, both 'options' and
 396  * 'extra_opts' are updated to reflect the mount options that worked.
 397  * If the retry fails, 'options' and 'extra_opts' are left unchanged.
 398  */
 399 static int retry_nfsmount(const char *spec, const char *node,
 400                         int flags, struct mount_options *options,
 401                         int fake, char **extra_opts)
 402 {
 403         struct mount_options *retry_options;
 404         char *retry_str = NULL;
 405
 406         retry_options = rewrite_mount_options(*extra_opts);
 407         if (!retry_options) {
 408                 errno = EIO;
 409                 return 0;
 410         }
 411
 412         if (po_join(retry_options, &retry_str) == PO_FAILED) {
 413                 po_destroy(retry_options);
 414                 errno = EIO;
 415                 return 0;
 416         }
 417
 418         if (verbose)
 419                 printf(_("%s: text-based options (retry): '%s'\n"),
 420                         progname, retry_str);
 421
 422         if (!mount(spec, node, "nfs",
 423                                 flags & ~(MS_USER|MS_USERS), retry_str)) {
 424                 free(*extra_opts);
 425                 *extra_opts = retry_str;
 426                 po_replace(options, retry_options);
 427                 return 1;
 428         }
 429
 430         po_destroy(retry_options);
 431         free(retry_str);
 432         return 0;
 433 }
 434
 435 /*
 436  * Attempt an NFSv2/3 mount via a mount(2) system call.  If the kernel
 437  * claims the requested service isn't supported on the server, probe
 438  * the server to see what's supported, rewrite the mount options,
 439  * and retry the request.
 440  *
 441  * Returns 1 if successful.  Otherwise, returns zero.
 442  * "errno" is set to reflect the individual error.
 443  *
 444  * Side effect: If the retry is successful, both 'options' and
 445  * 'extra_opts' are updated to reflect the mount options that worked.
 446  * If the retry fails, 'options' and 'extra_opts' are left unchanged.
 447  */
 448 static int try_nfs23mount(const char *spec, const char *node,
 449                           int flags, struct mount_options *options,
 450                           int fake, char **extra_opts)
 451 {
 452         if (po_join(options, extra_opts) == PO_FAILED) {
 453                 errno = EIO;
 454                 return 0;
 455         }
 456
 457         if (verbose)
 458                 printf(_("%s: text-based options: '%s'\n"),
 459                         progname, *extra_opts);
 460
 461         if (fake)
 462                 return 1;
 463
 464         if (!mount(spec, node, "nfs",
 465                                 flags & ~(MS_USER|MS_USERS), *extra_opts))
 466                 return 1;
 467
 468         /*
 469          * The kernel returns EOPNOTSUPP if the RPC bind failed,
 470          * and EPROTONOSUPPORT if the version isn't supported.
 471          */
 472         if (errno != EOPNOTSUPP && errno != EPROTONOSUPPORT)
 473                 return 0;
 474
 475         return retry_nfsmount(spec, node, flags, options, fake, extra_opts);
 476 }
 477
 478 /*
 479  * Attempt an NFS v4 mount via a mount(2) system call.
 480  *
 481  * Returns 1 if successful.  Otherwise, returns zero.
 482  * "errno" is set to reflect the individual error.
 483  */
 484 static int try_nfs4mount(const char *spec, const char *node,
 485                          int flags, struct mount_options *options,
 486                          int fake, char **extra_opts)
 487 {
 488         if (po_join(options, extra_opts) == PO_FAILED) {
 489                 errno = EIO;
 490                 return 0;
 491         }
 492
 493         if (verbose)
 494                 printf(_("%s: text-based options: '%s'\n"),
 495                         progname, *extra_opts);
 496
 497         if (fake)
 498                 return 1;
 499
 500         if (!mount(spec, node, "nfs4",
 501                                 flags & ~(MS_USER|MS_USERS), *extra_opts))
 502                 return 1;
 503         return 0;
 504 }
 505
 506 /*
 507  * Try the mount(2) system call.
 508  *
 509  * Returns 1 if successful.  Otherwise, returns zero.
 510  * "errno" is set to reflect the individual error.
 511  */
 512 static int try_mount(const char *spec, const char *node, const char *type,
 513                      int flags, struct mount_options *options, int fake,
 514                      char **extra_opts)
 515 {
 516         if (strncmp(type, "nfs4", 4) == 0)
 517                 return try_nfs4mount(spec, node, flags,
 518                                         options, fake, extra_opts);
 519         else
 520                 return try_nfs23mount(spec, node, flags,
 521                                         options, fake, extra_opts);
 522 }
 523
 524 /*
 525  * Handle "foreground" NFS mounts.
 526  *
 527  * Retry the mount request for as long as the 'retry=' option says.
 528  *
 529  * Returns a valid mount command exit code.
 530  */
 531 static int nfsmount_fg(const char *spec, const char *node,
 532                        const char *type, int flags,
 533                        struct mount_options *options, int fake,
 534                        char **extra_opts)
 535 {
 536         unsigned int secs = 1;
 537         time_t timeout = time(NULL);
 538         char *retry;
 539
 540         timeout += 60 * 2;              /* default: 2 minutes */
 541         retry = po_get(options, "retry");
 542         if (retry)
 543                 timeout += 60 * atoi(retry);
 544
 545         if (verbose)
 546                 printf(_("%s: timeout set for %s"),
 547                         progname, ctime(&timeout));
 548
 549         for (;;) {
 550                 if (try_mount(spec, node, type, flags,
 551                                         options, fake, extra_opts))
 552                         return EX_SUCCESS;
 553
 554                 if (is_permanent_error(errno))
 555                         break;
 556
 557                 if (time(NULL) > timeout) {
 558                         errno = ETIMEDOUT;
 559                         break;
 560                 }
 561
 562                 if (errno != ETIMEDOUT) {
 563                         if (sleep(secs))
 564                                 break;
 565                         secs <<= 1;
 566                         if (secs > 10)
 567                                 secs = 10;
 568                 }
 569         };
 570
 571         mount_error(spec, node, errno);
 572         return EX_FAIL;
 573 }
 574
 575 /*
 576  * Handle "background" NFS mount [first try]
 577  *
 578  * Returns a valid mount command exit code.
 579  *
 580  * EX_BG should cause the caller to fork and invoke nfsmount_child.
 581  */
 582 static int nfsmount_parent(const char *spec, const char *node,
 583                            const char *type, char *hostname, int flags,
 584                            struct mount_options *options,
 585                            int fake, char **extra_opts)
 586 {
 587         if (try_mount(spec, node, type, flags, options,
 588                                         fake, extra_opts))
 589                 return EX_SUCCESS;
 590
 591         if (is_permanent_error(errno)) {
 592                 mount_error(spec, node, errno);
 593                 return EX_FAIL;
 594         }
 595
 596         sys_mount_errors(hostname, errno, 1, 1);
 597         return EX_BG;
 598 }
 599
 600 /*
 601  * Handle "background" NFS mount [retry daemon]
 602  *
 603  * Returns a valid mount command exit code: EX_SUCCESS if successful,
 604  * EX_FAIL if a failure occurred.  There's nothing to catch the
 605  * error return, though, so we use sys_mount_errors to log the
 606  * failure.
 607  */
 608 static int nfsmount_child(const char *spec, const char *node,
 609                           const char *type, char *hostname, int flags,
 610                           struct mount_options *options,
 611                           int fake, char **extra_opts)
 612 {
 613         unsigned int secs = 1;
 614         time_t timeout = time(NULL);
 615         char *retry;
 616
 617         timeout += 60 * 10000;          /* default: 10,000 minutes */
 618         retry = po_get(options, "retry");
 619         if (retry)
 620                 timeout += 60 * atoi(retry);
 621
 622         for (;;) {
 623                 if (sleep(secs))
 624                         break;
 625                 secs <<= 1;
 626                 if (secs > 120)
 627                         secs = 120;
 628
 629                 if (try_mount(spec, node, type, flags, options,
 630                                                         fake, extra_opts))
 631                         return EX_SUCCESS;
 632
 633                 if (is_permanent_error(errno))
 634                         break;
 635
 636                 if (time(NULL) > timeout)
 637                         break;
 638
 639                 sys_mount_errors(hostname, errno, 1, 1);
 640         };
 641
 642         sys_mount_errors(hostname, errno, 1, 0);
 643         return EX_FAIL;
 644 }
 645
 646 /*
 647  * Handle "background" NFS mount
 648  *
 649  * Returns a valid mount command exit code.
 650  */
 651 static int nfsmount_bg(const char *spec, const char *node,
 652                           const char *type, char *hostname, int flags,
 653                           struct mount_options *options,
 654                           int fake, int child, char **extra_opts)
 655 {
 656         if (!child)
 657                 return nfsmount_parent(spec, node, type, hostname, flags,
 658                                         options, fake, extra_opts);
 659         else
 660                 return nfsmount_child(spec, node, type, hostname, flags,
 661                                         options, fake, extra_opts);
 662 }
 663
 664 /**
 665  * nfsmount_string - Mount an NFS file system using C string options
 666  * @spec: C string specifying remote share to mount ("hostname:path")
 667  * @node: C string pathname of local mounted-on directory
 668  * @type: C string that represents file system type ("nfs" or "nfs4")
 669  * @flags: MS_ style mount flags
 670  * @extra_opts: pointer to C string containing fs-specific mount options
 671  *              (input and output argument)
 672  * @fake: flag indicating whether to carry out the whole operation
 673  * @child: one if this is a mount daemon (bg)
 674  */
 675 int nfsmount_string(const char *spec, const char *node, const char *type,
 676                     int flags, char **extra_opts, int fake, int child)
 677 {
 678         struct mount_options *options = NULL;
 679         struct sockaddr_in saddr;
 680         char *hostname;
 681         int retval = EX_FAIL;
 682
 683         if (!parse_devname(spec, &hostname))
 684                 return retval;
 685         if (!fill_ipv4_sockaddr(hostname, &saddr))
 686                 goto fail;
 687
 688         options = po_split(*extra_opts);
 689         if (!options) {
 690                 nfs_error(_("%s: internal option parsing error"), progname);
 691                 goto fail;
 692         }
 693
 694         if (!set_mandatory_options(type, &saddr, options))
 695                 goto out;
 696
 697         if (po_rightmost(options, "bg", "fg") == PO_KEY1_RIGHTMOST)
 698                 retval = nfsmount_bg(spec, node, type, hostname, flags,
 699                                         options, fake, child, extra_opts);
 700         else
 701                 retval = nfsmount_fg(spec, node, type, flags, options,
 702                                                         fake, extra_opts);
 703
 704 out:
 705         po_destroy(options);
 706 fail:
 707         free(hostname);
 708         return retval;
 709 }