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 "monitor/monitor.h"
27 #include "sysemu/sysemu.h"
28 #include "qemu/error-report.h"
29 #include "qemu/timer.h"
30 #include "sysemu/char.h"
32 #include "qmp-commands.h"
33 #include "qapi/qmp-input-visitor.h"
34 #include "qapi/qmp-output-visitor.h"
35 #include "qapi-visit.h"
36 #include "qemu/base64.h"
37 #include "io/channel-socket.h"
38 #include "io/channel-file.h"
39 #include "io/channel-tls.h"
44 #include <sys/times.h>
48 #include <sys/ioctl.h>
49 #include <sys/resource.h>
50 #include <sys/socket.h>
51 #include <netinet/in.h>
53 #include <arpa/inet.h>
55 #include <sys/select.h>
57 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
58 #include <dev/ppbus/ppi.h>
59 #include <dev/ppbus/ppbconf.h>
60 #elif defined(__DragonFly__)
61 #include <dev/misc/ppi/ppi.h>
62 #include <bus/ppbus/ppbconf.h>
66 #include <linux/ppdev.h>
67 #include <linux/parport.h>
70 #include <sys/ethernet.h>
71 #include <sys/sockio.h>
72 #include <netinet/arp.h>
73 #include <netinet/in.h>
74 #include <netinet/in_systm.h>
75 #include <netinet/ip.h>
76 #include <netinet/ip_icmp.h> // must come after ip.h
77 #include <netinet/udp.h>
78 #include <netinet/tcp.h>
83 #include "qemu/sockets.h"
84 #include "ui/qemu-spice.h"
86 #define READ_BUF_LEN 4096
87 #define READ_RETRIES 10
88 #define TCP_MAX_FDS 16
90 /***********************************************************/
91 /* Socket address helpers */
93 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
94 bool is_listen, bool is_telnet)
97 case SOCKET_ADDRESS_KIND_INET:
98 return g_strdup_printf("%s%s:%s:%s%s", prefix,
99 is_telnet ? "telnet" : "tcp", addr->u.inet->host,
100 addr->u.inet->port, is_listen ? ",server" : "");
102 case SOCKET_ADDRESS_KIND_UNIX:
103 return g_strdup_printf("%sunix:%s%s", prefix,
104 addr->u.q_unix->path,
105 is_listen ? ",server" : "");
107 case SOCKET_ADDRESS_KIND_FD:
108 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd->str,
109 is_listen ? ",server" : "");
116 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
117 struct sockaddr_storage *ps, socklen_t ps_len,
118 bool is_listen, bool is_telnet)
120 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
121 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
122 const char *left = "", *right = "";
124 switch (ss->ss_family) {
127 return g_strdup_printf("unix:%s%s",
128 ((struct sockaddr_un *)(ss))->sun_path,
129 is_listen ? ",server" : "");
136 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
137 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
138 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
139 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
140 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
141 is_telnet ? "telnet" : "tcp",
142 left, shost, right, sserv,
143 is_listen ? ",server" : "",
144 left, phost, right, pserv);
147 return g_strdup_printf("unknown");
151 /***********************************************************/
152 /* character device */
154 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
155 QTAILQ_HEAD_INITIALIZER(chardevs);
157 static void qemu_chr_free_common(CharDriverState *chr);
159 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp)
161 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
162 qemu_mutex_init(&chr->chr_write_lock);
164 if (backend->has_logfile) {
165 int flags = O_WRONLY | O_CREAT;
166 if (backend->has_logappend &&
167 backend->logappend) {
172 chr->logfd = qemu_open(backend->logfile, flags, 0666);
173 if (chr->logfd < 0) {
174 error_setg_errno(errp, errno,
175 "Unable to open logfile %s",
187 void qemu_chr_be_event(CharDriverState *s, int event)
189 /* Keep track if the char device is open */
191 case CHR_EVENT_OPENED:
194 case CHR_EVENT_CLOSED:
201 s->chr_event(s->handler_opaque, event);
204 void qemu_chr_be_generic_open(CharDriverState *s)
206 qemu_chr_be_event(s, CHR_EVENT_OPENED);
210 /* Not reporting errors from writing to logfile, as logs are
211 * defined to be "best effort" only */
212 static void qemu_chr_fe_write_log(CharDriverState *s,
213 const uint8_t *buf, size_t len)
224 ret = write(s->logfd, buf + done, len - done);
225 if (ret == -1 && errno == EAGAIN) {
228 } while (ret == -1 && errno == EAGAIN);
237 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len)
241 qemu_mutex_lock(&s->chr_write_lock);
242 ret = s->chr_write(s, buf, len);
245 qemu_chr_fe_write_log(s, buf, ret);
248 qemu_mutex_unlock(&s->chr_write_lock);
252 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len)
257 qemu_mutex_lock(&s->chr_write_lock);
258 while (offset < len) {
260 res = s->chr_write(s, buf + offset, len - offset);
261 if (res == -1 && errno == EAGAIN) {
264 } while (res == -1 && errno == EAGAIN);
273 qemu_chr_fe_write_log(s, buf, offset);
276 qemu_mutex_unlock(&s->chr_write_lock);
284 int qemu_chr_fe_read_all(CharDriverState *s, uint8_t *buf, int len)
286 int offset = 0, counter = 10;
289 if (!s->chr_sync_read) {
293 while (offset < len) {
295 res = s->chr_sync_read(s, buf + offset, len - offset);
296 if (res == -1 && errno == EAGAIN) {
299 } while (res == -1 && errno == EAGAIN);
319 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg)
323 return s->chr_ioctl(s, cmd, arg);
326 int qemu_chr_be_can_write(CharDriverState *s)
328 if (!s->chr_can_read)
330 return s->chr_can_read(s->handler_opaque);
333 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
336 s->chr_read(s->handler_opaque, buf, len);
340 int qemu_chr_fe_get_msgfd(CharDriverState *s)
343 return (qemu_chr_fe_get_msgfds(s, &fd, 1) == 1) ? fd : -1;
346 int qemu_chr_fe_get_msgfds(CharDriverState *s, int *fds, int len)
348 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
351 int qemu_chr_fe_set_msgfds(CharDriverState *s, int *fds, int num)
353 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
356 int qemu_chr_add_client(CharDriverState *s, int fd)
358 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
361 void qemu_chr_accept_input(CharDriverState *s)
363 if (s->chr_accept_input)
364 s->chr_accept_input(s);
368 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
370 char buf[READ_BUF_LEN];
373 vsnprintf(buf, sizeof(buf), fmt, ap);
374 qemu_chr_fe_write(s, (uint8_t *)buf, strlen(buf));
378 static void remove_fd_in_watch(CharDriverState *chr);
380 void qemu_chr_add_handlers(CharDriverState *s,
381 IOCanReadHandler *fd_can_read,
382 IOReadHandler *fd_read,
383 IOEventHandler *fd_event,
388 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
390 remove_fd_in_watch(s);
394 s->chr_can_read = fd_can_read;
395 s->chr_read = fd_read;
396 s->chr_event = fd_event;
397 s->handler_opaque = opaque;
398 if (fe_open && s->chr_update_read_handler)
399 s->chr_update_read_handler(s);
401 if (!s->explicit_fe_open) {
402 qemu_chr_fe_set_open(s, fe_open);
405 /* We're connecting to an already opened device, so let's make sure we
406 also get the open event */
407 if (fe_open && s->be_open) {
408 qemu_chr_be_generic_open(s);
412 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
417 static CharDriverState *qemu_chr_open_null(const char *id,
418 ChardevBackend *backend,
422 CharDriverState *chr;
423 ChardevCommon *common = qapi_ChardevDummy_base(backend->u.null);
425 chr = qemu_chr_alloc(common, errp);
429 chr->chr_write = null_chr_write;
430 chr->explicit_be_open = true;
434 /* MUX driver for serial I/O splitting */
436 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
437 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
439 IOCanReadHandler *chr_can_read[MAX_MUX];
440 IOReadHandler *chr_read[MAX_MUX];
441 IOEventHandler *chr_event[MAX_MUX];
442 void *ext_opaque[MAX_MUX];
443 CharDriverState *drv;
448 /* Intermediate input buffer allows to catch escape sequences even if the
449 currently active device is not accepting any input - but only until it
451 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
456 /* Protected by the CharDriverState chr_write_lock. */
458 int64_t timestamps_start;
462 /* Called with chr_write_lock held. */
463 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
465 MuxDriver *d = chr->opaque;
467 if (!d->timestamps) {
468 ret = qemu_chr_fe_write(d->drv, buf, len);
473 for (i = 0; i < len; i++) {
479 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
480 if (d->timestamps_start == -1)
481 d->timestamps_start = ti;
482 ti -= d->timestamps_start;
484 snprintf(buf1, sizeof(buf1),
485 "[%02d:%02d:%02d.%03d] ",
490 qemu_chr_fe_write(d->drv, (uint8_t *)buf1, strlen(buf1));
493 ret += qemu_chr_fe_write(d->drv, buf+i, 1);
494 if (buf[i] == '\n') {
502 static const char * const mux_help[] = {
503 "% h print this help\n\r",
504 "% x exit emulator\n\r",
505 "% s save disk data back to file (if -snapshot)\n\r",
506 "% t toggle console timestamps\n\r",
507 "% b send break (magic sysrq)\n\r",
508 "% c switch between console and monitor\n\r",
513 int term_escape_char = 0x01; /* ctrl-a is used for escape */
514 static void mux_print_help(CharDriverState *chr)
517 char ebuf[15] = "Escape-Char";
518 char cbuf[50] = "\n\r";
520 if (term_escape_char > 0 && term_escape_char < 26) {
521 snprintf(cbuf, sizeof(cbuf), "\n\r");
522 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
524 snprintf(cbuf, sizeof(cbuf),
525 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
528 qemu_chr_fe_write(chr, (uint8_t *)cbuf, strlen(cbuf));
529 for (i = 0; mux_help[i] != NULL; i++) {
530 for (j=0; mux_help[i][j] != '\0'; j++) {
531 if (mux_help[i][j] == '%')
532 qemu_chr_fe_write(chr, (uint8_t *)ebuf, strlen(ebuf));
534 qemu_chr_fe_write(chr, (uint8_t *)&mux_help[i][j], 1);
539 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
541 if (d->chr_event[mux_nr])
542 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
545 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
547 if (d->term_got_escape) {
548 d->term_got_escape = 0;
549 if (ch == term_escape_char)
558 const char *term = "QEMU: Terminated\n\r";
559 qemu_chr_fe_write(chr, (uint8_t *)term, strlen(term));
567 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
570 /* Switch to the next registered device */
571 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
573 if (d->focus >= d->mux_cnt)
575 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
578 d->timestamps = !d->timestamps;
579 d->timestamps_start = -1;
583 } else if (ch == term_escape_char) {
584 d->term_got_escape = 1;
592 static void mux_chr_accept_input(CharDriverState *chr)
594 MuxDriver *d = chr->opaque;
597 while (d->prod[m] != d->cons[m] &&
598 d->chr_can_read[m] &&
599 d->chr_can_read[m](d->ext_opaque[m])) {
600 d->chr_read[m](d->ext_opaque[m],
601 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
605 static int mux_chr_can_read(void *opaque)
607 CharDriverState *chr = opaque;
608 MuxDriver *d = chr->opaque;
611 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
613 if (d->chr_can_read[m])
614 return d->chr_can_read[m](d->ext_opaque[m]);
618 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
620 CharDriverState *chr = opaque;
621 MuxDriver *d = chr->opaque;
625 mux_chr_accept_input (opaque);
627 for(i = 0; i < size; i++)
628 if (mux_proc_byte(chr, d, buf[i])) {
629 if (d->prod[m] == d->cons[m] &&
630 d->chr_can_read[m] &&
631 d->chr_can_read[m](d->ext_opaque[m]))
632 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
634 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
638 static void mux_chr_event(void *opaque, int event)
640 CharDriverState *chr = opaque;
641 MuxDriver *d = chr->opaque;
644 /* Send the event to all registered listeners */
645 for (i = 0; i < d->mux_cnt; i++)
646 mux_chr_send_event(d, i, event);
649 static void mux_chr_update_read_handler(CharDriverState *chr)
651 MuxDriver *d = chr->opaque;
653 if (d->mux_cnt >= MAX_MUX) {
654 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
657 d->ext_opaque[d->mux_cnt] = chr->handler_opaque;
658 d->chr_can_read[d->mux_cnt] = chr->chr_can_read;
659 d->chr_read[d->mux_cnt] = chr->chr_read;
660 d->chr_event[d->mux_cnt] = chr->chr_event;
661 /* Fix up the real driver with mux routines */
662 if (d->mux_cnt == 0) {
663 qemu_chr_add_handlers(d->drv, mux_chr_can_read, mux_chr_read,
666 if (d->focus != -1) {
667 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
669 d->focus = d->mux_cnt;
671 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
674 static bool muxes_realized;
677 * Called after processing of default and command-line-specified
678 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
679 * to a mux chardev. This is done here to ensure that
680 * output/prompts/banners are only displayed for the FE that has
681 * focus when initial command-line processing/machine init is
684 * After this point, any new FE attached to any new or existing
685 * mux will receive CHR_EVENT_OPENED notifications for the BE
688 static void muxes_realize_done(Notifier *notifier, void *unused)
690 CharDriverState *chr;
692 QTAILQ_FOREACH(chr, &chardevs, next) {
694 MuxDriver *d = chr->opaque;
697 /* send OPENED to all already-attached FEs */
698 for (i = 0; i < d->mux_cnt; i++) {
699 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
701 /* mark mux as OPENED so any new FEs will immediately receive
704 qemu_chr_be_generic_open(chr);
707 muxes_realized = true;
710 static Notifier muxes_realize_notify = {
711 .notify = muxes_realize_done,
714 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
716 MuxDriver *d = s->opaque;
717 return d->drv->chr_add_watch(d->drv, cond);
720 static CharDriverState *qemu_chr_open_mux(const char *id,
721 ChardevBackend *backend,
722 ChardevReturn *ret, Error **errp)
724 ChardevMux *mux = backend->u.mux;
725 CharDriverState *chr, *drv;
727 ChardevCommon *common = qapi_ChardevMux_base(backend->u.mux);
729 drv = qemu_chr_find(mux->chardev);
731 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
735 chr = qemu_chr_alloc(common, errp);
739 d = g_new0(MuxDriver, 1);
744 chr->chr_write = mux_chr_write;
745 chr->chr_update_read_handler = mux_chr_update_read_handler;
746 chr->chr_accept_input = mux_chr_accept_input;
747 /* Frontend guest-open / -close notification is not support with muxes */
748 chr->chr_set_fe_open = NULL;
749 if (drv->chr_add_watch) {
750 chr->chr_add_watch = mux_chr_add_watch;
752 /* only default to opened state if we've realized the initial
755 chr->explicit_be_open = muxes_realized ? 0 : 1;
762 typedef struct IOWatchPoll
769 IOCanReadHandler *fd_can_read;
774 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
776 return container_of(source, IOWatchPoll, parent);
779 static gboolean io_watch_poll_prepare(GSource *source, gint *timeout_)
781 IOWatchPoll *iwp = io_watch_poll_from_source(source);
782 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
783 bool was_active = iwp->src != NULL;
784 if (was_active == now_active) {
789 iwp->src = qio_channel_create_watch(
790 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
791 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
792 g_source_attach(iwp->src, NULL);
794 g_source_destroy(iwp->src);
795 g_source_unref(iwp->src);
801 static gboolean io_watch_poll_check(GSource *source)
806 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
812 static void io_watch_poll_finalize(GSource *source)
814 /* Due to a glib bug, removing the last reference to a source
815 * inside a finalize callback causes recursive locking (and a
816 * deadlock). This is not a problem inside other callbacks,
817 * including dispatch callbacks, so we call io_remove_watch_poll
818 * to remove this source. At this point, iwp->src must
819 * be NULL, or we would leak it.
821 * This would be solved much more elegantly by child sources,
822 * but we support older glib versions that do not have them.
824 IOWatchPoll *iwp = io_watch_poll_from_source(source);
825 assert(iwp->src == NULL);
828 static GSourceFuncs io_watch_poll_funcs = {
829 .prepare = io_watch_poll_prepare,
830 .check = io_watch_poll_check,
831 .dispatch = io_watch_poll_dispatch,
832 .finalize = io_watch_poll_finalize,
835 /* Can only be used for read */
836 static guint io_add_watch_poll(QIOChannel *ioc,
837 IOCanReadHandler *fd_can_read,
838 QIOChannelFunc fd_read,
844 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs, sizeof(IOWatchPoll));
845 iwp->fd_can_read = fd_can_read;
846 iwp->opaque = user_data;
848 iwp->fd_read = (GSourceFunc) fd_read;
851 tag = g_source_attach(&iwp->parent, NULL);
852 g_source_unref(&iwp->parent);
856 static void io_remove_watch_poll(guint tag)
861 g_return_if_fail (tag > 0);
863 source = g_main_context_find_source_by_id(NULL, tag);
864 g_return_if_fail (source != NULL);
866 iwp = io_watch_poll_from_source(source);
868 g_source_destroy(iwp->src);
869 g_source_unref(iwp->src);
872 g_source_destroy(&iwp->parent);
875 static void remove_fd_in_watch(CharDriverState *chr)
877 if (chr->fd_in_tag) {
878 io_remove_watch_poll(chr->fd_in_tag);
884 static int io_channel_send_full(QIOChannel *ioc,
885 const void *buf, size_t len,
886 int *fds, size_t nfds)
890 while (offset < len) {
892 struct iovec iov = { .iov_base = (char *)buf + offset,
893 .iov_len = len - offset };
895 ret = qio_channel_writev_full(
898 if (ret == QIO_CHANNEL_ERR_BLOCK) {
901 } else if (ret < 0) {
918 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
920 return io_channel_send_full(ioc, buf, len, NULL, 0);
924 typedef struct FDCharDriver {
925 CharDriverState *chr;
926 QIOChannel *ioc_in, *ioc_out;
930 /* Called with chr_write_lock held. */
931 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
933 FDCharDriver *s = chr->opaque;
935 return io_channel_send(s->ioc_out, buf, len);
938 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
940 CharDriverState *chr = opaque;
941 FDCharDriver *s = chr->opaque;
943 uint8_t buf[READ_BUF_LEN];
947 if (len > s->max_size) {
954 ret = qio_channel_read(
955 chan, (gchar *)buf, len, NULL);
957 remove_fd_in_watch(chr);
958 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
962 qemu_chr_be_write(chr, buf, ret);
968 static int fd_chr_read_poll(void *opaque)
970 CharDriverState *chr = opaque;
971 FDCharDriver *s = chr->opaque;
973 s->max_size = qemu_chr_be_can_write(chr);
977 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
979 FDCharDriver *s = chr->opaque;
980 return qio_channel_create_watch(s->ioc_out, cond);
983 static void fd_chr_update_read_handler(CharDriverState *chr)
985 FDCharDriver *s = chr->opaque;
987 remove_fd_in_watch(chr);
989 chr->fd_in_tag = io_add_watch_poll(s->ioc_in,
995 static void fd_chr_close(struct CharDriverState *chr)
997 FDCharDriver *s = chr->opaque;
999 remove_fd_in_watch(chr);
1001 object_unref(OBJECT(s->ioc_in));
1004 object_unref(OBJECT(s->ioc_out));
1008 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1011 /* open a character device to a unix fd */
1012 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out,
1013 ChardevCommon *backend, Error **errp)
1015 CharDriverState *chr;
1018 chr = qemu_chr_alloc(backend, errp);
1022 s = g_new0(FDCharDriver, 1);
1023 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1024 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1025 qemu_set_nonblock(fd_out);
1028 chr->chr_add_watch = fd_chr_add_watch;
1029 chr->chr_write = fd_chr_write;
1030 chr->chr_update_read_handler = fd_chr_update_read_handler;
1031 chr->chr_close = fd_chr_close;
1036 static CharDriverState *qemu_chr_open_pipe(const char *id,
1037 ChardevBackend *backend,
1041 ChardevHostdev *opts = backend->u.pipe;
1045 const char *filename = opts->device;
1046 ChardevCommon *common = qapi_ChardevHostdev_base(backend->u.pipe);
1049 filename_in = g_strdup_printf("%s.in", filename);
1050 filename_out = g_strdup_printf("%s.out", filename);
1051 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1052 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1053 g_free(filename_in);
1054 g_free(filename_out);
1055 if (fd_in < 0 || fd_out < 0) {
1060 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1062 error_setg_file_open(errp, errno, filename);
1066 return qemu_chr_open_fd(fd_in, fd_out, common, errp);
1069 /* init terminal so that we can grab keys */
1070 static struct termios oldtty;
1071 static int old_fd0_flags;
1072 static bool stdio_in_use;
1073 static bool stdio_allow_signal;
1074 static bool stdio_echo_state;
1076 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1078 static void term_exit(void)
1080 tcsetattr (0, TCSANOW, &oldtty);
1081 fcntl(0, F_SETFL, old_fd0_flags);
1084 static void term_stdio_handler(int sig)
1086 /* restore echo after resume from suspend. */
1087 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1090 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1094 stdio_echo_state = echo;
1097 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1098 |INLCR|IGNCR|ICRNL|IXON);
1099 tty.c_oflag |= OPOST;
1100 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1101 tty.c_cflag &= ~(CSIZE|PARENB);
1104 tty.c_cc[VTIME] = 0;
1106 if (!stdio_allow_signal)
1107 tty.c_lflag &= ~ISIG;
1109 tcsetattr (0, TCSANOW, &tty);
1112 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1118 static CharDriverState *qemu_chr_open_stdio(const char *id,
1119 ChardevBackend *backend,
1123 ChardevStdio *opts = backend->u.stdio;
1124 CharDriverState *chr;
1125 struct sigaction act;
1126 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio);
1128 if (is_daemonized()) {
1129 error_setg(errp, "cannot use stdio with -daemonize");
1134 error_setg(errp, "cannot use stdio by multiple character devices");
1138 stdio_in_use = true;
1139 old_fd0_flags = fcntl(0, F_GETFL);
1140 tcgetattr(0, &oldtty);
1141 qemu_set_nonblock(0);
1144 memset(&act, 0, sizeof(act));
1145 act.sa_handler = term_stdio_handler;
1146 sigaction(SIGCONT, &act, NULL);
1148 chr = qemu_chr_open_fd(0, 1, common, errp);
1149 chr->chr_close = qemu_chr_close_stdio;
1150 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1151 if (opts->has_signal) {
1152 stdio_allow_signal = opts->signal;
1154 qemu_chr_fe_set_echo(chr, false);
1159 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1160 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1161 || defined(__GLIBC__)
1163 #define HAVE_CHARDEV_SERIAL 1
1164 #define HAVE_CHARDEV_PTY 1
1170 /* Protected by the CharDriverState chr_write_lock. */
1177 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1178 static void pty_chr_state(CharDriverState *chr, int connected);
1180 static gboolean pty_chr_timer(gpointer opaque)
1182 struct CharDriverState *chr = opaque;
1183 PtyCharDriver *s = chr->opaque;
1185 qemu_mutex_lock(&chr->chr_write_lock);
1188 if (!s->connected) {
1190 pty_chr_update_read_handler_locked(chr);
1192 qemu_mutex_unlock(&chr->chr_write_lock);
1196 /* Called with chr_write_lock held. */
1197 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1199 PtyCharDriver *s = chr->opaque;
1202 g_source_remove(s->timer_tag);
1207 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1209 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1213 /* Called with chr_write_lock held. */
1214 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1216 PtyCharDriver *s = chr->opaque;
1219 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1222 pfd.events = G_IO_OUT;
1225 rc = g_poll(&pfd, 1, 0);
1226 } while (rc == -1 && errno == EINTR);
1229 if (pfd.revents & G_IO_HUP) {
1230 pty_chr_state(chr, 0);
1232 pty_chr_state(chr, 1);
1236 static void pty_chr_update_read_handler(CharDriverState *chr)
1238 qemu_mutex_lock(&chr->chr_write_lock);
1239 pty_chr_update_read_handler_locked(chr);
1240 qemu_mutex_unlock(&chr->chr_write_lock);
1243 /* Called with chr_write_lock held. */
1244 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1246 PtyCharDriver *s = chr->opaque;
1248 if (!s->connected) {
1249 /* guest sends data, check for (re-)connect */
1250 pty_chr_update_read_handler_locked(chr);
1251 if (!s->connected) {
1255 return io_channel_send(s->ioc, buf, len);
1258 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1260 PtyCharDriver *s = chr->opaque;
1261 if (!s->connected) {
1264 return qio_channel_create_watch(s->ioc, cond);
1267 static int pty_chr_read_poll(void *opaque)
1269 CharDriverState *chr = opaque;
1270 PtyCharDriver *s = chr->opaque;
1272 s->read_bytes = qemu_chr_be_can_write(chr);
1273 return s->read_bytes;
1276 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1278 CharDriverState *chr = opaque;
1279 PtyCharDriver *s = chr->opaque;
1281 uint8_t buf[READ_BUF_LEN];
1285 if (len > s->read_bytes)
1286 len = s->read_bytes;
1290 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1292 pty_chr_state(chr, 0);
1295 pty_chr_state(chr, 1);
1296 qemu_chr_be_write(chr, buf, ret);
1301 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1303 CharDriverState *chr = opaque;
1304 PtyCharDriver *s = chr->opaque;
1307 qemu_chr_be_generic_open(chr);
1311 /* Called with chr_write_lock held. */
1312 static void pty_chr_state(CharDriverState *chr, int connected)
1314 PtyCharDriver *s = chr->opaque;
1318 g_source_remove(s->open_tag);
1321 remove_fd_in_watch(chr);
1323 /* (re-)connect poll interval for idle guests: once per second.
1324 * We check more frequently in case the guests sends data to
1325 * the virtual device linked to our pty. */
1326 pty_chr_rearm_timer(chr, 1000);
1329 g_source_remove(s->timer_tag);
1332 if (!s->connected) {
1333 g_assert(s->open_tag == 0);
1335 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1337 if (!chr->fd_in_tag) {
1338 chr->fd_in_tag = io_add_watch_poll(s->ioc,
1345 static void pty_chr_close(struct CharDriverState *chr)
1347 PtyCharDriver *s = chr->opaque;
1349 qemu_mutex_lock(&chr->chr_write_lock);
1350 pty_chr_state(chr, 0);
1352 object_unref(OBJECT(s->ioc));
1354 g_source_remove(s->timer_tag);
1357 qemu_mutex_unlock(&chr->chr_write_lock);
1359 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1362 static CharDriverState *qemu_chr_open_pty(const char *id,
1363 ChardevBackend *backend,
1367 CharDriverState *chr;
1369 int master_fd, slave_fd;
1370 char pty_name[PATH_MAX];
1371 ChardevCommon *common = qapi_ChardevDummy_base(backend->u.pty);
1373 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1374 if (master_fd < 0) {
1375 error_setg_errno(errp, errno, "Failed to create PTY");
1379 qemu_set_nonblock(master_fd);
1381 chr = qemu_chr_alloc(common, errp);
1387 chr->filename = g_strdup_printf("pty:%s", pty_name);
1388 ret->pty = g_strdup(pty_name);
1389 ret->has_pty = true;
1391 fprintf(stderr, "char device redirected to %s (label %s)\n",
1394 s = g_new0(PtyCharDriver, 1);
1396 chr->chr_write = pty_chr_write;
1397 chr->chr_update_read_handler = pty_chr_update_read_handler;
1398 chr->chr_close = pty_chr_close;
1399 chr->chr_add_watch = pty_chr_add_watch;
1400 chr->explicit_be_open = true;
1402 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1403 s->slave_fd = slave_fd;
1409 static void tty_serial_init(int fd, int speed,
1410 int parity, int data_bits, int stop_bits)
1416 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1417 speed, parity, data_bits, stop_bits);
1419 tcgetattr (fd, &tty);
1421 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1422 speed = speed * 10 / 11;
1439 /* Non-Posix values follow. They may be unsupported on some systems. */
1441 check_speed(115200);
1443 check_speed(230400);
1446 check_speed(460800);
1449 check_speed(500000);
1452 check_speed(576000);
1455 check_speed(921600);
1458 check_speed(1000000);
1461 check_speed(1152000);
1464 check_speed(1500000);
1467 check_speed(2000000);
1470 check_speed(2500000);
1473 check_speed(3000000);
1476 check_speed(3500000);
1479 check_speed(4000000);
1484 cfsetispeed(&tty, spd);
1485 cfsetospeed(&tty, spd);
1487 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1488 |INLCR|IGNCR|ICRNL|IXON);
1489 tty.c_oflag |= OPOST;
1490 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1491 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1512 tty.c_cflag |= PARENB;
1515 tty.c_cflag |= PARENB | PARODD;
1519 tty.c_cflag |= CSTOPB;
1521 tcsetattr (fd, TCSANOW, &tty);
1524 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1526 FDCharDriver *s = chr->opaque;
1527 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1530 case CHR_IOCTL_SERIAL_SET_PARAMS:
1532 QEMUSerialSetParams *ssp = arg;
1533 tty_serial_init(fioc->fd,
1534 ssp->speed, ssp->parity,
1535 ssp->data_bits, ssp->stop_bits);
1538 case CHR_IOCTL_SERIAL_SET_BREAK:
1540 int enable = *(int *)arg;
1542 tcsendbreak(fioc->fd, 1);
1546 case CHR_IOCTL_SERIAL_GET_TIOCM:
1549 int *targ = (int *)arg;
1550 ioctl(fioc->fd, TIOCMGET, &sarg);
1552 if (sarg & TIOCM_CTS)
1553 *targ |= CHR_TIOCM_CTS;
1554 if (sarg & TIOCM_CAR)
1555 *targ |= CHR_TIOCM_CAR;
1556 if (sarg & TIOCM_DSR)
1557 *targ |= CHR_TIOCM_DSR;
1558 if (sarg & TIOCM_RI)
1559 *targ |= CHR_TIOCM_RI;
1560 if (sarg & TIOCM_DTR)
1561 *targ |= CHR_TIOCM_DTR;
1562 if (sarg & TIOCM_RTS)
1563 *targ |= CHR_TIOCM_RTS;
1566 case CHR_IOCTL_SERIAL_SET_TIOCM:
1568 int sarg = *(int *)arg;
1570 ioctl(fioc->fd, TIOCMGET, &targ);
1571 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1572 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1573 if (sarg & CHR_TIOCM_CTS)
1575 if (sarg & CHR_TIOCM_CAR)
1577 if (sarg & CHR_TIOCM_DSR)
1579 if (sarg & CHR_TIOCM_RI)
1581 if (sarg & CHR_TIOCM_DTR)
1583 if (sarg & CHR_TIOCM_RTS)
1585 ioctl(fioc->fd, TIOCMSET, &targ);
1594 static void qemu_chr_close_tty(CharDriverState *chr)
1599 static CharDriverState *qemu_chr_open_tty_fd(int fd,
1600 ChardevCommon *backend,
1603 CharDriverState *chr;
1605 tty_serial_init(fd, 115200, 'N', 8, 1);
1606 chr = qemu_chr_open_fd(fd, fd, backend, errp);
1607 chr->chr_ioctl = tty_serial_ioctl;
1608 chr->chr_close = qemu_chr_close_tty;
1611 #endif /* __linux__ || __sun__ */
1613 #if defined(__linux__)
1615 #define HAVE_CHARDEV_PARPORT 1
1620 } ParallelCharDriver;
1622 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1624 if (s->mode != mode) {
1626 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1633 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1635 ParallelCharDriver *drv = chr->opaque;
1640 case CHR_IOCTL_PP_READ_DATA:
1641 if (ioctl(fd, PPRDATA, &b) < 0)
1643 *(uint8_t *)arg = b;
1645 case CHR_IOCTL_PP_WRITE_DATA:
1646 b = *(uint8_t *)arg;
1647 if (ioctl(fd, PPWDATA, &b) < 0)
1650 case CHR_IOCTL_PP_READ_CONTROL:
1651 if (ioctl(fd, PPRCONTROL, &b) < 0)
1653 /* Linux gives only the lowest bits, and no way to know data
1654 direction! For better compatibility set the fixed upper
1656 *(uint8_t *)arg = b | 0xc0;
1658 case CHR_IOCTL_PP_WRITE_CONTROL:
1659 b = *(uint8_t *)arg;
1660 if (ioctl(fd, PPWCONTROL, &b) < 0)
1663 case CHR_IOCTL_PP_READ_STATUS:
1664 if (ioctl(fd, PPRSTATUS, &b) < 0)
1666 *(uint8_t *)arg = b;
1668 case CHR_IOCTL_PP_DATA_DIR:
1669 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1672 case CHR_IOCTL_PP_EPP_READ_ADDR:
1673 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1674 struct ParallelIOArg *parg = arg;
1675 int n = read(fd, parg->buffer, parg->count);
1676 if (n != parg->count) {
1681 case CHR_IOCTL_PP_EPP_READ:
1682 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1683 struct ParallelIOArg *parg = arg;
1684 int n = read(fd, parg->buffer, parg->count);
1685 if (n != parg->count) {
1690 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1691 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1692 struct ParallelIOArg *parg = arg;
1693 int n = write(fd, parg->buffer, parg->count);
1694 if (n != parg->count) {
1699 case CHR_IOCTL_PP_EPP_WRITE:
1700 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1701 struct ParallelIOArg *parg = arg;
1702 int n = write(fd, parg->buffer, parg->count);
1703 if (n != parg->count) {
1714 static void pp_close(CharDriverState *chr)
1716 ParallelCharDriver *drv = chr->opaque;
1719 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1720 ioctl(fd, PPRELEASE);
1723 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1726 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1727 ChardevCommon *backend,
1730 CharDriverState *chr;
1731 ParallelCharDriver *drv;
1733 if (ioctl(fd, PPCLAIM) < 0) {
1734 error_setg_errno(errp, errno, "not a parallel port");
1739 chr = qemu_chr_alloc(backend, errp);
1744 drv = g_new0(ParallelCharDriver, 1);
1746 chr->chr_write = null_chr_write;
1747 chr->chr_ioctl = pp_ioctl;
1748 chr->chr_close = pp_close;
1751 drv->mode = IEEE1284_MODE_COMPAT;
1755 #endif /* __linux__ */
1757 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1759 #define HAVE_CHARDEV_PARPORT 1
1761 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1763 int fd = (int)(intptr_t)chr->opaque;
1767 case CHR_IOCTL_PP_READ_DATA:
1768 if (ioctl(fd, PPIGDATA, &b) < 0)
1770 *(uint8_t *)arg = b;
1772 case CHR_IOCTL_PP_WRITE_DATA:
1773 b = *(uint8_t *)arg;
1774 if (ioctl(fd, PPISDATA, &b) < 0)
1777 case CHR_IOCTL_PP_READ_CONTROL:
1778 if (ioctl(fd, PPIGCTRL, &b) < 0)
1780 *(uint8_t *)arg = b;
1782 case CHR_IOCTL_PP_WRITE_CONTROL:
1783 b = *(uint8_t *)arg;
1784 if (ioctl(fd, PPISCTRL, &b) < 0)
1787 case CHR_IOCTL_PP_READ_STATUS:
1788 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1790 *(uint8_t *)arg = b;
1798 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1799 ChardevBackend *backend,
1802 CharDriverState *chr;
1804 chr = qemu_chr_alloc(common, errp);
1808 chr->opaque = (void *)(intptr_t)fd;
1809 chr->chr_write = null_chr_write;
1810 chr->chr_ioctl = pp_ioctl;
1811 chr->explicit_be_open = true;
1818 #define HAVE_CHARDEV_SERIAL 1
1822 HANDLE hcom, hrecv, hsend;
1827 /* Protected by the CharDriverState chr_write_lock. */
1833 HANDLE hInputReadyEvent;
1834 HANDLE hInputDoneEvent;
1835 HANDLE hInputThread;
1836 uint8_t win_stdio_buf;
1837 } WinStdioCharState;
1839 #define NSENDBUF 2048
1840 #define NRECVBUF 2048
1841 #define MAXCONNECT 1
1842 #define NTIMEOUT 5000
1844 static int win_chr_poll(void *opaque);
1845 static int win_chr_pipe_poll(void *opaque);
1847 static void win_chr_close(CharDriverState *chr)
1849 WinCharState *s = chr->opaque;
1852 CloseHandle(s->hsend);
1856 CloseHandle(s->hrecv);
1860 CloseHandle(s->hcom);
1864 qemu_del_polling_cb(win_chr_pipe_poll, chr);
1866 qemu_del_polling_cb(win_chr_poll, chr);
1868 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1871 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
1873 WinCharState *s = chr->opaque;
1875 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
1880 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
1882 error_setg(errp, "Failed CreateEvent");
1885 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
1887 error_setg(errp, "Failed CreateEvent");
1891 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
1892 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
1893 if (s->hcom == INVALID_HANDLE_VALUE) {
1894 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
1899 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
1900 error_setg(errp, "Failed SetupComm");
1904 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
1905 size = sizeof(COMMCONFIG);
1906 GetDefaultCommConfig(filename, &comcfg, &size);
1907 comcfg.dcb.DCBlength = sizeof(DCB);
1908 CommConfigDialog(filename, NULL, &comcfg);
1910 if (!SetCommState(s->hcom, &comcfg.dcb)) {
1911 error_setg(errp, "Failed SetCommState");
1915 if (!SetCommMask(s->hcom, EV_ERR)) {
1916 error_setg(errp, "Failed SetCommMask");
1920 cto.ReadIntervalTimeout = MAXDWORD;
1921 if (!SetCommTimeouts(s->hcom, &cto)) {
1922 error_setg(errp, "Failed SetCommTimeouts");
1926 if (!ClearCommError(s->hcom, &err, &comstat)) {
1927 error_setg(errp, "Failed ClearCommError");
1930 qemu_add_polling_cb(win_chr_poll, chr);
1938 /* Called with chr_write_lock held. */
1939 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
1941 WinCharState *s = chr->opaque;
1942 DWORD len, ret, size, err;
1945 ZeroMemory(&s->osend, sizeof(s->osend));
1946 s->osend.hEvent = s->hsend;
1949 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
1951 ret = WriteFile(s->hcom, buf, len, &size, NULL);
1953 err = GetLastError();
1954 if (err == ERROR_IO_PENDING) {
1955 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
1973 static int win_chr_read_poll(CharDriverState *chr)
1975 WinCharState *s = chr->opaque;
1977 s->max_size = qemu_chr_be_can_write(chr);
1981 static void win_chr_readfile(CharDriverState *chr)
1983 WinCharState *s = chr->opaque;
1985 uint8_t buf[READ_BUF_LEN];
1988 ZeroMemory(&s->orecv, sizeof(s->orecv));
1989 s->orecv.hEvent = s->hrecv;
1990 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
1992 err = GetLastError();
1993 if (err == ERROR_IO_PENDING) {
1994 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
1999 qemu_chr_be_write(chr, buf, size);
2003 static void win_chr_read(CharDriverState *chr)
2005 WinCharState *s = chr->opaque;
2007 if (s->len > s->max_size)
2008 s->len = s->max_size;
2012 win_chr_readfile(chr);
2015 static int win_chr_poll(void *opaque)
2017 CharDriverState *chr = opaque;
2018 WinCharState *s = chr->opaque;
2022 ClearCommError(s->hcom, &comerr, &status);
2023 if (status.cbInQue > 0) {
2024 s->len = status.cbInQue;
2025 win_chr_read_poll(chr);
2032 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2033 ChardevCommon *backend,
2036 CharDriverState *chr;
2039 chr = qemu_chr_alloc(backend, errp);
2043 s = g_new0(WinCharState, 1);
2045 chr->chr_write = win_chr_write;
2046 chr->chr_close = win_chr_close;
2048 if (win_chr_init(chr, filename, errp) < 0) {
2050 qemu_chr_free_common(chr);
2056 static int win_chr_pipe_poll(void *opaque)
2058 CharDriverState *chr = opaque;
2059 WinCharState *s = chr->opaque;
2062 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2065 win_chr_read_poll(chr);
2072 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2075 WinCharState *s = chr->opaque;
2083 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2085 error_setg(errp, "Failed CreateEvent");
2088 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2090 error_setg(errp, "Failed CreateEvent");
2094 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2095 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2096 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2098 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2100 if (s->hcom == INVALID_HANDLE_VALUE) {
2101 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2106 ZeroMemory(&ov, sizeof(ov));
2107 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2108 ret = ConnectNamedPipe(s->hcom, &ov);
2110 error_setg(errp, "Failed ConnectNamedPipe");
2114 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2116 error_setg(errp, "Failed GetOverlappedResult");
2118 CloseHandle(ov.hEvent);
2125 CloseHandle(ov.hEvent);
2128 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2137 static CharDriverState *qemu_chr_open_pipe(const char *id,
2138 ChardevBackend *backend,
2142 ChardevHostdev *opts = backend->u.pipe;
2143 const char *filename = opts->device;
2144 CharDriverState *chr;
2146 ChardevCommon *common = qapi_ChardevHostdev_base(backend->u.pipe);
2148 chr = qemu_chr_alloc(common, errp);
2152 s = g_new0(WinCharState, 1);
2154 chr->chr_write = win_chr_write;
2155 chr->chr_close = win_chr_close;
2157 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2159 qemu_chr_free_common(chr);
2165 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out,
2166 ChardevCommon *backend,
2169 CharDriverState *chr;
2172 chr = qemu_chr_alloc(backend, errp);
2176 s = g_new0(WinCharState, 1);
2179 chr->chr_write = win_chr_write;
2183 static CharDriverState *qemu_chr_open_win_con(const char *id,
2184 ChardevBackend *backend,
2188 ChardevCommon *common = qapi_ChardevDummy_base(backend->u.console);
2189 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE),
2193 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2195 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2202 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2212 static void win_stdio_wait_func(void *opaque)
2214 CharDriverState *chr = opaque;
2215 WinStdioCharState *stdio = chr->opaque;
2216 INPUT_RECORD buf[4];
2221 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2224 /* Avoid error storm */
2225 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2229 for (i = 0; i < dwSize; i++) {
2230 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2232 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2234 if (kev->uChar.AsciiChar != 0) {
2235 for (j = 0; j < kev->wRepeatCount; j++) {
2236 if (qemu_chr_be_can_write(chr)) {
2237 uint8_t c = kev->uChar.AsciiChar;
2238 qemu_chr_be_write(chr, &c, 1);
2246 static DWORD WINAPI win_stdio_thread(LPVOID param)
2248 CharDriverState *chr = param;
2249 WinStdioCharState *stdio = chr->opaque;
2255 /* Wait for one byte */
2256 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2258 /* Exit in case of error, continue if nothing read */
2266 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2267 if (stdio->win_stdio_buf == '\r') {
2271 /* Signal the main thread and wait until the byte was eaten */
2272 if (!SetEvent(stdio->hInputReadyEvent)) {
2275 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2281 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2285 static void win_stdio_thread_wait_func(void *opaque)
2287 CharDriverState *chr = opaque;
2288 WinStdioCharState *stdio = chr->opaque;
2290 if (qemu_chr_be_can_write(chr)) {
2291 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2294 SetEvent(stdio->hInputDoneEvent);
2297 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2299 WinStdioCharState *stdio = chr->opaque;
2302 GetConsoleMode(stdio->hStdIn, &dwMode);
2305 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2307 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2311 static void win_stdio_close(CharDriverState *chr)
2313 WinStdioCharState *stdio = chr->opaque;
2315 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2316 CloseHandle(stdio->hInputReadyEvent);
2318 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2319 CloseHandle(stdio->hInputDoneEvent);
2321 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2322 TerminateThread(stdio->hInputThread, 0);
2325 g_free(chr->opaque);
2329 static CharDriverState *qemu_chr_open_stdio(const char *id,
2330 ChardevBackend *backend,
2334 CharDriverState *chr;
2335 WinStdioCharState *stdio;
2338 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio);
2340 chr = qemu_chr_alloc(common, errp);
2344 stdio = g_new0(WinStdioCharState, 1);
2346 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2347 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2348 error_setg(errp, "cannot open stdio: invalid handle");
2352 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2354 chr->opaque = stdio;
2355 chr->chr_write = win_stdio_write;
2356 chr->chr_close = win_stdio_close;
2359 if (qemu_add_wait_object(stdio->hStdIn,
2360 win_stdio_wait_func, chr)) {
2361 error_setg(errp, "qemu_add_wait_object: failed");
2367 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2368 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2369 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2370 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2371 error_setg(errp, "cannot create event");
2374 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2375 win_stdio_thread_wait_func, chr)) {
2376 error_setg(errp, "qemu_add_wait_object: failed");
2379 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2382 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2383 error_setg(errp, "cannot create stdio thread");
2388 dwMode |= ENABLE_LINE_INPUT;
2391 /* set the terminal in raw mode */
2392 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2393 dwMode |= ENABLE_PROCESSED_INPUT;
2396 SetConsoleMode(stdio->hStdIn, dwMode);
2398 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2399 qemu_chr_fe_set_echo(chr, false);
2404 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2406 CloseHandle(stdio->hInputReadyEvent);
2407 CloseHandle(stdio->hInputDoneEvent);
2409 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2412 #endif /* !_WIN32 */
2415 /***********************************************************/
2416 /* UDP Net console */
2420 uint8_t buf[READ_BUF_LEN];
2426 /* Called with chr_write_lock held. */
2427 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2429 NetCharDriver *s = chr->opaque;
2431 return qio_channel_write(
2432 s->ioc, (const char *)buf, len, NULL);
2435 static int udp_chr_read_poll(void *opaque)
2437 CharDriverState *chr = opaque;
2438 NetCharDriver *s = chr->opaque;
2440 s->max_size = qemu_chr_be_can_write(chr);
2442 /* If there were any stray characters in the queue process them
2445 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2446 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2448 s->max_size = qemu_chr_be_can_write(chr);
2453 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2455 CharDriverState *chr = opaque;
2456 NetCharDriver *s = chr->opaque;
2459 if (s->max_size == 0) {
2462 ret = qio_channel_read(
2463 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2465 remove_fd_in_watch(chr);
2471 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2472 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2474 s->max_size = qemu_chr_be_can_write(chr);
2480 static void udp_chr_update_read_handler(CharDriverState *chr)
2482 NetCharDriver *s = chr->opaque;
2484 remove_fd_in_watch(chr);
2486 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2492 static void udp_chr_close(CharDriverState *chr)
2494 NetCharDriver *s = chr->opaque;
2496 remove_fd_in_watch(chr);
2498 object_unref(OBJECT(s->ioc));
2501 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2504 static CharDriverState *qemu_chr_open_udp(QIOChannelSocket *sioc,
2505 ChardevCommon *backend,
2508 CharDriverState *chr = NULL;
2509 NetCharDriver *s = NULL;
2511 chr = qemu_chr_alloc(backend, errp);
2515 s = g_new0(NetCharDriver, 1);
2517 s->ioc = QIO_CHANNEL(sioc);
2521 chr->chr_write = udp_chr_write;
2522 chr->chr_update_read_handler = udp_chr_update_read_handler;
2523 chr->chr_close = udp_chr_close;
2524 /* be isn't opened until we get a connection */
2525 chr->explicit_be_open = true;
2529 /***********************************************************/
2530 /* TCP Net console */
2533 QIOChannel *ioc; /* Client I/O channel */
2534 QIOChannelSocket *sioc; /* Client master channel */
2535 QIOChannelSocket *listen_ioc;
2537 QCryptoTLSCreds *tls_creds;
2544 size_t read_msgfds_num;
2546 size_t write_msgfds_num;
2548 SocketAddress *addr;
2552 guint reconnect_timer;
2553 int64_t reconnect_time;
2554 bool connect_err_reported;
2557 static gboolean socket_reconnect_timeout(gpointer opaque);
2559 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2561 TCPCharDriver *s = chr->opaque;
2562 assert(s->connected == 0);
2563 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2564 socket_reconnect_timeout, chr);
2567 static void check_report_connect_error(CharDriverState *chr,
2570 TCPCharDriver *s = chr->opaque;
2572 if (!s->connect_err_reported) {
2573 error_report("Unable to connect character device %s: %s",
2574 chr->label, error_get_pretty(err));
2575 s->connect_err_reported = true;
2577 qemu_chr_socket_restart_timer(chr);
2580 static gboolean tcp_chr_accept(QIOChannel *chan,
2584 /* Called with chr_write_lock held. */
2585 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2587 TCPCharDriver *s = chr->opaque;
2589 int ret = io_channel_send_full(s->ioc, buf, len,
2591 s->write_msgfds_num);
2593 /* free the written msgfds, no matter what */
2594 if (s->write_msgfds_num) {
2595 g_free(s->write_msgfds);
2596 s->write_msgfds = 0;
2597 s->write_msgfds_num = 0;
2602 /* XXX: indicate an error ? */
2607 static int tcp_chr_read_poll(void *opaque)
2609 CharDriverState *chr = opaque;
2610 TCPCharDriver *s = chr->opaque;
2613 s->max_size = qemu_chr_be_can_write(chr);
2618 #define IAC_BREAK 243
2619 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2621 uint8_t *buf, int *size)
2623 /* Handle any telnet client's basic IAC options to satisfy char by
2624 * char mode with no echo. All IAC options will be removed from
2625 * the buf and the do_telnetopt variable will be used to track the
2626 * state of the width of the IAC information.
2628 * IAC commands come in sets of 3 bytes with the exception of the
2629 * "IAC BREAK" command and the double IAC.
2635 for (i = 0; i < *size; i++) {
2636 if (s->do_telnetopt > 1) {
2637 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2638 /* Double IAC means send an IAC */
2642 s->do_telnetopt = 1;
2644 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2645 /* Handle IAC break commands by sending a serial break */
2646 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2651 if (s->do_telnetopt >= 4) {
2652 s->do_telnetopt = 1;
2655 if ((unsigned char)buf[i] == IAC) {
2656 s->do_telnetopt = 2;
2667 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2669 TCPCharDriver *s = chr->opaque;
2670 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2672 assert(num <= TCP_MAX_FDS);
2677 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2679 /* Close unused fds */
2680 for (i = to_copy; i < s->read_msgfds_num; i++) {
2681 close(s->read_msgfds[i]);
2684 g_free(s->read_msgfds);
2686 s->read_msgfds_num = 0;
2692 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2694 TCPCharDriver *s = chr->opaque;
2696 if (!qio_channel_has_feature(s->ioc,
2697 QIO_CHANNEL_FEATURE_FD_PASS)) {
2700 /* clear old pending fd array */
2701 g_free(s->write_msgfds);
2704 s->write_msgfds = g_new(int, num);
2705 memcpy(s->write_msgfds, fds, num * sizeof(int));
2708 s->write_msgfds_num = num;
2713 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2715 TCPCharDriver *s = chr->opaque;
2716 struct iovec iov = { .iov_base = buf, .iov_len = len };
2720 size_t msgfds_num = 0;
2722 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2723 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2724 &msgfds, &msgfds_num,
2727 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2733 /* close and clean read_msgfds */
2734 for (i = 0; i < s->read_msgfds_num; i++) {
2735 close(s->read_msgfds[i]);
2738 if (s->read_msgfds_num) {
2739 g_free(s->read_msgfds);
2742 s->read_msgfds = msgfds;
2743 s->read_msgfds_num = msgfds_num;
2746 for (i = 0; i < s->read_msgfds_num; i++) {
2747 int fd = s->read_msgfds[i];
2752 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2755 #ifndef MSG_CMSG_CLOEXEC
2756 qemu_set_cloexec(fd);
2763 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2765 TCPCharDriver *s = chr->opaque;
2766 return qio_channel_create_watch(s->ioc, cond);
2769 static void tcp_chr_disconnect(CharDriverState *chr)
2771 TCPCharDriver *s = chr->opaque;
2774 if (s->listen_ioc) {
2775 s->listen_tag = qio_channel_add_watch(
2776 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
2778 remove_fd_in_watch(chr);
2779 object_unref(OBJECT(s->sioc));
2781 object_unref(OBJECT(s->ioc));
2783 g_free(chr->filename);
2784 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
2785 s->is_listen, s->is_telnet);
2786 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2787 if (s->reconnect_time) {
2788 qemu_chr_socket_restart_timer(chr);
2792 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2794 CharDriverState *chr = opaque;
2795 TCPCharDriver *s = chr->opaque;
2796 uint8_t buf[READ_BUF_LEN];
2799 if (!s->connected || s->max_size <= 0) {
2803 if (len > s->max_size)
2805 size = tcp_chr_recv(chr, (void *)buf, len);
2806 if (size == 0 || size == -1) {
2807 /* connection closed */
2808 tcp_chr_disconnect(chr);
2809 } else if (size > 0) {
2810 if (s->do_telnetopt)
2811 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
2813 qemu_chr_be_write(chr, buf, size);
2819 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
2821 TCPCharDriver *s = chr->opaque;
2824 if (!s->connected) {
2828 size = tcp_chr_recv(chr, (void *) buf, len);
2830 /* connection closed */
2831 tcp_chr_disconnect(chr);
2837 static void tcp_chr_connect(void *opaque)
2839 CharDriverState *chr = opaque;
2840 TCPCharDriver *s = chr->opaque;
2842 g_free(chr->filename);
2843 chr->filename = sockaddr_to_str(
2844 &s->sioc->localAddr, s->sioc->localAddrLen,
2845 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
2846 s->is_listen, s->is_telnet);
2850 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2854 qemu_chr_be_generic_open(chr);
2857 static void tcp_chr_update_read_handler(CharDriverState *chr)
2859 TCPCharDriver *s = chr->opaque;
2861 remove_fd_in_watch(chr);
2863 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2870 CharDriverState *chr;
2873 } TCPCharDriverTelnetInit;
2875 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
2876 GIOCondition cond G_GNUC_UNUSED,
2879 TCPCharDriverTelnetInit *init = user_data;
2882 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
2884 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2887 tcp_chr_disconnect(init->chr);
2891 init->buflen -= ret;
2893 if (init->buflen == 0) {
2894 tcp_chr_connect(init->chr);
2898 memmove(init->buf, init->buf + ret, init->buflen);
2903 static void tcp_chr_telnet_init(CharDriverState *chr)
2905 TCPCharDriver *s = chr->opaque;
2906 TCPCharDriverTelnetInit *init =
2907 g_new0(TCPCharDriverTelnetInit, 1);
2913 #define IACSET(x, a, b, c) \
2920 /* Prep the telnet negotion to put telnet in binary,
2921 * no echo, single char mode */
2922 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
2923 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
2924 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
2925 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
2929 qio_channel_add_watch(
2931 tcp_chr_telnet_init_io,
2936 static void tcp_chr_tls_handshake(Object *source,
2940 CharDriverState *chr = user_data;
2941 TCPCharDriver *s = chr->opaque;
2944 tcp_chr_disconnect(chr);
2946 if (s->do_telnetopt) {
2947 tcp_chr_telnet_init(chr);
2949 tcp_chr_connect(chr);
2955 static void tcp_chr_tls_init(CharDriverState *chr)
2957 TCPCharDriver *s = chr->opaque;
2958 QIOChannelTLS *tioc;
2962 tioc = qio_channel_tls_new_server(
2963 s->ioc, s->tls_creds,
2964 NULL, /* XXX Use an ACL */
2967 tioc = qio_channel_tls_new_client(
2968 s->ioc, s->tls_creds,
2969 s->addr->u.inet->host,
2974 tcp_chr_disconnect(chr);
2976 object_unref(OBJECT(s->ioc));
2977 s->ioc = QIO_CHANNEL(tioc);
2979 qio_channel_tls_handshake(tioc,
2980 tcp_chr_tls_handshake,
2986 static int tcp_chr_new_client(CharDriverState *chr, QIOChannelSocket *sioc)
2988 TCPCharDriver *s = chr->opaque;
2989 if (s->ioc != NULL) {
2993 s->ioc = QIO_CHANNEL(sioc);
2994 object_ref(OBJECT(sioc));
2996 object_ref(OBJECT(sioc));
2998 if (s->do_nodelay) {
2999 qio_channel_set_delay(s->ioc, false);
3001 if (s->listen_tag) {
3002 g_source_remove(s->listen_tag);
3007 tcp_chr_tls_init(chr);
3009 if (s->do_telnetopt) {
3010 tcp_chr_telnet_init(chr);
3012 tcp_chr_connect(chr);
3020 static int tcp_chr_add_client(CharDriverState *chr, int fd)
3023 QIOChannelSocket *sioc;
3025 sioc = qio_channel_socket_new_fd(fd, NULL);
3029 qio_channel_set_blocking(QIO_CHANNEL(sioc), false, NULL);
3030 ret = tcp_chr_new_client(chr, sioc);
3031 object_unref(OBJECT(sioc));
3035 static gboolean tcp_chr_accept(QIOChannel *channel,
3039 CharDriverState *chr = opaque;
3040 QIOChannelSocket *sioc;
3042 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3048 tcp_chr_new_client(chr, sioc);
3050 object_unref(OBJECT(sioc));
3055 static void tcp_chr_close(CharDriverState *chr)
3057 TCPCharDriver *s = chr->opaque;
3060 if (s->reconnect_timer) {
3061 g_source_remove(s->reconnect_timer);
3062 s->reconnect_timer = 0;
3064 qapi_free_SocketAddress(s->addr);
3065 remove_fd_in_watch(chr);
3067 object_unref(OBJECT(s->ioc));
3069 if (s->listen_tag) {
3070 g_source_remove(s->listen_tag);
3073 if (s->listen_ioc) {
3074 object_unref(OBJECT(s->listen_ioc));
3076 if (s->read_msgfds_num) {
3077 for (i = 0; i < s->read_msgfds_num; i++) {
3078 close(s->read_msgfds[i]);
3080 g_free(s->read_msgfds);
3083 object_unref(OBJECT(s->tls_creds));
3085 if (s->write_msgfds_num) {
3086 g_free(s->write_msgfds);
3089 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3092 static void qemu_chr_finish_socket_connection(CharDriverState *chr,
3093 QIOChannelSocket *sioc)
3095 TCPCharDriver *s = chr->opaque;
3098 s->listen_ioc = sioc;
3099 s->listen_tag = qio_channel_add_watch(
3100 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
3102 tcp_chr_new_client(chr, sioc);
3103 object_unref(OBJECT(sioc));
3107 static void qemu_chr_socket_connected(Object *src, Error *err, void *opaque)
3109 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(src);
3110 CharDriverState *chr = opaque;
3111 TCPCharDriver *s = chr->opaque;
3114 check_report_connect_error(chr, err);
3119 s->connect_err_reported = false;
3120 qemu_chr_finish_socket_connection(chr, sioc);
3123 static bool qemu_chr_open_socket_fd(CharDriverState *chr, Error **errp)
3125 TCPCharDriver *s = chr->opaque;
3126 QIOChannelSocket *sioc = qio_channel_socket_new();
3129 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
3132 qemu_chr_finish_socket_connection(chr, sioc);
3133 } else if (s->reconnect_time) {
3134 qio_channel_socket_connect_async(sioc, s->addr,
3135 qemu_chr_socket_connected,
3138 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
3141 qemu_chr_finish_socket_connection(chr, sioc);
3147 object_unref(OBJECT(sioc));
3151 /*********************************************************/
3152 /* Ring buffer chardev */
3159 } RingBufCharDriver;
3161 static size_t ringbuf_count(const CharDriverState *chr)
3163 const RingBufCharDriver *d = chr->opaque;
3165 return d->prod - d->cons;
3168 /* Called with chr_write_lock held. */
3169 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3171 RingBufCharDriver *d = chr->opaque;
3174 if (!buf || (len < 0)) {
3178 for (i = 0; i < len; i++ ) {
3179 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3180 if (d->prod - d->cons > d->size) {
3181 d->cons = d->prod - d->size;
3188 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3190 RingBufCharDriver *d = chr->opaque;
3193 qemu_mutex_lock(&chr->chr_write_lock);
3194 for (i = 0; i < len && d->cons != d->prod; i++) {
3195 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3197 qemu_mutex_unlock(&chr->chr_write_lock);
3202 static void ringbuf_chr_close(struct CharDriverState *chr)
3204 RingBufCharDriver *d = chr->opaque;
3211 static CharDriverState *qemu_chr_open_ringbuf(const char *id,
3212 ChardevBackend *backend,
3216 ChardevRingbuf *opts = backend->u.ringbuf;
3217 ChardevCommon *common = qapi_ChardevRingbuf_base(backend->u.ringbuf);
3218 CharDriverState *chr;
3219 RingBufCharDriver *d;
3221 chr = qemu_chr_alloc(common, errp);
3225 d = g_malloc(sizeof(*d));
3227 d->size = opts->has_size ? opts->size : 65536;
3229 /* The size must be power of 2 */
3230 if (d->size & (d->size - 1)) {
3231 error_setg(errp, "size of ringbuf chardev must be power of two");
3237 d->cbuf = g_malloc0(d->size);
3240 chr->chr_write = ringbuf_chr_write;
3241 chr->chr_close = ringbuf_chr_close;
3247 qemu_chr_free_common(chr);
3251 bool chr_is_ringbuf(const CharDriverState *chr)
3253 return chr->chr_write == ringbuf_chr_write;
3256 void qmp_ringbuf_write(const char *device, const char *data,
3257 bool has_format, enum DataFormat format,
3260 CharDriverState *chr;
3261 const uint8_t *write_data;
3265 chr = qemu_chr_find(device);
3267 error_setg(errp, "Device '%s' not found", device);
3271 if (!chr_is_ringbuf(chr)) {
3272 error_setg(errp,"%s is not a ringbuf device", device);
3276 if (has_format && (format == DATA_FORMAT_BASE64)) {
3277 write_data = qbase64_decode(data, -1,
3284 write_data = (uint8_t *)data;
3285 write_count = strlen(data);
3288 ret = ringbuf_chr_write(chr, write_data, write_count);
3290 if (write_data != (uint8_t *)data) {
3291 g_free((void *)write_data);
3295 error_setg(errp, "Failed to write to device %s", device);
3300 char *qmp_ringbuf_read(const char *device, int64_t size,
3301 bool has_format, enum DataFormat format,
3304 CharDriverState *chr;
3309 chr = qemu_chr_find(device);
3311 error_setg(errp, "Device '%s' not found", device);
3315 if (!chr_is_ringbuf(chr)) {
3316 error_setg(errp,"%s is not a ringbuf device", device);
3321 error_setg(errp, "size must be greater than zero");
3325 count = ringbuf_count(chr);
3326 size = size > count ? count : size;
3327 read_data = g_malloc(size + 1);
3329 ringbuf_chr_read(chr, read_data, size);
3331 if (has_format && (format == DATA_FORMAT_BASE64)) {
3332 data = g_base64_encode(read_data, size);
3336 * FIXME should read only complete, valid UTF-8 characters up
3337 * to @size bytes. Invalid sequences should be replaced by a
3338 * suitable replacement character. Except when (and only
3339 * when) ring buffer lost characters since last read, initial
3340 * continuation characters should be dropped.
3342 read_data[size] = 0;
3343 data = (char *)read_data;
3349 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3351 char host[65], port[33], width[8], height[8];
3355 Error *local_err = NULL;
3357 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3359 error_report_err(local_err);
3363 if (strstart(filename, "mon:", &p)) {
3365 qemu_opt_set(opts, "mux", "on", &error_abort);
3366 if (strcmp(filename, "stdio") == 0) {
3367 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3368 * but pass it to the guest. Handle this only for compat syntax,
3369 * for -chardev syntax we have special option for this.
3370 * This is what -nographic did, redirecting+muxing serial+monitor
3371 * to stdio causing Ctrl+C to be passed to guest. */
3372 qemu_opt_set(opts, "signal", "off", &error_abort);
3376 if (strcmp(filename, "null") == 0 ||
3377 strcmp(filename, "pty") == 0 ||
3378 strcmp(filename, "msmouse") == 0 ||
3379 strcmp(filename, "braille") == 0 ||
3380 strcmp(filename, "testdev") == 0 ||
3381 strcmp(filename, "stdio") == 0) {
3382 qemu_opt_set(opts, "backend", filename, &error_abort);
3385 if (strstart(filename, "vc", &p)) {
3386 qemu_opt_set(opts, "backend", "vc", &error_abort);
3388 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3390 qemu_opt_set(opts, "width", width, &error_abort);
3391 qemu_opt_set(opts, "height", height, &error_abort);
3392 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3394 qemu_opt_set(opts, "cols", width, &error_abort);
3395 qemu_opt_set(opts, "rows", height, &error_abort);
3402 if (strcmp(filename, "con:") == 0) {
3403 qemu_opt_set(opts, "backend", "console", &error_abort);
3406 if (strstart(filename, "COM", NULL)) {
3407 qemu_opt_set(opts, "backend", "serial", &error_abort);
3408 qemu_opt_set(opts, "path", filename, &error_abort);
3411 if (strstart(filename, "file:", &p)) {
3412 qemu_opt_set(opts, "backend", "file", &error_abort);
3413 qemu_opt_set(opts, "path", p, &error_abort);
3416 if (strstart(filename, "pipe:", &p)) {
3417 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3418 qemu_opt_set(opts, "path", p, &error_abort);
3421 if (strstart(filename, "tcp:", &p) ||
3422 strstart(filename, "telnet:", &p)) {
3423 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3425 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3428 qemu_opt_set(opts, "backend", "socket", &error_abort);
3429 qemu_opt_set(opts, "host", host, &error_abort);
3430 qemu_opt_set(opts, "port", port, &error_abort);
3431 if (p[pos] == ',') {
3432 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3434 error_report_err(local_err);
3438 if (strstart(filename, "telnet:", &p))
3439 qemu_opt_set(opts, "telnet", "on", &error_abort);
3442 if (strstart(filename, "udp:", &p)) {
3443 qemu_opt_set(opts, "backend", "udp", &error_abort);
3444 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3446 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3450 qemu_opt_set(opts, "host", host, &error_abort);
3451 qemu_opt_set(opts, "port", port, &error_abort);
3452 if (p[pos] == '@') {
3454 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3456 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3460 qemu_opt_set(opts, "localaddr", host, &error_abort);
3461 qemu_opt_set(opts, "localport", port, &error_abort);
3465 if (strstart(filename, "unix:", &p)) {
3466 qemu_opt_set(opts, "backend", "socket", &error_abort);
3467 qemu_opts_do_parse(opts, p, "path", &local_err);
3469 error_report_err(local_err);
3474 if (strstart(filename, "/dev/parport", NULL) ||
3475 strstart(filename, "/dev/ppi", NULL)) {
3476 qemu_opt_set(opts, "backend", "parport", &error_abort);
3477 qemu_opt_set(opts, "path", filename, &error_abort);
3480 if (strstart(filename, "/dev/", NULL)) {
3481 qemu_opt_set(opts, "backend", "tty", &error_abort);
3482 qemu_opt_set(opts, "path", filename, &error_abort);
3487 qemu_opts_del(opts);
3491 static void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3493 const char *logfile = qemu_opt_get(opts, "logfile");
3495 backend->has_logfile = logfile != NULL;
3496 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3498 backend->has_logappend = true;
3499 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3503 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3506 const char *path = qemu_opt_get(opts, "path");
3509 error_setg(errp, "chardev: file: no filename given");
3512 backend->u.file = g_new0(ChardevFile, 1);
3513 qemu_chr_parse_common(opts, qapi_ChardevFile_base(backend->u.file));
3514 backend->u.file->out = g_strdup(path);
3516 backend->u.file->has_append = true;
3517 backend->u.file->append = qemu_opt_get_bool(opts, "append", false);
3520 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3523 backend->u.stdio = g_new0(ChardevStdio, 1);
3524 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(backend->u.stdio));
3525 backend->u.stdio->has_signal = true;
3526 backend->u.stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3529 #ifdef HAVE_CHARDEV_SERIAL
3530 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3533 const char *device = qemu_opt_get(opts, "path");
3535 if (device == NULL) {
3536 error_setg(errp, "chardev: serial/tty: no device path given");
3539 backend->u.serial = g_new0(ChardevHostdev, 1);
3540 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(backend->u.serial));
3541 backend->u.serial->device = g_strdup(device);
3545 #ifdef HAVE_CHARDEV_PARPORT
3546 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3549 const char *device = qemu_opt_get(opts, "path");
3551 if (device == NULL) {
3552 error_setg(errp, "chardev: parallel: no device path given");
3555 backend->u.parallel = g_new0(ChardevHostdev, 1);
3556 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(backend->u.parallel));
3557 backend->u.parallel->device = g_strdup(device);
3561 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3564 const char *device = qemu_opt_get(opts, "path");
3566 if (device == NULL) {
3567 error_setg(errp, "chardev: pipe: no device path given");
3570 backend->u.pipe = g_new0(ChardevHostdev, 1);
3571 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(backend->u.pipe));
3572 backend->u.pipe->device = g_strdup(device);
3575 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3580 backend->u.ringbuf = g_new0(ChardevRingbuf, 1);
3581 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(backend->u.ringbuf));
3583 val = qemu_opt_get_size(opts, "size", 0);
3585 backend->u.ringbuf->has_size = true;
3586 backend->u.ringbuf->size = val;
3590 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3593 const char *chardev = qemu_opt_get(opts, "chardev");
3595 if (chardev == NULL) {
3596 error_setg(errp, "chardev: mux: no chardev given");
3599 backend->u.mux = g_new0(ChardevMux, 1);
3600 qemu_chr_parse_common(opts, qapi_ChardevMux_base(backend->u.mux));
3601 backend->u.mux->chardev = g_strdup(chardev);
3604 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3607 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3608 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3609 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3610 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3611 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3612 const char *path = qemu_opt_get(opts, "path");
3613 const char *host = qemu_opt_get(opts, "host");
3614 const char *port = qemu_opt_get(opts, "port");
3615 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
3616 SocketAddress *addr;
3620 error_setg(errp, "chardev: socket: no host given");
3624 error_setg(errp, "chardev: socket: no port given");
3629 error_setg(errp, "TLS can only be used over TCP socket");
3634 backend->u.socket = g_new0(ChardevSocket, 1);
3635 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(backend->u.socket));
3637 backend->u.socket->has_nodelay = true;
3638 backend->u.socket->nodelay = do_nodelay;
3639 backend->u.socket->has_server = true;
3640 backend->u.socket->server = is_listen;
3641 backend->u.socket->has_telnet = true;
3642 backend->u.socket->telnet = is_telnet;
3643 backend->u.socket->has_wait = true;
3644 backend->u.socket->wait = is_waitconnect;
3645 backend->u.socket->has_reconnect = true;
3646 backend->u.socket->reconnect = reconnect;
3647 backend->u.socket->tls_creds = g_strdup(tls_creds);
3649 addr = g_new0(SocketAddress, 1);
3651 addr->type = SOCKET_ADDRESS_KIND_UNIX;
3652 addr->u.q_unix = g_new0(UnixSocketAddress, 1);
3653 addr->u.q_unix->path = g_strdup(path);
3655 addr->type = SOCKET_ADDRESS_KIND_INET;
3656 addr->u.inet = g_new0(InetSocketAddress, 1);
3657 addr->u.inet->host = g_strdup(host);
3658 addr->u.inet->port = g_strdup(port);
3659 addr->u.inet->has_to = qemu_opt_get(opts, "to");
3660 addr->u.inet->to = qemu_opt_get_number(opts, "to", 0);
3661 addr->u.inet->has_ipv4 = qemu_opt_get(opts, "ipv4");
3662 addr->u.inet->ipv4 = qemu_opt_get_bool(opts, "ipv4", 0);
3663 addr->u.inet->has_ipv6 = qemu_opt_get(opts, "ipv6");
3664 addr->u.inet->ipv6 = qemu_opt_get_bool(opts, "ipv6", 0);
3666 backend->u.socket->addr = addr;
3669 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3672 const char *host = qemu_opt_get(opts, "host");
3673 const char *port = qemu_opt_get(opts, "port");
3674 const char *localaddr = qemu_opt_get(opts, "localaddr");
3675 const char *localport = qemu_opt_get(opts, "localport");
3676 bool has_local = false;
3677 SocketAddress *addr;
3679 if (host == NULL || strlen(host) == 0) {
3682 if (port == NULL || strlen(port) == 0) {
3683 error_setg(errp, "chardev: udp: remote port not specified");
3686 if (localport == NULL || strlen(localport) == 0) {
3691 if (localaddr == NULL || strlen(localaddr) == 0) {
3697 backend->u.udp = g_new0(ChardevUdp, 1);
3698 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(backend->u.udp));
3700 addr = g_new0(SocketAddress, 1);
3701 addr->type = SOCKET_ADDRESS_KIND_INET;
3702 addr->u.inet = g_new0(InetSocketAddress, 1);
3703 addr->u.inet->host = g_strdup(host);
3704 addr->u.inet->port = g_strdup(port);
3705 addr->u.inet->has_ipv4 = qemu_opt_get(opts, "ipv4");
3706 addr->u.inet->ipv4 = qemu_opt_get_bool(opts, "ipv4", 0);
3707 addr->u.inet->has_ipv6 = qemu_opt_get(opts, "ipv6");
3708 addr->u.inet->ipv6 = qemu_opt_get_bool(opts, "ipv6", 0);
3709 backend->u.udp->remote = addr;
3712 backend->u.udp->has_local = true;
3713 addr = g_new0(SocketAddress, 1);
3714 addr->type = SOCKET_ADDRESS_KIND_INET;
3715 addr->u.inet = g_new0(InetSocketAddress, 1);
3716 addr->u.inet->host = g_strdup(localaddr);
3717 addr->u.inet->port = g_strdup(localport);
3718 backend->u.udp->local = addr;
3722 typedef struct CharDriver {
3724 ChardevBackendKind kind;
3725 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3726 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3727 ChardevReturn *ret, Error **errp);
3730 static GSList *backends;
3732 void register_char_driver(const char *name, ChardevBackendKind kind,
3733 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
3734 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3735 ChardevReturn *ret, Error **errp))
3739 s = g_malloc0(sizeof(*s));
3740 s->name = g_strdup(name);
3745 backends = g_slist_append(backends, s);
3748 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
3749 void (*init)(struct CharDriverState *s),
3752 Error *local_err = NULL;
3754 CharDriverState *chr;
3756 ChardevReturn *ret = NULL;
3757 ChardevBackend *backend;
3758 const char *id = qemu_opts_id(opts);
3762 error_setg(errp, "chardev: no id specified");
3766 if (qemu_opt_get(opts, "backend") == NULL) {
3767 error_setg(errp, "chardev: \"%s\" missing backend",
3768 qemu_opts_id(opts));
3771 for (i = backends; i; i = i->next) {
3774 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
3779 error_setg(errp, "chardev: backend \"%s\" not found",
3780 qemu_opt_get(opts, "backend"));
3784 backend = g_new0(ChardevBackend, 1);
3786 if (qemu_opt_get_bool(opts, "mux", 0)) {
3787 bid = g_strdup_printf("%s-base", id);
3791 backend->type = cd->kind;
3793 cd->parse(opts, backend, &local_err);
3795 error_propagate(errp, local_err);
3799 ChardevCommon *cc = g_new0(ChardevCommon, 1);
3800 qemu_chr_parse_common(opts, cc);
3801 backend->u.data = cc;
3804 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
3810 qapi_free_ChardevBackend(backend);
3811 qapi_free_ChardevReturn(ret);
3812 backend = g_new0(ChardevBackend, 1);
3813 backend->u.mux = g_new0(ChardevMux, 1);
3814 backend->type = CHARDEV_BACKEND_KIND_MUX;
3815 backend->u.mux->chardev = g_strdup(bid);
3816 ret = qmp_chardev_add(id, backend, errp);
3818 chr = qemu_chr_find(bid);
3819 qemu_chr_delete(chr);
3825 chr = qemu_chr_find(id);
3829 qapi_free_ChardevBackend(backend);
3830 qapi_free_ChardevReturn(ret);
3835 qemu_opts_del(opts);
3839 CharDriverState *qemu_chr_new(const char *label, const char *filename, void (*init)(struct CharDriverState *s))
3842 CharDriverState *chr;
3846 if (strstart(filename, "chardev:", &p)) {
3847 return qemu_chr_find(p);
3850 opts = qemu_chr_parse_compat(label, filename);
3854 chr = qemu_chr_new_from_opts(opts, init, &err);
3856 error_report_err(err);
3858 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
3859 qemu_chr_fe_claim_no_fail(chr);
3860 monitor_init(chr, MONITOR_USE_READLINE);
3865 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo)
3867 if (chr->chr_set_echo) {
3868 chr->chr_set_echo(chr, echo);
3872 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open)
3874 if (chr->fe_open == fe_open) {
3877 chr->fe_open = fe_open;
3878 if (chr->chr_set_fe_open) {
3879 chr->chr_set_fe_open(chr, fe_open);
3883 void qemu_chr_fe_event(struct CharDriverState *chr, int event)
3885 if (chr->chr_fe_event) {
3886 chr->chr_fe_event(chr, event);
3890 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
3891 GIOFunc func, void *user_data)
3896 if (s->chr_add_watch == NULL) {
3900 src = s->chr_add_watch(s, cond);
3905 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
3906 tag = g_source_attach(src, NULL);
3907 g_source_unref(src);
3912 int qemu_chr_fe_claim(CharDriverState *s)
3914 if (s->avail_connections < 1) {
3917 s->avail_connections--;
3921 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
3923 if (qemu_chr_fe_claim(s) != 0) {
3924 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
3925 __func__, s->label);
3930 void qemu_chr_fe_release(CharDriverState *s)
3932 s->avail_connections++;
3935 static void qemu_chr_free_common(CharDriverState *chr)
3937 g_free(chr->filename);
3939 qemu_opts_del(chr->opts);
3940 if (chr->logfd != -1) {
3943 qemu_mutex_destroy(&chr->chr_write_lock);
3947 void qemu_chr_free(CharDriverState *chr)
3949 if (chr->chr_close) {
3950 chr->chr_close(chr);
3952 qemu_chr_free_common(chr);
3955 void qemu_chr_delete(CharDriverState *chr)
3957 QTAILQ_REMOVE(&chardevs, chr, next);
3961 ChardevInfoList *qmp_query_chardev(Error **errp)
3963 ChardevInfoList *chr_list = NULL;
3964 CharDriverState *chr;
3966 QTAILQ_FOREACH(chr, &chardevs, next) {
3967 ChardevInfoList *info = g_malloc0(sizeof(*info));
3968 info->value = g_malloc0(sizeof(*info->value));
3969 info->value->label = g_strdup(chr->label);
3970 info->value->filename = g_strdup(chr->filename);
3971 info->value->frontend_open = chr->fe_open;
3973 info->next = chr_list;
3980 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
3982 ChardevBackendInfoList *backend_list = NULL;
3983 CharDriver *c = NULL;
3986 for (i = backends; i; i = i->next) {
3987 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
3989 info->value = g_malloc0(sizeof(*info->value));
3990 info->value->name = g_strdup(c->name);
3992 info->next = backend_list;
3993 backend_list = info;
3996 return backend_list;
3999 CharDriverState *qemu_chr_find(const char *name)
4001 CharDriverState *chr;
4003 QTAILQ_FOREACH(chr, &chardevs, next) {
4004 if (strcmp(chr->label, name) != 0)
4011 /* Get a character (serial) device interface. */
4012 CharDriverState *qemu_char_get_next_serial(void)
4014 static int next_serial;
4015 CharDriverState *chr;
4017 /* FIXME: This function needs to go away: use chardev properties! */
4019 while (next_serial < MAX_SERIAL_PORTS && serial_hds[next_serial]) {
4020 chr = serial_hds[next_serial++];
4021 qemu_chr_fe_claim_no_fail(chr);
4027 QemuOptsList qemu_chardev_opts = {
4029 .implied_opt_name = "backend",
4030 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4034 .type = QEMU_OPT_STRING,
4037 .type = QEMU_OPT_STRING,
4040 .type = QEMU_OPT_STRING,
4043 .type = QEMU_OPT_STRING,
4045 .name = "localaddr",
4046 .type = QEMU_OPT_STRING,
4048 .name = "localport",
4049 .type = QEMU_OPT_STRING,
4052 .type = QEMU_OPT_NUMBER,
4055 .type = QEMU_OPT_BOOL,
4058 .type = QEMU_OPT_BOOL,
4061 .type = QEMU_OPT_BOOL,
4064 .type = QEMU_OPT_BOOL,
4067 .type = QEMU_OPT_BOOL,
4069 .name = "reconnect",
4070 .type = QEMU_OPT_NUMBER,
4073 .type = QEMU_OPT_BOOL,
4075 .name = "tls-creds",
4076 .type = QEMU_OPT_STRING,
4079 .type = QEMU_OPT_NUMBER,
4082 .type = QEMU_OPT_NUMBER,
4085 .type = QEMU_OPT_NUMBER,
4088 .type = QEMU_OPT_NUMBER,
4091 .type = QEMU_OPT_BOOL,
4094 .type = QEMU_OPT_BOOL,
4097 .type = QEMU_OPT_STRING,
4100 .type = QEMU_OPT_NUMBER,
4103 .type = QEMU_OPT_SIZE,
4106 .type = QEMU_OPT_STRING,
4109 .type = QEMU_OPT_BOOL,
4112 .type = QEMU_OPT_STRING,
4114 .name = "logappend",
4115 .type = QEMU_OPT_BOOL,
4117 { /* end of list */ }
4123 static CharDriverState *qmp_chardev_open_file(const char *id,
4124 ChardevBackend *backend,
4128 ChardevFile *file = backend->u.file;
4129 ChardevCommon *common = qapi_ChardevFile_base(backend->u.file);
4133 error_setg(errp, "input file not supported");
4137 out = CreateFile(file->out, GENERIC_WRITE, FILE_SHARE_READ, NULL,
4138 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
4139 if (out == INVALID_HANDLE_VALUE) {
4140 error_setg(errp, "open %s failed", file->out);
4143 return qemu_chr_open_win_file(out, common, errp);
4146 static CharDriverState *qmp_chardev_open_serial(const char *id,
4147 ChardevBackend *backend,
4151 ChardevHostdev *serial = backend->u.serial;
4152 ChardevCommon *common = qapi_ChardevHostdev_base(backend->u.serial);
4153 return qemu_chr_open_win_path(serial->device, common, errp);
4158 static int qmp_chardev_open_file_source(char *src, int flags,
4163 TFR(fd = qemu_open(src, flags, 0666));
4165 error_setg_file_open(errp, errno, src);
4170 static CharDriverState *qmp_chardev_open_file(const char *id,
4171 ChardevBackend *backend,
4175 ChardevFile *file = backend->u.file;
4176 ChardevCommon *common = qapi_ChardevFile_base(backend->u.file);
4177 int flags, in = -1, out;
4179 flags = O_WRONLY | O_CREAT | O_BINARY;
4180 if (file->has_append && file->append) {
4186 out = qmp_chardev_open_file_source(file->out, flags, errp);
4193 in = qmp_chardev_open_file_source(file->in, flags, errp);
4200 return qemu_chr_open_fd(in, out, common, errp);
4203 #ifdef HAVE_CHARDEV_SERIAL
4204 static CharDriverState *qmp_chardev_open_serial(const char *id,
4205 ChardevBackend *backend,
4209 ChardevHostdev *serial = backend->u.serial;
4210 ChardevCommon *common = qapi_ChardevHostdev_base(backend->u.serial);
4213 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4217 qemu_set_nonblock(fd);
4218 return qemu_chr_open_tty_fd(fd, common, errp);
4222 #ifdef HAVE_CHARDEV_PARPORT
4223 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4224 ChardevBackend *backend,
4228 ChardevHostdev *parallel = backend->u.parallel;
4229 ChardevCommon *common = qapi_ChardevHostdev_base(backend->u.parallel);
4232 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4236 return qemu_chr_open_pp_fd(fd, common, errp);
4242 static void socket_try_connect(CharDriverState *chr)
4246 if (!qemu_chr_open_socket_fd(chr, &err)) {
4247 check_report_connect_error(chr, err);
4251 static gboolean socket_reconnect_timeout(gpointer opaque)
4253 CharDriverState *chr = opaque;
4254 TCPCharDriver *s = chr->opaque;
4256 s->reconnect_timer = 0;
4262 socket_try_connect(chr);
4267 static CharDriverState *qmp_chardev_open_socket(const char *id,
4268 ChardevBackend *backend,
4272 CharDriverState *chr;
4274 ChardevSocket *sock = backend->u.socket;
4275 SocketAddress *addr = sock->addr;
4276 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4277 bool is_listen = sock->has_server ? sock->server : true;
4278 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4279 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4280 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4281 ChardevCommon *common = qapi_ChardevSocket_base(backend->u.socket);
4283 chr = qemu_chr_alloc(common, errp);
4287 s = g_new0(TCPCharDriver, 1);
4289 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4290 s->is_listen = is_listen;
4291 s->is_telnet = is_telnet;
4292 s->do_nodelay = do_nodelay;
4293 if (sock->tls_creds) {
4295 creds = object_resolve_path_component(
4296 object_get_objects_root(), sock->tls_creds);
4298 error_setg(errp, "No TLS credentials with id '%s'",
4302 s->tls_creds = (QCryptoTLSCreds *)
4303 object_dynamic_cast(creds,
4304 TYPE_QCRYPTO_TLS_CREDS);
4305 if (!s->tls_creds) {
4306 error_setg(errp, "Object with id '%s' is not TLS credentials",
4310 object_ref(OBJECT(s->tls_creds));
4312 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4313 error_setg(errp, "%s",
4314 "Expected TLS credentials for server endpoint");
4318 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4319 error_setg(errp, "%s",
4320 "Expected TLS credentials for client endpoint");
4326 qapi_copy_SocketAddress(&s->addr, sock->addr);
4329 chr->chr_write = tcp_chr_write;
4330 chr->chr_sync_read = tcp_chr_sync_read;
4331 chr->chr_close = tcp_chr_close;
4332 chr->get_msgfds = tcp_get_msgfds;
4333 chr->set_msgfds = tcp_set_msgfds;
4334 chr->chr_add_client = tcp_chr_add_client;
4335 chr->chr_add_watch = tcp_chr_add_watch;
4336 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4337 /* be isn't opened until we get a connection */
4338 chr->explicit_be_open = true;
4340 chr->filename = SocketAddress_to_str("disconnected:",
4341 addr, is_listen, is_telnet);
4345 s->do_telnetopt = 1;
4347 } else if (reconnect > 0) {
4348 s->reconnect_time = reconnect;
4351 if (s->reconnect_time) {
4352 socket_try_connect(chr);
4353 } else if (!qemu_chr_open_socket_fd(chr, errp)) {
4357 if (is_listen && is_waitconnect) {
4358 fprintf(stderr, "QEMU waiting for connection on: %s\n",
4360 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
4361 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
4368 object_unref(OBJECT(s->tls_creds));
4371 qemu_chr_free_common(chr);
4375 static CharDriverState *qmp_chardev_open_udp(const char *id,
4376 ChardevBackend *backend,
4380 ChardevUdp *udp = backend->u.udp;
4381 ChardevCommon *common = qapi_ChardevUdp_base(backend->u.udp);
4382 QIOChannelSocket *sioc = qio_channel_socket_new();
4384 if (qio_channel_socket_dgram_sync(sioc,
4385 udp->remote, udp->local,
4387 object_unref(OBJECT(sioc));
4390 return qemu_chr_open_udp(sioc, common, errp);
4393 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4396 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4397 CharDriverState *chr = NULL;
4398 Error *local_err = NULL;
4402 chr = qemu_chr_find(id);
4404 error_setg(errp, "Chardev '%s' already exists", id);
4409 for (i = backends; i; i = i->next) {
4412 if (cd->kind == backend->type) {
4413 chr = cd->create(id, backend, ret, &local_err);
4415 error_propagate(errp, local_err);
4424 error_setg(errp, "chardev backend not available");
4428 chr->label = g_strdup(id);
4429 chr->avail_connections =
4430 (backend->type == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4431 if (!chr->filename) {
4432 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4434 if (!chr->explicit_be_open) {
4435 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4437 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4445 void qmp_chardev_remove(const char *id, Error **errp)
4447 CharDriverState *chr;
4449 chr = qemu_chr_find(id);
4451 error_setg(errp, "Chardev '%s' not found", id);
4454 if (chr->chr_can_read || chr->chr_read ||
4455 chr->chr_event || chr->handler_opaque) {
4456 error_setg(errp, "Chardev '%s' is busy", id);
4459 qemu_chr_delete(chr);
4462 static void register_types(void)
4464 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4465 qemu_chr_open_null);
4466 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4467 qemu_chr_parse_socket, qmp_chardev_open_socket);
4468 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4469 qmp_chardev_open_udp);
4470 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4471 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4472 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4473 qemu_chr_parse_file_out, qmp_chardev_open_file);
4474 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4475 qemu_chr_parse_stdio, qemu_chr_open_stdio);
4476 #if defined HAVE_CHARDEV_SERIAL
4477 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4478 qemu_chr_parse_serial, qmp_chardev_open_serial);
4479 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4480 qemu_chr_parse_serial, qmp_chardev_open_serial);
4482 #ifdef HAVE_CHARDEV_PARPORT
4483 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4484 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4485 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4486 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4488 #ifdef HAVE_CHARDEV_PTY
4489 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4493 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4494 qemu_chr_open_win_con);
4496 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4497 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4498 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4500 /* Bug-compatibility: */
4501 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4502 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4503 /* this must be done after machine init, since we register FEs with muxes
4504 * as part of realize functions like serial_isa_realizefn when -nographic
4507 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4510 type_init(register_types);