* [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17
@ 2019-06-17 18:48 Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 01/16] monitor: Fix return type of monitor_fdset_dup_fd_find Markus Armbruster
` (18 more replies)
0 siblings, 19 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel
The following changes since commit 076243ffe6c1b687e9e6d98348c3bf3398df78f3:
Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20190617' into staging (2019-06-17 16:41:25 +0100)
are available in the Git repository at:
git://repo.or.cz/qemu/armbru.git tags/pull-monitor-2019-06-17
for you to fetch changes up to 092b8737c5e7695c4b9caa3b4eedc66763632755:
vl: Deprecate -mon pretty=... for HMP monitors (2019-06-17 20:36:56 +0200)
----------------------------------------------------------------
Monitor patches for 2019-06-17
----------------------------------------------------------------
Kevin Wolf (15):
monitor: Remove unused password prompting fields
monitor: Split monitor_init in HMP and QMP function
monitor: Make MonitorQMP a child class of Monitor
monitor: Create MonitorHMP with readline state
monitor: Remove Monitor.cmd_table indirection
monitor: Rename HMP command type and tables
Move monitor.c to monitor/misc.c
monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c
monitor: Create monitor-internal.h with common definitions
monitor: Split out monitor/qmp.c
monitor: Split out monitor/hmp.c
monitor: Split out monitor/monitor.c
monitor: Split Monitor.flags into separate bools
monitor: Replace monitor_init() with monitor_init_{hmp, qmp}()
vl: Deprecate -mon pretty=... for HMP monitors
Yury Kotov (1):
monitor: Fix return type of monitor_fdset_dup_fd_find
MAINTAINERS | 13 +-
Makefile.objs | 4 +-
Makefile.target | 3 +-
chardev/char.c | 2 +-
docs/devel/writing-qmp-commands.txt | 11 +-
gdbstub.c | 2 +-
hmp-commands.hx | 2 +-
include/monitor/monitor.h | 17 +-
monitor.c | 4729 -----------------------------------
monitor/Makefile.objs | 3 +
hmp.c => monitor/hmp-cmds.c | 7 +-
monitor/hmp.c | 1416 +++++++++++
monitor/misc.c | 2353 +++++++++++++++++
monitor/monitor-internal.h | 183 ++
monitor/monitor.c | 628 +++++
qmp.c => monitor/qmp-cmds.c | 2 +-
monitor/qmp.c | 404 +++
monitor/trace-events | 15 +
qemu-deprecated.texi | 6 +
stubs/fdset.c | 2 +-
stubs/monitor.c | 6 +-
tests/test-util-sockets.c | 3 +-
trace-events | 10 -
vl.c | 28 +-
24 files changed, 5072 insertions(+), 4777 deletions(-)
delete mode 100644 monitor.c
create mode 100644 monitor/Makefile.objs
rename hmp.c => monitor/hmp-cmds.c (99%)
create mode 100644 monitor/hmp.c
create mode 100644 monitor/misc.c
create mode 100644 monitor/monitor-internal.h
create mode 100644 monitor/monitor.c
rename qmp.c => monitor/qmp-cmds.c (99%)
create mode 100644 monitor/qmp.c
create mode 100644 monitor/trace-events
--
2.21.0
^ permalink raw reply [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 01/16] monitor: Fix return type of monitor_fdset_dup_fd_find
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 02/16] monitor: Remove unused password prompting fields Markus Armbruster
` (17 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Yury Kotov
From: Yury Kotov <yury-kotov@yandex-team.ru>
monitor_fdset_dup_fd_find_remove() and monitor_fdset_dup_fd_find()
return mon_fdset->id which is int64_t. Downcasting from int64_t to int
leads to a bug with removing fd from fdset with id >= 2^32.
So, fix return types for these function.
Signed-off-by: Yury Kotov <yury-kotov@yandex-team.ru>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190523094433.30297-1-yury-kotov@yandex-team.ru>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
include/monitor/monitor.h | 2 +-
monitor.c | 4 ++--
stubs/fdset.c | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/include/monitor/monitor.h b/include/monitor/monitor.h
index 06cfcd8f36..1e1d6d2269 100644
--- a/include/monitor/monitor.h
+++ b/include/monitor/monitor.h
@@ -44,6 +44,6 @@ AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
int monitor_fdset_get_fd(int64_t fdset_id, int flags);
int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd);
void monitor_fdset_dup_fd_remove(int dup_fd);
-int monitor_fdset_dup_fd_find(int dup_fd);
+int64_t monitor_fdset_dup_fd_find(int dup_fd);
#endif /* MONITOR_H */
diff --git a/monitor.c b/monitor.c
index 5c5cbe254a..dce3496920 100644
--- a/monitor.c
+++ b/monitor.c
@@ -2604,7 +2604,7 @@ err:
return -1;
}
-static int monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
+static int64_t monitor_fdset_dup_fd_find_remove(int dup_fd, bool remove)
{
MonFdset *mon_fdset;
MonFdsetFd *mon_fdset_fd_dup;
@@ -2632,7 +2632,7 @@ err:
return -1;
}
-int monitor_fdset_dup_fd_find(int dup_fd)
+int64_t monitor_fdset_dup_fd_find(int dup_fd)
{
return monitor_fdset_dup_fd_find_remove(dup_fd, false);
}
diff --git a/stubs/fdset.c b/stubs/fdset.c
index f3d9980b7e..67dd5e1d34 100644
--- a/stubs/fdset.c
+++ b/stubs/fdset.c
@@ -6,7 +6,7 @@ int monitor_fdset_dup_fd_add(int64_t fdset_id, int dup_fd)
return -1;
}
-int monitor_fdset_dup_fd_find(int dup_fd)
+int64_t monitor_fdset_dup_fd_find(int dup_fd)
{
return -1;
}
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 02/16] monitor: Remove unused password prompting fields
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 01/16] monitor: Fix return type of monitor_fdset_dup_fd_find Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 03/16] monitor: Split monitor_init in HMP and QMP function Markus Armbruster
` (16 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Commit 788cf9f8c removed the code for password prompting from the
monitor. Since then, the Monitor fields password_completion_cb and
password_opaque have been unused. Remove them.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190613153405.24769-2-kwolf@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
monitor.c | 2 --
1 file changed, 2 deletions(-)
diff --git a/monitor.c b/monitor.c
index dce3496920..8e9851ae15 100644
--- a/monitor.c
+++ b/monitor.c
@@ -222,8 +222,6 @@ struct Monitor {
MonitorQMP qmp;
gchar *mon_cpu_path;
- BlockCompletionFunc *password_completion_cb;
- void *password_opaque;
mon_cmd_t *cmd_table;
QTAILQ_ENTRY(Monitor) entry;
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 03/16] monitor: Split monitor_init in HMP and QMP function
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 01/16] monitor: Fix return type of monitor_fdset_dup_fd_find Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 02/16] monitor: Remove unused password prompting fields Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 04/16] monitor: Make MonitorQMP a child class of Monitor Markus Armbruster
` (15 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Instead of mixing HMP and QMP monitors in the same function, separate
the monitor creation function for both.
While in theory, one could pass both MONITOR_USE_CONTROL and
MONITOR_USE_READLINE before this patch and both flags would do
something, readline support is tightly coupled with HMP: QMP never feeds
its input to readline, and the tab completion function treats the input
as an HMP command. Therefore, this configuration is useless.
After this patch, the QMP path asserts that MONITOR_USE_READLINE is not
set. The HMP path can be used with or without MONITOR_USE_READLINE, like
before.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190613153405.24769-3-kwolf@redhat.com>
[Zero initialization of Monitor moved from monitor_data_init() to
callers]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
monitor.c | 95 ++++++++++++++++++++++++++++++++-----------------------
1 file changed, 55 insertions(+), 40 deletions(-)
diff --git a/monitor.c b/monitor.c
index 8e9851ae15..261342a0f6 100644
--- a/monitor.c
+++ b/monitor.c
@@ -704,13 +704,12 @@ static void handle_hmp_command(Monitor *mon, const char *cmdline);
static void monitor_iothread_init(void);
-static void monitor_data_init(Monitor *mon, bool skip_flush,
+static void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
bool use_io_thread)
{
if (use_io_thread && !mon_iothread) {
monitor_iothread_init();
}
- memset(mon, 0, sizeof(Monitor));
qemu_mutex_init(&mon->mon_lock);
qemu_mutex_init(&mon->qmp.qmp_queue_lock);
mon->outbuf = qstring_new();
@@ -719,6 +718,7 @@ static void monitor_data_init(Monitor *mon, bool skip_flush,
mon->skip_flush = skip_flush;
mon->use_io_thread = use_io_thread;
mon->qmp.qmp_requests = g_queue_new();
+ mon->flags = flags;
}
static void monitor_data_destroy(Monitor *mon)
@@ -740,9 +740,10 @@ char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
int64_t cpu_index, Error **errp)
{
char *output = NULL;
- Monitor *old_mon, hmp;
+ Monitor *old_mon;
+ Monitor hmp = {};
- monitor_data_init(&hmp, true, false);
+ monitor_data_init(&hmp, 0, true, false);
old_mon = cur_mon;
cur_mon = &hmp;
@@ -4605,19 +4606,51 @@ static void monitor_qmp_setup_handlers_bh(void *opaque)
monitor_list_append(mon);
}
-void monitor_init(Chardev *chr, int flags)
+static void monitor_init_qmp(Chardev *chr, int flags)
{
- Monitor *mon = g_malloc(sizeof(*mon));
- bool use_readline = flags & MONITOR_USE_READLINE;
+ Monitor *mon = g_new0(Monitor, 1);
+
+ /* Only HMP supports readline */
+ assert(!(flags & MONITOR_USE_READLINE));
/* Note: we run QMP monitor in I/O thread when @chr supports that */
- monitor_data_init(mon, false,
- (flags & MONITOR_USE_CONTROL)
- && qemu_chr_has_feature(chr,
- QEMU_CHAR_FEATURE_GCONTEXT));
+ monitor_data_init(mon, flags, false,
+ qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT));
qemu_chr_fe_init(&mon->chr, chr, &error_abort);
- mon->flags = flags;
+ qemu_chr_fe_set_echo(&mon->chr, true);
+
+ json_message_parser_init(&mon->qmp.parser, handle_qmp_command, mon, NULL);
+ if (mon->use_io_thread) {
+ /*
+ * Make sure the old iowatch is gone. It's possible when
+ * e.g. the chardev is in client mode, with wait=on.
+ */
+ remove_fd_in_watch(chr);
+ /*
+ * We can't call qemu_chr_fe_set_handlers() directly here
+ * since chardev might be running in the monitor I/O
+ * thread. Schedule a bottom half.
+ */
+ aio_bh_schedule_oneshot(iothread_get_aio_context(mon_iothread),
+ monitor_qmp_setup_handlers_bh, mon);
+ /* The bottom half will add @mon to @mon_list */
+ } else {
+ qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
+ monitor_qmp_read, monitor_qmp_event,
+ NULL, mon, NULL, true);
+ monitor_list_append(mon);
+ }
+}
+
+static void monitor_init_hmp(Chardev *chr, int flags)
+{
+ Monitor *mon = g_new0(Monitor, 1);
+ bool use_readline = flags & MONITOR_USE_READLINE;
+
+ monitor_data_init(mon, flags, false, false);
+ qemu_chr_fe_init(&mon->chr, chr, &error_abort);
+
if (use_readline) {
mon->rs = readline_init(monitor_readline_printf,
monitor_readline_flush,
@@ -4626,36 +4659,18 @@ void monitor_init(Chardev *chr, int flags)
monitor_read_command(mon, 0);
}
- if (monitor_is_qmp(mon)) {
- qemu_chr_fe_set_echo(&mon->chr, true);
- json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
- mon, NULL);
- if (mon->use_io_thread) {
- /*
- * Make sure the old iowatch is gone. It's possible when
- * e.g. the chardev is in client mode, with wait=on.
- */
- remove_fd_in_watch(chr);
- /*
- * We can't call qemu_chr_fe_set_handlers() directly here
- * since chardev might be running in the monitor I/O
- * thread. Schedule a bottom half.
- */
- aio_bh_schedule_oneshot(iothread_get_aio_context(mon_iothread),
- monitor_qmp_setup_handlers_bh, mon);
- /* The bottom half will add @mon to @mon_list */
- return;
- } else {
- qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
- monitor_qmp_read, monitor_qmp_event,
- NULL, mon, NULL, true);
- }
+ qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
+ monitor_event, NULL, mon, NULL, true);
+ monitor_list_append(mon);
+}
+
+void monitor_init(Chardev *chr, int flags)
+{
+ if (flags & MONITOR_USE_CONTROL) {
+ monitor_init_qmp(chr, flags);
} else {
- qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
- monitor_event, NULL, mon, NULL, true);
+ monitor_init_hmp(chr, flags);
}
-
- monitor_list_append(mon);
}
void monitor_cleanup(void)
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 04/16] monitor: Make MonitorQMP a child class of Monitor
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (2 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 03/16] monitor: Split monitor_init in HMP and QMP function Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 05/16] monitor: Create MonitorHMP with readline state Markus Armbruster
` (14 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Currently, struct Monitor mixes state that is only relevant for HMP,
state that is only relevant for QMP, and some actually shared state.
In particular, a MonitorQMP field is present in the state of any
monitor, even if it's not a QMP monitor and therefore doesn't use the
state.
As a first step towards a clean separation between QMP and HMP, let
MonitorQMP extend Monitor and create a MonitorQMP object only when the
monitor is actually a QMP monitor.
Some places accessed Monitor.qmp unconditionally, even for HMP monitors.
They can't keep doing this now, so during the conversion, they are
either changed to become conditional on monitor_is_qmp() or to assert()
that they always get a QMP monitor.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Message-Id: <20190613153405.24769-4-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Superfluous variable in monitor_data_destroy() eliminated]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
monitor.c | 219 ++++++++++++++++++++++++++++++------------------------
1 file changed, 123 insertions(+), 96 deletions(-)
diff --git a/monitor.c b/monitor.c
index 261342a0f6..15f94fc41f 100644
--- a/monitor.c
+++ b/monitor.c
@@ -168,26 +168,6 @@ struct MonFdset {
QLIST_ENTRY(MonFdset) next;
};
-typedef struct {
- JSONMessageParser parser;
- /*
- * When a client connects, we're in capabilities negotiation mode.
- * @commands is &qmp_cap_negotiation_commands then. When command
- * qmp_capabilities succeeds, we go into command mode, and
- * @command becomes &qmp_commands.
- */
- QmpCommandList *commands;
- bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
- bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
- /*
- * Protects qmp request/response queue.
- * Take monitor_lock first when you need both.
- */
- QemuMutex qmp_queue_lock;
- /* Input queue that holds all the parsed QMP requests */
- GQueue *qmp_requests;
-} MonitorQMP;
-
/*
* To prevent flooding clients, events can be throttled. The
* throttling is calculated globally, rather than per-Monitor
@@ -220,7 +200,6 @@ struct Monitor {
*/
ReadLineState *rs;
- MonitorQMP qmp;
gchar *mon_cpu_path;
mon_cmd_t *cmd_table;
QTAILQ_ENTRY(Monitor) entry;
@@ -241,6 +220,27 @@ struct Monitor {
int mux_out;
};
+typedef struct {
+ Monitor common;
+ JSONMessageParser parser;
+ /*
+ * When a client connects, we're in capabilities negotiation mode.
+ * @commands is &qmp_cap_negotiation_commands then. When command
+ * qmp_capabilities succeeds, we go into command mode, and
+ * @command becomes &qmp_commands.
+ */
+ QmpCommandList *commands;
+ bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
+ bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
+ /*
+ * Protects qmp request/response queue.
+ * Take monitor_lock first when you need both.
+ */
+ QemuMutex qmp_queue_lock;
+ /* Input queue that holds all the parsed QMP requests */
+ GQueue *qmp_requests;
+} MonitorQMP;
+
/* Shared monitor I/O thread */
IOThread *mon_iothread;
@@ -249,7 +249,7 @@ QEMUBH *qmp_dispatcher_bh;
struct QMPRequest {
/* Owner of the request */
- Monitor *mon;
+ MonitorQMP *mon;
/*
* Request object to be handled or Error to be reported
* (exactly one of them is non-null)
@@ -357,18 +357,18 @@ static void qmp_request_free(QMPRequest *req)
}
/* Caller must hold mon->qmp.qmp_queue_lock */
-static void monitor_qmp_cleanup_req_queue_locked(Monitor *mon)
+static void monitor_qmp_cleanup_req_queue_locked(MonitorQMP *mon)
{
- while (!g_queue_is_empty(mon->qmp.qmp_requests)) {
- qmp_request_free(g_queue_pop_head(mon->qmp.qmp_requests));
+ while (!g_queue_is_empty(mon->qmp_requests)) {
+ qmp_request_free(g_queue_pop_head(mon->qmp_requests));
}
}
-static void monitor_qmp_cleanup_queues(Monitor *mon)
+static void monitor_qmp_cleanup_queues(MonitorQMP *mon)
{
- qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
+ qemu_mutex_lock(&mon->qmp_queue_lock);
monitor_qmp_cleanup_req_queue_locked(mon);
- qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
+ qemu_mutex_unlock(&mon->qmp_queue_lock);
}
@@ -480,17 +480,17 @@ int monitor_printf(Monitor *mon, const char *fmt, ...)
return ret;
}
-static void qmp_send_response(Monitor *mon, const QDict *rsp)
+static void qmp_send_response(MonitorQMP *mon, const QDict *rsp)
{
const QObject *data = QOBJECT(rsp);
QString *json;
- json = mon->flags & MONITOR_USE_PRETTY ? qobject_to_json_pretty(data) :
- qobject_to_json(data);
+ json = mon->common.flags & MONITOR_USE_PRETTY ?
+ qobject_to_json_pretty(data) : qobject_to_json(data);
assert(json != NULL);
qstring_append_chr(json, '\n');
- monitor_puts(mon, qstring_get_str(json));
+ monitor_puts(&mon->common, qstring_get_str(json));
qobject_unref(json);
}
@@ -513,12 +513,17 @@ static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
{
Monitor *mon;
+ MonitorQMP *qmp_mon;
trace_monitor_protocol_event_emit(event, qdict);
QTAILQ_FOREACH(mon, &mon_list, entry) {
- if (monitor_is_qmp(mon)
- && mon->qmp.commands != &qmp_cap_negotiation_commands) {
- qmp_send_response(mon, qdict);
+ if (!monitor_is_qmp(mon)) {
+ continue;
+ }
+
+ qmp_mon = container_of(mon, MonitorQMP, common);
+ if (qmp_mon->commands != &qmp_cap_negotiation_commands) {
+ qmp_send_response(qmp_mon, qdict);
}
}
}
@@ -711,29 +716,32 @@ static void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
monitor_iothread_init();
}
qemu_mutex_init(&mon->mon_lock);
- qemu_mutex_init(&mon->qmp.qmp_queue_lock);
mon->outbuf = qstring_new();
/* Use *mon_cmds by default. */
mon->cmd_table = mon_cmds;
mon->skip_flush = skip_flush;
mon->use_io_thread = use_io_thread;
- mon->qmp.qmp_requests = g_queue_new();
mon->flags = flags;
}
+static void monitor_data_destroy_qmp(MonitorQMP *mon)
+{
+ json_message_parser_destroy(&mon->parser);
+ qemu_mutex_destroy(&mon->qmp_queue_lock);
+ monitor_qmp_cleanup_req_queue_locked(mon);
+ g_queue_free(mon->qmp_requests);
+}
+
static void monitor_data_destroy(Monitor *mon)
{
g_free(mon->mon_cpu_path);
qemu_chr_fe_deinit(&mon->chr, false);
if (monitor_is_qmp(mon)) {
- json_message_parser_destroy(&mon->qmp.parser);
+ monitor_data_destroy_qmp(container_of(mon, MonitorQMP, common));
}
readline_free(mon->rs);
qobject_unref(mon->outbuf);
qemu_mutex_destroy(&mon->mon_lock);
- qemu_mutex_destroy(&mon->qmp.qmp_queue_lock);
- monitor_qmp_cleanup_req_queue_locked(mon);
- g_queue_free(mon->qmp.qmp_requests);
}
char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
@@ -1087,8 +1095,12 @@ static void query_commands_cb(QmpCommand *cmd, void *opaque)
CommandInfoList *qmp_query_commands(Error **errp)
{
CommandInfoList *list = NULL;
+ MonitorQMP *mon;
- qmp_for_each_command(cur_mon->qmp.commands, query_commands_cb, &list);
+ assert(monitor_is_qmp(cur_mon));
+ mon = container_of(cur_mon, MonitorQMP, common);
+
+ qmp_for_each_command(mon->commands, query_commands_cb, &list);
return list;
}
@@ -1155,16 +1167,16 @@ static void monitor_init_qmp_commands(void)
qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
}
-static bool qmp_oob_enabled(Monitor *mon)
+static bool qmp_oob_enabled(MonitorQMP *mon)
{
- return mon->qmp.capab[QMP_CAPABILITY_OOB];
+ return mon->capab[QMP_CAPABILITY_OOB];
}
-static void monitor_qmp_caps_reset(Monitor *mon)
+static void monitor_qmp_caps_reset(MonitorQMP *mon)
{
- memset(mon->qmp.capab_offered, 0, sizeof(mon->qmp.capab_offered));
- memset(mon->qmp.capab, 0, sizeof(mon->qmp.capab));
- mon->qmp.capab_offered[QMP_CAPABILITY_OOB] = mon->use_io_thread;
+ memset(mon->capab_offered, 0, sizeof(mon->capab_offered));
+ memset(mon->capab, 0, sizeof(mon->capab));
+ mon->capab_offered[QMP_CAPABILITY_OOB] = mon->common.use_io_thread;
}
/*
@@ -1172,7 +1184,7 @@ static void monitor_qmp_caps_reset(Monitor *mon)
* On success, set mon->qmp.capab[], and return true.
* On error, set @errp, and return false.
*/
-static bool qmp_caps_accept(Monitor *mon, QMPCapabilityList *list,
+static bool qmp_caps_accept(MonitorQMP *mon, QMPCapabilityList *list,
Error **errp)
{
GString *unavailable = NULL;
@@ -1181,7 +1193,7 @@ static bool qmp_caps_accept(Monitor *mon, QMPCapabilityList *list,
memset(capab, 0, sizeof(capab));
for (; list; list = list->next) {
- if (!mon->qmp.capab_offered[list->value]) {
+ if (!mon->capab_offered[list->value]) {
if (!unavailable) {
unavailable = g_string_new(QMPCapability_str(list->value));
} else {
@@ -1198,25 +1210,30 @@ static bool qmp_caps_accept(Monitor *mon, QMPCapabilityList *list,
return false;
}
- memcpy(mon->qmp.capab, capab, sizeof(capab));
+ memcpy(mon->capab, capab, sizeof(capab));
return true;
}
void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
Error **errp)
{
- if (cur_mon->qmp.commands == &qmp_commands) {
+ MonitorQMP *mon;
+
+ assert(monitor_is_qmp(cur_mon));
+ mon = container_of(cur_mon, MonitorQMP, common);
+
+ if (mon->commands == &qmp_commands) {
error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
"Capabilities negotiation is already complete, command "
"ignored");
return;
}
- if (!qmp_caps_accept(cur_mon, enable, errp)) {
+ if (!qmp_caps_accept(mon, enable, errp)) {
return;
}
- cur_mon->qmp.commands = &qmp_commands;
+ mon->commands = &qmp_commands;
}
/* Set the current CPU defined by the user. Callers must hold BQL. */
@@ -4123,27 +4140,27 @@ static int monitor_can_read(void *opaque)
* Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
* Nothing is emitted then.
*/
-static void monitor_qmp_respond(Monitor *mon, QDict *rsp)
+static void monitor_qmp_respond(MonitorQMP *mon, QDict *rsp)
{
if (rsp) {
qmp_send_response(mon, rsp);
}
}
-static void monitor_qmp_dispatch(Monitor *mon, QObject *req)
+static void monitor_qmp_dispatch(MonitorQMP *mon, QObject *req)
{
Monitor *old_mon;
QDict *rsp;
QDict *error;
old_mon = cur_mon;
- cur_mon = mon;
+ cur_mon = &mon->common;
- rsp = qmp_dispatch(mon->qmp.commands, req, qmp_oob_enabled(mon));
+ rsp = qmp_dispatch(mon->commands, req, qmp_oob_enabled(mon));
cur_mon = old_mon;
- if (mon->qmp.commands == &qmp_cap_negotiation_commands) {
+ if (mon->commands == &qmp_cap_negotiation_commands) {
error = qdict_get_qdict(rsp, "error");
if (error
&& !g_strcmp0(qdict_get_try_str(error, "class"),
@@ -4168,24 +4185,30 @@ static void monitor_qmp_dispatch(Monitor *mon, QObject *req)
* monitor to the end of mon_list queue.
*
* Note: if the function returned with non-NULL, then the caller will
- * be with mon->qmp.qmp_queue_lock held, and the caller is responsible
+ * be with qmp_mon->qmp_queue_lock held, and the caller is responsible
* to release it.
*/
static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void)
{
QMPRequest *req_obj = NULL;
Monitor *mon;
+ MonitorQMP *qmp_mon;
qemu_mutex_lock(&monitor_lock);
QTAILQ_FOREACH(mon, &mon_list, entry) {
- qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
- req_obj = g_queue_pop_head(mon->qmp.qmp_requests);
+ if (!monitor_is_qmp(mon)) {
+ continue;
+ }
+
+ qmp_mon = container_of(mon, MonitorQMP, common);
+ qemu_mutex_lock(&qmp_mon->qmp_queue_lock);
+ req_obj = g_queue_pop_head(qmp_mon->qmp_requests);
if (req_obj) {
/* With the lock of corresponding queue held */
break;
}
- qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
+ qemu_mutex_unlock(&qmp_mon->qmp_queue_lock);
}
if (req_obj) {
@@ -4207,7 +4230,7 @@ static void monitor_qmp_bh_dispatcher(void *data)
QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock();
QDict *rsp;
bool need_resume;
- Monitor *mon;
+ MonitorQMP *mon;
if (!req_obj) {
return;
@@ -4216,8 +4239,8 @@ static void monitor_qmp_bh_dispatcher(void *data)
mon = req_obj->mon;
/* qmp_oob_enabled() might change after "qmp_capabilities" */
need_resume = !qmp_oob_enabled(mon) ||
- mon->qmp.qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1;
- qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
+ mon->qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1;
+ qemu_mutex_unlock(&mon->qmp_queue_lock);
if (req_obj->req) {
QDict *qdict = qobject_to(QDict, req_obj->req);
QObject *id = qdict ? qdict_get(qdict, "id") : NULL;
@@ -4233,7 +4256,7 @@ static void monitor_qmp_bh_dispatcher(void *data)
if (need_resume) {
/* Pairs with the monitor_suspend() in handle_qmp_command() */
- monitor_resume(mon);
+ monitor_resume(&mon->common);
}
qmp_request_free(req_obj);
@@ -4243,7 +4266,7 @@ static void monitor_qmp_bh_dispatcher(void *data)
static void handle_qmp_command(void *opaque, QObject *req, Error *err)
{
- Monitor *mon = opaque;
+ MonitorQMP *mon = opaque;
QObject *id = NULL;
QDict *qdict;
QMPRequest *req_obj;
@@ -4275,7 +4298,7 @@ static void handle_qmp_command(void *opaque, QObject *req, Error *err)
req_obj->err = err;
/* Protect qmp_requests and fetching its length. */
- qemu_mutex_lock(&mon->qmp.qmp_queue_lock);
+ qemu_mutex_lock(&mon->qmp_queue_lock);
/*
* Suspend the monitor when we can't queue more requests after
@@ -4284,8 +4307,8 @@ static void handle_qmp_command(void *opaque, QObject *req, Error *err)
* command, for backward compatibility.
*/
if (!qmp_oob_enabled(mon) ||
- mon->qmp.qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1) {
- monitor_suspend(mon);
+ mon->qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1) {
+ monitor_suspend(&mon->common);
}
/*
@@ -4293,9 +4316,9 @@ static void handle_qmp_command(void *opaque, QObject *req, Error *err)
* handled in time order. Ownership for req_obj, req,
* etc. will be delivered to the handler side.
*/
- assert(mon->qmp.qmp_requests->length < QMP_REQ_QUEUE_LEN_MAX);
- g_queue_push_tail(mon->qmp.qmp_requests, req_obj);
- qemu_mutex_unlock(&mon->qmp.qmp_queue_lock);
+ assert(mon->qmp_requests->length < QMP_REQ_QUEUE_LEN_MAX);
+ g_queue_push_tail(mon->qmp_requests, req_obj);
+ qemu_mutex_unlock(&mon->qmp_queue_lock);
/* Kick the dispatcher routine */
qemu_bh_schedule(qmp_dispatcher_bh);
@@ -4303,9 +4326,9 @@ static void handle_qmp_command(void *opaque, QObject *req, Error *err)
static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
{
- Monitor *mon = opaque;
+ MonitorQMP *mon = opaque;
- json_message_parser_feed(&mon->qmp.parser, (const char *) buf, size);
+ json_message_parser_feed(&mon->parser, (const char *) buf, size);
}
static void monitor_read(void *opaque, const uint8_t *buf, int size)
@@ -4391,7 +4414,7 @@ void monitor_resume(Monitor *mon)
trace_monitor_suspend(mon, -1);
}
-static QDict *qmp_greeting(Monitor *mon)
+static QDict *qmp_greeting(MonitorQMP *mon)
{
QList *cap_list = qlist_new();
QObject *ver = NULL;
@@ -4400,7 +4423,7 @@ static QDict *qmp_greeting(Monitor *mon)
qmp_marshal_query_version(NULL, &ver, NULL);
for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
- if (mon->qmp.capab_offered[cap]) {
+ if (mon->capab_offered[cap]) {
qlist_append_str(cap_list, QMPCapability_str(cap));
}
}
@@ -4413,11 +4436,11 @@ static QDict *qmp_greeting(Monitor *mon)
static void monitor_qmp_event(void *opaque, int event)
{
QDict *data;
- Monitor *mon = opaque;
+ MonitorQMP *mon = opaque;
switch (event) {
case CHR_EVENT_OPENED:
- mon->qmp.commands = &qmp_cap_negotiation_commands;
+ mon->commands = &qmp_cap_negotiation_commands;
monitor_qmp_caps_reset(mon);
data = qmp_greeting(mon);
qmp_send_response(mon, data);
@@ -4432,8 +4455,8 @@ static void monitor_qmp_event(void *opaque, int event)
* is closed.
*/
monitor_qmp_cleanup_queues(mon);
- json_message_parser_destroy(&mon->qmp.parser);
- json_message_parser_init(&mon->qmp.parser, handle_qmp_command,
+ json_message_parser_destroy(&mon->parser);
+ json_message_parser_init(&mon->parser, handle_qmp_command,
mon, NULL);
mon_refcount--;
monitor_fdsets_cleanup();
@@ -4595,33 +4618,37 @@ static void monitor_list_append(Monitor *mon)
static void monitor_qmp_setup_handlers_bh(void *opaque)
{
- Monitor *mon = opaque;
+ MonitorQMP *mon = opaque;
GMainContext *context;
- assert(mon->use_io_thread);
+ assert(mon->common.use_io_thread);
context = iothread_get_g_main_context(mon_iothread);
assert(context);
- qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_qmp_read,
- monitor_qmp_event, NULL, mon, context, true);
- monitor_list_append(mon);
+ qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read,
+ monitor_qmp_read, monitor_qmp_event,
+ NULL, &mon->common, context, true);
+ monitor_list_append(&mon->common);
}
static void monitor_init_qmp(Chardev *chr, int flags)
{
- Monitor *mon = g_new0(Monitor, 1);
+ MonitorQMP *mon = g_new0(MonitorQMP, 1);
/* Only HMP supports readline */
assert(!(flags & MONITOR_USE_READLINE));
/* Note: we run QMP monitor in I/O thread when @chr supports that */
- monitor_data_init(mon, flags, false,
+ monitor_data_init(&mon->common, flags, false,
qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT));
- qemu_chr_fe_init(&mon->chr, chr, &error_abort);
- qemu_chr_fe_set_echo(&mon->chr, true);
+ qemu_mutex_init(&mon->qmp_queue_lock);
+ mon->qmp_requests = g_queue_new();
- json_message_parser_init(&mon->qmp.parser, handle_qmp_command, mon, NULL);
- if (mon->use_io_thread) {
+ qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
+ qemu_chr_fe_set_echo(&mon->common.chr, true);
+
+ json_message_parser_init(&mon->parser, handle_qmp_command, mon, NULL);
+ if (mon->common.use_io_thread) {
/*
* Make sure the old iowatch is gone. It's possible when
* e.g. the chardev is in client mode, with wait=on.
@@ -4636,10 +4663,10 @@ static void monitor_init_qmp(Chardev *chr, int flags)
monitor_qmp_setup_handlers_bh, mon);
/* The bottom half will add @mon to @mon_list */
} else {
- qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read,
+ qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read,
monitor_qmp_read, monitor_qmp_event,
- NULL, mon, NULL, true);
- monitor_list_append(mon);
+ NULL, &mon->common, NULL, true);
+ monitor_list_append(&mon->common);
}
}
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 05/16] monitor: Create MonitorHMP with readline state
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (3 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 04/16] monitor: Make MonitorQMP a child class of Monitor Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 06/16] monitor: Remove Monitor.cmd_table indirection Markus Armbruster
` (13 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
The ReadLineState in Monitor is only used for HMP monitors. Create
MonitorHMP and move it there.
Can't use container_of() in hmp_change(). Cast instead, and mark
FIXME. Will be cleaned up shortly.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Message-Id: <20190613153405.24769-5-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Superfluous variable in monitor_data_destroy() eliminated, whitespace
tweaked in hmp_change(), commit message improved]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
hmp.c | 4 +-
include/monitor/monitor.h | 5 +-
monitor.c | 126 +++++++++++++++++++++-----------------
3 files changed, 77 insertions(+), 58 deletions(-)
diff --git a/hmp.c b/hmp.c
index be5e345c6f..e6ea7cb9c2 100644
--- a/hmp.c
+++ b/hmp.c
@@ -1943,6 +1943,8 @@ static void hmp_change_read_arg(void *opaque, const char *password,
void hmp_change(Monitor *mon, const QDict *qdict)
{
+ /* FIXME Make MonitorHMP public and use container_of */
+ MonitorHMP *hmp_mon = (MonitorHMP *)mon;
const char *device = qdict_get_str(qdict, "device");
const char *target = qdict_get_str(qdict, "target");
const char *arg = qdict_get_try_str(qdict, "arg");
@@ -1960,7 +1962,7 @@ void hmp_change(Monitor *mon, const QDict *qdict)
if (strcmp(target, "passwd") == 0 ||
strcmp(target, "password") == 0) {
if (!arg) {
- monitor_read_password(mon, hmp_change_read_arg, NULL);
+ monitor_read_password(hmp_mon, hmp_change_read_arg, NULL);
return;
}
}
diff --git a/include/monitor/monitor.h b/include/monitor/monitor.h
index 1e1d6d2269..f9d30e1d78 100644
--- a/include/monitor/monitor.h
+++ b/include/monitor/monitor.h
@@ -6,6 +6,7 @@
#include "qemu/readline.h"
extern __thread Monitor *cur_mon;
+typedef struct MonitorHMP MonitorHMP;
/* flags for monitor_init */
/* 0x01 unused */
@@ -34,8 +35,8 @@ void monitor_flush(Monitor *mon);
int monitor_set_cpu(int cpu_index);
int monitor_get_cpu_index(void);
-void monitor_read_command(Monitor *mon, int show_prompt);
-int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
+void monitor_read_command(MonitorHMP *mon, int show_prompt);
+int monitor_read_password(MonitorHMP *mon, ReadLineFunc *readline_func,
void *opaque);
AddfdInfo *monitor_fdset_add_fd(int fd, bool has_fdset_id, int64_t fdset_id,
diff --git a/monitor.c b/monitor.c
index 15f94fc41f..7c57308e2a 100644
--- a/monitor.c
+++ b/monitor.c
@@ -192,14 +192,6 @@ struct Monitor {
bool skip_flush;
bool use_io_thread;
- /*
- * State used only in the thread "owning" the monitor.
- * If @use_io_thread, this is @mon_iothread.
- * Else, it's the main thread.
- * These members can be safely accessed without locks.
- */
- ReadLineState *rs;
-
gchar *mon_cpu_path;
mon_cmd_t *cmd_table;
QTAILQ_ENTRY(Monitor) entry;
@@ -220,6 +212,18 @@ struct Monitor {
int mux_out;
};
+struct MonitorHMP {
+ Monitor common;
+ /*
+ * State used only in the thread "owning" the monitor.
+ * If @use_io_thread, this is @mon_iothread. (This does not actually happen
+ * in the current state of the code.)
+ * Else, it's the main thread.
+ * These members can be safely accessed without locks.
+ */
+ ReadLineState *rs;
+};
+
typedef struct {
Monitor common;
JSONMessageParser parser;
@@ -326,7 +330,7 @@ bool monitor_cur_is_qmp(void)
return cur_mon && monitor_is_qmp(cur_mon);
}
-void monitor_read_command(Monitor *mon, int show_prompt)
+void monitor_read_command(MonitorHMP *mon, int show_prompt)
{
if (!mon->rs)
return;
@@ -336,7 +340,7 @@ void monitor_read_command(Monitor *mon, int show_prompt)
readline_show_prompt(mon->rs);
}
-int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
+int monitor_read_password(MonitorHMP *mon, ReadLineFunc *readline_func,
void *opaque)
{
if (mon->rs) {
@@ -344,7 +348,8 @@ int monitor_read_password(Monitor *mon, ReadLineFunc *readline_func,
/* prompt is printed on return from the command handler */
return 0;
} else {
- monitor_printf(mon, "terminal does not support password prompting\n");
+ monitor_printf(&mon->common,
+ "terminal does not support password prompting\n");
return -ENOTTY;
}
}
@@ -705,7 +710,7 @@ static void monitor_qapi_event_init(void)
qapi_event_throttle_equal);
}
-static void handle_hmp_command(Monitor *mon, const char *cmdline);
+static void handle_hmp_command(MonitorHMP *mon, const char *cmdline);
static void monitor_iothread_init(void);
@@ -738,8 +743,9 @@ static void monitor_data_destroy(Monitor *mon)
qemu_chr_fe_deinit(&mon->chr, false);
if (monitor_is_qmp(mon)) {
monitor_data_destroy_qmp(container_of(mon, MonitorQMP, common));
+ } else {
+ readline_free(container_of(mon, MonitorHMP, common)->rs);
}
- readline_free(mon->rs);
qobject_unref(mon->outbuf);
qemu_mutex_destroy(&mon->mon_lock);
}
@@ -749,12 +755,12 @@ char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
{
char *output = NULL;
Monitor *old_mon;
- Monitor hmp = {};
+ MonitorHMP hmp = {};
- monitor_data_init(&hmp, 0, true, false);
+ monitor_data_init(&hmp.common, 0, true, false);
old_mon = cur_mon;
- cur_mon = &hmp;
+ cur_mon = &hmp.common;
if (has_cpu_index) {
int ret = monitor_set_cpu(cpu_index);
@@ -769,16 +775,16 @@ char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
handle_hmp_command(&hmp, command_line);
cur_mon = old_mon;
- qemu_mutex_lock(&hmp.mon_lock);
- if (qstring_get_length(hmp.outbuf) > 0) {
- output = g_strdup(qstring_get_str(hmp.outbuf));
+ qemu_mutex_lock(&hmp.common.mon_lock);
+ if (qstring_get_length(hmp.common.outbuf) > 0) {
+ output = g_strdup(qstring_get_str(hmp.common.outbuf));
} else {
output = g_strdup("");
}
- qemu_mutex_unlock(&hmp.mon_lock);
+ qemu_mutex_unlock(&hmp.common.mon_lock);
out:
- monitor_data_destroy(&hmp);
+ monitor_data_destroy(&hmp.common);
return output;
}
@@ -1348,16 +1354,19 @@ static void hmp_info_sync_profile(Monitor *mon, const QDict *qdict)
static void hmp_info_history(Monitor *mon, const QDict *qdict)
{
+ MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
int i;
const char *str;
- if (!mon->rs)
+ if (!hmp_mon->rs) {
return;
+ }
i = 0;
for(;;) {
- str = readline_get_history(mon->rs, i);
- if (!str)
+ str = readline_get_history(hmp_mon->rs, i);
+ if (!str) {
break;
+ }
monitor_printf(mon, "%d: '%s'\n", i, str);
i++;
}
@@ -3055,11 +3064,12 @@ static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
* Do not assume the return value points into @table! It doesn't when
* the command is found in a sub-command table.
*/
-static const mon_cmd_t *monitor_parse_command(Monitor *mon,
+static const mon_cmd_t *monitor_parse_command(MonitorHMP *hmp_mon,
const char *cmdp_start,
const char **cmdp,
mon_cmd_t *table)
{
+ Monitor *mon = &hmp_mon->common;
const char *p;
const mon_cmd_t *cmd;
char cmdname[256];
@@ -3090,7 +3100,7 @@ static const mon_cmd_t *monitor_parse_command(Monitor *mon,
*cmdp = p;
/* search sub command */
if (cmd->sub_table != NULL && *p != '\0') {
- return monitor_parse_command(mon, cmdp_start, cmdp, cmd->sub_table);
+ return monitor_parse_command(hmp_mon, cmdp_start, cmdp, cmd->sub_table);
}
return cmd;
@@ -3467,7 +3477,7 @@ fail:
return NULL;
}
-static void handle_hmp_command(Monitor *mon, const char *cmdline)
+static void handle_hmp_command(MonitorHMP *mon, const char *cmdline)
{
QDict *qdict;
const mon_cmd_t *cmd;
@@ -3475,26 +3485,26 @@ static void handle_hmp_command(Monitor *mon, const char *cmdline)
trace_handle_hmp_command(mon, cmdline);
- cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->cmd_table);
+ cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->common.cmd_table);
if (!cmd) {
return;
}
- qdict = monitor_parse_arguments(mon, &cmdline, cmd);
+ qdict = monitor_parse_arguments(&mon->common, &cmdline, cmd);
if (!qdict) {
while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
cmdline--;
}
- monitor_printf(mon, "Try \"help %.*s\" for more information\n",
+ monitor_printf(&mon->common, "Try \"help %.*s\" for more information\n",
(int)(cmdline - cmd_start), cmd_start);
return;
}
- cmd->cmd(mon, qdict);
+ cmd->cmd(&mon->common, qdict);
qobject_unref(qdict);
}
-static void cmd_completion(Monitor *mon, const char *name, const char *list)
+static void cmd_completion(MonitorHMP *mon, const char *name, const char *list)
{
const char *p, *pstart;
char cmd[128];
@@ -3518,7 +3528,7 @@ static void cmd_completion(Monitor *mon, const char *name, const char *list)
}
}
-static void file_completion(Monitor *mon, const char *input)
+static void file_completion(MonitorHMP *mon, const char *input)
{
DIR *ffs;
struct dirent *d;
@@ -4007,7 +4017,7 @@ void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
}
}
-static void monitor_find_completion_by_table(Monitor *mon,
+static void monitor_find_completion_by_table(MonitorHMP *mon,
const mon_cmd_t *cmd_table,
char **args,
int nb_args)
@@ -4102,7 +4112,7 @@ static void monitor_find_completion_by_table(Monitor *mon,
static void monitor_find_completion(void *opaque,
const char *cmdline)
{
- Monitor *mon = opaque;
+ MonitorHMP *mon = opaque;
char *args[MAX_ARGS];
int nb_args, len;
@@ -4122,7 +4132,7 @@ static void monitor_find_completion(void *opaque,
}
/* 2. auto complete according to args */
- monitor_find_completion_by_table(mon, mon->cmd_table, args, nb_args);
+ monitor_find_completion_by_table(mon, mon->common.cmd_table, args, nb_args);
cleanup:
free_cmdline_args(args, nb_args);
@@ -4333,19 +4343,21 @@ static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
static void monitor_read(void *opaque, const uint8_t *buf, int size)
{
+ MonitorHMP *mon;
Monitor *old_mon = cur_mon;
int i;
cur_mon = opaque;
+ mon = container_of(cur_mon, MonitorHMP, common);
- if (cur_mon->rs) {
+ if (mon->rs) {
for (i = 0; i < size; i++)
- readline_handle_byte(cur_mon->rs, buf[i]);
+ readline_handle_byte(mon->rs, buf[i]);
} else {
if (size == 0 || buf[size - 1] != 0)
monitor_printf(cur_mon, "corrupted command\n");
else
- handle_hmp_command(cur_mon, (char *)buf);
+ handle_hmp_command(mon, (char *)buf);
}
cur_mon = old_mon;
@@ -4354,11 +4366,11 @@ static void monitor_read(void *opaque, const uint8_t *buf, int size)
static void monitor_command_cb(void *opaque, const char *cmdline,
void *readline_opaque)
{
- Monitor *mon = opaque;
+ MonitorHMP *mon = opaque;
- monitor_suspend(mon);
+ monitor_suspend(&mon->common);
handle_hmp_command(mon, cmdline);
- monitor_resume(mon);
+ monitor_resume(&mon->common);
}
int monitor_suspend(Monitor *mon)
@@ -4404,8 +4416,9 @@ void monitor_resume(Monitor *mon)
}
if (!monitor_is_qmp(mon)) {
- assert(mon->rs);
- readline_show_prompt(mon->rs);
+ MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
+ assert(hmp_mon->rs);
+ readline_show_prompt(hmp_mon->rs);
}
aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
@@ -4467,6 +4480,7 @@ static void monitor_qmp_event(void *opaque, int event)
static void monitor_event(void *opaque, int event)
{
Monitor *mon = opaque;
+ MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
switch (event) {
case CHR_EVENT_MUX_IN:
@@ -4474,7 +4488,7 @@ static void monitor_event(void *opaque, int event)
mon->mux_out = 0;
qemu_mutex_unlock(&mon->mon_lock);
if (mon->reset_seen) {
- readline_restart(mon->rs);
+ readline_restart(hmp_mon->rs);
monitor_resume(mon);
monitor_flush(mon);
} else {
@@ -4501,8 +4515,8 @@ static void monitor_event(void *opaque, int event)
monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
"information\n", QEMU_VERSION);
if (!mon->mux_out) {
- readline_restart(mon->rs);
- readline_show_prompt(mon->rs);
+ readline_restart(hmp_mon->rs);
+ readline_show_prompt(hmp_mon->rs);
}
mon->reset_seen = 1;
mon_refcount++;
@@ -4563,15 +4577,17 @@ void monitor_init_globals(void)
static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
const char *fmt, ...)
{
+ MonitorHMP *mon = opaque;
va_list ap;
va_start(ap, fmt);
- monitor_vprintf(opaque, fmt, ap);
+ monitor_vprintf(&mon->common, fmt, ap);
va_end(ap);
}
static void monitor_readline_flush(void *opaque)
{
- monitor_flush(opaque);
+ MonitorHMP *mon = opaque;
+ monitor_flush(&mon->common);
}
/*
@@ -4672,11 +4688,11 @@ static void monitor_init_qmp(Chardev *chr, int flags)
static void monitor_init_hmp(Chardev *chr, int flags)
{
- Monitor *mon = g_new0(Monitor, 1);
+ MonitorHMP *mon = g_new0(MonitorHMP, 1);
bool use_readline = flags & MONITOR_USE_READLINE;
- monitor_data_init(mon, flags, false, false);
- qemu_chr_fe_init(&mon->chr, chr, &error_abort);
+ monitor_data_init(&mon->common, flags, false, false);
+ qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
if (use_readline) {
mon->rs = readline_init(monitor_readline_printf,
@@ -4686,9 +4702,9 @@ static void monitor_init_hmp(Chardev *chr, int flags)
monitor_read_command(mon, 0);
}
- qemu_chr_fe_set_handlers(&mon->chr, monitor_can_read, monitor_read,
- monitor_event, NULL, mon, NULL, true);
- monitor_list_append(mon);
+ qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read, monitor_read,
+ monitor_event, NULL, &mon->common, NULL, true);
+ monitor_list_append(&mon->common);
}
void monitor_init(Chardev *chr, int flags)
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 06/16] monitor: Remove Monitor.cmd_table indirection
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (4 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 05/16] monitor: Create MonitorHMP with readline state Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 07/16] monitor: Rename HMP command type and tables Markus Armbruster
` (12 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
Monitor.cmd_table is initialised to point to mon_cmds and never changed
afterwards. We can remove the indirection and just reference mon_cmds
directly instead.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-6-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
monitor.c | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/monitor.c b/monitor.c
index 7c57308e2a..6fb9fa285c 100644
--- a/monitor.c
+++ b/monitor.c
@@ -193,7 +193,6 @@ struct Monitor {
bool use_io_thread;
gchar *mon_cpu_path;
- mon_cmd_t *cmd_table;
QTAILQ_ENTRY(Monitor) entry;
/*
@@ -722,8 +721,6 @@ static void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
}
qemu_mutex_init(&mon->mon_lock);
mon->outbuf = qstring_new();
- /* Use *mon_cmds by default. */
- mon->cmd_table = mon_cmds;
mon->skip_flush = skip_flush;
mon->use_io_thread = use_io_thread;
mon->flags = flags;
@@ -1024,7 +1021,7 @@ static void help_cmd(Monitor *mon, const char *name)
}
/* 2. dump the contents according to parsed args */
- help_cmd_dump(mon, mon->cmd_table, args, nb_args, 0);
+ help_cmd_dump(mon, mon_cmds, args, nb_args, 0);
free_cmdline_args(args, nb_args);
}
@@ -3485,7 +3482,7 @@ static void handle_hmp_command(MonitorHMP *mon, const char *cmdline)
trace_handle_hmp_command(mon, cmdline);
- cmd = monitor_parse_command(mon, cmdline, &cmdline, mon->common.cmd_table);
+ cmd = monitor_parse_command(mon, cmdline, &cmdline, mon_cmds);
if (!cmd) {
return;
}
@@ -4132,7 +4129,7 @@ static void monitor_find_completion(void *opaque,
}
/* 2. auto complete according to args */
- monitor_find_completion_by_table(mon, mon->common.cmd_table, args, nb_args);
+ monitor_find_completion_by_table(mon, mon_cmds, args, nb_args);
cleanup:
free_cmdline_args(args, nb_args);
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 07/16] monitor: Rename HMP command type and tables
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (5 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 06/16] monitor: Remove Monitor.cmd_table indirection Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 08/16] Move monitor.c to monitor/misc.c Markus Armbruster
` (11 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
This renames the type for HMP monitor commands and the tables holding
the commands to make clear that they are related to HMP and to allow
making them public later:
* mon_cmd_t -> HMPCommand (fixing use of a reserved name, too)
* mon_cmds -> hmp_cmds
* info_cmds -> hmp_info_cmds
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-7-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[sortcmdlist() cleaned up to make checkpatch.pl happy]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
hmp-commands.hx | 2 +-
monitor.c | 72 ++++++++++++++++++++++++-------------------------
2 files changed, 36 insertions(+), 38 deletions(-)
diff --git a/hmp-commands.hx b/hmp-commands.hx
index a2c3ffc218..8b7aec3e8d 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -1934,7 +1934,7 @@ ETEXI
.params = "[subcommand]",
.help = "show various information about the system state",
.cmd = hmp_info_help,
- .sub_table = info_cmds,
+ .sub_table = hmp_info_cmds,
.flags = "p",
},
diff --git a/monitor.c b/monitor.c
index 6fb9fa285c..3015b6e9c7 100644
--- a/monitor.c
+++ b/monitor.c
@@ -127,7 +127,7 @@
*
*/
-typedef struct mon_cmd_t {
+typedef struct HMPCommand {
const char *name;
const char *args_type;
const char *params;
@@ -138,9 +138,9 @@ typedef struct mon_cmd_t {
* cmd should be used. If it exists, sub_table[?].cmd should be
* used, and cmd of 1st level plays the role of help function.
*/
- struct mon_cmd_t *sub_table;
+ struct HMPCommand *sub_table;
void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
-} mon_cmd_t;
+} HMPCommand;
/* file descriptors passed via SCM_RIGHTS */
typedef struct mon_fd_t mon_fd_t;
@@ -277,8 +277,8 @@ static QLIST_HEAD(, MonFdset) mon_fdsets;
static int mon_refcount;
-static mon_cmd_t mon_cmds[];
-static mon_cmd_t info_cmds[];
+static HMPCommand hmp_cmds[];
+static HMPCommand hmp_info_cmds[];
QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
@@ -933,7 +933,7 @@ static int parse_cmdline(const char *cmdline,
/*
* Can command @cmd be executed in preconfig state?
*/
-static bool cmd_can_preconfig(const mon_cmd_t *cmd)
+static bool cmd_can_preconfig(const HMPCommand *cmd)
{
if (!cmd->flags) {
return false;
@@ -943,7 +943,7 @@ static bool cmd_can_preconfig(const mon_cmd_t *cmd)
}
static void help_cmd_dump_one(Monitor *mon,
- const mon_cmd_t *cmd,
+ const HMPCommand *cmd,
char **prefix_args,
int prefix_args_nb)
{
@@ -960,10 +960,10 @@ static void help_cmd_dump_one(Monitor *mon,
}
/* @args[@arg_index] is the valid command need to find in @cmds */
-static void help_cmd_dump(Monitor *mon, const mon_cmd_t *cmds,
+static void help_cmd_dump(Monitor *mon, const HMPCommand *cmds,
char **args, int nb_args, int arg_index)
{
- const mon_cmd_t *cmd;
+ const HMPCommand *cmd;
size_t i;
/* No valid arg need to compare with, dump all in *cmds */
@@ -1021,7 +1021,7 @@ static void help_cmd(Monitor *mon, const char *name)
}
/* 2. dump the contents according to parsed args */
- help_cmd_dump(mon, mon_cmds, args, nb_args, 0);
+ help_cmd_dump(mon, hmp_cmds, args, nb_args, 0);
free_cmdline_args(args, nb_args);
}
@@ -2689,13 +2689,13 @@ int monitor_fd_param(Monitor *mon, const char *fdname, Error **errp)
}
/* Please update hmp-commands.hx when adding or changing commands */
-static mon_cmd_t info_cmds[] = {
+static HMPCommand hmp_info_cmds[] = {
#include "hmp-commands-info.h"
{ NULL, NULL, },
};
-/* mon_cmds and info_cmds would be sorted at runtime */
-static mon_cmd_t mon_cmds[] = {
+/* hmp_cmds and hmp_info_cmds would be sorted at runtime */
+static HMPCommand hmp_cmds[] = {
#include "hmp-commands.h"
{ NULL, NULL, },
};
@@ -3037,10 +3037,10 @@ static int is_valid_option(const char *c, const char *typestr)
return (typestr != NULL);
}
-static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
- const char *cmdname)
+static const HMPCommand *search_dispatch_table(const HMPCommand *disp_table,
+ const char *cmdname)
{
- const mon_cmd_t *cmd;
+ const HMPCommand *cmd;
for (cmd = disp_table; cmd->name != NULL; cmd++) {
if (compare_cmd(cmdname, cmd->name)) {
@@ -3061,14 +3061,14 @@ static const mon_cmd_t *search_dispatch_table(const mon_cmd_t *disp_table,
* Do not assume the return value points into @table! It doesn't when
* the command is found in a sub-command table.
*/
-static const mon_cmd_t *monitor_parse_command(MonitorHMP *hmp_mon,
- const char *cmdp_start,
- const char **cmdp,
- mon_cmd_t *table)
+static const HMPCommand *monitor_parse_command(MonitorHMP *hmp_mon,
+ const char *cmdp_start,
+ const char **cmdp,
+ HMPCommand *table)
{
Monitor *mon = &hmp_mon->common;
const char *p;
- const mon_cmd_t *cmd;
+ const HMPCommand *cmd;
char cmdname[256];
/* extract the command name */
@@ -3112,7 +3112,7 @@ static const mon_cmd_t *monitor_parse_command(MonitorHMP *hmp_mon,
static QDict *monitor_parse_arguments(Monitor *mon,
const char **endp,
- const mon_cmd_t *cmd)
+ const HMPCommand *cmd)
{
const char *typestr;
char *key;
@@ -3477,12 +3477,12 @@ fail:
static void handle_hmp_command(MonitorHMP *mon, const char *cmdline)
{
QDict *qdict;
- const mon_cmd_t *cmd;
+ const HMPCommand *cmd;
const char *cmd_start = cmdline;
trace_handle_hmp_command(mon, cmdline);
- cmd = monitor_parse_command(mon, cmdline, &cmdline, mon_cmds);
+ cmd = monitor_parse_command(mon, cmdline, &cmdline, hmp_cmds);
if (!cmd) {
return;
}
@@ -4015,14 +4015,14 @@ void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
}
static void monitor_find_completion_by_table(MonitorHMP *mon,
- const mon_cmd_t *cmd_table,
+ const HMPCommand *cmd_table,
char **args,
int nb_args)
{
const char *cmdname;
int i;
const char *ptype, *old_ptype, *str, *name;
- const mon_cmd_t *cmd;
+ const HMPCommand *cmd;
BlockBackend *blk = NULL;
if (nb_args <= 1) {
@@ -4129,7 +4129,7 @@ static void monitor_find_completion(void *opaque,
}
/* 2. auto complete according to args */
- monitor_find_completion_by_table(mon, mon_cmds, args, nb_args);
+ monitor_find_completion_by_table(mon, hmp_cmds, args, nb_args);
cleanup:
free_cmdline_args(args, nb_args);
@@ -4529,20 +4529,18 @@ static void monitor_event(void *opaque, int event)
static int
compare_mon_cmd(const void *a, const void *b)
{
- return strcmp(((const mon_cmd_t *)a)->name,
- ((const mon_cmd_t *)b)->name);
+ return strcmp(((const HMPCommand *)a)->name,
+ ((const HMPCommand *)b)->name);
}
static void sortcmdlist(void)
{
- int array_num;
- int elem_size = sizeof(mon_cmd_t);
-
- array_num = sizeof(mon_cmds)/elem_size-1;
- qsort((void *)mon_cmds, array_num, elem_size, compare_mon_cmd);
-
- array_num = sizeof(info_cmds)/elem_size-1;
- qsort((void *)info_cmds, array_num, elem_size, compare_mon_cmd);
+ qsort(hmp_cmds, ARRAY_SIZE(hmp_cmds) - 1,
+ sizeof(*hmp_cmds),
+ compare_mon_cmd);
+ qsort(hmp_info_cmds, ARRAY_SIZE(hmp_info_cmds) - 1,
+ sizeof(*hmp_info_cmds),
+ compare_mon_cmd);
}
static void monitor_iothread_init(void)
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 08/16] Move monitor.c to monitor/misc.c
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (6 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 07/16] monitor: Rename HMP command type and tables Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 09/16] monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c Markus Armbruster
` (10 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Create a new monitor/ subdirectory and move monitor.c there. As the plan
is to move the monitor core into separate files, use the chance to
rename it to misc.c.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190613153405.24769-8-kwolf@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
MAINTAINERS | 4 ++--
Makefile.objs | 1 +
Makefile.target | 3 ++-
docs/devel/writing-qmp-commands.txt | 2 +-
monitor/Makefile.objs | 1 +
monitor.c => monitor/misc.c | 2 +-
monitor/trace-events | 11 +++++++++++
trace-events | 10 ----------
8 files changed, 19 insertions(+), 15 deletions(-)
create mode 100644 monitor/Makefile.objs
rename monitor.c => monitor/misc.c (99%)
create mode 100644 monitor/trace-events
diff --git a/MAINTAINERS b/MAINTAINERS
index acbad134ec..575ea6e68d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1918,7 +1918,7 @@ F: qapi/run-state.json
Human Monitor (HMP)
M: Dr. David Alan Gilbert <dgilbert@redhat.com>
S: Maintained
-F: monitor.c
+F: monitor/misc.c
F: hmp.[ch]
F: hmp-commands*.hx
F: include/monitor/hmp-target.h
@@ -2040,7 +2040,7 @@ QMP
M: Markus Armbruster <armbru@redhat.com>
S: Supported
F: qmp.c
-F: monitor.c
+F: monitor/misc.c
F: docs/devel/*qmp-*
F: docs/interop/*qmp-*
F: scripts/qmp/
diff --git a/Makefile.objs b/Makefile.objs
index c8337fa34b..dd39a70b48 100644
--- a/Makefile.objs
+++ b/Makefile.objs
@@ -130,6 +130,7 @@ trace-events-subdirs =
trace-events-subdirs += accel/kvm
trace-events-subdirs += accel/tcg
trace-events-subdirs += crypto
+trace-events-subdirs += monitor
ifeq ($(CONFIG_USER_ONLY),y)
trace-events-subdirs += linux-user
endif
diff --git a/Makefile.target b/Makefile.target
index ecd856e3a3..72c267f7dc 100644
--- a/Makefile.target
+++ b/Makefile.target
@@ -148,9 +148,10 @@ endif #CONFIG_BSD_USER
#########################################################
# System emulator target
ifdef CONFIG_SOFTMMU
-obj-y += arch_init.o cpus.o monitor.o gdbstub.o balloon.o ioport.o numa.o
+obj-y += arch_init.o cpus.o gdbstub.o balloon.o ioport.o numa.o
obj-y += qtest.o
obj-y += hw/
+obj-y += monitor/
obj-y += qapi/
obj-y += memory.o
obj-y += memory_mapping.o
diff --git a/docs/devel/writing-qmp-commands.txt b/docs/devel/writing-qmp-commands.txt
index 9dfc62bf5a..cc6ecd6d5d 100644
--- a/docs/devel/writing-qmp-commands.txt
+++ b/docs/devel/writing-qmp-commands.txt
@@ -470,7 +470,7 @@ it's good practice to always check for errors.
Another important detail is that HMP's "info" commands don't go into the
hmp-commands.hx. Instead, they go into the info_cmds[] table, which is defined
-in the monitor.c file. The entry for the "info alarmclock" follows:
+in the monitor/misc.c file. The entry for the "info alarmclock" follows:
{
.name = "alarmclock",
diff --git a/monitor/Makefile.objs b/monitor/Makefile.objs
new file mode 100644
index 0000000000..e783b0616b
--- /dev/null
+++ b/monitor/Makefile.objs
@@ -0,0 +1 @@
+obj-y += misc.o
diff --git a/monitor.c b/monitor/misc.c
similarity index 99%
rename from monitor.c
rename to monitor/misc.c
index 3015b6e9c7..c5f8483b7e 100644
--- a/monitor.c
+++ b/monitor/misc.c
@@ -64,7 +64,7 @@
#include "qapi/qmp/json-parser.h"
#include "qapi/qmp/qlist.h"
#include "qom/object_interfaces.h"
-#include "trace-root.h"
+#include "trace.h"
#include "trace/control.h"
#include "monitor/hmp-target.h"
#ifdef CONFIG_TRACE_SIMPLE
diff --git a/monitor/trace-events b/monitor/trace-events
new file mode 100644
index 0000000000..abfdf20b14
--- /dev/null
+++ b/monitor/trace-events
@@ -0,0 +1,11 @@
+# See docs/devel/tracing.txt for syntax documentation.
+
+# misc.c
+monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
+monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
+monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
+handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
+handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
+monitor_suspend(void *ptr, int cnt) "mon %p: %d"
+monitor_qmp_cmd_in_band(const char *id) "%s"
+monitor_qmp_cmd_out_of_band(const char *id) "%s"
diff --git a/trace-events b/trace-events
index 844ee58dd9..aeea3c2bdb 100644
--- a/trace-events
+++ b/trace-events
@@ -41,16 +41,6 @@ system_wakeup_request(int reason) "reason=%d"
qemu_system_shutdown_request(int reason) "reason=%d"
qemu_system_powerdown_request(void) ""
-# monitor.c
-monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
-monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
-monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
-handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
-handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
-monitor_suspend(void *ptr, int cnt) "mon %p: %d"
-monitor_qmp_cmd_in_band(const char *id) "%s"
-monitor_qmp_cmd_out_of_band(const char *id) "%s"
-
# dma-helpers.c
dma_blk_io(void *dbs, void *bs, int64_t offset, bool to_dev) "dbs=%p bs=%p offset=%" PRId64 " to_dev=%d"
dma_aio_cancel(void *dbs) "dbs=%p"
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 09/16] monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (7 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 08/16] Move monitor.c to monitor/misc.c Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 10/16] monitor: Create monitor-internal.h with common definitions Markus Armbruster
` (9 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Now that we have a monitor/ subdirectory, let's move hmp.c and qmp.c
from the root directory there. As they contain implementations of
monitor commands, rename them to {hmp,qmp}-cmds.c, so that {hmp,qmp}.c
are free for the HMP and QMP infrastructure.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190613153405.24769-9-kwolf@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
MAINTAINERS | 5 +++--
Makefile.objs | 2 +-
docs/devel/writing-qmp-commands.txt | 9 +++++----
monitor/Makefile.objs | 1 +
hmp.c => monitor/hmp-cmds.c | 2 +-
qmp.c => monitor/qmp-cmds.c | 2 +-
6 files changed, 12 insertions(+), 9 deletions(-)
rename hmp.c => monitor/hmp-cmds.c (99%)
rename qmp.c => monitor/qmp-cmds.c (99%)
diff --git a/MAINTAINERS b/MAINTAINERS
index 575ea6e68d..3c7d366727 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1919,7 +1919,8 @@ Human Monitor (HMP)
M: Dr. David Alan Gilbert <dgilbert@redhat.com>
S: Maintained
F: monitor/misc.c
-F: hmp.[ch]
+F: monitor/hmp*
+F: hmp.h
F: hmp-commands*.hx
F: include/monitor/hmp-target.h
F: tests/test-hmp.c
@@ -2039,7 +2040,7 @@ F: tests/check-qom-proplist.c
QMP
M: Markus Armbruster <armbru@redhat.com>
S: Supported
-F: qmp.c
+F: monitor/qmp*
F: monitor/misc.c
F: docs/devel/*qmp-*
F: docs/interop/*qmp-*
diff --git a/Makefile.objs b/Makefile.objs
index dd39a70b48..9495fcbc7e 100644
--- a/Makefile.objs
+++ b/Makefile.objs
@@ -83,8 +83,8 @@ common-obj-$(CONFIG_FDT) += device_tree.o
######################################################################
# qapi
-common-obj-y += qmp.o hmp.o
common-obj-y += qapi/
+common-obj-y += monitor/
endif
#######################################################################
diff --git a/docs/devel/writing-qmp-commands.txt b/docs/devel/writing-qmp-commands.txt
index cc6ecd6d5d..46a6c48683 100644
--- a/docs/devel/writing-qmp-commands.txt
+++ b/docs/devel/writing-qmp-commands.txt
@@ -20,7 +20,7 @@ new QMP command.
2. Write the QMP command itself, which is a regular C function. Preferably,
the command should be exported by some QEMU subsystem. But it can also be
- added to the qmp.c file
+ added to the monitor/qmp-cmds.c file
3. At this point the command can be tested under the QMP protocol
@@ -101,7 +101,8 @@ protocol data.
The next step is to write the "hello-world" implementation. As explained
earlier, it's preferable for commands to live in QEMU subsystems. But
-"hello-world" doesn't pertain to any, so we put its implementation in qmp.c:
+"hello-world" doesn't pertain to any, so we put its implementation in
+monitor/qmp-cmds.c:
void qmp_hello_world(Error **errp)
{
@@ -146,7 +147,7 @@ for mandatory arguments). Finally, 'str' is the argument's type, which
stands for "string". The QAPI also supports integers, booleans, enumerations
and user defined types.
-Now, let's update our C implementation in qmp.c:
+Now, let's update our C implementation in monitor/qmp-cmds.c:
void qmp_hello_world(bool has_message, const char *message, Error **errp)
{
@@ -267,7 +268,7 @@ monitor (HMP).
With the introduction of the QAPI, HMP commands make QMP calls. Most of the
time HMP commands are simple wrappers. All HMP commands implementation exist in
-the hmp.c file.
+the monitor/hmp-cmds.c file.
Here's the implementation of the "hello-world" HMP command:
diff --git a/monitor/Makefile.objs b/monitor/Makefile.objs
index e783b0616b..a7170af6e1 100644
--- a/monitor/Makefile.objs
+++ b/monitor/Makefile.objs
@@ -1 +1,2 @@
obj-y += misc.o
+common-obj-y += qmp-cmds.o hmp-cmds.o
diff --git a/hmp.c b/monitor/hmp-cmds.c
similarity index 99%
rename from hmp.c
rename to monitor/hmp-cmds.c
index e6ea7cb9c2..c917e24d9c 100644
--- a/hmp.c
+++ b/monitor/hmp-cmds.c
@@ -1,5 +1,5 @@
/*
- * Human Monitor Interface
+ * Human Monitor Interface commands
*
* Copyright IBM, Corp. 2011
*
diff --git a/qmp.c b/monitor/qmp-cmds.c
similarity index 99%
rename from qmp.c
rename to monitor/qmp-cmds.c
index 6797568444..f1b1e4f08b 100644
--- a/qmp.c
+++ b/monitor/qmp-cmds.c
@@ -1,5 +1,5 @@
/*
- * QEMU Management Protocol
+ * QEMU Management Protocol commands
*
* Copyright IBM, Corp. 2011
*
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 10/16] monitor: Create monitor-internal.h with common definitions
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (8 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 09/16] monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 11/16] monitor: Split out monitor/qmp.c Markus Armbruster
` (8 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Before we can split monitor/misc.c, we need to create a header file that
contains the common definitions that will be used by multiple source
files.
For a start, add the type definitions for Monitor, MonitorHMP and
MonitorQMP and their dependencies. We'll add functions as needed when
splitting monitor/misc.c.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Message-Id: <20190613153405.24769-10-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Header guard symbol tidied up, superfluous #include dropped, FIXME in
hmp_change() resolved]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
MAINTAINERS | 2 +
monitor/hmp-cmds.c | 5 +-
monitor/misc.c | 114 +----------------------------
monitor/monitor-internal.h | 145 +++++++++++++++++++++++++++++++++++++
4 files changed, 150 insertions(+), 116 deletions(-)
create mode 100644 monitor/monitor-internal.h
diff --git a/MAINTAINERS b/MAINTAINERS
index 3c7d366727..15f21c35e0 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1918,6 +1918,7 @@ F: qapi/run-state.json
Human Monitor (HMP)
M: Dr. David Alan Gilbert <dgilbert@redhat.com>
S: Maintained
+F: monitor/monitor-internal.h
F: monitor/misc.c
F: monitor/hmp*
F: hmp.h
@@ -2040,6 +2041,7 @@ F: tests/check-qom-proplist.c
QMP
M: Markus Armbruster <armbru@redhat.com>
S: Supported
+F: monitor/monitor-internal.h
F: monitor/qmp*
F: monitor/misc.c
F: docs/devel/*qmp-*
diff --git a/monitor/hmp-cmds.c b/monitor/hmp-cmds.c
index c917e24d9c..c283dde0e9 100644
--- a/monitor/hmp-cmds.c
+++ b/monitor/hmp-cmds.c
@@ -24,7 +24,7 @@
#include "qemu/option.h"
#include "qemu/timer.h"
#include "qemu/sockets.h"
-#include "monitor/monitor.h"
+#include "monitor/monitor-internal.h"
#include "monitor/qdev.h"
#include "qapi/error.h"
#include "qapi/opts-visitor.h"
@@ -1943,8 +1943,7 @@ static void hmp_change_read_arg(void *opaque, const char *password,
void hmp_change(Monitor *mon, const QDict *qdict)
{
- /* FIXME Make MonitorHMP public and use container_of */
- MonitorHMP *hmp_mon = (MonitorHMP *)mon;
+ MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
const char *device = qdict_get_str(qdict, "device");
const char *target = qdict_get_str(qdict, "target");
const char *arg = qdict_get_try_str(qdict, "arg");
diff --git a/monitor/misc.c b/monitor/misc.c
index c5f8483b7e..3cdbb681fb 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -23,6 +23,7 @@
*/
#include "qemu/osdep.h"
+#include "monitor-internal.h"
#include "qemu/units.h"
#include <dirent.h>
#include "cpu.h"
@@ -35,15 +36,12 @@
#include "exec/gdbstub.h"
#include "net/net.h"
#include "net/slirp.h"
-#include "chardev/char-fe.h"
#include "chardev/char-io.h"
#include "chardev/char-mux.h"
#include "ui/qemu-spice.h"
#include "sysemu/numa.h"
-#include "monitor/monitor.h"
#include "qemu/config-file.h"
#include "qemu/ctype.h"
-#include "qemu/readline.h"
#include "ui/console.h"
#include "ui/input.h"
#include "sysemu/block-backend.h"
@@ -61,7 +59,6 @@
#include "qapi/qmp/qnum.h"
#include "qapi/qmp/qstring.h"
#include "qapi/qmp/qjson.h"
-#include "qapi/qmp/json-parser.h"
#include "qapi/qmp/qlist.h"
#include "qom/object_interfaces.h"
#include "trace.h"
@@ -93,55 +90,6 @@
#include "hw/s390x/storage-attributes.h"
#endif
-/*
- * Supported types:
- *
- * 'F' filename
- * 'B' block device name
- * 's' string (accept optional quote)
- * 'S' it just appends the rest of the string (accept optional quote)
- * 'O' option string of the form NAME=VALUE,...
- * parsed according to QemuOptsList given by its name
- * Example: 'device:O' uses qemu_device_opts.
- * Restriction: only lists with empty desc are supported
- * TODO lift the restriction
- * 'i' 32 bit integer
- * 'l' target long (32 or 64 bit)
- * 'M' Non-negative target long (32 or 64 bit), in user mode the
- * value is multiplied by 2^20 (think Mebibyte)
- * 'o' octets (aka bytes)
- * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
- * K, k suffix, which multiplies the value by 2^60 for suffixes E
- * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
- * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
- * 'T' double
- * user mode accepts an optional ms, us, ns suffix,
- * which divides the value by 1e3, 1e6, 1e9, respectively
- * '/' optional gdb-like print format (like "/10x")
- *
- * '?' optional type (for all types, except '/')
- * '.' other form of optional type (for 'i' and 'l')
- * 'b' boolean
- * user mode accepts "on" or "off"
- * '-' optional parameter (eg. '-f')
- *
- */
-
-typedef struct HMPCommand {
- const char *name;
- const char *args_type;
- const char *params;
- const char *help;
- const char *flags; /* p=preconfig */
- void (*cmd)(Monitor *mon, const QDict *qdict);
- /* @sub_table is a list of 2nd level of commands. If it does not exist,
- * cmd should be used. If it exists, sub_table[?].cmd should be
- * used, and cmd of 1st level plays the role of help function.
- */
- struct HMPCommand *sub_table;
- void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
-} HMPCommand;
-
/* file descriptors passed via SCM_RIGHTS */
typedef struct mon_fd_t mon_fd_t;
struct mon_fd_t {
@@ -184,66 +132,6 @@ typedef struct {
int64_t rate; /* Minimum time (in ns) between two events */
} MonitorQAPIEventConf;
-struct Monitor {
- CharBackend chr;
- int reset_seen;
- int flags;
- int suspend_cnt; /* Needs to be accessed atomically */
- bool skip_flush;
- bool use_io_thread;
-
- gchar *mon_cpu_path;
- QTAILQ_ENTRY(Monitor) entry;
-
- /*
- * The per-monitor lock. We can't access guest memory when holding
- * the lock.
- */
- QemuMutex mon_lock;
-
- /*
- * Members that are protected by the per-monitor lock
- */
- QLIST_HEAD(, mon_fd_t) fds;
- QString *outbuf;
- guint out_watch;
- /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
- int mux_out;
-};
-
-struct MonitorHMP {
- Monitor common;
- /*
- * State used only in the thread "owning" the monitor.
- * If @use_io_thread, this is @mon_iothread. (This does not actually happen
- * in the current state of the code.)
- * Else, it's the main thread.
- * These members can be safely accessed without locks.
- */
- ReadLineState *rs;
-};
-
-typedef struct {
- Monitor common;
- JSONMessageParser parser;
- /*
- * When a client connects, we're in capabilities negotiation mode.
- * @commands is &qmp_cap_negotiation_commands then. When command
- * qmp_capabilities succeeds, we go into command mode, and
- * @command becomes &qmp_commands.
- */
- QmpCommandList *commands;
- bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
- bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
- /*
- * Protects qmp request/response queue.
- * Take monitor_lock first when you need both.
- */
- QemuMutex qmp_queue_lock;
- /* Input queue that holds all the parsed QMP requests */
- GQueue *qmp_requests;
-} MonitorQMP;
-
/* Shared monitor I/O thread */
IOThread *mon_iothread;
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
new file mode 100644
index 0000000000..ebaf0201c8
--- /dev/null
+++ b/monitor/monitor-internal.h
@@ -0,0 +1,145 @@
+/*
+ * QEMU monitor
+ *
+ * Copyright (c) 2003-2004 Fabrice Bellard
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MONITOR_INTERNAL_H
+#define MONITOR_INTERNAL_H
+
+#include "chardev/char-fe.h"
+#include "monitor/monitor.h"
+#include "qapi/qapi-types-misc.h"
+#include "qapi/qmp/dispatch.h"
+#include "qapi/qmp/json-parser.h"
+#include "qemu/readline.h"
+
+/*
+ * Supported types:
+ *
+ * 'F' filename
+ * 'B' block device name
+ * 's' string (accept optional quote)
+ * 'S' it just appends the rest of the string (accept optional quote)
+ * 'O' option string of the form NAME=VALUE,...
+ * parsed according to QemuOptsList given by its name
+ * Example: 'device:O' uses qemu_device_opts.
+ * Restriction: only lists with empty desc are supported
+ * TODO lift the restriction
+ * 'i' 32 bit integer
+ * 'l' target long (32 or 64 bit)
+ * 'M' Non-negative target long (32 or 64 bit), in user mode the
+ * value is multiplied by 2^20 (think Mebibyte)
+ * 'o' octets (aka bytes)
+ * user mode accepts an optional E, e, P, p, T, t, G, g, M, m,
+ * K, k suffix, which multiplies the value by 2^60 for suffixes E
+ * and e, 2^50 for suffixes P and p, 2^40 for suffixes T and t,
+ * 2^30 for suffixes G and g, 2^20 for M and m, 2^10 for K and k
+ * 'T' double
+ * user mode accepts an optional ms, us, ns suffix,
+ * which divides the value by 1e3, 1e6, 1e9, respectively
+ * '/' optional gdb-like print format (like "/10x")
+ *
+ * '?' optional type (for all types, except '/')
+ * '.' other form of optional type (for 'i' and 'l')
+ * 'b' boolean
+ * user mode accepts "on" or "off"
+ * '-' optional parameter (eg. '-f')
+ *
+ */
+
+typedef struct HMPCommand {
+ const char *name;
+ const char *args_type;
+ const char *params;
+ const char *help;
+ const char *flags; /* p=preconfig */
+ void (*cmd)(Monitor *mon, const QDict *qdict);
+ /*
+ * @sub_table is a list of 2nd level of commands. If it does not exist,
+ * cmd should be used. If it exists, sub_table[?].cmd should be
+ * used, and cmd of 1st level plays the role of help function.
+ */
+ struct HMPCommand *sub_table;
+ void (*command_completion)(ReadLineState *rs, int nb_args, const char *str);
+} HMPCommand;
+
+struct Monitor {
+ CharBackend chr;
+ int reset_seen;
+ int flags;
+ int suspend_cnt; /* Needs to be accessed atomically */
+ bool skip_flush;
+ bool use_io_thread;
+
+ gchar *mon_cpu_path;
+ QTAILQ_ENTRY(Monitor) entry;
+
+ /*
+ * The per-monitor lock. We can't access guest memory when holding
+ * the lock.
+ */
+ QemuMutex mon_lock;
+
+ /*
+ * Members that are protected by the per-monitor lock
+ */
+ QLIST_HEAD(, mon_fd_t) fds;
+ QString *outbuf;
+ guint out_watch;
+ /* Read under either BQL or mon_lock, written with BQL+mon_lock. */
+ int mux_out;
+};
+
+struct MonitorHMP {
+ Monitor common;
+ /*
+ * State used only in the thread "owning" the monitor.
+ * If @use_io_thread, this is @mon_iothread. (This does not actually happen
+ * in the current state of the code.)
+ * Else, it's the main thread.
+ * These members can be safely accessed without locks.
+ */
+ ReadLineState *rs;
+};
+
+typedef struct {
+ Monitor common;
+ JSONMessageParser parser;
+ /*
+ * When a client connects, we're in capabilities negotiation mode.
+ * @commands is &qmp_cap_negotiation_commands then. When command
+ * qmp_capabilities succeeds, we go into command mode, and
+ * @command becomes &qmp_commands.
+ */
+ QmpCommandList *commands;
+ bool capab_offered[QMP_CAPABILITY__MAX]; /* capabilities offered */
+ bool capab[QMP_CAPABILITY__MAX]; /* offered and accepted */
+ /*
+ * Protects qmp request/response queue.
+ * Take monitor_lock first when you need both.
+ */
+ QemuMutex qmp_queue_lock;
+ /* Input queue that holds all the parsed QMP requests */
+ GQueue *qmp_requests;
+} MonitorQMP;
+
+#endif
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 11/16] monitor: Split out monitor/qmp.c
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (9 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 10/16] monitor: Create monitor-internal.h with common definitions Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 12/16] monitor: Split out monitor/hmp.c Markus Armbruster
` (7 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Dr . David Alan Gilbert
From: Kevin Wolf <kwolf@redhat.com>
Move QMP infrastructure from monitor/misc.c to monitor/qmp.c. This is
code that can be shared for all targets, so compile it only once.
The amount of function and particularly extern variables in
monitor_int.h is probably a bit larger than it needs to be, but this way
no non-trivial code modifications are needed. The interfaces between QMP
and the monitor core can be cleaned up later.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Message-Id: <20190613153405.24769-11-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[monitor_is_qmp() tidied up to make checkpatch.pl happy,
superfluous #include dropped]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
Makefile.objs | 1 +
monitor/Makefile.objs | 1 +
monitor/misc.c | 401 +-----------------------------------
monitor/monitor-internal.h | 30 +++
monitor/qmp.c | 406 +++++++++++++++++++++++++++++++++++++
monitor/trace-events | 4 +-
6 files changed, 450 insertions(+), 393 deletions(-)
create mode 100644 monitor/qmp.c
diff --git a/Makefile.objs b/Makefile.objs
index 9495fcbc7e..658cfc9d9f 100644
--- a/Makefile.objs
+++ b/Makefile.objs
@@ -46,6 +46,7 @@ ifeq ($(CONFIG_SOFTMMU),y)
common-obj-y = blockdev.o blockdev-nbd.o block/
common-obj-y += bootdevice.o iothread.o
common-obj-y += job-qmp.o
+common-obj-y += monitor/
common-obj-y += net/
common-obj-y += qdev-monitor.o device-hotplug.o
common-obj-$(CONFIG_WIN32) += os-win32.o
diff --git a/monitor/Makefile.objs b/monitor/Makefile.objs
index a7170af6e1..1037c09ff8 100644
--- a/monitor/Makefile.objs
+++ b/monitor/Makefile.objs
@@ -1,2 +1,3 @@
obj-y += misc.o
+common-obj-y += qmp.o
common-obj-y += qmp-cmds.o hmp-cmds.o
diff --git a/monitor/misc.c b/monitor/misc.c
index 3cdbb681fb..824d28d717 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -36,7 +36,6 @@
#include "exec/gdbstub.h"
#include "net/net.h"
#include "net/slirp.h"
-#include "chardev/char-io.h"
#include "chardev/char-mux.h"
#include "ui/qemu-spice.h"
#include "sysemu/numa.h"
@@ -58,8 +57,6 @@
#include "qapi/qmp/qerror.h"
#include "qapi/qmp/qnum.h"
#include "qapi/qmp/qstring.h"
-#include "qapi/qmp/qjson.h"
-#include "qapi/qmp/qlist.h"
#include "qom/object_interfaces.h"
#include "trace.h"
#include "trace/control.h"
@@ -81,7 +78,6 @@
#include "qapi/qapi-introspect.h"
#include "sysemu/qtest.h"
#include "sysemu/cpus.h"
-#include "sysemu/iothread.h"
#include "qemu/cutils.h"
#include "tcg/tcg.h"
@@ -138,51 +134,29 @@ IOThread *mon_iothread;
/* Bottom half to dispatch the requests received from I/O thread */
QEMUBH *qmp_dispatcher_bh;
-struct QMPRequest {
- /* Owner of the request */
- MonitorQMP *mon;
- /*
- * Request object to be handled or Error to be reported
- * (exactly one of them is non-null)
- */
- QObject *req;
- Error *err;
-};
-typedef struct QMPRequest QMPRequest;
-
/* QMP checker flags */
#define QMP_ACCEPT_UNKNOWNS 1
/* Protects mon_list, monitor_qapi_event_state, monitor_destroyed. */
-static QemuMutex monitor_lock;
+QemuMutex monitor_lock;
static GHashTable *monitor_qapi_event_state;
-static QTAILQ_HEAD(, Monitor) mon_list;
+MonitorList mon_list;
static bool monitor_destroyed;
/* Protects mon_fdsets */
static QemuMutex mon_fdsets_lock;
static QLIST_HEAD(, MonFdset) mon_fdsets;
-static int mon_refcount;
+int mon_refcount;
static HMPCommand hmp_cmds[];
static HMPCommand hmp_info_cmds[];
-QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
-
__thread Monitor *cur_mon;
static void monitor_command_cb(void *opaque, const char *cmdline,
void *readline_opaque);
-/**
- * Is @mon a QMP monitor?
- */
-static inline bool monitor_is_qmp(const Monitor *mon)
-{
- return (mon->flags & MONITOR_USE_CONTROL);
-}
-
/**
* Is @mon is using readline?
* Note: not all HMP monitors use readline, e.g., gdbserver has a
@@ -241,28 +215,6 @@ int monitor_read_password(MonitorHMP *mon, ReadLineFunc *readline_func,
}
}
-static void qmp_request_free(QMPRequest *req)
-{
- qobject_unref(req->req);
- error_free(req->err);
- g_free(req);
-}
-
-/* Caller must hold mon->qmp.qmp_queue_lock */
-static void monitor_qmp_cleanup_req_queue_locked(MonitorQMP *mon)
-{
- while (!g_queue_is_empty(mon->qmp_requests)) {
- qmp_request_free(g_queue_pop_head(mon->qmp_requests));
- }
-}
-
-static void monitor_qmp_cleanup_queues(MonitorQMP *mon)
-{
- qemu_mutex_lock(&mon->qmp_queue_lock);
- monitor_qmp_cleanup_req_queue_locked(mon);
- qemu_mutex_unlock(&mon->qmp_queue_lock);
-}
-
static void monitor_flush_locked(Monitor *mon);
@@ -322,7 +274,7 @@ void monitor_flush(Monitor *mon)
}
/* flush at every end of line */
-static int monitor_puts(Monitor *mon, const char *str)
+int monitor_puts(Monitor *mon, const char *str)
{
int i;
char c;
@@ -372,21 +324,6 @@ int monitor_printf(Monitor *mon, const char *fmt, ...)
return ret;
}
-static void qmp_send_response(MonitorQMP *mon, const QDict *rsp)
-{
- const QObject *data = QOBJECT(rsp);
- QString *json;
-
- json = mon->common.flags & MONITOR_USE_PRETTY ?
- qobject_to_json_pretty(data) : qobject_to_json(data);
- assert(json != NULL);
-
- qstring_append_chr(json, '\n');
- monitor_puts(&mon->common, qstring_get_str(json));
-
- qobject_unref(json);
-}
-
static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
/* Limit guest-triggerable events to 1 per second */
[QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
@@ -601,8 +538,8 @@ static void handle_hmp_command(MonitorHMP *mon, const char *cmdline);
static void monitor_iothread_init(void);
-static void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
- bool use_io_thread)
+void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
+ bool use_io_thread)
{
if (use_io_thread && !mon_iothread) {
monitor_iothread_init();
@@ -614,14 +551,6 @@ static void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
mon->flags = flags;
}
-static void monitor_data_destroy_qmp(MonitorQMP *mon)
-{
- json_message_parser_destroy(&mon->parser);
- qemu_mutex_destroy(&mon->qmp_queue_lock);
- monitor_qmp_cleanup_req_queue_locked(mon);
- g_queue_free(mon->qmp_requests);
-}
-
static void monitor_data_destroy(Monitor *mon)
{
g_free(mon->mon_cpu_path);
@@ -1058,18 +987,6 @@ static void monitor_init_qmp_commands(void)
qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
}
-static bool qmp_oob_enabled(MonitorQMP *mon)
-{
- return mon->capab[QMP_CAPABILITY_OOB];
-}
-
-static void monitor_qmp_caps_reset(MonitorQMP *mon)
-{
- memset(mon->capab_offered, 0, sizeof(mon->capab_offered));
- memset(mon->capab, 0, sizeof(mon->capab));
- mon->capab_offered[QMP_CAPABILITY_OOB] = mon->common.use_io_thread;
-}
-
/*
* Accept QMP capabilities in @list for @mon.
* On success, set mon->qmp.capab[], and return true.
@@ -2245,7 +2162,7 @@ static void monitor_fdset_cleanup(MonFdset *mon_fdset)
}
}
-static void monitor_fdsets_cleanup(void)
+void monitor_fdsets_cleanup(void)
{
MonFdset *mon_fdset;
MonFdset *mon_fdset_next;
@@ -4023,209 +3940,13 @@ cleanup:
free_cmdline_args(args, nb_args);
}
-static int monitor_can_read(void *opaque)
+int monitor_can_read(void *opaque)
{
Monitor *mon = opaque;
return !atomic_mb_read(&mon->suspend_cnt);
}
-/*
- * Emit QMP response @rsp with ID @id to @mon.
- * Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
- * Nothing is emitted then.
- */
-static void monitor_qmp_respond(MonitorQMP *mon, QDict *rsp)
-{
- if (rsp) {
- qmp_send_response(mon, rsp);
- }
-}
-
-static void monitor_qmp_dispatch(MonitorQMP *mon, QObject *req)
-{
- Monitor *old_mon;
- QDict *rsp;
- QDict *error;
-
- old_mon = cur_mon;
- cur_mon = &mon->common;
-
- rsp = qmp_dispatch(mon->commands, req, qmp_oob_enabled(mon));
-
- cur_mon = old_mon;
-
- if (mon->commands == &qmp_cap_negotiation_commands) {
- error = qdict_get_qdict(rsp, "error");
- if (error
- && !g_strcmp0(qdict_get_try_str(error, "class"),
- QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
- /* Provide a more useful error message */
- qdict_del(error, "desc");
- qdict_put_str(error, "desc", "Expecting capabilities negotiation"
- " with 'qmp_capabilities'");
- }
- }
-
- monitor_qmp_respond(mon, rsp);
- qobject_unref(rsp);
-}
-
-/*
- * Pop a QMP request from a monitor request queue.
- * Return the request, or NULL all request queues are empty.
- * We are using round-robin fashion to pop the request, to avoid
- * processing commands only on a very busy monitor. To achieve that,
- * when we process one request on a specific monitor, we put that
- * monitor to the end of mon_list queue.
- *
- * Note: if the function returned with non-NULL, then the caller will
- * be with qmp_mon->qmp_queue_lock held, and the caller is responsible
- * to release it.
- */
-static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void)
-{
- QMPRequest *req_obj = NULL;
- Monitor *mon;
- MonitorQMP *qmp_mon;
-
- qemu_mutex_lock(&monitor_lock);
-
- QTAILQ_FOREACH(mon, &mon_list, entry) {
- if (!monitor_is_qmp(mon)) {
- continue;
- }
-
- qmp_mon = container_of(mon, MonitorQMP, common);
- qemu_mutex_lock(&qmp_mon->qmp_queue_lock);
- req_obj = g_queue_pop_head(qmp_mon->qmp_requests);
- if (req_obj) {
- /* With the lock of corresponding queue held */
- break;
- }
- qemu_mutex_unlock(&qmp_mon->qmp_queue_lock);
- }
-
- if (req_obj) {
- /*
- * We found one request on the monitor. Degrade this monitor's
- * priority to lowest by re-inserting it to end of queue.
- */
- QTAILQ_REMOVE(&mon_list, mon, entry);
- QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
- }
-
- qemu_mutex_unlock(&monitor_lock);
-
- return req_obj;
-}
-
-static void monitor_qmp_bh_dispatcher(void *data)
-{
- QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock();
- QDict *rsp;
- bool need_resume;
- MonitorQMP *mon;
-
- if (!req_obj) {
- return;
- }
-
- mon = req_obj->mon;
- /* qmp_oob_enabled() might change after "qmp_capabilities" */
- need_resume = !qmp_oob_enabled(mon) ||
- mon->qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1;
- qemu_mutex_unlock(&mon->qmp_queue_lock);
- if (req_obj->req) {
- QDict *qdict = qobject_to(QDict, req_obj->req);
- QObject *id = qdict ? qdict_get(qdict, "id") : NULL;
- trace_monitor_qmp_cmd_in_band(qobject_get_try_str(id) ?: "");
- monitor_qmp_dispatch(mon, req_obj->req);
- } else {
- assert(req_obj->err);
- rsp = qmp_error_response(req_obj->err);
- req_obj->err = NULL;
- monitor_qmp_respond(mon, rsp);
- qobject_unref(rsp);
- }
-
- if (need_resume) {
- /* Pairs with the monitor_suspend() in handle_qmp_command() */
- monitor_resume(&mon->common);
- }
- qmp_request_free(req_obj);
-
- /* Reschedule instead of looping so the main loop stays responsive */
- qemu_bh_schedule(qmp_dispatcher_bh);
-}
-
-static void handle_qmp_command(void *opaque, QObject *req, Error *err)
-{
- MonitorQMP *mon = opaque;
- QObject *id = NULL;
- QDict *qdict;
- QMPRequest *req_obj;
-
- assert(!req != !err);
-
- qdict = qobject_to(QDict, req);
- if (qdict) {
- id = qdict_get(qdict, "id");
- } /* else will fail qmp_dispatch() */
-
- if (req && trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
- QString *req_json = qobject_to_json(req);
- trace_handle_qmp_command(mon, qstring_get_str(req_json));
- qobject_unref(req_json);
- }
-
- if (qdict && qmp_is_oob(qdict)) {
- /* OOB commands are executed immediately */
- trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id) ?: "");
- monitor_qmp_dispatch(mon, req);
- qobject_unref(req);
- return;
- }
-
- req_obj = g_new0(QMPRequest, 1);
- req_obj->mon = mon;
- req_obj->req = req;
- req_obj->err = err;
-
- /* Protect qmp_requests and fetching its length. */
- qemu_mutex_lock(&mon->qmp_queue_lock);
-
- /*
- * Suspend the monitor when we can't queue more requests after
- * this one. Dequeuing in monitor_qmp_bh_dispatcher() will resume
- * it. Note that when OOB is disabled, we queue at most one
- * command, for backward compatibility.
- */
- if (!qmp_oob_enabled(mon) ||
- mon->qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1) {
- monitor_suspend(&mon->common);
- }
-
- /*
- * Put the request to the end of queue so that requests will be
- * handled in time order. Ownership for req_obj, req,
- * etc. will be delivered to the handler side.
- */
- assert(mon->qmp_requests->length < QMP_REQ_QUEUE_LEN_MAX);
- g_queue_push_tail(mon->qmp_requests, req_obj);
- qemu_mutex_unlock(&mon->qmp_queue_lock);
-
- /* Kick the dispatcher routine */
- qemu_bh_schedule(qmp_dispatcher_bh);
-}
-
-static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
-{
- MonitorQMP *mon = opaque;
-
- json_message_parser_feed(&mon->parser, (const char *) buf, size);
-}
-
static void monitor_read(void *opaque, const uint8_t *buf, int size)
{
MonitorHMP *mon;
@@ -4312,56 +4033,6 @@ void monitor_resume(Monitor *mon)
trace_monitor_suspend(mon, -1);
}
-static QDict *qmp_greeting(MonitorQMP *mon)
-{
- QList *cap_list = qlist_new();
- QObject *ver = NULL;
- QMPCapability cap;
-
- qmp_marshal_query_version(NULL, &ver, NULL);
-
- for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
- if (mon->capab_offered[cap]) {
- qlist_append_str(cap_list, QMPCapability_str(cap));
- }
- }
-
- return qdict_from_jsonf_nofail(
- "{'QMP': {'version': %p, 'capabilities': %p}}",
- ver, cap_list);
-}
-
-static void monitor_qmp_event(void *opaque, int event)
-{
- QDict *data;
- MonitorQMP *mon = opaque;
-
- switch (event) {
- case CHR_EVENT_OPENED:
- mon->commands = &qmp_cap_negotiation_commands;
- monitor_qmp_caps_reset(mon);
- data = qmp_greeting(mon);
- qmp_send_response(mon, data);
- qobject_unref(data);
- mon_refcount++;
- break;
- case CHR_EVENT_CLOSED:
- /*
- * Note: this is only useful when the output of the chardev
- * backend is still open. For example, when the backend is
- * stdio, it's possible that stdout is still open when stdin
- * is closed.
- */
- monitor_qmp_cleanup_queues(mon);
- json_message_parser_destroy(&mon->parser);
- json_message_parser_init(&mon->parser, handle_qmp_command,
- mon, NULL);
- mon_refcount--;
- monitor_fdsets_cleanup();
- break;
- }
-}
-
static void monitor_event(void *opaque, int event)
{
Monitor *mon = opaque;
@@ -4495,7 +4166,7 @@ int error_vprintf_unless_qmp(const char *fmt, va_list ap)
return -1;
}
-static void monitor_list_append(Monitor *mon)
+void monitor_list_append(Monitor *mon)
{
qemu_mutex_lock(&monitor_lock);
/*
@@ -4515,60 +4186,6 @@ static void monitor_list_append(Monitor *mon)
}
}
-static void monitor_qmp_setup_handlers_bh(void *opaque)
-{
- MonitorQMP *mon = opaque;
- GMainContext *context;
-
- assert(mon->common.use_io_thread);
- context = iothread_get_g_main_context(mon_iothread);
- assert(context);
- qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read,
- monitor_qmp_read, monitor_qmp_event,
- NULL, &mon->common, context, true);
- monitor_list_append(&mon->common);
-}
-
-static void monitor_init_qmp(Chardev *chr, int flags)
-{
- MonitorQMP *mon = g_new0(MonitorQMP, 1);
-
- /* Only HMP supports readline */
- assert(!(flags & MONITOR_USE_READLINE));
-
- /* Note: we run QMP monitor in I/O thread when @chr supports that */
- monitor_data_init(&mon->common, flags, false,
- qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT));
-
- qemu_mutex_init(&mon->qmp_queue_lock);
- mon->qmp_requests = g_queue_new();
-
- qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
- qemu_chr_fe_set_echo(&mon->common.chr, true);
-
- json_message_parser_init(&mon->parser, handle_qmp_command, mon, NULL);
- if (mon->common.use_io_thread) {
- /*
- * Make sure the old iowatch is gone. It's possible when
- * e.g. the chardev is in client mode, with wait=on.
- */
- remove_fd_in_watch(chr);
- /*
- * We can't call qemu_chr_fe_set_handlers() directly here
- * since chardev might be running in the monitor I/O
- * thread. Schedule a bottom half.
- */
- aio_bh_schedule_oneshot(iothread_get_aio_context(mon_iothread),
- monitor_qmp_setup_handlers_bh, mon);
- /* The bottom half will add @mon to @mon_list */
- } else {
- qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read,
- monitor_qmp_read, monitor_qmp_event,
- NULL, &mon->common, NULL, true);
- monitor_list_append(&mon->common);
- }
-}
-
static void monitor_init_hmp(Chardev *chr, int flags)
{
MonitorHMP *mon = g_new0(MonitorHMP, 1);
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index ebaf0201c8..d859bd3894 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -31,6 +31,7 @@
#include "qapi/qmp/dispatch.h"
#include "qapi/qmp/json-parser.h"
#include "qemu/readline.h"
+#include "sysemu/iothread.h"
/*
* Supported types:
@@ -142,4 +143,33 @@ typedef struct {
GQueue *qmp_requests;
} MonitorQMP;
+/**
+ * Is @mon a QMP monitor?
+ */
+static inline bool monitor_is_qmp(const Monitor *mon)
+{
+ return mon->flags & MONITOR_USE_CONTROL;
+}
+
+typedef QTAILQ_HEAD(MonitorList, Monitor) MonitorList;
+extern IOThread *mon_iothread;
+extern QEMUBH *qmp_dispatcher_bh;
+extern QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
+extern QemuMutex monitor_lock;
+extern MonitorList mon_list;
+extern int mon_refcount;
+
+void monitor_init_qmp(Chardev *chr, int flags);
+
+int monitor_puts(Monitor *mon, const char *str);
+void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
+ bool use_io_thread);
+int monitor_can_read(void *opaque);
+void monitor_list_append(Monitor *mon);
+void monitor_fdsets_cleanup(void);
+
+void qmp_send_response(MonitorQMP *mon, const QDict *rsp);
+void monitor_data_destroy_qmp(MonitorQMP *mon);
+void monitor_qmp_bh_dispatcher(void *data);
+
#endif
diff --git a/monitor/qmp.c b/monitor/qmp.c
new file mode 100644
index 0000000000..7c3d081a72
--- /dev/null
+++ b/monitor/qmp.c
@@ -0,0 +1,406 @@
+/*
+ * QEMU monitor
+ *
+ * Copyright (c) 2003-2004 Fabrice Bellard
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "qemu/osdep.h"
+
+#include "chardev/char-io.h"
+#include "monitor-internal.h"
+#include "qapi/error.h"
+#include "qapi/qapi-commands-misc.h"
+#include "qapi/qmp/qdict.h"
+#include "qapi/qmp/qjson.h"
+#include "qapi/qmp/qlist.h"
+#include "qapi/qmp/qstring.h"
+#include "trace.h"
+
+struct QMPRequest {
+ /* Owner of the request */
+ MonitorQMP *mon;
+ /*
+ * Request object to be handled or Error to be reported
+ * (exactly one of them is non-null)
+ */
+ QObject *req;
+ Error *err;
+};
+typedef struct QMPRequest QMPRequest;
+
+QmpCommandList qmp_commands, qmp_cap_negotiation_commands;
+
+static bool qmp_oob_enabled(MonitorQMP *mon)
+{
+ return mon->capab[QMP_CAPABILITY_OOB];
+}
+
+static void monitor_qmp_caps_reset(MonitorQMP *mon)
+{
+ memset(mon->capab_offered, 0, sizeof(mon->capab_offered));
+ memset(mon->capab, 0, sizeof(mon->capab));
+ mon->capab_offered[QMP_CAPABILITY_OOB] = mon->common.use_io_thread;
+}
+
+static void qmp_request_free(QMPRequest *req)
+{
+ qobject_unref(req->req);
+ error_free(req->err);
+ g_free(req);
+}
+
+/* Caller must hold mon->qmp.qmp_queue_lock */
+static void monitor_qmp_cleanup_req_queue_locked(MonitorQMP *mon)
+{
+ while (!g_queue_is_empty(mon->qmp_requests)) {
+ qmp_request_free(g_queue_pop_head(mon->qmp_requests));
+ }
+}
+
+static void monitor_qmp_cleanup_queues(MonitorQMP *mon)
+{
+ qemu_mutex_lock(&mon->qmp_queue_lock);
+ monitor_qmp_cleanup_req_queue_locked(mon);
+ qemu_mutex_unlock(&mon->qmp_queue_lock);
+}
+
+void qmp_send_response(MonitorQMP *mon, const QDict *rsp)
+{
+ const QObject *data = QOBJECT(rsp);
+ QString *json;
+
+ json = mon->common.flags & MONITOR_USE_PRETTY ?
+ qobject_to_json_pretty(data) : qobject_to_json(data);
+ assert(json != NULL);
+
+ qstring_append_chr(json, '\n');
+ monitor_puts(&mon->common, qstring_get_str(json));
+
+ qobject_unref(json);
+}
+
+/*
+ * Emit QMP response @rsp with ID @id to @mon.
+ * Null @rsp can only happen for commands with QCO_NO_SUCCESS_RESP.
+ * Nothing is emitted then.
+ */
+static void monitor_qmp_respond(MonitorQMP *mon, QDict *rsp)
+{
+ if (rsp) {
+ qmp_send_response(mon, rsp);
+ }
+}
+
+static void monitor_qmp_dispatch(MonitorQMP *mon, QObject *req)
+{
+ Monitor *old_mon;
+ QDict *rsp;
+ QDict *error;
+
+ old_mon = cur_mon;
+ cur_mon = &mon->common;
+
+ rsp = qmp_dispatch(mon->commands, req, qmp_oob_enabled(mon));
+
+ cur_mon = old_mon;
+
+ if (mon->commands == &qmp_cap_negotiation_commands) {
+ error = qdict_get_qdict(rsp, "error");
+ if (error
+ && !g_strcmp0(qdict_get_try_str(error, "class"),
+ QapiErrorClass_str(ERROR_CLASS_COMMAND_NOT_FOUND))) {
+ /* Provide a more useful error message */
+ qdict_del(error, "desc");
+ qdict_put_str(error, "desc", "Expecting capabilities negotiation"
+ " with 'qmp_capabilities'");
+ }
+ }
+
+ monitor_qmp_respond(mon, rsp);
+ qobject_unref(rsp);
+}
+
+/*
+ * Pop a QMP request from a monitor request queue.
+ * Return the request, or NULL all request queues are empty.
+ * We are using round-robin fashion to pop the request, to avoid
+ * processing commands only on a very busy monitor. To achieve that,
+ * when we process one request on a specific monitor, we put that
+ * monitor to the end of mon_list queue.
+ *
+ * Note: if the function returned with non-NULL, then the caller will
+ * be with qmp_mon->qmp_queue_lock held, and the caller is responsible
+ * to release it.
+ */
+static QMPRequest *monitor_qmp_requests_pop_any_with_lock(void)
+{
+ QMPRequest *req_obj = NULL;
+ Monitor *mon;
+ MonitorQMP *qmp_mon;
+
+ qemu_mutex_lock(&monitor_lock);
+
+ QTAILQ_FOREACH(mon, &mon_list, entry) {
+ if (!monitor_is_qmp(mon)) {
+ continue;
+ }
+
+ qmp_mon = container_of(mon, MonitorQMP, common);
+ qemu_mutex_lock(&qmp_mon->qmp_queue_lock);
+ req_obj = g_queue_pop_head(qmp_mon->qmp_requests);
+ if (req_obj) {
+ /* With the lock of corresponding queue held */
+ break;
+ }
+ qemu_mutex_unlock(&qmp_mon->qmp_queue_lock);
+ }
+
+ if (req_obj) {
+ /*
+ * We found one request on the monitor. Degrade this monitor's
+ * priority to lowest by re-inserting it to end of queue.
+ */
+ QTAILQ_REMOVE(&mon_list, mon, entry);
+ QTAILQ_INSERT_TAIL(&mon_list, mon, entry);
+ }
+
+ qemu_mutex_unlock(&monitor_lock);
+
+ return req_obj;
+}
+
+void monitor_qmp_bh_dispatcher(void *data)
+{
+ QMPRequest *req_obj = monitor_qmp_requests_pop_any_with_lock();
+ QDict *rsp;
+ bool need_resume;
+ MonitorQMP *mon;
+
+ if (!req_obj) {
+ return;
+ }
+
+ mon = req_obj->mon;
+ /* qmp_oob_enabled() might change after "qmp_capabilities" */
+ need_resume = !qmp_oob_enabled(mon) ||
+ mon->qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1;
+ qemu_mutex_unlock(&mon->qmp_queue_lock);
+ if (req_obj->req) {
+ QDict *qdict = qobject_to(QDict, req_obj->req);
+ QObject *id = qdict ? qdict_get(qdict, "id") : NULL;
+ trace_monitor_qmp_cmd_in_band(qobject_get_try_str(id) ?: "");
+ monitor_qmp_dispatch(mon, req_obj->req);
+ } else {
+ assert(req_obj->err);
+ rsp = qmp_error_response(req_obj->err);
+ req_obj->err = NULL;
+ monitor_qmp_respond(mon, rsp);
+ qobject_unref(rsp);
+ }
+
+ if (need_resume) {
+ /* Pairs with the monitor_suspend() in handle_qmp_command() */
+ monitor_resume(&mon->common);
+ }
+ qmp_request_free(req_obj);
+
+ /* Reschedule instead of looping so the main loop stays responsive */
+ qemu_bh_schedule(qmp_dispatcher_bh);
+}
+
+static void handle_qmp_command(void *opaque, QObject *req, Error *err)
+{
+ MonitorQMP *mon = opaque;
+ QObject *id = NULL;
+ QDict *qdict;
+ QMPRequest *req_obj;
+
+ assert(!req != !err);
+
+ qdict = qobject_to(QDict, req);
+ if (qdict) {
+ id = qdict_get(qdict, "id");
+ } /* else will fail qmp_dispatch() */
+
+ if (req && trace_event_get_state_backends(TRACE_HANDLE_QMP_COMMAND)) {
+ QString *req_json = qobject_to_json(req);
+ trace_handle_qmp_command(mon, qstring_get_str(req_json));
+ qobject_unref(req_json);
+ }
+
+ if (qdict && qmp_is_oob(qdict)) {
+ /* OOB commands are executed immediately */
+ trace_monitor_qmp_cmd_out_of_band(qobject_get_try_str(id) ?: "");
+ monitor_qmp_dispatch(mon, req);
+ qobject_unref(req);
+ return;
+ }
+
+ req_obj = g_new0(QMPRequest, 1);
+ req_obj->mon = mon;
+ req_obj->req = req;
+ req_obj->err = err;
+
+ /* Protect qmp_requests and fetching its length. */
+ qemu_mutex_lock(&mon->qmp_queue_lock);
+
+ /*
+ * Suspend the monitor when we can't queue more requests after
+ * this one. Dequeuing in monitor_qmp_bh_dispatcher() will resume
+ * it. Note that when OOB is disabled, we queue at most one
+ * command, for backward compatibility.
+ */
+ if (!qmp_oob_enabled(mon) ||
+ mon->qmp_requests->length == QMP_REQ_QUEUE_LEN_MAX - 1) {
+ monitor_suspend(&mon->common);
+ }
+
+ /*
+ * Put the request to the end of queue so that requests will be
+ * handled in time order. Ownership for req_obj, req,
+ * etc. will be delivered to the handler side.
+ */
+ assert(mon->qmp_requests->length < QMP_REQ_QUEUE_LEN_MAX);
+ g_queue_push_tail(mon->qmp_requests, req_obj);
+ qemu_mutex_unlock(&mon->qmp_queue_lock);
+
+ /* Kick the dispatcher routine */
+ qemu_bh_schedule(qmp_dispatcher_bh);
+}
+
+static void monitor_qmp_read(void *opaque, const uint8_t *buf, int size)
+{
+ MonitorQMP *mon = opaque;
+
+ json_message_parser_feed(&mon->parser, (const char *) buf, size);
+}
+
+static QDict *qmp_greeting(MonitorQMP *mon)
+{
+ QList *cap_list = qlist_new();
+ QObject *ver = NULL;
+ QMPCapability cap;
+
+ qmp_marshal_query_version(NULL, &ver, NULL);
+
+ for (cap = 0; cap < QMP_CAPABILITY__MAX; cap++) {
+ if (mon->capab_offered[cap]) {
+ qlist_append_str(cap_list, QMPCapability_str(cap));
+ }
+ }
+
+ return qdict_from_jsonf_nofail(
+ "{'QMP': {'version': %p, 'capabilities': %p}}",
+ ver, cap_list);
+}
+
+static void monitor_qmp_event(void *opaque, int event)
+{
+ QDict *data;
+ MonitorQMP *mon = opaque;
+
+ switch (event) {
+ case CHR_EVENT_OPENED:
+ mon->commands = &qmp_cap_negotiation_commands;
+ monitor_qmp_caps_reset(mon);
+ data = qmp_greeting(mon);
+ qmp_send_response(mon, data);
+ qobject_unref(data);
+ mon_refcount++;
+ break;
+ case CHR_EVENT_CLOSED:
+ /*
+ * Note: this is only useful when the output of the chardev
+ * backend is still open. For example, when the backend is
+ * stdio, it's possible that stdout is still open when stdin
+ * is closed.
+ */
+ monitor_qmp_cleanup_queues(mon);
+ json_message_parser_destroy(&mon->parser);
+ json_message_parser_init(&mon->parser, handle_qmp_command,
+ mon, NULL);
+ mon_refcount--;
+ monitor_fdsets_cleanup();
+ break;
+ }
+}
+
+void monitor_data_destroy_qmp(MonitorQMP *mon)
+{
+ json_message_parser_destroy(&mon->parser);
+ qemu_mutex_destroy(&mon->qmp_queue_lock);
+ monitor_qmp_cleanup_req_queue_locked(mon);
+ g_queue_free(mon->qmp_requests);
+}
+
+static void monitor_qmp_setup_handlers_bh(void *opaque)
+{
+ MonitorQMP *mon = opaque;
+ GMainContext *context;
+
+ assert(mon->common.use_io_thread);
+ context = iothread_get_g_main_context(mon_iothread);
+ assert(context);
+ qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read,
+ monitor_qmp_read, monitor_qmp_event,
+ NULL, &mon->common, context, true);
+ monitor_list_append(&mon->common);
+}
+
+void monitor_init_qmp(Chardev *chr, int flags)
+{
+ MonitorQMP *mon = g_new0(MonitorQMP, 1);
+
+ /* Only HMP supports readline */
+ assert(!(flags & MONITOR_USE_READLINE));
+
+ /* Note: we run QMP monitor in I/O thread when @chr supports that */
+ monitor_data_init(&mon->common, flags, false,
+ qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT));
+
+ qemu_mutex_init(&mon->qmp_queue_lock);
+ mon->qmp_requests = g_queue_new();
+
+ qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
+ qemu_chr_fe_set_echo(&mon->common.chr, true);
+
+ json_message_parser_init(&mon->parser, handle_qmp_command, mon, NULL);
+ if (mon->common.use_io_thread) {
+ /*
+ * Make sure the old iowatch is gone. It's possible when
+ * e.g. the chardev is in client mode, with wait=on.
+ */
+ remove_fd_in_watch(chr);
+ /*
+ * We can't call qemu_chr_fe_set_handlers() directly here
+ * since chardev might be running in the monitor I/O
+ * thread. Schedule a bottom half.
+ */
+ aio_bh_schedule_oneshot(iothread_get_aio_context(mon_iothread),
+ monitor_qmp_setup_handlers_bh, mon);
+ /* The bottom half will add @mon to @mon_list */
+ } else {
+ qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read,
+ monitor_qmp_read, monitor_qmp_event,
+ NULL, &mon->common, NULL, true);
+ monitor_list_append(&mon->common);
+ }
+}
diff --git a/monitor/trace-events b/monitor/trace-events
index abfdf20b14..a06dde3fd3 100644
--- a/monitor/trace-events
+++ b/monitor/trace-events
@@ -5,7 +5,9 @@ monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
-handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
monitor_suspend(void *ptr, int cnt) "mon %p: %d"
+
+# qmp.c
monitor_qmp_cmd_in_band(const char *id) "%s"
monitor_qmp_cmd_out_of_band(const char *id) "%s"
+handle_qmp_command(void *mon, const char *req) "mon %p req: %s"
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 12/16] monitor: Split out monitor/hmp.c
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (10 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 11/16] monitor: Split out monitor/qmp.c Markus Armbruster
@ 2019-06-17 18:48 ` Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 13/16] monitor: Split out monitor/monitor.c Markus Armbruster
` (6 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:48 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
Move HMP infrastructure from monitor/misc.c to monitor/hmp.c. This is
code that can be shared for all targets, so compile it only once.
The amount of function and particularly extern variables in
monitor_int.h is probably a bit larger than it needs to be, but this way
no non-trivial code modifications are needed. The interfaces between HMP
and the monitor core can be cleaned up later.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-12-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Comment reformatted to make checkpatch.pl happy, superfluous #include
dropped]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
monitor/Makefile.objs | 2 +-
monitor/hmp.c | 1416 ++++++++++++++++++++++++++++++++++++
monitor/misc.c | 1368 +---------------------------------
monitor/monitor-internal.h | 8 +
monitor/trace-events | 4 +-
5 files changed, 1444 insertions(+), 1354 deletions(-)
create mode 100644 monitor/hmp.c
diff --git a/monitor/Makefile.objs b/monitor/Makefile.objs
index 1037c09ff8..bea8838acc 100644
--- a/monitor/Makefile.objs
+++ b/monitor/Makefile.objs
@@ -1,3 +1,3 @@
obj-y += misc.o
-common-obj-y += qmp.o
+common-obj-y += qmp.o hmp.o
common-obj-y += qmp-cmds.o hmp-cmds.o
diff --git a/monitor/hmp.c b/monitor/hmp.c
new file mode 100644
index 0000000000..86e86c1cf1
--- /dev/null
+++ b/monitor/hmp.c
@@ -0,0 +1,1416 @@
+/*
+ * QEMU monitor
+ *
+ * Copyright (c) 2003-2004 Fabrice Bellard
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "qemu/osdep.h"
+#include "monitor-internal.h"
+#include "qapi/error.h"
+#include "qapi/qmp/qdict.h"
+#include "qapi/qmp/qnum.h"
+#include "qemu/config-file.h"
+#include "qemu/ctype.h"
+#include "qemu/cutils.h"
+#include "qemu/log.h"
+#include "qemu/option.h"
+#include "qemu/units.h"
+#include "sysemu/block-backend.h"
+#include "sysemu/sysemu.h"
+#include "trace.h"
+
+static void monitor_command_cb(void *opaque, const char *cmdline,
+ void *readline_opaque)
+{
+ MonitorHMP *mon = opaque;
+
+ monitor_suspend(&mon->common);
+ handle_hmp_command(mon, cmdline);
+ monitor_resume(&mon->common);
+}
+
+void monitor_read_command(MonitorHMP *mon, int show_prompt)
+{
+ if (!mon->rs) {
+ return;
+ }
+
+ readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
+ if (show_prompt) {
+ readline_show_prompt(mon->rs);
+ }
+}
+
+int monitor_read_password(MonitorHMP *mon, ReadLineFunc *readline_func,
+ void *opaque)
+{
+ if (mon->rs) {
+ readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
+ /* prompt is printed on return from the command handler */
+ return 0;
+ } else {
+ monitor_printf(&mon->common,
+ "terminal does not support password prompting\n");
+ return -ENOTTY;
+ }
+}
+
+static int get_str(char *buf, int buf_size, const char **pp)
+{
+ const char *p;
+ char *q;
+ int c;
+
+ q = buf;
+ p = *pp;
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*p == '\0') {
+ fail:
+ *q = '\0';
+ *pp = p;
+ return -1;
+ }
+ if (*p == '\"') {
+ p++;
+ while (*p != '\0' && *p != '\"') {
+ if (*p == '\\') {
+ p++;
+ c = *p++;
+ switch (c) {
+ case 'n':
+ c = '\n';
+ break;
+ case 'r':
+ c = '\r';
+ break;
+ case '\\':
+ case '\'':
+ case '\"':
+ break;
+ default:
+ printf("unsupported escape code: '\\%c'\n", c);
+ goto fail;
+ }
+ if ((q - buf) < buf_size - 1) {
+ *q++ = c;
+ }
+ } else {
+ if ((q - buf) < buf_size - 1) {
+ *q++ = *p;
+ }
+ p++;
+ }
+ }
+ if (*p != '\"') {
+ printf("unterminated string\n");
+ goto fail;
+ }
+ p++;
+ } else {
+ while (*p != '\0' && !qemu_isspace(*p)) {
+ if ((q - buf) < buf_size - 1) {
+ *q++ = *p;
+ }
+ p++;
+ }
+ }
+ *q = '\0';
+ *pp = p;
+ return 0;
+}
+
+#define MAX_ARGS 16
+
+static void free_cmdline_args(char **args, int nb_args)
+{
+ int i;
+
+ assert(nb_args <= MAX_ARGS);
+
+ for (i = 0; i < nb_args; i++) {
+ g_free(args[i]);
+ }
+
+}
+
+/*
+ * Parse the command line to get valid args.
+ * @cmdline: command line to be parsed.
+ * @pnb_args: location to store the number of args, must NOT be NULL.
+ * @args: location to store the args, which should be freed by caller, must
+ * NOT be NULL.
+ *
+ * Returns 0 on success, negative on failure.
+ *
+ * NOTE: this parser is an approximate form of the real command parser. Number
+ * of args have a limit of MAX_ARGS. If cmdline contains more, it will
+ * return with failure.
+ */
+static int parse_cmdline(const char *cmdline,
+ int *pnb_args, char **args)
+{
+ const char *p;
+ int nb_args, ret;
+ char buf[1024];
+
+ p = cmdline;
+ nb_args = 0;
+ for (;;) {
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*p == '\0') {
+ break;
+ }
+ if (nb_args >= MAX_ARGS) {
+ goto fail;
+ }
+ ret = get_str(buf, sizeof(buf), &p);
+ if (ret < 0) {
+ goto fail;
+ }
+ args[nb_args] = g_strdup(buf);
+ nb_args++;
+ }
+ *pnb_args = nb_args;
+ return 0;
+
+ fail:
+ free_cmdline_args(args, nb_args);
+ return -1;
+}
+
+/*
+ * Can command @cmd be executed in preconfig state?
+ */
+static bool cmd_can_preconfig(const HMPCommand *cmd)
+{
+ if (!cmd->flags) {
+ return false;
+ }
+
+ return strchr(cmd->flags, 'p');
+}
+
+static void help_cmd_dump_one(Monitor *mon,
+ const HMPCommand *cmd,
+ char **prefix_args,
+ int prefix_args_nb)
+{
+ int i;
+
+ if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
+ return;
+ }
+
+ for (i = 0; i < prefix_args_nb; i++) {
+ monitor_printf(mon, "%s ", prefix_args[i]);
+ }
+ monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
+}
+
+/* @args[@arg_index] is the valid command need to find in @cmds */
+static void help_cmd_dump(Monitor *mon, const HMPCommand *cmds,
+ char **args, int nb_args, int arg_index)
+{
+ const HMPCommand *cmd;
+ size_t i;
+
+ /* No valid arg need to compare with, dump all in *cmds */
+ if (arg_index >= nb_args) {
+ for (cmd = cmds; cmd->name != NULL; cmd++) {
+ help_cmd_dump_one(mon, cmd, args, arg_index);
+ }
+ return;
+ }
+
+ /* Find one entry to dump */
+ for (cmd = cmds; cmd->name != NULL; cmd++) {
+ if (hmp_compare_cmd(args[arg_index], cmd->name) &&
+ ((!runstate_check(RUN_STATE_PRECONFIG) ||
+ cmd_can_preconfig(cmd)))) {
+ if (cmd->sub_table) {
+ /* continue with next arg */
+ help_cmd_dump(mon, cmd->sub_table,
+ args, nb_args, arg_index + 1);
+ } else {
+ help_cmd_dump_one(mon, cmd, args, arg_index);
+ }
+ return;
+ }
+ }
+
+ /* Command not found */
+ monitor_printf(mon, "unknown command: '");
+ for (i = 0; i <= arg_index; i++) {
+ monitor_printf(mon, "%s%s", args[i], i == arg_index ? "'\n" : " ");
+ }
+}
+
+void help_cmd(Monitor *mon, const char *name)
+{
+ char *args[MAX_ARGS];
+ int nb_args = 0;
+
+ /* 1. parse user input */
+ if (name) {
+ /* special case for log, directly dump and return */
+ if (!strcmp(name, "log")) {
+ const QEMULogItem *item;
+ monitor_printf(mon, "Log items (comma separated):\n");
+ monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
+ for (item = qemu_log_items; item->mask != 0; item++) {
+ monitor_printf(mon, "%-10s %s\n", item->name, item->help);
+ }
+ return;
+ }
+
+ if (parse_cmdline(name, &nb_args, args) < 0) {
+ return;
+ }
+ }
+
+ /* 2. dump the contents according to parsed args */
+ help_cmd_dump(mon, hmp_cmds, args, nb_args, 0);
+
+ free_cmdline_args(args, nb_args);
+}
+
+/*******************************************************************/
+
+static const char *pch;
+static sigjmp_buf expr_env;
+
+static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
+expr_error(Monitor *mon, const char *fmt, ...)
+{
+ va_list ap;
+ va_start(ap, fmt);
+ monitor_vprintf(mon, fmt, ap);
+ monitor_printf(mon, "\n");
+ va_end(ap);
+ siglongjmp(expr_env, 1);
+}
+
+static void next(void)
+{
+ if (*pch != '\0') {
+ pch++;
+ while (qemu_isspace(*pch)) {
+ pch++;
+ }
+ }
+}
+
+static int64_t expr_sum(Monitor *mon);
+
+static int64_t expr_unary(Monitor *mon)
+{
+ int64_t n;
+ char *p;
+ int ret;
+
+ switch (*pch) {
+ case '+':
+ next();
+ n = expr_unary(mon);
+ break;
+ case '-':
+ next();
+ n = -expr_unary(mon);
+ break;
+ case '~':
+ next();
+ n = ~expr_unary(mon);
+ break;
+ case '(':
+ next();
+ n = expr_sum(mon);
+ if (*pch != ')') {
+ expr_error(mon, "')' expected");
+ }
+ next();
+ break;
+ case '\'':
+ pch++;
+ if (*pch == '\0') {
+ expr_error(mon, "character constant expected");
+ }
+ n = *pch;
+ pch++;
+ if (*pch != '\'') {
+ expr_error(mon, "missing terminating \' character");
+ }
+ next();
+ break;
+ case '$':
+ {
+ char buf[128], *q;
+ int64_t reg = 0;
+
+ pch++;
+ q = buf;
+ while ((*pch >= 'a' && *pch <= 'z') ||
+ (*pch >= 'A' && *pch <= 'Z') ||
+ (*pch >= '0' && *pch <= '9') ||
+ *pch == '_' || *pch == '.') {
+ if ((q - buf) < sizeof(buf) - 1) {
+ *q++ = *pch;
+ }
+ pch++;
+ }
+ while (qemu_isspace(*pch)) {
+ pch++;
+ }
+ *q = 0;
+ ret = get_monitor_def(®, buf);
+ if (ret < 0) {
+ expr_error(mon, "unknown register");
+ }
+ n = reg;
+ }
+ break;
+ case '\0':
+ expr_error(mon, "unexpected end of expression");
+ n = 0;
+ break;
+ default:
+ errno = 0;
+ n = strtoull(pch, &p, 0);
+ if (errno == ERANGE) {
+ expr_error(mon, "number too large");
+ }
+ if (pch == p) {
+ expr_error(mon, "invalid char '%c' in expression", *p);
+ }
+ pch = p;
+ while (qemu_isspace(*pch)) {
+ pch++;
+ }
+ break;
+ }
+ return n;
+}
+
+static int64_t expr_prod(Monitor *mon)
+{
+ int64_t val, val2;
+ int op;
+
+ val = expr_unary(mon);
+ for (;;) {
+ op = *pch;
+ if (op != '*' && op != '/' && op != '%') {
+ break;
+ }
+ next();
+ val2 = expr_unary(mon);
+ switch (op) {
+ default:
+ case '*':
+ val *= val2;
+ break;
+ case '/':
+ case '%':
+ if (val2 == 0) {
+ expr_error(mon, "division by zero");
+ }
+ if (op == '/') {
+ val /= val2;
+ } else {
+ val %= val2;
+ }
+ break;
+ }
+ }
+ return val;
+}
+
+static int64_t expr_logic(Monitor *mon)
+{
+ int64_t val, val2;
+ int op;
+
+ val = expr_prod(mon);
+ for (;;) {
+ op = *pch;
+ if (op != '&' && op != '|' && op != '^') {
+ break;
+ }
+ next();
+ val2 = expr_prod(mon);
+ switch (op) {
+ default:
+ case '&':
+ val &= val2;
+ break;
+ case '|':
+ val |= val2;
+ break;
+ case '^':
+ val ^= val2;
+ break;
+ }
+ }
+ return val;
+}
+
+static int64_t expr_sum(Monitor *mon)
+{
+ int64_t val, val2;
+ int op;
+
+ val = expr_logic(mon);
+ for (;;) {
+ op = *pch;
+ if (op != '+' && op != '-') {
+ break;
+ }
+ next();
+ val2 = expr_logic(mon);
+ if (op == '+') {
+ val += val2;
+ } else {
+ val -= val2;
+ }
+ }
+ return val;
+}
+
+static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
+{
+ pch = *pp;
+ if (sigsetjmp(expr_env, 0)) {
+ *pp = pch;
+ return -1;
+ }
+ while (qemu_isspace(*pch)) {
+ pch++;
+ }
+ *pval = expr_sum(mon);
+ *pp = pch;
+ return 0;
+}
+
+static int get_double(Monitor *mon, double *pval, const char **pp)
+{
+ const char *p = *pp;
+ char *tailp;
+ double d;
+
+ d = strtod(p, &tailp);
+ if (tailp == p) {
+ monitor_printf(mon, "Number expected\n");
+ return -1;
+ }
+ if (d != d || d - d != 0) {
+ /* NaN or infinity */
+ monitor_printf(mon, "Bad number\n");
+ return -1;
+ }
+ *pval = d;
+ *pp = tailp;
+ return 0;
+}
+
+/*
+ * Store the command-name in cmdname, and return a pointer to
+ * the remaining of the command string.
+ */
+static const char *get_command_name(const char *cmdline,
+ char *cmdname, size_t nlen)
+{
+ size_t len;
+ const char *p, *pstart;
+
+ p = cmdline;
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*p == '\0') {
+ return NULL;
+ }
+ pstart = p;
+ while (*p != '\0' && *p != '/' && !qemu_isspace(*p)) {
+ p++;
+ }
+ len = p - pstart;
+ if (len > nlen - 1) {
+ len = nlen - 1;
+ }
+ memcpy(cmdname, pstart, len);
+ cmdname[len] = '\0';
+ return p;
+}
+
+/**
+ * Read key of 'type' into 'key' and return the current
+ * 'type' pointer.
+ */
+static char *key_get_info(const char *type, char **key)
+{
+ size_t len;
+ char *p, *str;
+
+ if (*type == ',') {
+ type++;
+ }
+
+ p = strchr(type, ':');
+ if (!p) {
+ *key = NULL;
+ return NULL;
+ }
+ len = p - type;
+
+ str = g_malloc(len + 1);
+ memcpy(str, type, len);
+ str[len] = '\0';
+
+ *key = str;
+ return ++p;
+}
+
+static int default_fmt_format = 'x';
+static int default_fmt_size = 4;
+
+static int is_valid_option(const char *c, const char *typestr)
+{
+ char option[3];
+
+ option[0] = '-';
+ option[1] = *c;
+ option[2] = '\0';
+
+ typestr = strstr(typestr, option);
+ return (typestr != NULL);
+}
+
+static const HMPCommand *search_dispatch_table(const HMPCommand *disp_table,
+ const char *cmdname)
+{
+ const HMPCommand *cmd;
+
+ for (cmd = disp_table; cmd->name != NULL; cmd++) {
+ if (hmp_compare_cmd(cmdname, cmd->name)) {
+ return cmd;
+ }
+ }
+
+ return NULL;
+}
+
+/*
+ * Parse command name from @cmdp according to command table @table.
+ * If blank, return NULL.
+ * Else, if no valid command can be found, report to @mon, and return
+ * NULL.
+ * Else, change @cmdp to point right behind the name, and return its
+ * command table entry.
+ * Do not assume the return value points into @table! It doesn't when
+ * the command is found in a sub-command table.
+ */
+static const HMPCommand *monitor_parse_command(MonitorHMP *hmp_mon,
+ const char *cmdp_start,
+ const char **cmdp,
+ HMPCommand *table)
+{
+ Monitor *mon = &hmp_mon->common;
+ const char *p;
+ const HMPCommand *cmd;
+ char cmdname[256];
+
+ /* extract the command name */
+ p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
+ if (!p) {
+ return NULL;
+ }
+
+ cmd = search_dispatch_table(table, cmdname);
+ if (!cmd) {
+ monitor_printf(mon, "unknown command: '%.*s'\n",
+ (int)(p - cmdp_start), cmdp_start);
+ return NULL;
+ }
+ if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
+ monitor_printf(mon, "Command '%.*s' not available with -preconfig "
+ "until after exit_preconfig.\n",
+ (int)(p - cmdp_start), cmdp_start);
+ return NULL;
+ }
+
+ /* filter out following useless space */
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+
+ *cmdp = p;
+ /* search sub command */
+ if (cmd->sub_table != NULL && *p != '\0') {
+ return monitor_parse_command(hmp_mon, cmdp_start, cmdp, cmd->sub_table);
+ }
+
+ return cmd;
+}
+
+/*
+ * Parse arguments for @cmd.
+ * If it can't be parsed, report to @mon, and return NULL.
+ * Else, insert command arguments into a QDict, and return it.
+ * Note: On success, caller has to free the QDict structure.
+ */
+static QDict *monitor_parse_arguments(Monitor *mon,
+ const char **endp,
+ const HMPCommand *cmd)
+{
+ const char *typestr;
+ char *key;
+ int c;
+ const char *p = *endp;
+ char buf[1024];
+ QDict *qdict = qdict_new();
+
+ /* parse the parameters */
+ typestr = cmd->args_type;
+ for (;;) {
+ typestr = key_get_info(typestr, &key);
+ if (!typestr) {
+ break;
+ }
+ c = *typestr;
+ typestr++;
+ switch (c) {
+ case 'F':
+ case 'B':
+ case 's':
+ {
+ int ret;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*typestr == '?') {
+ typestr++;
+ if (*p == '\0') {
+ /* no optional string: NULL argument */
+ break;
+ }
+ }
+ ret = get_str(buf, sizeof(buf), &p);
+ if (ret < 0) {
+ switch (c) {
+ case 'F':
+ monitor_printf(mon, "%s: filename expected\n",
+ cmd->name);
+ break;
+ case 'B':
+ monitor_printf(mon, "%s: block device name expected\n",
+ cmd->name);
+ break;
+ default:
+ monitor_printf(mon, "%s: string expected\n", cmd->name);
+ break;
+ }
+ goto fail;
+ }
+ qdict_put_str(qdict, key, buf);
+ }
+ break;
+ case 'O':
+ {
+ QemuOptsList *opts_list;
+ QemuOpts *opts;
+
+ opts_list = qemu_find_opts(key);
+ if (!opts_list || opts_list->desc->name) {
+ goto bad_type;
+ }
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (!*p) {
+ break;
+ }
+ if (get_str(buf, sizeof(buf), &p) < 0) {
+ goto fail;
+ }
+ opts = qemu_opts_parse_noisily(opts_list, buf, true);
+ if (!opts) {
+ goto fail;
+ }
+ qemu_opts_to_qdict(opts, qdict);
+ qemu_opts_del(opts);
+ }
+ break;
+ case '/':
+ {
+ int count, format, size;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*p == '/') {
+ /* format found */
+ p++;
+ count = 1;
+ if (qemu_isdigit(*p)) {
+ count = 0;
+ while (qemu_isdigit(*p)) {
+ count = count * 10 + (*p - '0');
+ p++;
+ }
+ }
+ size = -1;
+ format = -1;
+ for (;;) {
+ switch (*p) {
+ case 'o':
+ case 'd':
+ case 'u':
+ case 'x':
+ case 'i':
+ case 'c':
+ format = *p++;
+ break;
+ case 'b':
+ size = 1;
+ p++;
+ break;
+ case 'h':
+ size = 2;
+ p++;
+ break;
+ case 'w':
+ size = 4;
+ p++;
+ break;
+ case 'g':
+ case 'L':
+ size = 8;
+ p++;
+ break;
+ default:
+ goto next;
+ }
+ }
+ next:
+ if (*p != '\0' && !qemu_isspace(*p)) {
+ monitor_printf(mon, "invalid char in format: '%c'\n",
+ *p);
+ goto fail;
+ }
+ if (format < 0) {
+ format = default_fmt_format;
+ }
+ if (format != 'i') {
+ /* for 'i', not specifying a size gives -1 as size */
+ if (size < 0) {
+ size = default_fmt_size;
+ }
+ default_fmt_size = size;
+ }
+ default_fmt_format = format;
+ } else {
+ count = 1;
+ format = default_fmt_format;
+ if (format != 'i') {
+ size = default_fmt_size;
+ } else {
+ size = -1;
+ }
+ }
+ qdict_put_int(qdict, "count", count);
+ qdict_put_int(qdict, "format", format);
+ qdict_put_int(qdict, "size", size);
+ }
+ break;
+ case 'i':
+ case 'l':
+ case 'M':
+ {
+ int64_t val;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*typestr == '?' || *typestr == '.') {
+ if (*typestr == '?') {
+ if (*p == '\0') {
+ typestr++;
+ break;
+ }
+ } else {
+ if (*p == '.') {
+ p++;
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ } else {
+ typestr++;
+ break;
+ }
+ }
+ typestr++;
+ }
+ if (get_expr(mon, &val, &p)) {
+ goto fail;
+ }
+ /* Check if 'i' is greater than 32-bit */
+ if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
+ monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
+ monitor_printf(mon, "integer is for 32-bit values\n");
+ goto fail;
+ } else if (c == 'M') {
+ if (val < 0) {
+ monitor_printf(mon, "enter a positive value\n");
+ goto fail;
+ }
+ val *= MiB;
+ }
+ qdict_put_int(qdict, key, val);
+ }
+ break;
+ case 'o':
+ {
+ int ret;
+ uint64_t val;
+ const char *end;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*typestr == '?') {
+ typestr++;
+ if (*p == '\0') {
+ break;
+ }
+ }
+ ret = qemu_strtosz_MiB(p, &end, &val);
+ if (ret < 0 || val > INT64_MAX) {
+ monitor_printf(mon, "invalid size\n");
+ goto fail;
+ }
+ qdict_put_int(qdict, key, val);
+ p = end;
+ }
+ break;
+ case 'T':
+ {
+ double val;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*typestr == '?') {
+ typestr++;
+ if (*p == '\0') {
+ break;
+ }
+ }
+ if (get_double(mon, &val, &p) < 0) {
+ goto fail;
+ }
+ if (p[0] && p[1] == 's') {
+ switch (*p) {
+ case 'm':
+ val /= 1e3; p += 2; break;
+ case 'u':
+ val /= 1e6; p += 2; break;
+ case 'n':
+ val /= 1e9; p += 2; break;
+ }
+ }
+ if (*p && !qemu_isspace(*p)) {
+ monitor_printf(mon, "Unknown unit suffix\n");
+ goto fail;
+ }
+ qdict_put(qdict, key, qnum_from_double(val));
+ }
+ break;
+ case 'b':
+ {
+ const char *beg;
+ bool val;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ beg = p;
+ while (qemu_isgraph(*p)) {
+ p++;
+ }
+ if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
+ val = true;
+ } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
+ val = false;
+ } else {
+ monitor_printf(mon, "Expected 'on' or 'off'\n");
+ goto fail;
+ }
+ qdict_put_bool(qdict, key, val);
+ }
+ break;
+ case '-':
+ {
+ const char *tmp = p;
+ int skip_key = 0;
+ /* option */
+
+ c = *typestr++;
+ if (c == '\0') {
+ goto bad_type;
+ }
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*p == '-') {
+ p++;
+ if (c != *p) {
+ if (!is_valid_option(p, typestr)) {
+ monitor_printf(mon, "%s: unsupported option -%c\n",
+ cmd->name, *p);
+ goto fail;
+ } else {
+ skip_key = 1;
+ }
+ }
+ if (skip_key) {
+ p = tmp;
+ } else {
+ /* has option */
+ p++;
+ qdict_put_bool(qdict, key, true);
+ }
+ }
+ }
+ break;
+ case 'S':
+ {
+ /* package all remaining string */
+ int len;
+
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*typestr == '?') {
+ typestr++;
+ if (*p == '\0') {
+ /* no remaining string: NULL argument */
+ break;
+ }
+ }
+ len = strlen(p);
+ if (len <= 0) {
+ monitor_printf(mon, "%s: string expected\n",
+ cmd->name);
+ goto fail;
+ }
+ qdict_put_str(qdict, key, p);
+ p += len;
+ }
+ break;
+ default:
+ bad_type:
+ monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
+ goto fail;
+ }
+ g_free(key);
+ key = NULL;
+ }
+ /* check that all arguments were parsed */
+ while (qemu_isspace(*p)) {
+ p++;
+ }
+ if (*p != '\0') {
+ monitor_printf(mon, "%s: extraneous characters at the end of line\n",
+ cmd->name);
+ goto fail;
+ }
+
+ return qdict;
+
+fail:
+ qobject_unref(qdict);
+ g_free(key);
+ return NULL;
+}
+
+void handle_hmp_command(MonitorHMP *mon, const char *cmdline)
+{
+ QDict *qdict;
+ const HMPCommand *cmd;
+ const char *cmd_start = cmdline;
+
+ trace_handle_hmp_command(mon, cmdline);
+
+ cmd = monitor_parse_command(mon, cmdline, &cmdline, hmp_cmds);
+ if (!cmd) {
+ return;
+ }
+
+ qdict = monitor_parse_arguments(&mon->common, &cmdline, cmd);
+ if (!qdict) {
+ while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
+ cmdline--;
+ }
+ monitor_printf(&mon->common, "Try \"help %.*s\" for more information\n",
+ (int)(cmdline - cmd_start), cmd_start);
+ return;
+ }
+
+ cmd->cmd(&mon->common, qdict);
+ qobject_unref(qdict);
+}
+
+static void cmd_completion(MonitorHMP *mon, const char *name, const char *list)
+{
+ const char *p, *pstart;
+ char cmd[128];
+ int len;
+
+ p = list;
+ for (;;) {
+ pstart = p;
+ p = qemu_strchrnul(p, '|');
+ len = p - pstart;
+ if (len > sizeof(cmd) - 2) {
+ len = sizeof(cmd) - 2;
+ }
+ memcpy(cmd, pstart, len);
+ cmd[len] = '\0';
+ if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
+ readline_add_completion(mon->rs, cmd);
+ }
+ if (*p == '\0') {
+ break;
+ }
+ p++;
+ }
+}
+
+static void file_completion(MonitorHMP *mon, const char *input)
+{
+ DIR *ffs;
+ struct dirent *d;
+ char path[1024];
+ char file[1024], file_prefix[1024];
+ int input_path_len;
+ const char *p;
+
+ p = strrchr(input, '/');
+ if (!p) {
+ input_path_len = 0;
+ pstrcpy(file_prefix, sizeof(file_prefix), input);
+ pstrcpy(path, sizeof(path), ".");
+ } else {
+ input_path_len = p - input + 1;
+ memcpy(path, input, input_path_len);
+ if (input_path_len > sizeof(path) - 1) {
+ input_path_len = sizeof(path) - 1;
+ }
+ path[input_path_len] = '\0';
+ pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
+ }
+
+ ffs = opendir(path);
+ if (!ffs) {
+ return;
+ }
+ for (;;) {
+ struct stat sb;
+ d = readdir(ffs);
+ if (!d) {
+ break;
+ }
+
+ if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
+ continue;
+ }
+
+ if (strstart(d->d_name, file_prefix, NULL)) {
+ memcpy(file, input, input_path_len);
+ if (input_path_len < sizeof(file)) {
+ pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
+ d->d_name);
+ }
+ /*
+ * stat the file to find out if it's a directory.
+ * In that case add a slash to speed up typing long paths
+ */
+ if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
+ pstrcat(file, sizeof(file), "/");
+ }
+ readline_add_completion(mon->rs, file);
+ }
+ }
+ closedir(ffs);
+}
+
+static const char *next_arg_type(const char *typestr)
+{
+ const char *p = strchr(typestr, ':');
+ return (p != NULL ? ++p : typestr);
+}
+
+static void monitor_find_completion_by_table(MonitorHMP *mon,
+ const HMPCommand *cmd_table,
+ char **args,
+ int nb_args)
+{
+ const char *cmdname;
+ int i;
+ const char *ptype, *old_ptype, *str, *name;
+ const HMPCommand *cmd;
+ BlockBackend *blk = NULL;
+
+ if (nb_args <= 1) {
+ /* command completion */
+ if (nb_args == 0) {
+ cmdname = "";
+ } else {
+ cmdname = args[0];
+ }
+ readline_set_completion_index(mon->rs, strlen(cmdname));
+ for (cmd = cmd_table; cmd->name != NULL; cmd++) {
+ if (!runstate_check(RUN_STATE_PRECONFIG) ||
+ cmd_can_preconfig(cmd)) {
+ cmd_completion(mon, cmdname, cmd->name);
+ }
+ }
+ } else {
+ /* find the command */
+ for (cmd = cmd_table; cmd->name != NULL; cmd++) {
+ if (hmp_compare_cmd(args[0], cmd->name) &&
+ (!runstate_check(RUN_STATE_PRECONFIG) ||
+ cmd_can_preconfig(cmd))) {
+ break;
+ }
+ }
+ if (!cmd->name) {
+ return;
+ }
+
+ if (cmd->sub_table) {
+ /* do the job again */
+ monitor_find_completion_by_table(mon, cmd->sub_table,
+ &args[1], nb_args - 1);
+ return;
+ }
+ if (cmd->command_completion) {
+ cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
+ return;
+ }
+
+ ptype = next_arg_type(cmd->args_type);
+ for (i = 0; i < nb_args - 2; i++) {
+ if (*ptype != '\0') {
+ ptype = next_arg_type(ptype);
+ while (*ptype == '?') {
+ ptype = next_arg_type(ptype);
+ }
+ }
+ }
+ str = args[nb_args - 1];
+ old_ptype = NULL;
+ while (*ptype == '-' && old_ptype != ptype) {
+ old_ptype = ptype;
+ ptype = next_arg_type(ptype);
+ }
+ switch (*ptype) {
+ case 'F':
+ /* file completion */
+ readline_set_completion_index(mon->rs, strlen(str));
+ file_completion(mon, str);
+ break;
+ case 'B':
+ /* block device name completion */
+ readline_set_completion_index(mon->rs, strlen(str));
+ while ((blk = blk_next(blk)) != NULL) {
+ name = blk_name(blk);
+ if (str[0] == '\0' ||
+ !strncmp(name, str, strlen(str))) {
+ readline_add_completion(mon->rs, name);
+ }
+ }
+ break;
+ case 's':
+ case 'S':
+ if (!strcmp(cmd->name, "help|?")) {
+ monitor_find_completion_by_table(mon, cmd_table,
+ &args[1], nb_args - 1);
+ }
+ break;
+ default:
+ break;
+ }
+ }
+}
+
+static void monitor_find_completion(void *opaque,
+ const char *cmdline)
+{
+ MonitorHMP *mon = opaque;
+ char *args[MAX_ARGS];
+ int nb_args, len;
+
+ /* 1. parse the cmdline */
+ if (parse_cmdline(cmdline, &nb_args, args) < 0) {
+ return;
+ }
+
+ /*
+ * if the line ends with a space, it means we want to complete the
+ * next arg
+ */
+ len = strlen(cmdline);
+ if (len > 0 && qemu_isspace(cmdline[len - 1])) {
+ if (nb_args >= MAX_ARGS) {
+ goto cleanup;
+ }
+ args[nb_args++] = g_strdup("");
+ }
+
+ /* 2. auto complete according to args */
+ monitor_find_completion_by_table(mon, hmp_cmds, args, nb_args);
+
+cleanup:
+ free_cmdline_args(args, nb_args);
+}
+
+static void monitor_read(void *opaque, const uint8_t *buf, int size)
+{
+ MonitorHMP *mon;
+ Monitor *old_mon = cur_mon;
+ int i;
+
+ cur_mon = opaque;
+ mon = container_of(cur_mon, MonitorHMP, common);
+
+ if (mon->rs) {
+ for (i = 0; i < size; i++) {
+ readline_handle_byte(mon->rs, buf[i]);
+ }
+ } else {
+ if (size == 0 || buf[size - 1] != 0) {
+ monitor_printf(cur_mon, "corrupted command\n");
+ } else {
+ handle_hmp_command(mon, (char *)buf);
+ }
+ }
+
+ cur_mon = old_mon;
+}
+
+static void monitor_event(void *opaque, int event)
+{
+ Monitor *mon = opaque;
+ MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
+
+ switch (event) {
+ case CHR_EVENT_MUX_IN:
+ qemu_mutex_lock(&mon->mon_lock);
+ mon->mux_out = 0;
+ qemu_mutex_unlock(&mon->mon_lock);
+ if (mon->reset_seen) {
+ readline_restart(hmp_mon->rs);
+ monitor_resume(mon);
+ monitor_flush(mon);
+ } else {
+ atomic_mb_set(&mon->suspend_cnt, 0);
+ }
+ break;
+
+ case CHR_EVENT_MUX_OUT:
+ if (mon->reset_seen) {
+ if (atomic_mb_read(&mon->suspend_cnt) == 0) {
+ monitor_printf(mon, "\n");
+ }
+ monitor_flush(mon);
+ monitor_suspend(mon);
+ } else {
+ atomic_inc(&mon->suspend_cnt);
+ }
+ qemu_mutex_lock(&mon->mon_lock);
+ mon->mux_out = 1;
+ qemu_mutex_unlock(&mon->mon_lock);
+ break;
+
+ case CHR_EVENT_OPENED:
+ monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
+ "information\n", QEMU_VERSION);
+ if (!mon->mux_out) {
+ readline_restart(hmp_mon->rs);
+ readline_show_prompt(hmp_mon->rs);
+ }
+ mon->reset_seen = 1;
+ mon_refcount++;
+ break;
+
+ case CHR_EVENT_CLOSED:
+ mon_refcount--;
+ monitor_fdsets_cleanup();
+ break;
+ }
+}
+
+
+/*
+ * These functions just adapt the readline interface in a typesafe way. We
+ * could cast function pointers but that discards compiler checks.
+ */
+static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
+ const char *fmt, ...)
+{
+ MonitorHMP *mon = opaque;
+ va_list ap;
+ va_start(ap, fmt);
+ monitor_vprintf(&mon->common, fmt, ap);
+ va_end(ap);
+}
+
+static void monitor_readline_flush(void *opaque)
+{
+ MonitorHMP *mon = opaque;
+ monitor_flush(&mon->common);
+}
+
+void monitor_init_hmp(Chardev *chr, int flags)
+{
+ MonitorHMP *mon = g_new0(MonitorHMP, 1);
+ bool use_readline = flags & MONITOR_USE_READLINE;
+
+ monitor_data_init(&mon->common, flags, false, false);
+ qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
+
+ if (use_readline) {
+ mon->rs = readline_init(monitor_readline_printf,
+ monitor_readline_flush,
+ mon,
+ monitor_find_completion);
+ monitor_read_command(mon, 0);
+ }
+
+ qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read, monitor_read,
+ monitor_event, NULL, &mon->common, NULL, true);
+ monitor_list_append(&mon->common);
+}
diff --git a/monitor/misc.c b/monitor/misc.c
index 824d28d717..5756d25590 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -24,7 +24,6 @@
#include "qemu/osdep.h"
#include "monitor-internal.h"
-#include "qemu/units.h"
#include <dirent.h>
#include "cpu.h"
#include "hw/hw.h"
@@ -39,11 +38,9 @@
#include "chardev/char-mux.h"
#include "ui/qemu-spice.h"
#include "sysemu/numa.h"
-#include "qemu/config-file.h"
#include "qemu/ctype.h"
#include "ui/console.h"
#include "ui/input.h"
-#include "sysemu/block-backend.h"
#include "audio/audio.h"
#include "disas/disas.h"
#include "sysemu/balloon.h"
@@ -55,7 +52,6 @@
#include "sysemu/tpm.h"
#include "qapi/qmp/qdict.h"
#include "qapi/qmp/qerror.h"
-#include "qapi/qmp/qnum.h"
#include "qapi/qmp/qstring.h"
#include "qom/object_interfaces.h"
#include "trace.h"
@@ -66,7 +62,6 @@
#endif
#include "exec/memory.h"
#include "exec/exec-all.h"
-#include "qemu/log.h"
#include "qemu/option.h"
#include "hmp.h"
#include "qemu/thread.h"
@@ -149,14 +144,10 @@ static QLIST_HEAD(, MonFdset) mon_fdsets;
int mon_refcount;
-static HMPCommand hmp_cmds[];
static HMPCommand hmp_info_cmds[];
__thread Monitor *cur_mon;
-static void monitor_command_cb(void *opaque, const char *cmdline,
- void *readline_opaque);
-
/**
* Is @mon is using readline?
* Note: not all HMP monitors use readline, e.g., gdbserver has a
@@ -191,31 +182,6 @@ bool monitor_cur_is_qmp(void)
return cur_mon && monitor_is_qmp(cur_mon);
}
-void monitor_read_command(MonitorHMP *mon, int show_prompt)
-{
- if (!mon->rs)
- return;
-
- readline_start(mon->rs, "(qemu) ", 0, monitor_command_cb, NULL);
- if (show_prompt)
- readline_show_prompt(mon->rs);
-}
-
-int monitor_read_password(MonitorHMP *mon, ReadLineFunc *readline_func,
- void *opaque)
-{
- if (mon->rs) {
- readline_start(mon->rs, "Password: ", 1, readline_func, opaque);
- /* prompt is printed on return from the command handler */
- return 0;
- } else {
- monitor_printf(&mon->common,
- "terminal does not support password prompting\n");
- return -ENOTTY;
- }
-}
-
-
static void monitor_flush_locked(Monitor *mon);
static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
@@ -534,8 +500,6 @@ static void monitor_qapi_event_init(void)
qapi_event_throttle_equal);
}
-static void handle_hmp_command(MonitorHMP *mon, const char *cmdline);
-
static void monitor_iothread_init(void);
void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
@@ -602,245 +566,27 @@ out:
return output;
}
-static int compare_cmd(const char *name, const char *list)
+/**
+ * Is @name in the '|' separated list of names @list?
+ */
+int hmp_compare_cmd(const char *name, const char *list)
{
const char *p, *pstart;
int len;
len = strlen(name);
p = list;
- for(;;) {
- pstart = p;
- p = qemu_strchrnul(p, '|');
- if ((p - pstart) == len && !memcmp(pstart, name, len))
- return 1;
- if (*p == '\0')
- break;
- p++;
- }
- return 0;
-}
-
-static int get_str(char *buf, int buf_size, const char **pp)
-{
- const char *p;
- char *q;
- int c;
-
- q = buf;
- p = *pp;
- while (qemu_isspace(*p)) {
- p++;
- }
- if (*p == '\0') {
- fail:
- *q = '\0';
- *pp = p;
- return -1;
- }
- if (*p == '\"') {
- p++;
- while (*p != '\0' && *p != '\"') {
- if (*p == '\\') {
- p++;
- c = *p++;
- switch (c) {
- case 'n':
- c = '\n';
- break;
- case 'r':
- c = '\r';
- break;
- case '\\':
- case '\'':
- case '\"':
- break;
- default:
- printf("unsupported escape code: '\\%c'\n", c);
- goto fail;
- }
- if ((q - buf) < buf_size - 1) {
- *q++ = c;
- }
- } else {
- if ((q - buf) < buf_size - 1) {
- *q++ = *p;
- }
- p++;
- }
- }
- if (*p != '\"') {
- printf("unterminated string\n");
- goto fail;
- }
- p++;
- } else {
- while (*p != '\0' && !qemu_isspace(*p)) {
- if ((q - buf) < buf_size - 1) {
- *q++ = *p;
- }
- p++;
- }
- }
- *q = '\0';
- *pp = p;
- return 0;
-}
-
-#define MAX_ARGS 16
-
-static void free_cmdline_args(char **args, int nb_args)
-{
- int i;
-
- assert(nb_args <= MAX_ARGS);
-
- for (i = 0; i < nb_args; i++) {
- g_free(args[i]);
- }
-
-}
-
-/*
- * Parse the command line to get valid args.
- * @cmdline: command line to be parsed.
- * @pnb_args: location to store the number of args, must NOT be NULL.
- * @args: location to store the args, which should be freed by caller, must
- * NOT be NULL.
- *
- * Returns 0 on success, negative on failure.
- *
- * NOTE: this parser is an approximate form of the real command parser. Number
- * of args have a limit of MAX_ARGS. If cmdline contains more, it will
- * return with failure.
- */
-static int parse_cmdline(const char *cmdline,
- int *pnb_args, char **args)
-{
- const char *p;
- int nb_args, ret;
- char buf[1024];
-
- p = cmdline;
- nb_args = 0;
for (;;) {
- while (qemu_isspace(*p)) {
- p++;
+ pstart = p;
+ p = qemu_strchrnul(p, '|');
+ if ((p - pstart) == len && !memcmp(pstart, name, len)) {
+ return 1;
}
if (*p == '\0') {
break;
}
- if (nb_args >= MAX_ARGS) {
- goto fail;
- }
- ret = get_str(buf, sizeof(buf), &p);
- if (ret < 0) {
- goto fail;
- }
- args[nb_args] = g_strdup(buf);
- nb_args++;
+ p++;
}
- *pnb_args = nb_args;
return 0;
-
- fail:
- free_cmdline_args(args, nb_args);
- return -1;
-}
-
-/*
- * Can command @cmd be executed in preconfig state?
- */
-static bool cmd_can_preconfig(const HMPCommand *cmd)
-{
- if (!cmd->flags) {
- return false;
- }
-
- return strchr(cmd->flags, 'p');
-}
-
-static void help_cmd_dump_one(Monitor *mon,
- const HMPCommand *cmd,
- char **prefix_args,
- int prefix_args_nb)
-{
- int i;
-
- if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
- return;
- }
-
- for (i = 0; i < prefix_args_nb; i++) {
- monitor_printf(mon, "%s ", prefix_args[i]);
- }
- monitor_printf(mon, "%s %s -- %s\n", cmd->name, cmd->params, cmd->help);
-}
-
-/* @args[@arg_index] is the valid command need to find in @cmds */
-static void help_cmd_dump(Monitor *mon, const HMPCommand *cmds,
- char **args, int nb_args, int arg_index)
-{
- const HMPCommand *cmd;
- size_t i;
-
- /* No valid arg need to compare with, dump all in *cmds */
- if (arg_index >= nb_args) {
- for (cmd = cmds; cmd->name != NULL; cmd++) {
- help_cmd_dump_one(mon, cmd, args, arg_index);
- }
- return;
- }
-
- /* Find one entry to dump */
- for (cmd = cmds; cmd->name != NULL; cmd++) {
- if (compare_cmd(args[arg_index], cmd->name) &&
- ((!runstate_check(RUN_STATE_PRECONFIG) ||
- cmd_can_preconfig(cmd)))) {
- if (cmd->sub_table) {
- /* continue with next arg */
- help_cmd_dump(mon, cmd->sub_table,
- args, nb_args, arg_index + 1);
- } else {
- help_cmd_dump_one(mon, cmd, args, arg_index);
- }
- return;
- }
- }
-
- /* Command not found */
- monitor_printf(mon, "unknown command: '");
- for (i = 0; i <= arg_index; i++) {
- monitor_printf(mon, "%s%s", args[i], i == arg_index ? "'\n" : " ");
- }
-}
-
-static void help_cmd(Monitor *mon, const char *name)
-{
- char *args[MAX_ARGS];
- int nb_args = 0;
-
- /* 1. parse user input */
- if (name) {
- /* special case for log, directly dump and return */
- if (!strcmp(name, "log")) {
- const QEMULogItem *item;
- monitor_printf(mon, "Log items (comma separated):\n");
- monitor_printf(mon, "%-10s %s\n", "none", "remove all logs");
- for (item = qemu_log_items; item->mask != 0; item++) {
- monitor_printf(mon, "%-10s %s\n", item->name, item->help);
- }
- return;
- }
-
- if (parse_cmdline(name, &nb_args, args) < 0) {
- return;
- }
- }
-
- /* 2. dump the contents according to parsed args */
- help_cmd_dump(mon, hmp_cmds, args, nb_args, 0);
-
- free_cmdline_args(args, nb_args);
}
static void do_help_cmd(Monitor *mon, const QDict *qdict)
@@ -2500,30 +2246,16 @@ static HMPCommand hmp_info_cmds[] = {
};
/* hmp_cmds and hmp_info_cmds would be sorted at runtime */
-static HMPCommand hmp_cmds[] = {
+HMPCommand hmp_cmds[] = {
#include "hmp-commands.h"
{ NULL, NULL, },
};
-/*******************************************************************/
-
-static const char *pch;
-static sigjmp_buf expr_env;
-
-
-static void GCC_FMT_ATTR(2, 3) QEMU_NORETURN
-expr_error(Monitor *mon, const char *fmt, ...)
-{
- va_list ap;
- va_start(ap, fmt);
- monitor_vprintf(mon, fmt, ap);
- monitor_printf(mon, "\n");
- va_end(ap);
- siglongjmp(expr_env, 1);
-}
-
-/* return 0 if OK, -1 if not found */
-static int get_monitor_def(target_long *pval, const char *name)
+/*
+ * Set @pval to the value in the register identified by @name.
+ * return 0 if OK, -1 if not found
+ */
+int get_monitor_def(int64_t *pval, const char *name)
{
const MonitorDef *md = target_monitor_defs();
CPUState *cs = mon_get_cpu();
@@ -2536,7 +2268,7 @@ static int get_monitor_def(target_long *pval, const char *name)
}
for(; md->name != NULL; md++) {
- if (compare_cmd(name, md->name)) {
+ if (hmp_compare_cmd(name, md->name)) {
if (md->get_value) {
*pval = md->get_value(md, md->offset);
} else {
@@ -2566,829 +2298,6 @@ static int get_monitor_def(target_long *pval, const char *name)
return ret;
}
-static void next(void)
-{
- if (*pch != '\0') {
- pch++;
- while (qemu_isspace(*pch))
- pch++;
- }
-}
-
-static int64_t expr_sum(Monitor *mon);
-
-static int64_t expr_unary(Monitor *mon)
-{
- int64_t n;
- char *p;
- int ret;
-
- switch(*pch) {
- case '+':
- next();
- n = expr_unary(mon);
- break;
- case '-':
- next();
- n = -expr_unary(mon);
- break;
- case '~':
- next();
- n = ~expr_unary(mon);
- break;
- case '(':
- next();
- n = expr_sum(mon);
- if (*pch != ')') {
- expr_error(mon, "')' expected");
- }
- next();
- break;
- case '\'':
- pch++;
- if (*pch == '\0')
- expr_error(mon, "character constant expected");
- n = *pch;
- pch++;
- if (*pch != '\'')
- expr_error(mon, "missing terminating \' character");
- next();
- break;
- case '$':
- {
- char buf[128], *q;
- target_long reg=0;
-
- pch++;
- q = buf;
- while ((*pch >= 'a' && *pch <= 'z') ||
- (*pch >= 'A' && *pch <= 'Z') ||
- (*pch >= '0' && *pch <= '9') ||
- *pch == '_' || *pch == '.') {
- if ((q - buf) < sizeof(buf) - 1)
- *q++ = *pch;
- pch++;
- }
- while (qemu_isspace(*pch))
- pch++;
- *q = 0;
- ret = get_monitor_def(®, buf);
- if (ret < 0)
- expr_error(mon, "unknown register");
- n = reg;
- }
- break;
- case '\0':
- expr_error(mon, "unexpected end of expression");
- n = 0;
- break;
- default:
- errno = 0;
- n = strtoull(pch, &p, 0);
- if (errno == ERANGE) {
- expr_error(mon, "number too large");
- }
- if (pch == p) {
- expr_error(mon, "invalid char '%c' in expression", *p);
- }
- pch = p;
- while (qemu_isspace(*pch))
- pch++;
- break;
- }
- return n;
-}
-
-
-static int64_t expr_prod(Monitor *mon)
-{
- int64_t val, val2;
- int op;
-
- val = expr_unary(mon);
- for(;;) {
- op = *pch;
- if (op != '*' && op != '/' && op != '%')
- break;
- next();
- val2 = expr_unary(mon);
- switch(op) {
- default:
- case '*':
- val *= val2;
- break;
- case '/':
- case '%':
- if (val2 == 0)
- expr_error(mon, "division by zero");
- if (op == '/')
- val /= val2;
- else
- val %= val2;
- break;
- }
- }
- return val;
-}
-
-static int64_t expr_logic(Monitor *mon)
-{
- int64_t val, val2;
- int op;
-
- val = expr_prod(mon);
- for(;;) {
- op = *pch;
- if (op != '&' && op != '|' && op != '^')
- break;
- next();
- val2 = expr_prod(mon);
- switch(op) {
- default:
- case '&':
- val &= val2;
- break;
- case '|':
- val |= val2;
- break;
- case '^':
- val ^= val2;
- break;
- }
- }
- return val;
-}
-
-static int64_t expr_sum(Monitor *mon)
-{
- int64_t val, val2;
- int op;
-
- val = expr_logic(mon);
- for(;;) {
- op = *pch;
- if (op != '+' && op != '-')
- break;
- next();
- val2 = expr_logic(mon);
- if (op == '+')
- val += val2;
- else
- val -= val2;
- }
- return val;
-}
-
-static int get_expr(Monitor *mon, int64_t *pval, const char **pp)
-{
- pch = *pp;
- if (sigsetjmp(expr_env, 0)) {
- *pp = pch;
- return -1;
- }
- while (qemu_isspace(*pch))
- pch++;
- *pval = expr_sum(mon);
- *pp = pch;
- return 0;
-}
-
-static int get_double(Monitor *mon, double *pval, const char **pp)
-{
- const char *p = *pp;
- char *tailp;
- double d;
-
- d = strtod(p, &tailp);
- if (tailp == p) {
- monitor_printf(mon, "Number expected\n");
- return -1;
- }
- if (d != d || d - d != 0) {
- /* NaN or infinity */
- monitor_printf(mon, "Bad number\n");
- return -1;
- }
- *pval = d;
- *pp = tailp;
- return 0;
-}
-
-/*
- * Store the command-name in cmdname, and return a pointer to
- * the remaining of the command string.
- */
-static const char *get_command_name(const char *cmdline,
- char *cmdname, size_t nlen)
-{
- size_t len;
- const char *p, *pstart;
-
- p = cmdline;
- while (qemu_isspace(*p))
- p++;
- if (*p == '\0')
- return NULL;
- pstart = p;
- while (*p != '\0' && *p != '/' && !qemu_isspace(*p))
- p++;
- len = p - pstart;
- if (len > nlen - 1)
- len = nlen - 1;
- memcpy(cmdname, pstart, len);
- cmdname[len] = '\0';
- return p;
-}
-
-/**
- * Read key of 'type' into 'key' and return the current
- * 'type' pointer.
- */
-static char *key_get_info(const char *type, char **key)
-{
- size_t len;
- char *p, *str;
-
- if (*type == ',')
- type++;
-
- p = strchr(type, ':');
- if (!p) {
- *key = NULL;
- return NULL;
- }
- len = p - type;
-
- str = g_malloc(len + 1);
- memcpy(str, type, len);
- str[len] = '\0';
-
- *key = str;
- return ++p;
-}
-
-static int default_fmt_format = 'x';
-static int default_fmt_size = 4;
-
-static int is_valid_option(const char *c, const char *typestr)
-{
- char option[3];
-
- option[0] = '-';
- option[1] = *c;
- option[2] = '\0';
-
- typestr = strstr(typestr, option);
- return (typestr != NULL);
-}
-
-static const HMPCommand *search_dispatch_table(const HMPCommand *disp_table,
- const char *cmdname)
-{
- const HMPCommand *cmd;
-
- for (cmd = disp_table; cmd->name != NULL; cmd++) {
- if (compare_cmd(cmdname, cmd->name)) {
- return cmd;
- }
- }
-
- return NULL;
-}
-
-/*
- * Parse command name from @cmdp according to command table @table.
- * If blank, return NULL.
- * Else, if no valid command can be found, report to @mon, and return
- * NULL.
- * Else, change @cmdp to point right behind the name, and return its
- * command table entry.
- * Do not assume the return value points into @table! It doesn't when
- * the command is found in a sub-command table.
- */
-static const HMPCommand *monitor_parse_command(MonitorHMP *hmp_mon,
- const char *cmdp_start,
- const char **cmdp,
- HMPCommand *table)
-{
- Monitor *mon = &hmp_mon->common;
- const char *p;
- const HMPCommand *cmd;
- char cmdname[256];
-
- /* extract the command name */
- p = get_command_name(*cmdp, cmdname, sizeof(cmdname));
- if (!p)
- return NULL;
-
- cmd = search_dispatch_table(table, cmdname);
- if (!cmd) {
- monitor_printf(mon, "unknown command: '%.*s'\n",
- (int)(p - cmdp_start), cmdp_start);
- return NULL;
- }
- if (runstate_check(RUN_STATE_PRECONFIG) && !cmd_can_preconfig(cmd)) {
- monitor_printf(mon, "Command '%.*s' not available with -preconfig "
- "until after exit_preconfig.\n",
- (int)(p - cmdp_start), cmdp_start);
- return NULL;
- }
-
- /* filter out following useless space */
- while (qemu_isspace(*p)) {
- p++;
- }
-
- *cmdp = p;
- /* search sub command */
- if (cmd->sub_table != NULL && *p != '\0') {
- return monitor_parse_command(hmp_mon, cmdp_start, cmdp, cmd->sub_table);
- }
-
- return cmd;
-}
-
-/*
- * Parse arguments for @cmd.
- * If it can't be parsed, report to @mon, and return NULL.
- * Else, insert command arguments into a QDict, and return it.
- * Note: On success, caller has to free the QDict structure.
- */
-
-static QDict *monitor_parse_arguments(Monitor *mon,
- const char **endp,
- const HMPCommand *cmd)
-{
- const char *typestr;
- char *key;
- int c;
- const char *p = *endp;
- char buf[1024];
- QDict *qdict = qdict_new();
-
- /* parse the parameters */
- typestr = cmd->args_type;
- for(;;) {
- typestr = key_get_info(typestr, &key);
- if (!typestr)
- break;
- c = *typestr;
- typestr++;
- switch(c) {
- case 'F':
- case 'B':
- case 's':
- {
- int ret;
-
- while (qemu_isspace(*p))
- p++;
- if (*typestr == '?') {
- typestr++;
- if (*p == '\0') {
- /* no optional string: NULL argument */
- break;
- }
- }
- ret = get_str(buf, sizeof(buf), &p);
- if (ret < 0) {
- switch(c) {
- case 'F':
- monitor_printf(mon, "%s: filename expected\n",
- cmd->name);
- break;
- case 'B':
- monitor_printf(mon, "%s: block device name expected\n",
- cmd->name);
- break;
- default:
- monitor_printf(mon, "%s: string expected\n", cmd->name);
- break;
- }
- goto fail;
- }
- qdict_put_str(qdict, key, buf);
- }
- break;
- case 'O':
- {
- QemuOptsList *opts_list;
- QemuOpts *opts;
-
- opts_list = qemu_find_opts(key);
- if (!opts_list || opts_list->desc->name) {
- goto bad_type;
- }
- while (qemu_isspace(*p)) {
- p++;
- }
- if (!*p)
- break;
- if (get_str(buf, sizeof(buf), &p) < 0) {
- goto fail;
- }
- opts = qemu_opts_parse_noisily(opts_list, buf, true);
- if (!opts) {
- goto fail;
- }
- qemu_opts_to_qdict(opts, qdict);
- qemu_opts_del(opts);
- }
- break;
- case '/':
- {
- int count, format, size;
-
- while (qemu_isspace(*p))
- p++;
- if (*p == '/') {
- /* format found */
- p++;
- count = 1;
- if (qemu_isdigit(*p)) {
- count = 0;
- while (qemu_isdigit(*p)) {
- count = count * 10 + (*p - '0');
- p++;
- }
- }
- size = -1;
- format = -1;
- for(;;) {
- switch(*p) {
- case 'o':
- case 'd':
- case 'u':
- case 'x':
- case 'i':
- case 'c':
- format = *p++;
- break;
- case 'b':
- size = 1;
- p++;
- break;
- case 'h':
- size = 2;
- p++;
- break;
- case 'w':
- size = 4;
- p++;
- break;
- case 'g':
- case 'L':
- size = 8;
- p++;
- break;
- default:
- goto next;
- }
- }
- next:
- if (*p != '\0' && !qemu_isspace(*p)) {
- monitor_printf(mon, "invalid char in format: '%c'\n",
- *p);
- goto fail;
- }
- if (format < 0)
- format = default_fmt_format;
- if (format != 'i') {
- /* for 'i', not specifying a size gives -1 as size */
- if (size < 0)
- size = default_fmt_size;
- default_fmt_size = size;
- }
- default_fmt_format = format;
- } else {
- count = 1;
- format = default_fmt_format;
- if (format != 'i') {
- size = default_fmt_size;
- } else {
- size = -1;
- }
- }
- qdict_put_int(qdict, "count", count);
- qdict_put_int(qdict, "format", format);
- qdict_put_int(qdict, "size", size);
- }
- break;
- case 'i':
- case 'l':
- case 'M':
- {
- int64_t val;
-
- while (qemu_isspace(*p))
- p++;
- if (*typestr == '?' || *typestr == '.') {
- if (*typestr == '?') {
- if (*p == '\0') {
- typestr++;
- break;
- }
- } else {
- if (*p == '.') {
- p++;
- while (qemu_isspace(*p))
- p++;
- } else {
- typestr++;
- break;
- }
- }
- typestr++;
- }
- if (get_expr(mon, &val, &p))
- goto fail;
- /* Check if 'i' is greater than 32-bit */
- if ((c == 'i') && ((val >> 32) & 0xffffffff)) {
- monitor_printf(mon, "\'%s\' has failed: ", cmd->name);
- monitor_printf(mon, "integer is for 32-bit values\n");
- goto fail;
- } else if (c == 'M') {
- if (val < 0) {
- monitor_printf(mon, "enter a positive value\n");
- goto fail;
- }
- val *= MiB;
- }
- qdict_put_int(qdict, key, val);
- }
- break;
- case 'o':
- {
- int ret;
- uint64_t val;
- const char *end;
-
- while (qemu_isspace(*p)) {
- p++;
- }
- if (*typestr == '?') {
- typestr++;
- if (*p == '\0') {
- break;
- }
- }
- ret = qemu_strtosz_MiB(p, &end, &val);
- if (ret < 0 || val > INT64_MAX) {
- monitor_printf(mon, "invalid size\n");
- goto fail;
- }
- qdict_put_int(qdict, key, val);
- p = end;
- }
- break;
- case 'T':
- {
- double val;
-
- while (qemu_isspace(*p))
- p++;
- if (*typestr == '?') {
- typestr++;
- if (*p == '\0') {
- break;
- }
- }
- if (get_double(mon, &val, &p) < 0) {
- goto fail;
- }
- if (p[0] && p[1] == 's') {
- switch (*p) {
- case 'm':
- val /= 1e3; p += 2; break;
- case 'u':
- val /= 1e6; p += 2; break;
- case 'n':
- val /= 1e9; p += 2; break;
- }
- }
- if (*p && !qemu_isspace(*p)) {
- monitor_printf(mon, "Unknown unit suffix\n");
- goto fail;
- }
- qdict_put(qdict, key, qnum_from_double(val));
- }
- break;
- case 'b':
- {
- const char *beg;
- bool val;
-
- while (qemu_isspace(*p)) {
- p++;
- }
- beg = p;
- while (qemu_isgraph(*p)) {
- p++;
- }
- if (p - beg == 2 && !memcmp(beg, "on", p - beg)) {
- val = true;
- } else if (p - beg == 3 && !memcmp(beg, "off", p - beg)) {
- val = false;
- } else {
- monitor_printf(mon, "Expected 'on' or 'off'\n");
- goto fail;
- }
- qdict_put_bool(qdict, key, val);
- }
- break;
- case '-':
- {
- const char *tmp = p;
- int skip_key = 0;
- /* option */
-
- c = *typestr++;
- if (c == '\0')
- goto bad_type;
- while (qemu_isspace(*p))
- p++;
- if (*p == '-') {
- p++;
- if(c != *p) {
- if(!is_valid_option(p, typestr)) {
-
- monitor_printf(mon, "%s: unsupported option -%c\n",
- cmd->name, *p);
- goto fail;
- } else {
- skip_key = 1;
- }
- }
- if(skip_key) {
- p = tmp;
- } else {
- /* has option */
- p++;
- qdict_put_bool(qdict, key, true);
- }
- }
- }
- break;
- case 'S':
- {
- /* package all remaining string */
- int len;
-
- while (qemu_isspace(*p)) {
- p++;
- }
- if (*typestr == '?') {
- typestr++;
- if (*p == '\0') {
- /* no remaining string: NULL argument */
- break;
- }
- }
- len = strlen(p);
- if (len <= 0) {
- monitor_printf(mon, "%s: string expected\n",
- cmd->name);
- goto fail;
- }
- qdict_put_str(qdict, key, p);
- p += len;
- }
- break;
- default:
- bad_type:
- monitor_printf(mon, "%s: unknown type '%c'\n", cmd->name, c);
- goto fail;
- }
- g_free(key);
- key = NULL;
- }
- /* check that all arguments were parsed */
- while (qemu_isspace(*p))
- p++;
- if (*p != '\0') {
- monitor_printf(mon, "%s: extraneous characters at the end of line\n",
- cmd->name);
- goto fail;
- }
-
- return qdict;
-
-fail:
- qobject_unref(qdict);
- g_free(key);
- return NULL;
-}
-
-static void handle_hmp_command(MonitorHMP *mon, const char *cmdline)
-{
- QDict *qdict;
- const HMPCommand *cmd;
- const char *cmd_start = cmdline;
-
- trace_handle_hmp_command(mon, cmdline);
-
- cmd = monitor_parse_command(mon, cmdline, &cmdline, hmp_cmds);
- if (!cmd) {
- return;
- }
-
- qdict = monitor_parse_arguments(&mon->common, &cmdline, cmd);
- if (!qdict) {
- while (cmdline > cmd_start && qemu_isspace(cmdline[-1])) {
- cmdline--;
- }
- monitor_printf(&mon->common, "Try \"help %.*s\" for more information\n",
- (int)(cmdline - cmd_start), cmd_start);
- return;
- }
-
- cmd->cmd(&mon->common, qdict);
- qobject_unref(qdict);
-}
-
-static void cmd_completion(MonitorHMP *mon, const char *name, const char *list)
-{
- const char *p, *pstart;
- char cmd[128];
- int len;
-
- p = list;
- for(;;) {
- pstart = p;
- p = qemu_strchrnul(p, '|');
- len = p - pstart;
- if (len > sizeof(cmd) - 2)
- len = sizeof(cmd) - 2;
- memcpy(cmd, pstart, len);
- cmd[len] = '\0';
- if (name[0] == '\0' || !strncmp(name, cmd, strlen(name))) {
- readline_add_completion(mon->rs, cmd);
- }
- if (*p == '\0')
- break;
- p++;
- }
-}
-
-static void file_completion(MonitorHMP *mon, const char *input)
-{
- DIR *ffs;
- struct dirent *d;
- char path[1024];
- char file[1024], file_prefix[1024];
- int input_path_len;
- const char *p;
-
- p = strrchr(input, '/');
- if (!p) {
- input_path_len = 0;
- pstrcpy(file_prefix, sizeof(file_prefix), input);
- pstrcpy(path, sizeof(path), ".");
- } else {
- input_path_len = p - input + 1;
- memcpy(path, input, input_path_len);
- if (input_path_len > sizeof(path) - 1)
- input_path_len = sizeof(path) - 1;
- path[input_path_len] = '\0';
- pstrcpy(file_prefix, sizeof(file_prefix), p + 1);
- }
-
- ffs = opendir(path);
- if (!ffs)
- return;
- for(;;) {
- struct stat sb;
- d = readdir(ffs);
- if (!d)
- break;
-
- if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
- continue;
- }
-
- if (strstart(d->d_name, file_prefix, NULL)) {
- memcpy(file, input, input_path_len);
- if (input_path_len < sizeof(file))
- pstrcpy(file + input_path_len, sizeof(file) - input_path_len,
- d->d_name);
- /* stat the file to find out if it's a directory.
- * In that case add a slash to speed up typing long paths
- */
- if (stat(file, &sb) == 0 && S_ISDIR(sb.st_mode)) {
- pstrcat(file, sizeof(file), "/");
- }
- readline_add_completion(mon->rs, file);
- }
- }
- closedir(ffs);
-}
-
-static const char *next_arg_type(const char *typestr)
-{
- const char *p = strchr(typestr, ':');
- return (p != NULL ? ++p : typestr);
-}
-
static void add_completion_option(ReadLineState *rs, const char *str,
const char *option)
{
@@ -3819,127 +2728,6 @@ void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
}
}
-static void monitor_find_completion_by_table(MonitorHMP *mon,
- const HMPCommand *cmd_table,
- char **args,
- int nb_args)
-{
- const char *cmdname;
- int i;
- const char *ptype, *old_ptype, *str, *name;
- const HMPCommand *cmd;
- BlockBackend *blk = NULL;
-
- if (nb_args <= 1) {
- /* command completion */
- if (nb_args == 0)
- cmdname = "";
- else
- cmdname = args[0];
- readline_set_completion_index(mon->rs, strlen(cmdname));
- for (cmd = cmd_table; cmd->name != NULL; cmd++) {
- if (!runstate_check(RUN_STATE_PRECONFIG) ||
- cmd_can_preconfig(cmd)) {
- cmd_completion(mon, cmdname, cmd->name);
- }
- }
- } else {
- /* find the command */
- for (cmd = cmd_table; cmd->name != NULL; cmd++) {
- if (compare_cmd(args[0], cmd->name) &&
- (!runstate_check(RUN_STATE_PRECONFIG) ||
- cmd_can_preconfig(cmd))) {
- break;
- }
- }
- if (!cmd->name) {
- return;
- }
-
- if (cmd->sub_table) {
- /* do the job again */
- monitor_find_completion_by_table(mon, cmd->sub_table,
- &args[1], nb_args - 1);
- return;
- }
- if (cmd->command_completion) {
- cmd->command_completion(mon->rs, nb_args, args[nb_args - 1]);
- return;
- }
-
- ptype = next_arg_type(cmd->args_type);
- for(i = 0; i < nb_args - 2; i++) {
- if (*ptype != '\0') {
- ptype = next_arg_type(ptype);
- while (*ptype == '?')
- ptype = next_arg_type(ptype);
- }
- }
- str = args[nb_args - 1];
- old_ptype = NULL;
- while (*ptype == '-' && old_ptype != ptype) {
- old_ptype = ptype;
- ptype = next_arg_type(ptype);
- }
- switch(*ptype) {
- case 'F':
- /* file completion */
- readline_set_completion_index(mon->rs, strlen(str));
- file_completion(mon, str);
- break;
- case 'B':
- /* block device name completion */
- readline_set_completion_index(mon->rs, strlen(str));
- while ((blk = blk_next(blk)) != NULL) {
- name = blk_name(blk);
- if (str[0] == '\0' ||
- !strncmp(name, str, strlen(str))) {
- readline_add_completion(mon->rs, name);
- }
- }
- break;
- case 's':
- case 'S':
- if (!strcmp(cmd->name, "help|?")) {
- monitor_find_completion_by_table(mon, cmd_table,
- &args[1], nb_args - 1);
- }
- break;
- default:
- break;
- }
- }
-}
-
-static void monitor_find_completion(void *opaque,
- const char *cmdline)
-{
- MonitorHMP *mon = opaque;
- char *args[MAX_ARGS];
- int nb_args, len;
-
- /* 1. parse the cmdline */
- if (parse_cmdline(cmdline, &nb_args, args) < 0) {
- return;
- }
-
- /* if the line ends with a space, it means we want to complete the
- next arg */
- len = strlen(cmdline);
- if (len > 0 && qemu_isspace(cmdline[len - 1])) {
- if (nb_args >= MAX_ARGS) {
- goto cleanup;
- }
- args[nb_args++] = g_strdup("");
- }
-
- /* 2. auto complete according to args */
- monitor_find_completion_by_table(mon, hmp_cmds, args, nb_args);
-
-cleanup:
- free_cmdline_args(args, nb_args);
-}
-
int monitor_can_read(void *opaque)
{
Monitor *mon = opaque;
@@ -3947,38 +2735,6 @@ int monitor_can_read(void *opaque)
return !atomic_mb_read(&mon->suspend_cnt);
}
-static void monitor_read(void *opaque, const uint8_t *buf, int size)
-{
- MonitorHMP *mon;
- Monitor *old_mon = cur_mon;
- int i;
-
- cur_mon = opaque;
- mon = container_of(cur_mon, MonitorHMP, common);
-
- if (mon->rs) {
- for (i = 0; i < size; i++)
- readline_handle_byte(mon->rs, buf[i]);
- } else {
- if (size == 0 || buf[size - 1] != 0)
- monitor_printf(cur_mon, "corrupted command\n");
- else
- handle_hmp_command(mon, (char *)buf);
- }
-
- cur_mon = old_mon;
-}
-
-static void monitor_command_cb(void *opaque, const char *cmdline,
- void *readline_opaque)
-{
- MonitorHMP *mon = opaque;
-
- monitor_suspend(&mon->common);
- handle_hmp_command(mon, cmdline);
- monitor_resume(&mon->common);
-}
-
int monitor_suspend(Monitor *mon)
{
if (monitor_is_hmp_non_interactive(mon)) {
@@ -4033,58 +2789,6 @@ void monitor_resume(Monitor *mon)
trace_monitor_suspend(mon, -1);
}
-static void monitor_event(void *opaque, int event)
-{
- Monitor *mon = opaque;
- MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
-
- switch (event) {
- case CHR_EVENT_MUX_IN:
- qemu_mutex_lock(&mon->mon_lock);
- mon->mux_out = 0;
- qemu_mutex_unlock(&mon->mon_lock);
- if (mon->reset_seen) {
- readline_restart(hmp_mon->rs);
- monitor_resume(mon);
- monitor_flush(mon);
- } else {
- atomic_mb_set(&mon->suspend_cnt, 0);
- }
- break;
-
- case CHR_EVENT_MUX_OUT:
- if (mon->reset_seen) {
- if (atomic_mb_read(&mon->suspend_cnt) == 0) {
- monitor_printf(mon, "\n");
- }
- monitor_flush(mon);
- monitor_suspend(mon);
- } else {
- atomic_inc(&mon->suspend_cnt);
- }
- qemu_mutex_lock(&mon->mon_lock);
- mon->mux_out = 1;
- qemu_mutex_unlock(&mon->mon_lock);
- break;
-
- case CHR_EVENT_OPENED:
- monitor_printf(mon, "QEMU %s monitor - type 'help' for more "
- "information\n", QEMU_VERSION);
- if (!mon->mux_out) {
- readline_restart(hmp_mon->rs);
- readline_show_prompt(hmp_mon->rs);
- }
- mon->reset_seen = 1;
- mon_refcount++;
- break;
-
- case CHR_EVENT_CLOSED:
- mon_refcount--;
- monitor_fdsets_cleanup();
- break;
- }
-}
-
static int
compare_mon_cmd(const void *a, const void *b)
{
@@ -4125,25 +2829,6 @@ void monitor_init_globals(void)
NULL);
}
-/* These functions just adapt the readline interface in a typesafe way. We
- * could cast function pointers but that discards compiler checks.
- */
-static void GCC_FMT_ATTR(2, 3) monitor_readline_printf(void *opaque,
- const char *fmt, ...)
-{
- MonitorHMP *mon = opaque;
- va_list ap;
- va_start(ap, fmt);
- monitor_vprintf(&mon->common, fmt, ap);
- va_end(ap);
-}
-
-static void monitor_readline_flush(void *opaque)
-{
- MonitorHMP *mon = opaque;
- monitor_flush(&mon->common);
-}
-
/*
* Print to current monitor if we have one, else to stderr.
*/
@@ -4186,27 +2871,6 @@ void monitor_list_append(Monitor *mon)
}
}
-static void monitor_init_hmp(Chardev *chr, int flags)
-{
- MonitorHMP *mon = g_new0(MonitorHMP, 1);
- bool use_readline = flags & MONITOR_USE_READLINE;
-
- monitor_data_init(&mon->common, flags, false, false);
- qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
-
- if (use_readline) {
- mon->rs = readline_init(monitor_readline_printf,
- monitor_readline_flush,
- mon,
- monitor_find_completion);
- monitor_read_command(mon, 0);
- }
-
- qemu_chr_fe_set_handlers(&mon->common.chr, monitor_can_read, monitor_read,
- monitor_event, NULL, &mon->common, NULL, true);
- monitor_list_append(&mon->common);
-}
-
void monitor_init(Chardev *chr, int flags)
{
if (flags & MONITOR_USE_CONTROL) {
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index d859bd3894..10fda7d97c 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -159,7 +159,10 @@ extern QemuMutex monitor_lock;
extern MonitorList mon_list;
extern int mon_refcount;
+extern HMPCommand hmp_cmds[];
+
void monitor_init_qmp(Chardev *chr, int flags);
+void monitor_init_hmp(Chardev *chr, int flags);
int monitor_puts(Monitor *mon, const char *str);
void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
@@ -172,4 +175,9 @@ void qmp_send_response(MonitorQMP *mon, const QDict *rsp);
void monitor_data_destroy_qmp(MonitorQMP *mon);
void monitor_qmp_bh_dispatcher(void *data);
+int get_monitor_def(int64_t *pval, const char *name);
+void help_cmd(Monitor *mon, const char *name);
+void handle_hmp_command(MonitorHMP *mon, const char *cmdline);
+int hmp_compare_cmd(const char *name, const char *list);
+
#endif
diff --git a/monitor/trace-events b/monitor/trace-events
index a06dde3fd3..2285d26121 100644
--- a/monitor/trace-events
+++ b/monitor/trace-events
@@ -1,10 +1,12 @@
# See docs/devel/tracing.txt for syntax documentation.
+# hmp.c
+handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
+
# misc.c
monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
-handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
monitor_suspend(void *ptr, int cnt) "mon %p: %d"
# qmp.c
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 13/16] monitor: Split out monitor/monitor.c
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (11 preceding siblings ...)
2019-06-17 18:48 ` [Qemu-devel] [PULL 12/16] monitor: Split out monitor/hmp.c Markus Armbruster
@ 2019-06-17 18:49 ` Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 14/16] monitor: Split Monitor.flags into separate bools Markus Armbruster
` (5 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:49 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
Move the monitor core infrastructure from monitor/misc.c to
monitor/monitor.c. This is code that can be shared for all targets, so
compile it only once.
What remains in monitor/misc.c after this patch is mostly monitor
command implementations (which could move to hmp-cmds.c or qmp-cmds.c
later) and code that requires a system emulator or is even
target-dependent (including HMP command completion code).
The amount of function and particularly extern variables in
monitor_int.h is probably a bit larger than it needs to be, but this way
no non-trivial code modifications are needed. The interfaces between all
monitor parts can be cleaned up later.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-13-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Superfluous #include dropped]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
MAINTAINERS | 2 +
include/monitor/monitor.h | 1 +
monitor/Makefile.objs | 2 +-
monitor/misc.c | 598 +----------------------------------
monitor/monitor-internal.h | 1 +
monitor/monitor.c | 633 +++++++++++++++++++++++++++++++++++++
monitor/trace-events | 2 +-
7 files changed, 640 insertions(+), 599 deletions(-)
create mode 100644 monitor/monitor.c
diff --git a/MAINTAINERS b/MAINTAINERS
index 15f21c35e0..d32c5c2313 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1920,6 +1920,7 @@ M: Dr. David Alan Gilbert <dgilbert@redhat.com>
S: Maintained
F: monitor/monitor-internal.h
F: monitor/misc.c
+F: monitor/monitor.c
F: monitor/hmp*
F: hmp.h
F: hmp-commands*.hx
@@ -2044,6 +2045,7 @@ S: Supported
F: monitor/monitor-internal.h
F: monitor/qmp*
F: monitor/misc.c
+F: monitor/monitor.c
F: docs/devel/*qmp-*
F: docs/interop/*qmp-*
F: scripts/qmp/
diff --git a/include/monitor/monitor.h b/include/monitor/monitor.h
index f9d30e1d78..44ac43df34 100644
--- a/include/monitor/monitor.h
+++ b/include/monitor/monitor.h
@@ -19,6 +19,7 @@ typedef struct MonitorHMP MonitorHMP;
bool monitor_cur_is_qmp(void);
void monitor_init_globals(void);
+void monitor_init_globals_core(void);
void monitor_init(Chardev *chr, int flags);
void monitor_cleanup(void);
diff --git a/monitor/Makefile.objs b/monitor/Makefile.objs
index bea8838acc..e91a8581cd 100644
--- a/monitor/Makefile.objs
+++ b/monitor/Makefile.objs
@@ -1,3 +1,3 @@
obj-y += misc.o
-common-obj-y += qmp.o hmp.o
+common-obj-y += monitor.o qmp.o hmp.o
common-obj-y += qmp-cmds.o hmp-cmds.o
diff --git a/monitor/misc.c b/monitor/misc.c
index 5756d25590..002aba1030 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -54,7 +54,6 @@
#include "qapi/qmp/qerror.h"
#include "qapi/qmp/qstring.h"
#include "qom/object_interfaces.h"
-#include "trace.h"
#include "trace/control.h"
#include "monitor/hmp-target.h"
#ifdef CONFIG_TRACE_SIMPLE
@@ -71,7 +70,6 @@
#include "qapi/error.h"
#include "qapi/qmp-event.h"
#include "qapi/qapi-introspect.h"
-#include "sysemu/qtest.h"
#include "sysemu/cpus.h"
#include "qemu/cutils.h"
#include "tcg/tcg.h"
@@ -107,427 +105,15 @@ struct MonFdset {
QLIST_ENTRY(MonFdset) next;
};
-/*
- * To prevent flooding clients, events can be throttled. The
- * throttling is calculated globally, rather than per-Monitor
- * instance.
- */
-typedef struct MonitorQAPIEventState {
- QAPIEvent event; /* Throttling state for this event type and... */
- QDict *data; /* ... data, see qapi_event_throttle_equal() */
- QEMUTimer *timer; /* Timer for handling delayed events */
- QDict *qdict; /* Delayed event (if any) */
-} MonitorQAPIEventState;
-
-typedef struct {
- int64_t rate; /* Minimum time (in ns) between two events */
-} MonitorQAPIEventConf;
-
-/* Shared monitor I/O thread */
-IOThread *mon_iothread;
-
-/* Bottom half to dispatch the requests received from I/O thread */
-QEMUBH *qmp_dispatcher_bh;
-
/* QMP checker flags */
#define QMP_ACCEPT_UNKNOWNS 1
-/* Protects mon_list, monitor_qapi_event_state, monitor_destroyed. */
-QemuMutex monitor_lock;
-static GHashTable *monitor_qapi_event_state;
-MonitorList mon_list;
-static bool monitor_destroyed;
-
/* Protects mon_fdsets */
static QemuMutex mon_fdsets_lock;
static QLIST_HEAD(, MonFdset) mon_fdsets;
-int mon_refcount;
-
static HMPCommand hmp_info_cmds[];
-__thread Monitor *cur_mon;
-
-/**
- * Is @mon is using readline?
- * Note: not all HMP monitors use readline, e.g., gdbserver has a
- * non-interactive HMP monitor, so readline is not used there.
- */
-static inline bool monitor_uses_readline(const Monitor *mon)
-{
- return mon->flags & MONITOR_USE_READLINE;
-}
-
-static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
-{
- return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
-}
-
-/*
- * Return the clock to use for recording an event's time.
- * It's QEMU_CLOCK_REALTIME, except for qtests it's
- * QEMU_CLOCK_VIRTUAL, to support testing rate limits.
- * Beware: result is invalid before configure_accelerator().
- */
-static inline QEMUClockType monitor_get_event_clock(void)
-{
- return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
-}
-
-/**
- * Is the current monitor, if any, a QMP monitor?
- */
-bool monitor_cur_is_qmp(void)
-{
- return cur_mon && monitor_is_qmp(cur_mon);
-}
-
-static void monitor_flush_locked(Monitor *mon);
-
-static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
- void *opaque)
-{
- Monitor *mon = opaque;
-
- qemu_mutex_lock(&mon->mon_lock);
- mon->out_watch = 0;
- monitor_flush_locked(mon);
- qemu_mutex_unlock(&mon->mon_lock);
- return FALSE;
-}
-
-/* Caller must hold mon->mon_lock */
-static void monitor_flush_locked(Monitor *mon)
-{
- int rc;
- size_t len;
- const char *buf;
-
- if (mon->skip_flush) {
- return;
- }
-
- buf = qstring_get_str(mon->outbuf);
- len = qstring_get_length(mon->outbuf);
-
- if (len && !mon->mux_out) {
- rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
- if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
- /* all flushed or error */
- qobject_unref(mon->outbuf);
- mon->outbuf = qstring_new();
- return;
- }
- if (rc > 0) {
- /* partial write */
- QString *tmp = qstring_from_str(buf + rc);
- qobject_unref(mon->outbuf);
- mon->outbuf = tmp;
- }
- if (mon->out_watch == 0) {
- mon->out_watch =
- qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
- monitor_unblocked, mon);
- }
- }
-}
-
-void monitor_flush(Monitor *mon)
-{
- qemu_mutex_lock(&mon->mon_lock);
- monitor_flush_locked(mon);
- qemu_mutex_unlock(&mon->mon_lock);
-}
-
-/* flush at every end of line */
-int monitor_puts(Monitor *mon, const char *str)
-{
- int i;
- char c;
-
- qemu_mutex_lock(&mon->mon_lock);
- for (i = 0; str[i]; i++) {
- c = str[i];
- if (c == '\n') {
- qstring_append_chr(mon->outbuf, '\r');
- }
- qstring_append_chr(mon->outbuf, c);
- if (c == '\n') {
- monitor_flush_locked(mon);
- }
- }
- qemu_mutex_unlock(&mon->mon_lock);
-
- return i;
-}
-
-int monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
-{
- char *buf;
- int n;
-
- if (!mon)
- return -1;
-
- if (monitor_is_qmp(mon)) {
- return -1;
- }
-
- buf = g_strdup_vprintf(fmt, ap);
- n = monitor_puts(mon, buf);
- g_free(buf);
- return n;
-}
-
-int monitor_printf(Monitor *mon, const char *fmt, ...)
-{
- int ret;
-
- va_list ap;
- va_start(ap, fmt);
- ret = monitor_vprintf(mon, fmt, ap);
- va_end(ap);
- return ret;
-}
-
-static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
- /* Limit guest-triggerable events to 1 per second */
- [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
- [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
- [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
- [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
- [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
- [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
-};
-
-/*
- * Broadcast an event to all monitors.
- * @qdict is the event object. Its member "event" must match @event.
- * Caller must hold monitor_lock.
- */
-static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
-{
- Monitor *mon;
- MonitorQMP *qmp_mon;
-
- trace_monitor_protocol_event_emit(event, qdict);
- QTAILQ_FOREACH(mon, &mon_list, entry) {
- if (!monitor_is_qmp(mon)) {
- continue;
- }
-
- qmp_mon = container_of(mon, MonitorQMP, common);
- if (qmp_mon->commands != &qmp_cap_negotiation_commands) {
- qmp_send_response(qmp_mon, qdict);
- }
- }
-}
-
-static void monitor_qapi_event_handler(void *opaque);
-
-/*
- * Queue a new event for emission to Monitor instances,
- * applying any rate limiting if required.
- */
-static void
-monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
-{
- MonitorQAPIEventConf *evconf;
- MonitorQAPIEventState *evstate;
-
- assert(event < QAPI_EVENT__MAX);
- evconf = &monitor_qapi_event_conf[event];
- trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
-
- qemu_mutex_lock(&monitor_lock);
-
- if (!evconf->rate) {
- /* Unthrottled event */
- monitor_qapi_event_emit(event, qdict);
- } else {
- QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
- MonitorQAPIEventState key = { .event = event, .data = data };
-
- evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
- assert(!evstate || timer_pending(evstate->timer));
-
- if (evstate) {
- /*
- * Timer is pending for (at least) evconf->rate ns after
- * last send. Store event for sending when timer fires,
- * replacing a prior stored event if any.
- */
- qobject_unref(evstate->qdict);
- evstate->qdict = qobject_ref(qdict);
- } else {
- /*
- * Last send was (at least) evconf->rate ns ago.
- * Send immediately, and arm the timer to call
- * monitor_qapi_event_handler() in evconf->rate ns. Any
- * events arriving before then will be delayed until then.
- */
- int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
-
- monitor_qapi_event_emit(event, qdict);
-
- evstate = g_new(MonitorQAPIEventState, 1);
- evstate->event = event;
- evstate->data = qobject_ref(data);
- evstate->qdict = NULL;
- evstate->timer = timer_new_ns(monitor_get_event_clock(),
- monitor_qapi_event_handler,
- evstate);
- g_hash_table_add(monitor_qapi_event_state, evstate);
- timer_mod_ns(evstate->timer, now + evconf->rate);
- }
- }
-
- qemu_mutex_unlock(&monitor_lock);
-}
-
-void qapi_event_emit(QAPIEvent event, QDict *qdict)
-{
- /*
- * monitor_qapi_event_queue_no_reenter() is not reentrant: it
- * would deadlock on monitor_lock. Work around by queueing
- * events in thread-local storage.
- * TODO: remove this, make it re-enter safe.
- */
- typedef struct MonitorQapiEvent {
- QAPIEvent event;
- QDict *qdict;
- QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
- } MonitorQapiEvent;
- static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
- static __thread bool reentered;
- MonitorQapiEvent *ev;
-
- if (!reentered) {
- QSIMPLEQ_INIT(&event_queue);
- }
-
- ev = g_new(MonitorQapiEvent, 1);
- ev->qdict = qobject_ref(qdict);
- ev->event = event;
- QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
- if (reentered) {
- return;
- }
-
- reentered = true;
-
- while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
- QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
- monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
- qobject_unref(ev->qdict);
- g_free(ev);
- }
-
- reentered = false;
-}
-
-/*
- * This function runs evconf->rate ns after sending a throttled
- * event.
- * If another event has since been stored, send it.
- */
-static void monitor_qapi_event_handler(void *opaque)
-{
- MonitorQAPIEventState *evstate = opaque;
- MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
-
- trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
- qemu_mutex_lock(&monitor_lock);
-
- if (evstate->qdict) {
- int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
-
- monitor_qapi_event_emit(evstate->event, evstate->qdict);
- qobject_unref(evstate->qdict);
- evstate->qdict = NULL;
- timer_mod_ns(evstate->timer, now + evconf->rate);
- } else {
- g_hash_table_remove(monitor_qapi_event_state, evstate);
- qobject_unref(evstate->data);
- timer_free(evstate->timer);
- g_free(evstate);
- }
-
- qemu_mutex_unlock(&monitor_lock);
-}
-
-static unsigned int qapi_event_throttle_hash(const void *key)
-{
- const MonitorQAPIEventState *evstate = key;
- unsigned int hash = evstate->event * 255;
-
- if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
- hash += g_str_hash(qdict_get_str(evstate->data, "id"));
- }
-
- if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
- hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
- }
-
- return hash;
-}
-
-static gboolean qapi_event_throttle_equal(const void *a, const void *b)
-{
- const MonitorQAPIEventState *eva = a;
- const MonitorQAPIEventState *evb = b;
-
- if (eva->event != evb->event) {
- return FALSE;
- }
-
- if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
- return !strcmp(qdict_get_str(eva->data, "id"),
- qdict_get_str(evb->data, "id"));
- }
-
- if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
- return !strcmp(qdict_get_str(eva->data, "node-name"),
- qdict_get_str(evb->data, "node-name"));
- }
-
- return TRUE;
-}
-
-static void monitor_qapi_event_init(void)
-{
- monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
- qapi_event_throttle_equal);
-}
-
-static void monitor_iothread_init(void);
-
-void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
- bool use_io_thread)
-{
- if (use_io_thread && !mon_iothread) {
- monitor_iothread_init();
- }
- qemu_mutex_init(&mon->mon_lock);
- mon->outbuf = qstring_new();
- mon->skip_flush = skip_flush;
- mon->use_io_thread = use_io_thread;
- mon->flags = flags;
-}
-
-static void monitor_data_destroy(Monitor *mon)
-{
- g_free(mon->mon_cpu_path);
- qemu_chr_fe_deinit(&mon->chr, false);
- if (monitor_is_qmp(mon)) {
- monitor_data_destroy_qmp(container_of(mon, MonitorQMP, common));
- } else {
- readline_free(container_of(mon, MonitorHMP, common)->rs);
- }
- qobject_unref(mon->outbuf);
- qemu_mutex_destroy(&mon->mon_lock);
-}
-
char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
int64_t cpu_index, Error **errp)
{
@@ -2728,67 +2314,6 @@ void loadvm_completion(ReadLineState *rs, int nb_args, const char *str)
}
}
-int monitor_can_read(void *opaque)
-{
- Monitor *mon = opaque;
-
- return !atomic_mb_read(&mon->suspend_cnt);
-}
-
-int monitor_suspend(Monitor *mon)
-{
- if (monitor_is_hmp_non_interactive(mon)) {
- return -ENOTTY;
- }
-
- atomic_inc(&mon->suspend_cnt);
-
- if (mon->use_io_thread) {
- /*
- * Kick I/O thread to make sure this takes effect. It'll be
- * evaluated again in prepare() of the watch object.
- */
- aio_notify(iothread_get_aio_context(mon_iothread));
- }
-
- trace_monitor_suspend(mon, 1);
- return 0;
-}
-
-static void monitor_accept_input(void *opaque)
-{
- Monitor *mon = opaque;
-
- qemu_chr_fe_accept_input(&mon->chr);
-}
-
-void monitor_resume(Monitor *mon)
-{
- if (monitor_is_hmp_non_interactive(mon)) {
- return;
- }
-
- if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
- AioContext *ctx;
-
- if (mon->use_io_thread) {
- ctx = iothread_get_aio_context(mon_iothread);
- } else {
- ctx = qemu_get_aio_context();
- }
-
- if (!monitor_is_qmp(mon)) {
- MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
- assert(hmp_mon->rs);
- readline_show_prompt(hmp_mon->rs);
- }
-
- aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
- }
-
- trace_monitor_suspend(mon, -1);
-}
-
static int
compare_mon_cmd(const void *a, const void *b)
{
@@ -2806,135 +2331,14 @@ static void sortcmdlist(void)
compare_mon_cmd);
}
-static void monitor_iothread_init(void)
-{
- mon_iothread = iothread_create("mon_iothread", &error_abort);
-}
-
void monitor_init_globals(void)
{
+ monitor_init_globals_core();
monitor_init_qmp_commands();
- monitor_qapi_event_init();
sortcmdlist();
- qemu_mutex_init(&monitor_lock);
qemu_mutex_init(&mon_fdsets_lock);
-
- /*
- * The dispatcher BH must run in the main loop thread, since we
- * have commands assuming that context. It would be nice to get
- * rid of those assumptions.
- */
- qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
- monitor_qmp_bh_dispatcher,
- NULL);
}
-/*
- * Print to current monitor if we have one, else to stderr.
- */
-int error_vprintf(const char *fmt, va_list ap)
-{
- if (cur_mon && !monitor_cur_is_qmp()) {
- return monitor_vprintf(cur_mon, fmt, ap);
- }
- return vfprintf(stderr, fmt, ap);
-}
-
-int error_vprintf_unless_qmp(const char *fmt, va_list ap)
-{
- if (!cur_mon) {
- return vfprintf(stderr, fmt, ap);
- }
- if (!monitor_cur_is_qmp()) {
- return monitor_vprintf(cur_mon, fmt, ap);
- }
- return -1;
-}
-
-void monitor_list_append(Monitor *mon)
-{
- qemu_mutex_lock(&monitor_lock);
- /*
- * This prevents inserting new monitors during monitor_cleanup().
- * A cleaner solution would involve the main thread telling other
- * threads to terminate, waiting for their termination.
- */
- if (!monitor_destroyed) {
- QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
- mon = NULL;
- }
- qemu_mutex_unlock(&monitor_lock);
-
- if (mon) {
- monitor_data_destroy(mon);
- g_free(mon);
- }
-}
-
-void monitor_init(Chardev *chr, int flags)
-{
- if (flags & MONITOR_USE_CONTROL) {
- monitor_init_qmp(chr, flags);
- } else {
- monitor_init_hmp(chr, flags);
- }
-}
-
-void monitor_cleanup(void)
-{
- /*
- * We need to explicitly stop the I/O thread (but not destroy it),
- * clean up the monitor resources, then destroy the I/O thread since
- * we need to unregister from chardev below in
- * monitor_data_destroy(), and chardev is not thread-safe yet
- */
- if (mon_iothread) {
- iothread_stop(mon_iothread);
- }
-
- /* Flush output buffers and destroy monitors */
- qemu_mutex_lock(&monitor_lock);
- monitor_destroyed = true;
- while (!QTAILQ_EMPTY(&mon_list)) {
- Monitor *mon = QTAILQ_FIRST(&mon_list);
- QTAILQ_REMOVE(&mon_list, mon, entry);
- /* Permit QAPI event emission from character frontend release */
- qemu_mutex_unlock(&monitor_lock);
- monitor_flush(mon);
- monitor_data_destroy(mon);
- qemu_mutex_lock(&monitor_lock);
- g_free(mon);
- }
- qemu_mutex_unlock(&monitor_lock);
-
- /* QEMUBHs needs to be deleted before destroying the I/O thread */
- qemu_bh_delete(qmp_dispatcher_bh);
- qmp_dispatcher_bh = NULL;
- if (mon_iothread) {
- iothread_destroy(mon_iothread);
- mon_iothread = NULL;
- }
-}
-
-QemuOptsList qemu_mon_opts = {
- .name = "mon",
- .implied_opt_name = "chardev",
- .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
- .desc = {
- {
- .name = "mode",
- .type = QEMU_OPT_STRING,
- },{
- .name = "chardev",
- .type = QEMU_OPT_STRING,
- },{
- .name = "pretty",
- .type = QEMU_OPT_BOOL,
- },
- { /* end of list */ }
- },
-};
-
HotpluggableCPUList *qmp_query_hotpluggable_cpus(Error **errp)
{
MachineState *ms = MACHINE(qdev_get_machine());
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index 10fda7d97c..b4996c14ac 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -167,6 +167,7 @@ void monitor_init_hmp(Chardev *chr, int flags);
int monitor_puts(Monitor *mon, const char *str);
void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
bool use_io_thread);
+void monitor_data_destroy(Monitor *mon);
int monitor_can_read(void *opaque);
void monitor_list_append(Monitor *mon);
void monitor_fdsets_cleanup(void);
diff --git a/monitor/monitor.c b/monitor/monitor.c
new file mode 100644
index 0000000000..db3d5ece99
--- /dev/null
+++ b/monitor/monitor.c
@@ -0,0 +1,633 @@
+/*
+ * QEMU monitor
+ *
+ * Copyright (c) 2003-2004 Fabrice Bellard
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "qemu/osdep.h"
+#include "monitor-internal.h"
+#include "qapi/error.h"
+#include "qapi/qapi-emit-events.h"
+#include "qapi/qmp/qdict.h"
+#include "qapi/qmp/qstring.h"
+#include "qemu/error-report.h"
+#include "qemu/option.h"
+#include "sysemu/qtest.h"
+#include "trace.h"
+
+/*
+ * To prevent flooding clients, events can be throttled. The
+ * throttling is calculated globally, rather than per-Monitor
+ * instance.
+ */
+typedef struct MonitorQAPIEventState {
+ QAPIEvent event; /* Throttling state for this event type and... */
+ QDict *data; /* ... data, see qapi_event_throttle_equal() */
+ QEMUTimer *timer; /* Timer for handling delayed events */
+ QDict *qdict; /* Delayed event (if any) */
+} MonitorQAPIEventState;
+
+typedef struct {
+ int64_t rate; /* Minimum time (in ns) between two events */
+} MonitorQAPIEventConf;
+
+/* Shared monitor I/O thread */
+IOThread *mon_iothread;
+
+/* Bottom half to dispatch the requests received from I/O thread */
+QEMUBH *qmp_dispatcher_bh;
+
+/* Protects mon_list, monitor_qapi_event_state, monitor_destroyed. */
+QemuMutex monitor_lock;
+static GHashTable *monitor_qapi_event_state;
+
+MonitorList mon_list;
+int mon_refcount;
+static bool monitor_destroyed;
+
+__thread Monitor *cur_mon;
+
+/**
+ * Is the current monitor, if any, a QMP monitor?
+ */
+bool monitor_cur_is_qmp(void)
+{
+ return cur_mon && monitor_is_qmp(cur_mon);
+}
+
+/**
+ * Is @mon is using readline?
+ * Note: not all HMP monitors use readline, e.g., gdbserver has a
+ * non-interactive HMP monitor, so readline is not used there.
+ */
+static inline bool monitor_uses_readline(const Monitor *mon)
+{
+ return mon->flags & MONITOR_USE_READLINE;
+}
+
+static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
+{
+ return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
+}
+
+static void monitor_flush_locked(Monitor *mon);
+
+static gboolean monitor_unblocked(GIOChannel *chan, GIOCondition cond,
+ void *opaque)
+{
+ Monitor *mon = opaque;
+
+ qemu_mutex_lock(&mon->mon_lock);
+ mon->out_watch = 0;
+ monitor_flush_locked(mon);
+ qemu_mutex_unlock(&mon->mon_lock);
+ return FALSE;
+}
+
+/* Caller must hold mon->mon_lock */
+static void monitor_flush_locked(Monitor *mon)
+{
+ int rc;
+ size_t len;
+ const char *buf;
+
+ if (mon->skip_flush) {
+ return;
+ }
+
+ buf = qstring_get_str(mon->outbuf);
+ len = qstring_get_length(mon->outbuf);
+
+ if (len && !mon->mux_out) {
+ rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
+ if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
+ /* all flushed or error */
+ qobject_unref(mon->outbuf);
+ mon->outbuf = qstring_new();
+ return;
+ }
+ if (rc > 0) {
+ /* partial write */
+ QString *tmp = qstring_from_str(buf + rc);
+ qobject_unref(mon->outbuf);
+ mon->outbuf = tmp;
+ }
+ if (mon->out_watch == 0) {
+ mon->out_watch =
+ qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
+ monitor_unblocked, mon);
+ }
+ }
+}
+
+void monitor_flush(Monitor *mon)
+{
+ qemu_mutex_lock(&mon->mon_lock);
+ monitor_flush_locked(mon);
+ qemu_mutex_unlock(&mon->mon_lock);
+}
+
+/* flush at every end of line */
+int monitor_puts(Monitor *mon, const char *str)
+{
+ int i;
+ char c;
+
+ qemu_mutex_lock(&mon->mon_lock);
+ for (i = 0; str[i]; i++) {
+ c = str[i];
+ if (c == '\n') {
+ qstring_append_chr(mon->outbuf, '\r');
+ }
+ qstring_append_chr(mon->outbuf, c);
+ if (c == '\n') {
+ monitor_flush_locked(mon);
+ }
+ }
+ qemu_mutex_unlock(&mon->mon_lock);
+
+ return i;
+}
+
+int monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
+{
+ char *buf;
+ int n;
+
+ if (!mon) {
+ return -1;
+ }
+
+ if (monitor_is_qmp(mon)) {
+ return -1;
+ }
+
+ buf = g_strdup_vprintf(fmt, ap);
+ n = monitor_puts(mon, buf);
+ g_free(buf);
+ return n;
+}
+
+int monitor_printf(Monitor *mon, const char *fmt, ...)
+{
+ int ret;
+
+ va_list ap;
+ va_start(ap, fmt);
+ ret = monitor_vprintf(mon, fmt, ap);
+ va_end(ap);
+ return ret;
+}
+
+/*
+ * Print to current monitor if we have one, else to stderr.
+ */
+int error_vprintf(const char *fmt, va_list ap)
+{
+ if (cur_mon && !monitor_cur_is_qmp()) {
+ return monitor_vprintf(cur_mon, fmt, ap);
+ }
+ return vfprintf(stderr, fmt, ap);
+}
+
+int error_vprintf_unless_qmp(const char *fmt, va_list ap)
+{
+ if (!cur_mon) {
+ return vfprintf(stderr, fmt, ap);
+ }
+ if (!monitor_cur_is_qmp()) {
+ return monitor_vprintf(cur_mon, fmt, ap);
+ }
+ return -1;
+}
+
+
+static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
+ /* Limit guest-triggerable events to 1 per second */
+ [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
+ [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
+ [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
+ [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
+ [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
+ [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
+};
+
+/*
+ * Return the clock to use for recording an event's time.
+ * It's QEMU_CLOCK_REALTIME, except for qtests it's
+ * QEMU_CLOCK_VIRTUAL, to support testing rate limits.
+ * Beware: result is invalid before configure_accelerator().
+ */
+static inline QEMUClockType monitor_get_event_clock(void)
+{
+ return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
+}
+
+/*
+ * Broadcast an event to all monitors.
+ * @qdict is the event object. Its member "event" must match @event.
+ * Caller must hold monitor_lock.
+ */
+static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
+{
+ Monitor *mon;
+ MonitorQMP *qmp_mon;
+
+ trace_monitor_protocol_event_emit(event, qdict);
+ QTAILQ_FOREACH(mon, &mon_list, entry) {
+ if (!monitor_is_qmp(mon)) {
+ continue;
+ }
+
+ qmp_mon = container_of(mon, MonitorQMP, common);
+ if (qmp_mon->commands != &qmp_cap_negotiation_commands) {
+ qmp_send_response(qmp_mon, qdict);
+ }
+ }
+}
+
+static void monitor_qapi_event_handler(void *opaque);
+
+/*
+ * Queue a new event for emission to Monitor instances,
+ * applying any rate limiting if required.
+ */
+static void
+monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
+{
+ MonitorQAPIEventConf *evconf;
+ MonitorQAPIEventState *evstate;
+
+ assert(event < QAPI_EVENT__MAX);
+ evconf = &monitor_qapi_event_conf[event];
+ trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
+
+ qemu_mutex_lock(&monitor_lock);
+
+ if (!evconf->rate) {
+ /* Unthrottled event */
+ monitor_qapi_event_emit(event, qdict);
+ } else {
+ QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
+ MonitorQAPIEventState key = { .event = event, .data = data };
+
+ evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
+ assert(!evstate || timer_pending(evstate->timer));
+
+ if (evstate) {
+ /*
+ * Timer is pending for (at least) evconf->rate ns after
+ * last send. Store event for sending when timer fires,
+ * replacing a prior stored event if any.
+ */
+ qobject_unref(evstate->qdict);
+ evstate->qdict = qobject_ref(qdict);
+ } else {
+ /*
+ * Last send was (at least) evconf->rate ns ago.
+ * Send immediately, and arm the timer to call
+ * monitor_qapi_event_handler() in evconf->rate ns. Any
+ * events arriving before then will be delayed until then.
+ */
+ int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
+
+ monitor_qapi_event_emit(event, qdict);
+
+ evstate = g_new(MonitorQAPIEventState, 1);
+ evstate->event = event;
+ evstate->data = qobject_ref(data);
+ evstate->qdict = NULL;
+ evstate->timer = timer_new_ns(monitor_get_event_clock(),
+ monitor_qapi_event_handler,
+ evstate);
+ g_hash_table_add(monitor_qapi_event_state, evstate);
+ timer_mod_ns(evstate->timer, now + evconf->rate);
+ }
+ }
+
+ qemu_mutex_unlock(&monitor_lock);
+}
+
+void qapi_event_emit(QAPIEvent event, QDict *qdict)
+{
+ /*
+ * monitor_qapi_event_queue_no_reenter() is not reentrant: it
+ * would deadlock on monitor_lock. Work around by queueing
+ * events in thread-local storage.
+ * TODO: remove this, make it re-enter safe.
+ */
+ typedef struct MonitorQapiEvent {
+ QAPIEvent event;
+ QDict *qdict;
+ QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
+ } MonitorQapiEvent;
+ static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
+ static __thread bool reentered;
+ MonitorQapiEvent *ev;
+
+ if (!reentered) {
+ QSIMPLEQ_INIT(&event_queue);
+ }
+
+ ev = g_new(MonitorQapiEvent, 1);
+ ev->qdict = qobject_ref(qdict);
+ ev->event = event;
+ QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
+ if (reentered) {
+ return;
+ }
+
+ reentered = true;
+
+ while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
+ QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
+ monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
+ qobject_unref(ev->qdict);
+ g_free(ev);
+ }
+
+ reentered = false;
+}
+
+/*
+ * This function runs evconf->rate ns after sending a throttled
+ * event.
+ * If another event has since been stored, send it.
+ */
+static void monitor_qapi_event_handler(void *opaque)
+{
+ MonitorQAPIEventState *evstate = opaque;
+ MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
+
+ trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
+ qemu_mutex_lock(&monitor_lock);
+
+ if (evstate->qdict) {
+ int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
+
+ monitor_qapi_event_emit(evstate->event, evstate->qdict);
+ qobject_unref(evstate->qdict);
+ evstate->qdict = NULL;
+ timer_mod_ns(evstate->timer, now + evconf->rate);
+ } else {
+ g_hash_table_remove(monitor_qapi_event_state, evstate);
+ qobject_unref(evstate->data);
+ timer_free(evstate->timer);
+ g_free(evstate);
+ }
+
+ qemu_mutex_unlock(&monitor_lock);
+}
+
+static unsigned int qapi_event_throttle_hash(const void *key)
+{
+ const MonitorQAPIEventState *evstate = key;
+ unsigned int hash = evstate->event * 255;
+
+ if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
+ hash += g_str_hash(qdict_get_str(evstate->data, "id"));
+ }
+
+ if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
+ hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
+ }
+
+ return hash;
+}
+
+static gboolean qapi_event_throttle_equal(const void *a, const void *b)
+{
+ const MonitorQAPIEventState *eva = a;
+ const MonitorQAPIEventState *evb = b;
+
+ if (eva->event != evb->event) {
+ return FALSE;
+ }
+
+ if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
+ return !strcmp(qdict_get_str(eva->data, "id"),
+ qdict_get_str(evb->data, "id"));
+ }
+
+ if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
+ return !strcmp(qdict_get_str(eva->data, "node-name"),
+ qdict_get_str(evb->data, "node-name"));
+ }
+
+ return TRUE;
+}
+
+int monitor_suspend(Monitor *mon)
+{
+ if (monitor_is_hmp_non_interactive(mon)) {
+ return -ENOTTY;
+ }
+
+ atomic_inc(&mon->suspend_cnt);
+
+ if (mon->use_io_thread) {
+ /*
+ * Kick I/O thread to make sure this takes effect. It'll be
+ * evaluated again in prepare() of the watch object.
+ */
+ aio_notify(iothread_get_aio_context(mon_iothread));
+ }
+
+ trace_monitor_suspend(mon, 1);
+ return 0;
+}
+
+static void monitor_accept_input(void *opaque)
+{
+ Monitor *mon = opaque;
+
+ qemu_chr_fe_accept_input(&mon->chr);
+}
+
+void monitor_resume(Monitor *mon)
+{
+ if (monitor_is_hmp_non_interactive(mon)) {
+ return;
+ }
+
+ if (atomic_dec_fetch(&mon->suspend_cnt) == 0) {
+ AioContext *ctx;
+
+ if (mon->use_io_thread) {
+ ctx = iothread_get_aio_context(mon_iothread);
+ } else {
+ ctx = qemu_get_aio_context();
+ }
+
+ if (!monitor_is_qmp(mon)) {
+ MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
+ assert(hmp_mon->rs);
+ readline_show_prompt(hmp_mon->rs);
+ }
+
+ aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
+ }
+
+ trace_monitor_suspend(mon, -1);
+}
+
+int monitor_can_read(void *opaque)
+{
+ Monitor *mon = opaque;
+
+ return !atomic_mb_read(&mon->suspend_cnt);
+}
+
+void monitor_list_append(Monitor *mon)
+{
+ qemu_mutex_lock(&monitor_lock);
+ /*
+ * This prevents inserting new monitors during monitor_cleanup().
+ * A cleaner solution would involve the main thread telling other
+ * threads to terminate, waiting for their termination.
+ */
+ if (!monitor_destroyed) {
+ QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
+ mon = NULL;
+ }
+ qemu_mutex_unlock(&monitor_lock);
+
+ if (mon) {
+ monitor_data_destroy(mon);
+ g_free(mon);
+ }
+}
+
+static void monitor_iothread_init(void)
+{
+ mon_iothread = iothread_create("mon_iothread", &error_abort);
+}
+
+void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
+ bool use_io_thread)
+{
+ if (use_io_thread && !mon_iothread) {
+ monitor_iothread_init();
+ }
+ qemu_mutex_init(&mon->mon_lock);
+ mon->outbuf = qstring_new();
+ mon->skip_flush = skip_flush;
+ mon->use_io_thread = use_io_thread;
+ mon->flags = flags;
+}
+
+void monitor_data_destroy(Monitor *mon)
+{
+ g_free(mon->mon_cpu_path);
+ qemu_chr_fe_deinit(&mon->chr, false);
+ if (monitor_is_qmp(mon)) {
+ monitor_data_destroy_qmp(container_of(mon, MonitorQMP, common));
+ } else {
+ readline_free(container_of(mon, MonitorHMP, common)->rs);
+ }
+ qobject_unref(mon->outbuf);
+ qemu_mutex_destroy(&mon->mon_lock);
+}
+
+void monitor_init(Chardev *chr, int flags)
+{
+ if (flags & MONITOR_USE_CONTROL) {
+ monitor_init_qmp(chr, flags);
+ } else {
+ monitor_init_hmp(chr, flags);
+ }
+}
+
+void monitor_cleanup(void)
+{
+ /*
+ * We need to explicitly stop the I/O thread (but not destroy it),
+ * clean up the monitor resources, then destroy the I/O thread since
+ * we need to unregister from chardev below in
+ * monitor_data_destroy(), and chardev is not thread-safe yet
+ */
+ if (mon_iothread) {
+ iothread_stop(mon_iothread);
+ }
+
+ /* Flush output buffers and destroy monitors */
+ qemu_mutex_lock(&monitor_lock);
+ monitor_destroyed = true;
+ while (!QTAILQ_EMPTY(&mon_list)) {
+ Monitor *mon = QTAILQ_FIRST(&mon_list);
+ QTAILQ_REMOVE(&mon_list, mon, entry);
+ /* Permit QAPI event emission from character frontend release */
+ qemu_mutex_unlock(&monitor_lock);
+ monitor_flush(mon);
+ monitor_data_destroy(mon);
+ qemu_mutex_lock(&monitor_lock);
+ g_free(mon);
+ }
+ qemu_mutex_unlock(&monitor_lock);
+
+ /* QEMUBHs needs to be deleted before destroying the I/O thread */
+ qemu_bh_delete(qmp_dispatcher_bh);
+ qmp_dispatcher_bh = NULL;
+ if (mon_iothread) {
+ iothread_destroy(mon_iothread);
+ mon_iothread = NULL;
+ }
+}
+
+static void monitor_qapi_event_init(void)
+{
+ monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
+ qapi_event_throttle_equal);
+}
+
+void monitor_init_globals_core(void)
+{
+ monitor_qapi_event_init();
+ qemu_mutex_init(&monitor_lock);
+
+ /*
+ * The dispatcher BH must run in the main loop thread, since we
+ * have commands assuming that context. It would be nice to get
+ * rid of those assumptions.
+ */
+ qmp_dispatcher_bh = aio_bh_new(iohandler_get_aio_context(),
+ monitor_qmp_bh_dispatcher,
+ NULL);
+}
+
+QemuOptsList qemu_mon_opts = {
+ .name = "mon",
+ .implied_opt_name = "chardev",
+ .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
+ .desc = {
+ {
+ .name = "mode",
+ .type = QEMU_OPT_STRING,
+ },{
+ .name = "chardev",
+ .type = QEMU_OPT_STRING,
+ },{
+ .name = "pretty",
+ .type = QEMU_OPT_BOOL,
+ },
+ { /* end of list */ }
+ },
+};
diff --git a/monitor/trace-events b/monitor/trace-events
index 2285d26121..0365ac4d99 100644
--- a/monitor/trace-events
+++ b/monitor/trace-events
@@ -3,7 +3,7 @@
# hmp.c
handle_hmp_command(void *mon, const char *cmdline) "mon %p cmdline: %s"
-# misc.c
+# monitor.c
monitor_protocol_event_handler(uint32_t event, void *qdict) "event=%d data=%p"
monitor_protocol_event_emit(uint32_t event, void *data) "event=%d data=%p"
monitor_protocol_event_queue(uint32_t event, void *qdict, uint64_t rate) "event=%d data=%p rate=%" PRId64
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 14/16] monitor: Split Monitor.flags into separate bools
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (12 preceding siblings ...)
2019-06-17 18:49 ` [Qemu-devel] [PULL 13/16] monitor: Split out monitor/monitor.c Markus Armbruster
@ 2019-06-17 18:49 ` Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 15/16] monitor: Replace monitor_init() with monitor_init_{hmp, qmp}() Markus Armbruster
` (4 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:49 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
Monitor.flags contains three different flags: One to distinguish HMP
from QMP; one specific to HMP (MONITOR_USE_READLINE) that is ignored
with QMP; and another one specific to QMP (MONITOR_USE_PRETTY) that is
ignored with HMP.
Split the flags field into three bools and move them to the right
subclass. Flags are still in use for the monitor_init() interface.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-14-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
monitor/hmp.c | 6 +++---
monitor/misc.c | 2 +-
monitor/monitor-internal.h | 8 +++++---
monitor/monitor.c | 14 +++++++++-----
monitor/qmp.c | 7 ++++---
5 files changed, 22 insertions(+), 15 deletions(-)
diff --git a/monitor/hmp.c b/monitor/hmp.c
index 86e86c1cf1..07f827c90c 100644
--- a/monitor/hmp.c
+++ b/monitor/hmp.c
@@ -1397,12 +1397,12 @@ static void monitor_readline_flush(void *opaque)
void monitor_init_hmp(Chardev *chr, int flags)
{
MonitorHMP *mon = g_new0(MonitorHMP, 1);
- bool use_readline = flags & MONITOR_USE_READLINE;
- monitor_data_init(&mon->common, flags, false, false);
+ monitor_data_init(&mon->common, false, false, false);
qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
- if (use_readline) {
+ mon->use_readline = flags & MONITOR_USE_READLINE;
+ if (mon->use_readline) {
mon->rs = readline_init(monitor_readline_printf,
monitor_readline_flush,
mon,
diff --git a/monitor/misc.c b/monitor/misc.c
index 002aba1030..10f24673f8 100644
--- a/monitor/misc.c
+++ b/monitor/misc.c
@@ -121,7 +121,7 @@ char *qmp_human_monitor_command(const char *command_line, bool has_cpu_index,
Monitor *old_mon;
MonitorHMP hmp = {};
- monitor_data_init(&hmp.common, 0, true, false);
+ monitor_data_init(&hmp.common, false, true, false);
old_mon = cur_mon;
cur_mon = &hmp.common;
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index b4996c14ac..03ea0239ef 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -86,8 +86,8 @@ typedef struct HMPCommand {
struct Monitor {
CharBackend chr;
int reset_seen;
- int flags;
int suspend_cnt; /* Needs to be accessed atomically */
+ bool is_qmp;
bool skip_flush;
bool use_io_thread;
@@ -112,6 +112,7 @@ struct Monitor {
struct MonitorHMP {
Monitor common;
+ bool use_readline;
/*
* State used only in the thread "owning" the monitor.
* If @use_io_thread, this is @mon_iothread. (This does not actually happen
@@ -125,6 +126,7 @@ struct MonitorHMP {
typedef struct {
Monitor common;
JSONMessageParser parser;
+ bool pretty;
/*
* When a client connects, we're in capabilities negotiation mode.
* @commands is &qmp_cap_negotiation_commands then. When command
@@ -148,7 +150,7 @@ typedef struct {
*/
static inline bool monitor_is_qmp(const Monitor *mon)
{
- return mon->flags & MONITOR_USE_CONTROL;
+ return mon->is_qmp;
}
typedef QTAILQ_HEAD(MonitorList, Monitor) MonitorList;
@@ -165,7 +167,7 @@ void monitor_init_qmp(Chardev *chr, int flags);
void monitor_init_hmp(Chardev *chr, int flags);
int monitor_puts(Monitor *mon, const char *str);
-void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
+void monitor_data_init(Monitor *mon, bool is_qmp, bool skip_flush,
bool use_io_thread);
void monitor_data_destroy(Monitor *mon);
int monitor_can_read(void *opaque);
diff --git a/monitor/monitor.c b/monitor/monitor.c
index db3d5ece99..3f4808240a 100644
--- a/monitor/monitor.c
+++ b/monitor/monitor.c
@@ -78,14 +78,18 @@ bool monitor_cur_is_qmp(void)
* Note: not all HMP monitors use readline, e.g., gdbserver has a
* non-interactive HMP monitor, so readline is not used there.
*/
-static inline bool monitor_uses_readline(const Monitor *mon)
+static inline bool monitor_uses_readline(const MonitorHMP *mon)
{
- return mon->flags & MONITOR_USE_READLINE;
+ return mon->use_readline;
}
static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
{
- return !monitor_is_qmp(mon) && !monitor_uses_readline(mon);
+ if (monitor_is_qmp(mon)) {
+ return false;
+ }
+
+ return !monitor_uses_readline(container_of(mon, MonitorHMP, common));
}
static void monitor_flush_locked(Monitor *mon);
@@ -521,17 +525,17 @@ static void monitor_iothread_init(void)
mon_iothread = iothread_create("mon_iothread", &error_abort);
}
-void monitor_data_init(Monitor *mon, int flags, bool skip_flush,
+void monitor_data_init(Monitor *mon, bool is_qmp, bool skip_flush,
bool use_io_thread)
{
if (use_io_thread && !mon_iothread) {
monitor_iothread_init();
}
qemu_mutex_init(&mon->mon_lock);
+ mon->is_qmp = is_qmp;
mon->outbuf = qstring_new();
mon->skip_flush = skip_flush;
mon->use_io_thread = use_io_thread;
- mon->flags = flags;
}
void monitor_data_destroy(Monitor *mon)
diff --git a/monitor/qmp.c b/monitor/qmp.c
index 7c3d081a72..940649f688 100644
--- a/monitor/qmp.c
+++ b/monitor/qmp.c
@@ -87,8 +87,7 @@ void qmp_send_response(MonitorQMP *mon, const QDict *rsp)
const QObject *data = QOBJECT(rsp);
QString *json;
- json = mon->common.flags & MONITOR_USE_PRETTY ?
- qobject_to_json_pretty(data) : qobject_to_json(data);
+ json = mon->pretty ? qobject_to_json_pretty(data) : qobject_to_json(data);
assert(json != NULL);
qstring_append_chr(json, '\n');
@@ -373,9 +372,11 @@ void monitor_init_qmp(Chardev *chr, int flags)
assert(!(flags & MONITOR_USE_READLINE));
/* Note: we run QMP monitor in I/O thread when @chr supports that */
- monitor_data_init(&mon->common, flags, false,
+ monitor_data_init(&mon->common, true, false,
qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT));
+ mon->pretty = flags & MONITOR_USE_PRETTY;
+
qemu_mutex_init(&mon->qmp_queue_lock);
mon->qmp_requests = g_queue_new();
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 15/16] monitor: Replace monitor_init() with monitor_init_{hmp, qmp}()
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (13 preceding siblings ...)
2019-06-17 18:49 ` [Qemu-devel] [PULL 14/16] monitor: Split Monitor.flags into separate bools Markus Armbruster
@ 2019-06-17 18:49 ` Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors Markus Armbruster
` (3 subsequent siblings)
18 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:49 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
Most callers know which monitor type they want to have. Instead of
calling monitor_init() with flags that can describe both types of
monitors, make monitor_init_{hmp,qmp}() public interfaces that take
specific bools instead of flags and call these functions directly.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-15-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
chardev/char.c | 2 +-
gdbstub.c | 2 +-
include/monitor/monitor.h | 9 ++-------
monitor/hmp.c | 4 ++--
monitor/monitor-internal.h | 3 ---
monitor/monitor.c | 9 ---------
monitor/qmp.c | 7 ++-----
stubs/monitor.c | 6 +++++-
tests/test-util-sockets.c | 3 ++-
vl.c | 18 ++++++++++++------
10 files changed, 27 insertions(+), 36 deletions(-)
diff --git a/chardev/char.c b/chardev/char.c
index e4887bcc82..7b6b2cb123 100644
--- a/chardev/char.c
+++ b/chardev/char.c
@@ -731,7 +731,7 @@ Chardev *qemu_chr_new_noreplay(const char *label, const char *filename,
if (qemu_opt_get_bool(opts, "mux", 0)) {
assert(permit_mux_mon);
- monitor_init(chr, MONITOR_USE_READLINE);
+ monitor_init_hmp(chr, true);
}
out:
diff --git a/gdbstub.c b/gdbstub.c
index d614a1f3c0..8618e34311 100644
--- a/gdbstub.c
+++ b/gdbstub.c
@@ -3344,7 +3344,7 @@ int gdbserver_start(const char *device)
/* Initialize a monitor terminal for gdb */
mon_chr = qemu_chardev_new(NULL, TYPE_CHARDEV_GDB,
NULL, NULL, &error_abort);
- monitor_init(mon_chr, 0);
+ monitor_init_hmp(mon_chr, false);
} else {
qemu_chr_fe_deinit(&s->chr, true);
mon_chr = s->mon_chr;
diff --git a/include/monitor/monitor.h b/include/monitor/monitor.h
index 44ac43df34..a81eeff5f8 100644
--- a/include/monitor/monitor.h
+++ b/include/monitor/monitor.h
@@ -8,19 +8,14 @@
extern __thread Monitor *cur_mon;
typedef struct MonitorHMP MonitorHMP;
-/* flags for monitor_init */
-/* 0x01 unused */
-#define MONITOR_USE_READLINE 0x02
-#define MONITOR_USE_CONTROL 0x04
-#define MONITOR_USE_PRETTY 0x08
-
#define QMP_REQ_QUEUE_LEN_MAX 8
bool monitor_cur_is_qmp(void);
void monitor_init_globals(void);
void monitor_init_globals_core(void);
-void monitor_init(Chardev *chr, int flags);
+void monitor_init_qmp(Chardev *chr, bool pretty);
+void monitor_init_hmp(Chardev *chr, bool use_readline);
void monitor_cleanup(void);
int monitor_suspend(Monitor *mon);
diff --git a/monitor/hmp.c b/monitor/hmp.c
index 07f827c90c..5349a81307 100644
--- a/monitor/hmp.c
+++ b/monitor/hmp.c
@@ -1394,14 +1394,14 @@ static void monitor_readline_flush(void *opaque)
monitor_flush(&mon->common);
}
-void monitor_init_hmp(Chardev *chr, int flags)
+void monitor_init_hmp(Chardev *chr, bool use_readline)
{
MonitorHMP *mon = g_new0(MonitorHMP, 1);
monitor_data_init(&mon->common, false, false, false);
qemu_chr_fe_init(&mon->common.chr, chr, &error_abort);
- mon->use_readline = flags & MONITOR_USE_READLINE;
+ mon->use_readline = use_readline;
if (mon->use_readline) {
mon->rs = readline_init(monitor_readline_printf,
monitor_readline_flush,
diff --git a/monitor/monitor-internal.h b/monitor/monitor-internal.h
index 03ea0239ef..7760b22ba3 100644
--- a/monitor/monitor-internal.h
+++ b/monitor/monitor-internal.h
@@ -163,9 +163,6 @@ extern int mon_refcount;
extern HMPCommand hmp_cmds[];
-void monitor_init_qmp(Chardev *chr, int flags);
-void monitor_init_hmp(Chardev *chr, int flags);
-
int monitor_puts(Monitor *mon, const char *str);
void monitor_data_init(Monitor *mon, bool is_qmp, bool skip_flush,
bool use_io_thread);
diff --git a/monitor/monitor.c b/monitor/monitor.c
index 3f4808240a..3ef28171c0 100644
--- a/monitor/monitor.c
+++ b/monitor/monitor.c
@@ -551,15 +551,6 @@ void monitor_data_destroy(Monitor *mon)
qemu_mutex_destroy(&mon->mon_lock);
}
-void monitor_init(Chardev *chr, int flags)
-{
- if (flags & MONITOR_USE_CONTROL) {
- monitor_init_qmp(chr, flags);
- } else {
- monitor_init_hmp(chr, flags);
- }
-}
-
void monitor_cleanup(void)
{
/*
diff --git a/monitor/qmp.c b/monitor/qmp.c
index 940649f688..e1b196217d 100644
--- a/monitor/qmp.c
+++ b/monitor/qmp.c
@@ -364,18 +364,15 @@ static void monitor_qmp_setup_handlers_bh(void *opaque)
monitor_list_append(&mon->common);
}
-void monitor_init_qmp(Chardev *chr, int flags)
+void monitor_init_qmp(Chardev *chr, bool pretty)
{
MonitorQMP *mon = g_new0(MonitorQMP, 1);
- /* Only HMP supports readline */
- assert(!(flags & MONITOR_USE_READLINE));
-
/* Note: we run QMP monitor in I/O thread when @chr supports that */
monitor_data_init(&mon->common, true, false,
qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_GCONTEXT));
- mon->pretty = flags & MONITOR_USE_PRETTY;
+ mon->pretty = pretty;
qemu_mutex_init(&mon->qmp_queue_lock);
mon->qmp_requests = g_queue_new();
diff --git a/stubs/monitor.c b/stubs/monitor.c
index cdbf5c5f9a..c3e9a2e4dc 100644
--- a/stubs/monitor.c
+++ b/stubs/monitor.c
@@ -16,7 +16,11 @@ int monitor_get_fd(Monitor *mon, const char *name, Error **errp)
return -1;
}
-void monitor_init(Chardev *chr, int flags)
+void monitor_init_qmp(Chardev *chr, bool pretty)
+{
+}
+
+void monitor_init_hmp(Chardev *chr, bool use_readline)
{
}
diff --git a/tests/test-util-sockets.c b/tests/test-util-sockets.c
index fd1ced058c..f1ebffee5a 100644
--- a/tests/test-util-sockets.c
+++ b/tests/test-util-sockets.c
@@ -71,7 +71,8 @@ int monitor_get_fd(Monitor *mon, const char *fdname, Error **errp)
*/
__thread Monitor *cur_mon;
int monitor_vprintf(Monitor *mon, const char *fmt, va_list ap) { abort(); }
-void monitor_init(Chardev *chr, int flags) {}
+void monitor_init_qmp(Chardev *chr, bool pretty) {}
+void monitor_init_hmp(Chardev *chr, bool use_readline) {}
static void test_socket_fd_pass_name_good(void)
diff --git a/vl.c b/vl.c
index 005468cbfb..32daa434eb 100644
--- a/vl.c
+++ b/vl.c
@@ -2299,25 +2299,27 @@ static int fsdev_init_func(void *opaque, QemuOpts *opts, Error **errp)
static int mon_init_func(void *opaque, QemuOpts *opts, Error **errp)
{
Chardev *chr;
+ bool qmp;
+ bool pretty = false;
const char *chardev;
const char *mode;
- int flags;
mode = qemu_opt_get(opts, "mode");
if (mode == NULL) {
mode = "readline";
}
if (strcmp(mode, "readline") == 0) {
- flags = MONITOR_USE_READLINE;
+ qmp = false;
} else if (strcmp(mode, "control") == 0) {
- flags = MONITOR_USE_CONTROL;
+ qmp = true;
} else {
error_setg(errp, "unknown monitor mode \"%s\"", mode);
return -1;
}
- if (qemu_opt_get_bool(opts, "pretty", 0))
- flags |= MONITOR_USE_PRETTY;
+ if (qemu_opt_get_bool(opts, "pretty", 0)) {
+ pretty = true;
+ }
chardev = qemu_opt_get(opts, "chardev");
if (!chardev) {
@@ -2330,7 +2332,11 @@ static int mon_init_func(void *opaque, QemuOpts *opts, Error **errp)
return -1;
}
- monitor_init(chr, flags);
+ if (qmp) {
+ monitor_init_qmp(chr, pretty);
+ } else {
+ monitor_init_hmp(chr, true);
+ }
return 0;
}
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (14 preceding siblings ...)
2019-06-17 18:49 ` [Qemu-devel] [PULL 15/16] monitor: Replace monitor_init() with monitor_init_{hmp, qmp}() Markus Armbruster
@ 2019-06-17 18:49 ` Markus Armbruster
2019-06-18 9:01 ` Daniel P. Berrangé
2019-06-17 18:58 ` [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Peter Maydell
` (2 subsequent siblings)
18 siblings, 1 reply; 26+ messages in thread
From: Markus Armbruster @ 2019-06-17 18:49 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf
From: Kevin Wolf <kwolf@redhat.com>
The -mon pretty=on|off switch of the -mon option applies only to QMP
monitors. It's silently ignored for HMP. Deprecate this combination so
that we can make it an error in future versions.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Message-Id: <20190613153405.24769-16-kwolf@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qemu-deprecated.texi | 6 ++++++
vl.c | 10 +++++++++-
2 files changed, 15 insertions(+), 1 deletion(-)
diff --git a/qemu-deprecated.texi b/qemu-deprecated.texi
index 50292d820b..df04f2840b 100644
--- a/qemu-deprecated.texi
+++ b/qemu-deprecated.texi
@@ -72,6 +72,12 @@ backend settings instead of environment variables. To ease migration to
the new format, the ``-audiodev-help'' option can be used to convert
the current values of the environment variables to ``-audiodev'' options.
+@subsection -mon ...,control=readline,pretty=on|off (since 4.1)
+
+The @code{pretty=on|off} switch has no effect for HMP monitors, but is
+silently ignored. Using the switch with HMP monitors will become an
+error in the future.
+
@subsection -realtime (since 4.1)
The @code{-realtime mlock=on|off} argument has been replaced by the
diff --git a/vl.c b/vl.c
index 32daa434eb..99a56b5556 100644
--- a/vl.c
+++ b/vl.c
@@ -2317,6 +2317,10 @@ static int mon_init_func(void *opaque, QemuOpts *opts, Error **errp)
return -1;
}
+ if (!qmp && qemu_opt_get(opts, "pretty")) {
+ warn_report("'pretty' is deprecated for HMP monitors, it has no effect "
+ "and will be removed in future versions");
+ }
if (qemu_opt_get_bool(opts, "pretty", 0)) {
pretty = true;
}
@@ -2362,7 +2366,11 @@ static void monitor_parse(const char *optarg, const char *mode, bool pretty)
opts = qemu_opts_create(qemu_find_opts("mon"), label, 1, &error_fatal);
qemu_opt_set(opts, "mode", mode, &error_abort);
qemu_opt_set(opts, "chardev", label, &error_abort);
- qemu_opt_set_bool(opts, "pretty", pretty, &error_abort);
+ if (!strcmp(mode, "control")) {
+ qemu_opt_set_bool(opts, "pretty", pretty, &error_abort);
+ } else {
+ assert(pretty == false);
+ }
monitor_device_index++;
}
--
2.21.0
^ permalink raw reply related [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (15 preceding siblings ...)
2019-06-17 18:49 ` [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors Markus Armbruster
@ 2019-06-17 18:58 ` Peter Maydell
2019-06-18 6:07 ` Markus Armbruster
2019-06-17 20:04 ` no-reply
2019-06-17 22:49 ` no-reply
18 siblings, 1 reply; 26+ messages in thread
From: Peter Maydell @ 2019-06-17 18:58 UTC (permalink / raw)
To: Markus Armbruster; +Cc: QEMU Developers
On Mon, 17 Jun 2019 at 19:51, Markus Armbruster <armbru@redhat.com> wrote:
>
> The following changes since commit 076243ffe6c1b687e9e6d98348c3bf3398df78f3:
>
> Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20190617' into staging (2019-06-17 16:41:25 +0100)
>
> are available in the Git repository at:
>
> git://repo.or.cz/qemu/armbru.git tags/pull-monitor-2019-06-17
>
> for you to fetch changes up to 092b8737c5e7695c4b9caa3b4eedc66763632755:
>
> vl: Deprecate -mon pretty=... for HMP monitors (2019-06-17 20:36:56 +0200)
>
> ----------------------------------------------------------------
> Monitor patches for 2019-06-17
>
Hi; I'm afraid this doesn't compile:
Most hosts (ppc64, s390, aarch64, aarch32, osx, and possibly
the others too though they haven't failed immediately) fail
something like this:
/home/pm215/qemu/monitor/misc.c: In function ‘netdev_del_completion’:
/home/pm215/qemu/monitor/misc.c:2165:9: error: implicit declaration of
function ‘qemu_find_opts_err’ [-Werror=implicit-function-declaration]
opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
^
/home/pm215/qemu/monitor/misc.c:2165:9: error: nested extern
declaration of ‘qemu_find_opts_err’ [-Werror=nested-externs]
/home/pm215/qemu/monitor/misc.c:2165:9: error: passing argument 1 of
‘qemu_opts_find’ makes pointer from integer without a cast [-Werror]
In file included from /home/pm215/qemu/monitor/misc.c:64:0:
/home/pm215/qemu/include/qemu/option.h:105:11: note: expected ‘struct
QemuOptsList *’ but argument is of type ‘int’
QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id);
^
cc1: all warnings being treated as errors
windows is a bit different:
/home/petmay01/qemu-for-merges/monitor/hmp.c: In function 'file_completion':
/home/petmay01/qemu-for-merges/monitor/hmp.c:1113:5: error: unknown
type name 'DIR'
DIR *ffs;
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1135:11: error: implicit
declaration of function 'opendir'
[-Werror=implicit-function-declaration]
ffs = opendir(path);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1135:5: error: nested
extern declaration of 'opendir' [-Werror=nested-externs]
ffs = opendir(path);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1135:9: error: assignment
makes pointer from integer without a cast [-Werror=int-conversion]
ffs = opendir(path);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1141:13: error: implicit
declaration of function 'readdir'
[-Werror=implicit-function-declaration]
d = readdir(ffs);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1141:9: error: nested
extern declaration of 'readdir' [-Werror=nested-externs]
d = readdir(ffs);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1141:11: error:
assignment makes pointer from integer without a cast
[-Werror=int-conversion]
d = readdir(ffs);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1146:21: error:
dereferencing pointer to incomplete type 'struct dirent'
if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1166:5: error: implicit
declaration of function 'closedir'
[-Werror=implicit-function-declaration]
closedir(ffs);
^
/home/petmay01/qemu-for-merges/monitor/hmp.c:1166:5: error: nested
extern declaration of 'closedir' [-Werror=nested-externs]
thanks
-- PMM
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (16 preceding siblings ...)
2019-06-17 18:58 ` [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Peter Maydell
@ 2019-06-17 20:04 ` no-reply
2019-06-17 22:49 ` no-reply
18 siblings, 0 replies; 26+ messages in thread
From: no-reply @ 2019-06-17 20:04 UTC (permalink / raw)
To: armbru; +Cc: qemu-devel
Patchew URL: https://patchew.org/QEMU/20190617184903.19436-1-armbru@redhat.com/
Hi,
This series seems to have some coding style problems. See output below for
more information:
Subject: [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17
Type: series
Message-id: 20190617184903.19436-1-armbru@redhat.com
=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===
Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
- [tag update] patchew/20190617175317.27557-1-peter.maydell@linaro.org -> patchew/20190617175317.27557-1-peter.maydell@linaro.org
Switched to a new branch 'test'
10cbb82 vl: Deprecate -mon pretty=... for HMP monitors
c8d6357 monitor: Replace monitor_init() with monitor_init_{hmp, qmp}()
add28d5 monitor: Split Monitor.flags into separate bools
61f535a monitor: Split out monitor/monitor.c
1f84df4 monitor: Split out monitor/hmp.c
7b0f436 monitor: Split out monitor/qmp.c
62fff9a monitor: Create monitor-internal.h with common definitions
0be87c8 monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c
9dc5b85 Move monitor.c to monitor/misc.c
32b2352 monitor: Rename HMP command type and tables
6259cf7 monitor: Remove Monitor.cmd_table indirection
4cc8716 monitor: Create MonitorHMP with readline state
e28b9ba monitor: Make MonitorQMP a child class of Monitor
0032c2c monitor: Split monitor_init in HMP and QMP function
8ef4253 monitor: Remove unused password prompting fields
f21701f monitor: Fix return type of monitor_fdset_dup_fd_find
=== OUTPUT BEGIN ===
1/16 Checking commit f21701f2afc2 (monitor: Fix return type of monitor_fdset_dup_fd_find)
2/16 Checking commit 8ef4253a4478 (monitor: Remove unused password prompting fields)
3/16 Checking commit 0032c2cf455d (monitor: Split monitor_init in HMP and QMP function)
4/16 Checking commit e28b9ba8e716 (monitor: Make MonitorQMP a child class of Monitor)
5/16 Checking commit 4cc8716de54a (monitor: Create MonitorHMP with readline state)
6/16 Checking commit 6259cf7f6c52 (monitor: Remove Monitor.cmd_table indirection)
7/16 Checking commit 32b235292bf6 (monitor: Rename HMP command type and tables)
8/16 Checking commit 9dc5b85526e4 (Move monitor.c to monitor/misc.c)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#82:
new file mode 100644
total: 0 errors, 1 warnings, 78 lines checked
Patch 8/16 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
9/16 Checking commit 0be87c866744 (monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#106:
rename from hmp.c
total: 0 errors, 1 warnings, 73 lines checked
Patch 9/16 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
10/16 Checking commit 62fff9aeab3c (monitor: Create monitor-internal.h with common definitions)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#227:
new file mode 100644
total: 0 errors, 1 warnings, 326 lines checked
Patch 10/16 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
11/16 Checking commit 7b0f43601c81 (monitor: Split out monitor/qmp.c)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#628:
new file mode 100644
total: 0 errors, 1 warnings, 984 lines checked
Patch 11/16 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
12/16 Checking commit 1f84df448bda (monitor: Split out monitor/hmp.c)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#33:
new file mode 100644
ERROR: consider using qemu_strtoull in preference to strtoull
#436: FILE: monitor/hmp.c:399:
+ n = strtoull(pch, &p, 0);
total: 1 errors, 1 warnings, 2937 lines checked
Patch 12/16 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
13/16 Checking commit 61f535a02231 (monitor: Split out monitor/monitor.c)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#735:
new file mode 100644
WARNING: Block comments use a leading /* on a separate line
#1370: FILE: monitor/monitor.c:631:
+ { /* end of list */ }
total: 0 errors, 2 warnings, 1317 lines checked
Patch 13/16 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
14/16 Checking commit add28d51ab77 (monitor: Split Monitor.flags into separate bools)
15/16 Checking commit c8d635777789 (monitor: Replace monitor_init() with monitor_init_{hmp, qmp}())
16/16 Checking commit 10cbb82deaa5 (vl: Deprecate -mon pretty=... for HMP monitors)
=== OUTPUT END ===
Test command exited with code: 1
The full log is available at
http://patchew.org/logs/20190617184903.19436-1-armbru@redhat.com/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
` (17 preceding siblings ...)
2019-06-17 20:04 ` no-reply
@ 2019-06-17 22:49 ` no-reply
18 siblings, 0 replies; 26+ messages in thread
From: no-reply @ 2019-06-17 22:49 UTC (permalink / raw)
To: armbru; +Cc: qemu-devel
Patchew URL: https://patchew.org/QEMU/20190617184903.19436-1-armbru@redhat.com/
Hi,
This series failed build test on s390x host. Please find the details below.
=== TEST SCRIPT BEGIN ===
#!/bin/bash
# Testing script will be invoked under the git checkout with
# HEAD pointing to a commit that has the patches applied on top of "base"
# branch
set -e
CC=$HOME/bin/cc
INSTALL=$PWD/install
BUILD=$PWD/build
mkdir -p $BUILD $INSTALL
SRC=$PWD
cd $BUILD
$SRC/configure --cc=$CC --prefix=$INSTALL
make -j4
# XXX: we need reliable clean up
# make check -j4 V=1
make install
echo
echo "=== ENV ==="
env
echo
echo "=== PACKAGES ==="
rpm -qa
=== TEST SCRIPT END ===
CC arm-softmmu/hw/block/virtio-blk.o
CC alpha-softmmu/hw/char/virtio-serial-bus.o
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c: In function ‘netdev_del_completion’:
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: implicit declaration of function ‘qemu_find_opts_err’; did you mean ‘qemu_find_netdev’? [-Werror=implicit-function-declaration]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~
| qemu_find_netdev
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: nested extern declaration of ‘qemu_find_opts_err’ [-Werror=nested-externs]
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: passing argument 1 of ‘qemu_opts_find’ makes pointer from integer without a cast [-Werror=int-conversion]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| |
---
CC aarch64-softmmu/hw/intc/arm_gicv3_cpuif.o
CC alpha-softmmu/qapi/qapi-introspect.o
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c: In function ‘netdev_del_completion’:
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: implicit declaration of function ‘qemu_find_opts_err’; did you mean ‘qemu_find_netdev’? [-Werror=implicit-function-declaration]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~
| qemu_find_netdev
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: nested extern declaration of ‘qemu_find_opts_err’ [-Werror=nested-externs]
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: passing argument 1 of ‘qemu_opts_find’ makes pointer from integer without a cast [-Werror=int-conversion]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| |
---
CC arm-softmmu/hw/arm/msf2-soc.o
CC aarch64-softmmu/qapi/qapi-types.o
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c: In function ‘netdev_del_completion’:
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: implicit declaration of function ‘qemu_find_opts_err’; did you mean ‘qemu_find_netdev’? [-Werror=implicit-function-declaration]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~
| qemu_find_netdev
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: nested extern declaration of ‘qemu_find_opts_err’ [-Werror=nested-externs]
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: passing argument 1 of ‘qemu_opts_find’ makes pointer from integer without a cast [-Werror=int-conversion]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| |
---
CC arm-softmmu/qapi/qapi-events.o
CC arm-softmmu/qapi/qapi-commands-target.o
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c: In function ‘netdev_del_completion’:
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: implicit declaration of function ‘qemu_find_opts_err’; did you mean ‘qemu_find_netdev’? [-Werror=implicit-function-declaration]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~
| qemu_find_netdev
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: nested extern declaration of ‘qemu_find_opts_err’ [-Werror=nested-externs]
/var/tmp/patchew-tester-tmp-0lxd7r14/src/monitor/misc.c:2165:31: error: passing argument 1 of ‘qemu_opts_find’ makes pointer from integer without a cast [-Werror=int-conversion]
2165 | opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| |
The full log is available at
http://patchew.org/logs/20190617184903.19436-1-armbru@redhat.com/testing.s390x/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17
2019-06-17 18:58 ` [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Peter Maydell
@ 2019-06-18 6:07 ` Markus Armbruster
0 siblings, 0 replies; 26+ messages in thread
From: Markus Armbruster @ 2019-06-18 6:07 UTC (permalink / raw)
To: Peter Maydell; +Cc: QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On Mon, 17 Jun 2019 at 19:51, Markus Armbruster <armbru@redhat.com> wrote:
>>
>> The following changes since commit 076243ffe6c1b687e9e6d98348c3bf3398df78f3:
>>
>> Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20190617' into staging (2019-06-17 16:41:25 +0100)
>>
>> are available in the Git repository at:
>>
>> git://repo.or.cz/qemu/armbru.git tags/pull-monitor-2019-06-17
>>
>> for you to fetch changes up to 092b8737c5e7695c4b9caa3b4eedc66763632755:
>>
>> vl: Deprecate -mon pretty=... for HMP monitors (2019-06-17 20:36:56 +0200)
>>
>> ----------------------------------------------------------------
>> Monitor patches for 2019-06-17
>>
>
> Hi; I'm afraid this doesn't compile:
>
> Most hosts (ppc64, s390, aarch64, aarch32, osx, and possibly
> the others too though they haven't failed immediately) fail
> something like this:
>
> /home/pm215/qemu/monitor/misc.c: In function ‘netdev_del_completion’:
> /home/pm215/qemu/monitor/misc.c:2165:9: error: implicit declaration of
> function ‘qemu_find_opts_err’ [-Werror=implicit-function-declaration]
> opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), name);
> ^
> /home/pm215/qemu/monitor/misc.c:2165:9: error: nested extern
> declaration of ‘qemu_find_opts_err’ [-Werror=nested-externs]
> /home/pm215/qemu/monitor/misc.c:2165:9: error: passing argument 1 of
> ‘qemu_opts_find’ makes pointer from integer without a cast [-Werror]
> In file included from /home/pm215/qemu/monitor/misc.c:64:0:
> /home/pm215/qemu/include/qemu/option.h:105:11: note: expected ‘struct
> QemuOptsList *’ but argument is of type ‘int’
> QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id);
> ^
> cc1: all warnings being treated as errors
Yup, my fault: I fell into the trap laid by include/ui/qemu-spice.h,
which includes qemu/config-file.h only when CONFIG_SPICE.
> windows is a bit different:
>
> /home/petmay01/qemu-for-merges/monitor/hmp.c: In function 'file_completion':
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1113:5: error: unknown
> type name 'DIR'
> DIR *ffs;
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1135:11: error: implicit
> declaration of function 'opendir'
> [-Werror=implicit-function-declaration]
> ffs = opendir(path);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1135:5: error: nested
> extern declaration of 'opendir' [-Werror=nested-externs]
> ffs = opendir(path);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1135:9: error: assignment
> makes pointer from integer without a cast [-Werror=int-conversion]
> ffs = opendir(path);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1141:13: error: implicit
> declaration of function 'readdir'
> [-Werror=implicit-function-declaration]
> d = readdir(ffs);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1141:9: error: nested
> extern declaration of 'readdir' [-Werror=nested-externs]
> d = readdir(ffs);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1141:11: error:
> assignment makes pointer from integer without a cast
> [-Werror=int-conversion]
> d = readdir(ffs);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1146:21: error:
> dereferencing pointer to incomplete type 'struct dirent'
> if (strcmp(d->d_name, ".") == 0 || strcmp(d->d_name, "..") == 0) {
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1166:5: error: implicit
> declaration of function 'closedir'
> [-Werror=implicit-function-declaration]
> closedir(ffs);
> ^
> /home/petmay01/qemu-for-merges/monitor/hmp.c:1166:5: error: nested
> extern declaration of 'closedir' [-Werror=nested-externs]
Here, Kevin fell into the trap laid by GLib, which includes <dirent.h>
only #ifdef G_OS_UNIX.
v2 coming up.
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors
2019-06-17 18:49 ` [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors Markus Armbruster
@ 2019-06-18 9:01 ` Daniel P. Berrangé
2019-06-18 10:34 ` Kevin Wolf
0 siblings, 1 reply; 26+ messages in thread
From: Daniel P. Berrangé @ 2019-06-18 9:01 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Kevin Wolf, qemu-devel
On Mon, Jun 17, 2019 at 08:49:03PM +0200, Markus Armbruster wrote:
> From: Kevin Wolf <kwolf@redhat.com>
>
> The -mon pretty=on|off switch of the -mon option applies only to QMP
> monitors. It's silently ignored for HMP. Deprecate this combination so
> that we can make it an error in future versions.
No objection to merging this PR as is, but how about we extend the
deprecation to QMP too ?
I was responsible for adding this option back in 2010 and I don't
think I've used it since 2012 when I added pretty printing support
to scripts/qmp/qmp-shell. I struggle to imagine good reasons for
using QMP directly with pretty printing, as opposed to doing it
via qmp-shell or another wrapper tool.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors
2019-06-18 9:01 ` Daniel P. Berrangé
@ 2019-06-18 10:34 ` Kevin Wolf
2019-06-19 6:42 ` Markus Armbruster
0 siblings, 1 reply; 26+ messages in thread
From: Kevin Wolf @ 2019-06-18 10:34 UTC (permalink / raw)
To: Daniel P. Berrangé; +Cc: Markus Armbruster, qemu-devel
Am 18.06.2019 um 11:01 hat Daniel P. Berrangé geschrieben:
> On Mon, Jun 17, 2019 at 08:49:03PM +0200, Markus Armbruster wrote:
> > From: Kevin Wolf <kwolf@redhat.com>
> >
> > The -mon pretty=on|off switch of the -mon option applies only to QMP
> > monitors. It's silently ignored for HMP. Deprecate this combination so
> > that we can make it an error in future versions.
>
> No objection to merging this PR as is, but how about we extend the
> deprecation to QMP too ?
>
> I was responsible for adding this option back in 2010 and I don't
> think I've used it since 2012 when I added pretty printing support
> to scripts/qmp/qmp-shell. I struggle to imagine good reasons for
> using QMP directly with pretty printing, as opposed to doing it
> via qmp-shell or another wrapper tool.
qemu-iotests uses it. It doesn't only make the output (and espeically
diffs on failure) much more readable, but in fact also avoids very long
lines in the refernce output that used to break patch emails when we
didn't use pretty printing yet.
So let's keep it for QMP, please.
Kevin
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors
2019-06-18 10:34 ` Kevin Wolf
@ 2019-06-19 6:42 ` Markus Armbruster
2019-06-19 9:18 ` Kevin Wolf
0 siblings, 1 reply; 26+ messages in thread
From: Markus Armbruster @ 2019-06-19 6:42 UTC (permalink / raw)
To: Kevin Wolf; +Cc: Daniel P. Berrangé, qemu-devel
Kevin Wolf <kwolf@redhat.com> writes:
> Am 18.06.2019 um 11:01 hat Daniel P. Berrangé geschrieben:
>> On Mon, Jun 17, 2019 at 08:49:03PM +0200, Markus Armbruster wrote:
>> > From: Kevin Wolf <kwolf@redhat.com>
>> >
>> > The -mon pretty=on|off switch of the -mon option applies only to QMP
>> > monitors. It's silently ignored for HMP. Deprecate this combination so
>> > that we can make it an error in future versions.
>>
>> No objection to merging this PR as is, but how about we extend the
>> deprecation to QMP too ?
>>
>> I was responsible for adding this option back in 2010 and I don't
>> think I've used it since 2012 when I added pretty printing support
>> to scripts/qmp/qmp-shell. I struggle to imagine good reasons for
>> using QMP directly with pretty printing, as opposed to doing it
>> via qmp-shell or another wrapper tool.
>
> qemu-iotests uses it. It doesn't only make the output (and espeically
> diffs on failure) much more readable, but in fact also avoids very long
> lines in the refernce output that used to break patch emails when we
> didn't use pretty printing yet.
>
> So let's keep it for QMP, please.
Perhaps we can get rid of it if we find a suitable filter.
Hmm, Python comes with one: "python -m json.tool". It expects just one
expression, and fails if anything follows:
$ printf '{"execute": "qmp_capabilities"}\n{"execute": "query-version"}\n' | socat UNIX:/work/armbru/images/test-qmp STDIO | python3 -m json.tool
Extra data: line 2 column 1 (char 134)
To pretty print a sequence of expressions, you have to wrap a loop
around it:
$ printf '{"execute": "qmp_capabilities"}\n{"execute": "query-version"}\n' | socat UNIX:/work/armbru/images/test-qmp STDIO | { while read line; do echo "$line" | python3 -m json.tool; done; }
{
"QMP": {
"version": {
"qemu": {
"micro": 50,
"minor": 0,
"major": 4
},
"package": "v4.0.0-1467-g6385dd6613"
},
"capabilities": [
"oob"
]
}
}
{
"return": {}
}
{
"return": {
"qemu": {
"micro": 50,
"minor": 0,
"major": 4
},
"package": "v4.0.0-1467-g6385dd6613"
}
}
I figure we'd want to loop in Python instead of shell.
My point is: pretty-printing is trivial in Python. The case for
maintaining C code to do it seems weak.
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors
2019-06-19 6:42 ` Markus Armbruster
@ 2019-06-19 9:18 ` Kevin Wolf
2019-06-19 9:20 ` Daniel P. Berrangé
0 siblings, 1 reply; 26+ messages in thread
From: Kevin Wolf @ 2019-06-19 9:18 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Daniel P. Berrangé, qemu-devel
Am 19.06.2019 um 08:42 hat Markus Armbruster geschrieben:
> Kevin Wolf <kwolf@redhat.com> writes:
>
> > Am 18.06.2019 um 11:01 hat Daniel P. Berrangé geschrieben:
> >> On Mon, Jun 17, 2019 at 08:49:03PM +0200, Markus Armbruster wrote:
> >> > From: Kevin Wolf <kwolf@redhat.com>
> >> >
> >> > The -mon pretty=on|off switch of the -mon option applies only to QMP
> >> > monitors. It's silently ignored for HMP. Deprecate this combination so
> >> > that we can make it an error in future versions.
> >>
> >> No objection to merging this PR as is, but how about we extend the
> >> deprecation to QMP too ?
> >>
> >> I was responsible for adding this option back in 2010 and I don't
> >> think I've used it since 2012 when I added pretty printing support
> >> to scripts/qmp/qmp-shell. I struggle to imagine good reasons for
> >> using QMP directly with pretty printing, as opposed to doing it
> >> via qmp-shell or another wrapper tool.
> >
> > qemu-iotests uses it. It doesn't only make the output (and espeically
> > diffs on failure) much more readable, but in fact also avoids very long
> > lines in the refernce output that used to break patch emails when we
> > didn't use pretty printing yet.
> >
> > So let's keep it for QMP, please.
>
> Perhaps we can get rid of it if we find a suitable filter.
>
> Hmm, Python comes with one: "python -m json.tool". It expects just one
> expression, and fails if anything follows:
>
> $ printf '{"execute": "qmp_capabilities"}\n{"execute": "query-version"}\n' | socat UNIX:/work/armbru/images/test-qmp STDIO | python3 -m json.tool
> Extra data: line 2 column 1 (char 134)
>
> To pretty print a sequence of expressions, you have to wrap a loop
> around it:
>
> $ printf '{"execute": "qmp_capabilities"}\n{"execute": "query-version"}\n' | socat UNIX:/work/armbru/images/test-qmp STDIO | { while read line; do echo "$line" | python3 -m json.tool; done; }
Yes, it's doable. It's not a very nice command line, but it does its
job.
What do we win by removing pretty printing from qemu? We invest some
work doing the patches, reviewing them, etc. and save the whole
complexity of adding a few newlines and spaces to an already existing
string buffer in a single place (qjson.c).
In exchange, we have to add the above overlong command line to every
qemu-iotests case for which pretty printed QMP is useful, and lose the
ability to just do -qmp-pretty stdio manually (which I do every now and
then) instead of having to dig up the above line in some script to copy
it.
It doesn't look like a net win to me.
> I figure we'd want to loop in Python instead of shell.
>
> My point is: pretty-printing is trivial in Python. The case for
> maintaining C code to do it seems weak.
The pretty printing is fairly trivial in C, too, when you already
generate JSON. The code seems to have been last touched in 2014, and
before that in 2010 when it was introduced. The maintenance burden
doesn't seem to be that bad.
Removing features that have users can be justified sometimes, but it
does need a justification, in my opinion.
Kevin
^ permalink raw reply [flat|nested] 26+ messages in thread
* Re: [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors
2019-06-19 9:18 ` Kevin Wolf
@ 2019-06-19 9:20 ` Daniel P. Berrangé
0 siblings, 0 replies; 26+ messages in thread
From: Daniel P. Berrangé @ 2019-06-19 9:20 UTC (permalink / raw)
To: Kevin Wolf; +Cc: Markus Armbruster, qemu-devel
On Wed, Jun 19, 2019 at 11:18:52AM +0200, Kevin Wolf wrote:
> Am 19.06.2019 um 08:42 hat Markus Armbruster geschrieben:
> > Kevin Wolf <kwolf@redhat.com> writes:
> >
> > > Am 18.06.2019 um 11:01 hat Daniel P. Berrangé geschrieben:
> > >> On Mon, Jun 17, 2019 at 08:49:03PM +0200, Markus Armbruster wrote:
> > >> > From: Kevin Wolf <kwolf@redhat.com>
> > >> >
> > >> > The -mon pretty=on|off switch of the -mon option applies only to QMP
> > >> > monitors. It's silently ignored for HMP. Deprecate this combination so
> > >> > that we can make it an error in future versions.
> > >>
> > >> No objection to merging this PR as is, but how about we extend the
> > >> deprecation to QMP too ?
> > >>
> > >> I was responsible for adding this option back in 2010 and I don't
> > >> think I've used it since 2012 when I added pretty printing support
> > >> to scripts/qmp/qmp-shell. I struggle to imagine good reasons for
> > >> using QMP directly with pretty printing, as opposed to doing it
> > >> via qmp-shell or another wrapper tool.
> > >
> > > qemu-iotests uses it. It doesn't only make the output (and espeically
> > > diffs on failure) much more readable, but in fact also avoids very long
> > > lines in the refernce output that used to break patch emails when we
> > > didn't use pretty printing yet.
> > >
> > > So let's keep it for QMP, please.
> >
> > Perhaps we can get rid of it if we find a suitable filter.
> >
> > Hmm, Python comes with one: "python -m json.tool". It expects just one
> > expression, and fails if anything follows:
> >
> > $ printf '{"execute": "qmp_capabilities"}\n{"execute": "query-version"}\n' | socat UNIX:/work/armbru/images/test-qmp STDIO | python3 -m json.tool
> > Extra data: line 2 column 1 (char 134)
> >
> > To pretty print a sequence of expressions, you have to wrap a loop
> > around it:
> >
> > $ printf '{"execute": "qmp_capabilities"}\n{"execute": "query-version"}\n' | socat UNIX:/work/armbru/images/test-qmp STDIO | { while read line; do echo "$line" | python3 -m json.tool; done; }
>
> Yes, it's doable. It's not a very nice command line, but it does its
> job.
>
> What do we win by removing pretty printing from qemu? We invest some
> work doing the patches, reviewing them, etc. and save the whole
> complexity of adding a few newlines and spaces to an already existing
> string buffer in a single place (qjson.c).
>
> In exchange, we have to add the above overlong command line to every
> qemu-iotests case for which pretty printed QMP is useful, and lose the
> ability to just do -qmp-pretty stdio manually (which I do every now and
> then) instead of having to dig up the above line in some script to copy
> it.
>
> It doesn't look like a net win to me.
>
> > I figure we'd want to loop in Python instead of shell.
> >
> > My point is: pretty-printing is trivial in Python. The case for
> > maintaining C code to do it seems weak.
>
> The pretty printing is fairly trivial in C, too, when you already
> generate JSON. The code seems to have been last touched in 2014, and
> before that in 2010 when it was introduced. The maintenance burden
> doesn't seem to be that bad.
>
> Removing features that have users can be justified sometimes, but it
> does need a justification, in my opinion.
I'm fine with keeping the print-printing in QEMU given that you illustrated
an existing usage of it I wasn't aware of & its not difficult code to
maintain.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
^ permalink raw reply [flat|nested] 26+ messages in thread
end of thread, other threads:[~2019-06-19 9:23 UTC | newest]
Thread overview: 26+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-06-17 18:48 [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 01/16] monitor: Fix return type of monitor_fdset_dup_fd_find Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 02/16] monitor: Remove unused password prompting fields Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 03/16] monitor: Split monitor_init in HMP and QMP function Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 04/16] monitor: Make MonitorQMP a child class of Monitor Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 05/16] monitor: Create MonitorHMP with readline state Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 06/16] monitor: Remove Monitor.cmd_table indirection Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 07/16] monitor: Rename HMP command type and tables Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 08/16] Move monitor.c to monitor/misc.c Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 09/16] monitor: Move {hmp, qmp}.c to monitor/{hmp, qmp}-cmds.c Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 10/16] monitor: Create monitor-internal.h with common definitions Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 11/16] monitor: Split out monitor/qmp.c Markus Armbruster
2019-06-17 18:48 ` [Qemu-devel] [PULL 12/16] monitor: Split out monitor/hmp.c Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 13/16] monitor: Split out monitor/monitor.c Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 14/16] monitor: Split Monitor.flags into separate bools Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 15/16] monitor: Replace monitor_init() with monitor_init_{hmp, qmp}() Markus Armbruster
2019-06-17 18:49 ` [Qemu-devel] [PULL 16/16] vl: Deprecate -mon pretty=... for HMP monitors Markus Armbruster
2019-06-18 9:01 ` Daniel P. Berrangé
2019-06-18 10:34 ` Kevin Wolf
2019-06-19 6:42 ` Markus Armbruster
2019-06-19 9:18 ` Kevin Wolf
2019-06-19 9:20 ` Daniel P. Berrangé
2019-06-17 18:58 ` [Qemu-devel] [PULL 00/16] Monitor patches for 2019-06-17 Peter Maydell
2019-06-18 6:07 ` Markus Armbruster
2019-06-17 20:04 ` no-reply
2019-06-17 22:49 ` no-reply
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.