1 //===-- SystemInitializerTest.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 "SystemInitializerTest.h"
10 #include "lldb/Core/Debugger.h"
11 #include "lldb/Core/PluginManager.h"
12 #include "lldb/Host/Host.h"
13 #include "lldb/Initialization/SystemInitializerCommon.h"
14 #include "lldb/Interpreter/CommandInterpreter.h"
15 #include "lldb/Utility/Timer.h"
16 #include "llvm/Support/TargetSelect.h"
17 
18 #include <string>
19 
20 LLDB_PLUGIN_DECLARE(ABIMacOSX_arm64);
21 LLDB_PLUGIN_DECLARE(ABISysV_arm64);
22 LLDB_PLUGIN_DECLARE(ABIMacOSX_arm);
23 LLDB_PLUGIN_DECLARE(ABISysV_arm);
24 LLDB_PLUGIN_DECLARE(ABISysV_arc);
25 LLDB_PLUGIN_DECLARE(ABISysV_hexagon);
26 LLDB_PLUGIN_DECLARE(ABISysV_mips);
27 LLDB_PLUGIN_DECLARE(ABISysV_mips64);
28 LLDB_PLUGIN_DECLARE(ABISysV_ppc);
29 LLDB_PLUGIN_DECLARE(ABISysV_ppc64);
30 LLDB_PLUGIN_DECLARE(ABISysV_s390x);
31 LLDB_PLUGIN_DECLARE(ABIMacOSX_i386);
32 LLDB_PLUGIN_DECLARE(ABISysV_i386);
33 LLDB_PLUGIN_DECLARE(ABISysV_x86_64);
34 LLDB_PLUGIN_DECLARE(ABIWindows_x86_64);
35 LLDB_PLUGIN_DECLARE(ObjectFileBreakpad);
36 LLDB_PLUGIN_DECLARE(ObjectFileELF);
37 LLDB_PLUGIN_DECLARE(ObjectFileMachO);
38 LLDB_PLUGIN_DECLARE(ObjectFilePECOFF);
39 LLDB_PLUGIN_DECLARE(ObjectFileWasm);
40 LLDB_PLUGIN_DECLARE(ObjectContainerBSDArchive);
41 LLDB_PLUGIN_DECLARE(ObjectContainerUniversalMachO);
42 LLDB_PLUGIN_DECLARE(ScriptInterpreterNone);
43 LLDB_PLUGIN_DECLARE(PlatformFreeBSD);
44 LLDB_PLUGIN_DECLARE(PlatformLinux);
45 LLDB_PLUGIN_DECLARE(PlatformNetBSD);
46 LLDB_PLUGIN_DECLARE(PlatformOpenBSD);
47 LLDB_PLUGIN_DECLARE(PlatformWindows);
48 LLDB_PLUGIN_DECLARE(PlatformAndroid);
49 LLDB_PLUGIN_DECLARE(PlatformMacOSX);
50 LLDB_PLUGIN_DECLARE(TypeSystemClang);
51 LLDB_PLUGIN_DECLARE(ArchitectureArm);
52 LLDB_PLUGIN_DECLARE(ArchitectureMips);
53 LLDB_PLUGIN_DECLARE(ArchitecturePPC64);
54 LLDB_PLUGIN_DECLARE(DisassemblerLLVMC);
55 LLDB_PLUGIN_DECLARE(JITLoaderGDB);
56 LLDB_PLUGIN_DECLARE(ProcessElfCore);
57 LLDB_PLUGIN_DECLARE(ProcessMachCore);
58 LLDB_PLUGIN_DECLARE(ProcessMinidump);
59 LLDB_PLUGIN_DECLARE(MemoryHistoryASan);
60 LLDB_PLUGIN_DECLARE(InstrumentationRuntimeASan);
61 LLDB_PLUGIN_DECLARE(InstrumentationRuntimeTSan);
62 LLDB_PLUGIN_DECLARE(InstrumentationRuntimeUBSan);
63 LLDB_PLUGIN_DECLARE(InstrumentationRuntimeMainThreadChecker);
64 LLDB_PLUGIN_DECLARE(SymbolVendorELF);
65 LLDB_PLUGIN_DECLARE(SymbolFileBreakpad);
66 LLDB_PLUGIN_DECLARE(SymbolFileDWARF);
67 LLDB_PLUGIN_DECLARE(SymbolFilePDB);
68 LLDB_PLUGIN_DECLARE(SymbolFileSymtab);
69 LLDB_PLUGIN_DECLARE(SymbolVendorWasm);
70 LLDB_PLUGIN_DECLARE(UnwindAssemblyInstEmulation);
71 LLDB_PLUGIN_DECLARE(UnwindAssembly_x86);
72 LLDB_PLUGIN_DECLARE(EmulateInstructionARM);
73 LLDB_PLUGIN_DECLARE(EmulateInstructionARM64);
74 LLDB_PLUGIN_DECLARE(EmulateInstructionMIPS);
75 LLDB_PLUGIN_DECLARE(EmulateInstructionMIPS64);
76 LLDB_PLUGIN_DECLARE(EmulateInstructionPPC64);
77 LLDB_PLUGIN_DECLARE(SymbolFileDWARFDebugMap);
78 LLDB_PLUGIN_DECLARE(ItaniumABILanguageRuntime);
79 LLDB_PLUGIN_DECLARE(AppleObjCRuntime);
80 LLDB_PLUGIN_DECLARE(SystemRuntimeMacOSX);
81 LLDB_PLUGIN_DECLARE(RenderScriptRuntime);
82 LLDB_PLUGIN_DECLARE(CPlusPlusLanguage);
83 LLDB_PLUGIN_DECLARE(ObjCLanguage);
84 LLDB_PLUGIN_DECLARE(ObjCPlusPlusLanguage);
85 #if defined(_WIN32)
86 LLDB_PLUGIN_DECLARE(ProcessWindows);
87 #endif
88 #if defined(__FreeBSD__)
89 LLDB_PLUGIN_DECLARE(ProcessFreeBSD);
90 #endif
91 #if defined(__APPLE__)
92 LLDB_PLUGIN_DECLARE(SymbolVendorMacOSX);
93 LLDB_PLUGIN_DECLARE(ProcessKDP);
94 LLDB_PLUGIN_DECLARE(DynamicLoaderDarwinKernel);
95 #endif
96 LLDB_PLUGIN_DECLARE(StructuredDataDarwinLog);
97 LLDB_PLUGIN_DECLARE(PlatformRemoteGDBServer);
98 LLDB_PLUGIN_DECLARE(ProcessGDBRemote);
99 LLDB_PLUGIN_DECLARE(DynamicLoaderMacOSXDYLD);
100 LLDB_PLUGIN_DECLARE(DynamicLoaderMacOS);
101 LLDB_PLUGIN_DECLARE(DynamicLoaderPOSIXDYLD);
102 LLDB_PLUGIN_DECLARE(DynamicLoaderStatic);
103 LLDB_PLUGIN_DECLARE(DynamicLoaderWindowsDYLD);
104 
105 using namespace lldb_private;
106 
107 SystemInitializerTest::SystemInitializerTest() {}
108 
109 SystemInitializerTest::~SystemInitializerTest() {}
110 
111 #define LLDB_PROCESS_AArch64(op)                                               \
112   op(ABIMacOSX_arm64);                                                         \
113   op(ABISysV_arm64);
114 #define LLDB_PROCESS_ARM(op)                                                   \
115   op(ABIMacOSX_arm);                                                           \
116   op(ABISysV_arm);
117 #define LLDB_PROCESS_Hexagon(op) op(ABISysV_hexagon);
118 #define LLDB_PROCESS_Mips(op)                                                  \
119   op(ABISysV_mips);                                                            \
120   op(ABISysV_mips64);
121 #define LLDB_PROCESS_PowerPC(op)                                               \
122   op(ABISysV_ppc);                                                             \
123   op(ABISysV_ppc64);
124 #define LLDB_PROCESS_SystemZ(op) op(ABISysV_s390x);
125 #define LLDB_PROCESS_X86(op)                                                   \
126   op(ABIMacOSX_i386);                                                          \
127   op(ABISysV_i386);                                                            \
128   op(ABISysV_x86_64);                                                          \
129   op(ABIWindows_x86_64);
130 
131 #define LLDB_PROCESS_AMDGPU(op)
132 #define LLDB_PROCESS_ARC(op)
133 #define LLDB_PROCESS_AVR(op)
134 #define LLDB_PROCESS_BPF(op)
135 #define LLDB_PROCESS_Lanai(op)
136 #define LLDB_PROCESS_MSP430(op)
137 #define LLDB_PROCESS_NVPTX(op)
138 #define LLDB_PROCESS_RISCV(op)
139 #define LLDB_PROCESS_Sparc(op)
140 #define LLDB_PROCESS_WebAssembly(op)
141 #define LLDB_PROCESS_XCore(op)
142 
143 llvm::Error SystemInitializerTest::Initialize() {
144   if (auto e = SystemInitializerCommon::Initialize())
145     return e;
146 
147   LLDB_PLUGIN_INITIALIZE(ObjectFileBreakpad);
148   LLDB_PLUGIN_INITIALIZE(ObjectFileELF);
149   LLDB_PLUGIN_INITIALIZE(ObjectFileMachO);
150   LLDB_PLUGIN_INITIALIZE(ObjectFilePECOFF);
151   LLDB_PLUGIN_INITIALIZE(ObjectFileWasm);
152 
153   LLDB_PLUGIN_INITIALIZE(ObjectContainerBSDArchive);
154   LLDB_PLUGIN_INITIALIZE(ObjectContainerUniversalMachO);
155 
156   LLDB_PLUGIN_INITIALIZE(ScriptInterpreterNone);
157 
158   LLDB_PLUGIN_INITIALIZE(PlatformFreeBSD);
159   LLDB_PLUGIN_INITIALIZE(PlatformLinux);
160   LLDB_PLUGIN_INITIALIZE(PlatformNetBSD);
161   LLDB_PLUGIN_INITIALIZE(PlatformOpenBSD);
162   LLDB_PLUGIN_INITIALIZE(PlatformWindows);
163   LLDB_PLUGIN_INITIALIZE(PlatformAndroid);
164   LLDB_PLUGIN_INITIALIZE(PlatformMacOSX);
165 
166   // Initialize LLVM and Clang
167   llvm::InitializeAllTargets();
168   llvm::InitializeAllAsmPrinters();
169   llvm::InitializeAllTargetMCs();
170   llvm::InitializeAllDisassemblers();
171 
172   LLDB_PLUGIN_INITIALIZE(TypeSystemClang);
173 
174 #define LLVM_TARGET(t) LLDB_PROCESS_##t(LLDB_PLUGIN_INITIALIZE)
175 #include "llvm/Config/Targets.def"
176 
177   LLDB_PLUGIN_INITIALIZE(ArchitectureArm);
178   LLDB_PLUGIN_INITIALIZE(ArchitectureMips);
179   LLDB_PLUGIN_INITIALIZE(ArchitecturePPC64);
180 
181   LLDB_PLUGIN_INITIALIZE(DisassemblerLLVMC);
182 
183   LLDB_PLUGIN_INITIALIZE(JITLoaderGDB);
184   LLDB_PLUGIN_INITIALIZE(ProcessElfCore);
185   LLDB_PLUGIN_INITIALIZE(ProcessMachCore);
186   LLDB_PLUGIN_INITIALIZE(ProcessMinidump);
187   LLDB_PLUGIN_INITIALIZE(MemoryHistoryASan);
188   LLDB_PLUGIN_INITIALIZE(InstrumentationRuntimeASan);
189   LLDB_PLUGIN_INITIALIZE(InstrumentationRuntimeTSan);
190   LLDB_PLUGIN_INITIALIZE(InstrumentationRuntimeUBSan);
191   LLDB_PLUGIN_INITIALIZE(InstrumentationRuntimeMainThreadChecker);
192 
193   LLDB_PLUGIN_INITIALIZE(SymbolVendorELF);
194   LLDB_PLUGIN_INITIALIZE(SymbolFileBreakpad);
195   LLDB_PLUGIN_INITIALIZE(SymbolFileDWARF);
196   LLDB_PLUGIN_INITIALIZE(SymbolFilePDB);
197   LLDB_PLUGIN_INITIALIZE(SymbolFileSymtab);
198   LLDB_PLUGIN_INITIALIZE(SymbolVendorWasm);
199   LLDB_PLUGIN_INITIALIZE(UnwindAssemblyInstEmulation);
200   LLDB_PLUGIN_INITIALIZE(UnwindAssembly_x86);
201 
202   LLDB_PLUGIN_INITIALIZE(EmulateInstructionARM);
203   LLDB_PLUGIN_INITIALIZE(EmulateInstructionARM64);
204   LLDB_PLUGIN_INITIALIZE(EmulateInstructionMIPS);
205   LLDB_PLUGIN_INITIALIZE(EmulateInstructionMIPS64);
206   LLDB_PLUGIN_INITIALIZE(EmulateInstructionPPC64);
207 
208   LLDB_PLUGIN_INITIALIZE(SymbolFileDWARFDebugMap);
209   LLDB_PLUGIN_INITIALIZE(ItaniumABILanguageRuntime);
210   LLDB_PLUGIN_INITIALIZE(AppleObjCRuntime);
211   LLDB_PLUGIN_INITIALIZE(SystemRuntimeMacOSX);
212   LLDB_PLUGIN_INITIALIZE(RenderScriptRuntime);
213 
214   LLDB_PLUGIN_INITIALIZE(CPlusPlusLanguage);
215   LLDB_PLUGIN_INITIALIZE(ObjCLanguage);
216   LLDB_PLUGIN_INITIALIZE(ObjCPlusPlusLanguage);
217 
218 #if defined(_WIN32)
219   LLDB_PLUGIN_INITIALIZE(ProcessWindows);
220 #endif
221 #if defined(__FreeBSD__)
222   LLDB_PLUGIN_INITIALIZE(ProcessFreeBSD);
223 #endif
224 #if defined(__APPLE__)
225   LLDB_PLUGIN_INITIALIZE(SymbolVendorMacOSX);
226   LLDB_PLUGIN_INITIALIZE(ProcessKDP);
227   LLDB_PLUGIN_INITIALIZE(DynamicLoaderDarwinKernel);
228 #endif
229 
230   // This plugin is valid on any host that talks to a Darwin remote. It
231   // shouldn't be limited to __APPLE__.
232   LLDB_PLUGIN_INITIALIZE(StructuredDataDarwinLog);
233 
234   // Platform agnostic plugins
235   LLDB_PLUGIN_INITIALIZE(PlatformRemoteGDBServer);
236 
237   LLDB_PLUGIN_INITIALIZE(ProcessGDBRemote);
238   LLDB_PLUGIN_INITIALIZE(DynamicLoaderMacOSXDYLD);
239   LLDB_PLUGIN_INITIALIZE(DynamicLoaderMacOS);
240   LLDB_PLUGIN_INITIALIZE(DynamicLoaderPOSIXDYLD);
241   LLDB_PLUGIN_INITIALIZE(DynamicLoaderStatic);
242   LLDB_PLUGIN_INITIALIZE(DynamicLoaderWindowsDYLD);
243 
244   // Scan for any system or user LLDB plug-ins
245   PluginManager::Initialize();
246 
247   // The process settings need to know about installed plug-ins, so the
248   // Settings must be initialized
249   // AFTER PluginManager::Initialize is called.
250 
251   Debugger::SettingsInitialize();
252 
253   return llvm::Error::success();
254 }
255 
256 void SystemInitializerTest::Terminate() {
257   static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
258   Timer scoped_timer(func_cat, LLVM_PRETTY_FUNCTION);
259 
260   Debugger::SettingsTerminate();
261 
262   // Terminate and unload and loaded system or user LLDB plug-ins
263   PluginManager::Terminate();
264 
265   LLDB_PLUGIN_TERMINATE(TypeSystemClang);
266 
267   LLDB_PLUGIN_TERMINATE(ArchitectureArm);
268   LLDB_PLUGIN_TERMINATE(ArchitectureMips);
269   LLDB_PLUGIN_TERMINATE(ArchitecturePPC64);
270 
271 #define LLVM_TARGET(t) LLDB_PROCESS_##t(LLDB_PLUGIN_TERMINATE)
272 #include "llvm/Config/Targets.def"
273 
274   LLDB_PLUGIN_TERMINATE(DisassemblerLLVMC);
275 
276   LLDB_PLUGIN_TERMINATE(JITLoaderGDB);
277   LLDB_PLUGIN_TERMINATE(ProcessElfCore);
278   LLDB_PLUGIN_TERMINATE(ProcessMachCore);
279   LLDB_PLUGIN_TERMINATE(ProcessMinidump);
280   LLDB_PLUGIN_TERMINATE(MemoryHistoryASan);
281 
282   LLDB_PLUGIN_TERMINATE(InstrumentationRuntimeASan);
283   LLDB_PLUGIN_TERMINATE(InstrumentationRuntimeTSan);
284   LLDB_PLUGIN_TERMINATE(InstrumentationRuntimeUBSan);
285   LLDB_PLUGIN_TERMINATE(InstrumentationRuntimeMainThreadChecker);
286 
287   LLDB_PLUGIN_TERMINATE(SymbolVendorWasm);
288   LLDB_PLUGIN_TERMINATE(SymbolVendorELF);
289   LLDB_PLUGIN_TERMINATE(SymbolFileBreakpad);
290   LLDB_PLUGIN_TERMINATE(SymbolFileDWARF);
291   LLDB_PLUGIN_TERMINATE(SymbolFilePDB);
292   LLDB_PLUGIN_TERMINATE(SymbolFileSymtab);
293   LLDB_PLUGIN_TERMINATE(UnwindAssembly_x86);
294   LLDB_PLUGIN_TERMINATE(UnwindAssemblyInstEmulation);
295 
296   LLDB_PLUGIN_TERMINATE(EmulateInstructionARM);
297   LLDB_PLUGIN_TERMINATE(EmulateInstructionARM64);
298   LLDB_PLUGIN_TERMINATE(EmulateInstructionMIPS);
299   LLDB_PLUGIN_TERMINATE(EmulateInstructionMIPS64);
300   LLDB_PLUGIN_TERMINATE(EmulateInstructionPPC64);
301 
302   LLDB_PLUGIN_TERMINATE(SymbolFileDWARFDebugMap);
303   LLDB_PLUGIN_TERMINATE(ItaniumABILanguageRuntime);
304   LLDB_PLUGIN_TERMINATE(AppleObjCRuntime);
305   LLDB_PLUGIN_TERMINATE(SystemRuntimeMacOSX);
306   LLDB_PLUGIN_TERMINATE(RenderScriptRuntime);
307 
308   LLDB_PLUGIN_TERMINATE(CPlusPlusLanguage);
309   LLDB_PLUGIN_TERMINATE(ObjCLanguage);
310   LLDB_PLUGIN_TERMINATE(ObjCPlusPlusLanguage);
311 
312 #if defined(__APPLE__)
313   LLDB_PLUGIN_TERMINATE(DynamicLoaderDarwinKernel);
314   LLDB_PLUGIN_TERMINATE(ProcessKDP);
315   LLDB_PLUGIN_TERMINATE(SymbolVendorMacOSX);
316 #endif
317 
318 #if defined(__FreeBSD__)
319   LLDB_PLUGIN_TERMINATE(ProcessFreeBSD);
320 #endif
321   Debugger::SettingsTerminate();
322 
323   LLDB_PLUGIN_TERMINATE(PlatformRemoteGDBServer);
324   LLDB_PLUGIN_TERMINATE(ProcessGDBRemote);
325   LLDB_PLUGIN_TERMINATE(StructuredDataDarwinLog);
326 
327   LLDB_PLUGIN_TERMINATE(DynamicLoaderMacOSXDYLD);
328   LLDB_PLUGIN_TERMINATE(DynamicLoaderMacOS);
329   LLDB_PLUGIN_TERMINATE(DynamicLoaderPOSIXDYLD);
330   LLDB_PLUGIN_TERMINATE(DynamicLoaderStatic);
331   LLDB_PLUGIN_TERMINATE(DynamicLoaderWindowsDYLD);
332 
333   LLDB_PLUGIN_TERMINATE(PlatformFreeBSD);
334   LLDB_PLUGIN_TERMINATE(PlatformLinux);
335   LLDB_PLUGIN_TERMINATE(PlatformNetBSD);
336   LLDB_PLUGIN_TERMINATE(PlatformOpenBSD);
337   LLDB_PLUGIN_TERMINATE(PlatformWindows);
338   LLDB_PLUGIN_TERMINATE(PlatformAndroid);
339   LLDB_PLUGIN_TERMINATE(PlatformMacOSX);
340 
341   LLDB_PLUGIN_TERMINATE(ObjectFileBreakpad);
342   LLDB_PLUGIN_TERMINATE(ObjectFileELF);
343   LLDB_PLUGIN_TERMINATE(ObjectFileMachO);
344   LLDB_PLUGIN_TERMINATE(ObjectFilePECOFF);
345   LLDB_PLUGIN_TERMINATE(ObjectFileWasm);
346 
347   LLDB_PLUGIN_TERMINATE(ObjectContainerBSDArchive);
348   LLDB_PLUGIN_TERMINATE(ObjectContainerUniversalMachO);
349 
350   LLDB_PLUGIN_TERMINATE(ScriptInterpreterNone);
351 
352   // Now shutdown the common parts, in reverse order.
353   SystemInitializerCommon::Terminate();
354 }
355