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 uuid_search(struct btrfs_fs_devices *fs_devices, char *search)
254 struct list_head *cur;
255 struct btrfs_device *device;
256 int search_len = strlen(search);
258 search_len = min(search_len, 37);
259 uuid_unparse(fs_devices->fsid, uuidbuf);
260 if (!strncmp(uuidbuf, search, search_len))
263 list_for_each(cur, &fs_devices->devices) {
264 device = list_entry(cur, struct btrfs_device, dev_list);
265 if ((device->label && strcmp(device->label, search) == 0) ||
266 strcmp(device->name, search) == 0)
273 * Sort devices by devid, ascending
275 static int cmp_device_id(void *priv, struct list_head *a,
278 const struct btrfs_device *da = list_entry(a, struct btrfs_device,
280 const struct btrfs_device *db = list_entry(b, struct btrfs_device,
283 return da->devid < db->devid ? -1 :
284 da->devid > db->devid ? 1 : 0;
287 static void print_one_uuid(struct btrfs_fs_devices *fs_devices)
290 struct list_head *cur;
291 struct btrfs_device *device;
295 if (add_seen_fsid(fs_devices->fsid))
298 uuid_unparse(fs_devices->fsid, uuidbuf);
299 device = list_entry(fs_devices->devices.next, struct btrfs_device,
301 if (device->label && device->label[0])
302 printf("Label: '%s' ", device->label);
304 printf("Label: none ");
307 total = device->total_devs;
308 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
309 (unsigned long long)total,
310 pretty_size(device->super_bytes_used));
312 list_sort(NULL, &fs_devices->devices, cmp_device_id);
313 list_for_each(cur, &fs_devices->devices) {
314 device = list_entry(cur, struct btrfs_device, dev_list);
316 printf("\tdevid %4llu size %s used %s path %s\n",
317 (unsigned long long)device->devid,
318 pretty_size(device->total_bytes),
319 pretty_size(device->bytes_used), device->name);
323 if (devs_found < total) {
324 printf("\t*** Some devices missing\n");
329 /* adds up all the used spaces as reported by the space info ioctl
331 static u64 calc_used_bytes(struct btrfs_ioctl_space_args *si)
335 for (i = 0; i < si->total_spaces; i++)
336 ret += si->spaces[i].used_bytes;
340 static int print_one_fs(struct btrfs_ioctl_fs_info_args *fs_info,
341 struct btrfs_ioctl_dev_info_args *dev_info,
342 struct btrfs_ioctl_space_args *space_info,
343 char *label, char *path)
347 struct btrfs_ioctl_dev_info_args *tmp_dev_info;
350 ret = add_seen_fsid(fs_info->fsid);
356 uuid_unparse(fs_info->fsid, uuidbuf);
357 printf("Label: %s uuid: %s\n",
358 strlen(label) ? label : "none", uuidbuf);
360 printf("\tTotal devices %llu FS bytes used %s\n",
361 fs_info->num_devices,
362 pretty_size(calc_used_bytes(space_info)));
364 for (i = 0; i < fs_info->num_devices; i++) {
365 tmp_dev_info = (struct btrfs_ioctl_dev_info_args *)&dev_info[i];
366 printf("\tdevid %llu size %s used %s path %s\n",
368 pretty_size(tmp_dev_info->total_bytes),
369 pretty_size(tmp_dev_info->bytes_used),
377 /* This function checks if the given input parameter is
379 * return -1: some error in the given input
380 * return 0: unknow input
381 * return 1: given input is uuid
382 * return 2: given input is path
384 static int check_arg_type(char *input)
390 return BTRFS_ARG_UNKNOWN;
392 if (realpath(input, path)) {
393 if (is_block_device(input) == 1)
394 return BTRFS_ARG_BLKDEV;
396 if (is_mount_point(input) == 1)
397 return BTRFS_ARG_MNTPOINT;
399 return BTRFS_ARG_UNKNOWN;
402 if (!uuid_parse(input, out))
403 return BTRFS_ARG_UUID;
405 return BTRFS_ARG_UNKNOWN;
408 static int btrfs_scan_kernel(void *search)
410 int ret = 0, fd, type;
413 struct btrfs_ioctl_fs_info_args fs_info_arg;
414 struct btrfs_ioctl_dev_info_args *dev_info_arg = NULL;
415 struct btrfs_ioctl_space_args *space_info_arg;
416 char label[BTRFS_LABEL_SIZE];
419 f = setmntent("/proc/self/mounts", "r");
423 type = check_arg_type(search);
424 if (type == BTRFS_ARG_BLKDEV)
427 while ((mnt = getmntent(f)) != NULL) {
428 if (strcmp(mnt->mnt_type, "btrfs"))
430 ret = get_fs_info(mnt->mnt_dir, &fs_info_arg,
437 ret = uuid_parse(search, uuid);
440 if (uuid_compare(fs_info_arg.fsid, uuid))
443 case BTRFS_ARG_MNTPOINT:
444 if (strcmp(search, mnt->mnt_dir))
447 case BTRFS_ARG_UNKNOWN:
451 fd = open(mnt->mnt_dir, O_RDONLY);
452 if ((fd != -1) && !get_df(fd, &space_info_arg)) {
453 get_label_mounted(mnt->mnt_dir, label);
454 print_one_fs(&fs_info_arg, dev_info_arg,
455 space_info_arg, label, mnt->mnt_dir);
456 free(space_info_arg);
465 static const char * const cmd_show_usage[] = {
466 "btrfs filesystem show [options|<path>|<uuid>]",
467 "Show the structure of a filesystem",
468 "-d|--all-devices show only disks under /dev containing btrfs filesystem",
469 "-m|--mounted show only mounted btrfs",
470 "If no argument is given, structure of all present filesystems is shown.",
474 static int cmd_show(int argc, char **argv)
476 struct list_head *all_uuids;
477 struct btrfs_fs_devices *fs_devices;
478 struct list_head *cur_uuid;
481 int where = BTRFS_SCAN_LBLKID;
483 char mp[BTRFS_PATH_NAME_MAX + 1];
487 static struct option long_options[] = {
488 { "all-devices", no_argument, NULL, 'd'},
489 { "mounted", no_argument, NULL, 'm'},
490 { NULL, no_argument, NULL, 0 },
492 int c = getopt_long(argc, argv, "dm", long_options,
498 where = BTRFS_SCAN_DEV;
501 where = BTRFS_SCAN_MOUNTED;
504 usage(cmd_show_usage);
508 if (where == BTRFS_SCAN_LBLKID) {
509 if (check_argc_max(argc, optind + 1))
510 usage(cmd_show_usage);
512 if (check_argc_max(argc, optind))
513 usage(cmd_show_usage);
516 search = argv[optind];
517 type = check_arg_type(search);
518 if (type == BTRFS_ARG_UNKNOWN) {
519 fprintf(stderr, "ERROR: arg type unknown\n");
520 usage(cmd_show_usage);
522 if (type == BTRFS_ARG_BLKDEV) {
523 ret = get_btrfs_mount(search, mp, sizeof(mp));
529 if (where == BTRFS_SCAN_DEV)
532 /* show mounted btrfs */
533 btrfs_scan_kernel(search);
535 /* shows mounted only */
536 if (where == BTRFS_SCAN_MOUNTED)
540 ret = scan_for_btrfs(where, !BTRFS_UPDATE_KERNEL);
543 fprintf(stderr, "ERROR: %d while scanning\n", ret);
547 all_uuids = btrfs_scanned_uuids();
548 list_for_each(cur_uuid, all_uuids) {
549 fs_devices = list_entry(cur_uuid, struct btrfs_fs_devices,
551 if (search && uuid_search(fs_devices, search) == 0)
554 print_one_uuid(fs_devices);
558 printf("%s\n", BTRFS_BUILD_VERSION);
563 static const char * const cmd_sync_usage[] = {
564 "btrfs filesystem sync <path>",
565 "Force a sync on a filesystem",
569 static int cmd_sync(int argc, char **argv)
573 DIR *dirstream = NULL;
575 if (check_argc_exact(argc, 2))
576 usage(cmd_sync_usage);
580 fd = open_file_or_dir(path, &dirstream);
582 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
586 printf("FSSync '%s'\n", path);
587 res = ioctl(fd, BTRFS_IOC_SYNC);
589 close_file_or_dir(fd, dirstream);
591 fprintf(stderr, "ERROR: unable to fs-syncing '%s' - %s\n",
599 static int parse_compress_type(char *s)
601 if (strcmp(optarg, "zlib") == 0)
602 return BTRFS_COMPRESS_ZLIB;
603 else if (strcmp(optarg, "lzo") == 0)
604 return BTRFS_COMPRESS_LZO;
606 fprintf(stderr, "Unknown compress type %s\n", s);
611 static const char * const cmd_defrag_usage[] = {
612 "btrfs filesystem defragment [options] <file>|<dir> [<file>|<dir>...]",
613 "Defragment a file or a directory",
616 "-r defragment files recursively",
617 "-c[zlib,lzo] compress the file while defragmenting",
618 "-f flush data to disk immediately after defragmenting",
619 "-s start defragment only from byte onward",
620 "-l len defragment only up to len bytes",
621 "-t size minimal size of file to be considered for defragmenting",
625 static int do_defrag(int fd, int fancy_ioctl,
626 struct btrfs_ioctl_defrag_range_args *range)
631 ret = ioctl(fd, BTRFS_IOC_DEFRAG, NULL);
633 ret = ioctl(fd, BTRFS_IOC_DEFRAG_RANGE, range);
638 static int defrag_global_fancy_ioctl;
639 static struct btrfs_ioctl_defrag_range_args defrag_global_range;
640 static int defrag_global_verbose;
641 static int defrag_global_errors;
642 static int defrag_callback(const char *fpath, const struct stat *sb,
643 int typeflag, struct FTW *ftwbuf)
649 if (typeflag == FTW_F) {
650 if (defrag_global_verbose)
651 printf("%s\n", fpath);
652 fd = open(fpath, O_RDWR);
656 ret = do_defrag(fd, defrag_global_fancy_ioctl, &defrag_global_range);
659 if (ret && e == ENOTTY) {
660 fprintf(stderr, "ERROR: defrag range ioctl not "
661 "supported in this kernel, please try "
662 "without any options.\n");
663 defrag_global_errors++;
672 fprintf(stderr, "ERROR: defrag failed on %s - %s\n", fpath, strerror(e));
673 defrag_global_errors++;
677 static int cmd_defrag(int argc, char **argv)
687 struct btrfs_ioctl_defrag_range_args range;
689 int compress_type = BTRFS_COMPRESS_NONE;
692 defrag_global_errors = 0;
693 defrag_global_verbose = 0;
694 defrag_global_errors = 0;
695 defrag_global_fancy_ioctl = 0;
698 int c = getopt(argc, argv, "vrc::fs:l:t:");
704 compress_type = BTRFS_COMPRESS_ZLIB;
706 compress_type = parse_compress_type(optarg);
707 defrag_global_fancy_ioctl = 1;
711 defrag_global_fancy_ioctl = 1;
714 defrag_global_verbose = 1;
717 start = parse_size(optarg);
718 defrag_global_fancy_ioctl = 1;
721 len = parse_size(optarg);
722 defrag_global_fancy_ioctl = 1;
725 thresh = parse_size(optarg);
726 defrag_global_fancy_ioctl = 1;
732 usage(cmd_defrag_usage);
736 if (check_argc_min(argc - optind, 1))
737 usage(cmd_defrag_usage);
739 memset(&defrag_global_range, 0, sizeof(range));
740 defrag_global_range.start = start;
741 defrag_global_range.len = len;
742 defrag_global_range.extent_thresh = thresh;
744 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_COMPRESS;
745 defrag_global_range.compress_type = compress_type;
748 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_START_IO;
750 for (i = optind; i < argc; i++) {
752 fd = open_file_or_dir(argv[i], &dirstream);
754 fprintf(stderr, "ERROR: failed to open %s - %s\n", argv[i],
756 defrag_global_errors++;
757 close_file_or_dir(fd, dirstream);
763 if (fstat(fd, &st)) {
764 fprintf(stderr, "ERROR: failed to stat %s - %s\n",
765 argv[i], strerror(errno));
766 defrag_global_errors++;
767 close_file_or_dir(fd, dirstream);
770 if (S_ISDIR(st.st_mode)) {
771 ret = nftw(argv[i], defrag_callback, 10,
772 FTW_MOUNT | FTW_PHYS);
775 /* errors are handled in the callback */
778 if (defrag_global_verbose)
779 printf("%s\n", argv[i]);
780 ret = do_defrag(fd, defrag_global_fancy_ioctl,
781 &defrag_global_range);
785 if (defrag_global_verbose)
786 printf("%s\n", argv[i]);
787 ret = do_defrag(fd, defrag_global_fancy_ioctl,
788 &defrag_global_range);
791 close_file_or_dir(fd, dirstream);
792 if (ret && e == ENOTTY) {
793 fprintf(stderr, "ERROR: defrag range ioctl not "
794 "supported in this kernel, please try "
795 "without any options.\n");
796 defrag_global_errors++;
800 fprintf(stderr, "ERROR: defrag failed on %s - %s\n",
801 argv[i], strerror(e));
802 defrag_global_errors++;
805 if (defrag_global_verbose)
806 printf("%s\n", BTRFS_BUILD_VERSION);
807 if (defrag_global_errors)
808 fprintf(stderr, "total %d failures\n", defrag_global_errors);
810 return !!defrag_global_errors;
813 static const char * const cmd_resize_usage[] = {
814 "btrfs filesystem resize [devid:][+/-]<newsize>[gkm]|[devid:]max <path>",
815 "Resize a filesystem",
816 "If 'max' is passed, the filesystem will occupy all available space",
817 "on the device 'devid'.",
821 static int cmd_resize(int argc, char **argv)
823 struct btrfs_ioctl_vol_args args;
826 DIR *dirstream = NULL;
828 if (check_argc_exact(argc, 3))
829 usage(cmd_resize_usage);
834 len = strlen(amount);
835 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
836 fprintf(stderr, "ERROR: size value too long ('%s)\n",
841 fd = open_file_or_dir(path, &dirstream);
843 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
847 printf("Resize '%s' of '%s'\n", path, amount);
848 strncpy_null(args.name, amount);
849 res = ioctl(fd, BTRFS_IOC_RESIZE, &args);
851 close_file_or_dir(fd, dirstream);
853 fprintf(stderr, "ERROR: unable to resize '%s' - %s\n",
860 static const char * const cmd_label_usage[] = {
861 "btrfs filesystem label [<device>|<mount_point>] [<newlabel>]",
862 "Get or change the label of a filesystem",
863 "With one argument, get the label of filesystem on <device>.",
864 "If <newlabel> is passed, set the filesystem label to <newlabel>.",
868 static int cmd_label(int argc, char **argv)
870 if (check_argc_min(argc, 2) || check_argc_max(argc, 3))
871 usage(cmd_label_usage);
874 return set_label(argv[1], argv[2]);
876 return get_label(argv[1]);
879 const struct cmd_group filesystem_cmd_group = {
880 filesystem_cmd_group_usage, NULL, {
881 { "df", cmd_df, cmd_df_usage, NULL, 0 },
882 { "show", cmd_show, cmd_show_usage, NULL, 0 },
883 { "sync", cmd_sync, cmd_sync_usage, NULL, 0 },
884 { "defragment", cmd_defrag, cmd_defrag_usage, NULL, 0 },
885 { "balance", cmd_balance, NULL, &balance_cmd_group, 1 },
886 { "resize", cmd_resize, cmd_resize_usage, NULL, 0 },
887 { "label", cmd_label, cmd_label_usage, NULL, 0 },
892 int cmd_filesystem(int argc, char **argv)
894 return handle_command_group(&filesystem_cmd_group, argc, argv);