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 /* This really should never happen */
112 if (!sargs->total_spaces) {
116 count = sargs->total_spaces;
119 sargs = malloc(sizeof(struct btrfs_ioctl_space_args) +
120 (count * sizeof(struct btrfs_ioctl_space_info)));
124 sargs->space_slots = count;
125 sargs->total_spaces = 0;
126 ret = ioctl(fd, BTRFS_IOC_SPACE_INFO, sargs);
129 fprintf(stderr, "ERROR: get space info count %llu - %s\n",
138 static void print_df(struct btrfs_ioctl_space_args *sargs)
141 struct btrfs_ioctl_space_info *sp = sargs->spaces;
143 for (i = 0; i < sargs->total_spaces; i++, sp++) {
144 printf("%s, %s: total=%s, used=%s\n",
145 group_type_str(sp->flags),
146 group_profile_str(sp->flags),
147 pretty_size(sp->total_bytes),
148 pretty_size(sp->used_bytes));
152 static int cmd_df(int argc, char **argv)
154 struct btrfs_ioctl_space_args *sargs = NULL;
158 DIR *dirstream = NULL;
160 if (check_argc_exact(argc, 2))
165 fd = open_file_or_dir(path, &dirstream);
167 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
170 ret = get_df(fd, &sargs);
176 fprintf(stderr, "ERROR: get_df failed %s\n", strerror(ret));
179 close_file_or_dir(fd, dirstream);
183 static int uuid_search(struct btrfs_fs_devices *fs_devices, char *search)
186 struct list_head *cur;
187 struct btrfs_device *device;
188 int search_len = strlen(search);
190 search_len = min(search_len, 37);
191 uuid_unparse(fs_devices->fsid, uuidbuf);
192 if (!strncmp(uuidbuf, search, search_len))
195 list_for_each(cur, &fs_devices->devices) {
196 device = list_entry(cur, struct btrfs_device, dev_list);
197 if ((device->label && strcmp(device->label, search) == 0) ||
198 strcmp(device->name, search) == 0)
205 * Sort devices by devid, ascending
207 static int cmp_device_id(void *priv, struct list_head *a,
210 const struct btrfs_device *da = list_entry(a, struct btrfs_device,
212 const struct btrfs_device *db = list_entry(b, struct btrfs_device,
215 return da->devid < db->devid ? -1 :
216 da->devid > db->devid ? 1 : 0;
219 static void print_one_uuid(struct btrfs_fs_devices *fs_devices)
222 struct list_head *cur;
223 struct btrfs_device *device;
227 uuid_unparse(fs_devices->fsid, uuidbuf);
228 device = list_entry(fs_devices->devices.next, struct btrfs_device,
230 if (device->label && device->label[0])
231 printf("Label: '%s' ", device->label);
233 printf("Label: none ");
236 total = device->total_devs;
237 printf(" uuid: %s\n\tTotal devices %llu FS bytes used %s\n", uuidbuf,
238 (unsigned long long)total,
239 pretty_size(device->super_bytes_used));
241 list_sort(NULL, &fs_devices->devices, cmp_device_id);
242 list_for_each(cur, &fs_devices->devices) {
243 device = list_entry(cur, struct btrfs_device, dev_list);
245 printf("\tdevid %4llu size %s used %s path %s\n",
246 (unsigned long long)device->devid,
247 pretty_size(device->total_bytes),
248 pretty_size(device->bytes_used), device->name);
252 if (devs_found < total) {
253 printf("\t*** Some devices missing\n");
258 /* adds up all the used spaces as reported by the space info ioctl
260 static u64 calc_used_bytes(struct btrfs_ioctl_space_args *si)
264 for (i = 0; i < si->total_spaces; i++)
265 ret += si->spaces[i].used_bytes;
269 static int print_one_fs(struct btrfs_ioctl_fs_info_args *fs_info,
270 struct btrfs_ioctl_dev_info_args *dev_info,
271 struct btrfs_ioctl_space_args *space_info,
272 char *label, char *path)
276 struct btrfs_ioctl_dev_info_args *tmp_dev_info;
278 uuid_unparse(fs_info->fsid, uuidbuf);
279 printf("Label: %s uuid: %s\n",
280 strlen(label) ? label : "none", uuidbuf);
282 printf("\tTotal devices %llu FS bytes used %s\n",
283 fs_info->num_devices,
284 pretty_size(calc_used_bytes(space_info)));
286 for (i = 0; i < fs_info->num_devices; i++) {
287 tmp_dev_info = (struct btrfs_ioctl_dev_info_args *)&dev_info[i];
288 printf("\tdevid %llu size %s used %s path %s\n",
290 pretty_size(tmp_dev_info->total_bytes),
291 pretty_size(tmp_dev_info->bytes_used),
299 /* This function checks if the given input parameter is
301 * return -1: some error in the given input
302 * return 0: unknow input
303 * return 1: given input is uuid
304 * return 2: given input is path
306 static int check_arg_type(char *input)
312 return BTRFS_ARG_UNKNOWN;
314 if (realpath(input, path)) {
315 if (is_block_device(input) == 1)
316 return BTRFS_ARG_BLKDEV;
318 if (is_mount_point(input) == 1)
319 return BTRFS_ARG_MNTPOINT;
321 return BTRFS_ARG_UNKNOWN;
324 if (!uuid_parse(input, out))
325 return BTRFS_ARG_UUID;
327 return BTRFS_ARG_UNKNOWN;
330 static int btrfs_scan_kernel(void *search)
332 int ret = 0, fd, type;
335 struct btrfs_ioctl_fs_info_args fs_info_arg;
336 struct btrfs_ioctl_dev_info_args *dev_info_arg = NULL;
337 struct btrfs_ioctl_space_args *space_info_arg;
338 char label[BTRFS_LABEL_SIZE];
341 f = setmntent("/proc/self/mounts", "r");
345 type = check_arg_type(search);
346 if (type == BTRFS_ARG_BLKDEV)
349 while ((mnt = getmntent(f)) != NULL) {
350 if (strcmp(mnt->mnt_type, "btrfs"))
352 ret = get_fs_info(mnt->mnt_dir, &fs_info_arg,
359 ret = uuid_parse(search, uuid);
362 if (uuid_compare(fs_info_arg.fsid, uuid))
365 case BTRFS_ARG_MNTPOINT:
366 if (strcmp(search, mnt->mnt_dir))
369 case BTRFS_ARG_UNKNOWN:
373 fd = open(mnt->mnt_dir, O_RDONLY);
374 if (fd > 0 && !get_df(fd, &space_info_arg)) {
375 get_label_mounted(mnt->mnt_dir, label);
376 print_one_fs(&fs_info_arg, dev_info_arg,
377 space_info_arg, label, mnt->mnt_dir);
378 free(space_info_arg);
387 static const char * const cmd_show_usage[] = {
388 "btrfs filesystem show [options|<path>|<uuid>]",
389 "Show the structure of a filesystem",
390 "-d|--all-devices show only disks under /dev containing btrfs filesystem",
391 "-m|--mounted show only mounted btrfs",
392 "If no argument is given, structure of all present filesystems is shown.",
396 static int cmd_show(int argc, char **argv)
398 struct list_head *all_uuids;
399 struct btrfs_fs_devices *fs_devices;
400 struct list_head *cur_uuid;
403 int where = BTRFS_SCAN_LBLKID;
405 char mp[BTRFS_PATH_NAME_MAX + 1];
409 static struct option long_options[] = {
410 { "all-devices", no_argument, NULL, 'd'},
411 { "mounted", no_argument, NULL, 'm'},
412 { NULL, no_argument, NULL, 0 },
414 int c = getopt_long(argc, argv, "dm", long_options,
420 where = BTRFS_SCAN_DEV;
423 where = BTRFS_SCAN_MOUNTED;
426 usage(cmd_show_usage);
430 if (where == BTRFS_SCAN_LBLKID) {
431 if (check_argc_max(argc, optind + 1))
432 usage(cmd_show_usage);
434 if (check_argc_max(argc, optind))
435 usage(cmd_show_usage);
438 search = argv[optind];
439 type = check_arg_type(search);
440 if (type == BTRFS_ARG_UNKNOWN) {
441 fprintf(stderr, "ERROR: arg type unknown\n");
442 usage(cmd_show_usage);
444 if (type == BTRFS_ARG_BLKDEV) {
445 ret = get_btrfs_mount(search, mp, sizeof(mp));
451 if (where == BTRFS_SCAN_DEV)
454 /* show mounted btrfs */
455 btrfs_scan_kernel(search);
457 /* shows mounted only */
458 if (where == BTRFS_SCAN_MOUNTED)
462 ret = scan_for_btrfs(where, !BTRFS_UPDATE_KERNEL);
465 fprintf(stderr, "ERROR: %d while scanning\n", ret);
469 all_uuids = btrfs_scanned_uuids();
470 list_for_each(cur_uuid, all_uuids) {
471 fs_devices = list_entry(cur_uuid, struct btrfs_fs_devices,
473 if (search && uuid_search(fs_devices, search) == 0)
476 print_one_uuid(fs_devices);
480 printf("%s\n", BTRFS_BUILD_VERSION);
484 static const char * const cmd_sync_usage[] = {
485 "btrfs filesystem sync <path>",
486 "Force a sync on a filesystem",
490 static int cmd_sync(int argc, char **argv)
494 DIR *dirstream = NULL;
496 if (check_argc_exact(argc, 2))
497 usage(cmd_sync_usage);
501 fd = open_file_or_dir(path, &dirstream);
503 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
507 printf("FSSync '%s'\n", path);
508 res = ioctl(fd, BTRFS_IOC_SYNC);
510 close_file_or_dir(fd, dirstream);
512 fprintf(stderr, "ERROR: unable to fs-syncing '%s' - %s\n",
520 static int parse_compress_type(char *s)
522 if (strcmp(optarg, "zlib") == 0)
523 return BTRFS_COMPRESS_ZLIB;
524 else if (strcmp(optarg, "lzo") == 0)
525 return BTRFS_COMPRESS_LZO;
527 fprintf(stderr, "Unknown compress type %s\n", s);
532 static const char * const cmd_defrag_usage[] = {
533 "btrfs filesystem defragment [options] <file>|<dir> [<file>|<dir>...]",
534 "Defragment a file or a directory",
537 "-r defragment files recursively",
538 "-c[zlib,lzo] compress the file while defragmenting",
539 "-f flush data to disk immediately after defragmenting",
540 "-s start defragment only from byte onward",
541 "-l len defragment only up to len bytes",
542 "-t size minimal size of file to be considered for defragmenting",
546 static int do_defrag(int fd, int fancy_ioctl,
547 struct btrfs_ioctl_defrag_range_args *range)
552 ret = ioctl(fd, BTRFS_IOC_DEFRAG, NULL);
554 ret = ioctl(fd, BTRFS_IOC_DEFRAG_RANGE, range);
559 static int defrag_global_fancy_ioctl;
560 static struct btrfs_ioctl_defrag_range_args defrag_global_range;
561 static int defrag_global_verbose;
562 static int defrag_global_errors;
563 static int defrag_callback(const char *fpath, const struct stat *sb,
564 int typeflag, struct FTW *ftwbuf)
570 if (typeflag == FTW_F) {
571 if (defrag_global_verbose)
572 printf("%s\n", fpath);
573 fd = open(fpath, O_RDWR);
577 ret = do_defrag(fd, defrag_global_fancy_ioctl, &defrag_global_range);
580 if (ret && e == ENOTTY) {
581 fprintf(stderr, "ERROR: defrag range ioctl not "
582 "supported in this kernel, please try "
583 "without any options.\n");
584 defrag_global_errors++;
593 fprintf(stderr, "ERROR: defrag failed on %s - %s\n", fpath, strerror(e));
594 defrag_global_errors++;
598 static int cmd_defrag(int argc, char **argv)
608 struct btrfs_ioctl_defrag_range_args range;
610 int compress_type = BTRFS_COMPRESS_NONE;
613 defrag_global_errors = 0;
614 defrag_global_verbose = 0;
615 defrag_global_errors = 0;
616 defrag_global_fancy_ioctl = 0;
619 int c = getopt(argc, argv, "vrc::fs:l:t:");
625 compress_type = BTRFS_COMPRESS_ZLIB;
627 compress_type = parse_compress_type(optarg);
628 defrag_global_fancy_ioctl = 1;
632 defrag_global_fancy_ioctl = 1;
635 defrag_global_verbose = 1;
638 start = parse_size(optarg);
639 defrag_global_fancy_ioctl = 1;
642 len = parse_size(optarg);
643 defrag_global_fancy_ioctl = 1;
646 thresh = parse_size(optarg);
647 defrag_global_fancy_ioctl = 1;
653 usage(cmd_defrag_usage);
657 if (check_argc_min(argc - optind, 1))
658 usage(cmd_defrag_usage);
660 memset(&defrag_global_range, 0, sizeof(range));
661 defrag_global_range.start = start;
662 defrag_global_range.len = len;
663 defrag_global_range.extent_thresh = thresh;
665 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_COMPRESS;
666 defrag_global_range.compress_type = compress_type;
669 defrag_global_range.flags |= BTRFS_DEFRAG_RANGE_START_IO;
671 for (i = optind; i < argc; i++) {
673 fd = open_file_or_dir(argv[i], &dirstream);
675 fprintf(stderr, "ERROR: failed to open %s - %s\n", argv[i],
677 defrag_global_errors++;
678 close_file_or_dir(fd, dirstream);
685 if (S_ISDIR(st.st_mode)) {
686 ret = nftw(argv[i], defrag_callback, 10,
687 FTW_MOUNT | FTW_PHYS);
690 /* errors are handled in the callback */
693 if (defrag_global_verbose)
694 printf("%s\n", argv[i]);
695 ret = do_defrag(fd, defrag_global_fancy_ioctl,
696 &defrag_global_range);
700 if (defrag_global_verbose)
701 printf("%s\n", argv[i]);
702 ret = do_defrag(fd, defrag_global_fancy_ioctl,
703 &defrag_global_range);
706 close_file_or_dir(fd, dirstream);
707 if (ret && e == ENOTTY) {
708 fprintf(stderr, "ERROR: defrag range ioctl not "
709 "supported in this kernel, please try "
710 "without any options.\n");
711 defrag_global_errors++;
715 fprintf(stderr, "ERROR: defrag failed on %s - %s\n",
716 argv[i], strerror(e));
717 defrag_global_errors++;
720 if (defrag_global_verbose)
721 printf("%s\n", BTRFS_BUILD_VERSION);
722 if (defrag_global_errors)
723 fprintf(stderr, "total %d failures\n", defrag_global_errors);
725 return !!defrag_global_errors;
728 static const char * const cmd_resize_usage[] = {
729 "btrfs filesystem resize [devid:][+/-]<newsize>[gkm]|[devid:]max <path>",
730 "Resize a filesystem",
731 "If 'max' is passed, the filesystem will occupy all available space",
732 "on the device 'devid'.",
736 static int cmd_resize(int argc, char **argv)
738 struct btrfs_ioctl_vol_args args;
741 DIR *dirstream = NULL;
743 if (check_argc_exact(argc, 3))
744 usage(cmd_resize_usage);
749 len = strlen(amount);
750 if (len == 0 || len >= BTRFS_VOL_NAME_MAX) {
751 fprintf(stderr, "ERROR: size value too long ('%s)\n",
756 fd = open_file_or_dir(path, &dirstream);
758 fprintf(stderr, "ERROR: can't access to '%s'\n", path);
762 printf("Resize '%s' of '%s'\n", path, amount);
763 strncpy_null(args.name, amount);
764 res = ioctl(fd, BTRFS_IOC_RESIZE, &args);
766 close_file_or_dir(fd, dirstream);
768 fprintf(stderr, "ERROR: unable to resize '%s' - %s\n",
775 static const char * const cmd_label_usage[] = {
776 "btrfs filesystem label [<device>|<mount_point>] [<newlabel>]",
777 "Get or change the label of a filesystem",
778 "With one argument, get the label of filesystem on <device>.",
779 "If <newlabel> is passed, set the filesystem label to <newlabel>.",
783 static int cmd_label(int argc, char **argv)
785 if (check_argc_min(argc, 2) || check_argc_max(argc, 3))
786 usage(cmd_label_usage);
789 return set_label(argv[1], argv[2]);
791 return get_label(argv[1]);
794 const struct cmd_group filesystem_cmd_group = {
795 filesystem_cmd_group_usage, NULL, {
796 { "df", cmd_df, cmd_df_usage, NULL, 0 },
797 { "show", cmd_show, cmd_show_usage, NULL, 0 },
798 { "sync", cmd_sync, cmd_sync_usage, NULL, 0 },
799 { "defragment", cmd_defrag, cmd_defrag_usage, NULL, 0 },
800 { "balance", cmd_balance, NULL, &balance_cmd_group, 1 },
801 { "resize", cmd_resize, cmd_resize_usage, NULL, 0 },
802 { "label", cmd_label, cmd_label_usage, NULL, 0 },
807 int cmd_filesystem(int argc, char **argv)
809 return handle_command_group(&filesystem_cmd_group, argc, argv);