lwext4/ext4_balloc.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  *
   4  * HelenOS:
   5  * Copyright (c) 2012 Martin Sucha
   6  * Copyright (c) 2012 Frantisek Princ
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * - Redistributions of source code must retain the above copyright
  14  *   notice, this list of conditions and the following disclaimer.
  15  * - Redistributions in binary form must reproduce the above copyright
  16  *   notice, this list of conditions and the following disclaimer in the
  17  *   documentation and/or other materials provided with the distribution.
  18  * - The name of the author may not be used to endorse or promote products
  19  *   derived from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /** @addtogroup lwext4
  34  * @{
  35  */
  36 /**
  37  * @file  ext4_balloc.h
  38  * @brief Physical block allocator.
  39  */
  40
  41 #ifndef EXT4_BALLOC_H_
  42 #define EXT4_BALLOC_H_
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include "ext4_config.h"
  49 #include "ext4_types.h"
  50
  51 #include <stdint.h>
  52 #include <stdbool.h>
  53
  54 /**@brief Compute number of block group from block address.
  55  * @param sb superblock pointer.
  56  * @param baddr Absolute address of block.
  57  * @return Block group index
  58  */
  59 uint32_t ext4_balloc_get_bgid_of_block(struct ext4_sblock *s,
  60                                        ext4_fsblk_t baddr);
  61
  62 /**@brief Compute the starting block address of a block group
  63  * @param sb   superblock pointer.
  64  * @param bgid block group index
  65  * @return Block address
  66  */
  67 ext4_fsblk_t ext4_balloc_get_block_of_bgid(struct ext4_sblock *s,
  68                                            uint32_t bgid);
  69
  70 /**@brief Calculate and set checksum of block bitmap.
  71  * @param sb superblock pointer.
  72  * @param bg block group
  73  * @param bitmap bitmap buffer
  74  */
  75 void ext4_balloc_set_bitmap_csum(struct ext4_sblock *sb,
  76                                  struct ext4_bgroup *bg,
  77                                  void *bitmap);
  78
  79 /**@brief   Free block from inode.
  80  * @param   inode_ref inode reference
  81  * @param   baddr block address
  82  * @return  standard error code*/
  83 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref,
  84                            ext4_fsblk_t baddr);
  85
  86 /**@brief   Free blocks from inode.
  87  * @param   inode_ref inode reference
  88  * @param   first block address
  89  * @param   count block count
  90  * @return  standard error code*/
  91 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref,
  92                             ext4_fsblk_t first, uint32_t count);
  93
  94 /**@brief   Allocate block procedure.
  95  * @param   inode_ref inode reference
  96  * @param   goal
  97  * @param   baddr allocated block address
  98  * @return  standard error code*/
  99 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref,
 100                             ext4_fsblk_t goal,
 101                             ext4_fsblk_t *baddr);
 102
 103 /**@brief   Try allocate selected block.
 104  * @param   inode_ref inode reference
 105  * @param   baddr block address to allocate
 106  * @param   free if baddr is not allocated
 107  * @return  standard error code*/
 108 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
 109                                 ext4_fsblk_t baddr, bool *free);
 110
 111 #ifdef __cplusplus
 112 }
 113 #endif
 114
 115 #endif /* EXT4_BALLOC_H_ */
 116
 117 /**
 118  * @}
 119  */