ext4_journal: simple handling on superblock.
[lwext4.git] / lwext4 / ext4_fs.h
index 5afa48fb42c3932696c7dcd6dda0bc5349550978..17019e5dd97054cc0d97efa3a524eea918069a08 100644 (file)
 #ifndef EXT4_FS_H_
 #define EXT4_FS_H_
 
-#include <ext4_config.h>
-#include <ext4_types.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "ext4_config.h"
+#include "ext4_types.h"
 
 #include <stdint.h>
 #include <stdbool.h>
  * @param baddr Block number to convert
  * @return Relative number of block
  */
-static inline uint32_t ext4_fs_baddr2_index_in_group(struct ext4_sblock *s,
-        uint32_t baddr)
+static inline uint32_t ext4_fs_addr_to_idx_bg(struct ext4_sblock *s,
+                                                    ext4_fsblk_t baddr)
 {
-    ext4_assert(baddr);
-    if(ext4_get32(s, first_data_block))
-        baddr--;
+       if (ext4_get32(s, first_data_block))
+               baddr--;
 
-    return  baddr % ext4_get32(s, blocks_per_group);
+       return baddr % ext4_get32(s, blocks_per_group);
 }
 
-
 /**@brief Convert relative block address in group to absolute address.
  * @param s Superblock pointer
  * @param index Relative block address
  * @param bgid Block group
  * @return Absolute block address
  */
-static inline uint32_t ext4_fs_index_in_group2_baddr(struct ext4_sblock *s,
-        uint32_t index, uint32_t bgid)
+static inline ext4_fsblk_t ext4_fs_bg_idx_to_addr(struct ext4_sblock *s,
+                                                    uint32_t index,
+                                                    uint32_t bgid)
 {
-    if(ext4_get32(s, first_data_block))
-        index++;
+       if (ext4_get32(s, first_data_block))
+               index++;
 
-    return ext4_get32(s, blocks_per_group) * bgid + index;
+       return ext4_get32(s, blocks_per_group) * bgid + index;
 }
 
 /**@brief TODO: */
-static inline uint64_t ext4_fs_first_bg_block_no(struct ext4_sblock *s,
-        uint32_t bgid)
+static inline ext4_fsblk_t ext4_fs_first_bg_block_no(struct ext4_sblock *s,
+                                                uint32_t bgid)
 {
-    return (uint64_t)bgid * ext4_get32(s, blocks_per_group) +
-            ext4_get32(s, first_data_block);
+       return (uint64_t)bgid * ext4_get32(s, blocks_per_group) +
+              ext4_get32(s, first_data_block);
 }
 
 /**@brief Initialize filesystem and read all needed data.
@@ -117,7 +120,7 @@ int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only);
  * @return Error code
  */
 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
-    struct ext4_block_group_ref *ref);
+                               struct ext4_block_group_ref *ref);
 
 /**@brief Put reference to block group.
  * @param ref Pointer for reference to be put back
@@ -132,7 +135,13 @@ int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref);
  * @return Error code
  */
 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
-    struct ext4_inode_ref *ref);
+                         struct ext4_inode_ref *ref);
+
+/**@brief Reset blocks field of i-node.
+ * @param fs        Filesystem to reset blocks field of i-inode on
+ * @param inode_ref ref Pointer for inode to be operated on
+ */
+void ext4_fs_inode_blocks_init(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref);
 
 /**@brief Put reference to i-node.
  * @param ref Pointer for reference to be put back
@@ -140,14 +149,20 @@ int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
  */
 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref);
 
+/**@brief Convert filetype to inode mode.
+ * @param filetype
+ * @return inode mode
+ */
+uint32_t ext4_fs_correspond_inode_mode(int filetype);
+
 /**@brief Allocate new i-node in the filesystem.
  * @param fs        Filesystem to allocated i-node on
  * @param inode_ref Output pointer to return reference to allocated i-node
- * @param flags     Flags to be set for newly created i-node
+ * @param filetype  File type of newly created i-node
  * @return Error code
  */
 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
-    bool is_directory);
+                       int filetype);
 
 /**@brief Release i-node and mark it as free.
  * @param inode_ref I-node to be released
@@ -160,34 +175,43 @@ int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref);
  * @param new_size  New size of inode (must be < current size)
  * @return Error code
  */
-int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref,
-    uint64_t new_size);
+int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref, uint64_t new_size);
+
+/**@brief Compute 'goal' for inode index
+ * @param inode_ref Reference to inode, to allocate block for
+ * @return goal
+ */
+ext4_fsblk_t ext4_fs_inode_to_goal_block(struct ext4_inode_ref *inode_ref);
+
+/**@brief Compute 'goal' for allocation algorithm (For blockmap).
+ * @param inode_ref Reference to inode, to allocate block for
+ * @param goal
+ * @return error code
+ */
+int ext4_fs_indirect_find_goal(struct ext4_inode_ref *inode_ref,
+                               ext4_fsblk_t *goal);
 
 /**@brief Get physical block address by logical index of the block.
  * @param inode_ref I-node to read block address from
- * @param iblock    Logical index of block
- * @param fblock    Output pointer for return physical block address
+ * @param iblock            Logical index of block
+ * @param fblock            Output pointer for return physical
+ *                          block address
+ * @param support_unwritten Indicate whether unwritten block range
+ *                          is supported under the current context
  * @return Error code
  */
 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
-    uint64_t iblock, uint32_t *fblock);
+                                      uint64_t iblock, ext4_fsblk_t *fblock,
+                                      bool support_unwritten);
 
-/**@brief Set physical block address for the block logical address into the i-node.
- * @param inode_ref I-node to set block address to
+/**@brief Initialize a part of unwritten range of the inode.
+ * @param inode_ref I-node to proceed on.
  * @param iblock    Logical index of block
- * @param fblock    Physical block address
- * @return Error code
- */
-int ext4_fs_set_inode_data_block_index(struct ext4_inode_ref *inode_ref,
-    uint64_t iblock, uint32_t fblock);
-
-/**@brief Release data block from i-node
- * @param inode_ref I-node to release block from
- * @param iblock    Logical block to be released
+ * @param fblock    Output pointer for return physical block address
  * @return Error code
  */
-int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
-    uint32_t iblock);
+int ext4_fs_init_inode_data_block_index(struct ext4_inode_ref *inode_ref,
+                                      uint64_t iblock, ext4_fsblk_t *fblock);
 
 /**@brief Append following logical block to the i-node.
  * @param inode_ref I-node to append block to
@@ -196,7 +220,21 @@ int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
  * @return Error code
  */
 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
-    uint32_t *fblock, uint32_t *iblock);
+                              ext4_fsblk_t *fblock, uint32_t *iblock);
+
+/**@brief   Increment inode link count.
+ * @param   inode none handle
+ */
+void ext4_fs_inode_links_count_inc(struct ext4_inode_ref *inode_ref);
+
+/**@brief   Decrement inode link count.
+ * @param   inode none handle
+ */
+void ext4_fs_inode_links_count_dec(struct ext4_inode_ref *inode_ref);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* EXT4_FS_H_ */