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"
43 * for btrfs fi show, we maintain a hash of fsids we've already printed.
44 * This way we don't print dups if a given FS is mounted more than once.
46 #define SEEN_FSID_HASH_SIZE 256
49 u8 fsid[BTRFS_FSID_SIZE];
50 struct seen_fsid *next;
53 static struct seen_fsid *seen_fsid_hash[SEEN_FSID_HASH_SIZE] = {NULL,};
55 static int add_seen_fsid(u8 *fsid)
58 int slot = hash % SEEN_FSID_HASH_SIZE;
59 struct seen_fsid *seen = seen_fsid_hash[slot];
60 struct seen_fsid *alloc;
66 if (memcmp(seen->fsid, fsid, BTRFS_FSID_SIZE) == 0)
77 alloc = malloc(sizeof(*alloc));
82 memcpy(alloc->fsid, fsid, BTRFS_FSID_SIZE);
87 seen_fsid_hash[slot] = alloc;
92 static void free_seen_fsid(void)
95 struct seen_fsid *seen;
96 struct seen_fsid *next;
98 for (slot = 0; slot < SEEN_FSID_HASH_SIZE; slot++) {
99 seen = seen_fsid_hash[slot];
105 seen_fsid_hash[slot] = NULL;
109 static const char * const filesystem_cmd_group_usage[] = {
110 "btrfs filesystem [<group>] <command> [<args>]",
114 static const char * const cmd_df_usage[] = {
115 "btrfs filesystem df <path>",
116 "Show space usage information for a mount point",
120 static char *group_type_str(u64 flag)
122 switch (flag & BTRFS_BLOCK_GROUP_TYPE_MASK) {
123 case BTRFS_BLOCK_GROUP_DATA:
125 case BTRFS_BLOCK_GROUP_SYSTEM:
127 case BTRFS_BLOCK_GROUP_METADATA:
129 case BTRFS_BLOCK_GROUP_DATA|BTRFS_BLOCK_GROUP_METADATA:
130 return "Data+Metadata";
136 static char *group_profile_str(u64 flag)
138 switch (flag & BTRFS_BLOCK_GROUP_PROFILE_MASK) {
141 case BTRFS_BLOCK_GROUP_RAID0:
143 case BTRFS_BLOCK_GROUP_RAID1:
145 case BTRFS_BLOCK_GROUP_RAID5:
147 case BTRFS_BLOCK_GROUP_RAID6:
149 case BTRFS_BLOCK_GROUP_DUP:
151 case BTRFS_BLOCK_GROUP_RAID10:
158 static int get_df(int fd, struct btrfs_ioctl_space_args **sargs_ret)
162 struct btrfs_ioctl_space_args *sargs;
164 sargs = malloc(sizeof(struct btrfs_ioctl_space_args));
168 sargs->space_slots = 0;
169 sargs->total_spaces = 0;
171 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
174 fprintf(stderr, "ERROR: couldn't get space info - %s\n",
179 /* This really should never happen */
180 if (!sargs->total_spaces) {
184 count = sargs->total_spaces;
187 sargs = malloc(sizeof(struct btrfs_ioctl_space_args) +
188 (count * sizeof(struct btrfs_ioctl_space_info)));
192 sargs->space_slots = count;
193 sargs->total_spaces = 0;
194 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
197 fprintf(stderr, "ERROR: get space info count %llu - %s\n",
206 static void print_df(struct btrfs_ioctl_space_args *sargs)
209 struct btrfs_ioctl_space_info *sp = sargs->spaces;
211 for (i = 0; i < sargs->total_spaces; i++, sp++) {
212 printf("%s, %s: total=%s, used=%s\n",
213 group_type_str(sp->flags),
214 group_profile_str(sp->flags),
215 pretty_size(sp->total_bytes),
216 pretty_size(sp->used_bytes));
220 static int cmd_df(int argc, char **argv)
222 struct btrfs_ioctl_space_args *sargs = NULL;
226 DIR *dirstream = NULL;
228 if (check_argc_exact(argc, 2))
233 fd = open_file_or_dir(path, &dirstream);
235 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
238 ret = get_df(fd, &sargs);
244 fprintf(stderr, "ERROR: get_df failed %s\n", strerror(-ret));
247 close_file_or_dir(fd, dirstream);
251 static int match_search_item_kernel(__u8 *fsid, char *mnt, char *label,
254 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
255 int search_len = strlen(search);
257 search_len = min(search_len, BTRFS_UUID_UNPARSED_SIZE);
258 uuid_unparse(fsid, uuidbuf);
259 if (!strncmp(uuidbuf, search, search_len))
262 if (strlen(label) && strcmp(label, search) == 0)
265 if (strcmp(mnt, search) == 0)
271 static int uuid_search(struct btrfs_fs_devices *fs_devices, char *search)
273 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
274 struct list_head *cur;
275 struct btrfs_device *device;
276 int search_len = strlen(search);
278 search_len = min(search_len, BTRFS_UUID_UNPARSED_SIZE);
279 uuid_unparse(fs_devices->fsid, uuidbuf);
280 if (!strncmp(uuidbuf, search, search_len))
283 list_for_each(cur, &fs_devices->devices) {
284 device = list_entry(cur, struct btrfs_device, dev_list);
285 if ((device->label && strcmp(device->label, search) == 0) ||
286 strcmp(device->name, search) == 0)
293 * Sort devices by devid, ascending
295 static int cmp_device_id(void *priv, struct list_head *a,
298 const struct btrfs_device *da = list_entry(a, struct btrfs_device,
300 const struct btrfs_device *db = list_entry(b, struct btrfs_device,
303 return da->devid < db->devid ? -1 :
304 da->devid > db->devid ? 1 : 0;
307 static void print_one_uuid(struct btrfs_fs_devices *fs_devices)
309 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
310 struct list_head *cur;
311 struct btrfs_device *device;
315 if (add_seen_fsid(fs_devices->fsid))
318 uuid_unparse(fs_devices->fsid, uuidbuf);
319 device = list_entry(fs_devices->devices.next, struct btrfs_device,
321 if (device->label && device->label[0])
322 printf("Label: '%s' ", device->label);
324 printf("Label: none ");
327 total = device->total_devs;
328 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
329 (unsigned long long)total,
330 pretty_size(device->super_bytes_used));
332 list_sort(NULL, &fs_devices->devices, cmp_device_id);
333 list_for_each(cur, &fs_devices->devices) {
334 device = list_entry(cur, struct btrfs_device, dev_list);
336 printf("\tdevid %4llu size %s used %s path %s\n",
337 (unsigned long long)device->devid,
338 pretty_size(device->total_bytes),
339 pretty_size(device->bytes_used), device->name);
343 if (devs_found < total) {
344 printf("\t*** Some devices missing\n");
349 /* adds up all the used spaces as reported by the space info ioctl
351 static u64 calc_used_bytes(struct btrfs_ioctl_space_args *si)
355 for (i = 0; i < si->total_spaces; i++)
356 ret += si->spaces[i].used_bytes;
360 static int print_one_fs(struct btrfs_ioctl_fs_info_args *fs_info,
361 struct btrfs_ioctl_dev_info_args *dev_info,
362 struct btrfs_ioctl_space_args *space_info,
363 char *label, char *path)
366 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
367 struct btrfs_ioctl_dev_info_args *tmp_dev_info;
370 ret = add_seen_fsid(fs_info->fsid);
376 uuid_unparse(fs_info->fsid, uuidbuf);
377 if (label && strlen(label))
378 printf("Label: '%s' ", label);
380 printf("Label: none ");
382 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
383 fs_info->num_devices,
384 pretty_size(calc_used_bytes(space_info)));
386 for (i = 0; i < fs_info->num_devices; i++) {
387 tmp_dev_info = (struct btrfs_ioctl_dev_info_args *)&dev_info[i];
388 printf("\tdevid %4llu size %s used %s path %s\n",
390 pretty_size(tmp_dev_info->total_bytes),
391 pretty_size(tmp_dev_info->bytes_used),
399 /* This function checks if the given input parameter is
401 * return -1: some error in the given input
402 * return 0: unknow input
403 * return 1: given input is uuid
404 * return 2: given input is path
406 static int check_arg_type(char *input)
414 if (realpath(input, path)) {
415 if (is_block_device(input) == 1)
416 return BTRFS_ARG_BLKDEV;
418 if (is_mount_point(input) == 1)
419 return BTRFS_ARG_MNTPOINT;
421 return BTRFS_ARG_UNKNOWN;
424 if (strlen(input) == (BTRFS_UUID_UNPARSED_SIZE - 1) &&
425 !uuid_parse(input, out))
426 return BTRFS_ARG_UUID;
428 return BTRFS_ARG_UNKNOWN;
431 static int btrfs_scan_kernel(void *search)
436 struct btrfs_ioctl_fs_info_args fs_info_arg;
437 struct btrfs_ioctl_dev_info_args *dev_info_arg = NULL;
438 struct btrfs_ioctl_space_args *space_info_arg;
439 char label[BTRFS_LABEL_SIZE];
441 f = setmntent("/proc/self/mounts", "r");
445 memset(label, 0, sizeof(label));
446 while ((mnt = getmntent(f)) != NULL) {
447 if (strcmp(mnt->mnt_type, "btrfs"))
449 ret = get_fs_info(mnt->mnt_dir, &fs_info_arg,
454 if (get_label_mounted(mnt->mnt_dir, label)) {
459 if (search && !match_search_item_kernel(fs_info_arg.fsid,
460 mnt->mnt_dir, label, search)) {
465 fd = open(mnt->mnt_dir, O_RDONLY);
466 if ((fd != -1) && !get_df(fd, &space_info_arg)) {
467 print_one_fs(&fs_info_arg, dev_info_arg,
468 space_info_arg, label, mnt->mnt_dir);
469 kfree(space_info_arg);
470 memset(label, 0, sizeof(label));
486 static const char * const cmd_show_usage[] = {
487 "btrfs filesystem show [options] [<path>|<uuid>|<device>|label]",
488 "Show the structure of a filesystem",
489 "-d|--all-devices show only disks under /dev containing btrfs filesystem",
490 "-m|--mounted show only mounted btrfs",
491 "If no argument is given, structure of all present filesystems is shown.",
495 static int cmd_show(int argc, char **argv)
497 struct list_head *all_uuids;
498 struct btrfs_fs_devices *fs_devices;
499 struct list_head *cur_uuid;
502 int where = BTRFS_SCAN_LBLKID;
504 char mp[BTRFS_PATH_NAME_MAX + 1];
509 static struct option long_options[] = {
510 { "all-devices", no_argument, NULL, 'd'},
511 { "mounted", no_argument, NULL, 'm'},
512 { NULL, no_argument, NULL, 0 },
514 int c = getopt_long(argc, argv, "dm", long_options,
520 where = BTRFS_SCAN_DEV;
523 where = BTRFS_SCAN_MOUNTED;
526 usage(cmd_show_usage);
530 if (check_argc_max(argc, optind + 1))
531 usage(cmd_show_usage);
534 search = argv[optind];
535 if (strlen(search) == 0)
536 usage(cmd_show_usage);
537 type = check_arg_type(search);
538 if (type == BTRFS_ARG_BLKDEV) {
539 if (where == BTRFS_SCAN_DEV) {
540 /* we need to do this because
541 * legacy BTRFS_SCAN_DEV
542 * provides /dev/dm-x paths
544 if (realpath(search, path))
547 ret = get_btrfs_mount(search,
550 /* given block dev is mounted*/
558 if (where == BTRFS_SCAN_DEV)
561 /* show mounted btrfs */
562 ret = btrfs_scan_kernel(search);
566 /* shows mounted only */
567 if (where == BTRFS_SCAN_MOUNTED)
571 ret = scan_for_btrfs(where, !BTRFS_UPDATE_KERNEL);
574 fprintf(stderr, "ERROR: %d while scanning\n", ret);
578 all_uuids = btrfs_scanned_uuids();
579 list_for_each(cur_uuid, all_uuids) {
580 fs_devices = list_entry(cur_uuid, struct btrfs_fs_devices,
582 if (search && uuid_search(fs_devices, search) == 0)
585 print_one_uuid(fs_devices);
589 printf("%s\n", BTRFS_BUILD_VERSION);
594 static const char * const cmd_sync_usage[] = {
595 "btrfs filesystem sync <path>",
596 "Force a sync on a filesystem",
600 static int cmd_sync(int argc, char **argv)
604 DIR *dirstream = NULL;
606 if (check_argc_exact(argc, 2))
607 usage(cmd_sync_usage);
611 fd = open_file_or_dir(path, &dirstream);
613 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
617 printf("FSSync '%s'\n", path);
618 res = ioctl(fd, BTRFS_IOC_SYNC);
620 close_file_or_dir(fd, dirstream);
622 fprintf(stderr, "ERROR: unable to fs-syncing '%s' - %s\n",
630 static int parse_compress_type(char *s)
632 if (strcmp(optarg, "zlib") == 0)
633 return BTRFS_COMPRESS_ZLIB;
634 else if (strcmp(optarg, "lzo") == 0)
635 return BTRFS_COMPRESS_LZO;
637 fprintf(stderr, "Unknown compress type %s\n", s);
642 static const char * const cmd_defrag_usage[] = {
643 "btrfs filesystem defragment [options] <file>|<dir> [<file>|<dir>...]",
644 "Defragment a file or a directory",
647 "-r defragment files recursively",
648 "-c[zlib,lzo] compress the file while defragmenting",
649 "-f flush data to disk immediately after defragmenting",
650 "-s start defragment only from byte onward",
651 "-l len defragment only up to len bytes",
652 "-t size minimal size of file to be considered for defragmenting",
656 static int do_defrag(int fd, int fancy_ioctl,
657 struct btrfs_ioctl_defrag_range_args *range)
662 ret = ioctl(fd, BTRFS_IOC_DEFRAG, NULL);
664 ret = ioctl(fd, BTRFS_IOC_DEFRAG_RANGE, range);
669 static int defrag_global_fancy_ioctl;
670 static struct btrfs_ioctl_defrag_range_args defrag_global_range;
671 static int defrag_global_verbose;
672 static int defrag_global_errors;
673 static int defrag_callback(const char *fpath, const struct stat *sb,
674 int typeflag, struct FTW *ftwbuf)
680 if ((typeflag == FTW_F) && S_ISREG(sb->st_mode)) {
681 if (defrag_global_verbose)
682 printf("%s\n", fpath);
683 fd = open(fpath, O_RDWR);
687 ret = do_defrag(fd, defrag_global_fancy_ioctl, &defrag_global_range);
690 if (ret && e == ENOTTY && defrag_global_fancy_ioctl) {
691 fprintf(stderr, "ERROR: defrag range ioctl not "
692 "supported in this kernel, please try "
693 "without any options.\n");
694 defrag_global_errors++;
703 fprintf(stderr, "ERROR: defrag failed on %s - %s\n", fpath, strerror(e));
704 defrag_global_errors++;
708 static int cmd_defrag(int argc, char **argv)
718 struct btrfs_ioctl_defrag_range_args range;
720 int compress_type = BTRFS_COMPRESS_NONE;
723 defrag_global_errors = 0;
724 defrag_global_verbose = 0;
725 defrag_global_errors = 0;
726 defrag_global_fancy_ioctl = 0;
729 int c = getopt(argc, argv, "vrc::fs:l:t:");
735 compress_type = BTRFS_COMPRESS_ZLIB;
737 compress_type = parse_compress_type(optarg);
738 defrag_global_fancy_ioctl = 1;
742 defrag_global_fancy_ioctl = 1;
745 defrag_global_verbose = 1;
748 start = parse_size(optarg);
749 defrag_global_fancy_ioctl = 1;
752 len = parse_size(optarg);
753 defrag_global_fancy_ioctl = 1;
756 thresh = parse_size(optarg);
757 defrag_global_fancy_ioctl = 1;
763 usage(cmd_defrag_usage);
767 if (check_argc_min(argc - optind, 1))
768 usage(cmd_defrag_usage);
770 memset(&defrag_global_range, 0, sizeof(range));
771 defrag_global_range.start = start;
772 defrag_global_range.len = len;
773 defrag_global_range.extent_thresh = thresh;
775 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_COMPRESS;
776 defrag_global_range.compress_type = compress_type;
779 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_START_IO;
781 for (i = optind; i < argc; i++) {
785 fd = open_file_or_dir(argv[i], &dirstream);
787 fprintf(stderr, "ERROR: failed to open %s - %s\n", argv[i],
789 defrag_global_errors++;
790 close_file_or_dir(fd, dirstream);
793 if (fstat(fd, &st)) {
794 fprintf(stderr, "ERROR: failed to stat %s - %s\n",
795 argv[i], strerror(errno));
796 defrag_global_errors++;
797 close_file_or_dir(fd, dirstream);
800 if (!(S_ISDIR(st.st_mode) || S_ISREG(st.st_mode))) {
802 "ERROR: %s is not a directory or a regular file\n",
804 defrag_global_errors++;
805 close_file_or_dir(fd, dirstream);
809 if (S_ISDIR(st.st_mode)) {
810 ret = nftw(argv[i], defrag_callback, 10,
811 FTW_MOUNT | FTW_PHYS);
814 /* errors are handled in the callback */
817 if (defrag_global_verbose)
818 printf("%s\n", argv[i]);
819 ret = do_defrag(fd, defrag_global_fancy_ioctl,
820 &defrag_global_range);
824 if (defrag_global_verbose)
825 printf("%s\n", argv[i]);
826 ret = do_defrag(fd, defrag_global_fancy_ioctl,
827 &defrag_global_range);
830 close_file_or_dir(fd, dirstream);
831 if (ret && e == ENOTTY && defrag_global_fancy_ioctl) {
832 fprintf(stderr, "ERROR: defrag range ioctl not "
833 "supported in this kernel, please try "
834 "without any options.\n");
835 defrag_global_errors++;
839 fprintf(stderr, "ERROR: defrag failed on %s - %s\n",
840 argv[i], strerror(e));
841 defrag_global_errors++;
844 if (defrag_global_verbose)
845 printf("%s\n", BTRFS_BUILD_VERSION);
846 if (defrag_global_errors)
847 fprintf(stderr, "total %d failures\n", defrag_global_errors);
849 return !!defrag_global_errors;
852 static const char * const cmd_resize_usage[] = {
853 "btrfs filesystem resize [devid:][+/-]<newsize>[gkm]|[devid:]max <path>",
854 "Resize a filesystem",
855 "If 'max' is passed, the filesystem will occupy all available space",
856 "on the device 'devid'.",
860 static int cmd_resize(int argc, char **argv)
862 struct btrfs_ioctl_vol_args args;
865 DIR *dirstream = NULL;
867 if (check_argc_exact(argc, 3))
868 usage(cmd_resize_usage);
873 len = strlen(amount);
874 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
875 fprintf(stderr, "ERROR: size value too long ('%s)\n",
880 fd = open_file_or_dir(path, &dirstream);
882 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
886 printf("Resize '%s' of '%s'\n", path, amount);
887 strncpy_null(args.name, amount);
888 res = ioctl(fd, BTRFS_IOC_RESIZE, &args);
890 close_file_or_dir(fd, dirstream);
892 fprintf(stderr, "ERROR: unable to resize '%s' - %s\n",
899 static const char * const cmd_label_usage[] = {
900 "btrfs filesystem label [<device>|<mount_point>] [<newlabel>]",
901 "Get or change the label of a filesystem",
902 "With one argument, get the label of filesystem on <device>.",
903 "If <newlabel> is passed, set the filesystem label to <newlabel>.",
907 static int cmd_label(int argc, char **argv)
909 if (check_argc_min(argc, 2) || check_argc_max(argc, 3))
910 usage(cmd_label_usage);
913 return set_label(argv[1], argv[2]);
915 char label[BTRFS_LABEL_SIZE];
918 ret = get_label(argv[1], label);
920 fprintf(stdout, "%s\n", label);
926 const struct cmd_group filesystem_cmd_group = {
927 filesystem_cmd_group_usage, NULL, {
928 { "df", cmd_df, cmd_df_usage, NULL, 0 },
929 { "show", cmd_show, cmd_show_usage, NULL, 0 },
930 { "sync", cmd_sync, cmd_sync_usage, NULL, 0 },
931 { "defragment", cmd_defrag, cmd_defrag_usage, NULL, 0 },
932 { "balance", cmd_balance, NULL, &balance_cmd_group, 1 },
933 { "resize", cmd_resize, cmd_resize_usage, NULL, 0 },
934 { "label", cmd_label, cmd_label_usage, NULL, 0 },
939 int cmd_filesystem(int argc, char **argv)
941 return handle_command_group(&filesystem_cmd_group, argc, argv);