Merge branch 'for-chris' of git://repo.or.cz/btrfs-progs-unstable/devel into raid56
[btrfs-progs-unstable/devel.git] / cmds-scrub.c
blobefdfdb4fcba36b59a0cff8c21f2c8aacd4421199
1 /*
2 * Copyright (C) 2011 STRATO. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #include "kerncompat.h"
21 #include <sys/ioctl.h>
22 #include <sys/wait.h>
23 #include <sys/stat.h>
24 #include <sys/types.h>
25 #include <sys/socket.h>
26 #include <sys/un.h>
27 #include <poll.h>
28 #include <sys/file.h>
29 #include <uuid/uuid.h>
30 #include <fcntl.h>
31 #include <unistd.h>
32 #include <pthread.h>
33 #include <ctype.h>
34 #include <signal.h>
35 #include <stdarg.h>
37 #include "ctree.h"
38 #include "ioctl.h"
39 #include "utils.h"
40 #include "volumes.h"
41 #include "disk-io.h"
43 #include "commands.h"
45 static const char * const scrub_cmd_group_usage[] = {
46 "btrfs scrub <command> [options] <path>|<device>",
47 NULL
50 #define SCRUB_DATA_FILE "/var/lib/btrfs/scrub.status"
51 #define SCRUB_PROGRESS_SOCKET_PATH "/var/lib/btrfs/scrub.progress"
52 #define SCRUB_FILE_VERSION_PREFIX "scrub status"
53 #define SCRUB_FILE_VERSION "1"
55 struct scrub_stats {
56 time_t t_start;
57 time_t t_resumed;
58 u64 duration;
59 u64 finished;
60 u64 canceled;
63 struct scrub_progress {
64 struct btrfs_ioctl_scrub_args scrub_args;
65 int fd;
66 int ret;
67 int skip;
68 struct scrub_stats stats;
69 struct scrub_file_record *resumed;
70 int ioctl_errno;
71 pthread_mutex_t progress_mutex;
74 struct scrub_file_record {
75 u8 fsid[BTRFS_FSID_SIZE];
76 u64 devid;
77 struct scrub_stats stats;
78 struct btrfs_scrub_progress p;
81 struct scrub_progress_cycle {
82 int fdmnt;
83 int prg_fd;
84 int do_record;
85 struct btrfs_ioctl_fs_info_args *fi;
86 struct scrub_progress *progress;
87 struct scrub_progress *shared_progress;
88 pthread_mutex_t *write_mutex;
91 struct scrub_fs_stat {
92 struct btrfs_scrub_progress p;
93 struct scrub_stats s;
94 int i;
97 static void print_scrub_full(struct btrfs_scrub_progress *sp)
99 printf("\tdata_extents_scrubbed: %lld\n", sp->data_extents_scrubbed);
100 printf("\ttree_extents_scrubbed: %lld\n", sp->tree_extents_scrubbed);
101 printf("\tdata_bytes_scrubbed: %lld\n", sp->data_bytes_scrubbed);
102 printf("\ttree_bytes_scrubbed: %lld\n", sp->tree_bytes_scrubbed);
103 printf("\tread_errors: %lld\n", sp->read_errors);
104 printf("\tcsum_errors: %lld\n", sp->csum_errors);
105 printf("\tverify_errors: %lld\n", sp->verify_errors);
106 printf("\tno_csum: %lld\n", sp->no_csum);
107 printf("\tcsum_discards: %lld\n", sp->csum_discards);
108 printf("\tsuper_errors: %lld\n", sp->super_errors);
109 printf("\tmalloc_errors: %lld\n", sp->malloc_errors);
110 printf("\tuncorrectable_errors: %lld\n", sp->uncorrectable_errors);
111 printf("\tunverified_errors: %lld\n", sp->unverified_errors);
112 printf("\tcorrected_errors: %lld\n", sp->corrected_errors);
113 printf("\tlast_physical: %lld\n", sp->last_physical);
116 #define ERR(test, ...) do { \
117 if (test) \
118 fprintf(stderr, __VA_ARGS__); \
119 } while (0)
121 #define PRINT_SCRUB_ERROR(test, desc) do { \
122 if (test) \
123 printf(" %s=%llu", desc, test); \
124 } while (0)
126 static void print_scrub_summary(struct btrfs_scrub_progress *p)
128 u64 err_cnt;
129 u64 err_cnt2;
130 char *bytes;
132 err_cnt = p->read_errors +
133 p->csum_errors +
134 p->verify_errors +
135 p->super_errors;
137 err_cnt2 = p->corrected_errors + p->uncorrectable_errors;
139 if (p->malloc_errors)
140 printf("*** WARNING: memory allocation failed while scrubbing. "
141 "results may be inaccurate\n");
142 bytes = pretty_sizes(p->data_bytes_scrubbed + p->tree_bytes_scrubbed);
143 printf("\ttotal bytes scrubbed: %s with %llu errors\n", bytes,
144 max(err_cnt, err_cnt2));
145 free(bytes);
146 if (err_cnt || err_cnt2) {
147 printf("\terror details:");
148 PRINT_SCRUB_ERROR(p->read_errors, "read");
149 PRINT_SCRUB_ERROR(p->super_errors, "super");
150 PRINT_SCRUB_ERROR(p->verify_errors, "verify");
151 PRINT_SCRUB_ERROR(p->csum_errors, "csum");
152 printf("\n");
153 printf("\tcorrected errors: %llu, uncorrectable errors: %llu, "
154 "unverified errors: %llu\n", p->corrected_errors,
155 p->uncorrectable_errors, p->unverified_errors);
159 #define _SCRUB_FS_STAT(p, name, fs_stat) do { \
160 fs_stat->p.name += p->name; \
161 } while (0)
163 #define _SCRUB_FS_STAT_MIN(ss, name, fs_stat) \
164 do { \
165 if (fs_stat->s.name > ss->name) { \
166 fs_stat->s.name = ss->name; \
168 } while (0)
170 #define _SCRUB_FS_STAT_ZMIN(ss, name, fs_stat) \
171 do { \
172 if (!fs_stat->s.name || fs_stat->s.name > ss->name) { \
173 fs_stat->s.name = ss->name; \
175 } while (0)
177 #define _SCRUB_FS_STAT_ZMAX(ss, name, fs_stat) \
178 do { \
179 if (!(fs_stat)->s.name || (fs_stat)->s.name < (ss)->name) { \
180 (fs_stat)->s.name = (ss)->name; \
182 } while (0)
184 static void add_to_fs_stat(struct btrfs_scrub_progress *p,
185 struct scrub_stats *ss,
186 struct scrub_fs_stat *fs_stat)
188 _SCRUB_FS_STAT(p, data_extents_scrubbed, fs_stat);
189 _SCRUB_FS_STAT(p, tree_extents_scrubbed, fs_stat);
190 _SCRUB_FS_STAT(p, data_bytes_scrubbed, fs_stat);
191 _SCRUB_FS_STAT(p, tree_bytes_scrubbed, fs_stat);
192 _SCRUB_FS_STAT(p, read_errors, fs_stat);
193 _SCRUB_FS_STAT(p, csum_errors, fs_stat);
194 _SCRUB_FS_STAT(p, verify_errors, fs_stat);
195 _SCRUB_FS_STAT(p, no_csum, fs_stat);
196 _SCRUB_FS_STAT(p, csum_discards, fs_stat);
197 _SCRUB_FS_STAT(p, super_errors, fs_stat);
198 _SCRUB_FS_STAT(p, malloc_errors, fs_stat);
199 _SCRUB_FS_STAT(p, uncorrectable_errors, fs_stat);
200 _SCRUB_FS_STAT(p, corrected_errors, fs_stat);
201 _SCRUB_FS_STAT(p, last_physical, fs_stat);
202 _SCRUB_FS_STAT_ZMIN(ss, t_start, fs_stat);
203 _SCRUB_FS_STAT_ZMIN(ss, t_resumed, fs_stat);
204 _SCRUB_FS_STAT_ZMAX(ss, duration, fs_stat);
205 _SCRUB_FS_STAT_ZMAX(ss, canceled, fs_stat);
206 _SCRUB_FS_STAT_MIN(ss, finished, fs_stat);
209 static void init_fs_stat(struct scrub_fs_stat *fs_stat)
211 memset(fs_stat, 0, sizeof(*fs_stat));
212 fs_stat->s.finished = 1;
215 static void _print_scrub_ss(struct scrub_stats *ss)
217 char t[4096];
218 struct tm tm;
220 if (!ss || !ss->t_start) {
221 printf("\tno stats available\n");
222 return;
224 if (ss->t_resumed) {
225 localtime_r(&ss->t_resumed, &tm);
226 strftime(t, sizeof(t), "%c", &tm);
227 t[sizeof(t) - 1] = '\0';
228 printf("\tscrub resumed at %s", t);
229 } else {
230 localtime_r(&ss->t_start, &tm);
231 strftime(t, sizeof(t), "%c", &tm);
232 t[sizeof(t) - 1] = '\0';
233 printf("\tscrub started at %s", t);
235 if (ss->finished && !ss->canceled) {
236 printf(" and finished after %llu seconds\n",
237 ss->duration);
238 } else if (ss->canceled) {
239 printf(" and was aborted after %llu seconds\n",
240 ss->duration);
241 } else {
242 printf(", running for %llu seconds\n", ss->duration);
246 static void print_scrub_dev(struct btrfs_ioctl_dev_info_args *di,
247 struct btrfs_scrub_progress *p, int raw,
248 const char *append, struct scrub_stats *ss)
250 printf("scrub device %s (id %llu) %s\n", di->path, di->devid,
251 append ? append : "");
253 _print_scrub_ss(ss);
255 if (p) {
256 if (raw)
257 print_scrub_full(p);
258 else
259 print_scrub_summary(p);
263 static void print_fs_stat(struct scrub_fs_stat *fs_stat, int raw)
265 _print_scrub_ss(&fs_stat->s);
267 if (raw)
268 print_scrub_full(&fs_stat->p);
269 else
270 print_scrub_summary(&fs_stat->p);
273 static void free_history(struct scrub_file_record **last_scrubs)
275 struct scrub_file_record **l = last_scrubs;
276 if (!l)
277 return;
278 while (*l)
279 free(*l++);
280 free(last_scrubs);
284 * cancels a running scrub and makes the master process record the current
285 * progress status before exiting.
287 static int cancel_fd = -1;
288 static void scrub_sigint_record_progress(int signal)
290 ioctl(cancel_fd, BTRFS_IOC_SCRUB_CANCEL, NULL);
293 static int scrub_handle_sigint_parent(void)
295 struct sigaction sa = {
296 .sa_handler = SIG_IGN,
297 .sa_flags = SA_RESTART,
300 return sigaction(SIGINT, &sa, NULL);
303 static int scrub_handle_sigint_child(int fd)
305 struct sigaction sa = {
306 .sa_handler = fd == -1 ? SIG_DFL : scrub_sigint_record_progress,
309 cancel_fd = fd;
310 return sigaction(SIGINT, &sa, NULL);
313 static int scrub_datafile(const char *fn_base, const char *fn_local,
314 const char *fn_tmp, char *datafile, int size)
316 int ret;
317 int end = size - 2;
319 datafile[end + 1] = '\0';
320 strncpy(datafile, fn_base, end);
321 ret = strlen(datafile);
323 if (ret + 1 > end)
324 return -EOVERFLOW;
326 datafile[ret] = '.';
327 strncpy(datafile + ret + 1, fn_local, end - ret - 1);
328 ret = strlen(datafile);
330 if (ret + 1 > end)
331 return -EOVERFLOW;
333 if (fn_tmp) {
334 datafile[ret] = '_';
335 strncpy(datafile + ret + 1, fn_tmp, end - ret - 1);
336 ret = strlen(datafile);
338 if (ret > end)
339 return -EOVERFLOW;
342 return 0;
345 static int scrub_open_file(const char *datafile, int m)
347 int fd;
348 int ret;
350 fd = open(datafile, m, 0600);
351 if (fd < 0)
352 return -errno;
354 ret = flock(fd, LOCK_EX|LOCK_NB);
355 if (ret) {
356 ret = errno;
357 close(fd);
358 return -ret;
361 return fd;
364 static int scrub_open_file_r(const char *fn_base, const char *fn_local)
366 int ret;
367 char datafile[BTRFS_PATH_NAME_MAX + 1];
368 ret = scrub_datafile(fn_base, fn_local, NULL,
369 datafile, sizeof(datafile));
370 if (ret < 0)
371 return ret;
372 return scrub_open_file(datafile, O_RDONLY);
375 static int scrub_open_file_w(const char *fn_base, const char *fn_local,
376 const char *tmp)
378 int ret;
379 char datafile[BTRFS_PATH_NAME_MAX + 1];
380 ret = scrub_datafile(fn_base, fn_local, tmp,
381 datafile, sizeof(datafile));
382 if (ret < 0)
383 return ret;
384 return scrub_open_file(datafile, O_WRONLY|O_CREAT);
387 static int scrub_rename_file(const char *fn_base, const char *fn_local,
388 const char *tmp)
390 int ret;
391 char datafile_old[BTRFS_PATH_NAME_MAX + 1];
392 char datafile_new[BTRFS_PATH_NAME_MAX + 1];
393 ret = scrub_datafile(fn_base, fn_local, tmp,
394 datafile_old, sizeof(datafile_old));
395 if (ret < 0)
396 return ret;
397 ret = scrub_datafile(fn_base, fn_local, NULL,
398 datafile_new, sizeof(datafile_new));
399 if (ret < 0)
400 return ret;
401 ret = rename(datafile_old, datafile_new);
402 return ret ? -errno : 0;
405 #define _SCRUB_KVREAD(ret, i, name, avail, l, dest) if (ret == 0) { \
406 ret = scrub_kvread(i, sizeof(#name), avail, l, #name, dest.name); \
410 * returns 0 if the key did not match (nothing was read)
411 * 1 if the key did match (success)
412 * -1 if the key did match and an error occured
414 static int scrub_kvread(int *i, int len, int avail, const char *buf,
415 const char *key, u64 *dest)
417 int j;
419 if (*i + len + 1 < avail && strncmp(&buf[*i], key, len - 1) == 0) {
420 *i += len - 1;
421 if (buf[*i] != ':')
422 return -1;
423 *i += 1;
424 for (j = 0; isdigit(buf[*i + j]) && *i + j < avail; ++j)
426 if (*i + j >= avail)
427 return -1;
428 *dest = atoll(&buf[*i]);
429 *i += j;
430 return 1;
433 return 0;
436 #define _SCRUB_INVALID do { \
437 if (report_errors) \
438 fprintf(stderr, "WARNING: invalid data in line %d pos " \
439 "%d state %d (near \"%.*s\") at %s:%d\n", \
440 lineno, i, state, 20 > avail ? avail : 20, \
441 l + i, __FILE__, __LINE__); \
442 goto skip; \
443 } while (0)
445 static struct scrub_file_record **scrub_read_file(int fd, int report_errors)
447 int avail = 0;
448 int old_avail = 0;
449 char l[16 * 1024];
450 int state = 0;
451 int curr = -1;
452 int i = 0;
453 int j;
454 int ret;
455 int eof = 0;
456 int lineno = 0;
457 u64 version;
458 char empty_uuid[BTRFS_FSID_SIZE] = {0};
459 struct scrub_file_record **p = NULL;
461 if (fd < 0)
462 return ERR_PTR(-EINVAL);
464 again:
465 old_avail = avail - i;
466 BUG_ON(old_avail < 0);
467 if (old_avail)
468 memmove(l, l + i, old_avail);
469 avail = read(fd, l + old_avail, sizeof(l) - old_avail);
470 if (avail == 0)
471 eof = 1;
472 if (avail == 0 && old_avail == 0) {
473 if (curr >= 0 &&
474 memcmp(p[curr]->fsid, empty_uuid, BTRFS_FSID_SIZE) == 0) {
475 p[curr] = NULL;
476 } else if (curr == -1) {
477 p = ERR_PTR(-ENODATA);
479 return p;
481 if (avail == -1)
482 return ERR_PTR(-errno);
483 avail += old_avail;
485 i = 0;
486 while (i < avail) {
487 switch (state) {
488 case 0: /* start of file */
489 ret = scrub_kvread(&i,
490 sizeof(SCRUB_FILE_VERSION_PREFIX), avail, l,
491 SCRUB_FILE_VERSION_PREFIX, &version);
492 if (ret != 1)
493 _SCRUB_INVALID;
494 if (version != atoll(SCRUB_FILE_VERSION))
495 return ERR_PTR(-ENOTSUP);
496 state = 6;
497 continue;
498 case 1: /* start of line, alloc */
500 * this state makes sure we have a complete line in
501 * further processing, so we don't need wrap-tracking
502 * everywhere.
504 if (!eof && !memchr(l + i, '\n', avail - i))
505 goto again;
506 ++lineno;
507 if (curr > -1 && memcmp(p[curr]->fsid, empty_uuid,
508 BTRFS_FSID_SIZE) == 0) {
509 state = 2;
510 continue;
512 ++curr;
513 p = realloc(p, (curr + 2) * sizeof(*p));
514 if (p)
515 p[curr] = malloc(sizeof(**p));
516 if (!p || !p[curr])
517 return ERR_PTR(-errno);
518 memset(p[curr], 0, sizeof(**p));
519 p[curr + 1] = NULL;
520 ++state;
521 /* fall through */
522 case 2: /* start of line, skip space */
523 while (isspace(l[i]) && i < avail) {
524 if (l[i] == '\n')
525 ++lineno;
526 ++i;
528 if (i >= avail ||
529 (!eof && !memchr(l + i, '\n', avail - i)))
530 goto again;
531 ++state;
532 /* fall through */
533 case 3: /* read fsid */
534 if (i == avail)
535 continue;
536 for (j = 0; l[i + j] != ':' && i + j < avail; ++j)
538 if (i + j + 1 >= avail)
539 _SCRUB_INVALID;
540 if (j != 36)
541 _SCRUB_INVALID;
542 l[i + j] = '\0';
543 ret = uuid_parse(l + i, p[curr]->fsid);
544 if (ret)
545 _SCRUB_INVALID;
546 i += j + 1;
547 ++state;
548 /* fall through */
549 case 4: /* read dev id */
550 for (j = 0; isdigit(l[i + j]) && i+j < avail; ++j)
552 if (j == 0 || i + j + 1 >= avail)
553 _SCRUB_INVALID;
554 p[curr]->devid = atoll(&l[i]);
555 i += j + 1;
556 ++state;
557 /* fall through */
558 case 5: /* read key/value pair */
559 ret = 0;
560 _SCRUB_KVREAD(ret, &i, data_extents_scrubbed, avail, l,
561 &p[curr]->p);
562 _SCRUB_KVREAD(ret, &i, data_extents_scrubbed, avail, l,
563 &p[curr]->p);
564 _SCRUB_KVREAD(ret, &i, tree_extents_scrubbed, avail, l,
565 &p[curr]->p);
566 _SCRUB_KVREAD(ret, &i, data_bytes_scrubbed, avail, l,
567 &p[curr]->p);
568 _SCRUB_KVREAD(ret, &i, tree_bytes_scrubbed, avail, l,
569 &p[curr]->p);
570 _SCRUB_KVREAD(ret, &i, read_errors, avail, l,
571 &p[curr]->p);
572 _SCRUB_KVREAD(ret, &i, csum_errors, avail, l,
573 &p[curr]->p);
574 _SCRUB_KVREAD(ret, &i, verify_errors, avail, l,
575 &p[curr]->p);
576 _SCRUB_KVREAD(ret, &i, no_csum, avail, l,
577 &p[curr]->p);
578 _SCRUB_KVREAD(ret, &i, csum_discards, avail, l,
579 &p[curr]->p);
580 _SCRUB_KVREAD(ret, &i, super_errors, avail, l,
581 &p[curr]->p);
582 _SCRUB_KVREAD(ret, &i, malloc_errors, avail, l,
583 &p[curr]->p);
584 _SCRUB_KVREAD(ret, &i, uncorrectable_errors, avail, l,
585 &p[curr]->p);
586 _SCRUB_KVREAD(ret, &i, corrected_errors, avail, l,
587 &p[curr]->p);
588 _SCRUB_KVREAD(ret, &i, last_physical, avail, l,
589 &p[curr]->p);
590 _SCRUB_KVREAD(ret, &i, finished, avail, l,
591 &p[curr]->stats);
592 _SCRUB_KVREAD(ret, &i, t_start, avail, l,
593 (u64 *)&p[curr]->stats);
594 _SCRUB_KVREAD(ret, &i, t_resumed, avail, l,
595 (u64 *)&p[curr]->stats);
596 _SCRUB_KVREAD(ret, &i, duration, avail, l,
597 (u64 *)&p[curr]->stats);
598 _SCRUB_KVREAD(ret, &i, canceled, avail, l,
599 &p[curr]->stats);
600 if (ret != 1)
601 _SCRUB_INVALID;
602 ++state;
603 /* fall through */
604 case 6: /* after number */
605 if (l[i] == '|')
606 state = 5;
607 else if (l[i] == '\n')
608 state = 1;
609 else
610 _SCRUB_INVALID;
611 ++i;
612 continue;
613 case 99: /* skip rest of line */
614 skip:
615 state = 99;
616 do {
617 ++i;
618 if (l[i - 1] == '\n') {
619 state = 1;
620 break;
622 } while (i < avail);
623 continue;
625 BUG();
627 goto again;
630 static int scrub_write_buf(int fd, const void *data, int len)
632 int ret;
633 ret = write(fd, data, len);
634 return ret - len;
637 static int scrub_writev(int fd, char *buf, int max, const char *fmt, ...)
638 __attribute__ ((format (printf, 4, 5)));
639 static int scrub_writev(int fd, char *buf, int max, const char *fmt, ...)
641 int ret;
642 va_list args;
644 va_start(args, fmt);
645 ret = vsnprintf(buf, max, fmt, args);
646 va_end(args);
647 if (ret >= max)
648 return ret - max;
649 return scrub_write_buf(fd, buf, ret);
652 #define _SCRUB_SUM(dest, data, name) dest->scrub_args.progress.name = \
653 data->resumed->p.name + data->scrub_args.progress.name
655 static struct scrub_progress *scrub_resumed_stats(struct scrub_progress *data,
656 struct scrub_progress *dest)
658 if (!data->resumed || data->skip)
659 return data;
661 _SCRUB_SUM(dest, data, data_extents_scrubbed);
662 _SCRUB_SUM(dest, data, tree_extents_scrubbed);
663 _SCRUB_SUM(dest, data, data_bytes_scrubbed);
664 _SCRUB_SUM(dest, data, tree_bytes_scrubbed);
665 _SCRUB_SUM(dest, data, read_errors);
666 _SCRUB_SUM(dest, data, csum_errors);
667 _SCRUB_SUM(dest, data, verify_errors);
668 _SCRUB_SUM(dest, data, no_csum);
669 _SCRUB_SUM(dest, data, csum_discards);
670 _SCRUB_SUM(dest, data, super_errors);
671 _SCRUB_SUM(dest, data, malloc_errors);
672 _SCRUB_SUM(dest, data, uncorrectable_errors);
673 _SCRUB_SUM(dest, data, corrected_errors);
674 _SCRUB_SUM(dest, data, last_physical);
675 dest->stats.canceled = data->stats.canceled;
676 dest->stats.finished = data->stats.finished;
677 dest->stats.t_resumed = data->stats.t_start;
678 dest->stats.t_start = data->resumed->stats.t_start;
679 dest->stats.duration = data->resumed->stats.duration +
680 data->stats.duration;
681 dest->scrub_args.devid = data->scrub_args.devid;
682 return dest;
685 #define _SCRUB_KVWRITE(fd, buf, name, use) \
686 scrub_kvwrite(fd, buf, sizeof(buf), #name, \
687 use->scrub_args.progress.name)
689 #define _SCRUB_KVWRITE_STATS(fd, buf, name, use) \
690 scrub_kvwrite(fd, buf, sizeof(buf), #name, \
691 use->stats.name)
693 static int scrub_kvwrite(int fd, char *buf, int max, const char *key, u64 val)
695 return scrub_writev(fd, buf, max, "|%s:%lld", key, val);
698 static int scrub_write_file(int fd, const char *fsid,
699 struct scrub_progress *data, int n)
701 int ret = 0;
702 int i;
703 char buf[1024];
704 struct scrub_progress local;
705 struct scrub_progress *use;
707 if (n < 1)
708 return -EINVAL;
710 /* each -1 is to subtract one \0 byte, the + 2 is for ':' and '\n' */
711 ret = scrub_write_buf(fd, SCRUB_FILE_VERSION_PREFIX ":"
712 SCRUB_FILE_VERSION "\n",
713 (sizeof(SCRUB_FILE_VERSION_PREFIX) - 1) +
714 (sizeof(SCRUB_FILE_VERSION) - 1) + 2);
715 if (ret)
716 return -EOVERFLOW;
718 for (i = 0; i < n; ++i) {
719 use = scrub_resumed_stats(&data[i], &local);
720 if (scrub_write_buf(fd, fsid, strlen(fsid)) ||
721 scrub_write_buf(fd, ":", 1) ||
722 scrub_writev(fd, buf, sizeof(buf), "%lld",
723 use->scrub_args.devid) ||
724 scrub_write_buf(fd, buf, ret) ||
725 _SCRUB_KVWRITE(fd, buf, data_extents_scrubbed, use) ||
726 _SCRUB_KVWRITE(fd, buf, tree_extents_scrubbed, use) ||
727 _SCRUB_KVWRITE(fd, buf, data_bytes_scrubbed, use) ||
728 _SCRUB_KVWRITE(fd, buf, tree_bytes_scrubbed, use) ||
729 _SCRUB_KVWRITE(fd, buf, read_errors, use) ||
730 _SCRUB_KVWRITE(fd, buf, csum_errors, use) ||
731 _SCRUB_KVWRITE(fd, buf, verify_errors, use) ||
732 _SCRUB_KVWRITE(fd, buf, no_csum, use) ||
733 _SCRUB_KVWRITE(fd, buf, csum_discards, use) ||
734 _SCRUB_KVWRITE(fd, buf, super_errors, use) ||
735 _SCRUB_KVWRITE(fd, buf, malloc_errors, use) ||
736 _SCRUB_KVWRITE(fd, buf, uncorrectable_errors, use) ||
737 _SCRUB_KVWRITE(fd, buf, corrected_errors, use) ||
738 _SCRUB_KVWRITE(fd, buf, last_physical, use) ||
739 _SCRUB_KVWRITE_STATS(fd, buf, t_start, use) ||
740 _SCRUB_KVWRITE_STATS(fd, buf, t_resumed, use) ||
741 _SCRUB_KVWRITE_STATS(fd, buf, duration, use) ||
742 _SCRUB_KVWRITE_STATS(fd, buf, canceled, use) ||
743 _SCRUB_KVWRITE_STATS(fd, buf, finished, use) ||
744 scrub_write_buf(fd, "\n", 1)) {
745 return -EOVERFLOW;
749 return 0;
752 static int scrub_write_progress(pthread_mutex_t *m, const char *fsid,
753 struct scrub_progress *data, int n)
755 int ret;
756 int err;
757 int fd = 0;
758 int old;
760 ret = pthread_mutex_lock(m);
761 if (ret) {
762 err = -errno;
763 goto out;
766 ret = pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old);
767 if (ret) {
768 err = -ret;
769 goto out;
772 fd = scrub_open_file_w(SCRUB_DATA_FILE, fsid, "tmp");
773 if (fd < 0) {
774 err = fd;
775 goto out;
777 err = scrub_write_file(fd, fsid, data, n);
778 if (err)
779 goto out;
780 err = scrub_rename_file(SCRUB_DATA_FILE, fsid, "tmp");
781 if (err)
782 goto out;
784 out:
785 if (fd > 0) {
786 ret = close(fd);
787 if (ret)
788 err = -errno;
791 ret = pthread_mutex_unlock(m);
792 if (ret && !err)
793 err = -ret;
795 ret = pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &old);
796 if (ret && !err)
797 err = -ret;
799 return err;
802 static void *scrub_one_dev(void *ctx)
804 struct scrub_progress *sp = ctx;
805 int ret;
806 struct timeval tv;
808 sp->stats.canceled = 0;
809 sp->stats.duration = 0;
810 sp->stats.finished = 0;
812 ret = ioctl(sp->fd, BTRFS_IOC_SCRUB, &sp->scrub_args);
813 gettimeofday(&tv, NULL);
814 sp->ret = ret;
815 sp->stats.duration = tv.tv_sec - sp->stats.t_start;
816 sp->stats.canceled = !!ret;
817 sp->ioctl_errno = errno;
818 ret = pthread_mutex_lock(&sp->progress_mutex);
819 if (ret)
820 return ERR_PTR(-ret);
821 sp->stats.finished = 1;
822 ret = pthread_mutex_unlock(&sp->progress_mutex);
823 if (ret)
824 return ERR_PTR(-ret);
826 return NULL;
829 static void *progress_one_dev(void *ctx)
831 struct scrub_progress *sp = ctx;
833 sp->ret = ioctl(sp->fd, BTRFS_IOC_SCRUB_PROGRESS, &sp->scrub_args);
834 sp->ioctl_errno = errno;
836 return NULL;
839 static void *scrub_progress_cycle(void *ctx)
841 int ret;
842 int old;
843 int i;
844 char fsid[37];
845 struct scrub_progress *sp;
846 struct scrub_progress *sp_last;
847 struct scrub_progress *sp_shared;
848 struct timeval tv;
849 struct scrub_progress_cycle *spc = ctx;
850 int ndev = spc->fi->num_devices;
851 int this = 1;
852 int last = 0;
853 int peer_fd = -1;
854 struct pollfd accept_poll_fd = {
855 .fd = spc->prg_fd,
856 .events = POLLIN,
857 .revents = 0,
859 struct pollfd write_poll_fd = {
860 .events = POLLOUT,
861 .revents = 0,
863 struct sockaddr_un peer;
864 socklen_t peer_size = sizeof(peer);
866 ret = pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &old);
867 if (ret)
868 return ERR_PTR(-ret);
870 uuid_unparse(spc->fi->fsid, fsid);
872 for (i = 0; i < ndev; ++i) {
873 sp = &spc->progress[i];
874 sp_last = &spc->progress[i + ndev];
875 sp_shared = &spc->shared_progress[i];
876 sp->scrub_args.devid = sp_last->scrub_args.devid =
877 sp_shared->scrub_args.devid;
878 sp->fd = sp_last->fd = spc->fdmnt;
879 sp->stats.t_start = sp_last->stats.t_start =
880 sp_shared->stats.t_start;
881 sp->resumed = sp_last->resumed = sp_shared->resumed;
882 sp->skip = sp_last->skip = sp_shared->skip;
883 sp->stats.finished = sp_last->stats.finished =
884 sp_shared->stats.finished;
887 while (1) {
888 ret = poll(&accept_poll_fd, 1, 5 * 1000);
889 if (ret == -1)
890 return ERR_PTR(-errno);
891 if (ret)
892 peer_fd = accept(spc->prg_fd, (struct sockaddr *)&peer,
893 &peer_size);
894 gettimeofday(&tv, NULL);
895 this = (this + 1)%2;
896 last = (last + 1)%2;
897 for (i = 0; i < ndev; ++i) {
898 sp = &spc->progress[this * ndev + i];
899 sp_last = &spc->progress[last * ndev + i];
900 sp_shared = &spc->shared_progress[i];
901 if (sp->stats.finished)
902 continue;
903 progress_one_dev(sp);
904 sp->stats.duration = tv.tv_sec - sp->stats.t_start;
905 if (!sp->ret)
906 continue;
907 if (sp->ioctl_errno != ENOTCONN &&
908 sp->ioctl_errno != ENODEV)
909 return ERR_PTR(-sp->ioctl_errno);
911 * scrub finished or device removed, check the
912 * finished flag. if unset, just use the last
913 * result we got for the current write and go
914 * on. flag should be set on next cycle, then.
916 ret = pthread_mutex_lock(&sp_shared->progress_mutex);
917 if (ret)
918 return ERR_PTR(-ret);
919 if (!sp_shared->stats.finished) {
920 ret = pthread_mutex_unlock(
921 &sp_shared->progress_mutex);
922 if (ret)
923 return ERR_PTR(-ret);
924 memcpy(sp, sp_last, sizeof(*sp));
925 continue;
927 ret = pthread_mutex_unlock(&sp_shared->progress_mutex);
928 if (ret)
929 return ERR_PTR(-ret);
930 memcpy(sp, sp_shared, sizeof(*sp));
931 memcpy(sp_last, sp_shared, sizeof(*sp));
933 if (peer_fd != -1) {
934 write_poll_fd.fd = peer_fd;
935 ret = poll(&write_poll_fd, 1, 0);
936 if (ret == -1)
937 return ERR_PTR(-errno);
938 if (ret) {
939 ret = scrub_write_file(
940 peer_fd, fsid,
941 &spc->progress[this * ndev], ndev);
942 if (ret)
943 return ERR_PTR(ret);
945 close(peer_fd);
946 peer_fd = -1;
948 if (!spc->do_record)
949 continue;
950 ret = scrub_write_progress(spc->write_mutex, fsid,
951 &spc->progress[this * ndev], ndev);
952 if (ret)
953 return ERR_PTR(ret);
957 static struct scrub_file_record *last_dev_scrub(
958 struct scrub_file_record *const *const past_scrubs, u64 devid)
960 int i;
962 if (!past_scrubs || IS_ERR(past_scrubs))
963 return NULL;
965 for (i = 0; past_scrubs[i]; ++i)
966 if (past_scrubs[i]->devid == devid)
967 return past_scrubs[i];
969 return NULL;
972 int mkdir_p(char *path)
974 int i;
975 int ret;
977 for (i = 1; i < strlen(path); ++i) {
978 if (path[i] != '/')
979 continue;
980 path[i] = '\0';
981 ret = mkdir(path, 0777);
982 if (ret && errno != EEXIST)
983 return 1;
984 path[i] = '/';
987 return 0;
990 static const char * const cmd_scrub_start_usage[];
991 static const char * const cmd_scrub_resume_usage[];
993 static int scrub_start(int argc, char **argv, int resume)
995 int fdmnt;
996 int prg_fd = -1;
997 int fdres = -1;
998 int ret;
999 pid_t pid;
1000 int c;
1001 int i;
1002 int err = 0;
1003 int e_uncorrectable = 0;
1004 int e_correctable = 0;
1005 int print_raw = 0;
1006 char *path;
1007 int do_background = 1;
1008 int do_wait = 0;
1009 int do_print = 0;
1010 int do_quiet = 0;
1011 int do_record = 1;
1012 int readonly = 0;
1013 int do_stats_per_dev = 0;
1014 int n_start = 0;
1015 int n_skip = 0;
1016 int n_resume = 0;
1017 struct btrfs_ioctl_fs_info_args fi_args;
1018 struct btrfs_ioctl_dev_info_args *di_args = NULL;
1019 struct scrub_progress *sp = NULL;
1020 struct scrub_fs_stat fs_stat;
1021 struct timeval tv;
1022 struct sockaddr_un addr = {
1023 .sun_family = AF_UNIX,
1025 pthread_t *t_devs = NULL;
1026 pthread_t t_prog;
1027 pthread_attr_t t_attr;
1028 struct scrub_file_record **past_scrubs = NULL;
1029 struct scrub_file_record *last_scrub = NULL;
1030 char *datafile = strdup(SCRUB_DATA_FILE);
1031 char fsid[37];
1032 char sock_path[BTRFS_PATH_NAME_MAX + 1] = "";
1033 struct scrub_progress_cycle spc;
1034 pthread_mutex_t spc_write_mutex = PTHREAD_MUTEX_INITIALIZER;
1035 void *terr;
1036 u64 devid;
1038 optind = 1;
1039 while ((c = getopt(argc, argv, "BdqrR")) != -1) {
1040 switch (c) {
1041 case 'B':
1042 do_background = 0;
1043 do_wait = 1;
1044 do_print = 1;
1045 break;
1046 case 'd':
1047 do_stats_per_dev = 1;
1048 break;
1049 case 'q':
1050 do_quiet = 1;
1051 break;
1052 case 'r':
1053 readonly = 1;
1054 break;
1055 case 'R':
1056 print_raw = 1;
1057 break;
1058 case '?':
1059 default:
1060 usage(resume ? cmd_scrub_resume_usage :
1061 cmd_scrub_start_usage);
1065 /* try to catch most error cases before forking */
1067 if (check_argc_exact(argc - optind, 1)) {
1068 usage(resume ? cmd_scrub_resume_usage :
1069 cmd_scrub_start_usage);
1072 spc.progress = NULL;
1073 if (do_quiet && do_print)
1074 do_print = 0;
1076 if (mkdir_p(datafile)) {
1077 ERR(!do_quiet, "WARNING: cannot create scrub data "
1078 "file, mkdir %s failed: %s. Status recording "
1079 "disabled\n", datafile, strerror(errno));
1080 do_record = 0;
1082 free(datafile);
1084 path = argv[optind];
1086 fdmnt = open_file_or_dir(path);
1087 if (fdmnt < 0) {
1088 ERR(!do_quiet, "ERROR: can't access '%s'\n", path);
1089 return 12;
1092 ret = get_fs_info(fdmnt, path, &fi_args, &di_args);
1093 if (ret) {
1094 ERR(!do_quiet, "ERROR: getting dev info for scrub failed: "
1095 "%s\n", strerror(-ret));
1096 err = 1;
1097 goto out;
1099 if (!fi_args.num_devices) {
1100 ERR(!do_quiet, "ERROR: no devices found\n");
1101 err = 1;
1102 goto out;
1105 uuid_unparse(fi_args.fsid, fsid);
1106 fdres = scrub_open_file_r(SCRUB_DATA_FILE, fsid);
1107 if (fdres < 0 && fdres != -ENOENT) {
1108 ERR(!do_quiet, "WARNING: failed to open status file: "
1109 "%s\n", strerror(-fdres));
1110 } else if (fdres >= 0) {
1111 past_scrubs = scrub_read_file(fdres, !do_quiet);
1112 if (IS_ERR(past_scrubs))
1113 ERR(!do_quiet, "WARNING: failed to read status file: "
1114 "%s\n", strerror(-PTR_ERR(past_scrubs)));
1115 close(fdres);
1118 t_devs = malloc(fi_args.num_devices * sizeof(*t_devs));
1119 sp = calloc(fi_args.num_devices, sizeof(*sp));
1120 spc.progress = calloc(fi_args.num_devices * 2, sizeof(*spc.progress));
1122 if (!t_devs || !sp || !spc.progress) {
1123 ERR(!do_quiet, "ERROR: scrub failed: %s", strerror(errno));
1124 err = 1;
1125 goto out;
1128 ret = pthread_attr_init(&t_attr);
1129 if (ret) {
1130 ERR(!do_quiet, "ERROR: pthread_attr_init failed: %s\n",
1131 strerror(ret));
1132 err = 1;
1133 goto out;
1136 for (i = 0; i < fi_args.num_devices; ++i) {
1137 devid = di_args[i].devid;
1138 ret = pthread_mutex_init(&sp[i].progress_mutex, NULL);
1139 if (ret) {
1140 ERR(!do_quiet, "ERROR: pthread_mutex_init failed: "
1141 "%s\n", strerror(ret));
1142 err = 1;
1143 goto out;
1145 last_scrub = last_dev_scrub(past_scrubs, devid);
1146 sp[i].scrub_args.devid = devid;
1147 sp[i].fd = fdmnt;
1148 if (resume && last_scrub && (last_scrub->stats.canceled ||
1149 !last_scrub->stats.finished)) {
1150 ++n_resume;
1151 sp[i].scrub_args.start = last_scrub->p.last_physical;
1152 sp[i].resumed = last_scrub;
1153 } else if (resume) {
1154 ++n_skip;
1155 sp[i].skip = 1;
1156 sp[i].resumed = last_scrub;
1157 continue;
1158 } else {
1159 ++n_start;
1160 sp[i].scrub_args.start = 0ll;
1161 sp[i].resumed = NULL;
1163 sp[i].skip = 0;
1164 sp[i].scrub_args.end = (u64)-1ll;
1165 sp[i].scrub_args.flags = readonly ? BTRFS_SCRUB_READONLY : 0;
1168 if (!n_start && !n_resume) {
1169 if (!do_quiet)
1170 printf("scrub: nothing to resume for %s, fsid %s\n",
1171 path, fsid);
1172 err = 0;
1173 goto out;
1176 ret = prg_fd = socket(AF_UNIX, SOCK_STREAM, 0);
1177 while (ret != -1) {
1178 ret = scrub_datafile(SCRUB_PROGRESS_SOCKET_PATH, fsid, NULL,
1179 sock_path, sizeof(sock_path));
1180 /* ignore EOVERFLOW, try using a shorter path for the socket */
1181 addr.sun_path[sizeof(addr.sun_path) - 1] = '\0';
1182 strncpy(addr.sun_path, sock_path, sizeof(addr.sun_path) - 1);
1183 ret = bind(prg_fd, (struct sockaddr *)&addr, sizeof(addr));
1184 if (ret != -1 || errno != EADDRINUSE)
1185 break;
1187 * bind failed with EADDRINUSE. so let's see if anyone answers
1188 * when we make a call to the socket ...
1190 ret = connect(prg_fd, (struct sockaddr *)&addr, sizeof(addr));
1191 if (!ret || errno != ECONNREFUSED) {
1192 /* ... yes, so scrub must be running. error out */
1193 fprintf(stderr, "ERROR: scrub already running\n");
1194 close(prg_fd);
1195 goto out;
1198 * ... no, this means someone left us alone with an unused
1199 * socket in the file system. remove it and try again.
1201 ret = unlink(sock_path);
1203 if (ret != -1)
1204 ret = listen(prg_fd, 100);
1205 if (ret == -1) {
1206 ERR(!do_quiet, "WARNING: failed to open the progress status "
1207 "socket at %s: %s. Progress cannot be queried\n",
1208 sock_path[0] ? sock_path : SCRUB_PROGRESS_SOCKET_PATH,
1209 strerror(errno));
1210 if (prg_fd != -1) {
1211 close(prg_fd);
1212 prg_fd = -1;
1213 if (sock_path[0])
1214 unlink(sock_path);
1218 if (do_record) {
1219 /* write all-zero progress file for a start */
1220 ret = scrub_write_progress(&spc_write_mutex, fsid, sp,
1221 fi_args.num_devices);
1222 if (ret) {
1223 ERR(!do_quiet, "WARNING: failed to write the progress "
1224 "status file: %s. Status recording disabled\n",
1225 strerror(-ret));
1226 do_record = 0;
1230 if (do_background) {
1231 pid = fork();
1232 if (pid == -1) {
1233 ERR(!do_quiet, "ERROR: cannot scrub, fork failed: "
1234 "%s\n", strerror(errno));
1235 err = 1;
1236 goto out;
1239 if (pid) {
1240 int stat;
1241 scrub_handle_sigint_parent();
1242 if (!do_quiet)
1243 printf("scrub %s on %s, fsid %s (pid=%d)\n",
1244 n_start ? "started" : "resumed",
1245 path, fsid, pid);
1246 if (!do_wait) {
1247 err = 0;
1248 goto out;
1250 ret = wait(&stat);
1251 if (ret != pid) {
1252 ERR(!do_quiet, "ERROR: wait failed: (ret=%d) "
1253 "%s\n", ret, strerror(errno));
1254 err = 1;
1255 goto out;
1257 if (!WIFEXITED(stat) || WEXITSTATUS(stat)) {
1258 ERR(!do_quiet, "ERROR: scrub process failed\n");
1259 err = WIFEXITED(stat) ? WEXITSTATUS(stat) : -1;
1260 goto out;
1262 err = 0;
1263 goto out;
1267 scrub_handle_sigint_child(fdmnt);
1269 for (i = 0; i < fi_args.num_devices; ++i) {
1270 if (sp[i].skip) {
1271 sp[i].scrub_args.progress = sp[i].resumed->p;
1272 sp[i].stats = sp[i].resumed->stats;
1273 sp[i].ret = 0;
1274 sp[i].stats.finished = 1;
1275 continue;
1277 devid = di_args[i].devid;
1278 gettimeofday(&tv, NULL);
1279 sp[i].stats.t_start = tv.tv_sec;
1280 ret = pthread_create(&t_devs[i], &t_attr,
1281 scrub_one_dev, &sp[i]);
1282 if (ret) {
1283 if (do_print)
1284 fprintf(stderr, "ERROR: creating "
1285 "scrub_one_dev[%llu] thread failed: "
1286 "%s\n", devid, strerror(ret));
1287 err = 1;
1288 goto out;
1292 spc.fdmnt = fdmnt;
1293 spc.prg_fd = prg_fd;
1294 spc.do_record = do_record;
1295 spc.write_mutex = &spc_write_mutex;
1296 spc.shared_progress = sp;
1297 spc.fi = &fi_args;
1298 ret = pthread_create(&t_prog, &t_attr, scrub_progress_cycle, &spc);
1299 if (ret) {
1300 if (do_print)
1301 fprintf(stderr, "ERROR: creating progress thread "
1302 "failed: %s\n", strerror(ret));
1303 err = 1;
1304 goto out;
1307 err = 0;
1308 for (i = 0; i < fi_args.num_devices; ++i) {
1309 if (sp[i].skip)
1310 continue;
1311 devid = di_args[i].devid;
1312 ret = pthread_join(t_devs[i], NULL);
1313 if (ret) {
1314 if (do_print)
1315 fprintf(stderr, "ERROR: pthread_join failed "
1316 "for scrub_one_dev[%llu]: %s\n", devid,
1317 strerror(ret));
1318 ++err;
1319 continue;
1321 if (sp[i].ret && sp[i].ioctl_errno == ENODEV) {
1322 if (do_print)
1323 fprintf(stderr, "WARNING: device %lld not "
1324 "present\n", devid);
1325 continue;
1327 if (sp[i].ret && sp[i].ioctl_errno == ECANCELED) {
1328 ++err;
1329 } else if (sp[i].ret) {
1330 if (do_print)
1331 fprintf(stderr, "ERROR: scrubbing %s failed "
1332 "for device id %lld (%s)\n", path,
1333 devid, strerror(sp[i].ioctl_errno));
1334 ++err;
1335 continue;
1337 if (sp[i].scrub_args.progress.uncorrectable_errors > 0)
1338 e_uncorrectable++;
1339 if (sp[i].scrub_args.progress.corrected_errors > 0
1340 || sp[i].scrub_args.progress.unverified_errors > 0)
1341 e_correctable++;
1344 if (do_print) {
1345 const char *append = "done";
1346 if (!do_stats_per_dev)
1347 init_fs_stat(&fs_stat);
1348 for (i = 0; i < fi_args.num_devices; ++i) {
1349 if (do_stats_per_dev) {
1350 print_scrub_dev(&di_args[i],
1351 &sp[i].scrub_args.progress,
1352 print_raw,
1353 sp[i].ret ? "canceled" : "done",
1354 &sp[i].stats);
1355 } else {
1356 if (sp[i].ret)
1357 append = "canceled";
1358 add_to_fs_stat(&sp[i].scrub_args.progress,
1359 &sp[i].stats, &fs_stat);
1362 if (!do_stats_per_dev) {
1363 printf("scrub %s for %s\n", append, fsid);
1364 print_fs_stat(&fs_stat, print_raw);
1368 ret = pthread_cancel(t_prog);
1369 if (!ret)
1370 ret = pthread_join(t_prog, &terr);
1371 if (do_print && ret) {
1372 fprintf(stderr, "ERROR: progress thead handling failed: %s\n",
1373 strerror(ret));
1376 if (do_print && terr && terr != PTHREAD_CANCELED) {
1377 fprintf(stderr, "ERROR: recording progress "
1378 "failed: %s\n", strerror(-PTR_ERR(terr)));
1381 if (do_record) {
1382 ret = scrub_write_progress(&spc_write_mutex, fsid, sp,
1383 fi_args.num_devices);
1384 if (ret && do_print) {
1385 fprintf(stderr, "ERROR: failed to record the result: "
1386 "%s\n", strerror(-ret));
1390 scrub_handle_sigint_child(-1);
1392 out:
1393 free_history(past_scrubs);
1394 free(di_args);
1395 free(t_devs);
1396 free(sp);
1397 free(spc.progress);
1398 if (prg_fd > -1) {
1399 close(prg_fd);
1400 if (sock_path[0])
1401 unlink(sock_path);
1403 close(fdmnt);
1405 if (err)
1406 return 1;
1407 if (e_correctable)
1408 return 7;
1409 if (e_uncorrectable)
1410 return 8;
1411 return 0;
1414 static const char * const cmd_scrub_start_usage[] = {
1415 "btrfs scrub start [-Bdqr] <path>|<device>",
1416 "Start a new scrub",
1418 "-B do not background",
1419 "-d stats per device (-B only)",
1420 "-q be quiet",
1421 "-r read only mode",
1422 NULL
1425 static int cmd_scrub_start(int argc, char **argv)
1427 return scrub_start(argc, argv, 0);
1430 static const char * const cmd_scrub_cancel_usage[] = {
1431 "btrfs scrub cancel <path>|<device>",
1432 "Cancel a running scrub",
1433 NULL
1436 static int cmd_scrub_cancel(int argc, char **argv)
1438 char *path;
1439 int ret;
1440 int fdmnt;
1441 int err;
1442 char mp[BTRFS_PATH_NAME_MAX + 1];
1443 struct btrfs_fs_devices *fs_devices_mnt = NULL;
1445 if (check_argc_exact(argc, 2))
1446 usage(cmd_scrub_cancel_usage);
1448 path = argv[1];
1450 fdmnt = open_file_or_dir(path);
1451 if (fdmnt < 0) {
1452 fprintf(stderr, "ERROR: scrub cancel failed\n");
1453 return 12;
1456 again:
1457 ret = ioctl(fdmnt, BTRFS_IOC_SCRUB_CANCEL, NULL);
1458 err = errno;
1459 close(fdmnt);
1461 if (ret && err == EINVAL) {
1462 /* path is no mounted btrfs. try if it's a device */
1463 ret = check_mounted_where(fdmnt, path, mp, sizeof(mp),
1464 &fs_devices_mnt);
1465 close(fdmnt);
1466 if (ret) {
1467 fdmnt = open_file_or_dir(mp);
1468 if (fdmnt >= 0) {
1469 path = mp;
1470 goto again;
1475 if (ret) {
1476 fprintf(stderr, "ERROR: scrub cancel failed on %s: %s\n", path,
1477 err == ENOTCONN ? "not running" : strerror(errno));
1478 return 1;
1481 printf("scrub cancelled\n");
1483 return 0;
1486 static const char * const cmd_scrub_resume_usage[] = {
1487 "btrfs scrub resume [-Bdqr] <path>|<device>",
1488 "Resume previously canceled or interrupted scrub",
1490 "-B do not background",
1491 "-d stats per device (-B only)",
1492 "-q be quiet",
1493 "-r read only mode",
1494 NULL
1497 static int cmd_scrub_resume(int argc, char **argv)
1499 return scrub_start(argc, argv, 1);
1502 static const char * const cmd_scrub_status_usage[] = {
1503 "btrfs scrub status [-dR] <path>|<device>",
1504 "Show status of running or finished scrub",
1506 "-d stats per device",
1507 "-R print raw stats",
1508 NULL
1511 static int cmd_scrub_status(int argc, char **argv)
1513 char *path;
1514 struct btrfs_ioctl_fs_info_args fi_args;
1515 struct btrfs_ioctl_dev_info_args *di_args = NULL;
1516 struct scrub_file_record **past_scrubs = NULL;
1517 struct scrub_file_record *last_scrub;
1518 struct scrub_fs_stat fs_stat;
1519 struct sockaddr_un addr = {
1520 .sun_family = AF_UNIX,
1522 int ret;
1523 int i;
1524 int fdmnt;
1525 int print_raw = 0;
1526 int do_stats_per_dev = 0;
1527 int c;
1528 char fsid[37];
1529 int fdres = -1;
1530 int err = 0;
1532 optind = 1;
1533 while ((c = getopt(argc, argv, "dR")) != -1) {
1534 switch (c) {
1535 case 'd':
1536 do_stats_per_dev = 1;
1537 break;
1538 case 'R':
1539 print_raw = 1;
1540 break;
1541 case '?':
1542 default:
1543 usage(cmd_scrub_status_usage);
1547 if (check_argc_exact(argc - optind, 1))
1548 usage(cmd_scrub_status_usage);
1550 path = argv[optind];
1552 fdmnt = open_file_or_dir(path);
1553 if (fdmnt < 0) {
1554 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
1555 return 12;
1558 ret = get_fs_info(fdmnt, path, &fi_args, &di_args);
1559 if (ret) {
1560 fprintf(stderr, "ERROR: getting dev info for scrub failed: "
1561 "%s\n", strerror(-ret));
1562 err = 1;
1563 goto out;
1565 if (!fi_args.num_devices) {
1566 fprintf(stderr, "ERROR: no devices found\n");
1567 err = 1;
1568 goto out;
1571 uuid_unparse(fi_args.fsid, fsid);
1573 fdres = socket(AF_UNIX, SOCK_STREAM, 0);
1574 if (fdres == -1) {
1575 fprintf(stderr, "ERROR: failed to create socket to "
1576 "receive progress information: %s\n",
1577 strerror(errno));
1578 err = 1;
1579 goto out;
1581 scrub_datafile(SCRUB_PROGRESS_SOCKET_PATH, fsid,
1582 NULL, addr.sun_path, sizeof(addr.sun_path));
1583 /* ignore EOVERFLOW, just use shorter name and hope for the best */
1584 addr.sun_path[sizeof(addr.sun_path) - 1] = '\0';
1585 ret = connect(fdres, (struct sockaddr *)&addr, sizeof(addr));
1586 if (ret == -1) {
1587 fdres = scrub_open_file_r(SCRUB_DATA_FILE, fsid);
1588 if (fdres < 0 && fdres != -ENOENT) {
1589 fprintf(stderr, "WARNING: failed to open status file: "
1590 "%s\n", strerror(-fdres));
1591 err = 1;
1592 goto out;
1596 if (fdres >= 0) {
1597 past_scrubs = scrub_read_file(fdres, 1);
1598 if (IS_ERR(past_scrubs))
1599 fprintf(stderr, "WARNING: failed to read status: %s\n",
1600 strerror(-PTR_ERR(past_scrubs)));
1603 printf("scrub status for %s\n", fsid);
1605 if (do_stats_per_dev) {
1606 for (i = 0; i < fi_args.num_devices; ++i) {
1607 last_scrub = last_dev_scrub(past_scrubs,
1608 di_args[i].devid);
1609 if (!last_scrub) {
1610 print_scrub_dev(&di_args[i], NULL, print_raw,
1611 NULL, NULL);
1612 continue;
1614 print_scrub_dev(&di_args[i], &last_scrub->p, print_raw,
1615 last_scrub->stats.finished ?
1616 "history" : "status",
1617 &last_scrub->stats);
1619 } else {
1620 init_fs_stat(&fs_stat);
1621 for (i = 0; i < fi_args.num_devices; ++i) {
1622 last_scrub = last_dev_scrub(past_scrubs,
1623 di_args[i].devid);
1624 if (!last_scrub)
1625 continue;
1626 add_to_fs_stat(&last_scrub->p, &last_scrub->stats,
1627 &fs_stat);
1629 print_fs_stat(&fs_stat, print_raw);
1632 out:
1633 free_history(past_scrubs);
1634 free(di_args);
1635 if (fdres > -1)
1636 close(fdres);
1638 return err;
1641 const struct cmd_group scrub_cmd_group = {
1642 scrub_cmd_group_usage, NULL, {
1643 { "start", cmd_scrub_start, cmd_scrub_start_usage, NULL, 0 },
1644 { "cancel", cmd_scrub_cancel, cmd_scrub_cancel_usage, NULL, 0 },
1645 { "resume", cmd_scrub_resume, cmd_scrub_resume_usage, NULL, 0 },
1646 { "status", cmd_scrub_status, cmd_scrub_status_usage, NULL, 0 },
1647 { 0, 0, 0, 0, 0 }
1651 int cmd_scrub(int argc, char **argv)
1653 return handle_command_group(&scrub_cmd_group, argc, argv);