target/alpha: Clean up alpha_cpu_dump_state
[qemu/ar7.git] / monitor.c
blob6428eb3b7ea4f0a064979946ee838a5374319bdb
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(cs, addr & TARGET_PAGE_MASK, &attrs);
1689 if (gpa == -1) {
1690 monitor_printf(mon, "Unmapped\n");
1691 } else {
1692 monitor_printf(mon, "gpa: %#" HWADDR_PRIx "\n",
1693 gpa + (addr & ~TARGET_PAGE_MASK));
1697 #ifdef CONFIG_LINUX
1698 static uint64_t vtop(void *ptr, Error **errp)
1700 uint64_t pinfo;
1701 uint64_t ret = -1;
1702 uintptr_t addr = (uintptr_t) ptr;
1703 uintptr_t pagesize = getpagesize();
1704 off_t offset = addr / pagesize * sizeof(pinfo);
1705 int fd;
1707 fd = open("/proc/self/pagemap", O_RDONLY);
1708 if (fd == -1) {
1709 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1710 return -1;
1713 /* Force copy-on-write if necessary. */
1714 atomic_add((uint8_t *)ptr, 0);
1716 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1717 error_setg_errno(errp, errno, "Cannot read pagemap");
1718 goto out;
1720 if ((pinfo & (1ull << 63)) == 0) {
1721 error_setg(errp, "Page not present");
1722 goto out;
1724 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1726 out:
1727 close(fd);
1728 return ret;
1731 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1733 hwaddr addr = qdict_get_int(qdict, "addr");
1734 Error *local_err = NULL;
1735 MemoryRegion *mr = NULL;
1736 void *ptr;
1737 uint64_t physaddr;
1739 ptr = gpa2hva(&mr, addr, &local_err);
1740 if (local_err) {
1741 error_report_err(local_err);
1742 return;
1745 physaddr = vtop(ptr, &local_err);
1746 if (local_err) {
1747 error_report_err(local_err);
1748 } else {
1749 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1750 " (%s) is 0x%" PRIx64 "\n",
1751 addr, mr->name, (uint64_t) physaddr);
1754 memory_region_unref(mr);
1756 #endif
1758 static void do_print(Monitor *mon, const QDict *qdict)
1760 int format = qdict_get_int(qdict, "format");
1761 hwaddr val = qdict_get_int(qdict, "val");
1763 switch(format) {
1764 case 'o':
1765 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1766 break;
1767 case 'x':
1768 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1769 break;
1770 case 'u':
1771 monitor_printf(mon, "%" HWADDR_PRIu, val);
1772 break;
1773 default:
1774 case 'd':
1775 monitor_printf(mon, "%" HWADDR_PRId, val);
1776 break;
1777 case 'c':
1778 monitor_printc(mon, val);
1779 break;
1781 monitor_printf(mon, "\n");
1784 static void hmp_sum(Monitor *mon, const QDict *qdict)
1786 uint32_t addr;
1787 uint16_t sum;
1788 uint32_t start = qdict_get_int(qdict, "start");
1789 uint32_t size = qdict_get_int(qdict, "size");
1791 sum = 0;
1792 for(addr = start; addr < (start + size); addr++) {
1793 uint8_t val = address_space_ldub(&address_space_memory, addr,
1794 MEMTXATTRS_UNSPECIFIED, NULL);
1795 /* BSD sum algorithm ('sum' Unix command) */
1796 sum = (sum >> 1) | (sum << 15);
1797 sum += val;
1799 monitor_printf(mon, "%05d\n", sum);
1802 static int mouse_button_state;
1804 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1806 int dx, dy, dz, button;
1807 const char *dx_str = qdict_get_str(qdict, "dx_str");
1808 const char *dy_str = qdict_get_str(qdict, "dy_str");
1809 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1811 dx = strtol(dx_str, NULL, 0);
1812 dy = strtol(dy_str, NULL, 0);
1813 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1814 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1816 if (dz_str) {
1817 dz = strtol(dz_str, NULL, 0);
1818 if (dz != 0) {
1819 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1820 qemu_input_queue_btn(NULL, button, true);
1821 qemu_input_event_sync();
1822 qemu_input_queue_btn(NULL, button, false);
1825 qemu_input_event_sync();
1828 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1830 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1831 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1832 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1833 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1835 int button_state = qdict_get_int(qdict, "button_state");
1837 if (mouse_button_state == button_state) {
1838 return;
1840 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1841 qemu_input_event_sync();
1842 mouse_button_state = button_state;
1845 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1847 int size = qdict_get_int(qdict, "size");
1848 int addr = qdict_get_int(qdict, "addr");
1849 int has_index = qdict_haskey(qdict, "index");
1850 uint32_t val;
1851 int suffix;
1853 if (has_index) {
1854 int index = qdict_get_int(qdict, "index");
1855 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1856 addr++;
1858 addr &= 0xffff;
1860 switch(size) {
1861 default:
1862 case 1:
1863 val = cpu_inb(addr);
1864 suffix = 'b';
1865 break;
1866 case 2:
1867 val = cpu_inw(addr);
1868 suffix = 'w';
1869 break;
1870 case 4:
1871 val = cpu_inl(addr);
1872 suffix = 'l';
1873 break;
1875 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1876 suffix, addr, size * 2, val);
1879 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1881 int size = qdict_get_int(qdict, "size");
1882 int addr = qdict_get_int(qdict, "addr");
1883 int val = qdict_get_int(qdict, "val");
1885 addr &= IOPORTS_MASK;
1887 switch (size) {
1888 default:
1889 case 1:
1890 cpu_outb(addr, val);
1891 break;
1892 case 2:
1893 cpu_outw(addr, val);
1894 break;
1895 case 4:
1896 cpu_outl(addr, val);
1897 break;
1901 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1903 Error *local_err = NULL;
1904 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1906 qemu_boot_set(bootdevice, &local_err);
1907 if (local_err) {
1908 error_report_err(local_err);
1909 } else {
1910 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1914 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1916 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1917 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
1918 bool owner = qdict_get_try_bool(qdict, "owner", false);
1920 mtree_info(flatview, dispatch_tree, owner);
1923 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1925 int i;
1926 NumaNodeMem *node_mem;
1927 CpuInfoList *cpu_list, *cpu;
1929 cpu_list = qmp_query_cpus(&error_abort);
1930 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
1932 query_numa_node_mem(node_mem);
1933 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1934 for (i = 0; i < nb_numa_nodes; i++) {
1935 monitor_printf(mon, "node %d cpus:", i);
1936 for (cpu = cpu_list; cpu; cpu = cpu->next) {
1937 if (cpu->value->has_props && cpu->value->props->has_node_id &&
1938 cpu->value->props->node_id == i) {
1939 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
1942 monitor_printf(mon, "\n");
1943 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1944 node_mem[i].node_mem >> 20);
1945 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
1946 node_mem[i].node_plugged_mem >> 20);
1948 qapi_free_CpuInfoList(cpu_list);
1949 g_free(node_mem);
1952 #ifdef CONFIG_PROFILER
1954 int64_t dev_time;
1956 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1958 static int64_t last_cpu_exec_time;
1959 int64_t cpu_exec_time;
1960 int64_t delta;
1962 cpu_exec_time = tcg_cpu_exec_time();
1963 delta = cpu_exec_time - last_cpu_exec_time;
1965 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1966 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1967 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1968 delta, delta / (double)NANOSECONDS_PER_SECOND);
1969 last_cpu_exec_time = cpu_exec_time;
1970 dev_time = 0;
1972 #else
1973 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1975 monitor_printf(mon, "Internal profiler not compiled\n");
1977 #endif
1979 /* Capture support */
1980 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1982 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1984 int i;
1985 CaptureState *s;
1987 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1988 monitor_printf(mon, "[%d]: ", i);
1989 s->ops.info (s->opaque);
1993 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1995 int i;
1996 int n = qdict_get_int(qdict, "n");
1997 CaptureState *s;
1999 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2000 if (i == n) {
2001 s->ops.destroy (s->opaque);
2002 QLIST_REMOVE (s, entries);
2003 g_free (s);
2004 return;
2009 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2011 const char *path = qdict_get_str(qdict, "path");
2012 int has_freq = qdict_haskey(qdict, "freq");
2013 int freq = qdict_get_try_int(qdict, "freq", -1);
2014 int has_bits = qdict_haskey(qdict, "bits");
2015 int bits = qdict_get_try_int(qdict, "bits", -1);
2016 int has_channels = qdict_haskey(qdict, "nchannels");
2017 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2018 CaptureState *s;
2020 s = g_malloc0 (sizeof (*s));
2022 freq = has_freq ? freq : 44100;
2023 bits = has_bits ? bits : 16;
2024 nchannels = has_channels ? nchannels : 2;
2026 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2027 monitor_printf(mon, "Failed to add wave capture\n");
2028 g_free (s);
2029 return;
2031 QLIST_INSERT_HEAD (&capture_head, s, entries);
2034 static QAuthZList *find_auth(Monitor *mon, const char *name)
2036 Object *obj;
2037 Object *container;
2039 container = object_get_objects_root();
2040 obj = object_resolve_path_component(container, name);
2041 if (!obj) {
2042 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2043 return NULL;
2046 return QAUTHZ_LIST(obj);
2049 static bool warn_acl;
2050 static void hmp_warn_acl(void)
2052 if (warn_acl) {
2053 return;
2055 error_report("The acl_show, acl_reset, acl_policy, acl_add, acl_remove "
2056 "commands are deprecated with no replacement. Authorization "
2057 "for VNC should be performed using the pluggable QAuthZ "
2058 "objects");
2059 warn_acl = true;
2062 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2064 const char *aclname = qdict_get_str(qdict, "aclname");
2065 QAuthZList *auth = find_auth(mon, aclname);
2066 QAuthZListRuleList *rules;
2067 size_t i = 0;
2069 hmp_warn_acl();
2071 if (!auth) {
2072 return;
2075 monitor_printf(mon, "policy: %s\n",
2076 QAuthZListPolicy_str(auth->policy));
2078 rules = auth->rules;
2079 while (rules) {
2080 QAuthZListRule *rule = rules->value;
2081 i++;
2082 monitor_printf(mon, "%zu: %s %s\n", i,
2083 QAuthZListPolicy_str(rule->policy),
2084 rule->match);
2085 rules = rules->next;
2089 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2091 const char *aclname = qdict_get_str(qdict, "aclname");
2092 QAuthZList *auth = find_auth(mon, aclname);
2094 hmp_warn_acl();
2096 if (!auth) {
2097 return;
2100 auth->policy = QAUTHZ_LIST_POLICY_DENY;
2101 qapi_free_QAuthZListRuleList(auth->rules);
2102 auth->rules = NULL;
2103 monitor_printf(mon, "acl: removed all rules\n");
2106 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2108 const char *aclname = qdict_get_str(qdict, "aclname");
2109 const char *policy = qdict_get_str(qdict, "policy");
2110 QAuthZList *auth = find_auth(mon, aclname);
2111 int val;
2112 Error *err = NULL;
2114 hmp_warn_acl();
2116 if (!auth) {
2117 return;
2120 val = qapi_enum_parse(&QAuthZListPolicy_lookup,
2121 policy,
2122 QAUTHZ_LIST_POLICY_DENY,
2123 &err);
2124 if (err) {
2125 error_free(err);
2126 monitor_printf(mon, "acl: unknown policy '%s', "
2127 "expected 'deny' or 'allow'\n", policy);
2128 } else {
2129 auth->policy = val;
2130 if (auth->policy == QAUTHZ_LIST_POLICY_ALLOW) {
2131 monitor_printf(mon, "acl: policy set to 'allow'\n");
2132 } else {
2133 monitor_printf(mon, "acl: policy set to 'deny'\n");
2138 static QAuthZListFormat hmp_acl_get_format(const char *match)
2140 if (strchr(match, '*')) {
2141 return QAUTHZ_LIST_FORMAT_GLOB;
2142 } else {
2143 return QAUTHZ_LIST_FORMAT_EXACT;
2147 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2149 const char *aclname = qdict_get_str(qdict, "aclname");
2150 const char *match = qdict_get_str(qdict, "match");
2151 const char *policystr = qdict_get_str(qdict, "policy");
2152 int has_index = qdict_haskey(qdict, "index");
2153 int index = qdict_get_try_int(qdict, "index", -1);
2154 QAuthZList *auth = find_auth(mon, aclname);
2155 Error *err = NULL;
2156 QAuthZListPolicy policy;
2157 QAuthZListFormat format;
2158 size_t i = 0;
2160 hmp_warn_acl();
2162 if (!auth) {
2163 return;
2166 policy = qapi_enum_parse(&QAuthZListPolicy_lookup,
2167 policystr,
2168 QAUTHZ_LIST_POLICY_DENY,
2169 &err);
2170 if (err) {
2171 error_free(err);
2172 monitor_printf(mon, "acl: unknown policy '%s', "
2173 "expected 'deny' or 'allow'\n", policystr);
2174 return;
2177 format = hmp_acl_get_format(match);
2179 if (has_index && index == 0) {
2180 monitor_printf(mon, "acl: unable to add acl entry\n");
2181 return;
2184 if (has_index) {
2185 i = qauthz_list_insert_rule(auth, match, policy,
2186 format, index - 1, &err);
2187 } else {
2188 i = qauthz_list_append_rule(auth, match, policy,
2189 format, &err);
2191 if (err) {
2192 monitor_printf(mon, "acl: unable to add rule: %s",
2193 error_get_pretty(err));
2194 error_free(err);
2195 } else {
2196 monitor_printf(mon, "acl: added rule at position %zu\n", i + 1);
2200 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2202 const char *aclname = qdict_get_str(qdict, "aclname");
2203 const char *match = qdict_get_str(qdict, "match");
2204 QAuthZList *auth = find_auth(mon, aclname);
2205 ssize_t i = 0;
2207 hmp_warn_acl();
2209 if (!auth) {
2210 return;
2213 i = qauthz_list_delete_rule(auth, match);
2214 if (i >= 0) {
2215 monitor_printf(mon, "acl: removed rule at position %zu\n", i + 1);
2216 } else {
2217 monitor_printf(mon, "acl: no matching acl entry\n");
2221 void qmp_getfd(const char *fdname, Error **errp)
2223 mon_fd_t *monfd;
2224 int fd, tmp_fd;
2226 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2227 if (fd == -1) {
2228 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2229 return;
2232 if (qemu_isdigit(fdname[0])) {
2233 close(fd);
2234 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2235 "a name not starting with a digit");
2236 return;
2239 qemu_mutex_lock(&cur_mon->mon_lock);
2240 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2241 if (strcmp(monfd->name, fdname) != 0) {
2242 continue;
2245 tmp_fd = monfd->fd;
2246 monfd->fd = fd;
2247 qemu_mutex_unlock(&cur_mon->mon_lock);
2248 /* Make sure close() is outside critical section */
2249 close(tmp_fd);
2250 return;
2253 monfd = g_malloc0(sizeof(mon_fd_t));
2254 monfd->name = g_strdup(fdname);
2255 monfd->fd = fd;
2257 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2258 qemu_mutex_unlock(&cur_mon->mon_lock);
2261 void qmp_closefd(const char *fdname, Error **errp)
2263 mon_fd_t *monfd;
2264 int tmp_fd;
2266 qemu_mutex_lock(&cur_mon->mon_lock);
2267 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2268 if (strcmp(monfd->name, fdname) != 0) {
2269 continue;
2272 QLIST_REMOVE(monfd, next);
2273 tmp_fd = monfd->fd;
2274 g_free(monfd->name);
2275 g_free(monfd);
2276 qemu_mutex_unlock(&cur_mon->mon_lock);
2277 /* Make sure close() is outside critical section */
2278 close(tmp_fd);
2279 return;
2282 qemu_mutex_unlock(&cur_mon->mon_lock);
2283 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2286 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2288 mon_fd_t *monfd;
2290 qemu_mutex_lock(&mon->mon_lock);
2291 QLIST_FOREACH(monfd, &mon->fds, next) {
2292 int fd;
2294 if (strcmp(monfd->name, fdname) != 0) {
2295 continue;
2298 fd = monfd->fd;
2300 /* caller takes ownership of fd */
2301 QLIST_REMOVE(monfd, next);
2302 g_free(monfd->name);
2303 g_free(monfd);
2304 qemu_mutex_unlock(&mon->mon_lock);
2306 return fd;
2309 qemu_mutex_unlock(&mon->mon_lock);
2310 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2311 return -1;
2314 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2316 MonFdsetFd *mon_fdset_fd;
2317 MonFdsetFd *mon_fdset_fd_next;
2319 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2320 if ((mon_fdset_fd->removed ||
2321 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2322 runstate_is_running()) {
2323 close(mon_fdset_fd->fd);
2324 g_free(mon_fdset_fd->opaque);
2325 QLIST_REMOVE(mon_fdset_fd, next);
2326 g_free(mon_fdset_fd);
2330 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2331 QLIST_REMOVE(mon_fdset, next);
2332 g_free(mon_fdset);
2336 static void monitor_fdsets_cleanup(void)
2338 MonFdset *mon_fdset;
2339 MonFdset *mon_fdset_next;
2341 qemu_mutex_lock(&mon_fdsets_lock);
2342 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2343 monitor_fdset_cleanup(mon_fdset);
2345 qemu_mutex_unlock(&mon_fdsets_lock);
2348 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2349 const char *opaque, Error **errp)
2351 int fd;
2352 Monitor *mon = cur_mon;
2353 AddfdInfo *fdinfo;
2355 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2356 if (fd == -1) {
2357 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2358 goto error;
2361 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2362 has_opaque, opaque, errp);
2363 if (fdinfo) {
2364 return fdinfo;
2367 error:
2368 if (fd != -1) {
2369 close(fd);
2371 return NULL;
2374 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2376 MonFdset *mon_fdset;
2377 MonFdsetFd *mon_fdset_fd;
2378 char fd_str[60];
2380 qemu_mutex_lock(&mon_fdsets_lock);
2381 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2382 if (mon_fdset->id != fdset_id) {
2383 continue;
2385 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2386 if (has_fd) {
2387 if (mon_fdset_fd->fd != fd) {
2388 continue;
2390 mon_fdset_fd->removed = true;
2391 break;
2392 } else {
2393 mon_fdset_fd->removed = true;
2396 if (has_fd && !mon_fdset_fd) {
2397 goto error;
2399 monitor_fdset_cleanup(mon_fdset);
2400 qemu_mutex_unlock(&mon_fdsets_lock);
2401 return;
2404 error:
2405 qemu_mutex_unlock(&mon_fdsets_lock);
2406 if (has_fd) {
2407 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2408 fdset_id, fd);
2409 } else {
2410 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2412 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2415 FdsetInfoList *qmp_query_fdsets(Error **errp)
2417 MonFdset *mon_fdset;
2418 MonFdsetFd *mon_fdset_fd;
2419 FdsetInfoList *fdset_list = NULL;
2421 qemu_mutex_lock(&mon_fdsets_lock);
2422 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2423 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2424 FdsetFdInfoList *fdsetfd_list = NULL;
2426 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2427 fdset_info->value->fdset_id = mon_fdset->id;
2429 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2430 FdsetFdInfoList *fdsetfd_info;
2432 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2433 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2434 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2435 if (mon_fdset_fd->opaque) {
2436 fdsetfd_info->value->has_opaque = true;
2437 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2438 } else {
2439 fdsetfd_info->value->has_opaque = false;
2442 fdsetfd_info->next = fdsetfd_list;
2443 fdsetfd_list = fdsetfd_info;
2446 fdset_info->value->fds = fdsetfd_list;
2448 fdset_info->next = fdset_list;
2449 fdset_list = fdset_info;
2451 qemu_mutex_unlock(&mon_fdsets_lock);
2453 return fdset_list;
2456 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2457 bool has_opaque, const char *opaque,
2458 Error **errp)
2460 MonFdset *mon_fdset = NULL;
2461 MonFdsetFd *mon_fdset_fd;
2462 AddfdInfo *fdinfo;
2464 qemu_mutex_lock(&mon_fdsets_lock);
2465 if (has_fdset_id) {
2466 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2467 /* Break if match found or match impossible due to ordering by ID */
2468 if (fdset_id <= mon_fdset->id) {
2469 if (fdset_id < mon_fdset->id) {
2470 mon_fdset = NULL;
2472 break;
2477 if (mon_fdset == NULL) {
2478 int64_t fdset_id_prev = -1;
2479 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2481 if (has_fdset_id) {
2482 if (fdset_id < 0) {
2483 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2484 "a non-negative value");
2485 qemu_mutex_unlock(&mon_fdsets_lock);
2486 return NULL;
2488 /* Use specified fdset ID */
2489 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2490 mon_fdset_cur = mon_fdset;
2491 if (fdset_id < mon_fdset_cur->id) {
2492 break;
2495 } else {
2496 /* Use first available fdset ID */
2497 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2498 mon_fdset_cur = mon_fdset;
2499 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2500 fdset_id_prev = mon_fdset_cur->id;
2501 continue;
2503 break;
2507 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2508 if (has_fdset_id) {
2509 mon_fdset->id = fdset_id;
2510 } else {
2511 mon_fdset->id = fdset_id_prev + 1;
2514 /* The fdset list is ordered by fdset ID */
2515 if (!mon_fdset_cur) {
2516 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2517 } else if (mon_fdset->id < mon_fdset_cur->id) {
2518 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2519 } else {
2520 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2524 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2525 mon_fdset_fd->fd = fd;
2526 mon_fdset_fd->removed = false;
2527 if (has_opaque) {
2528 mon_fdset_fd->opaque = g_strdup(opaque);
2530 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2532 fdinfo = g_malloc0(sizeof(*fdinfo));
2533 fdinfo->fdset_id = mon_fdset->id;
2534 fdinfo->fd = mon_fdset_fd->fd;
2536 qemu_mutex_unlock(&mon_fdsets_lock);
2537 return fdinfo;
2540 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2542 #ifdef _WIN32
2543 return -ENOENT;
2544 #else
2545 MonFdset *mon_fdset;
2546 MonFdsetFd *mon_fdset_fd;
2547 int mon_fd_flags;
2548 int ret;
2550 qemu_mutex_lock(&mon_fdsets_lock);
2551 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2552 if (mon_fdset->id != fdset_id) {
2553 continue;
2555 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2556 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2557 if (mon_fd_flags == -1) {
2558 ret = -errno;
2559 goto out;
2562 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2563 ret = mon_fdset_fd->fd;
2564 goto out;
2567 ret = -EACCES;
2568 goto out;
2570 ret = -ENOENT;
2572 out:
2573 qemu_mutex_unlock(&mon_fdsets_lock);
2574 return ret;
2575 #endif
2578 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2580 MonFdset *mon_fdset;
2581 MonFdsetFd *mon_fdset_fd_dup;
2583 qemu_mutex_lock(&mon_fdsets_lock);
2584 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2585 if (mon_fdset->id != fdset_id) {
2586 continue;
2588 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2589 if (mon_fdset_fd_dup->fd == dup_fd) {
2590 goto err;
2593 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2594 mon_fdset_fd_dup->fd = dup_fd;
2595 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2596 qemu_mutex_unlock(&mon_fdsets_lock);
2597 return 0;
2600 err:
2601 qemu_mutex_unlock(&mon_fdsets_lock);
2602 return -1;
2605 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2607 MonFdset *mon_fdset;
2608 MonFdsetFd *mon_fdset_fd_dup;
2610 qemu_mutex_lock(&mon_fdsets_lock);
2611 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2612 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2613 if (mon_fdset_fd_dup->fd == dup_fd) {
2614 if (remove) {
2615 QLIST_REMOVE(mon_fdset_fd_dup, next);
2616 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2617 monitor_fdset_cleanup(mon_fdset);
2619 goto err;
2620 } else {
2621 qemu_mutex_unlock(&mon_fdsets_lock);
2622 return mon_fdset->id;
2628 err:
2629 qemu_mutex_unlock(&mon_fdsets_lock);
2630 return -1;
2633 int monitor_fdset_dup_fd_find(int dup_fd)
2635 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2638 void monitor_fdset_dup_fd_remove(int dup_fd)
2640 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2643 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2645 int fd;
2646 Error *local_err = NULL;
2648 if (!qemu_isdigit(fdname[0]) && mon) {
2649 fd = monitor_get_fd(mon, fdname, &local_err);
2650 } else {
2651 fd = qemu_parse_fd(fdname);
2652 if (fd == -1) {
2653 error_setg(&local_err, "Invalid file descriptor number '%s'",
2654 fdname);
2657 if (local_err) {
2658 error_propagate(errp, local_err);
2659 assert(fd == -1);
2660 } else {
2661 assert(fd != -1);
2664 return fd;
2667 /* Please update hmp-commands.hx when adding or changing commands */
2668 static mon_cmd_t info_cmds[] = {
2669 #include "hmp-commands-info.h"
2670 { NULL, NULL, },
2673 /* mon_cmds and info_cmds would be sorted at runtime */
2674 static mon_cmd_t mon_cmds[] = {
2675 #include "hmp-commands.h"
2676 { NULL, NULL, },
2679 /*******************************************************************/
2681 static const char *pch;
2682 static sigjmp_buf expr_env;
2685 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2686 expr_error(Monitor *mon, const char *fmt, ...)
2688 va_list ap;
2689 va_start(ap, fmt);
2690 monitor_vprintf(mon, fmt, ap);
2691 monitor_printf(mon, "\n");
2692 va_end(ap);
2693 siglongjmp(expr_env, 1);
2696 /* return 0 if OK, -1 if not found */
2697 static int get_monitor_def(target_long *pval, const char *name)
2699 const MonitorDef *md = target_monitor_defs();
2700 CPUState *cs = mon_get_cpu();
2701 void *ptr;
2702 uint64_t tmp = 0;
2703 int ret;
2705 if (cs == NULL || md == NULL) {
2706 return -1;
2709 for(; md->name != NULL; md++) {
2710 if (compare_cmd(name, md->name)) {
2711 if (md->get_value) {
2712 *pval = md->get_value(md, md->offset);
2713 } else {
2714 CPUArchState *env = mon_get_cpu_env();
2715 ptr = (uint8_t *)env + md->offset;
2716 switch(md->type) {
2717 case MD_I32:
2718 *pval = *(int32_t *)ptr;
2719 break;
2720 case MD_TLONG:
2721 *pval = *(target_long *)ptr;
2722 break;
2723 default:
2724 *pval = 0;
2725 break;
2728 return 0;
2732 ret = target_get_monitor_def(cs, name, &tmp);
2733 if (!ret) {
2734 *pval = (target_long) tmp;
2737 return ret;
2740 static void next(void)
2742 if (*pch != '\0') {
2743 pch++;
2744 while (qemu_isspace(*pch))
2745 pch++;
2749 static int64_t expr_sum(Monitor *mon);
2751 static int64_t expr_unary(Monitor *mon)
2753 int64_t n;
2754 char *p;
2755 int ret;
2757 switch(*pch) {
2758 case '+':
2759 next();
2760 n = expr_unary(mon);
2761 break;
2762 case '-':
2763 next();
2764 n = -expr_unary(mon);
2765 break;
2766 case '~':
2767 next();
2768 n = ~expr_unary(mon);
2769 break;
2770 case '(':
2771 next();
2772 n = expr_sum(mon);
2773 if (*pch != ')') {
2774 expr_error(mon, "')' expected");
2776 next();
2777 break;
2778 case '\'':
2779 pch++;
2780 if (*pch == '\0')
2781 expr_error(mon, "character constant expected");
2782 n = *pch;
2783 pch++;
2784 if (*pch != '\'')
2785 expr_error(mon, "missing terminating \' character");
2786 next();
2787 break;
2788 case '$':
2790 char buf[128], *q;
2791 target_long reg=0;
2793 pch++;
2794 q = buf;
2795 while ((*pch >= 'a' && *pch <= 'z') ||
2796 (*pch >= 'A' && *pch <= 'Z') ||
2797 (*pch >= '0' && *pch <= '9') ||
2798 *pch == '_' || *pch == '.') {
2799 if ((q - buf) < sizeof(buf) - 1)
2800 *q++ = *pch;
2801 pch++;
2803 while (qemu_isspace(*pch))
2804 pch++;
2805 *q = 0;
2806 ret = get_monitor_def(&reg, buf);
2807 if (ret < 0)
2808 expr_error(mon, "unknown register");
2809 n = reg;
2811 break;
2812 case '\0':
2813 expr_error(mon, "unexpected end of expression");
2814 n = 0;
2815 break;
2816 default:
2817 errno = 0;
2818 n = strtoull(pch, &p, 0);
2819 if (errno == ERANGE) {
2820 expr_error(mon, "number too large");
2822 if (pch == p) {
2823 expr_error(mon, "invalid char '%c' in expression", *p);
2825 pch = p;
2826 while (qemu_isspace(*pch))
2827 pch++;
2828 break;
2830 return n;
2834 static int64_t expr_prod(Monitor *mon)
2836 int64_t val, val2;
2837 int op;
2839 val = expr_unary(mon);
2840 for(;;) {
2841 op = *pch;
2842 if (op != '*' && op != '/' && op != '%')
2843 break;
2844 next();
2845 val2 = expr_unary(mon);
2846 switch(op) {
2847 default:
2848 case '*':
2849 val *= val2;
2850 break;
2851 case '/':
2852 case '%':
2853 if (val2 == 0)
2854 expr_error(mon, "division by zero");
2855 if (op == '/')
2856 val /= val2;
2857 else
2858 val %= val2;
2859 break;
2862 return val;
2865 static int64_t expr_logic(Monitor *mon)
2867 int64_t val, val2;
2868 int op;
2870 val = expr_prod(mon);
2871 for(;;) {
2872 op = *pch;
2873 if (op != '&' && op != '|' && op != '^')
2874 break;
2875 next();
2876 val2 = expr_prod(mon);
2877 switch(op) {
2878 default:
2879 case '&':
2880 val &= val2;
2881 break;
2882 case '|':
2883 val |= val2;
2884 break;
2885 case '^':
2886 val ^= val2;
2887 break;
2890 return val;
2893 static int64_t expr_sum(Monitor *mon)
2895 int64_t val, val2;
2896 int op;
2898 val = expr_logic(mon);
2899 for(;;) {
2900 op = *pch;
2901 if (op != '+' && op != '-')
2902 break;
2903 next();
2904 val2 = expr_logic(mon);
2905 if (op == '+')
2906 val += val2;
2907 else
2908 val -= val2;
2910 return val;
2913 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2915 pch = *pp;
2916 if (sigsetjmp(expr_env, 0)) {
2917 *pp = pch;
2918 return -1;
2920 while (qemu_isspace(*pch))
2921 pch++;
2922 *pval = expr_sum(mon);
2923 *pp = pch;
2924 return 0;
2927 static int get_double(Monitor *mon, double *pval, const char **pp)
2929 const char *p = *pp;
2930 char *tailp;
2931 double d;
2933 d = strtod(p, &tailp);
2934 if (tailp == p) {
2935 monitor_printf(mon, "Number expected\n");
2936 return -1;
2938 if (d != d || d - d != 0) {
2939 /* NaN or infinity */
2940 monitor_printf(mon, "Bad number\n");
2941 return -1;
2943 *pval = d;
2944 *pp = tailp;
2945 return 0;
2949 * Store the command-name in cmdname, and return a pointer to
2950 * the remaining of the command string.
2952 static const char *get_command_name(const char *cmdline,
2953 char *cmdname, size_t nlen)
2955 size_t len;
2956 const char *p, *pstart;
2958 p = cmdline;
2959 while (qemu_isspace(*p))
2960 p++;
2961 if (*p == '\0')
2962 return NULL;
2963 pstart = p;
2964 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2965 p++;
2966 len = p - pstart;
2967 if (len > nlen - 1)
2968 len = nlen - 1;
2969 memcpy(cmdname, pstart, len);
2970 cmdname[len] = '\0';
2971 return p;
2975 * Read key of 'type' into 'key' and return the current
2976 * 'type' pointer.
2978 static char *key_get_info(const char *type, char **key)
2980 size_t len;
2981 char *p, *str;
2983 if (*type == ',')
2984 type++;
2986 p = strchr(type, ':');
2987 if (!p) {
2988 *key = NULL;
2989 return NULL;
2991 len = p - type;
2993 str = g_malloc(len + 1);
2994 memcpy(str, type, len);
2995 str[len] = '\0';
2997 *key = str;
2998 return ++p;
3001 static int default_fmt_format = 'x';
3002 static int default_fmt_size = 4;
3004 static int is_valid_option(const char *c, const char *typestr)
3006 char option[3];
3008 option[0] = '-';
3009 option[1] = *c;
3010 option[2] = '\0';
3012 typestr = strstr(typestr, option);
3013 return (typestr != NULL);
3016 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
3017 const char *cmdname)
3019 const mon_cmd_t *cmd;
3021 for (cmd = disp_table; cmd->name != NULL; cmd++) {
3022 if (compare_cmd(cmdname, cmd->name)) {
3023 return cmd;
3027 return NULL;
3031 * Parse command name from @cmdp according to command table @table.
3032 * If blank, return NULL.
3033 * Else, if no valid command can be found, report to @mon, and return
3034 * NULL.
3035 * Else, change @cmdp to point right behind the name, and return its
3036 * command table entry.
3037 * Do not assume the return value points into @table! It doesn't when
3038 * the command is found in a sub-command table.
3040 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
3041 const char *cmdp_start,
3042 const char **cmdp,
3043 mon_cmd_t *table)
3045 const char *p;
3046 const mon_cmd_t *cmd;
3047 char cmdname[256];
3049 /* extract the command name */
3050 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
3051 if (!p)
3052 return NULL;
3054 cmd = search_dispatch_table(table, cmdname);
3055 if (!cmd) {
3056 monitor_printf(mon, "unknown command: '%.*s'\n",
3057 (int)(p - cmdp_start), cmdp_start);
3058 return NULL;
3060 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
3061 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
3062 "until after exit_preconfig.\n",
3063 (int)(p - cmdp_start), cmdp_start);
3064 return NULL;
3067 /* filter out following useless space */
3068 while (qemu_isspace(*p)) {
3069 p++;
3072 *cmdp = p;
3073 /* search sub command */
3074 if (cmd->sub_table != NULL && *p != '\0') {
3075 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3078 return cmd;
3082 * Parse arguments for @cmd.
3083 * If it can't be parsed, report to @mon, and return NULL.
3084 * Else, insert command arguments into a QDict, and return it.
3085 * Note: On success, caller has to free the QDict structure.
3088 static QDict *monitor_parse_arguments(Monitor *mon,
3089 const char **endp,
3090 const mon_cmd_t *cmd)
3092 const char *typestr;
3093 char *key;
3094 int c;
3095 const char *p = *endp;
3096 char buf[1024];
3097 QDict *qdict = qdict_new();
3099 /* parse the parameters */
3100 typestr = cmd->args_type;
3101 for(;;) {
3102 typestr = key_get_info(typestr, &key);
3103 if (!typestr)
3104 break;
3105 c = *typestr;
3106 typestr++;
3107 switch(c) {
3108 case 'F':
3109 case 'B':
3110 case 's':
3112 int ret;
3114 while (qemu_isspace(*p))
3115 p++;
3116 if (*typestr == '?') {
3117 typestr++;
3118 if (*p == '\0') {
3119 /* no optional string: NULL argument */
3120 break;
3123 ret = get_str(buf, sizeof(buf), &p);
3124 if (ret < 0) {
3125 switch(c) {
3126 case 'F':
3127 monitor_printf(mon, "%s: filename expected\n",
3128 cmd->name);
3129 break;
3130 case 'B':
3131 monitor_printf(mon, "%s: block device name expected\n",
3132 cmd->name);
3133 break;
3134 default:
3135 monitor_printf(mon, "%s: string expected\n", cmd->name);
3136 break;
3138 goto fail;
3140 qdict_put_str(qdict, key, buf);
3142 break;
3143 case 'O':
3145 QemuOptsList *opts_list;
3146 QemuOpts *opts;
3148 opts_list = qemu_find_opts(key);
3149 if (!opts_list || opts_list->desc->name) {
3150 goto bad_type;
3152 while (qemu_isspace(*p)) {
3153 p++;
3155 if (!*p)
3156 break;
3157 if (get_str(buf, sizeof(buf), &p) < 0) {
3158 goto fail;
3160 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3161 if (!opts) {
3162 goto fail;
3164 qemu_opts_to_qdict(opts, qdict);
3165 qemu_opts_del(opts);
3167 break;
3168 case '/':
3170 int count, format, size;
3172 while (qemu_isspace(*p))
3173 p++;
3174 if (*p == '/') {
3175 /* format found */
3176 p++;
3177 count = 1;
3178 if (qemu_isdigit(*p)) {
3179 count = 0;
3180 while (qemu_isdigit(*p)) {
3181 count = count * 10 + (*p - '0');
3182 p++;
3185 size = -1;
3186 format = -1;
3187 for(;;) {
3188 switch(*p) {
3189 case 'o':
3190 case 'd':
3191 case 'u':
3192 case 'x':
3193 case 'i':
3194 case 'c':
3195 format = *p++;
3196 break;
3197 case 'b':
3198 size = 1;
3199 p++;
3200 break;
3201 case 'h':
3202 size = 2;
3203 p++;
3204 break;
3205 case 'w':
3206 size = 4;
3207 p++;
3208 break;
3209 case 'g':
3210 case 'L':
3211 size = 8;
3212 p++;
3213 break;
3214 default:
3215 goto next;
3218 next:
3219 if (*p != '\0' && !qemu_isspace(*p)) {
3220 monitor_printf(mon, "invalid char in format: '%c'\n",
3221 *p);
3222 goto fail;
3224 if (format < 0)
3225 format = default_fmt_format;
3226 if (format != 'i') {
3227 /* for 'i', not specifying a size gives -1 as size */
3228 if (size < 0)
3229 size = default_fmt_size;
3230 default_fmt_size = size;
3232 default_fmt_format = format;
3233 } else {
3234 count = 1;
3235 format = default_fmt_format;
3236 if (format != 'i') {
3237 size = default_fmt_size;
3238 } else {
3239 size = -1;
3242 qdict_put_int(qdict, "count", count);
3243 qdict_put_int(qdict, "format", format);
3244 qdict_put_int(qdict, "size", size);
3246 break;
3247 case 'i':
3248 case 'l':
3249 case 'M':
3251 int64_t val;
3253 while (qemu_isspace(*p))
3254 p++;
3255 if (*typestr == '?' || *typestr == '.') {
3256 if (*typestr == '?') {
3257 if (*p == '\0') {
3258 typestr++;
3259 break;
3261 } else {
3262 if (*p == '.') {
3263 p++;
3264 while (qemu_isspace(*p))
3265 p++;
3266 } else {
3267 typestr++;
3268 break;
3271 typestr++;
3273 if (get_expr(mon, &val, &p))
3274 goto fail;
3275 /* Check if 'i' is greater than 32-bit */
3276 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3277 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3278 monitor_printf(mon, "integer is for 32-bit values\n");
3279 goto fail;
3280 } else if (c == 'M') {
3281 if (val < 0) {
3282 monitor_printf(mon, "enter a positive value\n");
3283 goto fail;
3285 val *= MiB;
3287 qdict_put_int(qdict, key, val);
3289 break;
3290 case 'o':
3292 int ret;
3293 uint64_t val;
3294 const char *end;
3296 while (qemu_isspace(*p)) {
3297 p++;
3299 if (*typestr == '?') {
3300 typestr++;
3301 if (*p == '\0') {
3302 break;
3305 ret = qemu_strtosz_MiB(p, &end, &val);
3306 if (ret < 0 || val > INT64_MAX) {
3307 monitor_printf(mon, "invalid size\n");
3308 goto fail;
3310 qdict_put_int(qdict, key, val);
3311 p = end;
3313 break;
3314 case 'T':
3316 double val;
3318 while (qemu_isspace(*p))
3319 p++;
3320 if (*typestr == '?') {
3321 typestr++;
3322 if (*p == '\0') {
3323 break;
3326 if (get_double(mon, &val, &p) < 0) {
3327 goto fail;
3329 if (p[0] && p[1] == 's') {
3330 switch (*p) {
3331 case 'm':
3332 val /= 1e3; p += 2; break;
3333 case 'u':
3334 val /= 1e6; p += 2; break;
3335 case 'n':
3336 val /= 1e9; p += 2; break;
3339 if (*p && !qemu_isspace(*p)) {
3340 monitor_printf(mon, "Unknown unit suffix\n");
3341 goto fail;
3343 qdict_put(qdict, key, qnum_from_double(val));
3345 break;
3346 case 'b':
3348 const char *beg;
3349 bool val;
3351 while (qemu_isspace(*p)) {
3352 p++;
3354 beg = p;
3355 while (qemu_isgraph(*p)) {
3356 p++;
3358 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3359 val = true;
3360 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3361 val = false;
3362 } else {
3363 monitor_printf(mon, "Expected 'on' or 'off'\n");
3364 goto fail;
3366 qdict_put_bool(qdict, key, val);
3368 break;
3369 case '-':
3371 const char *tmp = p;
3372 int skip_key = 0;
3373 /* option */
3375 c = *typestr++;
3376 if (c == '\0')
3377 goto bad_type;
3378 while (qemu_isspace(*p))
3379 p++;
3380 if (*p == '-') {
3381 p++;
3382 if(c != *p) {
3383 if(!is_valid_option(p, typestr)) {
3385 monitor_printf(mon, "%s: unsupported option -%c\n",
3386 cmd->name, *p);
3387 goto fail;
3388 } else {
3389 skip_key = 1;
3392 if(skip_key) {
3393 p = tmp;
3394 } else {
3395 /* has option */
3396 p++;
3397 qdict_put_bool(qdict, key, true);
3401 break;
3402 case 'S':
3404 /* package all remaining string */
3405 int len;
3407 while (qemu_isspace(*p)) {
3408 p++;
3410 if (*typestr == '?') {
3411 typestr++;
3412 if (*p == '\0') {
3413 /* no remaining string: NULL argument */
3414 break;
3417 len = strlen(p);
3418 if (len <= 0) {
3419 monitor_printf(mon, "%s: string expected\n",
3420 cmd->name);
3421 goto fail;
3423 qdict_put_str(qdict, key, p);
3424 p += len;
3426 break;
3427 default:
3428 bad_type:
3429 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3430 goto fail;
3432 g_free(key);
3433 key = NULL;
3435 /* check that all arguments were parsed */
3436 while (qemu_isspace(*p))
3437 p++;
3438 if (*p != '\0') {
3439 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3440 cmd->name);
3441 goto fail;
3444 return qdict;
3446 fail:
3447 qobject_unref(qdict);
3448 g_free(key);
3449 return NULL;
3452 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3454 QDict *qdict;
3455 const mon_cmd_t *cmd;
3456 const char *cmd_start = cmdline;
3458 trace_handle_hmp_command(mon, cmdline);
3460 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3461 if (!cmd) {
3462 return;
3465 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3466 if (!qdict) {
3467 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3468 cmdline--;
3470 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3471 (int)(cmdline - cmd_start), cmd_start);
3472 return;
3475 cmd->cmd(mon, qdict);
3476 qobject_unref(qdict);
3479 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3481 const char *p, *pstart;
3482 char cmd[128];
3483 int len;
3485 p = list;
3486 for(;;) {
3487 pstart = p;
3488 p = qemu_strchrnul(p, '|');
3489 len = p - pstart;
3490 if (len > sizeof(cmd) - 2)
3491 len = sizeof(cmd) - 2;
3492 memcpy(cmd, pstart, len);
3493 cmd[len] = '\0';
3494 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3495 readline_add_completion(mon->rs, cmd);
3497 if (*p == '\0')
3498 break;
3499 p++;
3503 static void file_completion(Monitor *mon, const char *input)
3505 DIR *ffs;
3506 struct dirent *d;
3507 char path[1024];
3508 char file[1024], file_prefix[1024];
3509 int input_path_len;
3510 const char *p;
3512 p = strrchr(input, '/');
3513 if (!p) {
3514 input_path_len = 0;
3515 pstrcpy(file_prefix, sizeof(file_prefix), input);
3516 pstrcpy(path, sizeof(path), ".");
3517 } else {
3518 input_path_len = p - input + 1;
3519 memcpy(path, input, input_path_len);
3520 if (input_path_len > sizeof(path) - 1)
3521 input_path_len = sizeof(path) - 1;
3522 path[input_path_len] = '\0';
3523 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3526 ffs = opendir(path);
3527 if (!ffs)
3528 return;
3529 for(;;) {
3530 struct stat sb;
3531 d = readdir(ffs);
3532 if (!d)
3533 break;
3535 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3536 continue;
3539 if (strstart(d->d_name, file_prefix, NULL)) {
3540 memcpy(file, input, input_path_len);
3541 if (input_path_len < sizeof(file))
3542 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3543 d->d_name);
3544 /* stat the file to find out if it's a directory.
3545 * In that case add a slash to speed up typing long paths
3547 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3548 pstrcat(file, sizeof(file), "/");
3550 readline_add_completion(mon->rs, file);
3553 closedir(ffs);
3556 static const char *next_arg_type(const char *typestr)
3558 const char *p = strchr(typestr, ':');
3559 return (p != NULL ? ++p : typestr);
3562 static void add_completion_option(ReadLineState *rs, const char *str,
3563 const char *option)
3565 if (!str || !option) {
3566 return;
3568 if (!strncmp(option, str, strlen(str))) {
3569 readline_add_completion(rs, option);
3573 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3575 size_t len;
3576 ChardevBackendInfoList *list, *start;
3578 if (nb_args != 2) {
3579 return;
3581 len = strlen(str);
3582 readline_set_completion_index(rs, len);
3584 start = list = qmp_query_chardev_backends(NULL);
3585 while (list) {
3586 const char *chr_name = list->value->name;
3588 if (!strncmp(chr_name, str, len)) {
3589 readline_add_completion(rs, chr_name);
3591 list = list->next;
3593 qapi_free_ChardevBackendInfoList(start);
3596 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3598 size_t len;
3599 int i;
3601 if (nb_args != 2) {
3602 return;
3604 len = strlen(str);
3605 readline_set_completion_index(rs, len);
3606 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3607 add_completion_option(rs, str, NetClientDriver_str(i));
3611 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3613 GSList *list, *elt;
3614 size_t len;
3616 if (nb_args != 2) {
3617 return;
3620 len = strlen(str);
3621 readline_set_completion_index(rs, len);
3622 list = elt = object_class_get_list(TYPE_DEVICE, false);
3623 while (elt) {
3624 const char *name;
3625 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3626 TYPE_DEVICE);
3627 name = object_class_get_name(OBJECT_CLASS(dc));
3629 if (dc->user_creatable
3630 && !strncmp(name, str, len)) {
3631 readline_add_completion(rs, name);
3633 elt = elt->next;
3635 g_slist_free(list);
3638 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3640 GSList *list, *elt;
3641 size_t len;
3643 if (nb_args != 2) {
3644 return;
3647 len = strlen(str);
3648 readline_set_completion_index(rs, len);
3649 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3650 while (elt) {
3651 const char *name;
3653 name = object_class_get_name(OBJECT_CLASS(elt->data));
3654 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3655 readline_add_completion(rs, name);
3657 elt = elt->next;
3659 g_slist_free(list);
3662 static void peripheral_device_del_completion(ReadLineState *rs,
3663 const char *str, size_t len)
3665 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3666 GSList *list, *item;
3668 list = qdev_build_hotpluggable_device_list(peripheral);
3669 if (!list) {
3670 return;
3673 for (item = list; item; item = g_slist_next(item)) {
3674 DeviceState *dev = item->data;
3676 if (dev->id && !strncmp(str, dev->id, len)) {
3677 readline_add_completion(rs, dev->id);
3681 g_slist_free(list);
3684 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3686 size_t len;
3687 ChardevInfoList *list, *start;
3689 if (nb_args != 2) {
3690 return;
3692 len = strlen(str);
3693 readline_set_completion_index(rs, len);
3695 start = list = qmp_query_chardev(NULL);
3696 while (list) {
3697 ChardevInfo *chr = list->value;
3699 if (!strncmp(chr->label, str, len)) {
3700 readline_add_completion(rs, chr->label);
3702 list = list->next;
3704 qapi_free_ChardevInfoList(start);
3707 static void ringbuf_completion(ReadLineState *rs, const char *str)
3709 size_t len;
3710 ChardevInfoList *list, *start;
3712 len = strlen(str);
3713 readline_set_completion_index(rs, len);
3715 start = list = qmp_query_chardev(NULL);
3716 while (list) {
3717 ChardevInfo *chr_info = list->value;
3719 if (!strncmp(chr_info->label, str, len)) {
3720 Chardev *chr = qemu_chr_find(chr_info->label);
3721 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3722 readline_add_completion(rs, chr_info->label);
3725 list = list->next;
3727 qapi_free_ChardevInfoList(start);
3730 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3732 if (nb_args != 2) {
3733 return;
3735 ringbuf_completion(rs, str);
3738 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3740 size_t len;
3742 if (nb_args != 2) {
3743 return;
3746 len = strlen(str);
3747 readline_set_completion_index(rs, len);
3748 peripheral_device_del_completion(rs, str, len);
3751 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3753 ObjectPropertyInfoList *list, *start;
3754 size_t len;
3756 if (nb_args != 2) {
3757 return;
3759 len = strlen(str);
3760 readline_set_completion_index(rs, len);
3762 start = list = qmp_qom_list("/objects", NULL);
3763 while (list) {
3764 ObjectPropertyInfo *info = list->value;
3766 if (!strncmp(info->type, "child<", 5)
3767 && !strncmp(info->name, str, len)) {
3768 readline_add_completion(rs, info->name);
3770 list = list->next;
3772 qapi_free_ObjectPropertyInfoList(start);
3775 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3777 int i;
3778 char *sep;
3779 size_t len;
3781 if (nb_args != 2) {
3782 return;
3784 sep = strrchr(str, '-');
3785 if (sep) {
3786 str = sep + 1;
3788 len = strlen(str);
3789 readline_set_completion_index(rs, len);
3790 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3791 if (!strncmp(str, QKeyCode_str(i), len)) {
3792 readline_add_completion(rs, QKeyCode_str(i));
3797 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3799 size_t len;
3801 len = strlen(str);
3802 readline_set_completion_index(rs, len);
3803 if (nb_args == 2) {
3804 NetClientState *ncs[MAX_QUEUE_NUM];
3805 int count, i;
3806 count = qemu_find_net_clients_except(NULL, ncs,
3807 NET_CLIENT_DRIVER_NONE,
3808 MAX_QUEUE_NUM);
3809 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3810 const char *name = ncs[i]->name;
3811 if (!strncmp(str, name, len)) {
3812 readline_add_completion(rs, name);
3815 } else if (nb_args == 3) {
3816 add_completion_option(rs, str, "on");
3817 add_completion_option(rs, str, "off");
3821 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3823 int len, count, i;
3824 NetClientState *ncs[MAX_QUEUE_NUM];
3826 if (nb_args != 2) {
3827 return;
3830 len = strlen(str);
3831 readline_set_completion_index(rs, len);
3832 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3833 MAX_QUEUE_NUM);
3834 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3835 QemuOpts *opts;
3836 const char *name = ncs[i]->name;
3837 if (strncmp(str, name, len)) {
3838 continue;
3840 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3841 if (opts) {
3842 readline_add_completion(rs, name);
3847 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3849 size_t len;
3851 len = strlen(str);
3852 readline_set_completion_index(rs, len);
3853 if (nb_args == 2) {
3854 TraceEventIter iter;
3855 TraceEvent *ev;
3856 char *pattern = g_strdup_printf("%s*", str);
3857 trace_event_iter_init(&iter, pattern);
3858 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3859 readline_add_completion(rs, trace_event_get_name(ev));
3861 g_free(pattern);
3865 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3867 size_t len;
3869 len = strlen(str);
3870 readline_set_completion_index(rs, len);
3871 if (nb_args == 2) {
3872 TraceEventIter iter;
3873 TraceEvent *ev;
3874 char *pattern = g_strdup_printf("%s*", str);
3875 trace_event_iter_init(&iter, pattern);
3876 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3877 readline_add_completion(rs, trace_event_get_name(ev));
3879 g_free(pattern);
3880 } else if (nb_args == 3) {
3881 add_completion_option(rs, str, "on");
3882 add_completion_option(rs, str, "off");
3886 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3888 int i;
3890 if (nb_args != 2) {
3891 return;
3893 readline_set_completion_index(rs, strlen(str));
3894 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3895 add_completion_option(rs, str, WatchdogAction_str(i));
3899 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3900 const char *str)
3902 size_t len;
3904 len = strlen(str);
3905 readline_set_completion_index(rs, len);
3906 if (nb_args == 2) {
3907 int i;
3908 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3909 const char *name = MigrationCapability_str(i);
3910 if (!strncmp(str, name, len)) {
3911 readline_add_completion(rs, name);
3914 } else if (nb_args == 3) {
3915 add_completion_option(rs, str, "on");
3916 add_completion_option(rs, str, "off");
3920 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3921 const char *str)
3923 size_t len;
3925 len = strlen(str);
3926 readline_set_completion_index(rs, len);
3927 if (nb_args == 2) {
3928 int i;
3929 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3930 const char *name = MigrationParameter_str(i);
3931 if (!strncmp(str, name, len)) {
3932 readline_add_completion(rs, name);
3938 static void vm_completion(ReadLineState *rs, const char *str)
3940 size_t len;
3941 BlockDriverState *bs;
3942 BdrvNextIterator it;
3944 len = strlen(str);
3945 readline_set_completion_index(rs, len);
3947 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3948 SnapshotInfoList *snapshots, *snapshot;
3949 AioContext *ctx = bdrv_get_aio_context(bs);
3950 bool ok = false;
3952 aio_context_acquire(ctx);
3953 if (bdrv_can_snapshot(bs)) {
3954 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3956 aio_context_release(ctx);
3957 if (!ok) {
3958 continue;
3961 snapshot = snapshots;
3962 while (snapshot) {
3963 char *completion = snapshot->value->name;
3964 if (!strncmp(str, completion, len)) {
3965 readline_add_completion(rs, completion);
3967 completion = snapshot->value->id;
3968 if (!strncmp(str, completion, len)) {
3969 readline_add_completion(rs, completion);
3971 snapshot = snapshot->next;
3973 qapi_free_SnapshotInfoList(snapshots);
3978 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3980 if (nb_args == 2) {
3981 vm_completion(rs, str);
3985 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3987 if (nb_args == 2) {
3988 vm_completion(rs, str);
3992 static void monitor_find_completion_by_table(Monitor *mon,
3993 const mon_cmd_t *cmd_table,
3994 char **args,
3995 int nb_args)
3997 const char *cmdname;
3998 int i;
3999 const char *ptype, *old_ptype, *str, *name;
4000 const mon_cmd_t *cmd;
4001 BlockBackend *blk = NULL;
4003 if (nb_args <= 1) {
4004 /* command completion */
4005 if (nb_args == 0)
4006 cmdname = "";
4007 else
4008 cmdname = args[0];
4009 readline_set_completion_index(mon->rs, strlen(cmdname));
4010 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4011 if (!runstate_check(RUN_STATE_PRECONFIG) ||
4012 cmd_can_preconfig(cmd)) {
4013 cmd_completion(mon, cmdname, cmd->name);
4016 } else {
4017 /* find the command */
4018 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4019 if (compare_cmd(args[0], cmd->name) &&
4020 (!runstate_check(RUN_STATE_PRECONFIG) ||
4021 cmd_can_preconfig(cmd))) {
4022 break;
4025 if (!cmd->name) {
4026 return;
4029 if (cmd->sub_table) {
4030 /* do the job again */
4031 monitor_find_completion_by_table(mon, cmd->sub_table,
4032 &args[1], nb_args - 1);
4033 return;
4035 if (cmd->command_completion) {
4036 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
4037 return;
4040 ptype = next_arg_type(cmd->args_type);
4041 for(i = 0; i < nb_args - 2; i++) {
4042 if (*ptype != '\0') {
4043 ptype = next_arg_type(ptype);
4044 while (*ptype == '?')
4045 ptype = next_arg_type(ptype);
4048 str = args[nb_args - 1];
4049 old_ptype = NULL;
4050 while (*ptype == '-' && old_ptype != ptype) {
4051 old_ptype = ptype;
4052 ptype = next_arg_type(ptype);
4054 switch(*ptype) {
4055 case 'F':
4056 /* file completion */
4057 readline_set_completion_index(mon->rs, strlen(str));
4058 file_completion(mon, str);
4059 break;
4060 case 'B':
4061 /* block device name completion */
4062 readline_set_completion_index(mon->rs, strlen(str));
4063 while ((blk = blk_next(blk)) != NULL) {
4064 name = blk_name(blk);
4065 if (str[0] == '\0' ||
4066 !strncmp(name, str, strlen(str))) {
4067 readline_add_completion(mon->rs, name);
4070 break;
4071 case 's':
4072 case 'S':
4073 if (!strcmp(cmd->name, "help|?")) {
4074 monitor_find_completion_by_table(mon, cmd_table,
4075 &args[1], nb_args - 1);
4077 break;
4078 default:
4079 break;
4084 static void monitor_find_completion(void *opaque,
4085 const char *cmdline)
4087 Monitor *mon = opaque;
4088 char *args[MAX_ARGS];
4089 int nb_args, len;
4091 /* 1. parse the cmdline */
4092 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4093 return;
4096 /* if the line ends with a space, it means we want to complete the
4097 next arg */
4098 len = strlen(cmdline);
4099 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4100 if (nb_args >= MAX_ARGS) {
4101 goto cleanup;
4103 args[nb_args++] = g_strdup("");
4106 /* 2. auto complete according to args */
4107 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4109 cleanup:
4110 free_cmdline_args(args, nb_args);
4113 static int monitor_can_read(void *opaque)
4115 Monitor *mon = opaque;
4117 return !atomic_mb_read(&mon->suspend_cnt);
4121 * Emit QMP response @rsp with ID @id to @mon.
4122 * Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
4123 * Nothing is emitted then.
4125 static void monitor_qmp_respond(Monitor *mon, QDict *rsp)
4127 if (rsp) {
4128 qmp_send_response(mon, rsp);
4132 static void monitor_qmp_dispatch(Monitor *mon, QObject *req)
4134 Monitor *old_mon;
4135 QDict *rsp;
4136 QDict *error;
4138 old_mon = cur_mon;
4139 cur_mon = mon;
4141 rsp = qmp_dispatch(mon->qmp.commands, req, qmp_oob_enabled(mon));
4143 cur_mon = old_mon;
4145 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
4146 error = qdict_get_qdict(rsp, "error");
4147 if (error
4148 && !g_strcmp0(qdict_get_try_str(error, "class"),
4149 QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
4150 /* Provide a more useful error message */
4151 qdict_del(error, "desc");
4152 qdict_put_str(error, "desc", "Expecting capabilities negotiation"
4153 " with 'qmp_capabilities'");
4157 monitor_qmp_respond(mon, rsp);
4158 qobject_unref(rsp);
4162 * Pop a QMP request from a monitor request queue.
4163 * Return the request, or NULL all request queues are empty.
4164 * We are using round-robin fashion to pop the request, to avoid
4165 * processing commands only on a very busy monitor. To achieve that,
4166 * when we process one request on a specific monitor, we put that
4167 * monitor to the end of mon_list queue.
4169 * Note: if the function returned with non-NULL, then the caller will
4170 * be with mon->qmp.qmp_queue_lock held, and the caller is responsible
4171 * to release it.
4173 static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void)
4175 QMPRequest *req_obj = NULL;
4176 Monitor *mon;
4178 qemu_mutex_lock(&monitor_lock);
4180 QTAILQ_FOREACH(mon, &mon_list, entry) {
4181 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4182 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4183 if (req_obj) {
4184 /* With the lock of corresponding queue held */
4185 break;
4187 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4190 if (req_obj) {
4192 * We found one request on the monitor. Degrade this monitor's
4193 * priority to lowest by re-inserting it to end of queue.
4195 QTAILQ_REMOVE(&mon_list, mon, entry);
4196 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4199 qemu_mutex_unlock(&monitor_lock);
4201 return req_obj;
4204 static void monitor_qmp_bh_dispatcher(void *data)
4206 QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock();
4207 QDict *rsp;
4208 bool need_resume;
4209 Monitor *mon;
4211 if (!req_obj) {
4212 return;
4215 mon = req_obj->mon;
4216 /* qmp_oob_enabled() might change after "qmp_capabilities" */
4217 need_resume = !qmp_oob_enabled(mon) ||
4218 mon->qmp.qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1;
4219 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4220 if (req_obj->req) {
4221 QDict *qdict = qobject_to(QDict, req_obj->req);
4222 QObject *id = qdict ? qdict_get(qdict, "id") : NULL;
4223 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(id) ?: "");
4224 monitor_qmp_dispatch(mon, req_obj->req);
4225 } else {
4226 assert(req_obj->err);
4227 rsp = qmp_error_response(req_obj->err);
4228 req_obj->err = NULL;
4229 monitor_qmp_respond(mon, rsp);
4230 qobject_unref(rsp);
4233 if (need_resume) {
4234 /* Pairs with the monitor_suspend() in handle_qmp_command() */
4235 monitor_resume(mon);
4237 qmp_request_free(req_obj);
4239 /* Reschedule instead of looping so the main loop stays responsive */
4240 qemu_bh_schedule(qmp_dispatcher_bh);
4243 static void handle_qmp_command(void *opaque, QObject *req, Error *err)
4245 Monitor *mon = opaque;
4246 QObject *id = NULL;
4247 QDict *qdict;
4248 QMPRequest *req_obj;
4250 assert(!req != !err);
4252 qdict = qobject_to(QDict, req);
4253 if (qdict) {
4254 id = qdict_get(qdict, "id");
4255 } /* else will fail qmp_dispatch() */
4257 if (req && trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4258 QString *req_json = qobject_to_json(req);
4259 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4260 qobject_unref(req_json);
4263 if (qdict && qmp_is_oob(qdict)) {
4264 /* OOB commands are executed immediately */
4265 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id) ?: "");
4266 monitor_qmp_dispatch(mon, req);
4267 qobject_unref(req);
4268 return;
4271 req_obj = g_new0(QMPRequest, 1);
4272 req_obj->mon = mon;
4273 req_obj->req = req;
4274 req_obj->err = err;
4276 /* Protect qmp_requests and fetching its length. */
4277 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4280 * Suspend the monitor when we can't queue more requests after
4281 * this one. Dequeuing in monitor_qmp_bh_dispatcher() will resume
4282 * it. Note that when OOB is disabled, we queue at most one
4283 * command, for backward compatibility.
4285 if (!qmp_oob_enabled(mon) ||
4286 mon->qmp.qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1) {
4287 monitor_suspend(mon);
4291 * Put the request to the end of queue so that requests will be
4292 * handled in time order. Ownership for req_obj, req,
4293 * etc. will be delivered to the handler side.
4295 assert(mon->qmp.qmp_requests->length < QMP_REQ_QUEUE_LEN_MAX);
4296 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4297 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4299 /* Kick the dispatcher routine */
4300 qemu_bh_schedule(qmp_dispatcher_bh);
4303 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4305 Monitor *mon = opaque;
4307 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4310 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4312 Monitor *old_mon = cur_mon;
4313 int i;
4315 cur_mon = opaque;
4317 if (cur_mon->rs) {
4318 for (i = 0; i < size; i++)
4319 readline_handle_byte(cur_mon->rs, buf[i]);
4320 } else {
4321 if (size == 0 || buf[size - 1] != 0)
4322 monitor_printf(cur_mon, "corrupted command\n");
4323 else
4324 handle_hmp_command(cur_mon, (char *)buf);
4327 cur_mon = old_mon;
4330 static void monitor_command_cb(void *opaque, const char *cmdline,
4331 void *readline_opaque)
4333 Monitor *mon = opaque;
4335 monitor_suspend(mon);
4336 handle_hmp_command(mon, cmdline);
4337 monitor_resume(mon);
4340 int monitor_suspend(Monitor *mon)
4342 if (monitor_is_hmp_non_interactive(mon)) {
4343 return -ENOTTY;
4346 atomic_inc(&mon->suspend_cnt);
4348 if (mon->use_io_thread) {
4350 * Kick I/O thread to make sure this takes effect. It'll be
4351 * evaluated again in prepare() of the watch object.
4353 aio_notify(iothread_get_aio_context(mon_iothread));
4356 trace_monitor_suspend(mon, 1);
4357 return 0;
4360 static void monitor_accept_input(void *opaque)
4362 Monitor *mon = opaque;
4364 qemu_chr_fe_accept_input(&mon->chr);
4367 void monitor_resume(Monitor *mon)
4369 if (monitor_is_hmp_non_interactive(mon)) {
4370 return;
4373 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4374 AioContext *ctx;
4376 if (mon->use_io_thread) {
4377 ctx = iothread_get_aio_context(mon_iothread);
4378 } else {
4379 ctx = qemu_get_aio_context();
4382 if (!monitor_is_qmp(mon)) {
4383 assert(mon->rs);
4384 readline_show_prompt(mon->rs);
4387 aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
4390 trace_monitor_suspend(mon, -1);
4393 static QDict *qmp_greeting(Monitor *mon)
4395 QList *cap_list = qlist_new();
4396 QObject *ver = NULL;
4397 QMPCapability cap;
4399 qmp_marshal_query_version(NULL, &ver, NULL);
4401 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4402 if (mon->qmp.capab_offered[cap]) {
4403 qlist_append_str(cap_list, QMPCapability_str(cap));
4407 return qdict_from_jsonf_nofail(
4408 "{'QMP': {'version': %p, 'capabilities': %p}}",
4409 ver, cap_list);
4412 static void monitor_qmp_event(void *opaque, int event)
4414 QDict *data;
4415 Monitor *mon = opaque;
4417 switch (event) {
4418 case CHR_EVENT_OPENED:
4419 mon->qmp.commands = &qmp_cap_negotiation_commands;
4420 monitor_qmp_caps_reset(mon);
4421 data = qmp_greeting(mon);
4422 qmp_send_response(mon, data);
4423 qobject_unref(data);
4424 mon_refcount++;
4425 break;
4426 case CHR_EVENT_CLOSED:
4428 * Note: this is only useful when the output of the chardev
4429 * backend is still open. For example, when the backend is
4430 * stdio, it's possible that stdout is still open when stdin
4431 * is closed.
4433 monitor_qmp_cleanup_queues(mon);
4434 json_message_parser_destroy(&mon->qmp.parser);
4435 json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
4436 mon, NULL);
4437 mon_refcount--;
4438 monitor_fdsets_cleanup();
4439 break;
4443 static void monitor_event(void *opaque, int event)
4445 Monitor *mon = opaque;
4447 switch (event) {
4448 case CHR_EVENT_MUX_IN:
4449 qemu_mutex_lock(&mon->mon_lock);
4450 mon->mux_out = 0;
4451 qemu_mutex_unlock(&mon->mon_lock);
4452 if (mon->reset_seen) {
4453 readline_restart(mon->rs);
4454 monitor_resume(mon);
4455 monitor_flush(mon);
4456 } else {
4457 atomic_mb_set(&mon->suspend_cnt, 0);
4459 break;
4461 case CHR_EVENT_MUX_OUT:
4462 if (mon->reset_seen) {
4463 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4464 monitor_printf(mon, "\n");
4466 monitor_flush(mon);
4467 monitor_suspend(mon);
4468 } else {
4469 atomic_inc(&mon->suspend_cnt);
4471 qemu_mutex_lock(&mon->mon_lock);
4472 mon->mux_out = 1;
4473 qemu_mutex_unlock(&mon->mon_lock);
4474 break;
4476 case CHR_EVENT_OPENED:
4477 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4478 "information\n", QEMU_VERSION);
4479 if (!mon->mux_out) {
4480 readline_restart(mon->rs);
4481 readline_show_prompt(mon->rs);
4483 mon->reset_seen = 1;
4484 mon_refcount++;
4485 break;
4487 case CHR_EVENT_CLOSED:
4488 mon_refcount--;
4489 monitor_fdsets_cleanup();
4490 break;
4494 static int
4495 compare_mon_cmd(const void *a, const void *b)
4497 return strcmp(((const mon_cmd_t *)a)->name,
4498 ((const mon_cmd_t *)b)->name);
4501 static void sortcmdlist(void)
4503 int array_num;
4504 int elem_size = sizeof(mon_cmd_t);
4506 array_num = sizeof(mon_cmds)/elem_size-1;
4507 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4509 array_num = sizeof(info_cmds)/elem_size-1;
4510 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4513 static void monitor_iothread_init(void)
4515 mon_iothread = iothread_create("mon_iothread", &error_abort);
4518 void monitor_init_globals(void)
4520 monitor_init_qmp_commands();
4521 monitor_qapi_event_init();
4522 sortcmdlist();
4523 qemu_mutex_init(&monitor_lock);
4524 qemu_mutex_init(&mon_fdsets_lock);
4527 * The dispatcher BH must run in the main loop thread, since we
4528 * have commands assuming that context. It would be nice to get
4529 * rid of those assumptions.
4531 qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4532 monitor_qmp_bh_dispatcher,
4533 NULL);
4536 /* These functions just adapt the readline interface in a typesafe way. We
4537 * could cast function pointers but that discards compiler checks.
4539 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4540 const char *fmt, ...)
4542 va_list ap;
4543 va_start(ap, fmt);
4544 monitor_vprintf(opaque, fmt, ap);
4545 va_end(ap);
4548 static void monitor_readline_flush(void *opaque)
4550 monitor_flush(opaque);
4554 * Print to current monitor if we have one, else to stderr.
4556 int error_vprintf(const char *fmt, va_list ap)
4558 if (cur_mon && !monitor_cur_is_qmp()) {
4559 return monitor_vprintf(cur_mon, fmt, ap);
4561 return vfprintf(stderr, fmt, ap);
4564 int error_vprintf_unless_qmp(const char *fmt, va_list ap)
4566 if (!cur_mon) {
4567 return vfprintf(stderr, fmt, ap);
4569 if (!monitor_cur_is_qmp()) {
4570 return monitor_vprintf(cur_mon, fmt, ap);
4572 return -1;
4575 static void monitor_list_append(Monitor *mon)
4577 qemu_mutex_lock(&monitor_lock);
4579 * This prevents inserting new monitors during monitor_cleanup().
4580 * A cleaner solution would involve the main thread telling other
4581 * threads to terminate, waiting for their termination.
4583 if (!monitor_destroyed) {
4584 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4585 mon = NULL;
4587 qemu_mutex_unlock(&monitor_lock);
4589 if (mon) {
4590 monitor_data_destroy(mon);
4591 g_free(mon);
4595 static void monitor_qmp_setup_handlers_bh(void *opaque)
4597 Monitor *mon = opaque;
4598 GMainContext *context;
4600 assert(mon->use_io_thread);
4601 context = iothread_get_g_main_context(mon_iothread);
4602 assert(context);
4603 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4604 monitor_qmp_event, NULL, mon, context, true);
4605 monitor_list_append(mon);
4608 void monitor_init(Chardev *chr, int flags)
4610 Monitor *mon = g_malloc(sizeof(*mon));
4611 bool use_readline = flags & MONITOR_USE_READLINE;
4613 /* Note: we run QMP monitor in I/O thread when @chr supports that */
4614 monitor_data_init(mon, false,
4615 (flags & MONITOR_USE_CONTROL)
4616 && qemu_chr_has_feature(chr,
4617 QEMU_CHAR_FEATURE_GCONTEXT));
4619 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4620 mon->flags = flags;
4621 if (use_readline) {
4622 mon->rs = readline_init(monitor_readline_printf,
4623 monitor_readline_flush,
4624 mon,
4625 monitor_find_completion);
4626 monitor_read_command(mon, 0);
4629 if (monitor_is_qmp(mon)) {
4630 qemu_chr_fe_set_echo(&mon->chr, true);
4631 json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
4632 mon, NULL);
4633 if (mon->use_io_thread) {
4635 * Make sure the old iowatch is gone. It's possible when
4636 * e.g. the chardev is in client mode, with wait=on.
4638 remove_fd_in_watch(chr);
4640 * We can't call qemu_chr_fe_set_handlers() directly here
4641 * since chardev might be running in the monitor I/O
4642 * thread. Schedule a bottom half.
4644 aio_bh_schedule_oneshot(iothread_get_aio_context(mon_iothread),
4645 monitor_qmp_setup_handlers_bh, mon);
4646 /* The bottom half will add @mon to @mon_list */
4647 return;
4648 } else {
4649 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4650 monitor_qmp_read, monitor_qmp_event,
4651 NULL, mon, NULL, true);
4653 } else {
4654 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4655 monitor_event, NULL, mon, NULL, true);
4658 monitor_list_append(mon);
4661 void monitor_cleanup(void)
4664 * We need to explicitly stop the I/O thread (but not destroy it),
4665 * clean up the monitor resources, then destroy the I/O thread since
4666 * we need to unregister from chardev below in
4667 * monitor_data_destroy(), and chardev is not thread-safe yet
4669 if (mon_iothread) {
4670 iothread_stop(mon_iothread);
4673 /* Flush output buffers and destroy monitors */
4674 qemu_mutex_lock(&monitor_lock);
4675 monitor_destroyed = true;
4676 while (!QTAILQ_EMPTY(&mon_list)) {
4677 Monitor *mon = QTAILQ_FIRST(&mon_list);
4678 QTAILQ_REMOVE(&mon_list, mon, entry);
4679 /* Permit QAPI event emission from character frontend release */
4680 qemu_mutex_unlock(&monitor_lock);
4681 monitor_flush(mon);
4682 monitor_data_destroy(mon);
4683 qemu_mutex_lock(&monitor_lock);
4684 g_free(mon);
4686 qemu_mutex_unlock(&monitor_lock);
4688 /* QEMUBHs needs to be deleted before destroying the I/O thread */
4689 qemu_bh_delete(qmp_dispatcher_bh);
4690 qmp_dispatcher_bh = NULL;
4691 if (mon_iothread) {
4692 iothread_destroy(mon_iothread);
4693 mon_iothread = NULL;
4697 QemuOptsList qemu_mon_opts = {
4698 .name = "mon",
4699 .implied_opt_name = "chardev",
4700 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4701 .desc = {
4703 .name = "mode",
4704 .type = QEMU_OPT_STRING,
4706 .name = "chardev",
4707 .type = QEMU_OPT_STRING,
4709 .name = "pretty",
4710 .type = QEMU_OPT_BOOL,
4712 { /* end of list */ }
4716 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4718 MachineState *ms = MACHINE(qdev_get_machine());
4719 MachineClass *mc = MACHINE_GET_CLASS(ms);
4721 if (!mc->has_hotpluggable_cpus) {
4722 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4723 return NULL;
4726 return machine_query_hotpluggable_cpus(ms);