https://github.com/medismailben updated https://github.com/llvm/llvm-project/pull/97273
>From c475dcf4e57fbbaa0bc50da5103f1eb3a273e83a Mon Sep 17 00:00:00 2001 From: Med Ismail Bennani <ism...@bennani.ma> Date: Tue, 2 Jul 2024 21:31:21 -0700 Subject: [PATCH] [lldb/Commands] Add `scripting template list` command with auto discovery This patch introduces a new `template` multiword sub-command to the `scripting` top-level command. As the name suggests, this sub-command operates on scripting templates, and currently has the ability to automatically discover the various scripting extensions that lldb supports. Signed-off-by: Med Ismail Bennani <ism...@bennani.ma> --- lldb/include/lldb/Core/PluginManager.h | 27 ++++ .../Interfaces/ScriptedInterface.h | 7 + lldb/include/lldb/lldb-private-interfaces.h | 4 + .../Commands/CommandObjectScripting.cpp | 148 ++++++++++++++++++ lldb/source/Commands/Options.td | 6 + lldb/source/Core/PluginManager.cpp | 87 ++++++++++ lldb/source/Plugins/CMakeLists.txt | 3 + .../Python/Interfaces/CMakeLists.txt | 5 + .../ScriptedProcessPythonInterface.cpp | 23 +++ .../ScriptedProcessPythonInterface.h | 13 +- .../ScriptedThreadPlanPythonInterface.cpp | 18 +++ .../ScriptedThreadPlanPythonInterface.h | 13 +- 12 files changed, 352 insertions(+), 2 deletions(-) diff --git a/lldb/include/lldb/Core/PluginManager.h b/lldb/include/lldb/Core/PluginManager.h index f2296e2920238..d7d89347c1561 100644 --- a/lldb/include/lldb/Core/PluginManager.h +++ b/lldb/include/lldb/Core/PluginManager.h @@ -487,6 +487,33 @@ class PluginManager { static LanguageSet GetAllTypeSystemSupportedLanguagesForExpressions(); + // Scripted Interface + static bool + RegisterPlugin(llvm::StringRef name, llvm::StringRef description, + ScriptedInterfaceCreateInstance create_callback, + lldb::ScriptLanguage language, + std::vector<llvm::StringRef> command_interpreter_usages, + std::vector<llvm::StringRef> api_usages); + + static bool UnregisterPlugin(ScriptedInterfaceCreateInstance create_callback); + + static ScriptedInterfaceCreateInstance + GetScriptedInterfaceCreateCallbackAtIndex(uint32_t idx); + + static uint32_t GetNumScriptedInterfaces(); + + static llvm::StringRef GetScriptedInterfaceNameAtIndex(uint32_t idx); + + static llvm::StringRef GetScriptedInterfaceDescriptionAtIndex(uint32_t idx); + + static lldb::ScriptLanguage GetScriptedInterfaceLanguageAtIndex(uint32_t idx); + + static std::vector<llvm::StringRef> + GetScriptedInterfaceCommandInterpreterUsagesAtIndex(uint32_t idx); + + static std::vector<llvm::StringRef> + GetScriptedInterfaceAPIUsagesAtIndex(uint32_t idx); + // REPL static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, REPLCreateInstance create_callback, diff --git a/lldb/include/lldb/Interpreter/Interfaces/ScriptedInterface.h b/lldb/include/lldb/Interpreter/Interfaces/ScriptedInterface.h index 69504dbcda5dc..23658b90bb90a 100644 --- a/lldb/include/lldb/Interpreter/Interfaces/ScriptedInterface.h +++ b/lldb/include/lldb/Interpreter/Interfaces/ScriptedInterface.h @@ -68,6 +68,13 @@ class ScriptedInterface { return true; } + static bool + CreateInstance(lldb::ScriptLanguage language, + std::vector<llvm::StringRef> command_interpreter_usages, + std::vector<llvm::StringRef> api_usages) { + return false; + } + protected: StructuredData::GenericSP m_object_instance_sp; }; diff --git a/lldb/include/lldb/lldb-private-interfaces.h b/lldb/include/lldb/lldb-private-interfaces.h index cdd9b51d9329c..2404e28158690 100644 --- a/lldb/include/lldb/lldb-private-interfaces.h +++ b/lldb/include/lldb/lldb-private-interfaces.h @@ -124,6 +124,10 @@ typedef lldb::REPLSP (*REPLCreateInstance)(Status &error, lldb::LanguageType language, Debugger *debugger, Target *target, const char *repl_options); +typedef bool (*ScriptedInterfaceCreateInstance)( + lldb::ScriptLanguage language, + std::vector<llvm::StringRef> command_interpreter_usages, + std::vector<llvm::StringRef> api_usages); typedef int (*ComparisonFunction)(const void *, const void *); typedef void (*DebuggerInitializeCallback)(Debugger &debugger); /// Trace diff --git a/lldb/source/Commands/CommandObjectScripting.cpp b/lldb/source/Commands/CommandObjectScripting.cpp index fee0565a7c48a..5ac16c290953a 100644 --- a/lldb/source/Commands/CommandObjectScripting.cpp +++ b/lldb/source/Commands/CommandObjectScripting.cpp @@ -8,6 +8,7 @@ #include "CommandObjectScripting.h" #include "lldb/Core/Debugger.h" +#include "lldb/Core/PluginManager.h" #include "lldb/DataFormatters/DataVisualization.h" #include "lldb/Host/Config.h" #include "lldb/Host/OptionParser.h" @@ -21,6 +22,8 @@ using namespace lldb; using namespace lldb_private; +#pragma mark CommandObjectScriptingRun + #define LLDB_OPTIONS_scripting_run #include "CommandOptions.inc" @@ -127,6 +130,148 @@ class CommandObjectScriptingRun : public CommandObjectRaw { CommandOptions m_options; }; +#pragma mark CommandObjectScriptingTemplateList + +#define LLDB_OPTIONS_scripting_template_list +#include "CommandOptions.inc" + +class CommandObjectScriptingTemplateList : public CommandObjectParsed { +public: + CommandObjectScriptingTemplateList(CommandInterpreter &interpreter) + : CommandObjectParsed( + interpreter, "scripting template list", + "List all the available scripting affordances templates. ", + "scripting template list [--language <scripting-language> --]") {} + + ~CommandObjectScriptingTemplateList() override = default; + + Options *GetOptions() override { return &m_options; } + + class CommandOptions : public Options { + public: + CommandOptions() = default; + ~CommandOptions() override = default; + Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, + ExecutionContext *execution_context) override { + Status error; + const int short_option = m_getopt_table[option_idx].val; + + switch (short_option) { + case 'l': + m_language = (lldb::ScriptLanguage)OptionArgParser::ToOptionEnum( + option_arg, GetDefinitions()[option_idx].enum_values, + eScriptLanguageNone, error); + if (!error.Success()) + error.SetErrorStringWithFormat("unrecognized value for language '%s'", + option_arg.str().c_str()); + break; + default: + llvm_unreachable("Unimplemented option"); + } + + return error; + } + + void OptionParsingStarting(ExecutionContext *execution_context) override { + m_language = lldb::eScriptLanguageDefault; + } + + llvm::ArrayRef<OptionDefinition> GetDefinitions() override { + return llvm::ArrayRef(g_scripting_template_list_options); + } + + lldb::ScriptLanguage m_language = lldb::eScriptLanguageDefault; + }; + +protected: + void DoExecute(Args &command, CommandReturnObject &result) override { + Stream &s = result.GetOutputStream(); + s.Printf("Available scripted affordances:\n"); + + auto print_field = [&s](llvm::StringRef key, llvm::StringRef value, + bool check_validity = false) { + if (!check_validity || !value.empty()) { + s.IndentMore(); + s.Indent(); + s << key << ": " << value << '\n'; + s.IndentLess(); + } + }; + + auto print_usages = [&s](llvm::StringRef usage_kind, + std::vector<llvm::StringRef> &usages) { + s.IndentMore(); + s.Indent(); + s << usage_kind << " Usages:"; + if (usages.empty()) + s << " No usages.\n"; + else if (usages.size() == 1) + s << " " << usages.front() << '\n'; + else { + s << '\n'; + for (llvm::StringRef usage : usages) { + s.IndentMore(); + s.Indent(); + s << usage << '\n'; + s.IndentLess(); + } + } + s.IndentLess(); + }; + + size_t num_templates = PluginManager::GetNumScriptedInterfaces(); + for (size_t i = 0; i < num_templates; i++) { + llvm::StringRef plugin_name = + PluginManager::GetScriptedInterfaceNameAtIndex(i); + if (plugin_name.empty()) + break; + + lldb::ScriptLanguage lang = + PluginManager::GetScriptedInterfaceLanguageAtIndex(i); + if (lang != m_options.m_language) + continue; + + llvm::StringRef desc = + PluginManager::GetScriptedInterfaceDescriptionAtIndex(i); + std::vector<llvm::StringRef> ci_usages = + PluginManager::GetScriptedInterfaceCommandInterpreterUsagesAtIndex(i); + std::vector<llvm::StringRef> api_usages = + PluginManager::GetScriptedInterfaceAPIUsagesAtIndex(i); + + print_field("Name", plugin_name); + print_field("Language", ScriptInterpreter::LanguageToString(lang)); + print_field("Description", desc); + print_usages("Command Interpreter", ci_usages); + print_usages("API", api_usages); + + if (i != num_templates - 1) + s.EOL(); + } + } + +private: + CommandOptions m_options; +}; + +#pragma mark CommandObjectMultiwordScriptingTemplate + +// CommandObjectMultiwordScriptingTemplate + +class CommandObjectMultiwordScriptingTemplate : public CommandObjectMultiword { +public: + CommandObjectMultiwordScriptingTemplate(CommandInterpreter &interpreter) + : CommandObjectMultiword( + interpreter, "scripting template", + "Commands for operating on the scripting templates.", + "scripting template [<subcommand-options>]") { + LoadSubCommand( + "list", + CommandObjectSP(new CommandObjectScriptingTemplateList(interpreter))); + } + + ~CommandObjectMultiwordScriptingTemplate() override = default; +}; + #pragma mark CommandObjectMultiwordScripting // CommandObjectMultiwordScripting @@ -139,6 +284,9 @@ CommandObjectMultiwordScripting::CommandObjectMultiwordScripting( "scripting <subcommand> [<subcommand-options>]") { LoadSubCommand("run", CommandObjectSP(new CommandObjectScriptingRun(interpreter))); + LoadSubCommand("template", + CommandObjectSP( + new CommandObjectMultiwordScriptingTemplate(interpreter))); } CommandObjectMultiwordScripting::~CommandObjectMultiwordScripting() = default; diff --git a/lldb/source/Commands/Options.td b/lldb/source/Commands/Options.td index 24e97f3bb97d3..6e5ed21b22ad8 100644 --- a/lldb/source/Commands/Options.td +++ b/lldb/source/Commands/Options.td @@ -841,6 +841,12 @@ let Command = "scripting run" in { " language. If none is specific the default scripting language is used.">; } +let Command = "scripting template list" in { + def scripting_template_list_language : Option<"language", "l">, + EnumArg<"ScriptLang">, Desc<"Specify the scripting " + " language. If none is specified the default scripting language is used.">; +} + let Command = "source info" in { def source_info_count : Option<"count", "c">, Arg<"Count">, Desc<"The number of line entries to display.">; diff --git a/lldb/source/Core/PluginManager.cpp b/lldb/source/Core/PluginManager.cpp index b428370d7f333..d7d4d16938c0c 100644 --- a/lldb/source/Core/PluginManager.cpp +++ b/lldb/source/Core/PluginManager.cpp @@ -1479,6 +1479,92 @@ LanguageSet PluginManager::GetAllTypeSystemSupportedLanguagesForExpressions() { return all; } +#pragma mark ScriptedInterfaces + +struct ScriptedInterfaceInstance + : public PluginInstance<ScriptedInterfaceCreateInstance> { + ScriptedInterfaceInstance( + llvm::StringRef name, llvm::StringRef description, + ScriptedInterfaceCreateInstance create_callback, + lldb::ScriptLanguage language, + std::vector<llvm::StringRef> command_interpreter_usages, + std::vector<llvm::StringRef> api_usages) + : PluginInstance<ScriptedInterfaceCreateInstance>(name, description, + create_callback), + language(language), + command_interpreter_usages(command_interpreter_usages), + api_usages(api_usages) {} + + lldb::ScriptLanguage language; + std::vector<llvm::StringRef> command_interpreter_usages; + std::vector<llvm::StringRef> api_usages; +}; + +typedef PluginInstances<ScriptedInterfaceInstance> ScriptedInterfaceInstances; + +static ScriptedInterfaceInstances &GetScriptedInterfaceInstances() { + static ScriptedInterfaceInstances g_instances; + return g_instances; +} + +bool PluginManager::RegisterPlugin( + llvm::StringRef name, llvm::StringRef description, + ScriptedInterfaceCreateInstance create_callback, + lldb::ScriptLanguage language, + std::vector<llvm::StringRef> command_interpreter_usages, + std::vector<llvm::StringRef> api_usages) { + return GetScriptedInterfaceInstances().RegisterPlugin( + name, description, create_callback, language, command_interpreter_usages, + api_usages); +} + +bool PluginManager::UnregisterPlugin( + ScriptedInterfaceCreateInstance create_callback) { + return GetScriptedInterfaceInstances().UnregisterPlugin(create_callback); +} + +ScriptedInterfaceCreateInstance +PluginManager::GetScriptedInterfaceCreateCallbackAtIndex(uint32_t idx) { + return GetScriptedInterfaceInstances().GetCallbackAtIndex(idx); +} + +uint32_t PluginManager::GetNumScriptedInterfaces() { + return GetScriptedInterfaceInstances().GetInstances().size(); +} + +llvm::StringRef PluginManager::GetScriptedInterfaceNameAtIndex(uint32_t index) { + return GetScriptedInterfaceInstances().GetNameAtIndex(index); +} + +llvm::StringRef +PluginManager::GetScriptedInterfaceDescriptionAtIndex(uint32_t index) { + return GetScriptedInterfaceInstances().GetDescriptionAtIndex(index); +} + +lldb::ScriptLanguage +PluginManager::GetScriptedInterfaceLanguageAtIndex(uint32_t idx) { + const auto &instances = GetScriptedInterfaceInstances().GetInstances(); + return idx < instances.size() ? instances[idx].language + : ScriptLanguage::eScriptLanguageNone; +} + +std::vector<llvm::StringRef> +PluginManager::GetScriptedInterfaceCommandInterpreterUsagesAtIndex( + uint32_t idx) { + const auto &instances = GetScriptedInterfaceInstances().GetInstances(); + if (idx >= instances.size()) + return {}; + return instances[idx].command_interpreter_usages; +} + +std::vector<llvm::StringRef> +PluginManager::GetScriptedInterfaceAPIUsagesAtIndex(uint32_t idx) { + const auto &instances = GetScriptedInterfaceInstances().GetInstances(); + if (idx >= instances.size()) + return {}; + return instances[idx].api_usages; +} + #pragma mark REPL struct REPLInstance : public PluginInstance<REPLCreateInstance> { @@ -1539,6 +1625,7 @@ void PluginManager::DebuggerInitialize(Debugger &debugger) { GetOperatingSystemInstances().PerformDebuggerCallback(debugger); GetStructuredDataPluginInstances().PerformDebuggerCallback(debugger); GetTracePluginInstances().PerformDebuggerCallback(debugger); + GetScriptedInterfaceInstances().PerformDebuggerCallback(debugger); } // This is the preferred new way to register plugin specific settings. e.g. diff --git a/lldb/source/Plugins/CMakeLists.txt b/lldb/source/Plugins/CMakeLists.txt index 854f589f45ae0..34dd8c1eb22f6 100644 --- a/lldb/source/Plugins/CMakeLists.txt +++ b/lldb/source/Plugins/CMakeLists.txt @@ -29,6 +29,9 @@ add_subdirectory(UnwindAssembly) set(LLDB_STRIPPED_PLUGINS) get_property(LLDB_ALL_PLUGINS GLOBAL PROPERTY LLDB_PLUGINS) +get_property(LLDB_EXTRA_PLUGINS GLOBAL PROPERTY LLDB_EXTRA_SCRIPT_PLUGINS) +list(APPEND LLDB_ALL_PLUGINS ${LLDB_EXTRA_PLUGINS}) + set(LLDB_ENUM_PLUGINS "") diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/CMakeLists.txt b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/CMakeLists.txt index c60e4bb503a37..c0ee9c8d0654d 100644 --- a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/CMakeLists.txt +++ b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/CMakeLists.txt @@ -19,6 +19,11 @@ if (LLDB_ENABLE_LIBEDIT) list(APPEND LLDB_LIBEDIT_LIBS LibEdit::LibEdit) endif() +set_property(GLOBAL PROPERTY LLDB_EXTRA_SCRIPT_PLUGINS + lldbPluginScriptedProcessPythonInterface + lldbPluginScriptedThreadPlanPythonInterface +) + add_lldb_library(lldbPluginScriptInterpreterPythonInterfaces OperatingSystemPythonInterface.cpp ScriptedPythonInterface.cpp diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.cpp b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.cpp index 313c597ce48f3..1464467fb3797 100644 --- a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.cpp +++ b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.cpp @@ -11,6 +11,7 @@ // LLDB Python header must be included first #include "../lldb-python.h" #endif +#include "lldb/Core/PluginManager.h" #include "lldb/Target/Process.h" #include "lldb/Utility/Log.h" #include "lldb/Utility/Status.h" @@ -29,6 +30,8 @@ using namespace lldb_private; using namespace lldb_private::python; using Locker = ScriptInterpreterPythonImpl::Locker; +LLDB_PLUGIN_DEFINE(ScriptedProcessPythonInterface) + ScriptedProcessPythonInterface::ScriptedProcessPythonInterface( ScriptInterpreterPythonImpl &interpreter) : ScriptedProcessInterface(), ScriptedPythonInterface(interpreter) {} @@ -208,4 +211,24 @@ StructuredData::DictionarySP ScriptedProcessPythonInterface::GetMetadata() { return dict; } +void ScriptedProcessPythonInterface::Initialize() { + const std::vector<llvm::StringRef> ci_usages = { + "process attach -C <script-name> [-k key -v value ...]", + "process launch -C <script-name> [-k key -v value ...]"}; + const std::vector<llvm::StringRef> api_usages = { + "SBAttachInfo.SetScriptedProcessClassName", + "SBAttachInfo.SetScriptedProcessDictionary", + "SBTarget.Attach", + "SBLaunchInfo.SetScriptedProcessClassName", + "SBLaunchInfo.SetScriptedProcessDictionary", + "SBTarget.Launch"}; + PluginManager::RegisterPlugin( + GetPluginNameStatic(), llvm::StringRef("Mock process state"), + CreateInstance, eScriptLanguagePython, ci_usages, api_usages); +} + +void ScriptedProcessPythonInterface::Terminate() { + PluginManager::UnregisterPlugin(CreateInstance); +} + #endif diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.h b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.h index c75caa9340f25..8bfc3f2c0757c 100644 --- a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.h +++ b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedProcessPythonInterface.h @@ -19,7 +19,8 @@ namespace lldb_private { class ScriptedProcessPythonInterface : public ScriptedProcessInterface, - public ScriptedPythonInterface { + public ScriptedPythonInterface, + public PluginInterface { public: ScriptedProcessPythonInterface(ScriptInterpreterPythonImpl &interpreter); @@ -67,6 +68,16 @@ class ScriptedProcessPythonInterface : public ScriptedProcessInterface, StructuredData::DictionarySP GetMetadata() override; + static void Initialize(); + + static void Terminate(); + + static llvm::StringRef GetPluginNameStatic() { + return "ScriptedProcessPythonInterface"; + } + + llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } + private: lldb::ScriptedThreadInterfaceSP CreateScriptedThreadInterface() override; }; diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.cpp b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.cpp index f23858c01277c..05b7fbaa37af3 100644 --- a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.cpp +++ b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.cpp @@ -18,11 +18,14 @@ #include "../SWIGPythonBridge.h" #include "../ScriptInterpreterPythonImpl.h" #include "ScriptedThreadPlanPythonInterface.h" +#include "lldb/Core/PluginManager.h" using namespace lldb; using namespace lldb_private; using namespace lldb_private::python; +LLDB_PLUGIN_DEFINE(ScriptedThreadPlanPythonInterface) + ScriptedThreadPlanPythonInterface::ScriptedThreadPlanPythonInterface( ScriptInterpreterPythonImpl &interpreter) : ScriptedThreadPlanInterface(), ScriptedPythonInterface(interpreter) {} @@ -102,4 +105,19 @@ ScriptedThreadPlanPythonInterface::GetStopDescription(lldb::StreamSP &stream) { return llvm::Error::success(); } +void ScriptedThreadPlanPythonInterface::Initialize() { + const std::vector<llvm::StringRef> ci_usages = { + "thread step-scripted -C <script-name> [-k key -v value ...]"}; + const std::vector<llvm::StringRef> api_usages = { + "SBThread.StepUsingScriptedThreadPlan"}; + PluginManager::RegisterPlugin( + GetPluginNameStatic(), + llvm::StringRef("Alter thread stepping logic and stop reason"), + CreateInstance, eScriptLanguagePython, ci_usages, api_usages); +} + +void ScriptedThreadPlanPythonInterface::Terminate() { + PluginManager::UnregisterPlugin(CreateInstance); +} + #endif diff --git a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.h b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.h index 6ec89b9f59253..4dc4607fb9c9d 100644 --- a/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.h +++ b/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedThreadPlanPythonInterface.h @@ -19,7 +19,8 @@ namespace lldb_private { class ScriptedThreadPlanPythonInterface : public ScriptedThreadPlanInterface, - public ScriptedPythonInterface { + public ScriptedPythonInterface, + public PluginInterface { public: ScriptedThreadPlanPythonInterface(ScriptInterpreterPythonImpl &interpreter); @@ -41,6 +42,16 @@ class ScriptedThreadPlanPythonInterface : public ScriptedThreadPlanInterface, lldb::StateType GetRunState() override; llvm::Error GetStopDescription(lldb::StreamSP &stream) override; + + static void Initialize(); + + static void Terminate(); + + static llvm::StringRef GetPluginNameStatic() { + return "ScriptedThreadPlanPythonInterface"; + } + + llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } }; } // namespace lldb_private _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits