lwext4/ext4_bcache.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_bcache.h
  34  * @brief Block cache allocator.
  35  */
  36
  37 #ifndef EXT4_BCACHE_H_
  38 #define EXT4_BCACHE_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 #include "tree.h"
  49 #include "queue.h"
  50
  51 #define EXT4_BLOCK_ZERO()       \
  52         {.lb_id = 0, .data = 0}
  53
  54 /**@brief   Single block descriptor*/
  55 struct ext4_block {
  56         /**@brief   Logical block ID*/
  57         uint64_t lb_id;
  58
  59         /**@brief   Buffer */
  60         struct ext4_buf *buf;
  61
  62         /**@brief   Data buffer.*/
  63         uint8_t *data;
  64 };
  65
  66 struct ext4_bcache;
  67
  68 /**@brief   Single block descriptor*/
  69 struct ext4_buf {
  70         /**@brief   Flags*/
  71         int flags;
  72
  73         /**@brief   Logical block address*/
  74         uint64_t lba;
  75
  76         /**@brief   Data buffer.*/
  77         uint8_t *data;
  78
  79         /**@brief   LRU priority. (unused) */
  80         uint32_t lru_prio;
  81
  82         /**@brief   LRU id.*/
  83         uint32_t lru_id;
  84
  85         /**@brief   Reference count table*/
  86         uint32_t refctr;
  87
  88         /**@brief   Whether or not buffer is on dirty list.*/
  89         bool on_dirty_list;
  90
  91         /**@brief   LBA tree node*/
  92         RB_ENTRY(ext4_buf) lba_node;
  93
  94         /**@brief   LRU tree node*/
  95         RB_ENTRY(ext4_buf) lru_node;
  96
  97         /**@brief   Dirty list node*/
  98         SLIST_ENTRY(ext4_buf) dirty_node;
  99
 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,
 107                           int res,
 108                           void *arg);
 109
 110         /**@brief   argument passed to end_write() callback.*/
 111         void *end_write_arg;
 112 };
 113
 114 /**@brief   Block cache descriptor*/
 115 struct ext4_bcache {
 116
 117         /**@brief   Item count in block cache*/
 118         uint32_t cnt;
 119
 120         /**@brief   Item size in block cache*/
 121         uint32_t itemsize;
 122
 123         /**@brief   Last recently used counter*/
 124         uint32_t lru_ctr;
 125
 126         /**@brief   Currently referenced datablocks*/
 127         uint32_t ref_blocks;
 128
 129         /**@brief   Maximum referenced datablocks*/
 130         uint32_t max_ref_blocks;
 131
 132         /**@brief   The blockdev binded to this block cache*/
 133         struct ext4_blockdev *bdev;
 134
 135         /**@brief   A tree holding all bufs*/
 136         RB_HEAD(ext4_buf_lba, ext4_buf) lba_root;
 137
 138         /**@brief   A tree holding unreferenced bufs*/
 139         RB_HEAD(ext4_buf_lru, ext4_buf) lru_root;
 140
 141         /**@brief   A singly-linked list holding dirty buffers*/
 142         SLIST_HEAD(ext4_buf_dirty, ext4_buf) dirty_list;
 143 };
 144
 145 /**@brief buffer state bits
 146  *
 147  *  - BC♡UPTODATE: Buffer contains valid data.
 148  *  - BC_DIRTY: Buffer is dirty.
 149  *  - BC_FLUSH: Buffer will be immediately flushed,
 150  *              when no one references it.
 151  */
 152 enum bcache_state_bits {
 153         BC_UPTODATE,
 154         BC_DIRTY,
 155         BC_FLUSH
 156 };
 157
 158 #define ext4_bcache_set_flag(buf, b)    \
 159         (buf)->flags |= 1 << (b)
 160
 161 #define ext4_bcache_clear_flag(buf, b)    \
 162         (buf)->flags &= ~(1 << (b))
 163
 164 #define ext4_bcache_test_flag(buf, b)    \
 165         (((buf)->flags & (1 << (b))) >> (b))
 166
 167 static inline void ext4_bcache_set_dirty(struct ext4_buf *buf) {
 168         ext4_bcache_set_flag(buf, BC_UPTODATE);
 169         ext4_bcache_set_flag(buf, BC_DIRTY);
 170 }
 171
 172 static inline void ext4_bcache_clear_dirty(struct ext4_buf *buf) {
 173         ext4_bcache_clear_flag(buf, BC_UPTODATE);
 174         ext4_bcache_clear_flag(buf, BC_DIRTY);
 175 }
 176
 177 /**@brief   Increment reference counter of buf by 1.*/
 178 #define ext4_bcache_inc_ref(buf) ((buf)->refctr++)
 179
 180 /**@brief   Decrement reference counter of buf by 1.*/
 181 #define ext4_bcache_dec_ref(buf) ((buf)->refctr--)
 182
 183 /**@brief   Static initializer of block cache structure.*/
 184 #define EXT4_BCACHE_STATIC_INSTANCE(__name, __cnt, __itemsize)                 \
 185         static struct ext4_bcache __name = {                                   \
 186             .cnt = __cnt,                                                      \
 187             .itemsize = __itemsize,                                            \
 188             .lru_ctr = 0,                                                      \
 189         }
 190
 191 /**@brief   Insert buffer to dirty cache list
 192  * @param   bc block cache descriptor
 193  * @param   buf buffer descriptor */
 194 static inline void
 195 ext4_bcache_insert_dirty_node(struct ext4_bcache *bc, struct ext4_buf *buf) {
 196         if (!buf->on_dirty_list) {
 197                 SLIST_INSERT_HEAD(&bc->dirty_list, buf, dirty_node);
 198                 buf->on_dirty_list = true;
 199         }
 200 }
 201
 202 /**@brief   Remove buffer to dirty cache list
 203  * @param   bc block cache descriptor
 204  * @param   buf buffer descriptor */
 205 static inline void
 206 ext4_bcache_remove_dirty_node(struct ext4_bcache *bc, struct ext4_buf *buf) {
 207         if (buf->on_dirty_list) {
 208                 SLIST_REMOVE(&bc->dirty_list, buf, ext4_buf, dirty_node);
 209                 buf->on_dirty_list = false;
 210         }
 211 }
 212
 213
 214 /**@brief   Dynamic initialization of block cache.
 215  * @param   bc block cache descriptor
 216  * @param   cnt items count in block cache
 217  * @param   itemsize single item size (in bytes)
 218  * @return  standard error code*/
 219 int ext4_bcache_init_dynamic(struct ext4_bcache *bc, uint32_t cnt,
 220                              uint32_t itemsize);
 221
 222 /**@brief   Do cleanup works on block cache.
 223  * @param   bc block cache descriptor.*/
 224 void ext4_bcache_cleanup(struct ext4_bcache *bc);
 225
 226 /**@brief   Dynamic de-initialization of block cache.
 227  * @param   bc block cache descriptor
 228  * @return  standard error code*/
 229 int ext4_bcache_fini_dynamic(struct ext4_bcache *bc);
 230
 231 /**@brief   Get a buffer with the lowest LRU counter in bcache.
 232  * @param   bc block cache descriptor
 233  * @return  buffer with the lowest LRU counter*/
 234 struct ext4_buf *ext4_buf_lowest_lru(struct ext4_bcache *bc);
 235
 236 /**@brief   Drop unreferenced buffer from bcache.
 237  * @param   bc block cache descriptor
 238  * @param   buf buffer*/
 239 void ext4_bcache_drop_buf(struct ext4_bcache *bc, struct ext4_buf *buf);
 240
 241 /**@brief   Allocate block from block cache memory.
 242  *          Unreferenced block allocation is based on LRU
 243  *          (Last Recently Used) algorithm.
 244  * @param   bc block cache descriptor
 245  * @param   b block to alloc
 246  * @param   is_new block is new (needs to be read)
 247  * @return  standard error code*/
 248 int ext4_bcache_alloc(struct ext4_bcache *bc, struct ext4_block *b,
 249                       bool *is_new);
 250
 251 /**@brief   Free block from cache memory (decrement reference counter).
 252  * @param   bc block cache descriptor
 253  * @param   b block to free
 254  * @return  standard error code*/
 255 int ext4_bcache_free(struct ext4_bcache *bc, struct ext4_block *b);
 256
 257 /**@brief   Return a full status of block cache.
 258  * @param   bc block cache descriptor
 259  * @return  full status*/
 260 bool ext4_bcache_is_full(struct ext4_bcache *bc);
 261
 262 #ifdef __cplusplus
 263 }
 264 #endif
 265
 266 #endif /* EXT4_BCACHE_H_ */
 267
 268 /**
 269  * @}
 270  */