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, 2013, Intel Corporation.
26 * lustre/utils/lustre_lfsck.c
28 * Lustre user-space tools for LFSCK.
30 * Author: Fan Yong <yong.fan@whamcloud.com>
43 #include <lustre/lustre_lfsck_user.h>
44 #include <libcfs/libcfsutil.h>
45 #include <lnet/lnetctl.h>
46 #include <lustre_ioctl.h>
48 static struct option long_opt_start[] = {
49 {"device", required_argument, 0, 'M'},
50 {"all", no_argument, 0, 'A'},
51 {"create_ostobj", optional_argument, 0, 'c'},
52 {"error", required_argument, 0, 'e'},
53 {"help", no_argument, 0, 'h'},
54 {"dryrun", optional_argument, 0, 'n'},
55 {"orphan", no_argument, 0, 'o'},
56 {"reset", no_argument, 0, 'r'},
57 {"speed", required_argument, 0, 's'},
58 {"type", required_argument, 0, 't'},
59 {"window_size", required_argument, 0, 'w'},
63 static struct option long_opt_stop[] = {
64 {"device", required_argument, 0, 'M'},
65 {"all", no_argument, 0, 'A'},
66 {"help", no_argument, 0, 'h'},
70 struct lfsck_type_name {
76 static struct lfsck_type_name lfsck_types_names[] = {
77 { "layout", 6, LT_LAYOUT },
78 { "namespace", 9, LT_NAMESPACE},
82 static inline int lfsck_name2type(const char *name, int namelen)
86 while (lfsck_types_names[i].name != NULL) {
87 if (namelen == lfsck_types_names[i].namelen &&
88 strncmp(lfsck_types_names[i].name, name, namelen) == 0)
89 return lfsck_types_names[i].type;
95 static void usage_start(void)
97 fprintf(stderr, "Start LFSCK.\n"
99 "lfsck_start <-M | --device [MDT,OST]_device>\n"
100 " [-A | --all] [-c | --create_ostobj [on | off]]\n"
101 " [-e | --error {continue | abort}] [-h | --help]\n"
102 " [-n | --dryrun [on | off]] [-o | --orphan]\n"
103 " [-r | --reset] [-s | --speed speed_limit]\n"
104 " [-t | --type lfsck_type[,lfsck_type...]]\n"
105 " [-w | --window_size size]\n"
107 "-M: The device to start LFSCK/scrub on.\n"
108 "-A: Start LFSCK on all MDT devices.\n"
109 "-c: Create the lost OST-object for dangling LOV EA: "
110 "'off'(default) or 'on'.\n"
111 "-e: Error handle, 'continue'(default) or 'abort'.\n"
112 "-h: Help information.\n"
113 "-n: Check without modification. 'off'(default) or 'on'.\n"
114 "-o: Handle orphan objects.\n"
115 "-r: Reset scanning start position to the device beginning.\n"
116 " The non-specified parameters will be reset as default.\n"
117 "-s: How many items can be scanned at most per second. "
118 "'%d' means no limit (default).\n"
119 "-t: The LFSCK type(s) to be started.\n"
120 "-w: The window size for async requests pipeline.\n",
121 LFSCK_SPEED_NO_LIMIT);
124 static void usage_stop(void)
126 fprintf(stderr, "Stop LFSCK.\n"
128 "lfsck_stop <-M | --device [MDT,OST]_device>\n"
129 "[-A | --all] [-h | --help]\n"
131 "-M: The device to stop LFSCK/scrub on.\n"
132 "-A: Stop LFSCK on all MDT devices.\n"
133 "-h: Help information.\n");
136 static int lfsck_pack_dev(struct obd_ioctl_data *data, char *device, char *arg)
138 int len = strlen(arg) + 1;
140 if (len > MAX_OBD_NAME) {
141 fprintf(stderr, "device name is too long. "
142 "Valid length should be less than %d\n", MAX_OBD_NAME);
146 memcpy(device, arg, len);
147 data->ioc_inlbuf4 = device;
148 data->ioc_inllen4 = len;
149 data->ioc_dev = OBD_DEV_BY_DEVNAME;
153 int jt_lfsck_start(int argc, char **argv)
155 struct obd_ioctl_data data;
156 char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
157 char device[MAX_OBD_NAME];
158 struct lfsck_start start;
159 char *optstring = "Ac::e:hM:n::ors:t:w:";
160 int opt, index, rc, val, i, type;
162 memset(&data, 0, sizeof(data));
163 memset(&start, 0, sizeof(start));
164 memset(device, 0, MAX_OBD_NAME);
165 start.ls_version = LFSCK_VERSION_V1;
166 start.ls_active = LFSCK_TYPES_DEF;
168 /* Reset the 'optind' for the case of getopt_long() called multiple
169 * times under the same lctl. */
171 while ((opt = getopt_long(argc, argv, optstring, long_opt_start,
175 start.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST;
178 if (optarg == NULL || strcmp(optarg, "on") == 0) {
179 start.ls_flags |= LPF_CREATE_OSTOBJ;
180 } else if (strcmp(optarg, "off") != 0) {
181 fprintf(stderr, "Invalid switch: %s. "
182 "The valid switch should be: 'on' "
183 "or 'off' (default) without blank, "
184 "or empty. For example: '-non' or "
185 "'-noff' or '-n'.\n", optarg);
188 start.ls_valid |= LSV_CREATE_OSTOBJ;
191 if (strcmp(optarg, "abort") == 0) {
192 start.ls_flags |= LPF_FAILOUT;
193 } else if (strcmp(optarg, "continue") != 0) {
194 fprintf(stderr, "Invalid error handler: %s. "
195 "The valid value should be: 'continue'"
196 "(default) or 'abort'.\n", optarg);
199 start.ls_valid |= LSV_ERROR_HANDLE;
205 rc = lfsck_pack_dev(&data, device, optarg);
210 if (optarg == NULL || strcmp(optarg, "on") == 0) {
211 start.ls_flags |= LPF_DRYRUN;
212 } else if (strcmp(optarg, "off") != 0) {
213 fprintf(stderr, "Invalid switch: %s. "
214 "The valid switch should be: 'on' "
215 "or 'off' (default) without blank, "
216 "or empty. For example: '-non' or "
217 "'-noff' or '-n'.\n", optarg);
220 start.ls_valid |= LSV_DRYRUN;
223 start.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST |
227 start.ls_flags |= LPF_RESET;
231 start.ls_speed_limit = val;
232 start.ls_valid |= LSV_SPEED_LIMIT;
235 char *str = optarg, *p, c;
239 while (*str == ' ' || *str == ',')
246 while (*p != 0 && *p != ' ' && *p != ',')
251 type = lfsck_name2type(str, strlen(str));
253 fprintf(stderr, "Invalid type (%s).\n"
254 "The valid value should be "
255 "'layout' or 'namespace'.\n",
264 start.ls_active |= type;
266 if (start.ls_active == 0) {
267 fprintf(stderr, "Miss LFSCK type(s).\n"
268 "The valid value should be "
269 "'layout' or 'namespace'.\n");
276 if (val < 0 || val > LFSCK_ASYNC_WIN_MAX) {
278 "Too large async window size, "
279 "which may cause memory issues. "
280 "The valid range is [0 - %u]. "
281 "If you do not want to restrict "
282 "the window size for async reqeusts "
283 "pipeline, just set it as 0.\n",
284 LFSCK_ASYNC_WIN_MAX);
288 start.ls_async_windows = val;
289 start.ls_valid |= LSV_ASYNC_WINDOWS;
292 fprintf(stderr, "Invalid option, '-h' for help.\n");
297 if (data.ioc_inlbuf4 == NULL) {
298 if (lcfg_get_devname() != NULL) {
299 rc = lfsck_pack_dev(&data, device, lcfg_get_devname());
304 "Must specify device to start LFSCK.\n");
309 data.ioc_inlbuf1 = (char *)&start;
310 data.ioc_inllen1 = sizeof(start);
311 memset(buf, 0, sizeof(rawbuf));
312 rc = obd_ioctl_pack(&data, &buf, sizeof(rawbuf));
314 fprintf(stderr, "Fail to pack ioctl data: rc = %d.\n", rc);
318 rc = l_ioctl(OBD_DEV_ID, OBD_IOC_START_LFSCK, buf);
320 perror("Fail to start LFSCK");
324 obd_ioctl_unpack(&data, buf, sizeof(rawbuf));
325 if (start.ls_active == 0) {
326 printf("Started LFSCK on the device %s", device);
328 printf("Started LFSCK on the device %s:", device);
330 while (lfsck_types_names[i].name != NULL) {
331 if (start.ls_active & lfsck_types_names[i].type) {
332 printf(" %s", lfsck_types_names[i].name);
333 start.ls_active &= ~lfsck_types_names[i].type;
337 if (start.ls_active != 0)
338 printf(" unknown(0x%x)", start.ls_active);
344 int jt_lfsck_stop(int argc, char **argv)
346 struct obd_ioctl_data data;
347 char rawbuf[MAX_IOC_BUFLEN], *buf = rawbuf;
348 char device[MAX_OBD_NAME];
349 struct lfsck_stop stop;
350 char *optstring = "AhM:";
353 memset(&data, 0, sizeof(data));
354 memset(&stop, 0, sizeof(stop));
355 memset(device, 0, MAX_OBD_NAME);
357 /* Reset the 'optind' for the case of getopt_long() called multiple
358 * times under the same lctl. */
360 while ((opt = getopt_long(argc, argv, optstring, long_opt_stop,
364 stop.ls_flags |= LPF_ALL_TGT | LPF_BROADCAST;
370 rc = lfsck_pack_dev(&data, device, optarg);
375 fprintf(stderr, "Invalid option, '-h' for help.\n");
380 if (data.ioc_inlbuf4 == NULL) {
381 if (lcfg_get_devname() != NULL) {
382 rc = lfsck_pack_dev(&data, device, lcfg_get_devname());
387 "Must specify device to stop LFSCK.\n");
392 data.ioc_inlbuf1 = (char *)&stop;
393 data.ioc_inllen1 = sizeof(stop);
394 memset(buf, 0, sizeof(rawbuf));
395 rc = obd_ioctl_pack(&data, &buf, sizeof(rawbuf));
397 fprintf(stderr, "Fail to pack ioctl data: rc = %d.\n", rc);
401 rc = l_ioctl(OBD_DEV_ID, OBD_IOC_STOP_LFSCK, buf);
403 perror("Fail to stop LFSCK");
407 printf("Stopped LFSCK on the device %s.\n", device);