1 //===-- SystemInitializerFull.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 "SystemInitializerFull.h"
10 #include "lldb/API/SBCommandInterpreter.h"
11 #include "lldb/Host/Config.h"
12 
13 #if LLDB_ENABLE_PYTHON
14 #include "Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.h"
15 #endif
16 
17 #if LLDB_ENABLE_LUA
18 #include "Plugins/ScriptInterpreter/Lua/ScriptInterpreterLua.h"
19 #endif
20 
21 #include "lldb/Core/Debugger.h"
22 #include "lldb/Host/Host.h"
23 #include "lldb/Initialization/SystemInitializerCommon.h"
24 #include "lldb/Interpreter/CommandInterpreter.h"
25 #include "lldb/Symbol/ClangASTContext.h"
26 #include "lldb/Utility/Timer.h"
27 
28 #include "Plugins/ABI/MacOSX-arm/ABIMacOSX_arm.h"
29 #include "Plugins/ABI/MacOSX-arm64/ABIMacOSX_arm64.h"
30 #include "Plugins/ABI/MacOSX-i386/ABIMacOSX_i386.h"
31 #include "Plugins/ABI/SysV-arc/ABISysV_arc.h"
32 #include "Plugins/ABI/SysV-arm/ABISysV_arm.h"
33 #include "Plugins/ABI/SysV-arm64/ABISysV_arm64.h"
34 #include "Plugins/ABI/SysV-hexagon/ABISysV_hexagon.h"
35 #include "Plugins/ABI/SysV-i386/ABISysV_i386.h"
36 #include "Plugins/ABI/SysV-mips/ABISysV_mips.h"
37 #include "Plugins/ABI/SysV-mips64/ABISysV_mips64.h"
38 #include "Plugins/ABI/SysV-ppc/ABISysV_ppc.h"
39 #include "Plugins/ABI/SysV-ppc64/ABISysV_ppc64.h"
40 #include "Plugins/ABI/SysV-s390x/ABISysV_s390x.h"
41 #include "Plugins/ABI/SysV-x86_64/ABISysV_x86_64.h"
42 #include "Plugins/ABI/Windows-x86_64/ABIWindows_x86_64.h"
43 #include "Plugins/Architecture/Arm/ArchitectureArm.h"
44 #include "Plugins/Architecture/Mips/ArchitectureMips.h"
45 #include "Plugins/Architecture/PPC64/ArchitecturePPC64.h"
46 #include "Plugins/Disassembler/llvm/DisassemblerLLVMC.h"
47 #include "Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOS.h"
48 #include "Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderMacOSXDYLD.h"
49 #include "Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h"
50 #include "Plugins/DynamicLoader/Static/DynamicLoaderStatic.h"
51 #include "Plugins/DynamicLoader/Windows-DYLD/DynamicLoaderWindowsDYLD.h"
52 #include "Plugins/Instruction/ARM/EmulateInstructionARM.h"
53 #include "Plugins/Instruction/ARM64/EmulateInstructionARM64.h"
54 #include "Plugins/Instruction/MIPS/EmulateInstructionMIPS.h"
55 #include "Plugins/Instruction/MIPS64/EmulateInstructionMIPS64.h"
56 #include "Plugins/Instruction/PPC64/EmulateInstructionPPC64.h"
57 #include "Plugins/InstrumentationRuntime/ASan/ASanRuntime.h"
58 #include "Plugins/InstrumentationRuntime/MainThreadChecker/MainThreadCheckerRuntime.h"
59 #include "Plugins/InstrumentationRuntime/TSan/TSanRuntime.h"
60 #include "Plugins/InstrumentationRuntime/UBSan/UBSanRuntime.h"
61 #include "Plugins/JITLoader/GDB/JITLoaderGDB.h"
62 #include "Plugins/Language/CPlusPlus/CPlusPlusLanguage.h"
63 #include "Plugins/Language/ObjC/ObjCLanguage.h"
64 #include "Plugins/Language/ObjCPlusPlus/ObjCPlusPlusLanguage.h"
65 #include "Plugins/LanguageRuntime/CPlusPlus/ItaniumABI/ItaniumABILanguageRuntime.h"
66 #include "Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV1.h"
67 #include "Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV2.h"
68 #include "Plugins/LanguageRuntime/RenderScript/RenderScriptRuntime/RenderScriptRuntime.h"
69 #include "Plugins/MemoryHistory/asan/MemoryHistoryASan.h"
70 #include "Plugins/ObjectContainer/BSD-Archive/ObjectContainerBSDArchive.h"
71 #include "Plugins/ObjectContainer/Universal-Mach-O/ObjectContainerUniversalMachO.h"
72 #include "Plugins/ObjectFile/Breakpad/ObjectFileBreakpad.h"
73 #include "Plugins/ObjectFile/ELF/ObjectFileELF.h"
74 #include "Plugins/ObjectFile/Mach-O/ObjectFileMachO.h"
75 #include "Plugins/ObjectFile/PECOFF/ObjectFilePECOFF.h"
76 #include "Plugins/ObjectFile/wasm/ObjectFileWasm.h"
77 #include "Plugins/OperatingSystem/Python/OperatingSystemPython.h"
78 #include "Plugins/Platform/Android/PlatformAndroid.h"
79 #include "Plugins/Platform/FreeBSD/PlatformFreeBSD.h"
80 #include "Plugins/Platform/Linux/PlatformLinux.h"
81 #include "Plugins/Platform/MacOSX/PlatformMacOSX.h"
82 #include "Plugins/Platform/MacOSX/PlatformRemoteiOS.h"
83 #include "Plugins/Platform/NetBSD/PlatformNetBSD.h"
84 #include "Plugins/Platform/OpenBSD/PlatformOpenBSD.h"
85 #include "Plugins/Platform/Windows/PlatformWindows.h"
86 #include "Plugins/Platform/gdb-server/PlatformRemoteGDBServer.h"
87 #include "Plugins/Process/elf-core/ProcessElfCore.h"
88 #include "Plugins/Process/gdb-remote/ProcessGDBRemote.h"
89 #include "Plugins/Process/mach-core/ProcessMachCore.h"
90 #include "Plugins/Process/minidump/ProcessMinidump.h"
91 #include "Plugins/ScriptInterpreter/None/ScriptInterpreterNone.h"
92 #include "Plugins/SymbolFile/Breakpad/SymbolFileBreakpad.h"
93 #include "Plugins/SymbolFile/DWARF/SymbolFileDWARF.h"
94 #include "Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h"
95 #include "Plugins/SymbolFile/PDB/SymbolFilePDB.h"
96 #include "Plugins/SymbolFile/Symtab/SymbolFileSymtab.h"
97 #include "Plugins/SymbolVendor/ELF/SymbolVendorELF.h"
98 #include "Plugins/SystemRuntime/MacOSX/SystemRuntimeMacOSX.h"
99 #include "Plugins/UnwindAssembly/InstEmulation/UnwindAssemblyInstEmulation.h"
100 #include "Plugins/UnwindAssembly/x86/UnwindAssembly-x86.h"
101 
102 #if defined(__APPLE__)
103 #include "Plugins/DynamicLoader/Darwin-Kernel/DynamicLoaderDarwinKernel.h"
104 #include "Plugins/Platform/MacOSX/PlatformAppleTVSimulator.h"
105 #include "Plugins/Platform/MacOSX/PlatformAppleWatchSimulator.h"
106 #include "Plugins/Platform/MacOSX/PlatformDarwinKernel.h"
107 #include "Plugins/Platform/MacOSX/PlatformRemoteAppleBridge.h"
108 #include "Plugins/Platform/MacOSX/PlatformRemoteAppleTV.h"
109 #include "Plugins/Platform/MacOSX/PlatformRemoteAppleWatch.h"
110 #include "Plugins/Platform/MacOSX/PlatformiOSSimulator.h"
111 #include "Plugins/Process/MacOSX-Kernel/ProcessKDP.h"
112 #include "Plugins/SymbolVendor/MacOSX/SymbolVendorMacOSX.h"
113 #endif
114 #include "Plugins/StructuredData/DarwinLog/StructuredDataDarwinLog.h"
115 
116 #if defined(__FreeBSD__)
117 #include "Plugins/Process/FreeBSD/ProcessFreeBSD.h"
118 #endif
119 
120 #if defined(_WIN32)
121 #include "Plugins/Process/Windows/Common/ProcessWindows.h"
122 #include "lldb/Host/windows/windows.h"
123 #endif
124 
125 #include "llvm/Support/TargetSelect.h"
126 
127 #pragma clang diagnostic push
128 #pragma clang diagnostic ignored "-Wglobal-constructors"
129 #include "llvm/ExecutionEngine/MCJIT.h"
130 #pragma clang diagnostic pop
131 
132 #include <string>
133 
134 using namespace lldb_private;
135 
136 SystemInitializerFull::SystemInitializerFull() {}
137 
138 SystemInitializerFull::~SystemInitializerFull() {}
139 
140 #define LLDB_PROCESS_AArch64(op)                                               \
141   ABIMacOSX_arm64::op();                                                       \
142   ABISysV_arm64::op();
143 #define LLDB_PROCESS_ARM(op)                                                   \
144   ABIMacOSX_arm::op();                                                         \
145   ABISysV_arm::op();
146 #define LLDB_PROCESS_ARC(op)                                                   \
147   ABISysV_arc::op();
148 #define LLDB_PROCESS_Hexagon(op) ABISysV_hexagon::op();
149 #define LLDB_PROCESS_Mips(op)                                                  \
150   ABISysV_mips::op();                                                          \
151   ABISysV_mips64::op();
152 #define LLDB_PROCESS_PowerPC(op)                                               \
153   ABISysV_ppc::op();                                                          \
154   ABISysV_ppc64::op();
155 #define LLDB_PROCESS_SystemZ(op) ABISysV_s390x::op();
156 #define LLDB_PROCESS_X86(op)                                                   \
157   ABIMacOSX_i386::op();                                                        \
158   ABISysV_i386::op();                                                          \
159   ABISysV_x86_64::op();                                                        \
160   ABIWindows_x86_64::op();
161 
162 #define LLDB_PROCESS_AMDGPU(op)
163 #define LLDB_PROCESS_AVR(op)
164 #define LLDB_PROCESS_BPF(op)
165 #define LLDB_PROCESS_Lanai(op)
166 #define LLDB_PROCESS_MSP430(op)
167 #define LLDB_PROCESS_NVPTX(op)
168 #define LLDB_PROCESS_RISCV(op)
169 #define LLDB_PROCESS_Sparc(op)
170 #define LLDB_PROCESS_WebAssembly(op)
171 #define LLDB_PROCESS_XCore(op)
172 
173 llvm::Error SystemInitializerFull::Initialize() {
174   if (auto e = SystemInitializerCommon::Initialize())
175     return e;
176 
177   breakpad::ObjectFileBreakpad::Initialize();
178   ObjectFileELF::Initialize();
179   ObjectFileMachO::Initialize();
180   ObjectFilePECOFF::Initialize();
181   wasm::ObjectFileWasm::Initialize();
182 
183   ObjectContainerBSDArchive::Initialize();
184   ObjectContainerUniversalMachO::Initialize();
185 
186   ScriptInterpreterNone::Initialize();
187 
188 #if LLDB_ENABLE_PYTHON
189   OperatingSystemPython::Initialize();
190 #endif
191 
192 #if LLDB_ENABLE_PYTHON
193   ScriptInterpreterPython::Initialize();
194 #endif
195 
196 #if LLDB_ENABLE_LUA
197   ScriptInterpreterLua::Initialize();
198 #endif
199 
200   platform_freebsd::PlatformFreeBSD::Initialize();
201   platform_linux::PlatformLinux::Initialize();
202   platform_netbsd::PlatformNetBSD::Initialize();
203   platform_openbsd::PlatformOpenBSD::Initialize();
204   PlatformWindows::Initialize();
205   platform_android::PlatformAndroid::Initialize();
206   PlatformRemoteiOS::Initialize();
207   PlatformMacOSX::Initialize();
208 #if defined(__APPLE__)
209   PlatformiOSSimulator::Initialize();
210   PlatformDarwinKernel::Initialize();
211 #endif
212 
213   // Initialize LLVM and Clang
214   llvm::InitializeAllTargets();
215   llvm::InitializeAllAsmPrinters();
216   llvm::InitializeAllTargetMCs();
217   llvm::InitializeAllDisassemblers();
218 
219   ClangASTContext::Initialize();
220 
221 #define LLVM_TARGET(t) LLDB_PROCESS_ ## t(Initialize)
222 #include "llvm/Config/Targets.def"
223 
224   ArchitectureArm::Initialize();
225   ArchitectureMips::Initialize();
226   ArchitecturePPC64::Initialize();
227 
228   DisassemblerLLVMC::Initialize();
229 
230   JITLoaderGDB::Initialize();
231   ProcessElfCore::Initialize();
232   ProcessMachCore::Initialize();
233   minidump::ProcessMinidump::Initialize();
234   MemoryHistoryASan::Initialize();
235   AddressSanitizerRuntime::Initialize();
236   ThreadSanitizerRuntime::Initialize();
237   UndefinedBehaviorSanitizerRuntime::Initialize();
238   MainThreadCheckerRuntime::Initialize();
239 
240   SymbolVendorELF::Initialize();
241   breakpad::SymbolFileBreakpad::Initialize();
242   SymbolFileDWARF::Initialize();
243   SymbolFilePDB::Initialize();
244   SymbolFileSymtab::Initialize();
245   UnwindAssemblyInstEmulation::Initialize();
246   UnwindAssembly_x86::Initialize();
247 
248   EmulateInstructionARM::Initialize();
249   EmulateInstructionARM64::Initialize();
250   EmulateInstructionMIPS::Initialize();
251   EmulateInstructionMIPS64::Initialize();
252   EmulateInstructionPPC64::Initialize();
253 
254   SymbolFileDWARFDebugMap::Initialize();
255   ItaniumABILanguageRuntime::Initialize();
256   AppleObjCRuntimeV2::Initialize();
257   AppleObjCRuntimeV1::Initialize();
258   SystemRuntimeMacOSX::Initialize();
259   RenderScriptRuntime::Initialize();
260 
261   CPlusPlusLanguage::Initialize();
262   ObjCLanguage::Initialize();
263   ObjCPlusPlusLanguage::Initialize();
264 
265 #if defined(_WIN32)
266   ProcessWindows::Initialize();
267 #endif
268 #if defined(__FreeBSD__)
269   ProcessFreeBSD::Initialize();
270 #endif
271 #if defined(__APPLE__)
272   SymbolVendorMacOSX::Initialize();
273   ProcessKDP::Initialize();
274   PlatformAppleTVSimulator::Initialize();
275   PlatformAppleWatchSimulator::Initialize();
276   PlatformRemoteAppleTV::Initialize();
277   PlatformRemoteAppleWatch::Initialize();
278   PlatformRemoteAppleBridge::Initialize();
279   DynamicLoaderDarwinKernel::Initialize();
280 #endif
281 
282   // This plugin is valid on any host that talks to a Darwin remote. It
283   // shouldn't be limited to __APPLE__.
284   StructuredDataDarwinLog::Initialize();
285 
286   // Platform agnostic plugins
287   platform_gdb_server::PlatformRemoteGDBServer::Initialize();
288 
289   process_gdb_remote::ProcessGDBRemote::Initialize();
290   DynamicLoaderMacOSXDYLD::Initialize();
291   DynamicLoaderMacOS::Initialize();
292   DynamicLoaderPOSIXDYLD::Initialize();
293   DynamicLoaderStatic::Initialize();
294   DynamicLoaderWindowsDYLD::Initialize();
295 
296   // Scan for any system or user LLDB plug-ins
297   PluginManager::Initialize();
298 
299   // The process settings need to know about installed plug-ins, so the
300   // Settings must be initialized
301   // AFTER PluginManager::Initialize is called.
302 
303   Debugger::SettingsInitialize();
304 
305   return llvm::Error::success();
306 }
307 
308 void SystemInitializerFull::Terminate() {
309   static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
310   Timer scoped_timer(func_cat, LLVM_PRETTY_FUNCTION);
311 
312   Debugger::SettingsTerminate();
313 
314   // Terminate and unload and loaded system or user LLDB plug-ins
315   PluginManager::Terminate();
316 
317   ClangASTContext::Terminate();
318 
319   ArchitectureArm::Terminate();
320   ArchitectureMips::Terminate();
321   ArchitecturePPC64::Terminate();
322 
323 #define LLVM_TARGET(t) LLDB_PROCESS_ ## t(Terminate)
324 #include "llvm/Config/Targets.def"
325 
326   DisassemblerLLVMC::Terminate();
327 
328   JITLoaderGDB::Terminate();
329   ProcessElfCore::Terminate();
330   ProcessMachCore::Terminate();
331   minidump::ProcessMinidump::Terminate();
332   MemoryHistoryASan::Terminate();
333   AddressSanitizerRuntime::Terminate();
334   ThreadSanitizerRuntime::Terminate();
335   UndefinedBehaviorSanitizerRuntime::Terminate();
336   MainThreadCheckerRuntime::Terminate();
337   SymbolVendorELF::Terminate();
338   breakpad::SymbolFileBreakpad::Terminate();
339   SymbolFileDWARF::Terminate();
340   SymbolFilePDB::Terminate();
341   SymbolFileSymtab::Terminate();
342   UnwindAssembly_x86::Terminate();
343   UnwindAssemblyInstEmulation::Terminate();
344 
345   EmulateInstructionARM::Terminate();
346   EmulateInstructionARM64::Terminate();
347   EmulateInstructionMIPS::Terminate();
348   EmulateInstructionMIPS64::Terminate();
349   EmulateInstructionPPC64::Terminate();
350 
351   SymbolFileDWARFDebugMap::Terminate();
352   ItaniumABILanguageRuntime::Terminate();
353   AppleObjCRuntimeV2::Terminate();
354   AppleObjCRuntimeV1::Terminate();
355   SystemRuntimeMacOSX::Terminate();
356   RenderScriptRuntime::Terminate();
357 
358   CPlusPlusLanguage::Terminate();
359   ObjCLanguage::Terminate();
360   ObjCPlusPlusLanguage::Terminate();
361 
362 #if defined(__APPLE__)
363   DynamicLoaderDarwinKernel::Terminate();
364   ProcessKDP::Terminate();
365   SymbolVendorMacOSX::Terminate();
366   PlatformAppleTVSimulator::Terminate();
367   PlatformAppleWatchSimulator::Terminate();
368   PlatformRemoteAppleTV::Terminate();
369   PlatformRemoteAppleWatch::Terminate();
370   PlatformRemoteAppleBridge::Terminate();
371 #endif
372 
373 #if defined(__FreeBSD__)
374   ProcessFreeBSD::Terminate();
375 #endif
376   Debugger::SettingsTerminate();
377 
378   platform_gdb_server::PlatformRemoteGDBServer::Terminate();
379   process_gdb_remote::ProcessGDBRemote::Terminate();
380   StructuredDataDarwinLog::Terminate();
381 
382   DynamicLoaderMacOSXDYLD::Terminate();
383   DynamicLoaderMacOS::Terminate();
384   DynamicLoaderPOSIXDYLD::Terminate();
385   DynamicLoaderStatic::Terminate();
386   DynamicLoaderWindowsDYLD::Terminate();
387 
388 #if LLDB_ENABLE_PYTHON
389   OperatingSystemPython::Terminate();
390 #endif
391 
392   platform_freebsd::PlatformFreeBSD::Terminate();
393   platform_linux::PlatformLinux::Terminate();
394   platform_netbsd::PlatformNetBSD::Terminate();
395   platform_openbsd::PlatformOpenBSD::Terminate();
396   PlatformWindows::Terminate();
397   platform_android::PlatformAndroid::Terminate();
398   PlatformMacOSX::Terminate();
399   PlatformRemoteiOS::Terminate();
400 #if defined(__APPLE__)
401   PlatformiOSSimulator::Terminate();
402   PlatformDarwinKernel::Terminate();
403 #endif
404 
405   breakpad::ObjectFileBreakpad::Terminate();
406   ObjectFileELF::Terminate();
407   ObjectFileMachO::Terminate();
408   ObjectFilePECOFF::Terminate();
409   wasm::ObjectFileWasm::Terminate();
410 
411   ObjectContainerBSDArchive::Terminate();
412   ObjectContainerUniversalMachO::Terminate();
413 
414   // Now shutdown the common parts, in reverse order.
415   SystemInitializerCommon::Terminate();
416 }
417