On 05/08/2018 04:20 PM, Lin Ma wrote: > The first entry in the returned array is the substitution for TEXT. It > causes unnecessary output if other commands or options share the same > prefix, e.g. > > $ virsh des<TAB><TAB> > des desc destroy > > or > > $ virsh domblklist --d<TAB><TAB> > --d --details --domain > > This patch fixes the above issue. > > Signed-off-by: Lin Ma <lma(a)suse.com&gt; > --- > tools/vsh.c | 6 +++++- > 1 file changed, 5 insertions(+), 1 deletion(-) > > diff --git a/tools/vsh.c b/tools/vsh.c > index 73ec007e56..57f7589b53 100644 > --- a/tools/vsh.c > +++ b/tools/vsh.c > @@ -3458,6 +3458,7 @@ cmdComplete(vshControl *ctl, const vshCmd *cmd) > const vshCmdOpt *opt = NULL; > char **matches = NULL, **iter; > virBuffer buf = VIR_BUFFER_INITIALIZER; > + int n; This needs to be size_t. Even though it's not used to directly access entries of @matches array, it kind of is. It's used to count them. And int is not guaranteed to be able to address all of them. > > if (vshCommandOptStringQuiet(ctl, cmd, "string", &arg) <= 0) > goto cleanup; > @@ -3493,8 +3494,11 @@ cmdComplete(vshControl *ctl, const vshCmd *cmd) > if (!(matches = vshReadlineCompletion(arg, 0, 0))) > goto cleanup; > > - for (iter = matches; *iter; iter++) > + for (n = 0, iter = matches; *iter; iter++, n++) { > + if (n == 0 && matches[1]) > + continue; This can be rewritten so that we don't need @n at all: if (iter == matches && matches[1]) continue; Or even better, just start iterating not from the first but second entry: for (iter = &matches[1]; *iter; iter++) printf("%s\n", *iter);

This is safe because: a) @matches is guaranteed to be non-NULL at this point (due to check above), b) @matches is NULL terminated array and as you and documentation [1] say, the first entry is substitution for text (which we want to skip). So even if the array is nothing but the substitution and NULL, matches[1] will be NULL: matches = { "subs", NULL }; Also, I'm adding a small comment because it is not obvious why we are skipping the first entry. ACK then. Michal 1: http://www.delorie.com/gnu/docs/readline/rlman_46.html

On 05/08/2018 04:20 PM, Lin Ma wrote: > Signed-off-by: Lin Ma <lma(a)suse.com&gt; > --- > tools/virsh-domain.c | 107 +++++++++++++++++++++++++++------------------------ > 1 file changed, 57 insertions(+), 50 deletions(-) > > diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c > index 30da953446..36278ebc1c 100644 > --- a/tools/virsh-domain.c > +++ b/tools/virsh-domain.c > @@ -13335,10 +13335,6 @@ static const vshCmdInfo info_event[] = { > static const vshCmdOptDef opts_event[] = { > VIRSH_COMMON_OPT_DOMAIN_OT_STRING(N_("filter by domain name, id or uuid"), > 0), > - {.name = "event", > - .type = VSH_OT_STRING, > - .help = N_("which event type to wait for") > - }, > {.name = "all", > .type = VSH_OT_BOOL, > .help = N_("wait for all events instead of just one type") > @@ -13359,6 +13355,10 @@ static const vshCmdOptDef opts_event[] = { > .type = VSH_OT_BOOL, > .help = N_("show timestamp for each printed event") > }, > + {.name = "event", > + .type = VSH_OT_ARGV, > + .help = N_("which event type to wait for") > + }, > {.name = NULL} > }; I'm not sure we can do this. Consider somebody has the following line in their script: virsh event domain reboot (which is supposed to wait for reboot event on domain "domain"). However, after your change virsh fails. This would introduce a regression. Not mentioning the fact that documentation needs update too ;-) > > @@ -13368,58 +13368,64 @@ cmdEvent(vshControl *ctl, const vshCmd *cmd) > virDomainPtr dom = NULL; > bool ret = false; > int timeout = 0; > - virshDomEventData *data = NULL; > + virshDomEventData *dataList = NULL; > size_t i; > - const char *eventName = NULL; > - int event = -1; > + int *eventIdxList = NULL; > + size_t nevents = 0; > + int eventid = -1; > bool all = vshCommandOptBool(cmd, "all"); > bool loop = vshCommandOptBool(cmd, "loop"); > bool timestamp = vshCommandOptBool(cmd, "timestamp"); > + bool event = vshCommandOptBool(cmd, "event"); > int count = 0; > + const vshCmdOpt *opt = NULL; > virshControlPtr priv = ctl->privData; > > if (vshCommandOptBool(cmd, "list")) { > - for (event = 0; event < VIR_DOMAIN_EVENT_ID_LAST; event++) > - vshPrint(ctl, "%s\n", vshEventCallbacks[event].name); > + for (eventid = 0; eventid < VIR_DOMAIN_EVENT_ID_LAST; eventid++) > + vshPrint(ctl, "%s\n", vshEventCallbacks[eventid].name); > return true; > } > > - if (vshCommandOptStringReq(ctl, cmd, "event", &eventName) < 0) > - return false; > - if (eventName) { > - for (event = 0; event < VIR_DOMAIN_EVENT_ID_LAST; event++) > - if (STREQ(eventName, vshEventCallbacks[event].name)) > - break; > - if (event == VIR_DOMAIN_EVENT_ID_LAST) { > - vshError(ctl, _("unknown event type %s"), eventName); > - return false; > + if (event) { > + while ((opt = vshCommandOptArgv(ctl, cmd, opt))) { > + if (opt->data) { > + for (eventid = 0; eventid < VIR_DOMAIN_EVENT_ID_LAST; eventid++) > + if (STREQ(opt->data, vshEventCallbacks[eventid].name)) > + break; > + if (eventid == VIR_DOMAIN_EVENT_ID_LAST) { > + vshError(ctl, _("unknown event type %s"), opt->data); > + goto cleanup; > + } > + size_t n = nevents; > + virshDomEventData data; > + data.ctl = ctl; > + data.loop = loop; > + data.count = &count; > + data.timestamp = timestamp; > + data.cb = &vshEventCallbacks[eventid]; > + data.id = -1; > + if (VIR_APPEND_ELEMENT(dataList, nevents, data) < 0) > + goto cleanup; > + if (VIR_APPEND_ELEMENT(eventIdxList, n, eventid) < 0) > + goto cleanup; > + } > } > - } else if (!all) { > - vshError(ctl, "%s", > - _("one of --list, --all, or --event <type> is required")); > - return false; > - } > - > - if (all) { > - if (VIR_ALLOC_N(data, VIR_DOMAIN_EVENT_ID_LAST) < 0) > + } else if (all) { > + if (VIR_ALLOC_N(dataList, VIR_DOMAIN_EVENT_ID_LAST) < 0) > goto cleanup; > for (i = 0; i < VIR_DOMAIN_EVENT_ID_LAST; i++) { > - data[i].ctl = ctl; > - data[i].loop = loop; > - data[i].count = &count; > - data[i].timestamp = timestamp; > - data[i].cb = &vshEventCallbacks[i]; > - data[i].id = -1; > + dataList[i].ctl = ctl; > + dataList[i].loop = loop; > + dataList[i].count = &count; > + dataList[i].timestamp = timestamp; > + dataList[i].cb = &vshEventCallbacks[i]; > + dataList[i].id = -1; How about doing simple: if (event) { parse events into @eventIdxList } else if (all) { VIR_ALLOC_N(eventIdxList, VIR_DOMAIN_EVENT_ID_LAST); for (i = 0; i < VIR_DOMAIN_EVENT_ID_LAST; i++) eventIdxList[i] = i; } The idea is that eventIdxList will be populated in both cases. It simplifies the code a bit because then we don't have to special case on all the places. The @dataList can be constructed outside of those if bodies then. > } > } else { > - if (VIR_ALLOC_N(data, 1) < 0) > - goto cleanup; > - data[0].ctl = ctl; > - data[0].loop = vshCommandOptBool(cmd, "loop"); > - data[0].count = &count; > - data[0].timestamp = timestamp; > - data[0].cb = &vshEventCallbacks[event]; > - data[0].id = -1; > + vshError(ctl, "%s", > + _("one of --list, --all, or --event <type> is required")); > + return false; > } > if (vshCommandOptTimeoutToMs(ctl, cmd, &timeout) < 0) > goto cleanup; > @@ -13431,11 +13437,11 @@ cmdEvent(vshControl *ctl, const vshCmd *cmd) > if (vshEventStart(ctl, timeout) < 0) > goto cleanup; > > - for (i = 0; i < (all ? VIR_DOMAIN_EVENT_ID_LAST : 1); i++) { > - if ((data[i].id = virConnectDomainEventRegisterAny(priv->conn, dom, > - all ? i : event, > - data[i].cb->cb, > - &data[i], > + for (i = 0; i < (event ? nevents : VIR_DOMAIN_EVENT_ID_LAST); i++) { > + if ((dataList[i].id = virConnectDomainEventRegisterAny(priv->conn, dom, > + event ? eventIdxList[i] : i, > + dataList[i].cb->cb, > + &dataList[i], > NULL)) < 0) { > /* When registering for all events: if the first > * registration succeeds, silently ignore failures on all > @@ -13465,14 +13471,15 @@ cmdEvent(vshControl *ctl, const vshCmd *cmd) > > cleanup: > vshEventCleanup(ctl); > - if (data) { > - for (i = 0; i < (all ? VIR_DOMAIN_EVENT_ID_LAST : 1); i++) { > - if (data[i].id >= 0 && > - virConnectDomainEventDeregisterAny(priv->conn, data[i].id) < 0) > + if (dataList) { > + for (i = 0; i < (event ? nevents : VIR_DOMAIN_EVENT_ID_LAST); i++) { > + if (dataList[i].id >= 0 && > + virConnectDomainEventDeregisterAny(priv->conn, dataList[i].id) < 0) > ret = false; > } > - VIR_FREE(data); > + VIR_FREE(dataList); > } > + VIR_FREE(eventIdxList); > virshDomainFree(dom); > return ret; > } > Again, problem is that we cannot do the argument swap like you did. But without it the rest of the patch is needless.

Signed-off-by: Lin Ma <lma(a)suse.com&gt; --- tools/virsh-util.c | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ tools/virsh-util.h | 3 +++ 2 files changed, 63 insertions(+) diff --git a/tools/virsh-util.c b/tools/virsh-util.c index 44be3ad64b..686f9aef98 100644 --- a/tools/virsh-util.c +++ b/tools/virsh-util.c @@ -285,3 +285,63 @@ virshDomainGetXML(vshControl *ctl, return ret; } + + +const char * +virshDomainEventGetName(int event) +{ + switch ((int)event) { + case VIR_DOMAIN_EVENT_ID_LIFECYCLE: + return "lifecycle"; + case VIR_DOMAIN_EVENT_ID_REBOOT: + return "reboot"; + case VIR_DOMAIN_EVENT_ID_RTC_CHANGE: + return "rtc-change"; + case VIR_DOMAIN_EVENT_ID_WATCHDOG: + return "watchdog"; + case VIR_DOMAIN_EVENT_ID_IO_ERROR: + return "io-error"; + case VIR_DOMAIN_EVENT_ID_GRAPHICS: + return "graphics"; + case VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON: + return "io-error-reason"; + case VIR_DOMAIN_EVENT_ID_CONTROL_ERROR: + return "control-error"; + case VIR_DOMAIN_EVENT_ID_BLOCK_JOB: + return "block-job"; + case VIR_DOMAIN_EVENT_ID_DISK_CHANGE: + return "disk-change"; + case VIR_DOMAIN_EVENT_ID_TRAY_CHANGE: + return "tray-change"; + case VIR_DOMAIN_EVENT_ID_PMWAKEUP: + return "pm-wakeup"; + case VIR_DOMAIN_EVENT_ID_PMSUSPEND: + return "pm-suspend"; + case VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE: + return "balloon-change"; + case VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK: + return "pm-suspend-disk"; + case VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED: + return "device-removed"; + case VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2: + return "block-job-2"; + case VIR_DOMAIN_EVENT_ID_TUNABLE: + return "tunable"; + case VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE: + return "agent-lifecycle"; + case VIR_DOMAIN_EVENT_ID_DEVICE_ADDED: + return "device-added"; + case VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION: + return "migration-iteration"; + case VIR_DOMAIN_EVENT_ID_JOB_COMPLETED: + return "job-completed"; + case VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED: + return "device-removal-failed"; + case VIR_DOMAIN_EVENT_ID_METADATA_CHANGE: + return "metadata-change"; + case VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD: + return "block-threshold"; + default: + return NULL; + }

On 05/10/2018 05:17 PM, Michal Privoznik wrote: > On 05/08/2018 04:20 PM, Lin Ma wrote: >> Signed-off-by: Lin Ma <lma(a)suse.com&gt; >> --- >>   tools/virsh-util.c | 60 >> ++++++++++++++++++++++++++++++++++++++++++++++++++++++ >>   tools/virsh-util.h |  3 +++ >>   2 files changed, 63 insertions(+) >> >> diff --git a/tools/virsh-util.c b/tools/virsh-util.c >> index 44be3ad64b..686f9aef98 100644 >> --- a/tools/virsh-util.c >> +++ b/tools/virsh-util.c >> @@ -285,3 +285,63 @@ virshDomainGetXML(vshControl *ctl, >>         return ret; >>   } >> + >> + >> +const char * >> +virshDomainEventGetName(int event) >> +{ >> +    switch ((int)event) { >> +    case VIR_DOMAIN_EVENT_ID_LIFECYCLE: >> +        return "lifecycle"; >> +    case VIR_DOMAIN_EVENT_ID_REBOOT: >> +        return "reboot"; >> +    case VIR_DOMAIN_EVENT_ID_RTC_CHANGE: >> +        return "rtc-change"; >> +    case VIR_DOMAIN_EVENT_ID_WATCHDOG: >> +        return "watchdog"; >> +    case VIR_DOMAIN_EVENT_ID_IO_ERROR: >> +        return "io-error"; >> +    case VIR_DOMAIN_EVENT_ID_GRAPHICS: >> +        return "graphics"; >> +    case VIR_DOMAIN_EVENT_ID_IO_ERROR_REASON: >> +        return "io-error-reason"; >> +    case VIR_DOMAIN_EVENT_ID_CONTROL_ERROR: >> +        return "control-error"; >> +    case VIR_DOMAIN_EVENT_ID_BLOCK_JOB: >> +        return "block-job"; >> +    case VIR_DOMAIN_EVENT_ID_DISK_CHANGE: >> +        return "disk-change"; >> +    case VIR_DOMAIN_EVENT_ID_TRAY_CHANGE: >> +        return "tray-change"; >> +    case VIR_DOMAIN_EVENT_ID_PMWAKEUP: >> +        return "pm-wakeup"; >> +    case VIR_DOMAIN_EVENT_ID_PMSUSPEND: >> +        return "pm-suspend"; >> +    case VIR_DOMAIN_EVENT_ID_BALLOON_CHANGE: >> +        return "balloon-change"; >> +    case VIR_DOMAIN_EVENT_ID_PMSUSPEND_DISK: >> +        return "pm-suspend-disk"; >> +    case VIR_DOMAIN_EVENT_ID_DEVICE_REMOVED: >> +        return "device-removed"; >> +    case VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2: >> +        return "block-job-2"; >> +    case VIR_DOMAIN_EVENT_ID_TUNABLE: >> +        return "tunable"; >> +    case VIR_DOMAIN_EVENT_ID_AGENT_LIFECYCLE: >> +        return "agent-lifecycle"; >> +    case VIR_DOMAIN_EVENT_ID_DEVICE_ADDED: >> +        return "device-added"; >> +    case VIR_DOMAIN_EVENT_ID_MIGRATION_ITERATION: >> +        return "migration-iteration"; >> +    case VIR_DOMAIN_EVENT_ID_JOB_COMPLETED: >> +        return "job-completed"; >> +    case VIR_DOMAIN_EVENT_ID_DEVICE_REMOVAL_FAILED: >> +        return "device-removal-failed"; >> +    case VIR_DOMAIN_EVENT_ID_METADATA_CHANGE: >> +        return "metadata-change"; >> +    case VIR_DOMAIN_EVENT_ID_BLOCK_THRESHOLD: >> +        return "block-threshold"; >> +    default: >> +        return NULL; >> +    } > > Or simply: > > const char * > virshDomainEventGetName(int event) > { >      if (event < 0 || event >= VIR_DOMAIN_EVENT_ID_LAST) >          return NULL; > >      return vshEventCallbacks[event].name; > } > > > I really want to avoid having two places defining strings (one for > command parse code, the other for completions). For using vshEventCallbacks in tools/virsh-util.c, It seems that we need to move lots of code which related to vshEventCallbacks to virsh-util.h or somewhere else. Say those event callback functions and corresponding structures and macros. I'm not sure what is the reasonable way to make it happen, May I have your idea?

(btw, there are other 'vshEventCallbacks' array which defining in virsh-secret.c, virsh-pool.c and virsh-nodedev.c.we only move the vshEventCallbacks and related data structures from virsh-domain.c?)