Stop tools before rebooting. Fixes crash if a Lua script's exit handler did a memory read or write.

Author: SuuperW

src/BizHawk.Client.Common/tools/Interfaces/IToolForm.cs

@@ -27,6 +27,12 @@ public interface IToolForm
 		/// </summary>
 		void UpdateValues(ToolFormUpdateType type);
 
+		/// <summary>
+		/// Stop the tool, in preparation for a game or core change.
+		/// A tool should expect that either <see cref="Restart"/> or <see cref="Close"/> will be called after this.
+		/// </summary>
+		void Stop();
+
 		/// <summary>
 		/// Will be called anytime the dialog needs to be restarted, such as when a new ROM is loaded
 		/// The tool implementing this needs to account for a Game and Core change

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -3942,6 +3942,8 @@ private bool CloseGame(bool clearSram = false)
 				if (saveMovieResult == TryAgainResult.Canceled) return false;
 			}
 
+			Tools.Stop();
+
 			if (clearSram)
 			{
 				var path = Config.PathEntries.SaveRamAbsolutePath(Game, MovieSession.Movie);

src/BizHawk.Client.EmuHawk/tools/BasicBot/BasicBot.cs

@@ -263,6 +263,18 @@ public string FromSlot
 		protected override void UpdateAfter() => Update(fast: false);
 		protected override void FastUpdateAfter() => Update(fast: true);
 
+		public override void Stop()
+		{
+			if (_isBotting)
+			{
+				StopBot();
+			}
+			else if (_replayMode)
+			{
+				FinishReplay();
+			}
+		}
+
 		public override void Restart()
 		{
 			_ = StatableCore!; // otherwise unused due to loadstating via MainForm; however this service is very much required so the property needs to be present
@@ -275,16 +287,6 @@ public override void Restart()
 				_dataSize = 1;
 			}
 
-			if (_isBotting)
-			{
-				StopBot();
-			}
-			else if (_replayMode)
-			{
-				FinishReplay();
-			}
-
-
 			if (_lastRom != MainForm.CurrentlyOpenRom)
 			{
 				_lastRom = MainForm.CurrentlyOpenRom;

src/BizHawk.Client.EmuHawk/tools/Debugger/GenericDebugger.IToolForm.cs

@@ -112,10 +112,14 @@ private void FullUpdate()
 			BreakPointControl1.UpdateValues();
 		}
 
+		public override void Stop()
+		{
+			DisengageDebugger();
+		}
+
 		public override void Restart()
 		{
 			UpdateCapabilitiesProps();
-			DisengageDebugger();
 			EngageDebugger();
 		}
 

src/BizHawk.Client.EmuHawk/tools/Lua/LuaConsole.cs

@@ -156,6 +156,7 @@ public LuaConsole()
 		}
 
 		private LuaLibraries LuaImp;
+		private List<LuaFile> _scriptsToRestart = new();
 
 		private IEnumerable<LuaFile> SelectedItems =>  LuaListView.SelectedRows.Select(index => LuaImp.ScriptList[index]);
 
@@ -186,10 +187,22 @@ private void BranchesMarkersSplit_SplitterMoved(object sender, SplitterEventArgs
 			Settings.SplitDistance = splitContainer1.SplitterDistance;
 		}
 
-		public override void Restart()
+		public override void Stop()
 		{
-			List<LuaFile> runningScripts = new();
+			if (LuaImp is not null && !LuaImp.IsRebootingCore)
+			{
+				_scriptsToRestart = LuaImp.ScriptList.Where(lf => lf.Enabled).ToList();
 
+				// we don't use _scriptsToRestart here as the other scripts need to be stopped too
+				foreach (var file in LuaImp.ScriptList)
+				{
+					DisableLuaScript(file);
+				}
+			}
+		}
+
+		public override void Restart()
+		{
 			ApiContainer apiContainer = ApiManager.RestartLua(
 				Emulator.ServiceProvider,
 				WriteToOutputWindow,
@@ -203,23 +216,11 @@ public override void Restart()
 				Game,
 				DialogController);
 
-			// Things we need to do with the existing LuaImp before we can make a new one
-			if (LuaImp is not null)
+			if (LuaImp is not null && LuaImp.IsRebootingCore)
 			{
-				if (LuaImp.IsRebootingCore)
-				{
-					// Even if the lua console is self-rebooting from client.reboot_core() we still want to re-inject dependencies
-					LuaImp.Restart(Emulator.ServiceProvider, Config, apiContainer);
-					return;
-				}
-
-				runningScripts = LuaImp.ScriptList.Where(lf => lf.Enabled).ToList();
-
-				// we don't use runningScripts here as the other scripts need to be stopped too
-				foreach (var file in LuaImp.ScriptList)
-				{
-					DisableLuaScript(file);
-				}
+				// Even if the lua console is self-rebooting from client.reboot_core() we still want to re-inject dependencies
+				LuaImp.Restart(Emulator.ServiceProvider, Config, apiContainer);
+				return;
 			}
 
 			LuaFileList newScripts = new(LuaImp?.ScriptList, onChanged: SessionChangedCallback);
@@ -240,7 +241,7 @@ public override void Restart()
 				.Select(static f => $"{f.Library}.{f.Name}")
 				.ToArray());
 
-			foreach (var file in runningScripts)
+			foreach (var file in _scriptsToRestart)
 			{
 				try
 				{

src/BizHawk.Client.EmuHawk/tools/ToolFormBase.cs

@@ -31,6 +31,8 @@ public class ToolFormBase : FormBase, IToolForm, IDialogParent
 		public virtual bool IsActive => IsHandleCreated && !IsDisposed;
 		public virtual bool IsLoaded => IsActive;
 
+		public virtual void Stop() {}
+
 		public virtual void Restart() {}
 
 		public void SetToolFormBaseProps(

src/BizHawk.Client.EmuHawk/tools/ToolManager.cs

@@ -34,6 +34,7 @@ public class ToolManager
 		// For instance, add an IToolForm property called UsesCheats, so that a UpdateCheatRelatedTools() method can update all tools of this type
 		// Also a UsesRam, and similar method
 		private readonly List<IToolForm> _tools = new List<IToolForm>();
+		private readonly List<IToolForm> _toolsToRestart = new();
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="ToolManager"/> class.
@@ -589,6 +590,15 @@ public void GeneralUpdateActiveExtTools()
 			}
 		}
 
+		public void Stop()
+		{
+			foreach (IToolForm tool in _tools.Where(static t => t.IsActive))
+			{
+				_toolsToRestart.Add(tool);
+				tool.Stop();
+			}
+		}
+
 		public void Restart(Config config, IEmulator emulator, IGameInfo game)
 		{
 			_config = config;
@@ -604,7 +614,7 @@ public void Restart(Config config, IEmulator emulator, IGameInfo game)
 				if (ServiceInjector.UpdateServices(_emulator.ServiceProvider, tool)
 					&& (tool is not IExternalToolForm || ApiInjector.UpdateApis(GetOrInitApiProvider, tool)))
 				{
-					if (tool.IsActive) tool.Restart();
+					if (_toolsToRestart.Contains(tool)) tool.Restart();
 				}
 				else
 				{
@@ -618,6 +628,8 @@ public void Restart(Config config, IEmulator emulator, IGameInfo game)
 				tool.Close();
 				_tools.Remove(tool);
 			}
+
+			_toolsToRestart.Clear();
 		}
 
 		/// <summary>