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/qmp-input-visitor.h"
36 #include "qapi/qmp-output-visitor.h"
37 #include "qapi-visit.h"
38 #include "qemu/base64.h"
39 #include "io/channel-socket.h"
40 #include "io/channel-file.h"
41 #include "io/channel-tls.h"
42 #include "sysemu/replay.h"
47 #include <sys/times.h>
51 #include <sys/ioctl.h>
52 #include <sys/resource.h>
53 #include <sys/socket.h>
54 #include <netinet/in.h>
56 #include <arpa/inet.h>
58 #include <sys/select.h>
60 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
61 #include <dev/ppbus/ppi.h>
62 #include <dev/ppbus/ppbconf.h>
63 #elif defined(__DragonFly__)
64 #include <dev/misc/ppi/ppi.h>
65 #include <bus/ppbus/ppbconf.h>
69 #include <linux/ppdev.h>
70 #include <linux/parport.h>
73 #include <sys/ethernet.h>
74 #include <sys/sockio.h>
75 #include <netinet/arp.h>
76 #include <netinet/in.h>
77 #include <netinet/in_systm.h>
78 #include <netinet/ip.h>
79 #include <netinet/ip_icmp.h> // must come after ip.h
80 #include <netinet/udp.h>
81 #include <netinet/tcp.h>
86 #include "qemu/sockets.h"
87 #include "ui/qemu-spice.h"
89 #define READ_BUF_LEN 4096
90 #define READ_RETRIES 10
91 #define TCP_MAX_FDS 16
93 /***********************************************************/
94 /* Socket address helpers */
96 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
97 bool is_listen, bool is_telnet)
100 case SOCKET_ADDRESS_KIND_INET:
101 return g_strdup_printf("%s%s:%s:%s%s", prefix,
102 is_telnet ? "telnet" : "tcp",
103 addr->u.inet.data->host,
104 addr->u.inet.data->port,
105 is_listen ? ",server" : "");
107 case SOCKET_ADDRESS_KIND_UNIX:
108 return g_strdup_printf("%sunix:%s%s", prefix,
109 addr->u.q_unix.data->path,
110 is_listen ? ",server" : "");
112 case SOCKET_ADDRESS_KIND_FD:
113 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.data->str,
114 is_listen ? ",server" : "");
121 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
122 struct sockaddr_storage *ps, socklen_t ps_len,
123 bool is_listen, bool is_telnet)
125 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
126 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
127 const char *left = "", *right = "";
129 switch (ss->ss_family) {
132 return g_strdup_printf("unix:%s%s",
133 ((struct sockaddr_un *)(ss))->sun_path,
134 is_listen ? ",server" : "");
141 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
142 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
143 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
144 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
145 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
146 is_telnet ? "telnet" : "tcp",
147 left, shost, right, sserv,
148 is_listen ? ",server" : "",
149 left, phost, right, pserv);
152 return g_strdup_printf("unknown");
156 /***********************************************************/
157 /* character device */
159 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
160 QTAILQ_HEAD_INITIALIZER(chardevs);
162 static void qemu_chr_free_common(CharDriverState *chr);
164 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp)
166 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
167 qemu_mutex_init(&chr->chr_write_lock);
169 if (backend->has_logfile) {
170 int flags = O_WRONLY | O_CREAT;
171 if (backend->has_logappend &&
172 backend->logappend) {
177 chr->logfd = qemu_open(backend->logfile, flags, 0666);
178 if (chr->logfd < 0) {
179 error_setg_errno(errp, errno,
180 "Unable to open logfile %s",
192 void qemu_chr_be_event(CharDriverState *s, int event)
194 /* Keep track if the char device is open */
196 case CHR_EVENT_OPENED:
199 case CHR_EVENT_CLOSED:
206 s->chr_event(s->handler_opaque, event);
209 void qemu_chr_be_generic_open(CharDriverState *s)
211 qemu_chr_be_event(s, CHR_EVENT_OPENED);
215 /* Not reporting errors from writing to logfile, as logs are
216 * defined to be "best effort" only */
217 static void qemu_chr_fe_write_log(CharDriverState *s,
218 const uint8_t *buf, size_t len)
229 ret = write(s->logfd, buf + done, len - done);
230 if (ret == -1 && errno == EAGAIN) {
242 static int qemu_chr_fe_write_buffer(CharDriverState *s, const uint8_t *buf, int len, int *offset)
247 qemu_mutex_lock(&s->chr_write_lock);
248 while (*offset < len) {
250 res = s->chr_write(s, buf + *offset, len - *offset);
251 if (res < 0 && errno == EAGAIN) {
263 qemu_chr_fe_write_log(s, buf, *offset);
265 qemu_mutex_unlock(&s->chr_write_lock);
270 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len)
274 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
276 replay_char_write_event_load(&ret, &offset);
277 assert(offset <= len);
278 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
282 qemu_mutex_lock(&s->chr_write_lock);
283 ret = s->chr_write(s, buf, len);
286 qemu_chr_fe_write_log(s, buf, ret);
289 qemu_mutex_unlock(&s->chr_write_lock);
291 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
292 replay_char_write_event_save(ret, ret < 0 ? 0 : ret);
298 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len)
303 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
304 replay_char_write_event_load(&res, &offset);
305 assert(offset <= len);
306 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
310 res = qemu_chr_fe_write_buffer(s, buf, len, &offset);
312 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
313 replay_char_write_event_save(res, offset);
322 int qemu_chr_fe_read_all(CharDriverState *s, uint8_t *buf, int len)
324 int offset = 0, counter = 10;
327 if (!s->chr_sync_read) {
331 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
332 return replay_char_read_all_load(buf);
335 while (offset < len) {
337 res = s->chr_sync_read(s, buf + offset, len - offset);
338 if (res == -1 && errno == EAGAIN) {
348 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
349 replay_char_read_all_save_error(res);
361 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
362 replay_char_read_all_save_buf(buf, offset);
367 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg)
370 if (!s->chr_ioctl || s->replay) {
373 res = s->chr_ioctl(s, cmd, arg);
379 int qemu_chr_be_can_write(CharDriverState *s)
381 if (!s->chr_can_read)
383 return s->chr_can_read(s->handler_opaque);
386 void qemu_chr_be_write_impl(CharDriverState *s, uint8_t *buf, int len)
389 s->chr_read(s->handler_opaque, buf, len);
393 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
396 if (replay_mode == REPLAY_MODE_PLAY) {
399 replay_chr_be_write(s, buf, len);
401 qemu_chr_be_write_impl(s, buf, len);
405 int qemu_chr_fe_get_msgfd(CharDriverState *s)
408 int res = (qemu_chr_fe_get_msgfds(s, &fd, 1) == 1) ? fd : -1;
411 "Replay: get msgfd is not supported for serial devices yet\n");
417 int qemu_chr_fe_get_msgfds(CharDriverState *s, int *fds, int len)
419 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
422 int qemu_chr_fe_set_msgfds(CharDriverState *s, int *fds, int num)
424 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
427 int qemu_chr_add_client(CharDriverState *s, int fd)
429 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
432 void qemu_chr_accept_input(CharDriverState *s)
434 if (s->chr_accept_input)
435 s->chr_accept_input(s);
439 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
441 char buf[READ_BUF_LEN];
444 vsnprintf(buf, sizeof(buf), fmt, ap);
445 qemu_chr_fe_write(s, (uint8_t *)buf, strlen(buf));
449 static void remove_fd_in_watch(CharDriverState *chr);
451 void qemu_chr_add_handlers(CharDriverState *s,
452 IOCanReadHandler *fd_can_read,
453 IOReadHandler *fd_read,
454 IOEventHandler *fd_event,
459 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
461 remove_fd_in_watch(s);
465 s->chr_can_read = fd_can_read;
466 s->chr_read = fd_read;
467 s->chr_event = fd_event;
468 s->handler_opaque = opaque;
469 if (fe_open && s->chr_update_read_handler)
470 s->chr_update_read_handler(s);
472 if (!s->explicit_fe_open) {
473 qemu_chr_fe_set_open(s, fe_open);
476 /* We're connecting to an already opened device, so let's make sure we
477 also get the open event */
478 if (fe_open && s->be_open) {
479 qemu_chr_be_generic_open(s);
483 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
488 static CharDriverState *qemu_chr_open_null(const char *id,
489 ChardevBackend *backend,
493 CharDriverState *chr;
494 ChardevCommon *common = backend->u.null.data;
496 chr = qemu_chr_alloc(common, errp);
500 chr->chr_write = null_chr_write;
501 chr->explicit_be_open = true;
505 /* MUX driver for serial I/O splitting */
507 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
508 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
510 IOCanReadHandler *chr_can_read[MAX_MUX];
511 IOReadHandler *chr_read[MAX_MUX];
512 IOEventHandler *chr_event[MAX_MUX];
513 void *ext_opaque[MAX_MUX];
514 CharDriverState *drv;
519 /* Intermediate input buffer allows to catch escape sequences even if the
520 currently active device is not accepting any input - but only until it
522 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
527 /* Protected by the CharDriverState chr_write_lock. */
529 int64_t timestamps_start;
533 /* Called with chr_write_lock held. */
534 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
536 MuxDriver *d = chr->opaque;
538 if (!d->timestamps) {
539 ret = qemu_chr_fe_write(d->drv, buf, len);
544 for (i = 0; i < len; i++) {
550 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
551 if (d->timestamps_start == -1)
552 d->timestamps_start = ti;
553 ti -= d->timestamps_start;
555 snprintf(buf1, sizeof(buf1),
556 "[%02d:%02d:%02d.%03d] ",
561 qemu_chr_fe_write(d->drv, (uint8_t *)buf1, strlen(buf1));
564 ret += qemu_chr_fe_write(d->drv, buf+i, 1);
565 if (buf[i] == '\n') {
573 static const char * const mux_help[] = {
574 "% h print this help\n\r",
575 "% x exit emulator\n\r",
576 "% s save disk data back to file (if -snapshot)\n\r",
577 "% t toggle console timestamps\n\r",
578 "% b send break (magic sysrq)\n\r",
579 "% c switch between console and monitor\n\r",
584 int term_escape_char = 0x01; /* ctrl-a is used for escape */
585 static void mux_print_help(CharDriverState *chr)
588 char ebuf[15] = "Escape-Char";
589 char cbuf[50] = "\n\r";
591 if (term_escape_char > 0 && term_escape_char < 26) {
592 snprintf(cbuf, sizeof(cbuf), "\n\r");
593 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
595 snprintf(cbuf, sizeof(cbuf),
596 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
599 qemu_chr_fe_write(chr, (uint8_t *)cbuf, strlen(cbuf));
600 for (i = 0; mux_help[i] != NULL; i++) {
601 for (j=0; mux_help[i][j] != '\0'; j++) {
602 if (mux_help[i][j] == '%')
603 qemu_chr_fe_write(chr, (uint8_t *)ebuf, strlen(ebuf));
605 qemu_chr_fe_write(chr, (uint8_t *)&mux_help[i][j], 1);
610 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
612 if (d->chr_event[mux_nr])
613 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
616 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
618 if (d->term_got_escape) {
619 d->term_got_escape = 0;
620 if (ch == term_escape_char)
629 const char *term = "QEMU: Terminated\n\r";
630 qemu_chr_fe_write(chr, (uint8_t *)term, strlen(term));
638 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
641 /* Switch to the next registered device */
642 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
644 if (d->focus >= d->mux_cnt)
646 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
649 d->timestamps = !d->timestamps;
650 d->timestamps_start = -1;
654 } else if (ch == term_escape_char) {
655 d->term_got_escape = 1;
663 static void mux_chr_accept_input(CharDriverState *chr)
665 MuxDriver *d = chr->opaque;
668 while (d->prod[m] != d->cons[m] &&
669 d->chr_can_read[m] &&
670 d->chr_can_read[m](d->ext_opaque[m])) {
671 d->chr_read[m](d->ext_opaque[m],
672 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
676 static int mux_chr_can_read(void *opaque)
678 CharDriverState *chr = opaque;
679 MuxDriver *d = chr->opaque;
682 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
684 if (d->chr_can_read[m])
685 return d->chr_can_read[m](d->ext_opaque[m]);
689 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
691 CharDriverState *chr = opaque;
692 MuxDriver *d = chr->opaque;
696 mux_chr_accept_input (opaque);
698 for(i = 0; i < size; i++)
699 if (mux_proc_byte(chr, d, buf[i])) {
700 if (d->prod[m] == d->cons[m] &&
701 d->chr_can_read[m] &&
702 d->chr_can_read[m](d->ext_opaque[m]))
703 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
705 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
709 static void mux_chr_event(void *opaque, int event)
711 CharDriverState *chr = opaque;
712 MuxDriver *d = chr->opaque;
715 /* Send the event to all registered listeners */
716 for (i = 0; i < d->mux_cnt; i++)
717 mux_chr_send_event(d, i, event);
720 static void mux_chr_update_read_handler(CharDriverState *chr)
722 MuxDriver *d = chr->opaque;
724 if (d->mux_cnt >= MAX_MUX) {
725 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
728 d->ext_opaque[d->mux_cnt] = chr->handler_opaque;
729 d->chr_can_read[d->mux_cnt] = chr->chr_can_read;
730 d->chr_read[d->mux_cnt] = chr->chr_read;
731 d->chr_event[d->mux_cnt] = chr->chr_event;
732 /* Fix up the real driver with mux routines */
733 if (d->mux_cnt == 0) {
734 qemu_chr_add_handlers(d->drv, mux_chr_can_read, mux_chr_read,
737 if (d->focus != -1) {
738 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
740 d->focus = d->mux_cnt;
742 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
745 static bool muxes_realized;
748 * Called after processing of default and command-line-specified
749 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
750 * to a mux chardev. This is done here to ensure that
751 * output/prompts/banners are only displayed for the FE that has
752 * focus when initial command-line processing/machine init is
755 * After this point, any new FE attached to any new or existing
756 * mux will receive CHR_EVENT_OPENED notifications for the BE
759 static void muxes_realize_done(Notifier *notifier, void *unused)
761 CharDriverState *chr;
763 QTAILQ_FOREACH(chr, &chardevs, next) {
765 MuxDriver *d = chr->opaque;
768 /* send OPENED to all already-attached FEs */
769 for (i = 0; i < d->mux_cnt; i++) {
770 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
772 /* mark mux as OPENED so any new FEs will immediately receive
775 qemu_chr_be_generic_open(chr);
778 muxes_realized = true;
781 static Notifier muxes_realize_notify = {
782 .notify = muxes_realize_done,
785 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
787 MuxDriver *d = s->opaque;
788 return d->drv->chr_add_watch(d->drv, cond);
791 static CharDriverState *qemu_chr_open_mux(const char *id,
792 ChardevBackend *backend,
793 ChardevReturn *ret, Error **errp)
795 ChardevMux *mux = backend->u.mux.data;
796 CharDriverState *chr, *drv;
798 ChardevCommon *common = qapi_ChardevMux_base(mux);
800 drv = qemu_chr_find(mux->chardev);
802 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
806 chr = qemu_chr_alloc(common, errp);
810 d = g_new0(MuxDriver, 1);
815 chr->chr_write = mux_chr_write;
816 chr->chr_update_read_handler = mux_chr_update_read_handler;
817 chr->chr_accept_input = mux_chr_accept_input;
818 /* Frontend guest-open / -close notification is not support with muxes */
819 chr->chr_set_fe_open = NULL;
820 if (drv->chr_add_watch) {
821 chr->chr_add_watch = mux_chr_add_watch;
823 /* only default to opened state if we've realized the initial
826 chr->explicit_be_open = muxes_realized ? 0 : 1;
833 typedef struct IOWatchPoll
840 IOCanReadHandler *fd_can_read;
845 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
847 return container_of(source, IOWatchPoll, parent);
850 static gboolean io_watch_poll_prepare(GSource *source, gint *timeout_)
852 IOWatchPoll *iwp = io_watch_poll_from_source(source);
853 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
854 bool was_active = iwp->src != NULL;
855 if (was_active == now_active) {
860 iwp->src = qio_channel_create_watch(
861 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
862 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
863 g_source_attach(iwp->src, NULL);
865 g_source_destroy(iwp->src);
866 g_source_unref(iwp->src);
872 static gboolean io_watch_poll_check(GSource *source)
877 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
883 static void io_watch_poll_finalize(GSource *source)
885 /* Due to a glib bug, removing the last reference to a source
886 * inside a finalize callback causes recursive locking (and a
887 * deadlock). This is not a problem inside other callbacks,
888 * including dispatch callbacks, so we call io_remove_watch_poll
889 * to remove this source. At this point, iwp->src must
890 * be NULL, or we would leak it.
892 * This would be solved much more elegantly by child sources,
893 * but we support older glib versions that do not have them.
895 IOWatchPoll *iwp = io_watch_poll_from_source(source);
896 assert(iwp->src == NULL);
899 static GSourceFuncs io_watch_poll_funcs = {
900 .prepare = io_watch_poll_prepare,
901 .check = io_watch_poll_check,
902 .dispatch = io_watch_poll_dispatch,
903 .finalize = io_watch_poll_finalize,
906 /* Can only be used for read */
907 static guint io_add_watch_poll(QIOChannel *ioc,
908 IOCanReadHandler *fd_can_read,
909 QIOChannelFunc fd_read,
915 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs, sizeof(IOWatchPoll));
916 iwp->fd_can_read = fd_can_read;
917 iwp->opaque = user_data;
919 iwp->fd_read = (GSourceFunc) fd_read;
922 tag = g_source_attach(&iwp->parent, NULL);
923 g_source_unref(&iwp->parent);
927 static void io_remove_watch_poll(guint tag)
932 g_return_if_fail (tag > 0);
934 source = g_main_context_find_source_by_id(NULL, tag);
935 g_return_if_fail (source != NULL);
937 iwp = io_watch_poll_from_source(source);
939 g_source_destroy(iwp->src);
940 g_source_unref(iwp->src);
943 g_source_destroy(&iwp->parent);
946 static void remove_fd_in_watch(CharDriverState *chr)
948 if (chr->fd_in_tag) {
949 io_remove_watch_poll(chr->fd_in_tag);
955 static int io_channel_send_full(QIOChannel *ioc,
956 const void *buf, size_t len,
957 int *fds, size_t nfds)
961 while (offset < len) {
963 struct iovec iov = { .iov_base = (char *)buf + offset,
964 .iov_len = len - offset };
966 ret = qio_channel_writev_full(
969 if (ret == QIO_CHANNEL_ERR_BLOCK) {
976 } else if (ret < 0) {
989 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
991 return io_channel_send_full(ioc, buf, len, NULL, 0);
995 typedef struct FDCharDriver {
996 CharDriverState *chr;
997 QIOChannel *ioc_in, *ioc_out;
1001 /* Called with chr_write_lock held. */
1002 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1004 FDCharDriver *s = chr->opaque;
1006 return io_channel_send(s->ioc_out, buf, len);
1009 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1011 CharDriverState *chr = opaque;
1012 FDCharDriver *s = chr->opaque;
1014 uint8_t buf[READ_BUF_LEN];
1018 if (len > s->max_size) {
1025 ret = qio_channel_read(
1026 chan, (gchar *)buf, len, NULL);
1028 remove_fd_in_watch(chr);
1029 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1033 qemu_chr_be_write(chr, buf, ret);
1039 static int fd_chr_read_poll(void *opaque)
1041 CharDriverState *chr = opaque;
1042 FDCharDriver *s = chr->opaque;
1044 s->max_size = qemu_chr_be_can_write(chr);
1048 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1050 FDCharDriver *s = chr->opaque;
1051 return qio_channel_create_watch(s->ioc_out, cond);
1054 static void fd_chr_update_read_handler(CharDriverState *chr)
1056 FDCharDriver *s = chr->opaque;
1058 remove_fd_in_watch(chr);
1060 chr->fd_in_tag = io_add_watch_poll(s->ioc_in,
1066 static void fd_chr_close(struct CharDriverState *chr)
1068 FDCharDriver *s = chr->opaque;
1070 remove_fd_in_watch(chr);
1072 object_unref(OBJECT(s->ioc_in));
1075 object_unref(OBJECT(s->ioc_out));
1079 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1082 /* open a character device to a unix fd */
1083 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out,
1084 ChardevCommon *backend, Error **errp)
1086 CharDriverState *chr;
1089 chr = qemu_chr_alloc(backend, errp);
1093 s = g_new0(FDCharDriver, 1);
1094 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1095 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1096 qemu_set_nonblock(fd_out);
1099 chr->chr_add_watch = fd_chr_add_watch;
1100 chr->chr_write = fd_chr_write;
1101 chr->chr_update_read_handler = fd_chr_update_read_handler;
1102 chr->chr_close = fd_chr_close;
1107 static CharDriverState *qemu_chr_open_pipe(const char *id,
1108 ChardevBackend *backend,
1112 ChardevHostdev *opts = backend->u.pipe.data;
1116 const char *filename = opts->device;
1117 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
1120 filename_in = g_strdup_printf("%s.in", filename);
1121 filename_out = g_strdup_printf("%s.out", filename);
1122 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1123 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1124 g_free(filename_in);
1125 g_free(filename_out);
1126 if (fd_in < 0 || fd_out < 0) {
1131 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1133 error_setg_file_open(errp, errno, filename);
1137 return qemu_chr_open_fd(fd_in, fd_out, common, errp);
1140 /* init terminal so that we can grab keys */
1141 static struct termios oldtty;
1142 static int old_fd0_flags;
1143 static bool stdio_in_use;
1144 static bool stdio_allow_signal;
1145 static bool stdio_echo_state;
1147 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1149 static void term_exit(void)
1151 tcsetattr (0, TCSANOW, &oldtty);
1152 fcntl(0, F_SETFL, old_fd0_flags);
1155 static void term_stdio_handler(int sig)
1157 /* restore echo after resume from suspend. */
1158 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1161 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1165 stdio_echo_state = echo;
1168 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1169 |INLCR|IGNCR|ICRNL|IXON);
1170 tty.c_oflag |= OPOST;
1171 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1172 tty.c_cflag &= ~(CSIZE|PARENB);
1175 tty.c_cc[VTIME] = 0;
1177 if (!stdio_allow_signal)
1178 tty.c_lflag &= ~ISIG;
1180 tcsetattr (0, TCSANOW, &tty);
1183 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1189 static CharDriverState *qemu_chr_open_stdio(const char *id,
1190 ChardevBackend *backend,
1194 ChardevStdio *opts = backend->u.stdio.data;
1195 CharDriverState *chr;
1196 struct sigaction act;
1197 ChardevCommon *common = qapi_ChardevStdio_base(opts);
1199 if (is_daemonized()) {
1200 error_setg(errp, "cannot use stdio with -daemonize");
1205 error_setg(errp, "cannot use stdio by multiple character devices");
1209 stdio_in_use = true;
1210 old_fd0_flags = fcntl(0, F_GETFL);
1211 tcgetattr(0, &oldtty);
1212 qemu_set_nonblock(0);
1215 memset(&act, 0, sizeof(act));
1216 act.sa_handler = term_stdio_handler;
1217 sigaction(SIGCONT, &act, NULL);
1219 chr = qemu_chr_open_fd(0, 1, common, errp);
1220 chr->chr_close = qemu_chr_close_stdio;
1221 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1222 if (opts->has_signal) {
1223 stdio_allow_signal = opts->signal;
1225 qemu_chr_fe_set_echo(chr, false);
1230 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1231 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1232 || defined(__GLIBC__)
1234 #define HAVE_CHARDEV_SERIAL 1
1235 #define HAVE_CHARDEV_PTY 1
1241 /* Protected by the CharDriverState chr_write_lock. */
1247 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1248 static void pty_chr_state(CharDriverState *chr, int connected);
1250 static gboolean pty_chr_timer(gpointer opaque)
1252 struct CharDriverState *chr = opaque;
1253 PtyCharDriver *s = chr->opaque;
1255 qemu_mutex_lock(&chr->chr_write_lock);
1258 if (!s->connected) {
1260 pty_chr_update_read_handler_locked(chr);
1262 qemu_mutex_unlock(&chr->chr_write_lock);
1266 /* Called with chr_write_lock held. */
1267 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1269 PtyCharDriver *s = chr->opaque;
1272 g_source_remove(s->timer_tag);
1277 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1279 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1283 /* Called with chr_write_lock held. */
1284 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1286 PtyCharDriver *s = chr->opaque;
1289 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1292 pfd.events = G_IO_OUT;
1295 rc = g_poll(&pfd, 1, 0);
1296 } while (rc == -1 && errno == EINTR);
1299 if (pfd.revents & G_IO_HUP) {
1300 pty_chr_state(chr, 0);
1302 pty_chr_state(chr, 1);
1306 static void pty_chr_update_read_handler(CharDriverState *chr)
1308 qemu_mutex_lock(&chr->chr_write_lock);
1309 pty_chr_update_read_handler_locked(chr);
1310 qemu_mutex_unlock(&chr->chr_write_lock);
1313 /* Called with chr_write_lock held. */
1314 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1316 PtyCharDriver *s = chr->opaque;
1318 if (!s->connected) {
1319 /* guest sends data, check for (re-)connect */
1320 pty_chr_update_read_handler_locked(chr);
1321 if (!s->connected) {
1325 return io_channel_send(s->ioc, buf, len);
1328 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1330 PtyCharDriver *s = chr->opaque;
1331 if (!s->connected) {
1334 return qio_channel_create_watch(s->ioc, cond);
1337 static int pty_chr_read_poll(void *opaque)
1339 CharDriverState *chr = opaque;
1340 PtyCharDriver *s = chr->opaque;
1342 s->read_bytes = qemu_chr_be_can_write(chr);
1343 return s->read_bytes;
1346 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1348 CharDriverState *chr = opaque;
1349 PtyCharDriver *s = chr->opaque;
1351 uint8_t buf[READ_BUF_LEN];
1355 if (len > s->read_bytes)
1356 len = s->read_bytes;
1360 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1362 pty_chr_state(chr, 0);
1365 pty_chr_state(chr, 1);
1366 qemu_chr_be_write(chr, buf, ret);
1371 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1373 CharDriverState *chr = opaque;
1374 PtyCharDriver *s = chr->opaque;
1377 qemu_chr_be_generic_open(chr);
1381 /* Called with chr_write_lock held. */
1382 static void pty_chr_state(CharDriverState *chr, int connected)
1384 PtyCharDriver *s = chr->opaque;
1388 g_source_remove(s->open_tag);
1391 remove_fd_in_watch(chr);
1393 /* (re-)connect poll interval for idle guests: once per second.
1394 * We check more frequently in case the guests sends data to
1395 * the virtual device linked to our pty. */
1396 pty_chr_rearm_timer(chr, 1000);
1399 g_source_remove(s->timer_tag);
1402 if (!s->connected) {
1403 g_assert(s->open_tag == 0);
1405 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1407 if (!chr->fd_in_tag) {
1408 chr->fd_in_tag = io_add_watch_poll(s->ioc,
1415 static void pty_chr_close(struct CharDriverState *chr)
1417 PtyCharDriver *s = chr->opaque;
1419 qemu_mutex_lock(&chr->chr_write_lock);
1420 pty_chr_state(chr, 0);
1421 object_unref(OBJECT(s->ioc));
1423 g_source_remove(s->timer_tag);
1426 qemu_mutex_unlock(&chr->chr_write_lock);
1428 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1431 static CharDriverState *qemu_chr_open_pty(const char *id,
1432 ChardevBackend *backend,
1436 CharDriverState *chr;
1438 int master_fd, slave_fd;
1439 char pty_name[PATH_MAX];
1440 ChardevCommon *common = backend->u.pty.data;
1442 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1443 if (master_fd < 0) {
1444 error_setg_errno(errp, errno, "Failed to create PTY");
1449 qemu_set_nonblock(master_fd);
1451 chr = qemu_chr_alloc(common, errp);
1457 chr->filename = g_strdup_printf("pty:%s", pty_name);
1458 ret->pty = g_strdup(pty_name);
1459 ret->has_pty = true;
1461 fprintf(stderr, "char device redirected to %s (label %s)\n",
1464 s = g_new0(PtyCharDriver, 1);
1466 chr->chr_write = pty_chr_write;
1467 chr->chr_update_read_handler = pty_chr_update_read_handler;
1468 chr->chr_close = pty_chr_close;
1469 chr->chr_add_watch = pty_chr_add_watch;
1470 chr->explicit_be_open = true;
1472 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1478 static void tty_serial_init(int fd, int speed,
1479 int parity, int data_bits, int stop_bits)
1485 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1486 speed, parity, data_bits, stop_bits);
1488 tcgetattr (fd, &tty);
1490 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1491 speed = speed * 10 / 11;
1508 /* Non-Posix values follow. They may be unsupported on some systems. */
1510 check_speed(115200);
1512 check_speed(230400);
1515 check_speed(460800);
1518 check_speed(500000);
1521 check_speed(576000);
1524 check_speed(921600);
1527 check_speed(1000000);
1530 check_speed(1152000);
1533 check_speed(1500000);
1536 check_speed(2000000);
1539 check_speed(2500000);
1542 check_speed(3000000);
1545 check_speed(3500000);
1548 check_speed(4000000);
1553 cfsetispeed(&tty, spd);
1554 cfsetospeed(&tty, spd);
1556 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1557 |INLCR|IGNCR|ICRNL|IXON);
1558 tty.c_oflag |= OPOST;
1559 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1560 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1581 tty.c_cflag |= PARENB;
1584 tty.c_cflag |= PARENB | PARODD;
1588 tty.c_cflag |= CSTOPB;
1590 tcsetattr (fd, TCSANOW, &tty);
1593 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1595 FDCharDriver *s = chr->opaque;
1596 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1599 case CHR_IOCTL_SERIAL_SET_PARAMS:
1601 QEMUSerialSetParams *ssp = arg;
1602 tty_serial_init(fioc->fd,
1603 ssp->speed, ssp->parity,
1604 ssp->data_bits, ssp->stop_bits);
1607 case CHR_IOCTL_SERIAL_SET_BREAK:
1609 int enable = *(int *)arg;
1611 tcsendbreak(fioc->fd, 1);
1615 case CHR_IOCTL_SERIAL_GET_TIOCM:
1618 int *targ = (int *)arg;
1619 ioctl(fioc->fd, TIOCMGET, &sarg);
1621 if (sarg & TIOCM_CTS)
1622 *targ |= CHR_TIOCM_CTS;
1623 if (sarg & TIOCM_CAR)
1624 *targ |= CHR_TIOCM_CAR;
1625 if (sarg & TIOCM_DSR)
1626 *targ |= CHR_TIOCM_DSR;
1627 if (sarg & TIOCM_RI)
1628 *targ |= CHR_TIOCM_RI;
1629 if (sarg & TIOCM_DTR)
1630 *targ |= CHR_TIOCM_DTR;
1631 if (sarg & TIOCM_RTS)
1632 *targ |= CHR_TIOCM_RTS;
1635 case CHR_IOCTL_SERIAL_SET_TIOCM:
1637 int sarg = *(int *)arg;
1639 ioctl(fioc->fd, TIOCMGET, &targ);
1640 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1641 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1642 if (sarg & CHR_TIOCM_CTS)
1644 if (sarg & CHR_TIOCM_CAR)
1646 if (sarg & CHR_TIOCM_DSR)
1648 if (sarg & CHR_TIOCM_RI)
1650 if (sarg & CHR_TIOCM_DTR)
1652 if (sarg & CHR_TIOCM_RTS)
1654 ioctl(fioc->fd, TIOCMSET, &targ);
1663 static void qemu_chr_close_tty(CharDriverState *chr)
1668 static CharDriverState *qemu_chr_open_tty_fd(int fd,
1669 ChardevCommon *backend,
1672 CharDriverState *chr;
1674 tty_serial_init(fd, 115200, 'N', 8, 1);
1675 chr = qemu_chr_open_fd(fd, fd, backend, errp);
1676 chr->chr_ioctl = tty_serial_ioctl;
1677 chr->chr_close = qemu_chr_close_tty;
1680 #endif /* __linux__ || __sun__ */
1682 #if defined(__linux__)
1684 #define HAVE_CHARDEV_PARPORT 1
1689 } ParallelCharDriver;
1691 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1693 if (s->mode != mode) {
1695 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1702 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1704 ParallelCharDriver *drv = chr->opaque;
1709 case CHR_IOCTL_PP_READ_DATA:
1710 if (ioctl(fd, PPRDATA, &b) < 0)
1712 *(uint8_t *)arg = b;
1714 case CHR_IOCTL_PP_WRITE_DATA:
1715 b = *(uint8_t *)arg;
1716 if (ioctl(fd, PPWDATA, &b) < 0)
1719 case CHR_IOCTL_PP_READ_CONTROL:
1720 if (ioctl(fd, PPRCONTROL, &b) < 0)
1722 /* Linux gives only the lowest bits, and no way to know data
1723 direction! For better compatibility set the fixed upper
1725 *(uint8_t *)arg = b | 0xc0;
1727 case CHR_IOCTL_PP_WRITE_CONTROL:
1728 b = *(uint8_t *)arg;
1729 if (ioctl(fd, PPWCONTROL, &b) < 0)
1732 case CHR_IOCTL_PP_READ_STATUS:
1733 if (ioctl(fd, PPRSTATUS, &b) < 0)
1735 *(uint8_t *)arg = b;
1737 case CHR_IOCTL_PP_DATA_DIR:
1738 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1741 case CHR_IOCTL_PP_EPP_READ_ADDR:
1742 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1743 struct ParallelIOArg *parg = arg;
1744 int n = read(fd, parg->buffer, parg->count);
1745 if (n != parg->count) {
1750 case CHR_IOCTL_PP_EPP_READ:
1751 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1752 struct ParallelIOArg *parg = arg;
1753 int n = read(fd, parg->buffer, parg->count);
1754 if (n != parg->count) {
1759 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1760 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1761 struct ParallelIOArg *parg = arg;
1762 int n = write(fd, parg->buffer, parg->count);
1763 if (n != parg->count) {
1768 case CHR_IOCTL_PP_EPP_WRITE:
1769 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1770 struct ParallelIOArg *parg = arg;
1771 int n = write(fd, parg->buffer, parg->count);
1772 if (n != parg->count) {
1783 static void pp_close(CharDriverState *chr)
1785 ParallelCharDriver *drv = chr->opaque;
1788 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1789 ioctl(fd, PPRELEASE);
1792 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1795 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1796 ChardevCommon *backend,
1799 CharDriverState *chr;
1800 ParallelCharDriver *drv;
1802 if (ioctl(fd, PPCLAIM) < 0) {
1803 error_setg_errno(errp, errno, "not a parallel port");
1808 chr = qemu_chr_alloc(backend, errp);
1813 drv = g_new0(ParallelCharDriver, 1);
1815 chr->chr_write = null_chr_write;
1816 chr->chr_ioctl = pp_ioctl;
1817 chr->chr_close = pp_close;
1820 drv->mode = IEEE1284_MODE_COMPAT;
1824 #endif /* __linux__ */
1826 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1828 #define HAVE_CHARDEV_PARPORT 1
1830 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1832 int fd = (int)(intptr_t)chr->opaque;
1836 case CHR_IOCTL_PP_READ_DATA:
1837 if (ioctl(fd, PPIGDATA, &b) < 0)
1839 *(uint8_t *)arg = b;
1841 case CHR_IOCTL_PP_WRITE_DATA:
1842 b = *(uint8_t *)arg;
1843 if (ioctl(fd, PPISDATA, &b) < 0)
1846 case CHR_IOCTL_PP_READ_CONTROL:
1847 if (ioctl(fd, PPIGCTRL, &b) < 0)
1849 *(uint8_t *)arg = b;
1851 case CHR_IOCTL_PP_WRITE_CONTROL:
1852 b = *(uint8_t *)arg;
1853 if (ioctl(fd, PPISCTRL, &b) < 0)
1856 case CHR_IOCTL_PP_READ_STATUS:
1857 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1859 *(uint8_t *)arg = b;
1867 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1868 ChardevCommon *backend,
1871 CharDriverState *chr;
1873 chr = qemu_chr_alloc(backend, errp);
1877 chr->opaque = (void *)(intptr_t)fd;
1878 chr->chr_write = null_chr_write;
1879 chr->chr_ioctl = pp_ioctl;
1880 chr->explicit_be_open = true;
1887 #define HAVE_CHARDEV_SERIAL 1
1891 HANDLE hcom, hrecv, hsend;
1896 /* Protected by the CharDriverState chr_write_lock. */
1902 HANDLE hInputReadyEvent;
1903 HANDLE hInputDoneEvent;
1904 HANDLE hInputThread;
1905 uint8_t win_stdio_buf;
1906 } WinStdioCharState;
1908 #define NSENDBUF 2048
1909 #define NRECVBUF 2048
1910 #define MAXCONNECT 1
1911 #define NTIMEOUT 5000
1913 static int win_chr_poll(void *opaque);
1914 static int win_chr_pipe_poll(void *opaque);
1916 static void win_chr_close(CharDriverState *chr)
1918 WinCharState *s = chr->opaque;
1921 CloseHandle(s->hsend);
1925 CloseHandle(s->hrecv);
1929 CloseHandle(s->hcom);
1933 qemu_del_polling_cb(win_chr_pipe_poll, chr);
1935 qemu_del_polling_cb(win_chr_poll, chr);
1937 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1940 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
1942 WinCharState *s = chr->opaque;
1944 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
1949 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
1951 error_setg(errp, "Failed CreateEvent");
1954 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
1956 error_setg(errp, "Failed CreateEvent");
1960 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
1961 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
1962 if (s->hcom == INVALID_HANDLE_VALUE) {
1963 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
1968 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
1969 error_setg(errp, "Failed SetupComm");
1973 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
1974 size = sizeof(COMMCONFIG);
1975 GetDefaultCommConfig(filename, &comcfg, &size);
1976 comcfg.dcb.DCBlength = sizeof(DCB);
1977 CommConfigDialog(filename, NULL, &comcfg);
1979 if (!SetCommState(s->hcom, &comcfg.dcb)) {
1980 error_setg(errp, "Failed SetCommState");
1984 if (!SetCommMask(s->hcom, EV_ERR)) {
1985 error_setg(errp, "Failed SetCommMask");
1989 cto.ReadIntervalTimeout = MAXDWORD;
1990 if (!SetCommTimeouts(s->hcom, &cto)) {
1991 error_setg(errp, "Failed SetCommTimeouts");
1995 if (!ClearCommError(s->hcom, &err, &comstat)) {
1996 error_setg(errp, "Failed ClearCommError");
1999 qemu_add_polling_cb(win_chr_poll, chr);
2007 /* Called with chr_write_lock held. */
2008 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
2010 WinCharState *s = chr->opaque;
2011 DWORD len, ret, size, err;
2014 ZeroMemory(&s->osend, sizeof(s->osend));
2015 s->osend.hEvent = s->hsend;
2018 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
2020 ret = WriteFile(s->hcom, buf, len, &size, NULL);
2022 err = GetLastError();
2023 if (err == ERROR_IO_PENDING) {
2024 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
2042 static int win_chr_read_poll(CharDriverState *chr)
2044 WinCharState *s = chr->opaque;
2046 s->max_size = qemu_chr_be_can_write(chr);
2050 static void win_chr_readfile(CharDriverState *chr)
2052 WinCharState *s = chr->opaque;
2054 uint8_t buf[READ_BUF_LEN];
2057 ZeroMemory(&s->orecv, sizeof(s->orecv));
2058 s->orecv.hEvent = s->hrecv;
2059 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2061 err = GetLastError();
2062 if (err == ERROR_IO_PENDING) {
2063 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2068 qemu_chr_be_write(chr, buf, size);
2072 static void win_chr_read(CharDriverState *chr)
2074 WinCharState *s = chr->opaque;
2076 if (s->len > s->max_size)
2077 s->len = s->max_size;
2081 win_chr_readfile(chr);
2084 static int win_chr_poll(void *opaque)
2086 CharDriverState *chr = opaque;
2087 WinCharState *s = chr->opaque;
2091 ClearCommError(s->hcom, &comerr, &status);
2092 if (status.cbInQue > 0) {
2093 s->len = status.cbInQue;
2094 win_chr_read_poll(chr);
2101 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2102 ChardevCommon *backend,
2105 CharDriverState *chr;
2108 chr = qemu_chr_alloc(backend, errp);
2112 s = g_new0(WinCharState, 1);
2114 chr->chr_write = win_chr_write;
2115 chr->chr_close = win_chr_close;
2117 if (win_chr_init(chr, filename, errp) < 0) {
2119 qemu_chr_free_common(chr);
2125 static int win_chr_pipe_poll(void *opaque)
2127 CharDriverState *chr = opaque;
2128 WinCharState *s = chr->opaque;
2131 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2134 win_chr_read_poll(chr);
2141 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2144 WinCharState *s = chr->opaque;
2152 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2154 error_setg(errp, "Failed CreateEvent");
2157 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2159 error_setg(errp, "Failed CreateEvent");
2163 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2164 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2165 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2167 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2169 if (s->hcom == INVALID_HANDLE_VALUE) {
2170 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2175 ZeroMemory(&ov, sizeof(ov));
2176 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2177 ret = ConnectNamedPipe(s->hcom, &ov);
2179 error_setg(errp, "Failed ConnectNamedPipe");
2183 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2185 error_setg(errp, "Failed GetOverlappedResult");
2187 CloseHandle(ov.hEvent);
2194 CloseHandle(ov.hEvent);
2197 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2206 static CharDriverState *qemu_chr_open_pipe(const char *id,
2207 ChardevBackend *backend,
2211 ChardevHostdev *opts = backend->u.pipe.data;
2212 const char *filename = opts->device;
2213 CharDriverState *chr;
2215 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
2217 chr = qemu_chr_alloc(common, errp);
2221 s = g_new0(WinCharState, 1);
2223 chr->chr_write = win_chr_write;
2224 chr->chr_close = win_chr_close;
2226 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2228 qemu_chr_free_common(chr);
2234 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out,
2235 ChardevCommon *backend,
2238 CharDriverState *chr;
2241 chr = qemu_chr_alloc(backend, errp);
2245 s = g_new0(WinCharState, 1);
2248 chr->chr_write = win_chr_write;
2252 static CharDriverState *qemu_chr_open_win_con(const char *id,
2253 ChardevBackend *backend,
2257 ChardevCommon *common = backend->u.console.data;
2258 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE),
2262 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2264 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2271 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2281 static void win_stdio_wait_func(void *opaque)
2283 CharDriverState *chr = opaque;
2284 WinStdioCharState *stdio = chr->opaque;
2285 INPUT_RECORD buf[4];
2290 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2293 /* Avoid error storm */
2294 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2298 for (i = 0; i < dwSize; i++) {
2299 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2301 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2303 if (kev->uChar.AsciiChar != 0) {
2304 for (j = 0; j < kev->wRepeatCount; j++) {
2305 if (qemu_chr_be_can_write(chr)) {
2306 uint8_t c = kev->uChar.AsciiChar;
2307 qemu_chr_be_write(chr, &c, 1);
2315 static DWORD WINAPI win_stdio_thread(LPVOID param)
2317 CharDriverState *chr = param;
2318 WinStdioCharState *stdio = chr->opaque;
2324 /* Wait for one byte */
2325 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2327 /* Exit in case of error, continue if nothing read */
2335 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2336 if (stdio->win_stdio_buf == '\r') {
2340 /* Signal the main thread and wait until the byte was eaten */
2341 if (!SetEvent(stdio->hInputReadyEvent)) {
2344 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2350 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2354 static void win_stdio_thread_wait_func(void *opaque)
2356 CharDriverState *chr = opaque;
2357 WinStdioCharState *stdio = chr->opaque;
2359 if (qemu_chr_be_can_write(chr)) {
2360 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2363 SetEvent(stdio->hInputDoneEvent);
2366 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2368 WinStdioCharState *stdio = chr->opaque;
2371 GetConsoleMode(stdio->hStdIn, &dwMode);
2374 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2376 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2380 static void win_stdio_close(CharDriverState *chr)
2382 WinStdioCharState *stdio = chr->opaque;
2384 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2385 CloseHandle(stdio->hInputReadyEvent);
2387 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2388 CloseHandle(stdio->hInputDoneEvent);
2390 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2391 TerminateThread(stdio->hInputThread, 0);
2394 g_free(chr->opaque);
2398 static CharDriverState *qemu_chr_open_stdio(const char *id,
2399 ChardevBackend *backend,
2403 CharDriverState *chr;
2404 WinStdioCharState *stdio;
2407 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio.data);
2409 chr = qemu_chr_alloc(common, errp);
2413 stdio = g_new0(WinStdioCharState, 1);
2415 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2416 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2417 error_setg(errp, "cannot open stdio: invalid handle");
2421 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2423 chr->opaque = stdio;
2424 chr->chr_write = win_stdio_write;
2425 chr->chr_close = win_stdio_close;
2428 if (qemu_add_wait_object(stdio->hStdIn,
2429 win_stdio_wait_func, chr)) {
2430 error_setg(errp, "qemu_add_wait_object: failed");
2436 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2437 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2438 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2439 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2440 error_setg(errp, "cannot create event");
2443 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2444 win_stdio_thread_wait_func, chr)) {
2445 error_setg(errp, "qemu_add_wait_object: failed");
2448 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2451 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2452 error_setg(errp, "cannot create stdio thread");
2457 dwMode |= ENABLE_LINE_INPUT;
2460 /* set the terminal in raw mode */
2461 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2462 dwMode |= ENABLE_PROCESSED_INPUT;
2465 SetConsoleMode(stdio->hStdIn, dwMode);
2467 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2468 qemu_chr_fe_set_echo(chr, false);
2473 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2475 CloseHandle(stdio->hInputReadyEvent);
2476 CloseHandle(stdio->hInputDoneEvent);
2478 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2481 #endif /* !_WIN32 */
2484 /***********************************************************/
2485 /* UDP Net console */
2489 uint8_t buf[READ_BUF_LEN];
2495 /* Called with chr_write_lock held. */
2496 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2498 NetCharDriver *s = chr->opaque;
2500 return qio_channel_write(
2501 s->ioc, (const char *)buf, len, NULL);
2504 static int udp_chr_read_poll(void *opaque)
2506 CharDriverState *chr = opaque;
2507 NetCharDriver *s = chr->opaque;
2509 s->max_size = qemu_chr_be_can_write(chr);
2511 /* If there were any stray characters in the queue process them
2514 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2515 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2517 s->max_size = qemu_chr_be_can_write(chr);
2522 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2524 CharDriverState *chr = opaque;
2525 NetCharDriver *s = chr->opaque;
2528 if (s->max_size == 0) {
2531 ret = qio_channel_read(
2532 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2534 remove_fd_in_watch(chr);
2540 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2541 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2543 s->max_size = qemu_chr_be_can_write(chr);
2549 static void udp_chr_update_read_handler(CharDriverState *chr)
2551 NetCharDriver *s = chr->opaque;
2553 remove_fd_in_watch(chr);
2555 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2561 static void udp_chr_close(CharDriverState *chr)
2563 NetCharDriver *s = chr->opaque;
2565 remove_fd_in_watch(chr);
2567 object_unref(OBJECT(s->ioc));
2570 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2573 static CharDriverState *qemu_chr_open_udp(QIOChannelSocket *sioc,
2574 ChardevCommon *backend,
2577 CharDriverState *chr = NULL;
2578 NetCharDriver *s = NULL;
2580 chr = qemu_chr_alloc(backend, errp);
2584 s = g_new0(NetCharDriver, 1);
2586 s->ioc = QIO_CHANNEL(sioc);
2590 chr->chr_write = udp_chr_write;
2591 chr->chr_update_read_handler = udp_chr_update_read_handler;
2592 chr->chr_close = udp_chr_close;
2593 /* be isn't opened until we get a connection */
2594 chr->explicit_be_open = true;
2598 /***********************************************************/
2599 /* TCP Net console */
2602 QIOChannel *ioc; /* Client I/O channel */
2603 QIOChannelSocket *sioc; /* Client master channel */
2604 QIOChannelSocket *listen_ioc;
2606 QCryptoTLSCreds *tls_creds;
2613 size_t read_msgfds_num;
2615 size_t write_msgfds_num;
2617 SocketAddress *addr;
2621 guint reconnect_timer;
2622 int64_t reconnect_time;
2623 bool connect_err_reported;
2626 static gboolean socket_reconnect_timeout(gpointer opaque);
2628 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2630 TCPCharDriver *s = chr->opaque;
2631 assert(s->connected == 0);
2632 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2633 socket_reconnect_timeout, chr);
2636 static void check_report_connect_error(CharDriverState *chr,
2639 TCPCharDriver *s = chr->opaque;
2641 if (!s->connect_err_reported) {
2642 error_report("Unable to connect character device %s: %s",
2643 chr->label, error_get_pretty(err));
2644 s->connect_err_reported = true;
2646 qemu_chr_socket_restart_timer(chr);
2649 static gboolean tcp_chr_accept(QIOChannel *chan,
2653 /* Called with chr_write_lock held. */
2654 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2656 TCPCharDriver *s = chr->opaque;
2658 int ret = io_channel_send_full(s->ioc, buf, len,
2660 s->write_msgfds_num);
2662 /* free the written msgfds, no matter what */
2663 if (s->write_msgfds_num) {
2664 g_free(s->write_msgfds);
2665 s->write_msgfds = 0;
2666 s->write_msgfds_num = 0;
2671 /* XXX: indicate an error ? */
2676 static int tcp_chr_read_poll(void *opaque)
2678 CharDriverState *chr = opaque;
2679 TCPCharDriver *s = chr->opaque;
2682 s->max_size = qemu_chr_be_can_write(chr);
2687 #define IAC_BREAK 243
2688 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2690 uint8_t *buf, int *size)
2692 /* Handle any telnet client's basic IAC options to satisfy char by
2693 * char mode with no echo. All IAC options will be removed from
2694 * the buf and the do_telnetopt variable will be used to track the
2695 * state of the width of the IAC information.
2697 * IAC commands come in sets of 3 bytes with the exception of the
2698 * "IAC BREAK" command and the double IAC.
2704 for (i = 0; i < *size; i++) {
2705 if (s->do_telnetopt > 1) {
2706 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2707 /* Double IAC means send an IAC */
2711 s->do_telnetopt = 1;
2713 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2714 /* Handle IAC break commands by sending a serial break */
2715 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2720 if (s->do_telnetopt >= 4) {
2721 s->do_telnetopt = 1;
2724 if ((unsigned char)buf[i] == IAC) {
2725 s->do_telnetopt = 2;
2736 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2738 TCPCharDriver *s = chr->opaque;
2739 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2741 assert(num <= TCP_MAX_FDS);
2746 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2748 /* Close unused fds */
2749 for (i = to_copy; i < s->read_msgfds_num; i++) {
2750 close(s->read_msgfds[i]);
2753 g_free(s->read_msgfds);
2755 s->read_msgfds_num = 0;
2761 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2763 TCPCharDriver *s = chr->opaque;
2765 if (!qio_channel_has_feature(s->ioc,
2766 QIO_CHANNEL_FEATURE_FD_PASS)) {
2769 /* clear old pending fd array */
2770 g_free(s->write_msgfds);
2771 s->write_msgfds = NULL;
2774 s->write_msgfds = g_new(int, num);
2775 memcpy(s->write_msgfds, fds, num * sizeof(int));
2778 s->write_msgfds_num = num;
2783 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2785 TCPCharDriver *s = chr->opaque;
2786 struct iovec iov = { .iov_base = buf, .iov_len = len };
2790 size_t msgfds_num = 0;
2792 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2793 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2794 &msgfds, &msgfds_num,
2797 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2802 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2805 } else if (ret == -1) {
2810 /* close and clean read_msgfds */
2811 for (i = 0; i < s->read_msgfds_num; i++) {
2812 close(s->read_msgfds[i]);
2815 if (s->read_msgfds_num) {
2816 g_free(s->read_msgfds);
2819 s->read_msgfds = msgfds;
2820 s->read_msgfds_num = msgfds_num;
2823 for (i = 0; i < s->read_msgfds_num; i++) {
2824 int fd = s->read_msgfds[i];
2829 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2832 #ifndef MSG_CMSG_CLOEXEC
2833 qemu_set_cloexec(fd);
2840 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2842 TCPCharDriver *s = chr->opaque;
2843 return qio_channel_create_watch(s->ioc, cond);
2846 static void tcp_chr_disconnect(CharDriverState *chr)
2848 TCPCharDriver *s = chr->opaque;
2850 if (!s->connected) {
2855 if (s->listen_ioc) {
2856 s->listen_tag = qio_channel_add_watch(
2857 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
2859 tcp_set_msgfds(chr, NULL, 0);
2860 remove_fd_in_watch(chr);
2861 object_unref(OBJECT(s->sioc));
2863 object_unref(OBJECT(s->ioc));
2865 g_free(chr->filename);
2866 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
2867 s->is_listen, s->is_telnet);
2868 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2869 if (s->reconnect_time) {
2870 qemu_chr_socket_restart_timer(chr);
2874 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2876 CharDriverState *chr = opaque;
2877 TCPCharDriver *s = chr->opaque;
2878 uint8_t buf[READ_BUF_LEN];
2881 if (!s->connected || s->max_size <= 0) {
2885 if (len > s->max_size)
2887 size = tcp_chr_recv(chr, (void *)buf, len);
2888 if (size == 0 || size == -1) {
2889 /* connection closed */
2890 tcp_chr_disconnect(chr);
2891 } else if (size > 0) {
2892 if (s->do_telnetopt)
2893 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
2895 qemu_chr_be_write(chr, buf, size);
2901 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
2903 TCPCharDriver *s = chr->opaque;
2906 if (!s->connected) {
2910 size = tcp_chr_recv(chr, (void *) buf, len);
2912 /* connection closed */
2913 tcp_chr_disconnect(chr);
2919 static void tcp_chr_connect(void *opaque)
2921 CharDriverState *chr = opaque;
2922 TCPCharDriver *s = chr->opaque;
2924 g_free(chr->filename);
2925 chr->filename = sockaddr_to_str(
2926 &s->sioc->localAddr, s->sioc->localAddrLen,
2927 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
2928 s->is_listen, s->is_telnet);
2932 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2936 qemu_chr_be_generic_open(chr);
2939 static void tcp_chr_update_read_handler(CharDriverState *chr)
2941 TCPCharDriver *s = chr->opaque;
2943 if (!s->connected) {
2947 remove_fd_in_watch(chr);
2949 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2956 CharDriverState *chr;
2959 } TCPCharDriverTelnetInit;
2961 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
2962 GIOCondition cond G_GNUC_UNUSED,
2965 TCPCharDriverTelnetInit *init = user_data;
2968 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
2970 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2973 tcp_chr_disconnect(init->chr);
2977 init->buflen -= ret;
2979 if (init->buflen == 0) {
2980 tcp_chr_connect(init->chr);
2984 memmove(init->buf, init->buf + ret, init->buflen);
2989 static void tcp_chr_telnet_init(CharDriverState *chr)
2991 TCPCharDriver *s = chr->opaque;
2992 TCPCharDriverTelnetInit *init =
2993 g_new0(TCPCharDriverTelnetInit, 1);
2999 #define IACSET(x, a, b, c) \
3006 /* Prep the telnet negotion to put telnet in binary,
3007 * no echo, single char mode */
3008 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3009 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3010 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3011 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3015 qio_channel_add_watch(
3017 tcp_chr_telnet_init_io,
3022 static void tcp_chr_tls_handshake(Object *source,
3026 CharDriverState *chr = user_data;
3027 TCPCharDriver *s = chr->opaque;
3030 tcp_chr_disconnect(chr);
3032 if (s->do_telnetopt) {
3033 tcp_chr_telnet_init(chr);
3035 tcp_chr_connect(chr);
3041 static void tcp_chr_tls_init(CharDriverState *chr)
3043 TCPCharDriver *s = chr->opaque;
3044 QIOChannelTLS *tioc;
3048 tioc = qio_channel_tls_new_server(
3049 s->ioc, s->tls_creds,
3050 NULL, /* XXX Use an ACL */
3053 tioc = qio_channel_tls_new_client(
3054 s->ioc, s->tls_creds,
3055 s->addr->u.inet.data->host,
3060 tcp_chr_disconnect(chr);
3062 object_unref(OBJECT(s->ioc));
3063 s->ioc = QIO_CHANNEL(tioc);
3065 qio_channel_tls_handshake(tioc,
3066 tcp_chr_tls_handshake,
3072 static int tcp_chr_new_client(CharDriverState *chr, QIOChannelSocket *sioc)
3074 TCPCharDriver *s = chr->opaque;
3075 if (s->ioc != NULL) {
3079 s->ioc = QIO_CHANNEL(sioc);
3080 object_ref(OBJECT(sioc));
3082 object_ref(OBJECT(sioc));
3084 qio_channel_set_blocking(s->ioc, false, NULL);
3086 if (s->do_nodelay) {
3087 qio_channel_set_delay(s->ioc, false);
3089 if (s->listen_tag) {
3090 g_source_remove(s->listen_tag);
3095 tcp_chr_tls_init(chr);
3097 if (s->do_telnetopt) {
3098 tcp_chr_telnet_init(chr);
3100 tcp_chr_connect(chr);
3108 static int tcp_chr_add_client(CharDriverState *chr, int fd)
3111 QIOChannelSocket *sioc;
3113 sioc = qio_channel_socket_new_fd(fd, NULL);
3117 ret = tcp_chr_new_client(chr, sioc);
3118 object_unref(OBJECT(sioc));
3122 static gboolean tcp_chr_accept(QIOChannel *channel,
3126 CharDriverState *chr = opaque;
3127 QIOChannelSocket *sioc;
3129 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3135 tcp_chr_new_client(chr, sioc);
3137 object_unref(OBJECT(sioc));
3142 static void tcp_chr_close(CharDriverState *chr)
3144 TCPCharDriver *s = chr->opaque;
3147 if (s->reconnect_timer) {
3148 g_source_remove(s->reconnect_timer);
3149 s->reconnect_timer = 0;
3151 qapi_free_SocketAddress(s->addr);
3152 remove_fd_in_watch(chr);
3154 object_unref(OBJECT(s->ioc));
3156 if (s->listen_tag) {
3157 g_source_remove(s->listen_tag);
3160 if (s->listen_ioc) {
3161 object_unref(OBJECT(s->listen_ioc));
3163 if (s->read_msgfds_num) {
3164 for (i = 0; i < s->read_msgfds_num; i++) {
3165 close(s->read_msgfds[i]);
3167 g_free(s->read_msgfds);
3170 object_unref(OBJECT(s->tls_creds));
3172 if (s->write_msgfds_num) {
3173 g_free(s->write_msgfds);
3176 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3180 static void qemu_chr_socket_connected(Object *src, Error *err, void *opaque)
3182 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(src);
3183 CharDriverState *chr = opaque;
3184 TCPCharDriver *s = chr->opaque;
3187 check_report_connect_error(chr, err);
3192 s->connect_err_reported = false;
3193 tcp_chr_new_client(chr, sioc);
3194 object_unref(OBJECT(sioc));
3198 /*********************************************************/
3199 /* Ring buffer chardev */
3206 } RingBufCharDriver;
3208 static size_t ringbuf_count(const CharDriverState *chr)
3210 const RingBufCharDriver *d = chr->opaque;
3212 return d->prod - d->cons;
3215 /* Called with chr_write_lock held. */
3216 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3218 RingBufCharDriver *d = chr->opaque;
3221 if (!buf || (len < 0)) {
3225 for (i = 0; i < len; i++ ) {
3226 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3227 if (d->prod - d->cons > d->size) {
3228 d->cons = d->prod - d->size;
3235 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3237 RingBufCharDriver *d = chr->opaque;
3240 qemu_mutex_lock(&chr->chr_write_lock);
3241 for (i = 0; i < len && d->cons != d->prod; i++) {
3242 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3244 qemu_mutex_unlock(&chr->chr_write_lock);
3249 static void ringbuf_chr_close(struct CharDriverState *chr)
3251 RingBufCharDriver *d = chr->opaque;
3258 static CharDriverState *qemu_chr_open_ringbuf(const char *id,
3259 ChardevBackend *backend,
3263 ChardevRingbuf *opts = backend->u.ringbuf.data;
3264 ChardevCommon *common = qapi_ChardevRingbuf_base(opts);
3265 CharDriverState *chr;
3266 RingBufCharDriver *d;
3268 chr = qemu_chr_alloc(common, errp);
3272 d = g_malloc(sizeof(*d));
3274 d->size = opts->has_size ? opts->size : 65536;
3276 /* The size must be power of 2 */
3277 if (d->size & (d->size - 1)) {
3278 error_setg(errp, "size of ringbuf chardev must be power of two");
3284 d->cbuf = g_malloc0(d->size);
3287 chr->chr_write = ringbuf_chr_write;
3288 chr->chr_close = ringbuf_chr_close;
3294 qemu_chr_free_common(chr);
3298 bool chr_is_ringbuf(const CharDriverState *chr)
3300 return chr->chr_write == ringbuf_chr_write;
3303 void qmp_ringbuf_write(const char *device, const char *data,
3304 bool has_format, enum DataFormat format,
3307 CharDriverState *chr;
3308 const uint8_t *write_data;
3312 chr = qemu_chr_find(device);
3314 error_setg(errp, "Device '%s' not found", device);
3318 if (!chr_is_ringbuf(chr)) {
3319 error_setg(errp,"%s is not a ringbuf device", device);
3323 if (has_format && (format == DATA_FORMAT_BASE64)) {
3324 write_data = qbase64_decode(data, -1,
3331 write_data = (uint8_t *)data;
3332 write_count = strlen(data);
3335 ret = ringbuf_chr_write(chr, write_data, write_count);
3337 if (write_data != (uint8_t *)data) {
3338 g_free((void *)write_data);
3342 error_setg(errp, "Failed to write to device %s", device);
3347 char *qmp_ringbuf_read(const char *device, int64_t size,
3348 bool has_format, enum DataFormat format,
3351 CharDriverState *chr;
3356 chr = qemu_chr_find(device);
3358 error_setg(errp, "Device '%s' not found", device);
3362 if (!chr_is_ringbuf(chr)) {
3363 error_setg(errp,"%s is not a ringbuf device", device);
3368 error_setg(errp, "size must be greater than zero");
3372 count = ringbuf_count(chr);
3373 size = size > count ? count : size;
3374 read_data = g_malloc(size + 1);
3376 ringbuf_chr_read(chr, read_data, size);
3378 if (has_format && (format == DATA_FORMAT_BASE64)) {
3379 data = g_base64_encode(read_data, size);
3383 * FIXME should read only complete, valid UTF-8 characters up
3384 * to @size bytes. Invalid sequences should be replaced by a
3385 * suitable replacement character. Except when (and only
3386 * when) ring buffer lost characters since last read, initial
3387 * continuation characters should be dropped.
3389 read_data[size] = 0;
3390 data = (char *)read_data;
3396 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3398 char host[65], port[33], width[8], height[8];
3402 Error *local_err = NULL;
3404 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3406 error_report_err(local_err);
3410 if (strstart(filename, "mon:", &p)) {
3412 qemu_opt_set(opts, "mux", "on", &error_abort);
3413 if (strcmp(filename, "stdio") == 0) {
3414 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3415 * but pass it to the guest. Handle this only for compat syntax,
3416 * for -chardev syntax we have special option for this.
3417 * This is what -nographic did, redirecting+muxing serial+monitor
3418 * to stdio causing Ctrl+C to be passed to guest. */
3419 qemu_opt_set(opts, "signal", "off", &error_abort);
3423 if (strcmp(filename, "null") == 0 ||
3424 strcmp(filename, "pty") == 0 ||
3425 strcmp(filename, "msmouse") == 0 ||
3426 strcmp(filename, "braille") == 0 ||
3427 strcmp(filename, "testdev") == 0 ||
3428 strcmp(filename, "stdio") == 0) {
3429 qemu_opt_set(opts, "backend", filename, &error_abort);
3432 if (strstart(filename, "vc", &p)) {
3433 qemu_opt_set(opts, "backend", "vc", &error_abort);
3435 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3437 qemu_opt_set(opts, "width", width, &error_abort);
3438 qemu_opt_set(opts, "height", height, &error_abort);
3439 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3441 qemu_opt_set(opts, "cols", width, &error_abort);
3442 qemu_opt_set(opts, "rows", height, &error_abort);
3449 if (strcmp(filename, "con:") == 0) {
3450 qemu_opt_set(opts, "backend", "console", &error_abort);
3453 if (strstart(filename, "COM", NULL)) {
3454 qemu_opt_set(opts, "backend", "serial", &error_abort);
3455 qemu_opt_set(opts, "path", filename, &error_abort);
3458 if (strstart(filename, "file:", &p)) {
3459 qemu_opt_set(opts, "backend", "file", &error_abort);
3460 qemu_opt_set(opts, "path", p, &error_abort);
3463 if (strstart(filename, "pipe:", &p)) {
3464 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3465 qemu_opt_set(opts, "path", p, &error_abort);
3468 if (strstart(filename, "tcp:", &p) ||
3469 strstart(filename, "telnet:", &p)) {
3470 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3472 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3475 qemu_opt_set(opts, "backend", "socket", &error_abort);
3476 qemu_opt_set(opts, "host", host, &error_abort);
3477 qemu_opt_set(opts, "port", port, &error_abort);
3478 if (p[pos] == ',') {
3479 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3481 error_report_err(local_err);
3485 if (strstart(filename, "telnet:", &p))
3486 qemu_opt_set(opts, "telnet", "on", &error_abort);
3489 if (strstart(filename, "udp:", &p)) {
3490 qemu_opt_set(opts, "backend", "udp", &error_abort);
3491 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3493 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3497 qemu_opt_set(opts, "host", host, &error_abort);
3498 qemu_opt_set(opts, "port", port, &error_abort);
3499 if (p[pos] == '@') {
3501 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3503 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3507 qemu_opt_set(opts, "localaddr", host, &error_abort);
3508 qemu_opt_set(opts, "localport", port, &error_abort);
3512 if (strstart(filename, "unix:", &p)) {
3513 qemu_opt_set(opts, "backend", "socket", &error_abort);
3514 qemu_opts_do_parse(opts, p, "path", &local_err);
3516 error_report_err(local_err);
3521 if (strstart(filename, "/dev/parport", NULL) ||
3522 strstart(filename, "/dev/ppi", NULL)) {
3523 qemu_opt_set(opts, "backend", "parport", &error_abort);
3524 qemu_opt_set(opts, "path", filename, &error_abort);
3527 if (strstart(filename, "/dev/", NULL)) {
3528 qemu_opt_set(opts, "backend", "tty", &error_abort);
3529 qemu_opt_set(opts, "path", filename, &error_abort);
3534 qemu_opts_del(opts);
3538 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3540 const char *logfile = qemu_opt_get(opts, "logfile");
3542 backend->has_logfile = logfile != NULL;
3543 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3545 backend->has_logappend = true;
3546 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3550 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3553 const char *path = qemu_opt_get(opts, "path");
3557 error_setg(errp, "chardev: file: no filename given");
3560 file = backend->u.file.data = g_new0(ChardevFile, 1);
3561 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3562 file->out = g_strdup(path);
3564 file->has_append = true;
3565 file->append = qemu_opt_get_bool(opts, "append", false);
3568 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3571 ChardevStdio *stdio;
3573 stdio = backend->u.stdio.data = g_new0(ChardevStdio, 1);
3574 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3575 stdio->has_signal = true;
3576 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3579 #ifdef HAVE_CHARDEV_SERIAL
3580 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3583 const char *device = qemu_opt_get(opts, "path");
3584 ChardevHostdev *serial;
3586 if (device == NULL) {
3587 error_setg(errp, "chardev: serial/tty: no device path given");
3590 serial = backend->u.serial.data = g_new0(ChardevHostdev, 1);
3591 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3592 serial->device = g_strdup(device);
3596 #ifdef HAVE_CHARDEV_PARPORT
3597 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3600 const char *device = qemu_opt_get(opts, "path");
3601 ChardevHostdev *parallel;
3603 if (device == NULL) {
3604 error_setg(errp, "chardev: parallel: no device path given");
3607 parallel = backend->u.parallel.data = g_new0(ChardevHostdev, 1);
3608 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3609 parallel->device = g_strdup(device);
3613 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3616 const char *device = qemu_opt_get(opts, "path");
3617 ChardevHostdev *dev;
3619 if (device == NULL) {
3620 error_setg(errp, "chardev: pipe: no device path given");
3623 dev = backend->u.pipe.data = g_new0(ChardevHostdev, 1);
3624 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3625 dev->device = g_strdup(device);
3628 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3632 ChardevRingbuf *ringbuf;
3634 ringbuf = backend->u.ringbuf.data = g_new0(ChardevRingbuf, 1);
3635 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3637 val = qemu_opt_get_size(opts, "size", 0);
3639 ringbuf->has_size = true;
3640 ringbuf->size = val;
3644 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3647 const char *chardev = qemu_opt_get(opts, "chardev");
3650 if (chardev == NULL) {
3651 error_setg(errp, "chardev: mux: no chardev given");
3654 mux = backend->u.mux.data = g_new0(ChardevMux, 1);
3655 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
3656 mux->chardev = g_strdup(chardev);
3659 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3662 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3663 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3664 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3665 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3666 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3667 const char *path = qemu_opt_get(opts, "path");
3668 const char *host = qemu_opt_get(opts, "host");
3669 const char *port = qemu_opt_get(opts, "port");
3670 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
3671 SocketAddress *addr;
3672 ChardevSocket *sock;
3676 error_setg(errp, "chardev: socket: no host given");
3680 error_setg(errp, "chardev: socket: no port given");
3685 error_setg(errp, "TLS can only be used over TCP socket");
3690 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
3691 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
3693 sock->has_nodelay = true;
3694 sock->nodelay = do_nodelay;
3695 sock->has_server = true;
3696 sock->server = is_listen;
3697 sock->has_telnet = true;
3698 sock->telnet = is_telnet;
3699 sock->has_wait = true;
3700 sock->wait = is_waitconnect;
3701 sock->has_reconnect = true;
3702 sock->reconnect = reconnect;
3703 sock->tls_creds = g_strdup(tls_creds);
3705 addr = g_new0(SocketAddress, 1);
3707 UnixSocketAddress *q_unix;
3708 addr->type = SOCKET_ADDRESS_KIND_UNIX;
3709 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
3710 q_unix->path = g_strdup(path);
3712 addr->type = SOCKET_ADDRESS_KIND_INET;
3713 addr->u.inet.data = g_new(InetSocketAddress, 1);
3714 *addr->u.inet.data = (InetSocketAddress) {
3715 .host = g_strdup(host),
3716 .port = g_strdup(port),
3717 .has_to = qemu_opt_get(opts, "to"),
3718 .to = qemu_opt_get_number(opts, "to", 0),
3719 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3720 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3721 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3722 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3728 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3731 const char *host = qemu_opt_get(opts, "host");
3732 const char *port = qemu_opt_get(opts, "port");
3733 const char *localaddr = qemu_opt_get(opts, "localaddr");
3734 const char *localport = qemu_opt_get(opts, "localport");
3735 bool has_local = false;
3736 SocketAddress *addr;
3739 if (host == NULL || strlen(host) == 0) {
3742 if (port == NULL || strlen(port) == 0) {
3743 error_setg(errp, "chardev: udp: remote port not specified");
3746 if (localport == NULL || strlen(localport) == 0) {
3751 if (localaddr == NULL || strlen(localaddr) == 0) {
3757 udp = backend->u.udp.data = g_new0(ChardevUdp, 1);
3758 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
3760 addr = g_new0(SocketAddress, 1);
3761 addr->type = SOCKET_ADDRESS_KIND_INET;
3762 addr->u.inet.data = g_new(InetSocketAddress, 1);
3763 *addr->u.inet.data = (InetSocketAddress) {
3764 .host = g_strdup(host),
3765 .port = g_strdup(port),
3766 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3767 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3768 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3769 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3774 udp->has_local = true;
3775 addr = g_new0(SocketAddress, 1);
3776 addr->type = SOCKET_ADDRESS_KIND_INET;
3777 addr->u.inet.data = g_new(InetSocketAddress, 1);
3778 *addr->u.inet.data = (InetSocketAddress) {
3779 .host = g_strdup(localaddr),
3780 .port = g_strdup(localport),
3786 typedef struct CharDriver {
3788 ChardevBackendKind kind;
3789 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3790 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3791 ChardevReturn *ret, Error **errp);
3794 static GSList *backends;
3796 void register_char_driver(const char *name, ChardevBackendKind kind,
3797 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
3798 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3799 ChardevReturn *ret, Error **errp))
3803 s = g_malloc0(sizeof(*s));
3804 s->name = g_strdup(name);
3809 backends = g_slist_append(backends, s);
3812 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
3813 void (*init)(struct CharDriverState *s),
3816 Error *local_err = NULL;
3818 CharDriverState *chr;
3820 ChardevReturn *ret = NULL;
3821 ChardevBackend *backend;
3822 const char *id = qemu_opts_id(opts);
3826 error_setg(errp, "chardev: no id specified");
3830 if (qemu_opt_get(opts, "backend") == NULL) {
3831 error_setg(errp, "chardev: \"%s\" missing backend",
3832 qemu_opts_id(opts));
3835 for (i = backends; i; i = i->next) {
3838 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
3843 error_setg(errp, "chardev: backend \"%s\" not found",
3844 qemu_opt_get(opts, "backend"));
3848 backend = g_new0(ChardevBackend, 1);
3850 if (qemu_opt_get_bool(opts, "mux", 0)) {
3851 bid = g_strdup_printf("%s-base", id);
3855 backend->type = cd->kind;
3857 cd->parse(opts, backend, &local_err);
3859 error_propagate(errp, local_err);
3863 ChardevCommon *cc = g_new0(ChardevCommon, 1);
3864 qemu_chr_parse_common(opts, cc);
3865 backend->u.null.data = cc; /* Any ChardevCommon member would work */
3868 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
3874 qapi_free_ChardevBackend(backend);
3875 qapi_free_ChardevReturn(ret);
3876 backend = g_new0(ChardevBackend, 1);
3877 backend->u.mux.data = g_new0(ChardevMux, 1);
3878 backend->type = CHARDEV_BACKEND_KIND_MUX;
3879 backend->u.mux.data->chardev = g_strdup(bid);
3880 ret = qmp_chardev_add(id, backend, errp);
3882 chr = qemu_chr_find(bid);
3883 qemu_chr_delete(chr);
3889 chr = qemu_chr_find(id);
3893 qapi_free_ChardevBackend(backend);
3894 qapi_free_ChardevReturn(ret);
3899 qemu_opts_del(opts);
3903 CharDriverState *qemu_chr_new_noreplay(const char *label, const char *filename,
3904 void (*init)(struct CharDriverState *s))
3907 CharDriverState *chr;
3911 if (strstart(filename, "chardev:", &p)) {
3912 return qemu_chr_find(p);
3915 opts = qemu_chr_parse_compat(label, filename);
3919 chr = qemu_chr_new_from_opts(opts, init, &err);
3921 error_report_err(err);
3923 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
3924 qemu_chr_fe_claim_no_fail(chr);
3925 monitor_init(chr, MONITOR_USE_READLINE);
3930 CharDriverState *qemu_chr_new(const char *label, const char *filename, void (*init)(struct CharDriverState *s))
3932 CharDriverState *chr;
3933 chr = qemu_chr_new_noreplay(label, filename, init);
3935 chr->replay = replay_mode != REPLAY_MODE_NONE;
3936 if (chr->replay && chr->chr_ioctl) {
3938 "Replay: ioctl is not supported for serial devices yet\n");
3940 replay_register_char_driver(chr);
3945 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo)
3947 if (chr->chr_set_echo) {
3948 chr->chr_set_echo(chr, echo);
3952 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open)
3954 if (chr->fe_open == fe_open) {
3957 chr->fe_open = fe_open;
3958 if (chr->chr_set_fe_open) {
3959 chr->chr_set_fe_open(chr, fe_open);
3963 void qemu_chr_fe_event(struct CharDriverState *chr, int event)
3965 if (chr->chr_fe_event) {
3966 chr->chr_fe_event(chr, event);
3970 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
3971 GIOFunc func, void *user_data)
3976 if (s->chr_add_watch == NULL) {
3980 src = s->chr_add_watch(s, cond);
3985 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
3986 tag = g_source_attach(src, NULL);
3987 g_source_unref(src);
3992 int qemu_chr_fe_claim(CharDriverState *s)
3994 if (s->avail_connections < 1) {
3997 s->avail_connections--;
4001 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
4003 if (qemu_chr_fe_claim(s) != 0) {
4004 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
4005 __func__, s->label);
4010 void qemu_chr_fe_release(CharDriverState *s)
4012 s->avail_connections++;
4015 static void qemu_chr_free_common(CharDriverState *chr)
4017 g_free(chr->filename);
4019 qemu_opts_del(chr->opts);
4020 if (chr->logfd != -1) {
4023 qemu_mutex_destroy(&chr->chr_write_lock);
4027 void qemu_chr_free(CharDriverState *chr)
4029 if (chr->chr_close) {
4030 chr->chr_close(chr);
4032 qemu_chr_free_common(chr);
4035 void qemu_chr_delete(CharDriverState *chr)
4037 QTAILQ_REMOVE(&chardevs, chr, next);
4041 ChardevInfoList *qmp_query_chardev(Error **errp)
4043 ChardevInfoList *chr_list = NULL;
4044 CharDriverState *chr;
4046 QTAILQ_FOREACH(chr, &chardevs, next) {
4047 ChardevInfoList *info = g_malloc0(sizeof(*info));
4048 info->value = g_malloc0(sizeof(*info->value));
4049 info->value->label = g_strdup(chr->label);
4050 info->value->filename = g_strdup(chr->filename);
4051 info->value->frontend_open = chr->fe_open;
4053 info->next = chr_list;
4060 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
4062 ChardevBackendInfoList *backend_list = NULL;
4063 CharDriver *c = NULL;
4066 for (i = backends; i; i = i->next) {
4067 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
4069 info->value = g_malloc0(sizeof(*info->value));
4070 info->value->name = g_strdup(c->name);
4072 info->next = backend_list;
4073 backend_list = info;
4076 return backend_list;
4079 CharDriverState *qemu_chr_find(const char *name)
4081 CharDriverState *chr;
4083 QTAILQ_FOREACH(chr, &chardevs, next) {
4084 if (strcmp(chr->label, name) != 0)
4091 /* Get a character (serial) device interface. */
4092 CharDriverState *qemu_char_get_next_serial(void)
4094 static int next_serial;
4095 CharDriverState *chr;
4097 /* FIXME: This function needs to go away: use chardev properties! */
4099 while (next_serial < MAX_SERIAL_PORTS && serial_hds[next_serial]) {
4100 chr = serial_hds[next_serial++];
4101 qemu_chr_fe_claim_no_fail(chr);
4107 QemuOptsList qemu_chardev_opts = {
4109 .implied_opt_name = "backend",
4110 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4114 .type = QEMU_OPT_STRING,
4117 .type = QEMU_OPT_STRING,
4120 .type = QEMU_OPT_STRING,
4123 .type = QEMU_OPT_STRING,
4125 .name = "localaddr",
4126 .type = QEMU_OPT_STRING,
4128 .name = "localport",
4129 .type = QEMU_OPT_STRING,
4132 .type = QEMU_OPT_NUMBER,
4135 .type = QEMU_OPT_BOOL,
4138 .type = QEMU_OPT_BOOL,
4141 .type = QEMU_OPT_BOOL,
4144 .type = QEMU_OPT_BOOL,
4147 .type = QEMU_OPT_BOOL,
4149 .name = "reconnect",
4150 .type = QEMU_OPT_NUMBER,
4153 .type = QEMU_OPT_BOOL,
4155 .name = "tls-creds",
4156 .type = QEMU_OPT_STRING,
4159 .type = QEMU_OPT_NUMBER,
4162 .type = QEMU_OPT_NUMBER,
4165 .type = QEMU_OPT_NUMBER,
4168 .type = QEMU_OPT_NUMBER,
4171 .type = QEMU_OPT_BOOL,
4174 .type = QEMU_OPT_BOOL,
4177 .type = QEMU_OPT_STRING,
4180 .type = QEMU_OPT_NUMBER,
4183 .type = QEMU_OPT_SIZE,
4186 .type = QEMU_OPT_STRING,
4189 .type = QEMU_OPT_BOOL,
4192 .type = QEMU_OPT_STRING,
4194 .name = "logappend",
4195 .type = QEMU_OPT_BOOL,
4197 { /* end of list */ }
4203 static CharDriverState *qmp_chardev_open_file(const char *id,
4204 ChardevBackend *backend,
4208 ChardevFile *file = backend->u.file.data;
4209 ChardevCommon *common = qapi_ChardevFile_base(file);
4213 error_setg(errp, "input file not supported");
4217 out = CreateFile(file->out, GENERIC_WRITE, FILE_SHARE_READ, NULL,
4218 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
4219 if (out == INVALID_HANDLE_VALUE) {
4220 error_setg(errp, "open %s failed", file->out);
4223 return qemu_chr_open_win_file(out, common, errp);
4226 static CharDriverState *qmp_chardev_open_serial(const char *id,
4227 ChardevBackend *backend,
4231 ChardevHostdev *serial = backend->u.serial.data;
4232 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4233 return qemu_chr_open_win_path(serial->device, common, errp);
4238 static int qmp_chardev_open_file_source(char *src, int flags,
4243 TFR(fd = qemu_open(src, flags, 0666));
4245 error_setg_file_open(errp, errno, src);
4250 static CharDriverState *qmp_chardev_open_file(const char *id,
4251 ChardevBackend *backend,
4255 ChardevFile *file = backend->u.file.data;
4256 ChardevCommon *common = qapi_ChardevFile_base(file);
4257 int flags, in = -1, out;
4259 flags = O_WRONLY | O_CREAT | O_BINARY;
4260 if (file->has_append && file->append) {
4266 out = qmp_chardev_open_file_source(file->out, flags, errp);
4273 in = qmp_chardev_open_file_source(file->in, flags, errp);
4280 return qemu_chr_open_fd(in, out, common, errp);
4283 #ifdef HAVE_CHARDEV_SERIAL
4284 static CharDriverState *qmp_chardev_open_serial(const char *id,
4285 ChardevBackend *backend,
4289 ChardevHostdev *serial = backend->u.serial.data;
4290 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4293 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4297 qemu_set_nonblock(fd);
4298 return qemu_chr_open_tty_fd(fd, common, errp);
4302 #ifdef HAVE_CHARDEV_PARPORT
4303 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4304 ChardevBackend *backend,
4308 ChardevHostdev *parallel = backend->u.parallel.data;
4309 ChardevCommon *common = qapi_ChardevHostdev_base(parallel);
4312 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4316 return qemu_chr_open_pp_fd(fd, common, errp);
4322 static gboolean socket_reconnect_timeout(gpointer opaque)
4324 CharDriverState *chr = opaque;
4325 TCPCharDriver *s = chr->opaque;
4326 QIOChannelSocket *sioc;
4328 s->reconnect_timer = 0;
4334 sioc = qio_channel_socket_new();
4335 qio_channel_socket_connect_async(sioc, s->addr,
4336 qemu_chr_socket_connected,
4342 static CharDriverState *qmp_chardev_open_socket(const char *id,
4343 ChardevBackend *backend,
4347 CharDriverState *chr;
4349 ChardevSocket *sock = backend->u.socket.data;
4350 SocketAddress *addr = sock->addr;
4351 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4352 bool is_listen = sock->has_server ? sock->server : true;
4353 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4354 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4355 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4356 ChardevCommon *common = qapi_ChardevSocket_base(sock);
4357 QIOChannelSocket *sioc = NULL;
4359 chr = qemu_chr_alloc(common, errp);
4363 s = g_new0(TCPCharDriver, 1);
4365 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4366 s->is_listen = is_listen;
4367 s->is_telnet = is_telnet;
4368 s->do_nodelay = do_nodelay;
4369 if (sock->tls_creds) {
4371 creds = object_resolve_path_component(
4372 object_get_objects_root(), sock->tls_creds);
4374 error_setg(errp, "No TLS credentials with id '%s'",
4378 s->tls_creds = (QCryptoTLSCreds *)
4379 object_dynamic_cast(creds,
4380 TYPE_QCRYPTO_TLS_CREDS);
4381 if (!s->tls_creds) {
4382 error_setg(errp, "Object with id '%s' is not TLS credentials",
4386 object_ref(OBJECT(s->tls_creds));
4388 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4389 error_setg(errp, "%s",
4390 "Expected TLS credentials for server endpoint");
4394 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4395 error_setg(errp, "%s",
4396 "Expected TLS credentials for client endpoint");
4402 qapi_copy_SocketAddress(&s->addr, sock->addr);
4405 chr->chr_write = tcp_chr_write;
4406 chr->chr_sync_read = tcp_chr_sync_read;
4407 chr->chr_close = tcp_chr_close;
4408 chr->get_msgfds = tcp_get_msgfds;
4409 chr->set_msgfds = tcp_set_msgfds;
4410 chr->chr_add_client = tcp_chr_add_client;
4411 chr->chr_add_watch = tcp_chr_add_watch;
4412 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4413 /* be isn't opened until we get a connection */
4414 chr->explicit_be_open = true;
4416 chr->filename = SocketAddress_to_str("disconnected:",
4417 addr, is_listen, is_telnet);
4421 s->do_telnetopt = 1;
4423 } else if (reconnect > 0) {
4424 s->reconnect_time = reconnect;
4427 sioc = qio_channel_socket_new();
4428 if (s->reconnect_time) {
4429 qio_channel_socket_connect_async(sioc, s->addr,
4430 qemu_chr_socket_connected,
4432 } else if (s->is_listen) {
4433 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4436 s->listen_ioc = sioc;
4437 if (is_waitconnect) {
4438 fprintf(stderr, "QEMU waiting for connection on: %s\n",
4440 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
4442 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
4444 s->listen_tag = qio_channel_add_watch(
4445 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
4448 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
4451 tcp_chr_new_client(chr, sioc);
4452 object_unref(OBJECT(sioc));
4459 object_unref(OBJECT(sioc));
4462 object_unref(OBJECT(s->tls_creds));
4465 qemu_chr_free_common(chr);
4469 static CharDriverState *qmp_chardev_open_udp(const char *id,
4470 ChardevBackend *backend,
4474 ChardevUdp *udp = backend->u.udp.data;
4475 ChardevCommon *common = qapi_ChardevUdp_base(udp);
4476 QIOChannelSocket *sioc = qio_channel_socket_new();
4478 if (qio_channel_socket_dgram_sync(sioc,
4479 udp->local, udp->remote,
4481 object_unref(OBJECT(sioc));
4484 return qemu_chr_open_udp(sioc, common, errp);
4487 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4490 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4491 CharDriverState *chr = NULL;
4492 Error *local_err = NULL;
4496 chr = qemu_chr_find(id);
4498 error_setg(errp, "Chardev '%s' already exists", id);
4503 for (i = backends; i; i = i->next) {
4506 if (cd->kind == backend->type) {
4507 chr = cd->create(id, backend, ret, &local_err);
4509 error_propagate(errp, local_err);
4518 error_setg(errp, "chardev backend not available");
4522 chr->label = g_strdup(id);
4523 chr->avail_connections =
4524 (backend->type == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4525 if (!chr->filename) {
4526 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4528 if (!chr->explicit_be_open) {
4529 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4531 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4539 void qmp_chardev_remove(const char *id, Error **errp)
4541 CharDriverState *chr;
4543 chr = qemu_chr_find(id);
4545 error_setg(errp, "Chardev '%s' not found", id);
4548 if (chr->chr_can_read || chr->chr_read ||
4549 chr->chr_event || chr->handler_opaque) {
4550 error_setg(errp, "Chardev '%s' is busy", id);
4555 "Chardev '%s' cannot be unplugged in record/replay mode", id);
4558 qemu_chr_delete(chr);
4561 static void register_types(void)
4563 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4564 qemu_chr_open_null);
4565 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4566 qemu_chr_parse_socket, qmp_chardev_open_socket);
4567 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4568 qmp_chardev_open_udp);
4569 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4570 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4571 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4572 qemu_chr_parse_file_out, qmp_chardev_open_file);
4573 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4574 qemu_chr_parse_stdio, qemu_chr_open_stdio);
4575 #if defined HAVE_CHARDEV_SERIAL
4576 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4577 qemu_chr_parse_serial, qmp_chardev_open_serial);
4578 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4579 qemu_chr_parse_serial, qmp_chardev_open_serial);
4581 #ifdef HAVE_CHARDEV_PARPORT
4582 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4583 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4584 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4585 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4587 #ifdef HAVE_CHARDEV_PTY
4588 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4592 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4593 qemu_chr_open_win_con);
4595 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4596 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4597 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4599 /* Bug-compatibility: */
4600 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4601 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4602 /* this must be done after machine init, since we register FEs with muxes
4603 * as part of realize functions like serial_isa_realizefn when -nographic
4606 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4609 type_init(register_types);