lwext4/ext4_extent.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_extent.h\r
  39  * @brief More complex filesystem functions.\r
  40  */\r
  41 #ifndef EXT4_EXTENT_H_\r
  42 #define EXT4_EXTENT_H_\r
  43 \r
  44 #include <ext4_config.h>\r
  45 #include <ext4_types.h>\r
  46 \r
  47 /**@brief Get logical number of the block covered by extent.\r
  48  * @param extent Extent to load number from\r
  49  * @return Logical number of the first block covered by extent */\r
  50 uint32_t ext4_extent_get_first_block(struct ext4_extent *extent);\r
  51 \r
  52 /**@brief Set logical number of the first block covered by extent.\r
  53  * @param extent Extent to set number to\r
  54  * @param iblock Logical number of the first block covered by extent */\r
  55 void ext4_extent_set_first_block(struct ext4_extent *extent, uint32_t iblock);\r
  56 \r
  57 /**@brief Get number of blocks covered by extent.\r
  58  * @param extent Extent to load count from\r
  59  * @return Number of blocks covered by extent */\r
  60 uint16_t ext4_extent_get_block_count(struct ext4_extent *extent);\r
  61 \r
  62 /**@brief Set number of blocks covered by extent.\r
  63  * @param extent Extent to load count from\r
  64  * @param count  Number of blocks covered by extent */\r
  65 void ext4_extent_set_block_count(struct ext4_extent *extent, uint16_t count);\r
  66 \r
  67 /**@brief Get physical number of the first block covered by extent.\r
  68  * @param extent Extent to load number\r
  69  * @return Physical number of the first block covered by extent */\r
  70 uint64_t ext4_extent_get_start(struct ext4_extent *extent);\r
  71 \r
  72 /**@brief Set physical number of the first block covered by extent.\r
  73  * @param extent Extent to load number\r
  74  * @param fblock Physical number of the first block covered by extent */\r
  75 void ext4_extent_set_start(struct ext4_extent *extent, uint64_t fblock);\r
  76 \r
  77 \r
  78 /**@brief Get logical number of the block covered by extent index.\r
  79  * @param index Extent index to load number from\r
  80  * @return Logical number of the first block covered by extent index */\r
  81 uint32_t ext4_extent_index_get_first_block(struct ext4_extent_index *index);\r
  82 \r
  83 /**@brief Set logical number of the block covered by extent index.\r
  84  * @param index  Extent index to set number to\r
  85  * @param iblock Logical number of the first block covered by extent index */\r
  86 void ext4_extent_index_set_first_block(struct ext4_extent_index *index,\r
  87     uint32_t iblock);\r
  88 \r
  89 /**@brief Get physical number of block where the child node is located.\r
  90  * @param index Extent index to load number from\r
  91  * @return Physical number of the block with child node */\r
  92 uint64_t ext4_extent_index_get_leaf(struct ext4_extent_index *index);\r
  93 \r
  94 \r
  95 /**@brief Set physical number of block where the child node is located.\r
  96  * @param index  Extent index to set number to\r
  97  * @param fblock Ohysical number of the block with child node */\r
  98 void ext4_extent_index_set_leaf(struct ext4_extent_index *index,\r
  99     uint64_t fblock);\r
 100 \r
 101 \r
 102 /**@brief Get magic value from extent header.\r
 103  * @param header Extent header to load value from\r
 104  * @return Magic value of extent header */\r
 105 uint16_t ext4_extent_header_get_magic(struct ext4_extent_header *header);\r
 106 \r
 107 /**@brief Set magic value to extent header.\r
 108  * @param header Extent header to set value to\r
 109  * @param magic  Magic value of extent header */\r
 110 void ext4_extent_header_set_magic(struct ext4_extent_header *header,\r
 111     uint16_t magic);\r
 112 \r
 113 /**@brief Get number of entries from extent header\r
 114  * @param header Extent header to get value from\r
 115  * @return Number of entries covered by extent header */\r
 116 uint16_t ext4_extent_header_get_entries_count(struct ext4_extent_header *header);\r
 117 \r
 118 /**@brief Set number of entries to extent header\r
 119  * @param header Extent header to set value to\r
 120  * @param count  Number of entries covered by extent header */\r
 121 void ext4_extent_header_set_entries_count(struct ext4_extent_header *header,\r
 122     uint16_t count);\r
 123 \r
 124 /**@brief Get maximum number of entries from extent header\r
 125  * @param header Extent header to get value from\r
 126  * @return Maximum number of entries covered by extent header */\r
 127 uint16_t ext4_extent_header_get_max_entries_count(struct ext4_extent_header *header);\r
 128 \r
 129 /**@brief Set maximum number of entries to extent header\r
 130  * @param header    Extent header to set value to\r
 131  * @param max_count Maximum number of entries covered by extent header */\r
 132 void ext4_extent_header_set_max_entries_count(struct ext4_extent_header *header,\r
 133     uint16_t max_count);\r
 134 \r
 135 /**@brief Get depth of extent subtree.\r
 136  * @param header Extent header to get value from\r
 137  * @return Depth of extent subtree */\r
 138 uint16_t ext4_extent_header_get_depth(struct ext4_extent_header *header);\r
 139 \r
 140 /**@brief Set depth of extent subtree.\r
 141  * @param header Extent header to set value to\r
 142  * @param depth  Depth of extent subtree */\r
 143 void ext4_extent_header_set_depth(struct ext4_extent_header *header,\r
 144     uint16_t depth);\r
 145 \r
 146 /**@brief Get generation from extent header\r
 147  * @param header Extent header to get value from\r
 148  * @return Generation */\r
 149 uint32_t ext4_extent_header_get_generation(struct ext4_extent_header *header);\r
 150 \r
 151 /**@brief Set generation to extent header\r
 152  * @param header     Extent header to set value to\r
 153  * @param generation Generation */\r
 154 void ext4_extent_header_set_generation(struct ext4_extent_header *header,\r
 155     uint32_t generation);\r
 156 \r
 157 /**@brief Find physical block in the extent tree by logical block number.\r
 158  * There is no need to save path in the tree during this algorithm.\r
 159  * @param inode_ref I-node to load block from\r
 160  * @param iblock    Logical block number to find\r
 161  * @param fblock    Output value for physical block number\r
 162  * @return Error code*/\r
 163 int ext4_extent_find_block(struct ext4_inode_ref *inode_ref, uint32_t iblock,\r
 164     uint32_t *fblock);\r
 165 \r
 166 /**@brief Release all data blocks starting from specified logical block.\r
 167  * @param inode_ref   I-node to release blocks from\r
 168  * @param iblock_from First logical block to release\r
 169  * @return Error code */\r
 170 int ext4_extent_release_blocks_from(struct ext4_inode_ref *inode_ref,\r
 171     uint32_t iblock_from);\r
 172 \r
 173 /**@brief Append data block to the i-node.\r
 174  * This function allocates data block, tries to append it\r
 175  * to some existing extent or creates new extents.\r
 176  * It includes possible extent tree modifications (splitting).\r
 177  * @param inode_ref I-node to append block to\r
 178  * @param iblock    Output logical number of newly allocated block\r
 179  * @param fblock    Output physical block address of newly allocated block\r
 180  *\r
 181  * @return Error code*/\r
 182 int ext4_extent_append_block(struct ext4_inode_ref *inode_ref,\r
 183         uint32_t *iblock, uint32_t *fblock, bool update_size);\r
 184 \r
 185 \r
 186 #endif /* EXT4_EXTENT_H_ */\r
 187 /**\r
 188  * @}\r
 189  */\r