Merge tag 'pull-target-arm-20220519' of https://git.linaro.org/people/pmaydell/qemu...
[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 "monitor/monitor.h"
18 #include "qemu/queue.h"
19
20 typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
21
22 typedef enum QmpCommandOptions
23 {
24 QCO_NO_SUCCESS_RESP = (1U << 0),
25 QCO_ALLOW_OOB = (1U << 1),
26 QCO_ALLOW_PRECONFIG = (1U << 2),
27 QCO_COROUTINE = (1U << 3),
28 } QmpCommandOptions;
29
30 typedef struct QmpCommand
31 {
32 const char *name;
33 /* Runs in coroutine context if QCO_COROUTINE is set */
34 QmpCommandFunc *fn;
35 QmpCommandOptions options;
36 unsigned special_features;
37 QTAILQ_ENTRY(QmpCommand) node;
38 bool enabled;
39 const char *disable_reason;
40 } QmpCommand;
41
42 typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
43
44 void qmp_register_command(QmpCommandList *cmds, const char *name,
45 QmpCommandFunc *fn, QmpCommandOptions options,
46 unsigned special_features);
47 const QmpCommand *qmp_find_command(const QmpCommandList *cmds,
48 const char *name);
49 void qmp_disable_command(QmpCommandList *cmds, const char *name,
50 const char *err_msg);
51 void qmp_enable_command(QmpCommandList *cmds, const char *name);
52
53 bool qmp_command_is_enabled(const QmpCommand *cmd);
54 bool qmp_command_available(const QmpCommand *cmd, Error **errp);
55 const char *qmp_command_name(const QmpCommand *cmd);
56 bool qmp_has_success_response(const QmpCommand *cmd);
57 QDict *qmp_error_response(Error *err);
58 QDict *qmp_dispatch(const QmpCommandList *cmds, QObject *request,
59 bool allow_oob, Monitor *cur_mon);
60 bool qmp_is_oob(const QDict *dict);
61
62 typedef void (*qmp_cmd_callback_fn)(const QmpCommand *cmd, void *opaque);
63
64 void qmp_for_each_command(const QmpCommandList *cmds, qmp_cmd_callback_fn fn,
65 void *opaque);
66
67 #endif