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