Merge remote-tracking branch 'remotes/vivier2/tags/trivial-branch-for-5.2-pull-reques...
[qemu.git] / include / qapi / qmp / dispatch.h
1 /*
2 * Core Definitions for QAPI/QMP Dispatch
3 *
4 * Copyright IBM, Corp. 2011
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
10 * See the COPYING.LIB file in the top-level directory.
11 *
12 */
13
14 #ifndef QAPI_QMP_DISPATCH_H
15 #define QAPI_QMP_DISPATCH_H
16
17 #include "qemu/queue.h"
18
19 typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
20
21 typedef enum QmpCommandOptions
22 {
23 QCO_NO_OPTIONS = 0x0,
24 QCO_NO_SUCCESS_RESP = (1U << 0),
25 QCO_ALLOW_OOB = (1U << 1),
26 QCO_ALLOW_PRECONFIG = (1U << 2),
27 } QmpCommandOptions;
28
29 typedef struct QmpCommand
30 {
31 const char *name;
32 QmpCommandFunc *fn;
33 QmpCommandOptions options;
34 QTAILQ_ENTRY(QmpCommand) node;
35 bool enabled;
36 } QmpCommand;
37
38 typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
39
40 void qmp_register_command(QmpCommandList *cmds, const char *name,
41 QmpCommandFunc *fn, QmpCommandOptions options);
42 const QmpCommand *qmp_find_command(const QmpCommandList *cmds,
43 const char *name);
44 void qmp_disable_command(QmpCommandList *cmds, const char *name);
45 void qmp_enable_command(QmpCommandList *cmds, const char *name);
46
47 bool qmp_command_is_enabled(const QmpCommand *cmd);
48 const char *qmp_command_name(const QmpCommand *cmd);
49 bool qmp_has_success_response(const QmpCommand *cmd);
50 QDict *qmp_error_response(Error *err);
51 QDict *qmp_dispatch(const QmpCommandList *cmds, QObject *request,
52 bool allow_oob);
53 bool qmp_is_oob(const QDict *dict);
54
55 typedef void (*qmp_cmd_callback_fn)(const QmpCommand *cmd, void *opaque);
56
57 void qmp_for_each_command(const QmpCommandList *cmds, qmp_cmd_callback_fn fn,
58 void *opaque);
59
60 #endif