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