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 private:
268   Instance *GetInstanceAtIndex(uint32_t idx) {
269     if (idx < m_instances.size())
270       return &m_instances[idx];
271     return nullptr;
272   }
273   std::vector<Instance> m_instances;
274 };
275 
276 #pragma mark ABI
277 
278 typedef PluginInstance<ABICreateInstance> ABIInstance;
279 typedef PluginInstances<ABIInstance> ABIInstances;
280 
281 static ABIInstances &GetABIInstances() {
282   static ABIInstances g_instances;
283   return g_instances;
284 }
285 
286 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
287                                    ABICreateInstance create_callback) {
288   return GetABIInstances().RegisterPlugin(name, description, create_callback);
289 }
290 
291 bool PluginManager::UnregisterPlugin(ABICreateInstance create_callback) {
292   return GetABIInstances().UnregisterPlugin(create_callback);
293 }
294 
295 ABICreateInstance PluginManager::GetABICreateCallbackAtIndex(uint32_t idx) {
296   return GetABIInstances().GetCallbackAtIndex(idx);
297 }
298 
299 #pragma mark Architecture
300 
301 typedef PluginInstance<ArchitectureCreateInstance> ArchitectureInstance;
302 typedef std::vector<ArchitectureInstance> ArchitectureInstances;
303 
304 static ArchitectureInstances &GetArchitectureInstances() {
305   static ArchitectureInstances g_instances;
306   return g_instances;
307 }
308 
309 void PluginManager::RegisterPlugin(ConstString name,
310                                    llvm::StringRef description,
311                                    ArchitectureCreateInstance create_callback) {
312   GetArchitectureInstances().push_back(
313       {name, std::string(description), create_callback});
314 }
315 
316 void PluginManager::UnregisterPlugin(
317     ArchitectureCreateInstance create_callback) {
318   auto &instances = GetArchitectureInstances();
319 
320   for (auto pos = instances.begin(), end = instances.end(); pos != end; ++pos) {
321     if (pos->create_callback == create_callback) {
322       instances.erase(pos);
323       return;
324     }
325   }
326   llvm_unreachable("Plugin not found");
327 }
328 
329 std::unique_ptr<Architecture>
330 PluginManager::CreateArchitectureInstance(const ArchSpec &arch) {
331   for (const auto &instances : GetArchitectureInstances()) {
332     if (auto plugin_up = instances.create_callback(arch))
333       return plugin_up;
334   }
335   return nullptr;
336 }
337 
338 #pragma mark Disassembler
339 
340 typedef PluginInstance<DisassemblerCreateInstance> DisassemblerInstance;
341 typedef PluginInstances<DisassemblerInstance> DisassemblerInstances;
342 
343 static DisassemblerInstances &GetDisassemblerInstances() {
344   static DisassemblerInstances g_instances;
345   return g_instances;
346 }
347 
348 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
349                                    DisassemblerCreateInstance create_callback) {
350   return GetDisassemblerInstances().RegisterPlugin(name, description,
351                                                    create_callback);
352 }
353 
354 bool PluginManager::UnregisterPlugin(
355     DisassemblerCreateInstance create_callback) {
356   return GetDisassemblerInstances().UnregisterPlugin(create_callback);
357 }
358 
359 DisassemblerCreateInstance
360 PluginManager::GetDisassemblerCreateCallbackAtIndex(uint32_t idx) {
361   return GetDisassemblerInstances().GetCallbackAtIndex(idx);
362 }
363 
364 DisassemblerCreateInstance
365 PluginManager::GetDisassemblerCreateCallbackForPluginName(ConstString name) {
366   return GetDisassemblerInstances().GetCallbackForName(name);
367 }
368 
369 #pragma mark DynamicLoader
370 
371 typedef PluginInstance<DynamicLoaderCreateInstance> DynamicLoaderInstance;
372 typedef PluginInstances<DynamicLoaderInstance> DynamicLoaderInstances;
373 
374 static DynamicLoaderInstances &GetDynamicLoaderInstances() {
375   static DynamicLoaderInstances g_instances;
376   return g_instances;
377 }
378 
379 bool PluginManager::RegisterPlugin(
380     ConstString name, const char *description,
381     DynamicLoaderCreateInstance create_callback,
382     DebuggerInitializeCallback debugger_init_callback) {
383   return GetDynamicLoaderInstances().RegisterPlugin(
384       name, description, create_callback, debugger_init_callback);
385 }
386 
387 bool PluginManager::UnregisterPlugin(
388     DynamicLoaderCreateInstance create_callback) {
389   return GetDynamicLoaderInstances().UnregisterPlugin(create_callback);
390 }
391 
392 DynamicLoaderCreateInstance
393 PluginManager::GetDynamicLoaderCreateCallbackAtIndex(uint32_t idx) {
394   return GetDynamicLoaderInstances().GetCallbackAtIndex(idx);
395 }
396 
397 DynamicLoaderCreateInstance
398 PluginManager::GetDynamicLoaderCreateCallbackForPluginName(ConstString name) {
399   return GetDynamicLoaderInstances().GetCallbackForName(name);
400 }
401 
402 #pragma mark JITLoader
403 
404 typedef PluginInstance<JITLoaderCreateInstance> JITLoaderInstance;
405 typedef PluginInstances<JITLoaderInstance> JITLoaderInstances;
406 
407 static JITLoaderInstances &GetJITLoaderInstances() {
408   static JITLoaderInstances g_instances;
409   return g_instances;
410 }
411 
412 bool PluginManager::RegisterPlugin(
413     ConstString name, const char *description,
414     JITLoaderCreateInstance create_callback,
415     DebuggerInitializeCallback debugger_init_callback) {
416   return GetJITLoaderInstances().RegisterPlugin(
417       name, description, create_callback, debugger_init_callback);
418 }
419 
420 bool PluginManager::UnregisterPlugin(JITLoaderCreateInstance create_callback) {
421   return GetJITLoaderInstances().UnregisterPlugin(create_callback);
422 }
423 
424 JITLoaderCreateInstance
425 PluginManager::GetJITLoaderCreateCallbackAtIndex(uint32_t idx) {
426   return GetJITLoaderInstances().GetCallbackAtIndex(idx);
427 }
428 
429 #pragma mark EmulateInstruction
430 
431 typedef PluginInstance<EmulateInstructionCreateInstance>
432     EmulateInstructionInstance;
433 typedef PluginInstances<EmulateInstructionInstance> EmulateInstructionInstances;
434 
435 static EmulateInstructionInstances &GetEmulateInstructionInstances() {
436   static EmulateInstructionInstances g_instances;
437   return g_instances;
438 }
439 
440 bool PluginManager::RegisterPlugin(
441     ConstString name, const char *description,
442     EmulateInstructionCreateInstance create_callback) {
443   return GetEmulateInstructionInstances().RegisterPlugin(name, description,
444                                                          create_callback);
445 }
446 
447 bool PluginManager::UnregisterPlugin(
448     EmulateInstructionCreateInstance create_callback) {
449   return GetEmulateInstructionInstances().UnregisterPlugin(create_callback);
450 }
451 
452 EmulateInstructionCreateInstance
453 PluginManager::GetEmulateInstructionCreateCallbackAtIndex(uint32_t idx) {
454   return GetEmulateInstructionInstances().GetCallbackAtIndex(idx);
455 }
456 
457 EmulateInstructionCreateInstance
458 PluginManager::GetEmulateInstructionCreateCallbackForPluginName(
459     ConstString name) {
460   return GetEmulateInstructionInstances().GetCallbackForName(name);
461 }
462 
463 #pragma mark OperatingSystem
464 
465 typedef PluginInstance<OperatingSystemCreateInstance> OperatingSystemInstance;
466 typedef PluginInstances<OperatingSystemInstance> OperatingSystemInstances;
467 
468 static OperatingSystemInstances &GetOperatingSystemInstances() {
469   static OperatingSystemInstances g_instances;
470   return g_instances;
471 }
472 
473 bool PluginManager::RegisterPlugin(
474     ConstString name, const char *description,
475     OperatingSystemCreateInstance create_callback,
476     DebuggerInitializeCallback debugger_init_callback) {
477   return GetOperatingSystemInstances().RegisterPlugin(
478       name, description, create_callback, debugger_init_callback);
479 }
480 
481 bool PluginManager::UnregisterPlugin(
482     OperatingSystemCreateInstance create_callback) {
483   return GetOperatingSystemInstances().UnregisterPlugin(create_callback);
484 }
485 
486 OperatingSystemCreateInstance
487 PluginManager::GetOperatingSystemCreateCallbackAtIndex(uint32_t idx) {
488   return GetOperatingSystemInstances().GetCallbackAtIndex(idx);
489 }
490 
491 OperatingSystemCreateInstance
492 PluginManager::GetOperatingSystemCreateCallbackForPluginName(ConstString name) {
493   return GetOperatingSystemInstances().GetCallbackForName(name);
494 }
495 
496 #pragma mark Language
497 
498 typedef PluginInstance<LanguageCreateInstance> LanguageInstance;
499 typedef PluginInstances<LanguageInstance> LanguageInstances;
500 
501 static LanguageInstances &GetLanguageInstances() {
502   static LanguageInstances g_instances;
503   return g_instances;
504 }
505 
506 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
507                                    LanguageCreateInstance create_callback) {
508   return GetLanguageInstances().RegisterPlugin(name, description,
509                                                create_callback);
510 }
511 
512 bool PluginManager::UnregisterPlugin(LanguageCreateInstance create_callback) {
513   return GetLanguageInstances().UnregisterPlugin(create_callback);
514 }
515 
516 LanguageCreateInstance
517 PluginManager::GetLanguageCreateCallbackAtIndex(uint32_t idx) {
518   return GetLanguageInstances().GetCallbackAtIndex(idx);
519 }
520 
521 #pragma mark LanguageRuntime
522 
523 struct LanguageRuntimeInstance
524     : public PluginInstance<LanguageRuntimeCreateInstance> {
525   LanguageRuntimeInstance(
526       ConstString name, std::string description, CallbackType create_callback,
527       DebuggerInitializeCallback debugger_init_callback,
528       LanguageRuntimeGetCommandObject command_callback,
529       LanguageRuntimeGetExceptionPrecondition precondition_callback)
530       : PluginInstance<LanguageRuntimeCreateInstance>(
531             name, std::move(description), create_callback,
532             debugger_init_callback),
533         command_callback(command_callback),
534         precondition_callback(precondition_callback) {}
535 
536   LanguageRuntimeGetCommandObject command_callback;
537   LanguageRuntimeGetExceptionPrecondition precondition_callback;
538 };
539 
540 typedef PluginInstances<LanguageRuntimeInstance> LanguageRuntimeInstances;
541 
542 static LanguageRuntimeInstances &GetLanguageRuntimeInstances() {
543   static LanguageRuntimeInstances g_instances;
544   return g_instances;
545 }
546 
547 bool PluginManager::RegisterPlugin(
548     ConstString name, const char *description,
549     LanguageRuntimeCreateInstance create_callback,
550     LanguageRuntimeGetCommandObject command_callback,
551     LanguageRuntimeGetExceptionPrecondition precondition_callback) {
552   return GetLanguageRuntimeInstances().RegisterPlugin(
553       name, description, create_callback, nullptr, command_callback,
554       precondition_callback);
555 }
556 
557 bool PluginManager::UnregisterPlugin(
558     LanguageRuntimeCreateInstance create_callback) {
559   return GetLanguageRuntimeInstances().UnregisterPlugin(create_callback);
560 }
561 
562 LanguageRuntimeCreateInstance
563 PluginManager::GetLanguageRuntimeCreateCallbackAtIndex(uint32_t idx) {
564   return GetLanguageRuntimeInstances().GetCallbackAtIndex(idx);
565 }
566 
567 LanguageRuntimeGetCommandObject
568 PluginManager::GetLanguageRuntimeGetCommandObjectAtIndex(uint32_t idx) {
569   const auto &instances = GetLanguageRuntimeInstances().GetInstances();
570   if (idx < instances.size())
571     return instances[idx].command_callback;
572   return nullptr;
573 }
574 
575 LanguageRuntimeGetExceptionPrecondition
576 PluginManager::GetLanguageRuntimeGetExceptionPreconditionAtIndex(uint32_t idx) {
577   const auto &instances = GetLanguageRuntimeInstances().GetInstances();
578   if (idx < instances.size())
579     return instances[idx].precondition_callback;
580   return nullptr;
581 }
582 
583 #pragma mark SystemRuntime
584 
585 typedef PluginInstance<SystemRuntimeCreateInstance> SystemRuntimeInstance;
586 typedef PluginInstances<SystemRuntimeInstance> SystemRuntimeInstances;
587 
588 static SystemRuntimeInstances &GetSystemRuntimeInstances() {
589   static SystemRuntimeInstances g_instances;
590   return g_instances;
591 }
592 
593 bool PluginManager::RegisterPlugin(
594     ConstString name, const char *description,
595     SystemRuntimeCreateInstance create_callback) {
596   return GetSystemRuntimeInstances().RegisterPlugin(name, description,
597                                                     create_callback);
598 }
599 
600 bool PluginManager::UnregisterPlugin(
601     SystemRuntimeCreateInstance create_callback) {
602   return GetSystemRuntimeInstances().UnregisterPlugin(create_callback);
603 }
604 
605 SystemRuntimeCreateInstance
606 PluginManager::GetSystemRuntimeCreateCallbackAtIndex(uint32_t idx) {
607   return GetSystemRuntimeInstances().GetCallbackAtIndex(idx);
608 }
609 
610 #pragma mark ObjectFile
611 
612 struct ObjectFileInstance : public PluginInstance<ObjectFileCreateInstance> {
613   ObjectFileInstance(
614       ConstString name, std::string description, CallbackType create_callback,
615       ObjectFileCreateMemoryInstance create_memory_callback,
616       ObjectFileGetModuleSpecifications get_module_specifications,
617       ObjectFileSaveCore save_core)
618       : PluginInstance<ObjectFileCreateInstance>(name, std::move(description),
619                                                  create_callback),
620         create_memory_callback(create_memory_callback),
621         get_module_specifications(get_module_specifications),
622         save_core(save_core) {}
623 
624   ObjectFileCreateMemoryInstance create_memory_callback;
625   ObjectFileGetModuleSpecifications get_module_specifications;
626   ObjectFileSaveCore save_core;
627 };
628 typedef PluginInstances<ObjectFileInstance> ObjectFileInstances;
629 
630 static ObjectFileInstances &GetObjectFileInstances() {
631   static ObjectFileInstances g_instances;
632   return g_instances;
633 }
634 
635 bool PluginManager::RegisterPlugin(
636     ConstString name, const char *description,
637     ObjectFileCreateInstance create_callback,
638     ObjectFileCreateMemoryInstance create_memory_callback,
639     ObjectFileGetModuleSpecifications get_module_specifications,
640     ObjectFileSaveCore save_core) {
641   return GetObjectFileInstances().RegisterPlugin(
642       name, description, create_callback, create_memory_callback,
643       get_module_specifications, save_core);
644 }
645 
646 bool PluginManager::UnregisterPlugin(ObjectFileCreateInstance create_callback) {
647   return GetObjectFileInstances().UnregisterPlugin(create_callback);
648 }
649 
650 ObjectFileCreateInstance
651 PluginManager::GetObjectFileCreateCallbackAtIndex(uint32_t idx) {
652   return GetObjectFileInstances().GetCallbackAtIndex(idx);
653 }
654 
655 ObjectFileCreateMemoryInstance
656 PluginManager::GetObjectFileCreateMemoryCallbackAtIndex(uint32_t idx) {
657   const auto &instances = GetObjectFileInstances().GetInstances();
658   if (idx < instances.size())
659     return instances[idx].create_memory_callback;
660   return nullptr;
661 }
662 
663 ObjectFileGetModuleSpecifications
664 PluginManager::GetObjectFileGetModuleSpecificationsCallbackAtIndex(
665     uint32_t idx) {
666   const auto &instances = GetObjectFileInstances().GetInstances();
667   if (idx < instances.size())
668     return instances[idx].get_module_specifications;
669   return nullptr;
670 }
671 
672 ObjectFileCreateMemoryInstance
673 PluginManager::GetObjectFileCreateMemoryCallbackForPluginName(
674     ConstString name) {
675   if (!name)
676     return nullptr;
677   const auto &instances = GetObjectFileInstances().GetInstances();
678   for (auto &instance : instances) {
679     if (instance.name == name)
680       return instance.create_memory_callback;
681   }
682   return nullptr;
683 }
684 
685 Status PluginManager::SaveCore(const lldb::ProcessSP &process_sp,
686                                const FileSpec &outfile) {
687   Status error;
688   auto &instances = GetObjectFileInstances().GetInstances();
689   for (auto &instance : instances) {
690     if (instance.save_core && instance.save_core(process_sp, outfile, error))
691       return error;
692   }
693   error.SetErrorString(
694       "no ObjectFile plugins were able to save a core for this process");
695   return error;
696 }
697 
698 #pragma mark ObjectContainer
699 
700 struct ObjectContainerInstance
701     : public PluginInstance<ObjectContainerCreateInstance> {
702   ObjectContainerInstance(
703       ConstString name, std::string description, CallbackType create_callback,
704       ObjectFileGetModuleSpecifications get_module_specifications)
705       : PluginInstance<ObjectContainerCreateInstance>(
706             name, std::move(description), create_callback),
707         get_module_specifications(get_module_specifications) {}
708 
709   ObjectFileGetModuleSpecifications get_module_specifications;
710 };
711 typedef PluginInstances<ObjectContainerInstance> ObjectContainerInstances;
712 
713 static ObjectContainerInstances &GetObjectContainerInstances() {
714   static ObjectContainerInstances g_instances;
715   return g_instances;
716 }
717 
718 bool PluginManager::RegisterPlugin(
719     ConstString name, const char *description,
720     ObjectContainerCreateInstance create_callback,
721     ObjectFileGetModuleSpecifications get_module_specifications) {
722   return GetObjectContainerInstances().RegisterPlugin(
723       name, description, create_callback, get_module_specifications);
724 }
725 
726 bool PluginManager::UnregisterPlugin(
727     ObjectContainerCreateInstance create_callback) {
728   return GetObjectContainerInstances().UnregisterPlugin(create_callback);
729 }
730 
731 ObjectContainerCreateInstance
732 PluginManager::GetObjectContainerCreateCallbackAtIndex(uint32_t idx) {
733   return GetObjectContainerInstances().GetCallbackAtIndex(idx);
734 }
735 
736 ObjectFileGetModuleSpecifications
737 PluginManager::GetObjectContainerGetModuleSpecificationsCallbackAtIndex(
738     uint32_t idx) {
739   const auto &instances = GetObjectContainerInstances().GetInstances();
740   if (idx < instances.size())
741     return instances[idx].get_module_specifications;
742   return nullptr;
743 }
744 
745 #pragma mark Platform
746 
747 typedef PluginInstance<PlatformCreateInstance> PlatformInstance;
748 typedef PluginInstances<PlatformInstance> PlatformInstances;
749 
750 static PlatformInstances &GetPlatformInstances() {
751   static PlatformInstances g_platform_instances;
752   return g_platform_instances;
753 }
754 
755 bool PluginManager::RegisterPlugin(
756     ConstString name, const char *description,
757     PlatformCreateInstance create_callback,
758     DebuggerInitializeCallback debugger_init_callback) {
759   return GetPlatformInstances().RegisterPlugin(
760       name, description, create_callback, debugger_init_callback);
761 }
762 
763 bool PluginManager::UnregisterPlugin(PlatformCreateInstance create_callback) {
764   return GetPlatformInstances().UnregisterPlugin(create_callback);
765 }
766 
767 const char *PluginManager::GetPlatformPluginNameAtIndex(uint32_t idx) {
768   return GetPlatformInstances().GetNameAtIndex(idx);
769 }
770 
771 const char *PluginManager::GetPlatformPluginDescriptionAtIndex(uint32_t idx) {
772   return GetPlatformInstances().GetDescriptionAtIndex(idx);
773 }
774 
775 PlatformCreateInstance
776 PluginManager::GetPlatformCreateCallbackAtIndex(uint32_t idx) {
777   return GetPlatformInstances().GetCallbackAtIndex(idx);
778 }
779 
780 PlatformCreateInstance
781 PluginManager::GetPlatformCreateCallbackForPluginName(ConstString name) {
782   return GetPlatformInstances().GetCallbackForName(name);
783 }
784 
785 void PluginManager::AutoCompletePlatformName(llvm::StringRef name,
786                                              CompletionRequest &request) {
787   for (const auto &instance : GetPlatformInstances().GetInstances()) {
788     if (instance.name.GetStringRef().startswith(name))
789       request.AddCompletion(instance.name.GetCString());
790   }
791 }
792 
793 #pragma mark Process
794 
795 typedef PluginInstance<ProcessCreateInstance> ProcessInstance;
796 typedef PluginInstances<ProcessInstance> ProcessInstances;
797 
798 static ProcessInstances &GetProcessInstances() {
799   static ProcessInstances g_instances;
800   return g_instances;
801 }
802 
803 bool PluginManager::RegisterPlugin(
804     ConstString name, const char *description,
805     ProcessCreateInstance create_callback,
806     DebuggerInitializeCallback debugger_init_callback) {
807   return GetProcessInstances().RegisterPlugin(
808       name, description, create_callback, debugger_init_callback);
809 }
810 
811 bool PluginManager::UnregisterPlugin(ProcessCreateInstance create_callback) {
812   return GetProcessInstances().UnregisterPlugin(create_callback);
813 }
814 
815 const char *PluginManager::GetProcessPluginNameAtIndex(uint32_t idx) {
816   return GetProcessInstances().GetNameAtIndex(idx);
817 }
818 
819 const char *PluginManager::GetProcessPluginDescriptionAtIndex(uint32_t idx) {
820   return GetProcessInstances().GetDescriptionAtIndex(idx);
821 }
822 
823 ProcessCreateInstance
824 PluginManager::GetProcessCreateCallbackAtIndex(uint32_t idx) {
825   return GetProcessInstances().GetCallbackAtIndex(idx);
826 }
827 
828 ProcessCreateInstance
829 PluginManager::GetProcessCreateCallbackForPluginName(ConstString name) {
830   return GetProcessInstances().GetCallbackForName(name);
831 }
832 
833 #pragma mark ScriptInterpreter
834 
835 struct ScriptInterpreterInstance
836     : public PluginInstance<ScriptInterpreterCreateInstance> {
837   ScriptInterpreterInstance(ConstString name, std::string description,
838                             CallbackType create_callback,
839                             lldb::ScriptLanguage language)
840       : PluginInstance<ScriptInterpreterCreateInstance>(
841             name, std::move(description), create_callback),
842         language(language) {}
843 
844   lldb::ScriptLanguage language = lldb::eScriptLanguageNone;
845 };
846 
847 typedef PluginInstances<ScriptInterpreterInstance> ScriptInterpreterInstances;
848 
849 static ScriptInterpreterInstances &GetScriptInterpreterInstances() {
850   static ScriptInterpreterInstances g_instances;
851   return g_instances;
852 }
853 
854 bool PluginManager::RegisterPlugin(
855     ConstString name, const char *description,
856     lldb::ScriptLanguage script_language,
857     ScriptInterpreterCreateInstance create_callback) {
858   return GetScriptInterpreterInstances().RegisterPlugin(
859       name, description, create_callback, script_language);
860 }
861 
862 bool PluginManager::UnregisterPlugin(
863     ScriptInterpreterCreateInstance create_callback) {
864   return GetScriptInterpreterInstances().UnregisterPlugin(create_callback);
865 }
866 
867 ScriptInterpreterCreateInstance
868 PluginManager::GetScriptInterpreterCreateCallbackAtIndex(uint32_t idx) {
869   return GetScriptInterpreterInstances().GetCallbackAtIndex(idx);
870 }
871 
872 lldb::ScriptInterpreterSP
873 PluginManager::GetScriptInterpreterForLanguage(lldb::ScriptLanguage script_lang,
874                                                Debugger &debugger) {
875   const auto &instances = GetScriptInterpreterInstances().GetInstances();
876   ScriptInterpreterCreateInstance none_instance = nullptr;
877   for (const auto &instance : instances) {
878     if (instance.language == lldb::eScriptLanguageNone)
879       none_instance = instance.create_callback;
880 
881     if (script_lang == instance.language)
882       return instance.create_callback(debugger);
883   }
884 
885   // If we didn't find one, return the ScriptInterpreter for the null language.
886   assert(none_instance != nullptr);
887   return none_instance(debugger);
888 }
889 
890 #pragma mark StructuredDataPlugin
891 
892 struct StructuredDataPluginInstance
893     : public PluginInstance<StructuredDataPluginCreateInstance> {
894   StructuredDataPluginInstance(
895       ConstString name, std::string description, CallbackType create_callback,
896       DebuggerInitializeCallback debugger_init_callback,
897       StructuredDataFilterLaunchInfo filter_callback)
898       : PluginInstance<StructuredDataPluginCreateInstance>(
899             name, std::move(description), create_callback,
900             debugger_init_callback),
901         filter_callback(filter_callback) {}
902 
903   StructuredDataFilterLaunchInfo filter_callback = nullptr;
904 };
905 
906 typedef PluginInstances<StructuredDataPluginInstance>
907     StructuredDataPluginInstances;
908 
909 static StructuredDataPluginInstances &GetStructuredDataPluginInstances() {
910   static StructuredDataPluginInstances g_instances;
911   return g_instances;
912 }
913 
914 bool PluginManager::RegisterPlugin(
915     ConstString name, const char *description,
916     StructuredDataPluginCreateInstance create_callback,
917     DebuggerInitializeCallback debugger_init_callback,
918     StructuredDataFilterLaunchInfo filter_callback) {
919   return GetStructuredDataPluginInstances().RegisterPlugin(
920       name, description, create_callback, debugger_init_callback,
921       filter_callback);
922 }
923 
924 bool PluginManager::UnregisterPlugin(
925     StructuredDataPluginCreateInstance create_callback) {
926   return GetStructuredDataPluginInstances().UnregisterPlugin(create_callback);
927 }
928 
929 StructuredDataPluginCreateInstance
930 PluginManager::GetStructuredDataPluginCreateCallbackAtIndex(uint32_t idx) {
931   return GetStructuredDataPluginInstances().GetCallbackAtIndex(idx);
932 }
933 
934 StructuredDataFilterLaunchInfo
935 PluginManager::GetStructuredDataFilterCallbackAtIndex(
936     uint32_t idx, bool &iteration_complete) {
937   const auto &instances = GetStructuredDataPluginInstances().GetInstances();
938   if (idx < instances.size()) {
939     iteration_complete = false;
940     return instances[idx].filter_callback;
941   } else {
942     iteration_complete = true;
943   }
944   return nullptr;
945 }
946 
947 #pragma mark SymbolFile
948 
949 typedef PluginInstance<SymbolFileCreateInstance> SymbolFileInstance;
950 typedef PluginInstances<SymbolFileInstance> SymbolFileInstances;
951 
952 static SymbolFileInstances &GetSymbolFileInstances() {
953   static SymbolFileInstances g_instances;
954   return g_instances;
955 }
956 
957 bool PluginManager::RegisterPlugin(
958     ConstString name, const char *description,
959     SymbolFileCreateInstance create_callback,
960     DebuggerInitializeCallback debugger_init_callback) {
961   return GetSymbolFileInstances().RegisterPlugin(
962       name, description, create_callback, debugger_init_callback);
963 }
964 
965 bool PluginManager::UnregisterPlugin(SymbolFileCreateInstance create_callback) {
966   return GetSymbolFileInstances().UnregisterPlugin(create_callback);
967 }
968 
969 SymbolFileCreateInstance
970 PluginManager::GetSymbolFileCreateCallbackAtIndex(uint32_t idx) {
971   return GetSymbolFileInstances().GetCallbackAtIndex(idx);
972 }
973 
974 #pragma mark SymbolVendor
975 
976 typedef PluginInstance<SymbolVendorCreateInstance> SymbolVendorInstance;
977 typedef PluginInstances<SymbolVendorInstance> SymbolVendorInstances;
978 
979 static SymbolVendorInstances &GetSymbolVendorInstances() {
980   static SymbolVendorInstances g_instances;
981   return g_instances;
982 }
983 
984 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
985                                    SymbolVendorCreateInstance create_callback) {
986   return GetSymbolVendorInstances().RegisterPlugin(name, description,
987                                                    create_callback);
988 }
989 
990 bool PluginManager::UnregisterPlugin(
991     SymbolVendorCreateInstance create_callback) {
992   return GetSymbolVendorInstances().UnregisterPlugin(create_callback);
993 }
994 
995 SymbolVendorCreateInstance
996 PluginManager::GetSymbolVendorCreateCallbackAtIndex(uint32_t idx) {
997   return GetSymbolVendorInstances().GetCallbackAtIndex(idx);
998 }
999 
1000 #pragma mark UnwindAssembly
1001 
1002 typedef PluginInstance<UnwindAssemblyCreateInstance> UnwindAssemblyInstance;
1003 typedef PluginInstances<UnwindAssemblyInstance> UnwindAssemblyInstances;
1004 
1005 static UnwindAssemblyInstances &GetUnwindAssemblyInstances() {
1006   static UnwindAssemblyInstances g_instances;
1007   return g_instances;
1008 }
1009 
1010 bool PluginManager::RegisterPlugin(
1011     ConstString name, const char *description,
1012     UnwindAssemblyCreateInstance create_callback) {
1013   return GetUnwindAssemblyInstances().RegisterPlugin(name, description,
1014                                                      create_callback);
1015 }
1016 
1017 bool PluginManager::UnregisterPlugin(
1018     UnwindAssemblyCreateInstance create_callback) {
1019   return GetUnwindAssemblyInstances().UnregisterPlugin(create_callback);
1020 }
1021 
1022 UnwindAssemblyCreateInstance
1023 PluginManager::GetUnwindAssemblyCreateCallbackAtIndex(uint32_t idx) {
1024   return GetUnwindAssemblyInstances().GetCallbackAtIndex(idx);
1025 }
1026 
1027 #pragma mark MemoryHistory
1028 
1029 typedef PluginInstance<MemoryHistoryCreateInstance> MemoryHistoryInstance;
1030 typedef PluginInstances<MemoryHistoryInstance> MemoryHistoryInstances;
1031 
1032 static MemoryHistoryInstances &GetMemoryHistoryInstances() {
1033   static MemoryHistoryInstances g_instances;
1034   return g_instances;
1035 }
1036 
1037 bool PluginManager::RegisterPlugin(
1038     ConstString name, const char *description,
1039     MemoryHistoryCreateInstance create_callback) {
1040   return GetMemoryHistoryInstances().RegisterPlugin(name, description,
1041                                                     create_callback);
1042 }
1043 
1044 bool PluginManager::UnregisterPlugin(
1045     MemoryHistoryCreateInstance create_callback) {
1046   return GetMemoryHistoryInstances().UnregisterPlugin(create_callback);
1047 }
1048 
1049 MemoryHistoryCreateInstance
1050 PluginManager::GetMemoryHistoryCreateCallbackAtIndex(uint32_t idx) {
1051   return GetMemoryHistoryInstances().GetCallbackAtIndex(idx);
1052 }
1053 
1054 #pragma mark InstrumentationRuntime
1055 
1056 struct InstrumentationRuntimeInstance
1057     : public PluginInstance<InstrumentationRuntimeCreateInstance> {
1058   InstrumentationRuntimeInstance(
1059       ConstString name, std::string description, CallbackType create_callback,
1060       InstrumentationRuntimeGetType get_type_callback)
1061       : PluginInstance<InstrumentationRuntimeCreateInstance>(
1062             name, std::move(description), create_callback),
1063         get_type_callback(get_type_callback) {}
1064 
1065   InstrumentationRuntimeGetType get_type_callback = nullptr;
1066 };
1067 
1068 typedef PluginInstances<InstrumentationRuntimeInstance>
1069     InstrumentationRuntimeInstances;
1070 
1071 static InstrumentationRuntimeInstances &GetInstrumentationRuntimeInstances() {
1072   static InstrumentationRuntimeInstances g_instances;
1073   return g_instances;
1074 }
1075 
1076 bool PluginManager::RegisterPlugin(
1077     ConstString name, const char *description,
1078     InstrumentationRuntimeCreateInstance create_callback,
1079     InstrumentationRuntimeGetType get_type_callback) {
1080   return GetInstrumentationRuntimeInstances().RegisterPlugin(
1081       name, description, create_callback, get_type_callback);
1082 }
1083 
1084 bool PluginManager::UnregisterPlugin(
1085     InstrumentationRuntimeCreateInstance create_callback) {
1086   return GetInstrumentationRuntimeInstances().UnregisterPlugin(create_callback);
1087 }
1088 
1089 InstrumentationRuntimeGetType
1090 PluginManager::GetInstrumentationRuntimeGetTypeCallbackAtIndex(uint32_t idx) {
1091   const auto &instances = GetInstrumentationRuntimeInstances().GetInstances();
1092   if (idx < instances.size())
1093     return instances[idx].get_type_callback;
1094   return nullptr;
1095 }
1096 
1097 InstrumentationRuntimeCreateInstance
1098 PluginManager::GetInstrumentationRuntimeCreateCallbackAtIndex(uint32_t idx) {
1099   return GetInstrumentationRuntimeInstances().GetCallbackAtIndex(idx);
1100 }
1101 
1102 #pragma mark TypeSystem
1103 
1104 struct TypeSystemInstance : public PluginInstance<TypeSystemCreateInstance> {
1105   TypeSystemInstance(ConstString name, std::string description,
1106                      CallbackType create_callback,
1107                      LanguageSet supported_languages_for_types,
1108                      LanguageSet supported_languages_for_expressions)
1109       : PluginInstance<TypeSystemCreateInstance>(name, std::move(description),
1110                                                  create_callback),
1111         supported_languages_for_types(supported_languages_for_types),
1112         supported_languages_for_expressions(
1113             supported_languages_for_expressions) {}
1114 
1115   LanguageSet supported_languages_for_types;
1116   LanguageSet supported_languages_for_expressions;
1117 };
1118 
1119 typedef PluginInstances<TypeSystemInstance> TypeSystemInstances;
1120 
1121 static TypeSystemInstances &GetTypeSystemInstances() {
1122   static TypeSystemInstances g_instances;
1123   return g_instances;
1124 }
1125 
1126 bool PluginManager::RegisterPlugin(
1127     ConstString name, const char *description,
1128     TypeSystemCreateInstance create_callback,
1129     LanguageSet supported_languages_for_types,
1130     LanguageSet supported_languages_for_expressions) {
1131   return GetTypeSystemInstances().RegisterPlugin(
1132       name, description, create_callback, supported_languages_for_types,
1133       supported_languages_for_expressions);
1134 }
1135 
1136 bool PluginManager::UnregisterPlugin(TypeSystemCreateInstance create_callback) {
1137   return GetTypeSystemInstances().UnregisterPlugin(create_callback);
1138 }
1139 
1140 TypeSystemCreateInstance
1141 PluginManager::GetTypeSystemCreateCallbackAtIndex(uint32_t idx) {
1142   return GetTypeSystemInstances().GetCallbackAtIndex(idx);
1143 }
1144 
1145 LanguageSet PluginManager::GetAllTypeSystemSupportedLanguagesForTypes() {
1146   const auto &instances = GetTypeSystemInstances().GetInstances();
1147   LanguageSet all;
1148   for (unsigned i = 0; i < instances.size(); ++i)
1149     all.bitvector |= instances[i].supported_languages_for_types.bitvector;
1150   return all;
1151 }
1152 
1153 LanguageSet PluginManager::GetAllTypeSystemSupportedLanguagesForExpressions() {
1154   const auto &instances = GetTypeSystemInstances().GetInstances();
1155   LanguageSet all;
1156   for (unsigned i = 0; i < instances.size(); ++i)
1157     all.bitvector |= instances[i].supported_languages_for_expressions.bitvector;
1158   return all;
1159 }
1160 
1161 #pragma mark REPL
1162 
1163 struct REPLInstance : public PluginInstance<REPLCreateInstance> {
1164   REPLInstance(ConstString name, std::string description,
1165                CallbackType create_callback, LanguageSet supported_languages)
1166       : PluginInstance<REPLCreateInstance>(name, std::move(description),
1167                                            create_callback),
1168         supported_languages(supported_languages) {}
1169 
1170   LanguageSet supported_languages;
1171 };
1172 
1173 typedef PluginInstances<REPLInstance> REPLInstances;
1174 
1175 static REPLInstances &GetREPLInstances() {
1176   static REPLInstances g_instances;
1177   return g_instances;
1178 }
1179 
1180 bool PluginManager::RegisterPlugin(ConstString name, const char *description,
1181                                    REPLCreateInstance create_callback,
1182                                    LanguageSet supported_languages) {
1183   return GetREPLInstances().RegisterPlugin(name, description, create_callback,
1184                                            supported_languages);
1185 }
1186 
1187 bool PluginManager::UnregisterPlugin(REPLCreateInstance create_callback) {
1188   return GetREPLInstances().UnregisterPlugin(create_callback);
1189 }
1190 
1191 REPLCreateInstance PluginManager::GetREPLCreateCallbackAtIndex(uint32_t idx) {
1192   return GetREPLInstances().GetCallbackAtIndex(idx);
1193 }
1194 
1195 LanguageSet PluginManager::GetREPLAllTypeSystemSupportedLanguages() {
1196   const auto &instances = GetREPLInstances().GetInstances();
1197   LanguageSet all;
1198   for (unsigned i = 0; i < instances.size(); ++i)
1199     all.bitvector |= instances[i].supported_languages.bitvector;
1200   return all;
1201 }
1202 
1203 #pragma mark PluginManager
1204 
1205 void PluginManager::DebuggerInitialize(Debugger &debugger) {
1206   GetDynamicLoaderInstances().PerformDebuggerCallback(debugger);
1207   GetJITLoaderInstances().PerformDebuggerCallback(debugger);
1208   GetPlatformInstances().PerformDebuggerCallback(debugger);
1209   GetProcessInstances().PerformDebuggerCallback(debugger);
1210   GetSymbolFileInstances().PerformDebuggerCallback(debugger);
1211   GetOperatingSystemInstances().PerformDebuggerCallback(debugger);
1212   GetStructuredDataPluginInstances().PerformDebuggerCallback(debugger);
1213 }
1214 
1215 // This is the preferred new way to register plugin specific settings.  e.g.
1216 // This will put a plugin's settings under e.g.
1217 // "plugin.<plugin_type_name>.<plugin_type_desc>.SETTINGNAME".
1218 static lldb::OptionValuePropertiesSP
1219 GetDebuggerPropertyForPlugins(Debugger &debugger, ConstString plugin_type_name,
1220                               ConstString plugin_type_desc, bool can_create) {
1221   lldb::OptionValuePropertiesSP parent_properties_sp(
1222       debugger.GetValueProperties());
1223   if (parent_properties_sp) {
1224     static ConstString g_property_name("plugin");
1225 
1226     OptionValuePropertiesSP plugin_properties_sp =
1227         parent_properties_sp->GetSubProperty(nullptr, g_property_name);
1228     if (!plugin_properties_sp && can_create) {
1229       plugin_properties_sp =
1230           std::make_shared<OptionValueProperties>(g_property_name);
1231       parent_properties_sp->AppendProperty(
1232           g_property_name, ConstString("Settings specify to plugins."), true,
1233           plugin_properties_sp);
1234     }
1235 
1236     if (plugin_properties_sp) {
1237       lldb::OptionValuePropertiesSP plugin_type_properties_sp =
1238           plugin_properties_sp->GetSubProperty(nullptr, plugin_type_name);
1239       if (!plugin_type_properties_sp && can_create) {
1240         plugin_type_properties_sp =
1241             std::make_shared<OptionValueProperties>(plugin_type_name);
1242         plugin_properties_sp->AppendProperty(plugin_type_name, plugin_type_desc,
1243                                              true, plugin_type_properties_sp);
1244       }
1245       return plugin_type_properties_sp;
1246     }
1247   }
1248   return lldb::OptionValuePropertiesSP();
1249 }
1250 
1251 // This is deprecated way to register plugin specific settings.  e.g.
1252 // "<plugin_type_name>.plugin.<plugin_type_desc>.SETTINGNAME" and Platform
1253 // generic settings would be under "platform.SETTINGNAME".
1254 static lldb::OptionValuePropertiesSP GetDebuggerPropertyForPluginsOldStyle(
1255     Debugger &debugger, ConstString plugin_type_name,
1256     ConstString plugin_type_desc, bool can_create) {
1257   static ConstString g_property_name("plugin");
1258   lldb::OptionValuePropertiesSP parent_properties_sp(
1259       debugger.GetValueProperties());
1260   if (parent_properties_sp) {
1261     OptionValuePropertiesSP plugin_properties_sp =
1262         parent_properties_sp->GetSubProperty(nullptr, plugin_type_name);
1263     if (!plugin_properties_sp && can_create) {
1264       plugin_properties_sp =
1265           std::make_shared<OptionValueProperties>(plugin_type_name);
1266       parent_properties_sp->AppendProperty(plugin_type_name, plugin_type_desc,
1267                                            true, plugin_properties_sp);
1268     }
1269 
1270     if (plugin_properties_sp) {
1271       lldb::OptionValuePropertiesSP plugin_type_properties_sp =
1272           plugin_properties_sp->GetSubProperty(nullptr, g_property_name);
1273       if (!plugin_type_properties_sp && can_create) {
1274         plugin_type_properties_sp =
1275             std::make_shared<OptionValueProperties>(g_property_name);
1276         plugin_properties_sp->AppendProperty(
1277             g_property_name, ConstString("Settings specific to plugins"), true,
1278             plugin_type_properties_sp);
1279       }
1280       return plugin_type_properties_sp;
1281     }
1282   }
1283   return lldb::OptionValuePropertiesSP();
1284 }
1285 
1286 namespace {
1287 
1288 typedef lldb::OptionValuePropertiesSP
1289 GetDebuggerPropertyForPluginsPtr(Debugger &, ConstString, ConstString,
1290                                  bool can_create);
1291 
1292 lldb::OptionValuePropertiesSP
1293 GetSettingForPlugin(Debugger &debugger, ConstString setting_name,
1294                     ConstString plugin_type_name,
1295                     GetDebuggerPropertyForPluginsPtr get_debugger_property =
1296                         GetDebuggerPropertyForPlugins) {
1297   lldb::OptionValuePropertiesSP properties_sp;
1298   lldb::OptionValuePropertiesSP plugin_type_properties_sp(get_debugger_property(
1299       debugger, plugin_type_name,
1300       ConstString(), // not creating to so we don't need the description
1301       false));
1302   if (plugin_type_properties_sp)
1303     properties_sp =
1304         plugin_type_properties_sp->GetSubProperty(nullptr, setting_name);
1305   return properties_sp;
1306 }
1307 
1308 bool CreateSettingForPlugin(
1309     Debugger &debugger, ConstString plugin_type_name,
1310     ConstString plugin_type_desc,
1311     const lldb::OptionValuePropertiesSP &properties_sp, ConstString description,
1312     bool is_global_property,
1313     GetDebuggerPropertyForPluginsPtr get_debugger_property =
1314         GetDebuggerPropertyForPlugins) {
1315   if (properties_sp) {
1316     lldb::OptionValuePropertiesSP plugin_type_properties_sp(
1317         get_debugger_property(debugger, plugin_type_name, plugin_type_desc,
1318                               true));
1319     if (plugin_type_properties_sp) {
1320       plugin_type_properties_sp->AppendProperty(properties_sp->GetName(),
1321                                                 description, is_global_property,
1322                                                 properties_sp);
1323       return true;
1324     }
1325   }
1326   return false;
1327 }
1328 
1329 const char *kDynamicLoaderPluginName("dynamic-loader");
1330 const char *kPlatformPluginName("platform");
1331 const char *kProcessPluginName("process");
1332 const char *kSymbolFilePluginName("symbol-file");
1333 const char *kJITLoaderPluginName("jit-loader");
1334 const char *kStructuredDataPluginName("structured-data");
1335 
1336 } // anonymous namespace
1337 
1338 lldb::OptionValuePropertiesSP
1339 PluginManager::GetSettingForDynamicLoaderPlugin(Debugger &debugger,
1340                                                 ConstString setting_name) {
1341   return GetSettingForPlugin(debugger, setting_name,
1342                              ConstString(kDynamicLoaderPluginName));
1343 }
1344 
1345 bool PluginManager::CreateSettingForDynamicLoaderPlugin(
1346     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1347     ConstString description, bool is_global_property) {
1348   return CreateSettingForPlugin(
1349       debugger, ConstString(kDynamicLoaderPluginName),
1350       ConstString("Settings for dynamic loader plug-ins"), properties_sp,
1351       description, is_global_property);
1352 }
1353 
1354 lldb::OptionValuePropertiesSP
1355 PluginManager::GetSettingForPlatformPlugin(Debugger &debugger,
1356                                            ConstString setting_name) {
1357   return GetSettingForPlugin(debugger, setting_name,
1358                              ConstString(kPlatformPluginName),
1359                              GetDebuggerPropertyForPluginsOldStyle);
1360 }
1361 
1362 bool PluginManager::CreateSettingForPlatformPlugin(
1363     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1364     ConstString description, bool is_global_property) {
1365   return CreateSettingForPlugin(debugger, ConstString(kPlatformPluginName),
1366                                 ConstString("Settings for platform plug-ins"),
1367                                 properties_sp, description, is_global_property,
1368                                 GetDebuggerPropertyForPluginsOldStyle);
1369 }
1370 
1371 lldb::OptionValuePropertiesSP
1372 PluginManager::GetSettingForProcessPlugin(Debugger &debugger,
1373                                           ConstString setting_name) {
1374   return GetSettingForPlugin(debugger, setting_name,
1375                              ConstString(kProcessPluginName));
1376 }
1377 
1378 bool PluginManager::CreateSettingForProcessPlugin(
1379     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1380     ConstString description, bool is_global_property) {
1381   return CreateSettingForPlugin(debugger, ConstString(kProcessPluginName),
1382                                 ConstString("Settings for process plug-ins"),
1383                                 properties_sp, description, is_global_property);
1384 }
1385 
1386 lldb::OptionValuePropertiesSP
1387 PluginManager::GetSettingForSymbolFilePlugin(Debugger &debugger,
1388                                              ConstString setting_name) {
1389   return GetSettingForPlugin(debugger, setting_name,
1390                              ConstString(kSymbolFilePluginName));
1391 }
1392 
1393 bool PluginManager::CreateSettingForSymbolFilePlugin(
1394     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1395     ConstString description, bool is_global_property) {
1396   return CreateSettingForPlugin(
1397       debugger, ConstString(kSymbolFilePluginName),
1398       ConstString("Settings for symbol file plug-ins"), properties_sp,
1399       description, is_global_property);
1400 }
1401 
1402 lldb::OptionValuePropertiesSP
1403 PluginManager::GetSettingForJITLoaderPlugin(Debugger &debugger,
1404                                             ConstString setting_name) {
1405   return GetSettingForPlugin(debugger, setting_name,
1406                              ConstString(kJITLoaderPluginName));
1407 }
1408 
1409 bool PluginManager::CreateSettingForJITLoaderPlugin(
1410     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1411     ConstString description, bool is_global_property) {
1412   return CreateSettingForPlugin(debugger, ConstString(kJITLoaderPluginName),
1413                                 ConstString("Settings for JIT loader plug-ins"),
1414                                 properties_sp, description, is_global_property);
1415 }
1416 
1417 static const char *kOperatingSystemPluginName("os");
1418 
1419 lldb::OptionValuePropertiesSP
1420 PluginManager::GetSettingForOperatingSystemPlugin(Debugger &debugger,
1421                                                   ConstString setting_name) {
1422   lldb::OptionValuePropertiesSP properties_sp;
1423   lldb::OptionValuePropertiesSP plugin_type_properties_sp(
1424       GetDebuggerPropertyForPlugins(
1425           debugger, ConstString(kOperatingSystemPluginName),
1426           ConstString(), // not creating to so we don't need the description
1427           false));
1428   if (plugin_type_properties_sp)
1429     properties_sp =
1430         plugin_type_properties_sp->GetSubProperty(nullptr, setting_name);
1431   return properties_sp;
1432 }
1433 
1434 bool PluginManager::CreateSettingForOperatingSystemPlugin(
1435     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1436     ConstString description, bool is_global_property) {
1437   if (properties_sp) {
1438     lldb::OptionValuePropertiesSP plugin_type_properties_sp(
1439         GetDebuggerPropertyForPlugins(
1440             debugger, ConstString(kOperatingSystemPluginName),
1441             ConstString("Settings for operating system plug-ins"), true));
1442     if (plugin_type_properties_sp) {
1443       plugin_type_properties_sp->AppendProperty(properties_sp->GetName(),
1444                                                 description, is_global_property,
1445                                                 properties_sp);
1446       return true;
1447     }
1448   }
1449   return false;
1450 }
1451 
1452 lldb::OptionValuePropertiesSP
1453 PluginManager::GetSettingForStructuredDataPlugin(Debugger &debugger,
1454                                                  ConstString setting_name) {
1455   return GetSettingForPlugin(debugger, setting_name,
1456                              ConstString(kStructuredDataPluginName));
1457 }
1458 
1459 bool PluginManager::CreateSettingForStructuredDataPlugin(
1460     Debugger &debugger, const lldb::OptionValuePropertiesSP &properties_sp,
1461     ConstString description, bool is_global_property) {
1462   return CreateSettingForPlugin(
1463       debugger, ConstString(kStructuredDataPluginName),
1464       ConstString("Settings for structured data plug-ins"), properties_sp,
1465       description, is_global_property);
1466 }
1467