lwext4/ext4_dir_idx.h

   1 /*\r
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)\r
   3  *\r
   4  *\r
   5  * HelenOS:\r
   6  * Copyright (c) 2012 Martin Sucha\r
   7  * Copyright (c) 2012 Frantisek Princ\r
   8  * All rights reserved.\r
   9  *\r
  10  * Redistribution and use in source and binary forms, with or without\r
  11  * modification, are permitted provided that the following conditions\r
  12  * are met:\r
  13  *\r
  14  * - Redistributions of source code must retain the above copyright\r
  15  *   notice, this list of conditions and the following disclaimer.\r
  16  * - Redistributions in binary form must reproduce the above copyright\r
  17  *   notice, this list of conditions and the following disclaimer in the\r
  18  *   documentation and/or other materials provided with the distribution.\r
  19  * - The name of the author may not be used to endorse or promote products\r
  20  *   derived from this software without specific prior written permission.\r
  21  *\r
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
  23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
  24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
  25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  32  */\r
  33 \r
  34 /** @addtogroup lwext4\r
  35  * @{\r
  36  */\r
  37 /**\r
  38  * @file  ext4_dir_idx.h\r
  39  * @brief Directory indexing procedures.\r
  40  */\r
  41 \r
  42 #ifndef EXT4_DIR_IDX_H_\r
  43 #define EXT4_DIR_IDX_H_\r
  44 \r
  45 #include <ext4_config.h>\r
  46 #include <ext4_types.h>\r
  47 \r
  48 #include <stdint.h>\r
  49 #include <stdbool.h>\r
  50 \r
  51 /**@brief   TODO: ...*/\r
  52 uint8_t ext4_dir_dx_root_info_get_hash_version(\r
  53     struct ext4_directory_dx_root_info *root_info);\r
  54 \r
  55 /**@brief   TODO: ...*/\r
  56 void ext4_dir_dx_root_info_set_hash_version(\r
  57     struct ext4_directory_dx_root_info  *root_info, uint8_t v);\r
  58 \r
  59 /**@brief   TODO: ...*/\r
  60 uint8_t ext4_dir_dx_root_info_get_info_length(\r
  61     struct ext4_directory_dx_root_info *root_info);\r
  62 \r
  63 /**@brief   TODO: ...*/\r
  64 void ext4_dir_dx_root_info_set_info_length(\r
  65     struct ext4_directory_dx_root_info  *root_info, uint8_t len);\r
  66 \r
  67 /**@brief   TODO: ...*/\r
  68 uint8_t ext4_dir_dx_root_info_get_indirect_levels(\r
  69     struct ext4_directory_dx_root_info *root_info);\r
  70 \r
  71 /**@brief   TODO: ...*/\r
  72 void ext4_dir_dx_root_info_set_indirect_levels(\r
  73     struct ext4_directory_dx_root_info *root_info, uint8_t lvl);\r
  74 \r
  75 /**@brief   TODO: ...*/\r
  76 uint16_t ext4_dir_dx_countlimit_get_limit(\r
  77     struct ext4_directory_dx_countlimit *climit);\r
  78 \r
  79 /**@brief   TODO: ...*/\r
  80 void ext4_dir_dx_countlimit_set_limit(\r
  81     struct ext4_directory_dx_countlimit *climit, uint16_t limit);\r
  82 \r
  83 /**@brief   TODO: ...*/\r
  84 uint16_t ext4_dir_dx_countlimit_get_count(\r
  85     struct ext4_directory_dx_countlimit *climit);\r
  86 \r
  87 /**@brief   TODO: ...*/\r
  88 void ext4_dir_dx_countlimit_set_count(\r
  89     struct ext4_directory_dx_countlimit *climit, uint16_t count);\r
  90 \r
  91 /**@brief   TODO: ...*/\r
  92 uint32_t ext4_dir_dx_entry_get_hash(\r
  93     struct ext4_directory_dx_entry *entry);\r
  94 \r
  95 /**@brief   TODO: ...*/\r
  96 void ext4_dir_dx_entry_set_hash(\r
  97     struct ext4_directory_dx_entry *entry, uint32_t hash);\r
  98 \r
  99 /**@brief   TODO: ...*/\r
 100 uint32_t ext4_dir_dx_entry_get_block(\r
 101     struct ext4_directory_dx_entry *entry);\r
 102 \r
 103 /**@brief   TODO: ...*/\r
 104 void ext4_dir_dx_entry_set_block(\r
 105     struct ext4_directory_dx_entry *entry, uint32_t block);\r
 106 \r
 107 /**@brief   TODO: ...*/\r
 108 int ext4_dir_dx_init(struct ext4_inode_ref *dir);\r
 109 \r
 110 /**@brief   TODO: ...*/\r
 111 int ext4_dir_dx_find_entry(struct ext4_directory_search_result * result,\r
 112     struct ext4_inode_ref *inode_ref, size_t name_len, const char *name);\r
 113 \r
 114 /**@brief   TODO: ...*/\r
 115 int ext4_dir_dx_add_entry(struct ext4_inode_ref *parent,\r
 116     struct ext4_inode_ref *child, const char *name);\r
 117 \r
 118 #endif /* EXT4_DIR_IDX_H_ */\r
 119 \r
 120 /**\r
 121  * @}\r
 122  */\r
 123 \r