docs/devel/testing.rst: add missing newlines after code block
[qemu/ar7.git] / monitor.c
blob823b5a1099d657c64f6e10892edbf9d27327fc77
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 "qemu/acl.h"
55 #include "sysemu/tpm.h"
56 #include "qapi/qmp/qdict.h"
57 #include "qapi/qmp/qerror.h"
58 #include "qapi/qmp/qnum.h"
59 #include "qapi/qmp/qstring.h"
60 #include "qapi/qmp/qjson.h"
61 #include "qapi/qmp/json-parser.h"
62 #include "qapi/qmp/qlist.h"
63 #include "qom/object_interfaces.h"
64 #include "trace-root.h"
65 #include "trace/control.h"
66 #include "monitor/hmp-target.h"
67 #ifdef CONFIG_TRACE_SIMPLE
68 #include "trace/simple.h"
69 #endif
70 #include "exec/memory.h"
71 #include "exec/exec-all.h"
72 #include "qemu/log.h"
73 #include "qemu/option.h"
74 #include "hmp.h"
75 #include "qemu/thread.h"
76 #include "block/qapi.h"
77 #include "qapi/qapi-commands.h"
78 #include "qapi/qapi-events.h"
79 #include "qapi/error.h"
80 #include "qapi/qmp-event.h"
81 #include "qapi/qapi-introspect.h"
82 #include "sysemu/qtest.h"
83 #include "sysemu/cpus.h"
84 #include "sysemu/iothread.h"
85 #include "qemu/cutils.h"
86 #include "tcg/tcg.h"
88 #if defined(TARGET_S390X)
89 #include "hw/s390x/storage-keys.h"
90 #include "hw/s390x/storage-attributes.h"
91 #endif
94 * Supported types:
96 * 'F' filename
97 * 'B' block device name
98 * 's' string (accept optional quote)
99 * 'S' it just appends the rest of the string (accept optional quote)
100 * 'O' option string of the form NAME=VALUE,...
101 * parsed according to QemuOptsList given by its name
102 * Example: 'device:O' uses qemu_device_opts.
103 * Restriction: only lists with empty desc are supported
104 * TODO lift the restriction
105 * 'i' 32 bit integer
106 * 'l' target long (32 or 64 bit)
107 * 'M' Non-negative target long (32 or 64 bit), in user mode the
108 * value is multiplied by 2^20 (think Mebibyte)
109 * 'o' octets (aka bytes)
110 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
111 * K, k suffix, which multiplies the value by 2^60 for suffixes E
112 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
113 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
114 * 'T' double
115 * user mode accepts an optional ms, us, ns suffix,
116 * which divides the value by 1e3, 1e6, 1e9, respectively
117 * '/' optional gdb-like print format (like "/10x")
119 * '?' optional type (for all types, except '/')
120 * '.' other form of optional type (for 'i' and 'l')
121 * 'b' boolean
122 * user mode accepts "on" or "off"
123 * '-' optional parameter (eg. '-f')
127 typedef struct mon_cmd_t {
128 const char *name;
129 const char *args_type;
130 const char *params;
131 const char *help;
132 const char *flags; /* p=preconfig */
133 void (*cmd)(Monitor *mon, const QDict *qdict);
134 /* @sub_table is a list of 2nd level of commands. If it does not exist,
135 * cmd should be used. If it exists, sub_table[?].cmd should be
136 * used, and cmd of 1st level plays the role of help function.
138 struct mon_cmd_t *sub_table;
139 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
140 } mon_cmd_t;
142 /* file descriptors passed via SCM_RIGHTS */
143 typedef struct mon_fd_t mon_fd_t;
144 struct mon_fd_t {
145 char *name;
146 int fd;
147 QLIST_ENTRY(mon_fd_t) next;
150 /* file descriptor associated with a file descriptor set */
151 typedef struct MonFdsetFd MonFdsetFd;
152 struct MonFdsetFd {
153 int fd;
154 bool removed;
155 char *opaque;
156 QLIST_ENTRY(MonFdsetFd) next;
159 /* file descriptor set containing fds passed via SCM_RIGHTS */
160 typedef struct MonFdset MonFdset;
161 struct MonFdset {
162 int64_t id;
163 QLIST_HEAD(, MonFdsetFd) fds;
164 QLIST_HEAD(, MonFdsetFd) dup_fds;
165 QLIST_ENTRY(MonFdset) next;
168 typedef struct {
169 JSONMessageParser parser;
171 * When a client connects, we're in capabilities negotiation mode.
172 * @commands is &qmp_cap_negotiation_commands then. When command
173 * qmp_capabilities succeeds, we go into command mode, and
174 * @command becomes &qmp_commands.
176 QmpCommandList *commands;
177 bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
178 bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
180 * Protects qmp request/response queue.
181 * Take monitor_lock first when you need both.
183 QemuMutex qmp_queue_lock;
184 /* Input queue that holds all the parsed QMP requests */
185 GQueue *qmp_requests;
186 } MonitorQMP;
189 * To prevent flooding clients, events can be throttled. The
190 * throttling is calculated globally, rather than per-Monitor
191 * instance.
193 typedef struct MonitorQAPIEventState {
194 QAPIEvent event; /* Throttling state for this event type and... */
195 QDict *data; /* ... data, see qapi_event_throttle_equal() */
196 QEMUTimer *timer; /* Timer for handling delayed events */
197 QDict *qdict; /* Delayed event (if any) */
198 } MonitorQAPIEventState;
200 typedef struct {
201 int64_t rate; /* Minimum time (in ns) between two events */
202 } MonitorQAPIEventConf;
204 struct Monitor {
205 CharBackend chr;
206 int reset_seen;
207 int flags;
208 int suspend_cnt; /* Needs to be accessed atomically */
209 bool skip_flush;
210 bool use_io_thread;
213 * State used only in the thread "owning" the monitor.
214 * If @use_io_thread, this is @mon_iothread.
215 * Else, it's the main thread.
216 * These members can be safely accessed without locks.
218 ReadLineState *rs;
220 MonitorQMP qmp;
221 gchar *mon_cpu_path;
222 BlockCompletionFunc *password_completion_cb;
223 void *password_opaque;
224 mon_cmd_t *cmd_table;
225 QTAILQ_ENTRY(Monitor) entry;
228 * The per-monitor lock. We can't access guest memory when holding
229 * the lock.
231 QemuMutex mon_lock;
234 * Members that are protected by the per-monitor lock
236 QLIST_HEAD(, mon_fd_t) fds;
237 QString *outbuf;
238 guint out_watch;
239 /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
240 int mux_out;
243 /* Shared monitor I/O thread */
244 IOThread *mon_iothread;
246 /* Bottom half to dispatch the requests received from I/O thread */
247 QEMUBH *qmp_dispatcher_bh;
249 struct QMPRequest {
250 /* Owner of the request */
251 Monitor *mon;
252 /* "id" field of the request */
253 QObject *id;
255 * Request object to be handled or Error to be reported
256 * (exactly one of them is non-null)
258 QObject *req;
259 Error *err;
261 typedef struct QMPRequest QMPRequest;
263 /* QMP checker flags */
264 #define QMP_ACCEPT_UNKNOWNS 1
266 /* Protects mon_list, monitor_qapi_event_state. */
267 static QemuMutex monitor_lock;
268 static GHashTable *monitor_qapi_event_state;
269 static QTAILQ_HEAD(mon_list, Monitor) mon_list;
271 /* Protects mon_fdsets */
272 static QemuMutex mon_fdsets_lock;
273 static QLIST_HEAD(mon_fdsets, 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->id);
355 qobject_unref(req->req);
356 error_free(req->err);
357 g_free(req);
360 /* Caller must hold mon->qmp.qmp_queue_lock */
361 static void monitor_qmp_cleanup_req_queue_locked(Monitor *mon)
363 while (!g_queue_is_empty(mon->qmp.qmp_requests)) {
364 qmp_request_free(g_queue_pop_head(mon->qmp.qmp_requests));
368 static void monitor_qmp_cleanup_queues(Monitor *mon)
370 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
371 monitor_qmp_cleanup_req_queue_locked(mon);
372 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
376 static void monitor_flush_locked(Monitor *mon);
378 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
379 void *opaque)
381 Monitor *mon = opaque;
383 qemu_mutex_lock(&mon->mon_lock);
384 mon->out_watch = 0;
385 monitor_flush_locked(mon);
386 qemu_mutex_unlock(&mon->mon_lock);
387 return FALSE;
390 /* Caller must hold mon->mon_lock */
391 static void monitor_flush_locked(Monitor *mon)
393 int rc;
394 size_t len;
395 const char *buf;
397 if (mon->skip_flush) {
398 return;
401 buf = qstring_get_str(mon->outbuf);
402 len = qstring_get_length(mon->outbuf);
404 if (len && !mon->mux_out) {
405 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
406 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
407 /* all flushed or error */
408 qobject_unref(mon->outbuf);
409 mon->outbuf = qstring_new();
410 return;
412 if (rc > 0) {
413 /* partial write */
414 QString *tmp = qstring_from_str(buf + rc);
415 qobject_unref(mon->outbuf);
416 mon->outbuf = tmp;
418 if (mon->out_watch == 0) {
419 mon->out_watch =
420 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
421 monitor_unblocked, mon);
426 void monitor_flush(Monitor *mon)
428 qemu_mutex_lock(&mon->mon_lock);
429 monitor_flush_locked(mon);
430 qemu_mutex_unlock(&mon->mon_lock);
433 /* flush at every end of line */
434 static void monitor_puts(Monitor *mon, const char *str)
436 char c;
438 qemu_mutex_lock(&mon->mon_lock);
439 for(;;) {
440 c = *str++;
441 if (c == '\0')
442 break;
443 if (c == '\n') {
444 qstring_append_chr(mon->outbuf, '\r');
446 qstring_append_chr(mon->outbuf, c);
447 if (c == '\n') {
448 monitor_flush_locked(mon);
451 qemu_mutex_unlock(&mon->mon_lock);
454 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
456 char *buf;
458 if (!mon)
459 return;
461 if (monitor_is_qmp(mon)) {
462 return;
465 buf = g_strdup_vprintf(fmt, ap);
466 monitor_puts(mon, buf);
467 g_free(buf);
470 void monitor_printf(Monitor *mon, const char *fmt, ...)
472 va_list ap;
473 va_start(ap, fmt);
474 monitor_vprintf(mon, fmt, ap);
475 va_end(ap);
478 int monitor_fprintf(FILE *stream, const char *fmt, ...)
480 va_list ap;
481 va_start(ap, fmt);
482 monitor_vprintf((Monitor *)stream, fmt, ap);
483 va_end(ap);
484 return 0;
487 static void qmp_send_response(Monitor *mon, const QDict *rsp)
489 const QObject *data = QOBJECT(rsp);
490 QString *json;
492 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
493 qobject_to_json(data);
494 assert(json != NULL);
496 qstring_append_chr(json, '\n');
497 monitor_puts(mon, qstring_get_str(json));
499 qobject_unref(json);
502 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
503 /* Limit guest-triggerable events to 1 per second */
504 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
505 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
506 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
507 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
508 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
509 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
513 * Broadcast an event to all monitors.
514 * @qdict is the event object. Its member "event" must match @event.
515 * Caller must hold monitor_lock.
517 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
519 Monitor *mon;
521 trace_monitor_protocol_event_emit(event, qdict);
522 QTAILQ_FOREACH(mon, &mon_list, entry) {
523 if (monitor_is_qmp(mon)
524 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
525 qmp_send_response(mon, qdict);
530 static void monitor_qapi_event_handler(void *opaque);
533 * Queue a new event for emission to Monitor instances,
534 * applying any rate limiting if required.
536 static void
537 monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
539 MonitorQAPIEventConf *evconf;
540 MonitorQAPIEventState *evstate;
542 assert(event < QAPI_EVENT__MAX);
543 evconf = &monitor_qapi_event_conf[event];
544 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
546 qemu_mutex_lock(&monitor_lock);
548 if (!evconf->rate) {
549 /* Unthrottled event */
550 monitor_qapi_event_emit(event, qdict);
551 } else {
552 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
553 MonitorQAPIEventState key = { .event = event, .data = data };
555 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
556 assert(!evstate || timer_pending(evstate->timer));
558 if (evstate) {
560 * Timer is pending for (at least) evconf->rate ns after
561 * last send. Store event for sending when timer fires,
562 * replacing a prior stored event if any.
564 qobject_unref(evstate->qdict);
565 evstate->qdict = qobject_ref(qdict);
566 } else {
568 * Last send was (at least) evconf->rate ns ago.
569 * Send immediately, and arm the timer to call
570 * monitor_qapi_event_handler() in evconf->rate ns. Any
571 * events arriving before then will be delayed until then.
573 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
575 monitor_qapi_event_emit(event, qdict);
577 evstate = g_new(MonitorQAPIEventState, 1);
578 evstate->event = event;
579 evstate->data = qobject_ref(data);
580 evstate->qdict = NULL;
581 evstate->timer = timer_new_ns(monitor_get_event_clock(),
582 monitor_qapi_event_handler,
583 evstate);
584 g_hash_table_add(monitor_qapi_event_state, evstate);
585 timer_mod_ns(evstate->timer, now + evconf->rate);
589 qemu_mutex_unlock(&monitor_lock);
592 static void
593 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict)
596 * monitor_qapi_event_queue_no_reenter() is not reentrant: it
597 * would deadlock on monitor_lock. Work around by queueing
598 * events in thread-local storage.
599 * TODO: remove this, make it re-enter safe.
601 typedef struct MonitorQapiEvent {
602 QAPIEvent event;
603 QDict *qdict;
604 QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
605 } MonitorQapiEvent;
606 static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
607 static __thread bool reentered;
608 MonitorQapiEvent *ev;
610 if (!reentered) {
611 QSIMPLEQ_INIT(&event_queue);
614 ev = g_new(MonitorQapiEvent, 1);
615 ev->qdict = qobject_ref(qdict);
616 ev->event = event;
617 QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
618 if (reentered) {
619 return;
622 reentered = true;
624 while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
625 QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
626 monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
627 qobject_unref(ev->qdict);
628 g_free(ev);
631 reentered = false;
635 * This function runs evconf->rate ns after sending a throttled
636 * event.
637 * If another event has since been stored, send it.
639 static void monitor_qapi_event_handler(void *opaque)
641 MonitorQAPIEventState *evstate = opaque;
642 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
644 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
645 qemu_mutex_lock(&monitor_lock);
647 if (evstate->qdict) {
648 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
650 monitor_qapi_event_emit(evstate->event, evstate->qdict);
651 qobject_unref(evstate->qdict);
652 evstate->qdict = NULL;
653 timer_mod_ns(evstate->timer, now + evconf->rate);
654 } else {
655 g_hash_table_remove(monitor_qapi_event_state, evstate);
656 qobject_unref(evstate->data);
657 timer_free(evstate->timer);
658 g_free(evstate);
661 qemu_mutex_unlock(&monitor_lock);
664 static unsigned int qapi_event_throttle_hash(const void *key)
666 const MonitorQAPIEventState *evstate = key;
667 unsigned int hash = evstate->event * 255;
669 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
670 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
673 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
674 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
677 return hash;
680 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
682 const MonitorQAPIEventState *eva = a;
683 const MonitorQAPIEventState *evb = b;
685 if (eva->event != evb->event) {
686 return FALSE;
689 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
690 return !strcmp(qdict_get_str(eva->data, "id"),
691 qdict_get_str(evb->data, "id"));
694 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
695 return !strcmp(qdict_get_str(eva->data, "node-name"),
696 qdict_get_str(evb->data, "node-name"));
699 return TRUE;
702 static void monitor_qapi_event_init(void)
704 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
705 qapi_event_throttle_equal);
706 qmp_event_set_func_emit(monitor_qapi_event_queue);
709 static void handle_hmp_command(Monitor *mon, const char *cmdline);
711 static void monitor_data_init(Monitor *mon, bool skip_flush,
712 bool use_io_thread)
714 memset(mon, 0, sizeof(Monitor));
715 qemu_mutex_init(&mon->mon_lock);
716 qemu_mutex_init(&mon->qmp.qmp_queue_lock);
717 mon->outbuf = qstring_new();
718 /* Use *mon_cmds by default. */
719 mon->cmd_table = mon_cmds;
720 mon->skip_flush = skip_flush;
721 mon->use_io_thread = use_io_thread;
722 mon->qmp.qmp_requests = g_queue_new();
725 static void monitor_data_destroy(Monitor *mon)
727 g_free(mon->mon_cpu_path);
728 qemu_chr_fe_deinit(&mon->chr, false);
729 if (monitor_is_qmp(mon)) {
730 json_message_parser_destroy(&mon->qmp.parser);
732 readline_free(mon->rs);
733 qobject_unref(mon->outbuf);
734 qemu_mutex_destroy(&mon->mon_lock);
735 qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
736 monitor_qmp_cleanup_req_queue_locked(mon);
737 g_queue_free(mon->qmp.qmp_requests);
740 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
741 int64_t cpu_index, Error **errp)
743 char *output = NULL;
744 Monitor *old_mon, hmp;
746 monitor_data_init(&hmp, true, false);
748 old_mon = cur_mon;
749 cur_mon = &hmp;
751 if (has_cpu_index) {
752 int ret = monitor_set_cpu(cpu_index);
753 if (ret < 0) {
754 cur_mon = old_mon;
755 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
756 "a CPU number");
757 goto out;
761 handle_hmp_command(&hmp, command_line);
762 cur_mon = old_mon;
764 qemu_mutex_lock(&hmp.mon_lock);
765 if (qstring_get_length(hmp.outbuf) > 0) {
766 output = g_strdup(qstring_get_str(hmp.outbuf));
767 } else {
768 output = g_strdup("");
770 qemu_mutex_unlock(&hmp.mon_lock);
772 out:
773 monitor_data_destroy(&hmp);
774 return output;
777 static int compare_cmd(const char *name, const char *list)
779 const char *p, *pstart;
780 int len;
781 len = strlen(name);
782 p = list;
783 for(;;) {
784 pstart = p;
785 p = qemu_strchrnul(p, '|');
786 if ((p - pstart) == len && !memcmp(pstart, name, len))
787 return 1;
788 if (*p == '\0')
789 break;
790 p++;
792 return 0;
795 static int get_str(char *buf, int buf_size, const char **pp)
797 const char *p;
798 char *q;
799 int c;
801 q = buf;
802 p = *pp;
803 while (qemu_isspace(*p)) {
804 p++;
806 if (*p == '\0') {
807 fail:
808 *q = '\0';
809 *pp = p;
810 return -1;
812 if (*p == '\"') {
813 p++;
814 while (*p != '\0' && *p != '\"') {
815 if (*p == '\\') {
816 p++;
817 c = *p++;
818 switch (c) {
819 case 'n':
820 c = '\n';
821 break;
822 case 'r':
823 c = '\r';
824 break;
825 case '\\':
826 case '\'':
827 case '\"':
828 break;
829 default:
830 printf("unsupported escape code: '\\%c'\n", c);
831 goto fail;
833 if ((q - buf) < buf_size - 1) {
834 *q++ = c;
836 } else {
837 if ((q - buf) < buf_size - 1) {
838 *q++ = *p;
840 p++;
843 if (*p != '\"') {
844 printf("unterminated string\n");
845 goto fail;
847 p++;
848 } else {
849 while (*p != '\0' && !qemu_isspace(*p)) {
850 if ((q - buf) < buf_size - 1) {
851 *q++ = *p;
853 p++;
856 *q = '\0';
857 *pp = p;
858 return 0;
861 #define MAX_ARGS 16
863 static void free_cmdline_args(char **args, int nb_args)
865 int i;
867 assert(nb_args <= MAX_ARGS);
869 for (i = 0; i < nb_args; i++) {
870 g_free(args[i]);
876 * Parse the command line to get valid args.
877 * @cmdline: command line to be parsed.
878 * @pnb_args: location to store the number of args, must NOT be NULL.
879 * @args: location to store the args, which should be freed by caller, must
880 * NOT be NULL.
882 * Returns 0 on success, negative on failure.
884 * NOTE: this parser is an approximate form of the real command parser. Number
885 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
886 * return with failure.
888 static int parse_cmdline(const char *cmdline,
889 int *pnb_args, char **args)
891 const char *p;
892 int nb_args, ret;
893 char buf[1024];
895 p = cmdline;
896 nb_args = 0;
897 for (;;) {
898 while (qemu_isspace(*p)) {
899 p++;
901 if (*p == '\0') {
902 break;
904 if (nb_args >= MAX_ARGS) {
905 goto fail;
907 ret = get_str(buf, sizeof(buf), &p);
908 if (ret < 0) {
909 goto fail;
911 args[nb_args] = g_strdup(buf);
912 nb_args++;
914 *pnb_args = nb_args;
915 return 0;
917 fail:
918 free_cmdline_args(args, nb_args);
919 return -1;
923 * Can command @cmd be executed in preconfig state?
925 static bool cmd_can_preconfig(const mon_cmd_t *cmd)
927 if (!cmd->flags) {
928 return false;
931 return strchr(cmd->flags, 'p');
934 static void help_cmd_dump_one(Monitor *mon,
935 const mon_cmd_t *cmd,
936 char **prefix_args,
937 int prefix_args_nb)
939 int i;
941 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
942 return;
945 for (i = 0; i < prefix_args_nb; i++) {
946 monitor_printf(mon, "%s ", prefix_args[i]);
948 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
951 /* @args[@arg_index] is the valid command need to find in @cmds */
952 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
953 char **args, int nb_args, int arg_index)
955 const mon_cmd_t *cmd;
956 size_t i;
958 /* No valid arg need to compare with, dump all in *cmds */
959 if (arg_index >= nb_args) {
960 for (cmd = cmds; cmd->name != NULL; cmd++) {
961 help_cmd_dump_one(mon, cmd, args, arg_index);
963 return;
966 /* Find one entry to dump */
967 for (cmd = cmds; cmd->name != NULL; cmd++) {
968 if (compare_cmd(args[arg_index], cmd->name) &&
969 ((!runstate_check(RUN_STATE_PRECONFIG) ||
970 cmd_can_preconfig(cmd)))) {
971 if (cmd->sub_table) {
972 /* continue with next arg */
973 help_cmd_dump(mon, cmd->sub_table,
974 args, nb_args, arg_index + 1);
975 } else {
976 help_cmd_dump_one(mon, cmd, args, arg_index);
978 return;
982 /* Command not found */
983 monitor_printf(mon, "unknown command: '");
984 for (i = 0; i <= arg_index; i++) {
985 monitor_printf(mon, "%s%s", args[i], i == arg_index ? "'\n" : " ");
989 static void help_cmd(Monitor *mon, const char *name)
991 char *args[MAX_ARGS];
992 int nb_args = 0;
994 /* 1. parse user input */
995 if (name) {
996 /* special case for log, directly dump and return */
997 if (!strcmp(name, "log")) {
998 const QEMULogItem *item;
999 monitor_printf(mon, "Log items (comma separated):\n");
1000 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
1001 for (item = qemu_log_items; item->mask != 0; item++) {
1002 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
1004 return;
1007 if (parse_cmdline(name, &nb_args, args) < 0) {
1008 return;
1012 /* 2. dump the contents according to parsed args */
1013 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
1015 free_cmdline_args(args, nb_args);
1018 static void do_help_cmd(Monitor *mon, const QDict *qdict)
1020 help_cmd(mon, qdict_get_try_str(qdict, "name"));
1023 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
1025 const char *tp_name = qdict_get_str(qdict, "name");
1026 bool new_state = qdict_get_bool(qdict, "option");
1027 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1028 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1029 Error *local_err = NULL;
1031 if (vcpu < 0) {
1032 monitor_printf(mon, "argument vcpu must be positive");
1033 return;
1036 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
1037 if (local_err) {
1038 error_report_err(local_err);
1042 #ifdef CONFIG_TRACE_SIMPLE
1043 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
1045 const char *op = qdict_get_try_str(qdict, "op");
1046 const char *arg = qdict_get_try_str(qdict, "arg");
1048 if (!op) {
1049 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
1050 } else if (!strcmp(op, "on")) {
1051 st_set_trace_file_enabled(true);
1052 } else if (!strcmp(op, "off")) {
1053 st_set_trace_file_enabled(false);
1054 } else if (!strcmp(op, "flush")) {
1055 st_flush_trace_buffer();
1056 } else if (!strcmp(op, "set")) {
1057 if (arg) {
1058 st_set_trace_file(arg);
1060 } else {
1061 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
1062 help_cmd(mon, "trace-file");
1065 #endif
1067 static void hmp_info_help(Monitor *mon, const QDict *qdict)
1069 help_cmd(mon, "info");
1072 static void query_commands_cb(QmpCommand *cmd, void *opaque)
1074 CommandInfoList *info, **list = opaque;
1076 if (!cmd->enabled) {
1077 return;
1080 info = g_malloc0(sizeof(*info));
1081 info->value = g_malloc0(sizeof(*info->value));
1082 info->value->name = g_strdup(cmd->name);
1083 info->next = *list;
1084 *list = info;
1087 CommandInfoList *qmp_query_commands(Error **errp)
1089 CommandInfoList *list = NULL;
1091 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
1093 return list;
1096 EventInfoList *qmp_query_events(Error **errp)
1098 EventInfoList *info, *ev_list = NULL;
1099 QAPIEvent e;
1101 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
1102 const char *event_name = QAPIEvent_str(e);
1103 assert(event_name != NULL);
1104 info = g_malloc0(sizeof(*info));
1105 info->value = g_malloc0(sizeof(*info->value));
1106 info->value->name = g_strdup(event_name);
1108 info->next = ev_list;
1109 ev_list = info;
1112 return ev_list;
1116 * Minor hack: generated marshalling suppressed for this command
1117 * ('gen': false in the schema) so we can parse the JSON string
1118 * directly into QObject instead of first parsing it with
1119 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
1120 * to QObject with generated output marshallers, every time. Instead,
1121 * we do it in test-qobject-input-visitor.c, just to make sure
1122 * qapi-gen.py's output actually conforms to the schema.
1124 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
1125 Error **errp)
1127 *ret_data = qobject_from_qlit(&qmp_schema_qlit);
1131 * We used to define commands in qmp-commands.hx in addition to the
1132 * QAPI schema. This permitted defining some of them only in certain
1133 * configurations. query-commands has always reflected that (good,
1134 * because it lets QMP clients figure out what's actually available),
1135 * while query-qmp-schema never did (not so good). This function is a
1136 * hack to keep the configuration-specific commands defined exactly as
1137 * before, even though qmp-commands.hx is gone.
1139 * FIXME Educate the QAPI schema on configuration-specific commands,
1140 * and drop this hack.
1142 static void qmp_unregister_commands_hack(void)
1144 #ifndef CONFIG_REPLICATION
1145 qmp_unregister_command(&qmp_commands, "xen-set-replication");
1146 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
1147 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
1148 #endif
1149 #ifndef TARGET_I386
1150 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
1151 qmp_unregister_command(&qmp_commands, "query-sev");
1152 qmp_unregister_command(&qmp_commands, "query-sev-launch-measure");
1153 qmp_unregister_command(&qmp_commands, "query-sev-capabilities");
1154 #endif
1155 #ifndef TARGET_S390X
1156 qmp_unregister_command(&qmp_commands, "dump-skeys");
1157 #endif
1158 #ifndef TARGET_ARM
1159 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
1160 #endif
1161 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
1162 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
1163 #endif
1164 #if !defined(TARGET_S390X)
1165 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
1166 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
1167 #endif
1168 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
1169 && !defined(TARGET_S390X)
1170 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1171 #endif
1174 static void monitor_init_qmp_commands(void)
1177 * Two command lists:
1178 * - qmp_commands contains all QMP commands
1179 * - qmp_cap_negotiation_commands contains just
1180 * "qmp_capabilities", to enforce capability negotiation
1183 qmp_init_marshal(&qmp_commands);
1185 qmp_register_command(&qmp_commands, "query-qmp-schema",
1186 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
1187 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1188 QCO_NO_OPTIONS);
1189 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1190 QCO_NO_OPTIONS);
1192 qmp_unregister_commands_hack();
1194 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1195 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1196 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
1199 static bool qmp_oob_enabled(Monitor *mon)
1201 return mon->qmp.capab[QMP_CAPABILITY_OOB];
1204 static void monitor_qmp_caps_reset(Monitor *mon)
1206 memset(mon->qmp.capab_offered, 0, sizeof(mon->qmp.capab_offered));
1207 memset(mon->qmp.capab, 0, sizeof(mon->qmp.capab));
1208 mon->qmp.capab_offered[QMP_CAPABILITY_OOB] = mon->use_io_thread;
1212 * Accept QMP capabilities in @list for @mon.
1213 * On success, set mon->qmp.capab[], and return true.
1214 * On error, set @errp, and return false.
1216 static bool qmp_caps_accept(Monitor *mon, QMPCapabilityList *list,
1217 Error **errp)
1219 GString *unavailable = NULL;
1220 bool capab[QMP_CAPABILITY__MAX];
1222 memset(capab, 0, sizeof(capab));
1224 for (; list; list = list->next) {
1225 if (!mon->qmp.capab_offered[list->value]) {
1226 if (!unavailable) {
1227 unavailable = g_string_new(QMPCapability_str(list->value));
1228 } else {
1229 g_string_append_printf(unavailable, ", %s",
1230 QMPCapability_str(list->value));
1233 capab[list->value] = true;
1236 if (unavailable) {
1237 error_setg(errp, "Capability %s not available", unavailable->str);
1238 g_string_free(unavailable, true);
1239 return false;
1242 memcpy(mon->qmp.capab, capab, sizeof(capab));
1243 return true;
1246 void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
1247 Error **errp)
1249 if (cur_mon->qmp.commands == &qmp_commands) {
1250 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1251 "Capabilities negotiation is already complete, command "
1252 "ignored");
1253 return;
1256 if (!qmp_caps_accept(cur_mon, enable, errp)) {
1257 return;
1260 cur_mon->qmp.commands = &qmp_commands;
1263 /* Set the current CPU defined by the user. Callers must hold BQL. */
1264 int monitor_set_cpu(int cpu_index)
1266 CPUState *cpu;
1268 cpu = qemu_get_cpu(cpu_index);
1269 if (cpu == NULL) {
1270 return -1;
1272 g_free(cur_mon->mon_cpu_path);
1273 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1274 return 0;
1277 /* Callers must hold BQL. */
1278 static CPUState *mon_get_cpu_sync(bool synchronize)
1280 CPUState *cpu;
1282 if (cur_mon->mon_cpu_path) {
1283 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1284 TYPE_CPU, NULL);
1285 if (!cpu) {
1286 g_free(cur_mon->mon_cpu_path);
1287 cur_mon->mon_cpu_path = NULL;
1290 if (!cur_mon->mon_cpu_path) {
1291 if (!first_cpu) {
1292 return NULL;
1294 monitor_set_cpu(first_cpu->cpu_index);
1295 cpu = first_cpu;
1297 if (synchronize) {
1298 cpu_synchronize_state(cpu);
1300 return cpu;
1303 CPUState *mon_get_cpu(void)
1305 return mon_get_cpu_sync(true);
1308 CPUArchState *mon_get_cpu_env(void)
1310 CPUState *cs = mon_get_cpu();
1312 return cs ? cs->env_ptr : NULL;
1315 int monitor_get_cpu_index(void)
1317 CPUState *cs = mon_get_cpu_sync(false);
1319 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1322 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1324 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1325 CPUState *cs;
1327 if (all_cpus) {
1328 CPU_FOREACH(cs) {
1329 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1330 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1332 } else {
1333 cs = mon_get_cpu();
1335 if (!cs) {
1336 monitor_printf(mon, "No CPU available\n");
1337 return;
1340 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1344 #ifdef CONFIG_TCG
1345 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1347 if (!tcg_enabled()) {
1348 error_report("JIT information is only available with accel=tcg");
1349 return;
1352 dump_exec_info((FILE *)mon, monitor_fprintf);
1353 dump_drift_info((FILE *)mon, monitor_fprintf);
1356 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1358 dump_opcount_info((FILE *)mon, monitor_fprintf);
1360 #endif
1362 static void hmp_info_sync_profile(Monitor *mon, const QDict *qdict)
1364 int64_t max = qdict_get_try_int(qdict, "max", 10);
1365 bool mean = qdict_get_try_bool(qdict, "mean", false);
1366 bool coalesce = !qdict_get_try_bool(qdict, "no_coalesce", false);
1367 enum QSPSortBy sort_by;
1369 sort_by = mean ? QSP_SORT_BY_AVG_WAIT_TIME : QSP_SORT_BY_TOTAL_WAIT_TIME;
1370 qsp_report((FILE *)mon, monitor_fprintf, max, sort_by, coalesce);
1373 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1375 int i;
1376 const char *str;
1378 if (!mon->rs)
1379 return;
1380 i = 0;
1381 for(;;) {
1382 str = readline_get_history(mon->rs, i);
1383 if (!str)
1384 break;
1385 monitor_printf(mon, "%d: '%s'\n", i, str);
1386 i++;
1390 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1392 CPUState *cs = mon_get_cpu();
1394 if (!cs) {
1395 monitor_printf(mon, "No CPU available\n");
1396 return;
1398 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1401 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1403 const char *name = qdict_get_try_str(qdict, "name");
1404 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1405 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1406 TraceEventInfoList *events;
1407 TraceEventInfoList *elem;
1408 Error *local_err = NULL;
1410 if (name == NULL) {
1411 name = "*";
1413 if (vcpu < 0) {
1414 monitor_printf(mon, "argument vcpu must be positive");
1415 return;
1418 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1419 if (local_err) {
1420 error_report_err(local_err);
1421 return;
1424 for (elem = events; elem != NULL; elem = elem->next) {
1425 monitor_printf(mon, "%s : state %u\n",
1426 elem->value->name,
1427 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1429 qapi_free_TraceEventInfoList(events);
1432 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1433 bool has_port, int64_t port,
1434 bool has_tls_port, int64_t tls_port,
1435 bool has_cert_subject, const char *cert_subject,
1436 Error **errp)
1438 if (strcmp(protocol, "spice") == 0) {
1439 if (!qemu_using_spice(errp)) {
1440 return;
1443 if (!has_port && !has_tls_port) {
1444 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1445 return;
1448 if (qemu_spice_migrate_info(hostname,
1449 has_port ? port : -1,
1450 has_tls_port ? tls_port : -1,
1451 cert_subject)) {
1452 error_setg(errp, QERR_UNDEFINED_ERROR);
1453 return;
1455 return;
1458 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1461 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1463 Error *err = NULL;
1465 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1466 if (err) {
1467 error_report_err(err);
1471 static void hmp_log(Monitor *mon, const QDict *qdict)
1473 int mask;
1474 const char *items = qdict_get_str(qdict, "items");
1476 if (!strcmp(items, "none")) {
1477 mask = 0;
1478 } else {
1479 mask = qemu_str_to_log_mask(items);
1480 if (!mask) {
1481 help_cmd(mon, "log");
1482 return;
1485 qemu_set_log(mask);
1488 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1490 const char *option = qdict_get_try_str(qdict, "option");
1491 if (!option || !strcmp(option, "on")) {
1492 singlestep = 1;
1493 } else if (!strcmp(option, "off")) {
1494 singlestep = 0;
1495 } else {
1496 monitor_printf(mon, "unexpected option %s\n", option);
1500 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1502 const char *device = qdict_get_try_str(qdict, "device");
1503 if (!device)
1504 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1505 if (gdbserver_start(device) < 0) {
1506 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1507 device);
1508 } else if (strcmp(device, "none") == 0) {
1509 monitor_printf(mon, "Disabled gdbserver\n");
1510 } else {
1511 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1512 device);
1516 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1518 const char *action = qdict_get_str(qdict, "action");
1519 if (select_watchdog_action(action) == -1) {
1520 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1524 static void monitor_printc(Monitor *mon, int c)
1526 monitor_printf(mon, "'");
1527 switch(c) {
1528 case '\'':
1529 monitor_printf(mon, "\\'");
1530 break;
1531 case '\\':
1532 monitor_printf(mon, "\\\\");
1533 break;
1534 case '\n':
1535 monitor_printf(mon, "\\n");
1536 break;
1537 case '\r':
1538 monitor_printf(mon, "\\r");
1539 break;
1540 default:
1541 if (c >= 32 && c <= 126) {
1542 monitor_printf(mon, "%c", c);
1543 } else {
1544 monitor_printf(mon, "\\x%02x", c);
1546 break;
1548 monitor_printf(mon, "'");
1551 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1552 hwaddr addr, int is_physical)
1554 int l, line_size, i, max_digits, len;
1555 uint8_t buf[16];
1556 uint64_t v;
1557 CPUState *cs = mon_get_cpu();
1559 if (!cs && (format == 'i' || !is_physical)) {
1560 monitor_printf(mon, "Can not dump without CPU\n");
1561 return;
1564 if (format == 'i') {
1565 monitor_disas(mon, cs, addr, count, is_physical);
1566 return;
1569 len = wsize * count;
1570 if (wsize == 1)
1571 line_size = 8;
1572 else
1573 line_size = 16;
1574 max_digits = 0;
1576 switch(format) {
1577 case 'o':
1578 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1579 break;
1580 default:
1581 case 'x':
1582 max_digits = (wsize * 8) / 4;
1583 break;
1584 case 'u':
1585 case 'd':
1586 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1587 break;
1588 case 'c':
1589 wsize = 1;
1590 break;
1593 while (len > 0) {
1594 if (is_physical)
1595 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1596 else
1597 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1598 l = len;
1599 if (l > line_size)
1600 l = line_size;
1601 if (is_physical) {
1602 cpu_physical_memory_read(addr, buf, l);
1603 } else {
1604 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1605 monitor_printf(mon, " Cannot access memory\n");
1606 break;
1609 i = 0;
1610 while (i < l) {
1611 switch(wsize) {
1612 default:
1613 case 1:
1614 v = ldub_p(buf + i);
1615 break;
1616 case 2:
1617 v = lduw_p(buf + i);
1618 break;
1619 case 4:
1620 v = (uint32_t)ldl_p(buf + i);
1621 break;
1622 case 8:
1623 v = ldq_p(buf + i);
1624 break;
1626 monitor_printf(mon, " ");
1627 switch(format) {
1628 case 'o':
1629 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1630 break;
1631 case 'x':
1632 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1633 break;
1634 case 'u':
1635 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1636 break;
1637 case 'd':
1638 monitor_printf(mon, "%*" PRId64, max_digits, v);
1639 break;
1640 case 'c':
1641 monitor_printc(mon, v);
1642 break;
1644 i += wsize;
1646 monitor_printf(mon, "\n");
1647 addr += l;
1648 len -= l;
1652 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1654 int count = qdict_get_int(qdict, "count");
1655 int format = qdict_get_int(qdict, "format");
1656 int size = qdict_get_int(qdict, "size");
1657 target_long addr = qdict_get_int(qdict, "addr");
1659 memory_dump(mon, count, format, size, addr, 0);
1662 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1664 int count = qdict_get_int(qdict, "count");
1665 int format = qdict_get_int(qdict, "format");
1666 int size = qdict_get_int(qdict, "size");
1667 hwaddr addr = qdict_get_int(qdict, "addr");
1669 memory_dump(mon, count, format, size, addr, 1);
1672 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1674 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1675 addr, 1);
1677 if (!mrs.mr) {
1678 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1679 return NULL;
1682 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1683 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1684 memory_region_unref(mrs.mr);
1685 return NULL;
1688 *p_mr = mrs.mr;
1689 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1692 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1694 hwaddr addr = qdict_get_int(qdict, "addr");
1695 Error *local_err = NULL;
1696 MemoryRegion *mr = NULL;
1697 void *ptr;
1699 ptr = gpa2hva(&mr, addr, &local_err);
1700 if (local_err) {
1701 error_report_err(local_err);
1702 return;
1705 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1706 " (%s) is %p\n",
1707 addr, mr->name, ptr);
1709 memory_region_unref(mr);
1712 #ifdef CONFIG_LINUX
1713 static uint64_t vtop(void *ptr, Error **errp)
1715 uint64_t pinfo;
1716 uint64_t ret = -1;
1717 uintptr_t addr = (uintptr_t) ptr;
1718 uintptr_t pagesize = getpagesize();
1719 off_t offset = addr / pagesize * sizeof(pinfo);
1720 int fd;
1722 fd = open("/proc/self/pagemap", O_RDONLY);
1723 if (fd == -1) {
1724 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1725 return -1;
1728 /* Force copy-on-write if necessary. */
1729 atomic_add((uint8_t *)ptr, 0);
1731 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1732 error_setg_errno(errp, errno, "Cannot read pagemap");
1733 goto out;
1735 if ((pinfo & (1ull << 63)) == 0) {
1736 error_setg(errp, "Page not present");
1737 goto out;
1739 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1741 out:
1742 close(fd);
1743 return ret;
1746 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1748 hwaddr addr = qdict_get_int(qdict, "addr");
1749 Error *local_err = NULL;
1750 MemoryRegion *mr = NULL;
1751 void *ptr;
1752 uint64_t physaddr;
1754 ptr = gpa2hva(&mr, addr, &local_err);
1755 if (local_err) {
1756 error_report_err(local_err);
1757 return;
1760 physaddr = vtop(ptr, &local_err);
1761 if (local_err) {
1762 error_report_err(local_err);
1763 } else {
1764 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1765 " (%s) is 0x%" PRIx64 "\n",
1766 addr, mr->name, (uint64_t) physaddr);
1769 memory_region_unref(mr);
1771 #endif
1773 static void do_print(Monitor *mon, const QDict *qdict)
1775 int format = qdict_get_int(qdict, "format");
1776 hwaddr val = qdict_get_int(qdict, "val");
1778 switch(format) {
1779 case 'o':
1780 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1781 break;
1782 case 'x':
1783 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1784 break;
1785 case 'u':
1786 monitor_printf(mon, "%" HWADDR_PRIu, val);
1787 break;
1788 default:
1789 case 'd':
1790 monitor_printf(mon, "%" HWADDR_PRId, val);
1791 break;
1792 case 'c':
1793 monitor_printc(mon, val);
1794 break;
1796 monitor_printf(mon, "\n");
1799 static void hmp_sum(Monitor *mon, const QDict *qdict)
1801 uint32_t addr;
1802 uint16_t sum;
1803 uint32_t start = qdict_get_int(qdict, "start");
1804 uint32_t size = qdict_get_int(qdict, "size");
1806 sum = 0;
1807 for(addr = start; addr < (start + size); addr++) {
1808 uint8_t val = address_space_ldub(&address_space_memory, addr,
1809 MEMTXATTRS_UNSPECIFIED, NULL);
1810 /* BSD sum algorithm ('sum' Unix command) */
1811 sum = (sum >> 1) | (sum << 15);
1812 sum += val;
1814 monitor_printf(mon, "%05d\n", sum);
1817 static int mouse_button_state;
1819 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1821 int dx, dy, dz, button;
1822 const char *dx_str = qdict_get_str(qdict, "dx_str");
1823 const char *dy_str = qdict_get_str(qdict, "dy_str");
1824 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1826 dx = strtol(dx_str, NULL, 0);
1827 dy = strtol(dy_str, NULL, 0);
1828 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1829 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1831 if (dz_str) {
1832 dz = strtol(dz_str, NULL, 0);
1833 if (dz != 0) {
1834 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1835 qemu_input_queue_btn(NULL, button, true);
1836 qemu_input_event_sync();
1837 qemu_input_queue_btn(NULL, button, false);
1840 qemu_input_event_sync();
1843 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1845 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1846 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1847 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1848 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1850 int button_state = qdict_get_int(qdict, "button_state");
1852 if (mouse_button_state == button_state) {
1853 return;
1855 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1856 qemu_input_event_sync();
1857 mouse_button_state = button_state;
1860 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1862 int size = qdict_get_int(qdict, "size");
1863 int addr = qdict_get_int(qdict, "addr");
1864 int has_index = qdict_haskey(qdict, "index");
1865 uint32_t val;
1866 int suffix;
1868 if (has_index) {
1869 int index = qdict_get_int(qdict, "index");
1870 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1871 addr++;
1873 addr &= 0xffff;
1875 switch(size) {
1876 default:
1877 case 1:
1878 val = cpu_inb(addr);
1879 suffix = 'b';
1880 break;
1881 case 2:
1882 val = cpu_inw(addr);
1883 suffix = 'w';
1884 break;
1885 case 4:
1886 val = cpu_inl(addr);
1887 suffix = 'l';
1888 break;
1890 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1891 suffix, addr, size * 2, val);
1894 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1896 int size = qdict_get_int(qdict, "size");
1897 int addr = qdict_get_int(qdict, "addr");
1898 int val = qdict_get_int(qdict, "val");
1900 addr &= IOPORTS_MASK;
1902 switch (size) {
1903 default:
1904 case 1:
1905 cpu_outb(addr, val);
1906 break;
1907 case 2:
1908 cpu_outw(addr, val);
1909 break;
1910 case 4:
1911 cpu_outl(addr, val);
1912 break;
1916 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1918 Error *local_err = NULL;
1919 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1921 qemu_boot_set(bootdevice, &local_err);
1922 if (local_err) {
1923 error_report_err(local_err);
1924 } else {
1925 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1929 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1931 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1932 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
1933 bool owner = qdict_get_try_bool(qdict, "owner", false);
1935 mtree_info((fprintf_function)monitor_printf, mon, flatview, dispatch_tree,
1936 owner);
1939 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1941 int i;
1942 NumaNodeMem *node_mem;
1943 CpuInfoList *cpu_list, *cpu;
1945 cpu_list = qmp_query_cpus(&error_abort);
1946 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
1948 query_numa_node_mem(node_mem);
1949 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1950 for (i = 0; i < nb_numa_nodes; i++) {
1951 monitor_printf(mon, "node %d cpus:", i);
1952 for (cpu = cpu_list; cpu; cpu = cpu->next) {
1953 if (cpu->value->has_props && cpu->value->props->has_node_id &&
1954 cpu->value->props->node_id == i) {
1955 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
1958 monitor_printf(mon, "\n");
1959 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1960 node_mem[i].node_mem >> 20);
1961 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
1962 node_mem[i].node_plugged_mem >> 20);
1964 qapi_free_CpuInfoList(cpu_list);
1965 g_free(node_mem);
1968 #ifdef CONFIG_PROFILER
1970 int64_t dev_time;
1972 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1974 static int64_t last_cpu_exec_time;
1975 int64_t cpu_exec_time;
1976 int64_t delta;
1978 cpu_exec_time = tcg_cpu_exec_time();
1979 delta = cpu_exec_time - last_cpu_exec_time;
1981 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1982 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1983 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1984 delta, delta / (double)NANOSECONDS_PER_SECOND);
1985 last_cpu_exec_time = cpu_exec_time;
1986 dev_time = 0;
1988 #else
1989 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1991 monitor_printf(mon, "Internal profiler not compiled\n");
1993 #endif
1995 /* Capture support */
1996 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1998 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
2000 int i;
2001 CaptureState *s;
2003 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2004 monitor_printf(mon, "[%d]: ", i);
2005 s->ops.info (s->opaque);
2009 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
2011 int i;
2012 int n = qdict_get_int(qdict, "n");
2013 CaptureState *s;
2015 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2016 if (i == n) {
2017 s->ops.destroy (s->opaque);
2018 QLIST_REMOVE (s, entries);
2019 g_free (s);
2020 return;
2025 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2027 const char *path = qdict_get_str(qdict, "path");
2028 int has_freq = qdict_haskey(qdict, "freq");
2029 int freq = qdict_get_try_int(qdict, "freq", -1);
2030 int has_bits = qdict_haskey(qdict, "bits");
2031 int bits = qdict_get_try_int(qdict, "bits", -1);
2032 int has_channels = qdict_haskey(qdict, "nchannels");
2033 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2034 CaptureState *s;
2036 s = g_malloc0 (sizeof (*s));
2038 freq = has_freq ? freq : 44100;
2039 bits = has_bits ? bits : 16;
2040 nchannels = has_channels ? nchannels : 2;
2042 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2043 monitor_printf(mon, "Failed to add wave capture\n");
2044 g_free (s);
2045 return;
2047 QLIST_INSERT_HEAD (&capture_head, s, entries);
2050 static qemu_acl *find_acl(Monitor *mon, const char *name)
2052 qemu_acl *acl = qemu_acl_find(name);
2054 if (!acl) {
2055 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2057 return acl;
2060 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2062 const char *aclname = qdict_get_str(qdict, "aclname");
2063 qemu_acl *acl = find_acl(mon, aclname);
2064 qemu_acl_entry *entry;
2065 int i = 0;
2067 if (acl) {
2068 monitor_printf(mon, "policy: %s\n",
2069 acl->defaultDeny ? "deny" : "allow");
2070 QTAILQ_FOREACH(entry, &acl->entries, next) {
2071 i++;
2072 monitor_printf(mon, "%d: %s %s\n", i,
2073 entry->deny ? "deny" : "allow", entry->match);
2078 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2080 const char *aclname = qdict_get_str(qdict, "aclname");
2081 qemu_acl *acl = find_acl(mon, aclname);
2083 if (acl) {
2084 qemu_acl_reset(acl);
2085 monitor_printf(mon, "acl: removed all rules\n");
2089 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2091 const char *aclname = qdict_get_str(qdict, "aclname");
2092 const char *policy = qdict_get_str(qdict, "policy");
2093 qemu_acl *acl = find_acl(mon, aclname);
2095 if (acl) {
2096 if (strcmp(policy, "allow") == 0) {
2097 acl->defaultDeny = 0;
2098 monitor_printf(mon, "acl: policy set to 'allow'\n");
2099 } else if (strcmp(policy, "deny") == 0) {
2100 acl->defaultDeny = 1;
2101 monitor_printf(mon, "acl: policy set to 'deny'\n");
2102 } else {
2103 monitor_printf(mon, "acl: unknown policy '%s', "
2104 "expected 'deny' or 'allow'\n", policy);
2109 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2111 const char *aclname = qdict_get_str(qdict, "aclname");
2112 const char *match = qdict_get_str(qdict, "match");
2113 const char *policy = qdict_get_str(qdict, "policy");
2114 int has_index = qdict_haskey(qdict, "index");
2115 int index = qdict_get_try_int(qdict, "index", -1);
2116 qemu_acl *acl = find_acl(mon, aclname);
2117 int deny, ret;
2119 if (acl) {
2120 if (strcmp(policy, "allow") == 0) {
2121 deny = 0;
2122 } else if (strcmp(policy, "deny") == 0) {
2123 deny = 1;
2124 } else {
2125 monitor_printf(mon, "acl: unknown policy '%s', "
2126 "expected 'deny' or 'allow'\n", policy);
2127 return;
2129 if (has_index)
2130 ret = qemu_acl_insert(acl, deny, match, index);
2131 else
2132 ret = qemu_acl_append(acl, deny, match);
2133 if (ret < 0)
2134 monitor_printf(mon, "acl: unable to add acl entry\n");
2135 else
2136 monitor_printf(mon, "acl: added rule at position %d\n", ret);
2140 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2142 const char *aclname = qdict_get_str(qdict, "aclname");
2143 const char *match = qdict_get_str(qdict, "match");
2144 qemu_acl *acl = find_acl(mon, aclname);
2145 int ret;
2147 if (acl) {
2148 ret = qemu_acl_remove(acl, match);
2149 if (ret < 0)
2150 monitor_printf(mon, "acl: no matching acl entry\n");
2151 else
2152 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
2156 void qmp_getfd(const char *fdname, Error **errp)
2158 mon_fd_t *monfd;
2159 int fd, tmp_fd;
2161 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2162 if (fd == -1) {
2163 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2164 return;
2167 if (qemu_isdigit(fdname[0])) {
2168 close(fd);
2169 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2170 "a name not starting with a digit");
2171 return;
2174 qemu_mutex_lock(&cur_mon->mon_lock);
2175 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2176 if (strcmp(monfd->name, fdname) != 0) {
2177 continue;
2180 tmp_fd = monfd->fd;
2181 monfd->fd = fd;
2182 qemu_mutex_unlock(&cur_mon->mon_lock);
2183 /* Make sure close() is outside critical section */
2184 close(tmp_fd);
2185 return;
2188 monfd = g_malloc0(sizeof(mon_fd_t));
2189 monfd->name = g_strdup(fdname);
2190 monfd->fd = fd;
2192 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2193 qemu_mutex_unlock(&cur_mon->mon_lock);
2196 void qmp_closefd(const char *fdname, Error **errp)
2198 mon_fd_t *monfd;
2199 int tmp_fd;
2201 qemu_mutex_lock(&cur_mon->mon_lock);
2202 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2203 if (strcmp(monfd->name, fdname) != 0) {
2204 continue;
2207 QLIST_REMOVE(monfd, next);
2208 tmp_fd = monfd->fd;
2209 g_free(monfd->name);
2210 g_free(monfd);
2211 qemu_mutex_unlock(&cur_mon->mon_lock);
2212 /* Make sure close() is outside critical section */
2213 close(tmp_fd);
2214 return;
2217 qemu_mutex_unlock(&cur_mon->mon_lock);
2218 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2221 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2223 mon_fd_t *monfd;
2225 qemu_mutex_lock(&mon->mon_lock);
2226 QLIST_FOREACH(monfd, &mon->fds, next) {
2227 int fd;
2229 if (strcmp(monfd->name, fdname) != 0) {
2230 continue;
2233 fd = monfd->fd;
2235 /* caller takes ownership of fd */
2236 QLIST_REMOVE(monfd, next);
2237 g_free(monfd->name);
2238 g_free(monfd);
2239 qemu_mutex_unlock(&mon->mon_lock);
2241 return fd;
2244 qemu_mutex_unlock(&mon->mon_lock);
2245 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2246 return -1;
2249 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2251 MonFdsetFd *mon_fdset_fd;
2252 MonFdsetFd *mon_fdset_fd_next;
2254 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2255 if ((mon_fdset_fd->removed ||
2256 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2257 runstate_is_running()) {
2258 close(mon_fdset_fd->fd);
2259 g_free(mon_fdset_fd->opaque);
2260 QLIST_REMOVE(mon_fdset_fd, next);
2261 g_free(mon_fdset_fd);
2265 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2266 QLIST_REMOVE(mon_fdset, next);
2267 g_free(mon_fdset);
2271 static void monitor_fdsets_cleanup(void)
2273 MonFdset *mon_fdset;
2274 MonFdset *mon_fdset_next;
2276 qemu_mutex_lock(&mon_fdsets_lock);
2277 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2278 monitor_fdset_cleanup(mon_fdset);
2280 qemu_mutex_unlock(&mon_fdsets_lock);
2283 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2284 const char *opaque, Error **errp)
2286 int fd;
2287 Monitor *mon = cur_mon;
2288 AddfdInfo *fdinfo;
2290 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2291 if (fd == -1) {
2292 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2293 goto error;
2296 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2297 has_opaque, opaque, errp);
2298 if (fdinfo) {
2299 return fdinfo;
2302 error:
2303 if (fd != -1) {
2304 close(fd);
2306 return NULL;
2309 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2311 MonFdset *mon_fdset;
2312 MonFdsetFd *mon_fdset_fd;
2313 char fd_str[60];
2315 qemu_mutex_lock(&mon_fdsets_lock);
2316 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2317 if (mon_fdset->id != fdset_id) {
2318 continue;
2320 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2321 if (has_fd) {
2322 if (mon_fdset_fd->fd != fd) {
2323 continue;
2325 mon_fdset_fd->removed = true;
2326 break;
2327 } else {
2328 mon_fdset_fd->removed = true;
2331 if (has_fd && !mon_fdset_fd) {
2332 goto error;
2334 monitor_fdset_cleanup(mon_fdset);
2335 qemu_mutex_unlock(&mon_fdsets_lock);
2336 return;
2339 error:
2340 qemu_mutex_unlock(&mon_fdsets_lock);
2341 if (has_fd) {
2342 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2343 fdset_id, fd);
2344 } else {
2345 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2347 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2350 FdsetInfoList *qmp_query_fdsets(Error **errp)
2352 MonFdset *mon_fdset;
2353 MonFdsetFd *mon_fdset_fd;
2354 FdsetInfoList *fdset_list = NULL;
2356 qemu_mutex_lock(&mon_fdsets_lock);
2357 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2358 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2359 FdsetFdInfoList *fdsetfd_list = NULL;
2361 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2362 fdset_info->value->fdset_id = mon_fdset->id;
2364 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2365 FdsetFdInfoList *fdsetfd_info;
2367 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2368 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2369 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2370 if (mon_fdset_fd->opaque) {
2371 fdsetfd_info->value->has_opaque = true;
2372 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2373 } else {
2374 fdsetfd_info->value->has_opaque = false;
2377 fdsetfd_info->next = fdsetfd_list;
2378 fdsetfd_list = fdsetfd_info;
2381 fdset_info->value->fds = fdsetfd_list;
2383 fdset_info->next = fdset_list;
2384 fdset_list = fdset_info;
2386 qemu_mutex_unlock(&mon_fdsets_lock);
2388 return fdset_list;
2391 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2392 bool has_opaque, const char *opaque,
2393 Error **errp)
2395 MonFdset *mon_fdset = NULL;
2396 MonFdsetFd *mon_fdset_fd;
2397 AddfdInfo *fdinfo;
2399 qemu_mutex_lock(&mon_fdsets_lock);
2400 if (has_fdset_id) {
2401 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2402 /* Break if match found or match impossible due to ordering by ID */
2403 if (fdset_id <= mon_fdset->id) {
2404 if (fdset_id < mon_fdset->id) {
2405 mon_fdset = NULL;
2407 break;
2412 if (mon_fdset == NULL) {
2413 int64_t fdset_id_prev = -1;
2414 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2416 if (has_fdset_id) {
2417 if (fdset_id < 0) {
2418 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2419 "a non-negative value");
2420 qemu_mutex_unlock(&mon_fdsets_lock);
2421 return NULL;
2423 /* Use specified fdset ID */
2424 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2425 mon_fdset_cur = mon_fdset;
2426 if (fdset_id < mon_fdset_cur->id) {
2427 break;
2430 } else {
2431 /* Use first available fdset ID */
2432 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2433 mon_fdset_cur = mon_fdset;
2434 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2435 fdset_id_prev = mon_fdset_cur->id;
2436 continue;
2438 break;
2442 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2443 if (has_fdset_id) {
2444 mon_fdset->id = fdset_id;
2445 } else {
2446 mon_fdset->id = fdset_id_prev + 1;
2449 /* The fdset list is ordered by fdset ID */
2450 if (!mon_fdset_cur) {
2451 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2452 } else if (mon_fdset->id < mon_fdset_cur->id) {
2453 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2454 } else {
2455 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2459 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2460 mon_fdset_fd->fd = fd;
2461 mon_fdset_fd->removed = false;
2462 if (has_opaque) {
2463 mon_fdset_fd->opaque = g_strdup(opaque);
2465 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2467 fdinfo = g_malloc0(sizeof(*fdinfo));
2468 fdinfo->fdset_id = mon_fdset->id;
2469 fdinfo->fd = mon_fdset_fd->fd;
2471 qemu_mutex_unlock(&mon_fdsets_lock);
2472 return fdinfo;
2475 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2477 #ifdef _WIN32
2478 return -ENOENT;
2479 #else
2480 MonFdset *mon_fdset;
2481 MonFdsetFd *mon_fdset_fd;
2482 int mon_fd_flags;
2483 int ret;
2485 qemu_mutex_lock(&mon_fdsets_lock);
2486 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2487 if (mon_fdset->id != fdset_id) {
2488 continue;
2490 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2491 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2492 if (mon_fd_flags == -1) {
2493 ret = -errno;
2494 goto out;
2497 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2498 ret = mon_fdset_fd->fd;
2499 goto out;
2502 ret = -EACCES;
2503 goto out;
2505 ret = -ENOENT;
2507 out:
2508 qemu_mutex_unlock(&mon_fdsets_lock);
2509 return ret;
2510 #endif
2513 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2515 MonFdset *mon_fdset;
2516 MonFdsetFd *mon_fdset_fd_dup;
2518 qemu_mutex_lock(&mon_fdsets_lock);
2519 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2520 if (mon_fdset->id != fdset_id) {
2521 continue;
2523 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2524 if (mon_fdset_fd_dup->fd == dup_fd) {
2525 goto err;
2528 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2529 mon_fdset_fd_dup->fd = dup_fd;
2530 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2531 qemu_mutex_unlock(&mon_fdsets_lock);
2532 return 0;
2535 err:
2536 qemu_mutex_unlock(&mon_fdsets_lock);
2537 return -1;
2540 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2542 MonFdset *mon_fdset;
2543 MonFdsetFd *mon_fdset_fd_dup;
2545 qemu_mutex_lock(&mon_fdsets_lock);
2546 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2547 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2548 if (mon_fdset_fd_dup->fd == dup_fd) {
2549 if (remove) {
2550 QLIST_REMOVE(mon_fdset_fd_dup, next);
2551 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2552 monitor_fdset_cleanup(mon_fdset);
2554 goto err;
2555 } else {
2556 qemu_mutex_unlock(&mon_fdsets_lock);
2557 return mon_fdset->id;
2563 err:
2564 qemu_mutex_unlock(&mon_fdsets_lock);
2565 return -1;
2568 int monitor_fdset_dup_fd_find(int dup_fd)
2570 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2573 void monitor_fdset_dup_fd_remove(int dup_fd)
2575 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2578 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2580 int fd;
2581 Error *local_err = NULL;
2583 if (!qemu_isdigit(fdname[0]) && mon) {
2584 fd = monitor_get_fd(mon, fdname, &local_err);
2585 } else {
2586 fd = qemu_parse_fd(fdname);
2587 if (fd == -1) {
2588 error_setg(&local_err, "Invalid file descriptor number '%s'",
2589 fdname);
2592 if (local_err) {
2593 error_propagate(errp, local_err);
2594 assert(fd == -1);
2595 } else {
2596 assert(fd != -1);
2599 return fd;
2602 /* Please update hmp-commands.hx when adding or changing commands */
2603 static mon_cmd_t info_cmds[] = {
2604 #include "hmp-commands-info.h"
2605 { NULL, NULL, },
2608 /* mon_cmds and info_cmds would be sorted at runtime */
2609 static mon_cmd_t mon_cmds[] = {
2610 #include "hmp-commands.h"
2611 { NULL, NULL, },
2614 /*******************************************************************/
2616 static const char *pch;
2617 static sigjmp_buf expr_env;
2620 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2621 expr_error(Monitor *mon, const char *fmt, ...)
2623 va_list ap;
2624 va_start(ap, fmt);
2625 monitor_vprintf(mon, fmt, ap);
2626 monitor_printf(mon, "\n");
2627 va_end(ap);
2628 siglongjmp(expr_env, 1);
2631 /* return 0 if OK, -1 if not found */
2632 static int get_monitor_def(target_long *pval, const char *name)
2634 const MonitorDef *md = target_monitor_defs();
2635 CPUState *cs = mon_get_cpu();
2636 void *ptr;
2637 uint64_t tmp = 0;
2638 int ret;
2640 if (cs == NULL || md == NULL) {
2641 return -1;
2644 for(; md->name != NULL; md++) {
2645 if (compare_cmd(name, md->name)) {
2646 if (md->get_value) {
2647 *pval = md->get_value(md, md->offset);
2648 } else {
2649 CPUArchState *env = mon_get_cpu_env();
2650 ptr = (uint8_t *)env + md->offset;
2651 switch(md->type) {
2652 case MD_I32:
2653 *pval = *(int32_t *)ptr;
2654 break;
2655 case MD_TLONG:
2656 *pval = *(target_long *)ptr;
2657 break;
2658 default:
2659 *pval = 0;
2660 break;
2663 return 0;
2667 ret = target_get_monitor_def(cs, name, &tmp);
2668 if (!ret) {
2669 *pval = (target_long) tmp;
2672 return ret;
2675 static void next(void)
2677 if (*pch != '\0') {
2678 pch++;
2679 while (qemu_isspace(*pch))
2680 pch++;
2684 static int64_t expr_sum(Monitor *mon);
2686 static int64_t expr_unary(Monitor *mon)
2688 int64_t n;
2689 char *p;
2690 int ret;
2692 switch(*pch) {
2693 case '+':
2694 next();
2695 n = expr_unary(mon);
2696 break;
2697 case '-':
2698 next();
2699 n = -expr_unary(mon);
2700 break;
2701 case '~':
2702 next();
2703 n = ~expr_unary(mon);
2704 break;
2705 case '(':
2706 next();
2707 n = expr_sum(mon);
2708 if (*pch != ')') {
2709 expr_error(mon, "')' expected");
2711 next();
2712 break;
2713 case '\'':
2714 pch++;
2715 if (*pch == '\0')
2716 expr_error(mon, "character constant expected");
2717 n = *pch;
2718 pch++;
2719 if (*pch != '\'')
2720 expr_error(mon, "missing terminating \' character");
2721 next();
2722 break;
2723 case '$':
2725 char buf[128], *q;
2726 target_long reg=0;
2728 pch++;
2729 q = buf;
2730 while ((*pch >= 'a' && *pch <= 'z') ||
2731 (*pch >= 'A' && *pch <= 'Z') ||
2732 (*pch >= '0' && *pch <= '9') ||
2733 *pch == '_' || *pch == '.') {
2734 if ((q - buf) < sizeof(buf) - 1)
2735 *q++ = *pch;
2736 pch++;
2738 while (qemu_isspace(*pch))
2739 pch++;
2740 *q = 0;
2741 ret = get_monitor_def(&reg, buf);
2742 if (ret < 0)
2743 expr_error(mon, "unknown register");
2744 n = reg;
2746 break;
2747 case '\0':
2748 expr_error(mon, "unexpected end of expression");
2749 n = 0;
2750 break;
2751 default:
2752 errno = 0;
2753 n = strtoull(pch, &p, 0);
2754 if (errno == ERANGE) {
2755 expr_error(mon, "number too large");
2757 if (pch == p) {
2758 expr_error(mon, "invalid char '%c' in expression", *p);
2760 pch = p;
2761 while (qemu_isspace(*pch))
2762 pch++;
2763 break;
2765 return n;
2769 static int64_t expr_prod(Monitor *mon)
2771 int64_t val, val2;
2772 int op;
2774 val = expr_unary(mon);
2775 for(;;) {
2776 op = *pch;
2777 if (op != '*' && op != '/' && op != '%')
2778 break;
2779 next();
2780 val2 = expr_unary(mon);
2781 switch(op) {
2782 default:
2783 case '*':
2784 val *= val2;
2785 break;
2786 case '/':
2787 case '%':
2788 if (val2 == 0)
2789 expr_error(mon, "division by zero");
2790 if (op == '/')
2791 val /= val2;
2792 else
2793 val %= val2;
2794 break;
2797 return val;
2800 static int64_t expr_logic(Monitor *mon)
2802 int64_t val, val2;
2803 int op;
2805 val = expr_prod(mon);
2806 for(;;) {
2807 op = *pch;
2808 if (op != '&' && op != '|' && op != '^')
2809 break;
2810 next();
2811 val2 = expr_prod(mon);
2812 switch(op) {
2813 default:
2814 case '&':
2815 val &= val2;
2816 break;
2817 case '|':
2818 val |= val2;
2819 break;
2820 case '^':
2821 val ^= val2;
2822 break;
2825 return val;
2828 static int64_t expr_sum(Monitor *mon)
2830 int64_t val, val2;
2831 int op;
2833 val = expr_logic(mon);
2834 for(;;) {
2835 op = *pch;
2836 if (op != '+' && op != '-')
2837 break;
2838 next();
2839 val2 = expr_logic(mon);
2840 if (op == '+')
2841 val += val2;
2842 else
2843 val -= val2;
2845 return val;
2848 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2850 pch = *pp;
2851 if (sigsetjmp(expr_env, 0)) {
2852 *pp = pch;
2853 return -1;
2855 while (qemu_isspace(*pch))
2856 pch++;
2857 *pval = expr_sum(mon);
2858 *pp = pch;
2859 return 0;
2862 static int get_double(Monitor *mon, double *pval, const char **pp)
2864 const char *p = *pp;
2865 char *tailp;
2866 double d;
2868 d = strtod(p, &tailp);
2869 if (tailp == p) {
2870 monitor_printf(mon, "Number expected\n");
2871 return -1;
2873 if (d != d || d - d != 0) {
2874 /* NaN or infinity */
2875 monitor_printf(mon, "Bad number\n");
2876 return -1;
2878 *pval = d;
2879 *pp = tailp;
2880 return 0;
2884 * Store the command-name in cmdname, and return a pointer to
2885 * the remaining of the command string.
2887 static const char *get_command_name(const char *cmdline,
2888 char *cmdname, size_t nlen)
2890 size_t len;
2891 const char *p, *pstart;
2893 p = cmdline;
2894 while (qemu_isspace(*p))
2895 p++;
2896 if (*p == '\0')
2897 return NULL;
2898 pstart = p;
2899 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2900 p++;
2901 len = p - pstart;
2902 if (len > nlen - 1)
2903 len = nlen - 1;
2904 memcpy(cmdname, pstart, len);
2905 cmdname[len] = '\0';
2906 return p;
2910 * Read key of 'type' into 'key' and return the current
2911 * 'type' pointer.
2913 static char *key_get_info(const char *type, char **key)
2915 size_t len;
2916 char *p, *str;
2918 if (*type == ',')
2919 type++;
2921 p = strchr(type, ':');
2922 if (!p) {
2923 *key = NULL;
2924 return NULL;
2926 len = p - type;
2928 str = g_malloc(len + 1);
2929 memcpy(str, type, len);
2930 str[len] = '\0';
2932 *key = str;
2933 return ++p;
2936 static int default_fmt_format = 'x';
2937 static int default_fmt_size = 4;
2939 static int is_valid_option(const char *c, const char *typestr)
2941 char option[3];
2943 option[0] = '-';
2944 option[1] = *c;
2945 option[2] = '\0';
2947 typestr = strstr(typestr, option);
2948 return (typestr != NULL);
2951 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2952 const char *cmdname)
2954 const mon_cmd_t *cmd;
2956 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2957 if (compare_cmd(cmdname, cmd->name)) {
2958 return cmd;
2962 return NULL;
2966 * Parse command name from @cmdp according to command table @table.
2967 * If blank, return NULL.
2968 * Else, if no valid command can be found, report to @mon, and return
2969 * NULL.
2970 * Else, change @cmdp to point right behind the name, and return its
2971 * command table entry.
2972 * Do not assume the return value points into @table! It doesn't when
2973 * the command is found in a sub-command table.
2975 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2976 const char *cmdp_start,
2977 const char **cmdp,
2978 mon_cmd_t *table)
2980 const char *p;
2981 const mon_cmd_t *cmd;
2982 char cmdname[256];
2984 /* extract the command name */
2985 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2986 if (!p)
2987 return NULL;
2989 cmd = search_dispatch_table(table, cmdname);
2990 if (!cmd) {
2991 monitor_printf(mon, "unknown command: '%.*s'\n",
2992 (int)(p - cmdp_start), cmdp_start);
2993 return NULL;
2995 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
2996 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
2997 "until after exit_preconfig.\n",
2998 (int)(p - cmdp_start), cmdp_start);
2999 return NULL;
3002 /* filter out following useless space */
3003 while (qemu_isspace(*p)) {
3004 p++;
3007 *cmdp = p;
3008 /* search sub command */
3009 if (cmd->sub_table != NULL && *p != '\0') {
3010 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3013 return cmd;
3017 * Parse arguments for @cmd.
3018 * If it can't be parsed, report to @mon, and return NULL.
3019 * Else, insert command arguments into a QDict, and return it.
3020 * Note: On success, caller has to free the QDict structure.
3023 static QDict *monitor_parse_arguments(Monitor *mon,
3024 const char **endp,
3025 const mon_cmd_t *cmd)
3027 const char *typestr;
3028 char *key;
3029 int c;
3030 const char *p = *endp;
3031 char buf[1024];
3032 QDict *qdict = qdict_new();
3034 /* parse the parameters */
3035 typestr = cmd->args_type;
3036 for(;;) {
3037 typestr = key_get_info(typestr, &key);
3038 if (!typestr)
3039 break;
3040 c = *typestr;
3041 typestr++;
3042 switch(c) {
3043 case 'F':
3044 case 'B':
3045 case 's':
3047 int ret;
3049 while (qemu_isspace(*p))
3050 p++;
3051 if (*typestr == '?') {
3052 typestr++;
3053 if (*p == '\0') {
3054 /* no optional string: NULL argument */
3055 break;
3058 ret = get_str(buf, sizeof(buf), &p);
3059 if (ret < 0) {
3060 switch(c) {
3061 case 'F':
3062 monitor_printf(mon, "%s: filename expected\n",
3063 cmd->name);
3064 break;
3065 case 'B':
3066 monitor_printf(mon, "%s: block device name expected\n",
3067 cmd->name);
3068 break;
3069 default:
3070 monitor_printf(mon, "%s: string expected\n", cmd->name);
3071 break;
3073 goto fail;
3075 qdict_put_str(qdict, key, buf);
3077 break;
3078 case 'O':
3080 QemuOptsList *opts_list;
3081 QemuOpts *opts;
3083 opts_list = qemu_find_opts(key);
3084 if (!opts_list || opts_list->desc->name) {
3085 goto bad_type;
3087 while (qemu_isspace(*p)) {
3088 p++;
3090 if (!*p)
3091 break;
3092 if (get_str(buf, sizeof(buf), &p) < 0) {
3093 goto fail;
3095 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3096 if (!opts) {
3097 goto fail;
3099 qemu_opts_to_qdict(opts, qdict);
3100 qemu_opts_del(opts);
3102 break;
3103 case '/':
3105 int count, format, size;
3107 while (qemu_isspace(*p))
3108 p++;
3109 if (*p == '/') {
3110 /* format found */
3111 p++;
3112 count = 1;
3113 if (qemu_isdigit(*p)) {
3114 count = 0;
3115 while (qemu_isdigit(*p)) {
3116 count = count * 10 + (*p - '0');
3117 p++;
3120 size = -1;
3121 format = -1;
3122 for(;;) {
3123 switch(*p) {
3124 case 'o':
3125 case 'd':
3126 case 'u':
3127 case 'x':
3128 case 'i':
3129 case 'c':
3130 format = *p++;
3131 break;
3132 case 'b':
3133 size = 1;
3134 p++;
3135 break;
3136 case 'h':
3137 size = 2;
3138 p++;
3139 break;
3140 case 'w':
3141 size = 4;
3142 p++;
3143 break;
3144 case 'g':
3145 case 'L':
3146 size = 8;
3147 p++;
3148 break;
3149 default:
3150 goto next;
3153 next:
3154 if (*p != '\0' && !qemu_isspace(*p)) {
3155 monitor_printf(mon, "invalid char in format: '%c'\n",
3156 *p);
3157 goto fail;
3159 if (format < 0)
3160 format = default_fmt_format;
3161 if (format != 'i') {
3162 /* for 'i', not specifying a size gives -1 as size */
3163 if (size < 0)
3164 size = default_fmt_size;
3165 default_fmt_size = size;
3167 default_fmt_format = format;
3168 } else {
3169 count = 1;
3170 format = default_fmt_format;
3171 if (format != 'i') {
3172 size = default_fmt_size;
3173 } else {
3174 size = -1;
3177 qdict_put_int(qdict, "count", count);
3178 qdict_put_int(qdict, "format", format);
3179 qdict_put_int(qdict, "size", size);
3181 break;
3182 case 'i':
3183 case 'l':
3184 case 'M':
3186 int64_t val;
3188 while (qemu_isspace(*p))
3189 p++;
3190 if (*typestr == '?' || *typestr == '.') {
3191 if (*typestr == '?') {
3192 if (*p == '\0') {
3193 typestr++;
3194 break;
3196 } else {
3197 if (*p == '.') {
3198 p++;
3199 while (qemu_isspace(*p))
3200 p++;
3201 } else {
3202 typestr++;
3203 break;
3206 typestr++;
3208 if (get_expr(mon, &val, &p))
3209 goto fail;
3210 /* Check if 'i' is greater than 32-bit */
3211 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3212 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3213 monitor_printf(mon, "integer is for 32-bit values\n");
3214 goto fail;
3215 } else if (c == 'M') {
3216 if (val < 0) {
3217 monitor_printf(mon, "enter a positive value\n");
3218 goto fail;
3220 val *= MiB;
3222 qdict_put_int(qdict, key, val);
3224 break;
3225 case 'o':
3227 int ret;
3228 uint64_t val;
3229 char *end;
3231 while (qemu_isspace(*p)) {
3232 p++;
3234 if (*typestr == '?') {
3235 typestr++;
3236 if (*p == '\0') {
3237 break;
3240 ret = qemu_strtosz_MiB(p, &end, &val);
3241 if (ret < 0 || val > INT64_MAX) {
3242 monitor_printf(mon, "invalid size\n");
3243 goto fail;
3245 qdict_put_int(qdict, key, val);
3246 p = end;
3248 break;
3249 case 'T':
3251 double val;
3253 while (qemu_isspace(*p))
3254 p++;
3255 if (*typestr == '?') {
3256 typestr++;
3257 if (*p == '\0') {
3258 break;
3261 if (get_double(mon, &val, &p) < 0) {
3262 goto fail;
3264 if (p[0] && p[1] == 's') {
3265 switch (*p) {
3266 case 'm':
3267 val /= 1e3; p += 2; break;
3268 case 'u':
3269 val /= 1e6; p += 2; break;
3270 case 'n':
3271 val /= 1e9; p += 2; break;
3274 if (*p && !qemu_isspace(*p)) {
3275 monitor_printf(mon, "Unknown unit suffix\n");
3276 goto fail;
3278 qdict_put(qdict, key, qnum_from_double(val));
3280 break;
3281 case 'b':
3283 const char *beg;
3284 bool val;
3286 while (qemu_isspace(*p)) {
3287 p++;
3289 beg = p;
3290 while (qemu_isgraph(*p)) {
3291 p++;
3293 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3294 val = true;
3295 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3296 val = false;
3297 } else {
3298 monitor_printf(mon, "Expected 'on' or 'off'\n");
3299 goto fail;
3301 qdict_put_bool(qdict, key, val);
3303 break;
3304 case '-':
3306 const char *tmp = p;
3307 int skip_key = 0;
3308 /* option */
3310 c = *typestr++;
3311 if (c == '\0')
3312 goto bad_type;
3313 while (qemu_isspace(*p))
3314 p++;
3315 if (*p == '-') {
3316 p++;
3317 if(c != *p) {
3318 if(!is_valid_option(p, typestr)) {
3320 monitor_printf(mon, "%s: unsupported option -%c\n",
3321 cmd->name, *p);
3322 goto fail;
3323 } else {
3324 skip_key = 1;
3327 if(skip_key) {
3328 p = tmp;
3329 } else {
3330 /* has option */
3331 p++;
3332 qdict_put_bool(qdict, key, true);
3336 break;
3337 case 'S':
3339 /* package all remaining string */
3340 int len;
3342 while (qemu_isspace(*p)) {
3343 p++;
3345 if (*typestr == '?') {
3346 typestr++;
3347 if (*p == '\0') {
3348 /* no remaining string: NULL argument */
3349 break;
3352 len = strlen(p);
3353 if (len <= 0) {
3354 monitor_printf(mon, "%s: string expected\n",
3355 cmd->name);
3356 goto fail;
3358 qdict_put_str(qdict, key, p);
3359 p += len;
3361 break;
3362 default:
3363 bad_type:
3364 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3365 goto fail;
3367 g_free(key);
3368 key = NULL;
3370 /* check that all arguments were parsed */
3371 while (qemu_isspace(*p))
3372 p++;
3373 if (*p != '\0') {
3374 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3375 cmd->name);
3376 goto fail;
3379 return qdict;
3381 fail:
3382 qobject_unref(qdict);
3383 g_free(key);
3384 return NULL;
3387 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3389 QDict *qdict;
3390 const mon_cmd_t *cmd;
3391 const char *cmd_start = cmdline;
3393 trace_handle_hmp_command(mon, cmdline);
3395 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3396 if (!cmd) {
3397 return;
3400 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3401 if (!qdict) {
3402 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3403 cmdline--;
3405 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3406 (int)(cmdline - cmd_start), cmd_start);
3407 return;
3410 cmd->cmd(mon, qdict);
3411 qobject_unref(qdict);
3414 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3416 const char *p, *pstart;
3417 char cmd[128];
3418 int len;
3420 p = list;
3421 for(;;) {
3422 pstart = p;
3423 p = qemu_strchrnul(p, '|');
3424 len = p - pstart;
3425 if (len > sizeof(cmd) - 2)
3426 len = sizeof(cmd) - 2;
3427 memcpy(cmd, pstart, len);
3428 cmd[len] = '\0';
3429 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3430 readline_add_completion(mon->rs, cmd);
3432 if (*p == '\0')
3433 break;
3434 p++;
3438 static void file_completion(Monitor *mon, const char *input)
3440 DIR *ffs;
3441 struct dirent *d;
3442 char path[1024];
3443 char file[1024], file_prefix[1024];
3444 int input_path_len;
3445 const char *p;
3447 p = strrchr(input, '/');
3448 if (!p) {
3449 input_path_len = 0;
3450 pstrcpy(file_prefix, sizeof(file_prefix), input);
3451 pstrcpy(path, sizeof(path), ".");
3452 } else {
3453 input_path_len = p - input + 1;
3454 memcpy(path, input, input_path_len);
3455 if (input_path_len > sizeof(path) - 1)
3456 input_path_len = sizeof(path) - 1;
3457 path[input_path_len] = '\0';
3458 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3461 ffs = opendir(path);
3462 if (!ffs)
3463 return;
3464 for(;;) {
3465 struct stat sb;
3466 d = readdir(ffs);
3467 if (!d)
3468 break;
3470 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3471 continue;
3474 if (strstart(d->d_name, file_prefix, NULL)) {
3475 memcpy(file, input, input_path_len);
3476 if (input_path_len < sizeof(file))
3477 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3478 d->d_name);
3479 /* stat the file to find out if it's a directory.
3480 * In that case add a slash to speed up typing long paths
3482 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3483 pstrcat(file, sizeof(file), "/");
3485 readline_add_completion(mon->rs, file);
3488 closedir(ffs);
3491 static const char *next_arg_type(const char *typestr)
3493 const char *p = strchr(typestr, ':');
3494 return (p != NULL ? ++p : typestr);
3497 static void add_completion_option(ReadLineState *rs, const char *str,
3498 const char *option)
3500 if (!str || !option) {
3501 return;
3503 if (!strncmp(option, str, strlen(str))) {
3504 readline_add_completion(rs, option);
3508 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3510 size_t len;
3511 ChardevBackendInfoList *list, *start;
3513 if (nb_args != 2) {
3514 return;
3516 len = strlen(str);
3517 readline_set_completion_index(rs, len);
3519 start = list = qmp_query_chardev_backends(NULL);
3520 while (list) {
3521 const char *chr_name = list->value->name;
3523 if (!strncmp(chr_name, str, len)) {
3524 readline_add_completion(rs, chr_name);
3526 list = list->next;
3528 qapi_free_ChardevBackendInfoList(start);
3531 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3533 size_t len;
3534 int i;
3536 if (nb_args != 2) {
3537 return;
3539 len = strlen(str);
3540 readline_set_completion_index(rs, len);
3541 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3542 add_completion_option(rs, str, NetClientDriver_str(i));
3546 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3548 GSList *list, *elt;
3549 size_t len;
3551 if (nb_args != 2) {
3552 return;
3555 len = strlen(str);
3556 readline_set_completion_index(rs, len);
3557 list = elt = object_class_get_list(TYPE_DEVICE, false);
3558 while (elt) {
3559 const char *name;
3560 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3561 TYPE_DEVICE);
3562 name = object_class_get_name(OBJECT_CLASS(dc));
3564 if (dc->user_creatable
3565 && !strncmp(name, str, len)) {
3566 readline_add_completion(rs, name);
3568 elt = elt->next;
3570 g_slist_free(list);
3573 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3575 GSList *list, *elt;
3576 size_t len;
3578 if (nb_args != 2) {
3579 return;
3582 len = strlen(str);
3583 readline_set_completion_index(rs, len);
3584 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3585 while (elt) {
3586 const char *name;
3588 name = object_class_get_name(OBJECT_CLASS(elt->data));
3589 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3590 readline_add_completion(rs, name);
3592 elt = elt->next;
3594 g_slist_free(list);
3597 static void peripheral_device_del_completion(ReadLineState *rs,
3598 const char *str, size_t len)
3600 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3601 GSList *list, *item;
3603 list = qdev_build_hotpluggable_device_list(peripheral);
3604 if (!list) {
3605 return;
3608 for (item = list; item; item = g_slist_next(item)) {
3609 DeviceState *dev = item->data;
3611 if (dev->id && !strncmp(str, dev->id, len)) {
3612 readline_add_completion(rs, dev->id);
3616 g_slist_free(list);
3619 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3621 size_t len;
3622 ChardevInfoList *list, *start;
3624 if (nb_args != 2) {
3625 return;
3627 len = strlen(str);
3628 readline_set_completion_index(rs, len);
3630 start = list = qmp_query_chardev(NULL);
3631 while (list) {
3632 ChardevInfo *chr = list->value;
3634 if (!strncmp(chr->label, str, len)) {
3635 readline_add_completion(rs, chr->label);
3637 list = list->next;
3639 qapi_free_ChardevInfoList(start);
3642 static void ringbuf_completion(ReadLineState *rs, const char *str)
3644 size_t len;
3645 ChardevInfoList *list, *start;
3647 len = strlen(str);
3648 readline_set_completion_index(rs, len);
3650 start = list = qmp_query_chardev(NULL);
3651 while (list) {
3652 ChardevInfo *chr_info = list->value;
3654 if (!strncmp(chr_info->label, str, len)) {
3655 Chardev *chr = qemu_chr_find(chr_info->label);
3656 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3657 readline_add_completion(rs, chr_info->label);
3660 list = list->next;
3662 qapi_free_ChardevInfoList(start);
3665 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3667 if (nb_args != 2) {
3668 return;
3670 ringbuf_completion(rs, str);
3673 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3675 size_t len;
3677 if (nb_args != 2) {
3678 return;
3681 len = strlen(str);
3682 readline_set_completion_index(rs, len);
3683 peripheral_device_del_completion(rs, str, len);
3686 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3688 ObjectPropertyInfoList *list, *start;
3689 size_t len;
3691 if (nb_args != 2) {
3692 return;
3694 len = strlen(str);
3695 readline_set_completion_index(rs, len);
3697 start = list = qmp_qom_list("/objects", NULL);
3698 while (list) {
3699 ObjectPropertyInfo *info = list->value;
3701 if (!strncmp(info->type, "child<", 5)
3702 && !strncmp(info->name, str, len)) {
3703 readline_add_completion(rs, info->name);
3705 list = list->next;
3707 qapi_free_ObjectPropertyInfoList(start);
3710 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3712 int i;
3713 char *sep;
3714 size_t len;
3716 if (nb_args != 2) {
3717 return;
3719 sep = strrchr(str, '-');
3720 if (sep) {
3721 str = sep + 1;
3723 len = strlen(str);
3724 readline_set_completion_index(rs, len);
3725 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3726 if (!strncmp(str, QKeyCode_str(i), len)) {
3727 readline_add_completion(rs, QKeyCode_str(i));
3732 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3734 size_t len;
3736 len = strlen(str);
3737 readline_set_completion_index(rs, len);
3738 if (nb_args == 2) {
3739 NetClientState *ncs[MAX_QUEUE_NUM];
3740 int count, i;
3741 count = qemu_find_net_clients_except(NULL, ncs,
3742 NET_CLIENT_DRIVER_NONE,
3743 MAX_QUEUE_NUM);
3744 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3745 const char *name = ncs[i]->name;
3746 if (!strncmp(str, name, len)) {
3747 readline_add_completion(rs, name);
3750 } else if (nb_args == 3) {
3751 add_completion_option(rs, str, "on");
3752 add_completion_option(rs, str, "off");
3756 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3758 int len, count, i;
3759 NetClientState *ncs[MAX_QUEUE_NUM];
3761 if (nb_args != 2) {
3762 return;
3765 len = strlen(str);
3766 readline_set_completion_index(rs, len);
3767 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3768 MAX_QUEUE_NUM);
3769 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3770 QemuOpts *opts;
3771 const char *name = ncs[i]->name;
3772 if (strncmp(str, name, len)) {
3773 continue;
3775 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3776 if (opts) {
3777 readline_add_completion(rs, name);
3782 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3784 size_t len;
3786 len = strlen(str);
3787 readline_set_completion_index(rs, len);
3788 if (nb_args == 2) {
3789 TraceEventIter iter;
3790 TraceEvent *ev;
3791 char *pattern = g_strdup_printf("%s*", str);
3792 trace_event_iter_init(&iter, pattern);
3793 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3794 readline_add_completion(rs, trace_event_get_name(ev));
3796 g_free(pattern);
3800 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3802 size_t len;
3804 len = strlen(str);
3805 readline_set_completion_index(rs, len);
3806 if (nb_args == 2) {
3807 TraceEventIter iter;
3808 TraceEvent *ev;
3809 char *pattern = g_strdup_printf("%s*", str);
3810 trace_event_iter_init(&iter, pattern);
3811 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3812 readline_add_completion(rs, trace_event_get_name(ev));
3814 g_free(pattern);
3815 } else if (nb_args == 3) {
3816 add_completion_option(rs, str, "on");
3817 add_completion_option(rs, str, "off");
3821 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3823 int i;
3825 if (nb_args != 2) {
3826 return;
3828 readline_set_completion_index(rs, strlen(str));
3829 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3830 add_completion_option(rs, str, WatchdogAction_str(i));
3834 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3835 const char *str)
3837 size_t len;
3839 len = strlen(str);
3840 readline_set_completion_index(rs, len);
3841 if (nb_args == 2) {
3842 int i;
3843 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3844 const char *name = MigrationCapability_str(i);
3845 if (!strncmp(str, name, len)) {
3846 readline_add_completion(rs, name);
3849 } else if (nb_args == 3) {
3850 add_completion_option(rs, str, "on");
3851 add_completion_option(rs, str, "off");
3855 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3856 const char *str)
3858 size_t len;
3860 len = strlen(str);
3861 readline_set_completion_index(rs, len);
3862 if (nb_args == 2) {
3863 int i;
3864 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3865 const char *name = MigrationParameter_str(i);
3866 if (!strncmp(str, name, len)) {
3867 readline_add_completion(rs, name);
3873 static void vm_completion(ReadLineState *rs, const char *str)
3875 size_t len;
3876 BlockDriverState *bs;
3877 BdrvNextIterator it;
3879 len = strlen(str);
3880 readline_set_completion_index(rs, len);
3882 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3883 SnapshotInfoList *snapshots, *snapshot;
3884 AioContext *ctx = bdrv_get_aio_context(bs);
3885 bool ok = false;
3887 aio_context_acquire(ctx);
3888 if (bdrv_can_snapshot(bs)) {
3889 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3891 aio_context_release(ctx);
3892 if (!ok) {
3893 continue;
3896 snapshot = snapshots;
3897 while (snapshot) {
3898 char *completion = snapshot->value->name;
3899 if (!strncmp(str, completion, len)) {
3900 readline_add_completion(rs, completion);
3902 completion = snapshot->value->id;
3903 if (!strncmp(str, completion, len)) {
3904 readline_add_completion(rs, completion);
3906 snapshot = snapshot->next;
3908 qapi_free_SnapshotInfoList(snapshots);
3913 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3915 if (nb_args == 2) {
3916 vm_completion(rs, str);
3920 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3922 if (nb_args == 2) {
3923 vm_completion(rs, str);
3927 static void monitor_find_completion_by_table(Monitor *mon,
3928 const mon_cmd_t *cmd_table,
3929 char **args,
3930 int nb_args)
3932 const char *cmdname;
3933 int i;
3934 const char *ptype, *old_ptype, *str, *name;
3935 const mon_cmd_t *cmd;
3936 BlockBackend *blk = NULL;
3938 if (nb_args <= 1) {
3939 /* command completion */
3940 if (nb_args == 0)
3941 cmdname = "";
3942 else
3943 cmdname = args[0];
3944 readline_set_completion_index(mon->rs, strlen(cmdname));
3945 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3946 if (!runstate_check(RUN_STATE_PRECONFIG) ||
3947 cmd_can_preconfig(cmd)) {
3948 cmd_completion(mon, cmdname, cmd->name);
3951 } else {
3952 /* find the command */
3953 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3954 if (compare_cmd(args[0], cmd->name) &&
3955 (!runstate_check(RUN_STATE_PRECONFIG) ||
3956 cmd_can_preconfig(cmd))) {
3957 break;
3960 if (!cmd->name) {
3961 return;
3964 if (cmd->sub_table) {
3965 /* do the job again */
3966 monitor_find_completion_by_table(mon, cmd->sub_table,
3967 &args[1], nb_args - 1);
3968 return;
3970 if (cmd->command_completion) {
3971 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3972 return;
3975 ptype = next_arg_type(cmd->args_type);
3976 for(i = 0; i < nb_args - 2; i++) {
3977 if (*ptype != '\0') {
3978 ptype = next_arg_type(ptype);
3979 while (*ptype == '?')
3980 ptype = next_arg_type(ptype);
3983 str = args[nb_args - 1];
3984 old_ptype = NULL;
3985 while (*ptype == '-' && old_ptype != ptype) {
3986 old_ptype = ptype;
3987 ptype = next_arg_type(ptype);
3989 switch(*ptype) {
3990 case 'F':
3991 /* file completion */
3992 readline_set_completion_index(mon->rs, strlen(str));
3993 file_completion(mon, str);
3994 break;
3995 case 'B':
3996 /* block device name completion */
3997 readline_set_completion_index(mon->rs, strlen(str));
3998 while ((blk = blk_next(blk)) != NULL) {
3999 name = blk_name(blk);
4000 if (str[0] == '\0' ||
4001 !strncmp(name, str, strlen(str))) {
4002 readline_add_completion(mon->rs, name);
4005 break;
4006 case 's':
4007 case 'S':
4008 if (!strcmp(cmd->name, "help|?")) {
4009 monitor_find_completion_by_table(mon, cmd_table,
4010 &args[1], nb_args - 1);
4012 break;
4013 default:
4014 break;
4019 static void monitor_find_completion(void *opaque,
4020 const char *cmdline)
4022 Monitor *mon = opaque;
4023 char *args[MAX_ARGS];
4024 int nb_args, len;
4026 /* 1. parse the cmdline */
4027 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4028 return;
4031 /* if the line ends with a space, it means we want to complete the
4032 next arg */
4033 len = strlen(cmdline);
4034 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4035 if (nb_args >= MAX_ARGS) {
4036 goto cleanup;
4038 args[nb_args++] = g_strdup("");
4041 /* 2. auto complete according to args */
4042 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4044 cleanup:
4045 free_cmdline_args(args, nb_args);
4048 static int monitor_can_read(void *opaque)
4050 Monitor *mon = opaque;
4052 return !atomic_mb_read(&mon->suspend_cnt);
4056 * Emit QMP response @rsp with ID @id to @mon.
4057 * Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
4058 * Nothing is emitted then.
4060 static void monitor_qmp_respond(Monitor *mon, QDict *rsp, QObject *id)
4062 if (rsp) {
4063 if (id) {
4064 qdict_put_obj(rsp, "id", qobject_ref(id));
4067 qmp_send_response(mon, rsp);
4071 static void monitor_qmp_dispatch(Monitor *mon, QObject *req, QObject *id)
4073 Monitor *old_mon;
4074 QDict *rsp;
4075 QDict *error;
4077 old_mon = cur_mon;
4078 cur_mon = mon;
4080 rsp = qmp_dispatch(mon->qmp.commands, req, qmp_oob_enabled(mon));
4082 cur_mon = old_mon;
4084 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
4085 error = qdict_get_qdict(rsp, "error");
4086 if (error
4087 && !g_strcmp0(qdict_get_try_str(error, "class"),
4088 QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
4089 /* Provide a more useful error message */
4090 qdict_del(error, "desc");
4091 qdict_put_str(error, "desc", "Expecting capabilities negotiation"
4092 " with 'qmp_capabilities'");
4096 monitor_qmp_respond(mon, rsp, id);
4097 qobject_unref(rsp);
4101 * Pop a QMP request from a monitor request queue.
4102 * Return the request, or NULL all request queues are empty.
4103 * We are using round-robin fashion to pop the request, to avoid
4104 * processing commands only on a very busy monitor. To achieve that,
4105 * when we process one request on a specific monitor, we put that
4106 * monitor to the end of mon_list queue.
4108 static QMPRequest *monitor_qmp_requests_pop_any(void)
4110 QMPRequest *req_obj = NULL;
4111 Monitor *mon;
4113 qemu_mutex_lock(&monitor_lock);
4115 QTAILQ_FOREACH(mon, &mon_list, entry) {
4116 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4117 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4118 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4119 if (req_obj) {
4120 break;
4124 if (req_obj) {
4126 * We found one request on the monitor. Degrade this monitor's
4127 * priority to lowest by re-inserting it to end of queue.
4129 QTAILQ_REMOVE(&mon_list, mon, entry);
4130 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4133 qemu_mutex_unlock(&monitor_lock);
4135 return req_obj;
4138 static void monitor_qmp_bh_dispatcher(void *data)
4140 QMPRequest *req_obj = monitor_qmp_requests_pop_any();
4141 QDict *rsp;
4142 bool need_resume;
4144 if (!req_obj) {
4145 return;
4148 /* qmp_oob_enabled() might change after "qmp_capabilities" */
4149 need_resume = !qmp_oob_enabled(req_obj->mon);
4150 if (req_obj->req) {
4151 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(req_obj->id) ?: "");
4152 monitor_qmp_dispatch(req_obj->mon, req_obj->req, req_obj->id);
4153 } else {
4154 assert(req_obj->err);
4155 rsp = qmp_error_response(req_obj->err);
4156 req_obj->err = NULL;
4157 monitor_qmp_respond(req_obj->mon, rsp, NULL);
4158 qobject_unref(rsp);
4161 if (need_resume) {
4162 /* Pairs with the monitor_suspend() in handle_qmp_command() */
4163 monitor_resume(req_obj->mon);
4165 qmp_request_free(req_obj);
4167 /* Reschedule instead of looping so the main loop stays responsive */
4168 qemu_bh_schedule(qmp_dispatcher_bh);
4171 #define QMP_REQ_QUEUE_LEN_MAX (8)
4173 static void handle_qmp_command(void *opaque, QObject *req, Error *err)
4175 Monitor *mon = opaque;
4176 QObject *id = NULL;
4177 QDict *qdict;
4178 QMPRequest *req_obj;
4180 assert(!req != !err);
4182 qdict = qobject_to(QDict, req);
4183 if (qdict) {
4184 id = qobject_ref(qdict_get(qdict, "id"));
4185 qdict_del(qdict, "id");
4186 } /* else will fail qmp_dispatch() */
4188 if (req && trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4189 QString *req_json = qobject_to_json(req);
4190 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4191 qobject_unref(req_json);
4194 if (qdict && qmp_is_oob(qdict)) {
4195 /* OOB commands are executed immediately */
4196 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id)
4197 ?: "");
4198 monitor_qmp_dispatch(mon, req, id);
4199 qobject_unref(req);
4200 qobject_unref(id);
4201 return;
4204 req_obj = g_new0(QMPRequest, 1);
4205 req_obj->mon = mon;
4206 req_obj->id = id;
4207 req_obj->req = req;
4208 req_obj->err = err;
4210 /* Protect qmp_requests and fetching its length. */
4211 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4214 * If OOB is not enabled on the current monitor, we'll emulate the
4215 * old behavior that we won't process the current monitor any more
4216 * until it has responded. This helps make sure that as long as
4217 * OOB is not enabled, the server will never drop any command.
4219 if (!qmp_oob_enabled(mon)) {
4220 monitor_suspend(mon);
4221 } else {
4222 /* Drop the request if queue is full. */
4223 if (mon->qmp.qmp_requests->length >= QMP_REQ_QUEUE_LEN_MAX) {
4224 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4226 * FIXME @id's scope is just @mon, and broadcasting it is
4227 * wrong. If another monitor's client has a command with
4228 * the same ID in flight, the event will incorrectly claim
4229 * that command was dropped.
4231 qapi_event_send_command_dropped(id,
4232 COMMAND_DROP_REASON_QUEUE_FULL);
4233 qmp_request_free(req_obj);
4234 return;
4239 * Put the request to the end of queue so that requests will be
4240 * handled in time order. Ownership for req_obj, req, id,
4241 * etc. will be delivered to the handler side.
4243 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4244 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4246 /* Kick the dispatcher routine */
4247 qemu_bh_schedule(qmp_dispatcher_bh);
4250 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4252 Monitor *mon = opaque;
4254 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4257 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4259 Monitor *old_mon = cur_mon;
4260 int i;
4262 cur_mon = opaque;
4264 if (cur_mon->rs) {
4265 for (i = 0; i < size; i++)
4266 readline_handle_byte(cur_mon->rs, buf[i]);
4267 } else {
4268 if (size == 0 || buf[size - 1] != 0)
4269 monitor_printf(cur_mon, "corrupted command\n");
4270 else
4271 handle_hmp_command(cur_mon, (char *)buf);
4274 cur_mon = old_mon;
4277 static void monitor_command_cb(void *opaque, const char *cmdline,
4278 void *readline_opaque)
4280 Monitor *mon = opaque;
4282 monitor_suspend(mon);
4283 handle_hmp_command(mon, cmdline);
4284 monitor_resume(mon);
4287 int monitor_suspend(Monitor *mon)
4289 if (monitor_is_hmp_non_interactive(mon)) {
4290 return -ENOTTY;
4293 atomic_inc(&mon->suspend_cnt);
4295 if (monitor_is_qmp(mon)) {
4297 * Kick I/O thread to make sure this takes effect. It'll be
4298 * evaluated again in prepare() of the watch object.
4300 aio_notify(iothread_get_aio_context(mon_iothread));
4303 trace_monitor_suspend(mon, 1);
4304 return 0;
4307 void monitor_resume(Monitor *mon)
4309 if (monitor_is_hmp_non_interactive(mon)) {
4310 return;
4313 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4314 if (monitor_is_qmp(mon)) {
4316 * For QMP monitors that are running in the I/O thread,
4317 * let's kick the thread in case it's sleeping.
4319 if (mon->use_io_thread) {
4320 aio_notify(iothread_get_aio_context(mon_iothread));
4322 } else {
4323 assert(mon->rs);
4324 readline_show_prompt(mon->rs);
4326 qemu_chr_fe_accept_input(&mon->chr);
4328 trace_monitor_suspend(mon, -1);
4331 static QDict *qmp_greeting(Monitor *mon)
4333 QList *cap_list = qlist_new();
4334 QObject *ver = NULL;
4335 QMPCapability cap;
4337 qmp_marshal_query_version(NULL, &ver, NULL);
4339 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4340 if (mon->qmp.capab_offered[cap]) {
4341 qlist_append_str(cap_list, QMPCapability_str(cap));
4345 return qdict_from_jsonf_nofail(
4346 "{'QMP': {'version': %p, 'capabilities': %p}}",
4347 ver, cap_list);
4350 static void monitor_qmp_event(void *opaque, int event)
4352 QDict *data;
4353 Monitor *mon = opaque;
4355 switch (event) {
4356 case CHR_EVENT_OPENED:
4357 mon->qmp.commands = &qmp_cap_negotiation_commands;
4358 monitor_qmp_caps_reset(mon);
4359 data = qmp_greeting(mon);
4360 qmp_send_response(mon, data);
4361 qobject_unref(data);
4362 mon_refcount++;
4363 break;
4364 case CHR_EVENT_CLOSED:
4366 * Note: this is only useful when the output of the chardev
4367 * backend is still open. For example, when the backend is
4368 * stdio, it's possible that stdout is still open when stdin
4369 * is closed.
4371 monitor_qmp_cleanup_queues(mon);
4372 json_message_parser_destroy(&mon->qmp.parser);
4373 json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
4374 mon, NULL);
4375 mon_refcount--;
4376 monitor_fdsets_cleanup();
4377 break;
4381 static void monitor_event(void *opaque, int event)
4383 Monitor *mon = opaque;
4385 switch (event) {
4386 case CHR_EVENT_MUX_IN:
4387 qemu_mutex_lock(&mon->mon_lock);
4388 mon->mux_out = 0;
4389 qemu_mutex_unlock(&mon->mon_lock);
4390 if (mon->reset_seen) {
4391 readline_restart(mon->rs);
4392 monitor_resume(mon);
4393 monitor_flush(mon);
4394 } else {
4395 atomic_mb_set(&mon->suspend_cnt, 0);
4397 break;
4399 case CHR_EVENT_MUX_OUT:
4400 if (mon->reset_seen) {
4401 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4402 monitor_printf(mon, "\n");
4404 monitor_flush(mon);
4405 monitor_suspend(mon);
4406 } else {
4407 atomic_inc(&mon->suspend_cnt);
4409 qemu_mutex_lock(&mon->mon_lock);
4410 mon->mux_out = 1;
4411 qemu_mutex_unlock(&mon->mon_lock);
4412 break;
4414 case CHR_EVENT_OPENED:
4415 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4416 "information\n", QEMU_VERSION);
4417 if (!mon->mux_out) {
4418 readline_restart(mon->rs);
4419 readline_show_prompt(mon->rs);
4421 mon->reset_seen = 1;
4422 mon_refcount++;
4423 break;
4425 case CHR_EVENT_CLOSED:
4426 mon_refcount--;
4427 monitor_fdsets_cleanup();
4428 break;
4432 static int
4433 compare_mon_cmd(const void *a, const void *b)
4435 return strcmp(((const mon_cmd_t *)a)->name,
4436 ((const mon_cmd_t *)b)->name);
4439 static void sortcmdlist(void)
4441 int array_num;
4442 int elem_size = sizeof(mon_cmd_t);
4444 array_num = sizeof(mon_cmds)/elem_size-1;
4445 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4447 array_num = sizeof(info_cmds)/elem_size-1;
4448 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4451 static GMainContext *monitor_get_io_context(void)
4453 return iothread_get_g_main_context(mon_iothread);
4456 static AioContext *monitor_get_aio_context(void)
4458 return iothread_get_aio_context(mon_iothread);
4461 static void monitor_iothread_init(void)
4463 mon_iothread = iothread_create("mon_iothread", &error_abort);
4466 * The dispatcher BH must run in the main loop thread, since we
4467 * have commands assuming that context. It would be nice to get
4468 * rid of those assumptions.
4470 qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4471 monitor_qmp_bh_dispatcher,
4472 NULL);
4475 void monitor_init_globals(void)
4477 monitor_init_qmp_commands();
4478 monitor_qapi_event_init();
4479 sortcmdlist();
4480 qemu_mutex_init(&monitor_lock);
4481 qemu_mutex_init(&mon_fdsets_lock);
4482 monitor_iothread_init();
4485 /* These functions just adapt the readline interface in a typesafe way. We
4486 * could cast function pointers but that discards compiler checks.
4488 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4489 const char *fmt, ...)
4491 va_list ap;
4492 va_start(ap, fmt);
4493 monitor_vprintf(opaque, fmt, ap);
4494 va_end(ap);
4497 static void monitor_readline_flush(void *opaque)
4499 monitor_flush(opaque);
4503 * Print to current monitor if we have one, else to stream.
4504 * TODO should return int, so callers can calculate width, but that
4505 * requires surgery to monitor_vprintf(). Left for another day.
4507 void monitor_vfprintf(FILE *stream, const char *fmt, va_list ap)
4509 if (cur_mon && !monitor_cur_is_qmp()) {
4510 monitor_vprintf(cur_mon, fmt, ap);
4511 } else {
4512 vfprintf(stream, fmt, ap);
4517 * Print to current monitor if we have one, else to stderr.
4518 * TODO should return int, so callers can calculate width, but that
4519 * requires surgery to monitor_vprintf(). Left for another day.
4521 void error_vprintf(const char *fmt, va_list ap)
4523 monitor_vfprintf(stderr, fmt, ap);
4526 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4528 if (cur_mon && !monitor_cur_is_qmp()) {
4529 monitor_vprintf(cur_mon, fmt, ap);
4530 } else if (!cur_mon) {
4531 vfprintf(stderr, fmt, ap);
4535 static void monitor_list_append(Monitor *mon)
4537 qemu_mutex_lock(&monitor_lock);
4538 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4539 qemu_mutex_unlock(&monitor_lock);
4542 static void monitor_qmp_setup_handlers_bh(void *opaque)
4544 Monitor *mon = opaque;
4545 GMainContext *context;
4547 assert(mon->use_io_thread);
4548 context = monitor_get_io_context();
4549 assert(context);
4550 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4551 monitor_qmp_event, NULL, mon, context, true);
4552 monitor_list_append(mon);
4555 void monitor_init(Chardev *chr, int flags)
4557 Monitor *mon = g_malloc(sizeof(*mon));
4558 bool use_readline = flags & MONITOR_USE_READLINE;
4559 bool use_oob = flags & MONITOR_USE_OOB;
4561 if (use_oob) {
4562 if (CHARDEV_IS_MUX(chr)) {
4563 error_report("Monitor out-of-band is not supported with "
4564 "MUX typed chardev backend");
4565 exit(1);
4567 if (use_readline) {
4568 error_report("Monitor out-of-band is only supported by QMP");
4569 exit(1);
4573 monitor_data_init(mon, false, use_oob);
4575 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4576 mon->flags = flags;
4577 if (use_readline) {
4578 mon->rs = readline_init(monitor_readline_printf,
4579 monitor_readline_flush,
4580 mon,
4581 monitor_find_completion);
4582 monitor_read_command(mon, 0);
4585 if (monitor_is_qmp(mon)) {
4586 qemu_chr_fe_set_echo(&mon->chr, true);
4587 json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
4588 mon, NULL);
4589 if (mon->use_io_thread) {
4591 * Make sure the old iowatch is gone. It's possible when
4592 * e.g. the chardev is in client mode, with wait=on.
4594 remove_fd_in_watch(chr);
4596 * We can't call qemu_chr_fe_set_handlers() directly here
4597 * since chardev might be running in the monitor I/O
4598 * thread. Schedule a bottom half.
4600 aio_bh_schedule_oneshot(monitor_get_aio_context(),
4601 monitor_qmp_setup_handlers_bh, mon);
4602 /* The bottom half will add @mon to @mon_list */
4603 return;
4604 } else {
4605 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4606 monitor_qmp_read, monitor_qmp_event,
4607 NULL, mon, NULL, true);
4609 } else {
4610 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4611 monitor_event, NULL, mon, NULL, true);
4614 monitor_list_append(mon);
4617 void monitor_cleanup(void)
4619 Monitor *mon, *next;
4622 * We need to explicitly stop the I/O thread (but not destroy it),
4623 * clean up the monitor resources, then destroy the I/O thread since
4624 * we need to unregister from chardev below in
4625 * monitor_data_destroy(), and chardev is not thread-safe yet
4627 iothread_stop(mon_iothread);
4629 /* Flush output buffers and destroy monitors */
4630 qemu_mutex_lock(&monitor_lock);
4631 QTAILQ_FOREACH_SAFE(mon, &mon_list, entry, next) {
4632 QTAILQ_REMOVE(&mon_list, mon, entry);
4633 monitor_flush(mon);
4634 monitor_data_destroy(mon);
4635 g_free(mon);
4637 qemu_mutex_unlock(&monitor_lock);
4639 /* QEMUBHs needs to be deleted before destroying the I/O thread */
4640 qemu_bh_delete(qmp_dispatcher_bh);
4641 qmp_dispatcher_bh = NULL;
4643 iothread_destroy(mon_iothread);
4644 mon_iothread = NULL;
4647 QemuOptsList qemu_mon_opts = {
4648 .name = "mon",
4649 .implied_opt_name = "chardev",
4650 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4651 .desc = {
4653 .name = "mode",
4654 .type = QEMU_OPT_STRING,
4656 .name = "chardev",
4657 .type = QEMU_OPT_STRING,
4659 .name = "pretty",
4660 .type = QEMU_OPT_BOOL,
4662 .name = "x-oob",
4663 .type = QEMU_OPT_BOOL,
4665 { /* end of list */ }
4669 #ifndef TARGET_I386
4670 void qmp_rtc_reset_reinjection(Error **errp)
4672 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4675 SevInfo *qmp_query_sev(Error **errp)
4677 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev");
4678 return NULL;
4681 SevLaunchMeasureInfo *qmp_query_sev_launch_measure(Error **errp)
4683 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-launch-measure");
4684 return NULL;
4687 SevCapability *qmp_query_sev_capabilities(Error **errp)
4689 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-capabilities");
4690 return NULL;
4692 #endif
4694 #ifndef TARGET_S390X
4695 void qmp_dump_skeys(const char *filename, Error **errp)
4697 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4699 #endif
4701 #ifndef TARGET_ARM
4702 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4704 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4705 return NULL;
4707 #endif
4709 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4711 MachineState *ms = MACHINE(qdev_get_machine());
4712 MachineClass *mc = MACHINE_GET_CLASS(ms);
4714 if (!mc->has_hotpluggable_cpus) {
4715 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4716 return NULL;
4719 return machine_query_hotpluggable_cpus(ms);