Med Ismail Bennani
1b4a578a9f
Replace the (class_name, args_sp) parameter pair on CreatePluginObject across the scripted plugin interfaces (ScriptedThread, OperatingSystem, ScriptedBreakpoint, ScriptedFrameProvider, ScriptedProcess, and the underlying ScriptedPythonInterface template) with a single `const ScriptedMetadata &`. Callers (OperatingSystemPython, ScriptedThread, ScriptedProcess, BreakpointResolverScripted, ScriptedFrameProvider) pass their existing ScriptedMetadata directly, removing the need to re-bundle class_name and args at every call site. ScriptedBreakpoint, ScriptedFrameProvider and ScriptedProcess no longer carry a redundant `args_sp` parameter; their callers fold those args into the metadata, and the Python overrides reconstruct a StructuredDataImpl from the metadata's args dict for the dispatched call. ScriptedInterface gains an `m_scripted_metadata` member and a `GetScriptedMetadata()` accessor; ScriptedPythonInterface populates it when CreatePluginObject is invoked so subclasses can later report which script class is in play. Hook/StopHook/ThreadPlan public interfaces keep their existing `args_sp` parameter for now; subsequent commits consolidate that. Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
116 lines
3.7 KiB
C++
116 lines
3.7 KiB
C++
//===-- ScriptedThreadPlanPythonInterface.cpp -----------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "../lldb-python.h"
|
|
|
|
#include "lldb/Core/PluginManager.h"
|
|
#include "lldb/Utility/Log.h"
|
|
#include "lldb/lldb-enumerations.h"
|
|
|
|
#include "../SWIGPythonBridge.h"
|
|
#include "../ScriptInterpreterPythonImpl.h"
|
|
#include "ScriptedThreadPlanPythonInterface.h"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
using namespace lldb_private::python;
|
|
|
|
ScriptedThreadPlanPythonInterface::ScriptedThreadPlanPythonInterface(
|
|
ScriptInterpreterPythonImpl &interpreter)
|
|
: ScriptedThreadPlanInterface(), ScriptedPythonInterface(interpreter) {}
|
|
|
|
llvm::Expected<StructuredData::GenericSP>
|
|
ScriptedThreadPlanPythonInterface::CreatePluginObject(
|
|
const ScriptedMetadata &scripted_metadata,
|
|
lldb::ThreadPlanSP thread_plan_sp, const StructuredDataImpl &args_sp) {
|
|
return ScriptedPythonInterface::CreatePluginObject(scripted_metadata, nullptr,
|
|
thread_plan_sp, args_sp);
|
|
}
|
|
|
|
llvm::Expected<bool>
|
|
ScriptedThreadPlanPythonInterface::ExplainsStop(Event *event) {
|
|
Status error;
|
|
StructuredData::ObjectSP obj = Dispatch("explains_stop", error, event);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error)) {
|
|
if (!obj)
|
|
return false;
|
|
return error.ToError();
|
|
}
|
|
|
|
return obj->GetBooleanValue();
|
|
}
|
|
|
|
llvm::Expected<bool>
|
|
ScriptedThreadPlanPythonInterface::ShouldStop(Event *event) {
|
|
Status error;
|
|
StructuredData::ObjectSP obj = Dispatch("should_stop", error, event);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error)) {
|
|
if (!obj)
|
|
return false;
|
|
return error.ToError();
|
|
}
|
|
|
|
return obj->GetBooleanValue();
|
|
}
|
|
|
|
llvm::Expected<bool> ScriptedThreadPlanPythonInterface::IsStale() {
|
|
Status error;
|
|
StructuredData::ObjectSP obj = Dispatch("is_stale", error);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error)) {
|
|
if (!obj)
|
|
return false;
|
|
return error.ToError();
|
|
}
|
|
|
|
return obj->GetBooleanValue();
|
|
}
|
|
|
|
lldb::StateType ScriptedThreadPlanPythonInterface::GetRunState() {
|
|
Status error;
|
|
StructuredData::ObjectSP obj = Dispatch("should_step", error);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error))
|
|
return lldb::eStateStepping;
|
|
|
|
return static_cast<lldb::StateType>(obj->GetUnsignedIntegerValue(
|
|
static_cast<uint32_t>(lldb::eStateStepping)));
|
|
}
|
|
|
|
llvm::Error
|
|
ScriptedThreadPlanPythonInterface::GetStopDescription(lldb::StreamSP &stream) {
|
|
Status error;
|
|
Dispatch("stop_description", error, stream);
|
|
|
|
if (error.Fail())
|
|
return error.ToError();
|
|
|
|
return llvm::Error::success();
|
|
}
|
|
|
|
void ScriptedThreadPlanPythonInterface::Initialize() {
|
|
const std::vector<llvm::StringRef> ci_usages = {
|
|
"thread step-scripted -C <script-name> [-k key -v value ...]"};
|
|
const std::vector<llvm::StringRef> api_usages = {
|
|
"SBThread.StepUsingScriptedThreadPlan"};
|
|
PluginManager::RegisterPlugin(
|
|
GetPluginNameStatic(),
|
|
llvm::StringRef("Alter thread stepping logic and stop reason"),
|
|
CreateInstance, eScriptLanguagePython, {ci_usages, api_usages});
|
|
}
|
|
|
|
void ScriptedThreadPlanPythonInterface::Terminate() {
|
|
PluginManager::UnregisterPlugin(CreateInstance);
|
|
}
|