4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "qemu/cutils.h"
27 #include "monitor/monitor.h"
28 #include "sysemu/sysemu.h"
29 #include "qemu/config-file.h"
30 #include "qemu/error-report.h"
31 #include "qemu/qemu-print.h"
32 #include "chardev/char.h"
33 #include "qapi/error.h"
34 #include "qapi/qapi-commands-char.h"
35 #include "qapi/qmp/qerror.h"
36 #include "sysemu/replay.h"
37 #include "qemu/help_option.h"
38 #include "qemu/option.h"
40 #include "chardev/char-mux.h"
42 /***********************************************************/
43 /* character device */
45 static Object
*get_chardevs_root(void)
47 return container_get(object_get_root(), "/chardevs");
50 static void chr_be_event(Chardev
*s
, int event
)
52 CharBackend
*be
= s
->be
;
54 if (!be
|| !be
->chr_event
) {
58 be
->chr_event(be
->opaque
, event
);
61 void qemu_chr_be_event(Chardev
*s
, int event
)
63 /* Keep track if the char device is open */
65 case CHR_EVENT_OPENED
:
68 case CHR_EVENT_CLOSED
:
73 CHARDEV_GET_CLASS(s
)->chr_be_event(s
, event
);
76 /* Not reporting errors from writing to logfile, as logs are
77 * defined to be "best effort" only */
78 static void qemu_chr_write_log(Chardev
*s
, const uint8_t *buf
, size_t len
)
89 ret
= write(s
->logfd
, buf
+ done
, len
- done
);
90 if (ret
== -1 && errno
== EAGAIN
) {
102 static int qemu_chr_write_buffer(Chardev
*s
,
103 const uint8_t *buf
, int len
,
104 int *offset
, bool write_all
)
106 ChardevClass
*cc
= CHARDEV_GET_CLASS(s
);
110 qemu_mutex_lock(&s
->chr_write_lock
);
111 while (*offset
< len
) {
113 res
= cc
->chr_write(s
, buf
+ *offset
, len
- *offset
);
114 if (res
< 0 && errno
== EAGAIN
&& write_all
) {
129 qemu_chr_write_log(s
, buf
, *offset
);
131 qemu_mutex_unlock(&s
->chr_write_lock
);
136 int qemu_chr_write(Chardev
*s
, const uint8_t *buf
, int len
, bool write_all
)
141 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
142 replay_char_write_event_load(&res
, &offset
);
143 assert(offset
<= len
);
144 qemu_chr_write_buffer(s
, buf
, offset
, &offset
, true);
148 res
= qemu_chr_write_buffer(s
, buf
, len
, &offset
, write_all
);
150 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
151 replay_char_write_event_save(res
, offset
);
160 int qemu_chr_be_can_write(Chardev
*s
)
162 CharBackend
*be
= s
->be
;
164 if (!be
|| !be
->chr_can_read
) {
168 return be
->chr_can_read(be
->opaque
);
171 void qemu_chr_be_write_impl(Chardev
*s
, uint8_t *buf
, int len
)
173 CharBackend
*be
= s
->be
;
175 if (be
&& be
->chr_read
) {
176 be
->chr_read(be
->opaque
, buf
, len
);
180 void qemu_chr_be_write(Chardev
*s
, uint8_t *buf
, int len
)
182 if (qemu_chr_replay(s
)) {
183 if (replay_mode
== REPLAY_MODE_PLAY
) {
186 replay_chr_be_write(s
, buf
, len
);
188 qemu_chr_be_write_impl(s
, buf
, len
);
192 void qemu_chr_be_update_read_handlers(Chardev
*s
,
193 GMainContext
*context
)
195 ChardevClass
*cc
= CHARDEV_GET_CLASS(s
);
197 assert(qemu_chr_has_feature(s
, QEMU_CHAR_FEATURE_GCONTEXT
)
199 s
->gcontext
= context
;
200 if (cc
->chr_update_read_handler
) {
201 cc
->chr_update_read_handler(s
);
205 int qemu_chr_add_client(Chardev
*s
, int fd
)
207 return CHARDEV_GET_CLASS(s
)->chr_add_client
?
208 CHARDEV_GET_CLASS(s
)->chr_add_client(s
, fd
) : -1;
211 static void qemu_char_open(Chardev
*chr
, ChardevBackend
*backend
,
212 bool *be_opened
, Error
**errp
)
214 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
215 /* Any ChardevCommon member would work */
216 ChardevCommon
*common
= backend
? backend
->u
.null
.data
: NULL
;
218 if (common
&& common
->has_logfile
) {
219 int flags
= O_WRONLY
| O_CREAT
;
220 if (common
->has_logappend
&&
226 chr
->logfd
= qemu_open(common
->logfile
, flags
, 0666);
227 if (chr
->logfd
< 0) {
228 error_setg_errno(errp
, errno
,
229 "Unable to open logfile %s",
236 cc
->open(chr
, backend
, be_opened
, errp
);
240 static void char_init(Object
*obj
)
242 Chardev
*chr
= CHARDEV(obj
);
245 qemu_mutex_init(&chr
->chr_write_lock
);
248 * Assume if chr_update_read_handler is implemented it will
249 * take the updated gcontext into account.
251 if (CHARDEV_GET_CLASS(chr
)->chr_update_read_handler
) {
252 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_GCONTEXT
);
257 static int null_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
262 static void char_class_init(ObjectClass
*oc
, void *data
)
264 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
266 cc
->chr_write
= null_chr_write
;
267 cc
->chr_be_event
= chr_be_event
;
270 static void char_finalize(Object
*obj
)
272 Chardev
*chr
= CHARDEV(obj
);
277 g_free(chr
->filename
);
279 if (chr
->logfd
!= -1) {
282 qemu_mutex_destroy(&chr
->chr_write_lock
);
285 static const TypeInfo char_type_info
= {
286 .name
= TYPE_CHARDEV
,
287 .parent
= TYPE_OBJECT
,
288 .instance_size
= sizeof(Chardev
),
289 .instance_init
= char_init
,
290 .instance_finalize
= char_finalize
,
292 .class_size
= sizeof(ChardevClass
),
293 .class_init
= char_class_init
,
296 static int chardev_machine_done_notify_one(Object
*child
, void *opaque
)
298 Chardev
*chr
= (Chardev
*)child
;
299 ChardevClass
*class = CHARDEV_GET_CLASS(chr
);
301 if (class->chr_machine_done
) {
302 return class->chr_machine_done(chr
);
308 static void chardev_machine_done_hook(Notifier
*notifier
, void *unused
)
310 int ret
= object_child_foreach(get_chardevs_root(),
311 chardev_machine_done_notify_one
, NULL
);
314 error_report("Failed to call chardev machine_done hooks");
319 static Notifier chardev_machine_done_notify
= {
320 .notify
= chardev_machine_done_hook
,
323 static bool qemu_chr_is_busy(Chardev
*s
)
325 if (CHARDEV_IS_MUX(s
)) {
326 MuxChardev
*d
= MUX_CHARDEV(s
);
327 return d
->mux_cnt
>= 0;
329 return s
->be
!= NULL
;
333 int qemu_chr_wait_connected(Chardev
*chr
, Error
**errp
)
335 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
337 if (cc
->chr_wait_connected
) {
338 return cc
->chr_wait_connected(chr
, errp
);
344 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
,
347 char host
[65], port
[33], width
[8], height
[8];
351 Error
*local_err
= NULL
;
353 opts
= qemu_opts_create(qemu_find_opts("chardev"), label
, 1, &local_err
);
355 error_report_err(local_err
);
359 if (strstart(filename
, "mon:", &p
)) {
360 if (!permit_mux_mon
) {
361 error_report("mon: isn't supported in this context");
365 qemu_opt_set(opts
, "mux", "on", &error_abort
);
366 if (strcmp(filename
, "stdio") == 0) {
367 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
368 * but pass it to the guest. Handle this only for compat syntax,
369 * for -chardev syntax we have special option for this.
370 * This is what -nographic did, redirecting+muxing serial+monitor
371 * to stdio causing Ctrl+C to be passed to guest. */
372 qemu_opt_set(opts
, "signal", "off", &error_abort
);
376 if (strcmp(filename
, "null") == 0 ||
377 strcmp(filename
, "pty") == 0 ||
378 strcmp(filename
, "msmouse") == 0 ||
379 strcmp(filename
, "wctablet") == 0 ||
380 strcmp(filename
, "braille") == 0 ||
381 strcmp(filename
, "testdev") == 0 ||
382 strcmp(filename
, "stdio") == 0) {
383 qemu_opt_set(opts
, "backend", filename
, &error_abort
);
386 if (strstart(filename
, "vc", &p
)) {
387 qemu_opt_set(opts
, "backend", "vc", &error_abort
);
389 if (sscanf(p
+1, "%7[0-9]x%7[0-9]", width
, height
) == 2) {
391 qemu_opt_set(opts
, "width", width
, &error_abort
);
392 qemu_opt_set(opts
, "height", height
, &error_abort
);
393 } else if (sscanf(p
+1, "%7[0-9]Cx%7[0-9]C", width
, height
) == 2) {
395 qemu_opt_set(opts
, "cols", width
, &error_abort
);
396 qemu_opt_set(opts
, "rows", height
, &error_abort
);
403 if (strcmp(filename
, "con:") == 0) {
404 qemu_opt_set(opts
, "backend", "console", &error_abort
);
407 if (strstart(filename
, "COM", NULL
)) {
408 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
409 qemu_opt_set(opts
, "path", filename
, &error_abort
);
412 if (strstart(filename
, "file:", &p
)) {
413 qemu_opt_set(opts
, "backend", "file", &error_abort
);
414 qemu_opt_set(opts
, "path", p
, &error_abort
);
417 if (strstart(filename
, "pipe:", &p
)) {
418 qemu_opt_set(opts
, "backend", "pipe", &error_abort
);
419 qemu_opt_set(opts
, "path", p
, &error_abort
);
422 if (strstart(filename
, "tcp:", &p
) ||
423 strstart(filename
, "telnet:", &p
) ||
424 strstart(filename
, "tn3270:", &p
) ||
425 strstart(filename
, "websocket:", &p
)) {
426 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
428 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1)
431 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
432 qemu_opt_set(opts
, "host", host
, &error_abort
);
433 qemu_opt_set(opts
, "port", port
, &error_abort
);
435 qemu_opts_do_parse(opts
, p
+pos
+1, NULL
, &local_err
);
437 error_report_err(local_err
);
441 if (strstart(filename
, "telnet:", &p
)) {
442 qemu_opt_set(opts
, "telnet", "on", &error_abort
);
443 } else if (strstart(filename
, "tn3270:", &p
)) {
444 qemu_opt_set(opts
, "tn3270", "on", &error_abort
);
445 } else if (strstart(filename
, "websocket:", &p
)) {
446 qemu_opt_set(opts
, "websocket", "on", &error_abort
);
450 if (strstart(filename
, "udp:", &p
)) {
451 qemu_opt_set(opts
, "backend", "udp", &error_abort
);
452 if (sscanf(p
, "%64[^:]:%32[^@,]%n", host
, port
, &pos
) < 2) {
454 if (sscanf(p
, ":%32[^@,]%n", port
, &pos
) < 1) {
458 qemu_opt_set(opts
, "host", host
, &error_abort
);
459 qemu_opt_set(opts
, "port", port
, &error_abort
);
462 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
464 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1) {
468 qemu_opt_set(opts
, "localaddr", host
, &error_abort
);
469 qemu_opt_set(opts
, "localport", port
, &error_abort
);
473 if (strstart(filename
, "unix:", &p
)) {
474 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
475 qemu_opts_do_parse(opts
, p
, "path", &local_err
);
477 error_report_err(local_err
);
482 if (strstart(filename
, "/dev/parport", NULL
) ||
483 strstart(filename
, "/dev/ppi", NULL
)) {
484 qemu_opt_set(opts
, "backend", "parallel", &error_abort
);
485 qemu_opt_set(opts
, "path", filename
, &error_abort
);
488 if (strstart(filename
, "/dev/", NULL
)) {
489 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
490 qemu_opt_set(opts
, "path", filename
, &error_abort
);
494 error_report("'%s' is not a valid char driver", filename
);
501 void qemu_chr_parse_common(QemuOpts
*opts
, ChardevCommon
*backend
)
503 const char *logfile
= qemu_opt_get(opts
, "logfile");
505 backend
->has_logfile
= logfile
!= NULL
;
506 backend
->logfile
= g_strdup(logfile
);
508 backend
->has_logappend
= true;
509 backend
->logappend
= qemu_opt_get_bool(opts
, "logappend", false);
512 static const ChardevClass
*char_get_class(const char *driver
, Error
**errp
)
515 const ChardevClass
*cc
;
516 char *typename
= g_strdup_printf("chardev-%s", driver
);
518 oc
= object_class_by_name(typename
);
521 if (!object_class_dynamic_cast(oc
, TYPE_CHARDEV
)) {
522 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
526 if (object_class_is_abstract(oc
)) {
527 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
528 "abstract device type");
532 cc
= CHARDEV_CLASS(oc
);
534 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
541 static const struct ChardevAlias
{
542 const char *typename
;
544 } chardev_alias_table
[] = {
545 #ifdef HAVE_CHARDEV_PARPORT
546 { "parallel", "parport" },
548 #ifdef HAVE_CHARDEV_SERIAL
553 typedef struct ChadevClassFE
{
554 void (*fn
)(const char *name
, void *opaque
);
559 chardev_class_foreach(ObjectClass
*klass
, void *opaque
)
561 ChadevClassFE
*fe
= opaque
;
563 assert(g_str_has_prefix(object_class_get_name(klass
), "chardev-"));
564 if (CHARDEV_CLASS(klass
)->internal
) {
568 fe
->fn(object_class_get_name(klass
) + 8, fe
->opaque
);
572 chardev_name_foreach(void (*fn
)(const char *name
, void *opaque
), void *opaque
)
574 ChadevClassFE fe
= { .fn
= fn
, .opaque
= opaque
};
577 object_class_foreach(chardev_class_foreach
, TYPE_CHARDEV
, false, &fe
);
579 for (i
= 0; i
< (int)ARRAY_SIZE(chardev_alias_table
); i
++) {
580 fn(chardev_alias_table
[i
].alias
, opaque
);
585 help_string_append(const char *name
, void *opaque
)
587 GString
*str
= opaque
;
589 g_string_append_printf(str
, "\n %s", name
);
592 static const char *chardev_alias_translate(const char *name
)
595 for (i
= 0; i
< (int)ARRAY_SIZE(chardev_alias_table
); i
++) {
596 if (g_strcmp0(chardev_alias_table
[i
].alias
, name
) == 0) {
597 return chardev_alias_table
[i
].typename
;
603 ChardevBackend
*qemu_chr_parse_opts(QemuOpts
*opts
, Error
**errp
)
605 Error
*local_err
= NULL
;
606 const ChardevClass
*cc
;
607 ChardevBackend
*backend
= NULL
;
608 const char *name
= chardev_alias_translate(qemu_opt_get(opts
, "backend"));
611 error_setg(errp
, "chardev: \"%s\" missing backend",
616 cc
= char_get_class(name
, errp
);
621 backend
= g_new0(ChardevBackend
, 1);
622 backend
->type
= CHARDEV_BACKEND_KIND_NULL
;
625 cc
->parse(opts
, backend
, &local_err
);
627 error_propagate(errp
, local_err
);
628 qapi_free_ChardevBackend(backend
);
632 ChardevCommon
*ccom
= g_new0(ChardevCommon
, 1);
633 qemu_chr_parse_common(opts
, ccom
);
634 backend
->u
.null
.data
= ccom
; /* Any ChardevCommon member would work */
640 Chardev
*qemu_chr_new_from_opts(QemuOpts
*opts
, GMainContext
*context
,
643 const ChardevClass
*cc
;
645 ChardevBackend
*backend
= NULL
;
646 const char *name
= chardev_alias_translate(qemu_opt_get(opts
, "backend"));
647 const char *id
= qemu_opts_id(opts
);
650 if (name
&& is_help_option(name
)) {
651 GString
*str
= g_string_new("");
653 chardev_name_foreach(help_string_append
, str
);
655 qemu_printf("Available chardev backend types: %s\n", str
->str
);
656 g_string_free(str
, true);
661 error_setg(errp
, "chardev: no id specified");
665 backend
= qemu_chr_parse_opts(opts
, errp
);
666 if (backend
== NULL
) {
670 cc
= char_get_class(name
, errp
);
675 if (qemu_opt_get_bool(opts
, "mux", 0)) {
676 bid
= g_strdup_printf("%s-base", id
);
679 chr
= qemu_chardev_new(bid
? bid
: id
,
680 object_class_get_name(OBJECT_CLASS(cc
)),
681 backend
, context
, errp
);
689 qapi_free_ChardevBackend(backend
);
690 backend
= g_new0(ChardevBackend
, 1);
691 backend
->type
= CHARDEV_BACKEND_KIND_MUX
;
692 backend
->u
.mux
.data
= g_new0(ChardevMux
, 1);
693 backend
->u
.mux
.data
->chardev
= g_strdup(bid
);
694 mux
= qemu_chardev_new(id
, TYPE_CHARDEV_MUX
, backend
, context
, errp
);
696 object_unparent(OBJECT(chr
));
704 qapi_free_ChardevBackend(backend
);
709 Chardev
*qemu_chr_new_noreplay(const char *label
, const char *filename
,
710 bool permit_mux_mon
, GMainContext
*context
)
717 if (strstart(filename
, "chardev:", &p
)) {
718 return qemu_chr_find(p
);
721 opts
= qemu_chr_parse_compat(label
, filename
, permit_mux_mon
);
725 chr
= qemu_chr_new_from_opts(opts
, context
, &err
);
727 error_report_err(err
);
731 if (qemu_opt_get_bool(opts
, "mux", 0)) {
732 assert(permit_mux_mon
);
733 monitor_init(chr
, MONITOR_USE_READLINE
);
741 static Chardev
*qemu_chr_new_permit_mux_mon(const char *label
,
742 const char *filename
,
744 GMainContext
*context
)
747 chr
= qemu_chr_new_noreplay(label
, filename
, permit_mux_mon
, context
);
749 if (replay_mode
!= REPLAY_MODE_NONE
) {
750 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_REPLAY
);
752 if (qemu_chr_replay(chr
) && CHARDEV_GET_CLASS(chr
)->chr_ioctl
) {
753 error_report("Replay: ioctl is not supported "
754 "for serial devices yet");
756 replay_register_char_driver(chr
);
761 Chardev
*qemu_chr_new(const char *label
, const char *filename
,
762 GMainContext
*context
)
764 return qemu_chr_new_permit_mux_mon(label
, filename
, false, context
);
767 Chardev
*qemu_chr_new_mux_mon(const char *label
, const char *filename
,
768 GMainContext
*context
)
770 return qemu_chr_new_permit_mux_mon(label
, filename
, true, context
);
773 static int qmp_query_chardev_foreach(Object
*obj
, void *data
)
775 Chardev
*chr
= CHARDEV(obj
);
776 ChardevInfoList
**list
= data
;
777 ChardevInfoList
*info
= g_malloc0(sizeof(*info
));
779 info
->value
= g_malloc0(sizeof(*info
->value
));
780 info
->value
->label
= g_strdup(chr
->label
);
781 info
->value
->filename
= g_strdup(chr
->filename
);
782 info
->value
->frontend_open
= chr
->be
&& chr
->be
->fe_open
;
790 ChardevInfoList
*qmp_query_chardev(Error
**errp
)
792 ChardevInfoList
*chr_list
= NULL
;
794 object_child_foreach(get_chardevs_root(),
795 qmp_query_chardev_foreach
, &chr_list
);
801 qmp_prepend_backend(const char *name
, void *opaque
)
803 ChardevBackendInfoList
**list
= opaque
;
804 ChardevBackendInfoList
*info
= g_malloc0(sizeof(*info
));
806 info
->value
= g_malloc0(sizeof(*info
->value
));
807 info
->value
->name
= g_strdup(name
);
812 ChardevBackendInfoList
*qmp_query_chardev_backends(Error
**errp
)
814 ChardevBackendInfoList
*backend_list
= NULL
;
816 chardev_name_foreach(qmp_prepend_backend
, &backend_list
);
821 Chardev
*qemu_chr_find(const char *name
)
823 Object
*obj
= object_resolve_path_component(get_chardevs_root(), name
);
825 return obj
? CHARDEV(obj
) : NULL
;
828 QemuOptsList qemu_chardev_opts
= {
830 .implied_opt_name
= "backend",
831 .head
= QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts
.head
),
835 .type
= QEMU_OPT_STRING
,
838 .type
= QEMU_OPT_STRING
,
841 .type
= QEMU_OPT_STRING
,
844 .type
= QEMU_OPT_STRING
,
847 .type
= QEMU_OPT_STRING
,
850 .type
= QEMU_OPT_STRING
,
853 .type
= QEMU_OPT_STRING
,
856 .type
= QEMU_OPT_NUMBER
,
859 .type
= QEMU_OPT_BOOL
,
862 .type
= QEMU_OPT_BOOL
,
865 .type
= QEMU_OPT_BOOL
,
868 .type
= QEMU_OPT_BOOL
,
871 .type
= QEMU_OPT_BOOL
,
874 .type
= QEMU_OPT_NUMBER
,
877 .type
= QEMU_OPT_BOOL
,
880 .type
= QEMU_OPT_BOOL
,
883 .type
= QEMU_OPT_STRING
,
886 .type
= QEMU_OPT_STRING
,
889 .type
= QEMU_OPT_BOOL
,
892 .type
= QEMU_OPT_NUMBER
,
895 .type
= QEMU_OPT_NUMBER
,
898 .type
= QEMU_OPT_NUMBER
,
901 .type
= QEMU_OPT_NUMBER
,
904 .type
= QEMU_OPT_BOOL
,
907 .type
= QEMU_OPT_BOOL
,
910 .type
= QEMU_OPT_STRING
,
913 .type
= QEMU_OPT_NUMBER
,
916 .type
= QEMU_OPT_SIZE
,
919 .type
= QEMU_OPT_STRING
,
922 .type
= QEMU_OPT_BOOL
,
925 .type
= QEMU_OPT_STRING
,
928 .type
= QEMU_OPT_BOOL
,
930 { /* end of list */ }
934 bool qemu_chr_has_feature(Chardev
*chr
,
935 ChardevFeature feature
)
937 return test_bit(feature
, chr
->features
);
940 void qemu_chr_set_feature(Chardev
*chr
,
941 ChardevFeature feature
)
943 return set_bit(feature
, chr
->features
);
946 Chardev
*qemu_chardev_new(const char *id
, const char *typename
,
947 ChardevBackend
*backend
,
948 GMainContext
*gcontext
,
953 Error
*local_err
= NULL
;
954 bool be_opened
= true;
956 assert(g_str_has_prefix(typename
, "chardev-"));
958 obj
= object_new(typename
);
960 chr
->label
= g_strdup(id
);
961 chr
->gcontext
= gcontext
;
963 qemu_char_open(chr
, backend
, &be_opened
, &local_err
);
968 if (!chr
->filename
) {
969 chr
->filename
= g_strdup(typename
+ 8);
972 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
976 object_property_add_child(get_chardevs_root(), id
, obj
, &local_err
);
985 error_propagate(errp
, local_err
);
993 ChardevReturn
*qmp_chardev_add(const char *id
, ChardevBackend
*backend
,
996 const ChardevClass
*cc
;
1000 cc
= char_get_class(ChardevBackendKind_str(backend
->type
), errp
);
1005 chr
= qemu_chardev_new(id
, object_class_get_name(OBJECT_CLASS(cc
)),
1006 backend
, NULL
, errp
);
1011 ret
= g_new0(ChardevReturn
, 1);
1012 if (CHARDEV_IS_PTY(chr
)) {
1013 ret
->pty
= g_strdup(chr
->filename
+ 4);
1014 ret
->has_pty
= true;
1020 ChardevReturn
*qmp_chardev_change(const char *id
, ChardevBackend
*backend
,
1024 const ChardevClass
*cc
;
1025 Chardev
*chr
, *chr_new
;
1026 bool closed_sent
= false;
1029 chr
= qemu_chr_find(id
);
1031 error_setg(errp
, "Chardev '%s' does not exist", id
);
1035 if (CHARDEV_IS_MUX(chr
)) {
1036 error_setg(errp
, "Mux device hotswap not supported yet");
1040 if (qemu_chr_replay(chr
)) {
1042 "Chardev '%s' cannot be changed in record/replay mode", id
);
1049 object_unparent(OBJECT(chr
));
1050 return qmp_chardev_add(id
, backend
, errp
);
1053 if (!be
->chr_be_change
) {
1054 error_setg(errp
, "Chardev user does not support chardev hotswap");
1058 cc
= char_get_class(ChardevBackendKind_str(backend
->type
), errp
);
1063 chr_new
= qemu_chardev_new(NULL
, object_class_get_name(OBJECT_CLASS(cc
)),
1064 backend
, chr
->gcontext
, errp
);
1068 chr_new
->label
= g_strdup(id
);
1070 if (chr
->be_open
&& !chr_new
->be_open
) {
1071 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1076 qemu_chr_fe_init(be
, chr_new
, &error_abort
);
1078 if (be
->chr_be_change(be
->opaque
) < 0) {
1079 error_setg(errp
, "Chardev '%s' change failed", chr_new
->label
);
1081 qemu_chr_fe_init(be
, chr
, &error_abort
);
1083 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
1085 object_unref(OBJECT(chr_new
));
1089 object_unparent(OBJECT(chr
));
1090 object_property_add_child(get_chardevs_root(), chr_new
->label
,
1091 OBJECT(chr_new
), &error_abort
);
1092 object_unref(OBJECT(chr_new
));
1094 ret
= g_new0(ChardevReturn
, 1);
1095 if (CHARDEV_IS_PTY(chr_new
)) {
1096 ret
->pty
= g_strdup(chr_new
->filename
+ 4);
1097 ret
->has_pty
= true;
1103 void qmp_chardev_remove(const char *id
, Error
**errp
)
1107 chr
= qemu_chr_find(id
);
1109 error_setg(errp
, "Chardev '%s' not found", id
);
1112 if (qemu_chr_is_busy(chr
)) {
1113 error_setg(errp
, "Chardev '%s' is busy", id
);
1116 if (qemu_chr_replay(chr
)) {
1118 "Chardev '%s' cannot be unplugged in record/replay mode", id
);
1121 object_unparent(OBJECT(chr
));
1124 void qmp_chardev_send_break(const char *id
, Error
**errp
)
1128 chr
= qemu_chr_find(id
);
1130 error_setg(errp
, "Chardev '%s' not found", id
);
1133 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
1137 * Add a timeout callback for the chardev (in milliseconds), return
1138 * the GSource object created. Please use this to add timeout hook for
1139 * chardev instead of g_timeout_add() and g_timeout_add_seconds(), to
1140 * make sure the gcontext that the task bound to is correct.
1142 GSource
*qemu_chr_timeout_add_ms(Chardev
*chr
, guint ms
,
1143 GSourceFunc func
, void *private)
1145 GSource
*source
= g_timeout_source_new(ms
);
1148 g_source_set_callback(source
, func
, private, NULL
);
1149 g_source_attach(source
, chr
->gcontext
);
1154 void qemu_chr_cleanup(void)
1156 object_unparent(get_chardevs_root());
1159 static void register_types(void)
1161 type_register_static(&char_type_info
);
1163 /* this must be done after machine init, since we register FEs with muxes
1164 * as part of realize functions like serial_isa_realizefn when -nographic
1167 qemu_add_machine_init_done_notifier(&chardev_machine_done_notify
);
1170 type_init(register_types
);