125 lines
4.6 KiB
C#
125 lines
4.6 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
|
|
namespace BizHawk.Emulation.Common
|
|
{
|
|
/// <summary>
|
|
/// This is a property of <seealso cref="IDebuggable"/>, and defines the means by which a client
|
|
/// gets and sets memory callbacks in the core. A memory callback should fire any time memory is
|
|
/// read/written/executed by the core, and depends on the type specified by the callback
|
|
/// </summary>
|
|
/// <seealso cref="IDebuggable"/>
|
|
public interface IMemoryCallbackSystem : IEnumerable<IMemoryCallback>
|
|
{
|
|
/*
|
|
* DANGER:
|
|
* Many cores will blindly call CallReads(), CallWrites(), CallExecutes() on every rwx no matter what.
|
|
* These functions must return very quickly if the list is empty. Very very quickly.
|
|
*/
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not Execute callbacks are available for this this implementation
|
|
/// </summary>
|
|
bool ExecuteCallbacksAvailable { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not there are currently any read hooks
|
|
/// </summary>
|
|
bool HasReads { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not there are currently any write hooks
|
|
/// </summary>
|
|
bool HasWrites { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not there are currently any execute hooks
|
|
/// </summary>
|
|
bool HasExecutes { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not there are currently any read hooks
|
|
/// </summary>
|
|
bool HasReadsForScope(string scope);
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not there are currently any write hooks
|
|
/// </summary>
|
|
bool HasWritesForScope(string scope);
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether or not there are currently any execute hooks
|
|
/// </summary>
|
|
bool HasExecutesForScope(string scope);
|
|
|
|
/// <summary>
|
|
/// Adds a callback for the given type to the given address
|
|
/// If no address is specified the callback will be hooked to all addresses
|
|
/// Note: an execute callback can not be added without an address, else an InvalidOperationException will occur
|
|
/// </summary>
|
|
/// <exception cref="InvalidCastException">Thrown when the <see cref="IMemoryCallback.Scope"/> property of the <see cref="IMemoryCallback"/> is not in the <see cref="AvailableScopes"/></exception>
|
|
void Add(IMemoryCallback callback);
|
|
|
|
/// <summary>
|
|
/// Executes all Read callbacks for the given address and domain
|
|
/// </summary>
|
|
/// <param name="addr">The address to check for callbacks</param>
|
|
/// <param name="scope">The scope that the address pertains to. Must be a value in <see cref="AvailableScopes"></param>
|
|
void CallReads(uint addr, string scope);
|
|
|
|
/// <summary>
|
|
/// Executes all Write callbacks for the given address and domain
|
|
/// </summary>
|
|
/// <param name="addr">The address to check for callbacks</param>
|
|
/// <param name="scope">The scope that the address pertains to. Must be a value in <see cref="AvailableScopes"></param>
|
|
void CallWrites(uint addr, string scope);
|
|
|
|
/// <summary>
|
|
/// Executes all Execute callbacks for the given address and domain
|
|
/// </summary>
|
|
/// <param name="addr">The address to check for callbacks</param>
|
|
/// <param name="scope">The scope that the address pertains to. Must be a value in <see cref="AvailableScopes"></param>
|
|
void CallExecutes(uint addr, string scope);
|
|
|
|
/// <summary>
|
|
/// Removes the given callback from the list
|
|
/// </summary>
|
|
void Remove(Action action);
|
|
|
|
/// <summary>
|
|
/// Removes the given callbacks from the list
|
|
/// </summary>
|
|
void RemoveAll(IEnumerable<Action> actions);
|
|
|
|
/// <summary>
|
|
/// Removes all read,write, and execute callbacks
|
|
/// </summary>
|
|
void Clear();
|
|
|
|
/// <summary>
|
|
/// A list of available "scopes" (memory domains, cpus, etc) that a the <see cref="IMemoryCallback.Scope"/> property of the <see cref="IMemoryCallback"/> can have
|
|
/// Passing a <see cref="IMemoryCallback"/> into the <see cref="Add(IMemoryCallback)"/> method that is not in this list will result in an <seealso cref="InvalidOperationException"/>
|
|
/// </summary>
|
|
string[] AvailableScopes { get; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// This service defines a memory callback used by an IMemoryCallbackSystem implementation
|
|
/// </summary>
|
|
/// <seealso cref="IMemoryCallbackSystem"/>
|
|
public interface IMemoryCallback
|
|
{
|
|
MemoryCallbackType Type { get; }
|
|
string Name { get; }
|
|
Action Callback { get; }
|
|
uint? Address { get; }
|
|
uint? AddressMask { get; }
|
|
string Scope { get; }
|
|
}
|
|
|
|
public enum MemoryCallbackType
|
|
{
|
|
Read, Write, Execute
|
|
}
|
|
}
|