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,
60 if (ext4_get32(s, first_data_block))
63 return baddr % ext4_get32(s, blocks_per_group);
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
72 static inline uint32_t ext4_fs_index_in_group2_baddr(struct ext4_sblock *s,
76 if (ext4_get32(s, first_data_block))
79 return ext4_get32(s, blocks_per_group) * bgid + index;
83 static inline uint64_t ext4_fs_first_bg_block_no(struct ext4_sblock *s,
86 return (uint64_t)bgid * ext4_get32(s, blocks_per_group) +
87 ext4_get32(s, first_data_block);
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
95 int ext4_fs_init(struct ext4_fs *fs, struct ext4_blockdev *bdev);
97 /**@brief Destroy filesystem instance (used by unmount operation).
98 * @param fs Filesystem to be destroyed
101 int ext4_fs_fini(struct ext4_fs *fs);
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
111 int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only);
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
119 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
120 struct ext4_block_group_ref *ref);
122 /**@brief Put reference to block group.
123 * @param ref Pointer for reference to be put back
126 int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref);
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
134 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
135 struct ext4_inode_ref *ref);
137 /**@brief Put reference to i-node.
138 * @param ref Pointer for reference to be put back
141 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref);
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
149 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
152 /**@brief Release i-node and mark it as free.
153 * @param inode_ref I-node to be released
156 int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref);
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)
163 int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref, uint64_t new_size);
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
171 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
172 uint64_t iblock, uint32_t *fblock);
174 /**@brief Set physical block address for the block logical address into the
176 * @param inode_ref I-node to set block address to
177 * @param iblock Logical index of block
178 * @param fblock Physical block address
181 int ext4_fs_set_inode_data_block_index(struct ext4_inode_ref *inode_ref,
182 uint64_t iblock, uint32_t fblock);
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
189 int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
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
198 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
199 uint32_t *fblock, uint32_t *iblock);
201 /**@brief Increment inode link count.
202 * @param inode none handle
204 void ext4_fs_inode_links_count_inc(struct ext4_inode_ref *inode_ref);
206 /**@brief Decrement inode link count.
207 * @param inode none handle
209 void ext4_fs_inode_links_count_dec(struct ext4_inode_ref *inode_ref);
211 #endif /* EXT4_FS_H_ */