1 /*
2 * htree.c --- hash tree routines
3 *
4 * Copyright (C) 2002 Theodore Ts'o. This file may be redistributed
5 * under the terms of the GNU Public License.
6 */
7
8 #include "config.h"
9 #include <stdio.h>
10 #include <unistd.h>
11 #include <stdlib.h>
12 #include <ctype.h>
13 #include <string.h>
14 #include <time.h>
15 #ifdef HAVE_ERRNO_H
16 #include <errno.h>
17 #endif
18 #include <sys/types.h>
19 #ifdef HAVE_GETOPT_H
20 #include <getopt.h>
21 #else
22 extern int optind;
23 extern char *optarg;
24 #endif
25
26 #include "debugfs.h"
27 #include "uuid/uuid.h"
28 #include "e2p/e2p.h"
29
30 static FILE *pager;
31
htree_dump_leaf_node(ext2_filsys fs,ext2_ino_t ino,struct ext2_inode * inode,struct ext2_dx_root_info * rootnode,blk64_t blk,char * buf)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)
36 {
37 errcode_t errcode;
38 struct ext2_dir_entry *dirent;
39 int thislen, col = 0;
40 unsigned int offset = 0;
41 char name[EXT2_NAME_LEN + 1];
42 char tmp[EXT2_NAME_LEN + 64];
43 blk64_t pblk;
44 ext2_dirhash_t hash, minor_hash;
45 unsigned int rec_len;
46 int hash_alg;
47 int hash_flags = inode->i_flags & EXT4_CASEFOLD_FL;
48 int csum_size = 0;
49
50 if (ext2fs_has_feature_metadata_csum(fs->super))
51 csum_size = sizeof(struct ext2_dir_entry_tail);
52
53 errcode = ext2fs_bmap2(fs, ino, inode, buf, 0, blk, 0, &pblk);
54 if (errcode) {
55 com_err("htree_dump_leaf_node", errcode,
56 "while mapping logical block %llu\n", blk);
57 return;
58 }
59
60 fprintf(pager, "Reading directory block %llu, phys %llu\n", blk, pblk);
61 errcode = ext2fs_read_dir_block4(current_fs, pblk, buf, 0, ino);
62 if (errcode) {
63 com_err("htree_dump_leaf_node", errcode,
64 "while reading block %llu (%llu)\n",
65 blk, pblk);
66 return;
67 }
68 hash_alg = rootnode->hash_version;
69 if ((hash_alg <= EXT2_HASH_TEA) &&
70 (fs->super->s_flags & EXT2_FLAGS_UNSIGNED_HASH))
71 hash_alg += 3;
72
73 while (offset < fs->blocksize) {
74 dirent = (struct ext2_dir_entry *) (buf + offset);
75 errcode = ext2fs_get_rec_len(fs, dirent, &rec_len);
76 if (errcode) {
77 com_err("htree_dump_leaf_inode", errcode,
78 "while getting rec_len for block %lu",
79 (unsigned long) blk);
80 return;
81 }
82 thislen = ext2fs_dirent_name_len(dirent);
83 if (((offset + rec_len) > fs->blocksize) ||
84 (rec_len < 8) ||
85 ((rec_len % 4) != 0) ||
86 ((unsigned) thislen + 8 > rec_len)) {
87 fprintf(pager, "Corrupted directory block (%llu)!\n",
88 blk);
89 break;
90 }
91 strncpy(name, dirent->name, thislen);
92 name[thislen] = '\0';
93 errcode = ext2fs_dirhash2(hash_alg, name, thislen,
94 fs->encoding, hash_flags,
95 fs->super->s_hash_seed,
96 &hash, &minor_hash);
97 if (errcode)
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;
105
106 t = (struct ext2_dir_entry_tail *) dirent;
107
108 snprintf(tmp, EXT2_NAME_LEN + 64,
109 "leaf block checksum: 0x%08x ",
110 t->det_checksum);
111 } else {
112 snprintf(tmp, EXT2_NAME_LEN + 64,
113 "%u 0x%08x-%08x (%d) %s ",
114 dirent->inode, hash, minor_hash,
115 rec_len, name);
116 }
117 thislen = strlen(tmp);
118 if (col + thislen > 80) {
119 fprintf(pager, "\n");
120 col = 0;
121 }
122 fprintf(pager, "%s", tmp);
123 col += thislen;
124 offset += rec_len;
125 }
126 fprintf(pager, "\n");
127 }
128
129
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);
134
135
htree_dump_int_node(ext2_filsys fs,ext2_ino_t ino,struct ext2_inode * inode,struct ext2_dx_root_info * rootnode,struct ext2_dx_entry * ent,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,
140 char *buf, int level)
141 {
142 struct ext2_dx_countlimit dx_countlimit;
143 struct ext2_dx_tail *tail;
144 int hash, i;
145 int limit, count;
146 int remainder;
147
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);
151
152 fprintf(pager, "Number of entries (count): %d\n", count);
153 fprintf(pager, "Number of entries (limit): %d\n", limit);
154
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;
158 else
159 remainder -= 8;
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\n",
164 ext2fs_le32_to_cpu(tail->dt_checksum));
165 }
166
167 for (i=0; i < count; i++) {
168 hash = i ? ext2fs_le32_to_cpu(ent[i].hash) : 0;
169 fprintf(pager, "Entry #%d: Hash 0x%08x%s, block %u\n", i,
170 hash, (hash & 1) ? " (**)" : "",
171 ext2fs_le32_to_cpu(ent[i].block));
172 }
173
174 fprintf(pager, "\n");
175
176 for (i=0; i < count; i++) {
177 unsigned int hashval, block;
178
179 hashval = ext2fs_le32_to_cpu(ent[i].hash);
180 block = ext2fs_le32_to_cpu(ent[i].block);
181 fprintf(pager, "Entry #%d: Hash 0x%08x, block %u\n", i,
182 i ? hashval : 0, block);
183 if (level)
184 htree_dump_int_block(fs, ino, inode, rootnode,
185 block, buf, level-1);
186 else
187 htree_dump_leaf_node(fs, ino, inode, rootnode,
188 block, buf);
189 }
190
191 fprintf(pager, "---------------------\n");
192 }
193
htree_dump_int_block(ext2_filsys fs,ext2_ino_t ino,struct ext2_inode * inode,struct ext2_dx_root_info * rootnode,blk64_t blk,char * buf,int level)194 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
195 struct ext2_inode *inode,
196 struct ext2_dx_root_info * rootnode,
197 blk64_t blk, char *buf, int level)
198 {
199 char *cbuf;
200 errcode_t errcode;
201 blk64_t pblk;
202
203 cbuf = malloc(fs->blocksize);
204 if (!cbuf) {
205 fprintf(pager, "Couldn't allocate child block.\n");
206 return;
207 }
208
209 errcode = ext2fs_bmap2(fs, ino, inode, buf, 0, blk, 0, &pblk);
210 if (errcode) {
211 com_err("htree_dump_int_block", errcode,
212 "while mapping logical block %llu\n", blk);
213 goto errout;
214 }
215
216 errcode = io_channel_read_blk64(current_fs->io, pblk, 1, buf);
217 if (errcode) {
218 com_err("htree_dump_int_block", errcode,
219 "while reading block %llu\n", blk);
220 goto errout;
221 }
222
223 htree_dump_int_node(fs, ino, inode, rootnode,
224 (struct ext2_dx_entry *) (buf+8),
225 cbuf, level);
226 errout:
227 free(cbuf);
228 }
229
230
231
do_htree_dump(int argc,char * argv[],int sci_idx EXT2FS_ATTR ((unused)),void * infop EXT2FS_ATTR ((unused)))232 void do_htree_dump(int argc, char *argv[], int sci_idx EXT2FS_ATTR((unused)),
233 void *infop EXT2FS_ATTR((unused)))
234 {
235 ext2_ino_t ino;
236 struct ext2_inode inode;
237 blk64_t blk;
238 char *buf = NULL;
239 struct ext2_dx_root_info *rootnode;
240 struct ext2_dx_entry *ent;
241 errcode_t errcode;
242
243 if (check_fs_open(argv[0]))
244 return;
245
246 pager = open_pager();
247
248 if (common_inode_args_process(argc, argv, &ino, 0))
249 goto errout;
250
251 if (debugfs_read_inode(ino, &inode, argv[1]))
252 goto errout;
253
254 if (!LINUX_S_ISDIR(inode.i_mode)) {
255 com_err(argv[0], 0, "Not a directory");
256 goto errout;
257 }
258
259 if ((inode.i_flags & EXT2_BTREE_FL) == 0) {
260 com_err(argv[0], 0, "Not a hash-indexed directory");
261 goto errout;
262 }
263
264 buf = malloc(2*current_fs->blocksize);
265 if (!buf) {
266 com_err(argv[0], 0, "Couldn't allocate htree buffer");
267 goto errout;
268 }
269
270 errcode = ext2fs_bmap2(current_fs, ino, &inode, buf, 0, 0, 0, &blk);
271 if (errcode) {
272 com_err("do_htree_block", errcode,
273 "while mapping logical block 0\n");
274 goto errout;
275 }
276
277 errcode = io_channel_read_blk64(current_fs->io, blk,
278 1, buf);
279 if (errcode) {
280 com_err(argv[0], errcode, "Error reading root node");
281 goto errout;
282 }
283
284 rootnode = (struct ext2_dx_root_info *) (buf + 24);
285
286 fprintf(pager, "Root node dump:\n");
287 fprintf(pager, "\t Reserved zero: %u\n", rootnode->reserved_zero);
288 fprintf(pager, "\t Hash Version: %d\n", rootnode->hash_version);
289 fprintf(pager, "\t Info length: %d\n", rootnode->info_length);
290 fprintf(pager, "\t Indirect levels: %d\n", rootnode->indirect_levels);
291 fprintf(pager, "\t Flags: %d\n", rootnode->unused_flags);
292
293 ent = (struct ext2_dx_entry *)
294 ((char *)rootnode + rootnode->info_length);
295
296 htree_dump_int_node(current_fs, ino, &inode, rootnode, ent,
297 buf + current_fs->blocksize,
298 rootnode->indirect_levels);
299
300 errout:
301 free(buf);
302 close_pager(pager);
303 }
304
305 /*
306 * This function prints the hash of a given file.
307 */
do_dx_hash(int argc,char * argv[],int sci_idx EXT2FS_ATTR ((unused)),void * infop EXT2FS_ATTR ((unused)))308 void do_dx_hash(int argc, char *argv[], int sci_idx EXT2FS_ATTR((unused)),
309 void *infop EXT2FS_ATTR((unused)))
310 {
311 ext2_dirhash_t hash, minor_hash;
312 errcode_t err;
313 int c;
314 int hash_version = 0;
315 __u32 hash_seed[4];
316 int hash_flags = 0;
317 const struct ext2fs_nls_table *encoding = NULL;
318
319 hash_seed[0] = hash_seed[1] = hash_seed[2] = hash_seed[3] = 0;
320
321 reset_getopt();
322 while ((c = getopt(argc, argv, "h:s:ce:")) != EOF) {
323 switch (c) {
324 case 'h':
325 hash_version = e2p_string2hash(optarg);
326 if (hash_version < 0)
327 hash_version = atoi(optarg);
328 break;
329 case 's':
330 if (uuid_parse(optarg, (unsigned char *) hash_seed)) {
331 fprintf(stderr, "Invalid UUID format: %s\n",
332 optarg);
333 return;
334 }
335 break;
336 case 'c':
337 hash_flags |= EXT4_CASEFOLD_FL;
338 break;
339 case 'e':
340 encoding = ext2fs_load_nls_table(e2p_str2encoding(optarg));
341 if (!encoding) {
342 fprintf(stderr, "Invalid encoding: %s\n",
343 optarg);
344 return;
345 }
346 break;
347 default:
348 goto print_usage;
349 }
350 }
351 if (optind != argc-1) {
352 print_usage:
353 com_err(argv[0], 0, "usage: dx_hash [-h hash_alg] "
354 "[-s hash_seed] [-c] [-e encoding] filename");
355 return;
356 }
357 err = ext2fs_dirhash2(hash_version, argv[optind],
358 strlen(argv[optind]), encoding, hash_flags,
359 hash_seed, &hash, &minor_hash);
360
361 if (err) {
362 com_err(argv[0], err, "while calculating hash");
363 return;
364 }
365 printf("Hash of %s is 0x%0x (minor 0x%0x)\n", argv[optind],
366 hash, minor_hash);
367 }
368
369 /*
370 * Search for particular directory entry (useful for debugging very
371 * large hash tree directories that have lost some blocks from the
372 * btree index).
373 */
374 struct process_block_struct {
375 char *search_name;
376 char *buf;
377 int len;
378 };
379
380 static int search_dir_block(ext2_filsys fs, blk64_t *blocknr,
381 e2_blkcnt_t blockcnt, blk64_t ref_blk,
382 int ref_offset, void *priv_data);
383
do_dirsearch(int argc,char * argv[],int sci_idx EXT2FS_ATTR ((unused)),void * infop EXT2FS_ATTR ((unused)))384 void do_dirsearch(int argc, char *argv[], int sci_idx EXT2FS_ATTR((unused)),
385 void *infop EXT2FS_ATTR((unused)))
386 {
387 ext2_ino_t inode;
388 struct process_block_struct pb;
389
390 if (check_fs_open(argv[0]))
391 return;
392
393 if (argc != 3) {
394 com_err(0, 0, "Usage: dirsearch dir filename");
395 return;
396 }
397
398 inode = string_to_inode(argv[1]);
399 if (!inode)
400 return;
401
402 pb.buf = malloc(current_fs->blocksize);
403 if (!pb.buf) {
404 com_err("dirsearch", 0, "Couldn't allocate buffer");
405 return;
406 }
407 pb.search_name = argv[2];
408 pb.len = strlen(pb.search_name);
409
410 ext2fs_block_iterate3(current_fs, inode, BLOCK_FLAG_READ_ONLY, 0,
411 search_dir_block, &pb);
412
413 free(pb.buf);
414 }
415
416
search_dir_block(ext2_filsys fs,blk64_t * blocknr,e2_blkcnt_t blockcnt,blk64_t ref_blk EXT2FS_ATTR ((unused)),int ref_offset EXT2FS_ATTR ((unused)),void * priv_data)417 static int search_dir_block(ext2_filsys fs, blk64_t *blocknr,
418 e2_blkcnt_t blockcnt,
419 blk64_t ref_blk EXT2FS_ATTR((unused)),
420 int ref_offset EXT2FS_ATTR((unused)),
421 void *priv_data)
422 {
423 struct process_block_struct *p;
424 struct ext2_dir_entry *dirent;
425 errcode_t errcode;
426 unsigned int offset = 0;
427 unsigned int rec_len;
428
429 if (blockcnt < 0)
430 return 0;
431
432 p = (struct process_block_struct *) priv_data;
433
434 errcode = io_channel_read_blk64(current_fs->io, *blocknr, 1, p->buf);
435 if (errcode) {
436 com_err("search_dir_block", errcode,
437 "while reading block %lu", (unsigned long) *blocknr);
438 return BLOCK_ABORT;
439 }
440
441 while (offset < fs->blocksize) {
442 dirent = (struct ext2_dir_entry *) (p->buf + offset);
443 errcode = ext2fs_get_rec_len(fs, dirent, &rec_len);
444 if (errcode) {
445 com_err("htree_dump_leaf_inode", errcode,
446 "while getting rec_len for block %lu",
447 (unsigned long) *blocknr);
448 return BLOCK_ABORT;
449 }
450 if (dirent->inode &&
451 p->len == ext2fs_dirent_name_len(dirent) &&
452 strncmp(p->search_name, dirent->name,
453 p->len) == 0) {
454 printf("Entry found at logical block %lld, "
455 "phys %llu, offset %u\n", (long long)blockcnt,
456 *blocknr, offset);
457 printf("offset %u\n", offset);
458 return BLOCK_ABORT;
459 }
460 offset += rec_len;
461 }
462 return 0;
463 }
464
465