[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 09/11] qapi: Implement deprecated-input=reject for QMP commands
From: |
Markus Armbruster |
Subject: |
[PULL 09/11] qapi: Implement deprecated-input=reject for QMP commands |
Date: |
Tue, 16 Mar 2021 18:05:49 +0100 |
This policy rejects deprecated input, and thus permits "testing the
future". Implement it for QMP commands: make deprecated ones fail.
Example: when QEMU is run with -compat deprecated-input=reject, then
{"execute": "query-cpus"}
fails like this
{"error": {"class": "CommandNotFound", "desc": "Deprecated command
query-cpus disabled by policy"}}
When the deprecated command is removed, the error will change to
{"error": {"class": "CommandNotFound", "desc": "The command query-cpus has
not been found"}}
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20210312153210.2810514-9-armbru@redhat.com>
---
include/qapi/qmp/dispatch.h | 1 +
qapi/qmp-dispatch.c | 13 +++++++++++++
tests/unit/test-qmp-cmds.c | 24 ++++++++++++++++++++++++
scripts/qapi/commands.py | 10 +++++++---
4 files changed, 45 insertions(+), 3 deletions(-)
diff --git a/include/qapi/qmp/dispatch.h b/include/qapi/qmp/dispatch.h
index 1486cac3ef..8b974b570e 100644
--- a/include/qapi/qmp/dispatch.h
+++ b/include/qapi/qmp/dispatch.h
@@ -26,6 +26,7 @@ typedef enum QmpCommandOptions
QCO_ALLOW_OOB = (1U << 1),
QCO_ALLOW_PRECONFIG = (1U << 2),
QCO_COROUTINE = (1U << 3),
+ QCO_DEPRECATED = (1U << 4),
} QmpCommandOptions;
typedef struct QmpCommand
diff --git a/qapi/qmp-dispatch.c b/qapi/qmp-dispatch.c
index 45090f881a..cbc4452341 100644
--- a/qapi/qmp-dispatch.c
+++ b/qapi/qmp-dispatch.c
@@ -158,6 +158,19 @@ QDict *qmp_dispatch(const QmpCommandList *cmds, QObject
*request,
"The command %s has not been found", command);
goto out;
}
+ if (cmd->options & QCO_DEPRECATED) {
+ switch (compat_policy.deprecated_input) {
+ case COMPAT_POLICY_INPUT_ACCEPT:
+ break;
+ case COMPAT_POLICY_INPUT_REJECT:
+ error_set(&err, ERROR_CLASS_COMMAND_NOT_FOUND,
+ "Deprecated command %s disabled by policy",
+ command);
+ goto out;
+ default:
+ abort();
+ }
+ }
if (!cmd->enabled) {
error_set(&err, ERROR_CLASS_COMMAND_NOT_FOUND,
"The command %s has been disabled for this instance",
diff --git a/tests/unit/test-qmp-cmds.c b/tests/unit/test-qmp-cmds.c
index 1079d35122..cba982154b 100644
--- a/tests/unit/test-qmp-cmds.c
+++ b/tests/unit/test-qmp-cmds.c
@@ -281,6 +281,28 @@ static void test_dispatch_cmd_io(void)
qobject_unref(ret3);
}
+static void test_dispatch_cmd_deprecated(void)
+{
+ const char *cmd = "{ 'execute': 'test-command-features1' }";
+ QDict *ret;
+
+ memset(&compat_policy, 0, sizeof(compat_policy));
+
+ /* accept */
+ ret = qobject_to(QDict, do_qmp_dispatch(false, cmd));
+ assert(ret && qdict_size(ret) == 0);
+ qobject_unref(ret);
+
+ compat_policy.has_deprecated_input = true;
+ compat_policy.deprecated_input = COMPAT_POLICY_INPUT_ACCEPT;
+ ret = qobject_to(QDict, do_qmp_dispatch(false, cmd));
+ assert(ret && qdict_size(ret) == 0);
+ qobject_unref(ret);
+
+ compat_policy.deprecated_input = COMPAT_POLICY_INPUT_REJECT;
+ do_qmp_dispatch_error(false, ERROR_CLASS_COMMAND_NOT_FOUND, cmd);
+}
+
static void test_dispatch_cmd_ret_deprecated(void)
{
const char *cmd = "{ 'execute': 'test-features0' }";
@@ -379,6 +401,8 @@ int main(int argc, char **argv)
g_test_add_func("/qmp/dispatch_cmd_io", test_dispatch_cmd_io);
g_test_add_func("/qmp/dispatch_cmd_success_response",
test_dispatch_cmd_success_response);
+ g_test_add_func("/qmp/dispatch_cmd_deprecated",
+ test_dispatch_cmd_deprecated);
g_test_add_func("/qmp/dispatch_cmd_ret_deprecated",
test_dispatch_cmd_ret_deprecated);
g_test_add_func("/qmp/dealloc_types", test_dealloc_types);
diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py
index 7adeda917b..f5d97454af 100644
--- a/scripts/qapi/commands.py
+++ b/scripts/qapi/commands.py
@@ -210,12 +210,16 @@ def gen_marshal(name: str,
def gen_register_command(name: str,
+ features: List[QAPISchemaFeature],
success_response: bool,
allow_oob: bool,
allow_preconfig: bool,
coroutine: bool) -> str:
options = []
+ if 'deprecated' in [f.name for f in features]:
+ options += ['QCO_DEPRECATED']
+
if not success_response:
options += ['QCO_NO_SUCCESS_RESP']
if allow_oob:
@@ -326,9 +330,9 @@ def visit_command(self,
self._genc.add(gen_marshal(name, arg_type, boxed, ret_type))
with self._temp_module('./init'):
with ifcontext(ifcond, self._genh, self._genc):
- self._genc.add(gen_register_command(name, success_response,
- allow_oob, allow_preconfig,
- coroutine))
+ self._genc.add(gen_register_command(
+ name, features, success_response, allow_oob,
+ allow_preconfig, coroutine))
def gen_commands(schema: QAPISchema,
--
2.26.2
- [PULL 10/11] qapi: Implement deprecated-input=reject for QMP command arguments, (continued)
- [PULL 10/11] qapi: Implement deprecated-input=reject for QMP command arguments, Markus Armbruster, 2021/03/16
- [PULL 09/11] qapi: Implement deprecated-input=reject for QMP commands, Markus Armbruster, 2021/03/16
- Re: [PULL 00/11] QOM and fdc patches patches for 2021-03-16, Eric Blake, 2021/03/16
- [PULL 00/11] QOM and fdc patches patches for 2021-03-16, Markus Armbruster, 2021/03/16
- [PULL 01/11] qemuutil: remove qemu_set_fd_handler duplicate symbol, Markus Armbruster, 2021/03/16
- [PULL 08/11] test-util-sockets: Add stub for monitor_set_cur(), Markus Armbruster, 2021/03/16
- [PULL 02/11] qemu-options: New -compat to set policy for deprecated interfaces, Markus Armbruster, 2021/03/16
- [PULL 05/11] qapi: Implement deprecated-output=hide for QMP event data, Markus Armbruster, 2021/03/16
- [PULL 04/11] qapi: Implement deprecated-output=hide for QMP events, Markus Armbruster, 2021/03/16
- [PULL 07/11] qapi: Implement deprecated-output=hide for QMP introspection, Markus Armbruster, 2021/03/16
- [PULL 09/11] qapi: Implement deprecated-input=reject for QMP commands,
Markus Armbruster <=
- [PULL 11/11] qapi: New -compat deprecated-input=crash, Markus Armbruster, 2021/03/16
- [PULL 03/11] qapi: Implement deprecated-output=hide for QMP command results, Markus Armbruster, 2021/03/16
- [PULL 06/11] monitor: Drop query-qmp-schema 'gen': false hack, Markus Armbruster, 2021/03/16
- [PULL 10/11] qapi: Implement deprecated-input=reject for QMP command arguments, Markus Armbruster, 2021/03/16
- Re: [PULL 00/11] QOM and fdc patches patches for 2021-03-16, Markus Armbruster, 2021/03/16