debugfs/htree.c

   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 <stdio.h>
   9 #include <unistd.h>
  10 #include <stdlib.h>
  11 #include <ctype.h>
  12 #include <string.h>
  13 #include <time.h>
  14 #ifdef HAVE_ERRNO_H
  15 #include <errno.h>
  16 #endif
  17 #include <sys/types.h>
  18 #ifdef HAVE_GETOPT_H
  19 #include <getopt.h>
  20 #else
  21 extern int optind;
  22 extern char *optarg;
  23 #endif
  24 #ifdef HAVE_OPTRESET
  25 extern int optreset;            /* defined by BSD, but not others */
  26 #endif
  27
  28 #include "debugfs.h"
  29
  30 static FILE *pager;
  31
  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                                  blk_t blk, char *buf)
  36 {
  37         errcode_t       errcode;
  38         struct ext2_dir_entry *dirent;
  39         int             thislen, col = 0, offset = 0;
  40         char            name[EXT2_NAME_LEN];
  41         char            tmp[EXT2_NAME_LEN + 16];
  42         blk_t           pblk;
  43         ext2_dirhash_t  hash;
  44
  45         errcode = ext2fs_bmap(fs, ino, inode, buf, 0, blk, &pblk);
  46         if (errcode) {
  47                 com_err("htree_dump_leaf_node", errcode,
  48                         "while mapping logical block %d\n", blk);
  49                 return;
  50         }
  51
  52         errcode = ext2fs_read_dir_block2(current_fs, pblk, buf, 0);
  53         if (errcode) {
  54                 com_err("htree_dump_leaf_node", errcode,
  55                         "while  reading block %d\n", blk);
  56                 return;
  57         }
  58
  59         while (offset < fs->blocksize) {
  60                 dirent = (struct ext2_dir_entry *) (buf + offset);
  61                 if (((offset + dirent->rec_len) > fs->blocksize) ||
  62                     (dirent->rec_len < 8) ||
  63                     ((dirent->rec_len % 4) != 0) ||
  64                     (((dirent->name_len & 0xFF)+8) > dirent->rec_len)) {
  65                         fprintf(pager, "Corrupted directory block (%d)!\n", blk);
  66                         break;
  67                 }
  68                 thislen = ((dirent->name_len & 0xFF) < EXT2_NAME_LEN) ?
  69                         (dirent->name_len & 0xFF) : EXT2_NAME_LEN;
  70                 strncpy(name, dirent->name, thislen);
  71                 name[thislen] = '\0';
  72                 errcode = ext2fs_dirhash(rootnode->hash_version, name,
  73                                          thislen, fs->super->s_hash_seed,
  74                                          &hash, 0);
  75                 if (errcode)
  76                         com_err("htree_dump_leaf_node", errcode,
  77                                 "while calculating hash");
  78                 sprintf(tmp, "%u 0x%08x (%d) %s   ", dirent->inode,
  79                         hash, dirent->rec_len, name);
  80                 thislen = strlen(tmp);
  81                 if (col + thislen > 80) {
  82                         fprintf(pager, "\n");
  83                         col = 0;
  84                 }
  85                 fprintf(pager, "%s", tmp);
  86                 col += thislen;
  87                 offset += dirent->rec_len;
  88         }
  89         fprintf(pager, "\n");
  90 }
  91
  92
  93 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
  94                                  struct ext2_inode *inode,
  95                                  struct ext2_dx_root_info * rootnode,
  96                                  blk_t blk, char *buf, int level);
  97
  98
  99 static void htree_dump_int_node(ext2_filsys fs, ext2_ino_t ino,
 100                                 struct ext2_inode *inode,
 101                                 struct ext2_dx_root_info * rootnode,
 102                                 struct ext2_dx_entry *ent,
 103                                 char *buf, int level)
 104 {
 105         struct ext2_dx_countlimit       limit;
 106         struct ext2_dx_entry            e;
 107         int                             hash, i;
 108
 109
 110         limit = *((struct ext2_dx_countlimit *) ent);
 111         limit.count = ext2fs_le16_to_cpu(limit.count);
 112         limit.limit = ext2fs_le16_to_cpu(limit.limit);
 113
 114         fprintf(pager, "Number of entries (count): %d\n", limit.count);
 115         fprintf(pager, "Number of entries (limit): %d\n", limit.limit);
 116
 117         for (i=0; i < limit.count; i++) {
 118                 hash = i ? ext2fs_le32_to_cpu(ent[i].hash) : 0;
 119                 fprintf(pager, "Entry #%d: Hash 0x%08x%s, block %d\n", i,
 120                         hash, (hash & 1) ? " (**)" : "",
 121                         ext2fs_le32_to_cpu(ent[i].block));
 122                 }
 123
 124         fprintf(pager, "\n");
 125
 126         for (i=0; i < limit.count; i++) {
 127                 e.hash = ext2fs_le32_to_cpu(ent[i].hash);
 128                 e.block = ext2fs_le32_to_cpu(ent[i].block);
 129                 fprintf(pager, "Entry #%d: Hash 0x%08x, block %d\n", i,
 130                        i ? e.hash : 0, e.block);
 131                 if (level)
 132                         htree_dump_int_block(fs, ino, inode, rootnode,
 133                                              e.block, buf, level-1);
 134                 else
 135                         htree_dump_leaf_node(fs, ino, inode, rootnode,
 136                                              e.block, buf);
 137         }
 138
 139         fprintf(pager, "---------------------\n");
 140 }
 141
 142 static void htree_dump_int_block(ext2_filsys fs, ext2_ino_t ino,
 143                                  struct ext2_inode *inode,
 144                                  struct ext2_dx_root_info * rootnode,
 145                                  blk_t blk, char *buf, int level)
 146 {
 147         char            *cbuf;
 148         errcode_t       errcode;
 149         blk_t           pblk;
 150
 151         cbuf = malloc(fs->blocksize);
 152         if (!cbuf) {
 153                 fprintf(pager, "Couldn't allocate child block.\n");
 154                 return;
 155         }
 156
 157         errcode = ext2fs_bmap(fs, ino, inode, buf, 0, blk, &pblk);
 158         if (errcode) {
 159                 com_err("htree_dump_int_block", errcode,
 160                         "while mapping logical block %d\n", blk);
 161                 return;
 162         }
 163
 164         errcode = io_channel_read_blk(current_fs->io, pblk, 1, buf);
 165         if (errcode) {
 166                 com_err("htree_dump_int_block", errcode,
 167                         "while  reading block %d\n", blk);
 168                 return;
 169         }
 170
 171         htree_dump_int_node(fs, ino, inode, rootnode,
 172                             (struct ext2_dx_entry *) (buf+8),
 173                             cbuf, level);
 174         free(cbuf);
 175 }
 176
 177
 178
 179 void do_htree_dump(int argc, char *argv[])
 180 {
 181         ext2_ino_t      ino;
 182         struct ext2_inode inode;
 183         int             c;
 184         int             long_opt;
 185         char            *buf = NULL;
 186         struct          ext2_dx_root_info  *rootnode;
 187         struct          ext2_dx_entry *ent;
 188         struct          ext2_dx_countlimit *limit;
 189         errcode_t       errcode;
 190
 191         if (check_fs_open(argv[0]))
 192                 return;
 193
 194         pager = open_pager();
 195
 196         optind = 0;
 197 #ifdef HAVE_OPTRESET
 198         optreset = 1;           /* Makes BSD getopt happy */
 199 #endif
 200         while ((c = getopt (argc, argv, "l")) != EOF) {
 201                 switch (c) {
 202                 case 'l':
 203                         long_opt++;
 204                         break;
 205                 }
 206         }
 207
 208         if (argc > optind+1) {
 209                 com_err(0, 0, "Usage: htree_dump [-l] file");
 210                 goto errout;
 211         }
 212
 213         if (argc == optind)
 214                 ino = cwd;
 215         else
 216                 ino = string_to_inode(argv[optind]);
 217         if (!ino)
 218                 goto errout;
 219
 220         if (debugfs_read_inode(ino, &inode, argv[1]))
 221                 goto errout;
 222
 223         if (!LINUX_S_ISDIR(inode.i_mode)) {
 224                 com_err(argv[0], 0, "Not a directory");
 225                 goto errout;
 226         }
 227
 228         if ((inode.i_flags & EXT2_BTREE_FL) == 0) {
 229                 com_err(argv[0], 0, "Not a hash-indexed directory");
 230                 goto errout;
 231         }
 232
 233         buf = malloc(2*current_fs->blocksize);
 234         if (!buf) {
 235                 com_err(argv[0], 0, "Couldn't allocate htree buffer");
 236                 goto errout;
 237         }
 238
 239         errcode = io_channel_read_blk(current_fs->io, inode.i_block[0],
 240                                       1, buf);
 241         if (errcode) {
 242                 com_err(argv[0], errcode, "Error reading root node");
 243                 goto errout;
 244         }
 245
 246         rootnode = (struct ext2_dx_root_info *) (buf + 24);
 247
 248         fprintf(pager, "Root node dump:\n");
 249         fprintf(pager, "\t Reserved zero: %d\n", rootnode->reserved_zero);
 250         fprintf(pager, "\t Hash Version: %d\n", rootnode->hash_version);
 251         fprintf(pager, "\t Info length: %d\n", rootnode->info_length);
 252         fprintf(pager, "\t Indirect levels: %d\n", rootnode->indirect_levels);
 253         fprintf(pager, "\t Flags: %d\n", rootnode->unused_flags);
 254
 255         ent = (struct ext2_dx_entry *) (buf + 24 + rootnode->info_length);
 256         limit = (struct ext2_dx_countlimit *) ent;
 257
 258         htree_dump_int_node(current_fs, ino, &inode, rootnode, ent,
 259                             buf + current_fs->blocksize,
 260                             rootnode->indirect_levels);
 261
 262 errout:
 263         if (buf)
 264                 free(buf);
 265         close_pager(pager);
 266 }
 267
 268 /*
 269  * This function prints the hash of a given file.
 270  */
 271 void do_dx_hash(int argc, char *argv[])
 272 {
 273         ext2_dirhash_t hash, minor_hash;
 274         errcode_t       err;
 275         int             c;
 276         int             hash_version = 0;
 277         __u32           hash_seed[4];
 278
 279         hash_seed[0] = hash_seed[1] = hash_seed[2] = hash_seed[3] = 0;
 280         optind = 0;
 281 #ifdef HAVE_OPTRESET
 282         optreset = 1;           /* Makes BSD getopt happy */
 283 #endif
 284         while ((c = getopt (argc, argv, "h:")) != EOF) {
 285                 switch (c) {
 286                 case 'h':
 287                         hash_version = atoi(optarg);
 288                         break;
 289                 }
 290         }
 291         if (optind != argc-1) {
 292                 com_err(argv[0], 0, "usage: dx_hash filename");
 293                 return;
 294         }
 295         err = ext2fs_dirhash(hash_version, argv[optind], strlen(argv[optind]),
 296                              hash_seed, &hash, &minor_hash);
 297         if (err) {
 298                 com_err(argv[0], err, "while caclulating hash");
 299                 return;
 300         }
 301         printf("Hash of %s is 0x%0x (minor 0x%0x)\n", argv[optind],
 302                hash, minor_hash);
 303 }
 304
 305 /*
 306  * Search for particular directory entry (useful for debugging very
 307  * large hash tree directories that have lost some blocks from the
 308  * btree index).
 309  */
 310 struct process_block_struct {
 311         char    *search_name;
 312         char    *buf;
 313         int     len;
 314 };
 315
 316 static int search_dir_block(ext2_filsys fs, blk_t *blocknr,
 317                             e2_blkcnt_t blockcnt, blk_t ref_blk,
 318                             int ref_offset, void *priv_data);
 319
 320 void do_dirsearch(int argc, char *argv[])
 321 {
 322         ext2_ino_t      inode;
 323         struct process_block_struct pb;
 324
 325         if (check_fs_open(argv[0]))
 326                 return;
 327
 328         if (argc != 3) {
 329                 com_err(0, 0, "Usage: dirsearch dir filename");
 330                 return;
 331         }
 332
 333         inode = string_to_inode(argv[1]);
 334         if (!inode)
 335                 return;
 336
 337         pb.buf = malloc(current_fs->blocksize);
 338         if (!pb.buf) {
 339                 com_err("dirsearch", 0, "Couldn't allocate buffer");
 340                 return;
 341         }
 342         pb.search_name = argv[2];
 343         pb.len = strlen(pb.search_name);
 344
 345         ext2fs_block_iterate2(current_fs, inode, 0, 0, search_dir_block, &pb);
 346
 347         free(pb.buf);
 348 }
 349
 350
 351 static int search_dir_block(ext2_filsys fs, blk_t *blocknr,
 352                             e2_blkcnt_t blockcnt, blk_t ref_blk,
 353                             int ref_offset, void *priv_data)
 354 {
 355         struct process_block_struct *p;
 356         struct ext2_dir_entry *dirent;
 357         errcode_t               errcode;
 358         int                     offset = 0;
 359
 360         if (blockcnt < 0)
 361                 return 0;
 362
 363         p = (struct process_block_struct *) priv_data;
 364
 365         errcode = io_channel_read_blk(current_fs->io, *blocknr, 1, p->buf);
 366         if (errcode) {
 367                 com_err("search_dir_block", errcode,
 368                         "while reading block %lu", *blocknr);
 369                 return BLOCK_ABORT;
 370         }
 371
 372         while (offset < fs->blocksize) {
 373                 dirent = (struct ext2_dir_entry *) (p->buf + offset);
 374
 375                 if (dirent->inode &&
 376                     p->len == (dirent->name_len & 0xFF) &&
 377                     strncmp(p->search_name, dirent->name,
 378                             p->len) == 0) {
 379                         printf("Entry found at logical block %lld, "
 380                                "phys %d, offset %d\n", blockcnt,
 381                                *blocknr, offset);
 382                         printf("offset %d\n", offset);
 383                         return BLOCK_ABORT;
 384                 }
 385                 offset += dirent->rec_len;
 386         }
 387         return 0;
 388 }
 389