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->page_size - BATTFS_HEADER_LEN, 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->page_size - BATTFS_HEADER_LEN, 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->page_size - BATTFS_HEADER_LEN, 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->page_size - BATTFS_HEADER_LEN;
 268
 269                 /* Check header FCS */
 270                 if (hdr.fcs == computeFcs(&hdr))
 271                 {
 272                         ASSERT(hdr.fill <= disk->page_size - BATTFS_HEADER_LEN);
 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.
 416  * \return true if ok, false on errors.
 417  */
 418 static bool loadPage(struct BattFsSuper *disk, pgcnt_t new_page)
 419 {
 420         if (disk->curr_page == new_page)
 421                 return true;
 422
 423         LOG_INFO("Loading page %d\n", new_page);
 424
 425         if (!(flushBuffer(disk)
 426                 && disk->load(disk, new_page)))
 427                 return false;
 428
 429         disk->curr_page = new_page;
 430
 431         return true;
 432 }
 433
 434
 435 /**
 436  * Initialize and mount disk described by
 437  * \a disk.
 438  * \return false on errors, true otherwise.
 439  */
 440 bool battfs_init(struct BattFsSuper *disk)
 441 {
 442         pgoff_t filelen_table[BATTFS_MAX_FILES];
 443
 444         /* Sanity check */
 445         ASSERT(disk->open);
 446
 447         /* Init disk device */
 448         if (!disk->open(disk))
 449         {
 450                 LOG_ERR("open error\n");
 451                 return false;
 452         }
 453
 454         /* Disk open must set all of these */
 455         ASSERT(disk->read);
 456         ASSERT(disk->load);
 457         ASSERT(disk->bufferWrite);
 458         ASSERT(disk->bufferRead);
 459         ASSERT(disk->save);
 460         ASSERT(disk->erase);
 461         ASSERT(disk->close);
 462         ASSERT(disk->page_size);
 463         ASSERT(disk->page_count);
 464         ASSERT(disk->page_count < PAGE_UNSET_SENTINEL - 1);
 465         ASSERT(disk->page_array);
 466
 467         memset(filelen_table, 0, BATTFS_MAX_FILES * sizeof(pgoff_t));
 468
 469         disk->free_bytes = 0;
 470         disk->disk_size = (disk_size_t)(disk->page_size - BATTFS_HEADER_LEN) * disk->page_count;
 471
 472         /* Initialize page buffer cache */
 473         disk->cache_dirty = false;
 474         disk->curr_page = 0;
 475         disk->load(disk, disk->curr_page);
 476
 477         /* Count pages per file */
 478         if (!countDiskFilePages(disk, filelen_table))
 479         {
 480                 LOG_ERR("counting file pages\n");
 481                 return false;
 482         }
 483
 484         /* Once here, we have filelen_table filled with file lengths */
 485
 486         /* Fill page array with sentinel */
 487         for (pgcnt_t page = 0; page < disk->page_count; page++)
 488                 disk->page_array[page] = PAGE_UNSET_SENTINEL;
 489
 490         /* Fill page allocation array using filelen_table */
 491         if (!fillPageArray(disk, filelen_table))
 492         {
 493                 LOG_ERR("filling page array\n");
 494                 return false;
 495         }
 496         #if LOG_LEVEL > LOG_LVL_INFO
 497                 dumpPageArray(disk)
 498         #endif
 499         #warning TODO: shuffle free blocks
 500         //#if LOG_LEVEL > LOG_LVL_INFO
 501         //      dumpPageArray(disk)
 502         //#endif
 503         /* Init list for opened files. */
 504         LIST_INIT(&disk->file_opened_list);
 505         return true;
 506 }
 507
 508 /**
 509  * Flush file \a fd.
 510  * \return 0 if ok, EOF on errors.
 511  */
 512 static int battfs_flush(struct KFile *fd)
 513 {
 514         BattFs *fdb = BATTFS_CAST(fd);
 515
 516         if (flushBuffer(fdb->disk))
 517                 return 0;
 518         else
 519                 return EOF;
 520 }
 521
 522 /**
 523  * Close file \a fd.
 524  * \return 0 if ok, EOF on errors.
 525  */
 526 static int battfs_fileclose(struct KFile *fd)
 527 {
 528         BattFs *fdb = BATTFS_CAST(fd);
 529
 530         battfs_flush(fd);
 531         REMOVE(&fdb->link);
 532         return 0;
 533 }
 534
 535
 536 static bool getNewPage(struct BattFsSuper *disk, pgcnt_t new_pos, inode_t inode, pgoff_t pgoff)
 537 {
 538         if (disk->free_page_start >= disk->page_count)
 539         {
 540                 #warning TODO space over!
 541                 LOG_INFO("No disk space available\n");
 542                 return false;
 543         }
 544         flushBuffer(disk);
 545         LOG_INFO("Getting new page %d, pos %d\n", disk->page_array[disk->free_page_start], new_pos);
 546         disk->curr_page = disk->page_array[disk->free_page_start++];
 547         memmove(&disk->page_array[new_pos + 1], &disk->page_array[new_pos], (disk->free_page_start - new_pos - 1) * sizeof(pgcnt_t));
 548
 549         Node *n;
 550         /* Move following file start point one position ahead. */
 551         FOREACH_NODE(n, &disk->file_opened_list)
 552         {
 553                 BattFs *file = containerof(n, BattFs, link);
 554                 if (file->inode > inode)
 555                 {
 556                         LOG_INFO("Move file %d start pos\n", file->inode);
 557                         file->start++;
 558                 }
 559         }
 560
 561         disk->page_array[new_pos] = disk->curr_page;
 562         disk->cache_dirty = true;
 563
 564         BattFsPageHeader hdr;
 565         hdr.inode = inode;
 566         hdr.pgoff =  pgoff;
 567         hdr.fill = 0;
 568         hdr.seq = 0;
 569         if (!setBufferHdr(disk, &hdr))
 570                 return false;
 571         else
 572                 return true;
 573 }
 574
 575 /**
 576  * Write to file \a fd \a size bytes from \a buf.
 577  * \return The number of bytes written.
 578  */
 579 static size_t battfs_write(struct KFile *fd, const void *_buf, size_t size)
 580 {
 581         BattFs *fdb = BATTFS_CAST(fd);
 582         const uint8_t *buf = (const uint8_t *)_buf;
 583
 584         size_t total_write = 0;
 585         pgoff_t pg_offset;
 586         pgaddr_t addr_offset;
 587         pgaddr_t wr_len;
 588
 589         BattFsPageHeader curr_hdr;
 590         if (!getBufferHdr(fdb->disk, &curr_hdr))
 591                 return total_write;
 592
 593         #warning TODO seek_pos > size?
 594
 595         while (size)
 596         {
 597                 pg_offset = fd->seek_pos / (fdb->disk->page_size - BATTFS_HEADER_LEN);
 598                 addr_offset = fd->seek_pos % (fdb->disk->page_size - BATTFS_HEADER_LEN);
 599                 wr_len = MIN(size, (size_t)(fdb->disk->page_size - BATTFS_HEADER_LEN - addr_offset));
 600
 601                 /* Handle write outside EOF */
 602                 if (pg_offset > fdb->max_off)
 603                 {
 604                         LOG_INFO("New page needed, pg_offset %d, pos %d\n", pg_offset, (fdb->start - fdb->disk->page_array) + pg_offset);
 605                         if (!(getNewPage(fdb->disk, (fdb->start - fdb->disk->page_array) + pg_offset, fdb->inode, pg_offset)
 606                                 && getBufferHdr(fdb->disk, &curr_hdr)))
 607                                 return total_write;
 608                         fdb->max_off = pg_offset;
 609                 }
 610                 /* Handle cache load of a new page*/
 611                 else if (fdb->start[pg_offset] != fdb->disk->curr_page)
 612                 {
 613                         LOG_INFO("Re-writing page %d to %d\n", fdb->start[pg_offset], fdb->disk->page_array[fdb->disk->free_page_start]);
 614                         if (!(loadPage(fdb->disk, fdb->start[pg_offset])
 615                                 && getBufferHdr(fdb->disk, &curr_hdr)))
 616                         {
 617                                 #warning TODO set error?
 618                                 return total_write;
 619                         }
 620
 621                         /* Get a free page */
 622                         fdb->disk->curr_page = fdb->disk->page_array[fdb->disk->free_page_start];
 623                         movePages(fdb->disk, fdb->disk->free_page_start + 1, -1);
 624
 625                         /* Insert previous page in free blocks list */
 626                         LOG_INFO("Setting page %d as free\n", fdb->start[pg_offset]);
 627                         fdb->disk->page_array[fdb->disk->page_count - 1] = fdb->start[pg_offset];
 628                         /* Assign new page */
 629                         fdb->start[pg_offset] = fdb->disk->curr_page;
 630                         curr_hdr.seq++;
 631                 }
 632
 633
 634                 //LOG_INFO("writing to buffer for page %d, offset %d, size %d\n", fdb->disk->curr_page, addr_offset, wr_len);
 635                 if (fdb->disk->bufferWrite(fdb->disk, addr_offset, buf, wr_len) != wr_len)
 636                 {
 637                         #warning TODO set error?
 638                 }
 639                 fdb->disk->cache_dirty = true;
 640
 641                 size -= wr_len;
 642                 fd->seek_pos += wr_len;
 643                 total_write += wr_len;
 644                 buf += wr_len;
 645                 fill_t fill_delta = MAX((int32_t)(addr_offset + wr_len) - curr_hdr.fill, (int32_t)0);
 646                 fdb->disk->free_bytes -= fill_delta;
 647                 fd->size += fill_delta;
 648                 curr_hdr.fill += fill_delta;
 649
 650                 if (!setBufferHdr(fdb->disk, &curr_hdr))
 651                         return total_write;
 652
 653                 //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);
 654         }
 655         return total_write;
 656 }
 657
 658
 659 /**
 660  * Read from file \a fd \a size bytes in \a buf.
 661  * \return The number of bytes read.
 662  */
 663 static size_t battfs_read(struct KFile *fd, void *_buf, size_t size)
 664 {
 665         BattFs *fdb = BATTFS_CAST(fd);
 666         uint8_t *buf = (uint8_t *)_buf;
 667
 668         size_t total_read = 0;
 669         pgoff_t pg_offset;
 670         pgaddr_t addr_offset;
 671         pgaddr_t read_len;
 672
 673         size = MIN((kfile_off_t)size, fd->size - fd->seek_pos);
 674
 675         while (size)
 676         {
 677                 pg_offset = fd->seek_pos / (fdb->disk->page_size - BATTFS_HEADER_LEN);
 678                 addr_offset = fd->seek_pos % (fdb->disk->page_size - BATTFS_HEADER_LEN);
 679                 read_len = MIN(size, (size_t)(fdb->disk->page_size - BATTFS_HEADER_LEN - addr_offset));
 680
 681                 /* Read from disk */
 682                 if (diskRead(fdb->disk, fdb->start[pg_offset], addr_offset, buf, read_len) != read_len)
 683                 {
 684                         #warning TODO set error?
 685                 }
 686
 687                 #if _DEBUG
 688                         BattFsPageHeader hdr;
 689                         readHdr(fdb->disk, fdb->start[pg_offset], &hdr);
 690                         ASSERT(hdr.inode == fdb->inode);
 691                 #endif
 692
 693                 size -= read_len;
 694                 fd->seek_pos += read_len;
 695                 total_read += read_len;
 696                 buf += read_len;
 697         }
 698         return total_read;
 699 }
 700
 701
 702 /**
 703  * Search file \a inode in \a disk using a binary search.
 704  * \a last is filled with array offset of file start
 705  * in disk->page_array if file is found, otherwise
 706  * \a last is filled with the correct insert position
 707  * for creating a file with the given \a inode.
 708  * \return true if file is found, false otherwisr.
 709  */
 710 static bool findFile(BattFsSuper *disk, inode_t inode, pgcnt_t *last)
 711 {
 712         BattFsPageHeader hdr;
 713         pgcnt_t first = 0, page;
 714         *last = disk->free_page_start;
 715         fcs_t fcs;
 716
 717         while (first < *last)
 718         {
 719                 page = (first + *last) / 2;
 720                 LOG_INFO("first %d, last %d, page %d\n", first, *last, page);
 721                 if (!readHdr(disk, disk->page_array[page], &hdr))
 722                         return false;
 723                 LOG_INFO("inode read: %d\n", hdr.inode);
 724                 fcs = computeFcs(&hdr);
 725                 if (hdr.fcs == fcs && hdr.inode == inode)
 726                 {
 727                         *last = page - hdr.pgoff;
 728                         LOG_INFO("Found: %d\n", *last);
 729                         return true;
 730                 }
 731                 else if (hdr.fcs == fcs && hdr.inode < inode)
 732                         first = page + 1;
 733                 else
 734                         *last = page - 1;
 735         }
 736         LOG_INFO("Not found: last %d\n", *last);
 737         return false;
 738 }
 739
 740 /**
 741  * \return true if file \a inode exists on \a disk, false otherwise.
 742  */
 743 bool battfs_fileExists(BattFsSuper *disk, inode_t inode)
 744 {
 745         pgcnt_t dummy;
 746         return findFile(disk, inode, &dummy);
 747 }
 748
 749 /**
 750  * Count size of file \a inode on \a disk, starting at pointer \a start
 751  * in disk->page_array. Size is written in \a size.
 752  * \return true if all s ok, false on disk read errors.
 753  */
 754 static file_size_t countFileSize(BattFsSuper *disk, pgcnt_t *start, inode_t inode)
 755 {
 756         file_size_t size = 0;
 757         BattFsPageHeader hdr;
 758
 759         while (start < &disk->page_array[disk->free_page_start])
 760         {
 761                 if (!readHdr(disk, *start++, &hdr))
 762                         return EOF;
 763                 if (hdr.fcs == computeFcs(&hdr) && hdr.inode == inode)
 764                         size += hdr.fill;
 765                 else
 766                         break;
 767         }
 768         return size;
 769 }
 770
 771 /**
 772  * Open file \a inode from \a disk in \a mode.
 773  * File context is stored in \a fd.
 774  * \return true if ok, false otherwise.
 775  */
 776 bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode)
 777 {
 778         Node *n;
 779
 780         memset(fd, 0, sizeof(*fd));
 781
 782         /* Search file start point in disk page array */
 783         pgcnt_t start_pos;
 784         if (!findFile(disk, inode, &start_pos))
 785         {
 786                 LOG_INFO("file %d not found\n", inode);
 787                 if (!(mode & BATTFS_CREATE))
 788                         return false;
 789                 /* Create the file */
 790                 if (!(getNewPage(disk, start_pos, inode, 0)))
 791                         return false;
 792         }
 793         fd->start = &disk->page_array[start_pos];
 794         LOG_INFO("Start pos %d\n", start_pos);
 795
 796         /* Fill file size */
 797         if ((fd->fd.size = countFileSize(disk, fd->start, inode)) == EOF)
 798                 return false;
 799         fd->max_off = fd->fd.size / (disk->page_size - BATTFS_HEADER_LEN);
 800
 801         /* Reset seek position */
 802         fd->fd.seek_pos = 0;
 803
 804         /* Insert file handle in list, ordered by inode, ascending. */
 805         FOREACH_NODE(n, &disk->file_opened_list)
 806         {
 807                 BattFs *file = containerof(n, BattFs, link);
 808                 if (file->inode >= inode)
 809                         break;
 810         }
 811         INSERT_BEFORE(&fd->link, n);
 812
 813         /* Fill in data */
 814         fd->inode = inode;
 815         fd->mode = mode;
 816         fd->disk = disk;
 817
 818         fd->fd.close = battfs_fileclose;
 819         fd->fd.flush = battfs_flush;
 820         fd->fd.read = battfs_read;
 821         fd->fd.reopen = kfile_genericReopen;
 822         fd->fd.seek = kfile_genericSeek;
 823         fd->fd.write = battfs_write;
 824
 825 #warning TODO battfs_error, battfs_clearerr
 826 #if 0
 827         fd->fd.error = battfs_error;
 828         fd->fd.clearerr = battfs_clearerr;
 829 #endif
 830
 831         DB(fd->fd._type = KFT_BATTFS);
 832
 833         return true;
 834 }
 835
 836 /**
 837  * Close \a disk.
 838  */
 839 bool battfs_close(struct BattFsSuper *disk)
 840 {
 841         Node *n;
 842         int res = 0;
 843
 844         /* Close all open files */
 845         FOREACH_NODE(n, &disk->file_opened_list)
 846         {
 847                 BattFs *file = containerof(n, BattFs, link);
 848                 res += battfs_fileclose(&file->fd);
 849         }
 850
 851         /* Close disk */
 852         return disk->close(disk) && (res == 0);
 853 }
 854
 855 #if UNIT_TEST
 856
 857 bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff)
 858 {
 859         BattFsPageHeader hdr;
 860
 861         /* Reset page to all 0xff */
 862         uint8_t buf[disk->page_size];
 863         memset(buf, 0xFF, disk->page_size);
 864         disk->bufferWrite(disk, 0, buf, disk->page_size);
 865
 866         hdr.inode = inode;
 867         hdr.fill = fill;
 868         hdr.pgoff = pgoff;
 869         hdr.seq = seq;
 870         hdr.fcs = computeFcs(&hdr);
 871
 872         if (!(setBufferHdr(disk, &hdr) && disk->save(disk, page)))
 873         {
 874                 LOG_ERR("error writing hdr\n");
 875                 return false;
 876         }
 877
 878         return true;
 879 }
 880 #endif