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 QmpCommand *qmp_find_command(QmpCommandList *cmds, const char *name);
  43 void qmp_disable_command(QmpCommandList *cmds, const char *name);
  44 void qmp_enable_command(QmpCommandList *cmds, const char *name);
  45
  46 bool qmp_command_is_enabled(const QmpCommand *cmd);
  47 const char *qmp_command_name(const QmpCommand *cmd);
  48 bool qmp_has_success_response(const QmpCommand *cmd);
  49 QDict *qmp_error_response(Error *err);
  50 QDict *qmp_dispatch(QmpCommandList *cmds, QObject *request,
  51                     bool allow_oob);
  52 bool qmp_is_oob(const QDict *dict);
  53
  54 typedef void (*qmp_cmd_callback_fn)(QmpCommand *cmd, void *opaque);
  55
  56 void qmp_for_each_command(QmpCommandList *cmds, qmp_cmd_callback_fn fn,
  57                           void *opaque);
  58
  59 #endif