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 Inode handle functions
49 #include "ext4_config.h"
50 #include "ext4_types.h"
54 /**@brief Get mode of the i-node.
55 * @param sb Superblock
56 * @param inode I-node to load mode from
57 * @return Mode of the i-node
59 uint32_t ext4_inode_get_mode(struct ext4_sblock *sb, struct ext4_inode *inode);
61 /**@brief Set mode of the i-node.
62 * @param sb Superblock
63 * @param inode I-node to set mode to
64 * @param mode Mode to set to i-node
66 void ext4_inode_set_mode(struct ext4_sblock *sb, struct ext4_inode *inode,
69 /**@brief Get ID of the i-node owner (user id).
70 * @param inode I-node to load uid from
71 * @return User ID of the i-node owner
73 uint32_t ext4_inode_get_uid(struct ext4_inode *inode);
75 /**@brief Set ID of the i-node owner.
76 * @param inode I-node to set uid to
77 * @param uid ID of the i-node owner
79 void ext4_inode_set_uid(struct ext4_inode *inode, uint32_t uid);
81 /**@brief Get real i-node size.
82 * @param sb Superblock
83 * @param inode I-node to load size from
84 * @return Real size of i-node
86 uint64_t ext4_inode_get_size(struct ext4_sblock *sb, struct ext4_inode *inode);
88 /**@brief Set real i-node size.
89 * @param inode I-node to set size to
90 * @param size Size of the i-node
92 void ext4_inode_set_size(struct ext4_inode *inode, uint64_t size);
94 /**@brief Get time, when i-node was last accessed.
96 * @return Time of the last access (POSIX)
98 uint32_t ext4_inode_get_access_time(struct ext4_inode *inode);
100 /**@brief Set time, when i-node was last accessed.
101 * @param inode I-node
102 * @param time Time of the last access (POSIX)
104 void ext4_inode_set_access_time(struct ext4_inode *inode, uint32_t time);
106 /**@brief Get time, when i-node was last changed.
107 * @param inode I-node
108 * @return Time of the last change (POSIX)
110 uint32_t ext4_inode_get_change_inode_time(struct ext4_inode *inode);
112 /**@brief Set time, when i-node was last changed.
113 * @param inode I-node
114 * @param time Time of the last change (POSIX)
116 void ext4_inode_set_change_inode_time(struct ext4_inode *inode, uint32_t time);
118 /**@brief Get time, when i-node content was last modified.
119 * @param inode I-node
120 * @return Time of the last content modification (POSIX)
122 uint32_t ext4_inode_get_modif_time(struct ext4_inode *inode);
124 /**@brief Set time, when i-node content was last modified.
125 * @param inode I-node
126 * @param time Time of the last content modification (POSIX)
128 void ext4_inode_set_modif_time(struct ext4_inode *inode, uint32_t time);
130 /**@brief Get time, when i-node was deleted.
131 * @param inode I-node
132 * @return Time of the delete action (POSIX)
134 uint32_t ext4_inode_get_del_time(struct ext4_inode *inode);
136 /**@brief Set time, when i-node was deleted.
137 * @param inode I-node
138 * @param time Time of the delete action (POSIX)
140 void ext4_inode_set_del_time(struct ext4_inode *inode, uint32_t time);
142 /**@brief Get ID of the i-node owner's group.
143 * @param inode I-node to load gid from
144 * @return Group ID of the i-node owner
146 uint32_t ext4_inode_get_gid(struct ext4_inode *inode);
148 /**@brief Set ID to the i-node owner's group.
149 * @param inode I-node to set gid to
150 * @param gid Group ID of the i-node owner
152 void ext4_inode_set_gid(struct ext4_inode *inode, uint32_t gid);
154 /**@brief Get number of links to i-node.
155 * @param inode I-node to load number of links from
156 * @return Number of links to i-node
158 uint16_t ext4_inode_get_links_cnt(struct ext4_inode *inode);
160 /**@brief Set number of links to i-node.
161 * @param inode I-node to set number of links to
162 * @param count Number of links to i-node
164 void ext4_inode_set_links_cnt(struct ext4_inode *inode, uint16_t cnt);
166 /**@brief Get number of 512-bytes blocks used for i-node.
167 * @param sb Superblock
168 * @param inode I-node
169 * @return Number of 512-bytes blocks
171 uint64_t ext4_inode_get_blocks_count(struct ext4_sblock *sb,
172 struct ext4_inode *inode);
174 /**@brief Set number of 512-bytes blocks used for i-node.
175 * @param sb Superblock
176 * @param inode I-node
177 * @param count Number of 512-bytes blocks
180 int ext4_inode_set_blocks_count(struct ext4_sblock *sb,
181 struct ext4_inode *inode, uint64_t cnt);
183 /**@brief Get flags (features) of i-node.
184 * @param inode I-node to get flags from
185 * @return Flags (bitmap)
187 uint32_t ext4_inode_get_flags(struct ext4_inode *inode);
189 /**@brief Set flags (features) of i-node.
190 * @param inode I-node to set flags to
191 * @param flags Flags to set to i-node
193 void ext4_inode_set_flags(struct ext4_inode *inode, uint32_t flags);
195 /**@brief Get file generation (used by NFS).
196 * @param inode I-node
197 * @return File generation
199 uint32_t ext4_inode_get_generation(struct ext4_inode *inode);
201 /**@brief Set file generation (used by NFS).
202 * @param inode I-node
203 * @param generation File generation
205 void ext4_inode_set_generation(struct ext4_inode *inode, uint32_t gen);
207 /**@brief Get extra I-node size field.
208 * @param inode I-node
209 * @return extra I-node size
211 uint16_t ext4_inode_get_extra_isize(struct ext4_inode *inode);
213 /**@brief Set extra I-node size field.
214 * @param inode I-node
215 * @param size extra I-node size
217 void ext4_inode_set_extra_isize(struct ext4_inode *inode, uint16_t size);
219 /**@brief Get address of block, where are extended attributes located.
220 * @param inode I-node
221 * @param sb Superblock
222 * @return Block address
224 uint64_t ext4_inode_get_file_acl(struct ext4_inode *inode,
225 struct ext4_sblock *sb);
227 /**@brief Set address of block, where are extended attributes located.
228 * @param inode I-node
229 * @param sb Superblock
230 * @param file_acl Block address
232 void ext4_inode_set_file_acl(struct ext4_inode *inode, struct ext4_sblock *sb,
235 /**@brief Get block address of specified direct block.
236 * @param inode I-node to load block from
237 * @param idx Index of logical block
238 * @return Physical block address
240 uint32_t ext4_inode_get_direct_block(struct ext4_inode *inode, uint32_t idx);
242 /**@brief Set block address of specified direct block.
243 * @param inode I-node to set block address to
244 * @param idx Index of logical block
245 * @param fblock Physical block address
247 void ext4_inode_set_direct_block(struct ext4_inode *inode, uint32_t idx,
250 /**@brief Get block address of specified indirect block.
251 * @param inode I-node to get block address from
252 * @param idx Index of indirect block
253 * @return Physical block address
255 uint32_t ext4_inode_get_indirect_block(struct ext4_inode *inode, uint32_t idx);
257 /**@brief Set block address of specified indirect block.
258 * @param inode I-node to set block address to
259 * @param idx Index of indirect block
260 * @param fblock Physical block address
262 void ext4_inode_set_indirect_block(struct ext4_inode *inode, uint32_t idx,
265 /**@brief return the type of i-node
266 * @param sb Superblock
267 * @param inode I-node to return the type of
268 * @return Result of check operation
270 uint32_t ext4_inode_type(struct ext4_sblock *sb, struct ext4_inode *inode);
272 /**@brief Check if i-node has specified type.
273 * @param sb Superblock
274 * @param inode I-node to check type of
275 * @param type Type to check
276 * @return Result of check operation
278 bool ext4_inode_is_type(struct ext4_sblock *sb, struct ext4_inode *inode,
281 /**@brief Check if i-node has specified flag.
282 * @param inode I-node to check flags of
283 * @param flag Flag to check
284 * @return Result of check operation
286 bool ext4_inode_has_flag(struct ext4_inode *inode, uint32_t f);
288 /**@brief Remove specified flag from i-node.
289 * @param inode I-node to clear flag on
290 * @param clear_flag Flag to be cleared
292 void ext4_inode_clear_flag(struct ext4_inode *inode, uint32_t f);
294 /**@brief Set specified flag to i-node.
295 * @param inode I-node to set flag on
296 * @param set_flag Flag to be set
298 void ext4_inode_set_flag(struct ext4_inode *inode, uint32_t f);
300 /**@brief Get inode checksum(crc32)
301 * @param sb Superblock
302 * @param inode I-node to get checksum value from
305 ext4_inode_get_csum(struct ext4_sblock *sb, struct ext4_inode *inode);
307 /**@brief Get inode checksum(crc32)
308 * @param sb Superblock
309 * @param inode I-node to get checksum value from
312 ext4_inode_set_csum(struct ext4_sblock *sb, struct ext4_inode *inode,
315 /**@brief Check if i-node can be truncated.
316 * @param sb Superblock
317 * @param inode I-node to check
318 * @return Result of the check operation
320 bool ext4_inode_can_truncate(struct ext4_sblock *sb, struct ext4_inode *inode);
322 /**@brief Get extent header from the root of the extent tree.
323 * @param inode I-node to get extent header from
324 * @return Pointer to extent header of the root node
326 struct ext4_extent_header *
327 ext4_inode_get_extent_header(struct ext4_inode *inode);
333 #endif /* EXT4_INODE_H_ */