mirror of
https://github.com/eledio-devices/thirdparty-littlefs.git
synced 2025-10-31 16:14:16 +01:00
c44427f9ec
As an embedded library, littlefs's configuration straddles two worlds.
In most cases the configuration is usually constant at build time, but
when integrated into OSs, the configuration needs to be dynamically
configurable.
To help with this, littlefs has a separate lfs_config struct that can be
placed into ROM when possible.
But you know what's better than ROM configuration? Truely inlinable
static configuration known at compile-time. In addition to avoiding the
RAM cost, compile-time configuration allows for additional compiler
optimizations, such as constexpr-elimination and removal of unused
code-paths.
So how to enable static configuration?
1. define LFS_STATICCFG
2. implement callbacks as global functions:
- lfs_read
- lfs_prog
- lfs_erase
- lfs_sync
2. define the now-required constants that configure littlefs:
- LFS_READ_SIZE
- LFS_PROG_SIZE
- LFS_BLOCK_SIZE
- LFS_BLOCK_COUNT
- LFS_BLOCK_CYCLES
- LFS_CACHE_SIZE
- LFS_LOOKAHEAD_SIZE
- LFS_READ_BUFFER (optional)
- LFS_PROG_BUFFER (optional)
- LFS_LOOKAHEAD_BUFFER (optional)
- LFS_NAME_MAX (optional)
- LFS_FILE_MAX (optional)
- LFS_ATTR_MAX (optional)
Note, there is a separate configuration for the file configuration, this
can be enabled/disabled independently of LFS_STATICCFG. You will likely
want to define this as well if you are looking for the smallest code
size.
In order to avoid a mess of #ifdefs, the internals of littlefs use a
simple macro that redirects to either the dynamic or static config at
compile time:
#ifdef LFS_STATICCFG
#define LFS_CFG_READ_SIZE(lfs) ((void)lfs, LFS_READ_SIZE)
#else
#define LFS_CFG_READ_SIZE(lfs) lfs->cfg->read_size
#endif
Unfortunately it does look like there still may be a lot of issues
related to warnings of comparisons against constants... If only C had
a way to ignore warnings on individual statements...
Original idea by apmorton
395 lines
13 KiB
TOML
395 lines
13 KiB
TOML
[[case]] # simple truncate
|
|
define.MEDIUMSIZE = [32, 2048]
|
|
define.LARGESIZE = 8192
|
|
code = '''
|
|
lfs_formatcfg(&lfs, &cfg) => 0;
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldynoop",
|
|
LFS_O_WRONLY | LFS_O_CREAT) => 0;
|
|
|
|
strcpy((char*)buffer, "hair");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < LARGESIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldynoop", LFS_O_RDWR) => 0;
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
|
|
lfs_file_truncate(&lfs, &file, MEDIUMSIZE) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldynoop", LFS_O_RDONLY) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
size = strlen("hair");
|
|
for (lfs_off_t j = 0; j < MEDIUMSIZE; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "hair", size) => 0;
|
|
}
|
|
lfs_file_read(&lfs, &file, buffer, size) => 0;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
'''
|
|
|
|
[[case]] # truncate and read
|
|
define.MEDIUMSIZE = [32, 2048]
|
|
define.LARGESIZE = 8192
|
|
code = '''
|
|
lfs_formatcfg(&lfs, &cfg) => 0;
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldyread",
|
|
LFS_O_WRONLY | LFS_O_CREAT) => 0;
|
|
|
|
strcpy((char*)buffer, "hair");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < LARGESIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldyread", LFS_O_RDWR) => 0;
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
|
|
lfs_file_truncate(&lfs, &file, MEDIUMSIZE) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
size = strlen("hair");
|
|
for (lfs_off_t j = 0; j < MEDIUMSIZE; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "hair", size) => 0;
|
|
}
|
|
lfs_file_read(&lfs, &file, buffer, size) => 0;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldyread", LFS_O_RDONLY) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
size = strlen("hair");
|
|
for (lfs_off_t j = 0; j < MEDIUMSIZE; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "hair", size) => 0;
|
|
}
|
|
lfs_file_read(&lfs, &file, buffer, size) => 0;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
'''
|
|
|
|
[[case]] # write, truncate, and read
|
|
code = '''
|
|
lfs_formatcfg(&lfs, &cfg) => 0;
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "sequence",
|
|
LFS_O_RDWR | LFS_O_CREAT | LFS_O_TRUNC) => 0;
|
|
|
|
size = lfs_min(lfs.cfg->cache_size, sizeof(buffer)/2);
|
|
lfs_size_t qsize = size / 4;
|
|
uint8_t *wb = buffer;
|
|
uint8_t *rb = buffer + size;
|
|
for (lfs_off_t j = 0; j < size; ++j) {
|
|
wb[j] = j;
|
|
}
|
|
|
|
/* Spread sequence over size */
|
|
lfs_file_write(&lfs, &file, wb, size) => size;
|
|
lfs_file_size(&lfs, &file) => size;
|
|
lfs_file_tell(&lfs, &file) => size;
|
|
|
|
lfs_file_seek(&lfs, &file, 0, LFS_SEEK_SET) => 0;
|
|
lfs_file_tell(&lfs, &file) => 0;
|
|
|
|
/* Chop off the last quarter */
|
|
lfs_size_t trunc = size - qsize;
|
|
lfs_file_truncate(&lfs, &file, trunc) => 0;
|
|
lfs_file_tell(&lfs, &file) => 0;
|
|
lfs_file_size(&lfs, &file) => trunc;
|
|
|
|
/* Read should produce first 3/4 */
|
|
lfs_file_read(&lfs, &file, rb, size) => trunc;
|
|
memcmp(rb, wb, trunc) => 0;
|
|
|
|
/* Move to 1/4 */
|
|
lfs_file_size(&lfs, &file) => trunc;
|
|
lfs_file_seek(&lfs, &file, qsize, LFS_SEEK_SET) => qsize;
|
|
lfs_file_tell(&lfs, &file) => qsize;
|
|
|
|
/* Chop to 1/2 */
|
|
trunc -= qsize;
|
|
lfs_file_truncate(&lfs, &file, trunc) => 0;
|
|
lfs_file_tell(&lfs, &file) => qsize;
|
|
lfs_file_size(&lfs, &file) => trunc;
|
|
|
|
/* Read should produce second quarter */
|
|
lfs_file_read(&lfs, &file, rb, size) => trunc - qsize;
|
|
memcmp(rb, wb + qsize, trunc - qsize) => 0;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
'''
|
|
|
|
[[case]] # truncate and write
|
|
define.MEDIUMSIZE = [32, 2048]
|
|
define.LARGESIZE = 8192
|
|
code = '''
|
|
lfs_formatcfg(&lfs, &cfg) => 0;
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldywrite",
|
|
LFS_O_WRONLY | LFS_O_CREAT) => 0;
|
|
|
|
strcpy((char*)buffer, "hair");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < LARGESIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldywrite", LFS_O_RDWR) => 0;
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
|
|
lfs_file_truncate(&lfs, &file, MEDIUMSIZE) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
strcpy((char*)buffer, "bald");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < MEDIUMSIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
lfs_file_open(&lfs, &file, "baldywrite", LFS_O_RDONLY) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
|
|
size = strlen("bald");
|
|
for (lfs_off_t j = 0; j < MEDIUMSIZE; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "bald", size) => 0;
|
|
}
|
|
lfs_file_read(&lfs, &file, buffer, size) => 0;
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
lfs_unmount(&lfs) => 0;
|
|
'''
|
|
|
|
[[case]] # truncate write under powerloss
|
|
define.SMALLSIZE = [4, 512]
|
|
define.MEDIUMSIZE = [32, 1024]
|
|
define.LARGESIZE = 2048
|
|
reentrant = true
|
|
code = '''
|
|
err = lfs_mountcfg(&lfs, &cfg);
|
|
if (err) {
|
|
lfs_formatcfg(&lfs, &cfg) => 0;
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
}
|
|
err = lfs_file_open(&lfs, &file, "baldy", LFS_O_RDONLY);
|
|
assert(!err || err == LFS_ERR_NOENT);
|
|
if (!err) {
|
|
size = lfs_file_size(&lfs, &file);
|
|
assert(size == 0 ||
|
|
size == LARGESIZE ||
|
|
size == MEDIUMSIZE ||
|
|
size == SMALLSIZE);
|
|
for (lfs_off_t j = 0; j < size; j += 4) {
|
|
lfs_file_read(&lfs, &file, buffer, 4) => 4;
|
|
assert(memcmp(buffer, "hair", 4) == 0 ||
|
|
memcmp(buffer, "bald", 4) == 0 ||
|
|
memcmp(buffer, "comb", 4) == 0);
|
|
}
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
}
|
|
|
|
lfs_file_open(&lfs, &file, "baldy",
|
|
LFS_O_WRONLY | LFS_O_CREAT | LFS_O_TRUNC) => 0;
|
|
lfs_file_size(&lfs, &file) => 0;
|
|
strcpy((char*)buffer, "hair");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < LARGESIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
|
|
lfs_file_open(&lfs, &file, "baldy", LFS_O_RDWR) => 0;
|
|
lfs_file_size(&lfs, &file) => LARGESIZE;
|
|
lfs_file_truncate(&lfs, &file, MEDIUMSIZE) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
strcpy((char*)buffer, "bald");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < MEDIUMSIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
|
|
lfs_file_open(&lfs, &file, "baldy", LFS_O_RDWR) => 0;
|
|
lfs_file_size(&lfs, &file) => MEDIUMSIZE;
|
|
lfs_file_truncate(&lfs, &file, SMALLSIZE) => 0;
|
|
lfs_file_size(&lfs, &file) => SMALLSIZE;
|
|
strcpy((char*)buffer, "comb");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < SMALLSIZE; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => SMALLSIZE;
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
|
|
lfs_unmount(&lfs) => 0;
|
|
'''
|
|
|
|
[[case]] # more aggressive general truncation tests
|
|
define.CONFIG = 'range(6)'
|
|
define.SMALLSIZE = 32
|
|
define.MEDIUMSIZE = 2048
|
|
define.LARGESIZE = 8192
|
|
code = '''
|
|
#define COUNT 5
|
|
const struct {
|
|
lfs_off_t startsizes[COUNT];
|
|
lfs_off_t startseeks[COUNT];
|
|
lfs_off_t hotsizes[COUNT];
|
|
lfs_off_t coldsizes[COUNT];
|
|
} configs[] = {
|
|
// cold shrinking
|
|
{{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE}},
|
|
// cold expanding
|
|
{{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE}},
|
|
// warm shrinking truncate
|
|
{{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE},
|
|
{ 0, 0, 0, 0, 0}},
|
|
// warm expanding truncate
|
|
{{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE},
|
|
{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE}},
|
|
// mid-file shrinking truncate
|
|
{{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{ LARGESIZE, LARGESIZE, LARGESIZE, LARGESIZE, LARGESIZE},
|
|
{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE},
|
|
{ 0, 0, 0, 0, 0}},
|
|
// mid-file expanding truncate
|
|
{{ 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE, 2*LARGESIZE},
|
|
{ 0, 0, SMALLSIZE, MEDIUMSIZE, LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE},
|
|
{2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE, 2*LARGESIZE}},
|
|
};
|
|
|
|
const lfs_off_t *startsizes = configs[CONFIG].startsizes;
|
|
const lfs_off_t *startseeks = configs[CONFIG].startseeks;
|
|
const lfs_off_t *hotsizes = configs[CONFIG].hotsizes;
|
|
const lfs_off_t *coldsizes = configs[CONFIG].coldsizes;
|
|
|
|
lfs_formatcfg(&lfs, &cfg) => 0;
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
|
|
for (unsigned i = 0; i < COUNT; i++) {
|
|
sprintf(path, "hairyhead%d", i);
|
|
lfs_file_open(&lfs, &file, path,
|
|
LFS_O_WRONLY | LFS_O_CREAT | LFS_O_TRUNC) => 0;
|
|
|
|
strcpy((char*)buffer, "hair");
|
|
size = strlen((char*)buffer);
|
|
for (lfs_off_t j = 0; j < startsizes[i]; j += size) {
|
|
lfs_file_write(&lfs, &file, buffer, size) => size;
|
|
}
|
|
lfs_file_size(&lfs, &file) => startsizes[i];
|
|
|
|
if (startseeks[i] != startsizes[i]) {
|
|
lfs_file_seek(&lfs, &file,
|
|
startseeks[i], LFS_SEEK_SET) => startseeks[i];
|
|
}
|
|
|
|
lfs_file_truncate(&lfs, &file, hotsizes[i]) => 0;
|
|
lfs_file_size(&lfs, &file) => hotsizes[i];
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
}
|
|
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
|
|
for (unsigned i = 0; i < COUNT; i++) {
|
|
sprintf(path, "hairyhead%d", i);
|
|
lfs_file_open(&lfs, &file, path, LFS_O_RDWR) => 0;
|
|
lfs_file_size(&lfs, &file) => hotsizes[i];
|
|
|
|
size = strlen("hair");
|
|
lfs_off_t j = 0;
|
|
for (; j < startsizes[i] && j < hotsizes[i]; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "hair", size) => 0;
|
|
}
|
|
|
|
for (; j < hotsizes[i]; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "\0\0\0\0", size) => 0;
|
|
}
|
|
|
|
lfs_file_truncate(&lfs, &file, coldsizes[i]) => 0;
|
|
lfs_file_size(&lfs, &file) => coldsizes[i];
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
}
|
|
|
|
lfs_unmount(&lfs) => 0;
|
|
|
|
lfs_mountcfg(&lfs, &cfg) => 0;
|
|
|
|
for (unsigned i = 0; i < COUNT; i++) {
|
|
sprintf(path, "hairyhead%d", i);
|
|
lfs_file_open(&lfs, &file, path, LFS_O_RDONLY) => 0;
|
|
lfs_file_size(&lfs, &file) => coldsizes[i];
|
|
|
|
size = strlen("hair");
|
|
lfs_off_t j = 0;
|
|
for (; j < startsizes[i] && j < hotsizes[i] && j < coldsizes[i];
|
|
j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "hair", size) => 0;
|
|
}
|
|
|
|
for (; j < coldsizes[i]; j += size) {
|
|
lfs_file_read(&lfs, &file, buffer, size) => size;
|
|
memcmp(buffer, "\0\0\0\0", size) => 0;
|
|
}
|
|
|
|
lfs_file_close(&lfs, &file) => 0;
|
|
}
|
|
|
|
lfs_unmount(&lfs) => 0;
|
|
'''
|