-
-
Notifications
You must be signed in to change notification settings - Fork 94
/
esp_littlefs.c
2153 lines (1876 loc) · 65.3 KB
/
esp_littlefs.c
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
/**
* @file esp_littlefs.c
* @brief Maps LittleFS <-> ESP_VFS
* @author Brian Pugh
*/
#ifndef LOG_LOCAL_LEVEL
#define LOG_LOCAL_LEVEL CONFIG_LOG_DEFAULT_LEVEL
#endif // LOG_LOCAL_LEVEL
#include "esp_littlefs.h"
#include "littlefs/lfs.h"
#include "sdkconfig.h"
#include "esp_log.h"
#include "esp_system.h"
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "freertos/task.h"
#include "littlefs_api.h"
#include <sys/dirent.h>
#include <sys/errno.h>
#include <sys/fcntl.h>
#include <sys/lock.h>
#include <sys/param.h>
#include <unistd.h>
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
#include "spi_flash_mmap.h"
#else
#include "esp_spi_flash.h"
#endif
#if CONFIG_IDF_TARGET_ESP32
#include "esp32/rom/spi_flash.h"
#elif CONFIG_IDF_TARGET_ESP32S2
#include "esp32s2/rom/spi_flash.h"
#elif CONFIG_IDF_TARGET_ESP32S3
#include "esp32s3/rom/spi_flash.h"
#elif CONFIG_IDF_TARGET_ESP32C3
#include "esp32c3/rom/spi_flash.h"
#elif CONFIG_IDF_TARGET_ESP32H2
#include "esp32h2/rom/spi_flash.h"
#elif CONFIG_IDF_TARGET_ESP8684
#include "esp8684/rom/spi_flash.h"
#elif __has_include("esp32/rom/spi_flash.h")
#include "esp32/rom/spi_flash.h" //IDF 4
#else
#include "rom/spi_flash.h" //IDF 3
#endif
#define CONFIG_LITTLEFS_BLOCK_SIZE 4096 /* ESP32 can only operate at 4kb */
/* File Descriptor Caching Params */
#define CONFIG_LITTLEFS_FD_CACHE_REALLOC_FACTOR 2 /* Amount to resize FD cache by */
#define CONFIG_LITTLEFS_FD_CACHE_MIN_SIZE 4 /* Minimum size of FD cache */
#define CONFIG_LITTLEFS_FD_CACHE_HYST 4 /* When shrinking, leave this many trailing FD slots available */
/**
* @brief Last Modified Time
*
* Use 't' for LITTLEFS_ATTR_MTIME to match example:
* https://github.com/ARMmbed/littlefs/issues/23#issuecomment-482293539
* And to match other external tools such as:
* https://github.com/earlephilhower/mklittlefs
*/
#define LITTLEFS_ATTR_MTIME ((uint8_t) 't')
/**
* @brief littlefs DIR structure
*/
typedef struct {
DIR dir; /*!< VFS DIR struct */
lfs_dir_t d; /*!< littlefs DIR struct */
struct dirent e; /*!< Last open dirent */
long offset; /*!< Offset of the current dirent */
char *path; /*!< Requested directory name */
} vfs_littlefs_dir_t;
static int vfs_littlefs_open(void* ctx, const char * path, int flags, int mode);
static ssize_t vfs_littlefs_write(void* ctx, int fd, const void * data, size_t size);
static ssize_t vfs_littlefs_read(void* ctx, int fd, void * dst, size_t size);
static ssize_t vfs_littlefs_pwrite(void *ctx, int fd, const void *src, size_t size, off_t offset);
static ssize_t vfs_littlefs_pread(void *ctx, int fd, void *dst, size_t size, off_t offset);
static int vfs_littlefs_close(void* ctx, int fd);
static off_t vfs_littlefs_lseek(void* ctx, int fd, off_t offset, int mode);
static int vfs_littlefs_fsync(void* ctx, int fd);
static esp_vfs_t vfs_littlefs_create_struct(bool writeable);
#ifdef CONFIG_VFS_SUPPORT_DIR
static int vfs_littlefs_stat(void* ctx, const char * path, struct stat * st);
static int vfs_littlefs_unlink(void* ctx, const char *path);
static int vfs_littlefs_rename(void* ctx, const char *src, const char *dst);
static DIR* vfs_littlefs_opendir(void* ctx, const char* name);
static int vfs_littlefs_closedir(void* ctx, DIR* pdir);
static struct dirent* vfs_littlefs_readdir(void* ctx, DIR* pdir);
static int vfs_littlefs_readdir_r(void* ctx, DIR* pdir,
struct dirent* entry, struct dirent** out_dirent);
static long vfs_littlefs_telldir(void* ctx, DIR* pdir);
static void vfs_littlefs_seekdir(void* ctx, DIR* pdir, long offset);
static int vfs_littlefs_mkdir(void* ctx, const char* name, mode_t mode);
static int vfs_littlefs_rmdir(void* ctx, const char* name);
static ssize_t vfs_littlefs_truncate( void *ctx, const char *path, off_t size);
#ifdef ESP_LITTLEFS_ENABLE_FTRUNCATE
static int vfs_littlefs_ftruncate(void *ctx, int fd, off_t size);
#endif // ESP_LITTLEFS_ENABLE_FTRUNCATE
static void esp_littlefs_dir_free(vfs_littlefs_dir_t *dir);
#endif
static void esp_littlefs_take_efs_lock(void);
static esp_err_t esp_littlefs_init_efs(esp_littlefs_t** efs, const esp_partition_t* partition, bool read_only);
static esp_err_t esp_littlefs_init(const esp_vfs_littlefs_conf_t* conf);
static esp_err_t esp_littlefs_by_label(const char* label, int * index);
static esp_err_t esp_littlefs_by_partition(const esp_partition_t* part, int*index);
static esp_err_t esp_littlefs_get_empty(int *index);
static void esp_littlefs_free(esp_littlefs_t ** efs);
static int esp_littlefs_flags_conv(int m);
#if CONFIG_LITTLEFS_USE_MTIME
static int vfs_littlefs_utime(void *ctx, const char *path, const struct utimbuf *times);
static void vfs_littlefs_update_mtime(esp_littlefs_t *efs, const char *path);
static int vfs_littlefs_update_mtime_value(esp_littlefs_t *efs, const char *path, time_t t);
static time_t vfs_littlefs_get_mtime(esp_littlefs_t *efs, const char *path);
#endif
#ifndef CONFIG_LITTLEFS_USE_ONLY_HASH
/* The only way in LittleFS to get info is via a path (lfs_stat), so it cannot
* be done if the path isn't stored. */
static int vfs_littlefs_fstat(void* ctx, int fd, struct stat * st);
#endif
#if CONFIG_LITTLEFS_SPIFFS_COMPAT
static void mkdirs(esp_littlefs_t * efs, const char *dir);
static void rmdirs(esp_littlefs_t * efs, const char *dir);
#endif // CONFIG_LITTLEFS_SPIFFS_COMPAT
static int vfs_littlefs_fcntl(void* ctx, int fd, int cmd, int arg);
static int sem_take(esp_littlefs_t *efs);
static int sem_give(esp_littlefs_t *efs);
static esp_err_t format_from_efs(esp_littlefs_t *efs);
static void get_total_and_used_bytes(esp_littlefs_t *efs, size_t *total_bytes, size_t *used_bytes);
static SemaphoreHandle_t _efs_lock = NULL;
static esp_littlefs_t * _efs[CONFIG_LITTLEFS_MAX_PARTITIONS] = { 0 };
/********************
* Helper Functions *
********************/
#if CONFIG_LITTLEFS_HUMAN_READABLE
/**
* @brief converts an enumerated lfs error into a string.
* @param lfs_errno The enumerated littlefs error.
*/
static const char * esp_littlefs_errno(enum lfs_error lfs_errno);
#endif
static void esp_littlefs_free_fds(esp_littlefs_t * efs) {
/* Need to free all files that were opened */
while (efs->file) {
vfs_littlefs_file_t * next = efs->file->next;
free(efs->file);
efs->file = next;
}
free(efs->cache);
efs->cache = 0;
efs->cache_size = efs->fd_count = 0;
}
static int lfs_errno_remap(enum lfs_error err) {
switch(err){
case LFS_ERR_OK: return 0;
case LFS_ERR_IO: return EIO;
case LFS_ERR_CORRUPT: return EBADMSG; // This is a bit opinionated.
case LFS_ERR_NOENT: return ENOENT;
case LFS_ERR_EXIST: return EEXIST;
case LFS_ERR_NOTDIR: return ENOTDIR;
case LFS_ERR_ISDIR: return EISDIR;
case LFS_ERR_NOTEMPTY: return ENOTEMPTY;
case LFS_ERR_BADF: return EBADF;
case LFS_ERR_FBIG: return EFBIG;
case LFS_ERR_INVAL: return EINVAL;
case LFS_ERR_NOSPC: return ENOSPC;
case LFS_ERR_NOMEM: return ENOMEM;
case LFS_ERR_NOATTR: return ENODATA;
case LFS_ERR_NAMETOOLONG: return ENAMETOOLONG;
}
return EINVAL; // Need some default vlaue
}
esp_err_t format_from_efs(esp_littlefs_t *efs)
{
assert( efs );
bool was_mounted = false;
/* Unmount if mounted */
if(efs->cache_size > 0){
int res;
ESP_LOGV(ESP_LITTLEFS_TAG, "Partition was mounted. Unmounting...");
was_mounted = true;
res = lfs_unmount(efs->fs);
if(res != LFS_ERR_OK){
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to unmount.");
return ESP_FAIL;
}
esp_littlefs_free_fds(efs);
}
/* Format */
{
int res;
ESP_LOGV(ESP_LITTLEFS_TAG, "Formatting filesystem");
res = lfs_format(efs->fs, &efs->cfg);
if( res != LFS_ERR_OK ) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to format filesystem");
return ESP_FAIL;
}
}
/* Mount filesystem */
if( was_mounted ) {
int res;
/* Remount the partition */
ESP_LOGV(ESP_LITTLEFS_TAG, "Remounting formatted partition");
res = lfs_mount(efs->fs, &efs->cfg);
if( res != LFS_ERR_OK ) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to re-mount filesystem");
return ESP_FAIL;
}
efs->cache_size = CONFIG_LITTLEFS_FD_CACHE_MIN_SIZE; // Initial size of cache; will resize ondemand
efs->cache = calloc(sizeof(*efs->cache), efs->cache_size);
}
ESP_LOGV(ESP_LITTLEFS_TAG, "Format Success!");
return ESP_OK;
}
void get_total_and_used_bytes(esp_littlefs_t *efs, size_t *total_bytes, size_t *used_bytes) {
size_t total_bytes_local = efs->cfg.block_size * efs->cfg.block_count;
if(total_bytes) *total_bytes = total_bytes_local;
/* lfs_fs_size may return a size larger than the actual filesystem size.
* https://github.com/littlefs-project/littlefs/blob/9c7e232086f865cff0bb96fe753deb66431d91fd/lfs.h#L658
*/
sem_take(efs);
if(used_bytes) *used_bytes = MIN(total_bytes_local, efs->cfg.block_size * lfs_fs_size(efs->fs));
sem_give(efs);
}
/********************
* Public Functions *
********************/
bool esp_littlefs_mounted(const char* partition_label) {
int index;
esp_err_t err;
err = esp_littlefs_by_label(partition_label, &index);
if(err != ESP_OK) return false;
return _efs[index]->cache_size > 0;
}
bool esp_littlefs_partition_mounted(const esp_partition_t* partition) {
int index;
esp_err_t err = esp_littlefs_by_partition(partition, &index);
if(err != ESP_OK) return false;
return _efs[index]->cache_size > 0;
}
esp_err_t esp_littlefs_info(const char* partition_label, size_t *total_bytes, size_t *used_bytes){
int index;
esp_err_t err;
err = esp_littlefs_by_label(partition_label, &index);
if(err != ESP_OK) return err;
get_total_and_used_bytes(_efs[index], total_bytes, used_bytes);
return ESP_OK;
}
esp_err_t esp_littlefs_partition_info(const esp_partition_t* partition, size_t *total_bytes, size_t *used_bytes){
int index;
esp_err_t err;
err = esp_littlefs_by_partition(partition, &index);
if(err != ESP_OK) return err;
get_total_and_used_bytes(_efs[index], total_bytes, used_bytes);
return ESP_OK;
}
esp_err_t esp_vfs_littlefs_register(const esp_vfs_littlefs_conf_t * conf)
{
assert(conf->base_path);
const esp_vfs_t vfs = vfs_littlefs_create_struct(!conf->read_only);
esp_err_t err = esp_littlefs_init(conf);
if (err != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to initialize LittleFS");
return err;
}
int index;
if(conf->partition_label)
{
if (esp_littlefs_by_label(conf->partition_label, &index) != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Unable to find partition \"%s\"", conf->partition_label);
return ESP_ERR_NOT_FOUND;
}
} else {
if (esp_littlefs_by_partition(conf->partition, &index) != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Unable to find partition \"0x%08"PRIX32"\"", conf->partition->address);
return ESP_ERR_NOT_FOUND;
}
}
strlcat(_efs[index]->base_path, conf->base_path, ESP_VFS_PATH_MAX + 1);
err = esp_vfs_register(conf->base_path, &vfs, _efs[index]);
if (err != ESP_OK) {
esp_littlefs_free(&_efs[index]);
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to register Littlefs to \"%s\"", conf->base_path);
return err;
}
ESP_LOGV(ESP_LITTLEFS_TAG, "Successfully registered LittleFS to \"%s\"", conf->base_path);
return ESP_OK;
}
esp_err_t esp_vfs_littlefs_unregister(const char* partition_label)
{
assert(partition_label);
int index;
if (esp_littlefs_by_label(partition_label, &index) != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Partition was never registered.");
return ESP_ERR_INVALID_STATE;
}
ESP_LOGV(ESP_LITTLEFS_TAG, "Unregistering \"%s\"", partition_label);
esp_err_t err = esp_vfs_unregister(_efs[index]->base_path);
if (err != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to unregister \"%s\"", partition_label);
return err;
}
esp_littlefs_free(&_efs[index]);
_efs[index] = NULL;
return ESP_OK;
}
esp_err_t esp_vfs_littlefs_unregister_partition(const esp_partition_t* partition) {
assert(partition);
int index;
if (esp_littlefs_by_partition(partition, &index) != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Partition was never registered.");
return ESP_ERR_INVALID_STATE;
}
ESP_LOGV(ESP_LITTLEFS_TAG, "Unregistering \"0x%08"PRIX32"\"", partition->address);
esp_err_t err = esp_vfs_unregister(_efs[index]->base_path);
if (err != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to unregister \"0x%08"PRIX32"\"", partition->address);
return err;
}
esp_littlefs_free(&_efs[index]);
_efs[index] = NULL;
return ESP_OK;
}
esp_err_t esp_littlefs_format(const char* partition_label) {
assert( partition_label );
bool efs_free = false;
int index = -1;
esp_err_t err;
ESP_LOGV(ESP_LITTLEFS_TAG, "Formatting \"%s\"", partition_label);
/* Get a context */
err = esp_littlefs_by_label(partition_label, &index);
if( err != ESP_OK ){
/* Create a tmp context */
ESP_LOGV(ESP_LITTLEFS_TAG, "Temporarily creating EFS context.");
efs_free = true;
const esp_vfs_littlefs_conf_t conf = {
/* base_name not necessary for initializing */
.dont_mount = true,
.partition_label = partition_label,
};
err = esp_littlefs_init(&conf); /* Internally MIGHT call esp_littlefs_format */
if( err != ESP_OK ) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to initialize to format.");
goto exit;
}
err = esp_littlefs_by_label(partition_label, &index);
if ( err != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Error obtaining context.");
goto exit;
}
}
err = format_from_efs(_efs[index]);
exit:
if(efs_free && index>=0) esp_littlefs_free(&_efs[index]);
return err;
}
esp_err_t esp_littlefs_format_partition(const esp_partition_t* partition) {
assert( partition );
bool efs_free = false;
int index = -1;
esp_err_t err;
ESP_LOGV(ESP_LITTLEFS_TAG, "Formatting partition at \"0x%08"PRIX32"\"", partition->address);
/* Get a context */
err = esp_littlefs_by_partition(partition, &index);
if( err != ESP_OK ){
/* Create a tmp context */
ESP_LOGV(ESP_LITTLEFS_TAG, "Temporarily creating EFS context.");
efs_free = true;
const esp_vfs_littlefs_conf_t conf = {
/* base_name not necessary for initializing */
.dont_mount = true,
.partition_label = NULL,
.partition = partition,
};
err = esp_littlefs_init(&conf); /* Internally MIGHT call esp_littlefs_format */
if( err != ESP_OK ) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Failed to initialize to format.");
goto exit;
}
err = esp_littlefs_by_partition(partition, &index);
if ( err != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Error obtaining context.");
goto exit;
}
}
err = format_from_efs(_efs[index]);
exit:
if(efs_free && index>=0) esp_littlefs_free(&_efs[index]);
return err;
}
/********************
* Static Functions *
********************/
/*** Helpers ***/
#if CONFIG_LITTLEFS_HUMAN_READABLE
/**
* @brief converts an enumerated lfs error into a string.
* @param lfs_error The littlefs error.
*/
static const char * esp_littlefs_errno(enum lfs_error lfs_errno) {
switch(lfs_errno){
case LFS_ERR_OK: return "LFS_ERR_OK";
case LFS_ERR_IO: return "LFS_ERR_IO";
case LFS_ERR_CORRUPT: return "LFS_ERR_CORRUPT";
case LFS_ERR_NOENT: return "LFS_ERR_NOENT";
case LFS_ERR_EXIST: return "LFS_ERR_EXIST";
case LFS_ERR_NOTDIR: return "LFS_ERR_NOTDIR";
case LFS_ERR_ISDIR: return "LFS_ERR_ISDIR";
case LFS_ERR_NOTEMPTY: return "LFS_ERR_NOTEMPTY";
case LFS_ERR_BADF: return "LFS_ERR_BADF";
case LFS_ERR_FBIG: return "LFS_ERR_FBIG";
case LFS_ERR_INVAL: return "LFS_ERR_INVAL";
case LFS_ERR_NOSPC: return "LFS_ERR_NOSPC";
case LFS_ERR_NOMEM: return "LFS_ERR_NOMEM";
case LFS_ERR_NOATTR: return "LFS_ERR_NOATTR";
case LFS_ERR_NAMETOOLONG: return "LFS_ERR_NAMETOOLONG";
default: return "LFS_ERR_UNDEFINED";
}
return "";
}
#else
#define esp_littlefs_errno(x) ""
#endif
static esp_vfs_t vfs_littlefs_create_struct(bool writeable) {
esp_vfs_t vfs = {
.flags = ESP_VFS_FLAG_CONTEXT_PTR,
.write_p = &vfs_littlefs_write,
.pwrite_p = &vfs_littlefs_pwrite,
.lseek_p = &vfs_littlefs_lseek,
.read_p = &vfs_littlefs_read,
.pread_p = &vfs_littlefs_pread,
.open_p = &vfs_littlefs_open,
.close_p = &vfs_littlefs_close,
.fsync_p = &vfs_littlefs_fsync,
.fcntl_p = &vfs_littlefs_fcntl,
#ifndef CONFIG_LITTLEFS_USE_ONLY_HASH
.fstat_p = &vfs_littlefs_fstat,
#endif
#ifdef CONFIG_VFS_SUPPORT_DIR
.stat_p = &vfs_littlefs_stat,
.link_p = NULL, /* Not Supported */
.unlink_p = &vfs_littlefs_unlink,
.rename_p = &vfs_littlefs_rename,
.opendir_p = &vfs_littlefs_opendir,
.readdir_p = &vfs_littlefs_readdir,
.readdir_r_p = &vfs_littlefs_readdir_r,
.telldir_p = &vfs_littlefs_telldir,
.seekdir_p = &vfs_littlefs_seekdir,
.closedir_p = &vfs_littlefs_closedir,
.mkdir_p = &vfs_littlefs_mkdir,
.rmdir_p = &vfs_littlefs_rmdir,
// access_p
.truncate_p = &vfs_littlefs_truncate,
#ifdef ESP_LITTLEFS_ENABLE_FTRUNCATE
.ftruncate_p = &vfs_littlefs_ftruncate,
#endif // ESP_LITTLEFS_ENABLE_FTRUNCATE
#if CONFIG_LITTLEFS_USE_MTIME
.utime_p = &vfs_littlefs_utime,
#endif // CONFIG_LITTLEFS_USE_MTIME
#endif // CONFIG_VFS_SUPPORT_DIR
};
if(!writeable) {
vfs.write_p = NULL;
vfs.pwrite_p = NULL;
vfs.fsync_p = NULL;
vfs.link_p = NULL;
vfs.unlink_p = NULL;
vfs.rename_p = NULL;
vfs.mkdir_p = NULL;
vfs.rmdir_p = NULL;
}
return vfs;
}
/**
* @brief Free and clear a littlefs definition structure.
* @param efs Pointer to pointer to struct. Done this way so we can also zero
* out the pointer.
*/
static void esp_littlefs_free(esp_littlefs_t ** efs)
{
esp_littlefs_t * e = *efs;
if (e == NULL) return;
*efs = NULL;
if (e->fs) {
if(e->cache_size > 0) lfs_unmount(e->fs);
free(e->fs);
}
if(e->lock) vSemaphoreDelete(e->lock);
esp_littlefs_free_fds(e);
free(e);
}
#ifdef CONFIG_VFS_SUPPORT_DIR
/**
* @brief Free a vfs_littlefs_dir_t struct.
*/
static void esp_littlefs_dir_free(vfs_littlefs_dir_t *dir){
if(dir == NULL) return;
if(dir->path) free(dir->path);
free(dir);
}
#endif
/**
* Get a mounted littlefs filesystem by label.
* @param[in] label
* @param[out] index index into _efs
* @return ESP_OK on success
*/
static esp_err_t esp_littlefs_by_partition(const esp_partition_t* part, int * index){
int i;
esp_littlefs_t * p;
if(!part || !index) return ESP_ERR_INVALID_ARG;
ESP_LOGV(ESP_LITTLEFS_TAG, "Searching for existing filesystem for partition \"0x%08"PRIX32"\"", part->address);
for (i = 0; i < CONFIG_LITTLEFS_MAX_PARTITIONS; i++) {
p = _efs[i];
if (p) {
if (part->address == p->partition->address) {
*index = i;
ESP_LOGV(ESP_LITTLEFS_TAG, "Found existing filesystem \"0x%08"PRIX32"\" at index %d", part->address, *index);
return ESP_OK;
}
}
}
ESP_LOGV(ESP_LITTLEFS_TAG, "Existing filesystem \"0x%08"PRIX32"\" not found", part->address);
return ESP_ERR_NOT_FOUND;
}
static esp_err_t esp_littlefs_by_label(const char* label, int * index){
int i;
esp_littlefs_t * p;
if(!label || !index) return ESP_ERR_INVALID_ARG;
ESP_LOGV(ESP_LITTLEFS_TAG, "Searching for existing filesystem for partition \"%s\"", label);
for (i = 0; i < CONFIG_LITTLEFS_MAX_PARTITIONS; i++) {
p = _efs[i];
if (p) {
if (strncmp(label, p->partition->label, 17) == 0) {
*index = i;
ESP_LOGV(ESP_LITTLEFS_TAG, "Found existing filesystem \"%s\" at index %d", label, *index);
return ESP_OK;
}
}
}
ESP_LOGV(ESP_LITTLEFS_TAG, "Existing filesystem \"%s\" not found", label);
return ESP_ERR_NOT_FOUND;
}
/**
* @brief Get the index of an unallocated LittleFS slot.
* @param[out] index Indexd of free LittleFS slot
* @return ESP_OK on success
*/
static esp_err_t esp_littlefs_get_empty(int *index) {
assert(index);
for(uint8_t i=0; i < CONFIG_LITTLEFS_MAX_PARTITIONS; i++){
if( _efs[i] == NULL ){
*index = i;
return ESP_OK;
}
}
ESP_LOGE(ESP_LITTLEFS_TAG, "No more free partitions available.");
return ESP_FAIL;
}
/**
* @brief Convert fcntl flags to littlefs flags
* @param m fcntl flags
* @return lfs flags
*/
static int esp_littlefs_flags_conv(int m) {
int lfs_flags = 0;
// Mask out unsupported flags; can cause internal LFS issues.
m &= (O_APPEND | O_RDONLY | O_WRONLY | O_RDWR | O_EXCL | O_CREAT | O_TRUNC);
if (m == O_APPEND) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_APPEND"); lfs_flags |= LFS_O_APPEND;}
if (m == O_RDONLY) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_RDONLY"); lfs_flags |= LFS_O_RDONLY;}
if (m & O_WRONLY) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_WRONLY"); lfs_flags |= LFS_O_WRONLY;}
if (m & O_RDWR) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_RDWR"); lfs_flags |= LFS_O_RDWR;}
if (m & O_EXCL) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_EXCL"); lfs_flags |= LFS_O_EXCL;}
if (m & O_CREAT) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_CREAT"); lfs_flags |= LFS_O_CREAT;}
if (m & O_TRUNC) {ESP_LOGV(ESP_LITTLEFS_TAG, "O_TRUNC"); lfs_flags |= LFS_O_TRUNC;}
return lfs_flags;
}
static void esp_littlefs_take_efs_lock(void) {
if( _efs_lock == NULL ){
static portMUX_TYPE mux = portMUX_INITIALIZER_UNLOCKED;
portENTER_CRITICAL(&mux);
if( _efs_lock == NULL ){
_efs_lock = xSemaphoreCreateMutex();
assert(_efs_lock);
}
portEXIT_CRITICAL(&mux);
}
xSemaphoreTake(_efs_lock, portMAX_DELAY);
}
static esp_err_t esp_littlefs_init_efs(esp_littlefs_t** efs, const esp_partition_t* partition, bool read_only)
{
/* Allocate Context */
*efs = calloc(1, sizeof(esp_littlefs_t));
if (efs == NULL) {
ESP_LOGE(ESP_LITTLEFS_TAG, "esp_littlefs could not be malloced");
return ESP_ERR_NO_MEM;
}
(*efs)->partition = partition;
{ /* LittleFS Configuration */
(*efs)->cfg.context = *efs;
(*efs)->read_only = read_only;
// block device operations
(*efs)->cfg.read = littlefs_api_read;
(*efs)->cfg.prog = littlefs_api_prog;
(*efs)->cfg.erase = littlefs_api_erase;
(*efs)->cfg.sync = littlefs_api_sync;
// block device configuration
(*efs)->cfg.read_size = CONFIG_LITTLEFS_READ_SIZE;
(*efs)->cfg.prog_size = CONFIG_LITTLEFS_WRITE_SIZE;
(*efs)->cfg.block_size = CONFIG_LITTLEFS_BLOCK_SIZE;;
(*efs)->cfg.block_count = (*efs)->partition->size / (*efs)->cfg.block_size;
(*efs)->cfg.cache_size = CONFIG_LITTLEFS_CACHE_SIZE;
(*efs)->cfg.lookahead_size = CONFIG_LITTLEFS_LOOKAHEAD_SIZE;
(*efs)->cfg.block_cycles = CONFIG_LITTLEFS_BLOCK_CYCLES;
#if CONFIG_LITTLEFS_MULTIVERSION
#if CONFIG_LITTLEFS_DISK_VERSION_MOST_RECENT
(*efs)->cfg.disk_version = 0;
#elif CONFIG_LITTLEFS_DISK_VERSION_2_1
(*efs)->cfg.disk_version = 0x00020001;
#elif CONFIG_LITTLEFS_DISK_VERSION_2_0
(*efs)->cfg.disk_version = 0x00020000;
#else
#error "CONFIG_LITTLEFS_MULTIVERSION enabled but no or unknown disk version selected!"
#endif
#endif
}
(*efs)->lock = xSemaphoreCreateRecursiveMutex();
if ((*efs)->lock == NULL) {
ESP_LOGE(ESP_LITTLEFS_TAG, "mutex lock could not be created");
return ESP_ERR_NO_MEM;
}
(*efs)->fs = calloc(1, sizeof(lfs_t));
if ((*efs)->fs == NULL) {
ESP_LOGE(ESP_LITTLEFS_TAG, "littlefs could not be malloced");
return ESP_ERR_NO_MEM;
}
return ESP_OK;
}
/**
* @brief Initialize and mount littlefs
* @param[in] conf Filesystem Configuration
* @return ESP_OK on success
*/
static esp_err_t esp_littlefs_init(const esp_vfs_littlefs_conf_t* conf)
{
int index = -1;
esp_err_t err = ESP_FAIL;
const esp_partition_t* partition = NULL;
esp_littlefs_t * efs = NULL;
esp_littlefs_take_efs_lock();
if (esp_littlefs_get_empty(&index) != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "max mounted partitions reached");
err = ESP_ERR_INVALID_STATE;
goto exit;
}
if(conf->partition_label)
{
/* Input and Environment Validation */
if (esp_littlefs_by_label(conf->partition_label, &index) == ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Partition already used");
err = ESP_ERR_INVALID_STATE;
goto exit;
}
partition = esp_partition_find_first(
ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY,
conf->partition_label);
if (!partition) {
ESP_LOGE(ESP_LITTLEFS_TAG, "partition \"%s\" could not be found", conf->partition_label);
err = ESP_ERR_NOT_FOUND;
goto exit;
}
} else if(conf->partition) {
if (esp_littlefs_by_partition(conf->partition, &index) == ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Partition already used");
err = ESP_ERR_INVALID_STATE;
goto exit;
}
partition = conf->partition;
} else {
ESP_LOGE(ESP_LITTLEFS_TAG, "No partition specified in configuration");
err = ESP_ERR_INVALID_ARG;
goto exit;
}
{
uint32_t flash_page_size = g_rom_flashchip.page_size;
uint32_t log_page_size = CONFIG_LITTLEFS_PAGE_SIZE;
if (log_page_size % flash_page_size != 0) {
ESP_LOGE(ESP_LITTLEFS_TAG, "LITTLEFS_PAGE_SIZE is not multiple of flash chip page size (%u)",
(unsigned int) flash_page_size);
err = ESP_ERR_INVALID_ARG;
goto exit;
}
}
err = esp_littlefs_init_efs(&efs, partition, conf->read_only);
if(err != ESP_OK) {
goto exit;
}
// Mount and Error Check
_efs[index] = efs;
if(!conf->dont_mount){
int res = lfs_mount(efs->fs, &efs->cfg);
if (conf->format_if_mount_failed && res != LFS_ERR_OK) {
esp_err_t err;
ESP_LOGW(ESP_LITTLEFS_TAG, "mount failed, %s (%i). formatting...", esp_littlefs_errno(res), res);
err = esp_littlefs_format_partition(efs->partition);
if(err != ESP_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "format failed");
err = ESP_FAIL;
goto exit;
}
res = lfs_mount(efs->fs, &efs->cfg);
}
if (res != LFS_ERR_OK) {
ESP_LOGE(ESP_LITTLEFS_TAG, "mount failed, %s (%i)", esp_littlefs_errno(res), res);
err = ESP_FAIL;
goto exit;
}
efs->cache_size = 4;
efs->cache = calloc(sizeof(*efs->cache), efs->cache_size);
}
err = ESP_OK;
exit:
if(err != ESP_OK){
if( index >= 0 ) {
esp_littlefs_free(&_efs[index]);
}
else{
esp_littlefs_free(&efs);
}
}
xSemaphoreGive(_efs_lock);
return err;
}
/**
* @brief
* @parameter efs file system context
*/
static inline int sem_take(esp_littlefs_t *efs) {
int res;
#if LOG_LOCAL_LEVEL >= 5
ESP_LOGV(ESP_LITTLEFS_TAG, "------------------------ Sem Taking [%s]", pcTaskGetName(NULL));
#endif
res = xSemaphoreTakeRecursive(efs->lock, portMAX_DELAY);
#if LOG_LOCAL_LEVEL >= 5
ESP_LOGV(ESP_LITTLEFS_TAG, "--------------------->>> Sem Taken [%s]", pcTaskGetName(NULL));
#endif
return res;
}
/**
* @brief
* @parameter efs file system context
*/
static inline int sem_give(esp_littlefs_t *efs) {
#if LOG_LOCAL_LEVEL >= 5
ESP_LOGV(ESP_LITTLEFS_TAG, "---------------------<<< Sem Give [%s]", pcTaskGetName(NULL));
#endif
return xSemaphoreGiveRecursive(efs->lock);
}
/* We are using a double allocation system here, which an array and a linked list.
The array contains the pointer to the file descriptor (the index in the array is what's returned to the user).
The linked list is used for file descriptors.
This means that position of nodes in the list must stay consistent:
- Allocation is obvious (append to the list from the head, and realloc the pointers array)
There is still a O(N) search in the cache for a free position to store
- Searching is a O(1) process (good)
- Deallocation is more tricky. That is, for example,
if you need to remove node 5 in a 12 nodes list, you'll have to:
1) Mark the 5th position as freed (if it's the last position of the array realloc smaller)
2) Walk the list until finding the pointer to the node O(N) and scrub the node so the chained list stays consistent
3) Deallocate the node
*/
/**
* @brief Get a file descriptor
* @param[in,out] efs file system context
* @param[out] file pointer to a file that'll be filled with a file object
* @param[in] path_len the length of the filepath in bytes (including terminating zero byte)
* @return integer file descriptor. Returns -1 if a FD cannot be obtained.
* @warning This must be called with lock taken
*/
static int esp_littlefs_allocate_fd(esp_littlefs_t *efs, vfs_littlefs_file_t ** file
#ifndef CONFIG_LITTLEFS_USE_ONLY_HASH
, const size_t path_len
#endif
)
{
int i = -1;
assert( efs->fd_count < UINT16_MAX );
assert( efs->cache_size < UINT16_MAX );
/* Make sure there is enough space in the cache to store new fd */
if (efs->fd_count + 1 > efs->cache_size) {
uint16_t new_size = (uint16_t)MIN(UINT16_MAX, CONFIG_LITTLEFS_FD_CACHE_REALLOC_FACTOR * efs->cache_size);
/* Resize the cache */
vfs_littlefs_file_t ** new_cache = realloc(efs->cache, new_size * sizeof(*efs->cache));
if (!new_cache) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Unable to allocate file cache");
return -1; /* If it fails here, no harm is done to the filesystem, so it's safe */
}
/* Zero out the new portions of the cache */
memset(&new_cache[efs->cache_size], 0, (new_size - efs->cache_size) * sizeof(*efs->cache));
efs->cache = new_cache;
efs->cache_size = new_size;
}
/* Allocate file descriptor here now */
#ifndef CONFIG_LITTLEFS_USE_ONLY_HASH
*file = calloc(1, sizeof(**file) + path_len);
#else
*file = calloc(1, sizeof(**file));
#endif
if (*file == NULL) {
/* If it fails here, the file system might have a larger cache, but it's harmless, no need to reverse it */
ESP_LOGE(ESP_LITTLEFS_TAG, "Unable to allocate FD");
return -1;
}
/* Starting from here, nothing can fail anymore */
#ifndef CONFIG_LITTLEFS_USE_ONLY_HASH
/* The trick here is to avoid dual allocation so the path pointer
should point to the next byte after it:
file => [ lfs_file | # | next | path | free_space ]
| /\
|__/
*/
(*file)->path = (char*)(*file) + sizeof(**file);
#endif
/* Now find a free place in cache */
for(i=0; i < efs->cache_size; i++) {
if (efs->cache[i] == NULL) {
efs->cache[i] = *file;
break;
}
}
/* Save file in the list */
(*file)->next = efs->file;
efs->file = *file;
efs->fd_count++;
return i;
}
/**
* @brief Release a file descriptor
* @param[in,out] efs file system context
* @param[in] fd File Descriptor to release
* @return 0 on success. -1 if a FD cannot be obtained.
* @warning This must be called with lock taken
*/
static int esp_littlefs_free_fd(esp_littlefs_t *efs, int fd){
vfs_littlefs_file_t * file, * head;
if((uint32_t)fd >= efs->cache_size) {
ESP_LOGE(ESP_LITTLEFS_TAG, "FD %d must be <%d.", fd, efs->cache_size);
return -1;
}
/* Get the file descriptor to free it */
file = efs->cache[fd];
head = efs->file;
/* Search for file in SLL to remove it */
if (file == head) {
/* Last file, can't fail */
efs->file = efs->file->next;
} else {
while (head && head->next != file) {
head = head->next;
}
if (!head) {
ESP_LOGE(ESP_LITTLEFS_TAG, "Inconsistent list");
return -1;
}
/* Transaction starts here and can't fail anymore */
head->next = file->next;
}
efs->cache[fd] = NULL;
efs->fd_count--;
ESP_LOGV(ESP_LITTLEFS_TAG, "Clearing FD");
free(file);
#if 0
/* Realloc smaller if its possible
* * Find and realloc based on number of trailing NULL ptrs in cache
* * Leave some hysteris to prevent thrashing around resize points