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"
84 #include "hw/s390x/storage-attributes.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, false);
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_str(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 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1087 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1088 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1094 monitor_printf(mon, "No CPU available\n");
1098 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1103 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1105 if (!tcg_enabled()) {
1106 error_report("JIT information is only available with accel=tcg");
1110 dump_exec_info((FILE *)mon, monitor_fprintf);
1111 dump_drift_info((FILE *)mon, monitor_fprintf);
1114 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1116 dump_opcount_info((FILE *)mon, monitor_fprintf);
1120 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1129 str = readline_get_history(mon->rs, i);
1132 monitor_printf(mon, "%d: '%s'\n", i, str);
1137 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1139 CPUState *cs = mon_get_cpu();
1142 monitor_printf(mon, "No CPU available\n");
1145 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1148 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1150 const char *name = qdict_get_try_str(qdict, "name");
1151 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1152 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1153 TraceEventInfoList *events;
1154 TraceEventInfoList *elem;
1155 Error *local_err = NULL;
1161 monitor_printf(mon, "argument vcpu must be positive");
1165 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1167 error_report_err(local_err);
1171 for (elem = events; elem != NULL; elem = elem->next) {
1172 monitor_printf(mon, "%s : state %u\n",
1174 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1176 qapi_free_TraceEventInfoList(events);
1179 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1180 bool has_port, int64_t port,
1181 bool has_tls_port, int64_t tls_port,
1182 bool has_cert_subject, const char *cert_subject,
1185 if (strcmp(protocol, "spice") == 0) {
1186 if (!qemu_using_spice(errp)) {
1190 if (!has_port && !has_tls_port) {
1191 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1195 if (qemu_spice_migrate_info(hostname,
1196 has_port ? port : -1,
1197 has_tls_port ? tls_port : -1,
1199 error_setg(errp, QERR_UNDEFINED_ERROR);
1205 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1208 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1212 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1214 error_report_err(err);
1218 static void hmp_log(Monitor *mon, const QDict *qdict)
1221 const char *items = qdict_get_str(qdict, "items");
1223 if (!strcmp(items, "none")) {
1226 mask = qemu_str_to_log_mask(items);
1228 help_cmd(mon, "log");
1235 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1237 const char *option = qdict_get_try_str(qdict, "option");
1238 if (!option || !strcmp(option, "on")) {
1240 } else if (!strcmp(option, "off")) {
1243 monitor_printf(mon, "unexpected option %s\n", option);
1247 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1249 const char *device = qdict_get_try_str(qdict, "device");
1251 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1252 if (gdbserver_start(device) < 0) {
1253 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1255 } else if (strcmp(device, "none") == 0) {
1256 monitor_printf(mon, "Disabled gdbserver\n");
1258 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1263 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1265 const char *action = qdict_get_str(qdict, "action");
1266 if (select_watchdog_action(action) == -1) {
1267 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1271 static void monitor_printc(Monitor *mon, int c)
1273 monitor_printf(mon, "'");
1276 monitor_printf(mon, "\\'");
1279 monitor_printf(mon, "\\\\");
1282 monitor_printf(mon, "\\n");
1285 monitor_printf(mon, "\\r");
1288 if (c >= 32 && c <= 126) {
1289 monitor_printf(mon, "%c", c);
1291 monitor_printf(mon, "\\x%02x", c);
1295 monitor_printf(mon, "'");
1298 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1299 hwaddr addr, int is_physical)
1301 int l, line_size, i, max_digits, len;
1304 CPUState *cs = mon_get_cpu();
1306 if (!cs && (format == 'i' || !is_physical)) {
1307 monitor_printf(mon, "Can not dump without CPU\n");
1311 if (format == 'i') {
1314 CPUArchState *env = mon_get_cpu_env();
1317 } else if (wsize == 4) {
1320 /* as default we use the current CS size */
1323 #ifdef TARGET_X86_64
1324 if ((env->efer & MSR_EFER_LMA) &&
1325 (env->segs[R_CS].flags & DESC_L_MASK))
1329 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1335 CPUArchState *env = mon_get_cpu_env();
1336 flags = msr_le << 16;
1337 flags |= env->bfd_mach;
1339 monitor_disas(mon, cs, addr, count, is_physical, flags);
1343 len = wsize * count;
1352 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1356 max_digits = (wsize * 8) / 4;
1360 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1369 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1371 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1376 cpu_physical_memory_read(addr, buf, l);
1378 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1379 monitor_printf(mon, " Cannot access memory\n");
1388 v = ldub_p(buf + i);
1391 v = lduw_p(buf + i);
1394 v = (uint32_t)ldl_p(buf + i);
1400 monitor_printf(mon, " ");
1403 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1406 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1409 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1412 monitor_printf(mon, "%*" PRId64, max_digits, v);
1415 monitor_printc(mon, v);
1420 monitor_printf(mon, "\n");
1426 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1428 int count = qdict_get_int(qdict, "count");
1429 int format = qdict_get_int(qdict, "format");
1430 int size = qdict_get_int(qdict, "size");
1431 target_long addr = qdict_get_int(qdict, "addr");
1433 memory_dump(mon, count, format, size, addr, 0);
1436 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1438 int count = qdict_get_int(qdict, "count");
1439 int format = qdict_get_int(qdict, "format");
1440 int size = qdict_get_int(qdict, "size");
1441 hwaddr addr = qdict_get_int(qdict, "addr");
1443 memory_dump(mon, count, format, size, addr, 1);
1446 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1448 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1452 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1456 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1457 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1458 memory_region_unref(mrs.mr);
1463 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1466 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1468 hwaddr addr = qdict_get_int(qdict, "addr");
1469 Error *local_err = NULL;
1470 MemoryRegion *mr = NULL;
1473 ptr = gpa2hva(&mr, addr, &local_err);
1475 error_report_err(local_err);
1479 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1481 addr, mr->name, ptr);
1483 memory_region_unref(mr);
1487 static uint64_t vtop(void *ptr, Error **errp)
1491 uintptr_t addr = (uintptr_t) ptr;
1492 uintptr_t pagesize = getpagesize();
1493 off_t offset = addr / pagesize * sizeof(pinfo);
1496 fd = open("/proc/self/pagemap", O_RDONLY);
1498 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1502 /* Force copy-on-write if necessary. */
1503 atomic_add((uint8_t *)ptr, 0);
1505 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1506 error_setg_errno(errp, errno, "Cannot read pagemap");
1509 if ((pinfo & (1ull << 63)) == 0) {
1510 error_setg(errp, "Page not present");
1513 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1520 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1522 hwaddr addr = qdict_get_int(qdict, "addr");
1523 Error *local_err = NULL;
1524 MemoryRegion *mr = NULL;
1528 ptr = gpa2hva(&mr, addr, &local_err);
1530 error_report_err(local_err);
1534 physaddr = vtop(ptr, &local_err);
1536 error_report_err(local_err);
1538 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1539 " (%s) is 0x%" PRIx64 "\n",
1540 addr, mr->name, (uint64_t) physaddr);
1543 memory_region_unref(mr);
1547 static void do_print(Monitor *mon, const QDict *qdict)
1549 int format = qdict_get_int(qdict, "format");
1550 hwaddr val = qdict_get_int(qdict, "val");
1554 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1557 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1560 monitor_printf(mon, "%" HWADDR_PRIu, val);
1564 monitor_printf(mon, "%" HWADDR_PRId, val);
1567 monitor_printc(mon, val);
1570 monitor_printf(mon, "\n");
1573 static void hmp_sum(Monitor *mon, const QDict *qdict)
1577 uint32_t start = qdict_get_int(qdict, "start");
1578 uint32_t size = qdict_get_int(qdict, "size");
1581 for(addr = start; addr < (start + size); addr++) {
1582 uint8_t val = address_space_ldub(&address_space_memory, addr,
1583 MEMTXATTRS_UNSPECIFIED, NULL);
1584 /* BSD sum algorithm ('sum' Unix command) */
1585 sum = (sum >> 1) | (sum << 15);
1588 monitor_printf(mon, "%05d\n", sum);
1591 static int mouse_button_state;
1593 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1595 int dx, dy, dz, button;
1596 const char *dx_str = qdict_get_str(qdict, "dx_str");
1597 const char *dy_str = qdict_get_str(qdict, "dy_str");
1598 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1600 dx = strtol(dx_str, NULL, 0);
1601 dy = strtol(dy_str, NULL, 0);
1602 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1603 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1606 dz = strtol(dz_str, NULL, 0);
1608 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1609 qemu_input_queue_btn(NULL, button, true);
1610 qemu_input_event_sync();
1611 qemu_input_queue_btn(NULL, button, false);
1614 qemu_input_event_sync();
1617 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1619 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1620 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1621 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1622 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1624 int button_state = qdict_get_int(qdict, "button_state");
1626 if (mouse_button_state == button_state) {
1629 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1630 qemu_input_event_sync();
1631 mouse_button_state = button_state;
1634 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1636 int size = qdict_get_int(qdict, "size");
1637 int addr = qdict_get_int(qdict, "addr");
1638 int has_index = qdict_haskey(qdict, "index");
1643 int index = qdict_get_int(qdict, "index");
1644 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1652 val = cpu_inb(addr);
1656 val = cpu_inw(addr);
1660 val = cpu_inl(addr);
1664 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1665 suffix, addr, size * 2, val);
1668 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1670 int size = qdict_get_int(qdict, "size");
1671 int addr = qdict_get_int(qdict, "addr");
1672 int val = qdict_get_int(qdict, "val");
1674 addr &= IOPORTS_MASK;
1679 cpu_outb(addr, val);
1682 cpu_outw(addr, val);
1685 cpu_outl(addr, val);
1690 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1692 Error *local_err = NULL;
1693 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1695 qemu_boot_set(bootdevice, &local_err);
1697 error_report_err(local_err);
1699 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1703 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1705 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1707 mtree_info((fprintf_function)monitor_printf, mon, flatview);
1710 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1714 CpuInfoList *cpu_list, *cpu;
1716 cpu_list = qmp_query_cpus(&error_abort);
1717 node_mem = g_new0(uint64_t, nb_numa_nodes);
1718 query_numa_node_mem(node_mem);
1719 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1720 for (i = 0; i < nb_numa_nodes; i++) {
1721 monitor_printf(mon, "node %d cpus:", i);
1722 for (cpu = cpu_list; cpu; cpu = cpu->next) {
1723 if (cpu->value->has_props && cpu->value->props->has_node_id &&
1724 cpu->value->props->node_id == i) {
1725 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
1728 monitor_printf(mon, "\n");
1729 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1732 qapi_free_CpuInfoList(cpu_list);
1736 #ifdef CONFIG_PROFILER
1741 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1743 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1744 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1745 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1746 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1751 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1753 monitor_printf(mon, "Internal profiler not compiled\n");
1757 /* Capture support */
1758 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1760 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1765 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1766 monitor_printf(mon, "[%d]: ", i);
1767 s->ops.info (s->opaque);
1771 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1774 int n = qdict_get_int(qdict, "n");
1777 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1779 s->ops.destroy (s->opaque);
1780 QLIST_REMOVE (s, entries);
1787 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1789 const char *path = qdict_get_str(qdict, "path");
1790 int has_freq = qdict_haskey(qdict, "freq");
1791 int freq = qdict_get_try_int(qdict, "freq", -1);
1792 int has_bits = qdict_haskey(qdict, "bits");
1793 int bits = qdict_get_try_int(qdict, "bits", -1);
1794 int has_channels = qdict_haskey(qdict, "nchannels");
1795 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1798 s = g_malloc0 (sizeof (*s));
1800 freq = has_freq ? freq : 44100;
1801 bits = has_bits ? bits : 16;
1802 nchannels = has_channels ? nchannels : 2;
1804 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1805 monitor_printf(mon, "Failed to add wave capture\n");
1809 QLIST_INSERT_HEAD (&capture_head, s, entries);
1812 static qemu_acl *find_acl(Monitor *mon, const char *name)
1814 qemu_acl *acl = qemu_acl_find(name);
1817 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1822 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1824 const char *aclname = qdict_get_str(qdict, "aclname");
1825 qemu_acl *acl = find_acl(mon, aclname);
1826 qemu_acl_entry *entry;
1830 monitor_printf(mon, "policy: %s\n",
1831 acl->defaultDeny ? "deny" : "allow");
1832 QTAILQ_FOREACH(entry, &acl->entries, next) {
1834 monitor_printf(mon, "%d: %s %s\n", i,
1835 entry->deny ? "deny" : "allow", entry->match);
1840 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1842 const char *aclname = qdict_get_str(qdict, "aclname");
1843 qemu_acl *acl = find_acl(mon, aclname);
1846 qemu_acl_reset(acl);
1847 monitor_printf(mon, "acl: removed all rules\n");
1851 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1853 const char *aclname = qdict_get_str(qdict, "aclname");
1854 const char *policy = qdict_get_str(qdict, "policy");
1855 qemu_acl *acl = find_acl(mon, aclname);
1858 if (strcmp(policy, "allow") == 0) {
1859 acl->defaultDeny = 0;
1860 monitor_printf(mon, "acl: policy set to 'allow'\n");
1861 } else if (strcmp(policy, "deny") == 0) {
1862 acl->defaultDeny = 1;
1863 monitor_printf(mon, "acl: policy set to 'deny'\n");
1865 monitor_printf(mon, "acl: unknown policy '%s', "
1866 "expected 'deny' or 'allow'\n", policy);
1871 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1873 const char *aclname = qdict_get_str(qdict, "aclname");
1874 const char *match = qdict_get_str(qdict, "match");
1875 const char *policy = qdict_get_str(qdict, "policy");
1876 int has_index = qdict_haskey(qdict, "index");
1877 int index = qdict_get_try_int(qdict, "index", -1);
1878 qemu_acl *acl = find_acl(mon, aclname);
1882 if (strcmp(policy, "allow") == 0) {
1884 } else if (strcmp(policy, "deny") == 0) {
1887 monitor_printf(mon, "acl: unknown policy '%s', "
1888 "expected 'deny' or 'allow'\n", policy);
1892 ret = qemu_acl_insert(acl, deny, match, index);
1894 ret = qemu_acl_append(acl, deny, match);
1896 monitor_printf(mon, "acl: unable to add acl entry\n");
1898 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1902 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1904 const char *aclname = qdict_get_str(qdict, "aclname");
1905 const char *match = qdict_get_str(qdict, "match");
1906 qemu_acl *acl = find_acl(mon, aclname);
1910 ret = qemu_acl_remove(acl, match);
1912 monitor_printf(mon, "acl: no matching acl entry\n");
1914 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1918 void qmp_getfd(const char *fdname, Error **errp)
1923 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1925 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1929 if (qemu_isdigit(fdname[0])) {
1931 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1932 "a name not starting with a digit");
1936 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1937 if (strcmp(monfd->name, fdname) != 0) {
1946 monfd = g_malloc0(sizeof(mon_fd_t));
1947 monfd->name = g_strdup(fdname);
1950 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1953 void qmp_closefd(const char *fdname, Error **errp)
1957 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1958 if (strcmp(monfd->name, fdname) != 0) {
1962 QLIST_REMOVE(monfd, next);
1964 g_free(monfd->name);
1969 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1972 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1976 QLIST_FOREACH(monfd, &mon->fds, next) {
1979 if (strcmp(monfd->name, fdname) != 0) {
1985 /* caller takes ownership of fd */
1986 QLIST_REMOVE(monfd, next);
1987 g_free(monfd->name);
1993 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1997 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1999 MonFdsetFd *mon_fdset_fd;
2000 MonFdsetFd *mon_fdset_fd_next;
2002 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2003 if ((mon_fdset_fd->removed ||
2004 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2005 runstate_is_running()) {
2006 close(mon_fdset_fd->fd);
2007 g_free(mon_fdset_fd->opaque);
2008 QLIST_REMOVE(mon_fdset_fd, next);
2009 g_free(mon_fdset_fd);
2013 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2014 QLIST_REMOVE(mon_fdset, next);
2019 static void monitor_fdsets_cleanup(void)
2021 MonFdset *mon_fdset;
2022 MonFdset *mon_fdset_next;
2024 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2025 monitor_fdset_cleanup(mon_fdset);
2029 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2030 const char *opaque, Error **errp)
2033 Monitor *mon = cur_mon;
2036 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2038 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2042 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2043 has_opaque, opaque, errp);
2055 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2057 MonFdset *mon_fdset;
2058 MonFdsetFd *mon_fdset_fd;
2061 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2062 if (mon_fdset->id != fdset_id) {
2065 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2067 if (mon_fdset_fd->fd != fd) {
2070 mon_fdset_fd->removed = true;
2073 mon_fdset_fd->removed = true;
2076 if (has_fd && !mon_fdset_fd) {
2079 monitor_fdset_cleanup(mon_fdset);
2085 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2088 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2090 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2093 FdsetInfoList *qmp_query_fdsets(Error **errp)
2095 MonFdset *mon_fdset;
2096 MonFdsetFd *mon_fdset_fd;
2097 FdsetInfoList *fdset_list = NULL;
2099 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2100 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2101 FdsetFdInfoList *fdsetfd_list = NULL;
2103 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2104 fdset_info->value->fdset_id = mon_fdset->id;
2106 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2107 FdsetFdInfoList *fdsetfd_info;
2109 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2110 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2111 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2112 if (mon_fdset_fd->opaque) {
2113 fdsetfd_info->value->has_opaque = true;
2114 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2116 fdsetfd_info->value->has_opaque = false;
2119 fdsetfd_info->next = fdsetfd_list;
2120 fdsetfd_list = fdsetfd_info;
2123 fdset_info->value->fds = fdsetfd_list;
2125 fdset_info->next = fdset_list;
2126 fdset_list = fdset_info;
2132 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2133 bool has_opaque, const char *opaque,
2136 MonFdset *mon_fdset = NULL;
2137 MonFdsetFd *mon_fdset_fd;
2141 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2142 /* Break if match found or match impossible due to ordering by ID */
2143 if (fdset_id <= mon_fdset->id) {
2144 if (fdset_id < mon_fdset->id) {
2152 if (mon_fdset == NULL) {
2153 int64_t fdset_id_prev = -1;
2154 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2158 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2159 "a non-negative value");
2162 /* Use specified fdset ID */
2163 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2164 mon_fdset_cur = mon_fdset;
2165 if (fdset_id < mon_fdset_cur->id) {
2170 /* Use first available fdset ID */
2171 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2172 mon_fdset_cur = mon_fdset;
2173 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2174 fdset_id_prev = mon_fdset_cur->id;
2181 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2183 mon_fdset->id = fdset_id;
2185 mon_fdset->id = fdset_id_prev + 1;
2188 /* The fdset list is ordered by fdset ID */
2189 if (!mon_fdset_cur) {
2190 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2191 } else if (mon_fdset->id < mon_fdset_cur->id) {
2192 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2194 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2198 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2199 mon_fdset_fd->fd = fd;
2200 mon_fdset_fd->removed = false;
2202 mon_fdset_fd->opaque = g_strdup(opaque);
2204 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2206 fdinfo = g_malloc0(sizeof(*fdinfo));
2207 fdinfo->fdset_id = mon_fdset->id;
2208 fdinfo->fd = mon_fdset_fd->fd;
2213 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2216 MonFdset *mon_fdset;
2217 MonFdsetFd *mon_fdset_fd;
2220 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2221 if (mon_fdset->id != fdset_id) {
2224 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2225 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2226 if (mon_fd_flags == -1) {
2230 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2231 return mon_fdset_fd->fd;
2243 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2245 MonFdset *mon_fdset;
2246 MonFdsetFd *mon_fdset_fd_dup;
2248 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2249 if (mon_fdset->id != fdset_id) {
2252 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2253 if (mon_fdset_fd_dup->fd == dup_fd) {
2257 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2258 mon_fdset_fd_dup->fd = dup_fd;
2259 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2265 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2267 MonFdset *mon_fdset;
2268 MonFdsetFd *mon_fdset_fd_dup;
2270 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2271 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2272 if (mon_fdset_fd_dup->fd == dup_fd) {
2274 QLIST_REMOVE(mon_fdset_fd_dup, next);
2275 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2276 monitor_fdset_cleanup(mon_fdset);
2280 return mon_fdset->id;
2288 int monitor_fdset_dup_fd_find(int dup_fd)
2290 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2293 void monitor_fdset_dup_fd_remove(int dup_fd)
2295 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2298 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2301 Error *local_err = NULL;
2303 if (!qemu_isdigit(fdname[0]) && mon) {
2304 fd = monitor_get_fd(mon, fdname, &local_err);
2306 fd = qemu_parse_fd(fdname);
2308 error_setg(&local_err, "Invalid file descriptor number '%s'",
2313 error_propagate(errp, local_err);
2322 /* Please update hmp-commands.hx when adding or changing commands */
2323 static mon_cmd_t info_cmds[] = {
2324 #include "hmp-commands-info.h"
2328 /* mon_cmds and info_cmds would be sorted at runtime */
2329 static mon_cmd_t mon_cmds[] = {
2330 #include "hmp-commands.h"
2334 /*******************************************************************/
2336 static const char *pch;
2337 static sigjmp_buf expr_env;
2340 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2341 expr_error(Monitor *mon, const char *fmt, ...)
2345 monitor_vprintf(mon, fmt, ap);
2346 monitor_printf(mon, "\n");
2348 siglongjmp(expr_env, 1);
2351 /* return 0 if OK, -1 if not found */
2352 static int get_monitor_def(target_long *pval, const char *name)
2354 const MonitorDef *md = target_monitor_defs();
2355 CPUState *cs = mon_get_cpu();
2360 if (cs == NULL || md == NULL) {
2364 for(; md->name != NULL; md++) {
2365 if (compare_cmd(name, md->name)) {
2366 if (md->get_value) {
2367 *pval = md->get_value(md, md->offset);
2369 CPUArchState *env = mon_get_cpu_env();
2370 ptr = (uint8_t *)env + md->offset;
2373 *pval = *(int32_t *)ptr;
2376 *pval = *(target_long *)ptr;
2387 ret = target_get_monitor_def(cs, name, &tmp);
2389 *pval = (target_long) tmp;
2395 static void next(void)
2399 while (qemu_isspace(*pch))
2404 static int64_t expr_sum(Monitor *mon);
2406 static int64_t expr_unary(Monitor *mon)
2415 n = expr_unary(mon);
2419 n = -expr_unary(mon);
2423 n = ~expr_unary(mon);
2429 expr_error(mon, "')' expected");
2436 expr_error(mon, "character constant expected");
2440 expr_error(mon, "missing terminating \' character");
2450 while ((*pch >= 'a' && *pch <= 'z') ||
2451 (*pch >= 'A' && *pch <= 'Z') ||
2452 (*pch >= '0' && *pch <= '9') ||
2453 *pch == '_' || *pch == '.') {
2454 if ((q - buf) < sizeof(buf) - 1)
2458 while (qemu_isspace(*pch))
2461 ret = get_monitor_def(®, buf);
2463 expr_error(mon, "unknown register");
2468 expr_error(mon, "unexpected end of expression");
2473 n = strtoull(pch, &p, 0);
2474 if (errno == ERANGE) {
2475 expr_error(mon, "number too large");
2478 expr_error(mon, "invalid char '%c' in expression", *p);
2481 while (qemu_isspace(*pch))
2489 static int64_t expr_prod(Monitor *mon)
2494 val = expr_unary(mon);
2497 if (op != '*' && op != '/' && op != '%')
2500 val2 = expr_unary(mon);
2509 expr_error(mon, "division by zero");
2520 static int64_t expr_logic(Monitor *mon)
2525 val = expr_prod(mon);
2528 if (op != '&' && op != '|' && op != '^')
2531 val2 = expr_prod(mon);
2548 static int64_t expr_sum(Monitor *mon)
2553 val = expr_logic(mon);
2556 if (op != '+' && op != '-')
2559 val2 = expr_logic(mon);
2568 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2571 if (sigsetjmp(expr_env, 0)) {
2575 while (qemu_isspace(*pch))
2577 *pval = expr_sum(mon);
2582 static int get_double(Monitor *mon, double *pval, const char **pp)
2584 const char *p = *pp;
2588 d = strtod(p, &tailp);
2590 monitor_printf(mon, "Number expected\n");
2593 if (d != d || d - d != 0) {
2594 /* NaN or infinity */
2595 monitor_printf(mon, "Bad number\n");
2604 * Store the command-name in cmdname, and return a pointer to
2605 * the remaining of the command string.
2607 static const char *get_command_name(const char *cmdline,
2608 char *cmdname, size_t nlen)
2611 const char *p, *pstart;
2614 while (qemu_isspace(*p))
2619 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2624 memcpy(cmdname, pstart, len);
2625 cmdname[len] = '\0';
2630 * Read key of 'type' into 'key' and return the current
2633 static char *key_get_info(const char *type, char **key)
2641 p = strchr(type, ':');
2648 str = g_malloc(len + 1);
2649 memcpy(str, type, len);
2656 static int default_fmt_format = 'x';
2657 static int default_fmt_size = 4;
2659 static int is_valid_option(const char *c, const char *typestr)
2667 typestr = strstr(typestr, option);
2668 return (typestr != NULL);
2671 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2672 const char *cmdname)
2674 const mon_cmd_t *cmd;
2676 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2677 if (compare_cmd(cmdname, cmd->name)) {
2686 * Parse command name from @cmdp according to command table @table.
2687 * If blank, return NULL.
2688 * Else, if no valid command can be found, report to @mon, and return
2690 * Else, change @cmdp to point right behind the name, and return its
2691 * command table entry.
2692 * Do not assume the return value points into @table! It doesn't when
2693 * the command is found in a sub-command table.
2695 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2700 const mon_cmd_t *cmd;
2703 /* extract the command name */
2704 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2708 cmd = search_dispatch_table(table, cmdname);
2710 monitor_printf(mon, "unknown command: '%.*s'\n",
2711 (int)(p - *cmdp), *cmdp);
2715 /* filter out following useless space */
2716 while (qemu_isspace(*p)) {
2721 /* search sub command */
2722 if (cmd->sub_table != NULL && *p != '\0') {
2723 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2730 * Parse arguments for @cmd.
2731 * If it can't be parsed, report to @mon, and return NULL.
2732 * Else, insert command arguments into a QDict, and return it.
2733 * Note: On success, caller has to free the QDict structure.
2736 static QDict *monitor_parse_arguments(Monitor *mon,
2738 const mon_cmd_t *cmd)
2740 const char *typestr;
2743 const char *p = *endp;
2745 QDict *qdict = qdict_new();
2747 /* parse the parameters */
2748 typestr = cmd->args_type;
2750 typestr = key_get_info(typestr, &key);
2762 while (qemu_isspace(*p))
2764 if (*typestr == '?') {
2767 /* no optional string: NULL argument */
2771 ret = get_str(buf, sizeof(buf), &p);
2775 monitor_printf(mon, "%s: filename expected\n",
2779 monitor_printf(mon, "%s: block device name expected\n",
2783 monitor_printf(mon, "%s: string expected\n", cmd->name);
2788 qdict_put_str(qdict, key, buf);
2793 QemuOptsList *opts_list;
2796 opts_list = qemu_find_opts(key);
2797 if (!opts_list || opts_list->desc->name) {
2800 while (qemu_isspace(*p)) {
2805 if (get_str(buf, sizeof(buf), &p) < 0) {
2808 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2812 qemu_opts_to_qdict(opts, qdict);
2813 qemu_opts_del(opts);
2818 int count, format, size;
2820 while (qemu_isspace(*p))
2826 if (qemu_isdigit(*p)) {
2828 while (qemu_isdigit(*p)) {
2829 count = count * 10 + (*p - '0');
2867 if (*p != '\0' && !qemu_isspace(*p)) {
2868 monitor_printf(mon, "invalid char in format: '%c'\n",
2873 format = default_fmt_format;
2874 if (format != 'i') {
2875 /* for 'i', not specifying a size gives -1 as size */
2877 size = default_fmt_size;
2878 default_fmt_size = size;
2880 default_fmt_format = format;
2883 format = default_fmt_format;
2884 if (format != 'i') {
2885 size = default_fmt_size;
2890 qdict_put_int(qdict, "count", count);
2891 qdict_put_int(qdict, "format", format);
2892 qdict_put_int(qdict, "size", size);
2901 while (qemu_isspace(*p))
2903 if (*typestr == '?' || *typestr == '.') {
2904 if (*typestr == '?') {
2912 while (qemu_isspace(*p))
2921 if (get_expr(mon, &val, &p))
2923 /* Check if 'i' is greater than 32-bit */
2924 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2925 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2926 monitor_printf(mon, "integer is for 32-bit values\n");
2928 } else if (c == 'M') {
2930 monitor_printf(mon, "enter a positive value\n");
2935 qdict_put_int(qdict, key, val);
2944 while (qemu_isspace(*p)) {
2947 if (*typestr == '?') {
2953 ret = qemu_strtosz_MiB(p, &end, &val);
2954 if (ret < 0 || val > INT64_MAX) {
2955 monitor_printf(mon, "invalid size\n");
2958 qdict_put_int(qdict, key, val);
2966 while (qemu_isspace(*p))
2968 if (*typestr == '?') {
2974 if (get_double(mon, &val, &p) < 0) {
2977 if (p[0] && p[1] == 's') {
2980 val /= 1e3; p += 2; break;
2982 val /= 1e6; p += 2; break;
2984 val /= 1e9; p += 2; break;
2987 if (*p && !qemu_isspace(*p)) {
2988 monitor_printf(mon, "Unknown unit suffix\n");
2991 qdict_put(qdict, key, qnum_from_double(val));
2999 while (qemu_isspace(*p)) {
3003 while (qemu_isgraph(*p)) {
3006 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3008 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3011 monitor_printf(mon, "Expected 'on' or 'off'\n");
3014 qdict_put_bool(qdict, key, val);
3019 const char *tmp = p;
3026 while (qemu_isspace(*p))
3031 if(!is_valid_option(p, typestr)) {
3033 monitor_printf(mon, "%s: unsupported option -%c\n",
3045 qdict_put_bool(qdict, key, true);
3052 /* package all remaining string */
3055 while (qemu_isspace(*p)) {
3058 if (*typestr == '?') {
3061 /* no remaining string: NULL argument */
3067 monitor_printf(mon, "%s: string expected\n",
3071 qdict_put_str(qdict, key, p);
3077 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3083 /* check that all arguments were parsed */
3084 while (qemu_isspace(*p))
3087 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3100 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3103 const mon_cmd_t *cmd;
3105 trace_handle_hmp_command(mon, cmdline);
3107 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
3112 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3114 monitor_printf(mon, "Try \"help %s\" for more information\n",
3119 cmd->cmd(mon, qdict);
3123 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3125 const char *p, *pstart;
3134 p = pstart + strlen(pstart);
3136 if (len > sizeof(cmd) - 2)
3137 len = sizeof(cmd) - 2;
3138 memcpy(cmd, pstart, len);
3140 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3141 readline_add_completion(mon->rs, cmd);
3149 static void file_completion(Monitor *mon, const char *input)
3154 char file[1024], file_prefix[1024];
3158 p = strrchr(input, '/');
3161 pstrcpy(file_prefix, sizeof(file_prefix), input);
3162 pstrcpy(path, sizeof(path), ".");
3164 input_path_len = p - input + 1;
3165 memcpy(path, input, input_path_len);
3166 if (input_path_len > sizeof(path) - 1)
3167 input_path_len = sizeof(path) - 1;
3168 path[input_path_len] = '\0';
3169 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3172 ffs = opendir(path);
3181 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3185 if (strstart(d->d_name, file_prefix, NULL)) {
3186 memcpy(file, input, input_path_len);
3187 if (input_path_len < sizeof(file))
3188 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3190 /* stat the file to find out if it's a directory.
3191 * In that case add a slash to speed up typing long paths
3193 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3194 pstrcat(file, sizeof(file), "/");
3196 readline_add_completion(mon->rs, file);
3202 static const char *next_arg_type(const char *typestr)
3204 const char *p = strchr(typestr, ':');
3205 return (p != NULL ? ++p : typestr);
3208 static void add_completion_option(ReadLineState *rs, const char *str,
3211 if (!str || !option) {
3214 if (!strncmp(option, str, strlen(str))) {
3215 readline_add_completion(rs, option);
3219 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3222 ChardevBackendInfoList *list, *start;
3228 readline_set_completion_index(rs, len);
3230 start = list = qmp_query_chardev_backends(NULL);
3232 const char *chr_name = list->value->name;
3234 if (!strncmp(chr_name, str, len)) {
3235 readline_add_completion(rs, chr_name);
3239 qapi_free_ChardevBackendInfoList(start);
3242 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3251 readline_set_completion_index(rs, len);
3252 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3253 add_completion_option(rs, str, NetClientDriver_str(i));
3257 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3267 readline_set_completion_index(rs, len);
3268 list = elt = object_class_get_list(TYPE_DEVICE, false);
3271 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3273 name = object_class_get_name(OBJECT_CLASS(dc));
3275 if (dc->user_creatable
3276 && !strncmp(name, str, len)) {
3277 readline_add_completion(rs, name);
3284 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3294 readline_set_completion_index(rs, len);
3295 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3299 name = object_class_get_name(OBJECT_CLASS(elt->data));
3300 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3301 readline_add_completion(rs, name);
3308 static void peripheral_device_del_completion(ReadLineState *rs,
3309 const char *str, size_t len)
3311 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3312 GSList *list, *item;
3314 list = qdev_build_hotpluggable_device_list(peripheral);
3319 for (item = list; item; item = g_slist_next(item)) {
3320 DeviceState *dev = item->data;
3322 if (dev->id && !strncmp(str, dev->id, len)) {
3323 readline_add_completion(rs, dev->id);
3330 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3333 ChardevInfoList *list, *start;
3339 readline_set_completion_index(rs, len);
3341 start = list = qmp_query_chardev(NULL);
3343 ChardevInfo *chr = list->value;
3345 if (!strncmp(chr->label, str, len)) {
3346 readline_add_completion(rs, chr->label);
3350 qapi_free_ChardevInfoList(start);
3353 static void ringbuf_completion(ReadLineState *rs, const char *str)
3356 ChardevInfoList *list, *start;
3359 readline_set_completion_index(rs, len);
3361 start = list = qmp_query_chardev(NULL);
3363 ChardevInfo *chr_info = list->value;
3365 if (!strncmp(chr_info->label, str, len)) {
3366 Chardev *chr = qemu_chr_find(chr_info->label);
3367 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3368 readline_add_completion(rs, chr_info->label);
3373 qapi_free_ChardevInfoList(start);
3376 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3381 ringbuf_completion(rs, str);
3384 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3393 readline_set_completion_index(rs, len);
3394 peripheral_device_del_completion(rs, str, len);
3397 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3399 ObjectPropertyInfoList *list, *start;
3406 readline_set_completion_index(rs, len);
3408 start = list = qmp_qom_list("/objects", NULL);
3410 ObjectPropertyInfo *info = list->value;
3412 if (!strncmp(info->type, "child<", 5)
3413 && !strncmp(info->name, str, len)) {
3414 readline_add_completion(rs, info->name);
3418 qapi_free_ObjectPropertyInfoList(start);
3421 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3430 sep = strrchr(str, '-');
3435 readline_set_completion_index(rs, len);
3436 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3437 if (!strncmp(str, QKeyCode_str(i), len)) {
3438 readline_add_completion(rs, QKeyCode_str(i));
3443 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3448 readline_set_completion_index(rs, len);
3450 NetClientState *ncs[MAX_QUEUE_NUM];
3452 count = qemu_find_net_clients_except(NULL, ncs,
3453 NET_CLIENT_DRIVER_NONE,
3455 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3456 const char *name = ncs[i]->name;
3457 if (!strncmp(str, name, len)) {
3458 readline_add_completion(rs, name);
3461 } else if (nb_args == 3) {
3462 add_completion_option(rs, str, "on");
3463 add_completion_option(rs, str, "off");
3467 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3470 NetClientState *ncs[MAX_QUEUE_NUM];
3477 readline_set_completion_index(rs, len);
3478 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3480 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3482 const char *name = ncs[i]->name;
3483 if (strncmp(str, name, len)) {
3486 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3488 readline_add_completion(rs, name);
3493 void info_trace_events_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));
3511 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3516 readline_set_completion_index(rs, len);
3518 TraceEventIter iter;
3520 char *pattern = g_strdup_printf("%s*", str);
3521 trace_event_iter_init(&iter, pattern);
3522 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3523 readline_add_completion(rs, trace_event_get_name(ev));
3526 } else if (nb_args == 3) {
3527 add_completion_option(rs, str, "on");
3528 add_completion_option(rs, str, "off");
3532 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3539 readline_set_completion_index(rs, strlen(str));
3540 for (i = 0; i < WATCHDOG_EXPIRATION_ACTION__MAX; i++) {
3541 add_completion_option(rs, str, WatchdogExpirationAction_str(i));
3545 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3551 readline_set_completion_index(rs, len);
3554 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3555 const char *name = MigrationCapability_str(i);
3556 if (!strncmp(str, name, len)) {
3557 readline_add_completion(rs, name);
3560 } else if (nb_args == 3) {
3561 add_completion_option(rs, str, "on");
3562 add_completion_option(rs, str, "off");
3566 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3572 readline_set_completion_index(rs, len);
3575 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3576 const char *name = MigrationParameter_str(i);
3577 if (!strncmp(str, name, len)) {
3578 readline_add_completion(rs, name);
3584 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3592 readline_set_completion_index(rs, len);
3593 for (i = 0; host_net_devices[i]; i++) {
3594 if (!strncmp(host_net_devices[i], str, len)) {
3595 readline_add_completion(rs, host_net_devices[i]);
3600 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3602 NetClientState *ncs[MAX_QUEUE_NUM];
3606 readline_set_completion_index(rs, len);
3608 count = qemu_find_net_clients_except(NULL, ncs,
3609 NET_CLIENT_DRIVER_NONE,
3611 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3615 if (net_hub_id_for_client(ncs[i], &id)) {
3618 snprintf(name, sizeof(name), "%d", id);
3619 if (!strncmp(str, name, len)) {
3620 readline_add_completion(rs, name);
3624 } else if (nb_args == 3) {
3625 count = qemu_find_net_clients_except(NULL, ncs,
3626 NET_CLIENT_DRIVER_NIC,
3628 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3632 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3633 net_hub_id_for_client(ncs[i], &id)) {
3636 name = ncs[i]->name;
3637 if (!strncmp(str, name, len)) {
3638 readline_add_completion(rs, name);
3645 static void vm_completion(ReadLineState *rs, const char *str)
3648 BlockDriverState *bs;
3649 BdrvNextIterator it;
3652 readline_set_completion_index(rs, len);
3654 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3655 SnapshotInfoList *snapshots, *snapshot;
3656 AioContext *ctx = bdrv_get_aio_context(bs);
3659 aio_context_acquire(ctx);
3660 if (bdrv_can_snapshot(bs)) {
3661 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3663 aio_context_release(ctx);
3668 snapshot = snapshots;
3670 char *completion = snapshot->value->name;
3671 if (!strncmp(str, completion, len)) {
3672 readline_add_completion(rs, completion);
3674 completion = snapshot->value->id;
3675 if (!strncmp(str, completion, len)) {
3676 readline_add_completion(rs, completion);
3678 snapshot = snapshot->next;
3680 qapi_free_SnapshotInfoList(snapshots);
3685 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3688 vm_completion(rs, str);
3692 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3695 vm_completion(rs, str);
3699 static void monitor_find_completion_by_table(Monitor *mon,
3700 const mon_cmd_t *cmd_table,
3704 const char *cmdname;
3706 const char *ptype, *str, *name;
3707 const mon_cmd_t *cmd;
3708 BlockBackend *blk = NULL;
3711 /* command completion */
3716 readline_set_completion_index(mon->rs, strlen(cmdname));
3717 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3718 cmd_completion(mon, cmdname, cmd->name);
3721 /* find the command */
3722 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3723 if (compare_cmd(args[0], cmd->name)) {
3731 if (cmd->sub_table) {
3732 /* do the job again */
3733 monitor_find_completion_by_table(mon, cmd->sub_table,
3734 &args[1], nb_args - 1);
3737 if (cmd->command_completion) {
3738 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3742 ptype = next_arg_type(cmd->args_type);
3743 for(i = 0; i < nb_args - 2; i++) {
3744 if (*ptype != '\0') {
3745 ptype = next_arg_type(ptype);
3746 while (*ptype == '?')
3747 ptype = next_arg_type(ptype);
3750 str = args[nb_args - 1];
3751 while (*ptype == '-' && ptype[1] != '\0') {
3752 ptype = next_arg_type(ptype);
3756 /* file completion */
3757 readline_set_completion_index(mon->rs, strlen(str));
3758 file_completion(mon, str);
3761 /* block device name completion */
3762 readline_set_completion_index(mon->rs, strlen(str));
3763 while ((blk = blk_next(blk)) != NULL) {
3764 name = blk_name(blk);
3765 if (str[0] == '\0' ||
3766 !strncmp(name, str, strlen(str))) {
3767 readline_add_completion(mon->rs, name);
3773 if (!strcmp(cmd->name, "help|?")) {
3774 monitor_find_completion_by_table(mon, cmd_table,
3775 &args[1], nb_args - 1);
3784 static void monitor_find_completion(void *opaque,
3785 const char *cmdline)
3787 Monitor *mon = opaque;
3788 char *args[MAX_ARGS];
3791 /* 1. parse the cmdline */
3792 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3796 /* if the line ends with a space, it means we want to complete the
3798 len = strlen(cmdline);
3799 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3800 if (nb_args >= MAX_ARGS) {
3803 args[nb_args++] = g_strdup("");
3806 /* 2. auto complete according to args */
3807 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3810 free_cmdline_args(args, nb_args);
3813 static int monitor_can_read(void *opaque)
3815 Monitor *mon = opaque;
3817 return (mon->suspend_cnt == 0) ? 1 : 0;
3820 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3822 QObject *req, *rsp = NULL, *id = NULL;
3823 QDict *qdict = NULL;
3824 Monitor *mon = cur_mon;
3827 req = json_parser_parse_err(tokens, NULL, &err);
3829 /* json_parser_parse_err() sucks: can fail without setting @err */
3830 error_setg(&err, QERR_JSON_PARSING);
3836 qdict = qobject_to_qdict(req);
3838 id = qdict_get(qdict, "id");
3840 qdict_del(qdict, "id");
3841 } /* else will fail qmp_dispatch() */
3843 if (trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
3844 QString *req_json = qobject_to_json(req);
3845 trace_handle_qmp_command(mon, qstring_get_str(req_json));
3849 rsp = qmp_dispatch(cur_mon->qmp.commands, req);
3851 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
3852 qdict = qdict_get_qdict(qobject_to_qdict(rsp), "error");
3854 && !g_strcmp0(qdict_get_try_str(qdict, "class"),
3855 QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
3856 /* Provide a more useful error message */
3857 qdict_del(qdict, "desc");
3858 qdict_put_str(qdict, "desc", "Expecting capabilities negotiation"
3859 " with 'qmp_capabilities'");
3865 qdict = qdict_new();
3866 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3868 rsp = QOBJECT(qdict);
3873 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3877 monitor_json_emitter(mon, rsp);
3881 qobject_decref(rsp);
3882 qobject_decref(req);
3885 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3887 Monitor *old_mon = cur_mon;
3891 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3896 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3898 Monitor *old_mon = cur_mon;
3904 for (i = 0; i < size; i++)
3905 readline_handle_byte(cur_mon->rs, buf[i]);
3907 if (size == 0 || buf[size - 1] != 0)
3908 monitor_printf(cur_mon, "corrupted command\n");
3910 handle_hmp_command(cur_mon, (char *)buf);
3916 static void monitor_command_cb(void *opaque, const char *cmdline,
3917 void *readline_opaque)
3919 Monitor *mon = opaque;
3921 monitor_suspend(mon);
3922 handle_hmp_command(mon, cmdline);
3923 monitor_resume(mon);
3926 int monitor_suspend(Monitor *mon)
3934 void monitor_resume(Monitor *mon)
3938 if (--mon->suspend_cnt == 0)
3939 readline_show_prompt(mon->rs);
3942 static QObject *get_qmp_greeting(void)
3944 QObject *ver = NULL;
3946 qmp_marshal_query_version(NULL, &ver, NULL);
3948 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3952 static void monitor_qmp_event(void *opaque, int event)
3955 Monitor *mon = opaque;
3958 case CHR_EVENT_OPENED:
3959 mon->qmp.commands = &qmp_cap_negotiation_commands;
3960 data = get_qmp_greeting();
3961 monitor_json_emitter(mon, data);
3962 qobject_decref(data);
3965 case CHR_EVENT_CLOSED:
3966 json_message_parser_destroy(&mon->qmp.parser);
3967 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3969 monitor_fdsets_cleanup();
3974 static void monitor_event(void *opaque, int event)
3976 Monitor *mon = opaque;
3979 case CHR_EVENT_MUX_IN:
3980 qemu_mutex_lock(&mon->out_lock);
3982 qemu_mutex_unlock(&mon->out_lock);
3983 if (mon->reset_seen) {
3984 readline_restart(mon->rs);
3985 monitor_resume(mon);
3988 mon->suspend_cnt = 0;
3992 case CHR_EVENT_MUX_OUT:
3993 if (mon->reset_seen) {
3994 if (mon->suspend_cnt == 0) {
3995 monitor_printf(mon, "\n");
3998 monitor_suspend(mon);
4002 qemu_mutex_lock(&mon->out_lock);
4004 qemu_mutex_unlock(&mon->out_lock);
4007 case CHR_EVENT_OPENED:
4008 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4009 "information\n", QEMU_VERSION);
4010 if (!mon->mux_out) {
4011 readline_restart(mon->rs);
4012 readline_show_prompt(mon->rs);
4014 mon->reset_seen = 1;
4018 case CHR_EVENT_CLOSED:
4020 monitor_fdsets_cleanup();
4026 compare_mon_cmd(const void *a, const void *b)
4028 return strcmp(((const mon_cmd_t *)a)->name,
4029 ((const mon_cmd_t *)b)->name);
4032 static void sortcmdlist(void)
4035 int elem_size = sizeof(mon_cmd_t);
4037 array_num = sizeof(mon_cmds)/elem_size-1;
4038 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4040 array_num = sizeof(info_cmds)/elem_size-1;
4041 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4044 /* These functions just adapt the readline interface in a typesafe way. We
4045 * could cast function pointers but that discards compiler checks.
4047 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4048 const char *fmt, ...)
4052 monitor_vprintf(opaque, fmt, ap);
4056 static void monitor_readline_flush(void *opaque)
4058 monitor_flush(opaque);
4062 * Print to current monitor if we have one, else to stderr.
4063 * TODO should return int, so callers can calculate width, but that
4064 * requires surgery to monitor_vprintf(). Left for another day.
4066 void error_vprintf(const char *fmt, va_list ap)
4068 if (cur_mon && !monitor_cur_is_qmp()) {
4069 monitor_vprintf(cur_mon, fmt, ap);
4071 vfprintf(stderr, fmt, ap);
4075 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4077 if (cur_mon && !monitor_cur_is_qmp()) {
4078 monitor_vprintf(cur_mon, fmt, ap);
4079 } else if (!cur_mon) {
4080 vfprintf(stderr, fmt, ap);
4084 static void __attribute__((constructor)) monitor_lock_init(void)
4086 qemu_mutex_init(&monitor_lock);
4089 void monitor_init(Chardev *chr, int flags)
4091 static int is_first_init = 1;
4094 if (is_first_init) {
4095 monitor_qapi_event_init();
4100 mon = g_malloc(sizeof(*mon));
4101 monitor_data_init(mon);
4103 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4105 if (flags & MONITOR_USE_READLINE) {
4106 mon->rs = readline_init(monitor_readline_printf,
4107 monitor_readline_flush,
4109 monitor_find_completion);
4110 monitor_read_command(mon, 0);
4113 if (monitor_is_qmp(mon)) {
4114 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4115 monitor_qmp_event, NULL, mon, NULL, true);
4116 qemu_chr_fe_set_echo(&mon->chr, true);
4117 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4119 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4120 monitor_event, NULL, mon, NULL, true);
4123 qemu_mutex_lock(&monitor_lock);
4124 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4125 qemu_mutex_unlock(&monitor_lock);
4128 void monitor_cleanup(void)
4130 Monitor *mon, *next;
4132 qemu_mutex_lock(&monitor_lock);
4133 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4134 QLIST_REMOVE(mon, entry);
4135 monitor_data_destroy(mon);
4138 qemu_mutex_unlock(&monitor_lock);
4141 QemuOptsList qemu_mon_opts = {
4143 .implied_opt_name = "chardev",
4144 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4148 .type = QEMU_OPT_STRING,
4151 .type = QEMU_OPT_STRING,
4153 .name = "default", /* deprecated */
4154 .type = QEMU_OPT_BOOL,
4157 .type = QEMU_OPT_BOOL,
4159 { /* end of list */ }
4164 void qmp_rtc_reset_reinjection(Error **errp)
4166 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4170 #ifndef TARGET_S390X
4171 void qmp_dump_skeys(const char *filename, Error **errp)
4173 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4178 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4180 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4185 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4187 MachineState *ms = MACHINE(qdev_get_machine());
4188 MachineClass *mc = MACHINE_GET_CLASS(ms);
4190 if (!mc->has_hotpluggable_cpus) {
4191 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4195 return machine_query_hotpluggable_cpus(ms);