scripts: dbgflags.py: Added -d/--diff, lineno, better find reuse

This started with adding -d/--diff support to dbgflags.py, which is very
useful for comparing flags during test failure.

The flag asserts in our tests generally look like this:

  tests/test_mount.toml:171:assert: assert failed with 33570064,
  expected eq 33570576
      assert(fsinfo.flags == (

Which can now be quickly compared with dbgflags.py:

  $ ./scripts/dbgflags.py +i 33570064 -d 33570576
   LFS3_I_GBMAP         0x02000000  Global on-disk block-map in use
   LFS3_I_REVPERTURB    0x00000010  Mounted with LFS3_M_REVPERTURB
   LFS3_I_MKCONSISTENT  0x00000100  Filesystem needs mkconsistent to write
  -LFS3_I_LOOKAHEAD     0x00000200  Lookahead buffer is not full
   LFS3_I_PREERASE      0x00000400  Blocks can be pre-erased
   LFS3_I_COMPACT       0x00000800  Filesystem may have uncompacted metadata
   LFS3_I_CKMETA        0x00001000  Metadata checksums not checked recently
   LFS3_I_CKDATA        0x00002000  Data checksums not checked recently

The assert print is a bit more annoying than it needs to be, as it only
prints in decimal. But, since our prettyasserts.py only works at the
syntax layer, it's not possible to make it any smarter.

---

To make this diffing work required a couple more features in our
self-parsing Flag class:

- Keep track of lineno, mainly for ordering things
- Moved find logic into a staticmethod on all classes
- Added _sentinel based defaults to find functions
- Allowed self to be non-class in line functions to deduplicate "Unknown
  flag" messages

I went ahead and extended these to the other self-parsing classes (Err
and Tag) in case they're useful in the future.
This commit is contained in:
Christopher Haster
2026-01-02 13:15:11 -06:00
parent a9c18862c6
commit 5511c100ed
9 changed files with 346 additions and 181 deletions
+54 -57
View File
@@ -30,10 +30,12 @@ ERR_RANGE = -34 # Result out of range
# self-parsing error codes
class Err:
def __init__(self, name, code, help):
def __init__(self, name, code, help, *,
lineno=0):
self.name = name
self.code = code
self.help = help
self.lineno = lineno
def __repr__(self):
return 'Err(%r, %r, %r)' % (
@@ -51,7 +53,10 @@ class Err:
return hash(self.name)
def line(self):
return ('LFS3_%s' % self.name, '%d' % self.code, self.help)
if isinstance(self, Err):
return ('LFS3_%s' % self.name, '%d' % self.code, self.help)
else:
return ('?', str(self), 'Unknown err code')
@staticmethod
@ft.cache
@@ -63,82 +68,74 @@ class Err:
err_pattern = re.compile(
'^(?P<name>ERR_[^ ]*) *= *(?P<code>[^#]*?) *'
'#+ *(?P<help>.*)$')
for line in (inspect.getsource(
inspect.getmodule(inspect.currentframe()))
.replace('\\\n', '')
.splitlines()):
for i, line in enumerate(
inspect.getsource(inspect.getmodule(inspect.currentframe()))
.replace('\\\n', '')
.splitlines()):
m = err_pattern.match(line)
if m:
errs.append(Err(
m.group('name'),
globals()[m.group('name')],
m.group('help')))
m.group('help'),
lineno=1+i))
return errs
_sentinel = object()
@staticmethod
def find(e_, *, default=_sentinel):
# find errs, note this is cached
errs__ = Err.errs()
# find by LFS3_ERR_+name
for e in errs__:
if 'LFS3_%s' % e.name.upper() == e_.upper():
return e
# find by ERR_+name
for e in errs__:
if e.name.upper() == e_.upper():
return e
# find by name
for e in errs__:
if e.name.split('_', 1)[1] == e_.upper():
return e
# find by E+name
for e in errs__:
if 'E%s' % e.name.split('_', 1)[1].upper() == e_.upper():
return e
try:
# find by err code
for e in errs__:
if e.code == int(e_, 0):
return e
# find by negated err code
for e in errs__:
if e.code == -int(e_, 0):
return e
except ValueError:
pass
# not found
if default is Err._sentinel:
raise KeyError(e_)
else:
return default
def main(errs, *,
list=False):
import builtins
list_, list = list, builtins.list
# find errs
errs__ = Err.errs()
lines = []
# list all known error codes
if list_:
for e in errs__:
for e in Err.errs():
lines.append(e.line())
# find errs by name or value
else:
for e_ in errs:
found = False
# find by LFS3_ERR_+name
for e in errs__:
if 'LFS3_%s' % e.name.upper() == e_.upper():
lines.append(e.line())
found = True
if found:
continue
# find by ERR_+name
for e in errs__:
if e.name.upper() == e_.upper():
lines.append(e.line())
found = True
if found:
continue
# find by name
for e in errs__:
if e.name.split('_', 1)[1] == e_.upper():
lines.append(e.line())
found = True
if found:
continue
# find by E+name
for e in errs__:
if 'E%s' % e.name.split('_', 1)[1].upper() == e_.upper():
lines.append(e.line())
found = True
if found:
continue
try:
# find by err code
for e in errs__:
if e.code == int(e_, 0):
lines.append(e.line())
found = True
if found:
continue
# find by negated err code
for e in errs__:
if e.code == -int(e_, 0):
lines.append(e.line())
found = True
if found:
continue
except ValueError:
lines.append(('?', e_, 'Unknown err code'))
lines.append(Err.line(Err.find(e_, default=e_)))
# first find widths
w = [0, 0]