filesystems-checker

File System Checking

In this assignment, you will be developing a working file system checker. A checker reads in a file system image and makes sure that it is consistent. When it isn't, the checker takes steps to repair the problems it sees; however, you won't be doing any repairs to keep this project a little simpler.

Patrick Sharp created a better version of this project here; when we get unlazy we will incorporate what he has done here. Thanks Patrick!

Background

Some basic background about file system consistency is found here:

• Crash Consistency: FSCK and Journaling

For those of you who are really interested, some research papers also make for a fun read:

• The Original FSCK Paper
• Our Work on a SQL-Based Checker
• Our Work on a Faster File System Checker and subsequent follow-up by McKusick on the BSD Implementation

A Basic Checker

For this project, you will use the xv6 file system image as the basic image that you will be reading and checking. The file include/fs.h includes the basic structures you need to understand, including the superblock, on disk inode format (struct dinode), and directory entry format (struct dirent). The tool tools/mkfs.c will also be useful to look at, in order to see how an empty file-system image is created.

Much of this project will be puzzling out the exact on-disk format xv6 uses for its simple file system, and then writing checks to see if various parts of that structure are consistent. Thus, reading through mkfs.c and the file system code itself will help you understand how xv6 uses the bits in the image to record persistent information.

Your checker should read through the file system image and determine the consistency of a number of things, including the following. When a problem is detected, print the error message (shown below) to standard error and exit immediately with exit code 1 (i.e., call exit(1)).

1. Each inode is either unallocated or one of the valid types (T_FILE, T_DIR, T_DEV). If not, print ERROR: bad inode.

2. For in-use inodes, each address that is used by inode is valid (points to a valid datablock address within the image). If the direct block is used and is invalid, print ERROR: bad direct address in inode.; if the indirect block is in use and is invalid, print ERROR: bad indirect address in inode.

3. Root directory exists, its inode number is 1, and the parent of the root directory is itself. If not, print ERROR: root directory does not exist.

4. Each directory contains . and .. entries, and the . entry points to the directory itself. If not, print ERROR: directory not properly formatted.

5. For in-use inodes, each address in use is also marked in use in the bitmap. If not, print ERROR: address used by inode but marked free in bitmap.

6. For blocks marked in-use in bitmap, the block should actually be in-use in an inode or indirect block somewhere. If not, print ERROR: bitmap marks block in use but it is not in use.

7. For in-use inodes, each direct address in use is only used once. If not, print ERROR: direct address used more than once.

8. For in-use inodes, each indirect address in use is only used once. If not, print ERROR: indirect address used more than once.

9. For all inodes marked in use, each must be referred to in at least one directory. If not, print ERROR: inode marked use but not found in a directory.

10. For each inode number that is referred to in a valid directory, it is actually marked in use. If not, print ERROR: inode referred to in directory but marked free.

11. Reference counts (number of links) for regular files match the number of times file is referred to in directories (i.e., hard links work correctly). If not, print ERROR: bad reference count for file.

12. No extra links allowed for directories (each directory only appears in one other directory). If not, print ERROR: directory appears more than once in file system.

Other Specifications

Your checker program, called xcheck, must be invoked exactly as follows:

prompt> xcheck file_system_image

The image file is a file that contains the file system image. If no image file is provided, you should print the usage error shown below:

prompt> xcheck 
Usage: xcheck <file_system_image> 

This output must be printed to standard error and exit with the error code of 1.

If the file system image does not exist, you should print the error image not found. to standard error and exit with the error code of 1.

If the checker detects any one of the 12 errors above, it should print the specific error to standard error and exit with error code 1.

If the checker detects none of the problems listed above, it should exit with return code of 0 and not print anything.

Hints

It may be worth looking into using mmap() for the project. Like, seriously, use mmap() to access the file-system image, it will make your life so much better.

It should be very helpful to read Chapter 6 of the xv6 book here. Note that the version of xv6 we're using does not include the logging feature described in the book; you can safely ignore the parts that pertain to that.

Make sure to look at fs.img, which is a file system image created when you make xv6 by the tool mkfs (found in the tools/ directory of xv6). The output of this tool is the file fs.img and it is a consistent file-system image. The tests, of course, will put inconsistencies into this image, but your tool should work over a consistent image as well. Study mkfs and its output to begin to make progress on this project.