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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
39 #endif /* HAVE_CONFIG_H */
49 #include <lustre_disk.h>
50 #include <lustre_ver.h>
51 #include <sys/mount.h>
53 #include <sys/utsname.h>
54 #include <linux/loop.h>
55 #include <sys/types.h>
61 #include <lustre/utils/gss/sk_utils.h>
64 #include "mount_utils.h"
66 extern char *progname;
69 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
70 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
72 static struct module_backfs_ops *backfs_ops[LDD_MT_LAST];
77 fprintf(stderr, "\n%s FATAL: ", progname);
80 int run_command(char *cmd, int cmdsz)
82 char log[] = "/tmp/run_command_logXXXXXX";
85 if ((cmdsz - strlen(cmd)) < 6) {
87 fprintf(stderr, "Command buffer overflow: %.*s...\n",
93 printf("cmd: %s\n", cmd);
95 if ((fd = mkstemp(log)) >= 0) {
101 strcat(cmd, " 2>&1");
103 /* Can't use popen because we need the rv of the command */
105 if (rc && (fd >= 0)) {
108 fp = fopen(log, "r");
110 while (fgets(buf, sizeof(buf), fp) != NULL) {
121 int add_param(char *buf, char *key, char *val)
123 int end = sizeof(((struct lustre_disk_data *)0)->ldd_params);
124 int start = strlen(buf);
128 keylen = strlen(key);
129 if (start + 1 + keylen + strlen(val) >= end) {
130 fprintf(stderr, "%s: params are too long-\n%s %s%s\n",
131 progname, buf, key ? key : "", val);
135 sprintf(buf + start, " %s%s", key ? key : "", val);
139 int get_param(char *buf, char *key, char **val)
141 int i, key_len = strlen(key);
144 ptr = strstr(buf, key);
146 *val = strdup(ptr + key_len);
150 for (i = 0; i < strlen(*val); i++)
151 if (((*val)[i] == ' ') || ((*val)[i] == '\0'))
161 int append_param(char *buf, char *key, char *val, char sep)
163 int key_len, i, offset, old_val_len;
164 char *ptr = NULL, str[1024];
167 ptr = strstr(buf, key);
169 /* key doesn't exist yet, so just add it */
171 return add_param(buf, key, val);
173 key_len = strlen(key);
175 /* Copy previous values to str */
176 for (i = 0; i < sizeof(str); ++i) {
177 if ((ptr[i+key_len] == ' ') || (ptr[i+key_len] == '\0'))
179 str[i] = ptr[i+key_len];
181 if (i == sizeof(str))
185 offset = old_val_len+key_len;
187 /* Move rest of buf to overwrite previous key and value */
188 for (i = 0; ptr[i+offset] != '\0'; ++i)
189 ptr[i] = ptr[i+offset];
193 snprintf(str+old_val_len, sizeof(str)-old_val_len, "%c%s", sep, val);
195 return add_param(buf, key, str);
198 char *strscat(char *dst, char *src, int buflen)
201 if (strlen(dst) + strlen(src) >= buflen) {
202 fprintf(stderr, "string buffer overflow (max %d): '%s' + '%s'"
203 "\n", buflen, dst, src);
206 return strcat(dst, src);
209 char *strscpy(char *dst, char *src, int buflen)
212 return strscat(dst, src, buflen);
215 int check_mtab_entry(char *spec1, char *spec2, char *mtpt, char *type)
220 fp = setmntent(MOUNTED, "r");
224 while ((mnt = getmntent(fp)) != NULL) {
225 if ((strcmp(mnt->mnt_fsname, spec1) == 0 ||
226 strcmp(mnt->mnt_fsname, spec2) == 0) &&
227 (mtpt == NULL || strcmp(mnt->mnt_dir, mtpt) == 0) &&
228 (type == NULL || strcmp(mnt->mnt_type, type) == 0)) {
238 #define PROC_DIR "/proc/"
239 static int mtab_is_proc(const char *mtab)
243 if (readlink(mtab, path, sizeof(path)) < 0)
246 if (strncmp(path, PROC_DIR, strlen(PROC_DIR)))
254 # include <libmount/libmount.h>
257 * The libmount is part of util-linux since 2.18.
258 * We use it to update utab to avoid umount would
259 * blocked in some rare case.
261 int update_utab_entry(struct mount_opts *mop)
263 struct libmnt_fs *fs = mnt_new_fs();
264 struct libmnt_update *upd;
267 mnt_fs_set_source(fs, mop->mo_source);
268 mnt_fs_set_target(fs, mop->mo_target);
269 mnt_fs_set_fstype(fs, "lustre");
270 mnt_fs_set_attributes(fs, "lustre");
272 upd = mnt_new_update();
276 rc = mnt_update_set_fs(upd, mop->mo_nomtab ? MS_REMOUNT : 0, NULL, fs);
277 if (rc == 1) /* update is unnecessary */
281 "error: failed to save utab entry: rc = %d\n", rc);
283 rc = mnt_update_table(upd, NULL);
286 mnt_free_update(upd);
292 int update_utab_entry(struct mount_opts *mop)
296 #endif /* HAVE_LIBMOUNT */
298 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
299 int flags, int freq, int pass)
305 /* Don't update mtab if it is linked to any file in /proc direcotry.*/
306 if (mtab_is_proc(MOUNTED))
309 mnt.mnt_fsname = spec;
312 mnt.mnt_opts = opts ? opts : "";
314 mnt.mnt_passno = pass;
316 fp = setmntent(MOUNTED, "a+");
318 fprintf(stderr, "%s: setmntent(%s): %s:",
319 progname, MOUNTED, strerror (errno));
322 if ((addmntent(fp, &mnt)) == 1) {
323 fprintf(stderr, "%s: addmntent: %s:",
324 progname, strerror (errno));
333 /* Search for opt in mntlist, returning true if found.
335 static int in_mntlist(char *opt, char *mntlist)
337 char *ml, *mlp, *item, *ctx = NULL;
339 if (!(ml = strdup(mntlist))) {
340 fprintf(stderr, "%s: out of memory\n", progname);
344 while ((item = strtok_r(mlp, ",", &ctx))) {
345 if (!strcmp(opt, item))
350 return (item != NULL);
353 /* Issue a message on stderr for every item in wanted_mountopts that is not
354 * present in mountopts. The justwarn boolean toggles between error and
355 * warning message. Return an error count.
357 int check_mountfsoptions(char *mountopts, char *wanted_mountopts)
359 char *ml, *mlp, *item, *ctx = NULL;
362 if (!(ml = strdup(wanted_mountopts))) {
363 fprintf(stderr, "%s: out of memory\n", progname);
367 while ((item = strtok_r(mlp, ",", &ctx))) {
368 if (!in_mntlist(item, mountopts)) {
369 fprintf(stderr, "%s: Error: mandatory mount option"
370 " '%s' is missing\n", progname, item);
379 /* Trim embedded white space, leading and trailing commas from string s.
381 void trim_mountfsoptions(char *s)
387 memmove(p, p + 1, strlen(p + 1) + 1);
394 memmove(&s[0], &s[1], strlen(&s[1]) + 1);
396 p = s + strlen(s) - 1;
397 while (p >= s && *p == ',')
401 /* Setup a file in the first unused loop_device */
402 int loop_setup(struct mkfs_opts *mop)
408 /* Figure out the loop device names */
409 if (!access("/dev/loop0", F_OK | R_OK) ||
410 !access("/dev/loop-control", F_OK | R_OK)) {
411 strcpy(loop_base, "/dev/loop\0");
412 } else if (!access("/dev/loop/0", F_OK | R_OK)) {
413 strcpy(loop_base, "/dev/loop/\0");
415 fprintf(stderr, "%s: can't access loop devices\n", progname);
419 /* Find unused loop device */
420 for (i = 0; i < MAX_LOOP_DEVICES; i++) {
422 int cmdsz = sizeof(cmd);
424 #ifdef HAVE_LOOP_CTL_GET_FREE
425 ret = open("/dev/loop-control", O_RDWR);
427 fprintf(stderr, "%s: can't access loop control\n", progname);
430 /* find or allocate a free loop device to use */
431 i = ioctl(ret, LOOP_CTL_GET_FREE);
434 fprintf(stderr, "%s: access loop control error\n", progname);
437 sprintf(l_device, "%s%d", loop_base, i);
439 sprintf(l_device, "%s%d", loop_base, i);
440 if (access(l_device, F_OK | R_OK))
443 snprintf(cmd, cmdsz, "losetup %s > /dev/null 2>&1", l_device);
446 /* losetup gets 1 (ret=256) for non-set-up device */
448 /* Set up a loopback device to our file */
449 snprintf(cmd, cmdsz, "losetup %s %s", l_device,
451 ret = run_command(cmd, cmdsz);
453 /* someone else picked up this loop device
457 fprintf(stderr, "%s: error %d on losetup: %s\n",
459 ret >= 0 ? strerror(ret) : "");
462 strscpy(mop->mo_loopdev, l_device,
463 sizeof(mop->mo_loopdev));
468 fprintf(stderr, "%s: out of loop devices!\n", progname);
472 int loop_cleanup(struct mkfs_opts *mop)
477 if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
480 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
481 for (tries = 0; tries < 3; tries++) {
482 ret = run_command(cmd, sizeof(cmd));
490 fprintf(stderr, "cannot cleanup %s: rc = %d\n",
491 mop->mo_loopdev, ret);
495 int loop_format(struct mkfs_opts *mop)
499 if (mop->mo_device_kb == 0) {
501 fprintf(stderr, "loop device requires a --device-size= "
506 fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
509 fprintf(stderr, "%s: Unable to create backing store: %s\n",
510 progname, strerror(errno));
514 if (ftruncate(fd, mop->mo_device_kb * 1024) != 0) {
517 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
518 progname, strerror(errno));
526 #define DLSYM(prefix, sym, func) \
529 snprintf(_fname, sizeof(_fname), "%s_%s", prefix, #func); \
530 sym->func = (typeof(sym->func))dlsym(sym->dl_handle, _fname); \
534 * Load plugin for a given mount_type from ${pkglibdir}/mount_osd_FSTYPE.so and
535 * return struct of function pointers (will be freed in unloack_backfs_module).
537 * \param[in] mount_type Mount type to load module for.
538 * \retval Value of backfs_ops struct
539 * \retval NULL if no module exists
541 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type)
544 char *error, filename[512], fsname[512], *name;
545 struct module_backfs_ops *ops;
547 /* This deals with duplicate ldd_mount_types resolving to same OSD layer
548 * plugin (e.g. ext3/ldiskfs/ldiskfs2 all being ldiskfs) */
549 strncpy(fsname, mt_type(mount_type), sizeof(fsname));
550 name = fsname + sizeof("osd-") - 1;
552 /* change osd- to osd_ */
553 fsname[sizeof("osd-") - 2] = '_';
555 snprintf(filename, sizeof(filename), PLUGIN_DIR"/mount_%s.so", fsname);
557 handle = dlopen(filename, RTLD_LAZY);
559 /* Check for $LUSTRE environment variable from test-framework.
560 * This allows using locally built modules to be used.
562 if (handle == NULL) {
564 dirname = getenv("LUSTRE");
566 snprintf(filename, sizeof(filename),
567 "%s/utils/.libs/mount_%s.so",
569 handle = dlopen(filename, RTLD_LAZY);
573 /* Do not clutter up console with missing types */
577 ops = malloc(sizeof(*ops));
583 ops->dl_handle = handle;
584 dlerror(); /* Clear any existing error */
586 DLSYM(name, ops, init);
587 DLSYM(name, ops, fini);
588 DLSYM(name, ops, read_ldd);
589 DLSYM(name, ops, write_ldd);
590 DLSYM(name, ops, is_lustre);
591 DLSYM(name, ops, make_lustre);
592 DLSYM(name, ops, prepare_lustre);
593 DLSYM(name, ops, tune_lustre);
594 DLSYM(name, ops, label_lustre);
595 DLSYM(name, ops, enable_quota);
600 fprintf(stderr, "%s\n", error);
606 /* optional methods */
607 DLSYM(name, ops, fix_mountopts);
613 * Unload plugin and free backfs_ops structure. Must be called the same number
614 * of times as load_backfs_module is.
616 void unload_backfs_module(struct module_backfs_ops *ops)
621 dlclose(ops->dl_handle);
625 /* Return true if backfs_ops has operations for the given mount_type. */
626 int backfs_mount_type_okay(enum ldd_mount_type mount_type)
628 if (unlikely(mount_type >= LDD_MT_LAST || mount_type < 0)) {
630 fprintf(stderr, "fs type out of range %d\n", mount_type);
633 if (backfs_ops[mount_type] == NULL) {
635 fprintf(stderr, "unhandled/unloaded fs type %d '%s'\n",
636 mount_type, mt_str(mount_type));
642 /* Write the server config files */
643 int osd_write_ldd(struct mkfs_opts *mop)
645 struct lustre_disk_data *ldd = &mop->mo_ldd;
648 if (backfs_mount_type_okay(ldd->ldd_mount_type))
649 ret = backfs_ops[ldd->ldd_mount_type]->write_ldd(mop);
656 /* Read the server config files */
657 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
661 if (backfs_mount_type_okay(ldd->ldd_mount_type))
662 ret = backfs_ops[ldd->ldd_mount_type]->read_ldd(dev, ldd);
669 /* Was this device formatted for Lustre */
670 int osd_is_lustre(char *dev, unsigned *mount_type)
674 vprint("checking for existing Lustre data: ");
676 for (i = 0; i < LDD_MT_LAST; ++i) {
677 if (backfs_ops[i] != NULL &&
678 backfs_ops[i]->is_lustre(dev, mount_type)) {
684 vprint("not found\n");
688 /* Build fs according to type */
689 int osd_make_lustre(struct mkfs_opts *mop)
691 struct lustre_disk_data *ldd = &mop->mo_ldd;
694 if (backfs_mount_type_okay(ldd->ldd_mount_type))
695 ret = backfs_ops[ldd->ldd_mount_type]->make_lustre(mop);
702 int osd_prepare_lustre(struct mkfs_opts *mop,
703 char *wanted_mountopts, size_t len)
705 struct lustre_disk_data *ldd = &mop->mo_ldd;
708 if (backfs_mount_type_okay(ldd->ldd_mount_type))
709 ret = backfs_ops[ldd->ldd_mount_type]->prepare_lustre(mop,
710 wanted_mountopts, len);
717 int osd_fix_mountopts(struct mkfs_opts *mop, char *mountopts, size_t len)
719 struct lustre_disk_data *ldd = &mop->mo_ldd;
721 if (!backfs_mount_type_okay(ldd->ldd_mount_type))
724 if (backfs_ops[ldd->ldd_mount_type]->fix_mountopts == NULL)
727 return backfs_ops[ldd->ldd_mount_type]->fix_mountopts(mop, mountopts,
731 int osd_tune_lustre(char *dev, struct mount_opts *mop)
733 struct lustre_disk_data *ldd = &mop->mo_ldd;
736 if (backfs_mount_type_okay(ldd->ldd_mount_type))
737 ret = backfs_ops[ldd->ldd_mount_type]->tune_lustre(dev, mop);
744 int osd_label_lustre(struct mount_opts *mop)
746 struct lustre_disk_data *ldd = &mop->mo_ldd;
749 if (backfs_mount_type_okay(ldd->ldd_mount_type))
750 ret = backfs_ops[ldd->ldd_mount_type]->label_lustre(mop);
757 /* Enable quota accounting */
758 int osd_enable_quota(struct mkfs_opts *mop)
760 struct lustre_disk_data *ldd = &mop->mo_ldd;
763 if (backfs_mount_type_okay(ldd->ldd_mount_type))
764 ret = backfs_ops[ldd->ldd_mount_type]->enable_quota(mop);
773 int i, rc, ret = EINVAL;
775 for (i = 0; i < LDD_MT_LAST; ++i) {
777 backfs_ops[i] = load_backfs_module(i);
778 if (backfs_ops[i] != NULL)
779 rc = backfs_ops[i]->init();
781 backfs_ops[i]->fini();
782 unload_backfs_module(backfs_ops[i]);
783 backfs_ops[i] = NULL;
795 for (i = 0; i < LDD_MT_LAST; ++i) {
796 if (backfs_ops[i] != NULL) {
797 backfs_ops[i]->fini();
798 unload_backfs_module(backfs_ops[i]);
799 backfs_ops[i] = NULL;
804 __u64 get_device_size(char* device)
809 fd = open(device, O_RDONLY);
811 fprintf(stderr, "%s: cannot open %s: %s\n",
812 progname, device, strerror(errno));
817 /* size in bytes. bz5831 */
818 ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
823 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
824 size = (__u64)lsize * 512;
829 fprintf(stderr, "%s: size ioctl failed: %s\n",
830 progname, strerror(errno));
834 vprint("device size = %juMB\n", (uintmax_t)(size >> 20));
835 /* return value in KB */
839 int file_create(char *path, __u64 size)
846 * Since "size" is in KB, the file offset it represents could overflow
849 size_max = (off_t)1 << (_FILE_OFFSET_BITS - 1 - 10);
850 if (size >= size_max) {
851 fprintf(stderr, "%s: %ju KB: Backing store size must be "
852 "smaller than %ju KB\n", progname, (uintmax_t) size,
853 (uintmax_t)size_max);
857 ret = access(path, F_OK);
864 fd = creat(path, S_IRUSR|S_IWUSR);
867 fprintf(stderr, "%s: Unable to create backing store: %s\n",
868 progname, strerror(errno));
872 ret = ftruncate(fd, size * 1024);
876 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
877 progname, strerror(errno));
885 int load_shared_keys(struct mount_opts *mop)
888 struct dirent *dentry;
890 char fullpath[PATH_MAX];
891 char *path = mop->mo_skpath;
895 if (IS_SERVER(&mop->mo_ldd)) {
896 if (IS_MGS(&mop->mo_ldd))
898 if (IS_MDT(&mop->mo_ldd) || IS_OST(&mop->mo_ldd))
899 type |= SK_TYPE_SERVER | SK_TYPE_CLIENT;
901 type |= SK_TYPE_CLIENT;
905 sk_init_logging(NULL, 1, 1);
907 rc = stat(path, &sbuf);
909 fprintf(stderr, "stat() failed for key %s: %s\n", path,
914 /* Load individual keys or a directory of them */
915 if (S_ISREG(sbuf.st_mode)) {
916 return sk_load_keyfile(path, type);
917 } else if (!S_ISDIR(sbuf.st_mode)) {
918 fprintf(stderr, "Invalid shared key path: %s\n", path);
924 fprintf(stderr, "Unable to open shared key directory: %s\n",
929 /* Loop through the files in the directory attempting to load them.
930 * Any issue with loading the keyfile is treated as an error although
931 * the loop continues until all files have been attempted. This will
932 * allow all errors be reported at once rather then requiring
933 * incremental corrections to fix each one and try again. */
934 while ((dentry = readdir(dir)) != NULL) {
935 if (strcmp(".", dentry->d_name) == 0 ||
936 strcmp("..", dentry->d_name) == 0)
939 rc = snprintf(fullpath, PATH_MAX, "%s/%s", path,
941 if (rc >= PATH_MAX) {
942 fprintf(stderr, "Path too long for %s/%s\n",
943 path, dentry->d_name);
948 rc = stat(fullpath, &sbuf);
950 fprintf(stderr, "Unable to stat %s: %s\n", fullpath,
956 if (!S_ISREG(sbuf.st_mode))
959 rc = sk_load_keyfile(fullpath, type);
961 fprintf(stderr, "Failed to load key %s\n", fullpath);