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"
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 "qemu/cutils.h"
81 #include "qapi/qmp/dispatch.h"
83 #if defined(TARGET_S390X)
84 #include "hw/s390x/storage-keys.h"
91 * 'B' block device name
92 * 's' string (accept optional quote)
93 * 'S' it just appends the rest of the string (accept optional quote)
94 * 'O' option string of the form NAME=VALUE,...
95 * parsed according to QemuOptsList given by its name
96 * Example: 'device:O' uses qemu_device_opts.
97 * Restriction: only lists with empty desc are supported
98 * TODO lift the restriction
100 * 'l' target long (32 or 64 bit)
101 * 'M' Non-negative target long (32 or 64 bit), in user mode the
102 * value is multiplied by 2^20 (think Mebibyte)
103 * 'o' octets (aka bytes)
104 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
105 * K, k suffix, which multiplies the value by 2^60 for suffixes E
106 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
107 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
109 * user mode accepts an optional ms, us, ns suffix,
110 * which divides the value by 1e3, 1e6, 1e9, respectively
111 * '/' optional gdb-like print format (like "/10x")
113 * '?' optional type (for all types, except '/')
114 * '.' other form of optional type (for 'i' and 'l')
116 * user mode accepts "on" or "off"
117 * '-' optional parameter (eg. '-f')
121 typedef struct mon_cmd_t {
123 const char *args_type;
126 void (*cmd)(Monitor *mon, const QDict *qdict);
127 /* @sub_table is a list of 2nd level of commands. If it does not exist,
128 * cmd should be used. If it exists, sub_table[?].cmd should be
129 * used, and cmd of 1st level plays the role of help function.
131 struct mon_cmd_t *sub_table;
132 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
135 /* file descriptors passed via SCM_RIGHTS */
136 typedef struct mon_fd_t mon_fd_t;
140 QLIST_ENTRY(mon_fd_t) next;
143 /* file descriptor associated with a file descriptor set */
144 typedef struct MonFdsetFd MonFdsetFd;
149 QLIST_ENTRY(MonFdsetFd) next;
152 /* file descriptor set containing fds passed via SCM_RIGHTS */
153 typedef struct MonFdset MonFdset;
156 QLIST_HEAD(, MonFdsetFd) fds;
157 QLIST_HEAD(, MonFdsetFd) dup_fds;
158 QLIST_ENTRY(MonFdset) next;
162 JSONMessageParser parser;
164 * When a client connects, we're in capabilities negotiation mode.
165 * When command qmp_capabilities succeeds, we go into command
168 bool in_command_mode; /* are we in command mode? */
172 * To prevent flooding clients, events can be throttled. The
173 * throttling is calculated globally, rather than per-Monitor
176 typedef struct MonitorQAPIEventState {
177 QAPIEvent event; /* Throttling state for this event type and... */
178 QDict *data; /* ... data, see qapi_event_throttle_equal() */
179 QEMUTimer *timer; /* Timer for handling delayed events */
180 QDict *qdict; /* Delayed event (if any) */
181 } MonitorQAPIEventState;
184 int64_t rate; /* Minimum time (in ns) between two events */
185 } MonitorQAPIEventConf;
198 /* Read under either BQL or out_lock, written with BQL+out_lock. */
204 BlockCompletionFunc *password_completion_cb;
205 void *password_opaque;
206 mon_cmd_t *cmd_table;
207 QLIST_HEAD(,mon_fd_t) fds;
208 QLIST_ENTRY(Monitor) entry;
211 /* QMP checker flags */
212 #define QMP_ACCEPT_UNKNOWNS 1
214 /* Protects mon_list, monitor_event_state. */
215 static QemuMutex monitor_lock;
217 static QLIST_HEAD(mon_list, Monitor) mon_list;
218 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
219 static int mon_refcount;
221 static mon_cmd_t mon_cmds[];
222 static mon_cmd_t info_cmds[];
226 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
228 static void monitor_command_cb(void *opaque, const char *cmdline,
229 void *readline_opaque);
232 * Is @mon a QMP monitor?
234 static inline bool monitor_is_qmp(const Monitor *mon)
236 return (mon->flags & MONITOR_USE_CONTROL);
240 * Is the current monitor, if any, a QMP monitor?
242 bool monitor_cur_is_qmp(void)
244 return cur_mon && monitor_is_qmp(cur_mon);
247 void monitor_read_command(Monitor *mon, int show_prompt)
252 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
254 readline_show_prompt(mon->rs);
257 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
261 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
262 /* prompt is printed on return from the command handler */
265 monitor_printf(mon, "terminal does not support password prompting\n");
270 static void monitor_flush_locked(Monitor *mon);
272 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
275 Monitor *mon = opaque;
277 qemu_mutex_lock(&mon->out_lock);
279 monitor_flush_locked(mon);
280 qemu_mutex_unlock(&mon->out_lock);
284 /* Called with mon->out_lock held. */
285 static void monitor_flush_locked(Monitor *mon)
291 if (mon->skip_flush) {
295 buf = qstring_get_str(mon->outbuf);
296 len = qstring_get_length(mon->outbuf);
298 if (len && !mon->mux_out) {
299 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
300 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
301 /* all flushed or error */
302 QDECREF(mon->outbuf);
303 mon->outbuf = qstring_new();
308 QString *tmp = qstring_from_str(buf + rc);
309 QDECREF(mon->outbuf);
312 if (mon->out_watch == 0) {
314 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
315 monitor_unblocked, mon);
320 void monitor_flush(Monitor *mon)
322 qemu_mutex_lock(&mon->out_lock);
323 monitor_flush_locked(mon);
324 qemu_mutex_unlock(&mon->out_lock);
327 /* flush at every end of line */
328 static void monitor_puts(Monitor *mon, const char *str)
332 qemu_mutex_lock(&mon->out_lock);
338 qstring_append_chr(mon->outbuf, '\r');
340 qstring_append_chr(mon->outbuf, c);
342 monitor_flush_locked(mon);
345 qemu_mutex_unlock(&mon->out_lock);
348 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
355 if (monitor_is_qmp(mon)) {
359 buf = g_strdup_vprintf(fmt, ap);
360 monitor_puts(mon, buf);
364 void monitor_printf(Monitor *mon, const char *fmt, ...)
368 monitor_vprintf(mon, fmt, ap);
372 int monitor_fprintf(FILE *stream, const char *fmt, ...)
376 monitor_vprintf((Monitor *)stream, fmt, ap);
381 static void monitor_json_emitter(Monitor *mon, const QObject *data)
385 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
386 qobject_to_json(data);
387 assert(json != NULL);
389 qstring_append_chr(json, '\n');
390 monitor_puts(mon, qstring_get_str(json));
395 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
396 /* Limit guest-triggerable events to 1 per second */
397 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
398 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
399 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
400 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
401 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
402 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
405 GHashTable *monitor_qapi_event_state;
408 * Emits the event to every monitor instance, @event is only used for trace
409 * Called with monitor_lock held.
411 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
415 trace_monitor_protocol_event_emit(event, qdict);
416 QLIST_FOREACH(mon, &mon_list, entry) {
417 if (monitor_is_qmp(mon) && mon->qmp.in_command_mode) {
418 monitor_json_emitter(mon, QOBJECT(qdict));
423 static void monitor_qapi_event_handler(void *opaque);
426 * Queue a new event for emission to Monitor instances,
427 * applying any rate limiting if required.
430 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
432 MonitorQAPIEventConf *evconf;
433 MonitorQAPIEventState *evstate;
435 assert(event < QAPI_EVENT__MAX);
436 evconf = &monitor_qapi_event_conf[event];
437 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
439 qemu_mutex_lock(&monitor_lock);
442 /* Unthrottled event */
443 monitor_qapi_event_emit(event, qdict);
445 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
446 MonitorQAPIEventState key = { .event = event, .data = data };
448 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
449 assert(!evstate || timer_pending(evstate->timer));
453 * Timer is pending for (at least) evconf->rate ns after
454 * last send. Store event for sending when timer fires,
455 * replacing a prior stored event if any.
457 QDECREF(evstate->qdict);
458 evstate->qdict = qdict;
459 QINCREF(evstate->qdict);
462 * Last send was (at least) evconf->rate ns ago.
463 * Send immediately, and arm the timer to call
464 * monitor_qapi_event_handler() in evconf->rate ns. Any
465 * events arriving before then will be delayed until then.
467 int64_t now = qemu_clock_get_ns(event_clock_type);
469 monitor_qapi_event_emit(event, qdict);
471 evstate = g_new(MonitorQAPIEventState, 1);
472 evstate->event = event;
473 evstate->data = data;
474 QINCREF(evstate->data);
475 evstate->qdict = NULL;
476 evstate->timer = timer_new_ns(event_clock_type,
477 monitor_qapi_event_handler,
479 g_hash_table_add(monitor_qapi_event_state, evstate);
480 timer_mod_ns(evstate->timer, now + evconf->rate);
484 qemu_mutex_unlock(&monitor_lock);
488 * This function runs evconf->rate ns after sending a throttled
490 * If another event has since been stored, send it.
492 static void monitor_qapi_event_handler(void *opaque)
494 MonitorQAPIEventState *evstate = opaque;
495 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
497 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
498 qemu_mutex_lock(&monitor_lock);
500 if (evstate->qdict) {
501 int64_t now = qemu_clock_get_ns(event_clock_type);
503 monitor_qapi_event_emit(evstate->event, evstate->qdict);
504 QDECREF(evstate->qdict);
505 evstate->qdict = NULL;
506 timer_mod_ns(evstate->timer, now + evconf->rate);
508 g_hash_table_remove(monitor_qapi_event_state, evstate);
509 QDECREF(evstate->data);
510 timer_free(evstate->timer);
514 qemu_mutex_unlock(&monitor_lock);
517 static unsigned int qapi_event_throttle_hash(const void *key)
519 const MonitorQAPIEventState *evstate = key;
520 unsigned int hash = evstate->event * 255;
522 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
523 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
526 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
527 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
533 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
535 const MonitorQAPIEventState *eva = a;
536 const MonitorQAPIEventState *evb = b;
538 if (eva->event != evb->event) {
542 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
543 return !strcmp(qdict_get_str(eva->data, "id"),
544 qdict_get_str(evb->data, "id"));
547 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
548 return !strcmp(qdict_get_str(eva->data, "node-name"),
549 qdict_get_str(evb->data, "node-name"));
555 static void monitor_qapi_event_init(void)
557 if (qtest_enabled()) {
558 event_clock_type = QEMU_CLOCK_VIRTUAL;
561 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
562 qapi_event_throttle_equal);
563 qmp_event_set_func_emit(monitor_qapi_event_queue);
566 void qmp_qmp_capabilities(Error **errp)
568 cur_mon->qmp.in_command_mode = true;
571 static void handle_hmp_command(Monitor *mon, const char *cmdline);
573 static void monitor_data_init(Monitor *mon)
575 memset(mon, 0, sizeof(Monitor));
576 qemu_mutex_init(&mon->out_lock);
577 mon->outbuf = qstring_new();
578 /* Use *mon_cmds by default. */
579 mon->cmd_table = mon_cmds;
582 static void monitor_data_destroy(Monitor *mon)
584 qemu_chr_fe_deinit(&mon->chr);
585 if (monitor_is_qmp(mon)) {
586 json_message_parser_destroy(&mon->qmp.parser);
589 QDECREF(mon->outbuf);
590 qemu_mutex_destroy(&mon->out_lock);
593 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
594 int64_t cpu_index, Error **errp)
597 Monitor *old_mon, hmp;
599 monitor_data_init(&hmp);
600 hmp.skip_flush = true;
606 int ret = monitor_set_cpu(cpu_index);
609 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
615 handle_hmp_command(&hmp, command_line);
618 qemu_mutex_lock(&hmp.out_lock);
619 if (qstring_get_length(hmp.outbuf) > 0) {
620 output = g_strdup(qstring_get_str(hmp.outbuf));
622 output = g_strdup("");
624 qemu_mutex_unlock(&hmp.out_lock);
627 monitor_data_destroy(&hmp);
631 static int compare_cmd(const char *name, const char *list)
633 const char *p, *pstart;
641 p = pstart + strlen(pstart);
642 if ((p - pstart) == len && !memcmp(pstart, name, len))
651 static int get_str(char *buf, int buf_size, const char **pp)
659 while (qemu_isspace(*p)) {
670 while (*p != '\0' && *p != '\"') {
686 printf("unsupported escape code: '\\%c'\n", c);
689 if ((q - buf) < buf_size - 1) {
693 if ((q - buf) < buf_size - 1) {
700 printf("unterminated string\n");
705 while (*p != '\0' && !qemu_isspace(*p)) {
706 if ((q - buf) < buf_size - 1) {
719 static void free_cmdline_args(char **args, int nb_args)
723 assert(nb_args <= MAX_ARGS);
725 for (i = 0; i < nb_args; i++) {
732 * Parse the command line to get valid args.
733 * @cmdline: command line to be parsed.
734 * @pnb_args: location to store the number of args, must NOT be NULL.
735 * @args: location to store the args, which should be freed by caller, must
738 * Returns 0 on success, negative on failure.
740 * NOTE: this parser is an approximate form of the real command parser. Number
741 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
742 * return with failure.
744 static int parse_cmdline(const char *cmdline,
745 int *pnb_args, char **args)
754 while (qemu_isspace(*p)) {
760 if (nb_args >= MAX_ARGS) {
763 ret = get_str(buf, sizeof(buf), &p);
767 args[nb_args] = g_strdup(buf);
774 free_cmdline_args(args, nb_args);
778 static void help_cmd_dump_one(Monitor *mon,
779 const mon_cmd_t *cmd,
785 for (i = 0; i < prefix_args_nb; i++) {
786 monitor_printf(mon, "%s ", prefix_args[i]);
788 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
791 /* @args[@arg_index] is the valid command need to find in @cmds */
792 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
793 char **args, int nb_args, int arg_index)
795 const mon_cmd_t *cmd;
797 /* No valid arg need to compare with, dump all in *cmds */
798 if (arg_index >= nb_args) {
799 for (cmd = cmds; cmd->name != NULL; cmd++) {
800 help_cmd_dump_one(mon, cmd, args, arg_index);
805 /* Find one entry to dump */
806 for (cmd = cmds; cmd->name != NULL; cmd++) {
807 if (compare_cmd(args[arg_index], cmd->name)) {
808 if (cmd->sub_table) {
809 /* continue with next arg */
810 help_cmd_dump(mon, cmd->sub_table,
811 args, nb_args, arg_index + 1);
813 help_cmd_dump_one(mon, cmd, args, arg_index);
820 static void help_cmd(Monitor *mon, const char *name)
822 char *args[MAX_ARGS];
825 /* 1. parse user input */
827 /* special case for log, directly dump and return */
828 if (!strcmp(name, "log")) {
829 const QEMULogItem *item;
830 monitor_printf(mon, "Log items (comma separated):\n");
831 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
832 for (item = qemu_log_items; item->mask != 0; item++) {
833 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
838 if (parse_cmdline(name, &nb_args, args) < 0) {
843 /* 2. dump the contents according to parsed args */
844 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
846 free_cmdline_args(args, nb_args);
849 static void do_help_cmd(Monitor *mon, const QDict *qdict)
851 help_cmd(mon, qdict_get_try_str(qdict, "name"));
854 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
856 const char *tp_name = qdict_get_str(qdict, "name");
857 bool new_state = qdict_get_bool(qdict, "option");
858 bool has_vcpu = qdict_haskey(qdict, "vcpu");
859 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
860 Error *local_err = NULL;
863 monitor_printf(mon, "argument vcpu must be positive");
867 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
869 error_report_err(local_err);
873 #ifdef CONFIG_TRACE_SIMPLE
874 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
876 const char *op = qdict_get_try_str(qdict, "op");
877 const char *arg = qdict_get_try_str(qdict, "arg");
880 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
881 } else if (!strcmp(op, "on")) {
882 st_set_trace_file_enabled(true);
883 } else if (!strcmp(op, "off")) {
884 st_set_trace_file_enabled(false);
885 } else if (!strcmp(op, "flush")) {
886 st_flush_trace_buffer();
887 } else if (!strcmp(op, "set")) {
889 st_set_trace_file(arg);
892 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
893 help_cmd(mon, "trace-file");
898 static void hmp_info_help(Monitor *mon, const QDict *qdict)
900 help_cmd(mon, "info");
903 static void query_commands_cb(QmpCommand *cmd, void *opaque)
905 CommandInfoList *info, **list = opaque;
911 info = g_malloc0(sizeof(*info));
912 info->value = g_malloc0(sizeof(*info->value));
913 info->value->name = g_strdup(cmd->name);
918 CommandInfoList *qmp_query_commands(Error **errp)
920 CommandInfoList *list = NULL;
922 qmp_for_each_command(query_commands_cb, &list);
927 EventInfoList *qmp_query_events(Error **errp)
929 EventInfoList *info, *ev_list = NULL;
932 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
933 const char *event_name = QAPIEvent_lookup[e];
934 assert(event_name != NULL);
935 info = g_malloc0(sizeof(*info));
936 info->value = g_malloc0(sizeof(*info->value));
937 info->value->name = g_strdup(event_name);
939 info->next = ev_list;
947 * Minor hack: generated marshalling suppressed for this command
948 * ('gen': false in the schema) so we can parse the JSON string
949 * directly into QObject instead of first parsing it with
950 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
951 * to QObject with generated output marshallers, every time. Instead,
952 * we do it in test-qobject-input-visitor.c, just to make sure
953 * qapi-introspect.py's output actually conforms to the schema.
955 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
958 *ret_data = qobject_from_json(qmp_schema_json);
962 * We used to define commands in qmp-commands.hx in addition to the
963 * QAPI schema. This permitted defining some of them only in certain
964 * configurations. query-commands has always reflected that (good,
965 * because it lets QMP clients figure out what's actually available),
966 * while query-qmp-schema never did (not so good). This function is a
967 * hack to keep the configuration-specific commands defined exactly as
968 * before, even though qmp-commands.hx is gone.
970 * FIXME Educate the QAPI schema on configuration-specific commands,
971 * and drop this hack.
973 static void qmp_unregister_commands_hack(void)
976 qmp_unregister_command("query-spice");
979 qmp_unregister_command("rtc-reset-reinjection");
982 qmp_unregister_command("dump-skeys");
985 qmp_unregister_command("query-gic-capabilities");
987 #if !defined(TARGET_S390X)
988 qmp_unregister_command("query-cpu-model-expansion");
989 qmp_unregister_command("query-cpu-model-baseline");
990 qmp_unregister_command("query-cpu-model-comparison");
992 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
993 && !defined(TARGET_S390X)
994 qmp_unregister_command("query-cpu-definitions");
998 static void qmp_init_marshal(void)
1000 qmp_register_command("query-qmp-schema", qmp_query_qmp_schema,
1002 qmp_register_command("device_add", qmp_device_add,
1004 qmp_register_command("netdev_add", qmp_netdev_add,
1007 /* call it after the rest of qapi_init() */
1008 register_module_init(qmp_unregister_commands_hack, MODULE_INIT_QAPI);
1011 qapi_init(qmp_init_marshal);
1013 /* set the current CPU defined by the user */
1014 int monitor_set_cpu(int cpu_index)
1018 cpu = qemu_get_cpu(cpu_index);
1022 cur_mon->mon_cpu = cpu;
1026 CPUState *mon_get_cpu(void)
1028 if (!cur_mon->mon_cpu) {
1029 monitor_set_cpu(first_cpu->cpu_index);
1031 cpu_synchronize_state(cur_mon->mon_cpu);
1032 return cur_mon->mon_cpu;
1035 CPUArchState *mon_get_cpu_env(void)
1037 return mon_get_cpu()->env_ptr;
1040 int monitor_get_cpu_index(void)
1042 return mon_get_cpu()->cpu_index;
1045 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1047 cpu_dump_state(mon_get_cpu(), (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1050 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1052 dump_exec_info((FILE *)mon, monitor_fprintf);
1053 dump_drift_info((FILE *)mon, monitor_fprintf);
1056 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1058 dump_opcount_info((FILE *)mon, monitor_fprintf);
1061 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1070 str = readline_get_history(mon->rs, i);
1073 monitor_printf(mon, "%d: '%s'\n", i, str);
1078 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1080 cpu_dump_statistics(mon_get_cpu(), (FILE *)mon, &monitor_fprintf, 0);
1083 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1085 const char *name = qdict_get_try_str(qdict, "name");
1086 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1087 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1088 TraceEventInfoList *events;
1089 TraceEventInfoList *elem;
1090 Error *local_err = NULL;
1096 monitor_printf(mon, "argument vcpu must be positive");
1100 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1102 error_report_err(local_err);
1106 for (elem = events; elem != NULL; elem = elem->next) {
1107 monitor_printf(mon, "%s : state %u\n",
1109 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1111 qapi_free_TraceEventInfoList(events);
1114 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1115 bool has_port, int64_t port,
1116 bool has_tls_port, int64_t tls_port,
1117 bool has_cert_subject, const char *cert_subject,
1120 if (strcmp(protocol, "spice") == 0) {
1121 if (!qemu_using_spice(errp)) {
1125 if (!has_port && !has_tls_port) {
1126 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1130 if (qemu_spice_migrate_info(hostname,
1131 has_port ? port : -1,
1132 has_tls_port ? tls_port : -1,
1134 error_setg(errp, QERR_UNDEFINED_ERROR);
1140 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1143 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1147 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1149 error_report_err(err);
1153 static void hmp_log(Monitor *mon, const QDict *qdict)
1156 const char *items = qdict_get_str(qdict, "items");
1158 if (!strcmp(items, "none")) {
1161 mask = qemu_str_to_log_mask(items);
1163 help_cmd(mon, "log");
1170 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1172 const char *option = qdict_get_try_str(qdict, "option");
1173 if (!option || !strcmp(option, "on")) {
1175 } else if (!strcmp(option, "off")) {
1178 monitor_printf(mon, "unexpected option %s\n", option);
1182 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1184 const char *device = qdict_get_try_str(qdict, "device");
1186 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1187 if (gdbserver_start(device) < 0) {
1188 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1190 } else if (strcmp(device, "none") == 0) {
1191 monitor_printf(mon, "Disabled gdbserver\n");
1193 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1198 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1200 const char *action = qdict_get_str(qdict, "action");
1201 if (select_watchdog_action(action) == -1) {
1202 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1206 static void monitor_printc(Monitor *mon, int c)
1208 monitor_printf(mon, "'");
1211 monitor_printf(mon, "\\'");
1214 monitor_printf(mon, "\\\\");
1217 monitor_printf(mon, "\\n");
1220 monitor_printf(mon, "\\r");
1223 if (c >= 32 && c <= 126) {
1224 monitor_printf(mon, "%c", c);
1226 monitor_printf(mon, "\\x%02x", c);
1230 monitor_printf(mon, "'");
1233 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1234 hwaddr addr, int is_physical)
1236 int l, line_size, i, max_digits, len;
1240 if (format == 'i') {
1243 CPUArchState *env = mon_get_cpu_env();
1246 } else if (wsize == 4) {
1249 /* as default we use the current CS size */
1252 #ifdef TARGET_X86_64
1253 if ((env->efer & MSR_EFER_LMA) &&
1254 (env->segs[R_CS].flags & DESC_L_MASK))
1258 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1264 CPUArchState *env = mon_get_cpu_env();
1265 flags = msr_le << 16;
1266 flags |= env->bfd_mach;
1268 monitor_disas(mon, mon_get_cpu(), addr, count, is_physical, flags);
1272 len = wsize * count;
1281 max_digits = (wsize * 8 + 2) / 3;
1285 max_digits = (wsize * 8) / 4;
1289 max_digits = (wsize * 8 * 10 + 32) / 33;
1298 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1300 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1305 cpu_physical_memory_read(addr, buf, l);
1307 if (cpu_memory_rw_debug(mon_get_cpu(), addr, buf, l, 0) < 0) {
1308 monitor_printf(mon, " Cannot access memory\n");
1317 v = ldub_p(buf + i);
1320 v = lduw_p(buf + i);
1323 v = (uint32_t)ldl_p(buf + i);
1329 monitor_printf(mon, " ");
1332 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1335 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1338 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1341 monitor_printf(mon, "%*" PRId64, max_digits, v);
1344 monitor_printc(mon, v);
1349 monitor_printf(mon, "\n");
1355 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1357 int count = qdict_get_int(qdict, "count");
1358 int format = qdict_get_int(qdict, "format");
1359 int size = qdict_get_int(qdict, "size");
1360 target_long addr = qdict_get_int(qdict, "addr");
1362 memory_dump(mon, count, format, size, addr, 0);
1365 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1367 int count = qdict_get_int(qdict, "count");
1368 int format = qdict_get_int(qdict, "format");
1369 int size = qdict_get_int(qdict, "size");
1370 hwaddr addr = qdict_get_int(qdict, "addr");
1372 memory_dump(mon, count, format, size, addr, 1);
1375 static void do_print(Monitor *mon, const QDict *qdict)
1377 int format = qdict_get_int(qdict, "format");
1378 hwaddr val = qdict_get_int(qdict, "val");
1382 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1385 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1388 monitor_printf(mon, "%" HWADDR_PRIu, val);
1392 monitor_printf(mon, "%" HWADDR_PRId, val);
1395 monitor_printc(mon, val);
1398 monitor_printf(mon, "\n");
1401 static void hmp_sum(Monitor *mon, const QDict *qdict)
1405 uint32_t start = qdict_get_int(qdict, "start");
1406 uint32_t size = qdict_get_int(qdict, "size");
1409 for(addr = start; addr < (start + size); addr++) {
1410 uint8_t val = address_space_ldub(&address_space_memory, addr,
1411 MEMTXATTRS_UNSPECIFIED, NULL);
1412 /* BSD sum algorithm ('sum' Unix command) */
1413 sum = (sum >> 1) | (sum << 15);
1416 monitor_printf(mon, "%05d\n", sum);
1419 static int mouse_button_state;
1421 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1423 int dx, dy, dz, button;
1424 const char *dx_str = qdict_get_str(qdict, "dx_str");
1425 const char *dy_str = qdict_get_str(qdict, "dy_str");
1426 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1428 dx = strtol(dx_str, NULL, 0);
1429 dy = strtol(dy_str, NULL, 0);
1430 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1431 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1434 dz = strtol(dz_str, NULL, 0);
1436 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1437 qemu_input_queue_btn(NULL, button, true);
1438 qemu_input_event_sync();
1439 qemu_input_queue_btn(NULL, button, false);
1442 qemu_input_event_sync();
1445 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1447 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1448 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1449 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1450 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1452 int button_state = qdict_get_int(qdict, "button_state");
1454 if (mouse_button_state == button_state) {
1457 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1458 qemu_input_event_sync();
1459 mouse_button_state = button_state;
1462 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1464 int size = qdict_get_int(qdict, "size");
1465 int addr = qdict_get_int(qdict, "addr");
1466 int has_index = qdict_haskey(qdict, "index");
1471 int index = qdict_get_int(qdict, "index");
1472 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1480 val = cpu_inb(addr);
1484 val = cpu_inw(addr);
1488 val = cpu_inl(addr);
1492 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1493 suffix, addr, size * 2, val);
1496 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1498 int size = qdict_get_int(qdict, "size");
1499 int addr = qdict_get_int(qdict, "addr");
1500 int val = qdict_get_int(qdict, "val");
1502 addr &= IOPORTS_MASK;
1507 cpu_outb(addr, val);
1510 cpu_outw(addr, val);
1513 cpu_outl(addr, val);
1518 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1520 Error *local_err = NULL;
1521 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1523 qemu_boot_set(bootdevice, &local_err);
1525 error_report_err(local_err);
1527 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1531 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1533 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1535 mtree_info((fprintf_function)monitor_printf, mon, flatview);
1538 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1544 node_mem = g_new0(uint64_t, nb_numa_nodes);
1545 query_numa_node_mem(node_mem);
1546 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1547 for (i = 0; i < nb_numa_nodes; i++) {
1548 monitor_printf(mon, "node %d cpus:", i);
1550 if (cpu->numa_node == i) {
1551 monitor_printf(mon, " %d", cpu->cpu_index);
1554 monitor_printf(mon, "\n");
1555 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1561 #ifdef CONFIG_PROFILER
1566 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1568 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1569 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1570 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1571 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1576 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1578 monitor_printf(mon, "Internal profiler not compiled\n");
1582 /* Capture support */
1583 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1585 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1590 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1591 monitor_printf(mon, "[%d]: ", i);
1592 s->ops.info (s->opaque);
1596 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1599 int n = qdict_get_int(qdict, "n");
1602 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1604 s->ops.destroy (s->opaque);
1605 QLIST_REMOVE (s, entries);
1612 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1614 const char *path = qdict_get_str(qdict, "path");
1615 int has_freq = qdict_haskey(qdict, "freq");
1616 int freq = qdict_get_try_int(qdict, "freq", -1);
1617 int has_bits = qdict_haskey(qdict, "bits");
1618 int bits = qdict_get_try_int(qdict, "bits", -1);
1619 int has_channels = qdict_haskey(qdict, "nchannels");
1620 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1623 s = g_malloc0 (sizeof (*s));
1625 freq = has_freq ? freq : 44100;
1626 bits = has_bits ? bits : 16;
1627 nchannels = has_channels ? nchannels : 2;
1629 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1630 monitor_printf(mon, "Failed to add wave capture\n");
1634 QLIST_INSERT_HEAD (&capture_head, s, entries);
1637 static qemu_acl *find_acl(Monitor *mon, const char *name)
1639 qemu_acl *acl = qemu_acl_find(name);
1642 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1647 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1649 const char *aclname = qdict_get_str(qdict, "aclname");
1650 qemu_acl *acl = find_acl(mon, aclname);
1651 qemu_acl_entry *entry;
1655 monitor_printf(mon, "policy: %s\n",
1656 acl->defaultDeny ? "deny" : "allow");
1657 QTAILQ_FOREACH(entry, &acl->entries, next) {
1659 monitor_printf(mon, "%d: %s %s\n", i,
1660 entry->deny ? "deny" : "allow", entry->match);
1665 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1667 const char *aclname = qdict_get_str(qdict, "aclname");
1668 qemu_acl *acl = find_acl(mon, aclname);
1671 qemu_acl_reset(acl);
1672 monitor_printf(mon, "acl: removed all rules\n");
1676 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1678 const char *aclname = qdict_get_str(qdict, "aclname");
1679 const char *policy = qdict_get_str(qdict, "policy");
1680 qemu_acl *acl = find_acl(mon, aclname);
1683 if (strcmp(policy, "allow") == 0) {
1684 acl->defaultDeny = 0;
1685 monitor_printf(mon, "acl: policy set to 'allow'\n");
1686 } else if (strcmp(policy, "deny") == 0) {
1687 acl->defaultDeny = 1;
1688 monitor_printf(mon, "acl: policy set to 'deny'\n");
1690 monitor_printf(mon, "acl: unknown policy '%s', "
1691 "expected 'deny' or 'allow'\n", policy);
1696 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1698 const char *aclname = qdict_get_str(qdict, "aclname");
1699 const char *match = qdict_get_str(qdict, "match");
1700 const char *policy = qdict_get_str(qdict, "policy");
1701 int has_index = qdict_haskey(qdict, "index");
1702 int index = qdict_get_try_int(qdict, "index", -1);
1703 qemu_acl *acl = find_acl(mon, aclname);
1707 if (strcmp(policy, "allow") == 0) {
1709 } else if (strcmp(policy, "deny") == 0) {
1712 monitor_printf(mon, "acl: unknown policy '%s', "
1713 "expected 'deny' or 'allow'\n", policy);
1717 ret = qemu_acl_insert(acl, deny, match, index);
1719 ret = qemu_acl_append(acl, deny, match);
1721 monitor_printf(mon, "acl: unable to add acl entry\n");
1723 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1727 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1729 const char *aclname = qdict_get_str(qdict, "aclname");
1730 const char *match = qdict_get_str(qdict, "match");
1731 qemu_acl *acl = find_acl(mon, aclname);
1735 ret = qemu_acl_remove(acl, match);
1737 monitor_printf(mon, "acl: no matching acl entry\n");
1739 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1743 void qmp_getfd(const char *fdname, Error **errp)
1748 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1750 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1754 if (qemu_isdigit(fdname[0])) {
1756 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1757 "a name not starting with a digit");
1761 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1762 if (strcmp(monfd->name, fdname) != 0) {
1771 monfd = g_malloc0(sizeof(mon_fd_t));
1772 monfd->name = g_strdup(fdname);
1775 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1778 void qmp_closefd(const char *fdname, Error **errp)
1782 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1783 if (strcmp(monfd->name, fdname) != 0) {
1787 QLIST_REMOVE(monfd, next);
1789 g_free(monfd->name);
1794 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1797 static void hmp_loadvm(Monitor *mon, const QDict *qdict)
1799 int saved_vm_running = runstate_is_running();
1800 const char *name = qdict_get_str(qdict, "name");
1802 vm_stop(RUN_STATE_RESTORE_VM);
1804 if (load_vmstate(name) == 0 && saved_vm_running) {
1809 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1813 QLIST_FOREACH(monfd, &mon->fds, next) {
1816 if (strcmp(monfd->name, fdname) != 0) {
1822 /* caller takes ownership of fd */
1823 QLIST_REMOVE(monfd, next);
1824 g_free(monfd->name);
1830 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1834 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1836 MonFdsetFd *mon_fdset_fd;
1837 MonFdsetFd *mon_fdset_fd_next;
1839 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
1840 if ((mon_fdset_fd->removed ||
1841 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
1842 runstate_is_running()) {
1843 close(mon_fdset_fd->fd);
1844 g_free(mon_fdset_fd->opaque);
1845 QLIST_REMOVE(mon_fdset_fd, next);
1846 g_free(mon_fdset_fd);
1850 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
1851 QLIST_REMOVE(mon_fdset, next);
1856 static void monitor_fdsets_cleanup(void)
1858 MonFdset *mon_fdset;
1859 MonFdset *mon_fdset_next;
1861 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
1862 monitor_fdset_cleanup(mon_fdset);
1866 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
1867 const char *opaque, Error **errp)
1870 Monitor *mon = cur_mon;
1873 fd = qemu_chr_fe_get_msgfd(&mon->chr);
1875 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1879 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
1880 has_opaque, opaque, errp);
1892 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
1894 MonFdset *mon_fdset;
1895 MonFdsetFd *mon_fdset_fd;
1898 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1899 if (mon_fdset->id != fdset_id) {
1902 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
1904 if (mon_fdset_fd->fd != fd) {
1907 mon_fdset_fd->removed = true;
1910 mon_fdset_fd->removed = true;
1913 if (has_fd && !mon_fdset_fd) {
1916 monitor_fdset_cleanup(mon_fdset);
1922 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
1925 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
1927 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
1930 FdsetInfoList *qmp_query_fdsets(Error **errp)
1932 MonFdset *mon_fdset;
1933 MonFdsetFd *mon_fdset_fd;
1934 FdsetInfoList *fdset_list = NULL;
1936 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1937 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
1938 FdsetFdInfoList *fdsetfd_list = NULL;
1940 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
1941 fdset_info->value->fdset_id = mon_fdset->id;
1943 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
1944 FdsetFdInfoList *fdsetfd_info;
1946 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
1947 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
1948 fdsetfd_info->value->fd = mon_fdset_fd->fd;
1949 if (mon_fdset_fd->opaque) {
1950 fdsetfd_info->value->has_opaque = true;
1951 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
1953 fdsetfd_info->value->has_opaque = false;
1956 fdsetfd_info->next = fdsetfd_list;
1957 fdsetfd_list = fdsetfd_info;
1960 fdset_info->value->fds = fdsetfd_list;
1962 fdset_info->next = fdset_list;
1963 fdset_list = fdset_info;
1969 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
1970 bool has_opaque, const char *opaque,
1973 MonFdset *mon_fdset = NULL;
1974 MonFdsetFd *mon_fdset_fd;
1978 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1979 /* Break if match found or match impossible due to ordering by ID */
1980 if (fdset_id <= mon_fdset->id) {
1981 if (fdset_id < mon_fdset->id) {
1989 if (mon_fdset == NULL) {
1990 int64_t fdset_id_prev = -1;
1991 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
1995 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
1996 "a non-negative value");
1999 /* Use specified fdset ID */
2000 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2001 mon_fdset_cur = mon_fdset;
2002 if (fdset_id < mon_fdset_cur->id) {
2007 /* Use first available fdset ID */
2008 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2009 mon_fdset_cur = mon_fdset;
2010 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2011 fdset_id_prev = mon_fdset_cur->id;
2018 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2020 mon_fdset->id = fdset_id;
2022 mon_fdset->id = fdset_id_prev + 1;
2025 /* The fdset list is ordered by fdset ID */
2026 if (!mon_fdset_cur) {
2027 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2028 } else if (mon_fdset->id < mon_fdset_cur->id) {
2029 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2031 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2035 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2036 mon_fdset_fd->fd = fd;
2037 mon_fdset_fd->removed = false;
2039 mon_fdset_fd->opaque = g_strdup(opaque);
2041 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2043 fdinfo = g_malloc0(sizeof(*fdinfo));
2044 fdinfo->fdset_id = mon_fdset->id;
2045 fdinfo->fd = mon_fdset_fd->fd;
2050 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2053 MonFdset *mon_fdset;
2054 MonFdsetFd *mon_fdset_fd;
2057 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2058 if (mon_fdset->id != fdset_id) {
2061 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2062 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2063 if (mon_fd_flags == -1) {
2067 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2068 return mon_fdset_fd->fd;
2080 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2082 MonFdset *mon_fdset;
2083 MonFdsetFd *mon_fdset_fd_dup;
2085 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2086 if (mon_fdset->id != fdset_id) {
2089 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2090 if (mon_fdset_fd_dup->fd == dup_fd) {
2094 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2095 mon_fdset_fd_dup->fd = dup_fd;
2096 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2102 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2104 MonFdset *mon_fdset;
2105 MonFdsetFd *mon_fdset_fd_dup;
2107 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2108 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2109 if (mon_fdset_fd_dup->fd == dup_fd) {
2111 QLIST_REMOVE(mon_fdset_fd_dup, next);
2112 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2113 monitor_fdset_cleanup(mon_fdset);
2117 return mon_fdset->id;
2125 int monitor_fdset_dup_fd_find(int dup_fd)
2127 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2130 void monitor_fdset_dup_fd_remove(int dup_fd)
2132 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2135 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2138 Error *local_err = NULL;
2140 if (!qemu_isdigit(fdname[0]) && mon) {
2141 fd = monitor_get_fd(mon, fdname, &local_err);
2143 fd = qemu_parse_fd(fdname);
2145 error_setg(&local_err, "Invalid file descriptor number '%s'",
2150 error_propagate(errp, local_err);
2159 /* Please update hmp-commands.hx when adding or changing commands */
2160 static mon_cmd_t info_cmds[] = {
2161 #include "hmp-commands-info.h"
2165 /* mon_cmds and info_cmds would be sorted at runtime */
2166 static mon_cmd_t mon_cmds[] = {
2167 #include "hmp-commands.h"
2171 /*******************************************************************/
2173 static const char *pch;
2174 static sigjmp_buf expr_env;
2177 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2178 expr_error(Monitor *mon, const char *fmt, ...)
2182 monitor_vprintf(mon, fmt, ap);
2183 monitor_printf(mon, "\n");
2185 siglongjmp(expr_env, 1);
2188 /* return 0 if OK, -1 if not found */
2189 static int get_monitor_def(target_long *pval, const char *name)
2191 const MonitorDef *md = target_monitor_defs();
2200 for(; md->name != NULL; md++) {
2201 if (compare_cmd(name, md->name)) {
2202 if (md->get_value) {
2203 *pval = md->get_value(md, md->offset);
2205 CPUArchState *env = mon_get_cpu_env();
2206 ptr = (uint8_t *)env + md->offset;
2209 *pval = *(int32_t *)ptr;
2212 *pval = *(target_long *)ptr;
2223 ret = target_get_monitor_def(mon_get_cpu(), name, &tmp);
2225 *pval = (target_long) tmp;
2231 static void next(void)
2235 while (qemu_isspace(*pch))
2240 static int64_t expr_sum(Monitor *mon);
2242 static int64_t expr_unary(Monitor *mon)
2251 n = expr_unary(mon);
2255 n = -expr_unary(mon);
2259 n = ~expr_unary(mon);
2265 expr_error(mon, "')' expected");
2272 expr_error(mon, "character constant expected");
2276 expr_error(mon, "missing terminating \' character");
2286 while ((*pch >= 'a' && *pch <= 'z') ||
2287 (*pch >= 'A' && *pch <= 'Z') ||
2288 (*pch >= '0' && *pch <= '9') ||
2289 *pch == '_' || *pch == '.') {
2290 if ((q - buf) < sizeof(buf) - 1)
2294 while (qemu_isspace(*pch))
2297 ret = get_monitor_def(®, buf);
2299 expr_error(mon, "unknown register");
2304 expr_error(mon, "unexpected end of expression");
2309 n = strtoull(pch, &p, 0);
2310 if (errno == ERANGE) {
2311 expr_error(mon, "number too large");
2314 expr_error(mon, "invalid char '%c' in expression", *p);
2317 while (qemu_isspace(*pch))
2325 static int64_t expr_prod(Monitor *mon)
2330 val = expr_unary(mon);
2333 if (op != '*' && op != '/' && op != '%')
2336 val2 = expr_unary(mon);
2345 expr_error(mon, "division by zero");
2356 static int64_t expr_logic(Monitor *mon)
2361 val = expr_prod(mon);
2364 if (op != '&' && op != '|' && op != '^')
2367 val2 = expr_prod(mon);
2384 static int64_t expr_sum(Monitor *mon)
2389 val = expr_logic(mon);
2392 if (op != '+' && op != '-')
2395 val2 = expr_logic(mon);
2404 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2407 if (sigsetjmp(expr_env, 0)) {
2411 while (qemu_isspace(*pch))
2413 *pval = expr_sum(mon);
2418 static int get_double(Monitor *mon, double *pval, const char **pp)
2420 const char *p = *pp;
2424 d = strtod(p, &tailp);
2426 monitor_printf(mon, "Number expected\n");
2429 if (d != d || d - d != 0) {
2430 /* NaN or infinity */
2431 monitor_printf(mon, "Bad number\n");
2440 * Store the command-name in cmdname, and return a pointer to
2441 * the remaining of the command string.
2443 static const char *get_command_name(const char *cmdline,
2444 char *cmdname, size_t nlen)
2447 const char *p, *pstart;
2450 while (qemu_isspace(*p))
2455 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2460 memcpy(cmdname, pstart, len);
2461 cmdname[len] = '\0';
2466 * Read key of 'type' into 'key' and return the current
2469 static char *key_get_info(const char *type, char **key)
2477 p = strchr(type, ':');
2484 str = g_malloc(len + 1);
2485 memcpy(str, type, len);
2492 static int default_fmt_format = 'x';
2493 static int default_fmt_size = 4;
2495 static int is_valid_option(const char *c, const char *typestr)
2503 typestr = strstr(typestr, option);
2504 return (typestr != NULL);
2507 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2508 const char *cmdname)
2510 const mon_cmd_t *cmd;
2512 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2513 if (compare_cmd(cmdname, cmd->name)) {
2522 * Parse command name from @cmdp according to command table @table.
2523 * If blank, return NULL.
2524 * Else, if no valid command can be found, report to @mon, and return
2526 * Else, change @cmdp to point right behind the name, and return its
2527 * command table entry.
2528 * Do not assume the return value points into @table! It doesn't when
2529 * the command is found in a sub-command table.
2531 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2536 const mon_cmd_t *cmd;
2539 /* extract the command name */
2540 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2544 cmd = search_dispatch_table(table, cmdname);
2546 monitor_printf(mon, "unknown command: '%.*s'\n",
2547 (int)(p - *cmdp), *cmdp);
2551 /* filter out following useless space */
2552 while (qemu_isspace(*p)) {
2557 /* search sub command */
2558 if (cmd->sub_table != NULL && *p != '\0') {
2559 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2566 * Parse arguments for @cmd.
2567 * If it can't be parsed, report to @mon, and return NULL.
2568 * Else, insert command arguments into a QDict, and return it.
2569 * Note: On success, caller has to free the QDict structure.
2572 static QDict *monitor_parse_arguments(Monitor *mon,
2574 const mon_cmd_t *cmd)
2576 const char *typestr;
2579 const char *p = *endp;
2581 QDict *qdict = qdict_new();
2583 /* parse the parameters */
2584 typestr = cmd->args_type;
2586 typestr = key_get_info(typestr, &key);
2598 while (qemu_isspace(*p))
2600 if (*typestr == '?') {
2603 /* no optional string: NULL argument */
2607 ret = get_str(buf, sizeof(buf), &p);
2611 monitor_printf(mon, "%s: filename expected\n",
2615 monitor_printf(mon, "%s: block device name expected\n",
2619 monitor_printf(mon, "%s: string expected\n", cmd->name);
2624 qdict_put(qdict, key, qstring_from_str(buf));
2629 QemuOptsList *opts_list;
2632 opts_list = qemu_find_opts(key);
2633 if (!opts_list || opts_list->desc->name) {
2636 while (qemu_isspace(*p)) {
2641 if (get_str(buf, sizeof(buf), &p) < 0) {
2644 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2648 qemu_opts_to_qdict(opts, qdict);
2649 qemu_opts_del(opts);
2654 int count, format, size;
2656 while (qemu_isspace(*p))
2662 if (qemu_isdigit(*p)) {
2664 while (qemu_isdigit(*p)) {
2665 count = count * 10 + (*p - '0');
2703 if (*p != '\0' && !qemu_isspace(*p)) {
2704 monitor_printf(mon, "invalid char in format: '%c'\n",
2709 format = default_fmt_format;
2710 if (format != 'i') {
2711 /* for 'i', not specifying a size gives -1 as size */
2713 size = default_fmt_size;
2714 default_fmt_size = size;
2716 default_fmt_format = format;
2719 format = default_fmt_format;
2720 if (format != 'i') {
2721 size = default_fmt_size;
2726 qdict_put(qdict, "count", qint_from_int(count));
2727 qdict_put(qdict, "format", qint_from_int(format));
2728 qdict_put(qdict, "size", qint_from_int(size));
2737 while (qemu_isspace(*p))
2739 if (*typestr == '?' || *typestr == '.') {
2740 if (*typestr == '?') {
2748 while (qemu_isspace(*p))
2757 if (get_expr(mon, &val, &p))
2759 /* Check if 'i' is greater than 32-bit */
2760 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2761 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2762 monitor_printf(mon, "integer is for 32-bit values\n");
2764 } else if (c == 'M') {
2766 monitor_printf(mon, "enter a positive value\n");
2771 qdict_put(qdict, key, qint_from_int(val));
2779 while (qemu_isspace(*p)) {
2782 if (*typestr == '?') {
2788 val = qemu_strtosz(p, &end);
2790 monitor_printf(mon, "invalid size\n");
2793 qdict_put(qdict, key, qint_from_int(val));
2801 while (qemu_isspace(*p))
2803 if (*typestr == '?') {
2809 if (get_double(mon, &val, &p) < 0) {
2812 if (p[0] && p[1] == 's') {
2815 val /= 1e3; p += 2; break;
2817 val /= 1e6; p += 2; break;
2819 val /= 1e9; p += 2; break;
2822 if (*p && !qemu_isspace(*p)) {
2823 monitor_printf(mon, "Unknown unit suffix\n");
2826 qdict_put(qdict, key, qfloat_from_double(val));
2834 while (qemu_isspace(*p)) {
2838 while (qemu_isgraph(*p)) {
2841 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
2843 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
2846 monitor_printf(mon, "Expected 'on' or 'off'\n");
2849 qdict_put(qdict, key, qbool_from_bool(val));
2854 const char *tmp = p;
2861 while (qemu_isspace(*p))
2866 if(!is_valid_option(p, typestr)) {
2868 monitor_printf(mon, "%s: unsupported option -%c\n",
2880 qdict_put(qdict, key, qbool_from_bool(true));
2887 /* package all remaining string */
2890 while (qemu_isspace(*p)) {
2893 if (*typestr == '?') {
2896 /* no remaining string: NULL argument */
2902 monitor_printf(mon, "%s: string expected\n",
2906 qdict_put(qdict, key, qstring_from_str(p));
2912 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
2918 /* check that all arguments were parsed */
2919 while (qemu_isspace(*p))
2922 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
2935 static void handle_hmp_command(Monitor *mon, const char *cmdline)
2938 const mon_cmd_t *cmd;
2940 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
2945 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
2947 monitor_printf(mon, "Try \"help %s\" for more information\n",
2952 cmd->cmd(mon, qdict);
2956 static void cmd_completion(Monitor *mon, const char *name, const char *list)
2958 const char *p, *pstart;
2967 p = pstart + strlen(pstart);
2969 if (len > sizeof(cmd) - 2)
2970 len = sizeof(cmd) - 2;
2971 memcpy(cmd, pstart, len);
2973 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
2974 readline_add_completion(mon->rs, cmd);
2982 static void file_completion(Monitor *mon, const char *input)
2987 char file[1024], file_prefix[1024];
2991 p = strrchr(input, '/');
2994 pstrcpy(file_prefix, sizeof(file_prefix), input);
2995 pstrcpy(path, sizeof(path), ".");
2997 input_path_len = p - input + 1;
2998 memcpy(path, input, input_path_len);
2999 if (input_path_len > sizeof(path) - 1)
3000 input_path_len = sizeof(path) - 1;
3001 path[input_path_len] = '\0';
3002 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3005 ffs = opendir(path);
3014 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3018 if (strstart(d->d_name, file_prefix, NULL)) {
3019 memcpy(file, input, input_path_len);
3020 if (input_path_len < sizeof(file))
3021 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3023 /* stat the file to find out if it's a directory.
3024 * In that case add a slash to speed up typing long paths
3026 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3027 pstrcat(file, sizeof(file), "/");
3029 readline_add_completion(mon->rs, file);
3035 static const char *next_arg_type(const char *typestr)
3037 const char *p = strchr(typestr, ':');
3038 return (p != NULL ? ++p : typestr);
3041 static void add_completion_option(ReadLineState *rs, const char *str,
3044 if (!str || !option) {
3047 if (!strncmp(option, str, strlen(str))) {
3048 readline_add_completion(rs, option);
3052 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3055 ChardevBackendInfoList *list, *start;
3061 readline_set_completion_index(rs, len);
3063 start = list = qmp_query_chardev_backends(NULL);
3065 const char *chr_name = list->value->name;
3067 if (!strncmp(chr_name, str, len)) {
3068 readline_add_completion(rs, chr_name);
3072 qapi_free_ChardevBackendInfoList(start);
3075 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3084 readline_set_completion_index(rs, len);
3085 for (i = 0; NetClientDriver_lookup[i]; i++) {
3086 add_completion_option(rs, str, NetClientDriver_lookup[i]);
3090 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3100 readline_set_completion_index(rs, len);
3101 list = elt = object_class_get_list(TYPE_DEVICE, false);
3104 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3106 name = object_class_get_name(OBJECT_CLASS(dc));
3108 if (!dc->cannot_instantiate_with_device_add_yet
3109 && !strncmp(name, str, len)) {
3110 readline_add_completion(rs, name);
3117 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3127 readline_set_completion_index(rs, len);
3128 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3132 name = object_class_get_name(OBJECT_CLASS(elt->data));
3133 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3134 readline_add_completion(rs, name);
3141 static void peripheral_device_del_completion(ReadLineState *rs,
3142 const char *str, size_t len)
3144 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3145 GSList *list, *item;
3147 list = qdev_build_hotpluggable_device_list(peripheral);
3152 for (item = list; item; item = g_slist_next(item)) {
3153 DeviceState *dev = item->data;
3155 if (dev->id && !strncmp(str, dev->id, len)) {
3156 readline_add_completion(rs, dev->id);
3163 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3166 ChardevInfoList *list, *start;
3172 readline_set_completion_index(rs, len);
3174 start = list = qmp_query_chardev(NULL);
3176 ChardevInfo *chr = list->value;
3178 if (!strncmp(chr->label, str, len)) {
3179 readline_add_completion(rs, chr->label);
3183 qapi_free_ChardevInfoList(start);
3186 static void ringbuf_completion(ReadLineState *rs, const char *str)
3189 ChardevInfoList *list, *start;
3192 readline_set_completion_index(rs, len);
3194 start = list = qmp_query_chardev(NULL);
3196 ChardevInfo *chr_info = list->value;
3198 if (!strncmp(chr_info->label, str, len)) {
3199 Chardev *chr = qemu_chr_find(chr_info->label);
3200 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3201 readline_add_completion(rs, chr_info->label);
3206 qapi_free_ChardevInfoList(start);
3209 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3214 ringbuf_completion(rs, str);
3217 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3226 readline_set_completion_index(rs, len);
3227 peripheral_device_del_completion(rs, str, len);
3230 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3232 ObjectPropertyInfoList *list, *start;
3239 readline_set_completion_index(rs, len);
3241 start = list = qmp_qom_list("/objects", NULL);
3243 ObjectPropertyInfo *info = list->value;
3245 if (!strncmp(info->type, "child<", 5)
3246 && !strncmp(info->name, str, len)) {
3247 readline_add_completion(rs, info->name);
3251 qapi_free_ObjectPropertyInfoList(start);
3254 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3263 sep = strrchr(str, '-');
3268 readline_set_completion_index(rs, len);
3269 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3270 if (!strncmp(str, QKeyCode_lookup[i], len)) {
3271 readline_add_completion(rs, QKeyCode_lookup[i]);
3276 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3281 readline_set_completion_index(rs, len);
3283 NetClientState *ncs[MAX_QUEUE_NUM];
3285 count = qemu_find_net_clients_except(NULL, ncs,
3286 NET_CLIENT_DRIVER_NONE,
3288 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3289 const char *name = ncs[i]->name;
3290 if (!strncmp(str, name, len)) {
3291 readline_add_completion(rs, name);
3294 } else if (nb_args == 3) {
3295 add_completion_option(rs, str, "on");
3296 add_completion_option(rs, str, "off");
3300 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3303 NetClientState *ncs[MAX_QUEUE_NUM];
3310 readline_set_completion_index(rs, len);
3311 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3313 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3315 const char *name = ncs[i]->name;
3316 if (strncmp(str, name, len)) {
3319 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3321 readline_add_completion(rs, name);
3326 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3331 readline_set_completion_index(rs, len);
3333 TraceEventIter iter;
3335 char *pattern = g_strdup_printf("%s*", str);
3336 trace_event_iter_init(&iter, pattern);
3337 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3338 readline_add_completion(rs, trace_event_get_name(ev));
3344 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3349 readline_set_completion_index(rs, len);
3351 TraceEventIter iter;
3353 char *pattern = g_strdup_printf("%s*", str);
3354 trace_event_iter_init(&iter, pattern);
3355 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3356 readline_add_completion(rs, trace_event_get_name(ev));
3359 } else if (nb_args == 3) {
3360 add_completion_option(rs, str, "on");
3361 add_completion_option(rs, str, "off");
3365 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3372 readline_set_completion_index(rs, strlen(str));
3373 for (i = 0; WatchdogExpirationAction_lookup[i]; i++) {
3374 add_completion_option(rs, str, WatchdogExpirationAction_lookup[i]);
3378 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3384 readline_set_completion_index(rs, len);
3387 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3388 const char *name = MigrationCapability_lookup[i];
3389 if (!strncmp(str, name, len)) {
3390 readline_add_completion(rs, name);
3393 } else if (nb_args == 3) {
3394 add_completion_option(rs, str, "on");
3395 add_completion_option(rs, str, "off");
3399 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3405 readline_set_completion_index(rs, len);
3408 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3409 const char *name = MigrationParameter_lookup[i];
3410 if (!strncmp(str, name, len)) {
3411 readline_add_completion(rs, name);
3417 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3425 readline_set_completion_index(rs, len);
3426 for (i = 0; host_net_devices[i]; i++) {
3427 if (!strncmp(host_net_devices[i], str, len)) {
3428 readline_add_completion(rs, host_net_devices[i]);
3433 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3435 NetClientState *ncs[MAX_QUEUE_NUM];
3439 readline_set_completion_index(rs, len);
3441 count = qemu_find_net_clients_except(NULL, ncs,
3442 NET_CLIENT_DRIVER_NONE,
3444 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3448 if (net_hub_id_for_client(ncs[i], &id)) {
3451 snprintf(name, sizeof(name), "%d", id);
3452 if (!strncmp(str, name, len)) {
3453 readline_add_completion(rs, name);
3457 } else if (nb_args == 3) {
3458 count = qemu_find_net_clients_except(NULL, ncs,
3459 NET_CLIENT_DRIVER_NIC,
3461 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3465 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3466 net_hub_id_for_client(ncs[i], &id)) {
3469 name = ncs[i]->name;
3470 if (!strncmp(str, name, len)) {
3471 readline_add_completion(rs, name);
3478 static void vm_completion(ReadLineState *rs, const char *str)
3481 BlockDriverState *bs;
3482 BdrvNextIterator it;
3485 readline_set_completion_index(rs, len);
3487 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3488 SnapshotInfoList *snapshots, *snapshot;
3489 AioContext *ctx = bdrv_get_aio_context(bs);
3492 aio_context_acquire(ctx);
3493 if (bdrv_can_snapshot(bs)) {
3494 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3496 aio_context_release(ctx);
3501 snapshot = snapshots;
3503 char *completion = snapshot->value->name;
3504 if (!strncmp(str, completion, len)) {
3505 readline_add_completion(rs, completion);
3507 completion = snapshot->value->id;
3508 if (!strncmp(str, completion, len)) {
3509 readline_add_completion(rs, completion);
3511 snapshot = snapshot->next;
3513 qapi_free_SnapshotInfoList(snapshots);
3518 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3521 vm_completion(rs, str);
3525 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3528 vm_completion(rs, str);
3532 static void monitor_find_completion_by_table(Monitor *mon,
3533 const mon_cmd_t *cmd_table,
3537 const char *cmdname;
3539 const char *ptype, *str, *name;
3540 const mon_cmd_t *cmd;
3541 BlockBackend *blk = NULL;
3544 /* command completion */
3549 readline_set_completion_index(mon->rs, strlen(cmdname));
3550 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3551 cmd_completion(mon, cmdname, cmd->name);
3554 /* find the command */
3555 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3556 if (compare_cmd(args[0], cmd->name)) {
3564 if (cmd->sub_table) {
3565 /* do the job again */
3566 monitor_find_completion_by_table(mon, cmd->sub_table,
3567 &args[1], nb_args - 1);
3570 if (cmd->command_completion) {
3571 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3575 ptype = next_arg_type(cmd->args_type);
3576 for(i = 0; i < nb_args - 2; i++) {
3577 if (*ptype != '\0') {
3578 ptype = next_arg_type(ptype);
3579 while (*ptype == '?')
3580 ptype = next_arg_type(ptype);
3583 str = args[nb_args - 1];
3584 while (*ptype == '-' && ptype[1] != '\0') {
3585 ptype = next_arg_type(ptype);
3589 /* file completion */
3590 readline_set_completion_index(mon->rs, strlen(str));
3591 file_completion(mon, str);
3594 /* block device name completion */
3595 readline_set_completion_index(mon->rs, strlen(str));
3596 while ((blk = blk_next(blk)) != NULL) {
3597 name = blk_name(blk);
3598 if (str[0] == '\0' ||
3599 !strncmp(name, str, strlen(str))) {
3600 readline_add_completion(mon->rs, name);
3606 if (!strcmp(cmd->name, "help|?")) {
3607 monitor_find_completion_by_table(mon, cmd_table,
3608 &args[1], nb_args - 1);
3617 static void monitor_find_completion(void *opaque,
3618 const char *cmdline)
3620 Monitor *mon = opaque;
3621 char *args[MAX_ARGS];
3624 /* 1. parse the cmdline */
3625 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3629 /* if the line ends with a space, it means we want to complete the
3631 len = strlen(cmdline);
3632 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3633 if (nb_args >= MAX_ARGS) {
3636 args[nb_args++] = g_strdup("");
3639 /* 2. auto complete according to args */
3640 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3643 free_cmdline_args(args, nb_args);
3646 static int monitor_can_read(void *opaque)
3648 Monitor *mon = opaque;
3650 return (mon->suspend_cnt == 0) ? 1 : 0;
3653 static bool invalid_qmp_mode(const Monitor *mon, const char *cmd,
3656 bool is_cap = g_str_equal(cmd, "qmp_capabilities");
3658 if (is_cap && mon->qmp.in_command_mode) {
3659 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
3660 "Capabilities negotiation is already complete, command "
3661 "'%s' ignored", cmd);
3664 if (!is_cap && !mon->qmp.in_command_mode) {
3665 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
3666 "Expecting capabilities negotiation with "
3667 "'qmp_capabilities' before command '%s'", cmd);
3674 * Input object checking rules
3676 * 1. Input object must be a dict
3677 * 2. The "execute" key must exist
3678 * 3. The "execute" key must be a string
3679 * 4. If the "arguments" key exists, it must be a dict
3680 * 5. If the "id" key exists, it can be anything (ie. json-value)
3681 * 6. Any argument not listed above is considered invalid
3683 static QDict *qmp_check_input_obj(QObject *input_obj, Error **errp)
3685 const QDictEntry *ent;
3686 int has_exec_key = 0;
3689 if (qobject_type(input_obj) != QTYPE_QDICT) {
3690 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT, "object");
3694 input_dict = qobject_to_qdict(input_obj);
3696 for (ent = qdict_first(input_dict); ent; ent = qdict_next(input_dict, ent)){
3697 const char *arg_name = qdict_entry_key(ent);
3698 const QObject *arg_obj = qdict_entry_value(ent);
3700 if (!strcmp(arg_name, "execute")) {
3701 if (qobject_type(arg_obj) != QTYPE_QSTRING) {
3702 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
3703 "execute", "string");
3707 } else if (!strcmp(arg_name, "arguments")) {
3708 if (qobject_type(arg_obj) != QTYPE_QDICT) {
3709 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
3710 "arguments", "object");
3713 } else if (!strcmp(arg_name, "id")) {
3714 /* Any string is acceptable as "id", so nothing to check */
3716 error_setg(errp, QERR_QMP_EXTRA_MEMBER, arg_name);
3721 if (!has_exec_key) {
3722 error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT, "execute");
3729 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3731 QObject *req, *rsp = NULL, *id = NULL;
3732 QDict *qdict = NULL;
3733 const char *cmd_name;
3734 Monitor *mon = cur_mon;
3737 req = json_parser_parse_err(tokens, NULL, &err);
3738 if (err || !req || qobject_type(req) != QTYPE_QDICT) {
3740 error_setg(&err, QERR_JSON_PARSING);
3745 qdict = qmp_check_input_obj(req, &err);
3750 id = qdict_get(qdict, "id");
3752 qdict_del(qdict, "id");
3754 cmd_name = qdict_get_str(qdict, "execute");
3755 trace_handle_qmp_command(mon, cmd_name);
3757 if (invalid_qmp_mode(mon, cmd_name, &err)) {
3761 rsp = qmp_dispatch(req);
3765 qdict = qdict_new();
3766 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3768 rsp = QOBJECT(qdict);
3773 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3777 monitor_json_emitter(mon, rsp);
3781 qobject_decref(rsp);
3782 qobject_decref(req);
3785 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3787 Monitor *old_mon = cur_mon;
3791 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3796 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3798 Monitor *old_mon = cur_mon;
3804 for (i = 0; i < size; i++)
3805 readline_handle_byte(cur_mon->rs, buf[i]);
3807 if (size == 0 || buf[size - 1] != 0)
3808 monitor_printf(cur_mon, "corrupted command\n");
3810 handle_hmp_command(cur_mon, (char *)buf);
3816 static void monitor_command_cb(void *opaque, const char *cmdline,
3817 void *readline_opaque)
3819 Monitor *mon = opaque;
3821 monitor_suspend(mon);
3822 handle_hmp_command(mon, cmdline);
3823 monitor_resume(mon);
3826 int monitor_suspend(Monitor *mon)
3834 void monitor_resume(Monitor *mon)
3838 if (--mon->suspend_cnt == 0)
3839 readline_show_prompt(mon->rs);
3842 static QObject *get_qmp_greeting(void)
3844 QObject *ver = NULL;
3846 qmp_marshal_query_version(NULL, &ver, NULL);
3848 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3852 static void monitor_qmp_event(void *opaque, int event)
3855 Monitor *mon = opaque;
3858 case CHR_EVENT_OPENED:
3859 mon->qmp.in_command_mode = false;
3860 data = get_qmp_greeting();
3861 monitor_json_emitter(mon, data);
3862 qobject_decref(data);
3865 case CHR_EVENT_CLOSED:
3866 json_message_parser_destroy(&mon->qmp.parser);
3867 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3869 monitor_fdsets_cleanup();
3874 static void monitor_event(void *opaque, int event)
3876 Monitor *mon = opaque;
3879 case CHR_EVENT_MUX_IN:
3880 qemu_mutex_lock(&mon->out_lock);
3882 qemu_mutex_unlock(&mon->out_lock);
3883 if (mon->reset_seen) {
3884 readline_restart(mon->rs);
3885 monitor_resume(mon);
3888 mon->suspend_cnt = 0;
3892 case CHR_EVENT_MUX_OUT:
3893 if (mon->reset_seen) {
3894 if (mon->suspend_cnt == 0) {
3895 monitor_printf(mon, "\n");
3898 monitor_suspend(mon);
3902 qemu_mutex_lock(&mon->out_lock);
3904 qemu_mutex_unlock(&mon->out_lock);
3907 case CHR_EVENT_OPENED:
3908 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3909 "information\n", QEMU_VERSION);
3910 if (!mon->mux_out) {
3911 readline_restart(mon->rs);
3912 readline_show_prompt(mon->rs);
3914 mon->reset_seen = 1;
3918 case CHR_EVENT_CLOSED:
3920 monitor_fdsets_cleanup();
3926 compare_mon_cmd(const void *a, const void *b)
3928 return strcmp(((const mon_cmd_t *)a)->name,
3929 ((const mon_cmd_t *)b)->name);
3932 static void sortcmdlist(void)
3935 int elem_size = sizeof(mon_cmd_t);
3937 array_num = sizeof(mon_cmds)/elem_size-1;
3938 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
3940 array_num = sizeof(info_cmds)/elem_size-1;
3941 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
3944 /* These functions just adapt the readline interface in a typesafe way. We
3945 * could cast function pointers but that discards compiler checks.
3947 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
3948 const char *fmt, ...)
3952 monitor_vprintf(opaque, fmt, ap);
3956 static void monitor_readline_flush(void *opaque)
3958 monitor_flush(opaque);
3962 * Print to current monitor if we have one, else to stderr.
3963 * TODO should return int, so callers can calculate width, but that
3964 * requires surgery to monitor_vprintf(). Left for another day.
3966 void error_vprintf(const char *fmt, va_list ap)
3968 if (cur_mon && !monitor_cur_is_qmp()) {
3969 monitor_vprintf(cur_mon, fmt, ap);
3971 vfprintf(stderr, fmt, ap);
3975 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
3977 if (cur_mon && !monitor_cur_is_qmp()) {
3978 monitor_vprintf(cur_mon, fmt, ap);
3979 } else if (!cur_mon) {
3980 vfprintf(stderr, fmt, ap);
3984 static void __attribute__((constructor)) monitor_lock_init(void)
3986 qemu_mutex_init(&monitor_lock);
3989 void monitor_init(Chardev *chr, int flags)
3991 static int is_first_init = 1;
3994 if (is_first_init) {
3995 monitor_qapi_event_init();
4000 mon = g_malloc(sizeof(*mon));
4001 monitor_data_init(mon);
4003 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4005 if (flags & MONITOR_USE_READLINE) {
4006 mon->rs = readline_init(monitor_readline_printf,
4007 monitor_readline_flush,
4009 monitor_find_completion);
4010 monitor_read_command(mon, 0);
4013 if (monitor_is_qmp(mon)) {
4014 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4015 monitor_qmp_event, mon, NULL, true);
4016 qemu_chr_fe_set_echo(&mon->chr, true);
4017 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4019 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4020 monitor_event, mon, NULL, true);
4023 qemu_mutex_lock(&monitor_lock);
4024 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4025 qemu_mutex_unlock(&monitor_lock);
4028 void monitor_cleanup(void)
4030 Monitor *mon, *next;
4032 qemu_mutex_lock(&monitor_lock);
4033 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4034 QLIST_REMOVE(mon, entry);
4035 monitor_data_destroy(mon);
4038 qemu_mutex_unlock(&monitor_lock);
4041 static void bdrv_password_cb(void *opaque, const char *password,
4042 void *readline_opaque)
4044 Monitor *mon = opaque;
4045 BlockDriverState *bs = readline_opaque;
4047 Error *local_err = NULL;
4049 bdrv_add_key(bs, password, &local_err);
4051 error_report_err(local_err);
4054 if (mon->password_completion_cb)
4055 mon->password_completion_cb(mon->password_opaque, ret);
4057 monitor_read_command(mon, 1);
4060 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
4061 BlockCompletionFunc *completion_cb,
4066 monitor_printf(mon, "%s (%s) is encrypted.\n", bdrv_get_device_name(bs),
4067 bdrv_get_encrypted_filename(bs));
4069 mon->password_completion_cb = completion_cb;
4070 mon->password_opaque = opaque;
4072 err = monitor_read_password(mon, bdrv_password_cb, bs);
4074 if (err && completion_cb)
4075 completion_cb(opaque, err);
4080 int monitor_read_block_device_key(Monitor *mon, const char *device,
4081 BlockCompletionFunc *completion_cb,
4087 blk = blk_by_name(device);
4089 monitor_printf(mon, "Device not found %s\n", device);
4093 monitor_printf(mon, "Device '%s' has no medium\n", device);
4097 bdrv_add_key(blk_bs(blk), NULL, &err);
4100 return monitor_read_bdrv_key_start(mon, blk_bs(blk), completion_cb, opaque);
4103 if (completion_cb) {
4104 completion_cb(opaque, 0);
4109 QemuOptsList qemu_mon_opts = {
4111 .implied_opt_name = "chardev",
4112 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4116 .type = QEMU_OPT_STRING,
4119 .type = QEMU_OPT_STRING,
4121 .name = "default", /* deprecated */
4122 .type = QEMU_OPT_BOOL,
4125 .type = QEMU_OPT_BOOL,
4127 { /* end of list */ }
4132 void qmp_rtc_reset_reinjection(Error **errp)
4134 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4138 #ifndef TARGET_S390X
4139 void qmp_dump_skeys(const char *filename, Error **errp)
4141 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4146 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4148 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4153 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4155 MachineState *ms = MACHINE(qdev_get_machine());
4156 MachineClass *mc = MACHINE_GET_CLASS(ms);
4158 if (!mc->query_hotpluggable_cpus) {
4159 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4163 return mc->query_hotpluggable_cpus(ms);