source: mainline/uspace/lib/ext4/libext4_extent.c@ 82cb6768

/*
 * Copyright (c) 2011 Frantisek Princ
 * 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.
 */

/** @addtogroup libext4
 * @{
 */ 

/**
 * @file        libext4_extent.c
 * @brief       Ext4 extent structures operations.
 */

#include <byteorder.h>
#include <errno.h>
#include <malloc.h>
#include "libext4.h"

uint32_t ext4_extent_get_first_block(ext4_extent_t *extent)
{
        return uint32_t_le2host(extent->first_block);
}

void ext4_extent_set_first_block(ext4_extent_t *extent, uint32_t first_block)
{
        extent->first_block = host2uint32_t_le(first_block);
}

uint16_t ext4_extent_get_block_count(ext4_extent_t *extent)
{
        return uint16_t_le2host(extent->block_count);
}

void ext4_extent_set_block_count(ext4_extent_t *extent, uint16_t block_count)
{
        extent->block_count = host2uint16_t_le(block_count);
}

uint64_t ext4_extent_get_start(ext4_extent_t *extent)
{
        return ((uint64_t)uint16_t_le2host(extent->start_hi)) << 32 |
                        ((uint64_t)uint32_t_le2host(extent->start_lo));
}

void ext4_extent_set_start(ext4_extent_t *extent, uint64_t start)
{
        extent->start_lo = host2uint32_t_le((start << 32) >> 32);
        extent->start_hi = host2uint16_t_le((uint16_t)(start >> 32));
}

uint32_t ext4_extent_index_get_first_block(ext4_extent_index_t *index)
{
        return uint32_t_le2host(index->first_block);
}

void ext4_extent_index_set_first_block(ext4_extent_index_t *index,
                uint32_t first)
{
        index->first_block = host2uint32_t_le(first);
}

uint64_t ext4_extent_index_get_leaf(ext4_extent_index_t *index)
{
        return ((uint64_t)uint16_t_le2host(index->leaf_hi)) << 32 |
                ((uint64_t)uint32_t_le2host(index->leaf_lo));
}

void ext4_extent_index_set_leaf(ext4_extent_index_t *index, uint64_t leaf)
{
        index->leaf_lo = host2uint32_t_le((leaf << 32) >> 32);
        index->leaf_hi = host2uint16_t_le((uint16_t)(leaf >> 32));
}

uint16_t ext4_extent_header_get_magic(ext4_extent_header_t *header)
{
        return uint16_t_le2host(header->magic);
}

void ext4_extent_header_set_magic(ext4_extent_header_t *header, uint16_t magic)
{
        header->magic = host2uint16_t_le(magic);
}

uint16_t ext4_extent_header_get_entries_count(ext4_extent_header_t *header)
{
        return uint16_t_le2host(header->entries_count);
}

void ext4_extent_header_set_entries_count(ext4_extent_header_t *header,
                uint16_t count)
{
        header->entries_count = host2uint16_t_le(count);
}

uint16_t ext4_extent_header_get_max_entries_count(ext4_extent_header_t *header)
{
        return uint16_t_le2host(header->max_entries_count);
}

void ext4_extent_header_set_max_entries_count(ext4_extent_header_t *header,
                uint16_t max_count)
{
        header->max_entries_count = host2uint16_t_le(max_count);
}

uint16_t ext4_extent_header_get_depth(ext4_extent_header_t *header)
{
        return uint16_t_le2host(header->depth);
}

void ext4_extent_header_set_depth(ext4_extent_header_t *header, uint16_t depth)
{
        header->depth = host2uint16_t_le(depth);
}

uint32_t ext4_extent_header_get_generation(ext4_extent_header_t *header)
{
        return uint32_t_le2host(header->generation);
}

void ext4_extent_header_set_generation(ext4_extent_header_t *header,
                uint32_t generation)
{
        header->generation = host2uint32_t_le(generation);
}

/**
 * Binary search in extent index node
 */
static void ext4_extent_binsearch_idx(ext4_extent_header_t *header,
        ext4_extent_index_t **index, uint32_t iblock)
{
        ext4_extent_index_t *r, *l, *m;

        uint16_t entries_count = ext4_extent_header_get_entries_count(header);

        if (entries_count == 1) {
                *index = EXT4_EXTENT_FIRST_INDEX(header);
                return;
        }

        l = EXT4_EXTENT_FIRST_INDEX(header) + 1;
        r = l + entries_count - 1;

        while (l <= r) {
                m = l + (r - l) / 2;
                uint32_t first_block = ext4_extent_index_get_first_block(m);
                if (iblock < first_block) {
                                r = m - 1;
                } else {
                                l = m + 1;
                }
        }

        *index = l - 1;
}

/**
 * Binary search in extent leaf node
 */
static void ext4_extent_binsearch(ext4_extent_header_t *header,
                ext4_extent_t **extent, uint32_t iblock)
{
        ext4_extent_t *r, *l, *m;

        uint16_t entries_count = ext4_extent_header_get_entries_count(header);

        if (entries_count == 0) {
                // this leaf is empty
//              EXT4FS_DBG("EMPTY LEAF");
                *extent = NULL;
                return;
        }

        if (entries_count == 1) {
                *extent = EXT4_EXTENT_FIRST(header);
                return;
        }

        l = EXT4_EXTENT_FIRST(header) + 1;
        r = l + entries_count - 1;

        while (l < r) {
                m = l + (r - l) / 2;
                uint32_t first_block = ext4_extent_get_first_block(m);
                if (iblock < first_block) {
                                r = m - 1;
                } else {
                                l = m + 1;
                }
        }

        *extent = l - 1;
}

// Reading routine without saving blocks to path - for saving memory during finding block
int ext4_extent_find_block(ext4_inode_ref_t *inode_ref, uint32_t iblock, uint32_t *fblock)
{
        int rc;

        uint64_t inode_size = ext4_inode_get_size(
                        inode_ref->fs->superblock, inode_ref->inode);

        uint32_t block_size = ext4_superblock_get_block_size(
                        inode_ref->fs->superblock);

        uint32_t last_idx = (inode_size - 1) / block_size;

        if (iblock > last_idx) {
                *fblock = 0;
                return EOK;
        }

        block_t* block = NULL;

        ext4_extent_header_t *header = ext4_inode_get_extent_header(inode_ref->inode);
        while (ext4_extent_header_get_depth(header) != 0) {

                ext4_extent_index_t *index;
                ext4_extent_binsearch_idx(header, &index, iblock);

                uint64_t child = ext4_extent_index_get_leaf(index);

                if (block != NULL) {
                        block_put(block);
                }

                rc = block_get(&block, inode_ref->fs->device, child, BLOCK_FLAGS_NONE);
                if (rc != EOK) {
                        return rc;
                }

                header = (ext4_extent_header_t *)block->data;
        }


        ext4_extent_t* extent = NULL;
        ext4_extent_binsearch(header, &extent, iblock);

        if (extent == NULL) {
                *fblock = 0;
        } else {
                uint32_t phys_block;
                phys_block = ext4_extent_get_start(extent) + iblock;
                phys_block -= ext4_extent_get_first_block(extent);

                *fblock = phys_block;
        }

        if (block != NULL) {
                block_put(block);
        }

        return EOK;
}

static int ext4_extent_find_extent(ext4_inode_ref_t *inode_ref,
                uint32_t iblock, ext4_extent_path_t **ret_path)
{
        int rc;

        ext4_extent_header_t *eh =
                        ext4_inode_get_extent_header(inode_ref->inode);

        uint16_t depth = ext4_extent_header_get_depth(eh);

        ext4_extent_path_t *tmp_path;

        // Added 2 for possible tree growing
        tmp_path = malloc(sizeof(ext4_extent_path_t) * (depth + 2));
        if (tmp_path == NULL) {
                return ENOMEM;
        }

        tmp_path[0].block = inode_ref->block;
        tmp_path[0].header = eh;

        uint16_t pos = 0;
        while (ext4_extent_header_get_depth(eh) != 0) {

                ext4_extent_binsearch_idx(tmp_path[pos].header, &tmp_path[pos].index, iblock);

                tmp_path[pos].depth = depth;
                tmp_path[pos].extent = NULL;

                assert(tmp_path[pos].index != NULL);

                uint64_t fblock = ext4_extent_index_get_leaf(tmp_path[pos].index);

                block_t *block;
                rc = block_get(&block, inode_ref->fs->device, fblock, BLOCK_FLAGS_NONE);
                if (rc != EOK) {
                        goto cleanup;
                }

                pos++;

                eh = (ext4_extent_header_t *)block->data;
                tmp_path[pos].block = block;
                tmp_path[pos].header = eh;

        }

        tmp_path[pos].depth = 0;
        tmp_path[pos].extent = NULL;
        tmp_path[pos].index = NULL;

    /* find extent */
        ext4_extent_binsearch(tmp_path[pos].header, &tmp_path[pos].extent, iblock);

        *ret_path = tmp_path;

        return EOK;

cleanup:
        // Put loaded blocks
        // From 1 -> 0 is a block with inode data
        for (uint16_t i = 1; i < tmp_path->depth; ++i) {
                if (tmp_path[i].block) {
                        block_put(tmp_path[i].block);
                }
        }

        // Destroy temporary data structure
        free(tmp_path);

        return rc;

}

static int ext4_extent_release(ext4_inode_ref_t *inode_ref, ext4_extent_t* extent)
{
        int rc;

        uint64_t start = ext4_extent_get_start(extent);
        uint16_t block_count = ext4_extent_get_block_count(extent);

        rc = ext4_balloc_free_blocks(inode_ref, start, block_count);
        if (rc != EOK) {
                EXT4FS_DBG("ERROR");
                return rc;
        }

        return EOK;
}

// Recursive release
static int ext4_extent_release_branch(ext4_inode_ref_t *inode_ref,
                ext4_extent_index_t *index)
{
        int rc;

        block_t* block;

        uint32_t fblock = ext4_extent_index_get_leaf(index);

//      EXT4FS_DBG("fblock = \%u", fblock);

        rc = block_get(&block, inode_ref->fs->device, fblock, BLOCK_FLAGS_NOREAD);
        if (rc != EOK) {
                EXT4FS_DBG("ERROR get_block");
                return rc;
        }

        ext4_extent_header_t *header = block->data;

        if (ext4_extent_header_get_depth(header)) {

                ext4_extent_index_t *idx = EXT4_EXTENT_FIRST_INDEX(header);

                for (uint32_t i = 0; i < ext4_extent_header_get_entries_count(header); ++i, ++idx) {
                        rc = ext4_extent_release_branch(inode_ref, idx);
                        if (rc != EOK) {
                                EXT4FS_DBG("error recursion");
                                return rc;
                        }
                }
        } else {
                ext4_extent_t *ext = EXT4_EXTENT_FIRST(header);

                for (uint32_t i = 0; i < ext4_extent_header_get_entries_count(header); ++i, ++ext) {
                        rc = ext4_extent_release(inode_ref, ext);
                        if (rc != EOK) {
                                EXT4FS_DBG("error recursion");
                                return rc;
                        }
                }
        }

        rc = block_put(block);
        if (rc != EOK) {
                EXT4FS_DBG("ERROR put_block");
                return rc;
        }

        ext4_balloc_free_block(inode_ref, fblock);

        return EOK;
}

int ext4_extent_release_blocks_from(ext4_inode_ref_t *inode_ref,
                uint32_t iblock_from)
{
        int rc = EOK;

        // Find the first extent to modify
        ext4_extent_path_t *path;
        rc = ext4_extent_find_extent(inode_ref, iblock_from, &path);
        if (rc != EOK) {
                return rc;
        }

        // Jump to last item of the path (extent)
        ext4_extent_path_t *path_ptr = path;
        while (path_ptr->depth != 0) {
                path_ptr++;
        }

        assert(path_ptr->extent != NULL);

        // First extent maybe released partially
        uint32_t first_fblock;
        first_fblock = ext4_extent_get_start(path_ptr->extent) + iblock_from;
        first_fblock -= ext4_extent_get_first_block(path_ptr->extent);

        uint16_t block_count = ext4_extent_get_block_count(path_ptr->extent);

        uint16_t delete_count = block_count - first_fblock +
                        ext4_extent_get_start(path_ptr->extent);

        rc = ext4_balloc_free_blocks(inode_ref, first_fblock, delete_count);
        if (rc != EOK) {
                goto cleanup;
        }

        block_count -= delete_count;
        ext4_extent_set_block_count(path_ptr->extent, block_count);

        uint16_t entries = ext4_extent_header_get_entries_count(path_ptr->header);
        ext4_extent_t *tmp_ext = path_ptr->extent + 1;
        ext4_extent_t *stop_ext = EXT4_EXTENT_FIRST(path_ptr->header) + entries;

        // If first extent empty, release it
        if (block_count == 0) {
                entries--;
                ext4_extent_header_set_entries_count(path_ptr->header, entries);
        }

        // Release all successors of the first extent in the same node
        while (tmp_ext < stop_ext) {
                first_fblock = ext4_extent_get_start(tmp_ext);
                delete_count = ext4_extent_get_block_count(tmp_ext);

                rc = ext4_balloc_free_blocks(inode_ref, first_fblock, delete_count);
                if (rc != EOK) {
                        goto cleanup;
                }

                entries--;
                ext4_extent_header_set_entries_count(path_ptr->header, entries);

                tmp_ext++;
        }

        // If leaf node is empty, the whole tree must be checked and the node will be released
        bool check_tree = false;

        // Don't release root block (including inode data) !!!
        if ((path_ptr != path) && (entries == 0)) {
                rc = ext4_balloc_free_block(inode_ref, path_ptr->block->lba);
                if (rc != EOK) {
                        goto cleanup;
                }
                check_tree = true;
        }

        // Jump to the parent
        --path_ptr;

        // release all successors in all levels
        while(path_ptr >= path) {
                entries = ext4_extent_header_get_entries_count(path_ptr->header);
                ext4_extent_index_t *index = path_ptr->index + 1;
                ext4_extent_index_t *stop =
                                EXT4_EXTENT_FIRST_INDEX(path_ptr->header) + entries;

                if (check_tree) {
                        entries--;
                        ext4_extent_header_set_entries_count(path_ptr->header, entries);
                }

                while (index < stop) {
                        rc = ext4_extent_release_branch(inode_ref, index);
                        if (rc != EOK) {
                                goto cleanup;
                        }
                        ++index;
                        --entries;
                        ext4_extent_header_set_entries_count(path_ptr->header, entries);
                }

                path_ptr->block->dirty = true;

                if ((entries == 0) && (path_ptr != path)) {
                        rc = ext4_balloc_free_block(inode_ref, path_ptr->block->lba);
                        if (rc != EOK) {
                                goto cleanup;
                        }
                        check_tree = true;
                } else {
                        check_tree = false;
                }

                --path_ptr;
        }


cleanup:
        // Put loaded blocks
        // From 1 -> 0 is a block with inode data
        for (uint16_t i = 1; i <= path->depth; ++i) {
                if (path[i].block) {
                        block_put(path[i].block);
                }
        }

        // Destroy temporary data structure
        free(path);

        return rc;
}

static int ext4_extent_append_extent(ext4_inode_ref_t *inode_ref,
                ext4_extent_path_t *path, ext4_extent_path_t **last_path_item,
                uint32_t iblock)
{
        int rc;

        ext4_extent_path_t *path_ptr = *last_path_item;

        uint16_t entries = ext4_extent_header_get_entries_count(path_ptr->header);
        uint16_t limit = ext4_extent_header_get_max_entries_count(path_ptr->header);

        // Trivial way - no splitting
        if (entries < limit) {
                ext4_extent_header_set_entries_count(path_ptr->header, entries + 1);
                path_ptr->extent = EXT4_EXTENT_FIRST(path_ptr->header) + entries;
                ext4_extent_set_block_count(path_ptr->extent, 0);
                ext4_extent_set_first_block(path_ptr->extent, iblock);
                ext4_extent_set_start(path_ptr->extent, 0);
                path_ptr->block->dirty = true;

                return EOK;
        }

        uint32_t block_size =
                        ext4_superblock_get_block_size(inode_ref->fs->superblock);

        // Trivial tree - grow
        if (path_ptr == path) {

//              EXT4FS_DBG("splitting extent root");

                uint32_t new_fblock;
                rc = ext4_balloc_alloc_block(inode_ref, &new_fblock);
                if (rc != EOK) {
                        EXT4FS_DBG("error in block allocation");
                        return rc;
                }

//              EXT4FS_DBG("allocated new node \%u", new_fblock);

                block_t *block;
                rc = block_get(&block, inode_ref->fs->device,
                                new_fblock, BLOCK_FLAGS_NOREAD);
                if (rc != EOK) {
                        EXT4FS_DBG("error in block_get");
                        return rc;
                }

                memset(block->data, 0, block_size);

                // Move data from root to the new block
                memcpy(block->data, inode_ref->inode->blocks,
                                EXT4_INODE_BLOCKS * sizeof(uint32_t));

                path_ptr++;
                path_ptr->block = block;
                path_ptr->header = (ext4_extent_header_t *)block->data;
                path_ptr->depth = ext4_extent_header_get_depth(path_ptr->header);
                path_ptr->index = NULL;

                uint16_t entries = ext4_extent_header_get_entries_count(path_ptr->header);
                path_ptr->extent = EXT4_EXTENT_FIRST(path_ptr->header) + entries;
                ext4_extent_header_set_entries_count(path_ptr->header, entries + 1);
                uint16_t limit = (block_size - sizeof(ext4_extent_header_t)) /
                                sizeof(ext4_extent_t);
                ext4_extent_header_set_max_entries_count(path_ptr->header, limit);

                // Modify root (in inode)
                path->depth = 1;
                path->extent = NULL;
                path->index = EXT4_EXTENT_FIRST_INDEX(path->header);

                ext4_extent_header_set_depth(path->header, path_ptr->depth + 1);
                ext4_extent_header_set_entries_count(path->header, 1);

                ext4_extent_index_set_first_block(path->index, 0);
                ext4_extent_index_set_leaf(path->index, new_fblock);

                path_ptr->block->dirty = true;
                path->block->dirty = true;

                *last_path_item = path_ptr;

                return EOK;
        }

        assert(false);

        // start splitting
        uint32_t fblock = 0;

        path_ptr--;

        while (path_ptr > path) {

                rc = ext4_balloc_alloc_block(inode_ref, &fblock);
                if (rc != EOK) {
                        return rc;
                }

                block_t *block;
                rc = block_get(&block, inode_ref->fs->device, fblock, BLOCK_FLAGS_NOREAD);
                if (rc != EOK) {
                        ext4_balloc_free_block(inode_ref, fblock);
                        return rc;
                }

                // Init block
                memset(block->data, 0, block_size);

                // Not modified
                block_put(path_ptr->block);
                path_ptr->block = block;

                path_ptr->header = block->data;

                if (path_ptr->depth) {
                        path_ptr->index = EXT4_EXTENT_FIRST_INDEX(path_ptr->header);
                } else {
                        path_ptr->extent = EXT4_EXTENT_FIRST(path_ptr->header);
                }
        }

        return EOK;
}

int ext4_extent_append_block(ext4_inode_ref_t *inode_ref,
                uint32_t *iblock, uint32_t *fblock)
{
        int rc = EOK;

        ext4_superblock_t *sb = inode_ref->fs->superblock;
        uint64_t inode_size = ext4_inode_get_size(sb, inode_ref->inode);
        uint32_t block_size = ext4_superblock_get_block_size(sb);

        // Calculate number of new logical block
        uint32_t new_block_idx = 0;
        if (inode_size > 0) {
                if ((inode_size % block_size) != 0) {
                        inode_size += block_size - (inode_size % block_size);
                }
                new_block_idx = inode_size / block_size;
        }

        // Load the nearest leaf (with extent)
        ext4_extent_path_t *path;
        rc = ext4_extent_find_extent(inode_ref, new_block_idx, &path);
        if (rc != EOK) {
                return rc;
        }

        // Jump to last item of the path (extent)
        ext4_extent_path_t *path_ptr = path;
        while (path_ptr->depth != 0) {
                path_ptr++;
        }

        uint32_t phys_block = 0;

        // Add new extent to the node
        if (path_ptr->extent == NULL) {
                goto append_extent;
        }

        uint16_t block_count = ext4_extent_get_block_count(path_ptr->extent);
        uint16_t block_limit = (1 << 15);

        if (block_count < block_limit) {

                if (block_count == 0) {

                        rc = ext4_balloc_alloc_block(inode_ref, &phys_block);
                        if (rc != EOK) {
                        // TODO error, cleanup
                                assert(false);
                        }

                        ext4_extent_set_first_block(path_ptr->extent, new_block_idx);
                        ext4_extent_set_start(path_ptr->extent, phys_block);
                        ext4_extent_set_block_count(path_ptr->extent, 1);

                        path_ptr->block->dirty = true;

                        goto finish;
                } else {

                        phys_block = ext4_extent_get_start(path_ptr->extent);
                        phys_block += ext4_extent_get_block_count(path_ptr->extent);

                        bool free;
                        rc = ext4_balloc_try_alloc_block(inode_ref, phys_block, &free);
                        if (rc != EOK) {
                                // TODO error
                                assert(false);
                        }

                        if (! free) {
                                // target is not free
//                              EXT4FS_DBG("target not free, \%u", phys_block);
                                goto append_extent;
                        }


                        ext4_extent_set_block_count(path_ptr->extent, block_count + 1);

                        path_ptr->block->dirty = true;

                        goto finish;
                }
        }

        assert(false);

append_extent:

        phys_block = 0;
        // Allocate and insert insert new block
        rc = ext4_balloc_alloc_block(inode_ref, &phys_block);
        if (rc != EOK) {
                EXT4FS_DBG("error in block allocation, rc = \%d", rc);
                goto finish;
        }

//      EXT4FS_DBG("allocated \%u", phys_block);

        rc = ext4_extent_append_extent(inode_ref, path, &path_ptr, new_block_idx);
        if (rc != EOK) {
                ext4_balloc_free_block(inode_ref, phys_block);
                goto finish;
        }

        ext4_extent_set_block_count(path_ptr->extent, 1);
        ext4_extent_set_first_block(path_ptr->extent, new_block_idx);
        ext4_extent_set_start(path_ptr->extent, phys_block);

        path_ptr->block->dirty = true;

finish:

        *iblock = new_block_idx;
        *fblock = phys_block;

//      EXT4FS_DBG("iblock = \%u, fblock = \%u", new_block_idx, phys_block);

        // Put loaded blocks
        // From 1 -> 0 is a block with inode data
        for (uint16_t i = 1; i <= path->depth; ++i) {
                if (path[i].block) {
                        block_put(path[i].block);
                }
        }

        // Destroy temporary data structure
        free(path);

        return rc;
}

/**
 * @}
 */