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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/utils/mkfs_lustre.c
38 * Author: Nathan Rutman <nathan@clusterfs.com>
41 /* This source file is compiled into both mkfs.lustre and tunefs.lustre */
45 #endif /* HAVE_CONFIG_H */
50 #include "mount_utils.h"
59 #include <sys/types.h>
61 #include <sys/mount.h>
62 #include <sys/utsname.h>
68 #include <lnet/nidstr.h>
69 #include <lustre_disk.h>
70 #include <lustre_param.h>
71 #include <lnet/lnetctl.h>
72 #include <lustre_ver.h>
81 static int print_only = 0;
83 #ifdef HAVE_LDISKFS_OSD
84 #define FSLIST_LDISKFS "ldiskfs"
87 #define FSLIST_LDISKFS ""
88 #endif /* HAVE_LDISKFS_OSD */
91 #define FSLIST_ZFS "|zfs"
93 #define FSLIST_ZFS "zfs"
98 #endif /* HAVE_ZFS_OSD */
101 #error "no backing OSD types (ldiskfs or ZFS) are configured"
104 #define FSLIST FSLIST_LDISKFS FSLIST_ZFS
106 void usage(FILE *out)
108 fprintf(out, "usage: %s <target type> [--backfstype="FSLIST"] "
109 "--fsname=<filesystem name>\n"
110 "\t--index=<target index> [options] <device>\n", progname);
112 fprintf(out, "usage: %s <target type> --backfstype=zfs "
113 "--fsname=<filesystem name> [options]\n"
114 "\t<pool name>/<dataset name>\n"
115 "\t[[<vdev type>] <device> [<device> ...] [vdev type>] ...]\n",
119 "\t<device>:block device or file (e.g /dev/sda or /tmp/ost1)\n"
121 "\t<pool name>: name of ZFS pool where target is created "
123 "\t<dataset name>: name of new dataset, must be unique within "
125 "\t<vdev type>: type of vdev (mirror, raidz, raidz2, spare, "
130 "\t\t--mgs: configuration management service\n"
131 "\t\t--mdt: metadata storage, mutually exclusive with ost\n"
132 "\t\t--ost: object storage, mutually exclusive with mdt, mgs\n"
133 "\toptions (in order of popularity):\n"
134 "\t\t--index=#N: numerical target index (0..N)\n"
135 "\t\t\trequired for all targets other than the MGS\n"
136 "\t\t--fsname=<8_char_filesystem_name>: fs targets belong to\n"
137 "\t\t\trequired for all targets other than MGS\n"
138 "\t\t--mgsnode=<nid>[,<...>]: NID(s) of remote MGS\n"
139 "\t\t\trequired for all targets other than MGS\n"
140 "\t\t--mountfsoptions=<opts>: permanent Lustre mount options\n"
141 "\t\t--backfs-mount-opts=<opts>: backing fs mount options\n"
142 "\t\t--failnode=<nid>[,<...>]: NID(s) of backup failover node\n"
143 "\t\t\tmutually exclusive with --servicenode\n"
144 "\t\t--servicenode=<nid>[,<...>]: NID(s) of service partners\n"
145 "\t\t\ttreat nodes as equal service node, mutually exclusive "
147 "\t\t--param <key>=<value>: set a permanent parameter\n"
148 "\t\t\te.g. --param sys.timeout=40\n"
149 "\t\t\t --param lov.stripesize=2M\n"
150 "\t\t--network=<net>[,<...>]: restrict OST/MDT to network(s)\n"
152 "\t\t--backfstype=<fstype>: backing fs type (ext3, ldiskfs)\n"
153 "\t\t--device-size=#N(KB): device size for loop devices\n"
154 "\t\t--mkfsoptions=<opts>: format options\n"
155 "\t\t--reformat: overwrite an existing disk\n"
156 "\t\t--replace: replace an old target with the same index\n"
157 "\t\t--stripe-count-hint=#N: for optimizing MDT inode size\n"
159 "\t\t--erase-params: erase all old parameter settings\n"
160 "\t\t--nomgs: turn off MGS service on this MDT\n"
161 "\t\t--writeconf: erase all config logs for this fs.\n"
162 "\t\t--quota: enable space accounting on old 2.x device.\n"
164 "\t\t--comment=<user comment>: arbitrary string (%d bytes)\n"
165 "\t\t--dryrun: report what we would do; don't write to disk\n"
166 "\t\t--verbose: e.g. show mkfs progress\n"
167 "\t\t-V|--version: output build version of the utility and\n"
170 (int)sizeof(((struct lustre_disk_data *)0)->ldd_userdata));
174 /* ==================== Lustre config functions =============*/
176 void print_ldd(char *str, struct lustre_disk_data *ldd)
178 printf("\n %s:\n", str);
179 printf("Target: %s\n", ldd->ldd_svname);
180 if (ldd->ldd_svindex == INDEX_UNASSIGNED)
181 printf("Index: unassigned\n");
183 printf("Index: %d\n", ldd->ldd_svindex);
184 if (ldd->ldd_uuid[0])
185 printf("UUID: %s\n", (char *)ldd->ldd_uuid);
186 printf("Lustre FS: %s\n", ldd->ldd_fsname);
187 printf("Mount type: %s\n", MT_STR(ldd));
188 printf("Flags: %#x\n", ldd->ldd_flags);
189 printf(" (%s%s%s%s%s%s%s%s%s)\n",
190 IS_MDT(ldd) ? "MDT ":"",
191 IS_OST(ldd) ? "OST ":"",
192 IS_MGS(ldd) ? "MGS ":"",
193 ldd->ldd_flags & LDD_F_NEED_INDEX ? "needs_index ":"",
194 ldd->ldd_flags & LDD_F_VIRGIN ? "first_time ":"",
195 ldd->ldd_flags & LDD_F_UPDATE ? "update ":"",
196 ldd->ldd_flags & LDD_F_WRITECONF ? "writeconf ":"",
197 ldd->ldd_flags & LDD_F_NO_PRIMNODE? "no_primnode ":"",
198 ldd->ldd_flags & LDD_F_UPGRADE14 ? "upgrade1.4 ":"");
199 printf("Persistent mount opts: %s\n", ldd->ldd_mount_opts);
200 printf("Parameters:%s\n", ldd->ldd_params);
201 if (ldd->ldd_userdata[0])
202 printf("Comment: %s\n", ldd->ldd_userdata);
206 void set_defaults(struct mkfs_opts *mop)
208 mop->mo_ldd.ldd_magic = LDD_MAGIC;
209 mop->mo_ldd.ldd_config_ver = 1;
210 mop->mo_ldd.ldd_flags = LDD_F_NEED_INDEX | LDD_F_UPDATE | LDD_F_VIRGIN;
211 #ifdef HAVE_LDISKFS_OSD
212 mop->mo_ldd.ldd_mount_type = LDD_MT_LDISKFS;
214 mop->mo_ldd.ldd_mount_type = LDD_MT_ZFS;
216 mop->mo_ldd.ldd_svindex = INDEX_UNASSIGNED;
217 mop->mo_mgs_failnodes = 0;
218 mop->mo_stripe_count = 1;
219 mop->mo_pool_vdevs = NULL;
222 static inline void badopt(const char *opt, char *type)
224 fprintf(stderr, "%s: '--%s' only valid for %s\n",
225 progname, opt, type);
229 /* from mount_lustre */
230 /* Get rid of symbolic hostnames for tcp, since kernel can't do lookups */
231 #define MAXNIDSTR 1024
232 static char *convert_hostnames(char *s1)
234 char *converted, *s2 = 0, *c, *end, sep;
235 int left = MAXNIDSTR;
238 converted = malloc(left);
239 if (converted == NULL) {
243 end = s1 + strlen(s1);
245 while ((left > 0) && (s1 < end)) {
246 s2 = strpbrk(s1, ",:");
251 nid = libcfs_str2nid(s1);
254 if (nid == LNET_NID_ANY) {
255 fprintf(stderr, "%s: Cannot resolve hostname '%s'.\n",
260 if (strncmp(libcfs_nid2str(nid), "127.0.0.1",
261 strlen("127.0.0.1")) == 0) {
262 fprintf(stderr, "%s: The NID '%s' resolves to the "
263 "loopback address '%s'. Lustre requires a "
264 "non-loopback address.\n",
265 progname, s1, libcfs_nid2str(nid));
270 c += snprintf(c, left, "%s%c", libcfs_nid2str(nid), sep);
271 left = converted + MAXNIDSTR - c;
277 int parse_opts(int argc, char *const argv[], struct mkfs_opts *mop,
280 static struct option long_opt[] = {
281 { "backfstype", required_argument, NULL, 'b' },
282 { "backfs-mount-opts", required_argument, NULL, 'B' },
283 { "stripe-count-hint", required_argument, NULL, 'c' },
284 { "comment", required_argument, NULL, 'u' },
285 { "configdev", required_argument, NULL, 'C' },
286 { "device-size", required_argument, NULL, 'd' },
287 { "dryrun", no_argument, NULL, 'n' },
288 { "erase-params", no_argument, NULL, 'e' },
289 { "failnode", required_argument, NULL, 'f' },
290 { "failover", required_argument, NULL, 'f' },
291 { "mgs", no_argument, NULL, 'G' },
292 { "help", no_argument, NULL, 'h' },
293 { "index", required_argument, NULL, 'i' },
294 { "mkfsoptions", required_argument, NULL, 'k' },
295 { "mgsnode", required_argument, NULL, 'm' },
296 { "mgsnid", required_argument, NULL, 'm' },
297 { "mdt", no_argument, NULL, 'M' },
298 { "fsname", required_argument, NULL, 'L' },
299 { "noformat", no_argument, NULL, 'n' },
300 { "nomgs", no_argument, NULL, 'N' },
301 { "mountfsoptions", required_argument, NULL, 'o' },
302 { "ost", no_argument, NULL, 'O' },
303 { "param", required_argument, NULL, 'p' },
304 { "print", no_argument, NULL, 'n' },
305 { "quiet", no_argument, NULL, 'q' },
306 { "quota", no_argument, NULL, 'Q' },
307 { "reformat", no_argument, NULL, 'r' },
308 { "replace", no_argument, NULL, 'R' },
309 { "servicenode", required_argument, NULL, 's' },
310 { "network", required_argument, NULL, 't' },
311 { "verbose", no_argument, NULL, 'v' },
312 { "version", no_argument, NULL, 'V' },
313 { "writeconf", no_argument, NULL, 'w' },
316 char *optstring = "b:c:C:d:ef:Ghi:k:L:m:MnNo:Op:PqrRs:t:Uu:vVw";
319 int failnode_set = 0, servicenode_set = 0;
321 bool index_option = false;
322 bool fsname_option = false;
324 while ((opt = getopt_long(argc, argv, optstring, long_opt, &longidx)) !=
329 while (i < LDD_MT_LAST) {
330 if (strcmp(optarg, mt_str(i)) == 0) {
331 mop->mo_ldd.ldd_mount_type = i;
336 if (i == LDD_MT_LAST) {
337 fprintf(stderr, "%s: invalid backend filesystem"
338 " type %s\n", progname, optarg);
344 mop->mo_mountopts = optarg;
347 if (IS_MDT(&mop->mo_ldd)) {
348 int stripe_count = atol(optarg);
349 if (stripe_count <= 0) {
350 fprintf(stderr, "%s: bad stripe count "
351 "%d\n", progname, stripe_count);
354 mop->mo_stripe_count = stripe_count;
356 badopt(long_opt[longidx].name, "MDT");
360 case 'C': /* Configdev */
362 printf("Configdev not implemented\n");
365 mop->mo_device_kb = atol(optarg);
368 mop->mo_ldd.ldd_params[0] = '\0';
369 /* Must update the mgs logs */
370 mop->mo_ldd.ldd_flags |= LDD_F_UPDATE;
376 if ((opt == 'f' && servicenode_set)
377 || (opt == 's' && failnode_set)) {
378 fprintf(stderr, "%s: %s cannot use with --%s\n",
379 progname, long_opt[longidx].name,
380 opt == 'f' ? "servicenode" : "failnode");
384 nids = convert_hostnames(optarg);
387 rc = append_param(mop->mo_ldd.ldd_params,
388 PARAM_FAILNODE, nids, ':');
392 /* Must update the mgs logs */
393 mop->mo_ldd.ldd_flags |= LDD_F_UPDATE;
397 mop->mo_ldd.ldd_flags |= LDD_F_NO_PRIMNODE;
400 mop->mo_flags |= MO_FAILOVER;
404 mop->mo_ldd.ldd_flags |= LDD_F_SV_TYPE_MGS;
411 /* LU-2374: check whether it is OST/MDT later */
412 mop->mo_ldd.ldd_svindex = atol(optarg);
413 if (mop->mo_ldd.ldd_svindex >= INDEX_UNASSIGNED) {
414 fprintf(stderr, "%s: wrong index %u. "
415 "Target index must be less than %u.\n",
416 progname, mop->mo_ldd.ldd_svindex,
420 mop->mo_ldd.ldd_flags &= ~LDD_F_NEED_INDEX;
423 strscpy(mop->mo_mkfsopts, optarg,
424 sizeof(mop->mo_mkfsopts));
427 rc = lustre_is_fsname_valid(optarg, 1,
430 fprintf(stderr, "%s: filesystem name must be "
431 "1-%d chars\n", progname,
435 fprintf(stderr, "%s: char '%c' not allowed in "
436 "filesystem name\n", progname, rc);
440 strscpy(mop->mo_ldd.ldd_fsname, optarg,
441 sizeof(mop->mo_ldd.ldd_fsname));
442 fsname_option = true;
446 char *nids = convert_hostnames(optarg);
449 rc = append_param(mop->mo_ldd.ldd_params,
450 PARAM_MGSNODE, nids, ':');
454 mop->mo_mgs_failnodes++;
458 mop->mo_ldd.ldd_flags |= LDD_F_SV_TYPE_MDT;
464 mop->mo_ldd.ldd_flags &= ~LDD_F_SV_TYPE_MGS;
470 mop->mo_ldd.ldd_flags |= LDD_F_SV_TYPE_OST;
473 rc = add_param(mop->mo_ldd.ldd_params, NULL, optarg);
476 /* Must update the mgs logs */
477 mop->mo_ldd.ldd_flags |= LDD_F_UPDATE;
483 mop->mo_flags |= MO_FORCEFORMAT;
489 if (!IS_MDT(&mop->mo_ldd) && !IS_OST(&mop->mo_ldd)) {
490 badopt(long_opt[longidx].name, "MDT,OST");
497 rc = add_param(mop->mo_ldd.ldd_params,
498 PARAM_NETWORK, optarg);
501 /* Must update the mgs logs */
502 mop->mo_ldd.ldd_flags |= LDD_F_UPDATE;
505 strscpy(mop->mo_ldd.ldd_userdata, optarg,
506 sizeof(mop->mo_ldd.ldd_userdata));
513 fprintf(stdout, "%s %s\n", progname,
514 LUSTRE_VERSION_STRING);
517 mop->mo_ldd.ldd_flags |= LDD_F_WRITECONF;
520 mop->mo_flags |= MO_QUOTA;
525 fprintf(stderr, "Unknown option '%c'\n", opt);
532 !(mop->mo_flags & MO_FORCEFORMAT) &&
533 (!(mop->mo_ldd.ldd_flags &
534 (LDD_F_UPGRADE14 | LDD_F_VIRGIN |
535 LDD_F_WRITECONF)))) {
536 fprintf(stderr, "%s: cannot change the name of"
537 " a registered target\n", progname);
540 if (index_option && !(mop->mo_ldd.ldd_flags &
541 (LDD_F_UPGRADE14 | LDD_F_VIRGIN |
543 fprintf(stderr, "%s: cannot change the index of"
544 " a registered target\n", progname);
548 /* Need to clear this flag after parsing 'L' and 'i' options. */
550 mop->mo_ldd.ldd_flags &= ~LDD_F_VIRGIN;
552 if (optind == argc) {
553 /* The user didn't specify device name */
555 fprintf(stderr, "Not enough arguments - device name or "
556 "pool/dataset name not specified.\n");
559 /* The device or pool/filesystem name */
560 strscpy(mop->mo_device, argv[optind], sizeof(mop->mo_device));
562 /* Followed by optional vdevs */
563 if (optind < argc - 1)
564 mop->mo_pool_vdevs = (char **) &argv[optind + 1];
570 int main(int argc, char *const argv[])
572 struct mkfs_opts mop;
573 struct lustre_disk_data *ldd;
574 char *mountopts = NULL;
575 char always_mountopts[512] = "";
576 char default_mountopts[512] = "";
581 if ((progname = strrchr(argv[0], '/')) != NULL)
586 if ((argc < 2) || (argv[argc - 1][0] == '-')) {
591 memset(&mop, 0, sizeof(mop));
594 /* device is last arg */
595 strscpy(mop.mo_device, argv[argc - 1], sizeof(mop.mo_device));
602 /* For tunefs, we must read in the old values before parsing any
605 /* Check whether the disk has already been formatted by mkfs.lustre */
606 ret = osd_is_lustre(mop.mo_device, &mount_type);
609 fprintf(stderr, "Device %s has not been formatted with "
610 "mkfs.lustre\n", mop.mo_device);
614 mop.mo_ldd.ldd_mount_type = mount_type;
616 ret = osd_read_ldd(mop.mo_device, &mop.mo_ldd);
619 fprintf(stderr, "Failed to read previous Lustre data from %s "
620 "(%d)\n", mop.mo_device, ret);
623 mop.mo_ldd.ldd_flags &= ~(LDD_F_WRITECONF | LDD_F_VIRGIN);
625 /* svname of the form lustre:OST1234 means never registered */
626 ret = strlen(mop.mo_ldd.ldd_svname);
627 if (mop.mo_ldd.ldd_svname[ret - 8] == ':') {
628 mop.mo_ldd.ldd_svname[ret - 8] = '-';
629 mop.mo_ldd.ldd_flags |= LDD_F_VIRGIN;
630 } else if (mop.mo_ldd.ldd_svname[ret - 8] == '=') {
631 mop.mo_ldd.ldd_svname[ret - 8] = '-';
632 mop.mo_ldd.ldd_flags |= LDD_F_WRITECONF;
635 if (strstr(mop.mo_ldd.ldd_params, PARAM_MGSNODE))
636 mop.mo_mgs_failnodes++;
639 print_ldd("Read previous values", &(mop.mo_ldd));
642 ret = parse_opts(argc, argv, &mop, &mountopts);
648 if (!(IS_MDT(ldd) || IS_OST(ldd) || IS_MGS(ldd))) {
650 fprintf(stderr, "must set target type: MDT,OST,MGS\n");
655 if (((IS_MDT(ldd) || IS_MGS(ldd))) && IS_OST(ldd)) {
657 fprintf(stderr, "OST type is exclusive with MDT,MGS\n");
662 /* Stand alone MGS doesn't need an index */
663 if (!IS_MDT(ldd) && IS_MGS(ldd)) {
664 #ifndef TUNEFS /* mkfs.lustre */
665 /* But if --index was specified flag an error */
666 if (!(mop.mo_ldd.ldd_flags & LDD_F_NEED_INDEX)) {
667 badopt("index", "MDT,OST");
671 mop.mo_ldd.ldd_flags &= ~LDD_F_NEED_INDEX;
674 if ((mop.mo_ldd.ldd_flags & (LDD_F_NEED_INDEX | LDD_F_UPGRADE14)) ==
675 (LDD_F_NEED_INDEX | LDD_F_UPGRADE14)) {
677 fprintf(stderr, "Can't find the target index, "
678 "specify with --index\n");
683 if (mop.mo_ldd.ldd_flags & LDD_F_NEED_INDEX)
684 fprintf(stderr, "warning: %s: for Lustre 2.4 and later, the "
685 "target index must be specified with --index\n",
688 /* If no index is supplied for MDT by default set index to zero */
689 if (IS_MDT(ldd) && (ldd->ldd_svindex == INDEX_UNASSIGNED)) {
690 mop.mo_ldd.ldd_flags &= ~LDD_F_NEED_INDEX;
691 mop.mo_ldd.ldd_svindex = 0;
693 if (!IS_MGS(ldd) && (mop.mo_mgs_failnodes == 0)) {
696 fprintf(stderr, "Must specify --mgs or --mgsnode\n");
698 fprintf(stderr, "Must specify --mgsnode\n");
702 if ((IS_MDT(ldd) || IS_OST(ldd)) && mop.mo_ldd.ldd_fsname[0] == '\0') {
704 fprintf(stderr, "Must specify --fsname for MDT/OST device\n");
709 /* These are the permanent mount options (always included) */
710 ret = osd_prepare_lustre(&mop,
711 default_mountopts, sizeof(default_mountopts),
712 always_mountopts, sizeof(always_mountopts));
715 fprintf(stderr, "unable to prepare backend (%d)\n", ret);
720 trim_mountfsoptions(mountopts);
721 (void)check_mountfsoptions(mountopts, default_mountopts, 1);
722 if (check_mountfsoptions(mountopts, always_mountopts, 0)) {
726 sprintf(ldd->ldd_mount_opts, "%s", mountopts);
729 if (ldd->ldd_mount_opts[0] == 0)
730 /* use the defaults unless old opts exist */
733 sprintf(ldd->ldd_mount_opts, "%s%s",
734 always_mountopts, default_mountopts);
735 trim_mountfsoptions(ldd->ldd_mount_opts);
739 server_make_name(ldd->ldd_flags, ldd->ldd_svindex,
740 ldd->ldd_fsname, ldd->ldd_svname);
743 print_ldd("Permanent disk data", ldd);
746 printf("exiting before disk write.\n");
750 if (check_mtab_entry(mop.mo_device, mop.mo_device, NULL, NULL))
753 /* Create the loopback file */
754 if (mop.mo_flags & MO_IS_LOOP) {
755 ret = access(mop.mo_device, F_OK);
758 #ifndef TUNEFS /* mkfs.lustre */
759 /* Reformat the loopback file */
760 if (ret || (mop.mo_flags & MO_FORCEFORMAT)) {
761 ret = loop_format(&mop);
767 ret = loop_setup(&mop);
770 fprintf(stderr, "Loop device setup for %s failed: %s\n",
771 mop.mo_device, strerror(ret));
776 #ifndef TUNEFS /* mkfs.lustre */
777 /* Check whether the disk has already been formatted by mkfs.lustre */
778 if (!(mop.mo_flags & MO_FORCEFORMAT)) {
779 ret = osd_is_lustre(mop.mo_device, &mount_type);
782 fprintf(stderr, "Device %s was previously formatted "
783 "for lustre. Use --reformat to reformat it, "
784 "or tunefs.lustre to modify.\n",
790 /* Format the backing filesystem */
791 ret = osd_make_lustre(&mop);
794 fprintf(stderr, "mkfs failed %d\n", ret);
798 /* update svname with '=' to refresh config */
799 if (mop.mo_ldd.ldd_flags & LDD_F_WRITECONF) {
800 struct mount_opts opts;
801 opts.mo_ldd = mop.mo_ldd;
802 opts.mo_source = mop.mo_device;
803 (void) osd_label_lustre(&opts);
806 /* Enable quota accounting */
807 if (mop.mo_flags & MO_QUOTA) {
808 ret = osd_enable_quota(&mop);
814 /* Write our config files */
815 ret = osd_write_ldd(&mop);
818 fprintf(stderr, "failed to write local files\n");
824 ret2 = loop_cleanup(&mop);
828 /* Fix any crazy return values from system() */
829 if (ret && ((ret & 255) == 0))
832 verrprint("%s: exiting with %d (%s)\n",
833 progname, ret, strerror(ret));