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