lwext4/ext4_fs.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  *
   4  *
   5  * HelenOS:
   6  * Copyright (c) 2012 Martin Sucha
   7  * Copyright (c) 2012 Frantisek Princ
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  * - Redistributions of source code must retain the above copyright
  15  *   notice, this list of conditions and the following disclaimer.
  16  * - Redistributions in binary form must reproduce the above copyright
  17  *   notice, this list of conditions and the following disclaimer in the
  18  *   documentation and/or other materials provided with the distribution.
  19  * - The name of the author may not be used to endorse or promote products
  20  *   derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /** @addtogroup lwext4
  35  * @{
  36  */
  37 /**
  38  * @file  ext4_fs.c
  39  * @brief More complex filesystem functions.
  40  */
  41
  42 #ifndef EXT4_FS_H_
  43 #define EXT4_FS_H_
  44
  45 #include <ext4_config.h>
  46 #include <ext4_types.h>
  47
  48 #include <stdint.h>
  49 #include <stdbool.h>
  50
  51 /**@brief Initialize filesystem and read all needed data.
  52  * @param fs Filesystem instance to be initialized
  53  * @param bdev Identifier if device with the filesystem
  54  * @return Error code
  55  */
  56 int ext4_fs_init(struct ext4_fs *fs, struct ext4_blockdev *bdev);
  57
  58 /**@brief Destroy filesystem instance (used by unmount operation).
  59  * @param fs Filesystem to be destroyed
  60  * @return Error code
  61  */
  62 int ext4_fs_fini(struct ext4_fs *fs);
  63
  64 /**@brief Check filesystem's features, if supported by this driver
  65  * Function can return EOK and set read_only flag. It mean's that
  66  * there are some not-supported features, that can cause problems
  67  * during some write operations.
  68  * @param fs        Filesystem to be checked
  69  * @param read_only Flag if filesystem should be mounted only for reading
  70  * @return Error code
  71  */
  72 int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only);
  73
  74 /**@brief Convert block address to relative index in block group.
  75  * @param sb Superblock pointer
  76  * @param baddr Block number to convert
  77  * @return Relative number of block
  78  */
  79 uint32_t ext4_fs_baddr2_index_in_group(struct ext4_sblock *s, uint32_t baddr);
  80
  81 /**@brief Convert relative block address in group to absolute address.
  82  * @param s Superblock pointer
  83  * @param index Relative block address
  84  * @param bgid Block group
  85  * @return Absolute block address
  86  */
  87 uint32_t ext4_fs_index_in_group2_baddr(struct ext4_sblock *s, uint32_t index,
  88     uint32_t bgid);
  89
  90 /**@brief Get reference to block group specified by index.
  91  * @param fs   Filesystem to find block group on
  92  * @param bgid Index of block group to load
  93  * @param ref  Output pointer for reference
  94  * @return Error code
  95  */
  96 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
  97     struct ext4_block_group_ref *ref);
  98
  99 /**@brief Put reference to block group.
 100  * @param ref Pointer for reference to be put back
 101  * @return Error code
 102  */
 103 int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref);
 104
 105 /**@brief Get reference to i-node specified by index.
 106  * @param fs    Filesystem to find i-node on
 107  * @param index Index of i-node to load
 108  * @param ref   Output pointer for reference
 109  * @return Error code
 110  */
 111 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
 112     struct ext4_inode_ref *ref);
 113
 114 /**@brief Put reference to i-node.
 115  * @param ref Pointer for reference to be put back
 116  * @return Error code
 117  */
 118 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref);
 119
 120 /**@brief Allocate new i-node in the filesystem.
 121  * @param fs        Filesystem to allocated i-node on
 122  * @param inode_ref Output pointer to return reference to allocated i-node
 123  * @param flags     Flags to be set for newly created i-node
 124  * @return Error code
 125  */
 126 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
 127     bool is_directory);
 128
 129 /**@brief Release i-node and mark it as free.
 130  * @param inode_ref I-node to be released
 131  * @return Error code
 132  */
 133 int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref);
 134
 135 /**@brief Truncate i-node data blocks.
 136  * @param inode_ref I-node to be truncated
 137  * @param new_size  New size of inode (must be < current size)
 138  * @return Error code
 139  */
 140 int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref,
 141     uint64_t new_size);
 142
 143 /**@brief Get physical block address by logical index of the block.
 144  * @param inode_ref I-node to read block address from
 145  * @param iblock    Logical index of block
 146  * @param fblock    Output pointer for return physical block address
 147  * @return Error code
 148  */
 149 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
 150     uint64_t iblock, uint32_t *fblock);
 151
 152 /**@brief Set physical block address for the block logical address into the i-node.
 153  * @param inode_ref I-node to set block address to
 154  * @param iblock    Logical index of block
 155  * @param fblock    Physical block address
 156  * @return Error code
 157  */
 158 int ext4_fs_set_inode_data_block_index(struct ext4_inode_ref *inode_ref,
 159     uint64_t iblock, uint32_t fblock);
 160
 161 /**@brief Release data block from i-node
 162  * @param inode_ref I-node to release block from
 163  * @param iblock    Logical block to be released
 164  * @return Error code
 165  */
 166 int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
 167     uint32_t iblock);
 168
 169 /**@brief Append following logical block to the i-node.
 170  * @param inode_ref I-node to append block to
 171  * @param fblock    Output physical block address of newly allocated block
 172  * @param iblock    Output logical number of newly allocated block
 173  * @return Error code
 174  */
 175 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
 176     uint32_t *fblock, uint32_t *iblock);
 177
 178 #endif /* EXT4_FS_H_ */
 179
 180 /**
 181  * @}
 182  */