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"
44 * for btrfs fi show, we maintain a hash of fsids we've already printed.
45 * This way we don't print dups if a given FS is mounted more than once.
47 #define SEEN_FSID_HASH_SIZE 256
50 u8 fsid[BTRFS_FSID_SIZE];
51 struct seen_fsid *next;
54 static struct seen_fsid *seen_fsid_hash[SEEN_FSID_HASH_SIZE] = {NULL,};
56 static int add_seen_fsid(u8 *fsid)
59 int slot = hash % SEEN_FSID_HASH_SIZE;
60 struct seen_fsid *seen = seen_fsid_hash[slot];
61 struct seen_fsid *alloc;
67 if (memcmp(seen->fsid, fsid, BTRFS_FSID_SIZE) == 0)
78 alloc = malloc(sizeof(*alloc));
83 memcpy(alloc->fsid, fsid, BTRFS_FSID_SIZE);
88 seen_fsid_hash[slot] = alloc;
93 static void free_seen_fsid(void)
96 struct seen_fsid *seen;
97 struct seen_fsid *next;
99 for (slot = 0; slot < SEEN_FSID_HASH_SIZE; slot++) {
100 seen = seen_fsid_hash[slot];
106 seen_fsid_hash[slot] = NULL;
110 static const char * const filesystem_cmd_group_usage[] = {
111 "btrfs filesystem [<group>] <command> [<args>]",
115 static const char * const cmd_df_usage[] = {
116 "btrfs filesystem df <path>",
117 "Show space usage information for a mount point",
121 static char *group_type_str(u64 flag)
123 switch (flag & BTRFS_BLOCK_GROUP_TYPE_MASK) {
124 case BTRFS_BLOCK_GROUP_DATA:
126 case BTRFS_BLOCK_GROUP_SYSTEM:
128 case BTRFS_BLOCK_GROUP_METADATA:
130 case BTRFS_BLOCK_GROUP_DATA|BTRFS_BLOCK_GROUP_METADATA:
131 return "Data+Metadata";
137 static char *group_profile_str(u64 flag)
139 switch (flag & BTRFS_BLOCK_GROUP_PROFILE_MASK) {
142 case BTRFS_BLOCK_GROUP_RAID0:
144 case BTRFS_BLOCK_GROUP_RAID1:
146 case BTRFS_BLOCK_GROUP_RAID5:
148 case BTRFS_BLOCK_GROUP_RAID6:
150 case BTRFS_BLOCK_GROUP_DUP:
152 case BTRFS_BLOCK_GROUP_RAID10:
159 static int get_df(int fd, struct btrfs_ioctl_space_args **sargs_ret)
163 struct btrfs_ioctl_space_args *sargs;
165 sargs = malloc(sizeof(struct btrfs_ioctl_space_args));
169 sargs->space_slots = 0;
170 sargs->total_spaces = 0;
172 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
175 fprintf(stderr, "ERROR: couldn't get space info - %s\n",
180 /* This really should never happen */
181 if (!sargs->total_spaces) {
185 count = sargs->total_spaces;
188 sargs = malloc(sizeof(struct btrfs_ioctl_space_args) +
189 (count * sizeof(struct btrfs_ioctl_space_info)));
193 sargs->space_slots = count;
194 sargs->total_spaces = 0;
195 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
198 fprintf(stderr, "ERROR: get space info count %llu - %s\n",
207 static void print_df(struct btrfs_ioctl_space_args *sargs)
210 struct btrfs_ioctl_space_info *sp = sargs->spaces;
212 for (i = 0; i < sargs->total_spaces; i++, sp++) {
213 printf("%s, %s: total=%s, used=%s\n",
214 group_type_str(sp->flags),
215 group_profile_str(sp->flags),
216 pretty_size(sp->total_bytes),
217 pretty_size(sp->used_bytes));
221 static int cmd_df(int argc, char **argv)
223 struct btrfs_ioctl_space_args *sargs = NULL;
227 DIR *dirstream = NULL;
229 if (check_argc_exact(argc, 2))
234 fd = open_file_or_dir(path, &dirstream);
236 fprintf(stderr, "ERROR: can't access '%s'\n", path);
239 ret = get_df(fd, &sargs);
245 fprintf(stderr, "ERROR: get_df failed %s\n", strerror(-ret));
248 close_file_or_dir(fd, dirstream);
252 static int match_search_item_kernel(__u8 *fsid, char *mnt, char *label,
255 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
256 int search_len = strlen(search);
258 search_len = min(search_len, BTRFS_UUID_UNPARSED_SIZE);
259 uuid_unparse(fsid, uuidbuf);
260 if (!strncmp(uuidbuf, search, search_len))
263 if (strlen(label) && strcmp(label, search) == 0)
266 if (strcmp(mnt, search) == 0)
272 static int uuid_search(struct btrfs_fs_devices *fs_devices, char *search)
274 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
275 struct list_head *cur;
276 struct btrfs_device *device;
277 int search_len = strlen(search);
279 search_len = min(search_len, BTRFS_UUID_UNPARSED_SIZE);
280 uuid_unparse(fs_devices->fsid, uuidbuf);
281 if (!strncmp(uuidbuf, search, search_len))
284 list_for_each(cur, &fs_devices->devices) {
285 device = list_entry(cur, struct btrfs_device, dev_list);
286 if ((device->label && strcmp(device->label, search) == 0) ||
287 strcmp(device->name, search) == 0)
294 * Sort devices by devid, ascending
296 static int cmp_device_id(void *priv, struct list_head *a,
299 const struct btrfs_device *da = list_entry(a, struct btrfs_device,
301 const struct btrfs_device *db = list_entry(b, struct btrfs_device,
304 return da->devid < db->devid ? -1 :
305 da->devid > db->devid ? 1 : 0;
308 static void print_one_uuid(struct btrfs_fs_devices *fs_devices)
310 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
311 struct list_head *cur;
312 struct btrfs_device *device;
316 if (add_seen_fsid(fs_devices->fsid))
319 uuid_unparse(fs_devices->fsid, uuidbuf);
320 device = list_entry(fs_devices->devices.next, struct btrfs_device,
322 if (device->label && device->label[0])
323 printf("Label: '%s' ", device->label);
325 printf("Label: none ");
328 total = device->total_devs;
329 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
330 (unsigned long long)total,
331 pretty_size(device->super_bytes_used));
333 list_sort(NULL, &fs_devices->devices, cmp_device_id);
334 list_for_each(cur, &fs_devices->devices) {
335 device = list_entry(cur, struct btrfs_device, dev_list);
337 printf("\tdevid %4llu size %s used %s path %s\n",
338 (unsigned long long)device->devid,
339 pretty_size(device->total_bytes),
340 pretty_size(device->bytes_used), device->name);
344 if (devs_found < total) {
345 printf("\t*** Some devices missing\n");
350 /* adds up all the used spaces as reported by the space info ioctl
352 static u64 calc_used_bytes(struct btrfs_ioctl_space_args *si)
356 for (i = 0; i < si->total_spaces; i++)
357 ret += si->spaces[i].used_bytes;
361 static int print_one_fs(struct btrfs_ioctl_fs_info_args *fs_info,
362 struct btrfs_ioctl_dev_info_args *dev_info,
363 struct btrfs_ioctl_space_args *space_info,
364 char *label, char *path)
369 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
370 struct btrfs_ioctl_dev_info_args *tmp_dev_info;
373 ret = add_seen_fsid(fs_info->fsid);
379 uuid_unparse(fs_info->fsid, uuidbuf);
380 if (label && strlen(label))
381 printf("Label: '%s' ", label);
383 printf("Label: none ");
385 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
386 fs_info->num_devices,
387 pretty_size(calc_used_bytes(space_info)));
389 for (i = 0; i < fs_info->num_devices; i++) {
390 tmp_dev_info = (struct btrfs_ioctl_dev_info_args *)&dev_info[i];
392 /* Add check for missing devices even mounted */
393 fd = open((char *)tmp_dev_info->path, O_RDONLY);
399 printf("\tdevid %4llu size %s used %s path %s\n",
401 pretty_size(tmp_dev_info->total_bytes),
402 pretty_size(tmp_dev_info->bytes_used),
407 printf("\t*** Some devices missing\n");
412 /* This function checks if the given input parameter is
414 * return -1: some error in the given input
415 * return 0: unknow input
416 * return 1: given input is uuid
417 * return 2: given input is path
419 static int check_arg_type(char *input)
427 if (realpath(input, path)) {
428 if (is_block_device(path) == 1)
429 return BTRFS_ARG_BLKDEV;
431 if (is_mount_point(path) == 1)
432 return BTRFS_ARG_MNTPOINT;
434 return BTRFS_ARG_UNKNOWN;
437 if (strlen(input) == (BTRFS_UUID_UNPARSED_SIZE - 1) &&
438 !uuid_parse(input, out))
439 return BTRFS_ARG_UUID;
441 return BTRFS_ARG_UNKNOWN;
444 static int btrfs_scan_kernel(void *search)
450 struct btrfs_ioctl_fs_info_args fs_info_arg;
451 struct btrfs_ioctl_dev_info_args *dev_info_arg = NULL;
452 struct btrfs_ioctl_space_args *space_info_arg = NULL;
453 char label[BTRFS_LABEL_SIZE];
455 f = setmntent("/proc/self/mounts", "r");
459 memset(label, 0, sizeof(label));
460 while ((mnt = getmntent(f)) != NULL) {
461 if (strcmp(mnt->mnt_type, "btrfs"))
463 ret = get_fs_info(mnt->mnt_dir, &fs_info_arg,
468 if (get_label_mounted(mnt->mnt_dir, label)) {
472 if (search && !match_search_item_kernel(fs_info_arg.fsid,
473 mnt->mnt_dir, label, search)) {
478 fd = open(mnt->mnt_dir, O_RDONLY);
479 if ((fd != -1) && !get_df(fd, &space_info_arg)) {
480 print_one_fs(&fs_info_arg, dev_info_arg,
481 space_info_arg, label, mnt->mnt_dir);
482 kfree(space_info_arg);
483 memset(label, 0, sizeof(label));
496 static int dev_to_fsid(char *dev, __u8 *fsid)
498 struct btrfs_super_block *disk_super;
507 fd = open(dev, O_RDONLY);
514 disk_super = (struct btrfs_super_block *)buf;
515 ret = btrfs_read_dev_super(fd, disk_super,
516 BTRFS_SUPER_INFO_OFFSET);
520 memcpy(fsid, disk_super->fsid, BTRFS_FSID_SIZE);
529 static const char * const cmd_show_usage[] = {
530 "btrfs filesystem show [options] [<path>|<uuid>|<device>|label]",
531 "Show the structure of a filesystem",
532 "-d|--all-devices show only disks under /dev containing btrfs filesystem",
533 "-m|--mounted show only mounted btrfs",
534 "If no argument is given, structure of all present filesystems is shown.",
538 static int cmd_show(int argc, char **argv)
540 struct list_head *all_uuids;
541 struct btrfs_fs_devices *fs_devices;
542 struct list_head *cur_uuid;
545 int where = BTRFS_SCAN_LBLKID;
547 char mp[BTRFS_PATH_NAME_MAX + 1];
549 __u8 fsid[BTRFS_FSID_SIZE];
555 static struct option long_options[] = {
556 { "all-devices", no_argument, NULL, 'd'},
557 { "mounted", no_argument, NULL, 'm'},
558 { NULL, no_argument, NULL, 0 },
560 int c = getopt_long(argc, argv, "dm", long_options,
566 where = BTRFS_SCAN_DEV;
569 where = BTRFS_SCAN_MOUNTED;
572 usage(cmd_show_usage);
576 if (check_argc_max(argc, optind + 1))
577 usage(cmd_show_usage);
580 search = argv[optind];
581 if (strlen(search) == 0)
582 usage(cmd_show_usage);
583 type = check_arg_type(search);
585 * needs spl handling if input arg is block dev
586 * And if input arg is mount-point just print it
589 if (type == BTRFS_ARG_BLKDEV) {
590 if (where == BTRFS_SCAN_DEV) {
591 /* we need to do this because
592 * legacy BTRFS_SCAN_DEV
593 * provides /dev/dm-x paths
595 if (realpath(search, path))
598 ret = get_btrfs_mount(search,
601 /* given block dev is mounted*/
603 type = BTRFS_ARG_MNTPOINT;
605 ret = dev_to_fsid(search, fsid);
608 "ERROR: No btrfs on %s\n",
612 uuid_unparse(fsid, uuid_buf);
614 type = BTRFS_ARG_UUID;
621 if (where == BTRFS_SCAN_DEV)
624 /* show mounted btrfs */
625 ret = btrfs_scan_kernel(search);
626 if (search && !ret) {
627 /* since search is found we are done */
631 /* shows mounted only */
632 if (where == BTRFS_SCAN_MOUNTED)
636 ret = scan_for_btrfs(where, !BTRFS_UPDATE_KERNEL);
639 fprintf(stderr, "ERROR: %d while scanning\n", ret);
643 all_uuids = btrfs_scanned_uuids();
644 list_for_each(cur_uuid, all_uuids) {
645 fs_devices = list_entry(cur_uuid, struct btrfs_fs_devices,
647 if (search && uuid_search(fs_devices, search) == 0)
650 print_one_uuid(fs_devices);
653 if (search && !found)
656 while (!list_empty(all_uuids)) {
657 fs_devices = list_entry(all_uuids->next,
658 struct btrfs_fs_devices, list);
659 list_del(&fs_devices->list);
660 btrfs_close_devices(fs_devices);
663 printf("%s\n", BTRFS_BUILD_VERSION);
668 static const char * const cmd_sync_usage[] = {
669 "btrfs filesystem sync <path>",
670 "Force a sync on a filesystem",
674 static int cmd_sync(int argc, char **argv)
678 DIR *dirstream = NULL;
680 if (check_argc_exact(argc, 2))
681 usage(cmd_sync_usage);
685 fd = open_file_or_dir(path, &dirstream);
687 fprintf(stderr, "ERROR: can't access '%s'\n", path);
691 printf("FSSync '%s'\n", path);
692 res = ioctl(fd, BTRFS_IOC_SYNC);
694 close_file_or_dir(fd, dirstream);
696 fprintf(stderr, "ERROR: unable to fs-syncing '%s' - %s\n",
704 static int parse_compress_type(char *s)
706 if (strcmp(optarg, "zlib") == 0)
707 return BTRFS_COMPRESS_ZLIB;
708 else if (strcmp(optarg, "lzo") == 0)
709 return BTRFS_COMPRESS_LZO;
711 fprintf(stderr, "Unknown compress type %s\n", s);
716 static const char * const cmd_defrag_usage[] = {
717 "btrfs filesystem defragment [options] <file>|<dir> [<file>|<dir>...]",
718 "Defragment a file or a directory",
721 "-r defragment files recursively",
722 "-c[zlib,lzo] compress the file while defragmenting",
723 "-f flush data to disk immediately after defragmenting",
724 "-s start defragment only from byte onward",
725 "-l len defragment only up to len bytes",
726 "-t size minimal size of file to be considered for defragmenting",
730 static int do_defrag(int fd, int fancy_ioctl,
731 struct btrfs_ioctl_defrag_range_args *range)
736 ret = ioctl(fd, BTRFS_IOC_DEFRAG, NULL);
738 ret = ioctl(fd, BTRFS_IOC_DEFRAG_RANGE, range);
743 static int defrag_global_fancy_ioctl;
744 static struct btrfs_ioctl_defrag_range_args defrag_global_range;
745 static int defrag_global_verbose;
746 static int defrag_global_errors;
747 static int defrag_callback(const char *fpath, const struct stat *sb,
748 int typeflag, struct FTW *ftwbuf)
754 if ((typeflag == FTW_F) && S_ISREG(sb->st_mode)) {
755 if (defrag_global_verbose)
756 printf("%s\n", fpath);
757 fd = open(fpath, O_RDWR);
761 ret = do_defrag(fd, defrag_global_fancy_ioctl, &defrag_global_range);
764 if (ret && e == ENOTTY && defrag_global_fancy_ioctl) {
765 fprintf(stderr, "ERROR: defrag range ioctl not "
766 "supported in this kernel, please try "
767 "without any options.\n");
768 defrag_global_errors++;
777 fprintf(stderr, "ERROR: defrag failed on %s - %s\n", fpath, strerror(e));
778 defrag_global_errors++;
782 static int cmd_defrag(int argc, char **argv)
792 struct btrfs_ioctl_defrag_range_args range;
794 int compress_type = BTRFS_COMPRESS_NONE;
797 defrag_global_errors = 0;
798 defrag_global_verbose = 0;
799 defrag_global_errors = 0;
800 defrag_global_fancy_ioctl = 0;
803 int c = getopt(argc, argv, "vrc::fs:l:t:");
809 compress_type = BTRFS_COMPRESS_ZLIB;
811 compress_type = parse_compress_type(optarg);
812 defrag_global_fancy_ioctl = 1;
816 defrag_global_fancy_ioctl = 1;
819 defrag_global_verbose = 1;
822 start = parse_size(optarg);
823 defrag_global_fancy_ioctl = 1;
826 len = parse_size(optarg);
827 defrag_global_fancy_ioctl = 1;
830 thresh = parse_size(optarg);
831 defrag_global_fancy_ioctl = 1;
837 usage(cmd_defrag_usage);
841 if (check_argc_min(argc - optind, 1))
842 usage(cmd_defrag_usage);
844 memset(&defrag_global_range, 0, sizeof(range));
845 defrag_global_range.start = start;
846 defrag_global_range.len = len;
847 defrag_global_range.extent_thresh = thresh;
849 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_COMPRESS;
850 defrag_global_range.compress_type = compress_type;
853 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_START_IO;
855 for (i = optind; i < argc; i++) {
859 fd = open_file_or_dir(argv[i], &dirstream);
861 fprintf(stderr, "ERROR: failed to open %s - %s\n", argv[i],
863 defrag_global_errors++;
864 close_file_or_dir(fd, dirstream);
867 if (fstat(fd, &st)) {
868 fprintf(stderr, "ERROR: failed to stat %s - %s\n",
869 argv[i], strerror(errno));
870 defrag_global_errors++;
871 close_file_or_dir(fd, dirstream);
874 if (!(S_ISDIR(st.st_mode) || S_ISREG(st.st_mode))) {
876 "ERROR: %s is not a directory or a regular file\n",
878 defrag_global_errors++;
879 close_file_or_dir(fd, dirstream);
883 if (S_ISDIR(st.st_mode)) {
884 ret = nftw(argv[i], defrag_callback, 10,
885 FTW_MOUNT | FTW_PHYS);
888 /* errors are handled in the callback */
891 if (defrag_global_verbose)
892 printf("%s\n", argv[i]);
893 ret = do_defrag(fd, defrag_global_fancy_ioctl,
894 &defrag_global_range);
898 if (defrag_global_verbose)
899 printf("%s\n", argv[i]);
900 ret = do_defrag(fd, defrag_global_fancy_ioctl,
901 &defrag_global_range);
904 close_file_or_dir(fd, dirstream);
905 if (ret && e == ENOTTY && defrag_global_fancy_ioctl) {
906 fprintf(stderr, "ERROR: defrag range ioctl not "
907 "supported in this kernel, please try "
908 "without any options.\n");
909 defrag_global_errors++;
913 fprintf(stderr, "ERROR: defrag failed on %s - %s\n",
914 argv[i], strerror(e));
915 defrag_global_errors++;
918 if (defrag_global_verbose)
919 printf("%s\n", BTRFS_BUILD_VERSION);
920 if (defrag_global_errors)
921 fprintf(stderr, "total %d failures\n", defrag_global_errors);
923 return !!defrag_global_errors;
926 static const char * const cmd_resize_usage[] = {
927 "btrfs filesystem resize [devid:][+/-]<newsize>[kKmMgGtTpPeE]|[devid:]max <path>",
928 "Resize a filesystem",
929 "If 'max' is passed, the filesystem will occupy all available space",
930 "on the device 'devid'.",
931 "[kK] means KiB, which denotes 1KiB = 1024B, 1MiB = 1024KiB, etc.",
935 static int cmd_resize(int argc, char **argv)
937 struct btrfs_ioctl_vol_args args;
940 DIR *dirstream = NULL;
942 if (check_argc_exact(argc, 3))
943 usage(cmd_resize_usage);
948 len = strlen(amount);
949 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
950 fprintf(stderr, "ERROR: size value too long ('%s)\n",
955 fd = open_file_or_dir(path, &dirstream);
957 fprintf(stderr, "ERROR: can't access '%s'\n", path);
961 printf("Resize '%s' of '%s'\n", path, amount);
962 strncpy_null(args.name, amount);
963 res = ioctl(fd, BTRFS_IOC_RESIZE, &args);
965 close_file_or_dir(fd, dirstream);
967 fprintf(stderr, "ERROR: unable to resize '%s' - %s\n",
974 static const char * const cmd_label_usage[] = {
975 "btrfs filesystem label [<device>|<mount_point>] [<newlabel>]",
976 "Get or change the label of a filesystem",
977 "With one argument, get the label of filesystem on <device>.",
978 "If <newlabel> is passed, set the filesystem label to <newlabel>.",
982 static int cmd_label(int argc, char **argv)
984 if (check_argc_min(argc, 2) || check_argc_max(argc, 3))
985 usage(cmd_label_usage);
988 return set_label(argv[1], argv[2]);
990 char label[BTRFS_LABEL_SIZE];
993 ret = get_label(argv[1], label);
995 fprintf(stdout, "%s\n", label);
1001 const struct cmd_group filesystem_cmd_group = {
1002 filesystem_cmd_group_usage, NULL, {
1003 { "df", cmd_df, cmd_df_usage, NULL, 0 },
1004 { "show", cmd_show, cmd_show_usage, NULL, 0 },
1005 { "sync", cmd_sync, cmd_sync_usage, NULL, 0 },
1006 { "defragment", cmd_defrag, cmd_defrag_usage, NULL, 0 },
1007 { "balance", cmd_balance, NULL, &balance_cmd_group, 1 },
1008 { "resize", cmd_resize, cmd_resize_usage, NULL, 0 },
1009 { "label", cmd_label, cmd_label_usage, NULL, 0 },
1014 int cmd_filesystem(int argc, char **argv)
1016 return handle_command_group(&filesystem_cmd_group, argc, argv);