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