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
;
571 static const TypeInfo char_null_type_info
= {
572 .name
= TYPE_CHARDEV_NULL
,
573 .parent
= TYPE_CHARDEV
,
574 .instance_size
= sizeof(Chardev
),
575 .class_init
= char_null_class_init
,
578 /* MUX driver for serial I/O splitting */
580 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
581 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
584 CharBackend
*backends
[MAX_MUX
];
590 /* Intermediate input buffer allows to catch escape sequences even if the
591 currently active device is not accepting any input - but only until it
593 unsigned char buffer
[MAX_MUX
][MUX_BUFFER_SIZE
];
598 /* Protected by the Chardev chr_write_lock. */
600 int64_t timestamps_start
;
603 #define MUX_CHARDEV(obj) OBJECT_CHECK(MuxChardev, (obj), TYPE_CHARDEV_MUX)
605 /* Called with chr_write_lock held. */
606 static int mux_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
608 MuxChardev
*d
= MUX_CHARDEV(chr
);
610 if (!d
->timestamps
) {
611 ret
= qemu_chr_fe_write(&d
->chr
, buf
, len
);
616 for (i
= 0; i
< len
; i
++) {
622 ti
= qemu_clock_get_ms(QEMU_CLOCK_REALTIME
);
623 if (d
->timestamps_start
== -1)
624 d
->timestamps_start
= ti
;
625 ti
-= d
->timestamps_start
;
627 snprintf(buf1
, sizeof(buf1
),
628 "[%02d:%02d:%02d.%03d] ",
633 /* XXX this blocks entire thread. Rewrite to use
634 * qemu_chr_fe_write and background I/O callbacks */
635 qemu_chr_fe_write_all(&d
->chr
,
636 (uint8_t *)buf1
, strlen(buf1
));
639 ret
+= qemu_chr_fe_write(&d
->chr
, buf
+ i
, 1);
640 if (buf
[i
] == '\n') {
648 static const char * const mux_help
[] = {
649 "% h print this help\n\r",
650 "% x exit emulator\n\r",
651 "% s save disk data back to file (if -snapshot)\n\r",
652 "% t toggle console timestamps\n\r",
653 "% b send break (magic sysrq)\n\r",
654 "% c switch between console and monitor\n\r",
659 int term_escape_char
= 0x01; /* ctrl-a is used for escape */
660 static void mux_print_help(Chardev
*chr
)
663 char ebuf
[15] = "Escape-Char";
664 char cbuf
[50] = "\n\r";
666 if (term_escape_char
> 0 && term_escape_char
< 26) {
667 snprintf(cbuf
, sizeof(cbuf
), "\n\r");
668 snprintf(ebuf
, sizeof(ebuf
), "C-%c", term_escape_char
- 1 + 'a');
670 snprintf(cbuf
, sizeof(cbuf
),
671 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
674 /* XXX this blocks entire thread. Rewrite to use
675 * qemu_chr_fe_write and background I/O callbacks */
676 qemu_chr_write_all(chr
, (uint8_t *)cbuf
, strlen(cbuf
));
677 for (i
= 0; mux_help
[i
] != NULL
; i
++) {
678 for (j
=0; mux_help
[i
][j
] != '\0'; j
++) {
679 if (mux_help
[i
][j
] == '%')
680 qemu_chr_write_all(chr
, (uint8_t *)ebuf
, strlen(ebuf
));
682 qemu_chr_write_all(chr
, (uint8_t *)&mux_help
[i
][j
], 1);
687 static void mux_chr_send_event(MuxChardev
*d
, int mux_nr
, int event
)
689 CharBackend
*be
= d
->backends
[mux_nr
];
691 if (be
&& be
->chr_event
) {
692 be
->chr_event(be
->opaque
, event
);
696 static int mux_proc_byte(Chardev
*chr
, MuxChardev
*d
, int ch
)
698 if (d
->term_got_escape
) {
699 d
->term_got_escape
= 0;
700 if (ch
== term_escape_char
)
709 const char *term
= "QEMU: Terminated\n\r";
710 qemu_chr_write_all(chr
, (uint8_t *)term
, strlen(term
));
718 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
721 assert(d
->mux_cnt
> 0); /* handler registered with first fe */
722 /* Switch to the next registered device */
723 mux_set_focus(chr
, (d
->focus
+ 1) % d
->mux_cnt
);
726 d
->timestamps
= !d
->timestamps
;
727 d
->timestamps_start
= -1;
731 } else if (ch
== term_escape_char
) {
732 d
->term_got_escape
= 1;
740 static void mux_chr_accept_input(Chardev
*chr
)
742 MuxChardev
*d
= MUX_CHARDEV(chr
);
744 CharBackend
*be
= d
->backends
[m
];
746 while (be
&& d
->prod
[m
] != d
->cons
[m
] &&
747 be
->chr_can_read
&& be
->chr_can_read(be
->opaque
)) {
748 be
->chr_read(be
->opaque
,
749 &d
->buffer
[m
][d
->cons
[m
]++ & MUX_BUFFER_MASK
], 1);
753 static int mux_chr_can_read(void *opaque
)
755 MuxChardev
*d
= MUX_CHARDEV(opaque
);
757 CharBackend
*be
= d
->backends
[m
];
759 if ((d
->prod
[m
] - d
->cons
[m
]) < MUX_BUFFER_SIZE
) {
763 if (be
&& be
->chr_can_read
) {
764 return be
->chr_can_read(be
->opaque
);
770 static void mux_chr_read(void *opaque
, const uint8_t *buf
, int size
)
772 Chardev
*chr
= CHARDEV(opaque
);
773 MuxChardev
*d
= MUX_CHARDEV(opaque
);
775 CharBackend
*be
= d
->backends
[m
];
778 mux_chr_accept_input(opaque
);
780 for (i
= 0; i
< size
; i
++)
781 if (mux_proc_byte(chr
, d
, buf
[i
])) {
782 if (d
->prod
[m
] == d
->cons
[m
] &&
783 be
&& be
->chr_can_read
&&
784 be
->chr_can_read(be
->opaque
))
785 be
->chr_read(be
->opaque
, &buf
[i
], 1);
787 d
->buffer
[m
][d
->prod
[m
]++ & MUX_BUFFER_MASK
] = buf
[i
];
791 static bool muxes_realized
;
793 static void mux_chr_event(void *opaque
, int event
)
795 MuxChardev
*d
= MUX_CHARDEV(opaque
);
798 if (!muxes_realized
) {
802 /* Send the event to all registered listeners */
803 for (i
= 0; i
< d
->mux_cnt
; i
++)
804 mux_chr_send_event(d
, i
, event
);
808 * Called after processing of default and command-line-specified
809 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
810 * to a mux chardev. This is done here to ensure that
811 * output/prompts/banners are only displayed for the FE that has
812 * focus when initial command-line processing/machine init is
815 * After this point, any new FE attached to any new or existing
816 * mux will receive CHR_EVENT_OPENED notifications for the BE
819 static void muxes_realize_done(Notifier
*notifier
, void *unused
)
823 QTAILQ_FOREACH(chr
, &chardevs
, next
) {
824 if (CHARDEV_IS_MUX(chr
)) {
825 MuxChardev
*d
= MUX_CHARDEV(chr
);
828 /* send OPENED to all already-attached FEs */
829 for (i
= 0; i
< d
->mux_cnt
; i
++) {
830 mux_chr_send_event(d
, i
, CHR_EVENT_OPENED
);
832 /* mark mux as OPENED so any new FEs will immediately receive
835 qemu_chr_be_generic_open(chr
);
838 muxes_realized
= true;
841 static Notifier muxes_realize_notify
= {
842 .notify
= muxes_realize_done
,
845 static GSource
*mux_chr_add_watch(Chardev
*s
, GIOCondition cond
)
847 MuxChardev
*d
= MUX_CHARDEV(s
);
848 Chardev
*chr
= qemu_chr_fe_get_driver(&d
->chr
);
849 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
851 if (!cc
->chr_add_watch
) {
855 return cc
->chr_add_watch(chr
, cond
);
858 static void char_mux_finalize(Object
*obj
)
860 MuxChardev
*d
= MUX_CHARDEV(obj
);
863 for (i
= 0; i
< d
->mux_cnt
; i
++) {
864 CharBackend
*be
= d
->backends
[i
];
869 qemu_chr_fe_deinit(&d
->chr
);
872 static void mux_chr_set_handlers(Chardev
*chr
, GMainContext
*context
)
874 MuxChardev
*d
= MUX_CHARDEV(chr
);
876 /* Fix up the real driver with mux routines */
877 qemu_chr_fe_set_handlers(&d
->chr
,
885 static void mux_set_focus(Chardev
*chr
, int focus
)
887 MuxChardev
*d
= MUX_CHARDEV(chr
);
890 assert(focus
< d
->mux_cnt
);
892 if (d
->focus
!= -1) {
893 mux_chr_send_event(d
, d
->focus
, CHR_EVENT_MUX_OUT
);
897 chr
->be
= d
->backends
[focus
];
898 mux_chr_send_event(d
, d
->focus
, CHR_EVENT_MUX_IN
);
901 static void qemu_chr_open_mux(Chardev
*chr
,
902 ChardevBackend
*backend
,
906 ChardevMux
*mux
= backend
->u
.mux
.data
;
908 MuxChardev
*d
= MUX_CHARDEV(chr
);
910 drv
= qemu_chr_find(mux
->chardev
);
912 error_setg(errp
, "mux: base chardev %s not found", mux
->chardev
);
917 /* only default to opened state if we've realized the initial
920 *be_opened
= muxes_realized
;
921 qemu_chr_fe_init(&d
->chr
, drv
, errp
);
924 Chardev
*qemu_chr_fe_get_driver(CharBackend
*be
)
929 bool qemu_chr_fe_init(CharBackend
*b
, Chardev
*s
, Error
**errp
)
933 if (CHARDEV_IS_MUX(s
)) {
934 MuxChardev
*d
= MUX_CHARDEV(s
);
936 if (d
->mux_cnt
>= MAX_MUX
) {
940 d
->backends
[d
->mux_cnt
] = b
;
954 error_setg(errp
, QERR_DEVICE_IN_USE
, s
->label
);
958 static bool qemu_chr_is_busy(Chardev
*s
)
960 if (CHARDEV_IS_MUX(s
)) {
961 MuxChardev
*d
= MUX_CHARDEV(s
);
962 return d
->mux_cnt
>= 0;
964 return s
->be
!= NULL
;
968 void qemu_chr_fe_deinit(CharBackend
*b
)
973 qemu_chr_fe_set_handlers(b
, NULL
, NULL
, NULL
, NULL
, NULL
, true);
974 if (b
->chr
->be
== b
) {
977 if (CHARDEV_IS_MUX(b
->chr
)) {
978 MuxChardev
*d
= MUX_CHARDEV(b
->chr
);
979 d
->backends
[b
->tag
] = NULL
;
985 void qemu_chr_fe_set_handlers(CharBackend
*b
,
986 IOCanReadHandler
*fd_can_read
,
987 IOReadHandler
*fd_read
,
988 IOEventHandler
*fd_event
,
990 GMainContext
*context
,
1002 cc
= CHARDEV_GET_CLASS(s
);
1003 if (!opaque
&& !fd_can_read
&& !fd_read
&& !fd_event
) {
1005 remove_fd_in_watch(s
);
1009 b
->chr_can_read
= fd_can_read
;
1010 b
->chr_read
= fd_read
;
1011 b
->chr_event
= fd_event
;
1013 if (cc
->chr_update_read_handler
) {
1014 cc
->chr_update_read_handler(s
, context
);
1018 qemu_chr_fe_set_open(b
, fe_open
);
1022 qemu_chr_fe_take_focus(b
);
1023 /* We're connecting to an already opened device, so let's make sure we
1024 also get the open event */
1026 qemu_chr_be_generic_open(s
);
1030 if (CHARDEV_IS_MUX(s
)) {
1031 mux_chr_set_handlers(s
, context
);
1035 void qemu_chr_fe_take_focus(CharBackend
*b
)
1041 if (CHARDEV_IS_MUX(b
->chr
)) {
1042 mux_set_focus(b
->chr
, b
->tag
);
1046 typedef struct IOWatchPoll
1053 IOCanReadHandler
*fd_can_read
;
1054 GSourceFunc fd_read
;
1056 GMainContext
*context
;
1059 static IOWatchPoll
*io_watch_poll_from_source(GSource
*source
)
1061 return container_of(source
, IOWatchPoll
, parent
);
1064 static gboolean
io_watch_poll_prepare(GSource
*source
,
1067 IOWatchPoll
*iwp
= io_watch_poll_from_source(source
);
1068 bool now_active
= iwp
->fd_can_read(iwp
->opaque
) > 0;
1069 bool was_active
= iwp
->src
!= NULL
;
1070 if (was_active
== now_active
) {
1075 iwp
->src
= qio_channel_create_watch(
1076 iwp
->ioc
, G_IO_IN
| G_IO_ERR
| G_IO_HUP
| G_IO_NVAL
);
1077 g_source_set_callback(iwp
->src
, iwp
->fd_read
, iwp
->opaque
, NULL
);
1078 g_source_attach(iwp
->src
, iwp
->context
);
1080 g_source_destroy(iwp
->src
);
1081 g_source_unref(iwp
->src
);
1087 static gboolean
io_watch_poll_check(GSource
*source
)
1092 static gboolean
io_watch_poll_dispatch(GSource
*source
, GSourceFunc callback
,
1098 static void io_watch_poll_finalize(GSource
*source
)
1100 /* Due to a glib bug, removing the last reference to a source
1101 * inside a finalize callback causes recursive locking (and a
1102 * deadlock). This is not a problem inside other callbacks,
1103 * including dispatch callbacks, so we call io_remove_watch_poll
1104 * to remove this source. At this point, iwp->src must
1105 * be NULL, or we would leak it.
1107 * This would be solved much more elegantly by child sources,
1108 * but we support older glib versions that do not have them.
1110 IOWatchPoll
*iwp
= io_watch_poll_from_source(source
);
1111 assert(iwp
->src
== NULL
);
1114 static GSourceFuncs io_watch_poll_funcs
= {
1115 .prepare
= io_watch_poll_prepare
,
1116 .check
= io_watch_poll_check
,
1117 .dispatch
= io_watch_poll_dispatch
,
1118 .finalize
= io_watch_poll_finalize
,
1121 /* Can only be used for read */
1122 static guint
io_add_watch_poll(Chardev
*chr
,
1124 IOCanReadHandler
*fd_can_read
,
1125 QIOChannelFunc fd_read
,
1127 GMainContext
*context
)
1133 iwp
= (IOWatchPoll
*) g_source_new(&io_watch_poll_funcs
,
1134 sizeof(IOWatchPoll
));
1135 iwp
->fd_can_read
= fd_can_read
;
1136 iwp
->opaque
= user_data
;
1138 iwp
->fd_read
= (GSourceFunc
) fd_read
;
1140 iwp
->context
= context
;
1142 name
= g_strdup_printf("chardev-iowatch-%s", chr
->label
);
1143 g_source_set_name((GSource
*)iwp
, name
);
1146 tag
= g_source_attach(&iwp
->parent
, context
);
1147 g_source_unref(&iwp
->parent
);
1151 static void io_remove_watch_poll(guint tag
)
1156 g_return_if_fail (tag
> 0);
1158 source
= g_main_context_find_source_by_id(NULL
, tag
);
1159 g_return_if_fail (source
!= NULL
);
1161 iwp
= io_watch_poll_from_source(source
);
1163 g_source_destroy(iwp
->src
);
1164 g_source_unref(iwp
->src
);
1167 g_source_destroy(&iwp
->parent
);
1170 static void remove_fd_in_watch(Chardev
*chr
)
1172 if (chr
->fd_in_tag
) {
1173 io_remove_watch_poll(chr
->fd_in_tag
);
1179 static int io_channel_send_full(QIOChannel
*ioc
,
1180 const void *buf
, size_t len
,
1181 int *fds
, size_t nfds
)
1185 while (offset
< len
) {
1187 struct iovec iov
= { .iov_base
= (char *)buf
+ offset
,
1188 .iov_len
= len
- offset
};
1190 ret
= qio_channel_writev_full(
1193 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
1200 } else if (ret
< 0) {
1213 static int io_channel_send(QIOChannel
*ioc
, const void *buf
, size_t len
)
1215 return io_channel_send_full(ioc
, buf
, len
, NULL
, 0);
1218 typedef struct FDChardev
{
1221 QIOChannel
*ioc_in
, *ioc_out
;
1225 #define TYPE_CHARDEV_FD "chardev-fd"
1226 #define FD_CHARDEV(obj) OBJECT_CHECK(FDChardev, (obj), TYPE_CHARDEV_FD)
1228 /* Called with chr_write_lock held. */
1229 static int fd_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
1231 FDChardev
*s
= FD_CHARDEV(chr
);
1233 return io_channel_send(s
->ioc_out
, buf
, len
);
1236 static gboolean
fd_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
1238 Chardev
*chr
= CHARDEV(opaque
);
1239 FDChardev
*s
= FD_CHARDEV(opaque
);
1241 uint8_t buf
[READ_BUF_LEN
];
1245 if (len
> s
->max_size
) {
1252 ret
= qio_channel_read(
1253 chan
, (gchar
*)buf
, len
, NULL
);
1255 remove_fd_in_watch(chr
);
1256 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1260 qemu_chr_be_write(chr
, buf
, ret
);
1266 static int fd_chr_read_poll(void *opaque
)
1268 Chardev
*chr
= CHARDEV(opaque
);
1269 FDChardev
*s
= FD_CHARDEV(opaque
);
1271 s
->max_size
= qemu_chr_be_can_write(chr
);
1275 static GSource
*fd_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
1277 FDChardev
*s
= FD_CHARDEV(chr
);
1278 return qio_channel_create_watch(s
->ioc_out
, cond
);
1281 static void fd_chr_update_read_handler(Chardev
*chr
,
1282 GMainContext
*context
)
1284 FDChardev
*s
= FD_CHARDEV(chr
);
1286 remove_fd_in_watch(chr
);
1288 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc_in
,
1295 static void char_fd_finalize(Object
*obj
)
1297 Chardev
*chr
= CHARDEV(obj
);
1298 FDChardev
*s
= FD_CHARDEV(obj
);
1300 remove_fd_in_watch(chr
);
1302 object_unref(OBJECT(s
->ioc_in
));
1305 object_unref(OBJECT(s
->ioc_out
));
1308 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1311 /* open a character device to a unix fd */
1312 static void qemu_chr_open_fd(Chardev
*chr
,
1313 int fd_in
, int fd_out
)
1315 FDChardev
*s
= FD_CHARDEV(chr
);
1318 s
->ioc_in
= QIO_CHANNEL(qio_channel_file_new_fd(fd_in
));
1319 name
= g_strdup_printf("chardev-file-in-%s", chr
->label
);
1320 qio_channel_set_name(QIO_CHANNEL(s
->ioc_in
), name
);
1322 s
->ioc_out
= QIO_CHANNEL(qio_channel_file_new_fd(fd_out
));
1323 name
= g_strdup_printf("chardev-file-out-%s", chr
->label
);
1324 qio_channel_set_name(QIO_CHANNEL(s
->ioc_out
), name
);
1326 qemu_set_nonblock(fd_out
);
1330 static void char_fd_class_init(ObjectClass
*oc
, void *data
)
1332 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
1334 cc
->chr_add_watch
= fd_chr_add_watch
;
1335 cc
->chr_write
= fd_chr_write
;
1336 cc
->chr_update_read_handler
= fd_chr_update_read_handler
;
1339 static const TypeInfo char_fd_type_info
= {
1340 .name
= TYPE_CHARDEV_FD
,
1341 .parent
= TYPE_CHARDEV
,
1342 .instance_size
= sizeof(FDChardev
),
1343 .instance_finalize
= char_fd_finalize
,
1344 .class_init
= char_fd_class_init
,
1348 static void qemu_chr_open_pipe(Chardev
*chr
,
1349 ChardevBackend
*backend
,
1353 ChardevHostdev
*opts
= backend
->u
.pipe
.data
;
1357 const char *filename
= opts
->device
;
1359 filename_in
= g_strdup_printf("%s.in", filename
);
1360 filename_out
= g_strdup_printf("%s.out", filename
);
1361 TFR(fd_in
= qemu_open(filename_in
, O_RDWR
| O_BINARY
));
1362 TFR(fd_out
= qemu_open(filename_out
, O_RDWR
| O_BINARY
));
1363 g_free(filename_in
);
1364 g_free(filename_out
);
1365 if (fd_in
< 0 || fd_out
< 0) {
1370 TFR(fd_in
= fd_out
= qemu_open(filename
, O_RDWR
| O_BINARY
));
1372 error_setg_file_open(errp
, errno
, filename
);
1376 qemu_chr_open_fd(chr
, fd_in
, fd_out
);
1379 /* init terminal so that we can grab keys */
1380 static struct termios oldtty
;
1381 static int old_fd0_flags
;
1382 static bool stdio_in_use
;
1383 static bool stdio_allow_signal
;
1384 static bool stdio_echo_state
;
1386 static void qemu_chr_set_echo_stdio(Chardev
*chr
, bool echo
);
1388 static void term_exit(void)
1390 tcsetattr (0, TCSANOW
, &oldtty
);
1391 fcntl(0, F_SETFL
, old_fd0_flags
);
1394 static void term_stdio_handler(int sig
)
1396 /* restore echo after resume from suspend. */
1397 qemu_chr_set_echo_stdio(NULL
, stdio_echo_state
);
1400 static void qemu_chr_set_echo_stdio(Chardev
*chr
, bool echo
)
1404 stdio_echo_state
= echo
;
1407 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
1408 |INLCR
|IGNCR
|ICRNL
|IXON
);
1409 tty
.c_oflag
|= OPOST
;
1410 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
1411 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
1414 tty
.c_cc
[VTIME
] = 0;
1416 if (!stdio_allow_signal
)
1417 tty
.c_lflag
&= ~ISIG
;
1419 tcsetattr (0, TCSANOW
, &tty
);
1422 static void char_stdio_finalize(Object
*obj
)
1427 static void qemu_chr_open_stdio(Chardev
*chr
,
1428 ChardevBackend
*backend
,
1432 ChardevStdio
*opts
= backend
->u
.stdio
.data
;
1433 struct sigaction act
;
1435 if (is_daemonized()) {
1436 error_setg(errp
, "cannot use stdio with -daemonize");
1441 error_setg(errp
, "cannot use stdio by multiple character devices");
1445 stdio_in_use
= true;
1446 old_fd0_flags
= fcntl(0, F_GETFL
);
1447 tcgetattr(0, &oldtty
);
1448 qemu_set_nonblock(0);
1451 memset(&act
, 0, sizeof(act
));
1452 act
.sa_handler
= term_stdio_handler
;
1453 sigaction(SIGCONT
, &act
, NULL
);
1455 qemu_chr_open_fd(chr
, 0, 1);
1457 if (opts
->has_signal
) {
1458 stdio_allow_signal
= opts
->signal
;
1460 qemu_chr_set_echo_stdio(chr
, false);
1463 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1464 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1465 || defined(__GLIBC__)
1467 #define HAVE_CHARDEV_SERIAL 1
1468 #define HAVE_CHARDEV_PTY 1
1475 /* Protected by the Chardev chr_write_lock. */
1481 #define PTY_CHARDEV(obj) OBJECT_CHECK(PtyChardev, (obj), TYPE_CHARDEV_PTY)
1483 static void pty_chr_update_read_handler_locked(Chardev
*chr
);
1484 static void pty_chr_state(Chardev
*chr
, int connected
);
1486 static gboolean
pty_chr_timer(gpointer opaque
)
1488 struct Chardev
*chr
= CHARDEV(opaque
);
1489 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1491 qemu_mutex_lock(&chr
->chr_write_lock
);
1494 if (!s
->connected
) {
1496 pty_chr_update_read_handler_locked(chr
);
1498 qemu_mutex_unlock(&chr
->chr_write_lock
);
1502 /* Called with chr_write_lock held. */
1503 static void pty_chr_rearm_timer(Chardev
*chr
, int ms
)
1505 PtyChardev
*s
= PTY_CHARDEV(chr
);
1509 g_source_remove(s
->timer_tag
);
1514 name
= g_strdup_printf("pty-timer-secs-%s", chr
->label
);
1515 s
->timer_tag
= g_timeout_add_seconds(1, pty_chr_timer
, chr
);
1517 name
= g_strdup_printf("pty-timer-ms-%s", chr
->label
);
1518 s
->timer_tag
= g_timeout_add(ms
, pty_chr_timer
, chr
);
1520 g_source_set_name_by_id(s
->timer_tag
, name
);
1524 /* Called with chr_write_lock held. */
1525 static void pty_chr_update_read_handler_locked(Chardev
*chr
)
1527 PtyChardev
*s
= PTY_CHARDEV(chr
);
1530 QIOChannelFile
*fioc
= QIO_CHANNEL_FILE(s
->ioc
);
1533 pfd
.events
= G_IO_OUT
;
1536 rc
= g_poll(&pfd
, 1, 0);
1537 } while (rc
== -1 && errno
== EINTR
);
1540 if (pfd
.revents
& G_IO_HUP
) {
1541 pty_chr_state(chr
, 0);
1543 pty_chr_state(chr
, 1);
1547 static void pty_chr_update_read_handler(Chardev
*chr
,
1548 GMainContext
*context
)
1550 qemu_mutex_lock(&chr
->chr_write_lock
);
1551 pty_chr_update_read_handler_locked(chr
);
1552 qemu_mutex_unlock(&chr
->chr_write_lock
);
1555 /* Called with chr_write_lock held. */
1556 static int char_pty_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
1558 PtyChardev
*s
= PTY_CHARDEV(chr
);
1560 if (!s
->connected
) {
1561 /* guest sends data, check for (re-)connect */
1562 pty_chr_update_read_handler_locked(chr
);
1563 if (!s
->connected
) {
1567 return io_channel_send(s
->ioc
, buf
, len
);
1570 static GSource
*pty_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
1572 PtyChardev
*s
= PTY_CHARDEV(chr
);
1573 if (!s
->connected
) {
1576 return qio_channel_create_watch(s
->ioc
, cond
);
1579 static int pty_chr_read_poll(void *opaque
)
1581 Chardev
*chr
= CHARDEV(opaque
);
1582 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1584 s
->read_bytes
= qemu_chr_be_can_write(chr
);
1585 return s
->read_bytes
;
1588 static gboolean
pty_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
1590 Chardev
*chr
= CHARDEV(opaque
);
1591 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1593 uint8_t buf
[READ_BUF_LEN
];
1597 if (len
> s
->read_bytes
)
1598 len
= s
->read_bytes
;
1602 ret
= qio_channel_read(s
->ioc
, (char *)buf
, len
, NULL
);
1604 pty_chr_state(chr
, 0);
1607 pty_chr_state(chr
, 1);
1608 qemu_chr_be_write(chr
, buf
, ret
);
1613 static gboolean
qemu_chr_be_generic_open_func(gpointer opaque
)
1615 Chardev
*chr
= CHARDEV(opaque
);
1616 PtyChardev
*s
= PTY_CHARDEV(opaque
);
1619 qemu_chr_be_generic_open(chr
);
1623 /* Called with chr_write_lock held. */
1624 static void pty_chr_state(Chardev
*chr
, int connected
)
1626 PtyChardev
*s
= PTY_CHARDEV(chr
);
1630 g_source_remove(s
->open_tag
);
1633 remove_fd_in_watch(chr
);
1635 /* (re-)connect poll interval for idle guests: once per second.
1636 * We check more frequently in case the guests sends data to
1637 * the virtual device linked to our pty. */
1638 pty_chr_rearm_timer(chr
, 1000);
1641 g_source_remove(s
->timer_tag
);
1644 if (!s
->connected
) {
1645 g_assert(s
->open_tag
== 0);
1647 s
->open_tag
= g_idle_add(qemu_chr_be_generic_open_func
, chr
);
1649 if (!chr
->fd_in_tag
) {
1650 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
1658 static void char_pty_finalize(Object
*obj
)
1660 Chardev
*chr
= CHARDEV(obj
);
1661 PtyChardev
*s
= PTY_CHARDEV(obj
);
1663 qemu_mutex_lock(&chr
->chr_write_lock
);
1664 pty_chr_state(chr
, 0);
1665 object_unref(OBJECT(s
->ioc
));
1667 g_source_remove(s
->timer_tag
);
1670 qemu_mutex_unlock(&chr
->chr_write_lock
);
1671 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1674 static void char_pty_open(Chardev
*chr
,
1675 ChardevBackend
*backend
,
1680 int master_fd
, slave_fd
;
1681 char pty_name
[PATH_MAX
];
1684 master_fd
= qemu_openpty_raw(&slave_fd
, pty_name
);
1685 if (master_fd
< 0) {
1686 error_setg_errno(errp
, errno
, "Failed to create PTY");
1691 qemu_set_nonblock(master_fd
);
1693 chr
->filename
= g_strdup_printf("pty:%s", pty_name
);
1694 error_report("char device redirected to %s (label %s)",
1695 pty_name
, chr
->label
);
1697 s
= PTY_CHARDEV(chr
);
1698 s
->ioc
= QIO_CHANNEL(qio_channel_file_new_fd(master_fd
));
1699 name
= g_strdup_printf("chardev-pty-%s", chr
->label
);
1700 qio_channel_set_name(QIO_CHANNEL(s
->ioc
), name
);
1706 static void char_pty_class_init(ObjectClass
*oc
, void *data
)
1708 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
1710 cc
->open
= char_pty_open
;
1711 cc
->chr_write
= char_pty_chr_write
;
1712 cc
->chr_update_read_handler
= pty_chr_update_read_handler
;
1713 cc
->chr_add_watch
= pty_chr_add_watch
;
1716 static const TypeInfo char_pty_type_info
= {
1717 .name
= TYPE_CHARDEV_PTY
,
1718 .parent
= TYPE_CHARDEV
,
1719 .instance_size
= sizeof(PtyChardev
),
1720 .instance_finalize
= char_pty_finalize
,
1721 .class_init
= char_pty_class_init
,
1724 static void tty_serial_init(int fd
, int speed
,
1725 int parity
, int data_bits
, int stop_bits
)
1731 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1732 speed
, parity
, data_bits
, stop_bits
);
1734 tcgetattr (fd
, &tty
);
1736 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1737 speed
= speed
* 10 / 11;
1754 /* Non-Posix values follow. They may be unsupported on some systems. */
1756 check_speed(115200);
1758 check_speed(230400);
1761 check_speed(460800);
1764 check_speed(500000);
1767 check_speed(576000);
1770 check_speed(921600);
1773 check_speed(1000000);
1776 check_speed(1152000);
1779 check_speed(1500000);
1782 check_speed(2000000);
1785 check_speed(2500000);
1788 check_speed(3000000);
1791 check_speed(3500000);
1794 check_speed(4000000);
1799 cfsetispeed(&tty
, spd
);
1800 cfsetospeed(&tty
, spd
);
1802 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
1803 |INLCR
|IGNCR
|ICRNL
|IXON
);
1804 tty
.c_oflag
|= OPOST
;
1805 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
|ISIG
);
1806 tty
.c_cflag
&= ~(CSIZE
|PARENB
|PARODD
|CRTSCTS
|CSTOPB
);
1827 tty
.c_cflag
|= PARENB
;
1830 tty
.c_cflag
|= PARENB
| PARODD
;
1834 tty
.c_cflag
|= CSTOPB
;
1836 tcsetattr (fd
, TCSANOW
, &tty
);
1839 static int tty_serial_ioctl(Chardev
*chr
, int cmd
, void *arg
)
1841 FDChardev
*s
= FD_CHARDEV(chr
);
1842 QIOChannelFile
*fioc
= QIO_CHANNEL_FILE(s
->ioc_in
);
1845 case CHR_IOCTL_SERIAL_SET_PARAMS
:
1847 QEMUSerialSetParams
*ssp
= arg
;
1848 tty_serial_init(fioc
->fd
,
1849 ssp
->speed
, ssp
->parity
,
1850 ssp
->data_bits
, ssp
->stop_bits
);
1853 case CHR_IOCTL_SERIAL_SET_BREAK
:
1855 int enable
= *(int *)arg
;
1857 tcsendbreak(fioc
->fd
, 1);
1861 case CHR_IOCTL_SERIAL_GET_TIOCM
:
1864 int *targ
= (int *)arg
;
1865 ioctl(fioc
->fd
, TIOCMGET
, &sarg
);
1867 if (sarg
& TIOCM_CTS
)
1868 *targ
|= CHR_TIOCM_CTS
;
1869 if (sarg
& TIOCM_CAR
)
1870 *targ
|= CHR_TIOCM_CAR
;
1871 if (sarg
& TIOCM_DSR
)
1872 *targ
|= CHR_TIOCM_DSR
;
1873 if (sarg
& TIOCM_RI
)
1874 *targ
|= CHR_TIOCM_RI
;
1875 if (sarg
& TIOCM_DTR
)
1876 *targ
|= CHR_TIOCM_DTR
;
1877 if (sarg
& TIOCM_RTS
)
1878 *targ
|= CHR_TIOCM_RTS
;
1881 case CHR_IOCTL_SERIAL_SET_TIOCM
:
1883 int sarg
= *(int *)arg
;
1885 ioctl(fioc
->fd
, TIOCMGET
, &targ
);
1886 targ
&= ~(CHR_TIOCM_CTS
| CHR_TIOCM_CAR
| CHR_TIOCM_DSR
1887 | CHR_TIOCM_RI
| CHR_TIOCM_DTR
| CHR_TIOCM_RTS
);
1888 if (sarg
& CHR_TIOCM_CTS
)
1890 if (sarg
& CHR_TIOCM_CAR
)
1892 if (sarg
& CHR_TIOCM_DSR
)
1894 if (sarg
& CHR_TIOCM_RI
)
1896 if (sarg
& CHR_TIOCM_DTR
)
1898 if (sarg
& CHR_TIOCM_RTS
)
1900 ioctl(fioc
->fd
, TIOCMSET
, &targ
);
1908 #endif /* __linux__ || __sun__ */
1910 #if defined(__linux__)
1912 #define HAVE_CHARDEV_PARPORT 1
1920 #define PARALLEL_CHARDEV(obj) \
1921 OBJECT_CHECK(ParallelChardev, (obj), TYPE_CHARDEV_PARALLEL)
1923 static int pp_hw_mode(ParallelChardev
*s
, uint16_t mode
)
1925 if (s
->mode
!= mode
) {
1927 if (ioctl(s
->fd
, PPSETMODE
, &m
) < 0)
1934 static int pp_ioctl(Chardev
*chr
, int cmd
, void *arg
)
1936 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
1941 case CHR_IOCTL_PP_READ_DATA
:
1942 if (ioctl(fd
, PPRDATA
, &b
) < 0)
1944 *(uint8_t *)arg
= b
;
1946 case CHR_IOCTL_PP_WRITE_DATA
:
1947 b
= *(uint8_t *)arg
;
1948 if (ioctl(fd
, PPWDATA
, &b
) < 0)
1951 case CHR_IOCTL_PP_READ_CONTROL
:
1952 if (ioctl(fd
, PPRCONTROL
, &b
) < 0)
1954 /* Linux gives only the lowest bits, and no way to know data
1955 direction! For better compatibility set the fixed upper
1957 *(uint8_t *)arg
= b
| 0xc0;
1959 case CHR_IOCTL_PP_WRITE_CONTROL
:
1960 b
= *(uint8_t *)arg
;
1961 if (ioctl(fd
, PPWCONTROL
, &b
) < 0)
1964 case CHR_IOCTL_PP_READ_STATUS
:
1965 if (ioctl(fd
, PPRSTATUS
, &b
) < 0)
1967 *(uint8_t *)arg
= b
;
1969 case CHR_IOCTL_PP_DATA_DIR
:
1970 if (ioctl(fd
, PPDATADIR
, (int *)arg
) < 0)
1973 case CHR_IOCTL_PP_EPP_READ_ADDR
:
1974 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
|IEEE1284_ADDR
)) {
1975 struct ParallelIOArg
*parg
= arg
;
1976 int n
= read(fd
, parg
->buffer
, parg
->count
);
1977 if (n
!= parg
->count
) {
1982 case CHR_IOCTL_PP_EPP_READ
:
1983 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
)) {
1984 struct ParallelIOArg
*parg
= arg
;
1985 int n
= read(fd
, parg
->buffer
, parg
->count
);
1986 if (n
!= parg
->count
) {
1991 case CHR_IOCTL_PP_EPP_WRITE_ADDR
:
1992 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
|IEEE1284_ADDR
)) {
1993 struct ParallelIOArg
*parg
= arg
;
1994 int n
= write(fd
, parg
->buffer
, parg
->count
);
1995 if (n
!= parg
->count
) {
2000 case CHR_IOCTL_PP_EPP_WRITE
:
2001 if (pp_hw_mode(drv
, IEEE1284_MODE_EPP
)) {
2002 struct ParallelIOArg
*parg
= arg
;
2003 int n
= write(fd
, parg
->buffer
, parg
->count
);
2004 if (n
!= parg
->count
) {
2015 static void qemu_chr_open_pp_fd(Chardev
*chr
,
2020 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
2022 if (ioctl(fd
, PPCLAIM
) < 0) {
2023 error_setg_errno(errp
, errno
, "not a parallel port");
2029 drv
->mode
= IEEE1284_MODE_COMPAT
;
2031 #endif /* __linux__ */
2033 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
2035 #define HAVE_CHARDEV_PARPORT 1
2042 #define PARALLEL_CHARDEV(obj) \
2043 OBJECT_CHECK(ParallelChardev, (obj), TYPE_CHARDEV_PARALLEL)
2045 static int pp_ioctl(Chardev
*chr
, int cmd
, void *arg
)
2047 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
2051 case CHR_IOCTL_PP_READ_DATA
:
2052 if (ioctl(drv
->fd
, PPIGDATA
, &b
) < 0) {
2055 *(uint8_t *)arg
= b
;
2057 case CHR_IOCTL_PP_WRITE_DATA
:
2058 b
= *(uint8_t *)arg
;
2059 if (ioctl(drv
->fd
, PPISDATA
, &b
) < 0) {
2063 case CHR_IOCTL_PP_READ_CONTROL
:
2064 if (ioctl(drv
->fd
, PPIGCTRL
, &b
) < 0) {
2067 *(uint8_t *)arg
= b
;
2069 case CHR_IOCTL_PP_WRITE_CONTROL
:
2070 b
= *(uint8_t *)arg
;
2071 if (ioctl(drv
->fd
, PPISCTRL
, &b
) < 0) {
2075 case CHR_IOCTL_PP_READ_STATUS
:
2076 if (ioctl(drv
->fd
, PPIGSTATUS
, &b
) < 0) {
2079 *(uint8_t *)arg
= b
;
2087 static void qemu_chr_open_pp_fd(Chardev
*chr
,
2092 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
2100 #define HAVE_CHARDEV_SERIAL 1
2105 HANDLE hcom
, hrecv
, hsend
;
2110 /* Protected by the Chardev chr_write_lock. */
2112 /* FIXME: file/console do not finalize */
2116 #define TYPE_CHARDEV_WIN "chardev-win"
2117 #define WIN_CHARDEV(obj) OBJECT_CHECK(WinChardev, (obj), TYPE_CHARDEV_WIN)
2122 HANDLE hInputReadyEvent
;
2123 HANDLE hInputDoneEvent
;
2124 HANDLE hInputThread
;
2125 uint8_t win_stdio_buf
;
2128 #define TYPE_CHARDEV_WIN_STDIO "chardev-win-stdio"
2129 #define WIN_STDIO_CHARDEV(obj) \
2130 OBJECT_CHECK(WinStdioChardev, (obj), TYPE_CHARDEV_WIN_STDIO)
2132 #define NSENDBUF 2048
2133 #define NRECVBUF 2048
2134 #define MAXCONNECT 1
2135 #define NTIMEOUT 5000
2137 static int win_chr_poll(void *opaque
);
2138 static int win_chr_pipe_poll(void *opaque
);
2140 static void char_win_finalize(Object
*obj
)
2142 Chardev
*chr
= CHARDEV(obj
);
2143 WinChardev
*s
= WIN_CHARDEV(chr
);
2150 CloseHandle(s
->hsend
);
2153 CloseHandle(s
->hrecv
);
2156 CloseHandle(s
->hcom
);
2159 qemu_del_polling_cb(win_chr_pipe_poll
, chr
);
2161 qemu_del_polling_cb(win_chr_poll
, chr
);
2163 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
2166 static int win_chr_init(Chardev
*chr
, const char *filename
, Error
**errp
)
2168 WinChardev
*s
= WIN_CHARDEV(chr
);
2170 COMMTIMEOUTS cto
= { 0, 0, 0, 0, 0};
2175 s
->hsend
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2177 error_setg(errp
, "Failed CreateEvent");
2180 s
->hrecv
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2182 error_setg(errp
, "Failed CreateEvent");
2186 s
->hcom
= CreateFile(filename
, GENERIC_READ
|GENERIC_WRITE
, 0, NULL
,
2187 OPEN_EXISTING
, FILE_FLAG_OVERLAPPED
, 0);
2188 if (s
->hcom
== INVALID_HANDLE_VALUE
) {
2189 error_setg(errp
, "Failed CreateFile (%lu)", GetLastError());
2194 if (!SetupComm(s
->hcom
, NRECVBUF
, NSENDBUF
)) {
2195 error_setg(errp
, "Failed SetupComm");
2199 ZeroMemory(&comcfg
, sizeof(COMMCONFIG
));
2200 size
= sizeof(COMMCONFIG
);
2201 GetDefaultCommConfig(filename
, &comcfg
, &size
);
2202 comcfg
.dcb
.DCBlength
= sizeof(DCB
);
2203 CommConfigDialog(filename
, NULL
, &comcfg
);
2205 if (!SetCommState(s
->hcom
, &comcfg
.dcb
)) {
2206 error_setg(errp
, "Failed SetCommState");
2210 if (!SetCommMask(s
->hcom
, EV_ERR
)) {
2211 error_setg(errp
, "Failed SetCommMask");
2215 cto
.ReadIntervalTimeout
= MAXDWORD
;
2216 if (!SetCommTimeouts(s
->hcom
, &cto
)) {
2217 error_setg(errp
, "Failed SetCommTimeouts");
2221 if (!ClearCommError(s
->hcom
, &err
, &comstat
)) {
2222 error_setg(errp
, "Failed ClearCommError");
2225 qemu_add_polling_cb(win_chr_poll
, chr
);
2232 /* Called with chr_write_lock held. */
2233 static int win_chr_write(Chardev
*chr
, const uint8_t *buf
, int len1
)
2235 WinChardev
*s
= WIN_CHARDEV(chr
);
2236 DWORD len
, ret
, size
, err
;
2239 ZeroMemory(&s
->osend
, sizeof(s
->osend
));
2240 s
->osend
.hEvent
= s
->hsend
;
2243 ret
= WriteFile(s
->hcom
, buf
, len
, &size
, &s
->osend
);
2245 ret
= WriteFile(s
->hcom
, buf
, len
, &size
, NULL
);
2247 err
= GetLastError();
2248 if (err
== ERROR_IO_PENDING
) {
2249 ret
= GetOverlappedResult(s
->hcom
, &s
->osend
, &size
, TRUE
);
2267 static int win_chr_read_poll(Chardev
*chr
)
2269 WinChardev
*s
= WIN_CHARDEV(chr
);
2271 s
->max_size
= qemu_chr_be_can_write(chr
);
2275 static void win_chr_readfile(Chardev
*chr
)
2277 WinChardev
*s
= WIN_CHARDEV(chr
);
2280 uint8_t buf
[READ_BUF_LEN
];
2283 ZeroMemory(&s
->orecv
, sizeof(s
->orecv
));
2284 s
->orecv
.hEvent
= s
->hrecv
;
2285 ret
= ReadFile(s
->hcom
, buf
, s
->len
, &size
, &s
->orecv
);
2287 err
= GetLastError();
2288 if (err
== ERROR_IO_PENDING
) {
2289 ret
= GetOverlappedResult(s
->hcom
, &s
->orecv
, &size
, TRUE
);
2294 qemu_chr_be_write(chr
, buf
, size
);
2298 static void win_chr_read(Chardev
*chr
)
2300 WinChardev
*s
= WIN_CHARDEV(chr
);
2302 if (s
->len
> s
->max_size
)
2303 s
->len
= s
->max_size
;
2307 win_chr_readfile(chr
);
2310 static int win_chr_poll(void *opaque
)
2312 Chardev
*chr
= CHARDEV(opaque
);
2313 WinChardev
*s
= WIN_CHARDEV(opaque
);
2317 ClearCommError(s
->hcom
, &comerr
, &status
);
2318 if (status
.cbInQue
> 0) {
2319 s
->len
= status
.cbInQue
;
2320 win_chr_read_poll(chr
);
2327 static int win_chr_pipe_poll(void *opaque
)
2329 Chardev
*chr
= CHARDEV(opaque
);
2330 WinChardev
*s
= WIN_CHARDEV(opaque
);
2333 PeekNamedPipe(s
->hcom
, NULL
, 0, NULL
, &size
, NULL
);
2336 win_chr_read_poll(chr
);
2343 static int win_chr_pipe_init(Chardev
*chr
, const char *filename
,
2346 WinChardev
*s
= WIN_CHARDEV(chr
);
2354 s
->hsend
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2356 error_setg(errp
, "Failed CreateEvent");
2359 s
->hrecv
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2361 error_setg(errp
, "Failed CreateEvent");
2365 openname
= g_strdup_printf("\\\\.\\pipe\\%s", filename
);
2366 s
->hcom
= CreateNamedPipe(openname
, PIPE_ACCESS_DUPLEX
| FILE_FLAG_OVERLAPPED
,
2367 PIPE_TYPE_BYTE
| PIPE_READMODE_BYTE
|
2369 MAXCONNECT
, NSENDBUF
, NRECVBUF
, NTIMEOUT
, NULL
);
2371 if (s
->hcom
== INVALID_HANDLE_VALUE
) {
2372 error_setg(errp
, "Failed CreateNamedPipe (%lu)", GetLastError());
2377 ZeroMemory(&ov
, sizeof(ov
));
2378 ov
.hEvent
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
2379 ret
= ConnectNamedPipe(s
->hcom
, &ov
);
2381 error_setg(errp
, "Failed ConnectNamedPipe");
2385 ret
= GetOverlappedResult(s
->hcom
, &ov
, &size
, TRUE
);
2387 error_setg(errp
, "Failed GetOverlappedResult");
2389 CloseHandle(ov
.hEvent
);
2396 CloseHandle(ov
.hEvent
);
2399 qemu_add_polling_cb(win_chr_pipe_poll
, chr
);
2407 static void qemu_chr_open_pipe(Chardev
*chr
,
2408 ChardevBackend
*backend
,
2412 ChardevHostdev
*opts
= backend
->u
.pipe
.data
;
2413 const char *filename
= opts
->device
;
2415 if (win_chr_pipe_init(chr
, filename
, errp
) < 0) {
2420 static void qemu_chr_open_win_file(Chardev
*chr
, HANDLE fd_out
)
2422 WinChardev
*s
= WIN_CHARDEV(chr
);
2424 s
->skip_free
= true;
2428 static void char_win_class_init(ObjectClass
*oc
, void *data
)
2430 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
2432 cc
->chr_write
= win_chr_write
;
2435 static const TypeInfo char_win_type_info
= {
2436 .name
= TYPE_CHARDEV_WIN
,
2437 .parent
= TYPE_CHARDEV
,
2438 .instance_size
= sizeof(WinChardev
),
2439 .instance_finalize
= char_win_finalize
,
2440 .class_init
= char_win_class_init
,
2444 static void qemu_chr_open_win_con(Chardev
*chr
,
2445 ChardevBackend
*backend
,
2449 qemu_chr_open_win_file(chr
, GetStdHandle(STD_OUTPUT_HANDLE
));
2452 static void char_console_class_init(ObjectClass
*oc
, void *data
)
2454 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
2456 cc
->open
= qemu_chr_open_win_con
;
2459 static const TypeInfo char_console_type_info
= {
2460 .name
= TYPE_CHARDEV_CONSOLE
,
2461 .parent
= TYPE_CHARDEV_WIN
,
2462 .class_init
= char_console_class_init
,
2465 static int win_stdio_write(Chardev
*chr
, const uint8_t *buf
, int len
)
2467 HANDLE hStdOut
= GetStdHandle(STD_OUTPUT_HANDLE
);
2474 if (!WriteFile(hStdOut
, buf
, len1
, &dwSize
, NULL
)) {
2484 static void win_stdio_wait_func(void *opaque
)
2486 Chardev
*chr
= CHARDEV(opaque
);
2487 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(opaque
);
2488 INPUT_RECORD buf
[4];
2493 ret
= ReadConsoleInput(stdio
->hStdIn
, buf
, ARRAY_SIZE(buf
), &dwSize
);
2496 /* Avoid error storm */
2497 qemu_del_wait_object(stdio
->hStdIn
, NULL
, NULL
);
2501 for (i
= 0; i
< dwSize
; i
++) {
2502 KEY_EVENT_RECORD
*kev
= &buf
[i
].Event
.KeyEvent
;
2504 if (buf
[i
].EventType
== KEY_EVENT
&& kev
->bKeyDown
) {
2506 if (kev
->uChar
.AsciiChar
!= 0) {
2507 for (j
= 0; j
< kev
->wRepeatCount
; j
++) {
2508 if (qemu_chr_be_can_write(chr
)) {
2509 uint8_t c
= kev
->uChar
.AsciiChar
;
2510 qemu_chr_be_write(chr
, &c
, 1);
2518 static DWORD WINAPI
win_stdio_thread(LPVOID param
)
2520 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(param
);
2526 /* Wait for one byte */
2527 ret
= ReadFile(stdio
->hStdIn
, &stdio
->win_stdio_buf
, 1, &dwSize
, NULL
);
2529 /* Exit in case of error, continue if nothing read */
2537 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2538 if (stdio
->win_stdio_buf
== '\r') {
2542 /* Signal the main thread and wait until the byte was eaten */
2543 if (!SetEvent(stdio
->hInputReadyEvent
)) {
2546 if (WaitForSingleObject(stdio
->hInputDoneEvent
, INFINITE
)
2552 qemu_del_wait_object(stdio
->hInputReadyEvent
, NULL
, NULL
);
2556 static void win_stdio_thread_wait_func(void *opaque
)
2558 Chardev
*chr
= CHARDEV(opaque
);
2559 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(opaque
);
2561 if (qemu_chr_be_can_write(chr
)) {
2562 qemu_chr_be_write(chr
, &stdio
->win_stdio_buf
, 1);
2565 SetEvent(stdio
->hInputDoneEvent
);
2568 static void qemu_chr_set_echo_win_stdio(Chardev
*chr
, bool echo
)
2570 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(chr
);
2573 GetConsoleMode(stdio
->hStdIn
, &dwMode
);
2576 SetConsoleMode(stdio
->hStdIn
, dwMode
| ENABLE_ECHO_INPUT
);
2578 SetConsoleMode(stdio
->hStdIn
, dwMode
& ~ENABLE_ECHO_INPUT
);
2582 static void char_win_stdio_finalize(Object
*obj
)
2584 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(obj
);
2586 if (stdio
->hInputReadyEvent
!= INVALID_HANDLE_VALUE
) {
2587 CloseHandle(stdio
->hInputReadyEvent
);
2589 if (stdio
->hInputDoneEvent
!= INVALID_HANDLE_VALUE
) {
2590 CloseHandle(stdio
->hInputDoneEvent
);
2592 if (stdio
->hInputThread
!= INVALID_HANDLE_VALUE
) {
2593 TerminateThread(stdio
->hInputThread
, 0);
2597 static const TypeInfo char_win_stdio_type_info
= {
2598 .name
= TYPE_CHARDEV_WIN_STDIO
,
2599 .parent
= TYPE_CHARDEV
,
2600 .instance_size
= sizeof(WinStdioChardev
),
2601 .instance_finalize
= char_win_stdio_finalize
,
2605 static void qemu_chr_open_stdio(Chardev
*chr
,
2606 ChardevBackend
*backend
,
2610 WinStdioChardev
*stdio
= WIN_STDIO_CHARDEV(chr
);
2614 stdio
->hStdIn
= GetStdHandle(STD_INPUT_HANDLE
);
2615 if (stdio
->hStdIn
== INVALID_HANDLE_VALUE
) {
2616 error_setg(errp
, "cannot open stdio: invalid handle");
2620 is_console
= GetConsoleMode(stdio
->hStdIn
, &dwMode
) != 0;
2623 if (qemu_add_wait_object(stdio
->hStdIn
,
2624 win_stdio_wait_func
, chr
)) {
2625 error_setg(errp
, "qemu_add_wait_object: failed");
2631 stdio
->hInputReadyEvent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
2632 stdio
->hInputDoneEvent
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
2633 if (stdio
->hInputReadyEvent
== INVALID_HANDLE_VALUE
2634 || stdio
->hInputDoneEvent
== INVALID_HANDLE_VALUE
) {
2635 error_setg(errp
, "cannot create event");
2638 if (qemu_add_wait_object(stdio
->hInputReadyEvent
,
2639 win_stdio_thread_wait_func
, chr
)) {
2640 error_setg(errp
, "qemu_add_wait_object: failed");
2643 stdio
->hInputThread
= CreateThread(NULL
, 0, win_stdio_thread
,
2646 if (stdio
->hInputThread
== INVALID_HANDLE_VALUE
) {
2647 error_setg(errp
, "cannot create stdio thread");
2652 dwMode
|= ENABLE_LINE_INPUT
;
2655 /* set the terminal in raw mode */
2656 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2657 dwMode
|= ENABLE_PROCESSED_INPUT
;
2660 SetConsoleMode(stdio
->hStdIn
, dwMode
);
2662 qemu_chr_set_echo_win_stdio(chr
, false);
2667 qemu_del_wait_object(stdio
->hInputReadyEvent
, NULL
, NULL
);
2669 CloseHandle(stdio
->hInputReadyEvent
);
2670 CloseHandle(stdio
->hInputDoneEvent
);
2672 qemu_del_wait_object(stdio
->hStdIn
, NULL
, NULL
);
2674 #endif /* !_WIN32 */
2676 /***********************************************************/
2677 /* UDP Net console */
2682 uint8_t buf
[READ_BUF_LEN
];
2688 #define UDP_CHARDEV(obj) OBJECT_CHECK(UdpChardev, (obj), TYPE_CHARDEV_UDP)
2690 /* Called with chr_write_lock held. */
2691 static int udp_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
2693 UdpChardev
*s
= UDP_CHARDEV(chr
);
2695 return qio_channel_write(
2696 s
->ioc
, (const char *)buf
, len
, NULL
);
2699 static int udp_chr_read_poll(void *opaque
)
2701 Chardev
*chr
= CHARDEV(opaque
);
2702 UdpChardev
*s
= UDP_CHARDEV(opaque
);
2704 s
->max_size
= qemu_chr_be_can_write(chr
);
2706 /* If there were any stray characters in the queue process them
2709 while (s
->max_size
> 0 && s
->bufptr
< s
->bufcnt
) {
2710 qemu_chr_be_write(chr
, &s
->buf
[s
->bufptr
], 1);
2712 s
->max_size
= qemu_chr_be_can_write(chr
);
2717 static gboolean
udp_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
2719 Chardev
*chr
= CHARDEV(opaque
);
2720 UdpChardev
*s
= UDP_CHARDEV(opaque
);
2723 if (s
->max_size
== 0) {
2726 ret
= qio_channel_read(
2727 s
->ioc
, (char *)s
->buf
, sizeof(s
->buf
), NULL
);
2729 remove_fd_in_watch(chr
);
2735 while (s
->max_size
> 0 && s
->bufptr
< s
->bufcnt
) {
2736 qemu_chr_be_write(chr
, &s
->buf
[s
->bufptr
], 1);
2738 s
->max_size
= qemu_chr_be_can_write(chr
);
2744 static void udp_chr_update_read_handler(Chardev
*chr
,
2745 GMainContext
*context
)
2747 UdpChardev
*s
= UDP_CHARDEV(chr
);
2749 remove_fd_in_watch(chr
);
2751 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
2758 static void char_udp_finalize(Object
*obj
)
2760 Chardev
*chr
= CHARDEV(obj
);
2761 UdpChardev
*s
= UDP_CHARDEV(obj
);
2763 remove_fd_in_watch(chr
);
2765 object_unref(OBJECT(s
->ioc
));
2767 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
2770 /***********************************************************/
2771 /* TCP Net console */
2775 QIOChannel
*ioc
; /* Client I/O channel */
2776 QIOChannelSocket
*sioc
; /* Client master channel */
2777 QIOChannelSocket
*listen_ioc
;
2779 QCryptoTLSCreds
*tls_creds
;
2786 size_t read_msgfds_num
;
2788 size_t write_msgfds_num
;
2790 SocketAddress
*addr
;
2794 guint reconnect_timer
;
2795 int64_t reconnect_time
;
2796 bool connect_err_reported
;
2799 #define SOCKET_CHARDEV(obj) \
2800 OBJECT_CHECK(SocketChardev, (obj), TYPE_CHARDEV_SOCKET)
2802 static gboolean
socket_reconnect_timeout(gpointer opaque
);
2804 static void qemu_chr_socket_restart_timer(Chardev
*chr
)
2806 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2809 assert(s
->connected
== 0);
2810 s
->reconnect_timer
= g_timeout_add_seconds(s
->reconnect_time
,
2811 socket_reconnect_timeout
, chr
);
2812 name
= g_strdup_printf("chardev-socket-reconnect-%s", chr
->label
);
2813 g_source_set_name_by_id(s
->reconnect_timer
, name
);
2817 static void check_report_connect_error(Chardev
*chr
,
2820 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2822 if (!s
->connect_err_reported
) {
2823 error_report("Unable to connect character device %s: %s",
2824 chr
->label
, error_get_pretty(err
));
2825 s
->connect_err_reported
= true;
2827 qemu_chr_socket_restart_timer(chr
);
2830 static gboolean
tcp_chr_accept(QIOChannel
*chan
,
2834 /* Called with chr_write_lock held. */
2835 static int tcp_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
2837 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2840 int ret
= io_channel_send_full(s
->ioc
, buf
, len
,
2842 s
->write_msgfds_num
);
2844 /* free the written msgfds, no matter what */
2845 if (s
->write_msgfds_num
) {
2846 g_free(s
->write_msgfds
);
2847 s
->write_msgfds
= 0;
2848 s
->write_msgfds_num
= 0;
2853 /* XXX: indicate an error ? */
2858 static int tcp_chr_read_poll(void *opaque
)
2860 Chardev
*chr
= CHARDEV(opaque
);
2861 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
2864 s
->max_size
= qemu_chr_be_can_write(chr
);
2869 #define IAC_BREAK 243
2870 static void tcp_chr_process_IAC_bytes(Chardev
*chr
,
2872 uint8_t *buf
, int *size
)
2874 /* Handle any telnet client's basic IAC options to satisfy char by
2875 * char mode with no echo. All IAC options will be removed from
2876 * the buf and the do_telnetopt variable will be used to track the
2877 * state of the width of the IAC information.
2879 * IAC commands come in sets of 3 bytes with the exception of the
2880 * "IAC BREAK" command and the double IAC.
2886 for (i
= 0; i
< *size
; i
++) {
2887 if (s
->do_telnetopt
> 1) {
2888 if ((unsigned char)buf
[i
] == IAC
&& s
->do_telnetopt
== 2) {
2889 /* Double IAC means send an IAC */
2893 s
->do_telnetopt
= 1;
2895 if ((unsigned char)buf
[i
] == IAC_BREAK
&& s
->do_telnetopt
== 2) {
2896 /* Handle IAC break commands by sending a serial break */
2897 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
2902 if (s
->do_telnetopt
>= 4) {
2903 s
->do_telnetopt
= 1;
2906 if ((unsigned char)buf
[i
] == IAC
) {
2907 s
->do_telnetopt
= 2;
2918 static int tcp_get_msgfds(Chardev
*chr
, int *fds
, int num
)
2920 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2922 int to_copy
= (s
->read_msgfds_num
< num
) ? s
->read_msgfds_num
: num
;
2924 assert(num
<= TCP_MAX_FDS
);
2929 memcpy(fds
, s
->read_msgfds
, to_copy
* sizeof(int));
2931 /* Close unused fds */
2932 for (i
= to_copy
; i
< s
->read_msgfds_num
; i
++) {
2933 close(s
->read_msgfds
[i
]);
2936 g_free(s
->read_msgfds
);
2938 s
->read_msgfds_num
= 0;
2944 static int tcp_set_msgfds(Chardev
*chr
, int *fds
, int num
)
2946 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2948 /* clear old pending fd array */
2949 g_free(s
->write_msgfds
);
2950 s
->write_msgfds
= NULL
;
2951 s
->write_msgfds_num
= 0;
2953 if (!s
->connected
||
2954 !qio_channel_has_feature(s
->ioc
,
2955 QIO_CHANNEL_FEATURE_FD_PASS
)) {
2960 s
->write_msgfds
= g_new(int, num
);
2961 memcpy(s
->write_msgfds
, fds
, num
* sizeof(int));
2964 s
->write_msgfds_num
= num
;
2969 static ssize_t
tcp_chr_recv(Chardev
*chr
, char *buf
, size_t len
)
2971 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
2972 struct iovec iov
= { .iov_base
= buf
, .iov_len
= len
};
2976 size_t msgfds_num
= 0;
2978 if (qio_channel_has_feature(s
->ioc
, QIO_CHANNEL_FEATURE_FD_PASS
)) {
2979 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
2980 &msgfds
, &msgfds_num
,
2983 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
2988 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
2991 } else if (ret
== -1) {
2996 /* close and clean read_msgfds */
2997 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
2998 close(s
->read_msgfds
[i
]);
3001 if (s
->read_msgfds_num
) {
3002 g_free(s
->read_msgfds
);
3005 s
->read_msgfds
= msgfds
;
3006 s
->read_msgfds_num
= msgfds_num
;
3009 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
3010 int fd
= s
->read_msgfds
[i
];
3015 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
3018 #ifndef MSG_CMSG_CLOEXEC
3019 qemu_set_cloexec(fd
);
3026 static GSource
*tcp_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
3028 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3029 return qio_channel_create_watch(s
->ioc
, cond
);
3032 static void tcp_chr_free_connection(Chardev
*chr
)
3034 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3037 if (!s
->connected
) {
3041 if (s
->read_msgfds_num
) {
3042 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
3043 close(s
->read_msgfds
[i
]);
3045 g_free(s
->read_msgfds
);
3046 s
->read_msgfds
= NULL
;
3047 s
->read_msgfds_num
= 0;
3050 tcp_set_msgfds(chr
, NULL
, 0);
3051 remove_fd_in_watch(chr
);
3052 object_unref(OBJECT(s
->sioc
));
3054 object_unref(OBJECT(s
->ioc
));
3056 g_free(chr
->filename
);
3057 chr
->filename
= NULL
;
3061 static void tcp_chr_disconnect(Chardev
*chr
)
3063 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3065 if (!s
->connected
) {
3069 tcp_chr_free_connection(chr
);
3071 if (s
->listen_ioc
) {
3072 s
->listen_tag
= qio_channel_add_watch(
3073 QIO_CHANNEL(s
->listen_ioc
), G_IO_IN
, tcp_chr_accept
, chr
, NULL
);
3075 chr
->filename
= SocketAddress_to_str("disconnected:", s
->addr
,
3076 s
->is_listen
, s
->is_telnet
);
3077 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
3078 if (s
->reconnect_time
) {
3079 qemu_chr_socket_restart_timer(chr
);
3083 static gboolean
tcp_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
3085 Chardev
*chr
= CHARDEV(opaque
);
3086 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
3087 uint8_t buf
[READ_BUF_LEN
];
3090 if (!s
->connected
|| s
->max_size
<= 0) {
3094 if (len
> s
->max_size
)
3096 size
= tcp_chr_recv(chr
, (void *)buf
, len
);
3097 if (size
== 0 || size
== -1) {
3098 /* connection closed */
3099 tcp_chr_disconnect(chr
);
3100 } else if (size
> 0) {
3101 if (s
->do_telnetopt
)
3102 tcp_chr_process_IAC_bytes(chr
, s
, buf
, &size
);
3104 qemu_chr_be_write(chr
, buf
, size
);
3110 static int tcp_chr_sync_read(Chardev
*chr
, const uint8_t *buf
, int len
)
3112 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3115 if (!s
->connected
) {
3119 size
= tcp_chr_recv(chr
, (void *) buf
, len
);
3121 /* connection closed */
3122 tcp_chr_disconnect(chr
);
3128 static void tcp_chr_connect(void *opaque
)
3130 Chardev
*chr
= CHARDEV(opaque
);
3131 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
3133 g_free(chr
->filename
);
3134 chr
->filename
= sockaddr_to_str(
3135 &s
->sioc
->localAddr
, s
->sioc
->localAddrLen
,
3136 &s
->sioc
->remoteAddr
, s
->sioc
->remoteAddrLen
,
3137 s
->is_listen
, s
->is_telnet
);
3141 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
3146 qemu_chr_be_generic_open(chr
);
3149 static void tcp_chr_update_read_handler(Chardev
*chr
,
3150 GMainContext
*context
)
3152 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3154 if (!s
->connected
) {
3158 remove_fd_in_watch(chr
);
3160 chr
->fd_in_tag
= io_add_watch_poll(chr
, s
->ioc
,
3171 } TCPChardevTelnetInit
;
3173 static gboolean
tcp_chr_telnet_init_io(QIOChannel
*ioc
,
3174 GIOCondition cond G_GNUC_UNUSED
,
3177 TCPChardevTelnetInit
*init
= user_data
;
3180 ret
= qio_channel_write(ioc
, init
->buf
, init
->buflen
, NULL
);
3182 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
3185 tcp_chr_disconnect(init
->chr
);
3189 init
->buflen
-= ret
;
3191 if (init
->buflen
== 0) {
3192 tcp_chr_connect(init
->chr
);
3196 memmove(init
->buf
, init
->buf
+ ret
, init
->buflen
);
3201 static void tcp_chr_telnet_init(Chardev
*chr
)
3203 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3204 TCPChardevTelnetInit
*init
= g_new0(TCPChardevTelnetInit
, 1);
3210 #define IACSET(x, a, b, c) \
3217 /* Prep the telnet negotion to put telnet in binary,
3218 * no echo, single char mode */
3219 IACSET(init
->buf
, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3220 IACSET(init
->buf
, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3221 IACSET(init
->buf
, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3222 IACSET(init
->buf
, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3226 qio_channel_add_watch(
3228 tcp_chr_telnet_init_io
,
3233 static void tcp_chr_tls_handshake(QIOTask
*task
,
3236 Chardev
*chr
= user_data
;
3237 SocketChardev
*s
= user_data
;
3239 if (qio_task_propagate_error(task
, NULL
)) {
3240 tcp_chr_disconnect(chr
);
3242 if (s
->do_telnetopt
) {
3243 tcp_chr_telnet_init(chr
);
3245 tcp_chr_connect(chr
);
3251 static void tcp_chr_tls_init(Chardev
*chr
)
3253 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3254 QIOChannelTLS
*tioc
;
3259 tioc
= qio_channel_tls_new_server(
3260 s
->ioc
, s
->tls_creds
,
3261 NULL
, /* XXX Use an ACL */
3264 tioc
= qio_channel_tls_new_client(
3265 s
->ioc
, s
->tls_creds
,
3266 s
->addr
->u
.inet
.data
->host
,
3271 tcp_chr_disconnect(chr
);
3274 name
= g_strdup_printf("chardev-tls-%s-%s",
3275 s
->is_listen
? "server" : "client",
3277 qio_channel_set_name(QIO_CHANNEL(tioc
), name
);
3279 object_unref(OBJECT(s
->ioc
));
3280 s
->ioc
= QIO_CHANNEL(tioc
);
3282 qio_channel_tls_handshake(tioc
,
3283 tcp_chr_tls_handshake
,
3289 static void tcp_chr_set_client_ioc_name(Chardev
*chr
,
3290 QIOChannelSocket
*sioc
)
3292 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3294 name
= g_strdup_printf("chardev-tcp-%s-%s",
3295 s
->is_listen
? "server" : "client",
3297 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
3302 static int tcp_chr_new_client(Chardev
*chr
, QIOChannelSocket
*sioc
)
3304 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3306 if (s
->ioc
!= NULL
) {
3310 s
->ioc
= QIO_CHANNEL(sioc
);
3311 object_ref(OBJECT(sioc
));
3313 object_ref(OBJECT(sioc
));
3315 qio_channel_set_blocking(s
->ioc
, false, NULL
);
3317 if (s
->do_nodelay
) {
3318 qio_channel_set_delay(s
->ioc
, false);
3320 if (s
->listen_tag
) {
3321 g_source_remove(s
->listen_tag
);
3326 tcp_chr_tls_init(chr
);
3328 if (s
->do_telnetopt
) {
3329 tcp_chr_telnet_init(chr
);
3331 tcp_chr_connect(chr
);
3339 static int tcp_chr_add_client(Chardev
*chr
, int fd
)
3342 QIOChannelSocket
*sioc
;
3344 sioc
= qio_channel_socket_new_fd(fd
, NULL
);
3348 tcp_chr_set_client_ioc_name(chr
, sioc
);
3349 ret
= tcp_chr_new_client(chr
, sioc
);
3350 object_unref(OBJECT(sioc
));
3354 static gboolean
tcp_chr_accept(QIOChannel
*channel
,
3358 Chardev
*chr
= CHARDEV(opaque
);
3359 QIOChannelSocket
*sioc
;
3361 sioc
= qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel
),
3367 tcp_chr_new_client(chr
, sioc
);
3369 object_unref(OBJECT(sioc
));
3374 static int tcp_chr_wait_connected(Chardev
*chr
, Error
**errp
)
3376 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3377 QIOChannelSocket
*sioc
;
3379 /* It can't wait on s->connected, since it is set asynchronously
3380 * in TLS and telnet cases, only wait for an accepted socket */
3383 error_report("QEMU waiting for connection on: %s",
3385 qio_channel_set_blocking(QIO_CHANNEL(s
->listen_ioc
), true, NULL
);
3386 tcp_chr_accept(QIO_CHANNEL(s
->listen_ioc
), G_IO_IN
, chr
);
3387 qio_channel_set_blocking(QIO_CHANNEL(s
->listen_ioc
), false, NULL
);
3389 sioc
= qio_channel_socket_new();
3390 tcp_chr_set_client_ioc_name(chr
, sioc
);
3391 if (qio_channel_socket_connect_sync(sioc
, s
->addr
, errp
) < 0) {
3392 object_unref(OBJECT(sioc
));
3395 tcp_chr_new_client(chr
, sioc
);
3396 object_unref(OBJECT(sioc
));
3403 static int qemu_chr_wait_connected(Chardev
*chr
, Error
**errp
)
3405 ChardevClass
*cc
= CHARDEV_GET_CLASS(chr
);
3407 if (cc
->chr_wait_connected
) {
3408 return cc
->chr_wait_connected(chr
, errp
);
3414 int qemu_chr_fe_wait_connected(CharBackend
*be
, Error
**errp
)
3417 error_setg(errp
, "missing associated backend");
3421 return qemu_chr_wait_connected(be
->chr
, errp
);
3424 static void char_socket_finalize(Object
*obj
)
3426 Chardev
*chr
= CHARDEV(obj
);
3427 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
3429 tcp_chr_free_connection(chr
);
3431 if (s
->reconnect_timer
) {
3432 g_source_remove(s
->reconnect_timer
);
3433 s
->reconnect_timer
= 0;
3435 qapi_free_SocketAddress(s
->addr
);
3436 if (s
->listen_tag
) {
3437 g_source_remove(s
->listen_tag
);
3440 if (s
->listen_ioc
) {
3441 object_unref(OBJECT(s
->listen_ioc
));
3444 object_unref(OBJECT(s
->tls_creds
));
3447 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
3451 static void qemu_chr_socket_connected(QIOTask
*task
, void *opaque
)
3453 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
3454 Chardev
*chr
= CHARDEV(opaque
);
3455 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
3458 if (qio_task_propagate_error(task
, &err
)) {
3459 check_report_connect_error(chr
, err
);
3464 s
->connect_err_reported
= false;
3465 tcp_chr_new_client(chr
, sioc
);
3468 object_unref(OBJECT(sioc
));
3472 /*********************************************************/
3473 /* Ring buffer chardev */
3483 #define RINGBUF_CHARDEV(obj) \
3484 OBJECT_CHECK(RingBufChardev, (obj), TYPE_CHARDEV_RINGBUF)
3486 static size_t ringbuf_count(const Chardev
*chr
)
3488 const RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3490 return d
->prod
- d
->cons
;
3493 /* Called with chr_write_lock held. */
3494 static int ringbuf_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
3496 RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3499 if (!buf
|| (len
< 0)) {
3503 for (i
= 0; i
< len
; i
++ ) {
3504 d
->cbuf
[d
->prod
++ & (d
->size
- 1)] = buf
[i
];
3505 if (d
->prod
- d
->cons
> d
->size
) {
3506 d
->cons
= d
->prod
- d
->size
;
3513 static int ringbuf_chr_read(Chardev
*chr
, uint8_t *buf
, int len
)
3515 RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3518 qemu_mutex_lock(&chr
->chr_write_lock
);
3519 for (i
= 0; i
< len
&& d
->cons
!= d
->prod
; i
++) {
3520 buf
[i
] = d
->cbuf
[d
->cons
++ & (d
->size
- 1)];
3522 qemu_mutex_unlock(&chr
->chr_write_lock
);
3527 static void char_ringbuf_finalize(Object
*obj
)
3529 RingBufChardev
*d
= RINGBUF_CHARDEV(obj
);
3534 static void qemu_chr_open_ringbuf(Chardev
*chr
,
3535 ChardevBackend
*backend
,
3539 ChardevRingbuf
*opts
= backend
->u
.ringbuf
.data
;
3540 RingBufChardev
*d
= RINGBUF_CHARDEV(chr
);
3542 d
->size
= opts
->has_size
? opts
->size
: 65536;
3544 /* The size must be power of 2 */
3545 if (d
->size
& (d
->size
- 1)) {
3546 error_setg(errp
, "size of ringbuf chardev must be power of two");
3552 d
->cbuf
= g_malloc0(d
->size
);
3555 void qmp_ringbuf_write(const char *device
, const char *data
,
3556 bool has_format
, enum DataFormat format
,
3560 const uint8_t *write_data
;
3564 chr
= qemu_chr_find(device
);
3566 error_setg(errp
, "Device '%s' not found", device
);
3570 if (!CHARDEV_IS_RINGBUF(chr
)) {
3571 error_setg(errp
,"%s is not a ringbuf device", device
);
3575 if (has_format
&& (format
== DATA_FORMAT_BASE64
)) {
3576 write_data
= qbase64_decode(data
, -1,
3583 write_data
= (uint8_t *)data
;
3584 write_count
= strlen(data
);
3587 ret
= ringbuf_chr_write(chr
, write_data
, write_count
);
3589 if (write_data
!= (uint8_t *)data
) {
3590 g_free((void *)write_data
);
3594 error_setg(errp
, "Failed to write to device %s", device
);
3599 char *qmp_ringbuf_read(const char *device
, int64_t size
,
3600 bool has_format
, enum DataFormat format
,
3608 chr
= qemu_chr_find(device
);
3610 error_setg(errp
, "Device '%s' not found", device
);
3614 if (!CHARDEV_IS_RINGBUF(chr
)) {
3615 error_setg(errp
,"%s is not a ringbuf device", device
);
3620 error_setg(errp
, "size must be greater than zero");
3624 count
= ringbuf_count(chr
);
3625 size
= size
> count
? count
: size
;
3626 read_data
= g_malloc(size
+ 1);
3628 ringbuf_chr_read(chr
, read_data
, size
);
3630 if (has_format
&& (format
== DATA_FORMAT_BASE64
)) {
3631 data
= g_base64_encode(read_data
, size
);
3635 * FIXME should read only complete, valid UTF-8 characters up
3636 * to @size bytes. Invalid sequences should be replaced by a
3637 * suitable replacement character. Except when (and only
3638 * when) ring buffer lost characters since last read, initial
3639 * continuation characters should be dropped.
3641 read_data
[size
] = 0;
3642 data
= (char *)read_data
;
3648 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
)
3650 char host
[65], port
[33], width
[8], height
[8];
3654 Error
*local_err
= NULL
;
3656 opts
= qemu_opts_create(qemu_find_opts("chardev"), label
, 1, &local_err
);
3658 error_report_err(local_err
);
3662 if (strstart(filename
, "mon:", &p
)) {
3664 qemu_opt_set(opts
, "mux", "on", &error_abort
);
3665 if (strcmp(filename
, "stdio") == 0) {
3666 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3667 * but pass it to the guest. Handle this only for compat syntax,
3668 * for -chardev syntax we have special option for this.
3669 * This is what -nographic did, redirecting+muxing serial+monitor
3670 * to stdio causing Ctrl+C to be passed to guest. */
3671 qemu_opt_set(opts
, "signal", "off", &error_abort
);
3675 if (strcmp(filename
, "null") == 0 ||
3676 strcmp(filename
, "pty") == 0 ||
3677 strcmp(filename
, "msmouse") == 0 ||
3678 strcmp(filename
, "braille") == 0 ||
3679 strcmp(filename
, "testdev") == 0 ||
3680 strcmp(filename
, "stdio") == 0) {
3681 qemu_opt_set(opts
, "backend", filename
, &error_abort
);
3684 if (strstart(filename
, "vc", &p
)) {
3685 qemu_opt_set(opts
, "backend", "vc", &error_abort
);
3687 if (sscanf(p
+1, "%7[0-9]x%7[0-9]", width
, height
) == 2) {
3689 qemu_opt_set(opts
, "width", width
, &error_abort
);
3690 qemu_opt_set(opts
, "height", height
, &error_abort
);
3691 } else if (sscanf(p
+1, "%7[0-9]Cx%7[0-9]C", width
, height
) == 2) {
3693 qemu_opt_set(opts
, "cols", width
, &error_abort
);
3694 qemu_opt_set(opts
, "rows", height
, &error_abort
);
3701 if (strcmp(filename
, "con:") == 0) {
3702 qemu_opt_set(opts
, "backend", "console", &error_abort
);
3705 if (strstart(filename
, "COM", NULL
)) {
3706 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
3707 qemu_opt_set(opts
, "path", filename
, &error_abort
);
3710 if (strstart(filename
, "file:", &p
)) {
3711 qemu_opt_set(opts
, "backend", "file", &error_abort
);
3712 qemu_opt_set(opts
, "path", p
, &error_abort
);
3715 if (strstart(filename
, "pipe:", &p
)) {
3716 qemu_opt_set(opts
, "backend", "pipe", &error_abort
);
3717 qemu_opt_set(opts
, "path", p
, &error_abort
);
3720 if (strstart(filename
, "tcp:", &p
) ||
3721 strstart(filename
, "telnet:", &p
)) {
3722 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
3724 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1)
3727 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
3728 qemu_opt_set(opts
, "host", host
, &error_abort
);
3729 qemu_opt_set(opts
, "port", port
, &error_abort
);
3730 if (p
[pos
] == ',') {
3731 qemu_opts_do_parse(opts
, p
+pos
+1, NULL
, &local_err
);
3733 error_report_err(local_err
);
3737 if (strstart(filename
, "telnet:", &p
))
3738 qemu_opt_set(opts
, "telnet", "on", &error_abort
);
3741 if (strstart(filename
, "udp:", &p
)) {
3742 qemu_opt_set(opts
, "backend", "udp", &error_abort
);
3743 if (sscanf(p
, "%64[^:]:%32[^@,]%n", host
, port
, &pos
) < 2) {
3745 if (sscanf(p
, ":%32[^@,]%n", port
, &pos
) < 1) {
3749 qemu_opt_set(opts
, "host", host
, &error_abort
);
3750 qemu_opt_set(opts
, "port", port
, &error_abort
);
3751 if (p
[pos
] == '@') {
3753 if (sscanf(p
, "%64[^:]:%32[^,]%n", host
, port
, &pos
) < 2) {
3755 if (sscanf(p
, ":%32[^,]%n", port
, &pos
) < 1) {
3759 qemu_opt_set(opts
, "localaddr", host
, &error_abort
);
3760 qemu_opt_set(opts
, "localport", port
, &error_abort
);
3764 if (strstart(filename
, "unix:", &p
)) {
3765 qemu_opt_set(opts
, "backend", "socket", &error_abort
);
3766 qemu_opts_do_parse(opts
, p
, "path", &local_err
);
3768 error_report_err(local_err
);
3773 if (strstart(filename
, "/dev/parport", NULL
) ||
3774 strstart(filename
, "/dev/ppi", NULL
)) {
3775 qemu_opt_set(opts
, "backend", "parport", &error_abort
);
3776 qemu_opt_set(opts
, "path", filename
, &error_abort
);
3779 if (strstart(filename
, "/dev/", NULL
)) {
3780 qemu_opt_set(opts
, "backend", "tty", &error_abort
);
3781 qemu_opt_set(opts
, "path", filename
, &error_abort
);
3786 qemu_opts_del(opts
);
3790 void qemu_chr_parse_common(QemuOpts
*opts
, ChardevCommon
*backend
)
3792 const char *logfile
= qemu_opt_get(opts
, "logfile");
3794 backend
->has_logfile
= logfile
!= NULL
;
3795 backend
->logfile
= logfile
? g_strdup(logfile
) : NULL
;
3797 backend
->has_logappend
= true;
3798 backend
->logappend
= qemu_opt_get_bool(opts
, "logappend", false);
3802 static void qemu_chr_parse_file_out(QemuOpts
*opts
, ChardevBackend
*backend
,
3805 const char *path
= qemu_opt_get(opts
, "path");
3808 backend
->type
= CHARDEV_BACKEND_KIND_FILE
;
3810 error_setg(errp
, "chardev: file: no filename given");
3813 file
= backend
->u
.file
.data
= g_new0(ChardevFile
, 1);
3814 qemu_chr_parse_common(opts
, qapi_ChardevFile_base(file
));
3815 file
->out
= g_strdup(path
);
3817 file
->has_append
= true;
3818 file
->append
= qemu_opt_get_bool(opts
, "append", false);
3821 static void qemu_chr_parse_stdio(QemuOpts
*opts
, ChardevBackend
*backend
,
3824 ChardevStdio
*stdio
;
3826 backend
->type
= CHARDEV_BACKEND_KIND_STDIO
;
3827 stdio
= backend
->u
.stdio
.data
= g_new0(ChardevStdio
, 1);
3828 qemu_chr_parse_common(opts
, qapi_ChardevStdio_base(stdio
));
3829 stdio
->has_signal
= true;
3830 stdio
->signal
= qemu_opt_get_bool(opts
, "signal", true);
3833 static void char_stdio_class_init(ObjectClass
*oc
, void *data
)
3835 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3837 cc
->parse
= qemu_chr_parse_stdio
;
3838 cc
->open
= qemu_chr_open_stdio
;
3840 cc
->chr_write
= win_stdio_write
;
3841 cc
->chr_set_echo
= qemu_chr_set_echo_win_stdio
;
3843 cc
->chr_set_echo
= qemu_chr_set_echo_stdio
;
3847 static const TypeInfo char_stdio_type_info
= {
3848 .name
= TYPE_CHARDEV_STDIO
,
3850 .parent
= TYPE_CHARDEV_WIN_STDIO
,
3852 .parent
= TYPE_CHARDEV_FD
,
3853 .instance_finalize
= char_stdio_finalize
,
3855 .class_init
= char_stdio_class_init
,
3858 #ifdef HAVE_CHARDEV_SERIAL
3859 static void qemu_chr_parse_serial(QemuOpts
*opts
, ChardevBackend
*backend
,
3862 const char *device
= qemu_opt_get(opts
, "path");
3863 ChardevHostdev
*serial
;
3865 backend
->type
= CHARDEV_BACKEND_KIND_SERIAL
;
3866 if (device
== NULL
) {
3867 error_setg(errp
, "chardev: serial/tty: no device path given");
3870 serial
= backend
->u
.serial
.data
= g_new0(ChardevHostdev
, 1);
3871 qemu_chr_parse_common(opts
, qapi_ChardevHostdev_base(serial
));
3872 serial
->device
= g_strdup(device
);
3876 #ifdef HAVE_CHARDEV_PARPORT
3877 static void qemu_chr_parse_parallel(QemuOpts
*opts
, ChardevBackend
*backend
,
3880 const char *device
= qemu_opt_get(opts
, "path");
3881 ChardevHostdev
*parallel
;
3883 backend
->type
= CHARDEV_BACKEND_KIND_PARALLEL
;
3884 if (device
== NULL
) {
3885 error_setg(errp
, "chardev: parallel: no device path given");
3888 parallel
= backend
->u
.parallel
.data
= g_new0(ChardevHostdev
, 1);
3889 qemu_chr_parse_common(opts
, qapi_ChardevHostdev_base(parallel
));
3890 parallel
->device
= g_strdup(device
);
3894 static void qemu_chr_parse_pipe(QemuOpts
*opts
, ChardevBackend
*backend
,
3897 const char *device
= qemu_opt_get(opts
, "path");
3898 ChardevHostdev
*dev
;
3900 backend
->type
= CHARDEV_BACKEND_KIND_PIPE
;
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
->parse
= qemu_chr_parse_pipe
;
3915 cc
->open
= qemu_chr_open_pipe
;
3918 static const TypeInfo char_pipe_type_info
= {
3919 .name
= TYPE_CHARDEV_PIPE
,
3921 .parent
= TYPE_CHARDEV_WIN
,
3923 .parent
= TYPE_CHARDEV_FD
,
3925 .class_init
= char_pipe_class_init
,
3928 static void qemu_chr_parse_ringbuf(QemuOpts
*opts
, ChardevBackend
*backend
,
3932 ChardevRingbuf
*ringbuf
;
3934 backend
->type
= CHARDEV_BACKEND_KIND_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
->parse
= qemu_chr_parse_ringbuf
;
3950 cc
->open
= qemu_chr_open_ringbuf
;
3951 cc
->chr_write
= ringbuf_chr_write
;
3954 static const TypeInfo char_ringbuf_type_info
= {
3955 .name
= TYPE_CHARDEV_RINGBUF
,
3956 .parent
= TYPE_CHARDEV
,
3957 .class_init
= char_ringbuf_class_init
,
3958 .instance_size
= sizeof(RingBufChardev
),
3959 .instance_finalize
= char_ringbuf_finalize
,
3962 /* Bug-compatibility: */
3963 static const TypeInfo char_memory_type_info
= {
3964 .name
= TYPE_CHARDEV_MEMORY
,
3965 .parent
= TYPE_CHARDEV_RINGBUF
,
3968 static void qemu_chr_parse_mux(QemuOpts
*opts
, ChardevBackend
*backend
,
3971 const char *chardev
= qemu_opt_get(opts
, "chardev");
3974 backend
->type
= CHARDEV_BACKEND_KIND_MUX
;
3975 if (chardev
== NULL
) {
3976 error_setg(errp
, "chardev: mux: no chardev given");
3979 mux
= backend
->u
.mux
.data
= g_new0(ChardevMux
, 1);
3980 qemu_chr_parse_common(opts
, qapi_ChardevMux_base(mux
));
3981 mux
->chardev
= g_strdup(chardev
);
3984 static void char_mux_class_init(ObjectClass
*oc
, void *data
)
3986 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
3988 cc
->parse
= qemu_chr_parse_mux
;
3989 cc
->open
= qemu_chr_open_mux
;
3990 cc
->chr_write
= mux_chr_write
;
3991 cc
->chr_accept_input
= mux_chr_accept_input
;
3992 cc
->chr_add_watch
= mux_chr_add_watch
;
3995 static const TypeInfo char_mux_type_info
= {
3996 .name
= TYPE_CHARDEV_MUX
,
3997 .parent
= TYPE_CHARDEV
,
3998 .class_init
= char_mux_class_init
,
3999 .instance_size
= sizeof(MuxChardev
),
4000 .instance_finalize
= char_mux_finalize
,
4003 static void qemu_chr_parse_socket(QemuOpts
*opts
, ChardevBackend
*backend
,
4006 bool is_listen
= qemu_opt_get_bool(opts
, "server", false);
4007 bool is_waitconnect
= is_listen
&& qemu_opt_get_bool(opts
, "wait", true);
4008 bool is_telnet
= qemu_opt_get_bool(opts
, "telnet", false);
4009 bool do_nodelay
= !qemu_opt_get_bool(opts
, "delay", true);
4010 int64_t reconnect
= qemu_opt_get_number(opts
, "reconnect", 0);
4011 const char *path
= qemu_opt_get(opts
, "path");
4012 const char *host
= qemu_opt_get(opts
, "host");
4013 const char *port
= qemu_opt_get(opts
, "port");
4014 const char *tls_creds
= qemu_opt_get(opts
, "tls-creds");
4015 SocketAddress
*addr
;
4016 ChardevSocket
*sock
;
4018 backend
->type
= CHARDEV_BACKEND_KIND_SOCKET
;
4021 error_setg(errp
, "chardev: socket: no host given");
4025 error_setg(errp
, "chardev: socket: no port given");
4030 error_setg(errp
, "TLS can only be used over TCP socket");
4035 sock
= backend
->u
.socket
.data
= g_new0(ChardevSocket
, 1);
4036 qemu_chr_parse_common(opts
, qapi_ChardevSocket_base(sock
));
4038 sock
->has_nodelay
= true;
4039 sock
->nodelay
= do_nodelay
;
4040 sock
->has_server
= true;
4041 sock
->server
= is_listen
;
4042 sock
->has_telnet
= true;
4043 sock
->telnet
= is_telnet
;
4044 sock
->has_wait
= true;
4045 sock
->wait
= is_waitconnect
;
4046 sock
->has_reconnect
= true;
4047 sock
->reconnect
= reconnect
;
4048 sock
->tls_creds
= g_strdup(tls_creds
);
4050 addr
= g_new0(SocketAddress
, 1);
4052 UnixSocketAddress
*q_unix
;
4053 addr
->type
= SOCKET_ADDRESS_KIND_UNIX
;
4054 q_unix
= addr
->u
.q_unix
.data
= g_new0(UnixSocketAddress
, 1);
4055 q_unix
->path
= g_strdup(path
);
4057 addr
->type
= SOCKET_ADDRESS_KIND_INET
;
4058 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
4059 *addr
->u
.inet
.data
= (InetSocketAddress
) {
4060 .host
= g_strdup(host
),
4061 .port
= g_strdup(port
),
4062 .has_to
= qemu_opt_get(opts
, "to"),
4063 .to
= qemu_opt_get_number(opts
, "to", 0),
4064 .has_ipv4
= qemu_opt_get(opts
, "ipv4"),
4065 .ipv4
= qemu_opt_get_bool(opts
, "ipv4", 0),
4066 .has_ipv6
= qemu_opt_get(opts
, "ipv6"),
4067 .ipv6
= qemu_opt_get_bool(opts
, "ipv6", 0),
4073 static void qemu_chr_parse_udp(QemuOpts
*opts
, ChardevBackend
*backend
,
4076 const char *host
= qemu_opt_get(opts
, "host");
4077 const char *port
= qemu_opt_get(opts
, "port");
4078 const char *localaddr
= qemu_opt_get(opts
, "localaddr");
4079 const char *localport
= qemu_opt_get(opts
, "localport");
4080 bool has_local
= false;
4081 SocketAddress
*addr
;
4084 backend
->type
= CHARDEV_BACKEND_KIND_UDP
;
4085 if (host
== NULL
|| strlen(host
) == 0) {
4088 if (port
== NULL
|| strlen(port
) == 0) {
4089 error_setg(errp
, "chardev: udp: remote port not specified");
4092 if (localport
== NULL
|| strlen(localport
) == 0) {
4097 if (localaddr
== NULL
|| strlen(localaddr
) == 0) {
4103 udp
= backend
->u
.udp
.data
= g_new0(ChardevUdp
, 1);
4104 qemu_chr_parse_common(opts
, qapi_ChardevUdp_base(udp
));
4106 addr
= g_new0(SocketAddress
, 1);
4107 addr
->type
= SOCKET_ADDRESS_KIND_INET
;
4108 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
4109 *addr
->u
.inet
.data
= (InetSocketAddress
) {
4110 .host
= g_strdup(host
),
4111 .port
= g_strdup(port
),
4112 .has_ipv4
= qemu_opt_get(opts
, "ipv4"),
4113 .ipv4
= qemu_opt_get_bool(opts
, "ipv4", 0),
4114 .has_ipv6
= qemu_opt_get(opts
, "ipv6"),
4115 .ipv6
= qemu_opt_get_bool(opts
, "ipv6", 0),
4120 udp
->has_local
= true;
4121 addr
= g_new0(SocketAddress
, 1);
4122 addr
->type
= SOCKET_ADDRESS_KIND_INET
;
4123 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
4124 *addr
->u
.inet
.data
= (InetSocketAddress
) {
4125 .host
= g_strdup(localaddr
),
4126 .port
= g_strdup(localport
),
4132 static const ChardevClass
*char_get_class(const char *driver
, Error
**errp
)
4135 const ChardevClass
*cc
;
4136 char *typename
= g_strdup_printf("chardev-%s", driver
);
4138 oc
= object_class_by_name(typename
);
4141 if (!object_class_dynamic_cast(oc
, TYPE_CHARDEV
)) {
4142 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
4146 if (object_class_is_abstract(oc
)) {
4147 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "driver",
4148 "abstract device type");
4152 cc
= CHARDEV_CLASS(oc
);
4154 error_setg(errp
, "'%s' is not a valid char driver name", driver
);
4161 static Chardev
*qemu_chardev_add(const char *id
, const char *typename
,
4162 ChardevBackend
*backend
, Error
**errp
)
4166 chr
= qemu_chr_find(id
);
4168 error_setg(errp
, "Chardev '%s' already exists", id
);
4172 chr
= qemu_chardev_new(id
, typename
, backend
, errp
);
4177 QTAILQ_INSERT_TAIL(&chardevs
, chr
, next
);
4181 static const struct ChardevAlias
{
4182 const char *typename
;
4184 } chardev_alias_table
[] = {
4185 #ifdef HAVE_CHARDEV_PARPORT
4186 { "parallel", "parport" },
4188 #ifdef HAVE_CHARDEV_SERIAL
4189 { "serial", "tty" },
4193 typedef struct ChadevClassFE
{
4194 void (*fn
)(const char *name
, void *opaque
);
4199 chardev_class_foreach(ObjectClass
*klass
, void *opaque
)
4201 ChadevClassFE
*fe
= opaque
;
4203 assert(g_str_has_prefix(object_class_get_name(klass
), "chardev-"));
4204 if (CHARDEV_CLASS(klass
)->internal
) {
4208 fe
->fn(object_class_get_name(klass
) + 8, fe
->opaque
);
4212 chardev_name_foreach(void (*fn
)(const char *name
, void *opaque
), void *opaque
)
4214 ChadevClassFE fe
= { .fn
= fn
, .opaque
= opaque
};
4217 object_class_foreach(chardev_class_foreach
, TYPE_CHARDEV
, false, &fe
);
4219 for (i
= 0; i
< ARRAY_SIZE(chardev_alias_table
); i
++) {
4220 fn(chardev_alias_table
[i
].alias
, opaque
);
4225 help_string_append(const char *name
, void *opaque
)
4227 GString
*str
= opaque
;
4229 g_string_append_printf(str
, "\n%s", name
);
4232 Chardev
*qemu_chr_new_from_opts(QemuOpts
*opts
,
4235 Error
*local_err
= NULL
;
4236 const ChardevClass
*cc
;
4239 ChardevBackend
*backend
= NULL
;
4240 const char *name
= qemu_opt_get(opts
, "backend");
4241 const char *id
= qemu_opts_id(opts
);
4245 error_setg(errp
, "chardev: \"%s\" missing backend",
4246 qemu_opts_id(opts
));
4250 if (is_help_option(name
)) {
4251 GString
*str
= g_string_new("");
4253 chardev_name_foreach(help_string_append
, str
);
4255 error_report("Available chardev backend types: %s", str
->str
);
4256 g_string_free(str
, true);
4261 error_setg(errp
, "chardev: no id specified");
4265 for (i
= 0; i
< ARRAY_SIZE(chardev_alias_table
); i
++) {
4266 if (g_strcmp0(chardev_alias_table
[i
].alias
, name
) == 0) {
4267 name
= chardev_alias_table
[i
].typename
;
4272 cc
= char_get_class(name
, errp
);
4277 backend
= g_new0(ChardevBackend
, 1);
4278 backend
->type
= CHARDEV_BACKEND_KIND_NULL
;
4280 if (qemu_opt_get_bool(opts
, "mux", 0)) {
4281 bid
= g_strdup_printf("%s-base", id
);
4286 cc
->parse(opts
, backend
, &local_err
);
4288 error_propagate(errp
, local_err
);
4292 ChardevCommon
*ccom
= g_new0(ChardevCommon
, 1);
4293 qemu_chr_parse_common(opts
, ccom
);
4294 backend
->u
.null
.data
= ccom
; /* Any ChardevCommon member would work */
4297 chr
= qemu_chardev_add(bid
? bid
: id
,
4298 object_class_get_name(OBJECT_CLASS(cc
)),
4306 qapi_free_ChardevBackend(backend
);
4307 backend
= g_new0(ChardevBackend
, 1);
4308 backend
->type
= CHARDEV_BACKEND_KIND_MUX
;
4309 backend
->u
.mux
.data
= g_new0(ChardevMux
, 1);
4310 backend
->u
.mux
.data
->chardev
= g_strdup(bid
);
4311 mux
= qemu_chardev_add(id
, TYPE_CHARDEV_MUX
, backend
, errp
);
4313 qemu_chr_delete(chr
);
4321 qapi_free_ChardevBackend(backend
);
4326 Chardev
*qemu_chr_new_noreplay(const char *label
, const char *filename
)
4333 if (strstart(filename
, "chardev:", &p
)) {
4334 return qemu_chr_find(p
);
4337 opts
= qemu_chr_parse_compat(label
, filename
);
4341 chr
= qemu_chr_new_from_opts(opts
, &err
);
4343 error_report_err(err
);
4345 if (chr
&& qemu_opt_get_bool(opts
, "mux", 0)) {
4346 monitor_init(chr
, MONITOR_USE_READLINE
);
4348 qemu_opts_del(opts
);
4352 Chardev
*qemu_chr_new(const char *label
, const char *filename
)
4355 chr
= qemu_chr_new_noreplay(label
, filename
);
4357 if (replay_mode
!= REPLAY_MODE_NONE
) {
4358 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_REPLAY
);
4360 if (qemu_chr_replay(chr
) && CHARDEV_GET_CLASS(chr
)->chr_ioctl
) {
4361 error_report("Replay: ioctl is not supported "
4362 "for serial devices yet");
4364 replay_register_char_driver(chr
);
4369 void qemu_chr_fe_set_echo(CharBackend
*be
, bool echo
)
4371 Chardev
*chr
= be
->chr
;
4373 if (chr
&& CHARDEV_GET_CLASS(chr
)->chr_set_echo
) {
4374 CHARDEV_GET_CLASS(chr
)->chr_set_echo(chr
, echo
);
4378 void qemu_chr_fe_set_open(CharBackend
*be
, int fe_open
)
4380 Chardev
*chr
= be
->chr
;
4386 if (be
->fe_open
== fe_open
) {
4389 be
->fe_open
= fe_open
;
4390 if (CHARDEV_GET_CLASS(chr
)->chr_set_fe_open
) {
4391 CHARDEV_GET_CLASS(chr
)->chr_set_fe_open(chr
, fe_open
);
4395 guint
qemu_chr_fe_add_watch(CharBackend
*be
, GIOCondition cond
,
4396 GIOFunc func
, void *user_data
)
4398 Chardev
*s
= be
->chr
;
4402 if (!s
|| CHARDEV_GET_CLASS(s
)->chr_add_watch
== NULL
) {
4406 src
= CHARDEV_GET_CLASS(s
)->chr_add_watch(s
, cond
);
4411 g_source_set_callback(src
, (GSourceFunc
)func
, user_data
, NULL
);
4412 tag
= g_source_attach(src
, NULL
);
4413 g_source_unref(src
);
4418 void qemu_chr_fe_disconnect(CharBackend
*be
)
4420 Chardev
*chr
= be
->chr
;
4422 if (chr
&& CHARDEV_GET_CLASS(chr
)->chr_disconnect
) {
4423 CHARDEV_GET_CLASS(chr
)->chr_disconnect(chr
);
4427 void qemu_chr_delete(Chardev
*chr
)
4429 QTAILQ_REMOVE(&chardevs
, chr
, next
);
4430 object_unref(OBJECT(chr
));
4433 ChardevInfoList
*qmp_query_chardev(Error
**errp
)
4435 ChardevInfoList
*chr_list
= NULL
;
4438 QTAILQ_FOREACH(chr
, &chardevs
, next
) {
4439 ChardevInfoList
*info
= g_malloc0(sizeof(*info
));
4440 info
->value
= g_malloc0(sizeof(*info
->value
));
4441 info
->value
->label
= g_strdup(chr
->label
);
4442 info
->value
->filename
= g_strdup(chr
->filename
);
4443 info
->value
->frontend_open
= chr
->be
&& chr
->be
->fe_open
;
4445 info
->next
= chr_list
;
4453 qmp_prepend_backend(const char *name
, void *opaque
)
4455 ChardevBackendInfoList
**list
= opaque
;
4456 ChardevBackendInfoList
*info
= g_malloc0(sizeof(*info
));
4458 info
->value
= g_malloc0(sizeof(*info
->value
));
4459 info
->value
->name
= g_strdup(name
);
4464 ChardevBackendInfoList
*qmp_query_chardev_backends(Error
**errp
)
4466 ChardevBackendInfoList
*backend_list
= NULL
;
4468 chardev_name_foreach(qmp_prepend_backend
, &backend_list
);
4470 return backend_list
;
4473 Chardev
*qemu_chr_find(const char *name
)
4477 QTAILQ_FOREACH(chr
, &chardevs
, next
) {
4478 if (strcmp(chr
->label
, name
) != 0)
4485 QemuOptsList qemu_chardev_opts
= {
4487 .implied_opt_name
= "backend",
4488 .head
= QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts
.head
),
4492 .type
= QEMU_OPT_STRING
,
4495 .type
= QEMU_OPT_STRING
,
4498 .type
= QEMU_OPT_STRING
,
4501 .type
= QEMU_OPT_STRING
,
4503 .name
= "localaddr",
4504 .type
= QEMU_OPT_STRING
,
4506 .name
= "localport",
4507 .type
= QEMU_OPT_STRING
,
4510 .type
= QEMU_OPT_NUMBER
,
4513 .type
= QEMU_OPT_BOOL
,
4516 .type
= QEMU_OPT_BOOL
,
4519 .type
= QEMU_OPT_BOOL
,
4522 .type
= QEMU_OPT_BOOL
,
4525 .type
= QEMU_OPT_BOOL
,
4527 .name
= "reconnect",
4528 .type
= QEMU_OPT_NUMBER
,
4531 .type
= QEMU_OPT_BOOL
,
4533 .name
= "tls-creds",
4534 .type
= QEMU_OPT_STRING
,
4537 .type
= QEMU_OPT_NUMBER
,
4540 .type
= QEMU_OPT_NUMBER
,
4543 .type
= QEMU_OPT_NUMBER
,
4546 .type
= QEMU_OPT_NUMBER
,
4549 .type
= QEMU_OPT_BOOL
,
4552 .type
= QEMU_OPT_BOOL
,
4555 .type
= QEMU_OPT_STRING
,
4558 .type
= QEMU_OPT_NUMBER
,
4561 .type
= QEMU_OPT_SIZE
,
4564 .type
= QEMU_OPT_STRING
,
4567 .type
= QEMU_OPT_BOOL
,
4570 .type
= QEMU_OPT_STRING
,
4572 .name
= "logappend",
4573 .type
= QEMU_OPT_BOOL
,
4575 { /* end of list */ }
4581 static void qmp_chardev_open_file(Chardev
*chr
,
4582 ChardevBackend
*backend
,
4586 ChardevFile
*file
= backend
->u
.file
.data
;
4592 error_setg(errp
, "input file not supported");
4596 if (file
->has_append
&& file
->append
) {
4597 /* Append to file if it already exists. */
4598 accessmode
= FILE_GENERIC_WRITE
& ~FILE_WRITE_DATA
;
4599 flags
= OPEN_ALWAYS
;
4601 /* Truncate file if it already exists. */
4602 accessmode
= GENERIC_WRITE
;
4603 flags
= CREATE_ALWAYS
;
4606 out
= CreateFile(file
->out
, accessmode
, FILE_SHARE_READ
, NULL
, flags
,
4607 FILE_ATTRIBUTE_NORMAL
, NULL
);
4608 if (out
== INVALID_HANDLE_VALUE
) {
4609 error_setg(errp
, "open %s failed", file
->out
);
4613 qemu_chr_open_win_file(chr
, out
);
4616 static void qmp_chardev_open_serial(Chardev
*chr
,
4617 ChardevBackend
*backend
,
4621 ChardevHostdev
*serial
= backend
->u
.serial
.data
;
4623 win_chr_init(chr
, serial
->device
, errp
);
4628 static int qmp_chardev_open_file_source(char *src
, int flags
,
4633 TFR(fd
= qemu_open(src
, flags
, 0666));
4635 error_setg_file_open(errp
, errno
, src
);
4640 static void qmp_chardev_open_file(Chardev
*chr
,
4641 ChardevBackend
*backend
,
4645 ChardevFile
*file
= backend
->u
.file
.data
;
4646 int flags
, in
= -1, out
;
4648 flags
= O_WRONLY
| O_CREAT
| O_BINARY
;
4649 if (file
->has_append
&& file
->append
) {
4655 out
= qmp_chardev_open_file_source(file
->out
, flags
, errp
);
4662 in
= qmp_chardev_open_file_source(file
->in
, flags
, errp
);
4669 qemu_chr_open_fd(chr
, in
, out
);
4672 #ifdef HAVE_CHARDEV_SERIAL
4673 static void qmp_chardev_open_serial(Chardev
*chr
,
4674 ChardevBackend
*backend
,
4678 ChardevHostdev
*serial
= backend
->u
.serial
.data
;
4681 fd
= qmp_chardev_open_file_source(serial
->device
, O_RDWR
, errp
);
4685 qemu_set_nonblock(fd
);
4686 tty_serial_init(fd
, 115200, 'N', 8, 1);
4688 qemu_chr_open_fd(chr
, fd
, fd
);
4692 #ifdef HAVE_CHARDEV_PARPORT
4693 static void qmp_chardev_open_parallel(Chardev
*chr
,
4694 ChardevBackend
*backend
,
4698 ChardevHostdev
*parallel
= backend
->u
.parallel
.data
;
4701 fd
= qmp_chardev_open_file_source(parallel
->device
, O_RDWR
, errp
);
4705 qemu_chr_open_pp_fd(chr
, fd
, be_opened
, errp
);
4708 static void char_parallel_class_init(ObjectClass
*oc
, void *data
)
4710 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4712 cc
->parse
= qemu_chr_parse_parallel
;
4713 cc
->open
= qmp_chardev_open_parallel
;
4714 #if defined(__linux__)
4715 cc
->chr_write
= null_chr_write
;
4716 cc
->chr_ioctl
= pp_ioctl
;
4717 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4718 cc
->chr_write
= null_chr_write
;
4719 cc
->chr_ioctl
= pp_ioctl
;
4723 static void char_parallel_finalize(Object
*obj
)
4725 #if defined(__linux__)
4726 Chardev
*chr
= CHARDEV(obj
);
4727 ParallelChardev
*drv
= PARALLEL_CHARDEV(chr
);
4730 pp_hw_mode(drv
, IEEE1284_MODE_COMPAT
);
4731 ioctl(fd
, PPRELEASE
);
4733 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
4734 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4735 /* FIXME: close fd? */
4739 static const TypeInfo char_parallel_type_info
= {
4740 .name
= TYPE_CHARDEV_PARALLEL
,
4741 .parent
= TYPE_CHARDEV
,
4742 .instance_size
= sizeof(ParallelChardev
),
4743 .instance_finalize
= char_parallel_finalize
,
4744 .class_init
= char_parallel_class_init
,
4750 static void char_file_class_init(ObjectClass
*oc
, void *data
)
4752 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4754 cc
->parse
= qemu_chr_parse_file_out
;
4755 cc
->open
= qmp_chardev_open_file
;
4758 static const TypeInfo char_file_type_info
= {
4759 .name
= TYPE_CHARDEV_FILE
,
4761 .parent
= TYPE_CHARDEV_WIN
,
4763 .parent
= TYPE_CHARDEV_FD
,
4765 .class_init
= char_file_class_init
,
4768 #ifdef HAVE_CHARDEV_SERIAL
4770 static void char_serial_class_init(ObjectClass
*oc
, void *data
)
4772 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4774 cc
->parse
= qemu_chr_parse_serial
;
4775 cc
->open
= qmp_chardev_open_serial
;
4777 cc
->chr_ioctl
= tty_serial_ioctl
;
4781 static const TypeInfo char_serial_type_info
= {
4782 .name
= TYPE_CHARDEV_SERIAL
,
4784 .parent
= TYPE_CHARDEV_WIN
,
4786 .parent
= TYPE_CHARDEV_FD
,
4788 .class_init
= char_serial_class_init
,
4792 static gboolean
socket_reconnect_timeout(gpointer opaque
)
4794 Chardev
*chr
= CHARDEV(opaque
);
4795 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
4796 QIOChannelSocket
*sioc
;
4798 s
->reconnect_timer
= 0;
4804 sioc
= qio_channel_socket_new();
4805 tcp_chr_set_client_ioc_name(chr
, sioc
);
4806 qio_channel_socket_connect_async(sioc
, s
->addr
,
4807 qemu_chr_socket_connected
,
4813 static void qmp_chardev_open_socket(Chardev
*chr
,
4814 ChardevBackend
*backend
,
4818 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
4819 ChardevSocket
*sock
= backend
->u
.socket
.data
;
4820 SocketAddress
*addr
= sock
->addr
;
4821 bool do_nodelay
= sock
->has_nodelay
? sock
->nodelay
: false;
4822 bool is_listen
= sock
->has_server
? sock
->server
: true;
4823 bool is_telnet
= sock
->has_telnet
? sock
->telnet
: false;
4824 bool is_waitconnect
= sock
->has_wait
? sock
->wait
: false;
4825 int64_t reconnect
= sock
->has_reconnect
? sock
->reconnect
: 0;
4826 QIOChannelSocket
*sioc
= NULL
;
4828 s
->is_unix
= addr
->type
== SOCKET_ADDRESS_KIND_UNIX
;
4829 s
->is_listen
= is_listen
;
4830 s
->is_telnet
= is_telnet
;
4831 s
->do_nodelay
= do_nodelay
;
4832 if (sock
->tls_creds
) {
4834 creds
= object_resolve_path_component(
4835 object_get_objects_root(), sock
->tls_creds
);
4837 error_setg(errp
, "No TLS credentials with id '%s'",
4841 s
->tls_creds
= (QCryptoTLSCreds
*)
4842 object_dynamic_cast(creds
,
4843 TYPE_QCRYPTO_TLS_CREDS
);
4844 if (!s
->tls_creds
) {
4845 error_setg(errp
, "Object with id '%s' is not TLS credentials",
4849 object_ref(OBJECT(s
->tls_creds
));
4851 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
4852 error_setg(errp
, "%s",
4853 "Expected TLS credentials for server endpoint");
4857 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT
) {
4858 error_setg(errp
, "%s",
4859 "Expected TLS credentials for client endpoint");
4865 s
->addr
= QAPI_CLONE(SocketAddress
, sock
->addr
);
4867 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_RECONNECTABLE
);
4869 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_FD_PASS
);
4872 /* be isn't opened until we get a connection */
4875 chr
->filename
= SocketAddress_to_str("disconnected:",
4876 addr
, is_listen
, is_telnet
);
4880 s
->do_telnetopt
= 1;
4882 } else if (reconnect
> 0) {
4883 s
->reconnect_time
= reconnect
;
4886 if (s
->reconnect_time
) {
4887 sioc
= qio_channel_socket_new();
4888 tcp_chr_set_client_ioc_name(chr
, sioc
);
4889 qio_channel_socket_connect_async(sioc
, s
->addr
,
4890 qemu_chr_socket_connected
,
4895 sioc
= qio_channel_socket_new();
4897 name
= g_strdup_printf("chardev-tcp-listener-%s", chr
->label
);
4898 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
4901 if (qio_channel_socket_listen_sync(sioc
, s
->addr
, errp
) < 0) {
4904 s
->listen_ioc
= sioc
;
4905 if (is_waitconnect
&&
4906 qemu_chr_wait_connected(chr
, errp
) < 0) {
4910 s
->listen_tag
= qio_channel_add_watch(
4911 QIO_CHANNEL(s
->listen_ioc
), G_IO_IN
,
4912 tcp_chr_accept
, chr
, NULL
);
4914 } else if (qemu_chr_wait_connected(chr
, errp
) < 0) {
4923 object_unref(OBJECT(sioc
));
4927 static void char_socket_class_init(ObjectClass
*oc
, void *data
)
4929 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4931 cc
->parse
= qemu_chr_parse_socket
;
4932 cc
->open
= qmp_chardev_open_socket
;
4933 cc
->chr_wait_connected
= tcp_chr_wait_connected
;
4934 cc
->chr_write
= tcp_chr_write
;
4935 cc
->chr_sync_read
= tcp_chr_sync_read
;
4936 cc
->chr_disconnect
= tcp_chr_disconnect
;
4937 cc
->get_msgfds
= tcp_get_msgfds
;
4938 cc
->set_msgfds
= tcp_set_msgfds
;
4939 cc
->chr_add_client
= tcp_chr_add_client
;
4940 cc
->chr_add_watch
= tcp_chr_add_watch
;
4941 cc
->chr_update_read_handler
= tcp_chr_update_read_handler
;
4944 static const TypeInfo char_socket_type_info
= {
4945 .name
= TYPE_CHARDEV_SOCKET
,
4946 .parent
= TYPE_CHARDEV
,
4947 .instance_size
= sizeof(SocketChardev
),
4948 .instance_finalize
= char_socket_finalize
,
4949 .class_init
= char_socket_class_init
,
4952 static void qmp_chardev_open_udp(Chardev
*chr
,
4953 ChardevBackend
*backend
,
4957 ChardevUdp
*udp
= backend
->u
.udp
.data
;
4958 QIOChannelSocket
*sioc
= qio_channel_socket_new();
4960 UdpChardev
*s
= UDP_CHARDEV(chr
);
4962 if (qio_channel_socket_dgram_sync(sioc
,
4963 udp
->local
, udp
->remote
,
4965 object_unref(OBJECT(sioc
));
4969 name
= g_strdup_printf("chardev-udp-%s", chr
->label
);
4970 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
4973 s
->ioc
= QIO_CHANNEL(sioc
);
4974 /* be isn't opened until we get a connection */
4978 static void char_udp_class_init(ObjectClass
*oc
, void *data
)
4980 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
4982 cc
->parse
= qemu_chr_parse_udp
;
4983 cc
->open
= qmp_chardev_open_udp
;
4984 cc
->chr_write
= udp_chr_write
;
4985 cc
->chr_update_read_handler
= udp_chr_update_read_handler
;
4988 static const TypeInfo char_udp_type_info
= {
4989 .name
= TYPE_CHARDEV_UDP
,
4990 .parent
= TYPE_CHARDEV
,
4991 .instance_size
= sizeof(UdpChardev
),
4992 .instance_finalize
= char_udp_finalize
,
4993 .class_init
= char_udp_class_init
,
4996 bool qemu_chr_has_feature(Chardev
*chr
,
4997 ChardevFeature feature
)
4999 return test_bit(feature
, chr
->features
);
5002 void qemu_chr_set_feature(Chardev
*chr
,
5003 ChardevFeature feature
)
5005 return set_bit(feature
, chr
->features
);
5008 Chardev
*qemu_chardev_new(const char *id
, const char *typename
,
5009 ChardevBackend
*backend
, Error
**errp
)
5011 Chardev
*chr
= NULL
;
5012 Error
*local_err
= NULL
;
5013 bool be_opened
= true;
5015 assert(g_str_has_prefix(typename
, "chardev-"));
5017 chr
= CHARDEV(object_new(typename
));
5018 chr
->label
= g_strdup(id
);
5020 qemu_char_open(chr
, backend
, &be_opened
, &local_err
);
5022 error_propagate(errp
, local_err
);
5023 object_unref(OBJECT(chr
));
5027 if (!chr
->filename
) {
5028 chr
->filename
= g_strdup(typename
+ 8);
5031 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
5037 ChardevReturn
*qmp_chardev_add(const char *id
, ChardevBackend
*backend
,
5040 const ChardevClass
*cc
;
5044 cc
= char_get_class(ChardevBackendKind_lookup
[backend
->type
], errp
);
5049 chr
= qemu_chardev_add(id
, object_class_get_name(OBJECT_CLASS(cc
)),
5055 ret
= g_new0(ChardevReturn
, 1);
5056 if (CHARDEV_IS_PTY(chr
)) {
5057 ret
->pty
= g_strdup(chr
->filename
+ 4);
5058 ret
->has_pty
= true;
5064 void qmp_chardev_remove(const char *id
, Error
**errp
)
5068 chr
= qemu_chr_find(id
);
5070 error_setg(errp
, "Chardev '%s' not found", id
);
5073 if (qemu_chr_is_busy(chr
)) {
5074 error_setg(errp
, "Chardev '%s' is busy", id
);
5077 if (qemu_chr_replay(chr
)) {
5079 "Chardev '%s' cannot be unplugged in record/replay mode", id
);
5082 qemu_chr_delete(chr
);
5085 void qemu_chr_cleanup(void)
5089 QTAILQ_FOREACH_SAFE(chr
, &chardevs
, next
, tmp
) {
5090 qemu_chr_delete(chr
);
5094 static void register_types(void)
5096 type_register_static(&char_type_info
);
5098 type_register_static(&char_fd_type_info
);
5100 type_register_static(&char_win_type_info
);
5101 type_register_static(&char_win_stdio_type_info
);
5103 type_register_static(&char_null_type_info
);
5104 type_register_static(&char_socket_type_info
);
5105 type_register_static(&char_udp_type_info
);
5106 type_register_static(&char_ringbuf_type_info
);
5107 type_register_static(&char_file_type_info
);
5108 type_register_static(&char_stdio_type_info
);
5109 #ifdef HAVE_CHARDEV_SERIAL
5110 type_register_static(&char_serial_type_info
);
5112 #ifdef HAVE_CHARDEV_PARPORT
5113 type_register_static(&char_parallel_type_info
);
5115 #ifdef HAVE_CHARDEV_PTY
5116 type_register_static(&char_pty_type_info
);
5119 type_register_static(&char_console_type_info
);
5121 type_register_static(&char_pipe_type_info
);
5122 type_register_static(&char_mux_type_info
);
5123 type_register_static(&char_memory_type_info
);
5125 /* this must be done after machine init, since we register FEs with muxes
5126 * as part of realize functions like serial_isa_realizefn when -nographic
5129 qemu_add_machine_init_done_notifier(&muxes_realize_notify
);
5132 type_init(register_types
);