This structure will hold various data related to a QMP client session:
the list of commands, the parser, the callbacks, the pending
operations...
Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
---
include/qapi/qmp/dispatch.h | 10 +++++++++-
monitor/misc.c | 6 +++---
monitor/monitor-internal.h | 2 +-
monitor/monitor.c | 2 +-
monitor/qmp.c | 8 +++++---
qapi/qmp-dispatch.c | 15 ++++++++++++---
qga/main.c | 5 ++++-
tests/test-qmp-cmds.c | 28 ++++++++++++++++++++++------
8 files changed, 57 insertions(+), 19 deletions(-)
diff --git a/include/qapi/qmp/dispatch.h b/include/qapi/qmp/dispatch.h
index 5a9cf82472..3b53cfd788 100644
--- a/include/qapi/qmp/dispatch.h
+++ b/include/qapi/qmp/dispatch.h
@@ -37,10 +37,18 @@ typedef struct QmpCommand
typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
+typedef struct QmpSession QmpSession;
+
+struct QmpSession {
+ const QmpCommandList *cmds;
+};
+
void qmp_register_command(QmpCommandList *cmds, const char *name,
QmpCommandFunc *fn, QmpCommandOptions options);
const QmpCommand *qmp_find_command(const QmpCommandList *cmds,
const char *name);
+void qmp_session_init(QmpSession *session, const QmpCommandList *cmds);
+void qmp_session_destroy(QmpSession *session);
void qmp_disable_command(QmpCommandList *cmds, const char *name);
void qmp_enable_command(QmpCommandList *cmds, const char *name);
@@ -48,7 +56,7 @@ bool qmp_command_is_enabled(const QmpCommand *cmd);
const char *qmp_command_name(const QmpCommand *cmd);
bool qmp_has_success_response(const QmpCommand *cmd);
QDict *qmp_error_response(Error *err);
-QDict *qmp_dispatch(const QmpCommandList *cmds, QObject *request,
+QDict *qmp_dispatch(QmpSession *session, QObject *request,
bool allow_oob);
bool qmp_is_oob(const QDict *dict);
diff --git a/monitor/misc.c b/monitor/misc.c
index 3052bfe8f1..bb33ca73cf 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -253,7 +253,7 @@ CommandInfoList *qmp_query_commands(Error **errp)
assert(monitor_is_qmp(cur_mon));
mon = container_of(cur_mon, MonitorQMP, common);
- qmp_for_each_command(mon->commands, query_commands_cb, &list);
+ qmp_for_each_command(mon->session.cmds, query_commands_cb, &list);
return list;
}
@@ -363,7 +363,7 @@ void qmp_qmp_capabilities(bool has_enable,
QMPCapabilityList *enable,
assert(monitor_is_qmp(cur_mon));
mon = container_of(cur_mon, MonitorQMP, common);
- if (mon->commands == &qmp_commands) {
+ if (mon->session.cmds == &qmp_commands) {
error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
"Capabilities negotiation is already complete, command "
"ignored");
@@ -374,7 +374,7 @@ void qmp_qmp_capabilities(bool has_enable,
QMPCapabilityList *enable,
return;
}
- mon->commands = &qmp_commands;
+ mon->session.cmds = &qmp_commands;
}
/* Set the current CPU defined by the user. Callers must hold BQL. */
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index 3e7dac5910..b15266e77b 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -132,7 +132,7 @@ typedef struct {
* qmp_capabilities succeeds, we go into command mode, and
* @command becomes &qmp_commands.
*/
- const QmpCommandList *commands;
+ QmpSession session;
bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
/*
diff --git a/monitor/monitor.c b/monitor/monitor.c
index 12898b6448..ecf21d9786 100644
--- a/monitor/monitor.c
+++ b/monitor/monitor.c
@@ -263,7 +263,7 @@ static void monitor_qapi_event_emit(QAPIEvent event, QDict
*qdict)
}
qmp_mon = container_of(mon, MonitorQMP, common);
- if (qmp_mon->commands != &qmp_cap_negotiation_commands) {
+ if (qmp_mon->session.cmds != &qmp_cap_negotiation_commands) {
qmp_send_response(qmp_mon, qdict);
}
}
diff --git a/monitor/qmp.c b/monitor/qmp.c
index 9d9e5d8b27..24ccdeb4a4 100644
--- a/monitor/qmp.c
+++ b/monitor/qmp.c
@@ -117,11 +117,11 @@ static void monitor_qmp_dispatch(MonitorQMP *mon, QObject
*req)
old_mon = cur_mon;
cur_mon = &mon->common;
- rsp = qmp_dispatch(mon->commands, req, qmp_oob_enabled(mon));
+ rsp = qmp_dispatch(&mon->session, req, qmp_oob_enabled(mon));
cur_mon = old_mon;
- if (mon->commands == &qmp_cap_negotiation_commands) {
+ if (mon->session.cmds == &qmp_cap_negotiation_commands) {
error = qdict_get_qdict(rsp, "error");
if (error
&& !g_strcmp0(qdict_get_try_str(error, "class"),
@@ -318,7 +318,7 @@ static void monitor_qmp_event(void *opaque, int event)
switch (event) {
case CHR_EVENT_OPENED:
- mon->commands = &qmp_cap_negotiation_commands;
+ qmp_session_init(&mon->session, &qmp_cap_negotiation_commands);
monitor_qmp_caps_reset(mon);
data = qmp_greeting(mon);
qmp_send_response(mon, data);
@@ -333,6 +333,7 @@ static void monitor_qmp_event(void *opaque, int event)
* is closed.
*/
monitor_qmp_cleanup_queues(mon);
+ qmp_session_destroy(&mon->session);
json_message_parser_destroy(&mon->parser);
json_message_parser_init(&mon->parser, handle_qmp_command,
mon, NULL);
@@ -344,6 +345,7 @@ static void monitor_qmp_event(void *opaque, int event)
void monitor_data_destroy_qmp(MonitorQMP *mon)
{
+ qmp_session_destroy(&mon->session);
json_message_parser_destroy(&mon->parser);
qemu_mutex_destroy(&mon->qmp_queue_lock);
monitor_qmp_cleanup_req_queue_locked(mon);
diff --git a/qapi/qmp-dispatch.c b/qapi/qmp-dispatch.c
index 857399c5fe..0e6b003dd8 100644
--- a/qapi/qmp-dispatch.c
+++ b/qapi/qmp-dispatch.c
@@ -164,15 +164,24 @@ bool qmp_is_oob(const QDict *dict)
&& !qdict_haskey(dict, "execute");
}
-QDict *qmp_dispatch(const QmpCommandList *cmds, QObject *request,
- bool allow_oob)
+void qmp_session_init(QmpSession *session, const QmpCommandList *cmds)
+{
+ session->cmds = cmds;
+}
+
+void qmp_session_destroy(QmpSession *session)
+{
+ session->cmds = NULL;
+}
+
+QDict *qmp_dispatch(QmpSession *session, QObject *request, bool allow_oob)
{
Error *err = NULL;
QDict *dict = qobject_to(QDict, request);
QObject *ret, *id = dict ? qdict_get(dict, "id") : NULL;
QDict *rsp;
- ret = do_qmp_dispatch(cmds, request, allow_oob, &err);
+ ret = do_qmp_dispatch(session->cmds, request, allow_oob, &err);
if (err) {
rsp = qmp_error_response(err);
} else if (ret) {
diff --git a/qga/main.c b/qga/main.c
index f23614528e..61190db5f3 100644
--- a/qga/main.c
+++ b/qga/main.c
@@ -74,6 +74,7 @@ typedef struct GAPersistentState {
typedef struct GAConfig GAConfig;
struct GAState {
+ QmpSession session;
JSONMessageParser parser;
GMainLoop *main_loop;
GAChannel *channel;
@@ -572,7 +573,7 @@ static void process_event(void *opaque, QObject *obj, Error
*err)
}
g_debug("processing command");
- rsp = qmp_dispatch(&ga_commands, obj, false);
+ rsp = qmp_dispatch(&s->session, obj, false);
end:
ret = send_response(s, rsp);
@@ -1338,6 +1339,7 @@ static GAState *initialize_agent(GAConfig *config, int
socket_activation)
ga_command_state_init(s, s->command_state);
ga_command_state_init_all(s->command_state);
json_message_parser_init(&s->parser, process_event, s, NULL);
+ qmp_session_init(&s->session, &ga_commands);
#ifndef _WIN32
if (!register_signal_handlers()) {
@@ -1369,6 +1371,7 @@ static void cleanup_agent(GAState *s)
CloseHandle(s->wakeup_event);
#endif
if (s->command_state) {
+ qmp_session_destroy(&s->session);
ga_command_state_cleanup_all(s->command_state);
ga_command_state_free(s->command_state);
json_message_parser_destroy(&s->parser);
diff --git a/tests/test-qmp-cmds.c b/tests/test-qmp-cmds.c
index 27b0afe55a..962c2cb2e1 100644
--- a/tests/test-qmp-cmds.c
+++ b/tests/test-qmp-cmds.c
@@ -147,44 +147,52 @@ __org_qemu_x_Union1
*qmp___org_qemu_x_command(__org_qemu_x_EnumList *a,
/* test commands with no input and no return value */
static void test_dispatch_cmd(void)
{
+ QmpSession session = { 0, };
QDict *req = qdict_new();
QDict *resp;
+ qmp_session_init(&session, &qmp_commands);
qdict_put_str(req, "execute", "user_def_cmd");
- resp = qmp_dispatch(&qmp_commands, QOBJECT(req), false);
+ resp = qmp_dispatch(&session, QOBJECT(req), false);
assert(resp != NULL);
assert(!qdict_haskey(resp, "error"));
qobject_unref(resp);
qobject_unref(req);
+ qmp_session_destroy(&session);
}
static void test_dispatch_cmd_oob(void)
{
+ QmpSession session = { 0, };
QDict *req = qdict_new();
QDict *resp;
+ qmp_session_init(&session, &qmp_commands);
qdict_put_str(req, "exec-oob", "test-flags-command");
- resp = qmp_dispatch(&qmp_commands, QOBJECT(req), true);
+ resp = qmp_dispatch(&session, QOBJECT(req), true);
assert(resp != NULL);
assert(!qdict_haskey(resp, "error"));
qobject_unref(resp);
qobject_unref(req);
+ qmp_session_destroy(&session);
}
/* test commands that return an error due to invalid parameters */
static void test_dispatch_cmd_failure(void)
{
+ QmpSession session = { 0, };
QDict *req = qdict_new();
QDict *args = qdict_new();
QDict *resp;
+ qmp_session_init(&session, &qmp_commands);
qdict_put_str(req, "execute", "user_def_cmd2");
- resp = qmp_dispatch(&qmp_commands, QOBJECT(req), false);
+ resp = qmp_dispatch(&session, QOBJECT(req), false);
assert(resp != NULL);
assert(qdict_haskey(resp, "error"));
@@ -198,36 +206,44 @@ static void test_dispatch_cmd_failure(void)
qdict_put_str(req, "execute", "user_def_cmd");
- resp = qmp_dispatch(&qmp_commands, QOBJECT(req), false);
+ resp = qmp_dispatch(&session, QOBJECT(req), false);
assert(resp != NULL);
assert(qdict_haskey(resp, "error"));
qobject_unref(resp);
qobject_unref(req);
+ qmp_session_destroy(&session);
}
static void test_dispatch_cmd_success_response(void)
{
+ QmpSession session = { 0, };
QDict *req = qdict_new();
QDict *resp;
+ qmp_session_init(&session, &qmp_commands);
qdict_put_str(req, "execute", "cmd-success-response");
- resp = qmp_dispatch(&qmp_commands, QOBJECT(req), false);
+ resp = qmp_dispatch(&session, QOBJECT(req), false);
g_assert_null(resp);
qobject_unref(req);
+ qmp_session_destroy(&session);
}
+
static QObject *test_qmp_dispatch(QDict *req)
{
+ QmpSession session = { 0, };
QDict *resp;
QObject *ret;
- resp = qmp_dispatch(&qmp_commands, QOBJECT(req), false);
+ qmp_session_init(&session, &qmp_commands);
+ resp = qmp_dispatch(&session, QOBJECT(req), false);
assert(resp && !qdict_haskey(resp, "error"));
ret = qdict_get(resp, "return");
assert(ret);
qobject_ref(ret);
qobject_unref(resp);
+ qmp_session_destroy(&session);
return ret;
}
--
2.24.0
