tests/acceptance: fix doc reference to avocado_qemu directory
[qemu/ar7.git] / monitor.c
blobbb48997913b5ea1135197af87278b576c6e46e77
1 /*
2 * QEMU monitor
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
22 * THE SOFTWARE.
25 #include "qemu/osdep.h"
26 #include "qemu/units.h"
27 #include <dirent.h>
28 #include "cpu.h"
29 #include "hw/hw.h"
30 #include "monitor/qdev.h"
31 #include "hw/usb.h"
32 #include "hw/pci/pci.h"
33 #include "sysemu/watchdog.h"
34 #include "hw/loader.h"
35 #include "exec/gdbstub.h"
36 #include "net/net.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"
47 #include "ui/input.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"
54 #include "authz/list.h"
55 #include "qapi/util.h"
56 #include "sysemu/tpm.h"
57 #include "qapi/qmp/qdict.h"
58 #include "qapi/qmp/qerror.h"
59 #include "qapi/qmp/qnum.h"
60 #include "qapi/qmp/qstring.h"
61 #include "qapi/qmp/qjson.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"
70 #endif
71 #include "exec/memory.h"
72 #include "exec/exec-all.h"
73 #include "qemu/log.h"
74 #include "qemu/option.h"
75 #include "hmp.h"
76 #include "qemu/thread.h"
77 #include "block/qapi.h"
78 #include "qapi/qapi-commands.h"
79 #include "qapi/qapi-emit-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"
87 #include "tcg/tcg.h"
89 #if defined(TARGET_S390X)
90 #include "hw/s390x/storage-keys.h"
91 #include "hw/s390x/storage-attributes.h"
92 #endif
95 * Supported types:
97 * 'F' filename
98 * 'B' block device name
99 * 's' string (accept optional quote)
100 * 'S' it just appends the rest of the string (accept optional quote)
101 * 'O' option string of the form NAME=VALUE,...
102 * parsed according to QemuOptsList given by its name
103 * Example: 'device:O' uses qemu_device_opts.
104 * Restriction: only lists with empty desc are supported
105 * TODO lift the restriction
106 * 'i' 32 bit integer
107 * 'l' target long (32 or 64 bit)
108 * 'M' Non-negative target long (32 or 64 bit), in user mode the
109 * value is multiplied by 2^20 (think Mebibyte)
110 * 'o' octets (aka bytes)
111 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
112 * K, k suffix, which multiplies the value by 2^60 for suffixes E
113 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
114 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
115 * 'T' double
116 * user mode accepts an optional ms, us, ns suffix,
117 * which divides the value by 1e3, 1e6, 1e9, respectively
118 * '/' optional gdb-like print format (like "/10x")
120 * '?' optional type (for all types, except '/')
121 * '.' other form of optional type (for 'i' and 'l')
122 * 'b' boolean
123 * user mode accepts "on" or "off"
124 * '-' optional parameter (eg. '-f')
128 typedef struct mon_cmd_t {
129 const char *name;
130 const char *args_type;
131 const char *params;
132 const char *help;
133 const char *flags; /* p=preconfig */
134 void (*cmd)(Monitor *mon, const QDict *qdict);
135 /* @sub_table is a list of 2nd level of commands. If it does not exist,
136 * cmd should be used. If it exists, sub_table[?].cmd should be
137 * used, and cmd of 1st level plays the role of help function.
139 struct mon_cmd_t *sub_table;
140 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
141 } mon_cmd_t;
143 /* file descriptors passed via SCM_RIGHTS */
144 typedef struct mon_fd_t mon_fd_t;
145 struct mon_fd_t {
146 char *name;
147 int fd;
148 QLIST_ENTRY(mon_fd_t) next;
151 /* file descriptor associated with a file descriptor set */
152 typedef struct MonFdsetFd MonFdsetFd;
153 struct MonFdsetFd {
154 int fd;
155 bool removed;
156 char *opaque;
157 QLIST_ENTRY(MonFdsetFd) next;
160 /* file descriptor set containing fds passed via SCM_RIGHTS */
161 typedef struct MonFdset MonFdset;
162 struct MonFdset {
163 int64_t id;
164 QLIST_HEAD(, MonFdsetFd) fds;
165 QLIST_HEAD(, MonFdsetFd) dup_fds;
166 QLIST_ENTRY(MonFdset) next;
169 typedef struct {
170 JSONMessageParser parser;
172 * When a client connects, we're in capabilities negotiation mode.
173 * @commands is &qmp_cap_negotiation_commands then. When command
174 * qmp_capabilities succeeds, we go into command mode, and
175 * @command becomes &qmp_commands.
177 QmpCommandList *commands;
178 bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
179 bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
181 * Protects qmp request/response queue.
182 * Take monitor_lock first when you need both.
184 QemuMutex qmp_queue_lock;
185 /* Input queue that holds all the parsed QMP requests */
186 GQueue *qmp_requests;
187 } MonitorQMP;
190 * To prevent flooding clients, events can be throttled. The
191 * throttling is calculated globally, rather than per-Monitor
192 * instance.
194 typedef struct MonitorQAPIEventState {
195 QAPIEvent event; /* Throttling state for this event type and... */
196 QDict *data; /* ... data, see qapi_event_throttle_equal() */
197 QEMUTimer *timer; /* Timer for handling delayed events */
198 QDict *qdict; /* Delayed event (if any) */
199 } MonitorQAPIEventState;
201 typedef struct {
202 int64_t rate; /* Minimum time (in ns) between two events */
203 } MonitorQAPIEventConf;
205 struct Monitor {
206 CharBackend chr;
207 int reset_seen;
208 int flags;
209 int suspend_cnt; /* Needs to be accessed atomically */
210 bool skip_flush;
211 bool use_io_thread;
214 * State used only in the thread "owning" the monitor.
215 * If @use_io_thread, this is @mon_iothread.
216 * Else, it's the main thread.
217 * These members can be safely accessed without locks.
219 ReadLineState *rs;
221 MonitorQMP qmp;
222 gchar *mon_cpu_path;
223 BlockCompletionFunc *password_completion_cb;
224 void *password_opaque;
225 mon_cmd_t *cmd_table;
226 QTAILQ_ENTRY(Monitor) entry;
229 * The per-monitor lock. We can't access guest memory when holding
230 * the lock.
232 QemuMutex mon_lock;
235 * Members that are protected by the per-monitor lock
237 QLIST_HEAD(, mon_fd_t) fds;
238 QString *outbuf;
239 guint out_watch;
240 /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
241 int mux_out;
244 /* Shared monitor I/O thread */
245 IOThread *mon_iothread;
247 /* Bottom half to dispatch the requests received from I/O thread */
248 QEMUBH *qmp_dispatcher_bh;
250 struct QMPRequest {
251 /* Owner of the request */
252 Monitor *mon;
254 * Request object to be handled or Error to be reported
255 * (exactly one of them is non-null)
257 QObject *req;
258 Error *err;
260 typedef struct QMPRequest QMPRequest;
262 /* QMP checker flags */
263 #define QMP_ACCEPT_UNKNOWNS 1
265 /* Protects mon_list, monitor_qapi_event_state, monitor_destroyed. */
266 static QemuMutex monitor_lock;
267 static GHashTable *monitor_qapi_event_state;
268 static QTAILQ_HEAD(, Monitor) mon_list;
269 static bool monitor_destroyed;
271 /* Protects mon_fdsets */
272 static QemuMutex mon_fdsets_lock;
273 static QLIST_HEAD(, MonFdset) mon_fdsets;
275 static int mon_refcount;
277 static mon_cmd_t mon_cmds[];
278 static mon_cmd_t info_cmds[];
280 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
282 __thread Monitor *cur_mon;
284 static void monitor_command_cb(void *opaque, const char *cmdline,
285 void *readline_opaque);
288 * Is @mon a QMP monitor?
290 static inline bool monitor_is_qmp(const Monitor *mon)
292 return (mon->flags & MONITOR_USE_CONTROL);
296 * Is @mon is using readline?
297 * Note: not all HMP monitors use readline, e.g., gdbserver has a
298 * non-interactive HMP monitor, so readline is not used there.
300 static inline bool monitor_uses_readline(const Monitor *mon)
302 return mon->flags & MONITOR_USE_READLINE;
305 static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
307 return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
311 * Return the clock to use for recording an event's time.
312 * It's QEMU_CLOCK_REALTIME, except for qtests it's
313 * QEMU_CLOCK_VIRTUAL, to support testing rate limits.
314 * Beware: result is invalid before configure_accelerator().
316 static inline QEMUClockType monitor_get_event_clock(void)
318 return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
322 * Is the current monitor, if any, a QMP monitor?
324 bool monitor_cur_is_qmp(void)
326 return cur_mon && monitor_is_qmp(cur_mon);
329 void monitor_read_command(Monitor *mon, int show_prompt)
331 if (!mon->rs)
332 return;
334 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
335 if (show_prompt)
336 readline_show_prompt(mon->rs);
339 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
340 void *opaque)
342 if (mon->rs) {
343 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
344 /* prompt is printed on return from the command handler */
345 return 0;
346 } else {
347 monitor_printf(mon, "terminal does not support password prompting\n");
348 return -ENOTTY;
352 static void qmp_request_free(QMPRequest *req)
354 qobject_unref(req->req);
355 error_free(req->err);
356 g_free(req);
359 /* Caller must hold mon->qmp.qmp_queue_lock */
360 static void monitor_qmp_cleanup_req_queue_locked(Monitor *mon)
362 while (!g_queue_is_empty(mon->qmp.qmp_requests)) {
363 qmp_request_free(g_queue_pop_head(mon->qmp.qmp_requests));
367 static void monitor_qmp_cleanup_queues(Monitor *mon)
369 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
370 monitor_qmp_cleanup_req_queue_locked(mon);
371 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
375 static void monitor_flush_locked(Monitor *mon);
377 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
378 void *opaque)
380 Monitor *mon = opaque;
382 qemu_mutex_lock(&mon->mon_lock);
383 mon->out_watch = 0;
384 monitor_flush_locked(mon);
385 qemu_mutex_unlock(&mon->mon_lock);
386 return FALSE;
389 /* Caller must hold mon->mon_lock */
390 static void monitor_flush_locked(Monitor *mon)
392 int rc;
393 size_t len;
394 const char *buf;
396 if (mon->skip_flush) {
397 return;
400 buf = qstring_get_str(mon->outbuf);
401 len = qstring_get_length(mon->outbuf);
403 if (len && !mon->mux_out) {
404 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
405 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
406 /* all flushed or error */
407 qobject_unref(mon->outbuf);
408 mon->outbuf = qstring_new();
409 return;
411 if (rc > 0) {
412 /* partial write */
413 QString *tmp = qstring_from_str(buf + rc);
414 qobject_unref(mon->outbuf);
415 mon->outbuf = tmp;
417 if (mon->out_watch == 0) {
418 mon->out_watch =
419 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
420 monitor_unblocked, mon);
425 void monitor_flush(Monitor *mon)
427 qemu_mutex_lock(&mon->mon_lock);
428 monitor_flush_locked(mon);
429 qemu_mutex_unlock(&mon->mon_lock);
432 /* flush at every end of line */
433 static int monitor_puts(Monitor *mon, const char *str)
435 int i;
436 char c;
438 qemu_mutex_lock(&mon->mon_lock);
439 for (i = 0; str[i]; i++) {
440 c = str[i];
441 if (c == '\n') {
442 qstring_append_chr(mon->outbuf, '\r');
444 qstring_append_chr(mon->outbuf, c);
445 if (c == '\n') {
446 monitor_flush_locked(mon);
449 qemu_mutex_unlock(&mon->mon_lock);
451 return i;
454 int monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
456 char *buf;
457 int n;
459 if (!mon)
460 return -1;
462 if (monitor_is_qmp(mon)) {
463 return -1;
466 buf = g_strdup_vprintf(fmt, ap);
467 n = monitor_puts(mon, buf);
468 g_free(buf);
469 return n;
472 int monitor_printf(Monitor *mon, const char *fmt, ...)
474 int ret;
476 va_list ap;
477 va_start(ap, fmt);
478 ret = monitor_vprintf(mon, fmt, ap);
479 va_end(ap);
480 return ret;
483 static void qmp_send_response(Monitor *mon, const QDict *rsp)
485 const QObject *data = QOBJECT(rsp);
486 QString *json;
488 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
489 qobject_to_json(data);
490 assert(json != NULL);
492 qstring_append_chr(json, '\n');
493 monitor_puts(mon, qstring_get_str(json));
495 qobject_unref(json);
498 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
499 /* Limit guest-triggerable events to 1 per second */
500 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
501 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
502 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
503 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
504 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
505 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
509 * Broadcast an event to all monitors.
510 * @qdict is the event object. Its member "event" must match @event.
511 * Caller must hold monitor_lock.
513 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
515 Monitor *mon;
517 trace_monitor_protocol_event_emit(event, qdict);
518 QTAILQ_FOREACH(mon, &mon_list, entry) {
519 if (monitor_is_qmp(mon)
520 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
521 qmp_send_response(mon, qdict);
526 static void monitor_qapi_event_handler(void *opaque);
529 * Queue a new event for emission to Monitor instances,
530 * applying any rate limiting if required.
532 static void
533 monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
535 MonitorQAPIEventConf *evconf;
536 MonitorQAPIEventState *evstate;
538 assert(event < QAPI_EVENT__MAX);
539 evconf = &monitor_qapi_event_conf[event];
540 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
542 qemu_mutex_lock(&monitor_lock);
544 if (!evconf->rate) {
545 /* Unthrottled event */
546 monitor_qapi_event_emit(event, qdict);
547 } else {
548 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
549 MonitorQAPIEventState key = { .event = event, .data = data };
551 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
552 assert(!evstate || timer_pending(evstate->timer));
554 if (evstate) {
556 * Timer is pending for (at least) evconf->rate ns after
557 * last send. Store event for sending when timer fires,
558 * replacing a prior stored event if any.
560 qobject_unref(evstate->qdict);
561 evstate->qdict = qobject_ref(qdict);
562 } else {
564 * Last send was (at least) evconf->rate ns ago.
565 * Send immediately, and arm the timer to call
566 * monitor_qapi_event_handler() in evconf->rate ns. Any
567 * events arriving before then will be delayed until then.
569 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
571 monitor_qapi_event_emit(event, qdict);
573 evstate = g_new(MonitorQAPIEventState, 1);
574 evstate->event = event;
575 evstate->data = qobject_ref(data);
576 evstate->qdict = NULL;
577 evstate->timer = timer_new_ns(monitor_get_event_clock(),
578 monitor_qapi_event_handler,
579 evstate);
580 g_hash_table_add(monitor_qapi_event_state, evstate);
581 timer_mod_ns(evstate->timer, now + evconf->rate);
585 qemu_mutex_unlock(&monitor_lock);
588 void qapi_event_emit(QAPIEvent event, QDict *qdict)
591 * monitor_qapi_event_queue_no_reenter() is not reentrant: it
592 * would deadlock on monitor_lock. Work around by queueing
593 * events in thread-local storage.
594 * TODO: remove this, make it re-enter safe.
596 typedef struct MonitorQapiEvent {
597 QAPIEvent event;
598 QDict *qdict;
599 QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
600 } MonitorQapiEvent;
601 static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
602 static __thread bool reentered;
603 MonitorQapiEvent *ev;
605 if (!reentered) {
606 QSIMPLEQ_INIT(&event_queue);
609 ev = g_new(MonitorQapiEvent, 1);
610 ev->qdict = qobject_ref(qdict);
611 ev->event = event;
612 QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
613 if (reentered) {
614 return;
617 reentered = true;
619 while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
620 QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
621 monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
622 qobject_unref(ev->qdict);
623 g_free(ev);
626 reentered = false;
630 * This function runs evconf->rate ns after sending a throttled
631 * event.
632 * If another event has since been stored, send it.
634 static void monitor_qapi_event_handler(void *opaque)
636 MonitorQAPIEventState *evstate = opaque;
637 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
639 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
640 qemu_mutex_lock(&monitor_lock);
642 if (evstate->qdict) {
643 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
645 monitor_qapi_event_emit(evstate->event, evstate->qdict);
646 qobject_unref(evstate->qdict);
647 evstate->qdict = NULL;
648 timer_mod_ns(evstate->timer, now + evconf->rate);
649 } else {
650 g_hash_table_remove(monitor_qapi_event_state, evstate);
651 qobject_unref(evstate->data);
652 timer_free(evstate->timer);
653 g_free(evstate);
656 qemu_mutex_unlock(&monitor_lock);
659 static unsigned int qapi_event_throttle_hash(const void *key)
661 const MonitorQAPIEventState *evstate = key;
662 unsigned int hash = evstate->event * 255;
664 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
665 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
668 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
669 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
672 return hash;
675 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
677 const MonitorQAPIEventState *eva = a;
678 const MonitorQAPIEventState *evb = b;
680 if (eva->event != evb->event) {
681 return FALSE;
684 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
685 return !strcmp(qdict_get_str(eva->data, "id"),
686 qdict_get_str(evb->data, "id"));
689 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
690 return !strcmp(qdict_get_str(eva->data, "node-name"),
691 qdict_get_str(evb->data, "node-name"));
694 return TRUE;
697 static void monitor_qapi_event_init(void)
699 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
700 qapi_event_throttle_equal);
703 static void handle_hmp_command(Monitor *mon, const char *cmdline);
705 static void monitor_iothread_init(void);
707 static void monitor_data_init(Monitor *mon, bool skip_flush,
708 bool use_io_thread)
710 if (use_io_thread && !mon_iothread) {
711 monitor_iothread_init();
713 memset(mon, 0, sizeof(Monitor));
714 qemu_mutex_init(&mon->mon_lock);
715 qemu_mutex_init(&mon->qmp.qmp_queue_lock);
716 mon->outbuf = qstring_new();
717 /* Use *mon_cmds by default. */
718 mon->cmd_table = mon_cmds;
719 mon->skip_flush = skip_flush;
720 mon->use_io_thread = use_io_thread;
721 mon->qmp.qmp_requests = g_queue_new();
724 static void monitor_data_destroy(Monitor *mon)
726 g_free(mon->mon_cpu_path);
727 qemu_chr_fe_deinit(&mon->chr, false);
728 if (monitor_is_qmp(mon)) {
729 json_message_parser_destroy(&mon->qmp.parser);
731 readline_free(mon->rs);
732 qobject_unref(mon->outbuf);
733 qemu_mutex_destroy(&mon->mon_lock);
734 qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
735 monitor_qmp_cleanup_req_queue_locked(mon);
736 g_queue_free(mon->qmp.qmp_requests);
739 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
740 int64_t cpu_index, Error **errp)
742 char *output = NULL;
743 Monitor *old_mon, hmp;
745 monitor_data_init(&hmp, true, false);
747 old_mon = cur_mon;
748 cur_mon = &hmp;
750 if (has_cpu_index) {
751 int ret = monitor_set_cpu(cpu_index);
752 if (ret < 0) {
753 cur_mon = old_mon;
754 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
755 "a CPU number");
756 goto out;
760 handle_hmp_command(&hmp, command_line);
761 cur_mon = old_mon;
763 qemu_mutex_lock(&hmp.mon_lock);
764 if (qstring_get_length(hmp.outbuf) > 0) {
765 output = g_strdup(qstring_get_str(hmp.outbuf));
766 } else {
767 output = g_strdup("");
769 qemu_mutex_unlock(&hmp.mon_lock);
771 out:
772 monitor_data_destroy(&hmp);
773 return output;
776 static int compare_cmd(const char *name, const char *list)
778 const char *p, *pstart;
779 int len;
780 len = strlen(name);
781 p = list;
782 for(;;) {
783 pstart = p;
784 p = qemu_strchrnul(p, '|');
785 if ((p - pstart) == len && !memcmp(pstart, name, len))
786 return 1;
787 if (*p == '\0')
788 break;
789 p++;
791 return 0;
794 static int get_str(char *buf, int buf_size, const char **pp)
796 const char *p;
797 char *q;
798 int c;
800 q = buf;
801 p = *pp;
802 while (qemu_isspace(*p)) {
803 p++;
805 if (*p == '\0') {
806 fail:
807 *q = '\0';
808 *pp = p;
809 return -1;
811 if (*p == '\"') {
812 p++;
813 while (*p != '\0' && *p != '\"') {
814 if (*p == '\\') {
815 p++;
816 c = *p++;
817 switch (c) {
818 case 'n':
819 c = '\n';
820 break;
821 case 'r':
822 c = '\r';
823 break;
824 case '\\':
825 case '\'':
826 case '\"':
827 break;
828 default:
829 printf("unsupported escape code: '\\%c'\n", c);
830 goto fail;
832 if ((q - buf) < buf_size - 1) {
833 *q++ = c;
835 } else {
836 if ((q - buf) < buf_size - 1) {
837 *q++ = *p;
839 p++;
842 if (*p != '\"') {
843 printf("unterminated string\n");
844 goto fail;
846 p++;
847 } else {
848 while (*p != '\0' && !qemu_isspace(*p)) {
849 if ((q - buf) < buf_size - 1) {
850 *q++ = *p;
852 p++;
855 *q = '\0';
856 *pp = p;
857 return 0;
860 #define MAX_ARGS 16
862 static void free_cmdline_args(char **args, int nb_args)
864 int i;
866 assert(nb_args <= MAX_ARGS);
868 for (i = 0; i < nb_args; i++) {
869 g_free(args[i]);
875 * Parse the command line to get valid args.
876 * @cmdline: command line to be parsed.
877 * @pnb_args: location to store the number of args, must NOT be NULL.
878 * @args: location to store the args, which should be freed by caller, must
879 * NOT be NULL.
881 * Returns 0 on success, negative on failure.
883 * NOTE: this parser is an approximate form of the real command parser. Number
884 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
885 * return with failure.
887 static int parse_cmdline(const char *cmdline,
888 int *pnb_args, char **args)
890 const char *p;
891 int nb_args, ret;
892 char buf[1024];
894 p = cmdline;
895 nb_args = 0;
896 for (;;) {
897 while (qemu_isspace(*p)) {
898 p++;
900 if (*p == '\0') {
901 break;
903 if (nb_args >= MAX_ARGS) {
904 goto fail;
906 ret = get_str(buf, sizeof(buf), &p);
907 if (ret < 0) {
908 goto fail;
910 args[nb_args] = g_strdup(buf);
911 nb_args++;
913 *pnb_args = nb_args;
914 return 0;
916 fail:
917 free_cmdline_args(args, nb_args);
918 return -1;
922 * Can command @cmd be executed in preconfig state?
924 static bool cmd_can_preconfig(const mon_cmd_t *cmd)
926 if (!cmd->flags) {
927 return false;
930 return strchr(cmd->flags, 'p');
933 static void help_cmd_dump_one(Monitor *mon,
934 const mon_cmd_t *cmd,
935 char **prefix_args,
936 int prefix_args_nb)
938 int i;
940 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
941 return;
944 for (i = 0; i < prefix_args_nb; i++) {
945 monitor_printf(mon, "%s ", prefix_args[i]);
947 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
950 /* @args[@arg_index] is the valid command need to find in @cmds */
951 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
952 char **args, int nb_args, int arg_index)
954 const mon_cmd_t *cmd;
955 size_t i;
957 /* No valid arg need to compare with, dump all in *cmds */
958 if (arg_index >= nb_args) {
959 for (cmd = cmds; cmd->name != NULL; cmd++) {
960 help_cmd_dump_one(mon, cmd, args, arg_index);
962 return;
965 /* Find one entry to dump */
966 for (cmd = cmds; cmd->name != NULL; cmd++) {
967 if (compare_cmd(args[arg_index], cmd->name) &&
968 ((!runstate_check(RUN_STATE_PRECONFIG) ||
969 cmd_can_preconfig(cmd)))) {
970 if (cmd->sub_table) {
971 /* continue with next arg */
972 help_cmd_dump(mon, cmd->sub_table,
973 args, nb_args, arg_index + 1);
974 } else {
975 help_cmd_dump_one(mon, cmd, args, arg_index);
977 return;
981 /* Command not found */
982 monitor_printf(mon, "unknown command: '");
983 for (i = 0; i <= arg_index; i++) {
984 monitor_printf(mon, "%s%s", args[i], i == arg_index ? "'\n" : " ");
988 static void help_cmd(Monitor *mon, const char *name)
990 char *args[MAX_ARGS];
991 int nb_args = 0;
993 /* 1. parse user input */
994 if (name) {
995 /* special case for log, directly dump and return */
996 if (!strcmp(name, "log")) {
997 const QEMULogItem *item;
998 monitor_printf(mon, "Log items (comma separated):\n");
999 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
1000 for (item = qemu_log_items; item->mask != 0; item++) {
1001 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
1003 return;
1006 if (parse_cmdline(name, &nb_args, args) < 0) {
1007 return;
1011 /* 2. dump the contents according to parsed args */
1012 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
1014 free_cmdline_args(args, nb_args);
1017 static void do_help_cmd(Monitor *mon, const QDict *qdict)
1019 help_cmd(mon, qdict_get_try_str(qdict, "name"));
1022 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
1024 const char *tp_name = qdict_get_str(qdict, "name");
1025 bool new_state = qdict_get_bool(qdict, "option");
1026 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1027 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1028 Error *local_err = NULL;
1030 if (vcpu < 0) {
1031 monitor_printf(mon, "argument vcpu must be positive");
1032 return;
1035 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
1036 if (local_err) {
1037 error_report_err(local_err);
1041 #ifdef CONFIG_TRACE_SIMPLE
1042 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
1044 const char *op = qdict_get_try_str(qdict, "op");
1045 const char *arg = qdict_get_try_str(qdict, "arg");
1047 if (!op) {
1048 st_print_trace_file_status();
1049 } else if (!strcmp(op, "on")) {
1050 st_set_trace_file_enabled(true);
1051 } else if (!strcmp(op, "off")) {
1052 st_set_trace_file_enabled(false);
1053 } else if (!strcmp(op, "flush")) {
1054 st_flush_trace_buffer();
1055 } else if (!strcmp(op, "set")) {
1056 if (arg) {
1057 st_set_trace_file(arg);
1059 } else {
1060 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
1061 help_cmd(mon, "trace-file");
1064 #endif
1066 static void hmp_info_help(Monitor *mon, const QDict *qdict)
1068 help_cmd(mon, "info");
1071 static void query_commands_cb(QmpCommand *cmd, void *opaque)
1073 CommandInfoList *info, **list = opaque;
1075 if (!cmd->enabled) {
1076 return;
1079 info = g_malloc0(sizeof(*info));
1080 info->value = g_malloc0(sizeof(*info->value));
1081 info->value->name = g_strdup(cmd->name);
1082 info->next = *list;
1083 *list = info;
1086 CommandInfoList *qmp_query_commands(Error **errp)
1088 CommandInfoList *list = NULL;
1090 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
1092 return list;
1095 EventInfoList *qmp_query_events(Error **errp)
1098 * TODO This deprecated command is the only user of
1099 * QAPIEvent_str() and QAPIEvent_lookup[]. When the command goes,
1100 * they should go, too.
1102 EventInfoList *info, *ev_list = NULL;
1103 QAPIEvent e;
1105 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
1106 const char *event_name = QAPIEvent_str(e);
1107 assert(event_name != NULL);
1108 info = g_malloc0(sizeof(*info));
1109 info->value = g_malloc0(sizeof(*info->value));
1110 info->value->name = g_strdup(event_name);
1112 info->next = ev_list;
1113 ev_list = info;
1116 return ev_list;
1120 * Minor hack: generated marshalling suppressed for this command
1121 * ('gen': false in the schema) so we can parse the JSON string
1122 * directly into QObject instead of first parsing it with
1123 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
1124 * to QObject with generated output marshallers, every time. Instead,
1125 * we do it in test-qobject-input-visitor.c, just to make sure
1126 * qapi-gen.py's output actually conforms to the schema.
1128 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
1129 Error **errp)
1131 *ret_data = qobject_from_qlit(&qmp_schema_qlit);
1134 static void monitor_init_qmp_commands(void)
1137 * Two command lists:
1138 * - qmp_commands contains all QMP commands
1139 * - qmp_cap_negotiation_commands contains just
1140 * "qmp_capabilities", to enforce capability negotiation
1143 qmp_init_marshal(&qmp_commands);
1145 qmp_register_command(&qmp_commands, "query-qmp-schema",
1146 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
1147 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1148 QCO_NO_OPTIONS);
1149 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1150 QCO_NO_OPTIONS);
1152 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1153 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1154 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
1157 static bool qmp_oob_enabled(Monitor *mon)
1159 return mon->qmp.capab[QMP_CAPABILITY_OOB];
1162 static void monitor_qmp_caps_reset(Monitor *mon)
1164 memset(mon->qmp.capab_offered, 0, sizeof(mon->qmp.capab_offered));
1165 memset(mon->qmp.capab, 0, sizeof(mon->qmp.capab));
1166 mon->qmp.capab_offered[QMP_CAPABILITY_OOB] = mon->use_io_thread;
1170 * Accept QMP capabilities in @list for @mon.
1171 * On success, set mon->qmp.capab[], and return true.
1172 * On error, set @errp, and return false.
1174 static bool qmp_caps_accept(Monitor *mon, QMPCapabilityList *list,
1175 Error **errp)
1177 GString *unavailable = NULL;
1178 bool capab[QMP_CAPABILITY__MAX];
1180 memset(capab, 0, sizeof(capab));
1182 for (; list; list = list->next) {
1183 if (!mon->qmp.capab_offered[list->value]) {
1184 if (!unavailable) {
1185 unavailable = g_string_new(QMPCapability_str(list->value));
1186 } else {
1187 g_string_append_printf(unavailable, ", %s",
1188 QMPCapability_str(list->value));
1191 capab[list->value] = true;
1194 if (unavailable) {
1195 error_setg(errp, "Capability %s not available", unavailable->str);
1196 g_string_free(unavailable, true);
1197 return false;
1200 memcpy(mon->qmp.capab, capab, sizeof(capab));
1201 return true;
1204 void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
1205 Error **errp)
1207 if (cur_mon->qmp.commands == &qmp_commands) {
1208 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1209 "Capabilities negotiation is already complete, command "
1210 "ignored");
1211 return;
1214 if (!qmp_caps_accept(cur_mon, enable, errp)) {
1215 return;
1218 cur_mon->qmp.commands = &qmp_commands;
1221 /* Set the current CPU defined by the user. Callers must hold BQL. */
1222 int monitor_set_cpu(int cpu_index)
1224 CPUState *cpu;
1226 cpu = qemu_get_cpu(cpu_index);
1227 if (cpu == NULL) {
1228 return -1;
1230 g_free(cur_mon->mon_cpu_path);
1231 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1232 return 0;
1235 /* Callers must hold BQL. */
1236 static CPUState *mon_get_cpu_sync(bool synchronize)
1238 CPUState *cpu;
1240 if (cur_mon->mon_cpu_path) {
1241 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1242 TYPE_CPU, NULL);
1243 if (!cpu) {
1244 g_free(cur_mon->mon_cpu_path);
1245 cur_mon->mon_cpu_path = NULL;
1248 if (!cur_mon->mon_cpu_path) {
1249 if (!first_cpu) {
1250 return NULL;
1252 monitor_set_cpu(first_cpu->cpu_index);
1253 cpu = first_cpu;
1255 if (synchronize) {
1256 cpu_synchronize_state(cpu);
1258 return cpu;
1261 CPUState *mon_get_cpu(void)
1263 return mon_get_cpu_sync(true);
1266 CPUArchState *mon_get_cpu_env(void)
1268 CPUState *cs = mon_get_cpu();
1270 return cs ? cs->env_ptr : NULL;
1273 int monitor_get_cpu_index(void)
1275 CPUState *cs = mon_get_cpu_sync(false);
1277 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1280 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1282 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1283 CPUState *cs;
1285 if (all_cpus) {
1286 CPU_FOREACH(cs) {
1287 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1288 cpu_dump_state(cs, NULL, CPU_DUMP_FPU);
1290 } else {
1291 cs = mon_get_cpu();
1293 if (!cs) {
1294 monitor_printf(mon, "No CPU available\n");
1295 return;
1298 cpu_dump_state(cs, NULL, CPU_DUMP_FPU);
1302 #ifdef CONFIG_TCG
1303 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1305 if (!tcg_enabled()) {
1306 error_report("JIT information is only available with accel=tcg");
1307 return;
1310 dump_exec_info();
1311 dump_drift_info();
1314 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1316 dump_opcount_info();
1318 #endif
1320 static void hmp_info_sync_profile(Monitor *mon, const QDict *qdict)
1322 int64_t max = qdict_get_try_int(qdict, "max", 10);
1323 bool mean = qdict_get_try_bool(qdict, "mean", false);
1324 bool coalesce = !qdict_get_try_bool(qdict, "no_coalesce", false);
1325 enum QSPSortBy sort_by;
1327 sort_by = mean ? QSP_SORT_BY_AVG_WAIT_TIME : QSP_SORT_BY_TOTAL_WAIT_TIME;
1328 qsp_report(max, sort_by, coalesce);
1331 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1333 int i;
1334 const char *str;
1336 if (!mon->rs)
1337 return;
1338 i = 0;
1339 for(;;) {
1340 str = readline_get_history(mon->rs, i);
1341 if (!str)
1342 break;
1343 monitor_printf(mon, "%d: '%s'\n", i, str);
1344 i++;
1348 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1350 CPUState *cs = mon_get_cpu();
1352 if (!cs) {
1353 monitor_printf(mon, "No CPU available\n");
1354 return;
1356 cpu_dump_statistics(cs, 0);
1359 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1361 const char *name = qdict_get_try_str(qdict, "name");
1362 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1363 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1364 TraceEventInfoList *events;
1365 TraceEventInfoList *elem;
1366 Error *local_err = NULL;
1368 if (name == NULL) {
1369 name = "*";
1371 if (vcpu < 0) {
1372 monitor_printf(mon, "argument vcpu must be positive");
1373 return;
1376 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1377 if (local_err) {
1378 error_report_err(local_err);
1379 return;
1382 for (elem = events; elem != NULL; elem = elem->next) {
1383 monitor_printf(mon, "%s : state %u\n",
1384 elem->value->name,
1385 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1387 qapi_free_TraceEventInfoList(events);
1390 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1391 bool has_port, int64_t port,
1392 bool has_tls_port, int64_t tls_port,
1393 bool has_cert_subject, const char *cert_subject,
1394 Error **errp)
1396 if (strcmp(protocol, "spice") == 0) {
1397 if (!qemu_using_spice(errp)) {
1398 return;
1401 if (!has_port && !has_tls_port) {
1402 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1403 return;
1406 if (qemu_spice_migrate_info(hostname,
1407 has_port ? port : -1,
1408 has_tls_port ? tls_port : -1,
1409 cert_subject)) {
1410 error_setg(errp, QERR_UNDEFINED_ERROR);
1411 return;
1413 return;
1416 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1419 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1421 Error *err = NULL;
1423 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1424 if (err) {
1425 error_report_err(err);
1429 static void hmp_log(Monitor *mon, const QDict *qdict)
1431 int mask;
1432 const char *items = qdict_get_str(qdict, "items");
1434 if (!strcmp(items, "none")) {
1435 mask = 0;
1436 } else {
1437 mask = qemu_str_to_log_mask(items);
1438 if (!mask) {
1439 help_cmd(mon, "log");
1440 return;
1443 qemu_set_log(mask);
1446 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1448 const char *option = qdict_get_try_str(qdict, "option");
1449 if (!option || !strcmp(option, "on")) {
1450 singlestep = 1;
1451 } else if (!strcmp(option, "off")) {
1452 singlestep = 0;
1453 } else {
1454 monitor_printf(mon, "unexpected option %s\n", option);
1458 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1460 const char *device = qdict_get_try_str(qdict, "device");
1461 if (!device)
1462 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1463 if (gdbserver_start(device) < 0) {
1464 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1465 device);
1466 } else if (strcmp(device, "none") == 0) {
1467 monitor_printf(mon, "Disabled gdbserver\n");
1468 } else {
1469 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1470 device);
1474 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1476 const char *action = qdict_get_str(qdict, "action");
1477 if (select_watchdog_action(action) == -1) {
1478 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1482 static void monitor_printc(Monitor *mon, int c)
1484 monitor_printf(mon, "'");
1485 switch(c) {
1486 case '\'':
1487 monitor_printf(mon, "\\'");
1488 break;
1489 case '\\':
1490 monitor_printf(mon, "\\\\");
1491 break;
1492 case '\n':
1493 monitor_printf(mon, "\\n");
1494 break;
1495 case '\r':
1496 monitor_printf(mon, "\\r");
1497 break;
1498 default:
1499 if (c >= 32 && c <= 126) {
1500 monitor_printf(mon, "%c", c);
1501 } else {
1502 monitor_printf(mon, "\\x%02x", c);
1504 break;
1506 monitor_printf(mon, "'");
1509 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1510 hwaddr addr, int is_physical)
1512 int l, line_size, i, max_digits, len;
1513 uint8_t buf[16];
1514 uint64_t v;
1515 CPUState *cs = mon_get_cpu();
1517 if (!cs && (format == 'i' || !is_physical)) {
1518 monitor_printf(mon, "Can not dump without CPU\n");
1519 return;
1522 if (format == 'i') {
1523 monitor_disas(mon, cs, addr, count, is_physical);
1524 return;
1527 len = wsize * count;
1528 if (wsize == 1)
1529 line_size = 8;
1530 else
1531 line_size = 16;
1532 max_digits = 0;
1534 switch(format) {
1535 case 'o':
1536 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1537 break;
1538 default:
1539 case 'x':
1540 max_digits = (wsize * 8) / 4;
1541 break;
1542 case 'u':
1543 case 'd':
1544 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1545 break;
1546 case 'c':
1547 wsize = 1;
1548 break;
1551 while (len > 0) {
1552 if (is_physical)
1553 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1554 else
1555 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1556 l = len;
1557 if (l > line_size)
1558 l = line_size;
1559 if (is_physical) {
1560 AddressSpace *as = cs ? cs->as : &address_space_memory;
1561 MemTxResult r = address_space_read(as, addr,
1562 MEMTXATTRS_UNSPECIFIED, buf, l);
1563 if (r != MEMTX_OK) {
1564 monitor_printf(mon, " Cannot access memory\n");
1565 break;
1567 } else {
1568 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1569 monitor_printf(mon, " Cannot access memory\n");
1570 break;
1573 i = 0;
1574 while (i < l) {
1575 switch(wsize) {
1576 default:
1577 case 1:
1578 v = ldub_p(buf + i);
1579 break;
1580 case 2:
1581 v = lduw_p(buf + i);
1582 break;
1583 case 4:
1584 v = (uint32_t)ldl_p(buf + i);
1585 break;
1586 case 8:
1587 v = ldq_p(buf + i);
1588 break;
1590 monitor_printf(mon, " ");
1591 switch(format) {
1592 case 'o':
1593 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1594 break;
1595 case 'x':
1596 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1597 break;
1598 case 'u':
1599 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1600 break;
1601 case 'd':
1602 monitor_printf(mon, "%*" PRId64, max_digits, v);
1603 break;
1604 case 'c':
1605 monitor_printc(mon, v);
1606 break;
1608 i += wsize;
1610 monitor_printf(mon, "\n");
1611 addr += l;
1612 len -= l;
1616 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1618 int count = qdict_get_int(qdict, "count");
1619 int format = qdict_get_int(qdict, "format");
1620 int size = qdict_get_int(qdict, "size");
1621 target_long addr = qdict_get_int(qdict, "addr");
1623 memory_dump(mon, count, format, size, addr, 0);
1626 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1628 int count = qdict_get_int(qdict, "count");
1629 int format = qdict_get_int(qdict, "format");
1630 int size = qdict_get_int(qdict, "size");
1631 hwaddr addr = qdict_get_int(qdict, "addr");
1633 memory_dump(mon, count, format, size, addr, 1);
1636 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1638 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1639 addr, 1);
1641 if (!mrs.mr) {
1642 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1643 return NULL;
1646 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1647 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1648 memory_region_unref(mrs.mr);
1649 return NULL;
1652 *p_mr = mrs.mr;
1653 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1656 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1658 hwaddr addr = qdict_get_int(qdict, "addr");
1659 Error *local_err = NULL;
1660 MemoryRegion *mr = NULL;
1661 void *ptr;
1663 ptr = gpa2hva(&mr, addr, &local_err);
1664 if (local_err) {
1665 error_report_err(local_err);
1666 return;
1669 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1670 " (%s) is %p\n",
1671 addr, mr->name, ptr);
1673 memory_region_unref(mr);
1676 static void hmp_gva2gpa(Monitor *mon, const QDict *qdict)
1678 target_ulong addr = qdict_get_int(qdict, "addr");
1679 MemTxAttrs attrs;
1680 CPUState *cs = mon_get_cpu();
1681 hwaddr gpa;
1683 if (!cs) {
1684 monitor_printf(mon, "No cpu\n");
1685 return;
1688 gpa = cpu_get_phys_page_attrs_debug(mon_get_cpu(),
1689 addr & TARGET_PAGE_MASK, &attrs);
1690 if (gpa == -1) {
1691 monitor_printf(mon, "Unmapped\n");
1692 } else {
1693 monitor_printf(mon, "gpa: %#" HWADDR_PRIx "\n",
1694 gpa + (addr & ~TARGET_PAGE_MASK));
1698 #ifdef CONFIG_LINUX
1699 static uint64_t vtop(void *ptr, Error **errp)
1701 uint64_t pinfo;
1702 uint64_t ret = -1;
1703 uintptr_t addr = (uintptr_t) ptr;
1704 uintptr_t pagesize = getpagesize();
1705 off_t offset = addr / pagesize * sizeof(pinfo);
1706 int fd;
1708 fd = open("/proc/self/pagemap", O_RDONLY);
1709 if (fd == -1) {
1710 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1711 return -1;
1714 /* Force copy-on-write if necessary. */
1715 atomic_add((uint8_t *)ptr, 0);
1717 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1718 error_setg_errno(errp, errno, "Cannot read pagemap");
1719 goto out;
1721 if ((pinfo & (1ull << 63)) == 0) {
1722 error_setg(errp, "Page not present");
1723 goto out;
1725 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1727 out:
1728 close(fd);
1729 return ret;
1732 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1734 hwaddr addr = qdict_get_int(qdict, "addr");
1735 Error *local_err = NULL;
1736 MemoryRegion *mr = NULL;
1737 void *ptr;
1738 uint64_t physaddr;
1740 ptr = gpa2hva(&mr, addr, &local_err);
1741 if (local_err) {
1742 error_report_err(local_err);
1743 return;
1746 physaddr = vtop(ptr, &local_err);
1747 if (local_err) {
1748 error_report_err(local_err);
1749 } else {
1750 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1751 " (%s) is 0x%" PRIx64 "\n",
1752 addr, mr->name, (uint64_t) physaddr);
1755 memory_region_unref(mr);
1757 #endif
1759 static void do_print(Monitor *mon, const QDict *qdict)
1761 int format = qdict_get_int(qdict, "format");
1762 hwaddr val = qdict_get_int(qdict, "val");
1764 switch(format) {
1765 case 'o':
1766 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1767 break;
1768 case 'x':
1769 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1770 break;
1771 case 'u':
1772 monitor_printf(mon, "%" HWADDR_PRIu, val);
1773 break;
1774 default:
1775 case 'd':
1776 monitor_printf(mon, "%" HWADDR_PRId, val);
1777 break;
1778 case 'c':
1779 monitor_printc(mon, val);
1780 break;
1782 monitor_printf(mon, "\n");
1785 static void hmp_sum(Monitor *mon, const QDict *qdict)
1787 uint32_t addr;
1788 uint16_t sum;
1789 uint32_t start = qdict_get_int(qdict, "start");
1790 uint32_t size = qdict_get_int(qdict, "size");
1792 sum = 0;
1793 for(addr = start; addr < (start + size); addr++) {
1794 uint8_t val = address_space_ldub(&address_space_memory, addr,
1795 MEMTXATTRS_UNSPECIFIED, NULL);
1796 /* BSD sum algorithm ('sum' Unix command) */
1797 sum = (sum >> 1) | (sum << 15);
1798 sum += val;
1800 monitor_printf(mon, "%05d\n", sum);
1803 static int mouse_button_state;
1805 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1807 int dx, dy, dz, button;
1808 const char *dx_str = qdict_get_str(qdict, "dx_str");
1809 const char *dy_str = qdict_get_str(qdict, "dy_str");
1810 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1812 dx = strtol(dx_str, NULL, 0);
1813 dy = strtol(dy_str, NULL, 0);
1814 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1815 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1817 if (dz_str) {
1818 dz = strtol(dz_str, NULL, 0);
1819 if (dz != 0) {
1820 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1821 qemu_input_queue_btn(NULL, button, true);
1822 qemu_input_event_sync();
1823 qemu_input_queue_btn(NULL, button, false);
1826 qemu_input_event_sync();
1829 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1831 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1832 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1833 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1834 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1836 int button_state = qdict_get_int(qdict, "button_state");
1838 if (mouse_button_state == button_state) {
1839 return;
1841 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1842 qemu_input_event_sync();
1843 mouse_button_state = button_state;
1846 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1848 int size = qdict_get_int(qdict, "size");
1849 int addr = qdict_get_int(qdict, "addr");
1850 int has_index = qdict_haskey(qdict, "index");
1851 uint32_t val;
1852 int suffix;
1854 if (has_index) {
1855 int index = qdict_get_int(qdict, "index");
1856 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1857 addr++;
1859 addr &= 0xffff;
1861 switch(size) {
1862 default:
1863 case 1:
1864 val = cpu_inb(addr);
1865 suffix = 'b';
1866 break;
1867 case 2:
1868 val = cpu_inw(addr);
1869 suffix = 'w';
1870 break;
1871 case 4:
1872 val = cpu_inl(addr);
1873 suffix = 'l';
1874 break;
1876 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1877 suffix, addr, size * 2, val);
1880 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1882 int size = qdict_get_int(qdict, "size");
1883 int addr = qdict_get_int(qdict, "addr");
1884 int val = qdict_get_int(qdict, "val");
1886 addr &= IOPORTS_MASK;
1888 switch (size) {
1889 default:
1890 case 1:
1891 cpu_outb(addr, val);
1892 break;
1893 case 2:
1894 cpu_outw(addr, val);
1895 break;
1896 case 4:
1897 cpu_outl(addr, val);
1898 break;
1902 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1904 Error *local_err = NULL;
1905 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1907 qemu_boot_set(bootdevice, &local_err);
1908 if (local_err) {
1909 error_report_err(local_err);
1910 } else {
1911 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1915 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1917 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1918 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
1919 bool owner = qdict_get_try_bool(qdict, "owner", false);
1921 mtree_info(flatview, dispatch_tree, owner);
1924 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1926 int i;
1927 NumaNodeMem *node_mem;
1928 CpuInfoList *cpu_list, *cpu;
1930 cpu_list = qmp_query_cpus(&error_abort);
1931 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
1933 query_numa_node_mem(node_mem);
1934 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1935 for (i = 0; i < nb_numa_nodes; i++) {
1936 monitor_printf(mon, "node %d cpus:", i);
1937 for (cpu = cpu_list; cpu; cpu = cpu->next) {
1938 if (cpu->value->has_props && cpu->value->props->has_node_id &&
1939 cpu->value->props->node_id == i) {
1940 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
1943 monitor_printf(mon, "\n");
1944 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1945 node_mem[i].node_mem >> 20);
1946 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
1947 node_mem[i].node_plugged_mem >> 20);
1949 qapi_free_CpuInfoList(cpu_list);
1950 g_free(node_mem);
1953 #ifdef CONFIG_PROFILER
1955 int64_t dev_time;
1957 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1959 static int64_t last_cpu_exec_time;
1960 int64_t cpu_exec_time;
1961 int64_t delta;
1963 cpu_exec_time = tcg_cpu_exec_time();
1964 delta = cpu_exec_time - last_cpu_exec_time;
1966 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1967 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1968 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1969 delta, delta / (double)NANOSECONDS_PER_SECOND);
1970 last_cpu_exec_time = cpu_exec_time;
1971 dev_time = 0;
1973 #else
1974 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1976 monitor_printf(mon, "Internal profiler not compiled\n");
1978 #endif
1980 /* Capture support */
1981 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1983 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1985 int i;
1986 CaptureState *s;
1988 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1989 monitor_printf(mon, "[%d]: ", i);
1990 s->ops.info (s->opaque);
1994 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1996 int i;
1997 int n = qdict_get_int(qdict, "n");
1998 CaptureState *s;
2000 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2001 if (i == n) {
2002 s->ops.destroy (s->opaque);
2003 QLIST_REMOVE (s, entries);
2004 g_free (s);
2005 return;
2010 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2012 const char *path = qdict_get_str(qdict, "path");
2013 int has_freq = qdict_haskey(qdict, "freq");
2014 int freq = qdict_get_try_int(qdict, "freq", -1);
2015 int has_bits = qdict_haskey(qdict, "bits");
2016 int bits = qdict_get_try_int(qdict, "bits", -1);
2017 int has_channels = qdict_haskey(qdict, "nchannels");
2018 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2019 CaptureState *s;
2021 s = g_malloc0 (sizeof (*s));
2023 freq = has_freq ? freq : 44100;
2024 bits = has_bits ? bits : 16;
2025 nchannels = has_channels ? nchannels : 2;
2027 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2028 monitor_printf(mon, "Failed to add wave capture\n");
2029 g_free (s);
2030 return;
2032 QLIST_INSERT_HEAD (&capture_head, s, entries);
2035 static QAuthZList *find_auth(Monitor *mon, const char *name)
2037 Object *obj;
2038 Object *container;
2040 container = object_get_objects_root();
2041 obj = object_resolve_path_component(container, name);
2042 if (!obj) {
2043 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2044 return NULL;
2047 return QAUTHZ_LIST(obj);
2050 static bool warn_acl;
2051 static void hmp_warn_acl(void)
2053 if (warn_acl) {
2054 return;
2056 error_report("The acl_show, acl_reset, acl_policy, acl_add, acl_remove "
2057 "commands are deprecated with no replacement. Authorization "
2058 "for VNC should be performed using the pluggable QAuthZ "
2059 "objects");
2060 warn_acl = true;
2063 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2065 const char *aclname = qdict_get_str(qdict, "aclname");
2066 QAuthZList *auth = find_auth(mon, aclname);
2067 QAuthZListRuleList *rules;
2068 size_t i = 0;
2070 hmp_warn_acl();
2072 if (!auth) {
2073 return;
2076 monitor_printf(mon, "policy: %s\n",
2077 QAuthZListPolicy_str(auth->policy));
2079 rules = auth->rules;
2080 while (rules) {
2081 QAuthZListRule *rule = rules->value;
2082 i++;
2083 monitor_printf(mon, "%zu: %s %s\n", i,
2084 QAuthZListPolicy_str(rule->policy),
2085 rule->match);
2086 rules = rules->next;
2090 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2092 const char *aclname = qdict_get_str(qdict, "aclname");
2093 QAuthZList *auth = find_auth(mon, aclname);
2095 hmp_warn_acl();
2097 if (!auth) {
2098 return;
2101 auth->policy = QAUTHZ_LIST_POLICY_DENY;
2102 qapi_free_QAuthZListRuleList(auth->rules);
2103 auth->rules = NULL;
2104 monitor_printf(mon, "acl: removed all rules\n");
2107 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2109 const char *aclname = qdict_get_str(qdict, "aclname");
2110 const char *policy = qdict_get_str(qdict, "policy");
2111 QAuthZList *auth = find_auth(mon, aclname);
2112 int val;
2113 Error *err = NULL;
2115 hmp_warn_acl();
2117 if (!auth) {
2118 return;
2121 val = qapi_enum_parse(&QAuthZListPolicy_lookup,
2122 policy,
2123 QAUTHZ_LIST_POLICY_DENY,
2124 &err);
2125 if (err) {
2126 error_free(err);
2127 monitor_printf(mon, "acl: unknown policy '%s', "
2128 "expected 'deny' or 'allow'\n", policy);
2129 } else {
2130 auth->policy = val;
2131 if (auth->policy == QAUTHZ_LIST_POLICY_ALLOW) {
2132 monitor_printf(mon, "acl: policy set to 'allow'\n");
2133 } else {
2134 monitor_printf(mon, "acl: policy set to 'deny'\n");
2139 static QAuthZListFormat hmp_acl_get_format(const char *match)
2141 if (strchr(match, '*')) {
2142 return QAUTHZ_LIST_FORMAT_GLOB;
2143 } else {
2144 return QAUTHZ_LIST_FORMAT_EXACT;
2148 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2150 const char *aclname = qdict_get_str(qdict, "aclname");
2151 const char *match = qdict_get_str(qdict, "match");
2152 const char *policystr = qdict_get_str(qdict, "policy");
2153 int has_index = qdict_haskey(qdict, "index");
2154 int index = qdict_get_try_int(qdict, "index", -1);
2155 QAuthZList *auth = find_auth(mon, aclname);
2156 Error *err = NULL;
2157 QAuthZListPolicy policy;
2158 QAuthZListFormat format;
2159 size_t i = 0;
2161 hmp_warn_acl();
2163 if (!auth) {
2164 return;
2167 policy = qapi_enum_parse(&QAuthZListPolicy_lookup,
2168 policystr,
2169 QAUTHZ_LIST_POLICY_DENY,
2170 &err);
2171 if (err) {
2172 error_free(err);
2173 monitor_printf(mon, "acl: unknown policy '%s', "
2174 "expected 'deny' or 'allow'\n", policystr);
2175 return;
2178 format = hmp_acl_get_format(match);
2180 if (has_index && index == 0) {
2181 monitor_printf(mon, "acl: unable to add acl entry\n");
2182 return;
2185 if (has_index) {
2186 i = qauthz_list_insert_rule(auth, match, policy,
2187 format, index - 1, &err);
2188 } else {
2189 i = qauthz_list_append_rule(auth, match, policy,
2190 format, &err);
2192 if (err) {
2193 monitor_printf(mon, "acl: unable to add rule: %s",
2194 error_get_pretty(err));
2195 error_free(err);
2196 } else {
2197 monitor_printf(mon, "acl: added rule at position %zu\n", i + 1);
2201 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2203 const char *aclname = qdict_get_str(qdict, "aclname");
2204 const char *match = qdict_get_str(qdict, "match");
2205 QAuthZList *auth = find_auth(mon, aclname);
2206 ssize_t i = 0;
2208 hmp_warn_acl();
2210 if (!auth) {
2211 return;
2214 i = qauthz_list_delete_rule(auth, match);
2215 if (i >= 0) {
2216 monitor_printf(mon, "acl: removed rule at position %zu\n", i + 1);
2217 } else {
2218 monitor_printf(mon, "acl: no matching acl entry\n");
2222 void qmp_getfd(const char *fdname, Error **errp)
2224 mon_fd_t *monfd;
2225 int fd, tmp_fd;
2227 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2228 if (fd == -1) {
2229 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2230 return;
2233 if (qemu_isdigit(fdname[0])) {
2234 close(fd);
2235 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2236 "a name not starting with a digit");
2237 return;
2240 qemu_mutex_lock(&cur_mon->mon_lock);
2241 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2242 if (strcmp(monfd->name, fdname) != 0) {
2243 continue;
2246 tmp_fd = monfd->fd;
2247 monfd->fd = fd;
2248 qemu_mutex_unlock(&cur_mon->mon_lock);
2249 /* Make sure close() is outside critical section */
2250 close(tmp_fd);
2251 return;
2254 monfd = g_malloc0(sizeof(mon_fd_t));
2255 monfd->name = g_strdup(fdname);
2256 monfd->fd = fd;
2258 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2259 qemu_mutex_unlock(&cur_mon->mon_lock);
2262 void qmp_closefd(const char *fdname, Error **errp)
2264 mon_fd_t *monfd;
2265 int tmp_fd;
2267 qemu_mutex_lock(&cur_mon->mon_lock);
2268 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2269 if (strcmp(monfd->name, fdname) != 0) {
2270 continue;
2273 QLIST_REMOVE(monfd, next);
2274 tmp_fd = monfd->fd;
2275 g_free(monfd->name);
2276 g_free(monfd);
2277 qemu_mutex_unlock(&cur_mon->mon_lock);
2278 /* Make sure close() is outside critical section */
2279 close(tmp_fd);
2280 return;
2283 qemu_mutex_unlock(&cur_mon->mon_lock);
2284 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2287 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2289 mon_fd_t *monfd;
2291 qemu_mutex_lock(&mon->mon_lock);
2292 QLIST_FOREACH(monfd, &mon->fds, next) {
2293 int fd;
2295 if (strcmp(monfd->name, fdname) != 0) {
2296 continue;
2299 fd = monfd->fd;
2301 /* caller takes ownership of fd */
2302 QLIST_REMOVE(monfd, next);
2303 g_free(monfd->name);
2304 g_free(monfd);
2305 qemu_mutex_unlock(&mon->mon_lock);
2307 return fd;
2310 qemu_mutex_unlock(&mon->mon_lock);
2311 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2312 return -1;
2315 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2317 MonFdsetFd *mon_fdset_fd;
2318 MonFdsetFd *mon_fdset_fd_next;
2320 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2321 if ((mon_fdset_fd->removed ||
2322 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2323 runstate_is_running()) {
2324 close(mon_fdset_fd->fd);
2325 g_free(mon_fdset_fd->opaque);
2326 QLIST_REMOVE(mon_fdset_fd, next);
2327 g_free(mon_fdset_fd);
2331 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2332 QLIST_REMOVE(mon_fdset, next);
2333 g_free(mon_fdset);
2337 static void monitor_fdsets_cleanup(void)
2339 MonFdset *mon_fdset;
2340 MonFdset *mon_fdset_next;
2342 qemu_mutex_lock(&mon_fdsets_lock);
2343 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2344 monitor_fdset_cleanup(mon_fdset);
2346 qemu_mutex_unlock(&mon_fdsets_lock);
2349 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2350 const char *opaque, Error **errp)
2352 int fd;
2353 Monitor *mon = cur_mon;
2354 AddfdInfo *fdinfo;
2356 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2357 if (fd == -1) {
2358 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2359 goto error;
2362 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2363 has_opaque, opaque, errp);
2364 if (fdinfo) {
2365 return fdinfo;
2368 error:
2369 if (fd != -1) {
2370 close(fd);
2372 return NULL;
2375 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2377 MonFdset *mon_fdset;
2378 MonFdsetFd *mon_fdset_fd;
2379 char fd_str[60];
2381 qemu_mutex_lock(&mon_fdsets_lock);
2382 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2383 if (mon_fdset->id != fdset_id) {
2384 continue;
2386 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2387 if (has_fd) {
2388 if (mon_fdset_fd->fd != fd) {
2389 continue;
2391 mon_fdset_fd->removed = true;
2392 break;
2393 } else {
2394 mon_fdset_fd->removed = true;
2397 if (has_fd && !mon_fdset_fd) {
2398 goto error;
2400 monitor_fdset_cleanup(mon_fdset);
2401 qemu_mutex_unlock(&mon_fdsets_lock);
2402 return;
2405 error:
2406 qemu_mutex_unlock(&mon_fdsets_lock);
2407 if (has_fd) {
2408 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2409 fdset_id, fd);
2410 } else {
2411 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2413 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2416 FdsetInfoList *qmp_query_fdsets(Error **errp)
2418 MonFdset *mon_fdset;
2419 MonFdsetFd *mon_fdset_fd;
2420 FdsetInfoList *fdset_list = NULL;
2422 qemu_mutex_lock(&mon_fdsets_lock);
2423 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2424 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2425 FdsetFdInfoList *fdsetfd_list = NULL;
2427 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2428 fdset_info->value->fdset_id = mon_fdset->id;
2430 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2431 FdsetFdInfoList *fdsetfd_info;
2433 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2434 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2435 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2436 if (mon_fdset_fd->opaque) {
2437 fdsetfd_info->value->has_opaque = true;
2438 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2439 } else {
2440 fdsetfd_info->value->has_opaque = false;
2443 fdsetfd_info->next = fdsetfd_list;
2444 fdsetfd_list = fdsetfd_info;
2447 fdset_info->value->fds = fdsetfd_list;
2449 fdset_info->next = fdset_list;
2450 fdset_list = fdset_info;
2452 qemu_mutex_unlock(&mon_fdsets_lock);
2454 return fdset_list;
2457 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2458 bool has_opaque, const char *opaque,
2459 Error **errp)
2461 MonFdset *mon_fdset = NULL;
2462 MonFdsetFd *mon_fdset_fd;
2463 AddfdInfo *fdinfo;
2465 qemu_mutex_lock(&mon_fdsets_lock);
2466 if (has_fdset_id) {
2467 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2468 /* Break if match found or match impossible due to ordering by ID */
2469 if (fdset_id <= mon_fdset->id) {
2470 if (fdset_id < mon_fdset->id) {
2471 mon_fdset = NULL;
2473 break;
2478 if (mon_fdset == NULL) {
2479 int64_t fdset_id_prev = -1;
2480 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2482 if (has_fdset_id) {
2483 if (fdset_id < 0) {
2484 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2485 "a non-negative value");
2486 qemu_mutex_unlock(&mon_fdsets_lock);
2487 return NULL;
2489 /* Use specified fdset ID */
2490 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2491 mon_fdset_cur = mon_fdset;
2492 if (fdset_id < mon_fdset_cur->id) {
2493 break;
2496 } else {
2497 /* Use first available fdset ID */
2498 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2499 mon_fdset_cur = mon_fdset;
2500 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2501 fdset_id_prev = mon_fdset_cur->id;
2502 continue;
2504 break;
2508 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2509 if (has_fdset_id) {
2510 mon_fdset->id = fdset_id;
2511 } else {
2512 mon_fdset->id = fdset_id_prev + 1;
2515 /* The fdset list is ordered by fdset ID */
2516 if (!mon_fdset_cur) {
2517 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2518 } else if (mon_fdset->id < mon_fdset_cur->id) {
2519 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2520 } else {
2521 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2525 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2526 mon_fdset_fd->fd = fd;
2527 mon_fdset_fd->removed = false;
2528 if (has_opaque) {
2529 mon_fdset_fd->opaque = g_strdup(opaque);
2531 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2533 fdinfo = g_malloc0(sizeof(*fdinfo));
2534 fdinfo->fdset_id = mon_fdset->id;
2535 fdinfo->fd = mon_fdset_fd->fd;
2537 qemu_mutex_unlock(&mon_fdsets_lock);
2538 return fdinfo;
2541 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2543 #ifdef _WIN32
2544 return -ENOENT;
2545 #else
2546 MonFdset *mon_fdset;
2547 MonFdsetFd *mon_fdset_fd;
2548 int mon_fd_flags;
2549 int ret;
2551 qemu_mutex_lock(&mon_fdsets_lock);
2552 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2553 if (mon_fdset->id != fdset_id) {
2554 continue;
2556 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2557 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2558 if (mon_fd_flags == -1) {
2559 ret = -errno;
2560 goto out;
2563 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2564 ret = mon_fdset_fd->fd;
2565 goto out;
2568 ret = -EACCES;
2569 goto out;
2571 ret = -ENOENT;
2573 out:
2574 qemu_mutex_unlock(&mon_fdsets_lock);
2575 return ret;
2576 #endif
2579 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2581 MonFdset *mon_fdset;
2582 MonFdsetFd *mon_fdset_fd_dup;
2584 qemu_mutex_lock(&mon_fdsets_lock);
2585 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2586 if (mon_fdset->id != fdset_id) {
2587 continue;
2589 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2590 if (mon_fdset_fd_dup->fd == dup_fd) {
2591 goto err;
2594 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2595 mon_fdset_fd_dup->fd = dup_fd;
2596 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2597 qemu_mutex_unlock(&mon_fdsets_lock);
2598 return 0;
2601 err:
2602 qemu_mutex_unlock(&mon_fdsets_lock);
2603 return -1;
2606 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2608 MonFdset *mon_fdset;
2609 MonFdsetFd *mon_fdset_fd_dup;
2611 qemu_mutex_lock(&mon_fdsets_lock);
2612 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2613 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2614 if (mon_fdset_fd_dup->fd == dup_fd) {
2615 if (remove) {
2616 QLIST_REMOVE(mon_fdset_fd_dup, next);
2617 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2618 monitor_fdset_cleanup(mon_fdset);
2620 goto err;
2621 } else {
2622 qemu_mutex_unlock(&mon_fdsets_lock);
2623 return mon_fdset->id;
2629 err:
2630 qemu_mutex_unlock(&mon_fdsets_lock);
2631 return -1;
2634 int monitor_fdset_dup_fd_find(int dup_fd)
2636 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2639 void monitor_fdset_dup_fd_remove(int dup_fd)
2641 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2644 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2646 int fd;
2647 Error *local_err = NULL;
2649 if (!qemu_isdigit(fdname[0]) && mon) {
2650 fd = monitor_get_fd(mon, fdname, &local_err);
2651 } else {
2652 fd = qemu_parse_fd(fdname);
2653 if (fd == -1) {
2654 error_setg(&local_err, "Invalid file descriptor number '%s'",
2655 fdname);
2658 if (local_err) {
2659 error_propagate(errp, local_err);
2660 assert(fd == -1);
2661 } else {
2662 assert(fd != -1);
2665 return fd;
2668 /* Please update hmp-commands.hx when adding or changing commands */
2669 static mon_cmd_t info_cmds[] = {
2670 #include "hmp-commands-info.h"
2671 { NULL, NULL, },
2674 /* mon_cmds and info_cmds would be sorted at runtime */
2675 static mon_cmd_t mon_cmds[] = {
2676 #include "hmp-commands.h"
2677 { NULL, NULL, },
2680 /*******************************************************************/
2682 static const char *pch;
2683 static sigjmp_buf expr_env;
2686 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2687 expr_error(Monitor *mon, const char *fmt, ...)
2689 va_list ap;
2690 va_start(ap, fmt);
2691 monitor_vprintf(mon, fmt, ap);
2692 monitor_printf(mon, "\n");
2693 va_end(ap);
2694 siglongjmp(expr_env, 1);
2697 /* return 0 if OK, -1 if not found */
2698 static int get_monitor_def(target_long *pval, const char *name)
2700 const MonitorDef *md = target_monitor_defs();
2701 CPUState *cs = mon_get_cpu();
2702 void *ptr;
2703 uint64_t tmp = 0;
2704 int ret;
2706 if (cs == NULL || md == NULL) {
2707 return -1;
2710 for(; md->name != NULL; md++) {
2711 if (compare_cmd(name, md->name)) {
2712 if (md->get_value) {
2713 *pval = md->get_value(md, md->offset);
2714 } else {
2715 CPUArchState *env = mon_get_cpu_env();
2716 ptr = (uint8_t *)env + md->offset;
2717 switch(md->type) {
2718 case MD_I32:
2719 *pval = *(int32_t *)ptr;
2720 break;
2721 case MD_TLONG:
2722 *pval = *(target_long *)ptr;
2723 break;
2724 default:
2725 *pval = 0;
2726 break;
2729 return 0;
2733 ret = target_get_monitor_def(cs, name, &tmp);
2734 if (!ret) {
2735 *pval = (target_long) tmp;
2738 return ret;
2741 static void next(void)
2743 if (*pch != '\0') {
2744 pch++;
2745 while (qemu_isspace(*pch))
2746 pch++;
2750 static int64_t expr_sum(Monitor *mon);
2752 static int64_t expr_unary(Monitor *mon)
2754 int64_t n;
2755 char *p;
2756 int ret;
2758 switch(*pch) {
2759 case '+':
2760 next();
2761 n = expr_unary(mon);
2762 break;
2763 case '-':
2764 next();
2765 n = -expr_unary(mon);
2766 break;
2767 case '~':
2768 next();
2769 n = ~expr_unary(mon);
2770 break;
2771 case '(':
2772 next();
2773 n = expr_sum(mon);
2774 if (*pch != ')') {
2775 expr_error(mon, "')' expected");
2777 next();
2778 break;
2779 case '\'':
2780 pch++;
2781 if (*pch == '\0')
2782 expr_error(mon, "character constant expected");
2783 n = *pch;
2784 pch++;
2785 if (*pch != '\'')
2786 expr_error(mon, "missing terminating \' character");
2787 next();
2788 break;
2789 case '$':
2791 char buf[128], *q;
2792 target_long reg=0;
2794 pch++;
2795 q = buf;
2796 while ((*pch >= 'a' && *pch <= 'z') ||
2797 (*pch >= 'A' && *pch <= 'Z') ||
2798 (*pch >= '0' && *pch <= '9') ||
2799 *pch == '_' || *pch == '.') {
2800 if ((q - buf) < sizeof(buf) - 1)
2801 *q++ = *pch;
2802 pch++;
2804 while (qemu_isspace(*pch))
2805 pch++;
2806 *q = 0;
2807 ret = get_monitor_def(&reg, buf);
2808 if (ret < 0)
2809 expr_error(mon, "unknown register");
2810 n = reg;
2812 break;
2813 case '\0':
2814 expr_error(mon, "unexpected end of expression");
2815 n = 0;
2816 break;
2817 default:
2818 errno = 0;
2819 n = strtoull(pch, &p, 0);
2820 if (errno == ERANGE) {
2821 expr_error(mon, "number too large");
2823 if (pch == p) {
2824 expr_error(mon, "invalid char '%c' in expression", *p);
2826 pch = p;
2827 while (qemu_isspace(*pch))
2828 pch++;
2829 break;
2831 return n;
2835 static int64_t expr_prod(Monitor *mon)
2837 int64_t val, val2;
2838 int op;
2840 val = expr_unary(mon);
2841 for(;;) {
2842 op = *pch;
2843 if (op != '*' && op != '/' && op != '%')
2844 break;
2845 next();
2846 val2 = expr_unary(mon);
2847 switch(op) {
2848 default:
2849 case '*':
2850 val *= val2;
2851 break;
2852 case '/':
2853 case '%':
2854 if (val2 == 0)
2855 expr_error(mon, "division by zero");
2856 if (op == '/')
2857 val /= val2;
2858 else
2859 val %= val2;
2860 break;
2863 return val;
2866 static int64_t expr_logic(Monitor *mon)
2868 int64_t val, val2;
2869 int op;
2871 val = expr_prod(mon);
2872 for(;;) {
2873 op = *pch;
2874 if (op != '&' && op != '|' && op != '^')
2875 break;
2876 next();
2877 val2 = expr_prod(mon);
2878 switch(op) {
2879 default:
2880 case '&':
2881 val &= val2;
2882 break;
2883 case '|':
2884 val |= val2;
2885 break;
2886 case '^':
2887 val ^= val2;
2888 break;
2891 return val;
2894 static int64_t expr_sum(Monitor *mon)
2896 int64_t val, val2;
2897 int op;
2899 val = expr_logic(mon);
2900 for(;;) {
2901 op = *pch;
2902 if (op != '+' && op != '-')
2903 break;
2904 next();
2905 val2 = expr_logic(mon);
2906 if (op == '+')
2907 val += val2;
2908 else
2909 val -= val2;
2911 return val;
2914 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2916 pch = *pp;
2917 if (sigsetjmp(expr_env, 0)) {
2918 *pp = pch;
2919 return -1;
2921 while (qemu_isspace(*pch))
2922 pch++;
2923 *pval = expr_sum(mon);
2924 *pp = pch;
2925 return 0;
2928 static int get_double(Monitor *mon, double *pval, const char **pp)
2930 const char *p = *pp;
2931 char *tailp;
2932 double d;
2934 d = strtod(p, &tailp);
2935 if (tailp == p) {
2936 monitor_printf(mon, "Number expected\n");
2937 return -1;
2939 if (d != d || d - d != 0) {
2940 /* NaN or infinity */
2941 monitor_printf(mon, "Bad number\n");
2942 return -1;
2944 *pval = d;
2945 *pp = tailp;
2946 return 0;
2950 * Store the command-name in cmdname, and return a pointer to
2951 * the remaining of the command string.
2953 static const char *get_command_name(const char *cmdline,
2954 char *cmdname, size_t nlen)
2956 size_t len;
2957 const char *p, *pstart;
2959 p = cmdline;
2960 while (qemu_isspace(*p))
2961 p++;
2962 if (*p == '\0')
2963 return NULL;
2964 pstart = p;
2965 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2966 p++;
2967 len = p - pstart;
2968 if (len > nlen - 1)
2969 len = nlen - 1;
2970 memcpy(cmdname, pstart, len);
2971 cmdname[len] = '\0';
2972 return p;
2976 * Read key of 'type' into 'key' and return the current
2977 * 'type' pointer.
2979 static char *key_get_info(const char *type, char **key)
2981 size_t len;
2982 char *p, *str;
2984 if (*type == ',')
2985 type++;
2987 p = strchr(type, ':');
2988 if (!p) {
2989 *key = NULL;
2990 return NULL;
2992 len = p - type;
2994 str = g_malloc(len + 1);
2995 memcpy(str, type, len);
2996 str[len] = '\0';
2998 *key = str;
2999 return ++p;
3002 static int default_fmt_format = 'x';
3003 static int default_fmt_size = 4;
3005 static int is_valid_option(const char *c, const char *typestr)
3007 char option[3];
3009 option[0] = '-';
3010 option[1] = *c;
3011 option[2] = '\0';
3013 typestr = strstr(typestr, option);
3014 return (typestr != NULL);
3017 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
3018 const char *cmdname)
3020 const mon_cmd_t *cmd;
3022 for (cmd = disp_table; cmd->name != NULL; cmd++) {
3023 if (compare_cmd(cmdname, cmd->name)) {
3024 return cmd;
3028 return NULL;
3032 * Parse command name from @cmdp according to command table @table.
3033 * If blank, return NULL.
3034 * Else, if no valid command can be found, report to @mon, and return
3035 * NULL.
3036 * Else, change @cmdp to point right behind the name, and return its
3037 * command table entry.
3038 * Do not assume the return value points into @table! It doesn't when
3039 * the command is found in a sub-command table.
3041 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
3042 const char *cmdp_start,
3043 const char **cmdp,
3044 mon_cmd_t *table)
3046 const char *p;
3047 const mon_cmd_t *cmd;
3048 char cmdname[256];
3050 /* extract the command name */
3051 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
3052 if (!p)
3053 return NULL;
3055 cmd = search_dispatch_table(table, cmdname);
3056 if (!cmd) {
3057 monitor_printf(mon, "unknown command: '%.*s'\n",
3058 (int)(p - cmdp_start), cmdp_start);
3059 return NULL;
3061 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
3062 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
3063 "until after exit_preconfig.\n",
3064 (int)(p - cmdp_start), cmdp_start);
3065 return NULL;
3068 /* filter out following useless space */
3069 while (qemu_isspace(*p)) {
3070 p++;
3073 *cmdp = p;
3074 /* search sub command */
3075 if (cmd->sub_table != NULL && *p != '\0') {
3076 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3079 return cmd;
3083 * Parse arguments for @cmd.
3084 * If it can't be parsed, report to @mon, and return NULL.
3085 * Else, insert command arguments into a QDict, and return it.
3086 * Note: On success, caller has to free the QDict structure.
3089 static QDict *monitor_parse_arguments(Monitor *mon,
3090 const char **endp,
3091 const mon_cmd_t *cmd)
3093 const char *typestr;
3094 char *key;
3095 int c;
3096 const char *p = *endp;
3097 char buf[1024];
3098 QDict *qdict = qdict_new();
3100 /* parse the parameters */
3101 typestr = cmd->args_type;
3102 for(;;) {
3103 typestr = key_get_info(typestr, &key);
3104 if (!typestr)
3105 break;
3106 c = *typestr;
3107 typestr++;
3108 switch(c) {
3109 case 'F':
3110 case 'B':
3111 case 's':
3113 int ret;
3115 while (qemu_isspace(*p))
3116 p++;
3117 if (*typestr == '?') {
3118 typestr++;
3119 if (*p == '\0') {
3120 /* no optional string: NULL argument */
3121 break;
3124 ret = get_str(buf, sizeof(buf), &p);
3125 if (ret < 0) {
3126 switch(c) {
3127 case 'F':
3128 monitor_printf(mon, "%s: filename expected\n",
3129 cmd->name);
3130 break;
3131 case 'B':
3132 monitor_printf(mon, "%s: block device name expected\n",
3133 cmd->name);
3134 break;
3135 default:
3136 monitor_printf(mon, "%s: string expected\n", cmd->name);
3137 break;
3139 goto fail;
3141 qdict_put_str(qdict, key, buf);
3143 break;
3144 case 'O':
3146 QemuOptsList *opts_list;
3147 QemuOpts *opts;
3149 opts_list = qemu_find_opts(key);
3150 if (!opts_list || opts_list->desc->name) {
3151 goto bad_type;
3153 while (qemu_isspace(*p)) {
3154 p++;
3156 if (!*p)
3157 break;
3158 if (get_str(buf, sizeof(buf), &p) < 0) {
3159 goto fail;
3161 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3162 if (!opts) {
3163 goto fail;
3165 qemu_opts_to_qdict(opts, qdict);
3166 qemu_opts_del(opts);
3168 break;
3169 case '/':
3171 int count, format, size;
3173 while (qemu_isspace(*p))
3174 p++;
3175 if (*p == '/') {
3176 /* format found */
3177 p++;
3178 count = 1;
3179 if (qemu_isdigit(*p)) {
3180 count = 0;
3181 while (qemu_isdigit(*p)) {
3182 count = count * 10 + (*p - '0');
3183 p++;
3186 size = -1;
3187 format = -1;
3188 for(;;) {
3189 switch(*p) {
3190 case 'o':
3191 case 'd':
3192 case 'u':
3193 case 'x':
3194 case 'i':
3195 case 'c':
3196 format = *p++;
3197 break;
3198 case 'b':
3199 size = 1;
3200 p++;
3201 break;
3202 case 'h':
3203 size = 2;
3204 p++;
3205 break;
3206 case 'w':
3207 size = 4;
3208 p++;
3209 break;
3210 case 'g':
3211 case 'L':
3212 size = 8;
3213 p++;
3214 break;
3215 default:
3216 goto next;
3219 next:
3220 if (*p != '\0' && !qemu_isspace(*p)) {
3221 monitor_printf(mon, "invalid char in format: '%c'\n",
3222 *p);
3223 goto fail;
3225 if (format < 0)
3226 format = default_fmt_format;
3227 if (format != 'i') {
3228 /* for 'i', not specifying a size gives -1 as size */
3229 if (size < 0)
3230 size = default_fmt_size;
3231 default_fmt_size = size;
3233 default_fmt_format = format;
3234 } else {
3235 count = 1;
3236 format = default_fmt_format;
3237 if (format != 'i') {
3238 size = default_fmt_size;
3239 } else {
3240 size = -1;
3243 qdict_put_int(qdict, "count", count);
3244 qdict_put_int(qdict, "format", format);
3245 qdict_put_int(qdict, "size", size);
3247 break;
3248 case 'i':
3249 case 'l':
3250 case 'M':
3252 int64_t val;
3254 while (qemu_isspace(*p))
3255 p++;
3256 if (*typestr == '?' || *typestr == '.') {
3257 if (*typestr == '?') {
3258 if (*p == '\0') {
3259 typestr++;
3260 break;
3262 } else {
3263 if (*p == '.') {
3264 p++;
3265 while (qemu_isspace(*p))
3266 p++;
3267 } else {
3268 typestr++;
3269 break;
3272 typestr++;
3274 if (get_expr(mon, &val, &p))
3275 goto fail;
3276 /* Check if 'i' is greater than 32-bit */
3277 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3278 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3279 monitor_printf(mon, "integer is for 32-bit values\n");
3280 goto fail;
3281 } else if (c == 'M') {
3282 if (val < 0) {
3283 monitor_printf(mon, "enter a positive value\n");
3284 goto fail;
3286 val *= MiB;
3288 qdict_put_int(qdict, key, val);
3290 break;
3291 case 'o':
3293 int ret;
3294 uint64_t val;
3295 const char *end;
3297 while (qemu_isspace(*p)) {
3298 p++;
3300 if (*typestr == '?') {
3301 typestr++;
3302 if (*p == '\0') {
3303 break;
3306 ret = qemu_strtosz_MiB(p, &end, &val);
3307 if (ret < 0 || val > INT64_MAX) {
3308 monitor_printf(mon, "invalid size\n");
3309 goto fail;
3311 qdict_put_int(qdict, key, val);
3312 p = end;
3314 break;
3315 case 'T':
3317 double val;
3319 while (qemu_isspace(*p))
3320 p++;
3321 if (*typestr == '?') {
3322 typestr++;
3323 if (*p == '\0') {
3324 break;
3327 if (get_double(mon, &val, &p) < 0) {
3328 goto fail;
3330 if (p[0] && p[1] == 's') {
3331 switch (*p) {
3332 case 'm':
3333 val /= 1e3; p += 2; break;
3334 case 'u':
3335 val /= 1e6; p += 2; break;
3336 case 'n':
3337 val /= 1e9; p += 2; break;
3340 if (*p && !qemu_isspace(*p)) {
3341 monitor_printf(mon, "Unknown unit suffix\n");
3342 goto fail;
3344 qdict_put(qdict, key, qnum_from_double(val));
3346 break;
3347 case 'b':
3349 const char *beg;
3350 bool val;
3352 while (qemu_isspace(*p)) {
3353 p++;
3355 beg = p;
3356 while (qemu_isgraph(*p)) {
3357 p++;
3359 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3360 val = true;
3361 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3362 val = false;
3363 } else {
3364 monitor_printf(mon, "Expected 'on' or 'off'\n");
3365 goto fail;
3367 qdict_put_bool(qdict, key, val);
3369 break;
3370 case '-':
3372 const char *tmp = p;
3373 int skip_key = 0;
3374 /* option */
3376 c = *typestr++;
3377 if (c == '\0')
3378 goto bad_type;
3379 while (qemu_isspace(*p))
3380 p++;
3381 if (*p == '-') {
3382 p++;
3383 if(c != *p) {
3384 if(!is_valid_option(p, typestr)) {
3386 monitor_printf(mon, "%s: unsupported option -%c\n",
3387 cmd->name, *p);
3388 goto fail;
3389 } else {
3390 skip_key = 1;
3393 if(skip_key) {
3394 p = tmp;
3395 } else {
3396 /* has option */
3397 p++;
3398 qdict_put_bool(qdict, key, true);
3402 break;
3403 case 'S':
3405 /* package all remaining string */
3406 int len;
3408 while (qemu_isspace(*p)) {
3409 p++;
3411 if (*typestr == '?') {
3412 typestr++;
3413 if (*p == '\0') {
3414 /* no remaining string: NULL argument */
3415 break;
3418 len = strlen(p);
3419 if (len <= 0) {
3420 monitor_printf(mon, "%s: string expected\n",
3421 cmd->name);
3422 goto fail;
3424 qdict_put_str(qdict, key, p);
3425 p += len;
3427 break;
3428 default:
3429 bad_type:
3430 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3431 goto fail;
3433 g_free(key);
3434 key = NULL;
3436 /* check that all arguments were parsed */
3437 while (qemu_isspace(*p))
3438 p++;
3439 if (*p != '\0') {
3440 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3441 cmd->name);
3442 goto fail;
3445 return qdict;
3447 fail:
3448 qobject_unref(qdict);
3449 g_free(key);
3450 return NULL;
3453 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3455 QDict *qdict;
3456 const mon_cmd_t *cmd;
3457 const char *cmd_start = cmdline;
3459 trace_handle_hmp_command(mon, cmdline);
3461 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3462 if (!cmd) {
3463 return;
3466 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3467 if (!qdict) {
3468 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3469 cmdline--;
3471 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3472 (int)(cmdline - cmd_start), cmd_start);
3473 return;
3476 cmd->cmd(mon, qdict);
3477 qobject_unref(qdict);
3480 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3482 const char *p, *pstart;
3483 char cmd[128];
3484 int len;
3486 p = list;
3487 for(;;) {
3488 pstart = p;
3489 p = qemu_strchrnul(p, '|');
3490 len = p - pstart;
3491 if (len > sizeof(cmd) - 2)
3492 len = sizeof(cmd) - 2;
3493 memcpy(cmd, pstart, len);
3494 cmd[len] = '\0';
3495 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3496 readline_add_completion(mon->rs, cmd);
3498 if (*p == '\0')
3499 break;
3500 p++;
3504 static void file_completion(Monitor *mon, const char *input)
3506 DIR *ffs;
3507 struct dirent *d;
3508 char path[1024];
3509 char file[1024], file_prefix[1024];
3510 int input_path_len;
3511 const char *p;
3513 p = strrchr(input, '/');
3514 if (!p) {
3515 input_path_len = 0;
3516 pstrcpy(file_prefix, sizeof(file_prefix), input);
3517 pstrcpy(path, sizeof(path), ".");
3518 } else {
3519 input_path_len = p - input + 1;
3520 memcpy(path, input, input_path_len);
3521 if (input_path_len > sizeof(path) - 1)
3522 input_path_len = sizeof(path) - 1;
3523 path[input_path_len] = '\0';
3524 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3527 ffs = opendir(path);
3528 if (!ffs)
3529 return;
3530 for(;;) {
3531 struct stat sb;
3532 d = readdir(ffs);
3533 if (!d)
3534 break;
3536 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3537 continue;
3540 if (strstart(d->d_name, file_prefix, NULL)) {
3541 memcpy(file, input, input_path_len);
3542 if (input_path_len < sizeof(file))
3543 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3544 d->d_name);
3545 /* stat the file to find out if it's a directory.
3546 * In that case add a slash to speed up typing long paths
3548 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3549 pstrcat(file, sizeof(file), "/");
3551 readline_add_completion(mon->rs, file);
3554 closedir(ffs);
3557 static const char *next_arg_type(const char *typestr)
3559 const char *p = strchr(typestr, ':');
3560 return (p != NULL ? ++p : typestr);
3563 static void add_completion_option(ReadLineState *rs, const char *str,
3564 const char *option)
3566 if (!str || !option) {
3567 return;
3569 if (!strncmp(option, str, strlen(str))) {
3570 readline_add_completion(rs, option);
3574 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3576 size_t len;
3577 ChardevBackendInfoList *list, *start;
3579 if (nb_args != 2) {
3580 return;
3582 len = strlen(str);
3583 readline_set_completion_index(rs, len);
3585 start = list = qmp_query_chardev_backends(NULL);
3586 while (list) {
3587 const char *chr_name = list->value->name;
3589 if (!strncmp(chr_name, str, len)) {
3590 readline_add_completion(rs, chr_name);
3592 list = list->next;
3594 qapi_free_ChardevBackendInfoList(start);
3597 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3599 size_t len;
3600 int i;
3602 if (nb_args != 2) {
3603 return;
3605 len = strlen(str);
3606 readline_set_completion_index(rs, len);
3607 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3608 add_completion_option(rs, str, NetClientDriver_str(i));
3612 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3614 GSList *list, *elt;
3615 size_t len;
3617 if (nb_args != 2) {
3618 return;
3621 len = strlen(str);
3622 readline_set_completion_index(rs, len);
3623 list = elt = object_class_get_list(TYPE_DEVICE, false);
3624 while (elt) {
3625 const char *name;
3626 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3627 TYPE_DEVICE);
3628 name = object_class_get_name(OBJECT_CLASS(dc));
3630 if (dc->user_creatable
3631 && !strncmp(name, str, len)) {
3632 readline_add_completion(rs, name);
3634 elt = elt->next;
3636 g_slist_free(list);
3639 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3641 GSList *list, *elt;
3642 size_t len;
3644 if (nb_args != 2) {
3645 return;
3648 len = strlen(str);
3649 readline_set_completion_index(rs, len);
3650 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3651 while (elt) {
3652 const char *name;
3654 name = object_class_get_name(OBJECT_CLASS(elt->data));
3655 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3656 readline_add_completion(rs, name);
3658 elt = elt->next;
3660 g_slist_free(list);
3663 static void peripheral_device_del_completion(ReadLineState *rs,
3664 const char *str, size_t len)
3666 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3667 GSList *list, *item;
3669 list = qdev_build_hotpluggable_device_list(peripheral);
3670 if (!list) {
3671 return;
3674 for (item = list; item; item = g_slist_next(item)) {
3675 DeviceState *dev = item->data;
3677 if (dev->id && !strncmp(str, dev->id, len)) {
3678 readline_add_completion(rs, dev->id);
3682 g_slist_free(list);
3685 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3687 size_t len;
3688 ChardevInfoList *list, *start;
3690 if (nb_args != 2) {
3691 return;
3693 len = strlen(str);
3694 readline_set_completion_index(rs, len);
3696 start = list = qmp_query_chardev(NULL);
3697 while (list) {
3698 ChardevInfo *chr = list->value;
3700 if (!strncmp(chr->label, str, len)) {
3701 readline_add_completion(rs, chr->label);
3703 list = list->next;
3705 qapi_free_ChardevInfoList(start);
3708 static void ringbuf_completion(ReadLineState *rs, const char *str)
3710 size_t len;
3711 ChardevInfoList *list, *start;
3713 len = strlen(str);
3714 readline_set_completion_index(rs, len);
3716 start = list = qmp_query_chardev(NULL);
3717 while (list) {
3718 ChardevInfo *chr_info = list->value;
3720 if (!strncmp(chr_info->label, str, len)) {
3721 Chardev *chr = qemu_chr_find(chr_info->label);
3722 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3723 readline_add_completion(rs, chr_info->label);
3726 list = list->next;
3728 qapi_free_ChardevInfoList(start);
3731 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3733 if (nb_args != 2) {
3734 return;
3736 ringbuf_completion(rs, str);
3739 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3741 size_t len;
3743 if (nb_args != 2) {
3744 return;
3747 len = strlen(str);
3748 readline_set_completion_index(rs, len);
3749 peripheral_device_del_completion(rs, str, len);
3752 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3754 ObjectPropertyInfoList *list, *start;
3755 size_t len;
3757 if (nb_args != 2) {
3758 return;
3760 len = strlen(str);
3761 readline_set_completion_index(rs, len);
3763 start = list = qmp_qom_list("/objects", NULL);
3764 while (list) {
3765 ObjectPropertyInfo *info = list->value;
3767 if (!strncmp(info->type, "child<", 5)
3768 && !strncmp(info->name, str, len)) {
3769 readline_add_completion(rs, info->name);
3771 list = list->next;
3773 qapi_free_ObjectPropertyInfoList(start);
3776 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3778 int i;
3779 char *sep;
3780 size_t len;
3782 if (nb_args != 2) {
3783 return;
3785 sep = strrchr(str, '-');
3786 if (sep) {
3787 str = sep + 1;
3789 len = strlen(str);
3790 readline_set_completion_index(rs, len);
3791 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3792 if (!strncmp(str, QKeyCode_str(i), len)) {
3793 readline_add_completion(rs, QKeyCode_str(i));
3798 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3800 size_t len;
3802 len = strlen(str);
3803 readline_set_completion_index(rs, len);
3804 if (nb_args == 2) {
3805 NetClientState *ncs[MAX_QUEUE_NUM];
3806 int count, i;
3807 count = qemu_find_net_clients_except(NULL, ncs,
3808 NET_CLIENT_DRIVER_NONE,
3809 MAX_QUEUE_NUM);
3810 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3811 const char *name = ncs[i]->name;
3812 if (!strncmp(str, name, len)) {
3813 readline_add_completion(rs, name);
3816 } else if (nb_args == 3) {
3817 add_completion_option(rs, str, "on");
3818 add_completion_option(rs, str, "off");
3822 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3824 int len, count, i;
3825 NetClientState *ncs[MAX_QUEUE_NUM];
3827 if (nb_args != 2) {
3828 return;
3831 len = strlen(str);
3832 readline_set_completion_index(rs, len);
3833 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3834 MAX_QUEUE_NUM);
3835 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3836 QemuOpts *opts;
3837 const char *name = ncs[i]->name;
3838 if (strncmp(str, name, len)) {
3839 continue;
3841 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3842 if (opts) {
3843 readline_add_completion(rs, name);
3848 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3850 size_t len;
3852 len = strlen(str);
3853 readline_set_completion_index(rs, len);
3854 if (nb_args == 2) {
3855 TraceEventIter iter;
3856 TraceEvent *ev;
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));
3862 g_free(pattern);
3866 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3868 size_t len;
3870 len = strlen(str);
3871 readline_set_completion_index(rs, len);
3872 if (nb_args == 2) {
3873 TraceEventIter iter;
3874 TraceEvent *ev;
3875 char *pattern = g_strdup_printf("%s*", str);
3876 trace_event_iter_init(&iter, pattern);
3877 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3878 readline_add_completion(rs, trace_event_get_name(ev));
3880 g_free(pattern);
3881 } else if (nb_args == 3) {
3882 add_completion_option(rs, str, "on");
3883 add_completion_option(rs, str, "off");
3887 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3889 int i;
3891 if (nb_args != 2) {
3892 return;
3894 readline_set_completion_index(rs, strlen(str));
3895 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3896 add_completion_option(rs, str, WatchdogAction_str(i));
3900 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3901 const char *str)
3903 size_t len;
3905 len = strlen(str);
3906 readline_set_completion_index(rs, len);
3907 if (nb_args == 2) {
3908 int i;
3909 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3910 const char *name = MigrationCapability_str(i);
3911 if (!strncmp(str, name, len)) {
3912 readline_add_completion(rs, name);
3915 } else if (nb_args == 3) {
3916 add_completion_option(rs, str, "on");
3917 add_completion_option(rs, str, "off");
3921 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3922 const char *str)
3924 size_t len;
3926 len = strlen(str);
3927 readline_set_completion_index(rs, len);
3928 if (nb_args == 2) {
3929 int i;
3930 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3931 const char *name = MigrationParameter_str(i);
3932 if (!strncmp(str, name, len)) {
3933 readline_add_completion(rs, name);
3939 static void vm_completion(ReadLineState *rs, const char *str)
3941 size_t len;
3942 BlockDriverState *bs;
3943 BdrvNextIterator it;
3945 len = strlen(str);
3946 readline_set_completion_index(rs, len);
3948 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3949 SnapshotInfoList *snapshots, *snapshot;
3950 AioContext *ctx = bdrv_get_aio_context(bs);
3951 bool ok = false;
3953 aio_context_acquire(ctx);
3954 if (bdrv_can_snapshot(bs)) {
3955 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3957 aio_context_release(ctx);
3958 if (!ok) {
3959 continue;
3962 snapshot = snapshots;
3963 while (snapshot) {
3964 char *completion = snapshot->value->name;
3965 if (!strncmp(str, completion, len)) {
3966 readline_add_completion(rs, completion);
3968 completion = snapshot->value->id;
3969 if (!strncmp(str, completion, len)) {
3970 readline_add_completion(rs, completion);
3972 snapshot = snapshot->next;
3974 qapi_free_SnapshotInfoList(snapshots);
3979 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3981 if (nb_args == 2) {
3982 vm_completion(rs, str);
3986 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3988 if (nb_args == 2) {
3989 vm_completion(rs, str);
3993 static void monitor_find_completion_by_table(Monitor *mon,
3994 const mon_cmd_t *cmd_table,
3995 char **args,
3996 int nb_args)
3998 const char *cmdname;
3999 int i;
4000 const char *ptype, *old_ptype, *str, *name;
4001 const mon_cmd_t *cmd;
4002 BlockBackend *blk = NULL;
4004 if (nb_args <= 1) {
4005 /* command completion */
4006 if (nb_args == 0)
4007 cmdname = "";
4008 else
4009 cmdname = args[0];
4010 readline_set_completion_index(mon->rs, strlen(cmdname));
4011 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4012 if (!runstate_check(RUN_STATE_PRECONFIG) ||
4013 cmd_can_preconfig(cmd)) {
4014 cmd_completion(mon, cmdname, cmd->name);
4017 } else {
4018 /* find the command */
4019 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4020 if (compare_cmd(args[0], cmd->name) &&
4021 (!runstate_check(RUN_STATE_PRECONFIG) ||
4022 cmd_can_preconfig(cmd))) {
4023 break;
4026 if (!cmd->name) {
4027 return;
4030 if (cmd->sub_table) {
4031 /* do the job again */
4032 monitor_find_completion_by_table(mon, cmd->sub_table,
4033 &args[1], nb_args - 1);
4034 return;
4036 if (cmd->command_completion) {
4037 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
4038 return;
4041 ptype = next_arg_type(cmd->args_type);
4042 for(i = 0; i < nb_args - 2; i++) {
4043 if (*ptype != '\0') {
4044 ptype = next_arg_type(ptype);
4045 while (*ptype == '?')
4046 ptype = next_arg_type(ptype);
4049 str = args[nb_args - 1];
4050 old_ptype = NULL;
4051 while (*ptype == '-' && old_ptype != ptype) {
4052 old_ptype = ptype;
4053 ptype = next_arg_type(ptype);
4055 switch(*ptype) {
4056 case 'F':
4057 /* file completion */
4058 readline_set_completion_index(mon->rs, strlen(str));
4059 file_completion(mon, str);
4060 break;
4061 case 'B':
4062 /* block device name completion */
4063 readline_set_completion_index(mon->rs, strlen(str));
4064 while ((blk = blk_next(blk)) != NULL) {
4065 name = blk_name(blk);
4066 if (str[0] == '\0' ||
4067 !strncmp(name, str, strlen(str))) {
4068 readline_add_completion(mon->rs, name);
4071 break;
4072 case 's':
4073 case 'S':
4074 if (!strcmp(cmd->name, "help|?")) {
4075 monitor_find_completion_by_table(mon, cmd_table,
4076 &args[1], nb_args - 1);
4078 break;
4079 default:
4080 break;
4085 static void monitor_find_completion(void *opaque,
4086 const char *cmdline)
4088 Monitor *mon = opaque;
4089 char *args[MAX_ARGS];
4090 int nb_args, len;
4092 /* 1. parse the cmdline */
4093 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4094 return;
4097 /* if the line ends with a space, it means we want to complete the
4098 next arg */
4099 len = strlen(cmdline);
4100 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4101 if (nb_args >= MAX_ARGS) {
4102 goto cleanup;
4104 args[nb_args++] = g_strdup("");
4107 /* 2. auto complete according to args */
4108 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4110 cleanup:
4111 free_cmdline_args(args, nb_args);
4114 static int monitor_can_read(void *opaque)
4116 Monitor *mon = opaque;
4118 return !atomic_mb_read(&mon->suspend_cnt);
4122 * Emit QMP response @rsp with ID @id to @mon.
4123 * Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
4124 * Nothing is emitted then.
4126 static void monitor_qmp_respond(Monitor *mon, QDict *rsp)
4128 if (rsp) {
4129 qmp_send_response(mon, rsp);
4133 static void monitor_qmp_dispatch(Monitor *mon, QObject *req)
4135 Monitor *old_mon;
4136 QDict *rsp;
4137 QDict *error;
4139 old_mon = cur_mon;
4140 cur_mon = mon;
4142 rsp = qmp_dispatch(mon->qmp.commands, req, qmp_oob_enabled(mon));
4144 cur_mon = old_mon;
4146 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
4147 error = qdict_get_qdict(rsp, "error");
4148 if (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 monitor_qmp_respond(mon, rsp);
4159 qobject_unref(rsp);
4163 * Pop a QMP request from a monitor request queue.
4164 * Return the request, or NULL all request queues are empty.
4165 * We are using round-robin fashion to pop the request, to avoid
4166 * processing commands only on a very busy monitor. To achieve that,
4167 * when we process one request on a specific monitor, we put that
4168 * monitor to the end of mon_list queue.
4170 * Note: if the function returned with non-NULL, then the caller will
4171 * be with mon->qmp.qmp_queue_lock held, and the caller is responsible
4172 * to release it.
4174 static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void)
4176 QMPRequest *req_obj = NULL;
4177 Monitor *mon;
4179 qemu_mutex_lock(&monitor_lock);
4181 QTAILQ_FOREACH(mon, &mon_list, entry) {
4182 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4183 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4184 if (req_obj) {
4185 /* With the lock of corresponding queue held */
4186 break;
4188 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4191 if (req_obj) {
4193 * We found one request on the monitor. Degrade this monitor's
4194 * priority to lowest by re-inserting it to end of queue.
4196 QTAILQ_REMOVE(&mon_list, mon, entry);
4197 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4200 qemu_mutex_unlock(&monitor_lock);
4202 return req_obj;
4205 static void monitor_qmp_bh_dispatcher(void *data)
4207 QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock();
4208 QDict *rsp;
4209 bool need_resume;
4210 Monitor *mon;
4212 if (!req_obj) {
4213 return;
4216 mon = req_obj->mon;
4217 /* qmp_oob_enabled() might change after "qmp_capabilities" */
4218 need_resume = !qmp_oob_enabled(mon) ||
4219 mon->qmp.qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1;
4220 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4221 if (req_obj->req) {
4222 QDict *qdict = qobject_to(QDict, req_obj->req);
4223 QObject *id = qdict ? qdict_get(qdict, "id") : NULL;
4224 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(id) ?: "");
4225 monitor_qmp_dispatch(mon, req_obj->req);
4226 } else {
4227 assert(req_obj->err);
4228 rsp = qmp_error_response(req_obj->err);
4229 req_obj->err = NULL;
4230 monitor_qmp_respond(mon, rsp);
4231 qobject_unref(rsp);
4234 if (need_resume) {
4235 /* Pairs with the monitor_suspend() in handle_qmp_command() */
4236 monitor_resume(mon);
4238 qmp_request_free(req_obj);
4240 /* Reschedule instead of looping so the main loop stays responsive */
4241 qemu_bh_schedule(qmp_dispatcher_bh);
4244 static void handle_qmp_command(void *opaque, QObject *req, Error *err)
4246 Monitor *mon = opaque;
4247 QObject *id = NULL;
4248 QDict *qdict;
4249 QMPRequest *req_obj;
4251 assert(!req != !err);
4253 qdict = qobject_to(QDict, req);
4254 if (qdict) {
4255 id = qdict_get(qdict, "id");
4256 } /* else will fail qmp_dispatch() */
4258 if (req && trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4259 QString *req_json = qobject_to_json(req);
4260 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4261 qobject_unref(req_json);
4264 if (qdict && qmp_is_oob(qdict)) {
4265 /* OOB commands are executed immediately */
4266 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id) ?: "");
4267 monitor_qmp_dispatch(mon, req);
4268 qobject_unref(req);
4269 return;
4272 req_obj = g_new0(QMPRequest, 1);
4273 req_obj->mon = mon;
4274 req_obj->req = req;
4275 req_obj->err = err;
4277 /* Protect qmp_requests and fetching its length. */
4278 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4281 * Suspend the monitor when we can't queue more requests after
4282 * this one. Dequeuing in monitor_qmp_bh_dispatcher() will resume
4283 * it. Note that when OOB is disabled, we queue at most one
4284 * command, for backward compatibility.
4286 if (!qmp_oob_enabled(mon) ||
4287 mon->qmp.qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1) {
4288 monitor_suspend(mon);
4292 * Put the request to the end of queue so that requests will be
4293 * handled in time order. Ownership for req_obj, req,
4294 * etc. will be delivered to the handler side.
4296 assert(mon->qmp.qmp_requests->length < QMP_REQ_QUEUE_LEN_MAX);
4297 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4298 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4300 /* Kick the dispatcher routine */
4301 qemu_bh_schedule(qmp_dispatcher_bh);
4304 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4306 Monitor *mon = opaque;
4308 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4311 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4313 Monitor *old_mon = cur_mon;
4314 int i;
4316 cur_mon = opaque;
4318 if (cur_mon->rs) {
4319 for (i = 0; i < size; i++)
4320 readline_handle_byte(cur_mon->rs, buf[i]);
4321 } else {
4322 if (size == 0 || buf[size - 1] != 0)
4323 monitor_printf(cur_mon, "corrupted command\n");
4324 else
4325 handle_hmp_command(cur_mon, (char *)buf);
4328 cur_mon = old_mon;
4331 static void monitor_command_cb(void *opaque, const char *cmdline,
4332 void *readline_opaque)
4334 Monitor *mon = opaque;
4336 monitor_suspend(mon);
4337 handle_hmp_command(mon, cmdline);
4338 monitor_resume(mon);
4341 int monitor_suspend(Monitor *mon)
4343 if (monitor_is_hmp_non_interactive(mon)) {
4344 return -ENOTTY;
4347 atomic_inc(&mon->suspend_cnt);
4349 if (mon->use_io_thread) {
4351 * Kick I/O thread to make sure this takes effect. It'll be
4352 * evaluated again in prepare() of the watch object.
4354 aio_notify(iothread_get_aio_context(mon_iothread));
4357 trace_monitor_suspend(mon, 1);
4358 return 0;
4361 static void monitor_accept_input(void *opaque)
4363 Monitor *mon = opaque;
4365 qemu_chr_fe_accept_input(&mon->chr);
4368 void monitor_resume(Monitor *mon)
4370 if (monitor_is_hmp_non_interactive(mon)) {
4371 return;
4374 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4375 AioContext *ctx;
4377 if (mon->use_io_thread) {
4378 ctx = iothread_get_aio_context(mon_iothread);
4379 } else {
4380 ctx = qemu_get_aio_context();
4383 if (!monitor_is_qmp(mon)) {
4384 assert(mon->rs);
4385 readline_show_prompt(mon->rs);
4388 aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
4391 trace_monitor_suspend(mon, -1);
4394 static QDict *qmp_greeting(Monitor *mon)
4396 QList *cap_list = qlist_new();
4397 QObject *ver = NULL;
4398 QMPCapability cap;
4400 qmp_marshal_query_version(NULL, &ver, NULL);
4402 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4403 if (mon->qmp.capab_offered[cap]) {
4404 qlist_append_str(cap_list, QMPCapability_str(cap));
4408 return qdict_from_jsonf_nofail(
4409 "{'QMP': {'version': %p, 'capabilities': %p}}",
4410 ver, cap_list);
4413 static void monitor_qmp_event(void *opaque, int event)
4415 QDict *data;
4416 Monitor *mon = opaque;
4418 switch (event) {
4419 case CHR_EVENT_OPENED:
4420 mon->qmp.commands = &qmp_cap_negotiation_commands;
4421 monitor_qmp_caps_reset(mon);
4422 data = qmp_greeting(mon);
4423 qmp_send_response(mon, data);
4424 qobject_unref(data);
4425 mon_refcount++;
4426 break;
4427 case CHR_EVENT_CLOSED:
4429 * Note: this is only useful when the output of the chardev
4430 * backend is still open. For example, when the backend is
4431 * stdio, it's possible that stdout is still open when stdin
4432 * is closed.
4434 monitor_qmp_cleanup_queues(mon);
4435 json_message_parser_destroy(&mon->qmp.parser);
4436 json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
4437 mon, NULL);
4438 mon_refcount--;
4439 monitor_fdsets_cleanup();
4440 break;
4444 static void monitor_event(void *opaque, int event)
4446 Monitor *mon = opaque;
4448 switch (event) {
4449 case CHR_EVENT_MUX_IN:
4450 qemu_mutex_lock(&mon->mon_lock);
4451 mon->mux_out = 0;
4452 qemu_mutex_unlock(&mon->mon_lock);
4453 if (mon->reset_seen) {
4454 readline_restart(mon->rs);
4455 monitor_resume(mon);
4456 monitor_flush(mon);
4457 } else {
4458 atomic_mb_set(&mon->suspend_cnt, 0);
4460 break;
4462 case CHR_EVENT_MUX_OUT:
4463 if (mon->reset_seen) {
4464 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4465 monitor_printf(mon, "\n");
4467 monitor_flush(mon);
4468 monitor_suspend(mon);
4469 } else {
4470 atomic_inc(&mon->suspend_cnt);
4472 qemu_mutex_lock(&mon->mon_lock);
4473 mon->mux_out = 1;
4474 qemu_mutex_unlock(&mon->mon_lock);
4475 break;
4477 case CHR_EVENT_OPENED:
4478 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4479 "information\n", QEMU_VERSION);
4480 if (!mon->mux_out) {
4481 readline_restart(mon->rs);
4482 readline_show_prompt(mon->rs);
4484 mon->reset_seen = 1;
4485 mon_refcount++;
4486 break;
4488 case CHR_EVENT_CLOSED:
4489 mon_refcount--;
4490 monitor_fdsets_cleanup();
4491 break;
4495 static int
4496 compare_mon_cmd(const void *a, const void *b)
4498 return strcmp(((const mon_cmd_t *)a)->name,
4499 ((const mon_cmd_t *)b)->name);
4502 static void sortcmdlist(void)
4504 int array_num;
4505 int elem_size = sizeof(mon_cmd_t);
4507 array_num = sizeof(mon_cmds)/elem_size-1;
4508 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4510 array_num = sizeof(info_cmds)/elem_size-1;
4511 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4514 static void monitor_iothread_init(void)
4516 mon_iothread = iothread_create("mon_iothread", &error_abort);
4519 void monitor_init_globals(void)
4521 monitor_init_qmp_commands();
4522 monitor_qapi_event_init();
4523 sortcmdlist();
4524 qemu_mutex_init(&monitor_lock);
4525 qemu_mutex_init(&mon_fdsets_lock);
4528 * The dispatcher BH must run in the main loop thread, since we
4529 * have commands assuming that context. It would be nice to get
4530 * rid of those assumptions.
4532 qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4533 monitor_qmp_bh_dispatcher,
4534 NULL);
4537 /* These functions just adapt the readline interface in a typesafe way. We
4538 * could cast function pointers but that discards compiler checks.
4540 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4541 const char *fmt, ...)
4543 va_list ap;
4544 va_start(ap, fmt);
4545 monitor_vprintf(opaque, fmt, ap);
4546 va_end(ap);
4549 static void monitor_readline_flush(void *opaque)
4551 monitor_flush(opaque);
4555 * Print to current monitor if we have one, else to stderr.
4557 int error_vprintf(const char *fmt, va_list ap)
4559 if (cur_mon && !monitor_cur_is_qmp()) {
4560 return monitor_vprintf(cur_mon, fmt, ap);
4562 return vfprintf(stderr, fmt, ap);
4565 int error_vprintf_unless_qmp(const char *fmt, va_list ap)
4567 if (!cur_mon) {
4568 return vfprintf(stderr, fmt, ap);
4570 if (!monitor_cur_is_qmp()) {
4571 return monitor_vprintf(cur_mon, fmt, ap);
4573 return -1;
4576 static void monitor_list_append(Monitor *mon)
4578 qemu_mutex_lock(&monitor_lock);
4580 * This prevents inserting new monitors during monitor_cleanup().
4581 * A cleaner solution would involve the main thread telling other
4582 * threads to terminate, waiting for their termination.
4584 if (!monitor_destroyed) {
4585 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4586 mon = NULL;
4588 qemu_mutex_unlock(&monitor_lock);
4590 if (mon) {
4591 monitor_data_destroy(mon);
4592 g_free(mon);
4596 static void monitor_qmp_setup_handlers_bh(void *opaque)
4598 Monitor *mon = opaque;
4599 GMainContext *context;
4601 assert(mon->use_io_thread);
4602 context = iothread_get_g_main_context(mon_iothread);
4603 assert(context);
4604 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4605 monitor_qmp_event, NULL, mon, context, true);
4606 monitor_list_append(mon);
4609 void monitor_init(Chardev *chr, int flags)
4611 Monitor *mon = g_malloc(sizeof(*mon));
4612 bool use_readline = flags & MONITOR_USE_READLINE;
4614 /* Note: we run QMP monitor in I/O thread when @chr supports that */
4615 monitor_data_init(mon, false,
4616 (flags & MONITOR_USE_CONTROL)
4617 && qemu_chr_has_feature(chr,
4618 QEMU_CHAR_FEATURE_GCONTEXT));
4620 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4621 mon->flags = flags;
4622 if (use_readline) {
4623 mon->rs = readline_init(monitor_readline_printf,
4624 monitor_readline_flush,
4625 mon,
4626 monitor_find_completion);
4627 monitor_read_command(mon, 0);
4630 if (monitor_is_qmp(mon)) {
4631 qemu_chr_fe_set_echo(&mon->chr, true);
4632 json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
4633 mon, NULL);
4634 if (mon->use_io_thread) {
4636 * Make sure the old iowatch is gone. It's possible when
4637 * e.g. the chardev is in client mode, with wait=on.
4639 remove_fd_in_watch(chr);
4641 * We can't call qemu_chr_fe_set_handlers() directly here
4642 * since chardev might be running in the monitor I/O
4643 * thread. Schedule a bottom half.
4645 aio_bh_schedule_oneshot(iothread_get_aio_context(mon_iothread),
4646 monitor_qmp_setup_handlers_bh, mon);
4647 /* The bottom half will add @mon to @mon_list */
4648 return;
4649 } else {
4650 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4651 monitor_qmp_read, monitor_qmp_event,
4652 NULL, mon, NULL, true);
4654 } else {
4655 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4656 monitor_event, NULL, mon, NULL, true);
4659 monitor_list_append(mon);
4662 void monitor_cleanup(void)
4665 * We need to explicitly stop the I/O thread (but not destroy it),
4666 * clean up the monitor resources, then destroy the I/O thread since
4667 * we need to unregister from chardev below in
4668 * monitor_data_destroy(), and chardev is not thread-safe yet
4670 if (mon_iothread) {
4671 iothread_stop(mon_iothread);
4674 /* Flush output buffers and destroy monitors */
4675 qemu_mutex_lock(&monitor_lock);
4676 monitor_destroyed = true;
4677 while (!QTAILQ_EMPTY(&mon_list)) {
4678 Monitor *mon = QTAILQ_FIRST(&mon_list);
4679 QTAILQ_REMOVE(&mon_list, mon, entry);
4680 /* Permit QAPI event emission from character frontend release */
4681 qemu_mutex_unlock(&monitor_lock);
4682 monitor_flush(mon);
4683 monitor_data_destroy(mon);
4684 qemu_mutex_lock(&monitor_lock);
4685 g_free(mon);
4687 qemu_mutex_unlock(&monitor_lock);
4689 /* QEMUBHs needs to be deleted before destroying the I/O thread */
4690 qemu_bh_delete(qmp_dispatcher_bh);
4691 qmp_dispatcher_bh = NULL;
4692 if (mon_iothread) {
4693 iothread_destroy(mon_iothread);
4694 mon_iothread = NULL;
4698 QemuOptsList qemu_mon_opts = {
4699 .name = "mon",
4700 .implied_opt_name = "chardev",
4701 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4702 .desc = {
4704 .name = "mode",
4705 .type = QEMU_OPT_STRING,
4707 .name = "chardev",
4708 .type = QEMU_OPT_STRING,
4710 .name = "pretty",
4711 .type = QEMU_OPT_BOOL,
4713 { /* end of list */ }
4717 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4719 MachineState *ms = MACHINE(qdev_get_machine());
4720 MachineClass *mc = MACHINE_GET_CLASS(ms);
4722 if (!mc->has_hotpluggable_cpus) {
4723 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4724 return NULL;
4727 return machine_query_hotpluggable_cpus(ms);