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.
17 #define _XOPEN_SOURCE 500
22 #include <sys/ioctl.h>
24 #include <uuid/uuid.h>
29 #include <linux/limits.h>
32 #include "kerncompat.h"
39 #include "list_sort.h"
41 static const char * const filesystem_cmd_group_usage[] = {
42 "btrfs filesystem [<group>] <command> [<args>]",
46 static const char * const cmd_df_usage[] = {
47 "btrfs filesystem df <path>",
48 "Show space usage information for a mount point",
52 static char *group_type_str(u64 flag)
54 switch (flag & BTRFS_BLOCK_GROUP_TYPE_MASK) {
55 case BTRFS_BLOCK_GROUP_DATA:
57 case BTRFS_BLOCK_GROUP_SYSTEM:
59 case BTRFS_BLOCK_GROUP_METADATA:
61 case BTRFS_BLOCK_GROUP_DATA|BTRFS_BLOCK_GROUP_METADATA:
62 return "Data+Metadata";
68 static char *group_profile_str(u64 flag)
70 switch (flag & BTRFS_BLOCK_GROUP_PROFILE_MASK) {
73 case BTRFS_BLOCK_GROUP_RAID0:
75 case BTRFS_BLOCK_GROUP_RAID1:
77 case BTRFS_BLOCK_GROUP_RAID5:
79 case BTRFS_BLOCK_GROUP_RAID6:
81 case BTRFS_BLOCK_GROUP_DUP:
83 case BTRFS_BLOCK_GROUP_RAID10:
90 static int get_df(int fd, struct btrfs_ioctl_space_args **sargs_ret)
94 struct btrfs_ioctl_space_args *sargs;
96 sargs = malloc(sizeof(struct btrfs_ioctl_space_args));
100 sargs->space_slots = 0;
101 sargs->total_spaces = 0;
103 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
106 fprintf(stderr, "ERROR: couldn't get space info - %s\n",
111 if (!sargs->total_spaces) {
115 count = sargs->total_spaces;
118 sargs = malloc(sizeof(struct btrfs_ioctl_space_args) +
119 (count * sizeof(struct btrfs_ioctl_space_info)));
123 sargs->space_slots = count;
124 sargs->total_spaces = 0;
125 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
128 fprintf(stderr, "ERROR: get space info count %llu - %s\n",
137 static void print_df(struct btrfs_ioctl_space_args *sargs)
140 struct btrfs_ioctl_space_info *sp = sargs->spaces;
142 for (i = 0; i < sargs->total_spaces; i++, sp++) {
143 printf("%s, %s: total=%s, used=%s\n",
144 group_type_str(sp->flags),
145 group_profile_str(sp->flags),
146 pretty_size(sp->total_bytes),
147 pretty_size(sp->used_bytes));
151 static int cmd_df(int argc, char **argv)
153 struct btrfs_ioctl_space_args *sargs = NULL;
157 DIR *dirstream = NULL;
159 if (check_argc_exact(argc, 2))
164 fd = open_file_or_dir(path, &dirstream);
166 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
169 ret = get_df(fd, &sargs);
175 fprintf(stderr, "ERROR: get_df failed %s\n", strerror(ret));
178 close_file_or_dir(fd, dirstream);
182 static int uuid_search(struct btrfs_fs_devices *fs_devices, char *search)
185 struct list_head *cur;
186 struct btrfs_device *device;
187 int search_len = strlen(search);
189 search_len = min(search_len, 37);
190 uuid_unparse(fs_devices->fsid, uuidbuf);
191 if (!strncmp(uuidbuf, search, search_len))
194 list_for_each(cur, &fs_devices->devices) {
195 device = list_entry(cur, struct btrfs_device, dev_list);
196 if ((device->label && strcmp(device->label, search) == 0) ||
197 strcmp(device->name, search) == 0)
204 * Sort devices by devid, ascending
206 static int cmp_device_id(void *priv, struct list_head *a,
209 const struct btrfs_device *da = list_entry(a, struct btrfs_device,
211 const struct btrfs_device *db = list_entry(b, struct btrfs_device,
214 return da->devid < db->devid ? -1 :
215 da->devid > db->devid ? 1 : 0;
218 static void print_one_uuid(struct btrfs_fs_devices *fs_devices)
221 struct list_head *cur;
222 struct btrfs_device *device;
226 uuid_unparse(fs_devices->fsid, uuidbuf);
227 device = list_entry(fs_devices->devices.next, struct btrfs_device,
229 if (device->label && device->label[0])
230 printf("Label: '%s' ", device->label);
232 printf("Label: none ");
235 total = device->total_devs;
236 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
237 (unsigned long long)total,
238 pretty_size(device->super_bytes_used));
240 list_sort(NULL, &fs_devices->devices, cmp_device_id);
241 list_for_each(cur, &fs_devices->devices) {
242 device = list_entry(cur, struct btrfs_device, dev_list);
244 printf("\tdevid %4llu size %s used %s path %s\n",
245 (unsigned long long)device->devid,
246 pretty_size(device->total_bytes),
247 pretty_size(device->bytes_used), device->name);
251 if (devs_found < total) {
252 printf("\t*** Some devices missing\n");
257 /* adds up all the used spaces as reported by the space info ioctl
259 static u64 calc_used_bytes(struct btrfs_ioctl_space_args *si)
263 for (i = 0; i < si->total_spaces; i++)
264 ret += si->spaces[i].used_bytes;
268 static int print_one_fs(struct btrfs_ioctl_fs_info_args *fs_info,
269 struct btrfs_ioctl_dev_info_args *dev_info,
270 struct btrfs_ioctl_space_args *space_info,
271 char *label, char *path)
275 struct btrfs_ioctl_dev_info_args *tmp_dev_info;
277 uuid_unparse(fs_info->fsid, uuidbuf);
278 printf("Label: %s uuid: %s\n",
279 strlen(label) ? label : "none", uuidbuf);
281 printf("\tTotal devices %llu FS bytes used %s\n",
282 fs_info->num_devices,
283 pretty_size(calc_used_bytes(space_info)));
285 for (i = 0; i < fs_info->num_devices; i++) {
286 tmp_dev_info = (struct btrfs_ioctl_dev_info_args *)&dev_info[i];
287 printf("\tdevid %llu size %s used %s path %s\n",
289 pretty_size(tmp_dev_info->total_bytes),
290 pretty_size(tmp_dev_info->bytes_used),
298 /* This function checks if the given input parameter is
300 * return -1: some error in the given input
301 * return 0: unknow input
302 * return 1: given input is uuid
303 * return 2: given input is path
305 static int check_arg_type(char *input)
311 return BTRFS_ARG_UNKNOWN;
313 if (realpath(input, path))
314 return BTRFS_ARG_PATH;
316 if (!uuid_parse(input, out))
317 return BTRFS_ARG_UUID;
319 return BTRFS_ARG_UNKNOWN;
322 static int btrfs_scan_kernel(void *search)
324 int ret = 0, fd, type;
327 struct btrfs_ioctl_fs_info_args fs_info_arg;
328 struct btrfs_ioctl_dev_info_args *dev_info_arg = NULL;
329 struct btrfs_ioctl_space_args *space_info_arg;
330 char label[BTRFS_LABEL_SIZE];
333 f = setmntent("/proc/self/mounts", "r");
337 type = check_arg_type(search);
339 while ((mnt = getmntent(f)) != NULL) {
340 if (strcmp(mnt->mnt_type, "btrfs"))
342 ret = get_fs_info(mnt->mnt_dir, &fs_info_arg,
349 ret = uuid_parse(search, uuid);
352 if (uuid_compare(fs_info_arg.fsid, uuid))
356 if (strcmp(search, mnt->mnt_dir))
363 fd = open(mnt->mnt_dir, O_RDONLY);
364 if (fd > 0 && !get_df(fd, &space_info_arg)) {
365 get_label_mounted(mnt->mnt_dir, label);
366 print_one_fs(&fs_info_arg, dev_info_arg,
367 space_info_arg, label, mnt->mnt_dir);
368 free(space_info_arg);
377 static const char * const cmd_show_usage[] = {
378 "btrfs filesystem show [options] [<path>|<uuid>]",
379 "Show the structure of a filesystem",
380 "-d|--all-devices show only disks under /dev containing btrfs filesystem",
381 "-m|--mounted show only mounted btrfs",
382 "If no argument is given, structure of all present filesystems is shown.",
386 static int cmd_show(int argc, char **argv)
388 struct list_head *all_uuids;
389 struct btrfs_fs_devices *fs_devices;
390 struct btrfs_device *device;
391 struct list_head *cur_uuid;
394 int where = BTRFS_SCAN_PROC;
399 static struct option long_options[] = {
400 { "all-devices", no_argument, NULL, 'd'},
401 { "mounted", no_argument, NULL, 'm'},
402 { NULL, no_argument, NULL, 0 },
404 int c = getopt_long(argc, argv, "dm", long_options,
410 where = BTRFS_SCAN_DEV;
413 where = BTRFS_SCAN_MOUNTED;
416 usage(cmd_show_usage);
420 if (check_argc_max(argc, optind + 1))
421 usage(cmd_show_usage);
423 search = argv[optind];
424 type = check_arg_type(search);
425 if (type == BTRFS_ARG_UNKNOWN) {
426 fprintf(stderr, "ERROR: arg type unknown\n");
427 usage(cmd_show_usage);
431 if (where == BTRFS_SCAN_DEV)
434 /* show mounted btrfs */
435 btrfs_scan_kernel(search);
437 /* shows mounted only */
438 if (where == BTRFS_SCAN_MOUNTED)
442 ret = scan_for_btrfs(where, !BTRFS_UPDATE_KERNEL);
445 fprintf(stderr, "ERROR: %d while scanning\n", ret);
449 all_uuids = btrfs_scanned_uuids();
450 list_for_each(cur_uuid, all_uuids) {
451 fs_devices = list_entry(cur_uuid, struct btrfs_fs_devices,
453 if (search && uuid_search(fs_devices, search) == 0)
456 /* skip mounted as they are already printed by
459 /* do it only for the default, no option */
460 if (where == BTRFS_SCAN_PROC) {
461 device = list_entry(fs_devices->devices.next,
462 struct btrfs_device, dev_list);
463 ret = check_mounted(device->name);
467 print_one_uuid(fs_devices);
471 printf("%s\n", BTRFS_BUILD_VERSION);
475 static const char * const cmd_sync_usage[] = {
476 "btrfs filesystem sync <path>",
477 "Force a sync on a filesystem",
481 static int cmd_sync(int argc, char **argv)
485 DIR *dirstream = NULL;
487 if (check_argc_exact(argc, 2))
488 usage(cmd_sync_usage);
492 fd = open_file_or_dir(path, &dirstream);
494 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
498 printf("FSSync '%s'\n", path);
499 res = ioctl(fd, BTRFS_IOC_SYNC);
501 close_file_or_dir(fd, dirstream);
503 fprintf(stderr, "ERROR: unable to fs-syncing '%s' - %s\n",
511 static int parse_compress_type(char *s)
513 if (strcmp(optarg, "zlib") == 0)
514 return BTRFS_COMPRESS_ZLIB;
515 else if (strcmp(optarg, "lzo") == 0)
516 return BTRFS_COMPRESS_LZO;
518 fprintf(stderr, "Unknown compress type %s\n", s);
523 static const char * const cmd_defrag_usage[] = {
524 "btrfs filesystem defragment [options] <file>|<dir> [<file>|<dir>...]",
525 "Defragment a file or a directory",
528 "-r defragment files recursively",
529 "-c[zlib,lzo] compress the file while defragmenting",
530 "-f flush data to disk immediately after defragmenting",
531 "-s start defragment only from byte onward",
532 "-l len defragment only up to len bytes",
533 "-t size minimal size of file to be considered for defragmenting",
537 static int do_defrag(int fd, int fancy_ioctl,
538 struct btrfs_ioctl_defrag_range_args *range)
543 ret = ioctl(fd, BTRFS_IOC_DEFRAG, NULL);
545 ret = ioctl(fd, BTRFS_IOC_DEFRAG_RANGE, range);
550 static int defrag_global_fancy_ioctl;
551 static struct btrfs_ioctl_defrag_range_args defrag_global_range;
552 static int defrag_global_verbose;
553 static int defrag_global_errors;
554 static int defrag_callback(const char *fpath, const struct stat *sb,
555 int typeflag, struct FTW *ftwbuf)
561 if (typeflag == FTW_F) {
562 if (defrag_global_verbose)
563 printf("%s\n", fpath);
564 fd = open(fpath, O_RDWR);
568 ret = do_defrag(fd, defrag_global_fancy_ioctl, &defrag_global_range);
571 if (ret && e == ENOTTY) {
572 fprintf(stderr, "ERROR: defrag range ioctl not "
573 "supported in this kernel, please try "
574 "without any options.\n");
575 defrag_global_errors++;
584 fprintf(stderr, "ERROR: defrag failed on %s - %s\n", fpath, strerror(e));
585 defrag_global_errors++;
589 static int cmd_defrag(int argc, char **argv)
599 struct btrfs_ioctl_defrag_range_args range;
601 int compress_type = BTRFS_COMPRESS_NONE;
604 defrag_global_errors = 0;
605 defrag_global_verbose = 0;
606 defrag_global_errors = 0;
607 defrag_global_fancy_ioctl = 0;
610 int c = getopt(argc, argv, "vrc::fs:l:t:");
616 compress_type = BTRFS_COMPRESS_ZLIB;
618 compress_type = parse_compress_type(optarg);
619 defrag_global_fancy_ioctl = 1;
623 defrag_global_fancy_ioctl = 1;
626 defrag_global_verbose = 1;
629 start = parse_size(optarg);
630 defrag_global_fancy_ioctl = 1;
633 len = parse_size(optarg);
634 defrag_global_fancy_ioctl = 1;
637 thresh = parse_size(optarg);
638 defrag_global_fancy_ioctl = 1;
644 usage(cmd_defrag_usage);
648 if (check_argc_min(argc - optind, 1))
649 usage(cmd_defrag_usage);
651 memset(&defrag_global_range, 0, sizeof(range));
652 defrag_global_range.start = start;
653 defrag_global_range.len = len;
654 defrag_global_range.extent_thresh = thresh;
656 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_COMPRESS;
657 defrag_global_range.compress_type = compress_type;
660 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_START_IO;
662 for (i = optind; i < argc; i++) {
664 fd = open_file_or_dir(argv[i], &dirstream);
666 fprintf(stderr, "ERROR: failed to open %s - %s\n", argv[i],
668 defrag_global_errors++;
669 close_file_or_dir(fd, dirstream);
676 if (S_ISDIR(st.st_mode)) {
677 ret = nftw(argv[i], defrag_callback, 10,
678 FTW_MOUNT | FTW_PHYS);
681 /* errors are handled in the callback */
684 if (defrag_global_verbose)
685 printf("%s\n", argv[i]);
686 ret = do_defrag(fd, defrag_global_fancy_ioctl,
687 &defrag_global_range);
691 if (defrag_global_verbose)
692 printf("%s\n", argv[i]);
693 ret = do_defrag(fd, defrag_global_fancy_ioctl,
694 &defrag_global_range);
697 close_file_or_dir(fd, dirstream);
698 if (ret && e == ENOTTY) {
699 fprintf(stderr, "ERROR: defrag range ioctl not "
700 "supported in this kernel, please try "
701 "without any options.\n");
702 defrag_global_errors++;
706 fprintf(stderr, "ERROR: defrag failed on %s - %s\n",
707 argv[i], strerror(e));
708 defrag_global_errors++;
711 if (defrag_global_verbose)
712 printf("%s\n", BTRFS_BUILD_VERSION);
713 if (defrag_global_errors)
714 fprintf(stderr, "total %d failures\n", defrag_global_errors);
716 return !!defrag_global_errors;
719 static const char * const cmd_resize_usage[] = {
720 "btrfs filesystem resize [devid:][+/-]<newsize>[gkm]|[devid:]max <path>",
721 "Resize a filesystem",
722 "If 'max' is passed, the filesystem will occupy all available space",
723 "on the device 'devid'.",
727 static int cmd_resize(int argc, char **argv)
729 struct btrfs_ioctl_vol_args args;
732 DIR *dirstream = NULL;
734 if (check_argc_exact(argc, 3))
735 usage(cmd_resize_usage);
740 len = strlen(amount);
741 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
742 fprintf(stderr, "ERROR: size value too long ('%s)\n",
747 fd = open_file_or_dir(path, &dirstream);
749 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
753 printf("Resize '%s' of '%s'\n", path, amount);
754 strncpy_null(args.name, amount);
755 res = ioctl(fd, BTRFS_IOC_RESIZE, &args);
757 close_file_or_dir(fd, dirstream);
759 fprintf(stderr, "ERROR: unable to resize '%s' - %s\n",
766 static const char * const cmd_label_usage[] = {
767 "btrfs filesystem label [<device>|<mount_point>] [<newlabel>]",
768 "Get or change the label of a filesystem",
769 "With one argument, get the label of filesystem on <device>.",
770 "If <newlabel> is passed, set the filesystem label to <newlabel>.",
774 static int cmd_label(int argc, char **argv)
776 if (check_argc_min(argc, 2) || check_argc_max(argc, 3))
777 usage(cmd_label_usage);
780 return set_label(argv[1], argv[2]);
782 return get_label(argv[1]);
785 const struct cmd_group filesystem_cmd_group = {
786 filesystem_cmd_group_usage, NULL, {
787 { "df", cmd_df, cmd_df_usage, NULL, 0 },
788 { "show", cmd_show, cmd_show_usage, NULL, 0 },
789 { "sync", cmd_sync, cmd_sync_usage, NULL, 0 },
790 { "defragment", cmd_defrag, cmd_defrag_usage, NULL, 0 },
791 { "balance", cmd_balance, NULL, &balance_cmd_group, 1 },
792 { "resize", cmd_resize, cmd_resize_usage, NULL, 0 },
793 { "label", cmd_label, cmd_label_usage, NULL, 0 },
798 int cmd_filesystem(int argc, char **argv)
800 return handle_command_group(&filesystem_cmd_group, argc, argv);