1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25#include "qemu/osdep.h"
26#include "monitor-internal.h"
27#include "qapi/error.h"
28#include "qapi/opts-visitor.h"
29#include "qapi/qapi-emit-events.h"
30#include "qapi/qapi-visit-control.h"
31#include "qapi/qmp/qdict.h"
32#include "qemu/error-report.h"
33#include "qemu/option.h"
34#include "sysemu/qtest.h"
35#include "trace.h"
36
37
38
39
40
41
42typedef struct MonitorQAPIEventState {
43 QAPIEvent event;
44 QDict *data;
45 QEMUTimer *timer;
46 QDict *qdict;
47} MonitorQAPIEventState;
48
49typedef struct {
50 int64_t rate;
51} MonitorQAPIEventConf;
52
53
54IOThread *mon_iothread;
55
56
57Coroutine *qmp_dispatcher_co;
58
59
60bool qmp_dispatcher_co_shutdown;
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81bool qmp_dispatcher_co_busy;
82
83
84
85
86
87QemuMutex monitor_lock;
88static GHashTable *monitor_qapi_event_state;
89static GHashTable *coroutine_mon;
90
91MonitorList mon_list;
92int mon_refcount;
93static bool monitor_destroyed;
94
95Monitor *monitor_cur(void)
96{
97 Monitor *mon;
98
99 qemu_mutex_lock(&monitor_lock);
100 mon = g_hash_table_lookup(coroutine_mon, qemu_coroutine_self());
101 qemu_mutex_unlock(&monitor_lock);
102
103 return mon;
104}
105
106
107
108
109
110
111
112
113Monitor *monitor_set_cur(Coroutine *co, Monitor *mon)
114{
115 Monitor *old_monitor = monitor_cur();
116
117 qemu_mutex_lock(&monitor_lock);
118 if (mon) {
119 g_hash_table_replace(coroutine_mon, co, mon);
120 } else {
121 g_hash_table_remove(coroutine_mon, co);
122 }
123 qemu_mutex_unlock(&monitor_lock);
124
125 return old_monitor;
126}
127
128
129
130
131bool monitor_cur_is_qmp(void)
132{
133 Monitor *cur_mon = monitor_cur();
134
135 return cur_mon && monitor_is_qmp(cur_mon);
136}
137
138
139
140
141
142
143static inline bool monitor_uses_readline(const MonitorHMP *mon)
144{
145 return mon->use_readline;
146}
147
148static inline bool monitor_is_hmp_non_interactive(const Monitor *mon)
149{
150 if (monitor_is_qmp(mon)) {
151 return false;
152 }
153
154 return !monitor_uses_readline(container_of(mon, MonitorHMP, common));
155}
156
157static void monitor_flush_locked(Monitor *mon);
158
159static gboolean monitor_unblocked(void *do_not_use, GIOCondition cond,
160 void *opaque)
161{
162 Monitor *mon = opaque;
163
164 qemu_mutex_lock(&mon->mon_lock);
165 mon->out_watch = 0;
166 monitor_flush_locked(mon);
167 qemu_mutex_unlock(&mon->mon_lock);
168 return FALSE;
169}
170
171
172static void monitor_flush_locked(Monitor *mon)
173{
174 int rc;
175 size_t len;
176 const char *buf;
177
178 if (mon->skip_flush) {
179 return;
180 }
181
182 buf = mon->outbuf->str;
183 len = mon->outbuf->len;
184
185 if (len && !mon->mux_out) {
186 rc = qemu_chr_fe_write(&mon->chr, (const uint8_t *) buf, len);
187 if ((rc < 0 && errno != EAGAIN) || (rc == len)) {
188
189 g_string_truncate(mon->outbuf, 0);
190 return;
191 }
192 if (rc > 0) {
193
194 g_string_erase(mon->outbuf, 0, rc);
195 }
196 if (mon->out_watch == 0) {
197 mon->out_watch =
198 qemu_chr_fe_add_watch(&mon->chr, G_IO_OUT | G_IO_HUP,
199 monitor_unblocked, mon);
200 }
201 }
202}
203
204void monitor_flush(Monitor *mon)
205{
206 qemu_mutex_lock(&mon->mon_lock);
207 monitor_flush_locked(mon);
208 qemu_mutex_unlock(&mon->mon_lock);
209}
210
211
212int monitor_puts(Monitor *mon, const char *str)
213{
214 int i;
215 char c;
216
217 qemu_mutex_lock(&mon->mon_lock);
218 for (i = 0; str[i]; i++) {
219 c = str[i];
220 if (c == '\n') {
221 g_string_append_c(mon->outbuf, '\r');
222 }
223 g_string_append_c(mon->outbuf, c);
224 if (c == '\n') {
225 monitor_flush_locked(mon);
226 }
227 }
228 qemu_mutex_unlock(&mon->mon_lock);
229
230 return i;
231}
232
233int monitor_vprintf(Monitor *mon, const char *fmt, va_list ap)
234{
235 char *buf;
236 int n;
237
238 if (!mon) {
239 return -1;
240 }
241
242 if (monitor_is_qmp(mon)) {
243 return -1;
244 }
245
246 buf = g_strdup_vprintf(fmt, ap);
247 n = monitor_puts(mon, buf);
248 g_free(buf);
249 return n;
250}
251
252int monitor_printf(Monitor *mon, const char *fmt, ...)
253{
254 int ret;
255
256 va_list ap;
257 va_start(ap, fmt);
258 ret = monitor_vprintf(mon, fmt, ap);
259 va_end(ap);
260 return ret;
261}
262
263
264
265
266int error_vprintf(const char *fmt, va_list ap)
267{
268 Monitor *cur_mon = monitor_cur();
269
270 if (cur_mon && !monitor_cur_is_qmp()) {
271 return monitor_vprintf(cur_mon, fmt, ap);
272 }
273 return vfprintf(stderr, fmt, ap);
274}
275
276int error_vprintf_unless_qmp(const char *fmt, va_list ap)
277{
278 Monitor *cur_mon = monitor_cur();
279
280 if (!cur_mon) {
281 return vfprintf(stderr, fmt, ap);
282 }
283 if (!monitor_cur_is_qmp()) {
284 return monitor_vprintf(cur_mon, fmt, ap);
285 }
286 return -1;
287}
288
289
290static MonitorQAPIEventConf monitor_qapi_event_conf[QAPI_EVENT__MAX] = {
291
292 [QAPI_EVENT_RTC_CHANGE] = { 1000 * SCALE_MS },
293 [QAPI_EVENT_WATCHDOG] = { 1000 * SCALE_MS },
294 [QAPI_EVENT_BALLOON_CHANGE] = { 1000 * SCALE_MS },
295 [QAPI_EVENT_QUORUM_REPORT_BAD] = { 1000 * SCALE_MS },
296 [QAPI_EVENT_QUORUM_FAILURE] = { 1000 * SCALE_MS },
297 [QAPI_EVENT_VSERPORT_CHANGE] = { 1000 * SCALE_MS },
298 [QAPI_EVENT_MEMORY_DEVICE_SIZE_CHANGE] = { 1000 * SCALE_MS },
299};
300
301
302
303
304
305
306
307static inline QEMUClockType monitor_get_event_clock(void)
308{
309 return qtest_enabled() ? QEMU_CLOCK_VIRTUAL : QEMU_CLOCK_REALTIME;
310}
311
312
313
314
315
316
317static void monitor_qapi_event_emit(QAPIEvent event, QDict *qdict)
318{
319 Monitor *mon;
320 MonitorQMP *qmp_mon;
321
322 trace_monitor_protocol_event_emit(event, qdict);
323 QTAILQ_FOREACH(mon, &mon_list, entry) {
324 if (!monitor_is_qmp(mon)) {
325 continue;
326 }
327
328 qmp_mon = container_of(mon, MonitorQMP, common);
329 if (qmp_mon->commands != &qmp_cap_negotiation_commands) {
330 qmp_send_response(qmp_mon, qdict);
331 }
332 }
333}
334
335static void monitor_qapi_event_handler(void *opaque);
336
337
338
339
340
341static void
342monitor_qapi_event_queue_no_reenter(QAPIEvent event, QDict *qdict)
343{
344 MonitorQAPIEventConf *evconf;
345 MonitorQAPIEventState *evstate;
346
347 assert(event < QAPI_EVENT__MAX);
348 evconf = &monitor_qapi_event_conf[event];
349 trace_monitor_protocol_event_queue(event, qdict, evconf->rate);
350
351 QEMU_LOCK_GUARD(&monitor_lock);
352
353 if (!evconf->rate) {
354
355 monitor_qapi_event_emit(event, qdict);
356 } else {
357 QDict *data = qobject_to(QDict, qdict_get(qdict, "data"));
358 MonitorQAPIEventState key = { .event = event, .data = data };
359
360 evstate = g_hash_table_lookup(monitor_qapi_event_state, &key);
361 assert(!evstate || timer_pending(evstate->timer));
362
363 if (evstate) {
364
365
366
367
368
369 qobject_unref(evstate->qdict);
370 evstate->qdict = qobject_ref(qdict);
371 } else {
372
373
374
375
376
377
378 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
379
380 monitor_qapi_event_emit(event, qdict);
381
382 evstate = g_new(MonitorQAPIEventState, 1);
383 evstate->event = event;
384 evstate->data = qobject_ref(data);
385 evstate->qdict = NULL;
386 evstate->timer = timer_new_ns(monitor_get_event_clock(),
387 monitor_qapi_event_handler,
388 evstate);
389 g_hash_table_add(monitor_qapi_event_state, evstate);
390 timer_mod_ns(evstate->timer, now + evconf->rate);
391 }
392 }
393}
394
395void qapi_event_emit(QAPIEvent event, QDict *qdict)
396{
397
398
399
400
401
402
403 typedef struct MonitorQapiEvent {
404 QAPIEvent event;
405 QDict *qdict;
406 QSIMPLEQ_ENTRY(MonitorQapiEvent) entry;
407 } MonitorQapiEvent;
408 static __thread QSIMPLEQ_HEAD(, MonitorQapiEvent) event_queue;
409 static __thread bool reentered;
410 MonitorQapiEvent *ev;
411
412 if (!reentered) {
413 QSIMPLEQ_INIT(&event_queue);
414 }
415
416 ev = g_new(MonitorQapiEvent, 1);
417 ev->qdict = qobject_ref(qdict);
418 ev->event = event;
419 QSIMPLEQ_INSERT_TAIL(&event_queue, ev, entry);
420 if (reentered) {
421 return;
422 }
423
424 reentered = true;
425
426 while ((ev = QSIMPLEQ_FIRST(&event_queue)) != NULL) {
427 QSIMPLEQ_REMOVE_HEAD(&event_queue, entry);
428 monitor_qapi_event_queue_no_reenter(ev->event, ev->qdict);
429 qobject_unref(ev->qdict);
430 g_free(ev);
431 }
432
433 reentered = false;
434}
435
436
437
438
439
440
441static void monitor_qapi_event_handler(void *opaque)
442{
443 MonitorQAPIEventState *evstate = opaque;
444 MonitorQAPIEventConf *evconf = &monitor_qapi_event_conf[evstate->event];
445
446 trace_monitor_protocol_event_handler(evstate->event, evstate->qdict);
447 QEMU_LOCK_GUARD(&monitor_lock);
448
449 if (evstate->qdict) {
450 int64_t now = qemu_clock_get_ns(monitor_get_event_clock());
451
452 monitor_qapi_event_emit(evstate->event, evstate->qdict);
453 qobject_unref(evstate->qdict);
454 evstate->qdict = NULL;
455 timer_mod_ns(evstate->timer, now + evconf->rate);
456 } else {
457 g_hash_table_remove(monitor_qapi_event_state, evstate);
458 qobject_unref(evstate->data);
459 timer_free(evstate->timer);
460 g_free(evstate);
461 }
462}
463
464static unsigned int qapi_event_throttle_hash(const void *key)
465{
466 const MonitorQAPIEventState *evstate = key;
467 unsigned int hash = evstate->event * 255;
468
469 if (evstate->event == QAPI_EVENT_VSERPORT_CHANGE) {
470 hash += g_str_hash(qdict_get_str(evstate->data, "id"));
471 }
472
473 if (evstate->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
474 hash += g_str_hash(qdict_get_str(evstate->data, "node-name"));
475 }
476
477 return hash;
478}
479
480static gboolean qapi_event_throttle_equal(const void *a, const void *b)
481{
482 const MonitorQAPIEventState *eva = a;
483 const MonitorQAPIEventState *evb = b;
484
485 if (eva->event != evb->event) {
486 return FALSE;
487 }
488
489 if (eva->event == QAPI_EVENT_VSERPORT_CHANGE) {
490 return !strcmp(qdict_get_str(eva->data, "id"),
491 qdict_get_str(evb->data, "id"));
492 }
493
494 if (eva->event == QAPI_EVENT_QUORUM_REPORT_BAD) {
495 return !strcmp(qdict_get_str(eva->data, "node-name"),
496 qdict_get_str(evb->data, "node-name"));
497 }
498
499 return TRUE;
500}
501
502int monitor_suspend(Monitor *mon)
503{
504 if (monitor_is_hmp_non_interactive(mon)) {
505 return -ENOTTY;
506 }
507
508 qatomic_inc(&mon->suspend_cnt);
509
510 if (mon->use_io_thread) {
511
512
513
514
515 aio_notify(iothread_get_aio_context(mon_iothread));
516 }
517
518 trace_monitor_suspend(mon, 1);
519 return 0;
520}
521
522static void monitor_accept_input(void *opaque)
523{
524 Monitor *mon = opaque;
525
526 qemu_chr_fe_accept_input(&mon->chr);
527}
528
529void monitor_resume(Monitor *mon)
530{
531 if (monitor_is_hmp_non_interactive(mon)) {
532 return;
533 }
534
535 if (qatomic_dec_fetch(&mon->suspend_cnt) == 0) {
536 AioContext *ctx;
537
538 if (mon->use_io_thread) {
539 ctx = iothread_get_aio_context(mon_iothread);
540 } else {
541 ctx = qemu_get_aio_context();
542 }
543
544 if (!monitor_is_qmp(mon)) {
545 MonitorHMP *hmp_mon = container_of(mon, MonitorHMP, common);
546 assert(hmp_mon->rs);
547 readline_show_prompt(hmp_mon->rs);
548 }
549
550 aio_bh_schedule_oneshot(ctx, monitor_accept_input, mon);
551 }
552
553 trace_monitor_suspend(mon, -1);
554}
555
556int monitor_can_read(void *opaque)
557{
558 Monitor *mon = opaque;
559
560 return !qatomic_mb_read(&mon->suspend_cnt);
561}
562
563void monitor_list_append(Monitor *mon)
564{
565 qemu_mutex_lock(&monitor_lock);
566
567
568
569
570
571 if (!monitor_destroyed) {
572 QTAILQ_INSERT_HEAD(&mon_list, mon, entry);
573 mon = NULL;
574 }
575 qemu_mutex_unlock(&monitor_lock);
576
577 if (mon) {
578 monitor_data_destroy(mon);
579 g_free(mon);
580 }
581}
582
583static void monitor_iothread_init(void)
584{
585 mon_iothread = iothread_create("mon_iothread", &error_abort);
586}
587
588void monitor_data_init(Monitor *mon, bool is_qmp, bool skip_flush,
589 bool use_io_thread)
590{
591 if (use_io_thread && !mon_iothread) {
592 monitor_iothread_init();
593 }
594 qemu_mutex_init(&mon->mon_lock);
595 mon->is_qmp = is_qmp;
596 mon->outbuf = g_string_new(NULL);
597 mon->skip_flush = skip_flush;
598 mon->use_io_thread = use_io_thread;
599}
600
601void monitor_data_destroy(Monitor *mon)
602{
603 g_free(mon->mon_cpu_path);
604 qemu_chr_fe_deinit(&mon->chr, false);
605 if (monitor_is_qmp(mon)) {
606 monitor_data_destroy_qmp(container_of(mon, MonitorQMP, common));
607 } else {
608 readline_free(container_of(mon, MonitorHMP, common)->rs);
609 }
610 g_string_free(mon->outbuf, true);
611 qemu_mutex_destroy(&mon->mon_lock);
612}
613
614void monitor_cleanup(void)
615{
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631 qmp_dispatcher_co_shutdown = true;
632 if (!qatomic_xchg(&qmp_dispatcher_co_busy, true)) {
633 aio_co_wake(qmp_dispatcher_co);
634 }
635
636 AIO_WAIT_WHILE(qemu_get_aio_context(),
637 (aio_poll(iohandler_get_aio_context(), false),
638 qatomic_mb_read(&qmp_dispatcher_co_busy)));
639
640
641
642
643
644
645
646 if (mon_iothread) {
647 iothread_stop(mon_iothread);
648 }
649
650
651 qemu_mutex_lock(&monitor_lock);
652 monitor_destroyed = true;
653 while (!QTAILQ_EMPTY(&mon_list)) {
654 Monitor *mon = QTAILQ_FIRST(&mon_list);
655 QTAILQ_REMOVE(&mon_list, mon, entry);
656
657 qemu_mutex_unlock(&monitor_lock);
658 monitor_flush(mon);
659 monitor_data_destroy(mon);
660 qemu_mutex_lock(&monitor_lock);
661 g_free(mon);
662 }
663 qemu_mutex_unlock(&monitor_lock);
664
665 if (mon_iothread) {
666 iothread_destroy(mon_iothread);
667 mon_iothread = NULL;
668 }
669}
670
671static void monitor_qapi_event_init(void)
672{
673 monitor_qapi_event_state = g_hash_table_new(qapi_event_throttle_hash,
674 qapi_event_throttle_equal);
675}
676
677void monitor_init_globals_core(void)
678{
679 monitor_qapi_event_init();
680 qemu_mutex_init(&monitor_lock);
681 coroutine_mon = g_hash_table_new(NULL, NULL);
682
683
684
685
686
687
688 qmp_dispatcher_co = qemu_coroutine_create(monitor_qmp_dispatcher_co, NULL);
689 qatomic_mb_set(&qmp_dispatcher_co_busy, true);
690 aio_co_schedule(iohandler_get_aio_context(), qmp_dispatcher_co);
691}
692
693int monitor_init(MonitorOptions *opts, bool allow_hmp, Error **errp)
694{
695 Chardev *chr;
696 Error *local_err = NULL;
697
698 chr = qemu_chr_find(opts->chardev);
699 if (chr == NULL) {
700 error_setg(errp, "chardev \"%s\" not found", opts->chardev);
701 return -1;
702 }
703
704 if (!opts->has_mode) {
705 opts->mode = allow_hmp ? MONITOR_MODE_READLINE : MONITOR_MODE_CONTROL;
706 }
707
708 switch (opts->mode) {
709 case MONITOR_MODE_CONTROL:
710 monitor_init_qmp(chr, opts->pretty, &local_err);
711 break;
712 case MONITOR_MODE_READLINE:
713 if (!allow_hmp) {
714 error_setg(errp, "Only QMP is supported");
715 return -1;
716 }
717 if (opts->pretty) {
718 error_setg(errp, "'pretty' is not compatible with HMP monitors");
719 return -1;
720 }
721 monitor_init_hmp(chr, true, &local_err);
722 break;
723 default:
724 g_assert_not_reached();
725 }
726
727 if (local_err) {
728 error_propagate(errp, local_err);
729 return -1;
730 }
731 return 0;
732}
733
734int monitor_init_opts(QemuOpts *opts, Error **errp)
735{
736 Visitor *v;
737 MonitorOptions *options;
738 int ret;
739
740 v = opts_visitor_new(opts);
741 visit_type_MonitorOptions(v, NULL, &options, errp);
742 visit_free(v);
743 if (!options) {
744 return -1;
745 }
746
747 ret = monitor_init(options, true, errp);
748 qapi_free_MonitorOptions(options);
749 return ret;
750}
751
752QemuOptsList qemu_mon_opts = {
753 .name = "mon",
754 .implied_opt_name = "chardev",
755 .head = QTAILQ_HEAD_INITIALIZER(qemu_mon_opts.head),
756 .desc = {
757 {
758 .name = "mode",
759 .type = QEMU_OPT_STRING,
760 },{
761 .name = "chardev",
762 .type = QEMU_OPT_STRING,
763 },{
764 .name = "pretty",
765 .type = QEMU_OPT_BOOL,
766 },
767 { }
768 },
769};
770