bertos/fs/battfs.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \version $Id$
  34  *
  35  * \author Francesco Sacchi <batt@develer.com>
  36  *
  37  * \brief BattFS: a filesystem for embedded platforms (interface).
  38  * TODO: Add detailed filesystem description.
  39  *
  40  * $WIZAR_MODULE = {
  41  * "name" : "battfs",
  42  * "depends" : ["rotating_hash", "kfile"],
  43  * "configuration" : "bertos/cfg/cfg_battfs.h"
  44  * }
  45  */
  46
  47 #ifndef FS_BATTFS_H
  48 #define FS_BATTFS_H
  49
  50 #include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
  51 #include <cpu/types.h> // CPU_BITS_PER_CHAR
  52 #include <algo/rotating_hash.h>
  53 #include <struct/list.h>
  54 #include <kern/kfile.h>
  55
  56 typedef uint16_t fill_t;    ///< Type for keeping trace of space filled inside a page
  57 typedef fill_t   pgaddr_t;  ///< Type for addressing space inside a page
  58 typedef uint16_t pgcnt_t;   ///< Type for counting pages on disk
  59 typedef pgcnt_t  pgoff_t;   ///< Type for counting pages inside a file
  60 typedef uint8_t  inode_t;   ///< Type for file inodes
  61 typedef uint64_t  seq_t;    ///< Type for page seq number, at least 40bits wide.
  62 typedef rotating_t fcs_t;   ///< Type for header FCS.
  63
  64
  65 /**
  66  * BattFS page header, used to represent a page
  67  * header in memory.
  68  * To see how this is stored on disk:
  69  * \see battfs_to_disk
  70  * \see disk_to_battfs
  71  */
  72 typedef struct BattFsPageHeader
  73 {
  74         inode_t  inode; ///< File inode (file identifier).
  75         fill_t   fill;  ///< Filled bytes in page.
  76         pgoff_t  pgoff; ///< Page offset inside file.
  77
  78         /**
  79          * Page sequence number.
  80          * Every time a page is rewritten the seq number is
  81          * increased by 1. seq_t is wide enough to not to perform
  82          * a wrap around before the memory death.
  83          * So it can be kept as it would be
  84          * monotonically increasing for our needs.
  85          */
  86         seq_t    seq;
  87
  88         /**
  89          * FCS (Frame Check Sequence) of the page header.
  90          */
  91         fcs_t fcs;
  92 } BattFsPageHeader;
  93
  94 /**
  95  * Size of the header once saved on disk.
  96  * \see battfs_to_disk
  97  * \see disk_to_battfs
  98  */
  99 #define BATTFS_HEADER_LEN 12
 100
 101 /**
 102  * Maximum page address.
 103  */
 104 #define MAX_PAGE_ADDR ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1)
 105
 106 /**
 107  * Max number of files.
 108  */
 109 #define BATTFS_MAX_FILES (1 << (CPU_BITS_PER_CHAR * sizeof(inode_t)))
 110
 111 /* Fwd decl */
 112 struct BattFsSuper;
 113
 114 /**
 115  * Sentinel used to keep trace of unset pages in disk->page_array.
 116  */
 117 #define PAGE_UNSET_SENTINEL ((pgcnt_t)((1L << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1))
 118
 119 /**
 120  * Type interface for disk page read function.
 121  * \a page is the page address, \a addr the address inside the page,
 122  * \a size the lenght to be read.
 123  * \return the number of bytes read.
 124  */
 125 typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t);
 126
 127
 128 /**
 129  * Type interface for disk page load function.
 130  * The disk should supply a buffer used for loading/saving pages.
 131  * This has to be done by the disk driver because it knows memory details
 132  * (e.g. some memories can have the buffer inside the memory itself).
 133  * \a page is the page to be loaded from the disk in the buffer.
 134  * \return true if ok, false on errors.
 135  */
 136 typedef bool (*disk_page_load_t) (struct BattFsSuper *d, pgcnt_t page);
 137
 138 /**
 139  * Type interface for disk pagebuffer write function.
 140  * \a addr is the address inside the current loaded page,
 141  * \a size the lenght to be written.
 142  * \return the number of bytes written.
 143  */
 144 typedef size_t  (*disk_buffer_write_t) (struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t);
 145
 146 /**
 147  * Type interface for disk pagebuffer read function.
 148  * \a addr is the address inside the current loaded page,
 149  * \a size the lenght to be read.
 150  * \return the number of bytes read.
 151  */
 152 typedef size_t  (*disk_buffer_read_t) (struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t);
 153
 154 /**
 155  * Type interface for disk page save function.
 156  * The disk should supply a buffer used for loading/saving pages.
 157  * For details \see disk_page_load_t.
 158  * \a page is the page where the buffer will be written.
 159  * \return true if ok, false on errors.
 160  */
 161 typedef bool (*disk_page_save_t) (struct BattFsSuper *d, pgcnt_t page);
 162
 163 /**
 164  * Type interface for disk page erase function.
 165  * \a page is the page address.
 166  * \return true if all is ok, false otherwise.
 167  */
 168 typedef bool (*disk_page_erase_t) (struct BattFsSuper *d, pgcnt_t page);
 169
 170 /**
 171  * Type interface for disk deinit function.
 172  * \return true if all is ok, false otherwise.
 173  */
 174 typedef bool (*disk_close_t) (struct BattFsSuper *d);
 175
 176
 177 typedef uint32_t disk_size_t; ///< Type for disk sizes.
 178
 179 /**
 180  * Context used to describe a disk.
 181  * This context structure will be used to access disk.
 182  * Must be initialized by hw memory driver.
 183  */
 184 typedef struct BattFsSuper
 185 {
 186         void *disk_ctx;          ///< Disk context used by disk access functions.
 187         disk_page_read_t  read;  ///< Page read.
 188         disk_page_load_t  load;  ///< Page load.
 189         disk_buffer_write_t bufferWrite; ///< Buffer write.
 190         disk_buffer_read_t bufferRead; ///< Buffer read.
 191         disk_page_save_t  save;  ///< Page save.
 192         disk_page_erase_t erase; ///< Page erase.
 193         disk_close_t close;      ///< Disk deinit.
 194
 195         pgaddr_t page_size;      ///< Size of a memory page, in bytes. Used by disk low level driver.
 196         pgaddr_t data_size;      ///< Size of space usable for data in a disk page, in bytes. The rest is used by the page header.
 197         pgcnt_t page_count;      ///< Number of pages on disk.
 198
 199         /**
 200          * Page allocation array.
 201          * This array must be allocated somewhere and
 202          * must have enough space for page_count elements.
 203          * Is used by the filesystem to represent
 204          * the entire disk in memory.
 205          */
 206         pgcnt_t *page_array;
 207         pgcnt_t curr_page;  ///< Current page loaded in disk buffer.
 208         bool cache_dirty;   ///< True if current cache is dirty (nneds to be flushed).
 209
 210         /**
 211          * Lowest address, in page array, for free pages.
 212          * Pages above this element are free for use.
 213          */
 214         pgcnt_t free_page_start;
 215
 216         disk_size_t disk_size;   ///< Size of the disk, in bytes (page_count * page_size).
 217         disk_size_t free_bytes;  ///< Free space on the disk.
 218
 219         List file_opened_list;       ///< List used to keep trace of open files.
 220         /* TODO add other fields. */
 221 } BattFsSuper;
 222
 223 /**
 224  * True if space on \a disk is over.
 225  */
 226 #define SPACE_OVER(disk) ((disk)->free_page_start >= (disk)->page_count)
 227
 228 typedef uint8_t filemode_t;  ///< Type for file open modes.
 229 typedef int32_t file_size_t; ///< Type for file sizes.
 230
 231 /**
 232  * Modes for battfs_fileopen.
 233  * \{
 234  */
 235 #define BATTFS_CREATE BV(0)  ///< Create file if does not exist
 236 #define BATTFS_RD     BV(1)  ///< Open file for reading
 237 #define BATTFS_WR     BV(2)  ///< Open file fir writing
 238 /*/}*/
 239
 240
 241 /**
 242  * File errors.
 243  * \{
 244  */
 245 #define BATTFS_NEGATIVE_SEEK_ERR   BV(0) ///< Trying to read/write before file start.
 246 #define BATTFS_DISK_READ_ERR       BV(1) ///< Error reading from disk driver.
 247 #define BATTFS_DISK_LOADPAGE_ERR   BV(2) ///< Error loading a disk page in the buffer.
 248 #define BATTFS_DISK_BUFFERWR_ERR   BV(3) ///< Error writing in the disk page buffer.
 249 #define BATTFS_DISK_GETNEWPAGE_ERR BV(4) ///< Error getting a free page.
 250 #define BATTFS_DISK_BUFFERRD_ERR   BV(6) ///< Error reading from the disk page buffer.
 251 #define BATTFS_DISK_SPACEOVER_ERR  BV(7) ///< No more disk space available.
 252 #define BATTFS_DISK_FLUSHBUF_ERR   BV(8) ///< Error flushing (writing) the current page to disk.
 253 #define BATTFS_FILE_NOT_FOUND_ERR  BV(9) ///< File not found on disk.
 254 /*/}*/
 255
 256 /**
 257  * Describe a BattFs file usign a KFile.
 258  */
 259 typedef struct BattFs
 260 {
 261         KFile fd;           ///< KFile context
 262         Node link;          ///< Link for inserting in opened file list
 263         inode_t inode;      ///< inode of the opened file
 264         BattFsSuper *disk;  ///< Disk context
 265         filemode_t mode;    ///< File open mode
 266         pgcnt_t *start;     ///< Pointer to page_array file start position.
 267         pgcnt_t max_off;    ///< Max page offset allocated for the file.
 268         int errors;         ///< File status/errors
 269 } BattFs;
 270
 271 /**
 272  * Id for battfs file descriptors.
 273  */
 274 #define KFT_BATTFS MAKE_ID('B', 'T', 'F', 'S')
 275
 276 /**
 277  * Macro used to cast a KFile to a BattFS.
 278  * Also perform dynamic type check.
 279  */
 280 INLINE BattFs * BATTFS_CAST(KFile *fd)
 281 {
 282         ASSERT(fd->_type == KFT_BATTFS);
 283         return (BattFs *)fd;
 284 }
 285
 286 bool battfs_mount(struct BattFsSuper *d);
 287 bool battfs_fsck(struct BattFsSuper *disk);
 288 bool battfs_umount(struct BattFsSuper *disk);
 289
 290 bool battfs_fileExists(BattFsSuper *disk, inode_t inode);
 291 bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode);
 292 bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff);
 293 #endif /* FS_BATTFS_H */