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"
26 #include "qemu/units.h"
30 #include "monitor/qdev.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 "chardev/char-io.h"
40 #include "chardev/char-mux.h"
41 #include "ui/qemu-spice.h"
42 #include "sysemu/numa.h"
43 #include "monitor/monitor.h"
44 #include "qemu/config-file.h"
45 #include "qemu/readline.h"
46 #include "ui/console.h"
48 #include "sysemu/block-backend.h"
49 #include "audio/audio.h"
50 #include "disas/disas.h"
51 #include "sysemu/balloon.h"
52 #include "qemu/timer.h"
53 #include "sysemu/hw_accel.h"
55 #include "sysemu/tpm.h"
56 #include "qapi/qmp/qdict.h"
57 #include "qapi/qmp/qerror.h"
58 #include "qapi/qmp/qnum.h"
59 #include "qapi/qmp/qstring.h"
60 #include "qapi/qmp/qjson.h"
61 #include "qapi/qmp/json-streamer.h"
62 #include "qapi/qmp/json-parser.h"
63 #include "qapi/qmp/qlist.h"
64 #include "qom/object_interfaces.h"
65 #include "trace-root.h"
66 #include "trace/control.h"
67 #include "monitor/hmp-target.h"
68 #ifdef CONFIG_TRACE_SIMPLE
69 #include "trace/simple.h"
71 #include "exec/memory.h"
72 #include "exec/exec-all.h"
74 #include "qemu/option.h"
76 #include "qemu/thread.h"
77 #include "block/qapi.h"
78 #include "qapi/qapi-commands.h"
79 #include "qapi/qapi-events.h"
80 #include "qapi/error.h"
81 #include "qapi/qmp-event.h"
82 #include "qapi/qapi-introspect.h"
83 #include "sysemu/qtest.h"
84 #include "sysemu/cpus.h"
85 #include "sysemu/iothread.h"
86 #include "qemu/cutils.h"
88 #if defined(TARGET_S390X)
89 #include "hw/s390x/storage-keys.h"
90 #include "hw/s390x/storage-attributes.h"
97 * 'B' block device name
98 * 's' string (accept optional quote)
99 * 'S' it just appends the rest of the string (accept optional quote)
100 * 'O' option string of the form NAME=VALUE,...
101 * parsed according to QemuOptsList given by its name
102 * Example: 'device:O' uses qemu_device_opts.
103 * Restriction: only lists with empty desc are supported
104 * TODO lift the restriction
106 * 'l' target long (32 or 64 bit)
107 * 'M' Non-negative target long (32 or 64 bit), in user mode the
108 * value is multiplied by 2^20 (think Mebibyte)
109 * 'o' octets (aka bytes)
110 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
111 * K, k suffix, which multiplies the value by 2^60 for suffixes E
112 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
113 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
115 * user mode accepts an optional ms, us, ns suffix,
116 * which divides the value by 1e3, 1e6, 1e9, respectively
117 * '/' optional gdb-like print format (like "/10x")
119 * '?' optional type (for all types, except '/')
120 * '.' other form of optional type (for 'i' and 'l')
122 * user mode accepts "on" or "off"
123 * '-' optional parameter (eg. '-f')
127 typedef struct mon_cmd_t {
129 const char *args_type;
132 const char *flags; /* p=preconfig */
133 void (*cmd)(Monitor *mon, const QDict *qdict);
134 /* @sub_table is a list of 2nd level of commands. If it does not exist,
135 * cmd should be used. If it exists, sub_table[?].cmd should be
136 * used, and cmd of 1st level plays the role of help function.
138 struct mon_cmd_t *sub_table;
139 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
142 /* file descriptors passed via SCM_RIGHTS */
143 typedef struct mon_fd_t mon_fd_t;
147 QLIST_ENTRY(mon_fd_t) next;
150 /* file descriptor associated with a file descriptor set */
151 typedef struct MonFdsetFd MonFdsetFd;
156 QLIST_ENTRY(MonFdsetFd) next;
159 /* file descriptor set containing fds passed via SCM_RIGHTS */
160 typedef struct MonFdset MonFdset;
163 QLIST_HEAD(, MonFdsetFd) fds;
164 QLIST_HEAD(, MonFdsetFd) dup_fds;
165 QLIST_ENTRY(MonFdset) next;
169 JSONMessageParser parser;
171 * When a client connects, we're in capabilities negotiation mode.
172 * When command qmp_capabilities succeeds, we go into command
175 QmpCommandList *commands;
176 bool qmp_caps[QMP_CAPABILITY__MAX];
178 * Protects qmp request/response queue. Please take monitor_lock
179 * first when used together.
181 QemuMutex qmp_queue_lock;
182 /* Input queue that holds all the parsed QMP requests */
183 GQueue *qmp_requests;
184 /* Output queue contains all the QMP responses in order */
185 GQueue *qmp_responses;
189 * To prevent flooding clients, events can be throttled. The
190 * throttling is calculated globally, rather than per-Monitor
193 typedef struct MonitorQAPIEventState {
194 QAPIEvent event; /* Throttling state for this event type and... */
195 QDict *data; /* ... data, see qapi_event_throttle_equal() */
196 QEMUTimer *timer; /* Timer for handling delayed events */
197 QDict *qdict; /* Delayed event (if any) */
198 } MonitorQAPIEventState;
201 int64_t rate; /* Minimum time (in ns) between two events */
202 } MonitorQAPIEventConf;
208 int suspend_cnt; /* Needs to be accessed atomically */
213 * State used only in the thread "owning" the monitor.
214 * If @use_io_thr, this is mon_global.mon_iothread.
215 * Else, it's the main thread.
216 * These members can be safely accessed without locks.
222 BlockCompletionFunc *password_completion_cb;
223 void *password_opaque;
224 mon_cmd_t *cmd_table;
225 QTAILQ_ENTRY(Monitor) entry;
228 * The per-monitor lock. We can't access guest memory when holding
234 * Fields that are protected by the per-monitor lock.
236 QLIST_HEAD(, mon_fd_t) fds;
239 /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
243 /* Let's add monitor global variables to this struct. */
245 IOThread *mon_iothread;
246 /* Bottom half to dispatch the requests received from I/O thread */
247 QEMUBH *qmp_dispatcher_bh;
248 /* Bottom half to deliver the responses back to clients */
249 QEMUBH *qmp_respond_bh;
253 /* Owner of the request */
255 /* "id" field of the request */
258 * Request object to be handled or Error to be reported
259 * (exactly one of them is non-null)
264 * Whether we need to resume the monitor afterward. This flag is
265 * used to emulate the old QMP server behavior that the current
266 * command must be completed before execution of the next one.
270 typedef struct QMPRequest QMPRequest;
272 /* QMP checker flags */
273 #define QMP_ACCEPT_UNKNOWNS 1
275 /* Protects mon_list, monitor_qapi_event_state. */
276 static QemuMutex monitor_lock;
277 static GHashTable *monitor_qapi_event_state;
278 static QTAILQ_HEAD(mon_list, Monitor) mon_list;
280 /* Protects mon_fdsets */
281 static QemuMutex mon_fdsets_lock;
282 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
284 static int mon_refcount;
286 static mon_cmd_t mon_cmds[];
287 static mon_cmd_t info_cmds[];
289 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
293 static void monitor_command_cb(void *opaque, const char *cmdline,
294 void *readline_opaque);
297 * Is @mon a QMP monitor?
299 static inline bool monitor_is_qmp(const Monitor *mon)
301 return (mon->flags & MONITOR_USE_CONTROL);
305 * Whether @mon is using readline? Note: not all HMP monitors use
306 * readline, e.g., gdbserver has a non-interactive HMP monitor, so
307 * readline is not used there.
309 static inline bool monitor_uses_readline(const Monitor *mon)
311 return mon->flags & MONITOR_USE_READLINE;
314 static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
316 return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
320 * Return the clock to use for recording an event's time.
321 * Beware: result is invalid before configure_accelerator().
323 static inline QEMUClockType monitor_get_event_clock(void)
326 * This allows us to perform tests on the monitor queues to verify
327 * that the rate limits are enforced.
329 return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
333 * Is the current monitor, if any, a QMP monitor?
335 bool monitor_cur_is_qmp(void)
337 return cur_mon && monitor_is_qmp(cur_mon);
340 void monitor_read_command(Monitor *mon, int show_prompt)
345 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
347 readline_show_prompt(mon->rs);
350 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
354 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
355 /* prompt is printed on return from the command handler */
358 monitor_printf(mon, "terminal does not support password prompting\n");
363 static void qmp_request_free(QMPRequest *req)
365 qobject_unref(req->id);
366 qobject_unref(req->req);
367 error_free(req->err);
371 /* Must with the mon->qmp.qmp_queue_lock held */
372 static void monitor_qmp_cleanup_req_queue_locked(Monitor *mon)
374 while (!g_queue_is_empty(mon->qmp.qmp_requests)) {
375 qmp_request_free(g_queue_pop_head(mon->qmp.qmp_requests));
379 /* Must with the mon->qmp.qmp_queue_lock held */
380 static void monitor_qmp_cleanup_resp_queue_locked(Monitor *mon)
382 while (!g_queue_is_empty(mon->qmp.qmp_responses)) {
383 qobject_unref((QObject *)g_queue_pop_head(mon->qmp.qmp_responses));
387 static void monitor_qmp_cleanup_queues(Monitor *mon)
389 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
390 monitor_qmp_cleanup_req_queue_locked(mon);
391 monitor_qmp_cleanup_resp_queue_locked(mon);
392 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
396 static void monitor_flush_locked(Monitor *mon);
398 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
401 Monitor *mon = opaque;
403 qemu_mutex_lock(&mon->mon_lock);
405 monitor_flush_locked(mon);
406 qemu_mutex_unlock(&mon->mon_lock);
410 /* Called with mon->mon_lock held. */
411 static void monitor_flush_locked(Monitor *mon)
417 if (mon->skip_flush) {
421 buf = qstring_get_str(mon->outbuf);
422 len = qstring_get_length(mon->outbuf);
424 if (len && !mon->mux_out) {
425 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
426 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
427 /* all flushed or error */
428 qobject_unref(mon->outbuf);
429 mon->outbuf = qstring_new();
434 QString *tmp = qstring_from_str(buf + rc);
435 qobject_unref(mon->outbuf);
438 if (mon->out_watch == 0) {
440 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
441 monitor_unblocked, mon);
446 void monitor_flush(Monitor *mon)
448 qemu_mutex_lock(&mon->mon_lock);
449 monitor_flush_locked(mon);
450 qemu_mutex_unlock(&mon->mon_lock);
453 /* flush at every end of line */
454 static void monitor_puts(Monitor *mon, const char *str)
458 qemu_mutex_lock(&mon->mon_lock);
464 qstring_append_chr(mon->outbuf, '\r');
466 qstring_append_chr(mon->outbuf, c);
468 monitor_flush_locked(mon);
471 qemu_mutex_unlock(&mon->mon_lock);
474 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
481 if (monitor_is_qmp(mon)) {
485 buf = g_strdup_vprintf(fmt, ap);
486 monitor_puts(mon, buf);
490 void monitor_printf(Monitor *mon, const char *fmt, ...)
494 monitor_vprintf(mon, fmt, ap);
498 int monitor_fprintf(FILE *stream, const char *fmt, ...)
502 monitor_vprintf((Monitor *)stream, fmt, ap);
507 static void monitor_json_emitter_raw(Monitor *mon,
512 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
513 qobject_to_json(data);
514 assert(json != NULL);
516 qstring_append_chr(json, '\n');
517 monitor_puts(mon, qstring_get_str(json));
522 static void monitor_json_emitter(Monitor *mon, QObject *data)
524 if (mon->use_io_thr) {
526 * If using I/O thread, we need to queue the item so that I/O
527 * thread will do the rest for us. Take refcount so that
528 * caller won't free the data (which will be finally freed in
531 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
532 g_queue_push_tail(mon->qmp.qmp_responses, qobject_ref(data));
533 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
534 qemu_bh_schedule(mon_global.qmp_respond_bh);
537 * If not using monitor I/O thread, then we are in main thread.
538 * Do the emission right away.
540 monitor_json_emitter_raw(mon, data);
548 typedef struct QMPResponse QMPResponse;
550 static QObject *monitor_qmp_response_pop_one(Monitor *mon)
554 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
555 data = g_queue_pop_head(mon->qmp.qmp_responses);
556 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
561 static void monitor_qmp_response_flush(Monitor *mon)
565 while ((data = monitor_qmp_response_pop_one(mon))) {
566 monitor_json_emitter_raw(mon, data);
572 * Pop a QMPResponse from any monitor's response queue into @response.
573 * Return false if all the queues are empty; else true.
575 static bool monitor_qmp_response_pop_any(QMPResponse *response)
578 QObject *data = NULL;
580 qemu_mutex_lock(&monitor_lock);
581 QTAILQ_FOREACH(mon, &mon_list, entry) {
582 data = monitor_qmp_response_pop_one(mon);
585 response->data = data;
589 qemu_mutex_unlock(&monitor_lock);
593 static void monitor_qmp_bh_responder(void *opaque)
595 QMPResponse response;
597 while (monitor_qmp_response_pop_any(&response)) {
598 monitor_json_emitter_raw(response.mon, response.data);
599 qobject_unref(response.data);
603 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
604 /* Limit guest-triggerable events to 1 per second */
605 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
606 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
607 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
608 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
609 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
610 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
614 * Emits the event to every monitor instance, @event is only used for trace
615 * Called with monitor_lock held.
617 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
621 trace_monitor_protocol_event_emit(event, qdict);
622 QTAILQ_FOREACH(mon, &mon_list, entry) {
623 if (monitor_is_qmp(mon)
624 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
625 monitor_json_emitter(mon, QOBJECT(qdict));
630 static void monitor_qapi_event_handler(void *opaque);
633 * Queue a new event for emission to Monitor instances,
634 * applying any rate limiting if required.
637 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
639 MonitorQAPIEventConf *evconf;
640 MonitorQAPIEventState *evstate;
642 assert(event < QAPI_EVENT__MAX);
643 evconf = &monitor_qapi_event_conf[event];
644 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
646 qemu_mutex_lock(&monitor_lock);
649 /* Unthrottled event */
650 monitor_qapi_event_emit(event, qdict);
652 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
653 MonitorQAPIEventState key = { .event = event, .data = data };
655 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
656 assert(!evstate || timer_pending(evstate->timer));
660 * Timer is pending for (at least) evconf->rate ns after
661 * last send. Store event for sending when timer fires,
662 * replacing a prior stored event if any.
664 qobject_unref(evstate->qdict);
665 evstate->qdict = qobject_ref(qdict);
668 * Last send was (at least) evconf->rate ns ago.
669 * Send immediately, and arm the timer to call
670 * monitor_qapi_event_handler() in evconf->rate ns. Any
671 * events arriving before then will be delayed until then.
673 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
675 monitor_qapi_event_emit(event, qdict);
677 evstate = g_new(MonitorQAPIEventState, 1);
678 evstate->event = event;
679 evstate->data = qobject_ref(data);
680 evstate->qdict = NULL;
681 evstate->timer = timer_new_ns(monitor_get_event_clock(),
682 monitor_qapi_event_handler,
684 g_hash_table_add(monitor_qapi_event_state, evstate);
685 timer_mod_ns(evstate->timer, now + evconf->rate);
689 qemu_mutex_unlock(&monitor_lock);
693 * This function runs evconf->rate ns after sending a throttled
695 * If another event has since been stored, send it.
697 static void monitor_qapi_event_handler(void *opaque)
699 MonitorQAPIEventState *evstate = opaque;
700 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
702 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
703 qemu_mutex_lock(&monitor_lock);
705 if (evstate->qdict) {
706 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
708 monitor_qapi_event_emit(evstate->event, evstate->qdict);
709 qobject_unref(evstate->qdict);
710 evstate->qdict = NULL;
711 timer_mod_ns(evstate->timer, now + evconf->rate);
713 g_hash_table_remove(monitor_qapi_event_state, evstate);
714 qobject_unref(evstate->data);
715 timer_free(evstate->timer);
719 qemu_mutex_unlock(&monitor_lock);
722 static unsigned int qapi_event_throttle_hash(const void *key)
724 const MonitorQAPIEventState *evstate = key;
725 unsigned int hash = evstate->event * 255;
727 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
728 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
731 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
732 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
738 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
740 const MonitorQAPIEventState *eva = a;
741 const MonitorQAPIEventState *evb = b;
743 if (eva->event != evb->event) {
747 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
748 return !strcmp(qdict_get_str(eva->data, "id"),
749 qdict_get_str(evb->data, "id"));
752 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
753 return !strcmp(qdict_get_str(eva->data, "node-name"),
754 qdict_get_str(evb->data, "node-name"));
760 static void monitor_qapi_event_init(void)
762 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
763 qapi_event_throttle_equal);
764 qmp_event_set_func_emit(monitor_qapi_event_queue);
767 static void handle_hmp_command(Monitor *mon, const char *cmdline);
769 static void monitor_data_init(Monitor *mon, bool skip_flush,
772 memset(mon, 0, sizeof(Monitor));
773 qemu_mutex_init(&mon->mon_lock);
774 qemu_mutex_init(&mon->qmp.qmp_queue_lock);
775 mon->outbuf = qstring_new();
776 /* Use *mon_cmds by default. */
777 mon->cmd_table = mon_cmds;
778 mon->skip_flush = skip_flush;
779 mon->use_io_thr = use_io_thr;
780 mon->qmp.qmp_requests = g_queue_new();
781 mon->qmp.qmp_responses = g_queue_new();
784 static void monitor_data_destroy(Monitor *mon)
786 g_free(mon->mon_cpu_path);
787 qemu_chr_fe_deinit(&mon->chr, false);
788 if (monitor_is_qmp(mon)) {
789 json_message_parser_destroy(&mon->qmp.parser);
791 readline_free(mon->rs);
792 qobject_unref(mon->outbuf);
793 qemu_mutex_destroy(&mon->mon_lock);
794 qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
795 monitor_qmp_cleanup_req_queue_locked(mon);
796 monitor_qmp_cleanup_resp_queue_locked(mon);
797 g_queue_free(mon->qmp.qmp_requests);
798 g_queue_free(mon->qmp.qmp_responses);
801 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
802 int64_t cpu_index, Error **errp)
805 Monitor *old_mon, hmp;
807 monitor_data_init(&hmp, true, false);
813 int ret = monitor_set_cpu(cpu_index);
816 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
822 handle_hmp_command(&hmp, command_line);
825 qemu_mutex_lock(&hmp.mon_lock);
826 if (qstring_get_length(hmp.outbuf) > 0) {
827 output = g_strdup(qstring_get_str(hmp.outbuf));
829 output = g_strdup("");
831 qemu_mutex_unlock(&hmp.mon_lock);
834 monitor_data_destroy(&hmp);
838 static int compare_cmd(const char *name, const char *list)
840 const char *p, *pstart;
846 p = qemu_strchrnul(p, '|');
847 if ((p - pstart) == len && !memcmp(pstart, name, len))
856 static int get_str(char *buf, int buf_size, const char **pp)
864 while (qemu_isspace(*p)) {
875 while (*p != '\0' && *p != '\"') {
891 printf("unsupported escape code: '\\%c'\n", c);
894 if ((q - buf) < buf_size - 1) {
898 if ((q - buf) < buf_size - 1) {
905 printf("unterminated string\n");
910 while (*p != '\0' && !qemu_isspace(*p)) {
911 if ((q - buf) < buf_size - 1) {
924 static void free_cmdline_args(char **args, int nb_args)
928 assert(nb_args <= MAX_ARGS);
930 for (i = 0; i < nb_args; i++) {
937 * Parse the command line to get valid args.
938 * @cmdline: command line to be parsed.
939 * @pnb_args: location to store the number of args, must NOT be NULL.
940 * @args: location to store the args, which should be freed by caller, must
943 * Returns 0 on success, negative on failure.
945 * NOTE: this parser is an approximate form of the real command parser. Number
946 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
947 * return with failure.
949 static int parse_cmdline(const char *cmdline,
950 int *pnb_args, char **args)
959 while (qemu_isspace(*p)) {
965 if (nb_args >= MAX_ARGS) {
968 ret = get_str(buf, sizeof(buf), &p);
972 args[nb_args] = g_strdup(buf);
979 free_cmdline_args(args, nb_args);
984 * Returns true if the command can be executed in preconfig mode
985 * i.e. it has the 'p' flag.
987 static bool cmd_can_preconfig(const mon_cmd_t *cmd)
993 return strchr(cmd->flags, 'p');
996 static void help_cmd_dump_one(Monitor *mon,
997 const mon_cmd_t *cmd,
1003 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
1007 for (i = 0; i < prefix_args_nb; i++) {
1008 monitor_printf(mon, "%s ", prefix_args[i]);
1010 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
1013 /* @args[@arg_index] is the valid command need to find in @cmds */
1014 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
1015 char **args, int nb_args, int arg_index)
1017 const mon_cmd_t *cmd;
1019 /* No valid arg need to compare with, dump all in *cmds */
1020 if (arg_index >= nb_args) {
1021 for (cmd = cmds; cmd->name != NULL; cmd++) {
1022 help_cmd_dump_one(mon, cmd, args, arg_index);
1027 /* Find one entry to dump */
1028 for (cmd = cmds; cmd->name != NULL; cmd++) {
1029 if (compare_cmd(args[arg_index], cmd->name) &&
1030 ((!runstate_check(RUN_STATE_PRECONFIG) ||
1031 cmd_can_preconfig(cmd)))) {
1032 if (cmd->sub_table) {
1033 /* continue with next arg */
1034 help_cmd_dump(mon, cmd->sub_table,
1035 args, nb_args, arg_index + 1);
1037 help_cmd_dump_one(mon, cmd, args, arg_index);
1044 static void help_cmd(Monitor *mon, const char *name)
1046 char *args[MAX_ARGS];
1049 /* 1. parse user input */
1051 /* special case for log, directly dump and return */
1052 if (!strcmp(name, "log")) {
1053 const QEMULogItem *item;
1054 monitor_printf(mon, "Log items (comma separated):\n");
1055 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
1056 for (item = qemu_log_items; item->mask != 0; item++) {
1057 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
1062 if (parse_cmdline(name, &nb_args, args) < 0) {
1067 /* 2. dump the contents according to parsed args */
1068 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
1070 free_cmdline_args(args, nb_args);
1073 static void do_help_cmd(Monitor *mon, const QDict *qdict)
1075 help_cmd(mon, qdict_get_try_str(qdict, "name"));
1078 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
1080 const char *tp_name = qdict_get_str(qdict, "name");
1081 bool new_state = qdict_get_bool(qdict, "option");
1082 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1083 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1084 Error *local_err = NULL;
1087 monitor_printf(mon, "argument vcpu must be positive");
1091 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
1093 error_report_err(local_err);
1097 #ifdef CONFIG_TRACE_SIMPLE
1098 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
1100 const char *op = qdict_get_try_str(qdict, "op");
1101 const char *arg = qdict_get_try_str(qdict, "arg");
1104 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
1105 } else if (!strcmp(op, "on")) {
1106 st_set_trace_file_enabled(true);
1107 } else if (!strcmp(op, "off")) {
1108 st_set_trace_file_enabled(false);
1109 } else if (!strcmp(op, "flush")) {
1110 st_flush_trace_buffer();
1111 } else if (!strcmp(op, "set")) {
1113 st_set_trace_file(arg);
1116 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
1117 help_cmd(mon, "trace-file");
1122 static void hmp_info_help(Monitor *mon, const QDict *qdict)
1124 help_cmd(mon, "info");
1127 static void query_commands_cb(QmpCommand *cmd, void *opaque)
1129 CommandInfoList *info, **list = opaque;
1131 if (!cmd->enabled) {
1135 info = g_malloc0(sizeof(*info));
1136 info->value = g_malloc0(sizeof(*info->value));
1137 info->value->name = g_strdup(cmd->name);
1142 CommandInfoList *qmp_query_commands(Error **errp)
1144 CommandInfoList *list = NULL;
1146 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
1151 EventInfoList *qmp_query_events(Error **errp)
1153 EventInfoList *info, *ev_list = NULL;
1156 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
1157 const char *event_name = QAPIEvent_str(e);
1158 assert(event_name != NULL);
1159 info = g_malloc0(sizeof(*info));
1160 info->value = g_malloc0(sizeof(*info->value));
1161 info->value->name = g_strdup(event_name);
1163 info->next = ev_list;
1171 * Minor hack: generated marshalling suppressed for this command
1172 * ('gen': false in the schema) so we can parse the JSON string
1173 * directly into QObject instead of first parsing it with
1174 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
1175 * to QObject with generated output marshallers, every time. Instead,
1176 * we do it in test-qobject-input-visitor.c, just to make sure
1177 * qapi-gen.py's output actually conforms to the schema.
1179 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
1182 *ret_data = qobject_from_qlit(&qmp_schema_qlit);
1186 * We used to define commands in qmp-commands.hx in addition to the
1187 * QAPI schema. This permitted defining some of them only in certain
1188 * configurations. query-commands has always reflected that (good,
1189 * because it lets QMP clients figure out what's actually available),
1190 * while query-qmp-schema never did (not so good). This function is a
1191 * hack to keep the configuration-specific commands defined exactly as
1192 * before, even though qmp-commands.hx is gone.
1194 * FIXME Educate the QAPI schema on configuration-specific commands,
1195 * and drop this hack.
1197 static void qmp_unregister_commands_hack(void)
1199 #ifndef CONFIG_SPICE
1200 qmp_unregister_command(&qmp_commands, "query-spice");
1202 #ifndef CONFIG_REPLICATION
1203 qmp_unregister_command(&qmp_commands, "xen-set-replication");
1204 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
1205 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
1208 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
1209 qmp_unregister_command(&qmp_commands, "query-sev");
1210 qmp_unregister_command(&qmp_commands, "query-sev-launch-measure");
1211 qmp_unregister_command(&qmp_commands, "query-sev-capabilities");
1213 #ifndef TARGET_S390X
1214 qmp_unregister_command(&qmp_commands, "dump-skeys");
1217 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
1219 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
1220 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
1222 #if !defined(TARGET_S390X)
1223 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
1224 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
1226 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
1227 && !defined(TARGET_S390X)
1228 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1232 static void monitor_init_qmp_commands(void)
1235 * Two command lists:
1236 * - qmp_commands contains all QMP commands
1237 * - qmp_cap_negotiation_commands contains just
1238 * "qmp_capabilities", to enforce capability negotiation
1241 qmp_init_marshal(&qmp_commands);
1243 qmp_register_command(&qmp_commands, "query-qmp-schema",
1244 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
1245 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1247 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1250 qmp_unregister_commands_hack();
1252 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1253 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1254 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
1257 static bool qmp_cap_enabled(Monitor *mon, QMPCapability cap)
1259 return mon->qmp.qmp_caps[cap];
1262 static bool qmp_oob_enabled(Monitor *mon)
1264 return qmp_cap_enabled(mon, QMP_CAPABILITY_OOB);
1267 static void qmp_caps_check(Monitor *mon, QMPCapabilityList *list,
1270 for (; list; list = list->next) {
1271 assert(list->value < QMP_CAPABILITY__MAX);
1272 switch (list->value) {
1273 case QMP_CAPABILITY_OOB:
1274 if (!mon->use_io_thr) {
1276 * Out-of-band only works with monitors that are
1277 * running on dedicated I/O thread.
1279 error_setg(errp, "This monitor does not support "
1280 "out-of-band (OOB)");
1290 /* This function should only be called after capabilities are checked. */
1291 static void qmp_caps_apply(Monitor *mon, QMPCapabilityList *list)
1293 for (; list; list = list->next) {
1294 mon->qmp.qmp_caps[list->value] = true;
1298 void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
1301 Error *local_err = NULL;
1303 if (cur_mon->qmp.commands == &qmp_commands) {
1304 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1305 "Capabilities negotiation is already complete, command "
1310 /* Enable QMP capabilities provided by the client if applicable. */
1312 qmp_caps_check(cur_mon, enable, &local_err);
1315 * Failed check on any of the capabilities will fail the
1316 * entire command (and thus not apply any of the other
1317 * capabilities that were also requested).
1319 error_propagate(errp, local_err);
1322 qmp_caps_apply(cur_mon, enable);
1325 cur_mon->qmp.commands = &qmp_commands;
1328 /* Set the current CPU defined by the user. Callers must hold BQL. */
1329 int monitor_set_cpu(int cpu_index)
1333 cpu = qemu_get_cpu(cpu_index);
1337 g_free(cur_mon->mon_cpu_path);
1338 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1342 /* Callers must hold BQL. */
1343 static CPUState *mon_get_cpu_sync(bool synchronize)
1347 if (cur_mon->mon_cpu_path) {
1348 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1351 g_free(cur_mon->mon_cpu_path);
1352 cur_mon->mon_cpu_path = NULL;
1355 if (!cur_mon->mon_cpu_path) {
1359 monitor_set_cpu(first_cpu->cpu_index);
1363 cpu_synchronize_state(cpu);
1368 CPUState *mon_get_cpu(void)
1370 return mon_get_cpu_sync(true);
1373 CPUArchState *mon_get_cpu_env(void)
1375 CPUState *cs = mon_get_cpu();
1377 return cs ? cs->env_ptr : NULL;
1380 int monitor_get_cpu_index(void)
1382 CPUState *cs = mon_get_cpu_sync(false);
1384 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1387 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1389 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1394 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1395 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1401 monitor_printf(mon, "No CPU available\n");
1405 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1410 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1412 if (!tcg_enabled()) {
1413 error_report("JIT information is only available with accel=tcg");
1417 dump_exec_info((FILE *)mon, monitor_fprintf);
1418 dump_drift_info((FILE *)mon, monitor_fprintf);
1421 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1423 dump_opcount_info((FILE *)mon, monitor_fprintf);
1427 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1436 str = readline_get_history(mon->rs, i);
1439 monitor_printf(mon, "%d: '%s'\n", i, str);
1444 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1446 CPUState *cs = mon_get_cpu();
1449 monitor_printf(mon, "No CPU available\n");
1452 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1455 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1457 const char *name = qdict_get_try_str(qdict, "name");
1458 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1459 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1460 TraceEventInfoList *events;
1461 TraceEventInfoList *elem;
1462 Error *local_err = NULL;
1468 monitor_printf(mon, "argument vcpu must be positive");
1472 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1474 error_report_err(local_err);
1478 for (elem = events; elem != NULL; elem = elem->next) {
1479 monitor_printf(mon, "%s : state %u\n",
1481 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1483 qapi_free_TraceEventInfoList(events);
1486 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1487 bool has_port, int64_t port,
1488 bool has_tls_port, int64_t tls_port,
1489 bool has_cert_subject, const char *cert_subject,
1492 if (strcmp(protocol, "spice") == 0) {
1493 if (!qemu_using_spice(errp)) {
1497 if (!has_port && !has_tls_port) {
1498 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1502 if (qemu_spice_migrate_info(hostname,
1503 has_port ? port : -1,
1504 has_tls_port ? tls_port : -1,
1506 error_setg(errp, QERR_UNDEFINED_ERROR);
1512 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1515 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1519 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1521 error_report_err(err);
1525 static void hmp_log(Monitor *mon, const QDict *qdict)
1528 const char *items = qdict_get_str(qdict, "items");
1530 if (!strcmp(items, "none")) {
1533 mask = qemu_str_to_log_mask(items);
1535 help_cmd(mon, "log");
1542 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1544 const char *option = qdict_get_try_str(qdict, "option");
1545 if (!option || !strcmp(option, "on")) {
1547 } else if (!strcmp(option, "off")) {
1550 monitor_printf(mon, "unexpected option %s\n", option);
1554 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1556 const char *device = qdict_get_try_str(qdict, "device");
1558 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1559 if (gdbserver_start(device) < 0) {
1560 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1562 } else if (strcmp(device, "none") == 0) {
1563 monitor_printf(mon, "Disabled gdbserver\n");
1565 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1570 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1572 const char *action = qdict_get_str(qdict, "action");
1573 if (select_watchdog_action(action) == -1) {
1574 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1578 static void monitor_printc(Monitor *mon, int c)
1580 monitor_printf(mon, "'");
1583 monitor_printf(mon, "\\'");
1586 monitor_printf(mon, "\\\\");
1589 monitor_printf(mon, "\\n");
1592 monitor_printf(mon, "\\r");
1595 if (c >= 32 && c <= 126) {
1596 monitor_printf(mon, "%c", c);
1598 monitor_printf(mon, "\\x%02x", c);
1602 monitor_printf(mon, "'");
1605 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1606 hwaddr addr, int is_physical)
1608 int l, line_size, i, max_digits, len;
1611 CPUState *cs = mon_get_cpu();
1613 if (!cs && (format == 'i' || !is_physical)) {
1614 monitor_printf(mon, "Can not dump without CPU\n");
1618 if (format == 'i') {
1619 monitor_disas(mon, cs, addr, count, is_physical);
1623 len = wsize * count;
1632 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1636 max_digits = (wsize * 8) / 4;
1640 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1649 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1651 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1656 cpu_physical_memory_read(addr, buf, l);
1658 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1659 monitor_printf(mon, " Cannot access memory\n");
1668 v = ldub_p(buf + i);
1671 v = lduw_p(buf + i);
1674 v = (uint32_t)ldl_p(buf + i);
1680 monitor_printf(mon, " ");
1683 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1686 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1689 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1692 monitor_printf(mon, "%*" PRId64, max_digits, v);
1695 monitor_printc(mon, v);
1700 monitor_printf(mon, "\n");
1706 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1708 int count = qdict_get_int(qdict, "count");
1709 int format = qdict_get_int(qdict, "format");
1710 int size = qdict_get_int(qdict, "size");
1711 target_long addr = qdict_get_int(qdict, "addr");
1713 memory_dump(mon, count, format, size, addr, 0);
1716 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1718 int count = qdict_get_int(qdict, "count");
1719 int format = qdict_get_int(qdict, "format");
1720 int size = qdict_get_int(qdict, "size");
1721 hwaddr addr = qdict_get_int(qdict, "addr");
1723 memory_dump(mon, count, format, size, addr, 1);
1726 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1728 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1732 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1736 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1737 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1738 memory_region_unref(mrs.mr);
1743 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1746 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1748 hwaddr addr = qdict_get_int(qdict, "addr");
1749 Error *local_err = NULL;
1750 MemoryRegion *mr = NULL;
1753 ptr = gpa2hva(&mr, addr, &local_err);
1755 error_report_err(local_err);
1759 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1761 addr, mr->name, ptr);
1763 memory_region_unref(mr);
1767 static uint64_t vtop(void *ptr, Error **errp)
1771 uintptr_t addr = (uintptr_t) ptr;
1772 uintptr_t pagesize = getpagesize();
1773 off_t offset = addr / pagesize * sizeof(pinfo);
1776 fd = open("/proc/self/pagemap", O_RDONLY);
1778 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1782 /* Force copy-on-write if necessary. */
1783 atomic_add((uint8_t *)ptr, 0);
1785 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1786 error_setg_errno(errp, errno, "Cannot read pagemap");
1789 if ((pinfo & (1ull << 63)) == 0) {
1790 error_setg(errp, "Page not present");
1793 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1800 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1802 hwaddr addr = qdict_get_int(qdict, "addr");
1803 Error *local_err = NULL;
1804 MemoryRegion *mr = NULL;
1808 ptr = gpa2hva(&mr, addr, &local_err);
1810 error_report_err(local_err);
1814 physaddr = vtop(ptr, &local_err);
1816 error_report_err(local_err);
1818 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1819 " (%s) is 0x%" PRIx64 "\n",
1820 addr, mr->name, (uint64_t) physaddr);
1823 memory_region_unref(mr);
1827 static void do_print(Monitor *mon, const QDict *qdict)
1829 int format = qdict_get_int(qdict, "format");
1830 hwaddr val = qdict_get_int(qdict, "val");
1834 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1837 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1840 monitor_printf(mon, "%" HWADDR_PRIu, val);
1844 monitor_printf(mon, "%" HWADDR_PRId, val);
1847 monitor_printc(mon, val);
1850 monitor_printf(mon, "\n");
1853 static void hmp_sum(Monitor *mon, const QDict *qdict)
1857 uint32_t start = qdict_get_int(qdict, "start");
1858 uint32_t size = qdict_get_int(qdict, "size");
1861 for(addr = start; addr < (start + size); addr++) {
1862 uint8_t val = address_space_ldub(&address_space_memory, addr,
1863 MEMTXATTRS_UNSPECIFIED, NULL);
1864 /* BSD sum algorithm ('sum' Unix command) */
1865 sum = (sum >> 1) | (sum << 15);
1868 monitor_printf(mon, "%05d\n", sum);
1871 static int mouse_button_state;
1873 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1875 int dx, dy, dz, button;
1876 const char *dx_str = qdict_get_str(qdict, "dx_str");
1877 const char *dy_str = qdict_get_str(qdict, "dy_str");
1878 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1880 dx = strtol(dx_str, NULL, 0);
1881 dy = strtol(dy_str, NULL, 0);
1882 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1883 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1886 dz = strtol(dz_str, NULL, 0);
1888 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1889 qemu_input_queue_btn(NULL, button, true);
1890 qemu_input_event_sync();
1891 qemu_input_queue_btn(NULL, button, false);
1894 qemu_input_event_sync();
1897 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1899 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1900 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1901 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1902 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1904 int button_state = qdict_get_int(qdict, "button_state");
1906 if (mouse_button_state == button_state) {
1909 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1910 qemu_input_event_sync();
1911 mouse_button_state = button_state;
1914 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1916 int size = qdict_get_int(qdict, "size");
1917 int addr = qdict_get_int(qdict, "addr");
1918 int has_index = qdict_haskey(qdict, "index");
1923 int index = qdict_get_int(qdict, "index");
1924 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1932 val = cpu_inb(addr);
1936 val = cpu_inw(addr);
1940 val = cpu_inl(addr);
1944 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1945 suffix, addr, size * 2, val);
1948 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1950 int size = qdict_get_int(qdict, "size");
1951 int addr = qdict_get_int(qdict, "addr");
1952 int val = qdict_get_int(qdict, "val");
1954 addr &= IOPORTS_MASK;
1959 cpu_outb(addr, val);
1962 cpu_outw(addr, val);
1965 cpu_outl(addr, val);
1970 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1972 Error *local_err = NULL;
1973 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1975 qemu_boot_set(bootdevice, &local_err);
1977 error_report_err(local_err);
1979 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1983 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1985 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1986 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
1987 bool owner = qdict_get_try_bool(qdict, "owner", false);
1989 mtree_info((fprintf_function)monitor_printf, mon, flatview, dispatch_tree,
1993 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1996 NumaNodeMem *node_mem;
1997 CpuInfoList *cpu_list, *cpu;
1999 cpu_list = qmp_query_cpus(&error_abort);
2000 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
2002 query_numa_node_mem(node_mem);
2003 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
2004 for (i = 0; i < nb_numa_nodes; i++) {
2005 monitor_printf(mon, "node %d cpus:", i);
2006 for (cpu = cpu_list; cpu; cpu = cpu->next) {
2007 if (cpu->value->has_props && cpu->value->props->has_node_id &&
2008 cpu->value->props->node_id == i) {
2009 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
2012 monitor_printf(mon, "\n");
2013 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
2014 node_mem[i].node_mem >> 20);
2015 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
2016 node_mem[i].node_plugged_mem >> 20);
2018 qapi_free_CpuInfoList(cpu_list);
2022 #ifdef CONFIG_PROFILER
2027 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2029 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
2030 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
2031 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
2032 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
2037 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2039 monitor_printf(mon, "Internal profiler not compiled\n");
2043 /* Capture support */
2044 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
2046 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
2051 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2052 monitor_printf(mon, "[%d]: ", i);
2053 s->ops.info (s->opaque);
2057 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
2060 int n = qdict_get_int(qdict, "n");
2063 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2065 s->ops.destroy (s->opaque);
2066 QLIST_REMOVE (s, entries);
2073 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2075 const char *path = qdict_get_str(qdict, "path");
2076 int has_freq = qdict_haskey(qdict, "freq");
2077 int freq = qdict_get_try_int(qdict, "freq", -1);
2078 int has_bits = qdict_haskey(qdict, "bits");
2079 int bits = qdict_get_try_int(qdict, "bits", -1);
2080 int has_channels = qdict_haskey(qdict, "nchannels");
2081 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2084 s = g_malloc0 (sizeof (*s));
2086 freq = has_freq ? freq : 44100;
2087 bits = has_bits ? bits : 16;
2088 nchannels = has_channels ? nchannels : 2;
2090 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2091 monitor_printf(mon, "Failed to add wave capture\n");
2095 QLIST_INSERT_HEAD (&capture_head, s, entries);
2098 static qemu_acl *find_acl(Monitor *mon, const char *name)
2100 qemu_acl *acl = qemu_acl_find(name);
2103 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2108 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2110 const char *aclname = qdict_get_str(qdict, "aclname");
2111 qemu_acl *acl = find_acl(mon, aclname);
2112 qemu_acl_entry *entry;
2116 monitor_printf(mon, "policy: %s\n",
2117 acl->defaultDeny ? "deny" : "allow");
2118 QTAILQ_FOREACH(entry, &acl->entries, next) {
2120 monitor_printf(mon, "%d: %s %s\n", i,
2121 entry->deny ? "deny" : "allow", entry->match);
2126 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2128 const char *aclname = qdict_get_str(qdict, "aclname");
2129 qemu_acl *acl = find_acl(mon, aclname);
2132 qemu_acl_reset(acl);
2133 monitor_printf(mon, "acl: removed all rules\n");
2137 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2139 const char *aclname = qdict_get_str(qdict, "aclname");
2140 const char *policy = qdict_get_str(qdict, "policy");
2141 qemu_acl *acl = find_acl(mon, aclname);
2144 if (strcmp(policy, "allow") == 0) {
2145 acl->defaultDeny = 0;
2146 monitor_printf(mon, "acl: policy set to 'allow'\n");
2147 } else if (strcmp(policy, "deny") == 0) {
2148 acl->defaultDeny = 1;
2149 monitor_printf(mon, "acl: policy set to 'deny'\n");
2151 monitor_printf(mon, "acl: unknown policy '%s', "
2152 "expected 'deny' or 'allow'\n", policy);
2157 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2159 const char *aclname = qdict_get_str(qdict, "aclname");
2160 const char *match = qdict_get_str(qdict, "match");
2161 const char *policy = qdict_get_str(qdict, "policy");
2162 int has_index = qdict_haskey(qdict, "index");
2163 int index = qdict_get_try_int(qdict, "index", -1);
2164 qemu_acl *acl = find_acl(mon, aclname);
2168 if (strcmp(policy, "allow") == 0) {
2170 } else if (strcmp(policy, "deny") == 0) {
2173 monitor_printf(mon, "acl: unknown policy '%s', "
2174 "expected 'deny' or 'allow'\n", policy);
2178 ret = qemu_acl_insert(acl, deny, match, index);
2180 ret = qemu_acl_append(acl, deny, match);
2182 monitor_printf(mon, "acl: unable to add acl entry\n");
2184 monitor_printf(mon, "acl: added rule at position %d\n", ret);
2188 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2190 const char *aclname = qdict_get_str(qdict, "aclname");
2191 const char *match = qdict_get_str(qdict, "match");
2192 qemu_acl *acl = find_acl(mon, aclname);
2196 ret = qemu_acl_remove(acl, match);
2198 monitor_printf(mon, "acl: no matching acl entry\n");
2200 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
2204 void qmp_getfd(const char *fdname, Error **errp)
2209 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2211 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2215 if (qemu_isdigit(fdname[0])) {
2217 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2218 "a name not starting with a digit");
2222 qemu_mutex_lock(&cur_mon->mon_lock);
2223 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2224 if (strcmp(monfd->name, fdname) != 0) {
2230 qemu_mutex_unlock(&cur_mon->mon_lock);
2231 /* Make sure close() is out of critical section */
2236 monfd = g_malloc0(sizeof(mon_fd_t));
2237 monfd->name = g_strdup(fdname);
2240 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2241 qemu_mutex_unlock(&cur_mon->mon_lock);
2244 void qmp_closefd(const char *fdname, Error **errp)
2249 qemu_mutex_lock(&cur_mon->mon_lock);
2250 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2251 if (strcmp(monfd->name, fdname) != 0) {
2255 QLIST_REMOVE(monfd, next);
2257 g_free(monfd->name);
2259 qemu_mutex_unlock(&cur_mon->mon_lock);
2260 /* Make sure close() is out of critical section */
2265 qemu_mutex_unlock(&cur_mon->mon_lock);
2266 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2269 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2273 qemu_mutex_lock(&mon->mon_lock);
2274 QLIST_FOREACH(monfd, &mon->fds, next) {
2277 if (strcmp(monfd->name, fdname) != 0) {
2283 /* caller takes ownership of fd */
2284 QLIST_REMOVE(monfd, next);
2285 g_free(monfd->name);
2287 qemu_mutex_unlock(&mon->mon_lock);
2292 qemu_mutex_unlock(&mon->mon_lock);
2293 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2297 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2299 MonFdsetFd *mon_fdset_fd;
2300 MonFdsetFd *mon_fdset_fd_next;
2302 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2303 if ((mon_fdset_fd->removed ||
2304 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2305 runstate_is_running()) {
2306 close(mon_fdset_fd->fd);
2307 g_free(mon_fdset_fd->opaque);
2308 QLIST_REMOVE(mon_fdset_fd, next);
2309 g_free(mon_fdset_fd);
2313 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2314 QLIST_REMOVE(mon_fdset, next);
2319 static void monitor_fdsets_cleanup(void)
2321 MonFdset *mon_fdset;
2322 MonFdset *mon_fdset_next;
2324 qemu_mutex_lock(&mon_fdsets_lock);
2325 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2326 monitor_fdset_cleanup(mon_fdset);
2328 qemu_mutex_unlock(&mon_fdsets_lock);
2331 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2332 const char *opaque, Error **errp)
2335 Monitor *mon = cur_mon;
2338 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2340 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2344 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2345 has_opaque, opaque, errp);
2357 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2359 MonFdset *mon_fdset;
2360 MonFdsetFd *mon_fdset_fd;
2363 qemu_mutex_lock(&mon_fdsets_lock);
2364 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2365 if (mon_fdset->id != fdset_id) {
2368 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2370 if (mon_fdset_fd->fd != fd) {
2373 mon_fdset_fd->removed = true;
2376 mon_fdset_fd->removed = true;
2379 if (has_fd && !mon_fdset_fd) {
2382 monitor_fdset_cleanup(mon_fdset);
2383 qemu_mutex_unlock(&mon_fdsets_lock);
2388 qemu_mutex_unlock(&mon_fdsets_lock);
2390 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2393 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2395 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2398 FdsetInfoList *qmp_query_fdsets(Error **errp)
2400 MonFdset *mon_fdset;
2401 MonFdsetFd *mon_fdset_fd;
2402 FdsetInfoList *fdset_list = NULL;
2404 qemu_mutex_lock(&mon_fdsets_lock);
2405 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2406 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2407 FdsetFdInfoList *fdsetfd_list = NULL;
2409 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2410 fdset_info->value->fdset_id = mon_fdset->id;
2412 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2413 FdsetFdInfoList *fdsetfd_info;
2415 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2416 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2417 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2418 if (mon_fdset_fd->opaque) {
2419 fdsetfd_info->value->has_opaque = true;
2420 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2422 fdsetfd_info->value->has_opaque = false;
2425 fdsetfd_info->next = fdsetfd_list;
2426 fdsetfd_list = fdsetfd_info;
2429 fdset_info->value->fds = fdsetfd_list;
2431 fdset_info->next = fdset_list;
2432 fdset_list = fdset_info;
2434 qemu_mutex_unlock(&mon_fdsets_lock);
2439 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2440 bool has_opaque, const char *opaque,
2443 MonFdset *mon_fdset = NULL;
2444 MonFdsetFd *mon_fdset_fd;
2447 qemu_mutex_lock(&mon_fdsets_lock);
2449 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2450 /* Break if match found or match impossible due to ordering by ID */
2451 if (fdset_id <= mon_fdset->id) {
2452 if (fdset_id < mon_fdset->id) {
2460 if (mon_fdset == NULL) {
2461 int64_t fdset_id_prev = -1;
2462 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2466 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2467 "a non-negative value");
2468 qemu_mutex_unlock(&mon_fdsets_lock);
2471 /* Use specified fdset ID */
2472 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2473 mon_fdset_cur = mon_fdset;
2474 if (fdset_id < mon_fdset_cur->id) {
2479 /* Use first available fdset ID */
2480 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2481 mon_fdset_cur = mon_fdset;
2482 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2483 fdset_id_prev = mon_fdset_cur->id;
2490 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2492 mon_fdset->id = fdset_id;
2494 mon_fdset->id = fdset_id_prev + 1;
2497 /* The fdset list is ordered by fdset ID */
2498 if (!mon_fdset_cur) {
2499 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2500 } else if (mon_fdset->id < mon_fdset_cur->id) {
2501 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2503 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2507 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2508 mon_fdset_fd->fd = fd;
2509 mon_fdset_fd->removed = false;
2511 mon_fdset_fd->opaque = g_strdup(opaque);
2513 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2515 fdinfo = g_malloc0(sizeof(*fdinfo));
2516 fdinfo->fdset_id = mon_fdset->id;
2517 fdinfo->fd = mon_fdset_fd->fd;
2519 qemu_mutex_unlock(&mon_fdsets_lock);
2523 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2528 MonFdset *mon_fdset;
2529 MonFdsetFd *mon_fdset_fd;
2533 qemu_mutex_lock(&mon_fdsets_lock);
2534 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2535 if (mon_fdset->id != fdset_id) {
2538 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2539 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2540 if (mon_fd_flags == -1) {
2545 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2546 ret = mon_fdset_fd->fd;
2556 qemu_mutex_unlock(&mon_fdsets_lock);
2561 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2563 MonFdset *mon_fdset;
2564 MonFdsetFd *mon_fdset_fd_dup;
2566 qemu_mutex_lock(&mon_fdsets_lock);
2567 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2568 if (mon_fdset->id != fdset_id) {
2571 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2572 if (mon_fdset_fd_dup->fd == dup_fd) {
2576 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2577 mon_fdset_fd_dup->fd = dup_fd;
2578 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2579 qemu_mutex_unlock(&mon_fdsets_lock);
2584 qemu_mutex_unlock(&mon_fdsets_lock);
2588 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2590 MonFdset *mon_fdset;
2591 MonFdsetFd *mon_fdset_fd_dup;
2593 qemu_mutex_lock(&mon_fdsets_lock);
2594 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2595 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2596 if (mon_fdset_fd_dup->fd == dup_fd) {
2598 QLIST_REMOVE(mon_fdset_fd_dup, next);
2599 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2600 monitor_fdset_cleanup(mon_fdset);
2604 qemu_mutex_unlock(&mon_fdsets_lock);
2605 return mon_fdset->id;
2612 qemu_mutex_unlock(&mon_fdsets_lock);
2616 int monitor_fdset_dup_fd_find(int dup_fd)
2618 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2621 void monitor_fdset_dup_fd_remove(int dup_fd)
2623 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2626 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2629 Error *local_err = NULL;
2631 if (!qemu_isdigit(fdname[0]) && mon) {
2632 fd = monitor_get_fd(mon, fdname, &local_err);
2634 fd = qemu_parse_fd(fdname);
2636 error_setg(&local_err, "Invalid file descriptor number '%s'",
2641 error_propagate(errp, local_err);
2650 /* Please update hmp-commands.hx when adding or changing commands */
2651 static mon_cmd_t info_cmds[] = {
2652 #include "hmp-commands-info.h"
2656 /* mon_cmds and info_cmds would be sorted at runtime */
2657 static mon_cmd_t mon_cmds[] = {
2658 #include "hmp-commands.h"
2662 /*******************************************************************/
2664 static const char *pch;
2665 static sigjmp_buf expr_env;
2668 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2669 expr_error(Monitor *mon, const char *fmt, ...)
2673 monitor_vprintf(mon, fmt, ap);
2674 monitor_printf(mon, "\n");
2676 siglongjmp(expr_env, 1);
2679 /* return 0 if OK, -1 if not found */
2680 static int get_monitor_def(target_long *pval, const char *name)
2682 const MonitorDef *md = target_monitor_defs();
2683 CPUState *cs = mon_get_cpu();
2688 if (cs == NULL || md == NULL) {
2692 for(; md->name != NULL; md++) {
2693 if (compare_cmd(name, md->name)) {
2694 if (md->get_value) {
2695 *pval = md->get_value(md, md->offset);
2697 CPUArchState *env = mon_get_cpu_env();
2698 ptr = (uint8_t *)env + md->offset;
2701 *pval = *(int32_t *)ptr;
2704 *pval = *(target_long *)ptr;
2715 ret = target_get_monitor_def(cs, name, &tmp);
2717 *pval = (target_long) tmp;
2723 static void next(void)
2727 while (qemu_isspace(*pch))
2732 static int64_t expr_sum(Monitor *mon);
2734 static int64_t expr_unary(Monitor *mon)
2743 n = expr_unary(mon);
2747 n = -expr_unary(mon);
2751 n = ~expr_unary(mon);
2757 expr_error(mon, "')' expected");
2764 expr_error(mon, "character constant expected");
2768 expr_error(mon, "missing terminating \' character");
2778 while ((*pch >= 'a' && *pch <= 'z') ||
2779 (*pch >= 'A' && *pch <= 'Z') ||
2780 (*pch >= '0' && *pch <= '9') ||
2781 *pch == '_' || *pch == '.') {
2782 if ((q - buf) < sizeof(buf) - 1)
2786 while (qemu_isspace(*pch))
2789 ret = get_monitor_def(®, buf);
2791 expr_error(mon, "unknown register");
2796 expr_error(mon, "unexpected end of expression");
2801 n = strtoull(pch, &p, 0);
2802 if (errno == ERANGE) {
2803 expr_error(mon, "number too large");
2806 expr_error(mon, "invalid char '%c' in expression", *p);
2809 while (qemu_isspace(*pch))
2817 static int64_t expr_prod(Monitor *mon)
2822 val = expr_unary(mon);
2825 if (op != '*' && op != '/' && op != '%')
2828 val2 = expr_unary(mon);
2837 expr_error(mon, "division by zero");
2848 static int64_t expr_logic(Monitor *mon)
2853 val = expr_prod(mon);
2856 if (op != '&' && op != '|' && op != '^')
2859 val2 = expr_prod(mon);
2876 static int64_t expr_sum(Monitor *mon)
2881 val = expr_logic(mon);
2884 if (op != '+' && op != '-')
2887 val2 = expr_logic(mon);
2896 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2899 if (sigsetjmp(expr_env, 0)) {
2903 while (qemu_isspace(*pch))
2905 *pval = expr_sum(mon);
2910 static int get_double(Monitor *mon, double *pval, const char **pp)
2912 const char *p = *pp;
2916 d = strtod(p, &tailp);
2918 monitor_printf(mon, "Number expected\n");
2921 if (d != d || d - d != 0) {
2922 /* NaN or infinity */
2923 monitor_printf(mon, "Bad number\n");
2932 * Store the command-name in cmdname, and return a pointer to
2933 * the remaining of the command string.
2935 static const char *get_command_name(const char *cmdline,
2936 char *cmdname, size_t nlen)
2939 const char *p, *pstart;
2942 while (qemu_isspace(*p))
2947 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2952 memcpy(cmdname, pstart, len);
2953 cmdname[len] = '\0';
2958 * Read key of 'type' into 'key' and return the current
2961 static char *key_get_info(const char *type, char **key)
2969 p = strchr(type, ':');
2976 str = g_malloc(len + 1);
2977 memcpy(str, type, len);
2984 static int default_fmt_format = 'x';
2985 static int default_fmt_size = 4;
2987 static int is_valid_option(const char *c, const char *typestr)
2995 typestr = strstr(typestr, option);
2996 return (typestr != NULL);
2999 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
3000 const char *cmdname)
3002 const mon_cmd_t *cmd;
3004 for (cmd = disp_table; cmd->name != NULL; cmd++) {
3005 if (compare_cmd(cmdname, cmd->name)) {
3014 * Parse command name from @cmdp according to command table @table.
3015 * If blank, return NULL.
3016 * Else, if no valid command can be found, report to @mon, and return
3018 * Else, change @cmdp to point right behind the name, and return its
3019 * command table entry.
3020 * Do not assume the return value points into @table! It doesn't when
3021 * the command is found in a sub-command table.
3023 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
3024 const char *cmdp_start,
3029 const mon_cmd_t *cmd;
3032 /* extract the command name */
3033 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
3037 cmd = search_dispatch_table(table, cmdname);
3039 monitor_printf(mon, "unknown command: '%.*s'\n",
3040 (int)(p - cmdp_start), cmdp_start);
3043 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
3044 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
3045 "until after exit_preconfig.\n",
3046 (int)(p - cmdp_start), cmdp_start);
3050 /* filter out following useless space */
3051 while (qemu_isspace(*p)) {
3056 /* search sub command */
3057 if (cmd->sub_table != NULL && *p != '\0') {
3058 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3065 * Parse arguments for @cmd.
3066 * If it can't be parsed, report to @mon, and return NULL.
3067 * Else, insert command arguments into a QDict, and return it.
3068 * Note: On success, caller has to free the QDict structure.
3071 static QDict *monitor_parse_arguments(Monitor *mon,
3073 const mon_cmd_t *cmd)
3075 const char *typestr;
3078 const char *p = *endp;
3080 QDict *qdict = qdict_new();
3082 /* parse the parameters */
3083 typestr = cmd->args_type;
3085 typestr = key_get_info(typestr, &key);
3097 while (qemu_isspace(*p))
3099 if (*typestr == '?') {
3102 /* no optional string: NULL argument */
3106 ret = get_str(buf, sizeof(buf), &p);
3110 monitor_printf(mon, "%s: filename expected\n",
3114 monitor_printf(mon, "%s: block device name expected\n",
3118 monitor_printf(mon, "%s: string expected\n", cmd->name);
3123 qdict_put_str(qdict, key, buf);
3128 QemuOptsList *opts_list;
3131 opts_list = qemu_find_opts(key);
3132 if (!opts_list || opts_list->desc->name) {
3135 while (qemu_isspace(*p)) {
3140 if (get_str(buf, sizeof(buf), &p) < 0) {
3143 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3147 qemu_opts_to_qdict(opts, qdict);
3148 qemu_opts_del(opts);
3153 int count, format, size;
3155 while (qemu_isspace(*p))
3161 if (qemu_isdigit(*p)) {
3163 while (qemu_isdigit(*p)) {
3164 count = count * 10 + (*p - '0');
3202 if (*p != '\0' && !qemu_isspace(*p)) {
3203 monitor_printf(mon, "invalid char in format: '%c'\n",
3208 format = default_fmt_format;
3209 if (format != 'i') {
3210 /* for 'i', not specifying a size gives -1 as size */
3212 size = default_fmt_size;
3213 default_fmt_size = size;
3215 default_fmt_format = format;
3218 format = default_fmt_format;
3219 if (format != 'i') {
3220 size = default_fmt_size;
3225 qdict_put_int(qdict, "count", count);
3226 qdict_put_int(qdict, "format", format);
3227 qdict_put_int(qdict, "size", size);
3236 while (qemu_isspace(*p))
3238 if (*typestr == '?' || *typestr == '.') {
3239 if (*typestr == '?') {
3247 while (qemu_isspace(*p))
3256 if (get_expr(mon, &val, &p))
3258 /* Check if 'i' is greater than 32-bit */
3259 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3260 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3261 monitor_printf(mon, "integer is for 32-bit values\n");
3263 } else if (c == 'M') {
3265 monitor_printf(mon, "enter a positive value\n");
3270 qdict_put_int(qdict, key, val);
3279 while (qemu_isspace(*p)) {
3282 if (*typestr == '?') {
3288 ret = qemu_strtosz_MiB(p, &end, &val);
3289 if (ret < 0 || val > INT64_MAX) {
3290 monitor_printf(mon, "invalid size\n");
3293 qdict_put_int(qdict, key, val);
3301 while (qemu_isspace(*p))
3303 if (*typestr == '?') {
3309 if (get_double(mon, &val, &p) < 0) {
3312 if (p[0] && p[1] == 's') {
3315 val /= 1e3; p += 2; break;
3317 val /= 1e6; p += 2; break;
3319 val /= 1e9; p += 2; break;
3322 if (*p && !qemu_isspace(*p)) {
3323 monitor_printf(mon, "Unknown unit suffix\n");
3326 qdict_put(qdict, key, qnum_from_double(val));
3334 while (qemu_isspace(*p)) {
3338 while (qemu_isgraph(*p)) {
3341 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3343 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3346 monitor_printf(mon, "Expected 'on' or 'off'\n");
3349 qdict_put_bool(qdict, key, val);
3354 const char *tmp = p;
3361 while (qemu_isspace(*p))
3366 if(!is_valid_option(p, typestr)) {
3368 monitor_printf(mon, "%s: unsupported option -%c\n",
3380 qdict_put_bool(qdict, key, true);
3387 /* package all remaining string */
3390 while (qemu_isspace(*p)) {
3393 if (*typestr == '?') {
3396 /* no remaining string: NULL argument */
3402 monitor_printf(mon, "%s: string expected\n",
3406 qdict_put_str(qdict, key, p);
3412 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3418 /* check that all arguments were parsed */
3419 while (qemu_isspace(*p))
3422 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3430 qobject_unref(qdict);
3435 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3438 const mon_cmd_t *cmd;
3439 const char *cmd_start = cmdline;
3441 trace_handle_hmp_command(mon, cmdline);
3443 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3448 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3450 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3453 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3454 (int)(cmdline - cmd_start), cmd_start);
3458 cmd->cmd(mon, qdict);
3459 qobject_unref(qdict);
3462 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3464 const char *p, *pstart;
3471 p = qemu_strchrnul(p, '|');
3473 if (len > sizeof(cmd) - 2)
3474 len = sizeof(cmd) - 2;
3475 memcpy(cmd, pstart, len);
3477 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3478 readline_add_completion(mon->rs, cmd);
3486 static void file_completion(Monitor *mon, const char *input)
3491 char file[1024], file_prefix[1024];
3495 p = strrchr(input, '/');
3498 pstrcpy(file_prefix, sizeof(file_prefix), input);
3499 pstrcpy(path, sizeof(path), ".");
3501 input_path_len = p - input + 1;
3502 memcpy(path, input, input_path_len);
3503 if (input_path_len > sizeof(path) - 1)
3504 input_path_len = sizeof(path) - 1;
3505 path[input_path_len] = '\0';
3506 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3509 ffs = opendir(path);
3518 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3522 if (strstart(d->d_name, file_prefix, NULL)) {
3523 memcpy(file, input, input_path_len);
3524 if (input_path_len < sizeof(file))
3525 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3527 /* stat the file to find out if it's a directory.
3528 * In that case add a slash to speed up typing long paths
3530 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3531 pstrcat(file, sizeof(file), "/");
3533 readline_add_completion(mon->rs, file);
3539 static const char *next_arg_type(const char *typestr)
3541 const char *p = strchr(typestr, ':');
3542 return (p != NULL ? ++p : typestr);
3545 static void add_completion_option(ReadLineState *rs, const char *str,
3548 if (!str || !option) {
3551 if (!strncmp(option, str, strlen(str))) {
3552 readline_add_completion(rs, option);
3556 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3559 ChardevBackendInfoList *list, *start;
3565 readline_set_completion_index(rs, len);
3567 start = list = qmp_query_chardev_backends(NULL);
3569 const char *chr_name = list->value->name;
3571 if (!strncmp(chr_name, str, len)) {
3572 readline_add_completion(rs, chr_name);
3576 qapi_free_ChardevBackendInfoList(start);
3579 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3588 readline_set_completion_index(rs, len);
3589 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3590 add_completion_option(rs, str, NetClientDriver_str(i));
3594 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3604 readline_set_completion_index(rs, len);
3605 list = elt = object_class_get_list(TYPE_DEVICE, false);
3608 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3610 name = object_class_get_name(OBJECT_CLASS(dc));
3612 if (dc->user_creatable
3613 && !strncmp(name, str, len)) {
3614 readline_add_completion(rs, name);
3621 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3631 readline_set_completion_index(rs, len);
3632 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3636 name = object_class_get_name(OBJECT_CLASS(elt->data));
3637 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3638 readline_add_completion(rs, name);
3645 static void peripheral_device_del_completion(ReadLineState *rs,
3646 const char *str, size_t len)
3648 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3649 GSList *list, *item;
3651 list = qdev_build_hotpluggable_device_list(peripheral);
3656 for (item = list; item; item = g_slist_next(item)) {
3657 DeviceState *dev = item->data;
3659 if (dev->id && !strncmp(str, dev->id, len)) {
3660 readline_add_completion(rs, dev->id);
3667 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3670 ChardevInfoList *list, *start;
3676 readline_set_completion_index(rs, len);
3678 start = list = qmp_query_chardev(NULL);
3680 ChardevInfo *chr = list->value;
3682 if (!strncmp(chr->label, str, len)) {
3683 readline_add_completion(rs, chr->label);
3687 qapi_free_ChardevInfoList(start);
3690 static void ringbuf_completion(ReadLineState *rs, const char *str)
3693 ChardevInfoList *list, *start;
3696 readline_set_completion_index(rs, len);
3698 start = list = qmp_query_chardev(NULL);
3700 ChardevInfo *chr_info = list->value;
3702 if (!strncmp(chr_info->label, str, len)) {
3703 Chardev *chr = qemu_chr_find(chr_info->label);
3704 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3705 readline_add_completion(rs, chr_info->label);
3710 qapi_free_ChardevInfoList(start);
3713 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3718 ringbuf_completion(rs, str);
3721 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3730 readline_set_completion_index(rs, len);
3731 peripheral_device_del_completion(rs, str, len);
3734 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3736 ObjectPropertyInfoList *list, *start;
3743 readline_set_completion_index(rs, len);
3745 start = list = qmp_qom_list("/objects", NULL);
3747 ObjectPropertyInfo *info = list->value;
3749 if (!strncmp(info->type, "child<", 5)
3750 && !strncmp(info->name, str, len)) {
3751 readline_add_completion(rs, info->name);
3755 qapi_free_ObjectPropertyInfoList(start);
3758 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3767 sep = strrchr(str, '-');
3772 readline_set_completion_index(rs, len);
3773 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3774 if (!strncmp(str, QKeyCode_str(i), len)) {
3775 readline_add_completion(rs, QKeyCode_str(i));
3780 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3785 readline_set_completion_index(rs, len);
3787 NetClientState *ncs[MAX_QUEUE_NUM];
3789 count = qemu_find_net_clients_except(NULL, ncs,
3790 NET_CLIENT_DRIVER_NONE,
3792 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3793 const char *name = ncs[i]->name;
3794 if (!strncmp(str, name, len)) {
3795 readline_add_completion(rs, name);
3798 } else if (nb_args == 3) {
3799 add_completion_option(rs, str, "on");
3800 add_completion_option(rs, str, "off");
3804 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3807 NetClientState *ncs[MAX_QUEUE_NUM];
3814 readline_set_completion_index(rs, len);
3815 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3817 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3819 const char *name = ncs[i]->name;
3820 if (strncmp(str, name, len)) {
3823 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3825 readline_add_completion(rs, name);
3830 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3835 readline_set_completion_index(rs, len);
3837 TraceEventIter iter;
3839 char *pattern = g_strdup_printf("%s*", str);
3840 trace_event_iter_init(&iter, pattern);
3841 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3842 readline_add_completion(rs, trace_event_get_name(ev));
3848 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3853 readline_set_completion_index(rs, len);
3855 TraceEventIter iter;
3857 char *pattern = g_strdup_printf("%s*", str);
3858 trace_event_iter_init(&iter, pattern);
3859 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3860 readline_add_completion(rs, trace_event_get_name(ev));
3863 } else if (nb_args == 3) {
3864 add_completion_option(rs, str, "on");
3865 add_completion_option(rs, str, "off");
3869 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3876 readline_set_completion_index(rs, strlen(str));
3877 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3878 add_completion_option(rs, str, WatchdogAction_str(i));
3882 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3888 readline_set_completion_index(rs, len);
3891 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3892 const char *name = MigrationCapability_str(i);
3893 if (!strncmp(str, name, len)) {
3894 readline_add_completion(rs, name);
3897 } else if (nb_args == 3) {
3898 add_completion_option(rs, str, "on");
3899 add_completion_option(rs, str, "off");
3903 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3909 readline_set_completion_index(rs, len);
3912 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3913 const char *name = MigrationParameter_str(i);
3914 if (!strncmp(str, name, len)) {
3915 readline_add_completion(rs, name);
3921 static void vm_completion(ReadLineState *rs, const char *str)
3924 BlockDriverState *bs;
3925 BdrvNextIterator it;
3928 readline_set_completion_index(rs, len);
3930 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3931 SnapshotInfoList *snapshots, *snapshot;
3932 AioContext *ctx = bdrv_get_aio_context(bs);
3935 aio_context_acquire(ctx);
3936 if (bdrv_can_snapshot(bs)) {
3937 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3939 aio_context_release(ctx);
3944 snapshot = snapshots;
3946 char *completion = snapshot->value->name;
3947 if (!strncmp(str, completion, len)) {
3948 readline_add_completion(rs, completion);
3950 completion = snapshot->value->id;
3951 if (!strncmp(str, completion, len)) {
3952 readline_add_completion(rs, completion);
3954 snapshot = snapshot->next;
3956 qapi_free_SnapshotInfoList(snapshots);
3961 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3964 vm_completion(rs, str);
3968 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3971 vm_completion(rs, str);
3975 static void monitor_find_completion_by_table(Monitor *mon,
3976 const mon_cmd_t *cmd_table,
3980 const char *cmdname;
3982 const char *ptype, *old_ptype, *str, *name;
3983 const mon_cmd_t *cmd;
3984 BlockBackend *blk = NULL;
3987 /* command completion */
3992 readline_set_completion_index(mon->rs, strlen(cmdname));
3993 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3994 if (!runstate_check(RUN_STATE_PRECONFIG) ||
3995 cmd_can_preconfig(cmd)) {
3996 cmd_completion(mon, cmdname, cmd->name);
4000 /* find the command */
4001 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4002 if (compare_cmd(args[0], cmd->name) &&
4003 (!runstate_check(RUN_STATE_PRECONFIG) ||
4004 cmd_can_preconfig(cmd))) {
4012 if (cmd->sub_table) {
4013 /* do the job again */
4014 monitor_find_completion_by_table(mon, cmd->sub_table,
4015 &args[1], nb_args - 1);
4018 if (cmd->command_completion) {
4019 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
4023 ptype = next_arg_type(cmd->args_type);
4024 for(i = 0; i < nb_args - 2; i++) {
4025 if (*ptype != '\0') {
4026 ptype = next_arg_type(ptype);
4027 while (*ptype == '?')
4028 ptype = next_arg_type(ptype);
4031 str = args[nb_args - 1];
4033 while (*ptype == '-' && old_ptype != ptype) {
4035 ptype = next_arg_type(ptype);
4039 /* file completion */
4040 readline_set_completion_index(mon->rs, strlen(str));
4041 file_completion(mon, str);
4044 /* block device name completion */
4045 readline_set_completion_index(mon->rs, strlen(str));
4046 while ((blk = blk_next(blk)) != NULL) {
4047 name = blk_name(blk);
4048 if (str[0] == '\0' ||
4049 !strncmp(name, str, strlen(str))) {
4050 readline_add_completion(mon->rs, name);
4056 if (!strcmp(cmd->name, "help|?")) {
4057 monitor_find_completion_by_table(mon, cmd_table,
4058 &args[1], nb_args - 1);
4067 static void monitor_find_completion(void *opaque,
4068 const char *cmdline)
4070 Monitor *mon = opaque;
4071 char *args[MAX_ARGS];
4074 /* 1. parse the cmdline */
4075 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4079 /* if the line ends with a space, it means we want to complete the
4081 len = strlen(cmdline);
4082 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4083 if (nb_args >= MAX_ARGS) {
4086 args[nb_args++] = g_strdup("");
4089 /* 2. auto complete according to args */
4090 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4093 free_cmdline_args(args, nb_args);
4096 static int monitor_can_read(void *opaque)
4098 Monitor *mon = opaque;
4100 return !atomic_mb_read(&mon->suspend_cnt);
4104 * 1. This function takes ownership of rsp, err, and id.
4105 * 2. rsp, err, and id may be NULL.
4106 * 3. If err != NULL then rsp must be NULL.
4108 static void monitor_qmp_respond(Monitor *mon, QObject *rsp,
4109 Error *err, QObject *id)
4111 QDict *qdict = NULL;
4115 qdict = qdict_new();
4116 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
4118 rsp = QOBJECT(qdict);
4123 qdict_put_obj(qobject_to(QDict, rsp), "id", qobject_ref(id));
4126 monitor_json_emitter(mon, rsp);
4133 static void monitor_qmp_dispatch(Monitor *mon, QObject *req, QObject *id)
4142 rsp = qmp_dispatch(mon->qmp.commands, req, qmp_oob_enabled(mon));
4146 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
4147 error = qdict_get_qdict(qobject_to(QDict, rsp), "error");
4149 && !g_strcmp0(qdict_get_try_str(error, "class"),
4150 QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
4151 /* Provide a more useful error message */
4152 qdict_del(error, "desc");
4153 qdict_put_str(error, "desc", "Expecting capabilities negotiation"
4154 " with 'qmp_capabilities'");
4158 /* Respond if necessary */
4159 monitor_qmp_respond(mon, rsp, NULL, qobject_ref(id));
4163 * Pop one QMP request from monitor queues, return NULL if not found.
4164 * We are using round-robin fashion to pop the request, to avoid
4165 * processing commands only on a very busy monitor. To achieve that,
4166 * when we process one request on a specific monitor, we put that
4167 * monitor to the end of mon_list queue.
4169 static QMPRequest *monitor_qmp_requests_pop_any(void)
4171 QMPRequest *req_obj = NULL;
4174 qemu_mutex_lock(&monitor_lock);
4176 QTAILQ_FOREACH(mon, &mon_list, entry) {
4177 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4178 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4179 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4187 * We found one request on the monitor. Degrade this monitor's
4188 * priority to lowest by re-inserting it to end of queue.
4190 QTAILQ_REMOVE(&mon_list, mon, entry);
4191 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4194 qemu_mutex_unlock(&monitor_lock);
4199 static void monitor_qmp_bh_dispatcher(void *data)
4201 QMPRequest *req_obj = monitor_qmp_requests_pop_any();
4208 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(req_obj->id) ?: "");
4209 monitor_qmp_dispatch(req_obj->mon, req_obj->req, req_obj->id);
4211 assert(req_obj->err);
4212 monitor_qmp_respond(req_obj->mon, NULL, req_obj->err, NULL);
4215 if (req_obj->need_resume) {
4216 /* Pairs with the monitor_suspend() in handle_qmp_command() */
4217 monitor_resume(req_obj->mon);
4219 qmp_request_free(req_obj);
4221 /* Reschedule instead of looping so the main loop stays responsive */
4222 qemu_bh_schedule(mon_global.qmp_dispatcher_bh);
4225 #define QMP_REQ_QUEUE_LEN_MAX (8)
4227 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
4229 QObject *req, *id = NULL;
4231 MonitorQMP *mon_qmp = container_of(parser, MonitorQMP, parser);
4232 Monitor *mon = container_of(mon_qmp, Monitor, qmp);
4234 QMPRequest *req_obj;
4236 req = json_parser_parse_err(tokens, NULL, &err);
4238 /* json_parser_parse_err() sucks: can fail without setting @err */
4239 error_setg(&err, QERR_JSON_PARSING);
4242 qdict = qobject_to(QDict, req);
4244 id = qobject_ref(qdict_get(qdict, "id"));
4245 qdict_del(qdict, "id");
4246 } /* else will fail qmp_dispatch() */
4248 if (trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4249 QString *req_json = qobject_to_json(req);
4250 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4251 qobject_unref(req_json);
4254 if (qdict && qmp_is_oob(qdict)) {
4255 /* Out-of-band (OOB) requests are executed directly in parser. */
4256 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id)
4258 monitor_qmp_dispatch(mon, req, id);
4262 req_obj = g_new0(QMPRequest, 1);
4267 req_obj->need_resume = false;
4269 /* Protect qmp_requests and fetching its length. */
4270 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4273 * If OOB is not enabled on the current monitor, we'll emulate the
4274 * old behavior that we won't process the current monitor any more
4275 * until it has responded. This helps make sure that as long as
4276 * OOB is not enabled, the server will never drop any command.
4278 if (!qmp_oob_enabled(mon)) {
4279 monitor_suspend(mon);
4280 req_obj->need_resume = true;
4282 /* Drop the request if queue is full. */
4283 if (mon->qmp.qmp_requests->length >= QMP_REQ_QUEUE_LEN_MAX) {
4284 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4286 * FIXME @id's scope is just @mon, and broadcasting it is
4287 * wrong. If another monitor's client has a command with
4288 * the same ID in flight, the event will incorrectly claim
4289 * that command was dropped.
4291 qapi_event_send_command_dropped(id,
4292 COMMAND_DROP_REASON_QUEUE_FULL,
4294 qmp_request_free(req_obj);
4300 * Put the request to the end of queue so that requests will be
4301 * handled in time order. Ownership for req_obj, req, id,
4302 * etc. will be delivered to the handler side.
4304 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4305 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4307 /* Kick the dispatcher routine */
4308 qemu_bh_schedule(mon_global.qmp_dispatcher_bh);
4311 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4313 Monitor *mon = opaque;
4315 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4318 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4320 Monitor *old_mon = cur_mon;
4326 for (i = 0; i < size; i++)
4327 readline_handle_byte(cur_mon->rs, buf[i]);
4329 if (size == 0 || buf[size - 1] != 0)
4330 monitor_printf(cur_mon, "corrupted command\n");
4332 handle_hmp_command(cur_mon, (char *)buf);
4338 static void monitor_command_cb(void *opaque, const char *cmdline,
4339 void *readline_opaque)
4341 Monitor *mon = opaque;
4343 monitor_suspend(mon);
4344 handle_hmp_command(mon, cmdline);
4345 monitor_resume(mon);
4348 int monitor_suspend(Monitor *mon)
4350 if (monitor_is_hmp_non_interactive(mon)) {
4354 atomic_inc(&mon->suspend_cnt);
4356 if (monitor_is_qmp(mon)) {
4358 * Kick I/O thread to make sure this takes effect. It'll be
4359 * evaluated again in prepare() of the watch object.
4361 aio_notify(iothread_get_aio_context(mon_global.mon_iothread));
4364 trace_monitor_suspend(mon, 1);
4368 void monitor_resume(Monitor *mon)
4370 if (monitor_is_hmp_non_interactive(mon)) {
4374 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4375 if (monitor_is_qmp(mon)) {
4377 * For QMP monitors that are running in I/O thread, let's
4378 * kick the thread in case it's sleeping.
4380 if (mon->use_io_thr) {
4381 aio_notify(iothread_get_aio_context(mon_global.mon_iothread));
4385 readline_show_prompt(mon->rs);
4388 trace_monitor_suspend(mon, -1);
4391 static QObject *get_qmp_greeting(Monitor *mon)
4393 QList *cap_list = qlist_new();
4394 QObject *ver = NULL;
4397 qmp_marshal_query_version(NULL, &ver, NULL);
4399 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4400 if (!mon->use_io_thr && cap == QMP_CAPABILITY_OOB) {
4401 /* Monitors that are not using I/O thread won't support OOB */
4404 qlist_append_str(cap_list, QMPCapability_str(cap));
4407 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': %p}}",
4411 static void monitor_qmp_caps_reset(Monitor *mon)
4413 memset(mon->qmp.qmp_caps, 0, sizeof(mon->qmp.qmp_caps));
4416 static void monitor_qmp_event(void *opaque, int event)
4419 Monitor *mon = opaque;
4422 case CHR_EVENT_OPENED:
4423 mon->qmp.commands = &qmp_cap_negotiation_commands;
4424 monitor_qmp_caps_reset(mon);
4425 data = get_qmp_greeting(mon);
4426 monitor_json_emitter(mon, data);
4427 qobject_unref(data);
4430 case CHR_EVENT_CLOSED:
4432 * Note: this is only useful when the output of the chardev
4433 * backend is still open. For example, when the backend is
4434 * stdio, it's possible that stdout is still open when stdin
4437 monitor_qmp_response_flush(mon);
4438 monitor_qmp_cleanup_queues(mon);
4439 json_message_parser_destroy(&mon->qmp.parser);
4440 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4442 monitor_fdsets_cleanup();
4447 static void monitor_event(void *opaque, int event)
4449 Monitor *mon = opaque;
4452 case CHR_EVENT_MUX_IN:
4453 qemu_mutex_lock(&mon->mon_lock);
4455 qemu_mutex_unlock(&mon->mon_lock);
4456 if (mon->reset_seen) {
4457 readline_restart(mon->rs);
4458 monitor_resume(mon);
4461 atomic_mb_set(&mon->suspend_cnt, 0);
4465 case CHR_EVENT_MUX_OUT:
4466 if (mon->reset_seen) {
4467 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4468 monitor_printf(mon, "\n");
4471 monitor_suspend(mon);
4473 atomic_inc(&mon->suspend_cnt);
4475 qemu_mutex_lock(&mon->mon_lock);
4477 qemu_mutex_unlock(&mon->mon_lock);
4480 case CHR_EVENT_OPENED:
4481 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4482 "information\n", QEMU_VERSION);
4483 if (!mon->mux_out) {
4484 readline_restart(mon->rs);
4485 readline_show_prompt(mon->rs);
4487 mon->reset_seen = 1;
4491 case CHR_EVENT_CLOSED:
4493 monitor_fdsets_cleanup();
4499 compare_mon_cmd(const void *a, const void *b)
4501 return strcmp(((const mon_cmd_t *)a)->name,
4502 ((const mon_cmd_t *)b)->name);
4505 static void sortcmdlist(void)
4508 int elem_size = sizeof(mon_cmd_t);
4510 array_num = sizeof(mon_cmds)/elem_size-1;
4511 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4513 array_num = sizeof(info_cmds)/elem_size-1;
4514 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4517 static GMainContext *monitor_get_io_context(void)
4519 return iothread_get_g_main_context(mon_global.mon_iothread);
4522 static AioContext *monitor_get_aio_context(void)
4524 return iothread_get_aio_context(mon_global.mon_iothread);
4527 static void monitor_iothread_init(void)
4529 mon_global.mon_iothread = iothread_create("mon_iothread",
4533 * This MUST be on main loop thread since we have commands that
4534 * have assumption to be run on main loop thread. It would be
4535 * nice that one day we can remove this assumption in the future.
4537 mon_global.qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4538 monitor_qmp_bh_dispatcher,
4542 * Unlike the dispatcher BH, this must be run on the monitor I/O
4543 * thread, so that monitors that are using I/O thread will make
4544 * sure read/write operations are all done on the I/O thread.
4546 mon_global.qmp_respond_bh = aio_bh_new(monitor_get_aio_context(),
4547 monitor_qmp_bh_responder,
4551 void monitor_init_globals(void)
4553 monitor_init_qmp_commands();
4554 monitor_qapi_event_init();
4556 qemu_mutex_init(&monitor_lock);
4557 qemu_mutex_init(&mon_fdsets_lock);
4558 monitor_iothread_init();
4561 /* These functions just adapt the readline interface in a typesafe way. We
4562 * could cast function pointers but that discards compiler checks.
4564 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4565 const char *fmt, ...)
4569 monitor_vprintf(opaque, fmt, ap);
4573 static void monitor_readline_flush(void *opaque)
4575 monitor_flush(opaque);
4579 * Print to current monitor if we have one, else to stderr.
4580 * TODO should return int, so callers can calculate width, but that
4581 * requires surgery to monitor_vprintf(). Left for another day.
4583 void error_vprintf(const char *fmt, va_list ap)
4585 if (cur_mon && !monitor_cur_is_qmp()) {
4586 monitor_vprintf(cur_mon, fmt, ap);
4588 vfprintf(stderr, fmt, ap);
4592 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4594 if (cur_mon && !monitor_cur_is_qmp()) {
4595 monitor_vprintf(cur_mon, fmt, ap);
4596 } else if (!cur_mon) {
4597 vfprintf(stderr, fmt, ap);
4601 static void monitor_list_append(Monitor *mon)
4603 qemu_mutex_lock(&monitor_lock);
4604 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4605 qemu_mutex_unlock(&monitor_lock);
4608 static void monitor_qmp_setup_handlers_bh(void *opaque)
4610 Monitor *mon = opaque;
4611 GMainContext *context;
4613 if (mon->use_io_thr) {
4615 * When use_io_thr is set, we use the global shared dedicated
4616 * I/O thread for this monitor to handle input/output.
4618 context = monitor_get_io_context();
4619 /* We should have inited globals before reaching here. */
4622 /* The default main loop, which is the main thread */
4626 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4627 monitor_qmp_event, NULL, mon, context, true);
4628 monitor_list_append(mon);
4631 void monitor_init(Chardev *chr, int flags)
4633 Monitor *mon = g_malloc(sizeof(*mon));
4634 bool use_readline = flags & MONITOR_USE_READLINE;
4635 bool use_oob = flags & MONITOR_USE_OOB;
4638 if (CHARDEV_IS_MUX(chr)) {
4639 error_report("Monitor out-of-band is not supported with "
4640 "MUX typed chardev backend");
4644 error_report("Monitor out-of-band is only supported by QMP");
4649 monitor_data_init(mon, false, use_oob);
4651 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4654 mon->rs = readline_init(monitor_readline_printf,
4655 monitor_readline_flush,
4657 monitor_find_completion);
4658 monitor_read_command(mon, 0);
4661 if (monitor_is_qmp(mon)) {
4662 qemu_chr_fe_set_echo(&mon->chr, true);
4663 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4664 if (mon->use_io_thr) {
4666 * Make sure the old iowatch is gone. It's possible when
4667 * e.g. the chardev is in client mode, with wait=on.
4669 remove_fd_in_watch(chr);
4671 * We can't call qemu_chr_fe_set_handlers() directly here
4672 * since during the procedure the chardev will be active
4673 * and running in monitor I/O thread, while we'll still do
4674 * something before returning from it, which is a possible
4675 * race too. To avoid that, we just create a BH to setup
4678 aio_bh_schedule_oneshot(monitor_get_aio_context(),
4679 monitor_qmp_setup_handlers_bh, mon);
4680 /* We'll add this to mon_list in the BH when setup done */
4683 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4684 monitor_qmp_read, monitor_qmp_event,
4685 NULL, mon, NULL, true);
4688 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4689 monitor_event, NULL, mon, NULL, true);
4692 monitor_list_append(mon);
4695 void monitor_cleanup(void)
4697 Monitor *mon, *next;
4700 * We need to explicitly stop the I/O thread (but not destroy it),
4701 * cleanup the monitor resources, then destroy the I/O thread since
4702 * we need to unregister from chardev below in
4703 * monitor_data_destroy(), and chardev is not thread-safe yet
4705 iothread_stop(mon_global.mon_iothread);
4708 * After we have I/O thread to send responses, it's possible that
4709 * when we stop the I/O thread there are still replies queued in the
4710 * responder queue. Flush all of them. Note that even after this
4711 * flush it's still possible that out buffer is not flushed.
4712 * It'll be done in below monitor_flush() as the last resort.
4714 monitor_qmp_bh_responder(NULL);
4716 qemu_mutex_lock(&monitor_lock);
4717 QTAILQ_FOREACH_SAFE(mon, &mon_list, entry, next) {
4718 QTAILQ_REMOVE(&mon_list, mon, entry);
4720 monitor_data_destroy(mon);
4723 qemu_mutex_unlock(&monitor_lock);
4725 /* QEMUBHs needs to be deleted before destroying the I/O thread */
4726 qemu_bh_delete(mon_global.qmp_dispatcher_bh);
4727 mon_global.qmp_dispatcher_bh = NULL;
4728 qemu_bh_delete(mon_global.qmp_respond_bh);
4729 mon_global.qmp_respond_bh = NULL;
4731 iothread_destroy(mon_global.mon_iothread);
4732 mon_global.mon_iothread = NULL;
4735 QemuOptsList qemu_mon_opts = {
4737 .implied_opt_name = "chardev",
4738 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4742 .type = QEMU_OPT_STRING,
4745 .type = QEMU_OPT_STRING,
4748 .type = QEMU_OPT_BOOL,
4751 .type = QEMU_OPT_BOOL,
4753 { /* end of list */ }
4758 void qmp_rtc_reset_reinjection(Error **errp)
4760 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4763 SevInfo *qmp_query_sev(Error **errp)
4765 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev");
4769 SevLaunchMeasureInfo *qmp_query_sev_launch_measure(Error **errp)
4771 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-launch-measure");
4775 SevCapability *qmp_query_sev_capabilities(Error **errp)
4777 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-capabilities");
4782 #ifndef TARGET_S390X
4783 void qmp_dump_skeys(const char *filename, Error **errp)
4785 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4790 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4792 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4797 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4799 MachineState *ms = MACHINE(qdev_get_machine());
4800 MachineClass *mc = MACHINE_GET_CLASS(ms);
4802 if (!mc->has_hotpluggable_cpus) {
4803 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4807 return machine_query_hotpluggable_cpus(ms);