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
25 #include "qemu/osdep.h"
29 #include "monitor/qdev.h"
31 #include "hw/pci/pci.h"
32 #include "sysemu/watchdog.h"
33 #include "hw/loader.h"
34 #include "exec/gdbstub.h"
36 #include "net/slirp.h"
37 #include "chardev/char-fe.h"
38 #include "ui/qemu-spice.h"
39 #include "sysemu/numa.h"
40 #include "monitor/monitor.h"
41 #include "qemu/config-file.h"
42 #include "qemu/readline.h"
43 #include "ui/console.h"
45 #include "sysemu/blockdev.h"
46 #include "sysemu/block-backend.h"
47 #include "audio/audio.h"
48 #include "disas/disas.h"
49 #include "sysemu/balloon.h"
50 #include "qemu/timer.h"
51 #include "sysemu/hw_accel.h"
53 #include "sysemu/tpm.h"
54 #include "qapi/qmp/qdict.h"
55 #include "qapi/qmp/qerror.h"
56 #include "qapi/qmp/qnum.h"
57 #include "qapi/qmp/qstring.h"
58 #include "qapi/qmp/qjson.h"
59 #include "qapi/qmp/json-streamer.h"
60 #include "qapi/qmp/json-parser.h"
61 #include "qom/object_interfaces.h"
62 #include "trace-root.h"
63 #include "trace/control.h"
64 #include "monitor/hmp-target.h"
65 #ifdef CONFIG_TRACE_SIMPLE
66 #include "trace/simple.h"
68 #include "exec/memory.h"
69 #include "exec/exec-all.h"
71 #include "qemu/option.h"
73 #include "qemu/thread.h"
74 #include "block/qapi.h"
75 #include "qapi/qapi-commands.h"
76 #include "qapi/qapi-events.h"
77 #include "qapi/error.h"
78 #include "qapi/qmp-event.h"
79 #include "qapi/qapi-introspect.h"
80 #include "sysemu/qtest.h"
81 #include "sysemu/cpus.h"
82 #include "qemu/cutils.h"
84 #if defined(TARGET_S390X)
85 #include "hw/s390x/storage-keys.h"
86 #include "hw/s390x/storage-attributes.h"
93 * 'B' block device name
94 * 's' string (accept optional quote)
95 * 'S' it just appends the rest of the string (accept optional quote)
96 * 'O' option string of the form NAME=VALUE,...
97 * parsed according to QemuOptsList given by its name
98 * Example: 'device:O' uses qemu_device_opts.
99 * Restriction: only lists with empty desc are supported
100 * TODO lift the restriction
102 * 'l' target long (32 or 64 bit)
103 * 'M' Non-negative target long (32 or 64 bit), in user mode the
104 * value is multiplied by 2^20 (think Mebibyte)
105 * 'o' octets (aka bytes)
106 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
107 * K, k suffix, which multiplies the value by 2^60 for suffixes E
108 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
109 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
111 * user mode accepts an optional ms, us, ns suffix,
112 * which divides the value by 1e3, 1e6, 1e9, respectively
113 * '/' optional gdb-like print format (like "/10x")
115 * '?' optional type (for all types, except '/')
116 * '.' other form of optional type (for 'i' and 'l')
118 * user mode accepts "on" or "off"
119 * '-' optional parameter (eg. '-f')
123 typedef struct mon_cmd_t {
125 const char *args_type;
128 void (*cmd)(Monitor *mon, const QDict *qdict);
129 /* @sub_table is a list of 2nd level of commands. If it does not exist,
130 * cmd should be used. If it exists, sub_table[?].cmd should be
131 * used, and cmd of 1st level plays the role of help function.
133 struct mon_cmd_t *sub_table;
134 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
137 /* file descriptors passed via SCM_RIGHTS */
138 typedef struct mon_fd_t mon_fd_t;
142 QLIST_ENTRY(mon_fd_t) next;
145 /* file descriptor associated with a file descriptor set */
146 typedef struct MonFdsetFd MonFdsetFd;
151 QLIST_ENTRY(MonFdsetFd) next;
154 /* file descriptor set containing fds passed via SCM_RIGHTS */
155 typedef struct MonFdset MonFdset;
158 QLIST_HEAD(, MonFdsetFd) fds;
159 QLIST_HEAD(, MonFdsetFd) dup_fds;
160 QLIST_ENTRY(MonFdset) next;
164 JSONMessageParser parser;
166 * When a client connects, we're in capabilities negotiation mode.
167 * When command qmp_capabilities succeeds, we go into command
170 QmpCommandList *commands;
174 * To prevent flooding clients, events can be throttled. The
175 * throttling is calculated globally, rather than per-Monitor
178 typedef struct MonitorQAPIEventState {
179 QAPIEvent event; /* Throttling state for this event type and... */
180 QDict *data; /* ... data, see qapi_event_throttle_equal() */
181 QEMUTimer *timer; /* Timer for handling delayed events */
182 QDict *qdict; /* Delayed event (if any) */
183 } MonitorQAPIEventState;
186 int64_t rate; /* Minimum time (in ns) between two events */
187 } MonitorQAPIEventConf;
200 /* Read under either BQL or out_lock, written with BQL+out_lock. */
206 BlockCompletionFunc *password_completion_cb;
207 void *password_opaque;
208 mon_cmd_t *cmd_table;
209 QLIST_HEAD(,mon_fd_t) fds;
210 QLIST_ENTRY(Monitor) entry;
213 /* QMP checker flags */
214 #define QMP_ACCEPT_UNKNOWNS 1
216 /* Protects mon_list, monitor_event_state. */
217 static QemuMutex monitor_lock;
219 static QLIST_HEAD(mon_list, Monitor) mon_list;
220 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
221 static int mon_refcount;
223 static mon_cmd_t mon_cmds[];
224 static mon_cmd_t info_cmds[];
226 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
230 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
232 static void monitor_command_cb(void *opaque, const char *cmdline,
233 void *readline_opaque);
236 * Is @mon a QMP monitor?
238 static inline bool monitor_is_qmp(const Monitor *mon)
240 return (mon->flags & MONITOR_USE_CONTROL);
244 * Is the current monitor, if any, a QMP monitor?
246 bool monitor_cur_is_qmp(void)
248 return cur_mon && monitor_is_qmp(cur_mon);
251 void monitor_read_command(Monitor *mon, int show_prompt)
256 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
258 readline_show_prompt(mon->rs);
261 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
265 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
266 /* prompt is printed on return from the command handler */
269 monitor_printf(mon, "terminal does not support password prompting\n");
274 static void monitor_flush_locked(Monitor *mon);
276 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
279 Monitor *mon = opaque;
281 qemu_mutex_lock(&mon->out_lock);
283 monitor_flush_locked(mon);
284 qemu_mutex_unlock(&mon->out_lock);
288 /* Called with mon->out_lock held. */
289 static void monitor_flush_locked(Monitor *mon)
295 if (mon->skip_flush) {
299 buf = qstring_get_str(mon->outbuf);
300 len = qstring_get_length(mon->outbuf);
302 if (len && !mon->mux_out) {
303 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
304 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
305 /* all flushed or error */
306 QDECREF(mon->outbuf);
307 mon->outbuf = qstring_new();
312 QString *tmp = qstring_from_str(buf + rc);
313 QDECREF(mon->outbuf);
316 if (mon->out_watch == 0) {
318 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
319 monitor_unblocked, mon);
324 void monitor_flush(Monitor *mon)
326 qemu_mutex_lock(&mon->out_lock);
327 monitor_flush_locked(mon);
328 qemu_mutex_unlock(&mon->out_lock);
331 /* flush at every end of line */
332 static void monitor_puts(Monitor *mon, const char *str)
336 qemu_mutex_lock(&mon->out_lock);
342 qstring_append_chr(mon->outbuf, '\r');
344 qstring_append_chr(mon->outbuf, c);
346 monitor_flush_locked(mon);
349 qemu_mutex_unlock(&mon->out_lock);
352 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
359 if (monitor_is_qmp(mon)) {
363 buf = g_strdup_vprintf(fmt, ap);
364 monitor_puts(mon, buf);
368 void monitor_printf(Monitor *mon, const char *fmt, ...)
372 monitor_vprintf(mon, fmt, ap);
376 int monitor_fprintf(FILE *stream, const char *fmt, ...)
380 monitor_vprintf((Monitor *)stream, fmt, ap);
385 static void monitor_json_emitter(Monitor *mon, const QObject *data)
389 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
390 qobject_to_json(data);
391 assert(json != NULL);
393 qstring_append_chr(json, '\n');
394 monitor_puts(mon, qstring_get_str(json));
399 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
400 /* Limit guest-triggerable events to 1 per second */
401 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
402 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
403 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
404 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
405 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
406 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
409 GHashTable *monitor_qapi_event_state;
412 * Emits the event to every monitor instance, @event is only used for trace
413 * Called with monitor_lock held.
415 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
419 trace_monitor_protocol_event_emit(event, qdict);
420 QLIST_FOREACH(mon, &mon_list, entry) {
421 if (monitor_is_qmp(mon)
422 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
423 monitor_json_emitter(mon, QOBJECT(qdict));
428 static void monitor_qapi_event_handler(void *opaque);
431 * Queue a new event for emission to Monitor instances,
432 * applying any rate limiting if required.
435 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
437 MonitorQAPIEventConf *evconf;
438 MonitorQAPIEventState *evstate;
440 assert(event < QAPI_EVENT__MAX);
441 evconf = &monitor_qapi_event_conf[event];
442 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
444 qemu_mutex_lock(&monitor_lock);
447 /* Unthrottled event */
448 monitor_qapi_event_emit(event, qdict);
450 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
451 MonitorQAPIEventState key = { .event = event, .data = data };
453 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
454 assert(!evstate || timer_pending(evstate->timer));
458 * Timer is pending for (at least) evconf->rate ns after
459 * last send. Store event for sending when timer fires,
460 * replacing a prior stored event if any.
462 QDECREF(evstate->qdict);
463 evstate->qdict = qdict;
464 QINCREF(evstate->qdict);
467 * Last send was (at least) evconf->rate ns ago.
468 * Send immediately, and arm the timer to call
469 * monitor_qapi_event_handler() in evconf->rate ns. Any
470 * events arriving before then will be delayed until then.
472 int64_t now = qemu_clock_get_ns(event_clock_type);
474 monitor_qapi_event_emit(event, qdict);
476 evstate = g_new(MonitorQAPIEventState, 1);
477 evstate->event = event;
478 evstate->data = data;
479 QINCREF(evstate->data);
480 evstate->qdict = NULL;
481 evstate->timer = timer_new_ns(event_clock_type,
482 monitor_qapi_event_handler,
484 g_hash_table_add(monitor_qapi_event_state, evstate);
485 timer_mod_ns(evstate->timer, now + evconf->rate);
489 qemu_mutex_unlock(&monitor_lock);
493 * This function runs evconf->rate ns after sending a throttled
495 * If another event has since been stored, send it.
497 static void monitor_qapi_event_handler(void *opaque)
499 MonitorQAPIEventState *evstate = opaque;
500 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
502 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
503 qemu_mutex_lock(&monitor_lock);
505 if (evstate->qdict) {
506 int64_t now = qemu_clock_get_ns(event_clock_type);
508 monitor_qapi_event_emit(evstate->event, evstate->qdict);
509 QDECREF(evstate->qdict);
510 evstate->qdict = NULL;
511 timer_mod_ns(evstate->timer, now + evconf->rate);
513 g_hash_table_remove(monitor_qapi_event_state, evstate);
514 QDECREF(evstate->data);
515 timer_free(evstate->timer);
519 qemu_mutex_unlock(&monitor_lock);
522 static unsigned int qapi_event_throttle_hash(const void *key)
524 const MonitorQAPIEventState *evstate = key;
525 unsigned int hash = evstate->event * 255;
527 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
528 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
531 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
532 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
538 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
540 const MonitorQAPIEventState *eva = a;
541 const MonitorQAPIEventState *evb = b;
543 if (eva->event != evb->event) {
547 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
548 return !strcmp(qdict_get_str(eva->data, "id"),
549 qdict_get_str(evb->data, "id"));
552 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
553 return !strcmp(qdict_get_str(eva->data, "node-name"),
554 qdict_get_str(evb->data, "node-name"));
560 static void monitor_qapi_event_init(void)
562 if (qtest_enabled()) {
563 event_clock_type = QEMU_CLOCK_VIRTUAL;
566 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
567 qapi_event_throttle_equal);
568 qmp_event_set_func_emit(monitor_qapi_event_queue);
571 static void handle_hmp_command(Monitor *mon, const char *cmdline);
573 static void monitor_data_init(Monitor *mon)
575 memset(mon, 0, sizeof(Monitor));
576 qemu_mutex_init(&mon->out_lock);
577 mon->outbuf = qstring_new();
578 /* Use *mon_cmds by default. */
579 mon->cmd_table = mon_cmds;
582 static void monitor_data_destroy(Monitor *mon)
584 g_free(mon->mon_cpu_path);
585 qemu_chr_fe_deinit(&mon->chr, false);
586 if (monitor_is_qmp(mon)) {
587 json_message_parser_destroy(&mon->qmp.parser);
589 readline_free(mon->rs);
590 QDECREF(mon->outbuf);
591 qemu_mutex_destroy(&mon->out_lock);
594 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
595 int64_t cpu_index, Error **errp)
598 Monitor *old_mon, hmp;
600 monitor_data_init(&hmp);
601 hmp.skip_flush = true;
607 int ret = monitor_set_cpu(cpu_index);
610 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
616 handle_hmp_command(&hmp, command_line);
619 qemu_mutex_lock(&hmp.out_lock);
620 if (qstring_get_length(hmp.outbuf) > 0) {
621 output = g_strdup(qstring_get_str(hmp.outbuf));
623 output = g_strdup("");
625 qemu_mutex_unlock(&hmp.out_lock);
628 monitor_data_destroy(&hmp);
632 static int compare_cmd(const char *name, const char *list)
634 const char *p, *pstart;
642 p = pstart + strlen(pstart);
643 if ((p - pstart) == len && !memcmp(pstart, name, len))
652 static int get_str(char *buf, int buf_size, const char **pp)
660 while (qemu_isspace(*p)) {
671 while (*p != '\0' && *p != '\"') {
687 printf("unsupported escape code: '\\%c'\n", c);
690 if ((q - buf) < buf_size - 1) {
694 if ((q - buf) < buf_size - 1) {
701 printf("unterminated string\n");
706 while (*p != '\0' && !qemu_isspace(*p)) {
707 if ((q - buf) < buf_size - 1) {
720 static void free_cmdline_args(char **args, int nb_args)
724 assert(nb_args <= MAX_ARGS);
726 for (i = 0; i < nb_args; i++) {
733 * Parse the command line to get valid args.
734 * @cmdline: command line to be parsed.
735 * @pnb_args: location to store the number of args, must NOT be NULL.
736 * @args: location to store the args, which should be freed by caller, must
739 * Returns 0 on success, negative on failure.
741 * NOTE: this parser is an approximate form of the real command parser. Number
742 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
743 * return with failure.
745 static int parse_cmdline(const char *cmdline,
746 int *pnb_args, char **args)
755 while (qemu_isspace(*p)) {
761 if (nb_args >= MAX_ARGS) {
764 ret = get_str(buf, sizeof(buf), &p);
768 args[nb_args] = g_strdup(buf);
775 free_cmdline_args(args, nb_args);
779 static void help_cmd_dump_one(Monitor *mon,
780 const mon_cmd_t *cmd,
786 for (i = 0; i < prefix_args_nb; i++) {
787 monitor_printf(mon, "%s ", prefix_args[i]);
789 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
792 /* @args[@arg_index] is the valid command need to find in @cmds */
793 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
794 char **args, int nb_args, int arg_index)
796 const mon_cmd_t *cmd;
798 /* No valid arg need to compare with, dump all in *cmds */
799 if (arg_index >= nb_args) {
800 for (cmd = cmds; cmd->name != NULL; cmd++) {
801 help_cmd_dump_one(mon, cmd, args, arg_index);
806 /* Find one entry to dump */
807 for (cmd = cmds; cmd->name != NULL; cmd++) {
808 if (compare_cmd(args[arg_index], cmd->name)) {
809 if (cmd->sub_table) {
810 /* continue with next arg */
811 help_cmd_dump(mon, cmd->sub_table,
812 args, nb_args, arg_index + 1);
814 help_cmd_dump_one(mon, cmd, args, arg_index);
821 static void help_cmd(Monitor *mon, const char *name)
823 char *args[MAX_ARGS];
826 /* 1. parse user input */
828 /* special case for log, directly dump and return */
829 if (!strcmp(name, "log")) {
830 const QEMULogItem *item;
831 monitor_printf(mon, "Log items (comma separated):\n");
832 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
833 for (item = qemu_log_items; item->mask != 0; item++) {
834 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
839 if (parse_cmdline(name, &nb_args, args) < 0) {
844 /* 2. dump the contents according to parsed args */
845 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
847 free_cmdline_args(args, nb_args);
850 static void do_help_cmd(Monitor *mon, const QDict *qdict)
852 help_cmd(mon, qdict_get_try_str(qdict, "name"));
855 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
857 const char *tp_name = qdict_get_str(qdict, "name");
858 bool new_state = qdict_get_bool(qdict, "option");
859 bool has_vcpu = qdict_haskey(qdict, "vcpu");
860 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
861 Error *local_err = NULL;
864 monitor_printf(mon, "argument vcpu must be positive");
868 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
870 error_report_err(local_err);
874 #ifdef CONFIG_TRACE_SIMPLE
875 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
877 const char *op = qdict_get_try_str(qdict, "op");
878 const char *arg = qdict_get_try_str(qdict, "arg");
881 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
882 } else if (!strcmp(op, "on")) {
883 st_set_trace_file_enabled(true);
884 } else if (!strcmp(op, "off")) {
885 st_set_trace_file_enabled(false);
886 } else if (!strcmp(op, "flush")) {
887 st_flush_trace_buffer();
888 } else if (!strcmp(op, "set")) {
890 st_set_trace_file(arg);
893 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
894 help_cmd(mon, "trace-file");
899 static void hmp_info_help(Monitor *mon, const QDict *qdict)
901 help_cmd(mon, "info");
904 static void query_commands_cb(QmpCommand *cmd, void *opaque)
906 CommandInfoList *info, **list = opaque;
912 info = g_malloc0(sizeof(*info));
913 info->value = g_malloc0(sizeof(*info->value));
914 info->value->name = g_strdup(cmd->name);
919 CommandInfoList *qmp_query_commands(Error **errp)
921 CommandInfoList *list = NULL;
923 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
928 EventInfoList *qmp_query_events(Error **errp)
930 EventInfoList *info, *ev_list = NULL;
933 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
934 const char *event_name = QAPIEvent_str(e);
935 assert(event_name != NULL);
936 info = g_malloc0(sizeof(*info));
937 info->value = g_malloc0(sizeof(*info->value));
938 info->value->name = g_strdup(event_name);
940 info->next = ev_list;
948 * Minor hack: generated marshalling suppressed for this command
949 * ('gen': false in the schema) so we can parse the JSON string
950 * directly into QObject instead of first parsing it with
951 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
952 * to QObject with generated output marshallers, every time. Instead,
953 * we do it in test-qobject-input-visitor.c, just to make sure
954 * qapi-gen.py's output actually conforms to the schema.
956 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
959 *ret_data = qobject_from_json(qmp_schema_json, &error_abort);
963 * We used to define commands in qmp-commands.hx in addition to the
964 * QAPI schema. This permitted defining some of them only in certain
965 * configurations. query-commands has always reflected that (good,
966 * because it lets QMP clients figure out what's actually available),
967 * while query-qmp-schema never did (not so good). This function is a
968 * hack to keep the configuration-specific commands defined exactly as
969 * before, even though qmp-commands.hx is gone.
971 * FIXME Educate the QAPI schema on configuration-specific commands,
972 * and drop this hack.
974 static void qmp_unregister_commands_hack(void)
977 qmp_unregister_command(&qmp_commands, "query-spice");
979 #ifndef CONFIG_REPLICATION
980 qmp_unregister_command(&qmp_commands, "xen-set-replication");
981 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
982 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
985 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
986 qmp_unregister_command(&qmp_commands, "query-sev");
989 qmp_unregister_command(&qmp_commands, "dump-skeys");
992 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
994 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
995 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
997 #if !defined(TARGET_S390X)
998 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
999 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
1001 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
1002 && !defined(TARGET_S390X)
1003 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1007 void monitor_init_qmp_commands(void)
1010 * Two command lists:
1011 * - qmp_commands contains all QMP commands
1012 * - qmp_cap_negotiation_commands contains just
1013 * "qmp_capabilities", to enforce capability negotiation
1016 qmp_init_marshal(&qmp_commands);
1018 qmp_register_command(&qmp_commands, "query-qmp-schema",
1019 qmp_query_qmp_schema,
1021 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1023 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1026 qmp_unregister_commands_hack();
1028 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1029 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1030 qmp_marshal_qmp_capabilities, QCO_NO_OPTIONS);
1033 void qmp_qmp_capabilities(Error **errp)
1035 if (cur_mon->qmp.commands == &qmp_commands) {
1036 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1037 "Capabilities negotiation is already complete, command "
1042 cur_mon->qmp.commands = &qmp_commands;
1045 /* set the current CPU defined by the user */
1046 int monitor_set_cpu(int cpu_index)
1050 cpu = qemu_get_cpu(cpu_index);
1054 g_free(cur_mon->mon_cpu_path);
1055 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1059 static CPUState *mon_get_cpu_sync(bool synchronize)
1063 if (cur_mon->mon_cpu_path) {
1064 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1067 g_free(cur_mon->mon_cpu_path);
1068 cur_mon->mon_cpu_path = NULL;
1071 if (!cur_mon->mon_cpu_path) {
1075 monitor_set_cpu(first_cpu->cpu_index);
1079 cpu_synchronize_state(cpu);
1084 CPUState *mon_get_cpu(void)
1086 return mon_get_cpu_sync(true);
1089 CPUArchState *mon_get_cpu_env(void)
1091 CPUState *cs = mon_get_cpu();
1093 return cs ? cs->env_ptr : NULL;
1096 int monitor_get_cpu_index(void)
1098 CPUState *cs = mon_get_cpu_sync(false);
1100 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1103 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1105 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1110 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1111 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1117 monitor_printf(mon, "No CPU available\n");
1121 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1126 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1128 if (!tcg_enabled()) {
1129 error_report("JIT information is only available with accel=tcg");
1133 dump_exec_info((FILE *)mon, monitor_fprintf);
1134 dump_drift_info((FILE *)mon, monitor_fprintf);
1137 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1139 dump_opcount_info((FILE *)mon, monitor_fprintf);
1143 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1152 str = readline_get_history(mon->rs, i);
1155 monitor_printf(mon, "%d: '%s'\n", i, str);
1160 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1162 CPUState *cs = mon_get_cpu();
1165 monitor_printf(mon, "No CPU available\n");
1168 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1171 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1173 const char *name = qdict_get_try_str(qdict, "name");
1174 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1175 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1176 TraceEventInfoList *events;
1177 TraceEventInfoList *elem;
1178 Error *local_err = NULL;
1184 monitor_printf(mon, "argument vcpu must be positive");
1188 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1190 error_report_err(local_err);
1194 for (elem = events; elem != NULL; elem = elem->next) {
1195 monitor_printf(mon, "%s : state %u\n",
1197 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1199 qapi_free_TraceEventInfoList(events);
1202 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1203 bool has_port, int64_t port,
1204 bool has_tls_port, int64_t tls_port,
1205 bool has_cert_subject, const char *cert_subject,
1208 if (strcmp(protocol, "spice") == 0) {
1209 if (!qemu_using_spice(errp)) {
1213 if (!has_port && !has_tls_port) {
1214 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1218 if (qemu_spice_migrate_info(hostname,
1219 has_port ? port : -1,
1220 has_tls_port ? tls_port : -1,
1222 error_setg(errp, QERR_UNDEFINED_ERROR);
1228 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1231 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1235 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1237 error_report_err(err);
1241 static void hmp_log(Monitor *mon, const QDict *qdict)
1244 const char *items = qdict_get_str(qdict, "items");
1246 if (!strcmp(items, "none")) {
1249 mask = qemu_str_to_log_mask(items);
1251 help_cmd(mon, "log");
1258 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1260 const char *option = qdict_get_try_str(qdict, "option");
1261 if (!option || !strcmp(option, "on")) {
1263 } else if (!strcmp(option, "off")) {
1266 monitor_printf(mon, "unexpected option %s\n", option);
1270 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1272 const char *device = qdict_get_try_str(qdict, "device");
1274 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1275 if (gdbserver_start(device) < 0) {
1276 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1278 } else if (strcmp(device, "none") == 0) {
1279 monitor_printf(mon, "Disabled gdbserver\n");
1281 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1286 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1288 const char *action = qdict_get_str(qdict, "action");
1289 if (select_watchdog_action(action) == -1) {
1290 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1294 static void monitor_printc(Monitor *mon, int c)
1296 monitor_printf(mon, "'");
1299 monitor_printf(mon, "\\'");
1302 monitor_printf(mon, "\\\\");
1305 monitor_printf(mon, "\\n");
1308 monitor_printf(mon, "\\r");
1311 if (c >= 32 && c <= 126) {
1312 monitor_printf(mon, "%c", c);
1314 monitor_printf(mon, "\\x%02x", c);
1318 monitor_printf(mon, "'");
1321 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1322 hwaddr addr, int is_physical)
1324 int l, line_size, i, max_digits, len;
1327 CPUState *cs = mon_get_cpu();
1329 if (!cs && (format == 'i' || !is_physical)) {
1330 monitor_printf(mon, "Can not dump without CPU\n");
1334 if (format == 'i') {
1335 monitor_disas(mon, cs, addr, count, is_physical);
1339 len = wsize * count;
1348 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1352 max_digits = (wsize * 8) / 4;
1356 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1365 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1367 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1372 cpu_physical_memory_read(addr, buf, l);
1374 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1375 monitor_printf(mon, " Cannot access memory\n");
1384 v = ldub_p(buf + i);
1387 v = lduw_p(buf + i);
1390 v = (uint32_t)ldl_p(buf + i);
1396 monitor_printf(mon, " ");
1399 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1402 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1405 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1408 monitor_printf(mon, "%*" PRId64, max_digits, v);
1411 monitor_printc(mon, v);
1416 monitor_printf(mon, "\n");
1422 static void hmp_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 target_long addr = qdict_get_int(qdict, "addr");
1429 memory_dump(mon, count, format, size, addr, 0);
1432 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1434 int count = qdict_get_int(qdict, "count");
1435 int format = qdict_get_int(qdict, "format");
1436 int size = qdict_get_int(qdict, "size");
1437 hwaddr addr = qdict_get_int(qdict, "addr");
1439 memory_dump(mon, count, format, size, addr, 1);
1442 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1444 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1448 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1452 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1453 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1454 memory_region_unref(mrs.mr);
1459 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1462 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1464 hwaddr addr = qdict_get_int(qdict, "addr");
1465 Error *local_err = NULL;
1466 MemoryRegion *mr = NULL;
1469 ptr = gpa2hva(&mr, addr, &local_err);
1471 error_report_err(local_err);
1475 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1477 addr, mr->name, ptr);
1479 memory_region_unref(mr);
1483 static uint64_t vtop(void *ptr, Error **errp)
1487 uintptr_t addr = (uintptr_t) ptr;
1488 uintptr_t pagesize = getpagesize();
1489 off_t offset = addr / pagesize * sizeof(pinfo);
1492 fd = open("/proc/self/pagemap", O_RDONLY);
1494 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1498 /* Force copy-on-write if necessary. */
1499 atomic_add((uint8_t *)ptr, 0);
1501 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1502 error_setg_errno(errp, errno, "Cannot read pagemap");
1505 if ((pinfo & (1ull << 63)) == 0) {
1506 error_setg(errp, "Page not present");
1509 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1516 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1518 hwaddr addr = qdict_get_int(qdict, "addr");
1519 Error *local_err = NULL;
1520 MemoryRegion *mr = NULL;
1524 ptr = gpa2hva(&mr, addr, &local_err);
1526 error_report_err(local_err);
1530 physaddr = vtop(ptr, &local_err);
1532 error_report_err(local_err);
1534 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1535 " (%s) is 0x%" PRIx64 "\n",
1536 addr, mr->name, (uint64_t) physaddr);
1539 memory_region_unref(mr);
1543 static void do_print(Monitor *mon, const QDict *qdict)
1545 int format = qdict_get_int(qdict, "format");
1546 hwaddr val = qdict_get_int(qdict, "val");
1550 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1553 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1556 monitor_printf(mon, "%" HWADDR_PRIu, val);
1560 monitor_printf(mon, "%" HWADDR_PRId, val);
1563 monitor_printc(mon, val);
1566 monitor_printf(mon, "\n");
1569 static void hmp_sum(Monitor *mon, const QDict *qdict)
1573 uint32_t start = qdict_get_int(qdict, "start");
1574 uint32_t size = qdict_get_int(qdict, "size");
1577 for(addr = start; addr < (start + size); addr++) {
1578 uint8_t val = address_space_ldub(&address_space_memory, addr,
1579 MEMTXATTRS_UNSPECIFIED, NULL);
1580 /* BSD sum algorithm ('sum' Unix command) */
1581 sum = (sum >> 1) | (sum << 15);
1584 monitor_printf(mon, "%05d\n", sum);
1587 static int mouse_button_state;
1589 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1591 int dx, dy, dz, button;
1592 const char *dx_str = qdict_get_str(qdict, "dx_str");
1593 const char *dy_str = qdict_get_str(qdict, "dy_str");
1594 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1596 dx = strtol(dx_str, NULL, 0);
1597 dy = strtol(dy_str, NULL, 0);
1598 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1599 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1602 dz = strtol(dz_str, NULL, 0);
1604 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1605 qemu_input_queue_btn(NULL, button, true);
1606 qemu_input_event_sync();
1607 qemu_input_queue_btn(NULL, button, false);
1610 qemu_input_event_sync();
1613 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1615 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1616 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1617 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1618 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1620 int button_state = qdict_get_int(qdict, "button_state");
1622 if (mouse_button_state == button_state) {
1625 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1626 qemu_input_event_sync();
1627 mouse_button_state = button_state;
1630 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1632 int size = qdict_get_int(qdict, "size");
1633 int addr = qdict_get_int(qdict, "addr");
1634 int has_index = qdict_haskey(qdict, "index");
1639 int index = qdict_get_int(qdict, "index");
1640 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1648 val = cpu_inb(addr);
1652 val = cpu_inw(addr);
1656 val = cpu_inl(addr);
1660 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1661 suffix, addr, size * 2, val);
1664 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1666 int size = qdict_get_int(qdict, "size");
1667 int addr = qdict_get_int(qdict, "addr");
1668 int val = qdict_get_int(qdict, "val");
1670 addr &= IOPORTS_MASK;
1675 cpu_outb(addr, val);
1678 cpu_outw(addr, val);
1681 cpu_outl(addr, val);
1686 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1688 Error *local_err = NULL;
1689 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1691 qemu_boot_set(bootdevice, &local_err);
1693 error_report_err(local_err);
1695 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1699 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1701 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1702 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
1704 mtree_info((fprintf_function)monitor_printf, mon, flatview, dispatch_tree);
1707 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1710 NumaNodeMem *node_mem;
1711 CpuInfoList *cpu_list, *cpu;
1713 cpu_list = qmp_query_cpus(&error_abort);
1714 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
1716 query_numa_node_mem(node_mem);
1717 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1718 for (i = 0; i < nb_numa_nodes; i++) {
1719 monitor_printf(mon, "node %d cpus:", i);
1720 for (cpu = cpu_list; cpu; cpu = cpu->next) {
1721 if (cpu->value->has_props && cpu->value->props->has_node_id &&
1722 cpu->value->props->node_id == i) {
1723 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
1726 monitor_printf(mon, "\n");
1727 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1728 node_mem[i].node_mem >> 20);
1729 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
1730 node_mem[i].node_plugged_mem >> 20);
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,
2696 const char *cmdp_start,
2701 const mon_cmd_t *cmd;
2704 /* extract the command name */
2705 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2709 cmd = search_dispatch_table(table, cmdname);
2711 monitor_printf(mon, "unknown command: '%.*s'\n",
2712 (int)(p - cmdp_start), cmdp_start);
2716 /* filter out following useless space */
2717 while (qemu_isspace(*p)) {
2722 /* search sub command */
2723 if (cmd->sub_table != NULL && *p != '\0') {
2724 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
2731 * Parse arguments for @cmd.
2732 * If it can't be parsed, report to @mon, and return NULL.
2733 * Else, insert command arguments into a QDict, and return it.
2734 * Note: On success, caller has to free the QDict structure.
2737 static QDict *monitor_parse_arguments(Monitor *mon,
2739 const mon_cmd_t *cmd)
2741 const char *typestr;
2744 const char *p = *endp;
2746 QDict *qdict = qdict_new();
2748 /* parse the parameters */
2749 typestr = cmd->args_type;
2751 typestr = key_get_info(typestr, &key);
2763 while (qemu_isspace(*p))
2765 if (*typestr == '?') {
2768 /* no optional string: NULL argument */
2772 ret = get_str(buf, sizeof(buf), &p);
2776 monitor_printf(mon, "%s: filename expected\n",
2780 monitor_printf(mon, "%s: block device name expected\n",
2784 monitor_printf(mon, "%s: string expected\n", cmd->name);
2789 qdict_put_str(qdict, key, buf);
2794 QemuOptsList *opts_list;
2797 opts_list = qemu_find_opts(key);
2798 if (!opts_list || opts_list->desc->name) {
2801 while (qemu_isspace(*p)) {
2806 if (get_str(buf, sizeof(buf), &p) < 0) {
2809 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2813 qemu_opts_to_qdict(opts, qdict);
2814 qemu_opts_del(opts);
2819 int count, format, size;
2821 while (qemu_isspace(*p))
2827 if (qemu_isdigit(*p)) {
2829 while (qemu_isdigit(*p)) {
2830 count = count * 10 + (*p - '0');
2868 if (*p != '\0' && !qemu_isspace(*p)) {
2869 monitor_printf(mon, "invalid char in format: '%c'\n",
2874 format = default_fmt_format;
2875 if (format != 'i') {
2876 /* for 'i', not specifying a size gives -1 as size */
2878 size = default_fmt_size;
2879 default_fmt_size = size;
2881 default_fmt_format = format;
2884 format = default_fmt_format;
2885 if (format != 'i') {
2886 size = default_fmt_size;
2891 qdict_put_int(qdict, "count", count);
2892 qdict_put_int(qdict, "format", format);
2893 qdict_put_int(qdict, "size", size);
2902 while (qemu_isspace(*p))
2904 if (*typestr == '?' || *typestr == '.') {
2905 if (*typestr == '?') {
2913 while (qemu_isspace(*p))
2922 if (get_expr(mon, &val, &p))
2924 /* Check if 'i' is greater than 32-bit */
2925 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2926 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2927 monitor_printf(mon, "integer is for 32-bit values\n");
2929 } else if (c == 'M') {
2931 monitor_printf(mon, "enter a positive value\n");
2936 qdict_put_int(qdict, key, val);
2945 while (qemu_isspace(*p)) {
2948 if (*typestr == '?') {
2954 ret = qemu_strtosz_MiB(p, &end, &val);
2955 if (ret < 0 || val > INT64_MAX) {
2956 monitor_printf(mon, "invalid size\n");
2959 qdict_put_int(qdict, key, val);
2967 while (qemu_isspace(*p))
2969 if (*typestr == '?') {
2975 if (get_double(mon, &val, &p) < 0) {
2978 if (p[0] && p[1] == 's') {
2981 val /= 1e3; p += 2; break;
2983 val /= 1e6; p += 2; break;
2985 val /= 1e9; p += 2; break;
2988 if (*p && !qemu_isspace(*p)) {
2989 monitor_printf(mon, "Unknown unit suffix\n");
2992 qdict_put(qdict, key, qnum_from_double(val));
3000 while (qemu_isspace(*p)) {
3004 while (qemu_isgraph(*p)) {
3007 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3009 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3012 monitor_printf(mon, "Expected 'on' or 'off'\n");
3015 qdict_put_bool(qdict, key, val);
3020 const char *tmp = p;
3027 while (qemu_isspace(*p))
3032 if(!is_valid_option(p, typestr)) {
3034 monitor_printf(mon, "%s: unsupported option -%c\n",
3046 qdict_put_bool(qdict, key, true);
3053 /* package all remaining string */
3056 while (qemu_isspace(*p)) {
3059 if (*typestr == '?') {
3062 /* no remaining string: NULL argument */
3068 monitor_printf(mon, "%s: string expected\n",
3072 qdict_put_str(qdict, key, p);
3078 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3084 /* check that all arguments were parsed */
3085 while (qemu_isspace(*p))
3088 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3101 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3104 const mon_cmd_t *cmd;
3106 trace_handle_hmp_command(mon, cmdline);
3108 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3113 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3115 monitor_printf(mon, "Try \"help %s\" for more information\n",
3120 cmd->cmd(mon, qdict);
3124 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3126 const char *p, *pstart;
3135 p = pstart + strlen(pstart);
3137 if (len > sizeof(cmd) - 2)
3138 len = sizeof(cmd) - 2;
3139 memcpy(cmd, pstart, len);
3141 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3142 readline_add_completion(mon->rs, cmd);
3150 static void file_completion(Monitor *mon, const char *input)
3155 char file[1024], file_prefix[1024];
3159 p = strrchr(input, '/');
3162 pstrcpy(file_prefix, sizeof(file_prefix), input);
3163 pstrcpy(path, sizeof(path), ".");
3165 input_path_len = p - input + 1;
3166 memcpy(path, input, input_path_len);
3167 if (input_path_len > sizeof(path) - 1)
3168 input_path_len = sizeof(path) - 1;
3169 path[input_path_len] = '\0';
3170 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3173 ffs = opendir(path);
3182 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3186 if (strstart(d->d_name, file_prefix, NULL)) {
3187 memcpy(file, input, input_path_len);
3188 if (input_path_len < sizeof(file))
3189 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3191 /* stat the file to find out if it's a directory.
3192 * In that case add a slash to speed up typing long paths
3194 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3195 pstrcat(file, sizeof(file), "/");
3197 readline_add_completion(mon->rs, file);
3203 static const char *next_arg_type(const char *typestr)
3205 const char *p = strchr(typestr, ':');
3206 return (p != NULL ? ++p : typestr);
3209 static void add_completion_option(ReadLineState *rs, const char *str,
3212 if (!str || !option) {
3215 if (!strncmp(option, str, strlen(str))) {
3216 readline_add_completion(rs, option);
3220 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3223 ChardevBackendInfoList *list, *start;
3229 readline_set_completion_index(rs, len);
3231 start = list = qmp_query_chardev_backends(NULL);
3233 const char *chr_name = list->value->name;
3235 if (!strncmp(chr_name, str, len)) {
3236 readline_add_completion(rs, chr_name);
3240 qapi_free_ChardevBackendInfoList(start);
3243 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3252 readline_set_completion_index(rs, len);
3253 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3254 add_completion_option(rs, str, NetClientDriver_str(i));
3258 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3268 readline_set_completion_index(rs, len);
3269 list = elt = object_class_get_list(TYPE_DEVICE, false);
3272 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3274 name = object_class_get_name(OBJECT_CLASS(dc));
3276 if (dc->user_creatable
3277 && !strncmp(name, str, len)) {
3278 readline_add_completion(rs, name);
3285 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3295 readline_set_completion_index(rs, len);
3296 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3300 name = object_class_get_name(OBJECT_CLASS(elt->data));
3301 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3302 readline_add_completion(rs, name);
3309 static void peripheral_device_del_completion(ReadLineState *rs,
3310 const char *str, size_t len)
3312 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3313 GSList *list, *item;
3315 list = qdev_build_hotpluggable_device_list(peripheral);
3320 for (item = list; item; item = g_slist_next(item)) {
3321 DeviceState *dev = item->data;
3323 if (dev->id && !strncmp(str, dev->id, len)) {
3324 readline_add_completion(rs, dev->id);
3331 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3334 ChardevInfoList *list, *start;
3340 readline_set_completion_index(rs, len);
3342 start = list = qmp_query_chardev(NULL);
3344 ChardevInfo *chr = list->value;
3346 if (!strncmp(chr->label, str, len)) {
3347 readline_add_completion(rs, chr->label);
3351 qapi_free_ChardevInfoList(start);
3354 static void ringbuf_completion(ReadLineState *rs, const char *str)
3357 ChardevInfoList *list, *start;
3360 readline_set_completion_index(rs, len);
3362 start = list = qmp_query_chardev(NULL);
3364 ChardevInfo *chr_info = list->value;
3366 if (!strncmp(chr_info->label, str, len)) {
3367 Chardev *chr = qemu_chr_find(chr_info->label);
3368 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3369 readline_add_completion(rs, chr_info->label);
3374 qapi_free_ChardevInfoList(start);
3377 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3382 ringbuf_completion(rs, str);
3385 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3394 readline_set_completion_index(rs, len);
3395 peripheral_device_del_completion(rs, str, len);
3398 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3400 ObjectPropertyInfoList *list, *start;
3407 readline_set_completion_index(rs, len);
3409 start = list = qmp_qom_list("/objects", NULL);
3411 ObjectPropertyInfo *info = list->value;
3413 if (!strncmp(info->type, "child<", 5)
3414 && !strncmp(info->name, str, len)) {
3415 readline_add_completion(rs, info->name);
3419 qapi_free_ObjectPropertyInfoList(start);
3422 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3431 sep = strrchr(str, '-');
3436 readline_set_completion_index(rs, len);
3437 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3438 if (!strncmp(str, QKeyCode_str(i), len)) {
3439 readline_add_completion(rs, QKeyCode_str(i));
3444 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3449 readline_set_completion_index(rs, len);
3451 NetClientState *ncs[MAX_QUEUE_NUM];
3453 count = qemu_find_net_clients_except(NULL, ncs,
3454 NET_CLIENT_DRIVER_NONE,
3456 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3457 const char *name = ncs[i]->name;
3458 if (!strncmp(str, name, len)) {
3459 readline_add_completion(rs, name);
3462 } else if (nb_args == 3) {
3463 add_completion_option(rs, str, "on");
3464 add_completion_option(rs, str, "off");
3468 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3471 NetClientState *ncs[MAX_QUEUE_NUM];
3478 readline_set_completion_index(rs, len);
3479 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3481 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3483 const char *name = ncs[i]->name;
3484 if (strncmp(str, name, len)) {
3487 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3489 readline_add_completion(rs, name);
3494 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3499 readline_set_completion_index(rs, len);
3501 TraceEventIter iter;
3503 char *pattern = g_strdup_printf("%s*", str);
3504 trace_event_iter_init(&iter, pattern);
3505 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3506 readline_add_completion(rs, trace_event_get_name(ev));
3512 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3517 readline_set_completion_index(rs, len);
3519 TraceEventIter iter;
3521 char *pattern = g_strdup_printf("%s*", str);
3522 trace_event_iter_init(&iter, pattern);
3523 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3524 readline_add_completion(rs, trace_event_get_name(ev));
3527 } else if (nb_args == 3) {
3528 add_completion_option(rs, str, "on");
3529 add_completion_option(rs, str, "off");
3533 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3540 readline_set_completion_index(rs, strlen(str));
3541 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3542 add_completion_option(rs, str, WatchdogAction_str(i));
3546 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3552 readline_set_completion_index(rs, len);
3555 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3556 const char *name = MigrationCapability_str(i);
3557 if (!strncmp(str, name, len)) {
3558 readline_add_completion(rs, name);
3561 } else if (nb_args == 3) {
3562 add_completion_option(rs, str, "on");
3563 add_completion_option(rs, str, "off");
3567 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3573 readline_set_completion_index(rs, len);
3576 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3577 const char *name = MigrationParameter_str(i);
3578 if (!strncmp(str, name, len)) {
3579 readline_add_completion(rs, name);
3585 static void vm_completion(ReadLineState *rs, const char *str)
3588 BlockDriverState *bs;
3589 BdrvNextIterator it;
3592 readline_set_completion_index(rs, len);
3594 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3595 SnapshotInfoList *snapshots, *snapshot;
3596 AioContext *ctx = bdrv_get_aio_context(bs);
3599 aio_context_acquire(ctx);
3600 if (bdrv_can_snapshot(bs)) {
3601 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3603 aio_context_release(ctx);
3608 snapshot = snapshots;
3610 char *completion = snapshot->value->name;
3611 if (!strncmp(str, completion, len)) {
3612 readline_add_completion(rs, completion);
3614 completion = snapshot->value->id;
3615 if (!strncmp(str, completion, len)) {
3616 readline_add_completion(rs, completion);
3618 snapshot = snapshot->next;
3620 qapi_free_SnapshotInfoList(snapshots);
3625 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3628 vm_completion(rs, str);
3632 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3635 vm_completion(rs, str);
3639 static void monitor_find_completion_by_table(Monitor *mon,
3640 const mon_cmd_t *cmd_table,
3644 const char *cmdname;
3646 const char *ptype, *old_ptype, *str, *name;
3647 const mon_cmd_t *cmd;
3648 BlockBackend *blk = NULL;
3651 /* command completion */
3656 readline_set_completion_index(mon->rs, strlen(cmdname));
3657 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3658 cmd_completion(mon, cmdname, cmd->name);
3661 /* find the command */
3662 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3663 if (compare_cmd(args[0], cmd->name)) {
3671 if (cmd->sub_table) {
3672 /* do the job again */
3673 monitor_find_completion_by_table(mon, cmd->sub_table,
3674 &args[1], nb_args - 1);
3677 if (cmd->command_completion) {
3678 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3682 ptype = next_arg_type(cmd->args_type);
3683 for(i = 0; i < nb_args - 2; i++) {
3684 if (*ptype != '\0') {
3685 ptype = next_arg_type(ptype);
3686 while (*ptype == '?')
3687 ptype = next_arg_type(ptype);
3690 str = args[nb_args - 1];
3692 while (*ptype == '-' && old_ptype != ptype) {
3694 ptype = next_arg_type(ptype);
3698 /* file completion */
3699 readline_set_completion_index(mon->rs, strlen(str));
3700 file_completion(mon, str);
3703 /* block device name completion */
3704 readline_set_completion_index(mon->rs, strlen(str));
3705 while ((blk = blk_next(blk)) != NULL) {
3706 name = blk_name(blk);
3707 if (str[0] == '\0' ||
3708 !strncmp(name, str, strlen(str))) {
3709 readline_add_completion(mon->rs, name);
3715 if (!strcmp(cmd->name, "help|?")) {
3716 monitor_find_completion_by_table(mon, cmd_table,
3717 &args[1], nb_args - 1);
3726 static void monitor_find_completion(void *opaque,
3727 const char *cmdline)
3729 Monitor *mon = opaque;
3730 char *args[MAX_ARGS];
3733 /* 1. parse the cmdline */
3734 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3738 /* if the line ends with a space, it means we want to complete the
3740 len = strlen(cmdline);
3741 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3742 if (nb_args >= MAX_ARGS) {
3745 args[nb_args++] = g_strdup("");
3748 /* 2. auto complete according to args */
3749 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3752 free_cmdline_args(args, nb_args);
3755 static int monitor_can_read(void *opaque)
3757 Monitor *mon = opaque;
3759 return (mon->suspend_cnt == 0) ? 1 : 0;
3762 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3764 QObject *req, *rsp = NULL, *id = NULL;
3765 QDict *qdict = NULL;
3766 Monitor *mon = cur_mon;
3769 req = json_parser_parse_err(tokens, NULL, &err);
3771 /* json_parser_parse_err() sucks: can fail without setting @err */
3772 error_setg(&err, QERR_JSON_PARSING);
3778 qdict = qobject_to_qdict(req);
3780 id = qdict_get(qdict, "id");
3782 qdict_del(qdict, "id");
3783 } /* else will fail qmp_dispatch() */
3785 if (trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
3786 QString *req_json = qobject_to_json(req);
3787 trace_handle_qmp_command(mon, qstring_get_str(req_json));
3791 rsp = qmp_dispatch(cur_mon->qmp.commands, req);
3793 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
3794 qdict = qdict_get_qdict(qobject_to_qdict(rsp), "error");
3796 && !g_strcmp0(qdict_get_try_str(qdict, "class"),
3797 QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
3798 /* Provide a more useful error message */
3799 qdict_del(qdict, "desc");
3800 qdict_put_str(qdict, "desc", "Expecting capabilities negotiation"
3801 " with 'qmp_capabilities'");
3807 qdict = qdict_new();
3808 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3810 rsp = QOBJECT(qdict);
3815 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3819 monitor_json_emitter(mon, rsp);
3823 qobject_decref(rsp);
3824 qobject_decref(req);
3827 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3829 Monitor *old_mon = cur_mon;
3833 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3838 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3840 Monitor *old_mon = cur_mon;
3846 for (i = 0; i < size; i++)
3847 readline_handle_byte(cur_mon->rs, buf[i]);
3849 if (size == 0 || buf[size - 1] != 0)
3850 monitor_printf(cur_mon, "corrupted command\n");
3852 handle_hmp_command(cur_mon, (char *)buf);
3858 static void monitor_command_cb(void *opaque, const char *cmdline,
3859 void *readline_opaque)
3861 Monitor *mon = opaque;
3863 monitor_suspend(mon);
3864 handle_hmp_command(mon, cmdline);
3865 monitor_resume(mon);
3868 int monitor_suspend(Monitor *mon)
3876 void monitor_resume(Monitor *mon)
3880 if (--mon->suspend_cnt == 0)
3881 readline_show_prompt(mon->rs);
3884 static QObject *get_qmp_greeting(void)
3886 QObject *ver = NULL;
3888 qmp_marshal_query_version(NULL, &ver, NULL);
3890 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3894 static void monitor_qmp_event(void *opaque, int event)
3897 Monitor *mon = opaque;
3900 case CHR_EVENT_OPENED:
3901 mon->qmp.commands = &qmp_cap_negotiation_commands;
3902 data = get_qmp_greeting();
3903 monitor_json_emitter(mon, data);
3904 qobject_decref(data);
3907 case CHR_EVENT_CLOSED:
3908 json_message_parser_destroy(&mon->qmp.parser);
3909 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3911 monitor_fdsets_cleanup();
3916 static void monitor_event(void *opaque, int event)
3918 Monitor *mon = opaque;
3921 case CHR_EVENT_MUX_IN:
3922 qemu_mutex_lock(&mon->out_lock);
3924 qemu_mutex_unlock(&mon->out_lock);
3925 if (mon->reset_seen) {
3926 readline_restart(mon->rs);
3927 monitor_resume(mon);
3930 mon->suspend_cnt = 0;
3934 case CHR_EVENT_MUX_OUT:
3935 if (mon->reset_seen) {
3936 if (mon->suspend_cnt == 0) {
3937 monitor_printf(mon, "\n");
3940 monitor_suspend(mon);
3944 qemu_mutex_lock(&mon->out_lock);
3946 qemu_mutex_unlock(&mon->out_lock);
3949 case CHR_EVENT_OPENED:
3950 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3951 "information\n", QEMU_VERSION);
3952 if (!mon->mux_out) {
3953 readline_restart(mon->rs);
3954 readline_show_prompt(mon->rs);
3956 mon->reset_seen = 1;
3960 case CHR_EVENT_CLOSED:
3962 monitor_fdsets_cleanup();
3968 compare_mon_cmd(const void *a, const void *b)
3970 return strcmp(((const mon_cmd_t *)a)->name,
3971 ((const mon_cmd_t *)b)->name);
3974 static void sortcmdlist(void)
3977 int elem_size = sizeof(mon_cmd_t);
3979 array_num = sizeof(mon_cmds)/elem_size-1;
3980 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
3982 array_num = sizeof(info_cmds)/elem_size-1;
3983 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
3986 /* These functions just adapt the readline interface in a typesafe way. We
3987 * could cast function pointers but that discards compiler checks.
3989 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
3990 const char *fmt, ...)
3994 monitor_vprintf(opaque, fmt, ap);
3998 static void monitor_readline_flush(void *opaque)
4000 monitor_flush(opaque);
4004 * Print to current monitor if we have one, else to stderr.
4005 * TODO should return int, so callers can calculate width, but that
4006 * requires surgery to monitor_vprintf(). Left for another day.
4008 void error_vprintf(const char *fmt, va_list ap)
4010 if (cur_mon && !monitor_cur_is_qmp()) {
4011 monitor_vprintf(cur_mon, fmt, ap);
4013 vfprintf(stderr, fmt, ap);
4017 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4019 if (cur_mon && !monitor_cur_is_qmp()) {
4020 monitor_vprintf(cur_mon, fmt, ap);
4021 } else if (!cur_mon) {
4022 vfprintf(stderr, fmt, ap);
4026 static void __attribute__((constructor)) monitor_lock_init(void)
4028 qemu_mutex_init(&monitor_lock);
4031 void monitor_init(Chardev *chr, int flags)
4033 static int is_first_init = 1;
4036 if (is_first_init) {
4037 monitor_qapi_event_init();
4042 mon = g_malloc(sizeof(*mon));
4043 monitor_data_init(mon);
4045 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4047 if (flags & MONITOR_USE_READLINE) {
4048 mon->rs = readline_init(monitor_readline_printf,
4049 monitor_readline_flush,
4051 monitor_find_completion);
4052 monitor_read_command(mon, 0);
4055 if (monitor_is_qmp(mon)) {
4056 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4057 monitor_qmp_event, NULL, mon, NULL, true);
4058 qemu_chr_fe_set_echo(&mon->chr, true);
4059 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4061 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4062 monitor_event, NULL, mon, NULL, true);
4065 qemu_mutex_lock(&monitor_lock);
4066 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4067 qemu_mutex_unlock(&monitor_lock);
4070 void monitor_cleanup(void)
4072 Monitor *mon, *next;
4074 qemu_mutex_lock(&monitor_lock);
4075 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4076 QLIST_REMOVE(mon, entry);
4077 monitor_data_destroy(mon);
4080 qemu_mutex_unlock(&monitor_lock);
4083 QemuOptsList qemu_mon_opts = {
4085 .implied_opt_name = "chardev",
4086 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4090 .type = QEMU_OPT_STRING,
4093 .type = QEMU_OPT_STRING,
4096 .type = QEMU_OPT_BOOL,
4098 { /* end of list */ }
4103 void qmp_rtc_reset_reinjection(Error **errp)
4105 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4108 SevInfo *qmp_query_sev(Error **errp)
4110 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev");
4115 #ifndef TARGET_S390X
4116 void qmp_dump_skeys(const char *filename, Error **errp)
4118 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4123 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4125 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4130 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4132 MachineState *ms = MACHINE(qdev_get_machine());
4133 MachineClass *mc = MACHINE_GET_CLASS(ms);
4135 if (!mc->has_hotpluggable_cpus) {
4136 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4140 return machine_query_hotpluggable_cpus(ms);