aboutsummaryrefslogtreecommitdiff
path: root/cpu/nestest_test.go
blob: 4786c5befc4f18c165eee0eade1ae2eb09018032 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
package cpu

import (
	"bufio"
	"os"
	"regexp"
	"strconv"
	"testing"
)

type nestestBus struct {
	ram [0x0800]uint8
	prg []uint8
}

func (b *nestestBus) Read(addr uint16) uint8 {
	switch {
	case addr < 0x2000:
		return b.ram[addr%0x0800]
	case addr >= 0x8000:
		return b.prg[int(addr-0x8000)%len(b.prg)]
	default:
		return 0
	}
}

func (b *nestestBus) Write(addr uint16, v uint8) {
	if addr < 0x2000 {
		b.ram[addr%0x0800] = v
	}
}

func loadNestestPRG(path string) ([]uint8, error) {
	data, err := os.ReadFile(path)
	if err != nil {
		return nil, err
	}
	prgBanks := int(data[4])
	prgSize := prgBanks * 16 * 1024
	hasTrainer := data[6]&0x04 != 0
	offset := 16
	if hasTrainer {
		offset += 512
	}
	return data[offset : offset+prgSize], nil
}

type cpuState struct {
	pc             uint16
	a, x, y, p, sp uint8
	cyc            uint64
}

var nestestLogRE = regexp.MustCompile(
	`^([0-9A-F]{4}).*A:([0-9A-F]{2}) X:([0-9A-F]{2}) Y:([0-9A-F]{2}) P:([0-9A-F]{2}) SP:([0-9A-F]{2}).*CYC:\s*(\d+)`)

func loadNestestLog(path string) ([]cpuState, error) {
	f, err := os.Open(path)
	if err != nil {
		return nil, err
	}
	defer f.Close()

	var lines []cpuState
	scanner := bufio.NewScanner(f)
	for scanner.Scan() {
		m := nestestLogRE.FindStringSubmatch(scanner.Text())
		if m == nil {
			continue
		}
		parseHex8 := func(s string) uint8 {
			v, _ := strconv.ParseUint(s, 16, 8)
			return uint8(v)
		}
		pc, _ := strconv.ParseUint(m[1], 16, 16)
		cyc, _ := strconv.ParseUint(m[7], 10, 64)
		lines = append(lines, cpuState{
			pc:  uint16(pc),
			a:   parseHex8(m[2]),
			x:   parseHex8(m[3]),
			y:   parseHex8(m[4]),
			p:   parseHex8(m[5]),
			sp:  parseHex8(m[6]),
			cyc: cyc,
		})
	}
	return lines, scanner.Err()
}

// TestNestest runs nestest.nes and diffs the state against a known good log before each instruction
func TestNestest(t *testing.T) {
	const romPath = "testdata/nestest.nes"
	const logPath = "testdata/nestest.log"

	if _, err := os.Stat(romPath); err != nil {
		t.Skip("testdata/nestest.nes not present; add it and testdata/nestest.log to run this test")
	}

	prg, err := loadNestestPRG(romPath)
	if err != nil {
		t.Fatalf("loading ROM: %v", err)
	}
	want, err := loadNestestLog(logPath)
	if err != nil {
		t.Fatalf("loading log: %v", err)
	}
	if len(want) == 0 {
		t.Fatal("no log lines parsed")
	}

	bus := &nestestBus{prg: prg}
	c := NewCPU(bus)
	c.PC = 0xC000
	c.SP = 0xFD
	c.Status = 0x24
	c.Cycles = want[0].cyc

	for i, w := range want {
		got := cpuState{c.PC, c.A, c.X, c.Y, c.Status, c.SP, c.Cycles}
		if got != w {
			t.Fatalf("line %d: got %+v, want %+v", i+1, got, w)
		}

		stopped := func() (panicked bool) {
			defer func() {
				if r := recover(); r != nil {
					t.Logf("stopped at line %d: %v", i+1, r)
					panicked = true
				}
			}()
			c.Step()
			return false
		}()
		if stopped {
			t.Logf("matched %d instructions before stopping", i+1)
			return
		}
	}
}