From: "Marc-André Lureau" <marcandre.lureau@redhat.com> To: qemu-devel@nongnu.org Cc: "Eric Blake" <eblake@redhat.com>, "Markus Armbruster" <armbru@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, "Gerd Hoffmann" <kraxel@redhat.com>, "Michael Roth" <mdroth@linux.vnet.ibm.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com> Subject: [Qemu-devel] [PATCH v4 08/20] QmpSession: introduce QmpReturn Date: Tue, 9 Apr 2019 18:09:57 +0200 [thread overview] Message-ID: <20190409161009.6322-9-marcandre.lureau@redhat.com> (raw) In-Reply-To: <20190409161009.6322-1-marcandre.lureau@redhat.com> 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.lureau@redhat.com> --- include/qapi/qmp/dispatch.h | 34 ++++++++++++++++- monitor.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.c b/monitor.c index 71aad8d1ae..b1c4647a37 100644 --- a/monitor.c +++ b/monitor.c @@ -4175,7 +4175,6 @@ static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void) static void monitor_qmp_bh_dispatcher(void *data) { QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock(); - QDict *rsp; bool need_resume; Monitor *mon; @@ -4194,11 +4193,10 @@ static 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->qmp.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 f2c376d005..405cb291b1 100644 --- a/qapi/qmp-dispatch.c +++ b/qapi/qmp-dispatch.c @@ -19,6 +19,46 @@ #include "qapi/qmp/qbool.h" #include "sysemu/sysemu.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) { @@ -143,17 +183,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? */ @@ -170,9 +199,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); } @@ -208,25 +235,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.21.0.196.g041f5ea1cf
WARNING: multiple messages have this Message-ID (diff)
From: "Marc-André Lureau" <marcandre.lureau@redhat.com> To: qemu-devel@nongnu.org Cc: "Michael Roth" <mdroth@linux.vnet.ibm.com>, "Markus Armbruster" <armbru@redhat.com>, "Gerd Hoffmann" <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com> Subject: [Qemu-devel] [PATCH v4 08/20] QmpSession: introduce QmpReturn Date: Tue, 9 Apr 2019 18:09:57 +0200 [thread overview] Message-ID: <20190409161009.6322-9-marcandre.lureau@redhat.com> (raw) Message-ID: <20190409160957.sNu7dIGgCth6KGV-xrPsBpo5R6j6is4vF29vfcJDmkM@z> (raw) In-Reply-To: <20190409161009.6322-1-marcandre.lureau@redhat.com> 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.lureau@redhat.com> --- include/qapi/qmp/dispatch.h | 34 ++++++++++++++++- monitor.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.c b/monitor.c index 71aad8d1ae..b1c4647a37 100644 --- a/monitor.c +++ b/monitor.c @@ -4175,7 +4175,6 @@ static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void) static void monitor_qmp_bh_dispatcher(void *data) { QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock(); - QDict *rsp; bool need_resume; Monitor *mon; @@ -4194,11 +4193,10 @@ static 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->qmp.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 f2c376d005..405cb291b1 100644 --- a/qapi/qmp-dispatch.c +++ b/qapi/qmp-dispatch.c @@ -19,6 +19,46 @@ #include "qapi/qmp/qbool.h" #include "sysemu/sysemu.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) { @@ -143,17 +183,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? */ @@ -170,9 +199,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); } @@ -208,25 +235,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.21.0.196.g041f5ea1cf
next prev parent reply other threads:[~2019-04-09 16:11 UTC|newest] Thread overview: 64+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-04-09 16:09 [Qemu-devel] [PATCH v4 00/20] monitor: add asynchronous command type Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 01/20] qmp: constify QmpCommand and list Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 02/20] json-lexer: make it safe to call destroy multiple times Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 03/20] qmp: add QmpSession Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 04/20] QmpSession: add a return callback Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 05/20] QmpSession: add json parser and use it in qga Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 06/20] monitor: use qmp session to parse json feed Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 07/20] qga: simplify dispatch_return_cb Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau [this message] 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 08/20] QmpSession: introduce QmpReturn Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 09/20] qmp: simplify qmp_return_error() Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:09 ` [Qemu-devel] [PATCH v4 10/20] QmpSession: keep a queue of pending commands Marc-André Lureau 2019-04-09 16:09 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 11/20] QmpSession: return orderly Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 12/20] qmp: introduce asynchronous command type Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 13/20] scripts: learn 'async' qapi commands Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 14/20] qmp: add qmp_return_is_cancelled() Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 15/20] monitor: add qmp_return_get_monitor() Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 16/20] console: add graphic_hw_update_done() Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-10 8:43 ` Gerd Hoffmann 2019-04-10 8:43 ` Gerd Hoffmann 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 17/20] console: make screendump asynchronous Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-10 8:48 ` Gerd Hoffmann 2019-04-10 8:48 ` Gerd Hoffmann 2019-07-15 19:09 ` Marc-André Lureau 2019-07-30 11:23 ` Gerd Hoffmann 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 18/20] monitor: start making qmp_human_monitor_command() asynchronous Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 19/20] monitor: teach HMP about asynchronous commands Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 16:10 ` [Qemu-devel] [PATCH v4 20/20] hmp: call the asynchronous QMP screendump to fix outdated/glitches Marc-André Lureau 2019-04-09 16:10 ` Marc-André Lureau 2019-04-09 19:05 ` [Qemu-devel] [PATCH v4 00/20] monitor: add asynchronous command type no-reply 2019-04-09 19:05 ` no-reply 2019-04-09 19:07 ` no-reply 2019-04-09 19:07 ` no-reply 2019-05-17 22:21 ` Marc-André Lureau 2019-05-21 14:17 ` Markus Armbruster 2019-05-21 14:50 ` Marc-André Lureau 2019-05-23 7:52 ` Markus Armbruster 2019-05-25 12:12 ` Marc-André Lureau 2019-05-27 8:18 ` Markus Armbruster 2019-05-27 9:07 ` Gerd Hoffmann 2019-05-27 13:23 ` Markus Armbruster 2019-05-27 15:17 ` Marc-André Lureau 2019-05-28 6:09 ` Gerd Hoffmann 2019-05-31 9:15 ` Kevin Wolf 2019-05-21 20:50 ` John Snow
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20190409161009.6322-9-marcandre.lureau@redhat.com \ --to=marcandre.lureau@redhat.com \ --cc=armbru@redhat.com \ --cc=dgilbert@redhat.com \ --cc=eblake@redhat.com \ --cc=kraxel@redhat.com \ --cc=mdroth@linux.vnet.ibm.com \ --cc=qemu-devel@nongnu.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.