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