Add restart_and_wait API and add a unit test for it. Fix Vector35#608

1ikeadragon · Aug 19, 2024 · f5303e5 · f5303e5
1 parent 4677199
commit f5303e5
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 3 deletions.
diff --git a/api/debuggerapi.h b/api/debuggerapi.h
@@ -527,6 +527,7 @@ namespace BinaryNinjaDebuggerAPI {
 		DebugStopReason RunToAndWait(uint64_t remoteAddresses);
 		DebugStopReason RunToAndWait(const std::vector<uint64_t>& remoteAddresses);
 		DebugStopReason PauseAndWait();
+		DebugStopReason RestartAndWait();
 
 		std::string GetAdapterType();
 		void SetAdapterType(const std::string& adapter);

diff --git a/api/debuggercontroller.cpp b/api/debuggercontroller.cpp
@@ -501,6 +501,12 @@ DebugStopReason DebuggerController::PauseAndWait()
 }
 
 
+DebugStopReason DebuggerController::RestartAndWait()
+{
+	return BNDebuggerRestartAndWait(m_object);
+}
+
+
 std::string DebuggerController::GetAdapterType()
 {
 	char* adapter = BNDebuggerGetAdapterType(m_object);

diff --git a/api/ffi.h b/api/ffi.h
@@ -426,6 +426,7 @@ extern "C"
 	DEBUGGER_FFI_API BNDebugStopReason BNDebuggerRunToAndWait(
 		BNDebuggerController* controller, const uint64_t* remoteAddresses, size_t count);
 	DEBUGGER_FFI_API BNDebugStopReason BNDebuggerPauseAndWait(BNDebuggerController* controller);
+	DEBUGGER_FFI_API BNDebugStopReason BNDebuggerRestartAndWait(BNDebuggerController* controller);
 
 	DEBUGGER_FFI_API char* BNDebuggerGetAdapterType(BNDebuggerController* controller);
 	DEBUGGER_FFI_API void BNDebuggerSetAdapterType(BNDebuggerController* controller, const char* adapter);

diff --git a/api/python/debuggercontroller.py b/api/python/debuggercontroller.py
@@ -1143,6 +1143,14 @@ def pause_and_wait(self) -> None:
         """
         dbgcore.BNDebuggerPauseAndWait(self.handle)
 
+    def restart_and_wait(self) -> None:
+        """
+        Restart a running target.
+
+        The call is blocking and only returns when the target stops again after the restart.
+        """
+        dbgcore.BNDebuggerRestartAndWait(self.handle)
+
     @property
     def adapter_type(self) -> str:
         """

diff --git a/core/debuggercontroller.cpp b/core/debuggercontroller.cpp
@@ -1159,10 +1159,23 @@ std::vector<DebugFrame> DebuggerController::GetFramesOfThread(uint64_t tid)
 }
 
 
-void DebuggerController::Restart()
+bool DebuggerController::Restart()
 {
+	if (!m_state->IsConnected())
+		return false;
+
+	std::thread([&]() { RestartAndWait(); }).detach();
+	return true;
+}
+
+
+DebugStopReason DebuggerController::RestartAndWait()
+{
+	if (!m_state->IsConnected())
+		return InvalidStatusOrOperation;
+
 	QuitAndWait();
-	Launch();
+	return LaunchAndWait();
 }
 
 

diff --git a/core/debuggercontroller.h b/core/debuggercontroller.h
@@ -230,7 +230,7 @@ namespace BinaryNinjaDebugger {
 
 		// target control
 		bool Execute();
-		void Restart();
+		bool Restart();
 		bool ConnectToDebugServer();
 		bool DisconnectDebugServer();
 		// Convenience function, either launch the target process or connect to a remote, depending on the selected
@@ -261,6 +261,7 @@ namespace BinaryNinjaDebugger {
 		DebugStopReason GoAndWait();
 		DebugStopReason GoReverseAndWait();
 		DebugStopReason AttachAndWait();
+		DebugStopReason RestartAndWait();
 		DebugStopReason ConnectAndWait();
 		DebugStopReason StepIntoAndWait(BNFunctionGraphType il = NormalFunctionGraph);
 		DebugStopReason StepIntoReverseAndWait(BNFunctionGraphType il = NormalFunctionGraph);

diff --git a/core/ffi.cpp b/core/ffi.cpp
@@ -587,6 +587,12 @@ DebugStopReason BNDebuggerPauseAndWait(BNDebuggerController* controller)
 }
 
 
+DebugStopReason BNDebuggerRestartAndWait(BNDebuggerController* controller)
+{
+	return controller->object->RestartAndWait();
+}
+
+
 char* BNDebuggerGetAdapterType(BNDebuggerController* controller)
 {
 	if (!controller->object->GetState())

diff --git a/test/debugger_test.py b/test/debugger_test.py
@@ -259,6 +259,26 @@ def test_thread(self):
         self.assertGreater(len(threads), 1)
         dbg.quit_and_wait()
 
+    def test_restart(self):
+        fpath = name_to_fpath('helloworld_thread', self.arch)
+        bv = load(fpath)
+        dbg = DebuggerController(bv)
+        self.assertNotIn(dbg.launch_and_wait(), [DebugStopReason.ProcessExited, DebugStopReason.InternalError])
+
+        dbg.go()
+        time.sleep(1)
+        dbg.pause_and_wait()
+        self.assertGreater(len(dbg.threads), 1)
+
+        ret = dbg.restart_and_wait()
+        self.assertNotIn(ret, [DebugStopReason.ProcessExited, DebugStopReason.InternalError])
+
+        dbg.go()
+        time.sleep(1)
+        ret = dbg.restart_and_wait()
+        self.assertNotIn(ret, [DebugStopReason.ProcessExited, DebugStopReason.InternalError])
+        dbg.quit_and_wait()
+
     def test_assembly_code(self):
         if self.arch == 'x86_64':
             fpath = name_to_fpath('asmtest', 'x86_64')