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 "chardev/char-fe.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 "sysemu/hw_accel.h"
54 #include "sysemu/tpm.h"
55 #include "qapi/qmp/qerror.h"
56 #include "qapi/qmp/types.h"
57 #include "qapi/qmp/qjson.h"
58 #include "qapi/qmp/json-streamer.h"
59 #include "qapi/qmp/json-parser.h"
60 #include "qom/object_interfaces.h"
61 #include "trace-root.h"
62 #include "trace/control.h"
63 #include "monitor/hmp-target.h"
64 #ifdef CONFIG_TRACE_SIMPLE
65 #include "trace/simple.h"
67 #include "exec/memory.h"
68 #include "exec/exec-all.h"
70 #include "qmp-commands.h"
72 #include "qemu/thread.h"
73 #include "block/qapi.h"
74 #include "qapi/qmp-event.h"
75 #include "qapi-event.h"
76 #include "qmp-introspect.h"
77 #include "sysemu/qtest.h"
78 #include "sysemu/cpus.h"
79 #include "qemu/cutils.h"
80 #include "qapi/qmp/dispatch.h"
82 #if defined(TARGET_S390X)
83 #include "hw/s390x/storage-keys.h"
90 * 'B' block device name
91 * 's' string (accept optional quote)
92 * 'S' it just appends the rest of the string (accept optional quote)
93 * 'O' option string of the form NAME=VALUE,...
94 * parsed according to QemuOptsList given by its name
95 * Example: 'device:O' uses qemu_device_opts.
96 * Restriction: only lists with empty desc are supported
97 * TODO lift the restriction
99 * 'l' target long (32 or 64 bit)
100 * 'M' Non-negative target long (32 or 64 bit), in user mode the
101 * value is multiplied by 2^20 (think Mebibyte)
102 * 'o' octets (aka bytes)
103 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
104 * K, k suffix, which multiplies the value by 2^60 for suffixes E
105 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
106 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
108 * user mode accepts an optional ms, us, ns suffix,
109 * which divides the value by 1e3, 1e6, 1e9, respectively
110 * '/' optional gdb-like print format (like "/10x")
112 * '?' optional type (for all types, except '/')
113 * '.' other form of optional type (for 'i' and 'l')
115 * user mode accepts "on" or "off"
116 * '-' optional parameter (eg. '-f')
120 typedef struct mon_cmd_t {
122 const char *args_type;
125 void (*cmd)(Monitor *mon, const QDict *qdict);
126 /* @sub_table is a list of 2nd level of commands. If it does not exist,
127 * cmd should be used. If it exists, sub_table[?].cmd should be
128 * used, and cmd of 1st level plays the role of help function.
130 struct mon_cmd_t *sub_table;
131 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
134 /* file descriptors passed via SCM_RIGHTS */
135 typedef struct mon_fd_t mon_fd_t;
139 QLIST_ENTRY(mon_fd_t) next;
142 /* file descriptor associated with a file descriptor set */
143 typedef struct MonFdsetFd MonFdsetFd;
148 QLIST_ENTRY(MonFdsetFd) next;
151 /* file descriptor set containing fds passed via SCM_RIGHTS */
152 typedef struct MonFdset MonFdset;
155 QLIST_HEAD(, MonFdsetFd) fds;
156 QLIST_HEAD(, MonFdsetFd) dup_fds;
157 QLIST_ENTRY(MonFdset) next;
161 JSONMessageParser parser;
163 * When a client connects, we're in capabilities negotiation mode.
164 * When command qmp_capabilities succeeds, we go into command
167 QmpCommandList *commands;
171 * To prevent flooding clients, events can be throttled. The
172 * throttling is calculated globally, rather than per-Monitor
175 typedef struct MonitorQAPIEventState {
176 QAPIEvent event; /* Throttling state for this event type and... */
177 QDict *data; /* ... data, see qapi_event_throttle_equal() */
178 QEMUTimer *timer; /* Timer for handling delayed events */
179 QDict *qdict; /* Delayed event (if any) */
180 } MonitorQAPIEventState;
183 int64_t rate; /* Minimum time (in ns) between two events */
184 } MonitorQAPIEventConf;
197 /* Read under either BQL or out_lock, written with BQL+out_lock. */
203 BlockCompletionFunc *password_completion_cb;
204 void *password_opaque;
205 mon_cmd_t *cmd_table;
206 QLIST_HEAD(,mon_fd_t) fds;
207 QLIST_ENTRY(Monitor) entry;
210 /* QMP checker flags */
211 #define QMP_ACCEPT_UNKNOWNS 1
213 /* Protects mon_list, monitor_event_state. */
214 static QemuMutex monitor_lock;
216 static QLIST_HEAD(mon_list, Monitor) mon_list;
217 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
218 static int mon_refcount;
220 static mon_cmd_t mon_cmds[];
221 static mon_cmd_t info_cmds[];
223 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
227 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
229 static void monitor_command_cb(void *opaque, const char *cmdline,
230 void *readline_opaque);
233 * Is @mon a QMP monitor?
235 static inline bool monitor_is_qmp(const Monitor *mon)
237 return (mon->flags & MONITOR_USE_CONTROL);
241 * Is the current monitor, if any, a QMP monitor?
243 bool monitor_cur_is_qmp(void)
245 return cur_mon && monitor_is_qmp(cur_mon);
248 void monitor_read_command(Monitor *mon, int show_prompt)
253 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
255 readline_show_prompt(mon->rs);
258 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
262 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
263 /* prompt is printed on return from the command handler */
266 monitor_printf(mon, "terminal does not support password prompting\n");
271 static void monitor_flush_locked(Monitor *mon);
273 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
276 Monitor *mon = opaque;
278 qemu_mutex_lock(&mon->out_lock);
280 monitor_flush_locked(mon);
281 qemu_mutex_unlock(&mon->out_lock);
285 /* Called with mon->out_lock held. */
286 static void monitor_flush_locked(Monitor *mon)
292 if (mon->skip_flush) {
296 buf = qstring_get_str(mon->outbuf);
297 len = qstring_get_length(mon->outbuf);
299 if (len && !mon->mux_out) {
300 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
301 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
302 /* all flushed or error */
303 QDECREF(mon->outbuf);
304 mon->outbuf = qstring_new();
309 QString *tmp = qstring_from_str(buf + rc);
310 QDECREF(mon->outbuf);
313 if (mon->out_watch == 0) {
315 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
316 monitor_unblocked, mon);
321 void monitor_flush(Monitor *mon)
323 qemu_mutex_lock(&mon->out_lock);
324 monitor_flush_locked(mon);
325 qemu_mutex_unlock(&mon->out_lock);
328 /* flush at every end of line */
329 static void monitor_puts(Monitor *mon, const char *str)
333 qemu_mutex_lock(&mon->out_lock);
339 qstring_append_chr(mon->outbuf, '\r');
341 qstring_append_chr(mon->outbuf, c);
343 monitor_flush_locked(mon);
346 qemu_mutex_unlock(&mon->out_lock);
349 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
356 if (monitor_is_qmp(mon)) {
360 buf = g_strdup_vprintf(fmt, ap);
361 monitor_puts(mon, buf);
365 void monitor_printf(Monitor *mon, const char *fmt, ...)
369 monitor_vprintf(mon, fmt, ap);
373 int monitor_fprintf(FILE *stream, const char *fmt, ...)
377 monitor_vprintf((Monitor *)stream, fmt, ap);
382 static void monitor_json_emitter(Monitor *mon, const QObject *data)
386 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
387 qobject_to_json(data);
388 assert(json != NULL);
390 qstring_append_chr(json, '\n');
391 monitor_puts(mon, qstring_get_str(json));
396 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
397 /* Limit guest-triggerable events to 1 per second */
398 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
399 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
400 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
401 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
402 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
403 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
406 GHashTable *monitor_qapi_event_state;
409 * Emits the event to every monitor instance, @event is only used for trace
410 * Called with monitor_lock held.
412 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
416 trace_monitor_protocol_event_emit(event, qdict);
417 QLIST_FOREACH(mon, &mon_list, entry) {
418 if (monitor_is_qmp(mon)
419 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
420 monitor_json_emitter(mon, QOBJECT(qdict));
425 static void monitor_qapi_event_handler(void *opaque);
428 * Queue a new event for emission to Monitor instances,
429 * applying any rate limiting if required.
432 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
434 MonitorQAPIEventConf *evconf;
435 MonitorQAPIEventState *evstate;
437 assert(event < QAPI_EVENT__MAX);
438 evconf = &monitor_qapi_event_conf[event];
439 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
441 qemu_mutex_lock(&monitor_lock);
444 /* Unthrottled event */
445 monitor_qapi_event_emit(event, qdict);
447 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
448 MonitorQAPIEventState key = { .event = event, .data = data };
450 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
451 assert(!evstate || timer_pending(evstate->timer));
455 * Timer is pending for (at least) evconf->rate ns after
456 * last send. Store event for sending when timer fires,
457 * replacing a prior stored event if any.
459 QDECREF(evstate->qdict);
460 evstate->qdict = qdict;
461 QINCREF(evstate->qdict);
464 * Last send was (at least) evconf->rate ns ago.
465 * Send immediately, and arm the timer to call
466 * monitor_qapi_event_handler() in evconf->rate ns. Any
467 * events arriving before then will be delayed until then.
469 int64_t now = qemu_clock_get_ns(event_clock_type);
471 monitor_qapi_event_emit(event, qdict);
473 evstate = g_new(MonitorQAPIEventState, 1);
474 evstate->event = event;
475 evstate->data = data;
476 QINCREF(evstate->data);
477 evstate->qdict = NULL;
478 evstate->timer = timer_new_ns(event_clock_type,
479 monitor_qapi_event_handler,
481 g_hash_table_add(monitor_qapi_event_state, evstate);
482 timer_mod_ns(evstate->timer, now + evconf->rate);
486 qemu_mutex_unlock(&monitor_lock);
490 * This function runs evconf->rate ns after sending a throttled
492 * If another event has since been stored, send it.
494 static void monitor_qapi_event_handler(void *opaque)
496 MonitorQAPIEventState *evstate = opaque;
497 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
499 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
500 qemu_mutex_lock(&monitor_lock);
502 if (evstate->qdict) {
503 int64_t now = qemu_clock_get_ns(event_clock_type);
505 monitor_qapi_event_emit(evstate->event, evstate->qdict);
506 QDECREF(evstate->qdict);
507 evstate->qdict = NULL;
508 timer_mod_ns(evstate->timer, now + evconf->rate);
510 g_hash_table_remove(monitor_qapi_event_state, evstate);
511 QDECREF(evstate->data);
512 timer_free(evstate->timer);
516 qemu_mutex_unlock(&monitor_lock);
519 static unsigned int qapi_event_throttle_hash(const void *key)
521 const MonitorQAPIEventState *evstate = key;
522 unsigned int hash = evstate->event * 255;
524 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
525 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
528 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
529 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
535 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
537 const MonitorQAPIEventState *eva = a;
538 const MonitorQAPIEventState *evb = b;
540 if (eva->event != evb->event) {
544 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
545 return !strcmp(qdict_get_str(eva->data, "id"),
546 qdict_get_str(evb->data, "id"));
549 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
550 return !strcmp(qdict_get_str(eva->data, "node-name"),
551 qdict_get_str(evb->data, "node-name"));
557 static void monitor_qapi_event_init(void)
559 if (qtest_enabled()) {
560 event_clock_type = QEMU_CLOCK_VIRTUAL;
563 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
564 qapi_event_throttle_equal);
565 qmp_event_set_func_emit(monitor_qapi_event_queue);
568 static void handle_hmp_command(Monitor *mon, const char *cmdline);
570 static void monitor_data_init(Monitor *mon)
572 memset(mon, 0, sizeof(Monitor));
573 qemu_mutex_init(&mon->out_lock);
574 mon->outbuf = qstring_new();
575 /* Use *mon_cmds by default. */
576 mon->cmd_table = mon_cmds;
579 static void monitor_data_destroy(Monitor *mon)
581 qemu_chr_fe_deinit(&mon->chr, false);
582 if (monitor_is_qmp(mon)) {
583 json_message_parser_destroy(&mon->qmp.parser);
586 QDECREF(mon->outbuf);
587 qemu_mutex_destroy(&mon->out_lock);
590 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
591 int64_t cpu_index, Error **errp)
594 Monitor *old_mon, hmp;
596 monitor_data_init(&hmp);
597 hmp.skip_flush = true;
603 int ret = monitor_set_cpu(cpu_index);
606 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
612 handle_hmp_command(&hmp, command_line);
615 qemu_mutex_lock(&hmp.out_lock);
616 if (qstring_get_length(hmp.outbuf) > 0) {
617 output = g_strdup(qstring_get_str(hmp.outbuf));
619 output = g_strdup("");
621 qemu_mutex_unlock(&hmp.out_lock);
624 monitor_data_destroy(&hmp);
628 static int compare_cmd(const char *name, const char *list)
630 const char *p, *pstart;
638 p = pstart + strlen(pstart);
639 if ((p - pstart) == len && !memcmp(pstart, name, len))
648 static int get_str(char *buf, int buf_size, const char **pp)
656 while (qemu_isspace(*p)) {
667 while (*p != '\0' && *p != '\"') {
683 printf("unsupported escape code: '\\%c'\n", c);
686 if ((q - buf) < buf_size - 1) {
690 if ((q - buf) < buf_size - 1) {
697 printf("unterminated string\n");
702 while (*p != '\0' && !qemu_isspace(*p)) {
703 if ((q - buf) < buf_size - 1) {
716 static void free_cmdline_args(char **args, int nb_args)
720 assert(nb_args <= MAX_ARGS);
722 for (i = 0; i < nb_args; i++) {
729 * Parse the command line to get valid args.
730 * @cmdline: command line to be parsed.
731 * @pnb_args: location to store the number of args, must NOT be NULL.
732 * @args: location to store the args, which should be freed by caller, must
735 * Returns 0 on success, negative on failure.
737 * NOTE: this parser is an approximate form of the real command parser. Number
738 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
739 * return with failure.
741 static int parse_cmdline(const char *cmdline,
742 int *pnb_args, char **args)
751 while (qemu_isspace(*p)) {
757 if (nb_args >= MAX_ARGS) {
760 ret = get_str(buf, sizeof(buf), &p);
764 args[nb_args] = g_strdup(buf);
771 free_cmdline_args(args, nb_args);
775 static void help_cmd_dump_one(Monitor *mon,
776 const mon_cmd_t *cmd,
782 for (i = 0; i < prefix_args_nb; i++) {
783 monitor_printf(mon, "%s ", prefix_args[i]);
785 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
788 /* @args[@arg_index] is the valid command need to find in @cmds */
789 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
790 char **args, int nb_args, int arg_index)
792 const mon_cmd_t *cmd;
794 /* No valid arg need to compare with, dump all in *cmds */
795 if (arg_index >= nb_args) {
796 for (cmd = cmds; cmd->name != NULL; cmd++) {
797 help_cmd_dump_one(mon, cmd, args, arg_index);
802 /* Find one entry to dump */
803 for (cmd = cmds; cmd->name != NULL; cmd++) {
804 if (compare_cmd(args[arg_index], cmd->name)) {
805 if (cmd->sub_table) {
806 /* continue with next arg */
807 help_cmd_dump(mon, cmd->sub_table,
808 args, nb_args, arg_index + 1);
810 help_cmd_dump_one(mon, cmd, args, arg_index);
817 static void help_cmd(Monitor *mon, const char *name)
819 char *args[MAX_ARGS];
822 /* 1. parse user input */
824 /* special case for log, directly dump and return */
825 if (!strcmp(name, "log")) {
826 const QEMULogItem *item;
827 monitor_printf(mon, "Log items (comma separated):\n");
828 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
829 for (item = qemu_log_items; item->mask != 0; item++) {
830 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
835 if (parse_cmdline(name, &nb_args, args) < 0) {
840 /* 2. dump the contents according to parsed args */
841 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
843 free_cmdline_args(args, nb_args);
846 static void do_help_cmd(Monitor *mon, const QDict *qdict)
848 help_cmd(mon, qdict_get_try_str(qdict, "name"));
851 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
853 const char *tp_name = qdict_get_str(qdict, "name");
854 bool new_state = qdict_get_bool(qdict, "option");
855 bool has_vcpu = qdict_haskey(qdict, "vcpu");
856 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
857 Error *local_err = NULL;
860 monitor_printf(mon, "argument vcpu must be positive");
864 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
866 error_report_err(local_err);
870 #ifdef CONFIG_TRACE_SIMPLE
871 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
873 const char *op = qdict_get_try_str(qdict, "op");
874 const char *arg = qdict_get_try_str(qdict, "arg");
877 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
878 } else if (!strcmp(op, "on")) {
879 st_set_trace_file_enabled(true);
880 } else if (!strcmp(op, "off")) {
881 st_set_trace_file_enabled(false);
882 } else if (!strcmp(op, "flush")) {
883 st_flush_trace_buffer();
884 } else if (!strcmp(op, "set")) {
886 st_set_trace_file(arg);
889 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
890 help_cmd(mon, "trace-file");
895 static void hmp_info_help(Monitor *mon, const QDict *qdict)
897 help_cmd(mon, "info");
900 static void query_commands_cb(QmpCommand *cmd, void *opaque)
902 CommandInfoList *info, **list = opaque;
908 info = g_malloc0(sizeof(*info));
909 info->value = g_malloc0(sizeof(*info->value));
910 info->value->name = g_strdup(cmd->name);
915 CommandInfoList *qmp_query_commands(Error **errp)
917 CommandInfoList *list = NULL;
919 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
924 EventInfoList *qmp_query_events(Error **errp)
926 EventInfoList *info, *ev_list = NULL;
929 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
930 const char *event_name = QAPIEvent_lookup[e];
931 assert(event_name != NULL);
932 info = g_malloc0(sizeof(*info));
933 info->value = g_malloc0(sizeof(*info->value));
934 info->value->name = g_strdup(event_name);
936 info->next = ev_list;
944 * Minor hack: generated marshalling suppressed for this command
945 * ('gen': false in the schema) so we can parse the JSON string
946 * directly into QObject instead of first parsing it with
947 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
948 * to QObject with generated output marshallers, every time. Instead,
949 * we do it in test-qobject-input-visitor.c, just to make sure
950 * qapi-introspect.py's output actually conforms to the schema.
952 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
955 *ret_data = qobject_from_json(qmp_schema_json, &error_abort);
959 * We used to define commands in qmp-commands.hx in addition to the
960 * QAPI schema. This permitted defining some of them only in certain
961 * configurations. query-commands has always reflected that (good,
962 * because it lets QMP clients figure out what's actually available),
963 * while query-qmp-schema never did (not so good). This function is a
964 * hack to keep the configuration-specific commands defined exactly as
965 * before, even though qmp-commands.hx is gone.
967 * FIXME Educate the QAPI schema on configuration-specific commands,
968 * and drop this hack.
970 static void qmp_unregister_commands_hack(void)
973 qmp_unregister_command(&qmp_commands, "query-spice");
975 #ifndef CONFIG_REPLICATION
976 qmp_unregister_command(&qmp_commands, "xen-set-replication");
977 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
978 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
981 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
984 qmp_unregister_command(&qmp_commands, "dump-skeys");
987 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
989 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
990 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
992 #if !defined(TARGET_S390X)
993 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
994 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
996 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
997 && !defined(TARGET_S390X)
998 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1002 void monitor_init_qmp_commands(void)
1005 * Two command lists:
1006 * - qmp_commands contains all QMP commands
1007 * - qmp_cap_negotiation_commands contains just
1008 * "qmp_capabilities", to enforce capability negotiation
1011 qmp_init_marshal(&qmp_commands);
1013 qmp_register_command(&qmp_commands, "query-qmp-schema",
1014 qmp_query_qmp_schema,
1016 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1018 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1021 qmp_unregister_commands_hack();
1023 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1024 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1025 qmp_marshal_qmp_capabilities, QCO_NO_OPTIONS);
1028 void qmp_qmp_capabilities(Error **errp)
1030 if (cur_mon->qmp.commands == &qmp_commands) {
1031 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1032 "Capabilities negotiation is already complete, command "
1037 cur_mon->qmp.commands = &qmp_commands;
1040 /* set the current CPU defined by the user */
1041 int monitor_set_cpu(int cpu_index)
1045 cpu = qemu_get_cpu(cpu_index);
1049 cur_mon->mon_cpu = cpu;
1053 CPUState *mon_get_cpu(void)
1055 if (!cur_mon->mon_cpu) {
1059 monitor_set_cpu(first_cpu->cpu_index);
1061 cpu_synchronize_state(cur_mon->mon_cpu);
1062 return cur_mon->mon_cpu;
1065 CPUArchState *mon_get_cpu_env(void)
1067 CPUState *cs = mon_get_cpu();
1069 return cs ? cs->env_ptr : NULL;
1072 int monitor_get_cpu_index(void)
1074 CPUState *cs = mon_get_cpu();
1076 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1079 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1081 CPUState *cs = mon_get_cpu();
1084 monitor_printf(mon, "No CPU available\n");
1087 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1090 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1092 if (!tcg_enabled()) {
1093 error_report("JIT information is only available with accel=tcg");
1097 dump_exec_info((FILE *)mon, monitor_fprintf);
1098 dump_drift_info((FILE *)mon, monitor_fprintf);
1101 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1103 dump_opcount_info((FILE *)mon, monitor_fprintf);
1106 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1115 str = readline_get_history(mon->rs, i);
1118 monitor_printf(mon, "%d: '%s'\n", i, str);
1123 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1125 CPUState *cs = mon_get_cpu();
1128 monitor_printf(mon, "No CPU available\n");
1131 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1134 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1136 const char *name = qdict_get_try_str(qdict, "name");
1137 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1138 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1139 TraceEventInfoList *events;
1140 TraceEventInfoList *elem;
1141 Error *local_err = NULL;
1147 monitor_printf(mon, "argument vcpu must be positive");
1151 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1153 error_report_err(local_err);
1157 for (elem = events; elem != NULL; elem = elem->next) {
1158 monitor_printf(mon, "%s : state %u\n",
1160 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1162 qapi_free_TraceEventInfoList(events);
1165 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1166 bool has_port, int64_t port,
1167 bool has_tls_port, int64_t tls_port,
1168 bool has_cert_subject, const char *cert_subject,
1171 if (strcmp(protocol, "spice") == 0) {
1172 if (!qemu_using_spice(errp)) {
1176 if (!has_port && !has_tls_port) {
1177 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1181 if (qemu_spice_migrate_info(hostname,
1182 has_port ? port : -1,
1183 has_tls_port ? tls_port : -1,
1185 error_setg(errp, QERR_UNDEFINED_ERROR);
1191 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1194 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1198 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1200 error_report_err(err);
1204 static void hmp_log(Monitor *mon, const QDict *qdict)
1207 const char *items = qdict_get_str(qdict, "items");
1209 if (!strcmp(items, "none")) {
1212 mask = qemu_str_to_log_mask(items);
1214 help_cmd(mon, "log");
1221 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1223 const char *option = qdict_get_try_str(qdict, "option");
1224 if (!option || !strcmp(option, "on")) {
1226 } else if (!strcmp(option, "off")) {
1229 monitor_printf(mon, "unexpected option %s\n", option);
1233 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1235 const char *device = qdict_get_try_str(qdict, "device");
1237 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1238 if (gdbserver_start(device) < 0) {
1239 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1241 } else if (strcmp(device, "none") == 0) {
1242 monitor_printf(mon, "Disabled gdbserver\n");
1244 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1249 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1251 const char *action = qdict_get_str(qdict, "action");
1252 if (select_watchdog_action(action) == -1) {
1253 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1257 static void monitor_printc(Monitor *mon, int c)
1259 monitor_printf(mon, "'");
1262 monitor_printf(mon, "\\'");
1265 monitor_printf(mon, "\\\\");
1268 monitor_printf(mon, "\\n");
1271 monitor_printf(mon, "\\r");
1274 if (c >= 32 && c <= 126) {
1275 monitor_printf(mon, "%c", c);
1277 monitor_printf(mon, "\\x%02x", c);
1281 monitor_printf(mon, "'");
1284 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1285 hwaddr addr, int is_physical)
1287 int l, line_size, i, max_digits, len;
1290 CPUState *cs = mon_get_cpu();
1292 if (!cs && (format == 'i' || !is_physical)) {
1293 monitor_printf(mon, "Can not dump without CPU\n");
1297 if (format == 'i') {
1300 CPUArchState *env = mon_get_cpu_env();
1303 } else if (wsize == 4) {
1306 /* as default we use the current CS size */
1309 #ifdef TARGET_X86_64
1310 if ((env->efer & MSR_EFER_LMA) &&
1311 (env->segs[R_CS].flags & DESC_L_MASK))
1315 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1321 CPUArchState *env = mon_get_cpu_env();
1322 flags = msr_le << 16;
1323 flags |= env->bfd_mach;
1325 monitor_disas(mon, cs, addr, count, is_physical, flags);
1329 len = wsize * count;
1338 max_digits = (wsize * 8 + 2) / 3;
1342 max_digits = (wsize * 8) / 4;
1346 max_digits = (wsize * 8 * 10 + 32) / 33;
1355 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1357 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1362 cpu_physical_memory_read(addr, buf, l);
1364 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1365 monitor_printf(mon, " Cannot access memory\n");
1374 v = ldub_p(buf + i);
1377 v = lduw_p(buf + i);
1380 v = (uint32_t)ldl_p(buf + i);
1386 monitor_printf(mon, " ");
1389 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1392 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1395 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1398 monitor_printf(mon, "%*" PRId64, max_digits, v);
1401 monitor_printc(mon, v);
1406 monitor_printf(mon, "\n");
1412 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1414 int count = qdict_get_int(qdict, "count");
1415 int format = qdict_get_int(qdict, "format");
1416 int size = qdict_get_int(qdict, "size");
1417 target_long addr = qdict_get_int(qdict, "addr");
1419 memory_dump(mon, count, format, size, addr, 0);
1422 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1424 int count = qdict_get_int(qdict, "count");
1425 int format = qdict_get_int(qdict, "format");
1426 int size = qdict_get_int(qdict, "size");
1427 hwaddr addr = qdict_get_int(qdict, "addr");
1429 memory_dump(mon, count, format, size, addr, 1);
1432 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1434 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1438 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1442 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1443 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1444 memory_region_unref(mrs.mr);
1449 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1452 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1454 hwaddr addr = qdict_get_int(qdict, "addr");
1455 Error *local_err = NULL;
1456 MemoryRegion *mr = NULL;
1459 ptr = gpa2hva(&mr, addr, &local_err);
1461 error_report_err(local_err);
1465 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1467 addr, mr->name, ptr);
1469 memory_region_unref(mr);
1473 static uint64_t vtop(void *ptr, Error **errp)
1477 uintptr_t addr = (uintptr_t) ptr;
1478 uintptr_t pagesize = getpagesize();
1479 off_t offset = addr / pagesize * sizeof(pinfo);
1482 fd = open("/proc/self/pagemap", O_RDONLY);
1484 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1488 /* Force copy-on-write if necessary. */
1489 atomic_add((uint8_t *)ptr, 0);
1491 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1492 error_setg_errno(errp, errno, "Cannot read pagemap");
1495 if ((pinfo & (1ull << 63)) == 0) {
1496 error_setg(errp, "Page not present");
1499 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1506 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1508 hwaddr addr = qdict_get_int(qdict, "addr");
1509 Error *local_err = NULL;
1510 MemoryRegion *mr = NULL;
1514 ptr = gpa2hva(&mr, addr, &local_err);
1516 error_report_err(local_err);
1520 physaddr = vtop(ptr, &local_err);
1522 error_report_err(local_err);
1524 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1525 " (%s) is 0x%" PRIx64 "\n",
1526 addr, mr->name, (uint64_t) physaddr);
1529 memory_region_unref(mr);
1533 static void do_print(Monitor *mon, const QDict *qdict)
1535 int format = qdict_get_int(qdict, "format");
1536 hwaddr val = qdict_get_int(qdict, "val");
1540 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1543 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1546 monitor_printf(mon, "%" HWADDR_PRIu, val);
1550 monitor_printf(mon, "%" HWADDR_PRId, val);
1553 monitor_printc(mon, val);
1556 monitor_printf(mon, "\n");
1559 static void hmp_sum(Monitor *mon, const QDict *qdict)
1563 uint32_t start = qdict_get_int(qdict, "start");
1564 uint32_t size = qdict_get_int(qdict, "size");
1567 for(addr = start; addr < (start + size); addr++) {
1568 uint8_t val = address_space_ldub(&address_space_memory, addr,
1569 MEMTXATTRS_UNSPECIFIED, NULL);
1570 /* BSD sum algorithm ('sum' Unix command) */
1571 sum = (sum >> 1) | (sum << 15);
1574 monitor_printf(mon, "%05d\n", sum);
1577 static int mouse_button_state;
1579 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1581 int dx, dy, dz, button;
1582 const char *dx_str = qdict_get_str(qdict, "dx_str");
1583 const char *dy_str = qdict_get_str(qdict, "dy_str");
1584 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1586 dx = strtol(dx_str, NULL, 0);
1587 dy = strtol(dy_str, NULL, 0);
1588 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1589 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1592 dz = strtol(dz_str, NULL, 0);
1594 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1595 qemu_input_queue_btn(NULL, button, true);
1596 qemu_input_event_sync();
1597 qemu_input_queue_btn(NULL, button, false);
1600 qemu_input_event_sync();
1603 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1605 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1606 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1607 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1608 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1610 int button_state = qdict_get_int(qdict, "button_state");
1612 if (mouse_button_state == button_state) {
1615 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1616 qemu_input_event_sync();
1617 mouse_button_state = button_state;
1620 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1622 int size = qdict_get_int(qdict, "size");
1623 int addr = qdict_get_int(qdict, "addr");
1624 int has_index = qdict_haskey(qdict, "index");
1629 int index = qdict_get_int(qdict, "index");
1630 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1638 val = cpu_inb(addr);
1642 val = cpu_inw(addr);
1646 val = cpu_inl(addr);
1650 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1651 suffix, addr, size * 2, val);
1654 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1656 int size = qdict_get_int(qdict, "size");
1657 int addr = qdict_get_int(qdict, "addr");
1658 int val = qdict_get_int(qdict, "val");
1660 addr &= IOPORTS_MASK;
1665 cpu_outb(addr, val);
1668 cpu_outw(addr, val);
1671 cpu_outl(addr, val);
1676 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1678 Error *local_err = NULL;
1679 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1681 qemu_boot_set(bootdevice, &local_err);
1683 error_report_err(local_err);
1685 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1689 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1691 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1693 mtree_info((fprintf_function)monitor_printf, mon, flatview);
1696 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1702 node_mem = g_new0(uint64_t, nb_numa_nodes);
1703 query_numa_node_mem(node_mem);
1704 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1705 for (i = 0; i < nb_numa_nodes; i++) {
1706 monitor_printf(mon, "node %d cpus:", i);
1708 if (cpu->numa_node == i) {
1709 monitor_printf(mon, " %d", cpu->cpu_index);
1712 monitor_printf(mon, "\n");
1713 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1719 #ifdef CONFIG_PROFILER
1724 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1726 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1727 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1728 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1729 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1734 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1736 monitor_printf(mon, "Internal profiler not compiled\n");
1740 /* Capture support */
1741 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1743 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1748 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1749 monitor_printf(mon, "[%d]: ", i);
1750 s->ops.info (s->opaque);
1754 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1757 int n = qdict_get_int(qdict, "n");
1760 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1762 s->ops.destroy (s->opaque);
1763 QLIST_REMOVE (s, entries);
1770 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1772 const char *path = qdict_get_str(qdict, "path");
1773 int has_freq = qdict_haskey(qdict, "freq");
1774 int freq = qdict_get_try_int(qdict, "freq", -1);
1775 int has_bits = qdict_haskey(qdict, "bits");
1776 int bits = qdict_get_try_int(qdict, "bits", -1);
1777 int has_channels = qdict_haskey(qdict, "nchannels");
1778 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1781 s = g_malloc0 (sizeof (*s));
1783 freq = has_freq ? freq : 44100;
1784 bits = has_bits ? bits : 16;
1785 nchannels = has_channels ? nchannels : 2;
1787 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1788 monitor_printf(mon, "Failed to add wave capture\n");
1792 QLIST_INSERT_HEAD (&capture_head, s, entries);
1795 static qemu_acl *find_acl(Monitor *mon, const char *name)
1797 qemu_acl *acl = qemu_acl_find(name);
1800 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1805 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1807 const char *aclname = qdict_get_str(qdict, "aclname");
1808 qemu_acl *acl = find_acl(mon, aclname);
1809 qemu_acl_entry *entry;
1813 monitor_printf(mon, "policy: %s\n",
1814 acl->defaultDeny ? "deny" : "allow");
1815 QTAILQ_FOREACH(entry, &acl->entries, next) {
1817 monitor_printf(mon, "%d: %s %s\n", i,
1818 entry->deny ? "deny" : "allow", entry->match);
1823 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1825 const char *aclname = qdict_get_str(qdict, "aclname");
1826 qemu_acl *acl = find_acl(mon, aclname);
1829 qemu_acl_reset(acl);
1830 monitor_printf(mon, "acl: removed all rules\n");
1834 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1836 const char *aclname = qdict_get_str(qdict, "aclname");
1837 const char *policy = qdict_get_str(qdict, "policy");
1838 qemu_acl *acl = find_acl(mon, aclname);
1841 if (strcmp(policy, "allow") == 0) {
1842 acl->defaultDeny = 0;
1843 monitor_printf(mon, "acl: policy set to 'allow'\n");
1844 } else if (strcmp(policy, "deny") == 0) {
1845 acl->defaultDeny = 1;
1846 monitor_printf(mon, "acl: policy set to 'deny'\n");
1848 monitor_printf(mon, "acl: unknown policy '%s', "
1849 "expected 'deny' or 'allow'\n", policy);
1854 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1856 const char *aclname = qdict_get_str(qdict, "aclname");
1857 const char *match = qdict_get_str(qdict, "match");
1858 const char *policy = qdict_get_str(qdict, "policy");
1859 int has_index = qdict_haskey(qdict, "index");
1860 int index = qdict_get_try_int(qdict, "index", -1);
1861 qemu_acl *acl = find_acl(mon, aclname);
1865 if (strcmp(policy, "allow") == 0) {
1867 } else if (strcmp(policy, "deny") == 0) {
1870 monitor_printf(mon, "acl: unknown policy '%s', "
1871 "expected 'deny' or 'allow'\n", policy);
1875 ret = qemu_acl_insert(acl, deny, match, index);
1877 ret = qemu_acl_append(acl, deny, match);
1879 monitor_printf(mon, "acl: unable to add acl entry\n");
1881 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1885 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1887 const char *aclname = qdict_get_str(qdict, "aclname");
1888 const char *match = qdict_get_str(qdict, "match");
1889 qemu_acl *acl = find_acl(mon, aclname);
1893 ret = qemu_acl_remove(acl, match);
1895 monitor_printf(mon, "acl: no matching acl entry\n");
1897 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1901 void qmp_getfd(const char *fdname, Error **errp)
1906 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1908 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1912 if (qemu_isdigit(fdname[0])) {
1914 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1915 "a name not starting with a digit");
1919 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1920 if (strcmp(monfd->name, fdname) != 0) {
1929 monfd = g_malloc0(sizeof(mon_fd_t));
1930 monfd->name = g_strdup(fdname);
1933 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1936 void qmp_closefd(const char *fdname, Error **errp)
1940 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1941 if (strcmp(monfd->name, fdname) != 0) {
1945 QLIST_REMOVE(monfd, next);
1947 g_free(monfd->name);
1952 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1955 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1959 QLIST_FOREACH(monfd, &mon->fds, next) {
1962 if (strcmp(monfd->name, fdname) != 0) {
1968 /* caller takes ownership of fd */
1969 QLIST_REMOVE(monfd, next);
1970 g_free(monfd->name);
1976 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1980 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1982 MonFdsetFd *mon_fdset_fd;
1983 MonFdsetFd *mon_fdset_fd_next;
1985 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
1986 if ((mon_fdset_fd->removed ||
1987 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
1988 runstate_is_running()) {
1989 close(mon_fdset_fd->fd);
1990 g_free(mon_fdset_fd->opaque);
1991 QLIST_REMOVE(mon_fdset_fd, next);
1992 g_free(mon_fdset_fd);
1996 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
1997 QLIST_REMOVE(mon_fdset, next);
2002 static void monitor_fdsets_cleanup(void)
2004 MonFdset *mon_fdset;
2005 MonFdset *mon_fdset_next;
2007 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2008 monitor_fdset_cleanup(mon_fdset);
2012 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2013 const char *opaque, Error **errp)
2016 Monitor *mon = cur_mon;
2019 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2021 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2025 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2026 has_opaque, opaque, errp);
2038 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2040 MonFdset *mon_fdset;
2041 MonFdsetFd *mon_fdset_fd;
2044 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2045 if (mon_fdset->id != fdset_id) {
2048 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2050 if (mon_fdset_fd->fd != fd) {
2053 mon_fdset_fd->removed = true;
2056 mon_fdset_fd->removed = true;
2059 if (has_fd && !mon_fdset_fd) {
2062 monitor_fdset_cleanup(mon_fdset);
2068 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2071 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2073 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2076 FdsetInfoList *qmp_query_fdsets(Error **errp)
2078 MonFdset *mon_fdset;
2079 MonFdsetFd *mon_fdset_fd;
2080 FdsetInfoList *fdset_list = NULL;
2082 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2083 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2084 FdsetFdInfoList *fdsetfd_list = NULL;
2086 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2087 fdset_info->value->fdset_id = mon_fdset->id;
2089 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2090 FdsetFdInfoList *fdsetfd_info;
2092 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2093 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2094 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2095 if (mon_fdset_fd->opaque) {
2096 fdsetfd_info->value->has_opaque = true;
2097 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2099 fdsetfd_info->value->has_opaque = false;
2102 fdsetfd_info->next = fdsetfd_list;
2103 fdsetfd_list = fdsetfd_info;
2106 fdset_info->value->fds = fdsetfd_list;
2108 fdset_info->next = fdset_list;
2109 fdset_list = fdset_info;
2115 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2116 bool has_opaque, const char *opaque,
2119 MonFdset *mon_fdset = NULL;
2120 MonFdsetFd *mon_fdset_fd;
2124 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2125 /* Break if match found or match impossible due to ordering by ID */
2126 if (fdset_id <= mon_fdset->id) {
2127 if (fdset_id < mon_fdset->id) {
2135 if (mon_fdset == NULL) {
2136 int64_t fdset_id_prev = -1;
2137 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2141 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2142 "a non-negative value");
2145 /* Use specified fdset ID */
2146 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2147 mon_fdset_cur = mon_fdset;
2148 if (fdset_id < mon_fdset_cur->id) {
2153 /* Use first available fdset ID */
2154 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2155 mon_fdset_cur = mon_fdset;
2156 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2157 fdset_id_prev = mon_fdset_cur->id;
2164 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2166 mon_fdset->id = fdset_id;
2168 mon_fdset->id = fdset_id_prev + 1;
2171 /* The fdset list is ordered by fdset ID */
2172 if (!mon_fdset_cur) {
2173 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2174 } else if (mon_fdset->id < mon_fdset_cur->id) {
2175 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2177 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2181 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2182 mon_fdset_fd->fd = fd;
2183 mon_fdset_fd->removed = false;
2185 mon_fdset_fd->opaque = g_strdup(opaque);
2187 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2189 fdinfo = g_malloc0(sizeof(*fdinfo));
2190 fdinfo->fdset_id = mon_fdset->id;
2191 fdinfo->fd = mon_fdset_fd->fd;
2196 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2199 MonFdset *mon_fdset;
2200 MonFdsetFd *mon_fdset_fd;
2203 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2204 if (mon_fdset->id != fdset_id) {
2207 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2208 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2209 if (mon_fd_flags == -1) {
2213 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2214 return mon_fdset_fd->fd;
2226 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2228 MonFdset *mon_fdset;
2229 MonFdsetFd *mon_fdset_fd_dup;
2231 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2232 if (mon_fdset->id != fdset_id) {
2235 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2236 if (mon_fdset_fd_dup->fd == dup_fd) {
2240 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2241 mon_fdset_fd_dup->fd = dup_fd;
2242 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2248 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2250 MonFdset *mon_fdset;
2251 MonFdsetFd *mon_fdset_fd_dup;
2253 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2254 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2255 if (mon_fdset_fd_dup->fd == dup_fd) {
2257 QLIST_REMOVE(mon_fdset_fd_dup, next);
2258 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2259 monitor_fdset_cleanup(mon_fdset);
2263 return mon_fdset->id;
2271 int monitor_fdset_dup_fd_find(int dup_fd)
2273 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2276 void monitor_fdset_dup_fd_remove(int dup_fd)
2278 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2281 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2284 Error *local_err = NULL;
2286 if (!qemu_isdigit(fdname[0]) && mon) {
2287 fd = monitor_get_fd(mon, fdname, &local_err);
2289 fd = qemu_parse_fd(fdname);
2291 error_setg(&local_err, "Invalid file descriptor number '%s'",
2296 error_propagate(errp, local_err);
2305 /* Please update hmp-commands.hx when adding or changing commands */
2306 static mon_cmd_t info_cmds[] = {
2307 #include "hmp-commands-info.h"
2311 /* mon_cmds and info_cmds would be sorted at runtime */
2312 static mon_cmd_t mon_cmds[] = {
2313 #include "hmp-commands.h"
2317 /*******************************************************************/
2319 static const char *pch;
2320 static sigjmp_buf expr_env;
2323 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2324 expr_error(Monitor *mon, const char *fmt, ...)
2328 monitor_vprintf(mon, fmt, ap);
2329 monitor_printf(mon, "\n");
2331 siglongjmp(expr_env, 1);
2334 /* return 0 if OK, -1 if not found */
2335 static int get_monitor_def(target_long *pval, const char *name)
2337 const MonitorDef *md = target_monitor_defs();
2338 CPUState *cs = mon_get_cpu();
2343 if (cs == NULL || md == NULL) {
2347 for(; md->name != NULL; md++) {
2348 if (compare_cmd(name, md->name)) {
2349 if (md->get_value) {
2350 *pval = md->get_value(md, md->offset);
2352 CPUArchState *env = mon_get_cpu_env();
2353 ptr = (uint8_t *)env + md->offset;
2356 *pval = *(int32_t *)ptr;
2359 *pval = *(target_long *)ptr;
2370 ret = target_get_monitor_def(cs, name, &tmp);
2372 *pval = (target_long) tmp;
2378 static void next(void)
2382 while (qemu_isspace(*pch))
2387 static int64_t expr_sum(Monitor *mon);
2389 static int64_t expr_unary(Monitor *mon)
2398 n = expr_unary(mon);
2402 n = -expr_unary(mon);
2406 n = ~expr_unary(mon);
2412 expr_error(mon, "')' expected");
2419 expr_error(mon, "character constant expected");
2423 expr_error(mon, "missing terminating \' character");
2433 while ((*pch >= 'a' && *pch <= 'z') ||
2434 (*pch >= 'A' && *pch <= 'Z') ||
2435 (*pch >= '0' && *pch <= '9') ||
2436 *pch == '_' || *pch == '.') {
2437 if ((q - buf) < sizeof(buf) - 1)
2441 while (qemu_isspace(*pch))
2444 ret = get_monitor_def(®, buf);
2446 expr_error(mon, "unknown register");
2451 expr_error(mon, "unexpected end of expression");
2456 n = strtoull(pch, &p, 0);
2457 if (errno == ERANGE) {
2458 expr_error(mon, "number too large");
2461 expr_error(mon, "invalid char '%c' in expression", *p);
2464 while (qemu_isspace(*pch))
2472 static int64_t expr_prod(Monitor *mon)
2477 val = expr_unary(mon);
2480 if (op != '*' && op != '/' && op != '%')
2483 val2 = expr_unary(mon);
2492 expr_error(mon, "division by zero");
2503 static int64_t expr_logic(Monitor *mon)
2508 val = expr_prod(mon);
2511 if (op != '&' && op != '|' && op != '^')
2514 val2 = expr_prod(mon);
2531 static int64_t expr_sum(Monitor *mon)
2536 val = expr_logic(mon);
2539 if (op != '+' && op != '-')
2542 val2 = expr_logic(mon);
2551 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2554 if (sigsetjmp(expr_env, 0)) {
2558 while (qemu_isspace(*pch))
2560 *pval = expr_sum(mon);
2565 static int get_double(Monitor *mon, double *pval, const char **pp)
2567 const char *p = *pp;
2571 d = strtod(p, &tailp);
2573 monitor_printf(mon, "Number expected\n");
2576 if (d != d || d - d != 0) {
2577 /* NaN or infinity */
2578 monitor_printf(mon, "Bad number\n");
2587 * Store the command-name in cmdname, and return a pointer to
2588 * the remaining of the command string.
2590 static const char *get_command_name(const char *cmdline,
2591 char *cmdname, size_t nlen)
2594 const char *p, *pstart;
2597 while (qemu_isspace(*p))
2602 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2607 memcpy(cmdname, pstart, len);
2608 cmdname[len] = '\0';
2613 * Read key of 'type' into 'key' and return the current
2616 static char *key_get_info(const char *type, char **key)
2624 p = strchr(type, ':');
2631 str = g_malloc(len + 1);
2632 memcpy(str, type, len);
2639 static int default_fmt_format = 'x';
2640 static int default_fmt_size = 4;
2642 static int is_valid_option(const char *c, const char *typestr)
2650 typestr = strstr(typestr, option);
2651 return (typestr != NULL);
2654 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2655 const char *cmdname)
2657 const mon_cmd_t *cmd;
2659 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2660 if (compare_cmd(cmdname, cmd->name)) {
2669 * Parse command name from @cmdp according to command table @table.
2670 * If blank, return NULL.
2671 * Else, if no valid command can be found, report to @mon, and return
2673 * Else, change @cmdp to point right behind the name, and return its
2674 * command table entry.
2675 * Do not assume the return value points into @table! It doesn't when
2676 * the command is found in a sub-command table.
2678 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2683 const mon_cmd_t *cmd;
2686 /* extract the command name */
2687 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2691 cmd = search_dispatch_table(table, cmdname);
2693 monitor_printf(mon, "unknown command: '%.*s'\n",
2694 (int)(p - *cmdp), *cmdp);
2698 /* filter out following useless space */
2699 while (qemu_isspace(*p)) {
2704 /* search sub command */
2705 if (cmd->sub_table != NULL && *p != '\0') {
2706 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2713 * Parse arguments for @cmd.
2714 * If it can't be parsed, report to @mon, and return NULL.
2715 * Else, insert command arguments into a QDict, and return it.
2716 * Note: On success, caller has to free the QDict structure.
2719 static QDict *monitor_parse_arguments(Monitor *mon,
2721 const mon_cmd_t *cmd)
2723 const char *typestr;
2726 const char *p = *endp;
2728 QDict *qdict = qdict_new();
2730 /* parse the parameters */
2731 typestr = cmd->args_type;
2733 typestr = key_get_info(typestr, &key);
2745 while (qemu_isspace(*p))
2747 if (*typestr == '?') {
2750 /* no optional string: NULL argument */
2754 ret = get_str(buf, sizeof(buf), &p);
2758 monitor_printf(mon, "%s: filename expected\n",
2762 monitor_printf(mon, "%s: block device name expected\n",
2766 monitor_printf(mon, "%s: string expected\n", cmd->name);
2771 qdict_put_str(qdict, key, buf);
2776 QemuOptsList *opts_list;
2779 opts_list = qemu_find_opts(key);
2780 if (!opts_list || opts_list->desc->name) {
2783 while (qemu_isspace(*p)) {
2788 if (get_str(buf, sizeof(buf), &p) < 0) {
2791 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2795 qemu_opts_to_qdict(opts, qdict);
2796 qemu_opts_del(opts);
2801 int count, format, size;
2803 while (qemu_isspace(*p))
2809 if (qemu_isdigit(*p)) {
2811 while (qemu_isdigit(*p)) {
2812 count = count * 10 + (*p - '0');
2850 if (*p != '\0' && !qemu_isspace(*p)) {
2851 monitor_printf(mon, "invalid char in format: '%c'\n",
2856 format = default_fmt_format;
2857 if (format != 'i') {
2858 /* for 'i', not specifying a size gives -1 as size */
2860 size = default_fmt_size;
2861 default_fmt_size = size;
2863 default_fmt_format = format;
2866 format = default_fmt_format;
2867 if (format != 'i') {
2868 size = default_fmt_size;
2873 qdict_put_int(qdict, "count", count);
2874 qdict_put_int(qdict, "format", format);
2875 qdict_put_int(qdict, "size", size);
2884 while (qemu_isspace(*p))
2886 if (*typestr == '?' || *typestr == '.') {
2887 if (*typestr == '?') {
2895 while (qemu_isspace(*p))
2904 if (get_expr(mon, &val, &p))
2906 /* Check if 'i' is greater than 32-bit */
2907 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2908 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2909 monitor_printf(mon, "integer is for 32-bit values\n");
2911 } else if (c == 'M') {
2913 monitor_printf(mon, "enter a positive value\n");
2918 qdict_put_int(qdict, key, val);
2927 while (qemu_isspace(*p)) {
2930 if (*typestr == '?') {
2936 ret = qemu_strtosz_MiB(p, &end, &val);
2937 if (ret < 0 || val > INT64_MAX) {
2938 monitor_printf(mon, "invalid size\n");
2941 qdict_put_int(qdict, key, val);
2949 while (qemu_isspace(*p))
2951 if (*typestr == '?') {
2957 if (get_double(mon, &val, &p) < 0) {
2960 if (p[0] && p[1] == 's') {
2963 val /= 1e3; p += 2; break;
2965 val /= 1e6; p += 2; break;
2967 val /= 1e9; p += 2; break;
2970 if (*p && !qemu_isspace(*p)) {
2971 monitor_printf(mon, "Unknown unit suffix\n");
2974 qdict_put(qdict, key, qfloat_from_double(val));
2982 while (qemu_isspace(*p)) {
2986 while (qemu_isgraph(*p)) {
2989 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
2991 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
2994 monitor_printf(mon, "Expected 'on' or 'off'\n");
2997 qdict_put_bool(qdict, key, val);
3002 const char *tmp = p;
3009 while (qemu_isspace(*p))
3014 if(!is_valid_option(p, typestr)) {
3016 monitor_printf(mon, "%s: unsupported option -%c\n",
3028 qdict_put_bool(qdict, key, true);
3035 /* package all remaining string */
3038 while (qemu_isspace(*p)) {
3041 if (*typestr == '?') {
3044 /* no remaining string: NULL argument */
3050 monitor_printf(mon, "%s: string expected\n",
3054 qdict_put_str(qdict, key, p);
3060 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3066 /* check that all arguments were parsed */
3067 while (qemu_isspace(*p))
3070 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3083 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3086 const mon_cmd_t *cmd;
3088 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
3093 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3095 monitor_printf(mon, "Try \"help %s\" for more information\n",
3100 cmd->cmd(mon, qdict);
3104 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3106 const char *p, *pstart;
3115 p = pstart + strlen(pstart);
3117 if (len > sizeof(cmd) - 2)
3118 len = sizeof(cmd) - 2;
3119 memcpy(cmd, pstart, len);
3121 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3122 readline_add_completion(mon->rs, cmd);
3130 static void file_completion(Monitor *mon, const char *input)
3135 char file[1024], file_prefix[1024];
3139 p = strrchr(input, '/');
3142 pstrcpy(file_prefix, sizeof(file_prefix), input);
3143 pstrcpy(path, sizeof(path), ".");
3145 input_path_len = p - input + 1;
3146 memcpy(path, input, input_path_len);
3147 if (input_path_len > sizeof(path) - 1)
3148 input_path_len = sizeof(path) - 1;
3149 path[input_path_len] = '\0';
3150 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3153 ffs = opendir(path);
3162 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3166 if (strstart(d->d_name, file_prefix, NULL)) {
3167 memcpy(file, input, input_path_len);
3168 if (input_path_len < sizeof(file))
3169 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3171 /* stat the file to find out if it's a directory.
3172 * In that case add a slash to speed up typing long paths
3174 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3175 pstrcat(file, sizeof(file), "/");
3177 readline_add_completion(mon->rs, file);
3183 static const char *next_arg_type(const char *typestr)
3185 const char *p = strchr(typestr, ':');
3186 return (p != NULL ? ++p : typestr);
3189 static void add_completion_option(ReadLineState *rs, const char *str,
3192 if (!str || !option) {
3195 if (!strncmp(option, str, strlen(str))) {
3196 readline_add_completion(rs, option);
3200 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3203 ChardevBackendInfoList *list, *start;
3209 readline_set_completion_index(rs, len);
3211 start = list = qmp_query_chardev_backends(NULL);
3213 const char *chr_name = list->value->name;
3215 if (!strncmp(chr_name, str, len)) {
3216 readline_add_completion(rs, chr_name);
3220 qapi_free_ChardevBackendInfoList(start);
3223 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3232 readline_set_completion_index(rs, len);
3233 for (i = 0; NetClientDriver_lookup[i]; i++) {
3234 add_completion_option(rs, str, NetClientDriver_lookup[i]);
3238 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3248 readline_set_completion_index(rs, len);
3249 list = elt = object_class_get_list(TYPE_DEVICE, false);
3252 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3254 name = object_class_get_name(OBJECT_CLASS(dc));
3256 if (dc->user_creatable
3257 && !strncmp(name, str, len)) {
3258 readline_add_completion(rs, name);
3265 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3275 readline_set_completion_index(rs, len);
3276 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3280 name = object_class_get_name(OBJECT_CLASS(elt->data));
3281 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3282 readline_add_completion(rs, name);
3289 static void peripheral_device_del_completion(ReadLineState *rs,
3290 const char *str, size_t len)
3292 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3293 GSList *list, *item;
3295 list = qdev_build_hotpluggable_device_list(peripheral);
3300 for (item = list; item; item = g_slist_next(item)) {
3301 DeviceState *dev = item->data;
3303 if (dev->id && !strncmp(str, dev->id, len)) {
3304 readline_add_completion(rs, dev->id);
3311 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3314 ChardevInfoList *list, *start;
3320 readline_set_completion_index(rs, len);
3322 start = list = qmp_query_chardev(NULL);
3324 ChardevInfo *chr = list->value;
3326 if (!strncmp(chr->label, str, len)) {
3327 readline_add_completion(rs, chr->label);
3331 qapi_free_ChardevInfoList(start);
3334 static void ringbuf_completion(ReadLineState *rs, const char *str)
3337 ChardevInfoList *list, *start;
3340 readline_set_completion_index(rs, len);
3342 start = list = qmp_query_chardev(NULL);
3344 ChardevInfo *chr_info = list->value;
3346 if (!strncmp(chr_info->label, str, len)) {
3347 Chardev *chr = qemu_chr_find(chr_info->label);
3348 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3349 readline_add_completion(rs, chr_info->label);
3354 qapi_free_ChardevInfoList(start);
3357 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3362 ringbuf_completion(rs, str);
3365 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3374 readline_set_completion_index(rs, len);
3375 peripheral_device_del_completion(rs, str, len);
3378 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3380 ObjectPropertyInfoList *list, *start;
3387 readline_set_completion_index(rs, len);
3389 start = list = qmp_qom_list("/objects", NULL);
3391 ObjectPropertyInfo *info = list->value;
3393 if (!strncmp(info->type, "child<", 5)
3394 && !strncmp(info->name, str, len)) {
3395 readline_add_completion(rs, info->name);
3399 qapi_free_ObjectPropertyInfoList(start);
3402 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3411 sep = strrchr(str, '-');
3416 readline_set_completion_index(rs, len);
3417 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3418 if (!strncmp(str, QKeyCode_lookup[i], len)) {
3419 readline_add_completion(rs, QKeyCode_lookup[i]);
3424 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3429 readline_set_completion_index(rs, len);
3431 NetClientState *ncs[MAX_QUEUE_NUM];
3433 count = qemu_find_net_clients_except(NULL, ncs,
3434 NET_CLIENT_DRIVER_NONE,
3436 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3437 const char *name = ncs[i]->name;
3438 if (!strncmp(str, name, len)) {
3439 readline_add_completion(rs, name);
3442 } else if (nb_args == 3) {
3443 add_completion_option(rs, str, "on");
3444 add_completion_option(rs, str, "off");
3448 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3451 NetClientState *ncs[MAX_QUEUE_NUM];
3458 readline_set_completion_index(rs, len);
3459 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3461 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3463 const char *name = ncs[i]->name;
3464 if (strncmp(str, name, len)) {
3467 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3469 readline_add_completion(rs, name);
3474 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3479 readline_set_completion_index(rs, len);
3481 TraceEventIter iter;
3483 char *pattern = g_strdup_printf("%s*", str);
3484 trace_event_iter_init(&iter, pattern);
3485 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3486 readline_add_completion(rs, trace_event_get_name(ev));
3492 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3497 readline_set_completion_index(rs, len);
3499 TraceEventIter iter;
3501 char *pattern = g_strdup_printf("%s*", str);
3502 trace_event_iter_init(&iter, pattern);
3503 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3504 readline_add_completion(rs, trace_event_get_name(ev));
3507 } else if (nb_args == 3) {
3508 add_completion_option(rs, str, "on");
3509 add_completion_option(rs, str, "off");
3513 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3520 readline_set_completion_index(rs, strlen(str));
3521 for (i = 0; WatchdogExpirationAction_lookup[i]; i++) {
3522 add_completion_option(rs, str, WatchdogExpirationAction_lookup[i]);
3526 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3532 readline_set_completion_index(rs, len);
3535 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3536 const char *name = MigrationCapability_lookup[i];
3537 if (!strncmp(str, name, len)) {
3538 readline_add_completion(rs, name);
3541 } else if (nb_args == 3) {
3542 add_completion_option(rs, str, "on");
3543 add_completion_option(rs, str, "off");
3547 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3553 readline_set_completion_index(rs, len);
3556 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3557 const char *name = MigrationParameter_lookup[i];
3558 if (!strncmp(str, name, len)) {
3559 readline_add_completion(rs, name);
3565 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3573 readline_set_completion_index(rs, len);
3574 for (i = 0; host_net_devices[i]; i++) {
3575 if (!strncmp(host_net_devices[i], str, len)) {
3576 readline_add_completion(rs, host_net_devices[i]);
3581 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3583 NetClientState *ncs[MAX_QUEUE_NUM];
3587 readline_set_completion_index(rs, len);
3589 count = qemu_find_net_clients_except(NULL, ncs,
3590 NET_CLIENT_DRIVER_NONE,
3592 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3596 if (net_hub_id_for_client(ncs[i], &id)) {
3599 snprintf(name, sizeof(name), "%d", id);
3600 if (!strncmp(str, name, len)) {
3601 readline_add_completion(rs, name);
3605 } else if (nb_args == 3) {
3606 count = qemu_find_net_clients_except(NULL, ncs,
3607 NET_CLIENT_DRIVER_NIC,
3609 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3613 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3614 net_hub_id_for_client(ncs[i], &id)) {
3617 name = ncs[i]->name;
3618 if (!strncmp(str, name, len)) {
3619 readline_add_completion(rs, name);
3626 static void vm_completion(ReadLineState *rs, const char *str)
3629 BlockDriverState *bs;
3630 BdrvNextIterator it;
3633 readline_set_completion_index(rs, len);
3635 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3636 SnapshotInfoList *snapshots, *snapshot;
3637 AioContext *ctx = bdrv_get_aio_context(bs);
3640 aio_context_acquire(ctx);
3641 if (bdrv_can_snapshot(bs)) {
3642 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3644 aio_context_release(ctx);
3649 snapshot = snapshots;
3651 char *completion = snapshot->value->name;
3652 if (!strncmp(str, completion, len)) {
3653 readline_add_completion(rs, completion);
3655 completion = snapshot->value->id;
3656 if (!strncmp(str, completion, len)) {
3657 readline_add_completion(rs, completion);
3659 snapshot = snapshot->next;
3661 qapi_free_SnapshotInfoList(snapshots);
3666 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3669 vm_completion(rs, str);
3673 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3676 vm_completion(rs, str);
3680 static void monitor_find_completion_by_table(Monitor *mon,
3681 const mon_cmd_t *cmd_table,
3685 const char *cmdname;
3687 const char *ptype, *str, *name;
3688 const mon_cmd_t *cmd;
3689 BlockBackend *blk = NULL;
3692 /* command completion */
3697 readline_set_completion_index(mon->rs, strlen(cmdname));
3698 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3699 cmd_completion(mon, cmdname, cmd->name);
3702 /* find the command */
3703 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3704 if (compare_cmd(args[0], cmd->name)) {
3712 if (cmd->sub_table) {
3713 /* do the job again */
3714 monitor_find_completion_by_table(mon, cmd->sub_table,
3715 &args[1], nb_args - 1);
3718 if (cmd->command_completion) {
3719 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3723 ptype = next_arg_type(cmd->args_type);
3724 for(i = 0; i < nb_args - 2; i++) {
3725 if (*ptype != '\0') {
3726 ptype = next_arg_type(ptype);
3727 while (*ptype == '?')
3728 ptype = next_arg_type(ptype);
3731 str = args[nb_args - 1];
3732 while (*ptype == '-' && ptype[1] != '\0') {
3733 ptype = next_arg_type(ptype);
3737 /* file completion */
3738 readline_set_completion_index(mon->rs, strlen(str));
3739 file_completion(mon, str);
3742 /* block device name completion */
3743 readline_set_completion_index(mon->rs, strlen(str));
3744 while ((blk = blk_next(blk)) != NULL) {
3745 name = blk_name(blk);
3746 if (str[0] == '\0' ||
3747 !strncmp(name, str, strlen(str))) {
3748 readline_add_completion(mon->rs, name);
3754 if (!strcmp(cmd->name, "help|?")) {
3755 monitor_find_completion_by_table(mon, cmd_table,
3756 &args[1], nb_args - 1);
3765 static void monitor_find_completion(void *opaque,
3766 const char *cmdline)
3768 Monitor *mon = opaque;
3769 char *args[MAX_ARGS];
3772 /* 1. parse the cmdline */
3773 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3777 /* if the line ends with a space, it means we want to complete the
3779 len = strlen(cmdline);
3780 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3781 if (nb_args >= MAX_ARGS) {
3784 args[nb_args++] = g_strdup("");
3787 /* 2. auto complete according to args */
3788 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3791 free_cmdline_args(args, nb_args);
3794 static int monitor_can_read(void *opaque)
3796 Monitor *mon = opaque;
3798 return (mon->suspend_cnt == 0) ? 1 : 0;
3801 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3803 QObject *req, *rsp = NULL, *id = NULL;
3804 QDict *qdict = NULL;
3805 Monitor *mon = cur_mon;
3808 req = json_parser_parse_err(tokens, NULL, &err);
3810 /* json_parser_parse_err() sucks: can fail without setting @err */
3811 error_setg(&err, QERR_JSON_PARSING);
3817 qdict = qobject_to_qdict(req);
3819 id = qdict_get(qdict, "id");
3821 qdict_del(qdict, "id");
3822 } /* else will fail qmp_dispatch() */
3824 rsp = qmp_dispatch(cur_mon->qmp.commands, req);
3826 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
3827 qdict = qdict_get_qdict(qobject_to_qdict(rsp), "error");
3829 && !g_strcmp0(qdict_get_try_str(qdict, "class"),
3830 QapiErrorClass_lookup[ERROR_CLASS_COMMAND_NOT_FOUND])) {
3831 /* Provide a more useful error message */
3832 qdict_del(qdict, "desc");
3833 qdict_put_str(qdict, "desc", "Expecting capabilities negotiation"
3834 " with 'qmp_capabilities'");
3840 qdict = qdict_new();
3841 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3843 rsp = QOBJECT(qdict);
3848 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3852 monitor_json_emitter(mon, rsp);
3856 qobject_decref(rsp);
3857 qobject_decref(req);
3860 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3862 Monitor *old_mon = cur_mon;
3866 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3871 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3873 Monitor *old_mon = cur_mon;
3879 for (i = 0; i < size; i++)
3880 readline_handle_byte(cur_mon->rs, buf[i]);
3882 if (size == 0 || buf[size - 1] != 0)
3883 monitor_printf(cur_mon, "corrupted command\n");
3885 handle_hmp_command(cur_mon, (char *)buf);
3891 static void monitor_command_cb(void *opaque, const char *cmdline,
3892 void *readline_opaque)
3894 Monitor *mon = opaque;
3896 monitor_suspend(mon);
3897 handle_hmp_command(mon, cmdline);
3898 monitor_resume(mon);
3901 int monitor_suspend(Monitor *mon)
3909 void monitor_resume(Monitor *mon)
3913 if (--mon->suspend_cnt == 0)
3914 readline_show_prompt(mon->rs);
3917 static QObject *get_qmp_greeting(void)
3919 QObject *ver = NULL;
3921 qmp_marshal_query_version(NULL, &ver, NULL);
3923 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3927 static void monitor_qmp_event(void *opaque, int event)
3930 Monitor *mon = opaque;
3933 case CHR_EVENT_OPENED:
3934 mon->qmp.commands = &qmp_cap_negotiation_commands;
3935 data = get_qmp_greeting();
3936 monitor_json_emitter(mon, data);
3937 qobject_decref(data);
3940 case CHR_EVENT_CLOSED:
3941 json_message_parser_destroy(&mon->qmp.parser);
3942 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3944 monitor_fdsets_cleanup();
3949 static void monitor_event(void *opaque, int event)
3951 Monitor *mon = opaque;
3954 case CHR_EVENT_MUX_IN:
3955 qemu_mutex_lock(&mon->out_lock);
3957 qemu_mutex_unlock(&mon->out_lock);
3958 if (mon->reset_seen) {
3959 readline_restart(mon->rs);
3960 monitor_resume(mon);
3963 mon->suspend_cnt = 0;
3967 case CHR_EVENT_MUX_OUT:
3968 if (mon->reset_seen) {
3969 if (mon->suspend_cnt == 0) {
3970 monitor_printf(mon, "\n");
3973 monitor_suspend(mon);
3977 qemu_mutex_lock(&mon->out_lock);
3979 qemu_mutex_unlock(&mon->out_lock);
3982 case CHR_EVENT_OPENED:
3983 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3984 "information\n", QEMU_VERSION);
3985 if (!mon->mux_out) {
3986 readline_restart(mon->rs);
3987 readline_show_prompt(mon->rs);
3989 mon->reset_seen = 1;
3993 case CHR_EVENT_CLOSED:
3995 monitor_fdsets_cleanup();
4001 compare_mon_cmd(const void *a, const void *b)
4003 return strcmp(((const mon_cmd_t *)a)->name,
4004 ((const mon_cmd_t *)b)->name);
4007 static void sortcmdlist(void)
4010 int elem_size = sizeof(mon_cmd_t);
4012 array_num = sizeof(mon_cmds)/elem_size-1;
4013 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4015 array_num = sizeof(info_cmds)/elem_size-1;
4016 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4019 /* These functions just adapt the readline interface in a typesafe way. We
4020 * could cast function pointers but that discards compiler checks.
4022 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4023 const char *fmt, ...)
4027 monitor_vprintf(opaque, fmt, ap);
4031 static void monitor_readline_flush(void *opaque)
4033 monitor_flush(opaque);
4037 * Print to current monitor if we have one, else to stderr.
4038 * TODO should return int, so callers can calculate width, but that
4039 * requires surgery to monitor_vprintf(). Left for another day.
4041 void error_vprintf(const char *fmt, va_list ap)
4043 if (cur_mon && !monitor_cur_is_qmp()) {
4044 monitor_vprintf(cur_mon, fmt, ap);
4046 vfprintf(stderr, fmt, ap);
4050 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4052 if (cur_mon && !monitor_cur_is_qmp()) {
4053 monitor_vprintf(cur_mon, fmt, ap);
4054 } else if (!cur_mon) {
4055 vfprintf(stderr, fmt, ap);
4059 static void __attribute__((constructor)) monitor_lock_init(void)
4061 qemu_mutex_init(&monitor_lock);
4064 void monitor_init(Chardev *chr, int flags)
4066 static int is_first_init = 1;
4069 if (is_first_init) {
4070 monitor_qapi_event_init();
4075 mon = g_malloc(sizeof(*mon));
4076 monitor_data_init(mon);
4078 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4080 if (flags & MONITOR_USE_READLINE) {
4081 mon->rs = readline_init(monitor_readline_printf,
4082 monitor_readline_flush,
4084 monitor_find_completion);
4085 monitor_read_command(mon, 0);
4088 if (monitor_is_qmp(mon)) {
4089 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4090 monitor_qmp_event, mon, NULL, true);
4091 qemu_chr_fe_set_echo(&mon->chr, true);
4092 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4094 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4095 monitor_event, mon, NULL, true);
4098 qemu_mutex_lock(&monitor_lock);
4099 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4100 qemu_mutex_unlock(&monitor_lock);
4103 void monitor_cleanup(void)
4105 Monitor *mon, *next;
4107 qemu_mutex_lock(&monitor_lock);
4108 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4109 QLIST_REMOVE(mon, entry);
4110 monitor_data_destroy(mon);
4113 qemu_mutex_unlock(&monitor_lock);
4116 static void bdrv_password_cb(void *opaque, const char *password,
4117 void *readline_opaque)
4119 Monitor *mon = opaque;
4120 BlockDriverState *bs = readline_opaque;
4122 Error *local_err = NULL;
4124 bdrv_add_key(bs, password, &local_err);
4126 error_report_err(local_err);
4129 if (mon->password_completion_cb)
4130 mon->password_completion_cb(mon->password_opaque, ret);
4132 monitor_read_command(mon, 1);
4135 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
4136 BlockCompletionFunc *completion_cb,
4141 monitor_printf(mon, "%s (%s) is encrypted.\n", bdrv_get_device_name(bs),
4142 bdrv_get_encrypted_filename(bs));
4144 mon->password_completion_cb = completion_cb;
4145 mon->password_opaque = opaque;
4147 err = monitor_read_password(mon, bdrv_password_cb, bs);
4149 if (err && completion_cb)
4150 completion_cb(opaque, err);
4155 int monitor_read_block_device_key(Monitor *mon, const char *device,
4156 BlockCompletionFunc *completion_cb,
4162 blk = blk_by_name(device);
4164 monitor_printf(mon, "Device not found %s\n", device);
4168 monitor_printf(mon, "Device '%s' has no medium\n", device);
4172 bdrv_add_key(blk_bs(blk), NULL, &err);
4175 return monitor_read_bdrv_key_start(mon, blk_bs(blk), completion_cb, opaque);
4178 if (completion_cb) {
4179 completion_cb(opaque, 0);
4184 QemuOptsList qemu_mon_opts = {
4186 .implied_opt_name = "chardev",
4187 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4191 .type = QEMU_OPT_STRING,
4194 .type = QEMU_OPT_STRING,
4196 .name = "default", /* deprecated */
4197 .type = QEMU_OPT_BOOL,
4200 .type = QEMU_OPT_BOOL,
4202 { /* end of list */ }
4207 void qmp_rtc_reset_reinjection(Error **errp)
4209 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4213 #ifndef TARGET_S390X
4214 void qmp_dump_skeys(const char *filename, Error **errp)
4216 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4221 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4223 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4228 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4230 MachineState *ms = MACHINE(qdev_get_machine());
4231 MachineClass *mc = MACHINE_GET_CLASS(ms);
4233 if (!mc->has_hotpluggable_cpus) {
4234 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4238 return machine_query_hotpluggable_cpus(ms);