Whamcloud - gitweb
LU-2675 utils: remove loadgen
[fs/lustre-release.git] / lustre / utils / lustre_lfsck.c
index 89ec9b5..ce8263b 100644 (file)
@@ -20,7 +20,7 @@
  * GPL HEADER END
  */
 /*
- * Copyright (c) 2012 Whamcloud, Inc.
+ * Copyright (c) 2012, 2013, Intel Corporation.
  */
 /*
  * lustre/utils/lustre_lfsck.c
 
 #include "obdctl.h"
 
-#include <obd.h>
 #include <lustre/lustre_lfsck_user.h>
 #include <libcfs/libcfsutil.h>
 #include <lnet/lnetctl.h>
+#include <lustre_ioctl.h>
 
 static struct option long_opt_start[] = {
-       {"device",      required_argument, 0, 'M'},
-       {"error",       required_argument, 0, 'e'},
-       {"help",        no_argument,       0, 'h'},
-       {"dryrun",      required_argument, 0, 'n'},
-       {"reset",       no_argument,       0, 'r'},
-       {"speed",       required_argument, 0, 's'},
-       {"type",        required_argument, 0, 't'},
-       {0,             0,                 0,   0}
+       {"device",              required_argument, 0, 'M'},
+       {"all",                 no_argument,       0, 'A'},
+       {"create_ostobj",       optional_argument, 0, 'c'},
+       {"error",               required_argument, 0, 'e'},
+       {"help",                no_argument,       0, 'h'},
+       {"dryrun",              optional_argument, 0, 'n'},
+       {"orphan",              no_argument,       0, 'o'},
+       {"reset",               no_argument,       0, 'r'},
+       {"speed",               required_argument, 0, 's'},
+       {"type",                required_argument, 0, 't'},
+       {"window_size",         required_argument, 0, 'w'},
+       {0,                     0,                 0,  0 }
 };
 
 static struct option long_opt_stop[] = {
        {"device",      required_argument, 0, 'M'},
+       {"all",         no_argument,       0, 'A'},
        {"help",        no_argument,       0, 'h'},
        {0,             0,                 0,   0}
 };
 
-struct lfsck_types_names {
-       char   *name;
-       __u16   type;
+struct lfsck_type_name {
+       char            *ltn_name;
+       enum lfsck_type  ltn_type;
 };
 
-static struct lfsck_types_names lfsck_types_names[3] = {
-       { "layout",     LT_LAYOUT },
-       { "DNE",        LT_DNE },
-       { 0,            0 }
+static struct lfsck_type_name lfsck_types_names[] = {
+       { "scrub",      LFSCK_TYPE_SCRUB },
+       { "layout",     LFSCK_TYPE_LAYOUT },
+       { "namespace",  LFSCK_TYPE_NAMESPACE },
+       { "default",    LFSCK_TYPES_DEF },
+       { "all",        LFSCK_TYPES_SUPPORTED },
+       { NULL,         0 }
 };
 
+static enum lfsck_type lfsck_name2type(const char *name)
+{
+       int i;
+
+       for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++) {
+               if (strcmp(lfsck_types_names[i].ltn_name, name) == 0)
+                       return lfsck_types_names[i].ltn_type;
+       }
+       return -1;
+}
+
 static void usage_start(void)
 {
-       fprintf(stderr, "Start LFSCK.\n"
-               "SYNOPSIS:\n"
-               "lfsck_start <-M | --device MDT_device>\n"
-               "            [-e | --error error_handle] [-h | --help]\n"
-               "            [-n | --dryrun switch] [-r | --reset]\n"
-               "            [-s | --speed speed_limit]\n"
-               "            [-t | --type lfsck_type[,lfsck_type...]]\n"
-               "OPTIONS:\n"
-               "-M: The MDT device to start LFSCK on.\n"
-               "-e: Error handle, 'continue'(default) or 'abort'.\n"
-               "-h: Help information.\n"
-               "-n: Check without modification. 'off'(default) or 'on'.\n"
-               "-r: Reset scanning start position to the device beginning.\n"
-               "-s: How many items can be scanned at most per second. "
-                   "'%d' means no limit (default).\n"
-               "-t: The LFSCK type(s) to be started.\n",
+       fprintf(stderr, "start LFSCK\n"
+               "usage:\n"
+               "lfsck_start <-M | --device {MDT,OST}_device>\n"
+               "            [-A | --all] [-c | --create_ostobj [on | off]]\n"
+               "            [-C | --create_mdtobj [on | off]]\n"
+               "            [-e | --error {continue | abort}] [-h | --help]\n"
+               "            [-n | --dryrun [on | off]] [-o | --orphan]\n"
+               "            [-r | --reset] [-s | --speed ops_per_sec_limit]\n"
+               "            [-t | --type check_type[,check_type...]]\n"
+               "            [-w | --window_size size]\n"
+               "options:\n"
+               "-M: device to start LFSCK/scrub on\n"
+               "-A: start LFSCK on all MDT devices\n"
+               "-c: create the lost OST-object for dangling LOV EA "
+                   "(default 'off', or 'on')\n"
+               "-C: create the lost MDT-object for dangling name entry "
+                   "(default 'off', or 'on')\n"
+               "-e: error handle mode (default 'continue', or 'abort')\n"
+               "-h: this help message\n"
+               "-n: check with no modification (default 'off', or 'on')\n"
+               "-o: repair orphan OST-objects\n"
+               "-r: reset scanning to the start of the device\n"
+               "-s: maximum items to be scanned per second "
+                   "(default '%d' = no limit)\n"
+               "-t: check type(s) to be performed (default all)\n"
+               "-w: window size for async requests pipeline\n",
                LFSCK_SPEED_NO_LIMIT);
 }
 
 static void usage_stop(void)
 {
-       fprintf(stderr, "Stop LFSCK.\n"
-               "SYNOPSIS:\n"
-               "lfsck_stop <-M | --device MDT_device> [-h | --help]\n"
-               "OPTIONS:\n"
-               "-M: The MDT device to stop LFSCK on.\n"
-               "-h: Help information.\n");
+       fprintf(stderr, "stop LFSCK\n"
+               "usage:\n"
+               "lfsck_stop <-M | --device {MDT,OST}_device>\n"
+               "           [-A | --all] [-h | --help]\n"
+               "options:\n"
+               "-M: device to stop LFSCK/scrub on\n"
+               "-A: stop LFSCK on all MDT devices\n"
+               "-h: this help message\n");
 }
 
-static int lfsck_pack_dev(struct obd_ioctl_data *data, char *arg)
+static int lfsck_pack_dev(struct obd_ioctl_data *data, char *device, char *arg)
 {
-       data->ioc_inllen4 = strlen(arg) + 1;
-       if (data->ioc_inllen4 > MAX_OBD_NAME) {
-               fprintf(stderr, "MDT device name is too long. "
+       int len = strlen(arg) + 1;
+
+       if (len > MAX_OBD_NAME) {
+               fprintf(stderr, "device name is too long. "
                        "Valid length should be less than %d\n", MAX_OBD_NAME);
                return -EINVAL;
        }
 
-       data->ioc_inlbuf4 = arg;
+       memcpy(device, arg, len);
+       data->ioc_inlbuf4 = device;
+       data->ioc_inllen4 = len;
        data->ioc_dev = OBD_DEV_BY_DEVNAME;
        return 0;
 }
@@ -124,28 +158,57 @@ int jt_lfsck_start(int argc, char **argv)
        char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
        char device[MAX_OBD_NAME];
        struct lfsck_start start;
-       char *optstring = "M:e:hi:n:rs:t:";
+       char *optstring = "Ac::C::e:hM:n::ors:t:w:";
        int opt, index, rc, val, i;
 
        memset(&data, 0, sizeof(data));
        memset(&start, 0, sizeof(start));
+       memset(device, 0, MAX_OBD_NAME);
        start.ls_version = LFSCK_VERSION_V1;
-       start.ls_active = LFSCK_TYPES_DEF;
+       start.ls_active = LFSCK_TYPES_ALL;
+
+       /* Reset the 'optind' for the case of getopt_long() called multiple
+        * times under the same lctl. */
+       optind = 0;
        while ((opt = getopt_long(argc, argv, optstring, long_opt_start,
                                  &index)) != EOF) {
                switch (opt) {
-               case 'M':
-                       rc = lfsck_pack_dev(&data, optarg);
-                       if (rc != 0)
-                               return rc;
+               case 'A':
+                       start.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST;
+                       break;
+               case 'c':
+                       if (optarg == NULL || strcmp(optarg, "on") == 0) {
+                               start.ls_flags |= LPF_CREATE_OSTOBJ;
+                       } else if (strcmp(optarg, "off") != 0) {
+                               fprintf(stderr, "invalid switch: -c '%s'. "
+                                       "valid switches are:\n"
+                                       "empty ('on'), or 'off' without space. "
+                                       "For example:\n"
+                                       "'-c', '-con', '-coff'\n", optarg);
+                               return -EINVAL;
+                       }
+                       start.ls_valid |= LSV_CREATE_OSTOBJ;
+                       break;
+               case 'C':
+                       if (optarg == NULL || strcmp(optarg, "on") == 0) {
+                               start.ls_flags |= LPF_CREATE_MDTOBJ;
+                       } else if (strcmp(optarg, "off") != 0) {
+                               fprintf(stderr, "invalid switch: -C '%s'. "
+                                       "valid switches are:\n"
+                                       "empty ('on'), or 'off' without space. "
+                                       "For example:\n"
+                                       "'-C', '-Con', '-Coff'\n", optarg);
+                               return -EINVAL;
+                       }
+                       start.ls_valid |= LSV_CREATE_MDTOBJ;
                        break;
                case 'e':
                        if (strcmp(optarg, "abort") == 0) {
                                start.ls_flags |= LPF_FAILOUT;
                        } else if (strcmp(optarg, "continue") != 0) {
-                               fprintf(stderr, "Invalid error handler: %s. "
-                                       "The valid value should be: 'continue'"
-                                       "(default) or 'abort'.\n", optarg);
+                               fprintf(stderr, "invalid error mode: -e '%s'."
+                                       "valid modes are: "
+                                       "'continue' or 'abort'.\n", optarg);
                                return -EINVAL;
                        }
                        start.ls_valid |= LSV_ERROR_HANDLE;
@@ -153,17 +216,28 @@ int jt_lfsck_start(int argc, char **argv)
                case 'h':
                        usage_start();
                        return 0;
+               case 'M':
+                       rc = lfsck_pack_dev(&data, device, optarg);
+                       if (rc != 0)
+                               return rc;
+                       break;
                case 'n':
-                       if (strcmp(optarg, "on") == 0) {
+                       if (optarg == NULL || strcmp(optarg, "on") == 0) {
                                start.ls_flags |= LPF_DRYRUN;
                        } else if (strcmp(optarg, "off") != 0) {
-                               fprintf(stderr, "Invalid dryrun switch: %s. "
-                                       "The valid value shou be: 'off'"
-                                       "(default) or 'on'\n", optarg);
+                               fprintf(stderr, "invalid switch: -n '%s'. "
+                                       "valid switches are:\n"
+                                       "empty ('on'), or 'off' without space. "
+                                       "For example:\n"
+                                       "'-n', '-non', '-noff'\n", optarg);
                                return -EINVAL;
                        }
                        start.ls_valid |= LSV_DRYRUN;
                        break;
+               case 'o':
+                       start.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST |
+                                         LPF_OST_ORPHAN;
+                       break;
                case 'r':
                        start.ls_flags |= LPF_RESET;
                        break;
@@ -173,64 +247,66 @@ int jt_lfsck_start(int argc, char **argv)
                        start.ls_valid |= LSV_SPEED_LIMIT;
                        break;
                case 't': {
-                       char *str = optarg, *p, c;
-
-                       start.ls_active = 0;
-                       while (*str) {
-                               while (*str == ' ' || *str == ',')
-                                       str++;
-
-                               if (*str == 0)
-                                       break;
-
-                               p = str;
-                               while (*p != 0 && *p != ' ' && *p != ',')
-                                       p++;
-
-                               c = *p;
-                               *p = 0;
-                               for (i = 0; i < 3; i++) {
-                                       if (strcmp(str,
-                                                  lfsck_types_names[i].name)
-                                                  == 0) {
-                                               start.ls_active |=
-                                                   lfsck_types_names[i].type;
-                                               break;
-                                       }
-                               }
-                               *p = c;
-                               str = p;
-
-                               if (i >= 3 ) {
-                                       fprintf(stderr, "Invalid LFSCK type.\n"
-                                               "The valid value should be "
-                                               "'layout' or 'DNE'.\n");
-                                       return -EINVAL;
-                               }
+                       char *typename;
+
+                       if (start.ls_active == LFSCK_TYPES_ALL)
+                               start.ls_active = 0;
+                       while ((typename = strsep(&optarg, ",")) != NULL) {
+                               enum lfsck_type type;
+
+                               type = lfsck_name2type(typename);
+                               if (type == -1)
+                                       goto bad_type;
+                               start.ls_active |= type;
                        }
-                       if (start.ls_active == 0) {
-                               fprintf(stderr, "Miss LFSCK type(s).\n"
-                                       "The valid value should be "
-                                       "'layout' or 'DNE'.\n");
+                       break;
+bad_type:
+                       fprintf(stderr, "invalid check type -t '%s'. "
+                               "valid types are:\n", typename);
+                       for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++)
+                               fprintf(stderr, "%s%s", i != 0 ? "," : "",
+                                       lfsck_types_names[i].ltn_name);
+                       fprintf(stderr, "\n");
+                       return -EINVAL;
+               }
+               case 'w':
+                       val = atoi(optarg);
+                       if (val < 0 || val > LFSCK_ASYNC_WIN_MAX) {
+                               fprintf(stderr,
+                                       "Too large async window size, "
+                                       "which may cause memory issues. "
+                                       "The valid range is [0 - %u]. "
+                                       "If you do not want to restrict "
+                                       "the window size for async reqeusts "
+                                       "pipeline, just set it as 0.\n",
+                                       LFSCK_ASYNC_WIN_MAX);
                                return -EINVAL;
                        }
+
+                       start.ls_async_windows = val;
+                       start.ls_valid |= LSV_ASYNC_WINDOWS;
                        break;
-               }
                default:
                        fprintf(stderr, "Invalid option, '-h' for help.\n");
                        return -EINVAL;
                }
        }
 
+       if (start.ls_active == LFSCK_TYPES_ALL)
+               start.ls_active = LFSCK_TYPES_DEF;
+
        if (data.ioc_inlbuf4 == NULL) {
-               fprintf(stderr,
-                       "Must sepcify MDT device to start LFSCK.\n");
-               return -EINVAL;
+               if (lcfg_get_devname() != NULL) {
+                       rc = lfsck_pack_dev(&data, device, lcfg_get_devname());
+                       if (rc != 0)
+                               return rc;
+               } else {
+                       fprintf(stderr,
+                               "Must specify device to start LFSCK.\n");
+                       return -EINVAL;
+               }
        }
 
-       memset(device, 0, MAX_OBD_NAME);
-       memcpy(device, data.ioc_inlbuf4, data.ioc_inllen4);
-       data.ioc_inlbuf4 = device;
        data.ioc_inlbuf1 = (char *)&start;
        data.ioc_inllen1 = sizeof(start);
        memset(buf, 0, sizeof(rawbuf));
@@ -247,20 +323,17 @@ int jt_lfsck_start(int argc, char **argv)
        }
 
        obd_ioctl_unpack(&data, buf, sizeof(rawbuf));
-       printf("Started LFSCK on the MDT device %s:", device);
-       if (start.ls_active == 0) {
-               printf(" noop");
-       } else {
-               for (i = 0; i < 2; i++) {
-                       if (start.ls_active & lfsck_types_names[i].type) {
-                               printf(" %s", lfsck_types_names[i].name);
-                               start.ls_active &= ~lfsck_types_names[i].type;
-                       }
+       printf("Started LFSCK on the device %s: scrub", device);
+       for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++) {
+               if (start.ls_active & lfsck_types_names[i].ltn_type) {
+                       printf(" %s", lfsck_types_names[i].ltn_name);
+                       start.ls_active &= ~lfsck_types_names[i].ltn_type;
                }
-               if (start.ls_active != 0)
-                       printf(" unknown(0x%x)", start.ls_active);
        }
+       if (start.ls_active != 0)
+               printf(" unknown(0x%x)", start.ls_active);
        printf("\n");
+
        return 0;
 }
 
@@ -269,21 +342,31 @@ int jt_lfsck_stop(int argc, char **argv)
        struct obd_ioctl_data data;
        char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
        char device[MAX_OBD_NAME];
-       char *optstring = "M:h";
+       struct lfsck_stop stop;
+       char *optstring = "AhM:";
        int opt, index, rc;
 
        memset(&data, 0, sizeof(data));
+       memset(&stop, 0, sizeof(stop));
+       memset(device, 0, MAX_OBD_NAME);
+
+       /* Reset the 'optind' for the case of getopt_long() called multiple
+        * times under the same lctl. */
+       optind = 0;
        while ((opt = getopt_long(argc, argv, optstring, long_opt_stop,
                                  &index)) != EOF) {
                switch (opt) {
-               case 'M':
-                       rc = lfsck_pack_dev(&data, optarg);
-                       if (rc != 0)
-                               return rc;
+               case 'A':
+                       stop.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST;
                        break;
                case 'h':
                        usage_stop();
                        return 0;
+               case 'M':
+                       rc = lfsck_pack_dev(&data, device, optarg);
+                       if (rc != 0)
+                               return rc;
+                       break;
                default:
                        fprintf(stderr, "Invalid option, '-h' for help.\n");
                        return -EINVAL;
@@ -291,14 +374,19 @@ int jt_lfsck_stop(int argc, char **argv)
        }
 
        if (data.ioc_inlbuf4 == NULL) {
-               fprintf(stderr,
-                       "Must sepcify MDT device to stop LFSCK.\n");
-               return -EINVAL;
+               if (lcfg_get_devname() != NULL) {
+                       rc = lfsck_pack_dev(&data, device, lcfg_get_devname());
+                       if (rc != 0)
+                               return rc;
+               } else {
+                       fprintf(stderr,
+                               "Must specify device to stop LFSCK.\n");
+                       return -EINVAL;
+               }
        }
 
-       memset(device, 0, MAX_OBD_NAME);
-       memcpy(device, data.ioc_inlbuf4, data.ioc_inllen4);
-       data.ioc_inlbuf4 = device;
+       data.ioc_inlbuf1 = (char *)&stop;
+       data.ioc_inllen1 = sizeof(stop);
        memset(buf, 0, sizeof(rawbuf));
        rc = obd_ioctl_pack(&data, &buf, sizeof(rawbuf));
        if (rc) {
@@ -312,6 +400,6 @@ int jt_lfsck_stop(int argc, char **argv)
                return rc;
        }
 
-       printf("Stopped LFSCK on the MDT device %s.\n", device);
+       printf("Stopped LFSCK on the device %s.\n", device);
        return 0;
 }