Remove glob logic for plugin names

dmpots · dmpots · commit 9e7a6956c740 · 2025-04-11T17:32:49.000-07:00
We now only support matching plugin namespace or fully qualified names.
diff --git a/lldb/include/lldb/Interpreter/CommandOptionArgumentTable.h b/lldb/include/lldb/Interpreter/CommandOptionArgumentTable.h
@@ -314,6 +314,7 @@ static constexpr CommandObject::ArgumentTableEntry g_argument_table[] = {
     { lldb::eArgTypeModule, "module", lldb::CompletionType::eModuleCompletion, {}, { nullptr, false }, "The name of a module loaded into the current target." },
     { lldb::eArgTypeCPUName, "cpu-name", lldb::CompletionType::eNoCompletion, {}, { nullptr, false }, "The name of a CPU." },
     { lldb::eArgTypeCPUFeatures, "cpu-features", lldb::CompletionType::eNoCompletion, {}, { nullptr, false }, "The CPU feature string." },
+    { lldb::eArgTypeManagedPlugin, "managed-plugin", lldb::CompletionType::eNoCompletion, {}, { nullptr, false }, "Plugins managed by the PluginManager" },
     // clang-format on
 };
 
diff --git a/lldb/include/lldb/lldb-enumerations.h b/lldb/include/lldb/lldb-enumerations.h
@@ -663,6 +663,7 @@ enum CommandArgumentType {
   eArgTypeModule,
   eArgTypeCPUName,
   eArgTypeCPUFeatures,
+  eArgTypeManagedPlugin,
   eArgTypeLastArg // Always keep this entry as the last entry in this
                   // enumeration!!
 };
diff --git a/lldb/source/Commands/CommandObjectPlugin.cpp b/lldb/source/Commands/CommandObjectPlugin.cpp
@@ -50,63 +50,34 @@ class CommandObjectPluginLoad : public CommandObjectParsed {
 };
 
 namespace {
-#define LLDB_OPTIONS_plugin_list
-#include "CommandOptions.inc"
-
-// These option definitions are shared by the plugin list/enable/disable
-// commands.
-class PluginListCommandOptions : public Options {
-public:
-  PluginListCommandOptions() = default;
-
-  ~PluginListCommandOptions() 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 'x':
-      m_exact_name_match = true;
-      break;
-    default:
-      llvm_unreachable("Unimplemented option");
-    }
-
-    return error;
-  }
-
-  void OptionParsingStarting(ExecutionContext *execution_context) override {
-    m_exact_name_match = false;
-  }
-
-  llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
-    return llvm::ArrayRef(g_plugin_list_options);
-  }
-
-  // Instance variables to hold the values for command options.
-  bool m_exact_name_match = false;
-};
-
 // Helper function to perform an action on each matching plugin.
 // The action callback is given the containing namespace along with plugin info
 // for each matching plugin.
 static int ActOnMatchingPlugins(
-    llvm::GlobPattern pattern,
+    const llvm::StringRef pattern,
     std::function<void(const PluginNamespace &plugin_namespace,
                        const std::vector<RegisteredPluginInfo> &plugin_info)>
         action) {
   int num_matching = 0;
 
   for (const PluginNamespace &plugin_namespace :
        PluginManager::GetPluginNamespaces()) {
+    const bool match_namespace =
+        pattern.empty() || pattern == plugin_namespace.name;
+
     std::vector<RegisteredPluginInfo> matching_plugins;
     for (const RegisteredPluginInfo &plugin_info :
          plugin_namespace.get_info()) {
-      std::string qualified_name =
-          (plugin_namespace.name + "." + plugin_info.name).str();
-      if (pattern.match(qualified_name))
+
+      // If we match the namespace, we can skip the plugin name check.
+      bool match_qualified_name = false;
+      if (!match_namespace) {
+        std::string qualified_name =
+            (plugin_namespace.name + "." + plugin_info.name).str();
+        match_qualified_name = pattern == qualified_name;
+      }
+
+      if (match_namespace || match_qualified_name)
         matching_plugins.push_back(plugin_info);
     }
 
@@ -119,58 +90,10 @@ static int ActOnMatchingPlugins(
   return num_matching;
 }
 
-// Return a string in glob syntax for matching plugins.
-static std::string GetPluginNamePatternString(llvm::StringRef user_input,
-                                              bool add_default_glob) {
-  std::string pattern_str = user_input.empty() ? "*" : user_input.str();
-
-  if (add_default_glob && pattern_str != "*")
-    pattern_str = "*" + pattern_str + "*";
-
-  return pattern_str;
-}
-
-// Attempts to create a glob pattern for a plugin name based on plugin command
-// input. Writes an error message to the `result` object if the glob cannot be
-// created successfully.
-//
-// The `glob_storage` is used to hold the string data for the glob pattern. The
-// llvm::GlobPattern only contains pointers into the string data so we need a
-// stable location that can outlive the glob pattern itself.
-std::optional<llvm::GlobPattern>
-TryCreatePluginPattern(const char *plugin_command_name, const Args &command,
-                       const PluginListCommandOptions &options,
-                       CommandReturnObject &result, std::string &glob_storage) {
-  size_t argc = command.GetArgumentCount();
-  if (argc > 1) {
-    result.AppendErrorWithFormat("'%s' requires one argument",
-                                 plugin_command_name);
-    return {};
-  }
-
-  llvm::StringRef user_pattern = argc == 1 ? command[0].ref() : "";
-
-  glob_storage =
-      GetPluginNamePatternString(user_pattern, !options.m_exact_name_match);
-
-  auto glob_pattern = llvm::GlobPattern::create(glob_storage);
-
-  if (auto error = glob_pattern.takeError()) {
-    std::string error_message =
-        (llvm::Twine("Invalid plugin glob pattern: '") + glob_storage +
-         "': " + llvm::toString(std::move(error)))
-            .str();
-    result.AppendError(error_message);
-    return {};
-  }
-
-  return *glob_pattern;
-}
-
 // Call the "SetEnable" function for each matching plugins.
 // Used to share the majority of the code between the enable
 // and disable commands.
-int SetEnableOnMatchingPlugins(const llvm::GlobPattern &pattern,
+int SetEnableOnMatchingPlugins(const llvm::StringRef &pattern,
                                CommandReturnObject &result, bool enabled) {
   return ActOnMatchingPlugins(
       pattern, [&](const PluginNamespace &plugin_namespace,
@@ -198,7 +121,7 @@ class CommandObjectPluginList : public CommandObjectParsed {
       : CommandObjectParsed(interpreter, "plugin list",
                             "Report info about registered LLDB plugins.",
                             nullptr) {
-    AddSimpleArgumentList(eArgTypePlugin);
+    AddSimpleArgumentList(eArgTypeManagedPlugin);
     SetHelpLong(R"(
 Display information about registered plugins.
 The plugin information is formatted as shown below:
@@ -211,54 +134,41 @@ An enabled plugin is marked with [+] and a disabled plugin is marked with [-].
 
 Plugins can be listed by namespace and name with:
 
-  plugin list [<plugin-namespace>.][<plugin-name>]
+  plugin list <plugin-namespace>[.<plugin-name>]
 
-Plugin names are specified using glob patterns. The pattern will be matched
-against the plugins fully qualified name, which is composed of the namespace,
-followed by a '.', followed by the plugin name.
-
-When no arguments are given the plugin selection string is the wildcard '*'.
-By default wildcards are added around the input to enable searching by
-substring. You can prevent these implicit wild cards by using the
--x flag.
+Plugins can be listed by namespace alone or with a fully qualified name. When listed
+with just a namespace all plugins in that namespace are listed.  When no arguments
+are given all plugins are listed.
 
 Examples:
-List all plugins in the system-runtime namespace
-
-  (lldb) plugin list system-runtime.*
+List all plugins
 
-List all plugins containing the string foo
+  (lldb) plugin list
 
-  (lldb) plugin list foo
-
-This is equivalent to
+List all plugins in the system-runtime namespace
 
-  (lldb) plugin list *foo*
+  (lldb) plugin list system-runtime
 
-List only a plugin matching a fully qualified name exactly
+List only the plugin 'foo' matching a fully qualified name exactly
 
-  (lldb) plugin list -x system-runtime.foo
+  (lldb) plugin list system-runtime.foo
 )");
   }
 
   ~CommandObjectPluginList() override = default;
 
-  Options *GetOptions() override { return &m_options; }
-
 protected:
   void DoExecute(Args &command, CommandReturnObject &result) override {
-    std::string glob_storage;
-    std::optional<llvm::GlobPattern> plugin_glob = TryCreatePluginPattern(
-        "plugin list", command, m_options, result, glob_storage);
-
-    if (!plugin_glob) {
-      assert(!result.Succeeded());
+    size_t argc = command.GetArgumentCount();
+    if (argc > 1) {
+      result.AppendError("'plugin load' requires one argument");
       return;
     }
+    llvm::StringRef pattern = argc ? command[0].ref() : "";
 
     int num_matching = ActOnMatchingPlugins(
-        *plugin_glob, [&](const PluginNamespace &plugin_namespace,
-                          const std::vector<RegisteredPluginInfo> &plugins) {
+        pattern, [&](const PluginNamespace &plugin_namespace,
+                     const std::vector<RegisteredPluginInfo> &plugins) {
           result.AppendMessage(plugin_namespace.name);
           for (auto &plugin : plugins) {
             result.AppendMessageWithFormat(
@@ -271,73 +181,59 @@ List only a plugin matching a fully qualified name exactly
       result.AppendErrorWithFormat("Found no matching plugins");
     }
   }
-
-  PluginListCommandOptions m_options;
 };
 
 class CommandObjectPluginEnable : public CommandObjectParsed {
 public:
   CommandObjectPluginEnable(CommandInterpreter &interpreter)
       : CommandObjectParsed(interpreter, "plugin enable",
                             "Enable registered LLDB plugins.", nullptr) {
-    AddSimpleArgumentList(eArgTypePlugin);
+    AddSimpleArgumentList(eArgTypeManagedPlugin);
   }
 
   ~CommandObjectPluginEnable() override = default;
 
-  Options *GetOptions() override { return &m_options; }
-
 protected:
   void DoExecute(Args &command, CommandReturnObject &result) override {
-    std::string glob_storage;
-    std::optional<llvm::GlobPattern> plugin_glob = TryCreatePluginPattern(
-        "plugin enable", command, m_options, result, glob_storage);
-
-    if (!plugin_glob) {
-      assert(!result.Succeeded());
+    size_t argc = command.GetArgumentCount();
+    if (argc > 1) {
+      result.AppendError("'plugin enable' requires one argument");
       return;
     }
+    llvm::StringRef pattern = argc ? command[0].ref() : "";
 
-    int num_matching = SetEnableOnMatchingPlugins(*plugin_glob, result, true);
+    int num_matching = SetEnableOnMatchingPlugins(pattern, result, true);
 
     if (num_matching == 0) {
       result.AppendErrorWithFormat("Found no matching plugins to enable");
     }
   }
-
-  PluginListCommandOptions m_options;
 };
 
 class CommandObjectPluginDisable : public CommandObjectParsed {
 public:
   CommandObjectPluginDisable(CommandInterpreter &interpreter)
       : CommandObjectParsed(interpreter, "plugin disable",
                             "Disable registered LLDB plugins.", nullptr) {
-    AddSimpleArgumentList(eArgTypePlugin);
+    AddSimpleArgumentList(eArgTypeManagedPlugin);
   }
 
   ~CommandObjectPluginDisable() override = default;
 
-  Options *GetOptions() override { return &m_options; }
-
 protected:
   void DoExecute(Args &command, CommandReturnObject &result) override {
-    std::string glob_storage;
-    std::optional<llvm::GlobPattern> plugin_glob = TryCreatePluginPattern(
-        "plugin disable", command, m_options, result, glob_storage);
-
-    if (!plugin_glob) {
-      assert(!result.Succeeded());
+    size_t argc = command.GetArgumentCount();
+    if (argc > 1) {
+      result.AppendError("'plugin disable' requires one argument");
       return;
     }
+    llvm::StringRef pattern = argc ? command[0].ref() : "";
 
-    int num_matching = SetEnableOnMatchingPlugins(*plugin_glob, result, false);
+    int num_matching = SetEnableOnMatchingPlugins(pattern, result, false);
 
     if (num_matching == 0)
       result.AppendErrorWithFormat("Found no matching plugins to disable");
   }
-
-  PluginListCommandOptions m_options;
 };
 
 CommandObjectPlugin::CommandObjectPlugin(CommandInterpreter &interpreter)
diff --git a/lldb/test/Shell/Commands/command-plugin-enable+disable.test b/lldb/test/Shell/Commands/command-plugin-enable+disable.test
@@ -14,8 +14,8 @@ plugin list
 # CHECK:  [+] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
 # Test plugin disable disables a plugin.
-plugin disable systemruntime-macosx
-# CHECK-LABEL: plugin disable systemruntime-macosx
+plugin disable system-runtime.systemruntime-macosx
+# CHECK-LABEL: plugin disable system-runtime.systemruntime-macosx
 # CHECK: system-runtime
 # CHECK:  [-] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
@@ -25,8 +25,8 @@ plugin list
 # CHECK:  [-] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
 # Test plugin enable re-enables a plugin.
-plugin enable systemruntime-macosx
-# CHECK-LABEL: plugin enable systemruntime-macosx
+plugin enable system-runtime.systemruntime-macosx
+# CHECK-LABEL: plugin enable system-runtime.systemruntime-macosx
 # CHECK: system-runtime
 # CHECK:  [+] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
@@ -35,15 +35,15 @@ plugin list
 # CHECK: system-runtime
 # CHECK:  [+] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
-# Test plugin disable with wildcard works.
-plugin disable system*
-# CHECK-LABEL: plugin disable system*
+# Test plugin disable with namespace works.
+plugin disable system-runtime
+# CHECK-LABEL: plugin disable system-runtime
 # CHECK: system-runtime
 # CHECK:  [-] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
-# Test plugin enable with wildcard works.
-plugin enable system*
-# CHECK-LABEL: plugin enable system*
+# Test plugin enable with namespace works.
+plugin enable system-runtime
+# CHECK-LABEL: plugin enable system-runtime
 # CHECK: system-runtime
 # CHECK:  [+] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
diff --git a/lldb/test/Shell/Commands/command-plugin-list.test b/lldb/test/Shell/Commands/command-plugin-list.test
