fat_fat.c

Go to the documentation of this file.

/*
 * Copyright (c) 2008 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "fat_fat.h"
#include "fat_dentry.h"
#include "fat.h"
#include "../../vfs/vfs.h"
#include <libfs.h>
#include <libblock.h>
#include <errno.h>
#include <byteorder.h>
#include <align.h>
#include <assert.h>
#include <fibril_synch.h>
#include <malloc.h>
#include <mem.h>

/*
 * Convenience macros for computing some frequently used values from the
 * primitive boot sector members.
 */
#define RDS(bs)         ((sizeof(fat_dentry_t) * RDE((bs))) / BPS((bs))) + \
                        (((sizeof(fat_dentry_t) * RDE((bs))) % BPS((bs))) != 0)
#define SSA(bs)         (RSCNT((bs)) + FATCNT((bs)) * SF((bs)) + RDS(bs))

#define CLBN2PBN(bs, cl, bn) \
        (SSA((bs)) + ((cl) - FAT_CLST_FIRST) * SPC((bs)) + (bn) % SPC((bs)))

static FIBRIL_MUTEX_INITIALIZE(fat_alloc_lock);

int 
fat_cluster_walk(fat_bs_t *bs, devmap_handle_t devmap_handle, fat_cluster_t firstc,
    fat_cluster_t *lastc, uint16_t *numc, uint16_t max_clusters)
{
        block_t *b;
        uint16_t clusters = 0;
        fat_cluster_t clst = firstc;
        int rc;

        if (firstc == FAT_CLST_RES0) {
                /* No space allocated to the file. */
                if (lastc)
                        *lastc = firstc;
                if (numc)
                        *numc = 0;
                return EOK;
        }

        while (clst < FAT_CLST_LAST1 && clusters < max_clusters) {
                aoff64_t fsec;  /* sector offset relative to FAT1 */
                unsigned fidx;  /* FAT1 entry index */

                assert(clst >= FAT_CLST_FIRST);
                if (lastc)
                        *lastc = clst;  /* remember the last cluster number */
                fsec = (clst * sizeof(fat_cluster_t)) / BPS(bs);
                fidx = clst % (BPS(bs) / sizeof(fat_cluster_t));
                /* read FAT1 */
                rc = block_get(&b, devmap_handle, RSCNT(bs) + fsec,
                    BLOCK_FLAGS_NONE);
                if (rc != EOK)
                        return rc;
                clst = uint16_t_le2host(((fat_cluster_t *)b->data)[fidx]);
                assert(clst != FAT_CLST_BAD);
                rc = block_put(b);
                if (rc != EOK)
                        return rc;
                clusters++;
        }

        if (lastc && clst < FAT_CLST_LAST1)
                *lastc = clst;
        if (numc)
                *numc = clusters;

        return EOK;
}

int
fat_block_get(block_t **block, struct fat_bs *bs, fat_node_t *nodep,
    aoff64_t bn, int flags)
{
        fat_cluster_t firstc = nodep->firstc;
        fat_cluster_t currc;
        aoff64_t relbn = bn;
        int rc;

        if (!nodep->size)
                return ELIMIT;

        if (nodep->firstc == FAT_CLST_ROOT) 
                goto fall_through;

        if (((((nodep->size - 1) / BPS(bs)) / SPC(bs)) == bn / SPC(bs)) &&
            nodep->lastc_cached_valid) {
                /*
                 * This is a request to read a block within the last cluster
                 * when fortunately we have the last cluster number cached.
                 */
                return block_get(block, nodep->idx->devmap_handle,
                    CLBN2PBN(bs, nodep->lastc_cached_value, bn), flags);
        }

        if (nodep->currc_cached_valid && bn >= nodep->currc_cached_bn) {
                /*
                 * We can start with the cluster cached by the previous call to
                 * fat_block_get().
                 */
                firstc = nodep->currc_cached_value;
                relbn -= (nodep->currc_cached_bn / SPC(bs)) * SPC(bs);
        }

fall_through:
        rc = _fat_block_get(block, bs, nodep->idx->devmap_handle, firstc,
            &currc, relbn, flags);
        if (rc != EOK)
                return rc;
        
        /*
         * Update the "current" cluster cache.
         */
        nodep->currc_cached_valid = true;
        nodep->currc_cached_bn = bn;
        nodep->currc_cached_value = currc;

        return rc;
}

int
_fat_block_get(block_t **block, fat_bs_t *bs, devmap_handle_t devmap_handle,
    fat_cluster_t fcl, fat_cluster_t *clp, aoff64_t bn, int flags)
{
        uint16_t clusters;
        unsigned max_clusters;
        fat_cluster_t c;
        int rc;

        /*
         * This function can only operate on non-zero length files.
         */
        if (fcl == FAT_CLST_RES0)
                return ELIMIT;

        if (fcl == FAT_CLST_ROOT) {
                /* root directory special case */
                assert(bn < RDS(bs));
                rc = block_get(block, devmap_handle,
                    RSCNT(bs) + FATCNT(bs) * SF(bs) + bn, flags);
                return rc;
        }

        max_clusters = bn / SPC(bs);
        rc = fat_cluster_walk(bs, devmap_handle, fcl, &c, &clusters, max_clusters);
        if (rc != EOK)
                return rc;
        assert(clusters == max_clusters);

        rc = block_get(block, devmap_handle, CLBN2PBN(bs, c, bn), flags);

        if (clp)
                *clp = c;

        return rc;
}

int fat_fill_gap(fat_bs_t *bs, fat_node_t *nodep, fat_cluster_t mcl, aoff64_t pos)
{
        block_t *b;
        aoff64_t o, boundary;
        int rc;

        boundary = ROUND_UP(nodep->size, BPS(bs) * SPC(bs));

        /* zero out already allocated space */
        for (o = nodep->size; o < pos && o < boundary;
            o = ALIGN_DOWN(o + BPS(bs), BPS(bs))) {
                int flags = (o % BPS(bs) == 0) ?
                    BLOCK_FLAGS_NOREAD : BLOCK_FLAGS_NONE;
                rc = fat_block_get(&b, bs, nodep, o / BPS(bs), flags);
                if (rc != EOK)
                        return rc;
                memset(b->data + o % BPS(bs), 0, BPS(bs) - o % BPS(bs));
                b->dirty = true;                /* need to sync node */
                rc = block_put(b);
                if (rc != EOK)
                        return rc;
        }
        
        if (o >= pos)
                return EOK;
        
        /* zero out the initial part of the new cluster chain */
        for (o = boundary; o < pos; o += BPS(bs)) {
                rc = _fat_block_get(&b, bs, nodep->idx->devmap_handle, mcl,
                    NULL, (o - boundary) / BPS(bs), BLOCK_FLAGS_NOREAD);
                if (rc != EOK)
                        return rc;
                memset(b->data, 0, min(BPS(bs), pos - o));
                b->dirty = true;                /* need to sync node */
                rc = block_put(b);
                if (rc != EOK)
                        return rc;
        }

        return EOK;
}

int
fat_get_cluster(fat_bs_t *bs, devmap_handle_t devmap_handle, unsigned fatno,
    fat_cluster_t clst, fat_cluster_t *value)
{
        block_t *b;
        fat_cluster_t *cp;
        int rc;

        rc = block_get(&b, devmap_handle, RSCNT(bs) + SF(bs) * fatno +
            (clst * sizeof(fat_cluster_t)) / BPS(bs), BLOCK_FLAGS_NONE);
        if (rc != EOK)
                return rc;
        cp = (fat_cluster_t *)b->data +
            clst % (BPS(bs) / sizeof(fat_cluster_t));
        *value = uint16_t_le2host(*cp);
        rc = block_put(b);
        
        return rc;
}

int
fat_set_cluster(fat_bs_t *bs, devmap_handle_t devmap_handle, unsigned fatno,
    fat_cluster_t clst, fat_cluster_t value)
{
        block_t *b;
        fat_cluster_t *cp;
        int rc;

        assert(fatno < FATCNT(bs));
        rc = block_get(&b, devmap_handle, RSCNT(bs) + SF(bs) * fatno +
            (clst * sizeof(fat_cluster_t)) / BPS(bs), BLOCK_FLAGS_NONE);
        if (rc != EOK)
                return rc;
        cp = (fat_cluster_t *)b->data +
            clst % (BPS(bs) / sizeof(fat_cluster_t));
        *cp = host2uint16_t_le(value);
        b->dirty = true;                /* need to sync block */
        rc = block_put(b);
        return rc;
}

int fat_alloc_shadow_clusters(fat_bs_t *bs, devmap_handle_t devmap_handle,
    fat_cluster_t *lifo, unsigned nclsts)
{
        uint8_t fatno;
        unsigned c;
        int rc;

        for (fatno = FAT1 + 1; fatno < bs->fatcnt; fatno++) {
                for (c = 0; c < nclsts; c++) {
                        rc = fat_set_cluster(bs, devmap_handle, fatno, lifo[c],
                            c == 0 ? FAT_CLST_LAST1 : lifo[c - 1]);
                        if (rc != EOK)
                                return rc;
                }
        }

        return EOK;
}

int
fat_alloc_clusters(fat_bs_t *bs, devmap_handle_t devmap_handle, unsigned nclsts,
    fat_cluster_t *mcl, fat_cluster_t *lcl)
{
        block_t *blk;
        fat_cluster_t *lifo;    /* stack for storing free cluster numbers */ 
        unsigned found = 0;     /* top of the free cluster number stack */
        unsigned b, c, cl; 
        int rc;

        lifo = (fat_cluster_t *) malloc(nclsts * sizeof(fat_cluster_t));
        if (!lifo)
                return ENOMEM;
        
        /*
         * Search FAT1 for unused clusters.
         */
        fibril_mutex_lock(&fat_alloc_lock);
        for (b = 0, cl = 0; b < SF(bs); b++) {
                rc = block_get(&blk, devmap_handle, RSCNT(bs) + b,
                    BLOCK_FLAGS_NONE);
                if (rc != EOK)
                        goto error;
                for (c = 0; c < BPS(bs) / sizeof(fat_cluster_t); c++, cl++) {
                        /*
                         * Check if the entire cluster is physically there.
                         * This check becomes necessary when the file system is
                         * created with fewer total sectors than how many is
                         * inferred from the size of the file allocation table
                         * or when the last cluster ends beyond the end of the
                         * device.
                         */
                        if ((cl >= FAT_CLST_FIRST) &&
                            CLBN2PBN(bs, cl, SPC(bs) - 1) >= TS(bs)) {
                                rc = block_put(blk);
                                if (rc != EOK)
                                        goto error;
                                goto out;
                        }

                        fat_cluster_t *clst = (fat_cluster_t *)blk->data + c;
                        if (uint16_t_le2host(*clst) == FAT_CLST_RES0) {
                                /*
                                 * The cluster is free. Put it into our stack
                                 * of found clusters and mark it as non-free.
                                 */
                                lifo[found] = cl;
                                *clst = (found == 0) ?
                                    host2uint16_t_le(FAT_CLST_LAST1) :
                                    host2uint16_t_le(lifo[found - 1]);
                                blk->dirty = true;      /* need to sync block */
                                if (++found == nclsts) {
                                        /* we are almost done */
                                        rc = block_put(blk);
                                        if (rc != EOK)
                                                goto error;
                                        /* update the shadow copies of FAT */
                                        rc = fat_alloc_shadow_clusters(bs,
                                            devmap_handle, lifo, nclsts);
                                        if (rc != EOK)
                                                goto error;
                                        *mcl = lifo[found - 1];
                                        *lcl = lifo[0];
                                        free(lifo);
                                        fibril_mutex_unlock(&fat_alloc_lock);
                                        return EOK;
                                }
                        }
                }
                rc = block_put(blk);
                if (rc != EOK) {
error:
                        fibril_mutex_unlock(&fat_alloc_lock);
                        free(lifo);
                        return rc;
                }
        }
out:
        fibril_mutex_unlock(&fat_alloc_lock);

        /*
         * We could not find enough clusters. Now we need to free the clusters
         * we have allocated so far.
         */
        while (found--) {
                rc = fat_set_cluster(bs, devmap_handle, FAT1, lifo[found],
                    FAT_CLST_RES0);
                if (rc != EOK) {
                        free(lifo);
                        return rc;
                }
        }
        
        free(lifo);
        return ENOSPC;
}

int
fat_free_clusters(fat_bs_t *bs, devmap_handle_t devmap_handle, fat_cluster_t firstc)
{
        unsigned fatno;
        fat_cluster_t nextc;
        int rc;

        /* Mark all clusters in the chain as free in all copies of FAT. */
        while (firstc < FAT_CLST_LAST1) {
                assert(firstc >= FAT_CLST_FIRST && firstc < FAT_CLST_BAD);
                rc = fat_get_cluster(bs, devmap_handle, FAT1, firstc, &nextc);
                if (rc != EOK)
                        return rc;
                for (fatno = FAT1; fatno < bs->fatcnt; fatno++) {
                        rc = fat_set_cluster(bs, devmap_handle, fatno, firstc,
                            FAT_CLST_RES0);
                        if (rc != EOK)
                                return rc;
                }

                firstc = nextc;
        }

        return EOK;
}

int
fat_append_clusters(fat_bs_t *bs, fat_node_t *nodep, fat_cluster_t mcl,
    fat_cluster_t lcl)
{
        devmap_handle_t devmap_handle = nodep->idx->devmap_handle;
        fat_cluster_t lastc;
        uint8_t fatno;
        int rc;

        if (nodep->firstc == FAT_CLST_RES0) {
                /* No clusters allocated to the node yet. */
                nodep->firstc = mcl;
                nodep->dirty = true;    /* need to sync node */
        } else {
                if (nodep->lastc_cached_valid) {
                        lastc = nodep->lastc_cached_value;
                        nodep->lastc_cached_valid = false;
                } else {
                        rc = fat_cluster_walk(bs, devmap_handle, nodep->firstc,
                            &lastc, NULL, (uint16_t) -1);
                        if (rc != EOK)
                                return rc;
                }

                for (fatno = FAT1; fatno < bs->fatcnt; fatno++) {
                        rc = fat_set_cluster(bs, nodep->idx->devmap_handle, fatno,
                            lastc, mcl);
                        if (rc != EOK)
                                return rc;
                }
        }

        nodep->lastc_cached_valid = true;
        nodep->lastc_cached_value = lcl;

        return EOK;
}

int fat_chop_clusters(fat_bs_t *bs, fat_node_t *nodep, fat_cluster_t lcl)
{
        int rc;
        devmap_handle_t devmap_handle = nodep->idx->devmap_handle;

        /*
         * Invalidate cached cluster numbers.
         */
        nodep->lastc_cached_valid = false;
        if (nodep->currc_cached_value != lcl)
                nodep->currc_cached_valid = false;

        if (lcl == FAT_CLST_RES0) {
                /* The node will have zero size and no clusters allocated. */
                rc = fat_free_clusters(bs, devmap_handle, nodep->firstc);
                if (rc != EOK)
                        return rc;
                nodep->firstc = FAT_CLST_RES0;
                nodep->dirty = true;            /* need to sync node */
        } else {
                fat_cluster_t nextc;
                unsigned fatno;

                rc = fat_get_cluster(bs, devmap_handle, FAT1, lcl, &nextc);
                if (rc != EOK)
                        return rc;

                /* Terminate the cluster chain in all copies of FAT. */
                for (fatno = FAT1; fatno < bs->fatcnt; fatno++) {
                        rc = fat_set_cluster(bs, devmap_handle, fatno, lcl,
                            FAT_CLST_LAST1);
                        if (rc != EOK)
                                return rc;
                }

                /* Free all following clusters. */
                rc = fat_free_clusters(bs, devmap_handle, nextc);
                if (rc != EOK)
                        return rc;
        }

        /*
         * Update and re-enable the last cluster cache.
         */
        nodep->lastc_cached_valid = true;
        nodep->lastc_cached_value = lcl;

        return EOK;
}

int
fat_zero_cluster(struct fat_bs *bs, devmap_handle_t devmap_handle, fat_cluster_t c)
{
        int i;
        block_t *b;
        int rc;

        for (i = 0; i < SPC(bs); i++) {
                rc = _fat_block_get(&b, bs, devmap_handle, c, NULL, i,
                    BLOCK_FLAGS_NOREAD);
                if (rc != EOK)
                        return rc;
                memset(b->data, 0, BPS(bs));
                b->dirty = true;
                rc = block_put(b);
                if (rc != EOK)
                        return rc;
        }

        return EOK;
}

int fat_sanity_check(fat_bs_t *bs, devmap_handle_t devmap_handle)
{
        fat_cluster_t e0, e1;
        unsigned fat_no;
        int rc;

        /* Check number of FATs. */
        if (bs->fatcnt == 0)
                return ENOTSUP;

        /* Check total number of sectors. */

        if (bs->totsec16 == 0 && bs->totsec32 == 0)
                return ENOTSUP;

        if (bs->totsec16 != 0 && bs->totsec32 != 0 &&
            bs->totsec16 != bs->totsec32) 
                return ENOTSUP;

        /* Check media descriptor. Must be between 0xf0 and 0xff. */
        if ((bs->mdesc & 0xf0) != 0xf0)
                return ENOTSUP;

        /* Check number of sectors per FAT. */
        if (bs->sec_per_fat == 0)
                return ENOTSUP;

        /*
         * Check that the root directory entries take up whole blocks.
         * This check is rather strict, but it allows us to treat the root
         * directory and non-root directories uniformly in some places.
         * It can be removed provided that functions such as fat_read() are
         * sanitized to support file systems with this property.
         */
        if ((uint16_t_le2host(bs->root_ent_max) * sizeof(fat_dentry_t)) %
            uint16_t_le2host(bs->bps) != 0)
                return ENOTSUP;

        /* Check signature of each FAT. */

        for (fat_no = 0; fat_no < bs->fatcnt; fat_no++) {
                rc = fat_get_cluster(bs, devmap_handle, fat_no, 0, &e0);
                if (rc != EOK)
                        return EIO;

                rc = fat_get_cluster(bs, devmap_handle, fat_no, 1, &e1);
                if (rc != EOK)
                        return EIO;

                /* Check that first byte of FAT contains the media descriptor. */
                if ((e0 & 0xff) != bs->mdesc)
                        return ENOTSUP;

                /*
                 * Check that remaining bits of the first two entries are
                 * set to one.
                 */
                if ((e0 >> 8) != 0xff || e1 != 0xffff)
                        return ENOTSUP;
        }

        return EOK;
}

---