btrfs-progs: update wording for qgroup limits
[platform/upstream/btrfs-progs.git] / cmds-qgroup.c
1 /*
2  * Copyright (C) 2012 STRATO.  All rights reserved.
3  *
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.
7  *
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.
12  *
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.
17  */
18
19 #include <sys/ioctl.h>
20 #include <unistd.h>
21 #include <getopt.h>
22
23 #include "ctree.h"
24 #include "ioctl.h"
25
26 #include "commands.h"
27 #include "qgroup.h"
28 #include "utils.h"
29
30 static const char * const qgroup_cmd_group_usage[] = {
31         "btrfs qgroup <command> [options] <path>",
32         NULL
33 };
34
35 static int qgroup_assign(int assign, int argc, char **argv)
36 {
37         int ret = 0;
38         int fd;
39         int e;
40         char *path = argv[3];
41         struct btrfs_ioctl_qgroup_assign_args args;
42         DIR *dirstream = NULL;
43
44         if (check_argc_exact(argc, 4))
45                 return -1;
46
47         memset(&args, 0, sizeof(args));
48         args.assign = assign;
49         args.src = parse_qgroupid(argv[1]);
50         args.dst = parse_qgroupid(argv[2]);
51
52         /*
53          * FIXME src should accept subvol path
54          */
55         if ((args.src >> 48) >= (args.dst >> 48)) {
56                 fprintf(stderr, "ERROR: bad relation requested '%s'\n", path);
57                 return 1;
58         }
59         fd = open_file_or_dir(path, &dirstream);
60         if (fd < 0) {
61                 fprintf(stderr, "ERROR: can't access '%s'\n", path);
62                 return 1;
63         }
64
65         ret = ioctl(fd, BTRFS_IOC_QGROUP_ASSIGN, &args);
66         e = errno;
67         close_file_or_dir(fd, dirstream);
68         if (ret < 0) {
69                 fprintf(stderr, "ERROR: unable to assign quota group: %s\n",
70                         strerror(e));
71                 return 1;
72         }
73         return 0;
74 }
75
76 static int qgroup_create(int create, int argc, char **argv)
77 {
78         int ret = 0;
79         int fd;
80         int e;
81         char *path = argv[2];
82         struct btrfs_ioctl_qgroup_create_args args;
83         DIR *dirstream = NULL;
84
85         if (check_argc_exact(argc, 3))
86                 return -1;
87
88         memset(&args, 0, sizeof(args));
89         args.create = create;
90         args.qgroupid = parse_qgroupid(argv[1]);
91
92         fd = open_file_or_dir(path, &dirstream);
93         if (fd < 0) {
94                 fprintf(stderr, "ERROR: can't access '%s'\n", path);
95                 return 1;
96         }
97
98         ret = ioctl(fd, BTRFS_IOC_QGROUP_CREATE, &args);
99         e = errno;
100         close_file_or_dir(fd, dirstream);
101         if (ret < 0) {
102                 fprintf(stderr, "ERROR: unable to %s quota group: %s\n",
103                         create ? "create":"destroy", strerror(e));
104                 return 1;
105         }
106         return 0;
107 }
108
109 static int parse_limit(const char *p, unsigned long long *s)
110 {
111         char *endptr;
112         unsigned long long size;
113
114         if (strcasecmp(p, "none") == 0) {
115                 *s = 0;
116                 return 1;
117         }
118         size = strtoull(p, &endptr, 10);
119         switch (*endptr) {
120         case 'T':
121         case 't':
122                 size *= 1024;
123                 /* fallthrough */
124         case 'G':
125         case 'g':
126                 size *= 1024;
127                 /* fallthrough */
128         case 'M':
129         case 'm':
130                 size *= 1024;
131                 /* fallthrough */
132         case 'K':
133         case 'k':
134                 size *= 1024;
135                 ++endptr;
136                 break;
137         case 0:
138                 break;
139         default:
140                 return 0;
141         }
142
143         if (*endptr)
144                 return 0;
145
146         *s = size;
147
148         return 1;
149 }
150
151 static const char * const cmd_qgroup_assign_usage[] = {
152         "btrfs qgroup assign <src> <dst> <path>",
153         "Enable subvolume qgroup support for a filesystem.",
154         NULL
155 };
156
157 static int cmd_qgroup_assign(int argc, char **argv)
158 {
159         int ret = qgroup_assign(1, argc, argv);
160         if (ret < 0)
161                 usage(cmd_qgroup_assign_usage);
162         return ret;
163 }
164
165 static const char * const cmd_qgroup_remove_usage[] = {
166         "btrfs qgroup remove <src> <dst> <path>",
167         "Remove a subvol from a quota group.",
168         NULL
169 };
170
171 static int cmd_qgroup_remove(int argc, char **argv)
172 {
173         int ret = qgroup_assign(0, argc, argv);
174         if (ret < 0)
175                 usage(cmd_qgroup_remove_usage);
176         return ret;
177 }
178
179 static const char * const cmd_qgroup_create_usage[] = {
180         "btrfs qgroup create <qgroupid> <path>",
181         "Create a subvolume quota group.",
182         NULL
183 };
184
185 static int cmd_qgroup_create(int argc, char **argv)
186 {
187         int ret = qgroup_create(1, argc, argv);
188         if (ret < 0)
189                 usage(cmd_qgroup_create_usage);
190         return ret;
191 }
192
193 static const char * const cmd_qgroup_destroy_usage[] = {
194         "btrfs qgroup destroy <qgroupid> <path>",
195         "Destroy a subvolume quota group.",
196         NULL
197 };
198
199 static int cmd_qgroup_destroy(int argc, char **argv)
200 {
201         int ret = qgroup_create(0, argc, argv);
202         if (ret < 0)
203                 usage(cmd_qgroup_destroy_usage);
204         return ret;
205 }
206
207 static const char * const cmd_qgroup_show_usage[] = {
208         "btrfs qgroup show -pcreFf "
209         "[--sort=qgroupid,rfer,excl,max_rfer,max_excl] <path>",
210         "Show subvolume quota groups.",
211         "-p             print parent qgroup id",
212         "-c             print child qgroup id",
213         "-r             print limit of referenced size of qgroup",
214         "-e             print limit of exclusive size of qgroup",
215         "-F             list all qgroups which impact the given path",
216         "               (including ancestral qgroups)",
217         "-f             list all qgroups which impact the given path",
218         "               (excluding ancestral qgroups)",
219         "--raw          raw numbers in bytes",
220         "--human-readable",
221         "               human firendly numbers in given base, 1024 by default",
222         "--iec          use 1024 as a base (KiB, MiB, GiB, TiB)",
223         "--si           use 1000 as a base (kB, MB, GB, TB)",
224         "--kbytes       show sizes in KiB, or kB with --si",
225         "--mbytes       show sizes in MiB, or MB with --si",
226         "--gbytes       show sizes in GiB, or GB with --si",
227         "--tbytes       show sizes in TiB, or TB with --si",
228         "--sort=qgroupid,rfer,excl,max_rfer,max_excl",
229         "               list qgroups in order of qgroupid,"
230         "rfer,max_rfer or max_excl",
231         "               you can use '+' or '-' in front of each item.",
232         "               (+:ascending, -:descending, ascending default)",
233         NULL
234 };
235
236 static int cmd_qgroup_show(int argc, char **argv)
237 {
238         char *path;
239         int ret = 0;
240         int fd;
241         int e;
242         DIR *dirstream = NULL;
243         u64 qgroupid;
244         int filter_flag = 0;
245         unsigned unit_mode = UNITS_DEFAULT;
246
247         struct btrfs_qgroup_comparer_set *comparer_set;
248         struct btrfs_qgroup_filter_set *filter_set;
249         filter_set = btrfs_qgroup_alloc_filter_set();
250         comparer_set = btrfs_qgroup_alloc_comparer_set();
251
252         optind = 1;
253         while (1) {
254                 int c;
255                 int option_index = 0;
256                 static const struct option long_options[] = {
257                         {"sort", 1, NULL, 'S'},
258                         {"raw", no_argument, NULL, GETOPT_VAL_RAW},
259                         {"kbytes", no_argument, NULL, GETOPT_VAL_KBYTES},
260                         {"mbytes", no_argument, NULL, GETOPT_VAL_MBYTES},
261                         {"gbytes", no_argument, NULL, GETOPT_VAL_GBYTES},
262                         {"tbytes", no_argument, NULL, GETOPT_VAL_TBYTES},
263                         {"si", no_argument, NULL, GETOPT_VAL_SI},
264                         {"iec", no_argument, NULL, GETOPT_VAL_IEC},
265                         { "human-readable", no_argument, NULL,
266                                 GETOPT_VAL_HUMAN_READABLE},
267                         { NULL, 0, NULL, 0 }
268                 };
269                 c = getopt_long(argc, argv, "pcreFf",
270                                 long_options, &option_index);
271
272                 if (c < 0)
273                         break;
274                 switch (c) {
275                 case 'p':
276                         btrfs_qgroup_setup_print_column(
277                                 BTRFS_QGROUP_PARENT);
278                         break;
279                 case 'c':
280                         btrfs_qgroup_setup_print_column(
281                                 BTRFS_QGROUP_CHILD);
282                         break;
283                 case 'r':
284                         btrfs_qgroup_setup_print_column(
285                                 BTRFS_QGROUP_MAX_RFER);
286                         break;
287                 case 'e':
288                         btrfs_qgroup_setup_print_column(
289                                 BTRFS_QGROUP_MAX_EXCL);
290                         break;
291                 case 'F':
292                         filter_flag |= 0x1;
293                         break;
294                 case 'f':
295                         filter_flag |= 0x2;
296                         break;
297                 case 'S':
298                         ret = btrfs_qgroup_parse_sort_string(optarg,
299                                                              &comparer_set);
300                         if (ret)
301                                 usage(cmd_qgroup_show_usage);
302                         break;
303                 case GETOPT_VAL_RAW:
304                         unit_mode = UNITS_RAW;
305                         break;
306                 case GETOPT_VAL_KBYTES:
307                         units_set_base(&unit_mode, UNITS_KBYTES);
308                         break;
309                 case GETOPT_VAL_MBYTES:
310                         units_set_base(&unit_mode, UNITS_MBYTES);
311                         break;
312                 case GETOPT_VAL_GBYTES:
313                         units_set_base(&unit_mode, UNITS_GBYTES);
314                         break;
315                 case GETOPT_VAL_TBYTES:
316                         units_set_base(&unit_mode, UNITS_TBYTES);
317                         break;
318                 case GETOPT_VAL_SI:
319                         units_set_mode(&unit_mode, UNITS_DECIMAL);
320                         break;
321                 case GETOPT_VAL_IEC:
322                         units_set_mode(&unit_mode, UNITS_BINARY);
323                         break;
324                 case GETOPT_VAL_HUMAN_READABLE:
325                         unit_mode = UNITS_HUMAN_BINARY;
326                         break;
327                 default:
328                         usage(cmd_qgroup_show_usage);
329                 }
330         }
331         btrfs_qgroup_setup_units(unit_mode);
332
333         if (check_argc_exact(argc - optind, 1))
334                 usage(cmd_qgroup_show_usage);
335
336         path = argv[optind];
337         fd = open_file_or_dir(path, &dirstream);
338         if (fd < 0) {
339                 fprintf(stderr, "ERROR: can't access '%s'\n", path);
340                 return 1;
341         }
342
343         if (filter_flag) {
344                 qgroupid = btrfs_get_path_rootid(fd);
345                 if (filter_flag & 0x1)
346                         btrfs_qgroup_setup_filter(&filter_set,
347                                         BTRFS_QGROUP_FILTER_ALL_PARENT,
348                                         qgroupid);
349                 if (filter_flag & 0x2)
350                         btrfs_qgroup_setup_filter(&filter_set,
351                                         BTRFS_QGROUP_FILTER_PARENT,
352                                         qgroupid);
353         }
354         ret = btrfs_show_qgroups(fd, filter_set, comparer_set);
355         e = errno;
356         close_file_or_dir(fd, dirstream);
357         if (ret < 0)
358                 fprintf(stderr, "ERROR: can't list qgroups: %s\n",
359                                 strerror(e));
360
361         return !!ret;
362 }
363
364 static const char * const cmd_qgroup_limit_usage[] = {
365         "btrfs qgroup limit [options] <size>|none [<qgroupid>] <path>",
366         "Limit the size of a subvolume quota group.",
367         "",
368         "-c   limit amount of data after compression. This is the default,",
369         "     it is currently not possible to turn off this option.",
370         "-e   limit space exclusively assigned to this qgroup",
371         NULL
372 };
373
374 static int cmd_qgroup_limit(int argc, char **argv)
375 {
376         int ret = 0;
377         int fd;
378         int e;
379         char *path = NULL;
380         struct btrfs_ioctl_qgroup_limit_args args;
381         unsigned long long size;
382         int compressed = 0;
383         int exclusive = 0;
384         DIR *dirstream = NULL;
385
386         optind = 1;
387         while (1) {
388                 int c = getopt(argc, argv, "ce");
389                 if (c < 0)
390                         break;
391                 switch (c) {
392                 case 'c':
393                         compressed = 1;
394                         break;
395                 case 'e':
396                         exclusive = 1;
397                         break;
398                 default:
399                         usage(cmd_qgroup_limit_usage);
400                 }
401         }
402
403         if (check_argc_min(argc - optind, 2))
404                 usage(cmd_qgroup_limit_usage);
405
406         if (!parse_limit(argv[optind], &size)) {
407                 fprintf(stderr, "Invalid size argument given\n");
408                 return 1;
409         }
410
411         memset(&args, 0, sizeof(args));
412         if (size) {
413                 if (compressed)
414                         args.lim.flags |= BTRFS_QGROUP_LIMIT_RFER_CMPR |
415                                           BTRFS_QGROUP_LIMIT_EXCL_CMPR;
416                 if (exclusive) {
417                         args.lim.flags |= BTRFS_QGROUP_LIMIT_MAX_EXCL;
418                         args.lim.max_exclusive = size;
419                 } else {
420                         args.lim.flags |= BTRFS_QGROUP_LIMIT_MAX_RFER;
421                         args.lim.max_referenced = size;
422                 }
423         }
424
425         if (argc - optind == 2) {
426                 args.qgroupid = 0;
427                 path = argv[optind + 1];
428                 ret = test_issubvolume(path);
429                 if (ret < 0) {
430                         fprintf(stderr, "ERROR: error accessing '%s'\n", path);
431                         return 1;
432                 }
433                 if (!ret) {
434                         fprintf(stderr, "ERROR: '%s' is not a subvolume\n",
435                                 path);
436                         return 1;
437                 }
438                 /*
439                  * keep qgroupid at 0, this indicates that the subvolume the
440                  * fd refers to is to be limited
441                  */
442         } else if (argc - optind == 3) {
443                 args.qgroupid = parse_qgroupid(argv[optind + 1]);
444                 path = argv[optind + 2];
445         } else
446                 usage(cmd_qgroup_limit_usage);
447
448         fd = open_file_or_dir(path, &dirstream);
449         if (fd < 0) {
450                 fprintf(stderr, "ERROR: can't access '%s'\n", path);
451                 return 1;
452         }
453
454         ret = ioctl(fd, BTRFS_IOC_QGROUP_LIMIT, &args);
455         e = errno;
456         close_file_or_dir(fd, dirstream);
457         if (ret < 0) {
458                 fprintf(stderr, "ERROR: unable to limit requested quota group: "
459                         "%s\n", strerror(e));
460                 return 1;
461         }
462         return 0;
463 }
464
465 const struct cmd_group qgroup_cmd_group = {
466         qgroup_cmd_group_usage, NULL, {
467                 { "assign", cmd_qgroup_assign, cmd_qgroup_assign_usage,
468                    NULL, 0 },
469                 { "remove", cmd_qgroup_remove, cmd_qgroup_remove_usage,
470                    NULL, 0 },
471                 { "create", cmd_qgroup_create, cmd_qgroup_create_usage,
472                    NULL, 0 },
473                 { "destroy", cmd_qgroup_destroy, cmd_qgroup_destroy_usage,
474                    NULL, 0 },
475                 { "show", cmd_qgroup_show, cmd_qgroup_show_usage,
476                    NULL, 0 },
477                 { "limit", cmd_qgroup_limit, cmd_qgroup_limit_usage,
478                    NULL, 0 },
479                 NULL_CMD_STRUCT
480         }
481 };
482
483 int cmd_qgroup(int argc, char **argv)
484 {
485         return handle_command_group(&qgroup_cmd_group, argc, argv);
486 }