xref: /openbmc/qemu/include/qapi/qmp/dispatch.h (revision 41725fa7eda1d97576fc8c79b58d04a61629f40e)
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_OPTIONS            =  0x0,
25     QCO_NO_SUCCESS_RESP       =  (1U << 0),
26     QCO_ALLOW_OOB             =  (1U << 1),
27     QCO_ALLOW_PRECONFIG       =  (1U << 2),
28 } QmpCommandOptions;
29 
30 typedef struct QmpCommand
31 {
32     const char *name;
33     QmpCommandFunc *fn;
34     QmpCommandOptions options;
35     QTAILQ_ENTRY(QmpCommand) node;
36     bool enabled;
37 } QmpCommand;
38 
39 typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
40 
41 void qmp_register_command(QmpCommandList *cmds, const char *name,
42                           QmpCommandFunc *fn, QmpCommandOptions options);
43 const QmpCommand *qmp_find_command(const QmpCommandList *cmds,
44                                    const char *name);
45 void qmp_disable_command(QmpCommandList *cmds, const char *name);
46 void qmp_enable_command(QmpCommandList *cmds, const char *name);
47 
48 bool qmp_command_is_enabled(const QmpCommand *cmd);
49 const char *qmp_command_name(const QmpCommand *cmd);
50 bool qmp_has_success_response(const QmpCommand *cmd);
51 QDict *qmp_error_response(Error *err);
52 QDict *qmp_dispatch(const QmpCommandList *cmds, QObject *request,
53                     bool allow_oob, Monitor *cur_mon);
54 bool qmp_is_oob(const QDict *dict);
55 
56 typedef void (*qmp_cmd_callback_fn)(const QmpCommand *cmd, void *opaque);
57 
58 void qmp_for_each_command(const QmpCommandList *cmds, qmp_cmd_callback_fn fn,
59                           void *opaque);
60 
61 #endif
62