lwext4/ext4_super.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_super.c
  39  * @brief Superblock operations.
  40  */
  41
  42 #ifndef EXT4_SUPER_H_
  43 #define EXT4_SUPER_H_
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #include "ext4_config.h"
  50 #include "ext4_types.h"
  51
  52 /**@brief   Blocks count get stored in superblock.
  53  * @param   s superblock descriptor
  54  * @return  count of blocks*/
  55 static inline uint64_t ext4_sb_get_blocks_cnt(struct ext4_sblock *s)
  56 {
  57         return ((uint64_t)to_le32(s->blocks_count_hi) << 32) |
  58                to_le32(s->blocks_count_lo);
  59 }
  60
  61 /**@brief   Blocks count set  in superblock.
  62  * @param   s superblock descriptor
  63  * @return  count of blocks*/
  64 static inline void ext4_sb_set_blocks_cnt(struct ext4_sblock *s, uint64_t cnt)
  65 {
  66         s->blocks_count_lo = to_le32((cnt << 32) >> 32);
  67         s->blocks_count_hi = to_le32(cnt >> 32);
  68 }
  69
  70 /**@brief   Free blocks count get stored in superblock.
  71  * @param   s superblock descriptor
  72  * @return  free blocks*/
  73 static inline uint64_t ext4_sb_get_free_blocks_cnt(struct ext4_sblock *s)
  74 {
  75         return ((uint64_t)to_le32(s->free_blocks_count_hi) << 32) |
  76                to_le32(s->free_blocks_count_lo);
  77 }
  78
  79 /**@brief   Free blocks count set.
  80  * @param   s superblock descriptor
  81  * @param   cnt new value of free blocks*/
  82 static inline void ext4_sb_set_free_blocks_cnt(struct ext4_sblock *s,
  83                                                uint64_t cnt)
  84 {
  85         s->free_blocks_count_lo = to_le32((cnt << 32) >> 32);
  86         s->free_blocks_count_hi = to_le32(cnt >> 32);
  87 }
  88
  89 /**@brief   Block size get from superblock.
  90  * @param   s superblock descriptor
  91  * @return  block size in bytes*/
  92 static inline uint32_t ext4_sb_get_block_size(struct ext4_sblock *s)
  93 {
  94         return 1024 << to_le32(s->log_block_size);
  95 }
  96
  97 /**@brief   Block group descriptor size.
  98  * @param   s superblock descriptor
  99  * @return  block group descriptor size in bytes*/
 100 static inline uint16_t ext4_sb_get_desc_size(struct ext4_sblock *s)
 101 {
 102         uint16_t size = to_le16(s->desc_size);
 103
 104         return size < EXT4_MIN_BLOCK_GROUP_DESCRIPTOR_SIZE
 105                    ? EXT4_MIN_BLOCK_GROUP_DESCRIPTOR_SIZE
 106                    : size;
 107 }
 108
 109 /*************************Flags and features*********************************/
 110
 111 /**@brief   Support check of flag.
 112  * @param   s superblock descriptor
 113  * @param   v flag to check
 114  * @return  true if flag is supported*/
 115 static inline bool ext4_sb_check_flag(struct ext4_sblock *s, uint32_t v)
 116 {
 117         return to_le32(s->flags) & v;
 118 }
 119
 120 /**@brief   Support check of feature compatible.
 121  * @param   s superblock descriptor
 122  * @param   v feature to check
 123  * @return  true if feature is supported*/
 124 static inline bool ext4_sb_feature_com(struct ext4_sblock *s, uint32_t v)
 125 {
 126         return to_le32(s->features_compatible) & v;
 127 }
 128
 129 /**@brief   Support check of feature incompatible.
 130  * @param   s superblock descriptor
 131  * @param   v feature to check
 132  * @return  true if feature is supported*/
 133 static inline bool ext4_sb_feature_incom(struct ext4_sblock *s, uint32_t v)
 134 {
 135         return to_le32(s->features_incompatible) & v;
 136 }
 137
 138 /**@brief   Support check of read only flag.
 139  * @param   s superblock descriptor
 140  * @param   v flag to check
 141  * @return  true if flag is supported*/
 142 static inline bool ext4_sb_feature_ro_com(struct ext4_sblock *s, uint32_t v)
 143 {
 144         return to_le32(s->features_read_only) & v;
 145 }
 146
 147 /**@brief   Block group to flex group.
 148  * @param   s superblock descriptor
 149  * @param   block_group block group
 150  * @return  flex group id*/
 151 static inline uint32_t ext4_sb_bg_to_flex(struct ext4_sblock *s,
 152                                           uint32_t block_group)
 153 {
 154         return block_group >> to_le32(s->log_groups_per_flex);
 155 }
 156
 157 /**@brief   Flex block group size.
 158  * @param   s superblock descriptor
 159  * @return  flex bg size*/
 160 static inline uint32_t ext4_sb_flex_bg_size(struct ext4_sblock *s)
 161 {
 162         return 1 << to_le32(s->log_groups_per_flex);
 163 }
 164
 165 /**@brief   Return first meta block group id.
 166  * @param   s superblock descriptor
 167  * @return  first meta_bg id */
 168 static inline uint32_t ext4_sb_first_meta_bg(struct ext4_sblock *s)
 169 {
 170         return to_le32(s->first_meta_bg);
 171 }
 172
 173 /**************************More complex functions****************************/
 174
 175 /**@brief   Returns a block group count.
 176  * @param   s superblock descriptor
 177  * @return  count of block groups*/
 178 uint32_t ext4_block_group_cnt(struct ext4_sblock *s);
 179
 180 /**@brief   Returns block count in block group
 181  *          (last block group may have less blocks)
 182  * @param   s superblock descriptor
 183  * @param   bgid block group id
 184  * @return  blocks count*/
 185 uint32_t ext4_blocks_in_group_cnt(struct ext4_sblock *s, uint32_t bgid);
 186
 187 /**@brief   Returns inodes count in block group
 188  *          (last block group may have less inodes)
 189  * @param   s superblock descriptor
 190  * @param   bgid block group id
 191  * @return  inodes count*/
 192 uint32_t ext4_inodes_in_group_cnt(struct ext4_sblock *s, uint32_t bgid);
 193
 194 /***************************Read/write/check superblock**********************/
 195
 196 /**@brief   Superblock write.
 197  * @param   bdev block device descriptor.
 198  * @param   s superblock descriptor
 199  * @return  Standard error code */
 200 int ext4_sb_write(struct ext4_blockdev *bdev, struct ext4_sblock *s);
 201
 202 /**@brief   Superblock read.
 203  * @param   bdev block device descriptor.
 204  * @param   s superblock descriptor
 205  * @return  Standard error code */
 206 int ext4_sb_read(struct ext4_blockdev *bdev, struct ext4_sblock *s);
 207
 208 /**@brief   Superblock simple validation.
 209  * @param   s superblock descriptor
 210  * @return  true if OK*/
 211 bool ext4_sb_check(struct ext4_sblock *s);
 212
 213 /**@brief   Superblock presence in block group.
 214  * @param   s superblock descriptor
 215  * @param   block_group block group id
 216  * @return  true if block group has superblock*/
 217 bool ext4_sb_is_super_in_bg(struct ext4_sblock *s, uint32_t block_group);
 218
 219 /**@brief   TODO:*/
 220 bool ext4_sb_sparse(uint32_t group);
 221
 222 /**@brief   TODO:*/
 223 uint32_t ext4_bg_num_gdb(struct ext4_sblock *s, uint32_t group);
 224
 225 /**@brief   TODO:*/
 226 uint32_t ext4_num_base_meta_clusters(struct ext4_sblock *s,
 227                                      uint32_t block_group);
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 #endif /* EXT4_SUPER_H_ */
 234
 235 /**
 236  * @}
 237  */