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>
125 lines
4.4 KiB
C++
125 lines
4.4 KiB
C++
//===----------------------------------------------------------------------===//
|
|
//
|
|
// 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/Target/Thread.h"
|
|
#include "lldb/Utility/Log.h"
|
|
#include "lldb/lldb-enumerations.h"
|
|
|
|
#include "../SWIGPythonBridge.h"
|
|
#include "../ScriptInterpreterPythonImpl.h"
|
|
#include "ScriptedFrameProviderPythonInterface.h"
|
|
#include <optional>
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
using namespace lldb_private::python;
|
|
using Locker = ScriptInterpreterPythonImpl::Locker;
|
|
|
|
ScriptedFrameProviderPythonInterface::ScriptedFrameProviderPythonInterface(
|
|
ScriptInterpreterPythonImpl &interpreter)
|
|
: ScriptedFrameProviderInterface(), ScriptedPythonInterface(interpreter) {}
|
|
|
|
bool ScriptedFrameProviderPythonInterface::AppliesToThread(
|
|
llvm::StringRef class_name, lldb::ThreadSP thread_sp) {
|
|
// If there is any issue with this method, we will just assume it also applies
|
|
// to this thread which is the default behavior.
|
|
constexpr bool fail_value = true;
|
|
Status error;
|
|
StructuredData::ObjectSP obj =
|
|
CallStaticMethod(class_name, "applies_to_thread", error, thread_sp);
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error))
|
|
return fail_value;
|
|
|
|
return obj->GetBooleanValue(fail_value);
|
|
}
|
|
|
|
llvm::Expected<StructuredData::GenericSP>
|
|
ScriptedFrameProviderPythonInterface::CreatePluginObject(
|
|
const ScriptedMetadata &scripted_metadata,
|
|
lldb::StackFrameListSP input_frames) {
|
|
if (!input_frames)
|
|
return llvm::createStringError("invalid frame list");
|
|
|
|
return ScriptedPythonInterface::CreatePluginObject(
|
|
scripted_metadata, nullptr, input_frames, scripted_metadata.GetArgsSP());
|
|
}
|
|
|
|
std::string ScriptedFrameProviderPythonInterface::GetDescription(
|
|
llvm::StringRef class_name) {
|
|
Status error;
|
|
StructuredData::ObjectSP obj =
|
|
CallStaticMethod(class_name, "get_description", error);
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error))
|
|
return {};
|
|
|
|
return obj->GetStringValue().str();
|
|
}
|
|
|
|
std::optional<uint32_t>
|
|
ScriptedFrameProviderPythonInterface::GetPriority(llvm::StringRef class_name) {
|
|
Status error;
|
|
StructuredData::ObjectSP obj =
|
|
CallStaticMethod(class_name, "get_priority", error);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error))
|
|
return std::nullopt;
|
|
|
|
// Try to extract as unsigned integer. Return nullopt if Python returned None
|
|
// or if extraction fails.
|
|
if (StructuredData::UnsignedInteger *int_obj = obj->GetAsUnsignedInteger())
|
|
return static_cast<uint32_t>(int_obj->GetValue());
|
|
|
|
return std::nullopt;
|
|
}
|
|
|
|
StructuredData::ObjectSP
|
|
ScriptedFrameProviderPythonInterface::GetFrameAtIndex(uint32_t index) {
|
|
Status error;
|
|
StructuredData::ObjectSP obj = Dispatch("get_frame_at_index", error, index);
|
|
|
|
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
|
|
error))
|
|
return {};
|
|
|
|
return obj;
|
|
}
|
|
|
|
bool ScriptedFrameProviderPythonInterface::CreateInstance(
|
|
lldb::ScriptLanguage language, ScriptedInterfaceUsages usages) {
|
|
if (language != eScriptLanguagePython)
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
void ScriptedFrameProviderPythonInterface::Initialize() {
|
|
const std::vector<llvm::StringRef> ci_usages = {
|
|
"target frame-provider register -C <script-name> [-k key -v value ...]",
|
|
"target frame-provider list",
|
|
"target frame-provider remove <provider-name>",
|
|
"target frame-provider clear"};
|
|
const std::vector<llvm::StringRef> api_usages = {
|
|
"SBTarget.RegisterScriptedFrameProvider",
|
|
"SBTarget.RemoveScriptedFrameProvider",
|
|
"SBTarget.ClearScriptedFrameProvider"};
|
|
PluginManager::RegisterPlugin(
|
|
GetPluginNameStatic(),
|
|
llvm::StringRef("Provide scripted stack frames for threads"),
|
|
CreateInstance, eScriptLanguagePython, {ci_usages, api_usages});
|
|
}
|
|
|
|
void ScriptedFrameProviderPythonInterface::Terminate() {
|
|
PluginManager::UnregisterPlugin(CreateInstance);
|
|
}
|