bertos/fs/battfs.c

   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  * \brief BattFS: a filesystem for embedded platforms (implementation).
  34  *
  35  * \version $Id:$
  36  *
  37  * \author Francesco Sacchi <batt@develer.com>
  38  *
  39  */
  40
  41 #include "battfs.h"
  42
  43 #include <cfg/debug.h>
  44 #include <cfg/macros.h> /* MIN, MAX */
  45 #include <cpu/byteorder.h> /* cpu_to_xx */
  46
  47 #define LOG_LEVEL       LOG_LVL_INFO
  48 #define LOG_FORMAT      LOG_FMT_VERBOSE
  49 #include <cfg/log.h>
  50
  51 #include <string.h> /* memset, memmove */
  52
  53 #if LOG_LEVEL >= LOG_LVL_INFO
  54 static void dumpPageArray(struct BattFsSuper *disk)
  55 {
  56         kprintf("Page array dump, free_page_start %d:", disk->free_page_start);
  57         for (pgcnt_t i = 0; i < disk->page_count; i++)
  58         {
  59                 if (!(i % 16))
  60                         kputchar('\n');
  61                 kprintf("%04d ", disk->page_array[i]);
  62         }
  63         kputchar('\n');
  64 }
  65 #endif
  66
  67 /**
  68  * Convert from memory representation to disk structure.
  69  * \note filesystem is in little-endian format.
  70  */
  71 INLINE void battfs_to_disk(struct BattFsPageHeader *hdr, uint8_t *buf)
  72 {
  73         STATIC_ASSERT(BATTFS_HEADER_LEN == 12);
  74         buf[0] = hdr->inode;
  75
  76         buf[1] = hdr->fill;
  77         buf[2] = hdr->fill >> 8;
  78
  79         buf[3] = hdr->pgoff;
  80         buf[4] = hdr->pgoff >> 8;
  81
  82         /*
  83          * Sequence number is 40 bits long.
  84          * No need to take care of wraparonds: the memory will die first!
  85          */
  86         buf[5] = hdr->seq;
  87         buf[6] = hdr->seq >> 8;
  88         buf[7] = hdr->seq >> 16;
  89         buf[8] = hdr->seq >> 24;
  90         buf[9] = hdr->seq >> 32;
  91
  92         /*
  93          * This field must be the last one!
  94          * This is needed because if the page is only partially
  95          * written, we can use this to detect it.
  96          */
  97         buf[10] = hdr->fcs;
  98         buf[11] = hdr->fcs >> 8;
  99 }
 100
 101 /**
 102  * Convert from disk structure to memory representation.
 103  * \note filesystem is in little-endian format.
 104  */
 105 INLINE void disk_to_battfs(uint8_t *buf, struct BattFsPageHeader *hdr)
 106 {
 107         STATIC_ASSERT(BATTFS_HEADER_LEN == 12);
 108         hdr->inode = buf[0];
 109         hdr->fill = buf[2] << 8 | buf[1];
 110         hdr->pgoff = buf[4] << 8 | buf[3];
 111         hdr->seq = (seq_t)buf[9] << 32 | (seq_t)buf[8] << 24 | (seq_t)buf[7] << 16 | buf[6] << 8 | buf[5];
 112         hdr->fcs = buf[11] << 8 | buf[10];
 113 }
 114
 115 /**
 116  * Compute the fcs of the header.
 117  */
 118 static fcs_t computeFcs(struct BattFsPageHeader *hdr)
 119 {
 120         uint8_t buf[BATTFS_HEADER_LEN];
 121         fcs_t cks;
 122
 123         battfs_to_disk(hdr, buf);
 124         rotating_init(&cks);
 125         /* fcs is at the end of whole header */
 126         rotating_update(buf, BATTFS_HEADER_LEN - sizeof(fcs_t), &cks);
 127         return cks;
 128 }
 129
 130 /**
 131  * Read from disk.
 132  * If available, the cache will be used.
 133  * \return the number of bytes read.
 134  */
 135 static size_t diskRead(struct BattFsSuper *disk, pgcnt_t page, pgaddr_t addr, void *buf, size_t size)
 136 {
 137         /* Try to read from cache */
 138         if (page == disk->curr_page)
 139                 return disk->bufferRead(disk, addr, buf, size);
 140         /* Read from disk */
 141         else
 142                 return disk->read(disk, page, addr, buf, size);
 143 }
 144
 145
 146 /**
 147  * Read header of \a page in \a hdr.
 148  * \return true on success, false otherwise.
 149  */
 150 static bool readHdr(struct BattFsSuper *disk, pgcnt_t page, struct BattFsPageHeader *hdr)
 151 {
 152         uint8_t buf[BATTFS_HEADER_LEN];
 153         /*
 154          * Read header from disk.
 155          * Header is actually a footer, and so
 156          * resides at page end.
 157          */
 158         if (diskRead(disk, page, disk->data_size, buf, BATTFS_HEADER_LEN)
 159             != BATTFS_HEADER_LEN)
 160         {
 161                 LOG_ERR("page[%d]\n", page);
 162                 return false;
 163         }
 164
 165         /* Fill header */
 166         disk_to_battfs(buf, hdr);
 167
 168         return true;
 169 }
 170
 171 /**
 172  * Set header on current \a disk page buffer.
 173  * \return true on success, false otherwise.
 174  */
 175 static bool setBufferHdr(struct BattFsSuper *disk, struct BattFsPageHeader *hdr)
 176 {
 177         uint8_t buf[BATTFS_HEADER_LEN];
 178
 179         #warning FIXME:refactor computeFcs to save time and stack
 180         hdr->fcs = computeFcs(hdr);
 181         /* Fill buffer */
 182         battfs_to_disk(hdr, buf);
 183
 184         /*
 185          * write header to buffer.
 186          * Header is actually a footer, and so
 187          * resides at page end.
 188          */
 189         if (disk->bufferWrite(disk, disk->data_size, buf, BATTFS_HEADER_LEN)
 190             != BATTFS_HEADER_LEN)
 191         {
 192                 LOG_ERR("writing to buffer\n");
 193                 return false;
 194         }
 195         return true;
 196 }
 197
 198 static bool getBufferHdr(struct BattFsSuper *disk, struct BattFsPageHeader *hdr)
 199 {
 200         uint8_t buf[BATTFS_HEADER_LEN];
 201
 202         if (disk->bufferRead(disk, disk->data_size, buf, BATTFS_HEADER_LEN)
 203             != BATTFS_HEADER_LEN)
 204         {
 205                 LOG_ERR("reading from buffer\n");
 206                 return false;
 207         }
 208
 209         disk_to_battfs(buf, hdr);
 210
 211         return true;
 212 }
 213
 214 /**
 215  * Count the number of pages from
 216  * inode 0 to \a inode in \a filelen_table.
 217  */
 218 static pgcnt_t countPages(pgoff_t *filelen_table, inode_t inode)
 219 {
 220         pgcnt_t cnt = 0;
 221
 222         for (inode_t i = 0; i < inode; i++)
 223                 cnt += filelen_table[i];
 224
 225         return cnt;
 226 }
 227
 228 /**
 229  * Move all pages in page allocation array from \a src to \a src + \a offset.
 230  * The number of pages moved is page_count - MAX(dst, src).
 231  */
 232 static void movePages(struct BattFsSuper *disk, pgcnt_t src, int offset)
 233 {
 234         pgcnt_t dst = src + offset;
 235         LOG_INFO("src %d, offset %d, size %ld\n", src, offset, (disk->page_count - MAX(dst, src)) * sizeof(pgcnt_t));
 236         memmove(&disk->page_array[dst], &disk->page_array[src], (disk->page_count - MAX(dst, src)) * sizeof(pgcnt_t));
 237
 238         if (offset < 0)
 239         {
 240                 /* Fill empty space in array with sentinel */
 241                 for (pgcnt_t page = disk->page_count + offset; page < disk->page_count; page++)
 242                         disk->page_array[page] = PAGE_UNSET_SENTINEL;
 243         }
 244 }
 245
 246 /**
 247  * Count number of pages per file on \a disk.
 248  * This information is registered in \a filelen_table.
 249  * Array index represent file inode, while value contained
 250  * is the number of pages used by that file.
 251  *
 252  * \return true if ok, false on disk read errors.
 253  * \note The whole disk is scanned once.
 254  */
 255 static bool countDiskFilePages(struct BattFsSuper *disk, pgoff_t *filelen_table)
 256 {
 257         BattFsPageHeader hdr;
 258         disk->free_page_start = 0;
 259
 260         /* Count the number of disk page per file */
 261         for (pgcnt_t page = 0; page < disk->page_count; page++)
 262         {
 263                 if (!readHdr(disk, page, &hdr))
 264                         return false;
 265
 266                 /* Increase free space */
 267                 disk->free_bytes += disk->data_size;
 268
 269                 /* Check header FCS */
 270                 if (hdr.fcs == computeFcs(&hdr))
 271                 {
 272                         ASSERT(hdr.fill <= disk->data_size);
 273
 274                         /* Page is valid and is owned by a file */
 275                         filelen_table[hdr.inode]++;
 276
 277                         /* Keep trace of free space */
 278                         disk->free_bytes -= hdr.fill;
 279                         disk->free_page_start++;
 280                 }
 281         }
 282         LOG_INFO("free_bytes:%d, free_page_start:%d\n", disk->free_bytes, disk->free_page_start);
 283
 284         return true;
 285 }
 286
 287 /**
 288  * Fill page allocation array of \a disk
 289  * using file lenghts in \a filelen_table.
 290  *
 291  * The page allocation array is an array containings all file infos.
 292  * Is ordered by file, and within each file is ordered by page offset
 293  * inside file.
 294  * e.g. : at page array[0] you will find page address of the first page
 295  * of the first file (if present).
 296  * Free blocks are allocated after the last file.
 297  *
 298  * \return true if ok, false on disk read errors.
 299  * \note The whole disk is scanned at max twice.
 300  */
 301 static bool fillPageArray(struct BattFsSuper *disk, pgoff_t *filelen_table)
 302 {
 303         BattFsPageHeader hdr;
 304         pgcnt_t curr_free_page = disk->free_page_start;
 305         /* Fill page allocation array */
 306         for (pgcnt_t page = 0; page < disk->page_count; page++)
 307         {
 308                 if (!readHdr(disk, page, &hdr))
 309                         return false;
 310
 311                 /* Check header FCS */
 312                 if (hdr.fcs == computeFcs(&hdr))
 313                 {
 314                         /* Compute array position */
 315                         pgcnt_t array_pos = countPages(filelen_table, hdr.inode);
 316                         array_pos += hdr.pgoff;
 317
 318
 319                         /* Check if position is already used by another page of the same file */
 320                         if (disk->page_array[array_pos] == PAGE_UNSET_SENTINEL)
 321                                 disk->page_array[array_pos] = page;
 322                         else
 323                         {
 324                                 BattFsPageHeader hdr_prv;
 325
 326                                 if (!readHdr(disk, disk->page_array[array_pos], &hdr_prv))
 327                                         return false;
 328
 329                                 /* Check header FCS */
 330                                 ASSERT(hdr_prv.fcs == computeFcs(&hdr_prv));
 331
 332                                 /* Only the very same page with a different seq number can be here */
 333                                 ASSERT(hdr.inode == hdr_prv.inode);
 334                                 ASSERT(hdr.pgoff == hdr_prv.pgoff);
 335                                 ASSERT(hdr.seq != hdr_prv.seq);
 336
 337                                 pgcnt_t new_page, old_page;
 338                                 fill_t old_fill;
 339
 340                                 /*
 341                                  * Sequence number comparison: since
 342                                  * seq is 40 bits wide, it wraps once
 343                                  * every 1.1E12 times.
 344                                  * The memory will not live enough to
 345                                  * see a wraparound, so we can use a simple
 346                                  * compare here.
 347                                  */
 348                                 if (hdr.seq > hdr_prv.seq)
 349                                 {
 350                                         /* Current header is newer than the previuos one */
 351                                         old_page = disk->page_array[array_pos];
 352                                         new_page = page;
 353                                         old_fill = hdr_prv.fill;
 354                                 }
 355                                 else
 356                                 {
 357                                         /* Previous header is newer than the current one */
 358                                         old_page = page;
 359                                         new_page = disk->page_array[array_pos];
 360                                         old_fill = hdr.fill;
 361                                 }
 362
 363                                 /* Set new page */
 364                                 disk->page_array[array_pos] = new_page;
 365                                 /* Add free space */
 366                                 disk->free_bytes += old_fill;
 367                                 /* Shift all array one position to the left, overwriting duplicate page */
 368                                 array_pos -= hdr.pgoff;
 369                                 array_pos += filelen_table[hdr.inode];
 370                                 movePages(disk, array_pos, -1);
 371                                 /* Move back all indexes */
 372                                 filelen_table[hdr.inode]--;
 373                                 disk->free_page_start--;
 374                                 curr_free_page--;
 375                                 /* Set old page as free */
 376                                 ASSERT(disk->page_array[curr_free_page] == PAGE_UNSET_SENTINEL);
 377                                 disk->page_array[curr_free_page++] = old_page;
 378
 379                         }
 380                 }
 381                 else
 382                 {
 383                         /* Invalid page, keep as free */
 384                         ASSERT(disk->page_array[curr_free_page] == PAGE_UNSET_SENTINEL);
 385                         LOG_INFO("Page %d invalid, keeping as free\n", page);
 386                         disk->page_array[curr_free_page++] = page;
 387                 }
 388         }
 389         return true;
 390 }
 391
 392
 393 /**
 394  * Flush the current \a disk buffer.
 395  * \return true if ok, false on errors.
 396  */
 397 static bool flushBuffer(struct BattFsSuper *disk)
 398 {
 399         if (disk->cache_dirty)
 400         {
 401                 LOG_INFO("Flushing to disk page %d\n", disk->curr_page);
 402
 403                 if (!(disk->erase(disk, disk->curr_page)
 404                         && disk->save(disk, disk->curr_page)))
 405                         return false;
 406
 407                 disk->cache_dirty = false;
 408         }
 409         return true;
 410 }
 411
 412 /**
 413  * Load \a new_page from \a disk in disk page buffer.
 414  * If a previuos page is still dirty in the buffer, will be
 415  * flushed first. The new page header loaded will be put in \a new_hdr.
 416  * \return true if ok, false on errors.
 417  */
 418 static bool loadPage(struct BattFsSuper *disk, pgcnt_t new_page, BattFsPageHeader *new_hdr)
 419 {
 420         if (disk->curr_page == new_page)
 421                 return getBufferHdr(disk, new_hdr);
 422
 423         LOG_INFO("Loading page %d\n", new_page);
 424
 425         if (!(flushBuffer(disk)
 426                 && disk->load(disk, new_page)
 427                 && getBufferHdr(disk, new_hdr)))
 428                 return false;
 429
 430         disk->curr_page = new_page;
 431
 432         return true;
 433 }
 434
 435
 436 /**
 437  * Initialize and mount disk described by
 438  * \a disk.
 439  * \return false on errors, true otherwise.
 440  */
 441 bool battfs_init(struct BattFsSuper *disk)
 442 {
 443         pgoff_t filelen_table[BATTFS_MAX_FILES];
 444
 445         /* Sanity check */
 446         ASSERT(disk->open);
 447
 448         /* Init disk device */
 449         if (!disk->open(disk))
 450         {
 451                 LOG_ERR("open error\n");
 452                 return false;
 453         }
 454
 455         /* Disk open must set all of these */
 456         ASSERT(disk->read);
 457         ASSERT(disk->load);
 458         ASSERT(disk->bufferWrite);
 459         ASSERT(disk->bufferRead);
 460         ASSERT(disk->save);
 461         ASSERT(disk->erase);
 462         ASSERT(disk->close);
 463         ASSERT(disk->page_size > BATTFS_HEADER_LEN);
 464         /* Fill page_size with the usable space */
 465         disk->data_size = disk->page_size - BATTFS_HEADER_LEN;
 466         ASSERT(disk->page_count);
 467         ASSERT(disk->page_count < PAGE_UNSET_SENTINEL - 1);
 468         ASSERT(disk->page_array);
 469
 470         memset(filelen_table, 0, BATTFS_MAX_FILES * sizeof(pgoff_t));
 471
 472         disk->free_bytes = 0;
 473         disk->disk_size = (disk_size_t)disk->data_size * disk->page_count;
 474
 475         /* Initialize page buffer cache */
 476         disk->cache_dirty = false;
 477         disk->curr_page = 0;
 478         disk->load(disk, disk->curr_page);
 479
 480         /* Count pages per file */
 481         if (!countDiskFilePages(disk, filelen_table))
 482         {
 483                 LOG_ERR("counting file pages\n");
 484                 return false;
 485         }
 486
 487         /* Once here, we have filelen_table filled with file lengths */
 488
 489         /* Fill page array with sentinel */
 490         for (pgcnt_t page = 0; page < disk->page_count; page++)
 491                 disk->page_array[page] = PAGE_UNSET_SENTINEL;
 492
 493         /* Fill page allocation array using filelen_table */
 494         if (!fillPageArray(disk, filelen_table))
 495         {
 496                 LOG_ERR("filling page array\n");
 497                 return false;
 498         }
 499         #if LOG_LEVEL >= LOG_LVL_INFO
 500                 dumpPageArray(disk);
 501         #endif
 502         #warning TODO: shuffle free blocks
 503         //#if LOG_LEVEL > LOG_LVL_INFO
 504         //      dumpPageArray(disk);
 505         //#endif
 506         /* Init list for opened files. */
 507         LIST_INIT(&disk->file_opened_list);
 508         return true;
 509 }
 510
 511 /**
 512  * Check the filesystem.
 513  * \return true if ok, false on errors.
 514  */
 515 bool battfs_fsck(struct BattFsSuper *disk)
 516 {
 517         #define FSCHECK(cond) do { if(!(cond)) { LOG_ERR("\"" #cond "\"\n"); return false; } } while (0)
 518
 519         FSCHECK(disk->free_page_start <= disk->page_count);
 520         FSCHECK(disk->data_size < disk->page_size);
 521         FSCHECK(disk->free_bytes <= disk->disk_size);
 522
 523         disk_size_t free_bytes = 0;
 524         BattFsPageHeader hdr, prev_hdr;
 525         inode_t files = 0;
 526         pgcnt_t page_used = 0;
 527
 528         bool start = true;
 529
 530         for (pgcnt_t page = 0; page < disk->page_count; page++)
 531         {
 532                 FSCHECK(readHdr(disk, disk->page_array[page], &hdr));
 533                 free_bytes += disk->data_size;
 534
 535                 if (page < disk->free_page_start)
 536                 {
 537                         FSCHECK(computeFcs(&hdr) == hdr.fcs);
 538                         page_used++;
 539                         free_bytes -= hdr.fill;
 540                         if (hdr.inode != prev_hdr.inode || start)
 541                         {
 542                                 if (LIKELY(!start))
 543                                         FSCHECK(hdr.inode > prev_hdr.inode);
 544                                 else
 545                                         start = false;
 546
 547                                 FSCHECK(hdr.pgoff == 0);
 548                                 files++;
 549                         }
 550                         else
 551                         {
 552                                 FSCHECK(hdr.fill != 0);
 553                                 FSCHECK(prev_hdr.fill == disk->data_size);
 554                                 FSCHECK(hdr.pgoff == prev_hdr.pgoff + 1);
 555                         }
 556                         prev_hdr = hdr;
 557                 }
 558         }
 559
 560         FSCHECK(page_used == disk->free_page_start);
 561         FSCHECK(free_bytes == disk->free_bytes);
 562
 563         return true;
 564 }
 565
 566 /**
 567  * Flush file \a fd.
 568  * \return 0 if ok, EOF on errors.
 569  */
 570 static int battfs_flush(struct KFile *fd)
 571 {
 572         BattFs *fdb = BATTFS_CAST(fd);
 573
 574         if (flushBuffer(fdb->disk))
 575                 return 0;
 576         else
 577                 return EOF;
 578 }
 579
 580 /**
 581  * Close file \a fd.
 582  * \return 0 if ok, EOF on errors.
 583  */
 584 static int battfs_fileclose(struct KFile *fd)
 585 {
 586         BattFs *fdb = BATTFS_CAST(fd);
 587
 588         battfs_flush(fd);
 589         REMOVE(&fdb->link);
 590         return 0;
 591 }
 592
 593
 594 static bool getNewPage(struct BattFsSuper *disk, pgcnt_t new_pos, inode_t inode, pgoff_t pgoff, BattFsPageHeader *new_hdr)
 595 {
 596         if (disk->free_page_start >= disk->page_count)
 597         {
 598                 #warning TODO space over!
 599                 LOG_INFO("No disk space available\n");
 600                 return false;
 601         }
 602         flushBuffer(disk);
 603         LOG_INFO("Getting new page %d, pos %d\n", disk->page_array[disk->free_page_start], new_pos);
 604         disk->curr_page = disk->page_array[disk->free_page_start++];
 605         memmove(&disk->page_array[new_pos + 1], &disk->page_array[new_pos], (disk->free_page_start - new_pos - 1) * sizeof(pgcnt_t));
 606
 607         Node *n;
 608         /* Move following file start point one position ahead. */
 609         FOREACH_NODE(n, &disk->file_opened_list)
 610         {
 611                 BattFs *file = containerof(n, BattFs, link);
 612                 if (file->inode > inode)
 613                 {
 614                         LOG_INFO("Move file %d start pos\n", file->inode);
 615                         file->start++;
 616                 }
 617         }
 618
 619         disk->page_array[new_pos] = disk->curr_page;
 620         disk->cache_dirty = true;
 621
 622         new_hdr->inode = inode;
 623         new_hdr->pgoff =  pgoff;
 624         new_hdr->fill = 0;
 625         new_hdr->seq = 0;
 626         return setBufferHdr(disk, new_hdr);
 627 }
 628
 629 /**
 630  * Write to file \a fd \a size bytes from \a buf.
 631  * \return The number of bytes written.
 632  */
 633 static size_t battfs_write(struct KFile *fd, const void *_buf, size_t size)
 634 {
 635         BattFs *fdb = BATTFS_CAST(fd);
 636         const uint8_t *buf = (const uint8_t *)_buf;
 637
 638         size_t total_write = 0;
 639         pgoff_t pg_offset;
 640         pgaddr_t addr_offset;
 641         pgaddr_t wr_len;
 642         BattFsPageHeader curr_hdr;
 643
 644         if (fd->seek_pos < 0)
 645                 return total_write;
 646
 647         if (fd->seek_pos > fd->size)
 648         {
 649                 /* Handle writing when seek pos if far over EOF */
 650                 if (!loadPage(fdb->disk, fdb->start[fdb->max_off], &curr_hdr))
 651                 {
 652                                 #warning TODO set error?
 653                                 return total_write;
 654                 }
 655
 656                 /* Fill unused space of first page with 0s */
 657                 uint8_t dummy = 0;
 658                 pgaddr_t zero_bytes = MIN(fd->seek_pos - fd->size, fdb->disk->data_size - curr_hdr.fill);
 659                 while (zero_bytes--)
 660                 {
 661                         if (fdb->disk->bufferWrite(fdb->disk, curr_hdr.fill, &dummy, 1) != 1)
 662                         {
 663                                 #warning TODO set error?
 664                         }
 665                         curr_hdr.fill++;
 666                         fd->size++;
 667                         fdb->disk->free_bytes--;
 668                         fdb->disk->cache_dirty = true;
 669                 }
 670                 setBufferHdr(fdb->disk, &curr_hdr);
 671
 672                 /* Allocate the missing pages first. */
 673                 pgoff_t missing_pages = fd->seek_pos / fdb->disk->data_size - fdb->max_off;
 674
 675                 if (missing_pages)
 676                 {
 677                         LOG_INFO("missing pages: %d\n", missing_pages);
 678                         flushBuffer(fdb->disk);
 679
 680                         /* Fill page buffer with 0 to avoid filling unused pages with garbage */
 681                         for (pgaddr_t off = 0; off < fdb->disk->data_size; off++)
 682                         {
 683                                 if (fdb->disk->bufferWrite(fdb->disk, off, &dummy, 1) != 1)
 684                                 {
 685                                         #warning TODO set error?
 686                                 }
 687                         }
 688
 689                         while (missing_pages--)
 690                         {
 691                                 zero_bytes = MIN((kfile_off_t)fdb->disk->data_size, fd->seek_pos - fd->size);
 692                                 /* Get the new page needed */
 693                                 if (!getNewPage(fdb->disk, (fdb->start - fdb->disk->page_array) + fdb->max_off + 1, fdb->inode, fdb->max_off + 1, &curr_hdr))
 694                                         return total_write;
 695
 696                                 /* Update size and free space left */
 697                                 fd->size += zero_bytes;
 698                                 fdb->disk->free_bytes -= zero_bytes;
 699
 700                                 curr_hdr.fill = zero_bytes;
 701                                 setBufferHdr(fdb->disk, &curr_hdr);
 702
 703                                 fdb->max_off++;
 704                         }
 705                 }
 706         }
 707         else if (!getBufferHdr(fdb->disk, &curr_hdr))
 708                 return total_write;
 709
 710         while (size)
 711         {
 712                 pg_offset = fd->seek_pos / fdb->disk->data_size;
 713                 addr_offset = fd->seek_pos % fdb->disk->data_size;
 714                 wr_len = MIN(size, (size_t)(fdb->disk->data_size - addr_offset));
 715
 716                 /* Handle write outside EOF */
 717                 if (pg_offset > fdb->max_off)
 718                 {
 719                         LOG_INFO("New page needed, pg_offset %d, pos %d\n", pg_offset, (fdb->start - fdb->disk->page_array) + pg_offset);
 720                         if (!getNewPage(fdb->disk, (fdb->start - fdb->disk->page_array) + pg_offset, fdb->inode, pg_offset, &curr_hdr))
 721                                 return total_write;
 722                         fdb->max_off = pg_offset;
 723                 }
 724                 /* Handle cache load of a new page*/
 725                 else if (fdb->start[pg_offset] != fdb->disk->curr_page)
 726                 {
 727                         LOG_INFO("Re-writing page %d to %d\n", fdb->start[pg_offset], fdb->disk->page_array[fdb->disk->free_page_start]);
 728                         if (!loadPage(fdb->disk, fdb->start[pg_offset], &curr_hdr))
 729                         {
 730                                 #warning TODO set error?
 731                                 return total_write;
 732                         }
 733
 734                         /* Get a free page */
 735                         fdb->disk->curr_page = fdb->disk->page_array[fdb->disk->free_page_start];
 736                         movePages(fdb->disk, fdb->disk->free_page_start + 1, -1);
 737
 738                         /* Insert previous page in free blocks list */
 739                         LOG_INFO("Setting page %d as free\n", fdb->start[pg_offset]);
 740                         fdb->disk->page_array[fdb->disk->page_count - 1] = fdb->start[pg_offset];
 741                         /* Assign new page */
 742                         fdb->start[pg_offset] = fdb->disk->curr_page;
 743                         curr_hdr.seq++;
 744                 }
 745
 746
 747                 //LOG_INFO("writing to buffer for page %d, offset %d, size %d\n", fdb->disk->curr_page, addr_offset, wr_len);
 748                 if (fdb->disk->bufferWrite(fdb->disk, addr_offset, buf, wr_len) != wr_len)
 749                 {
 750                         #warning TODO set error?
 751                 }
 752                 fdb->disk->cache_dirty = true;
 753
 754                 size -= wr_len;
 755                 fd->seek_pos += wr_len;
 756                 total_write += wr_len;
 757                 buf += wr_len;
 758                 fill_t fill_delta = MAX((int32_t)(addr_offset + wr_len) - curr_hdr.fill, (int32_t)0);
 759                 fdb->disk->free_bytes -= fill_delta;
 760                 fd->size += fill_delta;
 761                 curr_hdr.fill += fill_delta;
 762
 763                 if (!setBufferHdr(fdb->disk, &curr_hdr))
 764                         return total_write;
 765
 766                 //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);
 767         }
 768         return total_write;
 769 }
 770
 771
 772 /**
 773  * Read from file \a fd \a size bytes in \a buf.
 774  * \return The number of bytes read.
 775  */
 776 static size_t battfs_read(struct KFile *fd, void *_buf, size_t size)
 777 {
 778         BattFs *fdb = BATTFS_CAST(fd);
 779         uint8_t *buf = (uint8_t *)_buf;
 780
 781         size_t total_read = 0;
 782         pgoff_t pg_offset;
 783         pgaddr_t addr_offset;
 784         pgaddr_t read_len;
 785
 786         if (fd->seek_pos < 0)
 787                 return total_read;
 788
 789         size = MIN((kfile_off_t)size, MAX(fd->size - fd->seek_pos, 0));
 790
 791         while (size)
 792         {
 793                 pg_offset = fd->seek_pos / fdb->disk->data_size;
 794                 addr_offset = fd->seek_pos % fdb->disk->data_size;
 795                 read_len = MIN(size, (size_t)(fdb->disk->data_size - addr_offset));
 796
 797                 //LOG_INFO("reading from page %d, offset %d, size %d\n", fdb->start[pg_offset], addr_offset, read_len);
 798                 /* Read from disk */
 799                 if (diskRead(fdb->disk, fdb->start[pg_offset], addr_offset, buf, read_len) != read_len)
 800                 {
 801                         #warning TODO set error?
 802                 }
 803
 804                 #if _DEBUG
 805                         BattFsPageHeader hdr;
 806                         readHdr(fdb->disk, fdb->start[pg_offset], &hdr);
 807                         ASSERT(hdr.inode == fdb->inode);
 808                 #endif
 809
 810                 size -= read_len;
 811                 fd->seek_pos += read_len;
 812                 total_read += read_len;
 813                 buf += read_len;
 814         }
 815         return total_read;
 816 }
 817
 818
 819 /**
 820  * Search file \a inode in \a disk using a binary search.
 821  * \a last is filled with array offset of file start
 822  * in disk->page_array if file is found, otherwise
 823  * \a last is filled with the correct insert position
 824  * for creating a file with the given \a inode.
 825  * \return true if file is found, false otherwisr.
 826  */
 827 static bool findFile(BattFsSuper *disk, inode_t inode, pgcnt_t *last)
 828 {
 829         BattFsPageHeader hdr;
 830         pgcnt_t first = 0, page;
 831         *last = disk->free_page_start;
 832         fcs_t fcs;
 833
 834         while (first < *last)
 835         {
 836                 page = (first + *last) / 2;
 837                 LOG_INFO("first %d, last %d, page %d\n", first, *last, page);
 838                 if (!readHdr(disk, disk->page_array[page], &hdr))
 839                         return false;
 840                 LOG_INFO("inode read: %d\n", hdr.inode);
 841                 fcs = computeFcs(&hdr);
 842                 if (hdr.fcs == fcs && hdr.inode == inode)
 843                 {
 844                         *last = page - hdr.pgoff;
 845                         LOG_INFO("Found: %d\n", *last);
 846                         return true;
 847                 }
 848                 else if (hdr.fcs == fcs && hdr.inode < inode)
 849                         first = page + 1;
 850                 else
 851                         *last = page - 1;
 852         }
 853         LOG_INFO("Not found: last %d\n", *last);
 854         return false;
 855 }
 856
 857 /**
 858  * \return true if file \a inode exists on \a disk, false otherwise.
 859  */
 860 bool battfs_fileExists(BattFsSuper *disk, inode_t inode)
 861 {
 862         pgcnt_t dummy;
 863         return findFile(disk, inode, &dummy);
 864 }
 865
 866 /**
 867  * Count size of file \a inode on \a disk, starting at pointer \a start
 868  * in disk->page_array. Size is written in \a size.
 869  * \return true if all s ok, false on disk read errors.
 870  */
 871 static file_size_t countFileSize(BattFsSuper *disk, pgcnt_t *start, inode_t inode)
 872 {
 873         file_size_t size = 0;
 874         BattFsPageHeader hdr;
 875
 876         while (start < &disk->page_array[disk->free_page_start])
 877         {
 878                 if (!readHdr(disk, *start++, &hdr))
 879                         return EOF;
 880                 if (hdr.fcs == computeFcs(&hdr) && hdr.inode == inode)
 881                         size += hdr.fill;
 882                 else
 883                         break;
 884         }
 885         return size;
 886 }
 887
 888 /**
 889  * Open file \a inode from \a disk in \a mode.
 890  * File context is stored in \a fd.
 891  * \return true if ok, false otherwise.
 892  */
 893 bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode)
 894 {
 895         Node *n;
 896
 897         memset(fd, 0, sizeof(*fd));
 898
 899         /* Search file start point in disk page array */
 900         pgcnt_t start_pos;
 901         if (!findFile(disk, inode, &start_pos))
 902         {
 903                 LOG_INFO("file %d not found\n", inode);
 904                 if (!(mode & BATTFS_CREATE))
 905                         return false;
 906                 /* Create the file */
 907                 BattFsPageHeader hdr;
 908                 if (!(getNewPage(disk, start_pos, inode, 0, &hdr)))
 909                         return false;
 910         }
 911         fd->start = &disk->page_array[start_pos];
 912         LOG_INFO("Start pos %d\n", start_pos);
 913
 914         /* Fill file size */
 915         if ((fd->fd.size = countFileSize(disk, fd->start, inode)) == EOF)
 916                 return false;
 917         fd->max_off = fd->fd.size / disk->data_size;
 918
 919         /* Reset seek position */
 920         fd->fd.seek_pos = 0;
 921
 922         /* Insert file handle in list, ordered by inode, ascending. */
 923         FOREACH_NODE(n, &disk->file_opened_list)
 924         {
 925                 BattFs *file = containerof(n, BattFs, link);
 926                 if (file->inode >= inode)
 927                         break;
 928         }
 929         INSERT_BEFORE(&fd->link, n);
 930
 931         /* Fill in data */
 932         fd->inode = inode;
 933         fd->mode = mode;
 934         fd->disk = disk;
 935
 936         fd->fd.close = battfs_fileclose;
 937         fd->fd.flush = battfs_flush;
 938         fd->fd.read = battfs_read;
 939         fd->fd.reopen = kfile_genericReopen;
 940         fd->fd.seek = kfile_genericSeek;
 941         fd->fd.write = battfs_write;
 942
 943 #warning TODO battfs_error, battfs_clearerr
 944 #if 0
 945         fd->fd.error = battfs_error;
 946         fd->fd.clearerr = battfs_clearerr;
 947 #endif
 948
 949         DB(fd->fd._type = KFT_BATTFS);
 950
 951         return true;
 952 }
 953
 954 /**
 955  * Close \a disk.
 956  */
 957 bool battfs_close(struct BattFsSuper *disk)
 958 {
 959         Node *n;
 960         int res = 0;
 961
 962         /* Close all open files */
 963         FOREACH_NODE(n, &disk->file_opened_list)
 964         {
 965                 BattFs *file = containerof(n, BattFs, link);
 966                 res += battfs_fileclose(&file->fd);
 967         }
 968
 969         /* Close disk */
 970         return disk->close(disk) && (res == 0);
 971 }
 972
 973 #if UNIT_TEST
 974
 975 bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff)
 976 {
 977         BattFsPageHeader hdr;
 978
 979         /* Reset page to all 0xff */
 980         uint8_t buf[disk->page_size];
 981         memset(buf, 0xFF, disk->page_size);
 982         disk->bufferWrite(disk, 0, buf, disk->page_size);
 983
 984         hdr.inode = inode;
 985         hdr.fill = fill;
 986         hdr.pgoff = pgoff;
 987         hdr.seq = seq;
 988         hdr.fcs = computeFcs(&hdr);
 989
 990         if (!(setBufferHdr(disk, &hdr) && disk->save(disk, page)))
 991         {
 992                 LOG_ERR("error writing hdr\n");
 993                 return false;
 994         }
 995
 996         return true;
 997 }
 998 #endif