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.
29 * Copyright (c) 2012, 2013, Intel Corporation.
32 * This file is part of Lustre, http://www.lustre.org/
33 * Lustre is a trademark of Sun Microsystems, Inc.
38 #endif /* HAVE_CONFIG_H */
40 #include "mount_utils.h"
45 #include <lustre_disk.h>
46 #include <lustre_ver.h>
48 #include <sys/utsname.h>
49 #include <linux/loop.h>
52 extern char *progname;
55 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
56 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
58 static struct module_backfs_ops *backfs_ops[LDD_MT_LAST];
63 fprintf(stderr, "\n%s FATAL: ", progname);
66 int run_command(char *cmd, int cmdsz)
68 char log[] = "/tmp/run_command_logXXXXXX";
71 if ((cmdsz - strlen(cmd)) < 6) {
73 fprintf(stderr, "Command buffer overflow: %.*s...\n",
79 printf("cmd: %s\n", cmd);
81 if ((fd = mkstemp(log)) >= 0) {
89 /* Can't use popen because we need the rv of the command */
91 if (rc && (fd >= 0)) {
96 while (fgets(buf, sizeof(buf), fp) != NULL) {
107 int add_param(char *buf, char *key, char *val)
109 int end = sizeof(((struct lustre_disk_data *)0)->ldd_params);
110 int start = strlen(buf);
114 keylen = strlen(key);
115 if (start + 1 + keylen + strlen(val) >= end) {
116 fprintf(stderr, "%s: params are too long-\n%s %s%s\n",
117 progname, buf, key ? key : "", val);
121 sprintf(buf + start, " %s%s", key ? key : "", val);
125 int get_param(char *buf, char *key, char **val)
127 int i, key_len = strlen(key);
130 ptr = strstr(buf, key);
132 *val = strdup(ptr + key_len);
136 for (i = 0; i < strlen(*val); i++)
137 if (((*val)[i] == ' ') || ((*val)[i] == '\0'))
147 char *strscat(char *dst, char *src, int buflen)
150 if (strlen(dst) + strlen(src) >= buflen) {
151 fprintf(stderr, "string buffer overflow (max %d): '%s' + '%s'"
152 "\n", buflen, dst, src);
155 return strcat(dst, src);
158 char *strscpy(char *dst, char *src, int buflen)
161 return strscat(dst, src, buflen);
164 int check_mtab_entry(char *spec1, char *spec2, char *mtpt, char *type)
169 fp = setmntent(MOUNTED, "r");
173 while ((mnt = getmntent(fp)) != NULL) {
174 if ((strcmp(mnt->mnt_fsname, spec1) == 0 ||
175 strcmp(mnt->mnt_fsname, spec2) == 0) &&
176 (mtpt == NULL || strcmp(mnt->mnt_dir, mtpt) == 0) &&
177 (type == NULL || strcmp(mnt->mnt_type, type) == 0)) {
187 #define PROC_DIR "/proc/"
188 static int mtab_is_proc(const char *mtab)
192 if (readlink(mtab, path, sizeof(path)) < 0)
195 if (strncmp(path, PROC_DIR, strlen(PROC_DIR)))
201 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
202 int flags, int freq, int pass)
208 /* Don't update mtab if it is linked to any file in /proc direcotry.*/
209 if (mtab_is_proc(MOUNTED))
212 mnt.mnt_fsname = spec;
215 mnt.mnt_opts = opts ? opts : "";
217 mnt.mnt_passno = pass;
219 fp = setmntent(MOUNTED, "a+");
221 fprintf(stderr, "%s: setmntent(%s): %s:",
222 progname, MOUNTED, strerror (errno));
225 if ((addmntent(fp, &mnt)) == 1) {
226 fprintf(stderr, "%s: addmntent: %s:",
227 progname, strerror (errno));
236 /* Search for opt in mntlist, returning true if found.
238 static int in_mntlist(char *opt, char *mntlist)
240 char *ml, *mlp, *item, *ctx = NULL;
242 if (!(ml = strdup(mntlist))) {
243 fprintf(stderr, "%s: out of memory\n", progname);
247 while ((item = strtok_r(mlp, ",", &ctx))) {
248 if (!strcmp(opt, item))
253 return (item != NULL);
256 /* Issue a message on stderr for every item in wanted_mountopts that is not
257 * present in mountopts. The justwarn boolean toggles between error and
258 * warning message. Return an error count.
260 int check_mountfsoptions(char *mountopts, char *wanted_mountopts,
263 char *ml, *mlp, *item, *ctx = NULL;
266 if (!(ml = strdup(wanted_mountopts))) {
267 fprintf(stderr, "%s: out of memory\n", progname);
271 while ((item = strtok_r(mlp, ",", &ctx))) {
272 if (!in_mntlist(item, mountopts)) {
273 fprintf(stderr, "%s: %s mount option `%s' is missing\n",
274 progname, justwarn ? "Warning: default"
275 : "Error: mandatory", item);
284 /* Trim embedded white space, leading and trailing commas from string s.
286 void trim_mountfsoptions(char *s)
292 memmove(p, p + 1, strlen(p + 1) + 1);
299 memmove(&s[0], &s[1], strlen(&s[1]) + 1);
301 p = s + strlen(s) - 1;
302 while (p >= s && *p == ',')
306 /* Setup a file in the first unused loop_device */
307 int loop_setup(struct mkfs_opts *mop)
313 /* Figure out the loop device names */
314 if (!access("/dev/loop0", F_OK | R_OK) ||
315 !access("/dev/loop-control", F_OK | R_OK)) {
316 strcpy(loop_base, "/dev/loop\0");
317 } else if (!access("/dev/loop/0", F_OK | R_OK)) {
318 strcpy(loop_base, "/dev/loop/\0");
320 fprintf(stderr, "%s: can't access loop devices\n", progname);
324 /* Find unused loop device */
325 for (i = 0; i < MAX_LOOP_DEVICES; i++) {
327 int cmdsz = sizeof(cmd);
329 #ifdef LOOP_CTL_GET_FREE
330 ret = open("/dev/loop-control", O_RDWR);
332 fprintf(stderr, "%s: can't access loop control\n", progname);
335 /* find or allocate a free loop device to use */
336 i = ioctl(ret, LOOP_CTL_GET_FREE);
338 fprintf(stderr, "%s: access loop control error\n", progname);
341 sprintf(l_device, "%s%d", loop_base, i);
343 sprintf(l_device, "%s%d", loop_base, i);
344 if (access(l_device, F_OK | R_OK))
347 snprintf(cmd, cmdsz, "losetup %s > /dev/null 2>&1", l_device);
350 /* losetup gets 1 (ret=256) for non-set-up device */
352 /* Set up a loopback device to our file */
353 snprintf(cmd, cmdsz, "losetup %s %s", l_device,
355 ret = run_command(cmd, cmdsz);
357 /* someone else picked up this loop device
361 fprintf(stderr, "%s: error %d on losetup: %s\n",
363 ret >= 0 ? strerror(ret) : "");
366 strscpy(mop->mo_loopdev, l_device,
367 sizeof(mop->mo_loopdev));
372 fprintf(stderr, "%s: out of loop devices!\n", progname);
376 int loop_cleanup(struct mkfs_opts *mop)
381 if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
384 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
385 for (tries = 0; tries < 3; tries++) {
386 ret = run_command(cmd, sizeof(cmd));
394 fprintf(stderr, "cannot cleanup %s: rc = %d\n",
395 mop->mo_loopdev, ret);
399 int loop_format(struct mkfs_opts *mop)
403 if (mop->mo_device_kb == 0) {
405 fprintf(stderr, "loop device requires a --device-size= "
410 fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
413 fprintf(stderr, "%s: Unable to create backing store: %s\n",
414 progname, strerror(errno));
418 if (ftruncate(fd, mop->mo_device_kb * 1024) != 0) {
421 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
422 progname, strerror(errno));
430 #define DLSYM(prefix, sym, func) \
433 snprintf(_fname, sizeof(_fname), "%s_%s", prefix, #func); \
434 sym->func = (typeof(sym->func))dlsym(sym->dl_handle, _fname); \
438 * Load plugin for a given mount_type from ${pkglibdir}/mount_osd_FSTYPE.so and
439 * return struct of function pointers (will be freed in unloack_backfs_module).
441 * \param[in] mount_type Mount type to load module for.
442 * \retval Value of backfs_ops struct
443 * \retval NULL if no module exists
445 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type)
448 char *error, filename[512], fsname[512], *name;
449 struct module_backfs_ops *ops;
451 /* This deals with duplicate ldd_mount_types resolving to same OSD layer
452 * plugin (e.g. ext3/ldiskfs/ldiskfs2 all being ldiskfs) */
453 strlcpy(fsname, mt_type(mount_type), sizeof(fsname));
454 name = fsname + sizeof("osd-") - 1;
456 /* change osd- to osd_ */
457 fsname[sizeof("osd-") - 2] = '_';
459 snprintf(filename, sizeof(filename), PLUGIN_DIR"/mount_%s.so", fsname);
461 handle = dlopen(filename, RTLD_LAZY);
463 /* Check for $LUSTRE environment variable from test-framework.
464 * This allows using locally built modules to be used.
466 if (handle == NULL) {
468 dirname = getenv("LUSTRE");
470 snprintf(filename, sizeof(filename),
471 "%s/utils/.libs/mount_%s.so",
473 handle = dlopen(filename, RTLD_LAZY);
477 /* Do not clutter up console with missing types */
481 ops = malloc(sizeof(*ops));
487 ops->dl_handle = handle;
488 dlerror(); /* Clear any existing error */
490 DLSYM(name, ops, init);
491 DLSYM(name, ops, fini);
492 DLSYM(name, ops, read_ldd);
493 DLSYM(name, ops, write_ldd);
494 DLSYM(name, ops, is_lustre);
495 DLSYM(name, ops, make_lustre);
496 DLSYM(name, ops, prepare_lustre);
497 DLSYM(name, ops, tune_lustre);
498 DLSYM(name, ops, label_lustre);
499 DLSYM(name, ops, enable_quota);
504 fprintf(stderr, "%s\n", error);
513 * Unload plugin and free backfs_ops structure. Must be called the same number
514 * of times as load_backfs_module is.
516 void unload_backfs_module(struct module_backfs_ops *ops)
521 dlclose(ops->dl_handle);
525 /* Return true if backfs_ops has operations for the given mount_type. */
526 int backfs_mount_type_okay(enum ldd_mount_type mount_type)
528 if (unlikely(mount_type >= LDD_MT_LAST || mount_type < 0)) {
530 fprintf(stderr, "fs type out of range %d\n", mount_type);
533 if (backfs_ops[mount_type] == NULL) {
535 fprintf(stderr, "unhandled fs type %d '%s'\n",
536 mount_type, mt_str(mount_type));
542 /* Write the server config files */
543 int osd_write_ldd(struct mkfs_opts *mop)
545 struct lustre_disk_data *ldd = &mop->mo_ldd;
548 if (backfs_mount_type_okay(ldd->ldd_mount_type))
549 ret = backfs_ops[ldd->ldd_mount_type]->write_ldd(mop);
557 /* Read the server config files */
558 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
562 if (backfs_mount_type_okay(ldd->ldd_mount_type))
563 ret = backfs_ops[ldd->ldd_mount_type]->read_ldd(dev, ldd);
571 /* Was this device formatted for Lustre */
572 int osd_is_lustre(char *dev, unsigned *mount_type)
576 vprint("checking for existing Lustre data: ");
578 for (i = 0; i < LDD_MT_LAST; ++i) {
579 if (backfs_ops[i] != NULL &&
580 backfs_ops[i]->is_lustre(dev, mount_type)) {
586 vprint("not found\n");
590 /* Build fs according to type */
591 int osd_make_lustre(struct mkfs_opts *mop)
593 struct lustre_disk_data *ldd = &mop->mo_ldd;
596 if (backfs_mount_type_okay(ldd->ldd_mount_type))
597 ret = backfs_ops[ldd->ldd_mount_type]->make_lustre(mop);
605 int osd_prepare_lustre(struct mkfs_opts *mop,
606 char *default_mountopts, int default_len,
607 char *always_mountopts, int always_len)
609 struct lustre_disk_data *ldd = &mop->mo_ldd;
612 if (backfs_mount_type_okay(ldd->ldd_mount_type))
613 ret = backfs_ops[ldd->ldd_mount_type]->prepare_lustre(mop,
614 default_mountopts, default_len,
615 always_mountopts, always_len);
623 int osd_tune_lustre(char *dev, struct mount_opts *mop)
625 struct lustre_disk_data *ldd = &mop->mo_ldd;
628 if (backfs_mount_type_okay(ldd->ldd_mount_type))
629 ret = backfs_ops[ldd->ldd_mount_type]->tune_lustre(dev, mop);
637 int osd_label_lustre(struct mount_opts *mop)
639 struct lustre_disk_data *ldd = &mop->mo_ldd;
642 if (backfs_mount_type_okay(ldd->ldd_mount_type))
643 ret = backfs_ops[ldd->ldd_mount_type]->label_lustre(mop);
651 /* Enable quota accounting */
652 int osd_enable_quota(struct mkfs_opts *mop)
654 struct lustre_disk_data *ldd = &mop->mo_ldd;
657 if (backfs_mount_type_okay(ldd->ldd_mount_type))
658 ret = backfs_ops[ldd->ldd_mount_type]->enable_quota(mop);
670 for (i = 0; i < LDD_MT_LAST; ++i) {
671 backfs_ops[i] = load_backfs_module(i);
672 if (backfs_ops[i] != NULL)
673 ret = backfs_ops[i]->init();
685 for (i = 0; i < LDD_MT_LAST; ++i) {
686 if (backfs_ops[i] != NULL) {
687 backfs_ops[i]->fini();
688 unload_backfs_module(backfs_ops[i]);
689 backfs_ops[i] = NULL;
694 __u64 get_device_size(char* device)
699 fd = open(device, O_RDONLY);
701 fprintf(stderr, "%s: cannot open %s: %s\n",
702 progname, device, strerror(errno));
707 /* size in bytes. bz5831 */
708 ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
713 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
714 size = (__u64)lsize * 512;
719 fprintf(stderr, "%s: size ioctl failed: %s\n",
720 progname, strerror(errno));
724 vprint("device size = "LPU64"MB\n", size >> 20);
725 /* return value in KB */
729 int file_create(char *path, __u64 size)
736 * Since "size" is in KB, the file offset it represents could overflow
739 size_max = (off_t)1 << (_FILE_OFFSET_BITS - 1 - 10);
740 if (size >= size_max) {
741 fprintf(stderr, "%s: "LPU64" KB: Backing store size must be "
742 "smaller than "LPU64" KB\n", progname, size, size_max);
746 ret = access(path, F_OK);
753 fd = creat(path, S_IRUSR|S_IWUSR);
756 fprintf(stderr, "%s: Unable to create backing store: %s\n",
757 progname, strerror(errno));
761 ret = ftruncate(fd, size * 1024);
765 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
766 progname, strerror(errno));