target/arm/arm-powerctl: Fix psci info return values
[qemu/ar7.git] / monitor.c
blobf11893e1c3be9133f174854c4cd8d064be0bec9b
1 /*
2 * QEMU monitor
4 * Copyright (c) 2003-2004 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
24 #include "qemu/osdep.h"
25 #include <dirent.h>
26 #include "qemu-common.h"
27 #include "cpu.h"
28 #include "hw/hw.h"
29 #include "monitor/qdev.h"
30 #include "hw/usb.h"
31 #include "hw/i386/pc.h"
32 #include "hw/pci/pci.h"
33 #include "sysemu/watchdog.h"
34 #include "hw/loader.h"
35 #include "exec/gdbstub.h"
36 #include "net/net.h"
37 #include "net/slirp.h"
38 #include "sysemu/char.h"
39 #include "ui/qemu-spice.h"
40 #include "sysemu/sysemu.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"
46 #include "ui/input.h"
47 #include "sysemu/blockdev.h"
48 #include "sysemu/block-backend.h"
49 #include "audio/audio.h"
50 #include "disas/disas.h"
51 #include "sysemu/balloon.h"
52 #include "qemu/timer.h"
53 #include "migration/migration.h"
54 #include "sysemu/hw_accel.h"
55 #include "qemu/acl.h"
56 #include "sysemu/tpm.h"
57 #include "qapi/qmp/qerror.h"
58 #include "qapi/qmp/types.h"
59 #include "qapi/qmp/qjson.h"
60 #include "qapi/qmp/json-streamer.h"
61 #include "qapi/qmp/json-parser.h"
62 #include "qom/object_interfaces.h"
63 #include "trace-root.h"
64 #include "trace/control.h"
65 #include "monitor/hmp-target.h"
66 #ifdef CONFIG_TRACE_SIMPLE
67 #include "trace/simple.h"
68 #endif
69 #include "exec/memory.h"
70 #include "exec/exec-all.h"
71 #include "qemu/log.h"
72 #include "qmp-commands.h"
73 #include "hmp.h"
74 #include "qemu/thread.h"
75 #include "block/qapi.h"
76 #include "qapi/qmp-event.h"
77 #include "qapi-event.h"
78 #include "qmp-introspect.h"
79 #include "sysemu/qtest.h"
80 #include "qemu/cutils.h"
81 #include "qapi/qmp/dispatch.h"
83 #if defined(TARGET_S390X)
84 #include "hw/s390x/storage-keys.h"
85 #endif
88 * Supported types:
90 * 'F' filename
91 * 'B' block device name
92 * 's' string (accept optional quote)
93 * 'S' it just appends the rest of the string (accept optional quote)
94 * 'O' option string of the form NAME=VALUE,...
95 * parsed according to QemuOptsList given by its name
96 * Example: 'device:O' uses qemu_device_opts.
97 * Restriction: only lists with empty desc are supported
98 * TODO lift the restriction
99 * 'i' 32 bit integer
100 * 'l' target long (32 or 64 bit)
101 * 'M' Non-negative target long (32 or 64 bit), in user mode the
102 * value is multiplied by 2^20 (think Mebibyte)
103 * 'o' octets (aka bytes)
104 * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
105 * K, k suffix, which multiplies the value by 2^60 for suffixes E
106 * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
107 * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
108 * 'T' double
109 * user mode accepts an optional ms, us, ns suffix,
110 * which divides the value by 1e3, 1e6, 1e9, respectively
111 * '/' optional gdb-like print format (like "/10x")
113 * '?' optional type (for all types, except '/')
114 * '.' other form of optional type (for 'i' and 'l')
115 * 'b' boolean
116 * user mode accepts "on" or "off"
117 * '-' optional parameter (eg. '-f')
121 typedef struct mon_cmd_t {
122 const char *name;
123 const char *args_type;
124 const char *params;
125 const char *help;
126 void (*cmd)(Monitor *mon, const QDict *qdict);
127 /* @sub_table is a list of 2nd level of commands. If it does not exist,
128 * cmd should be used. If it exists, sub_table[?].cmd should be
129 * used, and cmd of 1st level plays the role of help function.
131 struct mon_cmd_t *sub_table;
132 void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
133 } mon_cmd_t;
135 /* file descriptors passed via SCM_RIGHTS */
136 typedef struct mon_fd_t mon_fd_t;
137 struct mon_fd_t {
138 char *name;
139 int fd;
140 QLIST_ENTRY(mon_fd_t) next;
143 /* file descriptor associated with a file descriptor set */
144 typedef struct MonFdsetFd MonFdsetFd;
145 struct MonFdsetFd {
146 int fd;
147 bool removed;
148 char *opaque;
149 QLIST_ENTRY(MonFdsetFd) next;
152 /* file descriptor set containing fds passed via SCM_RIGHTS */
153 typedef struct MonFdset MonFdset;
154 struct MonFdset {
155 int64_t id;
156 QLIST_HEAD(, MonFdsetFd) fds;
157 QLIST_HEAD(, MonFdsetFd) dup_fds;
158 QLIST_ENTRY(MonFdset) next;
161 typedef struct {
162 JSONMessageParser parser;
164 * When a client connects, we're in capabilities negotiation mode.
165 * When command qmp_capabilities succeeds, we go into command
166 * mode.
168 QmpCommandList *commands;
169 } MonitorQMP;
172 * To prevent flooding clients, events can be throttled. The
173 * throttling is calculated globally, rather than per-Monitor
174 * instance.
176 typedef struct MonitorQAPIEventState {
177 QAPIEvent event; /* Throttling state for this event type and... */
178 QDict *data; /* ... data, see qapi_event_throttle_equal() */
179 QEMUTimer *timer; /* Timer for handling delayed events */
180 QDict *qdict; /* Delayed event (if any) */
181 } MonitorQAPIEventState;
183 typedef struct {
184 int64_t rate; /* Minimum time (in ns) between two events */
185 } MonitorQAPIEventConf;
187 struct Monitor {
188 CharBackend chr;
189 int reset_seen;
190 int flags;
191 int suspend_cnt;
192 bool skip_flush;
194 QemuMutex out_lock;
195 QString *outbuf;
196 guint out_watch;
198 /* Read under either BQL or out_lock, written with BQL+out_lock. */
199 int mux_out;
201 ReadLineState *rs;
202 MonitorQMP qmp;
203 CPUState *mon_cpu;
204 BlockCompletionFunc *password_completion_cb;
205 void *password_opaque;
206 mon_cmd_t *cmd_table;
207 QLIST_HEAD(,mon_fd_t) fds;
208 QLIST_ENTRY(Monitor) entry;
211 /* QMP checker flags */
212 #define QMP_ACCEPT_UNKNOWNS 1
214 /* Protects mon_list, monitor_event_state. */
215 static QemuMutex monitor_lock;
217 static QLIST_HEAD(mon_list, Monitor) mon_list;
218 static QLIST_HEAD(mon_fdsets, MonFdset) mon_fdsets;
219 static int mon_refcount;
221 static mon_cmd_t mon_cmds[];
222 static mon_cmd_t info_cmds[];
224 QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
226 Monitor *cur_mon;
228 static QEMUClockType event_clock_type = QEMU_CLOCK_REALTIME;
230 static void monitor_command_cb(void *opaque, const char *cmdline,
231 void *readline_opaque);
234 * Is @mon a QMP monitor?
236 static inline bool monitor_is_qmp(const Monitor *mon)
238 return (mon->flags & MONITOR_USE_CONTROL);
242 * Is the current monitor, if any, a QMP monitor?
244 bool monitor_cur_is_qmp(void)
246 return cur_mon && monitor_is_qmp(cur_mon);
249 void monitor_read_command(Monitor *mon, int show_prompt)
251 if (!mon->rs)
252 return;
254 readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
255 if (show_prompt)
256 readline_show_prompt(mon->rs);
259 int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
260 void *opaque)
262 if (mon->rs) {
263 readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
264 /* prompt is printed on return from the command handler */
265 return 0;
266 } else {
267 monitor_printf(mon, "terminal does not support password prompting\n");
268 return -ENOTTY;
272 static void monitor_flush_locked(Monitor *mon);
274 static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
275 void *opaque)
277 Monitor *mon = opaque;
279 qemu_mutex_lock(&mon->out_lock);
280 mon->out_watch = 0;
281 monitor_flush_locked(mon);
282 qemu_mutex_unlock(&mon->out_lock);
283 return FALSE;
286 /* Called with mon->out_lock held. */
287 static void monitor_flush_locked(Monitor *mon)
289 int rc;
290 size_t len;
291 const char *buf;
293 if (mon->skip_flush) {
294 return;
297 buf = qstring_get_str(mon->outbuf);
298 len = qstring_get_length(mon->outbuf);
300 if (len && !mon->mux_out) {
301 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
302 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
303 /* all flushed or error */
304 QDECREF(mon->outbuf);
305 mon->outbuf = qstring_new();
306 return;
308 if (rc > 0) {
309 /* partial write */
310 QString *tmp = qstring_from_str(buf + rc);
311 QDECREF(mon->outbuf);
312 mon->outbuf = tmp;
314 if (mon->out_watch == 0) {
315 mon->out_watch =
316 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
317 monitor_unblocked, mon);
322 void monitor_flush(Monitor *mon)
324 qemu_mutex_lock(&mon->out_lock);
325 monitor_flush_locked(mon);
326 qemu_mutex_unlock(&mon->out_lock);
329 /* flush at every end of line */
330 static void monitor_puts(Monitor *mon, const char *str)
332 char c;
334 qemu_mutex_lock(&mon->out_lock);
335 for(;;) {
336 c = *str++;
337 if (c == '\0')
338 break;
339 if (c == '\n') {
340 qstring_append_chr(mon->outbuf, '\r');
342 qstring_append_chr(mon->outbuf, c);
343 if (c == '\n') {
344 monitor_flush_locked(mon);
347 qemu_mutex_unlock(&mon->out_lock);
350 void monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
352 char *buf;
354 if (!mon)
355 return;
357 if (monitor_is_qmp(mon)) {
358 return;
361 buf = g_strdup_vprintf(fmt, ap);
362 monitor_puts(mon, buf);
363 g_free(buf);
366 void monitor_printf(Monitor *mon, const char *fmt, ...)
368 va_list ap;
369 va_start(ap, fmt);
370 monitor_vprintf(mon, fmt, ap);
371 va_end(ap);
374 int monitor_fprintf(FILE *stream, const char *fmt, ...)
376 va_list ap;
377 va_start(ap, fmt);
378 monitor_vprintf((Monitor *)stream, fmt, ap);
379 va_end(ap);
380 return 0;
383 static void monitor_json_emitter(Monitor *mon, const QObject *data)
385 QString *json;
387 json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
388 qobject_to_json(data);
389 assert(json != NULL);
391 qstring_append_chr(json, '\n');
392 monitor_puts(mon, qstring_get_str(json));
394 QDECREF(json);
397 static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
398 /* Limit guest-triggerable events to 1 per second */
399 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
400 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
401 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
402 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
403 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
404 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
407 GHashTable *monitor_qapi_event_state;
410 * Emits the event to every monitor instance, @event is only used for trace
411 * Called with monitor_lock held.
413 static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
415 Monitor *mon;
417 trace_monitor_protocol_event_emit(event, qdict);
418 QLIST_FOREACH(mon, &mon_list, entry) {
419 if (monitor_is_qmp(mon)
420 && mon->qmp.commands != &qmp_cap_negotiation_commands) {
421 monitor_json_emitter(mon, QOBJECT(qdict));
426 static void monitor_qapi_event_handler(void *opaque);
429 * Queue a new event for emission to Monitor instances,
430 * applying any rate limiting if required.
432 static void
433 monitor_qapi_event_queue(QAPIEvent event, QDict *qdict, Error **errp)
435 MonitorQAPIEventConf *evconf;
436 MonitorQAPIEventState *evstate;
438 assert(event < QAPI_EVENT__MAX);
439 evconf = &monitor_qapi_event_conf[event];
440 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
442 qemu_mutex_lock(&monitor_lock);
444 if (!evconf->rate) {
445 /* Unthrottled event */
446 monitor_qapi_event_emit(event, qdict);
447 } else {
448 QDict *data = qobject_to_qdict(qdict_get(qdict, "data"));
449 MonitorQAPIEventState key = { .event = event, .data = data };
451 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
452 assert(!evstate || timer_pending(evstate->timer));
454 if (evstate) {
456 * Timer is pending for (at least) evconf->rate ns after
457 * last send. Store event for sending when timer fires,
458 * replacing a prior stored event if any.
460 QDECREF(evstate->qdict);
461 evstate->qdict = qdict;
462 QINCREF(evstate->qdict);
463 } else {
465 * Last send was (at least) evconf->rate ns ago.
466 * Send immediately, and arm the timer to call
467 * monitor_qapi_event_handler() in evconf->rate ns. Any
468 * events arriving before then will be delayed until then.
470 int64_t now = qemu_clock_get_ns(event_clock_type);
472 monitor_qapi_event_emit(event, qdict);
474 evstate = g_new(MonitorQAPIEventState, 1);
475 evstate->event = event;
476 evstate->data = data;
477 QINCREF(evstate->data);
478 evstate->qdict = NULL;
479 evstate->timer = timer_new_ns(event_clock_type,
480 monitor_qapi_event_handler,
481 evstate);
482 g_hash_table_add(monitor_qapi_event_state, evstate);
483 timer_mod_ns(evstate->timer, now + evconf->rate);
487 qemu_mutex_unlock(&monitor_lock);
491 * This function runs evconf->rate ns after sending a throttled
492 * event.
493 * If another event has since been stored, send it.
495 static void monitor_qapi_event_handler(void *opaque)
497 MonitorQAPIEventState *evstate = opaque;
498 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
500 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
501 qemu_mutex_lock(&monitor_lock);
503 if (evstate->qdict) {
504 int64_t now = qemu_clock_get_ns(event_clock_type);
506 monitor_qapi_event_emit(evstate->event, evstate->qdict);
507 QDECREF(evstate->qdict);
508 evstate->qdict = NULL;
509 timer_mod_ns(evstate->timer, now + evconf->rate);
510 } else {
511 g_hash_table_remove(monitor_qapi_event_state, evstate);
512 QDECREF(evstate->data);
513 timer_free(evstate->timer);
514 g_free(evstate);
517 qemu_mutex_unlock(&monitor_lock);
520 static unsigned int qapi_event_throttle_hash(const void *key)
522 const MonitorQAPIEventState *evstate = key;
523 unsigned int hash = evstate->event * 255;
525 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
526 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
529 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
530 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
533 return hash;
536 static gboolean qapi_event_throttle_equal(const void *a, const void *b)
538 const MonitorQAPIEventState *eva = a;
539 const MonitorQAPIEventState *evb = b;
541 if (eva->event != evb->event) {
542 return FALSE;
545 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
546 return !strcmp(qdict_get_str(eva->data, "id"),
547 qdict_get_str(evb->data, "id"));
550 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
551 return !strcmp(qdict_get_str(eva->data, "node-name"),
552 qdict_get_str(evb->data, "node-name"));
555 return TRUE;
558 static void monitor_qapi_event_init(void)
560 if (qtest_enabled()) {
561 event_clock_type = QEMU_CLOCK_VIRTUAL;
564 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
565 qapi_event_throttle_equal);
566 qmp_event_set_func_emit(monitor_qapi_event_queue);
569 static void handle_hmp_command(Monitor *mon, const char *cmdline);
571 static void monitor_data_init(Monitor *mon)
573 memset(mon, 0, sizeof(Monitor));
574 qemu_mutex_init(&mon->out_lock);
575 mon->outbuf = qstring_new();
576 /* Use *mon_cmds by default. */
577 mon->cmd_table = mon_cmds;
580 static void monitor_data_destroy(Monitor *mon)
582 qemu_chr_fe_deinit(&mon->chr);
583 if (monitor_is_qmp(mon)) {
584 json_message_parser_destroy(&mon->qmp.parser);
586 g_free(mon->rs);
587 QDECREF(mon->outbuf);
588 qemu_mutex_destroy(&mon->out_lock);
591 char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
592 int64_t cpu_index, Error **errp)
594 char *output = NULL;
595 Monitor *old_mon, hmp;
597 monitor_data_init(&hmp);
598 hmp.skip_flush = true;
600 old_mon = cur_mon;
601 cur_mon = &hmp;
603 if (has_cpu_index) {
604 int ret = monitor_set_cpu(cpu_index);
605 if (ret < 0) {
606 cur_mon = old_mon;
607 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "cpu-index",
608 "a CPU number");
609 goto out;
613 handle_hmp_command(&hmp, command_line);
614 cur_mon = old_mon;
616 qemu_mutex_lock(&hmp.out_lock);
617 if (qstring_get_length(hmp.outbuf) > 0) {
618 output = g_strdup(qstring_get_str(hmp.outbuf));
619 } else {
620 output = g_strdup("");
622 qemu_mutex_unlock(&hmp.out_lock);
624 out:
625 monitor_data_destroy(&hmp);
626 return output;
629 static int compare_cmd(const char *name, const char *list)
631 const char *p, *pstart;
632 int len;
633 len = strlen(name);
634 p = list;
635 for(;;) {
636 pstart = p;
637 p = strchr(p, '|');
638 if (!p)
639 p = pstart + strlen(pstart);
640 if ((p - pstart) == len && !memcmp(pstart, name, len))
641 return 1;
642 if (*p == '\0')
643 break;
644 p++;
646 return 0;
649 static int get_str(char *buf, int buf_size, const char **pp)
651 const char *p;
652 char *q;
653 int c;
655 q = buf;
656 p = *pp;
657 while (qemu_isspace(*p)) {
658 p++;
660 if (*p == '\0') {
661 fail:
662 *q = '\0';
663 *pp = p;
664 return -1;
666 if (*p == '\"') {
667 p++;
668 while (*p != '\0' && *p != '\"') {
669 if (*p == '\\') {
670 p++;
671 c = *p++;
672 switch (c) {
673 case 'n':
674 c = '\n';
675 break;
676 case 'r':
677 c = '\r';
678 break;
679 case '\\':
680 case '\'':
681 case '\"':
682 break;
683 default:
684 printf("unsupported escape code: '\\%c'\n", c);
685 goto fail;
687 if ((q - buf) < buf_size - 1) {
688 *q++ = c;
690 } else {
691 if ((q - buf) < buf_size - 1) {
692 *q++ = *p;
694 p++;
697 if (*p != '\"') {
698 printf("unterminated string\n");
699 goto fail;
701 p++;
702 } else {
703 while (*p != '\0' && !qemu_isspace(*p)) {
704 if ((q - buf) < buf_size - 1) {
705 *q++ = *p;
707 p++;
710 *q = '\0';
711 *pp = p;
712 return 0;
715 #define MAX_ARGS 16
717 static void free_cmdline_args(char **args, int nb_args)
719 int i;
721 assert(nb_args <= MAX_ARGS);
723 for (i = 0; i < nb_args; i++) {
724 g_free(args[i]);
730 * Parse the command line to get valid args.
731 * @cmdline: command line to be parsed.
732 * @pnb_args: location to store the number of args, must NOT be NULL.
733 * @args: location to store the args, which should be freed by caller, must
734 * NOT be NULL.
736 * Returns 0 on success, negative on failure.
738 * NOTE: this parser is an approximate form of the real command parser. Number
739 * of args have a limit of MAX_ARGS. If cmdline contains more, it will
740 * return with failure.
742 static int parse_cmdline(const char *cmdline,
743 int *pnb_args, char **args)
745 const char *p;
746 int nb_args, ret;
747 char buf[1024];
749 p = cmdline;
750 nb_args = 0;
751 for (;;) {
752 while (qemu_isspace(*p)) {
753 p++;
755 if (*p == '\0') {
756 break;
758 if (nb_args >= MAX_ARGS) {
759 goto fail;
761 ret = get_str(buf, sizeof(buf), &p);
762 if (ret < 0) {
763 goto fail;
765 args[nb_args] = g_strdup(buf);
766 nb_args++;
768 *pnb_args = nb_args;
769 return 0;
771 fail:
772 free_cmdline_args(args, nb_args);
773 return -1;
776 static void help_cmd_dump_one(Monitor *mon,
777 const mon_cmd_t *cmd,
778 char **prefix_args,
779 int prefix_args_nb)
781 int i;
783 for (i = 0; i < prefix_args_nb; i++) {
784 monitor_printf(mon, "%s ", prefix_args[i]);
786 monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
789 /* @args[@arg_index] is the valid command need to find in @cmds */
790 static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
791 char **args, int nb_args, int arg_index)
793 const mon_cmd_t *cmd;
795 /* No valid arg need to compare with, dump all in *cmds */
796 if (arg_index >= nb_args) {
797 for (cmd = cmds; cmd->name != NULL; cmd++) {
798 help_cmd_dump_one(mon, cmd, args, arg_index);
800 return;
803 /* Find one entry to dump */
804 for (cmd = cmds; cmd->name != NULL; cmd++) {
805 if (compare_cmd(args[arg_index], cmd->name)) {
806 if (cmd->sub_table) {
807 /* continue with next arg */
808 help_cmd_dump(mon, cmd->sub_table,
809 args, nb_args, arg_index + 1);
810 } else {
811 help_cmd_dump_one(mon, cmd, args, arg_index);
813 break;
818 static void help_cmd(Monitor *mon, const char *name)
820 char *args[MAX_ARGS];
821 int nb_args = 0;
823 /* 1. parse user input */
824 if (name) {
825 /* special case for log, directly dump and return */
826 if (!strcmp(name, "log")) {
827 const QEMULogItem *item;
828 monitor_printf(mon, "Log items (comma separated):\n");
829 monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
830 for (item = qemu_log_items; item->mask != 0; item++) {
831 monitor_printf(mon, "%-10s %s\n", item->name, item->help);
833 return;
836 if (parse_cmdline(name, &nb_args, args) < 0) {
837 return;
841 /* 2. dump the contents according to parsed args */
842 help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
844 free_cmdline_args(args, nb_args);
847 static void do_help_cmd(Monitor *mon, const QDict *qdict)
849 help_cmd(mon, qdict_get_try_str(qdict, "name"));
852 static void hmp_trace_event(Monitor *mon, const QDict *qdict)
854 const char *tp_name = qdict_get_str(qdict, "name");
855 bool new_state = qdict_get_bool(qdict, "option");
856 bool has_vcpu = qdict_haskey(qdict, "vcpu");
857 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
858 Error *local_err = NULL;
860 if (vcpu < 0) {
861 monitor_printf(mon, "argument vcpu must be positive");
862 return;
865 qmp_trace_event_set_state(tp_name, new_state, true, true, has_vcpu, vcpu, &local_err);
866 if (local_err) {
867 error_report_err(local_err);
871 #ifdef CONFIG_TRACE_SIMPLE
872 static void hmp_trace_file(Monitor *mon, const QDict *qdict)
874 const char *op = qdict_get_try_str(qdict, "op");
875 const char *arg = qdict_get_try_str(qdict, "arg");
877 if (!op) {
878 st_print_trace_file_status((FILE *)mon, &monitor_fprintf);
879 } else if (!strcmp(op, "on")) {
880 st_set_trace_file_enabled(true);
881 } else if (!strcmp(op, "off")) {
882 st_set_trace_file_enabled(false);
883 } else if (!strcmp(op, "flush")) {
884 st_flush_trace_buffer();
885 } else if (!strcmp(op, "set")) {
886 if (arg) {
887 st_set_trace_file(arg);
889 } else {
890 monitor_printf(mon, "unexpected argument \"%s\"\n", op);
891 help_cmd(mon, "trace-file");
894 #endif
896 static void hmp_info_help(Monitor *mon, const QDict *qdict)
898 help_cmd(mon, "info");
901 static void query_commands_cb(QmpCommand *cmd, void *opaque)
903 CommandInfoList *info, **list = opaque;
905 if (!cmd->enabled) {
906 return;
909 info = g_malloc0(sizeof(*info));
910 info->value = g_malloc0(sizeof(*info->value));
911 info->value->name = g_strdup(cmd->name);
912 info->next = *list;
913 *list = info;
916 CommandInfoList *qmp_query_commands(Error **errp)
918 CommandInfoList *list = NULL;
920 qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
922 return list;
925 EventInfoList *qmp_query_events(Error **errp)
927 EventInfoList *info, *ev_list = NULL;
928 QAPIEvent e;
930 for (e = 0 ; e < QAPI_EVENT__MAX ; e++) {
931 const char *event_name = QAPIEvent_lookup[e];
932 assert(event_name != NULL);
933 info = g_malloc0(sizeof(*info));
934 info->value = g_malloc0(sizeof(*info->value));
935 info->value->name = g_strdup(event_name);
937 info->next = ev_list;
938 ev_list = info;
941 return ev_list;
945 * Minor hack: generated marshalling suppressed for this command
946 * ('gen': false in the schema) so we can parse the JSON string
947 * directly into QObject instead of first parsing it with
948 * visit_type_SchemaInfoList() into a SchemaInfoList, then marshal it
949 * to QObject with generated output marshallers, every time. Instead,
950 * we do it in test-qobject-input-visitor.c, just to make sure
951 * qapi-introspect.py's output actually conforms to the schema.
953 static void qmp_query_qmp_schema(QDict *qdict, QObject **ret_data,
954 Error **errp)
956 *ret_data = qobject_from_json(qmp_schema_json, &error_abort);
960 * We used to define commands in qmp-commands.hx in addition to the
961 * QAPI schema. This permitted defining some of them only in certain
962 * configurations. query-commands has always reflected that (good,
963 * because it lets QMP clients figure out what's actually available),
964 * while query-qmp-schema never did (not so good). This function is a
965 * hack to keep the configuration-specific commands defined exactly as
966 * before, even though qmp-commands.hx is gone.
968 * FIXME Educate the QAPI schema on configuration-specific commands,
969 * and drop this hack.
971 static void qmp_unregister_commands_hack(void)
973 #ifndef CONFIG_SPICE
974 qmp_unregister_command(&qmp_commands, "query-spice");
975 #endif
976 #ifndef TARGET_I386
977 qmp_unregister_command(&qmp_commands, "rtc-reset-reinjection");
978 #endif
979 #ifndef TARGET_S390X
980 qmp_unregister_command(&qmp_commands, "dump-skeys");
981 #endif
982 #ifndef TARGET_ARM
983 qmp_unregister_command(&qmp_commands, "query-gic-capabilities");
984 #endif
985 #if !defined(TARGET_S390X) && !defined(TARGET_I386)
986 qmp_unregister_command(&qmp_commands, "query-cpu-model-expansion");
987 #endif
988 #if !defined(TARGET_S390X)
989 qmp_unregister_command(&qmp_commands, "query-cpu-model-baseline");
990 qmp_unregister_command(&qmp_commands, "query-cpu-model-comparison");
991 #endif
992 #if !defined(TARGET_PPC) && !defined(TARGET_ARM) && !defined(TARGET_I386) \
993 && !defined(TARGET_S390X)
994 qmp_unregister_command(&qmp_commands, "query-cpu-definitions");
995 #endif
998 void monitor_init_qmp_commands(void)
1001 * Two command lists:
1002 * - qmp_commands contains all QMP commands
1003 * - qmp_cap_negotiation_commands contains just
1004 * "qmp_capabilities", to enforce capability negotiation
1007 qmp_init_marshal(&qmp_commands);
1009 qmp_register_command(&qmp_commands, "query-qmp-schema",
1010 qmp_query_qmp_schema,
1011 QCO_NO_OPTIONS);
1012 qmp_register_command(&qmp_commands, "device_add", qmp_device_add,
1013 QCO_NO_OPTIONS);
1014 qmp_register_command(&qmp_commands, "netdev_add", qmp_netdev_add,
1015 QCO_NO_OPTIONS);
1017 qmp_unregister_commands_hack();
1019 QTAILQ_INIT(&qmp_cap_negotiation_commands);
1020 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
1021 qmp_marshal_qmp_capabilities, QCO_NO_OPTIONS);
1024 void qmp_qmp_capabilities(Error **errp)
1026 if (cur_mon->qmp.commands == &qmp_commands) {
1027 error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
1028 "Capabilities negotiation is already complete, command "
1029 "ignored");
1030 return;
1033 cur_mon->qmp.commands = &qmp_commands;
1036 /* set the current CPU defined by the user */
1037 int monitor_set_cpu(int cpu_index)
1039 CPUState *cpu;
1041 cpu = qemu_get_cpu(cpu_index);
1042 if (cpu == NULL) {
1043 return -1;
1045 cur_mon->mon_cpu = cpu;
1046 return 0;
1049 CPUState *mon_get_cpu(void)
1051 if (!cur_mon->mon_cpu) {
1052 if (!first_cpu) {
1053 return NULL;
1055 monitor_set_cpu(first_cpu->cpu_index);
1057 cpu_synchronize_state(cur_mon->mon_cpu);
1058 return cur_mon->mon_cpu;
1061 CPUArchState *mon_get_cpu_env(void)
1063 CPUState *cs = mon_get_cpu();
1065 return cs ? cs->env_ptr : NULL;
1068 int monitor_get_cpu_index(void)
1070 CPUState *cs = mon_get_cpu();
1072 return cs ? cs->cpu_index : UNASSIGNED_CPU_INDEX;
1075 static void hmp_info_registers(Monitor *mon, const QDict *qdict)
1077 CPUState *cs = mon_get_cpu();
1079 if (!cs) {
1080 monitor_printf(mon, "No CPU available\n");
1081 return;
1083 cpu_dump_state(cs, (FILE *)mon, monitor_fprintf, CPU_DUMP_FPU);
1086 static void hmp_info_jit(Monitor *mon, const QDict *qdict)
1088 dump_exec_info((FILE *)mon, monitor_fprintf);
1089 dump_drift_info((FILE *)mon, monitor_fprintf);
1092 static void hmp_info_opcount(Monitor *mon, const QDict *qdict)
1094 dump_opcount_info((FILE *)mon, monitor_fprintf);
1097 static void hmp_info_history(Monitor *mon, const QDict *qdict)
1099 int i;
1100 const char *str;
1102 if (!mon->rs)
1103 return;
1104 i = 0;
1105 for(;;) {
1106 str = readline_get_history(mon->rs, i);
1107 if (!str)
1108 break;
1109 monitor_printf(mon, "%d: '%s'\n", i, str);
1110 i++;
1114 static void hmp_info_cpustats(Monitor *mon, const QDict *qdict)
1116 CPUState *cs = mon_get_cpu();
1118 if (!cs) {
1119 monitor_printf(mon, "No CPU available\n");
1120 return;
1122 cpu_dump_statistics(cs, (FILE *)mon, &monitor_fprintf, 0);
1125 static void hmp_info_trace_events(Monitor *mon, const QDict *qdict)
1127 const char *name = qdict_get_try_str(qdict, "name");
1128 bool has_vcpu = qdict_haskey(qdict, "vcpu");
1129 int vcpu = qdict_get_try_int(qdict, "vcpu", 0);
1130 TraceEventInfoList *events;
1131 TraceEventInfoList *elem;
1132 Error *local_err = NULL;
1134 if (name == NULL) {
1135 name = "*";
1137 if (vcpu < 0) {
1138 monitor_printf(mon, "argument vcpu must be positive");
1139 return;
1142 events = qmp_trace_event_get_state(name, has_vcpu, vcpu, &local_err);
1143 if (local_err) {
1144 error_report_err(local_err);
1145 return;
1148 for (elem = events; elem != NULL; elem = elem->next) {
1149 monitor_printf(mon, "%s : state %u\n",
1150 elem->value->name,
1151 elem->value->state == TRACE_EVENT_STATE_ENABLED ? 1 : 0);
1153 qapi_free_TraceEventInfoList(events);
1156 void qmp_client_migrate_info(const char *protocol, const char *hostname,
1157 bool has_port, int64_t port,
1158 bool has_tls_port, int64_t tls_port,
1159 bool has_cert_subject, const char *cert_subject,
1160 Error **errp)
1162 if (strcmp(protocol, "spice") == 0) {
1163 if (!qemu_using_spice(errp)) {
1164 return;
1167 if (!has_port && !has_tls_port) {
1168 error_setg(errp, QERR_MISSING_PARAMETER, "port/tls-port");
1169 return;
1172 if (qemu_spice_migrate_info(hostname,
1173 has_port ? port : -1,
1174 has_tls_port ? tls_port : -1,
1175 cert_subject)) {
1176 error_setg(errp, QERR_UNDEFINED_ERROR);
1177 return;
1179 return;
1182 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "protocol", "spice");
1185 static void hmp_logfile(Monitor *mon, const QDict *qdict)
1187 Error *err = NULL;
1189 qemu_set_log_filename(qdict_get_str(qdict, "filename"), &err);
1190 if (err) {
1191 error_report_err(err);
1195 static void hmp_log(Monitor *mon, const QDict *qdict)
1197 int mask;
1198 const char *items = qdict_get_str(qdict, "items");
1200 if (!strcmp(items, "none")) {
1201 mask = 0;
1202 } else {
1203 mask = qemu_str_to_log_mask(items);
1204 if (!mask) {
1205 help_cmd(mon, "log");
1206 return;
1209 qemu_set_log(mask);
1212 static void hmp_singlestep(Monitor *mon, const QDict *qdict)
1214 const char *option = qdict_get_try_str(qdict, "option");
1215 if (!option || !strcmp(option, "on")) {
1216 singlestep = 1;
1217 } else if (!strcmp(option, "off")) {
1218 singlestep = 0;
1219 } else {
1220 monitor_printf(mon, "unexpected option %s\n", option);
1224 static void hmp_gdbserver(Monitor *mon, const QDict *qdict)
1226 const char *device = qdict_get_try_str(qdict, "device");
1227 if (!device)
1228 device = "tcp::" DEFAULT_GDBSTUB_PORT;
1229 if (gdbserver_start(device) < 0) {
1230 monitor_printf(mon, "Could not open gdbserver on device '%s'\n",
1231 device);
1232 } else if (strcmp(device, "none") == 0) {
1233 monitor_printf(mon, "Disabled gdbserver\n");
1234 } else {
1235 monitor_printf(mon, "Waiting for gdb connection on device '%s'\n",
1236 device);
1240 static void hmp_watchdog_action(Monitor *mon, const QDict *qdict)
1242 const char *action = qdict_get_str(qdict, "action");
1243 if (select_watchdog_action(action) == -1) {
1244 monitor_printf(mon, "Unknown watchdog action '%s'\n", action);
1248 static void monitor_printc(Monitor *mon, int c)
1250 monitor_printf(mon, "'");
1251 switch(c) {
1252 case '\'':
1253 monitor_printf(mon, "\\'");
1254 break;
1255 case '\\':
1256 monitor_printf(mon, "\\\\");
1257 break;
1258 case '\n':
1259 monitor_printf(mon, "\\n");
1260 break;
1261 case '\r':
1262 monitor_printf(mon, "\\r");
1263 break;
1264 default:
1265 if (c >= 32 && c <= 126) {
1266 monitor_printf(mon, "%c", c);
1267 } else {
1268 monitor_printf(mon, "\\x%02x", c);
1270 break;
1272 monitor_printf(mon, "'");
1275 static void memory_dump(Monitor *mon, int count, int format, int wsize,
1276 hwaddr addr, int is_physical)
1278 int l, line_size, i, max_digits, len;
1279 uint8_t buf[16];
1280 uint64_t v;
1281 CPUState *cs = mon_get_cpu();
1283 if (!cs && (format == 'i' || !is_physical)) {
1284 monitor_printf(mon, "Can not dump without CPU\n");
1285 return;
1288 if (format == 'i') {
1289 int flags = 0;
1290 #ifdef TARGET_I386
1291 CPUArchState *env = mon_get_cpu_env();
1292 if (wsize == 2) {
1293 flags = 1;
1294 } else if (wsize == 4) {
1295 flags = 0;
1296 } else {
1297 /* as default we use the current CS size */
1298 flags = 0;
1299 if (env) {
1300 #ifdef TARGET_X86_64
1301 if ((env->efer & MSR_EFER_LMA) &&
1302 (env->segs[R_CS].flags & DESC_L_MASK))
1303 flags = 2;
1304 else
1305 #endif
1306 if (!(env->segs[R_CS].flags & DESC_B_MASK))
1307 flags = 1;
1310 #endif
1311 #ifdef TARGET_PPC
1312 CPUArchState *env = mon_get_cpu_env();
1313 flags = msr_le << 16;
1314 flags |= env->bfd_mach;
1315 #endif
1316 monitor_disas(mon, cs, addr, count, is_physical, flags);
1317 return;
1320 len = wsize * count;
1321 if (wsize == 1)
1322 line_size = 8;
1323 else
1324 line_size = 16;
1325 max_digits = 0;
1327 switch(format) {
1328 case 'o':
1329 max_digits = (wsize * 8 + 2) / 3;
1330 break;
1331 default:
1332 case 'x':
1333 max_digits = (wsize * 8) / 4;
1334 break;
1335 case 'u':
1336 case 'd':
1337 max_digits = (wsize * 8 * 10 + 32) / 33;
1338 break;
1339 case 'c':
1340 wsize = 1;
1341 break;
1344 while (len > 0) {
1345 if (is_physical)
1346 monitor_printf(mon, TARGET_FMT_plx ":", addr);
1347 else
1348 monitor_printf(mon, TARGET_FMT_lx ":", (target_ulong)addr);
1349 l = len;
1350 if (l > line_size)
1351 l = line_size;
1352 if (is_physical) {
1353 cpu_physical_memory_read(addr, buf, l);
1354 } else {
1355 if (cpu_memory_rw_debug(cs, addr, buf, l, 0) < 0) {
1356 monitor_printf(mon, " Cannot access memory\n");
1357 break;
1360 i = 0;
1361 while (i < l) {
1362 switch(wsize) {
1363 default:
1364 case 1:
1365 v = ldub_p(buf + i);
1366 break;
1367 case 2:
1368 v = lduw_p(buf + i);
1369 break;
1370 case 4:
1371 v = (uint32_t)ldl_p(buf + i);
1372 break;
1373 case 8:
1374 v = ldq_p(buf + i);
1375 break;
1377 monitor_printf(mon, " ");
1378 switch(format) {
1379 case 'o':
1380 monitor_printf(mon, "%#*" PRIo64, max_digits, v);
1381 break;
1382 case 'x':
1383 monitor_printf(mon, "0x%0*" PRIx64, max_digits, v);
1384 break;
1385 case 'u':
1386 monitor_printf(mon, "%*" PRIu64, max_digits, v);
1387 break;
1388 case 'd':
1389 monitor_printf(mon, "%*" PRId64, max_digits, v);
1390 break;
1391 case 'c':
1392 monitor_printc(mon, v);
1393 break;
1395 i += wsize;
1397 monitor_printf(mon, "\n");
1398 addr += l;
1399 len -= l;
1403 static void hmp_memory_dump(Monitor *mon, const QDict *qdict)
1405 int count = qdict_get_int(qdict, "count");
1406 int format = qdict_get_int(qdict, "format");
1407 int size = qdict_get_int(qdict, "size");
1408 target_long addr = qdict_get_int(qdict, "addr");
1410 memory_dump(mon, count, format, size, addr, 0);
1413 static void hmp_physical_memory_dump(Monitor *mon, const QDict *qdict)
1415 int count = qdict_get_int(qdict, "count");
1416 int format = qdict_get_int(qdict, "format");
1417 int size = qdict_get_int(qdict, "size");
1418 hwaddr addr = qdict_get_int(qdict, "addr");
1420 memory_dump(mon, count, format, size, addr, 1);
1423 static void do_print(Monitor *mon, const QDict *qdict)
1425 int format = qdict_get_int(qdict, "format");
1426 hwaddr val = qdict_get_int(qdict, "val");
1428 switch(format) {
1429 case 'o':
1430 monitor_printf(mon, "%#" HWADDR_PRIo, val);
1431 break;
1432 case 'x':
1433 monitor_printf(mon, "%#" HWADDR_PRIx, val);
1434 break;
1435 case 'u':
1436 monitor_printf(mon, "%" HWADDR_PRIu, val);
1437 break;
1438 default:
1439 case 'd':
1440 monitor_printf(mon, "%" HWADDR_PRId, val);
1441 break;
1442 case 'c':
1443 monitor_printc(mon, val);
1444 break;
1446 monitor_printf(mon, "\n");
1449 static void hmp_sum(Monitor *mon, const QDict *qdict)
1451 uint32_t addr;
1452 uint16_t sum;
1453 uint32_t start = qdict_get_int(qdict, "start");
1454 uint32_t size = qdict_get_int(qdict, "size");
1456 sum = 0;
1457 for(addr = start; addr < (start + size); addr++) {
1458 uint8_t val = address_space_ldub(&address_space_memory, addr,
1459 MEMTXATTRS_UNSPECIFIED, NULL);
1460 /* BSD sum algorithm ('sum' Unix command) */
1461 sum = (sum >> 1) | (sum << 15);
1462 sum += val;
1464 monitor_printf(mon, "%05d\n", sum);
1467 static int mouse_button_state;
1469 static void hmp_mouse_move(Monitor *mon, const QDict *qdict)
1471 int dx, dy, dz, button;
1472 const char *dx_str = qdict_get_str(qdict, "dx_str");
1473 const char *dy_str = qdict_get_str(qdict, "dy_str");
1474 const char *dz_str = qdict_get_try_str(qdict, "dz_str");
1476 dx = strtol(dx_str, NULL, 0);
1477 dy = strtol(dy_str, NULL, 0);
1478 qemu_input_queue_rel(NULL, INPUT_AXIS_X, dx);
1479 qemu_input_queue_rel(NULL, INPUT_AXIS_Y, dy);
1481 if (dz_str) {
1482 dz = strtol(dz_str, NULL, 0);
1483 if (dz != 0) {
1484 button = (dz > 0) ? INPUT_BUTTON_WHEEL_UP : INPUT_BUTTON_WHEEL_DOWN;
1485 qemu_input_queue_btn(NULL, button, true);
1486 qemu_input_event_sync();
1487 qemu_input_queue_btn(NULL, button, false);
1490 qemu_input_event_sync();
1493 static void hmp_mouse_button(Monitor *mon, const QDict *qdict)
1495 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1496 [INPUT_BUTTON_LEFT] = MOUSE_EVENT_LBUTTON,
1497 [INPUT_BUTTON_MIDDLE] = MOUSE_EVENT_MBUTTON,
1498 [INPUT_BUTTON_RIGHT] = MOUSE_EVENT_RBUTTON,
1500 int button_state = qdict_get_int(qdict, "button_state");
1502 if (mouse_button_state == button_state) {
1503 return;
1505 qemu_input_update_buttons(NULL, bmap, mouse_button_state, button_state);
1506 qemu_input_event_sync();
1507 mouse_button_state = button_state;
1510 static void hmp_ioport_read(Monitor *mon, const QDict *qdict)
1512 int size = qdict_get_int(qdict, "size");
1513 int addr = qdict_get_int(qdict, "addr");
1514 int has_index = qdict_haskey(qdict, "index");
1515 uint32_t val;
1516 int suffix;
1518 if (has_index) {
1519 int index = qdict_get_int(qdict, "index");
1520 cpu_outb(addr & IOPORTS_MASK, index & 0xff);
1521 addr++;
1523 addr &= 0xffff;
1525 switch(size) {
1526 default:
1527 case 1:
1528 val = cpu_inb(addr);
1529 suffix = 'b';
1530 break;
1531 case 2:
1532 val = cpu_inw(addr);
1533 suffix = 'w';
1534 break;
1535 case 4:
1536 val = cpu_inl(addr);
1537 suffix = 'l';
1538 break;
1540 monitor_printf(mon, "port%c[0x%04x] = %#0*x\n",
1541 suffix, addr, size * 2, val);
1544 static void hmp_ioport_write(Monitor *mon, const QDict *qdict)
1546 int size = qdict_get_int(qdict, "size");
1547 int addr = qdict_get_int(qdict, "addr");
1548 int val = qdict_get_int(qdict, "val");
1550 addr &= IOPORTS_MASK;
1552 switch (size) {
1553 default:
1554 case 1:
1555 cpu_outb(addr, val);
1556 break;
1557 case 2:
1558 cpu_outw(addr, val);
1559 break;
1560 case 4:
1561 cpu_outl(addr, val);
1562 break;
1566 static void hmp_boot_set(Monitor *mon, const QDict *qdict)
1568 Error *local_err = NULL;
1569 const char *bootdevice = qdict_get_str(qdict, "bootdevice");
1571 qemu_boot_set(bootdevice, &local_err);
1572 if (local_err) {
1573 error_report_err(local_err);
1574 } else {
1575 monitor_printf(mon, "boot device list now set to %s\n", bootdevice);
1579 static void hmp_info_mtree(Monitor *mon, const QDict *qdict)
1581 bool flatview = qdict_get_try_bool(qdict, "flatview", false);
1583 mtree_info((fprintf_function)monitor_printf, mon, flatview);
1586 static void hmp_info_numa(Monitor *mon, const QDict *qdict)
1588 int i;
1589 CPUState *cpu;
1590 uint64_t *node_mem;
1592 node_mem = g_new0(uint64_t, nb_numa_nodes);
1593 query_numa_node_mem(node_mem);
1594 monitor_printf(mon, "%d nodes\n", nb_numa_nodes);
1595 for (i = 0; i < nb_numa_nodes; i++) {
1596 monitor_printf(mon, "node %d cpus:", i);
1597 CPU_FOREACH(cpu) {
1598 if (cpu->numa_node == i) {
1599 monitor_printf(mon, " %d", cpu->cpu_index);
1602 monitor_printf(mon, "\n");
1603 monitor_printf(mon, "node %d size: %" PRId64 " MB\n", i,
1604 node_mem[i] >> 20);
1606 g_free(node_mem);
1609 #ifdef CONFIG_PROFILER
1611 int64_t tcg_time;
1612 int64_t dev_time;
1614 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1616 monitor_printf(mon, "async time %" PRId64 " (%0.3f)\n",
1617 dev_time, dev_time / (double)NANOSECONDS_PER_SECOND);
1618 monitor_printf(mon, "qemu time %" PRId64 " (%0.3f)\n",
1619 tcg_time, tcg_time / (double)NANOSECONDS_PER_SECOND);
1620 tcg_time = 0;
1621 dev_time = 0;
1623 #else
1624 static void hmp_info_profile(Monitor *mon, const QDict *qdict)
1626 monitor_printf(mon, "Internal profiler not compiled\n");
1628 #endif
1630 /* Capture support */
1631 static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
1633 static void hmp_info_capture(Monitor *mon, const QDict *qdict)
1635 int i;
1636 CaptureState *s;
1638 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1639 monitor_printf(mon, "[%d]: ", i);
1640 s->ops.info (s->opaque);
1644 static void hmp_stopcapture(Monitor *mon, const QDict *qdict)
1646 int i;
1647 int n = qdict_get_int(qdict, "n");
1648 CaptureState *s;
1650 for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) {
1651 if (i == n) {
1652 s->ops.destroy (s->opaque);
1653 QLIST_REMOVE (s, entries);
1654 g_free (s);
1655 return;
1660 static void hmp_wavcapture(Monitor *mon, const QDict *qdict)
1662 const char *path = qdict_get_str(qdict, "path");
1663 int has_freq = qdict_haskey(qdict, "freq");
1664 int freq = qdict_get_try_int(qdict, "freq", -1);
1665 int has_bits = qdict_haskey(qdict, "bits");
1666 int bits = qdict_get_try_int(qdict, "bits", -1);
1667 int has_channels = qdict_haskey(qdict, "nchannels");
1668 int nchannels = qdict_get_try_int(qdict, "nchannels", -1);
1669 CaptureState *s;
1671 s = g_malloc0 (sizeof (*s));
1673 freq = has_freq ? freq : 44100;
1674 bits = has_bits ? bits : 16;
1675 nchannels = has_channels ? nchannels : 2;
1677 if (wav_start_capture (s, path, freq, bits, nchannels)) {
1678 monitor_printf(mon, "Failed to add wave capture\n");
1679 g_free (s);
1680 return;
1682 QLIST_INSERT_HEAD (&capture_head, s, entries);
1685 static qemu_acl *find_acl(Monitor *mon, const char *name)
1687 qemu_acl *acl = qemu_acl_find(name);
1689 if (!acl) {
1690 monitor_printf(mon, "acl: unknown list '%s'\n", name);
1692 return acl;
1695 static void hmp_acl_show(Monitor *mon, const QDict *qdict)
1697 const char *aclname = qdict_get_str(qdict, "aclname");
1698 qemu_acl *acl = find_acl(mon, aclname);
1699 qemu_acl_entry *entry;
1700 int i = 0;
1702 if (acl) {
1703 monitor_printf(mon, "policy: %s\n",
1704 acl->defaultDeny ? "deny" : "allow");
1705 QTAILQ_FOREACH(entry, &acl->entries, next) {
1706 i++;
1707 monitor_printf(mon, "%d: %s %s\n", i,
1708 entry->deny ? "deny" : "allow", entry->match);
1713 static void hmp_acl_reset(Monitor *mon, const QDict *qdict)
1715 const char *aclname = qdict_get_str(qdict, "aclname");
1716 qemu_acl *acl = find_acl(mon, aclname);
1718 if (acl) {
1719 qemu_acl_reset(acl);
1720 monitor_printf(mon, "acl: removed all rules\n");
1724 static void hmp_acl_policy(Monitor *mon, const QDict *qdict)
1726 const char *aclname = qdict_get_str(qdict, "aclname");
1727 const char *policy = qdict_get_str(qdict, "policy");
1728 qemu_acl *acl = find_acl(mon, aclname);
1730 if (acl) {
1731 if (strcmp(policy, "allow") == 0) {
1732 acl->defaultDeny = 0;
1733 monitor_printf(mon, "acl: policy set to 'allow'\n");
1734 } else if (strcmp(policy, "deny") == 0) {
1735 acl->defaultDeny = 1;
1736 monitor_printf(mon, "acl: policy set to 'deny'\n");
1737 } else {
1738 monitor_printf(mon, "acl: unknown policy '%s', "
1739 "expected 'deny' or 'allow'\n", policy);
1744 static void hmp_acl_add(Monitor *mon, const QDict *qdict)
1746 const char *aclname = qdict_get_str(qdict, "aclname");
1747 const char *match = qdict_get_str(qdict, "match");
1748 const char *policy = qdict_get_str(qdict, "policy");
1749 int has_index = qdict_haskey(qdict, "index");
1750 int index = qdict_get_try_int(qdict, "index", -1);
1751 qemu_acl *acl = find_acl(mon, aclname);
1752 int deny, ret;
1754 if (acl) {
1755 if (strcmp(policy, "allow") == 0) {
1756 deny = 0;
1757 } else if (strcmp(policy, "deny") == 0) {
1758 deny = 1;
1759 } else {
1760 monitor_printf(mon, "acl: unknown policy '%s', "
1761 "expected 'deny' or 'allow'\n", policy);
1762 return;
1764 if (has_index)
1765 ret = qemu_acl_insert(acl, deny, match, index);
1766 else
1767 ret = qemu_acl_append(acl, deny, match);
1768 if (ret < 0)
1769 monitor_printf(mon, "acl: unable to add acl entry\n");
1770 else
1771 monitor_printf(mon, "acl: added rule at position %d\n", ret);
1775 static void hmp_acl_remove(Monitor *mon, const QDict *qdict)
1777 const char *aclname = qdict_get_str(qdict, "aclname");
1778 const char *match = qdict_get_str(qdict, "match");
1779 qemu_acl *acl = find_acl(mon, aclname);
1780 int ret;
1782 if (acl) {
1783 ret = qemu_acl_remove(acl, match);
1784 if (ret < 0)
1785 monitor_printf(mon, "acl: no matching acl entry\n");
1786 else
1787 monitor_printf(mon, "acl: removed rule at position %d\n", ret);
1791 void qmp_getfd(const char *fdname, Error **errp)
1793 mon_fd_t *monfd;
1794 int fd;
1796 fd = qemu_chr_fe_get_msgfd(&cur_mon->chr);
1797 if (fd == -1) {
1798 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1799 return;
1802 if (qemu_isdigit(fdname[0])) {
1803 close(fd);
1804 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdname",
1805 "a name not starting with a digit");
1806 return;
1809 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1810 if (strcmp(monfd->name, fdname) != 0) {
1811 continue;
1814 close(monfd->fd);
1815 monfd->fd = fd;
1816 return;
1819 monfd = g_malloc0(sizeof(mon_fd_t));
1820 monfd->name = g_strdup(fdname);
1821 monfd->fd = fd;
1823 QLIST_INSERT_HEAD(&cur_mon->fds, monfd, next);
1826 void qmp_closefd(const char *fdname, Error **errp)
1828 mon_fd_t *monfd;
1830 QLIST_FOREACH(monfd, &cur_mon->fds, next) {
1831 if (strcmp(monfd->name, fdname) != 0) {
1832 continue;
1835 QLIST_REMOVE(monfd, next);
1836 close(monfd->fd);
1837 g_free(monfd->name);
1838 g_free(monfd);
1839 return;
1842 error_setg(errp, QERR_FD_NOT_FOUND, fdname);
1845 static void hmp_loadvm(Monitor *mon, const QDict *qdict)
1847 int saved_vm_running = runstate_is_running();
1848 const char *name = qdict_get_str(qdict, "name");
1850 vm_stop(RUN_STATE_RESTORE_VM);
1852 if (load_vmstate(name) == 0 && saved_vm_running) {
1853 vm_start();
1857 int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
1859 mon_fd_t *monfd;
1861 QLIST_FOREACH(monfd, &mon->fds, next) {
1862 int fd;
1864 if (strcmp(monfd->name, fdname) != 0) {
1865 continue;
1868 fd = monfd->fd;
1870 /* caller takes ownership of fd */
1871 QLIST_REMOVE(monfd, next);
1872 g_free(monfd->name);
1873 g_free(monfd);
1875 return fd;
1878 error_setg(errp, "File descriptor named '%s' has not been found", fdname);
1879 return -1;
1882 static void monitor_fdset_cleanup(MonFdset *mon_fdset)
1884 MonFdsetFd *mon_fdset_fd;
1885 MonFdsetFd *mon_fdset_fd_next;
1887 QLIST_FOREACH_SAFE(mon_fdset_fd, &mon_fdset->fds, next, mon_fdset_fd_next) {
1888 if ((mon_fdset_fd->removed ||
1889 (QLIST_EMPTY(&mon_fdset->dup_fds) && mon_refcount == 0)) &&
1890 runstate_is_running()) {
1891 close(mon_fdset_fd->fd);
1892 g_free(mon_fdset_fd->opaque);
1893 QLIST_REMOVE(mon_fdset_fd, next);
1894 g_free(mon_fdset_fd);
1898 if (QLIST_EMPTY(&mon_fdset->fds) && QLIST_EMPTY(&mon_fdset->dup_fds)) {
1899 QLIST_REMOVE(mon_fdset, next);
1900 g_free(mon_fdset);
1904 static void monitor_fdsets_cleanup(void)
1906 MonFdset *mon_fdset;
1907 MonFdset *mon_fdset_next;
1909 QLIST_FOREACH_SAFE(mon_fdset, &mon_fdsets, next, mon_fdset_next) {
1910 monitor_fdset_cleanup(mon_fdset);
1914 AddfdInfo *qmp_add_fd(bool has_fdset_id, int64_t fdset_id, bool has_opaque,
1915 const char *opaque, Error **errp)
1917 int fd;
1918 Monitor *mon = cur_mon;
1919 AddfdInfo *fdinfo;
1921 fd = qemu_chr_fe_get_msgfd(&mon->chr);
1922 if (fd == -1) {
1923 error_setg(errp, QERR_FD_NOT_SUPPLIED);
1924 goto error;
1927 fdinfo = monitor_fdset_add_fd(fd, has_fdset_id, fdset_id,
1928 has_opaque, opaque, errp);
1929 if (fdinfo) {
1930 return fdinfo;
1933 error:
1934 if (fd != -1) {
1935 close(fd);
1937 return NULL;
1940 void qmp_remove_fd(int64_t fdset_id, bool has_fd, int64_t fd, Error **errp)
1942 MonFdset *mon_fdset;
1943 MonFdsetFd *mon_fdset_fd;
1944 char fd_str[60];
1946 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1947 if (mon_fdset->id != fdset_id) {
1948 continue;
1950 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
1951 if (has_fd) {
1952 if (mon_fdset_fd->fd != fd) {
1953 continue;
1955 mon_fdset_fd->removed = true;
1956 break;
1957 } else {
1958 mon_fdset_fd->removed = true;
1961 if (has_fd && !mon_fdset_fd) {
1962 goto error;
1964 monitor_fdset_cleanup(mon_fdset);
1965 return;
1968 error:
1969 if (has_fd) {
1970 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64 ", fd:%" PRId64,
1971 fdset_id, fd);
1972 } else {
1973 snprintf(fd_str, sizeof(fd_str), "fdset-id:%" PRId64, fdset_id);
1975 error_setg(errp, QERR_FD_NOT_FOUND, fd_str);
1978 FdsetInfoList *qmp_query_fdsets(Error **errp)
1980 MonFdset *mon_fdset;
1981 MonFdsetFd *mon_fdset_fd;
1982 FdsetInfoList *fdset_list = NULL;
1984 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
1985 FdsetInfoList *fdset_info = g_malloc0(sizeof(*fdset_info));
1986 FdsetFdInfoList *fdsetfd_list = NULL;
1988 fdset_info->value = g_malloc0(sizeof(*fdset_info->value));
1989 fdset_info->value->fdset_id = mon_fdset->id;
1991 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
1992 FdsetFdInfoList *fdsetfd_info;
1994 fdsetfd_info = g_malloc0(sizeof(*fdsetfd_info));
1995 fdsetfd_info->value = g_malloc0(sizeof(*fdsetfd_info->value));
1996 fdsetfd_info->value->fd = mon_fdset_fd->fd;
1997 if (mon_fdset_fd->opaque) {
1998 fdsetfd_info->value->has_opaque = true;
1999 fdsetfd_info->value->opaque = g_strdup(mon_fdset_fd->opaque);
2000 } else {
2001 fdsetfd_info->value->has_opaque = false;
2004 fdsetfd_info->next = fdsetfd_list;
2005 fdsetfd_list = fdsetfd_info;
2008 fdset_info->value->fds = fdsetfd_list;
2010 fdset_info->next = fdset_list;
2011 fdset_list = fdset_info;
2014 return fdset_list;
2017 AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
2018 bool has_opaque, const char *opaque,
2019 Error **errp)
2021 MonFdset *mon_fdset = NULL;
2022 MonFdsetFd *mon_fdset_fd;
2023 AddfdInfo *fdinfo;
2025 if (has_fdset_id) {
2026 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2027 /* Break if match found or match impossible due to ordering by ID */
2028 if (fdset_id <= mon_fdset->id) {
2029 if (fdset_id < mon_fdset->id) {
2030 mon_fdset = NULL;
2032 break;
2037 if (mon_fdset == NULL) {
2038 int64_t fdset_id_prev = -1;
2039 MonFdset *mon_fdset_cur = QLIST_FIRST(&mon_fdsets);
2041 if (has_fdset_id) {
2042 if (fdset_id < 0) {
2043 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "fdset-id",
2044 "a non-negative value");
2045 return NULL;
2047 /* Use specified fdset ID */
2048 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2049 mon_fdset_cur = mon_fdset;
2050 if (fdset_id < mon_fdset_cur->id) {
2051 break;
2054 } else {
2055 /* Use first available fdset ID */
2056 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2057 mon_fdset_cur = mon_fdset;
2058 if (fdset_id_prev == mon_fdset_cur->id - 1) {
2059 fdset_id_prev = mon_fdset_cur->id;
2060 continue;
2062 break;
2066 mon_fdset = g_malloc0(sizeof(*mon_fdset));
2067 if (has_fdset_id) {
2068 mon_fdset->id = fdset_id;
2069 } else {
2070 mon_fdset->id = fdset_id_prev + 1;
2073 /* The fdset list is ordered by fdset ID */
2074 if (!mon_fdset_cur) {
2075 QLIST_INSERT_HEAD(&mon_fdsets, mon_fdset, next);
2076 } else if (mon_fdset->id < mon_fdset_cur->id) {
2077 QLIST_INSERT_BEFORE(mon_fdset_cur, mon_fdset, next);
2078 } else {
2079 QLIST_INSERT_AFTER(mon_fdset_cur, mon_fdset, next);
2083 mon_fdset_fd = g_malloc0(sizeof(*mon_fdset_fd));
2084 mon_fdset_fd->fd = fd;
2085 mon_fdset_fd->removed = false;
2086 if (has_opaque) {
2087 mon_fdset_fd->opaque = g_strdup(opaque);
2089 QLIST_INSERT_HEAD(&mon_fdset->fds, mon_fdset_fd, next);
2091 fdinfo = g_malloc0(sizeof(*fdinfo));
2092 fdinfo->fdset_id = mon_fdset->id;
2093 fdinfo->fd = mon_fdset_fd->fd;
2095 return fdinfo;
2098 int monitor_fdset_get_fd(int64_t fdset_id, int flags)
2100 #ifndef _WIN32
2101 MonFdset *mon_fdset;
2102 MonFdsetFd *mon_fdset_fd;
2103 int mon_fd_flags;
2105 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2106 if (mon_fdset->id != fdset_id) {
2107 continue;
2109 QLIST_FOREACH(mon_fdset_fd, &mon_fdset->fds, next) {
2110 mon_fd_flags = fcntl(mon_fdset_fd->fd, F_GETFL);
2111 if (mon_fd_flags == -1) {
2112 return -1;
2115 if ((flags & O_ACCMODE) == (mon_fd_flags & O_ACCMODE)) {
2116 return mon_fdset_fd->fd;
2119 errno = EACCES;
2120 return -1;
2122 #endif
2124 errno = ENOENT;
2125 return -1;
2128 int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
2130 MonFdset *mon_fdset;
2131 MonFdsetFd *mon_fdset_fd_dup;
2133 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2134 if (mon_fdset->id != fdset_id) {
2135 continue;
2137 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2138 if (mon_fdset_fd_dup->fd == dup_fd) {
2139 return -1;
2142 mon_fdset_fd_dup = g_malloc0(sizeof(*mon_fdset_fd_dup));
2143 mon_fdset_fd_dup->fd = dup_fd;
2144 QLIST_INSERT_HEAD(&mon_fdset->dup_fds, mon_fdset_fd_dup, next);
2145 return 0;
2147 return -1;
2150 static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
2152 MonFdset *mon_fdset;
2153 MonFdsetFd *mon_fdset_fd_dup;
2155 QLIST_FOREACH(mon_fdset, &mon_fdsets, next) {
2156 QLIST_FOREACH(mon_fdset_fd_dup, &mon_fdset->dup_fds, next) {
2157 if (mon_fdset_fd_dup->fd == dup_fd) {
2158 if (remove) {
2159 QLIST_REMOVE(mon_fdset_fd_dup, next);
2160 if (QLIST_EMPTY(&mon_fdset->dup_fds)) {
2161 monitor_fdset_cleanup(mon_fdset);
2163 return -1;
2164 } else {
2165 return mon_fdset->id;
2170 return -1;
2173 int monitor_fdset_dup_fd_find(int dup_fd)
2175 return monitor_fdset_dup_fd_find_remove(dup_fd, false);
2178 void monitor_fdset_dup_fd_remove(int dup_fd)
2180 monitor_fdset_dup_fd_find_remove(dup_fd, true);
2183 int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
2185 int fd;
2186 Error *local_err = NULL;
2188 if (!qemu_isdigit(fdname[0]) && mon) {
2189 fd = monitor_get_fd(mon, fdname, &local_err);
2190 } else {
2191 fd = qemu_parse_fd(fdname);
2192 if (fd == -1) {
2193 error_setg(&local_err, "Invalid file descriptor number '%s'",
2194 fdname);
2197 if (local_err) {
2198 error_propagate(errp, local_err);
2199 assert(fd == -1);
2200 } else {
2201 assert(fd != -1);
2204 return fd;
2207 /* Please update hmp-commands.hx when adding or changing commands */
2208 static mon_cmd_t info_cmds[] = {
2209 #include "hmp-commands-info.h"
2210 { NULL, NULL, },
2213 /* mon_cmds and info_cmds would be sorted at runtime */
2214 static mon_cmd_t mon_cmds[] = {
2215 #include "hmp-commands.h"
2216 { NULL, NULL, },
2219 /*******************************************************************/
2221 static const char *pch;
2222 static sigjmp_buf expr_env;
2225 static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
2226 expr_error(Monitor *mon, const char *fmt, ...)
2228 va_list ap;
2229 va_start(ap, fmt);
2230 monitor_vprintf(mon, fmt, ap);
2231 monitor_printf(mon, "\n");
2232 va_end(ap);
2233 siglongjmp(expr_env, 1);
2236 /* return 0 if OK, -1 if not found */
2237 static int get_monitor_def(target_long *pval, const char *name)
2239 const MonitorDef *md = target_monitor_defs();
2240 CPUState *cs = mon_get_cpu();
2241 void *ptr;
2242 uint64_t tmp = 0;
2243 int ret;
2245 if (cs == NULL || md == NULL) {
2246 return -1;
2249 for(; md->name != NULL; md++) {
2250 if (compare_cmd(name, md->name)) {
2251 if (md->get_value) {
2252 *pval = md->get_value(md, md->offset);
2253 } else {
2254 CPUArchState *env = mon_get_cpu_env();
2255 ptr = (uint8_t *)env + md->offset;
2256 switch(md->type) {
2257 case MD_I32:
2258 *pval = *(int32_t *)ptr;
2259 break;
2260 case MD_TLONG:
2261 *pval = *(target_long *)ptr;
2262 break;
2263 default:
2264 *pval = 0;
2265 break;
2268 return 0;
2272 ret = target_get_monitor_def(cs, name, &tmp);
2273 if (!ret) {
2274 *pval = (target_long) tmp;
2277 return ret;
2280 static void next(void)
2282 if (*pch != '\0') {
2283 pch++;
2284 while (qemu_isspace(*pch))
2285 pch++;
2289 static int64_t expr_sum(Monitor *mon);
2291 static int64_t expr_unary(Monitor *mon)
2293 int64_t n;
2294 char *p;
2295 int ret;
2297 switch(*pch) {
2298 case '+':
2299 next();
2300 n = expr_unary(mon);
2301 break;
2302 case '-':
2303 next();
2304 n = -expr_unary(mon);
2305 break;
2306 case '~':
2307 next();
2308 n = ~expr_unary(mon);
2309 break;
2310 case '(':
2311 next();
2312 n = expr_sum(mon);
2313 if (*pch != ')') {
2314 expr_error(mon, "')' expected");
2316 next();
2317 break;
2318 case '\'':
2319 pch++;
2320 if (*pch == '\0')
2321 expr_error(mon, "character constant expected");
2322 n = *pch;
2323 pch++;
2324 if (*pch != '\'')
2325 expr_error(mon, "missing terminating \' character");
2326 next();
2327 break;
2328 case '$':
2330 char buf[128], *q;
2331 target_long reg=0;
2333 pch++;
2334 q = buf;
2335 while ((*pch >= 'a' && *pch <= 'z') ||
2336 (*pch >= 'A' && *pch <= 'Z') ||
2337 (*pch >= '0' && *pch <= '9') ||
2338 *pch == '_' || *pch == '.') {
2339 if ((q - buf) < sizeof(buf) - 1)
2340 *q++ = *pch;
2341 pch++;
2343 while (qemu_isspace(*pch))
2344 pch++;
2345 *q = 0;
2346 ret = get_monitor_def(&reg, buf);
2347 if (ret < 0)
2348 expr_error(mon, "unknown register");
2349 n = reg;
2351 break;
2352 case '\0':
2353 expr_error(mon, "unexpected end of expression");
2354 n = 0;
2355 break;
2356 default:
2357 errno = 0;
2358 n = strtoull(pch, &p, 0);
2359 if (errno == ERANGE) {
2360 expr_error(mon, "number too large");
2362 if (pch == p) {
2363 expr_error(mon, "invalid char '%c' in expression", *p);
2365 pch = p;
2366 while (qemu_isspace(*pch))
2367 pch++;
2368 break;
2370 return n;
2374 static int64_t expr_prod(Monitor *mon)
2376 int64_t val, val2;
2377 int op;
2379 val = expr_unary(mon);
2380 for(;;) {
2381 op = *pch;
2382 if (op != '*' && op != '/' && op != '%')
2383 break;
2384 next();
2385 val2 = expr_unary(mon);
2386 switch(op) {
2387 default:
2388 case '*':
2389 val *= val2;
2390 break;
2391 case '/':
2392 case '%':
2393 if (val2 == 0)
2394 expr_error(mon, "division by zero");
2395 if (op == '/')
2396 val /= val2;
2397 else
2398 val %= val2;
2399 break;
2402 return val;
2405 static int64_t expr_logic(Monitor *mon)
2407 int64_t val, val2;
2408 int op;
2410 val = expr_prod(mon);
2411 for(;;) {
2412 op = *pch;
2413 if (op != '&' && op != '|' && op != '^')
2414 break;
2415 next();
2416 val2 = expr_prod(mon);
2417 switch(op) {
2418 default:
2419 case '&':
2420 val &= val2;
2421 break;
2422 case '|':
2423 val |= val2;
2424 break;
2425 case '^':
2426 val ^= val2;
2427 break;
2430 return val;
2433 static int64_t expr_sum(Monitor *mon)
2435 int64_t val, val2;
2436 int op;
2438 val = expr_logic(mon);
2439 for(;;) {
2440 op = *pch;
2441 if (op != '+' && op != '-')
2442 break;
2443 next();
2444 val2 = expr_logic(mon);
2445 if (op == '+')
2446 val += val2;
2447 else
2448 val -= val2;
2450 return val;
2453 static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
2455 pch = *pp;
2456 if (sigsetjmp(expr_env, 0)) {
2457 *pp = pch;
2458 return -1;
2460 while (qemu_isspace(*pch))
2461 pch++;
2462 *pval = expr_sum(mon);
2463 *pp = pch;
2464 return 0;
2467 static int get_double(Monitor *mon, double *pval, const char **pp)
2469 const char *p = *pp;
2470 char *tailp;
2471 double d;
2473 d = strtod(p, &tailp);
2474 if (tailp == p) {
2475 monitor_printf(mon, "Number expected\n");
2476 return -1;
2478 if (d != d || d - d != 0) {
2479 /* NaN or infinity */
2480 monitor_printf(mon, "Bad number\n");
2481 return -1;
2483 *pval = d;
2484 *pp = tailp;
2485 return 0;
2489 * Store the command-name in cmdname, and return a pointer to
2490 * the remaining of the command string.
2492 static const char *get_command_name(const char *cmdline,
2493 char *cmdname, size_t nlen)
2495 size_t len;
2496 const char *p, *pstart;
2498 p = cmdline;
2499 while (qemu_isspace(*p))
2500 p++;
2501 if (*p == '\0')
2502 return NULL;
2503 pstart = p;
2504 while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
2505 p++;
2506 len = p - pstart;
2507 if (len > nlen - 1)
2508 len = nlen - 1;
2509 memcpy(cmdname, pstart, len);
2510 cmdname[len] = '\0';
2511 return p;
2515 * Read key of 'type' into 'key' and return the current
2516 * 'type' pointer.
2518 static char *key_get_info(const char *type, char **key)
2520 size_t len;
2521 char *p, *str;
2523 if (*type == ',')
2524 type++;
2526 p = strchr(type, ':');
2527 if (!p) {
2528 *key = NULL;
2529 return NULL;
2531 len = p - type;
2533 str = g_malloc(len + 1);
2534 memcpy(str, type, len);
2535 str[len] = '\0';
2537 *key = str;
2538 return ++p;
2541 static int default_fmt_format = 'x';
2542 static int default_fmt_size = 4;
2544 static int is_valid_option(const char *c, const char *typestr)
2546 char option[3];
2548 option[0] = '-';
2549 option[1] = *c;
2550 option[2] = '\0';
2552 typestr = strstr(typestr, option);
2553 return (typestr != NULL);
2556 static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
2557 const char *cmdname)
2559 const mon_cmd_t *cmd;
2561 for (cmd = disp_table; cmd->name != NULL; cmd++) {
2562 if (compare_cmd(cmdname, cmd->name)) {
2563 return cmd;
2567 return NULL;
2571 * Parse command name from @cmdp according to command table @table.
2572 * If blank, return NULL.
2573 * Else, if no valid command can be found, report to @mon, and return
2574 * NULL.
2575 * Else, change @cmdp to point right behind the name, and return its
2576 * command table entry.
2577 * Do not assume the return value points into @table! It doesn't when
2578 * the command is found in a sub-command table.
2580 static const mon_cmd_t *monitor_parse_command(Monitor *mon,
2581 const char **cmdp,
2582 mon_cmd_t *table)
2584 const char *p;
2585 const mon_cmd_t *cmd;
2586 char cmdname[256];
2588 /* extract the command name */
2589 p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
2590 if (!p)
2591 return NULL;
2593 cmd = search_dispatch_table(table, cmdname);
2594 if (!cmd) {
2595 monitor_printf(mon, "unknown command: '%.*s'\n",
2596 (int)(p - *cmdp), *cmdp);
2597 return NULL;
2600 /* filter out following useless space */
2601 while (qemu_isspace(*p)) {
2602 p++;
2605 *cmdp = p;
2606 /* search sub command */
2607 if (cmd->sub_table != NULL && *p != '\0') {
2608 return monitor_parse_command(mon, cmdp, cmd->sub_table);
2611 return cmd;
2615 * Parse arguments for @cmd.
2616 * If it can't be parsed, report to @mon, and return NULL.
2617 * Else, insert command arguments into a QDict, and return it.
2618 * Note: On success, caller has to free the QDict structure.
2621 static QDict *monitor_parse_arguments(Monitor *mon,
2622 const char **endp,
2623 const mon_cmd_t *cmd)
2625 const char *typestr;
2626 char *key;
2627 int c;
2628 const char *p = *endp;
2629 char buf[1024];
2630 QDict *qdict = qdict_new();
2632 /* parse the parameters */
2633 typestr = cmd->args_type;
2634 for(;;) {
2635 typestr = key_get_info(typestr, &key);
2636 if (!typestr)
2637 break;
2638 c = *typestr;
2639 typestr++;
2640 switch(c) {
2641 case 'F':
2642 case 'B':
2643 case 's':
2645 int ret;
2647 while (qemu_isspace(*p))
2648 p++;
2649 if (*typestr == '?') {
2650 typestr++;
2651 if (*p == '\0') {
2652 /* no optional string: NULL argument */
2653 break;
2656 ret = get_str(buf, sizeof(buf), &p);
2657 if (ret < 0) {
2658 switch(c) {
2659 case 'F':
2660 monitor_printf(mon, "%s: filename expected\n",
2661 cmd->name);
2662 break;
2663 case 'B':
2664 monitor_printf(mon, "%s: block device name expected\n",
2665 cmd->name);
2666 break;
2667 default:
2668 monitor_printf(mon, "%s: string expected\n", cmd->name);
2669 break;
2671 goto fail;
2673 qdict_put(qdict, key, qstring_from_str(buf));
2675 break;
2676 case 'O':
2678 QemuOptsList *opts_list;
2679 QemuOpts *opts;
2681 opts_list = qemu_find_opts(key);
2682 if (!opts_list || opts_list->desc->name) {
2683 goto bad_type;
2685 while (qemu_isspace(*p)) {
2686 p++;
2688 if (!*p)
2689 break;
2690 if (get_str(buf, sizeof(buf), &p) < 0) {
2691 goto fail;
2693 opts = qemu_opts_parse_noisily(opts_list, buf, true);
2694 if (!opts) {
2695 goto fail;
2697 qemu_opts_to_qdict(opts, qdict);
2698 qemu_opts_del(opts);
2700 break;
2701 case '/':
2703 int count, format, size;
2705 while (qemu_isspace(*p))
2706 p++;
2707 if (*p == '/') {
2708 /* format found */
2709 p++;
2710 count = 1;
2711 if (qemu_isdigit(*p)) {
2712 count = 0;
2713 while (qemu_isdigit(*p)) {
2714 count = count * 10 + (*p - '0');
2715 p++;
2718 size = -1;
2719 format = -1;
2720 for(;;) {
2721 switch(*p) {
2722 case 'o':
2723 case 'd':
2724 case 'u':
2725 case 'x':
2726 case 'i':
2727 case 'c':
2728 format = *p++;
2729 break;
2730 case 'b':
2731 size = 1;
2732 p++;
2733 break;
2734 case 'h':
2735 size = 2;
2736 p++;
2737 break;
2738 case 'w':
2739 size = 4;
2740 p++;
2741 break;
2742 case 'g':
2743 case 'L':
2744 size = 8;
2745 p++;
2746 break;
2747 default:
2748 goto next;
2751 next:
2752 if (*p != '\0' && !qemu_isspace(*p)) {
2753 monitor_printf(mon, "invalid char in format: '%c'\n",
2754 *p);
2755 goto fail;
2757 if (format < 0)
2758 format = default_fmt_format;
2759 if (format != 'i') {
2760 /* for 'i', not specifying a size gives -1 as size */
2761 if (size < 0)
2762 size = default_fmt_size;
2763 default_fmt_size = size;
2765 default_fmt_format = format;
2766 } else {
2767 count = 1;
2768 format = default_fmt_format;
2769 if (format != 'i') {
2770 size = default_fmt_size;
2771 } else {
2772 size = -1;
2775 qdict_put(qdict, "count", qint_from_int(count));
2776 qdict_put(qdict, "format", qint_from_int(format));
2777 qdict_put(qdict, "size", qint_from_int(size));
2779 break;
2780 case 'i':
2781 case 'l':
2782 case 'M':
2784 int64_t val;
2786 while (qemu_isspace(*p))
2787 p++;
2788 if (*typestr == '?' || *typestr == '.') {
2789 if (*typestr == '?') {
2790 if (*p == '\0') {
2791 typestr++;
2792 break;
2794 } else {
2795 if (*p == '.') {
2796 p++;
2797 while (qemu_isspace(*p))
2798 p++;
2799 } else {
2800 typestr++;
2801 break;
2804 typestr++;
2806 if (get_expr(mon, &val, &p))
2807 goto fail;
2808 /* Check if 'i' is greater than 32-bit */
2809 if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
2810 monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
2811 monitor_printf(mon, "integer is for 32-bit values\n");
2812 goto fail;
2813 } else if (c == 'M') {
2814 if (val < 0) {
2815 monitor_printf(mon, "enter a positive value\n");
2816 goto fail;
2818 val <<= 20;
2820 qdict_put(qdict, key, qint_from_int(val));
2822 break;
2823 case 'o':
2825 int ret;
2826 uint64_t val;
2827 char *end;
2829 while (qemu_isspace(*p)) {
2830 p++;
2832 if (*typestr == '?') {
2833 typestr++;
2834 if (*p == '\0') {
2835 break;
2838 ret = qemu_strtosz_MiB(p, &end, &val);
2839 if (ret < 0 || val > INT64_MAX) {
2840 monitor_printf(mon, "invalid size\n");
2841 goto fail;
2843 qdict_put(qdict, key, qint_from_int(val));
2844 p = end;
2846 break;
2847 case 'T':
2849 double val;
2851 while (qemu_isspace(*p))
2852 p++;
2853 if (*typestr == '?') {
2854 typestr++;
2855 if (*p == '\0') {
2856 break;
2859 if (get_double(mon, &val, &p) < 0) {
2860 goto fail;
2862 if (p[0] && p[1] == 's') {
2863 switch (*p) {
2864 case 'm':
2865 val /= 1e3; p += 2; break;
2866 case 'u':
2867 val /= 1e6; p += 2; break;
2868 case 'n':
2869 val /= 1e9; p += 2; break;
2872 if (*p && !qemu_isspace(*p)) {
2873 monitor_printf(mon, "Unknown unit suffix\n");
2874 goto fail;
2876 qdict_put(qdict, key, qfloat_from_double(val));
2878 break;
2879 case 'b':
2881 const char *beg;
2882 bool val;
2884 while (qemu_isspace(*p)) {
2885 p++;
2887 beg = p;
2888 while (qemu_isgraph(*p)) {
2889 p++;
2891 if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
2892 val = true;
2893 } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
2894 val = false;
2895 } else {
2896 monitor_printf(mon, "Expected 'on' or 'off'\n");
2897 goto fail;
2899 qdict_put(qdict, key, qbool_from_bool(val));
2901 break;
2902 case '-':
2904 const char *tmp = p;
2905 int skip_key = 0;
2906 /* option */
2908 c = *typestr++;
2909 if (c == '\0')
2910 goto bad_type;
2911 while (qemu_isspace(*p))
2912 p++;
2913 if (*p == '-') {
2914 p++;
2915 if(c != *p) {
2916 if(!is_valid_option(p, typestr)) {
2918 monitor_printf(mon, "%s: unsupported option -%c\n",
2919 cmd->name, *p);
2920 goto fail;
2921 } else {
2922 skip_key = 1;
2925 if(skip_key) {
2926 p = tmp;
2927 } else {
2928 /* has option */
2929 p++;
2930 qdict_put(qdict, key, qbool_from_bool(true));
2934 break;
2935 case 'S':
2937 /* package all remaining string */
2938 int len;
2940 while (qemu_isspace(*p)) {
2941 p++;
2943 if (*typestr == '?') {
2944 typestr++;
2945 if (*p == '\0') {
2946 /* no remaining string: NULL argument */
2947 break;
2950 len = strlen(p);
2951 if (len <= 0) {
2952 monitor_printf(mon, "%s: string expected\n",
2953 cmd->name);
2954 goto fail;
2956 qdict_put(qdict, key, qstring_from_str(p));
2957 p += len;
2959 break;
2960 default:
2961 bad_type:
2962 monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
2963 goto fail;
2965 g_free(key);
2966 key = NULL;
2968 /* check that all arguments were parsed */
2969 while (qemu_isspace(*p))
2970 p++;
2971 if (*p != '\0') {
2972 monitor_printf(mon, "%s: extraneous characters at the end of line\n",
2973 cmd->name);
2974 goto fail;
2977 return qdict;
2979 fail:
2980 QDECREF(qdict);
2981 g_free(key);
2982 return NULL;
2985 static void handle_hmp_command(Monitor *mon, const char *cmdline)
2987 QDict *qdict;
2988 const mon_cmd_t *cmd;
2990 cmd = monitor_parse_command(mon, &cmdline, mon->cmd_table);
2991 if (!cmd) {
2992 return;
2995 qdict = monitor_parse_arguments(mon, &cmdline, cmd);
2996 if (!qdict) {
2997 monitor_printf(mon, "Try \"help %s\" for more information\n",
2998 cmd->name);
2999 return;
3002 cmd->cmd(mon, qdict);
3003 QDECREF(qdict);
3006 static void cmd_completion(Monitor *mon, const char *name, const char *list)
3008 const char *p, *pstart;
3009 char cmd[128];
3010 int len;
3012 p = list;
3013 for(;;) {
3014 pstart = p;
3015 p = strchr(p, '|');
3016 if (!p)
3017 p = pstart + strlen(pstart);
3018 len = p - pstart;
3019 if (len > sizeof(cmd) - 2)
3020 len = sizeof(cmd) - 2;
3021 memcpy(cmd, pstart, len);
3022 cmd[len] = '\0';
3023 if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
3024 readline_add_completion(mon->rs, cmd);
3026 if (*p == '\0')
3027 break;
3028 p++;
3032 static void file_completion(Monitor *mon, const char *input)
3034 DIR *ffs;
3035 struct dirent *d;
3036 char path[1024];
3037 char file[1024], file_prefix[1024];
3038 int input_path_len;
3039 const char *p;
3041 p = strrchr(input, '/');
3042 if (!p) {
3043 input_path_len = 0;
3044 pstrcpy(file_prefix, sizeof(file_prefix), input);
3045 pstrcpy(path, sizeof(path), ".");
3046 } else {
3047 input_path_len = p - input + 1;
3048 memcpy(path, input, input_path_len);
3049 if (input_path_len > sizeof(path) - 1)
3050 input_path_len = sizeof(path) - 1;
3051 path[input_path_len] = '\0';
3052 pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
3055 ffs = opendir(path);
3056 if (!ffs)
3057 return;
3058 for(;;) {
3059 struct stat sb;
3060 d = readdir(ffs);
3061 if (!d)
3062 break;
3064 if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
3065 continue;
3068 if (strstart(d->d_name, file_prefix, NULL)) {
3069 memcpy(file, input, input_path_len);
3070 if (input_path_len < sizeof(file))
3071 pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
3072 d->d_name);
3073 /* stat the file to find out if it's a directory.
3074 * In that case add a slash to speed up typing long paths
3076 if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
3077 pstrcat(file, sizeof(file), "/");
3079 readline_add_completion(mon->rs, file);
3082 closedir(ffs);
3085 static const char *next_arg_type(const char *typestr)
3087 const char *p = strchr(typestr, ':');
3088 return (p != NULL ? ++p : typestr);
3091 static void add_completion_option(ReadLineState *rs, const char *str,
3092 const char *option)
3094 if (!str || !option) {
3095 return;
3097 if (!strncmp(option, str, strlen(str))) {
3098 readline_add_completion(rs, option);
3102 void chardev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3104 size_t len;
3105 ChardevBackendInfoList *list, *start;
3107 if (nb_args != 2) {
3108 return;
3110 len = strlen(str);
3111 readline_set_completion_index(rs, len);
3113 start = list = qmp_query_chardev_backends(NULL);
3114 while (list) {
3115 const char *chr_name = list->value->name;
3117 if (!strncmp(chr_name, str, len)) {
3118 readline_add_completion(rs, chr_name);
3120 list = list->next;
3122 qapi_free_ChardevBackendInfoList(start);
3125 void netdev_add_completion(ReadLineState *rs, int nb_args, const char *str)
3127 size_t len;
3128 int i;
3130 if (nb_args != 2) {
3131 return;
3133 len = strlen(str);
3134 readline_set_completion_index(rs, len);
3135 for (i = 0; NetClientDriver_lookup[i]; i++) {
3136 add_completion_option(rs, str, NetClientDriver_lookup[i]);
3140 void device_add_completion(ReadLineState *rs, int nb_args, const char *str)
3142 GSList *list, *elt;
3143 size_t len;
3145 if (nb_args != 2) {
3146 return;
3149 len = strlen(str);
3150 readline_set_completion_index(rs, len);
3151 list = elt = object_class_get_list(TYPE_DEVICE, false);
3152 while (elt) {
3153 const char *name;
3154 DeviceClass *dc = OBJECT_CLASS_CHECK(DeviceClass, elt->data,
3155 TYPE_DEVICE);
3156 name = object_class_get_name(OBJECT_CLASS(dc));
3158 if (!dc->cannot_instantiate_with_device_add_yet
3159 && !strncmp(name, str, len)) {
3160 readline_add_completion(rs, name);
3162 elt = elt->next;
3164 g_slist_free(list);
3167 void object_add_completion(ReadLineState *rs, int nb_args, const char *str)
3169 GSList *list, *elt;
3170 size_t len;
3172 if (nb_args != 2) {
3173 return;
3176 len = strlen(str);
3177 readline_set_completion_index(rs, len);
3178 list = elt = object_class_get_list(TYPE_USER_CREATABLE, false);
3179 while (elt) {
3180 const char *name;
3182 name = object_class_get_name(OBJECT_CLASS(elt->data));
3183 if (!strncmp(name, str, len) && strcmp(name, TYPE_USER_CREATABLE)) {
3184 readline_add_completion(rs, name);
3186 elt = elt->next;
3188 g_slist_free(list);
3191 static void peripheral_device_del_completion(ReadLineState *rs,
3192 const char *str, size_t len)
3194 Object *peripheral = container_get(qdev_get_machine(), "/peripheral");
3195 GSList *list, *item;
3197 list = qdev_build_hotpluggable_device_list(peripheral);
3198 if (!list) {
3199 return;
3202 for (item = list; item; item = g_slist_next(item)) {
3203 DeviceState *dev = item->data;
3205 if (dev->id && !strncmp(str, dev->id, len)) {
3206 readline_add_completion(rs, dev->id);
3210 g_slist_free(list);
3213 void chardev_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3215 size_t len;
3216 ChardevInfoList *list, *start;
3218 if (nb_args != 2) {
3219 return;
3221 len = strlen(str);
3222 readline_set_completion_index(rs, len);
3224 start = list = qmp_query_chardev(NULL);
3225 while (list) {
3226 ChardevInfo *chr = list->value;
3228 if (!strncmp(chr->label, str, len)) {
3229 readline_add_completion(rs, chr->label);
3231 list = list->next;
3233 qapi_free_ChardevInfoList(start);
3236 static void ringbuf_completion(ReadLineState *rs, const char *str)
3238 size_t len;
3239 ChardevInfoList *list, *start;
3241 len = strlen(str);
3242 readline_set_completion_index(rs, len);
3244 start = list = qmp_query_chardev(NULL);
3245 while (list) {
3246 ChardevInfo *chr_info = list->value;
3248 if (!strncmp(chr_info->label, str, len)) {
3249 Chardev *chr = qemu_chr_find(chr_info->label);
3250 if (chr && CHARDEV_IS_RINGBUF(chr)) {
3251 readline_add_completion(rs, chr_info->label);
3254 list = list->next;
3256 qapi_free_ChardevInfoList(start);
3259 void ringbuf_write_completion(ReadLineState *rs, int nb_args, const char *str)
3261 if (nb_args != 2) {
3262 return;
3264 ringbuf_completion(rs, str);
3267 void device_del_completion(ReadLineState *rs, int nb_args, const char *str)
3269 size_t len;
3271 if (nb_args != 2) {
3272 return;
3275 len = strlen(str);
3276 readline_set_completion_index(rs, len);
3277 peripheral_device_del_completion(rs, str, len);
3280 void object_del_completion(ReadLineState *rs, int nb_args, const char *str)
3282 ObjectPropertyInfoList *list, *start;
3283 size_t len;
3285 if (nb_args != 2) {
3286 return;
3288 len = strlen(str);
3289 readline_set_completion_index(rs, len);
3291 start = list = qmp_qom_list("/objects", NULL);
3292 while (list) {
3293 ObjectPropertyInfo *info = list->value;
3295 if (!strncmp(info->type, "child<", 5)
3296 && !strncmp(info->name, str, len)) {
3297 readline_add_completion(rs, info->name);
3299 list = list->next;
3301 qapi_free_ObjectPropertyInfoList(start);
3304 void sendkey_completion(ReadLineState *rs, int nb_args, const char *str)
3306 int i;
3307 char *sep;
3308 size_t len;
3310 if (nb_args != 2) {
3311 return;
3313 sep = strrchr(str, '-');
3314 if (sep) {
3315 str = sep + 1;
3317 len = strlen(str);
3318 readline_set_completion_index(rs, len);
3319 for (i = 0; i < Q_KEY_CODE__MAX; i++) {
3320 if (!strncmp(str, QKeyCode_lookup[i], len)) {
3321 readline_add_completion(rs, QKeyCode_lookup[i]);
3326 void set_link_completion(ReadLineState *rs, int nb_args, const char *str)
3328 size_t len;
3330 len = strlen(str);
3331 readline_set_completion_index(rs, len);
3332 if (nb_args == 2) {
3333 NetClientState *ncs[MAX_QUEUE_NUM];
3334 int count, i;
3335 count = qemu_find_net_clients_except(NULL, ncs,
3336 NET_CLIENT_DRIVER_NONE,
3337 MAX_QUEUE_NUM);
3338 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3339 const char *name = ncs[i]->name;
3340 if (!strncmp(str, name, len)) {
3341 readline_add_completion(rs, name);
3344 } else if (nb_args == 3) {
3345 add_completion_option(rs, str, "on");
3346 add_completion_option(rs, str, "off");
3350 void netdev_del_completion(ReadLineState *rs, int nb_args, const char *str)
3352 int len, count, i;
3353 NetClientState *ncs[MAX_QUEUE_NUM];
3355 if (nb_args != 2) {
3356 return;
3359 len = strlen(str);
3360 readline_set_completion_index(rs, len);
3361 count = qemu_find_net_clients_except(NULL, ncs, NET_CLIENT_DRIVER_NIC,
3362 MAX_QUEUE_NUM);
3363 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3364 QemuOpts *opts;
3365 const char *name = ncs[i]->name;
3366 if (strncmp(str, name, len)) {
3367 continue;
3369 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
3370 if (opts) {
3371 readline_add_completion(rs, name);
3376 void info_trace_events_completion(ReadLineState *rs, int nb_args, const char *str)
3378 size_t len;
3380 len = strlen(str);
3381 readline_set_completion_index(rs, len);
3382 if (nb_args == 2) {
3383 TraceEventIter iter;
3384 TraceEvent *ev;
3385 char *pattern = g_strdup_printf("%s*", str);
3386 trace_event_iter_init(&iter, pattern);
3387 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3388 readline_add_completion(rs, trace_event_get_name(ev));
3390 g_free(pattern);
3394 void trace_event_completion(ReadLineState *rs, int nb_args, const char *str)
3396 size_t len;
3398 len = strlen(str);
3399 readline_set_completion_index(rs, len);
3400 if (nb_args == 2) {
3401 TraceEventIter iter;
3402 TraceEvent *ev;
3403 char *pattern = g_strdup_printf("%s*", str);
3404 trace_event_iter_init(&iter, pattern);
3405 while ((ev = trace_event_iter_next(&iter)) != NULL) {
3406 readline_add_completion(rs, trace_event_get_name(ev));
3408 g_free(pattern);
3409 } else if (nb_args == 3) {
3410 add_completion_option(rs, str, "on");
3411 add_completion_option(rs, str, "off");
3415 void watchdog_action_completion(ReadLineState *rs, int nb_args, const char *str)
3417 int i;
3419 if (nb_args != 2) {
3420 return;
3422 readline_set_completion_index(rs, strlen(str));
3423 for (i = 0; WatchdogExpirationAction_lookup[i]; i++) {
3424 add_completion_option(rs, str, WatchdogExpirationAction_lookup[i]);
3428 void migrate_set_capability_completion(ReadLineState *rs, int nb_args,
3429 const char *str)
3431 size_t len;
3433 len = strlen(str);
3434 readline_set_completion_index(rs, len);
3435 if (nb_args == 2) {
3436 int i;
3437 for (i = 0; i < MIGRATION_CAPABILITY__MAX; i++) {
3438 const char *name = MigrationCapability_lookup[i];
3439 if (!strncmp(str, name, len)) {
3440 readline_add_completion(rs, name);
3443 } else if (nb_args == 3) {
3444 add_completion_option(rs, str, "on");
3445 add_completion_option(rs, str, "off");
3449 void migrate_set_parameter_completion(ReadLineState *rs, int nb_args,
3450 const char *str)
3452 size_t len;
3454 len = strlen(str);
3455 readline_set_completion_index(rs, len);
3456 if (nb_args == 2) {
3457 int i;
3458 for (i = 0; i < MIGRATION_PARAMETER__MAX; i++) {
3459 const char *name = MigrationParameter_lookup[i];
3460 if (!strncmp(str, name, len)) {
3461 readline_add_completion(rs, name);
3467 void host_net_add_completion(ReadLineState *rs, int nb_args, const char *str)
3469 int i;
3470 size_t len;
3471 if (nb_args != 2) {
3472 return;
3474 len = strlen(str);
3475 readline_set_completion_index(rs, len);
3476 for (i = 0; host_net_devices[i]; i++) {
3477 if (!strncmp(host_net_devices[i], str, len)) {
3478 readline_add_completion(rs, host_net_devices[i]);
3483 void host_net_remove_completion(ReadLineState *rs, int nb_args, const char *str)
3485 NetClientState *ncs[MAX_QUEUE_NUM];
3486 int count, i, len;
3488 len = strlen(str);
3489 readline_set_completion_index(rs, len);
3490 if (nb_args == 2) {
3491 count = qemu_find_net_clients_except(NULL, ncs,
3492 NET_CLIENT_DRIVER_NONE,
3493 MAX_QUEUE_NUM);
3494 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3495 int id;
3496 char name[16];
3498 if (net_hub_id_for_client(ncs[i], &id)) {
3499 continue;
3501 snprintf(name, sizeof(name), "%d", id);
3502 if (!strncmp(str, name, len)) {
3503 readline_add_completion(rs, name);
3506 return;
3507 } else if (nb_args == 3) {
3508 count = qemu_find_net_clients_except(NULL, ncs,
3509 NET_CLIENT_DRIVER_NIC,
3510 MAX_QUEUE_NUM);
3511 for (i = 0; i < MIN(count, MAX_QUEUE_NUM); i++) {
3512 int id;
3513 const char *name;
3515 if (ncs[i]->info->type == NET_CLIENT_DRIVER_HUBPORT ||
3516 net_hub_id_for_client(ncs[i], &id)) {
3517 continue;
3519 name = ncs[i]->name;
3520 if (!strncmp(str, name, len)) {
3521 readline_add_completion(rs, name);
3524 return;
3528 static void vm_completion(ReadLineState *rs, const char *str)
3530 size_t len;
3531 BlockDriverState *bs;
3532 BdrvNextIterator it;
3534 len = strlen(str);
3535 readline_set_completion_index(rs, len);
3537 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3538 SnapshotInfoList *snapshots, *snapshot;
3539 AioContext *ctx = bdrv_get_aio_context(bs);
3540 bool ok = false;
3542 aio_context_acquire(ctx);
3543 if (bdrv_can_snapshot(bs)) {
3544 ok = bdrv_query_snapshot_info_list(bs, &snapshots, NULL) == 0;
3546 aio_context_release(ctx);
3547 if (!ok) {
3548 continue;
3551 snapshot = snapshots;
3552 while (snapshot) {
3553 char *completion = snapshot->value->name;
3554 if (!strncmp(str, completion, len)) {
3555 readline_add_completion(rs, completion);
3557 completion = snapshot->value->id;
3558 if (!strncmp(str, completion, len)) {
3559 readline_add_completion(rs, completion);
3561 snapshot = snapshot->next;
3563 qapi_free_SnapshotInfoList(snapshots);
3568 void delvm_completion(ReadLineState *rs, int nb_args, const char *str)
3570 if (nb_args == 2) {
3571 vm_completion(rs, str);
3575 void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
3577 if (nb_args == 2) {
3578 vm_completion(rs, str);
3582 static void monitor_find_completion_by_table(Monitor *mon,
3583 const mon_cmd_t *cmd_table,
3584 char **args,
3585 int nb_args)
3587 const char *cmdname;
3588 int i;
3589 const char *ptype, *str, *name;
3590 const mon_cmd_t *cmd;
3591 BlockBackend *blk = NULL;
3593 if (nb_args <= 1) {
3594 /* command completion */
3595 if (nb_args == 0)
3596 cmdname = "";
3597 else
3598 cmdname = args[0];
3599 readline_set_completion_index(mon->rs, strlen(cmdname));
3600 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3601 cmd_completion(mon, cmdname, cmd->name);
3603 } else {
3604 /* find the command */
3605 for (cmd = cmd_table; cmd->name != NULL; cmd++) {
3606 if (compare_cmd(args[0], cmd->name)) {
3607 break;
3610 if (!cmd->name) {
3611 return;
3614 if (cmd->sub_table) {
3615 /* do the job again */
3616 monitor_find_completion_by_table(mon, cmd->sub_table,
3617 &args[1], nb_args - 1);
3618 return;
3620 if (cmd->command_completion) {
3621 cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
3622 return;
3625 ptype = next_arg_type(cmd->args_type);
3626 for(i = 0; i < nb_args - 2; i++) {
3627 if (*ptype != '\0') {
3628 ptype = next_arg_type(ptype);
3629 while (*ptype == '?')
3630 ptype = next_arg_type(ptype);
3633 str = args[nb_args - 1];
3634 while (*ptype == '-' && ptype[1] != '\0') {
3635 ptype = next_arg_type(ptype);
3637 switch(*ptype) {
3638 case 'F':
3639 /* file completion */
3640 readline_set_completion_index(mon->rs, strlen(str));
3641 file_completion(mon, str);
3642 break;
3643 case 'B':
3644 /* block device name completion */
3645 readline_set_completion_index(mon->rs, strlen(str));
3646 while ((blk = blk_next(blk)) != NULL) {
3647 name = blk_name(blk);
3648 if (str[0] == '\0' ||
3649 !strncmp(name, str, strlen(str))) {
3650 readline_add_completion(mon->rs, name);
3653 break;
3654 case 's':
3655 case 'S':
3656 if (!strcmp(cmd->name, "help|?")) {
3657 monitor_find_completion_by_table(mon, cmd_table,
3658 &args[1], nb_args - 1);
3660 break;
3661 default:
3662 break;
3667 static void monitor_find_completion(void *opaque,
3668 const char *cmdline)
3670 Monitor *mon = opaque;
3671 char *args[MAX_ARGS];
3672 int nb_args, len;
3674 /* 1. parse the cmdline */
3675 if (parse_cmdline(cmdline, &nb_args, args) < 0) {
3676 return;
3679 /* if the line ends with a space, it means we want to complete the
3680 next arg */
3681 len = strlen(cmdline);
3682 if (len > 0 && qemu_isspace(cmdline[len - 1])) {
3683 if (nb_args >= MAX_ARGS) {
3684 goto cleanup;
3686 args[nb_args++] = g_strdup("");
3689 /* 2. auto complete according to args */
3690 monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
3692 cleanup:
3693 free_cmdline_args(args, nb_args);
3696 static int monitor_can_read(void *opaque)
3698 Monitor *mon = opaque;
3700 return (mon->suspend_cnt == 0) ? 1 : 0;
3703 static void handle_qmp_command(JSONMessageParser *parser, GQueue *tokens)
3705 QObject *req, *rsp = NULL, *id = NULL;
3706 QDict *qdict = NULL;
3707 Monitor *mon = cur_mon;
3708 Error *err = NULL;
3710 req = json_parser_parse_err(tokens, NULL, &err);
3711 if (!req && !err) {
3712 /* json_parser_parse_err() sucks: can fail without setting @err */
3713 error_setg(&err, QERR_JSON_PARSING);
3715 if (err) {
3716 goto err_out;
3719 qdict = qobject_to_qdict(req);
3720 if (qdict) {
3721 id = qdict_get(qdict, "id");
3722 qobject_incref(id);
3723 qdict_del(qdict, "id");
3724 } /* else will fail qmp_dispatch() */
3726 rsp = qmp_dispatch(cur_mon->qmp.commands, req);
3728 if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
3729 qdict = qdict_get_qdict(qobject_to_qdict(rsp), "error");
3730 if (qdict
3731 && !g_strcmp0(qdict_get_try_str(qdict, "class"),
3732 QapiErrorClass_lookup[ERROR_CLASS_COMMAND_NOT_FOUND])) {
3733 /* Provide a more useful error message */
3734 qdict_del(qdict, "desc");
3735 qdict_put(qdict, "desc",
3736 qstring_from_str("Expecting capabilities negotiation"
3737 " with 'qmp_capabilities'"));
3741 err_out:
3742 if (err) {
3743 qdict = qdict_new();
3744 qdict_put_obj(qdict, "error", qmp_build_error_object(err));
3745 error_free(err);
3746 rsp = QOBJECT(qdict);
3749 if (rsp) {
3750 if (id) {
3751 qdict_put_obj(qobject_to_qdict(rsp), "id", id);
3752 id = NULL;
3755 monitor_json_emitter(mon, rsp);
3758 qobject_decref(id);
3759 qobject_decref(rsp);
3760 qobject_decref(req);
3763 static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
3765 Monitor *old_mon = cur_mon;
3767 cur_mon = opaque;
3769 json_message_parser_feed(&cur_mon->qmp.parser, (const char *) buf, size);
3771 cur_mon = old_mon;
3774 static void monitor_read(void *opaque, const uint8_t *buf, int size)
3776 Monitor *old_mon = cur_mon;
3777 int i;
3779 cur_mon = opaque;
3781 if (cur_mon->rs) {
3782 for (i = 0; i < size; i++)
3783 readline_handle_byte(cur_mon->rs, buf[i]);
3784 } else {
3785 if (size == 0 || buf[size - 1] != 0)
3786 monitor_printf(cur_mon, "corrupted command\n");
3787 else
3788 handle_hmp_command(cur_mon, (char *)buf);
3791 cur_mon = old_mon;
3794 static void monitor_command_cb(void *opaque, const char *cmdline,
3795 void *readline_opaque)
3797 Monitor *mon = opaque;
3799 monitor_suspend(mon);
3800 handle_hmp_command(mon, cmdline);
3801 monitor_resume(mon);
3804 int monitor_suspend(Monitor *mon)
3806 if (!mon->rs)
3807 return -ENOTTY;
3808 mon->suspend_cnt++;
3809 return 0;
3812 void monitor_resume(Monitor *mon)
3814 if (!mon->rs)
3815 return;
3816 if (--mon->suspend_cnt == 0)
3817 readline_show_prompt(mon->rs);
3820 static QObject *get_qmp_greeting(void)
3822 QObject *ver = NULL;
3824 qmp_marshal_query_version(NULL, &ver, NULL);
3826 return qobject_from_jsonf("{'QMP': {'version': %p, 'capabilities': []}}",
3827 ver);
3830 static void monitor_qmp_event(void *opaque, int event)
3832 QObject *data;
3833 Monitor *mon = opaque;
3835 switch (event) {
3836 case CHR_EVENT_OPENED:
3837 mon->qmp.commands = &qmp_cap_negotiation_commands;
3838 data = get_qmp_greeting();
3839 monitor_json_emitter(mon, data);
3840 qobject_decref(data);
3841 mon_refcount++;
3842 break;
3843 case CHR_EVENT_CLOSED:
3844 json_message_parser_destroy(&mon->qmp.parser);
3845 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3846 mon_refcount--;
3847 monitor_fdsets_cleanup();
3848 break;
3852 static void monitor_event(void *opaque, int event)
3854 Monitor *mon = opaque;
3856 switch (event) {
3857 case CHR_EVENT_MUX_IN:
3858 qemu_mutex_lock(&mon->out_lock);
3859 mon->mux_out = 0;
3860 qemu_mutex_unlock(&mon->out_lock);
3861 if (mon->reset_seen) {
3862 readline_restart(mon->rs);
3863 monitor_resume(mon);
3864 monitor_flush(mon);
3865 } else {
3866 mon->suspend_cnt = 0;
3868 break;
3870 case CHR_EVENT_MUX_OUT:
3871 if (mon->reset_seen) {
3872 if (mon->suspend_cnt == 0) {
3873 monitor_printf(mon, "\n");
3875 monitor_flush(mon);
3876 monitor_suspend(mon);
3877 } else {
3878 mon->suspend_cnt++;
3880 qemu_mutex_lock(&mon->out_lock);
3881 mon->mux_out = 1;
3882 qemu_mutex_unlock(&mon->out_lock);
3883 break;
3885 case CHR_EVENT_OPENED:
3886 monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
3887 "information\n", QEMU_VERSION);
3888 if (!mon->mux_out) {
3889 readline_restart(mon->rs);
3890 readline_show_prompt(mon->rs);
3892 mon->reset_seen = 1;
3893 mon_refcount++;
3894 break;
3896 case CHR_EVENT_CLOSED:
3897 mon_refcount--;
3898 monitor_fdsets_cleanup();
3899 break;
3903 static int
3904 compare_mon_cmd(const void *a, const void *b)
3906 return strcmp(((const mon_cmd_t *)a)->name,
3907 ((const mon_cmd_t *)b)->name);
3910 static void sortcmdlist(void)
3912 int array_num;
3913 int elem_size = sizeof(mon_cmd_t);
3915 array_num = sizeof(mon_cmds)/elem_size-1;
3916 qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
3918 array_num = sizeof(info_cmds)/elem_size-1;
3919 qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
3922 /* These functions just adapt the readline interface in a typesafe way. We
3923 * could cast function pointers but that discards compiler checks.
3925 static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
3926 const char *fmt, ...)
3928 va_list ap;
3929 va_start(ap, fmt);
3930 monitor_vprintf(opaque, fmt, ap);
3931 va_end(ap);
3934 static void monitor_readline_flush(void *opaque)
3936 monitor_flush(opaque);
3940 * Print to current monitor if we have one, else to stderr.
3941 * TODO should return int, so callers can calculate width, but that
3942 * requires surgery to monitor_vprintf(). Left for another day.
3944 void error_vprintf(const char *fmt, va_list ap)
3946 if (cur_mon && !monitor_cur_is_qmp()) {
3947 monitor_vprintf(cur_mon, fmt, ap);
3948 } else {
3949 vfprintf(stderr, fmt, ap);
3953 void error_vprintf_unless_qmp(const char *fmt, va_list ap)
3955 if (cur_mon && !monitor_cur_is_qmp()) {
3956 monitor_vprintf(cur_mon, fmt, ap);
3957 } else if (!cur_mon) {
3958 vfprintf(stderr, fmt, ap);
3962 static void __attribute__((constructor)) monitor_lock_init(void)
3964 qemu_mutex_init(&monitor_lock);
3967 void monitor_init(Chardev *chr, int flags)
3969 static int is_first_init = 1;
3970 Monitor *mon;
3972 if (is_first_init) {
3973 monitor_qapi_event_init();
3974 sortcmdlist();
3975 is_first_init = 0;
3978 mon = g_malloc(sizeof(*mon));
3979 monitor_data_init(mon);
3981 qemu_chr_fe_init(&mon->chr, chr, &error_abort);
3982 mon->flags = flags;
3983 if (flags & MONITOR_USE_READLINE) {
3984 mon->rs = readline_init(monitor_readline_printf,
3985 monitor_readline_flush,
3986 mon,
3987 monitor_find_completion);
3988 monitor_read_command(mon, 0);
3991 if (monitor_is_qmp(mon)) {
3992 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
3993 monitor_qmp_event, mon, NULL, true);
3994 qemu_chr_fe_set_echo(&mon->chr, true);
3995 json_message_parser_init(&mon->qmp.parser, handle_qmp_command);
3996 } else {
3997 qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
3998 monitor_event, mon, NULL, true);
4001 qemu_mutex_lock(&monitor_lock);
4002 QLIST_INSERT_HEAD(&mon_list, mon, entry);
4003 qemu_mutex_unlock(&monitor_lock);
4006 void monitor_cleanup(void)
4008 Monitor *mon, *next;
4010 qemu_mutex_lock(&monitor_lock);
4011 QLIST_FOREACH_SAFE(mon, &mon_list, entry, next) {
4012 QLIST_REMOVE(mon, entry);
4013 monitor_data_destroy(mon);
4014 g_free(mon);
4016 qemu_mutex_unlock(&monitor_lock);
4019 static void bdrv_password_cb(void *opaque, const char *password,
4020 void *readline_opaque)
4022 Monitor *mon = opaque;
4023 BlockDriverState *bs = readline_opaque;
4024 int ret = 0;
4025 Error *local_err = NULL;
4027 bdrv_add_key(bs, password, &local_err);
4028 if (local_err) {
4029 error_report_err(local_err);
4030 ret = -EPERM;
4032 if (mon->password_completion_cb)
4033 mon->password_completion_cb(mon->password_opaque, ret);
4035 monitor_read_command(mon, 1);
4038 int monitor_read_bdrv_key_start(Monitor *mon, BlockDriverState *bs,
4039 BlockCompletionFunc *completion_cb,
4040 void *opaque)
4042 int err;
4044 monitor_printf(mon, "%s (%s) is encrypted.\n", bdrv_get_device_name(bs),
4045 bdrv_get_encrypted_filename(bs));
4047 mon->password_completion_cb = completion_cb;
4048 mon->password_opaque = opaque;
4050 err = monitor_read_password(mon, bdrv_password_cb, bs);
4052 if (err && completion_cb)
4053 completion_cb(opaque, err);
4055 return err;
4058 int monitor_read_block_device_key(Monitor *mon, const char *device,
4059 BlockCompletionFunc *completion_cb,
4060 void *opaque)
4062 Error *err = NULL;
4063 BlockBackend *blk;
4065 blk = blk_by_name(device);
4066 if (!blk) {
4067 monitor_printf(mon, "Device not found %s\n", device);
4068 return -1;
4070 if (!blk_bs(blk)) {
4071 monitor_printf(mon, "Device '%s' has no medium\n", device);
4072 return -1;
4075 bdrv_add_key(blk_bs(blk), NULL, &err);
4076 if (err) {
4077 error_free(err);
4078 return monitor_read_bdrv_key_start(mon, blk_bs(blk), completion_cb, opaque);
4081 if (completion_cb) {
4082 completion_cb(opaque, 0);
4084 return 0;
4087 QemuOptsList qemu_mon_opts = {
4088 .name = "mon",
4089 .implied_opt_name = "chardev",
4090 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
4091 .desc = {
4093 .name = "mode",
4094 .type = QEMU_OPT_STRING,
4096 .name = "chardev",
4097 .type = QEMU_OPT_STRING,
4099 .name = "default", /* deprecated */
4100 .type = QEMU_OPT_BOOL,
4102 .name = "pretty",
4103 .type = QEMU_OPT_BOOL,
4105 { /* end of list */ }
4109 #ifndef TARGET_I386
4110 void qmp_rtc_reset_reinjection(Error **errp)
4112 error_setg(errp, QERR_FEATURE_DISABLED, "rtc-reset-reinjection");
4114 #endif
4116 #ifndef TARGET_S390X
4117 void qmp_dump_skeys(const char *filename, Error **errp)
4119 error_setg(errp, QERR_FEATURE_DISABLED, "dump-skeys");
4121 #endif
4123 #ifndef TARGET_ARM
4124 GICCapabilityList *qmp_query_gic_capabilities(Error **errp)
4126 error_setg(errp, QERR_FEATURE_DISABLED, "query-gic-capabilities");
4127 return NULL;
4129 #endif
4131 HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
4133 MachineState *ms = MACHINE(qdev_get_machine());
4134 MachineClass *mc = MACHINE_GET_CLASS(ms);
4136 if (!mc->has_hotpluggable_cpus) {
4137 error_setg(errp, QERR_FEATURE_DISABLED, "query-hotpluggable-cpus");
4138 return NULL;
4141 return machine_query_hotpluggable_cpus(ms);