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;
545 * Return one QMPResponse. The response is only valid if
546 * response.data is not NULL.
548 static QMPResponse monitor_qmp_response_pop_one(void)
551 QObject *data = NULL;
553 qemu_mutex_lock(&monitor_lock);
554 QTAILQ_FOREACH(mon, &mon_list, entry) {
555 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
556 data = g_queue_pop_head(mon->qmp.qmp_responses);
557 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
562 qemu_mutex_unlock(&monitor_lock);
563 return (QMPResponse) { .mon = mon, .data = data };
566 static void monitor_qmp_bh_responder(void *opaque)
568 QMPResponse response;
571 response = monitor_qmp_response_pop_one();
572 if (!response.data) {
575 monitor_json_emitter_raw(response.mon, response.data);
576 qobject_unref(response.data);
580 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
581 /* Limit guest-triggerable events to 1 per second */
582 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
583 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
584 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
585 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
586 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
587 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
591 * Emits the event to every monitor instance, @event is only used for trace
592 * Called with monitor_lock held.
594 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
598 trace_monitor_protocol_event_emit(event, qdict);
599 QTAILQ_FOREACH(mon, &mon_list, entry) {
600 if (monitor_is_qmp(mon)
601 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
602 monitor_json_emitter(mon, QOBJECT(qdict));
607 static void monitor_qapi_event_handler(void *opaque);
610 * Queue a new event for emission to Monitor instances,
611 * applying any rate limiting if required.
614 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
616 MonitorQAPIEventConf *evconf;
617 MonitorQAPIEventState *evstate;
619 assert(event < QAPI_EVENT__MAX);
620 evconf = &monitor_qapi_event_conf[event];
621 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
623 qemu_mutex_lock(&monitor_lock);
626 /* Unthrottled event */
627 monitor_qapi_event_emit(event, qdict);
629 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
630 MonitorQAPIEventState key = { .event = event, .data = data };
632 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
633 assert(!evstate || timer_pending(evstate->timer));
637 * Timer is pending for (at least) evconf->rate ns after
638 * last send. Store event for sending when timer fires,
639 * replacing a prior stored event if any.
641 qobject_unref(evstate->qdict);
642 evstate->qdict = qobject_ref(qdict);
645 * Last send was (at least) evconf->rate ns ago.
646 * Send immediately, and arm the timer to call
647 * monitor_qapi_event_handler() in evconf->rate ns. Any
648 * events arriving before then will be delayed until then.
650 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
652 monitor_qapi_event_emit(event, qdict);
654 evstate = g_new(MonitorQAPIEventState, 1);
655 evstate->event = event;
656 evstate->data = qobject_ref(data);
657 evstate->qdict = NULL;
658 evstate->timer = timer_new_ns(monitor_get_event_clock(),
659 monitor_qapi_event_handler,
661 g_hash_table_add(monitor_qapi_event_state, evstate);
662 timer_mod_ns(evstate->timer, now + evconf->rate);
666 qemu_mutex_unlock(&monitor_lock);
670 * This function runs evconf->rate ns after sending a throttled
672 * If another event has since been stored, send it.
674 static void monitor_qapi_event_handler(void *opaque)
676 MonitorQAPIEventState *evstate = opaque;
677 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
679 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
680 qemu_mutex_lock(&monitor_lock);
682 if (evstate->qdict) {
683 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
685 monitor_qapi_event_emit(evstate->event, evstate->qdict);
686 qobject_unref(evstate->qdict);
687 evstate->qdict = NULL;
688 timer_mod_ns(evstate->timer, now + evconf->rate);
690 g_hash_table_remove(monitor_qapi_event_state, evstate);
691 qobject_unref(evstate->data);
692 timer_free(evstate->timer);
696 qemu_mutex_unlock(&monitor_lock);
699 static unsigned int qapi_event_throttle_hash(const void *key)
701 const MonitorQAPIEventState *evstate = key;
702 unsigned int hash = evstate->event * 255;
704 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
705 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
708 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
709 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
715 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
717 const MonitorQAPIEventState *eva = a;
718 const MonitorQAPIEventState *evb = b;
720 if (eva->event != evb->event) {
724 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
725 return !strcmp(qdict_get_str(eva->data, "id"),
726 qdict_get_str(evb->data, "id"));
729 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
730 return !strcmp(qdict_get_str(eva->data, "node-name"),
731 qdict_get_str(evb->data, "node-name"));
737 static void monitor_qapi_event_init(void)
739 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
740 qapi_event_throttle_equal);
741 qmp_event_set_func_emit(monitor_qapi_event_queue);
744 static void handle_hmp_command(Monitor *mon, const char *cmdline);
746 static void monitor_data_init(Monitor *mon, bool skip_flush,
749 memset(mon, 0, sizeof(Monitor));
750 qemu_mutex_init(&mon->mon_lock);
751 qemu_mutex_init(&mon->qmp.qmp_queue_lock);
752 mon->outbuf = qstring_new();
753 /* Use *mon_cmds by default. */
754 mon->cmd_table = mon_cmds;
755 mon->skip_flush = skip_flush;
756 mon->use_io_thr = use_io_thr;
757 mon->qmp.qmp_requests = g_queue_new();
758 mon->qmp.qmp_responses = g_queue_new();
761 static void monitor_data_destroy(Monitor *mon)
763 g_free(mon->mon_cpu_path);
764 qemu_chr_fe_deinit(&mon->chr, false);
765 if (monitor_is_qmp(mon)) {
766 json_message_parser_destroy(&mon->qmp.parser);
768 readline_free(mon->rs);
769 qobject_unref(mon->outbuf);
770 qemu_mutex_destroy(&mon->mon_lock);
771 qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
772 monitor_qmp_cleanup_req_queue_locked(mon);
773 monitor_qmp_cleanup_resp_queue_locked(mon);
774 g_queue_free(mon->qmp.qmp_requests);
775 g_queue_free(mon->qmp.qmp_responses);
778 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
779 int64_t cpu_index, Error **errp)
782 Monitor *old_mon, hmp;
784 monitor_data_init(&hmp, true, false);
790 int ret = monitor_set_cpu(cpu_index);
793 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
799 handle_hmp_command(&hmp, command_line);
802 qemu_mutex_lock(&hmp.mon_lock);
803 if (qstring_get_length(hmp.outbuf) > 0) {
804 output = g_strdup(qstring_get_str(hmp.outbuf));
806 output = g_strdup("");
808 qemu_mutex_unlock(&hmp.mon_lock);
811 monitor_data_destroy(&hmp);
815 static int compare_cmd(const char *name, const char *list)
817 const char *p, *pstart;
825 p = pstart + strlen(pstart);
826 if ((p - pstart) == len && !memcmp(pstart, name, len))
835 static int get_str(char *buf, int buf_size, const char **pp)
843 while (qemu_isspace(*p)) {
854 while (*p != '\0' && *p != '\"') {
870 printf("unsupported escape code: '\\%c'\n", c);
873 if ((q - buf) < buf_size - 1) {
877 if ((q - buf) < buf_size - 1) {
884 printf("unterminated string\n");
889 while (*p != '\0' && !qemu_isspace(*p)) {
890 if ((q - buf) < buf_size - 1) {
903 static void free_cmdline_args(char **args, int nb_args)
907 assert(nb_args <= MAX_ARGS);
909 for (i = 0; i < nb_args; i++) {
916 * Parse the command line to get valid args.
917 * @cmdline: command line to be parsed.
918 * @pnb_args: location to store the number of args, must NOT be NULL.
919 * @args: location to store the args, which should be freed by caller, must
922 * Returns 0 on success, negative on failure.
924 * NOTE: this parser is an approximate form of the real command parser. Number
925 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
926 * return with failure.
928 static int parse_cmdline(const char *cmdline,
929 int *pnb_args, char **args)
938 while (qemu_isspace(*p)) {
944 if (nb_args >= MAX_ARGS) {
947 ret = get_str(buf, sizeof(buf), &p);
951 args[nb_args] = g_strdup(buf);
958 free_cmdline_args(args, nb_args);
963 * Returns true if the command can be executed in preconfig mode
964 * i.e. it has the 'p' flag.
966 static bool cmd_can_preconfig(const mon_cmd_t *cmd)
972 return strchr(cmd->flags, 'p');
975 static void help_cmd_dump_one(Monitor *mon,
976 const mon_cmd_t *cmd,
982 for (i = 0; i < prefix_args_nb; i++) {
983 monitor_printf(mon, "%s ", prefix_args[i]);
985 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
988 /* @args[@arg_index] is the valid command need to find in @cmds */
989 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
990 char **args, int nb_args, int arg_index)
992 const mon_cmd_t *cmd;
994 /* No valid arg need to compare with, dump all in *cmds */
995 if (arg_index >= nb_args) {
996 for (cmd = cmds; cmd->name != NULL; cmd++) {
997 help_cmd_dump_one(mon, cmd, args, arg_index);
1002 /* Find one entry to dump */
1003 for (cmd = cmds; cmd->name != NULL; cmd++) {
1004 if (compare_cmd(args[arg_index], cmd->name)) {
1005 if (cmd->sub_table) {
1006 /* continue with next arg */
1007 help_cmd_dump(mon, cmd->sub_table,
1008 args, nb_args, arg_index + 1);
1010 help_cmd_dump_one(mon, cmd, args, arg_index);
1017 static void help_cmd(Monitor *mon, const char *name)
1019 char *args[MAX_ARGS];
1022 /* 1. parse user input */
1024 /* special case for log, directly dump and return */
1025 if (!strcmp(name, "log")) {
1026 const QEMULogItem *item;
1027 monitor_printf(mon, "Log items (comma separated):\n");
1028 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
1029 for (item = qemu_log_items; item->mask != 0; item++) {
1030 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
1035 if (parse_cmdline(name, &nb_args, args) < 0) {
1040 /* 2. dump the contents according to parsed args */
1041 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
1043 free_cmdline_args(args, nb_args);
1046 static void do_help_cmd(Monitor *mon, const QDict *qdict)
1048 help_cmd(mon, qdict_get_try_str(qdict, "name"));
1051 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
1053 const char *tp_name = qdict_get_str(qdict, "name");
1054 bool new_state = qdict_get_bool(qdict, "option");
1055 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1056 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1057 Error *local_err = NULL;
1060 monitor_printf(mon, "argument vcpu must be positive");
1064 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
1066 error_report_err(local_err);
1070 #ifdef CONFIG_TRACE_SIMPLE
1071 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
1073 const char *op = qdict_get_try_str(qdict, "op");
1074 const char *arg = qdict_get_try_str(qdict, "arg");
1077 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
1078 } else if (!strcmp(op, "on")) {
1079 st_set_trace_file_enabled(true);
1080 } else if (!strcmp(op, "off")) {
1081 st_set_trace_file_enabled(false);
1082 } else if (!strcmp(op, "flush")) {
1083 st_flush_trace_buffer();
1084 } else if (!strcmp(op, "set")) {
1086 st_set_trace_file(arg);
1089 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
1090 help_cmd(mon, "trace-file");
1095 static void hmp_info_help(Monitor *mon, const QDict *qdict)
1097 help_cmd(mon, "info");
1100 static void query_commands_cb(QmpCommand *cmd, void *opaque)
1102 CommandInfoList *info, **list = opaque;
1104 if (!cmd->enabled) {
1108 info = g_malloc0(sizeof(*info));
1109 info->value = g_malloc0(sizeof(*info->value));
1110 info->value->name = g_strdup(cmd->name);
1115 CommandInfoList *qmp_query_commands(Error **errp)
1117 CommandInfoList *list = NULL;
1119 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
1124 EventInfoList *qmp_query_events(Error **errp)
1126 EventInfoList *info, *ev_list = NULL;
1129 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
1130 const char *event_name = QAPIEvent_str(e);
1131 assert(event_name != NULL);
1132 info = g_malloc0(sizeof(*info));
1133 info->value = g_malloc0(sizeof(*info->value));
1134 info->value->name = g_strdup(event_name);
1136 info->next = ev_list;
1144 * Minor hack: generated marshalling suppressed for this command
1145 * ('gen': false in the schema) so we can parse the JSON string
1146 * directly into QObject instead of first parsing it with
1147 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
1148 * to QObject with generated output marshallers, every time. Instead,
1149 * we do it in test-qobject-input-visitor.c, just to make sure
1150 * qapi-gen.py's output actually conforms to the schema.
1152 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
1155 *ret_data = qobject_from_qlit(&qmp_schema_qlit);
1159 * We used to define commands in qmp-commands.hx in addition to the
1160 * QAPI schema. This permitted defining some of them only in certain
1161 * configurations. query-commands has always reflected that (good,
1162 * because it lets QMP clients figure out what's actually available),
1163 * while query-qmp-schema never did (not so good). This function is a
1164 * hack to keep the configuration-specific commands defined exactly as
1165 * before, even though qmp-commands.hx is gone.
1167 * FIXME Educate the QAPI schema on configuration-specific commands,
1168 * and drop this hack.
1170 static void qmp_unregister_commands_hack(void)
1172 #ifndef CONFIG_SPICE
1173 qmp_unregister_command(&qmp_commands, "query-spice");
1175 #ifndef CONFIG_REPLICATION
1176 qmp_unregister_command(&qmp_commands, "xen-set-replication");
1177 qmp_unregister_command(&qmp_commands, "query-xen-replication-status");
1178 qmp_unregister_command(&qmp_commands, "xen-colo-do-checkpoint");
1181 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
1182 qmp_unregister_command(&qmp_commands, "query-sev");
1183 qmp_unregister_command(&qmp_commands, "query-sev-launch-measure");
1184 qmp_unregister_command(&qmp_commands, "query-sev-capabilities");
1186 #ifndef TARGET_S390X
1187 qmp_unregister_command(&qmp_commands, "dump-skeys");
1190 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
1192 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
1193 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
1195 #if !defined(TARGET_S390X)
1196 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
1197 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
1199 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
1200 && !defined(TARGET_S390X)
1201 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
1205 static void monitor_init_qmp_commands(void)
1208 * Two command lists:
1209 * - qmp_commands contains all QMP commands
1210 * - qmp_cap_negotiation_commands contains just
1211 * "qmp_capabilities", to enforce capability negotiation
1214 qmp_init_marshal(&qmp_commands);
1216 qmp_register_command(&qmp_commands, "query-qmp-schema",
1217 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
1218 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1220 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1223 qmp_unregister_commands_hack();
1225 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1226 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1227 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
1230 static bool qmp_cap_enabled(Monitor *mon, QMPCapability cap)
1232 return mon->qmp.qmp_caps[cap];
1235 static bool qmp_oob_enabled(Monitor *mon)
1237 return qmp_cap_enabled(mon, QMP_CAPABILITY_OOB);
1240 static void qmp_caps_check(Monitor *mon, QMPCapabilityList *list,
1243 for (; list; list = list->next) {
1244 assert(list->value < QMP_CAPABILITY__MAX);
1245 switch (list->value) {
1246 case QMP_CAPABILITY_OOB:
1247 if (!mon->use_io_thr) {
1249 * Out-Of-Band only works with monitors that are
1250 * running on dedicated IOThread.
1252 error_setg(errp, "This monitor does not support "
1253 "Out-Of-Band (OOB)");
1263 /* This function should only be called after capabilities are checked. */
1264 static void qmp_caps_apply(Monitor *mon, QMPCapabilityList *list)
1266 for (; list; list = list->next) {
1267 mon->qmp.qmp_caps[list->value] = true;
1272 * Return true if check successful, or false otherwise. When false is
1273 * returned, detailed error will be in errp if provided.
1275 static bool qmp_cmd_oob_check(Monitor *mon, QDict *req, Error **errp)
1277 const char *command;
1280 command = qdict_get_try_str(req, "execute");
1282 error_setg(errp, "Command field 'execute' missing");
1286 cmd = qmp_find_command(mon->qmp.commands, command);
1288 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
1289 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1290 "Expecting capabilities negotiation "
1291 "with 'qmp_capabilities'");
1293 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1294 "The command %s has not been found", command);
1299 if (qmp_is_oob(req)) {
1300 if (!qmp_oob_enabled(mon)) {
1301 error_setg(errp, "Please enable Out-Of-Band first "
1302 "for the session during capabilities negotiation");
1305 if (!(cmd->options & QCO_ALLOW_OOB)) {
1306 error_setg(errp, "The command %s does not support OOB",
1315 void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
1318 Error *local_err = NULL;
1320 if (cur_mon->qmp.commands == &qmp_commands) {
1321 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1322 "Capabilities negotiation is already complete, command "
1327 /* Enable QMP capabilities provided by the client if applicable. */
1329 qmp_caps_check(cur_mon, enable, &local_err);
1332 * Failed check on any of the capabilities will fail the
1333 * entire command (and thus not apply any of the other
1334 * capabilities that were also requested).
1336 error_propagate(errp, local_err);
1339 qmp_caps_apply(cur_mon, enable);
1342 cur_mon->qmp.commands = &qmp_commands;
1345 /* Set the current CPU defined by the user. Callers must hold BQL. */
1346 int monitor_set_cpu(int cpu_index)
1350 cpu = qemu_get_cpu(cpu_index);
1354 g_free(cur_mon->mon_cpu_path);
1355 cur_mon->mon_cpu_path = object_get_canonical_path(OBJECT(cpu));
1359 /* Callers must hold BQL. */
1360 static CPUState *mon_get_cpu_sync(bool synchronize)
1364 if (cur_mon->mon_cpu_path) {
1365 cpu = (CPUState *) object_resolve_path_type(cur_mon->mon_cpu_path,
1368 g_free(cur_mon->mon_cpu_path);
1369 cur_mon->mon_cpu_path = NULL;
1372 if (!cur_mon->mon_cpu_path) {
1376 monitor_set_cpu(first_cpu->cpu_index);
1380 cpu_synchronize_state(cpu);
1385 CPUState *mon_get_cpu(void)
1387 return mon_get_cpu_sync(true);
1390 CPUArchState *mon_get_cpu_env(void)
1392 CPUState *cs = mon_get_cpu();
1394 return cs ? cs->env_ptr : NULL;
1397 int monitor_get_cpu_index(void)
1399 CPUState *cs = mon_get_cpu_sync(false);
1401 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1404 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1406 bool all_cpus = qdict_get_try_bool(qdict, "cpustate_all", false);
1411 monitor_printf(mon, "\nCPU#%d\n", cs->cpu_index);
1412 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1418 monitor_printf(mon, "No CPU available\n");
1422 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1427 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1429 if (!tcg_enabled()) {
1430 error_report("JIT information is only available with accel=tcg");
1434 dump_exec_info((FILE *)mon, monitor_fprintf);
1435 dump_drift_info((FILE *)mon, monitor_fprintf);
1438 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1440 dump_opcount_info((FILE *)mon, monitor_fprintf);
1444 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1453 str = readline_get_history(mon->rs, i);
1456 monitor_printf(mon, "%d: '%s'\n", i, str);
1461 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1463 CPUState *cs = mon_get_cpu();
1466 monitor_printf(mon, "No CPU available\n");
1469 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1472 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1474 const char *name = qdict_get_try_str(qdict, "name");
1475 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1476 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1477 TraceEventInfoList *events;
1478 TraceEventInfoList *elem;
1479 Error *local_err = NULL;
1485 monitor_printf(mon, "argument vcpu must be positive");
1489 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1491 error_report_err(local_err);
1495 for (elem = events; elem != NULL; elem = elem->next) {
1496 monitor_printf(mon, "%s : state %u\n",
1498 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1500 qapi_free_TraceEventInfoList(events);
1503 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1504 bool has_port, int64_t port,
1505 bool has_tls_port, int64_t tls_port,
1506 bool has_cert_subject, const char *cert_subject,
1509 if (strcmp(protocol, "spice") == 0) {
1510 if (!qemu_using_spice(errp)) {
1514 if (!has_port && !has_tls_port) {
1515 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1519 if (qemu_spice_migrate_info(hostname,
1520 has_port ? port : -1,
1521 has_tls_port ? tls_port : -1,
1523 error_setg(errp, QERR_UNDEFINED_ERROR);
1529 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1532 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1536 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1538 error_report_err(err);
1542 static void hmp_log(Monitor *mon, const QDict *qdict)
1545 const char *items = qdict_get_str(qdict, "items");
1547 if (!strcmp(items, "none")) {
1550 mask = qemu_str_to_log_mask(items);
1552 help_cmd(mon, "log");
1559 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1561 const char *option = qdict_get_try_str(qdict, "option");
1562 if (!option || !strcmp(option, "on")) {
1564 } else if (!strcmp(option, "off")) {
1567 monitor_printf(mon, "unexpected option %s\n", option);
1571 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1573 const char *device = qdict_get_try_str(qdict, "device");
1575 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1576 if (gdbserver_start(device) < 0) {
1577 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1579 } else if (strcmp(device, "none") == 0) {
1580 monitor_printf(mon, "Disabled gdbserver\n");
1582 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1587 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1589 const char *action = qdict_get_str(qdict, "action");
1590 if (select_watchdog_action(action) == -1) {
1591 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1595 static void monitor_printc(Monitor *mon, int c)
1597 monitor_printf(mon, "'");
1600 monitor_printf(mon, "\\'");
1603 monitor_printf(mon, "\\\\");
1606 monitor_printf(mon, "\\n");
1609 monitor_printf(mon, "\\r");
1612 if (c >= 32 && c <= 126) {
1613 monitor_printf(mon, "%c", c);
1615 monitor_printf(mon, "\\x%02x", c);
1619 monitor_printf(mon, "'");
1622 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1623 hwaddr addr, int is_physical)
1625 int l, line_size, i, max_digits, len;
1628 CPUState *cs = mon_get_cpu();
1630 if (!cs && (format == 'i' || !is_physical)) {
1631 monitor_printf(mon, "Can not dump without CPU\n");
1635 if (format == 'i') {
1636 monitor_disas(mon, cs, addr, count, is_physical);
1640 len = wsize * count;
1649 max_digits = DIV_ROUND_UP(wsize * 8, 3);
1653 max_digits = (wsize * 8) / 4;
1657 max_digits = DIV_ROUND_UP(wsize * 8 * 10, 33);
1666 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1668 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1673 cpu_physical_memory_read(addr, buf, l);
1675 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1676 monitor_printf(mon, " Cannot access memory\n");
1685 v = ldub_p(buf + i);
1688 v = lduw_p(buf + i);
1691 v = (uint32_t)ldl_p(buf + i);
1697 monitor_printf(mon, " ");
1700 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1703 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1706 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1709 monitor_printf(mon, "%*" PRId64, max_digits, v);
1712 monitor_printc(mon, v);
1717 monitor_printf(mon, "\n");
1723 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1725 int count = qdict_get_int(qdict, "count");
1726 int format = qdict_get_int(qdict, "format");
1727 int size = qdict_get_int(qdict, "size");
1728 target_long addr = qdict_get_int(qdict, "addr");
1730 memory_dump(mon, count, format, size, addr, 0);
1733 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1735 int count = qdict_get_int(qdict, "count");
1736 int format = qdict_get_int(qdict, "format");
1737 int size = qdict_get_int(qdict, "size");
1738 hwaddr addr = qdict_get_int(qdict, "addr");
1740 memory_dump(mon, count, format, size, addr, 1);
1743 static void *gpa2hva(MemoryRegion **p_mr, hwaddr addr, Error **errp)
1745 MemoryRegionSection mrs = memory_region_find(get_system_memory(),
1749 error_setg(errp, "No memory is mapped at address 0x%" HWADDR_PRIx, addr);
1753 if (!memory_region_is_ram(mrs.mr) && !memory_region_is_romd(mrs.mr)) {
1754 error_setg(errp, "Memory at address 0x%" HWADDR_PRIx "is not RAM", addr);
1755 memory_region_unref(mrs.mr);
1760 return qemu_map_ram_ptr(mrs.mr->ram_block, mrs.offset_within_region);
1763 static void hmp_gpa2hva(Monitor *mon, const QDict *qdict)
1765 hwaddr addr = qdict_get_int(qdict, "addr");
1766 Error *local_err = NULL;
1767 MemoryRegion *mr = NULL;
1770 ptr = gpa2hva(&mr, addr, &local_err);
1772 error_report_err(local_err);
1776 monitor_printf(mon, "Host virtual address for 0x%" HWADDR_PRIx
1778 addr, mr->name, ptr);
1780 memory_region_unref(mr);
1784 static uint64_t vtop(void *ptr, Error **errp)
1788 uintptr_t addr = (uintptr_t) ptr;
1789 uintptr_t pagesize = getpagesize();
1790 off_t offset = addr / pagesize * sizeof(pinfo);
1793 fd = open("/proc/self/pagemap", O_RDONLY);
1795 error_setg_errno(errp, errno, "Cannot open /proc/self/pagemap");
1799 /* Force copy-on-write if necessary. */
1800 atomic_add((uint8_t *)ptr, 0);
1802 if (pread(fd, &pinfo, sizeof(pinfo), offset) != sizeof(pinfo)) {
1803 error_setg_errno(errp, errno, "Cannot read pagemap");
1806 if ((pinfo & (1ull << 63)) == 0) {
1807 error_setg(errp, "Page not present");
1810 ret = ((pinfo & 0x007fffffffffffffull) * pagesize) | (addr & (pagesize - 1));
1817 static void hmp_gpa2hpa(Monitor *mon, const QDict *qdict)
1819 hwaddr addr = qdict_get_int(qdict, "addr");
1820 Error *local_err = NULL;
1821 MemoryRegion *mr = NULL;
1825 ptr = gpa2hva(&mr, addr, &local_err);
1827 error_report_err(local_err);
1831 physaddr = vtop(ptr, &local_err);
1833 error_report_err(local_err);
1835 monitor_printf(mon, "Host physical address for 0x%" HWADDR_PRIx
1836 " (%s) is 0x%" PRIx64 "\n",
1837 addr, mr->name, (uint64_t) physaddr);
1840 memory_region_unref(mr);
1844 static void do_print(Monitor *mon, const QDict *qdict)
1846 int format = qdict_get_int(qdict, "format");
1847 hwaddr val = qdict_get_int(qdict, "val");
1851 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1854 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1857 monitor_printf(mon, "%" HWADDR_PRIu, val);
1861 monitor_printf(mon, "%" HWADDR_PRId, val);
1864 monitor_printc(mon, val);
1867 monitor_printf(mon, "\n");
1870 static void hmp_sum(Monitor *mon, const QDict *qdict)
1874 uint32_t start = qdict_get_int(qdict, "start");
1875 uint32_t size = qdict_get_int(qdict, "size");
1878 for(addr = start; addr < (start + size); addr++) {
1879 uint8_t val = address_space_ldub(&address_space_memory, addr,
1880 MEMTXATTRS_UNSPECIFIED, NULL);
1881 /* BSD sum algorithm ('sum' Unix command) */
1882 sum = (sum >> 1) | (sum << 15);
1885 monitor_printf(mon, "%05d\n", sum);
1888 static int mouse_button_state;
1890 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1892 int dx, dy, dz, button;
1893 const char *dx_str = qdict_get_str(qdict, "dx_str");
1894 const char *dy_str = qdict_get_str(qdict, "dy_str");
1895 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1897 dx = strtol(dx_str, NULL, 0);
1898 dy = strtol(dy_str, NULL, 0);
1899 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1900 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1903 dz = strtol(dz_str, NULL, 0);
1905 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1906 qemu_input_queue_btn(NULL, button, true);
1907 qemu_input_event_sync();
1908 qemu_input_queue_btn(NULL, button, false);
1911 qemu_input_event_sync();
1914 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1916 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1917 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1918 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1919 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1921 int button_state = qdict_get_int(qdict, "button_state");
1923 if (mouse_button_state == button_state) {
1926 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1927 qemu_input_event_sync();
1928 mouse_button_state = button_state;
1931 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1933 int size = qdict_get_int(qdict, "size");
1934 int addr = qdict_get_int(qdict, "addr");
1935 int has_index = qdict_haskey(qdict, "index");
1940 int index = qdict_get_int(qdict, "index");
1941 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1949 val = cpu_inb(addr);
1953 val = cpu_inw(addr);
1957 val = cpu_inl(addr);
1961 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1962 suffix, addr, size * 2, val);
1965 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1967 int size = qdict_get_int(qdict, "size");
1968 int addr = qdict_get_int(qdict, "addr");
1969 int val = qdict_get_int(qdict, "val");
1971 addr &= IOPORTS_MASK;
1976 cpu_outb(addr, val);
1979 cpu_outw(addr, val);
1982 cpu_outl(addr, val);
1987 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1989 Error *local_err = NULL;
1990 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1992 qemu_boot_set(bootdevice, &local_err);
1994 error_report_err(local_err);
1996 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
2000 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
2002 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
2003 bool dispatch_tree = qdict_get_try_bool(qdict, "dispatch_tree", false);
2005 mtree_info((fprintf_function)monitor_printf, mon, flatview, dispatch_tree);
2008 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
2011 NumaNodeMem *node_mem;
2012 CpuInfoList *cpu_list, *cpu;
2014 cpu_list = qmp_query_cpus(&error_abort);
2015 node_mem = g_new0(NumaNodeMem, nb_numa_nodes);
2017 query_numa_node_mem(node_mem);
2018 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
2019 for (i = 0; i < nb_numa_nodes; i++) {
2020 monitor_printf(mon, "node %d cpus:", i);
2021 for (cpu = cpu_list; cpu; cpu = cpu->next) {
2022 if (cpu->value->has_props && cpu->value->props->has_node_id &&
2023 cpu->value->props->node_id == i) {
2024 monitor_printf(mon, " %" PRIi64, cpu->value->CPU);
2027 monitor_printf(mon, "\n");
2028 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
2029 node_mem[i].node_mem >> 20);
2030 monitor_printf(mon, "node %d plugged: %" PRId64 " MB\n", i,
2031 node_mem[i].node_plugged_mem >> 20);
2033 qapi_free_CpuInfoList(cpu_list);
2037 #ifdef CONFIG_PROFILER
2042 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2044 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
2045 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
2046 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
2047 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
2052 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
2054 monitor_printf(mon, "Internal profiler not compiled\n");
2058 /* Capture support */
2059 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
2061 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
2066 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2067 monitor_printf(mon, "[%d]: ", i);
2068 s->ops.info (s->opaque);
2072 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
2075 int n = qdict_get_int(qdict, "n");
2078 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
2080 s->ops.destroy (s->opaque);
2081 QLIST_REMOVE (s, entries);
2088 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
2090 const char *path = qdict_get_str(qdict, "path");
2091 int has_freq = qdict_haskey(qdict, "freq");
2092 int freq = qdict_get_try_int(qdict, "freq", -1);
2093 int has_bits = qdict_haskey(qdict, "bits");
2094 int bits = qdict_get_try_int(qdict, "bits", -1);
2095 int has_channels = qdict_haskey(qdict, "nchannels");
2096 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
2099 s = g_malloc0 (sizeof (*s));
2101 freq = has_freq ? freq : 44100;
2102 bits = has_bits ? bits : 16;
2103 nchannels = has_channels ? nchannels : 2;
2105 if (wav_start_capture (s, path, freq, bits, nchannels)) {
2106 monitor_printf(mon, "Failed to add wave capture\n");
2110 QLIST_INSERT_HEAD (&capture_head, s, entries);
2113 static qemu_acl *find_acl(Monitor *mon, const char *name)
2115 qemu_acl *acl = qemu_acl_find(name);
2118 monitor_printf(mon, "acl: unknown list '%s'\n", name);
2123 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
2125 const char *aclname = qdict_get_str(qdict, "aclname");
2126 qemu_acl *acl = find_acl(mon, aclname);
2127 qemu_acl_entry *entry;
2131 monitor_printf(mon, "policy: %s\n",
2132 acl->defaultDeny ? "deny" : "allow");
2133 QTAILQ_FOREACH(entry, &acl->entries, next) {
2135 monitor_printf(mon, "%d: %s %s\n", i,
2136 entry->deny ? "deny" : "allow", entry->match);
2141 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
2143 const char *aclname = qdict_get_str(qdict, "aclname");
2144 qemu_acl *acl = find_acl(mon, aclname);
2147 qemu_acl_reset(acl);
2148 monitor_printf(mon, "acl: removed all rules\n");
2152 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
2154 const char *aclname = qdict_get_str(qdict, "aclname");
2155 const char *policy = qdict_get_str(qdict, "policy");
2156 qemu_acl *acl = find_acl(mon, aclname);
2159 if (strcmp(policy, "allow") == 0) {
2160 acl->defaultDeny = 0;
2161 monitor_printf(mon, "acl: policy set to 'allow'\n");
2162 } else if (strcmp(policy, "deny") == 0) {
2163 acl->defaultDeny = 1;
2164 monitor_printf(mon, "acl: policy set to 'deny'\n");
2166 monitor_printf(mon, "acl: unknown policy '%s', "
2167 "expected 'deny' or 'allow'\n", policy);
2172 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
2174 const char *aclname = qdict_get_str(qdict, "aclname");
2175 const char *match = qdict_get_str(qdict, "match");
2176 const char *policy = qdict_get_str(qdict, "policy");
2177 int has_index = qdict_haskey(qdict, "index");
2178 int index = qdict_get_try_int(qdict, "index", -1);
2179 qemu_acl *acl = find_acl(mon, aclname);
2183 if (strcmp(policy, "allow") == 0) {
2185 } else if (strcmp(policy, "deny") == 0) {
2188 monitor_printf(mon, "acl: unknown policy '%s', "
2189 "expected 'deny' or 'allow'\n", policy);
2193 ret = qemu_acl_insert(acl, deny, match, index);
2195 ret = qemu_acl_append(acl, deny, match);
2197 monitor_printf(mon, "acl: unable to add acl entry\n");
2199 monitor_printf(mon, "acl: added rule at position %d\n", ret);
2203 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
2205 const char *aclname = qdict_get_str(qdict, "aclname");
2206 const char *match = qdict_get_str(qdict, "match");
2207 qemu_acl *acl = find_acl(mon, aclname);
2211 ret = qemu_acl_remove(acl, match);
2213 monitor_printf(mon, "acl: no matching acl entry\n");
2215 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
2219 void qmp_getfd(const char *fdname, Error **errp)
2224 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
2226 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2230 if (qemu_isdigit(fdname[0])) {
2232 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
2233 "a name not starting with a digit");
2237 qemu_mutex_lock(&cur_mon->mon_lock);
2238 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2239 if (strcmp(monfd->name, fdname) != 0) {
2245 qemu_mutex_unlock(&cur_mon->mon_lock);
2246 /* Make sure close() is out of critical section */
2251 monfd = g_malloc0(sizeof(mon_fd_t));
2252 monfd->name = g_strdup(fdname);
2255 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
2256 qemu_mutex_unlock(&cur_mon->mon_lock);
2259 void qmp_closefd(const char *fdname, Error **errp)
2264 qemu_mutex_lock(&cur_mon->mon_lock);
2265 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
2266 if (strcmp(monfd->name, fdname) != 0) {
2270 QLIST_REMOVE(monfd, next);
2272 g_free(monfd->name);
2274 qemu_mutex_unlock(&cur_mon->mon_lock);
2275 /* Make sure close() is out of critical section */
2280 qemu_mutex_unlock(&cur_mon->mon_lock);
2281 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
2284 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
2288 qemu_mutex_lock(&mon->mon_lock);
2289 QLIST_FOREACH(monfd, &mon->fds, next) {
2292 if (strcmp(monfd->name, fdname) != 0) {
2298 /* caller takes ownership of fd */
2299 QLIST_REMOVE(monfd, next);
2300 g_free(monfd->name);
2302 qemu_mutex_unlock(&mon->mon_lock);
2307 qemu_mutex_unlock(&mon->mon_lock);
2308 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
2312 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
2314 MonFdsetFd *mon_fdset_fd;
2315 MonFdsetFd *mon_fdset_fd_next;
2317 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
2318 if ((mon_fdset_fd->removed ||
2319 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
2320 runstate_is_running()) {
2321 close(mon_fdset_fd->fd);
2322 g_free(mon_fdset_fd->opaque);
2323 QLIST_REMOVE(mon_fdset_fd, next);
2324 g_free(mon_fdset_fd);
2328 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
2329 QLIST_REMOVE(mon_fdset, next);
2334 static void monitor_fdsets_cleanup(void)
2336 MonFdset *mon_fdset;
2337 MonFdset *mon_fdset_next;
2339 qemu_mutex_lock(&mon_fdsets_lock);
2340 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
2341 monitor_fdset_cleanup(mon_fdset);
2343 qemu_mutex_unlock(&mon_fdsets_lock);
2346 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
2347 const char *opaque, Error **errp)
2350 Monitor *mon = cur_mon;
2353 fd = qemu_chr_fe_get_msgfd(&mon->chr);
2355 error_setg(errp, QERR_FD_NOT_SUPPLIED);
2359 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
2360 has_opaque, opaque, errp);
2372 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
2374 MonFdset *mon_fdset;
2375 MonFdsetFd *mon_fdset_fd;
2378 qemu_mutex_lock(&mon_fdsets_lock);
2379 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2380 if (mon_fdset->id != fdset_id) {
2383 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2385 if (mon_fdset_fd->fd != fd) {
2388 mon_fdset_fd->removed = true;
2391 mon_fdset_fd->removed = true;
2394 if (has_fd && !mon_fdset_fd) {
2397 monitor_fdset_cleanup(mon_fdset);
2398 qemu_mutex_unlock(&mon_fdsets_lock);
2403 qemu_mutex_unlock(&mon_fdsets_lock);
2405 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
2408 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
2410 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
2413 FdsetInfoList *qmp_query_fdsets(Error **errp)
2415 MonFdset *mon_fdset;
2416 MonFdsetFd *mon_fdset_fd;
2417 FdsetInfoList *fdset_list = NULL;
2419 qemu_mutex_lock(&mon_fdsets_lock);
2420 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2421 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
2422 FdsetFdInfoList *fdsetfd_list = NULL;
2424 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
2425 fdset_info->value->fdset_id = mon_fdset->id;
2427 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2428 FdsetFdInfoList *fdsetfd_info;
2430 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
2431 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
2432 fdsetfd_info->value->fd = mon_fdset_fd->fd;
2433 if (mon_fdset_fd->opaque) {
2434 fdsetfd_info->value->has_opaque = true;
2435 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2437 fdsetfd_info->value->has_opaque = false;
2440 fdsetfd_info->next = fdsetfd_list;
2441 fdsetfd_list = fdsetfd_info;
2444 fdset_info->value->fds = fdsetfd_list;
2446 fdset_info->next = fdset_list;
2447 fdset_list = fdset_info;
2449 qemu_mutex_unlock(&mon_fdsets_lock);
2454 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2455 bool has_opaque, const char *opaque,
2458 MonFdset *mon_fdset = NULL;
2459 MonFdsetFd *mon_fdset_fd;
2462 qemu_mutex_lock(&mon_fdsets_lock);
2464 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2465 /* Break if match found or match impossible due to ordering by ID */
2466 if (fdset_id <= mon_fdset->id) {
2467 if (fdset_id < mon_fdset->id) {
2475 if (mon_fdset == NULL) {
2476 int64_t fdset_id_prev = -1;
2477 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2481 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2482 "a non-negative value");
2483 qemu_mutex_unlock(&mon_fdsets_lock);
2486 /* Use specified fdset ID */
2487 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2488 mon_fdset_cur = mon_fdset;
2489 if (fdset_id < mon_fdset_cur->id) {
2494 /* Use first available fdset ID */
2495 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2496 mon_fdset_cur = mon_fdset;
2497 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2498 fdset_id_prev = mon_fdset_cur->id;
2505 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2507 mon_fdset->id = fdset_id;
2509 mon_fdset->id = fdset_id_prev + 1;
2512 /* The fdset list is ordered by fdset ID */
2513 if (!mon_fdset_cur) {
2514 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2515 } else if (mon_fdset->id < mon_fdset_cur->id) {
2516 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2518 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2522 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2523 mon_fdset_fd->fd = fd;
2524 mon_fdset_fd->removed = false;
2526 mon_fdset_fd->opaque = g_strdup(opaque);
2528 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2530 fdinfo = g_malloc0(sizeof(*fdinfo));
2531 fdinfo->fdset_id = mon_fdset->id;
2532 fdinfo->fd = mon_fdset_fd->fd;
2534 qemu_mutex_unlock(&mon_fdsets_lock);
2538 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2543 MonFdset *mon_fdset;
2544 MonFdsetFd *mon_fdset_fd;
2548 qemu_mutex_lock(&mon_fdsets_lock);
2549 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2550 if (mon_fdset->id != fdset_id) {
2553 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2554 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2555 if (mon_fd_flags == -1) {
2560 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2561 ret = mon_fdset_fd->fd;
2571 qemu_mutex_unlock(&mon_fdsets_lock);
2576 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2578 MonFdset *mon_fdset;
2579 MonFdsetFd *mon_fdset_fd_dup;
2581 qemu_mutex_lock(&mon_fdsets_lock);
2582 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2583 if (mon_fdset->id != fdset_id) {
2586 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2587 if (mon_fdset_fd_dup->fd == dup_fd) {
2591 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2592 mon_fdset_fd_dup->fd = dup_fd;
2593 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2594 qemu_mutex_unlock(&mon_fdsets_lock);
2599 qemu_mutex_unlock(&mon_fdsets_lock);
2603 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2605 MonFdset *mon_fdset;
2606 MonFdsetFd *mon_fdset_fd_dup;
2608 qemu_mutex_lock(&mon_fdsets_lock);
2609 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2610 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2611 if (mon_fdset_fd_dup->fd == dup_fd) {
2613 QLIST_REMOVE(mon_fdset_fd_dup, next);
2614 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2615 monitor_fdset_cleanup(mon_fdset);
2619 qemu_mutex_unlock(&mon_fdsets_lock);
2620 return mon_fdset->id;
2627 qemu_mutex_unlock(&mon_fdsets_lock);
2631 int monitor_fdset_dup_fd_find(int dup_fd)
2633 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2636 void monitor_fdset_dup_fd_remove(int dup_fd)
2638 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2641 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2644 Error *local_err = NULL;
2646 if (!qemu_isdigit(fdname[0]) && mon) {
2647 fd = monitor_get_fd(mon, fdname, &local_err);
2649 fd = qemu_parse_fd(fdname);
2651 error_setg(&local_err, "Invalid file descriptor number '%s'",
2656 error_propagate(errp, local_err);
2665 /* Please update hmp-commands.hx when adding or changing commands */
2666 static mon_cmd_t info_cmds[] = {
2667 #include "hmp-commands-info.h"
2671 /* mon_cmds and info_cmds would be sorted at runtime */
2672 static mon_cmd_t mon_cmds[] = {
2673 #include "hmp-commands.h"
2677 /*******************************************************************/
2679 static const char *pch;
2680 static sigjmp_buf expr_env;
2683 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2684 expr_error(Monitor *mon, const char *fmt, ...)
2688 monitor_vprintf(mon, fmt, ap);
2689 monitor_printf(mon, "\n");
2691 siglongjmp(expr_env, 1);
2694 /* return 0 if OK, -1 if not found */
2695 static int get_monitor_def(target_long *pval, const char *name)
2697 const MonitorDef *md = target_monitor_defs();
2698 CPUState *cs = mon_get_cpu();
2703 if (cs == NULL || md == NULL) {
2707 for(; md->name != NULL; md++) {
2708 if (compare_cmd(name, md->name)) {
2709 if (md->get_value) {
2710 *pval = md->get_value(md, md->offset);
2712 CPUArchState *env = mon_get_cpu_env();
2713 ptr = (uint8_t *)env + md->offset;
2716 *pval = *(int32_t *)ptr;
2719 *pval = *(target_long *)ptr;
2730 ret = target_get_monitor_def(cs, name, &tmp);
2732 *pval = (target_long) tmp;
2738 static void next(void)
2742 while (qemu_isspace(*pch))
2747 static int64_t expr_sum(Monitor *mon);
2749 static int64_t expr_unary(Monitor *mon)
2758 n = expr_unary(mon);
2762 n = -expr_unary(mon);
2766 n = ~expr_unary(mon);
2772 expr_error(mon, "')' expected");
2779 expr_error(mon, "character constant expected");
2783 expr_error(mon, "missing terminating \' character");
2793 while ((*pch >= 'a' && *pch <= 'z') ||
2794 (*pch >= 'A' && *pch <= 'Z') ||
2795 (*pch >= '0' && *pch <= '9') ||
2796 *pch == '_' || *pch == '.') {
2797 if ((q - buf) < sizeof(buf) - 1)
2801 while (qemu_isspace(*pch))
2804 ret = get_monitor_def(®, buf);
2806 expr_error(mon, "unknown register");
2811 expr_error(mon, "unexpected end of expression");
2816 n = strtoull(pch, &p, 0);
2817 if (errno == ERANGE) {
2818 expr_error(mon, "number too large");
2821 expr_error(mon, "invalid char '%c' in expression", *p);
2824 while (qemu_isspace(*pch))
2832 static int64_t expr_prod(Monitor *mon)
2837 val = expr_unary(mon);
2840 if (op != '*' && op != '/' && op != '%')
2843 val2 = expr_unary(mon);
2852 expr_error(mon, "division by zero");
2863 static int64_t expr_logic(Monitor *mon)
2868 val = expr_prod(mon);
2871 if (op != '&' && op != '|' && op != '^')
2874 val2 = expr_prod(mon);
2891 static int64_t expr_sum(Monitor *mon)
2896 val = expr_logic(mon);
2899 if (op != '+' && op != '-')
2902 val2 = expr_logic(mon);
2911 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2914 if (sigsetjmp(expr_env, 0)) {
2918 while (qemu_isspace(*pch))
2920 *pval = expr_sum(mon);
2925 static int get_double(Monitor *mon, double *pval, const char **pp)
2927 const char *p = *pp;
2931 d = strtod(p, &tailp);
2933 monitor_printf(mon, "Number expected\n");
2936 if (d != d || d - d != 0) {
2937 /* NaN or infinity */
2938 monitor_printf(mon, "Bad number\n");
2947 * Store the command-name in cmdname, and return a pointer to
2948 * the remaining of the command string.
2950 static const char *get_command_name(const char *cmdline,
2951 char *cmdname, size_t nlen)
2954 const char *p, *pstart;
2957 while (qemu_isspace(*p))
2962 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2967 memcpy(cmdname, pstart, len);
2968 cmdname[len] = '\0';
2973 * Read key of 'type' into 'key' and return the current
2976 static char *key_get_info(const char *type, char **key)
2984 p = strchr(type, ':');
2991 str = g_malloc(len + 1);
2992 memcpy(str, type, len);
2999 static int default_fmt_format = 'x';
3000 static int default_fmt_size = 4;
3002 static int is_valid_option(const char *c, const char *typestr)
3010 typestr = strstr(typestr, option);
3011 return (typestr != NULL);
3014 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
3015 const char *cmdname)
3017 const mon_cmd_t *cmd;
3019 for (cmd = disp_table; cmd->name != NULL; cmd++) {
3020 if (compare_cmd(cmdname, cmd->name)) {
3029 * Parse command name from @cmdp according to command table @table.
3030 * If blank, return NULL.
3031 * Else, if no valid command can be found, report to @mon, and return
3033 * Else, change @cmdp to point right behind the name, and return its
3034 * command table entry.
3035 * Do not assume the return value points into @table! It doesn't when
3036 * the command is found in a sub-command table.
3038 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
3039 const char *cmdp_start,
3044 const mon_cmd_t *cmd;
3047 /* extract the command name */
3048 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
3052 cmd = search_dispatch_table(table, cmdname);
3054 monitor_printf(mon, "unknown command: '%.*s'\n",
3055 (int)(p - cmdp_start), cmdp_start);
3058 if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
3059 monitor_printf(mon, "Command '%.*s' not available with -preconfig "
3060 "until after exit_preconfig.\n",
3061 (int)(p - cmdp_start), cmdp_start);
3065 /* filter out following useless space */
3066 while (qemu_isspace(*p)) {
3071 /* search sub command */
3072 if (cmd->sub_table != NULL && *p != '\0') {
3073 return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
3080 * Parse arguments for @cmd.
3081 * If it can't be parsed, report to @mon, and return NULL.
3082 * Else, insert command arguments into a QDict, and return it.
3083 * Note: On success, caller has to free the QDict structure.
3086 static QDict *monitor_parse_arguments(Monitor *mon,
3088 const mon_cmd_t *cmd)
3090 const char *typestr;
3093 const char *p = *endp;
3095 QDict *qdict = qdict_new();
3097 /* parse the parameters */
3098 typestr = cmd->args_type;
3100 typestr = key_get_info(typestr, &key);
3112 while (qemu_isspace(*p))
3114 if (*typestr == '?') {
3117 /* no optional string: NULL argument */
3121 ret = get_str(buf, sizeof(buf), &p);
3125 monitor_printf(mon, "%s: filename expected\n",
3129 monitor_printf(mon, "%s: block device name expected\n",
3133 monitor_printf(mon, "%s: string expected\n", cmd->name);
3138 qdict_put_str(qdict, key, buf);
3143 QemuOptsList *opts_list;
3146 opts_list = qemu_find_opts(key);
3147 if (!opts_list || opts_list->desc->name) {
3150 while (qemu_isspace(*p)) {
3155 if (get_str(buf, sizeof(buf), &p) < 0) {
3158 opts = qemu_opts_parse_noisily(opts_list, buf, true);
3162 qemu_opts_to_qdict(opts, qdict);
3163 qemu_opts_del(opts);
3168 int count, format, size;
3170 while (qemu_isspace(*p))
3176 if (qemu_isdigit(*p)) {
3178 while (qemu_isdigit(*p)) {
3179 count = count * 10 + (*p - '0');
3217 if (*p != '\0' && !qemu_isspace(*p)) {
3218 monitor_printf(mon, "invalid char in format: '%c'\n",
3223 format = default_fmt_format;
3224 if (format != 'i') {
3225 /* for 'i', not specifying a size gives -1 as size */
3227 size = default_fmt_size;
3228 default_fmt_size = size;
3230 default_fmt_format = format;
3233 format = default_fmt_format;
3234 if (format != 'i') {
3235 size = default_fmt_size;
3240 qdict_put_int(qdict, "count", count);
3241 qdict_put_int(qdict, "format", format);
3242 qdict_put_int(qdict, "size", size);
3251 while (qemu_isspace(*p))
3253 if (*typestr == '?' || *typestr == '.') {
3254 if (*typestr == '?') {
3262 while (qemu_isspace(*p))
3271 if (get_expr(mon, &val, &p))
3273 /* Check if 'i' is greater than 32-bit */
3274 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
3275 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
3276 monitor_printf(mon, "integer is for 32-bit values\n");
3278 } else if (c == 'M') {
3280 monitor_printf(mon, "enter a positive value\n");
3285 qdict_put_int(qdict, key, val);
3294 while (qemu_isspace(*p)) {
3297 if (*typestr == '?') {
3303 ret = qemu_strtosz_MiB(p, &end, &val);
3304 if (ret < 0 || val > INT64_MAX) {
3305 monitor_printf(mon, "invalid size\n");
3308 qdict_put_int(qdict, key, val);
3316 while (qemu_isspace(*p))
3318 if (*typestr == '?') {
3324 if (get_double(mon, &val, &p) < 0) {
3327 if (p[0] && p[1] == 's') {
3330 val /= 1e3; p += 2; break;
3332 val /= 1e6; p += 2; break;
3334 val /= 1e9; p += 2; break;
3337 if (*p && !qemu_isspace(*p)) {
3338 monitor_printf(mon, "Unknown unit suffix\n");
3341 qdict_put(qdict, key, qnum_from_double(val));
3349 while (qemu_isspace(*p)) {
3353 while (qemu_isgraph(*p)) {
3356 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
3358 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
3361 monitor_printf(mon, "Expected 'on' or 'off'\n");
3364 qdict_put_bool(qdict, key, val);
3369 const char *tmp = p;
3376 while (qemu_isspace(*p))
3381 if(!is_valid_option(p, typestr)) {
3383 monitor_printf(mon, "%s: unsupported option -%c\n",
3395 qdict_put_bool(qdict, key, true);
3402 /* package all remaining string */
3405 while (qemu_isspace(*p)) {
3408 if (*typestr == '?') {
3411 /* no remaining string: NULL argument */
3417 monitor_printf(mon, "%s: string expected\n",
3421 qdict_put_str(qdict, key, p);
3427 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
3433 /* check that all arguments were parsed */
3434 while (qemu_isspace(*p))
3437 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
3445 qobject_unref(qdict);
3450 static void handle_hmp_command(Monitor *mon, const char *cmdline)
3453 const mon_cmd_t *cmd;
3454 const char *cmd_start = cmdline;
3456 trace_handle_hmp_command(mon, cmdline);
3458 if (runstate_check(RUN_STATE_PRECONFIG)) {
3459 monitor_printf(mon, "HMP not available in preconfig state, "
3460 "use QMP instead\n");
3464 cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
3469 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
3471 while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
3474 monitor_printf(mon, "Try \"help %.*s\" for more information\n",
3475 (int)(cmdline - cmd_start), cmd_start);
3479 cmd->cmd(mon, qdict);
3480 qobject_unref(qdict);
3483 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3485 const char *p, *pstart;
3494 p = pstart + strlen(pstart);
3496 if (len > sizeof(cmd) - 2)
3497 len = sizeof(cmd) - 2;
3498 memcpy(cmd, pstart, len);
3500 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3501 readline_add_completion(mon->rs, cmd);
3509 static void file_completion(Monitor *mon, const char *input)
3514 char file[1024], file_prefix[1024];
3518 p = strrchr(input, '/');
3521 pstrcpy(file_prefix, sizeof(file_prefix), input);
3522 pstrcpy(path, sizeof(path), ".");
3524 input_path_len = p - input + 1;
3525 memcpy(path, input, input_path_len);
3526 if (input_path_len > sizeof(path) - 1)
3527 input_path_len = sizeof(path) - 1;
3528 path[input_path_len] = '\0';
3529 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3532 ffs = opendir(path);
3541 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3545 if (strstart(d->d_name, file_prefix, NULL)) {
3546 memcpy(file, input, input_path_len);
3547 if (input_path_len < sizeof(file))
3548 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3550 /* stat the file to find out if it's a directory.
3551 * In that case add a slash to speed up typing long paths
3553 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3554 pstrcat(file, sizeof(file), "/");
3556 readline_add_completion(mon->rs, file);
3562 static const char *next_arg_type(const char *typestr)
3564 const char *p = strchr(typestr, ':');
3565 return (p != NULL ? ++p : typestr);
3568 static void add_completion_option(ReadLineState *rs, const char *str,
3571 if (!str || !option) {
3574 if (!strncmp(option, str, strlen(str))) {
3575 readline_add_completion(rs, option);
3579 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3582 ChardevBackendInfoList *list, *start;
3588 readline_set_completion_index(rs, len);
3590 start = list = qmp_query_chardev_backends(NULL);
3592 const char *chr_name = list->value->name;
3594 if (!strncmp(chr_name, str, len)) {
3595 readline_add_completion(rs, chr_name);
3599 qapi_free_ChardevBackendInfoList(start);
3602 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3611 readline_set_completion_index(rs, len);
3612 for (i = 0; i < NET_CLIENT_DRIVER__MAX; i++) {
3613 add_completion_option(rs, str, NetClientDriver_str(i));
3617 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3627 readline_set_completion_index(rs, len);
3628 list = elt = object_class_get_list(TYPE_DEVICE, false);
3631 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3633 name = object_class_get_name(OBJECT_CLASS(dc));
3635 if (dc->user_creatable
3636 && !strncmp(name, str, len)) {
3637 readline_add_completion(rs, name);
3644 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3654 readline_set_completion_index(rs, len);
3655 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3659 name = object_class_get_name(OBJECT_CLASS(elt->data));
3660 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3661 readline_add_completion(rs, name);
3668 static void peripheral_device_del_completion(ReadLineState *rs,
3669 const char *str, size_t len)
3671 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3672 GSList *list, *item;
3674 list = qdev_build_hotpluggable_device_list(peripheral);
3679 for (item = list; item; item = g_slist_next(item)) {
3680 DeviceState *dev = item->data;
3682 if (dev->id && !strncmp(str, dev->id, len)) {
3683 readline_add_completion(rs, dev->id);
3690 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3693 ChardevInfoList *list, *start;
3699 readline_set_completion_index(rs, len);
3701 start = list = qmp_query_chardev(NULL);
3703 ChardevInfo *chr = list->value;
3705 if (!strncmp(chr->label, str, len)) {
3706 readline_add_completion(rs, chr->label);
3710 qapi_free_ChardevInfoList(start);
3713 static void ringbuf_completion(ReadLineState *rs, const char *str)
3716 ChardevInfoList *list, *start;
3719 readline_set_completion_index(rs, len);
3721 start = list = qmp_query_chardev(NULL);
3723 ChardevInfo *chr_info = list->value;
3725 if (!strncmp(chr_info->label, str, len)) {
3726 Chardev *chr = qemu_chr_find(chr_info->label);
3727 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3728 readline_add_completion(rs, chr_info->label);
3733 qapi_free_ChardevInfoList(start);
3736 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3741 ringbuf_completion(rs, str);
3744 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3753 readline_set_completion_index(rs, len);
3754 peripheral_device_del_completion(rs, str, len);
3757 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3759 ObjectPropertyInfoList *list, *start;
3766 readline_set_completion_index(rs, len);
3768 start = list = qmp_qom_list("/objects", NULL);
3770 ObjectPropertyInfo *info = list->value;
3772 if (!strncmp(info->type, "child<", 5)
3773 && !strncmp(info->name, str, len)) {
3774 readline_add_completion(rs, info->name);
3778 qapi_free_ObjectPropertyInfoList(start);
3781 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3790 sep = strrchr(str, '-');
3795 readline_set_completion_index(rs, len);
3796 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3797 if (!strncmp(str, QKeyCode_str(i), len)) {
3798 readline_add_completion(rs, QKeyCode_str(i));
3803 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3808 readline_set_completion_index(rs, len);
3810 NetClientState *ncs[MAX_QUEUE_NUM];
3812 count = qemu_find_net_clients_except(NULL, ncs,
3813 NET_CLIENT_DRIVER_NONE,
3815 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3816 const char *name = ncs[i]->name;
3817 if (!strncmp(str, name, len)) {
3818 readline_add_completion(rs, name);
3821 } else if (nb_args == 3) {
3822 add_completion_option(rs, str, "on");
3823 add_completion_option(rs, str, "off");
3827 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3830 NetClientState *ncs[MAX_QUEUE_NUM];
3837 readline_set_completion_index(rs, len);
3838 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3840 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3842 const char *name = ncs[i]->name;
3843 if (strncmp(str, name, len)) {
3846 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3848 readline_add_completion(rs, name);
3853 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3858 readline_set_completion_index(rs, len);
3860 TraceEventIter iter;
3862 char *pattern = g_strdup_printf("%s*", str);
3863 trace_event_iter_init(&iter, pattern);
3864 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3865 readline_add_completion(rs, trace_event_get_name(ev));
3871 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3876 readline_set_completion_index(rs, len);
3878 TraceEventIter iter;
3880 char *pattern = g_strdup_printf("%s*", str);
3881 trace_event_iter_init(&iter, pattern);
3882 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3883 readline_add_completion(rs, trace_event_get_name(ev));
3886 } else if (nb_args == 3) {
3887 add_completion_option(rs, str, "on");
3888 add_completion_option(rs, str, "off");
3892 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3899 readline_set_completion_index(rs, strlen(str));
3900 for (i = 0; i < WATCHDOG_ACTION__MAX; i++) {
3901 add_completion_option(rs, str, WatchdogAction_str(i));
3905 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3911 readline_set_completion_index(rs, len);
3914 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3915 const char *name = MigrationCapability_str(i);
3916 if (!strncmp(str, name, len)) {
3917 readline_add_completion(rs, name);
3920 } else if (nb_args == 3) {
3921 add_completion_option(rs, str, "on");
3922 add_completion_option(rs, str, "off");
3926 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3932 readline_set_completion_index(rs, len);
3935 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3936 const char *name = MigrationParameter_str(i);
3937 if (!strncmp(str, name, len)) {
3938 readline_add_completion(rs, name);
3944 static void vm_completion(ReadLineState *rs, const char *str)
3947 BlockDriverState *bs;
3948 BdrvNextIterator it;
3951 readline_set_completion_index(rs, len);
3953 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3954 SnapshotInfoList *snapshots, *snapshot;
3955 AioContext *ctx = bdrv_get_aio_context(bs);
3958 aio_context_acquire(ctx);
3959 if (bdrv_can_snapshot(bs)) {
3960 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3962 aio_context_release(ctx);
3967 snapshot = snapshots;
3969 char *completion = snapshot->value->name;
3970 if (!strncmp(str, completion, len)) {
3971 readline_add_completion(rs, completion);
3973 completion = snapshot->value->id;
3974 if (!strncmp(str, completion, len)) {
3975 readline_add_completion(rs, completion);
3977 snapshot = snapshot->next;
3979 qapi_free_SnapshotInfoList(snapshots);
3984 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3987 vm_completion(rs, str);
3991 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3994 vm_completion(rs, str);
3998 static void monitor_find_completion_by_table(Monitor *mon,
3999 const mon_cmd_t *cmd_table,
4003 const char *cmdname;
4005 const char *ptype, *old_ptype, *str, *name;
4006 const mon_cmd_t *cmd;
4007 BlockBackend *blk = NULL;
4010 /* command completion */
4015 readline_set_completion_index(mon->rs, strlen(cmdname));
4016 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4017 cmd_completion(mon, cmdname, cmd->name);
4020 /* find the command */
4021 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
4022 if (compare_cmd(args[0], cmd->name)) {
4030 if (cmd->sub_table) {
4031 /* do the job again */
4032 monitor_find_completion_by_table(mon, cmd->sub_table,
4033 &args[1], nb_args - 1);
4036 if (cmd->command_completion) {
4037 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
4041 ptype = next_arg_type(cmd->args_type);
4042 for(i = 0; i < nb_args - 2; i++) {
4043 if (*ptype != '\0') {
4044 ptype = next_arg_type(ptype);
4045 while (*ptype == '?')
4046 ptype = next_arg_type(ptype);
4049 str = args[nb_args - 1];
4051 while (*ptype == '-' && old_ptype != ptype) {
4053 ptype = next_arg_type(ptype);
4057 /* file completion */
4058 readline_set_completion_index(mon->rs, strlen(str));
4059 file_completion(mon, str);
4062 /* block device name completion */
4063 readline_set_completion_index(mon->rs, strlen(str));
4064 while ((blk = blk_next(blk)) != NULL) {
4065 name = blk_name(blk);
4066 if (str[0] == '\0' ||
4067 !strncmp(name, str, strlen(str))) {
4068 readline_add_completion(mon->rs, name);
4074 if (!strcmp(cmd->name, "help|?")) {
4075 monitor_find_completion_by_table(mon, cmd_table,
4076 &args[1], nb_args - 1);
4085 static void monitor_find_completion(void *opaque,
4086 const char *cmdline)
4088 Monitor *mon = opaque;
4089 char *args[MAX_ARGS];
4092 /* 1. parse the cmdline */
4093 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
4097 /* if the line ends with a space, it means we want to complete the
4099 len = strlen(cmdline);
4100 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
4101 if (nb_args >= MAX_ARGS) {
4104 args[nb_args++] = g_strdup("");
4107 /* 2. auto complete according to args */
4108 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
4111 free_cmdline_args(args, nb_args);
4114 static int monitor_can_read(void *opaque)
4116 Monitor *mon = opaque;
4118 return !atomic_mb_read(&mon->suspend_cnt);
4122 * 1. This function takes ownership of rsp, err, and id.
4123 * 2. rsp, err, and id may be NULL.
4124 * 3. If err != NULL then rsp must be NULL.
4126 static void monitor_qmp_respond(Monitor *mon, QObject *rsp,
4127 Error *err, QObject *id)
4129 QDict *qdict = NULL;
4133 qdict = qdict_new();
4134 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
4136 rsp = QOBJECT(qdict);
4141 qdict_put_obj(qobject_to(QDict, rsp), "id", qobject_ref(id));
4144 monitor_json_emitter(mon, rsp);
4152 * Dispatch one single QMP request. The function will free the req_obj
4153 * and objects inside it before return.
4155 static void monitor_qmp_dispatch_one(QMPRequest *req_obj)
4157 Monitor *mon, *old_mon;
4158 QObject *req, *rsp = NULL, *id;
4164 need_resume = req_obj->need_resume;
4168 if (trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
4169 QString *req_json = qobject_to_json(req);
4170 trace_handle_qmp_command(mon, qstring_get_str(req_json));
4171 qobject_unref(req_json);
4177 rsp = qmp_dispatch(mon->qmp.commands, req);
4181 /* Respond if necessary */
4182 monitor_qmp_respond(mon, rsp, NULL, id);
4184 /* This pairs with the monitor_suspend() in handle_qmp_command(). */
4186 monitor_resume(mon);
4193 * Pop one QMP request from monitor queues, return NULL if not found.
4194 * We are using round-robin fashion to pop the request, to avoid
4195 * processing commands only on a very busy monitor. To achieve that,
4196 * when we process one request on a specific monitor, we put that
4197 * monitor to the end of mon_list queue.
4199 static QMPRequest *monitor_qmp_requests_pop_one(void)
4201 QMPRequest *req_obj = NULL;
4204 qemu_mutex_lock(&monitor_lock);
4206 QTAILQ_FOREACH(mon, &mon_list, entry) {
4207 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4208 req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
4209 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4217 * We found one request on the monitor. Degrade this monitor's
4218 * priority to lowest by re-inserting it to end of queue.
4220 QTAILQ_REMOVE(&mon_list, mon, entry);
4221 QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
4224 qemu_mutex_unlock(&monitor_lock);
4229 static void monitor_qmp_bh_dispatcher(void *data)
4231 QMPRequest *req_obj = monitor_qmp_requests_pop_one();
4234 trace_monitor_qmp_cmd_in_band(qobject_get_try_str(req_obj->id) ?: "");
4235 monitor_qmp_dispatch_one(req_obj);
4236 /* Reschedule instead of looping so the main loop stays responsive */
4237 qemu_bh_schedule(mon_global.qmp_dispatcher_bh);
4241 #define QMP_REQ_QUEUE_LEN_MAX (8)
4243 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
4245 QObject *req, *id = NULL;
4246 QDict *qdict = NULL;
4247 MonitorQMP *mon_qmp = container_of(parser, MonitorQMP, parser);
4248 Monitor *mon = container_of(mon_qmp, Monitor, qmp);
4250 QMPRequest *req_obj;
4252 req = json_parser_parse_err(tokens, NULL, &err);
4254 /* json_parser_parse_err() sucks: can fail without setting @err */
4255 error_setg(&err, QERR_JSON_PARSING);
4261 /* Check against the request in general layout */
4262 qdict = qmp_dispatch_check_obj(req, &err);
4267 /* Check against OOB specific */
4268 if (!qmp_cmd_oob_check(mon, qdict, &err)) {
4272 id = qdict_get(qdict, "id");
4274 /* When OOB is enabled, the "id" field is mandatory. */
4275 if (qmp_oob_enabled(mon) && !id) {
4276 error_setg(&err, "Out-Of-Band capability requires that "
4277 "every command contains an 'id' field");
4281 req_obj = g_new0(QMPRequest, 1);
4283 req_obj->id = qobject_ref(id);
4285 req_obj->need_resume = false;
4287 qdict_del(qdict, "id");
4289 if (qmp_is_oob(qdict)) {
4290 /* Out-Of-Band (OOB) requests are executed directly in parser. */
4291 trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(req_obj->id)
4293 monitor_qmp_dispatch_one(req_obj);
4297 /* Protect qmp_requests and fetching its length. */
4298 qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
4301 * If OOB is not enabled on the current monitor, we'll emulate the
4302 * old behavior that we won't process the current monitor any more
4303 * until it has responded. This helps make sure that as long as
4304 * OOB is not enabled, the server will never drop any command.
4306 if (!qmp_oob_enabled(mon)) {
4307 monitor_suspend(mon);
4308 req_obj->need_resume = true;
4310 /* Drop the request if queue is full. */
4311 if (mon->qmp.qmp_requests->length >= QMP_REQ_QUEUE_LEN_MAX) {
4312 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4313 qapi_event_send_command_dropped(id,
4314 COMMAND_DROP_REASON_QUEUE_FULL,
4316 qmp_request_free(req_obj);
4322 * Put the request to the end of queue so that requests will be
4323 * handled in time order. Ownership for req_obj, req, id,
4324 * etc. will be delivered to the handler side.
4326 g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
4327 qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
4329 /* Kick the dispatcher routine */
4330 qemu_bh_schedule(mon_global.qmp_dispatcher_bh);
4334 monitor_qmp_respond(mon, NULL, err, NULL);
4338 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
4340 Monitor *mon = opaque;
4342 json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
4345 static void monitor_read(void *opaque, const uint8_t *buf, int size)
4347 Monitor *old_mon = cur_mon;
4353 for (i = 0; i < size; i++)
4354 readline_handle_byte(cur_mon->rs, buf[i]);
4356 if (size == 0 || buf[size - 1] != 0)
4357 monitor_printf(cur_mon, "corrupted command\n");
4359 handle_hmp_command(cur_mon, (char *)buf);
4365 static void monitor_command_cb(void *opaque, const char *cmdline,
4366 void *readline_opaque)
4368 Monitor *mon = opaque;
4370 monitor_suspend(mon);
4371 handle_hmp_command(mon, cmdline);
4372 monitor_resume(mon);
4375 int monitor_suspend(Monitor *mon)
4377 if (monitor_is_hmp_non_interactive(mon)) {
4381 atomic_inc(&mon->suspend_cnt);
4383 if (monitor_is_qmp(mon)) {
4385 * Kick iothread to make sure this takes effect. It'll be
4386 * evaluated again in prepare() of the watch object.
4388 aio_notify(iothread_get_aio_context(mon_global.mon_iothread));
4391 trace_monitor_suspend(mon, 1);
4395 void monitor_resume(Monitor *mon)
4397 if (monitor_is_hmp_non_interactive(mon)) {
4401 if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
4402 if (monitor_is_qmp(mon)) {
4404 * For QMP monitors that are running in IOThread, let's
4405 * kick the thread in case it's sleeping.
4407 if (mon->use_io_thr) {
4408 aio_notify(iothread_get_aio_context(mon_global.mon_iothread));
4412 readline_show_prompt(mon->rs);
4415 trace_monitor_suspend(mon, -1);
4418 static QObject *get_qmp_greeting(Monitor *mon)
4420 QList *cap_list = qlist_new();
4421 QObject *ver = NULL;
4424 qmp_marshal_query_version(NULL, &ver, NULL);
4426 for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
4427 if (!mon->use_io_thr && cap == QMP_CAPABILITY_OOB) {
4428 /* Monitors that are not using IOThread won't support OOB */
4431 qlist_append_str(cap_list, QMPCapability_str(cap));
4434 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': %p}}",
4438 static void monitor_qmp_caps_reset(Monitor *mon)
4440 memset(mon->qmp.qmp_caps, 0, sizeof(mon->qmp.qmp_caps));
4443 static void monitor_qmp_event(void *opaque, int event)
4446 Monitor *mon = opaque;
4449 case CHR_EVENT_OPENED:
4450 mon->qmp.commands = &qmp_cap_negotiation_commands;
4451 monitor_qmp_caps_reset(mon);
4452 data = get_qmp_greeting(mon);
4453 monitor_json_emitter(mon, data);
4454 qobject_unref(data);
4457 case CHR_EVENT_CLOSED:
4458 monitor_qmp_cleanup_queues(mon);
4459 json_message_parser_destroy(&mon->qmp.parser);
4460 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4462 monitor_fdsets_cleanup();
4467 static void monitor_event(void *opaque, int event)
4469 Monitor *mon = opaque;
4472 case CHR_EVENT_MUX_IN:
4473 qemu_mutex_lock(&mon->mon_lock);
4475 qemu_mutex_unlock(&mon->mon_lock);
4476 if (mon->reset_seen) {
4477 readline_restart(mon->rs);
4478 monitor_resume(mon);
4481 atomic_mb_set(&mon->suspend_cnt, 0);
4485 case CHR_EVENT_MUX_OUT:
4486 if (mon->reset_seen) {
4487 if (atomic_mb_read(&mon->suspend_cnt) == 0) {
4488 monitor_printf(mon, "\n");
4491 monitor_suspend(mon);
4493 atomic_inc(&mon->suspend_cnt);
4495 qemu_mutex_lock(&mon->mon_lock);
4497 qemu_mutex_unlock(&mon->mon_lock);
4500 case CHR_EVENT_OPENED:
4501 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
4502 "information\n", QEMU_VERSION);
4503 if (!mon->mux_out) {
4504 readline_restart(mon->rs);
4505 readline_show_prompt(mon->rs);
4507 mon->reset_seen = 1;
4511 case CHR_EVENT_CLOSED:
4513 monitor_fdsets_cleanup();
4519 compare_mon_cmd(const void *a, const void *b)
4521 return strcmp(((const mon_cmd_t *)a)->name,
4522 ((const mon_cmd_t *)b)->name);
4525 static void sortcmdlist(void)
4528 int elem_size = sizeof(mon_cmd_t);
4530 array_num = sizeof(mon_cmds)/elem_size-1;
4531 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
4533 array_num = sizeof(info_cmds)/elem_size-1;
4534 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
4537 static GMainContext *monitor_get_io_context(void)
4539 return iothread_get_g_main_context(mon_global.mon_iothread);
4542 static AioContext *monitor_get_aio_context(void)
4544 return iothread_get_aio_context(mon_global.mon_iothread);
4547 static void monitor_iothread_init(void)
4549 mon_global.mon_iothread = iothread_create("mon_iothread",
4553 * This MUST be on main loop thread since we have commands that
4554 * have assumption to be run on main loop thread. It would be
4555 * nice that one day we can remove this assumption in the future.
4557 mon_global.qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
4558 monitor_qmp_bh_dispatcher,
4562 * Unlike the dispatcher BH, this must be run on the monitor IO
4563 * thread, so that monitors that are using IO thread will make
4564 * sure read/write operations are all done on the IO thread.
4566 mon_global.qmp_respond_bh = aio_bh_new(monitor_get_aio_context(),
4567 monitor_qmp_bh_responder,
4571 void monitor_init_globals(void)
4573 monitor_init_qmp_commands();
4574 monitor_qapi_event_init();
4576 qemu_mutex_init(&monitor_lock);
4577 qemu_mutex_init(&mon_fdsets_lock);
4578 monitor_iothread_init();
4581 /* These functions just adapt the readline interface in a typesafe way. We
4582 * could cast function pointers but that discards compiler checks.
4584 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
4585 const char *fmt, ...)
4589 monitor_vprintf(opaque, fmt, ap);
4593 static void monitor_readline_flush(void *opaque)
4595 monitor_flush(opaque);
4599 * Print to current monitor if we have one, else to stderr.
4600 * TODO should return int, so callers can calculate width, but that
4601 * requires surgery to monitor_vprintf(). Left for another day.
4603 void error_vprintf(const char *fmt, va_list ap)
4605 if (cur_mon && !monitor_cur_is_qmp()) {
4606 monitor_vprintf(cur_mon, fmt, ap);
4608 vfprintf(stderr, fmt, ap);
4612 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
4614 if (cur_mon && !monitor_cur_is_qmp()) {
4615 monitor_vprintf(cur_mon, fmt, ap);
4616 } else if (!cur_mon) {
4617 vfprintf(stderr, fmt, ap);
4621 static void monitor_list_append(Monitor *mon)
4623 qemu_mutex_lock(&monitor_lock);
4624 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
4625 qemu_mutex_unlock(&monitor_lock);
4628 static void monitor_qmp_setup_handlers_bh(void *opaque)
4630 Monitor *mon = opaque;
4631 GMainContext *context;
4633 if (mon->use_io_thr) {
4635 * When use_io_thr is set, we use the global shared dedicated
4636 * IO thread for this monitor to handle input/output.
4638 context = monitor_get_io_context();
4639 /* We should have inited globals before reaching here. */
4642 /* The default main loop, which is the main thread */
4646 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
4647 monitor_qmp_event, NULL, mon, context, true);
4648 monitor_list_append(mon);
4651 void monitor_init(Chardev *chr, int flags)
4653 Monitor *mon = g_malloc(sizeof(*mon));
4654 bool use_readline = flags & MONITOR_USE_READLINE;
4655 bool use_oob = flags & MONITOR_USE_OOB;
4658 if (CHARDEV_IS_MUX(chr)) {
4659 error_report("Monitor Out-Of-Band is not supported with "
4660 "MUX typed chardev backend");
4664 error_report("Monitor Out-Of-band is only supported by QMP");
4669 monitor_data_init(mon, false, use_oob);
4671 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
4674 mon->rs = readline_init(monitor_readline_printf,
4675 monitor_readline_flush,
4677 monitor_find_completion);
4678 monitor_read_command(mon, 0);
4681 if (monitor_is_qmp(mon)) {
4682 qemu_chr_fe_set_echo(&mon->chr, true);
4683 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
4684 if (mon->use_io_thr) {
4686 * Make sure the old iowatch is gone. It's possible when
4687 * e.g. the chardev is in client mode, with wait=on.
4689 remove_fd_in_watch(chr);
4691 * We can't call qemu_chr_fe_set_handlers() directly here
4692 * since during the procedure the chardev will be active
4693 * and running in monitor iothread, while we'll still do
4694 * something before returning from it, which is a possible
4695 * race too. To avoid that, we just create a BH to setup
4698 aio_bh_schedule_oneshot(monitor_get_aio_context(),
4699 monitor_qmp_setup_handlers_bh, mon);
4700 /* We'll add this to mon_list in the BH when setup done */
4703 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
4704 monitor_qmp_read, monitor_qmp_event,
4705 NULL, mon, NULL, true);
4708 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
4709 monitor_event, NULL, mon, NULL, true);
4712 monitor_list_append(mon);
4715 void monitor_cleanup(void)
4717 Monitor *mon, *next;
4720 * We need to explicitly stop the iothread (but not destroy it),
4721 * cleanup the monitor resources, then destroy the iothread since
4722 * we need to unregister from chardev below in
4723 * monitor_data_destroy(), and chardev is not thread-safe yet
4725 iothread_stop(mon_global.mon_iothread);
4728 * After we have IOThread to send responses, it's possible that
4729 * when we stop the IOThread there are still replies queued in the
4730 * responder queue. Flush all of them. Note that even after this
4731 * flush it's still possible that out buffer is not flushed.
4732 * It'll be done in below monitor_flush() as the last resort.
4734 monitor_qmp_bh_responder(NULL);
4736 qemu_mutex_lock(&monitor_lock);
4737 QTAILQ_FOREACH_SAFE(mon, &mon_list, entry, next) {
4738 QTAILQ_REMOVE(&mon_list, mon, entry);
4740 monitor_data_destroy(mon);
4743 qemu_mutex_unlock(&monitor_lock);
4745 /* QEMUBHs needs to be deleted before destroying the IOThread. */
4746 qemu_bh_delete(mon_global.qmp_dispatcher_bh);
4747 mon_global.qmp_dispatcher_bh = NULL;
4748 qemu_bh_delete(mon_global.qmp_respond_bh);
4749 mon_global.qmp_respond_bh = NULL;
4751 iothread_destroy(mon_global.mon_iothread);
4752 mon_global.mon_iothread = NULL;
4755 QemuOptsList qemu_mon_opts = {
4757 .implied_opt_name = "chardev",
4758 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4762 .type = QEMU_OPT_STRING,
4765 .type = QEMU_OPT_STRING,
4768 .type = QEMU_OPT_BOOL,
4771 .type = QEMU_OPT_BOOL,
4773 { /* end of list */ }
4778 void qmp_rtc_reset_reinjection(Error **errp)
4780 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4783 SevInfo *qmp_query_sev(Error **errp)
4785 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev");
4789 SevLaunchMeasureInfo *qmp_query_sev_launch_measure(Error **errp)
4791 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-launch-measure");
4795 SevCapability *qmp_query_sev_capabilities(Error **errp)
4797 error_setg(errp, QERR_FEATURE_DISABLED, "query-sev-capabilities");
4802 #ifndef TARGET_S390X
4803 void qmp_dump_skeys(const char *filename, Error **errp)
4805 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4810 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4812 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4817 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4819 MachineState *ms = MACHINE(qdev_get_machine());
4820 MachineClass *mc = MACHINE_GET_CLASS(ms);
4822 if (!mc->has_hotpluggable_cpus) {
4823 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4827 return machine_query_hotpluggable_cpus(ms);