4 * Copyright (c) 2003-2004 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 #include "qemu/osdep.h"
26 #include "qemu-common.h"
29 #include "monitor/qdev.h"
31 #include "hw/i386/pc.h"
32 #include "hw/pci/pci.h"
33 #include "sysemu/watchdog.h"
34 #include "hw/loader.h"
35 #include "exec/gdbstub.h"
37 #include "net/slirp.h"
38 #include "sysemu/char.h"
39 #include "ui/qemu-spice.h"
40 #include "sysemu/sysemu.h"
41 #include "sysemu/numa.h"
42 #include "monitor/monitor.h"
43 #include "qemu/config-file.h"
44 #include "qemu/readline.h"
45 #include "ui/console.h"
47 #include "sysemu/blockdev.h"
48 #include "sysemu/block-backend.h"
49 #include "audio/audio.h"
50 #include "disas/disas.h"
51 #include "sysemu/balloon.h"
52 #include "qemu/timer.h"
53 #include "migration/migration.h"
54 #include "sysemu/hw_accel.h"
56 #include "sysemu/tpm.h"
57 #include "qapi/qmp/qerror.h"
58 #include "qapi/qmp/types.h"
59 #include "qapi/qmp/qjson.h"
60 #include "qapi/qmp/json-streamer.h"
61 #include "qapi/qmp/json-parser.h"
62 #include "qom/object_interfaces.h"
63 #include "trace-root.h"
64 #include "trace/control.h"
65 #include "monitor/hmp-target.h"
66 #ifdef CONFIG_TRACE_SIMPLE
67 #include "trace/simple.h"
69 #include "exec/memory.h"
70 #include "exec/exec-all.h"
72 #include "qmp-commands.h"
74 #include "qemu/thread.h"
75 #include "block/qapi.h"
76 #include "qapi/qmp-event.h"
77 #include "qapi-event.h"
78 #include "qmp-introspect.h"
79 #include "sysemu/qtest.h"
80 #include "sysemu/cpus.h"
81 #include "qemu/cutils.h"
82 #include "qapi/qmp/dispatch.h"
84 #if defined(TARGET_S390X)
85 #include "hw/s390x/storage-keys.h"
92 * 'B' block device name
93 * 's' string (accept optional quote)
94 * 'S' it just appends the rest of the string (accept optional quote)
95 * 'O' option string of the form NAME=VALUE,...
96 * parsed according to QemuOptsList given by its name
97 * Example: 'device:O' uses qemu_device_opts.
98 * Restriction: only lists with empty desc are supported
99 * TODO lift the restriction
101 * 'l' target long (32 or 64 bit)
102 * 'M' Non-negative target long (32 or 64 bit), in user mode the
103 * value is multiplied by 2^20 (think Mebibyte)
104 * 'o' octets (aka bytes)
105 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
106 * K, k suffix, which multiplies the value by 2^60 for suffixes E
107 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
108 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
110 * user mode accepts an optional ms, us, ns suffix,
111 * which divides the value by 1e3, 1e6, 1e9, respectively
112 * '/' optional gdb-like print format (like "/10x")
114 * '?' optional type (for all types, except '/')
115 * '.' other form of optional type (for 'i' and 'l')
117 * user mode accepts "on" or "off"
118 * '-' optional parameter (eg. '-f')
122 typedef struct mon_cmd_t {
124 const char *args_type;
127 void (*cmd)(Monitor *mon, const QDict *qdict);
128 /* @sub_table is a list of 2nd level of commands. If it does not exist,
129 * cmd should be used. If it exists, sub_table[?].cmd should be
130 * used, and cmd of 1st level plays the role of help function.
132 struct mon_cmd_t *sub_table;
133 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
136 /* file descriptors passed via SCM_RIGHTS */
137 typedef struct mon_fd_t mon_fd_t;
141 QLIST_ENTRY(mon_fd_t) next;
144 /* file descriptor associated with a file descriptor set */
145 typedef struct MonFdsetFd MonFdsetFd;
150 QLIST_ENTRY(MonFdsetFd) next;
153 /* file descriptor set containing fds passed via SCM_RIGHTS */
154 typedef struct MonFdset MonFdset;
157 QLIST_HEAD(, MonFdsetFd) fds;
158 QLIST_HEAD(, MonFdsetFd) dup_fds;
159 QLIST_ENTRY(MonFdset) next;
163 JSONMessageParser parser;
165 * When a client connects, we're in capabilities negotiation mode.
166 * When command qmp_capabilities succeeds, we go into command
169 QmpCommandList *commands;
173 * To prevent flooding clients, events can be throttled. The
174 * throttling is calculated globally, rather than per-Monitor
177 typedef struct MonitorQAPIEventState {
178 QAPIEvent event; /* Throttling state for this event type and... */
179 QDict *data; /* ... data, see qapi_event_throttle_equal() */
180 QEMUTimer *timer; /* Timer for handling delayed events */
181 QDict *qdict; /* Delayed event (if any) */
182 } MonitorQAPIEventState;
185 int64_t rate; /* Minimum time (in ns) between two events */
186 } MonitorQAPIEventConf;
199 /* Read under either BQL or out_lock, written with BQL+out_lock. */
205 BlockCompletionFunc *password_completion_cb;
206 void *password_opaque;
207 mon_cmd_t *cmd_table;
208 QLIST_HEAD(,mon_fd_t) fds;
209 QLIST_ENTRY(Monitor) entry;
212 /* QMP checker flags */
213 #define QMP_ACCEPT_UNKNOWNS 1
215 /* Protects mon_list, monitor_event_state. */
216 static QemuMutex monitor_lock;
218 static QLIST_HEAD(mon_list, Monitor) mon_list;
219 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
220 static int mon_refcount;
222 static mon_cmd_t mon_cmds[];
223 static mon_cmd_t info_cmds[];
225 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
229 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
231 static void monitor_command_cb(void *opaque, const char *cmdline,
232 void *readline_opaque);
235 * Is @mon a QMP monitor?
237 static inline bool monitor_is_qmp(const Monitor *mon)
239 return (mon->flags & MONITOR_USE_CONTROL);
243 * Is the current monitor, if any, a QMP monitor?
245 bool monitor_cur_is_qmp(void)
247 return cur_mon && monitor_is_qmp(cur_mon);
250 void monitor_read_command(Monitor *mon, int show_prompt)
255 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
257 readline_show_prompt(mon->rs);
260 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
264 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
265 /* prompt is printed on return from the command handler */
268 monitor_printf(mon, "terminal does not support password prompting\n");
273 static void monitor_flush_locked(Monitor *mon);
275 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
278 Monitor *mon = opaque;
280 qemu_mutex_lock(&mon->out_lock);
282 monitor_flush_locked(mon);
283 qemu_mutex_unlock(&mon->out_lock);
287 /* Called with mon->out_lock held. */
288 static void monitor_flush_locked(Monitor *mon)
294 if (mon->skip_flush) {
298 buf = qstring_get_str(mon->outbuf);
299 len = qstring_get_length(mon->outbuf);
301 if (len && !mon->mux_out) {
302 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
303 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
304 /* all flushed or error */
305 QDECREF(mon->outbuf);
306 mon->outbuf = qstring_new();
311 QString *tmp = qstring_from_str(buf + rc);
312 QDECREF(mon->outbuf);
315 if (mon->out_watch == 0) {
317 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
318 monitor_unblocked, mon);
323 void monitor_flush(Monitor *mon)
325 qemu_mutex_lock(&mon->out_lock);
326 monitor_flush_locked(mon);
327 qemu_mutex_unlock(&mon->out_lock);
330 /* flush at every end of line */
331 static void monitor_puts(Monitor *mon, const char *str)
335 qemu_mutex_lock(&mon->out_lock);
341 qstring_append_chr(mon->outbuf, '\r');
343 qstring_append_chr(mon->outbuf, c);
345 monitor_flush_locked(mon);
348 qemu_mutex_unlock(&mon->out_lock);
351 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
358 if (monitor_is_qmp(mon)) {
362 buf = g_strdup_vprintf(fmt, ap);
363 monitor_puts(mon, buf);
367 void monitor_printf(Monitor *mon, const char *fmt, ...)
371 monitor_vprintf(mon, fmt, ap);
375 int monitor_fprintf(FILE *stream, const char *fmt, ...)
379 monitor_vprintf((Monitor *)stream, fmt, ap);
384 static void monitor_json_emitter(Monitor *mon, const QObject *data)
388 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
389 qobject_to_json(data);
390 assert(json != NULL);
392 qstring_append_chr(json, '\n');
393 monitor_puts(mon, qstring_get_str(json));
398 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
399 /* Limit guest-triggerable events to 1 per second */
400 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
401 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
402 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
403 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
404 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
405 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
408 GHashTable *monitor_qapi_event_state;
411 * Emits the event to every monitor instance, @event is only used for trace
412 * Called with monitor_lock held.
414 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
418 trace_monitor_protocol_event_emit(event, qdict);
419 QLIST_FOREACH(mon, &mon_list, entry) {
420 if (monitor_is_qmp(mon)
421 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
422 monitor_json_emitter(mon, QOBJECT(qdict));
427 static void monitor_qapi_event_handler(void *opaque);
430 * Queue a new event for emission to Monitor instances,
431 * applying any rate limiting if required.
434 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
436 MonitorQAPIEventConf *evconf;
437 MonitorQAPIEventState *evstate;
439 assert(event < QAPI_EVENT__MAX);
440 evconf = &monitor_qapi_event_conf[event];
441 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
443 qemu_mutex_lock(&monitor_lock);
446 /* Unthrottled event */
447 monitor_qapi_event_emit(event, qdict);
449 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
450 MonitorQAPIEventState key = { .event = event, .data = data };
452 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
453 assert(!evstate || timer_pending(evstate->timer));
457 * Timer is pending for (at least) evconf->rate ns after
458 * last send. Store event for sending when timer fires,
459 * replacing a prior stored event if any.
461 QDECREF(evstate->qdict);
462 evstate->qdict = qdict;
463 QINCREF(evstate->qdict);
466 * Last send was (at least) evconf->rate ns ago.
467 * Send immediately, and arm the timer to call
468 * monitor_qapi_event_handler() in evconf->rate ns. Any
469 * events arriving before then will be delayed until then.
471 int64_t now = qemu_clock_get_ns(event_clock_type);
473 monitor_qapi_event_emit(event, qdict);
475 evstate = g_new(MonitorQAPIEventState, 1);
476 evstate->event = event;
477 evstate->data = data;
478 QINCREF(evstate->data);
479 evstate->qdict = NULL;
480 evstate->timer = timer_new_ns(event_clock_type,
481 monitor_qapi_event_handler,
483 g_hash_table_add(monitor_qapi_event_state, evstate);
484 timer_mod_ns(evstate->timer, now + evconf->rate);
488 qemu_mutex_unlock(&monitor_lock);
492 * This function runs evconf->rate ns after sending a throttled
494 * If another event has since been stored, send it.
496 static void monitor_qapi_event_handler(void *opaque)
498 MonitorQAPIEventState *evstate = opaque;
499 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
501 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
502 qemu_mutex_lock(&monitor_lock);
504 if (evstate->qdict) {
505 int64_t now = qemu_clock_get_ns(event_clock_type);
507 monitor_qapi_event_emit(evstate->event, evstate->qdict);
508 QDECREF(evstate->qdict);
509 evstate->qdict = NULL;
510 timer_mod_ns(evstate->timer, now + evconf->rate);
512 g_hash_table_remove(monitor_qapi_event_state, evstate);
513 QDECREF(evstate->data);
514 timer_free(evstate->timer);
518 qemu_mutex_unlock(&monitor_lock);
521 static unsigned int qapi_event_throttle_hash(const void *key)
523 const MonitorQAPIEventState *evstate = key;
524 unsigned int hash = evstate->event * 255;
526 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
527 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
530 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
531 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
537 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
539 const MonitorQAPIEventState *eva = a;
540 const MonitorQAPIEventState *evb = b;
542 if (eva->event != evb->event) {
546 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
547 return !strcmp(qdict_get_str(eva->data, "id"),
548 qdict_get_str(evb->data, "id"));
551 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
552 return !strcmp(qdict_get_str(eva->data, "node-name"),
553 qdict_get_str(evb->data, "node-name"));
559 static void monitor_qapi_event_init(void)
561 if (qtest_enabled()) {
562 event_clock_type = QEMU_CLOCK_VIRTUAL;
565 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
566 qapi_event_throttle_equal);
567 qmp_event_set_func_emit(monitor_qapi_event_queue);
570 static void handle_hmp_command(Monitor *mon, const char *cmdline);
572 static void monitor_data_init(Monitor *mon)
574 memset(mon, 0, sizeof(Monitor));
575 qemu_mutex_init(&mon->out_lock);
576 mon->outbuf = qstring_new();
577 /* Use *mon_cmds by default. */
578 mon->cmd_table = mon_cmds;
581 static void monitor_data_destroy(Monitor *mon)
583 qemu_chr_fe_deinit(&mon->chr);
584 if (monitor_is_qmp(mon)) {
585 json_message_parser_destroy(&mon->qmp.parser);
588 QDECREF(mon->outbuf);
589 qemu_mutex_destroy(&mon->out_lock);
592 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
593 int64_t cpu_index, Error **errp)
596 Monitor *old_mon, hmp;
598 monitor_data_init(&hmp);
599 hmp.skip_flush = true;
605 int ret = monitor_set_cpu(cpu_index);
608 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
614 handle_hmp_command(&hmp, command_line);
617 qemu_mutex_lock(&hmp.out_lock);
618 if (qstring_get_length(hmp.outbuf) > 0) {
619 output = g_strdup(qstring_get_str(hmp.outbuf));
621 output = g_strdup("");
623 qemu_mutex_unlock(&hmp.out_lock);
626 monitor_data_destroy(&hmp);
630 static int compare_cmd(const char *name, const char *list)
632 const char *p, *pstart;
640 p = pstart + strlen(pstart);
641 if ((p - pstart) == len && !memcmp(pstart, name, len))
650 static int get_str(char *buf, int buf_size, const char **pp)
658 while (qemu_isspace(*p)) {
669 while (*p != '\0' && *p != '\"') {
685 printf("unsupported escape code: '\\%c'\n", c);
688 if ((q - buf) < buf_size - 1) {
692 if ((q - buf) < buf_size - 1) {
699 printf("unterminated string\n");
704 while (*p != '\0' && !qemu_isspace(*p)) {
705 if ((q - buf) < buf_size - 1) {
718 static void free_cmdline_args(char **args, int nb_args)
722 assert(nb_args <= MAX_ARGS);
724 for (i = 0; i < nb_args; i++) {
731 * Parse the command line to get valid args.
732 * @cmdline: command line to be parsed.
733 * @pnb_args: location to store the number of args, must NOT be NULL.
734 * @args: location to store the args, which should be freed by caller, must
737 * Returns 0 on success, negative on failure.
739 * NOTE: this parser is an approximate form of the real command parser. Number
740 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
741 * return with failure.
743 static int parse_cmdline(const char *cmdline,
744 int *pnb_args, char **args)
753 while (qemu_isspace(*p)) {
759 if (nb_args >= MAX_ARGS) {
762 ret = get_str(buf, sizeof(buf), &p);
766 args[nb_args] = g_strdup(buf);
773 free_cmdline_args(args, nb_args);
777 static void help_cmd_dump_one(Monitor *mon,
778 const mon_cmd_t *cmd,
784 for (i = 0; i < prefix_args_nb; i++) {
785 monitor_printf(mon, "%s ", prefix_args[i]);
787 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
790 /* @args[@arg_index] is the valid command need to find in @cmds */
791 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
792 char **args, int nb_args, int arg_index)
794 const mon_cmd_t *cmd;
796 /* No valid arg need to compare with, dump all in *cmds */
797 if (arg_index >= nb_args) {
798 for (cmd = cmds; cmd->name != NULL; cmd++) {
799 help_cmd_dump_one(mon, cmd, args, arg_index);
804 /* Find one entry to dump */
805 for (cmd = cmds; cmd->name != NULL; cmd++) {
806 if (compare_cmd(args[arg_index], cmd->name)) {
807 if (cmd->sub_table) {
808 /* continue with next arg */
809 help_cmd_dump(mon, cmd->sub_table,
810 args, nb_args, arg_index + 1);
812 help_cmd_dump_one(mon, cmd, args, arg_index);
819 static void help_cmd(Monitor *mon, const char *name)
821 char *args[MAX_ARGS];
824 /* 1. parse user input */
826 /* special case for log, directly dump and return */
827 if (!strcmp(name, "log")) {
828 const QEMULogItem *item;
829 monitor_printf(mon, "Log items (comma separated):\n");
830 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
831 for (item = qemu_log_items; item->mask != 0; item++) {
832 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
837 if (parse_cmdline(name, &nb_args, args) < 0) {
842 /* 2. dump the contents according to parsed args */
843 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
845 free_cmdline_args(args, nb_args);
848 static void do_help_cmd(Monitor *mon, const QDict *qdict)
850 help_cmd(mon, qdict_get_try_str(qdict, "name"));
853 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
855 const char *tp_name = qdict_get_str(qdict, "name");
856 bool new_state = qdict_get_bool(qdict, "option");
857 bool has_vcpu = qdict_haskey(qdict, "vcpu");
858 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
859 Error *local_err = NULL;
862 monitor_printf(mon, "argument vcpu must be positive");
866 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
868 error_report_err(local_err);
872 #ifdef CONFIG_TRACE_SIMPLE
873 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
875 const char *op = qdict_get_try_str(qdict, "op");
876 const char *arg = qdict_get_try_str(qdict, "arg");
879 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
880 } else if (!strcmp(op, "on")) {
881 st_set_trace_file_enabled(true);
882 } else if (!strcmp(op, "off")) {
883 st_set_trace_file_enabled(false);
884 } else if (!strcmp(op, "flush")) {
885 st_flush_trace_buffer();
886 } else if (!strcmp(op, "set")) {
888 st_set_trace_file(arg);
891 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
892 help_cmd(mon, "trace-file");
897 static void hmp_info_help(Monitor *mon, const QDict *qdict)
899 help_cmd(mon, "info");
902 static void query_commands_cb(QmpCommand *cmd, void *opaque)
904 CommandInfoList *info, **list = opaque;
910 info = g_malloc0(sizeof(*info));
911 info->value = g_malloc0(sizeof(*info->value));
912 info->value->name = g_strdup(cmd->name);
917 CommandInfoList *qmp_query_commands(Error **errp)
919 CommandInfoList *list = NULL;
921 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
926 EventInfoList *qmp_query_events(Error **errp)
928 EventInfoList *info, *ev_list = NULL;
931 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
932 const char *event_name = QAPIEvent_lookup[e];
933 assert(event_name != NULL);
934 info = g_malloc0(sizeof(*info));
935 info->value = g_malloc0(sizeof(*info->value));
936 info->value->name = g_strdup(event_name);
938 info->next = ev_list;
946 * Minor hack: generated marshalling suppressed for this command
947 * ('gen': false in the schema) so we can parse the JSON string
948 * directly into QObject instead of first parsing it with
949 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
950 * to QObject with generated output marshallers, every time. Instead,
951 * we do it in test-qobject-input-visitor.c, just to make sure
952 * qapi-introspect.py's output actually conforms to the schema.
954 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
957 *ret_data = qobject_from_json(qmp_schema_json, &error_abort);
961 * We used to define commands in qmp-commands.hx in addition to the
962 * QAPI schema. This permitted defining some of them only in certain
963 * configurations. query-commands has always reflected that (good,
964 * because it lets QMP clients figure out what's actually available),
965 * while query-qmp-schema never did (not so good). This function is a
966 * hack to keep the configuration-specific commands defined exactly as
967 * before, even though qmp-commands.hx is gone.
969 * FIXME Educate the QAPI schema on configuration-specific commands,
970 * and drop this hack.
972 static void qmp_unregister_commands_hack(void)
975 qmp_unregister_command(&qmp_commands, "query-spice");
978 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
981 qmp_unregister_command(&qmp_commands, "dump-skeys");
984 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
986 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
987 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
989 #if !defined(TARGET_S390X)
990 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
991 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
993 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
994 && !defined(TARGET_S390X)
995 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
999 void monitor_init_qmp_commands(void)
1002 * Two command lists:
1003 * - qmp_commands contains all QMP commands
1004 * - qmp_cap_negotiation_commands contains just
1005 * "qmp_capabilities", to enforce capability negotiation
1008 qmp_init_marshal(&qmp_commands);
1010 qmp_register_command(&qmp_commands, "query-qmp-schema",
1011 qmp_query_qmp_schema,
1013 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1015 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1018 qmp_unregister_commands_hack();
1020 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1021 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1022 qmp_marshal_qmp_capabilities, QCO_NO_OPTIONS);
1025 void qmp_qmp_capabilities(Error **errp)
1027 if (cur_mon->qmp.commands == &qmp_commands) {
1028 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1029 "Capabilities negotiation is already complete, command "
1034 cur_mon->qmp.commands = &qmp_commands;
1037 /* set the current CPU defined by the user */
1038 int monitor_set_cpu(int cpu_index)
1042 cpu = qemu_get_cpu(cpu_index);
1046 cur_mon->mon_cpu = cpu;
1050 CPUState *mon_get_cpu(void)
1052 if (!cur_mon->mon_cpu) {
1056 monitor_set_cpu(first_cpu->cpu_index);
1058 cpu_synchronize_state(cur_mon->mon_cpu);
1059 return cur_mon->mon_cpu;
1062 CPUArchState *mon_get_cpu_env(void)
1064 CPUState *cs = mon_get_cpu();
1066 return cs ? cs->env_ptr : NULL;
1069 int monitor_get_cpu_index(void)
1071 CPUState *cs = mon_get_cpu();
1073 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1076 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1078 CPUState *cs = mon_get_cpu();
1081 monitor_printf(mon, "No CPU available\n");
1084 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1087 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1089 dump_exec_info((FILE *)mon, monitor_fprintf);
1090 dump_drift_info((FILE *)mon, monitor_fprintf);
1093 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1095 dump_opcount_info((FILE *)mon, monitor_fprintf);
1098 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1107 str = readline_get_history(mon->rs, i);
1110 monitor_printf(mon, "%d: '%s'\n", i, str);
1115 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1117 CPUState *cs = mon_get_cpu();
1120 monitor_printf(mon, "No CPU available\n");
1123 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1126 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1128 const char *name = qdict_get_try_str(qdict, "name");
1129 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1130 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1131 TraceEventInfoList *events;
1132 TraceEventInfoList *elem;
1133 Error *local_err = NULL;
1139 monitor_printf(mon, "argument vcpu must be positive");
1143 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1145 error_report_err(local_err);
1149 for (elem = events; elem != NULL; elem = elem->next) {
1150 monitor_printf(mon, "%s : state %u\n",
1152 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1154 qapi_free_TraceEventInfoList(events);
1157 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1158 bool has_port, int64_t port,
1159 bool has_tls_port, int64_t tls_port,
1160 bool has_cert_subject, const char *cert_subject,
1163 if (strcmp(protocol, "spice") == 0) {
1164 if (!qemu_using_spice(errp)) {
1168 if (!has_port && !has_tls_port) {
1169 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1173 if (qemu_spice_migrate_info(hostname,
1174 has_port ? port : -1,
1175 has_tls_port ? tls_port : -1,
1177 error_setg(errp, QERR_UNDEFINED_ERROR);
1183 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1186 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1190 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1192 error_report_err(err);
1196 static void hmp_log(Monitor *mon, const QDict *qdict)
1199 const char *items = qdict_get_str(qdict, "items");
1201 if (!strcmp(items, "none")) {
1204 mask = qemu_str_to_log_mask(items);
1206 help_cmd(mon, "log");
1213 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1215 const char *option = qdict_get_try_str(qdict, "option");
1216 if (!option || !strcmp(option, "on")) {
1218 } else if (!strcmp(option, "off")) {
1221 monitor_printf(mon, "unexpected option %s\n", option);
1225 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1227 const char *device = qdict_get_try_str(qdict, "device");
1229 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1230 if (gdbserver_start(device) < 0) {
1231 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1233 } else if (strcmp(device, "none") == 0) {
1234 monitor_printf(mon, "Disabled gdbserver\n");
1236 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1241 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1243 const char *action = qdict_get_str(qdict, "action");
1244 if (select_watchdog_action(action) == -1) {
1245 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1249 static void monitor_printc(Monitor *mon, int c)
1251 monitor_printf(mon, "'");
1254 monitor_printf(mon, "\\'");
1257 monitor_printf(mon, "\\\\");
1260 monitor_printf(mon, "\\n");
1263 monitor_printf(mon, "\\r");
1266 if (c >= 32 && c <= 126) {
1267 monitor_printf(mon, "%c", c);
1269 monitor_printf(mon, "\\x%02x", c);
1273 monitor_printf(mon, "'");
1276 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1277 hwaddr addr, int is_physical)
1279 int l, line_size, i, max_digits, len;
1282 CPUState *cs = mon_get_cpu();
1284 if (!cs && (format == 'i' || !is_physical)) {
1285 monitor_printf(mon, "Can not dump without CPU\n");
1289 if (format == 'i') {
1292 CPUArchState *env = mon_get_cpu_env();
1295 } else if (wsize == 4) {
1298 /* as default we use the current CS size */
1301 #ifdef TARGET_X86_64
1302 if ((env->efer & MSR_EFER_LMA) &&
1303 (env->segs[R_CS].flags & DESC_L_MASK))
1307 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1313 CPUArchState *env = mon_get_cpu_env();
1314 flags = msr_le << 16;
1315 flags |= env->bfd_mach;
1317 monitor_disas(mon, cs, addr, count, is_physical, flags);
1321 len = wsize * count;
1330 max_digits = (wsize * 8 + 2) / 3;
1334 max_digits = (wsize * 8) / 4;
1338 max_digits = (wsize * 8 * 10 + 32) / 33;
1347 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1349 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1354 cpu_physical_memory_read(addr, buf, l);
1356 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1357 monitor_printf(mon, " Cannot access memory\n");
1366 v = ldub_p(buf + i);
1369 v = lduw_p(buf + i);
1372 v = (uint32_t)ldl_p(buf + i);
1378 monitor_printf(mon, " ");
1381 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1384 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1387 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1390 monitor_printf(mon, "%*" PRId64, max_digits, v);
1393 monitor_printc(mon, v);
1398 monitor_printf(mon, "\n");
1404 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1406 int count = qdict_get_int(qdict, "count");
1407 int format = qdict_get_int(qdict, "format");
1408 int size = qdict_get_int(qdict, "size");
1409 target_long addr = qdict_get_int(qdict, "addr");
1411 memory_dump(mon, count, format, size, addr, 0);
1414 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1416 int count = qdict_get_int(qdict, "count");
1417 int format = qdict_get_int(qdict, "format");
1418 int size = qdict_get_int(qdict, "size");
1419 hwaddr addr = qdict_get_int(qdict, "addr");
1421 memory_dump(mon, count, format, size, addr, 1);
1424 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1426 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1430 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1434 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1435 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1436 memory_region_unref(mrs.mr);
1441 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1444 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1446 hwaddr addr = qdict_get_int(qdict, "addr");
1447 Error *local_err = NULL;
1448 MemoryRegion *mr = NULL;
1451 ptr = gpa2hva(&mr, addr, &local_err);
1453 error_report_err(local_err);
1457 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1459 addr, mr->name, ptr);
1461 memory_region_unref(mr);
1465 static uint64_t vtop(void *ptr, Error **errp)
1469 uintptr_t addr = (uintptr_t) ptr;
1470 uintptr_t pagesize = getpagesize();
1471 off_t offset = addr / pagesize * sizeof(pinfo);
1474 fd = open("/proc/self/pagemap", O_RDONLY);
1476 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1480 /* Force copy-on-write if necessary. */
1481 atomic_add((uint8_t *)ptr, 0);
1483 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1484 error_setg_errno(errp, errno, "Cannot read pagemap");
1487 if ((pinfo & (1ull << 63)) == 0) {
1488 error_setg(errp, "Page not present");
1491 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1498 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1500 hwaddr addr = qdict_get_int(qdict, "addr");
1501 Error *local_err = NULL;
1502 MemoryRegion *mr = NULL;
1506 ptr = gpa2hva(&mr, addr, &local_err);
1508 error_report_err(local_err);
1512 physaddr = vtop(ptr, &local_err);
1514 error_report_err(local_err);
1516 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1517 " (%s) is 0x%" PRIx64 "\n",
1518 addr, mr->name, (uint64_t) physaddr);
1521 memory_region_unref(mr);
1525 static void do_print(Monitor *mon, const QDict *qdict)
1527 int format = qdict_get_int(qdict, "format");
1528 hwaddr val = qdict_get_int(qdict, "val");
1532 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1535 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1538 monitor_printf(mon, "%" HWADDR_PRIu, val);
1542 monitor_printf(mon, "%" HWADDR_PRId, val);
1545 monitor_printc(mon, val);
1548 monitor_printf(mon, "\n");
1551 static void hmp_sum(Monitor *mon, const QDict *qdict)
1555 uint32_t start = qdict_get_int(qdict, "start");
1556 uint32_t size = qdict_get_int(qdict, "size");
1559 for(addr = start; addr < (start + size); addr++) {
1560 uint8_t val = address_space_ldub(&address_space_memory, addr,
1561 MEMTXATTRS_UNSPECIFIED, NULL);
1562 /* BSD sum algorithm ('sum' Unix command) */
1563 sum = (sum >> 1) | (sum << 15);
1566 monitor_printf(mon, "%05d\n", sum);
1569 static int mouse_button_state;
1571 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1573 int dx, dy, dz, button;
1574 const char *dx_str = qdict_get_str(qdict, "dx_str");
1575 const char *dy_str = qdict_get_str(qdict, "dy_str");
1576 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1578 dx = strtol(dx_str, NULL, 0);
1579 dy = strtol(dy_str, NULL, 0);
1580 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1581 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1584 dz = strtol(dz_str, NULL, 0);
1586 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1587 qemu_input_queue_btn(NULL, button, true);
1588 qemu_input_event_sync();
1589 qemu_input_queue_btn(NULL, button, false);
1592 qemu_input_event_sync();
1595 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1597 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1598 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1599 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1600 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1602 int button_state = qdict_get_int(qdict, "button_state");
1604 if (mouse_button_state == button_state) {
1607 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1608 qemu_input_event_sync();
1609 mouse_button_state = button_state;
1612 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1614 int size = qdict_get_int(qdict, "size");
1615 int addr = qdict_get_int(qdict, "addr");
1616 int has_index = qdict_haskey(qdict, "index");
1621 int index = qdict_get_int(qdict, "index");
1622 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1630 val = cpu_inb(addr);
1634 val = cpu_inw(addr);
1638 val = cpu_inl(addr);
1642 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1643 suffix, addr, size * 2, val);
1646 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1648 int size = qdict_get_int(qdict, "size");
1649 int addr = qdict_get_int(qdict, "addr");
1650 int val = qdict_get_int(qdict, "val");
1652 addr &= IOPORTS_MASK;
1657 cpu_outb(addr, val);
1660 cpu_outw(addr, val);
1663 cpu_outl(addr, val);
1668 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1670 Error *local_err = NULL;
1671 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1673 qemu_boot_set(bootdevice, &local_err);
1675 error_report_err(local_err);
1677 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1681 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1683 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1685 mtree_info((fprintf_function)monitor_printf, mon, flatview);
1688 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1694 node_mem = g_new0(uint64_t, nb_numa_nodes);
1695 query_numa_node_mem(node_mem);
1696 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1697 for (i = 0; i < nb_numa_nodes; i++) {
1698 monitor_printf(mon, "node %d cpus:", i);
1700 if (cpu->numa_node == i) {
1701 monitor_printf(mon, " %d", cpu->cpu_index);
1704 monitor_printf(mon, "\n");
1705 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1711 #ifdef CONFIG_PROFILER
1716 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1718 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1719 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1720 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1721 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1726 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1728 monitor_printf(mon, "Internal profiler not compiled\n");
1732 /* Capture support */
1733 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1735 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1740 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1741 monitor_printf(mon, "[%d]: ", i);
1742 s->ops.info (s->opaque);
1746 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1749 int n = qdict_get_int(qdict, "n");
1752 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1754 s->ops.destroy (s->opaque);
1755 QLIST_REMOVE (s, entries);
1762 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1764 const char *path = qdict_get_str(qdict, "path");
1765 int has_freq = qdict_haskey(qdict, "freq");
1766 int freq = qdict_get_try_int(qdict, "freq", -1);
1767 int has_bits = qdict_haskey(qdict, "bits");
1768 int bits = qdict_get_try_int(qdict, "bits", -1);
1769 int has_channels = qdict_haskey(qdict, "nchannels");
1770 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1773 s = g_malloc0 (sizeof (*s));
1775 freq = has_freq ? freq : 44100;
1776 bits = has_bits ? bits : 16;
1777 nchannels = has_channels ? nchannels : 2;
1779 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1780 monitor_printf(mon, "Failed to add wave capture\n");
1784 QLIST_INSERT_HEAD (&capture_head, s, entries);
1787 static qemu_acl *find_acl(Monitor *mon, const char *name)
1789 qemu_acl *acl = qemu_acl_find(name);
1792 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1797 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1799 const char *aclname = qdict_get_str(qdict, "aclname");
1800 qemu_acl *acl = find_acl(mon, aclname);
1801 qemu_acl_entry *entry;
1805 monitor_printf(mon, "policy: %s\n",
1806 acl->defaultDeny ? "deny" : "allow");
1807 QTAILQ_FOREACH(entry, &acl->entries, next) {
1809 monitor_printf(mon, "%d: %s %s\n", i,
1810 entry->deny ? "deny" : "allow", entry->match);
1815 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1817 const char *aclname = qdict_get_str(qdict, "aclname");
1818 qemu_acl *acl = find_acl(mon, aclname);
1821 qemu_acl_reset(acl);
1822 monitor_printf(mon, "acl: removed all rules\n");
1826 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1828 const char *aclname = qdict_get_str(qdict, "aclname");
1829 const char *policy = qdict_get_str(qdict, "policy");
1830 qemu_acl *acl = find_acl(mon, aclname);
1833 if (strcmp(policy, "allow") == 0) {
1834 acl->defaultDeny = 0;
1835 monitor_printf(mon, "acl: policy set to 'allow'\n");
1836 } else if (strcmp(policy, "deny") == 0) {
1837 acl->defaultDeny = 1;
1838 monitor_printf(mon, "acl: policy set to 'deny'\n");
1840 monitor_printf(mon, "acl: unknown policy '%s', "
1841 "expected 'deny' or 'allow'\n", policy);
1846 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1848 const char *aclname = qdict_get_str(qdict, "aclname");
1849 const char *match = qdict_get_str(qdict, "match");
1850 const char *policy = qdict_get_str(qdict, "policy");
1851 int has_index = qdict_haskey(qdict, "index");
1852 int index = qdict_get_try_int(qdict, "index", -1);
1853 qemu_acl *acl = find_acl(mon, aclname);
1857 if (strcmp(policy, "allow") == 0) {
1859 } else if (strcmp(policy, "deny") == 0) {
1862 monitor_printf(mon, "acl: unknown policy '%s', "
1863 "expected 'deny' or 'allow'\n", policy);
1867 ret = qemu_acl_insert(acl, deny, match, index);
1869 ret = qemu_acl_append(acl, deny, match);
1871 monitor_printf(mon, "acl: unable to add acl entry\n");
1873 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1877 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1879 const char *aclname = qdict_get_str(qdict, "aclname");
1880 const char *match = qdict_get_str(qdict, "match");
1881 qemu_acl *acl = find_acl(mon, aclname);
1885 ret = qemu_acl_remove(acl, match);
1887 monitor_printf(mon, "acl: no matching acl entry\n");
1889 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1893 void qmp_getfd(const char *fdname, Error **errp)
1898 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1900 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1904 if (qemu_isdigit(fdname[0])) {
1906 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1907 "a name not starting with a digit");
1911 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1912 if (strcmp(monfd->name, fdname) != 0) {
1921 monfd = g_malloc0(sizeof(mon_fd_t));
1922 monfd->name = g_strdup(fdname);
1925 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1928 void qmp_closefd(const char *fdname, Error **errp)
1932 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1933 if (strcmp(monfd->name, fdname) != 0) {
1937 QLIST_REMOVE(monfd, next);
1939 g_free(monfd->name);
1944 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1947 static void hmp_loadvm(Monitor *mon, const QDict *qdict)
1949 int saved_vm_running = runstate_is_running();
1950 const char *name = qdict_get_str(qdict, "name");
1952 vm_stop(RUN_STATE_RESTORE_VM);
1954 if (load_vmstate(name) == 0 && saved_vm_running) {
1959 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1963 QLIST_FOREACH(monfd, &mon->fds, next) {
1966 if (strcmp(monfd->name, fdname) != 0) {
1972 /* caller takes ownership of fd */
1973 QLIST_REMOVE(monfd, next);
1974 g_free(monfd->name);
1980 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1984 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1986 MonFdsetFd *mon_fdset_fd;
1987 MonFdsetFd *mon_fdset_fd_next;
1989 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
1990 if ((mon_fdset_fd->removed ||
1991 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
1992 runstate_is_running()) {
1993 close(mon_fdset_fd->fd);
1994 g_free(mon_fdset_fd->opaque);
1995 QLIST_REMOVE(mon_fdset_fd, next);
1996 g_free(mon_fdset_fd);
2000 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2001 QLIST_REMOVE(mon_fdset, next);
2006 static void monitor_fdsets_cleanup(void)
2008 MonFdset *mon_fdset;
2009 MonFdset *mon_fdset_next;
2011 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2012 monitor_fdset_cleanup(mon_fdset);
2016 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2017 const char *opaque, Error **errp)
2020 Monitor *mon = cur_mon;
2023 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2025 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2029 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2030 has_opaque, opaque, errp);
2042 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2044 MonFdset *mon_fdset;
2045 MonFdsetFd *mon_fdset_fd;
2048 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2049 if (mon_fdset->id != fdset_id) {
2052 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2054 if (mon_fdset_fd->fd != fd) {
2057 mon_fdset_fd->removed = true;
2060 mon_fdset_fd->removed = true;
2063 if (has_fd && !mon_fdset_fd) {
2066 monitor_fdset_cleanup(mon_fdset);
2072 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2075 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2077 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2080 FdsetInfoList *qmp_query_fdsets(Error **errp)
2082 MonFdset *mon_fdset;
2083 MonFdsetFd *mon_fdset_fd;
2084 FdsetInfoList *fdset_list = NULL;
2086 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2087 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2088 FdsetFdInfoList *fdsetfd_list = NULL;
2090 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2091 fdset_info->value->fdset_id = mon_fdset->id;
2093 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2094 FdsetFdInfoList *fdsetfd_info;
2096 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2097 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2098 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2099 if (mon_fdset_fd->opaque) {
2100 fdsetfd_info->value->has_opaque = true;
2101 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2103 fdsetfd_info->value->has_opaque = false;
2106 fdsetfd_info->next = fdsetfd_list;
2107 fdsetfd_list = fdsetfd_info;
2110 fdset_info->value->fds = fdsetfd_list;
2112 fdset_info->next = fdset_list;
2113 fdset_list = fdset_info;
2119 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2120 bool has_opaque, const char *opaque,
2123 MonFdset *mon_fdset = NULL;
2124 MonFdsetFd *mon_fdset_fd;
2128 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2129 /* Break if match found or match impossible due to ordering by ID */
2130 if (fdset_id <= mon_fdset->id) {
2131 if (fdset_id < mon_fdset->id) {
2139 if (mon_fdset == NULL) {
2140 int64_t fdset_id_prev = -1;
2141 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2145 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2146 "a non-negative value");
2149 /* Use specified fdset ID */
2150 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2151 mon_fdset_cur = mon_fdset;
2152 if (fdset_id < mon_fdset_cur->id) {
2157 /* Use first available fdset ID */
2158 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2159 mon_fdset_cur = mon_fdset;
2160 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2161 fdset_id_prev = mon_fdset_cur->id;
2168 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2170 mon_fdset->id = fdset_id;
2172 mon_fdset->id = fdset_id_prev + 1;
2175 /* The fdset list is ordered by fdset ID */
2176 if (!mon_fdset_cur) {
2177 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2178 } else if (mon_fdset->id < mon_fdset_cur->id) {
2179 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2181 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2185 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2186 mon_fdset_fd->fd = fd;
2187 mon_fdset_fd->removed = false;
2189 mon_fdset_fd->opaque = g_strdup(opaque);
2191 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2193 fdinfo = g_malloc0(sizeof(*fdinfo));
2194 fdinfo->fdset_id = mon_fdset->id;
2195 fdinfo->fd = mon_fdset_fd->fd;
2200 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2203 MonFdset *mon_fdset;
2204 MonFdsetFd *mon_fdset_fd;
2207 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2208 if (mon_fdset->id != fdset_id) {
2211 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2212 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2213 if (mon_fd_flags == -1) {
2217 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2218 return mon_fdset_fd->fd;
2230 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2232 MonFdset *mon_fdset;
2233 MonFdsetFd *mon_fdset_fd_dup;
2235 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2236 if (mon_fdset->id != fdset_id) {
2239 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2240 if (mon_fdset_fd_dup->fd == dup_fd) {
2244 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2245 mon_fdset_fd_dup->fd = dup_fd;
2246 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2252 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2254 MonFdset *mon_fdset;
2255 MonFdsetFd *mon_fdset_fd_dup;
2257 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2258 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2259 if (mon_fdset_fd_dup->fd == dup_fd) {
2261 QLIST_REMOVE(mon_fdset_fd_dup, next);
2262 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2263 monitor_fdset_cleanup(mon_fdset);
2267 return mon_fdset->id;
2275 int monitor_fdset_dup_fd_find(int dup_fd)
2277 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2280 void monitor_fdset_dup_fd_remove(int dup_fd)
2282 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2285 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2288 Error *local_err = NULL;
2290 if (!qemu_isdigit(fdname[0]) && mon) {
2291 fd = monitor_get_fd(mon, fdname, &local_err);
2293 fd = qemu_parse_fd(fdname);
2295 error_setg(&local_err, "Invalid file descriptor number '%s'",
2300 error_propagate(errp, local_err);
2309 /* Please update hmp-commands.hx when adding or changing commands */
2310 static mon_cmd_t info_cmds[] = {
2311 #include "hmp-commands-info.h"
2315 /* mon_cmds and info_cmds would be sorted at runtime */
2316 static mon_cmd_t mon_cmds[] = {
2317 #include "hmp-commands.h"
2321 /*******************************************************************/
2323 static const char *pch;
2324 static sigjmp_buf expr_env;
2327 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2328 expr_error(Monitor *mon, const char *fmt, ...)
2332 monitor_vprintf(mon, fmt, ap);
2333 monitor_printf(mon, "\n");
2335 siglongjmp(expr_env, 1);
2338 /* return 0 if OK, -1 if not found */
2339 static int get_monitor_def(target_long *pval, const char *name)
2341 const MonitorDef *md = target_monitor_defs();
2342 CPUState *cs = mon_get_cpu();
2347 if (cs == NULL || md == NULL) {
2351 for(; md->name != NULL; md++) {
2352 if (compare_cmd(name, md->name)) {
2353 if (md->get_value) {
2354 *pval = md->get_value(md, md->offset);
2356 CPUArchState *env = mon_get_cpu_env();
2357 ptr = (uint8_t *)env + md->offset;
2360 *pval = *(int32_t *)ptr;
2363 *pval = *(target_long *)ptr;
2374 ret = target_get_monitor_def(cs, name, &tmp);
2376 *pval = (target_long) tmp;
2382 static void next(void)
2386 while (qemu_isspace(*pch))
2391 static int64_t expr_sum(Monitor *mon);
2393 static int64_t expr_unary(Monitor *mon)
2402 n = expr_unary(mon);
2406 n = -expr_unary(mon);
2410 n = ~expr_unary(mon);
2416 expr_error(mon, "')' expected");
2423 expr_error(mon, "character constant expected");
2427 expr_error(mon, "missing terminating \' character");
2437 while ((*pch >= 'a' && *pch <= 'z') ||
2438 (*pch >= 'A' && *pch <= 'Z') ||
2439 (*pch >= '0' && *pch <= '9') ||
2440 *pch == '_' || *pch == '.') {
2441 if ((q - buf) < sizeof(buf) - 1)
2445 while (qemu_isspace(*pch))
2448 ret = get_monitor_def(®, buf);
2450 expr_error(mon, "unknown register");
2455 expr_error(mon, "unexpected end of expression");
2460 n = strtoull(pch, &p, 0);
2461 if (errno == ERANGE) {
2462 expr_error(mon, "number too large");
2465 expr_error(mon, "invalid char '%c' in expression", *p);
2468 while (qemu_isspace(*pch))
2476 static int64_t expr_prod(Monitor *mon)
2481 val = expr_unary(mon);
2484 if (op != '*' && op != '/' && op != '%')
2487 val2 = expr_unary(mon);
2496 expr_error(mon, "division by zero");
2507 static int64_t expr_logic(Monitor *mon)
2512 val = expr_prod(mon);
2515 if (op != '&' && op != '|' && op != '^')
2518 val2 = expr_prod(mon);
2535 static int64_t expr_sum(Monitor *mon)
2540 val = expr_logic(mon);
2543 if (op != '+' && op != '-')
2546 val2 = expr_logic(mon);
2555 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2558 if (sigsetjmp(expr_env, 0)) {
2562 while (qemu_isspace(*pch))
2564 *pval = expr_sum(mon);
2569 static int get_double(Monitor *mon, double *pval, const char **pp)
2571 const char *p = *pp;
2575 d = strtod(p, &tailp);
2577 monitor_printf(mon, "Number expected\n");
2580 if (d != d || d - d != 0) {
2581 /* NaN or infinity */
2582 monitor_printf(mon, "Bad number\n");
2591 * Store the command-name in cmdname, and return a pointer to
2592 * the remaining of the command string.
2594 static const char *get_command_name(const char *cmdline,
2595 char *cmdname, size_t nlen)
2598 const char *p, *pstart;
2601 while (qemu_isspace(*p))
2606 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2611 memcpy(cmdname, pstart, len);
2612 cmdname[len] = '\0';
2617 * Read key of 'type' into 'key' and return the current
2620 static char *key_get_info(const char *type, char **key)
2628 p = strchr(type, ':');
2635 str = g_malloc(len + 1);
2636 memcpy(str, type, len);
2643 static int default_fmt_format = 'x';
2644 static int default_fmt_size = 4;
2646 static int is_valid_option(const char *c, const char *typestr)
2654 typestr = strstr(typestr, option);
2655 return (typestr != NULL);
2658 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2659 const char *cmdname)
2661 const mon_cmd_t *cmd;
2663 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2664 if (compare_cmd(cmdname, cmd->name)) {
2673 * Parse command name from @cmdp according to command table @table.
2674 * If blank, return NULL.
2675 * Else, if no valid command can be found, report to @mon, and return
2677 * Else, change @cmdp to point right behind the name, and return its
2678 * command table entry.
2679 * Do not assume the return value points into @table! It doesn't when
2680 * the command is found in a sub-command table.
2682 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2687 const mon_cmd_t *cmd;
2690 /* extract the command name */
2691 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2695 cmd = search_dispatch_table(table, cmdname);
2697 monitor_printf(mon, "unknown command: '%.*s'\n",
2698 (int)(p - *cmdp), *cmdp);
2702 /* filter out following useless space */
2703 while (qemu_isspace(*p)) {
2708 /* search sub command */
2709 if (cmd->sub_table != NULL && *p != '\0') {
2710 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2717 * Parse arguments for @cmd.
2718 * If it can't be parsed, report to @mon, and return NULL.
2719 * Else, insert command arguments into a QDict, and return it.
2720 * Note: On success, caller has to free the QDict structure.
2723 static QDict *monitor_parse_arguments(Monitor *mon,
2725 const mon_cmd_t *cmd)
2727 const char *typestr;
2730 const char *p = *endp;
2732 QDict *qdict = qdict_new();
2734 /* parse the parameters */
2735 typestr = cmd->args_type;
2737 typestr = key_get_info(typestr, &key);
2749 while (qemu_isspace(*p))
2751 if (*typestr == '?') {
2754 /* no optional string: NULL argument */
2758 ret = get_str(buf, sizeof(buf), &p);
2762 monitor_printf(mon, "%s: filename expected\n",
2766 monitor_printf(mon, "%s: block device name expected\n",
2770 monitor_printf(mon, "%s: string expected\n", cmd->name);
2775 qdict_put(qdict, key, qstring_from_str(buf));
2780 QemuOptsList *opts_list;
2783 opts_list = qemu_find_opts(key);
2784 if (!opts_list || opts_list->desc->name) {
2787 while (qemu_isspace(*p)) {
2792 if (get_str(buf, sizeof(buf), &p) < 0) {
2795 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2799 qemu_opts_to_qdict(opts, qdict);
2800 qemu_opts_del(opts);
2805 int count, format, size;
2807 while (qemu_isspace(*p))
2813 if (qemu_isdigit(*p)) {
2815 while (qemu_isdigit(*p)) {
2816 count = count * 10 + (*p - '0');
2854 if (*p != '\0' && !qemu_isspace(*p)) {
2855 monitor_printf(mon, "invalid char in format: '%c'\n",
2860 format = default_fmt_format;
2861 if (format != 'i') {
2862 /* for 'i', not specifying a size gives -1 as size */
2864 size = default_fmt_size;
2865 default_fmt_size = size;
2867 default_fmt_format = format;
2870 format = default_fmt_format;
2871 if (format != 'i') {
2872 size = default_fmt_size;
2877 qdict_put(qdict, "count", qint_from_int(count));
2878 qdict_put(qdict, "format", qint_from_int(format));
2879 qdict_put(qdict, "size", qint_from_int(size));
2888 while (qemu_isspace(*p))
2890 if (*typestr == '?' || *typestr == '.') {
2891 if (*typestr == '?') {
2899 while (qemu_isspace(*p))
2908 if (get_expr(mon, &val, &p))
2910 /* Check if 'i' is greater than 32-bit */
2911 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2912 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2913 monitor_printf(mon, "integer is for 32-bit values\n");
2915 } else if (c == 'M') {
2917 monitor_printf(mon, "enter a positive value\n");
2922 qdict_put(qdict, key, qint_from_int(val));
2931 while (qemu_isspace(*p)) {
2934 if (*typestr == '?') {
2940 ret = qemu_strtosz_MiB(p, &end, &val);
2941 if (ret < 0 || val > INT64_MAX) {
2942 monitor_printf(mon, "invalid size\n");
2945 qdict_put(qdict, key, qint_from_int(val));
2953 while (qemu_isspace(*p))
2955 if (*typestr == '?') {
2961 if (get_double(mon, &val, &p) < 0) {
2964 if (p[0] && p[1] == 's') {
2967 val /= 1e3; p += 2; break;
2969 val /= 1e6; p += 2; break;
2971 val /= 1e9; p += 2; break;
2974 if (*p && !qemu_isspace(*p)) {
2975 monitor_printf(mon, "Unknown unit suffix\n");
2978 qdict_put(qdict, key, qfloat_from_double(val));
2986 while (qemu_isspace(*p)) {
2990 while (qemu_isgraph(*p)) {
2993 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
2995 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
2998 monitor_printf(mon, "Expected 'on' or 'off'\n");
3001 qdict_put(qdict, key, qbool_from_bool(val));
3006 const char *tmp = p;
3013 while (qemu_isspace(*p))
3018 if(!is_valid_option(p, typestr)) {
3020 monitor_printf(mon, "%s: unsupported option -%c\n",
3032 qdict_put(qdict, key, qbool_from_bool(true));
3039 /* package all remaining string */
3042 while (qemu_isspace(*p)) {
3045 if (*typestr == '?') {
3048 /* no remaining string: NULL argument */
3054 monitor_printf(mon, "%s: string expected\n",
3058 qdict_put(qdict, key, qstring_from_str(p));
3064 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3070 /* check that all arguments were parsed */
3071 while (qemu_isspace(*p))
3074 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3087 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3090 const mon_cmd_t *cmd;
3092 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
3097 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3099 monitor_printf(mon, "Try \"help %s\" for more information\n",
3104 cmd->cmd(mon, qdict);
3108 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3110 const char *p, *pstart;
3119 p = pstart + strlen(pstart);
3121 if (len > sizeof(cmd) - 2)
3122 len = sizeof(cmd) - 2;
3123 memcpy(cmd, pstart, len);
3125 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3126 readline_add_completion(mon->rs, cmd);
3134 static void file_completion(Monitor *mon, const char *input)
3139 char file[1024], file_prefix[1024];
3143 p = strrchr(input, '/');
3146 pstrcpy(file_prefix, sizeof(file_prefix), input);
3147 pstrcpy(path, sizeof(path), ".");
3149 input_path_len = p - input + 1;
3150 memcpy(path, input, input_path_len);
3151 if (input_path_len > sizeof(path) - 1)
3152 input_path_len = sizeof(path) - 1;
3153 path[input_path_len] = '\0';
3154 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3157 ffs = opendir(path);
3166 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3170 if (strstart(d->d_name, file_prefix, NULL)) {
3171 memcpy(file, input, input_path_len);
3172 if (input_path_len < sizeof(file))
3173 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3175 /* stat the file to find out if it's a directory.
3176 * In that case add a slash to speed up typing long paths
3178 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3179 pstrcat(file, sizeof(file), "/");
3181 readline_add_completion(mon->rs, file);
3187 static const char *next_arg_type(const char *typestr)
3189 const char *p = strchr(typestr, ':');
3190 return (p != NULL ? ++p : typestr);
3193 static void add_completion_option(ReadLineState *rs, const char *str,
3196 if (!str || !option) {
3199 if (!strncmp(option, str, strlen(str))) {
3200 readline_add_completion(rs, option);
3204 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3207 ChardevBackendInfoList *list, *start;
3213 readline_set_completion_index(rs, len);
3215 start = list = qmp_query_chardev_backends(NULL);
3217 const char *chr_name = list->value->name;
3219 if (!strncmp(chr_name, str, len)) {
3220 readline_add_completion(rs, chr_name);
3224 qapi_free_ChardevBackendInfoList(start);
3227 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3236 readline_set_completion_index(rs, len);
3237 for (i = 0; NetClientDriver_lookup[i]; i++) {
3238 add_completion_option(rs, str, NetClientDriver_lookup[i]);
3242 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3252 readline_set_completion_index(rs, len);
3253 list = elt = object_class_get_list(TYPE_DEVICE, false);
3256 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3258 name = object_class_get_name(OBJECT_CLASS(dc));
3260 if (!dc->cannot_instantiate_with_device_add_yet
3261 && !strncmp(name, str, len)) {
3262 readline_add_completion(rs, name);
3269 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3279 readline_set_completion_index(rs, len);
3280 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3284 name = object_class_get_name(OBJECT_CLASS(elt->data));
3285 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3286 readline_add_completion(rs, name);
3293 static void peripheral_device_del_completion(ReadLineState *rs,
3294 const char *str, size_t len)
3296 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3297 GSList *list, *item;
3299 list = qdev_build_hotpluggable_device_list(peripheral);
3304 for (item = list; item; item = g_slist_next(item)) {
3305 DeviceState *dev = item->data;
3307 if (dev->id && !strncmp(str, dev->id, len)) {
3308 readline_add_completion(rs, dev->id);
3315 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3318 ChardevInfoList *list, *start;
3324 readline_set_completion_index(rs, len);
3326 start = list = qmp_query_chardev(NULL);
3328 ChardevInfo *chr = list->value;
3330 if (!strncmp(chr->label, str, len)) {
3331 readline_add_completion(rs, chr->label);
3335 qapi_free_ChardevInfoList(start);
3338 static void ringbuf_completion(ReadLineState *rs, const char *str)
3341 ChardevInfoList *list, *start;
3344 readline_set_completion_index(rs, len);
3346 start = list = qmp_query_chardev(NULL);
3348 ChardevInfo *chr_info = list->value;
3350 if (!strncmp(chr_info->label, str, len)) {
3351 Chardev *chr = qemu_chr_find(chr_info->label);
3352 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3353 readline_add_completion(rs, chr_info->label);
3358 qapi_free_ChardevInfoList(start);
3361 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3366 ringbuf_completion(rs, str);
3369 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3378 readline_set_completion_index(rs, len);
3379 peripheral_device_del_completion(rs, str, len);
3382 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3384 ObjectPropertyInfoList *list, *start;
3391 readline_set_completion_index(rs, len);
3393 start = list = qmp_qom_list("/objects", NULL);
3395 ObjectPropertyInfo *info = list->value;
3397 if (!strncmp(info->type, "child<", 5)
3398 && !strncmp(info->name, str, len)) {
3399 readline_add_completion(rs, info->name);
3403 qapi_free_ObjectPropertyInfoList(start);
3406 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3415 sep = strrchr(str, '-');
3420 readline_set_completion_index(rs, len);
3421 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3422 if (!strncmp(str, QKeyCode_lookup[i], len)) {
3423 readline_add_completion(rs, QKeyCode_lookup[i]);
3428 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3433 readline_set_completion_index(rs, len);
3435 NetClientState *ncs[MAX_QUEUE_NUM];
3437 count = qemu_find_net_clients_except(NULL, ncs,
3438 NET_CLIENT_DRIVER_NONE,
3440 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3441 const char *name = ncs[i]->name;
3442 if (!strncmp(str, name, len)) {
3443 readline_add_completion(rs, name);
3446 } else if (nb_args == 3) {
3447 add_completion_option(rs, str, "on");
3448 add_completion_option(rs, str, "off");
3452 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3455 NetClientState *ncs[MAX_QUEUE_NUM];
3462 readline_set_completion_index(rs, len);
3463 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3465 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3467 const char *name = ncs[i]->name;
3468 if (strncmp(str, name, len)) {
3471 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3473 readline_add_completion(rs, name);
3478 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3483 readline_set_completion_index(rs, len);
3485 TraceEventIter iter;
3487 char *pattern = g_strdup_printf("%s*", str);
3488 trace_event_iter_init(&iter, pattern);
3489 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3490 readline_add_completion(rs, trace_event_get_name(ev));
3496 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3501 readline_set_completion_index(rs, len);
3503 TraceEventIter iter;
3505 char *pattern = g_strdup_printf("%s*", str);
3506 trace_event_iter_init(&iter, pattern);
3507 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3508 readline_add_completion(rs, trace_event_get_name(ev));
3511 } else if (nb_args == 3) {
3512 add_completion_option(rs, str, "on");
3513 add_completion_option(rs, str, "off");
3517 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3524 readline_set_completion_index(rs, strlen(str));
3525 for (i = 0; WatchdogExpirationAction_lookup[i]; i++) {
3526 add_completion_option(rs, str, WatchdogExpirationAction_lookup[i]);
3530 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3536 readline_set_completion_index(rs, len);
3539 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3540 const char *name = MigrationCapability_lookup[i];
3541 if (!strncmp(str, name, len)) {
3542 readline_add_completion(rs, name);
3545 } else if (nb_args == 3) {
3546 add_completion_option(rs, str, "on");
3547 add_completion_option(rs, str, "off");
3551 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3557 readline_set_completion_index(rs, len);
3560 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3561 const char *name = MigrationParameter_lookup[i];
3562 if (!strncmp(str, name, len)) {
3563 readline_add_completion(rs, name);
3569 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3577 readline_set_completion_index(rs, len);
3578 for (i = 0; host_net_devices[i]; i++) {
3579 if (!strncmp(host_net_devices[i], str, len)) {
3580 readline_add_completion(rs, host_net_devices[i]);
3585 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3587 NetClientState *ncs[MAX_QUEUE_NUM];
3591 readline_set_completion_index(rs, len);
3593 count = qemu_find_net_clients_except(NULL, ncs,
3594 NET_CLIENT_DRIVER_NONE,
3596 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3600 if (net_hub_id_for_client(ncs[i], &id)) {
3603 snprintf(name, sizeof(name), "%d", id);
3604 if (!strncmp(str, name, len)) {
3605 readline_add_completion(rs, name);
3609 } else if (nb_args == 3) {
3610 count = qemu_find_net_clients_except(NULL, ncs,
3611 NET_CLIENT_DRIVER_NIC,
3613 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3617 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3618 net_hub_id_for_client(ncs[i], &id)) {
3621 name = ncs[i]->name;
3622 if (!strncmp(str, name, len)) {
3623 readline_add_completion(rs, name);
3630 static void vm_completion(ReadLineState *rs, const char *str)
3633 BlockDriverState *bs;
3634 BdrvNextIterator it;
3637 readline_set_completion_index(rs, len);
3639 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3640 SnapshotInfoList *snapshots, *snapshot;
3641 AioContext *ctx = bdrv_get_aio_context(bs);
3644 aio_context_acquire(ctx);
3645 if (bdrv_can_snapshot(bs)) {
3646 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3648 aio_context_release(ctx);
3653 snapshot = snapshots;
3655 char *completion = snapshot->value->name;
3656 if (!strncmp(str, completion, len)) {
3657 readline_add_completion(rs, completion);
3659 completion = snapshot->value->id;
3660 if (!strncmp(str, completion, len)) {
3661 readline_add_completion(rs, completion);
3663 snapshot = snapshot->next;
3665 qapi_free_SnapshotInfoList(snapshots);
3670 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3673 vm_completion(rs, str);
3677 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3680 vm_completion(rs, str);
3684 static void monitor_find_completion_by_table(Monitor *mon,
3685 const mon_cmd_t *cmd_table,
3689 const char *cmdname;
3691 const char *ptype, *str, *name;
3692 const mon_cmd_t *cmd;
3693 BlockBackend *blk = NULL;
3696 /* command completion */
3701 readline_set_completion_index(mon->rs, strlen(cmdname));
3702 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3703 cmd_completion(mon, cmdname, cmd->name);
3706 /* find the command */
3707 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3708 if (compare_cmd(args[0], cmd->name)) {
3716 if (cmd->sub_table) {
3717 /* do the job again */
3718 monitor_find_completion_by_table(mon, cmd->sub_table,
3719 &args[1], nb_args - 1);
3722 if (cmd->command_completion) {
3723 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3727 ptype = next_arg_type(cmd->args_type);
3728 for(i = 0; i < nb_args - 2; i++) {
3729 if (*ptype != '\0') {
3730 ptype = next_arg_type(ptype);
3731 while (*ptype == '?')
3732 ptype = next_arg_type(ptype);
3735 str = args[nb_args - 1];
3736 while (*ptype == '-' && ptype[1] != '\0') {
3737 ptype = next_arg_type(ptype);
3741 /* file completion */
3742 readline_set_completion_index(mon->rs, strlen(str));
3743 file_completion(mon, str);
3746 /* block device name completion */
3747 readline_set_completion_index(mon->rs, strlen(str));
3748 while ((blk = blk_next(blk)) != NULL) {
3749 name = blk_name(blk);
3750 if (str[0] == '\0' ||
3751 !strncmp(name, str, strlen(str))) {
3752 readline_add_completion(mon->rs, name);
3758 if (!strcmp(cmd->name, "help|?")) {
3759 monitor_find_completion_by_table(mon, cmd_table,
3760 &args[1], nb_args - 1);
3769 static void monitor_find_completion(void *opaque,
3770 const char *cmdline)
3772 Monitor *mon = opaque;
3773 char *args[MAX_ARGS];
3776 /* 1. parse the cmdline */
3777 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3781 /* if the line ends with a space, it means we want to complete the
3783 len = strlen(cmdline);
3784 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3785 if (nb_args >= MAX_ARGS) {
3788 args[nb_args++] = g_strdup("");
3791 /* 2. auto complete according to args */
3792 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3795 free_cmdline_args(args, nb_args);
3798 static int monitor_can_read(void *opaque)
3800 Monitor *mon = opaque;
3802 return (mon->suspend_cnt == 0) ? 1 : 0;
3805 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3807 QObject *req, *rsp = NULL, *id = NULL;
3808 QDict *qdict = NULL;
3809 Monitor *mon = cur_mon;
3812 req = json_parser_parse_err(tokens, NULL, &err);
3814 /* json_parser_parse_err() sucks: can fail without setting @err */
3815 error_setg(&err, QERR_JSON_PARSING);
3821 qdict = qobject_to_qdict(req);
3823 id = qdict_get(qdict, "id");
3825 qdict_del(qdict, "id");
3826 } /* else will fail qmp_dispatch() */
3828 rsp = qmp_dispatch(cur_mon->qmp.commands, req);
3830 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
3831 qdict = qdict_get_qdict(qobject_to_qdict(rsp), "error");
3833 && !g_strcmp0(qdict_get_try_str(qdict, "class"),
3834 QapiErrorClass_lookup[ERROR_CLASS_COMMAND_NOT_FOUND])) {
3835 /* Provide a more useful error message */
3836 qdict_del(qdict, "desc");
3837 qdict_put(qdict, "desc",
3838 qstring_from_str("Expecting capabilities negotiation"
3839 " with 'qmp_capabilities'"));
3845 qdict = qdict_new();
3846 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3848 rsp = QOBJECT(qdict);
3853 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3857 monitor_json_emitter(mon, rsp);
3861 qobject_decref(rsp);
3862 qobject_decref(req);
3865 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3867 Monitor *old_mon = cur_mon;
3871 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3876 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3878 Monitor *old_mon = cur_mon;
3884 for (i = 0; i < size; i++)
3885 readline_handle_byte(cur_mon->rs, buf[i]);
3887 if (size == 0 || buf[size - 1] != 0)
3888 monitor_printf(cur_mon, "corrupted command\n");
3890 handle_hmp_command(cur_mon, (char *)buf);
3896 static void monitor_command_cb(void *opaque, const char *cmdline,
3897 void *readline_opaque)
3899 Monitor *mon = opaque;
3901 monitor_suspend(mon);
3902 handle_hmp_command(mon, cmdline);
3903 monitor_resume(mon);
3906 int monitor_suspend(Monitor *mon)
3914 void monitor_resume(Monitor *mon)
3918 if (--mon->suspend_cnt == 0)
3919 readline_show_prompt(mon->rs);
3922 static QObject *get_qmp_greeting(void)
3924 QObject *ver = NULL;
3926 qmp_marshal_query_version(NULL, &ver, NULL);
3928 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3932 static void monitor_qmp_event(void *opaque, int event)
3935 Monitor *mon = opaque;
3938 case CHR_EVENT_OPENED:
3939 mon->qmp.commands = &qmp_cap_negotiation_commands;
3940 data = get_qmp_greeting();
3941 monitor_json_emitter(mon, data);
3942 qobject_decref(data);
3945 case CHR_EVENT_CLOSED:
3946 json_message_parser_destroy(&mon->qmp.parser);
3947 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3949 monitor_fdsets_cleanup();
3954 static void monitor_event(void *opaque, int event)
3956 Monitor *mon = opaque;
3959 case CHR_EVENT_MUX_IN:
3960 qemu_mutex_lock(&mon->out_lock);
3962 qemu_mutex_unlock(&mon->out_lock);
3963 if (mon->reset_seen) {
3964 readline_restart(mon->rs);
3965 monitor_resume(mon);
3968 mon->suspend_cnt = 0;
3972 case CHR_EVENT_MUX_OUT:
3973 if (mon->reset_seen) {
3974 if (mon->suspend_cnt == 0) {
3975 monitor_printf(mon, "\n");
3978 monitor_suspend(mon);
3982 qemu_mutex_lock(&mon->out_lock);
3984 qemu_mutex_unlock(&mon->out_lock);
3987 case CHR_EVENT_OPENED:
3988 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3989 "information\n", QEMU_VERSION);
3990 if (!mon->mux_out) {
3991 readline_restart(mon->rs);
3992 readline_show_prompt(mon->rs);
3994 mon->reset_seen = 1;
3998 case CHR_EVENT_CLOSED:
4000 monitor_fdsets_cleanup();
4006 compare_mon_cmd(const void *a, const void *b)
4008 return strcmp(((const mon_cmd_t *)a)->name,
4009 ((const mon_cmd_t *)b)->name);
4012 static void sortcmdlist(void)
4015 int elem_size = sizeof(mon_cmd_t);
4017 array_num = sizeof(mon_cmds)/elem_size-1;
4018 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4020 array_num = sizeof(info_cmds)/elem_size-1;
4021 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4024 /* These functions just adapt the readline interface in a typesafe way. We
4025 * could cast function pointers but that discards compiler checks.
4027 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4028 const char *fmt, ...)
4032 monitor_vprintf(opaque, fmt, ap);
4036 static void monitor_readline_flush(void *opaque)
4038 monitor_flush(opaque);
4042 * Print to current monitor if we have one, else to stderr.
4043 * TODO should return int, so callers can calculate width, but that
4044 * requires surgery to monitor_vprintf(). Left for another day.
4046 void error_vprintf(const char *fmt, va_list ap)
4048 if (cur_mon && !monitor_cur_is_qmp()) {
4049 monitor_vprintf(cur_mon, fmt, ap);
4051 vfprintf(stderr, fmt, ap);
4055 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4057 if (cur_mon && !monitor_cur_is_qmp()) {
4058 monitor_vprintf(cur_mon, fmt, ap);
4059 } else if (!cur_mon) {
4060 vfprintf(stderr, fmt, ap);
4064 static void __attribute__((constructor)) monitor_lock_init(void)
4066 qemu_mutex_init(&monitor_lock);
4069 void monitor_init(Chardev *chr, int flags)
4071 static int is_first_init = 1;
4074 if (is_first_init) {
4075 monitor_qapi_event_init();
4080 mon = g_malloc(sizeof(*mon));
4081 monitor_data_init(mon);
4083 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4085 if (flags & MONITOR_USE_READLINE) {
4086 mon->rs = readline_init(monitor_readline_printf,
4087 monitor_readline_flush,
4089 monitor_find_completion);
4090 monitor_read_command(mon, 0);
4093 if (monitor_is_qmp(mon)) {
4094 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4095 monitor_qmp_event, mon, NULL, true);
4096 qemu_chr_fe_set_echo(&mon->chr, true);
4097 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4099 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4100 monitor_event, mon, NULL, true);
4103 qemu_mutex_lock(&monitor_lock);
4104 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4105 qemu_mutex_unlock(&monitor_lock);
4108 void monitor_cleanup(void)
4110 Monitor *mon, *next;
4112 qemu_mutex_lock(&monitor_lock);
4113 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4114 QLIST_REMOVE(mon, entry);
4115 monitor_data_destroy(mon);
4118 qemu_mutex_unlock(&monitor_lock);
4121 static void bdrv_password_cb(void *opaque, const char *password,
4122 void *readline_opaque)
4124 Monitor *mon = opaque;
4125 BlockDriverState *bs = readline_opaque;
4127 Error *local_err = NULL;
4129 bdrv_add_key(bs, password, &local_err);
4131 error_report_err(local_err);
4134 if (mon->password_completion_cb)
4135 mon->password_completion_cb(mon->password_opaque, ret);
4137 monitor_read_command(mon, 1);
4140 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
4141 BlockCompletionFunc *completion_cb,
4146 monitor_printf(mon, "%s (%s) is encrypted.\n", bdrv_get_device_name(bs),
4147 bdrv_get_encrypted_filename(bs));
4149 mon->password_completion_cb = completion_cb;
4150 mon->password_opaque = opaque;
4152 err = monitor_read_password(mon, bdrv_password_cb, bs);
4154 if (err && completion_cb)
4155 completion_cb(opaque, err);
4160 int monitor_read_block_device_key(Monitor *mon, const char *device,
4161 BlockCompletionFunc *completion_cb,
4167 blk = blk_by_name(device);
4169 monitor_printf(mon, "Device not found %s\n", device);
4173 monitor_printf(mon, "Device '%s' has no medium\n", device);
4177 bdrv_add_key(blk_bs(blk), NULL, &err);
4180 return monitor_read_bdrv_key_start(mon, blk_bs(blk), completion_cb, opaque);
4183 if (completion_cb) {
4184 completion_cb(opaque, 0);
4189 QemuOptsList qemu_mon_opts = {
4191 .implied_opt_name = "chardev",
4192 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4196 .type = QEMU_OPT_STRING,
4199 .type = QEMU_OPT_STRING,
4201 .name = "default", /* deprecated */
4202 .type = QEMU_OPT_BOOL,
4205 .type = QEMU_OPT_BOOL,
4207 { /* end of list */ }
4212 void qmp_rtc_reset_reinjection(Error **errp)
4214 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4218 #ifndef TARGET_S390X
4219 void qmp_dump_skeys(const char *filename, Error **errp)
4221 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4226 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4228 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4233 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4235 MachineState *ms = MACHINE(qdev_get_machine());
4236 MachineClass *mc = MACHINE_GET_CLASS(ms);
4238 if (!mc->has_hotpluggable_cpus) {
4239 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4243 return machine_query_hotpluggable_cpus(ms);