Files
goldeneye-pc-port/tools_pc/verify.sh
T
James Dansereau 4b38c2566e D478-D490: crash log, session start, performance, fidelity, regions
Crash-log snprintf (D478), start-mp folder (D479), shader pre-warm (D480),
render worker thread (#92 low-end 45 to 60 fps, D481), lighter first-launch
defaults (D482), sniper crouch/zoom fixes (D483-D485, #136), Rareware text
TMEM swap (D75), D173 residual, turret/explosion fidelity (D486, #126),
21-level Windows golden rebase with a two-tier gate, PAL and JP convert/build/
boot (D258) with PAL frame height (D487) and osTvType (D488).

Refs: D478 D479 D480 D481 D482 D483 D484 D485 D486 D75 D173 D258 D487 D488 #136 #126
2026-10-06 18:35:42 -04:00

415 lines
17 KiB
Bash

#!/bin/bash
# verify.sh — one command -> one machine-readable verdict (speed-ups plan Step 2).
#
# Wraps the manual recipe every session was re-deriving by hand (build,
# 640x480 ini pin, GE_PCDUMP capture, crash-symbolication, pixcount,
# framediff): see docs/dev/notes/AGENTIC-SPEEDUPS-PLAN.md Step 2 / N6.
#
# Usage:
# verify.sh <level> single level: name (dam, bunker1, "surface 1")
# or -level_XX number (09, 33, ...)
# verify.sh sweep [subset] all 21 solo levels, or SWEEP_LEVELS-style
# "name:XX name:XX ..." subset
# verify.sh parity <level> --against <dir>
# framediff this platform's capture against a
# capture directory from the other platform
# (there is no cross-OS launch here — feed it
# a directory of PPMs/PNGs pulled off that box)
#
# Options:
# --platform win|linux default: autodetect via `uname -s`
# --dump lo-hi:step GE_PCDUMP window (default: 900-1500:300, the golden
# capture window for every level and both modes)
# --script "..." GE_INPUTSCRIPT (default "20:START": skip the intro
# flyby so frame 900+ is settled gameplay)
#
# Golden recipe (2026-10-02 re-base): 640x480 defaults-only ini, GE_RSEED pinned
# (GOLDEN_SEED below), GE_INPUTSCRIPT "20:START", GE_PCDUMP 900-1500:300,
# goldens in tools_pc/golden/<level>/<platform>/. See tools_pc/golden/README.md.
# --json also emit one JSON object (or array, for sweep) to
# stdout: {level, platform, status, frames,
# worst_cell, crash_sym}
# --against DIR parity mode only: the other platform's capture dir
#
# Status values: PASS | CRASH | NO-FRAMES | STALLED | REGRESSION
# (STALLED is this tool's extension of the plan's 4-value enum — see
# level_sweep.sh's D117/D134 note: a level that renders a few frames then
# stops moving is a load-sensitivity flake, not a real pass or fail.)
#
# Known limitation (N6 / M-48): on --platform linux, GE_PCDUMP reads back
# black frames on llvmpipe/WSLg (a glReadPixels tooling bug, not a render
# bug — the live window renders fine). pixcount/framediff are therefore
# skipped on linux and the verdict is crash-detection only, flagged NOTE.
set -u
cd "$(dirname "$0")/.."
ROOT="$(pwd)"
# --- arg parsing -------------------------------------------------------------
MODE=""; LEVEL_ARG=""; PLATFORM=""; DUMP=""; SCRIPT="20:START"; JSON=0; AGAINST=""
GOLDEN_DUMP="900-1500:300"
USER_DUMP=0; USER_SCRIPT=0
# Per-level golden recipe overrides: Cuba is the ending cutscene + credits (it
# drops back to the boot screens before frame 1200, and START would skip it),
# so it captures the cutscene itself with no input.
golden_dump_for() { case "$1" in cuba) echo "300-900:300" ;; *) echo "$GOLDEN_DUMP" ;; esac; }
# Second tier: per-pixel (framediff --exact) limit, % of pixels over a
# per-channel tolerance of 2. Measured 2026-10-02 run to run (21 levels x 2
# captures): <= 0.57% everywhere except Jungle 1.75% / Surface 2 2.33% (moving
# foliage/fog) and Cuba 36% (cutscene animation timing; structural tier only).
# A global texture-filter change measured 22% on Dam, so 1% leaves ~2x margin
# over the noise and still catches whole-frame render changes.
golden_tolpct_for() { case "$1" in cuba) echo "" ;; jungle|surface2) echo "3.0" ;; *) echo "1.0" ;; esac; }
golden_script_for() { case "$1" in cuba) echo "1:SNONE" ;; *) echo "20:START" ;; esac; }
GOLDEN_SEED="${GE_RSEED:-0x0123456789abcdef}"
POSARGS=()
while [ $# -gt 0 ]; do
case "$1" in
--platform) PLATFORM="$2"; shift 2 ;;
--dump) DUMP="$2"; USER_DUMP=1; shift 2 ;;
--script) SCRIPT="$2"; USER_SCRIPT=1; shift 2 ;;
--against) AGAINST="$2"; shift 2 ;;
--json) JSON=1; shift ;;
-h|--help) sed -n '2,32p' "$0"; exit 0 ;;
*) POSARGS+=("$1"); shift ;;
esac
done
set -- "${POSARGS[@]:-}"
case "${1:-}" in
sweep) MODE=sweep; shift; SWEEP_SUBSET="${*:-}" ;;
parity) MODE=parity; LEVEL_ARG="${2:-}"; shift 2 2>/dev/null || true ;;
""|-h) sed -n '2,32p' "$0"; exit 0 ;;
*) MODE=single; LEVEL_ARG="$1" ;;
esac
if [ -z "$PLATFORM" ]; then
case "$(uname -s)" in
Linux*) PLATFORM=linux ;;
*) PLATFORM=win ;;
esac
fi
if [ "$PLATFORM" = win ]; then
BUILD_DIR=build-pc
EXE="$ROOT/build-pc/ge007.x86_64.exe"
export PATH="/c/msys64/mingw64/bin:$PATH" # addr2line + runtime DLLs
else
BUILD_DIR=build-linux
EXE="$ROOT/build-linux/ge007.x86_64"
fi
# Only ever stop the game process THIS script started (never other instances:
# the maintainer may be playing), and only as a watchdog fallback -- every run
# normally ends through GE_QUITFRAME's orderly quit (D344: a hard kill of a
# live GL/audio process has caused a host BSOD).
GAMEPID=""
kill_ours() { [ -n "$GAMEPID" ] && kill "$GAMEPID" >/dev/null 2>&1; GAMEPID=""; }
# name -> -level_XX (mission order; matches playtest.sh / level_sweep.sh)
LEVELS=(
"dam:33" "facility:34" "runway:35" "surface1:36" "bunker1:09" "silo:20"
"frigate:26" "surface2:43" "bunker2:27" "statue:22" "archives:24"
"streets:29" "depot:30" "train:25" "jungle:37" "control:23" "caverns:39"
"cradle:41" "aztec:28" "egypt:32" "cuba:54"
)
norm() { echo "$1" | tr 'A-Z' 'a-z' | tr -d ' _-'; }
resolve_level() {
local arg="$1"
if [[ "$arg" =~ ^[0-9]+$ ]]; then echo "num:$(printf '%02d' "$arg")"; return; fi
local key; key=$(norm "$arg")
for e in "${LEVELS[@]}"; do
[ "$(norm "${e%%:*}")" = "$key" ] && { echo "${e%%:*}:${e##*:}"; return; }
done
echo ""
}
name_for_num() {
local num="$1"
for e in "${LEVELS[@]}"; do [ "${e##*:}" = "$num" ] && { echo "${e%%:*}"; return; }; done
echo "level_$num"
}
# --- build-if-stale ------------------------------------------------------
if [ ! -d "$BUILD_DIR" ]; then
echo "error: $BUILD_DIR missing — configure it first (./build-pc.sh for win;" >&2
echo " cmake -S . -B build-linux -G Ninja -DROMID=ntsc-final for linux)" >&2
exit 2
fi
BUILD_LOG=$(mktemp)
if ! cmake --build "$BUILD_DIR" -j 8 >"$BUILD_LOG" 2>&1; then
echo "BUILD FAILED"
cat "$BUILD_LOG" >&2
rm -f "$BUILD_LOG"
exit 2
fi
rm -f "$BUILD_LOG"
if [ ! -x "$EXE" ] && [ ! -f "$EXE" ]; then
echo "error: build produced no $EXE" >&2
exit 2
fi
# --- golden lookup: tools_pc/golden/<level>/<platform>/, else the flat
# level_09 set (today's only golden — Step 3 fills the rest in) ----------
golden_dir_for() {
local name="$1"
local per="$ROOT/tools_pc/golden/$name/$PLATFORM"
if [ -d "$per" ] && ls "$per"/*.png >/dev/null 2>&1; then echo "$per"; return; fi
echo ""
}
# --- ini pin: golden frames are captured at 640x480 with every other option
# at its compiled-in default (a personal ini -- FovScale, DrawDistance,
# MSAA... -- changes the frame and would fail the golden); back up + restore
INI="$ROOT/data/ge007.ini"
INI_BAK=""
INI_CREATED=0
pin_ini_640x480() {
if [ -f "$INI" ]; then
INI_BAK=$(mktemp)
cp "$INI" "$INI_BAK"
else
INI_CREATED=1
fi
printf '[Window]\nWidth = 640\nHeight = 480\n' > "$INI"
}
restore_ini() {
if [ -n "$INI_BAK" ]; then cp "$INI_BAK" "$INI" && rm -f "$INI_BAK"
elif [ "$INI_CREATED" = 1 ]; then rm -f "$INI"; fi
}
trap 'restore_ini; kill_ours' EXIT INT TERM
# --- run one level -> sets globals: R_STATUS R_FRAMES R_SYM R_BRIEF -------
run_one() {
local name="$1" num="$2" dump="$3" watchdog="${4:-90}"
local capdir; capdir=$(mktemp -d)
[ "$USER_DUMP" = 1 ] || dump=$(golden_dump_for "$name")
local script="$SCRIPT"
[ "$USER_SCRIPT" = 1 ] || script=$(golden_script_for "$name")
R_STATUS=""; R_FRAMES=0; R_SYM=""; R_BRIEF=""
rm -f "$ROOT/ge007.crash.log"
# Quit right after the last requested GE_PCDUMP frame via GE_QUITFRAME (an
# orderly D344 quit), instead of idling out the watchdog; the watchdog stays
# the safety net for a level that never gets there (hang / flake).
local lo hi step lastframe quitframe=""
IFS='-:' read -r lo hi step <<< "$dump"
if [[ "$lo" =~ ^-?[0-9]+$ && "$hi" =~ ^-?[0-9]+$ ]]; then
[[ "$step" =~ ^[0-9]+$ && "$step" -gt 0 ]] || step=1
lastframe=$(( lo + step * ( (hi - lo) / step ) ))
quitframe=$(( lastframe + 2 ))
fi
( cd "$ROOT" && export GE_PCDUMP="$dump"
[ -n "$quitframe" ] && export GE_QUITFRAME="$quitframe"
[ -n "$script" ] && export GE_INPUTSCRIPT="$script"
export GE_RSEED="$GOLDEN_SEED"
exec "$EXE" "-level_$num" ) >"$capdir/run.log" 2>&1 &
local gamepid=$!
GAMEPID=$gamepid
local ticks=0 max_ticks=$(( watchdog * 5 )) # 0.2s ticks
while kill -0 "$gamepid" 2>/dev/null && [ "$ticks" -lt "$max_ticks" ]; do
sleep 0.2
ticks=$((ticks + 1))
done
if kill -0 "$gamepid" 2>/dev/null; then
echo " watchdog: $name still running after ${watchdog}s, stopping it" >&2
kill_ours
fi
wait "$gamepid" 2>/dev/null
GAMEPID=""
mv "$ROOT"/ppm "$capdir/ppm" 2>/dev/null || mkdir -p "$capdir/ppm"
R_FRAMES=$(ls "$capdir/ppm"/*.ppm 2>/dev/null | wc -l)
if [ -f "$ROOT/ge007.crash.log" ]; then
R_STATUS=CRASH
cp "$ROOT/ge007.crash.log" "$capdir/crash.log"
# Step 9 (R5): crash_brief.py owns address extraction + symbolication
# (both platforms -- the old inline `0x1[0-9a-fA-F]{8,}` grep here
# assumed the Windows 0x140000000 image base and would never match a
# Linux no-PIE 0x20000000-based address) and prints a dispatch-ready
# brief with known-parked-signature and porting-notes/findings hits.
R_BRIEF=$(python "$ROOT/tools_pc/crash_brief.py" \
--crash-log "$capdir/crash.log" --exe "$EXE" --platform "$PLATFORM" \
--level "$name" --json 2>&1)
R_SYM=$(echo "$R_BRIEF" | python -c "
import json,sys
s=sys.stdin.read(); i=s.find('{')
try:
d,_=json.JSONDecoder().raw_decode(s[i:]) if i>=0 else (None,0)
f=d['frames'][0]
print('%s %s' % (f.get('func') or '??', f.get('loc') or ''))
except Exception:
print('')
" 2>/dev/null)
elif [ "$R_FRAMES" -eq 0 ]; then
R_STATUS=NO-FRAMES
else
R_STATUS=PASS
fi
CAPDIR="$capdir"
}
# --- verdict emission --------------------------------------------------------
emit_verdict() {
local name="$1" status="$2" frames="$3" worst="$4" sym="$5" note="${6:-}"
echo "$name: $status frames=$frames${worst:+ worst_cell=$worst}${sym:+ crash_sym=\"$sym\"}${note:+ ($note)}"
if [ "$JSON" = 1 ]; then
python3 - "$name" "$PLATFORM" "$status" "$frames" "$worst" "$sym" "$note" <<'EOF'
import json, sys
name, plat, status, frames, worst, sym, note = sys.argv[1:8]
obj = {"level": name, "platform": plat, "status": status, "frames": int(frames)}
if worst: obj["worst_cell"] = float(worst)
if sym: obj["crash_sym"] = sym
if note: obj["note"] = note
print(json.dumps(obj))
EOF
fi
}
verify_level() {
local name="$1" num="$2" dump="$3" watchdog="${4:-90}"
run_one "$name" "$num" "$dump" "$watchdog"
local status="$R_STATUS" frames="$R_FRAMES" sym="$R_SYM" worst="" note=""
if [ "$status" = PASS ]; then
if [ "$PLATFORM" = linux ]; then
note="GE_PCDUMP reads black on llvmpipe/WSLg — pixcount/framediff skipped, crash-detect only"
else
local last; last=$(ls "$CAPDIR"/ppm/*.ppm 2>/dev/null | tail -1)
if [ -n "$last" ] && ! python3 "$ROOT/tools_pc/pixcount.py" "$last" >/dev/null 2>&1; then
status=NO-FRAMES; note="frames present but all-clear (pixcount 0)"
else
local gdir; gdir=$(golden_dir_for "$name")
if [ -n "$gdir" ]; then
local fdiff; fdiff=$(python3 "$ROOT/tools_pc/framediff.py" "$CAPDIR/ppm" --golden "$gdir" --json 2>&1)
local fexit=$?
# framediff --json sandwiches the JSON blob between human-readable
# per-frame lines and a summary line -- pull it out by scanning
# from the first '{' with a raw JSON decoder instead of assuming
# the whole stream parses.
worst=$(echo "$fdiff" | python3 -c "
import json,sys
s = sys.stdin.read()
i = s.find('{')
try:
d, _ = json.JSONDecoder().raw_decode(s[i:]) if i >= 0 else (None, 0)
print(max((r.get('worst_cell',0) for r in d['results']), default=0))
except Exception:
print('')
" 2>/dev/null)
# exit 1 = a real per-frame threshold fail (pixel/cell/hash delta).
# exit 2 = a structural mismatch (missing/size) -- most commonly the
# golden's frame stems don't line up with this run's --dump window
# (goldens are captured at GOLDEN_DUMP; a
# sweep using a different stride has nothing to compare against
# rather than a real regression). Only exit 1 is a verdict fail.
case "$fexit" in
1) status=REGRESSION; note="framediff vs $gdir" ;;
2) note="golden frame stems don't match --dump window ($dump) for $gdir" ;;
esac
local tolpct; tolpct=$(golden_tolpct_for "$name")
if [ "$fexit" = 0 ] && [ -n "$tolpct" ]; then
local xout; xout=$(python3 "$ROOT/tools_pc/framediff.py" "$CAPDIR/ppm" --golden "$gdir" --exact --tol 2 --tol-pct "$tolpct" 2>&1)
if [ $? -eq 1 ]; then
status=REGRESSION
note="per-pixel: $(echo "$xout" | grep -m1 FAIL | sed 's/^FAIL //') (limit ${tolpct}%)"
fi
fi
else
note="no golden for $name/$PLATFORM yet (Step 3)"
fi
fi
fi
fi
local brief="$R_BRIEF"
if [ "$status" = NO-FRAMES ] && [ -f "$CAPDIR/run.log" ]; then
# stderr, not stdout: sweep mode captures verify_level's stdout via
# `out=$(...)` and only keeps its first line (`head -1`) as the verdict
# summary -- anything printed here on stdout would become that first
# line and clip the real verdict (and, worse, the --json line further
# down). stderr bypasses the capture and reaches the terminal/log file
# directly.
echo " -- $name run.log tail (NO-FRAMES, no crash -- likely startup/init failure) --" >&2
tail -n 30 "$CAPDIR/run.log" | sed 's/^/ | /' >&2
fi
rm -rf "$CAPDIR"
emit_verdict "$name" "$status" "$frames" "$worst" "$sym" "$note"
if [ "$status" = CRASH ] && [ -n "$brief" ]; then
# crash_brief.py's --json output sandwiches the JSON blob after the
# human-readable brief -- print only the brief part here.
echo "$brief" | awk '/^\{/{exit} {print}'
fi
case "$status" in PASS) return 0 ;; *) return 1 ;; esac
}
# --- dispatch ----------------------------------------------------------------
case "$MODE" in
single)
resolved=$(resolve_level "$LEVEL_ARG")
[ -z "$resolved" ] && { echo "unknown level '$LEVEL_ARG'" >&2; exit 2; }
name="${resolved%%:*}"; num="${resolved##*:}"
[ "${resolved%%:*}" = num ] && name=$(name_for_num "$num")
pin_ini_640x480 2>/dev/null || true
verify_level "$name" "$num" "${DUMP:-$GOLDEN_DUMP}"
;;
sweep)
RESULTS_JSON=()
RC=0
subset="${SWEEP_LEVELS:-${SWEEP_SUBSET:-}}"
entries=("${LEVELS[@]}")
[ -n "$subset" ] && read -ra entries <<< "$subset"
for e in "${entries[@]}"; do
n="${e%%:*}"; num="${e##*:}"
pin_ini_640x480 2>/dev/null || true
out=$(verify_level "$n" "$num" "${DUMP:-$GOLDEN_DUMP}" 60)
rc=$?
[ "$rc" -ne 0 ] && RC=1
# Pre-existing bug (found alongside D244's diagnostics): `head -1` here
# silently discarded emit_verdict's --json line (its 2nd line of
# output, starting with `{`) on every sweep run -- RESULTS_JSON above
# was declared for exactly this and never actually populated, so
# `--json` sweeps have never produced a usable verdict array; the
# workflow's "Extract JSON verdict" step (scans for the last `[{` in
# sweep.log) always got an empty `[]`.
echo "$out" | head -1
if [ "$JSON" = 1 ]; then
j=$(echo "$out" | grep -m1 '^{')
[ -n "$j" ] && RESULTS_JSON+=("$j")
fi
done
echo "SWEEP DONE"
if [ "$JSON" = 1 ] && [ "${#RESULTS_JSON[@]}" -gt 0 ]; then
{ printf '['
for i in "${!RESULTS_JSON[@]}"; do
[ "$i" -gt 0 ] && printf ','
printf '%s' "${RESULTS_JSON[$i]}"
done
printf ']\n'
}
fi
exit $RC
;;
parity)
[ -z "$LEVEL_ARG" ] && { echo "usage: verify.sh parity <level> --against DIR" >&2; exit 2; }
[ -z "$AGAINST" ] && { echo "parity needs --against DIR (the other platform's capture)" >&2; exit 2; }
resolved=$(resolve_level "$LEVEL_ARG")
[ -z "$resolved" ] && { echo "unknown level '$LEVEL_ARG'" >&2; exit 2; }
name="${resolved%%:*}"; num="${resolved##*:}"
pin_ini_640x480 2>/dev/null || true
run_one "$name" "$num" "${DUMP:-$GOLDEN_DUMP}" 90
if [ "$R_STATUS" != PASS ]; then
emit_verdict "$name" "$R_STATUS" "$R_FRAMES" "" "$R_SYM"
rm -rf "$CAPDIR"; exit 1
fi
python3 "$ROOT/tools_pc/framediff.py" "$CAPDIR/ppm" --golden "$AGAINST" --tol 2 --tol-pct 0.5 --exact ${JSON:+--json}
rc=$?
rm -rf "$CAPDIR"
exit $rc
;;
esac