2 * pass2.c --- check directory structure
4 * Copyright (C) 1993, 1994, 1995, 1996, 1997 Theodore Ts'o
7 * This file may be redistributed under the terms of the GNU Public
11 * Pass 2 of e2fsck iterates through all active directory inodes, and
12 * applies to following tests to each directory entry in the directory
13 * blocks in the inodes:
15 * - The length of the directory entry (rec_len) should be at
16 * least 8 bytes, and no more than the remaining space
17 * left in the directory block.
18 * - The length of the name in the directory entry (name_len)
19 * should be less than (rec_len - 8).
20 * - The inode number in the directory entry should be within
22 * - The inode number should refer to a in-use inode.
23 * - The first entry should be '.', and its inode should be
24 * the inode of the directory.
25 * - The second entry should be '..'.
27 * To minimize disk seek time, the directory blocks are processed in
28 * sorted order of block numbers.
30 * Pass 2 also collects the following information:
31 * - The inode numbers of the subdirectories for each directory.
33 * Pass 2 relies on the following information from previous passes:
34 * - The directory information collected in pass 1.
35 * - The inode_used_map bitmap
36 * - The inode_bad_map bitmap
37 * - The inode_dir_map bitmap
39 * Pass 2 frees the following data structures
40 * - The inode_bad_map bitmap
47 * Keeps track of how many times an inode is referenced.
49 static void deallocate_inode(e2fsck_t ctx, ino_t ino,
51 static int process_bad_inode(e2fsck_t ctx, ino_t dir, ino_t ino);
52 static int check_dir_block(ext2_filsys fs,
53 struct ext2_db_entry *dir_blocks_info,
55 static int allocate_dir_block(e2fsck_t ctx,
56 struct ext2_db_entry *dir_blocks_info,
57 char *buf, struct problem_context *pctx);
58 static int update_dir_block(ext2_filsys fs,
63 struct check_dir_struct {
65 struct problem_context pctx;
70 void e2fsck_pass2(e2fsck_t ctx)
72 ext2_filsys fs = ctx->fs;
75 struct resource_track rtrack;
78 struct check_dir_struct cd;
81 init_resource_track(&rtrack);
84 clear_problem_context(&cd.pctx);
87 mtrace_print("Pass 2");
90 if (!(ctx->options & E2F_OPT_PREEN))
91 fix_problem(ctx, PR_2_PASS_HEADER, &cd.pctx);
93 cd.pctx.errcode = ext2fs_create_icount2(fs, EXT2_ICOUNT_OPT_INCREMENT,
94 0, ctx->inode_link_info,
96 if (cd.pctx.errcode) {
97 fix_problem(ctx, PR_2_ALLOCATE_ICOUNT, &cd.pctx);
98 ctx->flags |= E2F_FLAG_ABORT;
101 buf = (char *) e2fsck_allocate_memory(ctx, fs->blocksize,
102 "directory scan buffer");
105 * Set up the parent pointer for the root directory, if
106 * present. (If the root directory is not present, we will
107 * create it in pass 3.)
109 dir = e2fsck_get_dir_info(ctx, EXT2_ROOT_INO);
111 dir->parent = EXT2_ROOT_INO;
116 cd.max = ext2fs_dblist_count(fs->dblist);
118 cd.pctx.errcode = ext2fs_dblist_iterate(fs->dblist, check_dir_block,
120 if (ctx->flags & E2F_FLAG_SIGNAL_MASK)
122 if (cd.pctx.errcode) {
123 fix_problem(ctx, PR_2_DBLIST_ITERATE, &cd.pctx);
124 ctx->flags |= E2F_FLAG_ABORT;
128 ext2fs_free_mem((void **) &buf);
129 ext2fs_free_dblist(fs->dblist);
131 if (ctx->inode_bad_map) {
132 ext2fs_free_inode_bitmap(ctx->inode_bad_map);
133 ctx->inode_bad_map = 0;
135 #ifdef RESOURCE_TRACK
136 if (ctx->options & E2F_OPT_TIME2)
137 print_resource_track("Pass 2", &rtrack);
142 * Make sure the first entry in the directory is '.', and that the
143 * directory entry is sane.
145 static int check_dot(e2fsck_t ctx,
146 struct ext2_dir_entry *dirent,
147 ino_t ino, struct problem_context *pctx)
149 struct ext2_dir_entry *nextdir;
156 problem = PR_2_MISSING_DOT;
157 else if (((dirent->name_len & 0xFF) != 1) ||
158 (dirent->name[0] != '.'))
159 problem = PR_2_1ST_NOT_DOT;
160 else if (dirent->name[1] != '\0')
161 problem = PR_2_DOT_NULL_TERM;
164 if (fix_problem(ctx, problem, pctx)) {
165 if (dirent->rec_len < 12)
166 dirent->rec_len = 12;
168 dirent->name_len = 1;
169 dirent->name[0] = '.';
170 dirent->name[1] = '\0';
175 if (dirent->inode != ino) {
176 if (fix_problem(ctx, PR_2_BAD_INODE_DOT, pctx)) {
181 if (dirent->rec_len > 12) {
182 new_len = dirent->rec_len - 12;
185 fix_problem(ctx, PR_2_SPLIT_DOT, pctx)) {
186 nextdir = (struct ext2_dir_entry *)
187 ((char *) dirent + 12);
188 dirent->rec_len = 12;
189 nextdir->rec_len = new_len;
191 nextdir->name_len = 0;
200 * Make sure the second entry in the directory is '..', and that the
201 * directory entry is sane. We do not check the inode number of '..'
202 * here; this gets done in pass 3.
204 static int check_dotdot(e2fsck_t ctx,
205 struct ext2_dir_entry *dirent,
206 struct dir_info *dir, struct problem_context *pctx)
211 problem = PR_2_MISSING_DOT_DOT;
212 else if (((dirent->name_len & 0xFF) != 2) ||
213 (dirent->name[0] != '.') ||
214 (dirent->name[1] != '.'))
215 problem = PR_2_2ND_NOT_DOT_DOT;
216 else if (dirent->name[2] != '\0')
217 problem = PR_2_DOT_DOT_NULL_TERM;
220 if (fix_problem(ctx, problem, pctx)) {
221 if (dirent->rec_len < 12)
222 dirent->rec_len = 12;
224 * Note: we don't have the parent inode just
225 * yet, so we will fill it in with the root
226 * inode. This will get fixed in pass 3.
228 dirent->inode = EXT2_ROOT_INO;
229 dirent->name_len = 2;
230 dirent->name[0] = '.';
231 dirent->name[1] = '.';
232 dirent->name[2] = '\0';
237 dir->dotdot = dirent->inode;
242 * Check to make sure a directory entry doesn't contain any illegal
245 static int check_name(e2fsck_t ctx,
246 struct ext2_dir_entry *dirent,
247 ino_t dir_ino, struct problem_context *pctx)
253 for ( i = 0; i < (dirent->name_len & 0xFF); i++) {
254 if (dirent->name[i] == '/' || dirent->name[i] == '\0') {
256 fixup = fix_problem(ctx, PR_2_BAD_NAME, pctx);
259 dirent->name[i] = '.';
267 static int check_dir_block(ext2_filsys fs,
268 struct ext2_db_entry *db,
271 struct dir_info *subdir, *dir;
272 struct ext2_dir_entry *dirent;
274 int dir_modified = 0;
276 blk_t block_nr = db->blk;
279 struct check_dir_struct *cd;
284 cd = (struct check_dir_struct *) priv_data;
289 if ((ctx->progress)(ctx, 2, cd->count++, cd->max))
293 * Make sure the inode is still in use (could have been
294 * deleted in the duplicate/bad blocks pass.
296 if (!(ext2fs_test_inode_bitmap(ctx->inode_used_map, ino)))
300 cd->pctx.blk = block_nr;
301 cd->pctx.blkcount = db->blockcnt;
307 if (allocate_dir_block(ctx, db, buf, &cd->pctx))
318 printf("In process_dir_block block %lu, #%d, inode %lu\n", block_nr,
322 cd->pctx.errcode = ext2fs_read_dir_block(fs, block_nr, buf);
323 if (cd->pctx.errcode) {
324 if (!fix_problem(ctx, PR_2_READ_DIRBLOCK, &cd->pctx)) {
325 ctx->flags |= E2F_FLAG_ABORT;
328 memset(buf, 0, fs->blocksize);
334 dirent = (struct ext2_dir_entry *) (buf + offset);
335 cd->pctx.dirent = dirent;
336 cd->pctx.num = offset;
337 if (((offset + dirent->rec_len) > fs->blocksize) ||
338 (dirent->rec_len < 8) ||
339 ((dirent->rec_len % 4) != 0) ||
340 (((dirent->name_len & 0xFF)+8) > dirent->rec_len)) {
341 if (fix_problem(ctx, PR_2_DIR_CORRUPTED, &cd->pctx)) {
342 dirent->rec_len = fs->blocksize - offset;
343 dirent->name_len = 0;
349 if ((dirent->name_len & 0xFF) > EXT2_NAME_LEN) {
350 if (fix_problem(ctx, PR_2_FILENAME_LONG, &cd->pctx)) {
351 dirent->name_len = EXT2_NAME_LEN;
356 if (dot_state == 1) {
357 if (check_dot(ctx, dirent, ino, &cd->pctx))
359 } else if (dot_state == 2) {
360 dir = e2fsck_get_dir_info(ctx, ino);
362 fix_problem(ctx, PR_2_NO_DIRINFO, &cd->pctx);
363 ctx->flags |= E2F_FLAG_ABORT;
366 if (check_dotdot(ctx, dirent, dir, &cd->pctx))
368 } else if (dirent->inode == ino) {
369 problem = PR_2_LINK_DOT;
370 if (fix_problem(ctx, PR_2_LINK_DOT, &cd->pctx)) {
380 * Make sure the inode listed is a legal one.
382 if (((dirent->inode != EXT2_ROOT_INO) &&
383 (dirent->inode < EXT2_FIRST_INODE(fs->super))) ||
384 (dirent->inode > fs->super->s_inodes_count)) {
385 problem = PR_2_BAD_INO;
386 } else if (!(ext2fs_test_inode_bitmap(ctx->inode_used_map,
389 * If the inode is unused, offer to clear it.
391 problem = PR_2_UNUSED_INODE;
392 } else if (ctx->inode_bb_map &&
393 (ext2fs_test_inode_bitmap(ctx->inode_bb_map,
396 * If the inode is in a bad block, offer to
399 problem = PR_2_BB_INODE;
400 } else if ((dot_state > 2) &&
401 ((dirent->name_len & 0xFF) == 1) &&
402 (dirent->name[0] == '.')) {
404 * If there's a '.' entry in anything other
405 * than the first directory entry, it's a
406 * duplicate entry that should be removed.
408 problem = PR_2_DUP_DOT;
409 } else if ((dot_state > 2) &&
410 ((dirent->name_len & 0xFF) == 2) &&
411 (dirent->name[0] == '.') &&
412 (dirent->name[1] == '.')) {
414 * If there's a '..' entry in anything other
415 * than the second directory entry, it's a
416 * duplicate entry that should be removed.
418 problem = PR_2_DUP_DOT_DOT;
419 } else if ((dot_state > 2) &&
420 (dirent->inode == EXT2_ROOT_INO)) {
422 * Don't allow links to the root directory.
423 * We check this specially to make sure we
424 * catch this error case even if the root
425 * directory hasn't been created yet.
427 problem = PR_2_LINK_ROOT;
431 if (fix_problem(ctx, problem, &cd->pctx)) {
436 ext2fs_unmark_valid(fs);
437 if (problem == PR_2_BAD_INO)
443 * If the inode was marked as having bad fields in
444 * pass1, process it and offer to fix/clear it.
445 * (We wait until now so that we can display the
446 * pathname to the user.)
448 if (ctx->inode_bad_map &&
449 ext2fs_test_inode_bitmap(ctx->inode_bad_map,
451 if (process_bad_inode(ctx, ino, dirent->inode)) {
456 if (ctx->flags & E2F_FLAG_SIGNAL_MASK)
460 if (check_name(ctx, dirent, ino, &cd->pctx))
464 * If this is a directory, then mark its parent in its
465 * dir_info structure. If the parent field is already
466 * filled in, then this directory has more than one
467 * hard link. We assume the first link is correct,
468 * and ask the user if he/she wants to clear this one.
470 if ((dot_state > 2) &&
471 (ext2fs_test_inode_bitmap(ctx->inode_dir_map,
473 subdir = e2fsck_get_dir_info(ctx, dirent->inode);
475 cd->pctx.ino = dirent->inode;
476 fix_problem(ctx, PR_2_NO_DIRINFO, &cd->pctx);
477 ctx->flags |= E2F_FLAG_ABORT;
480 if (subdir->parent) {
481 cd->pctx.ino2 = subdir->parent;
482 if (fix_problem(ctx, PR_2_LINK_DIR,
490 subdir->parent = ino;
493 ext2fs_icount_increment(ctx->inode_count, dirent->inode,
496 ctx->fs_links_count++;
497 ctx->fs_total_count++;
499 offset += dirent->rec_len;
500 } while (offset < fs->blocksize);
504 if (offset != fs->blocksize) {
505 cd->pctx.num = dirent->rec_len - fs->blocksize + offset;
506 if (fix_problem(ctx, PR_2_FINAL_RECLEN, &cd->pctx)) {
507 dirent->rec_len = cd->pctx.num;
512 cd->pctx.errcode = ext2fs_write_dir_block(fs, block_nr, buf);
513 if (cd->pctx.errcode) {
514 if (!fix_problem(ctx, PR_2_WRITE_DIRBLOCK,
516 ctx->flags |= E2F_FLAG_ABORT;
520 ext2fs_mark_changed(fs);
526 * This function is called to deallocate a block, and is an interator
527 * functioned called by deallocate inode via ext2fs_iterate_block().
529 static int deallocate_inode_block(ext2_filsys fs,
534 e2fsck_t ctx = (e2fsck_t) priv_data;
538 ext2fs_unmark_block_bitmap(ctx->block_found_map, *block_nr);
539 ext2fs_unmark_block_bitmap(fs->block_map, *block_nr);
544 * This fuction deallocates an inode
546 static void deallocate_inode(e2fsck_t ctx, ino_t ino,
549 ext2_filsys fs = ctx->fs;
550 struct ext2_inode inode;
551 struct problem_context pctx;
553 ext2fs_icount_store(ctx->inode_link_info, ino, 0);
554 e2fsck_read_inode(ctx, ino, &inode, "deallocate_inode");
555 inode.i_links_count = 0;
556 inode.i_dtime = time(0);
557 e2fsck_write_inode(ctx, ino, &inode, "deallocate_inode");
558 clear_problem_context(&pctx);
562 * Fix up the bitmaps...
564 e2fsck_read_bitmaps(ctx);
565 ext2fs_unmark_inode_bitmap(ctx->inode_used_map, ino);
566 ext2fs_unmark_inode_bitmap(ctx->inode_dir_map, ino);
567 if (ctx->inode_bad_map)
568 ext2fs_unmark_inode_bitmap(ctx->inode_bad_map, ino);
569 ext2fs_unmark_inode_bitmap(fs->inode_map, ino);
570 ext2fs_mark_ib_dirty(fs);
572 if (!ext2fs_inode_has_valid_blocks(&inode))
575 ext2fs_mark_bb_dirty(fs);
576 pctx.errcode = ext2fs_block_iterate(fs, ino, 0, block_buf,
577 deallocate_inode_block, ctx);
579 fix_problem(ctx, PR_2_DEALLOC_INODE, &pctx);
580 ctx->flags |= E2F_FLAG_ABORT;
585 static int process_bad_inode(e2fsck_t ctx, ino_t dir, ino_t ino)
587 ext2_filsys fs = ctx->fs;
588 struct ext2_inode inode;
589 int inode_modified = 0;
590 unsigned char *frag, *fsize;
591 struct problem_context pctx;
594 e2fsck_read_inode(ctx, ino, &inode, "process_bad_inode");
596 clear_problem_context(&pctx);
601 if (!LINUX_S_ISDIR(inode.i_mode) && !LINUX_S_ISREG(inode.i_mode) &&
602 !LINUX_S_ISCHR(inode.i_mode) && !LINUX_S_ISBLK(inode.i_mode) &&
603 !LINUX_S_ISLNK(inode.i_mode) && !LINUX_S_ISFIFO(inode.i_mode) &&
604 !(LINUX_S_ISSOCK(inode.i_mode)))
605 problem = PR_2_BAD_MODE;
607 if (LINUX_S_ISCHR(inode.i_mode)
608 && !e2fsck_pass1_check_device_inode(&inode))
609 problem = PR_2_BAD_CHAR_DEV;
611 if (LINUX_S_ISBLK(inode.i_mode)
612 && !e2fsck_pass1_check_device_inode(&inode))
613 problem = PR_2_BAD_BLOCK_DEV;
616 if (fix_problem(ctx, problem, &pctx)) {
617 deallocate_inode(ctx, ino, 0);
618 if (ctx->flags & E2F_FLAG_SIGNAL_MASK)
626 fix_problem(ctx, PR_2_FADDR_ZERO, &pctx)) {
631 switch (fs->super->s_creator_os) {
633 frag = &inode.osd2.linux2.l_i_frag;
634 fsize = &inode.osd2.linux2.l_i_fsize;
637 frag = &inode.osd2.hurd2.h_i_frag;
638 fsize = &inode.osd2.hurd2.h_i_fsize;
641 frag = &inode.osd2.masix2.m_i_frag;
642 fsize = &inode.osd2.masix2.m_i_fsize;
649 if (fix_problem(ctx, PR_2_FRAG_ZERO, &pctx)) {
655 if (fsize && *fsize) {
657 if (fix_problem(ctx, PR_2_FSIZE_ZERO, &pctx)) {
664 if (inode.i_file_acl &&
665 fix_problem(ctx, PR_2_FILE_ACL_ZERO, &pctx)) {
666 inode.i_file_acl = 0;
669 if (inode.i_dir_acl &&
670 LINUX_S_ISDIR(inode.i_mode) &&
671 fix_problem(ctx, PR_2_DIR_ACL_ZERO, &pctx)) {
676 e2fsck_write_inode(ctx, ino, &inode, "process_bad_inode");
682 * allocate_dir_block --- this function allocates a new directory
683 * block for a particular inode; this is done if a directory has
684 * a "hole" in it, or if a directory has a illegal block number
685 * that was zeroed out and now needs to be replaced.
687 static int allocate_dir_block(e2fsck_t ctx,
688 struct ext2_db_entry *db,
689 char *buf, struct problem_context *pctx)
691 ext2_filsys fs = ctx->fs;
694 struct ext2_inode inode;
696 if (fix_problem(ctx, PR_2_DIRECTORY_HOLE, pctx) == 0)
700 * Read the inode and block bitmaps in; we'll be messing with
703 e2fsck_read_bitmaps(ctx);
706 * First, find a free block
708 pctx->errcode = ext2fs_new_block(fs, 0, ctx->block_found_map, &blk);
710 pctx->str = "ext2fs_new_block";
711 fix_problem(ctx, PR_2_ALLOC_DIRBOCK, pctx);
714 ext2fs_mark_block_bitmap(ctx->block_found_map, blk);
715 ext2fs_mark_block_bitmap(fs->block_map, blk);
716 ext2fs_mark_bb_dirty(fs);
719 * Now let's create the actual data block for the inode
722 pctx->errcode = ext2fs_new_dir_block(fs, 0, 0, &block);
724 pctx->errcode = ext2fs_new_dir_block(fs, db->ino,
725 EXT2_ROOT_INO, &block);
728 pctx->str = "ext2fs_new_dir_block";
729 fix_problem(ctx, PR_2_ALLOC_DIRBOCK, pctx);
733 pctx->errcode = ext2fs_write_dir_block(fs, blk, block);
734 ext2fs_free_mem((void **) &block);
736 pctx->str = "ext2fs_write_dir_block";
737 fix_problem(ctx, PR_2_ALLOC_DIRBOCK, pctx);
742 * Update the inode block count
744 e2fsck_read_inode(ctx, db->ino, &inode, "allocate_dir_block");
745 inode.i_blocks += fs->blocksize / 512;
746 if (inode.i_size < (db->blockcnt+1) * fs->blocksize)
747 inode.i_size = (db->blockcnt+1) * fs->blocksize;
748 e2fsck_write_inode(ctx, db->ino, &inode, "allocate_dir_block");
751 * Finally, update the block pointers for the inode
754 pctx->errcode = ext2fs_block_iterate(fs, db->ino, BLOCK_FLAG_HOLE,
755 0, update_dir_block, db);
757 pctx->str = "ext2fs_block_iterate";
758 fix_problem(ctx, PR_2_ALLOC_DIRBOCK, pctx);
766 * This is a helper function for allocate_dir_block().
768 static int update_dir_block(ext2_filsys fs,
773 struct ext2_db_entry *db;
775 db = (struct ext2_db_entry *) priv_data;
776 if (db->blockcnt == blockcnt) {
778 return BLOCK_CHANGED;