fabi/Sylpheed
1
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity

fix(tools): every sylpheed.db reader honours $SYLPHEED_DB, and none needs a retired checkout

Browse Source 
`SYLPHEED_DB` is the documented contract for the static-analysis database —
`docker/decoder/sylph-decoder` sets it, and `docs/agents/CONTAINER-NOTES.md` and
`decoder-loop.md` list it — but no reader honoured it:

  isl_cmdtab.py, name_block_bases.py   hardcoded `/work/xenia-rs/sylpheed.db`, a
                                        path that has not existed anywhere since
                                        `/work` became a clone. Both failed on
                                        every machine, before and after the
                                        database moved.
  zq.py                                 used `$SYLPH_XEXDB`, a name invented in
                                        #39 without grepping for the existing one.

All three now resolve `$SYLPHEED_DB`, then `$SYLPH_XEXDB` (kept as an alias so
nothing already written against it breaks), then `<repo root>/sylpheed.db`, and
refuse with exit 1 naming both variables and the build command otherwise.

`grab_tutorial.sh` hardcoded its helpers into the retired `sylpheed-reborn`
checkout. That copy's `skip_intro.sh` still calls the removed `vgamepad` and
exits 0 having pressed nothing — the failure this repository's own copy was
rewritten to make loud. So the script was already running a silently broken
helper; it now resolves its helpers from its own directory. Nothing exists only
in reborn's `tools/re-capture` (checked: 0 reborn-only files).

Verified against the same database, output compared byte for byte with the
ORIGINAL scripts (path-substituted copies, sibling imports resolvable):

  resolution path    isl_cmdtab   name_block_bases
  default (root)     identical    identical
  $SYLPHEED_DB       identical    identical
  $SYLPH_XEXDB       identical    identical
  bad path           exit 1       exit 1          (zq.py: exit 1 too)

and `isl_cmdtab`'s output is byte-identical to the body of the committed
`docs/re/data/isl-command-table.txt`.

⚠️ `name_block_bases`'s output does NOT reproduce the committed
`docs/re/data/name-block-bases.txt` (2,609 lines differ, `strings in the image:
7366` vs `7140`). That is the database, not this change: the artefact was
generated from the agent box's older 586 MB database, and this machine's is the
current generator's. Two databases are in circulation. Not regenerated here.

⚠️ Also not fixed, because it is a different bug: `name_block_bases.py` globs
`/work/sylph_extract/**/*.pak`, another path that exists nowhere now; that part
of its report is silently empty. It should read `$SYLPHEED_DISC`.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
sim
2026-09-16 20:07:19 +02:00
parent ad30352384
commit 120621daca
4 changed files with 66 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tools/re-capture/grab_tutorial.sh
View File

@@ -11,7 +11,10 @@ N="${1:?usage: grab_tutorial.sh <index 0..5> <outfile>}"
OUT="${2:?}"
export HOME=/sylph-home/re SDL_AUDIODRIVER=dummy DISPLAY=:98
SD="$(cd "$(dirname "$0")" && pwd)"
RC="/home/fabi/RE - Project Sylpheed/sylpheed-reborn/tools/re-capture"
# This script lives in the helpers' own directory. It used to hardcode the
# retired `sylpheed-reborn` checkout, whose `skip_intro.sh` still calls the
# removed `vgamepad` and exits 0 having pressed nothing.
RC="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# The container entrypoint's Xvfb/openbox do NOT restart on their own, and a
# dead Xvfb leaves a <defunct> entry that still matches `pgrep` -- so test the

27
tools/re-capture/isl_cmdtab.py
View File

@@ -5,7 +5,32 @@ Each write is `stw rX, off(r1)` (a two-word stack pair) followed by
`ld r9, off(r1)` and `std r9, N(r31)`, where slot = (N - 32) / 8.
"""
import duckdb, re, sys
con=duckdb.connect('/work/xenia-rs/sylpheed.db', read_only=True)
def _resolve_db():
"""`$SYLPHEED_DB`, else `$SYLPH_XEXDB`, else `<repo root>/sylpheed.db`.
`SYLPHEED_DB` is the documented contract -- `docker/decoder/sylph-decoder` sets
it and `docs/agents/CONTAINER-NOTES.md` lists it -- but no reader honoured it:
this script hardcoded `/work/xenia-rs/sylpheed.db`, a path that has not
existed anywhere since `/work` became a clone, so it failed on every machine.
"""
import os, pathlib
for var in ('SYLPHEED_DB', 'SYLPH_XEXDB'):
v = os.environ.get(var)
if v:
p = pathlib.Path(v).expanduser()
if not p.is_file():
sys.exit(f'${var} is set but is not a file: {p}')
return str(p)
p = pathlib.Path(__file__).resolve().parents[2] / 'sylpheed.db'
if p.is_file():
return str(p)
sys.exit(f'no database: set $SYLPHEED_DB, or build {p} with '
'sylph-xexdb dis <xex|iso> --db sylpheed.db --analyze sql --quiet')
con=duckdb.connect(_resolve_db(), read_only=True)
rows=con.execute("select address, coalesce(ext_disasm,disasm) from instructions "
"where address>=? and address<? order by address",
[0x822FE040,0x822FE618]).fetchall()

26
tools/re-capture/name_block_bases.py
View File

@@ -15,14 +15,36 @@ Regenerates docs/re/data/name-block-bases.txt.
"""
import sys, os, glob, collections, bisect
DB = '/work/xenia-rs/sylpheed.db'
def _resolve_db():
"""`$SYLPHEED_DB`, else `$SYLPH_XEXDB`, else `<repo root>/sylpheed.db`.
`SYLPHEED_DB` is the documented contract -- `docker/decoder/sylph-decoder` sets
it and `docs/agents/CONTAINER-NOTES.md` lists it -- but no reader honoured it:
this script hardcoded `/work/xenia-rs/sylpheed.db`, a path that has not
existed anywhere since `/work` became a clone, so it failed on every machine.
"""
import os, pathlib
for var in ('SYLPHEED_DB', 'SYLPH_XEXDB'):
v = os.environ.get(var)
if v:
p = pathlib.Path(v).expanduser()
if not p.is_file():
sys.exit(f'${var} is set but is not a file: {p}')
return str(p)
p = pathlib.Path(__file__).resolve().parents[2] / 'sylpheed.db'
if p.is_file():
return str(p)
sys.exit(f'no database: set $SYLPHEED_DB, or build {p} with '
'sylph-xexdb dis <xex|iso> --db sylpheed.db --analyze sql --quiet')
MIN_GROUP = 8 # displacements needed before a group is worth solving
MIN_RESOLVED = 12 # report a function only if the base explains this many
LOW, HIGH = 0x82000000, 0x82400000
def main():
import duckdb
con = duckdb.connect(DB, read_only=True)
con = duckdb.connect(_resolve_db(), read_only=True)
S = set(a for (a,) in con.execute("SELECT address FROM strings").fetchall())
txt = dict(con.execute("SELECT address, content FROM strings").fetchall())
funcs = con.execute(