lwext4/ext4_bcache.h

   1 /*\r
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)\r
   3  * All rights reserved.\r
   4  *\r
   5  * Redistribution and use in source and binary forms, with or without\r
   6  * modification, are permitted provided that the following conditions\r
   7  * are met:\r
   8  *\r
   9  * - Redistributions of source code must retain the above copyright\r
  10  *   notice, this list of conditions and the following disclaimer.\r
  11  * - Redistributions in binary form must reproduce the above copyright\r
  12  *   notice, this list of conditions and the following disclaimer in the\r
  13  *   documentation and/or other materials provided with the distribution.\r
  14  * - The name of the author may not be used to endorse or promote products\r
  15  *   derived from this software without specific prior written permission.\r
  16  *\r
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES\r
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\r
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\r
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\r
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF\r
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  */\r
  28 \r
  29 /** @addtogroup lwext4\r
  30  * @{\r
  31  */\r
  32 /**\r
  33  * @file  ext4_bcache.h\r
  34  * @brief Block cache allocator.\r
  35  */\r
  36 \r
  37 #ifndef EXT4_BCACHE_H_\r
  38 #define EXT4_BCACHE_H_\r
  39 \r
  40 #include <ext4_config.h>\r
  41 \r
  42 #include <stdint.h>\r
  43 #include <stdbool.h>\r
  44 \r
  45 /**@brief       Single block descriptor.*/\r
  46 struct  ext4_block {\r
  47     /**@brief   Dirty flag.*/\r
  48     bool                dirty;\r
  49 \r
  50     /**@brief   Logical block ID*/\r
  51     uint64_t    lb_id;\r
  52 \r
  53     /**@brief   Cache id*/\r
  54     uint32_t    cache_id;\r
  55 \r
  56     /**@brief   Data buffer.*/\r
  57     uint8_t             *data;\r
  58 };\r
  59 \r
  60 \r
  61 /**@brief       Block cache descriptor.*/\r
  62 struct  ext4_bcache {\r
  63 \r
  64     /**@brief   Item count in block cache*/\r
  65     uint32_t    cnt;\r
  66 \r
  67     /**@brief   Item size in block cache*/\r
  68     uint32_t    itemsize;\r
  69 \r
  70     /**@brief   Last recently used counter.*/\r
  71     uint32_t    lru_ctr;\r
  72 \r
  73     /**@brief   Reference count table (cnt).*/\r
  74     uint32_t    *refctr;\r
  75 \r
  76     /**@brief   Last recently used ID table (cnt)*/\r
  77     uint32_t    *lru_id;\r
  78 \r
  79     /**@brief   Free delay mode table (cnt)*/\r
  80     uint8_t     *free_delay;\r
  81 \r
  82     /**@brief   Logical block table (cnt).*/\r
  83     uint64_t    *lba;\r
  84 \r
  85     /**@brief   Cache data buffers (cnt * itemsize)*/\r
  86     uint8_t             *data;\r
  87 \r
  88     /**@brief   Currently referenced datablocks*/\r
  89     uint32_t    ref_blocks;\r
  90 \r
  91     /**@brief   Maximum referenced datablocks*/\r
  92     uint32_t    max_ref_blocks;\r
  93 \r
  94 };\r
  95 \r
  96 /**@brief       Static initializer of block cache structure.*/\r
  97 #define EXT4_BCACHE_STATIC_INSTANCE(__name, __cnt, __itemsize)      \\r
  98         static uint32_t __name##_refctr[(__cnt)];                   \\r
  99         static uint32_t __name##_lru_id[(__cnt)];                   \\r
 100         static uint8_t          __name##_free_delay[(__cnt)];           \\r
 101         static uint64_t __name##_lba[(__cnt)];                      \\r
 102         static uint8_t  __name##_data[(__cnt) * (__itemsize)];      \\r
 103         static struct ext4_bcache       __name = {                      \\r
 104                 .cnt       = __cnt,                                 \\r
 105                 .itemsize  = __itemsize,                            \\r
 106                 .lru_ctr   = 0,                                     \\r
 107                 .refctr    = __name##_refctr,                       \\r
 108                 .lru_id    = __name##_lru_id,                       \\r
 109                 .lba       = __name##_lba,                          \\r
 110                 .free_delay= __name##_free_delay,                   \\r
 111                 .data      = __name##_data,                         \\r
 112         }\r
 113 \r
 114 \r
 115 /**@brief       Dynamic initialization of block cache.\r
 116  * @param       bc block cache descriptor\r
 117  * @param       cnt items count in block cache\r
 118  * @param       itemsize single item size (in bytes)\r
 119  * @return      standard error code*/\r
 120 int     ext4_bcache_init_dynamic(struct ext4_bcache *bc, uint32_t cnt,\r
 121     uint32_t itemsize);\r
 122 \r
 123 /**@brief       Dynamic de-initialization of block cache.\r
 124  * @param       bc block cache descriptor\r
 125  * @return      standard error code*/\r
 126 int ext4_bcache_fini_dynamic(struct     ext4_bcache *bc);\r
 127 \r
 128 /**@brief       Allocate block from block cache memory.\r
 129  *          Unreferenced block allocation is based on LRU\r
 130  *          (Last Recently Used) algorithm.\r
 131  * @param       bc      block cache descriptor\r
 132  * @param       b block to alloc\r
 133  * @param       is_new block is new (needs to be read)\r
 134  * @return  standard error code*/\r
 135 int ext4_bcache_alloc(struct ext4_bcache *bc, struct ext4_block *b,\r
 136     bool *is_new);\r
 137 \r
 138 /**@brief       Free block from cache memory (decrement reference counter).\r
 139  * @param       bc      block cache descriptor\r
 140  * @param       b block to free\r
 141  * @return  standard error code*/\r
 142 int ext4_bcache_free (struct ext4_bcache *bc, struct ext4_block *b,\r
 143     uint8_t free_delay);\r
 144 \r
 145 \r
 146 /**@brief       Return a full status of block cache.\r
 147  * @param       bc      block cache descriptor\r
 148  * @return      full status*/\r
 149 bool ext4_bcache_is_full(struct ext4_bcache *bc);\r
 150 \r
 151 #endif /* EXT4_BCACHE_H_ */\r
 152 \r
 153 /**\r
 154  * @}\r
 155  */\r