Fix ADC and SBC instructions and add test runner script (#5)

snes-cpu-test-runner/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "snes-cpu-test-runner"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+snes-core = { path = "../snes-core" }
+
+serde = { version = "1.0.195", features = ["derive"] }
+serde_json = "1.0.111"

snes-cpu-test-runner/src/main.rs

@@ -0,0 +1,161 @@
+use snes_core::cpu::bus::Bus;
+use snes_core::cpu::registers::Registers;
+/// https://github.com/TomHarte/ProcessorTests/tree/main/65816
+
+use snes_core::emulator::Emulator;
+use serde::{Deserialize, Serialize};
+use serde_json::Result;
+use snes_core::rom::special_ram_cart::SpecialRAMCart;
+
+use std::fs::File;
+use std::io::Read;
+
+#[derive(Serialize, Deserialize, Debug)]
+pub struct TestState {
+    pc: usize,
+    s: usize,
+    p: usize,
+    a: usize,
+    x: usize,
+    y: usize,
+    dbr: usize,
+    d: usize,
+    pbr: usize,
+    e: usize,
+    ram: Vec<(usize, usize)>,
+}
+
+#[derive(Serialize, Deserialize)]
+pub struct TestSuite {
+    name: String,
+    initial: TestState,
+    r#final: TestState,
+    cycles: Vec<(usize, Option<usize>, String)>,
+}
+
+#[derive(Serialize, Deserialize)]
+pub struct TestSuiteList(Vec<TestSuite>);
+
+fn print_failed(initial_state: &TestState, expected_state: &TestState, bus: &Bus, cpu_registers: &Registers) {
+    eprintln!("FAILED!");
+    eprintln!("----------");
+    eprintln!("Initial:");
+    eprintln!("{:?}", initial_state);
+    eprintln!("Expected:");
+    eprintln!("{:?}", expected_state);
+    eprintln!("Result:");
+    let mut result_ram = vec![];
+    for (address, _) in &expected_state.ram {
+        result_ram.push((*address, bus.read_external(*address as u32) as usize))
+    }
+    let result_state = TestState {
+        pc: cpu_registers.pc as usize,
+        s: cpu_registers.sp as usize,
+        p: cpu_registers.p as usize,
+        a: cpu_registers.a as usize,
+        x: cpu_registers.x as usize,
+        y: cpu_registers.y as usize,
+        dbr: cpu_registers.dbr as usize,
+        d: cpu_registers.d as usize,
+        pbr: cpu_registers.pbr as usize,
+        e: if cpu_registers.emulation_mode {1} else {0},
+        ram: result_ram,
+    };
+    eprintln!("{:?}", result_state);
+    eprintln!("----------");
+    // std::process::exit(1);
+}
+
+fn main() -> Result<()> {
+    let args: Vec<String> = std::env::args().collect();
+    if args.len() < 2 {
+        eprintln!("A test file must be provided");
+        std::process::exit(1);
+    }
+    let filename = args.get(1).unwrap();
+    if filename.is_empty() {
+        eprintln!("A test file must be provided");
+        std::process::exit(1);
+    }
+    let mut file = File::open(filename).unwrap();
+    let mut buff = String::new();
+    file.read_to_string(&mut buff).unwrap();
+
+    let tests: TestSuiteList = serde_json::from_str(&buff)?;
+
+    let mut emulator = Emulator::new();
+    emulator.bus.force_cart_lookup = true;
+    emulator.bus.rom = Box::new(SpecialRAMCart::new());
+
+    let mut total_failed = 0;
+    let mut total_passed = 0;
+
+    for test in &tests.0 {
+        let mut did_test_fail = false;
+        println!("running test case {}", test.name);
+
+        emulator.cpu.registers.pc = test.initial.pc as u16;
+        emulator.cpu.registers.sp = test.initial.s as u16;
+        emulator.cpu.registers.p = test.initial.p as u8;
+        emulator.cpu.registers.a = test.initial.a as u16;
+        emulator.cpu.registers.x = test.initial.x as u16;
+        emulator.cpu.registers.y = test.initial.y as u16;
+        emulator.cpu.registers.dbr = test.initial.dbr as u8;
+        emulator.cpu.registers.d = test.initial.d as u16;
+        emulator.cpu.registers.pbr = test.initial.pbr as u8;
+        emulator.cpu.registers.emulation_mode = test.initial.e == 1;
+
+        for (address, value) in &test.initial.ram {
+            emulator.bus.write(*address as u32, *value as u8);
+        }
+
+        emulator.tick();
+
+        let is_emu_mode = emulator.cpu.registers.emulation_mode;
+        let is_16index = emulator.cpu.registers.is_16bit_index();
+
+        let emu_mode_sp = (emulator.cpu.registers.sp as usize & 0xFF) | 0x100;
+
+        // compare the results
+        if
+            emulator.cpu.registers.pc as usize != test.r#final.pc ||
+            (if is_emu_mode {emu_mode_sp} else {emulator.cpu.registers.sp as usize}) != test.r#final.s ||
+            emulator.cpu.registers.p as usize != test.r#final.p ||
+            emulator.cpu.registers.a as usize != test.r#final.a ||
+            if is_16index {emulator.cpu.registers.x as usize} else {emulator.cpu.registers.x as u8 as usize} != test.r#final.x ||
+            if is_16index {emulator.cpu.registers.y as usize} else {emulator.cpu.registers.y as u8 as usize} != test.r#final.y ||
+            emulator.cpu.registers.dbr as usize != test.r#final.dbr ||
+            emulator.cpu.registers.d as usize != test.r#final.d ||
+            emulator.cpu.registers.pbr as usize != test.r#final.pbr ||
+            emulator.cpu.registers.emulation_mode != (test.r#final.e == 1)
+        {
+            print_failed(&test.initial, &test.r#final, &emulator.bus, &emulator.cpu.registers);
+            did_test_fail = true;
+        }
+        for (address, value) in &test.r#final.ram {
+            if *value != emulator.bus.read_external(*address as u32) as usize {
+                print_failed(&test.initial, &test.r#final, &emulator.bus, &emulator.cpu.registers);
+                did_test_fail = true;
+            }
+        }
+
+        if did_test_fail {
+            total_failed += 1;
+        } else {
+            total_passed += 1;
+        }
+
+        // Cleanup RAM
+        for (address, _) in &test.initial.ram {
+            emulator.bus.write(*address as u32, 0x00);
+        }
+        for (address, _) in &test.r#final.ram {
+            emulator.bus.write(*address as u32, 0x00);
+        }
+    }
+
+    println!("----------");
+    println!("TOTAL PASSED: {}", total_passed);
+    println!("TOTAL FAILED: {}", total_failed);
+    Ok(())
+}