From da60878c4cb4cb4b47c4774a1d52c93a086aa0df Mon Sep 17 00:00:00 2001
From: Erik Skultety <eskultet@redhat.com>
Date: Thu, 25 Jan 2018 16:08:46 +0100
Subject: [PATCH] vsh: Drop redundant definition searches from
 vshCmd{def,Grp}Help

These helpers are called from a single place only - cmdHelp wrapper and
just before the wrapper invokes the helpers, it performs the search,
either for command group or for the command itself, except the result is
discarded and the helper therefore needs to do it again. Drop this
inefficient handling and pass the @def structure rather than a name,
thus preventing the helper from needing to perform the search again.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
---
 tools/vsh.c | 43 +++++++++++++++----------------------------
 tools/vsh.h |  4 ++--
 2 files changed, 17 insertions(+), 30 deletions(-)

diff --git a/tools/vsh.c b/tools/vsh.c
index 058df7ef6f..761d2ec3a4 100644
--- a/tools/vsh.c
+++ b/tools/vsh.c
@@ -629,44 +629,32 @@ vshCmdGrpSearch(const char *grpname)
 }
 
 bool
-vshCmdGrpHelp(vshControl *ctl, const char *grpname)
+vshCmdGrpHelp(vshControl *ctl, const vshCmdGrp *grp)
 {
-    const vshCmdGrp *grp = vshCmdGrpSearch(grpname);
     const vshCmdDef *cmd = NULL;
 
-    if (!grp) {
-        vshError(ctl, _("command group '%s' doesn't exist"), grpname);
-        return false;
-    } else {
-        vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
-                 grp->keyword);
+    vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
+             grp->keyword);
 
-        for (cmd = grp->commands; cmd->name; cmd++) {
-            if (cmd->flags & VSH_CMD_FLAG_ALIAS)
-                continue;
-            vshPrint(ctl, "    %-30s %s\n", cmd->name,
-                     _(vshCmddefGetInfo(cmd, "help")));
-        }
+    for (cmd = grp->commands; cmd->name; cmd++) {
+        if (cmd->flags & VSH_CMD_FLAG_ALIAS)
+            continue;
+        vshPrint(ctl, "    %-30s %s\n", cmd->name,
+                 _(vshCmddefGetInfo(cmd, "help")));
     }
 
     return true;
 }
 
 bool
-vshCmddefHelp(vshControl *ctl, const char *cmdname)
+vshCmddefHelp(vshControl *ctl, const vshCmdDef *def)
 {
-    const vshCmdDef *def = vshCmddefSearch(cmdname);
     const char *desc = NULL;
     char buf[256];
     uint64_t opts_need_arg;
     uint64_t opts_required;
     bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
 
-    if (!def) {
-        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
-        return false;
-    }
-
     if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
         vshError(ctl, _("internal error: bad options in command: '%s'"),
                  def->name);
@@ -3181,12 +3169,11 @@ const vshCmdInfo info_help[] = {
 bool
 cmdHelp(vshControl *ctl, const vshCmd *cmd)
 {
+    const vshCmdDef *def = NULL;
+    const vshCmdGrp *grp = NULL;
     const char *name = NULL;
 
     if (vshCommandOptStringQuiet(ctl, cmd, "command", &name) <= 0) {
-        const vshCmdGrp *grp;
-        const vshCmdDef *def;
-
         vshPrint(ctl, "%s", _("Grouped commands:\n\n"));
 
         for (grp = cmdGroups; grp->name; grp++) {
@@ -3206,10 +3193,10 @@ cmdHelp(vshControl *ctl, const vshCmd *cmd)
         return true;
     }
 
-    if (vshCmddefSearch(name)) {
-        return vshCmddefHelp(ctl, name);
-    } else if (vshCmdGrpSearch(name)) {
-        return vshCmdGrpHelp(ctl, name);
+    if ((def = vshCmddefSearch(name))) {
+        return vshCmddefHelp(ctl, def);
+    } else if ((grp = vshCmdGrpSearch(name))) {
+        return vshCmdGrpHelp(ctl, grp);
     } else {
         vshError(ctl, _("command or command group '%s' doesn't exist"), name);
         return false;
diff --git a/tools/vsh.h b/tools/vsh.h
index 6894700d90..694476471b 100644
--- a/tools/vsh.h
+++ b/tools/vsh.h
@@ -257,9 +257,9 @@ void vshCloseLogFile(vshControl *ctl);
 
 const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
 const vshCmdDef *vshCmddefSearch(const char *cmdname);
-bool vshCmddefHelp(vshControl *ctl, const char *name);
+bool vshCmddefHelp(vshControl *ctl, const vshCmdDef *def);
 const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
-bool vshCmdGrpHelp(vshControl *ctl, const char *name);
+bool vshCmdGrpHelp(vshControl *ctl, const vshCmdGrp *grp);
 
 int vshCommandOptInt(vshControl *ctl, const vshCmd *cmd,
                      const char *name, int *value)