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/numa.h"
41 #include "monitor/monitor.h"
42 #include "qemu/config-file.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/hw_accel.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"
62 #include "trace-root.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 "sysemu/cpus.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 QmpCommandList *commands;
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[];
224 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
228 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
230 static void monitor_command_cb(void *opaque, const char *cmdline,
231 void *readline_opaque);
234 * Is @mon a QMP monitor?
236 static inline bool monitor_is_qmp(const Monitor *mon)
238 return (mon->flags & MONITOR_USE_CONTROL);
242 * Is the current monitor, if any, a QMP monitor?
244 bool monitor_cur_is_qmp(void)
246 return cur_mon && monitor_is_qmp(cur_mon);
249 void monitor_read_command(Monitor *mon, int show_prompt)
254 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
256 readline_show_prompt(mon->rs);
259 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
263 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
264 /* prompt is printed on return from the command handler */
267 monitor_printf(mon, "terminal does not support password prompting\n");
272 static void monitor_flush_locked(Monitor *mon);
274 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
277 Monitor *mon = opaque;
279 qemu_mutex_lock(&mon->out_lock);
281 monitor_flush_locked(mon);
282 qemu_mutex_unlock(&mon->out_lock);
286 /* Called with mon->out_lock held. */
287 static void monitor_flush_locked(Monitor *mon)
293 if (mon->skip_flush) {
297 buf = qstring_get_str(mon->outbuf);
298 len = qstring_get_length(mon->outbuf);
300 if (len && !mon->mux_out) {
301 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
302 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
303 /* all flushed or error */
304 QDECREF(mon->outbuf);
305 mon->outbuf = qstring_new();
310 QString *tmp = qstring_from_str(buf + rc);
311 QDECREF(mon->outbuf);
314 if (mon->out_watch == 0) {
316 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
317 monitor_unblocked, mon);
322 void monitor_flush(Monitor *mon)
324 qemu_mutex_lock(&mon->out_lock);
325 monitor_flush_locked(mon);
326 qemu_mutex_unlock(&mon->out_lock);
329 /* flush at every end of line */
330 static void monitor_puts(Monitor *mon, const char *str)
334 qemu_mutex_lock(&mon->out_lock);
340 qstring_append_chr(mon->outbuf, '\r');
342 qstring_append_chr(mon->outbuf, c);
344 monitor_flush_locked(mon);
347 qemu_mutex_unlock(&mon->out_lock);
350 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
357 if (monitor_is_qmp(mon)) {
361 buf = g_strdup_vprintf(fmt, ap);
362 monitor_puts(mon, buf);
366 void monitor_printf(Monitor *mon, const char *fmt, ...)
370 monitor_vprintf(mon, fmt, ap);
374 int monitor_fprintf(FILE *stream, const char *fmt, ...)
378 monitor_vprintf((Monitor *)stream, fmt, ap);
383 static void monitor_json_emitter(Monitor *mon, const QObject *data)
387 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
388 qobject_to_json(data);
389 assert(json != NULL);
391 qstring_append_chr(json, '\n');
392 monitor_puts(mon, qstring_get_str(json));
397 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
398 /* Limit guest-triggerable events to 1 per second */
399 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
400 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
401 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
402 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
403 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
404 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
407 GHashTable *monitor_qapi_event_state;
410 * Emits the event to every monitor instance, @event is only used for trace
411 * Called with monitor_lock held.
413 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
417 trace_monitor_protocol_event_emit(event, qdict);
418 QLIST_FOREACH(mon, &mon_list, entry) {
419 if (monitor_is_qmp(mon)
420 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
421 monitor_json_emitter(mon, QOBJECT(qdict));
426 static void monitor_qapi_event_handler(void *opaque);
429 * Queue a new event for emission to Monitor instances,
430 * applying any rate limiting if required.
433 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
435 MonitorQAPIEventConf *evconf;
436 MonitorQAPIEventState *evstate;
438 assert(event < QAPI_EVENT__MAX);
439 evconf = &monitor_qapi_event_conf[event];
440 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
442 qemu_mutex_lock(&monitor_lock);
445 /* Unthrottled event */
446 monitor_qapi_event_emit(event, qdict);
448 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
449 MonitorQAPIEventState key = { .event = event, .data = data };
451 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
452 assert(!evstate || timer_pending(evstate->timer));
456 * Timer is pending for (at least) evconf->rate ns after
457 * last send. Store event for sending when timer fires,
458 * replacing a prior stored event if any.
460 QDECREF(evstate->qdict);
461 evstate->qdict = qdict;
462 QINCREF(evstate->qdict);
465 * Last send was (at least) evconf->rate ns ago.
466 * Send immediately, and arm the timer to call
467 * monitor_qapi_event_handler() in evconf->rate ns. Any
468 * events arriving before then will be delayed until then.
470 int64_t now = qemu_clock_get_ns(event_clock_type);
472 monitor_qapi_event_emit(event, qdict);
474 evstate = g_new(MonitorQAPIEventState, 1);
475 evstate->event = event;
476 evstate->data = data;
477 QINCREF(evstate->data);
478 evstate->qdict = NULL;
479 evstate->timer = timer_new_ns(event_clock_type,
480 monitor_qapi_event_handler,
482 g_hash_table_add(monitor_qapi_event_state, evstate);
483 timer_mod_ns(evstate->timer, now + evconf->rate);
487 qemu_mutex_unlock(&monitor_lock);
491 * This function runs evconf->rate ns after sending a throttled
493 * If another event has since been stored, send it.
495 static void monitor_qapi_event_handler(void *opaque)
497 MonitorQAPIEventState *evstate = opaque;
498 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
500 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
501 qemu_mutex_lock(&monitor_lock);
503 if (evstate->qdict) {
504 int64_t now = qemu_clock_get_ns(event_clock_type);
506 monitor_qapi_event_emit(evstate->event, evstate->qdict);
507 QDECREF(evstate->qdict);
508 evstate->qdict = NULL;
509 timer_mod_ns(evstate->timer, now + evconf->rate);
511 g_hash_table_remove(monitor_qapi_event_state, evstate);
512 QDECREF(evstate->data);
513 timer_free(evstate->timer);
517 qemu_mutex_unlock(&monitor_lock);
520 static unsigned int qapi_event_throttle_hash(const void *key)
522 const MonitorQAPIEventState *evstate = key;
523 unsigned int hash = evstate->event * 255;
525 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
526 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
529 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
530 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
536 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
538 const MonitorQAPIEventState *eva = a;
539 const MonitorQAPIEventState *evb = b;
541 if (eva->event != evb->event) {
545 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
546 return !strcmp(qdict_get_str(eva->data, "id"),
547 qdict_get_str(evb->data, "id"));
550 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
551 return !strcmp(qdict_get_str(eva->data, "node-name"),
552 qdict_get_str(evb->data, "node-name"));
558 static void monitor_qapi_event_init(void)
560 if (qtest_enabled()) {
561 event_clock_type = QEMU_CLOCK_VIRTUAL;
564 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
565 qapi_event_throttle_equal);
566 qmp_event_set_func_emit(monitor_qapi_event_queue);
569 static void handle_hmp_command(Monitor *mon, const char *cmdline);
571 static void monitor_data_init(Monitor *mon)
573 memset(mon, 0, sizeof(Monitor));
574 qemu_mutex_init(&mon->out_lock);
575 mon->outbuf = qstring_new();
576 /* Use *mon_cmds by default. */
577 mon->cmd_table = mon_cmds;
580 static void monitor_data_destroy(Monitor *mon)
582 qemu_chr_fe_deinit(&mon->chr);
583 if (monitor_is_qmp(mon)) {
584 json_message_parser_destroy(&mon->qmp.parser);
587 QDECREF(mon->outbuf);
588 qemu_mutex_destroy(&mon->out_lock);
591 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
592 int64_t cpu_index, Error **errp)
595 Monitor *old_mon, hmp;
597 monitor_data_init(&hmp);
598 hmp.skip_flush = true;
604 int ret = monitor_set_cpu(cpu_index);
607 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
613 handle_hmp_command(&hmp, command_line);
616 qemu_mutex_lock(&hmp.out_lock);
617 if (qstring_get_length(hmp.outbuf) > 0) {
618 output = g_strdup(qstring_get_str(hmp.outbuf));
620 output = g_strdup("");
622 qemu_mutex_unlock(&hmp.out_lock);
625 monitor_data_destroy(&hmp);
629 static int compare_cmd(const char *name, const char *list)
631 const char *p, *pstart;
639 p = pstart + strlen(pstart);
640 if ((p - pstart) == len && !memcmp(pstart, name, len))
649 static int get_str(char *buf, int buf_size, const char **pp)
657 while (qemu_isspace(*p)) {
668 while (*p != '\0' && *p != '\"') {
684 printf("unsupported escape code: '\\%c'\n", c);
687 if ((q - buf) < buf_size - 1) {
691 if ((q - buf) < buf_size - 1) {
698 printf("unterminated string\n");
703 while (*p != '\0' && !qemu_isspace(*p)) {
704 if ((q - buf) < buf_size - 1) {
717 static void free_cmdline_args(char **args, int nb_args)
721 assert(nb_args <= MAX_ARGS);
723 for (i = 0; i < nb_args; i++) {
730 * Parse the command line to get valid args.
731 * @cmdline: command line to be parsed.
732 * @pnb_args: location to store the number of args, must NOT be NULL.
733 * @args: location to store the args, which should be freed by caller, must
736 * Returns 0 on success, negative on failure.
738 * NOTE: this parser is an approximate form of the real command parser. Number
739 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
740 * return with failure.
742 static int parse_cmdline(const char *cmdline,
743 int *pnb_args, char **args)
752 while (qemu_isspace(*p)) {
758 if (nb_args >= MAX_ARGS) {
761 ret = get_str(buf, sizeof(buf), &p);
765 args[nb_args] = g_strdup(buf);
772 free_cmdline_args(args, nb_args);
776 static void help_cmd_dump_one(Monitor *mon,
777 const mon_cmd_t *cmd,
783 for (i = 0; i < prefix_args_nb; i++) {
784 monitor_printf(mon, "%s ", prefix_args[i]);
786 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
789 /* @args[@arg_index] is the valid command need to find in @cmds */
790 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
791 char **args, int nb_args, int arg_index)
793 const mon_cmd_t *cmd;
795 /* No valid arg need to compare with, dump all in *cmds */
796 if (arg_index >= nb_args) {
797 for (cmd = cmds; cmd->name != NULL; cmd++) {
798 help_cmd_dump_one(mon, cmd, args, arg_index);
803 /* Find one entry to dump */
804 for (cmd = cmds; cmd->name != NULL; cmd++) {
805 if (compare_cmd(args[arg_index], cmd->name)) {
806 if (cmd->sub_table) {
807 /* continue with next arg */
808 help_cmd_dump(mon, cmd->sub_table,
809 args, nb_args, arg_index + 1);
811 help_cmd_dump_one(mon, cmd, args, arg_index);
818 static void help_cmd(Monitor *mon, const char *name)
820 char *args[MAX_ARGS];
823 /* 1. parse user input */
825 /* special case for log, directly dump and return */
826 if (!strcmp(name, "log")) {
827 const QEMULogItem *item;
828 monitor_printf(mon, "Log items (comma separated):\n");
829 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
830 for (item = qemu_log_items; item->mask != 0; item++) {
831 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
836 if (parse_cmdline(name, &nb_args, args) < 0) {
841 /* 2. dump the contents according to parsed args */
842 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
844 free_cmdline_args(args, nb_args);
847 static void do_help_cmd(Monitor *mon, const QDict *qdict)
849 help_cmd(mon, qdict_get_try_str(qdict, "name"));
852 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
854 const char *tp_name = qdict_get_str(qdict, "name");
855 bool new_state = qdict_get_bool(qdict, "option");
856 bool has_vcpu = qdict_haskey(qdict, "vcpu");
857 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
858 Error *local_err = NULL;
861 monitor_printf(mon, "argument vcpu must be positive");
865 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
867 error_report_err(local_err);
871 #ifdef CONFIG_TRACE_SIMPLE
872 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
874 const char *op = qdict_get_try_str(qdict, "op");
875 const char *arg = qdict_get_try_str(qdict, "arg");
878 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
879 } else if (!strcmp(op, "on")) {
880 st_set_trace_file_enabled(true);
881 } else if (!strcmp(op, "off")) {
882 st_set_trace_file_enabled(false);
883 } else if (!strcmp(op, "flush")) {
884 st_flush_trace_buffer();
885 } else if (!strcmp(op, "set")) {
887 st_set_trace_file(arg);
890 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
891 help_cmd(mon, "trace-file");
896 static void hmp_info_help(Monitor *mon, const QDict *qdict)
898 help_cmd(mon, "info");
901 static void query_commands_cb(QmpCommand *cmd, void *opaque)
903 CommandInfoList *info, **list = opaque;
909 info = g_malloc0(sizeof(*info));
910 info->value = g_malloc0(sizeof(*info->value));
911 info->value->name = g_strdup(cmd->name);
916 CommandInfoList *qmp_query_commands(Error **errp)
918 CommandInfoList *list = NULL;
920 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
925 EventInfoList *qmp_query_events(Error **errp)
927 EventInfoList *info, *ev_list = NULL;
930 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
931 const char *event_name = QAPIEvent_lookup[e];
932 assert(event_name != NULL);
933 info = g_malloc0(sizeof(*info));
934 info->value = g_malloc0(sizeof(*info->value));
935 info->value->name = g_strdup(event_name);
937 info->next = ev_list;
945 * Minor hack: generated marshalling suppressed for this command
946 * ('gen': false in the schema) so we can parse the JSON string
947 * directly into QObject instead of first parsing it with
948 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
949 * to QObject with generated output marshallers, every time. Instead,
950 * we do it in test-qobject-input-visitor.c, just to make sure
951 * qapi-introspect.py's output actually conforms to the schema.
953 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
956 *ret_data = qobject_from_json(qmp_schema_json, &error_abort);
960 * We used to define commands in qmp-commands.hx in addition to the
961 * QAPI schema. This permitted defining some of them only in certain
962 * configurations. query-commands has always reflected that (good,
963 * because it lets QMP clients figure out what's actually available),
964 * while query-qmp-schema never did (not so good). This function is a
965 * hack to keep the configuration-specific commands defined exactly as
966 * before, even though qmp-commands.hx is gone.
968 * FIXME Educate the QAPI schema on configuration-specific commands,
969 * and drop this hack.
971 static void qmp_unregister_commands_hack(void)
974 qmp_unregister_command(&qmp_commands, "query-spice");
976 #ifndef CONFIG_REPLICATION
977 qmp_unregister_command(&qmp_commands, "xen-set-replication");
978 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
979 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
982 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
985 qmp_unregister_command(&qmp_commands, "dump-skeys");
988 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
990 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
991 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
993 #if !defined(TARGET_S390X)
994 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
995 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
997 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
998 && !defined(TARGET_S390X)
999 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1003 void monitor_init_qmp_commands(void)
1006 * Two command lists:
1007 * - qmp_commands contains all QMP commands
1008 * - qmp_cap_negotiation_commands contains just
1009 * "qmp_capabilities", to enforce capability negotiation
1012 qmp_init_marshal(&qmp_commands);
1014 qmp_register_command(&qmp_commands, "query-qmp-schema",
1015 qmp_query_qmp_schema,
1017 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1019 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1022 qmp_unregister_commands_hack();
1024 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1025 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1026 qmp_marshal_qmp_capabilities, QCO_NO_OPTIONS);
1029 void qmp_qmp_capabilities(Error **errp)
1031 if (cur_mon->qmp.commands == &qmp_commands) {
1032 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1033 "Capabilities negotiation is already complete, command "
1038 cur_mon->qmp.commands = &qmp_commands;
1041 /* set the current CPU defined by the user */
1042 int monitor_set_cpu(int cpu_index)
1046 cpu = qemu_get_cpu(cpu_index);
1050 cur_mon->mon_cpu = cpu;
1054 CPUState *mon_get_cpu(void)
1056 if (!cur_mon->mon_cpu) {
1060 monitor_set_cpu(first_cpu->cpu_index);
1062 cpu_synchronize_state(cur_mon->mon_cpu);
1063 return cur_mon->mon_cpu;
1066 CPUArchState *mon_get_cpu_env(void)
1068 CPUState *cs = mon_get_cpu();
1070 return cs ? cs->env_ptr : NULL;
1073 int monitor_get_cpu_index(void)
1075 CPUState *cs = mon_get_cpu();
1077 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1080 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1082 CPUState *cs = mon_get_cpu();
1085 monitor_printf(mon, "No CPU available\n");
1088 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1091 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1093 if (!tcg_enabled()) {
1094 error_report("JIT information is only available with accel=tcg");
1098 dump_exec_info((FILE *)mon, monitor_fprintf);
1099 dump_drift_info((FILE *)mon, monitor_fprintf);
1102 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1104 dump_opcount_info((FILE *)mon, monitor_fprintf);
1107 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1116 str = readline_get_history(mon->rs, i);
1119 monitor_printf(mon, "%d: '%s'\n", i, str);
1124 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1126 CPUState *cs = mon_get_cpu();
1129 monitor_printf(mon, "No CPU available\n");
1132 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1135 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1137 const char *name = qdict_get_try_str(qdict, "name");
1138 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1139 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1140 TraceEventInfoList *events;
1141 TraceEventInfoList *elem;
1142 Error *local_err = NULL;
1148 monitor_printf(mon, "argument vcpu must be positive");
1152 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1154 error_report_err(local_err);
1158 for (elem = events; elem != NULL; elem = elem->next) {
1159 monitor_printf(mon, "%s : state %u\n",
1161 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1163 qapi_free_TraceEventInfoList(events);
1166 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1167 bool has_port, int64_t port,
1168 bool has_tls_port, int64_t tls_port,
1169 bool has_cert_subject, const char *cert_subject,
1172 if (strcmp(protocol, "spice") == 0) {
1173 if (!qemu_using_spice(errp)) {
1177 if (!has_port && !has_tls_port) {
1178 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1182 if (qemu_spice_migrate_info(hostname,
1183 has_port ? port : -1,
1184 has_tls_port ? tls_port : -1,
1186 error_setg(errp, QERR_UNDEFINED_ERROR);
1192 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1195 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1199 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1201 error_report_err(err);
1205 static void hmp_log(Monitor *mon, const QDict *qdict)
1208 const char *items = qdict_get_str(qdict, "items");
1210 if (!strcmp(items, "none")) {
1213 mask = qemu_str_to_log_mask(items);
1215 help_cmd(mon, "log");
1222 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1224 const char *option = qdict_get_try_str(qdict, "option");
1225 if (!option || !strcmp(option, "on")) {
1227 } else if (!strcmp(option, "off")) {
1230 monitor_printf(mon, "unexpected option %s\n", option);
1234 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1236 const char *device = qdict_get_try_str(qdict, "device");
1238 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1239 if (gdbserver_start(device) < 0) {
1240 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1242 } else if (strcmp(device, "none") == 0) {
1243 monitor_printf(mon, "Disabled gdbserver\n");
1245 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1250 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1252 const char *action = qdict_get_str(qdict, "action");
1253 if (select_watchdog_action(action) == -1) {
1254 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1258 static void monitor_printc(Monitor *mon, int c)
1260 monitor_printf(mon, "'");
1263 monitor_printf(mon, "\\'");
1266 monitor_printf(mon, "\\\\");
1269 monitor_printf(mon, "\\n");
1272 monitor_printf(mon, "\\r");
1275 if (c >= 32 && c <= 126) {
1276 monitor_printf(mon, "%c", c);
1278 monitor_printf(mon, "\\x%02x", c);
1282 monitor_printf(mon, "'");
1285 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1286 hwaddr addr, int is_physical)
1288 int l, line_size, i, max_digits, len;
1291 CPUState *cs = mon_get_cpu();
1293 if (!cs && (format == 'i' || !is_physical)) {
1294 monitor_printf(mon, "Can not dump without CPU\n");
1298 if (format == 'i') {
1301 CPUArchState *env = mon_get_cpu_env();
1304 } else if (wsize == 4) {
1307 /* as default we use the current CS size */
1310 #ifdef TARGET_X86_64
1311 if ((env->efer & MSR_EFER_LMA) &&
1312 (env->segs[R_CS].flags & DESC_L_MASK))
1316 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1322 CPUArchState *env = mon_get_cpu_env();
1323 flags = msr_le << 16;
1324 flags |= env->bfd_mach;
1326 monitor_disas(mon, cs, addr, count, is_physical, flags);
1330 len = wsize * count;
1339 max_digits = (wsize * 8 + 2) / 3;
1343 max_digits = (wsize * 8) / 4;
1347 max_digits = (wsize * 8 * 10 + 32) / 33;
1356 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1358 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1363 cpu_physical_memory_read(addr, buf, l);
1365 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1366 monitor_printf(mon, " Cannot access memory\n");
1375 v = ldub_p(buf + i);
1378 v = lduw_p(buf + i);
1381 v = (uint32_t)ldl_p(buf + i);
1387 monitor_printf(mon, " ");
1390 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1393 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1396 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1399 monitor_printf(mon, "%*" PRId64, max_digits, v);
1402 monitor_printc(mon, v);
1407 monitor_printf(mon, "\n");
1413 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1415 int count = qdict_get_int(qdict, "count");
1416 int format = qdict_get_int(qdict, "format");
1417 int size = qdict_get_int(qdict, "size");
1418 target_long addr = qdict_get_int(qdict, "addr");
1420 memory_dump(mon, count, format, size, addr, 0);
1423 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1425 int count = qdict_get_int(qdict, "count");
1426 int format = qdict_get_int(qdict, "format");
1427 int size = qdict_get_int(qdict, "size");
1428 hwaddr addr = qdict_get_int(qdict, "addr");
1430 memory_dump(mon, count, format, size, addr, 1);
1433 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1435 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1439 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1443 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1444 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1445 memory_region_unref(mrs.mr);
1450 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1453 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1455 hwaddr addr = qdict_get_int(qdict, "addr");
1456 Error *local_err = NULL;
1457 MemoryRegion *mr = NULL;
1460 ptr = gpa2hva(&mr, addr, &local_err);
1462 error_report_err(local_err);
1466 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1468 addr, mr->name, ptr);
1470 memory_region_unref(mr);
1474 static uint64_t vtop(void *ptr, Error **errp)
1478 uintptr_t addr = (uintptr_t) ptr;
1479 uintptr_t pagesize = getpagesize();
1480 off_t offset = addr / pagesize * sizeof(pinfo);
1483 fd = open("/proc/self/pagemap", O_RDONLY);
1485 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1489 /* Force copy-on-write if necessary. */
1490 atomic_add((uint8_t *)ptr, 0);
1492 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1493 error_setg_errno(errp, errno, "Cannot read pagemap");
1496 if ((pinfo & (1ull << 63)) == 0) {
1497 error_setg(errp, "Page not present");
1500 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1507 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1509 hwaddr addr = qdict_get_int(qdict, "addr");
1510 Error *local_err = NULL;
1511 MemoryRegion *mr = NULL;
1515 ptr = gpa2hva(&mr, addr, &local_err);
1517 error_report_err(local_err);
1521 physaddr = vtop(ptr, &local_err);
1523 error_report_err(local_err);
1525 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1526 " (%s) is 0x%" PRIx64 "\n",
1527 addr, mr->name, (uint64_t) physaddr);
1530 memory_region_unref(mr);
1534 static void do_print(Monitor *mon, const QDict *qdict)
1536 int format = qdict_get_int(qdict, "format");
1537 hwaddr val = qdict_get_int(qdict, "val");
1541 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1544 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1547 monitor_printf(mon, "%" HWADDR_PRIu, val);
1551 monitor_printf(mon, "%" HWADDR_PRId, val);
1554 monitor_printc(mon, val);
1557 monitor_printf(mon, "\n");
1560 static void hmp_sum(Monitor *mon, const QDict *qdict)
1564 uint32_t start = qdict_get_int(qdict, "start");
1565 uint32_t size = qdict_get_int(qdict, "size");
1568 for(addr = start; addr < (start + size); addr++) {
1569 uint8_t val = address_space_ldub(&address_space_memory, addr,
1570 MEMTXATTRS_UNSPECIFIED, NULL);
1571 /* BSD sum algorithm ('sum' Unix command) */
1572 sum = (sum >> 1) | (sum << 15);
1575 monitor_printf(mon, "%05d\n", sum);
1578 static int mouse_button_state;
1580 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1582 int dx, dy, dz, button;
1583 const char *dx_str = qdict_get_str(qdict, "dx_str");
1584 const char *dy_str = qdict_get_str(qdict, "dy_str");
1585 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1587 dx = strtol(dx_str, NULL, 0);
1588 dy = strtol(dy_str, NULL, 0);
1589 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1590 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1593 dz = strtol(dz_str, NULL, 0);
1595 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1596 qemu_input_queue_btn(NULL, button, true);
1597 qemu_input_event_sync();
1598 qemu_input_queue_btn(NULL, button, false);
1601 qemu_input_event_sync();
1604 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1606 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1607 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1608 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1609 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1611 int button_state = qdict_get_int(qdict, "button_state");
1613 if (mouse_button_state == button_state) {
1616 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1617 qemu_input_event_sync();
1618 mouse_button_state = button_state;
1621 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1623 int size = qdict_get_int(qdict, "size");
1624 int addr = qdict_get_int(qdict, "addr");
1625 int has_index = qdict_haskey(qdict, "index");
1630 int index = qdict_get_int(qdict, "index");
1631 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1639 val = cpu_inb(addr);
1643 val = cpu_inw(addr);
1647 val = cpu_inl(addr);
1651 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1652 suffix, addr, size * 2, val);
1655 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1657 int size = qdict_get_int(qdict, "size");
1658 int addr = qdict_get_int(qdict, "addr");
1659 int val = qdict_get_int(qdict, "val");
1661 addr &= IOPORTS_MASK;
1666 cpu_outb(addr, val);
1669 cpu_outw(addr, val);
1672 cpu_outl(addr, val);
1677 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1679 Error *local_err = NULL;
1680 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1682 qemu_boot_set(bootdevice, &local_err);
1684 error_report_err(local_err);
1686 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1690 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1692 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1694 mtree_info((fprintf_function)monitor_printf, mon, flatview);
1697 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1703 node_mem = g_new0(uint64_t, nb_numa_nodes);
1704 query_numa_node_mem(node_mem);
1705 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1706 for (i = 0; i < nb_numa_nodes; i++) {
1707 monitor_printf(mon, "node %d cpus:", i);
1709 if (cpu->numa_node == i) {
1710 monitor_printf(mon, " %d", cpu->cpu_index);
1713 monitor_printf(mon, "\n");
1714 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1720 #ifdef CONFIG_PROFILER
1725 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1727 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1728 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1729 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1730 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1735 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1737 monitor_printf(mon, "Internal profiler not compiled\n");
1741 /* Capture support */
1742 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1744 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1749 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1750 monitor_printf(mon, "[%d]: ", i);
1751 s->ops.info (s->opaque);
1755 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1758 int n = qdict_get_int(qdict, "n");
1761 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1763 s->ops.destroy (s->opaque);
1764 QLIST_REMOVE (s, entries);
1771 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1773 const char *path = qdict_get_str(qdict, "path");
1774 int has_freq = qdict_haskey(qdict, "freq");
1775 int freq = qdict_get_try_int(qdict, "freq", -1);
1776 int has_bits = qdict_haskey(qdict, "bits");
1777 int bits = qdict_get_try_int(qdict, "bits", -1);
1778 int has_channels = qdict_haskey(qdict, "nchannels");
1779 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1782 s = g_malloc0 (sizeof (*s));
1784 freq = has_freq ? freq : 44100;
1785 bits = has_bits ? bits : 16;
1786 nchannels = has_channels ? nchannels : 2;
1788 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1789 monitor_printf(mon, "Failed to add wave capture\n");
1793 QLIST_INSERT_HEAD (&capture_head, s, entries);
1796 static qemu_acl *find_acl(Monitor *mon, const char *name)
1798 qemu_acl *acl = qemu_acl_find(name);
1801 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1806 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1808 const char *aclname = qdict_get_str(qdict, "aclname");
1809 qemu_acl *acl = find_acl(mon, aclname);
1810 qemu_acl_entry *entry;
1814 monitor_printf(mon, "policy: %s\n",
1815 acl->defaultDeny ? "deny" : "allow");
1816 QTAILQ_FOREACH(entry, &acl->entries, next) {
1818 monitor_printf(mon, "%d: %s %s\n", i,
1819 entry->deny ? "deny" : "allow", entry->match);
1824 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1826 const char *aclname = qdict_get_str(qdict, "aclname");
1827 qemu_acl *acl = find_acl(mon, aclname);
1830 qemu_acl_reset(acl);
1831 monitor_printf(mon, "acl: removed all rules\n");
1835 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1837 const char *aclname = qdict_get_str(qdict, "aclname");
1838 const char *policy = qdict_get_str(qdict, "policy");
1839 qemu_acl *acl = find_acl(mon, aclname);
1842 if (strcmp(policy, "allow") == 0) {
1843 acl->defaultDeny = 0;
1844 monitor_printf(mon, "acl: policy set to 'allow'\n");
1845 } else if (strcmp(policy, "deny") == 0) {
1846 acl->defaultDeny = 1;
1847 monitor_printf(mon, "acl: policy set to 'deny'\n");
1849 monitor_printf(mon, "acl: unknown policy '%s', "
1850 "expected 'deny' or 'allow'\n", policy);
1855 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1857 const char *aclname = qdict_get_str(qdict, "aclname");
1858 const char *match = qdict_get_str(qdict, "match");
1859 const char *policy = qdict_get_str(qdict, "policy");
1860 int has_index = qdict_haskey(qdict, "index");
1861 int index = qdict_get_try_int(qdict, "index", -1);
1862 qemu_acl *acl = find_acl(mon, aclname);
1866 if (strcmp(policy, "allow") == 0) {
1868 } else if (strcmp(policy, "deny") == 0) {
1871 monitor_printf(mon, "acl: unknown policy '%s', "
1872 "expected 'deny' or 'allow'\n", policy);
1876 ret = qemu_acl_insert(acl, deny, match, index);
1878 ret = qemu_acl_append(acl, deny, match);
1880 monitor_printf(mon, "acl: unable to add acl entry\n");
1882 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1886 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1888 const char *aclname = qdict_get_str(qdict, "aclname");
1889 const char *match = qdict_get_str(qdict, "match");
1890 qemu_acl *acl = find_acl(mon, aclname);
1894 ret = qemu_acl_remove(acl, match);
1896 monitor_printf(mon, "acl: no matching acl entry\n");
1898 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1902 void qmp_getfd(const char *fdname, Error **errp)
1907 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1909 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1913 if (qemu_isdigit(fdname[0])) {
1915 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1916 "a name not starting with a digit");
1920 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1921 if (strcmp(monfd->name, fdname) != 0) {
1930 monfd = g_malloc0(sizeof(mon_fd_t));
1931 monfd->name = g_strdup(fdname);
1934 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1937 void qmp_closefd(const char *fdname, Error **errp)
1941 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1942 if (strcmp(monfd->name, fdname) != 0) {
1946 QLIST_REMOVE(monfd, next);
1948 g_free(monfd->name);
1953 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1956 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1960 QLIST_FOREACH(monfd, &mon->fds, next) {
1963 if (strcmp(monfd->name, fdname) != 0) {
1969 /* caller takes ownership of fd */
1970 QLIST_REMOVE(monfd, next);
1971 g_free(monfd->name);
1977 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1981 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1983 MonFdsetFd *mon_fdset_fd;
1984 MonFdsetFd *mon_fdset_fd_next;
1986 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
1987 if ((mon_fdset_fd->removed ||
1988 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
1989 runstate_is_running()) {
1990 close(mon_fdset_fd->fd);
1991 g_free(mon_fdset_fd->opaque);
1992 QLIST_REMOVE(mon_fdset_fd, next);
1993 g_free(mon_fdset_fd);
1997 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
1998 QLIST_REMOVE(mon_fdset, next);
2003 static void monitor_fdsets_cleanup(void)
2005 MonFdset *mon_fdset;
2006 MonFdset *mon_fdset_next;
2008 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2009 monitor_fdset_cleanup(mon_fdset);
2013 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2014 const char *opaque, Error **errp)
2017 Monitor *mon = cur_mon;
2020 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2022 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2026 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2027 has_opaque, opaque, errp);
2039 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2041 MonFdset *mon_fdset;
2042 MonFdsetFd *mon_fdset_fd;
2045 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2046 if (mon_fdset->id != fdset_id) {
2049 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2051 if (mon_fdset_fd->fd != fd) {
2054 mon_fdset_fd->removed = true;
2057 mon_fdset_fd->removed = true;
2060 if (has_fd && !mon_fdset_fd) {
2063 monitor_fdset_cleanup(mon_fdset);
2069 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2072 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2074 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2077 FdsetInfoList *qmp_query_fdsets(Error **errp)
2079 MonFdset *mon_fdset;
2080 MonFdsetFd *mon_fdset_fd;
2081 FdsetInfoList *fdset_list = NULL;
2083 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2084 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2085 FdsetFdInfoList *fdsetfd_list = NULL;
2087 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2088 fdset_info->value->fdset_id = mon_fdset->id;
2090 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2091 FdsetFdInfoList *fdsetfd_info;
2093 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2094 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2095 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2096 if (mon_fdset_fd->opaque) {
2097 fdsetfd_info->value->has_opaque = true;
2098 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2100 fdsetfd_info->value->has_opaque = false;
2103 fdsetfd_info->next = fdsetfd_list;
2104 fdsetfd_list = fdsetfd_info;
2107 fdset_info->value->fds = fdsetfd_list;
2109 fdset_info->next = fdset_list;
2110 fdset_list = fdset_info;
2116 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2117 bool has_opaque, const char *opaque,
2120 MonFdset *mon_fdset = NULL;
2121 MonFdsetFd *mon_fdset_fd;
2125 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2126 /* Break if match found or match impossible due to ordering by ID */
2127 if (fdset_id <= mon_fdset->id) {
2128 if (fdset_id < mon_fdset->id) {
2136 if (mon_fdset == NULL) {
2137 int64_t fdset_id_prev = -1;
2138 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2142 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2143 "a non-negative value");
2146 /* Use specified fdset ID */
2147 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2148 mon_fdset_cur = mon_fdset;
2149 if (fdset_id < mon_fdset_cur->id) {
2154 /* Use first available fdset ID */
2155 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2156 mon_fdset_cur = mon_fdset;
2157 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2158 fdset_id_prev = mon_fdset_cur->id;
2165 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2167 mon_fdset->id = fdset_id;
2169 mon_fdset->id = fdset_id_prev + 1;
2172 /* The fdset list is ordered by fdset ID */
2173 if (!mon_fdset_cur) {
2174 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2175 } else if (mon_fdset->id < mon_fdset_cur->id) {
2176 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2178 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2182 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2183 mon_fdset_fd->fd = fd;
2184 mon_fdset_fd->removed = false;
2186 mon_fdset_fd->opaque = g_strdup(opaque);
2188 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2190 fdinfo = g_malloc0(sizeof(*fdinfo));
2191 fdinfo->fdset_id = mon_fdset->id;
2192 fdinfo->fd = mon_fdset_fd->fd;
2197 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2200 MonFdset *mon_fdset;
2201 MonFdsetFd *mon_fdset_fd;
2204 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2205 if (mon_fdset->id != fdset_id) {
2208 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2209 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2210 if (mon_fd_flags == -1) {
2214 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2215 return mon_fdset_fd->fd;
2227 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2229 MonFdset *mon_fdset;
2230 MonFdsetFd *mon_fdset_fd_dup;
2232 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2233 if (mon_fdset->id != fdset_id) {
2236 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2237 if (mon_fdset_fd_dup->fd == dup_fd) {
2241 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2242 mon_fdset_fd_dup->fd = dup_fd;
2243 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2249 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2251 MonFdset *mon_fdset;
2252 MonFdsetFd *mon_fdset_fd_dup;
2254 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2255 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2256 if (mon_fdset_fd_dup->fd == dup_fd) {
2258 QLIST_REMOVE(mon_fdset_fd_dup, next);
2259 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2260 monitor_fdset_cleanup(mon_fdset);
2264 return mon_fdset->id;
2272 int monitor_fdset_dup_fd_find(int dup_fd)
2274 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2277 void monitor_fdset_dup_fd_remove(int dup_fd)
2279 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2282 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2285 Error *local_err = NULL;
2287 if (!qemu_isdigit(fdname[0]) && mon) {
2288 fd = monitor_get_fd(mon, fdname, &local_err);
2290 fd = qemu_parse_fd(fdname);
2292 error_setg(&local_err, "Invalid file descriptor number '%s'",
2297 error_propagate(errp, local_err);
2306 /* Please update hmp-commands.hx when adding or changing commands */
2307 static mon_cmd_t info_cmds[] = {
2308 #include "hmp-commands-info.h"
2312 /* mon_cmds and info_cmds would be sorted at runtime */
2313 static mon_cmd_t mon_cmds[] = {
2314 #include "hmp-commands.h"
2318 /*******************************************************************/
2320 static const char *pch;
2321 static sigjmp_buf expr_env;
2324 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2325 expr_error(Monitor *mon, const char *fmt, ...)
2329 monitor_vprintf(mon, fmt, ap);
2330 monitor_printf(mon, "\n");
2332 siglongjmp(expr_env, 1);
2335 /* return 0 if OK, -1 if not found */
2336 static int get_monitor_def(target_long *pval, const char *name)
2338 const MonitorDef *md = target_monitor_defs();
2339 CPUState *cs = mon_get_cpu();
2344 if (cs == NULL || md == NULL) {
2348 for(; md->name != NULL; md++) {
2349 if (compare_cmd(name, md->name)) {
2350 if (md->get_value) {
2351 *pval = md->get_value(md, md->offset);
2353 CPUArchState *env = mon_get_cpu_env();
2354 ptr = (uint8_t *)env + md->offset;
2357 *pval = *(int32_t *)ptr;
2360 *pval = *(target_long *)ptr;
2371 ret = target_get_monitor_def(cs, name, &tmp);
2373 *pval = (target_long) tmp;
2379 static void next(void)
2383 while (qemu_isspace(*pch))
2388 static int64_t expr_sum(Monitor *mon);
2390 static int64_t expr_unary(Monitor *mon)
2399 n = expr_unary(mon);
2403 n = -expr_unary(mon);
2407 n = ~expr_unary(mon);
2413 expr_error(mon, "')' expected");
2420 expr_error(mon, "character constant expected");
2424 expr_error(mon, "missing terminating \' character");
2434 while ((*pch >= 'a' && *pch <= 'z') ||
2435 (*pch >= 'A' && *pch <= 'Z') ||
2436 (*pch >= '0' && *pch <= '9') ||
2437 *pch == '_' || *pch == '.') {
2438 if ((q - buf) < sizeof(buf) - 1)
2442 while (qemu_isspace(*pch))
2445 ret = get_monitor_def(®, buf);
2447 expr_error(mon, "unknown register");
2452 expr_error(mon, "unexpected end of expression");
2457 n = strtoull(pch, &p, 0);
2458 if (errno == ERANGE) {
2459 expr_error(mon, "number too large");
2462 expr_error(mon, "invalid char '%c' in expression", *p);
2465 while (qemu_isspace(*pch))
2473 static int64_t expr_prod(Monitor *mon)
2478 val = expr_unary(mon);
2481 if (op != '*' && op != '/' && op != '%')
2484 val2 = expr_unary(mon);
2493 expr_error(mon, "division by zero");
2504 static int64_t expr_logic(Monitor *mon)
2509 val = expr_prod(mon);
2512 if (op != '&' && op != '|' && op != '^')
2515 val2 = expr_prod(mon);
2532 static int64_t expr_sum(Monitor *mon)
2537 val = expr_logic(mon);
2540 if (op != '+' && op != '-')
2543 val2 = expr_logic(mon);
2552 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2555 if (sigsetjmp(expr_env, 0)) {
2559 while (qemu_isspace(*pch))
2561 *pval = expr_sum(mon);
2566 static int get_double(Monitor *mon, double *pval, const char **pp)
2568 const char *p = *pp;
2572 d = strtod(p, &tailp);
2574 monitor_printf(mon, "Number expected\n");
2577 if (d != d || d - d != 0) {
2578 /* NaN or infinity */
2579 monitor_printf(mon, "Bad number\n");
2588 * Store the command-name in cmdname, and return a pointer to
2589 * the remaining of the command string.
2591 static const char *get_command_name(const char *cmdline,
2592 char *cmdname, size_t nlen)
2595 const char *p, *pstart;
2598 while (qemu_isspace(*p))
2603 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2608 memcpy(cmdname, pstart, len);
2609 cmdname[len] = '\0';
2614 * Read key of 'type' into 'key' and return the current
2617 static char *key_get_info(const char *type, char **key)
2625 p = strchr(type, ':');
2632 str = g_malloc(len + 1);
2633 memcpy(str, type, len);
2640 static int default_fmt_format = 'x';
2641 static int default_fmt_size = 4;
2643 static int is_valid_option(const char *c, const char *typestr)
2651 typestr = strstr(typestr, option);
2652 return (typestr != NULL);
2655 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2656 const char *cmdname)
2658 const mon_cmd_t *cmd;
2660 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2661 if (compare_cmd(cmdname, cmd->name)) {
2670 * Parse command name from @cmdp according to command table @table.
2671 * If blank, return NULL.
2672 * Else, if no valid command can be found, report to @mon, and return
2674 * Else, change @cmdp to point right behind the name, and return its
2675 * command table entry.
2676 * Do not assume the return value points into @table! It doesn't when
2677 * the command is found in a sub-command table.
2679 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2684 const mon_cmd_t *cmd;
2687 /* extract the command name */
2688 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2692 cmd = search_dispatch_table(table, cmdname);
2694 monitor_printf(mon, "unknown command: '%.*s'\n",
2695 (int)(p - *cmdp), *cmdp);
2699 /* filter out following useless space */
2700 while (qemu_isspace(*p)) {
2705 /* search sub command */
2706 if (cmd->sub_table != NULL && *p != '\0') {
2707 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2714 * Parse arguments for @cmd.
2715 * If it can't be parsed, report to @mon, and return NULL.
2716 * Else, insert command arguments into a QDict, and return it.
2717 * Note: On success, caller has to free the QDict structure.
2720 static QDict *monitor_parse_arguments(Monitor *mon,
2722 const mon_cmd_t *cmd)
2724 const char *typestr;
2727 const char *p = *endp;
2729 QDict *qdict = qdict_new();
2731 /* parse the parameters */
2732 typestr = cmd->args_type;
2734 typestr = key_get_info(typestr, &key);
2746 while (qemu_isspace(*p))
2748 if (*typestr == '?') {
2751 /* no optional string: NULL argument */
2755 ret = get_str(buf, sizeof(buf), &p);
2759 monitor_printf(mon, "%s: filename expected\n",
2763 monitor_printf(mon, "%s: block device name expected\n",
2767 monitor_printf(mon, "%s: string expected\n", cmd->name);
2772 qdict_put_str(qdict, key, buf);
2777 QemuOptsList *opts_list;
2780 opts_list = qemu_find_opts(key);
2781 if (!opts_list || opts_list->desc->name) {
2784 while (qemu_isspace(*p)) {
2789 if (get_str(buf, sizeof(buf), &p) < 0) {
2792 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2796 qemu_opts_to_qdict(opts, qdict);
2797 qemu_opts_del(opts);
2802 int count, format, size;
2804 while (qemu_isspace(*p))
2810 if (qemu_isdigit(*p)) {
2812 while (qemu_isdigit(*p)) {
2813 count = count * 10 + (*p - '0');
2851 if (*p != '\0' && !qemu_isspace(*p)) {
2852 monitor_printf(mon, "invalid char in format: '%c'\n",
2857 format = default_fmt_format;
2858 if (format != 'i') {
2859 /* for 'i', not specifying a size gives -1 as size */
2861 size = default_fmt_size;
2862 default_fmt_size = size;
2864 default_fmt_format = format;
2867 format = default_fmt_format;
2868 if (format != 'i') {
2869 size = default_fmt_size;
2874 qdict_put_int(qdict, "count", count);
2875 qdict_put_int(qdict, "format", format);
2876 qdict_put_int(qdict, "size", size);
2885 while (qemu_isspace(*p))
2887 if (*typestr == '?' || *typestr == '.') {
2888 if (*typestr == '?') {
2896 while (qemu_isspace(*p))
2905 if (get_expr(mon, &val, &p))
2907 /* Check if 'i' is greater than 32-bit */
2908 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2909 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2910 monitor_printf(mon, "integer is for 32-bit values\n");
2912 } else if (c == 'M') {
2914 monitor_printf(mon, "enter a positive value\n");
2919 qdict_put_int(qdict, key, val);
2928 while (qemu_isspace(*p)) {
2931 if (*typestr == '?') {
2937 ret = qemu_strtosz_MiB(p, &end, &val);
2938 if (ret < 0 || val > INT64_MAX) {
2939 monitor_printf(mon, "invalid size\n");
2942 qdict_put_int(qdict, key, val);
2950 while (qemu_isspace(*p))
2952 if (*typestr == '?') {
2958 if (get_double(mon, &val, &p) < 0) {
2961 if (p[0] && p[1] == 's') {
2964 val /= 1e3; p += 2; break;
2966 val /= 1e6; p += 2; break;
2968 val /= 1e9; p += 2; break;
2971 if (*p && !qemu_isspace(*p)) {
2972 monitor_printf(mon, "Unknown unit suffix\n");
2975 qdict_put(qdict, key, qfloat_from_double(val));
2983 while (qemu_isspace(*p)) {
2987 while (qemu_isgraph(*p)) {
2990 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
2992 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
2995 monitor_printf(mon, "Expected 'on' or 'off'\n");
2998 qdict_put_bool(qdict, key, val);
3003 const char *tmp = p;
3010 while (qemu_isspace(*p))
3015 if(!is_valid_option(p, typestr)) {
3017 monitor_printf(mon, "%s: unsupported option -%c\n",
3029 qdict_put_bool(qdict, key, true);
3036 /* package all remaining string */
3039 while (qemu_isspace(*p)) {
3042 if (*typestr == '?') {
3045 /* no remaining string: NULL argument */
3051 monitor_printf(mon, "%s: string expected\n",
3055 qdict_put_str(qdict, key, p);
3061 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3067 /* check that all arguments were parsed */
3068 while (qemu_isspace(*p))
3071 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3084 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3087 const mon_cmd_t *cmd;
3089 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
3094 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3096 monitor_printf(mon, "Try \"help %s\" for more information\n",
3101 cmd->cmd(mon, qdict);
3105 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3107 const char *p, *pstart;
3116 p = pstart + strlen(pstart);
3118 if (len > sizeof(cmd) - 2)
3119 len = sizeof(cmd) - 2;
3120 memcpy(cmd, pstart, len);
3122 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3123 readline_add_completion(mon->rs, cmd);
3131 static void file_completion(Monitor *mon, const char *input)
3136 char file[1024], file_prefix[1024];
3140 p = strrchr(input, '/');
3143 pstrcpy(file_prefix, sizeof(file_prefix), input);
3144 pstrcpy(path, sizeof(path), ".");
3146 input_path_len = p - input + 1;
3147 memcpy(path, input, input_path_len);
3148 if (input_path_len > sizeof(path) - 1)
3149 input_path_len = sizeof(path) - 1;
3150 path[input_path_len] = '\0';
3151 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3154 ffs = opendir(path);
3163 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3167 if (strstart(d->d_name, file_prefix, NULL)) {
3168 memcpy(file, input, input_path_len);
3169 if (input_path_len < sizeof(file))
3170 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3172 /* stat the file to find out if it's a directory.
3173 * In that case add a slash to speed up typing long paths
3175 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3176 pstrcat(file, sizeof(file), "/");
3178 readline_add_completion(mon->rs, file);
3184 static const char *next_arg_type(const char *typestr)
3186 const char *p = strchr(typestr, ':');
3187 return (p != NULL ? ++p : typestr);
3190 static void add_completion_option(ReadLineState *rs, const char *str,
3193 if (!str || !option) {
3196 if (!strncmp(option, str, strlen(str))) {
3197 readline_add_completion(rs, option);
3201 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3204 ChardevBackendInfoList *list, *start;
3210 readline_set_completion_index(rs, len);
3212 start = list = qmp_query_chardev_backends(NULL);
3214 const char *chr_name = list->value->name;
3216 if (!strncmp(chr_name, str, len)) {
3217 readline_add_completion(rs, chr_name);
3221 qapi_free_ChardevBackendInfoList(start);
3224 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3233 readline_set_completion_index(rs, len);
3234 for (i = 0; NetClientDriver_lookup[i]; i++) {
3235 add_completion_option(rs, str, NetClientDriver_lookup[i]);
3239 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3249 readline_set_completion_index(rs, len);
3250 list = elt = object_class_get_list(TYPE_DEVICE, false);
3253 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3255 name = object_class_get_name(OBJECT_CLASS(dc));
3257 if (!dc->cannot_instantiate_with_device_add_yet
3258 && !strncmp(name, str, len)) {
3259 readline_add_completion(rs, name);
3266 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3276 readline_set_completion_index(rs, len);
3277 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3281 name = object_class_get_name(OBJECT_CLASS(elt->data));
3282 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3283 readline_add_completion(rs, name);
3290 static void peripheral_device_del_completion(ReadLineState *rs,
3291 const char *str, size_t len)
3293 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3294 GSList *list, *item;
3296 list = qdev_build_hotpluggable_device_list(peripheral);
3301 for (item = list; item; item = g_slist_next(item)) {
3302 DeviceState *dev = item->data;
3304 if (dev->id && !strncmp(str, dev->id, len)) {
3305 readline_add_completion(rs, dev->id);
3312 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3315 ChardevInfoList *list, *start;
3321 readline_set_completion_index(rs, len);
3323 start = list = qmp_query_chardev(NULL);
3325 ChardevInfo *chr = list->value;
3327 if (!strncmp(chr->label, str, len)) {
3328 readline_add_completion(rs, chr->label);
3332 qapi_free_ChardevInfoList(start);
3335 static void ringbuf_completion(ReadLineState *rs, const char *str)
3338 ChardevInfoList *list, *start;
3341 readline_set_completion_index(rs, len);
3343 start = list = qmp_query_chardev(NULL);
3345 ChardevInfo *chr_info = list->value;
3347 if (!strncmp(chr_info->label, str, len)) {
3348 Chardev *chr = qemu_chr_find(chr_info->label);
3349 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3350 readline_add_completion(rs, chr_info->label);
3355 qapi_free_ChardevInfoList(start);
3358 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3363 ringbuf_completion(rs, str);
3366 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3375 readline_set_completion_index(rs, len);
3376 peripheral_device_del_completion(rs, str, len);
3379 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3381 ObjectPropertyInfoList *list, *start;
3388 readline_set_completion_index(rs, len);
3390 start = list = qmp_qom_list("/objects", NULL);
3392 ObjectPropertyInfo *info = list->value;
3394 if (!strncmp(info->type, "child<", 5)
3395 && !strncmp(info->name, str, len)) {
3396 readline_add_completion(rs, info->name);
3400 qapi_free_ObjectPropertyInfoList(start);
3403 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3412 sep = strrchr(str, '-');
3417 readline_set_completion_index(rs, len);
3418 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3419 if (!strncmp(str, QKeyCode_lookup[i], len)) {
3420 readline_add_completion(rs, QKeyCode_lookup[i]);
3425 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3430 readline_set_completion_index(rs, len);
3432 NetClientState *ncs[MAX_QUEUE_NUM];
3434 count = qemu_find_net_clients_except(NULL, ncs,
3435 NET_CLIENT_DRIVER_NONE,
3437 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3438 const char *name = ncs[i]->name;
3439 if (!strncmp(str, name, len)) {
3440 readline_add_completion(rs, name);
3443 } else if (nb_args == 3) {
3444 add_completion_option(rs, str, "on");
3445 add_completion_option(rs, str, "off");
3449 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3452 NetClientState *ncs[MAX_QUEUE_NUM];
3459 readline_set_completion_index(rs, len);
3460 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3462 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3464 const char *name = ncs[i]->name;
3465 if (strncmp(str, name, len)) {
3468 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3470 readline_add_completion(rs, name);
3475 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3480 readline_set_completion_index(rs, len);
3482 TraceEventIter iter;
3484 char *pattern = g_strdup_printf("%s*", str);
3485 trace_event_iter_init(&iter, pattern);
3486 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3487 readline_add_completion(rs, trace_event_get_name(ev));
3493 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3498 readline_set_completion_index(rs, len);
3500 TraceEventIter iter;
3502 char *pattern = g_strdup_printf("%s*", str);
3503 trace_event_iter_init(&iter, pattern);
3504 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3505 readline_add_completion(rs, trace_event_get_name(ev));
3508 } else if (nb_args == 3) {
3509 add_completion_option(rs, str, "on");
3510 add_completion_option(rs, str, "off");
3514 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3521 readline_set_completion_index(rs, strlen(str));
3522 for (i = 0; WatchdogExpirationAction_lookup[i]; i++) {
3523 add_completion_option(rs, str, WatchdogExpirationAction_lookup[i]);
3527 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3533 readline_set_completion_index(rs, len);
3536 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3537 const char *name = MigrationCapability_lookup[i];
3538 if (!strncmp(str, name, len)) {
3539 readline_add_completion(rs, name);
3542 } else if (nb_args == 3) {
3543 add_completion_option(rs, str, "on");
3544 add_completion_option(rs, str, "off");
3548 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3554 readline_set_completion_index(rs, len);
3557 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3558 const char *name = MigrationParameter_lookup[i];
3559 if (!strncmp(str, name, len)) {
3560 readline_add_completion(rs, name);
3566 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3574 readline_set_completion_index(rs, len);
3575 for (i = 0; host_net_devices[i]; i++) {
3576 if (!strncmp(host_net_devices[i], str, len)) {
3577 readline_add_completion(rs, host_net_devices[i]);
3582 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3584 NetClientState *ncs[MAX_QUEUE_NUM];
3588 readline_set_completion_index(rs, len);
3590 count = qemu_find_net_clients_except(NULL, ncs,
3591 NET_CLIENT_DRIVER_NONE,
3593 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3597 if (net_hub_id_for_client(ncs[i], &id)) {
3600 snprintf(name, sizeof(name), "%d", id);
3601 if (!strncmp(str, name, len)) {
3602 readline_add_completion(rs, name);
3606 } else if (nb_args == 3) {
3607 count = qemu_find_net_clients_except(NULL, ncs,
3608 NET_CLIENT_DRIVER_NIC,
3610 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3614 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3615 net_hub_id_for_client(ncs[i], &id)) {
3618 name = ncs[i]->name;
3619 if (!strncmp(str, name, len)) {
3620 readline_add_completion(rs, name);
3627 static void vm_completion(ReadLineState *rs, const char *str)
3630 BlockDriverState *bs;
3631 BdrvNextIterator it;
3634 readline_set_completion_index(rs, len);
3636 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3637 SnapshotInfoList *snapshots, *snapshot;
3638 AioContext *ctx = bdrv_get_aio_context(bs);
3641 aio_context_acquire(ctx);
3642 if (bdrv_can_snapshot(bs)) {
3643 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3645 aio_context_release(ctx);
3650 snapshot = snapshots;
3652 char *completion = snapshot->value->name;
3653 if (!strncmp(str, completion, len)) {
3654 readline_add_completion(rs, completion);
3656 completion = snapshot->value->id;
3657 if (!strncmp(str, completion, len)) {
3658 readline_add_completion(rs, completion);
3660 snapshot = snapshot->next;
3662 qapi_free_SnapshotInfoList(snapshots);
3667 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3670 vm_completion(rs, str);
3674 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3677 vm_completion(rs, str);
3681 static void monitor_find_completion_by_table(Monitor *mon,
3682 const mon_cmd_t *cmd_table,
3686 const char *cmdname;
3688 const char *ptype, *str, *name;
3689 const mon_cmd_t *cmd;
3690 BlockBackend *blk = NULL;
3693 /* command completion */
3698 readline_set_completion_index(mon->rs, strlen(cmdname));
3699 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3700 cmd_completion(mon, cmdname, cmd->name);
3703 /* find the command */
3704 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3705 if (compare_cmd(args[0], cmd->name)) {
3713 if (cmd->sub_table) {
3714 /* do the job again */
3715 monitor_find_completion_by_table(mon, cmd->sub_table,
3716 &args[1], nb_args - 1);
3719 if (cmd->command_completion) {
3720 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3724 ptype = next_arg_type(cmd->args_type);
3725 for(i = 0; i < nb_args - 2; i++) {
3726 if (*ptype != '\0') {
3727 ptype = next_arg_type(ptype);
3728 while (*ptype == '?')
3729 ptype = next_arg_type(ptype);
3732 str = args[nb_args - 1];
3733 while (*ptype == '-' && ptype[1] != '\0') {
3734 ptype = next_arg_type(ptype);
3738 /* file completion */
3739 readline_set_completion_index(mon->rs, strlen(str));
3740 file_completion(mon, str);
3743 /* block device name completion */
3744 readline_set_completion_index(mon->rs, strlen(str));
3745 while ((blk = blk_next(blk)) != NULL) {
3746 name = blk_name(blk);
3747 if (str[0] == '\0' ||
3748 !strncmp(name, str, strlen(str))) {
3749 readline_add_completion(mon->rs, name);
3755 if (!strcmp(cmd->name, "help|?")) {
3756 monitor_find_completion_by_table(mon, cmd_table,
3757 &args[1], nb_args - 1);
3766 static void monitor_find_completion(void *opaque,
3767 const char *cmdline)
3769 Monitor *mon = opaque;
3770 char *args[MAX_ARGS];
3773 /* 1. parse the cmdline */
3774 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3778 /* if the line ends with a space, it means we want to complete the
3780 len = strlen(cmdline);
3781 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3782 if (nb_args >= MAX_ARGS) {
3785 args[nb_args++] = g_strdup("");
3788 /* 2. auto complete according to args */
3789 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3792 free_cmdline_args(args, nb_args);
3795 static int monitor_can_read(void *opaque)
3797 Monitor *mon = opaque;
3799 return (mon->suspend_cnt == 0) ? 1 : 0;
3802 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3804 QObject *req, *rsp = NULL, *id = NULL;
3805 QDict *qdict = NULL;
3806 Monitor *mon = cur_mon;
3809 req = json_parser_parse_err(tokens, NULL, &err);
3811 /* json_parser_parse_err() sucks: can fail without setting @err */
3812 error_setg(&err, QERR_JSON_PARSING);
3818 qdict = qobject_to_qdict(req);
3820 id = qdict_get(qdict, "id");
3822 qdict_del(qdict, "id");
3823 } /* else will fail qmp_dispatch() */
3825 rsp = qmp_dispatch(cur_mon->qmp.commands, req);
3827 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
3828 qdict = qdict_get_qdict(qobject_to_qdict(rsp), "error");
3830 && !g_strcmp0(qdict_get_try_str(qdict, "class"),
3831 QapiErrorClass_lookup[ERROR_CLASS_COMMAND_NOT_FOUND])) {
3832 /* Provide a more useful error message */
3833 qdict_del(qdict, "desc");
3834 qdict_put_str(qdict, "desc", "Expecting capabilities negotiation"
3835 " with 'qmp_capabilities'");
3841 qdict = qdict_new();
3842 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3844 rsp = QOBJECT(qdict);
3849 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3853 monitor_json_emitter(mon, rsp);
3857 qobject_decref(rsp);
3858 qobject_decref(req);
3861 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3863 Monitor *old_mon = cur_mon;
3867 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3872 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3874 Monitor *old_mon = cur_mon;
3880 for (i = 0; i < size; i++)
3881 readline_handle_byte(cur_mon->rs, buf[i]);
3883 if (size == 0 || buf[size - 1] != 0)
3884 monitor_printf(cur_mon, "corrupted command\n");
3886 handle_hmp_command(cur_mon, (char *)buf);
3892 static void monitor_command_cb(void *opaque, const char *cmdline,
3893 void *readline_opaque)
3895 Monitor *mon = opaque;
3897 monitor_suspend(mon);
3898 handle_hmp_command(mon, cmdline);
3899 monitor_resume(mon);
3902 int monitor_suspend(Monitor *mon)
3910 void monitor_resume(Monitor *mon)
3914 if (--mon->suspend_cnt == 0)
3915 readline_show_prompt(mon->rs);
3918 static QObject *get_qmp_greeting(void)
3920 QObject *ver = NULL;
3922 qmp_marshal_query_version(NULL, &ver, NULL);
3924 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3928 static void monitor_qmp_event(void *opaque, int event)
3931 Monitor *mon = opaque;
3934 case CHR_EVENT_OPENED:
3935 mon->qmp.commands = &qmp_cap_negotiation_commands;
3936 data = get_qmp_greeting();
3937 monitor_json_emitter(mon, data);
3938 qobject_decref(data);
3941 case CHR_EVENT_CLOSED:
3942 json_message_parser_destroy(&mon->qmp.parser);
3943 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3945 monitor_fdsets_cleanup();
3950 static void monitor_event(void *opaque, int event)
3952 Monitor *mon = opaque;
3955 case CHR_EVENT_MUX_IN:
3956 qemu_mutex_lock(&mon->out_lock);
3958 qemu_mutex_unlock(&mon->out_lock);
3959 if (mon->reset_seen) {
3960 readline_restart(mon->rs);
3961 monitor_resume(mon);
3964 mon->suspend_cnt = 0;
3968 case CHR_EVENT_MUX_OUT:
3969 if (mon->reset_seen) {
3970 if (mon->suspend_cnt == 0) {
3971 monitor_printf(mon, "\n");
3974 monitor_suspend(mon);
3978 qemu_mutex_lock(&mon->out_lock);
3980 qemu_mutex_unlock(&mon->out_lock);
3983 case CHR_EVENT_OPENED:
3984 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3985 "information\n", QEMU_VERSION);
3986 if (!mon->mux_out) {
3987 readline_restart(mon->rs);
3988 readline_show_prompt(mon->rs);
3990 mon->reset_seen = 1;
3994 case CHR_EVENT_CLOSED:
3996 monitor_fdsets_cleanup();
4002 compare_mon_cmd(const void *a, const void *b)
4004 return strcmp(((const mon_cmd_t *)a)->name,
4005 ((const mon_cmd_t *)b)->name);
4008 static void sortcmdlist(void)
4011 int elem_size = sizeof(mon_cmd_t);
4013 array_num = sizeof(mon_cmds)/elem_size-1;
4014 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4016 array_num = sizeof(info_cmds)/elem_size-1;
4017 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4020 /* These functions just adapt the readline interface in a typesafe way. We
4021 * could cast function pointers but that discards compiler checks.
4023 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4024 const char *fmt, ...)
4028 monitor_vprintf(opaque, fmt, ap);
4032 static void monitor_readline_flush(void *opaque)
4034 monitor_flush(opaque);
4038 * Print to current monitor if we have one, else to stderr.
4039 * TODO should return int, so callers can calculate width, but that
4040 * requires surgery to monitor_vprintf(). Left for another day.
4042 void error_vprintf(const char *fmt, va_list ap)
4044 if (cur_mon && !monitor_cur_is_qmp()) {
4045 monitor_vprintf(cur_mon, fmt, ap);
4047 vfprintf(stderr, fmt, ap);
4051 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4053 if (cur_mon && !monitor_cur_is_qmp()) {
4054 monitor_vprintf(cur_mon, fmt, ap);
4055 } else if (!cur_mon) {
4056 vfprintf(stderr, fmt, ap);
4060 static void __attribute__((constructor)) monitor_lock_init(void)
4062 qemu_mutex_init(&monitor_lock);
4065 void monitor_init(Chardev *chr, int flags)
4067 static int is_first_init = 1;
4070 if (is_first_init) {
4071 monitor_qapi_event_init();
4076 mon = g_malloc(sizeof(*mon));
4077 monitor_data_init(mon);
4079 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4081 if (flags & MONITOR_USE_READLINE) {
4082 mon->rs = readline_init(monitor_readline_printf,
4083 monitor_readline_flush,
4085 monitor_find_completion);
4086 monitor_read_command(mon, 0);
4089 if (monitor_is_qmp(mon)) {
4090 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4091 monitor_qmp_event, mon, NULL, true);
4092 qemu_chr_fe_set_echo(&mon->chr, true);
4093 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4095 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4096 monitor_event, mon, NULL, true);
4099 qemu_mutex_lock(&monitor_lock);
4100 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4101 qemu_mutex_unlock(&monitor_lock);
4104 void monitor_cleanup(void)
4106 Monitor *mon, *next;
4108 qemu_mutex_lock(&monitor_lock);
4109 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4110 QLIST_REMOVE(mon, entry);
4111 monitor_data_destroy(mon);
4114 qemu_mutex_unlock(&monitor_lock);
4117 static void bdrv_password_cb(void *opaque, const char *password,
4118 void *readline_opaque)
4120 Monitor *mon = opaque;
4121 BlockDriverState *bs = readline_opaque;
4123 Error *local_err = NULL;
4125 bdrv_add_key(bs, password, &local_err);
4127 error_report_err(local_err);
4130 if (mon->password_completion_cb)
4131 mon->password_completion_cb(mon->password_opaque, ret);
4133 monitor_read_command(mon, 1);
4136 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
4137 BlockCompletionFunc *completion_cb,
4142 monitor_printf(mon, "%s (%s) is encrypted.\n", bdrv_get_device_name(bs),
4143 bdrv_get_encrypted_filename(bs));
4145 mon->password_completion_cb = completion_cb;
4146 mon->password_opaque = opaque;
4148 err = monitor_read_password(mon, bdrv_password_cb, bs);
4150 if (err && completion_cb)
4151 completion_cb(opaque, err);
4156 int monitor_read_block_device_key(Monitor *mon, const char *device,
4157 BlockCompletionFunc *completion_cb,
4163 blk = blk_by_name(device);
4165 monitor_printf(mon, "Device not found %s\n", device);
4169 monitor_printf(mon, "Device '%s' has no medium\n", device);
4173 bdrv_add_key(blk_bs(blk), NULL, &err);
4176 return monitor_read_bdrv_key_start(mon, blk_bs(blk), completion_cb, opaque);
4179 if (completion_cb) {
4180 completion_cb(opaque, 0);
4185 QemuOptsList qemu_mon_opts = {
4187 .implied_opt_name = "chardev",
4188 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4192 .type = QEMU_OPT_STRING,
4195 .type = QEMU_OPT_STRING,
4197 .name = "default", /* deprecated */
4198 .type = QEMU_OPT_BOOL,
4201 .type = QEMU_OPT_BOOL,
4203 { /* end of list */ }
4208 void qmp_rtc_reset_reinjection(Error **errp)
4210 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4214 #ifndef TARGET_S390X
4215 void qmp_dump_skeys(const char *filename, Error **errp)
4217 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4222 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4224 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4229 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4231 MachineState *ms = MACHINE(qdev_get_machine());
4232 MachineClass *mc = MACHINE_GET_CLASS(ms);
4234 if (!mc->has_hotpluggable_cpus) {
4235 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4239 return machine_query_hotpluggable_cpus(ms);