yaze::emu::WatchpointManager Class Reference

Manages memory watchpoints for debugging. More...

#include <watchpoint_manager.h>

Classes
struct	AccessLog
struct	Watchpoint

Public Member Functions
	WatchpointManager ()=default
	~WatchpointManager ()=default
uint32_t	AddWatchpoint (uint32_t start_address, uint32_t end_address, bool track_reads, bool track_writes, bool break_on_access=false, const std::string &description="")
	Add a memory watchpoint.
void	RemoveWatchpoint (uint32_t id)
	Remove a watchpoint.
void	SetEnabled (uint32_t id, bool enabled)
	Enable or disable a watchpoint.
bool	OnMemoryAccess (uint32_t pc, uint32_t address, bool is_write, uint8_t old_value, uint8_t new_value, uint64_t cycle_count)
	Check if memory access should break/log.
std::vector< Watchpoint >	GetAllWatchpoints () const
	Get all watchpoints.
std::vector< AccessLog >	GetHistory (uint32_t address, int max_entries=100) const
	Get access history for a specific address.
void	ClearAll ()
	Clear all watchpoints.
void	ClearHistory ()
	Clear history for all watchpoints.
bool	ExportHistoryToCSV (const std::string &filepath) const
	Export access history to CSV.

Private Member Functions
bool	IsInRange (const Watchpoint &wp, uint32_t address) const

Private Attributes
std::unordered_map< uint32_t, Watchpoint >	watchpoints_
uint32_t	next_id_ = 1

Detailed Description

Manages memory watchpoints for debugging.

Watchpoints track memory accesses (reads/writes) and can break execution when specific memory locations are accessed. This is crucial for:

• Finding where variables are modified
• Detecting buffer overflows
• Tracking down corruption bugs
• Understanding data flow

Inspired by Mesen2's memory debugging capabilities.

Definition at line 26 of file watchpoint_manager.h.

Constructor & Destructor Documentation

WatchpointManager()

yaze::emu::WatchpointManager::WatchpointManager ( )

default

~WatchpointManager()

yaze::emu::WatchpointManager::~WatchpointManager ( )

default

Member Function Documentation

AddWatchpoint()

uint32_t yaze::emu::WatchpointManager::AddWatchpoint	(	uint32_t	start_address,
		uint32_t	end_address,
		bool	track_reads,
		bool	track_writes,
		bool	break_on_access = false,
		const std::string &	description = "" )

Add a memory watchpoint.

Parameters

start_address	Starting address of range to watch
end_address	Ending address (inclusive), or same as start for single byte
track_reads	Track read accesses
track_writes	Track write accesses
break_on_access	Pause emulation when accessed
description	User-friendly description

Returns

Unique watchpoint ID

Definition at line 12 of file watchpoint_manager.cc.

References yaze::emu::WatchpointManager::Watchpoint::break_on_access, yaze::emu::WatchpointManager::Watchpoint::description, yaze::emu::WatchpointManager::Watchpoint::enabled, yaze::emu::WatchpointManager::Watchpoint::end_address, yaze::emu::WatchpointManager::Watchpoint::id, LOG_INFO, next_id_, yaze::emu::WatchpointManager::Watchpoint::start_address, yaze::emu::WatchpointManager::Watchpoint::track_reads, yaze::emu::WatchpointManager::Watchpoint::track_writes, and watchpoints_.

Referenced by yaze::cli::agent::MemoryDebuggingExample::DebugSpriteData(), yaze::cli::agent::MemoryDebuggingExample::MonitorInventory(), yaze::test::EmulatorTestSuite::RunWatchpointManagerTest(), yaze::cli::agent::MemoryDebuggingExample::TrackDMATransfers(), and yaze::cli::agent::MemoryDebuggingExample::TrackPlayerHealth().

RemoveWatchpoint()

void yaze::emu::WatchpointManager::RemoveWatchpoint

(

uint32_t

id

)

Remove a watchpoint.

Definition at line 39 of file watchpoint_manager.cc.

References LOG_INFO, and watchpoints_.

SetEnabled()

void yaze::emu::WatchpointManager::SetEnabled	(	uint32_t	id,
		bool	enabled )

Enable or disable a watchpoint.

Definition at line 47 of file watchpoint_manager.cc.

References LOG_INFO, and watchpoints_.

OnMemoryAccess()

bool yaze::emu::WatchpointManager::OnMemoryAccess	(	uint32_t	pc,
		uint32_t	address,
		bool	is_write,
		uint8_t	old_value,
		uint8_t	new_value,
		uint64_t	cycle_count )

Check if memory access should break/log.

Parameters

pc	Current program counter
address	Memory address being accessed
is_write	True for write, false for read
old_value	Previous value at address
new_value	New value (for writes) or value read
cycle_count	Current CPU cycle

Returns

true if should break execution

Definition at line 56 of file watchpoint_manager.cc.

References yaze::emu::WatchpointManager::AccessLog::address, yaze::emu::WatchpointManager::AccessLog::cycle_count, yaze::emu::WatchpointManager::AccessLog::description, yaze::emu::WatchpointManager::AccessLog::is_write, IsInRange(), yaze::emu::WatchpointManager::Watchpoint::kMaxHistorySize, LOG_INFO, yaze::emu::WatchpointManager::AccessLog::new_value, yaze::emu::WatchpointManager::AccessLog::old_value, yaze::emu::WatchpointManager::AccessLog::pc, and watchpoints_.

Referenced by yaze::test::EmulatorTestSuite::RunWatchpointManagerTest().

Here is the call graph for this function:

GetAllWatchpoints()

std::vector< WatchpointManager::Watchpoint > yaze::emu::WatchpointManager::GetAllWatchpoints

(

)

const

Get all watchpoints.

Definition at line 105 of file watchpoint_manager.cc.

References watchpoints_.

Referenced by yaze::cli::agent::MemoryDebuggingExample::AnalyzeWatchpointData().

GetHistory()

std::vector< WatchpointManager::AccessLog > yaze::emu::WatchpointManager::GetHistory	(	uint32_t	address,
		int	max_entries = 100 ) const

Get access history for a specific address.

Parameters

address	Address to query
max_entries	Maximum number of entries to return

Returns

Vector of access logs

Definition at line 117 of file watchpoint_manager.cc.

References IsInRange(), and watchpoints_.

Referenced by yaze::cli::agent::MemoryDebuggingExample::AnalyzeWatchpointData(), and yaze::test::EmulatorTestSuite::RunWatchpointManagerTest().

Here is the call graph for this function:

ClearAll()

void yaze::emu::WatchpointManager::ClearAll

(

)

Clear all watchpoints.

Definition at line 137 of file watchpoint_manager.cc.

References LOG_INFO, and watchpoints_.

Referenced by yaze::cli::agent::MemoryDebuggingExample::ClearDebugging().

ClearHistory()

void yaze::emu::WatchpointManager::ClearHistory

(

)

Clear history for all watchpoints.

Definition at line 143 of file watchpoint_manager.cc.

References LOG_INFO, and watchpoints_.

ExportHistoryToCSV()

bool yaze::emu::WatchpointManager::ExportHistoryToCSV

(

const std::string &

filepath

)

const

Export access history to CSV.

Parameters

filepath

Output file path

Returns

true if successful

Definition at line 150 of file watchpoint_manager.cc.

References LOG_INFO, and watchpoints_.

Referenced by yaze::cli::agent::MemoryDebuggingExample::ExportWatchpointHistory().

IsInRange()

bool yaze::emu::WatchpointManager::IsInRange ( const Watchpoint & wp, uint32_t address ) const

inlineprivate

Definition at line 132 of file watchpoint_manager.h.

References yaze::emu::WatchpointManager::Watchpoint::end_address, and yaze::emu::WatchpointManager::Watchpoint::start_address.

Referenced by GetHistory(), and OnMemoryAccess().

Member Data Documentation

watchpoints_

std::unordered_map<uint32_t, Watchpoint> yaze::emu::WatchpointManager::watchpoints_

private

Definition at line 128 of file watchpoint_manager.h.

Referenced by AddWatchpoint(), ClearAll(), ClearHistory(), ExportHistoryToCSV(), GetAllWatchpoints(), GetHistory(), OnMemoryAccess(), RemoveWatchpoint(), and SetEnabled().

next_id_

uint32_t yaze::emu::WatchpointManager::next_id_ = 1

private

Definition at line 129 of file watchpoint_manager.h.

Referenced by AddWatchpoint().

---

The documentation for this class was generated from the following files:

• src/app/emu/debug/watchpoint_manager.h
• src/app/emu/debug/watchpoint_manager.cc