Github/littlefs
1
Fork 0
Code Actions Activity

Renamed omdir -> handle

Browse Source 
- lfs3_omdir_t -> lfs3_handle_t
- lfs3.omdirs -> lfs3.handles
- o -> h
- lfs3_omdir_* -> lfs3_handle_*
- lfs3_omdir_ismidopen -> lfs3_mid_isopen

From conversations with users, the term "handle" or "file handle" seems
to be the most common/easily understood term for the lfs3_file_t struct
itself. It makes sense to adopt this in our codebase.

I usually dislike inventing new names for things when prefixes can imply
a relationship (size -> ssize, cache -> rcache, shrub -> bshrub, etc),
but lfs3_omdirs_t was probably a bit much.
This commit is contained in:
Christopher Haster
2025-07-18 15:22:22 -05:00
parent ee3be04a93
commit 4cea5af96f
8 changed files with 650 additions and 644 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_mtree.toml
+60 -60
View File
@@ -2860,21 +2860,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "c", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "c", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// insert a new entry, this should update our neighbors
lfs3_mdir_t mdir;
@@ -2906,8 +2906,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -2920,21 +2920,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "b", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "b", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// try removing left neighbor
lfs3_mdir_t mdir;
@@ -2956,8 +2956,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -2970,21 +2970,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "b", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "b", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// try removing right neighbor
lfs3_mdir_t mdir;
@@ -3006,8 +3006,8 @@ code = '''
assert(left.mdir.r.trunk == mdir.r.trunk);
assert(left.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3022,21 +3022,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "d", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "d", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// create 2 large entries that needs to be uninlined and split
uint8_t buffer[SIZE];
@@ -3083,8 +3083,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3099,21 +3099,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "e", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "e", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// create 2 large entries that needs to be uninlined and split
uint8_t buffer[SIZE];
@@ -3174,8 +3174,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3190,21 +3190,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "b", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "b", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// force mroot to compact twice, this should extend the mroot
lfs3_mdir_t old_mroot = lfs3.mroot;
@@ -3230,8 +3230,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3248,21 +3248,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "d", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "d", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// create 2 large entries that needs to be uninlined and split
uint8_t buffer[SIZE];
@@ -3327,8 +3327,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3345,21 +3345,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "d", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "d", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// create 2 large entries that needs to be uninlined and split
uint8_t buffer[SIZE];
@@ -3424,8 +3424,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3440,21 +3440,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "f", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "f", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// create 2 large entries that needs to be uninlined and split
uint8_t buffer[SIZE];
@@ -3534,8 +3534,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''
@@ -3550,21 +3550,21 @@ code = '''
lfs3_alloc_ckpoint(&lfs3);
// setup our neighbors
lfs3_omdir_t left = {.flags=0};
lfs3_handle_t left = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "a", 1,
&left.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &left.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "a", 1))) => 0;
assert(left.mdir.r.weight == 2);
lfs3_omdir_open(&lfs3, &left);
lfs3_handle_open(&lfs3, &left);
lfs3_omdir_t right = {.flags=0};
lfs3_handle_t right = {.flags=0};
lfs3_mtree_namelookup(&lfs3, 0, "e", 1,
&right.mdir, NULL) => LFS3_ERR_NOENT;
lfs3_mdir_commit(&lfs3, &right.mdir, LFS3_RATTRS(
LFS3_RATTR_NAME(LFS3_TAG_REG, +1, 0, "e", 1))) => 0;
assert(right.mdir.r.weight == 3);
lfs3_omdir_open(&lfs3, &right);
lfs3_handle_open(&lfs3, &right);
// create 2 large entries that needs to be uninlined and split
uint8_t buffer[SIZE];
@@ -3635,8 +3635,8 @@ code = '''
assert(right.mdir.r.trunk == mdir.r.trunk);
assert(right.mdir.r.cksum == mdir.r.cksum);
lfs3_omdir_close(&lfs3, &left);
lfs3_omdir_close(&lfs3, &right);
lfs3_handle_close(&lfs3, &left);
lfs3_handle_close(&lfs3, &right);
lfs3_unmount(&lfs3) => 0;
'''