QmpReturn (and associated functions) is used during synchronous
dispatch return for now. It helps to factor out some code for
handling a reply context.
In the following patches, the QmpReturn will be the basis upon which
asynchronous reply will be handled: it will hold the context for a QMP
command reply.
Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
---
include/qapi/qmp/dispatch.h | 34 ++++++++++++++++-
monitor/qmp.c | 6 +--
qapi/qmp-dispatch.c | 74 ++++++++++++++++++++++---------------
3 files changed, 79 insertions(+), 35 deletions(-)
diff --git a/include/qapi/qmp/dispatch.h b/include/qapi/qmp/dispatch.h
index b3ca6c9ff2..6c0d21968e 100644
--- a/include/qapi/qmp/dispatch.h
+++ b/include/qapi/qmp/dispatch.h
@@ -17,6 +17,8 @@
#include "qemu/queue.h"
#include "qapi/qmp/json-parser.h"
+typedef struct QmpReturn QmpReturn;
+
typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
typedef enum QmpCommandOptions
@@ -47,6 +49,37 @@ struct QmpSession {
QmpDispatchReturn *return_cb;
};
+struct QmpReturn {
+ QmpSession *session;
+ QDict *rsp;
+};
+
+/**
+ * qmp_return_new:
+ *
+ * Allocates and initializes a QmpReturn.
+ */
+QmpReturn *qmp_return_new(QmpSession *session, const QObject *req);
+
+/**
+ * qmp_return_free:
+ *
+ * Free a QmpReturn. This shouldn't be needed if you actually return
+ * with qmp_return{_error}.
+ */
+void qmp_return_free(QmpReturn *qret);
+
+/**
+ * qmp_return{_error}:
+ *
+ * Construct the command reply, and call the
+ * return_cb() associated with the session.
+ *
+ * Finally, free the QmpReturn.
+ */
+void qmp_return(QmpReturn *qret, QObject *rsp);
+void qmp_return_error(QmpReturn *qret, Error *err);
+
void qmp_register_command(QmpCommandList *cmds, const char *name,
QmpCommandFunc *fn, QmpCommandOptions options);
const QmpCommand *qmp_find_command(const QmpCommandList *cmds,
@@ -67,7 +100,6 @@ void qmp_enable_command(QmpCommandList *cmds, const char
*name);
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);
void qmp_dispatch(QmpSession *session, QObject *request,
bool allow_oob);
bool qmp_is_oob(const QDict *dict);
diff --git a/monitor/qmp.c b/monitor/qmp.c
index cd29494e28..056ad7b68b 100644
--- a/monitor/qmp.c
+++ b/monitor/qmp.c
@@ -179,7 +179,6 @@ static QMPRequest
*monitor_qmp_requests_pop_any_with_lock(void)
void monitor_qmp_bh_dispatcher(void *data)
{
QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock();
- QDict *rsp;
bool need_resume;
MonitorQMP *mon;
@@ -198,11 +197,10 @@ void monitor_qmp_bh_dispatcher(void *data)
trace_monitor_qmp_cmd_in_band(qobject_get_try_str(id) ?: "");
monitor_qmp_dispatch(mon, req_obj->req);
} else {
+ QmpSession *session = &req_obj->mon->session;
assert(req_obj->err);
- rsp = qmp_error_response(req_obj->err);
+ qmp_return_error(qmp_return_new(session, req_obj->req), req_obj->err);
req_obj->err = NULL;
- qmp_send_response(req_obj->mon, rsp);
- qobject_unref(rsp);
}
if (need_resume) {
diff --git a/qapi/qmp-dispatch.c b/qapi/qmp-dispatch.c
index b004d7506f..188b5680b6 100644
--- a/qapi/qmp-dispatch.c
+++ b/qapi/qmp-dispatch.c
@@ -19,6 +19,46 @@
#include "sysemu/runstate.h"
#include "qapi/qmp/qbool.h"
+QmpReturn *qmp_return_new(QmpSession *session, const QObject *request)
+{
+ QmpReturn *qret = g_new0(QmpReturn, 1);
+ const QDict *req = qobject_to(QDict, request);
+ QObject *id = req ? qdict_get(req, "id") : NULL;
+
+ qret->session = session;
+ qret->rsp = qdict_new();
+ if (id) {
+ qobject_ref(id);
+ qdict_put_obj(qret->rsp, "id", id);
+ }
+
+ return qret;
+}
+
+void qmp_return_free(QmpReturn *qret)
+{
+ qobject_unref(qret->rsp);
+ g_free(qret);
+}
+
+void qmp_return(QmpReturn *qret, QObject *rsp)
+{
+ qdict_put_obj(qret->rsp, "return", rsp ?: QOBJECT(qdict_new()));
+ qret->session->return_cb(qret->session, qret->rsp);
+ qmp_return_free(qret);
+}
+
+void qmp_return_error(QmpReturn *qret, Error *err)
+{
+ qdict_put_obj(qret->rsp, "error",
+ qobject_from_jsonf_nofail("{ 'class': %s, 'desc': %s }",
+ QapiErrorClass_str(error_get_class(err)),
+ error_get_pretty(err)));
+ error_free(err);
+ qret->session->return_cb(qret->session, qret->rsp);
+ qmp_return_free(qret);
+}
+
static QDict *qmp_dispatch_check_obj(const QObject *request, bool allow_oob,
Error **errp)
{
@@ -144,17 +184,6 @@ static QObject *do_qmp_dispatch(const QmpCommandList
*cmds, QObject *request,
return ret;
}
-QDict *qmp_error_response(Error *err)
-{
- QDict *rsp;
-
- rsp = qdict_from_jsonf_nofail("{ 'error': { 'class': %s, 'desc': %s } }",
- QapiErrorClass_str(error_get_class(err)),
- error_get_pretty(err));
- error_free(err);
- return rsp;
-}
-
/*
* Does @qdict look like a command to be run out-of-band?
*/
@@ -171,9 +200,7 @@ static void qmp_json_emit(void *opaque, QObject *obj, Error
*err)
assert(!obj != !err);
if (err) {
- QDict *rsp = qmp_error_response(err);
- session->return_cb(session, rsp);
- qobject_unref(rsp);
+ qmp_return_error(qmp_return_new(session, obj), err);
} else {
qmp_dispatch(session, obj, false);
}
@@ -209,25 +236,12 @@ void qmp_session_destroy(QmpSession *session)
void 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;
+ QObject *ret;
ret = do_qmp_dispatch(session->cmds, request, allow_oob, &err);
if (err) {
- rsp = qmp_error_response(err);
+ qmp_return_error(qmp_return_new(session, request), err);
} else if (ret) {
- rsp = qdict_new();
- qdict_put_obj(rsp, "return", ret);
- } else {
- /* Can only happen for commands with QCO_NO_SUCCESS_RESP */
- return;
+ qmp_return(qmp_return_new(session, request), ret);
}
-
- if (id) {
- qdict_put_obj(rsp, "id", qobject_ref(id));
- }
-
- session->return_cb(session, rsp);
- qobject_unref(rsp);
}
--
2.24.0
