[libvirt] [PATCH 00/18] Make bash completion great again
Technically, this is a v2 of [1], but this implements the feature from different angle and therefore it's a start of new series. What's implemented? =================== Auto completion for both interactive and non-interactive virsh/virt-admin. Known limitations ================= Currently, just options completers work. I mean, to bring up list of domains you have to: virsh # start --domain <TAB><TAB> Doing bare: virsh # start <TAB><TAB> brings up list of --options. With the new approach implemented here it should be easy to implement this. But that can be saved for later. How to test this? ================= Interactive completion should work out of the box. Just make sure you're connected. Completers don't connect! You certainly don't want ssh's 'Password:' prompt show on <TAB><TAB>, do you? Non-interactive completers do connect, but in order to avoid any password prompts, /dev/stdin is closed before anything else is done. In order to test it, just: libvirt.git $ source tools/bash-completion/vsh Now, bash completion should work: libvirt.git $ ./tools/virsh -c qemu:///system start --domain <TAB><TAB> Notes ===== As usual, you can find all the patches on my github [2]. I've tried to work in all the review suggestions from v1. Due to changes in design (reusing parse code instead of duplicating it) not all suggestions were possible to work in though. Michal 1: https://www.redhat.com/archives/libvir-list/2017-November/msg00213.html 2: https://github.com/zippy2/libvirt/tree/bash_autocomplete_v3 (yeah v3, don't ask) Michal Privoznik (18): vsh: Drop useless check for opts != NULL vsh: Drop useless check for cmd != NULL vshCommandParse: Don't leak @tkdata vshCommandStringParse: Allow retrieving partial result vshReadlineParse: Drop code duplication vshReadlineParse: Escape returned results if needed vshReadlineParse: Use string list vshCommandOpt: Allow caller avoiding assert() util: Introduce virStringListMerge vsh: Fix vshCompleter signature vsh: Call vshCmdOptDef completer vsh: Prune string list returned by completer vsh: Filter --options vsh: Introduce complete command tools: Provide bash autompletion file virsh: Introduce virshDomainNameCompleter virsh: Introduce virshDomainInterfaceCompleter virt-admin: Introduce vshAdmServerCompleter configure.ac | 3 + libvirt.spec.in | 3 + m4/virt-bash-completion.m4 | 74 +++++ src/libvirt_private.syms | 1 + src/util/virstring.c | 36 +++ src/util/virstring.h | 3 + tools/Makefile.am | 40 ++- tools/bash-completion/vsh | 67 +++++ tools/virsh-completer.c | 150 ++++++++++ tools/virsh-completer.h | 41 +++ tools/virsh-domain-monitor.c | 33 ++- tools/virsh-domain.c | 186 ++++++------ tools/virsh-snapshot.c | 24 +- tools/virsh.c | 5 +- tools/virsh.h | 7 +- tools/virt-admin-completer.c | 76 +++++ tools/virt-admin-completer.h | 33 +++ tools/virt-admin.c | 13 +- tools/vsh.c | 663 ++++++++++++++++++++++++++----------------- tools/vsh.h | 23 +- 20 files changed, 1097 insertions(+), 384 deletions(-) create mode 100644 m4/virt-bash-completion.m4 create mode 100644 tools/bash-completion/vsh create mode 100644 tools/virsh-completer.c create mode 100644 tools/virsh-completer.h create mode 100644 tools/virt-admin-completer.c create mode 100644 tools/virt-admin-completer.h -- 2.13.6
All our internal *Free() functions are capable of handling NULL. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index e878119b9..e38dcec92 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -799,8 +799,7 @@ vshCommandFree(vshCmd *cmd) c = c->next; - if (tmp->opts) - vshCommandOptFree(tmp->opts); + vshCommandOptFree(tmp->opts); VIR_FREE(tmp); } } @@ -1581,8 +1580,7 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) vshCommandFree(ctl->cmd); ctl->cmd = NULL; } - if (first) - vshCommandOptFree(first); + vshCommandOptFree(first); VIR_FREE(tkdata); return false; } -- 2.13.6
All our internal *Free() functions are capable of handling NULL. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index e38dcec92..a21e1d1de 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -1392,10 +1392,8 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) vshCmd *clast = NULL; vshCmdOpt *first = NULL; - if (ctl->cmd) { - vshCommandFree(ctl->cmd); - ctl->cmd = NULL; - } + vshCommandFree(ctl->cmd); + ctl->cmd = NULL; while (1) { vshCmdOpt *last = NULL; @@ -1576,10 +1574,8 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) return true; syntaxError: - if (ctl->cmd) { - vshCommandFree(ctl->cmd); - ctl->cmd = NULL; - } + vshCommandFree(ctl->cmd); + ctl->cmd = NULL; vshCommandOptFree(first); VIR_FREE(tkdata); return false; -- 2.13.6
When parsing cmd line which has "--" on it, this is leaked. Problem is, parser->getNextArg() allocates new string and stores it into tkdata. But as soon as "--" is detected 'continue' is issued without any free of the allocated memory. ==5304== 3 bytes in 1 blocks are definitely lost in loss record 1 of 782 ==5304== at 0x4C2AF50: malloc (vg_replace_malloc.c:299) ==5304== by 0x8BB5AA9: strdup (strdup.c:42) ==5304== by 0x55842CA: virStrdup (virstring.c:941) ==5304== by 0x172B21: _vshStrdup (vsh.c:162) ==5304== by 0x175E8E: vshCommandArgvGetArg (vsh.c:1622) ==5304== by 0x17551D: vshCommandParse (vsh.c:1418) ==5304== by 0x175F25: vshCommandArgvParse (vsh.c:1638) ==5304== by 0x130940: virshParseArgv (virsh.c:820) ==5304== by 0x130C49: main (virsh.c:922) Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/vsh.c b/tools/vsh.c index a21e1d1de..2366b7b71 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -1491,6 +1491,7 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) } } else if (tkdata[0] == '-' && tkdata[1] == '-' && tkdata[2] == '\0') { + VIR_FREE(tkdata); data_only = true; continue; } else { -- 2.13.6
In the future, this function is going to be called from vshReadlineParse() to provide parsed input for completer callbacks. The idea is to allow the callbacks to provide more specific data. For instance, for the following input: virsh # domifaddr --domain fedora --interface <TAB><TAB> the --interface completer callback is going to be called. Now, it is more user friendly if the completer offers only those interfaces found in 'fedora' domain. But in order to do that it needs to be able to retrieve partially parsed result. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/virsh.c | 4 +- tools/virt-admin.c | 4 +- tools/vsh.c | 111 +++++++++++++++++++++++++++++++++++++---------------- tools/vsh.h | 2 +- 4 files changed, 82 insertions(+), 39 deletions(-) diff --git a/tools/virsh.c b/tools/virsh.c index 89a2bea10..933d6b4c9 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -817,7 +817,7 @@ virshParseArgv(vshControl *ctl, int argc, char **argv) ctl->imode = false; if (argc - optind == 1) { vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]); - return vshCommandStringParse(ctl, argv[optind]); + return vshCommandStringParse(ctl, argv[optind], NULL); } else { return vshCommandArgvParse(ctl, argc - optind, argv + optind); } @@ -954,7 +954,7 @@ main(int argc, char **argv) #if WITH_READLINE add_history(ctl->cmdstr); #endif - if (vshCommandStringParse(ctl, ctl->cmdstr)) + if (vshCommandStringParse(ctl, ctl->cmdstr, NULL)) vshCommandRun(ctl, ctl->cmd); } VIR_FREE(ctl->cmdstr); diff --git a/tools/virt-admin.c b/tools/virt-admin.c index e529a2891..b8b33af19 100644 --- a/tools/virt-admin.c +++ b/tools/virt-admin.c @@ -1335,7 +1335,7 @@ vshAdmParseArgv(vshControl *ctl, int argc, char **argv) ctl->imode = false; if (argc - optind == 1) { vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]); - return vshCommandStringParse(ctl, argv[optind]); + return vshCommandStringParse(ctl, argv[optind], NULL); } else { return vshCommandArgvParse(ctl, argc - optind, argv + optind); } @@ -1555,7 +1555,7 @@ main(int argc, char **argv) #if WITH_READLINE add_history(ctl->cmdstr); #endif - if (vshCommandStringParse(ctl, ctl->cmdstr)) + if (vshCommandStringParse(ctl, ctl->cmdstr, NULL)) vshCommandRun(ctl, ctl->cmd); } VIR_FREE(ctl->cmdstr); diff --git a/tools/vsh.c b/tools/vsh.c index 2366b7b71..34eb592ef 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -1386,26 +1386,34 @@ struct _vshCommandParser { }; static bool -vshCommandParse(vshControl *ctl, vshCommandParser *parser) +vshCommandParse(vshControl *ctl, vshCommandParser *parser, vshCmd **partial) { char *tkdata = NULL; vshCmd *clast = NULL; vshCmdOpt *first = NULL; + const vshCmdDef *cmd = NULL; - vshCommandFree(ctl->cmd); - ctl->cmd = NULL; + if (!partial) { + vshCommandFree(ctl->cmd); + ctl->cmd = NULL; + } while (1) { vshCmdOpt *last = NULL; - const vshCmdDef *cmd = NULL; vshCommandToken tk; bool data_only = false; uint64_t opts_need_arg = 0; uint64_t opts_required = 0; uint64_t opts_seen = 0; + cmd = NULL; first = NULL; + if (partial) { + vshCommandFree(*partial); + *partial = NULL; + } + while (1) { const vshCmdOptDef *opt = NULL; @@ -1422,7 +1430,8 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) if (cmd == NULL) { /* first token must be command name */ if (!(cmd = vshCmddefSearch(tkdata))) { - vshError(ctl, _("unknown command: '%s'"), tkdata); + if (!partial) + vshError(ctl, _("unknown command: '%s'"), tkdata); goto syntaxError; /* ... or ignore this command only? */ } @@ -1434,9 +1443,10 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) } if (vshCmddefOptParse(cmd, &opts_need_arg, &opts_required) < 0) { - vshError(ctl, - _("internal error: bad options in command: '%s'"), - tkdata); + if (!partial) + vshError(ctl, + _("internal error: bad options in command: '%s'"), + tkdata); goto syntaxError; } VIR_FREE(tkdata); @@ -1454,7 +1464,7 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) /* Special case 'help' to ignore all spurious options */ if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2, &opts_seen, &opt_index, - &optstr, true))) { + &optstr, partial == NULL))) { VIR_FREE(optstr); if (STREQ(cmd->name, "help")) continue; @@ -1471,11 +1481,24 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) if (tk == VSH_TK_ERROR) goto syntaxError; if (tk != VSH_TK_ARG) { - vshError(ctl, - _("expected syntax: --%s <%s>"), - opt->name, - opt->type == - VSH_OT_INT ? _("number") : _("string")); + if (partial) { + vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt)); + arg->def = opt; + arg->data = tkdata; + tkdata = NULL; + arg->next = NULL; + if (!first) + first = arg; + if (last) + last->next = arg; + last = arg; + } else { + vshError(ctl, + _("expected syntax: --%s <%s>"), + opt->name, + opt->type == + VSH_OT_INT ? _("number") : _("string")); + } goto syntaxError; } if (opt->type != VSH_OT_ARGV) @@ -1483,8 +1506,9 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) } else { tkdata = NULL; if (optstr) { - vshError(ctl, _("invalid '=' after option --%s"), - opt->name); + if (!partial) + vshError(ctl, _("invalid '=' after option --%s"), + opt->name); VIR_FREE(optstr); goto syntaxError; } @@ -1500,7 +1524,8 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) if (!(opt = vshCmddefGetData(cmd, &opts_need_arg, &opts_seen)) && STRNEQ(cmd->name, "help")) { - vshError(ctl, _("unexpected data '%s'"), tkdata); + if (!partial) + vshError(ctl, _("unexpected data '%s'"), tkdata); goto syntaxError; } } @@ -1519,11 +1544,12 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) last->next = arg; last = arg; - vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n", - cmd->name, - opt->name, - opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"), - opt->type != VSH_OT_BOOL ? arg->data : _("(none)")); + if (ctl) + vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n", + cmd->name, + opt->name, + opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"), + opt->type != VSH_OT_BOOL ? arg->data : _("(none)")); } } @@ -1555,17 +1581,24 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) c->opts = first; c->def = cmd; c->next = NULL; + first = NULL; - if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) { + if (!partial && + vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) { VIR_FREE(c); goto syntaxError; } - if (!ctl->cmd) - ctl->cmd = c; - if (clast) - clast->next = c; - clast = c; + if (partial) { + vshCommandFree(*partial); + *partial = c; + } else { + if (!ctl->cmd) + ctl->cmd = c; + if (clast) + clast->next = c; + clast = c; + } } if (tk == VSH_TK_END) @@ -1575,9 +1608,19 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) return true; syntaxError: - vshCommandFree(ctl->cmd); - ctl->cmd = NULL; - vshCommandOptFree(first); + if (partial) { + vshCmd *tmp; + + tmp = vshMalloc(ctl, sizeof(*tmp)); + tmp->opts = first; + tmp->def = cmd; + + *partial = tmp; + } else { + vshCommandFree(ctl->cmd); + ctl->cmd = NULL; + vshCommandOptFree(first); + } VIR_FREE(tkdata); return false; } @@ -1612,7 +1655,7 @@ vshCommandArgvParse(vshControl *ctl, int nargs, char **argv) parser.arg_pos = argv; parser.arg_end = argv + nargs; parser.getNextArg = vshCommandArgvGetArg; - return vshCommandParse(ctl, &parser); + return vshCommandParse(ctl, &parser, NULL); } /* ---------------------- @@ -1684,7 +1727,7 @@ vshCommandStringGetArg(vshControl *ctl, vshCommandParser *parser, char **res, } bool -vshCommandStringParse(vshControl *ctl, char *cmdstr) +vshCommandStringParse(vshControl *ctl, char *cmdstr, vshCmd **partial) { vshCommandParser parser; @@ -1693,7 +1736,7 @@ vshCommandStringParse(vshControl *ctl, char *cmdstr) parser.pos = cmdstr; parser.getNextArg = vshCommandStringGetArg; - return vshCommandParse(ctl, &parser); + return vshCommandParse(ctl, &parser, partial); } /** diff --git a/tools/vsh.h b/tools/vsh.h index ab755bccf..8f7df9ff8 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -299,7 +299,7 @@ int vshBlockJobOptionBandwidth(vshControl *ctl, unsigned long *bandwidth); bool vshCommandOptBool(const vshCmd *cmd, const char *name); bool vshCommandRun(vshControl *ctl, const vshCmd *cmd); -bool vshCommandStringParse(vshControl *ctl, char *cmdstr); +bool vshCommandStringParse(vshControl *ctl, char *cmdstr, vshCmd **partial); const vshCmdOpt *vshCommandOptArgv(vshControl *ctl, const vshCmd *cmd, const vshCmdOpt *opt); -- 2.13.6
Now that we have a way of retrieving partly parsed command we don't need duplicate code that parses the user's input. Yes, this code removes call of opt's completer, but: a) current implementation is broken anyway, and b) it will be added back shortly Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 214 +++++++----------------------------------------------------- 1 file changed, 24 insertions(+), 190 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index 34eb592ef..c3423d6e3 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2697,216 +2697,50 @@ vshReadlineOptionsGenerator(const char *text, int state, const vshCmdDef *cmd_pa static char * vshReadlineParse(const char *text, int state) { - static vshCommandParser parser, sanitizer; - vshCommandToken tk; + static vshCmd *partial; static const vshCmdDef *cmd; - const vshCmdOptDef *opt = NULL; - char *tkdata, *optstr, *const_tkdata, *completed_name; char *res = NULL; - static char *ctext, *sanitized_text; - static char **completed_list; - static unsigned int completed_list_index; - static uint64_t const_opts_need_arg, const_opts_required, const_opts_seen; - uint64_t opts_seen; - size_t opt_index; - static bool cmd_exists, opts_filled, opt_exists; - static bool non_bool_opt_exists, data_complete; if (!state) { - parser.pos = rl_line_buffer; - parser.getNextArg = vshCommandStringGetArg; - - ctext = vshStrdup(NULL, text); - sanitizer.pos = ctext; - sanitizer.getNextArg = vshCommandStringGetArg; - - const_tkdata = NULL; - tkdata = NULL; - sanitized_text = NULL; - optstr = NULL; - - completed_list = NULL; - completed_list_index = 0; - - /* Sanitize/de-quote the autocomplete text */ - tk = sanitizer.getNextArg(NULL, &sanitizer, &sanitized_text, false); - - /* No autocomplete if sanitized text is a token error or token end */ - if (tk == VSH_TK_ERROR) - goto error; - - tk = parser.getNextArg(NULL, &parser, &const_tkdata, false); - - if (tk == VSH_TK_ERROR) - goto error; - - /* Free-ing purposes */ - tkdata = const_tkdata; - /* Skip leading space */ - virSkipSpaces((const char**)&tkdata); - - /* Handle ';'s */ - while (tk == VSH_TK_SUBCMD_END) { - tk = parser.getNextArg(NULL, &parser, &const_tkdata, false); - tkdata = const_tkdata; - } - - /* Skip trailing space after ;*/ - virSkipSpaces((const char**)&tkdata); - - cmd_exists = false; - opts_filled = false; - non_bool_opt_exists = false; - data_complete = false; - - const_opts_need_arg = 0; - const_opts_required = 0; - const_opts_seen = 0; - - opt_index = 0; + char *buf = vshStrdup(NULL, rl_line_buffer); + vshCommandFree(partial); + partial = NULL; cmd = NULL; - opt = NULL; - /* Parse till text to be auto-completed is reached */ - while (STRNEQ(tkdata, sanitized_text)) { - if (!cmd) { - if (!(cmd = vshCmddefSearch(tkdata))) - goto error; - if (cmd->flags & VSH_CMD_FLAG_ALIAS) - cmd = vshCmddefSearch(cmd->alias); + *(buf + rl_point) = '\0'; - cmd_exists = true; - if (vshCmddefOptParse(cmd, &const_opts_need_arg, - &const_opts_required) < 0) - goto error; - opts_seen = const_opts_seen; - opts_filled = true; - } else if (tkdata[0] == '-' && tkdata[1] == '-' && - c_isalnum(tkdata[2])) { - /* Command retrieved successfully, move to options */ - optstr = strchr(tkdata + 2, '='); - opt_index = 0; + vshCommandStringParse(NULL, buf, &partial); - if (optstr) { - *optstr = '\0'; - optstr = vshStrdup(NULL, optstr + 1); - } + VIR_FREE(buf); - if (!(opt = vshCmddefGetOption(NULL, cmd, tkdata + 2, - &opts_seen, &opt_index, - &optstr, false))) { - /* Parsing failed wrt autocomplete */ - VIR_FREE(optstr); - goto error; - } + if (partial) + cmd = partial->def; - opts_seen = const_opts_seen; - opt_exists = true; - VIR_FREE(const_tkdata); - if (opt->type != VSH_OT_BOOL) { - non_bool_opt_exists = true; - /* Opt exists and check for option data */ - if (optstr) { - const_tkdata = optstr; - tkdata = const_tkdata; - } else { - VIR_FREE(const_tkdata); - tk = parser.getNextArg(NULL, &parser, &const_tkdata, - false); - - if (tk == VSH_TK_ERROR) - goto error; - - tkdata = const_tkdata; - virSkipSpaces((const char **)&tkdata); - } - if (STREQ(tkdata, sanitized_text)) { - /* auto-complete non-bool option arg */ - data_complete = true; - break; - } - non_bool_opt_exists = false; - } else { - tkdata = NULL; - /* opt type is BOOL */ - if (optstr) { - VIR_FREE(optstr); - goto error; - } - } - } else if (!opt_exists) { - /* No -- option provided and some other token given - * Try to find the default option. - */ - if (!(opt = vshCmddefGetData(cmd, &const_opts_need_arg, - &const_opts_seen)) - || opt->type == VSH_OT_BOOL) - goto error; - opt_exists = true; - opts_seen = const_opts_seen; - } else { - /* In every other case, return NULL */ - goto error; - } - - VIR_FREE(const_tkdata); - tk = parser.getNextArg(NULL, &parser, &const_tkdata, false); - - if (tk == VSH_TK_ERROR) - goto error; - - while (tk == VSH_TK_SUBCMD_END) { - cmd = NULL; - cmd_exists = false; - opts_filled = false; - opt = NULL; - non_bool_opt_exists = false; - tk = parser.getNextArg(NULL, &parser, &const_tkdata, false); - } - - tkdata = const_tkdata; - - virSkipSpaces((const char**)&tkdata); + if (cmd && STREQ(cmd->name, text)) { + /* Corner case - some commands share prefix (e.g. + * dump and dumpxml). If user typed 'dump<TAB><TAB>', + * then @text = "dump" and we want to offer command + * completion. If they typed 'dump <TAB><TAB>' then + * @text = "" (the space after the command) and we + * want to offer options completion for dump command. + */ + cmd = NULL; } - VIR_FREE(const_tkdata); } - if (!cmd_exists) { - res = vshReadlineCommandGenerator(sanitized_text, state); - } else if (opts_filled && !non_bool_opt_exists) { - res = vshReadlineOptionsGenerator(sanitized_text, state, cmd); - } else if (non_bool_opt_exists && data_complete && opt && opt->completer) { - if (!completed_list) - completed_list = opt->completer(autoCompleteOpaque, - opt->completer_flags); - if (completed_list) { - while ((completed_name = completed_list[completed_list_index])) { - completed_list_index++; - if (!STRPREFIX(completed_name, sanitized_text)) - continue; - res = vshStrdup(NULL, completed_name); - return res; - } - res = NULL; - virStringListFree(completed_list); - completed_list_index = 0; - } + if (!cmd) { + res = vshReadlineCommandGenerator(text, state); + } else { + res = vshReadlineOptionsGenerator(text, state, cmd); } if (!res) { - VIR_FREE(sanitized_text); - VIR_FREE(ctext); + vshCommandFree(partial); + partial = NULL; } return res; - - error: - VIR_FREE(const_tkdata); - VIR_FREE(sanitized_text); - VIR_FREE(ctext); - return NULL; - } static char ** -- 2.13.6
When returning a string that needs escaping there are two scenarios that can happen. Firstly, user already started the string with a quote (or double quote) in which case we don't need to do anything - readline takes care of that. However, if they haven't typed anything yet, we need to escape the string ourselves. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/tools/vsh.c b/tools/vsh.c index c3423d6e3..bcabf4231 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2735,6 +2735,14 @@ vshReadlineParse(const char *text, int state) res = vshReadlineOptionsGenerator(text, state, cmd); } + if (res && + !rl_completion_quote_character) { + virBuffer buf = VIR_BUFFER_INITIALIZER; + virBufferEscapeShell(&buf, res); + VIR_FREE(res); + res = virBufferContentAndReset(&buf); + } + if (!res) { vshCommandFree(partial); partial = NULL; @@ -2754,6 +2762,16 @@ vshReadlineCompletion(const char *text, return matches; } + +static int +vshReadlineCharIsQuoted(char *line, int idx) +{ + return idx > 0 && + line[idx - 1] == '\\' && + !vshReadlineCharIsQuoted(line, idx - 1); +} + + # define HISTSIZE_MAX 500000 static int @@ -2765,6 +2783,7 @@ vshReadlineInit(vshControl *ctl) char *histsize_env = NULL; const char *histsize_str = NULL; const char *break_characters = " \t\n\\`@$><=;|&{("; + const char *quote_characters = "\"'"; /* Opaque data for autocomplete callbacks. */ autoCompleteOpaque = ctl; @@ -2788,6 +2807,14 @@ vshReadlineInit(vshControl *ctl) rl_basic_word_break_characters = (char *) break_characters; # endif +# if defined(RL_READLINE_VERSION) && RL_READLINE_VERSION > 0x0402 + rl_completer_quote_characters = quote_characters; + rl_char_is_quoted_p = vshReadlineCharIsQuoted; +# else + rl_completer_quote_characters = (char *) quote_characters; + rl_char_is_quoted_p = (Function *) vshReadlineCharIsQuoted; +# endif + if (virAsprintf(&histsize_env, "%s_HISTSIZE", ctl->env_prefix) < 0) goto cleanup; -- 2.13.6
It's better to fetch list of either commands or options just once and then iterate over it. Moreover, it makes future completers way simpler as they will return string lists too. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 121 ++++++++++++++++++++++++++++++++++++------------------------ 1 file changed, 73 insertions(+), 48 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index bcabf4231..ebc8d9cb1 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2605,25 +2605,25 @@ vshTreePrint(vshControl *ctl, vshTreeLookup lookup, void *opaque, * ----------------- */ -/* - * Generator function for command completion. STATE lets us - * know whether to start from scratch; without any state - * (i.e. STATE == 0), then we start at the top of the list. +/** + * vshReadlineCommandGenerator: + * @text: optional command prefix + * + * Generator function for command completion. + * + * Returns a string list of commands with @text prefix, + * NULL if there's no such command. */ -static char * -vshReadlineCommandGenerator(const char *text, int state) +static char ** +vshReadlineCommandGenerator(const char *text) { - static unsigned int grp_list_index, cmd_list_index; - static size_t len; + size_t grp_list_index = 0, cmd_list_index = 0; + size_t len = strlen(text); const char *name; const vshCmdGrp *grp; const vshCmdDef *cmds; - - if (!state) { - grp_list_index = 0; - cmd_list_index = 0; - len = strlen(text); - } + size_t ret_size = 0; + char **ret = NULL; grp = cmdGroups; @@ -2638,8 +2638,16 @@ vshReadlineCommandGenerator(const char *text, int state) if (cmds[cmd_list_index++].flags & VSH_CMD_FLAG_ALIAS) continue; - if (STREQLEN(name, text, len)) - return vshStrdup(NULL, name); + if (STREQLEN(name, text, len)) { + if (VIR_REALLOC_N(ret, ret_size + 2) < 0) { + virStringListFree(ret); + return NULL; + } + ret[ret_size] = vshStrdup(NULL, name); + ret_size++; + /* Terminate the string list properly. */ + ret[ret_size] = NULL; + } } } else { cmd_list_index = 0; @@ -2647,23 +2655,17 @@ vshReadlineCommandGenerator(const char *text, int state) } } - /* If no names matched, then return NULL. */ - return NULL; + return ret; } -static char * -vshReadlineOptionsGenerator(const char *text, int state, const vshCmdDef *cmd_parsed) +static char ** +vshReadlineOptionsGenerator(const char *text, const vshCmdDef *cmd) { - static unsigned int list_index; - static size_t len; - static const vshCmdDef *cmd; + size_t list_index = 0; + size_t len = strlen(text); const char *name; - - if (!state) { - cmd = cmd_parsed; - list_index = 0; - len = strlen(text); - } + size_t ret_size = 0; + char **ret = NULL; if (!cmd) return NULL; @@ -2672,7 +2674,7 @@ vshReadlineOptionsGenerator(const char *text, int state, const vshCmdDef *cmd_pa return NULL; while ((name = cmd->opts[list_index].name)) { - char *res; + size_t name_len; list_index++; @@ -2685,28 +2687,40 @@ vshReadlineOptionsGenerator(const char *text, int state, const vshCmdDef *cmd_pa } else if (STRNEQLEN(text, "--", len)) { return NULL; } - res = vshMalloc(NULL, strlen(name) + 3); - snprintf(res, strlen(name) + 3, "--%s", name); - return res; + + if (VIR_REALLOC_N(ret, ret_size + 2) < 0) { + virStringListFree(ret); + return NULL; + } + + name_len = strlen(name); + ret[ret_size] = vshMalloc(NULL, name_len + 3); + snprintf(ret[ret_size], name_len + 3, "--%s", name); + ret_size++; + /* Terminate the string list properly. */ + ret[ret_size] = NULL; } - /* If no names matched, then return NULL. */ - return NULL; + return ret; } static char * vshReadlineParse(const char *text, int state) { static vshCmd *partial; - static const vshCmdDef *cmd; - char *res = NULL; + static char **list; + static size_t list_index; + const vshCmdDef *cmd = NULL; + char *ret = NULL; if (!state) { char *buf = vshStrdup(NULL, rl_line_buffer); vshCommandFree(partial); partial = NULL; - cmd = NULL; + virStringListFree(list); + list = NULL; + list_index = 0; *(buf + rl_point) = '\0'; @@ -2729,26 +2743,37 @@ vshReadlineParse(const char *text, int state) } } - if (!cmd) { - res = vshReadlineCommandGenerator(text, state); - } else { - res = vshReadlineOptionsGenerator(text, state, cmd); + if (!list) { + if (!cmd) { + list = vshReadlineCommandGenerator(text); + } else { + list = vshReadlineOptionsGenerator(text, cmd); + } } - if (res && + if (list) { + ret = vshStrdup(NULL, list[list_index]); + list_index++; + } + + if (ret && !rl_completion_quote_character) { virBuffer buf = VIR_BUFFER_INITIALIZER; - virBufferEscapeShell(&buf, res); - VIR_FREE(res); - res = virBufferContentAndReset(&buf); + virBufferEscapeShell(&buf, ret); + VIR_FREE(ret); + ret = virBufferContentAndReset(&buf); } - if (!res) { + if (!ret) { vshCommandFree(partial); partial = NULL; + virStringListFree(list); + list = NULL; + list_index = 0; } - return res; + return ret; + } static char ** -- 2.13.6
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts). Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name); if (STREQ(name, valid->name)) break; valid++; diff --git a/tools/vsh.h b/tools/vsh.h index 8f7df9ff8..112b1b57d 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -188,7 +188,8 @@ struct _vshCmdDef { struct _vshCmd { const vshCmdDef *def; /* command definition */ vshCmdOpt *opts; /* list of command arguments */ - vshCmd *next; /* next command */ + vshCmd *next; /* next command */ + bool skipChecks; /* skip validity checks when retrieving opts */ }; /* -- 2.13.6
For two string lists merge one into the other one. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- src/libvirt_private.syms | 1 + src/util/virstring.c | 36 ++++++++++++++++++++++++++++++++++++ src/util/virstring.h | 3 +++ 3 files changed, 40 insertions(+) diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms index d5c3b9abb..d807cdca6 100644 --- a/src/libvirt_private.syms +++ b/src/libvirt_private.syms @@ -2764,6 +2764,7 @@ virStringListGetFirstWithPrefix; virStringListHasString; virStringListJoin; virStringListLength; +virStringListMerge; virStringListRemove; virStringMatch; virStringParsePort; diff --git a/src/util/virstring.c b/src/util/virstring.c index b2ebce27f..47d9efba2 100644 --- a/src/util/virstring.c +++ b/src/util/virstring.c @@ -239,6 +239,42 @@ virStringListRemove(char ***strings, } +/** + * virStringListMerge: + * @dst: a NULL-terminated array of strings to expand + * @src: a NULL-terminated array of strings + * + * Merges @src into @dst. Upon successful return from this + * function, @dst is resized to $(dst + src) elements and @src is + * freed. + * + * Returns 0 on success, -1 otherwise. + */ +int +virStringListMerge(char ***dst, + char ***src) +{ + size_t dst_len, src_len, i; + + if (!src || !*src) + return 0; + + dst_len = virStringListLength((const char **) *dst); + src_len = virStringListLength((const char **) *src); + + if (VIR_REALLOC_N(*dst, dst_len + src_len + 1) < 0) + return -1; + + for (i = 0; i <= src_len; i++) + (*dst)[i + dst_len] = (*src)[i]; + + /* Don't call virStringListFree() as it would free strings in + * @src. */ + VIR_FREE(*src); + return 0; +} + + /** * virStringListCopy: * @dst: where to store the copy of @strings diff --git a/src/util/virstring.h b/src/util/virstring.h index b19abaf9f..f42aaff62 100644 --- a/src/util/virstring.h +++ b/src/util/virstring.h @@ -46,6 +46,9 @@ char **virStringListAdd(const char **strings, void virStringListRemove(char ***strings, const char *item); +int virStringListMerge(char ***dst, + char ***src); + int virStringListCopy(char ***dst, const char **src); -- 2.13.6
The first argument passed to this function is vshControl *. There's no need to use void pointer. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 2 +- tools/vsh.h | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index d27acb95b..f99d941d9 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -66,7 +66,7 @@ #ifdef WITH_READLINE /* For autocompletion */ -void *autoCompleteOpaque; +vshControl *autoCompleteOpaque; #endif /* NOTE: It would be much nicer to have these two as part of vshControl diff --git a/tools/vsh.h b/tools/vsh.h index 112b1b57d..51f8ef213 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -123,7 +123,8 @@ typedef struct _vshCmdOpt vshCmdOpt; typedef struct _vshCmdOptDef vshCmdOptDef; typedef struct _vshControl vshControl; -typedef char **(*vshCompleter)(void *opaque, unsigned int flags); +typedef char **(*vshCompleter)(vshControl *ctl, + unsigned int flags); /* * vshCmdInfo -- name/value pair for information about command -- 2.13.6
Now that we have everything prepared we can call options' completer again. At the same time, pass partially parsed input to the completer callback - it will help the callbacks to narrow down the list of returned options based on user's input. For instance, if the completer is supposed to return list of interfaces depending on user input it may return just those interfaces defined for already specified domain. Of course, completers might ignore this parameter. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 51 +++++++++++++++++++++++++++++++++++++++++++++++++-- tools/vsh.h | 1 + 2 files changed, 50 insertions(+), 2 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index f99d941d9..10a4ef69c 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2705,6 +2705,36 @@ vshReadlineOptionsGenerator(const char *text, const vshCmdDef *cmd) return ret; } + +static const vshCmdOptDef * +vshReadlineCommandFindOpt(const vshCmd *partial, + const char *text) +{ + const vshCmd *tmp = partial; + + while (tmp && tmp->next) { + if (tmp->def == tmp->next->def && + !tmp->next->opts) + break; + tmp = tmp->next; + } + + if (tmp && tmp->opts) { + const vshCmdOpt *opt = tmp->opts; + + while (opt) { + if (STREQ_NULLABLE(opt->data, text) || + STREQ_NULLABLE(opt->data, " ")) + return opt->def; + + opt = opt->next; + } + } + + return NULL; +} + + static char * vshReadlineParse(const char *text, int state) { @@ -2712,6 +2742,7 @@ vshReadlineParse(const char *text, int state) static char **list; static size_t list_index; const vshCmdDef *cmd = NULL; + const vshCmdOptDef *opt = NULL; char *ret = NULL; if (!state) { @@ -2729,8 +2760,10 @@ vshReadlineParse(const char *text, int state) VIR_FREE(buf); - if (partial) + if (partial) { cmd = partial->def; + partial->skipChecks = true; + } if (cmd && STREQ(cmd->name, text)) { /* Corner case - some commands share prefix (e.g. @@ -2742,13 +2775,26 @@ vshReadlineParse(const char *text, int state) */ cmd = NULL; } + + opt = vshReadlineCommandFindOpt(partial, text); } if (!list) { if (!cmd) { list = vshReadlineCommandGenerator(text); } else { - list = vshReadlineOptionsGenerator(text, cmd); + if (!opt || opt->type != VSH_OT_DATA) + list = vshReadlineOptionsGenerator(text, cmd); + + if (opt && opt->completer) { + char **completer_list = opt->completer(autoCompleteOpaque, + partial, + opt->completer_flags); + if (virStringListMerge(&list, &completer_list) < 0) { + virStringListFree(completer_list); + goto cleanup; + } + } } } @@ -2765,6 +2811,7 @@ vshReadlineParse(const char *text, int state) ret = virBufferContentAndReset(&buf); } + cleanup: if (!ret) { vshCommandFree(partial); partial = NULL; diff --git a/tools/vsh.h b/tools/vsh.h index 51f8ef213..ae40fb4e8 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -124,6 +124,7 @@ typedef struct _vshCmdOptDef vshCmdOptDef; typedef struct _vshControl vshControl; typedef char **(*vshCompleter)(vshControl *ctl, + const vshCmd *cmd, unsigned int flags); /* -- 2.13.6
Instead of having completers prune returned string list based on user's input we can do that right after the callback is called. Only strings matching the prefix will be presented to the user then. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/tools/vsh.c b/tools/vsh.c index 10a4ef69c..49e8033bd 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2735,6 +2735,40 @@ vshReadlineCommandFindOpt(const vshCmd *partial, } +static int +vshCompleterFilter(char ***list, + const char *text) +{ + char **newList = NULL; + size_t newList_len = 0; + size_t list_len; + size_t i; + + if (!list || !*list) + return -1; + + list_len = virStringListLength((const char **) *list); + + if (VIR_ALLOC_N(newList, list_len + 1) < 0) + return -1; + + for (i = 0; i < list_len; i++) { + if (!STRPREFIX((*list)[i], text)) { + VIR_FREE((*list)[i]); + continue; + } + + VIR_STEAL_PTR(newList[newList_len], (*list)[i]); + newList_len++; + } + + ignore_value(VIR_REALLOC_N_QUIET(newList, newList_len + 1)); + VIR_FREE(*list); + *list = newList; + return 0; +} + + static char * vshReadlineParse(const char *text, int state) { @@ -2790,7 +2824,14 @@ vshReadlineParse(const char *text, int state) char **completer_list = opt->completer(autoCompleteOpaque, partial, opt->completer_flags); - if (virStringListMerge(&list, &completer_list) < 0) { + + /* For string list returned by completer we have to do + * filtering based on @text because completer returns all + * possible strings. */ + + if (completer_list && + (vshCompleterFilter(&completer_list, text) < 0 || + virStringListMerge(&list, &completer_list) < 0)) { virStringListFree(completer_list); goto cleanup; } -- 2.13.6
Similarly to the previous commit, once we've presented an --option for a command to the user it makes no sense to offer it again. Therefore, we can prune all already specified options. For instance, after this patch: virsh # migrate --verbose <TAB><TAB> will no longer offer --verbose option. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/tools/vsh.c b/tools/vsh.c index 49e8033bd..f061783e0 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2769,6 +2769,60 @@ vshCompleterFilter(char ***list, } +static int +vshReadlineOptionsPrune(char ***list, + vshCmd *last) +{ + char **newList = NULL; + size_t newList_len = 0; + size_t list_len; + size_t i; + + if (!list || !*list) + return -1; + + if (!last->opts) + return 0; + + list_len = virStringListLength((const char **) *list); + + if (VIR_ALLOC_N(newList, list_len + 1) < 0) + return -1; + + for (i = 0; i < list_len; i++) { + const char *list_opt = STRSKIP((*list)[i], "--"); + bool exist = false; + vshCmdOpt *opt = last->opts; + + /* Should never happen (TM) */ + if (!list_opt) + return -1; + + while (opt) { + if (STREQ(opt->def->name, list_opt)) { + exist = true; + break; + } + + opt = opt->next; + } + + if (exist) { + VIR_FREE((*list)[i]); + continue; + } + + VIR_STEAL_PTR(newList[newList_len], (*list)[i]); + newList_len++; + } + + ignore_value(VIR_REALLOC_N_QUIET(newList, newList_len + 1)); + VIR_FREE(*list); + *list = newList; + return 0; +} + + static char * vshReadlineParse(const char *text, int state) { @@ -2817,9 +2871,13 @@ vshReadlineParse(const char *text, int state) if (!cmd) { list = vshReadlineCommandGenerator(text); } else { - if (!opt || opt->type != VSH_OT_DATA) + if (!opt || opt->type != VSH_OT_DATA) { list = vshReadlineOptionsGenerator(text, cmd); + if (vshReadlineOptionsPrune(&list, partial) < 0) + goto cleanup; + } + if (opt && opt->completer) { char **completer_list = opt->completer(autoCompleteOpaque, partial, -- 2.13.6
This command is going to be called from bash completion script in the following form: virsh complete -- start --domain Its only purpose is to return list of possible strings for completion. Note that this is a 'hidden', unlisted command and therefore there's no documentation to it. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/virsh.c | 1 + tools/virt-admin.c | 1 + tools/vsh.c | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ tools/vsh.h | 14 ++++++++++ 4 files changed, 96 insertions(+) diff --git a/tools/virsh.c b/tools/virsh.c index 933d6b4c9..5f8352e86 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -833,6 +833,7 @@ static const vshCmdDef virshCmds[] = { VSH_CMD_PWD, VSH_CMD_QUIT, VSH_CMD_SELF_TEST, + VSH_CMD_COMPLETE, {.name = "connect", .handler = cmdConnect, .opts = opts_connect, diff --git a/tools/virt-admin.c b/tools/virt-admin.c index b8b33af19..ef5bada63 100644 --- a/tools/virt-admin.c +++ b/tools/virt-admin.c @@ -1351,6 +1351,7 @@ static const vshCmdDef vshAdmCmds[] = { VSH_CMD_PWD, VSH_CMD_QUIT, VSH_CMD_SELF_TEST, + VSH_CMD_COMPLETE, {.name = "uri", .handler = cmdURI, .opts = NULL, diff --git a/tools/vsh.c b/tools/vsh.c index f061783e0..9f4805b3d 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -3472,3 +3472,83 @@ cmdSelfTest(vshControl *ctl ATTRIBUTE_UNUSED, return true; } + +/* ---------------------- + * Autocompletion command + * ---------------------- */ + +const vshCmdOptDef opts_complete[] = { + {.name = "string", + .type = VSH_OT_ARGV, + .flags = VSH_OFLAG_EMPTY_OK, + .help = N_("partial string to autocomplete") + }, + {.name = NULL} +}; + +const vshCmdInfo info_complete[] = { + {.name = "help", + .data = N_("internal command for autocompletion") + }, + {.name = "desc", + .data = N_("internal use only") + }, + {.name = NULL} +}; + +bool +cmdComplete(vshControl *ctl, const vshCmd *cmd) +{ + bool ret = false; +#ifdef WITH_READLINE + const vshClientHooks *hooks = ctl->hooks; + int stdin_fileno = STDIN_FILENO; + const char *arg = ""; + const vshCmdOpt *opt = NULL; + char **matches = NULL, **iter; + virBuffer buf = VIR_BUFFER_INITIALIZER; + + if (vshCommandOptStringQuiet(ctl, cmd, "string", &arg) <= 0) + goto cleanup; + + /* This command is flagged VSH_CMD_FLAG_NOCONNECT because we + * need to prevent auth hooks reading any input. Therefore, we + * have to close stdin and then connect ourselves. */ + VIR_FORCE_CLOSE(stdin_fileno); + + if (!(hooks && hooks->connHandler && hooks->connHandler(ctl))) + goto cleanup; + + while ((opt = vshCommandOptArgv(ctl, cmd, opt))) { + if (virBufferUse(&buf) != 0) + virBufferAddChar(&buf, ' '); + virBufferAddStr(&buf, opt->data); + arg = opt->data; + } + + if (virBufferCheckError(&buf) < 0) + goto cleanup; + + vshReadlineInit(ctl); + + if (!(rl_line_buffer = virBufferContentAndReset(&buf)) && + VIR_STRDUP(rl_line_buffer, "") < 0) + goto cleanup; + + /* rl_point is current cursor position in rl_line_buffer. + * In our case it's at the end of the whole line. */ + rl_point = strlen(rl_line_buffer); + + if (!(matches = vshReadlineCompletion(arg, 0, 0))) + goto cleanup; + + for (iter = matches; *iter; iter++) + printf("%s\n", *iter); + + ret = true; + cleanup: + virBufferFreeAndReset(&buf); + virStringListFree(matches); +#endif /* WITH_READLINE */ + return ret; +} diff --git a/tools/vsh.h b/tools/vsh.h index ae40fb4e8..6894700d9 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -382,6 +382,8 @@ extern const vshCmdInfo info_echo[]; extern const vshCmdInfo info_pwd[]; extern const vshCmdInfo info_quit[]; extern const vshCmdInfo info_selftest[]; +extern const vshCmdOptDef opts_complete[]; +extern const vshCmdInfo info_complete[]; bool cmdHelp(vshControl *ctl, const vshCmd *cmd); bool cmdCd(vshControl *ctl, const vshCmd *cmd); @@ -389,6 +391,7 @@ bool cmdEcho(vshControl *ctl, const vshCmd *cmd); bool cmdPwd(vshControl *ctl, const vshCmd *cmd); bool cmdQuit(vshControl *ctl, const vshCmd *cmd); bool cmdSelfTest(vshControl *ctl, const vshCmd *cmd); +bool cmdComplete(vshControl *ctl, const vshCmd *cmd); # define VSH_CMD_CD \ { \ @@ -454,6 +457,17 @@ bool cmdSelfTest(vshControl *ctl, const vshCmd *cmd); .alias = "self-test" \ } +# define VSH_CMD_COMPLETE \ + { \ + .name = "complete", \ + .handler = cmdComplete, \ + .opts = opts_complete, \ + .info = info_complete, \ + .flags = VSH_CMD_FLAG_NOCONNECT | VSH_CMD_FLAG_ALIAS, \ + .alias = "complete" \ + } + + /* readline */ char * vshReadline(vshControl *ctl, const char *prompt); -- 2.13.6
The only purpose of this file is to be sourced. After that one can use completion even for their bash: # virsh list --<TAB><TAB> --all --inactive ... Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- configure.ac | 3 ++ libvirt.spec.in | 3 ++ m4/virt-bash-completion.m4 | 74 ++++++++++++++++++++++++++++++++++++++++++++++ tools/Makefile.am | 22 ++++++++++++-- tools/bash-completion/vsh | 67 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 167 insertions(+), 2 deletions(-) create mode 100644 m4/virt-bash-completion.m4 create mode 100644 tools/bash-completion/vsh diff --git a/configure.ac b/configure.ac index fba4e4bf5..06236fad8 100644 --- a/configure.ac +++ b/configure.ac @@ -242,6 +242,7 @@ LIBVIRT_ARG_APPARMOR LIBVIRT_ARG_ATTR LIBVIRT_ARG_AUDIT LIBVIRT_ARG_AVAHI +LIBVIRT_ARG_BASH_COMPLETION LIBVIRT_ARG_BLKID LIBVIRT_ARG_CAPNG LIBVIRT_ARG_CURL @@ -278,6 +279,7 @@ LIBVIRT_CHECK_ATOMIC LIBVIRT_CHECK_ATTR LIBVIRT_CHECK_AUDIT LIBVIRT_CHECK_AVAHI +LIBVIRT_CHECK_BASH_COMPLETION LIBVIRT_CHECK_BLKID LIBVIRT_CHECK_CAPNG LIBVIRT_CHECK_CURL @@ -976,6 +978,7 @@ LIBVIRT_RESULT_APPARMOR LIBVIRT_RESULT_ATTR LIBVIRT_RESULT_AUDIT LIBVIRT_RESULT_AVAHI +LIBVIRT_RESULT_BASH_COMPLETION LIBVIRT_RESULT_BLKID LIBVIRT_RESULT_CAPNG LIBVIRT_RESULT_CURL diff --git a/libvirt.spec.in b/libvirt.spec.in index 7e1b6a27d..d4ef116b2 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -306,6 +306,7 @@ BuildRequires: xen-devel BuildRequires: libxml2-devel BuildRequires: libxslt BuildRequires: readline-devel +BuildRequires: bash-completion >= 2.0 BuildRequires: ncurses-devel BuildRequires: gettext BuildRequires: libtasn1-devel @@ -2047,6 +2048,8 @@ exit 0 %{_datadir}/systemtap/tapset/libvirt_qemu_probes*.stp %{_datadir}/systemtap/tapset/libvirt_functions.stp +%{_datadir}/bash-completion/completions/vsh + %if %{with_systemd} %{_unitdir}/libvirt-guests.service diff --git a/m4/virt-bash-completion.m4 b/m4/virt-bash-completion.m4 new file mode 100644 index 000000000..e1ef58740 --- /dev/null +++ b/m4/virt-bash-completion.m4 @@ -0,0 +1,74 @@ +dnl Bash completion support +dnl +dnl Copyright (C) 2017 Red Hat, Inc. +dnl +dnl This library is free software; you can redistribute it and/or +dnl modify it under the terms of the GNU Lesser General Public +dnl License as published by the Free Software Foundation; either +dnl version 2.1 of the License, or (at your option) any later version. +dnl +dnl This library is distributed in the hope that it will be useful, +dnl but WITHOUT ANY WARRANTY; without even the implied warranty of +dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +dnl Lesser General Public License for more details. +dnl +dnl You should have received a copy of the GNU Lesser General Public +dnl License along with this library. If not, see +dnl <http://www.gnu.org/licenses/>. +dnl +dnl Inspired by libguestfs code. +dnl + +AC_DEFUN([LIBVIRT_ARG_BASH_COMPLETION],[ + LIBVIRT_ARG_WITH_FEATURE([BASH_COMPLETION], [bash-completion], [check], [2.0]) + LIBVIRT_ARG_WITH([BASH_COMPLETIONS_DIR], + [directory containing bash completions scripts], + [check]) +]) + +AC_DEFUN([LIBVIRT_CHECK_BASH_COMPLETION], [ + AC_REQUIRE([LIBVIRT_CHECK_READLINE]) + + if test "x$with_readline" != "xyes" ; then + if test "x$with_bash_completion" != "xyes" ; then + with_bash_completion=no + else + AC_MSG_ERROR([readline is required for bash completion support]) + fi + else + if test "x$with_bash_completion" = "xcheck" ; then + with_bash_completion=yes + fi + fi + + LIBVIRT_CHECK_PKG([BASH_COMPLETION], [bash-completion], [2.0]) + + if test "x$with_bash_completion" = "xyes" ; then + if test "x$with_bash_completions_dir" = "xcheck"; then + AC_MSG_CHECKING([for bash-completions directory]) + BASH_COMPLETIONS_DIR="$($PKG_CONFIG --variable=completionsdir bash-completion)" + AC_MSG_RESULT([$BASH_COMPLETIONS_DIR]) + + dnl Replace bash completions's exec_prefix with our own. + dnl Note that ${exec_prefix} is kept verbatim at this point in time, + dnl and will only be expanded later, when make is called: this makes + dnl it possible to override such prefix at compilation or installation + dnl time + bash_completions_prefix="$($PKG_CONFIG --variable=prefix bash-completion)" + if test "x$bash_completions_prefix" = "x" ; then + bash_completions_prefix="/usr" + fi + + BASH_COMPLETIONS_DIR='${exec_prefix}'"${BASH_COMPLETIONS_DIR#$bash_completions_prefix}" + elif test "x$with_bash_completions_dir" = "xno" || test "x$with_bash_completions_dir" = "xyes"; then + AC_MSG_ERROR([bash-completions-dir must be used only with valid path]) + else + BASH_COMPLETIONS_DIR=$with_bash_completions_dir + fi + AC_SUBST([BASH_COMPLETIONS_DIR]) + fi +]) + +AC_DEFUN([LIBVIRT_RESULT_BASH_COMPLETION],[ + LIBVIRT_RESULT_LIB([BASH_COMPLETION]) +]) diff --git a/tools/Makefile.am b/tools/Makefile.am index fbc73a7c3..1df2a601f 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -73,6 +73,7 @@ EXTRA_DIST = \ libvirt-guests.sysconf \ virt-login-shell.conf \ virsh-edit.c \ + bash-completion/vsh \ $(PODFILES) \ $(MANINFILES) \ $(NULL) @@ -326,9 +327,11 @@ POD2MAN = pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" < $< > $@-t && \ mv $@-t $@ -install-data-local: install-init install-systemd install-nss +install-data-local: install-init install-systemd install-nss \ + install-bash-completion -uninstall-local: uninstall-init uninstall-systemd uninstall-nss +uninstall-local: uninstall-init uninstall-systemd uninstall-nss \ + uninstall-bash-completion install-sysconfig: $(MKDIR_P) $(DESTDIR)$(sysconfdir)/sysconfig @@ -414,6 +417,21 @@ libvirt-guests.service: libvirt-guests.service.in $(top_builddir)/config.status mv $@-t $@ +if WITH_BASH_COMPLETION +install-bash-completion: + $(MKDIR_P) "$(DESTDIR)$(BASH_COMPLETIONS_DIR)" + $(INSTALL_SCRIPT) $(srcdir)/bash-completion/vsh \ + "$(DESTDIR)$(BASH_COMPLETIONS_DIR)/vsh" + +uninstall-bash-completion: + rm -f $(DESTDIR)$(BASH_COMPLETIONS_DIR)/vsh + rmdir $(DESTDIR)$(BASH_COMPLETIONS_DIR) ||: +else ! WITH_BASH_COMPLETION +install-bash-completion: +uninstall-bash-completion: +endif ! WITH_BASH_COMPLETION + + EXTRA_DIST += \ wireshark/util/genxdrstub.pl \ wireshark/util/make-dissector-reg diff --git a/tools/bash-completion/vsh b/tools/bash-completion/vsh new file mode 100644 index 000000000..8493cad28 --- /dev/null +++ b/tools/bash-completion/vsh @@ -0,0 +1,67 @@ +# +# virsh & virt-admin completion command +# + +_vsh_complete() +{ + local words cword c=0 i=0 cur RO URI CMDLINE INPUT A + + # Here, $COMP_WORDS is an array of words on the bash + # command line that user wants to complete. However, when + # parsing command line, the default set of word breaks is + # applied. This doesn't work for us as it mangles libvirt + # arguments, e.g. connection URI (with the default set it's + # split into multiple items within the array). Fortunately, + # there's a fixup function for the array. + _get_comp_words_by_ref -n "\"'><=;|&(:" -w words -i cword + COMP_WORDS=( "${words[@]}" ) + COMP_CWORD=${cword} + cur=${COMP_WORDS[$COMP_CWORD]} + + # See what URI is user trying to connect to and if they are + # connecting RO. Honour that. + while [ $c -le $COMP_CWORD ]; do + word="${COMP_WORDS[c]}" + case "$word" in + -r|--readonly) RO=1 ;; + -c|--connect) c=$((++c)); URI=${COMP_WORDS[c]} ;; + *) if [ $c -ne 0 ] && [ $i -eq 0 ]; then i=$c; break; fi ;; + esac + c=$((++c)) + done + + CMDLINE= + if [ -n "${RO}" ]; then + CMDLINE="${CMDLINE} -r" + fi + if [ -n "${URI}" ]; then + CMDLINE="${CMDLINE} -c ${URI}" + fi + + INPUT=( "${COMP_WORDS[@]:$i:$COMP_CWORD}" ) + + # Uncomment these lines for easy debug. +# echo; +# echo "RO=${flag_ro}"; +# echo "URI=${URI}"; +# echo "CMDLINE=${CMDLINE}"; +# echo "INPUT[${#INPUT[@]}]=**${INPUT[@]}**"; +# echo "cur=${cur}"; +# echo; +# return 0; + + # Small shortcut here. According to manpage: + # When the function is executed, the first argument ($1) is + # the name of the command whose arguments are being + # completed. + # Therefore, we might just run $1. + A=($($1 ${CMDLINE} complete -- "${INPUT[@]}" 2>/dev/null)) + + COMPREPLY=($(compgen -W "${A[*]%--}" -- ${cur})) + __ltrim_colon_completions "$cur" + return 0 +} && +complete -o default -o filenames -F _vsh_complete virsh && +complete -o default -o filenames -F _vsh_complete virt-admin + +# vim: ft=sh:et:ts=4:sw=4:tw=80 -- 2.13.6
Now that we have everything prepared let the fun begin. This completer is very simple and returns domain names. Moreover, depending on the command it can return just a subset of domains (e.g. only running/paused/transient/.. ones). Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/Makefile.am | 9 +++ tools/virsh-completer.c | 90 +++++++++++++++++++++ tools/virsh-completer.h | 33 ++++++++ tools/virsh-domain-monitor.c | 30 +++---- tools/virsh-domain.c | 182 ++++++++++++++++++++++--------------------- tools/virsh-snapshot.c | 24 +++--- tools/virsh.h | 7 +- 7 files changed, 256 insertions(+), 119 deletions(-) create mode 100644 tools/virsh-completer.c create mode 100644 tools/virsh-completer.h diff --git a/tools/Makefile.am b/tools/Makefile.am index 1df2a601f..7466d8282 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -231,6 +231,15 @@ virsh_SOURCES = \ virsh-volume.c virsh-volume.h \ $(NULL) +VIRSH_COMPLETER = \ + virsh-completer.c virsh-completer.h + +if WITH_READLINE +virsh_SOURCES += $(VIRSH_COMPLETER) +else ! WITH_READLINE +EXTRA_DIST += $(VIRSH_COMPLETER) +endif ! WITH_READLINE + virsh_LDFLAGS = \ $(AM_LDFLAGS) \ $(PIE_LDFLAGS) \ diff --git a/tools/virsh-completer.c b/tools/virsh-completer.c new file mode 100644 index 000000000..4e32b882b --- /dev/null +++ b/tools/virsh-completer.c @@ -0,0 +1,90 @@ +/* + * virsh-completer.c: virsh completer callbacks + * + * Copyright (C) 2017 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>. + * + * Michal Privoznik <mprivozn@redhat.com> + * + */ + +#include <config.h> + +#include "virsh-completer.h" +#include "virsh.h" +#include "virsh-util.h" +#include "internal.h" +#include "viralloc.h" +#include "virstring.h" + + +char ** +virshDomainNameCompleter(vshControl *ctl, + const vshCmd *cmd ATTRIBUTE_UNUSED, + unsigned int flags) +{ + virshControlPtr priv = ctl->privData; + virDomainPtr *domains = NULL; + int ndomains = 0; + size_t i = 0; + char **ret = NULL; + + virCheckFlags(VIR_CONNECT_LIST_DOMAINS_ACTIVE | + VIR_CONNECT_LIST_DOMAINS_INACTIVE | + VIR_CONNECT_LIST_DOMAINS_PERSISTENT | + VIR_CONNECT_LIST_DOMAINS_TRANSIENT | + VIR_CONNECT_LIST_DOMAINS_RUNNING | + VIR_CONNECT_LIST_DOMAINS_PAUSED | + VIR_CONNECT_LIST_DOMAINS_SHUTOFF | + VIR_CONNECT_LIST_DOMAINS_OTHER | + VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE | + VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE | + VIR_CONNECT_LIST_DOMAINS_AUTOSTART | + VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART | + VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT | + VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT, + NULL); + + if (!priv->conn || virConnectIsAlive(priv->conn) <= 0) + return NULL; + + if ((ndomains = virConnectListAllDomains(priv->conn, &domains, flags)) < 0) + return NULL; + + if (VIR_ALLOC_N(ret, ndomains + 1) < 0) + goto error; + + for (i = 0; i < ndomains; i++) { + const char *name = virDomainGetName(domains[i]); + + if (VIR_STRDUP(ret[i], name) < 0) + goto error; + + virshDomainFree(domains[i]); + } + VIR_FREE(domains); + + return ret; + error: + + for (; i < ndomains; i++) + virshDomainFree(domains[i]); + VIR_FREE(domains); + for (i = 0; i < ndomains; i++) + VIR_FREE(ret[i]); + VIR_FREE(ret); + return NULL; +} diff --git a/tools/virsh-completer.h b/tools/virsh-completer.h new file mode 100644 index 000000000..288e17909 --- /dev/null +++ b/tools/virsh-completer.h @@ -0,0 +1,33 @@ +/* + * virsh-completer.h: virsh completer callbacks + * + * Copyright (C) 2017 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>. + * + * Michal Privoznik <mprivozn@redhat.com> + * + */ + +#ifndef VIRSH_COMPLETER +# define VIRSH_COMPLETER + +# include "vsh.h" + +char ** virshDomainNameCompleter(vshControl *ctl, + const vshCmd *cmd, + unsigned int flags); + +#endif diff --git a/tools/virsh-domain-monitor.c b/tools/virsh-domain-monitor.c index 7b4e320c2..a09eb010c 100644 --- a/tools/virsh-domain-monitor.c +++ b/tools/virsh-domain-monitor.c @@ -40,8 +40,8 @@ #include "virxml.h" #include "virstring.h" -#define VIRSH_COMMON_OPT_DOMAIN_FULL \ - VIRSH_COMMON_OPT_DOMAIN(N_("domain name, id or uuid")) +#define VIRSH_COMMON_OPT_DOMAIN_FULL(cflags) \ + VIRSH_COMMON_OPT_DOMAIN(N_("domain name, id or uuid"), cflags) VIR_ENUM_DECL(virshDomainIOError) VIR_ENUM_IMPL(virshDomainIOError, @@ -278,7 +278,7 @@ static const vshCmdInfo info_dommemstat[] = { }; static const vshCmdOptDef opts_dommemstat[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "period", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ_OPT, @@ -390,7 +390,7 @@ static const vshCmdInfo info_domblkinfo[] = { }; static const vshCmdOptDef opts_domblkinfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "device", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -460,7 +460,7 @@ static const vshCmdInfo info_domblklist[] = { }; static const vshCmdOptDef opts_domblklist[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "inactive", .type = VSH_OT_BOOL, .help = N_("get inactive rather than running configuration") @@ -566,7 +566,7 @@ static const vshCmdInfo info_domiflist[] = { }; static const vshCmdOptDef opts_domiflist[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "inactive", .type = VSH_OT_BOOL, .help = N_("get inactive rather than running configuration") @@ -655,7 +655,7 @@ static const vshCmdInfo info_domif_getlink[] = { }; static const vshCmdOptDef opts_domif_getlink[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -752,7 +752,7 @@ static const vshCmdInfo info_domcontrol[] = { }; static const vshCmdOptDef opts_domcontrol[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -805,7 +805,7 @@ static const vshCmdInfo info_domblkstat[] = { }; static const vshCmdOptDef opts_domblkstat[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "device", .type = VSH_OT_STRING, .flags = VSH_OFLAG_EMPTY_OK, @@ -991,7 +991,7 @@ static const vshCmdInfo info_domifstat[] = { }; static const vshCmdOptDef opts_domifstat[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -1064,7 +1064,7 @@ static const vshCmdInfo info_domblkerror[] = { }; static const vshCmdOptDef opts_domblkerror[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -1125,7 +1125,7 @@ static const vshCmdInfo info_dominfo[] = { }; static const vshCmdOptDef opts_dominfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = NULL} }; @@ -1264,7 +1264,7 @@ static const vshCmdInfo info_domstate[] = { }; static const vshCmdOptDef opts_domstate[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "reason", .type = VSH_OT_BOOL, .help = N_("also print reason for the state") @@ -1316,7 +1316,7 @@ static const vshCmdInfo info_domtime[] = { }; static const vshCmdOptDef opts_domtime[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "now", .type = VSH_OT_BOOL, .help = N_("set to the time of the host running virsh") @@ -2145,7 +2145,7 @@ static const vshCmdInfo info_domifaddr[] = { }; static const vshCmdOptDef opts_domifaddr[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "interface", .type = VSH_OT_STRING, .flags = VSH_OFLAG_NONE, diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c index 93cb02098..13f8db3dd 100644 --- a/tools/virsh-domain.c +++ b/tools/virsh-domain.c @@ -65,8 +65,8 @@ # define SA_SIGINFO 0 #endif -#define VIRSH_COMMON_OPT_DOMAIN_FULL \ - VIRSH_COMMON_OPT_DOMAIN(N_("domain name, id or uuid")) +#define VIRSH_COMMON_OPT_DOMAIN_FULL(cflags) \ + VIRSH_COMMON_OPT_DOMAIN(N_("domain name, id or uuid"), cflags) #define VIRSH_COMMON_OPT_DOMAIN_PERSISTENT \ {.name = "persistent", \ @@ -154,7 +154,7 @@ static const vshCmdInfo info_attach_device[] = { }; static const vshCmdOptDef opts_attach_device[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), VIRSH_COMMON_OPT_FILE(N_("XML file")), VIRSH_COMMON_OPT_DOMAIN_PERSISTENT, VIRSH_COMMON_OPT_DOMAIN_CONFIG, @@ -236,7 +236,7 @@ static const vshCmdInfo info_attach_disk[] = { }; static const vshCmdOptDef opts_attach_disk[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "source", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ | VSH_OFLAG_EMPTY_OK, @@ -727,7 +727,7 @@ static const vshCmdInfo info_attach_interface[] = { }; static const vshCmdOptDef opts_attach_interface[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "type", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -1037,7 +1037,7 @@ static const vshCmdInfo info_autostart[] = { }; static const vshCmdOptDef opts_autostart[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "disable", .type = VSH_OT_BOOL, .help = N_("disable autostarting") @@ -1089,7 +1089,7 @@ static const vshCmdInfo info_blkdeviotune[] = { }; static const vshCmdOptDef opts_blkdeviotune[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "device", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -1416,7 +1416,7 @@ static const vshCmdInfo info_blkiotune[] = { }; static const vshCmdOptDef opts_blkiotune[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "weight", .type = VSH_OT_INT, .help = N_("IO Weight") @@ -1885,7 +1885,7 @@ static const vshCmdInfo info_block_commit[] = { }; static const vshCmdOptDef opts_block_commit[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "path", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -2110,7 +2110,7 @@ static const vshCmdInfo info_block_copy[] = { }; static const vshCmdOptDef opts_block_copy[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "path", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -2426,7 +2426,7 @@ static const vshCmdInfo info_block_job[] = { }; static const vshCmdOptDef opts_block_job[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "path", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -2669,7 +2669,7 @@ static const vshCmdInfo info_block_pull[] = { }; static const vshCmdOptDef opts_block_pull[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "path", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -2815,7 +2815,7 @@ static const vshCmdInfo info_block_resize[] = { }; static const vshCmdOptDef opts_block_resize[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "path", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -2879,7 +2879,7 @@ static const vshCmdInfo info_console[] = { }; static const vshCmdOptDef opts_console[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "devname", /* sc_prohibit_devname */ .type = VSH_OT_STRING, .help = N_("character device name") @@ -2973,7 +2973,7 @@ static const vshCmdInfo info_domif_setlink[] = { }; static const vshCmdOptDef opts_domif_setlink[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -3143,7 +3143,7 @@ static const vshCmdInfo info_domiftune[] = { }; static const vshCmdOptDef opts_domiftune[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -3340,7 +3340,7 @@ static const vshCmdInfo info_suspend[] = { }; static const vshCmdOptDef opts_suspend[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_RUNNING), {.name = NULL} }; @@ -3382,7 +3382,7 @@ static const vshCmdInfo info_dom_pm_suspend[] = { }; static const vshCmdOptDef opts_dom_pm_suspend[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_RUNNING), {.name = "target", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -3460,7 +3460,7 @@ static const vshCmdInfo info_dom_pm_wakeup[] = { }; static const vshCmdOptDef opts_dom_pm_wakeup[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_OTHER), {.name = NULL} }; @@ -3505,7 +3505,7 @@ static const vshCmdInfo info_undefine[] = { }; static const vshCmdOptDef opts_undefine[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_PERSISTENT), {.name = "managed-save", .type = VSH_OT_BOOL, .help = N_("remove domain managed state file") @@ -3923,7 +3923,8 @@ static const vshCmdInfo info_start[] = { }; static const vshCmdOptDef opts_start[] = { - VIRSH_COMMON_OPT_DOMAIN(N_("name of the inactive domain")), + VIRSH_COMMON_OPT_DOMAIN(N_("name of the inactive domain"), + VIR_CONNECT_LIST_DOMAINS_SHUTOFF), #ifndef WIN32 {.name = "console", .type = VSH_OT_BOOL, @@ -4098,7 +4099,7 @@ static const vshCmdInfo info_save[] = { }; static const vshCmdOptDef opts_save[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), VIRSH_COMMON_OPT_FILE(N_("where to save the data")), {.name = "bypass-cache", .type = VSH_OT_BOOL, @@ -4544,7 +4545,7 @@ static const vshCmdInfo info_managedsave[] = { }; static const vshCmdOptDef opts_managedsave[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "bypass-cache", .type = VSH_OT_BOOL, .help = N_("avoid file system cache when saving") @@ -4663,7 +4664,7 @@ static const vshCmdInfo info_managedsaveremove[] = { }; static const vshCmdOptDef opts_managedsaveremove[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = NULL} }; @@ -4718,7 +4719,7 @@ static const vshCmdInfo info_managed_save_edit[] = { }; static const vshCmdOptDef opts_managed_save_edit[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "running", .type = VSH_OT_BOOL, .help = N_("set domain to be running on start") @@ -4784,7 +4785,7 @@ static const vshCmdInfo info_managed_save_dumpxml[] = { }; static const vshCmdOptDef opts_managed_save_dumpxml[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "security-info", .type = VSH_OT_BOOL, .help = N_("include security sensitive information in XML dump") @@ -4832,7 +4833,7 @@ static const vshCmdInfo info_managed_save_define[] = { }; static const vshCmdOptDef opts_managed_save_define[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "xml", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -4904,7 +4905,7 @@ static const vshCmdInfo info_schedinfo[] = { }; static const vshCmdOptDef opts_schedinfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "weight", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ_OPT, @@ -5215,7 +5216,7 @@ static const vshCmdInfo info_dump[] = { }; static const vshCmdOptDef opts_dump[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), VIRSH_COMMON_OPT_FILE(N_("where to dump the core")), VIRSH_COMMON_OPT_LIVE(N_("perform a live core dump if supported")), {.name = "crash", @@ -5387,7 +5388,7 @@ static const vshCmdInfo info_screenshot[] = { }; static const vshCmdOptDef opts_screenshot[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "file", .type = VSH_OT_STRING, .help = N_("where to store the screenshot") @@ -5530,7 +5531,7 @@ static const vshCmdInfo info_setLifecycleAction[] = { }; static const vshCmdOptDef opts_setLifecycleAction[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "type", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -5626,7 +5627,7 @@ static const vshCmdInfo info_set_user_password[] = { }; static const vshCmdOptDef opts_set_user_password[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "user", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -5690,7 +5691,7 @@ static const vshCmdInfo info_resume[] = { }; static const vshCmdOptDef opts_resume[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_PAUSED), {.name = NULL} }; @@ -5729,7 +5730,7 @@ static const vshCmdInfo info_shutdown[] = { }; static const vshCmdOptDef opts_shutdown[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "mode", .type = VSH_OT_STRING, .help = N_("shutdown mode: acpi|agent|initctl|signal|paravirt") @@ -5813,7 +5814,7 @@ static const vshCmdInfo info_reboot[] = { }; static const vshCmdOptDef opts_reboot[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "mode", .type = VSH_OT_STRING, .help = N_("shutdown mode: acpi|agent|initctl|signal|paravirt") @@ -5892,7 +5893,7 @@ static const vshCmdInfo info_reset[] = { }; static const vshCmdOptDef opts_reset[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = NULL} }; @@ -5931,7 +5932,7 @@ static const vshCmdInfo info_domjobinfo[] = { }; static const vshCmdOptDef opts_domjobinfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "completed", .type = VSH_OT_BOOL, .help = N_("return statistics of a recently completed job") @@ -6275,7 +6276,7 @@ static const vshCmdInfo info_domjobabort[] = { }; static const vshCmdOptDef opts_domjobabort[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -6309,7 +6310,7 @@ static const vshCmdInfo info_vcpucount[] = { }; static const vshCmdOptDef opts_vcpucount[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "maximum", .type = VSH_OT_BOOL, .help = N_("get maximum count of vcpus") @@ -6506,7 +6507,7 @@ static const vshCmdInfo info_vcpuinfo[] = { }; static const vshCmdOptDef opts_vcpuinfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "pretty", .type = VSH_OT_BOOL, .help = N_("return human readable output") @@ -6755,7 +6756,7 @@ static const vshCmdInfo info_vcpupin[] = { }; static const vshCmdOptDef opts_vcpupin[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "vcpu", .type = VSH_OT_INT, .help = N_("vcpu number") @@ -6972,7 +6973,7 @@ static const vshCmdInfo info_emulatorpin[] = { }; static const vshCmdOptDef opts_emulatorpin[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "cpulist", .type = VSH_OT_STRING, .flags = VSH_OFLAG_EMPTY_OK, @@ -7076,7 +7077,7 @@ static const vshCmdInfo info_setvcpus[] = { }; static const vshCmdOptDef opts_setvcpus[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "count", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, @@ -7174,7 +7175,7 @@ static const vshCmdInfo info_guestvcpus[] = { }; static const vshCmdOptDef opts_guestvcpus[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "cpulist", .type = VSH_OT_STRING, .help = N_("list of cpus to enable or disable") @@ -7259,7 +7260,7 @@ static const vshCmdInfo info_setvcpu[] = { }; static const vshCmdOptDef opts_setvcpu[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "vcpulist", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -7342,7 +7343,7 @@ static const vshCmdInfo info_domblkthreshold[] = { }; static const vshCmdOptDef opts_domblkthreshold[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "dev", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -7398,7 +7399,7 @@ static const vshCmdInfo info_iothreadinfo[] = { {.name = NULL} }; static const vshCmdOptDef opts_iothreadinfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), VIRSH_COMMON_OPT_DOMAIN_CONFIG, VIRSH_COMMON_OPT_DOMAIN_LIVE, VIRSH_COMMON_OPT_DOMAIN_CURRENT, @@ -7474,7 +7475,7 @@ static const vshCmdInfo info_iothreadpin[] = { }; static const vshCmdOptDef opts_iothreadpin[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "iothread", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, @@ -7556,7 +7557,7 @@ static const vshCmdInfo info_iothreadadd[] = { }; static const vshCmdOptDef opts_iothreadadd[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "id", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, @@ -7621,7 +7622,7 @@ static const vshCmdInfo info_iothreaddel[] = { }; static const vshCmdOptDef opts_iothreaddel[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "id", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, @@ -7897,7 +7898,7 @@ static const vshCmdInfo info_cpu_stats[] = { }; static const vshCmdOptDef opts_cpu_stats[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "total", .type = VSH_OT_BOOL, .help = N_("Show total statistics only") @@ -8236,7 +8237,7 @@ static const vshCmdInfo info_destroy[] = { }; static const vshCmdOptDef opts_destroy[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "graceful", .type = VSH_OT_BOOL, .help = N_("terminate gracefully") @@ -8289,7 +8290,7 @@ static const vshCmdInfo info_desc[] = { }; static const vshCmdOptDef opts_desc[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), VIRSH_COMMON_OPT_LIVE(N_("modify/get running state")), VIRSH_COMMON_OPT_CONFIG(N_("modify/get persistent configuration")), VIRSH_COMMON_OPT_CURRENT(N_("modify/get current state configuration")), @@ -8454,7 +8455,7 @@ static const vshCmdInfo info_metadata[] = { }; static const vshCmdOptDef opts_metadata[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "uri", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -8600,7 +8601,7 @@ static const vshCmdInfo info_inject_nmi[] = { }; static const vshCmdOptDef opts_inject_nmi[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -8634,7 +8635,7 @@ static const vshCmdInfo info_send_key[] = { }; static const vshCmdOptDef opts_send_key[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "codeset", .type = VSH_OT_STRING, .flags = VSH_OFLAG_REQ_OPT, @@ -8730,7 +8731,7 @@ static const vshCmdInfo info_send_process_signal[] = { }; static const vshCmdOptDef opts_send_process_signal[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "pid", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -8835,7 +8836,7 @@ static const vshCmdInfo info_setmem[] = { }; static const vshCmdOptDef opts_setmem[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "kilobytes", .type = VSH_OT_ALIAS, .help = "size" @@ -8916,7 +8917,7 @@ static const vshCmdInfo info_setmaxmem[] = { }; static const vshCmdOptDef opts_setmaxmem[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "kilobytes", .type = VSH_OT_ALIAS, .help = "size" @@ -9004,7 +9005,7 @@ static const vshCmdInfo info_memtune[] = { }; static const vshCmdOptDef opts_memtune[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "hard-limit", .type = VSH_OT_INT, .help = N_("Max memory, as scaled integer (default KiB)") @@ -9181,7 +9182,7 @@ static const vshCmdInfo info_perf[] = { }; static const vshCmdOptDef opts_perf[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "enable", .type = VSH_OT_STRING, .help = N_("perf events which will be enabled") @@ -9315,7 +9316,7 @@ static const vshCmdInfo info_numatune[] = { }; static const vshCmdOptDef opts_numatune[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "mode", .type = VSH_OT_STRING, .help = N_("NUMA mode, one of strict, preferred and interleave \n" @@ -9450,7 +9451,7 @@ static const vshCmdInfo info_qemu_monitor_command[] = { }; static const vshCmdOptDef opts_qemu_monitor_command[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "hmp", .type = VSH_OT_BOOL, .help = N_("command is in human monitor protocol") @@ -9751,7 +9752,7 @@ static const vshCmdInfo info_qemu_agent_command[] = { }; static const vshCmdOptDef opts_qemu_agent_command[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "timeout", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ_OPT, @@ -9873,7 +9874,7 @@ static const vshCmdInfo info_lxc_enter_namespace[] = { }; static const vshCmdOptDef opts_lxc_enter_namespace[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "noseclabel", .type = VSH_OT_BOOL, .help = N_("Do not change process security label") @@ -10014,7 +10015,7 @@ static const vshCmdInfo info_dumpxml[] = { }; static const vshCmdOptDef opts_dumpxml[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "inactive", .type = VSH_OT_BOOL, .help = N_("show inactive defined XML") @@ -10223,7 +10224,7 @@ static const vshCmdInfo info_domname[] = { }; static const vshCmdOptDef opts_domname[] = { - VIRSH_COMMON_OPT_DOMAIN(N_("domain id or uuid")), + VIRSH_COMMON_OPT_DOMAIN(N_("domain id or uuid"), 0), {.name = NULL} }; @@ -10255,7 +10256,7 @@ static const vshCmdInfo info_domrename[] = { }; static const vshCmdOptDef opts_domrename[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_INACTIVE), {.name = "new-name", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -10302,7 +10303,8 @@ static const vshCmdInfo info_domid[] = { }; static const vshCmdOptDef opts_domid[] = { - VIRSH_COMMON_OPT_DOMAIN(N_("domain name or uuid")), + VIRSH_COMMON_OPT_DOMAIN(N_("domain name or uuid"), + VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -10339,7 +10341,7 @@ static const vshCmdInfo info_domuuid[] = { }; static const vshCmdOptDef opts_domuuid[] = { - VIRSH_COMMON_OPT_DOMAIN(N_("domain id or name")), + VIRSH_COMMON_OPT_DOMAIN(N_("domain id or name"), 0), {.name = NULL} }; @@ -10376,7 +10378,7 @@ static const vshCmdInfo info_migrate[] = { }; static const vshCmdOptDef opts_migrate[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "desturi", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -10974,7 +10976,7 @@ static const vshCmdInfo info_migrate_setmaxdowntime[] = { }; static const vshCmdOptDef opts_migrate_setmaxdowntime[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "downtime", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, @@ -11025,7 +11027,7 @@ static const vshCmdInfo info_migrate_getmaxdowntime[] = { }; static const vshCmdOptDef opts_migrate_getmaxdowntime[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -11066,7 +11068,7 @@ static const vshCmdInfo info_migrate_compcache[] = { }; static const vshCmdOptDef opts_migrate_compcache[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "size", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ_OPT, @@ -11123,7 +11125,7 @@ static const vshCmdInfo info_migrate_setspeed[] = { }; static const vshCmdOptDef opts_migrate_setspeed[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "bandwidth", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, @@ -11169,7 +11171,7 @@ static const vshCmdInfo info_migrate_getspeed[] = { }; static const vshCmdOptDef opts_migrate_getspeed[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -11252,7 +11254,7 @@ static const vshCmdInfo info_domdisplay[] = { }; static const vshCmdOptDef opts_domdisplay[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "include-password", .type = VSH_OT_BOOL, .help = N_("includes the password into the connection URI if available") @@ -11533,7 +11535,7 @@ static const vshCmdInfo info_vncdisplay[] = { }; static const vshCmdOptDef opts_vncdisplay[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -11609,7 +11611,7 @@ static const vshCmdInfo info_ttyconsole[] = { }; static const vshCmdOptDef opts_ttyconsole[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; @@ -11651,7 +11653,7 @@ static const vshCmdInfo info_domhostname[] = { }; static const vshCmdOptDef opts_domhostname[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = NULL} }; @@ -11810,7 +11812,7 @@ static const vshCmdInfo info_detach_device[] = { }; static const vshCmdOptDef opts_detach_device[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), VIRSH_COMMON_OPT_FILE(N_("XML file")), VIRSH_COMMON_OPT_DOMAIN_PERSISTENT, VIRSH_COMMON_OPT_DOMAIN_CONFIG, @@ -11891,7 +11893,7 @@ static const vshCmdInfo info_update_device[] = { }; static const vshCmdOptDef opts_update_device[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), VIRSH_COMMON_OPT_FILE(N_("XML file")), VIRSH_COMMON_OPT_DOMAIN_PERSISTENT, VIRSH_COMMON_OPT_DOMAIN_CONFIG, @@ -11973,7 +11975,7 @@ static const vshCmdInfo info_detach_interface[] = { }; static const vshCmdOptDef opts_detach_interface[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "type", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -12416,7 +12418,7 @@ static const vshCmdInfo info_detach_disk[] = { }; static const vshCmdOptDef opts_detach_disk[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "target", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -12516,7 +12518,7 @@ static const vshCmdInfo info_edit[] = { }; static const vshCmdOptDef opts_edit[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "skip-validate", .type = VSH_OT_BOOL, .help = N_("skip validation of the XML against the schema") @@ -13475,7 +13477,7 @@ static const vshCmdInfo info_change_media[] = { }; static const vshCmdOptDef opts_change_media[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "path", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -13636,7 +13638,7 @@ static const vshCmdInfo info_domfstrim[] = { }; static const vshCmdOptDef opts_domfstrim[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "minimum", .type = VSH_OT_INT, .help = N_("Just a hint to ignore contiguous " @@ -13689,7 +13691,7 @@ static const vshCmdInfo info_domfsfreeze[] = { }; static const vshCmdOptDef opts_domfsfreeze[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "mountpoint", .type = VSH_OT_ARGV, .help = N_("mountpoint path to be frozen") @@ -13742,7 +13744,7 @@ static const vshCmdInfo info_domfsthaw[] = { }; static const vshCmdOptDef opts_domfsthaw[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = "mountpoint", .type = VSH_OT_ARGV, .help = N_("mountpoint path to be thawed") @@ -13795,7 +13797,7 @@ static const vshCmdInfo info_domfsinfo[] = { }; static const vshCmdOptDef opts_domfsinfo[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(VIR_CONNECT_LIST_DOMAINS_ACTIVE), {.name = NULL} }; diff --git a/tools/virsh-snapshot.c b/tools/virsh-snapshot.c index cd89a414a..c44a36f98 100644 --- a/tools/virsh-snapshot.c +++ b/tools/virsh-snapshot.c @@ -42,8 +42,8 @@ #include "virxml.h" #include "conf/snapshot_conf.h" -#define VIRSH_COMMON_OPT_DOMAIN_FULL \ - VIRSH_COMMON_OPT_DOMAIN(N_("domain name, id or uuid")) +#define VIRSH_COMMON_OPT_DOMAIN_FULL(cflags) \ + VIRSH_COMMON_OPT_DOMAIN(N_("domain name, id or uuid"), cflags) /* Helper for snapshot-create and snapshot-create-as */ static bool @@ -125,7 +125,7 @@ static const vshCmdInfo info_snapshot_create[] = { }; static const vshCmdOptDef opts_snapshot_create[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "xmlfile", .type = VSH_OT_STRING, .help = N_("domain snapshot XML") @@ -319,7 +319,7 @@ static const vshCmdInfo info_snapshot_create_as[] = { }; static const vshCmdOptDef opts_snapshot_create_as[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "name", .type = VSH_OT_STRING, .help = N_("name of snapshot") @@ -508,7 +508,7 @@ static const vshCmdInfo info_snapshot_edit[] = { }; static const vshCmdOptDef opts_snapshot_edit[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "snapshotname", .type = VSH_OT_STRING, .help = N_("snapshot name") @@ -620,7 +620,7 @@ static const vshCmdInfo info_snapshot_current[] = { }; static const vshCmdOptDef opts_snapshot_current[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "name", .type = VSH_OT_BOOL, .help = N_("list the name, rather than the full xml") @@ -851,7 +851,7 @@ static const vshCmdInfo info_snapshot_info[] = { }; static const vshCmdOptDef opts_snapshot_info[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "snapshotname", .type = VSH_OT_STRING, .help = N_("snapshot name") @@ -1401,7 +1401,7 @@ static const vshCmdInfo info_snapshot_list[] = { }; static const vshCmdOptDef opts_snapshot_list[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "parent", .type = VSH_OT_BOOL, .help = N_("add a column showing parent snapshot") @@ -1657,7 +1657,7 @@ static const vshCmdInfo info_snapshot_dumpxml[] = { }; static const vshCmdOptDef opts_snapshot_dumpxml[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "snapshotname", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, @@ -1720,7 +1720,7 @@ static const vshCmdInfo info_snapshot_parent[] = { }; static const vshCmdOptDef opts_snapshot_parent[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "snapshotname", .type = VSH_OT_STRING, .help = N_("find parent of snapshot name") @@ -1779,7 +1779,7 @@ static const vshCmdInfo info_snapshot_revert[] = { }; static const vshCmdOptDef opts_snapshot_revert[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "snapshotname", .type = VSH_OT_STRING, .help = N_("snapshot name") @@ -1863,7 +1863,7 @@ static const vshCmdInfo info_snapshot_delete[] = { }; static const vshCmdOptDef opts_snapshot_delete[] = { - VIRSH_COMMON_OPT_DOMAIN_FULL, + VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "snapshotname", .type = VSH_OT_STRING, .help = N_("snapshot name") diff --git a/tools/virsh.h b/tools/virsh.h index b353b645a..528e04558 100644 --- a/tools/virsh.h +++ b/tools/virsh.h @@ -38,6 +38,7 @@ # include "virthread.h" # include "virpolkit.h" # include "vsh.h" +# include "virsh-completer.h" # define VIRSH_PROMPT_RW "virsh # " # define VIRSH_PROMPT_RO "virsh > " @@ -70,11 +71,13 @@ .help = _helpstr \ } -# define VIRSH_COMMON_OPT_DOMAIN(_helpstr) \ +# define VIRSH_COMMON_OPT_DOMAIN(_helpstr, cflags) \ {.name = "domain", \ .type = VSH_OT_DATA, \ .flags = VSH_OFLAG_REQ, \ - .help = _helpstr \ + .help = _helpstr, \ + .completer = virshDomainNameCompleter, \ + .completer_flags = cflags, \ } # define VIRSH_COMMON_OPT_CONFIG(_helpstr) \ -- 2.13.6
For given domain fetch list of defined interfaces. This can be used for commands like domif-getlink and others. If available, the interface name is returned (e.g. "vnet0", usually available only for running domains), if not the MAC address is returned. Moreover, the detach-interface command requires only MAC address and therefore we have new flag that forces the completer to return just the MAC address. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/virsh-completer.c | 60 ++++++++++++++++++++++++++++++++++++++++++++ tools/virsh-completer.h | 8 ++++++ tools/virsh-domain-monitor.c | 3 +++ tools/virsh-domain.c | 4 +++ 4 files changed, 75 insertions(+) diff --git a/tools/virsh-completer.c b/tools/virsh-completer.c index 4e32b882b..25c3aaa0d 100644 --- a/tools/virsh-completer.c +++ b/tools/virsh-completer.c @@ -29,6 +29,7 @@ #include "internal.h" #include "viralloc.h" #include "virstring.h" +#include "virxml.h" char ** @@ -88,3 +89,62 @@ virshDomainNameCompleter(vshControl *ctl, VIR_FREE(ret); return NULL; } + + +char ** +virshDomainInterfaceCompleter(vshControl *ctl, + const vshCmd *cmd, + unsigned int flags) +{ + virshControlPtr priv = ctl->privData; + xmlDocPtr xmldoc = NULL; + xmlXPathContextPtr ctxt = NULL; + int ninterfaces; + xmlNodePtr *interfaces = NULL; + size_t i; + unsigned int domainXMLFlags = 0; + char **ret = NULL; + + virCheckFlags(VIRSH_DOMAIN_INTERFACE_COMPLETER_MAC, NULL); + + if (!priv->conn || virConnectIsAlive(priv->conn) <= 0) + return NULL; + + if (vshCommandOptBool(cmd, "config")) + domainXMLFlags = VIR_DOMAIN_XML_INACTIVE; + + if (virshDomainGetXML(ctl, cmd, domainXMLFlags, &xmldoc, &ctxt) < 0) + goto error; + + ninterfaces = virXPathNodeSet("./devices/interface", ctxt, &interfaces); + if (ninterfaces < 0) + goto error; + + if (VIR_ALLOC_N(ret, ninterfaces + 1) < 0) + goto error; + + for (i = 0; i < ninterfaces; i++) { + ctxt->node = interfaces[i]; + + if (!(flags & VIRSH_DOMAIN_INTERFACE_COMPLETER_MAC) && + (ret[i] = virXPathString("string(./target/@dev)", ctxt))) + continue; + + /* In case we are dealing with inactive domain XML there's no + * <target dev=''/>. Offer MAC addresses then. */ + if (!(ret[i] = virXPathString("string(./mac/@address)", ctxt))) + goto error; + } + + VIR_FREE(interfaces); + xmlFreeDoc(xmldoc); + xmlXPathFreeContext(ctxt); + return ret; + + error: + VIR_FREE(interfaces); + xmlFreeDoc(xmldoc); + xmlXPathFreeContext(ctxt); + virStringListFree(ret); + return NULL; +} diff --git a/tools/virsh-completer.h b/tools/virsh-completer.h index 288e17909..680cd12ff 100644 --- a/tools/virsh-completer.h +++ b/tools/virsh-completer.h @@ -30,4 +30,12 @@ char ** virshDomainNameCompleter(vshControl *ctl, const vshCmd *cmd, unsigned int flags); +enum { + VIRSH_DOMAIN_INTERFACE_COMPLETER_MAC = 1 << 1, /* Return just MACs */ +}; + +char ** virshDomainInterfaceCompleter(vshControl *ctl, + const vshCmd *cmd, + unsigned int flags); + #endif diff --git a/tools/virsh-domain-monitor.c b/tools/virsh-domain-monitor.c index a09eb010c..32a42707e 100644 --- a/tools/virsh-domain-monitor.c +++ b/tools/virsh-domain-monitor.c @@ -659,6 +659,7 @@ static const vshCmdOptDef opts_domif_getlink[] = { {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = virshDomainInterfaceCompleter, .help = N_("interface device (MAC Address)") }, {.name = "persistent", @@ -995,6 +996,7 @@ static const vshCmdOptDef opts_domifstat[] = { {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = virshDomainInterfaceCompleter, .help = N_("interface device specified by name or MAC Address") }, {.name = NULL} @@ -2149,6 +2151,7 @@ static const vshCmdOptDef opts_domifaddr[] = { {.name = "interface", .type = VSH_OT_STRING, .flags = VSH_OFLAG_NONE, + .completer = virshDomainInterfaceCompleter, .help = N_("network interface name")}, {.name = "full", .type = VSH_OT_BOOL, diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c index 13f8db3dd..0f329d6d7 100644 --- a/tools/virsh-domain.c +++ b/tools/virsh-domain.c @@ -2977,6 +2977,7 @@ static const vshCmdOptDef opts_domif_setlink[] = { {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = virshDomainInterfaceCompleter, .help = N_("interface device (MAC Address)") }, {.name = "state", @@ -3147,6 +3148,7 @@ static const vshCmdOptDef opts_domiftune[] = { {.name = "interface", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = virshDomainInterfaceCompleter, .help = N_("interface device (MAC Address)") }, {.name = "inbound", @@ -11983,6 +11985,8 @@ static const vshCmdOptDef opts_detach_interface[] = { }, {.name = "mac", .type = VSH_OT_STRING, + .completer = virshDomainInterfaceCompleter, + .completer_flags = VIRSH_DOMAIN_INTERFACE_COMPLETER_MAC, .help = N_("MAC address") }, VIRSH_COMMON_OPT_DOMAIN_PERSISTENT, -- 2.13.6
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/Makefile.am | 9 ++++++ tools/virt-admin-completer.c | 76 ++++++++++++++++++++++++++++++++++++++++++++ tools/virt-admin-completer.h | 33 +++++++++++++++++++ tools/virt-admin.c | 8 +++++ 4 files changed, 126 insertions(+) create mode 100644 tools/virt-admin-completer.c create mode 100644 tools/virt-admin-completer.h diff --git a/tools/Makefile.am b/tools/Makefile.am index 7466d8282..48125f516 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -258,6 +258,15 @@ virt_admin_SOURCES = \ virt-admin.c virt-admin.h \ $(NULL) +VIRT_ADMIN_COMPLETER = \ + virt-admin-completer.c virt-admin-completer.h + +if WITH_READLINE +virt_admin_SOURCES += $(VIRT_ADMIN_COMPLETER) +else ! WITH_READLINE +EXTRA_DIST += $(VIRT_ADMIN_COMPLETER) +endif ! WITH_READLINE + virt_admin_LDFLAGS = \ $(AM_LDFLAGS) \ $(COVERAGE_LDFLAGS) \ diff --git a/tools/virt-admin-completer.c b/tools/virt-admin-completer.c new file mode 100644 index 000000000..2cd471f32 --- /dev/null +++ b/tools/virt-admin-completer.c @@ -0,0 +1,76 @@ +/* + * virt-admin-completer.c: virt-admin completer callbacks + * + * Copyright (C) 2017 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>. + * + * Michal Privoznik <mprivozn@redhat.com> + * + */ + +#include <config.h> + +#include "virt-admin-completer.h" +#include "internal.h" +#include "virt-admin.h" +#include "viralloc.h" +#include "virstring.h" + + +char ** +vshAdmServerCompleter(vshControl *ctl, + const vshCmd *cmd ATTRIBUTE_UNUSED, + unsigned int flags) +{ + vshAdmControlPtr priv = ctl->privData; + virAdmServerPtr *srvs = NULL; + int nsrvs = 0; + size_t i = 0; + char **ret = NULL; + + virCheckFlags(0, NULL); + + if (!priv->conn || virAdmConnectIsAlive(priv->conn) <= 0) + return NULL; + + /* Obtain a list of available servers on the daemon */ + if ((nsrvs = virAdmConnectListServers(priv->conn, &srvs, 0)) < 0) + return NULL; + + if (VIR_ALLOC_N(ret, nsrvs + 1) < 0) + goto error; + + for (i = 0; i < nsrvs; i++) { + const char *name = virAdmServerGetName(srvs[i]); + + if (VIR_STRDUP(ret[i], name) < 0) + goto error; + + virAdmServerFree(srvs[i]); + } + VIR_FREE(srvs); + + return ret; + + error: + for (; i < nsrvs; i++) + virAdmServerFree(srvs[i]); + VIR_FREE(srvs); + for (i = 0; i < nsrvs; i++) + VIR_FREE(ret[i]); + VIR_FREE(ret); + return ret; +} diff --git a/tools/virt-admin-completer.h b/tools/virt-admin-completer.h new file mode 100644 index 000000000..7507b95c1 --- /dev/null +++ b/tools/virt-admin-completer.h @@ -0,0 +1,33 @@ +/* + * virt-admin-completer.h: virt-admin completer callbacks + * + * Copyright (C) 2017 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>. + * + * Michal Privoznik <mprivozn@redhat.com> + * + */ + +#ifndef VIRT_ADMIN_COMPLETER +# define VIRT_ADMIN_COMPLETER + +# include "vsh.h" + +char ** +vshAdmServerCompleter(vshControl *ctl, + const vshCmd *cmd, + unsigned int flags); +#endif diff --git a/tools/virt-admin.c b/tools/virt-admin.c index ef5bada63..c86b5763a 100644 --- a/tools/virt-admin.c +++ b/tools/virt-admin.c @@ -39,6 +39,7 @@ #include "virthread.h" #include "virgettext.h" #include "virtime.h" +#include "virt-admin-completer.h" /* Gnulib doesn't guarantee SA_SIGINFO support. */ #ifndef SA_SIGINFO @@ -428,6 +429,7 @@ static const vshCmdOptDef opts_srv_threadpool_info[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("Server to retrieve threadpool attributes from."), }, {.name = NULL} @@ -489,6 +491,7 @@ static const vshCmdOptDef opts_srv_threadpool_set[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("Server to alter threadpool attributes on."), }, {.name = "min-workers", @@ -595,6 +598,7 @@ static const vshCmdOptDef opts_srv_clients_list[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("server which to list connected clients from"), }, {.name = NULL} @@ -676,6 +680,7 @@ static const vshCmdOptDef opts_client_info[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("server to which <client> is connected to"), }, {.name = "client", @@ -763,6 +768,7 @@ static const vshCmdOptDef opts_client_disconnect[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("server which the client is currently connected to"), }, {.name = "client", @@ -828,6 +834,7 @@ static const vshCmdOptDef opts_srv_clients_info[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("Server to retrieve the client limits from."), }, {.name = NULL} @@ -887,6 +894,7 @@ static const vshCmdOptDef opts_srv_clients_set[] = { {.name = "server", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, + .completer = vshAdmServerCompleter, .help = N_("Server to alter the client-related configuration limits on."), }, {.name = "max-clients", -- 2.13.6
On Tue, Jan 02, 2018 at 06:11:57PM +0100, Michal Privoznik wrote:
In the future, this function is going to be called from vshReadlineParse() to provide parsed input for completer callbacks. The idea is to allow the callbacks to provide more specific data. For instance, for the following input:
virsh # domifaddr --domain fedora --interface <TAB><TAB>
the --interface completer callback is going to be called. Now, it is more user friendly if the completer offers only those interfaces found in 'fedora' domain. But in order to do that it needs to be able to retrieve partially parsed result.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/virsh.c | 4 +- tools/virt-admin.c | 4 +- tools/vsh.c | 111 +++++++++++++++++++++++++++++++++++++---------------- tools/vsh.h | 2 +- 4 files changed, 82 insertions(+), 39 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index 2366b7b71..34eb592ef 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -1519,11 +1544,12 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) last->next = arg; last = arg;
- vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n", - cmd->name, - opt->name, - opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"), - opt->type != VSH_OT_BOOL ? arg->data : _("(none)")); + if (ctl)
Don't you mean (!partial) here? This change looks weird otherwise. After reading the following patches I see that you call this with ctl == NULL (from readline). That makes sense, but there are few more places where ctl is used even when partial != NULL and that needs to be handled correctly.
On Tue, Jan 02, 2018 at 06:12:01PM +0100, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name);
This can segfault when cmd->skipChecks == False && valid->name == NULL, which is what the assert() guarded before. So either STREQ_NULLABLE or another if.
if (STREQ(name, valid->name)) break; valid++; diff --git a/tools/vsh.h b/tools/vsh.h index 8f7df9ff8..112b1b57d 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -188,7 +188,8 @@ struct _vshCmdDef { struct _vshCmd { const vshCmdDef *def; /* command definition */ vshCmdOpt *opts; /* list of command arguments */ - vshCmd *next; /* next command */ + vshCmd *next; /* next command */ + bool skipChecks; /* skip validity checks when retrieving opts */ };
/* -- 2.13.6
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
On Tue, Jan 02, 2018 at 06:12:09PM +0100, Michal Privoznik wrote:
Now that we have everything prepared let the fun begin. This completer is very simple and returns domain names. Moreover, depending on the command it can return just a subset of domains (e.g. only running/paused/transient/.. ones).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/Makefile.am | 9 +++ tools/virsh-completer.c | 90 +++++++++++++++++++++ tools/virsh-completer.h | 33 ++++++++ tools/virsh-domain-monitor.c | 30 +++---- tools/virsh-domain.c | 182 ++++++++++++++++++++++--------------------- tools/virsh-snapshot.c | 24 +++--- tools/virsh.h | 7 +- 7 files changed, 256 insertions(+), 119 deletions(-) create mode 100644 tools/virsh-completer.c create mode 100644 tools/virsh-completer.h
diff --git a/tools/virsh-completer.c b/tools/virsh-completer.c new file mode 100644 index 000000000..4e32b882b --- /dev/null +++ b/tools/virsh-completer.c @@ -0,0 +1,90 @@ +/* + * virsh-completer.c: virsh completer callbacks + * + * Copyright (C) 2017 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>. + * + * Michal Privoznik <mprivozn@redhat.com>
These two spaces before the name with no indication what the name means (like "Authors" that we have in other files) makes me wonder why do we have names here and there. Publicity?
+ * + */ + +#include <config.h> + +#include "virsh-completer.h" +#include "virsh.h" +#include "virsh-util.h" +#include "internal.h" +#include "viralloc.h" +#include "virstring.h" + + +char ** +virshDomainNameCompleter(vshControl *ctl, + const vshCmd *cmd ATTRIBUTE_UNUSED, + unsigned int flags) +{ + virshControlPtr priv = ctl->privData; + virDomainPtr *domains = NULL; + int ndomains = 0; + size_t i = 0; + char **ret = NULL; + + virCheckFlags(VIR_CONNECT_LIST_DOMAINS_ACTIVE | + VIR_CONNECT_LIST_DOMAINS_INACTIVE | + VIR_CONNECT_LIST_DOMAINS_PERSISTENT | + VIR_CONNECT_LIST_DOMAINS_TRANSIENT | + VIR_CONNECT_LIST_DOMAINS_RUNNING | + VIR_CONNECT_LIST_DOMAINS_PAUSED | + VIR_CONNECT_LIST_DOMAINS_SHUTOFF | + VIR_CONNECT_LIST_DOMAINS_OTHER | + VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE | + VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE | + VIR_CONNECT_LIST_DOMAINS_AUTOSTART | + VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART | + VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT | + VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHOT, + NULL); + + if (!priv->conn || virConnectIsAlive(priv->conn) <= 0) + return NULL; + + if ((ndomains = virConnectListAllDomains(priv->conn, &domains, flags)) < 0) + return NULL; + + if (VIR_ALLOC_N(ret, ndomains + 1) < 0) + goto error; + + for (i = 0; i < ndomains; i++) { + const char *name = virDomainGetName(domains[i]); + + if (VIR_STRDUP(ret[i], name) < 0) + goto error; + + virshDomainFree(domains[i]); + } + VIR_FREE(domains); + + return ret; + error: +
Weird whitespace, I guess the label should've been one line lower. I know, just bikeshedding. Nothing against this patch.
On Tue, Jan 02, 2018 at 06:12:10PM +0100, Michal Privoznik wrote:
For given domain fetch list of defined interfaces. This can be used for commands like domif-getlink and others. If available, the interface name is returned (e.g. "vnet0", usually available only for running domains), if not the MAC address is returned. Moreover, the detach-interface command requires only MAC address and therefore we have new flag that forces the completer to return just the MAC address.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/virsh-completer.c | 60 ++++++++++++++++++++++++++++++++++++++++++++ tools/virsh-completer.h | 8 ++++++ tools/virsh-domain-monitor.c | 3 +++ tools/virsh-domain.c | 4 +++ 4 files changed, 75 insertions(+)
diff --git a/tools/virsh-completer.h b/tools/virsh-completer.h index 288e17909..680cd12ff 100644 --- a/tools/virsh-completer.h +++ b/tools/virsh-completer.h @@ -30,4 +30,12 @@ char ** virshDomainNameCompleter(vshControl *ctl, const vshCmd *cmd, unsigned int flags);
+enum { + VIRSH_DOMAIN_INTERFACE_COMPLETER_MAC = 1 << 1, /* Return just MACs */
Why are you starting from 2? Why not start from 1? Didn't you mean 1 << 0?
On Tue, Jan 02, 2018 at 06:11:53PM +0100, Michal Privoznik wrote:
Technically, this is a v2 of [1], but this implements the feature from different angle and therefore it's a start of new series.
What's implemented? =================== Auto completion for both interactive and non-interactive virsh/virt-admin.
Known limitations ================= Currently, just options completers work. I mean, to bring up list of domains you have to:
virsh # start --domain <TAB><TAB>
Doing bare:
virsh # start <TAB><TAB>
brings up list of --options. With the new approach implemented here it should be easy to implement this. But that can be saved for later.
How to test this? =================
Interactive completion should work out of the box. Just make sure you're connected. Completers don't connect! You certainly don't want ssh's 'Password:' prompt show on <TAB><TAB>, do you? Non-interactive completers do connect, but in order to avoid any password prompts, /dev/stdin is closed before anything else is done. In order to test it, just:
libvirt.git $ source tools/bash-completion/vsh
Now, bash completion should work:
libvirt.git $ ./tools/virsh -c qemu:///system start --domain <TAB><TAB>
Notes =====
As usual, you can find all the patches on my github [2]. I've tried to work in all the review suggestions from v1. Due to changes in design (reusing parse code instead of duplicating it) not all suggestions were possible to work in though.
Michal
ACK to all if you fix the two possible NULL problems (04/18 and 08/18).
1: https://www.redhat.com/archives/libvir-list/2017-November/msg00213.html 2: https://github.com/zippy2/libvirt/tree/bash_autocomplete_v3 (yeah v3, don't ask)
Michal Privoznik (18): vsh: Drop useless check for opts != NULL vsh: Drop useless check for cmd != NULL vshCommandParse: Don't leak @tkdata vshCommandStringParse: Allow retrieving partial result vshReadlineParse: Drop code duplication vshReadlineParse: Escape returned results if needed vshReadlineParse: Use string list vshCommandOpt: Allow caller avoiding assert() util: Introduce virStringListMerge vsh: Fix vshCompleter signature vsh: Call vshCmdOptDef completer vsh: Prune string list returned by completer vsh: Filter --options vsh: Introduce complete command tools: Provide bash autompletion file virsh: Introduce virshDomainNameCompleter virsh: Introduce virshDomainInterfaceCompleter virt-admin: Introduce vshAdmServerCompleter
configure.ac | 3 + libvirt.spec.in | 3 + m4/virt-bash-completion.m4 | 74 +++++ src/libvirt_private.syms | 1 + src/util/virstring.c | 36 +++ src/util/virstring.h | 3 + tools/Makefile.am | 40 ++- tools/bash-completion/vsh | 67 +++++ tools/virsh-completer.c | 150 ++++++++++ tools/virsh-completer.h | 41 +++ tools/virsh-domain-monitor.c | 33 ++- tools/virsh-domain.c | 186 ++++++------ tools/virsh-snapshot.c | 24 +- tools/virsh.c | 5 +- tools/virsh.h | 7 +- tools/virt-admin-completer.c | 76 +++++ tools/virt-admin-completer.h | 33 +++ tools/virt-admin.c | 13 +- tools/vsh.c | 663 ++++++++++++++++++++++++++----------------- tools/vsh.h | 23 +- 20 files changed, 1097 insertions(+), 384 deletions(-) create mode 100644 m4/virt-bash-completion.m4 create mode 100644 tools/bash-completion/vsh create mode 100644 tools/virsh-completer.c create mode 100644 tools/virsh-completer.h create mode 100644 tools/virt-admin-completer.c create mode 100644 tools/virt-admin-completer.h
-- 2.13.6
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
On 01/11/2018 05:50 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:12:01PM +0100, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name);
This can segfault when cmd->skipChecks == False && valid->name == NULL, which is what the assert() guarded before.
So either STREQ_NULLABLE or another if.
Hmmm... Also see: https://www.redhat.com/archives/libvir-list/2017-December/msg00605.html it's related somewhat... John
if (STREQ(name, valid->name)) break; valid++; diff --git a/tools/vsh.h b/tools/vsh.h index 8f7df9ff8..112b1b57d 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -188,7 +188,8 @@ struct _vshCmdDef { struct _vshCmd { const vshCmdDef *def; /* command definition */ vshCmdOpt *opts; /* list of command arguments */ - vshCmd *next; /* next command */ + vshCmd *next; /* next command */ + bool skipChecks; /* skip validity checks when retrieving opts */ };
/* -- 2.13.6
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
On Thu, Jan 11, 2018 at 06:02:58AM -0500, John Ferlan wrote:
On 01/11/2018 05:50 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:12:01PM +0100, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name);
This can segfault when cmd->skipChecks == False && valid->name == NULL, which is what the assert() guarded before.
So either STREQ_NULLABLE or another if.
Hmmm... Also see:
https://www.redhat.com/archives/libvir-list/2017-December/msg00605.html
it's related somewhat...
I don't see how, this is all wrapped in `while (valid)`
On 01/11/2018 07:55 AM, Martin Kletzander wrote:
On Thu, Jan 11, 2018 at 06:02:58AM -0500, John Ferlan wrote:
On 01/11/2018 05:50 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:12:01PM +0100, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name);
This can segfault when cmd->skipChecks == False && valid->name == NULL, which is what the assert() guarded before.
So either STREQ_NULLABLE or another if.
Hmmm... Also see:
https://www.redhat.com/archives/libvir-list/2017-December/msg00605.html
it's related somewhat...
I don't see how, this is all wrapped in `while (valid)`
The other patch is "after" the loop. Look at the entire context... although we know it's a software engineering error to not have some sort of match, some compiler believes we can exit the "while (valid)" loop with "valid == NULL", follwed by the next assert which dereferences @valid without asserting if valid is non-NULL. I didn't say it was exactly related, just "related somewhat". John
On Thu, Jan 11, 2018 at 08:09:25AM -0500, John Ferlan wrote:
On 01/11/2018 07:55 AM, Martin Kletzander wrote:
On Thu, Jan 11, 2018 at 06:02:58AM -0500, John Ferlan wrote:
On 01/11/2018 05:50 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:12:01PM +0100, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name);
This can segfault when cmd->skipChecks == False && valid->name == NULL, which is what the assert() guarded before.
So either STREQ_NULLABLE or another if.
Hmmm... Also see:
https://www.redhat.com/archives/libvir-list/2017-December/msg00605.html
it's related somewhat...
I don't see how, this is all wrapped in `while (valid)`
The other patch is "after" the loop.
Look at the entire context... although we know it's a software engineering error to not have some sort of match, some compiler believes we can exit the "while (valid)" loop with "valid == NULL", follwed by the next assert which dereferences @valid without asserting if valid is non-NULL.
Oh, I guess that patch from Marc should be pushed (I still didn't get to soooo many patches on the list) and this should then handle addition to that change as well. I got confused by your vague "somewhat related" =)
I didn't say it was exactly related, just "related somewhat".
John
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
On 01/11/2018 11:48 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:11:57PM +0100, Michal Privoznik wrote:
In the future, this function is going to be called from vshReadlineParse() to provide parsed input for completer callbacks. The idea is to allow the callbacks to provide more specific data. For instance, for the following input:
virsh # domifaddr --domain fedora --interface <TAB><TAB>
the --interface completer callback is going to be called. Now, it is more user friendly if the completer offers only those interfaces found in 'fedora' domain. But in order to do that it needs to be able to retrieve partially parsed result.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/virsh.c | 4 +- tools/virt-admin.c | 4 +- tools/vsh.c | 111 +++++++++++++++++++++++++++++++++++++---------------- tools/vsh.h | 2 +- 4 files changed, 82 insertions(+), 39 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index 2366b7b71..34eb592ef 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -1519,11 +1544,12 @@ vshCommandParse(vshControl *ctl, vshCommandParser *parser) last->next = arg; last = arg;
- vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n", - cmd->name, - opt->name, - opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"), - opt->type != VSH_OT_BOOL ? arg->data : _("(none)")); + if (ctl)
Don't you mean (!partial) here? This change looks weird otherwise.
Oh right.
After reading the following patches I see that you call this with ctl == NULL (from readline). That makes sense, but there are few more places where ctl is used even when partial != NULL and that needs to be handled correctly.
Like what? vshError() can handle if ctl is NULL, and subsequently vshMalloc(), vshStrdup(), vshCmddefGetOption() and vshCommandCheckOpts() can too. Michal
On 01/11/2018 02:31 PM, Martin Kletzander wrote:
On Thu, Jan 11, 2018 at 08:09:25AM -0500, John Ferlan wrote:
On 01/11/2018 07:55 AM, Martin Kletzander wrote:
On Thu, Jan 11, 2018 at 06:02:58AM -0500, John Ferlan wrote:
On 01/11/2018 05:50 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:12:01PM +0100, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 7 ++++--- tools/vsh.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/tools/vsh.c b/tools/vsh.c index ebc8d9cb1..d27acb95b 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -829,7 +829,8 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; while (valid) { - assert(valid->name); + if (!cmd->skipChecks) + assert(valid->name);
This can segfault when cmd->skipChecks == False && valid->name == NULL, which is what the assert() guarded before.
So either STREQ_NULLABLE or another if.
Hmmm... Also see:
https://www.redhat.com/archives/libvir-list/2017-December/msg00605.html
it's related somewhat...
I don't see how, this is all wrapped in `while (valid)`
The other patch is "after" the loop.
Look at the entire context... although we know it's a software engineering error to not have some sort of match, some compiler believes we can exit the "while (valid)" loop with "valid == NULL", follwed by the next assert which dereferences @valid without asserting if valid is non-NULL.
Oh, I guess that patch from Marc should be pushed (I still didn't get to soooo many patches on the list) and this should then handle addition to that change as well. I got confused by your vague "somewhat related" =)
I don't think it should be pushed. The whole loop is foobared. I'm looking into it. The problem is, we initialize an array of opts like this: static const vshCmdOptDef opts_iothreadpin[] = { VIRSH_COMMON_OPT_DOMAIN_FULL(0), {.name = "iothread", .type = VSH_OT_INT, .flags = VSH_OFLAG_REQ, .help = N_("IOThread ID number") }, {.name = "cpulist", .type = VSH_OT_DATA, .flags = VSH_OFLAG_REQ, .help = N_("host cpu number(s) to set") }, VIRSH_COMMON_OPT_DOMAIN_CONFIG, VIRSH_COMMON_OPT_DOMAIN_LIVE, VIRSH_COMMON_OPT_DOMAIN_CURRENT, {.name = NULL} }; So the array is NOT NULL terminated. Therefore, if we iterate over it like this: while (valid) { ... valid++; } we will definitely read outside of the array. But as I've said, I'm looking into this and I think I have a patch ready. But before that, please don't push that patch of Marc's as it's not fixing the real issue. Michal
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts). Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 24 ++++++++++++++---------- tools/vsh.h | 3 ++- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index 54e59fff6..b113c8c95 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -828,15 +828,19 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, /* See if option is valid and/or required. */ *opt = NULL; - while (valid) { - assert(valid->name); - if (STREQ(name, valid->name)) - break; - valid++; + + if (!cmd->skipChecks) { + while (valid && valid->name) { + if (STREQ(name, valid->name)) + break; + valid++; + } + + assert(valid && (!needData || valid->type != VSH_OT_BOOL)); + + if (valid->flags & VSH_OFLAG_REQ) + ret = -1; } - assert(!needData || valid->type != VSH_OT_BOOL); - if (valid->flags & VSH_OFLAG_REQ) - ret = -1; /* See if option is present on command line. */ while (candidate) { diff --git a/tools/vsh.h b/tools/vsh.h index 8f7df9ff8..112b1b57d 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -188,7 +188,8 @@ struct _vshCmdDef { struct _vshCmd { const vshCmdDef *def; /* command definition */ vshCmdOpt *opts; /* list of command arguments */ - vshCmd *next; /* next command */ + vshCmd *next; /* next command */ + bool skipChecks; /* skip validity checks when retrieving opts */ }; /* -- 2.13.6
On 01/11/2018 11:38 AM, Michal Privoznik wrote:
In the future, completer callbacks will receive partially parsed command (and thus possibly incomplete). However, we still want them to use command options fetching APIs we already have (e.g. vshCommandOpt*()) and at the same time don't report any errors (nor call any asserts).
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 24 ++++++++++++++---------- tools/vsh.h | 3 ++- 2 files changed, 16 insertions(+), 11 deletions(-)
Looks good to me... Reviewed-by: John Ferlan <jferlan@redhat.com> Tks- John
diff --git a/tools/vsh.c b/tools/vsh.c index 54e59fff6..b113c8c95 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -815,8 +815,8 @@ vshCommandFree(vshCmd *cmd) * to the option if found, 0 with *OPT set to NULL if the name is * valid and the option is not required, -1 with *OPT set to NULL if * the option is required but not present, and assert if NAME is not - * valid (which indicates a programming error). No error messages are - * issued if a value is returned. + * valid (which indicates a programming error) unless cmd->skipChecks + * is set. No error messages are issued if a value is returned. */ static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt, @@ -828,15 +828,19 @@ vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt,
/* See if option is valid and/or required. */ *opt = NULL; - while (valid) { - assert(valid->name); - if (STREQ(name, valid->name)) - break; - valid++; + + if (!cmd->skipChecks) { + while (valid && valid->name) { + if (STREQ(name, valid->name)) + break; + valid++; + } + + assert(valid && (!needData || valid->type != VSH_OT_BOOL)); + + if (valid->flags & VSH_OFLAG_REQ) + ret = -1; } - assert(!needData || valid->type != VSH_OT_BOOL); - if (valid->flags & VSH_OFLAG_REQ) - ret = -1;
/* See if option is present on command line. */ while (candidate) { diff --git a/tools/vsh.h b/tools/vsh.h index 8f7df9ff8..112b1b57d 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -188,7 +188,8 @@ struct _vshCmdDef { struct _vshCmd { const vshCmdDef *def; /* command definition */ vshCmdOpt *opts; /* list of command arguments */ - vshCmd *next; /* next command */ + vshCmd *next; /* next command */ + bool skipChecks; /* skip validity checks when retrieving opts */ };
/*
On 01/11/2018 11:52 AM, Martin Kletzander wrote:
On Tue, Jan 02, 2018 at 06:11:53PM +0100, Michal Privoznik wrote:
Technically, this is a v2 of [1], but this implements the feature from different angle and therefore it's a start of new series.
What's implemented? =================== Auto completion for both interactive and non-interactive virsh/virt-admin.
Known limitations ================= Currently, just options completers work. I mean, to bring up list of domains you have to:
virsh # start --domain <TAB><TAB>
Doing bare:
virsh # start <TAB><TAB>
brings up list of --options. With the new approach implemented here it should be easy to implement this. But that can be saved for later.
How to test this? =================
Interactive completion should work out of the box. Just make sure you're connected. Completers don't connect! You certainly don't want ssh's 'Password:' prompt show on <TAB><TAB>, do you? Non-interactive completers do connect, but in order to avoid any password prompts, /dev/stdin is closed before anything else is done. In order to test it, just:
libvirt.git $ source tools/bash-completion/vsh
Now, bash completion should work:
libvirt.git $ ./tools/virsh -c qemu:///system start --domain <TAB><TAB>
Notes =====
As usual, you can find all the patches on my github [2]. I've tried to work in all the review suggestions from v1. Due to changes in design (reusing parse code instead of duplicating it) not all suggestions were possible to work in though.
Michal
ACK to all if you fix the two possible NULL problems (04/18 and 08/18).
Thank you guys. I've pushed these. Now all that's left to do is to write the completer callbacks, but that should be fairly easy now O:-) Michal
On 01/02/2018 12:12 PM, Michal Privoznik wrote:
Similarly to the previous commit, once we've presented an --option for a command to the user it makes no sense to offer it again. Therefore, we can prune all already specified options. For instance, after this patch:
virsh # migrate --verbose <TAB><TAB>
will no longer offer --verbose option.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- tools/vsh.c | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-)
diff --git a/tools/vsh.c b/tools/vsh.c index 49e8033bd..f061783e0 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -2769,6 +2769,60 @@ vshCompleterFilter(char ***list, }
+static int +vshReadlineOptionsPrune(char ***list, + vshCmd *last) +{ + char **newList = NULL; + size_t newList_len = 0; + size_t list_len; + size_t i; + + if (!list || !*list) + return -1; + + if (!last->opts) + return 0; + + list_len = virStringListLength((const char **) *list); + + if (VIR_ALLOC_N(newList, list_len + 1) < 0) + return -1; + + for (i = 0; i < list_len; i++) { + const char *list_opt = STRSKIP((*list)[i], "--"); + bool exist = false; + vshCmdOpt *opt = last->opts; + + /* Should never happen (TM) */ + if (!list_opt) + return -1;
But if it does, then you'll lean newList As reported by everyone's favorite tool! John
+ + while (opt) { + if (STREQ(opt->def->name, list_opt)) { + exist = true; + break; + } + + opt = opt->next; + } + + if (exist) { + VIR_FREE((*list)[i]); + continue; + } + + VIR_STEAL_PTR(newList[newList_len], (*list)[i]); + newList_len++; + } + + ignore_value(VIR_REALLOC_N_QUIET(newList, newList_len + 1)); + VIR_FREE(*list); + *list = newList; + return 0; +} + + static char * vshReadlineParse(const char *text, int state) { @@ -2817,9 +2871,13 @@ vshReadlineParse(const char *text, int state) if (!cmd) { list = vshReadlineCommandGenerator(text); } else { - if (!opt || opt->type != VSH_OT_DATA) + if (!opt || opt->type != VSH_OT_DATA) { list = vshReadlineOptionsGenerator(text, cmd);
+ if (vshReadlineOptionsPrune(&list, partial) < 0) + goto cleanup; + } + if (opt && opt->completer) { char **completer_list = opt->completer(autoCompleteOpaque, partial,
participants (3)
-
John Ferlan -
Martin Kletzander -
Michal Privoznik