1 //===-- PluginManager.cpp -------------------------------------------------===//
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 "lldb/Core/PluginManager.h"
10 
11 #include "lldb/Core/Debugger.h"
12 #include "lldb/Host/FileSystem.h"
13 #include "lldb/Host/HostInfo.h"
14 #include "lldb/Interpreter/OptionValueProperties.h"
15 #include "lldb/Utility/ConstString.h"
16 #include "lldb/Utility/FileSpec.h"
17 #include "lldb/Utility/Status.h"
18 #include "lldb/Utility/StringList.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Support/DynamicLibrary.h"
21 #include "llvm/Support/FileSystem.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include <assert.h>
24 #include <map>
25 #include <memory>
26 #include <mutex>
27 #include <string>
28 #include <utility>
29 #include <vector>
30 #if defined(_WIN32)
31 #include "lldb/Host/windows/PosixApi.h"
32 #endif
33 
34 using namespace lldb;
35 using namespace lldb_private;
36 
37 typedef bool (*PluginInitCallback)();
38 typedef void (*PluginTermCallback)();
39 
40 struct PluginInfo {
41   PluginInfo() : plugin_init_callback(nullptr), plugin_term_callback(nullptr) {}
42 
43   llvm::sys::DynamicLibrary library;
44   PluginInitCallback plugin_init_callback;
45   PluginTermCallback plugin_term_callback;
46 };
47 
48 typedef std::map<FileSpec, PluginInfo> PluginTerminateMap;
49 
50 static std::recursive_mutex &GetPluginMapMutex() {
51   static std::recursive_mutex g_plugin_map_mutex;
52   return g_plugin_map_mutex;
53 }
54 
55 static PluginTerminateMap &GetPluginMap() {
56   static PluginTerminateMap g_plugin_map;
57   return g_plugin_map;
58 }
59 
60 static bool PluginIsLoaded(const FileSpec &plugin_file_spec) {
61   std::lock_guard<std::recursive_mutex> guard(GetPluginMapMutex());
62   PluginTerminateMap &plugin_map = GetPluginMap();
63   return plugin_map.find(plugin_file_spec) != plugin_map.end();
64 }
65 
66 static void SetPluginInfo(const FileSpec &plugin_file_spec,
67                           const PluginInfo &plugin_info) {
68   std::lock_guard<std::recursive_mutex> guard(GetPluginMapMutex());
69   PluginTerminateMap &plugin_map = GetPluginMap();
70   assert(plugin_map.find(plugin_file_spec) == plugin_map.end());
71   plugin_map[plugin_file_spec] = plugin_info;
72 }
73 
74 template <typename FPtrTy> static FPtrTy CastToFPtr(void *VPtr) {
75   return reinterpret_cast<FPtrTy>(VPtr);
76 }
77 
78 static FileSystem::EnumerateDirectoryResult
79 LoadPluginCallback(void *baton, llvm::sys::fs::file_type ft,
80                    llvm::StringRef path) {
81   Status error;
82 
83   namespace fs = llvm::sys::fs;
84   // If we have a regular file, a symbolic link or unknown file type, try and
85   // process the file. We must handle unknown as sometimes the directory
86   // enumeration might be enumerating a file system that doesn't have correct
87   // file type information.
88   if (ft == fs::file_type::regular_file || ft == fs::file_type::symlink_file ||
89       ft == fs::file_type::type_unknown) {
90     FileSpec plugin_file_spec(path);
91     FileSystem::Instance().Resolve(plugin_file_spec);
92 
93     if (PluginIsLoaded(plugin_file_spec))
94       return FileSystem::eEnumerateDirectoryResultNext;
95     else {
96       PluginInfo plugin_info;
97 
98       std::string pluginLoadError;
99       plugin_info.library = llvm::sys::DynamicLibrary::getPermanentLibrary(
100           plugin_file_spec.GetPath().c_str(), &pluginLoadError);
101       if (plugin_info.library.isValid()) {
102         bool success = false;
103         plugin_info.plugin_init_callback = CastToFPtr<PluginInitCallback>(
104             plugin_info.library.getAddressOfSymbol("LLDBPluginInitialize"));
105         if (plugin_info.plugin_init_callback) {
106           // Call the plug-in "bool LLDBPluginInitialize(void)" function
107           success = plugin_info.plugin_init_callback();
108         }
109 
110         if (success) {
111           // It is ok for the "LLDBPluginTerminate" symbol to be nullptr
112           plugin_info.plugin_term_callback = CastToFPtr<PluginTermCallback>(
113               plugin_info.library.getAddressOfSymbol("LLDBPluginTerminate"));
114         } else {
115           // The initialize function returned FALSE which means the plug-in
116           // might not be compatible, or might be too new or too old, or might
117           // not want to run on this machine.  Set it to a default-constructed
118           // instance to invalidate it.
119           plugin_info = PluginInfo();
120         }
121 
122         // Regardless of success or failure, cache the plug-in load in our
123         // plug-in info so we don't try to load it again and again.
124         SetPluginInfo(plugin_file_spec, plugin_info);
125 
126         return FileSystem::eEnumerateDirectoryResultNext;
127       }
128     }
129   }
130 
131   if (ft == fs::file_type::directory_file ||
132       ft == fs::file_type::symlink_file || ft == fs::file_type::type_unknown) {
133     // Try and recurse into anything that a directory or symbolic link. We must
134     // also do this for unknown as sometimes the directory enumeration might be
135     // enumerating a file system that doesn't have correct file type
136     // information.
137     return FileSystem::eEnumerateDirectoryResultEnter;
138   }
139 
140   return FileSystem::eEnumerateDirectoryResultNext;
141 }
142 
143 void PluginManager::Initialize() {
144   const bool find_directories = true;
145   const bool find_files = true;
146   const bool find_other = true;
147   char dir_path[PATH_MAX];
148   if (FileSpec dir_spec = HostInfo::GetSystemPluginDir()) {
149     if (FileSystem::Instance().Exists(dir_spec) &&
150         dir_spec.GetPath(dir_path, sizeof(dir_path))) {
151       FileSystem::Instance().EnumerateDirectory(dir_path, find_directories,
152                                                 find_files, find_other,
153                                                 LoadPluginCallback, nullptr);
154     }
155   }
156 
157   if (FileSpec dir_spec = HostInfo::GetUserPluginDir()) {
158     if (FileSystem::Instance().Exists(dir_spec) &&
159         dir_spec.GetPath(dir_path, sizeof(dir_path))) {
160       FileSystem::Instance().EnumerateDirectory(dir_path, find_directories,
161                                                 find_files, find_other,
162                                                 LoadPluginCallback, nullptr);
163     }
164   }
165 }
166 
167 void PluginManager::Terminate() {
168   std::lock_guard<std::recursive_mutex> guard(GetPluginMapMutex());
169   PluginTerminateMap &plugin_map = GetPluginMap();
170 
171   PluginTerminateMap::const_iterator pos, end = plugin_map.end();
172   for (pos = plugin_map.begin(); pos != end; ++pos) {
173     // Call the plug-in "void LLDBPluginTerminate (void)" function if there is
174     // one (if the symbol was not nullptr).
175     if (pos->second.library.isValid()) {
176       if (pos->second.plugin_term_callback)
177         pos->second.plugin_term_callback();
178     }
179   }
180   plugin_map.clear();
181 }
182 
183 template <typename Callback> struct PluginInstance {
184   typedef Callback CallbackType;
185 
186   PluginInstance() = default;
187   PluginInstance(ConstString name, std::string description,
188                  Callback create_callback = nullptr,
189                  DebuggerInitializeCallback debugger_init_callback = nullptr)
190       : name(name), description(std::move(description)),
191         create_callback(create_callback),
192         debugger_init_callback(debugger_init_callback) {}
193 
194   ConstString name;
195   std::string description;
196   Callback create_callback;
197   DebuggerInitializeCallback debugger_init_callback;
198 };
199 
200 template <typename Instance> class PluginInstances {
201 public:
202   template <typename... Args>
203   bool RegisterPlugin(ConstString name, const char *description,
204                       typename Instance::CallbackType callback,
205                       Args &&... args) {
206     if (!callback)
207       return false;
208     assert((bool)name);
209     Instance instance =
210         Instance(name, description, callback, std::forward<Args>(args)...);
211     m_instances.push_back(instance);
212     return false;
213   }
214 
215   bool UnregisterPlugin(typename Instance::CallbackType callback) {
216     if (!callback)
217       return false;
218     auto pos = m_instances.begin();
219     auto end = m_instances.end();
220     for (; pos != end; ++pos) {
221       if (pos->create_callback == callback) {
222         m_instances.erase(pos);
223         return true;
224       }
225     }
226     return false;
227   }
228 
229   typename Instance::CallbackType GetCallbackAtIndex(uint32_t idx) {
230     if (Instance *instance = GetInstanceAtIndex(idx))
231       return instance->create_callback;
232     return nullptr;
233   }
234 
235   const char *GetDescriptionAtIndex(uint32_t idx) {
236     if (Instance *instance = GetInstanceAtIndex(idx))
237       return instance->description.c_str();
238     return nullptr;
239   }
240 
241   const char *GetNameAtIndex(uint32_t idx) {
242     if (Instance *instance = GetInstanceAtIndex(idx))
243       return instance->name.GetCString();
244     return nullptr;
245   }
246 
247   typename Instance::CallbackType GetCallbackForName(ConstString name) {
248     if (!name)
249       return nullptr;
250     for (auto &instance : m_instances) {
251       if (name == instance.name)
252         return instance.create_callback;
253     }
254     return nullptr;
255   }
256 
257   void PerformDebuggerCallback(Debugger &debugger) {
258     for (auto &instance : m_instances) {
259       if (instance.debugger_init_callback)
260         instance.debugger_init_callback(debugger);
261     }
262   }
263 
264   const std::vector<Instance> &GetInstances() const { return m_instances; }
265   std::vector<Instance> &GetInstances() { return m_instances; }
266 
267   Instance *GetInstanceAtIndex(uint32_t idx) {
268     if (idx < m_instances.size())
269       return &m_instances[idx];
270     return nullptr;
271   }
272 
273 private:
274   std::vector<Instance> m_instances;
275 };
276 
277 #pragma mark ABI
278 
279 typedef PluginInstance<ABICreateInstance> ABIInstance;
280 typedef PluginInstances<ABIInstance> ABIInstances;
281 
282 static ABIInstances &GetABIInstances() {
283   static ABIInstances g_instances;
284   return g_instances;
285 }
286 
287 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
288                                    ABICreateInstance create_callback) {
289   return GetABIInstances().RegisterPlugin(name, description, create_callback);
290 }
291 
292 bool PluginManager::UnregisterPlugin(ABICreateInstance create_callback) {
293   return GetABIInstances().UnregisterPlugin(create_callback);
294 }
295 
296 ABICreateInstance PluginManager::GetABICreateCallbackAtIndex(uint32_t idx) {
297   return GetABIInstances().GetCallbackAtIndex(idx);
298 }
299 
300 #pragma mark Architecture
301 
302 typedef PluginInstance<ArchitectureCreateInstance> ArchitectureInstance;
303 typedef std::vector<ArchitectureInstance> ArchitectureInstances;
304 
305 static ArchitectureInstances &GetArchitectureInstances() {
306   static ArchitectureInstances g_instances;
307   return g_instances;
308 }
309 
310 void PluginManager::RegisterPlugin(ConstString name,
311                                    llvm::StringRef description,
312                                    ArchitectureCreateInstance create_callback) {
313   GetArchitectureInstances().push_back(
314       {name, std::string(description), create_callback});
315 }
316 
317 void PluginManager::UnregisterPlugin(
318     ArchitectureCreateInstance create_callback) {
319   auto &instances = GetArchitectureInstances();
320 
321   for (auto pos = instances.begin(), end = instances.end(); pos != end; ++pos) {
322     if (pos->create_callback == create_callback) {
323       instances.erase(pos);
324       return;
325     }
326   }
327   llvm_unreachable("Plugin not found");
328 }
329 
330 std::unique_ptr<Architecture>
331 PluginManager::CreateArchitectureInstance(const ArchSpec &arch) {
332   for (const auto &instances : GetArchitectureInstances()) {
333     if (auto plugin_up = instances.create_callback(arch))
334       return plugin_up;
335   }
336   return nullptr;
337 }
338 
339 #pragma mark Disassembler
340 
341 typedef PluginInstance<DisassemblerCreateInstance> DisassemblerInstance;
342 typedef PluginInstances<DisassemblerInstance> DisassemblerInstances;
343 
344 static DisassemblerInstances &GetDisassemblerInstances() {
345   static DisassemblerInstances g_instances;
346   return g_instances;
347 }
348 
349 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
350                                    DisassemblerCreateInstance create_callback) {
351   return GetDisassemblerInstances().RegisterPlugin(name, description,
352                                                    create_callback);
353 }
354 
355 bool PluginManager::UnregisterPlugin(
356     DisassemblerCreateInstance create_callback) {
357   return GetDisassemblerInstances().UnregisterPlugin(create_callback);
358 }
359 
360 DisassemblerCreateInstance
361 PluginManager::GetDisassemblerCreateCallbackAtIndex(uint32_t idx) {
362   return GetDisassemblerInstances().GetCallbackAtIndex(idx);
363 }
364 
365 DisassemblerCreateInstance
366 PluginManager::GetDisassemblerCreateCallbackForPluginName(ConstString name) {
367   return GetDisassemblerInstances().GetCallbackForName(name);
368 }
369 
370 #pragma mark DynamicLoader
371 
372 typedef PluginInstance<DynamicLoaderCreateInstance> DynamicLoaderInstance;
373 typedef PluginInstances<DynamicLoaderInstance> DynamicLoaderInstances;
374 
375 static DynamicLoaderInstances &GetDynamicLoaderInstances() {
376   static DynamicLoaderInstances g_instances;
377   return g_instances;
378 }
379 
380 bool PluginManager::RegisterPlugin(
381     ConstString name, const char *description,
382     DynamicLoaderCreateInstance create_callback,
383     DebuggerInitializeCallback debugger_init_callback) {
384   return GetDynamicLoaderInstances().RegisterPlugin(
385       name, description, create_callback, debugger_init_callback);
386 }
387 
388 bool PluginManager::UnregisterPlugin(
389     DynamicLoaderCreateInstance create_callback) {
390   return GetDynamicLoaderInstances().UnregisterPlugin(create_callback);
391 }
392 
393 DynamicLoaderCreateInstance
394 PluginManager::GetDynamicLoaderCreateCallbackAtIndex(uint32_t idx) {
395   return GetDynamicLoaderInstances().GetCallbackAtIndex(idx);
396 }
397 
398 DynamicLoaderCreateInstance
399 PluginManager::GetDynamicLoaderCreateCallbackForPluginName(ConstString name) {
400   return GetDynamicLoaderInstances().GetCallbackForName(name);
401 }
402 
403 #pragma mark JITLoader
404 
405 typedef PluginInstance<JITLoaderCreateInstance> JITLoaderInstance;
406 typedef PluginInstances<JITLoaderInstance> JITLoaderInstances;
407 
408 static JITLoaderInstances &GetJITLoaderInstances() {
409   static JITLoaderInstances g_instances;
410   return g_instances;
411 }
412 
413 bool PluginManager::RegisterPlugin(
414     ConstString name, const char *description,
415     JITLoaderCreateInstance create_callback,
416     DebuggerInitializeCallback debugger_init_callback) {
417   return GetJITLoaderInstances().RegisterPlugin(
418       name, description, create_callback, debugger_init_callback);
419 }
420 
421 bool PluginManager::UnregisterPlugin(JITLoaderCreateInstance create_callback) {
422   return GetJITLoaderInstances().UnregisterPlugin(create_callback);
423 }
424 
425 JITLoaderCreateInstance
426 PluginManager::GetJITLoaderCreateCallbackAtIndex(uint32_t idx) {
427   return GetJITLoaderInstances().GetCallbackAtIndex(idx);
428 }
429 
430 #pragma mark EmulateInstruction
431 
432 typedef PluginInstance<EmulateInstructionCreateInstance>
433     EmulateInstructionInstance;
434 typedef PluginInstances<EmulateInstructionInstance> EmulateInstructionInstances;
435 
436 static EmulateInstructionInstances &GetEmulateInstructionInstances() {
437   static EmulateInstructionInstances g_instances;
438   return g_instances;
439 }
440 
441 bool PluginManager::RegisterPlugin(
442     ConstString name, const char *description,
443     EmulateInstructionCreateInstance create_callback) {
444   return GetEmulateInstructionInstances().RegisterPlugin(name, description,
445                                                          create_callback);
446 }
447 
448 bool PluginManager::UnregisterPlugin(
449     EmulateInstructionCreateInstance create_callback) {
450   return GetEmulateInstructionInstances().UnregisterPlugin(create_callback);
451 }
452 
453 EmulateInstructionCreateInstance
454 PluginManager::GetEmulateInstructionCreateCallbackAtIndex(uint32_t idx) {
455   return GetEmulateInstructionInstances().GetCallbackAtIndex(idx);
456 }
457 
458 EmulateInstructionCreateInstance
459 PluginManager::GetEmulateInstructionCreateCallbackForPluginName(
460     ConstString name) {
461   return GetEmulateInstructionInstances().GetCallbackForName(name);
462 }
463 
464 #pragma mark OperatingSystem
465 
466 typedef PluginInstance<OperatingSystemCreateInstance> OperatingSystemInstance;
467 typedef PluginInstances<OperatingSystemInstance> OperatingSystemInstances;
468 
469 static OperatingSystemInstances &GetOperatingSystemInstances() {
470   static OperatingSystemInstances g_instances;
471   return g_instances;
472 }
473 
474 bool PluginManager::RegisterPlugin(
475     ConstString name, const char *description,
476     OperatingSystemCreateInstance create_callback,
477     DebuggerInitializeCallback debugger_init_callback) {
478   return GetOperatingSystemInstances().RegisterPlugin(
479       name, description, create_callback, debugger_init_callback);
480 }
481 
482 bool PluginManager::UnregisterPlugin(
483     OperatingSystemCreateInstance create_callback) {
484   return GetOperatingSystemInstances().UnregisterPlugin(create_callback);
485 }
486 
487 OperatingSystemCreateInstance
488 PluginManager::GetOperatingSystemCreateCallbackAtIndex(uint32_t idx) {
489   return GetOperatingSystemInstances().GetCallbackAtIndex(idx);
490 }
491 
492 OperatingSystemCreateInstance
493 PluginManager::GetOperatingSystemCreateCallbackForPluginName(ConstString name) {
494   return GetOperatingSystemInstances().GetCallbackForName(name);
495 }
496 
497 #pragma mark Language
498 
499 typedef PluginInstance<LanguageCreateInstance> LanguageInstance;
500 typedef PluginInstances<LanguageInstance> LanguageInstances;
501 
502 static LanguageInstances &GetLanguageInstances() {
503   static LanguageInstances g_instances;
504   return g_instances;
505 }
506 
507 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
508                                    LanguageCreateInstance create_callback) {
509   return GetLanguageInstances().RegisterPlugin(name, description,
510                                                create_callback);
511 }
512 
513 bool PluginManager::UnregisterPlugin(LanguageCreateInstance create_callback) {
514   return GetLanguageInstances().UnregisterPlugin(create_callback);
515 }
516 
517 LanguageCreateInstance
518 PluginManager::GetLanguageCreateCallbackAtIndex(uint32_t idx) {
519   return GetLanguageInstances().GetCallbackAtIndex(idx);
520 }
521 
522 #pragma mark LanguageRuntime
523 
524 struct LanguageRuntimeInstance
525     : public PluginInstance<LanguageRuntimeCreateInstance> {
526   LanguageRuntimeInstance(
527       ConstString name, std::string description, CallbackType create_callback,
528       DebuggerInitializeCallback debugger_init_callback,
529       LanguageRuntimeGetCommandObject command_callback,
530       LanguageRuntimeGetExceptionPrecondition precondition_callback)
531       : PluginInstance<LanguageRuntimeCreateInstance>(
532             name, std::move(description), create_callback,
533             debugger_init_callback),
534         command_callback(command_callback),
535         precondition_callback(precondition_callback) {}
536 
537   LanguageRuntimeGetCommandObject command_callback;
538   LanguageRuntimeGetExceptionPrecondition precondition_callback;
539 };
540 
541 typedef PluginInstances<LanguageRuntimeInstance> LanguageRuntimeInstances;
542 
543 static LanguageRuntimeInstances &GetLanguageRuntimeInstances() {
544   static LanguageRuntimeInstances g_instances;
545   return g_instances;
546 }
547 
548 bool PluginManager::RegisterPlugin(
549     ConstString name, const char *description,
550     LanguageRuntimeCreateInstance create_callback,
551     LanguageRuntimeGetCommandObject command_callback,
552     LanguageRuntimeGetExceptionPrecondition precondition_callback) {
553   return GetLanguageRuntimeInstances().RegisterPlugin(
554       name, description, create_callback, nullptr, command_callback,
555       precondition_callback);
556 }
557 
558 bool PluginManager::UnregisterPlugin(
559     LanguageRuntimeCreateInstance create_callback) {
560   return GetLanguageRuntimeInstances().UnregisterPlugin(create_callback);
561 }
562 
563 LanguageRuntimeCreateInstance
564 PluginManager::GetLanguageRuntimeCreateCallbackAtIndex(uint32_t idx) {
565   return GetLanguageRuntimeInstances().GetCallbackAtIndex(idx);
566 }
567 
568 LanguageRuntimeGetCommandObject
569 PluginManager::GetLanguageRuntimeGetCommandObjectAtIndex(uint32_t idx) {
570   const auto &instances = GetLanguageRuntimeInstances().GetInstances();
571   if (idx < instances.size())
572     return instances[idx].command_callback;
573   return nullptr;
574 }
575 
576 LanguageRuntimeGetExceptionPrecondition
577 PluginManager::GetLanguageRuntimeGetExceptionPreconditionAtIndex(uint32_t idx) {
578   const auto &instances = GetLanguageRuntimeInstances().GetInstances();
579   if (idx < instances.size())
580     return instances[idx].precondition_callback;
581   return nullptr;
582 }
583 
584 #pragma mark SystemRuntime
585 
586 typedef PluginInstance<SystemRuntimeCreateInstance> SystemRuntimeInstance;
587 typedef PluginInstances<SystemRuntimeInstance> SystemRuntimeInstances;
588 
589 static SystemRuntimeInstances &GetSystemRuntimeInstances() {
590   static SystemRuntimeInstances g_instances;
591   return g_instances;
592 }
593 
594 bool PluginManager::RegisterPlugin(
595     ConstString name, const char *description,
596     SystemRuntimeCreateInstance create_callback) {
597   return GetSystemRuntimeInstances().RegisterPlugin(name, description,
598                                                     create_callback);
599 }
600 
601 bool PluginManager::UnregisterPlugin(
602     SystemRuntimeCreateInstance create_callback) {
603   return GetSystemRuntimeInstances().UnregisterPlugin(create_callback);
604 }
605 
606 SystemRuntimeCreateInstance
607 PluginManager::GetSystemRuntimeCreateCallbackAtIndex(uint32_t idx) {
608   return GetSystemRuntimeInstances().GetCallbackAtIndex(idx);
609 }
610 
611 #pragma mark ObjectFile
612 
613 struct ObjectFileInstance : public PluginInstance<ObjectFileCreateInstance> {
614   ObjectFileInstance(
615       ConstString name, std::string description, CallbackType create_callback,
616       ObjectFileCreateMemoryInstance create_memory_callback,
617       ObjectFileGetModuleSpecifications get_module_specifications,
618       ObjectFileSaveCore save_core)
619       : PluginInstance<ObjectFileCreateInstance>(name, std::move(description),
620                                                  create_callback),
621         create_memory_callback(create_memory_callback),
622         get_module_specifications(get_module_specifications),
623         save_core(save_core) {}
624 
625   ObjectFileCreateMemoryInstance create_memory_callback;
626   ObjectFileGetModuleSpecifications get_module_specifications;
627   ObjectFileSaveCore save_core;
628 };
629 typedef PluginInstances<ObjectFileInstance> ObjectFileInstances;
630 
631 static ObjectFileInstances &GetObjectFileInstances() {
632   static ObjectFileInstances g_instances;
633   return g_instances;
634 }
635 
636 bool PluginManager::RegisterPlugin(
637     ConstString name, const char *description,
638     ObjectFileCreateInstance create_callback,
639     ObjectFileCreateMemoryInstance create_memory_callback,
640     ObjectFileGetModuleSpecifications get_module_specifications,
641     ObjectFileSaveCore save_core) {
642   return GetObjectFileInstances().RegisterPlugin(
643       name, description, create_callback, create_memory_callback,
644       get_module_specifications, save_core);
645 }
646 
647 bool PluginManager::UnregisterPlugin(ObjectFileCreateInstance create_callback) {
648   return GetObjectFileInstances().UnregisterPlugin(create_callback);
649 }
650 
651 ObjectFileCreateInstance
652 PluginManager::GetObjectFileCreateCallbackAtIndex(uint32_t idx) {
653   return GetObjectFileInstances().GetCallbackAtIndex(idx);
654 }
655 
656 ObjectFileCreateMemoryInstance
657 PluginManager::GetObjectFileCreateMemoryCallbackAtIndex(uint32_t idx) {
658   const auto &instances = GetObjectFileInstances().GetInstances();
659   if (idx < instances.size())
660     return instances[idx].create_memory_callback;
661   return nullptr;
662 }
663 
664 ObjectFileGetModuleSpecifications
665 PluginManager::GetObjectFileGetModuleSpecificationsCallbackAtIndex(
666     uint32_t idx) {
667   const auto &instances = GetObjectFileInstances().GetInstances();
668   if (idx < instances.size())
669     return instances[idx].get_module_specifications;
670   return nullptr;
671 }
672 
673 ObjectFileCreateMemoryInstance
674 PluginManager::GetObjectFileCreateMemoryCallbackForPluginName(
675     ConstString name) {
676   if (!name)
677     return nullptr;
678   const auto &instances = GetObjectFileInstances().GetInstances();
679   for (auto &instance : instances) {
680     if (instance.name == name)
681       return instance.create_memory_callback;
682   }
683   return nullptr;
684 }
685 
686 Status PluginManager::SaveCore(const lldb::ProcessSP &process_sp,
687                                const FileSpec &outfile) {
688   Status error;
689   auto &instances = GetObjectFileInstances().GetInstances();
690   for (auto &instance : instances) {
691     if (instance.save_core && instance.save_core(process_sp, outfile, error))
692       return error;
693   }
694   error.SetErrorString(
695       "no ObjectFile plugins were able to save a core for this process");
696   return error;
697 }
698 
699 #pragma mark ObjectContainer
700 
701 struct ObjectContainerInstance
702     : public PluginInstance<ObjectContainerCreateInstance> {
703   ObjectContainerInstance(
704       ConstString name, std::string description, CallbackType create_callback,
705       ObjectFileGetModuleSpecifications get_module_specifications)
706       : PluginInstance<ObjectContainerCreateInstance>(
707             name, std::move(description), create_callback),
708         get_module_specifications(get_module_specifications) {}
709 
710   ObjectFileGetModuleSpecifications get_module_specifications;
711 };
712 typedef PluginInstances<ObjectContainerInstance> ObjectContainerInstances;
713 
714 static ObjectContainerInstances &GetObjectContainerInstances() {
715   static ObjectContainerInstances g_instances;
716   return g_instances;
717 }
718 
719 bool PluginManager::RegisterPlugin(
720     ConstString name, const char *description,
721     ObjectContainerCreateInstance create_callback,
722     ObjectFileGetModuleSpecifications get_module_specifications) {
723   return GetObjectContainerInstances().RegisterPlugin(
724       name, description, create_callback, get_module_specifications);
725 }
726 
727 bool PluginManager::UnregisterPlugin(
728     ObjectContainerCreateInstance create_callback) {
729   return GetObjectContainerInstances().UnregisterPlugin(create_callback);
730 }
731 
732 ObjectContainerCreateInstance
733 PluginManager::GetObjectContainerCreateCallbackAtIndex(uint32_t idx) {
734   return GetObjectContainerInstances().GetCallbackAtIndex(idx);
735 }
736 
737 ObjectFileGetModuleSpecifications
738 PluginManager::GetObjectContainerGetModuleSpecificationsCallbackAtIndex(
739     uint32_t idx) {
740   const auto &instances = GetObjectContainerInstances().GetInstances();
741   if (idx < instances.size())
742     return instances[idx].get_module_specifications;
743   return nullptr;
744 }
745 
746 #pragma mark Platform
747 
748 typedef PluginInstance<PlatformCreateInstance> PlatformInstance;
749 typedef PluginInstances<PlatformInstance> PlatformInstances;
750 
751 static PlatformInstances &GetPlatformInstances() {
752   static PlatformInstances g_platform_instances;
753   return g_platform_instances;
754 }
755 
756 bool PluginManager::RegisterPlugin(
757     ConstString name, const char *description,
758     PlatformCreateInstance create_callback,
759     DebuggerInitializeCallback debugger_init_callback) {
760   return GetPlatformInstances().RegisterPlugin(
761       name, description, create_callback, debugger_init_callback);
762 }
763 
764 bool PluginManager::UnregisterPlugin(PlatformCreateInstance create_callback) {
765   return GetPlatformInstances().UnregisterPlugin(create_callback);
766 }
767 
768 const char *PluginManager::GetPlatformPluginNameAtIndex(uint32_t idx) {
769   return GetPlatformInstances().GetNameAtIndex(idx);
770 }
771 
772 const char *PluginManager::GetPlatformPluginDescriptionAtIndex(uint32_t idx) {
773   return GetPlatformInstances().GetDescriptionAtIndex(idx);
774 }
775 
776 PlatformCreateInstance
777 PluginManager::GetPlatformCreateCallbackAtIndex(uint32_t idx) {
778   return GetPlatformInstances().GetCallbackAtIndex(idx);
779 }
780 
781 PlatformCreateInstance
782 PluginManager::GetPlatformCreateCallbackForPluginName(ConstString name) {
783   return GetPlatformInstances().GetCallbackForName(name);
784 }
785 
786 void PluginManager::AutoCompletePlatformName(llvm::StringRef name,
787                                              CompletionRequest &request) {
788   for (const auto &instance : GetPlatformInstances().GetInstances()) {
789     if (instance.name.GetStringRef().startswith(name))
790       request.AddCompletion(instance.name.GetCString());
791   }
792 }
793 
794 #pragma mark Process
795 
796 typedef PluginInstance<ProcessCreateInstance> ProcessInstance;
797 typedef PluginInstances<ProcessInstance> ProcessInstances;
798 
799 static ProcessInstances &GetProcessInstances() {
800   static ProcessInstances g_instances;
801   return g_instances;
802 }
803 
804 bool PluginManager::RegisterPlugin(
805     ConstString name, const char *description,
806     ProcessCreateInstance create_callback,
807     DebuggerInitializeCallback debugger_init_callback) {
808   return GetProcessInstances().RegisterPlugin(
809       name, description, create_callback, debugger_init_callback);
810 }
811 
812 bool PluginManager::UnregisterPlugin(ProcessCreateInstance create_callback) {
813   return GetProcessInstances().UnregisterPlugin(create_callback);
814 }
815 
816 const char *PluginManager::GetProcessPluginNameAtIndex(uint32_t idx) {
817   return GetProcessInstances().GetNameAtIndex(idx);
818 }
819 
820 const char *PluginManager::GetProcessPluginDescriptionAtIndex(uint32_t idx) {
821   return GetProcessInstances().GetDescriptionAtIndex(idx);
822 }
823 
824 ProcessCreateInstance
825 PluginManager::GetProcessCreateCallbackAtIndex(uint32_t idx) {
826   return GetProcessInstances().GetCallbackAtIndex(idx);
827 }
828 
829 ProcessCreateInstance
830 PluginManager::GetProcessCreateCallbackForPluginName(ConstString name) {
831   return GetProcessInstances().GetCallbackForName(name);
832 }
833 
834 void PluginManager::AutoCompleteProcessName(llvm::StringRef name,
835                                             CompletionRequest &request) {
836   for (const auto &instance : GetProcessInstances().GetInstances()) {
837     if (instance.name.GetStringRef().startswith(name))
838       request.AddCompletion(instance.name.GetCString(), instance.description);
839   }
840 }
841 
842 #pragma mark ScriptInterpreter
843 
844 struct ScriptInterpreterInstance
845     : public PluginInstance<ScriptInterpreterCreateInstance> {
846   ScriptInterpreterInstance(ConstString name, std::string description,
847                             CallbackType create_callback,
848                             lldb::ScriptLanguage language)
849       : PluginInstance<ScriptInterpreterCreateInstance>(
850             name, std::move(description), create_callback),
851         language(language) {}
852 
853   lldb::ScriptLanguage language = lldb::eScriptLanguageNone;
854 };
855 
856 typedef PluginInstances<ScriptInterpreterInstance> ScriptInterpreterInstances;
857 
858 static ScriptInterpreterInstances &GetScriptInterpreterInstances() {
859   static ScriptInterpreterInstances g_instances;
860   return g_instances;
861 }
862 
863 bool PluginManager::RegisterPlugin(
864     ConstString name, const char *description,
865     lldb::ScriptLanguage script_language,
866     ScriptInterpreterCreateInstance create_callback) {
867   return GetScriptInterpreterInstances().RegisterPlugin(
868       name, description, create_callback, script_language);
869 }
870 
871 bool PluginManager::UnregisterPlugin(
872     ScriptInterpreterCreateInstance create_callback) {
873   return GetScriptInterpreterInstances().UnregisterPlugin(create_callback);
874 }
875 
876 ScriptInterpreterCreateInstance
877 PluginManager::GetScriptInterpreterCreateCallbackAtIndex(uint32_t idx) {
878   return GetScriptInterpreterInstances().GetCallbackAtIndex(idx);
879 }
880 
881 lldb::ScriptInterpreterSP
882 PluginManager::GetScriptInterpreterForLanguage(lldb::ScriptLanguage script_lang,
883                                                Debugger &debugger) {
884   const auto &instances = GetScriptInterpreterInstances().GetInstances();
885   ScriptInterpreterCreateInstance none_instance = nullptr;
886   for (const auto &instance : instances) {
887     if (instance.language == lldb::eScriptLanguageNone)
888       none_instance = instance.create_callback;
889 
890     if (script_lang == instance.language)
891       return instance.create_callback(debugger);
892   }
893 
894   // If we didn't find one, return the ScriptInterpreter for the null language.
895   assert(none_instance != nullptr);
896   return none_instance(debugger);
897 }
898 
899 #pragma mark StructuredDataPlugin
900 
901 struct StructuredDataPluginInstance
902     : public PluginInstance<StructuredDataPluginCreateInstance> {
903   StructuredDataPluginInstance(
904       ConstString name, std::string description, CallbackType create_callback,
905       DebuggerInitializeCallback debugger_init_callback,
906       StructuredDataFilterLaunchInfo filter_callback)
907       : PluginInstance<StructuredDataPluginCreateInstance>(
908             name, std::move(description), create_callback,
909             debugger_init_callback),
910         filter_callback(filter_callback) {}
911 
912   StructuredDataFilterLaunchInfo filter_callback = nullptr;
913 };
914 
915 typedef PluginInstances<StructuredDataPluginInstance>
916     StructuredDataPluginInstances;
917 
918 static StructuredDataPluginInstances &GetStructuredDataPluginInstances() {
919   static StructuredDataPluginInstances g_instances;
920   return g_instances;
921 }
922 
923 bool PluginManager::RegisterPlugin(
924     ConstString name, const char *description,
925     StructuredDataPluginCreateInstance create_callback,
926     DebuggerInitializeCallback debugger_init_callback,
927     StructuredDataFilterLaunchInfo filter_callback) {
928   return GetStructuredDataPluginInstances().RegisterPlugin(
929       name, description, create_callback, debugger_init_callback,
930       filter_callback);
931 }
932 
933 bool PluginManager::UnregisterPlugin(
934     StructuredDataPluginCreateInstance create_callback) {
935   return GetStructuredDataPluginInstances().UnregisterPlugin(create_callback);
936 }
937 
938 StructuredDataPluginCreateInstance
939 PluginManager::GetStructuredDataPluginCreateCallbackAtIndex(uint32_t idx) {
940   return GetStructuredDataPluginInstances().GetCallbackAtIndex(idx);
941 }
942 
943 StructuredDataFilterLaunchInfo
944 PluginManager::GetStructuredDataFilterCallbackAtIndex(
945     uint32_t idx, bool &iteration_complete) {
946   const auto &instances = GetStructuredDataPluginInstances().GetInstances();
947   if (idx < instances.size()) {
948     iteration_complete = false;
949     return instances[idx].filter_callback;
950   } else {
951     iteration_complete = true;
952   }
953   return nullptr;
954 }
955 
956 #pragma mark SymbolFile
957 
958 typedef PluginInstance<SymbolFileCreateInstance> SymbolFileInstance;
959 typedef PluginInstances<SymbolFileInstance> SymbolFileInstances;
960 
961 static SymbolFileInstances &GetSymbolFileInstances() {
962   static SymbolFileInstances g_instances;
963   return g_instances;
964 }
965 
966 bool PluginManager::RegisterPlugin(
967     ConstString name, const char *description,
968     SymbolFileCreateInstance create_callback,
969     DebuggerInitializeCallback debugger_init_callback) {
970   return GetSymbolFileInstances().RegisterPlugin(
971       name, description, create_callback, debugger_init_callback);
972 }
973 
974 bool PluginManager::UnregisterPlugin(SymbolFileCreateInstance create_callback) {
975   return GetSymbolFileInstances().UnregisterPlugin(create_callback);
976 }
977 
978 SymbolFileCreateInstance
979 PluginManager::GetSymbolFileCreateCallbackAtIndex(uint32_t idx) {
980   return GetSymbolFileInstances().GetCallbackAtIndex(idx);
981 }
982 
983 #pragma mark SymbolVendor
984 
985 typedef PluginInstance<SymbolVendorCreateInstance> SymbolVendorInstance;
986 typedef PluginInstances<SymbolVendorInstance> SymbolVendorInstances;
987 
988 static SymbolVendorInstances &GetSymbolVendorInstances() {
989   static SymbolVendorInstances g_instances;
990   return g_instances;
991 }
992 
993 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
994                                    SymbolVendorCreateInstance create_callback) {
995   return GetSymbolVendorInstances().RegisterPlugin(name, description,
996                                                    create_callback);
997 }
998 
999 bool PluginManager::UnregisterPlugin(
1000     SymbolVendorCreateInstance create_callback) {
1001   return GetSymbolVendorInstances().UnregisterPlugin(create_callback);
1002 }
1003 
1004 SymbolVendorCreateInstance
1005 PluginManager::GetSymbolVendorCreateCallbackAtIndex(uint32_t idx) {
1006   return GetSymbolVendorInstances().GetCallbackAtIndex(idx);
1007 }
1008 
1009 #pragma mark Trace
1010 
1011 struct TraceInstance : public PluginInstance<TraceCreateInstance> {
1012   TraceInstance(ConstString name, std::string description,
1013                 CallbackType create_callback, llvm::StringRef schema)
1014       : PluginInstance<TraceCreateInstance>(name, std::move(description),
1015                                             create_callback),
1016         schema(schema) {}
1017 
1018   llvm::StringRef schema;
1019 };
1020 
1021 typedef PluginInstances<TraceInstance> TraceInstances;
1022 
1023 static TraceInstances &GetTraceInstances() {
1024   static TraceInstances g_instances;
1025   return g_instances;
1026 }
1027 
1028 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
1029                                    TraceCreateInstance create_callback,
1030                                    llvm::StringRef schema) {
1031   return GetTraceInstances().RegisterPlugin(name, description, create_callback,
1032                                             schema);
1033 }
1034 
1035 bool PluginManager::UnregisterPlugin(TraceCreateInstance create_callback) {
1036   return GetTraceInstances().UnregisterPlugin(create_callback);
1037 }
1038 
1039 TraceCreateInstance
1040 PluginManager::GetTraceCreateCallback(ConstString plugin_name) {
1041   return GetTraceInstances().GetCallbackForName(plugin_name);
1042 }
1043 
1044 llvm::StringRef PluginManager::GetTraceSchema(ConstString plugin_name) {
1045   for (const TraceInstance &instance : GetTraceInstances().GetInstances())
1046     if (instance.name == plugin_name)
1047       return instance.schema;
1048   return llvm::StringRef();
1049 }
1050 
1051 llvm::StringRef PluginManager::GetTraceSchema(size_t index) {
1052   if (TraceInstance *instance = GetTraceInstances().GetInstanceAtIndex(index))
1053     return instance->schema;
1054   return llvm::StringRef();
1055 }
1056 
1057 #pragma mark UnwindAssembly
1058 
1059 typedef PluginInstance<UnwindAssemblyCreateInstance> UnwindAssemblyInstance;
1060 typedef PluginInstances<UnwindAssemblyInstance> UnwindAssemblyInstances;
1061 
1062 static UnwindAssemblyInstances &GetUnwindAssemblyInstances() {
1063   static UnwindAssemblyInstances g_instances;
1064   return g_instances;
1065 }
1066 
1067 bool PluginManager::RegisterPlugin(
1068     ConstString name, const char *description,
1069     UnwindAssemblyCreateInstance create_callback) {
1070   return GetUnwindAssemblyInstances().RegisterPlugin(name, description,
1071                                                      create_callback);
1072 }
1073 
1074 bool PluginManager::UnregisterPlugin(
1075     UnwindAssemblyCreateInstance create_callback) {
1076   return GetUnwindAssemblyInstances().UnregisterPlugin(create_callback);
1077 }
1078 
1079 UnwindAssemblyCreateInstance
1080 PluginManager::GetUnwindAssemblyCreateCallbackAtIndex(uint32_t idx) {
1081   return GetUnwindAssemblyInstances().GetCallbackAtIndex(idx);
1082 }
1083 
1084 #pragma mark MemoryHistory
1085 
1086 typedef PluginInstance<MemoryHistoryCreateInstance> MemoryHistoryInstance;
1087 typedef PluginInstances<MemoryHistoryInstance> MemoryHistoryInstances;
1088 
1089 static MemoryHistoryInstances &GetMemoryHistoryInstances() {
1090   static MemoryHistoryInstances g_instances;
1091   return g_instances;
1092 }
1093 
1094 bool PluginManager::RegisterPlugin(
1095     ConstString name, const char *description,
1096     MemoryHistoryCreateInstance create_callback) {
1097   return GetMemoryHistoryInstances().RegisterPlugin(name, description,
1098                                                     create_callback);
1099 }
1100 
1101 bool PluginManager::UnregisterPlugin(
1102     MemoryHistoryCreateInstance create_callback) {
1103   return GetMemoryHistoryInstances().UnregisterPlugin(create_callback);
1104 }
1105 
1106 MemoryHistoryCreateInstance
1107 PluginManager::GetMemoryHistoryCreateCallbackAtIndex(uint32_t idx) {
1108   return GetMemoryHistoryInstances().GetCallbackAtIndex(idx);
1109 }
1110 
1111 #pragma mark InstrumentationRuntime
1112 
1113 struct InstrumentationRuntimeInstance
1114     : public PluginInstance<InstrumentationRuntimeCreateInstance> {
1115   InstrumentationRuntimeInstance(
1116       ConstString name, std::string description, CallbackType create_callback,
1117       InstrumentationRuntimeGetType get_type_callback)
1118       : PluginInstance<InstrumentationRuntimeCreateInstance>(
1119             name, std::move(description), create_callback),
1120         get_type_callback(get_type_callback) {}
1121 
1122   InstrumentationRuntimeGetType get_type_callback = nullptr;
1123 };
1124 
1125 typedef PluginInstances<InstrumentationRuntimeInstance>
1126     InstrumentationRuntimeInstances;
1127 
1128 static InstrumentationRuntimeInstances &GetInstrumentationRuntimeInstances() {
1129   static InstrumentationRuntimeInstances g_instances;
1130   return g_instances;
1131 }
1132 
1133 bool PluginManager::RegisterPlugin(
1134     ConstString name, const char *description,
1135     InstrumentationRuntimeCreateInstance create_callback,
1136     InstrumentationRuntimeGetType get_type_callback) {
1137   return GetInstrumentationRuntimeInstances().RegisterPlugin(
1138       name, description, create_callback, get_type_callback);
1139 }
1140 
1141 bool PluginManager::UnregisterPlugin(
1142     InstrumentationRuntimeCreateInstance create_callback) {
1143   return GetInstrumentationRuntimeInstances().UnregisterPlugin(create_callback);
1144 }
1145 
1146 InstrumentationRuntimeGetType
1147 PluginManager::GetInstrumentationRuntimeGetTypeCallbackAtIndex(uint32_t idx) {
1148   const auto &instances = GetInstrumentationRuntimeInstances().GetInstances();
1149   if (idx < instances.size())
1150     return instances[idx].get_type_callback;
1151   return nullptr;
1152 }
1153 
1154 InstrumentationRuntimeCreateInstance
1155 PluginManager::GetInstrumentationRuntimeCreateCallbackAtIndex(uint32_t idx) {
1156   return GetInstrumentationRuntimeInstances().GetCallbackAtIndex(idx);
1157 }
1158 
1159 #pragma mark TypeSystem
1160 
1161 struct TypeSystemInstance : public PluginInstance<TypeSystemCreateInstance> {
1162   TypeSystemInstance(ConstString name, std::string description,
1163                      CallbackType create_callback,
1164                      LanguageSet supported_languages_for_types,
1165                      LanguageSet supported_languages_for_expressions)
1166       : PluginInstance<TypeSystemCreateInstance>(name, std::move(description),
1167                                                  create_callback),
1168         supported_languages_for_types(supported_languages_for_types),
1169         supported_languages_for_expressions(
1170             supported_languages_for_expressions) {}
1171 
1172   LanguageSet supported_languages_for_types;
1173   LanguageSet supported_languages_for_expressions;
1174 };
1175 
1176 typedef PluginInstances<TypeSystemInstance> TypeSystemInstances;
1177 
1178 static TypeSystemInstances &GetTypeSystemInstances() {
1179   static TypeSystemInstances g_instances;
1180   return g_instances;
1181 }
1182 
1183 bool PluginManager::RegisterPlugin(
1184     ConstString name, const char *description,
1185     TypeSystemCreateInstance create_callback,
1186     LanguageSet supported_languages_for_types,
1187     LanguageSet supported_languages_for_expressions) {
1188   return GetTypeSystemInstances().RegisterPlugin(
1189       name, description, create_callback, supported_languages_for_types,
1190       supported_languages_for_expressions);
1191 }
1192 
1193 bool PluginManager::UnregisterPlugin(TypeSystemCreateInstance create_callback) {
1194   return GetTypeSystemInstances().UnregisterPlugin(create_callback);
1195 }
1196 
1197 TypeSystemCreateInstance
1198 PluginManager::GetTypeSystemCreateCallbackAtIndex(uint32_t idx) {
1199   return GetTypeSystemInstances().GetCallbackAtIndex(idx);
1200 }
1201 
1202 LanguageSet PluginManager::GetAllTypeSystemSupportedLanguagesForTypes() {
1203   const auto &instances = GetTypeSystemInstances().GetInstances();
1204   LanguageSet all;
1205   for (unsigned i = 0; i < instances.size(); ++i)
1206     all.bitvector |= instances[i].supported_languages_for_types.bitvector;
1207   return all;
1208 }
1209 
1210 LanguageSet PluginManager::GetAllTypeSystemSupportedLanguagesForExpressions() {
1211   const auto &instances = GetTypeSystemInstances().GetInstances();
1212   LanguageSet all;
1213   for (unsigned i = 0; i < instances.size(); ++i)
1214     all.bitvector |= instances[i].supported_languages_for_expressions.bitvector;
1215   return all;
1216 }
1217 
1218 #pragma mark REPL
1219 
1220 struct REPLInstance : public PluginInstance<REPLCreateInstance> {
1221   REPLInstance(ConstString name, std::string description,
1222                CallbackType create_callback, LanguageSet supported_languages)
1223       : PluginInstance<REPLCreateInstance>(name, std::move(description),
1224                                            create_callback),
1225         supported_languages(supported_languages) {}
1226 
1227   LanguageSet supported_languages;
1228 };
1229 
1230 typedef PluginInstances<REPLInstance> REPLInstances;
1231 
1232 static REPLInstances &GetREPLInstances() {
1233   static REPLInstances g_instances;
1234   return g_instances;
1235 }
1236 
1237 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
1238                                    REPLCreateInstance create_callback,
1239                                    LanguageSet supported_languages) {
1240   return GetREPLInstances().RegisterPlugin(name, description, create_callback,
1241                                            supported_languages);
1242 }
1243 
1244 bool PluginManager::UnregisterPlugin(REPLCreateInstance create_callback) {
1245   return GetREPLInstances().UnregisterPlugin(create_callback);
1246 }
1247 
1248 REPLCreateInstance PluginManager::GetREPLCreateCallbackAtIndex(uint32_t idx) {
1249   return GetREPLInstances().GetCallbackAtIndex(idx);
1250 }
1251 
1252 LanguageSet PluginManager::GetREPLAllTypeSystemSupportedLanguages() {
1253   const auto &instances = GetREPLInstances().GetInstances();
1254   LanguageSet all;
1255   for (unsigned i = 0; i < instances.size(); ++i)
1256     all.bitvector |= instances[i].supported_languages.bitvector;
1257   return all;
1258 }
1259 
1260 #pragma mark PluginManager
1261 
1262 void PluginManager::DebuggerInitialize(Debugger &debugger) {
1263   GetDynamicLoaderInstances().PerformDebuggerCallback(debugger);
1264   GetJITLoaderInstances().PerformDebuggerCallback(debugger);
1265   GetPlatformInstances().PerformDebuggerCallback(debugger);
1266   GetProcessInstances().PerformDebuggerCallback(debugger);
1267   GetSymbolFileInstances().PerformDebuggerCallback(debugger);
1268   GetOperatingSystemInstances().PerformDebuggerCallback(debugger);
1269   GetStructuredDataPluginInstances().PerformDebuggerCallback(debugger);
1270 }
1271 
1272 // This is the preferred new way to register plugin specific settings.  e.g.
1273 // This will put a plugin's settings under e.g.
1274 // "plugin.<plugin_type_name>.<plugin_type_desc>.SETTINGNAME".
1275 static lldb::OptionValuePropertiesSP
1276 GetDebuggerPropertyForPlugins(Debugger &debugger, ConstString plugin_type_name,
1277                               ConstString plugin_type_desc, bool can_create) {
1278   lldb::OptionValuePropertiesSP parent_properties_sp(
1279       debugger.GetValueProperties());
1280   if (parent_properties_sp) {
1281     static ConstString g_property_name("plugin");
1282 
1283     OptionValuePropertiesSP plugin_properties_sp =
1284         parent_properties_sp->GetSubProperty(nullptr, g_property_name);
1285     if (!plugin_properties_sp && can_create) {
1286       plugin_properties_sp =
1287           std::make_shared<OptionValueProperties>(g_property_name);
1288       parent_properties_sp->AppendProperty(
1289           g_property_name, ConstString("Settings specify to plugins."), true,
1290           plugin_properties_sp);
1291     }
1292 
1293     if (plugin_properties_sp) {
1294       lldb::OptionValuePropertiesSP plugin_type_properties_sp =
1295           plugin_properties_sp->GetSubProperty(nullptr, plugin_type_name);
1296       if (!plugin_type_properties_sp && can_create) {
1297         plugin_type_properties_sp =
1298             std::make_shared<OptionValueProperties>(plugin_type_name);
1299         plugin_properties_sp->AppendProperty(plugin_type_name, plugin_type_desc,
1300                                              true, plugin_type_properties_sp);
1301       }
1302       return plugin_type_properties_sp;
1303     }
1304   }
1305   return lldb::OptionValuePropertiesSP();
1306 }
1307 
1308 // This is deprecated way to register plugin specific settings.  e.g.
1309 // "<plugin_type_name>.plugin.<plugin_type_desc>.SETTINGNAME" and Platform
1310 // generic settings would be under "platform.SETTINGNAME".
1311 static lldb::OptionValuePropertiesSP GetDebuggerPropertyForPluginsOldStyle(
1312     Debugger &debugger, ConstString plugin_type_name,
1313     ConstString plugin_type_desc, bool can_create) {
1314   static ConstString g_property_name("plugin");
1315   lldb::OptionValuePropertiesSP parent_properties_sp(
1316       debugger.GetValueProperties());
1317   if (parent_properties_sp) {
1318     OptionValuePropertiesSP plugin_properties_sp =
1319         parent_properties_sp->GetSubProperty(nullptr, plugin_type_name);
1320     if (!plugin_properties_sp && can_create) {
1321       plugin_properties_sp =
1322           std::make_shared<OptionValueProperties>(plugin_type_name);
1323       parent_properties_sp->AppendProperty(plugin_type_name, plugin_type_desc,
1324                                            true, plugin_properties_sp);
1325     }
1326 
1327     if (plugin_properties_sp) {
1328       lldb::OptionValuePropertiesSP plugin_type_properties_sp =
1329           plugin_properties_sp->GetSubProperty(nullptr, g_property_name);
1330       if (!plugin_type_properties_sp && can_create) {
1331         plugin_type_properties_sp =
1332             std::make_shared<OptionValueProperties>(g_property_name);
1333         plugin_properties_sp->AppendProperty(
1334             g_property_name, ConstString("Settings specific to plugins"), true,
1335             plugin_type_properties_sp);
1336       }
1337       return plugin_type_properties_sp;
1338     }
1339   }
1340   return lldb::OptionValuePropertiesSP();
1341 }
1342 
1343 namespace {
1344 
1345 typedef lldb::OptionValuePropertiesSP
1346 GetDebuggerPropertyForPluginsPtr(Debugger &, ConstString, ConstString,
1347                                  bool can_create);
1348 
1349 lldb::OptionValuePropertiesSP
1350 GetSettingForPlugin(Debugger &debugger, ConstString setting_name,
1351                     ConstString plugin_type_name,
1352                     GetDebuggerPropertyForPluginsPtr get_debugger_property =
1353                         GetDebuggerPropertyForPlugins) {
1354   lldb::OptionValuePropertiesSP properties_sp;
1355   lldb::OptionValuePropertiesSP plugin_type_properties_sp(get_debugger_property(
1356       debugger, plugin_type_name,
1357       ConstString(), // not creating to so we don't need the description
1358       false));
1359   if (plugin_type_properties_sp)
1360     properties_sp =
1361         plugin_type_properties_sp->GetSubProperty(nullptr, setting_name);
1362   return properties_sp;
1363 }
1364 
1365 bool CreateSettingForPlugin(
1366     Debugger &debugger, ConstString plugin_type_name,
1367     ConstString plugin_type_desc,
1368     const lldb::OptionValuePropertiesSP &properties_sp, ConstString description,
1369     bool is_global_property,
1370     GetDebuggerPropertyForPluginsPtr get_debugger_property =
1371         GetDebuggerPropertyForPlugins) {
1372   if (properties_sp) {
1373     lldb::OptionValuePropertiesSP plugin_type_properties_sp(
1374         get_debugger_property(debugger, plugin_type_name, plugin_type_desc,
1375                               true));
1376     if (plugin_type_properties_sp) {
1377       plugin_type_properties_sp->AppendProperty(properties_sp->GetName(),
1378                                                 description, is_global_property,
1379                                                 properties_sp);
1380       return true;
1381     }
1382   }
1383   return false;
1384 }
1385 
1386 const char *kDynamicLoaderPluginName("dynamic-loader");
1387 const char *kPlatformPluginName("platform");
1388 const char *kProcessPluginName("process");
1389 const char *kSymbolFilePluginName("symbol-file");
1390 const char *kJITLoaderPluginName("jit-loader");
1391 const char *kStructuredDataPluginName("structured-data");
1392 
1393 } // anonymous namespace
1394 
1395 lldb::OptionValuePropertiesSP
1396 PluginManager::GetSettingForDynamicLoaderPlugin(Debugger &debugger,
1397                                                 ConstString setting_name) {
1398   return GetSettingForPlugin(debugger, setting_name,
1399                              ConstString(kDynamicLoaderPluginName));
1400 }
1401 
1402 bool PluginManager::CreateSettingForDynamicLoaderPlugin(
1403     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1404     ConstString description, bool is_global_property) {
1405   return CreateSettingForPlugin(
1406       debugger, ConstString(kDynamicLoaderPluginName),
1407       ConstString("Settings for dynamic loader plug-ins"), properties_sp,
1408       description, is_global_property);
1409 }
1410 
1411 lldb::OptionValuePropertiesSP
1412 PluginManager::GetSettingForPlatformPlugin(Debugger &debugger,
1413                                            ConstString setting_name) {
1414   return GetSettingForPlugin(debugger, setting_name,
1415                              ConstString(kPlatformPluginName),
1416                              GetDebuggerPropertyForPluginsOldStyle);
1417 }
1418 
1419 bool PluginManager::CreateSettingForPlatformPlugin(
1420     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1421     ConstString description, bool is_global_property) {
1422   return CreateSettingForPlugin(debugger, ConstString(kPlatformPluginName),
1423                                 ConstString("Settings for platform plug-ins"),
1424                                 properties_sp, description, is_global_property,
1425                                 GetDebuggerPropertyForPluginsOldStyle);
1426 }
1427 
1428 lldb::OptionValuePropertiesSP
1429 PluginManager::GetSettingForProcessPlugin(Debugger &debugger,
1430                                           ConstString setting_name) {
1431   return GetSettingForPlugin(debugger, setting_name,
1432                              ConstString(kProcessPluginName));
1433 }
1434 
1435 bool PluginManager::CreateSettingForProcessPlugin(
1436     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1437     ConstString description, bool is_global_property) {
1438   return CreateSettingForPlugin(debugger, ConstString(kProcessPluginName),
1439                                 ConstString("Settings for process plug-ins"),
1440                                 properties_sp, description, is_global_property);
1441 }
1442 
1443 lldb::OptionValuePropertiesSP
1444 PluginManager::GetSettingForSymbolFilePlugin(Debugger &debugger,
1445                                              ConstString setting_name) {
1446   return GetSettingForPlugin(debugger, setting_name,
1447                              ConstString(kSymbolFilePluginName));
1448 }
1449 
1450 bool PluginManager::CreateSettingForSymbolFilePlugin(
1451     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1452     ConstString description, bool is_global_property) {
1453   return CreateSettingForPlugin(
1454       debugger, ConstString(kSymbolFilePluginName),
1455       ConstString("Settings for symbol file plug-ins"), properties_sp,
1456       description, is_global_property);
1457 }
1458 
1459 lldb::OptionValuePropertiesSP
1460 PluginManager::GetSettingForJITLoaderPlugin(Debugger &debugger,
1461                                             ConstString setting_name) {
1462   return GetSettingForPlugin(debugger, setting_name,
1463                              ConstString(kJITLoaderPluginName));
1464 }
1465 
1466 bool PluginManager::CreateSettingForJITLoaderPlugin(
1467     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1468     ConstString description, bool is_global_property) {
1469   return CreateSettingForPlugin(debugger, ConstString(kJITLoaderPluginName),
1470                                 ConstString("Settings for JIT loader plug-ins"),
1471                                 properties_sp, description, is_global_property);
1472 }
1473 
1474 static const char *kOperatingSystemPluginName("os");
1475 
1476 lldb::OptionValuePropertiesSP
1477 PluginManager::GetSettingForOperatingSystemPlugin(Debugger &debugger,
1478                                                   ConstString setting_name) {
1479   lldb::OptionValuePropertiesSP properties_sp;
1480   lldb::OptionValuePropertiesSP plugin_type_properties_sp(
1481       GetDebuggerPropertyForPlugins(
1482           debugger, ConstString(kOperatingSystemPluginName),
1483           ConstString(), // not creating to so we don't need the description
1484           false));
1485   if (plugin_type_properties_sp)
1486     properties_sp =
1487         plugin_type_properties_sp->GetSubProperty(nullptr, setting_name);
1488   return properties_sp;
1489 }
1490 
1491 bool PluginManager::CreateSettingForOperatingSystemPlugin(
1492     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1493     ConstString description, bool is_global_property) {
1494   if (properties_sp) {
1495     lldb::OptionValuePropertiesSP plugin_type_properties_sp(
1496         GetDebuggerPropertyForPlugins(
1497             debugger, ConstString(kOperatingSystemPluginName),
1498             ConstString("Settings for operating system plug-ins"), true));
1499     if (plugin_type_properties_sp) {
1500       plugin_type_properties_sp->AppendProperty(properties_sp->GetName(),
1501                                                 description, is_global_property,
1502                                                 properties_sp);
1503       return true;
1504     }
1505   }
1506   return false;
1507 }
1508 
1509 lldb::OptionValuePropertiesSP
1510 PluginManager::GetSettingForStructuredDataPlugin(Debugger &debugger,
1511                                                  ConstString setting_name) {
1512   return GetSettingForPlugin(debugger, setting_name,
1513                              ConstString(kStructuredDataPluginName));
1514 }
1515 
1516 bool PluginManager::CreateSettingForStructuredDataPlugin(
1517     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1518     ConstString description, bool is_global_property) {
1519   return CreateSettingForPlugin(
1520       debugger, ConstString(kStructuredDataPluginName),
1521       ConstString("Settings for structured data plug-ins"), properties_sp,
1522       description, is_global_property);
1523 }
1524