lwext4/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
  38 #ifndef EXT4_BITMAP_H_
  39 #define EXT4_BITMAP_H_
  40
  41 #include <ext4_config.h>
  42 #include <stdint.h>
  43 #include <stdbool.h>
  44
  45 /**@brief   Set bitmap bit.
  46  * @param   bmap bitmap
  47  * @param   bit bit to set*/
  48 static inline void ext4_bmap_bit_set(uint8_t *bmap, uint32_t bit)
  49 {
  50     *(bmap + (bit >> 3)) |= (1 << (bit & 7));
  51 }
  52
  53 /**@brief   Clear bitmap bit.
  54  * @param   bmap bitmap buffer
  55  * @param   bit bit to clear*/
  56 static inline void ext4_bmap_bit_clr(uint8_t *bmap, uint32_t bit)
  57 {
  58     *(bmap + (bit >> 3)) &= ~(1 << (bit & 7));
  59 }
  60
  61
  62 /**@brief   Check if the bitmap bit is set.
  63  * @param   bmap bitmap buffer
  64  * @param   bit bit to check*/
  65 static inline bool ext4_bmap_is_bit_set(uint8_t *bmap, uint32_t bit)
  66 {
  67     return (*(bmap + (bit >> 3)) & (1 << (bit & 7)));
  68 }
  69
  70 /**@brief   Check if the bitmap bit is clear.
  71  * @param   bmap bitmap buffer
  72  * @param   bit bit to check*/
  73 static inline bool ext4_bmap_is_bit_clr(uint8_t *bmap, uint32_t bit)
  74 {
  75     return !ext4_bmap_is_bit_set(bmap, bit);
  76 }
  77
  78 /**@brief   Free range of bits in bitmap.
  79  * @param   bmap bitmap buffer
  80  * @param   sbit start bit
  81  * @param   bcnt bit count*/
  82 void ext4_bmap_bits_free(uint8_t *bmap, uint32_t sbit, uint32_t bcnt);
  83
  84 /**@brief   Find first clear bit in bitmap.
  85  * @param   sbit start bit of search
  86  * @param   ebit end bit of search
  87  * @param   bit_id output parameter (first free bit)
  88  * @return  standard error code*/
  89 int ext4_bmap_bit_find_clr(uint8_t *bmap, uint32_t sbit, uint32_t ebit,
  90     uint32_t *bit_id);
  91
  92
  93 #endif /* EXT4_BITMAP_H_ */
  94
  95 /**
  96  * @}
  97  */
  98