X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Ffs%2Fbattfs.h;h=adb5607cd07a3bd03dd5703fc3532fa9f6d23381;hb=500fbef0b281c79719c73ba1a818db54057f74b7;hp=d75bd6452fc941c26e74c1f2aa6d4a248d4e56bf;hpb=6eb6ebb5ae5953a27977f0ef66a36344462b949a;p=bertos.git diff --git a/bertos/fs/battfs.h b/bertos/fs/battfs.h index d75bd645..adb5607c 100644 --- a/bertos/fs/battfs.h +++ b/bertos/fs/battfs.h @@ -51,16 +51,10 @@ typedef uint16_t fill_t; ///< Type for keeping trace of space filled inside a typedef fill_t pgaddr_t; ///< Type for addressing space inside a page typedef uint16_t pgcnt_t; ///< Type for counting pages on disk typedef pgcnt_t pgoff_t; ///< Type for counting pages inside a file -typedef uint32_t mark_t; ///< Type for marking pages as free typedef uint8_t inode_t; ///< Type for file inodes -typedef uint8_t seq_t; ///< Type for page seq number +typedef uint64_t seq_t; ///< Type for page seq number, at least 40bits wide. typedef rotating_t fcs_t; ///< Type for header FCS. -/** - * Size required for free block allocation is at least 1 bit more - * than page addressing. - */ -STATIC_ASSERT(sizeof(mark_t) > sizeof(pgcnt_t)); /** * BattFS page header, used to represent a page @@ -72,16 +66,18 @@ STATIC_ASSERT(sizeof(mark_t) > sizeof(pgcnt_t)); typedef struct BattFsPageHeader { inode_t inode; ///< File inode (file identifier). - seq_t seq; ///< Page sequence number. fill_t fill; ///< Filled bytes in page. pgoff_t pgoff; ///< Page offset inside file. - mark_t mark; ///< Marker used to keep trace of free/used pages. /** - * FCS (Frame Check Sequence) of the page header once the page - * as been marked as free. + * Page sequence number. + * Every time a page is rewritten the seq number is + * increased by 1. seq_t is wide enough to not to perform + * a wrap around before the memory death. + * So it can be kept as it would be + * monotonically increasing for our needs. */ - fcs_t fcs_free; + seq_t seq; /** * FCS (Frame Check Sequence) of the page header. @@ -96,22 +92,6 @@ typedef struct BattFsPageHeader */ #define BATTFS_HEADER_LEN 12 -/** - * Marks for valid pages. - * Simply set to 1 all field bits. - * \{ - */ -#define MARK_PAGE_VALID ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t) + 1)) - 1) -#define FCS_FREE_VALID ((1 << (CPU_BITS_PER_CHAR * sizeof(fcs_t))) - 1) -/* \} */ - - -/** - * Half-size of free page marker. - * Used to keep trace of free marker wrap-arounds. - */ -#define MARK_HALF_SIZE (1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t) + 1)) - /** * Maximum page address. */ @@ -144,13 +124,41 @@ typedef bool (*disk_open_t) (struct BattFsSuper *d); */ typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t); + /** - * Type interface for disk page write function. - * \a page is the page address, \a addr the address inside the page, + * Type interface for disk page load function. + * The disk should supply a buffer used for loading/saving pages. + * This has to be done by the disk driver because it knows memory details + * (e.g. some memories can have the buffer inside the memory itself). + * \a page is the page to be loaded from the disk in the buffer. + * \return true if ok, false on errors. + */ +typedef bool (*disk_page_load_t) (struct BattFsSuper *d, pgcnt_t page); + +/** + * Type interface for disk pagebuffer write function. + * \a addr is the address inside the current loaded page, * \a size the lenght to be written. * \return the number of bytes written. */ -typedef size_t (*disk_page_write_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, const void *buf, size_t); +typedef size_t (*disk_buffer_write_t) (struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t); + +/** + * Type interface for disk pagebuffer read function. + * \a addr is the address inside the current loaded page, + * \a size the lenght to be read. + * \return the number of bytes read. + */ +typedef size_t (*disk_buffer_read_t) (struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t); + +/** + * Type interface for disk page save function. + * The disk should supply a buffer used for loading/saving pages. + * For details \see disk_page_load_t. + * \a page is the page where the buffer will be written. + * \return true if ok, false on errors. + */ +typedef bool (*disk_page_save_t) (struct BattFsSuper *d, pgcnt_t page); /** * Type interface for disk page erase function. @@ -177,11 +185,15 @@ typedef struct BattFsSuper { disk_open_t open; ///< Disk init. disk_page_read_t read; ///< Page read. - disk_page_write_t write; ///< Page write. + disk_page_load_t load; ///< Page load. + disk_buffer_write_t bufferWrite; ///< Buffer write. + disk_buffer_read_t bufferRead; ///< Buffer read. + disk_page_save_t save; ///< Page save. disk_page_erase_t erase; ///< Page erase. disk_close_t close; ///< Disk deinit. - pgaddr_t page_size; ///< Size of a disk page, in bytes. + pgaddr_t page_size; ///< Size of a memory page, in bytes. Used by disk low level driver. + pgaddr_t data_size; ///< Size of space usable for data in a disk page, in bytes. The rest is used by the page header. pgcnt_t page_count; ///< Number of pages on disk. /** @@ -192,18 +204,14 @@ typedef struct BattFsSuper * the entire disk in memory. */ pgcnt_t *page_array; + pgcnt_t curr_page; ///< Current page loaded in disk buffer. + bool cache_dirty; ///< True if current cache is dirty (nneds to be flushed). - /** - * Lowest free page counter. - * This is the counter of the first availble free page. - */ - mark_t free_start; - - /** - * Highest free page counter. - * This value is the next to be used to mark a block as free. + /** + * Lowest address, in page array, for free pages. + * Pages above this element are free for use. */ - mark_t free_next; + pgcnt_t free_page_start; disk_size_t disk_size; ///< Size of the disk, in bytes (page_count * page_size). disk_size_t free_bytes; ///< Free space on the disk. @@ -212,8 +220,13 @@ typedef struct BattFsSuper /* TODO add other fields. */ } BattFsSuper; -typedef uint8_t filemode_t; ///< Type for file open modes. -typedef uint32_t file_size_t; ///< Type for file sizes. +/** + * True if space on \a disk is over. + */ +#define SPACE_OVER(disk) ((disk)->free_page_start >= (disk)->page_count) + +typedef uint8_t filemode_t; ///< Type for file open modes. +typedef int32_t file_size_t; ///< Type for file sizes. /** * Modes for battfs_fileopen. @@ -228,7 +241,7 @@ typedef uint32_t file_size_t; ///< Type for file sizes. /** * Describe a BattFs file usign a KFile. */ -typedef struct BattFS +typedef struct BattFs { KFile fd; ///< KFile context Node link; ///< Link for inserting in opened file list @@ -236,7 +249,8 @@ typedef struct BattFS BattFsSuper *disk; ///< Disk context filemode_t mode; ///< File open mode pgcnt_t *start; ///< Pointer to page_array file start position. -} BattFS; + pgcnt_t max_off; ///< Max page offset allocated for the file. +} BattFs; /** * Id for battfs file descriptors. @@ -247,18 +261,17 @@ typedef struct BattFS * Macro used to cast a KFile to a BattFS. * Also perform dynamic type check. */ -INLINE BattFS * BATTFSKFILE(KFile *fd) +INLINE BattFs * BATTFS_CAST(KFile *fd) { ASSERT(fd->_type == KFT_BATTFS); - return (BattFS *)fd; + return (BattFs *)fd; } -bool battfs_init(struct BattFsSuper *d); -bool battfs_close(struct BattFsSuper *disk); +bool battfs_mount(struct BattFsSuper *d); +bool battfs_fsck(struct BattFsSuper *disk); +bool battfs_umount(struct BattFsSuper *disk); bool battfs_fileExists(BattFsSuper *disk, inode_t inode); -bool battfs_fileopen(BattFsSuper *disk, BattFS *fd, inode_t inode, filemode_t mode); - -bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff, mark_t mark); - +bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode); +bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff); #endif /* FS_BATTFS_H */