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