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>
51 extern char *progname;
54 #define vprint(fmt, arg...) if (verbose > 0) printf(fmt, ##arg)
55 #define verrprint(fmt, arg...) if (verbose >= 0) fprintf(stderr, fmt, ##arg)
57 static struct module_backfs_ops *backfs_ops[LDD_MT_LAST];
62 fprintf(stderr, "\n%s FATAL: ", progname);
65 int run_command(char *cmd, int cmdsz)
67 char log[] = "/tmp/run_command_logXXXXXX";
70 if ((cmdsz - strlen(cmd)) < 6) {
72 fprintf(stderr, "Command buffer overflow: %.*s...\n",
78 printf("cmd: %s\n", cmd);
80 if ((fd = mkstemp(log)) >= 0) {
88 /* Can't use popen because we need the rv of the command */
90 if (rc && (fd >= 0)) {
95 while (fgets(buf, sizeof(buf), fp) != NULL) {
106 int add_param(char *buf, char *key, char *val)
108 int end = sizeof(((struct lustre_disk_data *)0)->ldd_params);
109 int start = strlen(buf);
113 keylen = strlen(key);
114 if (start + 1 + keylen + strlen(val) >= end) {
115 fprintf(stderr, "%s: params are too long-\n%s %s%s\n",
116 progname, buf, key ? key : "", val);
120 sprintf(buf + start, " %s%s", key ? key : "", val);
124 int get_param(char *buf, char *key, char **val)
126 int i, key_len = strlen(key);
129 ptr = strstr(buf, key);
131 *val = strdup(ptr + key_len);
135 for (i = 0; i < strlen(*val); i++)
136 if (((*val)[i] == ' ') || ((*val)[i] == '\0'))
146 char *strscat(char *dst, char *src, int buflen)
149 if (strlen(dst) + strlen(src) >= buflen) {
150 fprintf(stderr, "string buffer overflow (max %d): '%s' + '%s'"
151 "\n", buflen, dst, src);
154 return strcat(dst, src);
157 char *strscpy(char *dst, char *src, int buflen)
160 return strscat(dst, src, buflen);
163 int check_mtab_entry(char *spec1, char *spec2, char *mtpt, char *type)
168 fp = setmntent(MOUNTED, "r");
172 while ((mnt = getmntent(fp)) != NULL) {
173 if ((strcmp(mnt->mnt_fsname, spec1) == 0 ||
174 strcmp(mnt->mnt_fsname, spec2) == 0) &&
175 (mtpt == NULL || strcmp(mnt->mnt_dir, mtpt) == 0) &&
176 (type == NULL || strcmp(mnt->mnt_type, type) == 0)) {
186 #define PROC_DIR "/proc/"
187 static int mtab_is_proc(const char *mtab)
191 if (readlink(mtab, path, sizeof(path)) < 0)
194 if (strncmp(path, PROC_DIR, strlen(PROC_DIR)))
200 int update_mtab_entry(char *spec, char *mtpt, char *type, char *opts,
201 int flags, int freq, int pass)
207 /* Don't update mtab if it is linked to any file in /proc direcotry.*/
208 if (mtab_is_proc(MOUNTED))
211 mnt.mnt_fsname = spec;
214 mnt.mnt_opts = opts ? opts : "";
216 mnt.mnt_passno = pass;
218 fp = setmntent(MOUNTED, "a+");
220 fprintf(stderr, "%s: setmntent(%s): %s:",
221 progname, MOUNTED, strerror (errno));
224 if ((addmntent(fp, &mnt)) == 1) {
225 fprintf(stderr, "%s: addmntent: %s:",
226 progname, strerror (errno));
235 /* Search for opt in mntlist, returning true if found.
237 static int in_mntlist(char *opt, char *mntlist)
239 char *ml, *mlp, *item, *ctx = NULL;
241 if (!(ml = strdup(mntlist))) {
242 fprintf(stderr, "%s: out of memory\n", progname);
246 while ((item = strtok_r(mlp, ",", &ctx))) {
247 if (!strcmp(opt, item))
252 return (item != NULL);
255 /* Issue a message on stderr for every item in wanted_mountopts that is not
256 * present in mountopts. The justwarn boolean toggles between error and
257 * warning message. Return an error count.
259 int check_mountfsoptions(char *mountopts, char *wanted_mountopts,
262 char *ml, *mlp, *item, *ctx = NULL;
265 if (!(ml = strdup(wanted_mountopts))) {
266 fprintf(stderr, "%s: out of memory\n", progname);
270 while ((item = strtok_r(mlp, ",", &ctx))) {
271 if (!in_mntlist(item, mountopts)) {
272 fprintf(stderr, "%s: %s mount option `%s' is missing\n",
273 progname, justwarn ? "Warning: default"
274 : "Error: mandatory", item);
283 /* Trim embedded white space, leading and trailing commas from string s.
285 void trim_mountfsoptions(char *s)
291 memmove(p, p + 1, strlen(p + 1) + 1);
298 memmove(&s[0], &s[1], strlen(&s[1]) + 1);
300 p = s + strlen(s) - 1;
301 while (p >= s && *p == ',')
305 /* Setup a file in the first unused loop_device */
306 int loop_setup(struct mkfs_opts *mop)
312 /* Figure out the loop device names */
313 if (!access("/dev/loop0", F_OK | R_OK)) {
314 strcpy(loop_base, "/dev/loop\0");
315 } else if (!access("/dev/loop/0", F_OK | R_OK)) {
316 strcpy(loop_base, "/dev/loop/\0");
318 fprintf(stderr, "%s: can't access loop devices\n", progname);
322 /* Find unused loop device */
323 for (i = 0; i < MAX_LOOP_DEVICES; i++) {
325 int cmdsz = sizeof(cmd);
327 sprintf(l_device, "%s%d", loop_base, i);
328 if (access(l_device, F_OK | R_OK))
330 snprintf(cmd, cmdsz, "losetup %s > /dev/null 2>&1", l_device);
333 /* losetup gets 1 (ret=256) for non-set-up device */
335 /* Set up a loopback device to our file */
336 snprintf(cmd, cmdsz, "losetup %s %s", l_device,
338 ret = run_command(cmd, cmdsz);
340 /* someone else picked up this loop device
344 fprintf(stderr, "%s: error %d on losetup: %s\n",
346 ret >= 0 ? strerror(ret) : "");
349 strscpy(mop->mo_loopdev, l_device,
350 sizeof(mop->mo_loopdev));
355 fprintf(stderr, "%s: out of loop devices!\n", progname);
359 int loop_cleanup(struct mkfs_opts *mop)
364 if ((mop->mo_flags & MO_IS_LOOP) && *mop->mo_loopdev) {
367 sprintf(cmd, "losetup -d %s", mop->mo_loopdev);
368 for (tries = 0; tries < 3; tries++) {
369 ret = run_command(cmd, sizeof(cmd));
377 fprintf(stderr, "cannot cleanup %s: rc = %d\n",
378 mop->mo_loopdev, ret);
382 int loop_format(struct mkfs_opts *mop)
386 if (mop->mo_device_sz == 0) {
388 fprintf(stderr, "loop device requires a --device-size= "
393 fd = creat(mop->mo_device, S_IRUSR|S_IWUSR);
396 fprintf(stderr, "%s: Unable to create backing store: %s\n",
397 progname, strerror(errno));
401 if (ftruncate(fd, mop->mo_device_sz * 1024) != 0) {
404 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
405 progname, strerror(errno));
413 #define DLSYM(prefix, sym, func) \
416 snprintf(_fname, sizeof(_fname), "%s_%s", prefix, #func); \
417 sym->func = (typeof(sym->func))dlsym(sym->dl_handle, _fname); \
421 * Load plugin for a given mount_type from ${pkglibdir}/mount_osd_FSTYPE.so and
422 * return struct of function pointers (will be freed in unloack_backfs_module).
424 * \param[in] mount_type Mount type to load module for.
425 * \retval Value of backfs_ops struct
426 * \retval NULL if no module exists
428 struct module_backfs_ops *load_backfs_module(enum ldd_mount_type mount_type)
431 char *error, filename[512], fsname[512], *name;
432 struct module_backfs_ops *ops;
434 /* This deals with duplicate ldd_mount_types resolving to same OSD layer
435 * plugin (e.g. ext3/ldiskfs/ldiskfs2 all being ldiskfs) */
436 strncpy(fsname, mt_type(mount_type), sizeof(fsname));
437 name = fsname + sizeof("osd-") - 1;
439 /* change osd- to osd_ */
440 fsname[sizeof("osd-") - 2] = '_';
442 snprintf(filename, sizeof(filename), PLUGIN_DIR"/mount_%s.so", fsname);
444 handle = dlopen(filename, RTLD_LAZY);
446 /* Do not clutter up console with missing types */
449 ops = malloc(sizeof(*ops));
455 ops->dl_handle = handle;
456 dlerror(); /* Clear any existing error */
458 DLSYM(name, ops, init);
459 DLSYM(name, ops, fini);
460 DLSYM(name, ops, read_ldd);
461 DLSYM(name, ops, write_ldd);
462 DLSYM(name, ops, is_lustre);
463 DLSYM(name, ops, make_lustre);
464 DLSYM(name, ops, prepare_lustre);
465 DLSYM(name, ops, tune_lustre);
466 DLSYM(name, ops, label_lustre);
467 DLSYM(name, ops, enable_quota);
472 fprintf(stderr, "%s\n", error);
481 * Unload plugin and free backfs_ops structure. Must be called the same number
482 * of times as load_backfs_module is.
484 void unload_backfs_module(struct module_backfs_ops *ops)
489 dlclose(ops->dl_handle);
493 /* Return true if backfs_ops has operations for the given mount_type. */
494 int backfs_mount_type_okay(enum ldd_mount_type mount_type)
496 if (unlikely(mount_type >= LDD_MT_LAST || mount_type < 0)) {
498 fprintf(stderr, "fs type out of range %d\n", mount_type);
501 if (backfs_ops[mount_type] == NULL) {
503 fprintf(stderr, "unhandled fs type %d '%s'\n",
504 mount_type, mt_str(mount_type));
510 /* Write the server config files */
511 int osd_write_ldd(struct mkfs_opts *mop)
513 struct lustre_disk_data *ldd = &mop->mo_ldd;
516 if (backfs_mount_type_okay(ldd->ldd_mount_type))
517 ret = backfs_ops[ldd->ldd_mount_type]->write_ldd(mop);
525 /* Read the server config files */
526 int osd_read_ldd(char *dev, struct lustre_disk_data *ldd)
530 if (backfs_mount_type_okay(ldd->ldd_mount_type))
531 ret = backfs_ops[ldd->ldd_mount_type]->read_ldd(dev, ldd);
539 /* Was this device formatted for Lustre */
540 int osd_is_lustre(char *dev, unsigned *mount_type)
544 vprint("checking for existing Lustre data: ");
546 for (i = 0; i < LDD_MT_LAST; ++i) {
547 if (backfs_ops[i] != NULL &&
548 backfs_ops[i]->is_lustre(dev, mount_type)) {
554 vprint("not found\n");
558 /* Build fs according to type */
559 int osd_make_lustre(struct mkfs_opts *mop)
561 struct lustre_disk_data *ldd = &mop->mo_ldd;
564 if (backfs_mount_type_okay(ldd->ldd_mount_type))
565 ret = backfs_ops[ldd->ldd_mount_type]->make_lustre(mop);
573 int osd_prepare_lustre(struct mkfs_opts *mop,
574 char *default_mountopts, int default_len,
575 char *always_mountopts, int always_len)
577 struct lustre_disk_data *ldd = &mop->mo_ldd;
580 if (backfs_mount_type_okay(ldd->ldd_mount_type))
581 ret = backfs_ops[ldd->ldd_mount_type]->prepare_lustre(mop,
582 default_mountopts, default_len,
583 always_mountopts, always_len);
591 int osd_tune_lustre(char *dev, struct mount_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]->tune_lustre(dev, mop);
605 int osd_label_lustre(struct mount_opts *mop)
607 struct lustre_disk_data *ldd = &mop->mo_ldd;
610 if (backfs_mount_type_okay(ldd->ldd_mount_type))
611 ret = backfs_ops[ldd->ldd_mount_type]->label_lustre(mop);
619 /* Enable quota accounting */
620 int osd_enable_quota(struct mkfs_opts *mop)
622 struct lustre_disk_data *ldd = &mop->mo_ldd;
625 if (backfs_mount_type_okay(ldd->ldd_mount_type))
626 ret = backfs_ops[ldd->ldd_mount_type]->enable_quota(mop);
638 for (i = 0; i < LDD_MT_LAST; ++i) {
639 backfs_ops[i] = load_backfs_module(i);
640 if (backfs_ops[i] != NULL)
641 ret = backfs_ops[i]->init();
653 for (i = 0; i < LDD_MT_LAST; ++i) {
654 if (backfs_ops[i] != NULL) {
655 backfs_ops[i]->fini();
656 unload_backfs_module(backfs_ops[i]);
657 backfs_ops[i] = NULL;
662 __u64 get_device_size(char* device)
667 fd = open(device, O_RDONLY);
669 fprintf(stderr, "%s: cannot open %s: %s\n",
670 progname, device, strerror(errno));
675 /* size in bytes. bz5831 */
676 ret = ioctl(fd, BLKGETSIZE64, (void*)&size);
681 ret = ioctl(fd, BLKGETSIZE, (void*)&lsize);
682 size = (__u64)lsize * 512;
687 fprintf(stderr, "%s: size ioctl failed: %s\n",
688 progname, strerror(errno));
692 vprint("device size = "LPU64"MB\n", size >> 20);
693 /* return value in KB */
697 int file_create(char *path, __u64 size)
704 * Since "size" is in KB, the file offset it represents could overflow
707 size_max = (off_t)1 << (_FILE_OFFSET_BITS - 1 - 10);
708 if (size >= size_max) {
709 fprintf(stderr, "%s: "LPU64" KB: Backing store size must be "
710 "smaller than "LPU64" KB\n", progname, size, size_max);
714 ret = access(path, F_OK);
721 fd = creat(path, S_IRUSR|S_IWUSR);
724 fprintf(stderr, "%s: Unable to create backing store: %s\n",
725 progname, strerror(errno));
729 ret = ftruncate(fd, size * 1024);
733 fprintf(stderr, "%s: Unable to truncate backing store: %s\n",
734 progname, strerror(errno));