4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/utils/mount_lustre.c
38 * Author: Robert Read <rread@clusterfs.com>
39 * Author: Nathan Rutman <nathan@clusterfs.com>
45 #include "mount_utils.h"
53 #include <lustre_ver.h>
56 #include <lustre/lustre_idl.h>
57 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 10, 53, 0)
60 * We only #include a kernel level include file here because
61 * important MS_ flag #defines are missing from the SLES version
63 * In the future if SLES updates sys/mount.h to have a more complete
64 * set of flag #defines we should stop including linux/fs.h
66 #if !defined(MS_RDONLY)
72 #define MAX_RETRIES 99
80 fprintf(out, "\nThis mount helper should only be invoked via the "
81 "mount (8) command,\ne.g. mount -t lustre dev dir\n\n");
82 fprintf(out, "usage: %s [-fhnvV] [-o <mntopt>] <device> <mountpt>\n",
85 "\t<device>: the disk device, or for a client:\n"
86 "\t\t<mgmtnid>[:<altmgtnid>...]:/<filesystem>-client\n"
87 "\t<filesystem>: name of the Lustre filesystem (e.g. lustre1)\n"
88 "\t<mountpt>: filesystem mountpoint (e.g. /mnt/lustre)\n"
89 "\t-f|--fake: fake mount (updates /etc/mtab)\n"
90 "\t-o force|--force: force mount even if already in /etc/mtab\n"
91 "\t-h|--help: print this usage message\n"
92 "\t-n|--nomtab: do not update /etc/mtab after mount\n"
93 "\t-v|--verbose: print verbose config settings\n"
94 "\t-V|--version: output build version of the utility and exit\n"
95 "\t<mntopt>: one or more comma separated of:\n"
96 "\t\t(no)flock,(no)user_xattr,(no)acl\n"
97 "\t\tabort_recov: abort server recovery handling\n"
98 "\t\tnosvc: only start MGC/MGS obds\n"
99 "\t\tnomgs: only start target obds, using existing MGS\n"
100 "\t\texclude=<ostname>[:<ostname>] : colon-separated list of "
101 "inactive OSTs (e.g. lustre-OST0001)\n"
102 "\t\tretry=<num>: number of times mount is retried by client\n"
103 "\t\tmd_stripe_cache_size=<num>: set the raid stripe cache "
104 "size for the underlying raid if present\n");
105 exit((out != stdout) ? EINVAL : 0);
108 /* Get rid of symbolic hostnames for tcp, since kernel can't do lookups */
109 #define MAXNIDSTR 1024
110 static char *convert_hostnames(char *s1)
112 char *converted, *s2 = 0, *c;
114 int left = MAXNIDSTR;
117 converted = malloc(left);
118 if (converted == NULL) {
119 fprintf(stderr, "out of memory: needed %d bytes\n",
124 while ((left > 0) && (*s1 != '/')) {
125 s2 = strpbrk(s1, ",:");
130 nid = libcfs_str2nid(s1);
131 *s2 = sep; /* back to original string */
132 if (nid == LNET_NID_ANY)
134 c += snprintf(c, left, "%s%c", libcfs_nid2str(nid), sep);
135 left = converted + MAXNIDSTR - c;
138 snprintf(c, left, "%s", s1);
141 fprintf(stderr, "%s: Can't parse NID '%s'\n", progname, s1);
146 /*****************************************************************************
148 * This part was cribbed from util-linux/mount/mount.c. There was no clear
149 * license information, but many other files in the package are identified as
150 * GNU GPL, so it's a pretty safe bet that was their intent.
152 ****************************************************************************/
154 const char *opt; /* option name */
155 int inv; /* true if flag value should be inverted */
156 int mask; /* flag mask value */
159 static const struct opt_map opt_map[] = {
160 /*"optname", inv,ms_mask */
161 /* These flags are parsed by mount, not lustre */
162 { "defaults", 0, 0 }, /* default options */
163 { "remount", 0, MS_REMOUNT}, /* remount with different options */
164 { "rw", 1, MS_RDONLY }, /* read-write */
165 { "ro", 0, MS_RDONLY }, /* read-only */
166 { "exec", 1, MS_NOEXEC }, /* permit execution of binaries */
167 { "noexec", 0, MS_NOEXEC }, /* don't execute binaries */
168 { "suid", 1, MS_NOSUID }, /* honor suid executables */
169 { "nosuid", 0, MS_NOSUID }, /* don't honor suid executables */
170 { "dev", 1, MS_NODEV }, /* interpret device files */
171 { "nodev", 0, MS_NODEV }, /* don't interpret devices */
172 { "sync", 0, MS_SYNCHRONOUS}, /* synchronous I/O */
173 { "async", 1, MS_SYNCHRONOUS}, /* asynchronous I/O */
174 { "atime", 1, MS_NOATIME }, /* set file access time on read */
175 { "noatime", 0, MS_NOATIME }, /* do not set file access time on read */
177 { "diratime", 1, MS_NODIRATIME }, /* set file access time on read */
178 { "nodiratime",0,MS_NODIRATIME }, /* do not set file access time on read */
181 { "relatime", 0, MS_RELATIME }, /* set file access time on read */
182 { "norelatime",1,MS_RELATIME }, /* do not set file access time on read */
184 #ifdef MS_STRICTATIME
185 { "strictatime",0,MS_STRICTATIME }, /* update access time strictly */
187 { "auto", 0, 0 }, /* Can be mounted using -a */
188 { "noauto", 0, 0 }, /* Can only be mounted explicitly */
189 { "nousers", 1, 0 }, /* Forbid ordinary user to mount */
190 { "nouser", 1, 0 }, /* Forbid ordinary user to mount */
191 { "noowner", 1, 0 }, /* Device owner has no special privs */
192 { "_netdev", 0, 0 }, /* Device accessible only via network */
196 /****************************************************************************/
198 /* 1 = don't pass on to lustre
199 0 = pass on to lustre */
200 static int parse_one_option(const char *check, int *flagp)
202 const struct opt_map *opt;
204 for (opt = &opt_map[0]; opt->opt != NULL; opt++) {
205 if (strncmp(check, opt->opt, strlen(opt->opt)) == 0) {
208 *flagp &= ~(opt->mask);
215 /* Assume any unknown options are valid and pass them on. The mount
216 will fail if lmd_parse, ll_options or ldiskfs doesn't recognize it.*/
220 static void append_option(char *options, const char *one)
223 strcat(options, ",");
224 strcat(options, one);
227 /* Replace options with subset of Lustre-specific options, and
228 fill in mount flags */
229 int parse_options(struct mount_opts *mop, char *orig_options, int *flagp)
231 char *options, *opt, *nextopt, *arg, *val;
233 options = calloc(strlen(orig_options) + 1, 1);
235 nextopt = orig_options;
236 while ((opt = strsep(&nextopt, ","))) {
241 /* Handle retries in a slightly different
244 val = strchr(opt, '=');
245 /* please note that some ldiskfs mount options are also in the form
246 * of param=value. We should pay attention not to remove those
247 * mount options, see bug 22097. */
248 if (val && strncmp(arg, "md_stripe_cache_size", 20) == 0) {
249 mop->mo_md_stripe_cache_size = atoi(val + 1);
250 } else if (val && strncmp(arg, "retry", 5) == 0) {
251 mop->mo_retry = atoi(val + 1);
252 if (mop->mo_retry > MAX_RETRIES)
253 mop->mo_retry = MAX_RETRIES;
254 else if (mop->mo_retry < 0)
256 } else if (val && strncmp(arg, "mgssec", 6) == 0) {
257 append_option(options, opt);
258 } else if (strncmp(arg, "nosvc", 5) == 0) {
260 append_option(options, opt);
261 } else if (strcmp(opt, "force") == 0) {
262 /* XXX special check for 'force' option */
264 printf("force: %d\n", mop->mo_force);
265 } else if (parse_one_option(opt, flagp) == 0) {
266 /* pass this on as an option */
267 append_option(options, opt);
270 #ifdef MS_STRICTATIME
271 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(3, 2, 53, 0)
274 * In the future when upstream fixes land in all supported kernels
275 * we should stop forcing MS_STRICTATIME in lustre mounts.
276 * We override the kernel level default of MS_RELATIME for now
277 * due to a kernel vfs level bug in atime updates that fails
278 * to reset timestamps from the future.
280 #warn "remove MS_STRICTATIME override if kernel updates atime from the future"
282 /* set strictatime to default if NOATIME or RELATIME
283 not given explicit */
284 if (!(*flagp & (MS_NOATIME | MS_RELATIME)))
285 *flagp |= MS_STRICTATIME;
287 strcpy(orig_options, options);
293 /* Add mgsnids from ldd params */
294 static int add_mgsnids(struct mount_opts *mop, char *options,
297 char *ptr = (char *)params;
300 while ((ptr = strstr(ptr, PARAM_MGSNODE)) != NULL) {
301 sep = strchr(ptr, ' ');
306 append_option(options, ptr);
307 mop->mo_have_mgsnid++;
319 static int clear_update_ondisk(char *source, struct lustre_disk_data *ldd)
321 char always_mountopts[512] = "";
322 char default_mountopts[512] = "";
323 struct mkfs_opts mkop;
327 memset(&mkop, 0, sizeof(mkop));
329 mkop.mo_ldd.ldd_flags &= ~LDD_F_UPDATE;
330 if (strlen(source) > sizeof(mkop.mo_device)-1) {
332 fprintf(stderr, "Device name too long: %s\n", source);
335 strncpy(mkop.mo_device, source, sizeof(mkop.mo_device));
337 ret = osd_prepare_lustre(&mkop,
338 default_mountopts, sizeof(default_mountopts),
339 always_mountopts, sizeof(always_mountopts));
342 fprintf(stderr, "Can't prepare device %s: %s\n",
343 source, strerror(ret));
347 /* Create the loopback file */
348 if (mkop.mo_flags & MO_IS_LOOP) {
349 ret = access(mkop.mo_device, F_OK);
353 fprintf(stderr, "Can't access device %s: %s\n",
354 source, strerror(ret));
358 ret = loop_setup(&mkop);
361 fprintf(stderr, "Loop device setup for %s failed: %s\n",
362 mkop.mo_device, strerror(ret));
366 ret = osd_write_ldd(&mkop);
369 fprintf(stderr, "failed to write local files: %s\n",
373 ret2 = loop_cleanup(&mkop);
380 static int parse_ldd(char *source, struct mount_opts *mop, char *options)
382 struct lustre_disk_data *ldd = &mop->mo_ldd;
386 rc = osd_is_lustre(source, &ldd->ldd_mount_type);
388 fprintf(stderr, "%s: %s has not been formatted with mkfs.lustre"
389 " or the backend filesystem type is not supported by "
390 "this tool\n", progname, source);
394 rc = osd_read_ldd(source, ldd);
396 fprintf(stderr, "%s: %s failed to read permanent mount"
397 " data: %s\n", progname, source,
398 rc >= 0 ? strerror(rc) : "");
402 if ((IS_MDT(ldd) || IS_OST(ldd)) &&
403 (ldd->ldd_flags & LDD_F_NEED_INDEX)) {
404 fprintf(stderr, "%s: %s has no index assigned "
405 "(probably formatted with old mkfs)\n",
410 if (ldd->ldd_flags & LDD_F_UPGRADE14) {
411 fprintf(stderr, "%s: we cannot upgrade %s from this (very old) "
412 "Lustre version\n", progname, source);
416 if (ldd->ldd_flags & LDD_F_UPDATE)
417 clear_update_ondisk(source, ldd);
419 /* Since we never rewrite ldd, ignore temp flags */
420 ldd->ldd_flags &= ~(LDD_F_VIRGIN | LDD_F_WRITECONF);
422 /* svname of the form lustre:OST1234 means never registered */
423 rc = strlen(ldd->ldd_svname);
424 if (ldd->ldd_svname[rc - 8] == ':') {
425 ldd->ldd_svname[rc - 8] = '-';
426 ldd->ldd_flags |= LDD_F_VIRGIN;
427 } else if (ldd->ldd_svname[rc - 8] == '=') {
428 ldd->ldd_svname[rc - 8] = '-';
429 ldd->ldd_flags |= LDD_F_WRITECONF;
432 /* backend osd type */
433 append_option(options, "osd=");
434 strcat(options, mt_type(ldd->ldd_mount_type));
436 append_option(options, ldd->ldd_mount_opts);
438 if (!mop->mo_have_mgsnid) {
439 /* Only use disk data if mount -o mgsnode=nid wasn't
441 if (ldd->ldd_flags & LDD_F_SV_TYPE_MGS) {
442 append_option(options, "mgs");
443 mop->mo_have_mgsnid++;
445 add_mgsnids(mop, options, ldd->ldd_params);
448 /* Better have an mgsnid by now */
449 if (!mop->mo_have_mgsnid) {
450 fprintf(stderr, "%s: missing option mgsnode=<nid>\n",
455 if (ldd->ldd_flags & LDD_F_VIRGIN)
456 append_option(options, "virgin");
457 if (ldd->ldd_flags & LDD_F_UPDATE)
458 append_option(options, "update");
459 if (ldd->ldd_flags & LDD_F_WRITECONF)
460 append_option(options, "writeconf");
461 if (ldd->ldd_flags & LDD_F_NO_PRIMNODE)
462 append_option(options, "noprimnode");
464 /* prefix every lustre parameter with param= so that in-kernel
465 * mount can recognize them properly and send to MGS at registration */
466 start = ldd->ldd_params;
467 while (start && *start != '\0') {
468 while (*start == ' ') start++;
472 start = strchr(cur, ' ');
477 append_option(options, "param=");
478 strcat(options, cur);
481 /* svname must be last option */
482 append_option(options, "svname=");
483 strcat(options, ldd->ldd_svname);
488 static void set_defaults(struct mount_opts *mop)
490 memset(mop, 0, sizeof(*mop));
491 mop->mo_usource = NULL;
492 mop->mo_source = NULL;
497 mop->mo_have_mgsnid = 0;
498 mop->mo_md_stripe_cache_size = 16384;
499 mop->mo_orig_options = "";
503 static int parse_opts(int argc, char *const argv[], struct mount_opts *mop)
505 static struct option long_opt[] = {
509 {"nomtab", 0, 0, 'n'},
510 {"options", 1, 0, 'o'},
511 {"verbose", 0, 0, 'v'},
512 {"version", 0, 0, 'V'},
515 char real_path[PATH_MAX] = {'\0'};
517 char path[256], name[256];
522 while ((opt = getopt_long(argc, argv, "fhno:vV",
523 long_opt, NULL)) != EOF){
527 printf("force: %d\n", mop->mo_force);
531 printf("fake: %d\n", mop->mo_fake);
538 printf("nomtab: %d\n", mop->mo_nomtab);
541 mop->mo_orig_options = optarg;
548 fprintf(stdout, "%s %s\n", progname,
549 LUSTRE_VERSION_STRING);
552 fprintf(stderr, "%s: unknown option '%c'\n",
559 if (optind + 2 > argc) {
560 fprintf(stderr, "%s: too few arguments\n", progname);
564 mop->mo_usource = argv[optind];
565 if (!mop->mo_usource) {
570 * Try to get the real path to the device, in case it is a
571 * symbolic link for instance
573 if (realpath(mop->mo_usource, real_path) != NULL) {
574 ptr = strrchr(real_path, '/');
575 if (ptr && strncmp(ptr, "/dm-", 4) == 0 && isdigit(*(ptr + 4))) {
576 snprintf(path, sizeof(path), "/sys/block/%s/dm/name", ptr+1);
577 if ((f = fopen(path, "r"))) {
578 /* read "<name>\n" from sysfs */
579 if (fgets(name, sizeof(name), f) && (sz = strlen(name)) > 1) {
581 snprintf(real_path, sizeof(real_path), "/dev/mapper/%s", name);
586 mop->mo_usource = strdup(real_path);
589 ptr = strstr(mop->mo_usource, ":/");
591 mop->mo_source = convert_hostnames(mop->mo_usource);
595 mop->mo_source = strdup(mop->mo_usource);
598 if (realpath(argv[optind + 1], mop->mo_target) == NULL) {
600 fprintf(stderr, "warning: %s: cannot resolve: %s\n",
601 argv[optind + 1], strerror(errno));
608 int main(int argc, char *const argv[])
610 struct mount_opts mop;
614 progname = strrchr(argv[0], '/');
615 progname = progname ? progname + 1 : argv[0];
623 rc = parse_opts(argc, argv, &mop);
628 for (i = 0; i < argc; i++)
629 printf("arg[%d] = %s\n", i, argv[i]);
630 printf("source = %s (%s), target = %s\n", mop.mo_usource,
631 mop.mo_source, mop.mo_target);
632 printf("options = %s\n", mop.mo_orig_options);
635 options = malloc(MAXOPT);
636 if (options == NULL) {
637 fprintf(stderr, "can't allocate memory for options\n");
640 strcpy(options, mop.mo_orig_options);
641 rc = parse_options(&mop, options, &flags);
643 fprintf(stderr, "%s: can't parse options: %s\n",
649 rc = check_mtab_entry(mop.mo_usource, mop.mo_source,
650 mop.mo_target, "lustre");
651 if (rc && !(flags & MS_REMOUNT)) {
652 fprintf(stderr, "%s: according to %s %s is "
653 "already mounted on %s\n", progname, MOUNTED,
654 mop.mo_usource, mop.mo_target);
657 if (!rc && (flags & MS_REMOUNT)) {
658 fprintf(stderr, "%s: according to %s %s is "
659 "not already mounted on %s\n", progname, MOUNTED,
660 mop.mo_usource, mop.mo_target);
664 if (flags & MS_REMOUNT)
667 rc = access(mop.mo_target, F_OK);
670 fprintf(stderr, "%s: %s inaccessible: %s\n", progname,
671 mop.mo_target, strerror(errno));
675 if (!strstr(mop.mo_usource, ":/")) {
676 rc = parse_ldd(mop.mo_source, &mop, options);
681 /* In Linux 2.4, the target device doesn't get passed to any of our
682 functions. So we'll stick it on the end of the options. */
683 append_option(options, "device=");
684 strcat(options, mop.mo_source);
687 printf("mounting device %s at %s, flags=%#x options=%s\n",
688 mop.mo_source, mop.mo_target, flags, options);
690 if (!strstr(mop.mo_usource, ":/") &&
691 osd_tune_lustre(mop.mo_source, &mop)) {
693 fprintf(stderr, "%s: unable to set tunables for %s"
694 " (may cause reduced IO performance)\n",
695 argv[0], mop.mo_source);
699 /* flags and target get to lustre_get_sb, but not
700 lustre_fill_super. Lustre ignores the flags, but mount
702 for (i = 0, rc = -EAGAIN; i <= mop.mo_retry && rc != 0; i++) {
703 rc = mount(mop.mo_source, mop.mo_target, "lustre",
704 flags, (void *)options);
706 /* change label from <fsname>:<index> to
707 * <fsname>-<index> to indicate the device has
708 * been registered. only if the label is
709 * supposed to be changed and target service
710 * is supposed to start */
711 if (mop.mo_ldd.ldd_flags &
712 (LDD_F_VIRGIN | LDD_F_WRITECONF)) {
713 if (mop.mo_nosvc == 0)
714 (void)osd_label_lustre(&mop);
718 fprintf(stderr, "%s: mount %s at %s "
719 "failed: %s retries left: "
720 "%d\n", basename(progname),
721 mop.mo_usource, mop.mo_target,
727 sleep(1 << max((i/2), 5));
741 cli = strrchr(mop.mo_usource, ':');
742 if (cli && (strlen(cli) > 2))
747 fprintf(stderr, "%s: mount %s at %s failed: %s\n", progname,
748 mop.mo_usource, mop.mo_target, strerror(errno));
750 fprintf(stderr, "Is the backend filesystem mounted?\n"
751 "Check /etc/mtab and /proc/mounts\n");
753 fprintf(stderr, "Are the lustre modules loaded?\n"
754 "Check /etc/modprobe.conf and "
755 "/proc/filesystems\n");
756 if (errno == ENOTBLK)
757 fprintf(stderr, "Do you need -o loop?\n");
758 if (errno == ENOMEDIUM)
760 "This filesystem needs at least 1 OST\n");
761 if (errno == ENOENT) {
762 fprintf(stderr, "Is the MGS specification correct?\n");
763 fprintf(stderr, "Is the filesystem name correct?\n");
764 fprintf(stderr, "If upgrading, is the copied client log"
765 " valid? (see upgrade docs)\n");
767 if (errno == EALREADY)
768 fprintf(stderr, "The target service is already running."
769 " (%s)\n", mop.mo_usource);
771 fprintf(stderr, "The target service failed to start "
772 "(bad config log?) (%s). "
773 "See /var/log/messages.\n", mop.mo_usource);
775 fprintf(stderr, "Is the MGS running?\n");
776 if (errno == EADDRINUSE)
777 fprintf(stderr, "The target service's index is already "
778 "in use. (%s)\n", mop.mo_usource);
779 if (errno == EINVAL) {
780 fprintf(stderr, "This may have multiple causes.\n");
782 fprintf(stderr, "Is '%s' the correct filesystem"
784 fprintf(stderr, "Are the mount options correct?\n");
785 fprintf(stderr, "Check the syslog for more info.\n");
788 /* May as well try to clean up loop devs */
789 if (strncmp(mop.mo_usource, "/dev/loop", 9) == 0) {
792 sprintf(cmd, "/sbin/losetup -d %s", mop.mo_usource);
793 if ((ret = system(cmd)) < 0)
796 rc = WEXITSTATUS(ret);
799 } else if (!mop.mo_nomtab) {
800 rc = update_mtab_entry(mop.mo_usource, mop.mo_target, "lustre",
801 mop.mo_orig_options, 0,0,0);
805 /* mo_usource should be freed, but we can rely on the kernel */