2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
6 * Copyright (c) 2012 Martin Sucha
7 * Copyright (c) 2012 Frantisek Princ
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
34 /** @addtogroup lwext4
39 * @brief More complex filesystem functions.
45 #include "ext4_config.h"
46 #include "ext4_types.h"
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
56 static inline uint32_t ext4_fs_baddr2_index_in_group(struct ext4_sblock *s,
59 if (ext4_get32(s, first_data_block))
62 return baddr % ext4_get32(s, blocks_per_group);
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
71 static inline ext4_fsblk_t ext4_fs_index_in_group2_baddr(struct ext4_sblock *s,
75 if (ext4_get32(s, first_data_block))
78 return ext4_get32(s, blocks_per_group) * bgid + index;
82 static inline ext4_fsblk_t ext4_fs_first_bg_block_no(struct ext4_sblock *s,
85 return (uint64_t)bgid * ext4_get32(s, blocks_per_group) +
86 ext4_get32(s, first_data_block);
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
94 int ext4_fs_init(struct ext4_fs *fs, struct ext4_blockdev *bdev);
96 /**@brief Destroy filesystem instance (used by unmount operation).
97 * @param fs Filesystem to be destroyed
100 int ext4_fs_fini(struct ext4_fs *fs);
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
110 int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only);
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
118 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
119 struct ext4_block_group_ref *ref);
121 /**@brief Put reference to block group.
122 * @param ref Pointer for reference to be put back
125 int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref);
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
133 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
134 struct ext4_inode_ref *ref);
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
140 void ext4_fs_inode_blocks_init(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref);
142 /**@brief Put reference to i-node.
143 * @param ref Pointer for reference to be put back
146 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref);
148 /**@brief Convert filetype to inode mode.
152 uint32_t ext4_fs_correspond_inode_mode(int filetype);
154 /**@brief Allocate new i-node in the filesystem.
155 * @param fs Filesystem to allocated i-node on
156 * @param inode_ref Output pointer to return reference to allocated i-node
157 * @param filetype File type of newly created i-node
160 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
163 /**@brief Release i-node and mark it as free.
164 * @param inode_ref I-node to be released
167 int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref);
169 /**@brief Truncate i-node data blocks.
170 * @param inode_ref I-node to be truncated
171 * @param new_size New size of inode (must be < current size)
174 int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref, uint64_t new_size);
176 /**@brief Compute 'goal' for inode index
177 * @param inode_ref Reference to inode, to allocate block for
180 ext4_fsblk_t ext4_fs_inode_to_goal_block(struct ext4_inode_ref *inode_ref);
182 /**@brief Compute 'goal' for allocation algorithm (For blockmap).
183 * @param inode_ref Reference to inode, to allocate block for
187 int ext4_fs_indirect_find_goal(struct ext4_inode_ref *inode_ref,
190 /**@brief Get physical block address by logical index of the block.
191 * @param inode_ref I-node to read block address from
192 * @param iblock Logical index of block
193 * @param fblock Output pointer for return physical
195 * @param support_unwritten Indicate whether unwritten block range
196 * is supported under the current context
199 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
200 uint64_t iblock, ext4_fsblk_t *fblock,
201 bool support_unwritten);
203 /**@brief Initialize a part of unwritten range of the inode.
204 * @param inode_ref I-node to proceed on.
205 * @param iblock Logical index of block
206 * @param fblock Output pointer for return physical block address
209 int ext4_fs_init_inode_data_block_index(struct ext4_inode_ref *inode_ref,
210 uint64_t iblock, ext4_fsblk_t *fblock);
212 /**@brief Append following logical block to the i-node.
213 * @param inode_ref I-node to append block to
214 * @param fblock Output physical block address of newly allocated block
215 * @param iblock Output logical number of newly allocated block
218 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
219 ext4_fsblk_t *fblock, uint32_t *iblock);
221 /**@brief Increment inode link count.
222 * @param inode none handle
224 void ext4_fs_inode_links_count_inc(struct ext4_inode_ref *inode_ref);
226 /**@brief Decrement inode link count.
227 * @param inode none handle
229 void ext4_fs_inode_links_count_dec(struct ext4_inode_ref *inode_ref);
231 #endif /* EXT4_FS_H_ */