Merge branch 'for-chris' of git://github.com/idryomov/btrfs-progs
[platform/upstream/btrfs-progs.git] / cmds-balance.c
1 /*
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.
5  *
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.
10  *
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.
15  */
16
17 #include <stdio.h>
18 #include <stdlib.h>
19 #include <string.h>
20 #include <unistd.h>
21 #include <getopt.h>
22 #include <sys/ioctl.h>
23 #include <errno.h>
24
25 #include "kerncompat.h"
26 #include "ctree.h"
27 #include "ioctl.h"
28 #include "volumes.h"
29
30 #include "commands.h"
31
32 static const char * const balance_cmd_group_usage[] = {
33         "btrfs [filesystem] balance <command> [options] <path>",
34         "btrfs [filesystem] balance <path>",
35         NULL
36 };
37
38 static const char balance_cmd_group_info[] =
39         "'btrfs filesystem balance' command is deprecated, please use\n"
40         "'btrfs balance start' command instead.";
41
42 static int parse_one_profile(const char *profile, u64 *flags)
43 {
44         if (!strcmp(profile, "raid0")) {
45                 *flags |= BTRFS_BLOCK_GROUP_RAID0;
46         } else if (!strcmp(profile, "raid1")) {
47                 *flags |= BTRFS_BLOCK_GROUP_RAID1;
48         } else if (!strcmp(profile, "raid10")) {
49                 *flags |= BTRFS_BLOCK_GROUP_RAID10;
50         } else if (!strcmp(profile, "dup")) {
51                 *flags |= BTRFS_BLOCK_GROUP_DUP;
52         } else if (!strcmp(profile, "single")) {
53                 *flags |= BTRFS_AVAIL_ALLOC_BIT_SINGLE;
54         } else {
55                 fprintf(stderr, "Unknown profile '%s'\n", profile);
56                 return 1;
57         }
58
59         return 0;
60 }
61
62 static int parse_profiles(char *profiles, u64 *flags)
63 {
64         char *this_char;
65         char *save_ptr;
66
67         for (this_char = strtok_r(profiles, "|", &save_ptr);
68              this_char != NULL;
69              this_char = strtok_r(NULL, "|", &save_ptr)) {
70                 if (parse_one_profile(this_char, flags))
71                         return 1;
72         }
73
74         return 0;
75 }
76
77 static int parse_u64(const char *str, u64 *result)
78 {
79         char *endptr;
80         u64 val;
81
82         val = strtoull(str, &endptr, 10);
83         if (*endptr)
84                 return 1;
85
86         *result = val;
87         return 0;
88 }
89
90 static int parse_range(const char *range, u64 *start, u64 *end)
91 {
92         char *dots;
93
94         dots = strstr(range, "..");
95         if (dots) {
96                 const char *rest = dots + 2;
97                 int skipped = 0;
98
99                 *dots = 0;
100
101                 if (!*rest) {
102                         *end = (u64)-1;
103                         skipped++;
104                 } else {
105                         if (parse_u64(rest, end))
106                                 return 1;
107                 }
108                 if (dots == range) {
109                         *start = 0;
110                         skipped++;
111                 } else {
112                         if (parse_u64(range, start))
113                                 return 1;
114                 }
115
116                 if (*start >= *end) {
117                         fprintf(stderr, "Range %llu..%llu doesn't make "
118                                 "sense\n", (unsigned long long)*start,
119                                 (unsigned long long)*end);
120                         return 1;
121                 }
122
123                 if (skipped <= 1)
124                         return 0;
125         }
126
127         return 1;
128 }
129
130 static int parse_filters(char *filters, struct btrfs_balance_args *args)
131 {
132         char *this_char;
133         char *value;
134         char *save_ptr;
135
136         if (!filters)
137                 return 0;
138
139         for (this_char = strtok_r(filters, ",", &save_ptr);
140              this_char != NULL;
141              this_char = strtok_r(NULL, ",", &save_ptr)) {
142                 if ((value = strchr(this_char, '=')) != NULL)
143                         *value++ = 0;
144                 if (!strcmp(this_char, "profiles")) {
145                         if (!value || !*value) {
146                                 fprintf(stderr, "the profiles filter requires "
147                                        "an argument\n");
148                                 return 1;
149                         }
150                         if (parse_profiles(value, &args->profiles)) {
151                                 fprintf(stderr, "Invalid profiles argument\n");
152                                 return 1;
153                         }
154                         args->flags |= BTRFS_BALANCE_ARGS_PROFILES;
155                 } else if (!strcmp(this_char, "usage")) {
156                         if (!value || !*value) {
157                                 fprintf(stderr, "the usage filter requires "
158                                        "an argument\n");
159                                 return 1;
160                         }
161                         if (parse_u64(value, &args->usage) ||
162                             args->usage < 1 || args->usage > 100) {
163                                 fprintf(stderr, "Invalid usage argument: %s\n",
164                                        value);
165                                 return 1;
166                         }
167                         args->flags |= BTRFS_BALANCE_ARGS_USAGE;
168                 } else if (!strcmp(this_char, "devid")) {
169                         if (!value || !*value) {
170                                 fprintf(stderr, "the devid filter requires "
171                                        "an argument\n");
172                                 return 1;
173                         }
174                         if (parse_u64(value, &args->devid) ||
175                             args->devid == 0) {
176                                 fprintf(stderr, "Invalid devid argument: %s\n",
177                                        value);
178                                 return 1;
179                         }
180                         args->flags |= BTRFS_BALANCE_ARGS_DEVID;
181                 } else if (!strcmp(this_char, "drange")) {
182                         if (!value || !*value) {
183                                 fprintf(stderr, "the drange filter requires "
184                                        "an argument\n");
185                                 return 1;
186                         }
187                         if (parse_range(value, &args->pstart, &args->pend)) {
188                                 fprintf(stderr, "Invalid drange argument\n");
189                                 return 1;
190                         }
191                         args->flags |= BTRFS_BALANCE_ARGS_DRANGE;
192                 } else if (!strcmp(this_char, "vrange")) {
193                         if (!value || !*value) {
194                                 fprintf(stderr, "the vrange filter requires "
195                                        "an argument\n");
196                                 return 1;
197                         }
198                         if (parse_range(value, &args->vstart, &args->vend)) {
199                                 fprintf(stderr, "Invalid vrange argument\n");
200                                 return 1;
201                         }
202                         args->flags |= BTRFS_BALANCE_ARGS_VRANGE;
203                 } else if (!strcmp(this_char, "convert")) {
204                         if (!value || !*value) {
205                                 fprintf(stderr, "the convert option requires "
206                                        "an argument\n");
207                                 return 1;
208                         }
209                         if (parse_one_profile(value, &args->target)) {
210                                 fprintf(stderr, "Invalid convert argument\n");
211                                 return 1;
212                         }
213                         args->flags |= BTRFS_BALANCE_ARGS_CONVERT;
214                 } else if (!strcmp(this_char, "soft")) {
215                         args->flags |= BTRFS_BALANCE_ARGS_SOFT;
216                 } else {
217                         fprintf(stderr, "Unrecognized balance option '%s'\n",
218                                 this_char);
219                         return 1;
220                 }
221         }
222
223         return 0;
224 }
225
226 static void dump_balance_args(struct btrfs_balance_args *args)
227 {
228         if (args->flags & BTRFS_BALANCE_ARGS_CONVERT) {
229                 printf("converting, target=%llu, soft is %s",
230                        (unsigned long long)args->target,
231                        (args->flags & BTRFS_BALANCE_ARGS_SOFT) ? "on" : "off");
232         } else {
233                 printf("balancing");
234         }
235
236         if (args->flags & BTRFS_BALANCE_ARGS_PROFILES)
237                 printf(", profiles=%llu", (unsigned long long)args->profiles);
238         if (args->flags & BTRFS_BALANCE_ARGS_USAGE)
239                 printf(", usage=%llu", (unsigned long long)args->usage);
240         if (args->flags & BTRFS_BALANCE_ARGS_DEVID)
241                 printf(", devid=%llu", (unsigned long long)args->devid);
242         if (args->flags & BTRFS_BALANCE_ARGS_DRANGE)
243                 printf(", drange=%llu..%llu",
244                        (unsigned long long)args->pstart,
245                        (unsigned long long)args->pend);
246         if (args->flags & BTRFS_BALANCE_ARGS_VRANGE)
247                 printf(", vrange=%llu..%llu",
248                        (unsigned long long)args->vstart,
249                        (unsigned long long)args->vend);
250
251         printf("\n");
252 }
253
254 static void dump_ioctl_balance_args(struct btrfs_ioctl_balance_args *args)
255 {
256         printf("Dumping filters: flags 0x%llx, state 0x%llx, force is %s\n",
257                (unsigned long long)args->flags, (unsigned long long)args->state,
258                (args->flags & BTRFS_BALANCE_FORCE) ? "on" : "off");
259         if (args->flags & BTRFS_BALANCE_DATA) {
260                 printf("  DATA (flags 0x%llx): ",
261                        (unsigned long long)args->data.flags);
262                 dump_balance_args(&args->data);
263         }
264         if (args->flags & BTRFS_BALANCE_METADATA) {
265                 printf("  METADATA (flags 0x%llx): ",
266                        (unsigned long long)args->meta.flags);
267                 dump_balance_args(&args->meta);
268         }
269         if (args->flags & BTRFS_BALANCE_SYSTEM) {
270                 printf("  SYSTEM (flags 0x%llx): ",
271                        (unsigned long long)args->sys.flags);
272                 dump_balance_args(&args->sys);
273         }
274 }
275
276 static int do_balance_v1(int fd)
277 {
278         struct btrfs_ioctl_vol_args args;
279         int ret;
280
281         memset(&args, 0, sizeof(args));
282         ret = ioctl(fd, BTRFS_IOC_BALANCE, &args);
283         return ret;
284 }
285
286 static int do_balance(const char *path, struct btrfs_ioctl_balance_args *args,
287                       int nofilters)
288 {
289         int fd;
290         int ret;
291         int e;
292
293         fd = open_file_or_dir(path);
294         if (fd < 0) {
295                 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
296                 return 12;
297         }
298
299         ret = ioctl(fd, BTRFS_IOC_BALANCE_V2, args);
300         e = errno;
301
302         if (ret < 0) {
303                 /*
304                  * older kernels don't have the new balance ioctl, try the
305                  * old one.  But, the old one doesn't know any filters, so
306                  * don't fall back if they tried to use the fancy new things
307                  */
308                 if (e == ENOTTY && nofilters) {
309                         ret = do_balance_v1(fd);
310                         if (ret == 0)
311                                 goto out;
312                         e = errno;
313                 }
314
315                 if (e == ECANCELED) {
316                         if (args->state & BTRFS_BALANCE_STATE_PAUSE_REQ)
317                                 fprintf(stderr, "balance paused by user\n");
318                         if (args->state & BTRFS_BALANCE_STATE_CANCEL_REQ)
319                                 fprintf(stderr, "balance canceled by user\n");
320                         ret = 0;
321                 } else {
322                         fprintf(stderr, "ERROR: error during balancing '%s' "
323                                 "- %s\n", path, strerror(e));
324                         if (e != EINPROGRESS)
325                                 fprintf(stderr, "There may be more info in "
326                                         "syslog - try dmesg | tail\n");
327                         ret = 19;
328                 }
329         } else {
330                 printf("Done, had to relocate %llu out of %llu chunks\n",
331                        (unsigned long long)args->stat.completed,
332                        (unsigned long long)args->stat.considered);
333                 ret = 0;
334         }
335
336 out:
337         close(fd);
338         return ret;
339 }
340
341 static const char * const cmd_balance_start_usage[] = {
342         "btrfs [filesystem] balance start [options] <path>",
343         "Balance chunks across the devices",
344         "Balance and/or convert (change allocation profile of) chunks that",
345         "passed all filters in a comma-separated list of filters for a",
346         "particular chunk type.  If filter list is not given balance all",
347         "chunks of that type.  In case none of the -d, -m or -s options is",
348         "given balance all chunks in a filesystem.",
349         "",
350         "-d[filters]    act on data chunks",
351         "-m[filters]    act on metadata chunks",
352         "-s[filetrs]    act on system chunks (only under -f)",
353         "-v             be verbose",
354         "-f             force reducing of metadata integrity",
355         NULL
356 };
357
358 static int cmd_balance_start(int argc, char **argv)
359 {
360         struct btrfs_ioctl_balance_args args;
361         struct btrfs_balance_args *ptrs[] = { &args.data, &args.sys,
362                                                 &args.meta, NULL };
363         int force = 0;
364         int verbose = 0;
365         int nofilters = 1;
366         int i;
367
368         memset(&args, 0, sizeof(args));
369
370         optind = 1;
371         while (1) {
372                 int longindex;
373                 static struct option longopts[] = {
374                         { "data", optional_argument, NULL, 'd'},
375                         { "metadata", optional_argument, NULL, 'm' },
376                         { "system", optional_argument, NULL, 's' },
377                         { "force", no_argument, NULL, 'f' },
378                         { "verbose", no_argument, NULL, 'v' },
379                         { 0, 0, 0, 0 }
380                 };
381
382                 int opt = getopt_long(argc, argv, "d::s::m::fv", longopts,
383                                       &longindex);
384                 if (opt < 0)
385                         break;
386
387                 switch (opt) {
388                 case 'd':
389                         nofilters = 0;
390                         args.flags |= BTRFS_BALANCE_DATA;
391
392                         if (parse_filters(optarg, &args.data))
393                                 return 1;
394                         break;
395                 case 's':
396                         nofilters = 0;
397                         args.flags |= BTRFS_BALANCE_SYSTEM;
398
399                         if (parse_filters(optarg, &args.sys))
400                                 return 1;
401                         break;
402                 case 'm':
403                         nofilters = 0;
404                         args.flags |= BTRFS_BALANCE_METADATA;
405
406                         if (parse_filters(optarg, &args.meta))
407                                 return 1;
408                         break;
409                 case 'f':
410                         force = 1;
411                         break;
412                 case 'v':
413                         verbose = 1;
414                         break;
415                 default:
416                         usage(cmd_balance_start_usage);
417                 }
418         }
419
420         if (check_argc_exact(argc - optind, 1))
421                 usage(cmd_balance_start_usage);
422
423         /*
424          * allow -s only under --force, otherwise do with system chunks
425          * the same thing we were ordered to do with meta chunks
426          */
427         if (args.flags & BTRFS_BALANCE_SYSTEM) {
428                 if (!force) {
429                         fprintf(stderr,
430 "Refusing to explicitly operate on system chunks.\n"
431 "Pass --force if you really want to do that.\n");
432                         return 1;
433                 }
434         } else if (args.flags & BTRFS_BALANCE_METADATA) {
435                 args.flags |= BTRFS_BALANCE_SYSTEM;
436                 memcpy(&args.sys, &args.meta,
437                         sizeof(struct btrfs_balance_args));
438         }
439
440         if (nofilters) {
441                 /* relocate everything - no filters */
442                 args.flags |= BTRFS_BALANCE_TYPE_MASK;
443         }
444
445         /* drange makes sense only when devid is set */
446         for (i = 0; ptrs[i]; i++) {
447                 if ((ptrs[i]->flags & BTRFS_BALANCE_ARGS_DRANGE) &&
448                     !(ptrs[i]->flags & BTRFS_BALANCE_ARGS_DEVID)) {
449                         fprintf(stderr, "drange filter can be used only if "
450                                 "devid filter is used\n");
451                         return 1;
452                 }
453         }
454
455         /* soft makes sense only when convert for corresponding type is set */
456         for (i = 0; ptrs[i]; i++) {
457                 if ((ptrs[i]->flags & BTRFS_BALANCE_ARGS_SOFT) &&
458                     !(ptrs[i]->flags & BTRFS_BALANCE_ARGS_CONVERT)) {
459                         fprintf(stderr, "'soft' option can be used only if "
460                                 "changing profiles\n");
461                         return 1;
462                 }
463         }
464
465         if (force)
466                 args.flags |= BTRFS_BALANCE_FORCE;
467         if (verbose)
468                 dump_ioctl_balance_args(&args);
469
470         return do_balance(argv[optind], &args, nofilters);
471 }
472
473 static const char * const cmd_balance_pause_usage[] = {
474         "btrfs [filesystem] balance pause <path>",
475         "Pause running balance",
476         NULL
477 };
478
479 static int cmd_balance_pause(int argc, char **argv)
480 {
481         const char *path;
482         int fd;
483         int ret;
484         int e;
485
486         if (check_argc_exact(argc, 2))
487                 usage(cmd_balance_pause_usage);
488
489         path = argv[1];
490
491         fd = open_file_or_dir(path);
492         if (fd < 0) {
493                 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
494                 return 12;
495         }
496
497         ret = ioctl(fd, BTRFS_IOC_BALANCE_CTL, BTRFS_BALANCE_CTL_PAUSE);
498         e = errno;
499         close(fd);
500
501         if (ret < 0) {
502                 fprintf(stderr, "ERROR: balance pause on '%s' failed - %s\n",
503                         path, (e == ENOTCONN) ? "Not running" : strerror(e));
504                 return 19;
505         }
506
507         return 0;
508 }
509
510 static const char * const cmd_balance_cancel_usage[] = {
511         "btrfs [filesystem] balance cancel <path>",
512         "Cancel running or paused balance",
513         NULL
514 };
515
516 static int cmd_balance_cancel(int argc, char **argv)
517 {
518         const char *path;
519         int fd;
520         int ret;
521         int e;
522
523         if (check_argc_exact(argc, 2))
524                 usage(cmd_balance_cancel_usage);
525
526         path = argv[1];
527
528         fd = open_file_or_dir(path);
529         if (fd < 0) {
530                 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
531                 return 12;
532         }
533
534         ret = ioctl(fd, BTRFS_IOC_BALANCE_CTL, BTRFS_BALANCE_CTL_CANCEL);
535         e = errno;
536         close(fd);
537
538         if (ret < 0) {
539                 fprintf(stderr, "ERROR: balance cancel on '%s' failed - %s\n",
540                         path, (e == ENOTCONN) ? "Not in progress" : strerror(e));
541                 return 19;
542         }
543
544         return 0;
545 }
546
547 static const char * const cmd_balance_resume_usage[] = {
548         "btrfs [filesystem] balance resume <path>",
549         "Resume interrupted balance",
550         NULL
551 };
552
553 static int cmd_balance_resume(int argc, char **argv)
554 {
555         struct btrfs_ioctl_balance_args args;
556         const char *path;
557         int fd;
558         int ret;
559         int e;
560
561         if (check_argc_exact(argc, 2))
562                 usage(cmd_balance_resume_usage);
563
564         path = argv[1];
565
566         fd = open_file_or_dir(path);
567         if (fd < 0) {
568                 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
569                 return 12;
570         }
571
572         memset(&args, 0, sizeof(args));
573         args.flags |= BTRFS_BALANCE_RESUME;
574
575         ret = ioctl(fd, BTRFS_IOC_BALANCE_V2, &args);
576         e = errno;
577         close(fd);
578
579         if (ret < 0) {
580                 if (e == ECANCELED) {
581                         if (args.state & BTRFS_BALANCE_STATE_PAUSE_REQ)
582                                 fprintf(stderr, "balance paused by user\n");
583                         if (args.state & BTRFS_BALANCE_STATE_CANCEL_REQ)
584                                 fprintf(stderr, "balance canceled by user\n");
585                 } else if (e == ENOTCONN || e == EINPROGRESS) {
586                         fprintf(stderr, "ERROR: balance resume on '%s' "
587                                 "failed - %s\n", path,
588                                 (e == ENOTCONN) ? "Not in progress" :
589                                                   "Already running");
590                         return 19;
591                 } else {
592                         fprintf(stderr,
593 "ERROR: error during balancing '%s' - %s\n"
594 "There may be more info in syslog - try dmesg | tail\n", path, strerror(e));
595                         return 19;
596                 }
597         } else {
598                 printf("Done, had to relocate %llu out of %llu chunks\n",
599                        (unsigned long long)args.stat.completed,
600                        (unsigned long long)args.stat.considered);
601         }
602
603         return 0;
604 }
605
606 static const char * const cmd_balance_status_usage[] = {
607         "btrfs [filesystem] balance status [-v] <path>",
608         "Show status of running or paused balance",
609         "",
610         "-v     be verbose",
611         NULL
612 };
613
614 static int cmd_balance_status(int argc, char **argv)
615 {
616         struct btrfs_ioctl_balance_args args;
617         const char *path;
618         int fd;
619         int verbose = 0;
620         int ret;
621         int e;
622
623         optind = 1;
624         while (1) {
625                 int longindex;
626                 static struct option longopts[] = {
627                         { "verbose", no_argument, NULL, 'v' },
628                         { 0, 0, 0, 0}
629                 };
630
631                 int opt = getopt_long(argc, argv, "v", longopts, &longindex);
632                 if (opt < 0)
633                         break;
634
635                 switch (opt) {
636                 case 'v':
637                         verbose = 1;
638                         break;
639                 default:
640                         usage(cmd_balance_status_usage);
641                 }
642         }
643
644         if (check_argc_exact(argc - optind, 1))
645                 usage(cmd_balance_status_usage);
646
647         path = argv[optind];
648
649         fd = open_file_or_dir(path);
650         if (fd < 0) {
651                 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
652                 return 12;
653         }
654
655         ret = ioctl(fd, BTRFS_IOC_BALANCE_PROGRESS, &args);
656         e = errno;
657         close(fd);
658
659         if (ret < 0) {
660                 fprintf(stderr, "ERROR: balance status on '%s' failed - %s\n",
661                         path, (e == ENOTCONN) ? "Not in progress" : strerror(e));
662                 return 19;
663         }
664
665         if (args.state & BTRFS_BALANCE_STATE_RUNNING) {
666                 printf("Balance on '%s' is running", path);
667                 if (args.state & BTRFS_BALANCE_STATE_CANCEL_REQ)
668                         printf(", cancel requested\n");
669                 else if (args.state & BTRFS_BALANCE_STATE_PAUSE_REQ)
670                         printf(", pause requested\n");
671                 else
672                         printf("\n");
673         } else {
674                 printf("Balance on '%s' is paused\n", path);
675         }
676
677         printf("%llu out of about %llu chunks balanced (%llu considered), "
678                "%3.f%% left\n", (unsigned long long)args.stat.completed,
679                (unsigned long long)args.stat.expected,
680                (unsigned long long)args.stat.considered,
681                100 * (1 - (float)args.stat.completed/args.stat.expected));
682
683         if (verbose)
684                 dump_ioctl_balance_args(&args);
685
686         return 0;
687 }
688
689 const struct cmd_group balance_cmd_group = {
690         balance_cmd_group_usage, balance_cmd_group_info, {
691                 { "start", cmd_balance_start, cmd_balance_start_usage, NULL, 0 },
692                 { "pause", cmd_balance_pause, cmd_balance_pause_usage, NULL, 0 },
693                 { "cancel", cmd_balance_cancel, cmd_balance_cancel_usage, NULL, 0 },
694                 { "resume", cmd_balance_resume, cmd_balance_resume_usage, NULL, 0 },
695                 { "status", cmd_balance_status, cmd_balance_status_usage, NULL, 0 },
696                 { 0, 0, 0, 0, 0 }
697         }
698 };
699
700 int cmd_balance(int argc, char **argv)
701 {
702         if (argc == 2) {
703                 /* old 'btrfs filesystem balance <path>' syntax */
704                 struct btrfs_ioctl_balance_args args;
705
706                 memset(&args, 0, sizeof(args));
707                 args.flags |= BTRFS_BALANCE_TYPE_MASK;
708
709                 return do_balance(argv[1], &args, 1);
710         }
711
712         return handle_command_group(&balance_cmd_group, argc, argv);
713 }