Files
psxrecomp/docs/internal/TOMBA2_EXC_CONSULT_RESPONSE.md
Matthew Stanley e6ce5006b4 docs: move root and stale docs into docs/ and docs/internal/
The repository root carried seven markdown files that were not onboarding
material, plus two that had been superseded by the code they described. This
sorts them: reader-facing docs to docs/, working notes to docs/internal/, and
the two superseded ones merged into the docs that replaced them.

Moved to docs/:            WIDESCREEN.md, ENHANCEMENTS.md, TCP_COMMANDS.md
Moved to docs/internal/:   PRINCIPLES.md, ISSUES.md, DEBUG.md, GTE_LM_FIX.md,
                           and from docs/: bios-hardening.md, overlay-status.md,
                           overlay-plan.md, overlay-recompilation-design.md,
                           overlay-discovery.md, TOMBA2_EXC_CONSULT_RESPONSE.md,
                           CASE_A_AOT_GAP.md, audit_inventory.md
Moved to docs/internal/upstream/: UPSTREAM_2026-08-20.md

The root keeps only what belongs there: README.md, CONTRIBUTING.md, LICENSE,
CLAUDE.md, THIRD_PARTY_ATTRIBUTION.md, RELEASE_NOTES.md, the dotfiles and
psxrecomp_cli.py.

MERGES

SPLITGEN_MIGRATION.md folded into docs/BUILDING.md as "Split generated C". Its
migration instructions were stale in a way that mattered: it told every game
repo to hand-edit its CMakeLists and add a file(GLOB ...) over
<serial>_full*.c, but runtime/runtime.cmake now does that itself. GEN_FULL_GLOB
is a multi-value argument of psxrecomp_add_game_runtime(); the loop at
runtime.cmake:1985 makes each pattern absolute against CMAKE_CURRENT_SOURCE_DIR,
expands it with file(GLOB), and concatenates the hits into
GAME_GENERATED_FULL_C. So a title names the pattern and gets however many shards
a regeneration produced. The rewritten section describes that, the two-step
fallback when the globs match nothing (GEN_FULL_FALLBACK, else <serial>_full.c
derived from the dispatch marker by substituting _dispatch.c), and the one
caveat the code actually has: that file(GLOB) is plain, not CONFIGURE_DEPENDS,
so a regeneration which changes the shard COUNT needs a re-configure to be seen.

psxrecomp-toml-readme.md folded into docs/GAME_PROJECT_SETUP.md as "EXE-only
autofill (psxrecomp-toml)", placed after "Disc autofill (probe_disc.py)" and
before "Project Studio" so the two autofill paths sit together. Its documented
flags were checked against the usage text in recompiler/src/main_toml.cpp:28-42
and against the argument parser at :150-165 -- all seven options match with no
drift, so the flag list is reproduced as-is. Added a pointer that probe_disc.py
is preferable when a cue exists, since that tool does the same EXE-header work
plus disc identity and netplay gates.

FUNCTIONAL FIXES

tools/gen_tcp_commands.py wrote to REPO/"TCP_COMMANDS.md". After the move that
path does not exist, so the generator would have created a new stray root file
and --check would have failed against it forever. Retargeted to
REPO/"docs"/"TCP_COMMANDS.md", along with the seven docstring and message
strings that name the path.

Running it surfaced two further problems, both fixed here:

  * The doc was genuinely stale -- pre-existing drift, not introduced by this
    commit (the moved file is byte-identical to origin/master, and no
    debug-server command table is touched here). Four commands registered since
    the last regeneration were missing from the index -- cdrom_timing_dump,
    savestate_status, ws_ui_groups, xprobe_watch -- and scanline had gained a
    backend. Regenerated: 307 -> 311 commands, and the change is confined to the
    AUTOGEN block (the hand-written head and tail are byte-identical to master).
    tools/gen_tcp_commands.py --check now exits 0.
  * DOC.write_text() has no newline argument, so Python translated every newline
    to os.linesep. On Windows that rewrote all 585 lines of the file to CRLF and
    turned a four-line index update into a whole-file diff -- measured: 589 CRLF
    / 0 LF after a run, against 0 CRLF / 585 LF in the repo. Now written through
    an explicit newline="" handle, verified to leave the file at 0 CRLF.

runtime/include/debug_server.h:9 and runtime/src/debug_server.c:8 cited "TCP.md
and DEBUG.md". TCP.md has never existed in this repo under that name; both now
name docs/TCP_COMMANDS.md and docs/internal/DEBUG.md.

LINK AND REFERENCE FIXES

Every inbound reference to a moved file was located by grepping each basename
across the whole tracked tree, not just the markdown. Markdown hrefs in
README.md, CONTRIBUTING.md, docs/ARCHITECTURE.md, docs/COMPILING_OVERLAYS.md,
docs/AOT_OVERLAY_PLAN.md, docs/RELOCATION_MANIFEST_FORMAT.md,
docs/config_schema.md, docs/OVERLAY_XREF.md, docs/TCP_COMMANDS.md and several
docs/internal/ files now point at the new locations; where two files became
siblings under docs/internal/ the path was shortened rather than lengthened
(bios-hardening.md's reference to overlay-discovery.md, for instance).
docs/COMPILING_OVERLAYS.md's "in this folder" phrasing was wrong once two of the
three files it listed moved, so it now names internal/ explicitly.

24 source-comment mentions of ENHANCEMENTS.md sections G1.x across 19 files
(recompiler, runtime, cmake) were retargeted to docs/ENHANCEMENTS.md with the
section numbers untouched. docs/SHADOW_ENHANCEMENTS.md is a DIFFERENT file and
was deliberately excluded.

20 rationale strings citing docs/CASE_A_AOT_GAP.md across the four
recompiler/seeds/*.json files were updated. Done as a byte-level substring
replacement rather than a JSON round-trip: two of those files are stored with
CRLF endings and two with LF, and re-serializing them reformatted 5,700 lines.
The byte-level version changes exactly 20 lines and each file still parses.

References that look similar but point elsewhere were deliberately left alone,
and are worth naming so a future pass does not "fix" them:

  * "recomp-template PRINCIPLES.md" / "NES recomp template PRINCIPLES.md" in
    CLAUDE.md:43, docs/SHADOW_ENHANCEMENTS.md:28,
    docs/internal/HLE_SCHEDULER_CARVEOUT_PLAN.md:5,
    runtime/src/debug_server.c:4934 and tools/parity_diff.py:8 are a different
    repository's file. Only the five that mean this repo's PRINCIPLES.md were
    updated.
  * Every remaining bare ISSUES.md mention is a GAME repo's tracker
    (MegaManX6Recomp 2/7/8/9, TombaRecomp 6), not this repo's.
  * docs/disc-speed.md:4,54,56 and docs/internal/bios-hardening.md:5 name
    overlay-discovery as a BRANCH, not a file, so no path applies.

INDEXES

README.md's "New here?" table gains rows for docs/WIDESCREEN.md,
docs/ENHANCEMENTS.md and docs/TCP_COMMANDS.md. docs/internal/README.md gains
sections indexing all fourteen documents that moved in, plus an "Upstream
contributor reviews" section describing upstream/ and the new sweep file, plus a
"Removed" bullet for CYCLE_TIMING_ARCH.md (deleted in the previous commit)
pointing at FAITHFUL_TIMING_PLAN.md, CYCLE_MODEL_BEETLE.md and
PRECISE_IRQ_SLICE.md -- following the SLJIT_PERSIST_CACHE.md precedent already
in that file.

docs/ENHANCEMENTS.md:7 claimed framework bugs live in "game repos' ISSUES.md
until a framework tracker exists". A framework tracker does exist; it now says
so and names the Beads epic.

VERIFICATION

A link checker was written to scan every tracked *.md for relative links,
resolving each against the tree being scanned. Baseline at origin/master: 129
files, 137 relative links, 3 broken. After both commits: 127 files, 159 relative
links, 3 broken -- the SAME three, all pre-existing and untouched here:

    docs/DATA_SHARDS.md -> INSTANT_LOADS_PARKED.md   (never existed)
    docs/DATA_SHARDS.md -> INSTANT_LOADS_SPIKE2.md   (never existed)
    docs/NETPLAY.md     -> ../lib/recomp-net/README.md  (inside a submodule)

Zero new broken links. The checker's own coverage was checked against a raw grep
for markdown link openers: the 3-link difference is C++ lambdas inside code
blocks, correctly not treated as links.

Also verified: py_compile over all 113 tracked tools/*.py plus psxrecomp_cli.py;
all four seed JSONs still parse; the test-registration guard still reports 123
test files all registered; recompiler/tests/test_coverage_vault.py still passes;
and no file in this commit had its line endings flipped (checked mechanically
across all 50 modified files, after two files were caught and redone).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-03 07:39:07 -07:00

5.1 KiB

Recomp GPT consult response — Tomba 2 EPC de-overload (2026-06-22)

Verbatim design response from the Recomp GPT (thread "Recomp - Tomba 2 Debugging Analysis"). Converges on Option A as a scoped dual-mode exception system, with safety rails. Implementation reference for the fix.

Core: hard resume-mode split

compiled/native interrupted context:
  EPC = sentinel
  resume = host longjmp + host GPR restore        (UNCHANGED — T1/MMX6/Ape)

dirty-interpreter interrupted context:
  EPC = real guest PC
  resume = architectural cpu->pc = EPC
  no sentinel dependency, no host GPR restore

An explicit PsxExceptionResumeMode { NATIVE_SENTINEL, DIRTY_REAL_EPC } on an exception frame. At delivery: if the interrupt source is a dirty-interp safe point, mode=DIRTY_REAL_EPC, EPC = cpu->pc (the committed next guest PC), do NOT make EPC a host token (GPR snapshot optional, diagnostics only). Else mode=NATIVE_SENTINEL, EPC=0x80000048, save GPRs for host restore (as today).

ReturnFromException becomes mode-driven:

  • DIRTY_REAL_EPC: in_exception=false; cpu->pc = cop0_epc; restore dispatch_depth; pop frame; return to dispatcher/dirty re-entry (NO host longjmp, NO host GPR restore — trust the guest handler's TCB save/restore).
  • NATIVE_SENTINEL: restore GPRs from host snapshot; restore dispatch_depth; pop frame; psx_exception_longjmp() (as today).
  • No active frame + EPC is a real guest PC: cpu->pc = cop0_epc; in_exception=false (async/game-driven RFE — the Tomba 2 case).
  • No active frame + EPC == sentinel: INVALID — latch RFE_SENTINEL_ESCAPED / fatal. Do NOT silently NOP the sentinel (that's the current bug's escape hatch).

Q1 — host GPR save/restore on the dirty path?

For the RFE exit: NO. Trust the guest/BIOS handler's architectural TCB save+restore. Host-restoring GPRs after that risks undoing legitimate handler work or masking a broken restore. Keep the host snapshot as a diagnostic latch only. A handler returning normally (non-RFE) in dirty-real-EPC mode should be a diagnostic failure / guarded legacy fallback, not the expected path.

Q2 — drop the in_exception gate?

NOT globally. Scope the sentinel longjmp strictly to EPC==sentinel && mode==NATIVE_SENTINEL && frame.active. Allow async/game-driven RFE when EPC is a real PC even if in_exception==0 (resume via cpu->pc=EPC).

Q3 — dispatch-depth / nested dirty-pump hazard

Real-EPC is safer than sentinel here, but enforce entry preconditions for dirty delivery: cpu->pc committed to the precise next guest insn; no half-executed insn; not between branch and delay slot unless BD/EPC modeled; dirty local state written back to cpu; no active dirty local-flow frame expecting a host C return; dispatch_depth saved. Block nested dirty-pump entry:

if (cpu->in_exception || cpu->exception_depth > 0) {
    cpu->pending_interrupt_after_exception = true;
    return;
}

Keep g_psx_dispatch_depth save/restore in BOTH modes.

Q4 — Option A vs B

Option A (lower risk). Option B (force the game handler inside our window) keeps EPC overloaded/fragile and still relies on host timing/lifetime semantics; Tomba 2 is showing a valid PSX pattern (HookEntryInt handler that calls ReturnFromException itself). A fixes the abstraction: dirty interp HAS a real guest PC → EPC should be real → RFE can be architectural. Scoped to dirty safe points; compiled-native unchanged.

Per-title failure modes to watch

  • Tomba 1: if a T1 interrupt is delivered from dirty interp and previously relied on host GPR restore, real-EPC could expose a BIOS handler context-restore bug. Expect T1 to stay mostly native-sentinel, or dirty-real-EPC resumes with real PCs and no sentinel async RFE.
  • MMX6: tighter interrupt timing / delay-slot-adjacent poll points → real EPC could be off by one control-flow unit. Mitigation: only allow DIRTY_REAL_EPC at poll boundaries NOT in delay-slot state, OR correctly set CAUSE.BD and EPC=branch_pc when interrupted in a delay slot.
  • Ape Escape: nested interrupt depth / dispatch-depth imbalance. Assert exception_depth never exceeds 1 unless explicitly supported; assert dispatch_depth before==after RFE; assert no sentinel EPC reaches the guest TCB on the dirty path.

Confirmation probe (paired ledger, always-on)

EXC_ENTRY{frame,cycle,mode,source(native/dirty),cpu_pc_before,epc_written,ra,sp, dispatch_depth,in_exception_before} → TCB_SAVE{saved_epc,saved_ra,saved_sp} → RFE_CALL{caller_pc,t1,in_exception,epc,ra,sp,mode,dispatch_depth} → RFE_EXIT{action=real_pc_resume|sentinel_longjmp|invalid_sentinel, pc_after,ra_after, sp_after,dispatch_depth_after}. Success for Tomba 2: EXC_ENTRY mode=DIRTY_REAL_EPC, epc_written=real pc; TCB_SAVE saved_epc=same real pc; RFE_CALL in_exception may be 0, epc=real pc; RFE_EXIT action=real_pc_resume; no dispatch pc=0 exit. Hard tripwire: if (EPC==0x80000048 && !active_native_sentinel_frame) latch RFE_SENTINEL_ESCAPED.

Bottom line

Make the sentinel less permissive and explicitly host-only. The bug is a host token escaping into guest-visible EPC/TCB state; the fix prevents that escape anywhere a real guest PC exists.