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)
367 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
368 struct btrfs_ioctl_dev_info_args *tmp_dev_info;
371 ret = add_seen_fsid(fs_info->fsid);
377 uuid_unparse(fs_info->fsid, uuidbuf);
378 if (label && strlen(label))
379 printf("Label: '%s' ", label);
381 printf("Label: none ");
383 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
384 fs_info->num_devices,
385 pretty_size(calc_used_bytes(space_info)));
387 for (i = 0; i < fs_info->num_devices; i++) {
388 tmp_dev_info = (struct btrfs_ioctl_dev_info_args *)&dev_info[i];
389 printf("\tdevid %4llu size %s used %s path %s\n",
391 pretty_size(tmp_dev_info->total_bytes),
392 pretty_size(tmp_dev_info->bytes_used),
400 /* This function checks if the given input parameter is
402 * return -1: some error in the given input
403 * return 0: unknow input
404 * return 1: given input is uuid
405 * return 2: given input is path
407 static int check_arg_type(char *input)
415 if (realpath(input, path)) {
416 if (is_block_device(input) == 1)
417 return BTRFS_ARG_BLKDEV;
419 if (is_mount_point(input) == 1)
420 return BTRFS_ARG_MNTPOINT;
422 return BTRFS_ARG_UNKNOWN;
425 if (strlen(input) == (BTRFS_UUID_UNPARSED_SIZE - 1) &&
426 !uuid_parse(input, out))
427 return BTRFS_ARG_UUID;
429 return BTRFS_ARG_UNKNOWN;
432 static int btrfs_scan_kernel(void *search)
437 struct btrfs_ioctl_fs_info_args fs_info_arg;
438 struct btrfs_ioctl_dev_info_args *dev_info_arg = NULL;
439 struct btrfs_ioctl_space_args *space_info_arg;
440 char label[BTRFS_LABEL_SIZE];
442 f = setmntent("/proc/self/mounts", "r");
446 memset(label, 0, sizeof(label));
447 while ((mnt = getmntent(f)) != NULL) {
448 if (strcmp(mnt->mnt_type, "btrfs"))
450 ret = get_fs_info(mnt->mnt_dir, &fs_info_arg,
455 if (get_label_mounted(mnt->mnt_dir, label)) {
460 if (search && !match_search_item_kernel(fs_info_arg.fsid,
461 mnt->mnt_dir, label, search)) {
466 fd = open(mnt->mnt_dir, O_RDONLY);
467 if ((fd != -1) && !get_df(fd, &space_info_arg)) {
468 print_one_fs(&fs_info_arg, dev_info_arg,
469 space_info_arg, label, mnt->mnt_dir);
470 kfree(space_info_arg);
471 memset(label, 0, sizeof(label));
487 static int dev_to_fsid(char *dev, __u8 *fsid)
489 struct btrfs_super_block *disk_super;
498 fd = open(dev, O_RDONLY);
505 disk_super = (struct btrfs_super_block *)buf;
506 ret = btrfs_read_dev_super(fd, disk_super,
507 BTRFS_SUPER_INFO_OFFSET);
511 memcpy(fsid, disk_super->fsid, BTRFS_FSID_SIZE);
520 static const char * const cmd_show_usage[] = {
521 "btrfs filesystem show [options] [<path>|<uuid>|<device>|label]",
522 "Show the structure of a filesystem",
523 "-d|--all-devices show only disks under /dev containing btrfs filesystem",
524 "-m|--mounted show only mounted btrfs",
525 "If no argument is given, structure of all present filesystems is shown.",
529 static int cmd_show(int argc, char **argv)
531 struct list_head *all_uuids;
532 struct btrfs_fs_devices *fs_devices;
533 struct list_head *cur_uuid;
536 int where = BTRFS_SCAN_LBLKID;
538 char mp[BTRFS_PATH_NAME_MAX + 1];
540 __u8 fsid[BTRFS_FSID_SIZE];
545 static struct option long_options[] = {
546 { "all-devices", no_argument, NULL, 'd'},
547 { "mounted", no_argument, NULL, 'm'},
548 { NULL, no_argument, NULL, 0 },
550 int c = getopt_long(argc, argv, "dm", long_options,
556 where = BTRFS_SCAN_DEV;
559 where = BTRFS_SCAN_MOUNTED;
562 usage(cmd_show_usage);
566 if (check_argc_max(argc, optind + 1))
567 usage(cmd_show_usage);
570 search = argv[optind];
571 if (strlen(search) == 0)
572 usage(cmd_show_usage);
573 type = check_arg_type(search);
575 * needs spl handling if input arg is block dev
576 * And if input arg is mount-point just print it
579 if (type == BTRFS_ARG_BLKDEV) {
580 if (where == BTRFS_SCAN_DEV) {
581 /* we need to do this because
582 * legacy BTRFS_SCAN_DEV
583 * provides /dev/dm-x paths
585 if (realpath(search, path))
588 ret = get_btrfs_mount(search,
591 /* given block dev is mounted*/
593 type = BTRFS_ARG_MNTPOINT;
595 ret = dev_to_fsid(search, fsid);
598 "ERROR: No btrfs on %s\n",
602 uuid_unparse(fsid, uuid_buf);
604 type = BTRFS_ARG_UUID;
611 if (where == BTRFS_SCAN_DEV)
614 /* show mounted btrfs */
615 ret = btrfs_scan_kernel(search);
619 /* shows mounted only */
620 if (where == BTRFS_SCAN_MOUNTED)
624 ret = scan_for_btrfs(where, !BTRFS_UPDATE_KERNEL);
627 fprintf(stderr, "ERROR: %d while scanning\n", ret);
631 all_uuids = btrfs_scanned_uuids();
632 list_for_each(cur_uuid, all_uuids) {
633 fs_devices = list_entry(cur_uuid, struct btrfs_fs_devices,
635 if (search && uuid_search(fs_devices, search) == 0)
638 print_one_uuid(fs_devices);
642 printf("%s\n", BTRFS_BUILD_VERSION);
647 static const char * const cmd_sync_usage[] = {
648 "btrfs filesystem sync <path>",
649 "Force a sync on a filesystem",
653 static int cmd_sync(int argc, char **argv)
657 DIR *dirstream = NULL;
659 if (check_argc_exact(argc, 2))
660 usage(cmd_sync_usage);
664 fd = open_file_or_dir(path, &dirstream);
666 fprintf(stderr, "ERROR: can't access '%s'\n", path);
670 printf("FSSync '%s'\n", path);
671 res = ioctl(fd, BTRFS_IOC_SYNC);
673 close_file_or_dir(fd, dirstream);
675 fprintf(stderr, "ERROR: unable to fs-syncing '%s' - %s\n",
683 static int parse_compress_type(char *s)
685 if (strcmp(optarg, "zlib") == 0)
686 return BTRFS_COMPRESS_ZLIB;
687 else if (strcmp(optarg, "lzo") == 0)
688 return BTRFS_COMPRESS_LZO;
690 fprintf(stderr, "Unknown compress type %s\n", s);
695 static const char * const cmd_defrag_usage[] = {
696 "btrfs filesystem defragment [options] <file>|<dir> [<file>|<dir>...]",
697 "Defragment a file or a directory",
700 "-r defragment files recursively",
701 "-c[zlib,lzo] compress the file while defragmenting",
702 "-f flush data to disk immediately after defragmenting",
703 "-s start defragment only from byte onward",
704 "-l len defragment only up to len bytes",
705 "-t size minimal size of file to be considered for defragmenting",
709 static int do_defrag(int fd, int fancy_ioctl,
710 struct btrfs_ioctl_defrag_range_args *range)
715 ret = ioctl(fd, BTRFS_IOC_DEFRAG, NULL);
717 ret = ioctl(fd, BTRFS_IOC_DEFRAG_RANGE, range);
722 static int defrag_global_fancy_ioctl;
723 static struct btrfs_ioctl_defrag_range_args defrag_global_range;
724 static int defrag_global_verbose;
725 static int defrag_global_errors;
726 static int defrag_callback(const char *fpath, const struct stat *sb,
727 int typeflag, struct FTW *ftwbuf)
733 if ((typeflag == FTW_F) && S_ISREG(sb->st_mode)) {
734 if (defrag_global_verbose)
735 printf("%s\n", fpath);
736 fd = open(fpath, O_RDWR);
740 ret = do_defrag(fd, defrag_global_fancy_ioctl, &defrag_global_range);
743 if (ret && e == ENOTTY && defrag_global_fancy_ioctl) {
744 fprintf(stderr, "ERROR: defrag range ioctl not "
745 "supported in this kernel, please try "
746 "without any options.\n");
747 defrag_global_errors++;
756 fprintf(stderr, "ERROR: defrag failed on %s - %s\n", fpath, strerror(e));
757 defrag_global_errors++;
761 static int cmd_defrag(int argc, char **argv)
771 struct btrfs_ioctl_defrag_range_args range;
773 int compress_type = BTRFS_COMPRESS_NONE;
776 defrag_global_errors = 0;
777 defrag_global_verbose = 0;
778 defrag_global_errors = 0;
779 defrag_global_fancy_ioctl = 0;
782 int c = getopt(argc, argv, "vrc::fs:l:t:");
788 compress_type = BTRFS_COMPRESS_ZLIB;
790 compress_type = parse_compress_type(optarg);
791 defrag_global_fancy_ioctl = 1;
795 defrag_global_fancy_ioctl = 1;
798 defrag_global_verbose = 1;
801 start = parse_size(optarg);
802 defrag_global_fancy_ioctl = 1;
805 len = parse_size(optarg);
806 defrag_global_fancy_ioctl = 1;
809 thresh = parse_size(optarg);
810 defrag_global_fancy_ioctl = 1;
816 usage(cmd_defrag_usage);
820 if (check_argc_min(argc - optind, 1))
821 usage(cmd_defrag_usage);
823 memset(&defrag_global_range, 0, sizeof(range));
824 defrag_global_range.start = start;
825 defrag_global_range.len = len;
826 defrag_global_range.extent_thresh = thresh;
828 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_COMPRESS;
829 defrag_global_range.compress_type = compress_type;
832 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_START_IO;
834 for (i = optind; i < argc; i++) {
838 fd = open_file_or_dir(argv[i], &dirstream);
840 fprintf(stderr, "ERROR: failed to open %s - %s\n", argv[i],
842 defrag_global_errors++;
843 close_file_or_dir(fd, dirstream);
846 if (fstat(fd, &st)) {
847 fprintf(stderr, "ERROR: failed to stat %s - %s\n",
848 argv[i], strerror(errno));
849 defrag_global_errors++;
850 close_file_or_dir(fd, dirstream);
853 if (!(S_ISDIR(st.st_mode) || S_ISREG(st.st_mode))) {
855 "ERROR: %s is not a directory or a regular file\n",
857 defrag_global_errors++;
858 close_file_or_dir(fd, dirstream);
862 if (S_ISDIR(st.st_mode)) {
863 ret = nftw(argv[i], defrag_callback, 10,
864 FTW_MOUNT | FTW_PHYS);
867 /* errors are handled in the callback */
870 if (defrag_global_verbose)
871 printf("%s\n", argv[i]);
872 ret = do_defrag(fd, defrag_global_fancy_ioctl,
873 &defrag_global_range);
877 if (defrag_global_verbose)
878 printf("%s\n", argv[i]);
879 ret = do_defrag(fd, defrag_global_fancy_ioctl,
880 &defrag_global_range);
883 close_file_or_dir(fd, dirstream);
884 if (ret && e == ENOTTY && defrag_global_fancy_ioctl) {
885 fprintf(stderr, "ERROR: defrag range ioctl not "
886 "supported in this kernel, please try "
887 "without any options.\n");
888 defrag_global_errors++;
892 fprintf(stderr, "ERROR: defrag failed on %s - %s\n",
893 argv[i], strerror(e));
894 defrag_global_errors++;
897 if (defrag_global_verbose)
898 printf("%s\n", BTRFS_BUILD_VERSION);
899 if (defrag_global_errors)
900 fprintf(stderr, "total %d failures\n", defrag_global_errors);
902 return !!defrag_global_errors;
905 static const char * const cmd_resize_usage[] = {
906 "btrfs filesystem resize [devid:][+/-]<newsize>[gkm]|[devid:]max <path>",
907 "Resize a filesystem",
908 "If 'max' is passed, the filesystem will occupy all available space",
909 "on the device 'devid'.",
913 static int cmd_resize(int argc, char **argv)
915 struct btrfs_ioctl_vol_args args;
918 DIR *dirstream = NULL;
920 if (check_argc_exact(argc, 3))
921 usage(cmd_resize_usage);
926 len = strlen(amount);
927 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
928 fprintf(stderr, "ERROR: size value too long ('%s)\n",
933 fd = open_file_or_dir(path, &dirstream);
935 fprintf(stderr, "ERROR: can't access '%s'\n", path);
939 printf("Resize '%s' of '%s'\n", path, amount);
940 strncpy_null(args.name, amount);
941 res = ioctl(fd, BTRFS_IOC_RESIZE, &args);
943 close_file_or_dir(fd, dirstream);
945 fprintf(stderr, "ERROR: unable to resize '%s' - %s\n",
952 static const char * const cmd_label_usage[] = {
953 "btrfs filesystem label [<device>|<mount_point>] [<newlabel>]",
954 "Get or change the label of a filesystem",
955 "With one argument, get the label of filesystem on <device>.",
956 "If <newlabel> is passed, set the filesystem label to <newlabel>.",
960 static int cmd_label(int argc, char **argv)
962 if (check_argc_min(argc, 2) || check_argc_max(argc, 3))
963 usage(cmd_label_usage);
966 return set_label(argv[1], argv[2]);
968 char label[BTRFS_LABEL_SIZE];
971 ret = get_label(argv[1], label);
973 fprintf(stdout, "%s\n", label);
979 const struct cmd_group filesystem_cmd_group = {
980 filesystem_cmd_group_usage, NULL, {
981 { "df", cmd_df, cmd_df_usage, NULL, 0 },
982 { "show", cmd_show, cmd_show_usage, NULL, 0 },
983 { "sync", cmd_sync, cmd_sync_usage, NULL, 0 },
984 { "defragment", cmd_defrag, cmd_defrag_usage, NULL, 0 },
985 { "balance", cmd_balance, NULL, &balance_cmd_group, 1 },
986 { "resize", cmd_resize, cmd_resize_usage, NULL, 0 },
987 { "label", cmd_label, cmd_label_usage, NULL, 0 },
992 int cmd_filesystem(int argc, char **argv)
994 return handle_command_group(&filesystem_cmd_group, argc, argv);