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 int append_param(char *buf, char *key, char *val, char sep)
149 int key_len, i, offset, old_val_len;
150 char *ptr = NULL, str[1024];
153 ptr = strstr(buf, key);
155 /* key doesn't exist yet, so just add it */
157 return add_param(buf, key, val);
159 key_len = strlen(key);
161 /* Copy previous values to str */
162 for (i = 0; i < sizeof(str); ++i) {
163 if ((ptr[i+key_len] == ' ') || (ptr[i+key_len] == '\0'))
165 str[i] = ptr[i+key_len];
167 if (i == sizeof(str))
171 offset = old_val_len+key_len;
173 /* Move rest of buf to overwrite previous key and value */
174 for (i = 0; ptr[i+offset] != '\0'; ++i)
175 ptr[i] = ptr[i+offset];
179 snprintf(str+old_val_len, sizeof(str)-old_val_len, "%c%s", sep, val);
181 return add_param(buf, key, str);
184 char *strscat(char *dst, char *src, int buflen)
187 if (strlen(dst) + strlen(src) >= buflen) {
188 fprintf(stderr, "string buffer overflow (max %d): '%s' + '%s'"
189 "\n", buflen, dst, src);
192 return strcat(dst, src);
195 char *strscpy(char *dst, char *src, int buflen)
198 return strscat(dst, src, buflen);
201 int check_mtab_entry(char *spec1, char *spec2, char *mtpt, char *type)
206 fp = setmntent(MOUNTED, "r");
210 while ((mnt = getmntent(fp)) != NULL) {
211 if ((strcmp(mnt->mnt_fsname, spec1) == 0 ||
212 strcmp(mnt->mnt_fsname, spec2) == 0) &&
213 (mtpt == NULL || strcmp(mnt->mnt_dir, mtpt) == 0) &&
214 (type == NULL || strcmp(mnt->mnt_type, type) == 0)) {
224 #define PROC_DIR "/proc/"
225 static int mtab_is_proc(const char *mtab)
229 if (readlink(mtab, path, sizeof(path)) < 0)
232 if (strncmp(path, PROC_DIR, strlen(PROC_DIR)))
238 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
239 int flags, int freq, int pass)
245 /* Don't update mtab if it is linked to any file in /proc direcotry.*/
246 if (mtab_is_proc(MOUNTED))
249 mnt.mnt_fsname = spec;
252 mnt.mnt_opts = opts ? opts : "";
254 mnt.mnt_passno = pass;
256 fp = setmntent(MOUNTED, "a+");
258 fprintf(stderr, "%s: setmntent(%s): %s:",
259 progname, MOUNTED, strerror (errno));
262 if ((addmntent(fp, &mnt)) == 1) {
263 fprintf(stderr, "%s: addmntent: %s:",
264 progname, strerror (errno));
273 /* Search for opt in mntlist, returning true if found.
275 static int in_mntlist(char *opt, char *mntlist)
277 char *ml, *mlp, *item, *ctx = NULL;
279 if (!(ml = strdup(mntlist))) {
280 fprintf(stderr, "%s: out of memory\n", progname);
284 while ((item = strtok_r(mlp, ",", &ctx))) {
285 if (!strcmp(opt, item))
290 return (item != NULL);
293 /* Issue a message on stderr for every item in wanted_mountopts that is not
294 * present in mountopts. The justwarn boolean toggles between error and
295 * warning message. Return an error count.
297 int check_mountfsoptions(char *mountopts, char *wanted_mountopts,
300 char *ml, *mlp, *item, *ctx = NULL;
303 if (!(ml = strdup(wanted_mountopts))) {
304 fprintf(stderr, "%s: out of memory\n", progname);
308 while ((item = strtok_r(mlp, ",", &ctx))) {
309 if (!in_mntlist(item, mountopts)) {
310 fprintf(stderr, "%s: %s mount option `%s' is missing\n",
311 progname, justwarn ? "Warning: default"
312 : "Error: mandatory", item);
321 /* Trim embedded white space, leading and trailing commas from string s.
323 void trim_mountfsoptions(char *s)
329 memmove(p, p + 1, strlen(p + 1) + 1);
336 memmove(&s[0], &s[1], strlen(&s[1]) + 1);
338 p = s + strlen(s) - 1;
339 while (p >= s && *p == ',')
343 /* Setup a file in the first unused loop_device */
344 int loop_setup(struct mkfs_opts *mop)
350 /* Figure out the loop device names */
351 if (!access("/dev/loop0", F_OK | R_OK) ||
352 !access("/dev/loop-control", F_OK | R_OK)) {
353 strcpy(loop_base, "/dev/loop\0");
354 } else if (!access("/dev/loop/0", F_OK | R_OK)) {
355 strcpy(loop_base, "/dev/loop/\0");
357 fprintf(stderr, "%s: can't access loop devices\n", progname);
361 /* Find unused loop device */
362 for (i = 0; i < MAX_LOOP_DEVICES; i++) {
364 int cmdsz = sizeof(cmd);
366 #ifdef LOOP_CTL_GET_FREE
367 ret = open("/dev/loop-control", O_RDWR);
369 fprintf(stderr, "%s: can't access loop control\n", progname);
372 /* find or allocate a free loop device to use */
373 i = ioctl(ret, LOOP_CTL_GET_FREE);
375 fprintf(stderr, "%s: access loop control error\n", progname);
378 sprintf(l_device, "%s%d", loop_base, i);
380 sprintf(l_device, "%s%d", loop_base, i);
381 if (access(l_device, F_OK | R_OK))
384 snprintf(cmd, cmdsz, "losetup %s > /dev/null 2>&1", l_device);
387 /* losetup gets 1 (ret=256) for non-set-up device */
389 /* Set up a loopback device to our file */
390 snprintf(cmd, cmdsz, "losetup %s %s", l_device,
392 ret = run_command(cmd, cmdsz);
394 /* someone else picked up this loop device
398 fprintf(stderr, "%s: error %d on losetup: %s\n",
400 ret >= 0 ? strerror(ret) : "");
403 strscpy(mop->mo_loopdev, l_device,
404 sizeof(mop->mo_loopdev));
409 fprintf(stderr, "%s: out of loop devices!\n", progname);
413 int loop_cleanup(struct mkfs_opts *mop)
418 if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
421 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
422 for (tries = 0; tries < 3; tries++) {
423 ret = run_command(cmd, sizeof(cmd));
431 fprintf(stderr, "cannot cleanup %s: rc = %d\n",
432 mop->mo_loopdev, ret);
436 int loop_format(struct mkfs_opts *mop)
440 if (mop->mo_device_kb == 0) {
442 fprintf(stderr, "loop device requires a --device-size= "
447 fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
450 fprintf(stderr, "%s: Unable to create backing store: %s\n",
451 progname, strerror(errno));
455 if (ftruncate(fd, mop->mo_device_kb * 1024) != 0) {
458 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
459 progname, strerror(errno));
467 #define DLSYM(prefix, sym, func) \
470 snprintf(_fname, sizeof(_fname), "%s_%s", prefix, #func); \
471 sym->func = (typeof(sym->func))dlsym(sym->dl_handle, _fname); \
475 * Load plugin for a given mount_type from ${pkglibdir}/mount_osd_FSTYPE.so and
476 * return struct of function pointers (will be freed in unloack_backfs_module).
478 * \param[in] mount_type Mount type to load module for.
479 * \retval Value of backfs_ops struct
480 * \retval NULL if no module exists
482 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type)
485 char *error, filename[512], fsname[512], *name;
486 struct module_backfs_ops *ops;
488 /* This deals with duplicate ldd_mount_types resolving to same OSD layer
489 * plugin (e.g. ext3/ldiskfs/ldiskfs2 all being ldiskfs) */
490 strlcpy(fsname, mt_type(mount_type), sizeof(fsname));
491 name = fsname + sizeof("osd-") - 1;
493 /* change osd- to osd_ */
494 fsname[sizeof("osd-") - 2] = '_';
496 snprintf(filename, sizeof(filename), PLUGIN_DIR"/mount_%s.so", fsname);
498 handle = dlopen(filename, RTLD_LAZY);
500 /* Check for $LUSTRE environment variable from test-framework.
501 * This allows using locally built modules to be used.
503 if (handle == NULL) {
505 dirname = getenv("LUSTRE");
507 snprintf(filename, sizeof(filename),
508 "%s/utils/.libs/mount_%s.so",
510 handle = dlopen(filename, RTLD_LAZY);
514 /* Do not clutter up console with missing types */
518 ops = malloc(sizeof(*ops));
524 ops->dl_handle = handle;
525 dlerror(); /* Clear any existing error */
527 DLSYM(name, ops, init);
528 DLSYM(name, ops, fini);
529 DLSYM(name, ops, read_ldd);
530 DLSYM(name, ops, write_ldd);
531 DLSYM(name, ops, is_lustre);
532 DLSYM(name, ops, make_lustre);
533 DLSYM(name, ops, prepare_lustre);
534 DLSYM(name, ops, tune_lustre);
535 DLSYM(name, ops, label_lustre);
536 DLSYM(name, ops, enable_quota);
541 fprintf(stderr, "%s\n", error);
550 * Unload plugin and free backfs_ops structure. Must be called the same number
551 * of times as load_backfs_module is.
553 void unload_backfs_module(struct module_backfs_ops *ops)
558 dlclose(ops->dl_handle);
562 /* Return true if backfs_ops has operations for the given mount_type. */
563 int backfs_mount_type_okay(enum ldd_mount_type mount_type)
565 if (unlikely(mount_type >= LDD_MT_LAST || mount_type < 0)) {
567 fprintf(stderr, "fs type out of range %d\n", mount_type);
570 if (backfs_ops[mount_type] == NULL) {
572 fprintf(stderr, "unhandled fs type %d '%s'\n",
573 mount_type, mt_str(mount_type));
579 /* Write the server config files */
580 int osd_write_ldd(struct mkfs_opts *mop)
582 struct lustre_disk_data *ldd = &mop->mo_ldd;
585 if (backfs_mount_type_okay(ldd->ldd_mount_type))
586 ret = backfs_ops[ldd->ldd_mount_type]->write_ldd(mop);
594 /* Read the server config files */
595 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
599 if (backfs_mount_type_okay(ldd->ldd_mount_type))
600 ret = backfs_ops[ldd->ldd_mount_type]->read_ldd(dev, ldd);
608 /* Was this device formatted for Lustre */
609 int osd_is_lustre(char *dev, unsigned *mount_type)
613 vprint("checking for existing Lustre data: ");
615 for (i = 0; i < LDD_MT_LAST; ++i) {
616 if (backfs_ops[i] != NULL &&
617 backfs_ops[i]->is_lustre(dev, mount_type)) {
623 vprint("not found\n");
627 /* Build fs according to type */
628 int osd_make_lustre(struct mkfs_opts *mop)
630 struct lustre_disk_data *ldd = &mop->mo_ldd;
633 if (backfs_mount_type_okay(ldd->ldd_mount_type))
634 ret = backfs_ops[ldd->ldd_mount_type]->make_lustre(mop);
642 int osd_prepare_lustre(struct mkfs_opts *mop,
643 char *default_mountopts, int default_len,
644 char *always_mountopts, int always_len)
646 struct lustre_disk_data *ldd = &mop->mo_ldd;
649 if (backfs_mount_type_okay(ldd->ldd_mount_type))
650 ret = backfs_ops[ldd->ldd_mount_type]->prepare_lustre(mop,
651 default_mountopts, default_len,
652 always_mountopts, always_len);
660 int osd_tune_lustre(char *dev, struct mount_opts *mop)
662 struct lustre_disk_data *ldd = &mop->mo_ldd;
665 if (backfs_mount_type_okay(ldd->ldd_mount_type))
666 ret = backfs_ops[ldd->ldd_mount_type]->tune_lustre(dev, mop);
674 int osd_label_lustre(struct mount_opts *mop)
676 struct lustre_disk_data *ldd = &mop->mo_ldd;
679 if (backfs_mount_type_okay(ldd->ldd_mount_type))
680 ret = backfs_ops[ldd->ldd_mount_type]->label_lustre(mop);
688 /* Enable quota accounting */
689 int osd_enable_quota(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]->enable_quota(mop);
707 for (i = 0; i < LDD_MT_LAST; ++i) {
708 backfs_ops[i] = load_backfs_module(i);
709 if (backfs_ops[i] != NULL)
710 ret = backfs_ops[i]->init();
722 for (i = 0; i < LDD_MT_LAST; ++i) {
723 if (backfs_ops[i] != NULL) {
724 backfs_ops[i]->fini();
725 unload_backfs_module(backfs_ops[i]);
726 backfs_ops[i] = NULL;
731 __u64 get_device_size(char* device)
736 fd = open(device, O_RDONLY);
738 fprintf(stderr, "%s: cannot open %s: %s\n",
739 progname, device, strerror(errno));
744 /* size in bytes. bz5831 */
745 ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
750 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
751 size = (__u64)lsize * 512;
756 fprintf(stderr, "%s: size ioctl failed: %s\n",
757 progname, strerror(errno));
761 vprint("device size = "LPU64"MB\n", size >> 20);
762 /* return value in KB */
766 int file_create(char *path, __u64 size)
773 * Since "size" is in KB, the file offset it represents could overflow
776 size_max = (off_t)1 << (_FILE_OFFSET_BITS - 1 - 10);
777 if (size >= size_max) {
778 fprintf(stderr, "%s: "LPU64" KB: Backing store size must be "
779 "smaller than "LPU64" KB\n", progname, size, size_max);
783 ret = access(path, F_OK);
790 fd = creat(path, S_IRUSR|S_IWUSR);
793 fprintf(stderr, "%s: Unable to create backing store: %s\n",
794 progname, strerror(errno));
798 ret = ftruncate(fd, size * 1024);
802 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
803 progname, strerror(errno));