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 Convert block address to relative index in block group.
  52  * @param sb Superblock pointer
  53  * @param baddr Block number to convert
  54  * @return Relative number of block
  55  */
  56 static inline uint32_t ext4_fs_baddr2_index_in_group(struct ext4_sblock *s,
  57                                                      uint32_t baddr)
  58 {
  59         if (ext4_get32(s, first_data_block))
  60                 baddr--;
  61
  62         return baddr % ext4_get32(s, blocks_per_group);
  63 }
  64
  65 /**@brief Convert relative block address in group to absolute address.
  66  * @param s Superblock pointer
  67  * @param index Relative block address
  68  * @param bgid Block group
  69  * @return Absolute block address
  70  */
  71 static inline uint32_t ext4_fs_index_in_group2_baddr(struct ext4_sblock *s,
  72                                                      uint32_t index,
  73                                                      uint32_t bgid)
  74 {
  75         if (ext4_get32(s, first_data_block))
  76                 index++;
  77
  78         return ext4_get32(s, blocks_per_group) * bgid + index;
  79 }
  80
  81 /**@brief TODO: */
  82 static inline uint64_t ext4_fs_first_bg_block_no(struct ext4_sblock *s,
  83                                                  uint32_t bgid)
  84 {
  85         return (uint64_t)bgid * ext4_get32(s, blocks_per_group) +
  86                ext4_get32(s, first_data_block);
  87 }
  88
  89 /**@brief Initialize filesystem and read all needed data.
  90  * @param fs Filesystem instance to be initialized
  91  * @param bdev Identifier if device with the filesystem
  92  * @return Error code
  93  */
  94 int ext4_fs_init(struct ext4_fs *fs, struct ext4_blockdev *bdev);
  95
  96 /**@brief Destroy filesystem instance (used by unmount operation).
  97  * @param fs Filesystem to be destroyed
  98  * @return Error code
  99  */
 100 int ext4_fs_fini(struct ext4_fs *fs);
 101
 102 /**@brief Check filesystem's features, if supported by this driver
 103  * Function can return EOK and set read_only flag. It mean's that
 104  * there are some not-supported features, that can cause problems
 105  * during some write operations.
 106  * @param fs        Filesystem to be checked
 107  * @param read_only Flag if filesystem should be mounted only for reading
 108  * @return Error code
 109  */
 110 int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only);
 111
 112 /**@brief Get reference to block group specified by index.
 113  * @param fs   Filesystem to find block group on
 114  * @param bgid Index of block group to load
 115  * @param ref  Output pointer for reference
 116  * @return Error code
 117  */
 118 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
 119                                 struct ext4_block_group_ref *ref);
 120
 121 /**@brief Put reference to block group.
 122  * @param ref Pointer for reference to be put back
 123  * @return Error code
 124  */
 125 int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref);
 126
 127 /**@brief Get reference to i-node specified by index.
 128  * @param fs    Filesystem to find i-node on
 129  * @param index Index of i-node to load
 130  * @param ref   Output pointer for reference
 131  * @return Error code
 132  */
 133 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
 134                           struct ext4_inode_ref *ref);
 135
 136 /**@brief Reset blocks field of i-node.
 137  * @param fs        Filesystem to reset blocks field of i-inode on
 138  * @param inode_ref ref Pointer for inode to be operated on
 139  */
 140 void ext4_fs_inode_blocks_init(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref);
 141
 142 /**@brief Put reference to i-node.
 143  * @param ref Pointer for reference to be put back
 144  * @return Error code
 145  */
 146 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref);
 147
 148 /**@brief Allocate new i-node in the filesystem.
 149  * @param fs        Filesystem to allocated i-node on
 150  * @param inode_ref Output pointer to return reference to allocated i-node
 151  * @param filetype  File type of newly created i-node
 152  * @return Error code
 153  */
 154 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
 155                         int filetype);
 156
 157 /**@brief Release i-node and mark it as free.
 158  * @param inode_ref I-node to be released
 159  * @return Error code
 160  */
 161 int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref);
 162
 163 /**@brief Truncate i-node data blocks.
 164  * @param inode_ref I-node to be truncated
 165  * @param new_size  New size of inode (must be < current size)
 166  * @return Error code
 167  */
 168 int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref, uint64_t new_size);
 169
 170 /**@brief Get physical block address by logical index of the block.
 171  * @param inode_ref I-node to read block address from
 172  * @param iblock    Logical index of block
 173  * @param fblock    Output pointer for return physical block address
 174  * @return Error code
 175  */
 176 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
 177                                        uint64_t iblock, uint32_t *fblock);
 178
 179 /**@brief Set physical block address for the block logical address into the
 180  * i-node.
 181  * @param inode_ref I-node to set block address to
 182  * @param iblock    Logical index of block
 183  * @param fblock    Physical block address
 184  * @return Error code
 185  */
 186 int ext4_fs_set_inode_data_block_index(struct ext4_inode_ref *inode_ref,
 187                                        uint64_t iblock, uint32_t fblock);
 188
 189 /**@brief Release data block from i-node
 190  * @param inode_ref I-node to release block from
 191  * @param iblock    Logical block to be released
 192  * @return Error code
 193  */
 194 int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
 195                                 uint32_t iblock);
 196
 197 /**@brief Append following logical block to the i-node.
 198  * @param inode_ref I-node to append block to
 199  * @param fblock    Output physical block address of newly allocated block
 200  * @param iblock    Output logical number of newly allocated block
 201  * @return Error code
 202  */
 203 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
 204                                uint32_t *fblock, uint32_t *iblock);
 205
 206 /**@brief   Increment inode link count.
 207  * @param   inode none handle
 208  */
 209 void ext4_fs_inode_links_count_inc(struct ext4_inode_ref *inode_ref);
 210
 211 /**@brief   Decrement inode link count.
 212  * @param   inode none handle
 213  */
 214 void ext4_fs_inode_links_count_dec(struct ext4_inode_ref *inode_ref);
 215
 216 #endif /* EXT4_FS_H_ */
 217
 218 /**
 219  * @}
 220  */