LXR qemu/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
  20typedef void (QmpCommandFunc)(QDict *, QObject **, Error **);
  21
  22typedef 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    QCO_COROUTINE             =  (1U << 3),
  29    QCO_DEPRECATED            =  (1U << 4),
  30} QmpCommandOptions;
  31
  32typedef struct QmpCommand
  33{
  34    const char *name;
  35    /* Runs in coroutine context if QCO_COROUTINE is set */
  36    QmpCommandFunc *fn;
  37    QmpCommandOptions options;
  38    QTAILQ_ENTRY(QmpCommand) node;
  39    bool enabled;
  40    const char *disable_reason;
  41} QmpCommand;
  42
  43typedef QTAILQ_HEAD(QmpCommandList, QmpCommand) QmpCommandList;
  44
  45void qmp_register_command(QmpCommandList *cmds, const char *name,
  46                          QmpCommandFunc *fn, QmpCommandOptions options);
  47const QmpCommand *qmp_find_command(const QmpCommandList *cmds,
  48                                   const char *name);
  49void qmp_disable_command(QmpCommandList *cmds, const char *name,
  50                         const char *err_msg);
  51void qmp_enable_command(QmpCommandList *cmds, const char *name);
  52
  53bool qmp_command_is_enabled(const QmpCommand *cmd);
  54bool qmp_command_available(const QmpCommand *cmd, Error **errp);
  55const char *qmp_command_name(const QmpCommand *cmd);
  56bool qmp_has_success_response(const QmpCommand *cmd);
  57QDict *qmp_error_response(Error *err);
  58QDict *qmp_dispatch(const QmpCommandList *cmds, QObject *request,
  59                    bool allow_oob, Monitor *cur_mon);
  60bool qmp_is_oob(const QDict *dict);
  61
  62typedef void (*qmp_cmd_callback_fn)(const QmpCommand *cmd, void *opaque);
  63
  64void qmp_for_each_command(const QmpCommandList *cmds, qmp_cmd_callback_fn fn,
  65                          void *opaque);
  66
  67#endif
  68