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