[Lldb-commits] [lldb] 3c33d72 - [lldb] Move ScriptedProcess private state update to implementation
Med Ismail Bennani via lldb-commits
lldb-commits at lists.llvm.org
Mon Mar 6 13:14:33 PST 2023
Author: Med Ismail Bennani
Date: 2023-03-06T13:14:15-08:00
New Revision: 3c33d72e7fa83beb8a9b39fb3b8ecf4ee00c697d
URL: https://github.com/llvm/llvm-project/commit/3c33d72e7fa83beb8a9b39fb3b8ecf4ee00c697d
DIFF: https://github.com/llvm/llvm-project/commit/3c33d72e7fa83beb8a9b39fb3b8ecf4ee00c697d.diff
LOG: [lldb] Move ScriptedProcess private state update to implementation
While debugging a Scripted Process, in order to update its state and
work nicely with lldb's execution model, it needs to toggle its private
state from running to stopped, which will result in broadcasting a
process state changed event to the debugger listener.
Originally, this state update was done systematically in the Scripted
Process C++ plugin, however in order to make scripted process
interactive, we need to be able to update their state dynamically.
This patch makes use of the recent addition of the
`SBProcess::ForceScriptedState` to programatically, and moves the
process private state update to the python implementation of the `resume`
method instead of doing it in `ScriptedProcess::DoResume`.
This patch also removes the unused `ShouldStop` & `Stop` scripted
process APIs, and adds new ScriptedInterface transform methods for
boolean arguments. This allow the user to programmatically decide if
after running the process, we should stop it (which is the default setting).
Differential Revision: https://reviews.llvm.org/D145295
Signed-off-by: Med Ismail Bennani <medismail.bennani at gmail.com>
Added:
Modified:
lldb/examples/python/scripted_process/scripted_process.py
lldb/include/lldb/Interpreter/ScriptedProcessInterface.h
lldb/source/Plugins/Process/scripted/ScriptedProcess.cpp
lldb/source/Plugins/Process/scripted/ScriptedProcess.h
lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h
lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp
lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.h
lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.h
Removed:
################################################################################
diff --git a/lldb/examples/python/scripted_process/scripted_process.py b/lldb/examples/python/scripted_process/scripted_process.py
index 044aee1338808..8b3c16153e286 100644
--- a/lldb/examples/python/scripted_process/scripted_process.py
+++ b/lldb/examples/python/scripted_process/scripted_process.py
@@ -160,30 +160,24 @@ def attach(self, attach_info):
"""
return lldb.SBError()
- def resume(self):
+ def resume(self, should_stop=True):
""" Simulate the scripted process resume.
- Returns:
- lldb.SBError: An `lldb.SBError` with error code 0.
- """
- return lldb.SBError()
-
- @abstractmethod
- def should_stop(self):
- """ Check if the scripted process plugin should produce the stop event.
-
- Returns:
- bool: True if scripted process should broadcast a stop event.
- False otherwise.
- """
- pass
-
- def stop(self):
- """ Trigger the scripted process stop.
+ Args:
+ should_stop (bool): If True, resume will also
Returns:
lldb.SBError: An `lldb.SBError` with error code 0.
"""
+ process = self.target.GetProcess()
+ if not process:
+ error = lldb.SBError()
+ error.SetErrorString("Invalid process.")
+ return error
+
+ process.ForceScriptedState(lldb.eStateRunning);
+ if (should_stop):
+ process.ForceScriptedState(lldb.eStateStopped);
return lldb.SBError()
@abstractmethod
diff --git a/lldb/include/lldb/Interpreter/ScriptedProcessInterface.h b/lldb/include/lldb/Interpreter/ScriptedProcessInterface.h
index ba4743077e029..977a8d923c355 100644
--- a/lldb/include/lldb/Interpreter/ScriptedProcessInterface.h
+++ b/lldb/include/lldb/Interpreter/ScriptedProcessInterface.h
@@ -38,10 +38,6 @@ class ScriptedProcessInterface : virtual public ScriptedInterface {
virtual Status Resume() { return Status("ScriptedProcess did not resume"); }
- virtual bool ShouldStop() { return true; }
-
- virtual Status Stop() { return Status("ScriptedProcess did not stop"); }
-
virtual std::optional<MemoryRegionInfo>
GetMemoryRegionContainingAddress(lldb::addr_t address, Status &error) {
error.SetErrorString("ScriptedProcess have no memory region.");
diff --git a/lldb/source/Plugins/Process/scripted/ScriptedProcess.cpp b/lldb/source/Plugins/Process/scripted/ScriptedProcess.cpp
index 948ee691ecbe4..79365f9b69758 100644
--- a/lldb/source/Plugins/Process/scripted/ScriptedProcess.cpp
+++ b/lldb/source/Plugins/Process/scripted/ScriptedProcess.cpp
@@ -187,8 +187,6 @@ Status ScriptedProcess::DoResume() {
if (resume) {
LLDB_LOGF(log, "ScriptedProcess::%s sending resume", __FUNCTION__);
- SetPrivateState(eStateRunning);
- SetPrivateState(eStateStopped);
error = GetInterface().Resume();
}
@@ -223,19 +221,6 @@ void ScriptedProcess::DidAttach(ArchSpec &process_arch) {
process_arch = GetArchitecture();
}
-Status ScriptedProcess::DoStop() {
- Log *log = GetLog(LLDBLog::Process);
-
- if (GetInterface().ShouldStop()) {
- SetPrivateState(eStateStopped);
- LLDB_LOGF(log, "ScriptedProcess::%s Immediate stop", __FUNCTION__);
- return {};
- }
-
- LLDB_LOGF(log, "ScriptedProcess::%s Delayed stop", __FUNCTION__);
- return GetInterface().Stop();
-}
-
Status ScriptedProcess::DoDestroy() { return Status(); }
bool ScriptedProcess::IsAlive() { return GetInterface().IsAlive(); }
diff --git a/lldb/source/Plugins/Process/scripted/ScriptedProcess.h b/lldb/source/Plugins/Process/scripted/ScriptedProcess.h
index 502197d21a939..728c96a904e4b 100644
--- a/lldb/source/Plugins/Process/scripted/ScriptedProcess.h
+++ b/lldb/source/Plugins/Process/scripted/ScriptedProcess.h
@@ -96,8 +96,6 @@ class ScriptedProcess : public Process {
ScriptedProcess(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp,
const ScriptedMetadata &scripted_metadata, Status &error);
- Status DoStop();
-
void Clear();
bool DoUpdateThreadList(ThreadList &old_thread_list,
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h
index 365d499bead86..33092209b1778 100644
--- a/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h
+++ b/lldb/source/Plugins/ScriptInterpreter/Python/PythonDataObjects.h
@@ -201,6 +201,7 @@ template <> struct PythonFormat<short> : PassthroughFormat<short, 'h'> {};
template <>
struct PythonFormat<unsigned short> : PassthroughFormat<unsigned short, 'H'> {};
template <> struct PythonFormat<int> : PassthroughFormat<int, 'i'> {};
+template <> struct PythonFormat<bool> : PassthroughFormat<bool, 'p'> {};
template <>
struct PythonFormat<unsigned int> : PassthroughFormat<unsigned int, 'I'> {};
template <> struct PythonFormat<long> : PassthroughFormat<long, 'l'> {};
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp
index cffa3bda3ab03..0c6f30841dfae 100644
--- a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp
+++ b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.cpp
@@ -80,21 +80,8 @@ Status ScriptedProcessPythonInterface::Launch() {
}
Status ScriptedProcessPythonInterface::Resume() {
- return GetStatusFromMethod("resume");
-}
-
-bool ScriptedProcessPythonInterface::ShouldStop() {
- Status error;
- StructuredData::ObjectSP obj = Dispatch("is_alive", error);
-
- if (!CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj, error))
- return {};
-
- return obj->GetBooleanValue();
-}
-
-Status ScriptedProcessPythonInterface::Stop() {
- return GetStatusFromMethod("stop");
+ // When calling ScriptedProcess.Resume from lldb we should always stop.
+ return GetStatusFromMethod("resume", /*should_stop=*/true);
}
std::optional<MemoryRegionInfo>
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.h b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.h
index b7b12b93a002b..d1fedfe68fd5f 100644
--- a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.h
+++ b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedProcessPythonInterface.h
@@ -37,10 +37,6 @@ class ScriptedProcessPythonInterface : public ScriptedProcessInterface,
Status Resume() override;
- bool ShouldStop() override;
-
- Status Stop() override;
-
std::optional<MemoryRegionInfo>
GetMemoryRegionContainingAddress(lldb::addr_t address,
Status &error) override;
diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.h b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.h
index a015bd106b5c6..31757a20a9dcb 100644
--- a/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.h
+++ b/lldb/source/Plugins/ScriptInterpreter/Python/ScriptedPythonInterface.h
@@ -113,6 +113,11 @@ class ScriptedPythonInterface : virtual public ScriptedInterface {
return {object};
}
+ python::PythonObject Transform(bool arg) {
+ // Boolean arguments need to be turned into python objects.
+ return python::PythonBoolean(arg);
+ }
+
python::PythonObject Transform(Status arg) {
return python::ToSWIGWrapper(arg);
}
@@ -141,6 +146,15 @@ class ScriptedPythonInterface : virtual public ScriptedInterface {
original_arg = ExtractValueFromPythonObject<T>(transformed_arg, error);
}
+ template <>
+ void ReverseTransform(bool &original_arg,
+ python::PythonObject transformed_arg, Status &error) {
+ python::PythonBoolean boolean_arg = python::PythonBoolean(
+ python::PyRefType::Borrowed, transformed_arg.get());
+ if (boolean_arg.IsValid())
+ original_arg = boolean_arg.GetValue();
+ }
+
template <std::size_t... I, typename... Args>
auto TransformTuple(const std::tuple<Args...> &args,
std::index_sequence<I...>) {
More information about the lldb-commits
mailing list