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,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License version 2 for more details. A copy is
14 * included in the COPYING file that accompanied this code.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * Copyright (c) 2012, 2016, Intel Corporation.
26 * lustre/utils/lustre_lfsck.c
28 * Lustre user-space tools for LFSCK.
30 * Author: Fan Yong <yong.fan@whamcloud.com>
39 #include <sys/ioctl.h>
43 #include "lustreapi_internal.h"
45 #include <lustre/lustre_lfsck_user.h>
46 #include <lnet/lnetctl.h>
47 #include <linux/lustre_ioctl.h>
48 /* Needs to be last to avoid clashes */
49 #include <libcfs/util/ioctl.h>
50 #include <libcfs/util/param.h>
52 static struct option long_opt_start[] = {
53 {"device", required_argument, 0, 'M'},
54 {"all", no_argument, 0, 'A'},
55 {"create_ostobj", optional_argument, 0, 'c'},
56 {"create-ostobj", optional_argument, 0, 'c'},
57 {"create_mdtobj", optional_argument, 0, 'C'},
58 {"create-mdtobj", optional_argument, 0, 'C'},
59 {"delay_create_ostobj", optional_argument, 0, 'd'},
60 {"delay-create-ostobj", optional_argument, 0, 'd'},
61 {"error", required_argument, 0, 'e'},
62 {"help", no_argument, 0, 'h'},
63 {"dryrun", optional_argument, 0, 'n'},
64 {"orphan", no_argument, 0, 'o'},
65 {"reset", no_argument, 0, 'r'},
66 {"speed", required_argument, 0, 's'},
67 {"type", required_argument, 0, 't'},
68 {"window_size", required_argument, 0, 'w'},
69 {"window-size", required_argument, 0, 'w'},
73 static struct option long_opt_stop[] = {
74 {"device", required_argument, 0, 'M'},
75 {"all", no_argument, 0, 'A'},
76 {"help", no_argument, 0, 'h'},
80 static struct option long_opt_query[] = {
81 {"device", required_argument, 0, 'M'},
82 {"type", required_argument, 0, 't'},
83 {"help", no_argument, 0, 'h'},
84 {"wait", no_argument, 0, 'w'},
88 struct lfsck_type_name {
90 enum lfsck_type ltn_type;
93 static struct lfsck_type_name lfsck_types_names[] = {
94 { "scrub", LFSCK_TYPE_SCRUB },
95 { "layout", LFSCK_TYPE_LAYOUT },
96 { "namespace", LFSCK_TYPE_NAMESPACE },
97 { "default", LFSCK_TYPES_DEF },
98 { "all", LFSCK_TYPES_SUPPORTED },
102 static enum lfsck_type lfsck_name2type(const char *name)
106 for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++) {
107 if (strcmp(lfsck_types_names[i].ltn_name, name) == 0)
108 return lfsck_types_names[i].ltn_type;
113 static const char *lfsck_type2name(__u16 type)
117 for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++) {
118 if (type == lfsck_types_names[i].ltn_type)
119 return lfsck_types_names[i].ltn_name;
125 static void usage_start(void)
127 fprintf(stderr, "start LFSCK\n"
129 "lfsck_start [-M | --device {MDT,OST}_device]\n"
130 " [-A | --all] [-c | --create_ostobj [on | off]]\n"
131 " [-C | --create_mdtobj [on | off]]\n"
132 " [-d | --delay_create_ostobj [on | off]]\n"
133 " [-e | --error {continue | abort}] [-h | --help]\n"
134 " [-n | --dryrun [on | off]] [-o | --orphan]\n"
135 " [-r | --reset] [-s | --speed ops_per_sec_limit]\n"
136 " [-t | --type check_type[,check_type...]]\n"
137 " [-w | --window_size size]\n"
139 "-M: device to start LFSCK/scrub on\n"
140 "-A: start LFSCK on all nodes via the specified MDT device "
141 "(see \"-M\" option) by single LFSCK command\n"
142 "-c: create the lost OST-object for dangling LOV EA "
143 "(default 'off', or 'on')\n"
144 "-C: create the lost MDT-object for dangling name entry "
145 "(default 'off', or 'on')\n"
146 "-d: delay create the lost OST-object for dangling LOV EA "
147 "until orphan OST-objects handled (default 'off', or 'on')\n"
148 "-e: error handle mode (default 'continue', or 'abort')\n"
149 "-h: this help message\n"
150 "-n: check with no modification (default 'off', or 'on')\n"
151 "-o: repair orphan OST-objects\n"
152 "-r: reset scanning to the start of the device\n"
153 "-s: maximum items to be scanned per second "
154 "(default '%d' = no limit)\n"
155 "-t: check type(s) to be performed (default all)\n"
156 "-w: window size for async requests pipeline\n",
157 LFSCK_SPEED_NO_LIMIT);
160 static void usage_stop(void)
162 fprintf(stderr, "stop LFSCK\n"
164 "lfsck_stop [-M | --device {MDT,OST}_device]\n"
165 " [-A | --all] [-h | --help]\n"
167 "-M: device to stop LFSCK/scrub on\n"
168 "-A: stop LFSCK on all nodes via the specified MDT device "
169 "(see \"-M\" option) by single LFSCK command\n"
170 "-h: this help message\n");
173 static void usage_query(void)
175 fprintf(stderr, "check the LFSCK global status\n"
177 "lfsck_query [-M | --device MDT_device] [-h | --help]\n"
178 " [-t | --type check_type[,check_type...]]\n"
181 "-M: device to query LFSCK on\n"
182 "-t: LFSCK type(s) to be queried (default is all)\n"
183 "-h: this help message\n"
184 "-w: do not return until LFSCK not running\n");
187 static int lfsck_pack_dev(struct obd_ioctl_data *data, char *device, char *arg)
189 int len = strlen(arg) + 1;
191 if (len > MAX_OBD_NAME) {
192 fprintf(stderr, "device name is too long. "
193 "Valid length should be less than %d\n", MAX_OBD_NAME);
197 memcpy(device, arg, len);
198 data->ioc_inlbuf4 = device;
199 data->ioc_inllen4 = len;
200 data->ioc_dev = OBD_DEV_BY_DEVNAME;
204 static int lfsck_get_dev_name(struct obd_ioctl_data *data, char *device,
205 int types, bool multipe_devices)
207 glob_t param = { 0 };
212 rc = cfs_get_param_paths(¶m, "mdd/*-MDT*");
214 if (multipe_devices || errno != ENOENT ||
215 types & LFSCK_TYPE_NAMESPACE) {
216 fprintf(stderr, "Fail to get device name: rc = %d\n."
217 "You can specify the device explicitly "
218 "via '-M' option.\n", rc);
222 rc = cfs_get_param_paths(¶m, "obdfilter/*-OST*");
224 fprintf(stderr, "Fail to get device name: rc = %d\n."
225 "You can specify the device explicitly "
226 "via '-M' option.\n", rc);
231 if (param.gl_pathc == 1)
234 if (!multipe_devices) {
236 "Detect multiple devices on current node. "
237 "Please specify the device explicitly "
238 "via '-M' option or '-A' option for all.\n");
243 ptr = strrchr(param.gl_pathv[0], '-');
249 for (i = 1; i < param.gl_pathc; i++) {
250 char *ptr2 = strrchr(param.gl_pathv[i], '-');
257 if ((ptr - param.gl_pathv[0]) != (ptr2 - param.gl_pathv[i]) ||
258 strncmp(param.gl_pathv[0], param.gl_pathv[i],
259 (ptr - param.gl_pathv[0])) != 0) {
261 "Detect multiple filesystems on current node. "
262 "Please specify the device explicitly "
263 "via '-M' option.\n");
270 rc = lfsck_pack_dev(data, device, basename(param.gl_pathv[0]));
273 cfs_free_param_data(¶m);
278 int jt_lfsck_start(int argc, char **argv)
280 struct obd_ioctl_data data;
281 char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
282 char device[MAX_OBD_NAME];
283 struct lfsck_start start;
284 char *optstring = "Ac::C::d::e:hM:n::ors:t:w:";
285 int opt, index, rc, val, i;
287 memset(&data, 0, sizeof(data));
288 memset(&start, 0, sizeof(start));
289 memset(device, 0, MAX_OBD_NAME);
290 start.ls_version = LFSCK_VERSION_V1;
291 start.ls_active = LFSCK_TYPES_ALL;
293 /* Reset the 'optind' for the case of getopt_long() called multiple
294 * times under the same lctl. */
296 while ((opt = getopt_long(argc, argv, optstring, long_opt_start,
300 start.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST;
303 if (optarg == NULL || strcmp(optarg, "on") == 0) {
304 start.ls_flags |= LPF_CREATE_OSTOBJ;
305 } else if (strcmp(optarg, "off") != 0) {
306 fprintf(stderr, "invalid switch: -c '%s'. "
307 "valid switches are:\n"
308 "empty ('on'), or 'off' without space. "
310 "'-c', '-con', '-coff'\n", optarg);
313 start.ls_valid |= LSV_CREATE_OSTOBJ;
316 if (optarg == NULL || strcmp(optarg, "on") == 0) {
317 start.ls_flags |= LPF_CREATE_MDTOBJ;
318 } else if (strcmp(optarg, "off") != 0) {
319 fprintf(stderr, "invalid switch: -C '%s'. "
320 "valid switches are:\n"
321 "empty ('on'), or 'off' without space. "
323 "'-C', '-Con', '-Coff'\n", optarg);
326 start.ls_valid |= LSV_CREATE_MDTOBJ;
329 if (optarg == NULL || strcmp(optarg, "on") == 0) {
330 start.ls_flags |= LPF_DELAY_CREATE_OSTOBJ;
331 } else if (strcmp(optarg, "off") != 0) {
332 fprintf(stderr, "invalid switch: -c '%s'. "
333 "valid switches are:\n"
334 "empty ('on'), or 'off' without space. "
336 "'-c', '-con', '-coff'\n", optarg);
339 start.ls_valid |= LSV_DELAY_CREATE_OSTOBJ;
342 if (strcmp(optarg, "abort") == 0) {
343 start.ls_flags |= LPF_FAILOUT;
344 } else if (strcmp(optarg, "continue") != 0) {
345 fprintf(stderr, "invalid error mode: -e '%s'."
347 "'continue' or 'abort'.\n", optarg);
350 start.ls_valid |= LSV_ERROR_HANDLE;
356 rc = lfsck_pack_dev(&data, device, optarg);
361 if (optarg == NULL || strcmp(optarg, "on") == 0) {
362 start.ls_flags |= LPF_DRYRUN;
363 } else if (strcmp(optarg, "off") != 0) {
364 fprintf(stderr, "invalid switch: -n '%s'. "
365 "valid switches are:\n"
366 "empty ('on'), or 'off' without space. "
368 "'-n', '-non', '-noff'\n", optarg);
371 start.ls_valid |= LSV_DRYRUN;
374 start.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST |
378 start.ls_flags |= LPF_RESET;
382 start.ls_speed_limit = val;
383 start.ls_valid |= LSV_SPEED_LIMIT;
388 if (start.ls_active == LFSCK_TYPES_ALL)
390 while ((typename = strsep(&optarg, ",")) != NULL) {
391 enum lfsck_type type;
393 type = lfsck_name2type(typename);
396 start.ls_active |= type;
400 fprintf(stderr, "invalid check type -t '%s'. "
401 "valid types are:\n", typename);
402 for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++)
403 fprintf(stderr, "%s%s", i != 0 ? "," : "",
404 lfsck_types_names[i].ltn_name);
405 fprintf(stderr, "\n");
410 if (val < 1 || val > LFSCK_ASYNC_WIN_MAX) {
412 "Invalid async window size that "
413 "may cause memory issues. The valid "
414 "range is [1 - %u].\n",
415 LFSCK_ASYNC_WIN_MAX);
419 start.ls_async_windows = val;
420 start.ls_valid |= LSV_ASYNC_WINDOWS;
423 fprintf(stderr, "Invalid option, '-h' for help.\n");
428 if (start.ls_active == LFSCK_TYPES_ALL)
429 start.ls_active = LFSCK_TYPES_DEF;
431 if (data.ioc_inlbuf4 == NULL) {
432 rc = lfsck_get_dev_name(&data, device, start.ls_active,
433 start.ls_flags & LPF_ALL_TGT);
438 data.ioc_inlbuf1 = (char *)&start;
439 data.ioc_inllen1 = sizeof(start);
440 memset(buf, 0, sizeof(rawbuf));
441 rc = obd_ioctl_pack(&data, &buf, sizeof(rawbuf));
443 fprintf(stderr, "Fail to pack ioctl data: rc = %d.\n", rc);
447 rc = l_ioctl(OBD_DEV_ID, OBD_IOC_START_LFSCK, buf);
449 perror("Fail to start LFSCK");
453 obd_ioctl_unpack(&data, buf, sizeof(rawbuf));
454 printf("Started LFSCK on the device %s: scrub", device);
455 for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++) {
456 if (start.ls_active & lfsck_types_names[i].ltn_type) {
457 printf(" %s", lfsck_types_names[i].ltn_name);
458 start.ls_active &= ~lfsck_types_names[i].ltn_type;
461 if (start.ls_active != 0)
462 printf(" unknown(0x%x)", start.ls_active);
468 int jt_lfsck_stop(int argc, char **argv)
470 struct obd_ioctl_data data;
471 char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
472 char device[MAX_OBD_NAME];
473 struct lfsck_stop stop;
474 char *optstring = "AhM:";
477 memset(&data, 0, sizeof(data));
478 memset(&stop, 0, sizeof(stop));
479 memset(device, 0, MAX_OBD_NAME);
481 /* Reset the 'optind' for the case of getopt_long() called multiple
482 * times under the same lctl. */
484 while ((opt = getopt_long(argc, argv, optstring, long_opt_stop,
488 stop.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST;
494 rc = lfsck_pack_dev(&data, device, optarg);
499 fprintf(stderr, "Invalid option, '-h' for help.\n");
504 if (data.ioc_inlbuf4 == NULL) {
505 rc = lfsck_get_dev_name(&data, device, 0,
506 stop.ls_flags & LPF_ALL_TGT);
511 data.ioc_inlbuf1 = (char *)&stop;
512 data.ioc_inllen1 = sizeof(stop);
513 memset(buf, 0, sizeof(rawbuf));
514 rc = obd_ioctl_pack(&data, &buf, sizeof(rawbuf));
516 fprintf(stderr, "Fail to pack ioctl data: rc = %d.\n", rc);
520 rc = l_ioctl(OBD_DEV_ID, OBD_IOC_STOP_LFSCK, buf);
522 perror("Fail to stop LFSCK");
526 printf("Stopped LFSCK on the device %s.\n", device);
530 int jt_lfsck_query(int argc, char **argv)
532 struct obd_ioctl_data data = { 0 };
533 char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
534 char device[MAX_OBD_NAME] = "";
535 struct lfsck_query query = { .lu_types = LFSCK_TYPES_ALL };
536 int opt, index, rc, i;
537 enum lfsck_type type;
539 while ((opt = getopt_long(argc, argv, "hM:t:w", long_opt_query,
546 rc = lfsck_pack_dev(&data, device, optarg);
553 if (query.lu_types == LFSCK_TYPES_ALL)
555 while ((typename = strsep(&optarg, ",")) != NULL) {
556 type = lfsck_name2type(typename);
559 query.lu_types |= type;
564 fprintf(stderr, "invalid LFSCK type -t '%s'. "
565 "valid types are:\n", typename);
566 for (i = 0; lfsck_types_names[i].ltn_name != NULL; i++)
567 fprintf(stderr, "%s%s", i != 0 ? "," : "",
568 lfsck_types_names[i].ltn_name);
569 fprintf(stderr, "\n");
573 query.lu_flags |= LPF_WAIT;
576 fprintf(stderr, "Invalid option, '-h' for help.\n");
582 if (data.ioc_inlbuf4 == NULL) {
583 rc = lfsck_get_dev_name(&data, device, 0, true);
588 data.ioc_inlbuf1 = (char *)&query;
589 data.ioc_inllen1 = sizeof(query);
590 memset(buf, 0, sizeof(rawbuf));
591 rc = obd_ioctl_pack(&data, &buf, sizeof(rawbuf));
593 fprintf(stderr, "Fail to pack ioctl data: rc = %d.\n", rc);
597 rc = l_ioctl(OBD_DEV_ID, OBD_IOC_QUERY_LFSCK, buf);
599 perror("Fail to query LFSCK");
603 obd_ioctl_unpack(&data, buf, sizeof(rawbuf));
604 for (i = 0, type = 1 << i; i < LFSCK_TYPE_BITS; i++, type = 1 << i) {
608 if (!(query.lu_types & type))
611 name = lfsck_type2name(type);
612 for (j = 0; j <= LS_MAX; j++)
613 printf("%s_mdts_%s: %d\n", name,
614 lfsck_status2name(j), query.lu_mdts_count[i][j]);
616 for (j = 0; j <= LS_MAX; j++)
617 printf("%s_osts_%s: %d\n", name,
618 lfsck_status2name(j), query.lu_osts_count[i][j]);
620 printf("%s_repaired: %llu\n", name, query.lu_repaired[i]);