2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public
4 * License v2 as published by the Free Software Foundation.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9 * General Public License for more details.
11 * You should have received a copy of the GNU General Public
12 * License along with this program; if not, write to the
13 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
14 * Boston, MA 021110-1307, USA.
22 #include <sys/ioctl.h>
25 #include "kerncompat.h"
33 static const char * const balance_cmd_group_usage[] = {
34 "btrfs balance <command> [options] <path>",
35 "btrfs balance <path>",
39 static int parse_one_profile(const char *profile, u64 *flags)
41 if (!strcmp(profile, "raid0")) {
42 *flags |= BTRFS_BLOCK_GROUP_RAID0;
43 } else if (!strcmp(profile, "raid1")) {
44 *flags |= BTRFS_BLOCK_GROUP_RAID1;
45 } else if (!strcmp(profile, "raid10")) {
46 *flags |= BTRFS_BLOCK_GROUP_RAID10;
47 } else if (!strcmp(profile, "raid5")) {
48 *flags |= BTRFS_BLOCK_GROUP_RAID5;
49 } else if (!strcmp(profile, "raid6")) {
50 *flags |= BTRFS_BLOCK_GROUP_RAID6;
51 } else if (!strcmp(profile, "dup")) {
52 *flags |= BTRFS_BLOCK_GROUP_DUP;
53 } else if (!strcmp(profile, "single")) {
54 *flags |= BTRFS_AVAIL_ALLOC_BIT_SINGLE;
56 fprintf(stderr, "Unknown profile '%s'\n", profile);
63 static int parse_profiles(char *profiles, u64 *flags)
66 char *save_ptr = NULL; /* Satisfy static checkers */
68 for (this_char = strtok_r(profiles, "|", &save_ptr);
70 this_char = strtok_r(NULL, "|", &save_ptr)) {
71 if (parse_one_profile(this_char, flags))
78 static int parse_u64(const char *str, u64 *result)
83 val = strtoull(str, &endptr, 10);
92 * Parse range that's missing some part that can be implicit:
93 * a..b - exact range, a can be equal to b
94 * a.. - implicitly unbounded maximum (end == (u64)-1)
95 * ..b - implicitly starting at 0
96 * a - invalid; unclear semantics, use parse_u64 instead
98 * Returned values are u64, value validation and interpretation should be done
101 static int parse_range(const char *range, u64 *start, u64 *end)
108 dots = strstr(range, "..");
118 *end = strtoull(rest, &endptr, 10);
126 *end = strtoull(range, &endptr, 10);
127 if (*endptr != 0 && *endptr != '.')
133 "ERROR: range %llu..%llu doesn't make sense\n",
134 (unsigned long long)*start,
135 (unsigned long long)*end);
146 * Parse range and check if start < end
148 static int parse_range_strict(const char *range, u64 *start, u64 *end)
150 if (parse_range(range, start, end) == 0) {
151 if (*start >= *end) {
153 "ERROR: range %llu..%llu not allowed\n",
154 (unsigned long long)*start,
155 (unsigned long long)*end);
165 * Convert 64bit range to 32bit with boundary checkso
167 static int range_to_u32(u64 start, u64 end, u32 *start32, u32 *end32)
172 if (end != (u64)-1 && end > (u32)-1)
175 *start32 = (u32)start;
181 __attribute__ ((unused))
182 static int parse_range_u32(const char *range, u32 *start, u32 *end)
187 if (parse_range(range, &tmp_start, &tmp_end))
190 if (range_to_u32(tmp_start, tmp_end, start, end))
196 __attribute__ ((unused))
197 static void print_range(u64 start, u64 end)
200 printf("%llu", (unsigned long long)start);
203 printf("%llu", (unsigned long long)end);
206 __attribute__ ((unused))
207 static void print_range_u32(u32 start, u32 end)
216 static int parse_filters(char *filters, struct btrfs_balance_args *args)
220 char *save_ptr = NULL; /* Satisfy static checkers */
225 for (this_char = strtok_r(filters, ",", &save_ptr);
227 this_char = strtok_r(NULL, ",", &save_ptr)) {
228 if ((value = strchr(this_char, '=')) != NULL)
230 if (!strcmp(this_char, "profiles")) {
231 if (!value || !*value) {
232 fprintf(stderr, "the profiles filter requires "
236 if (parse_profiles(value, &args->profiles)) {
237 fprintf(stderr, "Invalid profiles argument\n");
240 args->flags |= BTRFS_BALANCE_ARGS_PROFILES;
241 } else if (!strcmp(this_char, "usage")) {
242 if (!value || !*value) {
243 fprintf(stderr, "the usage filter requires "
247 if (parse_u64(value, &args->usage) ||
249 fprintf(stderr, "Invalid usage argument: %s\n",
253 args->flags |= BTRFS_BALANCE_ARGS_USAGE;
254 } else if (!strcmp(this_char, "devid")) {
255 if (!value || !*value) {
256 fprintf(stderr, "the devid filter requires "
260 if (parse_u64(value, &args->devid) ||
262 fprintf(stderr, "Invalid devid argument: %s\n",
266 args->flags |= BTRFS_BALANCE_ARGS_DEVID;
267 } else if (!strcmp(this_char, "drange")) {
268 if (!value || !*value) {
269 fprintf(stderr, "the drange filter requires "
273 if (parse_range_strict(value, &args->pstart, &args->pend)) {
274 fprintf(stderr, "Invalid drange argument\n");
277 args->flags |= BTRFS_BALANCE_ARGS_DRANGE;
278 } else if (!strcmp(this_char, "vrange")) {
279 if (!value || !*value) {
280 fprintf(stderr, "the vrange filter requires "
284 if (parse_range_strict(value, &args->vstart, &args->vend)) {
285 fprintf(stderr, "Invalid vrange argument\n");
288 args->flags |= BTRFS_BALANCE_ARGS_VRANGE;
289 } else if (!strcmp(this_char, "convert")) {
290 if (!value || !*value) {
291 fprintf(stderr, "the convert option requires "
295 if (parse_one_profile(value, &args->target)) {
296 fprintf(stderr, "Invalid convert argument\n");
299 args->flags |= BTRFS_BALANCE_ARGS_CONVERT;
300 } else if (!strcmp(this_char, "soft")) {
301 args->flags |= BTRFS_BALANCE_ARGS_SOFT;
302 } else if (!strcmp(this_char, "limit")) {
303 if (!value || !*value) {
305 "the limit filter requires an argument\n");
308 if (parse_u64(value, &args->limit)) {
309 if (parse_range_u32(value, &args->limit_min,
312 "Invalid limit argument: %s\n",
316 args->flags &= ~BTRFS_BALANCE_ARGS_LIMIT;
317 args->flags |= BTRFS_BALANCE_ARGS_LIMIT_RANGE;
319 args->flags &= ~BTRFS_BALANCE_ARGS_LIMIT_RANGE;
320 args->flags |= BTRFS_BALANCE_ARGS_LIMIT;
323 fprintf(stderr, "Unrecognized balance option '%s'\n",
332 static void dump_balance_args(struct btrfs_balance_args *args)
334 if (args->flags & BTRFS_BALANCE_ARGS_CONVERT) {
335 printf("converting, target=%llu, soft is %s",
336 (unsigned long long)args->target,
337 (args->flags & BTRFS_BALANCE_ARGS_SOFT) ? "on" : "off");
342 if (args->flags & BTRFS_BALANCE_ARGS_PROFILES)
343 printf(", profiles=%llu", (unsigned long long)args->profiles);
344 if (args->flags & BTRFS_BALANCE_ARGS_USAGE)
345 printf(", usage=%llu", (unsigned long long)args->usage);
346 if (args->flags & BTRFS_BALANCE_ARGS_DEVID)
347 printf(", devid=%llu", (unsigned long long)args->devid);
348 if (args->flags & BTRFS_BALANCE_ARGS_DRANGE)
349 printf(", drange=%llu..%llu",
350 (unsigned long long)args->pstart,
351 (unsigned long long)args->pend);
352 if (args->flags & BTRFS_BALANCE_ARGS_VRANGE)
353 printf(", vrange=%llu..%llu",
354 (unsigned long long)args->vstart,
355 (unsigned long long)args->vend);
356 if (args->flags & BTRFS_BALANCE_ARGS_LIMIT)
357 printf(", limit=%llu", (unsigned long long)args->limit);
358 if (args->flags & BTRFS_BALANCE_ARGS_LIMIT_RANGE) {
360 print_range_u32(args->limit_min, args->limit_max);
366 static void dump_ioctl_balance_args(struct btrfs_ioctl_balance_args *args)
368 printf("Dumping filters: flags 0x%llx, state 0x%llx, force is %s\n",
369 (unsigned long long)args->flags, (unsigned long long)args->state,
370 (args->flags & BTRFS_BALANCE_FORCE) ? "on" : "off");
371 if (args->flags & BTRFS_BALANCE_DATA) {
372 printf(" DATA (flags 0x%llx): ",
373 (unsigned long long)args->data.flags);
374 dump_balance_args(&args->data);
376 if (args->flags & BTRFS_BALANCE_METADATA) {
377 printf(" METADATA (flags 0x%llx): ",
378 (unsigned long long)args->meta.flags);
379 dump_balance_args(&args->meta);
381 if (args->flags & BTRFS_BALANCE_SYSTEM) {
382 printf(" SYSTEM (flags 0x%llx): ",
383 (unsigned long long)args->sys.flags);
384 dump_balance_args(&args->sys);
388 static int do_balance_v1(int fd)
390 struct btrfs_ioctl_vol_args args;
393 memset(&args, 0, sizeof(args));
394 ret = ioctl(fd, BTRFS_IOC_BALANCE, &args);
398 static int do_balance(const char *path, struct btrfs_ioctl_balance_args *args,
404 DIR *dirstream = NULL;
406 fd = btrfs_open_dir(path, &dirstream, 1);
410 ret = ioctl(fd, BTRFS_IOC_BALANCE_V2, args);
415 * older kernels don't have the new balance ioctl, try the
416 * old one. But, the old one doesn't know any filters, so
417 * don't fall back if they tried to use the fancy new things
419 if (e == ENOTTY && nofilters) {
420 ret = do_balance_v1(fd);
426 if (e == ECANCELED) {
427 if (args->state & BTRFS_BALANCE_STATE_PAUSE_REQ)
428 fprintf(stderr, "balance paused by user\n");
429 if (args->state & BTRFS_BALANCE_STATE_CANCEL_REQ)
430 fprintf(stderr, "balance canceled by user\n");
433 fprintf(stderr, "ERROR: error during balancing '%s' "
434 "- %s\n", path, strerror(e));
435 if (e != EINPROGRESS)
436 fprintf(stderr, "There may be more info in "
437 "syslog - try dmesg | tail\n");
441 printf("Done, had to relocate %llu out of %llu chunks\n",
442 (unsigned long long)args->stat.completed,
443 (unsigned long long)args->stat.considered);
448 close_file_or_dir(fd, dirstream);
452 static const char * const cmd_balance_start_usage[] = {
453 "btrfs balance start [options] <path>",
454 "Balance chunks across the devices",
455 "Balance and/or convert (change allocation profile of) chunks that",
456 "passed all filters in a comma-separated list of filters for a",
457 "particular chunk type. If filter list is not given balance all",
458 "chunks of that type. In case none of the -d, -m or -s options is",
459 "given balance all chunks in a filesystem.",
461 "-d[filters] act on data chunks",
462 "-m[filters] act on metadata chunks",
463 "-s[filters] act on system chunks (only under -f)",
465 "-f force reducing of metadata integrity",
469 static int cmd_balance_start(int argc, char **argv)
471 struct btrfs_ioctl_balance_args args;
472 struct btrfs_balance_args *ptrs[] = { &args.data, &args.sys,
479 memset(&args, 0, sizeof(args));
483 static const struct option longopts[] = {
484 { "data", optional_argument, NULL, 'd'},
485 { "metadata", optional_argument, NULL, 'm' },
486 { "system", optional_argument, NULL, 's' },
487 { "force", no_argument, NULL, 'f' },
488 { "verbose", no_argument, NULL, 'v' },
492 int opt = getopt_long(argc, argv, "d::s::m::fv", longopts, NULL);
499 args.flags |= BTRFS_BALANCE_DATA;
501 if (parse_filters(optarg, &args.data))
506 args.flags |= BTRFS_BALANCE_SYSTEM;
508 if (parse_filters(optarg, &args.sys))
513 args.flags |= BTRFS_BALANCE_METADATA;
515 if (parse_filters(optarg, &args.meta))
525 usage(cmd_balance_start_usage);
529 if (check_argc_exact(argc - optind, 1))
530 usage(cmd_balance_start_usage);
533 * allow -s only under --force, otherwise do with system chunks
534 * the same thing we were ordered to do with meta chunks
536 if (args.flags & BTRFS_BALANCE_SYSTEM) {
539 "Refusing to explicitly operate on system chunks.\n"
540 "Pass --force if you really want to do that.\n");
543 } else if (args.flags & BTRFS_BALANCE_METADATA) {
544 args.flags |= BTRFS_BALANCE_SYSTEM;
545 memcpy(&args.sys, &args.meta,
546 sizeof(struct btrfs_balance_args));
550 /* relocate everything - no filters */
551 args.flags |= BTRFS_BALANCE_TYPE_MASK;
554 /* drange makes sense only when devid is set */
555 for (i = 0; ptrs[i]; i++) {
556 if ((ptrs[i]->flags & BTRFS_BALANCE_ARGS_DRANGE) &&
557 !(ptrs[i]->flags & BTRFS_BALANCE_ARGS_DEVID)) {
558 fprintf(stderr, "drange filter can be used only if "
559 "devid filter is used\n");
564 /* soft makes sense only when convert for corresponding type is set */
565 for (i = 0; ptrs[i]; i++) {
566 if ((ptrs[i]->flags & BTRFS_BALANCE_ARGS_SOFT) &&
567 !(ptrs[i]->flags & BTRFS_BALANCE_ARGS_CONVERT)) {
568 fprintf(stderr, "'soft' option can be used only if "
569 "changing profiles\n");
575 args.flags |= BTRFS_BALANCE_FORCE;
577 dump_ioctl_balance_args(&args);
579 return do_balance(argv[optind], &args, nofilters);
582 static const char * const cmd_balance_pause_usage[] = {
583 "btrfs balance pause <path>",
584 "Pause running balance",
588 static int cmd_balance_pause(int argc, char **argv)
594 DIR *dirstream = NULL;
596 if (check_argc_exact(argc, 2))
597 usage(cmd_balance_pause_usage);
601 fd = btrfs_open_dir(path, &dirstream, 1);
605 ret = ioctl(fd, BTRFS_IOC_BALANCE_CTL, BTRFS_BALANCE_CTL_PAUSE);
607 close_file_or_dir(fd, dirstream);
610 fprintf(stderr, "ERROR: balance pause on '%s' failed - %s\n",
611 path, (e == ENOTCONN) ? "Not running" : strerror(e));
621 static const char * const cmd_balance_cancel_usage[] = {
622 "btrfs balance cancel <path>",
623 "Cancel running or paused balance",
627 static int cmd_balance_cancel(int argc, char **argv)
633 DIR *dirstream = NULL;
635 if (check_argc_exact(argc, 2))
636 usage(cmd_balance_cancel_usage);
640 fd = btrfs_open_dir(path, &dirstream, 1);
644 ret = ioctl(fd, BTRFS_IOC_BALANCE_CTL, BTRFS_BALANCE_CTL_CANCEL);
646 close_file_or_dir(fd, dirstream);
649 fprintf(stderr, "ERROR: balance cancel on '%s' failed - %s\n",
650 path, (e == ENOTCONN) ? "Not in progress" : strerror(e));
660 static const char * const cmd_balance_resume_usage[] = {
661 "btrfs balance resume <path>",
662 "Resume interrupted balance",
666 static int cmd_balance_resume(int argc, char **argv)
668 struct btrfs_ioctl_balance_args args;
670 DIR *dirstream = NULL;
675 if (check_argc_exact(argc, 2))
676 usage(cmd_balance_resume_usage);
680 fd = btrfs_open_dir(path, &dirstream, 1);
684 memset(&args, 0, sizeof(args));
685 args.flags |= BTRFS_BALANCE_RESUME;
687 ret = ioctl(fd, BTRFS_IOC_BALANCE_V2, &args);
689 close_file_or_dir(fd, dirstream);
692 if (e == ECANCELED) {
693 if (args.state & BTRFS_BALANCE_STATE_PAUSE_REQ)
694 fprintf(stderr, "balance paused by user\n");
695 if (args.state & BTRFS_BALANCE_STATE_CANCEL_REQ)
696 fprintf(stderr, "balance canceled by user\n");
697 } else if (e == ENOTCONN || e == EINPROGRESS) {
698 fprintf(stderr, "ERROR: balance resume on '%s' "
699 "failed - %s\n", path,
700 (e == ENOTCONN) ? "Not in progress" :
708 "ERROR: error during balancing '%s' - %s\n"
709 "There may be more info in syslog - try dmesg | tail\n", path, strerror(e));
713 printf("Done, had to relocate %llu out of %llu chunks\n",
714 (unsigned long long)args.stat.completed,
715 (unsigned long long)args.stat.considered);
721 static const char * const cmd_balance_status_usage[] = {
722 "btrfs balance status [-v] <path>",
723 "Show status of running or paused balance",
729 /* Checks the status of the balance if any
731 * 2 : Error failed to know if there is any pending balance
732 * 1 : Successful to know status of a pending balance
733 * 0 : When there is no pending balance or completed
735 static int cmd_balance_status(int argc, char **argv)
737 struct btrfs_ioctl_balance_args args;
739 DIR *dirstream = NULL;
748 static const struct option longopts[] = {
749 { "verbose", no_argument, NULL, 'v' },
753 opt = getopt_long(argc, argv, "v", longopts, NULL);
762 usage(cmd_balance_status_usage);
766 if (check_argc_exact(argc - optind, 1))
767 usage(cmd_balance_status_usage);
771 fd = btrfs_open_dir(path, &dirstream, 1);
775 ret = ioctl(fd, BTRFS_IOC_BALANCE_PROGRESS, &args);
777 close_file_or_dir(fd, dirstream);
781 printf("No balance found on '%s'\n", path);
784 fprintf(stderr, "ERROR: balance status on '%s' failed - %s\n",
789 if (args.state & BTRFS_BALANCE_STATE_RUNNING) {
790 printf("Balance on '%s' is running", path);
791 if (args.state & BTRFS_BALANCE_STATE_CANCEL_REQ)
792 printf(", cancel requested\n");
793 else if (args.state & BTRFS_BALANCE_STATE_PAUSE_REQ)
794 printf(", pause requested\n");
798 printf("Balance on '%s' is paused\n", path);
801 printf("%llu out of about %llu chunks balanced (%llu considered), "
802 "%3.f%% left\n", (unsigned long long)args.stat.completed,
803 (unsigned long long)args.stat.expected,
804 (unsigned long long)args.stat.considered,
805 100 * (1 - (float)args.stat.completed/args.stat.expected));
808 dump_ioctl_balance_args(&args);
813 static const char balance_cmd_group_info[] =
814 "balance data accross devices, or change block groups using filters";
816 const struct cmd_group balance_cmd_group = {
817 balance_cmd_group_usage, balance_cmd_group_info, {
818 { "start", cmd_balance_start, cmd_balance_start_usage, NULL, 0 },
819 { "pause", cmd_balance_pause, cmd_balance_pause_usage, NULL, 0 },
820 { "cancel", cmd_balance_cancel, cmd_balance_cancel_usage, NULL, 0 },
821 { "resume", cmd_balance_resume, cmd_balance_resume_usage, NULL, 0 },
822 { "status", cmd_balance_status, cmd_balance_status_usage, NULL, 0 },
827 int cmd_balance(int argc, char **argv)
830 /* old 'btrfs filesystem balance <path>' syntax */
831 struct btrfs_ioctl_balance_args args;
833 memset(&args, 0, sizeof(args));
834 args.flags |= BTRFS_BALANCE_TYPE_MASK;
836 return do_balance(argv[1], &args, 1);
839 return handle_command_group(&balance_cmd_group, argc, argv);