Add battfs config file; add shuffle for free blocks.
[bertos.git] / bertos / fs / battfs.c
index 7d30231f68726c0f4f03299780a27ba038f785e5..1ea39c5072e14c45f167cca124308441f2c46812 100644 (file)
  */
 
 #include "battfs.h"
-
+#include "cfg/cfg_battfs.h"
 #include <cfg/debug.h>
 #include <cfg/macros.h> /* MIN, MAX */
+#include <cfg/test.h>
 #include <cpu/byteorder.h> /* cpu_to_xx */
 
-#define LOG_LEVEL       LOG_LVL_INFO
-#define LOG_FORMAT      LOG_FMT_VERBOSE
+#define LOG_LEVEL       BATTFS_LOG_LEVEL
+#define LOG_FORMAT      BATTFS_LOG_FORMAT
 #include <cfg/log.h>
 
 #include <string.h> /* memset, memmove */
@@ -232,7 +233,7 @@ static pgcnt_t countPages(pgoff_t *filelen_table, inode_t inode)
 static void movePages(struct BattFsSuper *disk, pgcnt_t src, int offset)
 {
        pgcnt_t dst = src + offset;
-       LOG_INFO("src %d, offset %d, size %ld\n", src, offset, (disk->page_count - MAX(dst, src)) * sizeof(pgcnt_t));
+       LOG_INFO("src %d, offset %d, size %d\n", src, offset, (unsigned int)((disk->page_count - MAX(dst, src)) * sizeof(pgcnt_t)));
        memmove(&disk->page_array[dst], &disk->page_array[src], (disk->page_count - MAX(dst, src)) * sizeof(pgcnt_t));
 
        if (offset < 0)
@@ -279,7 +280,7 @@ static bool countDiskFilePages(struct BattFsSuper *disk, pgoff_t *filelen_table)
                        disk->free_page_start++;
                }
        }
-       LOG_INFO("free_bytes:%d, free_page_start:%d\n", disk->free_bytes, disk->free_page_start);
+       LOG_INFO("free_bytes:%ld, free_page_start:%d\n", (long)disk->free_bytes, disk->free_page_start);
 
        return true;
 }
@@ -382,7 +383,7 @@ static bool fillPageArray(struct BattFsSuper *disk, pgoff_t *filelen_table)
                {
                        /* Invalid page, keep as free */
                        ASSERT(disk->page_array[curr_free_page] == PAGE_UNSET_SENTINEL);
-                       LOG_INFO("Page %d invalid, keeping as free\n", page);
+                       //LOG_INFO("Page %d invalid, keeping as free\n", page);
                        disk->page_array[curr_free_page++] = page;
                }
        }
@@ -438,20 +439,10 @@ static bool loadPage(struct BattFsSuper *disk, pgcnt_t new_page, BattFsPageHeade
  * \a disk.
  * \return false on errors, true otherwise.
  */
-bool battfs_init(struct BattFsSuper *disk)
+bool battfs_mount(struct BattFsSuper *disk)
 {
        pgoff_t filelen_table[BATTFS_MAX_FILES];
 
-       /* Sanity check */
-       ASSERT(disk->open);
-
-       /* Init disk device */
-       if (!disk->open(disk))
-       {
-               LOG_ERR("open error\n");
-               return false;
-       }
-
        /* Disk open must set all of these */
        ASSERT(disk->read);
        ASSERT(disk->load);
@@ -499,10 +490,14 @@ bool battfs_init(struct BattFsSuper *disk)
        #if LOG_LEVEL >= LOG_LVL_INFO
                dumpPageArray(disk);
        #endif
-       #warning TODO: shuffle free blocks
-       //#if LOG_LEVEL > LOG_LVL_INFO
-       //      dumpPageArray(disk);
-       //#endif
+       #if CONFIG_BATTFS_SHUFFLE_FREE_PAGES
+               SHUFFLE(&disk->page_array[disk->free_page_start], disk->page_count - disk->free_page_start);
+
+               LOG_INFO("Page array after shuffle:\n");
+               #if LOG_LEVEL >= LOG_LVL_INFO
+                       dumpPageArray(disk);
+               #endif
+       #endif
        /* Init list for opened files. */
        LIST_INIT(&disk->file_opened_list);
        return true;
@@ -574,7 +569,10 @@ static int battfs_flush(struct KFile *fd)
        if (flushBuffer(fdb->disk))
                return 0;
        else
+       {
+               fdb->errors |= BATTFS_DISK_FLUSHBUF_ERR;
                return EOF;
+       }
 }
 
 /**
@@ -585,9 +583,13 @@ static int battfs_fileclose(struct KFile *fd)
 {
        BattFs *fdb = BATTFS_CAST(fd);
 
-       battfs_flush(fd);
-       REMOVE(&fdb->link);
-       return 0;
+       if (battfs_flush(fd) == 0)
+       {
+               REMOVE(&fdb->link);
+               return 0;
+       }
+       else
+               return EOF;
 }
 
 
@@ -595,7 +597,6 @@ static bool getNewPage(struct BattFsSuper *disk, pgcnt_t new_pos, inode_t inode,
 {
        if (SPACE_OVER(disk))
        {
-               #warning TODO space over!
                LOG_ERR("No disk space available!\n");
                return false;
        }
@@ -620,7 +621,7 @@ static bool getNewPage(struct BattFsSuper *disk, pgcnt_t new_pos, inode_t inode,
        disk->cache_dirty = true;
 
        new_hdr->inode = inode;
-       new_hdr->pgoff =  pgoff;
+       new_hdr->pgoff = pgoff;
        new_hdr->fill = 0;
        new_hdr->seq = 0;
        return setBufferHdr(disk, new_hdr);
@@ -633,6 +634,7 @@ static bool getNewPage(struct BattFsSuper *disk, pgcnt_t new_pos, inode_t inode,
 static size_t battfs_write(struct KFile *fd, const void *_buf, size_t size)
 {
        BattFs *fdb = BATTFS_CAST(fd);
+       BattFsSuper *disk = fdb->disk;
        const uint8_t *buf = (const uint8_t *)_buf;
 
        size_t total_write = 0;
@@ -642,132 +644,152 @@ static size_t battfs_write(struct KFile *fd, const void *_buf, size_t size)
        BattFsPageHeader curr_hdr;
 
        if (fd->seek_pos < 0)
+       {
+               fdb->errors |= BATTFS_NEGATIVE_SEEK_ERR;
                return total_write;
+       }
 
        if (fd->seek_pos > fd->size)
        {
                /* Handle writing when seek pos if far over EOF */
-               if (!loadPage(fdb->disk, fdb->start[fdb->max_off], &curr_hdr))
+               if (!loadPage(disk, fdb->start[fdb->max_off], &curr_hdr))
                {
-                               #warning TODO set error?
-                               return total_write;
+                       fdb->errors |= BATTFS_DISK_LOADPAGE_ERR;
+                       return total_write;
                }
 
                /* Fill unused space of first page with 0s */
                uint8_t dummy = 0;
-               pgaddr_t zero_bytes = MIN(fd->seek_pos - fd->size, fdb->disk->data_size - curr_hdr.fill);
+               pgaddr_t zero_bytes = MIN(fd->seek_pos - fd->size, (kfile_off_t)(disk->data_size - curr_hdr.fill));
                while (zero_bytes--)
                {
-                       if (fdb->disk->bufferWrite(fdb->disk, curr_hdr.fill, &dummy, 1) != 1)
+                       if (disk->bufferWrite(disk, curr_hdr.fill, &dummy, 1) != 1)
                        {
-                               #warning TODO set error?
+                               fdb->errors |= BATTFS_DISK_BUFFERWR_ERR;
+                               return total_write;
                        }
                        curr_hdr.fill++;
                        fd->size++;
-                       fdb->disk->free_bytes--;
-                       fdb->disk->cache_dirty = true;
+                       disk->free_bytes--;
+                       disk->cache_dirty = true;
                }
-               setBufferHdr(fdb->disk, &curr_hdr);
+               setBufferHdr(disk, &curr_hdr);
 
                /* Allocate the missing pages first. */
-               pgoff_t missing_pages = fd->seek_pos / fdb->disk->data_size - fdb->max_off;
+               pgoff_t missing_pages = fd->seek_pos / disk->data_size - fdb->max_off;
 
                if (missing_pages)
                {
                        LOG_INFO("missing pages: %d\n", missing_pages);
-                       flushBuffer(fdb->disk);
+                       flushBuffer(disk);
 
                        /* Fill page buffer with 0 to avoid filling unused pages with garbage */
-                       for (pgaddr_t off = 0; off < fdb->disk->data_size; off++)
+                       for (pgaddr_t off = 0; off < disk->data_size; off++)
                        {
-                               if (fdb->disk->bufferWrite(fdb->disk, off, &dummy, 1) != 1)
+                               if (disk->bufferWrite(disk, off, &dummy, 1) != 1)
                                {
-                                       #warning TODO set error?
+                                       fdb->errors |= BATTFS_DISK_BUFFERWR_ERR;
+                                       return total_write;
                                }
                        }
 
                        while (missing_pages--)
                        {
-                               zero_bytes = MIN((kfile_off_t)fdb->disk->data_size, fd->seek_pos - fd->size);
+                               zero_bytes = MIN((kfile_off_t)disk->data_size, fd->seek_pos - fd->size);
                                /* Get the new page needed */
-                               if (!getNewPage(fdb->disk, (fdb->start - fdb->disk->page_array) + fdb->max_off + 1, fdb->inode, fdb->max_off + 1, &curr_hdr))
+                               if (!getNewPage(disk, (fdb->start - disk->page_array) + fdb->max_off + 1, fdb->inode, fdb->max_off + 1, &curr_hdr))
+                               {
+                                       fdb->errors |= BATTFS_DISK_GETNEWPAGE_ERR;
                                        return total_write;
+                               }
 
                                /* Update size and free space left */
                                fd->size += zero_bytes;
-                               fdb->disk->free_bytes -= zero_bytes;
+                               disk->free_bytes -= zero_bytes;
 
                                curr_hdr.fill = zero_bytes;
-                               setBufferHdr(fdb->disk, &curr_hdr);
+                               setBufferHdr(disk, &curr_hdr);
 
                                fdb->max_off++;
                        }
                }
        }
-       else if (!getBufferHdr(fdb->disk, &curr_hdr))
+       else if (!getBufferHdr(disk, &curr_hdr))
+       {
+               fdb->errors |=  BATTFS_DISK_BUFFERRD_ERR;
                return total_write;
+       }
 
        while (size)
        {
-               pg_offset = fd->seek_pos / fdb->disk->data_size;
-               addr_offset = fd->seek_pos % fdb->disk->data_size;
-               wr_len = MIN(size, (size_t)(fdb->disk->data_size - addr_offset));
+               pg_offset = fd->seek_pos / disk->data_size;
+               addr_offset = fd->seek_pos % disk->data_size;
+               wr_len = MIN(size, (size_t)(disk->data_size - addr_offset));
 
                /* Handle write outside EOF */
                if (pg_offset > fdb->max_off)
                {
-                       LOG_INFO("New page needed, pg_offset %d, pos %d\n", pg_offset, (fdb->start - fdb->disk->page_array) + pg_offset);
-                       if (!getNewPage(fdb->disk, (fdb->start - fdb->disk->page_array) + pg_offset, fdb->inode, pg_offset, &curr_hdr))
+                       LOG_INFO("New page needed, pg_offset %d, pos %d\n", pg_offset, (int)((fdb->start - disk->page_array) + pg_offset));
+                       if (!getNewPage(disk, (fdb->start - disk->page_array) + pg_offset, fdb->inode, pg_offset, &curr_hdr))
+                       {
+                               fdb->errors |= BATTFS_DISK_GETNEWPAGE_ERR;
                                return total_write;
+                       }
+
                        fdb->max_off = pg_offset;
                }
                /* Handle cache load of a new page*/
-               else if (fdb->start[pg_offset] != fdb->disk->curr_page)
+               else if (fdb->start[pg_offset] != disk->curr_page)
                {
-                       if (SPACE_OVER(fdb->disk))
+                       if (SPACE_OVER(disk))
                        {
                                LOG_ERR("No disk space available!\n");
+                               fdb->errors |= BATTFS_DISK_SPACEOVER_ERR;
                                return total_write;
                        }
-                       LOG_INFO("Re-writing page %d to %d\n", fdb->start[pg_offset], fdb->disk->page_array[fdb->disk->free_page_start]);
-                       if (!loadPage(fdb->disk, fdb->start[pg_offset], &curr_hdr))
+                       LOG_INFO("Re-writing page %d to %d\n", fdb->start[pg_offset], disk->page_array[disk->free_page_start]);
+                       if (!loadPage(disk, fdb->start[pg_offset], &curr_hdr))
                        {
-                               #warning TODO set error?
+                               fdb->errors |= BATTFS_DISK_LOADPAGE_ERR;
                                return total_write;
                        }
 
                        /* Get a free page */
-                       fdb->disk->curr_page = fdb->disk->page_array[fdb->disk->free_page_start];
-                       movePages(fdb->disk, fdb->disk->free_page_start + 1, -1);
+                       disk->curr_page = disk->page_array[disk->free_page_start];
+                       movePages(disk, disk->free_page_start + 1, -1);
 
                        /* Insert previous page in free blocks list */
                        LOG_INFO("Setting page %d as free\n", fdb->start[pg_offset]);
-                       fdb->disk->page_array[fdb->disk->page_count - 1] = fdb->start[pg_offset];
+                       disk->page_array[disk->page_count - 1] = fdb->start[pg_offset];
                        /* Assign new page */
-                       fdb->start[pg_offset] = fdb->disk->curr_page;
+                       fdb->start[pg_offset] = disk->curr_page;
                        curr_hdr.seq++;
                }
 
-               //LOG_INFO("writing to buffer for page %d, offset %d, size %d\n", fdb->disk->curr_page, addr_offset, wr_len);
-               if (fdb->disk->bufferWrite(fdb->disk, addr_offset, buf, wr_len) != wr_len)
+               //LOG_INFO("writing to buffer for page %d, offset %d, size %d\n", disk->curr_page, addr_offset, wr_len);
+               if (disk->bufferWrite(disk, addr_offset, buf, wr_len) != wr_len)
                {
-                       #warning TODO set error?
+                       fdb->errors |= BATTFS_DISK_BUFFERWR_ERR;
+                       return total_write;
                }
-               fdb->disk->cache_dirty = true;
+               disk->cache_dirty = true;
 
                size -= wr_len;
                fd->seek_pos += wr_len;
                total_write += wr_len;
                buf += wr_len;
                fill_t fill_delta = MAX((int32_t)(addr_offset + wr_len) - curr_hdr.fill, (int32_t)0);
-               fdb->disk->free_bytes -= fill_delta;
+               disk->free_bytes -= fill_delta;
                fd->size += fill_delta;
                curr_hdr.fill += fill_delta;
 
-               if (!setBufferHdr(fdb->disk, &curr_hdr))
+               if (!setBufferHdr(disk, &curr_hdr))
+               {
+                       fdb->errors |= BATTFS_DISK_BUFFERWR_ERR;
                        return total_write;
+               }
 
-               //LOG_INFO("free_bytes %d, seek_pos %d, size %d, curr_hdr.fill %d\n", fdb->disk->free_bytes, fd->seek_pos, fd->size, curr_hdr.fill);
+               //LOG_INFO("free_bytes %d, seek_pos %d, size %d, curr_hdr.fill %d\n", disk->free_bytes, fd->seek_pos, fd->size, curr_hdr.fill);
        }
        return total_write;
 }
@@ -780,6 +802,7 @@ static size_t battfs_write(struct KFile *fd, const void *_buf, size_t size)
 static size_t battfs_read(struct KFile *fd, void *_buf, size_t size)
 {
        BattFs *fdb = BATTFS_CAST(fd);
+       BattFsSuper *disk = fdb->disk;
        uint8_t *buf = (uint8_t *)_buf;
 
        size_t total_read = 0;
@@ -788,26 +811,30 @@ static size_t battfs_read(struct KFile *fd, void *_buf, size_t size)
        pgaddr_t read_len;
 
        if (fd->seek_pos < 0)
+       {
+               fdb->errors |= BATTFS_NEGATIVE_SEEK_ERR;
                return total_read;
+       }
 
-       size = MIN((kfile_off_t)size, MAX(fd->size - fd->seek_pos, 0));
+       size = MIN((kfile_off_t)size, MAX(fd->size - fd->seek_pos, (kfile_off_t)0));
 
        while (size)
        {
-               pg_offset = fd->seek_pos / fdb->disk->data_size;
-               addr_offset = fd->seek_pos % fdb->disk->data_size;
-               read_len = MIN(size, (size_t)(fdb->disk->data_size - addr_offset));
+               pg_offset = fd->seek_pos / disk->data_size;
+               addr_offset = fd->seek_pos % disk->data_size;
+               read_len = MIN(size, (size_t)(disk->data_size - addr_offset));
 
                //LOG_INFO("reading from page %d, offset %d, size %d\n", fdb->start[pg_offset], addr_offset, read_len);
                /* Read from disk */
-               if (diskRead(fdb->disk, fdb->start[pg_offset], addr_offset, buf, read_len) != read_len)
+               if (diskRead(disk, fdb->start[pg_offset], addr_offset, buf, read_len) != read_len)
                {
-                       #warning TODO set error?
+                       fdb->errors |= BATTFS_DISK_READ_ERR;
+                       return total_read;
                }
 
                #if _DEBUG
                        BattFsPageHeader hdr;
-                       readHdr(fdb->disk, fdb->start[pg_offset], &hdr);
+                       readHdr(disk, fdb->start[pg_offset], &hdr);
                        ASSERT(hdr.inode == fdb->inode);
                #endif
 
@@ -852,7 +879,7 @@ static bool findFile(BattFsSuper *disk, inode_t inode, pgcnt_t *last)
                else if (hdr.fcs == fcs && hdr.inode < inode)
                        first = page + 1;
                else
-                       *last = page - 1;
+                       *last = page;
        }
        LOG_INFO("Not found: last %d\n", *last);
        return false;
@@ -889,6 +916,19 @@ static file_size_t countFileSize(BattFsSuper *disk, pgcnt_t *start, inode_t inod
        return size;
 }
 
+static int battfs_error(struct KFile *fd)
+{
+       BattFs *fdb = BATTFS_CAST(fd);
+       return fdb->errors;
+}
+
+
+static void battfs_clearerr(struct KFile *fd)
+{
+       BattFs *fdb = BATTFS_CAST(fd);
+       fdb->errors = 0;
+}
+
 /**
  * Open file \a inode from \a disk in \a mode.
  * File context is stored in \a fd.
@@ -906,18 +946,27 @@ bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mo
        {
                LOG_INFO("file %d not found\n", inode);
                if (!(mode & BATTFS_CREATE))
+               {
+                       fd->errors |= BATTFS_FILE_NOT_FOUND_ERR;
                        return false;
+               }
                /* Create the file */
                BattFsPageHeader hdr;
                if (!(getNewPage(disk, start_pos, inode, 0, &hdr)))
+               {
+                       fd->errors |= BATTFS_DISK_GETNEWPAGE_ERR;
                        return false;
+               }
        }
        fd->start = &disk->page_array[start_pos];
        LOG_INFO("Start pos %d\n", start_pos);
 
        /* Fill file size */
        if ((fd->fd.size = countFileSize(disk, fd->start, inode)) == EOF)
+       {
+               fd->errors |= BATTFS_DISK_READ_ERR;
                return false;
+       }
        fd->max_off = fd->fd.size / disk->data_size;
 
        /* Reset seek position */
@@ -944,21 +993,19 @@ bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mo
        fd->fd.seek = kfile_genericSeek;
        fd->fd.write = battfs_write;
 
-#warning TODO battfs_error, battfs_clearerr
-#if 0
        fd->fd.error = battfs_error;
        fd->fd.clearerr = battfs_clearerr;
-#endif
 
        DB(fd->fd._type = KFT_BATTFS);
 
        return true;
 }
 
+
 /**
- * Close \a disk.
+ * Umount \a disk.
  */
-bool battfs_close(struct BattFsSuper *disk)
+bool battfs_umount(struct BattFsSuper *disk)
 {
        Node *n;
        int res = 0;