2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
6 * Copyright (c) 2012 Martin Sucha
7 * Copyright (c) 2012 Frantisek Princ
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
34 /** @addtogroup lwext4
39 * @brief Superblock operations.
45 #include "ext4_config.h"
46 #include "ext4_types.h"
48 /**@brief Blocks count get stored in superblock.
49 * @param s superblock descriptor
50 * @return count of blocks*/
51 static inline uint64_t ext4_sb_get_blocks_cnt(struct ext4_sblock *s)
53 return ((uint64_t)to_le32(s->blocks_count_hi) << 32) |
54 to_le32(s->blocks_count_lo);
57 /**@brief Blocks count set in superblock.
58 * @param s superblock descriptor
59 * @return count of blocks*/
60 static inline void ext4_sb_set_blocks_cnt(struct ext4_sblock *s, uint64_t cnt)
62 s->blocks_count_lo = to_le32((cnt << 32) >> 32);
63 s->blocks_count_hi = to_le32(cnt >> 32);
66 /**@brief Free blocks count get stored in superblock.
67 * @param s superblock descriptor
68 * @return free blocks*/
69 static inline uint64_t ext4_sb_get_free_blocks_cnt(struct ext4_sblock *s)
71 return ((uint64_t)to_le32(s->free_blocks_count_hi) << 32) |
72 to_le32(s->free_blocks_count_lo);
75 /**@brief Free blocks count set.
76 * @param s superblock descriptor
77 * @param cnt new value of free blocks*/
78 static inline void ext4_sb_set_free_blocks_cnt(struct ext4_sblock *s,
81 s->free_blocks_count_lo = to_le32((cnt << 32) >> 32);
82 s->free_blocks_count_hi = to_le32(cnt >> 32);
85 /**@brief Block size get from superblock.
86 * @param s superblock descriptor
87 * @return block size in bytes*/
88 static inline uint32_t ext4_sb_get_block_size(struct ext4_sblock *s)
90 return 1024 << to_le32(s->log_block_size);
93 /**@brief Block group descriptor size.
94 * @param s superblock descriptor
95 * @return block group descriptor size in bytes*/
96 static inline uint16_t ext4_sb_get_desc_size(struct ext4_sblock *s)
98 uint16_t size = to_le16(s->desc_size);
100 return size < EXT4_MIN_BLOCK_GROUP_DESCRIPTOR_SIZE
101 ? EXT4_MIN_BLOCK_GROUP_DESCRIPTOR_SIZE
105 /*************************Flags and features*********************************/
107 /**@brief Support check of flag.
108 * @param s superblock descriptor
109 * @param v flag to check
110 * @return true if flag is supported*/
111 static inline bool ext4_sb_check_flag(struct ext4_sblock *s, uint32_t v)
113 return to_le32(s->flags) & v;
116 /**@brief Support check of feature compatible.
117 * @param s superblock descriptor
118 * @param v feature to check
119 * @return true if feature is supported*/
120 static inline bool ext4_sb_feature_com(struct ext4_sblock *s, uint32_t v)
122 return to_le32(s->features_compatible) & v;
125 /**@brief Support check of feature incompatible.
126 * @param s superblock descriptor
127 * @param v feature to check
128 * @return true if feature is supported*/
129 static inline bool ext4_sb_feature_incom(struct ext4_sblock *s, uint32_t v)
131 return to_le32(s->features_incompatible) & v;
134 /**@brief Support check of read only flag.
135 * @param s superblock descriptor
136 * @param v flag to check
137 * @return true if flag is supported*/
138 static inline bool ext4_sb_feature_ro_com(struct ext4_sblock *s, uint32_t v)
140 return to_le32(s->features_read_only) & v;
143 /**@brief Block group to flex group.
144 * @param s superblock descriptor
145 * @param block_group block group
146 * @return flex group id*/
147 static inline uint32_t ext4_sb_bg_to_flex(struct ext4_sblock *s,
148 uint32_t block_group)
150 return block_group >> to_le32(s->log_groups_per_flex);
153 /**@brief Flex block group size.
154 * @param s superblock descriptor
155 * @return flex bg size*/
156 static inline uint32_t ext4_sb_flex_bg_size(struct ext4_sblock *s)
158 return 1 << to_le32(s->log_groups_per_flex);
161 /**@brief Return first meta block group id.
162 * @param s superblock descriptor
163 * @return first meta_bg id */
164 static inline uint32_t ext4_sb_first_meta_bg(struct ext4_sblock *s)
166 return to_le32(s->first_meta_bg);
169 /**************************More complex functions****************************/
171 /**@brief Returns a block group count.
172 * @param s superblock descriptor
173 * @return count of block groups*/
174 uint32_t ext4_block_group_cnt(struct ext4_sblock *s);
176 /**@brief Returns block count in block group
177 * (last block group may have less blocks)
178 * @param s superblock descriptor
179 * @param bgid block group id
180 * @return blocks count*/
181 uint32_t ext4_blocks_in_group_cnt(struct ext4_sblock *s, uint32_t bgid);
183 /**@brief Returns inodes count in block group
184 * (last block group may have less inodes)
185 * @param s superblock descriptor
186 * @param bgid block group id
187 * @return inodes count*/
188 uint32_t ext4_inodes_in_group_cnt(struct ext4_sblock *s, uint32_t bgid);
190 /***************************Read/write/check superblock**********************/
192 /**@brief Superblock write.
193 * @param bdev block device descriptor.
194 * @param s superblock descriptor
195 * @return Standard error code */
196 int ext4_sb_write(struct ext4_blockdev *bdev, struct ext4_sblock *s);
198 /**@brief Superblock read.
199 * @param bdev block device descriptor.
200 * @param s superblock descriptor
201 * @return Standard error code */
202 int ext4_sb_read(struct ext4_blockdev *bdev, struct ext4_sblock *s);
204 /**@brief Superblock simple validation.
205 * @param s superblock descriptor
206 * @return true if OK*/
207 bool ext4_sb_check(struct ext4_sblock *s);
209 /**@brief Superblock presence in block group.
210 * @param s superblock descriptor
211 * @param block_group block group id
212 * @return true if block group has superblock*/
213 bool ext4_sb_is_super_in_bg(struct ext4_sblock *s, uint32_t block_group);
216 bool ext4_sb_sparse(uint32_t group);
219 uint32_t ext4_bg_num_gdb(struct ext4_sblock *s, uint32_t group);
222 uint32_t ext4_num_base_meta_clusters(struct ext4_sblock *s,
223 uint32_t block_group);
225 #endif /* EXT4_SUPER_H_ */