1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
//===----------------------------------------------------------------------===//
//
// 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/Core/PluginManager.h"
#include "lldb/Host/Config.h"
#include "lldb/Target/Thread.h"
#include "lldb/Utility/Log.h"
#include "lldb/lldb-enumerations.h"
#if LLDB_ENABLE_PYTHON
// LLDB Python header must be included first
#include "../lldb-python.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 llvm::StringRef class_name, lldb::StackFrameListSP input_frames,
StructuredData::DictionarySP args_sp) {
if (!input_frames)
return llvm::createStringError("invalid frame list");
StructuredDataImpl sd_impl(args_sp);
return ScriptedPythonInterface::CreatePluginObject(class_name, nullptr,
input_frames, sd_impl);
}
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);
}
#endif
|
