PTE_SHARE added.

[mit-jos.git] / fs / fs.c

#include <inc/string.h>

#include "fs.h"

struct Super *super;            // superblock
uint32_t *bitmap;               // bitmap blocks mapped in memory

void file_flush(struct File *f);
bool block_is_free(uint32_t blockno);

// Return the virtual address of this disk block.
char*
diskaddr(uint32_t blockno)
{
        if (super && blockno >= super->s_nblocks)
                panic("bad block number %08x in diskaddr", blockno);
        return (char*) (DISKMAP + blockno * BLKSIZE);
}

// Is this virtual address mapped?
bool
va_is_mapped(void *va)
{
        return (vpd[PDX(va)] & PTE_P) && (vpt[VPN(va)] & PTE_P);
}

// Is this disk block mapped?
bool
block_is_mapped(uint32_t blockno)
{
        char *va = diskaddr(blockno);
        return va_is_mapped(va) && va != 0;
}

// Is this virtual address dirty?
bool
va_is_dirty(void *va)
{
        return (vpt[VPN(va)] & PTE_D) != 0;
}

// Is this block dirty?
bool
block_is_dirty(uint32_t blockno)
{
        char *va = diskaddr(blockno);
        return va_is_mapped(va) && va_is_dirty(va);
}

// Allocate a page to hold the disk block
int
map_block(uint32_t blockno)
{
        if (block_is_mapped(blockno))
                return 0;
        return sys_page_alloc(0, diskaddr(blockno), PTE_U|PTE_P|PTE_W|PTE_SHARE);
}

// Make sure a particular disk block is loaded into memory.
// Returns 0 on success, or a negative error code on error.
// 
// If blk != 0, set *blk to the address of the block in memory.
//
// Hint: Use diskaddr, map_block, and ide_read.
static int
read_block(uint32_t blockno, char **blk)
{
        int r;
        char *addr;

        if (super && blockno >= super->s_nblocks)
                panic("reading non-existent block %08x\n", blockno);

        if (bitmap && block_is_free(blockno))
                panic("reading free block %08x\n", blockno);

        // LAB 5: Your code here.
        if ((r = map_block(blockno)) < 0)
                return r;

        if ((r = ide_read(blockno * BLKSECTS, diskaddr(blockno), BLKSECTS)) < 0)
                return r;

        if (blk)
                *blk = diskaddr(blockno);

        return 0;
}

// Copy the current contents of the block out to disk.
// Then clear the PTE_D bit using sys_page_map.
// Hint: Use ide_write.
// Hint: Use the PTE_USER constant when calling sys_page_map.
void
write_block(uint32_t blockno)
{
        char *addr;
        int r;

        if (!block_is_mapped(blockno))
                panic("write unmapped block %08x", blockno);
        
        // Write the disk block and clear PTE_D.
        // LAB 5: Your code here.
        addr = diskaddr(blockno);
        if ((r = ide_write(blockno * BLKSECTS, addr, BLKSECTS)) < 0)
                panic("ide write error: %e", r);
        if ((r = sys_page_map(0, addr, 0, addr, PTE_USER)) < 0)
                panic("sys page map error: %e", r);
}

// Make sure this block is unmapped.
void
unmap_block(uint32_t blockno)
{
        int r;

        if (!block_is_mapped(blockno))
                return;

        assert(block_is_free(blockno) || !block_is_dirty(blockno));

        if ((r = sys_page_unmap(0, diskaddr(blockno))) < 0)
                panic("unmap_block: sys_mem_unmap: %e", r);
        assert(!block_is_mapped(blockno));
}

// Check to see if the block bitmap indicates that block 'blockno' is free.
// Return 1 if the block is free, 0 if not.
bool
block_is_free(uint32_t blockno)
{
        if (super == 0 || blockno >= super->s_nblocks)
                return 0;
        if (bitmap[blockno / 32] & (1 << (blockno % 32)))
                return 1;
        return 0;
}

// Mark a block free in the bitmap
void
free_block(uint32_t blockno)
{
        // Blockno zero is the null pointer of block numbers.
        if (blockno == 0)
                panic("attempt to free zero block");
        bitmap[blockno/32] |= 1<<(blockno%32);
}

// Search the bitmap for a free block and allocate it.
// 
// Return block number allocated on success,
// -E_NO_DISK if we are out of blocks.
int
alloc_block_num(void)
{
        // LAB 5: Your code here.
        int i;

        for (i = 0; i < super->s_nblocks; i++) {
                if (block_is_free(i)) {
                        bitmap[i / 32] &= ~(1 << (i % 32));
                        write_block(i / BLKBITSIZE + 2);
                        return i;
                }
        }
        return -E_NO_DISK;
}

// Allocate a block -- first find a free block in the bitmap,
// then map it into memory.
int
alloc_block(void)
{
        int r, bno;

        if ((r = alloc_block_num()) < 0)
                return r;
        bno = r;

        if ((r = map_block(bno)) < 0) {
                free_block(bno);
                return r;
        }
        return bno;
}

// Read and validate the file system super-block.
void
read_super(void)
{
        int r;
        char *blk;

        if ((r = read_block(1, &blk)) < 0)
                panic("cannot read superblock: %e", r);

        super = (struct Super*) blk;
        if (super->s_magic != FS_MAGIC)
                panic("bad file system magic number");

        if (super->s_nblocks > DISKSIZE/BLKSIZE)
                panic("file system is too large");

        cprintf("superblock is good\n");
}

// Read and validate the file system bitmap.
//
// Read all the bitmap blocks into memory.
// Set the "bitmap" pointer to point at the beginning of the first
// bitmap block.
// 
// Check that all reserved blocks -- 0, 1, and the bitmap blocks themselves --
// are all marked as in-use
// (for each block i, assert(!block_is_free(i))).
//
// Hint: Assume that the superblock has already been loaded into
// memory (in variable 'super').  Check out super->s_nblocks.
void
read_bitmap(void)
{
        int r;
        uint32_t i, n;
        char *blk;

        // Read the bitmap into memory.
        // The bitmap consists of one or more blocks.  A single bitmap block
        // contains the in-use bits for BLKBITSIZE blocks.  There are
        // super->s_nblocks blocks in the disk altogether.
        // Set 'bitmap' to point to the first address in the bitmap.
        // Hint: Use read_block.

        // LAB 5: Your code here.
        n = super->s_nblocks / BLKBITSIZE;
        cprintf("read the nblocks: %d.\n", n);
        read_block(2, &blk);
        bitmap = (uint32_t *)blk;
        for (i = 1; i < n; i++)
                read_block(i + 2, NULL);

        // Make sure the reserved and root blocks are marked in-use.
        assert(!block_is_free(0));
        assert(!block_is_free(1));
        assert(bitmap);

        // Make sure that the bitmap blocks are marked in-use.
        // LAB 5: Your code here.
        for (i = 0; i < n; i++)
                assert(!block_is_free(i + 2));

        cprintf("read_bitmap is good\n");
}

// Test that write_block works, by smashing the superblock and reading it back.
void
check_write_block(void)
{
        super = 0;

        // back up super block
        read_block(0, 0);
        memmove(diskaddr(0), diskaddr(1), PGSIZE);

        // smash it 
        strcpy(diskaddr(1), "OOPS!\n");
        write_block(1);
        assert(block_is_mapped(1));
        assert(!va_is_dirty(diskaddr(1)));

        // clear it out
        sys_page_unmap(0, diskaddr(1));
        assert(!block_is_mapped(1));

        // read it back in
        read_block(1, 0);
        assert(strcmp(diskaddr(1), "OOPS!\n") == 0);

        // fix it
        memmove(diskaddr(1), diskaddr(0), PGSIZE);
        write_block(1);
        super = (struct Super*)diskaddr(1);

        cprintf("write_block is good\n");
}

// Initialize the file system
void
fs_init(void)
{
        static_assert(sizeof(struct File) == 256);

        // Find a JOS disk.  Use the second IDE disk (number 1) if available.
        if (ide_probe_disk1())
                ide_set_disk(1);
        else
                ide_set_disk(0);
        
        read_super();
        check_write_block();
        read_bitmap();
}

// Find the disk block number slot for the 'filebno'th block in file 'f'.
// Set '*ppdiskbno' to point to that slot.
// The slot will be one of the f->f_direct[] entries,
// or an entry in the indirect block.
// When 'alloc' is set, this function will allocate an indirect block
// if necessary.
//
// Returns:
//      0 on success (but note that *ppdiskbno might equal 0).
//      -E_NOT_FOUND if the function needed to allocate an indirect block, but
//              alloc was 0.
//      -E_NO_DISK if there's no space on the disk for an indirect block.
//      -E_NO_MEM if there's no space in memory for an indirect block.
//      -E_INVAL if filebno is out of range (it's >= NINDIRECT).
//
// Analogy: This is like pgdir_walk for files.  
int
file_block_walk(struct File *f, uint32_t filebno, uint32_t **ppdiskbno, bool alloc)
{
        int r;
        uint32_t *ptr;
        char *blk;

        if (filebno < NDIRECT)
                ptr = &f->f_direct[filebno];
        else if (filebno < NINDIRECT) {
                if (f->f_indirect == 0) {
                        if (alloc == 0)
                                return -E_NOT_FOUND;
                        if ((r = alloc_block()) < 0)
                                return r;
                        f->f_indirect = r;
                } else
                        alloc = 0;      // we did not allocate a block
                if ((r = read_block(f->f_indirect, &blk)) < 0)
                        return r;
                assert(blk != 0);
                if (alloc)              // must clear any block we allocated
                        memset(blk, 0, BLKSIZE);
                ptr = (uint32_t*)blk + filebno;
        } else
                return -E_INVAL;

        *ppdiskbno = ptr;
        return 0;
}

// Set '*diskbno' to the disk block number for the 'filebno'th block
// in file 'f'.
// If 'alloc' is set and the block does not exist, allocate it.
//
// Returns 0 on success, < 0 on error.  Errors are:
//      -E_NOT_FOUND if alloc was 0 but the block did not exist.
//      -E_NO_DISK if a block needed to be allocated but the disk is full.
//      -E_NO_MEM if we're out of memory.
//      -E_INVAL if filebno is out of range.
int
file_map_block(struct File *f, uint32_t filebno, uint32_t *diskbno, bool alloc)
{
        int r;
        uint32_t *ptr;

        if ((r = file_block_walk(f, filebno, &ptr, alloc)) < 0)
                return r;
        if (*ptr == 0) {
                if (alloc == 0)
                        return -E_NOT_FOUND;
                if ((r = alloc_block()) < 0)
                        return r;
                *ptr = r;
        }
        *diskbno = *ptr;
        return 0;
}

// Remove a block from file f.  If it's not there, just silently succeed.
// Returns 0 on success, < 0 on error.
int
file_clear_block(struct File *f, uint32_t filebno)
{
        int r;
        uint32_t *ptr;

        if ((r = file_block_walk(f, filebno, &ptr, 0)) < 0)
                return r;
        if (*ptr) {
                free_block(*ptr);
                *ptr = 0;
        }
        return 0;
}

// Set *blk to point at the filebno'th block in file 'f'.
// Allocate the block if it doesn't yet exist.
// Returns 0 on success, < 0 on error.
int
file_get_block(struct File *f, uint32_t filebno, char **blk)
{
        int r;
        uint32_t diskbno;

        // Read in the block, leaving the pointer in *blk.
        // Hint: Use file_map_block and read_block.
        // LAB 5: Your code here.
        if ((r = file_map_block(f, filebno, &diskbno, 1)) < 0)
                return r;
        if ((r = read_block(diskbno, blk)) < 0)
                return r;
        return 0;
}

// Mark the offset/BLKSIZE'th block dirty in file f
// by writing its first word to itself.  
int
file_dirty(struct File *f, off_t offset)
{
        int r;
        char *blk;

        if ((r = file_get_block(f, offset/BLKSIZE, &blk)) < 0)
                return r;
        *(volatile char*)blk = *(volatile char*)blk;
        return 0;
}

// Try to find a file named "name" in dir.  If so, set *file to it.
int
dir_lookup(struct File *dir, const char *name, struct File **file)
{
        int r;
        uint32_t i, j, nblock;
        char *blk;
        struct File *f;

        // Search dir for name.
        // We maintain the invariant that the size of a directory-file
        // is always a multiple of the file system's block size.
        assert((dir->f_size % BLKSIZE) == 0);
        nblock = dir->f_size / BLKSIZE;
        for (i = 0; i < nblock; i++) {
                if ((r = file_get_block(dir, i, &blk)) < 0)
                        return r;
                f = (struct File*) blk;
                for (j = 0; j < BLKFILES; j++)
                        if (strcmp(f[j].f_name, name) == 0) {
                                *file = &f[j];
                                f[j].f_dir = dir;
                                return 0;
                        }
        }
        return -E_NOT_FOUND;
}

// Set *file to point at a free File structure in dir.
int
dir_alloc_file(struct File *dir, struct File **file)
{
        int r;
        uint32_t nblock, i, j;
        char *blk;
        struct File *f;

        assert((dir->f_size % BLKSIZE) == 0);
        nblock = dir->f_size / BLKSIZE;
        for (i = 0; i < nblock; i++) {
                if ((r = file_get_block(dir, i, &blk)) < 0)
                        return r;
                f = (struct File*) blk;
                for (j = 0; j < BLKFILES; j++)
                        if (f[j].f_name[0] == '\0') {
                                *file = &f[j];
                                f[j].f_dir = dir;
                                return 0;
                        }
        }
        dir->f_size += BLKSIZE;
        if ((r = file_get_block(dir, i, &blk)) < 0)
                return r;
        f = (struct File*) blk;
        *file = &f[0];
        f[0].f_dir = dir;
        return 0;
}

// Skip over slashes.
static inline const char*
skip_slash(const char *p)
{
        while (*p == '/')
                p++;
        return p;
}

// Evaluate a path name, starting at the root.
// On success, set *pf to the file we found
// and set *pdir to the directory the file is in.
// If we cannot find the file but find the directory
// it should be in, set *pdir and copy the final path
// element into lastelem.
static int
walk_path(const char *path, struct File **pdir, struct File **pf, char *lastelem)
{
        const char *p;
        char name[MAXNAMELEN];
        struct File *dir, *f;
        int r;

        // if (*path != '/')
        //      return -E_BAD_PATH;
        path = skip_slash(path);
        f = &super->s_root;
        dir = 0;
        name[0] = 0;

        if (pdir)
                *pdir = 0;
        *pf = 0;
        while (*path != '\0') {
                dir = f;
                p = path;
                while (*path != '/' && *path != '\0')
                        path++;
                if (path - p >= MAXNAMELEN)
                        return -E_BAD_PATH;
                memmove(name, p, path - p);
                name[path - p] = '\0';
                path = skip_slash(path);

                if (dir->f_type != FTYPE_DIR)
                        return -E_NOT_FOUND;

                if ((r = dir_lookup(dir, name, &f)) < 0) {
                        if (r == -E_NOT_FOUND && *path == '\0') {
                                if (pdir)
                                        *pdir = dir;
                                if (lastelem)
                                        strcpy(lastelem, name);
                                *pf = 0;
                        }
                        return r;
                }
        }

        if (pdir)
                *pdir = dir;
        *pf = f;
        return 0;
}

// Create "path".  On success set *pf to point at the file and return 0.
// On error return < 0.
int
file_create(const char *path, struct File **pf)
{
        char name[MAXNAMELEN];
        int r;
        struct File *dir, *f;

        if ((r = walk_path(path, &dir, &f, name)) == 0)
                return -E_FILE_EXISTS;
        if (r != -E_NOT_FOUND || dir == 0)
                return r;
        if (dir_alloc_file(dir, &f) < 0)
                return r;
        strcpy(f->f_name, name);
        *pf = f;
        return 0;
}

// Open "path".  On success set *pf to point at the file and return 0.
// On error return < 0.
int
file_open(const char *path, struct File **pf)
{
        // Hint: Use walk_path.
        // LAB 5: Your code here.
        struct File *dir, *f;
        int r;

        if ((r = walk_path(path, &dir, &f, 0)) < 0)
                return r;
        *pf = f;
        return 0;
}

// Remove any blocks currently used by file 'f',
// but not necessary for a file of size 'newsize'.
// For both the old and new sizes, figure out the number of blocks required,
// and then clear the blocks from new_nblocks to old_nblocks.
// If the new_nblocks is no more than NDIRECT, and the indirect block has
// been allocated (f->f_indirect != 0), then free the indirect block too.
// (Remember to clear the f->f_indirect pointer so you'll know
// whether it's valid!)
// Do not change f->f_size.
static void
file_truncate_blocks(struct File *f, off_t newsize)
{
        int r;
        uint32_t bno, old_nblocks, new_nblocks;

        // Hint: Use file_clear_block and/or free_block.
        for (old_nblocks = 0; old_nblocks < f->f_size; old_nblocks += BLKSIZE)
                ;
        old_nblocks /= BLKSIZE;
        for (new_nblocks = 0; new_nblocks < newsize; new_nblocks += BLKSIZE)
                ;
        new_nblocks /= BLKSIZE;
        cprintf("truncate from %d[%d] -> %d[%d].\n", f->f_size, new_nblocks, f->f_size, old_nblocks);
        for (bno = new_nblocks; bno <= old_nblocks; bno++)
                if ((r = file_clear_block(f, bno)) < 0)
                        panic("file clear block error: %e\n", r);

        // Yeah, we need to clear the extra block as well
        if (new_nblocks < NDIRECT) {
                if (f->f_indirect != 0) {
                        free_block(f->f_indirect);
                        f->f_indirect = 0;
                }
                while (new_nblocks < NDIRECT)
                        f->f_direct[new_nblocks++] = 0;
        }
}

int
file_set_size(struct File *f, off_t newsize)
{
        if (f->f_size > newsize)
                file_truncate_blocks(f, newsize);
        f->f_size = newsize;
        if (f->f_dir)
                file_flush(f->f_dir);
        return 0;
}

// Flush the contents of file f out to disk.
// Loop over all the blocks in file.
// Translate the file block number into a disk block number
// and then check whether that disk block is dirty.  If so, write it out.
//
// Hint: use file_map_block, block_is_dirty, and write_block.
void
file_flush(struct File *f)
{
        // LAB 5: Your code here.
        int i, n, r;
        uint32_t diskbno;

        for (i = 0; i < f->f_size; i += BLKSIZE) {
                if ((r = file_map_block(f, i/BLKSIZE, &diskbno, 0)) < 0)
                        panic("file map block error: %e", r);
                if (block_is_dirty(diskbno))
                        write_block(diskbno);
                //if (f->f_indirect && block_is_dirty(f->f_indirect))
                        //write_block(f->f_indirect);
        }
}

// Sync the entire file system.  A big hammer.
void
fs_sync(void)
{
        int i;
        for (i = 0; i < super->s_nblocks; i++)
                if (block_is_dirty(i))
                        write_block(i);
}

// Close a file.
void
file_close(struct File *f)
{
        file_flush(f);
        if (f->f_dir)
                file_flush(f->f_dir);
}

// Remove a file by truncating it and then zeroing the name.
int
file_remove(const char *path)
{
        int r;
        struct File *f;

        if ((r = walk_path(path, 0, &f, 0)) < 0)
                return r;

        file_truncate_blocks(f, 0);
        f->f_name[0] = '\0';
        f->f_size = 0;
        if (f->f_dir)
                file_flush(f->f_dir);

        return 0;
}