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"
29 #include "monitor/qdev.h"
31 #include "hw/pci/pci.h"
32 #include "sysemu/watchdog.h"
33 #include "hw/loader.h"
34 #include "exec/gdbstub.h"
36 #include "net/slirp.h"
37 #include "chardev/char-fe.h"
38 #include "chardev/char-io.h"
39 #include "chardev/char-mux.h"
40 #include "ui/qemu-spice.h"
41 #include "sysemu/numa.h"
42 #include "monitor/monitor.h"
43 #include "qemu/config-file.h"
44 #include "qemu/readline.h"
45 #include "ui/console.h"
47 #include "sysemu/block-backend.h"
48 #include "audio/audio.h"
49 #include "disas/disas.h"
50 #include "sysemu/balloon.h"
51 #include "qemu/timer.h"
52 #include "sysemu/hw_accel.h"
54 #include "sysemu/tpm.h"
55 #include "qapi/qmp/qdict.h"
56 #include "qapi/qmp/qerror.h"
57 #include "qapi/qmp/qnum.h"
58 #include "qapi/qmp/qstring.h"
59 #include "qapi/qmp/qjson.h"
60 #include "qapi/qmp/json-streamer.h"
61 #include "qapi/qmp/json-parser.h"
62 #include "qapi/qmp/qlist.h"
63 #include "qom/object_interfaces.h"
64 #include "trace-root.h"
65 #include "trace/control.h"
66 #include "monitor/hmp-target.h"
67 #ifdef CONFIG_TRACE_SIMPLE
68 #include "trace/simple.h"
70 #include "exec/memory.h"
71 #include "exec/exec-all.h"
73 #include "qemu/option.h"
75 #include "qemu/thread.h"
76 #include "block/qapi.h"
77 #include "qapi/qapi-commands.h"
78 #include "qapi/qapi-events.h"
79 #include "qapi/error.h"
80 #include "qapi/qmp-event.h"
81 #include "qapi/qapi-introspect.h"
82 #include "sysemu/qtest.h"
83 #include "sysemu/cpus.h"
84 #include "sysemu/iothread.h"
85 #include "qemu/cutils.h"
87 #if defined(TARGET_S390X)
88 #include "hw/s390x/storage-keys.h"
89 #include "hw/s390x/storage-attributes.h"
96 * 'B' block device name
97 * 's' string (accept optional quote)
98 * 'S' it just appends the rest of the string (accept optional quote)
99 * 'O' option string of the form NAME=VALUE,...
100 * parsed according to QemuOptsList given by its name
101 * Example: 'device:O' uses qemu_device_opts.
102 * Restriction: only lists with empty desc are supported
103 * TODO lift the restriction
105 * 'l' target long (32 or 64 bit)
106 * 'M' Non-negative target long (32 or 64 bit), in user mode the
107 * value is multiplied by 2^20 (think Mebibyte)
108 * 'o' octets (aka bytes)
109 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
110 * K, k suffix, which multiplies the value by 2^60 for suffixes E
111 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
112 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
114 * user mode accepts an optional ms, us, ns suffix,
115 * which divides the value by 1e3, 1e6, 1e9, respectively
116 * '/' optional gdb-like print format (like "/10x")
118 * '?' optional type (for all types, except '/')
119 * '.' other form of optional type (for 'i' and 'l')
121 * user mode accepts "on" or "off"
122 * '-' optional parameter (eg. '-f')
126 typedef struct mon_cmd_t {
128 const char *args_type;
131 const char *flags; /* p=preconfig */
132 void (*cmd)(Monitor *mon, const QDict *qdict);
133 /* @sub_table is a list of 2nd level of commands. If it does not exist,
134 * cmd should be used. If it exists, sub_table[?].cmd should be
135 * used, and cmd of 1st level plays the role of help function.
137 struct mon_cmd_t *sub_table;
138 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
141 /* file descriptors passed via SCM_RIGHTS */
142 typedef struct mon_fd_t mon_fd_t;
146 QLIST_ENTRY(mon_fd_t) next;
149 /* file descriptor associated with a file descriptor set */
150 typedef struct MonFdsetFd MonFdsetFd;
155 QLIST_ENTRY(MonFdsetFd) next;
158 /* file descriptor set containing fds passed via SCM_RIGHTS */
159 typedef struct MonFdset MonFdset;
162 QLIST_HEAD(, MonFdsetFd) fds;
163 QLIST_HEAD(, MonFdsetFd) dup_fds;
164 QLIST_ENTRY(MonFdset) next;
168 JSONMessageParser parser;
170 * When a client connects, we're in capabilities negotiation mode.
171 * When command qmp_capabilities succeeds, we go into command
174 QmpCommandList *commands;
175 bool qmp_caps[QMP_CAPABILITY__MAX];
177 * Protects qmp request/response queue. Please take monitor_lock
178 * first when used together.
180 QemuMutex qmp_queue_lock;
181 /* Input queue that holds all the parsed QMP requests */
182 GQueue *qmp_requests;
183 /* Output queue contains all the QMP responses in order */
184 GQueue *qmp_responses;
188 * To prevent flooding clients, events can be throttled. The
189 * throttling is calculated globally, rather than per-Monitor
192 typedef struct MonitorQAPIEventState {
193 QAPIEvent event; /* Throttling state for this event type and... */
194 QDict *data; /* ... data, see qapi_event_throttle_equal() */
195 QEMUTimer *timer; /* Timer for handling delayed events */
196 QDict *qdict; /* Delayed event (if any) */
197 } MonitorQAPIEventState;
200 int64_t rate; /* Minimum time (in ns) between two events */
201 } MonitorQAPIEventConf;
207 int suspend_cnt; /* Needs to be accessed atomically */
212 * State used only in the thread "owning" the monitor.
213 * If @use_io_thr, this is mon_global.mon_iothread.
214 * Else, it's the main thread.
215 * These members can be safely accessed without locks.
221 BlockCompletionFunc *password_completion_cb;
222 void *password_opaque;
223 mon_cmd_t *cmd_table;
224 QTAILQ_ENTRY(Monitor) entry;
227 * The per-monitor lock. We can't access guest memory when holding
233 * Fields that are protected by the per-monitor lock.
235 QLIST_HEAD(, mon_fd_t) fds;
238 /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
242 /* Let's add monitor global variables to this struct. */
244 IOThread *mon_iothread;
245 /* Bottom half to dispatch the requests received from IO thread */
246 QEMUBH *qmp_dispatcher_bh;
247 /* Bottom half to deliver the responses back to clients */
248 QEMUBH *qmp_respond_bh;
252 /* Owner of the request */
254 /* "id" field of the request */
256 /* Request object to be handled */
259 * Whether we need to resume the monitor afterward. This flag is
260 * used to emulate the old QMP server behavior that the current
261 * command must be completed before execution of the next one.
265 typedef struct QMPRequest QMPRequest;
267 /* QMP checker flags */
268 #define QMP_ACCEPT_UNKNOWNS 1
270 /* Protects mon_list, monitor_qapi_event_state. */
271 static QemuMutex monitor_lock;
272 static GHashTable *monitor_qapi_event_state;
273 static QTAILQ_HEAD(mon_list, Monitor) mon_list;
275 /* Protects mon_fdsets */
276 static QemuMutex mon_fdsets_lock;
277 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
279 static int mon_refcount;
281 static mon_cmd_t mon_cmds[];
282 static mon_cmd_t info_cmds[];
284 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
288 static void monitor_command_cb(void *opaque, const char *cmdline,
289 void *readline_opaque);
292 * Is @mon a QMP monitor?
294 static inline bool monitor_is_qmp(const Monitor *mon)
296 return (mon->flags & MONITOR_USE_CONTROL);
300 * Whether @mon is using readline? Note: not all HMP monitors use
301 * readline, e.g., gdbserver has a non-interactive HMP monitor, so
302 * readline is not used there.
304 static inline bool monitor_uses_readline(const Monitor *mon)
306 return mon->flags & MONITOR_USE_READLINE;
309 static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
311 return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
315 * Return the clock to use for recording an event's time.
316 * Beware: result is invalid before configure_accelerator().
318 static inline QEMUClockType monitor_get_event_clock(void)
321 * This allows us to perform tests on the monitor queues to verify
322 * that the rate limits are enforced.
324 return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
328 * Is the current monitor, if any, a QMP monitor?
330 bool monitor_cur_is_qmp(void)
332 return cur_mon && monitor_is_qmp(cur_mon);
335 void monitor_read_command(Monitor *mon, int show_prompt)
340 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
342 readline_show_prompt(mon->rs);
345 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
349 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
350 /* prompt is printed on return from the command handler */
353 monitor_printf(mon, "terminal does not support password prompting\n");
358 static void qmp_request_free(QMPRequest *req)
360 qobject_unref(req->id);
361 qobject_unref(req->req);
365 /* Must with the mon->qmp.qmp_queue_lock held */
366 static void monitor_qmp_cleanup_req_queue_locked(Monitor *mon)
368 while (!g_queue_is_empty(mon->qmp.qmp_requests)) {
369 qmp_request_free(g_queue_pop_head(mon->qmp.qmp_requests));
373 /* Must with the mon->qmp.qmp_queue_lock held */
374 static void monitor_qmp_cleanup_resp_queue_locked(Monitor *mon)
376 while (!g_queue_is_empty(mon->qmp.qmp_responses)) {
377 qobject_unref((QObject *)g_queue_pop_head(mon->qmp.qmp_responses));
381 static void monitor_qmp_cleanup_queues(Monitor *mon)
383 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
384 monitor_qmp_cleanup_req_queue_locked(mon);
385 monitor_qmp_cleanup_resp_queue_locked(mon);
386 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
390 static void monitor_flush_locked(Monitor *mon);
392 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
395 Monitor *mon = opaque;
397 qemu_mutex_lock(&mon->mon_lock);
399 monitor_flush_locked(mon);
400 qemu_mutex_unlock(&mon->mon_lock);
404 /* Called with mon->mon_lock held. */
405 static void monitor_flush_locked(Monitor *mon)
411 if (mon->skip_flush) {
415 buf = qstring_get_str(mon->outbuf);
416 len = qstring_get_length(mon->outbuf);
418 if (len && !mon->mux_out) {
419 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
420 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
421 /* all flushed or error */
422 qobject_unref(mon->outbuf);
423 mon->outbuf = qstring_new();
428 QString *tmp = qstring_from_str(buf + rc);
429 qobject_unref(mon->outbuf);
432 if (mon->out_watch == 0) {
434 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
435 monitor_unblocked, mon);
440 void monitor_flush(Monitor *mon)
442 qemu_mutex_lock(&mon->mon_lock);
443 monitor_flush_locked(mon);
444 qemu_mutex_unlock(&mon->mon_lock);
447 /* flush at every end of line */
448 static void monitor_puts(Monitor *mon, const char *str)
452 qemu_mutex_lock(&mon->mon_lock);
458 qstring_append_chr(mon->outbuf, '\r');
460 qstring_append_chr(mon->outbuf, c);
462 monitor_flush_locked(mon);
465 qemu_mutex_unlock(&mon->mon_lock);
468 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
475 if (monitor_is_qmp(mon)) {
479 buf = g_strdup_vprintf(fmt, ap);
480 monitor_puts(mon, buf);
484 void monitor_printf(Monitor *mon, const char *fmt, ...)
488 monitor_vprintf(mon, fmt, ap);
492 int monitor_fprintf(FILE *stream, const char *fmt, ...)
496 monitor_vprintf((Monitor *)stream, fmt, ap);
501 static void monitor_json_emitter_raw(Monitor *mon,
506 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
507 qobject_to_json(data);
508 assert(json != NULL);
510 qstring_append_chr(json, '\n');
511 monitor_puts(mon, qstring_get_str(json));
516 static void monitor_json_emitter(Monitor *mon, QObject *data)
518 if (mon->use_io_thr) {
520 * If using IO thread, we need to queue the item so that IO
521 * thread will do the rest for us. Take refcount so that
522 * caller won't free the data (which will be finally freed in
525 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
526 g_queue_push_tail(mon->qmp.qmp_responses, qobject_ref(data));
527 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
528 qemu_bh_schedule(mon_global.qmp_respond_bh);
531 * If not using monitor IO thread, then we are in main thread.
532 * Do the emission right away.
534 monitor_json_emitter_raw(mon, data);
542 typedef struct QMPResponse QMPResponse;
544 static QObject *monitor_qmp_response_pop_one(Monitor *mon)
548 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
549 data = g_queue_pop_head(mon->qmp.qmp_responses);
550 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
555 static void monitor_qmp_response_flush(Monitor *mon)
559 while ((data = monitor_qmp_response_pop_one(mon))) {
560 monitor_json_emitter_raw(mon, data);
566 * Pop a QMPResponse from any monitor's response queue into @response.
567 * Return false if all the queues are empty; else true.
569 static bool monitor_qmp_response_pop_any(QMPResponse *response)
572 QObject *data = NULL;
574 qemu_mutex_lock(&monitor_lock);
575 QTAILQ_FOREACH(mon, &mon_list, entry) {
576 data = monitor_qmp_response_pop_one(mon);
579 response->data = data;
583 qemu_mutex_unlock(&monitor_lock);
587 static void monitor_qmp_bh_responder(void *opaque)
589 QMPResponse response;
591 while (monitor_qmp_response_pop_any(&response)) {
592 monitor_json_emitter_raw(response.mon, response.data);
593 qobject_unref(response.data);
597 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
598 /* Limit guest-triggerable events to 1 per second */
599 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
600 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
601 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
602 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
603 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
604 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
608 * Emits the event to every monitor instance, @event is only used for trace
609 * Called with monitor_lock held.
611 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
615 trace_monitor_protocol_event_emit(event, qdict);
616 QTAILQ_FOREACH(mon, &mon_list, entry) {
617 if (monitor_is_qmp(mon)
618 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
619 monitor_json_emitter(mon, QOBJECT(qdict));
624 static void monitor_qapi_event_handler(void *opaque);
627 * Queue a new event for emission to Monitor instances,
628 * applying any rate limiting if required.
631 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
633 MonitorQAPIEventConf *evconf;
634 MonitorQAPIEventState *evstate;
636 assert(event < QAPI_EVENT__MAX);
637 evconf = &monitor_qapi_event_conf[event];
638 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
640 qemu_mutex_lock(&monitor_lock);
643 /* Unthrottled event */
644 monitor_qapi_event_emit(event, qdict);
646 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
647 MonitorQAPIEventState key = { .event = event, .data = data };
649 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
650 assert(!evstate || timer_pending(evstate->timer));
654 * Timer is pending for (at least) evconf->rate ns after
655 * last send. Store event for sending when timer fires,
656 * replacing a prior stored event if any.
658 qobject_unref(evstate->qdict);
659 evstate->qdict = qobject_ref(qdict);
662 * Last send was (at least) evconf->rate ns ago.
663 * Send immediately, and arm the timer to call
664 * monitor_qapi_event_handler() in evconf->rate ns. Any
665 * events arriving before then will be delayed until then.
667 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
669 monitor_qapi_event_emit(event, qdict);
671 evstate = g_new(MonitorQAPIEventState, 1);
672 evstate->event = event;
673 evstate->data = qobject_ref(data);
674 evstate->qdict = NULL;
675 evstate->timer = timer_new_ns(monitor_get_event_clock(),
676 monitor_qapi_event_handler,
678 g_hash_table_add(monitor_qapi_event_state, evstate);
679 timer_mod_ns(evstate->timer, now + evconf->rate);
683 qemu_mutex_unlock(&monitor_lock);
687 * This function runs evconf->rate ns after sending a throttled
689 * If another event has since been stored, send it.
691 static void monitor_qapi_event_handler(void *opaque)
693 MonitorQAPIEventState *evstate = opaque;
694 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
696 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
697 qemu_mutex_lock(&monitor_lock);
699 if (evstate->qdict) {
700 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
702 monitor_qapi_event_emit(evstate->event, evstate->qdict);
703 qobject_unref(evstate->qdict);
704 evstate->qdict = NULL;
705 timer_mod_ns(evstate->timer, now + evconf->rate);
707 g_hash_table_remove(monitor_qapi_event_state, evstate);
708 qobject_unref(evstate->data);
709 timer_free(evstate->timer);
713 qemu_mutex_unlock(&monitor_lock);
716 static unsigned int qapi_event_throttle_hash(const void *key)
718 const MonitorQAPIEventState *evstate = key;
719 unsigned int hash = evstate->event * 255;
721 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
722 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
725 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
726 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
732 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
734 const MonitorQAPIEventState *eva = a;
735 const MonitorQAPIEventState *evb = b;
737 if (eva->event != evb->event) {
741 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
742 return !strcmp(qdict_get_str(eva->data, "id"),
743 qdict_get_str(evb->data, "id"));
746 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
747 return !strcmp(qdict_get_str(eva->data, "node-name"),
748 qdict_get_str(evb->data, "node-name"));
754 static void monitor_qapi_event_init(void)
756 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
757 qapi_event_throttle_equal);
758 qmp_event_set_func_emit(monitor_qapi_event_queue);
761 static void handle_hmp_command(Monitor *mon, const char *cmdline);
763 static void monitor_data_init(Monitor *mon, bool skip_flush,
766 memset(mon, 0, sizeof(Monitor));
767 qemu_mutex_init(&mon->mon_lock);
768 qemu_mutex_init(&mon->qmp.qmp_queue_lock);
769 mon->outbuf = qstring_new();
770 /* Use *mon_cmds by default. */
771 mon->cmd_table = mon_cmds;
772 mon->skip_flush = skip_flush;
773 mon->use_io_thr = use_io_thr;
774 mon->qmp.qmp_requests = g_queue_new();
775 mon->qmp.qmp_responses = g_queue_new();
778 static void monitor_data_destroy(Monitor *mon)
780 g_free(mon->mon_cpu_path);
781 qemu_chr_fe_deinit(&mon->chr, false);
782 if (monitor_is_qmp(mon)) {
783 json_message_parser_destroy(&mon->qmp.parser);
785 readline_free(mon->rs);
786 qobject_unref(mon->outbuf);
787 qemu_mutex_destroy(&mon->mon_lock);
788 qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
789 monitor_qmp_cleanup_req_queue_locked(mon);
790 monitor_qmp_cleanup_resp_queue_locked(mon);
791 g_queue_free(mon->qmp.qmp_requests);
792 g_queue_free(mon->qmp.qmp_responses);
795 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
796 int64_t cpu_index, Error **errp)
799 Monitor *old_mon, hmp;
801 monitor_data_init(&hmp, true, false);
807 int ret = monitor_set_cpu(cpu_index);
810 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
816 handle_hmp_command(&hmp, command_line);
819 qemu_mutex_lock(&hmp.mon_lock);
820 if (qstring_get_length(hmp.outbuf) > 0) {
821 output = g_strdup(qstring_get_str(hmp.outbuf));
823 output = g_strdup("");
825 qemu_mutex_unlock(&hmp.mon_lock);
828 monitor_data_destroy(&hmp);
832 static int compare_cmd(const char *name, const char *list)
834 const char *p, *pstart;
840 p = qemu_strchrnul(p, '|');
841 if ((p - pstart) == len && !memcmp(pstart, name, len))
850 static int get_str(char *buf, int buf_size, const char **pp)
858 while (qemu_isspace(*p)) {
869 while (*p != '\0' && *p != '\"') {
885 printf("unsupported escape code: '\\%c'\n", c);
888 if ((q - buf) < buf_size - 1) {
892 if ((q - buf) < buf_size - 1) {
899 printf("unterminated string\n");
904 while (*p != '\0' && !qemu_isspace(*p)) {
905 if ((q - buf) < buf_size - 1) {
918 static void free_cmdline_args(char **args, int nb_args)
922 assert(nb_args <= MAX_ARGS);
924 for (i = 0; i < nb_args; i++) {
931 * Parse the command line to get valid args.
932 * @cmdline: command line to be parsed.
933 * @pnb_args: location to store the number of args, must NOT be NULL.
934 * @args: location to store the args, which should be freed by caller, must
937 * Returns 0 on success, negative on failure.
939 * NOTE: this parser is an approximate form of the real command parser. Number
940 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
941 * return with failure.
943 static int parse_cmdline(const char *cmdline,
944 int *pnb_args, char **args)
953 while (qemu_isspace(*p)) {
959 if (nb_args >= MAX_ARGS) {
962 ret = get_str(buf, sizeof(buf), &p);
966 args[nb_args] = g_strdup(buf);
973 free_cmdline_args(args, nb_args);
978 * Returns true if the command can be executed in preconfig mode
979 * i.e. it has the 'p' flag.
981 static bool cmd_can_preconfig(const mon_cmd_t *cmd)
987 return strchr(cmd->flags, 'p');
990 static void help_cmd_dump_one(Monitor *mon,
991 const mon_cmd_t *cmd,
997 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
1001 for (i = 0; i < prefix_args_nb; i++) {
1002 monitor_printf(mon, "%s ", prefix_args[i]);
1004 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
1007 /* @args[@arg_index] is the valid command need to find in @cmds */
1008 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
1009 char **args, int nb_args, int arg_index)
1011 const mon_cmd_t *cmd;
1013 /* No valid arg need to compare with, dump all in *cmds */
1014 if (arg_index >= nb_args) {
1015 for (cmd = cmds; cmd->name != NULL; cmd++) {
1016 help_cmd_dump_one(mon, cmd, args, arg_index);
1021 /* Find one entry to dump */
1022 for (cmd = cmds; cmd->name != NULL; cmd++) {
1023 if (compare_cmd(args[arg_index], cmd->name) &&
1024 ((!runstate_check(RUN_STATE_PRECONFIG) ||
1025 cmd_can_preconfig(cmd)))) {
1026 if (cmd->sub_table) {
1027 /* continue with next arg */
1028 help_cmd_dump(mon, cmd->sub_table,
1029 args, nb_args, arg_index + 1);
1031 help_cmd_dump_one(mon, cmd, args, arg_index);
1038 static void help_cmd(Monitor *mon, const char *name)
1040 char *args[MAX_ARGS];
1043 /* 1. parse user input */
1045 /* special case for log, directly dump and return */
1046 if (!strcmp(name, "log")) {
1047 const QEMULogItem *item;
1048 monitor_printf(mon, "Log items (comma separated):\n");
1049 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
1050 for (item = qemu_log_items; item->mask != 0; item++) {
1051 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
1056 if (parse_cmdline(name, &nb_args, args) < 0) {
1061 /* 2. dump the contents according to parsed args */
1062 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
1064 free_cmdline_args(args, nb_args);
1067 static void do_help_cmd(Monitor *mon, const QDict *qdict)
1069 help_cmd(mon, qdict_get_try_str(qdict, "name"));
1072 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
1074 const char *tp_name = qdict_get_str(qdict, "name");
1075 bool new_state = qdict_get_bool(qdict, "option");
1076 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1077 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1078 Error *local_err = NULL;
1081 monitor_printf(mon, "argument vcpu must be positive");
1085 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
1087 error_report_err(local_err);
1091 #ifdef CONFIG_TRACE_SIMPLE
1092 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
1094 const char *op = qdict_get_try_str(qdict, "op");
1095 const char *arg = qdict_get_try_str(qdict, "arg");
1098 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
1099 } else if (!strcmp(op, "on")) {
1100 st_set_trace_file_enabled(true);
1101 } else if (!strcmp(op, "off")) {
1102 st_set_trace_file_enabled(false);
1103 } else if (!strcmp(op, "flush")) {
1104 st_flush_trace_buffer();
1105 } else if (!strcmp(op, "set")) {
1107 st_set_trace_file(arg);
1110 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
1111 help_cmd(mon, "trace-file");
1116 static void hmp_info_help(Monitor *mon, const QDict *qdict)
1118 help_cmd(mon, "info");
1121 static void query_commands_cb(QmpCommand *cmd, void *opaque)
1123 CommandInfoList *info, **list = opaque;
1125 if (!cmd->enabled) {
1129 info = g_malloc0(sizeof(*info));
1130 info->value = g_malloc0(sizeof(*info->value));
1131 info->value->name = g_strdup(cmd->name);
1136 CommandInfoList *qmp_query_commands(Error **errp)
1138 CommandInfoList *list = NULL;
1140 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
1145 EventInfoList *qmp_query_events(Error **errp)
1147 EventInfoList *info, *ev_list = NULL;
1150 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
1151 const char *event_name = QAPIEvent_str(e);
1152 assert(event_name != NULL);
1153 info = g_malloc0(sizeof(*info));
1154 info->value = g_malloc0(sizeof(*info->value));
1155 info->value->name = g_strdup(event_name);
1157 info->next = ev_list;
1165 * Minor hack: generated marshalling suppressed for this command
1166 * ('gen': false in the schema) so we can parse the JSON string
1167 * directly into QObject instead of first parsing it with
1168 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
1169 * to QObject with generated output marshallers, every time. Instead,
1170 * we do it in test-qobject-input-visitor.c, just to make sure
1171 * qapi-gen.py's output actually conforms to the schema.
1173 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
1176 *ret_data = qobject_from_qlit(&qmp_schema_qlit);
1180 * We used to define commands in qmp-commands.hx in addition to the
1181 * QAPI schema. This permitted defining some of them only in certain
1182 * configurations. query-commands has always reflected that (good,
1183 * because it lets QMP clients figure out what's actually available),
1184 * while query-qmp-schema never did (not so good). This function is a
1185 * hack to keep the configuration-specific commands defined exactly as
1186 * before, even though qmp-commands.hx is gone.
1188 * FIXME Educate the QAPI schema on configuration-specific commands,
1189 * and drop this hack.
1191 static void qmp_unregister_commands_hack(void)
1193 #ifndef CONFIG_SPICE
1194 qmp_unregister_command(&qmp_commands, "query-spice");
1196 #ifndef CONFIG_REPLICATION
1197 qmp_unregister_command(&qmp_commands, "xen-set-replication");
1198 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
1199 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
1202 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
1203 qmp_unregister_command(&qmp_commands, "query-sev");
1204 qmp_unregister_command(&qmp_commands, "query-sev-launch-measure");
1205 qmp_unregister_command(&qmp_commands, "query-sev-capabilities");
1207 #ifndef TARGET_S390X
1208 qmp_unregister_command(&qmp_commands, "dump-skeys");
1211 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
1213 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
1214 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
1216 #if !defined(TARGET_S390X)
1217 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
1218 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
1220 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
1221 && !defined(TARGET_S390X)
1222 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1226 static void monitor_init_qmp_commands(void)
1229 * Two command lists:
1230 * - qmp_commands contains all QMP commands
1231 * - qmp_cap_negotiation_commands contains just
1232 * "qmp_capabilities", to enforce capability negotiation
1235 qmp_init_marshal(&qmp_commands);
1237 qmp_register_command(&qmp_commands, "query-qmp-schema",
1238 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
1239 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1241 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1244 qmp_unregister_commands_hack();
1246 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1247 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1248 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
1251 static bool qmp_cap_enabled(Monitor *mon, QMPCapability cap)
1253 return mon->qmp.qmp_caps[cap];
1256 static bool qmp_oob_enabled(Monitor *mon)
1258 return qmp_cap_enabled(mon, QMP_CAPABILITY_OOB);
1261 static void qmp_caps_check(Monitor *mon, QMPCapabilityList *list,
1264 for (; list; list = list->next) {
1265 assert(list->value < QMP_CAPABILITY__MAX);
1266 switch (list->value) {
1267 case QMP_CAPABILITY_OOB:
1268 if (!mon->use_io_thr) {
1270 * Out-Of-Band only works with monitors that are
1271 * running on dedicated IOThread.
1273 error_setg(errp, "This monitor does not support "
1274 "Out-Of-Band (OOB)");
1284 /* This function should only be called after capabilities are checked. */
1285 static void qmp_caps_apply(Monitor *mon, QMPCapabilityList *list)
1287 for (; list; list = list->next) {
1288 mon->qmp.qmp_caps[list->value] = true;
1293 * Return true if check successful, or false otherwise. When false is
1294 * returned, detailed error will be in errp if provided.
1296 static bool qmp_cmd_oob_check(Monitor *mon, QDict *req, Error **errp)
1298 const char *command;
1301 command = qdict_get_try_str(req, "execute");
1303 error_setg(errp, "Command field 'execute' missing");
1307 cmd = qmp_find_command(mon->qmp.commands, command);
1309 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
1310 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1311 "Expecting capabilities negotiation "
1312 "with 'qmp_capabilities'");
1314 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1315 "The command %s has not been found", command);
1320 if (qmp_is_oob(req)) {
1321 if (!qmp_oob_enabled(mon)) {
1322 error_setg(errp, "Please enable Out-Of-Band first "
1323 "for the session during capabilities negotiation");
1326 if (!(cmd->options & QCO_ALLOW_OOB)) {
1327 error_setg(errp, "The command %s does not support OOB",
1336 void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
1339 Error *local_err = NULL;
1341 if (cur_mon->qmp.commands == &qmp_commands) {
1342 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1343 "Capabilities negotiation is already complete, command "
1348 /* Enable QMP capabilities provided by the client if applicable. */
1350 qmp_caps_check(cur_mon, enable, &local_err);
1353 * Failed check on any of the capabilities will fail the
1354 * entire command (and thus not apply any of the other
1355 * capabilities that were also requested).
1357 error_propagate(errp, local_err);
1360 qmp_caps_apply(cur_mon, enable);
1363 cur_mon->qmp.commands = &qmp_commands;
1366 /* Set the current CPU defined by the user. Callers must hold BQL. */
1367 int monitor_set_cpu(int cpu_index)
1371 cpu = qemu_get_cpu(cpu_index);
1375 g_free(cur_mon->mon_cpu_path);
1376 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1380 /* Callers must hold BQL. */
1381 static CPUState *mon_get_cpu_sync(bool synchronize)
1385 if (cur_mon->mon_cpu_path) {
1386 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1389 g_free(cur_mon->mon_cpu_path);
1390 cur_mon->mon_cpu_path = NULL;
1393 if (!cur_mon->mon_cpu_path) {
1397 monitor_set_cpu(first_cpu->cpu_index);
1401 cpu_synchronize_state(cpu);
1406 CPUState *mon_get_cpu(void)
1408 return mon_get_cpu_sync(true);
1411 CPUArchState *mon_get_cpu_env(void)
1413 CPUState *cs = mon_get_cpu();
1415 return cs ? cs->env_ptr : NULL;
1418 int monitor_get_cpu_index(void)
1420 CPUState *cs = mon_get_cpu_sync(false);
1422 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1425 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1427 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1432 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1433 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1439 monitor_printf(mon, "No CPU available\n");
1443 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1448 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1450 if (!tcg_enabled()) {
1451 error_report("JIT information is only available with accel=tcg");
1455 dump_exec_info((FILE *)mon, monitor_fprintf);
1456 dump_drift_info((FILE *)mon, monitor_fprintf);
1459 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1461 dump_opcount_info((FILE *)mon, monitor_fprintf);
1465 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1474 str = readline_get_history(mon->rs, i);
1477 monitor_printf(mon, "%d: '%s'\n", i, str);
1482 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1484 CPUState *cs = mon_get_cpu();
1487 monitor_printf(mon, "No CPU available\n");
1490 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1493 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1495 const char *name = qdict_get_try_str(qdict, "name");
1496 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1497 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1498 TraceEventInfoList *events;
1499 TraceEventInfoList *elem;
1500 Error *local_err = NULL;
1506 monitor_printf(mon, "argument vcpu must be positive");
1510 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1512 error_report_err(local_err);
1516 for (elem = events; elem != NULL; elem = elem->next) {
1517 monitor_printf(mon, "%s : state %u\n",
1519 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1521 qapi_free_TraceEventInfoList(events);
1524 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1525 bool has_port, int64_t port,
1526 bool has_tls_port, int64_t tls_port,
1527 bool has_cert_subject, const char *cert_subject,
1530 if (strcmp(protocol, "spice") == 0) {
1531 if (!qemu_using_spice(errp)) {
1535 if (!has_port && !has_tls_port) {
1536 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1540 if (qemu_spice_migrate_info(hostname,
1541 has_port ? port : -1,
1542 has_tls_port ? tls_port : -1,
1544 error_setg(errp, QERR_UNDEFINED_ERROR);
1550 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1553 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1557 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1559 error_report_err(err);
1563 static void hmp_log(Monitor *mon, const QDict *qdict)
1566 const char *items = qdict_get_str(qdict, "items");
1568 if (!strcmp(items, "none")) {
1571 mask = qemu_str_to_log_mask(items);
1573 help_cmd(mon, "log");
1580 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1582 const char *option = qdict_get_try_str(qdict, "option");
1583 if (!option || !strcmp(option, "on")) {
1585 } else if (!strcmp(option, "off")) {
1588 monitor_printf(mon, "unexpected option %s\n", option);
1592 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1594 const char *device = qdict_get_try_str(qdict, "device");
1596 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1597 if (gdbserver_start(device) < 0) {
1598 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1600 } else if (strcmp(device, "none") == 0) {
1601 monitor_printf(mon, "Disabled gdbserver\n");
1603 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1608 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1610 const char *action = qdict_get_str(qdict, "action");
1611 if (select_watchdog_action(action) == -1) {
1612 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1616 static void monitor_printc(Monitor *mon, int c)
1618 monitor_printf(mon, "'");
1621 monitor_printf(mon, "\\'");
1624 monitor_printf(mon, "\\\\");
1627 monitor_printf(mon, "\\n");
1630 monitor_printf(mon, "\\r");
1633 if (c >= 32 && c <= 126) {
1634 monitor_printf(mon, "%c", c);
1636 monitor_printf(mon, "\\x%02x", c);
1640 monitor_printf(mon, "'");
1643 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1644 hwaddr addr, int is_physical)
1646 int l, line_size, i, max_digits, len;
1649 CPUState *cs = mon_get_cpu();
1651 if (!cs && (format == 'i' || !is_physical)) {
1652 monitor_printf(mon, "Can not dump without CPU\n");
1656 if (format == 'i') {
1657 monitor_disas(mon, cs, addr, count, is_physical);
1661 len = wsize * count;
1670 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1674 max_digits = (wsize * 8) / 4;
1678 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1687 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1689 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1694 cpu_physical_memory_read(addr, buf, l);
1696 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1697 monitor_printf(mon, " Cannot access memory\n");
1706 v = ldub_p(buf + i);
1709 v = lduw_p(buf + i);
1712 v = (uint32_t)ldl_p(buf + i);
1718 monitor_printf(mon, " ");
1721 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1724 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1727 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1730 monitor_printf(mon, "%*" PRId64, max_digits, v);
1733 monitor_printc(mon, v);
1738 monitor_printf(mon, "\n");
1744 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1746 int count = qdict_get_int(qdict, "count");
1747 int format = qdict_get_int(qdict, "format");
1748 int size = qdict_get_int(qdict, "size");
1749 target_long addr = qdict_get_int(qdict, "addr");
1751 memory_dump(mon, count, format, size, addr, 0);
1754 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1756 int count = qdict_get_int(qdict, "count");
1757 int format = qdict_get_int(qdict, "format");
1758 int size = qdict_get_int(qdict, "size");
1759 hwaddr addr = qdict_get_int(qdict, "addr");
1761 memory_dump(mon, count, format, size, addr, 1);
1764 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1766 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1770 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1774 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1775 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1776 memory_region_unref(mrs.mr);
1781 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1784 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1786 hwaddr addr = qdict_get_int(qdict, "addr");
1787 Error *local_err = NULL;
1788 MemoryRegion *mr = NULL;
1791 ptr = gpa2hva(&mr, addr, &local_err);
1793 error_report_err(local_err);
1797 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1799 addr, mr->name, ptr);
1801 memory_region_unref(mr);
1805 static uint64_t vtop(void *ptr, Error **errp)
1809 uintptr_t addr = (uintptr_t) ptr;
1810 uintptr_t pagesize = getpagesize();
1811 off_t offset = addr / pagesize * sizeof(pinfo);
1814 fd = open("/proc/self/pagemap", O_RDONLY);
1816 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1820 /* Force copy-on-write if necessary. */
1821 atomic_add((uint8_t *)ptr, 0);
1823 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1824 error_setg_errno(errp, errno, "Cannot read pagemap");
1827 if ((pinfo & (1ull << 63)) == 0) {
1828 error_setg(errp, "Page not present");
1831 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1838 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1840 hwaddr addr = qdict_get_int(qdict, "addr");
1841 Error *local_err = NULL;
1842 MemoryRegion *mr = NULL;
1846 ptr = gpa2hva(&mr, addr, &local_err);
1848 error_report_err(local_err);
1852 physaddr = vtop(ptr, &local_err);
1854 error_report_err(local_err);
1856 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1857 " (%s) is 0x%" PRIx64 "\n",
1858 addr, mr->name, (uint64_t) physaddr);
1861 memory_region_unref(mr);
1865 static void do_print(Monitor *mon, const QDict *qdict)
1867 int format = qdict_get_int(qdict, "format");
1868 hwaddr val = qdict_get_int(qdict, "val");
1872 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1875 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1878 monitor_printf(mon, "%" HWADDR_PRIu, val);
1882 monitor_printf(mon, "%" HWADDR_PRId, val);
1885 monitor_printc(mon, val);
1888 monitor_printf(mon, "\n");
1891 static void hmp_sum(Monitor *mon, const QDict *qdict)
1895 uint32_t start = qdict_get_int(qdict, "start");
1896 uint32_t size = qdict_get_int(qdict, "size");
1899 for(addr = start; addr < (start + size); addr++) {
1900 uint8_t val = address_space_ldub(&address_space_memory, addr,
1901 MEMTXATTRS_UNSPECIFIED, NULL);
1902 /* BSD sum algorithm ('sum' Unix command) */
1903 sum = (sum >> 1) | (sum << 15);
1906 monitor_printf(mon, "%05d\n", sum);
1909 static int mouse_button_state;
1911 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1913 int dx, dy, dz, button;
1914 const char *dx_str = qdict_get_str(qdict, "dx_str");
1915 const char *dy_str = qdict_get_str(qdict, "dy_str");
1916 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1918 dx = strtol(dx_str, NULL, 0);
1919 dy = strtol(dy_str, NULL, 0);
1920 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1921 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1924 dz = strtol(dz_str, NULL, 0);
1926 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1927 qemu_input_queue_btn(NULL, button, true);
1928 qemu_input_event_sync();
1929 qemu_input_queue_btn(NULL, button, false);
1932 qemu_input_event_sync();
1935 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1937 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1938 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1939 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1940 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1942 int button_state = qdict_get_int(qdict, "button_state");
1944 if (mouse_button_state == button_state) {
1947 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1948 qemu_input_event_sync();
1949 mouse_button_state = button_state;
1952 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1954 int size = qdict_get_int(qdict, "size");
1955 int addr = qdict_get_int(qdict, "addr");
1956 int has_index = qdict_haskey(qdict, "index");
1961 int index = qdict_get_int(qdict, "index");
1962 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1970 val = cpu_inb(addr);
1974 val = cpu_inw(addr);
1978 val = cpu_inl(addr);
1982 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1983 suffix, addr, size * 2, val);
1986 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1988 int size = qdict_get_int(qdict, "size");
1989 int addr = qdict_get_int(qdict, "addr");
1990 int val = qdict_get_int(qdict, "val");
1992 addr &= IOPORTS_MASK;
1997 cpu_outb(addr, val);
2000 cpu_outw(addr, val);
2003 cpu_outl(addr, val);
2008 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
2010 Error *local_err = NULL;
2011 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
2013 qemu_boot_set(bootdevice, &local_err);
2015 error_report_err(local_err);
2017 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
2021 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
2023 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
2024 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
2025 bool owner = qdict_get_try_bool(qdict, "owner", false);
2027 mtree_info((fprintf_function)monitor_printf, mon, flatview, dispatch_tree,
2031 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
2034 NumaNodeMem *node_mem;
2035 CpuInfoList *cpu_list, *cpu;
2037 cpu_list = qmp_query_cpus(&error_abort);
2038 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
2040 query_numa_node_mem(node_mem);
2041 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
2042 for (i = 0; i < nb_numa_nodes; i++) {
2043 monitor_printf(mon, "node %d cpus:", i);
2044 for (cpu = cpu_list; cpu; cpu = cpu->next) {
2045 if (cpu->value->has_props && cpu->value->props->has_node_id &&
2046 cpu->value->props->node_id == i) {
2047 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
2050 monitor_printf(mon, "\n");
2051 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
2052 node_mem[i].node_mem >> 20);
2053 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
2054 node_mem[i].node_plugged_mem >> 20);
2056 qapi_free_CpuInfoList(cpu_list);
2060 #ifdef CONFIG_PROFILER
2065 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2067 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
2068 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
2069 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
2070 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
2075 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2077 monitor_printf(mon, "Internal profiler not compiled\n");
2081 /* Capture support */
2082 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
2084 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
2089 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2090 monitor_printf(mon, "[%d]: ", i);
2091 s->ops.info (s->opaque);
2095 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
2098 int n = qdict_get_int(qdict, "n");
2101 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2103 s->ops.destroy (s->opaque);
2104 QLIST_REMOVE (s, entries);
2111 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2113 const char *path = qdict_get_str(qdict, "path");
2114 int has_freq = qdict_haskey(qdict, "freq");
2115 int freq = qdict_get_try_int(qdict, "freq", -1);
2116 int has_bits = qdict_haskey(qdict, "bits");
2117 int bits = qdict_get_try_int(qdict, "bits", -1);
2118 int has_channels = qdict_haskey(qdict, "nchannels");
2119 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2122 s = g_malloc0 (sizeof (*s));
2124 freq = has_freq ? freq : 44100;
2125 bits = has_bits ? bits : 16;
2126 nchannels = has_channels ? nchannels : 2;
2128 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2129 monitor_printf(mon, "Failed to add wave capture\n");
2133 QLIST_INSERT_HEAD (&capture_head, s, entries);
2136 static qemu_acl *find_acl(Monitor *mon, const char *name)
2138 qemu_acl *acl = qemu_acl_find(name);
2141 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2146 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2148 const char *aclname = qdict_get_str(qdict, "aclname");
2149 qemu_acl *acl = find_acl(mon, aclname);
2150 qemu_acl_entry *entry;
2154 monitor_printf(mon, "policy: %s\n",
2155 acl->defaultDeny ? "deny" : "allow");
2156 QTAILQ_FOREACH(entry, &acl->entries, next) {
2158 monitor_printf(mon, "%d: %s %s\n", i,
2159 entry->deny ? "deny" : "allow", entry->match);
2164 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2166 const char *aclname = qdict_get_str(qdict, "aclname");
2167 qemu_acl *acl = find_acl(mon, aclname);
2170 qemu_acl_reset(acl);
2171 monitor_printf(mon, "acl: removed all rules\n");
2175 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2177 const char *aclname = qdict_get_str(qdict, "aclname");
2178 const char *policy = qdict_get_str(qdict, "policy");
2179 qemu_acl *acl = find_acl(mon, aclname);
2182 if (strcmp(policy, "allow") == 0) {
2183 acl->defaultDeny = 0;
2184 monitor_printf(mon, "acl: policy set to 'allow'\n");
2185 } else if (strcmp(policy, "deny") == 0) {
2186 acl->defaultDeny = 1;
2187 monitor_printf(mon, "acl: policy set to 'deny'\n");
2189 monitor_printf(mon, "acl: unknown policy '%s', "
2190 "expected 'deny' or 'allow'\n", policy);
2195 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2197 const char *aclname = qdict_get_str(qdict, "aclname");
2198 const char *match = qdict_get_str(qdict, "match");
2199 const char *policy = qdict_get_str(qdict, "policy");
2200 int has_index = qdict_haskey(qdict, "index");
2201 int index = qdict_get_try_int(qdict, "index", -1);
2202 qemu_acl *acl = find_acl(mon, aclname);
2206 if (strcmp(policy, "allow") == 0) {
2208 } else if (strcmp(policy, "deny") == 0) {
2211 monitor_printf(mon, "acl: unknown policy '%s', "
2212 "expected 'deny' or 'allow'\n", policy);
2216 ret = qemu_acl_insert(acl, deny, match, index);
2218 ret = qemu_acl_append(acl, deny, match);
2220 monitor_printf(mon, "acl: unable to add acl entry\n");
2222 monitor_printf(mon, "acl: added rule at position %d\n", ret);
2226 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2228 const char *aclname = qdict_get_str(qdict, "aclname");
2229 const char *match = qdict_get_str(qdict, "match");
2230 qemu_acl *acl = find_acl(mon, aclname);
2234 ret = qemu_acl_remove(acl, match);
2236 monitor_printf(mon, "acl: no matching acl entry\n");
2238 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
2242 void qmp_getfd(const char *fdname, Error **errp)
2247 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2249 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2253 if (qemu_isdigit(fdname[0])) {
2255 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2256 "a name not starting with a digit");
2260 qemu_mutex_lock(&cur_mon->mon_lock);
2261 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2262 if (strcmp(monfd->name, fdname) != 0) {
2268 qemu_mutex_unlock(&cur_mon->mon_lock);
2269 /* Make sure close() is out of critical section */
2274 monfd = g_malloc0(sizeof(mon_fd_t));
2275 monfd->name = g_strdup(fdname);
2278 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2279 qemu_mutex_unlock(&cur_mon->mon_lock);
2282 void qmp_closefd(const char *fdname, Error **errp)
2287 qemu_mutex_lock(&cur_mon->mon_lock);
2288 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2289 if (strcmp(monfd->name, fdname) != 0) {
2293 QLIST_REMOVE(monfd, next);
2295 g_free(monfd->name);
2297 qemu_mutex_unlock(&cur_mon->mon_lock);
2298 /* Make sure close() is out of critical section */
2303 qemu_mutex_unlock(&cur_mon->mon_lock);
2304 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2307 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2311 qemu_mutex_lock(&mon->mon_lock);
2312 QLIST_FOREACH(monfd, &mon->fds, next) {
2315 if (strcmp(monfd->name, fdname) != 0) {
2321 /* caller takes ownership of fd */
2322 QLIST_REMOVE(monfd, next);
2323 g_free(monfd->name);
2325 qemu_mutex_unlock(&mon->mon_lock);
2330 qemu_mutex_unlock(&mon->mon_lock);
2331 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2335 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2337 MonFdsetFd *mon_fdset_fd;
2338 MonFdsetFd *mon_fdset_fd_next;
2340 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2341 if ((mon_fdset_fd->removed ||
2342 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2343 runstate_is_running()) {
2344 close(mon_fdset_fd->fd);
2345 g_free(mon_fdset_fd->opaque);
2346 QLIST_REMOVE(mon_fdset_fd, next);
2347 g_free(mon_fdset_fd);
2351 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2352 QLIST_REMOVE(mon_fdset, next);
2357 static void monitor_fdsets_cleanup(void)
2359 MonFdset *mon_fdset;
2360 MonFdset *mon_fdset_next;
2362 qemu_mutex_lock(&mon_fdsets_lock);
2363 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2364 monitor_fdset_cleanup(mon_fdset);
2366 qemu_mutex_unlock(&mon_fdsets_lock);
2369 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2370 const char *opaque, Error **errp)
2373 Monitor *mon = cur_mon;
2376 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2378 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2382 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2383 has_opaque, opaque, errp);
2395 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2397 MonFdset *mon_fdset;
2398 MonFdsetFd *mon_fdset_fd;
2401 qemu_mutex_lock(&mon_fdsets_lock);
2402 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2403 if (mon_fdset->id != fdset_id) {
2406 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2408 if (mon_fdset_fd->fd != fd) {
2411 mon_fdset_fd->removed = true;
2414 mon_fdset_fd->removed = true;
2417 if (has_fd && !mon_fdset_fd) {
2420 monitor_fdset_cleanup(mon_fdset);
2421 qemu_mutex_unlock(&mon_fdsets_lock);
2426 qemu_mutex_unlock(&mon_fdsets_lock);
2428 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2431 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2433 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2436 FdsetInfoList *qmp_query_fdsets(Error **errp)
2438 MonFdset *mon_fdset;
2439 MonFdsetFd *mon_fdset_fd;
2440 FdsetInfoList *fdset_list = NULL;
2442 qemu_mutex_lock(&mon_fdsets_lock);
2443 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2444 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2445 FdsetFdInfoList *fdsetfd_list = NULL;
2447 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2448 fdset_info->value->fdset_id = mon_fdset->id;
2450 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2451 FdsetFdInfoList *fdsetfd_info;
2453 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2454 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2455 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2456 if (mon_fdset_fd->opaque) {
2457 fdsetfd_info->value->has_opaque = true;
2458 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2460 fdsetfd_info->value->has_opaque = false;
2463 fdsetfd_info->next = fdsetfd_list;
2464 fdsetfd_list = fdsetfd_info;
2467 fdset_info->value->fds = fdsetfd_list;
2469 fdset_info->next = fdset_list;
2470 fdset_list = fdset_info;
2472 qemu_mutex_unlock(&mon_fdsets_lock);
2477 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2478 bool has_opaque, const char *opaque,
2481 MonFdset *mon_fdset = NULL;
2482 MonFdsetFd *mon_fdset_fd;
2485 qemu_mutex_lock(&mon_fdsets_lock);
2487 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2488 /* Break if match found or match impossible due to ordering by ID */
2489 if (fdset_id <= mon_fdset->id) {
2490 if (fdset_id < mon_fdset->id) {
2498 if (mon_fdset == NULL) {
2499 int64_t fdset_id_prev = -1;
2500 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2504 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2505 "a non-negative value");
2506 qemu_mutex_unlock(&mon_fdsets_lock);
2509 /* Use specified fdset ID */
2510 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2511 mon_fdset_cur = mon_fdset;
2512 if (fdset_id < mon_fdset_cur->id) {
2517 /* Use first available fdset ID */
2518 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2519 mon_fdset_cur = mon_fdset;
2520 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2521 fdset_id_prev = mon_fdset_cur->id;
2528 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2530 mon_fdset->id = fdset_id;
2532 mon_fdset->id = fdset_id_prev + 1;
2535 /* The fdset list is ordered by fdset ID */
2536 if (!mon_fdset_cur) {
2537 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2538 } else if (mon_fdset->id < mon_fdset_cur->id) {
2539 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2541 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2545 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2546 mon_fdset_fd->fd = fd;
2547 mon_fdset_fd->removed = false;
2549 mon_fdset_fd->opaque = g_strdup(opaque);
2551 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2553 fdinfo = g_malloc0(sizeof(*fdinfo));
2554 fdinfo->fdset_id = mon_fdset->id;
2555 fdinfo->fd = mon_fdset_fd->fd;
2557 qemu_mutex_unlock(&mon_fdsets_lock);
2561 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2566 MonFdset *mon_fdset;
2567 MonFdsetFd *mon_fdset_fd;
2571 qemu_mutex_lock(&mon_fdsets_lock);
2572 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2573 if (mon_fdset->id != fdset_id) {
2576 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2577 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2578 if (mon_fd_flags == -1) {
2583 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2584 ret = mon_fdset_fd->fd;
2594 qemu_mutex_unlock(&mon_fdsets_lock);
2599 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2601 MonFdset *mon_fdset;
2602 MonFdsetFd *mon_fdset_fd_dup;
2604 qemu_mutex_lock(&mon_fdsets_lock);
2605 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2606 if (mon_fdset->id != fdset_id) {
2609 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2610 if (mon_fdset_fd_dup->fd == dup_fd) {
2614 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2615 mon_fdset_fd_dup->fd = dup_fd;
2616 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2617 qemu_mutex_unlock(&mon_fdsets_lock);
2622 qemu_mutex_unlock(&mon_fdsets_lock);
2626 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2628 MonFdset *mon_fdset;
2629 MonFdsetFd *mon_fdset_fd_dup;
2631 qemu_mutex_lock(&mon_fdsets_lock);
2632 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2633 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2634 if (mon_fdset_fd_dup->fd == dup_fd) {
2636 QLIST_REMOVE(mon_fdset_fd_dup, next);
2637 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2638 monitor_fdset_cleanup(mon_fdset);
2642 qemu_mutex_unlock(&mon_fdsets_lock);
2643 return mon_fdset->id;
2650 qemu_mutex_unlock(&mon_fdsets_lock);
2654 int monitor_fdset_dup_fd_find(int dup_fd)
2656 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2659 void monitor_fdset_dup_fd_remove(int dup_fd)
2661 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2664 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2667 Error *local_err = NULL;
2669 if (!qemu_isdigit(fdname[0]) && mon) {
2670 fd = monitor_get_fd(mon, fdname, &local_err);
2672 fd = qemu_parse_fd(fdname);
2674 error_setg(&local_err, "Invalid file descriptor number '%s'",
2679 error_propagate(errp, local_err);
2688 /* Please update hmp-commands.hx when adding or changing commands */
2689 static mon_cmd_t info_cmds[] = {
2690 #include "hmp-commands-info.h"
2694 /* mon_cmds and info_cmds would be sorted at runtime */
2695 static mon_cmd_t mon_cmds[] = {
2696 #include "hmp-commands.h"
2700 /*******************************************************************/
2702 static const char *pch;
2703 static sigjmp_buf expr_env;
2706 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2707 expr_error(Monitor *mon, const char *fmt, ...)
2711 monitor_vprintf(mon, fmt, ap);
2712 monitor_printf(mon, "\n");
2714 siglongjmp(expr_env, 1);
2717 /* return 0 if OK, -1 if not found */
2718 static int get_monitor_def(target_long *pval, const char *name)
2720 const MonitorDef *md = target_monitor_defs();
2721 CPUState *cs = mon_get_cpu();
2726 if (cs == NULL || md == NULL) {
2730 for(; md->name != NULL; md++) {
2731 if (compare_cmd(name, md->name)) {
2732 if (md->get_value) {
2733 *pval = md->get_value(md, md->offset);
2735 CPUArchState *env = mon_get_cpu_env();
2736 ptr = (uint8_t *)env + md->offset;
2739 *pval = *(int32_t *)ptr;
2742 *pval = *(target_long *)ptr;
2753 ret = target_get_monitor_def(cs, name, &tmp);
2755 *pval = (target_long) tmp;
2761 static void next(void)
2765 while (qemu_isspace(*pch))
2770 static int64_t expr_sum(Monitor *mon);
2772 static int64_t expr_unary(Monitor *mon)
2781 n = expr_unary(mon);
2785 n = -expr_unary(mon);
2789 n = ~expr_unary(mon);
2795 expr_error(mon, "')' expected");
2802 expr_error(mon, "character constant expected");
2806 expr_error(mon, "missing terminating \' character");
2816 while ((*pch >= 'a' && *pch <= 'z') ||
2817 (*pch >= 'A' && *pch <= 'Z') ||
2818 (*pch >= '0' && *pch <= '9') ||
2819 *pch == '_' || *pch == '.') {
2820 if ((q - buf) < sizeof(buf) - 1)
2824 while (qemu_isspace(*pch))
2827 ret = get_monitor_def(®, buf);
2829 expr_error(mon, "unknown register");
2834 expr_error(mon, "unexpected end of expression");
2839 n = strtoull(pch, &p, 0);
2840 if (errno == ERANGE) {
2841 expr_error(mon, "number too large");
2844 expr_error(mon, "invalid char '%c' in expression", *p);
2847 while (qemu_isspace(*pch))
2855 static int64_t expr_prod(Monitor *mon)
2860 val = expr_unary(mon);
2863 if (op != '*' && op != '/' && op != '%')
2866 val2 = expr_unary(mon);
2875 expr_error(mon, "division by zero");
2886 static int64_t expr_logic(Monitor *mon)
2891 val = expr_prod(mon);
2894 if (op != '&' && op != '|' && op != '^')
2897 val2 = expr_prod(mon);
2914 static int64_t expr_sum(Monitor *mon)
2919 val = expr_logic(mon);
2922 if (op != '+' && op != '-')
2925 val2 = expr_logic(mon);
2934 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2937 if (sigsetjmp(expr_env, 0)) {
2941 while (qemu_isspace(*pch))
2943 *pval = expr_sum(mon);
2948 static int get_double(Monitor *mon, double *pval, const char **pp)
2950 const char *p = *pp;
2954 d = strtod(p, &tailp);
2956 monitor_printf(mon, "Number expected\n");
2959 if (d != d || d - d != 0) {
2960 /* NaN or infinity */
2961 monitor_printf(mon, "Bad number\n");
2970 * Store the command-name in cmdname, and return a pointer to
2971 * the remaining of the command string.
2973 static const char *get_command_name(const char *cmdline,
2974 char *cmdname, size_t nlen)
2977 const char *p, *pstart;
2980 while (qemu_isspace(*p))
2985 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2990 memcpy(cmdname, pstart, len);
2991 cmdname[len] = '\0';
2996 * Read key of 'type' into 'key' and return the current
2999 static char *key_get_info(const char *type, char **key)
3007 p = strchr(type, ':');
3014 str = g_malloc(len + 1);
3015 memcpy(str, type, len);
3022 static int default_fmt_format = 'x';
3023 static int default_fmt_size = 4;
3025 static int is_valid_option(const char *c, const char *typestr)
3033 typestr = strstr(typestr, option);
3034 return (typestr != NULL);
3037 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
3038 const char *cmdname)
3040 const mon_cmd_t *cmd;
3042 for (cmd = disp_table; cmd->name != NULL; cmd++) {
3043 if (compare_cmd(cmdname, cmd->name)) {
3052 * Parse command name from @cmdp according to command table @table.
3053 * If blank, return NULL.
3054 * Else, if no valid command can be found, report to @mon, and return
3056 * Else, change @cmdp to point right behind the name, and return its
3057 * command table entry.
3058 * Do not assume the return value points into @table! It doesn't when
3059 * the command is found in a sub-command table.
3061 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
3062 const char *cmdp_start,
3067 const mon_cmd_t *cmd;
3070 /* extract the command name */
3071 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
3075 cmd = search_dispatch_table(table, cmdname);
3077 monitor_printf(mon, "unknown command: '%.*s'\n",
3078 (int)(p - cmdp_start), cmdp_start);
3081 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
3082 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
3083 "until after exit_preconfig.\n",
3084 (int)(p - cmdp_start), cmdp_start);
3088 /* filter out following useless space */
3089 while (qemu_isspace(*p)) {
3094 /* search sub command */
3095 if (cmd->sub_table != NULL && *p != '\0') {
3096 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3103 * Parse arguments for @cmd.
3104 * If it can't be parsed, report to @mon, and return NULL.
3105 * Else, insert command arguments into a QDict, and return it.
3106 * Note: On success, caller has to free the QDict structure.
3109 static QDict *monitor_parse_arguments(Monitor *mon,
3111 const mon_cmd_t *cmd)
3113 const char *typestr;
3116 const char *p = *endp;
3118 QDict *qdict = qdict_new();
3120 /* parse the parameters */
3121 typestr = cmd->args_type;
3123 typestr = key_get_info(typestr, &key);
3135 while (qemu_isspace(*p))
3137 if (*typestr == '?') {
3140 /* no optional string: NULL argument */
3144 ret = get_str(buf, sizeof(buf), &p);
3148 monitor_printf(mon, "%s: filename expected\n",
3152 monitor_printf(mon, "%s: block device name expected\n",
3156 monitor_printf(mon, "%s: string expected\n", cmd->name);
3161 qdict_put_str(qdict, key, buf);
3166 QemuOptsList *opts_list;
3169 opts_list = qemu_find_opts(key);
3170 if (!opts_list || opts_list->desc->name) {
3173 while (qemu_isspace(*p)) {
3178 if (get_str(buf, sizeof(buf), &p) < 0) {
3181 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3185 qemu_opts_to_qdict(opts, qdict);
3186 qemu_opts_del(opts);
3191 int count, format, size;
3193 while (qemu_isspace(*p))
3199 if (qemu_isdigit(*p)) {
3201 while (qemu_isdigit(*p)) {
3202 count = count * 10 + (*p - '0');
3240 if (*p != '\0' && !qemu_isspace(*p)) {
3241 monitor_printf(mon, "invalid char in format: '%c'\n",
3246 format = default_fmt_format;
3247 if (format != 'i') {
3248 /* for 'i', not specifying a size gives -1 as size */
3250 size = default_fmt_size;
3251 default_fmt_size = size;
3253 default_fmt_format = format;
3256 format = default_fmt_format;
3257 if (format != 'i') {
3258 size = default_fmt_size;
3263 qdict_put_int(qdict, "count", count);
3264 qdict_put_int(qdict, "format", format);
3265 qdict_put_int(qdict, "size", size);
3274 while (qemu_isspace(*p))
3276 if (*typestr == '?' || *typestr == '.') {
3277 if (*typestr == '?') {
3285 while (qemu_isspace(*p))
3294 if (get_expr(mon, &val, &p))
3296 /* Check if 'i' is greater than 32-bit */
3297 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3298 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3299 monitor_printf(mon, "integer is for 32-bit values\n");
3301 } else if (c == 'M') {
3303 monitor_printf(mon, "enter a positive value\n");
3308 qdict_put_int(qdict, key, val);
3317 while (qemu_isspace(*p)) {
3320 if (*typestr == '?') {
3326 ret = qemu_strtosz_MiB(p, &end, &val);
3327 if (ret < 0 || val > INT64_MAX) {
3328 monitor_printf(mon, "invalid size\n");
3331 qdict_put_int(qdict, key, val);
3339 while (qemu_isspace(*p))
3341 if (*typestr == '?') {
3347 if (get_double(mon, &val, &p) < 0) {
3350 if (p[0] && p[1] == 's') {
3353 val /= 1e3; p += 2; break;
3355 val /= 1e6; p += 2; break;
3357 val /= 1e9; p += 2; break;
3360 if (*p && !qemu_isspace(*p)) {
3361 monitor_printf(mon, "Unknown unit suffix\n");
3364 qdict_put(qdict, key, qnum_from_double(val));
3372 while (qemu_isspace(*p)) {
3376 while (qemu_isgraph(*p)) {
3379 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3381 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3384 monitor_printf(mon, "Expected 'on' or 'off'\n");
3387 qdict_put_bool(qdict, key, val);
3392 const char *tmp = p;
3399 while (qemu_isspace(*p))
3404 if(!is_valid_option(p, typestr)) {
3406 monitor_printf(mon, "%s: unsupported option -%c\n",
3418 qdict_put_bool(qdict, key, true);
3425 /* package all remaining string */
3428 while (qemu_isspace(*p)) {
3431 if (*typestr == '?') {
3434 /* no remaining string: NULL argument */
3440 monitor_printf(mon, "%s: string expected\n",
3444 qdict_put_str(qdict, key, p);
3450 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3456 /* check that all arguments were parsed */
3457 while (qemu_isspace(*p))
3460 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3468 qobject_unref(qdict);
3473 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3476 const mon_cmd_t *cmd;
3477 const char *cmd_start = cmdline;
3479 trace_handle_hmp_command(mon, cmdline);
3481 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3486 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3488 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3491 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3492 (int)(cmdline - cmd_start), cmd_start);
3496 cmd->cmd(mon, qdict);
3497 qobject_unref(qdict);
3500 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3502 const char *p, *pstart;
3509 p = qemu_strchrnul(p, '|');
3511 if (len > sizeof(cmd) - 2)
3512 len = sizeof(cmd) - 2;
3513 memcpy(cmd, pstart, len);
3515 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3516 readline_add_completion(mon->rs, cmd);
3524 static void file_completion(Monitor *mon, const char *input)
3529 char file[1024], file_prefix[1024];
3533 p = strrchr(input, '/');
3536 pstrcpy(file_prefix, sizeof(file_prefix), input);
3537 pstrcpy(path, sizeof(path), ".");
3539 input_path_len = p - input + 1;
3540 memcpy(path, input, input_path_len);
3541 if (input_path_len > sizeof(path) - 1)
3542 input_path_len = sizeof(path) - 1;
3543 path[input_path_len] = '\0';
3544 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3547 ffs = opendir(path);
3556 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3560 if (strstart(d->d_name, file_prefix, NULL)) {
3561 memcpy(file, input, input_path_len);
3562 if (input_path_len < sizeof(file))
3563 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3565 /* stat the file to find out if it's a directory.
3566 * In that case add a slash to speed up typing long paths
3568 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3569 pstrcat(file, sizeof(file), "/");
3571 readline_add_completion(mon->rs, file);
3577 static const char *next_arg_type(const char *typestr)
3579 const char *p = strchr(typestr, ':');
3580 return (p != NULL ? ++p : typestr);
3583 static void add_completion_option(ReadLineState *rs, const char *str,
3586 if (!str || !option) {
3589 if (!strncmp(option, str, strlen(str))) {
3590 readline_add_completion(rs, option);
3594 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3597 ChardevBackendInfoList *list, *start;
3603 readline_set_completion_index(rs, len);
3605 start = list = qmp_query_chardev_backends(NULL);
3607 const char *chr_name = list->value->name;
3609 if (!strncmp(chr_name, str, len)) {
3610 readline_add_completion(rs, chr_name);
3614 qapi_free_ChardevBackendInfoList(start);
3617 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3626 readline_set_completion_index(rs, len);
3627 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3628 add_completion_option(rs, str, NetClientDriver_str(i));
3632 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3642 readline_set_completion_index(rs, len);
3643 list = elt = object_class_get_list(TYPE_DEVICE, false);
3646 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3648 name = object_class_get_name(OBJECT_CLASS(dc));
3650 if (dc->user_creatable
3651 && !strncmp(name, str, len)) {
3652 readline_add_completion(rs, name);
3659 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3669 readline_set_completion_index(rs, len);
3670 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3674 name = object_class_get_name(OBJECT_CLASS(elt->data));
3675 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3676 readline_add_completion(rs, name);
3683 static void peripheral_device_del_completion(ReadLineState *rs,
3684 const char *str, size_t len)
3686 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3687 GSList *list, *item;
3689 list = qdev_build_hotpluggable_device_list(peripheral);
3694 for (item = list; item; item = g_slist_next(item)) {
3695 DeviceState *dev = item->data;
3697 if (dev->id && !strncmp(str, dev->id, len)) {
3698 readline_add_completion(rs, dev->id);
3705 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3708 ChardevInfoList *list, *start;
3714 readline_set_completion_index(rs, len);
3716 start = list = qmp_query_chardev(NULL);
3718 ChardevInfo *chr = list->value;
3720 if (!strncmp(chr->label, str, len)) {
3721 readline_add_completion(rs, chr->label);
3725 qapi_free_ChardevInfoList(start);
3728 static void ringbuf_completion(ReadLineState *rs, const char *str)
3731 ChardevInfoList *list, *start;
3734 readline_set_completion_index(rs, len);
3736 start = list = qmp_query_chardev(NULL);
3738 ChardevInfo *chr_info = list->value;
3740 if (!strncmp(chr_info->label, str, len)) {
3741 Chardev *chr = qemu_chr_find(chr_info->label);
3742 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3743 readline_add_completion(rs, chr_info->label);
3748 qapi_free_ChardevInfoList(start);
3751 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3756 ringbuf_completion(rs, str);
3759 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3768 readline_set_completion_index(rs, len);
3769 peripheral_device_del_completion(rs, str, len);
3772 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3774 ObjectPropertyInfoList *list, *start;
3781 readline_set_completion_index(rs, len);
3783 start = list = qmp_qom_list("/objects", NULL);
3785 ObjectPropertyInfo *info = list->value;
3787 if (!strncmp(info->type, "child<", 5)
3788 && !strncmp(info->name, str, len)) {
3789 readline_add_completion(rs, info->name);
3793 qapi_free_ObjectPropertyInfoList(start);
3796 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3805 sep = strrchr(str, '-');
3810 readline_set_completion_index(rs, len);
3811 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3812 if (!strncmp(str, QKeyCode_str(i), len)) {
3813 readline_add_completion(rs, QKeyCode_str(i));
3818 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3823 readline_set_completion_index(rs, len);
3825 NetClientState *ncs[MAX_QUEUE_NUM];
3827 count = qemu_find_net_clients_except(NULL, ncs,
3828 NET_CLIENT_DRIVER_NONE,
3830 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3831 const char *name = ncs[i]->name;
3832 if (!strncmp(str, name, len)) {
3833 readline_add_completion(rs, name);
3836 } else if (nb_args == 3) {
3837 add_completion_option(rs, str, "on");
3838 add_completion_option(rs, str, "off");
3842 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3845 NetClientState *ncs[MAX_QUEUE_NUM];
3852 readline_set_completion_index(rs, len);
3853 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3855 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3857 const char *name = ncs[i]->name;
3858 if (strncmp(str, name, len)) {
3861 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3863 readline_add_completion(rs, name);
3868 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3873 readline_set_completion_index(rs, len);
3875 TraceEventIter iter;
3877 char *pattern = g_strdup_printf("%s*", str);
3878 trace_event_iter_init(&iter, pattern);
3879 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3880 readline_add_completion(rs, trace_event_get_name(ev));
3886 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3891 readline_set_completion_index(rs, len);
3893 TraceEventIter iter;
3895 char *pattern = g_strdup_printf("%s*", str);
3896 trace_event_iter_init(&iter, pattern);
3897 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3898 readline_add_completion(rs, trace_event_get_name(ev));
3901 } else if (nb_args == 3) {
3902 add_completion_option(rs, str, "on");
3903 add_completion_option(rs, str, "off");
3907 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3914 readline_set_completion_index(rs, strlen(str));
3915 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3916 add_completion_option(rs, str, WatchdogAction_str(i));
3920 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3926 readline_set_completion_index(rs, len);
3929 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3930 const char *name = MigrationCapability_str(i);
3931 if (!strncmp(str, name, len)) {
3932 readline_add_completion(rs, name);
3935 } else if (nb_args == 3) {
3936 add_completion_option(rs, str, "on");
3937 add_completion_option(rs, str, "off");
3941 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3947 readline_set_completion_index(rs, len);
3950 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3951 const char *name = MigrationParameter_str(i);
3952 if (!strncmp(str, name, len)) {
3953 readline_add_completion(rs, name);
3959 static void vm_completion(ReadLineState *rs, const char *str)
3962 BlockDriverState *bs;
3963 BdrvNextIterator it;
3966 readline_set_completion_index(rs, len);
3968 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3969 SnapshotInfoList *snapshots, *snapshot;
3970 AioContext *ctx = bdrv_get_aio_context(bs);
3973 aio_context_acquire(ctx);
3974 if (bdrv_can_snapshot(bs)) {
3975 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3977 aio_context_release(ctx);
3982 snapshot = snapshots;
3984 char *completion = snapshot->value->name;
3985 if (!strncmp(str, completion, len)) {
3986 readline_add_completion(rs, completion);
3988 completion = snapshot->value->id;
3989 if (!strncmp(str, completion, len)) {
3990 readline_add_completion(rs, completion);
3992 snapshot = snapshot->next;
3994 qapi_free_SnapshotInfoList(snapshots);
3999 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
4002 vm_completion(rs, str);
4006 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
4009 vm_completion(rs, str);
4013 static void monitor_find_completion_by_table(Monitor *mon,
4014 const mon_cmd_t *cmd_table,
4018 const char *cmdname;
4020 const char *ptype, *old_ptype, *str, *name;
4021 const mon_cmd_t *cmd;
4022 BlockBackend *blk = NULL;
4025 /* command completion */
4030 readline_set_completion_index(mon->rs, strlen(cmdname));
4031 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4032 if (!runstate_check(RUN_STATE_PRECONFIG) ||
4033 cmd_can_preconfig(cmd)) {
4034 cmd_completion(mon, cmdname, cmd->name);
4038 /* find the command */
4039 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4040 if (compare_cmd(args[0], cmd->name) &&
4041 (!runstate_check(RUN_STATE_PRECONFIG) ||
4042 cmd_can_preconfig(cmd))) {
4050 if (cmd->sub_table) {
4051 /* do the job again */
4052 monitor_find_completion_by_table(mon, cmd->sub_table,
4053 &args[1], nb_args - 1);
4056 if (cmd->command_completion) {
4057 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
4061 ptype = next_arg_type(cmd->args_type);
4062 for(i = 0; i < nb_args - 2; i++) {
4063 if (*ptype != '\0') {
4064 ptype = next_arg_type(ptype);
4065 while (*ptype == '?')
4066 ptype = next_arg_type(ptype);
4069 str = args[nb_args - 1];
4071 while (*ptype == '-' && old_ptype != ptype) {
4073 ptype = next_arg_type(ptype);
4077 /* file completion */
4078 readline_set_completion_index(mon->rs, strlen(str));
4079 file_completion(mon, str);
4082 /* block device name completion */
4083 readline_set_completion_index(mon->rs, strlen(str));
4084 while ((blk = blk_next(blk)) != NULL) {
4085 name = blk_name(blk);
4086 if (str[0] == '\0' ||
4087 !strncmp(name, str, strlen(str))) {
4088 readline_add_completion(mon->rs, name);
4094 if (!strcmp(cmd->name, "help|?")) {
4095 monitor_find_completion_by_table(mon, cmd_table,
4096 &args[1], nb_args - 1);
4105 static void monitor_find_completion(void *opaque,
4106 const char *cmdline)
4108 Monitor *mon = opaque;
4109 char *args[MAX_ARGS];
4112 /* 1. parse the cmdline */
4113 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4117 /* if the line ends with a space, it means we want to complete the
4119 len = strlen(cmdline);
4120 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4121 if (nb_args >= MAX_ARGS) {
4124 args[nb_args++] = g_strdup("");
4127 /* 2. auto complete according to args */
4128 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4131 free_cmdline_args(args, nb_args);
4134 static int monitor_can_read(void *opaque)
4136 Monitor *mon = opaque;
4138 return !atomic_mb_read(&mon->suspend_cnt);
4142 * 1. This function takes ownership of rsp, err, and id.
4143 * 2. rsp, err, and id may be NULL.
4144 * 3. If err != NULL then rsp must be NULL.
4146 static void monitor_qmp_respond(Monitor *mon, QObject *rsp,
4147 Error *err, QObject *id)
4149 QDict *qdict = NULL;
4153 qdict = qdict_new();
4154 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
4156 rsp = QOBJECT(qdict);
4161 qdict_put_obj(qobject_to(QDict, rsp), "id", qobject_ref(id));
4164 monitor_json_emitter(mon, rsp);
4172 * Dispatch one single QMP request. The function will free the req_obj
4173 * and objects inside it before return.
4175 static void monitor_qmp_dispatch_one(QMPRequest *req_obj)
4177 Monitor *mon, *old_mon;
4178 QObject *req, *rsp = NULL, *id;
4184 need_resume = req_obj->need_resume;
4188 if (trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4189 QString *req_json = qobject_to_json(req);
4190 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4191 qobject_unref(req_json);
4197 rsp = qmp_dispatch(mon->qmp.commands, req);
4201 /* Respond if necessary */
4202 monitor_qmp_respond(mon, rsp, NULL, id);
4204 /* This pairs with the monitor_suspend() in handle_qmp_command(). */
4206 monitor_resume(mon);
4213 * Pop one QMP request from monitor queues, return NULL if not found.
4214 * We are using round-robin fashion to pop the request, to avoid
4215 * processing commands only on a very busy monitor. To achieve that,
4216 * when we process one request on a specific monitor, we put that
4217 * monitor to the end of mon_list queue.
4219 static QMPRequest *monitor_qmp_requests_pop_any(void)
4221 QMPRequest *req_obj = NULL;
4224 qemu_mutex_lock(&monitor_lock);
4226 QTAILQ_FOREACH(mon, &mon_list, entry) {
4227 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4228 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4229 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4237 * We found one request on the monitor. Degrade this monitor's
4238 * priority to lowest by re-inserting it to end of queue.
4240 QTAILQ_REMOVE(&mon_list, mon, entry);
4241 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4244 qemu_mutex_unlock(&monitor_lock);
4249 static void monitor_qmp_bh_dispatcher(void *data)
4251 QMPRequest *req_obj = monitor_qmp_requests_pop_any();
4254 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(req_obj->id) ?: "");
4255 monitor_qmp_dispatch_one(req_obj);
4256 /* Reschedule instead of looping so the main loop stays responsive */
4257 qemu_bh_schedule(mon_global.qmp_dispatcher_bh);
4261 #define QMP_REQ_QUEUE_LEN_MAX (8)
4263 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
4265 QObject *req, *id = NULL;
4266 QDict *qdict = NULL;
4267 MonitorQMP *mon_qmp = container_of(parser, MonitorQMP, parser);
4268 Monitor *mon = container_of(mon_qmp, Monitor, qmp);
4270 QMPRequest *req_obj;
4272 req = json_parser_parse_err(tokens, NULL, &err);
4274 /* json_parser_parse_err() sucks: can fail without setting @err */
4275 error_setg(&err, QERR_JSON_PARSING);
4281 /* Check against the request in general layout */
4282 qdict = qmp_dispatch_check_obj(req, &err);
4287 /* Check against OOB specific */
4288 if (!qmp_cmd_oob_check(mon, qdict, &err)) {
4292 id = qdict_get(qdict, "id");
4294 /* When OOB is enabled, the "id" field is mandatory. */
4295 if (qmp_oob_enabled(mon) && !id) {
4296 error_setg(&err, "Out-Of-Band capability requires that "
4297 "every command contains an 'id' field");
4301 req_obj = g_new0(QMPRequest, 1);
4303 req_obj->id = qobject_ref(id);
4305 req_obj->need_resume = false;
4307 qdict_del(qdict, "id");
4309 if (qmp_is_oob(qdict)) {
4310 /* Out-Of-Band (OOB) requests are executed directly in parser. */
4311 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(req_obj->id)
4313 monitor_qmp_dispatch_one(req_obj);
4317 /* Protect qmp_requests and fetching its length. */
4318 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4321 * If OOB is not enabled on the current monitor, we'll emulate the
4322 * old behavior that we won't process the current monitor any more
4323 * until it has responded. This helps make sure that as long as
4324 * OOB is not enabled, the server will never drop any command.
4326 if (!qmp_oob_enabled(mon)) {
4327 monitor_suspend(mon);
4328 req_obj->need_resume = true;
4330 /* Drop the request if queue is full. */
4331 if (mon->qmp.qmp_requests->length >= QMP_REQ_QUEUE_LEN_MAX) {
4332 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4333 qapi_event_send_command_dropped(id,
4334 COMMAND_DROP_REASON_QUEUE_FULL,
4336 qmp_request_free(req_obj);
4342 * Put the request to the end of queue so that requests will be
4343 * handled in time order. Ownership for req_obj, req, id,
4344 * etc. will be delivered to the handler side.
4346 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4347 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4349 /* Kick the dispatcher routine */
4350 qemu_bh_schedule(mon_global.qmp_dispatcher_bh);
4354 monitor_qmp_respond(mon, NULL, err, NULL);
4358 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4360 Monitor *mon = opaque;
4362 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4365 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4367 Monitor *old_mon = cur_mon;
4373 for (i = 0; i < size; i++)
4374 readline_handle_byte(cur_mon->rs, buf[i]);
4376 if (size == 0 || buf[size - 1] != 0)
4377 monitor_printf(cur_mon, "corrupted command\n");
4379 handle_hmp_command(cur_mon, (char *)buf);
4385 static void monitor_command_cb(void *opaque, const char *cmdline,
4386 void *readline_opaque)
4388 Monitor *mon = opaque;
4390 monitor_suspend(mon);
4391 handle_hmp_command(mon, cmdline);
4392 monitor_resume(mon);
4395 int monitor_suspend(Monitor *mon)
4397 if (monitor_is_hmp_non_interactive(mon)) {
4401 atomic_inc(&mon->suspend_cnt);
4403 if (monitor_is_qmp(mon)) {
4405 * Kick iothread to make sure this takes effect. It'll be
4406 * evaluated again in prepare() of the watch object.
4408 aio_notify(iothread_get_aio_context(mon_global.mon_iothread));
4411 trace_monitor_suspend(mon, 1);
4415 void monitor_resume(Monitor *mon)
4417 if (monitor_is_hmp_non_interactive(mon)) {
4421 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4422 if (monitor_is_qmp(mon)) {
4424 * For QMP monitors that are running in IOThread, let's
4425 * kick the thread in case it's sleeping.
4427 if (mon->use_io_thr) {
4428 aio_notify(iothread_get_aio_context(mon_global.mon_iothread));
4432 readline_show_prompt(mon->rs);
4435 trace_monitor_suspend(mon, -1);
4438 static QObject *get_qmp_greeting(Monitor *mon)
4440 QList *cap_list = qlist_new();
4441 QObject *ver = NULL;
4444 qmp_marshal_query_version(NULL, &ver, NULL);
4446 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4447 if (!mon->use_io_thr && cap == QMP_CAPABILITY_OOB) {
4448 /* Monitors that are not using IOThread won't support OOB */
4451 qlist_append_str(cap_list, QMPCapability_str(cap));
4454 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': %p}}",
4458 static void monitor_qmp_caps_reset(Monitor *mon)
4460 memset(mon->qmp.qmp_caps, 0, sizeof(mon->qmp.qmp_caps));
4463 static void monitor_qmp_event(void *opaque, int event)
4466 Monitor *mon = opaque;
4469 case CHR_EVENT_OPENED:
4470 mon->qmp.commands = &qmp_cap_negotiation_commands;
4471 monitor_qmp_caps_reset(mon);
4472 data = get_qmp_greeting(mon);
4473 monitor_json_emitter(mon, data);
4474 qobject_unref(data);
4477 case CHR_EVENT_CLOSED:
4479 * Note: this is only useful when the output of the chardev
4480 * backend is still open. For example, when the backend is
4481 * stdio, it's possible that stdout is still open when stdin
4484 monitor_qmp_response_flush(mon);
4485 monitor_qmp_cleanup_queues(mon);
4486 json_message_parser_destroy(&mon->qmp.parser);
4487 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4489 monitor_fdsets_cleanup();
4494 static void monitor_event(void *opaque, int event)
4496 Monitor *mon = opaque;
4499 case CHR_EVENT_MUX_IN:
4500 qemu_mutex_lock(&mon->mon_lock);
4502 qemu_mutex_unlock(&mon->mon_lock);
4503 if (mon->reset_seen) {
4504 readline_restart(mon->rs);
4505 monitor_resume(mon);
4508 atomic_mb_set(&mon->suspend_cnt, 0);
4512 case CHR_EVENT_MUX_OUT:
4513 if (mon->reset_seen) {
4514 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4515 monitor_printf(mon, "\n");
4518 monitor_suspend(mon);
4520 atomic_inc(&mon->suspend_cnt);
4522 qemu_mutex_lock(&mon->mon_lock);
4524 qemu_mutex_unlock(&mon->mon_lock);
4527 case CHR_EVENT_OPENED:
4528 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4529 "information\n", QEMU_VERSION);
4530 if (!mon->mux_out) {
4531 readline_restart(mon->rs);
4532 readline_show_prompt(mon->rs);
4534 mon->reset_seen = 1;
4538 case CHR_EVENT_CLOSED:
4540 monitor_fdsets_cleanup();
4546 compare_mon_cmd(const void *a, const void *b)
4548 return strcmp(((const mon_cmd_t *)a)->name,
4549 ((const mon_cmd_t *)b)->name);
4552 static void sortcmdlist(void)
4555 int elem_size = sizeof(mon_cmd_t);
4557 array_num = sizeof(mon_cmds)/elem_size-1;
4558 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4560 array_num = sizeof(info_cmds)/elem_size-1;
4561 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4564 static GMainContext *monitor_get_io_context(void)
4566 return iothread_get_g_main_context(mon_global.mon_iothread);
4569 static AioContext *monitor_get_aio_context(void)
4571 return iothread_get_aio_context(mon_global.mon_iothread);
4574 static void monitor_iothread_init(void)
4576 mon_global.mon_iothread = iothread_create("mon_iothread",
4580 * This MUST be on main loop thread since we have commands that
4581 * have assumption to be run on main loop thread. It would be
4582 * nice that one day we can remove this assumption in the future.
4584 mon_global.qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4585 monitor_qmp_bh_dispatcher,
4589 * Unlike the dispatcher BH, this must be run on the monitor IO
4590 * thread, so that monitors that are using IO thread will make
4591 * sure read/write operations are all done on the IO thread.
4593 mon_global.qmp_respond_bh = aio_bh_new(monitor_get_aio_context(),
4594 monitor_qmp_bh_responder,
4598 void monitor_init_globals(void)
4600 monitor_init_qmp_commands();
4601 monitor_qapi_event_init();
4603 qemu_mutex_init(&monitor_lock);
4604 qemu_mutex_init(&mon_fdsets_lock);
4605 monitor_iothread_init();
4608 /* These functions just adapt the readline interface in a typesafe way. We
4609 * could cast function pointers but that discards compiler checks.
4611 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4612 const char *fmt, ...)
4616 monitor_vprintf(opaque, fmt, ap);
4620 static void monitor_readline_flush(void *opaque)
4622 monitor_flush(opaque);
4626 * Print to current monitor if we have one, else to stderr.
4627 * TODO should return int, so callers can calculate width, but that
4628 * requires surgery to monitor_vprintf(). Left for another day.
4630 void error_vprintf(const char *fmt, va_list ap)
4632 if (cur_mon && !monitor_cur_is_qmp()) {
4633 monitor_vprintf(cur_mon, fmt, ap);
4635 vfprintf(stderr, fmt, ap);
4639 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4641 if (cur_mon && !monitor_cur_is_qmp()) {
4642 monitor_vprintf(cur_mon, fmt, ap);
4643 } else if (!cur_mon) {
4644 vfprintf(stderr, fmt, ap);
4648 static void monitor_list_append(Monitor *mon)
4650 qemu_mutex_lock(&monitor_lock);
4651 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4652 qemu_mutex_unlock(&monitor_lock);
4655 static void monitor_qmp_setup_handlers_bh(void *opaque)
4657 Monitor *mon = opaque;
4658 GMainContext *context;
4660 if (mon->use_io_thr) {
4662 * When use_io_thr is set, we use the global shared dedicated
4663 * IO thread for this monitor to handle input/output.
4665 context = monitor_get_io_context();
4666 /* We should have inited globals before reaching here. */
4669 /* The default main loop, which is the main thread */
4673 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4674 monitor_qmp_event, NULL, mon, context, true);
4675 monitor_list_append(mon);
4678 void monitor_init(Chardev *chr, int flags)
4680 Monitor *mon = g_malloc(sizeof(*mon));
4681 bool use_readline = flags & MONITOR_USE_READLINE;
4682 bool use_oob = flags & MONITOR_USE_OOB;
4685 if (CHARDEV_IS_MUX(chr)) {
4686 error_report("Monitor Out-Of-Band is not supported with "
4687 "MUX typed chardev backend");
4691 error_report("Monitor Out-Of-band is only supported by QMP");
4696 monitor_data_init(mon, false, use_oob);
4698 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4701 mon->rs = readline_init(monitor_readline_printf,
4702 monitor_readline_flush,
4704 monitor_find_completion);
4705 monitor_read_command(mon, 0);
4708 if (monitor_is_qmp(mon)) {
4709 qemu_chr_fe_set_echo(&mon->chr, true);
4710 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4711 if (mon->use_io_thr) {
4713 * Make sure the old iowatch is gone. It's possible when
4714 * e.g. the chardev is in client mode, with wait=on.
4716 remove_fd_in_watch(chr);
4718 * We can't call qemu_chr_fe_set_handlers() directly here
4719 * since during the procedure the chardev will be active
4720 * and running in monitor iothread, while we'll still do
4721 * something before returning from it, which is a possible
4722 * race too. To avoid that, we just create a BH to setup
4725 aio_bh_schedule_oneshot(monitor_get_aio_context(),
4726 monitor_qmp_setup_handlers_bh, mon);
4727 /* We'll add this to mon_list in the BH when setup done */
4730 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4731 monitor_qmp_read, monitor_qmp_event,
4732 NULL, mon, NULL, true);
4735 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4736 monitor_event, NULL, mon, NULL, true);
4739 monitor_list_append(mon);
4742 void monitor_cleanup(void)
4744 Monitor *mon, *next;
4747 * We need to explicitly stop the iothread (but not destroy it),
4748 * cleanup the monitor resources, then destroy the iothread since
4749 * we need to unregister from chardev below in
4750 * monitor_data_destroy(), and chardev is not thread-safe yet
4752 iothread_stop(mon_global.mon_iothread);
4755 * After we have IOThread to send responses, it's possible that
4756 * when we stop the IOThread there are still replies queued in the
4757 * responder queue. Flush all of them. Note that even after this
4758 * flush it's still possible that out buffer is not flushed.
4759 * It'll be done in below monitor_flush() as the last resort.
4761 monitor_qmp_bh_responder(NULL);
4763 qemu_mutex_lock(&monitor_lock);
4764 QTAILQ_FOREACH_SAFE(mon, &mon_list, entry, next) {
4765 QTAILQ_REMOVE(&mon_list, mon, entry);
4767 monitor_data_destroy(mon);
4770 qemu_mutex_unlock(&monitor_lock);
4772 /* QEMUBHs needs to be deleted before destroying the IOThread. */
4773 qemu_bh_delete(mon_global.qmp_dispatcher_bh);
4774 mon_global.qmp_dispatcher_bh = NULL;
4775 qemu_bh_delete(mon_global.qmp_respond_bh);
4776 mon_global.qmp_respond_bh = NULL;
4778 iothread_destroy(mon_global.mon_iothread);
4779 mon_global.mon_iothread = NULL;
4782 QemuOptsList qemu_mon_opts = {
4784 .implied_opt_name = "chardev",
4785 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4789 .type = QEMU_OPT_STRING,
4792 .type = QEMU_OPT_STRING,
4795 .type = QEMU_OPT_BOOL,
4798 .type = QEMU_OPT_BOOL,
4800 { /* end of list */ }
4805 void qmp_rtc_reset_reinjection(Error **errp)
4807 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4810 SevInfo *qmp_query_sev(Error **errp)
4812 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev");
4816 SevLaunchMeasureInfo *qmp_query_sev_launch_measure(Error **errp)
4818 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-launch-measure");
4822 SevCapability *qmp_query_sev_capabilities(Error **errp)
4824 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-capabilities");
4829 #ifndef TARGET_S390X
4830 void qmp_dump_skeys(const char *filename, Error **errp)
4832 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4837 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4839 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4844 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4846 MachineState *ms = MACHINE(qdev_get_machine());
4847 MachineClass *mc = MACHINE_GET_CLASS(ms);
4849 if (!mc->has_hotpluggable_cpus) {
4850 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4854 return machine_query_hotpluggable_cpus(ms);