battfs.h

Go to the documentation of this file.

#ifndef FS_BATTFS_H
#define FS_BATTFS_H

#include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
#include <cpu/types.h> // CPU_BITS_PER_CHAR
#include <algo/rotating_hash.h>
#include <struct/list.h>
#include <kern/kfile.h>

typedef uint16_t fill_t;    
typedef fill_t   pgaddr_t;  
typedef uint16_t pgcnt_t;   
typedef pgcnt_t  pgoff_t;   
typedef uint8_t  inode_t;   
typedef uint64_t  seq_t;    
typedef rotating_t fcs_t;   


typedef struct BattFsPageHeader
{
    inode_t  inode; 
    fill_t   fill;  
    pgoff_t  pgoff; 

    seq_t    seq;

    fcs_t fcs;
} BattFsPageHeader;

#define BATTFS_HEADER_LEN 12

#define MAX_PAGE_ADDR ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1)

#define BATTFS_MAX_FILES (1 << (CPU_BITS_PER_CHAR * sizeof(inode_t)))

/* Fwd decl */
struct BattFsSuper;

#define PAGE_UNSET_SENTINEL ((pgcnt_t)((1L << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1))

typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t);


typedef bool (*disk_page_load_t) (struct BattFsSuper *d, pgcnt_t page);

typedef size_t  (*disk_buffer_write_t) (struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t);

typedef size_t  (*disk_buffer_read_t) (struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t);

typedef bool (*disk_page_save_t) (struct BattFsSuper *d, pgcnt_t page);

typedef bool (*disk_page_erase_t) (struct BattFsSuper *d, pgcnt_t page);

typedef bool (*disk_close_t) (struct BattFsSuper *d);


typedef uint32_t disk_size_t; 

typedef struct BattFsSuper
{
    void *disk_ctx;          
    disk_page_read_t  read;  
    disk_page_load_t  load;  
    disk_buffer_write_t bufferWrite; 
    disk_buffer_read_t bufferRead; 
    disk_page_save_t  save;  
    disk_page_erase_t erase; 
    disk_close_t close;      

    pgaddr_t page_size;      
    pgaddr_t data_size;      
    pgcnt_t page_count;      

    pgcnt_t *page_array;
    pgcnt_t curr_page;  
    bool cache_dirty;   

    pgcnt_t free_page_start;

    disk_size_t disk_size;   
    disk_size_t free_bytes;  

    List file_opened_list;       
    /* TODO add other fields. */
} BattFsSuper;

#define SPACE_OVER(disk) ((disk)->free_page_start >= (disk)->page_count)

typedef uint8_t filemode_t;  
typedef int32_t file_size_t; 

#define BATTFS_CREATE BV(0)  ///< Create file if does not exist
#define BATTFS_RD     BV(1)  ///< Open file for reading
#define BATTFS_WR     BV(2)  ///< Open file fir writing
/*/}*/


#define BATTFS_NEGATIVE_SEEK_ERR   BV(0) ///< Trying to read/write before file start.
#define BATTFS_DISK_READ_ERR       BV(1) ///< Error reading from disk driver.
#define BATTFS_DISK_LOADPAGE_ERR   BV(2) ///< Error loading a disk page in the buffer.
#define BATTFS_DISK_BUFFERWR_ERR   BV(3) ///< Error writing in the disk page buffer.
#define BATTFS_DISK_GETNEWPAGE_ERR BV(4) ///< Error getting a free page.
#define BATTFS_DISK_BUFFERRD_ERR   BV(6) ///< Error reading from the disk page buffer.
#define BATTFS_DISK_SPACEOVER_ERR  BV(7) ///< No more disk space available.
#define BATTFS_DISK_FLUSHBUF_ERR   BV(8) ///< Error flushing (writing) the current page to disk.
#define BATTFS_FILE_NOT_FOUND_ERR  BV(9) ///< File not found on disk.
/*/}*/

typedef struct BattFs
{
    KFile fd;           
    Node link;          
    inode_t inode;      
    BattFsSuper *disk;  
    filemode_t mode;    
    pgcnt_t *start;     
    pgcnt_t max_off;    
    int errors;         
} BattFs;

#define KFT_BATTFS MAKE_ID('B', 'T', 'F', 'S')

INLINE BattFs * BATTFS_CAST(KFile *fd)
{
    ASSERT(fd->_type == KFT_BATTFS);
    return (BattFs *)fd;
}

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);
#endif /* FS_BATTFS_H */