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/readline.h"
44 #include "ui/console.h"
46 #include "sysemu/blockdev.h"
47 #include "sysemu/block-backend.h"
48 #include "audio/audio.h"
49 #include "disas/disas.h"
50 #include "sysemu/balloon.h"
51 #include "qemu/timer.h"
52 #include "migration/migration.h"
53 #include "sysemu/kvm.h"
55 #include "sysemu/tpm.h"
56 #include "qapi/qmp/qerror.h"
57 #include "qapi/qmp/types.h"
58 #include "qapi/qmp/qjson.h"
59 #include "qapi/qmp/json-streamer.h"
60 #include "qapi/qmp/json-parser.h"
61 #include "qom/object_interfaces.h"
63 #include "trace/control.h"
64 #include "monitor/hmp-target.h"
65 #ifdef CONFIG_TRACE_SIMPLE
66 #include "trace/simple.h"
68 #include "exec/memory.h"
69 #include "exec/exec-all.h"
71 #include "qmp-commands.h"
73 #include "qemu/thread.h"
74 #include "block/qapi.h"
75 #include "qapi/qmp-event.h"
76 #include "qapi-event.h"
77 #include "qmp-introspect.h"
78 #include "sysemu/qtest.h"
79 #include "qemu/cutils.h"
80 #include "qapi/qmp/dispatch.h"
82 #if defined(TARGET_S390X)
83 #include "hw/s390x/storage-keys.h"
90 * 'B' block device name
91 * 's' string (accept optional quote)
92 * 'S' it just appends the rest of the string (accept optional quote)
93 * 'O' option string of the form NAME=VALUE,...
94 * parsed according to QemuOptsList given by its name
95 * Example: 'device:O' uses qemu_device_opts.
96 * Restriction: only lists with empty desc are supported
97 * TODO lift the restriction
99 * 'l' target long (32 or 64 bit)
100 * 'M' Non-negative target long (32 or 64 bit), in user mode the
101 * value is multiplied by 2^20 (think Mebibyte)
102 * 'o' octets (aka bytes)
103 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
104 * K, k suffix, which multiplies the value by 2^60 for suffixes E
105 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
106 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
108 * user mode accepts an optional ms, us, ns suffix,
109 * which divides the value by 1e3, 1e6, 1e9, respectively
110 * '/' optional gdb-like print format (like "/10x")
112 * '?' optional type (for all types, except '/')
113 * '.' other form of optional type (for 'i' and 'l')
115 * user mode accepts "on" or "off"
116 * '-' optional parameter (eg. '-f')
120 typedef struct mon_cmd_t {
122 const char *args_type;
125 void (*cmd)(Monitor *mon, const QDict *qdict);
126 /* @sub_table is a list of 2nd level of commands. If it does not exist,
127 * cmd should be used. If it exists, sub_table[?].cmd should be
128 * used, and cmd of 1st level plays the role of help function.
130 struct mon_cmd_t *sub_table;
131 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
134 /* file descriptors passed via SCM_RIGHTS */
135 typedef struct mon_fd_t mon_fd_t;
139 QLIST_ENTRY(mon_fd_t) next;
142 /* file descriptor associated with a file descriptor set */
143 typedef struct MonFdsetFd MonFdsetFd;
148 QLIST_ENTRY(MonFdsetFd) next;
151 /* file descriptor set containing fds passed via SCM_RIGHTS */
152 typedef struct MonFdset MonFdset;
155 QLIST_HEAD(, MonFdsetFd) fds;
156 QLIST_HEAD(, MonFdsetFd) dup_fds;
157 QLIST_ENTRY(MonFdset) next;
161 JSONMessageParser parser;
163 * When a client connects, we're in capabilities negotiation mode.
164 * When command qmp_capabilities succeeds, we go into command
167 bool in_command_mode; /* are we in command mode? */
171 * To prevent flooding clients, events can be throttled. The
172 * throttling is calculated globally, rather than per-Monitor
175 typedef struct MonitorQAPIEventState {
176 QAPIEvent event; /* Throttling state for this event type and... */
177 QDict *data; /* ... data, see qapi_event_throttle_equal() */
178 QEMUTimer *timer; /* Timer for handling delayed events */
179 QDict *qdict; /* Delayed event (if any) */
180 } MonitorQAPIEventState;
183 int64_t rate; /* Minimum time (in ns) between two events */
184 } MonitorQAPIEventConf;
197 /* Read under either BQL or out_lock, written with BQL+out_lock. */
203 BlockCompletionFunc *password_completion_cb;
204 void *password_opaque;
205 mon_cmd_t *cmd_table;
206 QLIST_HEAD(,mon_fd_t) fds;
207 QLIST_ENTRY(Monitor) entry;
210 /* QMP checker flags */
211 #define QMP_ACCEPT_UNKNOWNS 1
213 /* Protects mon_list, monitor_event_state. */
214 static QemuMutex monitor_lock;
216 static QLIST_HEAD(mon_list, Monitor) mon_list;
217 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
218 static int mon_refcount;
220 static mon_cmd_t mon_cmds[];
221 static mon_cmd_t info_cmds[];
225 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
227 static void monitor_command_cb(void *opaque, const char *cmdline,
228 void *readline_opaque);
231 * Is @mon a QMP monitor?
233 static inline bool monitor_is_qmp(const Monitor *mon)
235 return (mon->flags & MONITOR_USE_CONTROL);
239 * Is the current monitor, if any, a QMP monitor?
241 bool monitor_cur_is_qmp(void)
243 return cur_mon && monitor_is_qmp(cur_mon);
246 void monitor_read_command(Monitor *mon, int show_prompt)
251 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
253 readline_show_prompt(mon->rs);
256 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
260 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
261 /* prompt is printed on return from the command handler */
264 monitor_printf(mon, "terminal does not support password prompting\n");
269 static void monitor_flush_locked(Monitor *mon);
271 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
274 Monitor *mon = opaque;
276 qemu_mutex_lock(&mon->out_lock);
278 monitor_flush_locked(mon);
279 qemu_mutex_unlock(&mon->out_lock);
283 /* Called with mon->out_lock held. */
284 static void monitor_flush_locked(Monitor *mon)
290 if (mon->skip_flush) {
294 buf = qstring_get_str(mon->outbuf);
295 len = qstring_get_length(mon->outbuf);
297 if (len && !mon->mux_out) {
298 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
299 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
300 /* all flushed or error */
301 QDECREF(mon->outbuf);
302 mon->outbuf = qstring_new();
307 QString *tmp = qstring_from_str(buf + rc);
308 QDECREF(mon->outbuf);
311 if (mon->out_watch == 0) {
313 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
314 monitor_unblocked, mon);
319 void monitor_flush(Monitor *mon)
321 qemu_mutex_lock(&mon->out_lock);
322 monitor_flush_locked(mon);
323 qemu_mutex_unlock(&mon->out_lock);
326 /* flush at every end of line */
327 static void monitor_puts(Monitor *mon, const char *str)
331 qemu_mutex_lock(&mon->out_lock);
337 qstring_append_chr(mon->outbuf, '\r');
339 qstring_append_chr(mon->outbuf, c);
341 monitor_flush_locked(mon);
344 qemu_mutex_unlock(&mon->out_lock);
347 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
354 if (monitor_is_qmp(mon)) {
358 buf = g_strdup_vprintf(fmt, ap);
359 monitor_puts(mon, buf);
363 void monitor_printf(Monitor *mon, const char *fmt, ...)
367 monitor_vprintf(mon, fmt, ap);
371 int monitor_fprintf(FILE *stream, const char *fmt, ...)
375 monitor_vprintf((Monitor *)stream, fmt, ap);
380 static void monitor_json_emitter(Monitor *mon, const QObject *data)
384 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
385 qobject_to_json(data);
386 assert(json != NULL);
388 qstring_append_chr(json, '\n');
389 monitor_puts(mon, qstring_get_str(json));
394 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
395 /* Limit guest-triggerable events to 1 per second */
396 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
397 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
398 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
399 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
400 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
401 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
404 GHashTable *monitor_qapi_event_state;
407 * Emits the event to every monitor instance, @event is only used for trace
408 * Called with monitor_lock held.
410 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
414 trace_monitor_protocol_event_emit(event, qdict);
415 QLIST_FOREACH(mon, &mon_list, entry) {
416 if (monitor_is_qmp(mon) && mon->qmp.in_command_mode) {
417 monitor_json_emitter(mon, QOBJECT(qdict));
422 static void monitor_qapi_event_handler(void *opaque);
425 * Queue a new event for emission to Monitor instances,
426 * applying any rate limiting if required.
429 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
431 MonitorQAPIEventConf *evconf;
432 MonitorQAPIEventState *evstate;
434 assert(event < QAPI_EVENT__MAX);
435 evconf = &monitor_qapi_event_conf[event];
436 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
438 qemu_mutex_lock(&monitor_lock);
441 /* Unthrottled event */
442 monitor_qapi_event_emit(event, qdict);
444 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
445 MonitorQAPIEventState key = { .event = event, .data = data };
447 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
448 assert(!evstate || timer_pending(evstate->timer));
452 * Timer is pending for (at least) evconf->rate ns after
453 * last send. Store event for sending when timer fires,
454 * replacing a prior stored event if any.
456 QDECREF(evstate->qdict);
457 evstate->qdict = qdict;
458 QINCREF(evstate->qdict);
461 * Last send was (at least) evconf->rate ns ago.
462 * Send immediately, and arm the timer to call
463 * monitor_qapi_event_handler() in evconf->rate ns. Any
464 * events arriving before then will be delayed until then.
466 int64_t now = qemu_clock_get_ns(event_clock_type);
468 monitor_qapi_event_emit(event, qdict);
470 evstate = g_new(MonitorQAPIEventState, 1);
471 evstate->event = event;
472 evstate->data = data;
473 QINCREF(evstate->data);
474 evstate->qdict = NULL;
475 evstate->timer = timer_new_ns(event_clock_type,
476 monitor_qapi_event_handler,
478 g_hash_table_add(monitor_qapi_event_state, evstate);
479 timer_mod_ns(evstate->timer, now + evconf->rate);
483 qemu_mutex_unlock(&monitor_lock);
487 * This function runs evconf->rate ns after sending a throttled
489 * If another event has since been stored, send it.
491 static void monitor_qapi_event_handler(void *opaque)
493 MonitorQAPIEventState *evstate = opaque;
494 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
496 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
497 qemu_mutex_lock(&monitor_lock);
499 if (evstate->qdict) {
500 int64_t now = qemu_clock_get_ns(event_clock_type);
502 monitor_qapi_event_emit(evstate->event, evstate->qdict);
503 QDECREF(evstate->qdict);
504 evstate->qdict = NULL;
505 timer_mod_ns(evstate->timer, now + evconf->rate);
507 g_hash_table_remove(monitor_qapi_event_state, evstate);
508 QDECREF(evstate->data);
509 timer_free(evstate->timer);
513 qemu_mutex_unlock(&monitor_lock);
516 static unsigned int qapi_event_throttle_hash(const void *key)
518 const MonitorQAPIEventState *evstate = key;
519 unsigned int hash = evstate->event * 255;
521 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
522 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
525 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
526 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
532 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
534 const MonitorQAPIEventState *eva = a;
535 const MonitorQAPIEventState *evb = b;
537 if (eva->event != evb->event) {
541 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
542 return !strcmp(qdict_get_str(eva->data, "id"),
543 qdict_get_str(evb->data, "id"));
546 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
547 return !strcmp(qdict_get_str(eva->data, "node-name"),
548 qdict_get_str(evb->data, "node-name"));
554 static void monitor_qapi_event_init(void)
556 if (qtest_enabled()) {
557 event_clock_type = QEMU_CLOCK_VIRTUAL;
560 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
561 qapi_event_throttle_equal);
562 qmp_event_set_func_emit(monitor_qapi_event_queue);
565 void qmp_qmp_capabilities(Error **errp)
567 cur_mon->qmp.in_command_mode = true;
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(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);
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("query-spice");
978 qmp_unregister_command("rtc-reset-reinjection");
981 qmp_unregister_command("dump-skeys");
984 qmp_unregister_command("query-gic-capabilities");
986 #if !defined(TARGET_S390X)
987 qmp_unregister_command("query-cpu-model-expansion");
988 qmp_unregister_command("query-cpu-model-baseline");
989 qmp_unregister_command("query-cpu-model-comparison");
991 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
992 && !defined(TARGET_S390X)
993 qmp_unregister_command("query-cpu-definitions");
997 static void qmp_init_marshal(void)
999 qmp_register_command("query-qmp-schema", qmp_query_qmp_schema,
1001 qmp_register_command("device_add", qmp_device_add,
1003 qmp_register_command("netdev_add", qmp_netdev_add,
1006 /* call it after the rest of qapi_init() */
1007 register_module_init(qmp_unregister_commands_hack, MODULE_INIT_QAPI);
1010 qapi_init(qmp_init_marshal);
1012 /* set the current CPU defined by the user */
1013 int monitor_set_cpu(int cpu_index)
1017 cpu = qemu_get_cpu(cpu_index);
1021 cur_mon->mon_cpu = cpu;
1025 CPUState *mon_get_cpu(void)
1027 if (!cur_mon->mon_cpu) {
1028 monitor_set_cpu(first_cpu->cpu_index);
1030 cpu_synchronize_state(cur_mon->mon_cpu);
1031 return cur_mon->mon_cpu;
1034 CPUArchState *mon_get_cpu_env(void)
1036 return mon_get_cpu()->env_ptr;
1039 int monitor_get_cpu_index(void)
1041 return mon_get_cpu()->cpu_index;
1044 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1046 cpu_dump_state(mon_get_cpu(), (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1049 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1051 dump_exec_info((FILE *)mon, monitor_fprintf);
1052 dump_drift_info((FILE *)mon, monitor_fprintf);
1055 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1057 dump_opcount_info((FILE *)mon, monitor_fprintf);
1060 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1069 str = readline_get_history(mon->rs, i);
1072 monitor_printf(mon, "%d: '%s'\n", i, str);
1077 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1079 cpu_dump_statistics(mon_get_cpu(), (FILE *)mon, &monitor_fprintf, 0);
1082 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1084 const char *name = qdict_get_try_str(qdict, "name");
1085 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1086 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1087 TraceEventInfoList *events;
1088 TraceEventInfoList *elem;
1089 Error *local_err = NULL;
1095 monitor_printf(mon, "argument vcpu must be positive");
1099 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1101 error_report_err(local_err);
1105 for (elem = events; elem != NULL; elem = elem->next) {
1106 monitor_printf(mon, "%s : state %u\n",
1108 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1110 qapi_free_TraceEventInfoList(events);
1113 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1114 bool has_port, int64_t port,
1115 bool has_tls_port, int64_t tls_port,
1116 bool has_cert_subject, const char *cert_subject,
1119 if (strcmp(protocol, "spice") == 0) {
1120 if (!qemu_using_spice(errp)) {
1124 if (!has_port && !has_tls_port) {
1125 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1129 if (qemu_spice_migrate_info(hostname,
1130 has_port ? port : -1,
1131 has_tls_port ? tls_port : -1,
1133 error_setg(errp, QERR_UNDEFINED_ERROR);
1139 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1142 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1146 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1148 error_report_err(err);
1152 static void hmp_log(Monitor *mon, const QDict *qdict)
1155 const char *items = qdict_get_str(qdict, "items");
1157 if (!strcmp(items, "none")) {
1160 mask = qemu_str_to_log_mask(items);
1162 help_cmd(mon, "log");
1169 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1171 const char *option = qdict_get_try_str(qdict, "option");
1172 if (!option || !strcmp(option, "on")) {
1174 } else if (!strcmp(option, "off")) {
1177 monitor_printf(mon, "unexpected option %s\n", option);
1181 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1183 const char *device = qdict_get_try_str(qdict, "device");
1185 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1186 if (gdbserver_start(device) < 0) {
1187 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1189 } else if (strcmp(device, "none") == 0) {
1190 monitor_printf(mon, "Disabled gdbserver\n");
1192 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1197 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1199 const char *action = qdict_get_str(qdict, "action");
1200 if (select_watchdog_action(action) == -1) {
1201 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1205 static void monitor_printc(Monitor *mon, int c)
1207 monitor_printf(mon, "'");
1210 monitor_printf(mon, "\\'");
1213 monitor_printf(mon, "\\\\");
1216 monitor_printf(mon, "\\n");
1219 monitor_printf(mon, "\\r");
1222 if (c >= 32 && c <= 126) {
1223 monitor_printf(mon, "%c", c);
1225 monitor_printf(mon, "\\x%02x", c);
1229 monitor_printf(mon, "'");
1232 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1233 hwaddr addr, int is_physical)
1235 int l, line_size, i, max_digits, len;
1239 if (format == 'i') {
1242 CPUArchState *env = mon_get_cpu_env();
1245 } else if (wsize == 4) {
1248 /* as default we use the current CS size */
1251 #ifdef TARGET_X86_64
1252 if ((env->efer & MSR_EFER_LMA) &&
1253 (env->segs[R_CS].flags & DESC_L_MASK))
1257 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1263 CPUArchState *env = mon_get_cpu_env();
1264 flags = msr_le << 16;
1265 flags |= env->bfd_mach;
1267 monitor_disas(mon, mon_get_cpu(), addr, count, is_physical, flags);
1271 len = wsize * count;
1280 max_digits = (wsize * 8 + 2) / 3;
1284 max_digits = (wsize * 8) / 4;
1288 max_digits = (wsize * 8 * 10 + 32) / 33;
1297 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1299 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1304 cpu_physical_memory_read(addr, buf, l);
1306 if (cpu_memory_rw_debug(mon_get_cpu(), addr, buf, l, 0) < 0) {
1307 monitor_printf(mon, " Cannot access memory\n");
1316 v = ldub_p(buf + i);
1319 v = lduw_p(buf + i);
1322 v = (uint32_t)ldl_p(buf + i);
1328 monitor_printf(mon, " ");
1331 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1334 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1337 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1340 monitor_printf(mon, "%*" PRId64, max_digits, v);
1343 monitor_printc(mon, v);
1348 monitor_printf(mon, "\n");
1354 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1356 int count = qdict_get_int(qdict, "count");
1357 int format = qdict_get_int(qdict, "format");
1358 int size = qdict_get_int(qdict, "size");
1359 target_long addr = qdict_get_int(qdict, "addr");
1361 memory_dump(mon, count, format, size, addr, 0);
1364 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1366 int count = qdict_get_int(qdict, "count");
1367 int format = qdict_get_int(qdict, "format");
1368 int size = qdict_get_int(qdict, "size");
1369 hwaddr addr = qdict_get_int(qdict, "addr");
1371 memory_dump(mon, count, format, size, addr, 1);
1374 static void do_print(Monitor *mon, const QDict *qdict)
1376 int format = qdict_get_int(qdict, "format");
1377 hwaddr val = qdict_get_int(qdict, "val");
1381 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1384 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1387 monitor_printf(mon, "%" HWADDR_PRIu, val);
1391 monitor_printf(mon, "%" HWADDR_PRId, val);
1394 monitor_printc(mon, val);
1397 monitor_printf(mon, "\n");
1400 static void hmp_sum(Monitor *mon, const QDict *qdict)
1404 uint32_t start = qdict_get_int(qdict, "start");
1405 uint32_t size = qdict_get_int(qdict, "size");
1408 for(addr = start; addr < (start + size); addr++) {
1409 uint8_t val = address_space_ldub(&address_space_memory, addr,
1410 MEMTXATTRS_UNSPECIFIED, NULL);
1411 /* BSD sum algorithm ('sum' Unix command) */
1412 sum = (sum >> 1) | (sum << 15);
1415 monitor_printf(mon, "%05d\n", sum);
1418 static int mouse_button_state;
1420 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1422 int dx, dy, dz, button;
1423 const char *dx_str = qdict_get_str(qdict, "dx_str");
1424 const char *dy_str = qdict_get_str(qdict, "dy_str");
1425 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1427 dx = strtol(dx_str, NULL, 0);
1428 dy = strtol(dy_str, NULL, 0);
1429 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1430 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1433 dz = strtol(dz_str, NULL, 0);
1435 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1436 qemu_input_queue_btn(NULL, button, true);
1437 qemu_input_event_sync();
1438 qemu_input_queue_btn(NULL, button, false);
1441 qemu_input_event_sync();
1444 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1446 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1447 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1448 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1449 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1451 int button_state = qdict_get_int(qdict, "button_state");
1453 if (mouse_button_state == button_state) {
1456 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1457 qemu_input_event_sync();
1458 mouse_button_state = button_state;
1461 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1463 int size = qdict_get_int(qdict, "size");
1464 int addr = qdict_get_int(qdict, "addr");
1465 int has_index = qdict_haskey(qdict, "index");
1470 int index = qdict_get_int(qdict, "index");
1471 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1479 val = cpu_inb(addr);
1483 val = cpu_inw(addr);
1487 val = cpu_inl(addr);
1491 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1492 suffix, addr, size * 2, val);
1495 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1497 int size = qdict_get_int(qdict, "size");
1498 int addr = qdict_get_int(qdict, "addr");
1499 int val = qdict_get_int(qdict, "val");
1501 addr &= IOPORTS_MASK;
1506 cpu_outb(addr, val);
1509 cpu_outw(addr, val);
1512 cpu_outl(addr, val);
1517 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1519 Error *local_err = NULL;
1520 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1522 qemu_boot_set(bootdevice, &local_err);
1524 error_report_err(local_err);
1526 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1530 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1532 mtree_info((fprintf_function)monitor_printf, mon);
1535 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1541 node_mem = g_new0(uint64_t, nb_numa_nodes);
1542 query_numa_node_mem(node_mem);
1543 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1544 for (i = 0; i < nb_numa_nodes; i++) {
1545 monitor_printf(mon, "node %d cpus:", i);
1547 if (cpu->numa_node == i) {
1548 monitor_printf(mon, " %d", cpu->cpu_index);
1551 monitor_printf(mon, "\n");
1552 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1558 #ifdef CONFIG_PROFILER
1563 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1565 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1566 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1567 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1568 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1573 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1575 monitor_printf(mon, "Internal profiler not compiled\n");
1579 /* Capture support */
1580 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1582 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1587 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1588 monitor_printf(mon, "[%d]: ", i);
1589 s->ops.info (s->opaque);
1593 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1596 int n = qdict_get_int(qdict, "n");
1599 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1601 s->ops.destroy (s->opaque);
1602 QLIST_REMOVE (s, entries);
1609 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1611 const char *path = qdict_get_str(qdict, "path");
1612 int has_freq = qdict_haskey(qdict, "freq");
1613 int freq = qdict_get_try_int(qdict, "freq", -1);
1614 int has_bits = qdict_haskey(qdict, "bits");
1615 int bits = qdict_get_try_int(qdict, "bits", -1);
1616 int has_channels = qdict_haskey(qdict, "nchannels");
1617 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1620 s = g_malloc0 (sizeof (*s));
1622 freq = has_freq ? freq : 44100;
1623 bits = has_bits ? bits : 16;
1624 nchannels = has_channels ? nchannels : 2;
1626 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1627 monitor_printf(mon, "Failed to add wave capture\n");
1631 QLIST_INSERT_HEAD (&capture_head, s, entries);
1634 static qemu_acl *find_acl(Monitor *mon, const char *name)
1636 qemu_acl *acl = qemu_acl_find(name);
1639 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1644 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1646 const char *aclname = qdict_get_str(qdict, "aclname");
1647 qemu_acl *acl = find_acl(mon, aclname);
1648 qemu_acl_entry *entry;
1652 monitor_printf(mon, "policy: %s\n",
1653 acl->defaultDeny ? "deny" : "allow");
1654 QTAILQ_FOREACH(entry, &acl->entries, next) {
1656 monitor_printf(mon, "%d: %s %s\n", i,
1657 entry->deny ? "deny" : "allow", entry->match);
1662 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1664 const char *aclname = qdict_get_str(qdict, "aclname");
1665 qemu_acl *acl = find_acl(mon, aclname);
1668 qemu_acl_reset(acl);
1669 monitor_printf(mon, "acl: removed all rules\n");
1673 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1675 const char *aclname = qdict_get_str(qdict, "aclname");
1676 const char *policy = qdict_get_str(qdict, "policy");
1677 qemu_acl *acl = find_acl(mon, aclname);
1680 if (strcmp(policy, "allow") == 0) {
1681 acl->defaultDeny = 0;
1682 monitor_printf(mon, "acl: policy set to 'allow'\n");
1683 } else if (strcmp(policy, "deny") == 0) {
1684 acl->defaultDeny = 1;
1685 monitor_printf(mon, "acl: policy set to 'deny'\n");
1687 monitor_printf(mon, "acl: unknown policy '%s', "
1688 "expected 'deny' or 'allow'\n", policy);
1693 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1695 const char *aclname = qdict_get_str(qdict, "aclname");
1696 const char *match = qdict_get_str(qdict, "match");
1697 const char *policy = qdict_get_str(qdict, "policy");
1698 int has_index = qdict_haskey(qdict, "index");
1699 int index = qdict_get_try_int(qdict, "index", -1);
1700 qemu_acl *acl = find_acl(mon, aclname);
1704 if (strcmp(policy, "allow") == 0) {
1706 } else if (strcmp(policy, "deny") == 0) {
1709 monitor_printf(mon, "acl: unknown policy '%s', "
1710 "expected 'deny' or 'allow'\n", policy);
1714 ret = qemu_acl_insert(acl, deny, match, index);
1716 ret = qemu_acl_append(acl, deny, match);
1718 monitor_printf(mon, "acl: unable to add acl entry\n");
1720 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1724 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1726 const char *aclname = qdict_get_str(qdict, "aclname");
1727 const char *match = qdict_get_str(qdict, "match");
1728 qemu_acl *acl = find_acl(mon, aclname);
1732 ret = qemu_acl_remove(acl, match);
1734 monitor_printf(mon, "acl: no matching acl entry\n");
1736 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1740 void qmp_getfd(const char *fdname, Error **errp)
1745 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1747 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1751 if (qemu_isdigit(fdname[0])) {
1753 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1754 "a name not starting with a digit");
1758 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1759 if (strcmp(monfd->name, fdname) != 0) {
1768 monfd = g_malloc0(sizeof(mon_fd_t));
1769 monfd->name = g_strdup(fdname);
1772 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1775 void qmp_closefd(const char *fdname, Error **errp)
1779 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1780 if (strcmp(monfd->name, fdname) != 0) {
1784 QLIST_REMOVE(monfd, next);
1786 g_free(monfd->name);
1791 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1794 static void hmp_loadvm(Monitor *mon, const QDict *qdict)
1796 int saved_vm_running = runstate_is_running();
1797 const char *name = qdict_get_str(qdict, "name");
1799 vm_stop(RUN_STATE_RESTORE_VM);
1801 if (load_vmstate(name) == 0 && saved_vm_running) {
1806 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1810 QLIST_FOREACH(monfd, &mon->fds, next) {
1813 if (strcmp(monfd->name, fdname) != 0) {
1819 /* caller takes ownership of fd */
1820 QLIST_REMOVE(monfd, next);
1821 g_free(monfd->name);
1827 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1831 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1833 MonFdsetFd *mon_fdset_fd;
1834 MonFdsetFd *mon_fdset_fd_next;
1836 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
1837 if ((mon_fdset_fd->removed ||
1838 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
1839 runstate_is_running()) {
1840 close(mon_fdset_fd->fd);
1841 g_free(mon_fdset_fd->opaque);
1842 QLIST_REMOVE(mon_fdset_fd, next);
1843 g_free(mon_fdset_fd);
1847 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
1848 QLIST_REMOVE(mon_fdset, next);
1853 static void monitor_fdsets_cleanup(void)
1855 MonFdset *mon_fdset;
1856 MonFdset *mon_fdset_next;
1858 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
1859 monitor_fdset_cleanup(mon_fdset);
1863 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
1864 const char *opaque, Error **errp)
1867 Monitor *mon = cur_mon;
1870 fd = qemu_chr_fe_get_msgfd(&mon->chr);
1872 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1876 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
1877 has_opaque, opaque, errp);
1889 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
1891 MonFdset *mon_fdset;
1892 MonFdsetFd *mon_fdset_fd;
1895 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1896 if (mon_fdset->id != fdset_id) {
1899 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
1901 if (mon_fdset_fd->fd != fd) {
1904 mon_fdset_fd->removed = true;
1907 mon_fdset_fd->removed = true;
1910 if (has_fd && !mon_fdset_fd) {
1913 monitor_fdset_cleanup(mon_fdset);
1919 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
1922 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
1924 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
1927 FdsetInfoList *qmp_query_fdsets(Error **errp)
1929 MonFdset *mon_fdset;
1930 MonFdsetFd *mon_fdset_fd;
1931 FdsetInfoList *fdset_list = NULL;
1933 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1934 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
1935 FdsetFdInfoList *fdsetfd_list = NULL;
1937 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
1938 fdset_info->value->fdset_id = mon_fdset->id;
1940 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
1941 FdsetFdInfoList *fdsetfd_info;
1943 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
1944 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
1945 fdsetfd_info->value->fd = mon_fdset_fd->fd;
1946 if (mon_fdset_fd->opaque) {
1947 fdsetfd_info->value->has_opaque = true;
1948 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
1950 fdsetfd_info->value->has_opaque = false;
1953 fdsetfd_info->next = fdsetfd_list;
1954 fdsetfd_list = fdsetfd_info;
1957 fdset_info->value->fds = fdsetfd_list;
1959 fdset_info->next = fdset_list;
1960 fdset_list = fdset_info;
1966 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
1967 bool has_opaque, const char *opaque,
1970 MonFdset *mon_fdset = NULL;
1971 MonFdsetFd *mon_fdset_fd;
1975 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1976 /* Break if match found or match impossible due to ordering by ID */
1977 if (fdset_id <= mon_fdset->id) {
1978 if (fdset_id < mon_fdset->id) {
1986 if (mon_fdset == NULL) {
1987 int64_t fdset_id_prev = -1;
1988 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
1992 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
1993 "a non-negative value");
1996 /* Use specified fdset ID */
1997 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1998 mon_fdset_cur = mon_fdset;
1999 if (fdset_id < mon_fdset_cur->id) {
2004 /* Use first available fdset ID */
2005 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2006 mon_fdset_cur = mon_fdset;
2007 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2008 fdset_id_prev = mon_fdset_cur->id;
2015 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2017 mon_fdset->id = fdset_id;
2019 mon_fdset->id = fdset_id_prev + 1;
2022 /* The fdset list is ordered by fdset ID */
2023 if (!mon_fdset_cur) {
2024 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2025 } else if (mon_fdset->id < mon_fdset_cur->id) {
2026 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2028 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2032 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2033 mon_fdset_fd->fd = fd;
2034 mon_fdset_fd->removed = false;
2036 mon_fdset_fd->opaque = g_strdup(opaque);
2038 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2040 fdinfo = g_malloc0(sizeof(*fdinfo));
2041 fdinfo->fdset_id = mon_fdset->id;
2042 fdinfo->fd = mon_fdset_fd->fd;
2047 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2050 MonFdset *mon_fdset;
2051 MonFdsetFd *mon_fdset_fd;
2054 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2055 if (mon_fdset->id != fdset_id) {
2058 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2059 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2060 if (mon_fd_flags == -1) {
2064 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2065 return mon_fdset_fd->fd;
2077 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2079 MonFdset *mon_fdset;
2080 MonFdsetFd *mon_fdset_fd_dup;
2082 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2083 if (mon_fdset->id != fdset_id) {
2086 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2087 if (mon_fdset_fd_dup->fd == dup_fd) {
2091 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2092 mon_fdset_fd_dup->fd = dup_fd;
2093 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2099 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2101 MonFdset *mon_fdset;
2102 MonFdsetFd *mon_fdset_fd_dup;
2104 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2105 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2106 if (mon_fdset_fd_dup->fd == dup_fd) {
2108 QLIST_REMOVE(mon_fdset_fd_dup, next);
2109 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2110 monitor_fdset_cleanup(mon_fdset);
2114 return mon_fdset->id;
2122 int monitor_fdset_dup_fd_find(int dup_fd)
2124 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2127 void monitor_fdset_dup_fd_remove(int dup_fd)
2129 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2132 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2135 Error *local_err = NULL;
2137 if (!qemu_isdigit(fdname[0]) && mon) {
2138 fd = monitor_get_fd(mon, fdname, &local_err);
2140 fd = qemu_parse_fd(fdname);
2142 error_setg(&local_err, "Invalid file descriptor number '%s'",
2147 error_propagate(errp, local_err);
2156 /* Please update hmp-commands.hx when adding or changing commands */
2157 static mon_cmd_t info_cmds[] = {
2158 #include "hmp-commands-info.h"
2162 /* mon_cmds and info_cmds would be sorted at runtime */
2163 static mon_cmd_t mon_cmds[] = {
2164 #include "hmp-commands.h"
2168 /*******************************************************************/
2170 static const char *pch;
2171 static sigjmp_buf expr_env;
2174 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2175 expr_error(Monitor *mon, const char *fmt, ...)
2179 monitor_vprintf(mon, fmt, ap);
2180 monitor_printf(mon, "\n");
2182 siglongjmp(expr_env, 1);
2185 /* return 0 if OK, -1 if not found */
2186 static int get_monitor_def(target_long *pval, const char *name)
2188 const MonitorDef *md = target_monitor_defs();
2197 for(; md->name != NULL; md++) {
2198 if (compare_cmd(name, md->name)) {
2199 if (md->get_value) {
2200 *pval = md->get_value(md, md->offset);
2202 CPUArchState *env = mon_get_cpu_env();
2203 ptr = (uint8_t *)env + md->offset;
2206 *pval = *(int32_t *)ptr;
2209 *pval = *(target_long *)ptr;
2220 ret = target_get_monitor_def(mon_get_cpu(), name, &tmp);
2222 *pval = (target_long) tmp;
2228 static void next(void)
2232 while (qemu_isspace(*pch))
2237 static int64_t expr_sum(Monitor *mon);
2239 static int64_t expr_unary(Monitor *mon)
2248 n = expr_unary(mon);
2252 n = -expr_unary(mon);
2256 n = ~expr_unary(mon);
2262 expr_error(mon, "')' expected");
2269 expr_error(mon, "character constant expected");
2273 expr_error(mon, "missing terminating \' character");
2283 while ((*pch >= 'a' && *pch <= 'z') ||
2284 (*pch >= 'A' && *pch <= 'Z') ||
2285 (*pch >= '0' && *pch <= '9') ||
2286 *pch == '_' || *pch == '.') {
2287 if ((q - buf) < sizeof(buf) - 1)
2291 while (qemu_isspace(*pch))
2294 ret = get_monitor_def(®, buf);
2296 expr_error(mon, "unknown register");
2301 expr_error(mon, "unexpected end of expression");
2306 n = strtoull(pch, &p, 0);
2307 if (errno == ERANGE) {
2308 expr_error(mon, "number too large");
2311 expr_error(mon, "invalid char '%c' in expression", *p);
2314 while (qemu_isspace(*pch))
2322 static int64_t expr_prod(Monitor *mon)
2327 val = expr_unary(mon);
2330 if (op != '*' && op != '/' && op != '%')
2333 val2 = expr_unary(mon);
2342 expr_error(mon, "division by zero");
2353 static int64_t expr_logic(Monitor *mon)
2358 val = expr_prod(mon);
2361 if (op != '&' && op != '|' && op != '^')
2364 val2 = expr_prod(mon);
2381 static int64_t expr_sum(Monitor *mon)
2386 val = expr_logic(mon);
2389 if (op != '+' && op != '-')
2392 val2 = expr_logic(mon);
2401 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2404 if (sigsetjmp(expr_env, 0)) {
2408 while (qemu_isspace(*pch))
2410 *pval = expr_sum(mon);
2415 static int get_double(Monitor *mon, double *pval, const char **pp)
2417 const char *p = *pp;
2421 d = strtod(p, &tailp);
2423 monitor_printf(mon, "Number expected\n");
2426 if (d != d || d - d != 0) {
2427 /* NaN or infinity */
2428 monitor_printf(mon, "Bad number\n");
2437 * Store the command-name in cmdname, and return a pointer to
2438 * the remaining of the command string.
2440 static const char *get_command_name(const char *cmdline,
2441 char *cmdname, size_t nlen)
2444 const char *p, *pstart;
2447 while (qemu_isspace(*p))
2452 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2457 memcpy(cmdname, pstart, len);
2458 cmdname[len] = '\0';
2463 * Read key of 'type' into 'key' and return the current
2466 static char *key_get_info(const char *type, char **key)
2474 p = strchr(type, ':');
2481 str = g_malloc(len + 1);
2482 memcpy(str, type, len);
2489 static int default_fmt_format = 'x';
2490 static int default_fmt_size = 4;
2492 static int is_valid_option(const char *c, const char *typestr)
2500 typestr = strstr(typestr, option);
2501 return (typestr != NULL);
2504 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2505 const char *cmdname)
2507 const mon_cmd_t *cmd;
2509 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2510 if (compare_cmd(cmdname, cmd->name)) {
2519 * Parse command name from @cmdp according to command table @table.
2520 * If blank, return NULL.
2521 * Else, if no valid command can be found, report to @mon, and return
2523 * Else, change @cmdp to point right behind the name, and return its
2524 * command table entry.
2525 * Do not assume the return value points into @table! It doesn't when
2526 * the command is found in a sub-command table.
2528 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2533 const mon_cmd_t *cmd;
2536 /* extract the command name */
2537 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2541 cmd = search_dispatch_table(table, cmdname);
2543 monitor_printf(mon, "unknown command: '%.*s'\n",
2544 (int)(p - *cmdp), *cmdp);
2548 /* filter out following useless space */
2549 while (qemu_isspace(*p)) {
2554 /* search sub command */
2555 if (cmd->sub_table != NULL && *p != '\0') {
2556 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2563 * Parse arguments for @cmd.
2564 * If it can't be parsed, report to @mon, and return NULL.
2565 * Else, insert command arguments into a QDict, and return it.
2566 * Note: On success, caller has to free the QDict structure.
2569 static QDict *monitor_parse_arguments(Monitor *mon,
2571 const mon_cmd_t *cmd)
2573 const char *typestr;
2576 const char *p = *endp;
2578 QDict *qdict = qdict_new();
2580 /* parse the parameters */
2581 typestr = cmd->args_type;
2583 typestr = key_get_info(typestr, &key);
2595 while (qemu_isspace(*p))
2597 if (*typestr == '?') {
2600 /* no optional string: NULL argument */
2604 ret = get_str(buf, sizeof(buf), &p);
2608 monitor_printf(mon, "%s: filename expected\n",
2612 monitor_printf(mon, "%s: block device name expected\n",
2616 monitor_printf(mon, "%s: string expected\n", cmd->name);
2621 qdict_put(qdict, key, qstring_from_str(buf));
2626 QemuOptsList *opts_list;
2629 opts_list = qemu_find_opts(key);
2630 if (!opts_list || opts_list->desc->name) {
2633 while (qemu_isspace(*p)) {
2638 if (get_str(buf, sizeof(buf), &p) < 0) {
2641 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2645 qemu_opts_to_qdict(opts, qdict);
2646 qemu_opts_del(opts);
2651 int count, format, size;
2653 while (qemu_isspace(*p))
2659 if (qemu_isdigit(*p)) {
2661 while (qemu_isdigit(*p)) {
2662 count = count * 10 + (*p - '0');
2700 if (*p != '\0' && !qemu_isspace(*p)) {
2701 monitor_printf(mon, "invalid char in format: '%c'\n",
2706 format = default_fmt_format;
2707 if (format != 'i') {
2708 /* for 'i', not specifying a size gives -1 as size */
2710 size = default_fmt_size;
2711 default_fmt_size = size;
2713 default_fmt_format = format;
2716 format = default_fmt_format;
2717 if (format != 'i') {
2718 size = default_fmt_size;
2723 qdict_put(qdict, "count", qint_from_int(count));
2724 qdict_put(qdict, "format", qint_from_int(format));
2725 qdict_put(qdict, "size", qint_from_int(size));
2734 while (qemu_isspace(*p))
2736 if (*typestr == '?' || *typestr == '.') {
2737 if (*typestr == '?') {
2745 while (qemu_isspace(*p))
2754 if (get_expr(mon, &val, &p))
2756 /* Check if 'i' is greater than 32-bit */
2757 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2758 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2759 monitor_printf(mon, "integer is for 32-bit values\n");
2761 } else if (c == 'M') {
2763 monitor_printf(mon, "enter a positive value\n");
2768 qdict_put(qdict, key, qint_from_int(val));
2776 while (qemu_isspace(*p)) {
2779 if (*typestr == '?') {
2785 val = qemu_strtosz(p, &end);
2787 monitor_printf(mon, "invalid size\n");
2790 qdict_put(qdict, key, qint_from_int(val));
2798 while (qemu_isspace(*p))
2800 if (*typestr == '?') {
2806 if (get_double(mon, &val, &p) < 0) {
2809 if (p[0] && p[1] == 's') {
2812 val /= 1e3; p += 2; break;
2814 val /= 1e6; p += 2; break;
2816 val /= 1e9; p += 2; break;
2819 if (*p && !qemu_isspace(*p)) {
2820 monitor_printf(mon, "Unknown unit suffix\n");
2823 qdict_put(qdict, key, qfloat_from_double(val));
2831 while (qemu_isspace(*p)) {
2835 while (qemu_isgraph(*p)) {
2838 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
2840 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
2843 monitor_printf(mon, "Expected 'on' or 'off'\n");
2846 qdict_put(qdict, key, qbool_from_bool(val));
2851 const char *tmp = p;
2858 while (qemu_isspace(*p))
2863 if(!is_valid_option(p, typestr)) {
2865 monitor_printf(mon, "%s: unsupported option -%c\n",
2877 qdict_put(qdict, key, qbool_from_bool(true));
2884 /* package all remaining string */
2887 while (qemu_isspace(*p)) {
2890 if (*typestr == '?') {
2893 /* no remaining string: NULL argument */
2899 monitor_printf(mon, "%s: string expected\n",
2903 qdict_put(qdict, key, qstring_from_str(p));
2909 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
2915 /* check that all arguments were parsed */
2916 while (qemu_isspace(*p))
2919 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
2932 static void handle_hmp_command(Monitor *mon, const char *cmdline)
2935 const mon_cmd_t *cmd;
2937 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
2942 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
2944 monitor_printf(mon, "Try \"help %s\" for more information\n",
2949 cmd->cmd(mon, qdict);
2953 static void cmd_completion(Monitor *mon, const char *name, const char *list)
2955 const char *p, *pstart;
2964 p = pstart + strlen(pstart);
2966 if (len > sizeof(cmd) - 2)
2967 len = sizeof(cmd) - 2;
2968 memcpy(cmd, pstart, len);
2970 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
2971 readline_add_completion(mon->rs, cmd);
2979 static void file_completion(Monitor *mon, const char *input)
2984 char file[1024], file_prefix[1024];
2988 p = strrchr(input, '/');
2991 pstrcpy(file_prefix, sizeof(file_prefix), input);
2992 pstrcpy(path, sizeof(path), ".");
2994 input_path_len = p - input + 1;
2995 memcpy(path, input, input_path_len);
2996 if (input_path_len > sizeof(path) - 1)
2997 input_path_len = sizeof(path) - 1;
2998 path[input_path_len] = '\0';
2999 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3002 ffs = opendir(path);
3011 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3015 if (strstart(d->d_name, file_prefix, NULL)) {
3016 memcpy(file, input, input_path_len);
3017 if (input_path_len < sizeof(file))
3018 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3020 /* stat the file to find out if it's a directory.
3021 * In that case add a slash to speed up typing long paths
3023 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3024 pstrcat(file, sizeof(file), "/");
3026 readline_add_completion(mon->rs, file);
3032 static const char *next_arg_type(const char *typestr)
3034 const char *p = strchr(typestr, ':');
3035 return (p != NULL ? ++p : typestr);
3038 static void add_completion_option(ReadLineState *rs, const char *str,
3041 if (!str || !option) {
3044 if (!strncmp(option, str, strlen(str))) {
3045 readline_add_completion(rs, option);
3049 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3052 ChardevBackendInfoList *list, *start;
3058 readline_set_completion_index(rs, len);
3060 start = list = qmp_query_chardev_backends(NULL);
3062 const char *chr_name = list->value->name;
3064 if (!strncmp(chr_name, str, len)) {
3065 readline_add_completion(rs, chr_name);
3069 qapi_free_ChardevBackendInfoList(start);
3072 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3081 readline_set_completion_index(rs, len);
3082 for (i = 0; NetClientDriver_lookup[i]; i++) {
3083 add_completion_option(rs, str, NetClientDriver_lookup[i]);
3087 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3097 readline_set_completion_index(rs, len);
3098 list = elt = object_class_get_list(TYPE_DEVICE, false);
3101 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3103 name = object_class_get_name(OBJECT_CLASS(dc));
3105 if (!dc->cannot_instantiate_with_device_add_yet
3106 && !strncmp(name, str, len)) {
3107 readline_add_completion(rs, name);
3114 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3124 readline_set_completion_index(rs, len);
3125 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3129 name = object_class_get_name(OBJECT_CLASS(elt->data));
3130 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3131 readline_add_completion(rs, name);
3138 static void peripheral_device_del_completion(ReadLineState *rs,
3139 const char *str, size_t len)
3141 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3142 GSList *list, *item;
3144 list = qdev_build_hotpluggable_device_list(peripheral);
3149 for (item = list; item; item = g_slist_next(item)) {
3150 DeviceState *dev = item->data;
3152 if (dev->id && !strncmp(str, dev->id, len)) {
3153 readline_add_completion(rs, dev->id);
3160 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3163 ChardevInfoList *list, *start;
3169 readline_set_completion_index(rs, len);
3171 start = list = qmp_query_chardev(NULL);
3173 ChardevInfo *chr = list->value;
3175 if (!strncmp(chr->label, str, len)) {
3176 readline_add_completion(rs, chr->label);
3180 qapi_free_ChardevInfoList(start);
3183 static void ringbuf_completion(ReadLineState *rs, const char *str)
3186 ChardevInfoList *list, *start;
3189 readline_set_completion_index(rs, len);
3191 start = list = qmp_query_chardev(NULL);
3193 ChardevInfo *chr_info = list->value;
3195 if (!strncmp(chr_info->label, str, len)) {
3196 CharDriverState *chr = qemu_chr_find(chr_info->label);
3197 if (chr && chr_is_ringbuf(chr)) {
3198 readline_add_completion(rs, chr_info->label);
3203 qapi_free_ChardevInfoList(start);
3206 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3211 ringbuf_completion(rs, str);
3214 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3223 readline_set_completion_index(rs, len);
3224 peripheral_device_del_completion(rs, str, len);
3227 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3229 ObjectPropertyInfoList *list, *start;
3236 readline_set_completion_index(rs, len);
3238 start = list = qmp_qom_list("/objects", NULL);
3240 ObjectPropertyInfo *info = list->value;
3242 if (!strncmp(info->type, "child<", 5)
3243 && !strncmp(info->name, str, len)) {
3244 readline_add_completion(rs, info->name);
3248 qapi_free_ObjectPropertyInfoList(start);
3251 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3260 sep = strrchr(str, '-');
3265 readline_set_completion_index(rs, len);
3266 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3267 if (!strncmp(str, QKeyCode_lookup[i], len)) {
3268 readline_add_completion(rs, QKeyCode_lookup[i]);
3273 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3278 readline_set_completion_index(rs, len);
3280 NetClientState *ncs[MAX_QUEUE_NUM];
3282 count = qemu_find_net_clients_except(NULL, ncs,
3283 NET_CLIENT_DRIVER_NONE,
3285 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3286 const char *name = ncs[i]->name;
3287 if (!strncmp(str, name, len)) {
3288 readline_add_completion(rs, name);
3291 } else if (nb_args == 3) {
3292 add_completion_option(rs, str, "on");
3293 add_completion_option(rs, str, "off");
3297 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3300 NetClientState *ncs[MAX_QUEUE_NUM];
3307 readline_set_completion_index(rs, len);
3308 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3310 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3312 const char *name = ncs[i]->name;
3313 if (strncmp(str, name, len)) {
3316 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3318 readline_add_completion(rs, name);
3323 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3328 readline_set_completion_index(rs, len);
3330 TraceEventIter iter;
3332 char *pattern = g_strdup_printf("%s*", str);
3333 trace_event_iter_init(&iter, pattern);
3334 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3335 readline_add_completion(rs, trace_event_get_name(ev));
3341 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3346 readline_set_completion_index(rs, len);
3348 TraceEventIter iter;
3350 char *pattern = g_strdup_printf("%s*", str);
3351 trace_event_iter_init(&iter, pattern);
3352 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3353 readline_add_completion(rs, trace_event_get_name(ev));
3356 } else if (nb_args == 3) {
3357 add_completion_option(rs, str, "on");
3358 add_completion_option(rs, str, "off");
3362 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3369 readline_set_completion_index(rs, strlen(str));
3370 for (i = 0; WatchdogExpirationAction_lookup[i]; i++) {
3371 add_completion_option(rs, str, WatchdogExpirationAction_lookup[i]);
3375 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3381 readline_set_completion_index(rs, len);
3384 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3385 const char *name = MigrationCapability_lookup[i];
3386 if (!strncmp(str, name, len)) {
3387 readline_add_completion(rs, name);
3390 } else if (nb_args == 3) {
3391 add_completion_option(rs, str, "on");
3392 add_completion_option(rs, str, "off");
3396 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3402 readline_set_completion_index(rs, len);
3405 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3406 const char *name = MigrationParameter_lookup[i];
3407 if (!strncmp(str, name, len)) {
3408 readline_add_completion(rs, name);
3414 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3422 readline_set_completion_index(rs, len);
3423 for (i = 0; host_net_devices[i]; i++) {
3424 if (!strncmp(host_net_devices[i], str, len)) {
3425 readline_add_completion(rs, host_net_devices[i]);
3430 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3432 NetClientState *ncs[MAX_QUEUE_NUM];
3436 readline_set_completion_index(rs, len);
3438 count = qemu_find_net_clients_except(NULL, ncs,
3439 NET_CLIENT_DRIVER_NONE,
3441 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3445 if (net_hub_id_for_client(ncs[i], &id)) {
3448 snprintf(name, sizeof(name), "%d", id);
3449 if (!strncmp(str, name, len)) {
3450 readline_add_completion(rs, name);
3454 } else if (nb_args == 3) {
3455 count = qemu_find_net_clients_except(NULL, ncs,
3456 NET_CLIENT_DRIVER_NIC,
3458 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3462 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3463 net_hub_id_for_client(ncs[i], &id)) {
3466 name = ncs[i]->name;
3467 if (!strncmp(str, name, len)) {
3468 readline_add_completion(rs, name);
3475 static void vm_completion(ReadLineState *rs, const char *str)
3478 BlockDriverState *bs;
3479 BdrvNextIterator it;
3482 readline_set_completion_index(rs, len);
3484 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3485 SnapshotInfoList *snapshots, *snapshot;
3486 AioContext *ctx = bdrv_get_aio_context(bs);
3489 aio_context_acquire(ctx);
3490 if (bdrv_can_snapshot(bs)) {
3491 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3493 aio_context_release(ctx);
3498 snapshot = snapshots;
3500 char *completion = snapshot->value->name;
3501 if (!strncmp(str, completion, len)) {
3502 readline_add_completion(rs, completion);
3504 completion = snapshot->value->id;
3505 if (!strncmp(str, completion, len)) {
3506 readline_add_completion(rs, completion);
3508 snapshot = snapshot->next;
3510 qapi_free_SnapshotInfoList(snapshots);
3515 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3518 vm_completion(rs, str);
3522 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3525 vm_completion(rs, str);
3529 static void monitor_find_completion_by_table(Monitor *mon,
3530 const mon_cmd_t *cmd_table,
3534 const char *cmdname;
3536 const char *ptype, *str, *name;
3537 const mon_cmd_t *cmd;
3538 BlockBackend *blk = NULL;
3541 /* command completion */
3546 readline_set_completion_index(mon->rs, strlen(cmdname));
3547 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3548 cmd_completion(mon, cmdname, cmd->name);
3551 /* find the command */
3552 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3553 if (compare_cmd(args[0], cmd->name)) {
3561 if (cmd->sub_table) {
3562 /* do the job again */
3563 monitor_find_completion_by_table(mon, cmd->sub_table,
3564 &args[1], nb_args - 1);
3567 if (cmd->command_completion) {
3568 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3572 ptype = next_arg_type(cmd->args_type);
3573 for(i = 0; i < nb_args - 2; i++) {
3574 if (*ptype != '\0') {
3575 ptype = next_arg_type(ptype);
3576 while (*ptype == '?')
3577 ptype = next_arg_type(ptype);
3580 str = args[nb_args - 1];
3581 while (*ptype == '-' && ptype[1] != '\0') {
3582 ptype = next_arg_type(ptype);
3586 /* file completion */
3587 readline_set_completion_index(mon->rs, strlen(str));
3588 file_completion(mon, str);
3591 /* block device name completion */
3592 readline_set_completion_index(mon->rs, strlen(str));
3593 while ((blk = blk_next(blk)) != NULL) {
3594 name = blk_name(blk);
3595 if (str[0] == '\0' ||
3596 !strncmp(name, str, strlen(str))) {
3597 readline_add_completion(mon->rs, name);
3603 if (!strcmp(cmd->name, "help|?")) {
3604 monitor_find_completion_by_table(mon, cmd_table,
3605 &args[1], nb_args - 1);
3614 static void monitor_find_completion(void *opaque,
3615 const char *cmdline)
3617 Monitor *mon = opaque;
3618 char *args[MAX_ARGS];
3621 /* 1. parse the cmdline */
3622 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3626 /* if the line ends with a space, it means we want to complete the
3628 len = strlen(cmdline);
3629 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3630 if (nb_args >= MAX_ARGS) {
3633 args[nb_args++] = g_strdup("");
3636 /* 2. auto complete according to args */
3637 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3640 free_cmdline_args(args, nb_args);
3643 static int monitor_can_read(void *opaque)
3645 Monitor *mon = opaque;
3647 return (mon->suspend_cnt == 0) ? 1 : 0;
3650 static bool invalid_qmp_mode(const Monitor *mon, const char *cmd,
3653 bool is_cap = g_str_equal(cmd, "qmp_capabilities");
3655 if (is_cap && mon->qmp.in_command_mode) {
3656 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
3657 "Capabilities negotiation is already complete, command "
3658 "'%s' ignored", cmd);
3661 if (!is_cap && !mon->qmp.in_command_mode) {
3662 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
3663 "Expecting capabilities negotiation with "
3664 "'qmp_capabilities' before command '%s'", cmd);
3671 * Input object checking rules
3673 * 1. Input object must be a dict
3674 * 2. The "execute" key must exist
3675 * 3. The "execute" key must be a string
3676 * 4. If the "arguments" key exists, it must be a dict
3677 * 5. If the "id" key exists, it can be anything (ie. json-value)
3678 * 6. Any argument not listed above is considered invalid
3680 static QDict *qmp_check_input_obj(QObject *input_obj, Error **errp)
3682 const QDictEntry *ent;
3683 int has_exec_key = 0;
3686 if (qobject_type(input_obj) != QTYPE_QDICT) {
3687 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT, "object");
3691 input_dict = qobject_to_qdict(input_obj);
3693 for (ent = qdict_first(input_dict); ent; ent = qdict_next(input_dict, ent)){
3694 const char *arg_name = qdict_entry_key(ent);
3695 const QObject *arg_obj = qdict_entry_value(ent);
3697 if (!strcmp(arg_name, "execute")) {
3698 if (qobject_type(arg_obj) != QTYPE_QSTRING) {
3699 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
3700 "execute", "string");
3704 } else if (!strcmp(arg_name, "arguments")) {
3705 if (qobject_type(arg_obj) != QTYPE_QDICT) {
3706 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
3707 "arguments", "object");
3710 } else if (!strcmp(arg_name, "id")) {
3711 /* Any string is acceptable as "id", so nothing to check */
3713 error_setg(errp, QERR_QMP_EXTRA_MEMBER, arg_name);
3718 if (!has_exec_key) {
3719 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT, "execute");
3726 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3728 QObject *req, *rsp = NULL, *id = NULL;
3729 QDict *qdict = NULL;
3730 const char *cmd_name;
3731 Monitor *mon = cur_mon;
3734 req = json_parser_parse_err(tokens, NULL, &err);
3735 if (err || !req || qobject_type(req) != QTYPE_QDICT) {
3737 error_setg(&err, QERR_JSON_PARSING);
3742 qdict = qmp_check_input_obj(req, &err);
3747 id = qdict_get(qdict, "id");
3749 qdict_del(qdict, "id");
3751 cmd_name = qdict_get_str(qdict, "execute");
3752 trace_handle_qmp_command(mon, cmd_name);
3754 if (invalid_qmp_mode(mon, cmd_name, &err)) {
3758 rsp = qmp_dispatch(req);
3762 qdict = qdict_new();
3763 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3765 rsp = QOBJECT(qdict);
3770 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3774 monitor_json_emitter(mon, rsp);
3778 qobject_decref(rsp);
3779 qobject_decref(req);
3782 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3784 Monitor *old_mon = cur_mon;
3788 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3793 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3795 Monitor *old_mon = cur_mon;
3801 for (i = 0; i < size; i++)
3802 readline_handle_byte(cur_mon->rs, buf[i]);
3804 if (size == 0 || buf[size - 1] != 0)
3805 monitor_printf(cur_mon, "corrupted command\n");
3807 handle_hmp_command(cur_mon, (char *)buf);
3813 static void monitor_command_cb(void *opaque, const char *cmdline,
3814 void *readline_opaque)
3816 Monitor *mon = opaque;
3818 monitor_suspend(mon);
3819 handle_hmp_command(mon, cmdline);
3820 monitor_resume(mon);
3823 int monitor_suspend(Monitor *mon)
3831 void monitor_resume(Monitor *mon)
3835 if (--mon->suspend_cnt == 0)
3836 readline_show_prompt(mon->rs);
3839 static QObject *get_qmp_greeting(void)
3841 QObject *ver = NULL;
3843 qmp_marshal_query_version(NULL, &ver, NULL);
3845 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3849 static void monitor_qmp_event(void *opaque, int event)
3852 Monitor *mon = opaque;
3855 case CHR_EVENT_OPENED:
3856 mon->qmp.in_command_mode = false;
3857 data = get_qmp_greeting();
3858 monitor_json_emitter(mon, data);
3859 qobject_decref(data);
3862 case CHR_EVENT_CLOSED:
3863 json_message_parser_destroy(&mon->qmp.parser);
3864 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3866 monitor_fdsets_cleanup();
3871 static void monitor_event(void *opaque, int event)
3873 Monitor *mon = opaque;
3876 case CHR_EVENT_MUX_IN:
3877 qemu_mutex_lock(&mon->out_lock);
3879 qemu_mutex_unlock(&mon->out_lock);
3880 if (mon->reset_seen) {
3881 readline_restart(mon->rs);
3882 monitor_resume(mon);
3885 mon->suspend_cnt = 0;
3889 case CHR_EVENT_MUX_OUT:
3890 if (mon->reset_seen) {
3891 if (mon->suspend_cnt == 0) {
3892 monitor_printf(mon, "\n");
3895 monitor_suspend(mon);
3899 qemu_mutex_lock(&mon->out_lock);
3901 qemu_mutex_unlock(&mon->out_lock);
3904 case CHR_EVENT_OPENED:
3905 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3906 "information\n", QEMU_VERSION);
3907 if (!mon->mux_out) {
3908 readline_restart(mon->rs);
3909 readline_show_prompt(mon->rs);
3911 mon->reset_seen = 1;
3915 case CHR_EVENT_CLOSED:
3917 monitor_fdsets_cleanup();
3923 compare_mon_cmd(const void *a, const void *b)
3925 return strcmp(((const mon_cmd_t *)a)->name,
3926 ((const mon_cmd_t *)b)->name);
3929 static void sortcmdlist(void)
3932 int elem_size = sizeof(mon_cmd_t);
3934 array_num = sizeof(mon_cmds)/elem_size-1;
3935 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
3937 array_num = sizeof(info_cmds)/elem_size-1;
3938 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
3941 /* These functions just adapt the readline interface in a typesafe way. We
3942 * could cast function pointers but that discards compiler checks.
3944 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
3945 const char *fmt, ...)
3949 monitor_vprintf(opaque, fmt, ap);
3953 static void monitor_readline_flush(void *opaque)
3955 monitor_flush(opaque);
3959 static QLIST_HEAD(, ErrorReporter) error_reporters =
3960 QLIST_HEAD_INITIALIZER(error_reporters);
3962 void add_error_reporter(ErrorReporter *new_reporter)
3964 QLIST_INSERT_HEAD(&error_reporters, new_reporter, node);
3967 static void report_to_clients(const char *fmt, va_list ap)
3969 ErrorReporter *reporter;
3970 QLIST_FOREACH(reporter, &error_reporters, node) {
3971 if (reporter->report) {
3972 (*(reporter->report))(fmt, ap);
3979 * Print to current monitor if we have one, else to stderr.
3980 * TODO should return int, so callers can calculate width, but that
3981 * requires surgery to monitor_vprintf(). Left for another day.
3983 void error_vprintf(const char *fmt, va_list ap)
3985 if (cur_mon && !monitor_cur_is_qmp()) {
3986 monitor_vprintf(cur_mon, fmt, ap);
3990 va_copy(ap_copy, ap);
3991 vfprintf(stderr, fmt, ap_copy);
3993 report_to_clients(fmt, ap);
3995 vfprintf(stderr, fmt, ap);
4000 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4002 if (cur_mon && !monitor_cur_is_qmp()) {
4003 monitor_vprintf(cur_mon, fmt, ap);
4007 static void __attribute__((constructor)) monitor_lock_init(void)
4009 qemu_mutex_init(&monitor_lock);
4012 void monitor_init(CharDriverState *chr, int flags)
4014 static int is_first_init = 1;
4017 if (is_first_init) {
4018 monitor_qapi_event_init();
4023 mon = g_malloc(sizeof(*mon));
4024 monitor_data_init(mon);
4026 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4028 if (flags & MONITOR_USE_READLINE) {
4029 mon->rs = readline_init(monitor_readline_printf,
4030 monitor_readline_flush,
4032 monitor_find_completion);
4033 monitor_read_command(mon, 0);
4036 if (monitor_is_qmp(mon)) {
4037 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4038 monitor_qmp_event, mon, NULL, true);
4039 qemu_chr_fe_set_echo(&mon->chr, true);
4040 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4042 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4043 monitor_event, mon, NULL, true);
4046 qemu_mutex_lock(&monitor_lock);
4047 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4048 qemu_mutex_unlock(&monitor_lock);
4051 void monitor_cleanup(void)
4053 Monitor *mon, *next;
4055 qemu_mutex_lock(&monitor_lock);
4056 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4057 QLIST_REMOVE(mon, entry);
4058 monitor_data_destroy(mon);
4061 qemu_mutex_unlock(&monitor_lock);
4064 static void bdrv_password_cb(void *opaque, const char *password,
4065 void *readline_opaque)
4067 Monitor *mon = opaque;
4068 BlockDriverState *bs = readline_opaque;
4070 Error *local_err = NULL;
4072 bdrv_add_key(bs, password, &local_err);
4074 error_report_err(local_err);
4077 if (mon->password_completion_cb)
4078 mon->password_completion_cb(mon->password_opaque, ret);
4080 monitor_read_command(mon, 1);
4083 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
4084 BlockCompletionFunc *completion_cb,
4089 monitor_printf(mon, "%s (%s) is encrypted.\n", bdrv_get_device_name(bs),
4090 bdrv_get_encrypted_filename(bs));
4092 mon->password_completion_cb = completion_cb;
4093 mon->password_opaque = opaque;
4095 err = monitor_read_password(mon, bdrv_password_cb, bs);
4097 if (err && completion_cb)
4098 completion_cb(opaque, err);
4103 int monitor_read_block_device_key(Monitor *mon, const char *device,
4104 BlockCompletionFunc *completion_cb,
4110 blk = blk_by_name(device);
4112 monitor_printf(mon, "Device not found %s\n", device);
4116 monitor_printf(mon, "Device '%s' has no medium\n", device);
4120 bdrv_add_key(blk_bs(blk), NULL, &err);
4123 return monitor_read_bdrv_key_start(mon, blk_bs(blk), completion_cb, opaque);
4126 if (completion_cb) {
4127 completion_cb(opaque, 0);
4132 QemuOptsList qemu_mon_opts = {
4134 .implied_opt_name = "chardev",
4135 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4139 .type = QEMU_OPT_STRING,
4142 .type = QEMU_OPT_STRING,
4144 .name = "default", /* deprecated */
4145 .type = QEMU_OPT_BOOL,
4148 .type = QEMU_OPT_BOOL,
4150 { /* end of list */ }
4155 void qmp_rtc_reset_reinjection(Error **errp)
4157 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4161 #ifndef TARGET_S390X
4162 void qmp_dump_skeys(const char *filename, Error **errp)
4164 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4169 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4171 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4176 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4178 MachineState *ms = MACHINE(qdev_get_machine());
4179 MachineClass *mc = MACHINE_GET_CLASS(ms);
4181 if (!mc->query_hotpluggable_cpus) {
4182 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4186 return mc->query_hotpluggable_cpus(ms);