source: mainline/uspace/lib/ext4/libext4_superblock.c@ 47faec1

/*
 * 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_superblock.c
 * @brief       Ext4 superblock operations.
 */

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

uint32_t ext4_superblock_get_inodes_count(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->inodes_count);
}

void ext4_superblock_set_inodes_count(ext4_superblock_t *sb, uint32_t count)
{
        sb->inodes_count = host2uint32_t_le(count);
}

uint64_t ext4_superblock_get_blocks_count(ext4_superblock_t *sb)
{
        return ((uint64_t)uint32_t_le2host(sb->blocks_count_hi) << 32) |
                        uint32_t_le2host(sb->blocks_count_lo);
}

void ext4_superblock_set_blocks_count(ext4_superblock_t *sb, uint64_t count)
{
        sb->blocks_count_lo = host2uint32_t_le((count << 32) >> 32);
        sb->blocks_count_hi = host2uint32_t_le(count >> 32);
}

uint64_t ext4_superblock_get_reserved_blocks_count(ext4_superblock_t *sb)
{
        return ((uint64_t)uint32_t_le2host(sb->reserved_blocks_count_hi) << 32) |
                        uint32_t_le2host(sb->reserved_blocks_count_lo);
}

void ext4_superblock_set_reserved_blocks_count(ext4_superblock_t *sb, uint64_t count)
{
        sb->reserved_blocks_count_lo = host2uint32_t_le((count << 32) >> 32);
        sb->reserved_blocks_count_hi = host2uint32_t_le(count >> 32);
}

uint64_t ext4_superblock_get_free_blocks_count(ext4_superblock_t *sb)
{
        return ((uint64_t)uint32_t_le2host(sb->free_blocks_count_hi) << 32) |
                        uint32_t_le2host(sb->free_blocks_count_lo);
}

void ext4_superblock_set_free_blocks_count(ext4_superblock_t *sb, uint64_t count)
{
        sb->free_blocks_count_lo = host2uint32_t_le((count << 32) >> 32);
        sb->free_blocks_count_hi = host2uint32_t_le(count >> 32);
}

uint32_t ext4_superblock_get_free_inodes_count(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->free_inodes_count);
}

void ext4_superblock_set_free_inodes_count(ext4_superblock_t *sb, uint32_t count)
{
        sb->free_inodes_count = host2uint32_t_le(count);
}

uint32_t ext4_superblock_get_first_data_block(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->first_data_block);
}

void ext4_superblock_set_first_data_block(ext4_superblock_t *sb, uint32_t first)
{
        sb->first_data_block = host2uint32_t_le(first);
}

uint32_t ext4_superblock_get_log_block_size(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->log_block_size);
}

void ext4_superblock_set_log_block_size(ext4_superblock_t *sb, uint32_t log_size)
{
        sb->log_block_size = host2uint32_t_le(log_size);
}

uint32_t ext4_superblock_get_block_size(ext4_superblock_t *sb)
{
        return 1024 << ext4_superblock_get_log_block_size(sb);
}

void ext4_superblock_set_block_size(ext4_superblock_t *sb, uint32_t size)
{
        uint32_t log = 0;
        uint32_t tmp = size / EXT4_MIN_BLOCK_SIZE;

        tmp >>= 1;
        while (tmp) {
                log++;
                tmp >>= 1;
        }

        ext4_superblock_set_log_block_size(sb, log);
}

uint32_t ext4_superblock_get_blocks_per_group(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->blocks_per_group);
}

void ext4_superblock_set_blocks_per_group(ext4_superblock_t *sb, uint32_t blocks)
{
        sb->blocks_per_group = host2uint32_t_le(blocks);
}

uint32_t ext4_superblock_get_inodes_per_group(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->inodes_per_group);
}

void ext4_superblock_set_inodes_per_group(ext4_superblock_t *sb, uint32_t inodes)
{
        sb->inodes_per_group = host2uint32_t_le(inodes);
}

uint32_t ext4_superblock_get_mount_time(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->mount_time);
}

void ext4_superblock_set_mount_time(ext4_superblock_t *sb, uint32_t time)
{
        sb->mount_time = host2uint32_t_le(time);
}

uint32_t ext4_superblock_get_write_time(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->write_time);
}

void ext4_superblock_set_write_time(ext4_superblock_t *sb, uint32_t time)
{
        sb->write_time = host2uint32_t_le(time);
}

uint16_t ext4_superblock_get_mount_count(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->mount_count);
}

void ext4_superblock_set_mount_count(ext4_superblock_t *sb, uint16_t count)
{
        sb->mount_count = host2uint16_t_le(count);
}

uint16_t ext4_superblock_get_max_mount_count(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->max_mount_count);
}

void ext4_superblock_set_max_mount_count(ext4_superblock_t *sb, uint16_t count)
{
        sb->max_mount_count = host2uint16_t_le(count);
}

uint16_t ext4_superblock_get_magic(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->magic);
}

uint16_t ext4_superblock_get_state(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->state);
}

void ext4_superblock_set_state(ext4_superblock_t *sb, uint16_t state)
{
        sb->state = host2uint16_t_le(state);
}

uint16_t ext4_superblock_get_errors(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->errors);
}

void ext4_superblock_set_errors(ext4_superblock_t *sb, uint16_t errors)
{
        sb->errors = host2uint16_t_le(errors);
}

uint16_t ext4_superblock_get_minor_rev_level(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->minor_rev_level);
}

void ext4_superblock_set_minor_rev_level(ext4_superblock_t *sb, uint16_t level)
{
        sb->minor_rev_level = host2uint16_t_le(level);
}

uint32_t ext4_superblock_get_last_check_time(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->last_check_time);
}

void ext4_superblock_set_last_check_time(ext4_superblock_t *sb, uint32_t time)
{
        sb->state = host2uint32_t_le(time);
}

uint32_t ext4_superblock_get_check_interval(ext4_superblock_t *sb){
        return uint32_t_le2host(sb->check_interval);
}

void ext4_superblock_set_check_interval(ext4_superblock_t *sb, uint32_t interval)
{
        sb->check_interval = host2uint32_t_le(interval);
}

uint32_t ext4_superblock_get_creator_os(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->creator_os);
}

void ext4_superblock_set_creator_os(ext4_superblock_t *sb, uint32_t os)
{
        sb->creator_os = host2uint32_t_le(os);
}

uint32_t ext4_superblock_get_rev_level(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->rev_level);
}

void ext4_superblock_set_rev_level(ext4_superblock_t *sb, uint32_t level)
{
        sb->rev_level = host2uint32_t_le(level);
}

uint16_t ext4_superblock_get_def_resuid(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->def_resuid);
}

void ext4_superblock_set_def_resuid(ext4_superblock_t *sb, uint16_t uid)
{
        sb->def_resuid = host2uint16_t_le(uid);
}

uint16_t ext4_superblock_get_def_resgid(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->def_resgid);
}

void ext4_superblock_set_def_resgid(ext4_superblock_t *sb, uint16_t gid)
{
        sb->def_resgid = host2uint16_t_le(gid);
}

uint32_t ext4_superblock_get_first_inode(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->first_inode);
}

void ext4_superblock_set_first_inode(ext4_superblock_t *sb, uint32_t first_inode)
{
        sb->first_inode = host2uint32_t_le(first_inode);
}

uint16_t ext4_superblock_get_inode_size(ext4_superblock_t *sb)
{
        if (ext4_superblock_get_rev_level(sb) == 0) {
                return EXT4_REV0_INODE_SIZE;
        }
        return uint16_t_le2host(sb->inode_size);
}

void ext4_superblock_set_inode_size(ext4_superblock_t *sb, uint16_t size)
{
        sb->inode_size = host2uint16_t_le(size);
}

uint16_t ext4_superblock_get_block_group_number(ext4_superblock_t *sb)
{
        return uint16_t_le2host(sb->block_group_number);
}

void ext4_superblock_set_block_group_number(ext4_superblock_t *sb, uint16_t bg)
{
        sb->block_group_number = host2uint16_t_le(bg);
}

uint32_t ext4_superblock_get_features_compatible(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->features_compatible);
}

void ext4_superblock_set_features_compatible(ext4_superblock_t *sb, uint32_t features)
{
        sb->features_compatible = host2uint32_t_le(features);
}

uint32_t ext4_superblock_get_features_incompatible(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->features_incompatible);
}

void ext4_superblock_set_features_incompatible(ext4_superblock_t *sb, uint32_t features)
{
        sb->features_incompatible = host2uint32_t_le(features);
}

uint32_t ext4_superblock_get_features_read_only(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->features_read_only);
}

void ext4_superblock_set_features_read_only(ext4_superblock_t *sb, uint32_t features)
{
        sb->features_read_only = host2uint32_t_le(features);
}

uint32_t ext4_superblock_get_last_orphan(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->last_orphan);
}

void ext4_superblock_set_last_orphan(ext4_superblock_t *sb, uint32_t last_orphan)
{
        sb->last_orphan = host2uint32_t_le(last_orphan);
}

uint32_t* ext4_superblock_get_hash_seed(ext4_superblock_t *sb)
{
        return sb->hash_seed;
}

uint16_t ext4_superblock_get_desc_size(ext4_superblock_t *sb)
{
        uint16_t size = uint16_t_le2host(sb->desc_size);

        if (size < EXT4_BLOCK_MIN_GROUP_DESCRIPTOR_SIZE) {
                size = EXT4_BLOCK_MIN_GROUP_DESCRIPTOR_SIZE;
        }

        return size;
}

void ext4_superblock_set_desc_size(ext4_superblock_t *sb, uint16_t size)
{
        sb->desc_size = host2uint16_t_le(size);
}

uint32_t ext4_superblock_get_flags(ext4_superblock_t *sb)
{
        return uint32_t_le2host(sb->flags);
}

void ext4_superblock_set_flags(ext4_superblock_t *sb, uint32_t flags)
{
        sb->flags = host2uint32_t_le(flags);
}


/*
 * More complex superblock operations
 */

bool ext4_superblock_has_flag(ext4_superblock_t *sb, uint32_t flag)
{
        if (ext4_superblock_get_flags(sb) & flag) {
                return true;
        }
        return false;
}

// Feature checkers
bool ext4_superblock_has_feature_compatible(ext4_superblock_t *sb, uint32_t feature)
{
        if (ext4_superblock_get_features_compatible(sb) & feature) {
                return true;
        }
        return false;
}

bool ext4_superblock_has_feature_incompatible(ext4_superblock_t *sb, uint32_t feature)
{
        if (ext4_superblock_get_features_incompatible(sb) & feature) {
                return true;
        }
        return false;
}

bool ext4_superblock_has_feature_read_only(ext4_superblock_t *sb, uint32_t feature)
{
        if (ext4_superblock_get_features_read_only(sb) & feature) {
                return true;
        }
        return false;
}


int ext4_superblock_read_direct(service_id_t service_id,
    ext4_superblock_t **superblock)
{
        int rc;

        void *data = malloc(EXT4_SUPERBLOCK_SIZE);
        if (data == NULL) {
                return ENOMEM;
        }

        rc = block_read_bytes_direct(service_id, EXT4_SUPERBLOCK_OFFSET,
            EXT4_SUPERBLOCK_SIZE, data);

        if (rc != EOK) {
                free(data);
                return rc;
        }

        (*superblock) = data;

        return EOK;
}

int ext4_superblock_write_direct(service_id_t service_id,
                ext4_superblock_t *sb)
{
        int rc;
        uint32_t phys_block_size;

        rc = block_get_bsize(service_id, &phys_block_size);
        if (rc != EOK) {
                // TODO error
                return rc;
        }

        uint64_t first_block = EXT4_SUPERBLOCK_OFFSET / phys_block_size;
        uint32_t block_count = EXT4_SUPERBLOCK_SIZE / phys_block_size;

        if (EXT4_SUPERBLOCK_SIZE % phys_block_size) {
                block_count++;
        }

        return block_write_direct(service_id, first_block, block_count, sb);

}


int ext4_superblock_check_sanity(ext4_superblock_t *sb)
{
        if (ext4_superblock_get_magic(sb) != EXT4_SUPERBLOCK_MAGIC) {
                return ENOTSUP;
        }

        // block size
        // desc size


        // TODO more checks !!!

        return EOK;
}

uint32_t ext4_superblock_get_block_group_count(ext4_superblock_t *sb)
{
        uint64_t blocks_count = ext4_superblock_get_blocks_count(sb);
        uint32_t blocks_per_group = ext4_superblock_get_blocks_per_group(sb);

        uint32_t block_groups_count = blocks_count / blocks_per_group;

        if (blocks_count % blocks_per_group) {
                block_groups_count++;
        }

        return block_groups_count;

}

uint32_t ext4_superblock_get_blocks_in_group(ext4_superblock_t *sb, uint32_t bgid)
{
        uint32_t block_group_count = ext4_superblock_get_block_group_count(sb);
        uint32_t blocks_per_group = ext4_superblock_get_blocks_per_group(sb);
        uint64_t total_blocks = ext4_superblock_get_blocks_count(sb);

        if (bgid < block_group_count - 1) {
                return blocks_per_group;
        } else {
                return (total_blocks - ((block_group_count - 1) * blocks_per_group));
        }

}

uint32_t ext4_superblock_get_inodes_in_group(ext4_superblock_t *sb, uint32_t bgid)
{
        uint32_t block_group_count = ext4_superblock_get_block_group_count(sb);
        uint32_t inodes_per_group = ext4_superblock_get_inodes_per_group(sb);
        uint32_t total_inodes = ext4_superblock_get_inodes_count(sb);

        if (bgid < block_group_count - 1) {
                return inodes_per_group;
        } else {
                return (total_inodes - ((block_group_count - 1) * inodes_per_group));
        }

}

/**
 * @}
 */