Files
BFM-decomp/tools/masked_diff.py
T
Drew T eec96f76a4 feat(phase-29 Task-12): structured failure telemetry + durable permuter-winner save
The permuter-autopsy prerequisite (Drew-directed). Captures the WHAT/WHERE of every
non-match so the classifier/autopsy (Task-13) can mine it, not just a scalar closeness:
- masked_diff.structured_diff(): the per-instruction masked residual [(idx,mine,tgt),...]
- match_one --json: emits {status,closeness,nins,residual} (refactored to share the primitive)
- backlog FIELDS += residual, passes_tried
- gate_stage.match_one_closeness returns + logs the residual on every near/fail (verified
  end-to-end: a near-miss's structured residual now lands in backlog.jsonl)
- grinder: durably save the winning C to .run/permuter-winners/ BEFORE gate_stage banks
  (this session's lesson — 3 permuter wins were lost to a mid-flight revert)
2026-07-20 19:50:14 -06:00

241 lines
12 KiB
Python

#!/usr/bin/env python3
"""masked_diff.py — the shared relocation-masked instruction oracle (BFM Phase 24 T2).
The single source of truth for "how close are two MIPS objects, ignoring link-time relocations."
Factored out of tools/match_one.py so match_one AND the permuter's MaskedScorer (tools/masked_scorer.py)
use ONE masking rule — and upgraded to `objdump -drz` so runs of nops are NOT collapsed (the `-dr`
nop-elision that under-counted GTE-heavy seeds, e.g. func_80132784 read as 384 ins instead of 400).
The mask (identical to the psyq_identify / match_one rule):
* jal / j (opcode>>26 in {2,3}) or any R_MIPS_*_26 reloc -> ignore the whole 26-bit target field
* R_MIPS_HI16 / R_MIPS_LO16 -> ignore the 16-bit immediate (linker fills it)
* everything else -> compare the full 32-bit word
Two compare modes:
* OBJECT vs OBJECT (the permuter: both target.o and cand.o carry relocs) — mask driven by the target's
relocs, AND require reloc-operand (symbol+addend) equality at masked positions. This is STRICTER than
match_one: a jal to the wrong symbol scores a mismatch (match_one, comparing against a resolved .s,
can't see the symbol). A masked count of 0 here ⟺ the two functions link to identical bytes.
* OBJECT vs splat .s (match_one: the target .s is RESOLVED, no relocs) — mask driven by MY object's
relocs, applied to both words; symbol-agnostic (the .s word is already the final linked value).
Neither mode is the byte-gate: the whole-binary rebuild (tools/harvest_verify.py) is the sole arbiter
(G3/P9). These masked metrics only rank candidates / measure closeness.
"""
import os
import re
import struct
import subprocess
import cdecl # the C-declaration oracle — the shared typedef-strip primitive (Phase-27 T4)
OBJDUMP = "mipsel-linux-gnu-objdump"
_HDR_RE = re.compile(r"^[0-9a-f]+ <([^>]+)>:")
_INS_RE = re.compile(r"\s+[0-9a-f]+:\s+([0-9a-f]{8})\s+(.*)")
_REL_RE = re.compile(r"R_MIPS_(\w+)\s+(\S+)")
# scalar/M2C typedef REDEFINITIONS common.h already provides (C89 rejects the dup). match_one and the
# permuter compile a draft in ISOLATION with `#include "common.h"` prepended, so the strip-set is
# exactly what common.h provides — derived from the header once (R33), never a hand-kept name list.
# DEPRECATED: SCALAR_TYPEDEF_RE (its `[^;]*` body cannot cross a `;`, so a multi-typedef LINE stripped
# NONE and the isolated compile then failed on the dup — 42 masked-MATCH drafts discarded over
# whitespace). Kept only as a fallback if the header probe can't run; strip_scalar_typedefs is correct.
SCALAR_TYPEDEF_RE = re.compile(
r"^[ \t]*typedef\b[^;]*\b(u8|u16|u32|u64|s8|s16|s32|s64|f32|f64|"
r"M2C_UNK|M2C_UNK8|M2C_UNK16|M2C_UNK32|M2C_UNK64)[ \t]*;[ \t]*\n",
re.M,
)
_COMMON_TD = None
def _common_typedefs():
"""The typedef names common.h provides — derived from the header once, cached. This is the
strip-set for an ISOLATED compile (match_one / the permuter prepend common.h). Falls back to the
deprecated regex's name set if the cpp probe can't run (offline / no toolchain)."""
global _COMMON_TD
if _COMMON_TD is None:
probe = os.path.join(cdecl.REPO, "src", ".masked_diff_probe.c")
try:
with open(probe, "w") as f:
f.write('#include "common.h"\n')
_COMMON_TD = frozenset(cdecl.typedef_names(probe))
except Exception:
_COMMON_TD = frozenset("u8 u16 u32 u64 s8 s16 s32 s64 f32 f64 "
"M2C_UNK M2C_UNK8 M2C_UNK16 M2C_UNK32 M2C_UNK64".split())
finally:
if os.path.exists(probe):
os.remove(probe)
return _COMMON_TD
def strip_scalar_typedefs(text):
"""Strip the scalar/M2C typedef redefinitions common.h provides, splitting multi-typedef lines
correctly (the T4 primitive). Keeps the draft's OWN custom struct/fn-ptr typedefs — common.h
doesn't provide those, and an isolated compile needs them. Replaces SCALAR_TYPEDEF_RE.sub('', …)."""
return cdecl.strip_provided_typedefs(text, _common_typedefs())
def _reloc_kind(name):
if "26" in name:
return "26"
if "HI16" in name:
return "HI16"
if "LO16" in name:
return "LO16"
if "PC16" in name: # R_MIPS_PC16 — see mask_for() (Phase 26-A audit)
return "PC16"
return name
def mask_for(word, reloc_kind):
"""The compare mask for one instruction word given its reloc kind (or None).
R_MIPS_PC16 (Phase 26-A audit). An over-approximating sweep of every reloc type `objdump -drz`
emits across all 3,367 real build objects found EXACTLY FOUR: R_MIPS_26 (1,090,661), R_MIPS_HI16
(633,662), R_MIPS_LO16 (633,437) — and R_MIPS_PC16 (211). The table handled three. PC16 fell
through to a FULL-WORD compare, but the object holds an UNRESOLVED PLACEHOLDER in the branch
displacement, so that compare can never succeed:
build/src/libgs6.o func_80053E28 MINE 1040ffff (beqz v0,388) TGT 10400018 (beqz $v0, GS_123…)
^^^^ placeholder ^^^^ real displacement
THE DECISIVE TEST — derived from the proven invariant, not from reading the regex: INCLUDE_ASM
pastes the ORIGINAL assembly, so for EVERY stub the build object's bytes ARE the target .s bytes,
and diff_object_s() MUST return 0. Run over all 60,740 stubs it returned 0 for 60,585 — and LIED
on 155.
Why a lying closeness oracle is worse than a slow one: every crack agent trusts this number. A
phantom non-zero sends an agent to grind at a wall that is not there, and the wasted attempt is
then booked into the backlog as a MATCHING failure, which feeds reserved_walls() and PERMANENTLY
BLACKLISTS a function that was never actually broken. A silent skip compounding into a false wall
— the same mechanism that made nine byte-exact functions look like an intrinsic compiler wall.
Masking PC16 exactly like HI16/LO16 (keep opcode+regs, drop the linker-filled displacement) cures
151 of the 155 and introduces ZERO new lies across all 60,740 functions (auditor's counterfactual,
independently re-run by a skeptic). The 4 survivors are a separate length-delta defect."""
if (word >> 26) in (2, 3): # jal / j — the 26-bit target is a link-time value
return 0
if reloc_kind == "26":
return 0
if reloc_kind in ("HI16", "LO16", "PC16"):
return 0xFFFF0000 # keep opcode+regs, drop the linker-filled immediate/displacement
return 0xFFFFFFFF
def insns_from_object(obj, fn=None):
"""objdump -drz an object's .text -> [{word, mnem, reloc_kind, reloc_op}]. -z keeps nop runs
(no collapse). fn: restrict to that <function> label; None = all .text (a one-function object)."""
out = subprocess.run([OBJDUMP, "-drz", "-j", ".text", obj],
capture_output=True, text=True).stdout
insns = []
infn = fn is None
for line in out.splitlines():
h = _HDR_RE.match(line)
if h:
infn = (fn is None) or (h.group(1) == fn)
continue
if not infn:
continue
mi = _INS_RE.match(line)
if mi:
insns.append({"word": int(mi.group(1), 16), "mnem": mi.group(2).strip(),
"reloc_kind": None, "reloc_op": None})
elif insns:
rm = _REL_RE.search(line)
if rm:
insns[-1]["reloc_kind"] = _reloc_kind(rm.group(1))
insns[-1]["reloc_op"] = rm.group(2)
# fn given but nothing matched (unlabeled .text) -> fall back to the whole section
if fn is not None and not insns:
return insns_from_object(obj, None)
return insns
def insns_from_s(s_path):
"""splat .s -> [{word, mnem, reloc_kind:None, reloc_op:None}] from each `/* off vaddr LEHEX */ mnem`
line. The target is RESOLVED (no relocs); the mask is driven by MY object's relocs at compare time."""
insns = []
for line in open(s_path, errors="replace"):
mi = re.match(r"\s*/\*\s*[0-9A-Fa-f]+\s+[0-9A-Fa-f]+\s+([0-9A-Fa-f]{8})\s*\*/\s+(.*)", line)
if mi:
insns.append({"word": struct.unpack("<I", bytes.fromhex(mi.group(1)))[0],
"mnem": re.sub(r"\s+", " ", mi.group(2).strip()),
"reloc_kind": None, "reloc_op": None})
return insns
def structured_diff(mine, tgt):
"""The per-instruction relocation-masked mismatch list: [(idx, mine_str, tgt_str), ...] over
two insns_from_* streams. Each entry is a mismatching instruction position; mine_str/tgt_str are
'<word_hex> <mnemonic>' (or '--' past the end of the shorter stream). len() == the masked mismatch
count (the `closeness`). This is the STRUCTURED RESIDUAL telemetry the permuter-autopsy classifier
reads (Phase-29 Task-12): idx localizes the residual, the word+mnem pair says what codegen differs
(a reg-alloc swap, a scheduled-order flip, an extra/absent instruction). Shared by match_one +
gate_stage's near-record so the same residual an agent reads is the one the autopsy mines."""
n = max(len(mine), len(tgt))
diffs = []
for i in range(n):
mw = mine[i]['word'] if i < len(mine) else None
mask = mask_for(mine[i]['word'], mine[i]['reloc_kind']) if i < len(mine) else 0xFFFFFFFF
me = (mw & mask) if mw is not None else None
tg = (tgt[i]['word'] & mask) if i < len(tgt) else None
if me != tg:
diffs.append((i,
('%08x %s' % (mine[i]['word'], mine[i]['mnem'])) if i < len(mine) else '--',
('%08x %s' % (tgt[i]['word'], tgt[i]['mnem'])) if i < len(tgt) else '--'))
return diffs
def diff_object_object(cand, tgt):
"""masked mismatch count between two objdump'd objects (permuter scorer). Mask driven by the
TARGET's relocs; at masked reloc/jal positions also require reloc-operand (symbol+addend) equality.
Length delta counts as mismatches (a wrong-instruction-count draft scores high). 0 ⟺ same linked bytes."""
n = max(len(cand), len(tgt))
diffs = 0
for i in range(n):
if i >= len(cand) or i >= len(tgt):
diffs += 1
continue
c, t = cand[i], tgt[i]
m = mask_for(t["word"], t["reloc_kind"])
if (c["word"] & m) != (t["word"] & m):
diffs += 1
continue
if m == 0 or m == 0xFFFF0000: # a masked reloc/jal slot -> the symbol+addend must also match
if (c["reloc_op"] or "") != (t["reloc_op"] or ""):
diffs += 1
return diffs
def diff_object_s(myobj, tgt_s):
"""match_one semantics: mask driven by MY object's relocs, applied to both words; symbol-agnostic
(the .s target is already resolved). Returns the masked mismatch count."""
n = max(len(myobj), len(tgt_s))
diffs = 0
for i in range(n):
if i >= len(myobj) or i >= len(tgt_s):
diffs += 1
continue
c, t = myobj[i], tgt_s[i]
m = mask_for(c["word"], c["reloc_kind"])
if (c["word"] & m) != (t["word"] & m):
diffs += 1
return diffs
if __name__ == "__main__": # spot-check: masked_diff.py <a.o> <b.o|.s> [fn]
import sys
a = sys.argv[1]
b = sys.argv[2]
fn = sys.argv[3] if len(sys.argv) > 3 else None
ai = insns_from_object(a, fn)
if b.endswith(".s"):
print(f"object-vs-.s: {diff_object_s(ai, insns_from_s(b))} mismatched "
f"(mine={len(ai)} ins, target={len(insns_from_s(b))})")
else:
bi = insns_from_object(b, fn)
print(f"object-vs-object: {diff_object_object(ai, bi)} mismatched "
f"(a={len(ai)} ins, b={len(bi)})")