-
Notifications
You must be signed in to change notification settings - Fork 130
/
MicroBitFileSystem.cpp
1352 lines (1120 loc) · 41.3 KB
/
MicroBitFileSystem.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
The MIT License (MIT)
Copyright (c) 2016 British Broadcasting Corporation.
This software is provided by Lancaster University by arrangement with the BBC.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include "MicroBitConfig.h"
#include "MicroBitFileSystem.h"
#include "MicroBitFlash.h"
#include "MicroBitStorage.h"
#include "MicroBitCompat.h"
#include "ErrorNo.h"
static uint32_t *defaultScratchPage = (uint32_t *)DEFAULT_SCRATCH_PAGE;
MicroBitFileSystem* MicroBitFileSystem::defaultFileSystem = NULL;
/**
* Allocate a free logical block.
* This is chosen at random from the blocks available, to even out the wear on the physical device.
* @return a valid, unused block address on success, or zero if no space is available.
*/
uint16_t MicroBitFileSystem::getFreeBlock()
{
// Walk the File Table and allocate the first free block - starting immediately after the last block allocated,
// and wrapping around the filesystem space if we reach the end.
uint16_t block;
uint16_t deletedBlock = 0;
for (block = (lastBlockAllocated + 1) % fileSystemSize; block != lastBlockAllocated; block++)
{
if (fileSystemTable[block] == MBFS_UNUSED)
{
lastBlockAllocated = block;
return block;
}
if (fileSystemTable[block] == MBFS_DELETED)
deletedBlock = block;
}
// if no UNUSED blocks are available, try to recycle one marked as DELETED.
block = deletedBlock;
// If no blocks are available - either UNUSED or marked as DELETED, then we're out of space and there's nothing we can do.
if (block)
{
// recycle the FileTable, such that we can mark all previously deleted blocks as re-usable.
// Better to do this in bulk, rather than on a block by block basis to improve efficiency.
recycleFileTable();
// Record the block we just allocated, so we can round-robin around blocks for load balancing.
lastBlockAllocated = block;
}
return block;
}
/**
* Allocates a free physical page of memory.
* This is chosen using a round robin algorithm, to even out the wear on the physical device.
* @return NULL on error, page address on success
*/
uint32_t* MicroBitFileSystem::getFreePage()
{
// Walk the file table, starting at the last allocated block, looking for an unused page.
int blocksPerPage = (PAGE_SIZE / MBFS_BLOCK_SIZE);
// get a handle on the next physical page.
uint16_t currentPage = getBlockNumber(getPage(lastBlockAllocated));
uint16_t page = (currentPage + blocksPerPage) % fileSystemSize;
uint16_t recyclablePage = 0;
// Walk around the file table, looking for a free page.
while (page != currentPage)
{
bool empty = true;
bool deleted = false;
uint16_t next;
for (int i = 0; i < blocksPerPage; i++)
{
next = getNextFileBlock(page + i);
if (next == MBFS_DELETED)
deleted = true;
else if (next != MBFS_UNUSED)
{
empty = false;
break;
}
}
// See if we found one...
if (empty)
{
lastBlockAllocated = page;
return getBlock(page);
}
// make note of the first unused but un-erased page we find (if any).
if (deleted && !recyclablePage)
recyclablePage = page;
page = (page + blocksPerPage) % fileSystemSize;
}
// No empty pages are available, but we may be able to recycle one.
if (recyclablePage)
{
uint32_t *address = getBlock(recyclablePage);
flash.erase_page(address);
return address;
}
// Nothing available at all. Use the default.
flash.erase_page(defaultScratchPage);
return defaultScratchPage;
}
/**
* Constructor. Creates an instance of a MicroBitFileSystem.
*/
MicroBitFileSystem::MicroBitFileSystem(uint32_t flashStart, int flashPages)
{
// Initialise status flags to default value
this->status = 0;
// Attempt tp load an existing filesystem, if it exisits
init(flashStart, flashPages);
// If this is the first FileSystem created, so it as the default.
if(MicroBitFileSystem::defaultFileSystem == NULL)
MicroBitFileSystem::defaultFileSystem = this;
}
/**
* Initialize the flash storage system
*
* The file system is located dynamically, based on where the program code
* and code data finishes. This avoids having to allocate a fixed flash
* region for builds even without MicroBitFileSystem.
*
* This method checks if the file system already exists, and loads it it.
* If not, it will determines the optimal size of the file system, if necessary, and format the space
*
* @return MICROBIT_OK on success, or an error code.
*/
int MicroBitFileSystem::init(uint32_t flashStart, int flashPages)
{
// Protect against accidental re-initialisation
if (status & MBFS_STATUS_INITIALISED)
return MICROBIT_NOT_SUPPORTED;
// Validate parameters
if (flashPages < 0)
return MICROBIT_INVALID_PARAMETER;
// Zero initialise default parameters (mbed/ARMCC does not permit this is the class definition).
fileSystemTable = NULL;
lastBlockAllocated = 0;
rootDirectory = NULL;
openFiles = NULL;
// If we have a zero length, then dynamically determine our geometry.
if (flashStart == 0)
{
// Flash start is on the first page after the programmed ROM contents.
// This is: __etext (program code) for GCC and Image$$RO$$Limit for ARMCC.
flashStart = FLASH_PROGRAM_END;
// Round up to the nearest free page.
if (flashStart % PAGE_SIZE != 0)
flashStart = ((uint32_t)flashStart & ~(PAGE_SIZE-1)) + PAGE_SIZE;
}
if (flashPages == 0)
flashPages = (DEFAULT_SCRATCH_PAGE - flashStart) / PAGE_SIZE;
// The FileTable alays resides at the start of the file system.
fileSystemTable = (uint16_t *)flashStart;
// First, try to load an existing file system at this location.
if (load() != MICROBIT_OK)
{
// No file system was found, so format a fresh one.
// Bring up a freshly formatted file system here.
fileSystemSize = flashPages * (PAGE_SIZE / MBFS_BLOCK_SIZE);
fileSystemTableSize = calculateFileTableSize();
format();
}
// indicate that we have a valid FileSystem
status = MBFS_STATUS_INITIALISED;
return MICROBIT_OK;
}
/**
* Attempts to detect and load an exisitng file file system.
*
* @return MICROBIT_OK on success, or MICROBIT_NO_DATA if the file system could not be found.
*/
int MicroBitFileSystem::load()
{
uint16_t rootOffset = fileSystemTable[0];
// A valid MBFS has the first 'N' blocks set to the value 'N' followed by a valid root directory block with magic signature.
for (int i = 0; i < rootOffset; i++)
{
if (fileSystemTable[i] >= MBFS_EOF || fileSystemTable[i] != rootOffset)
return MICROBIT_NO_DATA;
}
// Check for a valid signature at the start of the root directory
DirectoryEntry *root = (DirectoryEntry *) getBlock(rootOffset);
if (strcmp(root->file_name, MBFS_MAGIC) != 0)
return MICROBIT_NO_DATA;
rootDirectory = root;
fileSystemSize = root->length;
fileSystemTableSize = calculateFileTableSize();
return MICROBIT_OK;
}
/**
* Initialises a new file system. Assumes all pages are already erased.
*
* @return MICROBIT_OK on success, or an error code..
*/
int MicroBitFileSystem::format()
{
uint16_t value = fileSystemTableSize;
// Mark the FileTable blocks themselves as used.
for (uint16_t block = 0; block < fileSystemTableSize; block++)
flash.flash_write(&fileSystemTable[block], &value, 2);
// Create a root directory
value = MBFS_EOF;
flash.flash_write(&fileSystemTable[fileSystemTableSize], &value, 2);
// Store a MAGIC value in the first root directory entry.
// This will let us identify a valid File System later.
DirectoryEntry magic;
strcpy(magic.file_name, MBFS_MAGIC);
magic.first_block = fileSystemTableSize;
magic.flags = MBFS_DIRECTORY_ENTRY_VALID;
magic.length = fileSystemSize;
// Cache the root directory entry for later use.
rootDirectory = (DirectoryEntry *)getBlock(fileSystemTableSize);
flash.flash_write(rootDirectory, &magic, sizeof(DirectoryEntry));
return MICROBIT_OK;
}
/**
* Retrieve the DirectoryEntry for the given filename.
*
* @param filename A fully or partially qualified filename.
* @param directory The directory to search. If ommitted, the root directory will be used.
*
* @return A pointer to the DirectoryEntry for the given file, or NULL if no entry is found.
*/
DirectoryEntry* MicroBitFileSystem::getDirectoryEntry(char const * filename, const DirectoryEntry *directory)
{
Directory *dir;
char const *file;
uint16_t block;
DirectoryEntry *dirent;
// Determine the filename from the (potentially) fully qualified filename.
file = filename + strlen(filename);
while (file >= filename && *file != '/')
file--;
file++;
// Obtain a handle on the directory to search.
if (directory == NULL)
directory = rootDirectory;
block = directory->first_block;
dir = (Directory *) getBlock(block);
dirent = &dir->entry[0];
// Iterate through the directory entries until we find our file, or run out of space.
while (1)
{
if ((uint32_t)(dirent + 1) > (uint32_t)dir + MBFS_BLOCK_SIZE)
{
block = getNextFileBlock(block);
if (block == MBFS_EOF)
return NULL;
dir = (Directory *)getBlock(block);
dirent = &dir->entry[0];
}
// Check for a valid match
if (dirent->flags & MBFS_DIRECTORY_ENTRY_VALID && strcmp(dirent->file_name, file) == 0)
return dirent;
// Move onto the next entry.
dirent++;
}
return NULL;
}
/**
* Determine the number of logical blocks required to hold the file table.
*
* @return The number of logical blocks required to hold the file table.
*/
uint16_t MicroBitFileSystem::calculateFileTableSize()
{
uint16_t size = (fileSystemSize * 2) / MBFS_BLOCK_SIZE;
if ((fileSystemSize * 2) % MBFS_BLOCK_SIZE)
size++;
return size;
}
/**
* Retrieve a memory pointer for the start of the physical memory page containing the given block.
*
* @param block A valid block number.
*
* @return A pointer to the physical page in FLASH memory holding the given block.
*/
uint32_t *MicroBitFileSystem::getPage(uint16_t block)
{
uint32_t address = (uint32_t) getBlock(block);
return (uint32_t *) (address - address % PAGE_SIZE);
}
/**
* Retrieve a memory pointer for the start of the given block.
*
* @param block A valid block number.
*
* @return A pointer to the FLASH memory associated with the given block.
*/
uint32_t *MicroBitFileSystem::getBlock(uint16_t block)
{
return (uint32_t *)((uint32_t)fileSystemTable + block * MBFS_BLOCK_SIZE);
}
/**
* Retrieve the next block in a chain.
*
* @param block A valid block number.
*
* @return The block number of the next block in the file.
*/
uint16_t MicroBitFileSystem::getNextFileBlock(uint16_t block)
{
return fileSystemTable[block];
}
/**
* Determine the logical block that contains the given address.
*
* @param address A valid memory location within the file system space.
*
* @return The block number containing the given address.
*/
uint16_t MicroBitFileSystem::getBlockNumber(void *address)
{
return (((uint32_t) address - (uint32_t) fileSystemTable) / MBFS_BLOCK_SIZE);
}
/**
* Update a file table entry to a given value.
*
* @param block The block to update.
* @param value The value to store in the file table.
* @return MICROBIT_OK on success.
*/
int MicroBitFileSystem::fileTableWrite(uint16_t block, uint16_t value)
{
flash.flash_write(&fileSystemTable[block], &value, 2);
return MICROBIT_OK;
}
/**
* Retrieve the DirectoryEntry for the given filename.
*
* @param filename A fully qualified filename, from the root. Should be end with a "/" if no filename is provided.
*
* @return A pointer to the DirectoryEntry for the given file, or NULL if no entry is found.
*/
DirectoryEntry* MicroBitFileSystem::getDirectoryOf(char const * filename)
{
DirectoryEntry* directory;
// If not path is provided, return the root diretory.
if (filename == NULL || filename[0] == 0)
return rootDirectory;
char s[MBFS_FILENAME_LENGTH + 1];
uint8_t i = 0;
directory = rootDirectory;
while (*filename != '\0') {
if (*filename == '/') {
s[i] = '\0';
// Ensure each level of the filename is valid
if (i == 0 || i > MBFS_FILENAME_LENGTH + 1)
return NULL;
// Extract the relevant entry from the directory.
directory = getDirectoryEntry(s, directory);
// If file / directory does not exist, then there's nothing more we can do.
if (!directory)
return NULL;
i = 0;
}
else
s[i++] = *filename;
filename++;
}
return directory;
}
/**
* Refresh the physical page associated with the given block.
* Any logical blocks marked for deletion on that page are recycled.
*
* @param block the block to recycle.
* @param type One of MBFS_BLOCK_TYPE_FILE, MBFS_BLOCK_TYPE_DIRECTORY, MBFS_BLOCK_TYPE_FILETABLE.
* Erases and regenerates the given block, recycling and data marked for deletion.
* @return MICROBIT_OK on success.
*/
int MicroBitFileSystem::recycleBlock(uint16_t block, int type)
{
uint32_t *page = getPage(block);
uint32_t* scratch = getFreePage();
uint8_t *write = (uint8_t *)scratch;
uint16_t b = getBlockNumber(page);
for (int i = 0; i < PAGE_SIZE / MBFS_BLOCK_SIZE; i++)
{
// If we have an unused or deleted block, there's nothing to do - allow the block to be recycled.
if (fileSystemTable[b] == MBFS_DELETED || fileSystemTable[b] == MBFS_UNUSED)
{}
// If we have been asked to recycle a valid directory block, recycle individual entries where possible.
else if (b == block && type == MBFS_BLOCK_TYPE_DIRECTORY)
{
DirectoryEntry *direntIn = (DirectoryEntry *)getBlock(b);
DirectoryEntry *direntOut = (DirectoryEntry *)write;
for (uint16_t entry = 0; entry < MBFS_BLOCK_SIZE / sizeof(DirectoryEntry); entry++)
{
if (direntIn->flags & MBFS_DIRECTORY_ENTRY_VALID)
flash.flash_write((uint32_t *)direntOut, (uint32_t *)direntIn, sizeof(DirectoryEntry));
direntIn++;
direntOut++;
}
}
// All blocks before the root directory are the FileTable.
// Recycle any entries marked as DELETED to UNUSED.
else if (getBlock(b) < (uint32_t *)rootDirectory)
{
uint16_t *tableIn = (uint16_t *)getBlock(b);
uint16_t *tableOut = (uint16_t *)write;
for (int entry = 0; entry < MBFS_BLOCK_SIZE / 2; entry++)
{
if (*tableIn != MBFS_DELETED)
flash.flash_write(tableOut, tableIn, 2);
tableIn++;
tableOut++;
}
}
// Copy all other VALID blocks directly into the scratch page.
else
flash.flash_write(write, getBlock(b), MBFS_BLOCK_SIZE);
// move on to next block.
write += MBFS_BLOCK_SIZE;
b++;
}
// Now refresh the page originally holding the block.
flash.erase_page(page);
flash.flash_write(page, scratch, PAGE_SIZE);
flash.erase_page(scratch);
return MICROBIT_OK;
}
/**
* Refresh the physical pages associated with the file table.
* Any logical blocks marked for deletion on those pages are recycled back to UNUSED.
*
* @return MICROBIT_OK on success.
*/
int MicroBitFileSystem::recycleFileTable()
{
bool pageRecycled = false;
for (uint16_t block = 0; block < fileSystemSize; block++)
{
// if we just crossed a page boundary, reset pageRecycled.
if (block % (PAGE_SIZE / MBFS_BLOCK_SIZE) == 0)
pageRecycled = false;
if (fileSystemTable[block] == MBFS_DELETED && !pageRecycled)
{
recycleBlock(block);
pageRecycled = true;
}
}
// now, recycle the FileSystemTable itself, upcycling entries marked as DELETED to UNUSED as we go.
for (uint16_t block = 0; getPage(block) < (uint32_t *)rootDirectory; block += PAGE_SIZE / MBFS_BLOCK_SIZE)
recycleBlock(block);
return MICROBIT_OK;
}
/**
* Allocate a free DiretoryEntry in the given directory, extending and refreshing the directory block if necessary.
*
* @param directory The directory to add a DirectoryEntry to
* @return A pointer to the new DirectoryEntry for the given file, or NULL if it was not possible to allocated resources.
*/
DirectoryEntry* MicroBitFileSystem::createDirectoryEntry(DirectoryEntry *directory)
{
Directory *dir;
uint16_t block;
DirectoryEntry *dirent;
DirectoryEntry *empty = NULL;
DirectoryEntry *invalid = NULL;
// Try to find an unused entry in the directory.
block = directory->first_block;
dir = (Directory *)getBlock(block);
dirent = &dir->entry[0];
// Iterate through the directory entries until we find and unused entry, or run out of space.
while (1)
{
// Scan through each of the blocks in the directory
if ((uint32_t)(dirent+1) > (uint32_t)dir + MBFS_BLOCK_SIZE)
{
block = getNextFileBlock(block);
if (block == MBFS_EOF)
break;
dir = (Directory *)getBlock(block);
dirent = &dir->entry[0];
}
// If we find an empty slot, use that.
if (dirent->flags & MBFS_DIRECTORY_ENTRY_FREE)
{
empty = dirent;
break;
}
// Record the first invalid block we find (used, but then deleted).
if ((dirent->flags & MBFS_DIRECTORY_ENTRY_VALID) == 0 && invalid == NULL)
invalid = dirent;
// Move onto the next entry.
dirent++;
}
// Now choose the best available slot, giving preference to entries that would avoid a FLASH page erase opreation.
dirent = NULL;
// Ideally, choose an unused entry within an existing block.
if (empty)
{
dirent = empty;
}
// if not possible, try to re-use a second-hand block that has been freed. This will result in an erase operation of the block,
// but will not consume any more resources.
else if (invalid)
{
dirent = invalid;
uint16_t b = getBlockNumber(dirent);
recycleBlock(b, MBFS_BLOCK_TYPE_DIRECTORY);
}
// If nothing is available, extend the directory with a new block.
else
{
// Allocate a new logical block
uint16_t newBlock = getFreeBlock();
if (newBlock == 0)
return NULL;
// Append this to the directory
uint16_t lastBlock = directory->first_block;
while (getNextFileBlock(lastBlock) != MBFS_EOF)
lastBlock = getNextFileBlock(lastBlock);
// Append the block.
fileTableWrite(lastBlock, newBlock);
fileTableWrite(newBlock, MBFS_EOF);
dirent = (DirectoryEntry *)getBlock(newBlock);
}
return dirent;
}
/**
* Create a new DirectoryEntry with the given filename and flags.
*
* @param filename A fully or partially qualified filename.
* @param directory The directory in which to create the entry
* @param isDirectory true if the entry being created is itself a directory
*
* @return A pointer to the new DirectoryEntry for the given file, or NULL if it was not possible to allocated resources.
*/
DirectoryEntry* MicroBitFileSystem::createFile(char const * filename, DirectoryEntry *directory, bool isDirectory)
{
char const *file;
DirectoryEntry *dirent;
// Determine the filename from the (potentially) fully qualified filename.
file = filename + strlen(filename);
while (file >= filename && *file != '/')
file--;
file++;
// Allocate a directory entry for our new file.
dirent = createDirectoryEntry(directory);
if (dirent == NULL)
return NULL;
// Create a new block to represent the file.
uint16_t newBlock = getFreeBlock();
if (newBlock == 0)
return NULL;
// Populate our assigned Directory Entry.
DirectoryEntry d;
strcpy(d.file_name, file);
d.first_block = newBlock;
if (isDirectory)
{
// Mark as a directory, and set a zero length (special case for directories, to minimize unecessary FLASH erases).
d.flags = MBFS_DIRECTORY_ENTRY_VALID | MBFS_DIRECTORY_ENTRY_DIRECTORY;
d.length = 0;
}
else
{
// We leave the file size as unwritten for regular files - pending a possible forthcoming write/close operation.
d.flags = MBFS_DIRECTORY_ENTRY_NEW;
d.length = 0xffffffff;
}
// Push the new data back to FLASH memory
flash.flash_write(dirent, &d, sizeof(DirectoryEntry));
fileTableWrite(d.first_block, MBFS_EOF);
return dirent;
}
/**
* Searches the list of open files for one with the given identifier.
*
* @param fd A previsouly opened file identifier, as returned by open().
* @param remove Remove the file descriptor from the list if true.
* @return A FileDescriptor matching the given ID, or NULL if the file is not open.
*/
FileDescriptor* MicroBitFileSystem::getFileDescriptor(int fd, bool remove)
{
FileDescriptor *file = openFiles;
FileDescriptor *prev = NULL;
while (file)
{
if (file->id == fd)
{
if (remove)
{
if (prev)
prev->next = file->next;
else
openFiles = file->next;
}
return file;
}
prev = file;
file = file->next;
}
return NULL;
}
/**
* Creates a new directory with the given name and location
*
* @param name The fully qualified name of the new directory.
* @return MICROBIT_OK on success, MICROBIT_INVALID_PARAMETER if the path is invalid, or MICROBT_NO_RESOURCES if the FileSystem is full.
*/
int MicroBitFileSystem::createDirectory(char const *name)
{
DirectoryEntry* directory; // Directory holding this file.
DirectoryEntry* dirent; // Entry in the direcoty of this file.
// Protect against accidental re-initialisation
if ((status & MBFS_STATUS_INITIALISED) == 0)
return MICROBIT_NOT_SUPPORTED;
// Reject invalid filenames.
if (!isValidFilename(name))
return MICROBIT_INVALID_PARAMETER;
// Determine the directory for this file.
directory = getDirectoryOf(name);
if (directory == NULL)
return MICROBIT_INVALID_PARAMETER;
// Find the DirectoryEntry associated with the given name (if it exists).
// We don't permit files or directories with the same name.
dirent = getDirectoryEntry(name, directory);
if (dirent)
return MICROBIT_INVALID_PARAMETER;
dirent = createFile(name, directory, true);
if (dirent == NULL)
return MICROBIT_NO_RESOURCES;
return MICROBIT_OK;
}
/**
* Open a new file, and obtain a new file handle (int) to
* read/write/seek the file. The flags are:
* - MB_READ : read from the file.
* - MB_WRITE : write to the file.
* - MB_CREAT : create a new file, if it doesn't already exist.
*
* If a file is opened that doesn't exist, and MB_CREAT isn't passed,
* an error is returned, otherwise the file is created.
*
* @param filename name of the file to open, must contain only printable characters.
* @param flags One or more of MB_READ, MB_WRITE or MB_CREAT.
* @return return the file handle,MICROBIT_NOT_SUPPORTED if the file system has
* not been initialised MICROBIT_INVALID_PARAMETER if the filename is
* too large, MICROBIT_NO_RESOURCES if the file system is full.
*
* @code
* MicroBitFileSystem f();
* int fd = f.open("test.txt", MB_WRITE|MB_CREAT);
* if(fd<0)
* print("file open error");
* @endcode
*/
int MicroBitFileSystem::open(char const * filename, uint32_t flags)
{
FileDescriptor *file; // File Descriptor of this file.
DirectoryEntry* directory; // Directory holding this file.
DirectoryEntry* dirent; // Entry in the direcoty of this file.
int id; // FileDescriptor id to be return to the caller.
// Protect against accidental re-initialisation
if ((status & MBFS_STATUS_INITIALISED) == 0)
return MICROBIT_NOT_SUPPORTED;
// Reject invalid filenames.
if(!isValidFilename(filename))
return MICROBIT_INVALID_PARAMETER;
// Determine the directory for this file.
directory = getDirectoryOf(filename);
if (directory == NULL)
return MICROBIT_INVALID_PARAMETER;
// Find the DirectoryEntry assoviate with the given file (if it exists).
dirent = getDirectoryEntry(filename, directory);
// Only permit files to be opened once...
// also, detemrine a valid ID for this open file as we go.
file = openFiles;
id = 0;
while (file && dirent)
{
if (file->dirent == dirent)
return MICROBIT_NOT_SUPPORTED;
if (file->id == id)
{
id++;
file = openFiles;
continue;
}
file = file->next;
}
if (dirent == NULL)
{
// If the file doesn't exist, and we haven't been asked to create it, then there's nothing we can do.
if (!(flags & MB_CREAT))
return MICROBIT_INVALID_PARAMETER;
dirent = createFile(filename, directory, false);
if (dirent == NULL)
return MICROBIT_NO_RESOURCES;
}
// Try to add a new FileDescriptor into this directory.
file = new FileDescriptor;
if (file == NULL)
return MICROBIT_NO_RESOURCES;
// Populate the FileDescriptor
file->flags = (flags & ~(MB_CREAT));
file->id = id;
file->length = dirent->flags == MBFS_DIRECTORY_ENTRY_NEW ? 0 : dirent->length;
file->seek = (flags & MB_APPEND) ? file->length : 0;
file->dirent = dirent;
file->directory = directory;
file->cacheLength = 0;
// Add the file descriptor to the chain of open files.
file->next = openFiles;
openFiles = file;
// Return the FileDescriptor id to the user
return file->id;
}
/**
* Writes back all state associated with the given file to FLASH memory,
* leaving the file open.
*
* @param fd file descriptor - obtained with open().
* @return MICROBIT_OK on success, MICROBIT_NOT_SUPPORTED if the file system has not
* been initialised, MICROBIT_INVALID_PARAMETER if the given file handle
* is invalid.
*
* @code
* MicroBitFileSystem f();
* int fd = f.open("test.txt", MB_READ);
*
* ...
*
* f.flush(fd);
* @endcode
*/
int MicroBitFileSystem::flush(int fd)
{
// Protect against accidental re-initialisation
if ((status & MBFS_STATUS_INITIALISED) == 0)
return MICROBIT_NOT_SUPPORTED;
FileDescriptor *file = getFileDescriptor(fd);
// Ensure the file is open.
if(file == NULL)
return MICROBIT_INVALID_PARAMETER;
// Flush any data in the writeback cache.
writeBack(file);
// If the file has changed size, create an updated directory entry for the file, reflecting it's new length.
if (file->dirent->length != file->length)
{
DirectoryEntry d = *file->dirent;
d.length = file->length;
// Do some optimising to reduce FLASH churn if this is the first write to a file. No need then to create a new dirent...
if (file->dirent->flags == MBFS_DIRECTORY_ENTRY_NEW)
{
d.flags = MBFS_DIRECTORY_ENTRY_VALID;
flash.flash_write(file->dirent, &d, sizeof(DirectoryEntry));
}
// Otherwise, replace the dirent with a freshly allocated one, and mark the other as INVALID.
else
{
DirectoryEntry *newDirent;
uint16_t value = MBFS_DELETED;
// invalidate the old directory entry and create a new one with the updated data.
flash.flash_write(&file->dirent->flags, &value, 2);
newDirent = createDirectoryEntry(file->directory);
flash.flash_write(newDirent, &d, sizeof(DirectoryEntry));
}
}
return MICROBIT_OK;
}
/**
* Close the specified file handle.
* File handle resources are then made available for future open() calls.
*
* close() must be called at some point to ensure the filesize in the
* FT is synced with the cached value in the FD.
*
* @warning if close() is not called, the FT may not be correct,
* leading to data loss.
*
* @param fd file descriptor - obtained with open().
* @return MICROBIT_OK on success, MICROBIT_NOT_SUPPORTED if the file system has not
* been initialised, MICROBIT_INVALID_PARAMETER if the given file handle
* is invalid.
*
* @code
* MicroBitFileSystem f();
* int fd = f.open("test.txt", MB_READ);
* if(!f.close(fd))
* print("error closing file.");
* @endcode
*/
int MicroBitFileSystem::close(int fd)
{
// Firstly, ensure all unwritten data is flushed.
int r = flush(fd);
// If the flush called failed on validation, pass the error code onto the caller.
if (r != MICROBIT_OK)
return r;
// Remove the file descriptor from the list of open files, and free it.
// n.b. we know this is safe, as flush() validates this.
delete getFileDescriptor(fd, true);
return MICROBIT_OK;
}
/**
* Move the current position of a file handle, to be used for
* subsequent read/write calls.
*
* The offset modifier can be:
* - MB_SEEK_SET set the absolute seek position.
* - MB_SEEK_CUR set the seek position based on the current offset.
* - MB_SEEK_END set the seek position from the end of the file.
* E.g. to seek to 2nd-to-last byte, use offset=-1.
*
* @param fd file handle, obtained with open()
* @param offset new offset, can be positive/negative.
* @param flags
* @return new offset position on success, MICROBIT_NOT_SUPPORTED if the file system
* is not intiialised, MICROBIT_INVALID_PARAMETER if the flag given is invalid
* or the file handle is invalid.
*
* @code
* MicroBitFileSystem f;
* int fd = f.open("test.txt", MB_READ);
* f.seek(fd, -100, MB_SEEK_END); //100 bytes before end of file.
* @endcode
*/