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;
47 int hash_flags = inode->i_flags & EXT4_CASEFOLD_FL;
50 if (ext2fs_has_feature_metadata_csum(fs->super))
51 csum_size = sizeof(struct ext2_dir_entry_tail);
53 errcode = ext2fs_bmap2(fs, ino, inode, buf, 0, blk, 0, &pblk);
55 com_err("htree_dump_leaf_node", errcode,
56 "while mapping logical block %llu\n", blk);
60 fprintf(pager, "Reading directory block %llu, phys %llu\n", blk, pblk);
61 errcode = ext2fs_read_dir_block4(current_fs, pblk, buf, 0, ino);
63 com_err("htree_dump_leaf_node", errcode,
64 "while reading block %llu (%llu)\n",
68 hash_alg = rootnode->hash_version;
69 if ((hash_alg <= EXT2_HASH_TEA) &&
70 (fs->super->s_flags & EXT2_FLAGS_UNSIGNED_HASH))
73 while (offset < fs->blocksize) {
74 dirent = (struct ext2_dir_entry *) (buf + offset);
75 errcode = ext2fs_get_rec_len(fs, dirent, &rec_len);
77 com_err("htree_dump_leaf_inode", errcode,
78 "while getting rec_len for block %lu",
82 thislen = ext2fs_dirent_name_len(dirent);
83 if (((offset + rec_len) > fs->blocksize) ||
85 ((rec_len % 4) != 0) ||
86 ((unsigned) thislen + 8 > rec_len)) {
87 fprintf(pager, "Corrupted directory block (%llu)!\n",
91 strncpy(name, dirent->name, thislen);
93 errcode = ext2fs_dirhash2(hash_alg, name, thislen,
94 fs->encoding, hash_flags,
95 fs->super->s_hash_seed,
98 com_err("htree_dump_leaf_node", errcode,
99 "while calculating hash");
100 if ((offset == fs->blocksize - csum_size) &&
101 (dirent->inode == 0) &&
102 (dirent->rec_len == csum_size) &&
103 (dirent->name_len == EXT2_DIR_NAME_LEN_CSUM)) {
104 struct ext2_dir_entry_tail *t;
106 t = (struct ext2_dir_entry_tail *) dirent;
108 snprintf(tmp, EXT2_NAME_LEN + 64,
109 "leaf block checksum: 0x%08x ",
112 snprintf(tmp, EXT2_NAME_LEN + 64,
113 "%u 0x%08x-%08x (%d) %s ",
114 dirent->inode, hash, minor_hash,
117 thislen = strlen(tmp);
118 if (col + thislen > 80) {
119 fprintf(pager, "\n");
122 fprintf(pager, "%s", tmp);
126 fprintf(pager, "\n");
130 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
131 struct ext2_inode *inode,
132 struct ext2_dx_root_info * rootnode,
133 blk64_t blk, char *buf, int level);
136 static void htree_dump_int_node(ext2_filsys fs, ext2_ino_t ino,
137 struct ext2_inode *inode,
138 struct ext2_dx_root_info * rootnode,
139 struct ext2_dx_entry *ent, __u32 crc,
140 char *buf, int level)
142 struct ext2_dx_countlimit dx_countlimit;
143 struct ext2_dx_tail *tail;
148 dx_countlimit = *((struct ext2_dx_countlimit *) ent);
149 count = ext2fs_le16_to_cpu(dx_countlimit.count);
150 limit = ext2fs_le16_to_cpu(dx_countlimit.limit);
152 fprintf(pager, "Number of entries (count): %d\n", count);
153 fprintf(pager, "Number of entries (limit): %d\n", limit);
155 remainder = fs->blocksize - (limit * sizeof(struct ext2_dx_entry));
156 if (ent == (struct ext2_dx_entry *)(rootnode + 1))
157 remainder -= sizeof(struct ext2_dx_root_info) + 24;
160 if (ext2fs_has_feature_metadata_csum(fs->super) &&
161 remainder == sizeof(struct ext2_dx_tail)) {
162 tail = (struct ext2_dx_tail *)(ent + limit);
163 fprintf(pager, "Checksum: 0x%08x",
164 ext2fs_le32_to_cpu(tail->dt_checksum));
165 if (tail->dt_checksum != crc)
166 fprintf(pager, " --- EXPECTED: 0x%08x", crc);
170 for (i=0; i < count; i++) {
171 hash = i ? ext2fs_le32_to_cpu(ent[i].hash) : 0;
172 fprintf(pager, "Entry #%d: Hash 0x%08x%s, block %u\n", i,
173 hash, (hash & 1) ? " (**)" : "",
174 ext2fs_le32_to_cpu(ent[i].block));
177 fprintf(pager, "\n");
179 for (i=0; i < count; i++) {
180 unsigned int hashval, block;
182 hashval = ext2fs_le32_to_cpu(ent[i].hash);
183 block = ext2fs_le32_to_cpu(ent[i].block);
184 fprintf(pager, "Entry #%d: Hash 0x%08x, block %u\n", i,
185 i ? hashval : 0, block);
187 htree_dump_int_block(fs, ino, inode, rootnode,
188 block, buf, level-1);
190 htree_dump_leaf_node(fs, ino, inode, rootnode,
194 fprintf(pager, "---------------------\n");
197 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
198 struct ext2_inode *inode,
199 struct ext2_dx_root_info * rootnode,
200 blk64_t blk, char *buf, int level)
207 cbuf = malloc(fs->blocksize);
209 fprintf(pager, "Couldn't allocate child block.\n");
213 errcode = ext2fs_bmap2(fs, ino, inode, buf, 0, blk, 0, &pblk);
215 com_err("htree_dump_int_block", errcode,
216 "while mapping logical block %llu\n", blk);
220 errcode = io_channel_read_blk64(current_fs->io, pblk, 1, buf);
222 com_err("htree_dump_int_block", errcode,
223 "while reading block %llu\n", blk);
227 errcode = ext2fs_dx_csum(current_fs, ino,
228 (struct ext2_dir_entry *) buf, &crc, NULL);
230 com_err("htree_dump_int_block", errcode,
231 "while calculating checksum for logical block %llu\n",
232 (unsigned long long) blk);
233 crc = (unsigned int) -1;
235 htree_dump_int_node(fs, ino, inode, rootnode,
236 (struct ext2_dx_entry *) (buf+8),
244 void do_htree_dump(int argc, char *argv[], int sci_idx EXT2FS_ATTR((unused)),
245 void *infop EXT2FS_ATTR((unused)))
248 struct ext2_inode inode;
251 struct ext2_dx_root_info *rootnode;
252 struct ext2_dx_entry *ent;
256 if (check_fs_open(argv[0]))
259 pager = open_pager();
261 if (common_inode_args_process(argc, argv, &ino, 0))
264 if (debugfs_read_inode(ino, &inode, argv[1]))
267 if (!LINUX_S_ISDIR(inode.i_mode)) {
268 com_err(argv[0], 0, "Not a directory");
272 if ((inode.i_flags & EXT2_BTREE_FL) == 0) {
273 com_err(argv[0], 0, "Not a hash-indexed directory");
277 buf = malloc(2*current_fs->blocksize);
279 com_err(argv[0], 0, "Couldn't allocate htree buffer");
283 errcode = ext2fs_bmap2(current_fs, ino, &inode, buf, 0, 0, 0, &blk);
285 com_err("do_htree_block", errcode,
286 "while mapping logical block 0\n");
290 errcode = io_channel_read_blk64(current_fs->io, blk,
293 com_err(argv[0], errcode, "Error reading root node");
297 rootnode = (struct ext2_dx_root_info *) (buf + 24);
299 fprintf(pager, "Root node dump:\n");
300 fprintf(pager, "\t Reserved zero: %u\n", rootnode->reserved_zero);
301 fprintf(pager, "\t Hash Version: %d\n", rootnode->hash_version);
302 fprintf(pager, "\t Info length: %d\n", rootnode->info_length);
303 fprintf(pager, "\t Indirect levels: %d\n", rootnode->indirect_levels);
304 fprintf(pager, "\t Flags: %d\n", rootnode->unused_flags);
306 ent = (struct ext2_dx_entry *)
307 ((char *)rootnode + rootnode->info_length);
309 errcode = ext2fs_dx_csum(current_fs, ino,
310 (struct ext2_dir_entry *) buf, &crc, NULL);
312 com_err("htree_dump_int_block", errcode,
313 "while calculating checksum for htree root\n");
314 crc = (unsigned int) -1;
316 htree_dump_int_node(current_fs, ino, &inode, rootnode, ent, crc,
317 buf + current_fs->blocksize,
318 rootnode->indirect_levels);
326 * This function prints the hash of a given file.
328 void do_dx_hash(int argc, char *argv[], int sci_idx EXT2FS_ATTR((unused)),
329 void *infop EXT2FS_ATTR((unused)))
331 ext2_dirhash_t hash, minor_hash;
334 int hash_version = 0;
337 const struct ext2fs_nls_table *encoding = NULL;
339 hash_seed[0] = hash_seed[1] = hash_seed[2] = hash_seed[3] = 0;
342 while ((c = getopt(argc, argv, "h:s:ce:")) != EOF) {
345 hash_version = e2p_string2hash(optarg);
346 if (hash_version < 0)
347 hash_version = atoi(optarg);
350 if (uuid_parse(optarg, (unsigned char *) hash_seed)) {
351 fprintf(stderr, "Invalid UUID format: %s\n",
357 hash_flags |= EXT4_CASEFOLD_FL;
360 encoding = ext2fs_load_nls_table(e2p_str2encoding(optarg));
362 fprintf(stderr, "Invalid encoding: %s\n",
371 if (optind != argc-1) {
373 com_err(argv[0], 0, "usage: dx_hash [-h hash_alg] "
374 "[-s hash_seed] [-c] [-e encoding] filename");
377 err = ext2fs_dirhash2(hash_version, argv[optind],
378 strlen(argv[optind]), encoding, hash_flags,
379 hash_seed, &hash, &minor_hash);
382 com_err(argv[0], err, "while calculating hash");
385 printf("Hash of %s is 0x%0x (minor 0x%0x)\n", argv[optind],
390 * Search for particular directory entry (useful for debugging very
391 * large hash tree directories that have lost some blocks from the
394 struct process_block_struct {
400 static int search_dir_block(ext2_filsys fs, blk64_t *blocknr,
401 e2_blkcnt_t blockcnt, blk64_t ref_blk,
402 int ref_offset, void *priv_data);
404 void do_dirsearch(int argc, char *argv[], int sci_idx EXT2FS_ATTR((unused)),
405 void *infop EXT2FS_ATTR((unused)))
408 struct process_block_struct pb;
410 if (check_fs_open(argv[0]))
414 com_err(0, 0, "Usage: dirsearch dir filename");
418 inode = string_to_inode(argv[1]);
422 pb.buf = malloc(current_fs->blocksize);
424 com_err("dirsearch", 0, "Couldn't allocate buffer");
427 pb.search_name = argv[2];
428 pb.len = strlen(pb.search_name);
430 ext2fs_block_iterate3(current_fs, inode, BLOCK_FLAG_READ_ONLY, 0,
431 search_dir_block, &pb);
437 static int search_dir_block(ext2_filsys fs, blk64_t *blocknr,
438 e2_blkcnt_t blockcnt,
439 blk64_t ref_blk EXT2FS_ATTR((unused)),
440 int ref_offset EXT2FS_ATTR((unused)),
443 struct process_block_struct *p;
444 struct ext2_dir_entry *dirent;
446 unsigned int offset = 0;
447 unsigned int rec_len;
452 p = (struct process_block_struct *) priv_data;
454 errcode = io_channel_read_blk64(current_fs->io, *blocknr, 1, p->buf);
456 com_err("search_dir_block", errcode,
457 "while reading block %lu", (unsigned long) *blocknr);
461 while (offset < fs->blocksize) {
462 dirent = (struct ext2_dir_entry *) (p->buf + offset);
463 errcode = ext2fs_get_rec_len(fs, dirent, &rec_len);
465 com_err("htree_dump_leaf_inode", errcode,
466 "while getting rec_len for block %lu",
467 (unsigned long) *blocknr);
471 p->len == ext2fs_dirent_name_len(dirent) &&
472 strncmp(p->search_name, dirent->name,
474 printf("Entry found at logical block %lld, "
475 "phys %llu, offset %u\n", (long long)blockcnt,
477 printf("offset %u\n", offset);