Added format flags to lfsr_format

This is mainly to solve the weird check-hole where passing CKPROGS/
CKREADS as mount flags has no effect on lfsr_format (I mean, it'd be a
bit silly if it did somehow):

  LFS_F_RDWR              0  // Format the filesystem as read and write
  LFS_F_CKPROGS  0x00000010  // Check progs by reading back progged data
  LFS_F_CKREADS  0x00000020  // Check reads via parity bits/checksums

This makes lfsr_format a more cumbersome interface, but I don't know if
this is necessarily a bad thing. There's always risk of data loss when
calling lfsr_format, so maybe it should be a pain to call.

At the very least, format flags may be useful in the future for
enabling/disabling format-time things such as the planned block-map,
parity-tree, etc. Though it's unclear if such significant settings
should be format flags or somehow encoded as fields in our config
struct.

---

The LFS_F_* format flags of course ended up conflicting with our
internal LFS_F_* flags, so I renamed most of the internal flags to match
the closest flag set they participate in:

- LFS_F_TYPE        -> LFS_O_TYPE
- LFS_F_UNFLUSH     -> LFS_O_UNFLUSH
- LFS_F_UNSYNC      -> LFS_O_UNSYNC
- LFS_F_ORPHAN      -> LFS_O_ORPHAN
- LFS_F_ZOMBIE      -> LFS_O_ZOMBIE

- LFS_F_ORPHANS     -> LFS_I_ORPHANS
- LFS_F_UNCOMPACTED -> LFS_I_UNCOMPACTED

- LFS_F_TSTATE      -> LFS_T_TSTATE
- LFS_F_BTYPE       -> LFS_T_BTYPE
- LFS_F_DIRTY       -> LFS_T_DIRTY
- LFS_F_MUTATED     -> LFS_T_MUTATED

This may make it a bit less clear which flags are a part of the public
API, vs intended only for internal use, but at the very least our asserts
in format/mount/open/etc should catch most of these mistakes.

---

Code cost ended up being pretty minimal. Actually negative. This is the
second time we're _adding_ a feature that somehow saves code, though the
reality for this one is we're really just pushing constants up into the
user's stack frame. Still, it's a good indication the cost of format
flags is small:

           code          stack
  before: 36452           2680
  after:  36448 (-0.0%)   2680 (+0.0%)
This commit is contained in:
Christopher Haster
2024-08-12 13:50:36 -05:00
parent dffd8fa0fa
commit acad3a3143
21 changed files with 785 additions and 678 deletions
+14 -14
View File
@@ -82,7 +82,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
// confirm the previous mount works
lfsp_mount(&lfsp, LFSP_M_RDWR, &cfgp) => 0;
@@ -109,7 +109,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
// write COUNT dirs
lfsp_mount(&lfsp, LFSP_M_RDWR, &cfgp) => 0;
@@ -169,7 +169,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
// write COUNT files
lfsp_mount(&lfsp, LFSP_M_RDWR, &cfgp) => 0;
@@ -259,7 +259,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
// write COUNT files+dirs
lfsp_mount(&lfsp, LFSP_M_RDWR, &cfgp) => 0;
@@ -376,7 +376,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
// write COUNT/2 dirs
lfsp_mount(&lfsp, LFSP_M_RDWR, &cfgp) => 0;
@@ -443,7 +443,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
// write half COUNT files
lfsp_mount(&lfsp, LFSP_M_RDWR, &cfgp) => 0;
@@ -565,7 +565,7 @@ code = '''
assert(sizeof(struct lfsp_config) == sizeof(struct lfs_config));
memcpy(&cfgp, CFG, sizeof(cfgp));
lfsp_t lfsp;
lfsp_format(&lfsp, &cfgp) => 0;
lfsr_format(&lfsp, LFS_F_RDWR, &cfgp) => 0;
//////
@@ -715,7 +715,7 @@ if = [
code = '''
// create the new version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// confirm the new mount works
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;
@@ -743,7 +743,7 @@ if = [
code = '''
// create the new version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// write COUNT dirs
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;
@@ -803,7 +803,7 @@ if = [
code = '''
// create the new version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// write COUNT files
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;
@@ -893,7 +893,7 @@ if = [
code = '''
// create the new version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// write COUNT files+dirs
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;
@@ -1010,7 +1010,7 @@ if = [
code = '''
// create the new version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// write COUNT/2 dirs
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;
@@ -1077,7 +1077,7 @@ if = [
code = '''
// create the previous version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// write half COUNT files
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;
@@ -1199,7 +1199,7 @@ if = [
code = '''
// create the previous version
lfs_t lfs;
lfsr_format(&lfs, CFG) => 0;
lfsr_format(&lfs, LFS_F_RDWR, CFG) => 0;
// write half COUNT files
lfsr_mount(&lfs, LFS_M_RDWR, CFG) => 0;