Sblock fill by using to_le32/to_le_16 macros & drop gdt_reserved blocks
[lwext4.git] / lwext4 / ext4_dir_idx.h
index 517d84f2642bbb553b647f3fcc57e9fce91db7b8..5a864cc38b8f116ec1a82d8b2cc5813a0a2c0a98 100644 (file)
-/*\r
- * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)\r
- *\r
- *\r
- * HelenOS:\r
- * Copyright (c) 2012 Martin Sucha\r
- * Copyright (c) 2012 Frantisek Princ\r
- * All rights reserved.\r
- *\r
- * Redistribution and use in source and binary forms, with or without\r
- * modification, are permitted provided that the following conditions\r
- * are met:\r
- *\r
- * - Redistributions of source code must retain the above copyright\r
- *   notice, this list of conditions and the following disclaimer.\r
- * - Redistributions in binary form must reproduce the above copyright\r
- *   notice, this list of conditions and the following disclaimer in the\r
- *   documentation and/or other materials provided with the distribution.\r
- * - The name of the author may not be used to endorse or promote products\r
- *   derived from this software without specific prior written permission.\r
- *\r
- * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
- * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
- * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
- */\r
-\r
-/** @addtogroup lwext4\r
- * @{\r
- */\r
-/**\r
- * @file  ext4_dir_idx.h\r
- * @brief Directory indexing procedures.\r
- */\r
-\r
-#ifndef EXT4_DIR_IDX_H_\r
-#define EXT4_DIR_IDX_H_\r
-\r
-#include <ext4_config.h>\r
-#include <ext4_types.h>\r
-\r
-#include <stdint.h>\r
-#include <stdbool.h>\r
-\r
-\r
-/**@brief Get hash version used in directory index.\r
- * @param root_info Pointer to root info structure of index\r
- * @return Hash algorithm version\r
- */\r
-static inline uint8_t ext4_dir_dx_root_info_get_hash_version(\r
-    struct ext4_directory_dx_root_info *root_info)\r
-{\r
-    return root_info->hash_version;\r
-}\r
-\r
-/**@brief Set hash version, that will be used in directory index.\r
- * @param root_info Pointer to root info structure of index\r
- * @param v Hash algorithm version\r
- */\r
-static inline void ext4_dir_dx_root_info_set_hash_version(\r
-    struct ext4_directory_dx_root_info  *root_info, uint8_t v)\r
-{\r
-    root_info->hash_version = v;\r
-}\r
-\r
-/**@brief Get length of root_info structure in bytes.\r
- * @param root_info Pointer to root info structure of index\r
- * @return Length of the structure\r
- */\r
-static inline uint8_t ext4_dir_dx_root_info_get_info_length(\r
-    struct ext4_directory_dx_root_info *root_info)\r
-{\r
-    return root_info->info_length;\r
-}\r
-\r
-/**@brief Set length of root_info structure in bytes.\r
- * @param root_info   Pointer to root info structure of index\r
- * @param info_length Length of the structure\r
- */\r
-static inline void ext4_dir_dx_root_info_set_info_length(\r
-    struct ext4_directory_dx_root_info  *root_info, uint8_t len)\r
-{\r
-    root_info->info_length = len;\r
-}\r
-\r
-/**@brief Get number of indirect levels of HTree.\r
- * @param root_info Pointer to root info structure of index\r
- * @return Height of HTree (actually only 0 or 1)\r
- */\r
-static inline uint8_t ext4_dir_dx_root_info_get_indirect_levels(\r
-    struct ext4_directory_dx_root_info *root_info)\r
-{\r
-    return root_info->indirect_levels;\r
-}\r
-\r
-/**@brief Set number of indirect levels of HTree.\r
- * @param root_info Pointer to root info structure of index\r
- * @param lvl Height of HTree (actually only 0 or 1)\r
- */\r
-static inline void ext4_dir_dx_root_info_set_indirect_levels(\r
-    struct ext4_directory_dx_root_info *root_info, uint8_t lvl)\r
-{\r
-    root_info->indirect_levels = lvl;\r
-}\r
-\r
-/**@brief Get maximum number of index node entries.\r
- * @param climit Pointer to counlimit structure\r
- * @return Maximum of entries in node\r
- */\r
-static inline uint16_t ext4_dir_dx_countlimit_get_limit(\r
-    struct ext4_directory_dx_countlimit *climit)\r
-{\r
-    return to_le16(climit->limit);\r
-}\r
-\r
-/**@brief Set maximum number of index node entries.\r
- * @param climit Pointer to counlimit structure\r
- * @param limit Maximum of entries in node\r
- */\r
-static inline void ext4_dir_dx_countlimit_set_limit(\r
-    struct ext4_directory_dx_countlimit *climit, uint16_t limit)\r
-{\r
-    climit->limit = to_le16(limit);\r
-}\r
-\r
-\r
-/**@brief Get current number of index node entries.\r
- * @param climit Pointer to counlimit structure\r
- * @return Number of entries in node\r
- */\r
-static inline uint16_t ext4_dir_dx_countlimit_get_count(\r
-    struct ext4_directory_dx_countlimit *climit)\r
-{\r
-    return to_le16(climit->count);\r
-}\r
-\r
-/**@brief Set current number of index node entries.\r
- * @param climit Pointer to counlimit structure\r
- * @param count Number of entries in node\r
- */\r
-static inline void ext4_dir_dx_countlimit_set_count(\r
-    struct ext4_directory_dx_countlimit *climit, uint16_t count)\r
-{\r
-    climit->count = to_le16(count);\r
-}\r
-\r
-/**@brief Get hash value of index entry.\r
- * @param entry Pointer to index entry\r
- * @return Hash value\r
- */\r
-static inline uint32_t ext4_dir_dx_entry_get_hash(\r
-    struct ext4_directory_dx_entry *entry)\r
-{\r
-    return to_le32(entry->hash);\r
-}\r
-\r
-/**@brief Set hash value of index entry.\r
- * @param entry Pointer to index entry\r
- * @param hash  Hash value\r
- */\r
-static inline void ext4_dir_dx_entry_set_hash(\r
-    struct ext4_directory_dx_entry *entry, uint32_t hash)\r
-{\r
-    entry->hash = to_le32(hash);\r
-}\r
-\r
-/**@brief Get block address where child node is located.\r
- * @param entry Pointer to index entry\r
- * @return Block address of child node\r
- */\r
-static inline uint32_t ext4_dir_dx_entry_get_block(\r
-    struct ext4_directory_dx_entry *entry)\r
-{\r
-    return to_le32(entry->block);\r
-}\r
-\r
-/**@brief Set block address where child node is located.\r
- * @param entry Pointer to index entry\r
- * @param block Block address of child node\r
- */\r
-static inline void ext4_dir_dx_entry_set_block(\r
-    struct ext4_directory_dx_entry *entry, uint32_t block)\r
-{\r
-    entry->block = to_le32(block);\r
-}\r
-\r
-/**@brief Initialize index structure of new directory.\r
- * @param dir Pointer to directory i-node\r
- * @return Error code\r
- */\r
-int ext4_dir_dx_init(struct ext4_inode_ref *dir);\r
-\r
-/**@brief Try to find directory entry using directory index.\r
- * @param result    Output value - if entry will be found,\r
- *                  than will be passed through this parameter\r
- * @param inode_ref Directory i-node\r
- * @param name_len  Length of name to be found\r
- * @param name      Name to be found\r
- * @return Error code\r
- */\r
-int ext4_dir_dx_find_entry(struct ext4_directory_search_result * result,\r
-    struct ext4_inode_ref *inode_ref, size_t name_len, const char *name);\r
-\r
-/**@brief Add new entry to indexed directory\r
- * @param parent Directory i-node\r
- * @param child  I-node to be referenced from directory entry\r
- * @param name   Name of new directory entry\r
- * @return Error code\r
- */\r
-int ext4_dir_dx_add_entry(struct ext4_inode_ref *parent,\r
-    struct ext4_inode_ref *child, const char *name);\r
-\r
-#endif /* EXT4_DIR_IDX_H_ */\r
-\r
-/**\r
- * @}\r
- */\r
-\r
+/*
+ * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
+ *
+ *
+ * HelenOS:
+ * Copyright (c) 2012 Martin Sucha
+ * Copyright (c) 2012 Frantisek Princ
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * - The name of the author may not be used to endorse or promote products
+ *   derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/** @addtogroup lwext4
+ * @{
+ */
+/**
+ * @file  ext4_dir_idx.h
+ * @brief Directory indexing procedures.
+ */
+
+#ifndef EXT4_DIR_IDX_H_
+#define EXT4_DIR_IDX_H_
+
+#include "ext4_config.h"
+#include "ext4_types.h"
+
+#include <stdint.h>
+#include <stdbool.h>
+
+/**@brief Initialize index structure of new directory.
+ * @param dir Pointer to directory i-node
+ * @param dir Pointer to parent directory i-node
+ * @return Error code
+ */
+int ext4_dir_dx_init(struct ext4_inode_ref *dir,
+                    struct ext4_inode_ref *parent);
+
+/**@brief Try to find directory entry using directory index.
+ * @param result    Output value - if entry will be found,
+ *                  than will be passed through this parameter
+ * @param inode_ref Directory i-node
+ * @param name_len  Length of name to be found
+ * @param name      Name to be found
+ * @return Error code
+ */
+int ext4_dir_dx_find_entry(struct ext4_dir_search_result *result,
+                          struct ext4_inode_ref *inode_ref, size_t name_len,
+                          const char *name);
+
+/**@brief Add new entry to indexed directory
+ * @param parent Directory i-node
+ * @param child  I-node to be referenced from directory entry
+ * @param name   Name of new directory entry
+ * @return Error code
+ */
+int ext4_dir_dx_add_entry(struct ext4_inode_ref *parent,
+                         struct ext4_inode_ref *child, const char *name);
+
+/**@brief Add new entry to indexed directory
+ * @param dir           Directory i-node
+ * @param parent_inode  parent inode index
+ * @return Error code
+ */
+int ext4_dir_dx_reset_parent_inode(struct ext4_inode_ref *dir,
+                                   uint32_t parent_inode);
+
+#endif /* EXT4_DIR_IDX_H_ */
+
+/**
+ * @}
+ */