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 extern "C" bool LLDBSwigPythonBreakpointCallbackFunction( 63 const char *python_function_name, const char *session_dictionary_name, 64 const lldb::StackFrameSP &sb_frame, 65 const lldb::BreakpointLocationSP &sb_bp_loc) { 66 return false; 67 } 68 69 extern "C" bool LLDBSwigPythonWatchpointCallbackFunction( 70 const char *python_function_name, const char *session_dictionary_name, 71 const lldb::StackFrameSP &sb_frame, const lldb::WatchpointSP &sb_wp) { 72 return false; 73 } 74 75 extern "C" bool LLDBSwigPythonCallTypeScript( 76 const char *python_function_name, void *session_dictionary, 77 const lldb::ValueObjectSP &valobj_sp, void **pyfunct_wrapper, 78 const lldb::TypeSummaryOptionsSP &options_sp, std::string &retval) { 79 return false; 80 } 81 82 extern "C" void * 83 LLDBSwigPythonCreateSyntheticProvider(const char *python_class_name, 84 const char *session_dictionary_name, 85 const lldb::ValueObjectSP &valobj_sp) { 86 return nullptr; 87 } 88 89 extern "C" void * 90 LLDBSwigPythonCreateCommandObject(const char *python_class_name, 91 const char *session_dictionary_name, 92 const lldb::DebuggerSP debugger_sp) { 93 return nullptr; 94 } 95 96 extern "C" void *LLDBSwigPythonCreateScriptedThreadPlan( 97 const char *python_class_name, const char *session_dictionary_name, 98 StructuredDataImpl *args_data, 99 std::string &error_string, 100 const lldb::ThreadPlanSP &thread_plan_sp) { 101 return nullptr; 102 } 103 104 extern "C" bool LLDBSWIGPythonCallThreadPlan(void *implementor, 105 const char *method_name, 106 Event *event_sp, bool &got_error) { 107 return false; 108 } 109 110 extern "C" void *LLDBSwigPythonCreateScriptedBreakpointResolver( 111 const char *python_class_name, const char *session_dictionary_name, 112 lldb_private::StructuredDataImpl *args, lldb::BreakpointSP &bkpt_sp) { 113 return nullptr; 114 } 115 116 extern "C" unsigned int 117 LLDBSwigPythonCallBreakpointResolver(void *implementor, const char *method_name, 118 lldb_private::SymbolContext *sym_ctx) { 119 return 0; 120 } 121 122 extern "C" size_t LLDBSwigPython_CalculateNumChildren(void *implementor, 123 uint32_t max) { 124 return 0; 125 } 126 127 extern "C" void *LLDBSwigPython_GetChildAtIndex(void *implementor, 128 uint32_t idx) { 129 return nullptr; 130 } 131 132 extern "C" int LLDBSwigPython_GetIndexOfChildWithName(void *implementor, 133 const char *child_name) { 134 return 0; 135 } 136 137 extern "C" void *LLDBSWIGPython_CastPyObjectToSBValue(void *data) { 138 return nullptr; 139 } 140 141 extern lldb::ValueObjectSP 142 LLDBSWIGPython_GetValueObjectSPFromSBValue(void *data) { 143 return nullptr; 144 } 145 146 extern "C" bool LLDBSwigPython_UpdateSynthProviderInstance(void *implementor) { 147 return false; 148 } 149 150 extern "C" bool 151 LLDBSwigPython_MightHaveChildrenSynthProviderInstance(void *implementor) { 152 return false; 153 } 154 155 extern "C" void * 156 LLDBSwigPython_GetValueSynthProviderInstance(void *implementor) { 157 return nullptr; 158 } 159 160 extern "C" bool 161 LLDBSwigPythonCallCommand(const char *python_function_name, 162 const char *session_dictionary_name, 163 lldb::DebuggerSP &debugger, const char *args, 164 lldb_private::CommandReturnObject &cmd_retobj, 165 lldb::ExecutionContextRefSP exe_ctx_ref_sp) { 166 return false; 167 } 168 169 extern "C" bool 170 LLDBSwigPythonCallCommandObject(void *implementor, lldb::DebuggerSP &debugger, 171 const char *args, 172 lldb_private::CommandReturnObject &cmd_retobj, 173 lldb::ExecutionContextRefSP exe_ctx_ref_sp) { 174 return false; 175 } 176 177 extern "C" bool 178 LLDBSwigPythonCallModuleInit(const char *python_module_name, 179 const char *session_dictionary_name, 180 lldb::DebuggerSP &debugger) { 181 return false; 182 } 183 184 extern "C" void * 185 LLDBSWIGPythonCreateOSPlugin(const char *python_class_name, 186 const char *session_dictionary_name, 187 const lldb::ProcessSP &process_sp) { 188 return nullptr; 189 } 190 191 extern "C" void * 192 LLDBSWIGPython_CreateFrameRecognizer(const char *python_class_name, 193 const char *session_dictionary_name) { 194 return nullptr; 195 } 196 197 extern "C" void * 198 LLDBSwigPython_GetRecognizedArguments(void *implementor, 199 const lldb::StackFrameSP &frame_sp) { 200 return nullptr; 201 } 202 203 extern "C" bool LLDBSWIGPythonRunScriptKeywordProcess( 204 const char *python_function_name, const char *session_dictionary_name, 205 lldb::ProcessSP &process, std::string &output) { 206 return false; 207 } 208 209 extern "C" bool LLDBSWIGPythonRunScriptKeywordThread( 210 const char *python_function_name, const char *session_dictionary_name, 211 lldb::ThreadSP &thread, std::string &output) { 212 return false; 213 } 214 215 extern "C" bool LLDBSWIGPythonRunScriptKeywordTarget( 216 const char *python_function_name, const char *session_dictionary_name, 217 lldb::TargetSP &target, std::string &output) { 218 return false; 219 } 220 221 extern "C" bool LLDBSWIGPythonRunScriptKeywordFrame( 222 const char *python_function_name, const char *session_dictionary_name, 223 lldb::StackFrameSP &frame, std::string &output) { 224 return false; 225 } 226 227 extern "C" bool LLDBSWIGPythonRunScriptKeywordValue( 228 const char *python_function_name, const char *session_dictionary_name, 229 lldb::ValueObjectSP &value, std::string &output) { 230 return false; 231 } 232 233 extern "C" void * 234 LLDBSWIGPython_GetDynamicSetting(void *module, const char *setting, 235 const lldb::TargetSP &target_sp) { 236 return nullptr; 237 } 238