lwext4/ext4_balloc.h

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