qemu/monitor/monitor-internal.h
<<
>>
Prefs 
   1/*
   2 * QEMU monitor
   3 *
   4 * Copyright (c) 2003-2004 Fabrice Bellard
   5 *
   6 * Permission is hereby granted, free of charge, to any person obtaining a copy
   7 * of this software and associated documentation files (the "Software"), to deal
   8 * in the Software without restriction, including without limitation the rights
   9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 * copies of the Software, and to permit persons to whom the Software is
  11 * furnished to do so, subject to the following conditions:
  12 *
  13 * The above copyright notice and this permission notice shall be included in
  14 * all copies or substantial portions of the Software.
  15 *
  16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 * THE SOFTWARE.
  23 */
  24
  25#ifndef MONITOR_INTERNAL_H
  26#define MONITOR_INTERNAL_H
  27
  28#include "chardev/char-fe.h"
  29#include "monitor/monitor.h"
  30#include "qapi/qapi-types-control.h"
  31#include "qapi/qmp/dispatch.h"
  32#include "qapi/qmp/json-parser.h"
  33#include "qemu/readline.h"
  34#include "sysemu/iothread.h"
  35
  36/*
  37 * Supported types:
  38 *
  39 * 'F'          filename
  40 * 'B'          block device name
  41 * 's'          string (accept optional quote)
  42 * 'S'          it just appends the rest of the string (accept optional quote)
  43 * 'O'          option string of the form NAME=VALUE,...
  44 *              parsed according to QemuOptsList given by its name
  45 *              Example: 'device:O' uses qemu_device_opts.
  46 *              Restriction: only lists with empty desc are supported
  47 *              TODO lift the restriction
  48 * 'i'          32 bit integer
  49 * 'l'          target long (32 or 64 bit)
  50 * 'M'          Non-negative target long (32 or 64 bit), in user mode the
  51 *              value is multiplied by 2^20 (think Mebibyte)
  52 * 'o'          octets (aka bytes)
  53 *              user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
  54 *              K, k suffix, which multiplies the value by 2^60 for suffixes E
  55 *              and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
  56 *              2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
  57 * 'T'          double
  58 *              user mode accepts an optional ms, us, ns suffix,
  59 *              which divides the value by 1e3, 1e6, 1e9, respectively
  60 * '/'          optional gdb-like print format (like "/10x")
  61 *
  62 * '?'          optional type (for all types, except '/')
  63 * '.'          other form of optional type (for 'i' and 'l')
  64 * 'b'          boolean
  65 *              user mode accepts "on" or "off"
  66 * '-'          optional parameter (eg. '-f')
  67 *
  68 */
  69
  70typedef struct HMPCommand {
  71    const char *name;
  72    const char *args_type;
  73    const char *params;
  74    const char *help;
  75    const char *flags; /* p=preconfig */
  76    void (*cmd)(Monitor *mon, const QDict *qdict);
  77    /*
  78     * If implementing a command that takes no arguments and simply
  79     * prints formatted data, then leave @cmd NULL, and then set
  80     * @cmd_info_hrt to the corresponding QMP handler that returns
  81     * the formatted text.
  82     */
  83    HumanReadableText *(*cmd_info_hrt)(Error **errp);
  84    bool coroutine;
  85    /*
  86     * @sub_table is a list of 2nd level of commands. If it does not exist,
  87     * cmd should be used. If it exists, sub_table[?].cmd should be
  88     * used, and cmd of 1st level plays the role of help function.
  89     */
  90    struct HMPCommand *sub_table;
  91    void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
  92} HMPCommand;
  93
  94struct Monitor {
  95    CharBackend chr;
  96    int reset_seen;
  97    int suspend_cnt;            /* Needs to be accessed atomically */
  98    bool is_qmp;
  99    bool skip_flush;
 100    bool use_io_thread;
 101
 102    char *mon_cpu_path;
 103    QTAILQ_ENTRY(Monitor) entry;
 104
 105    /*
 106     * The per-monitor lock. We can't access guest memory when holding
 107     * the lock.
 108     */
 109    QemuMutex mon_lock;
 110
 111    /*
 112     * Members that are protected by the per-monitor lock
 113     */
 114    QLIST_HEAD(, mon_fd_t) fds;
 115    GString *outbuf;
 116    guint out_watch;
 117    /* Read under either BQL or mon_lock, written with BQL+mon_lock.  */
 118    int mux_out;
 119};
 120
 121struct MonitorHMP {
 122    Monitor common;
 123    bool use_readline;
 124    /*
 125     * State used only in the thread "owning" the monitor.
 126     * If @use_io_thread, this is @mon_iothread. (This does not actually happen
 127     * in the current state of the code.)
 128     * Else, it's the main thread.
 129     * These members can be safely accessed without locks.
 130     */
 131    ReadLineState *rs;
 132};
 133
 134typedef struct {
 135    Monitor common;
 136    JSONMessageParser parser;
 137    bool pretty;
 138    /*
 139     * When a client connects, we're in capabilities negotiation mode.
 140     * @commands is &qmp_cap_negotiation_commands then.  When command
 141     * qmp_capabilities succeeds, we go into command mode, and
 142     * @command becomes &qmp_commands.
 143     */
 144    const QmpCommandList *commands;
 145    bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
 146    bool capab[QMP_CAPABILITY__MAX];         /* offered and accepted */
 147    /*
 148     * Protects qmp request/response queue.
 149     * Take monitor_lock first when you need both.
 150     */
 151    QemuMutex qmp_queue_lock;
 152    /* Input queue that holds all the parsed QMP requests */
 153    GQueue *qmp_requests;
 154} MonitorQMP;
 155
 156/**
 157 * Is @mon a QMP monitor?
 158 */
 159static inline bool monitor_is_qmp(const Monitor *mon)
 160{
 161    return mon->is_qmp;
 162}
 163
 164typedef QTAILQ_HEAD(MonitorList, Monitor) MonitorList;
 165extern IOThread *mon_iothread;
 166extern Coroutine *qmp_dispatcher_co;
 167extern bool qmp_dispatcher_co_shutdown;
 168extern bool qmp_dispatcher_co_busy;
 169extern QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
 170extern QemuMutex monitor_lock;
 171extern MonitorList mon_list;
 172extern int mon_refcount;
 173
 174extern HMPCommand hmp_cmds[];
 175
 176int monitor_puts(Monitor *mon, const char *str);
 177void monitor_data_init(Monitor *mon, bool is_qmp, bool skip_flush,
 178                       bool use_io_thread);
 179void monitor_data_destroy(Monitor *mon);
 180int monitor_can_read(void *opaque);
 181void monitor_list_append(Monitor *mon);
 182void monitor_fdsets_cleanup(void);
 183
 184void qmp_send_response(MonitorQMP *mon, const QDict *rsp);
 185void monitor_data_destroy_qmp(MonitorQMP *mon);
 186void coroutine_fn monitor_qmp_dispatcher_co(void *data);
 187
 188int get_monitor_def(Monitor *mon, int64_t *pval, const char *name);
 189void help_cmd(Monitor *mon, const char *name);
 190void handle_hmp_command(MonitorHMP *mon, const char *cmdline);
 191int hmp_compare_cmd(const char *name, const char *list);
 192
 193#endif
 194
Hosted by Missing Link Electronics. The original LXR software by the LXR community, this experimental version by lxr@linux.no.