lustre/utils/mount_lustre.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2002 Cluster File Systems, Inc.
   5  *   Author: Robert Read <rread@clusterfs.com>
   6  *   Author: Nathan Rutman <nathan@clusterfs.com>
   7  *
   8  *   This file is part of Lustre, http://www.lustre.org.
   9  *
  10  *   Lustre is free software; you can redistribute it and/or
  11  *   modify it under the terms of version 2 of the GNU General Public
  12  *   License as published by the Free Software Foundation.
  13  *
  14  *   Lustre is distributed in the hope that it will be useful,
  15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *   GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *   along with Lustre; if not, write to the Free Software
  21  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  */
  24
  25
  26 #define _GNU_SOURCE
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <unistd.h>
  30 #include <fcntl.h>
  31 #include <errno.h>
  32 #include <string.h>
  33 #include <sys/mount.h>
  34 #include <mntent.h>
  35 #include <getopt.h>
  36 #include <sys/utsname.h>
  37 #include "obdctl.h"
  38 #include <lustre_ver.h>
  39 #include <glob.h>
  40 #include <ctype.h>
  41 #include <limits.h>
  42
  43 #define MAX_HW_SECTORS_KB_PATH  "queue/max_hw_sectors_kb"
  44 #define MAX_SECTORS_KB_PATH     "queue/max_sectors_kb"
  45
  46 int          verbose = 0;
  47 int          nomtab = 0;
  48 int          fake = 0;
  49 int          force = 0;
  50 static char *progname = NULL;
  51
  52 void usage(FILE *out)
  53 {
  54         fprintf(out, "%s v"LUSTRE_VERSION_STRING"\n", progname);
  55         fprintf(out, "\nThis mount helper should only be invoked via the "
  56                 "mount (8) command,\ne.g. mount -t lustre dev dir\n\n");
  57         fprintf(out, "usage: %s [-fhnv] [-o <mntopt>] <device> <mountpt>\n",
  58                 progname);
  59         fprintf(out,
  60                 "\t<device>: the disk device, or for a client:\n"
  61                 "\t\t<mgmtnid>[:<altmgtnid>...]:/<filesystem>-client\n"
  62                 "\t<filesystem>: name of the Lustre filesystem (e.g. lustre1)\n"
  63                 "\t<mountpt>: filesystem mountpoint (e.g. /mnt/lustre)\n"
  64                 "\t-f|--fake: fake mount (updates /etc/mtab)\n"
  65                 "\t--force: force mount even if already in /etc/mtab\n"
  66                 "\t-h|--help: print this usage message\n"
  67                 "\t-n|--nomtab: do not update /etc/mtab after mount\n"
  68                 "\t-v|--verbose: print verbose config settings\n"
  69                 "\t<mntopt>: one or more comma separated of:\n"
  70                 "\t\t(no)flock,(no)user_xattr,(no)acl\n"
  71                 "\t\tnosvc: only start MGC/MGS obds\n"
  72                 "\t\texclude=<ostname>[:<ostname>] : colon-separated list of "
  73                 "inactive OSTs (e.g. lustre-OST0001)\n"
  74                 );
  75         exit((out != stdout) ? EINVAL : 0);
  76 }
  77
  78 static int check_mtab_entry(char *spec, char *mtpt, char *type)
  79 {
  80         FILE *fp;
  81         struct mntent *mnt;
  82
  83         fp = setmntent(MOUNTED, "r");
  84         if (fp == NULL)
  85                 return(0);
  86
  87         while ((mnt = getmntent(fp)) != NULL) {
  88                 if (strcmp(mnt->mnt_fsname, spec) == 0 &&
  89                         strcmp(mnt->mnt_dir, mtpt) == 0 &&
  90                         strcmp(mnt->mnt_type, type) == 0) {
  91                         endmntent(fp);
  92                         return(EEXIST);
  93                 }
  94         }
  95         endmntent(fp);
  96
  97         return(0);
  98 }
  99
 100 static int
 101 update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
 102                   int flags, int freq, int pass)
 103 {
 104         FILE *fp;
 105         struct mntent mnt;
 106         int rc = 0;
 107
 108         mnt.mnt_fsname = spec;
 109         mnt.mnt_dir = mtpt;
 110         mnt.mnt_type = type;
 111         mnt.mnt_opts = opts ? opts : "";
 112         mnt.mnt_freq = freq;
 113         mnt.mnt_passno = pass;
 114
 115         fp = setmntent(MOUNTED, "a+");
 116         if (fp == NULL) {
 117                 fprintf(stderr, "%s: setmntent(%s): %s:",
 118                         progname, MOUNTED, strerror (errno));
 119                 rc = 16;
 120         } else {
 121                 if ((addmntent(fp, &mnt)) == 1) {
 122                         fprintf(stderr, "%s: addmntent: %s:",
 123                                 progname, strerror (errno));
 124                         rc = 16;
 125                 }
 126                 endmntent(fp);
 127         }
 128
 129         return rc;
 130 }
 131
 132 /* Get rid of symbolic hostnames for tcp, since kernel can't do lookups */
 133 #define MAXNIDSTR 1024
 134 static char *convert_hostnames(char *s1)
 135 {
 136         char *converted, *s2 = 0, *c;
 137         char sep;
 138         int left = MAXNIDSTR;
 139         lnet_nid_t nid;
 140
 141         converted = malloc(left);
 142         c = converted;
 143         while ((left > 0) && (*s1 != '/')) {
 144                 s2 = strpbrk(s1, ",:");
 145                 if (!s2)
 146                         goto out_free;
 147                 sep = *s2;
 148                 *s2 = '\0';
 149                 nid = libcfs_str2nid(s1);
 150                 *s2 = sep;                      /* back to original string */
 151                 if (nid == LNET_NID_ANY)
 152                         goto out_free;
 153                 c += snprintf(c, left, "%s%c", libcfs_nid2str(nid), sep);
 154                 left = converted + MAXNIDSTR - c;
 155                 s1 = s2 + 1;
 156         }
 157         snprintf(c, left, "%s", s1);
 158         return converted;
 159 out_free:
 160         fprintf(stderr, "%s: Can't parse NID '%s'\n", progname, s1);
 161         free(converted);
 162         return NULL;
 163 }
 164
 165 /*****************************************************************************
 166  *
 167  * This part was cribbed from util-linux/mount/mount.c.  There was no clear
 168  * license information, but many other files in the package are identified as
 169  * GNU GPL, so it's a pretty safe bet that was their intent.
 170  *
 171  ****************************************************************************/
 172 struct opt_map {
 173         const char *opt;        /* option name */
 174         int inv;                /* true if flag value should be inverted */
 175         int mask;               /* flag mask value */
 176 };
 177
 178 static const struct opt_map opt_map[] = {
 179   /*"optname", inv,ms_mask */
 180   /* These flags are parsed by mount, not lustre */
 181   { "defaults", 0, 0         },      /* default options */
 182   { "remount",  0, MS_REMOUNT},      /* remount with different options */
 183   { "rw",       1, MS_RDONLY },      /* read-write */
 184   { "ro",       0, MS_RDONLY },      /* read-only */
 185   { "exec",     1, MS_NOEXEC },      /* permit execution of binaries */
 186   { "noexec",   0, MS_NOEXEC },      /* don't execute binaries */
 187   { "suid",     1, MS_NOSUID },      /* honor suid executables */
 188   { "nosuid",   0, MS_NOSUID },      /* don't honor suid executables */
 189   { "dev",      1, MS_NODEV  },      /* interpret device files  */
 190   { "nodev",    0, MS_NODEV  },      /* don't interpret devices */
 191   { "sync",     0, MS_SYNCHRONOUS},  /* synchronous I/O */
 192   { "async",    1, MS_SYNCHRONOUS},  /* asynchronous I/O */
 193   { "atime",    1, MS_NOATIME  },    /* set file access time on read */
 194   { "noatime",  0, MS_NOATIME  },    /* do not set file access time on read */
 195 #ifdef MS_NODIRATIME
 196   { "diratime", 1, MS_NODIRATIME },  /* set file access time on read */
 197   { "nodiratime",0,MS_NODIRATIME },  /* do not set file access time on read */
 198 #endif
 199 #ifdef MS_RELATIME
 200   { "relatime", 0, MS_RELATIME },  /* set file access time on read */
 201   { "norelatime",1,MS_RELATIME },  /* do not set file access time on read */
 202 #endif
 203   { "auto",     0, 0         },      /* Can be mounted using -a */
 204   { "noauto",   0, 0         },      /* Can only be mounted explicitly */
 205   { "nousers",  1, 0         },      /* Forbid ordinary user to mount */
 206   { "nouser",   1, 0         },      /* Forbid ordinary user to mount */
 207   { "noowner",  1, 0         },      /* Device owner has no special privs */
 208   { "_netdev",  0, 0         },      /* Device accessible only via network */
 209   { "loop",     0, 0         },
 210   { NULL,       0, 0         }
 211 };
 212 /****************************************************************************/
 213
 214 /* 1  = don't pass on to lustre
 215    0  = pass on to lustre */
 216 static int parse_one_option(const char *check, int *flagp)
 217 {
 218         const struct opt_map *opt;
 219
 220         for (opt = &opt_map[0]; opt->opt != NULL; opt++) {
 221                 if (strncmp(check, opt->opt, strlen(opt->opt)) == 0) {
 222                         if (opt->mask) {
 223                                 if (opt->inv)
 224                                         *flagp &= ~(opt->mask);
 225                                 else
 226                                         *flagp |= opt->mask;
 227                         }
 228                         return 1;
 229                 }
 230         }
 231         /* Assume any unknown options are valid and pass them on.  The mount
 232            will fail if lmd_parse, ll_options or ldiskfs doesn't recognize it.*/
 233         return 0;
 234 }
 235
 236 /* Replace options with subset of Lustre-specific options, and
 237    fill in mount flags */
 238 int parse_options(char *orig_options, int *flagp)
 239 {
 240         char *options, *opt, *nextopt;
 241
 242         options = calloc(strlen(orig_options) + 1, 1);
 243         *flagp = 0;
 244         nextopt = orig_options;
 245         while ((opt = strsep(&nextopt, ","))) {
 246                 if (!*opt)
 247                         /* empty option */
 248                         continue;
 249                 if (parse_one_option(opt, flagp) == 0) {
 250                         /* pass this on as an option */
 251                         if (*options)
 252                                 strcat(options, ",");
 253                         strcat(options, opt);
 254                 }
 255         }
 256         strcpy(orig_options, options);
 257         free(options);
 258         return 0;
 259 }
 260
 261
 262 int read_file(char *path, char *buf, int size)
 263 {
 264         FILE *fd;
 265
 266         fd = fopen(path, "r");
 267         if (fd == NULL)
 268                 return errno;
 269
 270         fgets(buf, size, fd);
 271         fclose(fd);
 272         return 0;
 273 }
 274
 275 int write_file(char *path, char *buf)
 276 {
 277         FILE *fd;
 278
 279         fd = fopen(path, "w");
 280         if (fd == NULL)
 281                 return errno;
 282
 283         fputs(buf, fd);
 284         fclose(fd);
 285         return 0;
 286 }
 287
 288 /* This is to tune the kernel for good SCSI performance.
 289  * For that we set the value of /sys/block/{dev}/queue/max_sectors_kb
 290  * to the value of /sys/block/{dev}/queue/max_hw_sectors_kb */
 291 int set_tunables(char *source, int src_len)
 292 {
 293         glob_t glob_info;
 294         struct stat stat_buf;
 295         char *chk_major, *chk_minor;
 296         char *savept, *dev, *s2 = 0;
 297         char *ret_path;
 298         char buf[PATH_MAX] = {'\0'}, path[PATH_MAX] = {'\0'};
 299         char real_path[PATH_MAX] = {'\0'};
 300         int i, rc = 0;
 301         int major, minor;
 302
 303         if (!source)
 304                 return -EINVAL;
 305
 306         ret_path = realpath(source, real_path);
 307         if (ret_path == NULL) {
 308                 if (verbose)
 309                         fprintf(stderr, "warning: %s: cannot resolve: %s",
 310                                 source, strerror(errno));
 311                 return -EINVAL;
 312         }
 313
 314         src_len = sizeof(real_path);
 315
 316         if (strncmp(real_path, "/dev/loop", 9) == 0)
 317                 return 0;
 318
 319         if ((real_path[0] != '/') && ((s2 = strpbrk(real_path, ",:")) != NULL))
 320                 return 0;
 321
 322         dev = real_path + src_len - 1;
 323         while (dev > real_path && (*dev != '/')) {
 324                 if (isdigit(*dev))
 325                         *dev = 0;
 326                 dev--;
 327         }
 328         snprintf(path, sizeof(path), "/sys/block%s/%s", dev,
 329                  MAX_HW_SECTORS_KB_PATH);
 330         rc = read_file(path, buf, sizeof(buf));
 331         if (rc == 0 && (strlen(buf) - 1) > 0) {
 332                 snprintf(path, sizeof(path), "/sys/block%s/%s", dev,
 333                          MAX_SECTORS_KB_PATH);
 334                 rc = write_file(path, buf);
 335                 if (rc && verbose)
 336                         fprintf(stderr, "warning: opening %s: %s\n",
 337                                 path, strerror(errno));
 338                 return rc;
 339         }
 340
 341         if (rc != ENOENT)
 342                 return rc;
 343
 344         /* The name of the device say 'X' specified in /dev/X may not
 345          * match any entry under /sys/block/. In that case we need to
 346          * match the major/minor number to find the entry under
 347          * sys/block corresponding to /dev/X */
 348         dev = real_path + src_len - 1;
 349         while (dev > real_path) {
 350                 if (isdigit(*dev))
 351                         *dev = 0;
 352                 dev--;
 353         }
 354
 355         rc = stat(dev, &stat_buf);
 356         if (rc) {
 357                 if (verbose)
 358                         fprintf(stderr, "warning: %s, device %s stat failed\n",
 359                                 strerror(errno), dev);
 360                 return rc;
 361         }
 362
 363         major = major(stat_buf.st_rdev);
 364         minor = minor(stat_buf.st_rdev);
 365         rc = glob("/sys/block/*", GLOB_NOSORT, NULL, &glob_info);
 366         if (rc) {
 367                 if (verbose)
 368                         fprintf(stderr, "warning: failed to read entries under "
 369                                 "/sys/block\n");
 370                 return rc;
 371         }
 372
 373         for (i = 0; i < glob_info.gl_pathc; i++){
 374                 snprintf(path, sizeof(path), "%s/dev", glob_info.gl_pathv[i]);
 375
 376                 rc = read_file(path, buf, sizeof(buf));
 377                 if (rc)
 378                         continue;
 379
 380                 if (buf[strlen(buf) - 1] == '\n')
 381                         buf[strlen(buf) - 1] = '\0';
 382
 383                 chk_major = strtok_r(buf, ":", &savept);
 384                 chk_minor = savept;
 385                 if (major == atoi(chk_major) &&minor == atoi(chk_minor))
 386                         break;
 387         }
 388
 389         if (i == glob_info.gl_pathc) {
 390                 if (verbose)
 391                         fprintf(stderr,"warning: device %s does not match any "
 392                                 "entry under /sys/block\n", real_path);
 393                 rc = -EINVAL;
 394                 goto out;
 395         }
 396
 397         snprintf(path, sizeof(path), "%s/%s", glob_info.gl_pathv[i],
 398                  MAX_HW_SECTORS_KB_PATH);
 399         rc = read_file(path, buf, sizeof(buf));
 400         if (rc) {
 401                 if (verbose)
 402                         fprintf(stderr, "warning: opening %s: %s\n",
 403                                 path, strerror(errno));
 404                 goto out;
 405         }
 406
 407         if (strlen(buf) - 1 > 0) {
 408                 snprintf(path, sizeof(path), "%s/%s",
 409                          glob_info.gl_pathv[i], MAX_SECTORS_KB_PATH);
 410                 rc = write_file(path, buf);
 411                 if (rc && verbose)
 412                         fprintf(stderr, "warning: writing to %s: %s\n",
 413                                 path, strerror(errno));
 414         }
 415
 416 out:
 417         globfree(&glob_info);
 418         return rc;
 419 }
 420
 421 int main(int argc, char *const argv[])
 422 {
 423         char default_options[] = "";
 424         char *usource, *source, *target, *ptr;
 425         char *options, *optcopy, *orig_options = default_options;
 426         int i, nargs = 3, opt, rc, flags, optlen;
 427         static struct option long_opt[] = {
 428                 {"fake", 0, 0, 'f'},
 429                 {"force", 0, 0, 1},
 430                 {"help", 0, 0, 'h'},
 431                 {"nomtab", 0, 0, 'n'},
 432                 {"options", 1, 0, 'o'},
 433                 {"verbose", 0, 0, 'v'},
 434                 {0, 0, 0, 0}
 435         };
 436
 437         progname = strrchr(argv[0], '/');
 438         progname = progname ? progname + 1 : argv[0];
 439
 440         while ((opt = getopt_long(argc, argv, "fhno:v",
 441                                   long_opt, NULL)) != EOF){
 442                 switch (opt) {
 443                 case 1:
 444                         ++force;
 445                         printf("force: %d\n", force);
 446                         nargs++;
 447                         break;
 448                 case 'f':
 449                         ++fake;
 450                         printf("fake: %d\n", fake);
 451                         nargs++;
 452                         break;
 453                 case 'h':
 454                         usage(stdout);
 455                         break;
 456                 case 'n':
 457                         ++nomtab;
 458                         printf("nomtab: %d\n", nomtab);
 459                         nargs++;
 460                         break;
 461                 case 'o':
 462                         orig_options = optarg;
 463                         nargs++;
 464                         break;
 465                 case 'v':
 466                         ++verbose;
 467                         nargs++;
 468                         break;
 469                 default:
 470                         fprintf(stderr, "%s: unknown option '%c'\n",
 471                                 progname, opt);
 472                         usage(stderr);
 473                         break;
 474                 }
 475         }
 476
 477         if (optind + 2 > argc) {
 478                 fprintf(stderr, "%s: too few arguments\n", progname);
 479                 usage(stderr);
 480         }
 481
 482         usource = argv[optind];
 483         source = convert_hostnames(usource);
 484         target = argv[optind + 1];
 485         ptr = target + strlen(target) - 1;
 486         while ((ptr > target) && (*ptr == '/')) {
 487                 *ptr = 0;
 488                 ptr--;
 489         }
 490
 491         if (!usource || !source) {
 492                 usage(stderr);
 493         }
 494
 495         if (verbose) {
 496                 for (i = 0; i < argc; i++)
 497                         printf("arg[%d] = %s\n", i, argv[i]);
 498                 printf("source = %s (%s), target = %s\n", usource, source, target);
 499                 printf("options = %s\n", orig_options);
 500         }
 501
 502         options = malloc(strlen(orig_options) + 1);
 503         strcpy(options, orig_options);
 504         rc = parse_options(options, &flags);
 505         if (rc) {
 506                 fprintf(stderr, "%s: can't parse options: %s\n",
 507                         progname, options);
 508                 return(EINVAL);
 509         }
 510
 511         if (!force) {
 512                 rc = check_mtab_entry(usource, target, "lustre");
 513                 if (rc && !(flags & MS_REMOUNT)) {
 514                         fprintf(stderr, "%s: according to %s %s is "
 515                                 "already mounted on %s\n",
 516                                 progname, MOUNTED, usource, target);
 517                         return(EEXIST);
 518                 }
 519                 if (!rc && (flags & MS_REMOUNT)) {
 520                         fprintf(stderr, "%s: according to %s %s is "
 521                                 "not already mounted on %s\n",
 522                                 progname, MOUNTED, usource, target);
 523                         return(ENOENT);
 524                 }
 525         }
 526         if (flags & MS_REMOUNT)
 527                 nomtab++;
 528
 529         rc = access(target, F_OK);
 530         if (rc) {
 531                 rc = errno;
 532                 fprintf(stderr, "%s: %s inaccessible: %s\n", progname, target,
 533                         strerror(errno));
 534                 return rc;
 535         }
 536
 537         /* In Linux 2.4, the target device doesn't get passed to any of our
 538            functions.  So we'll stick it on the end of the options. */
 539         optlen = strlen(options) + strlen(",device=") + strlen(source) + 1;
 540         optcopy = malloc(optlen);
 541         strcpy(optcopy, options);
 542         if (*optcopy)
 543                 strcat(optcopy, ",");
 544         strcat(optcopy, "device=");
 545         strcat(optcopy, source);
 546
 547         if (verbose)
 548                 printf("mounting device %s at %s, flags=%#x options=%s\n",
 549                        source, target, flags, optcopy);
 550
 551         if (set_tunables(source, strlen(source)) && verbose)
 552                 fprintf(stderr, "%s: unable to set tunables for %s"
 553                                 " (may cause reduced IO performance)",
 554                                 argv[0], source);
 555
 556         if (!fake)
 557                 /* flags and target get to lustre_get_sb, but not
 558                    lustre_fill_super.  Lustre ignores the flags, but mount
 559                    does not. */
 560                 rc = mount(source, target, "lustre", flags, (void *)optcopy);
 561
 562         if (rc) {
 563                 char *cli;
 564
 565                 rc = errno;
 566
 567                 cli = strrchr(usource, ':');
 568                 if (cli && (strlen(cli) > 2))
 569                         cli += 2;
 570                 else
 571                         cli = NULL;
 572
 573                 fprintf(stderr, "%s: mount %s at %s failed: %s\n", progname,
 574                         usource, target, strerror(errno));
 575                 if (errno == ENODEV)
 576                         fprintf(stderr, "Are the lustre modules loaded?\n"
 577                                 "Check /etc/modprobe.conf and /proc/filesystems"
 578                                 "\nNote 'alias lustre llite' should be removed"
 579                                 " from modprobe.conf\n");
 580                 if (errno == ENOTBLK)
 581                         fprintf(stderr, "Do you need -o loop?\n");
 582                 if (errno == ENOMEDIUM)
 583                         fprintf(stderr,
 584                                 "This filesystem needs at least 1 OST\n");
 585                 if (errno == ENOENT) {
 586                         fprintf(stderr, "Is the MGS specification correct?\n");
 587                         fprintf(stderr, "Is the filesystem name correct?\n");
 588                         fprintf(stderr, "If upgrading, is the copied client log"
 589                                 " valid? (see upgrade docs)\n");
 590                 }
 591                 if (errno == EALREADY)
 592                         fprintf(stderr, "The target service is already running."
 593                                 " (%s)\n", usource);
 594                 if (errno == ENXIO)
 595                         fprintf(stderr, "The target service failed to start "
 596                                 "(bad config log?) (%s).  "
 597                                 "See /var/log/messages.\n", usource);
 598                 if (errno == EIO)
 599                         fprintf(stderr, "Is the MGS running?\n");
 600                 if (errno == EADDRINUSE)
 601                         fprintf(stderr, "The target service's index is already "
 602                                 "in use. (%s)\n", usource);
 603                 if (errno == EINVAL) {
 604                         fprintf(stderr, "This may have multiple causes.\n");
 605                         if (cli)
 606                                 fprintf(stderr, "Is '%s' the correct filesystem"
 607                                         " name?\n", cli);
 608                         fprintf(stderr, "Are the mount options correct?\n");
 609                         fprintf(stderr, "Check the syslog for more info.\n");
 610                 }
 611
 612                 /* May as well try to clean up loop devs */
 613                 if (strncmp(usource, "/dev/loop", 9) == 0) {
 614                         char cmd[256];
 615                         sprintf(cmd, "/sbin/losetup -d %s", usource);
 616                         system(cmd);
 617                 }
 618
 619         } else if (!nomtab) {
 620                 rc = update_mtab_entry(usource, target, "lustre", orig_options,
 621                                        0,0,0);
 622         }
 623
 624         free(optcopy);
 625         free(source);
 626         return rc;
 627 }