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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
//===-- ScriptedPythonInterface.h -------------------------------*- 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
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_SCRIPTEDPYTHONINTERFACE_H
#define LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_SCRIPTEDPYTHONINTERFACE_H
#include "lldb/Host/Config.h"
#if LLDB_ENABLE_PYTHON
#include "lldb/Interpreter/ScriptedInterface.h"
#include "lldb/Utility/DataBufferHeap.h"
#include "PythonDataObjects.h"
#include "SWIGPythonBridge.h"
#include "ScriptInterpreterPythonImpl.h"
namespace lldb_private {
class ScriptInterpreterPythonImpl;
class ScriptedPythonInterface : virtual public ScriptedInterface {
public:
ScriptedPythonInterface(ScriptInterpreterPythonImpl &interpreter);
virtual ~ScriptedPythonInterface() = default;
protected:
template <typename T = StructuredData::ObjectSP>
T ExtractValueFromPythonObject(python::PythonObject &p, Status &error) {
return p.CreateStructuredObject();
}
template <>
Status ExtractValueFromPythonObject<Status>(python::PythonObject &p,
Status &error) {
if (lldb::SBError *sb_error = reinterpret_cast<lldb::SBError *>(
LLDBSWIGPython_CastPyObjectToSBError(p.get())))
error = m_interpreter.GetStatusFromSBError(*sb_error);
else
error.SetErrorString("Couldn't cast lldb::SBError to lldb::Status.");
return error;
}
template <>
lldb::DataExtractorSP
ExtractValueFromPythonObject<lldb::DataExtractorSP>(python::PythonObject &p,
Status &error) {
lldb::SBData *sb_data = reinterpret_cast<lldb::SBData *>(
LLDBSWIGPython_CastPyObjectToSBData(p.get()));
if (!sb_data) {
error.SetErrorString("Couldn't cast lldb::SBError to lldb::Status.");
return nullptr;
}
return m_interpreter.GetDataExtractorFromSBData(*sb_data);
}
template <typename T = StructuredData::ObjectSP, typename... Args>
T Dispatch(llvm::StringRef method_name, Status &error, Args... args) {
using namespace python;
using Locker = ScriptInterpreterPythonImpl::Locker;
auto error_with_message = [&method_name, &error](llvm::StringRef message) {
error.SetErrorStringWithFormatv(
"ScriptedPythonInterface::{0} ({1}) ERROR = {2}", __FUNCTION__,
method_name, message);
return T();
};
if (!m_object_instance_sp)
return error_with_message("Python object ill-formed");
Locker py_lock(&m_interpreter, Locker::AcquireLock | Locker::NoSTDIN,
Locker::FreeLock);
PythonObject implementor(PyRefType::Borrowed,
(PyObject *)m_object_instance_sp->GetValue());
if (!implementor.IsAllocated())
return error_with_message("Python implementor not allocated.");
PythonObject pmeth(
PyRefType::Owned,
PyObject_GetAttrString(implementor.get(), method_name.str().c_str()));
if (PyErr_Occurred())
PyErr_Clear();
if (!pmeth.IsAllocated())
return error_with_message("Python method not allocated.");
if (PyCallable_Check(pmeth.get()) == 0) {
if (PyErr_Occurred())
PyErr_Clear();
return error_with_message("Python method not callable.");
}
if (PyErr_Occurred())
PyErr_Clear();
// TODO: make `const char *` when removing support for Python 2.
char *format = nullptr;
std::string format_buffer;
if (sizeof...(Args) > 0) {
FormatArgs(format_buffer, args...);
// TODO: make `const char *` when removing support for Python 2.
format = const_cast<char *>(format_buffer.c_str());
}
// TODO: make `const char *` when removing support for Python 2.
PythonObject py_return(
PyRefType::Owned,
PyObject_CallMethod(implementor.get(),
const_cast<char *>(method_name.data()), format,
args...));
if (PyErr_Occurred()) {
PyErr_Print();
PyErr_Clear();
return error_with_message("Python method could not be called.");
}
if (!py_return.IsAllocated())
return error_with_message("Returned object is null.");
return ExtractValueFromPythonObject<T>(py_return, error);
}
Status GetStatusFromMethod(llvm::StringRef method_name);
template <typename T, typename... Args>
void FormatArgs(std::string &fmt, T arg, Args... args) const {
FormatArgs(fmt, arg);
FormatArgs(fmt, args...);
}
template <typename T> void FormatArgs(std::string &fmt, T arg) const {
fmt += GetPythonValueFormatString(arg);
}
void FormatArgs(std::string &fmt) const {}
// The lifetime is managed by the ScriptInterpreter
ScriptInterpreterPythonImpl &m_interpreter;
};
} // namespace lldb_private
#endif // LLDB_ENABLE_PYTHON
#endif // LLDB_PLUGINS_SCRIPTINTERPRETER_PYTHON_SCRIPTEDPYTHONINTERFACE_H
|