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