blob: c5a5d308774b0061853a5316e8b66ba7c61b6691 [file] [log] [blame]
Kevin Wolf1d95db72019-06-13 17:34:02 +02001/*
2 * QEMU monitor
3 *
4 * Copyright (c) 2003-2004 Fabrice Bellard
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25#include "qemu/osdep.h"
26#include "monitor-internal.h"
27#include "qapi/error.h"
Kevin Wolff2098722020-02-24 15:30:04 +010028#include "qapi/opts-visitor.h"
Kevin Wolf1d95db72019-06-13 17:34:02 +020029#include "qapi/qapi-emit-events.h"
Kevin Wolff2098722020-02-24 15:30:04 +010030#include "qapi/qapi-visit-control.h"
Daniel P. Berrangé407bc4b2024-11-18 16:12:34 +010031#include "qobject/qdict.h"
Kevin Wolf1d95db72019-06-13 17:34:02 +020032#include "qemu/error-report.h"
33#include "qemu/option.h"
Philippe Mathieu-Daudé32cad1f2024-12-03 15:20:13 +010034#include "system/qtest.h"
Kevin Wolf1d95db72019-06-13 17:34:02 +020035#include "trace.h"
36
37/*
38 * To prevent flooding clients, events can be throttled. The
39 * throttling is calculated globally, rather than per-Monitor
40 * instance.
41 */
42typedef struct MonitorQAPIEventState {
43 QAPIEvent event; /* Throttling state for this event type and... */
44 QDict *data; /* ... data, see qapi_event_throttle_equal() */
45 QEMUTimer *timer; /* Timer for handling delayed events */
46 QDict *qdict; /* Delayed event (if any) */
47} MonitorQAPIEventState;
48
49typedef struct {
50 int64_t rate; /* Minimum time (in ns) between two events */
51} MonitorQAPIEventConf;
52
53/* Shared monitor I/O thread */
54IOThread *mon_iothread;
55
Kevin Wolf9ce44e22020-10-05 17:58:50 +020056/* Coroutine to dispatch the requests received from I/O thread */
57Coroutine *qmp_dispatcher_co;
58
Paolo Bonzini0ff25532023-03-03 12:51:33 +010059/*
60 * Set to true when the dispatcher coroutine should terminate. Protected
61 * by monitor_lock.
62 */
Kevin Wolf9ce44e22020-10-05 17:58:50 +020063bool qmp_dispatcher_co_shutdown;
64
65/*
Kevin Wolfe69ee452020-10-05 17:58:48 +020066 * Protects mon_list, monitor_qapi_event_state, coroutine_mon,
67 * monitor_destroyed.
68 */
Kevin Wolf1d95db72019-06-13 17:34:02 +020069QemuMutex monitor_lock;
70static GHashTable *monitor_qapi_event_state;
Kevin Wolfe69ee452020-10-05 17:58:48 +020071static GHashTable *coroutine_mon; /* Maps Coroutine* to Monitor* */
Kevin Wolf1d95db72019-06-13 17:34:02 +020072
73MonitorList mon_list;
Kevin Wolf1d95db72019-06-13 17:34:02 +020074static bool monitor_destroyed;
75
Kevin Wolf947e4742020-10-05 17:58:44 +020076Monitor *monitor_cur(void)
77{
Kevin Wolfe69ee452020-10-05 17:58:48 +020078 Monitor *mon;
79
80 qemu_mutex_lock(&monitor_lock);
81 mon = g_hash_table_lookup(coroutine_mon, qemu_coroutine_self());
82 qemu_mutex_unlock(&monitor_lock);
83
84 return mon;
Kevin Wolf947e4742020-10-05 17:58:44 +020085}
86
87/**
88 * Sets a new current monitor and returns the old one.
Kevin Wolfe69ee452020-10-05 17:58:48 +020089 *
90 * If a non-NULL monitor is set for a coroutine, another call
91 * resetting it to NULL is required before the coroutine terminates,
92 * otherwise a stale entry would remain in the hash table.
Kevin Wolf947e4742020-10-05 17:58:44 +020093 */
Kevin Wolfe69ee452020-10-05 17:58:48 +020094Monitor *monitor_set_cur(Coroutine *co, Monitor *mon)
Kevin Wolf947e4742020-10-05 17:58:44 +020095{
Kevin Wolfe69ee452020-10-05 17:58:48 +020096 Monitor *old_monitor = monitor_cur();
Kevin Wolf947e4742020-10-05 17:58:44 +020097
Kevin Wolfe69ee452020-10-05 17:58:48 +020098 qemu_mutex_lock(&monitor_lock);
99 if (mon) {
100 g_hash_table_replace(coroutine_mon, co, mon);
101 } else {
102 g_hash_table_remove(coroutine_mon, co);
103 }
104 qemu_mutex_unlock(&monitor_lock);
105
Kevin Wolf947e4742020-10-05 17:58:44 +0200106 return old_monitor;
107}
Kevin Wolf1d95db72019-06-13 17:34:02 +0200108
109/**
110 * Is the current monitor, if any, a QMP monitor?
111 */
112bool monitor_cur_is_qmp(void)
113{
Kevin Wolf947e4742020-10-05 17:58:44 +0200114 Monitor *cur_mon = monitor_cur();
115
Kevin Wolf1d95db72019-06-13 17:34:02 +0200116 return cur_mon && monitor_is_qmp(cur_mon);
117}
118
119/**
120 * Is @mon is using readline?
121 * Note: not all HMP monitors use readline, e.g., gdbserver has a
122 * non-interactive HMP monitor, so readline is not used there.
123 */
Kevin Wolf92082412019-06-13 17:34:03 +0200124static inline bool monitor_uses_readline(const MonitorHMP *mon)
Kevin Wolf1d95db72019-06-13 17:34:02 +0200125{
Kevin Wolf92082412019-06-13 17:34:03 +0200126 return mon->use_readline;
Kevin Wolf1d95db72019-06-13 17:34:02 +0200127}
128
129static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
130{
Kevin Wolf92082412019-06-13 17:34:03 +0200131 if (monitor_is_qmp(mon)) {
132 return false;
133 }
134
135 return !monitor_uses_readline(container_of(mon, MonitorHMP, common));
Kevin Wolf1d95db72019-06-13 17:34:02 +0200136}
137
Marc-André Lureaubf7b1ea2021-08-04 17:01:14 +0400138static gboolean monitor_unblocked(void *do_not_use, GIOCondition cond,
Kevin Wolf1d95db72019-06-13 17:34:02 +0200139 void *opaque)
140{
141 Monitor *mon = opaque;
142
Paolo Bonzinie37548e2023-05-17 14:47:55 +0200143 QEMU_LOCK_GUARD(&mon->mon_lock);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200144 mon->out_watch = 0;
145 monitor_flush_locked(mon);
Philippe Mathieu-Daudé53c7c922023-07-05 13:22:10 +0200146 return G_SOURCE_REMOVE;
Kevin Wolf1d95db72019-06-13 17:34:02 +0200147}
148
149/* Caller must hold mon->mon_lock */
Paolo Bonzini4cb96b92023-05-17 14:46:49 +0200150void monitor_flush_locked(Monitor *mon)
Kevin Wolf1d95db72019-06-13 17:34:02 +0200151{
152 int rc;
153 size_t len;
154 const char *buf;
155
156 if (mon->skip_flush) {
157 return;
158 }
159
Markus Armbruster20076f42020-12-11 18:11:34 +0100160 buf = mon->outbuf->str;
161 len = mon->outbuf->len;
Kevin Wolf1d95db72019-06-13 17:34:02 +0200162
163 if (len && !mon->mux_out) {
164 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
165 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
166 /* all flushed or error */
Markus Armbruster20076f42020-12-11 18:11:34 +0100167 g_string_truncate(mon->outbuf, 0);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200168 return;
169 }
170 if (rc > 0) {
171 /* partial write */
Markus Armbruster20076f42020-12-11 18:11:34 +0100172 g_string_erase(mon->outbuf, 0, rc);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200173 }
174 if (mon->out_watch == 0) {
175 mon->out_watch =
176 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
177 monitor_unblocked, mon);
178 }
179 }
180}
181
182void monitor_flush(Monitor *mon)
183{
Paolo Bonzinie37548e2023-05-17 14:47:55 +0200184 QEMU_LOCK_GUARD(&mon->mon_lock);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200185 monitor_flush_locked(mon);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200186}
187
188/* flush at every end of line */
Paolo Bonzini4cb96b92023-05-17 14:46:49 +0200189int monitor_puts_locked(Monitor *mon, const char *str)
Kevin Wolf1d95db72019-06-13 17:34:02 +0200190{
191 int i;
192 char c;
193
Kevin Wolf1d95db72019-06-13 17:34:02 +0200194 for (i = 0; str[i]; i++) {
195 c = str[i];
196 if (c == '\n') {
Markus Armbruster20076f42020-12-11 18:11:34 +0100197 g_string_append_c(mon->outbuf, '\r');
Kevin Wolf1d95db72019-06-13 17:34:02 +0200198 }
Markus Armbruster20076f42020-12-11 18:11:34 +0100199 g_string_append_c(mon->outbuf, c);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200200 if (c == '\n') {
201 monitor_flush_locked(mon);
202 }
203 }
Kevin Wolf1d95db72019-06-13 17:34:02 +0200204
205 return i;
206}
207
Paolo Bonzini4cb96b92023-05-17 14:46:49 +0200208int monitor_puts(Monitor *mon, const char *str)
209{
210 QEMU_LOCK_GUARD(&mon->mon_lock);
211 return monitor_puts_locked(mon, str);
212}
213
Kevin Wolf1d95db72019-06-13 17:34:02 +0200214int monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
215{
216 char *buf;
217 int n;
218
219 if (!mon) {
220 return -1;
221 }
222
223 if (monitor_is_qmp(mon)) {
224 return -1;
225 }
226
227 buf = g_strdup_vprintf(fmt, ap);
228 n = monitor_puts(mon, buf);
229 g_free(buf);
230 return n;
231}
232
233int monitor_printf(Monitor *mon, const char *fmt, ...)
234{
235 int ret;
236
237 va_list ap;
238 va_start(ap, fmt);
239 ret = monitor_vprintf(mon, fmt, ap);
240 va_end(ap);
241 return ret;
242}
243
Markus Armbrusterdd00d7f2023-01-24 13:19:41 +0100244void monitor_printc(Monitor *mon, int c)
245{
246 monitor_printf(mon, "'");
247 switch(c) {
248 case '\'':
249 monitor_printf(mon, "\\'");
250 break;
251 case '\\':
252 monitor_printf(mon, "\\\\");
253 break;
254 case '\n':
255 monitor_printf(mon, "\\n");
256 break;
257 case '\r':
258 monitor_printf(mon, "\\r");
259 break;
260 default:
261 if (c >= 32 && c <= 126) {
262 monitor_printf(mon, "%c", c);
263 } else {
264 monitor_printf(mon, "\\x%02x", c);
265 }
266 break;
267 }
268 monitor_printf(mon, "'");
269}
270
Kevin Wolf1d95db72019-06-13 17:34:02 +0200271/*
272 * Print to current monitor if we have one, else to stderr.
273 */
274int error_vprintf(const char *fmt, va_list ap)
275{
Kevin Wolf947e4742020-10-05 17:58:44 +0200276 Monitor *cur_mon = monitor_cur();
277
Kevin Wolf1d95db72019-06-13 17:34:02 +0200278 if (cur_mon && !monitor_cur_is_qmp()) {
279 return monitor_vprintf(cur_mon, fmt, ap);
280 }
281 return vfprintf(stderr, fmt, ap);
282}
283
284int error_vprintf_unless_qmp(const char *fmt, va_list ap)
285{
Kevin Wolf947e4742020-10-05 17:58:44 +0200286 Monitor *cur_mon = monitor_cur();
287
Kevin Wolf1d95db72019-06-13 17:34:02 +0200288 if (!cur_mon) {
289 return vfprintf(stderr, fmt, ap);
290 }
291 if (!monitor_cur_is_qmp()) {
292 return monitor_vprintf(cur_mon, fmt, ap);
293 }
294 return -1;
295}
296
Marc-André Lureau756a98d2022-04-20 17:26:13 +0400297int error_printf_unless_qmp(const char *fmt, ...)
298{
299 va_list ap;
300 int ret;
301
302 va_start(ap, fmt);
303 ret = error_vprintf_unless_qmp(fmt, ap);
304 va_end(ap);
305 return ret;
306}
Kevin Wolf1d95db72019-06-13 17:34:02 +0200307
308static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
309 /* Limit guest-triggerable events to 1 per second */
310 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
Leonid Kaplan2155d2d2024-10-02 18:18:06 +0300311 [QAPI_EVENT_BLOCK_IO_ERROR] = { 1000 * SCALE_MS },
Kevin Wolf1d95db72019-06-13 17:34:02 +0200312 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
313 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
314 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
315 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
316 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
David Hildenbrand722a3c72020-06-26 09:22:44 +0200317 [QAPI_EVENT_MEMORY_DEVICE_SIZE_CHANGE] = { 1000 * SCALE_MS },
Maciej S. Szmigiero259ebed2023-08-23 23:34:14 +0200318 [QAPI_EVENT_HV_BALLOON_STATUS_REPORT] = { 1000 * SCALE_MS },
Kevin Wolf1d95db72019-06-13 17:34:02 +0200319};
320
321/*
322 * Return the clock to use for recording an event's time.
323 * It's QEMU_CLOCK_REALTIME, except for qtests it's
324 * QEMU_CLOCK_VIRTUAL, to support testing rate limits.
325 * Beware: result is invalid before configure_accelerator().
326 */
327static inline QEMUClockType monitor_get_event_clock(void)
328{
329 return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
330}
331
332/*
333 * Broadcast an event to all monitors.
334 * @qdict is the event object. Its member "event" must match @event.
335 * Caller must hold monitor_lock.
336 */
337static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
338{
339 Monitor *mon;
340 MonitorQMP *qmp_mon;
341
342 trace_monitor_protocol_event_emit(event, qdict);
343 QTAILQ_FOREACH(mon, &mon_list, entry) {
344 if (!monitor_is_qmp(mon)) {
345 continue;
346 }
347
348 qmp_mon = container_of(mon, MonitorQMP, common);
349 if (qmp_mon->commands != &qmp_cap_negotiation_commands) {
350 qmp_send_response(qmp_mon, qdict);
351 }
352 }
353}
354
355static void monitor_qapi_event_handler(void *opaque);
356
357/*
358 * Queue a new event for emission to Monitor instances,
359 * applying any rate limiting if required.
360 */
361static void
362monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
363{
364 MonitorQAPIEventConf *evconf;
365 MonitorQAPIEventState *evstate;
366
367 assert(event < QAPI_EVENT__MAX);
368 evconf = &monitor_qapi_event_conf[event];
369 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
370
Mahmoud Mandoura8e2ab52021-03-11 05:15:34 +0200371 QEMU_LOCK_GUARD(&monitor_lock);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200372
373 if (!evconf->rate) {
374 /* Unthrottled event */
375 monitor_qapi_event_emit(event, qdict);
376 } else {
377 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
378 MonitorQAPIEventState key = { .event = event, .data = data };
379
380 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
381 assert(!evstate || timer_pending(evstate->timer));
382
383 if (evstate) {
384 /*
385 * Timer is pending for (at least) evconf->rate ns after
386 * last send. Store event for sending when timer fires,
387 * replacing a prior stored event if any.
388 */
389 qobject_unref(evstate->qdict);
390 evstate->qdict = qobject_ref(qdict);
391 } else {
392 /*
393 * Last send was (at least) evconf->rate ns ago.
394 * Send immediately, and arm the timer to call
395 * monitor_qapi_event_handler() in evconf->rate ns. Any
396 * events arriving before then will be delayed until then.
397 */
398 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
399
400 monitor_qapi_event_emit(event, qdict);
401
402 evstate = g_new(MonitorQAPIEventState, 1);
403 evstate->event = event;
404 evstate->data = qobject_ref(data);
405 evstate->qdict = NULL;
406 evstate->timer = timer_new_ns(monitor_get_event_clock(),
407 monitor_qapi_event_handler,
408 evstate);
409 g_hash_table_add(monitor_qapi_event_state, evstate);
410 timer_mod_ns(evstate->timer, now + evconf->rate);
411 }
412 }
Kevin Wolf1d95db72019-06-13 17:34:02 +0200413}
414
415void qapi_event_emit(QAPIEvent event, QDict *qdict)
416{
417 /*
418 * monitor_qapi_event_queue_no_reenter() is not reentrant: it
419 * would deadlock on monitor_lock. Work around by queueing
420 * events in thread-local storage.
421 * TODO: remove this, make it re-enter safe.
422 */
423 typedef struct MonitorQapiEvent {
424 QAPIEvent event;
425 QDict *qdict;
426 QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
427 } MonitorQapiEvent;
428 static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
429 static __thread bool reentered;
430 MonitorQapiEvent *ev;
431
432 if (!reentered) {
433 QSIMPLEQ_INIT(&event_queue);
434 }
435
436 ev = g_new(MonitorQapiEvent, 1);
437 ev->qdict = qobject_ref(qdict);
438 ev->event = event;
439 QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
440 if (reentered) {
441 return;
442 }
443
444 reentered = true;
445
446 while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
447 QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
448 monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
449 qobject_unref(ev->qdict);
450 g_free(ev);
451 }
452
453 reentered = false;
454}
455
456/*
457 * This function runs evconf->rate ns after sending a throttled
458 * event.
459 * If another event has since been stored, send it.
460 */
461static void monitor_qapi_event_handler(void *opaque)
462{
463 MonitorQAPIEventState *evstate = opaque;
464 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
465
466 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
Mahmoud Mandoura8e2ab52021-03-11 05:15:34 +0200467 QEMU_LOCK_GUARD(&monitor_lock);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200468
469 if (evstate->qdict) {
470 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
471
472 monitor_qapi_event_emit(evstate->event, evstate->qdict);
473 qobject_unref(evstate->qdict);
474 evstate->qdict = NULL;
475 timer_mod_ns(evstate->timer, now + evconf->rate);
476 } else {
477 g_hash_table_remove(monitor_qapi_event_state, evstate);
478 qobject_unref(evstate->data);
479 timer_free(evstate->timer);
480 g_free(evstate);
481 }
Kevin Wolf1d95db72019-06-13 17:34:02 +0200482}
483
484static unsigned int qapi_event_throttle_hash(const void *key)
485{
486 const MonitorQAPIEventState *evstate = key;
487 unsigned int hash = evstate->event * 255;
488
489 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
490 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
491 }
492
493 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
494 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
495 }
496
Leonid Kaplan2155d2d2024-10-02 18:18:06 +0300497 if (evstate->event == QAPI_EVENT_MEMORY_DEVICE_SIZE_CHANGE ||
498 evstate->event == QAPI_EVENT_BLOCK_IO_ERROR) {
David Hildenbrand77ae2302021-09-29 18:24:45 +0200499 hash += g_str_hash(qdict_get_str(evstate->data, "qom-path"));
500 }
501
Kevin Wolf1d95db72019-06-13 17:34:02 +0200502 return hash;
503}
504
505static gboolean qapi_event_throttle_equal(const void *a, const void *b)
506{
507 const MonitorQAPIEventState *eva = a;
508 const MonitorQAPIEventState *evb = b;
509
510 if (eva->event != evb->event) {
511 return FALSE;
512 }
513
514 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
515 return !strcmp(qdict_get_str(eva->data, "id"),
516 qdict_get_str(evb->data, "id"));
517 }
518
519 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
520 return !strcmp(qdict_get_str(eva->data, "node-name"),
521 qdict_get_str(evb->data, "node-name"));
522 }
523
Leonid Kaplan2155d2d2024-10-02 18:18:06 +0300524 if (eva->event == QAPI_EVENT_MEMORY_DEVICE_SIZE_CHANGE ||
525 eva->event == QAPI_EVENT_BLOCK_IO_ERROR) {
David Hildenbrand77ae2302021-09-29 18:24:45 +0200526 return !strcmp(qdict_get_str(eva->data, "qom-path"),
527 qdict_get_str(evb->data, "qom-path"));
528 }
529
Kevin Wolf1d95db72019-06-13 17:34:02 +0200530 return TRUE;
531}
532
533int monitor_suspend(Monitor *mon)
534{
535 if (monitor_is_hmp_non_interactive(mon)) {
536 return -ENOTTY;
537 }
538
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100539 qatomic_inc(&mon->suspend_cnt);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200540
541 if (mon->use_io_thread) {
542 /*
543 * Kick I/O thread to make sure this takes effect. It'll be
544 * evaluated again in prepare() of the watch object.
545 */
546 aio_notify(iothread_get_aio_context(mon_iothread));
547 }
548
549 trace_monitor_suspend(mon, 1);
550 return 0;
551}
552
553static void monitor_accept_input(void *opaque)
554{
555 Monitor *mon = opaque;
556
Paolo Bonzini6ee7c822023-03-03 13:32:13 +0100557 qemu_mutex_lock(&mon->mon_lock);
558 if (!monitor_is_qmp(mon) && mon->reset_seen) {
Paolo Bonzinic5d0c552023-05-17 17:19:03 +0200559 MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
560 assert(hmp_mon->rs);
Paolo Bonzini6ee7c822023-03-03 13:32:13 +0100561 readline_restart(hmp_mon->rs);
562 qemu_mutex_unlock(&mon->mon_lock);
Paolo Bonzinic5d0c552023-05-17 17:19:03 +0200563 readline_show_prompt(hmp_mon->rs);
Paolo Bonzini6ee7c822023-03-03 13:32:13 +0100564 } else {
565 qemu_mutex_unlock(&mon->mon_lock);
Paolo Bonzinic5d0c552023-05-17 17:19:03 +0200566 }
567
Kevin Wolf1d95db72019-06-13 17:34:02 +0200568 qemu_chr_fe_accept_input(&mon->chr);
569}
570
571void monitor_resume(Monitor *mon)
572{
573 if (monitor_is_hmp_non_interactive(mon)) {
574 return;
575 }
576
Stefan Hajnoczid73415a2020-09-23 11:56:46 +0100577 if (qatomic_dec_fetch(&mon->suspend_cnt) == 0) {
Kevin Wolf1d95db72019-06-13 17:34:02 +0200578 AioContext *ctx;
579
580 if (mon->use_io_thread) {
581 ctx = iothread_get_aio_context(mon_iothread);
582 } else {
583 ctx = qemu_get_aio_context();
584 }
585
Kevin Wolf1d95db72019-06-13 17:34:02 +0200586 aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
587 }
588
589 trace_monitor_suspend(mon, -1);
590}
591
592int monitor_can_read(void *opaque)
593{
594 Monitor *mon = opaque;
595
Paolo Bonzini6ee7c822023-03-03 13:32:13 +0100596 return !qatomic_read(&mon->suspend_cnt);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200597}
598
599void monitor_list_append(Monitor *mon)
600{
601 qemu_mutex_lock(&monitor_lock);
602 /*
603 * This prevents inserting new monitors during monitor_cleanup().
604 * A cleaner solution would involve the main thread telling other
605 * threads to terminate, waiting for their termination.
606 */
607 if (!monitor_destroyed) {
608 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
609 mon = NULL;
610 }
611 qemu_mutex_unlock(&monitor_lock);
612
613 if (mon) {
614 monitor_data_destroy(mon);
615 g_free(mon);
616 }
617}
618
619static void monitor_iothread_init(void)
620{
621 mon_iothread = iothread_create("mon_iothread", &error_abort);
622}
623
Kevin Wolf92082412019-06-13 17:34:03 +0200624void monitor_data_init(Monitor *mon, bool is_qmp, bool skip_flush,
Kevin Wolf1d95db72019-06-13 17:34:02 +0200625 bool use_io_thread)
626{
627 if (use_io_thread && !mon_iothread) {
628 monitor_iothread_init();
629 }
630 qemu_mutex_init(&mon->mon_lock);
Kevin Wolf92082412019-06-13 17:34:03 +0200631 mon->is_qmp = is_qmp;
Markus Armbruster20076f42020-12-11 18:11:34 +0100632 mon->outbuf = g_string_new(NULL);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200633 mon->skip_flush = skip_flush;
634 mon->use_io_thread = use_io_thread;
Kevin Wolf1d95db72019-06-13 17:34:02 +0200635}
636
637void monitor_data_destroy(Monitor *mon)
638{
639 g_free(mon->mon_cpu_path);
640 qemu_chr_fe_deinit(&mon->chr, false);
641 if (monitor_is_qmp(mon)) {
642 monitor_data_destroy_qmp(container_of(mon, MonitorQMP, common));
643 } else {
644 readline_free(container_of(mon, MonitorHMP, common)->rs);
645 }
Markus Armbruster20076f42020-12-11 18:11:34 +0100646 g_string_free(mon->outbuf, true);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200647 qemu_mutex_destroy(&mon->mon_lock);
648}
649
Kevin Wolf1d95db72019-06-13 17:34:02 +0200650void monitor_cleanup(void)
651{
652 /*
Kevin Wolf357bda92020-10-13 14:50:27 +0200653 * The dispatcher needs to stop before destroying the monitor and
654 * the I/O thread.
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200655 *
656 * We need to poll both qemu_aio_context and iohandler_ctx to make
657 * sure that the dispatcher coroutine keeps making progress and
658 * eventually terminates. qemu_aio_context is automatically
Stefan Hajnoczi9612aa42023-03-09 14:08:55 -0500659 * polled by calling AIO_WAIT_WHILE_UNLOCKED on it, but we must poll
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200660 * iohandler_ctx manually.
Kevin Wolfc81219a2021-02-12 18:20:27 +0100661 *
662 * Letting the iothread continue while shutting down the dispatcher
663 * means that new requests may still be coming in. This is okay,
664 * we'll just leave them in the queue without sending a response
665 * and monitor_data_destroy() will free them.
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200666 */
Paolo Bonzini0ff25532023-03-03 12:51:33 +0100667 WITH_QEMU_LOCK_GUARD(&monitor_lock) {
668 qmp_dispatcher_co_shutdown = true;
669 }
Paolo Bonzini9f2d5852023-03-03 13:51:44 +0100670 qmp_dispatcher_co_wake();
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200671
Stefan Hajnoczi9612aa42023-03-09 14:08:55 -0500672 AIO_WAIT_WHILE_UNLOCKED(NULL,
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200673 (aio_poll(iohandler_get_aio_context(), false),
Paolo Bonzini3e6bed62023-03-03 12:45:29 +0100674 qatomic_read(&qmp_dispatcher_co)));
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200675
Kevin Wolfc81219a2021-02-12 18:20:27 +0100676 /*
677 * We need to explicitly stop the I/O thread (but not destroy it),
678 * clean up the monitor resources, then destroy the I/O thread since
679 * we need to unregister from chardev below in
680 * monitor_data_destroy(), and chardev is not thread-safe yet
681 */
682 if (mon_iothread) {
683 iothread_stop(mon_iothread);
684 }
685
Kevin Wolf357bda92020-10-13 14:50:27 +0200686 /* Flush output buffers and destroy monitors */
687 qemu_mutex_lock(&monitor_lock);
688 monitor_destroyed = true;
689 while (!QTAILQ_EMPTY(&mon_list)) {
690 Monitor *mon = QTAILQ_FIRST(&mon_list);
691 QTAILQ_REMOVE(&mon_list, mon, entry);
692 /* Permit QAPI event emission from character frontend release */
693 qemu_mutex_unlock(&monitor_lock);
694 monitor_flush(mon);
695 monitor_data_destroy(mon);
696 qemu_mutex_lock(&monitor_lock);
697 g_free(mon);
698 }
699 qemu_mutex_unlock(&monitor_lock);
700
Kevin Wolf1d95db72019-06-13 17:34:02 +0200701 if (mon_iothread) {
702 iothread_destroy(mon_iothread);
703 mon_iothread = NULL;
704 }
705}
706
707static void monitor_qapi_event_init(void)
708{
709 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
710 qapi_event_throttle_equal);
711}
712
Markus Armbruster9d2b5f22023-01-24 13:19:45 +0100713void monitor_init_globals(void)
Kevin Wolf1d95db72019-06-13 17:34:02 +0200714{
715 monitor_qapi_event_init();
716 qemu_mutex_init(&monitor_lock);
Kevin Wolfe69ee452020-10-05 17:58:48 +0200717 coroutine_mon = g_hash_table_new(NULL, NULL);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200718
719 /*
720 * The dispatcher BH must run in the main loop thread, since we
721 * have commands assuming that context. It would be nice to get
722 * rid of those assumptions.
723 */
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200724 qmp_dispatcher_co = qemu_coroutine_create(monitor_qmp_dispatcher_co, NULL);
Kevin Wolf9ce44e22020-10-05 17:58:50 +0200725 aio_co_schedule(iohandler_get_aio_context(), qmp_dispatcher_co);
Kevin Wolf1d95db72019-06-13 17:34:02 +0200726}
727
Kevin Wolfa2f411c2020-02-24 15:30:07 +0100728int monitor_init(MonitorOptions *opts, bool allow_hmp, Error **errp)
Kevin Wolfc3e95552020-01-29 11:22:36 +0100729{
Markus Armbruster50707b32022-11-21 09:50:49 +0100730 ERRP_GUARD();
Kevin Wolfc3e95552020-01-29 11:22:36 +0100731 Chardev *chr;
Kevin Wolfc3e95552020-01-29 11:22:36 +0100732
Kevin Wolff2098722020-02-24 15:30:04 +0100733 chr = qemu_chr_find(opts->chardev);
Kevin Wolfc3e95552020-01-29 11:22:36 +0100734 if (chr == NULL) {
Kevin Wolff2098722020-02-24 15:30:04 +0100735 error_setg(errp, "chardev \"%s\" not found", opts->chardev);
Kevin Wolfc3e95552020-01-29 11:22:36 +0100736 return -1;
737 }
738
Kevin Wolfa2f411c2020-02-24 15:30:07 +0100739 if (!opts->has_mode) {
740 opts->mode = allow_hmp ? MONITOR_MODE_READLINE : MONITOR_MODE_CONTROL;
741 }
742
Kevin Wolff2098722020-02-24 15:30:04 +0100743 switch (opts->mode) {
744 case MONITOR_MODE_CONTROL:
Markus Armbruster50707b32022-11-21 09:50:49 +0100745 monitor_init_qmp(chr, opts->pretty, errp);
Kevin Wolff2098722020-02-24 15:30:04 +0100746 break;
747 case MONITOR_MODE_READLINE:
Kevin Wolfa2f411c2020-02-24 15:30:07 +0100748 if (!allow_hmp) {
749 error_setg(errp, "Only QMP is supported");
750 return -1;
751 }
Kevin Wolff2098722020-02-24 15:30:04 +0100752 if (opts->pretty) {
Daniel P. Berrangé283d8452021-02-19 17:56:13 +0000753 error_setg(errp, "'pretty' is not compatible with HMP monitors");
754 return -1;
Kevin Wolff2098722020-02-24 15:30:04 +0100755 }
Markus Armbruster50707b32022-11-21 09:50:49 +0100756 monitor_init_hmp(chr, true, errp);
Kevin Wolff2098722020-02-24 15:30:04 +0100757 break;
758 default:
759 g_assert_not_reached();
760 }
761
Markus Armbruster50707b32022-11-21 09:50:49 +0100762 return *errp ? -1 : 0;
Kevin Wolff2098722020-02-24 15:30:04 +0100763}
764
765int monitor_init_opts(QemuOpts *opts, Error **errp)
766{
767 Visitor *v;
768 MonitorOptions *options;
Markus Armbrusterb11a0932020-07-07 18:06:07 +0200769 int ret;
Kevin Wolff2098722020-02-24 15:30:04 +0100770
771 v = opts_visitor_new(opts);
Markus Armbrusterb11a0932020-07-07 18:06:07 +0200772 visit_type_MonitorOptions(v, NULL, &options, errp);
Kevin Wolff2098722020-02-24 15:30:04 +0100773 visit_free(v);
Markus Armbrusterb11a0932020-07-07 18:06:07 +0200774 if (!options) {
Kevin Wolff2098722020-02-24 15:30:04 +0100775 return -1;
Kevin Wolfc3e95552020-01-29 11:22:36 +0100776 }
Markus Armbrusterb11a0932020-07-07 18:06:07 +0200777
778 ret = monitor_init(options, true, errp);
779 qapi_free_MonitorOptions(options);
780 return ret;
Kevin Wolfc3e95552020-01-29 11:22:36 +0100781}
782
Kevin Wolf1d95db72019-06-13 17:34:02 +0200783QemuOptsList qemu_mon_opts = {
784 .name = "mon",
785 .implied_opt_name = "chardev",
786 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
787 .desc = {
788 {
789 .name = "mode",
790 .type = QEMU_OPT_STRING,
791 },{
792 .name = "chardev",
793 .type = QEMU_OPT_STRING,
794 },{
795 .name = "pretty",
796 .type = QEMU_OPT_BOOL,
797 },
798 { /* end of list */ }
799 },
800};