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.
21 #include <sys/ioctl.h>
25 #include "kerncompat.h"
29 #include "send-utils.h"
32 #include "btrfs-list.h"
34 static const char * const inspect_cmd_group_usage[] = {
35 "btrfs inspect-internal <command> <args>",
39 static int __ino_to_path_fd(u64 inum, int fd, int verbose, const char *prepend)
43 struct btrfs_ioctl_ino_path_args ipa;
44 struct btrfs_data_container *fspath;
46 fspath = malloc(4096);
50 memset(fspath, 0, sizeof(*fspath));
53 ipa.fspath = ptr_to_u64(fspath);
55 ret = ioctl(fd, BTRFS_IOC_INO_PATHS, &ipa);
57 printf("ioctl ret=%d, error: %s\n", ret, strerror(errno));
62 printf("ioctl ret=%d, bytes_left=%lu, bytes_missing=%lu, "
63 "cnt=%d, missed=%d\n", ret,
64 (unsigned long)fspath->bytes_left,
65 (unsigned long)fspath->bytes_missing,
66 fspath->elem_cnt, fspath->elem_missed);
68 for (i = 0; i < fspath->elem_cnt; ++i) {
71 ptr = (u64)(unsigned long)fspath->val;
72 ptr += fspath->val[i];
73 str = (char *)(unsigned long)ptr;
75 printf("%s/%s\n", prepend, str);
85 static const char * const cmd_inspect_inode_resolve_usage[] = {
86 "btrfs inspect-internal inode-resolve [-v] <inode> <path>",
87 "Get file system paths for the given inode",
93 static int cmd_inspect_inode_resolve(int argc, char **argv)
98 DIR *dirstream = NULL;
102 int c = getopt(argc, argv, "v");
111 usage(cmd_inspect_inode_resolve_usage);
115 if (check_argc_exact(argc - optind, 2))
116 usage(cmd_inspect_inode_resolve_usage);
118 fd = open_file_or_dir(argv[optind+1], &dirstream);
120 fprintf(stderr, "ERROR: can't access '%s'\n", argv[optind+1]);
124 ret = __ino_to_path_fd(arg_strtou64(argv[optind]), fd, verbose,
126 close_file_or_dir(fd, dirstream);
131 static const char * const cmd_inspect_logical_resolve_usage[] = {
132 "btrfs inspect-internal logical-resolve [-Pv] [-s bufsize] <logical> <path>",
133 "Get file system paths for the given logical address",
134 "-P skip the path resolving and print the inodes instead",
136 "-s bufsize set inode container's size. This is used to increase inode",
137 " container's size in case it is not enough to read all the ",
138 " resolved results. The max value one can set is 64k",
142 static int cmd_inspect_logical_resolve(int argc, char **argv)
150 struct btrfs_ioctl_logical_ino_args loi;
151 struct btrfs_data_container *inodes;
153 char full_path[4096];
155 DIR *dirstream = NULL;
159 int c = getopt(argc, argv, "Pvs:");
171 size = arg_strtou64(optarg);
174 usage(cmd_inspect_logical_resolve_usage);
178 if (check_argc_exact(argc - optind, 2))
179 usage(cmd_inspect_logical_resolve_usage);
181 size = min(size, (u64)64 * 1024);
182 inodes = malloc(size);
186 memset(inodes, 0, sizeof(*inodes));
187 loi.logical = arg_strtou64(argv[optind]);
189 loi.inodes = ptr_to_u64(inodes);
191 fd = open_file_or_dir(argv[optind+1], &dirstream);
193 fprintf(stderr, "ERROR: can't access '%s'\n", argv[optind+1]);
198 ret = ioctl(fd, BTRFS_IOC_LOGICAL_INO, &loi);
200 printf("ioctl ret=%d, error: %s\n", ret, strerror(errno));
205 printf("ioctl ret=%d, total_size=%llu, bytes_left=%lu, "
206 "bytes_missing=%lu, cnt=%d, missed=%d\n",
208 (unsigned long)inodes->bytes_left,
209 (unsigned long)inodes->bytes_missing,
210 inodes->elem_cnt, inodes->elem_missed);
212 bytes_left = sizeof(full_path);
213 ret = snprintf(full_path, bytes_left, "%s/", argv[optind+1]);
214 path_ptr = full_path + ret;
215 bytes_left -= ret + 1;
216 BUG_ON(bytes_left < 0);
218 for (i = 0; i < inodes->elem_cnt; i += 3) {
219 u64 inum = inodes->val[i];
220 u64 offset = inodes->val[i+1];
221 u64 root = inodes->val[i+2];
227 name = btrfs_list_path_for_root(fd, root);
237 ret = snprintf(path_ptr, bytes_left, "%s",
239 BUG_ON(ret >= bytes_left);
241 path_fd = open_file_or_dir(full_path, &dirs);
243 fprintf(stderr, "ERROR: can't access "
244 "'%s'\n", full_path);
248 __ino_to_path_fd(inum, path_fd, verbose, full_path);
250 close_file_or_dir(path_fd, dirs);
252 printf("inode %llu offset %llu root %llu\n", inum,
258 close_file_or_dir(fd, dirstream);
263 static const char * const cmd_inspect_subvolid_resolve_usage[] = {
264 "btrfs inspect-internal subvolid-resolve <subvolid> <path>",
265 "Get file system paths for the given subvolume ID.",
269 static int cmd_inspect_subvolid_resolve(int argc, char **argv)
275 DIR *dirstream = NULL;
277 if (check_argc_exact(argc, 3))
278 usage(cmd_inspect_subvolid_resolve_usage);
280 fd = open_file_or_dir(argv[2], &dirstream);
282 fprintf(stderr, "ERROR: can't access '%s'\n", argv[2]);
287 subvol_id = arg_strtou64(argv[1]);
288 ret = btrfs_subvolid_resolve(fd, path, sizeof(path), subvol_id);
292 "%s: btrfs_subvolid_resolve(subvol_id %llu) failed with ret=%d\n",
293 argv[0], (unsigned long long)subvol_id, ret);
297 path[PATH_MAX - 1] = '\0';
298 printf("%s\n", path);
301 close_file_or_dir(fd, dirstream);
305 static const char* const cmd_inspect_rootid_usage[] = {
306 "btrfs inspect-internal rootid <path>",
307 "Get tree ID of the containing subvolume of path.",
311 static int cmd_inspect_rootid(int argc, char **argv)
316 DIR *dirstream = NULL;
318 if (check_argc_exact(argc, 2))
319 usage(cmd_inspect_rootid_usage);
321 fd = open_file_or_dir(argv[1], &dirstream);
323 fprintf(stderr, "ERROR: can't access '%s'\n", argv[1]);
328 ret = lookup_ino_rootid(fd, &rootid);
330 fprintf(stderr, "%s: rootid failed with ret=%d\n",
335 printf("%llu\n", (unsigned long long)rootid);
337 close_file_or_dir(fd, dirstream);
342 struct dev_extent_elem {
346 struct list_head list;
349 static int add_dev_extent(struct list_head *list,
350 const u64 start, const u64 end,
353 struct dev_extent_elem *e;
355 e = malloc(sizeof(*e));
363 list_add_tail(&e->list, list);
365 list_add(&e->list, list);
370 static void free_dev_extent_list(struct list_head *list)
372 while (!list_empty(list)) {
373 struct dev_extent_elem *e;
375 e = list_first_entry(list, struct dev_extent_elem, list);
381 static int hole_includes_sb_mirror(const u64 start, const u64 end)
386 for (i = 0; i < BTRFS_SUPER_MIRROR_MAX; i++) {
387 u64 bytenr = btrfs_sb_offset(i);
389 if (bytenr >= start && bytenr <= end) {
398 static void adjust_dev_min_size(struct list_head *extents,
399 struct list_head *holes,
403 * If relocation of the block group of a device extent must happen (see
404 * below) scratch space is used for the relocation. So track here the
405 * size of the largest device extent that has to be relocated. We track
406 * only the largest and not the sum of the sizes of all relocated block
407 * groups because after each block group is relocated the running
408 * transaction is committed so that pinned space is released.
410 u64 scratch_space = 0;
413 * List of device extents is sorted by descending order of the extent's
414 * end offset. If some extent goes beyond the computed minimum size,
415 * which initially matches the sum of the lenghts of all extents,
416 * we need to check if the extent can be relocated to an hole in the
417 * device between [0, *min_size[ (which is what the resize ioctl does).
419 while (!list_empty(extents)) {
420 struct dev_extent_elem *e;
421 struct dev_extent_elem *h;
426 e = list_first_entry(extents, struct dev_extent_elem, list);
427 if (e->end <= *min_size)
431 * Our extent goes beyond the computed *min_size. See if we can
432 * find a hole large enough to relocate it to. If not we must stop
433 * and set *min_size to the end of the extent.
435 extent_len = e->end - e->start + 1;
436 list_for_each_entry(h, holes, list) {
437 hole_len = h->end - h->start + 1;
438 if (hole_len >= extent_len) {
445 *min_size = e->end + 1;
450 * If the hole found contains the location for a superblock
451 * mirror, we are pessimistic and require allocating one
452 * more extent of the same size. This is because the block
453 * group could be in the worst case used by a single extent
454 * with a size >= (block_group.length - superblock.size).
456 if (hole_includes_sb_mirror(h->start,
457 h->start + extent_len - 1))
458 *min_size += extent_len;
460 if (hole_len > extent_len) {
461 h->start += extent_len;
470 if (extent_len > scratch_space)
471 scratch_space = extent_len;
475 *min_size += scratch_space;
477 * Chunk allocation requires inserting/updating items in the
478 * chunk tree, so often this can lead to the need of allocating
479 * a new system chunk too, which has a maximum size of 32Mb.
481 *min_size += 32 * 1024 * 1024;
485 static int print_min_dev_size(int fd, u64 devid)
489 * Device allocations starts at 1Mb or at the value passed through the
490 * mount option alloc_start if it's bigger than 1Mb. The alloc_start
491 * option is used for debugging and testing only, and recently the
492 * possibility of deprecating/removing it has been discussed, so we
495 u64 min_size = 1 * 1024 * 1024ull;
496 struct btrfs_ioctl_search_args args;
497 struct btrfs_ioctl_search_key *sk = &args.key;
498 u64 last_pos = (u64)-1;
502 memset(&args, 0, sizeof(args));
503 sk->tree_id = BTRFS_DEV_TREE_OBJECTID;
504 sk->min_objectid = devid;
505 sk->max_objectid = devid;
506 sk->max_type = BTRFS_DEV_EXTENT_KEY;
507 sk->min_type = BTRFS_DEV_EXTENT_KEY;
509 sk->max_offset = (u64)-1;
511 sk->max_transid = (u64)-1;
516 struct btrfs_ioctl_search_header *sh;
517 unsigned long off = 0;
519 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
522 "Error invoking tree search ioctl: %s\n",
528 if (sk->nr_items == 0)
531 for (i = 0; i < sk->nr_items; i++) {
532 struct btrfs_dev_extent *extent;
535 sh = (struct btrfs_ioctl_search_header *)(args.buf +
538 extent = (struct btrfs_dev_extent *)(args.buf + off);
541 sk->min_objectid = sh->objectid;
542 sk->min_type = sh->type;
543 sk->min_offset = sh->offset + 1;
545 if (sh->objectid != devid ||
546 sh->type != BTRFS_DEV_EXTENT_KEY)
549 len = btrfs_stack_dev_extent_length(extent);
551 ret = add_dev_extent(&extents, sh->offset,
552 sh->offset + len - 1, 0);
554 if (!ret && last_pos != (u64)-1 &&
555 last_pos != sh->offset)
556 ret = add_dev_extent(&holes, last_pos,
559 fprintf(stderr, "Error: %s\n", strerror(-ret));
564 last_pos = sh->offset + len;
567 if (sk->min_type != BTRFS_DEV_EXTENT_KEY ||
568 sk->min_objectid != devid)
572 adjust_dev_min_size(&extents, &holes, &min_size);
573 printf("%llu bytes (%s)\n", min_size, pretty_size(min_size));
576 free_dev_extent_list(&extents);
577 free_dev_extent_list(&holes);
582 static const char* const cmd_inspect_min_dev_size_usage[] = {
583 "btrfs inspect-internal min-dev-size [options] <path>",
584 "Get the minimum size the device can be shrunk to. The",
585 "device id 1 is used by default.",
586 "--id DEVID specify the device id to query",
590 static int cmd_inspect_min_dev_size(int argc, char **argv)
594 DIR *dirstream = NULL;
599 enum { GETOPT_VAL_DEVID = 256 };
600 static const struct option long_options[] = {
601 { "id", required_argument, NULL, GETOPT_VAL_DEVID },
605 c = getopt_long(argc, argv, "", long_options, NULL);
610 case GETOPT_VAL_DEVID:
611 devid = arg_strtou64(optarg);
614 usage(cmd_inspect_min_dev_size_usage);
617 if (check_argc_exact(argc - optind, 1))
618 usage(cmd_inspect_min_dev_size_usage);
620 fd = open_file_or_dir(argv[optind], &dirstream);
622 fprintf(stderr, "ERROR: can't access '%s'\n", argv[optind]);
627 ret = print_min_dev_size(fd, devid);
629 close_file_or_dir(fd, dirstream);
634 static const char inspect_cmd_group_info[] =
635 "query various internal information";
637 const struct cmd_group inspect_cmd_group = {
638 inspect_cmd_group_usage, inspect_cmd_group_info, {
639 { "inode-resolve", cmd_inspect_inode_resolve,
640 cmd_inspect_inode_resolve_usage, NULL, 0 },
641 { "logical-resolve", cmd_inspect_logical_resolve,
642 cmd_inspect_logical_resolve_usage, NULL, 0 },
643 { "subvolid-resolve", cmd_inspect_subvolid_resolve,
644 cmd_inspect_subvolid_resolve_usage, NULL, 0 },
645 { "rootid", cmd_inspect_rootid, cmd_inspect_rootid_usage, NULL,
647 { "min-dev-size", cmd_inspect_min_dev_size,
648 cmd_inspect_min_dev_size_usage, NULL, 0 },
653 int cmd_inspect(int argc, char **argv)
655 return handle_command_group(&inspect_cmd_group, argc, argv);