2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
29 /** @addtogroup lwext4
34 * @brief Block cache allocator.
37 #ifndef EXT4_BCACHE_H_
38 #define EXT4_BCACHE_H_
44 #include "ext4_config.h"
51 #define EXT4_BLOCK_ZERO() \
52 {.lb_id = 0, .data = 0}
54 /**@brief Single block descriptor*/
56 /**@brief Logical block ID*/
62 /**@brief Data buffer.*/
68 /**@brief Single block descriptor*/
73 /**@brief Logical block address*/
76 /**@brief Data buffer.*/
79 /**@brief LRU priority. (unused) */
85 /**@brief Reference count table*/
88 /**@brief Whether or not buffer is on dirty list.*/
91 /**@brief LBA tree node*/
92 RB_ENTRY(ext4_buf) lba_node;
94 /**@brief LRU tree node*/
95 RB_ENTRY(ext4_buf) lru_node;
97 /**@brief Dirty list node*/
98 SLIST_ENTRY(ext4_buf) dirty_node;
100 /**@brief Callback routine after a disk-write operation.
101 * @param bc block cache descriptor
102 * @param buf buffer descriptor
103 * @param standard error code returned by bdev->bwrite()
104 * @param arg argument passed to this routine*/
105 void (*end_write)(struct ext4_bcache *bc,
106 struct ext4_buf *buf,
110 /**@brief argument passed to end_write() callback.*/
114 /**@brief Block cache descriptor*/
117 /**@brief Item count in block cache*/
120 /**@brief Item size in block cache*/
123 /**@brief Last recently used counter*/
126 /**@brief Currently referenced datablocks*/
129 /**@brief Maximum referenced datablocks*/
130 uint32_t max_ref_blocks;
132 /**@brief The blockdev binded to this block cache*/
133 struct ext4_blockdev *bdev;
135 /**@brief A tree holding all bufs*/
136 RB_HEAD(ext4_buf_lba, ext4_buf) lba_root;
138 /**@brief A tree holding unreferenced bufs*/
139 RB_HEAD(ext4_buf_lru, ext4_buf) lru_root;
141 /**@brief A singly-linked list holding dirty buffers*/
142 SLIST_HEAD(ext4_buf_dirty, ext4_buf) dirty_list;
145 enum bcache_state_bits {
150 #define ext4_bcache_set_flag(buf, b) \
151 (buf)->flags |= 1 << (b)
153 #define ext4_bcache_clear_flag(buf, b) \
154 (buf)->flags &= ~(1 << (b))
156 #define ext4_bcache_test_flag(buf, b) \
157 (((buf)->flags & (1 << (b))) >> (b))
159 static inline void ext4_bcache_set_dirty(struct ext4_buf *buf) {
160 ext4_bcache_set_flag(buf, BC_UPTODATE);
161 ext4_bcache_set_flag(buf, BC_DIRTY);
164 static inline void ext4_bcache_clear_dirty(struct ext4_buf *buf) {
165 ext4_bcache_clear_flag(buf, BC_UPTODATE);
166 ext4_bcache_clear_flag(buf, BC_DIRTY);
169 /**@brief Increment reference counter of buf by 1.*/
170 #define ext4_bcache_inc_ref(buf) ((buf)->refctr++)
172 /**@brief Decrement reference counter of buf by 1.*/
173 #define ext4_bcache_dec_ref(buf) ((buf)->refctr--)
175 /**@brief Static initializer of block cache structure.*/
176 #define EXT4_BCACHE_STATIC_INSTANCE(__name, __cnt, __itemsize) \
177 static struct ext4_bcache __name = { \
179 .itemsize = __itemsize, \
183 /**@brief Insert buffer to dirty cache list
184 * @param bc block cache descriptor
185 * @param buf buffer descriptor */
187 ext4_bcache_insert_dirty_node(struct ext4_bcache *bc, struct ext4_buf *buf) {
188 if (!buf->on_dirty_list) {
189 SLIST_INSERT_HEAD(&bc->dirty_list, buf, dirty_node);
190 buf->on_dirty_list = true;
194 /**@brief Remove buffer to dirty cache list
195 * @param bc block cache descriptor
196 * @param buf buffer descriptor */
198 ext4_bcache_remove_dirty_node(struct ext4_bcache *bc, struct ext4_buf *buf) {
199 if (buf->on_dirty_list) {
200 SLIST_REMOVE(&bc->dirty_list, buf, ext4_buf, dirty_node);
201 buf->on_dirty_list = false;
206 /**@brief Dynamic initialization of block cache.
207 * @param bc block cache descriptor
208 * @param cnt items count in block cache
209 * @param itemsize single item size (in bytes)
210 * @return standard error code*/
211 int ext4_bcache_init_dynamic(struct ext4_bcache *bc, uint32_t cnt,
214 /**@brief Dynamic de-initialization of block cache.
215 * @param bc block cache descriptor
216 * @return standard error code*/
217 int ext4_bcache_fini_dynamic(struct ext4_bcache *bc);
219 /**@brief Get a buffer with the lowest LRU counter in bcache.
220 * @param bc block cache descriptor
221 * @return buffer with the lowest LRU counter*/
222 struct ext4_buf *ext4_buf_lowest_lru(struct ext4_bcache *bc);
224 /**@brief Drop unreferenced buffer from bcache.
225 * @param bc block cache descriptor
226 * @param buf buffer*/
227 void ext4_bcache_drop_buf(struct ext4_bcache *bc, struct ext4_buf *buf);
229 /**@brief Allocate block from block cache memory.
230 * Unreferenced block allocation is based on LRU
231 * (Last Recently Used) algorithm.
232 * @param bc block cache descriptor
233 * @param b block to alloc
234 * @param is_new block is new (needs to be read)
235 * @return standard error code*/
236 int ext4_bcache_alloc(struct ext4_bcache *bc, struct ext4_block *b,
239 /**@brief Free block from cache memory (decrement reference counter).
240 * @param bc block cache descriptor
241 * @param b block to free
242 * @return standard error code*/
243 int ext4_bcache_free(struct ext4_bcache *bc, struct ext4_block *b);
245 /**@brief Return a full status of block cache.
246 * @param bc block cache descriptor
247 * @return full status*/
248 bool ext4_bcache_is_full(struct ext4_bcache *bc);
254 #endif /* EXT4_BCACHE_H_ */