include/ext4_bitmap.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup lwext4
  30  * @{
  31  */
  32 /**
  33  * @file  ext4_bitmap.h
  34  * @brief Block/inode bitmap allocator.
  35  */
  36
  37 #ifndef EXT4_BITMAP_H_
  38 #define EXT4_BITMAP_H_
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #include "ext4_config.h"
  45
  46 #include <stdint.h>
  47 #include <stdbool.h>
  48
  49 /**@brief   Set bitmap bit.
  50  * @param   bmap bitmap
  51  * @param   bit bit to set*/
  52 static inline void ext4_bmap_bit_set(uint8_t *bmap, uint32_t bit)
  53 {
  54         *(bmap + (bit >> 3)) |= (1 << (bit & 7));
  55 }
  56
  57 /**@brief   Clear bitmap bit.
  58  * @param   bmap bitmap buffer
  59  * @param   bit bit to clear*/
  60 static inline void ext4_bmap_bit_clr(uint8_t *bmap, uint32_t bit)
  61 {
  62         *(bmap + (bit >> 3)) &= ~(1 << (bit & 7));
  63 }
  64
  65 /**@brief   Check if the bitmap bit is set.
  66  * @param   bmap bitmap buffer
  67  * @param   bit bit to check*/
  68 static inline bool ext4_bmap_is_bit_set(uint8_t *bmap, uint32_t bit)
  69 {
  70         return (*(bmap + (bit >> 3)) & (1 << (bit & 7)));
  71 }
  72
  73 /**@brief   Check if the bitmap bit is clear.
  74  * @param   bmap bitmap buffer
  75  * @param   bit bit to check*/
  76 static inline bool ext4_bmap_is_bit_clr(uint8_t *bmap, uint32_t bit)
  77 {
  78         return !ext4_bmap_is_bit_set(bmap, bit);
  79 }
  80
  81 /**@brief   Free range of bits in bitmap.
  82  * @param   bmap bitmap buffer
  83  * @param   sbit start bit
  84  * @param   bcnt bit count*/
  85 void ext4_bmap_bits_free(uint8_t *bmap, uint32_t sbit, uint32_t bcnt);
  86
  87 /**@brief   Find first clear bit in bitmap.
  88  * @param   sbit start bit of search
  89  * @param   ebit end bit of search
  90  * @param   bit_id output parameter (first free bit)
  91  * @return  standard error code*/
  92 int ext4_bmap_bit_find_clr(uint8_t *bmap, uint32_t sbit, uint32_t ebit,
  93                            uint32_t *bit_id);
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif /* EXT4_BITMAP_H_ */
 100
 101 /**
 102  * @}
 103  */