4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2007, 2008 Develer S.r.l. (http://www.develer.com/)
35 * \author Francesco Sacchi <batt@develer.com>
38 #include <fs/battfs.h>
40 #include <cfg/debug.h>
47 #define FILE_SIZE 32768
49 #define PAGE_COUNT FILE_SIZE / PAGE_SIZE
54 const char test_filename[]="battfs_disk.bin";
56 static uint8_t page_buffer[PAGE_SIZE];
58 static bool disk_open(struct BattFsSuper *d)
60 fp = fopen(test_filename, "r+b");
62 fseek(fp, 0, SEEK_END);
63 d->page_size = PAGE_SIZE;
64 d->page_count = ftell(fp) / d->page_size;
65 d->page_array = malloc(d->page_count * sizeof(pgcnt_t));
66 //TRACEMSG("page_size:%d, page_count:%d\n", d->page_size, d->page_count);
67 return (fp && d->page_array);
70 static size_t disk_page_read(struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t size)
72 //TRACEMSG("page:%d, addr:%d, size:%d", page, addr, size);
73 fseek(fp, page * d->page_size + addr, SEEK_SET);
74 return fread(buf, 1, size, fp);
77 static size_t disk_buffer_write(struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t size)
79 //TRACEMSG("addr:%d, size:%d", addr, size);
80 ASSERT(addr + size <= d->page_size);
81 memcpy(&page_buffer[addr], buf, size);
86 static size_t disk_buffer_read(struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t size)
88 //TRACEMSG("addr:%d, size:%d", addr, size);
89 ASSERT(addr + size <= d->page_size);
90 memcpy(buf, &page_buffer[addr], size);
95 static bool disk_page_load(struct BattFsSuper *d, pgcnt_t page)
97 //TRACEMSG("page:%d", page);
98 fseek(fp, page * d->page_size, SEEK_SET);
99 return fread(page_buffer, 1, d->page_size, fp) == d->page_size;
102 static bool disk_page_save(struct BattFsSuper *d, pgcnt_t page)
104 //TRACEMSG("page:%d", page);
105 fseek(fp, page * d->page_size, SEEK_SET);
106 return fwrite(page_buffer, 1, d->page_size, fp) == d->page_size;
109 static bool disk_page_erase(struct BattFsSuper *d, pgcnt_t page)
111 //TRACEMSG("page:%d", page);
112 fseek(fp, page * d->page_size, SEEK_SET);
114 for (int i = 0; i < d->page_size; i++)
115 if (fputc(0xff, fp) == EOF)
120 static bool disk_close(struct BattFsSuper *d)
124 return (fclose(fp) != EOF);
127 static void testCheck(BattFsSuper *disk, pgcnt_t *reference)
129 ASSERT(battfs_init(disk));
131 for (int i = 0; i < disk->page_count; i++)
133 if (disk->page_array[i] != reference[i])
135 kprintf("Error at addr %d: page_array read", i);
136 for (pgcnt_t i = 0; i < disk->page_count; i++)
140 kprintf("%04d ", disk->page_array[i]);
143 kprintf("Expected:");
144 for (pgcnt_t i = 0; i < disk->page_count; i++)
148 kprintf("%04d ", reference[i]);
158 static void test1(BattFsSuper *disk)
160 pgcnt_t ref[PAGE_COUNT];
161 kprintf("Test1: disk new\n");
163 FILE *fpt = fopen(test_filename, "w+");
165 for (int i = 0; i < FILE_SIZE; i++)
168 for (int i = 0; i < PAGE_COUNT; i++)
171 testCheck(disk, ref);
172 kprintf("Test1: passed\n");
175 static void test2(BattFsSuper *disk)
177 pgcnt_t ref[PAGE_COUNT];
178 kprintf("Test2: disk full with 1 contiguos file\n");
181 fp = fopen(test_filename, "w+");
183 for (int i = 0; i < PAGE_COUNT; i++)
185 battfs_writeTestBlock(disk, i, 0, 0, 0, i);
190 testCheck(disk, ref);
191 kprintf("Test2: passed\n");
195 static void test3(BattFsSuper *disk)
197 pgcnt_t ref[PAGE_COUNT];
198 kprintf("Test3: disk half full with 1 contiguos file, rest unformatted\n");
201 fp = fopen(test_filename, "w+");
203 for (int i = 0; i < PAGE_COUNT / 2; i++)
205 battfs_writeTestBlock(disk, i, 0, 0, 0, i);
208 fseek(fp, FILE_SIZE / 2, SEEK_SET);
209 for (int i = FILE_SIZE / 2; i < FILE_SIZE; i++)
213 for (int i = PAGE_COUNT / 2; i < PAGE_COUNT; i++)
219 testCheck(disk, ref);
220 kprintf("Test3: passed\n");
224 static void test4(BattFsSuper *disk)
226 pgcnt_t ref[PAGE_COUNT];
227 kprintf("Test4: disk half full with 1 contiguos file, rest marked free\n");
230 fp = fopen(test_filename, "w+");
232 for (int i = 0; i < PAGE_COUNT / 2; i++)
234 battfs_writeTestBlock(disk, i, 0, 0, 0, i);
237 for (int i = PAGE_COUNT / 2; i < PAGE_COUNT; i++)
239 battfs_writeTestBlock(disk, i, 0, 0, 0, i);
245 testCheck(disk, ref);
246 kprintf("Test4: passed\n");
249 static void test5(BattFsSuper *disk)
251 pgcnt_t ref[PAGE_COUNT];
252 kprintf("Test5: disk 1/3 full with 1 contiguos file, 1/3 marked free, rest unformatted\n");
255 fp = fopen(test_filename, "w+");
257 for (int i = 0; i < FILE_SIZE; i++)
260 for (int i = 0; i < PAGE_COUNT / 3; i++)
262 battfs_writeTestBlock(disk, i, 0, 0, 0, i);
265 for (int i = PAGE_COUNT / 3; i < 2 * (PAGE_COUNT / 3); i++)
267 battfs_writeTestBlock(disk, i, 0, 0, 0, i);
268 ref[i + PAGE_COUNT / 3 + 1] = i;
272 for (int i = PAGE_COUNT / 3; i < 2 * (PAGE_COUNT / 3) + 1; i++)
273 ref[i] = PAGE_COUNT + PAGE_COUNT / 3 - i - 1;
275 testCheck(disk, ref);
276 kprintf("Test5: passed\n");
280 static void test6(BattFsSuper *disk)
283 kprintf("Test6: 1 file with 1 old seq num, 1 free block\n");
286 fp = fopen(test_filename, "w+");
287 // page, inode, seq, fill, pgoff
288 battfs_writeTestBlock(disk, 0, 0, 0, 0, 0);
289 battfs_writeTestBlock(disk, 1, 0, 0, 0, 1);
290 battfs_writeTestBlock(disk, 2, 0, 1, 0, 1);
291 disk->erase(disk, 3);
300 testCheck(disk, ref);
301 kprintf("Test6: passed\n");
304 static void test7(BattFsSuper *disk)
307 kprintf("Test7: 1 file with 1 old seq num, 1 free block\n");
310 fp = fopen(test_filename, "w+");
311 // page, inode, seq, fill, pgoff
312 battfs_writeTestBlock(disk, 0, 0, 0, 0, 0);
313 battfs_writeTestBlock(disk, 1, 0, 1, 0, 1);
314 battfs_writeTestBlock(disk, 2, 0, 0, 0, 1);
315 disk->erase(disk, 3);
323 testCheck(disk, ref);
324 kprintf("Test7: passed\n");
327 static void test8(BattFsSuper *disk)
330 kprintf("Test8: 1 file with 1 old seq num, 1 free block\n");
333 fp = fopen(test_filename, "w+");
335 // page, inode, seq, fill, pgoff
336 disk->erase(disk, 0);
337 battfs_writeTestBlock(disk, 1, 0, 0, 0, 0);
338 battfs_writeTestBlock(disk, 2, 0, 1, 0, 1);
339 battfs_writeTestBlock(disk, 3, 0, 0, 0, 1);
348 testCheck(disk, ref);
349 kprintf("Test8: passed\n");
352 static void test9(BattFsSuper *disk)
355 kprintf("Test9: 2 file with old seq num, 2 free block\n");
358 fp = fopen(test_filename, "w+");
360 // page, inode, seq, fill, pgoff
361 disk->erase(disk, 0);
362 battfs_writeTestBlock(disk, 1, 0, 0, 0, 0);
363 battfs_writeTestBlock(disk, 2, 0, 3, 0, 1);
364 battfs_writeTestBlock(disk, 3, 0, 0, 0, 1);
365 disk->erase(disk, 4);
366 battfs_writeTestBlock(disk, 5, 4, 0, 0, 0);
367 battfs_writeTestBlock(disk, 6, 4, 1, 0, 1);
368 battfs_writeTestBlock(disk, 7, 4, 0, 0, 1);
381 testCheck(disk, ref);
382 kprintf("Test9: passed\n");
385 static void test10(BattFsSuper *disk)
389 kprintf("Test10: open file test, inode 0 and inode 4\n");
391 fp = fopen(test_filename, "w+");
393 int PAGE_FILL = PAGE_SIZE - BATTFS_HEADER_LEN;
394 unsigned int INODE = 0;
395 unsigned int INODE2 = 4;
396 unsigned int INEXISTENT_INODE = 123;
397 unsigned int MODE = 0;
399 // page, inode, seq, fill, pgoff
400 disk->erase(disk, 0);
401 battfs_writeTestBlock(disk, 1, INODE, 0, PAGE_FILL, 0);
402 battfs_writeTestBlock(disk, 2, INODE, 3, PAGE_FILL, 1);
403 battfs_writeTestBlock(disk, 3, INODE, 0, PAGE_FILL, 1);
404 disk->erase(disk, 4);
405 battfs_writeTestBlock(disk, 5, INODE2, 0, PAGE_FILL, 0);
406 battfs_writeTestBlock(disk, 6, INODE2, 1, PAGE_FILL, 1);
407 battfs_writeTestBlock(disk, 7, INODE2, 0, PAGE_FILL, 1);
411 ASSERT(battfs_init(disk));
412 ASSERT(!battfs_fileExists(disk, INEXISTENT_INODE));
414 ASSERT(battfs_fileExists(disk, INODE));
415 ASSERT(battfs_fileopen(disk, &fd1, INODE, MODE));
416 ASSERT(fd1.fd.size == PAGE_FILL * 2);
417 ASSERT(fd1.fd.seek_pos == 0);
418 ASSERT(fd1.mode == MODE);
419 ASSERT(fd1.inode == INODE);
420 ASSERT(fd1.start == &disk->page_array[0]);
421 ASSERT(fd1.disk == disk);
422 ASSERT(LIST_HEAD(&disk->file_opened_list) == &fd1.link);
424 ASSERT(kfile_reopen(&fd1.fd) == &fd1.fd);
425 ASSERT(fd1.fd.size == PAGE_FILL * 2);
426 ASSERT(fd1.fd.seek_pos == 0);
427 ASSERT(fd1.mode == MODE);
428 ASSERT(fd1.inode == INODE);
429 ASSERT(fd1.start == &disk->page_array[0]);
430 ASSERT(fd1.disk == disk);
431 ASSERT(LIST_HEAD(&disk->file_opened_list) == &fd1.link);
433 ASSERT(battfs_fileExists(disk, INODE2));
434 ASSERT(battfs_fileopen(disk, &fd2, INODE2, MODE));
435 ASSERT(fd2.fd.size == PAGE_FILL * 2);
436 ASSERT(fd2.fd.seek_pos == 0);
437 ASSERT(fd2.mode == MODE);
438 ASSERT(fd2.inode == INODE2);
439 ASSERT(fd2.start == &disk->page_array[2]);
440 ASSERT(fd2.disk == disk);
441 ASSERT(LIST_HEAD(&disk->file_opened_list)->succ == &fd2.link);
443 ASSERT(kfile_close(&fd1.fd) == 0);
444 ASSERT(kfile_close(&fd2.fd) == 0);
445 ASSERT(LIST_EMPTY(&disk->file_opened_list));
446 ASSERT(battfs_close(disk));
448 kprintf("Test10: passed\n");
451 static void test11(BattFsSuper *disk)
456 kprintf("Test11: read file test\n");
458 fp = fopen(test_filename, "w+");
460 unsigned int PAGE_FILL = PAGE_SIZE - BATTFS_HEADER_LEN;
461 unsigned int INODE = 0;
462 unsigned int INODE2 = 4;
463 unsigned int MODE = 0;
465 disk->erase(disk, 0);
466 battfs_writeTestBlock(disk, 1, INODE, 0, PAGE_FILL, 0);
467 battfs_writeTestBlock(disk, 2, INODE, 3, PAGE_FILL, 1);
468 battfs_writeTestBlock(disk, 3, INODE, 0, PAGE_FILL, 1);
469 disk->erase(disk, 4);
470 battfs_writeTestBlock(disk, 5, INODE2, 0, PAGE_FILL, 0);
471 battfs_writeTestBlock(disk, 6, INODE2, 1, PAGE_FILL, 1);
472 battfs_writeTestBlock(disk, 7, INODE2, 0, PAGE_FILL, 1);
476 ASSERT(battfs_init(disk));
477 ASSERT(battfs_fileopen(disk, &fd1, INODE, MODE));
478 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
479 ASSERT(fd1.fd.seek_pos == sizeof(buf));
480 for (size_t i = 0; i < sizeof(buf); i++)
481 ASSERT(buf[i] == 0xff);
483 ASSERT(kfile_close(&fd1.fd) == 0);
484 ASSERT(battfs_close(disk));
486 kprintf("Test11: passed\n");
489 static void test12(BattFsSuper *disk)
493 kprintf("Test12: read file test across page boundary and seek test\n");
495 fp = fopen(test_filename, "w+");
497 const unsigned int PAGE_FILL = PAGE_SIZE - BATTFS_HEADER_LEN;
498 unsigned int INODE = 0;
499 unsigned int MODE = 0;
500 uint8_t buf[PAGE_FILL + BATTFS_HEADER_LEN / 2];
502 disk->erase(disk, 0);
503 battfs_writeTestBlock(disk, 1, INODE, 0, PAGE_FILL, 0);
504 battfs_writeTestBlock(disk, 2, INODE, 3, PAGE_FILL, 1);
505 battfs_writeTestBlock(disk, 3, INODE, 0, PAGE_FILL, 1);
506 disk->erase(disk, 4);
507 battfs_writeTestBlock(disk, 5, INODE, 0, PAGE_FILL, 2);
508 battfs_writeTestBlock(disk, 6, INODE, 1, PAGE_FILL, 3);
509 battfs_writeTestBlock(disk, 7, INODE, 0, PAGE_FILL, 3);
513 ASSERT(battfs_init(disk));
514 ASSERT(battfs_fileopen(disk, &fd1, INODE, MODE));
516 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
517 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf));
518 for (size_t i = 0; i < sizeof(buf); i++)
519 ASSERT(buf[i] == 0xff);
521 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
522 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf) * 2);
523 for (size_t i = 0; i < sizeof(buf); i++)
524 ASSERT(buf[i] == 0xff);
526 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
527 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf) * 3);
528 for (size_t i = 0; i < sizeof(buf); i++)
529 ASSERT(buf[i] == 0xff);
531 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == PAGE_FILL * 4 - sizeof(buf) * 3);
532 ASSERT(fd1.fd.seek_pos == (kfile_off_t)fd1.fd.size);
533 for (size_t i = 0; i < PAGE_FILL * 4 - sizeof(buf) * 3; i++)
534 ASSERT(buf[i] == 0xff);
536 ASSERT(kfile_seek(&fd1.fd, 0, KSM_SEEK_SET) == 0);
537 ASSERT(fd1.fd.seek_pos == 0);
539 ASSERT(kfile_seek(&fd1.fd, 0, KSM_SEEK_END) == (kfile_off_t)fd1.fd.size);
540 ASSERT(fd1.fd.seek_pos = (kfile_off_t)fd1.fd.size);
542 ASSERT(kfile_close(&fd1.fd) == 0);
543 ASSERT(battfs_close(disk));
545 kprintf("Test12: passed\n");
549 static void test13(BattFsSuper *disk)
552 uint8_t buf[PAGE_SIZE - BATTFS_HEADER_LEN];
554 kprintf("Test13: write file test\n");
556 fp = fopen(test_filename, "w+");
558 unsigned int PAGE_FILL = PAGE_SIZE - BATTFS_HEADER_LEN;
559 unsigned int INODE = 0;
560 unsigned int INODE2 = 4;
561 unsigned int MODE = 0;
563 disk->erase(disk, 0);
564 battfs_writeTestBlock(disk, 1, INODE, 0, PAGE_FILL, 0);
565 battfs_writeTestBlock(disk, 2, INODE, 3, PAGE_FILL, 1);
566 battfs_writeTestBlock(disk, 3, INODE, 0, PAGE_FILL, 1);
567 disk->erase(disk, 4);
568 battfs_writeTestBlock(disk, 5, INODE2, 0, PAGE_FILL, 0);
569 battfs_writeTestBlock(disk, 6, INODE2, 1, PAGE_FILL, 1);
570 battfs_writeTestBlock(disk, 7, INODE2, 0, PAGE_FILL, 1);
574 for (size_t i = 0; i < sizeof(buf); i++)
577 ASSERT(battfs_init(disk));
578 ASSERT(battfs_fileopen(disk, &fd1, INODE, MODE));
579 ASSERT(kfile_write(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
580 ASSERT(fd1.fd.seek_pos == sizeof(buf));
581 ASSERT(kfile_seek(&fd1.fd, 0, KSM_SEEK_SET) == 0);
582 ASSERT(fd1.fd.seek_pos == 0);
584 memset(buf, 0, sizeof(buf));
585 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
586 for (size_t i = 0; i < sizeof(buf); i++)
589 ASSERT(kfile_close(&fd1.fd) == 0);
590 ASSERT(battfs_close(disk));
592 kprintf("Test13: passed\n");
595 static void test14(BattFsSuper *disk)
599 kprintf("Test14: write file test across page boundary and seek test\n");
601 fp = fopen(test_filename, "w+");
603 const unsigned int PAGE_FILL = PAGE_SIZE - BATTFS_HEADER_LEN;
604 unsigned int INODE = 0;
605 unsigned int MODE = 0;
606 uint8_t buf[PAGE_FILL + BATTFS_HEADER_LEN / 2];
608 disk->erase(disk, 0);
609 battfs_writeTestBlock(disk, 1, INODE, 0, PAGE_FILL, 0);
610 battfs_writeTestBlock(disk, 2, INODE, 3, PAGE_FILL, 1);
611 battfs_writeTestBlock(disk, 3, INODE, 0, PAGE_FILL, 1);
612 disk->erase(disk, 4);
613 battfs_writeTestBlock(disk, 5, INODE, 0, PAGE_FILL, 2);
614 battfs_writeTestBlock(disk, 6, INODE, 1, PAGE_FILL, 3);
615 battfs_writeTestBlock(disk, 7, INODE, 0, PAGE_FILL, 3);
619 ASSERT(battfs_init(disk));
620 ASSERT(battfs_fileopen(disk, &fd1, INODE, MODE));
623 for (size_t i = 0; i < sizeof(buf); i++)
625 ASSERT(kfile_write(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
626 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf));
628 for (size_t i = 0; i < sizeof(buf); i++)
630 ASSERT(kfile_write(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
631 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf) * 2);
633 for (size_t i = 0; i < sizeof(buf); i++)
635 ASSERT(kfile_write(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
636 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf) * 3);
638 ASSERT(kfile_seek(&fd1.fd, 0, KSM_SEEK_SET) == 0);
639 ASSERT(fd1.fd.seek_pos == 0);
642 memset(buf, 0, sizeof(buf));
643 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
644 for (size_t i = 0; i < sizeof(buf); i++)
645 ASSERT(buf[i] == val++);
647 memset(buf, 0, sizeof(buf));
648 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
649 for (size_t i = 0; i < sizeof(buf); i++)
650 ASSERT(buf[i] == val++);
652 memset(buf, 0, sizeof(buf));
653 ASSERT(kfile_read(&fd1.fd, buf, sizeof(buf)) == sizeof(buf));
654 for (size_t i = 0; i < sizeof(buf); i++)
655 ASSERT(buf[i] == val++);
657 ASSERT(fd1.fd.seek_pos == (kfile_off_t)sizeof(buf) * 3);
659 ASSERT(kfile_close(&fd1.fd) == 0);
660 ASSERT(battfs_close(disk));
662 kprintf("Test14: passed\n");
665 static void test15(BattFsSuper *disk)
667 kprintf("Test15: file creation on new disk\n");
669 FILE *fpt = fopen(test_filename, "w+");
671 for (int i = 0; i < FILE_SIZE; i++)
676 unsigned int INODE = 0;
677 unsigned int MODE = BATTFS_CREATE;
679 ASSERT(battfs_init(disk));
680 ASSERT(battfs_fileopen(disk, &fd1, INODE, MODE));
681 for (int i = 0; i < FILE_SIZE / 2; i++)
682 ASSERT(kfile_putc(i, &fd1.fd) != EOF);
684 ASSERT(kfile_close(&fd1.fd) == 0);
685 ASSERT(battfs_close(disk));
687 kprintf("Test15: passed\n");
690 int battfs_testRun(void)
694 disk.open = disk_open;
695 disk.read = disk_page_read;
696 disk.load = disk_page_load;
697 disk.bufferWrite = disk_buffer_write;
698 disk.bufferRead = disk_buffer_read;
699 disk.save = disk_page_save;
700 disk.erase = disk_page_erase;
701 disk.close = disk_close;
717 kprintf("All tests passed!\n");
722 int battfs_testSetup(void)
727 int battfs_testTearDown(void)
734 #include <fs/battfs.c>
735 #include <kern/kfile.c>
736 #include <drv/kdebug.c>
737 #include <mware/formatwr.c>
738 #include <mware/hex.c>