monitor: Refactoring in preparation for qemu-storage-daemon
v3 cover monitor: Refactoring in preparation for qemu-storage-daemon
This series creates a QAPI module 'control' that can be used from tools outside the system emulator and moves some monitor initialisation code from vl.c to monitor code.
It is split from the series to introduce qemu-storage-daemon because these refactorings make sense on their own as cleanups.
v3:
- Cleaned up #include [Markus]
- Changed schema documenttion headline [Markus]
- Changes comments according to review [Markus]
v2:
- Removed allow_hmp parameter from monitor_init_opts() [Markus]
- Renamed monitor.json to control.json [Markus]
Kevin Wolf (4):
monitor: Move monitor option parsing to monitor/monitor.c
qapi: Create module 'control'
monitor: Create monitor/qmp-cmds-control.c
monitor: Move qmp_query_qmp_schema to qmp-cmds-control.c
qapi/control.json | 218 +++++++++++++++++++++++++++++++++++++ qapi/misc.json | 212 ------------------------------------ qapi/qapi-schema.json | 1 + include/monitor/monitor.h | 3 + include/sysemu/sysemu.h | 1 - monitor/monitor-internal.h | 4 + monitor/hmp-cmds.c | 1 + monitor/misc.c | 127 +-------------------- monitor/monitor.c | 48 ++++++++ monitor/qmp-cmds-control.c | 169 ++++++++++++++++++++++++++++ monitor/qmp-cmds.c | 15 +-- monitor/qmp.c | 2 +- tests/qtest/qmp-test.c | 2 +- ui/gtk.c | 1 + vl.c | 45 +------- monitor/Makefile.objs | 3 +- qapi/Makefile.objs | 6 +- 17 files changed, 455 insertions(+), 403 deletions(-) create mode 100644 qapi/control.json create mode 100644 monitor/qmp-cmds-control.c
Signature · 1 line
2.20.1
PATCH v3 1/4 monitor: Move monitor option parsing to monitor/monitor.c
Both the system emulators and tools with QMP support (specifically, the planned storage daemon) will need to parse monitor options, so move that code to monitor/monitor.c, which can be linked into binaries that aren't a system emulator.
--- include/monitor/monitor.h | 3 +++ include/sysemu/sysemu.h | 1 - monitor/monitor.c | 48 +++++++++++++++++++++++++++++++++++++++ vl.c | 45 +----------------------------------- 4 files changed, 52 insertions(+), 45 deletions(-)
include/monitor/monitor.h +3 -0
@@ -10,12 +10,15 @@ typedef struct MonitorHMP MonitorHMP;#define QMP_REQ_QUEUE_LEN_MAX 8 +extern QemuOptsList qemu_mon_opts; +bool monitor_cur_is_qmp (void );void monitor_init_globals (void );void monitor_init_globals_core (void );void monitor_init_qmp (Chardev *chr,bool pretty);void monitor_init_hmp (Chardev *chr,bool use_readline); +int monitor_init_opts (QemuOpts *opts,Error **errp);void monitor_cleanup (void );int monitor_suspend (Monitor *mon);
include/sysemu/sysemu.h +0 -1
@@ -128,7 +128,6 @@ extern QemuOptsList qemu_netdev_opts;extern QemuOptsList qemu_nic_opts;extern QemuOptsList qemu_net_opts;extern QemuOptsList qemu_global_opts; -extern QemuOptsList qemu_mon_opts;extern QemuOptsList qemu_semihosting_config_opts;#endif
monitor/monitor.c +48 -0
54 lines not on this page · raw message
vl.c +1 -44
51 lines not on this page · raw message
Signature · 1 line
2.20.1
PATCH v3 2/4 qapi: Create module 'control'
In reply to Kevin Wolfmisc.json contains definitions that are related to the system emulator, so it can't be used for other tools like the storage daemon. This patch moves basic functionality that is shared between all tools (and mostly related to the monitor itself) into a new control.json, which could be used in tools as well.
--- qapi/control.json | 218 +++++++++++++++++++++++++++++++++++++ qapi/misc.json | 212 ------------------------------------ qapi/qapi-schema.json | 1 + monitor/monitor-internal.h | 1 + monitor/hmp-cmds.c | 1 + monitor/misc.c | 1 + monitor/qmp-cmds.c | 1 + monitor/qmp.c | 2 +- tests/qtest/qmp-test.c | 2 +- ui/gtk.c | 1 + qapi/Makefile.objs | 6 +- 11 files changed, 229 insertions(+), 217 deletions(-) create mode 100644 qapi/control.json
qapi/control.json new file +218 -0
@@ -0,0 +1,218 @@ +# -*- Mode: Python -*- +# + +## +# = QMP monitor control +## + +## +# @qmp_capabilities: +# +# Enable QMP capabilities. +# +# Arguments: +# +# @enable: An optional list of QMPCapability values to enable. The +# client must not enable any capability that is not +# mentioned in the QMP greeting message. If the field is not +# provided, it means no QMP capabilities will be enabled. +# (since 2.12) +# +# Example: +# +# -> { "execute": "qmp_capabilities", +# "arguments": { "enable": [ "oob" ] } } +# <- { "return": {} } +# +# Notes: This command is valid exactly when first connecting: it must be +# issued before any other command will be accepted, and will fail once the +# monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt) +# +# The QMP client needs to explicitly enable QMP capabilities, otherwise +# all the QMP capabilities will be turned off by default. +# +# Since: 0.13 +# +## +{ 'command': 'qmp_capabilities', + 'data': { '*enable': [ 'QMPCapability' ] }, + 'allow-preconfig': true } + +## +# @QMPCapability: +# +# Enumeration of capabilities to be advertised during initial client +# connection, used for agreeing on particular QMP extension behaviors. +# +# @oob: QMP ability to support out-of-band requests. +# (Please refer to qmp-spec.txt for more information on OOB) +# +# Since: 2.12 +# +## +{ 'enum': 'QMPCapability', + 'data': [ 'oob' ] } + +## +# @VersionTriple: +# +# A three-part version number. +# +# @major: The major version number. +# +# @minor: The minor version number. +# +# @micro: The micro version number. +# +# Since: 2.4 +## +{ 'struct': 'VersionTriple', + 'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} } + + +## +# @VersionInfo: +# +# A description of QEMU's version. +# +# @qemu: The version of QEMU. By current convention, a micro +# version of 50 signifies a development branch. A micro version +# greater than or equal to 90 signifies a release candidate for +# the next minor version. A micro version of less than 50 +# signifies a stable release. +# +# @package: QEMU will always set this field to an empty string. Downstream +# versions of QEMU should set this to a non-empty string. The +# exact format depends on the downstream however it highly +# recommended that a unique name is used. +# +# Since: 0.14.0 +## +{ 'struct': 'VersionInfo', + 'data': {'qemu': 'VersionTriple', 'package': 'str'} } + +## +# @query-version: +# +# Returns the current version of QEMU. +# +# Returns: A @VersionInfo object describing the current version of QEMU. +# +# Since: 0.14.0 +# +# Example: +# +# -> { "execute": "query-version" } +# <- { +# "return":{ +# "qemu":{ +# "major":0, +# "minor":11, +# "micro":5 +# }, +# "package":"" +# } +# } +# +## +{ 'command': 'query-version', 'returns': 'VersionInfo', + 'allow-preconfig': true } + +## +# @CommandInfo: +# +# Information about a QMP command +# +# @name: The command name +# +# Since: 0.14.0 +## +{ 'struct': 'CommandInfo', 'data': {'name': 'str'} } + +## +# @query-commands: +# +# Return a list of supported QMP commands by this server +# +# Returns: A list of @CommandInfo for all supported commands +# +# Since: 0.14.0 +# +# Example: +# +# -> { "execute": "query-commands" } +# <- { +# "return":[ +# { +# "name":"query-balloon" +# }, +# { +# "name":"system_powerdown" +# } +# ] +# } +# +# Note: This example has been shortened as the real response is too long. +# +## +{ 'command': 'query-commands', 'returns': ['CommandInfo'], + 'allow-preconfig': true } + +## +# @EventInfo: +# +# Information about a QMP event +# +# @name: The event name +# +# Since: 1.2.0 +## +{ 'struct': 'EventInfo', 'data': {'name': 'str'} } + +## +# @query-events: +# +# Return information on QMP events. +# +# Returns: A list of @EventInfo. +# +# Since: 1.2.0 +# +# Note: This command is deprecated, because its output doesn't reflect +# compile-time configuration. Use query-qmp-schema instead. +# +# Example: +# +# -> { "execute": "query-events" } +# <- { +# "return": [ +# { +# "name":"SHUTDOWN" +# }, +# { +# "name":"RESET" +# } +# ] +# } +# +# Note: This example has been shortened as the real response is too long. +# +## +{ 'command': 'query-events', 'returns': ['EventInfo'] } + +## +# @quit: +# +# This command will cause the QEMU process to exit gracefully. While every +# attempt is made to send the QMP response before terminating, this is not +# guaranteed. When using this interface, a premature EOF would not be +# unexpected. +# +# Since: 0.14.0 +# +# Example: +# +# -> { "execute": "quit" } +# <- { "return": {} } +## +{ 'command': 'quit' }
qapi/misc.json +0 -212
230 lines not on this page · raw message
qapi/qapi-schema.json +1 -0
@@ -98,6 +98,7 @@ { 'include': 'migration.json' } { 'include': 'transaction.json' } { 'include': 'trace.json' } +{ 'include': 'control.json' } { 'include': 'introspect.json' } { 'include': 'qom.json' } { 'include': 'qdev.json' }
monitor/monitor-internal.h +1 -0
@@ -27,6 +27,7 @@#include "chardev/char-fe.h" #include "monitor/monitor.h" +#include "qapi/qapi-types-control.h" #include "qapi/qmp/dispatch.h" #include "qapi/qmp/json-parser.h" #include "qemu/readline.h"
monitor/hmp-cmds.c +1 -0
@@ -31,6 +31,7 @@#include "qapi/qapi-builtin-visit.h" #include "qapi/qapi-commands-block.h" #include "qapi/qapi-commands-char.h" +#include "qapi/qapi-commands-control.h" #include "qapi/qapi-commands-migration.h" #include "qapi/qapi-commands-misc.h" #include "qapi/qapi-commands-net.h"
monitor/misc.c +1 -0
@@ -67,6 +67,7 @@#include "qemu/thread.h" #include "block/qapi.h" #include "qapi/qapi-commands-char.h" +#include "qapi/qapi-commands-control.h" #include "qapi/qapi-commands-migration.h" #include "qapi/qapi-commands-misc.h" #include "qapi/qapi-commands-qom.h"
monitor/qmp-cmds.c +1 -0
@@ -32,6 +32,7 @@#include "sysemu/block-backend.h" #include "qapi/error.h" #include "qapi/qapi-commands-block-core.h" +#include "qapi/qapi-commands-control.h" #include "qapi/qapi-commands-machine.h" #include "qapi/qapi-commands-misc.h" #include "qapi/qapi-commands-ui.h"
monitor/qmp.c +1 -1
@@ -27,7 +27,7 @@#include "chardev/char-io.h" #include "monitor-internal.h" #include "qapi/error.h" -#include "qapi/qapi-commands-misc.h" +#include "qapi/qapi-commands-control.h" #include "qapi/qmp/qdict.h" #include "qapi/qmp/qjson.h" #include "qapi/qmp/qlist.h"
tests/qtest/qmp-test.c +1 -1
@@ -13,7 +13,7 @@#include "qemu/osdep.h" #include "libqtest.h" #include "qapi/error.h" -#include "qapi/qapi-visit-misc.h" +#include "qapi/qapi-visit-control.h" #include "qapi/qmp/qdict.h" #include "qapi/qmp/qlist.h" #include "qapi/qobject-input-visitor.h"
ui/gtk.c +1 -0
@@ -32,6 +32,7 @@#include "qemu/osdep.h" #include "qapi/error.h" +#include "qapi/qapi-commands-control.h" #include "qapi/qapi-commands-misc.h" #include "qemu/cutils.h"
qapi/Makefile.objs +3 -3
@@ -5,9 +5,9 @@ util-obj-y += opts-visitor.o qapi-clone-visitor.o util-obj-y += qmp-event.o util-obj-y += qapi-util.o -QAPI_COMMON_MODULES = audio authz block-core block char common crypto -QAPI_COMMON_MODULES += dump error introspect job machine migration misc net -QAPI_COMMON_MODULES += qdev qom rdma rocker run-state sockets tpm +QAPI_COMMON_MODULES = audio authz block-core block char common control crypto +QAPI_COMMON_MODULES += dump error introspect job machine migration misc +QAPI_COMMON_MODULES += net qdev qom rdma rocker run-state sockets tpm QAPI_COMMON_MODULES += trace transaction ui QAPI_TARGET_MODULES = machine-target misc-target QAPI_MODULES = $(QAPI_COMMON_MODULES) $(QAPI_TARGET_MODULES)
Signature · 1 line
2.20.1
Re: [PATCH v3 2/4] qapi: Create module 'control'
Quoted 8 lines · Kevin Wolf
misc.json contains definitions that are related to the system emulator, so it can't be used for other tools like the storage daemon. This patch moves basic functionality that is shared between all tools (and mostly related to the monitor itself) into a new control.json, which could be used in tools as well.
Signed-off-by Kevin Wolf <[email protected]>Reviewed-by Markus Armbruster <[email protected]>
I'd like to retitle this patch and the next one:
qapi: Split control.json off misc.json
monitor: Collect "control" command handlers in qmp-cmds.control.c
Okay?
Re: [PATCH v3 2/4] qapi: Create module 'control'
Am 29.01.2020 um 17:35 hat Markus Armbruster geschrieben:
Quoted 11 lines
Quoted 8 lines · Kevin Wolf
misc.json contains definitions that are related to the system emulator, so it can't be used for other tools like the storage daemon. This patch moves basic functionality that is shared between all tools (and mostly related to the monitor itself) into a new control.json, which could be used in tools as well.
Signed-off-by Kevin Wolf <[email protected]>Reviewed-by Markus Armbruster <[email protected]>
Quoted 6 lines
I'd like to retitle this patch and the next one:
qapi: Split control.json off misc.json
monitor: Collect "control" command handlers inqmp-cmds.control.cOkay?
Sure, why not.
Kevin
Markus Armbruster
AppliedRe: [PATCH v3 2/4] qapi: Create module 'control'
Quoted 12 lines · Kevin Wolf
Am 29.01.2020 um 17:35 hat Markus Armbruster geschrieben:
Quoted 11 lines
Quoted 8 lines · Kevin Wolf
misc.json contains definitions that are related to the system emulator, so it can't be used for other tools like the storage daemon. This patch moves basic functionality that is shared between all tools (and mostly related to the monitor itself) into a new control.json, which could be used in tools as well.
Signed-off-by Kevin Wolf <[email protected]>Reviewed-by Markus Armbruster <[email protected]>
Quoted 8 lines
Quoted 6 lines
I'd like to retitle this patch and the next one:
qapi: Split control.json off misc.json
monitor: Collect "control" command handlers inqmp-cmds.control.cOkay?
Sure, why not.
Queued, thanks!
PATCH v3 3/4 monitor: Create monitor/qmp-cmds-control.c
In reply to Kevin WolfMove all of the QMP commands handlers to implement the 'control' module (qapi/control.json) that can be shared between the system emulator and tools such as a storage daemon to a new file monitor/qmp-cmds-control.c.
--- monitor/misc.c | 110 -------------------------- monitor/qmp-cmds-control.c | 153 +++++++++++++++++++++++++++++++++++++ monitor/qmp-cmds.c | 14 ---- monitor/Makefile.objs | 3 +- 4 files changed, 155 insertions(+), 125 deletions(-) create mode 100644 monitor/qmp-cmds-control.c
monitor/misc.c +0 -110
@@ -72,7 +72,6 @@#include "qapi/qapi-commands-misc.h" #include "qapi/qapi-commands-qom.h" #include "qapi/qapi-commands-trace.h" -#include "qapi/qapi-emit-events.h" #include "qapi/qapi-init-commands.h" #include "qapi/error.h" #include "qapi/qmp-event.h"
@@ -233,58 +232,6 @@ static void hmp_info_help(Monitor *mon, const QDict *qdict)help_cmd (mon,"info" ); } -static void query_commands_cb (QmpCommand *cmd,void *opaque) -{ -CommandInfoList *info, **list = opaque; - -if (!cmd->enabled) { -return ; - } - - info =g_malloc0 (sizeof (*info)); - info->value =g_malloc0 (sizeof (*info->value)); - info->value->name =g_strdup (cmd->name); - info->next = *list; - *list = info; -} - -CommandInfoList *qmp_query_commands (Error **errp) -{ -CommandInfoList *list =NULL ; -MonitorQMP *mon; - -assert (monitor_is_qmp (cur_mon)); - mon =container_of (cur_mon, MonitorQMP, common); - -qmp_for_each_command (mon->commands, query_commands_cb, &list); - -return list; -} - -EventInfoList *qmp_query_events (Error **errp) -{ -/* -* TODO This deprecated command is the only user of -* QAPIEvent_str() and QAPIEvent_lookup[]. When the command goes, -* they should go, too. -*/ -EventInfoList *info, *ev_list =NULL ; -QAPIEvent e; - -for (e =0 ; e <QAPI_EVENT__MAX ; e++) { -const char *event_name =QAPIEvent_str (e); -assert (event_name !=NULL ); - info =g_malloc0 (sizeof (*info)); - info->value =g_malloc0 (sizeof (*info->value)); - info->value->name =g_strdup (event_name); - - info->next = ev_list; - ev_list = info; - } - -return ev_list; -} -/* * Minor hack: generated marshalling suppressed for this command * ('gen': false in the schema) so we can parse the JSON string
@@ -323,63 +270,6 @@ static void monitor_init_qmp_commands(void) qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG); } -/* -* Accept QMP capabilities in @list for @mon. -* On success, set mon->qmp.capab[], and return true. -* On error, set @errp, and return false. -*/ -static bool qmp_caps_accept (MonitorQMP *mon,QMPCapabilityList *list, -Error **errp) -{ -GString *unavailable =NULL ; -bool capab[QMP_CAPABILITY__MAX ]; - -memset (capab,0 ,sizeof (capab)); - -for (; list; list = list->next) { -if (!mon->capab_offered[list->value]) { -if (!unavailable) { - unavailable =g_string_new (QMPCapability_str (list->value)); - }else { -g_string_append_printf (unavailable,", %s" , -QMPCapability_str (list->value)); - } - } - capab[list->value] = true; - } - -if (unavailable) { -error_setg (errp,"Capability %s not available" , unavailable->str); -g_string_free (unavailable, true); -return false; - } - -memcpy (mon->capab, capab,sizeof (capab)); -return true; -} - -void qmp_qmp_capabilities (bool has_enable,QMPCapabilityList *enable, -Error **errp) -{ -MonitorQMP *mon; - -assert (monitor_is_qmp (cur_mon)); - mon =container_of (cur_mon, MonitorQMP, common); - -if (mon->commands == &qmp_commands) { -error_set (errp,ERROR_CLASS_COMMAND_NOT_FOUND , -"Capabilities negotiation is already complete, command " -"ignored" ); -return ; - } - -if (!qmp_caps_accept (mon, enable, errp)) { -return ; - } - - mon->commands = &qmp_commands; -} -/* Set the current CPU defined by the user. Callers must hold BQL. */ int monitor_set_cpu (int cpu_index) {
monitor/qmp-cmds-control.c new file +153 -0
153 lines not on this page · raw message
monitor/qmp-cmds.c +0 -14
@@ -15,7 +15,6 @@#include "qemu/osdep.h" #include "qemu-common.h" -#include "qemu-version.h" #include "qemu/cutils.h" #include "qemu/option.h" #include "monitor/monitor.h"
@@ -52,19 +51,6 @@ NameInfo *qmp_query_name(Error **errp)return info; } -VersionInfo *qmp_query_version (Error **errp) -{ -VersionInfo *info =g_new0 (VersionInfo,1 ); - - info->qemu =g_new0 (VersionTriple,1 ); - info->qemu->major =QEMU_VERSION_MAJOR ; - info->qemu->minor =QEMU_VERSION_MINOR ; - info->qemu->micro =QEMU_VERSION_MICRO ; - info->package =g_strdup (QEMU_PKGVERSION ); - -return info; -} -KvmInfo *qmp_query_kvm (Error **errp) {KvmInfo *info =g_malloc0 (sizeof (*info));
monitor/Makefile.objs +2 -1
@@ -1,3 +1,4 @@ obj-y += misc.o common-obj-y += monitor.o qmp.o hmp.o -common-obj-y += qmp-cmds.o hmp-cmds.o +common-obj-y += qmp-cmds.o qmp-cmds-control.o +common-obj-y += hmp-cmds.o
Signature · 1 line
2.20.1
PATCH v3 4/4 monitor: Move qmp_query_qmp_schema to qmp-cmds-control.c
In reply to Kevin Wolfmonitor/misc.c contains code that works only in the system emulator, so it can't be linked to tools like a storage daemon. In order to make schema introspection available for tools, move the function to monitor/qmp-cmds-control.c, which can be linked into the storage daemon.
--- monitor/monitor-internal.h | 3 +++ monitor/misc.c | 16 ---------------- monitor/qmp-cmds-control.c | 16 ++++++++++++++++ 3 files changed, 19 insertions(+), 16 deletions(-)
monitor/monitor-internal.h +3 -0
@@ -180,4 +180,7 @@ void help_cmd(Monitor *mon, const char *name);void handle_hmp_command (MonitorHMP *mon,const char *cmdline);int hmp_compare_cmd (const char *name,const char *list); +void qmp_query_qmp_schema (QDict *qdict,QObject **ret_data, +Error **errp); +#endif
monitor/misc.c +0 -16
@@ -75,7 +75,6 @@#include "qapi/qapi-init-commands.h" #include "qapi/error.h" #include "qapi/qmp-event.h" -#include "qapi/qapi-introspect.h" #include "sysemu/cpus.h" #include "qemu/cutils.h" #include "tcg/tcg.h"
@@ -232,21 +231,6 @@ static void hmp_info_help(Monitor *mon, const QDict *qdict)help_cmd (mon,"info" ); } -/* -* Minor hack: generated marshalling suppressed for this command -* ('gen': false in the schema) so we can parse the JSON string -* directly into QObject instead of first parsing it with -* visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it -* to QObject with generated output marshallers, every time. Instead, -* we do it in test-qobject-input-visitor.c, just to make sure -* qapi-gen.py's output actually conforms to the schema. -*/ -static void qmp_query_qmp_schema (QDict *qdict,QObject **ret_data, -Error **errp) -{ - *ret_data =qobject_from_qlit (&qmp_schema_qlit); -} -static void monitor_init_qmp_commands (void ) {/*
monitor/qmp-cmds-control.c +16 -0
@@ -29,6 +29,7 @@#include "qapi/error.h" #include "qapi/qapi-commands-control.h" #include "qapi/qapi-emit-events.h" +#include "qapi/qapi-introspect.h" /* * Accept QMP capabilities in @list for @mon.
@@ -151,3 +152,18 @@ EventInfoList *qmp_query_events(Error **errp)return ev_list; } + +/* +* Minor hack: generated marshalling suppressed for this command +* ('gen': false in the schema) so we can parse the JSON string +* directly into QObject instead of first parsing it with +* visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it +* to QObject with generated output marshallers, every time. Instead, +* we do it in test-qobject-input-visitor.c, just to make sure +* qapi-gen.py's output actually conforms to the schema. +*/ +void qmp_query_qmp_schema (QDict *qdict,QObject **ret_data, +Error **errp) +{ + *ret_data =qobject_from_qlit (&qmp_schema_qlit); +}
Signature · 1 line
2.20.1