feature: Internal debugger memory and execution breakpoints

src/Spice86.Core/Emulator/InterruptHandlers/Common/MemoryWriter/InMemoryAddressSwitcher.cs

@@ -29,7 +29,7 @@ public InMemoryAddressSwitcher(IIndexable memory) {
     public SegmentedAddress? DefaultAddress { get; set; }
 
     /// <summary>
-    /// Sets the segmented address. PhysicalLocation needs to be initialized before calling this method.
+    /// Sets the segmented address. <see cref="PhysicalLocation"/> needs to be initialized before calling this method.
     /// </summary>
     /// <param name="segment">Segment</param>
     /// <param name="offset">Offset</param>

src/Spice86/Controls/StatusBar.cs

@@ -17,5 +17,6 @@ internal sealed class StatusBar : StackPanel {
 
     static StatusBar() {
         OrientationProperty.OverrideDefaultValue(typeof(StatusBar), Orientation.Horizontal);
+        HorizontalAlignmentProperty.OverrideDefaultValue<StatusBar>(HorizontalAlignment.Stretch);
     }
 }

src/Spice86/Controls/StatusBarItem.cs

@@ -1,12 +1,14 @@
 namespace Spice86.Controls;
 
 using Avalonia.Controls;
+using Avalonia.Layout;
 
 /// <summary>
 /// Control that implements an item inside a StatusBar.
 /// </summary>
 internal sealed class StatusBarItem : ContentControl {
     static StatusBarItem() {
+        HorizontalContentAlignmentProperty.OverrideDefaultValue<StatusBarItem>(HorizontalAlignment.Stretch);
         IsTabStopProperty.OverrideDefaultValue(typeof(StatusBarItem), false);
     }
 }

src/Spice86/Converters/InstructionToStringConverter.cs

@@ -21,6 +21,9 @@ public class InstructionToStringConverter : IValueConverter {
             }
             _outputString.Clear();
             var output = new StringOutput();
+            if (!string.IsNullOrWhiteSpace(cpuInstructionInfo.FunctionName)) {
+                _outputString.AppendLine($"{cpuInstructionInfo.FunctionName} entry point");
+            }
             // Don't use instr.ToString(), it allocates more, uses masm syntax and default options
             _formatter.Format(instr, output);
             _outputString.AppendLine(output.ToStringAndReset());

src/Spice86/Messages/StatusMessage.cs

@@ -0,0 +1,3 @@
+namespace Spice86.Messages;
+
+public record StatusMessage(DateTime Time, object Origin, string Message);

src/Spice86/Models/Debugging/CpuInstructionInfo.cs

@@ -4,11 +4,16 @@ namespace Spice86.Models.Debugging;
 
 using Iced.Intel;
 
+using Spice86.Shared.Emulator.Memory;
+
 public partial class CpuInstructionInfo : ObservableObject {
     [ObservableProperty] private string? _stringRepresentation;
+    [ObservableProperty] private bool _hasBreakpoint;
+    [ObservableProperty] private string? _functionName;
     [ObservableProperty] private bool _isCsIp;
     [ObservableProperty] private uint _address;
-    [ObservableProperty] private string? _segmentedAddress;
+    [ObservableProperty] private string? _addressInformation;
+    [ObservableProperty] private SegmentedAddress _segmentedAddress;
     [ObservableProperty] private ushort _IP16;
     [ObservableProperty] private uint _IP32;
     [ObservableProperty] private int _length;

src/Spice86/Models/Debugging/ExceptionInfo.cs

@@ -1,5 +1,2 @@
 namespace Spice86.Models.Debugging;
-
-using System.Reflection;
-
 public record ExceptionInfo(string? TargetSite, string Message, string? StackTrace);

src/Spice86/Models/Debugging/FunctionInfo.cs

@@ -0,0 +1,14 @@
+namespace Spice86.Models.Debugging;
+
+using CommunityToolkit.Mvvm.ComponentModel;
+
+using Spice86.Shared.Emulator.Memory;
+
+public partial class FunctionInfo : ObservableObject {
+    [ObservableProperty] private string? _name;
+    [ObservableProperty] private uint _address;
+
+    public override string ToString() {
+        return $"{Address}: {Name}";
+    }
+}

src/Spice86/Models/Debugging/SoundChannelInfo.cs

@@ -2,8 +2,6 @@ namespace Spice86.Models.Debugging;
 
 using CommunityToolkit.Mvvm.ComponentModel;
 
-using System.ComponentModel;
-
 public partial class SoundChannelInfo : ObservableObject {
     [ObservableProperty] private int _volume;
     [ObservableProperty] private float _stereoSeparation;

src/Spice86/Models/Debugging/VideoCardInfo.cs

@@ -2,11 +2,9 @@ namespace Spice86.Models.Debugging;
 
 using CommunityToolkit.Mvvm.ComponentModel;
 
-using Spice86.Core.Emulator.Devices.Video.Registers;
 using Spice86.Core.Emulator.Devices.Video.Registers.CrtController;
 using Spice86.Core.Emulator.Devices.Video.Registers.General;
 using Spice86.Core.Emulator.Devices.Video.Registers.Graphics;
-using Spice86.ViewModels;
 
 public partial class VideoCardInfo : ObservableObject {
     [ObservableProperty]

src/Spice86/Spice86DependencyInjection.cs

@@ -193,8 +193,9 @@ public Spice86DependencyInjection(ILoggerService loggerService, Configuration co
             dmaController, soundBlaster.Opl3Fm, softwareMixer, mouse, mouseDriver,
             vgaFunctionality, pauseHandler);
 
+        IDictionary<SegmentedAddress, FunctionInformation> functionsInformation = reader.ReadGhidraSymbolsFromFileOrCreate();
         InitializeFunctionHandlers(configuration, machine, loggerService,
-            reader.ReadGhidraSymbolsFromFileOrCreate(), functionHandler, functionHandlerInExternalInterrupt);
+            functionsInformation, functionHandler, functionHandlerInExternalInterrupt);
 
         ProgramExecutor programExecutor = new(configuration, emulatorBreakpointsManager,
             emulatorStateSerializer, memory, cpu, cfgCpu, state,
@@ -241,9 +242,11 @@ public Spice86DependencyInjection(ILoggerService loggerService, Configuration co
         DebugWindowViewModel? debugWindowViewModel = null;
         if (textClipboard != null && hostStorageProvider != null && uiThreadDispatcher != null) {
             IMessenger messenger = WeakReferenceMessenger.Default;
-            debugWindowViewModel = new DebugWindowViewModel(cpu, state, memory,
+            debugWindowViewModel = new DebugWindowViewModel(cpu, state, stack, memory,
                 midiDevice, videoState.DacRegisters.ArgbPalette, softwareMixer, vgaRenderer, videoState,
                 cfgCpu.ExecutionContextManager, messenger, uiThreadDispatcher, textClipboard, hostStorageProvider, 
+                emulatorBreakpointsManager,
+                functionsInformation,
                 new StructureViewModelFactory(configuration, loggerService, pauseHandler),
                 pauseHandler);
         }

src/Spice86/ViewModels/BreakpointViewModel.cs

@@ -0,0 +1,51 @@
+namespace Spice86.ViewModels;
+
+using CommunityToolkit.Mvvm.ComponentModel;
+
+using Spice86.Core.Emulator.VM;
+using Spice86.Core.Emulator.VM.Breakpoint;
+using Spice86.Models.Debugging;
+
+public partial class BreakpointViewModel : ViewModelBase {
+    private readonly BreakPoint _breakPoint;
+    private readonly EmulatorBreakpointsManager _emulatorBreakpointsManager;
+
+    public BreakpointViewModel(EmulatorBreakpointsManager emulatorBreakpointsManager, AddressBreakPoint breakPoint) {
+        _breakPoint = breakPoint;
+        _emulatorBreakpointsManager = emulatorBreakpointsManager;
+        IsEnabled = true;
+        Address = breakPoint.Address;
+    }
+
+    public BreakPointType Type => _breakPoint.BreakPointType;
+
+    //Can't get out of sync since GDB can't be used at the same tiem as the internal debugger
+    [ObservableProperty]
+    private bool _isEnabled;
+
+    public bool IsRemovedOnTrigger => _breakPoint.IsRemovedOnTrigger;
+
+    public long Address { get; }
+
+    public void Toggle() {
+        if (IsEnabled) {
+            Disable();
+        } else {
+            Enable();
+        }
+    }
+
+    public void Enable() {
+        _emulatorBreakpointsManager.ToggleBreakPoint(_breakPoint, on: true);
+        IsEnabled = true;
+    }
+
+    public void Disable() {
+        _emulatorBreakpointsManager.ToggleBreakPoint(_breakPoint, on: false);
+        IsEnabled = false;
+    }
+
+    internal bool IsFor(CpuInstructionInfo instructionInfo) {
+        return _breakPoint is AddressBreakPoint addressBreakPoint && addressBreakPoint.Address == instructionInfo.Address;
+    }
+}

src/Spice86/ViewModels/BreakpointsViewModel.cs

@@ -0,0 +1,70 @@
+namespace Spice86.ViewModels;
+
+using CommunityToolkit.Mvvm.ComponentModel;
+using CommunityToolkit.Mvvm.Input;
+
+using Spice86.Core.Emulator.VM;
+using Spice86.Core.Emulator.VM.Breakpoint;
+using Spice86.Models.Debugging;
+
+using System.Collections.ObjectModel;
+
+public partial class BreakpointsViewModel : ViewModelBase {
+    private readonly EmulatorBreakpointsManager _emulatorBreakpointsManager;
+
+    public BreakpointsViewModel(EmulatorBreakpointsManager emulatorBreakpointsManager) {
+        _emulatorBreakpointsManager = emulatorBreakpointsManager;
+    }
+
+    [ObservableProperty]
+    private ObservableCollection<BreakpointViewModel> _breakpoints = new();
+
+    [RelayCommand(CanExecute = nameof(ToggleSelectedBreakpointCanExecute))]
+    private void ToggleSelectedBreakpoint() {
+        if (SelectedBreakpoint is not null) {
+            SelectedBreakpoint.Toggle();
+        }
+    }
+
+    private bool ToggleSelectedBreakpointCanExecute() => SelectedBreakpoint is not null;
+
+    [ObservableProperty]
+    [NotifyCanExecuteChangedFor(nameof(RemoveBreakpointCommand))]
+    [NotifyCanExecuteChangedFor(nameof(ToggleSelectedBreakpointCommand))]
+    private BreakpointViewModel? _selectedBreakpoint;
+
+    internal void AddAddressBreakpoint(AddressBreakPoint addressBreakPoint) {
+        var breakpointViewModel = new BreakpointViewModel( _emulatorBreakpointsManager, addressBreakPoint);
+        Breakpoints.Add(breakpointViewModel);
+        SelectedBreakpoint = breakpointViewModel;
+        SelectedBreakpoint.Enable();
+    }
+
+    private bool RemoveBreakpointCanExecute() => SelectedBreakpoint is not null;
+
+
+    [RelayCommand(CanExecute = nameof(RemoveBreakpointCanExecute))]
+    private void RemoveBreakpoint() {
+        if (SelectedBreakpoint is not null) {
+            DeleteBreakpoint(SelectedBreakpoint);
+        }
+    }
+
+    internal void RemoveUserExecutionBreakpoint(CpuInstructionInfo instructionInfo) {
+        DeleteBreakpoint(Breakpoints.FirstOrDefault(x => x.IsFor(instructionInfo) && x is
+            { IsRemovedOnTrigger: false, Type: BreakPointType.EXECUTION }));
+    }
+
+    internal bool HasUserExecutionBreakpoint(CpuInstructionInfo instructionInfo) {
+        return Breakpoints.Any(x => x.IsFor(instructionInfo) && x is
+            { IsRemovedOnTrigger: false, Type: BreakPointType.EXECUTION });
+    }
+
+    private void DeleteBreakpoint(BreakpointViewModel? breakpoint) {
+        if (breakpoint is null) {
+            return;
+        }
+        breakpoint.Disable();
+        Breakpoints.Remove(breakpoint);
+    }
+}

src/Spice86/ViewModels/CfgCpuViewModel.cs

@@ -5,6 +5,7 @@
 using AvaloniaGraphControl;
 
 using CommunityToolkit.Mvvm.ComponentModel;
+using CommunityToolkit.Mvvm.Input;
 
 using Spice86.Core.Emulator.CPU.CfgCpu;
 using Spice86.Core.Emulator.CPU.CfgCpu.ControlFlowGraph;
@@ -32,18 +33,13 @@ public CfgCpuViewModel(ExecutionContextManager executionContextManager, IPauseHa
         IPerformanceMeasurer performanceMeasurer) {
         _executionContextManager = executionContextManager;
         _performanceMeasurer = performanceMeasurer;
-        pauseHandler.Pausing += OnPausing;
+        pauseHandler.Pausing += () => UpdateGraphCommand.Execute(null);
     }
 
-    private void OnPausing() {
+    [RelayCommand]
+    private async Task UpdateGraph() {
         Graph = null;
-        // This call of an async method from a sync method uses the async method and discards the Task.
-        // If this method fails, it will not crash the process.
-        // Instead, it will fire the TaskScheduler.UnobservedTaskException event.
-        // See https://github.com/davidfowl/AspNetCoreDiagnosticScenarios/blob/master/AsyncGuidance.md
-        // The alternative, making this event handler 'async void' would crash the process in case of an exception,
-        // unless a try/catch is put over the *entire* code of the sync method.
-        _ = UpdateCurrentGraphAsync();
+        await UpdateCurrentGraphAsync();
     }
 
     partial void OnMaxNodesToDisplayChanging(int value) => Graph = null;

src/Spice86/ViewModels/CpuViewModel.cs

@@ -5,6 +5,7 @@ namespace Spice86.ViewModels;
 using CommunityToolkit.Mvvm.ComponentModel;
 
 using Spice86.Core.Emulator.CPU;
+using Spice86.Core.Emulator.Memory;
 using Spice86.Core.Emulator.VM;
 using Spice86.Infrastructure;
 using Spice86.Models.Debugging;
@@ -14,15 +15,17 @@ namespace Spice86.ViewModels;
 
 public partial class CpuViewModel : ViewModelBase {
     private readonly State _cpuState;
+    private readonly IMemory _memory;
 
     [ObservableProperty]
     private StateInfo _state = new();
 
     [ObservableProperty]
     private CpuFlagsInfo _flags = new();
 
-    public CpuViewModel(State state, IPauseHandler pauseHandler, IUIDispatcher uiDispatcher) {
+    public CpuViewModel(State state, Stack stack, IMemory memory, IPauseHandler pauseHandler, IUIDispatcher uiDispatcher) {
         _cpuState = state;
+        _memory = memory;
         pauseHandler.Pausing += () => uiDispatcher.Post(() => _isPaused = true);
         _isPaused = pauseHandler.IsPaused;
         pauseHandler.Resumed += () => uiDispatcher.Post(() => _isPaused = false);
@@ -46,8 +49,6 @@ private void VisitCpuState(State state) {
             Flags.PropertyChanged -= OnStatePropertyChanged;
         }
 
-        return;
-
         void OnStatePropertyChanged(object? sender, PropertyChangedEventArgs e) {
             if (sender is null || e.PropertyName == null || !_isPaused) {
                 return;
@@ -59,6 +60,16 @@ void OnStatePropertyChanged(object? sender, PropertyChangedEventArgs e) {
             }
         }
     }
+
+    [ObservableProperty]
+    private string? _esiString;
+
+    [ObservableProperty]
+    private string? _ediString;
+
+    [ObservableProperty]
+    private string? _espString;
+
     private void UpdateCpuState(State state) {
         State.AH = state.AH;
         State.AL = state.AL;
@@ -91,6 +102,9 @@ private void UpdateCpuState(State state) {
         State.GS = state.GS;
         State.SS = state.SS;
         State.IP = state.IP;
+        EspString = _memory.GetZeroTerminatedString(State.ESP, 32);
+        EsiString = _memory.GetZeroTerminatedString(State.ESI, 32);
+        EdiString = _memory.GetZeroTerminatedString(State.EDI, 32);
         State.Cycles = state.Cycles;
         State.IpPhysicalAddress = state.IpPhysicalAddress;
         State.StackPhysicalAddress = state.StackPhysicalAddress;