mirror of
https://github.com/qemu/qemu.git
synced 2025-07-29 06:26:06 +00:00

Here "oob" stands for "Out-Of-Band". When "allow-oob" is set, it means the command allows out-of-band execution. The "oob" idea is proposed by Markus Armbruster in following thread: https://lists.gnu.org/archive/html/qemu-devel/2017-09/msg02057.html This new "allow-oob" boolean will be exposed by "query-qmp-schema" as well for command entries, so that QMP clients can know which commands can be used in out-of-band calls. For example the command "migrate" originally looks like: {"name": "migrate", "ret-type": "17", "meta-type": "command", "arg-type": "86"} And it'll be changed into: {"name": "migrate", "ret-type": "17", "allow-oob": false, "meta-type": "command", "arg-type": "86"} This patch only provides the QMP interface level changes. It does not contain the real out-of-band execution implementation yet. Suggested-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Fam Zheng <famz@redhat.com> Signed-off-by: Peter Xu <peterx@redhat.com> Message-Id: <20180309090006.10018-18-peterx@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> [eblake: rebase on introspection done by qlit] Signed-off-by: Eric Blake <eblake@redhat.com>
58 lines
1.7 KiB
C
58 lines
1.7 KiB
C
/*
|
|
* Core Definitions for QAPI/QMP Dispatch
|
|
*
|
|
* Copyright IBM, Corp. 2011
|
|
*
|
|
* Authors:
|
|
* Anthony Liguori <aliguori@us.ibm.com>
|
|
*
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
*
|
|
*/
|
|
|
|
#ifndef QAPI_QMP_DISPATCH_H
|
|
#define QAPI_QMP_DISPATCH_H
|
|
|
|
#include "qemu/queue.h"
|
|
|
|
typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
|
|
|
|
typedef enum QmpCommandOptions
|
|
{
|
|
QCO_NO_OPTIONS = 0x0,
|
|
QCO_NO_SUCCESS_RESP = (1U << 0),
|
|
QCO_ALLOW_OOB = (1U << 1),
|
|
} QmpCommandOptions;
|
|
|
|
typedef struct QmpCommand
|
|
{
|
|
const char *name;
|
|
QmpCommandFunc *fn;
|
|
QmpCommandOptions options;
|
|
QTAILQ_ENTRY(QmpCommand) node;
|
|
bool enabled;
|
|
} QmpCommand;
|
|
|
|
typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
|
|
|
|
void qmp_register_command(QmpCommandList *cmds, const char *name,
|
|
QmpCommandFunc *fn, QmpCommandOptions options);
|
|
void qmp_unregister_command(QmpCommandList *cmds, const char *name);
|
|
QmpCommand *qmp_find_command(QmpCommandList *cmds, const char *name);
|
|
QObject *qmp_dispatch(QmpCommandList *cmds, QObject *request);
|
|
void qmp_disable_command(QmpCommandList *cmds, const char *name);
|
|
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);
|
|
QObject *qmp_build_error_object(Error *err);
|
|
|
|
typedef void (*qmp_cmd_callback_fn)(QmpCommand *cmd, void *opaque);
|
|
|
|
void qmp_for_each_command(QmpCommandList *cmds, qmp_cmd_callback_fn fn,
|
|
void *opaque);
|
|
|
|
#endif
|