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>
26 #include "kerncompat.h"
30 #include "send-utils.h"
33 #include "btrfs-list.h"
35 static const char * const inspect_cmd_group_usage[] = {
36 "btrfs inspect-internal <command> <args>",
40 static int __ino_to_path_fd(u64 inum, int fd, int verbose, const char *prepend)
44 struct btrfs_ioctl_ino_path_args ipa;
45 struct btrfs_data_container *fspath;
47 fspath = malloc(4096);
51 memset(fspath, 0, sizeof(*fspath));
54 ipa.fspath = ptr_to_u64(fspath);
56 ret = ioctl(fd, BTRFS_IOC_INO_PATHS, &ipa);
58 printf("ioctl ret=%d, error: %s\n", ret, strerror(errno));
63 printf("ioctl ret=%d, bytes_left=%lu, bytes_missing=%lu, "
64 "cnt=%d, missed=%d\n", ret,
65 (unsigned long)fspath->bytes_left,
66 (unsigned long)fspath->bytes_missing,
67 fspath->elem_cnt, fspath->elem_missed);
69 for (i = 0; i < fspath->elem_cnt; ++i) {
72 ptr = (u64)(unsigned long)fspath->val;
73 ptr += fspath->val[i];
74 str = (char *)(unsigned long)ptr;
76 printf("%s/%s\n", prepend, str);
86 static const char * const cmd_inspect_inode_resolve_usage[] = {
87 "btrfs inspect-internal inode-resolve [-v] <inode> <path>",
88 "Get file system paths for the given inode",
94 static int cmd_inspect_inode_resolve(int argc, char **argv)
99 DIR *dirstream = NULL;
103 int c = getopt(argc, argv, "v");
112 usage(cmd_inspect_inode_resolve_usage);
116 if (check_argc_exact(argc - optind, 2))
117 usage(cmd_inspect_inode_resolve_usage);
119 fd = btrfs_open_dir(argv[optind + 1], &dirstream, 1);
123 ret = __ino_to_path_fd(arg_strtou64(argv[optind]), fd, verbose,
125 close_file_or_dir(fd, dirstream);
130 static const char * const cmd_inspect_logical_resolve_usage[] = {
131 "btrfs inspect-internal logical-resolve [-Pv] [-s bufsize] <logical> <path>",
132 "Get file system paths for the given logical address",
133 "-P skip the path resolving and print the inodes instead",
135 "-s bufsize set inode container's size. This is used to increase inode",
136 " container's size in case it is not enough to read all the ",
137 " resolved results. The max value one can set is 64k",
141 static int cmd_inspect_logical_resolve(int argc, char **argv)
149 struct btrfs_ioctl_logical_ino_args loi;
150 struct btrfs_data_container *inodes;
152 char full_path[4096];
154 DIR *dirstream = NULL;
158 int c = getopt(argc, argv, "Pvs:");
170 size = arg_strtou64(optarg);
173 usage(cmd_inspect_logical_resolve_usage);
177 if (check_argc_exact(argc - optind, 2))
178 usage(cmd_inspect_logical_resolve_usage);
180 size = min(size, (u64)64 * 1024);
181 inodes = malloc(size);
185 memset(inodes, 0, sizeof(*inodes));
186 loi.logical = arg_strtou64(argv[optind]);
188 loi.inodes = ptr_to_u64(inodes);
190 fd = btrfs_open_dir(argv[optind + 1], &dirstream, 1);
196 ret = ioctl(fd, BTRFS_IOC_LOGICAL_INO, &loi);
198 printf("ioctl ret=%d, error: %s\n", ret, strerror(errno));
203 printf("ioctl ret=%d, total_size=%llu, bytes_left=%lu, "
204 "bytes_missing=%lu, cnt=%d, missed=%d\n",
206 (unsigned long)inodes->bytes_left,
207 (unsigned long)inodes->bytes_missing,
208 inodes->elem_cnt, inodes->elem_missed);
210 bytes_left = sizeof(full_path);
211 ret = snprintf(full_path, bytes_left, "%s/", argv[optind+1]);
212 path_ptr = full_path + ret;
213 bytes_left -= ret + 1;
214 BUG_ON(bytes_left < 0);
216 for (i = 0; i < inodes->elem_cnt; i += 3) {
217 u64 inum = inodes->val[i];
218 u64 offset = inodes->val[i+1];
219 u64 root = inodes->val[i+2];
225 name = btrfs_list_path_for_root(fd, root);
235 ret = snprintf(path_ptr, bytes_left, "%s",
237 BUG_ON(ret >= bytes_left);
239 path_fd = btrfs_open_dir(full_path, &dirs, 1);
245 __ino_to_path_fd(inum, path_fd, verbose, full_path);
247 close_file_or_dir(path_fd, dirs);
249 printf("inode %llu offset %llu root %llu\n", inum,
255 close_file_or_dir(fd, dirstream);
260 static const char * const cmd_inspect_subvolid_resolve_usage[] = {
261 "btrfs inspect-internal subvolid-resolve <subvolid> <path>",
262 "Get file system paths for the given subvolume ID.",
266 static int cmd_inspect_subvolid_resolve(int argc, char **argv)
272 DIR *dirstream = NULL;
274 if (check_argc_exact(argc, 3))
275 usage(cmd_inspect_subvolid_resolve_usage);
277 fd = btrfs_open_dir(argv[2], &dirstream, 1);
283 subvol_id = arg_strtou64(argv[1]);
284 ret = btrfs_subvolid_resolve(fd, path, sizeof(path), subvol_id);
288 "%s: btrfs_subvolid_resolve(subvol_id %llu) failed with ret=%d\n",
289 argv[0], (unsigned long long)subvol_id, ret);
293 path[PATH_MAX - 1] = '\0';
294 printf("%s\n", path);
297 close_file_or_dir(fd, dirstream);
301 static const char* const cmd_inspect_rootid_usage[] = {
302 "btrfs inspect-internal rootid <path>",
303 "Get tree ID of the containing subvolume of path.",
307 static int cmd_inspect_rootid(int argc, char **argv)
312 DIR *dirstream = NULL;
314 if (check_argc_exact(argc, 2))
315 usage(cmd_inspect_rootid_usage);
317 fd = btrfs_open_dir(argv[1], &dirstream, 1);
323 ret = lookup_ino_rootid(fd, &rootid);
325 fprintf(stderr, "%s: rootid failed with ret=%d\n",
330 printf("%llu\n", (unsigned long long)rootid);
332 close_file_or_dir(fd, dirstream);
337 struct dev_extent_elem {
341 struct list_head list;
344 static int add_dev_extent(struct list_head *list,
345 const u64 start, const u64 end,
348 struct dev_extent_elem *e;
350 e = malloc(sizeof(*e));
358 list_add_tail(&e->list, list);
360 list_add(&e->list, list);
365 static void free_dev_extent_list(struct list_head *list)
367 while (!list_empty(list)) {
368 struct dev_extent_elem *e;
370 e = list_first_entry(list, struct dev_extent_elem, list);
376 static int hole_includes_sb_mirror(const u64 start, const u64 end)
381 for (i = 0; i < BTRFS_SUPER_MIRROR_MAX; i++) {
382 u64 bytenr = btrfs_sb_offset(i);
384 if (bytenr >= start && bytenr <= end) {
393 static void adjust_dev_min_size(struct list_head *extents,
394 struct list_head *holes,
398 * If relocation of the block group of a device extent must happen (see
399 * below) scratch space is used for the relocation. So track here the
400 * size of the largest device extent that has to be relocated. We track
401 * only the largest and not the sum of the sizes of all relocated block
402 * groups because after each block group is relocated the running
403 * transaction is committed so that pinned space is released.
405 u64 scratch_space = 0;
408 * List of device extents is sorted by descending order of the extent's
409 * end offset. If some extent goes beyond the computed minimum size,
410 * which initially matches the sum of the lenghts of all extents,
411 * we need to check if the extent can be relocated to an hole in the
412 * device between [0, *min_size[ (which is what the resize ioctl does).
414 while (!list_empty(extents)) {
415 struct dev_extent_elem *e;
416 struct dev_extent_elem *h;
421 e = list_first_entry(extents, struct dev_extent_elem, list);
422 if (e->end <= *min_size)
426 * Our extent goes beyond the computed *min_size. See if we can
427 * find a hole large enough to relocate it to. If not we must stop
428 * and set *min_size to the end of the extent.
430 extent_len = e->end - e->start + 1;
431 list_for_each_entry(h, holes, list) {
432 hole_len = h->end - h->start + 1;
433 if (hole_len >= extent_len) {
440 *min_size = e->end + 1;
445 * If the hole found contains the location for a superblock
446 * mirror, we are pessimistic and require allocating one
447 * more extent of the same size. This is because the block
448 * group could be in the worst case used by a single extent
449 * with a size >= (block_group.length - superblock.size).
451 if (hole_includes_sb_mirror(h->start,
452 h->start + extent_len - 1))
453 *min_size += extent_len;
455 if (hole_len > extent_len) {
456 h->start += extent_len;
465 if (extent_len > scratch_space)
466 scratch_space = extent_len;
470 *min_size += scratch_space;
472 * Chunk allocation requires inserting/updating items in the
473 * chunk tree, so often this can lead to the need of allocating
474 * a new system chunk too, which has a maximum size of 32Mb.
476 *min_size += 32 * 1024 * 1024;
480 static int print_min_dev_size(int fd, u64 devid)
484 * Device allocations starts at 1Mb or at the value passed through the
485 * mount option alloc_start if it's bigger than 1Mb. The alloc_start
486 * option is used for debugging and testing only, and recently the
487 * possibility of deprecating/removing it has been discussed, so we
490 u64 min_size = 1 * 1024 * 1024ull;
491 struct btrfs_ioctl_search_args args;
492 struct btrfs_ioctl_search_key *sk = &args.key;
493 u64 last_pos = (u64)-1;
497 memset(&args, 0, sizeof(args));
498 sk->tree_id = BTRFS_DEV_TREE_OBJECTID;
499 sk->min_objectid = devid;
500 sk->max_objectid = devid;
501 sk->max_type = BTRFS_DEV_EXTENT_KEY;
502 sk->min_type = BTRFS_DEV_EXTENT_KEY;
504 sk->max_offset = (u64)-1;
506 sk->max_transid = (u64)-1;
511 struct btrfs_ioctl_search_header *sh;
512 unsigned long off = 0;
514 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
517 "Error invoking tree search ioctl: %s\n",
523 if (sk->nr_items == 0)
526 for (i = 0; i < sk->nr_items; i++) {
527 struct btrfs_dev_extent *extent;
530 sh = (struct btrfs_ioctl_search_header *)(args.buf +
533 extent = (struct btrfs_dev_extent *)(args.buf + off);
536 sk->min_objectid = sh->objectid;
537 sk->min_type = sh->type;
538 sk->min_offset = sh->offset + 1;
540 if (sh->objectid != devid ||
541 sh->type != BTRFS_DEV_EXTENT_KEY)
544 len = btrfs_stack_dev_extent_length(extent);
546 ret = add_dev_extent(&extents, sh->offset,
547 sh->offset + len - 1, 0);
549 if (!ret && last_pos != (u64)-1 &&
550 last_pos != sh->offset)
551 ret = add_dev_extent(&holes, last_pos,
554 fprintf(stderr, "Error: %s\n", strerror(-ret));
559 last_pos = sh->offset + len;
562 if (sk->min_type != BTRFS_DEV_EXTENT_KEY ||
563 sk->min_objectid != devid)
567 adjust_dev_min_size(&extents, &holes, &min_size);
568 printf("%llu bytes (%s)\n", min_size, pretty_size(min_size));
571 free_dev_extent_list(&extents);
572 free_dev_extent_list(&holes);
577 static const char* const cmd_inspect_min_dev_size_usage[] = {
578 "btrfs inspect-internal min-dev-size [options] <path>",
579 "Get the minimum size the device can be shrunk to. The",
580 "device id 1 is used by default.",
581 "--id DEVID specify the device id to query",
585 static int cmd_inspect_min_dev_size(int argc, char **argv)
589 DIR *dirstream = NULL;
594 enum { GETOPT_VAL_DEVID = 256 };
595 static const struct option long_options[] = {
596 { "id", required_argument, NULL, GETOPT_VAL_DEVID },
600 c = getopt_long(argc, argv, "", long_options, NULL);
605 case GETOPT_VAL_DEVID:
606 devid = arg_strtou64(optarg);
609 usage(cmd_inspect_min_dev_size_usage);
612 if (check_argc_exact(argc - optind, 1))
613 usage(cmd_inspect_min_dev_size_usage);
615 fd = btrfs_open_dir(argv[optind], &dirstream, 1);
621 ret = print_min_dev_size(fd, devid);
622 close_file_or_dir(fd, dirstream);
627 static const char inspect_cmd_group_info[] =
628 "query various internal information";
630 const struct cmd_group inspect_cmd_group = {
631 inspect_cmd_group_usage, inspect_cmd_group_info, {
632 { "inode-resolve", cmd_inspect_inode_resolve,
633 cmd_inspect_inode_resolve_usage, NULL, 0 },
634 { "logical-resolve", cmd_inspect_logical_resolve,
635 cmd_inspect_logical_resolve_usage, NULL, 0 },
636 { "subvolid-resolve", cmd_inspect_subvolid_resolve,
637 cmd_inspect_subvolid_resolve_usage, NULL, 0 },
638 { "rootid", cmd_inspect_rootid, cmd_inspect_rootid_usage, NULL,
640 { "min-dev-size", cmd_inspect_min_dev_size,
641 cmd_inspect_min_dev_size_usage, NULL, 0 },
646 int cmd_inspect(int argc, char **argv)
648 return handle_command_group(&inspect_cmd_group, argc, argv);