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 = open_file_or_dir(argv[optind+1], &dirstream);
121 fprintf(stderr, "ERROR: can't access '%s'\n", argv[optind+1]);
125 ret = __ino_to_path_fd(arg_strtou64(argv[optind]), fd, verbose,
127 close_file_or_dir(fd, dirstream);
132 static const char * const cmd_inspect_logical_resolve_usage[] = {
133 "btrfs inspect-internal logical-resolve [-Pv] [-s bufsize] <logical> <path>",
134 "Get file system paths for the given logical address",
135 "-P skip the path resolving and print the inodes instead",
137 "-s bufsize set inode container's size. This is used to increase inode",
138 " container's size in case it is not enough to read all the ",
139 " resolved results. The max value one can set is 64k",
143 static int cmd_inspect_logical_resolve(int argc, char **argv)
151 struct btrfs_ioctl_logical_ino_args loi;
152 struct btrfs_data_container *inodes;
154 char full_path[4096];
156 DIR *dirstream = NULL;
160 int c = getopt(argc, argv, "Pvs:");
172 size = arg_strtou64(optarg);
175 usage(cmd_inspect_logical_resolve_usage);
179 if (check_argc_exact(argc - optind, 2))
180 usage(cmd_inspect_logical_resolve_usage);
182 size = min(size, (u64)64 * 1024);
183 inodes = malloc(size);
187 memset(inodes, 0, sizeof(*inodes));
188 loi.logical = arg_strtou64(argv[optind]);
190 loi.inodes = ptr_to_u64(inodes);
192 fd = open_file_or_dir(argv[optind+1], &dirstream);
194 fprintf(stderr, "ERROR: can't access '%s'\n", argv[optind+1]);
199 ret = ioctl(fd, BTRFS_IOC_LOGICAL_INO, &loi);
201 printf("ioctl ret=%d, error: %s\n", ret, strerror(errno));
206 printf("ioctl ret=%d, total_size=%llu, bytes_left=%lu, "
207 "bytes_missing=%lu, cnt=%d, missed=%d\n",
209 (unsigned long)inodes->bytes_left,
210 (unsigned long)inodes->bytes_missing,
211 inodes->elem_cnt, inodes->elem_missed);
213 bytes_left = sizeof(full_path);
214 ret = snprintf(full_path, bytes_left, "%s/", argv[optind+1]);
215 path_ptr = full_path + ret;
216 bytes_left -= ret + 1;
217 BUG_ON(bytes_left < 0);
219 for (i = 0; i < inodes->elem_cnt; i += 3) {
220 u64 inum = inodes->val[i];
221 u64 offset = inodes->val[i+1];
222 u64 root = inodes->val[i+2];
228 name = btrfs_list_path_for_root(fd, root);
238 ret = snprintf(path_ptr, bytes_left, "%s",
240 BUG_ON(ret >= bytes_left);
242 path_fd = open_file_or_dir(full_path, &dirs);
244 fprintf(stderr, "ERROR: can't access "
245 "'%s'\n", full_path);
249 __ino_to_path_fd(inum, path_fd, verbose, full_path);
251 close_file_or_dir(path_fd, dirs);
253 printf("inode %llu offset %llu root %llu\n", inum,
259 close_file_or_dir(fd, dirstream);
264 static const char * const cmd_inspect_subvolid_resolve_usage[] = {
265 "btrfs inspect-internal subvolid-resolve <subvolid> <path>",
266 "Get file system paths for the given subvolume ID.",
270 static int cmd_inspect_subvolid_resolve(int argc, char **argv)
276 DIR *dirstream = NULL;
278 if (check_argc_exact(argc, 3))
279 usage(cmd_inspect_subvolid_resolve_usage);
281 fd = open_file_or_dir(argv[2], &dirstream);
283 fprintf(stderr, "ERROR: can't access '%s'\n", argv[2]);
288 subvol_id = arg_strtou64(argv[1]);
289 ret = btrfs_subvolid_resolve(fd, path, sizeof(path), subvol_id);
293 "%s: btrfs_subvolid_resolve(subvol_id %llu) failed with ret=%d\n",
294 argv[0], (unsigned long long)subvol_id, ret);
298 path[PATH_MAX - 1] = '\0';
299 printf("%s\n", path);
302 close_file_or_dir(fd, dirstream);
306 static const char* const cmd_inspect_rootid_usage[] = {
307 "btrfs inspect-internal rootid <path>",
308 "Get tree ID of the containing subvolume of path.",
312 static int cmd_inspect_rootid(int argc, char **argv)
317 DIR *dirstream = NULL;
319 if (check_argc_exact(argc, 2))
320 usage(cmd_inspect_rootid_usage);
322 fd = open_file_or_dir(argv[1], &dirstream);
324 fprintf(stderr, "ERROR: can't access '%s'\n", argv[1]);
329 ret = lookup_ino_rootid(fd, &rootid);
331 fprintf(stderr, "%s: rootid failed with ret=%d\n",
336 printf("%llu\n", (unsigned long long)rootid);
338 close_file_or_dir(fd, dirstream);
343 struct dev_extent_elem {
347 struct list_head list;
350 static int add_dev_extent(struct list_head *list,
351 const u64 start, const u64 end,
354 struct dev_extent_elem *e;
356 e = malloc(sizeof(*e));
364 list_add_tail(&e->list, list);
366 list_add(&e->list, list);
371 static void free_dev_extent_list(struct list_head *list)
373 while (!list_empty(list)) {
374 struct dev_extent_elem *e;
376 e = list_first_entry(list, struct dev_extent_elem, list);
382 static int hole_includes_sb_mirror(const u64 start, const u64 end)
387 for (i = 0; i < BTRFS_SUPER_MIRROR_MAX; i++) {
388 u64 bytenr = btrfs_sb_offset(i);
390 if (bytenr >= start && bytenr <= end) {
399 static void adjust_dev_min_size(struct list_head *extents,
400 struct list_head *holes,
404 * If relocation of the block group of a device extent must happen (see
405 * below) scratch space is used for the relocation. So track here the
406 * size of the largest device extent that has to be relocated. We track
407 * only the largest and not the sum of the sizes of all relocated block
408 * groups because after each block group is relocated the running
409 * transaction is committed so that pinned space is released.
411 u64 scratch_space = 0;
414 * List of device extents is sorted by descending order of the extent's
415 * end offset. If some extent goes beyond the computed minimum size,
416 * which initially matches the sum of the lenghts of all extents,
417 * we need to check if the extent can be relocated to an hole in the
418 * device between [0, *min_size[ (which is what the resize ioctl does).
420 while (!list_empty(extents)) {
421 struct dev_extent_elem *e;
422 struct dev_extent_elem *h;
427 e = list_first_entry(extents, struct dev_extent_elem, list);
428 if (e->end <= *min_size)
432 * Our extent goes beyond the computed *min_size. See if we can
433 * find a hole large enough to relocate it to. If not we must stop
434 * and set *min_size to the end of the extent.
436 extent_len = e->end - e->start + 1;
437 list_for_each_entry(h, holes, list) {
438 hole_len = h->end - h->start + 1;
439 if (hole_len >= extent_len) {
446 *min_size = e->end + 1;
451 * If the hole found contains the location for a superblock
452 * mirror, we are pessimistic and require allocating one
453 * more extent of the same size. This is because the block
454 * group could be in the worst case used by a single extent
455 * with a size >= (block_group.length - superblock.size).
457 if (hole_includes_sb_mirror(h->start,
458 h->start + extent_len - 1))
459 *min_size += extent_len;
461 if (hole_len > extent_len) {
462 h->start += extent_len;
471 if (extent_len > scratch_space)
472 scratch_space = extent_len;
476 *min_size += scratch_space;
478 * Chunk allocation requires inserting/updating items in the
479 * chunk tree, so often this can lead to the need of allocating
480 * a new system chunk too, which has a maximum size of 32Mb.
482 *min_size += 32 * 1024 * 1024;
486 static int print_min_dev_size(int fd, u64 devid)
490 * Device allocations starts at 1Mb or at the value passed through the
491 * mount option alloc_start if it's bigger than 1Mb. The alloc_start
492 * option is used for debugging and testing only, and recently the
493 * possibility of deprecating/removing it has been discussed, so we
496 u64 min_size = 1 * 1024 * 1024ull;
497 struct btrfs_ioctl_search_args args;
498 struct btrfs_ioctl_search_key *sk = &args.key;
499 u64 last_pos = (u64)-1;
503 memset(&args, 0, sizeof(args));
504 sk->tree_id = BTRFS_DEV_TREE_OBJECTID;
505 sk->min_objectid = devid;
506 sk->max_objectid = devid;
507 sk->max_type = BTRFS_DEV_EXTENT_KEY;
508 sk->min_type = BTRFS_DEV_EXTENT_KEY;
510 sk->max_offset = (u64)-1;
512 sk->max_transid = (u64)-1;
517 struct btrfs_ioctl_search_header *sh;
518 unsigned long off = 0;
520 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
523 "Error invoking tree search ioctl: %s\n",
529 if (sk->nr_items == 0)
532 for (i = 0; i < sk->nr_items; i++) {
533 struct btrfs_dev_extent *extent;
536 sh = (struct btrfs_ioctl_search_header *)(args.buf +
539 extent = (struct btrfs_dev_extent *)(args.buf + off);
542 sk->min_objectid = sh->objectid;
543 sk->min_type = sh->type;
544 sk->min_offset = sh->offset + 1;
546 if (sh->objectid != devid ||
547 sh->type != BTRFS_DEV_EXTENT_KEY)
550 len = btrfs_stack_dev_extent_length(extent);
552 ret = add_dev_extent(&extents, sh->offset,
553 sh->offset + len - 1, 0);
555 if (!ret && last_pos != (u64)-1 &&
556 last_pos != sh->offset)
557 ret = add_dev_extent(&holes, last_pos,
560 fprintf(stderr, "Error: %s\n", strerror(-ret));
565 last_pos = sh->offset + len;
568 if (sk->min_type != BTRFS_DEV_EXTENT_KEY ||
569 sk->min_objectid != devid)
573 adjust_dev_min_size(&extents, &holes, &min_size);
574 printf("%llu bytes (%s)\n", min_size, pretty_size(min_size));
577 free_dev_extent_list(&extents);
578 free_dev_extent_list(&holes);
583 static const char* const cmd_inspect_min_dev_size_usage[] = {
584 "btrfs inspect-internal min-dev-size [options] <path>",
585 "Get the minimum size the device can be shrunk to. The",
586 "device id 1 is used by default.",
587 "--id DEVID specify the device id to query",
591 static int cmd_inspect_min_dev_size(int argc, char **argv)
595 DIR *dirstream = NULL;
600 enum { GETOPT_VAL_DEVID = 256 };
601 static const struct option long_options[] = {
602 { "id", required_argument, NULL, GETOPT_VAL_DEVID },
606 c = getopt_long(argc, argv, "", long_options, NULL);
611 case GETOPT_VAL_DEVID:
612 devid = arg_strtou64(optarg);
615 usage(cmd_inspect_min_dev_size_usage);
618 if (check_argc_exact(argc - optind, 1))
619 usage(cmd_inspect_min_dev_size_usage);
621 fd = open_file_or_dir(argv[optind], &dirstream);
623 fprintf(stderr, "ERROR: can't access '%s'\n", argv[optind]);
628 ret = print_min_dev_size(fd, devid);
630 close_file_or_dir(fd, dirstream);
635 static const char inspect_cmd_group_info[] =
636 "query various internal information";
638 const struct cmd_group inspect_cmd_group = {
639 inspect_cmd_group_usage, inspect_cmd_group_info, {
640 { "inode-resolve", cmd_inspect_inode_resolve,
641 cmd_inspect_inode_resolve_usage, NULL, 0 },
642 { "logical-resolve", cmd_inspect_logical_resolve,
643 cmd_inspect_logical_resolve_usage, NULL, 0 },
644 { "subvolid-resolve", cmd_inspect_subvolid_resolve,
645 cmd_inspect_subvolid_resolve_usage, NULL, 0 },
646 { "rootid", cmd_inspect_rootid, cmd_inspect_rootid_usage, NULL,
648 { "min-dev-size", cmd_inspect_min_dev_size,
649 cmd_inspect_min_dev_size_usage, NULL, 0 },
654 int cmd_inspect(int argc, char **argv)
656 return handle_command_group(&inspect_cmd_group, argc, argv);