From 4167c86123322d0aa0bd84965264aaa732f8a12b Mon Sep 17 00:00:00 2001 From: David Sterba Date: Sat, 26 Aug 2023 02:14:59 +0200 Subject: [PATCH] btrfs-progs: remove btrfs-fragments The btrfs-fragments utility generates a html page with a set of images representing block groups and visualises fragmentation. Though this might be useful, the build has been broken since commit 877f512c5502c9 ("btrfs-progs: sync block group item accessors from kernel"), version 5.7. Also it's been out of date regarding newly added trees or data structure updates and does not work correctly anymore. Signed-off-by: David Sterba --- .gitignore | 2 - Makefile | 3 +- btrfs-fragments.c | 458 ---------------------------------------------- 3 files changed, 1 insertion(+), 462 deletions(-) delete mode 100644 btrfs-fragments.c diff --git a/.gitignore b/.gitignore index aa78b405..edfaf250 100644 --- a/.gitignore +++ b/.gitignore @@ -8,8 +8,6 @@ /btrfs.static /btrfs-map-logical /btrfs-map-logical.static -/btrfs-fragments -/btrfs-fragments.static /btrfsck /mkfs.btrfs /mkfs.btrfs.static diff --git a/Makefile b/Makefile index e6afe272..5dfd3c01 100644 --- a/Makefile +++ b/Makefile @@ -358,7 +358,7 @@ progs_build = $(progs_install) btrfsck btrfs-corrupt-block # All programs. Use := instead of = so that this is expanded before we reassign # progs_build below. -progs := $(progs_build) btrfs-convert btrfs-fragments btrfs-sb-mod +progs := $(progs_build) btrfs-convert btrfs-sb-mod ifneq ($(DISABLE_BTRFSCONVERT),1) progs_install += btrfs-convert @@ -377,7 +377,6 @@ endif # specify btrfs_foo_libs = ; see $($(subst...)) rules below btrfs_convert_cflags = -DBTRFSCONVERT_EXT2=$(BTRFSCONVERT_EXT2) btrfs_convert_cflags += -DBTRFSCONVERT_REISERFS=$(BTRFSCONVERT_REISERFS) -btrfs_fragments_libs = -lgd -lpng -ljpeg -lfreetype cmds_restore_cflags = -DCOMPRESSION_LZO=$(COMPRESSION_LZO) -DCOMPRESSION_ZSTD=$(COMPRESSION_ZSTD) ifeq ($(CRYPTOPROVIDER_BUILTIN),1) diff --git a/btrfs-fragments.c b/btrfs-fragments.c deleted file mode 100644 index 4dbc0505..00000000 --- a/btrfs-fragments.c +++ /dev/null @@ -1,458 +0,0 @@ -/* - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public - * License v2 as published by the Free Software Foundation. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public - * License along with this program; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 021110-1307, USA. - */ - -#include "kerncompat.h" -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "kernel-shared/uapi/btrfs.h" -#include "kernel-shared/ctree.h" -#include "common/utils.h" - -static int use_color; -static void -push_im(gdImagePtr im, char *name, char *dir) -{ - char fullname[2000]; - FILE *pngout; - - if (!im) - return; - - snprintf(fullname, sizeof(fullname), "%s/%s", dir, name); - pngout = fopen(fullname, "w"); - if (!pngout) { - printf("unable to create file %s\n", fullname); - exit(1); - } - - gdImagePng(im, pngout); - - fclose(pngout); - gdImageDestroy(im); -} - -static char * -chunk_type(u64 flags) -{ - switch (flags & (BTRFS_BLOCK_GROUP_SYSTEM | BTRFS_BLOCK_GROUP_DATA | - BTRFS_BLOCK_GROUP_METADATA)) { - case BTRFS_BLOCK_GROUP_SYSTEM: - return "system"; - case BTRFS_BLOCK_GROUP_DATA: - return "data"; - case BTRFS_BLOCK_GROUP_METADATA: - return "metadata"; - case BTRFS_BLOCK_GROUP_DATA | BTRFS_BLOCK_GROUP_METADATA: - return "mixed"; - default: - return "invalid"; - } -} - -static void -print_bg(FILE *html, char *name, u64 start, u64 len, u64 used, u64 flags, - u64 areas) -{ - double frag = (double)areas / (len / 4096) * 2; - - fprintf(html, "

%s chunk starts at %llu, size is %s, %.2f%% used, " - "%.2f%% fragmented

\n", chunk_type(flags), start, - pretty_size(len), 100.0 * used / len, 100.0 * frag); - fprintf(html, "\n", name); -} - -enum tree_colors { - COLOR_ROOT = 0, - COLOR_EXTENT, - COLOR_CHUNK, - COLOR_DEV, - COLOR_FS, - COLOR_CSUM, - COLOR_RELOC, - COLOR_DATA, - COLOR_UNKNOWN, - COLOR_MAX -}; - -static int -get_color(struct btrfs_extent_item *item, int len) -{ - u64 refs; - u64 flags; - u8 type; - u64 offset; - struct btrfs_extent_inline_ref *ref; - - refs = btrfs_stack_extent_refs(item); - flags = btrfs_stack_extent_flags(item); - - if (flags & BTRFS_EXTENT_FLAG_DATA) - return COLOR_DATA; - if (refs > 1) { - /* this must be an fs tree */ - return COLOR_FS; - } - - ref = (void *)item + sizeof(struct btrfs_extent_item) + - sizeof(struct btrfs_tree_block_info); - type = btrfs_stack_extent_inline_ref_type(ref); - offset = btrfs_stack_extent_inline_ref_offset(ref); - - switch (type) { - case BTRFS_EXTENT_DATA_REF_KEY: - return COLOR_DATA; - case BTRFS_SHARED_BLOCK_REF_KEY: - case BTRFS_SHARED_DATA_REF_KEY: - return COLOR_FS; - case BTRFS_TREE_BLOCK_REF_KEY: - break; - default: - return COLOR_UNKNOWN; - } - - switch (offset) { - case BTRFS_ROOT_TREE_OBJECTID: - return COLOR_ROOT; - case BTRFS_EXTENT_TREE_OBJECTID: - return COLOR_EXTENT; - case BTRFS_CHUNK_TREE_OBJECTID: - return COLOR_CHUNK; - case BTRFS_DEV_TREE_OBJECTID: - return COLOR_DEV; - case BTRFS_FS_TREE_OBJECTID: - return COLOR_FS; - case BTRFS_CSUM_TREE_OBJECTID: - return COLOR_CSUM; - case BTRFS_DATA_RELOC_TREE_OBJECTID: - return COLOR_RELOC; - } - - return COLOR_UNKNOWN; -} - -static void -init_colors(gdImagePtr im, int *colors) -{ - colors[COLOR_ROOT] = gdImageColorAllocate(im, 255, 0, 0); - colors[COLOR_EXTENT] = gdImageColorAllocate(im, 0, 255, 0); - colors[COLOR_CHUNK] = gdImageColorAllocate(im, 255, 0, 0); - colors[COLOR_DEV] = gdImageColorAllocate(im, 255, 0, 0); - colors[COLOR_FS] = gdImageColorAllocate(im, 0, 0, 0); - colors[COLOR_CSUM] = gdImageColorAllocate(im, 0, 0, 255); - colors[COLOR_RELOC] = gdImageColorAllocate(im, 128, 128, 128); - colors[COLOR_DATA] = gdImageColorAllocate(im, 100, 0, 0); - colors[COLOR_UNKNOWN] = gdImageColorAllocate(im, 50, 50, 50); -} - -int -list_fragments(int fd, u64 flags, char *dir) -{ - int ret; - struct btrfs_ioctl_search_args args; - struct btrfs_ioctl_search_key *sk = &args.key; - int i; - struct btrfs_ioctl_search_header *sh; - unsigned long off = 0; - int bgnum = 0; - u64 bgstart = 0; - u64 bglen = 0; - u64 bgend = 0; - u64 bgflags = 0; - u64 bgused = 0; - u64 saved_extent = 0; - u64 saved_len = 0; - int saved_color = 0; - u64 last_end = 0; - u64 areas = 0; - long px; - char name[1000]; - FILE *html; - int colors[COLOR_MAX]; - - gdImagePtr im = NULL; - int black = 0; - int width = 800; - - snprintf(name, sizeof(name), "%s/index.html", dir); - html = fopen(name, "w"); - if (!html) { - printf("unable to create %s\n", name); - exit(1); - } - - fprintf(html, "
\n"); - fprintf(html, "Btrfs Block Group Allocation Map\n"); - fprintf(html, "\n"); - fprintf(html, "
\n"); - - memset(&args, 0, sizeof(args)); - - sk->tree_id = BTRFS_EXTENT_TREE_OBJECTID; - sk->max_type = -1; - sk->min_type = 0; - sk->max_objectid = (u64)-1; - sk->max_offset = (u64)-1; - sk->max_transid = (u64)-1; - - /* just a big number, doesn't matter much */ - sk->nr_items = 4096; - - while(1) { - ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args); - if (ret < 0) { - fprintf(stderr, "ERROR: can't perform the search\n"); - goto out_close; - } - /* the ioctl returns the number of item it found in nr_items */ - if (sk->nr_items == 0) - break; - - off = 0; - for (i = 0; i < sk->nr_items; i++) { - int j; - - sh = (struct btrfs_ioctl_search_header *)(args.buf + - off); - off += sizeof(*sh); - if (btrfs_search_header_type(sh) - == BTRFS_BLOCK_GROUP_ITEM_KEY) { - struct btrfs_block_group_item *bg; - - if (im) { - push_im(im, name, dir); - im = NULL; - - print_bg(html, name, bgstart, bglen, - bgused, bgflags, areas); - } - - ++bgnum; - - bg = (struct btrfs_block_group_item *) - (args.buf + off); - bgflags = btrfs_block_group_flags(bg); - bgused = btrfs_block_group_used(bg); - - printf("found block group %llu len %llu " - "flags %llu\n", - btrfs_search_header_objectid(sh), - btrfs_search_header_offset(sh), - bgflags); - if (!(bgflags & flags)) { - /* skip this block group */ - sk->min_objectid = - btrfs_search_header_objectid(sh) + - btrfs_search_header_offset(sh); - sk->min_type = 0; - sk->min_offset = 0; - break; - } - im = gdImageCreate(width, - (btrfs_search_header_offset(sh) - / 4096 + 799) / width); - - black = gdImageColorAllocate(im, 0, 0, 0); - - for (j = 0; j < ARRAY_SIZE(colors); ++j) - colors[j] = black; - - init_colors(im, colors); - bgstart = btrfs_search_header_objectid(sh); - bglen = btrfs_search_header_offset(sh); - bgend = bgstart + bglen; - - snprintf(name, sizeof(name), "bg%d.png", bgnum); - - last_end = bgstart; - if (saved_len) { - px = (saved_extent - bgstart) / 4096; - for (j = 0; j < saved_len / 4096; ++j) { - int x = (px + j) % width; - int y = (px + j) / width; - gdImageSetPixel(im, x, y, - saved_color); - } - last_end += saved_len; - } - areas = 0; - saved_len = 0; - } - if (im && btrfs_search_header_type(sh) - == BTRFS_EXTENT_ITEM_KEY) { - int c; - struct btrfs_extent_item *item; - - item = (struct btrfs_extent_item *) - (args.buf + off); - - if (use_color) - c = colors[get_color(item, - btrfs_search_header_len(sh))]; - else - c = black; - if (btrfs_search_header_objectid(sh) > bgend) { - printf("WARN: extent %llu is without " - "block group\n", - btrfs_search_header_objectid(sh)); - goto skip; - } - if (btrfs_search_header_objectid(sh) == bgend) { - saved_extent = - btrfs_search_header_objectid(sh); - saved_len = - btrfs_search_header_offset(sh); - saved_color = c; - goto skip; - } - px = (btrfs_search_header_objectid(sh) - - bgstart) / 4096; - for (j = 0; - j < btrfs_search_header_offset(sh) / 4096; - ++j) { - int x = (px + j) % width; - int y = (px + j) / width; - gdImageSetPixel(im, x, y, c); - } - if (btrfs_search_header_objectid(sh) != last_end) - ++areas; - last_end = btrfs_search_header_objectid(sh) - + btrfs_search_header_offset(sh); -skip:; - } - off += btrfs_search_header_len(sh); - - /* - * record the mins in sk so we can make sure the - * next search doesn't repeat this root - */ - sk->min_objectid = btrfs_search_header_objectid(sh); - sk->min_type = btrfs_search_header_type(sh); - sk->min_offset = btrfs_search_header_offset(sh); - } - sk->nr_items = 4096; - - /* increment by one */ - if (++sk->min_offset == 0) - if (++sk->min_type == 0) - if (++sk->min_objectid == 0) - break; - } - - if (im) { - push_im(im, name, dir); - print_bg(html, name, bgstart, bglen, bgused, bgflags, areas); - } - - if (use_color) { - fprintf(html, "

"); - fprintf(html, "data - dark red, "); - fprintf(html, "fs tree - black, "); - fprintf(html, "extent tree - green, "); - fprintf(html, "csum tree - blue, "); - fprintf(html, "reloc tree - grey, "); - fprintf(html, "other trees - red, "); - fprintf(html, "unknown tree - dark grey"); - fprintf(html, "

"); - } - fprintf(html, "\n"); - -out_close: - fclose(html); - - return ret; -} - -void fragments_usage(void) -{ - printf("usage: btrfs-fragments [options] \n"); - printf(" -c use color\n"); - printf(" -d print data chunks\n"); - printf(" -m print metadata chunks\n"); - printf(" -s print system chunks\n"); - printf(" (default is data+metadata)\n"); - printf(" -o output directory, default is html\n"); - exit(1); -} - -int main(int argc, char **argv) -{ - char *path; - int fd; - int ret; - u64 flags = 0; - char *dir = "html"; - DIR *dirstream = NULL; - - while (1) { - int c = getopt(argc, argv, "cmso:h"); - if (c < 0) - break; - switch (c) { - case 'c': - use_color = 1; - break; - case 'd': - flags |= BTRFS_BLOCK_GROUP_DATA; - break; - case 'm': - flags |= BTRFS_BLOCK_GROUP_METADATA; - break; - case 's': - flags |= BTRFS_BLOCK_GROUP_SYSTEM; - break; - case 'o': - dir = optarg; - break; - case 'h': - default: - fragments_usage(); - } - } - - set_argv0(argv); - if (check_argc_min(argc - optind, 1)) - return 1; - - path = argv[optind++]; - - fd = btrfs_open_dir(path, &dirstream, 1); - if (fd < 0) - exit(1); - - if (flags == 0) - flags = BTRFS_BLOCK_GROUP_DATA | BTRFS_BLOCK_GROUP_METADATA; - - ret = list_fragments(fd, flags, dir); - close_file_or_dir(fd, dirstream); - if (ret) - exit(1); - - exit(0); -}