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