4 * Copyright (c) 2003-2004 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "qemu/units.h"
30 #include "monitor/qdev.h"
32 #include "hw/pci/pci.h"
33 #include "sysemu/watchdog.h"
34 #include "hw/loader.h"
35 #include "exec/gdbstub.h"
37 #include "net/slirp.h"
38 #include "chardev/char-fe.h"
39 #include "chardev/char-io.h"
40 #include "chardev/char-mux.h"
41 #include "ui/qemu-spice.h"
42 #include "sysemu/numa.h"
43 #include "monitor/monitor.h"
44 #include "qemu/config-file.h"
45 #include "qemu/readline.h"
46 #include "ui/console.h"
48 #include "sysemu/block-backend.h"
49 #include "audio/audio.h"
50 #include "disas/disas.h"
51 #include "sysemu/balloon.h"
52 #include "qemu/timer.h"
53 #include "sysemu/hw_accel.h"
55 #include "sysemu/tpm.h"
56 #include "qapi/qmp/qdict.h"
57 #include "qapi/qmp/qerror.h"
58 #include "qapi/qmp/qnum.h"
59 #include "qapi/qmp/qstring.h"
60 #include "qapi/qmp/qjson.h"
61 #include "qapi/qmp/json-streamer.h"
62 #include "qapi/qmp/json-parser.h"
63 #include "qapi/qmp/qlist.h"
64 #include "qom/object_interfaces.h"
65 #include "trace-root.h"
66 #include "trace/control.h"
67 #include "monitor/hmp-target.h"
68 #ifdef CONFIG_TRACE_SIMPLE
69 #include "trace/simple.h"
71 #include "exec/memory.h"
72 #include "exec/exec-all.h"
74 #include "qemu/option.h"
76 #include "qemu/thread.h"
77 #include "block/qapi.h"
78 #include "qapi/qapi-commands.h"
79 #include "qapi/qapi-events.h"
80 #include "qapi/error.h"
81 #include "qapi/qmp-event.h"
82 #include "qapi/qapi-introspect.h"
83 #include "sysemu/qtest.h"
84 #include "sysemu/cpus.h"
85 #include "sysemu/iothread.h"
86 #include "qemu/cutils.h"
88 #if defined(TARGET_S390X)
89 #include "hw/s390x/storage-keys.h"
90 #include "hw/s390x/storage-attributes.h"
97 * 'B' block device name
98 * 's' string (accept optional quote)
99 * 'S' it just appends the rest of the string (accept optional quote)
100 * 'O' option string of the form NAME=VALUE,...
101 * parsed according to QemuOptsList given by its name
102 * Example: 'device:O' uses qemu_device_opts.
103 * Restriction: only lists with empty desc are supported
104 * TODO lift the restriction
106 * 'l' target long (32 or 64 bit)
107 * 'M' Non-negative target long (32 or 64 bit), in user mode the
108 * value is multiplied by 2^20 (think Mebibyte)
109 * 'o' octets (aka bytes)
110 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
111 * K, k suffix, which multiplies the value by 2^60 for suffixes E
112 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
113 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
115 * user mode accepts an optional ms, us, ns suffix,
116 * which divides the value by 1e3, 1e6, 1e9, respectively
117 * '/' optional gdb-like print format (like "/10x")
119 * '?' optional type (for all types, except '/')
120 * '.' other form of optional type (for 'i' and 'l')
122 * user mode accepts "on" or "off"
123 * '-' optional parameter (eg. '-f')
127 typedef struct mon_cmd_t {
129 const char *args_type;
132 const char *flags; /* p=preconfig */
133 void (*cmd)(Monitor *mon, const QDict *qdict);
134 /* @sub_table is a list of 2nd level of commands. If it does not exist,
135 * cmd should be used. If it exists, sub_table[?].cmd should be
136 * used, and cmd of 1st level plays the role of help function.
138 struct mon_cmd_t *sub_table;
139 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
142 /* file descriptors passed via SCM_RIGHTS */
143 typedef struct mon_fd_t mon_fd_t;
147 QLIST_ENTRY(mon_fd_t) next;
150 /* file descriptor associated with a file descriptor set */
151 typedef struct MonFdsetFd MonFdsetFd;
156 QLIST_ENTRY(MonFdsetFd) next;
159 /* file descriptor set containing fds passed via SCM_RIGHTS */
160 typedef struct MonFdset MonFdset;
163 QLIST_HEAD(, MonFdsetFd) fds;
164 QLIST_HEAD(, MonFdsetFd) dup_fds;
165 QLIST_ENTRY(MonFdset) next;
169 JSONMessageParser parser;
171 * When a client connects, we're in capabilities negotiation mode.
172 * @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 /* Output queue contains all the QMP responses in order */
187 GQueue *qmp_responses;
191 * To prevent flooding clients, events can be throttled. The
192 * throttling is calculated globally, rather than per-Monitor
195 typedef struct MonitorQAPIEventState {
196 QAPIEvent event; /* Throttling state for this event type and... */
197 QDict *data; /* ... data, see qapi_event_throttle_equal() */
198 QEMUTimer *timer; /* Timer for handling delayed events */
199 QDict *qdict; /* Delayed event (if any) */
200 } MonitorQAPIEventState;
203 int64_t rate; /* Minimum time (in ns) between two events */
204 } MonitorQAPIEventConf;
210 int suspend_cnt; /* Needs to be accessed atomically */
215 * State used only in the thread "owning" the monitor.
216 * If @use_io_thread, this is @mon_iothread.
217 * Else, it's the main thread.
218 * These members can be safely accessed without locks.
224 BlockCompletionFunc *password_completion_cb;
225 void *password_opaque;
226 mon_cmd_t *cmd_table;
227 QTAILQ_ENTRY(Monitor) entry;
230 * The per-monitor lock. We can't access guest memory when holding
236 * Members that are protected by the per-monitor lock
238 QLIST_HEAD(, mon_fd_t) fds;
241 /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
245 /* Shared monitor I/O thread */
246 IOThread *mon_iothread;
248 /* Bottom half to dispatch the requests received from I/O thread */
249 QEMUBH *qmp_dispatcher_bh;
251 /* Bottom half to deliver the responses back to clients */
252 QEMUBH *qmp_respond_bh;
255 /* Owner of the request */
257 /* "id" field of the request */
260 * Request object to be handled or Error to be reported
261 * (exactly one of them is non-null)
266 * Whether we need to resume the monitor afterward. This flag is
267 * used to emulate the old QMP server behavior that the current
268 * command must be completed before execution of the next one.
272 typedef struct QMPRequest QMPRequest;
274 /* QMP checker flags */
275 #define QMP_ACCEPT_UNKNOWNS 1
277 /* Protects mon_list, monitor_qapi_event_state. */
278 static QemuMutex monitor_lock;
279 static GHashTable *monitor_qapi_event_state;
280 static QTAILQ_HEAD(mon_list, Monitor) mon_list;
282 /* Protects mon_fdsets */
283 static QemuMutex mon_fdsets_lock;
284 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
286 static int mon_refcount;
288 static mon_cmd_t mon_cmds[];
289 static mon_cmd_t info_cmds[];
291 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
293 __thread Monitor *cur_mon;
295 static void monitor_command_cb(void *opaque, const char *cmdline,
296 void *readline_opaque);
299 * Is @mon a QMP monitor?
301 static inline bool monitor_is_qmp(const Monitor *mon)
303 return (mon->flags & MONITOR_USE_CONTROL);
307 * Is @mon is using readline?
308 * Note: not all HMP monitors use readline, e.g., gdbserver has a
309 * non-interactive HMP monitor, so readline is not used there.
311 static inline bool monitor_uses_readline(const Monitor *mon)
313 return mon->flags & MONITOR_USE_READLINE;
316 static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
318 return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
322 * Return the clock to use for recording an event's time.
323 * It's QEMU_CLOCK_REALTIME, except for qtests it's
324 * QEMU_CLOCK_VIRTUAL, to support testing rate limits.
325 * Beware: result is invalid before configure_accelerator().
327 static inline QEMUClockType monitor_get_event_clock(void)
329 return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
333 * Is the current monitor, if any, a QMP monitor?
335 bool monitor_cur_is_qmp(void)
337 return cur_mon && monitor_is_qmp(cur_mon);
340 void monitor_read_command(Monitor *mon, int show_prompt)
345 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
347 readline_show_prompt(mon->rs);
350 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
354 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
355 /* prompt is printed on return from the command handler */
358 monitor_printf(mon, "terminal does not support password prompting\n");
363 static void qmp_request_free(QMPRequest *req)
365 qobject_unref(req->id);
366 qobject_unref(req->req);
367 error_free(req->err);
371 /* Caller must hold mon->qmp.qmp_queue_lock */
372 static void monitor_qmp_cleanup_req_queue_locked(Monitor *mon)
374 while (!g_queue_is_empty(mon->qmp.qmp_requests)) {
375 qmp_request_free(g_queue_pop_head(mon->qmp.qmp_requests));
379 /* Caller must hold the mon->qmp.qmp_queue_lock */
380 static void monitor_qmp_cleanup_resp_queue_locked(Monitor *mon)
382 while (!g_queue_is_empty(mon->qmp.qmp_responses)) {
383 qobject_unref((QDict *)g_queue_pop_head(mon->qmp.qmp_responses));
387 static void monitor_qmp_cleanup_queues(Monitor *mon)
389 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
390 monitor_qmp_cleanup_req_queue_locked(mon);
391 monitor_qmp_cleanup_resp_queue_locked(mon);
392 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
396 static void monitor_flush_locked(Monitor *mon);
398 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
401 Monitor *mon = opaque;
403 qemu_mutex_lock(&mon->mon_lock);
405 monitor_flush_locked(mon);
406 qemu_mutex_unlock(&mon->mon_lock);
410 /* Caller must hold mon->mon_lock */
411 static void monitor_flush_locked(Monitor *mon)
417 if (mon->skip_flush) {
421 buf = qstring_get_str(mon->outbuf);
422 len = qstring_get_length(mon->outbuf);
424 if (len && !mon->mux_out) {
425 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
426 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
427 /* all flushed or error */
428 qobject_unref(mon->outbuf);
429 mon->outbuf = qstring_new();
434 QString *tmp = qstring_from_str(buf + rc);
435 qobject_unref(mon->outbuf);
438 if (mon->out_watch == 0) {
440 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
441 monitor_unblocked, mon);
446 void monitor_flush(Monitor *mon)
448 qemu_mutex_lock(&mon->mon_lock);
449 monitor_flush_locked(mon);
450 qemu_mutex_unlock(&mon->mon_lock);
453 /* flush at every end of line */
454 static void monitor_puts(Monitor *mon, const char *str)
458 qemu_mutex_lock(&mon->mon_lock);
464 qstring_append_chr(mon->outbuf, '\r');
466 qstring_append_chr(mon->outbuf, c);
468 monitor_flush_locked(mon);
471 qemu_mutex_unlock(&mon->mon_lock);
474 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
481 if (monitor_is_qmp(mon)) {
485 buf = g_strdup_vprintf(fmt, ap);
486 monitor_puts(mon, buf);
490 void monitor_printf(Monitor *mon, const char *fmt, ...)
494 monitor_vprintf(mon, fmt, ap);
498 int monitor_fprintf(FILE *stream, const char *fmt, ...)
502 monitor_vprintf((Monitor *)stream, fmt, ap);
507 static void qmp_send_response(Monitor *mon, QDict *rsp)
509 QObject *data = QOBJECT(rsp);
512 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
513 qobject_to_json(data);
514 assert(json != NULL);
516 qstring_append_chr(json, '\n');
517 monitor_puts(mon, qstring_get_str(json));
522 static void qmp_queue_response(Monitor *mon, QDict *rsp)
524 if (mon->use_io_thread) {
526 * Push a reference to the response queue. The I/O thread
527 * drains that queue and emits.
529 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
530 g_queue_push_tail(mon->qmp.qmp_responses, qobject_ref(rsp));
531 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
532 qemu_bh_schedule(qmp_respond_bh);
535 * Not using monitor I/O thread, i.e. we are in the main thread.
538 qmp_send_response(mon, rsp);
546 typedef struct QMPResponse QMPResponse;
548 static QDict *monitor_qmp_response_pop_one(Monitor *mon)
552 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
553 data = g_queue_pop_head(mon->qmp.qmp_responses);
554 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
559 static void monitor_qmp_response_flush(Monitor *mon)
563 while ((data = monitor_qmp_response_pop_one(mon))) {
564 qmp_send_response(mon, data);
570 * Pop a QMPResponse from any monitor's response queue into @response.
571 * Return false if all the queues are empty; else true.
573 static bool monitor_qmp_response_pop_any(QMPResponse *response)
578 qemu_mutex_lock(&monitor_lock);
579 QTAILQ_FOREACH(mon, &mon_list, entry) {
580 data = monitor_qmp_response_pop_one(mon);
583 response->data = data;
587 qemu_mutex_unlock(&monitor_lock);
591 static void monitor_qmp_bh_responder(void *opaque)
593 QMPResponse response;
595 while (monitor_qmp_response_pop_any(&response)) {
596 qmp_send_response(response.mon, response.data);
597 qobject_unref(response.data);
601 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
602 /* Limit guest-triggerable events to 1 per second */
603 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
604 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
605 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
606 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
607 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
608 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
612 * Broadcast an event to all monitors.
613 * @qdict is the event object. Its member "event" must match @event.
614 * Caller must hold monitor_lock.
616 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
620 trace_monitor_protocol_event_emit(event, qdict);
621 QTAILQ_FOREACH(mon, &mon_list, entry) {
622 if (monitor_is_qmp(mon)
623 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
624 qmp_queue_response(mon, qdict);
629 static void monitor_qapi_event_handler(void *opaque);
632 * Queue a new event for emission to Monitor instances,
633 * applying any rate limiting if required.
636 monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
638 MonitorQAPIEventConf *evconf;
639 MonitorQAPIEventState *evstate;
641 assert(event < QAPI_EVENT__MAX);
642 evconf = &monitor_qapi_event_conf[event];
643 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
645 qemu_mutex_lock(&monitor_lock);
648 /* Unthrottled event */
649 monitor_qapi_event_emit(event, qdict);
651 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
652 MonitorQAPIEventState key = { .event = event, .data = data };
654 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
655 assert(!evstate || timer_pending(evstate->timer));
659 * Timer is pending for (at least) evconf->rate ns after
660 * last send. Store event for sending when timer fires,
661 * replacing a prior stored event if any.
663 qobject_unref(evstate->qdict);
664 evstate->qdict = qobject_ref(qdict);
667 * Last send was (at least) evconf->rate ns ago.
668 * Send immediately, and arm the timer to call
669 * monitor_qapi_event_handler() in evconf->rate ns. Any
670 * events arriving before then will be delayed until then.
672 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
674 monitor_qapi_event_emit(event, qdict);
676 evstate = g_new(MonitorQAPIEventState, 1);
677 evstate->event = event;
678 evstate->data = qobject_ref(data);
679 evstate->qdict = NULL;
680 evstate->timer = timer_new_ns(monitor_get_event_clock(),
681 monitor_qapi_event_handler,
683 g_hash_table_add(monitor_qapi_event_state, evstate);
684 timer_mod_ns(evstate->timer, now + evconf->rate);
688 qemu_mutex_unlock(&monitor_lock);
692 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
695 * monitor_qapi_event_queue_no_reenter() is not reentrant: it
696 * would deadlock on monitor_lock. Work around by queueing
697 * events in thread-local storage.
698 * TODO: remove this, make it re-enter safe.
700 typedef struct MonitorQapiEvent {
703 QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
705 static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
706 static __thread bool reentered;
707 MonitorQapiEvent *ev;
710 QSIMPLEQ_INIT(&event_queue);
713 ev = g_new(MonitorQapiEvent, 1);
714 ev->qdict = qobject_ref(qdict);
716 QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
723 while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
724 QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
725 monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
726 qobject_unref(ev->qdict);
734 * This function runs evconf->rate ns after sending a throttled
736 * If another event has since been stored, send it.
738 static void monitor_qapi_event_handler(void *opaque)
740 MonitorQAPIEventState *evstate = opaque;
741 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
743 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
744 qemu_mutex_lock(&monitor_lock);
746 if (evstate->qdict) {
747 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
749 monitor_qapi_event_emit(evstate->event, evstate->qdict);
750 qobject_unref(evstate->qdict);
751 evstate->qdict = NULL;
752 timer_mod_ns(evstate->timer, now + evconf->rate);
754 g_hash_table_remove(monitor_qapi_event_state, evstate);
755 qobject_unref(evstate->data);
756 timer_free(evstate->timer);
760 qemu_mutex_unlock(&monitor_lock);
763 static unsigned int qapi_event_throttle_hash(const void *key)
765 const MonitorQAPIEventState *evstate = key;
766 unsigned int hash = evstate->event * 255;
768 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
769 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
772 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
773 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
779 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
781 const MonitorQAPIEventState *eva = a;
782 const MonitorQAPIEventState *evb = b;
784 if (eva->event != evb->event) {
788 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
789 return !strcmp(qdict_get_str(eva->data, "id"),
790 qdict_get_str(evb->data, "id"));
793 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
794 return !strcmp(qdict_get_str(eva->data, "node-name"),
795 qdict_get_str(evb->data, "node-name"));
801 static void monitor_qapi_event_init(void)
803 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
804 qapi_event_throttle_equal);
805 qmp_event_set_func_emit(monitor_qapi_event_queue);
808 static void handle_hmp_command(Monitor *mon, const char *cmdline);
810 static void monitor_data_init(Monitor *mon, bool skip_flush,
813 memset(mon, 0, sizeof(Monitor));
814 qemu_mutex_init(&mon->mon_lock);
815 qemu_mutex_init(&mon->qmp.qmp_queue_lock);
816 mon->outbuf = qstring_new();
817 /* Use *mon_cmds by default. */
818 mon->cmd_table = mon_cmds;
819 mon->skip_flush = skip_flush;
820 mon->use_io_thread = use_io_thread;
821 mon->qmp.qmp_requests = g_queue_new();
822 mon->qmp.qmp_responses = g_queue_new();
825 static void monitor_data_destroy(Monitor *mon)
827 g_free(mon->mon_cpu_path);
828 qemu_chr_fe_deinit(&mon->chr, false);
829 if (monitor_is_qmp(mon)) {
830 json_message_parser_destroy(&mon->qmp.parser);
832 readline_free(mon->rs);
833 qobject_unref(mon->outbuf);
834 qemu_mutex_destroy(&mon->mon_lock);
835 qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
836 monitor_qmp_cleanup_req_queue_locked(mon);
837 monitor_qmp_cleanup_resp_queue_locked(mon);
838 g_queue_free(mon->qmp.qmp_requests);
839 g_queue_free(mon->qmp.qmp_responses);
842 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
843 int64_t cpu_index, Error **errp)
846 Monitor *old_mon, hmp;
848 monitor_data_init(&hmp, true, false);
854 int ret = monitor_set_cpu(cpu_index);
857 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
863 handle_hmp_command(&hmp, command_line);
866 qemu_mutex_lock(&hmp.mon_lock);
867 if (qstring_get_length(hmp.outbuf) > 0) {
868 output = g_strdup(qstring_get_str(hmp.outbuf));
870 output = g_strdup("");
872 qemu_mutex_unlock(&hmp.mon_lock);
875 monitor_data_destroy(&hmp);
879 static int compare_cmd(const char *name, const char *list)
881 const char *p, *pstart;
887 p = qemu_strchrnul(p, '|');
888 if ((p - pstart) == len && !memcmp(pstart, name, len))
897 static int get_str(char *buf, int buf_size, const char **pp)
905 while (qemu_isspace(*p)) {
916 while (*p != '\0' && *p != '\"') {
932 printf("unsupported escape code: '\\%c'\n", c);
935 if ((q - buf) < buf_size - 1) {
939 if ((q - buf) < buf_size - 1) {
946 printf("unterminated string\n");
951 while (*p != '\0' && !qemu_isspace(*p)) {
952 if ((q - buf) < buf_size - 1) {
965 static void free_cmdline_args(char **args, int nb_args)
969 assert(nb_args <= MAX_ARGS);
971 for (i = 0; i < nb_args; i++) {
978 * Parse the command line to get valid args.
979 * @cmdline: command line to be parsed.
980 * @pnb_args: location to store the number of args, must NOT be NULL.
981 * @args: location to store the args, which should be freed by caller, must
984 * Returns 0 on success, negative on failure.
986 * NOTE: this parser is an approximate form of the real command parser. Number
987 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
988 * return with failure.
990 static int parse_cmdline(const char *cmdline,
991 int *pnb_args, char **args)
1000 while (qemu_isspace(*p)) {
1006 if (nb_args >= MAX_ARGS) {
1009 ret = get_str(buf, sizeof(buf), &p);
1013 args[nb_args] = g_strdup(buf);
1016 *pnb_args = nb_args;
1020 free_cmdline_args(args, nb_args);
1025 * Can command @cmd be executed in preconfig state?
1027 static bool cmd_can_preconfig(const mon_cmd_t *cmd)
1033 return strchr(cmd->flags, 'p');
1036 static void help_cmd_dump_one(Monitor *mon,
1037 const mon_cmd_t *cmd,
1043 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
1047 for (i = 0; i < prefix_args_nb; i++) {
1048 monitor_printf(mon, "%s ", prefix_args[i]);
1050 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
1053 /* @args[@arg_index] is the valid command need to find in @cmds */
1054 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
1055 char **args, int nb_args, int arg_index)
1057 const mon_cmd_t *cmd;
1059 /* No valid arg need to compare with, dump all in *cmds */
1060 if (arg_index >= nb_args) {
1061 for (cmd = cmds; cmd->name != NULL; cmd++) {
1062 help_cmd_dump_one(mon, cmd, args, arg_index);
1067 /* Find one entry to dump */
1068 for (cmd = cmds; cmd->name != NULL; cmd++) {
1069 if (compare_cmd(args[arg_index], cmd->name) &&
1070 ((!runstate_check(RUN_STATE_PRECONFIG) ||
1071 cmd_can_preconfig(cmd)))) {
1072 if (cmd->sub_table) {
1073 /* continue with next arg */
1074 help_cmd_dump(mon, cmd->sub_table,
1075 args, nb_args, arg_index + 1);
1077 help_cmd_dump_one(mon, cmd, args, arg_index);
1084 static void help_cmd(Monitor *mon, const char *name)
1086 char *args[MAX_ARGS];
1089 /* 1. parse user input */
1091 /* special case for log, directly dump and return */
1092 if (!strcmp(name, "log")) {
1093 const QEMULogItem *item;
1094 monitor_printf(mon, "Log items (comma separated):\n");
1095 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
1096 for (item = qemu_log_items; item->mask != 0; item++) {
1097 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
1102 if (parse_cmdline(name, &nb_args, args) < 0) {
1107 /* 2. dump the contents according to parsed args */
1108 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
1110 free_cmdline_args(args, nb_args);
1113 static void do_help_cmd(Monitor *mon, const QDict *qdict)
1115 help_cmd(mon, qdict_get_try_str(qdict, "name"));
1118 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
1120 const char *tp_name = qdict_get_str(qdict, "name");
1121 bool new_state = qdict_get_bool(qdict, "option");
1122 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1123 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1124 Error *local_err = NULL;
1127 monitor_printf(mon, "argument vcpu must be positive");
1131 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
1133 error_report_err(local_err);
1137 #ifdef CONFIG_TRACE_SIMPLE
1138 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
1140 const char *op = qdict_get_try_str(qdict, "op");
1141 const char *arg = qdict_get_try_str(qdict, "arg");
1144 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
1145 } else if (!strcmp(op, "on")) {
1146 st_set_trace_file_enabled(true);
1147 } else if (!strcmp(op, "off")) {
1148 st_set_trace_file_enabled(false);
1149 } else if (!strcmp(op, "flush")) {
1150 st_flush_trace_buffer();
1151 } else if (!strcmp(op, "set")) {
1153 st_set_trace_file(arg);
1156 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
1157 help_cmd(mon, "trace-file");
1162 static void hmp_info_help(Monitor *mon, const QDict *qdict)
1164 help_cmd(mon, "info");
1167 static void query_commands_cb(QmpCommand *cmd, void *opaque)
1169 CommandInfoList *info, **list = opaque;
1171 if (!cmd->enabled) {
1175 info = g_malloc0(sizeof(*info));
1176 info->value = g_malloc0(sizeof(*info->value));
1177 info->value->name = g_strdup(cmd->name);
1182 CommandInfoList *qmp_query_commands(Error **errp)
1184 CommandInfoList *list = NULL;
1186 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
1191 EventInfoList *qmp_query_events(Error **errp)
1193 EventInfoList *info, *ev_list = NULL;
1196 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
1197 const char *event_name = QAPIEvent_str(e);
1198 assert(event_name != NULL);
1199 info = g_malloc0(sizeof(*info));
1200 info->value = g_malloc0(sizeof(*info->value));
1201 info->value->name = g_strdup(event_name);
1203 info->next = ev_list;
1211 * Minor hack: generated marshalling suppressed for this command
1212 * ('gen': false in the schema) so we can parse the JSON string
1213 * directly into QObject instead of first parsing it with
1214 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
1215 * to QObject with generated output marshallers, every time. Instead,
1216 * we do it in test-qobject-input-visitor.c, just to make sure
1217 * qapi-gen.py's output actually conforms to the schema.
1219 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
1222 *ret_data = qobject_from_qlit(&qmp_schema_qlit);
1226 * We used to define commands in qmp-commands.hx in addition to the
1227 * QAPI schema. This permitted defining some of them only in certain
1228 * configurations. query-commands has always reflected that (good,
1229 * because it lets QMP clients figure out what's actually available),
1230 * while query-qmp-schema never did (not so good). This function is a
1231 * hack to keep the configuration-specific commands defined exactly as
1232 * before, even though qmp-commands.hx is gone.
1234 * FIXME Educate the QAPI schema on configuration-specific commands,
1235 * and drop this hack.
1237 static void qmp_unregister_commands_hack(void)
1239 #ifndef CONFIG_REPLICATION
1240 qmp_unregister_command(&qmp_commands, "xen-set-replication");
1241 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
1242 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
1245 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
1246 qmp_unregister_command(&qmp_commands, "query-sev");
1247 qmp_unregister_command(&qmp_commands, "query-sev-launch-measure");
1248 qmp_unregister_command(&qmp_commands, "query-sev-capabilities");
1250 #ifndef TARGET_S390X
1251 qmp_unregister_command(&qmp_commands, "dump-skeys");
1254 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
1256 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
1257 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
1259 #if !defined(TARGET_S390X)
1260 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
1261 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
1263 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
1264 && !defined(TARGET_S390X)
1265 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1269 static void monitor_init_qmp_commands(void)
1272 * Two command lists:
1273 * - qmp_commands contains all QMP commands
1274 * - qmp_cap_negotiation_commands contains just
1275 * "qmp_capabilities", to enforce capability negotiation
1278 qmp_init_marshal(&qmp_commands);
1280 qmp_register_command(&qmp_commands, "query-qmp-schema",
1281 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
1282 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1284 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1287 qmp_unregister_commands_hack();
1289 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1290 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1291 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
1294 static bool qmp_oob_enabled(Monitor *mon)
1296 return mon->qmp.capab[QMP_CAPABILITY_OOB];
1299 static void monitor_qmp_caps_reset(Monitor *mon)
1301 memset(mon->qmp.capab_offered, 0, sizeof(mon->qmp.capab_offered));
1302 memset(mon->qmp.capab, 0, sizeof(mon->qmp.capab));
1303 mon->qmp.capab_offered[QMP_CAPABILITY_OOB] = mon->use_io_thread;
1307 * Accept QMP capabilities in @list for @mon.
1308 * On success, set mon->qmp.capab[], and return true.
1309 * On error, set @errp, and return false.
1311 static bool qmp_caps_accept(Monitor *mon, QMPCapabilityList *list,
1314 GString *unavailable = NULL;
1315 bool capab[QMP_CAPABILITY__MAX];
1317 memset(capab, 0, sizeof(capab));
1319 for (; list; list = list->next) {
1320 if (!mon->qmp.capab_offered[list->value]) {
1322 unavailable = g_string_new(QMPCapability_str(list->value));
1324 g_string_append_printf(unavailable, ", %s",
1325 QMPCapability_str(list->value));
1328 capab[list->value] = true;
1332 error_setg(errp, "Capability %s not available", unavailable->str);
1333 g_string_free(unavailable, true);
1337 memcpy(mon->qmp.capab, capab, sizeof(capab));
1341 void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
1344 if (cur_mon->qmp.commands == &qmp_commands) {
1345 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1346 "Capabilities negotiation is already complete, command "
1351 if (!qmp_caps_accept(cur_mon, enable, errp)) {
1355 cur_mon->qmp.commands = &qmp_commands;
1358 /* Set the current CPU defined by the user. Callers must hold BQL. */
1359 int monitor_set_cpu(int cpu_index)
1363 cpu = qemu_get_cpu(cpu_index);
1367 g_free(cur_mon->mon_cpu_path);
1368 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1372 /* Callers must hold BQL. */
1373 static CPUState *mon_get_cpu_sync(bool synchronize)
1377 if (cur_mon->mon_cpu_path) {
1378 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1381 g_free(cur_mon->mon_cpu_path);
1382 cur_mon->mon_cpu_path = NULL;
1385 if (!cur_mon->mon_cpu_path) {
1389 monitor_set_cpu(first_cpu->cpu_index);
1393 cpu_synchronize_state(cpu);
1398 CPUState *mon_get_cpu(void)
1400 return mon_get_cpu_sync(true);
1403 CPUArchState *mon_get_cpu_env(void)
1405 CPUState *cs = mon_get_cpu();
1407 return cs ? cs->env_ptr : NULL;
1410 int monitor_get_cpu_index(void)
1412 CPUState *cs = mon_get_cpu_sync(false);
1414 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1417 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1419 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1424 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1425 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1431 monitor_printf(mon, "No CPU available\n");
1435 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1440 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1442 if (!tcg_enabled()) {
1443 error_report("JIT information is only available with accel=tcg");
1447 dump_exec_info((FILE *)mon, monitor_fprintf);
1448 dump_drift_info((FILE *)mon, monitor_fprintf);
1451 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1453 dump_opcount_info((FILE *)mon, monitor_fprintf);
1457 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1466 str = readline_get_history(mon->rs, i);
1469 monitor_printf(mon, "%d: '%s'\n", i, str);
1474 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1476 CPUState *cs = mon_get_cpu();
1479 monitor_printf(mon, "No CPU available\n");
1482 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1485 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1487 const char *name = qdict_get_try_str(qdict, "name");
1488 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1489 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1490 TraceEventInfoList *events;
1491 TraceEventInfoList *elem;
1492 Error *local_err = NULL;
1498 monitor_printf(mon, "argument vcpu must be positive");
1502 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1504 error_report_err(local_err);
1508 for (elem = events; elem != NULL; elem = elem->next) {
1509 monitor_printf(mon, "%s : state %u\n",
1511 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1513 qapi_free_TraceEventInfoList(events);
1516 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1517 bool has_port, int64_t port,
1518 bool has_tls_port, int64_t tls_port,
1519 bool has_cert_subject, const char *cert_subject,
1522 if (strcmp(protocol, "spice") == 0) {
1523 if (!qemu_using_spice(errp)) {
1527 if (!has_port && !has_tls_port) {
1528 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1532 if (qemu_spice_migrate_info(hostname,
1533 has_port ? port : -1,
1534 has_tls_port ? tls_port : -1,
1536 error_setg(errp, QERR_UNDEFINED_ERROR);
1542 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1545 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1549 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1551 error_report_err(err);
1555 static void hmp_log(Monitor *mon, const QDict *qdict)
1558 const char *items = qdict_get_str(qdict, "items");
1560 if (!strcmp(items, "none")) {
1563 mask = qemu_str_to_log_mask(items);
1565 help_cmd(mon, "log");
1572 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1574 const char *option = qdict_get_try_str(qdict, "option");
1575 if (!option || !strcmp(option, "on")) {
1577 } else if (!strcmp(option, "off")) {
1580 monitor_printf(mon, "unexpected option %s\n", option);
1584 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1586 const char *device = qdict_get_try_str(qdict, "device");
1588 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1589 if (gdbserver_start(device) < 0) {
1590 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1592 } else if (strcmp(device, "none") == 0) {
1593 monitor_printf(mon, "Disabled gdbserver\n");
1595 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1600 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1602 const char *action = qdict_get_str(qdict, "action");
1603 if (select_watchdog_action(action) == -1) {
1604 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1608 static void monitor_printc(Monitor *mon, int c)
1610 monitor_printf(mon, "'");
1613 monitor_printf(mon, "\\'");
1616 monitor_printf(mon, "\\\\");
1619 monitor_printf(mon, "\\n");
1622 monitor_printf(mon, "\\r");
1625 if (c >= 32 && c <= 126) {
1626 monitor_printf(mon, "%c", c);
1628 monitor_printf(mon, "\\x%02x", c);
1632 monitor_printf(mon, "'");
1635 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1636 hwaddr addr, int is_physical)
1638 int l, line_size, i, max_digits, len;
1641 CPUState *cs = mon_get_cpu();
1643 if (!cs && (format == 'i' || !is_physical)) {
1644 monitor_printf(mon, "Can not dump without CPU\n");
1648 if (format == 'i') {
1649 monitor_disas(mon, cs, addr, count, is_physical);
1653 len = wsize * count;
1662 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1666 max_digits = (wsize * 8) / 4;
1670 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1679 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1681 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1686 cpu_physical_memory_read(addr, buf, l);
1688 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1689 monitor_printf(mon, " Cannot access memory\n");
1698 v = ldub_p(buf + i);
1701 v = lduw_p(buf + i);
1704 v = (uint32_t)ldl_p(buf + i);
1710 monitor_printf(mon, " ");
1713 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1716 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1719 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1722 monitor_printf(mon, "%*" PRId64, max_digits, v);
1725 monitor_printc(mon, v);
1730 monitor_printf(mon, "\n");
1736 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1738 int count = qdict_get_int(qdict, "count");
1739 int format = qdict_get_int(qdict, "format");
1740 int size = qdict_get_int(qdict, "size");
1741 target_long addr = qdict_get_int(qdict, "addr");
1743 memory_dump(mon, count, format, size, addr, 0);
1746 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1748 int count = qdict_get_int(qdict, "count");
1749 int format = qdict_get_int(qdict, "format");
1750 int size = qdict_get_int(qdict, "size");
1751 hwaddr addr = qdict_get_int(qdict, "addr");
1753 memory_dump(mon, count, format, size, addr, 1);
1756 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1758 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1762 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1766 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1767 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1768 memory_region_unref(mrs.mr);
1773 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1776 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1778 hwaddr addr = qdict_get_int(qdict, "addr");
1779 Error *local_err = NULL;
1780 MemoryRegion *mr = NULL;
1783 ptr = gpa2hva(&mr, addr, &local_err);
1785 error_report_err(local_err);
1789 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1791 addr, mr->name, ptr);
1793 memory_region_unref(mr);
1797 static uint64_t vtop(void *ptr, Error **errp)
1801 uintptr_t addr = (uintptr_t) ptr;
1802 uintptr_t pagesize = getpagesize();
1803 off_t offset = addr / pagesize * sizeof(pinfo);
1806 fd = open("/proc/self/pagemap", O_RDONLY);
1808 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1812 /* Force copy-on-write if necessary. */
1813 atomic_add((uint8_t *)ptr, 0);
1815 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1816 error_setg_errno(errp, errno, "Cannot read pagemap");
1819 if ((pinfo & (1ull << 63)) == 0) {
1820 error_setg(errp, "Page not present");
1823 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1830 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1832 hwaddr addr = qdict_get_int(qdict, "addr");
1833 Error *local_err = NULL;
1834 MemoryRegion *mr = NULL;
1838 ptr = gpa2hva(&mr, addr, &local_err);
1840 error_report_err(local_err);
1844 physaddr = vtop(ptr, &local_err);
1846 error_report_err(local_err);
1848 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1849 " (%s) is 0x%" PRIx64 "\n",
1850 addr, mr->name, (uint64_t) physaddr);
1853 memory_region_unref(mr);
1857 static void do_print(Monitor *mon, const QDict *qdict)
1859 int format = qdict_get_int(qdict, "format");
1860 hwaddr val = qdict_get_int(qdict, "val");
1864 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1867 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1870 monitor_printf(mon, "%" HWADDR_PRIu, val);
1874 monitor_printf(mon, "%" HWADDR_PRId, val);
1877 monitor_printc(mon, val);
1880 monitor_printf(mon, "\n");
1883 static void hmp_sum(Monitor *mon, const QDict *qdict)
1887 uint32_t start = qdict_get_int(qdict, "start");
1888 uint32_t size = qdict_get_int(qdict, "size");
1891 for(addr = start; addr < (start + size); addr++) {
1892 uint8_t val = address_space_ldub(&address_space_memory, addr,
1893 MEMTXATTRS_UNSPECIFIED, NULL);
1894 /* BSD sum algorithm ('sum' Unix command) */
1895 sum = (sum >> 1) | (sum << 15);
1898 monitor_printf(mon, "%05d\n", sum);
1901 static int mouse_button_state;
1903 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1905 int dx, dy, dz, button;
1906 const char *dx_str = qdict_get_str(qdict, "dx_str");
1907 const char *dy_str = qdict_get_str(qdict, "dy_str");
1908 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1910 dx = strtol(dx_str, NULL, 0);
1911 dy = strtol(dy_str, NULL, 0);
1912 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1913 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1916 dz = strtol(dz_str, NULL, 0);
1918 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1919 qemu_input_queue_btn(NULL, button, true);
1920 qemu_input_event_sync();
1921 qemu_input_queue_btn(NULL, button, false);
1924 qemu_input_event_sync();
1927 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1929 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1930 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1931 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1932 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1934 int button_state = qdict_get_int(qdict, "button_state");
1936 if (mouse_button_state == button_state) {
1939 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1940 qemu_input_event_sync();
1941 mouse_button_state = button_state;
1944 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1946 int size = qdict_get_int(qdict, "size");
1947 int addr = qdict_get_int(qdict, "addr");
1948 int has_index = qdict_haskey(qdict, "index");
1953 int index = qdict_get_int(qdict, "index");
1954 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1962 val = cpu_inb(addr);
1966 val = cpu_inw(addr);
1970 val = cpu_inl(addr);
1974 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1975 suffix, addr, size * 2, val);
1978 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1980 int size = qdict_get_int(qdict, "size");
1981 int addr = qdict_get_int(qdict, "addr");
1982 int val = qdict_get_int(qdict, "val");
1984 addr &= IOPORTS_MASK;
1989 cpu_outb(addr, val);
1992 cpu_outw(addr, val);
1995 cpu_outl(addr, val);
2000 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
2002 Error *local_err = NULL;
2003 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
2005 qemu_boot_set(bootdevice, &local_err);
2007 error_report_err(local_err);
2009 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
2013 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
2015 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
2016 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
2017 bool owner = qdict_get_try_bool(qdict, "owner", false);
2019 mtree_info((fprintf_function)monitor_printf, mon, flatview, dispatch_tree,
2023 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
2026 NumaNodeMem *node_mem;
2027 CpuInfoList *cpu_list, *cpu;
2029 cpu_list = qmp_query_cpus(&error_abort);
2030 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
2032 query_numa_node_mem(node_mem);
2033 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
2034 for (i = 0; i < nb_numa_nodes; i++) {
2035 monitor_printf(mon, "node %d cpus:", i);
2036 for (cpu = cpu_list; cpu; cpu = cpu->next) {
2037 if (cpu->value->has_props && cpu->value->props->has_node_id &&
2038 cpu->value->props->node_id == i) {
2039 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
2042 monitor_printf(mon, "\n");
2043 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
2044 node_mem[i].node_mem >> 20);
2045 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
2046 node_mem[i].node_plugged_mem >> 20);
2048 qapi_free_CpuInfoList(cpu_list);
2052 #ifdef CONFIG_PROFILER
2057 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2059 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
2060 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
2061 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
2062 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
2067 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2069 monitor_printf(mon, "Internal profiler not compiled\n");
2073 /* Capture support */
2074 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
2076 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
2081 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2082 monitor_printf(mon, "[%d]: ", i);
2083 s->ops.info (s->opaque);
2087 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
2090 int n = qdict_get_int(qdict, "n");
2093 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2095 s->ops.destroy (s->opaque);
2096 QLIST_REMOVE (s, entries);
2103 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2105 const char *path = qdict_get_str(qdict, "path");
2106 int has_freq = qdict_haskey(qdict, "freq");
2107 int freq = qdict_get_try_int(qdict, "freq", -1);
2108 int has_bits = qdict_haskey(qdict, "bits");
2109 int bits = qdict_get_try_int(qdict, "bits", -1);
2110 int has_channels = qdict_haskey(qdict, "nchannels");
2111 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2114 s = g_malloc0 (sizeof (*s));
2116 freq = has_freq ? freq : 44100;
2117 bits = has_bits ? bits : 16;
2118 nchannels = has_channels ? nchannels : 2;
2120 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2121 monitor_printf(mon, "Failed to add wave capture\n");
2125 QLIST_INSERT_HEAD (&capture_head, s, entries);
2128 static qemu_acl *find_acl(Monitor *mon, const char *name)
2130 qemu_acl *acl = qemu_acl_find(name);
2133 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2138 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2140 const char *aclname = qdict_get_str(qdict, "aclname");
2141 qemu_acl *acl = find_acl(mon, aclname);
2142 qemu_acl_entry *entry;
2146 monitor_printf(mon, "policy: %s\n",
2147 acl->defaultDeny ? "deny" : "allow");
2148 QTAILQ_FOREACH(entry, &acl->entries, next) {
2150 monitor_printf(mon, "%d: %s %s\n", i,
2151 entry->deny ? "deny" : "allow", entry->match);
2156 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2158 const char *aclname = qdict_get_str(qdict, "aclname");
2159 qemu_acl *acl = find_acl(mon, aclname);
2162 qemu_acl_reset(acl);
2163 monitor_printf(mon, "acl: removed all rules\n");
2167 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2169 const char *aclname = qdict_get_str(qdict, "aclname");
2170 const char *policy = qdict_get_str(qdict, "policy");
2171 qemu_acl *acl = find_acl(mon, aclname);
2174 if (strcmp(policy, "allow") == 0) {
2175 acl->defaultDeny = 0;
2176 monitor_printf(mon, "acl: policy set to 'allow'\n");
2177 } else if (strcmp(policy, "deny") == 0) {
2178 acl->defaultDeny = 1;
2179 monitor_printf(mon, "acl: policy set to 'deny'\n");
2181 monitor_printf(mon, "acl: unknown policy '%s', "
2182 "expected 'deny' or 'allow'\n", policy);
2187 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2189 const char *aclname = qdict_get_str(qdict, "aclname");
2190 const char *match = qdict_get_str(qdict, "match");
2191 const char *policy = qdict_get_str(qdict, "policy");
2192 int has_index = qdict_haskey(qdict, "index");
2193 int index = qdict_get_try_int(qdict, "index", -1);
2194 qemu_acl *acl = find_acl(mon, aclname);
2198 if (strcmp(policy, "allow") == 0) {
2200 } else if (strcmp(policy, "deny") == 0) {
2203 monitor_printf(mon, "acl: unknown policy '%s', "
2204 "expected 'deny' or 'allow'\n", policy);
2208 ret = qemu_acl_insert(acl, deny, match, index);
2210 ret = qemu_acl_append(acl, deny, match);
2212 monitor_printf(mon, "acl: unable to add acl entry\n");
2214 monitor_printf(mon, "acl: added rule at position %d\n", ret);
2218 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2220 const char *aclname = qdict_get_str(qdict, "aclname");
2221 const char *match = qdict_get_str(qdict, "match");
2222 qemu_acl *acl = find_acl(mon, aclname);
2226 ret = qemu_acl_remove(acl, match);
2228 monitor_printf(mon, "acl: no matching acl entry\n");
2230 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
2234 void qmp_getfd(const char *fdname, Error **errp)
2239 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2241 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2245 if (qemu_isdigit(fdname[0])) {
2247 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2248 "a name not starting with a digit");
2252 qemu_mutex_lock(&cur_mon->mon_lock);
2253 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2254 if (strcmp(monfd->name, fdname) != 0) {
2260 qemu_mutex_unlock(&cur_mon->mon_lock);
2261 /* Make sure close() is outside critical section */
2266 monfd = g_malloc0(sizeof(mon_fd_t));
2267 monfd->name = g_strdup(fdname);
2270 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2271 qemu_mutex_unlock(&cur_mon->mon_lock);
2274 void qmp_closefd(const char *fdname, Error **errp)
2279 qemu_mutex_lock(&cur_mon->mon_lock);
2280 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2281 if (strcmp(monfd->name, fdname) != 0) {
2285 QLIST_REMOVE(monfd, next);
2287 g_free(monfd->name);
2289 qemu_mutex_unlock(&cur_mon->mon_lock);
2290 /* Make sure close() is outside critical section */
2295 qemu_mutex_unlock(&cur_mon->mon_lock);
2296 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2299 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2303 qemu_mutex_lock(&mon->mon_lock);
2304 QLIST_FOREACH(monfd, &mon->fds, next) {
2307 if (strcmp(monfd->name, fdname) != 0) {
2313 /* caller takes ownership of fd */
2314 QLIST_REMOVE(monfd, next);
2315 g_free(monfd->name);
2317 qemu_mutex_unlock(&mon->mon_lock);
2322 qemu_mutex_unlock(&mon->mon_lock);
2323 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2327 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2329 MonFdsetFd *mon_fdset_fd;
2330 MonFdsetFd *mon_fdset_fd_next;
2332 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2333 if ((mon_fdset_fd->removed ||
2334 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2335 runstate_is_running()) {
2336 close(mon_fdset_fd->fd);
2337 g_free(mon_fdset_fd->opaque);
2338 QLIST_REMOVE(mon_fdset_fd, next);
2339 g_free(mon_fdset_fd);
2343 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2344 QLIST_REMOVE(mon_fdset, next);
2349 static void monitor_fdsets_cleanup(void)
2351 MonFdset *mon_fdset;
2352 MonFdset *mon_fdset_next;
2354 qemu_mutex_lock(&mon_fdsets_lock);
2355 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2356 monitor_fdset_cleanup(mon_fdset);
2358 qemu_mutex_unlock(&mon_fdsets_lock);
2361 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2362 const char *opaque, Error **errp)
2365 Monitor *mon = cur_mon;
2368 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2370 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2374 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2375 has_opaque, opaque, errp);
2387 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2389 MonFdset *mon_fdset;
2390 MonFdsetFd *mon_fdset_fd;
2393 qemu_mutex_lock(&mon_fdsets_lock);
2394 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2395 if (mon_fdset->id != fdset_id) {
2398 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2400 if (mon_fdset_fd->fd != fd) {
2403 mon_fdset_fd->removed = true;
2406 mon_fdset_fd->removed = true;
2409 if (has_fd && !mon_fdset_fd) {
2412 monitor_fdset_cleanup(mon_fdset);
2413 qemu_mutex_unlock(&mon_fdsets_lock);
2418 qemu_mutex_unlock(&mon_fdsets_lock);
2420 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2423 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2425 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2428 FdsetInfoList *qmp_query_fdsets(Error **errp)
2430 MonFdset *mon_fdset;
2431 MonFdsetFd *mon_fdset_fd;
2432 FdsetInfoList *fdset_list = NULL;
2434 qemu_mutex_lock(&mon_fdsets_lock);
2435 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2436 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2437 FdsetFdInfoList *fdsetfd_list = NULL;
2439 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2440 fdset_info->value->fdset_id = mon_fdset->id;
2442 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2443 FdsetFdInfoList *fdsetfd_info;
2445 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2446 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2447 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2448 if (mon_fdset_fd->opaque) {
2449 fdsetfd_info->value->has_opaque = true;
2450 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2452 fdsetfd_info->value->has_opaque = false;
2455 fdsetfd_info->next = fdsetfd_list;
2456 fdsetfd_list = fdsetfd_info;
2459 fdset_info->value->fds = fdsetfd_list;
2461 fdset_info->next = fdset_list;
2462 fdset_list = fdset_info;
2464 qemu_mutex_unlock(&mon_fdsets_lock);
2469 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2470 bool has_opaque, const char *opaque,
2473 MonFdset *mon_fdset = NULL;
2474 MonFdsetFd *mon_fdset_fd;
2477 qemu_mutex_lock(&mon_fdsets_lock);
2479 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2480 /* Break if match found or match impossible due to ordering by ID */
2481 if (fdset_id <= mon_fdset->id) {
2482 if (fdset_id < mon_fdset->id) {
2490 if (mon_fdset == NULL) {
2491 int64_t fdset_id_prev = -1;
2492 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2496 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2497 "a non-negative value");
2498 qemu_mutex_unlock(&mon_fdsets_lock);
2501 /* Use specified fdset ID */
2502 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2503 mon_fdset_cur = mon_fdset;
2504 if (fdset_id < mon_fdset_cur->id) {
2509 /* Use first available fdset ID */
2510 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2511 mon_fdset_cur = mon_fdset;
2512 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2513 fdset_id_prev = mon_fdset_cur->id;
2520 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2522 mon_fdset->id = fdset_id;
2524 mon_fdset->id = fdset_id_prev + 1;
2527 /* The fdset list is ordered by fdset ID */
2528 if (!mon_fdset_cur) {
2529 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2530 } else if (mon_fdset->id < mon_fdset_cur->id) {
2531 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2533 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2537 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2538 mon_fdset_fd->fd = fd;
2539 mon_fdset_fd->removed = false;
2541 mon_fdset_fd->opaque = g_strdup(opaque);
2543 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2545 fdinfo = g_malloc0(sizeof(*fdinfo));
2546 fdinfo->fdset_id = mon_fdset->id;
2547 fdinfo->fd = mon_fdset_fd->fd;
2549 qemu_mutex_unlock(&mon_fdsets_lock);
2553 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2558 MonFdset *mon_fdset;
2559 MonFdsetFd *mon_fdset_fd;
2563 qemu_mutex_lock(&mon_fdsets_lock);
2564 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2565 if (mon_fdset->id != fdset_id) {
2568 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2569 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2570 if (mon_fd_flags == -1) {
2575 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2576 ret = mon_fdset_fd->fd;
2586 qemu_mutex_unlock(&mon_fdsets_lock);
2591 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2593 MonFdset *mon_fdset;
2594 MonFdsetFd *mon_fdset_fd_dup;
2596 qemu_mutex_lock(&mon_fdsets_lock);
2597 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2598 if (mon_fdset->id != fdset_id) {
2601 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2602 if (mon_fdset_fd_dup->fd == dup_fd) {
2606 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2607 mon_fdset_fd_dup->fd = dup_fd;
2608 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2609 qemu_mutex_unlock(&mon_fdsets_lock);
2614 qemu_mutex_unlock(&mon_fdsets_lock);
2618 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2620 MonFdset *mon_fdset;
2621 MonFdsetFd *mon_fdset_fd_dup;
2623 qemu_mutex_lock(&mon_fdsets_lock);
2624 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2625 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2626 if (mon_fdset_fd_dup->fd == dup_fd) {
2628 QLIST_REMOVE(mon_fdset_fd_dup, next);
2629 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2630 monitor_fdset_cleanup(mon_fdset);
2634 qemu_mutex_unlock(&mon_fdsets_lock);
2635 return mon_fdset->id;
2642 qemu_mutex_unlock(&mon_fdsets_lock);
2646 int monitor_fdset_dup_fd_find(int dup_fd)
2648 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2651 void monitor_fdset_dup_fd_remove(int dup_fd)
2653 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2656 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2659 Error *local_err = NULL;
2661 if (!qemu_isdigit(fdname[0]) && mon) {
2662 fd = monitor_get_fd(mon, fdname, &local_err);
2664 fd = qemu_parse_fd(fdname);
2666 error_setg(&local_err, "Invalid file descriptor number '%s'",
2671 error_propagate(errp, local_err);
2680 /* Please update hmp-commands.hx when adding or changing commands */
2681 static mon_cmd_t info_cmds[] = {
2682 #include "hmp-commands-info.h"
2686 /* mon_cmds and info_cmds would be sorted at runtime */
2687 static mon_cmd_t mon_cmds[] = {
2688 #include "hmp-commands.h"
2692 /*******************************************************************/
2694 static const char *pch;
2695 static sigjmp_buf expr_env;
2698 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2699 expr_error(Monitor *mon, const char *fmt, ...)
2703 monitor_vprintf(mon, fmt, ap);
2704 monitor_printf(mon, "\n");
2706 siglongjmp(expr_env, 1);
2709 /* return 0 if OK, -1 if not found */
2710 static int get_monitor_def(target_long *pval, const char *name)
2712 const MonitorDef *md = target_monitor_defs();
2713 CPUState *cs = mon_get_cpu();
2718 if (cs == NULL || md == NULL) {
2722 for(; md->name != NULL; md++) {
2723 if (compare_cmd(name, md->name)) {
2724 if (md->get_value) {
2725 *pval = md->get_value(md, md->offset);
2727 CPUArchState *env = mon_get_cpu_env();
2728 ptr = (uint8_t *)env + md->offset;
2731 *pval = *(int32_t *)ptr;
2734 *pval = *(target_long *)ptr;
2745 ret = target_get_monitor_def(cs, name, &tmp);
2747 *pval = (target_long) tmp;
2753 static void next(void)
2757 while (qemu_isspace(*pch))
2762 static int64_t expr_sum(Monitor *mon);
2764 static int64_t expr_unary(Monitor *mon)
2773 n = expr_unary(mon);
2777 n = -expr_unary(mon);
2781 n = ~expr_unary(mon);
2787 expr_error(mon, "')' expected");
2794 expr_error(mon, "character constant expected");
2798 expr_error(mon, "missing terminating \' character");
2808 while ((*pch >= 'a' && *pch <= 'z') ||
2809 (*pch >= 'A' && *pch <= 'Z') ||
2810 (*pch >= '0' && *pch <= '9') ||
2811 *pch == '_' || *pch == '.') {
2812 if ((q - buf) < sizeof(buf) - 1)
2816 while (qemu_isspace(*pch))
2819 ret = get_monitor_def(®, buf);
2821 expr_error(mon, "unknown register");
2826 expr_error(mon, "unexpected end of expression");
2831 n = strtoull(pch, &p, 0);
2832 if (errno == ERANGE) {
2833 expr_error(mon, "number too large");
2836 expr_error(mon, "invalid char '%c' in expression", *p);
2839 while (qemu_isspace(*pch))
2847 static int64_t expr_prod(Monitor *mon)
2852 val = expr_unary(mon);
2855 if (op != '*' && op != '/' && op != '%')
2858 val2 = expr_unary(mon);
2867 expr_error(mon, "division by zero");
2878 static int64_t expr_logic(Monitor *mon)
2883 val = expr_prod(mon);
2886 if (op != '&' && op != '|' && op != '^')
2889 val2 = expr_prod(mon);
2906 static int64_t expr_sum(Monitor *mon)
2911 val = expr_logic(mon);
2914 if (op != '+' && op != '-')
2917 val2 = expr_logic(mon);
2926 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2929 if (sigsetjmp(expr_env, 0)) {
2933 while (qemu_isspace(*pch))
2935 *pval = expr_sum(mon);
2940 static int get_double(Monitor *mon, double *pval, const char **pp)
2942 const char *p = *pp;
2946 d = strtod(p, &tailp);
2948 monitor_printf(mon, "Number expected\n");
2951 if (d != d || d - d != 0) {
2952 /* NaN or infinity */
2953 monitor_printf(mon, "Bad number\n");
2962 * Store the command-name in cmdname, and return a pointer to
2963 * the remaining of the command string.
2965 static const char *get_command_name(const char *cmdline,
2966 char *cmdname, size_t nlen)
2969 const char *p, *pstart;
2972 while (qemu_isspace(*p))
2977 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2982 memcpy(cmdname, pstart, len);
2983 cmdname[len] = '\0';
2988 * Read key of 'type' into 'key' and return the current
2991 static char *key_get_info(const char *type, char **key)
2999 p = strchr(type, ':');
3006 str = g_malloc(len + 1);
3007 memcpy(str, type, len);
3014 static int default_fmt_format = 'x';
3015 static int default_fmt_size = 4;
3017 static int is_valid_option(const char *c, const char *typestr)
3025 typestr = strstr(typestr, option);
3026 return (typestr != NULL);
3029 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
3030 const char *cmdname)
3032 const mon_cmd_t *cmd;
3034 for (cmd = disp_table; cmd->name != NULL; cmd++) {
3035 if (compare_cmd(cmdname, cmd->name)) {
3044 * Parse command name from @cmdp according to command table @table.
3045 * If blank, return NULL.
3046 * Else, if no valid command can be found, report to @mon, and return
3048 * Else, change @cmdp to point right behind the name, and return its
3049 * command table entry.
3050 * Do not assume the return value points into @table! It doesn't when
3051 * the command is found in a sub-command table.
3053 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
3054 const char *cmdp_start,
3059 const mon_cmd_t *cmd;
3062 /* extract the command name */
3063 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
3067 cmd = search_dispatch_table(table, cmdname);
3069 monitor_printf(mon, "unknown command: '%.*s'\n",
3070 (int)(p - cmdp_start), cmdp_start);
3073 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
3074 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
3075 "until after exit_preconfig.\n",
3076 (int)(p - cmdp_start), cmdp_start);
3080 /* filter out following useless space */
3081 while (qemu_isspace(*p)) {
3086 /* search sub command */
3087 if (cmd->sub_table != NULL && *p != '\0') {
3088 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3095 * Parse arguments for @cmd.
3096 * If it can't be parsed, report to @mon, and return NULL.
3097 * Else, insert command arguments into a QDict, and return it.
3098 * Note: On success, caller has to free the QDict structure.
3101 static QDict *monitor_parse_arguments(Monitor *mon,
3103 const mon_cmd_t *cmd)
3105 const char *typestr;
3108 const char *p = *endp;
3110 QDict *qdict = qdict_new();
3112 /* parse the parameters */
3113 typestr = cmd->args_type;
3115 typestr = key_get_info(typestr, &key);
3127 while (qemu_isspace(*p))
3129 if (*typestr == '?') {
3132 /* no optional string: NULL argument */
3136 ret = get_str(buf, sizeof(buf), &p);
3140 monitor_printf(mon, "%s: filename expected\n",
3144 monitor_printf(mon, "%s: block device name expected\n",
3148 monitor_printf(mon, "%s: string expected\n", cmd->name);
3153 qdict_put_str(qdict, key, buf);
3158 QemuOptsList *opts_list;
3161 opts_list = qemu_find_opts(key);
3162 if (!opts_list || opts_list->desc->name) {
3165 while (qemu_isspace(*p)) {
3170 if (get_str(buf, sizeof(buf), &p) < 0) {
3173 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3177 qemu_opts_to_qdict(opts, qdict);
3178 qemu_opts_del(opts);
3183 int count, format, size;
3185 while (qemu_isspace(*p))
3191 if (qemu_isdigit(*p)) {
3193 while (qemu_isdigit(*p)) {
3194 count = count * 10 + (*p - '0');
3232 if (*p != '\0' && !qemu_isspace(*p)) {
3233 monitor_printf(mon, "invalid char in format: '%c'\n",
3238 format = default_fmt_format;
3239 if (format != 'i') {
3240 /* for 'i', not specifying a size gives -1 as size */
3242 size = default_fmt_size;
3243 default_fmt_size = size;
3245 default_fmt_format = format;
3248 format = default_fmt_format;
3249 if (format != 'i') {
3250 size = default_fmt_size;
3255 qdict_put_int(qdict, "count", count);
3256 qdict_put_int(qdict, "format", format);
3257 qdict_put_int(qdict, "size", size);
3266 while (qemu_isspace(*p))
3268 if (*typestr == '?' || *typestr == '.') {
3269 if (*typestr == '?') {
3277 while (qemu_isspace(*p))
3286 if (get_expr(mon, &val, &p))
3288 /* Check if 'i' is greater than 32-bit */
3289 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3290 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3291 monitor_printf(mon, "integer is for 32-bit values\n");
3293 } else if (c == 'M') {
3295 monitor_printf(mon, "enter a positive value\n");
3300 qdict_put_int(qdict, key, val);
3309 while (qemu_isspace(*p)) {
3312 if (*typestr == '?') {
3318 ret = qemu_strtosz_MiB(p, &end, &val);
3319 if (ret < 0 || val > INT64_MAX) {
3320 monitor_printf(mon, "invalid size\n");
3323 qdict_put_int(qdict, key, val);
3331 while (qemu_isspace(*p))
3333 if (*typestr == '?') {
3339 if (get_double(mon, &val, &p) < 0) {
3342 if (p[0] && p[1] == 's') {
3345 val /= 1e3; p += 2; break;
3347 val /= 1e6; p += 2; break;
3349 val /= 1e9; p += 2; break;
3352 if (*p && !qemu_isspace(*p)) {
3353 monitor_printf(mon, "Unknown unit suffix\n");
3356 qdict_put(qdict, key, qnum_from_double(val));
3364 while (qemu_isspace(*p)) {
3368 while (qemu_isgraph(*p)) {
3371 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3373 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3376 monitor_printf(mon, "Expected 'on' or 'off'\n");
3379 qdict_put_bool(qdict, key, val);
3384 const char *tmp = p;
3391 while (qemu_isspace(*p))
3396 if(!is_valid_option(p, typestr)) {
3398 monitor_printf(mon, "%s: unsupported option -%c\n",
3410 qdict_put_bool(qdict, key, true);
3417 /* package all remaining string */
3420 while (qemu_isspace(*p)) {
3423 if (*typestr == '?') {
3426 /* no remaining string: NULL argument */
3432 monitor_printf(mon, "%s: string expected\n",
3436 qdict_put_str(qdict, key, p);
3442 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3448 /* check that all arguments were parsed */
3449 while (qemu_isspace(*p))
3452 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3460 qobject_unref(qdict);
3465 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3468 const mon_cmd_t *cmd;
3469 const char *cmd_start = cmdline;
3471 trace_handle_hmp_command(mon, cmdline);
3473 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3478 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3480 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3483 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3484 (int)(cmdline - cmd_start), cmd_start);
3488 cmd->cmd(mon, qdict);
3489 qobject_unref(qdict);
3492 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3494 const char *p, *pstart;
3501 p = qemu_strchrnul(p, '|');
3503 if (len > sizeof(cmd) - 2)
3504 len = sizeof(cmd) - 2;
3505 memcpy(cmd, pstart, len);
3507 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3508 readline_add_completion(mon->rs, cmd);
3516 static void file_completion(Monitor *mon, const char *input)
3521 char file[1024], file_prefix[1024];
3525 p = strrchr(input, '/');
3528 pstrcpy(file_prefix, sizeof(file_prefix), input);
3529 pstrcpy(path, sizeof(path), ".");
3531 input_path_len = p - input + 1;
3532 memcpy(path, input, input_path_len);
3533 if (input_path_len > sizeof(path) - 1)
3534 input_path_len = sizeof(path) - 1;
3535 path[input_path_len] = '\0';
3536 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3539 ffs = opendir(path);
3548 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3552 if (strstart(d->d_name, file_prefix, NULL)) {
3553 memcpy(file, input, input_path_len);
3554 if (input_path_len < sizeof(file))
3555 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3557 /* stat the file to find out if it's a directory.
3558 * In that case add a slash to speed up typing long paths
3560 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3561 pstrcat(file, sizeof(file), "/");
3563 readline_add_completion(mon->rs, file);
3569 static const char *next_arg_type(const char *typestr)
3571 const char *p = strchr(typestr, ':');
3572 return (p != NULL ? ++p : typestr);
3575 static void add_completion_option(ReadLineState *rs, const char *str,
3578 if (!str || !option) {
3581 if (!strncmp(option, str, strlen(str))) {
3582 readline_add_completion(rs, option);
3586 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3589 ChardevBackendInfoList *list, *start;
3595 readline_set_completion_index(rs, len);
3597 start = list = qmp_query_chardev_backends(NULL);
3599 const char *chr_name = list->value->name;
3601 if (!strncmp(chr_name, str, len)) {
3602 readline_add_completion(rs, chr_name);
3606 qapi_free_ChardevBackendInfoList(start);
3609 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3618 readline_set_completion_index(rs, len);
3619 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3620 add_completion_option(rs, str, NetClientDriver_str(i));
3624 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3634 readline_set_completion_index(rs, len);
3635 list = elt = object_class_get_list(TYPE_DEVICE, false);
3638 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3640 name = object_class_get_name(OBJECT_CLASS(dc));
3642 if (dc->user_creatable
3643 && !strncmp(name, str, len)) {
3644 readline_add_completion(rs, name);
3651 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3661 readline_set_completion_index(rs, len);
3662 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3666 name = object_class_get_name(OBJECT_CLASS(elt->data));
3667 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3668 readline_add_completion(rs, name);
3675 static void peripheral_device_del_completion(ReadLineState *rs,
3676 const char *str, size_t len)
3678 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3679 GSList *list, *item;
3681 list = qdev_build_hotpluggable_device_list(peripheral);
3686 for (item = list; item; item = g_slist_next(item)) {
3687 DeviceState *dev = item->data;
3689 if (dev->id && !strncmp(str, dev->id, len)) {
3690 readline_add_completion(rs, dev->id);
3697 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3700 ChardevInfoList *list, *start;
3706 readline_set_completion_index(rs, len);
3708 start = list = qmp_query_chardev(NULL);
3710 ChardevInfo *chr = list->value;
3712 if (!strncmp(chr->label, str, len)) {
3713 readline_add_completion(rs, chr->label);
3717 qapi_free_ChardevInfoList(start);
3720 static void ringbuf_completion(ReadLineState *rs, const char *str)
3723 ChardevInfoList *list, *start;
3726 readline_set_completion_index(rs, len);
3728 start = list = qmp_query_chardev(NULL);
3730 ChardevInfo *chr_info = list->value;
3732 if (!strncmp(chr_info->label, str, len)) {
3733 Chardev *chr = qemu_chr_find(chr_info->label);
3734 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3735 readline_add_completion(rs, chr_info->label);
3740 qapi_free_ChardevInfoList(start);
3743 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3748 ringbuf_completion(rs, str);
3751 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3760 readline_set_completion_index(rs, len);
3761 peripheral_device_del_completion(rs, str, len);
3764 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3766 ObjectPropertyInfoList *list, *start;
3773 readline_set_completion_index(rs, len);
3775 start = list = qmp_qom_list("/objects", NULL);
3777 ObjectPropertyInfo *info = list->value;
3779 if (!strncmp(info->type, "child<", 5)
3780 && !strncmp(info->name, str, len)) {
3781 readline_add_completion(rs, info->name);
3785 qapi_free_ObjectPropertyInfoList(start);
3788 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3797 sep = strrchr(str, '-');
3802 readline_set_completion_index(rs, len);
3803 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3804 if (!strncmp(str, QKeyCode_str(i), len)) {
3805 readline_add_completion(rs, QKeyCode_str(i));
3810 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3815 readline_set_completion_index(rs, len);
3817 NetClientState *ncs[MAX_QUEUE_NUM];
3819 count = qemu_find_net_clients_except(NULL, ncs,
3820 NET_CLIENT_DRIVER_NONE,
3822 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3823 const char *name = ncs[i]->name;
3824 if (!strncmp(str, name, len)) {
3825 readline_add_completion(rs, name);
3828 } else if (nb_args == 3) {
3829 add_completion_option(rs, str, "on");
3830 add_completion_option(rs, str, "off");
3834 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3837 NetClientState *ncs[MAX_QUEUE_NUM];
3844 readline_set_completion_index(rs, len);
3845 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3847 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3849 const char *name = ncs[i]->name;
3850 if (strncmp(str, name, len)) {
3853 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3855 readline_add_completion(rs, name);
3860 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3865 readline_set_completion_index(rs, len);
3867 TraceEventIter iter;
3869 char *pattern = g_strdup_printf("%s*", str);
3870 trace_event_iter_init(&iter, pattern);
3871 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3872 readline_add_completion(rs, trace_event_get_name(ev));
3878 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3883 readline_set_completion_index(rs, len);
3885 TraceEventIter iter;
3887 char *pattern = g_strdup_printf("%s*", str);
3888 trace_event_iter_init(&iter, pattern);
3889 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3890 readline_add_completion(rs, trace_event_get_name(ev));
3893 } else if (nb_args == 3) {
3894 add_completion_option(rs, str, "on");
3895 add_completion_option(rs, str, "off");
3899 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3906 readline_set_completion_index(rs, strlen(str));
3907 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3908 add_completion_option(rs, str, WatchdogAction_str(i));
3912 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3918 readline_set_completion_index(rs, len);
3921 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3922 const char *name = MigrationCapability_str(i);
3923 if (!strncmp(str, name, len)) {
3924 readline_add_completion(rs, name);
3927 } else if (nb_args == 3) {
3928 add_completion_option(rs, str, "on");
3929 add_completion_option(rs, str, "off");
3933 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3939 readline_set_completion_index(rs, len);
3942 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3943 const char *name = MigrationParameter_str(i);
3944 if (!strncmp(str, name, len)) {
3945 readline_add_completion(rs, name);
3951 static void vm_completion(ReadLineState *rs, const char *str)
3954 BlockDriverState *bs;
3955 BdrvNextIterator it;
3958 readline_set_completion_index(rs, len);
3960 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3961 SnapshotInfoList *snapshots, *snapshot;
3962 AioContext *ctx = bdrv_get_aio_context(bs);
3965 aio_context_acquire(ctx);
3966 if (bdrv_can_snapshot(bs)) {
3967 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3969 aio_context_release(ctx);
3974 snapshot = snapshots;
3976 char *completion = snapshot->value->name;
3977 if (!strncmp(str, completion, len)) {
3978 readline_add_completion(rs, completion);
3980 completion = snapshot->value->id;
3981 if (!strncmp(str, completion, len)) {
3982 readline_add_completion(rs, completion);
3984 snapshot = snapshot->next;
3986 qapi_free_SnapshotInfoList(snapshots);
3991 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3994 vm_completion(rs, str);
3998 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
4001 vm_completion(rs, str);
4005 static void monitor_find_completion_by_table(Monitor *mon,
4006 const mon_cmd_t *cmd_table,
4010 const char *cmdname;
4012 const char *ptype, *old_ptype, *str, *name;
4013 const mon_cmd_t *cmd;
4014 BlockBackend *blk = NULL;
4017 /* command completion */
4022 readline_set_completion_index(mon->rs, strlen(cmdname));
4023 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4024 if (!runstate_check(RUN_STATE_PRECONFIG) ||
4025 cmd_can_preconfig(cmd)) {
4026 cmd_completion(mon, cmdname, cmd->name);
4030 /* find the command */
4031 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4032 if (compare_cmd(args[0], cmd->name) &&
4033 (!runstate_check(RUN_STATE_PRECONFIG) ||
4034 cmd_can_preconfig(cmd))) {
4042 if (cmd->sub_table) {
4043 /* do the job again */
4044 monitor_find_completion_by_table(mon, cmd->sub_table,
4045 &args[1], nb_args - 1);
4048 if (cmd->command_completion) {
4049 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
4053 ptype = next_arg_type(cmd->args_type);
4054 for(i = 0; i < nb_args - 2; i++) {
4055 if (*ptype != '\0') {
4056 ptype = next_arg_type(ptype);
4057 while (*ptype == '?')
4058 ptype = next_arg_type(ptype);
4061 str = args[nb_args - 1];
4063 while (*ptype == '-' && old_ptype != ptype) {
4065 ptype = next_arg_type(ptype);
4069 /* file completion */
4070 readline_set_completion_index(mon->rs, strlen(str));
4071 file_completion(mon, str);
4074 /* block device name completion */
4075 readline_set_completion_index(mon->rs, strlen(str));
4076 while ((blk = blk_next(blk)) != NULL) {
4077 name = blk_name(blk);
4078 if (str[0] == '\0' ||
4079 !strncmp(name, str, strlen(str))) {
4080 readline_add_completion(mon->rs, name);
4086 if (!strcmp(cmd->name, "help|?")) {
4087 monitor_find_completion_by_table(mon, cmd_table,
4088 &args[1], nb_args - 1);
4097 static void monitor_find_completion(void *opaque,
4098 const char *cmdline)
4100 Monitor *mon = opaque;
4101 char *args[MAX_ARGS];
4104 /* 1. parse the cmdline */
4105 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4109 /* if the line ends with a space, it means we want to complete the
4111 len = strlen(cmdline);
4112 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4113 if (nb_args >= MAX_ARGS) {
4116 args[nb_args++] = g_strdup("");
4119 /* 2. auto complete according to args */
4120 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4123 free_cmdline_args(args, nb_args);
4126 static int monitor_can_read(void *opaque)
4128 Monitor *mon = opaque;
4130 return !atomic_mb_read(&mon->suspend_cnt);
4134 * Emit QMP response @rsp with ID @id to @mon.
4135 * Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
4136 * Nothing is emitted then.
4138 static void monitor_qmp_respond(Monitor *mon, QDict *rsp, QObject *id)
4142 qdict_put_obj(rsp, "id", qobject_ref(id));
4145 qmp_queue_response(mon, rsp);
4149 static void monitor_qmp_dispatch(Monitor *mon, QObject *req, QObject *id)
4158 rsp = qmp_dispatch(mon->qmp.commands, req, qmp_oob_enabled(mon));
4162 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
4163 error = qdict_get_qdict(rsp, "error");
4165 && !g_strcmp0(qdict_get_try_str(error, "class"),
4166 QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
4167 /* Provide a more useful error message */
4168 qdict_del(error, "desc");
4169 qdict_put_str(error, "desc", "Expecting capabilities negotiation"
4170 " with 'qmp_capabilities'");
4174 monitor_qmp_respond(mon, rsp, id);
4179 * Pop a QMP request from a monitor request queue.
4180 * Return the request, or NULL all request queues are empty.
4181 * We are using round-robin fashion to pop the request, to avoid
4182 * processing commands only on a very busy monitor. To achieve that,
4183 * when we process one request on a specific monitor, we put that
4184 * monitor to the end of mon_list queue.
4186 static QMPRequest *monitor_qmp_requests_pop_any(void)
4188 QMPRequest *req_obj = NULL;
4191 qemu_mutex_lock(&monitor_lock);
4193 QTAILQ_FOREACH(mon, &mon_list, entry) {
4194 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4195 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4196 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4204 * We found one request on the monitor. Degrade this monitor's
4205 * priority to lowest by re-inserting it to end of queue.
4207 QTAILQ_REMOVE(&mon_list, mon, entry);
4208 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4211 qemu_mutex_unlock(&monitor_lock);
4216 static void monitor_qmp_bh_dispatcher(void *data)
4218 QMPRequest *req_obj = monitor_qmp_requests_pop_any();
4226 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(req_obj->id) ?: "");
4227 monitor_qmp_dispatch(req_obj->mon, req_obj->req, req_obj->id);
4229 assert(req_obj->err);
4230 rsp = qmp_error_response(req_obj->err);
4231 req_obj->err = NULL;
4232 monitor_qmp_respond(req_obj->mon, rsp, NULL);
4236 if (req_obj->need_resume) {
4237 /* Pairs with the monitor_suspend() in handle_qmp_command() */
4238 monitor_resume(req_obj->mon);
4240 qmp_request_free(req_obj);
4242 /* Reschedule instead of looping so the main loop stays responsive */
4243 qemu_bh_schedule(qmp_dispatcher_bh);
4246 #define QMP_REQ_QUEUE_LEN_MAX (8)
4248 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
4250 QObject *req, *id = NULL;
4252 MonitorQMP *mon_qmp = container_of(parser, MonitorQMP, parser);
4253 Monitor *mon = container_of(mon_qmp, Monitor, qmp);
4255 QMPRequest *req_obj;
4257 req = json_parser_parse_err(tokens, NULL, &err);
4259 /* json_parser_parse_err() sucks: can fail without setting @err */
4260 error_setg(&err, QERR_JSON_PARSING);
4263 qdict = qobject_to(QDict, req);
4265 id = qobject_ref(qdict_get(qdict, "id"));
4266 qdict_del(qdict, "id");
4267 } /* else will fail qmp_dispatch() */
4269 if (req && trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4270 QString *req_json = qobject_to_json(req);
4271 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4272 qobject_unref(req_json);
4275 if (qdict && qmp_is_oob(qdict)) {
4276 /* OOB commands are executed immediately */
4277 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id)
4279 monitor_qmp_dispatch(mon, req, id);
4285 req_obj = g_new0(QMPRequest, 1);
4290 req_obj->need_resume = false;
4292 /* Protect qmp_requests and fetching its length. */
4293 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4296 * If OOB is not enabled on the current monitor, we'll emulate the
4297 * old behavior that we won't process the current monitor any more
4298 * until it has responded. This helps make sure that as long as
4299 * OOB is not enabled, the server will never drop any command.
4301 if (!qmp_oob_enabled(mon)) {
4302 monitor_suspend(mon);
4303 req_obj->need_resume = true;
4305 /* Drop the request if queue is full. */
4306 if (mon->qmp.qmp_requests->length >= QMP_REQ_QUEUE_LEN_MAX) {
4307 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4309 * FIXME @id's scope is just @mon, and broadcasting it is
4310 * wrong. If another monitor's client has a command with
4311 * the same ID in flight, the event will incorrectly claim
4312 * that command was dropped.
4314 qapi_event_send_command_dropped(id,
4315 COMMAND_DROP_REASON_QUEUE_FULL,
4317 qmp_request_free(req_obj);
4323 * Put the request to the end of queue so that requests will be
4324 * handled in time order. Ownership for req_obj, req, id,
4325 * etc. will be delivered to the handler side.
4327 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4328 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4330 /* Kick the dispatcher routine */
4331 qemu_bh_schedule(qmp_dispatcher_bh);
4334 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4336 Monitor *mon = opaque;
4338 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4341 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4343 Monitor *old_mon = cur_mon;
4349 for (i = 0; i < size; i++)
4350 readline_handle_byte(cur_mon->rs, buf[i]);
4352 if (size == 0 || buf[size - 1] != 0)
4353 monitor_printf(cur_mon, "corrupted command\n");
4355 handle_hmp_command(cur_mon, (char *)buf);
4361 static void monitor_command_cb(void *opaque, const char *cmdline,
4362 void *readline_opaque)
4364 Monitor *mon = opaque;
4366 monitor_suspend(mon);
4367 handle_hmp_command(mon, cmdline);
4368 monitor_resume(mon);
4371 int monitor_suspend(Monitor *mon)
4373 if (monitor_is_hmp_non_interactive(mon)) {
4377 atomic_inc(&mon->suspend_cnt);
4379 if (monitor_is_qmp(mon)) {
4381 * Kick I/O thread to make sure this takes effect. It'll be
4382 * evaluated again in prepare() of the watch object.
4384 aio_notify(iothread_get_aio_context(mon_iothread));
4387 trace_monitor_suspend(mon, 1);
4391 void monitor_resume(Monitor *mon)
4393 if (monitor_is_hmp_non_interactive(mon)) {
4397 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4398 if (monitor_is_qmp(mon)) {
4400 * For QMP monitors that are running in the I/O thread,
4401 * let's kick the thread in case it's sleeping.
4403 if (mon->use_io_thread) {
4404 aio_notify(iothread_get_aio_context(mon_iothread));
4408 readline_show_prompt(mon->rs);
4411 trace_monitor_suspend(mon, -1);
4414 static QDict *qmp_greeting(Monitor *mon)
4416 QList *cap_list = qlist_new();
4417 QObject *ver = NULL;
4420 qmp_marshal_query_version(NULL, &ver, NULL);
4422 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4423 if (mon->qmp.capab_offered[cap]) {
4424 qlist_append_str(cap_list, QMPCapability_str(cap));
4428 return qdict_from_jsonf_nofail(
4429 "{'QMP': {'version': %p, 'capabilities': %p}}",
4433 static void monitor_qmp_event(void *opaque, int event)
4436 Monitor *mon = opaque;
4439 case CHR_EVENT_OPENED:
4440 mon->qmp.commands = &qmp_cap_negotiation_commands;
4441 monitor_qmp_caps_reset(mon);
4442 data = qmp_greeting(mon);
4443 qmp_queue_response(mon, data);
4444 qobject_unref(data);
4447 case CHR_EVENT_CLOSED:
4449 * Note: this is only useful when the output of the chardev
4450 * backend is still open. For example, when the backend is
4451 * stdio, it's possible that stdout is still open when stdin
4454 monitor_qmp_response_flush(mon);
4455 monitor_qmp_cleanup_queues(mon);
4456 json_message_parser_destroy(&mon->qmp.parser);
4457 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4459 monitor_fdsets_cleanup();
4464 static void monitor_event(void *opaque, int event)
4466 Monitor *mon = opaque;
4469 case CHR_EVENT_MUX_IN:
4470 qemu_mutex_lock(&mon->mon_lock);
4472 qemu_mutex_unlock(&mon->mon_lock);
4473 if (mon->reset_seen) {
4474 readline_restart(mon->rs);
4475 monitor_resume(mon);
4478 atomic_mb_set(&mon->suspend_cnt, 0);
4482 case CHR_EVENT_MUX_OUT:
4483 if (mon->reset_seen) {
4484 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4485 monitor_printf(mon, "\n");
4488 monitor_suspend(mon);
4490 atomic_inc(&mon->suspend_cnt);
4492 qemu_mutex_lock(&mon->mon_lock);
4494 qemu_mutex_unlock(&mon->mon_lock);
4497 case CHR_EVENT_OPENED:
4498 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4499 "information\n", QEMU_VERSION);
4500 if (!mon->mux_out) {
4501 readline_restart(mon->rs);
4502 readline_show_prompt(mon->rs);
4504 mon->reset_seen = 1;
4508 case CHR_EVENT_CLOSED:
4510 monitor_fdsets_cleanup();
4516 compare_mon_cmd(const void *a, const void *b)
4518 return strcmp(((const mon_cmd_t *)a)->name,
4519 ((const mon_cmd_t *)b)->name);
4522 static void sortcmdlist(void)
4525 int elem_size = sizeof(mon_cmd_t);
4527 array_num = sizeof(mon_cmds)/elem_size-1;
4528 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4530 array_num = sizeof(info_cmds)/elem_size-1;
4531 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4534 static GMainContext *monitor_get_io_context(void)
4536 return iothread_get_g_main_context(mon_iothread);
4539 static AioContext *monitor_get_aio_context(void)
4541 return iothread_get_aio_context(mon_iothread);
4544 static void monitor_iothread_init(void)
4546 mon_iothread = iothread_create("mon_iothread", &error_abort);
4549 * The dispatcher BH must run in the main loop thread, since we
4550 * have commands assuming that context. It would be nice to get
4551 * rid of those assumptions.
4553 qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4554 monitor_qmp_bh_dispatcher,
4558 * The responder BH must be run in the monitor I/O thread, so that
4559 * monitors that are using the I/O thread have their output
4560 * written by the I/O thread.
4562 qmp_respond_bh = aio_bh_new(monitor_get_aio_context(),
4563 monitor_qmp_bh_responder,
4567 void monitor_init_globals(void)
4569 monitor_init_qmp_commands();
4570 monitor_qapi_event_init();
4572 qemu_mutex_init(&monitor_lock);
4573 qemu_mutex_init(&mon_fdsets_lock);
4574 monitor_iothread_init();
4577 /* These functions just adapt the readline interface in a typesafe way. We
4578 * could cast function pointers but that discards compiler checks.
4580 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4581 const char *fmt, ...)
4585 monitor_vprintf(opaque, fmt, ap);
4589 static void monitor_readline_flush(void *opaque)
4591 monitor_flush(opaque);
4595 * Print to current monitor if we have one, else to stderr.
4596 * TODO should return int, so callers can calculate width, but that
4597 * requires surgery to monitor_vprintf(). Left for another day.
4599 void error_vprintf(const char *fmt, va_list ap)
4601 if (cur_mon && !monitor_cur_is_qmp()) {
4602 monitor_vprintf(cur_mon, fmt, ap);
4604 vfprintf(stderr, fmt, ap);
4608 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4610 if (cur_mon && !monitor_cur_is_qmp()) {
4611 monitor_vprintf(cur_mon, fmt, ap);
4612 } else if (!cur_mon) {
4613 vfprintf(stderr, fmt, ap);
4617 static void monitor_list_append(Monitor *mon)
4619 qemu_mutex_lock(&monitor_lock);
4620 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4621 qemu_mutex_unlock(&monitor_lock);
4624 static void monitor_qmp_setup_handlers_bh(void *opaque)
4626 Monitor *mon = opaque;
4627 GMainContext *context;
4629 if (mon->use_io_thread) {
4630 /* Use @mon_iothread context */
4631 context = monitor_get_io_context();
4634 /* Use default main loop context */
4638 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4639 monitor_qmp_event, NULL, mon, context, true);
4640 monitor_list_append(mon);
4643 void monitor_init(Chardev *chr, int flags)
4645 Monitor *mon = g_malloc(sizeof(*mon));
4646 bool use_readline = flags & MONITOR_USE_READLINE;
4647 bool use_oob = flags & MONITOR_USE_OOB;
4650 if (CHARDEV_IS_MUX(chr)) {
4651 error_report("Monitor out-of-band is not supported with "
4652 "MUX typed chardev backend");
4656 error_report("Monitor out-of-band is only supported by QMP");
4661 monitor_data_init(mon, false, use_oob);
4663 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4666 mon->rs = readline_init(monitor_readline_printf,
4667 monitor_readline_flush,
4669 monitor_find_completion);
4670 monitor_read_command(mon, 0);
4673 if (monitor_is_qmp(mon)) {
4674 qemu_chr_fe_set_echo(&mon->chr, true);
4675 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4676 if (mon->use_io_thread) {
4678 * Make sure the old iowatch is gone. It's possible when
4679 * e.g. the chardev is in client mode, with wait=on.
4681 remove_fd_in_watch(chr);
4683 * We can't call qemu_chr_fe_set_handlers() directly here
4684 * since chardev might be running in the monitor I/O
4685 * thread. Schedule a bottom half.
4687 aio_bh_schedule_oneshot(monitor_get_aio_context(),
4688 monitor_qmp_setup_handlers_bh, mon);
4689 /* The bottom half will add @mon to @mon_list */
4692 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4693 monitor_qmp_read, monitor_qmp_event,
4694 NULL, mon, NULL, true);
4697 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4698 monitor_event, NULL, mon, NULL, true);
4701 monitor_list_append(mon);
4704 void monitor_cleanup(void)
4706 Monitor *mon, *next;
4709 * We need to explicitly stop the I/O thread (but not destroy it),
4710 * clean up the monitor resources, then destroy the I/O thread since
4711 * we need to unregister from chardev below in
4712 * monitor_data_destroy(), and chardev is not thread-safe yet
4714 iothread_stop(mon_iothread);
4717 * Flush all response queues. Note that even after this flush,
4718 * data may remain in output buffers.
4720 monitor_qmp_bh_responder(NULL);
4722 /* Flush output buffers and destroy monitors */
4723 qemu_mutex_lock(&monitor_lock);
4724 QTAILQ_FOREACH_SAFE(mon, &mon_list, entry, next) {
4725 QTAILQ_REMOVE(&mon_list, mon, entry);
4727 monitor_data_destroy(mon);
4730 qemu_mutex_unlock(&monitor_lock);
4732 /* QEMUBHs needs to be deleted before destroying the I/O thread */
4733 qemu_bh_delete(qmp_dispatcher_bh);
4734 qmp_dispatcher_bh = NULL;
4735 qemu_bh_delete(qmp_respond_bh);
4736 qmp_respond_bh = NULL;
4738 iothread_destroy(mon_iothread);
4739 mon_iothread = NULL;
4742 QemuOptsList qemu_mon_opts = {
4744 .implied_opt_name = "chardev",
4745 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4749 .type = QEMU_OPT_STRING,
4752 .type = QEMU_OPT_STRING,
4755 .type = QEMU_OPT_BOOL,
4758 .type = QEMU_OPT_BOOL,
4760 { /* end of list */ }
4765 void qmp_rtc_reset_reinjection(Error **errp)
4767 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4770 SevInfo *qmp_query_sev(Error **errp)
4772 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev");
4776 SevLaunchMeasureInfo *qmp_query_sev_launch_measure(Error **errp)
4778 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-launch-measure");
4782 SevCapability *qmp_query_sev_capabilities(Error **errp)
4784 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-capabilities");
4789 #ifndef TARGET_S390X
4790 void qmp_dump_skeys(const char *filename, Error **errp)
4792 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4797 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4799 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4804 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4806 MachineState *ms = MACHINE(qdev_get_machine());
4807 MachineClass *mc = MACHINE_GET_CLASS(ms);
4809 if (!mc->has_hotpluggable_cpus) {
4810 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4814 return machine_query_hotpluggable_cpus(ms);