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>
57 #include "mount_utils.h"
59 extern char *progname;
62 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
63 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
65 static struct module_backfs_ops *backfs_ops[LDD_MT_LAST];
70 fprintf(stderr, "\n%s FATAL: ", progname);
73 int run_command(char *cmd, int cmdsz)
75 char log[] = "/tmp/run_command_logXXXXXX";
78 if ((cmdsz - strlen(cmd)) < 6) {
80 fprintf(stderr, "Command buffer overflow: %.*s...\n",
86 printf("cmd: %s\n", cmd);
88 if ((fd = mkstemp(log)) >= 0) {
96 /* Can't use popen because we need the rv of the command */
98 if (rc && (fd >= 0)) {
101 fp = fopen(log, "r");
103 while (fgets(buf, sizeof(buf), fp) != NULL) {
114 int add_param(char *buf, char *key, char *val)
116 int end = sizeof(((struct lustre_disk_data *)0)->ldd_params);
117 int start = strlen(buf);
121 keylen = strlen(key);
122 if (start + 1 + keylen + strlen(val) >= end) {
123 fprintf(stderr, "%s: params are too long-\n%s %s%s\n",
124 progname, buf, key ? key : "", val);
128 sprintf(buf + start, " %s%s", key ? key : "", val);
132 int get_param(char *buf, char *key, char **val)
134 int i, key_len = strlen(key);
137 ptr = strstr(buf, key);
139 *val = strdup(ptr + key_len);
143 for (i = 0; i < strlen(*val); i++)
144 if (((*val)[i] == ' ') || ((*val)[i] == '\0'))
154 int append_param(char *buf, char *key, char *val, char sep)
156 int key_len, i, offset, old_val_len;
157 char *ptr = NULL, str[1024];
160 ptr = strstr(buf, key);
162 /* key doesn't exist yet, so just add it */
164 return add_param(buf, key, val);
166 key_len = strlen(key);
168 /* Copy previous values to str */
169 for (i = 0; i < sizeof(str); ++i) {
170 if ((ptr[i+key_len] == ' ') || (ptr[i+key_len] == '\0'))
172 str[i] = ptr[i+key_len];
174 if (i == sizeof(str))
178 offset = old_val_len+key_len;
180 /* Move rest of buf to overwrite previous key and value */
181 for (i = 0; ptr[i+offset] != '\0'; ++i)
182 ptr[i] = ptr[i+offset];
186 snprintf(str+old_val_len, sizeof(str)-old_val_len, "%c%s", sep, val);
188 return add_param(buf, key, str);
191 char *strscat(char *dst, char *src, int buflen)
194 if (strlen(dst) + strlen(src) >= buflen) {
195 fprintf(stderr, "string buffer overflow (max %d): '%s' + '%s'"
196 "\n", buflen, dst, src);
199 return strcat(dst, src);
202 char *strscpy(char *dst, char *src, int buflen)
205 return strscat(dst, src, buflen);
208 int check_mtab_entry(char *spec1, char *spec2, char *mtpt, char *type)
213 fp = setmntent(MOUNTED, "r");
217 while ((mnt = getmntent(fp)) != NULL) {
218 if ((strcmp(mnt->mnt_fsname, spec1) == 0 ||
219 strcmp(mnt->mnt_fsname, spec2) == 0) &&
220 (mtpt == NULL || strcmp(mnt->mnt_dir, mtpt) == 0) &&
221 (type == NULL || strcmp(mnt->mnt_type, type) == 0)) {
231 #define PROC_DIR "/proc/"
232 static int mtab_is_proc(const char *mtab)
236 if (readlink(mtab, path, sizeof(path)) < 0)
239 if (strncmp(path, PROC_DIR, strlen(PROC_DIR)))
247 # include <libmount/libmount.h>
250 * The libmount is part of util-linux since 2.18.
251 * We use it to update utab to avoid umount would
252 * blocked in some rare case.
254 int update_utab_entry(struct mount_opts *mop)
256 struct libmnt_fs *fs = mnt_new_fs();
257 struct libmnt_update *upd;
260 mnt_fs_set_source(fs, mop->mo_source);
261 mnt_fs_set_target(fs, mop->mo_target);
262 mnt_fs_set_fstype(fs, "lustre");
263 mnt_fs_set_attributes(fs, "lustre");
265 upd = mnt_new_update();
269 rc = mnt_update_set_fs(upd, mop->mo_nomtab ? MS_REMOUNT : 0, NULL, fs);
270 if (rc == 1) /* update is unnecessary */
274 "error: failed to save utab entry: rc = %d\n", rc);
276 rc = mnt_update_table(upd, NULL);
279 mnt_free_update(upd);
285 int update_utab_entry(struct mount_opts *mop)
289 #endif /* HAVE_LIBMOUNT */
291 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
292 int flags, int freq, int pass)
298 /* Don't update mtab if it is linked to any file in /proc direcotry.*/
299 if (mtab_is_proc(MOUNTED))
302 mnt.mnt_fsname = spec;
305 mnt.mnt_opts = opts ? opts : "";
307 mnt.mnt_passno = pass;
309 fp = setmntent(MOUNTED, "a+");
311 fprintf(stderr, "%s: setmntent(%s): %s:",
312 progname, MOUNTED, strerror (errno));
315 if ((addmntent(fp, &mnt)) == 1) {
316 fprintf(stderr, "%s: addmntent: %s:",
317 progname, strerror (errno));
326 /* Search for opt in mntlist, returning true if found.
328 static int in_mntlist(char *opt, char *mntlist)
330 char *ml, *mlp, *item, *ctx = NULL;
332 if (!(ml = strdup(mntlist))) {
333 fprintf(stderr, "%s: out of memory\n", progname);
337 while ((item = strtok_r(mlp, ",", &ctx))) {
338 if (!strcmp(opt, item))
343 return (item != NULL);
346 /* Issue a message on stderr for every item in wanted_mountopts that is not
347 * present in mountopts. The justwarn boolean toggles between error and
348 * warning message. Return an error count.
350 int check_mountfsoptions(char *mountopts, char *wanted_mountopts)
352 char *ml, *mlp, *item, *ctx = NULL;
355 if (!(ml = strdup(wanted_mountopts))) {
356 fprintf(stderr, "%s: out of memory\n", progname);
360 while ((item = strtok_r(mlp, ",", &ctx))) {
361 if (!in_mntlist(item, mountopts)) {
362 fprintf(stderr, "%s: Error: mandatory mount option"
363 " '%s' is missing\n", progname, item);
372 /* Trim embedded white space, leading and trailing commas from string s.
374 void trim_mountfsoptions(char *s)
380 memmove(p, p + 1, strlen(p + 1) + 1);
387 memmove(&s[0], &s[1], strlen(&s[1]) + 1);
389 p = s + strlen(s) - 1;
390 while (p >= s && *p == ',')
394 /* Setup a file in the first unused loop_device */
395 int loop_setup(struct mkfs_opts *mop)
401 /* Figure out the loop device names */
402 if (!access("/dev/loop0", F_OK | R_OK) ||
403 !access("/dev/loop-control", F_OK | R_OK)) {
404 strcpy(loop_base, "/dev/loop\0");
405 } else if (!access("/dev/loop/0", F_OK | R_OK)) {
406 strcpy(loop_base, "/dev/loop/\0");
408 fprintf(stderr, "%s: can't access loop devices\n", progname);
412 /* Find unused loop device */
413 for (i = 0; i < MAX_LOOP_DEVICES; i++) {
415 int cmdsz = sizeof(cmd);
417 #ifdef HAVE_LOOP_CTL_GET_FREE
418 ret = open("/dev/loop-control", O_RDWR);
420 fprintf(stderr, "%s: can't access loop control\n", progname);
423 /* find or allocate a free loop device to use */
424 i = ioctl(ret, LOOP_CTL_GET_FREE);
427 fprintf(stderr, "%s: access loop control error\n", progname);
430 sprintf(l_device, "%s%d", loop_base, i);
432 sprintf(l_device, "%s%d", loop_base, i);
433 if (access(l_device, F_OK | R_OK))
436 snprintf(cmd, cmdsz, "losetup %s > /dev/null 2>&1", l_device);
439 /* losetup gets 1 (ret=256) for non-set-up device */
441 /* Set up a loopback device to our file */
442 snprintf(cmd, cmdsz, "losetup %s %s", l_device,
444 ret = run_command(cmd, cmdsz);
446 /* someone else picked up this loop device
450 fprintf(stderr, "%s: error %d on losetup: %s\n",
452 ret >= 0 ? strerror(ret) : "");
455 strscpy(mop->mo_loopdev, l_device,
456 sizeof(mop->mo_loopdev));
461 fprintf(stderr, "%s: out of loop devices!\n", progname);
465 int loop_cleanup(struct mkfs_opts *mop)
470 if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
473 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
474 for (tries = 0; tries < 3; tries++) {
475 ret = run_command(cmd, sizeof(cmd));
483 fprintf(stderr, "cannot cleanup %s: rc = %d\n",
484 mop->mo_loopdev, ret);
488 int loop_format(struct mkfs_opts *mop)
492 if (mop->mo_device_kb == 0) {
494 fprintf(stderr, "loop device requires a --device-size= "
499 fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
502 fprintf(stderr, "%s: Unable to create backing store: %s\n",
503 progname, strerror(errno));
507 if (ftruncate(fd, mop->mo_device_kb * 1024) != 0) {
510 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
511 progname, strerror(errno));
519 #define DLSYM(prefix, sym, func) \
522 snprintf(_fname, sizeof(_fname), "%s_%s", prefix, #func); \
523 sym->func = (typeof(sym->func))dlsym(sym->dl_handle, _fname); \
527 * Load plugin for a given mount_type from ${pkglibdir}/mount_osd_FSTYPE.so and
528 * return struct of function pointers (will be freed in unloack_backfs_module).
530 * \param[in] mount_type Mount type to load module for.
531 * \retval Value of backfs_ops struct
532 * \retval NULL if no module exists
534 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type)
537 char *error, filename[512], fsname[512], *name;
538 struct module_backfs_ops *ops;
540 /* This deals with duplicate ldd_mount_types resolving to same OSD layer
541 * plugin (e.g. ext3/ldiskfs/ldiskfs2 all being ldiskfs) */
542 strncpy(fsname, mt_type(mount_type), sizeof(fsname));
543 name = fsname + sizeof("osd-") - 1;
545 /* change osd- to osd_ */
546 fsname[sizeof("osd-") - 2] = '_';
548 snprintf(filename, sizeof(filename), PLUGIN_DIR"/mount_%s.so", fsname);
550 handle = dlopen(filename, RTLD_LAZY);
552 /* Check for $LUSTRE environment variable from test-framework.
553 * This allows using locally built modules to be used.
555 if (handle == NULL) {
557 dirname = getenv("LUSTRE");
559 snprintf(filename, sizeof(filename),
560 "%s/utils/.libs/mount_%s.so",
562 handle = dlopen(filename, RTLD_LAZY);
566 /* Do not clutter up console with missing types */
570 ops = malloc(sizeof(*ops));
576 ops->dl_handle = handle;
577 dlerror(); /* Clear any existing error */
579 DLSYM(name, ops, init);
580 DLSYM(name, ops, fini);
581 DLSYM(name, ops, read_ldd);
582 DLSYM(name, ops, write_ldd);
583 DLSYM(name, ops, is_lustre);
584 DLSYM(name, ops, make_lustre);
585 DLSYM(name, ops, prepare_lustre);
586 DLSYM(name, ops, tune_lustre);
587 DLSYM(name, ops, label_lustre);
588 DLSYM(name, ops, enable_quota);
593 fprintf(stderr, "%s\n", error);
599 /* optional methods */
600 DLSYM(name, ops, fix_mountopts);
606 * Unload plugin and free backfs_ops structure. Must be called the same number
607 * of times as load_backfs_module is.
609 void unload_backfs_module(struct module_backfs_ops *ops)
614 dlclose(ops->dl_handle);
618 /* Return true if backfs_ops has operations for the given mount_type. */
619 int backfs_mount_type_okay(enum ldd_mount_type mount_type)
621 if (unlikely(mount_type >= LDD_MT_LAST || mount_type < 0)) {
623 fprintf(stderr, "fs type out of range %d\n", mount_type);
626 if (backfs_ops[mount_type] == NULL) {
628 fprintf(stderr, "unhandled/unloaded fs type %d '%s'\n",
629 mount_type, mt_str(mount_type));
635 /* Write the server config files */
636 int osd_write_ldd(struct mkfs_opts *mop)
638 struct lustre_disk_data *ldd = &mop->mo_ldd;
641 if (backfs_mount_type_okay(ldd->ldd_mount_type))
642 ret = backfs_ops[ldd->ldd_mount_type]->write_ldd(mop);
649 /* Read the server config files */
650 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
654 if (backfs_mount_type_okay(ldd->ldd_mount_type))
655 ret = backfs_ops[ldd->ldd_mount_type]->read_ldd(dev, ldd);
662 /* Was this device formatted for Lustre */
663 int osd_is_lustre(char *dev, unsigned *mount_type)
667 vprint("checking for existing Lustre data: ");
669 for (i = 0; i < LDD_MT_LAST; ++i) {
670 if (backfs_ops[i] != NULL &&
671 backfs_ops[i]->is_lustre(dev, mount_type)) {
677 vprint("not found\n");
681 /* Build fs according to type */
682 int osd_make_lustre(struct mkfs_opts *mop)
684 struct lustre_disk_data *ldd = &mop->mo_ldd;
687 if (backfs_mount_type_okay(ldd->ldd_mount_type))
688 ret = backfs_ops[ldd->ldd_mount_type]->make_lustre(mop);
695 int osd_prepare_lustre(struct mkfs_opts *mop,
696 char *wanted_mountopts, size_t len)
698 struct lustre_disk_data *ldd = &mop->mo_ldd;
701 if (backfs_mount_type_okay(ldd->ldd_mount_type))
702 ret = backfs_ops[ldd->ldd_mount_type]->prepare_lustre(mop,
703 wanted_mountopts, len);
710 int osd_fix_mountopts(struct mkfs_opts *mop, char *mountopts, size_t len)
712 struct lustre_disk_data *ldd = &mop->mo_ldd;
714 if (!backfs_mount_type_okay(ldd->ldd_mount_type))
717 if (backfs_ops[ldd->ldd_mount_type]->fix_mountopts == NULL)
720 return backfs_ops[ldd->ldd_mount_type]->fix_mountopts(mop, mountopts,
724 int osd_tune_lustre(char *dev, struct mount_opts *mop)
726 struct lustre_disk_data *ldd = &mop->mo_ldd;
729 if (backfs_mount_type_okay(ldd->ldd_mount_type))
730 ret = backfs_ops[ldd->ldd_mount_type]->tune_lustre(dev, mop);
737 int osd_label_lustre(struct mount_opts *mop)
739 struct lustre_disk_data *ldd = &mop->mo_ldd;
742 if (backfs_mount_type_okay(ldd->ldd_mount_type))
743 ret = backfs_ops[ldd->ldd_mount_type]->label_lustre(mop);
750 /* Enable quota accounting */
751 int osd_enable_quota(struct mkfs_opts *mop)
753 struct lustre_disk_data *ldd = &mop->mo_ldd;
756 if (backfs_mount_type_okay(ldd->ldd_mount_type))
757 ret = backfs_ops[ldd->ldd_mount_type]->enable_quota(mop);
766 int i, rc, ret = EINVAL;
768 for (i = 0; i < LDD_MT_LAST; ++i) {
770 backfs_ops[i] = load_backfs_module(i);
771 if (backfs_ops[i] != NULL)
772 rc = backfs_ops[i]->init();
774 backfs_ops[i]->fini();
775 unload_backfs_module(backfs_ops[i]);
776 backfs_ops[i] = NULL;
788 for (i = 0; i < LDD_MT_LAST; ++i) {
789 if (backfs_ops[i] != NULL) {
790 backfs_ops[i]->fini();
791 unload_backfs_module(backfs_ops[i]);
792 backfs_ops[i] = NULL;
797 __u64 get_device_size(char* device)
802 fd = open(device, O_RDONLY);
804 fprintf(stderr, "%s: cannot open %s: %s\n",
805 progname, device, strerror(errno));
810 /* size in bytes. bz5831 */
811 ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
816 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
817 size = (__u64)lsize * 512;
822 fprintf(stderr, "%s: size ioctl failed: %s\n",
823 progname, strerror(errno));
827 vprint("device size = %juMB\n", (uintmax_t)(size >> 20));
828 /* return value in KB */
832 int file_create(char *path, __u64 size)
839 * Since "size" is in KB, the file offset it represents could overflow
842 size_max = (off_t)1 << (_FILE_OFFSET_BITS - 1 - 10);
843 if (size >= size_max) {
844 fprintf(stderr, "%s: %ju KB: Backing store size must be "
845 "smaller than %ju KB\n", progname, (uintmax_t) size,
846 (uintmax_t)size_max);
850 ret = access(path, F_OK);
857 fd = creat(path, S_IRUSR|S_IWUSR);
860 fprintf(stderr, "%s: Unable to create backing store: %s\n",
861 progname, strerror(errno));
865 ret = ftruncate(fd, size * 1024);
869 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
870 progname, strerror(errno));