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 "sysemu/block-backend.h"
30 #include "qemu/error-report.h"
31 #include "qemu/timer.h"
32 #include "sysemu/char.h"
34 #include "qmp-commands.h"
35 #include "qapi/clone-visitor.h"
36 #include "qapi-visit.h"
37 #include "qemu/base64.h"
38 #include "io/channel-socket.h"
39 #include "io/channel-file.h"
40 #include "io/channel-tls.h"
41 #include "sysemu/replay.h"
42 #include "qemu/help_option.h"
47 #include <sys/times.h>
50 #include <sys/ioctl.h>
51 #include <sys/resource.h>
52 #include <sys/socket.h>
53 #include <netinet/in.h>
55 #include <arpa/inet.h>
57 #include <sys/select.h>
59 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
60 #include <dev/ppbus/ppi.h>
61 #include <dev/ppbus/ppbconf.h>
62 #elif defined(__DragonFly__)
63 #include <dev/misc/ppi/ppi.h>
64 #include <bus/ppbus/ppbconf.h>
68 #include <linux/ppdev.h>
69 #include <linux/parport.h>
72 #include <sys/ethernet.h>
73 #include <sys/sockio.h>
74 #include <netinet/arp.h>
75 #include <netinet/in.h>
76 #include <netinet/in_systm.h>
77 #include <netinet/ip.h>
78 #include <netinet/ip_icmp.h> // must come after ip.h
79 #include <netinet/udp.h>
80 #include <netinet/tcp.h>
85 #include "qemu/sockets.h"
86 #include "ui/qemu-spice.h"
88 #define READ_BUF_LEN 4096
89 #define READ_RETRIES 10
90 #define TCP_MAX_FDS 16
92 typedef struct MuxChardev MuxChardev
;
94 /***********************************************************/
95 /* Socket address helpers */
97 static char *SocketAddress_to_str(const char *prefix
, SocketAddress
*addr
,
98 bool is_listen
, bool is_telnet
)
100 switch (addr
->type
) {
101 case SOCKET_ADDRESS_KIND_INET
:
102 return g_strdup_printf("%s%s:%s:%s%s", prefix
,
103 is_telnet
? "telnet" : "tcp",
104 addr
->u
.inet
.data
->host
,
105 addr
->u
.inet
.data
->port
,
106 is_listen
? ",server" : "");
108 case SOCKET_ADDRESS_KIND_UNIX
:
109 return g_strdup_printf("%sunix:%s%s", prefix
,
110 addr
->u
.q_unix
.data
->path
,
111 is_listen
? ",server" : "");
113 case SOCKET_ADDRESS_KIND_FD
:
114 return g_strdup_printf("%sfd:%s%s", prefix
, addr
->u
.fd
.data
->str
,
115 is_listen
? ",server" : "");
122 static char *sockaddr_to_str(struct sockaddr_storage
*ss
, socklen_t ss_len
,
123 struct sockaddr_storage
*ps
, socklen_t ps_len
,
124 bool is_listen
, bool is_telnet
)
126 char shost
[NI_MAXHOST
], sserv
[NI_MAXSERV
];
127 char phost
[NI_MAXHOST
], pserv
[NI_MAXSERV
];
128 const char *left
= "", *right
= "";
130 switch (ss
->ss_family
) {
133 return g_strdup_printf("unix:%s%s",
134 ((struct sockaddr_un
*)(ss
))->sun_path
,
135 is_listen
? ",server" : "");
142 getnameinfo((struct sockaddr
*) ss
, ss_len
, shost
, sizeof(shost
),
143 sserv
, sizeof(sserv
), NI_NUMERICHOST
| NI_NUMERICSERV
);
144 getnameinfo((struct sockaddr
*) ps
, ps_len
, phost
, sizeof(phost
),
145 pserv
, sizeof(pserv
), NI_NUMERICHOST
| NI_NUMERICSERV
);
146 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
147 is_telnet
? "telnet" : "tcp",
148 left
, shost
, right
, sserv
,
149 is_listen
? ",server" : "",
150 left
, phost
, right
, pserv
);
153 return g_strdup_printf("unknown");
157 /***********************************************************/
158 /* character device */
160 static QTAILQ_HEAD(ChardevHead
, Chardev
) chardevs
=
161 QTAILQ_HEAD_INITIALIZER(chardevs
);
163 void qemu_chr_be_event(Chardev
*s
, int event
)
165 CharBackend
*be
= s
->be
;
167 /* Keep track if the char device is open */
169 case CHR_EVENT_OPENED
:
172 case CHR_EVENT_CLOSED
:
177 if (!be
|| !be
->chr_event
) {
181 be
->chr_event(be
->opaque
, event
);
184 void qemu_chr_be_generic_open(Chardev
*s
)
186 qemu_chr_be_event(s
, CHR_EVENT_OPENED
);
190 /* Not reporting errors from writing to logfile, as logs are
191 * defined to be "best effort" only */
192 static void qemu_chr_fe_write_log(Chardev
*s
,
193 const uint8_t *buf
, size_t len
)
204 ret
= write(s
->logfd
, buf
+ done
, len
- done
);
205 if (ret
== -1 && errno
== EAGAIN
) {
217 static int qemu_chr_fe_write_buffer(Chardev
*s
,
218 const uint8_t *buf
, int len
, int *offset
)
220 ChardevClass
*cc
= CHARDEV_GET_CLASS(s
);
224 qemu_mutex_lock(&s
->chr_write_lock
);
225 while (*offset
< len
) {
227 res
= cc
->chr_write(s
, buf
+ *offset
, len
- *offset
);
228 if (res
< 0 && errno
== EAGAIN
) {
240 qemu_chr_fe_write_log(s
, buf
, *offset
);
242 qemu_mutex_unlock(&s
->chr_write_lock
);
247 static bool qemu_chr_replay(Chardev
*chr
)
249 return qemu_chr_has_feature(chr
, QEMU_CHAR_FEATURE_REPLAY
);
252 int qemu_chr_fe_write(CharBackend
*be
, const uint8_t *buf
, int len
)
254 Chardev
*s
= be
->chr
;
262 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
264 replay_char_write_event_load(&ret
, &offset
);
265 assert(offset
<= len
);
266 qemu_chr_fe_write_buffer(s
, buf
, offset
, &offset
);
270 cc
= CHARDEV_GET_CLASS(s
);
271 qemu_mutex_lock(&s
->chr_write_lock
);
272 ret
= cc
->chr_write(s
, buf
, len
);
275 qemu_chr_fe_write_log(s
, buf
, ret
);
278 qemu_mutex_unlock(&s
->chr_write_lock
);
280 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
281 replay_char_write_event_save(ret
, ret
< 0 ? 0 : ret
);
287 static int qemu_chr_write_all(Chardev
*s
, const uint8_t *buf
, int len
)
292 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
293 replay_char_write_event_load(&res
, &offset
);
294 assert(offset
<= len
);
295 qemu_chr_fe_write_buffer(s
, buf
, offset
, &offset
);
299 res
= qemu_chr_fe_write_buffer(s
, buf
, len
, &offset
);
301 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
302 replay_char_write_event_save(res
, offset
);
311 int qemu_chr_fe_write_all(CharBackend
*be
, const uint8_t *buf
, int len
)
313 Chardev
*s
= be
->chr
;
319 return qemu_chr_write_all(s
, buf
, len
);
322 int qemu_chr_fe_read_all(CharBackend
*be
, uint8_t *buf
, int len
)
324 Chardev
*s
= be
->chr
;
325 int offset
= 0, counter
= 10;
328 if (!s
|| !CHARDEV_GET_CLASS(s
)->chr_sync_read
) {
332 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_PLAY
) {
333 return replay_char_read_all_load(buf
);
336 while (offset
< len
) {
338 res
= CHARDEV_GET_CLASS(s
)->chr_sync_read(s
, buf
+ offset
,
340 if (res
== -1 && errno
== EAGAIN
) {
350 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
351 replay_char_read_all_save_error(res
);
363 if (qemu_chr_replay(s
) && replay_mode
== REPLAY_MODE_RECORD
) {
364 replay_char_read_all_save_buf(buf
, offset
);
369 int qemu_chr_fe_ioctl(CharBackend
*be
, int cmd
, void *arg
)
371 Chardev
*s
= be
->chr
;
374 if (!s
|| !CHARDEV_GET_CLASS(s
)->chr_ioctl
|| qemu_chr_replay(s
)) {
377 res
= CHARDEV_GET_CLASS(s
)->chr_ioctl(s
, cmd
, arg
);
383 int qemu_chr_be_can_write(Chardev
*s
)
385 CharBackend
*be
= s
->be
;
387 if (!be
|| !be
->chr_can_read
) {
391 return be
->chr_can_read(be
->opaque
);
394 void qemu_chr_be_write_impl(Chardev
*s
, uint8_t *buf
, int len
)
396 CharBackend
*be
= s
->be
;
398 if (be
&& be
->chr_read
) {
399 be
->chr_read(be
->opaque
, buf
, len
);
403 void qemu_chr_be_write(Chardev
*s
, uint8_t *buf
, int len
)
405 if (qemu_chr_replay(s
)) {
406 if (replay_mode
== REPLAY_MODE_PLAY
) {
409 replay_chr_be_write(s
, buf
, len
);
411 qemu_chr_be_write_impl(s
, buf
, len
);
415 int qemu_chr_fe_get_msgfd(CharBackend
*be
)
417 Chardev
*s
= be
->chr
;
419 int res
= (qemu_chr_fe_get_msgfds(be
, &fd
, 1) == 1) ? fd
: -1;
420 if (s
&& qemu_chr_replay(s
)) {
421 error_report("Replay: get msgfd is not supported "
422 "for serial devices yet");
428 int qemu_chr_fe_get_msgfds(CharBackend
*be
, int *fds
, int len
)
430 Chardev
*s
= be
->chr
;
436 return CHARDEV_GET_CLASS(s
)->get_msgfds
?
437 CHARDEV_GET_CLASS(s
)->get_msgfds(s
, fds
, len
) : -1;
440 int qemu_chr_fe_set_msgfds(CharBackend
*be
, int *fds
, int num
)
442 Chardev
*s
= be
->chr
;
448 return CHARDEV_GET_CLASS(s
)->set_msgfds
?
449 CHARDEV_GET_CLASS(s
)->set_msgfds(s
, fds
, num
) : -1;
452 int qemu_chr_add_client(Chardev
*s
, int fd
)
454 return CHARDEV_GET_CLASS(s
)->chr_add_client
?
455 CHARDEV_GET_CLASS(s
)->chr_add_client(s
, fd
) : -1;
458 void qemu_chr_fe_accept_input(CharBackend
*be
)
460 Chardev
*s
= be
->chr
;
466 if (CHARDEV_GET_CLASS(s
)->chr_accept_input
) {
467 CHARDEV_GET_CLASS(s
)->chr_accept_input(s
);
472 void qemu_chr_fe_printf(CharBackend
*be
, const char *fmt
, ...)
474 char buf
[READ_BUF_LEN
];
477 vsnprintf(buf
, sizeof(buf
), fmt
, ap
);
478 /* XXX this blocks entire thread. Rewrite to use
479 * qemu_chr_fe_write and background I/O callbacks */
480 qemu_chr_fe_write_all(be
, (uint8_t *)buf
, strlen(buf
));
484 static void remove_fd_in_watch(Chardev
*chr
);
485 static void mux_chr_set_handlers(Chardev
*chr
, GMainContext
*context
);
486 static void mux_set_focus(Chardev
*chr
, int focus
);
488 static void qemu_char_open(Chardev
*chr
, ChardevBackend
*backend
,
489 bool *be_opened
, Error
**errp
)
491 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
492 /* Any ChardevCommon member would work */
493 ChardevCommon
*common
= backend
? backend
->u
.null
.data
: NULL
;
495 if (common
&& common
->has_logfile
) {
496 int flags
= O_WRONLY
| O_CREAT
;
497 if (common
->has_logappend
&&
503 chr
->logfd
= qemu_open(common
->logfile
, flags
, 0666);
504 if (chr
->logfd
< 0) {
505 error_setg_errno(errp
, errno
,
506 "Unable to open logfile %s",
513 cc
->open(chr
, backend
, be_opened
, errp
);
517 static void char_init(Object
*obj
)
519 Chardev
*chr
= CHARDEV(obj
);
522 qemu_mutex_init(&chr
->chr_write_lock
);
525 static void char_finalize(Object
*obj
)
527 Chardev
*chr
= CHARDEV(obj
);
532 g_free(chr
->filename
);
534 if (chr
->logfd
!= -1) {
537 qemu_mutex_destroy(&chr
->chr_write_lock
);
540 static const TypeInfo char_type_info
= {
541 .name
= TYPE_CHARDEV
,
542 .parent
= TYPE_OBJECT
,
543 .instance_size
= sizeof(Chardev
),
544 .instance_init
= char_init
,
545 .instance_finalize
= char_finalize
,
547 .class_size
= sizeof(ChardevClass
),
550 static int null_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
555 static void null_chr_open(Chardev
*chr
,
556 ChardevBackend
*backend
,
563 static void char_null_class_init(ObjectClass
*oc
, void *data
)
565 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
567 cc
->open
= null_chr_open
;
568 cc
->chr_write
= null_chr_write
;
569 cc
->kind
= CHARDEV_BACKEND_KIND_NULL
;
572 static const TypeInfo char_null_type_info
= {
573 .name
= TYPE_CHARDEV_NULL
,
574 .parent
= TYPE_CHARDEV
,
575 .instance_size
= sizeof(Chardev
),
576 .class_init
= char_null_class_init
,
579 /* MUX driver for serial I/O splitting */
581 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
582 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
585 CharBackend
*backends
[MAX_MUX
];
591 /* Intermediate input buffer allows to catch escape sequences even if the
592 currently active device is not accepting any input - but only until it
594 unsigned char buffer
[MAX_MUX
][MUX_BUFFER_SIZE
];
599 /* Protected by the Chardev chr_write_lock. */
601 int64_t timestamps_start
;
604 #define MUX_CHARDEV(obj) OBJECT_CHECK(MuxChardev, (obj), TYPE_CHARDEV_MUX)
606 /* Called with chr_write_lock held. */
607 static int mux_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
609 MuxChardev
*d
= MUX_CHARDEV(chr
);
611 if (!d
->timestamps
) {
612 ret
= qemu_chr_fe_write(&d
->chr
, buf
, len
);
617 for (i
= 0; i
< len
; i
++) {
623 ti
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
624 if (d
->timestamps_start
== -1)
625 d
->timestamps_start
= ti
;
626 ti
-= d
->timestamps_start
;
628 snprintf(buf1
, sizeof(buf1
),
629 "[%02d:%02d:%02d.%03d] ",
634 /* XXX this blocks entire thread. Rewrite to use
635 * qemu_chr_fe_write and background I/O callbacks */
636 qemu_chr_fe_write_all(&d
->chr
,
637 (uint8_t *)buf1
, strlen(buf1
));
640 ret
+= qemu_chr_fe_write(&d
->chr
, buf
+ i
, 1);
641 if (buf
[i
] == '\n') {
649 static const char * const mux_help
[] = {
650 "% h print this help\n\r",
651 "% x exit emulator\n\r",
652 "% s save disk data back to file (if -snapshot)\n\r",
653 "% t toggle console timestamps\n\r",
654 "% b send break (magic sysrq)\n\r",
655 "% c switch between console and monitor\n\r",
660 int term_escape_char
= 0x01; /* ctrl-a is used for escape */
661 static void mux_print_help(Chardev
*chr
)
664 char ebuf
[15] = "Escape-Char";
665 char cbuf
[50] = "\n\r";
667 if (term_escape_char
> 0 && term_escape_char
< 26) {
668 snprintf(cbuf
, sizeof(cbuf
), "\n\r");
669 snprintf(ebuf
, sizeof(ebuf
), "C-%c", term_escape_char
- 1 + 'a');
671 snprintf(cbuf
, sizeof(cbuf
),
672 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
675 /* XXX this blocks entire thread. Rewrite to use
676 * qemu_chr_fe_write and background I/O callbacks */
677 qemu_chr_write_all(chr
, (uint8_t *)cbuf
, strlen(cbuf
));
678 for (i
= 0; mux_help
[i
] != NULL
; i
++) {
679 for (j
=0; mux_help
[i
][j
] != '\0'; j
++) {
680 if (mux_help
[i
][j
] == '%')
681 qemu_chr_write_all(chr
, (uint8_t *)ebuf
, strlen(ebuf
));
683 qemu_chr_write_all(chr
, (uint8_t *)&mux_help
[i
][j
], 1);
688 static void mux_chr_send_event(MuxChardev
*d
, int mux_nr
, int event
)
690 CharBackend
*be
= d
->backends
[mux_nr
];
692 if (be
&& be
->chr_event
) {
693 be
->chr_event(be
->opaque
, event
);
697 static int mux_proc_byte(Chardev
*chr
, MuxChardev
*d
, int ch
)
699 if (d
->term_got_escape
) {
700 d
->term_got_escape
= 0;
701 if (ch
== term_escape_char
)
710 const char *term
= "QEMU: Terminated\n\r";
711 qemu_chr_write_all(chr
, (uint8_t *)term
, strlen(term
));
719 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
722 assert(d
->mux_cnt
> 0); /* handler registered with first fe */
723 /* Switch to the next registered device */
724 mux_set_focus(chr
, (d
->focus
+ 1) % d
->mux_cnt
);
727 d
->timestamps
= !d
->timestamps
;
728 d
->timestamps_start
= -1;
732 } else if (ch
== term_escape_char
) {
733 d
->term_got_escape
= 1;
741 static void mux_chr_accept_input(Chardev
*chr
)
743 MuxChardev
*d
= MUX_CHARDEV(chr
);
745 CharBackend
*be
= d
->backends
[m
];
747 while (be
&& d
->prod
[m
] != d
->cons
[m
] &&
748 be
->chr_can_read
&& be
->chr_can_read(be
->opaque
)) {
749 be
->chr_read(be
->opaque
,
750 &d
->buffer
[m
][d
->cons
[m
]++ & MUX_BUFFER_MASK
], 1);
754 static int mux_chr_can_read(void *opaque
)
756 MuxChardev
*d
= MUX_CHARDEV(opaque
);
758 CharBackend
*be
= d
->backends
[m
];
760 if ((d
->prod
[m
] - d
->cons
[m
]) < MUX_BUFFER_SIZE
) {
764 if (be
&& be
->chr_can_read
) {
765 return be
->chr_can_read(be
->opaque
);
771 static void mux_chr_read(void *opaque
, const uint8_t *buf
, int size
)
773 Chardev
*chr
= CHARDEV(opaque
);
774 MuxChardev
*d
= MUX_CHARDEV(opaque
);
776 CharBackend
*be
= d
->backends
[m
];
779 mux_chr_accept_input(opaque
);
781 for (i
= 0; i
< size
; i
++)
782 if (mux_proc_byte(chr
, d
, buf
[i
])) {
783 if (d
->prod
[m
] == d
->cons
[m
] &&
784 be
&& be
->chr_can_read
&&
785 be
->chr_can_read(be
->opaque
))
786 be
->chr_read(be
->opaque
, &buf
[i
], 1);
788 d
->buffer
[m
][d
->prod
[m
]++ & MUX_BUFFER_MASK
] = buf
[i
];
792 static bool muxes_realized
;
794 static void mux_chr_event(void *opaque
, int event
)
796 MuxChardev
*d
= MUX_CHARDEV(opaque
);
799 if (!muxes_realized
) {
803 /* Send the event to all registered listeners */
804 for (i
= 0; i
< d
->mux_cnt
; i
++)
805 mux_chr_send_event(d
, i
, event
);
809 * Called after processing of default and command-line-specified
810 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
811 * to a mux chardev. This is done here to ensure that
812 * output/prompts/banners are only displayed for the FE that has
813 * focus when initial command-line processing/machine init is
816 * After this point, any new FE attached to any new or existing
817 * mux will receive CHR_EVENT_OPENED notifications for the BE
820 static void muxes_realize_done(Notifier
*notifier
, void *unused
)
824 QTAILQ_FOREACH(chr
, &chardevs
, next
) {
825 if (CHARDEV_IS_MUX(chr
)) {
826 MuxChardev
*d
= MUX_CHARDEV(chr
);
829 /* send OPENED to all already-attached FEs */
830 for (i
= 0; i
< d
->mux_cnt
; i
++) {
831 mux_chr_send_event(d
, i
, CHR_EVENT_OPENED
);
833 /* mark mux as OPENED so any new FEs will immediately receive
836 qemu_chr_be_generic_open(chr
);
839 muxes_realized
= true;
842 static Notifier muxes_realize_notify
= {
843 .notify
= muxes_realize_done
,
846 static GSource
*mux_chr_add_watch(Chardev
*s
, GIOCondition cond
)
848 MuxChardev
*d
= MUX_CHARDEV(s
);
849 Chardev
*chr
= qemu_chr_fe_get_driver(&d
->chr
);
850 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
852 if (!cc
->chr_add_watch
) {
856 return cc
->chr_add_watch(chr
, cond
);
859 static void char_mux_finalize(Object
*obj
)
861 MuxChardev
*d
= MUX_CHARDEV(obj
);
864 for (i
= 0; i
< d
->mux_cnt
; i
++) {
865 CharBackend
*be
= d
->backends
[i
];
870 qemu_chr_fe_deinit(&d
->chr
);
873 static void mux_chr_set_handlers(Chardev
*chr
, GMainContext
*context
)
875 MuxChardev
*d
= MUX_CHARDEV(chr
);
877 /* Fix up the real driver with mux routines */
878 qemu_chr_fe_set_handlers(&d
->chr
,
886 static void mux_set_focus(Chardev
*chr
, int focus
)
888 MuxChardev
*d
= MUX_CHARDEV(chr
);
891 assert(focus
< d
->mux_cnt
);
893 if (d
->focus
!= -1) {
894 mux_chr_send_event(d
, d
->focus
, CHR_EVENT_MUX_OUT
);
898 chr
->be
= d
->backends
[focus
];
899 mux_chr_send_event(d
, d
->focus
, CHR_EVENT_MUX_IN
);
902 static void qemu_chr_open_mux(Chardev
*chr
,
903 ChardevBackend
*backend
,
907 ChardevMux
*mux
= backend
->u
.mux
.data
;
909 MuxChardev
*d
= MUX_CHARDEV(chr
);
911 drv
= qemu_chr_find(mux
->chardev
);
913 error_setg(errp
, "mux: base chardev %s not found", mux
->chardev
);
918 /* only default to opened state if we've realized the initial
921 *be_opened
= muxes_realized
;
922 qemu_chr_fe_init(&d
->chr
, drv
, errp
);
925 Chardev
*qemu_chr_fe_get_driver(CharBackend
*be
)
930 bool qemu_chr_fe_init(CharBackend
*b
, Chardev
*s
, Error
**errp
)
934 if (CHARDEV_IS_MUX(s
)) {
935 MuxChardev
*d
= MUX_CHARDEV(s
);
937 if (d
->mux_cnt
>= MAX_MUX
) {
941 d
->backends
[d
->mux_cnt
] = b
;
955 error_setg(errp
, QERR_DEVICE_IN_USE
, s
->label
);
959 static bool qemu_chr_is_busy(Chardev
*s
)
961 if (CHARDEV_IS_MUX(s
)) {
962 MuxChardev
*d
= MUX_CHARDEV(s
);
963 return d
->mux_cnt
>= 0;
965 return s
->be
!= NULL
;
969 void qemu_chr_fe_deinit(CharBackend
*b
)
974 qemu_chr_fe_set_handlers(b
, NULL
, NULL
, NULL
, NULL
, NULL
, true);
975 if (b
->chr
->be
== b
) {
978 if (CHARDEV_IS_MUX(b
->chr
)) {
979 MuxChardev
*d
= MUX_CHARDEV(b
->chr
);
980 d
->backends
[b
->tag
] = NULL
;
986 void qemu_chr_fe_set_handlers(CharBackend
*b
,
987 IOCanReadHandler
*fd_can_read
,
988 IOReadHandler
*fd_read
,
989 IOEventHandler
*fd_event
,
991 GMainContext
*context
,
1003 cc
= CHARDEV_GET_CLASS(s
);
1004 if (!opaque
&& !fd_can_read
&& !fd_read
&& !fd_event
) {
1006 remove_fd_in_watch(s
);
1010 b
->chr_can_read
= fd_can_read
;
1011 b
->chr_read
= fd_read
;
1012 b
->chr_event
= fd_event
;
1014 if (cc
->chr_update_read_handler
) {
1015 cc
->chr_update_read_handler(s
, context
);
1019 qemu_chr_fe_set_open(b
, fe_open
);
1023 qemu_chr_fe_take_focus(b
);
1024 /* We're connecting to an already opened device, so let's make sure we
1025 also get the open event */
1027 qemu_chr_be_generic_open(s
);
1031 if (CHARDEV_IS_MUX(s
)) {
1032 mux_chr_set_handlers(s
, context
);
1036 void qemu_chr_fe_take_focus(CharBackend
*b
)
1042 if (CHARDEV_IS_MUX(b
->chr
)) {
1043 mux_set_focus(b
->chr
, b
->tag
);
1047 typedef struct IOWatchPoll
1054 IOCanReadHandler
*fd_can_read
;
1055 GSourceFunc fd_read
;
1057 GMainContext
*context
;
1060 static IOWatchPoll
*io_watch_poll_from_source(GSource
*source
)
1062 return container_of(source
, IOWatchPoll
, parent
);
1065 static gboolean
io_watch_poll_prepare(GSource
*source
,
1068 IOWatchPoll
*iwp
= io_watch_poll_from_source(source
);
1069 bool now_active
= iwp
->fd_can_read(iwp
->opaque
) > 0;
1070 bool was_active
= iwp
->src
!= NULL
;
1071 if (was_active
== now_active
) {
1076 iwp
->src
= qio_channel_create_watch(
1077 iwp
->ioc
, G_IO_IN
| G_IO_ERR
| G_IO_HUP
| G_IO_NVAL
);
1078 g_source_set_callback(iwp
->src
, iwp
->fd_read
, iwp
->opaque
, NULL
);
1079 g_source_attach(iwp
->src
, iwp
->context
);
1081 g_source_destroy(iwp
->src
);
1082 g_source_unref(iwp
->src
);
1088 static gboolean
io_watch_poll_check(GSource
*source
)
1093 static gboolean
io_watch_poll_dispatch(GSource
*source
, GSourceFunc callback
,
1099 static void io_watch_poll_finalize(GSource
*source
)
1101 /* Due to a glib bug, removing the last reference to a source
1102 * inside a finalize callback causes recursive locking (and a
1103 * deadlock). This is not a problem inside other callbacks,
1104 * including dispatch callbacks, so we call io_remove_watch_poll
1105 * to remove this source. At this point, iwp->src must
1106 * be NULL, or we would leak it.
1108 * This would be solved much more elegantly by child sources,
1109 * but we support older glib versions that do not have them.
1111 IOWatchPoll
*iwp
= io_watch_poll_from_source(source
);
1112 assert(iwp
->src
== NULL
);
1115 static GSourceFuncs io_watch_poll_funcs
= {
1116 .prepare
= io_watch_poll_prepare
,
1117 .check
= io_watch_poll_check
,
1118 .dispatch
= io_watch_poll_dispatch
,
1119 .finalize
= io_watch_poll_finalize
,
1122 /* Can only be used for read */
1123 static guint
io_add_watch_poll(Chardev
*chr
,
1125 IOCanReadHandler
*fd_can_read
,
1126 QIOChannelFunc fd_read
,
1128 GMainContext
*context
)
1134 iwp
= (IOWatchPoll
*) g_source_new(&io_watch_poll_funcs
,
1135 sizeof(IOWatchPoll
));
1136 iwp
->fd_can_read
= fd_can_read
;
1137 iwp
->opaque
= user_data
;
1139 iwp
->fd_read
= (GSourceFunc
) fd_read
;
1141 iwp
->context
= context
;
1143 name
= g_strdup_printf("chardev-iowatch-%s", chr
->label
);
1144 g_source_set_name((GSource
*)iwp
, name
);
1147 tag
= g_source_attach(&iwp
->parent
, context
);
1148 g_source_unref(&iwp
->parent
);
1152 static void io_remove_watch_poll(guint tag
)
1157 g_return_if_fail (tag
> 0);
1159 source
= g_main_context_find_source_by_id(NULL
, tag
);
1160 g_return_if_fail (source
!= NULL
);
1162 iwp
= io_watch_poll_from_source(source
);
1164 g_source_destroy(iwp
->src
);
1165 g_source_unref(iwp
->src
);
1168 g_source_destroy(&iwp
->parent
);
1171 static void remove_fd_in_watch(Chardev
*chr
)
1173 if (chr
->fd_in_tag
) {
1174 io_remove_watch_poll(chr
->fd_in_tag
);
1180 static int io_channel_send_full(QIOChannel
*ioc
,
1181 const void *buf
, size_t len
,
1182 int *fds
, size_t nfds
)
1186 while (offset
< len
) {
1188 struct iovec iov
= { .iov_base
= (char *)buf
+ offset
,
1189 .iov_len
= len
- offset
};
1191 ret
= qio_channel_writev_full(
1194 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
1201 } else if (ret
< 0) {
1214 static int io_channel_send(QIOChannel
*ioc
, const void *buf
, size_t len
)
1216 return io_channel_send_full(ioc
, buf
, len
, NULL
, 0);
1219 typedef struct FDChardev
{
1222 QIOChannel
*ioc_in
, *ioc_out
;
1226 #define TYPE_CHARDEV_FD "chardev-fd"
1227 #define FD_CHARDEV(obj) OBJECT_CHECK(FDChardev, (obj), TYPE_CHARDEV_FD)
1229 /* Called with chr_write_lock held. */
1230 static int fd_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
1232 FDChardev
*s
= FD_CHARDEV(chr
);
1234 return io_channel_send(s
->ioc_out
, buf
, len
);
1237 static gboolean
fd_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
1239 Chardev
*chr
= CHARDEV(opaque
);
1240 FDChardev
*s
= FD_CHARDEV(opaque
);
1242 uint8_t buf
[READ_BUF_LEN
];
1246 if (len
> s
->max_size
) {
1253 ret
= qio_channel_read(
1254 chan
, (gchar
*)buf
, len
, NULL
);
1256 remove_fd_in_watch(chr
);
1257 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1261 qemu_chr_be_write(chr
, buf
, ret
);
1267 static int fd_chr_read_poll(void *opaque
)
1269 Chardev
*chr
= CHARDEV(opaque
);
1270 FDChardev
*s
= FD_CHARDEV(opaque
);
1272 s
->max_size
= qemu_chr_be_can_write(chr
);
1276 static GSource
*fd_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
1278 FDChardev
*s
= FD_CHARDEV(chr
);
1279 return qio_channel_create_watch(s
->ioc_out
, cond
);
1282 static void fd_chr_update_read_handler(Chardev
*chr
,
1283 GMainContext
*context
)
1285 FDChardev
*s
= FD_CHARDEV(chr
);
1287 remove_fd_in_watch(chr
);
1289 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc_in
,
1296 static void char_fd_finalize(Object
*obj
)
1298 Chardev
*chr
= CHARDEV(obj
);
1299 FDChardev
*s
= FD_CHARDEV(obj
);
1301 remove_fd_in_watch(chr
);
1303 object_unref(OBJECT(s
->ioc_in
));
1306 object_unref(OBJECT(s
->ioc_out
));
1309 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1312 /* open a character device to a unix fd */
1313 static void qemu_chr_open_fd(Chardev
*chr
,
1314 int fd_in
, int fd_out
)
1316 FDChardev
*s
= FD_CHARDEV(chr
);
1319 s
->ioc_in
= QIO_CHANNEL(qio_channel_file_new_fd(fd_in
));
1320 name
= g_strdup_printf("chardev-file-in-%s", chr
->label
);
1321 qio_channel_set_name(QIO_CHANNEL(s
->ioc_in
), name
);
1323 s
->ioc_out
= QIO_CHANNEL(qio_channel_file_new_fd(fd_out
));
1324 name
= g_strdup_printf("chardev-file-out-%s", chr
->label
);
1325 qio_channel_set_name(QIO_CHANNEL(s
->ioc_out
), name
);
1327 qemu_set_nonblock(fd_out
);
1331 static void char_fd_class_init(ObjectClass
*oc
, void *data
)
1333 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
1335 cc
->chr_add_watch
= fd_chr_add_watch
;
1336 cc
->chr_write
= fd_chr_write
;
1337 cc
->chr_update_read_handler
= fd_chr_update_read_handler
;
1340 static const TypeInfo char_fd_type_info
= {
1341 .name
= TYPE_CHARDEV_FD
,
1342 .parent
= TYPE_CHARDEV
,
1343 .instance_size
= sizeof(FDChardev
),
1344 .instance_finalize
= char_fd_finalize
,
1345 .class_init
= char_fd_class_init
,
1349 static void qemu_chr_open_pipe(Chardev
*chr
,
1350 ChardevBackend
*backend
,
1354 ChardevHostdev
*opts
= backend
->u
.pipe
.data
;
1358 const char *filename
= opts
->device
;
1360 filename_in
= g_strdup_printf("%s.in", filename
);
1361 filename_out
= g_strdup_printf("%s.out", filename
);
1362 TFR(fd_in
= qemu_open(filename_in
, O_RDWR
| O_BINARY
));
1363 TFR(fd_out
= qemu_open(filename_out
, O_RDWR
| O_BINARY
));
1364 g_free(filename_in
);
1365 g_free(filename_out
);
1366 if (fd_in
< 0 || fd_out
< 0) {
1371 TFR(fd_in
= fd_out
= qemu_open(filename
, O_RDWR
| O_BINARY
));
1373 error_setg_file_open(errp
, errno
, filename
);
1377 qemu_chr_open_fd(chr
, fd_in
, fd_out
);
1380 /* init terminal so that we can grab keys */
1381 static struct termios oldtty
;
1382 static int old_fd0_flags
;
1383 static bool stdio_in_use
;
1384 static bool stdio_allow_signal
;
1385 static bool stdio_echo_state
;
1387 static void qemu_chr_set_echo_stdio(Chardev
*chr
, bool echo
);
1389 static void term_exit(void)
1391 tcsetattr (0, TCSANOW
, &oldtty
);
1392 fcntl(0, F_SETFL
, old_fd0_flags
);
1395 static void term_stdio_handler(int sig
)
1397 /* restore echo after resume from suspend. */
1398 qemu_chr_set_echo_stdio(NULL
, stdio_echo_state
);
1401 static void qemu_chr_set_echo_stdio(Chardev
*chr
, bool echo
)
1405 stdio_echo_state
= echo
;
1408 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
1409 |INLCR
|IGNCR
|ICRNL
|IXON
);
1410 tty
.c_oflag
|= OPOST
;
1411 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
1412 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
1415 tty
.c_cc
[VTIME
] = 0;
1417 if (!stdio_allow_signal
)
1418 tty
.c_lflag
&= ~ISIG
;
1420 tcsetattr (0, TCSANOW
, &tty
);
1423 static void char_stdio_finalize(Object
*obj
)
1428 static void qemu_chr_open_stdio(Chardev
*chr
,
1429 ChardevBackend
*backend
,
1433 ChardevStdio
*opts
= backend
->u
.stdio
.data
;
1434 struct sigaction act
;
1436 if (is_daemonized()) {
1437 error_setg(errp
, "cannot use stdio with -daemonize");
1442 error_setg(errp
, "cannot use stdio by multiple character devices");
1446 stdio_in_use
= true;
1447 old_fd0_flags
= fcntl(0, F_GETFL
);
1448 tcgetattr(0, &oldtty
);
1449 qemu_set_nonblock(0);
1452 memset(&act
, 0, sizeof(act
));
1453 act
.sa_handler
= term_stdio_handler
;
1454 sigaction(SIGCONT
, &act
, NULL
);
1456 qemu_chr_open_fd(chr
, 0, 1);
1458 if (opts
->has_signal
) {
1459 stdio_allow_signal
= opts
->signal
;
1461 qemu_chr_set_echo_stdio(chr
, false);
1464 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1465 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1466 || defined(__GLIBC__)
1468 #define HAVE_CHARDEV_SERIAL 1
1469 #define HAVE_CHARDEV_PTY 1
1476 /* Protected by the Chardev chr_write_lock. */
1482 #define PTY_CHARDEV(obj) OBJECT_CHECK(PtyChardev, (obj), TYPE_CHARDEV_PTY)
1484 static void pty_chr_update_read_handler_locked(Chardev
*chr
);
1485 static void pty_chr_state(Chardev
*chr
, int connected
);
1487 static gboolean
pty_chr_timer(gpointer opaque
)
1489 struct Chardev
*chr
= CHARDEV(opaque
);
1490 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1492 qemu_mutex_lock(&chr
->chr_write_lock
);
1495 if (!s
->connected
) {
1497 pty_chr_update_read_handler_locked(chr
);
1499 qemu_mutex_unlock(&chr
->chr_write_lock
);
1503 /* Called with chr_write_lock held. */
1504 static void pty_chr_rearm_timer(Chardev
*chr
, int ms
)
1506 PtyChardev
*s
= PTY_CHARDEV(chr
);
1510 g_source_remove(s
->timer_tag
);
1515 name
= g_strdup_printf("pty-timer-secs-%s", chr
->label
);
1516 s
->timer_tag
= g_timeout_add_seconds(1, pty_chr_timer
, chr
);
1518 name
= g_strdup_printf("pty-timer-ms-%s", chr
->label
);
1519 s
->timer_tag
= g_timeout_add(ms
, pty_chr_timer
, chr
);
1521 g_source_set_name_by_id(s
->timer_tag
, name
);
1525 /* Called with chr_write_lock held. */
1526 static void pty_chr_update_read_handler_locked(Chardev
*chr
)
1528 PtyChardev
*s
= PTY_CHARDEV(chr
);
1531 QIOChannelFile
*fioc
= QIO_CHANNEL_FILE(s
->ioc
);
1534 pfd
.events
= G_IO_OUT
;
1537 rc
= g_poll(&pfd
, 1, 0);
1538 } while (rc
== -1 && errno
== EINTR
);
1541 if (pfd
.revents
& G_IO_HUP
) {
1542 pty_chr_state(chr
, 0);
1544 pty_chr_state(chr
, 1);
1548 static void pty_chr_update_read_handler(Chardev
*chr
,
1549 GMainContext
*context
)
1551 qemu_mutex_lock(&chr
->chr_write_lock
);
1552 pty_chr_update_read_handler_locked(chr
);
1553 qemu_mutex_unlock(&chr
->chr_write_lock
);
1556 /* Called with chr_write_lock held. */
1557 static int char_pty_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
1559 PtyChardev
*s
= PTY_CHARDEV(chr
);
1561 if (!s
->connected
) {
1562 /* guest sends data, check for (re-)connect */
1563 pty_chr_update_read_handler_locked(chr
);
1564 if (!s
->connected
) {
1568 return io_channel_send(s
->ioc
, buf
, len
);
1571 static GSource
*pty_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
1573 PtyChardev
*s
= PTY_CHARDEV(chr
);
1574 if (!s
->connected
) {
1577 return qio_channel_create_watch(s
->ioc
, cond
);
1580 static int pty_chr_read_poll(void *opaque
)
1582 Chardev
*chr
= CHARDEV(opaque
);
1583 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1585 s
->read_bytes
= qemu_chr_be_can_write(chr
);
1586 return s
->read_bytes
;
1589 static gboolean
pty_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
1591 Chardev
*chr
= CHARDEV(opaque
);
1592 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1594 uint8_t buf
[READ_BUF_LEN
];
1598 if (len
> s
->read_bytes
)
1599 len
= s
->read_bytes
;
1603 ret
= qio_channel_read(s
->ioc
, (char *)buf
, len
, NULL
);
1605 pty_chr_state(chr
, 0);
1608 pty_chr_state(chr
, 1);
1609 qemu_chr_be_write(chr
, buf
, ret
);
1614 static gboolean
qemu_chr_be_generic_open_func(gpointer opaque
)
1616 Chardev
*chr
= CHARDEV(opaque
);
1617 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1620 qemu_chr_be_generic_open(chr
);
1624 /* Called with chr_write_lock held. */
1625 static void pty_chr_state(Chardev
*chr
, int connected
)
1627 PtyChardev
*s
= PTY_CHARDEV(chr
);
1631 g_source_remove(s
->open_tag
);
1634 remove_fd_in_watch(chr
);
1636 /* (re-)connect poll interval for idle guests: once per second.
1637 * We check more frequently in case the guests sends data to
1638 * the virtual device linked to our pty. */
1639 pty_chr_rearm_timer(chr
, 1000);
1642 g_source_remove(s
->timer_tag
);
1645 if (!s
->connected
) {
1646 g_assert(s
->open_tag
== 0);
1648 s
->open_tag
= g_idle_add(qemu_chr_be_generic_open_func
, chr
);
1650 if (!chr
->fd_in_tag
) {
1651 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
1659 static void char_pty_finalize(Object
*obj
)
1661 Chardev
*chr
= CHARDEV(obj
);
1662 PtyChardev
*s
= PTY_CHARDEV(obj
);
1664 qemu_mutex_lock(&chr
->chr_write_lock
);
1665 pty_chr_state(chr
, 0);
1666 object_unref(OBJECT(s
->ioc
));
1668 g_source_remove(s
->timer_tag
);
1671 qemu_mutex_unlock(&chr
->chr_write_lock
);
1672 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1675 static void char_pty_open(Chardev
*chr
,
1676 ChardevBackend
*backend
,
1681 int master_fd
, slave_fd
;
1682 char pty_name
[PATH_MAX
];
1685 master_fd
= qemu_openpty_raw(&slave_fd
, pty_name
);
1686 if (master_fd
< 0) {
1687 error_setg_errno(errp
, errno
, "Failed to create PTY");
1692 qemu_set_nonblock(master_fd
);
1694 chr
->filename
= g_strdup_printf("pty:%s", pty_name
);
1695 error_report("char device redirected to %s (label %s)",
1696 pty_name
, chr
->label
);
1698 s
= PTY_CHARDEV(chr
);
1699 s
->ioc
= QIO_CHANNEL(qio_channel_file_new_fd(master_fd
));
1700 name
= g_strdup_printf("chardev-pty-%s", chr
->label
);
1701 qio_channel_set_name(QIO_CHANNEL(s
->ioc
), name
);
1707 static void char_pty_class_init(ObjectClass
*oc
, void *data
)
1709 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
1711 cc
->kind
= CHARDEV_BACKEND_KIND_PTY
;
1712 cc
->open
= char_pty_open
;
1713 cc
->chr_write
= char_pty_chr_write
;
1714 cc
->chr_update_read_handler
= pty_chr_update_read_handler
;
1715 cc
->chr_add_watch
= pty_chr_add_watch
;
1718 static const TypeInfo char_pty_type_info
= {
1719 .name
= TYPE_CHARDEV_PTY
,
1720 .parent
= TYPE_CHARDEV
,
1721 .instance_size
= sizeof(PtyChardev
),
1722 .instance_finalize
= char_pty_finalize
,
1723 .class_init
= char_pty_class_init
,
1726 static void tty_serial_init(int fd
, int speed
,
1727 int parity
, int data_bits
, int stop_bits
)
1733 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1734 speed
, parity
, data_bits
, stop_bits
);
1736 tcgetattr (fd
, &tty
);
1738 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1739 speed
= speed
* 10 / 11;
1756 /* Non-Posix values follow. They may be unsupported on some systems. */
1758 check_speed(115200);
1760 check_speed(230400);
1763 check_speed(460800);
1766 check_speed(500000);
1769 check_speed(576000);
1772 check_speed(921600);
1775 check_speed(1000000);
1778 check_speed(1152000);
1781 check_speed(1500000);
1784 check_speed(2000000);
1787 check_speed(2500000);
1790 check_speed(3000000);
1793 check_speed(3500000);
1796 check_speed(4000000);
1801 cfsetispeed(&tty
, spd
);
1802 cfsetospeed(&tty
, spd
);
1804 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
1805 |INLCR
|IGNCR
|ICRNL
|IXON
);
1806 tty
.c_oflag
|= OPOST
;
1807 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
|ISIG
);
1808 tty
.c_cflag
&= ~(CSIZE
|PARENB
|PARODD
|CRTSCTS
|CSTOPB
);
1829 tty
.c_cflag
|= PARENB
;
1832 tty
.c_cflag
|= PARENB
| PARODD
;
1836 tty
.c_cflag
|= CSTOPB
;
1838 tcsetattr (fd
, TCSANOW
, &tty
);
1841 static int tty_serial_ioctl(Chardev
*chr
, int cmd
, void *arg
)
1843 FDChardev
*s
= FD_CHARDEV(chr
);
1844 QIOChannelFile
*fioc
= QIO_CHANNEL_FILE(s
->ioc_in
);
1847 case CHR_IOCTL_SERIAL_SET_PARAMS
:
1849 QEMUSerialSetParams
*ssp
= arg
;
1850 tty_serial_init(fioc
->fd
,
1851 ssp
->speed
, ssp
->parity
,
1852 ssp
->data_bits
, ssp
->stop_bits
);
1855 case CHR_IOCTL_SERIAL_SET_BREAK
:
1857 int enable
= *(int *)arg
;
1859 tcsendbreak(fioc
->fd
, 1);
1863 case CHR_IOCTL_SERIAL_GET_TIOCM
:
1866 int *targ
= (int *)arg
;
1867 ioctl(fioc
->fd
, TIOCMGET
, &sarg
);
1869 if (sarg
& TIOCM_CTS
)
1870 *targ
|= CHR_TIOCM_CTS
;
1871 if (sarg
& TIOCM_CAR
)
1872 *targ
|= CHR_TIOCM_CAR
;
1873 if (sarg
& TIOCM_DSR
)
1874 *targ
|= CHR_TIOCM_DSR
;
1875 if (sarg
& TIOCM_RI
)
1876 *targ
|= CHR_TIOCM_RI
;
1877 if (sarg
& TIOCM_DTR
)
1878 *targ
|= CHR_TIOCM_DTR
;
1879 if (sarg
& TIOCM_RTS
)
1880 *targ
|= CHR_TIOCM_RTS
;
1883 case CHR_IOCTL_SERIAL_SET_TIOCM
:
1885 int sarg
= *(int *)arg
;
1887 ioctl(fioc
->fd
, TIOCMGET
, &targ
);
1888 targ
&= ~(CHR_TIOCM_CTS
| CHR_TIOCM_CAR
| CHR_TIOCM_DSR
1889 | CHR_TIOCM_RI
| CHR_TIOCM_DTR
| CHR_TIOCM_RTS
);
1890 if (sarg
& CHR_TIOCM_CTS
)
1892 if (sarg
& CHR_TIOCM_CAR
)
1894 if (sarg
& CHR_TIOCM_DSR
)
1896 if (sarg
& CHR_TIOCM_RI
)
1898 if (sarg
& CHR_TIOCM_DTR
)
1900 if (sarg
& CHR_TIOCM_RTS
)
1902 ioctl(fioc
->fd
, TIOCMSET
, &targ
);
1910 #endif /* __linux__ || __sun__ */
1912 #if defined(__linux__)
1914 #define HAVE_CHARDEV_PARPORT 1
1922 #define PARALLEL_CHARDEV(obj) \
1923 OBJECT_CHECK(ParallelChardev, (obj), TYPE_CHARDEV_PARALLEL)
1925 static int pp_hw_mode(ParallelChardev
*s
, uint16_t mode
)
1927 if (s
->mode
!= mode
) {
1929 if (ioctl(s
->fd
, PPSETMODE
, &m
) < 0)
1936 static int pp_ioctl(Chardev
*chr
, int cmd
, void *arg
)
1938 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
1943 case CHR_IOCTL_PP_READ_DATA
:
1944 if (ioctl(fd
, PPRDATA
, &b
) < 0)
1946 *(uint8_t *)arg
= b
;
1948 case CHR_IOCTL_PP_WRITE_DATA
:
1949 b
= *(uint8_t *)arg
;
1950 if (ioctl(fd
, PPWDATA
, &b
) < 0)
1953 case CHR_IOCTL_PP_READ_CONTROL
:
1954 if (ioctl(fd
, PPRCONTROL
, &b
) < 0)
1956 /* Linux gives only the lowest bits, and no way to know data
1957 direction! For better compatibility set the fixed upper
1959 *(uint8_t *)arg
= b
| 0xc0;
1961 case CHR_IOCTL_PP_WRITE_CONTROL
:
1962 b
= *(uint8_t *)arg
;
1963 if (ioctl(fd
, PPWCONTROL
, &b
) < 0)
1966 case CHR_IOCTL_PP_READ_STATUS
:
1967 if (ioctl(fd
, PPRSTATUS
, &b
) < 0)
1969 *(uint8_t *)arg
= b
;
1971 case CHR_IOCTL_PP_DATA_DIR
:
1972 if (ioctl(fd
, PPDATADIR
, (int *)arg
) < 0)
1975 case CHR_IOCTL_PP_EPP_READ_ADDR
:
1976 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
|IEEE1284_ADDR
)) {
1977 struct ParallelIOArg
*parg
= arg
;
1978 int n
= read(fd
, parg
->buffer
, parg
->count
);
1979 if (n
!= parg
->count
) {
1984 case CHR_IOCTL_PP_EPP_READ
:
1985 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
)) {
1986 struct ParallelIOArg
*parg
= arg
;
1987 int n
= read(fd
, parg
->buffer
, parg
->count
);
1988 if (n
!= parg
->count
) {
1993 case CHR_IOCTL_PP_EPP_WRITE_ADDR
:
1994 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
|IEEE1284_ADDR
)) {
1995 struct ParallelIOArg
*parg
= arg
;
1996 int n
= write(fd
, parg
->buffer
, parg
->count
);
1997 if (n
!= parg
->count
) {
2002 case CHR_IOCTL_PP_EPP_WRITE
:
2003 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
)) {
2004 struct ParallelIOArg
*parg
= arg
;
2005 int n
= write(fd
, parg
->buffer
, parg
->count
);
2006 if (n
!= parg
->count
) {
2017 static void qemu_chr_open_pp_fd(Chardev
*chr
,
2022 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
2024 if (ioctl(fd
, PPCLAIM
) < 0) {
2025 error_setg_errno(errp
, errno
, "not a parallel port");
2031 drv
->mode
= IEEE1284_MODE_COMPAT
;
2033 #endif /* __linux__ */
2035 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
2037 #define HAVE_CHARDEV_PARPORT 1
2044 #define PARALLEL_CHARDEV(obj) \
2045 OBJECT_CHECK(ParallelChardev, (obj), TYPE_CHARDEV_PARALLEL)
2047 static int pp_ioctl(Chardev
*chr
, int cmd
, void *arg
)
2049 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
2053 case CHR_IOCTL_PP_READ_DATA
:
2054 if (ioctl(drv
->fd
, PPIGDATA
, &b
) < 0) {
2057 *(uint8_t *)arg
= b
;
2059 case CHR_IOCTL_PP_WRITE_DATA
:
2060 b
= *(uint8_t *)arg
;
2061 if (ioctl(drv
->fd
, PPISDATA
, &b
) < 0) {
2065 case CHR_IOCTL_PP_READ_CONTROL
:
2066 if (ioctl(drv
->fd
, PPIGCTRL
, &b
) < 0) {
2069 *(uint8_t *)arg
= b
;
2071 case CHR_IOCTL_PP_WRITE_CONTROL
:
2072 b
= *(uint8_t *)arg
;
2073 if (ioctl(drv
->fd
, PPISCTRL
, &b
) < 0) {
2077 case CHR_IOCTL_PP_READ_STATUS
:
2078 if (ioctl(drv
->fd
, PPIGSTATUS
, &b
) < 0) {
2081 *(uint8_t *)arg
= b
;
2089 static void qemu_chr_open_pp_fd(Chardev
*chr
,
2094 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
2102 #define HAVE_CHARDEV_SERIAL 1
2107 HANDLE hcom
, hrecv
, hsend
;
2112 /* Protected by the Chardev chr_write_lock. */
2114 /* FIXME: file/console do not finalize */
2118 #define TYPE_CHARDEV_WIN "chardev-win"
2119 #define WIN_CHARDEV(obj) OBJECT_CHECK(WinChardev, (obj), TYPE_CHARDEV_WIN)
2124 HANDLE hInputReadyEvent
;
2125 HANDLE hInputDoneEvent
;
2126 HANDLE hInputThread
;
2127 uint8_t win_stdio_buf
;
2130 #define TYPE_CHARDEV_WIN_STDIO "chardev-win-stdio"
2131 #define WIN_STDIO_CHARDEV(obj) \
2132 OBJECT_CHECK(WinStdioChardev, (obj), TYPE_CHARDEV_WIN_STDIO)
2134 #define NSENDBUF 2048
2135 #define NRECVBUF 2048
2136 #define MAXCONNECT 1
2137 #define NTIMEOUT 5000
2139 static int win_chr_poll(void *opaque
);
2140 static int win_chr_pipe_poll(void *opaque
);
2142 static void char_win_finalize(Object
*obj
)
2144 Chardev
*chr
= CHARDEV(obj
);
2145 WinChardev
*s
= WIN_CHARDEV(chr
);
2152 CloseHandle(s
->hsend
);
2155 CloseHandle(s
->hrecv
);
2158 CloseHandle(s
->hcom
);
2161 qemu_del_polling_cb(win_chr_pipe_poll
, chr
);
2163 qemu_del_polling_cb(win_chr_poll
, chr
);
2165 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
2168 static int win_chr_init(Chardev
*chr
, const char *filename
, Error
**errp
)
2170 WinChardev
*s
= WIN_CHARDEV(chr
);
2172 COMMTIMEOUTS cto
= { 0, 0, 0, 0, 0};
2177 s
->hsend
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2179 error_setg(errp
, "Failed CreateEvent");
2182 s
->hrecv
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2184 error_setg(errp
, "Failed CreateEvent");
2188 s
->hcom
= CreateFile(filename
, GENERIC_READ
|GENERIC_WRITE
, 0, NULL
,
2189 OPEN_EXISTING
, FILE_FLAG_OVERLAPPED
, 0);
2190 if (s
->hcom
== INVALID_HANDLE_VALUE
) {
2191 error_setg(errp
, "Failed CreateFile (%lu)", GetLastError());
2196 if (!SetupComm(s
->hcom
, NRECVBUF
, NSENDBUF
)) {
2197 error_setg(errp
, "Failed SetupComm");
2201 ZeroMemory(&comcfg
, sizeof(COMMCONFIG
));
2202 size
= sizeof(COMMCONFIG
);
2203 GetDefaultCommConfig(filename
, &comcfg
, &size
);
2204 comcfg
.dcb
.DCBlength
= sizeof(DCB
);
2205 CommConfigDialog(filename
, NULL
, &comcfg
);
2207 if (!SetCommState(s
->hcom
, &comcfg
.dcb
)) {
2208 error_setg(errp
, "Failed SetCommState");
2212 if (!SetCommMask(s
->hcom
, EV_ERR
)) {
2213 error_setg(errp
, "Failed SetCommMask");
2217 cto
.ReadIntervalTimeout
= MAXDWORD
;
2218 if (!SetCommTimeouts(s
->hcom
, &cto
)) {
2219 error_setg(errp
, "Failed SetCommTimeouts");
2223 if (!ClearCommError(s
->hcom
, &err
, &comstat
)) {
2224 error_setg(errp
, "Failed ClearCommError");
2227 qemu_add_polling_cb(win_chr_poll
, chr
);
2234 /* Called with chr_write_lock held. */
2235 static int win_chr_write(Chardev
*chr
, const uint8_t *buf
, int len1
)
2237 WinChardev
*s
= WIN_CHARDEV(chr
);
2238 DWORD len
, ret
, size
, err
;
2241 ZeroMemory(&s
->osend
, sizeof(s
->osend
));
2242 s
->osend
.hEvent
= s
->hsend
;
2245 ret
= WriteFile(s
->hcom
, buf
, len
, &size
, &s
->osend
);
2247 ret
= WriteFile(s
->hcom
, buf
, len
, &size
, NULL
);
2249 err
= GetLastError();
2250 if (err
== ERROR_IO_PENDING
) {
2251 ret
= GetOverlappedResult(s
->hcom
, &s
->osend
, &size
, TRUE
);
2269 static int win_chr_read_poll(Chardev
*chr
)
2271 WinChardev
*s
= WIN_CHARDEV(chr
);
2273 s
->max_size
= qemu_chr_be_can_write(chr
);
2277 static void win_chr_readfile(Chardev
*chr
)
2279 WinChardev
*s
= WIN_CHARDEV(chr
);
2282 uint8_t buf
[READ_BUF_LEN
];
2285 ZeroMemory(&s
->orecv
, sizeof(s
->orecv
));
2286 s
->orecv
.hEvent
= s
->hrecv
;
2287 ret
= ReadFile(s
->hcom
, buf
, s
->len
, &size
, &s
->orecv
);
2289 err
= GetLastError();
2290 if (err
== ERROR_IO_PENDING
) {
2291 ret
= GetOverlappedResult(s
->hcom
, &s
->orecv
, &size
, TRUE
);
2296 qemu_chr_be_write(chr
, buf
, size
);
2300 static void win_chr_read(Chardev
*chr
)
2302 WinChardev
*s
= WIN_CHARDEV(chr
);
2304 if (s
->len
> s
->max_size
)
2305 s
->len
= s
->max_size
;
2309 win_chr_readfile(chr
);
2312 static int win_chr_poll(void *opaque
)
2314 Chardev
*chr
= CHARDEV(opaque
);
2315 WinChardev
*s
= WIN_CHARDEV(opaque
);
2319 ClearCommError(s
->hcom
, &comerr
, &status
);
2320 if (status
.cbInQue
> 0) {
2321 s
->len
= status
.cbInQue
;
2322 win_chr_read_poll(chr
);
2329 static int win_chr_pipe_poll(void *opaque
)
2331 Chardev
*chr
= CHARDEV(opaque
);
2332 WinChardev
*s
= WIN_CHARDEV(opaque
);
2335 PeekNamedPipe(s
->hcom
, NULL
, 0, NULL
, &size
, NULL
);
2338 win_chr_read_poll(chr
);
2345 static int win_chr_pipe_init(Chardev
*chr
, const char *filename
,
2348 WinChardev
*s
= WIN_CHARDEV(chr
);
2356 s
->hsend
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2358 error_setg(errp
, "Failed CreateEvent");
2361 s
->hrecv
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2363 error_setg(errp
, "Failed CreateEvent");
2367 openname
= g_strdup_printf("\\\\.\\pipe\\%s", filename
);
2368 s
->hcom
= CreateNamedPipe(openname
, PIPE_ACCESS_DUPLEX
| FILE_FLAG_OVERLAPPED
,
2369 PIPE_TYPE_BYTE
| PIPE_READMODE_BYTE
|
2371 MAXCONNECT
, NSENDBUF
, NRECVBUF
, NTIMEOUT
, NULL
);
2373 if (s
->hcom
== INVALID_HANDLE_VALUE
) {
2374 error_setg(errp
, "Failed CreateNamedPipe (%lu)", GetLastError());
2379 ZeroMemory(&ov
, sizeof(ov
));
2380 ov
.hEvent
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2381 ret
= ConnectNamedPipe(s
->hcom
, &ov
);
2383 error_setg(errp
, "Failed ConnectNamedPipe");
2387 ret
= GetOverlappedResult(s
->hcom
, &ov
, &size
, TRUE
);
2389 error_setg(errp
, "Failed GetOverlappedResult");
2391 CloseHandle(ov
.hEvent
);
2398 CloseHandle(ov
.hEvent
);
2401 qemu_add_polling_cb(win_chr_pipe_poll
, chr
);
2409 static void qemu_chr_open_pipe(Chardev
*chr
,
2410 ChardevBackend
*backend
,
2414 ChardevHostdev
*opts
= backend
->u
.pipe
.data
;
2415 const char *filename
= opts
->device
;
2417 if (win_chr_pipe_init(chr
, filename
, errp
) < 0) {
2422 static void qemu_chr_open_win_file(Chardev
*chr
, HANDLE fd_out
)
2424 WinChardev
*s
= WIN_CHARDEV(chr
);
2426 s
->skip_free
= true;
2430 static void char_win_class_init(ObjectClass
*oc
, void *data
)
2432 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
2434 cc
->chr_write
= win_chr_write
;
2437 static const TypeInfo char_win_type_info
= {
2438 .name
= TYPE_CHARDEV_WIN
,
2439 .parent
= TYPE_CHARDEV
,
2440 .instance_size
= sizeof(WinChardev
),
2441 .instance_finalize
= char_win_finalize
,
2442 .class_init
= char_win_class_init
,
2446 static void qemu_chr_open_win_con(Chardev
*chr
,
2447 ChardevBackend
*backend
,
2451 qemu_chr_open_win_file(chr
, GetStdHandle(STD_OUTPUT_HANDLE
));
2454 static void char_console_class_init(ObjectClass
*oc
, void *data
)
2456 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
2458 cc
->kind
= CHARDEV_BACKEND_KIND_CONSOLE
;
2459 cc
->open
= qemu_chr_open_win_con
;
2462 static const TypeInfo char_console_type_info
= {
2463 .name
= TYPE_CHARDEV_CONSOLE
,
2464 .parent
= TYPE_CHARDEV_WIN
,
2465 .class_init
= char_console_class_init
,
2468 static int win_stdio_write(Chardev
*chr
, const uint8_t *buf
, int len
)
2470 HANDLE hStdOut
= GetStdHandle(STD_OUTPUT_HANDLE
);
2477 if (!WriteFile(hStdOut
, buf
, len1
, &dwSize
, NULL
)) {
2487 static void win_stdio_wait_func(void *opaque
)
2489 Chardev
*chr
= CHARDEV(opaque
);
2490 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(opaque
);
2491 INPUT_RECORD buf
[4];
2496 ret
= ReadConsoleInput(stdio
->hStdIn
, buf
, ARRAY_SIZE(buf
), &dwSize
);
2499 /* Avoid error storm */
2500 qemu_del_wait_object(stdio
->hStdIn
, NULL
, NULL
);
2504 for (i
= 0; i
< dwSize
; i
++) {
2505 KEY_EVENT_RECORD
*kev
= &buf
[i
].Event
.KeyEvent
;
2507 if (buf
[i
].EventType
== KEY_EVENT
&& kev
->bKeyDown
) {
2509 if (kev
->uChar
.AsciiChar
!= 0) {
2510 for (j
= 0; j
< kev
->wRepeatCount
; j
++) {
2511 if (qemu_chr_be_can_write(chr
)) {
2512 uint8_t c
= kev
->uChar
.AsciiChar
;
2513 qemu_chr_be_write(chr
, &c
, 1);
2521 static DWORD WINAPI
win_stdio_thread(LPVOID param
)
2523 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(param
);
2529 /* Wait for one byte */
2530 ret
= ReadFile(stdio
->hStdIn
, &stdio
->win_stdio_buf
, 1, &dwSize
, NULL
);
2532 /* Exit in case of error, continue if nothing read */
2540 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2541 if (stdio
->win_stdio_buf
== '\r') {
2545 /* Signal the main thread and wait until the byte was eaten */
2546 if (!SetEvent(stdio
->hInputReadyEvent
)) {
2549 if (WaitForSingleObject(stdio
->hInputDoneEvent
, INFINITE
)
2555 qemu_del_wait_object(stdio
->hInputReadyEvent
, NULL
, NULL
);
2559 static void win_stdio_thread_wait_func(void *opaque
)
2561 Chardev
*chr
= CHARDEV(opaque
);
2562 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(opaque
);
2564 if (qemu_chr_be_can_write(chr
)) {
2565 qemu_chr_be_write(chr
, &stdio
->win_stdio_buf
, 1);
2568 SetEvent(stdio
->hInputDoneEvent
);
2571 static void qemu_chr_set_echo_win_stdio(Chardev
*chr
, bool echo
)
2573 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(chr
);
2576 GetConsoleMode(stdio
->hStdIn
, &dwMode
);
2579 SetConsoleMode(stdio
->hStdIn
, dwMode
| ENABLE_ECHO_INPUT
);
2581 SetConsoleMode(stdio
->hStdIn
, dwMode
& ~ENABLE_ECHO_INPUT
);
2585 static void char_win_stdio_finalize(Object
*obj
)
2587 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(obj
);
2589 if (stdio
->hInputReadyEvent
!= INVALID_HANDLE_VALUE
) {
2590 CloseHandle(stdio
->hInputReadyEvent
);
2592 if (stdio
->hInputDoneEvent
!= INVALID_HANDLE_VALUE
) {
2593 CloseHandle(stdio
->hInputDoneEvent
);
2595 if (stdio
->hInputThread
!= INVALID_HANDLE_VALUE
) {
2596 TerminateThread(stdio
->hInputThread
, 0);
2600 static const TypeInfo char_win_stdio_type_info
= {
2601 .name
= TYPE_CHARDEV_WIN_STDIO
,
2602 .parent
= TYPE_CHARDEV
,
2603 .instance_size
= sizeof(WinStdioChardev
),
2604 .instance_finalize
= char_win_stdio_finalize
,
2608 static void qemu_chr_open_stdio(Chardev
*chr
,
2609 ChardevBackend
*backend
,
2613 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(chr
);
2617 stdio
->hStdIn
= GetStdHandle(STD_INPUT_HANDLE
);
2618 if (stdio
->hStdIn
== INVALID_HANDLE_VALUE
) {
2619 error_setg(errp
, "cannot open stdio: invalid handle");
2623 is_console
= GetConsoleMode(stdio
->hStdIn
, &dwMode
) != 0;
2626 if (qemu_add_wait_object(stdio
->hStdIn
,
2627 win_stdio_wait_func
, chr
)) {
2628 error_setg(errp
, "qemu_add_wait_object: failed");
2634 stdio
->hInputReadyEvent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
2635 stdio
->hInputDoneEvent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
2636 if (stdio
->hInputReadyEvent
== INVALID_HANDLE_VALUE
2637 || stdio
->hInputDoneEvent
== INVALID_HANDLE_VALUE
) {
2638 error_setg(errp
, "cannot create event");
2641 if (qemu_add_wait_object(stdio
->hInputReadyEvent
,
2642 win_stdio_thread_wait_func
, chr
)) {
2643 error_setg(errp
, "qemu_add_wait_object: failed");
2646 stdio
->hInputThread
= CreateThread(NULL
, 0, win_stdio_thread
,
2649 if (stdio
->hInputThread
== INVALID_HANDLE_VALUE
) {
2650 error_setg(errp
, "cannot create stdio thread");
2655 dwMode
|= ENABLE_LINE_INPUT
;
2658 /* set the terminal in raw mode */
2659 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2660 dwMode
|= ENABLE_PROCESSED_INPUT
;
2663 SetConsoleMode(stdio
->hStdIn
, dwMode
);
2665 qemu_chr_set_echo_win_stdio(chr
, false);
2670 qemu_del_wait_object(stdio
->hInputReadyEvent
, NULL
, NULL
);
2672 CloseHandle(stdio
->hInputReadyEvent
);
2673 CloseHandle(stdio
->hInputDoneEvent
);
2675 qemu_del_wait_object(stdio
->hStdIn
, NULL
, NULL
);
2677 #endif /* !_WIN32 */
2679 /***********************************************************/
2680 /* UDP Net console */
2685 uint8_t buf
[READ_BUF_LEN
];
2691 #define UDP_CHARDEV(obj) OBJECT_CHECK(UdpChardev, (obj), TYPE_CHARDEV_UDP)
2693 /* Called with chr_write_lock held. */
2694 static int udp_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
2696 UdpChardev
*s
= UDP_CHARDEV(chr
);
2698 return qio_channel_write(
2699 s
->ioc
, (const char *)buf
, len
, NULL
);
2702 static int udp_chr_read_poll(void *opaque
)
2704 Chardev
*chr
= CHARDEV(opaque
);
2705 UdpChardev
*s
= UDP_CHARDEV(opaque
);
2707 s
->max_size
= qemu_chr_be_can_write(chr
);
2709 /* If there were any stray characters in the queue process them
2712 while (s
->max_size
> 0 && s
->bufptr
< s
->bufcnt
) {
2713 qemu_chr_be_write(chr
, &s
->buf
[s
->bufptr
], 1);
2715 s
->max_size
= qemu_chr_be_can_write(chr
);
2720 static gboolean
udp_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
2722 Chardev
*chr
= CHARDEV(opaque
);
2723 UdpChardev
*s
= UDP_CHARDEV(opaque
);
2726 if (s
->max_size
== 0) {
2729 ret
= qio_channel_read(
2730 s
->ioc
, (char *)s
->buf
, sizeof(s
->buf
), NULL
);
2732 remove_fd_in_watch(chr
);
2738 while (s
->max_size
> 0 && s
->bufptr
< s
->bufcnt
) {
2739 qemu_chr_be_write(chr
, &s
->buf
[s
->bufptr
], 1);
2741 s
->max_size
= qemu_chr_be_can_write(chr
);
2747 static void udp_chr_update_read_handler(Chardev
*chr
,
2748 GMainContext
*context
)
2750 UdpChardev
*s
= UDP_CHARDEV(chr
);
2752 remove_fd_in_watch(chr
);
2754 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
2761 static void char_udp_finalize(Object
*obj
)
2763 Chardev
*chr
= CHARDEV(obj
);
2764 UdpChardev
*s
= UDP_CHARDEV(obj
);
2766 remove_fd_in_watch(chr
);
2768 object_unref(OBJECT(s
->ioc
));
2770 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
2773 /***********************************************************/
2774 /* TCP Net console */
2778 QIOChannel
*ioc
; /* Client I/O channel */
2779 QIOChannelSocket
*sioc
; /* Client master channel */
2780 QIOChannelSocket
*listen_ioc
;
2782 QCryptoTLSCreds
*tls_creds
;
2789 size_t read_msgfds_num
;
2791 size_t write_msgfds_num
;
2793 SocketAddress
*addr
;
2797 guint reconnect_timer
;
2798 int64_t reconnect_time
;
2799 bool connect_err_reported
;
2802 #define SOCKET_CHARDEV(obj) \
2803 OBJECT_CHECK(SocketChardev, (obj), TYPE_CHARDEV_SOCKET)
2805 static gboolean
socket_reconnect_timeout(gpointer opaque
);
2807 static void qemu_chr_socket_restart_timer(Chardev
*chr
)
2809 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2812 assert(s
->connected
== 0);
2813 s
->reconnect_timer
= g_timeout_add_seconds(s
->reconnect_time
,
2814 socket_reconnect_timeout
, chr
);
2815 name
= g_strdup_printf("chardev-socket-reconnect-%s", chr
->label
);
2816 g_source_set_name_by_id(s
->reconnect_timer
, name
);
2820 static void check_report_connect_error(Chardev
*chr
,
2823 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2825 if (!s
->connect_err_reported
) {
2826 error_report("Unable to connect character device %s: %s",
2827 chr
->label
, error_get_pretty(err
));
2828 s
->connect_err_reported
= true;
2830 qemu_chr_socket_restart_timer(chr
);
2833 static gboolean
tcp_chr_accept(QIOChannel
*chan
,
2837 /* Called with chr_write_lock held. */
2838 static int tcp_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
2840 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2843 int ret
= io_channel_send_full(s
->ioc
, buf
, len
,
2845 s
->write_msgfds_num
);
2847 /* free the written msgfds, no matter what */
2848 if (s
->write_msgfds_num
) {
2849 g_free(s
->write_msgfds
);
2850 s
->write_msgfds
= 0;
2851 s
->write_msgfds_num
= 0;
2856 /* XXX: indicate an error ? */
2861 static int tcp_chr_read_poll(void *opaque
)
2863 Chardev
*chr
= CHARDEV(opaque
);
2864 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
2867 s
->max_size
= qemu_chr_be_can_write(chr
);
2872 #define IAC_BREAK 243
2873 static void tcp_chr_process_IAC_bytes(Chardev
*chr
,
2875 uint8_t *buf
, int *size
)
2877 /* Handle any telnet client's basic IAC options to satisfy char by
2878 * char mode with no echo. All IAC options will be removed from
2879 * the buf and the do_telnetopt variable will be used to track the
2880 * state of the width of the IAC information.
2882 * IAC commands come in sets of 3 bytes with the exception of the
2883 * "IAC BREAK" command and the double IAC.
2889 for (i
= 0; i
< *size
; i
++) {
2890 if (s
->do_telnetopt
> 1) {
2891 if ((unsigned char)buf
[i
] == IAC
&& s
->do_telnetopt
== 2) {
2892 /* Double IAC means send an IAC */
2896 s
->do_telnetopt
= 1;
2898 if ((unsigned char)buf
[i
] == IAC_BREAK
&& s
->do_telnetopt
== 2) {
2899 /* Handle IAC break commands by sending a serial break */
2900 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
2905 if (s
->do_telnetopt
>= 4) {
2906 s
->do_telnetopt
= 1;
2909 if ((unsigned char)buf
[i
] == IAC
) {
2910 s
->do_telnetopt
= 2;
2921 static int tcp_get_msgfds(Chardev
*chr
, int *fds
, int num
)
2923 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2925 int to_copy
= (s
->read_msgfds_num
< num
) ? s
->read_msgfds_num
: num
;
2927 assert(num
<= TCP_MAX_FDS
);
2932 memcpy(fds
, s
->read_msgfds
, to_copy
* sizeof(int));
2934 /* Close unused fds */
2935 for (i
= to_copy
; i
< s
->read_msgfds_num
; i
++) {
2936 close(s
->read_msgfds
[i
]);
2939 g_free(s
->read_msgfds
);
2941 s
->read_msgfds_num
= 0;
2947 static int tcp_set_msgfds(Chardev
*chr
, int *fds
, int num
)
2949 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2951 /* clear old pending fd array */
2952 g_free(s
->write_msgfds
);
2953 s
->write_msgfds
= NULL
;
2954 s
->write_msgfds_num
= 0;
2956 if (!s
->connected
||
2957 !qio_channel_has_feature(s
->ioc
,
2958 QIO_CHANNEL_FEATURE_FD_PASS
)) {
2963 s
->write_msgfds
= g_new(int, num
);
2964 memcpy(s
->write_msgfds
, fds
, num
* sizeof(int));
2967 s
->write_msgfds_num
= num
;
2972 static ssize_t
tcp_chr_recv(Chardev
*chr
, char *buf
, size_t len
)
2974 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2975 struct iovec iov
= { .iov_base
= buf
, .iov_len
= len
};
2979 size_t msgfds_num
= 0;
2981 if (qio_channel_has_feature(s
->ioc
, QIO_CHANNEL_FEATURE_FD_PASS
)) {
2982 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
2983 &msgfds
, &msgfds_num
,
2986 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
2991 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
2994 } else if (ret
== -1) {
2999 /* close and clean read_msgfds */
3000 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
3001 close(s
->read_msgfds
[i
]);
3004 if (s
->read_msgfds_num
) {
3005 g_free(s
->read_msgfds
);
3008 s
->read_msgfds
= msgfds
;
3009 s
->read_msgfds_num
= msgfds_num
;
3012 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
3013 int fd
= s
->read_msgfds
[i
];
3018 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
3021 #ifndef MSG_CMSG_CLOEXEC
3022 qemu_set_cloexec(fd
);
3029 static GSource
*tcp_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
3031 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3032 return qio_channel_create_watch(s
->ioc
, cond
);
3035 static void tcp_chr_free_connection(Chardev
*chr
)
3037 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3040 if (!s
->connected
) {
3044 if (s
->read_msgfds_num
) {
3045 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
3046 close(s
->read_msgfds
[i
]);
3048 g_free(s
->read_msgfds
);
3049 s
->read_msgfds
= NULL
;
3050 s
->read_msgfds_num
= 0;
3053 tcp_set_msgfds(chr
, NULL
, 0);
3054 remove_fd_in_watch(chr
);
3055 object_unref(OBJECT(s
->sioc
));
3057 object_unref(OBJECT(s
->ioc
));
3059 g_free(chr
->filename
);
3060 chr
->filename
= NULL
;
3064 static void tcp_chr_disconnect(Chardev
*chr
)
3066 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3068 if (!s
->connected
) {
3072 tcp_chr_free_connection(chr
);
3074 if (s
->listen_ioc
) {
3075 s
->listen_tag
= qio_channel_add_watch(
3076 QIO_CHANNEL(s
->listen_ioc
), G_IO_IN
, tcp_chr_accept
, chr
, NULL
);
3078 chr
->filename
= SocketAddress_to_str("disconnected:", s
->addr
,
3079 s
->is_listen
, s
->is_telnet
);
3080 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
3081 if (s
->reconnect_time
) {
3082 qemu_chr_socket_restart_timer(chr
);
3086 static gboolean
tcp_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
3088 Chardev
*chr
= CHARDEV(opaque
);
3089 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
3090 uint8_t buf
[READ_BUF_LEN
];
3093 if (!s
->connected
|| s
->max_size
<= 0) {
3097 if (len
> s
->max_size
)
3099 size
= tcp_chr_recv(chr
, (void *)buf
, len
);
3100 if (size
== 0 || size
== -1) {
3101 /* connection closed */
3102 tcp_chr_disconnect(chr
);
3103 } else if (size
> 0) {
3104 if (s
->do_telnetopt
)
3105 tcp_chr_process_IAC_bytes(chr
, s
, buf
, &size
);
3107 qemu_chr_be_write(chr
, buf
, size
);
3113 static int tcp_chr_sync_read(Chardev
*chr
, const uint8_t *buf
, int len
)
3115 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3118 if (!s
->connected
) {
3122 size
= tcp_chr_recv(chr
, (void *) buf
, len
);
3124 /* connection closed */
3125 tcp_chr_disconnect(chr
);
3131 static void tcp_chr_connect(void *opaque
)
3133 Chardev
*chr
= CHARDEV(opaque
);
3134 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
3136 g_free(chr
->filename
);
3137 chr
->filename
= sockaddr_to_str(
3138 &s
->sioc
->localAddr
, s
->sioc
->localAddrLen
,
3139 &s
->sioc
->remoteAddr
, s
->sioc
->remoteAddrLen
,
3140 s
->is_listen
, s
->is_telnet
);
3144 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
3149 qemu_chr_be_generic_open(chr
);
3152 static void tcp_chr_update_read_handler(Chardev
*chr
,
3153 GMainContext
*context
)
3155 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3157 if (!s
->connected
) {
3161 remove_fd_in_watch(chr
);
3163 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
3174 } TCPCharDriverTelnetInit
;
3176 static gboolean
tcp_chr_telnet_init_io(QIOChannel
*ioc
,
3177 GIOCondition cond G_GNUC_UNUSED
,
3180 TCPCharDriverTelnetInit
*init
= user_data
;
3183 ret
= qio_channel_write(ioc
, init
->buf
, init
->buflen
, NULL
);
3185 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
3188 tcp_chr_disconnect(init
->chr
);
3192 init
->buflen
-= ret
;
3194 if (init
->buflen
== 0) {
3195 tcp_chr_connect(init
->chr
);
3199 memmove(init
->buf
, init
->buf
+ ret
, init
->buflen
);
3204 static void tcp_chr_telnet_init(Chardev
*chr
)
3206 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3207 TCPCharDriverTelnetInit
*init
=
3208 g_new0(TCPCharDriverTelnetInit
, 1);
3214 #define IACSET(x, a, b, c) \
3221 /* Prep the telnet negotion to put telnet in binary,
3222 * no echo, single char mode */
3223 IACSET(init
->buf
, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3224 IACSET(init
->buf
, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3225 IACSET(init
->buf
, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3226 IACSET(init
->buf
, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3230 qio_channel_add_watch(
3232 tcp_chr_telnet_init_io
,
3237 static void tcp_chr_tls_handshake(QIOTask
*task
,
3240 Chardev
*chr
= user_data
;
3241 SocketChardev
*s
= user_data
;
3243 if (qio_task_propagate_error(task
, NULL
)) {
3244 tcp_chr_disconnect(chr
);
3246 if (s
->do_telnetopt
) {
3247 tcp_chr_telnet_init(chr
);
3249 tcp_chr_connect(chr
);
3255 static void tcp_chr_tls_init(Chardev
*chr
)
3257 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3258 QIOChannelTLS
*tioc
;
3263 tioc
= qio_channel_tls_new_server(
3264 s
->ioc
, s
->tls_creds
,
3265 NULL
, /* XXX Use an ACL */
3268 tioc
= qio_channel_tls_new_client(
3269 s
->ioc
, s
->tls_creds
,
3270 s
->addr
->u
.inet
.data
->host
,
3275 tcp_chr_disconnect(chr
);
3278 name
= g_strdup_printf("chardev-tls-%s-%s",
3279 s
->is_listen
? "server" : "client",
3281 qio_channel_set_name(QIO_CHANNEL(tioc
), name
);
3283 object_unref(OBJECT(s
->ioc
));
3284 s
->ioc
= QIO_CHANNEL(tioc
);
3286 qio_channel_tls_handshake(tioc
,
3287 tcp_chr_tls_handshake
,
3293 static void tcp_chr_set_client_ioc_name(Chardev
*chr
,
3294 QIOChannelSocket
*sioc
)
3296 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3298 name
= g_strdup_printf("chardev-tcp-%s-%s",
3299 s
->is_listen
? "server" : "client",
3301 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
3306 static int tcp_chr_new_client(Chardev
*chr
, QIOChannelSocket
*sioc
)
3308 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3310 if (s
->ioc
!= NULL
) {
3314 s
->ioc
= QIO_CHANNEL(sioc
);
3315 object_ref(OBJECT(sioc
));
3317 object_ref(OBJECT(sioc
));
3319 qio_channel_set_blocking(s
->ioc
, false, NULL
);
3321 if (s
->do_nodelay
) {
3322 qio_channel_set_delay(s
->ioc
, false);
3324 if (s
->listen_tag
) {
3325 g_source_remove(s
->listen_tag
);
3330 tcp_chr_tls_init(chr
);
3332 if (s
->do_telnetopt
) {
3333 tcp_chr_telnet_init(chr
);
3335 tcp_chr_connect(chr
);
3343 static int tcp_chr_add_client(Chardev
*chr
, int fd
)
3346 QIOChannelSocket
*sioc
;
3348 sioc
= qio_channel_socket_new_fd(fd
, NULL
);
3352 tcp_chr_set_client_ioc_name(chr
, sioc
);
3353 ret
= tcp_chr_new_client(chr
, sioc
);
3354 object_unref(OBJECT(sioc
));
3358 static gboolean
tcp_chr_accept(QIOChannel
*channel
,
3362 Chardev
*chr
= CHARDEV(opaque
);
3363 QIOChannelSocket
*sioc
;
3365 sioc
= qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel
),
3371 tcp_chr_new_client(chr
, sioc
);
3373 object_unref(OBJECT(sioc
));
3378 static int tcp_chr_wait_connected(Chardev
*chr
, Error
**errp
)
3380 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3381 QIOChannelSocket
*sioc
;
3383 /* It can't wait on s->connected, since it is set asynchronously
3384 * in TLS and telnet cases, only wait for an accepted socket */
3387 error_report("QEMU waiting for connection on: %s",
3389 qio_channel_set_blocking(QIO_CHANNEL(s
->listen_ioc
), true, NULL
);
3390 tcp_chr_accept(QIO_CHANNEL(s
->listen_ioc
), G_IO_IN
, chr
);
3391 qio_channel_set_blocking(QIO_CHANNEL(s
->listen_ioc
), false, NULL
);
3393 sioc
= qio_channel_socket_new();
3394 tcp_chr_set_client_ioc_name(chr
, sioc
);
3395 if (qio_channel_socket_connect_sync(sioc
, s
->addr
, errp
) < 0) {
3396 object_unref(OBJECT(sioc
));
3399 tcp_chr_new_client(chr
, sioc
);
3400 object_unref(OBJECT(sioc
));
3407 static int qemu_chr_wait_connected(Chardev
*chr
, Error
**errp
)
3409 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
3411 if (cc
->chr_wait_connected
) {
3412 return cc
->chr_wait_connected(chr
, errp
);
3418 int qemu_chr_fe_wait_connected(CharBackend
*be
, Error
**errp
)
3421 error_setg(errp
, "missing associated backend");
3425 return qemu_chr_wait_connected(be
->chr
, errp
);
3428 static void char_socket_finalize(Object
*obj
)
3430 Chardev
*chr
= CHARDEV(obj
);
3431 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
3433 tcp_chr_free_connection(chr
);
3435 if (s
->reconnect_timer
) {
3436 g_source_remove(s
->reconnect_timer
);
3437 s
->reconnect_timer
= 0;
3439 qapi_free_SocketAddress(s
->addr
);
3440 if (s
->listen_tag
) {
3441 g_source_remove(s
->listen_tag
);
3444 if (s
->listen_ioc
) {
3445 object_unref(OBJECT(s
->listen_ioc
));
3448 object_unref(OBJECT(s
->tls_creds
));
3451 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
3455 static void qemu_chr_socket_connected(QIOTask
*task
, void *opaque
)
3457 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
3458 Chardev
*chr
= CHARDEV(opaque
);
3459 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3462 if (qio_task_propagate_error(task
, &err
)) {
3463 check_report_connect_error(chr
, err
);
3468 s
->connect_err_reported
= false;
3469 tcp_chr_new_client(chr
, sioc
);
3472 object_unref(OBJECT(sioc
));
3476 /*********************************************************/
3477 /* Ring buffer chardev */
3487 #define RINGBUF_CHARDEV(obj) \
3488 OBJECT_CHECK(RingBufChardev, (obj), TYPE_CHARDEV_RINGBUF)
3490 static size_t ringbuf_count(const Chardev
*chr
)
3492 const RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3494 return d
->prod
- d
->cons
;
3497 /* Called with chr_write_lock held. */
3498 static int ringbuf_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
3500 RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3503 if (!buf
|| (len
< 0)) {
3507 for (i
= 0; i
< len
; i
++ ) {
3508 d
->cbuf
[d
->prod
++ & (d
->size
- 1)] = buf
[i
];
3509 if (d
->prod
- d
->cons
> d
->size
) {
3510 d
->cons
= d
->prod
- d
->size
;
3517 static int ringbuf_chr_read(Chardev
*chr
, uint8_t *buf
, int len
)
3519 RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3522 qemu_mutex_lock(&chr
->chr_write_lock
);
3523 for (i
= 0; i
< len
&& d
->cons
!= d
->prod
; i
++) {
3524 buf
[i
] = d
->cbuf
[d
->cons
++ & (d
->size
- 1)];
3526 qemu_mutex_unlock(&chr
->chr_write_lock
);
3531 static void char_ringbuf_finalize(Object
*obj
)
3533 RingBufChardev
*d
= RINGBUF_CHARDEV(obj
);
3538 static void qemu_chr_open_ringbuf(Chardev
*chr
,
3539 ChardevBackend
*backend
,
3543 ChardevRingbuf
*opts
= backend
->u
.ringbuf
.data
;
3544 RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3546 d
->size
= opts
->has_size
? opts
->size
: 65536;
3548 /* The size must be power of 2 */
3549 if (d
->size
& (d
->size
- 1)) {
3550 error_setg(errp
, "size of ringbuf chardev must be power of two");
3556 d
->cbuf
= g_malloc0(d
->size
);
3559 void qmp_ringbuf_write(const char *device
, const char *data
,
3560 bool has_format
, enum DataFormat format
,
3564 const uint8_t *write_data
;
3568 chr
= qemu_chr_find(device
);
3570 error_setg(errp
, "Device '%s' not found", device
);
3574 if (!CHARDEV_IS_RINGBUF(chr
)) {
3575 error_setg(errp
,"%s is not a ringbuf device", device
);
3579 if (has_format
&& (format
== DATA_FORMAT_BASE64
)) {
3580 write_data
= qbase64_decode(data
, -1,
3587 write_data
= (uint8_t *)data
;
3588 write_count
= strlen(data
);
3591 ret
= ringbuf_chr_write(chr
, write_data
, write_count
);
3593 if (write_data
!= (uint8_t *)data
) {
3594 g_free((void *)write_data
);
3598 error_setg(errp
, "Failed to write to device %s", device
);
3603 char *qmp_ringbuf_read(const char *device
, int64_t size
,
3604 bool has_format
, enum DataFormat format
,
3612 chr
= qemu_chr_find(device
);
3614 error_setg(errp
, "Device '%s' not found", device
);
3618 if (!CHARDEV_IS_RINGBUF(chr
)) {
3619 error_setg(errp
,"%s is not a ringbuf device", device
);
3624 error_setg(errp
, "size must be greater than zero");
3628 count
= ringbuf_count(chr
);
3629 size
= size
> count
? count
: size
;
3630 read_data
= g_malloc(size
+ 1);
3632 ringbuf_chr_read(chr
, read_data
, size
);
3634 if (has_format
&& (format
== DATA_FORMAT_BASE64
)) {
3635 data
= g_base64_encode(read_data
, size
);
3639 * FIXME should read only complete, valid UTF-8 characters up
3640 * to @size bytes. Invalid sequences should be replaced by a
3641 * suitable replacement character. Except when (and only
3642 * when) ring buffer lost characters since last read, initial
3643 * continuation characters should be dropped.
3645 read_data
[size
] = 0;
3646 data
= (char *)read_data
;
3652 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
)
3654 char host
[65], port
[33], width
[8], height
[8];
3658 Error
*local_err
= NULL
;
3660 opts
= qemu_opts_create(qemu_find_opts("chardev"), label
, 1, &local_err
);
3662 error_report_err(local_err
);
3666 if (strstart(filename
, "mon:", &p
)) {
3668 qemu_opt_set(opts
, "mux", "on", &error_abort
);
3669 if (strcmp(filename
, "stdio") == 0) {
3670 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3671 * but pass it to the guest. Handle this only for compat syntax,
3672 * for -chardev syntax we have special option for this.
3673 * This is what -nographic did, redirecting+muxing serial+monitor
3674 * to stdio causing Ctrl+C to be passed to guest. */
3675 qemu_opt_set(opts
, "signal", "off", &error_abort
);
3679 if (strcmp(filename
, "null") == 0 ||
3680 strcmp(filename
, "pty") == 0 ||
3681 strcmp(filename
, "msmouse") == 0 ||
3682 strcmp(filename
, "braille") == 0 ||
3683 strcmp(filename
, "testdev") == 0 ||
3684 strcmp(filename
, "stdio") == 0) {
3685 qemu_opt_set(opts
, "backend", filename
, &error_abort
);
3688 if (strstart(filename
, "vc", &p
)) {
3689 qemu_opt_set(opts
, "backend", "vc", &error_abort
);
3691 if (sscanf(p
+1, "%7[0-9]x%7[0-9]", width
, height
) == 2) {
3693 qemu_opt_set(opts
, "width", width
, &error_abort
);
3694 qemu_opt_set(opts
, "height", height
, &error_abort
);
3695 } else if (sscanf(p
+1, "%7[0-9]Cx%7[0-9]C", width
, height
) == 2) {
3697 qemu_opt_set(opts
, "cols", width
, &error_abort
);
3698 qemu_opt_set(opts
, "rows", height
, &error_abort
);
3705 if (strcmp(filename
, "con:") == 0) {
3706 qemu_opt_set(opts
, "backend", "console", &error_abort
);
3709 if (strstart(filename
, "COM", NULL
)) {
3710 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
3711 qemu_opt_set(opts
, "path", filename
, &error_abort
);
3714 if (strstart(filename
, "file:", &p
)) {
3715 qemu_opt_set(opts
, "backend", "file", &error_abort
);
3716 qemu_opt_set(opts
, "path", p
, &error_abort
);
3719 if (strstart(filename
, "pipe:", &p
)) {
3720 qemu_opt_set(opts
, "backend", "pipe", &error_abort
);
3721 qemu_opt_set(opts
, "path", p
, &error_abort
);
3724 if (strstart(filename
, "tcp:", &p
) ||
3725 strstart(filename
, "telnet:", &p
)) {
3726 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
3728 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1)
3731 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
3732 qemu_opt_set(opts
, "host", host
, &error_abort
);
3733 qemu_opt_set(opts
, "port", port
, &error_abort
);
3734 if (p
[pos
] == ',') {
3735 qemu_opts_do_parse(opts
, p
+pos
+1, NULL
, &local_err
);
3737 error_report_err(local_err
);
3741 if (strstart(filename
, "telnet:", &p
))
3742 qemu_opt_set(opts
, "telnet", "on", &error_abort
);
3745 if (strstart(filename
, "udp:", &p
)) {
3746 qemu_opt_set(opts
, "backend", "udp", &error_abort
);
3747 if (sscanf(p
, "%64[^:]:%32[^@,]%n", host
, port
, &pos
) < 2) {
3749 if (sscanf(p
, ":%32[^@,]%n", port
, &pos
) < 1) {
3753 qemu_opt_set(opts
, "host", host
, &error_abort
);
3754 qemu_opt_set(opts
, "port", port
, &error_abort
);
3755 if (p
[pos
] == '@') {
3757 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
3759 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1) {
3763 qemu_opt_set(opts
, "localaddr", host
, &error_abort
);
3764 qemu_opt_set(opts
, "localport", port
, &error_abort
);
3768 if (strstart(filename
, "unix:", &p
)) {
3769 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
3770 qemu_opts_do_parse(opts
, p
, "path", &local_err
);
3772 error_report_err(local_err
);
3777 if (strstart(filename
, "/dev/parport", NULL
) ||
3778 strstart(filename
, "/dev/ppi", NULL
)) {
3779 qemu_opt_set(opts
, "backend", "parport", &error_abort
);
3780 qemu_opt_set(opts
, "path", filename
, &error_abort
);
3783 if (strstart(filename
, "/dev/", NULL
)) {
3784 qemu_opt_set(opts
, "backend", "tty", &error_abort
);
3785 qemu_opt_set(opts
, "path", filename
, &error_abort
);
3790 qemu_opts_del(opts
);
3794 void qemu_chr_parse_common(QemuOpts
*opts
, ChardevCommon
*backend
)
3796 const char *logfile
= qemu_opt_get(opts
, "logfile");
3798 backend
->has_logfile
= logfile
!= NULL
;
3799 backend
->logfile
= logfile
? g_strdup(logfile
) : NULL
;
3801 backend
->has_logappend
= true;
3802 backend
->logappend
= qemu_opt_get_bool(opts
, "logappend", false);
3806 static void qemu_chr_parse_file_out(QemuOpts
*opts
, ChardevBackend
*backend
,
3809 const char *path
= qemu_opt_get(opts
, "path");
3813 error_setg(errp
, "chardev: file: no filename given");
3816 file
= backend
->u
.file
.data
= g_new0(ChardevFile
, 1);
3817 qemu_chr_parse_common(opts
, qapi_ChardevFile_base(file
));
3818 file
->out
= g_strdup(path
);
3820 file
->has_append
= true;
3821 file
->append
= qemu_opt_get_bool(opts
, "append", false);
3824 static void qemu_chr_parse_stdio(QemuOpts
*opts
, ChardevBackend
*backend
,
3827 ChardevStdio
*stdio
;
3829 stdio
= backend
->u
.stdio
.data
= g_new0(ChardevStdio
, 1);
3830 qemu_chr_parse_common(opts
, qapi_ChardevStdio_base(stdio
));
3831 stdio
->has_signal
= true;
3832 stdio
->signal
= qemu_opt_get_bool(opts
, "signal", true);
3835 static void char_stdio_class_init(ObjectClass
*oc
, void *data
)
3837 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3839 cc
->kind
= CHARDEV_BACKEND_KIND_STDIO
;
3840 cc
->parse
= qemu_chr_parse_stdio
;
3841 cc
->open
= qemu_chr_open_stdio
;
3843 cc
->chr_write
= win_stdio_write
;
3844 cc
->chr_set_echo
= qemu_chr_set_echo_win_stdio
;
3846 cc
->chr_set_echo
= qemu_chr_set_echo_stdio
;
3850 static const TypeInfo char_stdio_type_info
= {
3851 .name
= TYPE_CHARDEV_STDIO
,
3853 .parent
= TYPE_CHARDEV_WIN_STDIO
,
3855 .parent
= TYPE_CHARDEV_FD
,
3856 .instance_finalize
= char_stdio_finalize
,
3858 .class_init
= char_stdio_class_init
,
3861 #ifdef HAVE_CHARDEV_SERIAL
3862 static void qemu_chr_parse_serial(QemuOpts
*opts
, ChardevBackend
*backend
,
3865 const char *device
= qemu_opt_get(opts
, "path");
3866 ChardevHostdev
*serial
;
3868 if (device
== NULL
) {
3869 error_setg(errp
, "chardev: serial/tty: no device path given");
3872 serial
= backend
->u
.serial
.data
= g_new0(ChardevHostdev
, 1);
3873 qemu_chr_parse_common(opts
, qapi_ChardevHostdev_base(serial
));
3874 serial
->device
= g_strdup(device
);
3878 #ifdef HAVE_CHARDEV_PARPORT
3879 static void qemu_chr_parse_parallel(QemuOpts
*opts
, ChardevBackend
*backend
,
3882 const char *device
= qemu_opt_get(opts
, "path");
3883 ChardevHostdev
*parallel
;
3885 if (device
== NULL
) {
3886 error_setg(errp
, "chardev: parallel: no device path given");
3889 parallel
= backend
->u
.parallel
.data
= g_new0(ChardevHostdev
, 1);
3890 qemu_chr_parse_common(opts
, qapi_ChardevHostdev_base(parallel
));
3891 parallel
->device
= g_strdup(device
);
3895 static void qemu_chr_parse_pipe(QemuOpts
*opts
, ChardevBackend
*backend
,
3898 const char *device
= qemu_opt_get(opts
, "path");
3899 ChardevHostdev
*dev
;
3901 if (device
== NULL
) {
3902 error_setg(errp
, "chardev: pipe: no device path given");
3905 dev
= backend
->u
.pipe
.data
= g_new0(ChardevHostdev
, 1);
3906 qemu_chr_parse_common(opts
, qapi_ChardevHostdev_base(dev
));
3907 dev
->device
= g_strdup(device
);
3910 static void char_pipe_class_init(ObjectClass
*oc
, void *data
)
3912 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3914 cc
->kind
= CHARDEV_BACKEND_KIND_PIPE
;
3915 cc
->parse
= qemu_chr_parse_pipe
;
3916 cc
->open
= qemu_chr_open_pipe
;
3919 static const TypeInfo char_pipe_type_info
= {
3920 .name
= TYPE_CHARDEV_PIPE
,
3922 .parent
= TYPE_CHARDEV_WIN
,
3924 .parent
= TYPE_CHARDEV_FD
,
3926 .class_init
= char_pipe_class_init
,
3929 static void qemu_chr_parse_ringbuf(QemuOpts
*opts
, ChardevBackend
*backend
,
3933 ChardevRingbuf
*ringbuf
;
3935 ringbuf
= backend
->u
.ringbuf
.data
= g_new0(ChardevRingbuf
, 1);
3936 qemu_chr_parse_common(opts
, qapi_ChardevRingbuf_base(ringbuf
));
3938 val
= qemu_opt_get_size(opts
, "size", 0);
3940 ringbuf
->has_size
= true;
3941 ringbuf
->size
= val
;
3945 static void char_ringbuf_class_init(ObjectClass
*oc
, void *data
)
3947 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3949 cc
->kind
= CHARDEV_BACKEND_KIND_RINGBUF
;
3950 cc
->parse
= qemu_chr_parse_ringbuf
;
3951 cc
->open
= qemu_chr_open_ringbuf
;
3952 cc
->chr_write
= ringbuf_chr_write
;
3955 static const TypeInfo char_ringbuf_type_info
= {
3956 .name
= TYPE_CHARDEV_RINGBUF
,
3957 .parent
= TYPE_CHARDEV
,
3958 .class_init
= char_ringbuf_class_init
,
3959 .instance_size
= sizeof(RingBufChardev
),
3960 .instance_finalize
= char_ringbuf_finalize
,
3963 /* Bug-compatibility: */
3964 static void char_memory_class_init(ObjectClass
*oc
, void *data
)
3966 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3968 cc
->kind
= CHARDEV_BACKEND_KIND_MEMORY
;
3971 static const TypeInfo char_memory_type_info
= {
3972 .name
= TYPE_CHARDEV_MEMORY
,
3973 .parent
= TYPE_CHARDEV_RINGBUF
,
3974 .class_init
= char_memory_class_init
,
3977 static void qemu_chr_parse_mux(QemuOpts
*opts
, ChardevBackend
*backend
,
3980 const char *chardev
= qemu_opt_get(opts
, "chardev");
3983 if (chardev
== NULL
) {
3984 error_setg(errp
, "chardev: mux: no chardev given");
3987 mux
= backend
->u
.mux
.data
= g_new0(ChardevMux
, 1);
3988 qemu_chr_parse_common(opts
, qapi_ChardevMux_base(mux
));
3989 mux
->chardev
= g_strdup(chardev
);
3992 static void char_mux_class_init(ObjectClass
*oc
, void *data
)
3994 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3996 cc
->kind
= CHARDEV_BACKEND_KIND_MUX
;
3997 cc
->parse
= qemu_chr_parse_mux
;
3998 cc
->open
= qemu_chr_open_mux
;
3999 cc
->chr_write
= mux_chr_write
;
4000 cc
->chr_accept_input
= mux_chr_accept_input
;
4001 cc
->chr_add_watch
= mux_chr_add_watch
;
4004 static const TypeInfo char_mux_type_info
= {
4005 .name
= TYPE_CHARDEV_MUX
,
4006 .parent
= TYPE_CHARDEV
,
4007 .class_init
= char_mux_class_init
,
4008 .instance_size
= sizeof(MuxChardev
),
4009 .instance_finalize
= char_mux_finalize
,
4012 static void qemu_chr_parse_socket(QemuOpts
*opts
, ChardevBackend
*backend
,
4015 bool is_listen
= qemu_opt_get_bool(opts
, "server", false);
4016 bool is_waitconnect
= is_listen
&& qemu_opt_get_bool(opts
, "wait", true);
4017 bool is_telnet
= qemu_opt_get_bool(opts
, "telnet", false);
4018 bool do_nodelay
= !qemu_opt_get_bool(opts
, "delay", true);
4019 int64_t reconnect
= qemu_opt_get_number(opts
, "reconnect", 0);
4020 const char *path
= qemu_opt_get(opts
, "path");
4021 const char *host
= qemu_opt_get(opts
, "host");
4022 const char *port
= qemu_opt_get(opts
, "port");
4023 const char *tls_creds
= qemu_opt_get(opts
, "tls-creds");
4024 SocketAddress
*addr
;
4025 ChardevSocket
*sock
;
4029 error_setg(errp
, "chardev: socket: no host given");
4033 error_setg(errp
, "chardev: socket: no port given");
4038 error_setg(errp
, "TLS can only be used over TCP socket");
4043 sock
= backend
->u
.socket
.data
= g_new0(ChardevSocket
, 1);
4044 qemu_chr_parse_common(opts
, qapi_ChardevSocket_base(sock
));
4046 sock
->has_nodelay
= true;
4047 sock
->nodelay
= do_nodelay
;
4048 sock
->has_server
= true;
4049 sock
->server
= is_listen
;
4050 sock
->has_telnet
= true;
4051 sock
->telnet
= is_telnet
;
4052 sock
->has_wait
= true;
4053 sock
->wait
= is_waitconnect
;
4054 sock
->has_reconnect
= true;
4055 sock
->reconnect
= reconnect
;
4056 sock
->tls_creds
= g_strdup(tls_creds
);
4058 addr
= g_new0(SocketAddress
, 1);
4060 UnixSocketAddress
*q_unix
;
4061 addr
->type
= SOCKET_ADDRESS_KIND_UNIX
;
4062 q_unix
= addr
->u
.q_unix
.data
= g_new0(UnixSocketAddress
, 1);
4063 q_unix
->path
= g_strdup(path
);
4065 addr
->type
= SOCKET_ADDRESS_KIND_INET
;
4066 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
4067 *addr
->u
.inet
.data
= (InetSocketAddress
) {
4068 .host
= g_strdup(host
),
4069 .port
= g_strdup(port
),
4070 .has_to
= qemu_opt_get(opts
, "to"),
4071 .to
= qemu_opt_get_number(opts
, "to", 0),
4072 .has_ipv4
= qemu_opt_get(opts
, "ipv4"),
4073 .ipv4
= qemu_opt_get_bool(opts
, "ipv4", 0),
4074 .has_ipv6
= qemu_opt_get(opts
, "ipv6"),
4075 .ipv6
= qemu_opt_get_bool(opts
, "ipv6", 0),
4081 static void qemu_chr_parse_udp(QemuOpts
*opts
, ChardevBackend
*backend
,
4084 const char *host
= qemu_opt_get(opts
, "host");
4085 const char *port
= qemu_opt_get(opts
, "port");
4086 const char *localaddr
= qemu_opt_get(opts
, "localaddr");
4087 const char *localport
= qemu_opt_get(opts
, "localport");
4088 bool has_local
= false;
4089 SocketAddress
*addr
;
4092 if (host
== NULL
|| strlen(host
) == 0) {
4095 if (port
== NULL
|| strlen(port
) == 0) {
4096 error_setg(errp
, "chardev: udp: remote port not specified");
4099 if (localport
== NULL
|| strlen(localport
) == 0) {
4104 if (localaddr
== NULL
|| strlen(localaddr
) == 0) {
4110 udp
= backend
->u
.udp
.data
= g_new0(ChardevUdp
, 1);
4111 qemu_chr_parse_common(opts
, qapi_ChardevUdp_base(udp
));
4113 addr
= g_new0(SocketAddress
, 1);
4114 addr
->type
= SOCKET_ADDRESS_KIND_INET
;
4115 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
4116 *addr
->u
.inet
.data
= (InetSocketAddress
) {
4117 .host
= g_strdup(host
),
4118 .port
= g_strdup(port
),
4119 .has_ipv4
= qemu_opt_get(opts
, "ipv4"),
4120 .ipv4
= qemu_opt_get_bool(opts
, "ipv4", 0),
4121 .has_ipv6
= qemu_opt_get(opts
, "ipv6"),
4122 .ipv6
= qemu_opt_get_bool(opts
, "ipv6", 0),
4127 udp
->has_local
= true;
4128 addr
= g_new0(SocketAddress
, 1);
4129 addr
->type
= SOCKET_ADDRESS_KIND_INET
;
4130 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
4131 *addr
->u
.inet
.data
= (InetSocketAddress
) {
4132 .host
= g_strdup(localaddr
),
4133 .port
= g_strdup(localport
),
4139 static const ChardevClass
*char_get_class(const char *driver
, Error
**errp
)
4142 const ChardevClass
*cc
;
4143 char *typename
= g_strdup_printf("chardev-%s", driver
);
4145 oc
= object_class_by_name(typename
);
4148 if (!object_class_dynamic_cast(oc
, TYPE_CHARDEV
)) {
4149 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
4153 if (object_class_is_abstract(oc
)) {
4154 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
4155 "abstract device type");
4159 cc
= CHARDEV_CLASS(oc
);
4161 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
4168 static const struct ChardevAlias
{
4169 const char *typename
;
4171 } chardev_alias_table
[] = {
4172 #ifdef HAVE_CHARDEV_PARPORT
4173 { "parallel", "parport" },
4175 #ifdef HAVE_CHARDEV_SERIAL
4176 { "serial", "tty" },
4180 typedef struct ChadevClassFE
{
4181 void (*fn
)(const char *name
, void *opaque
);
4186 chardev_class_foreach(ObjectClass
*klass
, void *opaque
)
4188 ChadevClassFE
*fe
= opaque
;
4190 assert(g_str_has_prefix(object_class_get_name(klass
), "chardev-"));
4191 if (CHARDEV_CLASS(klass
)->internal
) {
4195 fe
->fn(object_class_get_name(klass
) + 8, fe
->opaque
);
4199 chardev_name_foreach(void (*fn
)(const char *name
, void *opaque
), void *opaque
)
4201 ChadevClassFE fe
= { .fn
= fn
, .opaque
= opaque
};
4204 object_class_foreach(chardev_class_foreach
, TYPE_CHARDEV
, false, &fe
);
4206 for (i
= 0; i
< ARRAY_SIZE(chardev_alias_table
); i
++) {
4207 fn(chardev_alias_table
[i
].alias
, opaque
);
4212 help_string_append(const char *name
, void *opaque
)
4214 GString
*str
= opaque
;
4216 g_string_append_printf(str
, "\n%s", name
);
4219 Chardev
*qemu_chr_new_from_opts(QemuOpts
*opts
,
4222 Error
*local_err
= NULL
;
4223 const ChardevClass
*cc
;
4226 ChardevReturn
*ret
= NULL
;
4227 ChardevBackend
*backend
;
4228 const char *name
= qemu_opt_get(opts
, "backend");
4229 const char *id
= qemu_opts_id(opts
);
4233 error_setg(errp
, "chardev: \"%s\" missing backend",
4234 qemu_opts_id(opts
));
4238 if (is_help_option(name
)) {
4239 GString
*str
= g_string_new("");
4241 chardev_name_foreach(help_string_append
, str
);
4243 error_report("Available chardev backend types: %s", str
->str
);
4244 g_string_free(str
, true);
4249 error_setg(errp
, "chardev: no id specified");
4253 for (i
= 0; i
< ARRAY_SIZE(chardev_alias_table
); i
++) {
4254 if (g_strcmp0(chardev_alias_table
[i
].alias
, name
) == 0) {
4255 name
= chardev_alias_table
[i
].typename
;
4260 cc
= char_get_class(name
, errp
);
4265 backend
= g_new0(ChardevBackend
, 1);
4267 if (qemu_opt_get_bool(opts
, "mux", 0)) {
4268 bid
= g_strdup_printf("%s-base", id
);
4272 backend
->type
= cc
->kind
;
4274 cc
->parse(opts
, backend
, &local_err
);
4276 error_propagate(errp
, local_err
);
4280 ChardevCommon
*ccom
= g_new0(ChardevCommon
, 1);
4281 qemu_chr_parse_common(opts
, ccom
);
4282 backend
->u
.null
.data
= ccom
; /* Any ChardevCommon member would work */
4285 ret
= qmp_chardev_add(bid
? bid
: id
, backend
, errp
);
4291 qapi_free_ChardevBackend(backend
);
4292 qapi_free_ChardevReturn(ret
);
4293 backend
= g_new0(ChardevBackend
, 1);
4294 backend
->u
.mux
.data
= g_new0(ChardevMux
, 1);
4295 backend
->type
= CHARDEV_BACKEND_KIND_MUX
;
4296 backend
->u
.mux
.data
->chardev
= g_strdup(bid
);
4297 ret
= qmp_chardev_add(id
, backend
, errp
);
4299 chr
= qemu_chr_find(bid
);
4300 qemu_chr_delete(chr
);
4306 chr
= qemu_chr_find(id
);
4309 qapi_free_ChardevBackend(backend
);
4310 qapi_free_ChardevReturn(ret
);
4318 Chardev
*qemu_chr_new_noreplay(const char *label
, const char *filename
)
4325 if (strstart(filename
, "chardev:", &p
)) {
4326 return qemu_chr_find(p
);
4329 opts
= qemu_chr_parse_compat(label
, filename
);
4333 chr
= qemu_chr_new_from_opts(opts
, &err
);
4335 error_report_err(err
);
4337 if (chr
&& qemu_opt_get_bool(opts
, "mux", 0)) {
4338 monitor_init(chr
, MONITOR_USE_READLINE
);
4340 qemu_opts_del(opts
);
4344 Chardev
*qemu_chr_new(const char *label
, const char *filename
)
4347 chr
= qemu_chr_new_noreplay(label
, filename
);
4349 if (replay_mode
!= REPLAY_MODE_NONE
) {
4350 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_REPLAY
);
4352 if (qemu_chr_replay(chr
) && CHARDEV_GET_CLASS(chr
)->chr_ioctl
) {
4353 error_report("Replay: ioctl is not supported "
4354 "for serial devices yet");
4356 replay_register_char_driver(chr
);
4361 void qemu_chr_fe_set_echo(CharBackend
*be
, bool echo
)
4363 Chardev
*chr
= be
->chr
;
4365 if (chr
&& CHARDEV_GET_CLASS(chr
)->chr_set_echo
) {
4366 CHARDEV_GET_CLASS(chr
)->chr_set_echo(chr
, echo
);
4370 void qemu_chr_fe_set_open(CharBackend
*be
, int fe_open
)
4372 Chardev
*chr
= be
->chr
;
4378 if (be
->fe_open
== fe_open
) {
4381 be
->fe_open
= fe_open
;
4382 if (CHARDEV_GET_CLASS(chr
)->chr_set_fe_open
) {
4383 CHARDEV_GET_CLASS(chr
)->chr_set_fe_open(chr
, fe_open
);
4387 guint
qemu_chr_fe_add_watch(CharBackend
*be
, GIOCondition cond
,
4388 GIOFunc func
, void *user_data
)
4390 Chardev
*s
= be
->chr
;
4394 if (!s
|| CHARDEV_GET_CLASS(s
)->chr_add_watch
== NULL
) {
4398 src
= CHARDEV_GET_CLASS(s
)->chr_add_watch(s
, cond
);
4403 g_source_set_callback(src
, (GSourceFunc
)func
, user_data
, NULL
);
4404 tag
= g_source_attach(src
, NULL
);
4405 g_source_unref(src
);
4410 void qemu_chr_fe_disconnect(CharBackend
*be
)
4412 Chardev
*chr
= be
->chr
;
4414 if (chr
&& CHARDEV_GET_CLASS(chr
)->chr_disconnect
) {
4415 CHARDEV_GET_CLASS(chr
)->chr_disconnect(chr
);
4419 void qemu_chr_delete(Chardev
*chr
)
4421 QTAILQ_REMOVE(&chardevs
, chr
, next
);
4422 object_unref(OBJECT(chr
));
4425 ChardevInfoList
*qmp_query_chardev(Error
**errp
)
4427 ChardevInfoList
*chr_list
= NULL
;
4430 QTAILQ_FOREACH(chr
, &chardevs
, next
) {
4431 ChardevInfoList
*info
= g_malloc0(sizeof(*info
));
4432 info
->value
= g_malloc0(sizeof(*info
->value
));
4433 info
->value
->label
= g_strdup(chr
->label
);
4434 info
->value
->filename
= g_strdup(chr
->filename
);
4435 info
->value
->frontend_open
= chr
->be
&& chr
->be
->fe_open
;
4437 info
->next
= chr_list
;
4445 qmp_prepend_backend(const char *name
, void *opaque
)
4447 ChardevBackendInfoList
**list
= opaque
;
4448 ChardevBackendInfoList
*info
= g_malloc0(sizeof(*info
));
4450 info
->value
= g_malloc0(sizeof(*info
->value
));
4451 info
->value
->name
= g_strdup(name
);
4456 ChardevBackendInfoList
*qmp_query_chardev_backends(Error
**errp
)
4458 ChardevBackendInfoList
*backend_list
= NULL
;
4460 chardev_name_foreach(qmp_prepend_backend
, &backend_list
);
4462 return backend_list
;
4465 Chardev
*qemu_chr_find(const char *name
)
4469 QTAILQ_FOREACH(chr
, &chardevs
, next
) {
4470 if (strcmp(chr
->label
, name
) != 0)
4477 QemuOptsList qemu_chardev_opts
= {
4479 .implied_opt_name
= "backend",
4480 .head
= QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts
.head
),
4484 .type
= QEMU_OPT_STRING
,
4487 .type
= QEMU_OPT_STRING
,
4490 .type
= QEMU_OPT_STRING
,
4493 .type
= QEMU_OPT_STRING
,
4495 .name
= "localaddr",
4496 .type
= QEMU_OPT_STRING
,
4498 .name
= "localport",
4499 .type
= QEMU_OPT_STRING
,
4502 .type
= QEMU_OPT_NUMBER
,
4505 .type
= QEMU_OPT_BOOL
,
4508 .type
= QEMU_OPT_BOOL
,
4511 .type
= QEMU_OPT_BOOL
,
4514 .type
= QEMU_OPT_BOOL
,
4517 .type
= QEMU_OPT_BOOL
,
4519 .name
= "reconnect",
4520 .type
= QEMU_OPT_NUMBER
,
4523 .type
= QEMU_OPT_BOOL
,
4525 .name
= "tls-creds",
4526 .type
= QEMU_OPT_STRING
,
4529 .type
= QEMU_OPT_NUMBER
,
4532 .type
= QEMU_OPT_NUMBER
,
4535 .type
= QEMU_OPT_NUMBER
,
4538 .type
= QEMU_OPT_NUMBER
,
4541 .type
= QEMU_OPT_BOOL
,
4544 .type
= QEMU_OPT_BOOL
,
4547 .type
= QEMU_OPT_STRING
,
4550 .type
= QEMU_OPT_NUMBER
,
4553 .type
= QEMU_OPT_SIZE
,
4556 .type
= QEMU_OPT_STRING
,
4559 .type
= QEMU_OPT_BOOL
,
4562 .type
= QEMU_OPT_STRING
,
4564 .name
= "logappend",
4565 .type
= QEMU_OPT_BOOL
,
4567 { /* end of list */ }
4573 static void qmp_chardev_open_file(Chardev
*chr
,
4574 ChardevBackend
*backend
,
4578 ChardevFile
*file
= backend
->u
.file
.data
;
4584 error_setg(errp
, "input file not supported");
4588 if (file
->has_append
&& file
->append
) {
4589 /* Append to file if it already exists. */
4590 accessmode
= FILE_GENERIC_WRITE
& ~FILE_WRITE_DATA
;
4591 flags
= OPEN_ALWAYS
;
4593 /* Truncate file if it already exists. */
4594 accessmode
= GENERIC_WRITE
;
4595 flags
= CREATE_ALWAYS
;
4598 out
= CreateFile(file
->out
, accessmode
, FILE_SHARE_READ
, NULL
, flags
,
4599 FILE_ATTRIBUTE_NORMAL
, NULL
);
4600 if (out
== INVALID_HANDLE_VALUE
) {
4601 error_setg(errp
, "open %s failed", file
->out
);
4605 qemu_chr_open_win_file(chr
, out
);
4608 static void qmp_chardev_open_serial(Chardev
*chr
,
4609 ChardevBackend
*backend
,
4613 ChardevHostdev
*serial
= backend
->u
.serial
.data
;
4615 win_chr_init(chr
, serial
->device
, errp
);
4620 static int qmp_chardev_open_file_source(char *src
, int flags
,
4625 TFR(fd
= qemu_open(src
, flags
, 0666));
4627 error_setg_file_open(errp
, errno
, src
);
4632 static void qmp_chardev_open_file(Chardev
*chr
,
4633 ChardevBackend
*backend
,
4637 ChardevFile
*file
= backend
->u
.file
.data
;
4638 int flags
, in
= -1, out
;
4640 flags
= O_WRONLY
| O_CREAT
| O_BINARY
;
4641 if (file
->has_append
&& file
->append
) {
4647 out
= qmp_chardev_open_file_source(file
->out
, flags
, errp
);
4654 in
= qmp_chardev_open_file_source(file
->in
, flags
, errp
);
4661 qemu_chr_open_fd(chr
, in
, out
);
4664 #ifdef HAVE_CHARDEV_SERIAL
4665 static void qmp_chardev_open_serial(Chardev
*chr
,
4666 ChardevBackend
*backend
,
4670 ChardevHostdev
*serial
= backend
->u
.serial
.data
;
4673 fd
= qmp_chardev_open_file_source(serial
->device
, O_RDWR
, errp
);
4677 qemu_set_nonblock(fd
);
4678 tty_serial_init(fd
, 115200, 'N', 8, 1);
4680 qemu_chr_open_fd(chr
, fd
, fd
);
4684 #ifdef HAVE_CHARDEV_PARPORT
4685 static void qmp_chardev_open_parallel(Chardev
*chr
,
4686 ChardevBackend
*backend
,
4690 ChardevHostdev
*parallel
= backend
->u
.parallel
.data
;
4693 fd
= qmp_chardev_open_file_source(parallel
->device
, O_RDWR
, errp
);
4697 qemu_chr_open_pp_fd(chr
, fd
, be_opened
, errp
);
4700 static void char_parallel_class_init(ObjectClass
*oc
, void *data
)
4702 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4704 cc
->kind
= CHARDEV_BACKEND_KIND_PARALLEL
;
4705 cc
->parse
= qemu_chr_parse_parallel
;
4706 cc
->open
= qmp_chardev_open_parallel
;
4707 #if defined(__linux__)
4708 cc
->chr_write
= null_chr_write
;
4709 cc
->chr_ioctl
= pp_ioctl
;
4710 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4711 cc
->chr_write
= null_chr_write
;
4712 cc
->chr_ioctl
= pp_ioctl
;
4716 static void char_parallel_finalize(Object
*obj
)
4718 #if defined(__linux__)
4719 Chardev
*chr
= CHARDEV(obj
);
4720 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
4723 pp_hw_mode(drv
, IEEE1284_MODE_COMPAT
);
4724 ioctl(fd
, PPRELEASE
);
4726 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
4727 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4728 /* FIXME: close fd? */
4732 static const TypeInfo char_parallel_type_info
= {
4733 .name
= TYPE_CHARDEV_PARALLEL
,
4734 .parent
= TYPE_CHARDEV
,
4735 .instance_size
= sizeof(ParallelChardev
),
4736 .instance_finalize
= char_parallel_finalize
,
4737 .class_init
= char_parallel_class_init
,
4743 static void char_file_class_init(ObjectClass
*oc
, void *data
)
4745 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4747 cc
->kind
= CHARDEV_BACKEND_KIND_FILE
;
4748 cc
->parse
= qemu_chr_parse_file_out
;
4749 cc
->open
= qmp_chardev_open_file
;
4752 static const TypeInfo char_file_type_info
= {
4753 .name
= TYPE_CHARDEV_FILE
,
4755 .parent
= TYPE_CHARDEV_WIN
,
4757 .parent
= TYPE_CHARDEV_FD
,
4759 .class_init
= char_file_class_init
,
4762 #ifdef HAVE_CHARDEV_SERIAL
4764 static void char_serial_class_init(ObjectClass
*oc
, void *data
)
4766 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4768 cc
->kind
= CHARDEV_BACKEND_KIND_SERIAL
;
4769 cc
->parse
= qemu_chr_parse_serial
;
4770 cc
->open
= qmp_chardev_open_serial
;
4772 cc
->chr_ioctl
= tty_serial_ioctl
;
4776 static const TypeInfo char_serial_type_info
= {
4777 .name
= TYPE_CHARDEV_SERIAL
,
4779 .parent
= TYPE_CHARDEV_WIN
,
4781 .parent
= TYPE_CHARDEV_FD
,
4783 .class_init
= char_serial_class_init
,
4787 static gboolean
socket_reconnect_timeout(gpointer opaque
)
4789 Chardev
*chr
= CHARDEV(opaque
);
4790 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
4791 QIOChannelSocket
*sioc
;
4793 s
->reconnect_timer
= 0;
4799 sioc
= qio_channel_socket_new();
4800 tcp_chr_set_client_ioc_name(chr
, sioc
);
4801 qio_channel_socket_connect_async(sioc
, s
->addr
,
4802 qemu_chr_socket_connected
,
4808 static void qmp_chardev_open_socket(Chardev
*chr
,
4809 ChardevBackend
*backend
,
4813 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
4814 ChardevSocket
*sock
= backend
->u
.socket
.data
;
4815 SocketAddress
*addr
= sock
->addr
;
4816 bool do_nodelay
= sock
->has_nodelay
? sock
->nodelay
: false;
4817 bool is_listen
= sock
->has_server
? sock
->server
: true;
4818 bool is_telnet
= sock
->has_telnet
? sock
->telnet
: false;
4819 bool is_waitconnect
= sock
->has_wait
? sock
->wait
: false;
4820 int64_t reconnect
= sock
->has_reconnect
? sock
->reconnect
: 0;
4821 QIOChannelSocket
*sioc
= NULL
;
4823 s
->is_unix
= addr
->type
== SOCKET_ADDRESS_KIND_UNIX
;
4824 s
->is_listen
= is_listen
;
4825 s
->is_telnet
= is_telnet
;
4826 s
->do_nodelay
= do_nodelay
;
4827 if (sock
->tls_creds
) {
4829 creds
= object_resolve_path_component(
4830 object_get_objects_root(), sock
->tls_creds
);
4832 error_setg(errp
, "No TLS credentials with id '%s'",
4836 s
->tls_creds
= (QCryptoTLSCreds
*)
4837 object_dynamic_cast(creds
,
4838 TYPE_QCRYPTO_TLS_CREDS
);
4839 if (!s
->tls_creds
) {
4840 error_setg(errp
, "Object with id '%s' is not TLS credentials",
4844 object_ref(OBJECT(s
->tls_creds
));
4846 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
4847 error_setg(errp
, "%s",
4848 "Expected TLS credentials for server endpoint");
4852 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT
) {
4853 error_setg(errp
, "%s",
4854 "Expected TLS credentials for client endpoint");
4860 s
->addr
= QAPI_CLONE(SocketAddress
, sock
->addr
);
4862 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_RECONNECTABLE
);
4864 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_FD_PASS
);
4867 /* be isn't opened until we get a connection */
4870 chr
->filename
= SocketAddress_to_str("disconnected:",
4871 addr
, is_listen
, is_telnet
);
4875 s
->do_telnetopt
= 1;
4877 } else if (reconnect
> 0) {
4878 s
->reconnect_time
= reconnect
;
4881 if (s
->reconnect_time
) {
4882 sioc
= qio_channel_socket_new();
4883 tcp_chr_set_client_ioc_name(chr
, sioc
);
4884 qio_channel_socket_connect_async(sioc
, s
->addr
,
4885 qemu_chr_socket_connected
,
4890 sioc
= qio_channel_socket_new();
4892 name
= g_strdup_printf("chardev-tcp-listener-%s", chr
->label
);
4893 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
4896 if (qio_channel_socket_listen_sync(sioc
, s
->addr
, errp
) < 0) {
4899 s
->listen_ioc
= sioc
;
4900 if (is_waitconnect
&&
4901 qemu_chr_wait_connected(chr
, errp
) < 0) {
4905 s
->listen_tag
= qio_channel_add_watch(
4906 QIO_CHANNEL(s
->listen_ioc
), G_IO_IN
,
4907 tcp_chr_accept
, chr
, NULL
);
4909 } else if (qemu_chr_wait_connected(chr
, errp
) < 0) {
4918 object_unref(OBJECT(sioc
));
4922 static void char_socket_class_init(ObjectClass
*oc
, void *data
)
4924 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4926 cc
->kind
= CHARDEV_BACKEND_KIND_SOCKET
;
4927 cc
->parse
= qemu_chr_parse_socket
;
4928 cc
->open
= qmp_chardev_open_socket
;
4929 cc
->chr_wait_connected
= tcp_chr_wait_connected
;
4930 cc
->chr_write
= tcp_chr_write
;
4931 cc
->chr_sync_read
= tcp_chr_sync_read
;
4932 cc
->chr_disconnect
= tcp_chr_disconnect
;
4933 cc
->get_msgfds
= tcp_get_msgfds
;
4934 cc
->set_msgfds
= tcp_set_msgfds
;
4935 cc
->chr_add_client
= tcp_chr_add_client
;
4936 cc
->chr_add_watch
= tcp_chr_add_watch
;
4937 cc
->chr_update_read_handler
= tcp_chr_update_read_handler
;
4940 static const TypeInfo char_socket_type_info
= {
4941 .name
= TYPE_CHARDEV_SOCKET
,
4942 .parent
= TYPE_CHARDEV
,
4943 .instance_size
= sizeof(SocketChardev
),
4944 .instance_finalize
= char_socket_finalize
,
4945 .class_init
= char_socket_class_init
,
4948 static void qmp_chardev_open_udp(Chardev
*chr
,
4949 ChardevBackend
*backend
,
4953 ChardevUdp
*udp
= backend
->u
.udp
.data
;
4954 QIOChannelSocket
*sioc
= qio_channel_socket_new();
4956 UdpChardev
*s
= UDP_CHARDEV(chr
);
4958 if (qio_channel_socket_dgram_sync(sioc
,
4959 udp
->local
, udp
->remote
,
4961 object_unref(OBJECT(sioc
));
4965 name
= g_strdup_printf("chardev-udp-%s", chr
->label
);
4966 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
4969 s
->ioc
= QIO_CHANNEL(sioc
);
4970 /* be isn't opened until we get a connection */
4974 static void char_udp_class_init(ObjectClass
*oc
, void *data
)
4976 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4978 cc
->kind
= CHARDEV_BACKEND_KIND_UDP
;
4979 cc
->parse
= qemu_chr_parse_udp
;
4980 cc
->open
= qmp_chardev_open_udp
;
4981 cc
->chr_write
= udp_chr_write
;
4982 cc
->chr_update_read_handler
= udp_chr_update_read_handler
;
4985 static const TypeInfo char_udp_type_info
= {
4986 .name
= TYPE_CHARDEV_UDP
,
4987 .parent
= TYPE_CHARDEV
,
4988 .instance_size
= sizeof(UdpChardev
),
4989 .instance_finalize
= char_udp_finalize
,
4990 .class_init
= char_udp_class_init
,
4993 bool qemu_chr_has_feature(Chardev
*chr
,
4994 CharDriverFeature feature
)
4996 return test_bit(feature
, chr
->features
);
4999 void qemu_chr_set_feature(Chardev
*chr
,
5000 CharDriverFeature feature
)
5002 return set_bit(feature
, chr
->features
);
5005 Chardev
*qemu_chardev_new(const char *id
, const char *typename
,
5006 ChardevBackend
*backend
, Error
**errp
)
5008 Chardev
*chr
= NULL
;
5009 Error
*local_err
= NULL
;
5010 bool be_opened
= true;
5012 assert(g_str_has_prefix(typename
, "chardev-"));
5014 chr
= CHARDEV(object_new(typename
));
5015 chr
->label
= g_strdup(id
);
5017 qemu_char_open(chr
, backend
, &be_opened
, &local_err
);
5019 error_propagate(errp
, local_err
);
5020 object_unref(OBJECT(chr
));
5024 if (!chr
->filename
) {
5025 chr
->filename
= g_strdup(typename
+ 8);
5028 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
5034 ChardevReturn
*qmp_chardev_add(const char *id
, ChardevBackend
*backend
,
5037 const ChardevClass
*cc
;
5041 chr
= qemu_chr_find(id
);
5043 error_setg(errp
, "Chardev '%s' already exists", id
);
5047 cc
= char_get_class(ChardevBackendKind_lookup
[backend
->type
], errp
);
5052 chr
= qemu_chardev_new(id
, object_class_get_name(OBJECT_CLASS(cc
)),
5058 ret
= g_new0(ChardevReturn
, 1);
5059 if (CHARDEV_IS_PTY(chr
)) {
5060 ret
->pty
= g_strdup(chr
->filename
+ 4);
5061 ret
->has_pty
= true;
5064 QTAILQ_INSERT_TAIL(&chardevs
, chr
, next
);
5068 void qmp_chardev_remove(const char *id
, Error
**errp
)
5072 chr
= qemu_chr_find(id
);
5074 error_setg(errp
, "Chardev '%s' not found", id
);
5077 if (qemu_chr_is_busy(chr
)) {
5078 error_setg(errp
, "Chardev '%s' is busy", id
);
5081 if (qemu_chr_replay(chr
)) {
5083 "Chardev '%s' cannot be unplugged in record/replay mode", id
);
5086 qemu_chr_delete(chr
);
5089 void qemu_chr_cleanup(void)
5093 QTAILQ_FOREACH_SAFE(chr
, &chardevs
, next
, tmp
) {
5094 qemu_chr_delete(chr
);
5098 static void register_types(void)
5100 type_register_static(&char_type_info
);
5102 type_register_static(&char_fd_type_info
);
5104 type_register_static(&char_win_type_info
);
5105 type_register_static(&char_win_stdio_type_info
);
5107 type_register_static(&char_null_type_info
);
5108 type_register_static(&char_socket_type_info
);
5109 type_register_static(&char_udp_type_info
);
5110 type_register_static(&char_ringbuf_type_info
);
5111 type_register_static(&char_file_type_info
);
5112 type_register_static(&char_stdio_type_info
);
5113 #ifdef HAVE_CHARDEV_SERIAL
5114 type_register_static(&char_serial_type_info
);
5116 #ifdef HAVE_CHARDEV_PARPORT
5117 type_register_static(&char_parallel_type_info
);
5119 #ifdef HAVE_CHARDEV_PTY
5120 type_register_static(&char_pty_type_info
);
5123 type_register_static(&char_console_type_info
);
5125 type_register_static(&char_pipe_type_info
);
5126 type_register_static(&char_mux_type_info
);
5127 type_register_static(&char_memory_type_info
);
5129 /* this must be done after machine init, since we register FEs with muxes
5130 * as part of realize functions like serial_isa_realizefn when -nographic
5133 qemu_add_machine_init_done_notifier(&muxes_realize_notify
);
5136 type_init(register_types
);