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
24 #include "qemu/osdep.h"
25 #include "qemu-common.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 "sysemu/char.h"
32 #include "qmp-commands.h"
33 #include "qapi-visit.h"
34 #include "sysemu/replay.h"
35 #include "qemu/help_option.h"
39 #include "char-parallel.h"
40 #include "char-serial.h"
42 /***********************************************************/
43 /* character device */
45 static Object
*get_chardevs_root(void)
47 return container_get(object_get_root(), "/chardevs");
50 void qemu_chr_be_event(Chardev
*s
, int event
)
52 CharBackend
*be
= s
->be
;
54 /* Keep track if the char device is open */
56 case CHR_EVENT_OPENED
:
59 case CHR_EVENT_CLOSED
:
64 if (!be
|| !be
->chr_event
) {
68 be
->chr_event(be
->opaque
, event
);
71 /* Not reporting errors from writing to logfile, as logs are
72 * defined to be "best effort" only */
73 static void qemu_chr_fe_write_log(Chardev
*s
,
74 const uint8_t *buf
, size_t len
)
85 ret
= write(s
->logfd
, buf
+ done
, len
- done
);
86 if (ret
== -1 && errno
== EAGAIN
) {
98 static int qemu_chr_fe_write_buffer(Chardev
*s
,
99 const uint8_t *buf
, int len
, int *offset
)
101 ChardevClass
*cc
= CHARDEV_GET_CLASS(s
);
105 qemu_mutex_lock(&s
->chr_write_lock
);
106 while (*offset
< len
) {
108 res
= cc
->chr_write(s
, buf
+ *offset
, len
- *offset
);
109 if (res
< 0 && errno
== EAGAIN
) {
121 qemu_chr_fe_write_log(s
, buf
, *offset
);
123 qemu_mutex_unlock(&s
->chr_write_lock
);
128 static bool qemu_chr_replay(Chardev
*chr
)
130 return qemu_chr_has_feature(chr
, QEMU_CHAR_FEATURE_REPLAY
);
133 int qemu_chr_fe_write(CharBackend
*be
, const uint8_t *buf
, int len
)
135 Chardev
*s
= be
->chr
;
143 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
145 replay_char_write_event_load(&ret
, &offset
);
146 assert(offset
<= len
);
147 qemu_chr_fe_write_buffer(s
, buf
, offset
, &offset
);
151 cc
= CHARDEV_GET_CLASS(s
);
152 qemu_mutex_lock(&s
->chr_write_lock
);
153 ret
= cc
->chr_write(s
, buf
, len
);
156 qemu_chr_fe_write_log(s
, buf
, ret
);
159 qemu_mutex_unlock(&s
->chr_write_lock
);
161 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
162 replay_char_write_event_save(ret
, ret
< 0 ? 0 : ret
);
168 int qemu_chr_write_all(Chardev
*s
, const uint8_t *buf
, int len
)
173 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
174 replay_char_write_event_load(&res
, &offset
);
175 assert(offset
<= len
);
176 qemu_chr_fe_write_buffer(s
, buf
, offset
, &offset
);
180 res
= qemu_chr_fe_write_buffer(s
, buf
, len
, &offset
);
182 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
183 replay_char_write_event_save(res
, offset
);
192 int qemu_chr_fe_write_all(CharBackend
*be
, const uint8_t *buf
, int len
)
194 Chardev
*s
= be
->chr
;
200 return qemu_chr_write_all(s
, buf
, len
);
203 int qemu_chr_fe_read_all(CharBackend
*be
, uint8_t *buf
, int len
)
205 Chardev
*s
= be
->chr
;
206 int offset
= 0, counter
= 10;
209 if (!s
|| !CHARDEV_GET_CLASS(s
)->chr_sync_read
) {
213 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
214 return replay_char_read_all_load(buf
);
217 while (offset
< len
) {
219 res
= CHARDEV_GET_CLASS(s
)->chr_sync_read(s
, buf
+ offset
,
221 if (res
== -1 && errno
== EAGAIN
) {
231 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
232 replay_char_read_all_save_error(res
);
244 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
245 replay_char_read_all_save_buf(buf
, offset
);
250 int qemu_chr_fe_ioctl(CharBackend
*be
, int cmd
, void *arg
)
252 Chardev
*s
= be
->chr
;
255 if (!s
|| !CHARDEV_GET_CLASS(s
)->chr_ioctl
|| qemu_chr_replay(s
)) {
258 res
= CHARDEV_GET_CLASS(s
)->chr_ioctl(s
, cmd
, arg
);
264 int qemu_chr_be_can_write(Chardev
*s
)
266 CharBackend
*be
= s
->be
;
268 if (!be
|| !be
->chr_can_read
) {
272 return be
->chr_can_read(be
->opaque
);
275 void qemu_chr_be_write_impl(Chardev
*s
, uint8_t *buf
, int len
)
277 CharBackend
*be
= s
->be
;
279 if (be
&& be
->chr_read
) {
280 be
->chr_read(be
->opaque
, buf
, len
);
284 void qemu_chr_be_write(Chardev
*s
, uint8_t *buf
, int len
)
286 if (qemu_chr_replay(s
)) {
287 if (replay_mode
== REPLAY_MODE_PLAY
) {
290 replay_chr_be_write(s
, buf
, len
);
292 qemu_chr_be_write_impl(s
, buf
, len
);
296 int qemu_chr_fe_get_msgfd(CharBackend
*be
)
298 Chardev
*s
= be
->chr
;
300 int res
= (qemu_chr_fe_get_msgfds(be
, &fd
, 1) == 1) ? fd
: -1;
301 if (s
&& qemu_chr_replay(s
)) {
302 error_report("Replay: get msgfd is not supported "
303 "for serial devices yet");
309 int qemu_chr_fe_get_msgfds(CharBackend
*be
, int *fds
, int len
)
311 Chardev
*s
= be
->chr
;
317 return CHARDEV_GET_CLASS(s
)->get_msgfds
?
318 CHARDEV_GET_CLASS(s
)->get_msgfds(s
, fds
, len
) : -1;
321 int qemu_chr_fe_set_msgfds(CharBackend
*be
, int *fds
, int num
)
323 Chardev
*s
= be
->chr
;
329 return CHARDEV_GET_CLASS(s
)->set_msgfds
?
330 CHARDEV_GET_CLASS(s
)->set_msgfds(s
, fds
, num
) : -1;
333 int qemu_chr_add_client(Chardev
*s
, int fd
)
335 return CHARDEV_GET_CLASS(s
)->chr_add_client
?
336 CHARDEV_GET_CLASS(s
)->chr_add_client(s
, fd
) : -1;
339 void qemu_chr_fe_accept_input(CharBackend
*be
)
341 Chardev
*s
= be
->chr
;
347 if (CHARDEV_GET_CLASS(s
)->chr_accept_input
) {
348 CHARDEV_GET_CLASS(s
)->chr_accept_input(s
);
353 void qemu_chr_fe_printf(CharBackend
*be
, const char *fmt
, ...)
355 char buf
[CHR_READ_BUF_LEN
];
358 vsnprintf(buf
, sizeof(buf
), fmt
, ap
);
359 /* XXX this blocks entire thread. Rewrite to use
360 * qemu_chr_fe_write and background I/O callbacks */
361 qemu_chr_fe_write_all(be
, (uint8_t *)buf
, strlen(buf
));
365 static void qemu_char_open(Chardev
*chr
, ChardevBackend
*backend
,
366 bool *be_opened
, Error
**errp
)
368 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
369 /* Any ChardevCommon member would work */
370 ChardevCommon
*common
= backend
? backend
->u
.null
.data
: NULL
;
372 if (common
&& common
->has_logfile
) {
373 int flags
= O_WRONLY
| O_CREAT
;
374 if (common
->has_logappend
&&
380 chr
->logfd
= qemu_open(common
->logfile
, flags
, 0666);
381 if (chr
->logfd
< 0) {
382 error_setg_errno(errp
, errno
,
383 "Unable to open logfile %s",
390 cc
->open(chr
, backend
, be_opened
, errp
);
394 static void char_init(Object
*obj
)
396 Chardev
*chr
= CHARDEV(obj
);
399 qemu_mutex_init(&chr
->chr_write_lock
);
402 static int null_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
407 static void char_class_init(ObjectClass
*oc
, void *data
)
409 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
411 cc
->chr_write
= null_chr_write
;
414 static void char_finalize(Object
*obj
)
416 Chardev
*chr
= CHARDEV(obj
);
421 g_free(chr
->filename
);
423 if (chr
->logfd
!= -1) {
426 qemu_mutex_destroy(&chr
->chr_write_lock
);
429 static const TypeInfo char_type_info
= {
430 .name
= TYPE_CHARDEV
,
431 .parent
= TYPE_OBJECT
,
432 .instance_size
= sizeof(Chardev
),
433 .instance_init
= char_init
,
434 .instance_finalize
= char_finalize
,
436 .class_size
= sizeof(ChardevClass
),
437 .class_init
= char_class_init
,
441 * Called after processing of default and command-line-specified
442 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
443 * to a mux chardev. This is done here to ensure that
444 * output/prompts/banners are only displayed for the FE that has
445 * focus when initial command-line processing/machine init is
448 * After this point, any new FE attached to any new or existing
449 * mux will receive CHR_EVENT_OPENED notifications for the BE
452 static int open_muxes(Object
*child
, void *opaque
)
454 if (CHARDEV_IS_MUX(child
)) {
455 /* send OPENED to all already-attached FEs */
456 mux_chr_send_all_event(CHARDEV(child
), CHR_EVENT_OPENED
);
457 /* mark mux as OPENED so any new FEs will immediately receive
460 qemu_chr_be_event(CHARDEV(child
), CHR_EVENT_OPENED
);
466 static void muxes_realize_done(Notifier
*notifier
, void *unused
)
468 muxes_realized
= true;
469 object_child_foreach(get_chardevs_root(), open_muxes
, NULL
);
472 static Notifier muxes_realize_notify
= {
473 .notify
= muxes_realize_done
,
476 Chardev
*qemu_chr_fe_get_driver(CharBackend
*be
)
481 bool qemu_chr_fe_init(CharBackend
*b
, Chardev
*s
, Error
**errp
)
485 if (CHARDEV_IS_MUX(s
)) {
486 MuxChardev
*d
= MUX_CHARDEV(s
);
488 if (d
->mux_cnt
>= MAX_MUX
) {
492 d
->backends
[d
->mux_cnt
] = b
;
506 error_setg(errp
, QERR_DEVICE_IN_USE
, s
->label
);
510 static bool qemu_chr_is_busy(Chardev
*s
)
512 if (CHARDEV_IS_MUX(s
)) {
513 MuxChardev
*d
= MUX_CHARDEV(s
);
514 return d
->mux_cnt
>= 0;
516 return s
->be
!= NULL
;
520 void qemu_chr_fe_deinit(CharBackend
*b
)
525 qemu_chr_fe_set_handlers(b
, NULL
, NULL
, NULL
, NULL
, NULL
, true);
526 if (b
->chr
->be
== b
) {
529 if (CHARDEV_IS_MUX(b
->chr
)) {
530 MuxChardev
*d
= MUX_CHARDEV(b
->chr
);
531 d
->backends
[b
->tag
] = NULL
;
537 void qemu_chr_fe_set_handlers(CharBackend
*b
,
538 IOCanReadHandler
*fd_can_read
,
539 IOReadHandler
*fd_read
,
540 IOEventHandler
*fd_event
,
542 GMainContext
*context
,
554 cc
= CHARDEV_GET_CLASS(s
);
555 if (!opaque
&& !fd_can_read
&& !fd_read
&& !fd_event
) {
557 remove_fd_in_watch(s
, context
);
561 b
->chr_can_read
= fd_can_read
;
562 b
->chr_read
= fd_read
;
563 b
->chr_event
= fd_event
;
565 if (cc
->chr_update_read_handler
) {
566 cc
->chr_update_read_handler(s
, context
);
570 qemu_chr_fe_set_open(b
, fe_open
);
574 qemu_chr_fe_take_focus(b
);
575 /* We're connecting to an already opened device, so let's make sure we
576 also get the open event */
578 qemu_chr_be_event(s
, CHR_EVENT_OPENED
);
582 if (CHARDEV_IS_MUX(s
)) {
583 mux_chr_set_handlers(s
, context
);
587 void qemu_chr_fe_take_focus(CharBackend
*b
)
593 if (CHARDEV_IS_MUX(b
->chr
)) {
594 mux_set_focus(b
->chr
, b
->tag
);
598 int qemu_chr_wait_connected(Chardev
*chr
, Error
**errp
)
600 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
602 if (cc
->chr_wait_connected
) {
603 return cc
->chr_wait_connected(chr
, errp
);
609 int qemu_chr_fe_wait_connected(CharBackend
*be
, Error
**errp
)
612 error_setg(errp
, "missing associated backend");
616 return qemu_chr_wait_connected(be
->chr
, errp
);
619 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
)
621 char host
[65], port
[33], width
[8], height
[8];
625 Error
*local_err
= NULL
;
627 opts
= qemu_opts_create(qemu_find_opts("chardev"), label
, 1, &local_err
);
629 error_report_err(local_err
);
633 if (strstart(filename
, "mon:", &p
)) {
635 qemu_opt_set(opts
, "mux", "on", &error_abort
);
636 if (strcmp(filename
, "stdio") == 0) {
637 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
638 * but pass it to the guest. Handle this only for compat syntax,
639 * for -chardev syntax we have special option for this.
640 * This is what -nographic did, redirecting+muxing serial+monitor
641 * to stdio causing Ctrl+C to be passed to guest. */
642 qemu_opt_set(opts
, "signal", "off", &error_abort
);
646 if (strcmp(filename
, "null") == 0 ||
647 strcmp(filename
, "pty") == 0 ||
648 strcmp(filename
, "msmouse") == 0 ||
649 strcmp(filename
, "wctablet") == 0 ||
650 strcmp(filename
, "braille") == 0 ||
651 strcmp(filename
, "testdev") == 0 ||
652 strcmp(filename
, "stdio") == 0) {
653 qemu_opt_set(opts
, "backend", filename
, &error_abort
);
656 if (strstart(filename
, "vc", &p
)) {
657 qemu_opt_set(opts
, "backend", "vc", &error_abort
);
659 if (sscanf(p
+1, "%7[0-9]x%7[0-9]", width
, height
) == 2) {
661 qemu_opt_set(opts
, "width", width
, &error_abort
);
662 qemu_opt_set(opts
, "height", height
, &error_abort
);
663 } else if (sscanf(p
+1, "%7[0-9]Cx%7[0-9]C", width
, height
) == 2) {
665 qemu_opt_set(opts
, "cols", width
, &error_abort
);
666 qemu_opt_set(opts
, "rows", height
, &error_abort
);
673 if (strcmp(filename
, "con:") == 0) {
674 qemu_opt_set(opts
, "backend", "console", &error_abort
);
677 if (strstart(filename
, "COM", NULL
)) {
678 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
679 qemu_opt_set(opts
, "path", filename
, &error_abort
);
682 if (strstart(filename
, "file:", &p
)) {
683 qemu_opt_set(opts
, "backend", "file", &error_abort
);
684 qemu_opt_set(opts
, "path", p
, &error_abort
);
687 if (strstart(filename
, "pipe:", &p
)) {
688 qemu_opt_set(opts
, "backend", "pipe", &error_abort
);
689 qemu_opt_set(opts
, "path", p
, &error_abort
);
692 if (strstart(filename
, "tcp:", &p
) ||
693 strstart(filename
, "telnet:", &p
)) {
694 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
696 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1)
699 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
700 qemu_opt_set(opts
, "host", host
, &error_abort
);
701 qemu_opt_set(opts
, "port", port
, &error_abort
);
703 qemu_opts_do_parse(opts
, p
+pos
+1, NULL
, &local_err
);
705 error_report_err(local_err
);
709 if (strstart(filename
, "telnet:", &p
))
710 qemu_opt_set(opts
, "telnet", "on", &error_abort
);
713 if (strstart(filename
, "udp:", &p
)) {
714 qemu_opt_set(opts
, "backend", "udp", &error_abort
);
715 if (sscanf(p
, "%64[^:]:%32[^@,]%n", host
, port
, &pos
) < 2) {
717 if (sscanf(p
, ":%32[^@,]%n", port
, &pos
) < 1) {
721 qemu_opt_set(opts
, "host", host
, &error_abort
);
722 qemu_opt_set(opts
, "port", port
, &error_abort
);
725 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
727 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1) {
731 qemu_opt_set(opts
, "localaddr", host
, &error_abort
);
732 qemu_opt_set(opts
, "localport", port
, &error_abort
);
736 if (strstart(filename
, "unix:", &p
)) {
737 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
738 qemu_opts_do_parse(opts
, p
, "path", &local_err
);
740 error_report_err(local_err
);
745 if (strstart(filename
, "/dev/parport", NULL
) ||
746 strstart(filename
, "/dev/ppi", NULL
)) {
747 qemu_opt_set(opts
, "backend", "parport", &error_abort
);
748 qemu_opt_set(opts
, "path", filename
, &error_abort
);
751 if (strstart(filename
, "/dev/", NULL
)) {
752 qemu_opt_set(opts
, "backend", "tty", &error_abort
);
753 qemu_opt_set(opts
, "path", filename
, &error_abort
);
762 void qemu_chr_parse_common(QemuOpts
*opts
, ChardevCommon
*backend
)
764 const char *logfile
= qemu_opt_get(opts
, "logfile");
766 backend
->has_logfile
= logfile
!= NULL
;
767 backend
->logfile
= logfile
? g_strdup(logfile
) : NULL
;
769 backend
->has_logappend
= true;
770 backend
->logappend
= qemu_opt_get_bool(opts
, "logappend", false);
773 static const ChardevClass
*char_get_class(const char *driver
, Error
**errp
)
776 const ChardevClass
*cc
;
777 char *typename
= g_strdup_printf("chardev-%s", driver
);
779 oc
= object_class_by_name(typename
);
782 if (!object_class_dynamic_cast(oc
, TYPE_CHARDEV
)) {
783 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
787 if (object_class_is_abstract(oc
)) {
788 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
789 "abstract device type");
793 cc
= CHARDEV_CLASS(oc
);
795 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
802 static const struct ChardevAlias
{
803 const char *typename
;
805 } chardev_alias_table
[] = {
806 #ifdef HAVE_CHARDEV_PARPORT
807 { "parallel", "parport" },
809 #ifdef HAVE_CHARDEV_SERIAL
814 typedef struct ChadevClassFE
{
815 void (*fn
)(const char *name
, void *opaque
);
820 chardev_class_foreach(ObjectClass
*klass
, void *opaque
)
822 ChadevClassFE
*fe
= opaque
;
824 assert(g_str_has_prefix(object_class_get_name(klass
), "chardev-"));
825 if (CHARDEV_CLASS(klass
)->internal
) {
829 fe
->fn(object_class_get_name(klass
) + 8, fe
->opaque
);
833 chardev_name_foreach(void (*fn
)(const char *name
, void *opaque
), void *opaque
)
835 ChadevClassFE fe
= { .fn
= fn
, .opaque
= opaque
};
838 object_class_foreach(chardev_class_foreach
, TYPE_CHARDEV
, false, &fe
);
840 for (i
= 0; i
< ARRAY_SIZE(chardev_alias_table
); i
++) {
841 fn(chardev_alias_table
[i
].alias
, opaque
);
846 help_string_append(const char *name
, void *opaque
)
848 GString
*str
= opaque
;
850 g_string_append_printf(str
, "\n%s", name
);
853 Chardev
*qemu_chr_new_from_opts(QemuOpts
*opts
,
856 Error
*local_err
= NULL
;
857 const ChardevClass
*cc
;
860 ChardevBackend
*backend
= NULL
;
861 const char *name
= qemu_opt_get(opts
, "backend");
862 const char *id
= qemu_opts_id(opts
);
866 error_setg(errp
, "chardev: \"%s\" missing backend",
871 if (is_help_option(name
)) {
872 GString
*str
= g_string_new("");
874 chardev_name_foreach(help_string_append
, str
);
876 error_report("Available chardev backend types: %s", str
->str
);
877 g_string_free(str
, true);
882 error_setg(errp
, "chardev: no id specified");
886 for (i
= 0; i
< ARRAY_SIZE(chardev_alias_table
); i
++) {
887 if (g_strcmp0(chardev_alias_table
[i
].alias
, name
) == 0) {
888 name
= chardev_alias_table
[i
].typename
;
893 cc
= char_get_class(name
, errp
);
898 backend
= g_new0(ChardevBackend
, 1);
899 backend
->type
= CHARDEV_BACKEND_KIND_NULL
;
901 if (qemu_opt_get_bool(opts
, "mux", 0)) {
902 bid
= g_strdup_printf("%s-base", id
);
907 cc
->parse(opts
, backend
, &local_err
);
909 error_propagate(errp
, local_err
);
913 ChardevCommon
*ccom
= g_new0(ChardevCommon
, 1);
914 qemu_chr_parse_common(opts
, ccom
);
915 backend
->u
.null
.data
= ccom
; /* Any ChardevCommon member would work */
918 chr
= qemu_chardev_new(bid
? bid
: id
,
919 object_class_get_name(OBJECT_CLASS(cc
)),
928 qapi_free_ChardevBackend(backend
);
929 backend
= g_new0(ChardevBackend
, 1);
930 backend
->type
= CHARDEV_BACKEND_KIND_MUX
;
931 backend
->u
.mux
.data
= g_new0(ChardevMux
, 1);
932 backend
->u
.mux
.data
->chardev
= g_strdup(bid
);
933 mux
= qemu_chardev_new(id
, TYPE_CHARDEV_MUX
, backend
, errp
);
935 object_unparent(OBJECT(chr
));
943 qapi_free_ChardevBackend(backend
);
948 Chardev
*qemu_chr_new_noreplay(const char *label
, const char *filename
)
955 if (strstart(filename
, "chardev:", &p
)) {
956 return qemu_chr_find(p
);
959 opts
= qemu_chr_parse_compat(label
, filename
);
963 chr
= qemu_chr_new_from_opts(opts
, &err
);
965 error_report_err(err
);
967 if (chr
&& qemu_opt_get_bool(opts
, "mux", 0)) {
968 monitor_init(chr
, MONITOR_USE_READLINE
);
974 Chardev
*qemu_chr_new(const char *label
, const char *filename
)
977 chr
= qemu_chr_new_noreplay(label
, filename
);
979 if (replay_mode
!= REPLAY_MODE_NONE
) {
980 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_REPLAY
);
982 if (qemu_chr_replay(chr
) && CHARDEV_GET_CLASS(chr
)->chr_ioctl
) {
983 error_report("Replay: ioctl is not supported "
984 "for serial devices yet");
986 replay_register_char_driver(chr
);
991 void qemu_chr_fe_set_echo(CharBackend
*be
, bool echo
)
993 Chardev
*chr
= be
->chr
;
995 if (chr
&& CHARDEV_GET_CLASS(chr
)->chr_set_echo
) {
996 CHARDEV_GET_CLASS(chr
)->chr_set_echo(chr
, echo
);
1000 void qemu_chr_fe_set_open(CharBackend
*be
, int fe_open
)
1002 Chardev
*chr
= be
->chr
;
1008 if (be
->fe_open
== fe_open
) {
1011 be
->fe_open
= fe_open
;
1012 if (CHARDEV_GET_CLASS(chr
)->chr_set_fe_open
) {
1013 CHARDEV_GET_CLASS(chr
)->chr_set_fe_open(chr
, fe_open
);
1017 guint
qemu_chr_fe_add_watch(CharBackend
*be
, GIOCondition cond
,
1018 GIOFunc func
, void *user_data
)
1020 Chardev
*s
= be
->chr
;
1024 if (!s
|| CHARDEV_GET_CLASS(s
)->chr_add_watch
== NULL
) {
1028 src
= CHARDEV_GET_CLASS(s
)->chr_add_watch(s
, cond
);
1033 g_source_set_callback(src
, (GSourceFunc
)func
, user_data
, NULL
);
1034 tag
= g_source_attach(src
, NULL
);
1035 g_source_unref(src
);
1040 void qemu_chr_fe_disconnect(CharBackend
*be
)
1042 Chardev
*chr
= be
->chr
;
1044 if (chr
&& CHARDEV_GET_CLASS(chr
)->chr_disconnect
) {
1045 CHARDEV_GET_CLASS(chr
)->chr_disconnect(chr
);
1049 static int qmp_query_chardev_foreach(Object
*obj
, void *data
)
1051 Chardev
*chr
= CHARDEV(obj
);
1052 ChardevInfoList
**list
= data
;
1053 ChardevInfoList
*info
= g_malloc0(sizeof(*info
));
1055 info
->value
= g_malloc0(sizeof(*info
->value
));
1056 info
->value
->label
= g_strdup(chr
->label
);
1057 info
->value
->filename
= g_strdup(chr
->filename
);
1058 info
->value
->frontend_open
= chr
->be
&& chr
->be
->fe_open
;
1066 ChardevInfoList
*qmp_query_chardev(Error
**errp
)
1068 ChardevInfoList
*chr_list
= NULL
;
1070 object_child_foreach(get_chardevs_root(),
1071 qmp_query_chardev_foreach
, &chr_list
);
1077 qmp_prepend_backend(const char *name
, void *opaque
)
1079 ChardevBackendInfoList
**list
= opaque
;
1080 ChardevBackendInfoList
*info
= g_malloc0(sizeof(*info
));
1082 info
->value
= g_malloc0(sizeof(*info
->value
));
1083 info
->value
->name
= g_strdup(name
);
1088 ChardevBackendInfoList
*qmp_query_chardev_backends(Error
**errp
)
1090 ChardevBackendInfoList
*backend_list
= NULL
;
1092 chardev_name_foreach(qmp_prepend_backend
, &backend_list
);
1094 return backend_list
;
1097 Chardev
*qemu_chr_find(const char *name
)
1099 Object
*obj
= object_resolve_path_component(get_chardevs_root(), name
);
1101 return obj
? CHARDEV(obj
) : NULL
;
1104 QemuOptsList qemu_chardev_opts
= {
1106 .implied_opt_name
= "backend",
1107 .head
= QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts
.head
),
1111 .type
= QEMU_OPT_STRING
,
1114 .type
= QEMU_OPT_STRING
,
1117 .type
= QEMU_OPT_STRING
,
1120 .type
= QEMU_OPT_STRING
,
1122 .name
= "localaddr",
1123 .type
= QEMU_OPT_STRING
,
1125 .name
= "localport",
1126 .type
= QEMU_OPT_STRING
,
1129 .type
= QEMU_OPT_NUMBER
,
1132 .type
= QEMU_OPT_BOOL
,
1135 .type
= QEMU_OPT_BOOL
,
1138 .type
= QEMU_OPT_BOOL
,
1141 .type
= QEMU_OPT_BOOL
,
1144 .type
= QEMU_OPT_BOOL
,
1146 .name
= "reconnect",
1147 .type
= QEMU_OPT_NUMBER
,
1150 .type
= QEMU_OPT_BOOL
,
1152 .name
= "tls-creds",
1153 .type
= QEMU_OPT_STRING
,
1156 .type
= QEMU_OPT_NUMBER
,
1159 .type
= QEMU_OPT_NUMBER
,
1162 .type
= QEMU_OPT_NUMBER
,
1165 .type
= QEMU_OPT_NUMBER
,
1168 .type
= QEMU_OPT_BOOL
,
1171 .type
= QEMU_OPT_BOOL
,
1174 .type
= QEMU_OPT_STRING
,
1177 .type
= QEMU_OPT_NUMBER
,
1180 .type
= QEMU_OPT_SIZE
,
1183 .type
= QEMU_OPT_STRING
,
1186 .type
= QEMU_OPT_BOOL
,
1189 .type
= QEMU_OPT_STRING
,
1191 .name
= "logappend",
1192 .type
= QEMU_OPT_BOOL
,
1194 { /* end of list */ }
1198 bool qemu_chr_has_feature(Chardev
*chr
,
1199 ChardevFeature feature
)
1201 return test_bit(feature
, chr
->features
);
1204 void qemu_chr_set_feature(Chardev
*chr
,
1205 ChardevFeature feature
)
1207 return set_bit(feature
, chr
->features
);
1210 Chardev
*qemu_chardev_new(const char *id
, const char *typename
,
1211 ChardevBackend
*backend
,
1215 Chardev
*chr
= NULL
;
1216 Error
*local_err
= NULL
;
1217 bool be_opened
= true;
1219 assert(g_str_has_prefix(typename
, "chardev-"));
1221 obj
= object_new(typename
);
1223 chr
->label
= g_strdup(id
);
1225 qemu_char_open(chr
, backend
, &be_opened
, &local_err
);
1230 if (!chr
->filename
) {
1231 chr
->filename
= g_strdup(typename
+ 8);
1234 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
1238 object_property_add_child(get_chardevs_root(), id
, obj
, &local_err
);
1247 error_propagate(errp
, local_err
);
1255 ChardevReturn
*qmp_chardev_add(const char *id
, ChardevBackend
*backend
,
1258 const ChardevClass
*cc
;
1262 cc
= char_get_class(ChardevBackendKind_lookup
[backend
->type
], errp
);
1267 chr
= qemu_chardev_new(id
, object_class_get_name(OBJECT_CLASS(cc
)),
1273 ret
= g_new0(ChardevReturn
, 1);
1274 if (CHARDEV_IS_PTY(chr
)) {
1275 ret
->pty
= g_strdup(chr
->filename
+ 4);
1276 ret
->has_pty
= true;
1282 void qmp_chardev_remove(const char *id
, Error
**errp
)
1286 chr
= qemu_chr_find(id
);
1288 error_setg(errp
, "Chardev '%s' not found", id
);
1291 if (qemu_chr_is_busy(chr
)) {
1292 error_setg(errp
, "Chardev '%s' is busy", id
);
1295 if (qemu_chr_replay(chr
)) {
1297 "Chardev '%s' cannot be unplugged in record/replay mode", id
);
1300 object_unparent(OBJECT(chr
));
1303 void qemu_chr_cleanup(void)
1305 object_unparent(get_chardevs_root());
1308 static void register_types(void)
1310 type_register_static(&char_type_info
);
1312 /* this must be done after machine init, since we register FEs with muxes
1313 * as part of realize functions like serial_isa_realizefn when -nographic
1316 qemu_add_machine_init_done_notifier(&muxes_realize_notify
);
1319 type_init(register_types
);