xref: /openbmc/qemu/include/qapi/qmp/dispatch.h (revision 1527badb)
17b1b5d19SPaolo Bonzini /*
27b1b5d19SPaolo Bonzini  * Core Definitions for QAPI/QMP Dispatch
37b1b5d19SPaolo Bonzini  *
47b1b5d19SPaolo Bonzini  * Copyright IBM, Corp. 2011
57b1b5d19SPaolo Bonzini  *
67b1b5d19SPaolo Bonzini  * Authors:
77b1b5d19SPaolo Bonzini  *  Anthony Liguori   <aliguori@us.ibm.com>
87b1b5d19SPaolo Bonzini  *
97b1b5d19SPaolo Bonzini  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
107b1b5d19SPaolo Bonzini  * See the COPYING.LIB file in the top-level directory.
117b1b5d19SPaolo Bonzini  *
127b1b5d19SPaolo Bonzini  */
137b1b5d19SPaolo Bonzini 
14121d0712SMarkus Armbruster #ifndef QAPI_QMP_DISPATCH_H
15121d0712SMarkus Armbruster #define QAPI_QMP_DISPATCH_H
167b1b5d19SPaolo Bonzini 
177b1b5d19SPaolo Bonzini #include "qapi/qmp/qobject.h"
187b1b5d19SPaolo Bonzini #include "qapi/qmp/qdict.h"
197b1b5d19SPaolo Bonzini 
207b1b5d19SPaolo Bonzini typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
217b1b5d19SPaolo Bonzini 
227b1b5d19SPaolo Bonzini typedef enum QmpCommandOptions
237b1b5d19SPaolo Bonzini {
247b1b5d19SPaolo Bonzini     QCO_NO_OPTIONS = 0x0,
257b1b5d19SPaolo Bonzini     QCO_NO_SUCCESS_RESP = 0x1,
267b1b5d19SPaolo Bonzini } QmpCommandOptions;
277b1b5d19SPaolo Bonzini 
287b1b5d19SPaolo Bonzini typedef struct QmpCommand
297b1b5d19SPaolo Bonzini {
307b1b5d19SPaolo Bonzini     const char *name;
317b1b5d19SPaolo Bonzini     QmpCommandFunc *fn;
327b1b5d19SPaolo Bonzini     QmpCommandOptions options;
337b1b5d19SPaolo Bonzini     QTAILQ_ENTRY(QmpCommand) node;
347b1b5d19SPaolo Bonzini     bool enabled;
357b1b5d19SPaolo Bonzini } QmpCommand;
367b1b5d19SPaolo Bonzini 
37*1527badbSMarkus Armbruster typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
38*1527badbSMarkus Armbruster 
39*1527badbSMarkus Armbruster void qmp_register_command(QmpCommandList *cmds, const char *name,
40*1527badbSMarkus Armbruster                           QmpCommandFunc *fn, QmpCommandOptions options);
41*1527badbSMarkus Armbruster void qmp_unregister_command(QmpCommandList *cmds, const char *name);
42*1527badbSMarkus Armbruster QmpCommand *qmp_find_command(QmpCommandList *cmds, const char *name);
43*1527badbSMarkus Armbruster QObject *qmp_dispatch(QmpCommandList *cmds, QObject *request);
44*1527badbSMarkus Armbruster void qmp_disable_command(QmpCommandList *cmds, const char *name);
45*1527badbSMarkus Armbruster void qmp_enable_command(QmpCommandList *cmds, const char *name);
46*1527badbSMarkus Armbruster 
478dc4d915SMark Wu bool qmp_command_is_enabled(const QmpCommand *cmd);
488dc4d915SMark Wu const char *qmp_command_name(const QmpCommand *cmd);
490106dc4fSMark Wu bool qmp_has_success_response(const QmpCommand *cmd);
50e940f543SMarkus Armbruster QObject *qmp_build_error_object(Error *err);
51*1527badbSMarkus Armbruster 
528dc4d915SMark Wu typedef void (*qmp_cmd_callback_fn)(QmpCommand *cmd, void *opaque);
53*1527badbSMarkus Armbruster 
54*1527badbSMarkus Armbruster void qmp_for_each_command(QmpCommandList *cmds, qmp_cmd_callback_fn fn,
55*1527badbSMarkus Armbruster                           void *opaque);
567b1b5d19SPaolo Bonzini 
577b1b5d19SPaolo Bonzini #endif
58