Skip to content

Commit

Permalink
Shrinked on-disk directory program size
Browse files Browse the repository at this point in the history 
Directories still consume two full erase blocks, but now only program
the exact on-disk region to store the directory contents. This results
in a decent improvement in the amount of data written and read to the
device when doing directory operations.

Calculating the checksum of dynamically sized data is surprisingly
tricky, since the size of the data could also contain errors. For the
littlefs, we can assume the data size must fit in an erase block.
If the data size is invalid, we can just treat the block as corrupted.
  • Loading branch information
@geky
geky committed Jun 28, 2017
1 parent 0d66f9f commit 1eeb2a6
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 34 deletions.
53 changes: 21 additions & 32 deletions lfs.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {

// set defaults
dir->d.rev += 1;
dir->d.size = sizeof(dir->d);
dir->d.size = sizeof(dir->d)+4;
dir->d.tail[0] = -1;
dir->d.tail[1] = -1;
dir->off = sizeof(dir->d);
Expand All @@ -331,17 +331,21 @@ static int lfs_dir_fetch(lfs_t *lfs,
continue;
}

if ((0x7fffffff & test.size) > lfs->cfg->block_size) {
continue;
}

uint32_t crc = 0xffffffff;
crc = lfs_crc(crc, &test, sizeof(test));

for (lfs_off_t j = sizeof(test); j < lfs->cfg->block_size; j += 4) {
uint32_t word;
int err = lfs_read(lfs, tpair[i], j, &word, 4);
for (lfs_off_t j = sizeof(test); j < (0x7fffffff & test.size); j++) {
uint8_t data;
int err = lfs_read(lfs, tpair[i], j, &data, 1);
if (err) {
return err;
}

crc = lfs_crc(crc, &word, 4);
crc = lfs_crc(crc, &data, 1);
}

if (crc != 0) {
Expand Down Expand Up @@ -405,8 +409,7 @@ static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
int i = 0;
lfs_off_t oldoff = sizeof(dir->d);
lfs_off_t newoff = sizeof(dir->d);
lfs_size_t newsize = 0x7fffffff & dir->d.size;
while (newoff < newsize) {
while (newoff < (0x7fffffff & dir->d.size)-4) {
if (i < count && regions[i].oldoff == oldoff) {
crc = lfs_crc(crc, regions[i].newdata, regions[i].newlen);
int err = lfs_prog(lfs, dir->pair[0],
Expand Down Expand Up @@ -442,21 +445,7 @@ static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
}
}

while (newoff < lfs->cfg->block_size-4) {
uint8_t data = 0xff;
crc = lfs_crc(crc, &data, 1);
err = lfs_prog(lfs, dir->pair[0], newoff, &data, 1);
if (err) {
if (err == LFS_ERR_CORRUPT) {
goto relocate;
}
return err;
}

newoff += 1;
}

err = lfs_prog(lfs, dir->pair[0], lfs->cfg->block_size-4, &crc, 4);
err = lfs_prog(lfs, dir->pair[0], newoff, &crc, 4);
if (err) {
if (err == LFS_ERR_CORRUPT) {
goto relocate;
Expand Down Expand Up @@ -514,8 +503,8 @@ static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,
lfs_entry_t *entry, const void *data) {
// check if we fit, if top bit is set we do not and move on
while (true) {
if (dir->d.size + entry->d.len <= lfs->cfg->block_size - 4) {
entry->off = dir->d.size;
if (dir->d.size + entry->d.len <= lfs->cfg->block_size) {
entry->off = dir->d.size - 4;
return lfs_dir_commit(lfs, dir, (struct lfs_region[]){
{entry->off, 0, &entry->d, sizeof(entry->d)},
{entry->off, 0, data, entry->d.len - sizeof(entry->d)}
Expand All @@ -532,7 +521,7 @@ static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,

newdir.d.tail[0] = dir->d.tail[0];
newdir.d.tail[1] = dir->d.tail[1];
entry->off = newdir.d.size;
entry->off = newdir.d.size - 4;
err = lfs_dir_commit(lfs, &newdir, (struct lfs_region[]){
{entry->off, 0, &entry->d, sizeof(entry->d)},
{entry->off, 0, data, entry->d.len - sizeof(entry->d)}
Expand All @@ -556,7 +545,7 @@ static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,

static int lfs_dir_remove(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
// either shift out the one entry or remove the whole dir block
if (dir->d.size == sizeof(dir->d)) {
if (dir->d.size == sizeof(dir->d)+4) {
lfs_dir_t pdir;
int res = lfs_pred(lfs, dir->pair, &pdir);
if (res < 0) {
Expand All @@ -580,7 +569,7 @@ static int lfs_dir_remove(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
}

static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)) {
while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)-4) {
if (!(0x80000000 & dir->d.size)) {
entry->off = dir->off;
return LFS_ERR_NOENT;
Expand All @@ -592,7 +581,7 @@ static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
}

dir->off = sizeof(dir->d);
dir->pos += sizeof(dir->d);
dir->pos += sizeof(dir->d) + 4;
}

int err = lfs_read(lfs, dir->pair[0], dir->off,
Expand Down Expand Up @@ -1483,7 +1472,7 @@ int lfs_remove(lfs_t *lfs, const char *path) {
int err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
if (err) {
return err;
} else if (dir.d.size != sizeof(dir.d)) {
} else if (dir.d.size != sizeof(dir.d)+4) {
return LFS_ERR_INVAL;
}
}
Expand Down Expand Up @@ -1559,7 +1548,7 @@ int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
int err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
if (err) {
return err;
} else if (dir.d.size != sizeof(dir.d)) {
} else if (dir.d.size != sizeof(dir.d)+4) {
return LFS_ERR_INVAL;
}
}
Expand Down Expand Up @@ -1733,7 +1722,7 @@ int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
};
superdir.d.tail[0] = root.pair[0];
superdir.d.tail[1] = root.pair[1];
superdir.d.size = sizeof(superdir.d) + sizeof(superblock.d);
superdir.d.size = sizeof(superdir.d) + sizeof(superblock.d) + 4;

// write both pairs to be safe
bool valid = false;
Expand Down Expand Up @@ -1832,7 +1821,7 @@ int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
}

// iterate over contents
while ((0x7fffffff & dir.d.size) >= dir.off + sizeof(entry.d)) {
while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
int err = lfs_read(lfs, dir.pair[0], dir.off,
&entry.d, sizeof(entry.d));
if (err) {
Expand Down
4 changes: 2 additions & 2 deletions tests/template.fmt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ lfs_size_t rsize;
uintmax_t res;

#ifndef LFS_READ_SIZE
#define LFS_READ_SIZE 64
#define LFS_READ_SIZE 16
#endif

#ifndef LFS_PROG_SIZE
#define LFS_PROG_SIZE 64
#define LFS_PROG_SIZE 16
#endif

#ifndef LFS_BLOCK_SIZE
Expand Down

0 comments on commit 1eeb2a6

Please sign in to comment.