1 //===-- PythonTestSuite.cpp -------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "gtest/gtest.h" 10 11 #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h" 12 #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPythonImpl.h" 13 #include "Plugins/ScriptInterpreter/Python/lldb-python.h" 14 #include "lldb/Host/FileSystem.h" 15 #include "lldb/Host/HostInfo.h" 16 17 #include "PythonTestSuite.h" 18 19 using namespace lldb_private; 20 class TestScriptInterpreterPython : public ScriptInterpreterPythonImpl { 21 public: 22 using ScriptInterpreterPythonImpl::Initialize; 23 using ScriptInterpreterPythonImpl::InitializePrivate; 24 }; 25 26 void PythonTestSuite::SetUp() { 27 FileSystem::Initialize(); 28 HostInfoBase::Initialize(); 29 // ScriptInterpreterPython::Initialize() depends on HostInfo being 30 // initializedso it can compute the python directory etc. 31 TestScriptInterpreterPython::Initialize(); 32 TestScriptInterpreterPython::InitializePrivate(); 33 34 // Although we don't care about concurrency for the purposes of running 35 // this test suite, Python requires the GIL to be locked even for 36 // deallocating memory, which can happen when you call Py_DECREF or 37 // Py_INCREF. So acquire the GIL for the entire duration of this 38 // test suite. 39 m_gil_state = PyGILState_Ensure(); 40 } 41 42 void PythonTestSuite::TearDown() { 43 PyGILState_Release(m_gil_state); 44 45 TestScriptInterpreterPython::Terminate(); 46 HostInfoBase::Terminate(); 47 FileSystem::Terminate(); 48 } 49 50 // The following functions are the Pythonic implementations of the required 51 // callbacks. Because they're defined in libLLDB which we cannot link for the 52 // unit test, we have a 'default' implementation here. 53 54 #if PY_MAJOR_VERSION >= 3 55 extern "C" PyObject *PyInit__lldb(void) { return nullptr; } 56 #define LLDBSwigPyInit PyInit__lldb 57 #else 58 extern "C" void init_lldb(void) {} 59 #define LLDBSwigPyInit init_lldb 60 #endif 61 62 #pragma clang diagnostic push 63 #pragma clang diagnostic ignored "-Wreturn-type-c-linkage" 64 65 extern "C" llvm::Expected<bool> LLDBSwigPythonBreakpointCallbackFunction( 66 const char *python_function_name, const char *session_dictionary_name, 67 const lldb::StackFrameSP &sb_frame, 68 const lldb::BreakpointLocationSP &sb_bp_loc, 69 StructuredDataImpl *args_impl) { 70 return false; 71 } 72 73 #pragma clang diagnostic pop 74 75 extern "C" bool LLDBSwigPythonWatchpointCallbackFunction( 76 const char *python_function_name, const char *session_dictionary_name, 77 const lldb::StackFrameSP &sb_frame, const lldb::WatchpointSP &sb_wp) { 78 return false; 79 } 80 81 extern "C" bool LLDBSwigPythonCallTypeScript( 82 const char *python_function_name, void *session_dictionary, 83 const lldb::ValueObjectSP &valobj_sp, void **pyfunct_wrapper, 84 const lldb::TypeSummaryOptionsSP &options_sp, std::string &retval) { 85 return false; 86 } 87 88 extern "C" void * 89 LLDBSwigPythonCreateSyntheticProvider(const char *python_class_name, 90 const char *session_dictionary_name, 91 const lldb::ValueObjectSP &valobj_sp) { 92 return nullptr; 93 } 94 95 extern "C" void * 96 LLDBSwigPythonCreateCommandObject(const char *python_class_name, 97 const char *session_dictionary_name, 98 const lldb::DebuggerSP debugger_sp) { 99 return nullptr; 100 } 101 102 extern "C" void *LLDBSwigPythonCreateScriptedThreadPlan( 103 const char *python_class_name, const char *session_dictionary_name, 104 StructuredDataImpl *args_data, 105 std::string &error_string, 106 const lldb::ThreadPlanSP &thread_plan_sp) { 107 return nullptr; 108 } 109 110 extern "C" bool LLDBSWIGPythonCallThreadPlan(void *implementor, 111 const char *method_name, 112 Event *event_sp, bool &got_error) { 113 return false; 114 } 115 116 extern "C" void *LLDBSwigPythonCreateScriptedBreakpointResolver( 117 const char *python_class_name, const char *session_dictionary_name, 118 lldb_private::StructuredDataImpl *args, lldb::BreakpointSP &bkpt_sp) { 119 return nullptr; 120 } 121 122 extern "C" unsigned int 123 LLDBSwigPythonCallBreakpointResolver(void *implementor, const char *method_name, 124 lldb_private::SymbolContext *sym_ctx) { 125 return 0; 126 } 127 128 extern "C" size_t LLDBSwigPython_CalculateNumChildren(void *implementor, 129 uint32_t max) { 130 return 0; 131 } 132 133 extern "C" void *LLDBSwigPython_GetChildAtIndex(void *implementor, 134 uint32_t idx) { 135 return nullptr; 136 } 137 138 extern "C" int LLDBSwigPython_GetIndexOfChildWithName(void *implementor, 139 const char *child_name) { 140 return 0; 141 } 142 143 extern "C" void *LLDBSWIGPython_CastPyObjectToSBValue(void *data) { 144 return nullptr; 145 } 146 147 extern lldb::ValueObjectSP 148 LLDBSWIGPython_GetValueObjectSPFromSBValue(void *data) { 149 return nullptr; 150 } 151 152 extern "C" bool LLDBSwigPython_UpdateSynthProviderInstance(void *implementor) { 153 return false; 154 } 155 156 extern "C" bool 157 LLDBSwigPython_MightHaveChildrenSynthProviderInstance(void *implementor) { 158 return false; 159 } 160 161 extern "C" void * 162 LLDBSwigPython_GetValueSynthProviderInstance(void *implementor) { 163 return nullptr; 164 } 165 166 extern "C" bool 167 LLDBSwigPythonCallCommand(const char *python_function_name, 168 const char *session_dictionary_name, 169 lldb::DebuggerSP &debugger, const char *args, 170 lldb_private::CommandReturnObject &cmd_retobj, 171 lldb::ExecutionContextRefSP exe_ctx_ref_sp) { 172 return false; 173 } 174 175 extern "C" bool 176 LLDBSwigPythonCallCommandObject(void *implementor, lldb::DebuggerSP &debugger, 177 const char *args, 178 lldb_private::CommandReturnObject &cmd_retobj, 179 lldb::ExecutionContextRefSP exe_ctx_ref_sp) { 180 return false; 181 } 182 183 extern "C" bool 184 LLDBSwigPythonCallModuleInit(const char *python_module_name, 185 const char *session_dictionary_name, 186 lldb::DebuggerSP &debugger) { 187 return false; 188 } 189 190 extern "C" void * 191 LLDBSWIGPythonCreateOSPlugin(const char *python_class_name, 192 const char *session_dictionary_name, 193 const lldb::ProcessSP &process_sp) { 194 return nullptr; 195 } 196 197 extern "C" void * 198 LLDBSWIGPython_CreateFrameRecognizer(const char *python_class_name, 199 const char *session_dictionary_name) { 200 return nullptr; 201 } 202 203 extern "C" void * 204 LLDBSwigPython_GetRecognizedArguments(void *implementor, 205 const lldb::StackFrameSP &frame_sp) { 206 return nullptr; 207 } 208 209 extern "C" bool LLDBSWIGPythonRunScriptKeywordProcess( 210 const char *python_function_name, const char *session_dictionary_name, 211 lldb::ProcessSP &process, std::string &output) { 212 return false; 213 } 214 215 extern "C" bool LLDBSWIGPythonRunScriptKeywordThread( 216 const char *python_function_name, const char *session_dictionary_name, 217 lldb::ThreadSP &thread, std::string &output) { 218 return false; 219 } 220 221 extern "C" bool LLDBSWIGPythonRunScriptKeywordTarget( 222 const char *python_function_name, const char *session_dictionary_name, 223 lldb::TargetSP &target, std::string &output) { 224 return false; 225 } 226 227 extern "C" bool LLDBSWIGPythonRunScriptKeywordFrame( 228 const char *python_function_name, const char *session_dictionary_name, 229 lldb::StackFrameSP &frame, std::string &output) { 230 return false; 231 } 232 233 extern "C" bool LLDBSWIGPythonRunScriptKeywordValue( 234 const char *python_function_name, const char *session_dictionary_name, 235 lldb::ValueObjectSP &value, std::string &output) { 236 return false; 237 } 238 239 extern "C" void * 240 LLDBSWIGPython_GetDynamicSetting(void *module, const char *setting, 241 const lldb::TargetSP &target_sp) { 242 return nullptr; 243 } 244