lustre/utils/mkfs_lustre.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/utils/mkfs_lustre.c
  33  *
  34  * Author: Nathan Rutman <nathan@clusterfs.com>
  35 */
  36
  37 /* This source file is compiled into both mkfs.lustre and tunefs.lustre */
  38
  39 #if HAVE_CONFIG_H
  40 #  include "config.h"
  41 #endif /* HAVE_CONFIG_H */
  42
  43 #ifndef _GNU_SOURCE
  44 #define _GNU_SOURCE
  45 #endif
  46 #include <stdlib.h>
  47 #include <stdio.h>
  48 #include <unistd.h>
  49 #include <fcntl.h>
  50 #include <stdarg.h>
  51 #include <mntent.h>
  52 #include <stdbool.h>
  53
  54 #include <sys/types.h>
  55 #include <sys/stat.h>
  56 #include <sys/mount.h>
  57 #include <sys/utsname.h>
  58
  59 #include <string.h>
  60 #include <getopt.h>
  61 #include <limits.h>
  62 #include <ctype.h>
  63 #include <linux/lnet/nidstr.h>
  64 #include <linux/lnet/lnetctl.h>
  65 #include <linux/lustre_param.h>
  66 #include <lustre_ver.h>
  67
  68 #include "mount_utils.h"
  69
  70 char *progname;
  71 int verbose = 1;
  72 int version;
  73 static int print_only = 0;
  74
  75 #ifdef HAVE_LDISKFS_OSD
  76 #define FSLIST_LDISKFS "ldiskfs"
  77 #define HAVE_FSLIST
  78 #else
  79  #define FSLIST_LDISKFS ""
  80 #endif /* HAVE_LDISKFS_OSD */
  81 #ifdef HAVE_ZFS_OSD
  82  #ifdef HAVE_FSLIST
  83    #define FSLIST_ZFS "|zfs"
  84  #else
  85   #define FSLIST_ZFS "zfs"
  86   #define HAVE_FSLIST
  87  #endif
  88 #else
  89  #define FSLIST_ZFS ""
  90 #endif /* HAVE_ZFS_OSD */
  91
  92 #ifndef HAVE_FSLIST
  93  #error "no backing OSD types (ldiskfs or ZFS) are configured"
  94 #endif
  95
  96 #define FSLIST FSLIST_LDISKFS FSLIST_ZFS
  97
  98 void usage(FILE *out)
  99 {
 100         fprintf(out, "usage: %s <target type> [--backfstype="FSLIST"] "
 101                 "--fsname=<filesystem name>\n"
 102                 "\t--index=<target index> [options] <device>\n", progname);
 103 #ifdef HAVE_ZFS_OSD
 104         fprintf(out, "usage: %s <target type> --backfstype=zfs "
 105                 "--fsname=<filesystem name> [options]\n"
 106                 "\t<pool name>/<dataset name>\n"
 107                 "\t[[<vdev type>] <device> [<device> ...] [vdev type>] ...]\n",
 108                 progname);
 109 #endif
 110         fprintf(out,
 111                 "\t<device>:block device or file (e.g /dev/sda or /tmp/ost1)\n"
 112 #ifdef HAVE_ZFS_OSD
 113                 "\t<pool name>: name of ZFS pool where target is created "
 114                         "(e.g. tank)\n"
 115                 "\t<dataset name>: name of new dataset, must be unique within "
 116                         "pool (e.g. ost1)\n"
 117                 "\t<vdev type>: type of vdev (mirror, raidz, raidz2, spare, "
 118                         "cache, log)\n"
 119 #endif
 120                 "\n"
 121                 "\ttarget types:\n"
 122                 "\t\t--mgs: configuration management service\n"
 123                 "\t\t--nomgs: turn off MGS service on this MDT\n"
 124 #ifndef TUNEFS
 125                 "\t\t--mdt: metadata storage, mutually exclusive with ost\n"
 126                 "\t\t--ost: object storage, mutually exclusive with mdt, mgs\n"
 127 #endif
 128                 "\toptions (in order of popularity):\n"
 129                 "\t\t--index=#N: numerical target index (0..N)\n"
 130                 "\t\t\trequired for all targets other than the MGS,\n"
 131                 "\t\t\ttarget index may either be a decimal number or\n"
 132                 "\t\t\thexadecimal number starting with '0x'\n"
 133                 "\t\t--fsname=<8_char_filesystem_name>: fs targets belong to\n"
 134                 "\t\t\trequired for all targets other than MGS\n"
 135                 "\t\t--mgsnode=<nid>[,<...>]: NID(s) of remote MGS\n"
 136                 "\t\t\trequired for all targets other than MGS\n"
 137                 "\t\t--mountfsoptions=<opts>: permanent Lustre mount options\n"
 138                 "\t\t--backfs-mount-opts=<opts>: backing fs mount options\n"
 139                 "\t\t--failnode=<nid>[,<...>]: NID(s) of backup failover node\n"
 140                 "\t\t\tmutually exclusive with --servicenode\n"
 141                 "\t\t--servicenode=<nid>[,<...>]: NID(s) of service partners\n"
 142                 "\t\t\ttreat nodes as equal service node, mutually exclusive "
 143                         "with --failnode\n"
 144                 "\t\t--param <key>=<value>: set a permanent parameter\n"
 145                 "\t\t\te.g. --param sys.timeout=40\n"
 146                 "\t\t\t     --param lov.stripesize=2M\n"
 147                 "\t\t--network=<net>[,<...>]: restrict OST/MDT to network(s)\n"
 148 #ifndef TUNEFS
 149                 "\t\t--backfstype=<fstype>: backing fs type (ldiskfs, zfs)\n"
 150                 "\t\t--device-size=#N(KB): device size for loop devices\n"
 151                 "\t\t--mkfsoptions=<opts>: format options\n"
 152                 "\t\t--reformat: overwrite an existing disk\n"
 153                 "\t\t--replace: replace an old target with the same index\n"
 154                 "\t\t--stripe-count-hint=#N: for optimizing MDT inode size\n"
 155 #else
 156                 "\t\t--erase-param <key>: erase all instances of a parameter\n"
 157                 "\t\t--erase-params: erase all old parameter settings\n"
 158                 "\t\t--writeconf: erase all config logs for this fs.\n"
 159                 "\t\t--quota: enable space accounting on old 2.x device.\n"
 160                 "\t\t--rename: rename the filesystem name\n"
 161 #endif
 162                 "\t\t--comment=<user comment>: arbitrary string (%d bytes)\n"
 163                 "\t\t--dryrun: report what we would do; don't write to disk\n"
 164                 "\t\t--verbose: e.g. show mkfs progress\n"
 165                 "\t\t--force-nohostid: Ignore hostid requirement for ZFS "
 166                         "import\n"
 167                 "\t\t-V|--version: output build version of the utility and\n"
 168                 "\t\t\texit\n"
 169                 "\t\t--quiet\n",
 170                 (int)sizeof(((struct lustre_disk_data *)0)->ldd_userdata));
 171         return;
 172 }
 173
 174 /* ==================== Lustre config functions =============*/
 175
 176 void print_ldd(char *str, struct mkfs_opts *mop)
 177 {
 178         struct lustre_disk_data *ldd = &mop->mo_ldd;
 179
 180         printf("\n   %s:\n", str);
 181         printf("Target:     %s\n", ldd->ldd_svname);
 182         if (ldd->ldd_svindex == INDEX_UNASSIGNED)
 183                 printf("Index:      unassigned\n");
 184         else
 185                 printf("Index:      %d\n", ldd->ldd_svindex);
 186         if (ldd->ldd_uuid[0])
 187                 printf("UUID:       %s\n", (char *)ldd->ldd_uuid);
 188         printf("Lustre FS:  %s\n", ldd->ldd_fsname);
 189         printf("Mount type: %s\n", MT_STR(ldd));
 190         printf("Flags:      %#x\n", ldd->ldd_flags);
 191         printf("              (%s%s%s%s%s%s%s%s%s)\n",
 192                IS_MDT(ldd) ? "MDT ":"",
 193                IS_OST(ldd) ? "OST ":"",
 194                IS_MGS(ldd) ? "MGS ":"",
 195                ldd->ldd_flags & LDD_F_NEED_INDEX ? "needs_index ":"",
 196                ldd->ldd_flags & LDD_F_VIRGIN     ? "first_time ":"",
 197                ldd->ldd_flags & LDD_F_UPDATE     ? "update ":"",
 198                ldd->ldd_flags & LDD_F_WRITECONF  ? "writeconf ":"",
 199                ldd->ldd_flags & LDD_F_NO_PRIMNODE? "no_primnode ":"",
 200                ldd->ldd_flags & LDD_F_UPGRADE14  ? "upgrade1.4 ":"");
 201         printf("Persistent mount opts: %s\n", ldd->ldd_mount_opts);
 202         osd_print_ldd_params(mop);
 203         if (ldd->ldd_userdata[0])
 204                 printf("Comment: %s\n", ldd->ldd_userdata);
 205         printf("\n");
 206 }
 207
 208 void set_defaults(struct mkfs_opts *mop)
 209 {
 210         mop->mo_ldd.ldd_magic = LDD_MAGIC;
 211         mop->mo_ldd.ldd_config_ver = 1;
 212         mop->mo_ldd.ldd_flags = LDD_F_NEED_INDEX | LDD_F_UPDATE | LDD_F_VIRGIN;
 213 #ifdef HAVE_LDISKFS_OSD
 214         mop->mo_ldd.ldd_mount_type = LDD_MT_LDISKFS;
 215 #else
 216         mop->mo_ldd.ldd_mount_type = LDD_MT_ZFS;
 217 #endif
 218         mop->mo_ldd.ldd_svindex = INDEX_UNASSIGNED;
 219         mop->mo_mgs_failnodes = 0;
 220         mop->mo_stripe_count = 1;
 221         mop->mo_pool_vdevs = NULL;
 222 }
 223
 224 /* Make the mdt/ost server obd name based on the filesystem name */
 225 static bool server_make_name(__u32 flags, __u16 index, const char *fs,
 226                              char *name_buf, size_t name_buf_size)
 227 {
 228         bool invalid_flag = false;
 229
 230         if (flags & (LDD_F_SV_TYPE_MDT | LDD_F_SV_TYPE_OST)) {
 231                 if (!(flags & LDD_F_SV_ALL))
 232                         snprintf(name_buf, name_buf_size, "%.8s%c%s%04x", fs,
 233                                 (flags & LDD_F_VIRGIN) ? ':' :
 234                                 ((flags & LDD_F_WRITECONF) ? '=' : '-'),
 235                                 (flags & LDD_F_SV_TYPE_MDT) ? "MDT" : "OST",
 236                                 index);
 237         } else if (flags & LDD_F_SV_TYPE_MGS) {
 238                 snprintf(name_buf, name_buf_size, "MGS");
 239         } else {
 240                 fprintf(stderr, "unknown server type %#x\n", flags);
 241                 invalid_flag = true;
 242         }
 243         return invalid_flag;
 244 }
 245
 246 static inline void badopt(const char *opt, char *type)
 247 {
 248         fprintf(stderr, "%s: '--%s' only valid for %s\n",
 249                 progname, opt, type);
 250         usage(stderr);
 251 }
 252
 253 #ifdef TUNEFS
 254 /**
 255  * Removes all existing instances of the parameter passed in \a param,
 256  * which are in the form of "key=<value>", from the buffer at \a buf.
 257  *
 258  * The parameter can be either in the form of "key" when passed by option
 259  * "--erase-param", or in the form of "key=<value>" when passed by option
 260  * "--param".
 261  *
 262  * \param buf     the buffer holding on-disk server parameters.
 263  * \param param   the parameter whose instances are to be removed from \a buf.
 264  * \param withval true means the parameter is in the form of "key=<value>"
 265  *                false means the parameter is in the form of "key"
 266  *
 267  * \retval 0      success, parameter was erased,
 268  * \retval 1      success, parameter was not found, don't need to do erase_ldd,
 269  * \retval EINVAL failure, invalid input parameter.
 270  */
 271 static int erase_param(const char *const buf, const char *const param,
 272                        bool withval)
 273 {
 274         char    search[PARAM_MAX + 1] = "";
 275         char    *buffer = (char *)buf;
 276         bool    found = false;
 277
 278         if (strlen(param) > PARAM_MAX) {
 279                 fprintf(stderr, "%s: param to erase is too long-\n%s\n",
 280                         progname, param);
 281                 return EINVAL;
 282         }
 283
 284         /* add_param() writes a space as the first character in ldd_params */
 285         search[0] = ' ';
 286
 287         /* "key" or "key=<value>" */
 288         if (withval) {
 289                 char *keyend;
 290
 291                 keyend = strchr(param, '=');
 292                 if (!keyend)
 293                         return EINVAL;
 294                 strncpy(&search[1], param, keyend - param + 1);
 295         } else {
 296                 strncpy(&search[1], param, strlen(param));
 297                 strncat(search, "=", 1);
 298         }
 299
 300         while (1) {
 301                 char    *space;
 302
 303                 buffer = strstr(buffer, search);
 304                 if (!buffer)
 305                         return found == true ? 0 : 1;
 306                 found = true;
 307                 space = strchr(buffer + 1, ' ');
 308                 if (space) {
 309                         memmove(buffer, space, strlen(space) + 1);
 310                 } else {
 311                         *buffer = '\0';
 312                         return 0;
 313                 }
 314         }
 315 }
 316 #endif
 317
 318 /* from mount_lustre */
 319 /* Get rid of symbolic hostnames for tcp, since kernel can't do lookups */
 320 #define MAXNIDSTR 1024
 321 static char *convert_hostnames(char *s1)
 322 {
 323         char *converted, *s2 = 0, *c, *end, sep;
 324         int left = MAXNIDSTR;
 325         lnet_nid_t nid;
 326
 327         converted = malloc(left);
 328         if (converted == NULL) {
 329                 return NULL;
 330         }
 331
 332         end = s1 + strlen(s1);
 333         c = converted;
 334         while ((left > 0) && (s1 < end)) {
 335                 s2 = strpbrk(s1, ",:");
 336                 if (!s2)
 337                         s2 = end;
 338                 sep = *s2;
 339                 *s2 = '\0';
 340                 nid = libcfs_str2nid(s1);
 341                 *s2 = sep;
 342
 343                 if (nid == LNET_NID_ANY) {
 344                         fprintf(stderr, "%s: Cannot resolve hostname '%s'.\n",
 345                                 progname, s1);
 346                         free(converted);
 347                         return NULL;
 348                 }
 349                 if (strncmp(libcfs_nid2str(nid), "127.0.0.1",
 350                             strlen("127.0.0.1")) == 0) {
 351                         fprintf(stderr, "%s: The NID '%s' resolves to the "
 352                                 "loopback address '%s'.  Lustre requires a "
 353                                 "non-loopback address.\n",
 354                                 progname, s1, libcfs_nid2str(nid));
 355                         free(converted);
 356                         return NULL;
 357                 }
 358
 359                 c += snprintf(c, left, "%s%c", libcfs_nid2str(nid), sep);
 360                 left = converted + MAXNIDSTR - c;
 361                 s1 = s2 + 1;
 362         }
 363         return converted;
 364 }
 365
 366 int parse_opts(int argc, char *const argv[], struct mkfs_opts *mop,
 367                char **mountopts, char *old_fsname)
 368 {
 369         static struct option long_opts[] = {
 370         { .val = 'B' ,  .name =  "backfs-mount-opts",
 371                                                 .has_arg = required_argument},
 372         { .val = 'f' ,  .name =  "failnode",    .has_arg = required_argument},
 373         { .val = 'f' ,  .name =  "failover",    .has_arg = required_argument},
 374         { .val = 'G' ,  .name =  "mgs",         .has_arg = no_argument},
 375         { .val = 'h' ,  .name =  "help",        .has_arg = no_argument},
 376         { .val = 'i' ,  .name =  "index",       .has_arg = required_argument},
 377         { .val = 'L' ,  .name =  "fsname",      .has_arg = required_argument},
 378         { .val = 'm' ,  .name =  "mgsnode",     .has_arg = required_argument},
 379         { .val = 'm' ,  .name =  "mgsnid",      .has_arg = required_argument},
 380         { .val = 'n' ,  .name =  "dryrun",      .has_arg = no_argument},
 381         { .val = 'N' ,  .name =  "nomgs",       .has_arg = no_argument},
 382         { .val = 'o' ,  .name =  "mountfsoptions",
 383                                                 .has_arg = required_argument},
 384         { .val = 'p' ,  .name =  "param",       .has_arg = required_argument},
 385         { .val = 'q' ,  .name =  "quiet",       .has_arg = no_argument},
 386         { .val = 's' ,  .name =  "servicenode", .has_arg = required_argument},
 387         { .val = 't' ,  .name =  "network",     .has_arg = required_argument},
 388         { .val = 'u' ,  .name =  "comment",     .has_arg = required_argument},
 389         { .val = 'U' ,  .name =  "force-nohostid",
 390                                                 .has_arg = no_argument},
 391         { .val = 'v' ,  .name =  "verbose",     .has_arg = no_argument},
 392         { .val = 'V' ,  .name =  "version",     .has_arg = no_argument},
 393 #ifndef TUNEFS
 394         { .val = 'b' ,  .name =  "backfstype",  .has_arg = required_argument},
 395         { .val = 'c' ,  .name =  "stripe-count-hint",
 396                                                 .has_arg = required_argument},
 397         { .val = 'd' ,  .name =  "device-size", .has_arg = required_argument},
 398         { .val = 'k' ,  .name =  "mkfsoptions", .has_arg = required_argument},
 399         { .val = 'M' ,  .name =  "mdt",         .has_arg = no_argument},
 400         { .val = 'O' ,  .name =  "ost",         .has_arg = no_argument},
 401         { .val = 'r' ,  .name =  "reformat",    .has_arg = no_argument},
 402         { .val = 'R' ,  .name =  "replace",     .has_arg = no_argument},
 403 #else
 404         { .val = 'E' ,  .name =  "erase-param", .has_arg = required_argument},
 405         { .val = 'e' ,  .name =  "erase-params",
 406                                                 .has_arg = no_argument},
 407         { .val = 'Q' ,  .name =  "quota",       .has_arg = no_argument},
 408         { .val = 'R' ,  .name =  "rename",      .has_arg = optional_argument},
 409         { .val = 'w' ,  .name =  "writeconf",   .has_arg = no_argument},
 410 #endif
 411         { .name = NULL } };
 412         char *short_opts = "B:f:Ghi:L:m:nNo:p:qs:t:u:vV"
 413 #ifndef TUNEFS
 414                           "b:c:d:k:MOrR";
 415 #else
 416                           "E:eQR::w";
 417 #endif
 418         struct lustre_disk_data *ldd = &mop->mo_ldd;
 419         char new_fsname[16] = { 0 };
 420         int opt;
 421         int rc, longidx;
 422         int failnode_set = 0, servicenode_set = 0;
 423         int replace = 0;
 424         bool index_option = false;
 425
 426 #ifdef TUNEFS
 427         /* For the right semantics, if '-e'/'--erase-params' is specified,
 428          * it must be picked out and all old parameters should be erased
 429          * before any other changes are done. */
 430         while ((opt = getopt_long(argc, argv, short_opts, long_opts,
 431                                   &longidx)) != EOF) {
 432                 switch (opt) {
 433                 case 'e':
 434                         ldd->ldd_params[0] = '\0';
 435                         mop->mo_flags |= MO_ERASE_ALL;
 436                         ldd->ldd_flags |= LDD_F_UPDATE;
 437                         break;
 438                 default:
 439                         break;
 440                 }
 441                 if (mop->mo_flags & MO_ERASE_ALL)
 442                         break;
 443         }
 444         optind = 0;
 445 #endif
 446         while ((opt = getopt_long(argc, argv, short_opts, long_opts,
 447                                   &longidx)) != EOF) {
 448                 switch (opt) {
 449                 case 'B':
 450                         mop->mo_mountopts = optarg;
 451                         break;
 452                 case 'f':
 453                 case 's': {
 454                         char *nids;
 455
 456                         if ((opt == 'f' && servicenode_set) ||
 457                             (opt == 's' && failnode_set)) {
 458                                 fprintf(stderr, "%s: %s cannot use with --%s\n",
 459                                         progname, long_opts[longidx].name,
 460                                         opt == 'f' ? "servicenode" :
 461                                         "failnode");
 462                                 return 1;
 463                         }
 464
 465                         nids = convert_hostnames(optarg);
 466                         if (nids == NULL)
 467                                 return 1;
 468
 469                         rc = append_param(ldd->ldd_params, PARAM_FAILNODE,
 470                                           nids, ':');
 471                         free(nids);
 472                         if (rc != 0)
 473                                 return rc;
 474
 475                         /* Must update the mgs logs */
 476                         ldd->ldd_flags |= LDD_F_UPDATE;
 477                         if (opt == 'f') {
 478                                 ldd->ldd_flags &= ~LDD_F_NO_PRIMNODE;
 479                                 failnode_set = 1;
 480                         } else {
 481                                 ldd->ldd_flags |= LDD_F_NO_PRIMNODE;
 482                                 servicenode_set = 1;
 483                         }
 484                         mop->mo_flags |= MO_FAILOVER;
 485                         break;
 486                 }
 487                 case 'G':
 488                         ldd->ldd_flags |= LDD_F_SV_TYPE_MGS;
 489                         break;
 490                 case 'h':
 491                         usage(stdout);
 492                         return 1;
 493                 case 'i': {
 494                         char *endptr = NULL;
 495                         int base;
 496                         index_option = true;
 497                         /* LU-2374: check whether it is OST/MDT later */
 498                         base = (strlen(optarg) > 1 &&
 499                                 !strncmp(optarg, "0x", 2)) ? 16 : 10;
 500                         /* Allowed input are base 16 and base 10 numbers only */
 501                         mop->mo_ldd.ldd_svindex = strtoul(optarg,
 502                                                           &endptr, base);
 503                         if (*endptr != '\0') {
 504                                 fprintf(stderr, "%s: wrong index %s. "
 505                                         "Target index must be decimal or "
 506                                         "hexadecimal.\n",
 507                                         progname, optarg);
 508                                 return 1;
 509                         }
 510                         if (ldd->ldd_svindex >= INDEX_UNASSIGNED) {
 511                                 fprintf(stderr, "%s: wrong index %u. "
 512                                         "Target index must be less than %u.\n",
 513                                         progname, ldd->ldd_svindex,
 514                                         INDEX_UNASSIGNED);
 515                                 return 1;
 516                         }
 517
 518                         ldd->ldd_flags &= ~LDD_F_NEED_INDEX;
 519                         break;
 520                 }
 521                 case 'L':
 522                         strscpy(new_fsname, optarg, sizeof(new_fsname));
 523                         break;
 524                 case 'm': {
 525                         char *nids = convert_hostnames(optarg);
 526
 527                         if (nids == NULL)
 528                                 return 1;
 529
 530                         rc = append_param(ldd->ldd_params, PARAM_MGSNODE,
 531                                           nids, ':');
 532                         free(nids);
 533                         if (rc != 0)
 534                                 return rc;
 535
 536                         mop->mo_mgs_failnodes++;
 537                         break;
 538                 }
 539                 case 'n':
 540                         print_only++;
 541                         break;
 542                 case 'N':
 543                         ldd->ldd_flags &= ~LDD_F_SV_TYPE_MGS;
 544                         break;
 545                 case 'o':
 546                         *mountopts = optarg;
 547                         break;
 548                 case 'p':
 549 #ifdef TUNEFS
 550                         /* Removes all existing instances of the parameter
 551                          * before adding new values.
 552                          */
 553                         rc = erase_param(ldd->ldd_params, optarg, true);
 554                         if (rc > 1)
 555                                 return rc;
 556 #endif
 557                         rc = add_param(ldd->ldd_params, NULL, optarg);
 558                         if (rc != 0)
 559                                 return rc;
 560                         /* Must update the mgs logs */
 561                         ldd->ldd_flags |= LDD_F_UPDATE;
 562                         break;
 563                 case 'q':
 564                         verbose--;
 565                         break;
 566                 case 't':
 567                         if (!IS_MDT(ldd) && !IS_OST(ldd)) {
 568                                 badopt(long_opts[longidx].name, "MDT,OST");
 569                                 return 1;
 570                         }
 571
 572                         if (optarg == NULL)
 573                                 return 1;
 574
 575                         rc = add_param(ldd->ldd_params, PARAM_NETWORK, optarg);
 576                         if (rc != 0)
 577                                 return rc;
 578
 579                         /* Must update the mgs logs */
 580                         ldd->ldd_flags |= LDD_F_UPDATE;
 581                         break;
 582                 case 'u':
 583                         strscpy(ldd->ldd_userdata, optarg,
 584                                 sizeof(ldd->ldd_userdata));
 585                         break;
 586                 case 'U':
 587                         mop->mo_flags |= MO_NOHOSTID_CHECK;
 588                         break;
 589                 case 'v':
 590                         verbose++;
 591                         break;
 592                 case 'V':
 593                         ++version;
 594                         fprintf(stdout, "%s %s\n", progname,
 595                                 LUSTRE_VERSION_STRING);
 596                         return 0;
 597 #ifndef TUNEFS
 598                 case 'b': {
 599                         int i = 0;
 600
 601                         do {
 602                                 if (strcmp(optarg, mt_str(i)) == 0) {
 603                                         ldd->ldd_mount_type = i;
 604                                         break;
 605                                 }
 606                         } while (++i < LDD_MT_LAST);
 607
 608                         if (i == LDD_MT_LAST) {
 609                                 fprintf(stderr, "%s: invalid backend filesystem"
 610                                         " type %s\n", progname, optarg);
 611                                 return 1;
 612                         }
 613                         break;
 614                 }
 615                 case 'c':
 616                         if (IS_MDT(ldd)) {
 617                                 int stripe_count = atol(optarg);
 618
 619                                 if (stripe_count <= 0) {
 620                                         fprintf(stderr, "%s: bad stripe count "
 621                                                 "%d\n", progname, stripe_count);
 622                                         return 1;
 623                                 }
 624                                 mop->mo_stripe_count = stripe_count;
 625                         } else {
 626                                 badopt(long_opts[longidx].name, "MDT");
 627                                 return 1;
 628                         }
 629                         break;
 630                 case 'd':
 631                         mop->mo_device_kb = atol(optarg);
 632                         break;
 633                 case 'k':
 634                         strscpy(mop->mo_mkfsopts, optarg,
 635                                 sizeof(mop->mo_mkfsopts));
 636                         break;
 637                 case 'M':
 638                         ldd->ldd_flags |= LDD_F_SV_TYPE_MDT;
 639                         break;
 640                 case 'O':
 641                         ldd->ldd_flags |= LDD_F_SV_TYPE_OST;
 642                         break;
 643                 case 'r':
 644                         mop->mo_flags |= MO_FORCEFORMAT;
 645                         break;
 646                 case 'R':
 647                         replace = 1;
 648                         break;
 649 #else /* TUNEFS */
 650                 case 'E':
 651                         rc = erase_param(ldd->ldd_params, optarg, false);
 652                         /* (rc == 1) means not found, so don't need to
 653                          * call osd_erase_ldd(). */
 654                         if (rc > 1)
 655                                 return rc;
 656                         if (!rc) {
 657                                 rc = osd_erase_ldd(mop, optarg);
 658                                 if (rc)
 659                                         return rc;
 660                         }
 661                         /* Must update the mgs logs */
 662                         ldd->ldd_flags |= LDD_F_UPDATE;
 663                         break;
 664                 case 'e':
 665                         /* Already done in the beginning */
 666                         break;
 667                 case 'Q':
 668                         mop->mo_flags |= MO_QUOTA;
 669                         break;
 670                 case 'R': {
 671                         char *tmp;
 672
 673                         mop->mo_flags |= MO_RENAME;
 674                         if (!optarg) {
 675                                 if (IS_SEPARATED_MGS(ldd)) {
 676                                         fprintf(stderr, "%s: must specify the "
 677                                                 "old fsname to be renamed for "
 678                                                 "separated MGS\n", progname);
 679                                         return 1;
 680                                 }
 681                                 break;
 682                         }
 683
 684                         if ((strlen(optarg) < 1) || (strlen(optarg) > 8)) {
 685                                 fprintf(stderr, "%s: filesystem name must be "
 686                                         "1-8 chars\n", progname);
 687                                 return 1;
 688                         }
 689
 690                         tmp = strpbrk(optarg, "/:");
 691                         if (tmp) {
 692                                 fprintf(stderr, "%s: char '%c' not allowed in "
 693                                         "filesystem name\n", progname, *tmp);
 694                                 return 1;
 695                         }
 696
 697                         if (IS_SEPARATED_MGS(ldd)) {
 698                                 strscpy(old_fsname, optarg,
 699                                         sizeof(ldd->ldd_fsname));
 700                         } else if (strlen(old_fsname) != strlen(optarg) ||
 701                                    strcmp(old_fsname, optarg) != 0) {
 702                                 fprintf(stderr, "%s: the given fsname '%s' "
 703                                         "to be renamed does not exist\n",
 704                                         progname, optarg);
 705                                 return 1;
 706                         }
 707                         break;
 708                 }
 709                 case 'w':
 710                         ldd->ldd_flags |= LDD_F_WRITECONF;
 711                         break;
 712 #endif /* !TUNEFS */
 713                 default:
 714                         if (opt != '?') {
 715                                 fatal();
 716                                 fprintf(stderr, "Unknown option '%c'\n", opt);
 717                         }
 718                         return EINVAL;
 719                 }
 720         }
 721
 722         if (strlen(new_fsname) > 0) {
 723                 if (!(mop->mo_flags & (MO_FORCEFORMAT | MO_RENAME)) &&
 724                      (!(ldd->ldd_flags &
 725                         (LDD_F_UPGRADE14 | LDD_F_VIRGIN | LDD_F_WRITECONF)))) {
 726                         fprintf(stderr, "%s: cannot change the name "
 727                                 "of a registered target\n", progname);
 728                         return 1;
 729                 }
 730
 731                 strscpy(ldd->ldd_fsname, new_fsname, sizeof(ldd->ldd_fsname));
 732         }
 733
 734         if (index_option && !(mop->mo_ldd.ldd_flags &
 735               (LDD_F_UPGRADE14 | LDD_F_VIRGIN |
 736                LDD_F_WRITECONF))) {
 737                 fprintf(stderr, "%s: cannot change the index of"
 738                         " a registered target\n", progname);
 739                 return 1;
 740         }
 741
 742 #ifdef TUNEFS
 743         if (mop->mo_flags & MO_RENAME) {
 744                 if (new_fsname[0] == '\0') {
 745                         fprintf(stderr, "%s: need to specify new fsname for "
 746                                 "renaming case\n", progname);
 747                         return 1;
 748                 }
 749
 750                 if (strcmp(old_fsname, new_fsname) == 0) {
 751                         fprintf(stderr, "%s: cannot rename fsname '%s' to "
 752                                 "the same name\n", progname, old_fsname);
 753                         return 1;
 754                 }
 755         }
 756 #endif
 757
 758         /* Need to clear this flag after parsing 'L' and 'i' options. */
 759         if (replace)
 760                 ldd->ldd_flags &= ~LDD_F_VIRGIN;
 761
 762         if (optind == argc) {
 763                 /* The user didn't specify device name */
 764                 fatal();
 765                 fprintf(stderr, "Not enough arguments - device name or "
 766                         "pool/dataset name not specified.\n");
 767                 return EINVAL;
 768         } else {
 769                 /*  The device or pool/filesystem name */
 770                 strscpy(mop->mo_device, argv[optind], sizeof(mop->mo_device));
 771
 772                 /* Followed by optional vdevs */
 773                 if (optind < argc - 1)
 774                         mop->mo_pool_vdevs = (char **) &argv[optind + 1];
 775         }
 776
 777         return 0;
 778 }
 779
 780 int main(int argc, char *const argv[])
 781 {
 782         struct mkfs_opts mop;
 783         struct lustre_disk_data *ldd = &mop.mo_ldd;
 784         char *mountopts = NULL;
 785         char wanted_mountopts[512] = "";
 786         char old_fsname[16] = "";
 787         unsigned mount_type;
 788         int ret = 0;
 789         int ret2 = 0;
 790
 791         progname = strrchr(argv[0], '/');
 792         if (progname != NULL)
 793                 progname++;
 794         else
 795                 progname = argv[0];
 796
 797         if ((argc < 2) || (argv[argc - 1][0] == '-')) {
 798                 usage(stderr);
 799                 return EINVAL;
 800         }
 801
 802         memset(&mop, 0, sizeof(mop));
 803         set_defaults(&mop);
 804
 805         /* device is last arg */
 806         strscpy(mop.mo_device, argv[argc - 1], sizeof(mop.mo_device));
 807
 808         ret = osd_init();
 809         if (ret != 0)
 810                 return ret;
 811
 812 #ifdef TUNEFS
 813         /* For tunefs, we must read in the old values before parsing any
 814            new ones. */
 815
 816         /* Check whether the disk has already been formatted by mkfs.lustre */
 817         ret = osd_is_lustre(mop.mo_device, &mount_type);
 818         if (ret == 0) {
 819                 fatal();
 820                 fprintf(stderr, "Device %s has not been formatted with "
 821                         "mkfs.lustre\n", mop.mo_device);
 822                 ret = ENODEV;
 823                 goto out;
 824         }
 825         ldd->ldd_mount_type = mount_type;
 826
 827         ret = osd_read_ldd(mop.mo_device, ldd);
 828         if (ret != 0) {
 829                 fatal();
 830                 fprintf(stderr, "Failed to read previous Lustre data from %s "
 831                         "(%d)\n", mop.mo_device, ret);
 832                 goto out;
 833         }
 834
 835         strscpy(old_fsname, ldd->ldd_fsname, sizeof(ldd->ldd_fsname));
 836         ldd->ldd_flags &= ~(LDD_F_WRITECONF | LDD_F_VIRGIN);
 837
 838         /* svname of the form lustre:OST1234 means never registered */
 839         ret = strlen(ldd->ldd_svname);
 840         if (ldd->ldd_svname[ret - 8] == ':') {
 841                 ldd->ldd_svname[ret - 8] = '-';
 842                 ldd->ldd_flags |= LDD_F_VIRGIN;
 843         } else if (ldd->ldd_svname[ret - 8] == '=') {
 844                 ldd->ldd_svname[ret - 8] = '-';
 845                 ldd->ldd_flags |= LDD_F_WRITECONF;
 846         }
 847
 848         if (strstr(ldd->ldd_params, PARAM_MGSNODE))
 849                 mop.mo_mgs_failnodes++;
 850
 851         if (verbose > 0)
 852                 print_ldd("Read previous values", &mop);
 853 #endif /* TUNEFS */
 854
 855         ret = parse_opts(argc, argv, &mop, &mountopts, old_fsname);
 856         if (ret != 0 || version)
 857                 goto out;
 858
 859         if (!IS_MDT(ldd) && !IS_OST(ldd) && !IS_MGS(ldd)) {
 860                 fatal();
 861                 fprintf(stderr, "must set target type: MDT,OST,MGS\n");
 862                 ret = EINVAL;
 863                 goto out;
 864         }
 865
 866         if (((IS_MDT(ldd) || IS_MGS(ldd))) && IS_OST(ldd)) {
 867                 fatal();
 868                 fprintf(stderr, "OST type is exclusive with MDT,MGS\n");
 869                 ret = EINVAL;
 870                 goto out;
 871         }
 872
 873         /* Stand alone MGS doesn't need an index */
 874         if (!IS_MDT(ldd) && IS_MGS(ldd)) {
 875 #ifndef TUNEFS
 876                 /* But if --index was specified flag an error */
 877                 if (!(ldd->ldd_flags & LDD_F_NEED_INDEX)) {
 878                         badopt("index", "MDT,OST");
 879                         goto out;
 880                 }
 881 #endif
 882                 ldd->ldd_flags &= ~LDD_F_NEED_INDEX;
 883         }
 884
 885         if ((ldd->ldd_flags & (LDD_F_NEED_INDEX | LDD_F_UPGRADE14)) ==
 886             (LDD_F_NEED_INDEX | LDD_F_UPGRADE14)) {
 887                 fatal();
 888                 fprintf(stderr, "Can't find the target index, "
 889                 "specify with --index\n");
 890                 ret = EINVAL;
 891                 goto out;
 892         }
 893
 894         if (ldd->ldd_flags & LDD_F_NEED_INDEX)
 895                 fprintf(stderr, "warning: %s: for Lustre 2.4 and later, the "
 896                         "target index must be specified with --index\n",
 897                         mop.mo_device);
 898
 899         /* If no index is supplied for MDT by default set index to zero */
 900         if (IS_MDT(ldd) && (ldd->ldd_svindex == INDEX_UNASSIGNED)) {
 901                 ldd->ldd_flags &= ~LDD_F_NEED_INDEX;
 902                 ldd->ldd_svindex = 0;
 903         }
 904 #ifndef TUNEFS
 905         if (!IS_MGS(ldd) && (mop.mo_mgs_failnodes == 0)) {
 906 #else
 907         /* Don't check --mgs or --mgsnode if print_only is set or
 908          * --erase-params is set. */
 909         if (!IS_MGS(ldd) && (mop.mo_mgs_failnodes == 0) && !print_only &&
 910             !(mop.mo_flags & MO_ERASE_ALL)) {
 911 #endif
 912                 fatal();
 913                 if (IS_MDT(ldd))
 914                         fprintf(stderr, "Must specify --mgs or --mgsnode\n");
 915                 else
 916                         fprintf(stderr, "Must specify --mgsnode\n");
 917                 ret = EINVAL;
 918                 goto out;
 919         }
 920         if ((IS_MDT(ldd) || IS_OST(ldd)) && ldd->ldd_fsname[0] == '\0') {
 921                 fatal();
 922                 fprintf(stderr, "Must specify --fsname for MDT/OST device\n");
 923                 ret = EINVAL;
 924                 goto out;
 925         }
 926
 927         /* These are the permanent mount options (always included) */
 928         ret = osd_prepare_lustre(&mop,
 929                                  wanted_mountopts, sizeof(wanted_mountopts));
 930         if (ret != 0) {
 931                 fatal();
 932                 fprintf(stderr, "unable to prepare backend (%d)\n", ret);
 933                 goto out;
 934         }
 935
 936         if (mountopts) {
 937                 trim_mountfsoptions(mountopts);
 938                 if (check_mountfsoptions(mountopts, wanted_mountopts)) {
 939                         ret = EINVAL;
 940                         goto out;
 941                 }
 942                 snprintf(ldd->ldd_mount_opts, sizeof(ldd->ldd_mount_opts),
 943                          "%s", mountopts);
 944         } else {
 945 #ifdef TUNEFS
 946                 if (ldd->ldd_mount_opts[0] == 0)
 947                 /* use the defaults unless old opts exist */
 948 #endif
 949                 {
 950                         snprintf(ldd->ldd_mount_opts,
 951                                  sizeof(ldd->ldd_mount_opts),
 952                                  "%s", wanted_mountopts);
 953                         trim_mountfsoptions(ldd->ldd_mount_opts);
 954                 }
 955         }
 956
 957         ret = osd_fix_mountopts(&mop, ldd->ldd_mount_opts,
 958                                 sizeof(ldd->ldd_mount_opts));
 959         if (ret != 0) {
 960                 fatal();
 961                 fprintf(stderr, "unable to fix mountfsoptions (%d)\n", ret);
 962                 goto out;
 963         }
 964
 965         if (server_make_name(ldd->ldd_flags, ldd->ldd_svindex,
 966                              ldd->ldd_fsname, ldd->ldd_svname,
 967                              sizeof(ldd->ldd_svname))) {
 968                 printf("unknown server type %#x\n", ldd->ldd_flags);
 969                 goto out;
 970         }
 971
 972         if (verbose >= 0)
 973                 print_ldd("Permanent disk data", &mop);
 974
 975         if (print_only) {
 976                 printf("exiting before disk write.\n");
 977                 goto out;
 978         }
 979
 980         if (check_mtab_entry(mop.mo_device, mop.mo_device, NULL, NULL))
 981                 return(EEXIST);
 982
 983         /* Create the loopback file */
 984         if (mop.mo_flags & MO_IS_LOOP) {
 985                 ret = access(mop.mo_device, F_OK);
 986                 if (ret != 0)
 987                         ret = errno;
 988
 989 #ifndef TUNEFS
 990                 /* Reformat the loopback file */
 991                 if (ret != 0 || (mop.mo_flags & MO_FORCEFORMAT)) {
 992                         ret = loop_format(&mop);
 993                         if (ret != 0)
 994                                 goto out;
 995                 }
 996 #endif
 997                 if (ret == 0)
 998                         ret = loop_setup(&mop);
 999                 if (ret != 0) {
1000                         fatal();
1001                         fprintf(stderr, "Loop device setup for %s failed: %s\n",
1002                                         mop.mo_device, strerror(ret));
1003                         goto out;
1004                 }
1005         }
1006
1007 #ifndef TUNEFS
1008         /* Check whether the disk has already been formatted by mkfs.lustre */
1009         if (!(mop.mo_flags & MO_FORCEFORMAT)) {
1010                 ret = osd_is_lustre(mop.mo_device, &mount_type);
1011                 if (ret != 0) {
1012                         fatal();
1013                         fprintf(stderr, "Device %s was previously formatted "
1014                                 "for lustre. Use --reformat to reformat it, "
1015                                 "or tunefs.lustre to modify.\n",
1016                                 mop.mo_device);
1017                         goto out;
1018                 }
1019         }
1020
1021         /* Format the backing filesystem */
1022         ret = osd_make_lustre(&mop);
1023         if (ret != 0) {
1024                 fatal();
1025                 fprintf(stderr, "mkfs failed %d\n", ret);
1026                 goto out;
1027         }
1028 #else /* TUNEFS */
1029         /* update svname with '=' to refresh config */
1030         if (ldd->ldd_flags & LDD_F_WRITECONF) {
1031                 struct mount_opts opts;
1032                 opts.mo_ldd = *ldd;
1033                 opts.mo_source = mop.mo_device;
1034                 (void) osd_label_lustre(&opts);
1035         }
1036
1037         /* Rename filesystem fsname */
1038         if (mop.mo_flags & MO_RENAME) {
1039                 ret = osd_rename_fsname(&mop, old_fsname);
1040                 if (ret)
1041                         goto out;
1042         }
1043
1044         /* Enable quota accounting */
1045         if (mop.mo_flags & MO_QUOTA) {
1046                 ret = osd_enable_quota(&mop);
1047                 goto out;
1048         }
1049 #endif /* !TUNEFS */
1050
1051         /* Write our config files */
1052         ret = osd_write_ldd(&mop);
1053         if (ret != 0) {
1054                 fatal();
1055                 fprintf(stderr, "failed to write local files\n");
1056                 goto out;
1057         }
1058 out:
1059         osd_fini();
1060         ret2 = loop_cleanup(&mop);
1061         if (ret == 0)
1062                 ret = ret2;
1063
1064         /* Fix any crazy return values from system() */
1065         if (ret != 0 && ((ret & 255) == 0))
1066                 return 1;
1067
1068         if (ret != 0)
1069                 verrprint("%s: exiting with %d (%s)\n",
1070                           progname, ret, strerror(ret));
1071         return ret;
1072 }