romdevtools 0.30.0 → 0.40.0

package/src/analysis/decompile.js

@@ -0,0 +1,108 @@
+// decompile.js — drive the Ghidra decompiler WASM (romdev-analysis-decompiler)
+// to turn a function into C pseudocode. Runs the decompiler's REPL one-shot
+// through the isolated worker pool: mount the SLEIGH home + the ROM image,
+// feed `load file <langid> <rom>; map function <addr>; decompile; print C`.
+//
+// The ROM is loaded as a RAW binary at VMA 0 — so the address passed must be a
+// FILE OFFSET into the image we hand it, not a banked CPU address. Callers that
+// have a CPU address use the disasm mappers to slice the right bank first; for
+// the common flat/first-bank case the file offset equals the CPU address minus
+// the platform's load base (handled in analyze.js).
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import fs from "node:fs";
+import { runIsolated } from "../toolchains/_worker/run.js";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/** Resolve the decompiler package (or the gitignored src staging fallback). */
+function decompilerPaths() {
+  let base;
+  try {
+    base = path.dirname(fileURLToPath(import.meta.resolve("romdev-analysis-decompiler")));
+  } catch { base = null; }
+  const candidates = [
+    base && { js: path.join(base, "wasm", "decompile.js"), sleigh: path.join(base, "sleigh") },
+    { js: path.join(__dirname, "decompiler", "wasm", "decompile.js"), sleigh: path.join(__dirname, "decompiler", "sleigh") },
+  ].filter(Boolean);
+  for (const c of candidates) if (fs.existsSync(c.js)) return c;
+  throw new Error(
+    "decompiler not found: install romdev-analysis-decompiler or run scripts/build-decompiler.sh"
+  );
+}
+
+/** romdev platform → Ghidra SLEIGH language id. null = not decompilable yet. */
+export const SLEIGH_LANGID = {
+  nes: "6502:LE:16:default",
+  atari2600: "6502:LE:16:default",
+  atari7800: "6502:LE:16:default",
+  c64: "6502:LE:16:default",
+  lynx: "65C02:LE:16:default",
+  sms: "z80:LE:16:default",
+  gg: "z80:LE:16:default",
+  msx: "z80:LE:16:default",
+  gb: "SM83:LE:16:default",
+  gbc: "SM83:LE:16:default",
+  gba: "ARM:LE:32:v4t",
+  genesis: "68000:BE:32:default",
+  snes: "65816:LE:24:snes",
+  pce: "HuC6280:LE:16:default",
+};
+
+/**
+ * Decompile the function at `fileOffset` in `romBytes` for `platform`.
+ * @returns {{platform, langid, address, code, warnings:string[], raw:string}}
+ */
+export async function decompileFunction({ platform, romBytes, fileOffset, name = "fn_target" }) {
+  const langid = SLEIGH_LANGID[platform];
+  if (!langid) throw new Error(`decompile: no SLEIGH language for platform '${platform}'`);
+  const { js, sleigh } = decompilerPaths();
+  const addr = "0x" + (fileOffset >>> 0).toString(16);
+
+  // REPL script. RawBinary loads at vma 0; `print C` emits the pseudocode.
+  const script = [
+    `load file ${langid} /work/rom.bin`,
+    `map function ${addr} ${name}`,
+    `decompile ${name}`,
+    `print C`,
+    `quit`,
+    "",
+  ].join("\n");
+
+  const res = await runIsolated({
+    gluePath: js,
+    argv: [],
+    env: { SLEIGHHOME: "/sleigh" },
+    stdinText: script,
+    hostDirMounts: [{ hostDir: sleigh, vfsDir: "/sleigh" }],
+    inputFiles: [{
+      vfsPath: "/work/rom.bin",
+      encoding: "base64",
+      data: Buffer.from(romBytes).toString("base64"),
+    }],
+  });
+
+  const raw = res.log ?? "";
+  // The decompiler echoes each prompt; the C body follows `print C`.
+  const code = extractC(raw);
+  const warnings = [...raw.matchAll(/\/\* WARNING: (.+?) \*\//g)].map((m) => m[1]);
+  if (!code) {
+    throw new Error(`decompile produced no C output (exit=${res.exitCode}): ${raw.slice(-400)}`);
+  }
+  return { platform, langid, address: fileOffset, addressHex: addr, code, warnings, raw };
+}
+
+/** Pull the C function text out of the REPL transcript (between `print C` and
+ * the next `[decomp]>` prompt). */
+function extractC(transcript) {
+  const lines = transcript.split("\n");
+  const start = lines.findIndex((l) => /\[decomp\]>\s*print C\b/.test(l));
+  if (start === -1) return null;
+  const body = [];
+  for (let i = start + 1; i < lines.length; i++) {
+    if (/^\[decomp\]>/.test(lines[i])) break;
+    body.push(lines[i]);
+  }
+  const text = body.join("\n").trim();
+  return text.length ? text : null;
+}

package/src/analysis/decompiler/sleigh/6502.cspec

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<compiler_spec>
+  <global>
+    <range space="RAM"/>
+  </global>
+  <stackpointer register="SP" space="RAM" growth="negative"/>
+  <returnaddress>
+    <varnode space="stack" offset="1" size="2"/>
+  </returnaddress>
+  <default_proto>
+    <prototype name="__stdcall" extrapop="2" stackshift="2" strategy="register">
+      <input>
+        <pentry minsize="1" maxsize="1">
+          <register name="A"/>
+        </pentry>
+        <pentry minsize="1" maxsize="1">
+          <register name="X"/>
+        </pentry>
+        <pentry minsize="1" maxsize="1">
+          <register name="Y"/>
+        </pentry>
+      </input>
+      <output>
+        <pentry minsize="1" maxsize="1">
+          <register name="A"/>
+        </pentry>
+      </output>
+      <unaffected>
+        <register name="SP"/>
+      </unaffected>
+    </prototype>
+  </default_proto>
+</compiler_spec>

package/src/analysis/decompiler/sleigh/6502.ldefs

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<language_definitions>
+  
+  <language processor="6502"
+            endian="little"
+            size="16"
+            variant="default"
+            version="1.0"
+            slafile="6502.sla"
+            processorspec="6502.pspec"
+            manualindexfile="../manuals/6502.idx"
+            id="6502:LE:16:default">
+    <description>6502 Microcontroller Family</description>
+    <compiler name="default" spec="6502.cspec" id="default"/>
+    <external_name tool="IDA-PRO" name="m6502"/>
+  </language>
+
+  <language processor="65C02"
+            endian="little"
+            size="16"
+            variant="default"
+            version="1.0"
+            slafile="65c02.sla"
+            processorspec="6502.pspec"
+            manualindexfile="../manuals/65c02.idx"
+            id="65C02:LE:16:default">
+    <description>65C02 Microcontroller Family</description>
+    <compiler name="default" spec="6502.cspec" id="default"/>
+	<external_name tool="IDA-PRO" name="m65c02"/>
+  </language>
+  
+</language_definitions>

package/src/analysis/decompiler/sleigh/6502.pspec

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<processor_spec>
+  <programcounter register="PC"/>
+  
+  <default_symbols>
+    <symbol name="NMI" address="FFFA" entry="true" type="code_ptr"/>
+    <symbol name="RES" address="FFFC" entry="true" type="code_ptr"/>
+    <symbol name="IRQ" address="FFFE" entry="true" type="code_ptr"/>
+  </default_symbols>
+  
+  <default_memory_blocks>
+    <memory_block name="ZERO_PAGE" start_address="0x0000" length="0x0100" initialized="false"/>
+    <memory_block name="STACK" start_address="0x0100" length="0x0100" initialized="false"/>
+  </default_memory_blocks>
+</processor_spec>