cf869d5317
Having "allow-oob":true for a command does not mean that this command
will always be run in out-of-band mode. The out-of-band quick path will
only be executed if we specify the extra "run-oob" flag when sending the
QMP request:
{ "execute": "command-that-allows-oob",
"arguments": { ... },
"control": { "run-oob": true } }
The "control" key is introduced to store this extra flag. "control"
field is used to store arguments that are shared by all the commands,
rather than command specific arguments. Let "run-oob" be the first.
Note that in the patch I exported qmp_dispatch_check_obj() to be used to
check the request earlier, and at the same time allowed "id" field to be
there since actually we always allow that.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Peter Xu <peterx@redhat.com>
Message-Id: <20180309090006.10018-19-peterx@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
[eblake: rebase to qobject_to(), spelling fix]
Signed-off-by: Eric Blake <eblake@redhat.com>
60 lines
1.8 KiB
C
60 lines
1.8 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);
|
|
QDict *qmp_dispatch_check_obj(const QObject *request, Error **errp);
|
|
bool qmp_is_oob(QDict *dict);
|
|
|
|
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
|