1 //===-- SystemInitializerFull.cpp -------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #if !defined(LLDB_DISABLE_PYTHON)
11 #include "Plugins/ScriptInterpreter/Python/lldb-python.h"
12 #endif
13 
14 #include "lldb/API/SystemInitializerFull.h"
15 
16 #include "lldb/API/SBCommandInterpreter.h"
17 
18 #if !defined(LLDB_DISABLE_PYTHON)
19 #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h"
20 #endif
21 
22 #include "lldb/Core/Debugger.h"
23 #include "lldb/Core/Timer.h"
24 #include "lldb/Host/Host.h"
25 #include "lldb/Initialization/SystemInitializerCommon.h"
26 #include "lldb/Interpreter/CommandInterpreter.h"
27 #include "lldb/Symbol/ClangASTContext.h"
28 #include "lldb/Symbol/GoASTContext.h"
29 #include "lldb/Symbol/JavaASTContext.h"
30 
31 #include "Plugins/ABI/MacOSX-i386/ABIMacOSX_i386.h"
32 #include "Plugins/ABI/MacOSX-arm/ABIMacOSX_arm.h"
33 #include "Plugins/ABI/MacOSX-arm64/ABIMacOSX_arm64.h"
34 #include "Plugins/ABI/SysV-arm/ABISysV_arm.h"
35 #include "Plugins/ABI/SysV-arm64/ABISysV_arm64.h"
36 #include "Plugins/ABI/SysV-hexagon/ABISysV_hexagon.h"
37 #include "Plugins/ABI/SysV-i386/ABISysV_i386.h"
38 #include "Plugins/ABI/SysV-x86_64/ABISysV_x86_64.h"
39 #include "Plugins/ABI/SysV-ppc/ABISysV_ppc.h"
40 #include "Plugins/ABI/SysV-ppc64/ABISysV_ppc64.h"
41 #include "Plugins/ABI/SysV-mips/ABISysV_mips.h"
42 #include "Plugins/ABI/SysV-mips64/ABISysV_mips64.h"
43 #include "Plugins/Disassembler/llvm/DisassemblerLLVMC.h"
44 #include "Plugins/DynamicLoader/Static/DynamicLoaderStatic.h"
45 #include "Plugins/Instruction/ARM64/EmulateInstructionARM64.h"
46 #include "Plugins/InstrumentationRuntime/AddressSanitizer/AddressSanitizerRuntime.h"
47 #include "Plugins/JITLoader/GDB/JITLoaderGDB.h"
48 #include "Plugins/Language/CPlusPlus/CPlusPlusLanguage.h"
49 #include "Plugins/Language/Go/GoLanguage.h"
50 #include "Plugins/Language/Java/JavaLanguage.h"
51 #include "Plugins/Language/ObjC/ObjCLanguage.h"
52 #include "Plugins/Language/ObjCPlusPlus/ObjCPlusPlusLanguage.h"
53 #include "Plugins/LanguageRuntime/CPlusPlus/ItaniumABI/ItaniumABILanguageRuntime.h"
54 #include "Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV1.h"
55 #include "Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV2.h"
56 #include "Plugins/LanguageRuntime/Go/GoLanguageRuntime.h"
57 #include "Plugins/LanguageRuntime/Java/JavaLanguageRuntime.h"
58 #include "Plugins/LanguageRuntime/RenderScript/RenderScriptRuntime/RenderScriptRuntime.h"
59 #include "Plugins/MemoryHistory/asan/MemoryHistoryASan.h"
60 #include "Plugins/Platform/gdb-server/PlatformRemoteGDBServer.h"
61 #include "Plugins/Process/elf-core/ProcessElfCore.h"
62 #include "Plugins/Process/gdb-remote/ProcessGDBRemote.h"
63 #include "Plugins/ScriptInterpreter/None/ScriptInterpreterNone.h"
64 #include "Plugins/SymbolFile/DWARF/SymbolFileDWARF.h"
65 #include "Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h"
66 #include "Plugins/SymbolFile/Symtab/SymbolFileSymtab.h"
67 #include "Plugins/SymbolVendor/ELF/SymbolVendorELF.h"
68 #include "Plugins/SystemRuntime/MacOSX/SystemRuntimeMacOSX.h"
69 #include "Plugins/UnwindAssembly/x86/UnwindAssembly-x86.h"
70 #include "Plugins/UnwindAssembly/InstEmulation/UnwindAssemblyInstEmulation.h"
71 
72 #if defined(__APPLE__)
73 #include "Plugins/Process/mach-core/ProcessMachCore.h"
74 #include "Plugins/Process/MacOSX-Kernel/ProcessKDP.h"
75 #include "Plugins/SymbolVendor/MacOSX/SymbolVendorMacOSX.h"
76 #include "Plugins/Platform/MacOSX/PlatformAppleTVSimulator.h"
77 #include "Plugins/Platform/MacOSX/PlatformAppleWatchSimulator.h"
78 #include "Plugins/Platform/MacOSX/PlatformRemoteAppleTV.h"
79 #include "Plugins/Platform/MacOSX/PlatformRemoteAppleWatch.h"
80 #endif
81 
82 #if defined(__FreeBSD__)
83 #include "Plugins/Process/FreeBSD/ProcessFreeBSD.h"
84 #endif
85 
86 #if defined(_MSC_VER)
87 #include "lldb/Host/windows/windows.h"
88 #include "Plugins/Process/Windows/Live/ProcessWindowsLive.h"
89 #include "Plugins/Process/Windows/MiniDump/ProcessWinMiniDump.h"
90 #endif
91 
92 #include "llvm/Support/TargetSelect.h"
93 
94 #include <string>
95 
96 using namespace lldb_private;
97 
98 #ifndef LLDB_DISABLE_PYTHON
99 
100 // Defined in the SWIG source file
101 #if PY_MAJOR_VERSION >= 3
102 extern "C" PyObject*
103 PyInit__lldb(void);
104 
105 #define LLDBSwigPyInit PyInit__lldb
106 
107 #else
108 extern "C" void
109 init_lldb(void);
110 
111 #define LLDBSwigPyInit init_lldb
112 #endif
113 
114 // these are the Pythonic implementations of the required callbacks
115 // these are scripting-language specific, which is why they belong here
116 // we still need to use function pointers to them instead of relying
117 // on linkage-time resolution because the SWIG stuff and this file
118 // get built at different times
119 extern "C" bool
120 LLDBSwigPythonBreakpointCallbackFunction (const char *python_function_name,
121                                           const char *session_dictionary_name,
122                                           const lldb::StackFrameSP& sb_frame,
123                                           const lldb::BreakpointLocationSP& sb_bp_loc);
124 
125 extern "C" bool
126 LLDBSwigPythonWatchpointCallbackFunction (const char *python_function_name,
127                                           const char *session_dictionary_name,
128                                           const lldb::StackFrameSP& sb_frame,
129                                           const lldb::WatchpointSP& sb_wp);
130 
131 extern "C" bool
132 LLDBSwigPythonCallTypeScript (const char *python_function_name,
133                               void *session_dictionary,
134                               const lldb::ValueObjectSP& valobj_sp,
135                               void** pyfunct_wrapper,
136                               const lldb::TypeSummaryOptionsSP& options_sp,
137                               std::string& retval);
138 
139 extern "C" void*
140 LLDBSwigPythonCreateSyntheticProvider (const char *python_class_name,
141                                        const char *session_dictionary_name,
142                                        const lldb::ValueObjectSP& valobj_sp);
143 
144 extern "C" void*
145 LLDBSwigPythonCreateCommandObject (const char *python_class_name,
146                                    const char *session_dictionary_name,
147                                    const lldb::DebuggerSP debugger_sp);
148 
149 extern "C" void*
150 LLDBSwigPythonCreateScriptedThreadPlan (const char *python_class_name,
151                                         const char *session_dictionary_name,
152                                         const lldb::ThreadPlanSP& thread_plan_sp);
153 
154 extern "C" bool
155 LLDBSWIGPythonCallThreadPlan (void *implementor,
156                               const char *method_name,
157                               Event *event_sp,
158                               bool &got_error);
159 
160 extern "C" size_t
161 LLDBSwigPython_CalculateNumChildren (void *implementor, uint32_t max);
162 
163 extern "C" void *
164 LLDBSwigPython_GetChildAtIndex (void *implementor, uint32_t idx);
165 
166 extern "C" int
167 LLDBSwigPython_GetIndexOfChildWithName (void *implementor, const char* child_name);
168 
169 extern "C" void *
170 LLDBSWIGPython_CastPyObjectToSBValue (void* data);
171 
172 extern lldb::ValueObjectSP
173 LLDBSWIGPython_GetValueObjectSPFromSBValue (void* data);
174 
175 extern "C" bool
176 LLDBSwigPython_UpdateSynthProviderInstance (void* implementor);
177 
178 extern "C" bool
179 LLDBSwigPython_MightHaveChildrenSynthProviderInstance (void* implementor);
180 
181 extern "C" void *
182 LLDBSwigPython_GetValueSynthProviderInstance (void* implementor);
183 
184 extern "C" bool
185 LLDBSwigPythonCallCommand (const char *python_function_name,
186                            const char *session_dictionary_name,
187                            lldb::DebuggerSP& debugger,
188                            const char* args,
189                            lldb_private::CommandReturnObject &cmd_retobj,
190                            lldb::ExecutionContextRefSP exe_ctx_ref_sp);
191 
192 extern "C" bool
193 LLDBSwigPythonCallCommandObject (void *implementor,
194                                  lldb::DebuggerSP& debugger,
195                                  const char* args,
196                                  lldb_private::CommandReturnObject& cmd_retobj,
197                                  lldb::ExecutionContextRefSP exe_ctx_ref_sp);
198 
199 extern "C" bool
200 LLDBSwigPythonCallModuleInit (const char *python_module_name,
201                               const char *session_dictionary_name,
202                               lldb::DebuggerSP& debugger);
203 
204 extern "C" void*
205 LLDBSWIGPythonCreateOSPlugin (const char *python_class_name,
206                               const char *session_dictionary_name,
207                               const lldb::ProcessSP& process_sp);
208 
209 extern "C" bool
210 LLDBSWIGPythonRunScriptKeywordProcess (const char* python_function_name,
211                                        const char* session_dictionary_name,
212                                        lldb::ProcessSP& process,
213                                        std::string& output);
214 
215 extern "C" bool
216 LLDBSWIGPythonRunScriptKeywordThread (const char* python_function_name,
217                                       const char* session_dictionary_name,
218                                       lldb::ThreadSP& thread,
219                                       std::string& output);
220 
221 extern "C" bool
222 LLDBSWIGPythonRunScriptKeywordTarget (const char* python_function_name,
223                                       const char* session_dictionary_name,
224                                       lldb::TargetSP& target,
225                                       std::string& output);
226 
227 extern "C" bool
228 LLDBSWIGPythonRunScriptKeywordFrame (const char* python_function_name,
229                                      const char* session_dictionary_name,
230                                      lldb::StackFrameSP& frame,
231                                      std::string& output);
232 
233 extern "C" bool
234 LLDBSWIGPythonRunScriptKeywordValue (const char* python_function_name,
235                                      const char* session_dictionary_name,
236                                      lldb::ValueObjectSP& value,
237                                      std::string& output);
238 
239 extern "C" void*
240 LLDBSWIGPython_GetDynamicSetting (void* module,
241                                   const char* setting,
242                                   const lldb::TargetSP& target_sp);
243 
244 
245 #endif
246 
247 SystemInitializerFull::SystemInitializerFull()
248 {
249 }
250 
251 SystemInitializerFull::~SystemInitializerFull()
252 {
253 }
254 
255 void
256 SystemInitializerFull::Initialize()
257 {
258     SystemInitializerCommon::Initialize();
259     ScriptInterpreterNone::Initialize();
260 
261 #if !defined(LLDB_DISABLE_PYTHON)
262     InitializeSWIG();
263 
264     // ScriptInterpreterPython::Initialize() depends on things like HostInfo being initialized
265     // so it can compute the python directory etc, so we need to do this after
266     // SystemInitializerCommon::Initialize().
267     ScriptInterpreterPython::Initialize();
268 #endif
269 
270     // Initialize LLVM and Clang
271     llvm::InitializeAllTargets();
272     llvm::InitializeAllAsmPrinters();
273     llvm::InitializeAllTargetMCs();
274     llvm::InitializeAllDisassemblers();
275 
276     ClangASTContext::Initialize();
277     GoASTContext::Initialize();
278     JavaASTContext::Initialize();
279 
280     ABIMacOSX_i386::Initialize();
281     ABIMacOSX_arm::Initialize();
282     ABIMacOSX_arm64::Initialize();
283     ABISysV_arm::Initialize();
284     ABISysV_arm64::Initialize();
285     ABISysV_hexagon::Initialize();
286     ABISysV_i386::Initialize();
287     ABISysV_x86_64::Initialize();
288     ABISysV_ppc::Initialize();
289     ABISysV_ppc64::Initialize();
290     ABISysV_mips::Initialize();
291     ABISysV_mips64::Initialize();
292     DisassemblerLLVMC::Initialize();
293 
294     JITLoaderGDB::Initialize();
295     ProcessElfCore::Initialize();
296 #if defined(_MSC_VER)
297     ProcessWinMiniDump::Initialize();
298 #endif
299     MemoryHistoryASan::Initialize();
300     AddressSanitizerRuntime::Initialize();
301 
302     SymbolVendorELF::Initialize();
303     SymbolFileDWARF::Initialize();
304     SymbolFileSymtab::Initialize();
305     UnwindAssemblyInstEmulation::Initialize();
306     UnwindAssembly_x86::Initialize();
307     EmulateInstructionARM64::Initialize();
308     SymbolFileDWARFDebugMap::Initialize();
309     ItaniumABILanguageRuntime::Initialize();
310     AppleObjCRuntimeV2::Initialize();
311     AppleObjCRuntimeV1::Initialize();
312     SystemRuntimeMacOSX::Initialize();
313     RenderScriptRuntime::Initialize();
314     GoLanguageRuntime::Initialize();
315     JavaLanguageRuntime::Initialize();
316 
317     CPlusPlusLanguage::Initialize();
318     GoLanguage::Initialize();
319     JavaLanguage::Initialize();
320     ObjCLanguage::Initialize();
321     ObjCPlusPlusLanguage::Initialize();
322 
323 #if defined(_MSC_VER)
324     ProcessWindowsLive::Initialize();
325 #endif
326 #if defined(__FreeBSD__)
327     ProcessFreeBSD::Initialize();
328 #endif
329 #if defined(__APPLE__)
330     SymbolVendorMacOSX::Initialize();
331     ProcessKDP::Initialize();
332     ProcessMachCore::Initialize();
333     PlatformAppleTVSimulator::Initialize();
334     PlatformAppleWatchSimulator::Initialize();
335     PlatformRemoteAppleTV::Initialize();
336     PlatformRemoteAppleWatch::Initialize();
337 #endif
338     //----------------------------------------------------------------------
339     // Platform agnostic plugins
340     //----------------------------------------------------------------------
341     platform_gdb_server::PlatformRemoteGDBServer::Initialize();
342 
343     process_gdb_remote::ProcessGDBRemote::Initialize();
344     DynamicLoaderStatic::Initialize();
345 
346     // Scan for any system or user LLDB plug-ins
347     PluginManager::Initialize();
348 
349     // The process settings need to know about installed plug-ins, so the Settings must be initialized
350     // AFTER PluginManager::Initialize is called.
351 
352     Debugger::SettingsInitialize();
353 }
354 
355 void SystemInitializerFull::InitializeSWIG()
356 {
357 #if !defined(LLDB_DISABLE_PYTHON)
358     ScriptInterpreterPython::InitializeInterpreter(
359         LLDBSwigPyInit,
360         LLDBSwigPythonBreakpointCallbackFunction,
361         LLDBSwigPythonWatchpointCallbackFunction,
362         LLDBSwigPythonCallTypeScript,
363         LLDBSwigPythonCreateSyntheticProvider,
364         LLDBSwigPythonCreateCommandObject,
365         LLDBSwigPython_CalculateNumChildren,
366         LLDBSwigPython_GetChildAtIndex,
367         LLDBSwigPython_GetIndexOfChildWithName,
368         LLDBSWIGPython_CastPyObjectToSBValue,
369         LLDBSWIGPython_GetValueObjectSPFromSBValue,
370         LLDBSwigPython_UpdateSynthProviderInstance,
371         LLDBSwigPython_MightHaveChildrenSynthProviderInstance,
372         LLDBSwigPython_GetValueSynthProviderInstance,
373         LLDBSwigPythonCallCommand,
374         LLDBSwigPythonCallCommandObject,
375         LLDBSwigPythonCallModuleInit,
376         LLDBSWIGPythonCreateOSPlugin,
377         LLDBSWIGPythonRunScriptKeywordProcess,
378         LLDBSWIGPythonRunScriptKeywordThread,
379         LLDBSWIGPythonRunScriptKeywordTarget,
380         LLDBSWIGPythonRunScriptKeywordFrame,
381         LLDBSWIGPythonRunScriptKeywordValue,
382         LLDBSWIGPython_GetDynamicSetting,
383         LLDBSwigPythonCreateScriptedThreadPlan,
384         LLDBSWIGPythonCallThreadPlan);
385 #endif
386 }
387 
388 void
389 SystemInitializerFull::Terminate()
390 {
391     Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
392 
393     Debugger::SettingsTerminate();
394 
395     // Terminate and unload and loaded system or user LLDB plug-ins
396     PluginManager::Terminate();
397 
398     ClangASTContext::Terminate();
399     GoASTContext::Terminate();
400     JavaASTContext::Terminate();
401 
402     ABIMacOSX_i386::Terminate();
403     ABIMacOSX_arm::Terminate();
404     ABIMacOSX_arm64::Terminate();
405     ABISysV_arm::Terminate();
406     ABISysV_arm64::Terminate();
407     ABISysV_hexagon::Terminate();
408     ABISysV_i386::Terminate();
409     ABISysV_x86_64::Terminate();
410     ABISysV_ppc::Terminate();
411     ABISysV_ppc64::Terminate();
412     ABISysV_mips::Terminate();
413     ABISysV_mips64::Terminate();
414     DisassemblerLLVMC::Terminate();
415 
416     JITLoaderGDB::Terminate();
417     ProcessElfCore::Terminate();
418 #if defined(_MSC_VER)
419     ProcessWinMiniDump::Terminate();
420 #endif
421     MemoryHistoryASan::Terminate();
422     AddressSanitizerRuntime::Terminate();
423     SymbolVendorELF::Terminate();
424     SymbolFileDWARF::Terminate();
425     SymbolFileSymtab::Terminate();
426     UnwindAssembly_x86::Terminate();
427     UnwindAssemblyInstEmulation::Terminate();
428     EmulateInstructionARM64::Terminate();
429     SymbolFileDWARFDebugMap::Terminate();
430     ItaniumABILanguageRuntime::Terminate();
431     AppleObjCRuntimeV2::Terminate();
432     AppleObjCRuntimeV1::Terminate();
433     SystemRuntimeMacOSX::Terminate();
434     RenderScriptRuntime::Terminate();
435     JavaLanguageRuntime::Terminate();
436 
437     CPlusPlusLanguage::Terminate();
438     GoLanguage::Terminate();
439     JavaLanguage::Terminate();
440     ObjCLanguage::Terminate();
441     ObjCPlusPlusLanguage::Terminate();
442 
443 #if defined(__APPLE__)
444     ProcessMachCore::Terminate();
445     ProcessKDP::Terminate();
446     SymbolVendorMacOSX::Terminate();
447     PlatformAppleTVSimulator::Terminate();
448     PlatformAppleWatchSimulator::Terminate();
449     PlatformRemoteAppleTV::Terminate();
450     PlatformRemoteAppleWatch::Terminate();
451 #endif
452 
453 #if defined(__FreeBSD__)
454     ProcessFreeBSD::Terminate();
455 #endif
456     Debugger::SettingsTerminate();
457 
458     platform_gdb_server::PlatformRemoteGDBServer::Terminate();
459     process_gdb_remote::ProcessGDBRemote::Terminate();
460     DynamicLoaderStatic::Terminate();
461 
462     // Now shutdown the common parts, in reverse order.
463     SystemInitializerCommon::Terminate();
464 }
465