Be able to setup breakpoints.

Author: pherrymason

go.mod

@@ -5,5 +5,6 @@ go 1.14
 require (
 	github.com/FMNSSun/hexit v0.0.0-20180713092704-89e1f9f0820e
 	github.com/lachee/raylib-goplus v0.0.0-20200605081007-7ca39b8afc71
+	github.com/pkg/profile v1.6.0 // indirect
 	github.com/stretchr/testify v1.6.1
 )

go.sum

@@ -4,6 +4,8 @@ github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/lachee/raylib-goplus v0.0.0-20200605081007-7ca39b8afc71 h1:H4fcwldyU7pQvzyR3fuNLe0Gs3f7yLg/lH7NorUTc7I=
 github.com/lachee/raylib-goplus v0.0.0-20200605081007-7ca39b8afc71/go.mod h1:dBwvFApqhdnnQuWzvHZnvWph/zlTAHC3nd/Hy6yBE8U=
+github.com/pkg/profile v1.6.0 h1:hUDfIISABYI59DyeB3OTay/HxSRwTQ8rB/H83k6r5dM=
+github.com/pkg/profile v1.6.0/go.mod h1:qBsxPvzyUincmltOk6iyRVxHYg4adc0OFOv72ZdLa18=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=

src/debugger/breakpoints.go

@@ -3,9 +3,12 @@ package debugger
 import (
 	"fmt"
 	"github.com/lachee/raylib-goplus/raylib"
+	"github.com/raulferras/nes-golang/src/nes"
+	"github.com/raulferras/nes-golang/src/nes/types"
 )
 
 type breakpointDebugger struct {
+	emulator           *nes.Nes
 	panel              *draggablePanel
 	breakpointAddPanel *breakpointAdd
 	breakpoints        [4]uint16
@@ -15,8 +18,9 @@ type breakpointDebugger struct {
 
 const breakpointDebuggerWidth = 500
 
-func NewBreakpointDebugger() *breakpointDebugger {
+func NewBreakpointDebugger(emulator *nes.Nes) *breakpointDebugger {
 	return &breakpointDebugger{
+		emulator: emulator,
 		panel: NewDraggablePanel(
 			"Debugger · Breakpoints",
 			raylib.Vector2{300, 350},
@@ -133,4 +137,5 @@ func (dbg *breakpointDebugger) onAddBreakpoint(address uint16) {
 	fmt.Printf("Breakpoint created: %X\n", address)
 	dbg.breakpoints[dbg.breakpointsCount] = address
 	dbg.breakpointsCount++
+	dbg.emulator.Debugger().AddBreakPoint(types.Address(address))
 }

src/debugger/controller.go

@@ -37,7 +37,7 @@ func NewDebugger(emulator *nes.Nes) GuiDebugger {
 		font:                  font,
 		emulator:              emulator,
 		ppuDebugger:           NewPPUDebugger(emulator.PPU()),
-		breakpointDebugger:    NewBreakpointDebugger(),
+		breakpointDebugger:    NewBreakpointDebugger(emulator),
 	}
 }
 

src/main.go

@@ -4,37 +4,33 @@ import (
 	"flag"
 	"fmt"
 	r "github.com/lachee/raylib-goplus/raylib"
+	"github.com/pkg/profile"
 	"github.com/raulferras/nes-golang/src/debugger"
 	"github.com/raulferras/nes-golang/src/graphics"
 	"github.com/raulferras/nes-golang/src/nes"
 	"github.com/raulferras/nes-golang/src/nes/gamePak"
 	"github.com/raulferras/nes-golang/src/nes/types"
 	"github.com/raulferras/nes-golang/src/utils"
 	"image"
-	"log"
 	"math/rand"
 	_ "net/http/pprof"
-	"os"
-	"runtime/pprof"
 	"time"
 )
 
 var cpuAdvance bool
 
 func main() {
-	/*
-		var cpuprofile = flag.String("cpuprofile", "", "write cpu profile to file")
-		var romPath = flag.String("rom", "", "path to rom")
-		var debugPPU = flag.Bool("debugPPU", false, "Displays PPU debug information")
-		flag.Parse()*/
-	cpuprofile, romPath, debugPPU, maxCPUCycle := cmdLineArguments()
+	scale, cpuprofile, romPath, debugPPU, maxCPUCycle := cmdLineArguments()
 	if cpuprofile != "" {
-		f, err := os.Create(cpuprofile)
+		/*f, err := os.Create(cpuprofile)
 		if err != nil {
 			log.Fatal(err)
 		}
 		pprof.StartCPUProfile(f)
+		pprof.
 		defer pprof.StopCPUProfile()
+		*/
+		defer profile.Start(profile.CPUProfile, profile.ProfilePath(".")).Stop()
 	}
 
 	rand.Seed(time.Now().UnixNano())
@@ -71,11 +67,11 @@ func main() {
 		),
 	)
 
-	loop(console)
+	loop(console, scale)
 	r.CloseWindow()
 }
 
-func loop(console *nes.Nes) {
+func loop(console *nes.Nes, scale int) {
 	cpuAdvance = true
 	console.Start()
 	_timestamp := r.GetTime()
@@ -130,12 +126,13 @@ func drawEmulation(frame *image.RGBA) {
 	}
 }
 
-func cmdLineArguments() (string, string, bool, int64) {
+func cmdLineArguments() (int, string, string, bool, int64) {
 	var cpuprofile = flag.String("cpuprofile", "", "write cpu profile to file")
 	var romPath = flag.String("rom", "", "path to rom")
 	var debugPPU = flag.Bool("debugPPU", false, "Displays PPU debug information")
 	var stopAtCpuCycle = flag.Int64("maxCpuCycle", -1, "stops emulation at given cpu cycle")
+	var scale = flag.Int("scale", 1, "scale resolution")
 	flag.Parse()
 
-	return *cpuprofile, *romPath, *debugPPU, *stopAtCpuCycle
+	return *scale, *cpuprofile, *romPath, *debugPPU, *stopAtCpuCycle
 }

src/nes/Debugger.go

@@ -10,26 +10,49 @@ import (
 // Debugger offers an api to interact externally with
 // NES components
 type Debugger struct {
-	debug       bool
-	cpu         *Cpu6502
-	ppu         *ppu.Ppu2c02
-	logPath     string
-	maxCPUCycle int64
-
+	cpu          *Cpu6502
+	ppu          *ppu.Ppu2c02
+	logPath      string
+	maxCPUCycle  int64
 	disassembled map[types.Address]string
 	DebugPPU     bool
+	debugCPU     bool
+	// debugging related
+	cpuBreakPoints    map[types.Address]bool
+	cpuStepByStepMode bool
 }
 
-func CreateNesDebugger(logPath string, debug bool, debugPPU bool, maxCPUCycle int64) *Debugger {
+func CreateNesDebugger(logPath string, debugCPU bool, debugPPU bool, maxCPUCycle int64) *Debugger {
 	return &Debugger{
-		debug:        debug,
 		cpu:          nil,
 		ppu:          nil,
 		logPath:      logPath,
 		maxCPUCycle:  maxCPUCycle,
 		disassembled: nil,
+		debugCPU:     debugCPU,
 		DebugPPU:     debugPPU,
+
+		cpuBreakPoints: make(map[types.Address]bool),
+	}
+}
+
+func (debugger *Debugger) AddBreakPoint(address types.Address) {
+	debugger.cpuBreakPoints[address] = true
+}
+
+func (debugger *Debugger) RemoveBreakPoint(address types.Address) {
+	debugger.cpuBreakPoints[address] = false
+}
+
+func (debugger *Debugger) shouldPauseBecauseBreakpoint() bool {
+	pc := debugger.cpu.ProgramCounter()
+	enabled, exist := debugger.cpuBreakPoints[pc]
+	if enabled && exist {
+		debugger.cpuStepByStepMode = true
+		return true
 	}
+
+	return false
 }
 
 func (debugger *Debugger) Disassembled() map[types.Address]string {

src/nes/Nes.go

@@ -7,6 +7,7 @@ import (
 	"github.com/raulferras/nes-golang/src/nes/ppu"
 	"github.com/raulferras/nes-golang/src/nes/types"
 	"image"
+	"log"
 )
 
 type Nes struct {
@@ -26,7 +27,7 @@ func CreateNes(gamePak *gamePak.GamePak, debugger *Debugger) *Nes {
 	cpuBus := newNESCPUMemory(thePPU, gamePak)
 	cpu := CreateCPU(
 		cpuBus,
-		cpu2.NewDebugger(debugger.debug, debugger.logPath+"/cpu.log"),
+		cpu2.NewDebugger(debugger.debugCPU, debugger.logPath+"/cpu.log"),
 	)
 	debugger.cpu = cpu
 	debugger.ppu = thePPU
@@ -104,8 +105,26 @@ func (nes *Nes) Tick() byte {
 }
 
 func (nes *Nes) TickForTime(seconds float64) {
+	/*
+		if nes.Debugger().shouldPauseBecauseBreakpoint() {
+			fmt.Printf("1\n")
+			time.Sleep(100 * time.Millisecond)
+			return
+		} else if nes.Debugger().cpuStepByStepMode {
+			fmt.Printf("2\n")
+			time.Sleep(100 * time.Millisecond)
+			nes.Tick()
+			return
+		}*/
+
 	cycles := int(1789773 * seconds)
+	//log.Printf("Running for %.2fsec\n", seconds)
 	for cycles > 0 {
+		if nes.Debugger().shouldPauseBecauseBreakpoint() {
+			log.Printf("Brekapoint reached")
+			break
+		}
+
 		cycles -= int(nes.Tick())
 		if nes.Stopped() {
 			break

src/nes/cpu6502.go

@@ -19,9 +19,7 @@ type Cpu6502 struct {
 
 	addressEvaluators [13]AddressModeMethod
 
-	// Debug parameters
-	debugger    *cpu.Debugger
-	cyclesLimit uint16
+	debugger *cpu.Debugger
 }
 
 func CreateCPU(memory Memory, debugger *cpu.Debugger) *Cpu6502 {

src/nes/cpu6502_Logger.go

@@ -94,8 +94,5 @@ func (cpu6502 *Cpu6502) logStep(registers cpu.Registers, opcode byte, operand [3
 }*/
 
 func (cpu6502 *Cpu6502) Stop() {
-	//if cpu6502.debug {
-	//	cpu6502.Logger.Close()
-	//}
 	cpu6502.debugger.Stop()
 }