* [PATCH v2 1/4] monitor: Move monitor option parsing to monitor/monitor.c
2020-01-28 17:52 [PATCH v2 0/4] monitor: Refactoring in preparation for qemu-storage-daemon Kevin Wolf
@ 2020-01-28 17:52 ` Kevin Wolf
2020-01-29 6:06 ` Markus Armbruster
2020-01-28 17:52 ` [PATCH v2 2/4] qapi: Create module 'control' Kevin Wolf
` (2 subsequent siblings)
3 siblings, 1 reply; 12+ messages in thread
From: Kevin Wolf @ 2020-01-28 17:52 UTC (permalink / raw)
To: qemu-block; +Cc: kwolf, armbru, qemu-devel
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.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
---
include/monitor/monitor.h | 4 ++++
include/sysemu/sysemu.h | 1 -
monitor/monitor.c | 48 +++++++++++++++++++++++++++++++++++++++
vl.c | 45 +-----------------------------------
4 files changed, 53 insertions(+), 45 deletions(-)
diff --git a/include/monitor/monitor.h b/include/monitor/monitor.h
index a81eeff5f8..ecf6cce827 100644
--- a/include/monitor/monitor.h
+++ b/include/monitor/monitor.h
@@ -3,6 +3,7 @@
#include "block/block.h"
#include "qapi/qapi-types-misc.h"
+#include "qemu/option.h"
#include "qemu/readline.h"
extern __thread Monitor *cur_mon;
@@ -10,12 +11,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);
diff --git a/include/sysemu/sysemu.h b/include/sysemu/sysemu.h
index 80c57fdc4e..bbd02cf941 100644
--- a/include/sysemu/sysemu.h
+++ b/include/sysemu/sysemu.h
@@ -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
diff --git a/monitor/monitor.c b/monitor/monitor.c
index 12898b6448..c1a6c4460f 100644
--- a/monitor/monitor.c
+++ b/monitor/monitor.c
@@ -609,6 +609,54 @@ void monitor_init_globals_core(void)
NULL);
}
+int monitor_init_opts(QemuOpts *opts, Error **errp)
+{
+ Chardev *chr;
+ bool qmp;
+ bool pretty = false;
+ const char *chardev;
+ const char *mode;
+
+ mode = qemu_opt_get(opts, "mode");
+ if (mode == NULL) {
+ mode = "readline";
+ }
+ if (strcmp(mode, "readline") == 0) {
+ qmp = false;
+ } else if (strcmp(mode, "control") == 0) {
+ qmp = true;
+ } else {
+ error_setg(errp, "unknown monitor mode \"%s\"", mode);
+ return -1;
+ }
+
+ if (!qmp && qemu_opt_get(opts, "pretty")) {
+ warn_report("'pretty' is deprecated for HMP monitors, it has no effect "
+ "and will be removed in future versions");
+ }
+ if (qemu_opt_get_bool(opts, "pretty", 0)) {
+ pretty = true;
+ }
+
+ chardev = qemu_opt_get(opts, "chardev");
+ if (!chardev) {
+ error_report("chardev is required");
+ exit(1);
+ }
+ chr = qemu_chr_find(chardev);
+ if (chr == NULL) {
+ error_setg(errp, "chardev \"%s\" not found", chardev);
+ return -1;
+ }
+
+ if (qmp) {
+ monitor_init_qmp(chr, pretty);
+ } else {
+ monitor_init_hmp(chr, true);
+ }
+ return 0;
+}
+
QemuOptsList qemu_mon_opts = {
.name = "mon",
.implied_opt_name = "chardev",
diff --git a/vl.c b/vl.c
index b0f52c4d6e..e263e15cd6 100644
--- a/vl.c
+++ b/vl.c
@@ -2118,50 +2118,7 @@ static int fsdev_init_func(void *opaque, QemuOpts *opts, Error **errp)
static int mon_init_func(void *opaque, QemuOpts *opts, Error **errp)
{
- Chardev *chr;
- bool qmp;
- bool pretty = false;
- const char *chardev;
- const char *mode;
-
- mode = qemu_opt_get(opts, "mode");
- if (mode == NULL) {
- mode = "readline";
- }
- if (strcmp(mode, "readline") == 0) {
- qmp = false;
- } else if (strcmp(mode, "control") == 0) {
- qmp = true;
- } else {
- error_setg(errp, "unknown monitor mode \"%s\"", mode);
- return -1;
- }
-
- if (!qmp && qemu_opt_get(opts, "pretty")) {
- warn_report("'pretty' is deprecated for HMP monitors, it has no effect "
- "and will be removed in future versions");
- }
- if (qemu_opt_get_bool(opts, "pretty", 0)) {
- pretty = true;
- }
-
- chardev = qemu_opt_get(opts, "chardev");
- if (!chardev) {
- error_report("chardev is required");
- exit(1);
- }
- chr = qemu_chr_find(chardev);
- if (chr == NULL) {
- error_setg(errp, "chardev \"%s\" not found", chardev);
- return -1;
- }
-
- if (qmp) {
- monitor_init_qmp(chr, pretty);
- } else {
- monitor_init_hmp(chr, true);
- }
- return 0;
+ return monitor_init_opts(opts, errp);
}
static void monitor_parse(const char *optarg, const char *mode, bool pretty)
--
2.20.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [PATCH v2 1/4] monitor: Move monitor option parsing to monitor/monitor.c
2020-01-28 17:52 ` [PATCH v2 1/4] monitor: Move monitor option parsing to monitor/monitor.c Kevin Wolf
@ 2020-01-29 6:06 ` Markus Armbruster
0 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2020-01-29 6:06 UTC (permalink / raw)
To: Kevin Wolf; +Cc: qemu-devel, qemu-block
Kevin Wolf <kwolf@redhat.com> writes:
> 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.
>
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> Reviewed-by: Markus Armbruster <armbru@redhat.com>
> ---
> include/monitor/monitor.h | 4 ++++
> include/sysemu/sysemu.h | 1 -
> monitor/monitor.c | 48 +++++++++++++++++++++++++++++++++++++++
> vl.c | 45 +-----------------------------------
> 4 files changed, 53 insertions(+), 45 deletions(-)
>
> diff --git a/include/monitor/monitor.h b/include/monitor/monitor.h
> index a81eeff5f8..ecf6cce827 100644
> --- a/include/monitor/monitor.h
> +++ b/include/monitor/monitor.h
> @@ -3,6 +3,7 @@
>
> #include "block/block.h"
> #include "qapi/qapi-types-misc.h"
> +#include "qemu/option.h"
Superfluous; qemu/typedefs.h already provides what you need.
> #include "qemu/readline.h"
>
> extern __thread Monitor *cur_mon;
> @@ -10,12 +11,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);
[...]
With the superfluous #include dropped:
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH v2 2/4] qapi: Create module 'control'
2020-01-28 17:52 [PATCH v2 0/4] monitor: Refactoring in preparation for qemu-storage-daemon Kevin Wolf
2020-01-28 17:52 ` [PATCH v2 1/4] monitor: Move monitor option parsing to monitor/monitor.c Kevin Wolf
@ 2020-01-28 17:52 ` Kevin Wolf
2020-01-29 8:35 ` Markus Armbruster
2020-01-28 17:52 ` [PATCH v2 3/4] monitor: Create monitor/qmp-cmds-control.c Kevin Wolf
2020-01-28 17:52 ` [PATCH v2 4/4] monitor: Move qmp_query_qmp_schema to qmp-cmds-control.c Kevin Wolf
3 siblings, 1 reply; 12+ messages in thread
From: Kevin Wolf @ 2020-01-28 17:52 UTC (permalink / raw)
To: qemu-block; +Cc: kwolf, armbru, qemu-devel
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 <kwolf@redhat.com>
---
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
diff --git a/qapi/control.json b/qapi/control.json
new file mode 100644
index 0000000000..a82a18da1a
--- /dev/null
+++ b/qapi/control.json
@@ -0,0 +1,218 @@
+# -*- Mode: Python -*-
+#
+
+##
+# = Monitor definitions (shared between system emulator and tools)
+##
+
+##
+# @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' }
diff --git a/qapi/misc.json b/qapi/misc.json
index 33b94e3589..cf656e9d4b 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -7,159 +7,6 @@
{ 'include': 'common.json' }
-##
-# @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 }
-
##
# @LostTickPolicy:
#
@@ -300,48 +147,6 @@
##
{ 'command': 'query-uuid', 'returns': 'UuidInfo', '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'] }
-
##
# @IOThreadInfo:
#
@@ -764,23 +569,6 @@
##
{ 'command': 'query-pci', 'returns': ['PciInfo'] }
-##
-# @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' }
-
##
# @stop:
#
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
index 9751b11f8f..61fd91ede7 100644
--- a/qapi/qapi-schema.json
+++ b/qapi/qapi-schema.json
@@ -103,6 +103,7 @@
{ 'include': 'qdev.json' }
{ 'include': 'machine.json' }
{ 'include': 'machine-target.json' }
+{ 'include': 'control.json' }
{ 'include': 'misc.json' }
{ 'include': 'misc-target.json' }
{ 'include': 'audio.json' }
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index d78f5ca190..4d402ded85 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -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"
diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
index d0e0af893a..abb052836b 100644
--- a/monitor/hmp-cmds.c
+++ b/monitor/hmp-cmds.c
@@ -33,6 +33,7 @@
#include "qapi/qapi-commands-char.h"
#include "qapi/qapi-commands-migration.h"
#include "qapi/qapi-commands-misc.h"
+#include "qapi/qapi-commands-control.h"
#include "qapi/qapi-commands-net.h"
#include "qapi/qapi-commands-rocker.h"
#include "qapi/qapi-commands-run-state.h"
diff --git a/monitor/misc.c b/monitor/misc.c
index 4752150a67..ce89cdb282 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -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"
diff --git a/monitor/qmp-cmds.c b/monitor/qmp-cmds.c
index c6faa3eaf0..263b39e700 100644
--- a/monitor/qmp-cmds.c
+++ b/monitor/qmp-cmds.c
@@ -34,6 +34,7 @@
#include "qapi/qapi-commands-block-core.h"
#include "qapi/qapi-commands-machine.h"
#include "qapi/qapi-commands-misc.h"
+#include "qapi/qapi-commands-control.h"
#include "qapi/qapi-commands-ui.h"
#include "qapi/qmp/qerror.h"
#include "hw/mem/memory-device.h"
diff --git a/monitor/qmp.c b/monitor/qmp.c
index 54c06ba824..8379c8f96e 100644
--- a/monitor/qmp.c
+++ b/monitor/qmp.c
@@ -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"
diff --git a/tests/qtest/qmp-test.c b/tests/qtest/qmp-test.c
index 1b0eb69832..1a8876b6ca 100644
--- a/tests/qtest/qmp-test.c
+++ b/tests/qtest/qmp-test.c
@@ -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"
diff --git a/ui/gtk.c b/ui/gtk.c
index d18892d1de..8ebbebe4ec 100644
--- a/ui/gtk.c
+++ b/ui/gtk.c
@@ -33,6 +33,7 @@
#include "qemu/osdep.h"
#include "qapi/error.h"
#include "qapi/qapi-commands-misc.h"
+#include "qapi/qapi-commands-control.h"
#include "qemu/cutils.h"
#include "ui/console.h"
diff --git a/qapi/Makefile.objs b/qapi/Makefile.objs
index a8f1f4c35e..20fcc37c2c 100644
--- a/qapi/Makefile.objs
+++ b/qapi/Makefile.objs
@@ -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)
--
2.20.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [PATCH v2 2/4] qapi: Create module 'control'
2020-01-28 17:52 ` [PATCH v2 2/4] qapi: Create module 'control' Kevin Wolf
@ 2020-01-29 8:35 ` Markus Armbruster
2020-01-29 9:09 ` Kevin Wolf
0 siblings, 1 reply; 12+ messages in thread
From: Markus Armbruster @ 2020-01-29 8:35 UTC (permalink / raw)
To: Kevin Wolf; +Cc: qemu-devel, qemu-block
Kevin Wolf <kwolf@redhat.com> writes:
> 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 <kwolf@redhat.com>
> ---
> 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
>
> diff --git a/qapi/control.json b/qapi/control.json
> new file mode 100644
> index 0000000000..a82a18da1a
> --- /dev/null
> +++ b/qapi/control.json
> @@ -0,0 +1,218 @@
> +# -*- Mode: Python -*-
> +#
> +
Let's add a copyright notice:
# Copyright (C) 2011-2020 Red Hat, Inc.
#
# This work is licensed under the terms of the GNU GPL, version 2 or later.
# See the COPYING file in the top-level directory.
> +##
> +# = Monitor definitions (shared between system emulator and tools)
> +##
This comment does double-duty: it's for readers of this source file, and
for readers of generated docs/interop/qemu-qmp-ref.*. It's okay for
the former, but not the latter, as the resulting table of contents
shows:
1 API Reference
1.1 Introduction
1.2 Stability Considerations
1.3 QMP errors
1.4 Common data types
1.5 Socket data types
1.6 VM run state
1.7 Cryptography
1.8 Block devices
1.8.1 Block core (VM unrelated)
1.8.2 Background jobs
1.8.3 Additional block stuff (VM related)
1.9 Character devices
1.10 Dump guest memory
1.11 Net devices
1.12 RDMA device
1.13 Rocker switch device
1.14 TPM (trusted platform module) devices
1.15 Remote desktop
1.15.1 Spice
1.15.2 VNC
1.16 Input
1.17 Migration
1.18 Transactions
1.19 Tracing
1.20 QMP introspection
1.21 QEMU Object Model (QOM)
1.22 Device infrastructure (qdev)
1.23 Machines
1.24 Monitor definitions (shared between system emulator and tools)
1.25 Miscellanea
Commands and Events Index
Data Types Index
Let's examine the file's contents to find a better description:
* qmp_capabilities
* QMPCapability
QMP capabilities negotiation. This is about the QMP monitor. I
figure few users of QMP need to know about it. No need to complicate
this patch to put it in the ideal spot (assuming there are ideal
spots).
* query-version
* VersionInfo
* VersionTriple
QMP query-version, QMP greeting, HMP info version
Losely related to introspection, QMP capabilities negotiation (the
greeting includes query-version output), and "process" below.
The HMP use is an implementation detail.
* query-commands
* CommandInfo
* query-events
* EventInfo
Legacy QMP introspection. query-events is deprecated in favor of
query-qmp-schema. query-commands probably should be.
Ideally, these go into or next to section 1.20 QMP introspection.
Let's deprecate and put them wherever is easiest for the grace period.
* quit
You move this here because like everything else you move here, you
expect this to be present in any QMP monitor. I expect that, too.
It's not really about the QMP monitor, it's about controlling the
process that provides the QMP monitor.
Proposed header:
# = QMP monitor control
This files @quit under monitor control, which isn't quite right, but
it'll do. Moving it away from @stop & friends is a bit unfortunate (see
patch to misc.json below). If that bothers us, we need to split
control.json. I'm not demanding such a split.
> +
> +##
> +# @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' }
> diff --git a/qapi/misc.json b/qapi/misc.json
> index 33b94e3589..cf656e9d4b 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -7,159 +7,6 @@
>
> { 'include': 'common.json' }
>
> -##
> -# @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 }
> -
> ##
> # @LostTickPolicy:
> #
> @@ -300,48 +147,6 @@
> ##
> { 'command': 'query-uuid', 'returns': 'UuidInfo', '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'] }
> -
> ##
> # @IOThreadInfo:
> #
> @@ -764,23 +569,6 @@
> ##
> { 'command': 'query-pci', 'returns': ['PciInfo'] }
>
> -##
> -# @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' }
> -
> ##
> # @stop:
> #
> diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
> index 9751b11f8f..61fd91ede7 100644
> --- a/qapi/qapi-schema.json
> +++ b/qapi/qapi-schema.json
> @@ -103,6 +103,7 @@
> { 'include': 'qdev.json' }
> { 'include': 'machine.json' }
> { 'include': 'machine-target.json' }
> +{ 'include': 'control.json' }
> { 'include': 'misc.json' }
> { 'include': 'misc-target.json' }
> { 'include': 'audio.json' }
This determines position within docs/interop/qemu-qmp-ref.*. Next to
misc.json is the least change. Perhaps putting it next to
introspect.json would be better.
If we split @quit off control.json, then we could include the .json
providing @quit next to @stop & friends. Again, I'm not demanding such
a split.
> diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
> index d78f5ca190..4d402ded85 100644
> --- a/monitor/monitor-internal.h
> +++ b/monitor/monitor-internal.h
> @@ -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"
> diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
> index d0e0af893a..abb052836b 100644
> --- a/monitor/hmp-cmds.c
> +++ b/monitor/hmp-cmds.c
> @@ -33,6 +33,7 @@
> #include "qapi/qapi-commands-char.h"
> #include "qapi/qapi-commands-migration.h"
> #include "qapi/qapi-commands-misc.h"
> +#include "qapi/qapi-commands-control.h"
> #include "qapi/qapi-commands-net.h"
> #include "qapi/qapi-commands-rocker.h"
> #include "qapi/qapi-commands-run-state.h"
Please keep the qapi/qapi-commands-* sorted, like you do ...
> diff --git a/monitor/misc.c b/monitor/misc.c
> index 4752150a67..ce89cdb282 100644
> --- a/monitor/misc.c
> +++ b/monitor/misc.c
> @@ -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"
... here.
> diff --git a/monitor/qmp-cmds.c b/monitor/qmp-cmds.c
> index c6faa3eaf0..263b39e700 100644
> --- a/monitor/qmp-cmds.c
> +++ b/monitor/qmp-cmds.c
> @@ -34,6 +34,7 @@
> #include "qapi/qapi-commands-block-core.h"
> #include "qapi/qapi-commands-machine.h"
> #include "qapi/qapi-commands-misc.h"
> +#include "qapi/qapi-commands-control.h"
> #include "qapi/qapi-commands-ui.h"
> #include "qapi/qmp/qerror.h"
> #include "hw/mem/memory-device.h"
Likewise.
> diff --git a/monitor/qmp.c b/monitor/qmp.c
> index 54c06ba824..8379c8f96e 100644
> --- a/monitor/qmp.c
> +++ b/monitor/qmp.c
> @@ -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"
> diff --git a/tests/qtest/qmp-test.c b/tests/qtest/qmp-test.c
> index 1b0eb69832..1a8876b6ca 100644
> --- a/tests/qtest/qmp-test.c
> +++ b/tests/qtest/qmp-test.c
> @@ -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"
> diff --git a/ui/gtk.c b/ui/gtk.c
> index d18892d1de..8ebbebe4ec 100644
> --- a/ui/gtk.c
> +++ b/ui/gtk.c
> @@ -33,6 +33,7 @@
> #include "qemu/osdep.h"
> #include "qapi/error.h"
> #include "qapi/qapi-commands-misc.h"
> +#include "qapi/qapi-commands-control.h"
> #include "qemu/cutils.h"
>
> #include "ui/console.h"
> diff --git a/qapi/Makefile.objs b/qapi/Makefile.objs
> index a8f1f4c35e..20fcc37c2c 100644
> --- a/qapi/Makefile.objs
> +++ b/qapi/Makefile.objs
> @@ -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)
With the comments and the include directives tidied up:
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: [PATCH v2 2/4] qapi: Create module 'control'
2020-01-29 8:35 ` Markus Armbruster
@ 2020-01-29 9:09 ` Kevin Wolf
2020-01-29 9:41 ` Markus Armbruster
0 siblings, 1 reply; 12+ messages in thread
From: Kevin Wolf @ 2020-01-29 9:09 UTC (permalink / raw)
To: Markus Armbruster; +Cc: qemu-devel, qemu-block
Am 29.01.2020 um 09:35 hat Markus Armbruster geschrieben:
> Kevin Wolf <kwolf@redhat.com> writes:
>
> > 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 <kwolf@redhat.com>
> > ---
> > 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
> >
> > diff --git a/qapi/control.json b/qapi/control.json
> > new file mode 100644
> > index 0000000000..a82a18da1a
> > --- /dev/null
> > +++ b/qapi/control.json
> > @@ -0,0 +1,218 @@
> > +# -*- Mode: Python -*-
> > +#
> > +
>
> Let's add a copyright notice:
>
> # Copyright (C) 2011-2020 Red Hat, Inc.
> #
> # This work is licensed under the terms of the GNU GPL, version 2 or later.
> # See the COPYING file in the top-level directory.
I'm not adding anything new, but just moving code from a file that
doesn't have a copyright notice. In fact, almost none of the schema
files have a copyright notice. I'm not comfortable adding legal
assertions without verifying that they are correct, and certainly not as
a side-effect of a code movement patch. This would be an unrelated
change.
I suggest that we leave this patch as is, and if you think copyright
notices should be added, the correct information can be tracked down
and added consistently for all schema files in a separate series.
> > +##
> > +# = Monitor definitions (shared between system emulator and tools)
> > +##
>
> This comment does double-duty: it's for readers of this source file, and
> for readers of generated docs/interop/qemu-qmp-ref.*. It's okay for
> the former, but not the latter, as the resulting table of contents
> shows:
> [...]
> Proposed header:
>
> # = QMP monitor control
Works for me.
> > diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
> > index 9751b11f8f..61fd91ede7 100644
> > --- a/qapi/qapi-schema.json
> > +++ b/qapi/qapi-schema.json
> > @@ -103,6 +103,7 @@
> > { 'include': 'qdev.json' }
> > { 'include': 'machine.json' }
> > { 'include': 'machine-target.json' }
> > +{ 'include': 'control.json' }
> > { 'include': 'misc.json' }
> > { 'include': 'misc-target.json' }
> > { 'include': 'audio.json' }
>
> This determines position within docs/interop/qemu-qmp-ref.*. Next to
> misc.json is the least change. Perhaps putting it next to
> introspect.json would be better.
>
> If we split @quit off control.json, then we could include the .json
> providing @quit next to @stop & friends. Again, I'm not demanding such
> a split.
I'll put it before introspect.json for now.
I don't think the whole order is overly meaningful and it could use some
rearrangement in general. Again, unrelated to this series.
> > diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
> > index d78f5ca190..4d402ded85 100644
> > --- a/monitor/monitor-internal.h
> > +++ b/monitor/monitor-internal.h
> > @@ -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"
> > diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
> > index d0e0af893a..abb052836b 100644
> > --- a/monitor/hmp-cmds.c
> > +++ b/monitor/hmp-cmds.c
> > @@ -33,6 +33,7 @@
> > #include "qapi/qapi-commands-char.h"
> > #include "qapi/qapi-commands-migration.h"
> > #include "qapi/qapi-commands-misc.h"
> > +#include "qapi/qapi-commands-control.h"
> > #include "qapi/qapi-commands-net.h"
> > #include "qapi/qapi-commands-rocker.h"
> > #include "qapi/qapi-commands-run-state.h"
>
> Please keep the qapi/qapi-commands-* sorted, like you do ...
It is sorted! It's exactly where you would expect "-monitor"... *sigh*
/me goes back to finding each #include and moving it.
/me hates renaming header files.
> > diff --git a/qapi/Makefile.objs b/qapi/Makefile.objs
> > index a8f1f4c35e..20fcc37c2c 100644
> > --- a/qapi/Makefile.objs
> > +++ b/qapi/Makefile.objs
> > @@ -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)
>
> With the comments and the include directives tidied up:
> Reviewed-by: Markus Armbruster <armbru@redhat.com>
Thanks. (I assume this means even without the copyright header.)
Kevin
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: [PATCH v2 2/4] qapi: Create module 'control'
2020-01-29 9:09 ` Kevin Wolf
@ 2020-01-29 9:41 ` Markus Armbruster
2020-01-29 10:17 ` Kevin Wolf
0 siblings, 1 reply; 12+ messages in thread
From: Markus Armbruster @ 2020-01-29 9:41 UTC (permalink / raw)
To: Kevin Wolf; +Cc: qemu-devel, qemu-block
Kevin Wolf <kwolf@redhat.com> writes:
> Am 29.01.2020 um 09:35 hat Markus Armbruster geschrieben:
>> Kevin Wolf <kwolf@redhat.com> writes:
>>
>> > 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 <kwolf@redhat.com>
>> > ---
>> > 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
>> >
>> > diff --git a/qapi/control.json b/qapi/control.json
>> > new file mode 100644
>> > index 0000000000..a82a18da1a
>> > --- /dev/null
>> > +++ b/qapi/control.json
>> > @@ -0,0 +1,218 @@
>> > +# -*- Mode: Python -*-
>> > +#
>> > +
>>
>> Let's add a copyright notice:
>>
>> # Copyright (C) 2011-2020 Red Hat, Inc.
>> #
>> # This work is licensed under the terms of the GNU GPL, version 2 or later.
>> # See the COPYING file in the top-level directory.
>
> I'm not adding anything new, but just moving code from a file that
> doesn't have a copyright notice. In fact, almost none of the schema
> files have a copyright notice. I'm not comfortable adding legal
> assertions without verifying that they are correct, and certainly not as
> a side-effect of a code movement patch. This would be an unrelated
> change.
>
> I suggest that we leave this patch as is, and if you think copyright
> notices should be added, the correct information can be tracked down
> and added consistently for all schema files in a separate series.
There is nothing to be tracked down. Anything that lacks an explicit
copyright notice is under GPLv2+, as per LICENSE.
>> > +##
>> > +# = Monitor definitions (shared between system emulator and tools)
>> > +##
>>
>> This comment does double-duty: it's for readers of this source file, and
>> for readers of generated docs/interop/qemu-qmp-ref.*. It's okay for
>> the former, but not the latter, as the resulting table of contents
>> shows:
>> [...]
>
>> Proposed header:
>>
>> # = QMP monitor control
>
> Works for me.
>
>> > diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
>> > index 9751b11f8f..61fd91ede7 100644
>> > --- a/qapi/qapi-schema.json
>> > +++ b/qapi/qapi-schema.json
>> > @@ -103,6 +103,7 @@
>> > { 'include': 'qdev.json' }
>> > { 'include': 'machine.json' }
>> > { 'include': 'machine-target.json' }
>> > +{ 'include': 'control.json' }
>> > { 'include': 'misc.json' }
>> > { 'include': 'misc-target.json' }
>> > { 'include': 'audio.json' }
>>
>> This determines position within docs/interop/qemu-qmp-ref.*. Next to
>> misc.json is the least change. Perhaps putting it next to
>> introspect.json would be better.
>>
>> If we split @quit off control.json, then we could include the .json
>> providing @quit next to @stop & friends. Again, I'm not demanding such
>> a split.
>
> I'll put it before introspect.json for now.
>
> I don't think the whole order is overly meaningful and it could use some
> rearrangement in general. Again, unrelated to this series.
Yes, the order could use some love.
>> > diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
>> > index d78f5ca190..4d402ded85 100644
>> > --- a/monitor/monitor-internal.h
>> > +++ b/monitor/monitor-internal.h
>> > @@ -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"
>> > diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
>> > index d0e0af893a..abb052836b 100644
>> > --- a/monitor/hmp-cmds.c
>> > +++ b/monitor/hmp-cmds.c
>> > @@ -33,6 +33,7 @@
>> > #include "qapi/qapi-commands-char.h"
>> > #include "qapi/qapi-commands-migration.h"
>> > #include "qapi/qapi-commands-misc.h"
>> > +#include "qapi/qapi-commands-control.h"
>> > #include "qapi/qapi-commands-net.h"
>> > #include "qapi/qapi-commands-rocker.h"
>> > #include "qapi/qapi-commands-run-state.h"
>>
>> Please keep the qapi/qapi-commands-* sorted, like you do ...
>
> It is sorted! It's exactly where you would expect "-monitor"... *sigh*
>
> /me goes back to finding each #include and moving it.
> /me hates renaming header files.
>
>> > diff --git a/qapi/Makefile.objs b/qapi/Makefile.objs
>> > index a8f1f4c35e..20fcc37c2c 100644
>> > --- a/qapi/Makefile.objs
>> > +++ b/qapi/Makefile.objs
>> > @@ -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)
>>
>> With the comments and the include directives tidied up:
>> Reviewed-by: Markus Armbruster <armbru@redhat.com>
>
> Thanks. (I assume this means even without the copyright header.)
I'd prefer with, but I'll accept without.
^ permalink raw reply [flat|nested] 12+ messages in thread* Re: [PATCH v2 2/4] qapi: Create module 'control'
2020-01-29 9:41 ` Markus Armbruster
@ 2020-01-29 10:17 ` Kevin Wolf
0 siblings, 0 replies; 12+ messages in thread
From: Kevin Wolf @ 2020-01-29 10:17 UTC (permalink / raw)
To: Markus Armbruster; +Cc: qemu-devel, qemu-block
Am 29.01.2020 um 10:41 hat Markus Armbruster geschrieben:
> Kevin Wolf <kwolf@redhat.com> writes:
>
> > Am 29.01.2020 um 09:35 hat Markus Armbruster geschrieben:
> >> Kevin Wolf <kwolf@redhat.com> writes:
> >>
> >> > 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 <kwolf@redhat.com>
> >> > ---
> >> > 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
> >> >
> >> > diff --git a/qapi/control.json b/qapi/control.json
> >> > new file mode 100644
> >> > index 0000000000..a82a18da1a
> >> > --- /dev/null
> >> > +++ b/qapi/control.json
> >> > @@ -0,0 +1,218 @@
> >> > +# -*- Mode: Python -*-
> >> > +#
> >> > +
> >>
> >> Let's add a copyright notice:
> >>
> >> # Copyright (C) 2011-2020 Red Hat, Inc.
> >> #
> >> # This work is licensed under the terms of the GNU GPL, version 2 or later.
> >> # See the COPYING file in the top-level directory.
> >
> > I'm not adding anything new, but just moving code from a file that
> > doesn't have a copyright notice. In fact, almost none of the schema
> > files have a copyright notice. I'm not comfortable adding legal
> > assertions without verifying that they are correct, and certainly not as
> > a side-effect of a code movement patch. This would be an unrelated
> > change.
> >
> > I suggest that we leave this patch as is, and if you think copyright
> > notices should be added, the correct information can be tracked down
> > and added consistently for all schema files in a separate series.
>
> There is nothing to be tracked down. Anything that lacks an explicit
> copyright notice is under GPLv2+, as per LICENSE.
The copyright holders should be tracked down rather than just putting
"Red Hat" there, which is most likely wrong. Not that copyright notices
anywhere else are much more complete, but they tend to be correct at
least when they are added (i.e. usually when the file is created), so
not updating them is the fault of the copyright holders that are
missing in the notice.
But anyway, it's unrelated to this patch in either case.
Kevin
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH v2 3/4] monitor: Create monitor/qmp-cmds-control.c
2020-01-28 17:52 [PATCH v2 0/4] monitor: Refactoring in preparation for qemu-storage-daemon Kevin Wolf
2020-01-28 17:52 ` [PATCH v2 1/4] monitor: Move monitor option parsing to monitor/monitor.c Kevin Wolf
2020-01-28 17:52 ` [PATCH v2 2/4] qapi: Create module 'control' Kevin Wolf
@ 2020-01-28 17:52 ` Kevin Wolf
2020-01-29 9:09 ` Markus Armbruster
2020-01-28 17:52 ` [PATCH v2 4/4] monitor: Move qmp_query_qmp_schema to qmp-cmds-control.c Kevin Wolf
3 siblings, 1 reply; 12+ messages in thread
From: Kevin Wolf @ 2020-01-28 17:52 UTC (permalink / raw)
To: qemu-block; +Cc: kwolf, armbru, qemu-devel
Move 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.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
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
diff --git a/monitor/misc.c b/monitor/misc.c
index ce89cdb282..482e19a154 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -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)
{
diff --git a/monitor/qmp-cmds-control.c b/monitor/qmp-cmds-control.c
new file mode 100644
index 0000000000..dc789de3f8
--- /dev/null
+++ b/monitor/qmp-cmds-control.c
@@ -0,0 +1,153 @@
+/*
+ * QMP commands related to the monitor (common functions for sysemu and tools)
+ *
+ * Copyright (c) 2003-2004 Fabrice Bellard
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "qemu/osdep.h"
+
+#include "monitor-internal.h"
+#include "qemu-version.h"
+#include "qapi/error.h"
+#include "qapi/qapi-commands-control.h"
+#include "qapi/qapi-emit-events.h"
+
+/*
+ * 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;
+}
+
+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;
+}
+
+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;
+}
diff --git a/monitor/qmp-cmds.c b/monitor/qmp-cmds.c
index 263b39e700..605d2506a8 100644
--- a/monitor/qmp-cmds.c
+++ b/monitor/qmp-cmds.c
@@ -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));
diff --git a/monitor/Makefile.objs b/monitor/Makefile.objs
index e91a8581cd..9244d90859 100644
--- a/monitor/Makefile.objs
+++ b/monitor/Makefile.objs
@@ -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
--
2.20.1
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [PATCH v2 3/4] monitor: Create monitor/qmp-cmds-control.c
2020-01-28 17:52 ` [PATCH v2 3/4] monitor: Create monitor/qmp-cmds-control.c Kevin Wolf
@ 2020-01-29 9:09 ` Markus Armbruster
0 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2020-01-29 9:09 UTC (permalink / raw)
To: Kevin Wolf; +Cc: qemu-devel, qemu-block
Kevin Wolf <kwolf@redhat.com> writes:
> Move 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.
>
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> ---
[...]
> diff --git a/monitor/qmp-cmds-control.c b/monitor/qmp-cmds-control.c
> new file mode 100644
> index 0000000000..dc789de3f8
> --- /dev/null
> +++ b/monitor/qmp-cmds-control.c
> @@ -0,0 +1,153 @@
> +/*
> + * QMP commands related to the monitor (common functions for sysemu and tools)
Rather long line. Let's s/common functions for/common to/.
The parenthesis is aspirational. I'd add it when it becomes factual,
but I'm willing to accept it even now.
[...]
With the comment tweak:
Reviewed-by: Markus Armbruster <armbru@redhat.com>
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH v2 4/4] monitor: Move qmp_query_qmp_schema to qmp-cmds-control.c
2020-01-28 17:52 [PATCH v2 0/4] monitor: Refactoring in preparation for qemu-storage-daemon Kevin Wolf
` (2 preceding siblings ...)
2020-01-28 17:52 ` [PATCH v2 3/4] monitor: Create monitor/qmp-cmds-control.c Kevin Wolf
@ 2020-01-28 17:52 ` Kevin Wolf
2020-01-29 9:11 ` Markus Armbruster
3 siblings, 1 reply; 12+ messages in thread
From: Kevin Wolf @ 2020-01-28 17:52 UTC (permalink / raw)
To: qemu-block; +Cc: kwolf, armbru, qemu-devel
monitor/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.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
monitor/monitor-internal.h | 3 +++
monitor/misc.c | 16 ----------------
monitor/qmp-cmds-control.c | 16 ++++++++++++++++
3 files changed, 19 insertions(+), 16 deletions(-)
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index 4d402ded85..3e6baba88f 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -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
diff --git a/monitor/misc.c b/monitor/misc.c
index 482e19a154..a64963cef4 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -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)
{
/*
diff --git a/monitor/qmp-cmds-control.c b/monitor/qmp-cmds-control.c
index dc789de3f8..c65d6fdf0f 100644
--- a/monitor/qmp-cmds-control.c
+++ b/monitor/qmp-cmds-control.c
@@ -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);
+}
--
2.20.1
^ permalink raw reply related [flat|nested] 12+ messages in thread