2 * htree.c --- hash tree routines
4 * Copyright (C) 2002 Theodore Ts'o. This file may be redistributed
5 * under the terms of the GNU Public License.
18 #include <sys/types.h>
27 #include "uuid/uuid.h"
32 static void htree_dump_leaf_node(ext2_filsys fs, ext2_ino_t ino,
33 struct ext2_inode *inode,
34 struct ext2_dx_root_info * rootnode,
35 blk64_t blk, char *buf)
38 struct ext2_dir_entry *dirent;
40 unsigned int offset = 0;
41 char name[EXT2_NAME_LEN + 1];
42 char tmp[EXT2_NAME_LEN + 64];
44 ext2_dirhash_t hash, minor_hash;
49 if (ext2fs_has_feature_metadata_csum(fs->super))
50 csum_size = sizeof(struct ext2_dir_entry_tail);
52 errcode = ext2fs_bmap2(fs, ino, inode, buf, 0, blk, 0, &pblk);
54 com_err("htree_dump_leaf_node", errcode,
55 "while mapping logical block %llu\n", blk);
59 fprintf(pager, "Reading directory block %llu, phys %llu\n", blk, pblk);
60 errcode = ext2fs_read_dir_block4(current_fs, pblk, buf, 0, ino);
62 com_err("htree_dump_leaf_node", errcode,
63 "while reading block %llu (%llu)\n",
67 hash_alg = rootnode->hash_version;
68 if ((hash_alg <= EXT2_HASH_TEA) &&
69 (fs->super->s_flags & EXT2_FLAGS_UNSIGNED_HASH))
72 while (offset < fs->blocksize) {
73 dirent = (struct ext2_dir_entry *) (buf + offset);
74 errcode = ext2fs_get_rec_len(fs, dirent, &rec_len);
76 com_err("htree_dump_leaf_inode", errcode,
77 "while getting rec_len for block %lu",
81 thislen = ext2fs_dirent_name_len(dirent);
82 if (((offset + rec_len) > fs->blocksize) ||
84 ((rec_len % 4) != 0) ||
85 ((unsigned) thislen + 8 > rec_len)) {
86 fprintf(pager, "Corrupted directory block (%llu)!\n",
90 strncpy(name, dirent->name, thislen);
92 errcode = ext2fs_dirhash(hash_alg, name,
93 thislen, fs->super->s_hash_seed,
96 com_err("htree_dump_leaf_node", errcode,
97 "while calculating hash");
98 if ((offset == fs->blocksize - csum_size) &&
99 (dirent->inode == 0) &&
100 (dirent->rec_len == csum_size) &&
101 (dirent->name_len == EXT2_DIR_NAME_LEN_CSUM)) {
102 struct ext2_dir_entry_tail *t;
104 t = (struct ext2_dir_entry_tail *) dirent;
106 snprintf(tmp, EXT2_NAME_LEN + 64,
107 "leaf block checksum: 0x%08x ",
110 snprintf(tmp, EXT2_NAME_LEN + 64,
111 "%u 0x%08x-%08x (%d) %s ",
112 dirent->inode, hash, minor_hash,
115 thislen = strlen(tmp);
116 if (col + thislen > 80) {
117 fprintf(pager, "\n");
120 fprintf(pager, "%s", tmp);
124 fprintf(pager, "\n");
128 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
129 struct ext2_inode *inode,
130 struct ext2_dx_root_info * rootnode,
131 blk64_t blk, char *buf, int level);
134 static void htree_dump_int_node(ext2_filsys fs, ext2_ino_t ino,
135 struct ext2_inode *inode,
136 struct ext2_dx_root_info * rootnode,
137 struct ext2_dx_entry *ent,
138 char *buf, int level)
140 struct ext2_dx_countlimit dx_countlimit;
141 struct ext2_dx_tail *tail;
146 dx_countlimit = *((struct ext2_dx_countlimit *) ent);
147 count = ext2fs_le16_to_cpu(dx_countlimit.count);
148 limit = ext2fs_le16_to_cpu(dx_countlimit.limit);
150 fprintf(pager, "Number of entries (count): %d\n", count);
151 fprintf(pager, "Number of entries (limit): %d\n", limit);
153 remainder = fs->blocksize - (limit * sizeof(struct ext2_dx_entry));
154 if (ent == (struct ext2_dx_entry *)(rootnode + 1))
155 remainder -= sizeof(struct ext2_dx_root_info) + 24;
158 if (ext2fs_has_feature_metadata_csum(fs->super) &&
159 remainder == sizeof(struct ext2_dx_tail)) {
160 tail = (struct ext2_dx_tail *)(ent + limit);
161 fprintf(pager, "Checksum: 0x%08x\n",
162 ext2fs_le32_to_cpu(tail->dt_checksum));
165 for (i=0; i < count; i++) {
166 hash = i ? ext2fs_le32_to_cpu(ent[i].hash) : 0;
167 fprintf(pager, "Entry #%d: Hash 0x%08x%s, block %u\n", i,
168 hash, (hash & 1) ? " (**)" : "",
169 ext2fs_le32_to_cpu(ent[i].block));
172 fprintf(pager, "\n");
174 for (i=0; i < count; i++) {
175 unsigned int hashval, block;
177 hashval = ext2fs_le32_to_cpu(ent[i].hash);
178 block = ext2fs_le32_to_cpu(ent[i].block);
179 fprintf(pager, "Entry #%d: Hash 0x%08x, block %u\n", i,
180 i ? hashval : 0, block);
182 htree_dump_int_block(fs, ino, inode, rootnode,
183 block, buf, level-1);
185 htree_dump_leaf_node(fs, ino, inode, rootnode,
189 fprintf(pager, "---------------------\n");
192 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
193 struct ext2_inode *inode,
194 struct ext2_dx_root_info * rootnode,
195 blk64_t blk, char *buf, int level)
201 cbuf = malloc(fs->blocksize);
203 fprintf(pager, "Couldn't allocate child block.\n");
207 errcode = ext2fs_bmap2(fs, ino, inode, buf, 0, blk, 0, &pblk);
209 com_err("htree_dump_int_block", errcode,
210 "while mapping logical block %llu\n", blk);
214 errcode = io_channel_read_blk64(current_fs->io, pblk, 1, buf);
216 com_err("htree_dump_int_block", errcode,
217 "while reading block %llu\n", blk);
221 htree_dump_int_node(fs, ino, inode, rootnode,
222 (struct ext2_dx_entry *) (buf+8),
230 void do_htree_dump(int argc, char *argv[])
233 struct ext2_inode inode;
236 struct ext2_dx_root_info *rootnode;
237 struct ext2_dx_entry *ent;
240 if (check_fs_open(argv[0]))
243 pager = open_pager();
245 if (common_inode_args_process(argc, argv, &ino, 0))
248 if (debugfs_read_inode(ino, &inode, argv[1]))
251 if (!LINUX_S_ISDIR(inode.i_mode)) {
252 com_err(argv[0], 0, "Not a directory");
256 if ((inode.i_flags & EXT2_BTREE_FL) == 0) {
257 com_err(argv[0], 0, "Not a hash-indexed directory");
261 buf = malloc(2*current_fs->blocksize);
263 com_err(argv[0], 0, "Couldn't allocate htree buffer");
267 errcode = ext2fs_bmap2(current_fs, ino, &inode, buf, 0, 0, 0, &blk);
269 com_err("do_htree_block", errcode,
270 "while mapping logical block 0\n");
274 errcode = io_channel_read_blk64(current_fs->io, blk,
277 com_err(argv[0], errcode, "Error reading root node");
281 rootnode = get_ext2_dx_root_info(current_fs, buf);
283 fprintf(pager, "Root node dump:\n");
284 fprintf(pager, "\t Reserved zero: %u\n", rootnode->reserved_zero);
285 fprintf(pager, "\t Hash Version: %d\n", rootnode->hash_version);
286 fprintf(pager, "\t Info length: %d\n", rootnode->info_length);
287 fprintf(pager, "\t Indirect levels: %d\n", rootnode->indirect_levels);
288 fprintf(pager, "\t Flags: %d\n", rootnode->unused_flags);
290 ent = (struct ext2_dx_entry *)
291 ((char *)rootnode + rootnode->info_length);
293 htree_dump_int_node(current_fs, ino, &inode, rootnode, ent,
294 buf + current_fs->blocksize,
295 rootnode->indirect_levels);
303 * This function prints the hash of a given file.
305 void do_dx_hash(int argc, char *argv[])
307 ext2_dirhash_t hash, minor_hash;
310 int hash_version = 0;
313 hash_seed[0] = hash_seed[1] = hash_seed[2] = hash_seed[3] = 0;
316 while ((c = getopt (argc, argv, "h:s:")) != EOF) {
319 hash_version = e2p_string2hash(optarg);
320 if (hash_version < 0)
321 hash_version = atoi(optarg);
324 if (uuid_parse(optarg, (unsigned char *) hash_seed)) {
325 fprintf(stderr, "Invalid UUID format: %s\n",
334 if (optind != argc-1) {
336 com_err(argv[0], 0, "usage: dx_hash [-h hash_alg] "
337 "[-s hash_seed] filename");
340 err = ext2fs_dirhash(hash_version, argv[optind], strlen(argv[optind]),
341 hash_seed, &hash, &minor_hash);
343 com_err(argv[0], err, "while calculating hash");
346 printf("Hash of %s is 0x%0x (minor 0x%0x)\n", argv[optind],
351 * Search for particular directory entry (useful for debugging very
352 * large hash tree directories that have lost some blocks from the
355 struct process_block_struct {
361 static int search_dir_block(ext2_filsys fs, blk64_t *blocknr,
362 e2_blkcnt_t blockcnt, blk64_t ref_blk,
363 int ref_offset, void *priv_data);
365 void do_dirsearch(int argc, char *argv[])
368 struct process_block_struct pb;
370 if (check_fs_open(argv[0]))
374 com_err(0, 0, "Usage: dirsearch dir filename");
378 inode = string_to_inode(argv[1]);
382 pb.buf = malloc(current_fs->blocksize);
384 com_err("dirsearch", 0, "Couldn't allocate buffer");
387 pb.search_name = argv[2];
388 pb.len = strlen(pb.search_name);
390 ext2fs_block_iterate3(current_fs, inode, BLOCK_FLAG_READ_ONLY, 0,
391 search_dir_block, &pb);
397 static int search_dir_block(ext2_filsys fs, blk64_t *blocknr,
398 e2_blkcnt_t blockcnt,
399 blk64_t ref_blk EXT2FS_ATTR((unused)),
400 int ref_offset EXT2FS_ATTR((unused)),
403 struct process_block_struct *p;
404 struct ext2_dir_entry *dirent;
406 unsigned int offset = 0;
407 unsigned int rec_len;
412 p = (struct process_block_struct *) priv_data;
414 errcode = io_channel_read_blk64(current_fs->io, *blocknr, 1, p->buf);
416 com_err("search_dir_block", errcode,
417 "while reading block %lu", (unsigned long) *blocknr);
421 while (offset < fs->blocksize) {
422 dirent = (struct ext2_dir_entry *) (p->buf + offset);
423 errcode = ext2fs_get_rec_len(fs, dirent, &rec_len);
425 com_err("htree_dump_leaf_inode", errcode,
426 "while getting rec_len for block %lu",
427 (unsigned long) *blocknr);
431 p->len == ext2fs_dirent_name_len(dirent) &&
432 strncmp(p->search_name, dirent->name,
434 printf("Entry found at logical block %lld, "
435 "phys %llu, offset %u\n", (long long)blockcnt,
437 printf("offset %u\n", offset);