4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "qemu/osdep.h"
25 #include "qemu-common.h"
26 #include "qemu/cutils.h"
27 #include "monitor/monitor.h"
28 #include "sysemu/sysemu.h"
29 #include "sysemu/block-backend.h"
30 #include "qemu/error-report.h"
31 #include "qemu/timer.h"
32 #include "sysemu/char.h"
34 #include "qmp-commands.h"
35 #include "qapi/clone-visitor.h"
36 #include "qapi-visit.h"
37 #include "qemu/base64.h"
38 #include "io/channel-socket.h"
39 #include "io/channel-file.h"
40 #include "io/channel-tls.h"
41 #include "sysemu/replay.h"
42 #include "qemu/help_option.h"
47 #include <sys/times.h>
50 #include <sys/ioctl.h>
51 #include <sys/resource.h>
52 #include <sys/socket.h>
53 #include <netinet/in.h>
55 #include <arpa/inet.h>
57 #include <sys/select.h>
59 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
60 #include <dev/ppbus/ppi.h>
61 #include <dev/ppbus/ppbconf.h>
62 #elif defined(__DragonFly__)
63 #include <dev/misc/ppi/ppi.h>
64 #include <bus/ppbus/ppbconf.h>
68 #include <linux/ppdev.h>
69 #include <linux/parport.h>
72 #include <sys/ethernet.h>
73 #include <sys/sockio.h>
74 #include <netinet/arp.h>
75 #include <netinet/in.h>
76 #include <netinet/in_systm.h>
77 #include <netinet/ip.h>
78 #include <netinet/ip_icmp.h> // must come after ip.h
79 #include <netinet/udp.h>
80 #include <netinet/tcp.h>
85 #include "qemu/sockets.h"
86 #include "ui/qemu-spice.h"
88 #define READ_BUF_LEN 4096
89 #define READ_RETRIES 10
90 #define TCP_MAX_FDS 16
92 typedef struct MuxDriver MuxDriver;
94 /***********************************************************/
95 /* Socket address helpers */
97 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
98 bool is_listen, bool is_telnet)
100 switch (addr->type) {
101 case SOCKET_ADDRESS_KIND_INET:
102 return g_strdup_printf("%s%s:%s:%s%s", prefix,
103 is_telnet ? "telnet" : "tcp",
104 addr->u.inet.data->host,
105 addr->u.inet.data->port,
106 is_listen ? ",server" : "");
108 case SOCKET_ADDRESS_KIND_UNIX:
109 return g_strdup_printf("%sunix:%s%s", prefix,
110 addr->u.q_unix.data->path,
111 is_listen ? ",server" : "");
113 case SOCKET_ADDRESS_KIND_FD:
114 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.data->str,
115 is_listen ? ",server" : "");
122 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
123 struct sockaddr_storage *ps, socklen_t ps_len,
124 bool is_listen, bool is_telnet)
126 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
127 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
128 const char *left = "", *right = "";
130 switch (ss->ss_family) {
133 return g_strdup_printf("unix:%s%s",
134 ((struct sockaddr_un *)(ss))->sun_path,
135 is_listen ? ",server" : "");
142 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
143 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
144 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
145 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
146 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
147 is_telnet ? "telnet" : "tcp",
148 left, shost, right, sserv,
149 is_listen ? ",server" : "",
150 left, phost, right, pserv);
153 return g_strdup_printf("unknown");
157 /***********************************************************/
158 /* character device */
160 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
161 QTAILQ_HEAD_INITIALIZER(chardevs);
163 static void qemu_chr_free_common(CharDriverState *chr);
165 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp)
167 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
168 qemu_mutex_init(&chr->chr_write_lock);
170 if (backend->has_logfile) {
171 int flags = O_WRONLY | O_CREAT;
172 if (backend->has_logappend &&
173 backend->logappend) {
178 chr->logfd = qemu_open(backend->logfile, flags, 0666);
179 if (chr->logfd < 0) {
180 error_setg_errno(errp, errno,
181 "Unable to open logfile %s",
193 void qemu_chr_be_event(CharDriverState *s, int event)
195 /* Keep track if the char device is open */
197 case CHR_EVENT_OPENED:
200 case CHR_EVENT_CLOSED:
207 s->chr_event(s->handler_opaque, event);
210 void qemu_chr_be_generic_open(CharDriverState *s)
212 qemu_chr_be_event(s, CHR_EVENT_OPENED);
216 /* Not reporting errors from writing to logfile, as logs are
217 * defined to be "best effort" only */
218 static void qemu_chr_fe_write_log(CharDriverState *s,
219 const uint8_t *buf, size_t len)
230 ret = write(s->logfd, buf + done, len - done);
231 if (ret == -1 && errno == EAGAIN) {
243 static int qemu_chr_fe_write_buffer(CharDriverState *s, const uint8_t *buf, int len, int *offset)
248 qemu_mutex_lock(&s->chr_write_lock);
249 while (*offset < len) {
251 res = s->chr_write(s, buf + *offset, len - *offset);
252 if (res < 0 && errno == EAGAIN) {
264 qemu_chr_fe_write_log(s, buf, *offset);
266 qemu_mutex_unlock(&s->chr_write_lock);
271 int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len)
273 CharDriverState *s = be->chr;
276 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
278 replay_char_write_event_load(&ret, &offset);
279 assert(offset <= len);
280 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
284 qemu_mutex_lock(&s->chr_write_lock);
285 ret = s->chr_write(s, buf, len);
288 qemu_chr_fe_write_log(s, buf, ret);
291 qemu_mutex_unlock(&s->chr_write_lock);
293 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
294 replay_char_write_event_save(ret, ret < 0 ? 0 : ret);
300 static int qemu_chr_write_all(CharDriverState *s, const uint8_t *buf, int len)
305 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
306 replay_char_write_event_load(&res, &offset);
307 assert(offset <= len);
308 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
312 res = qemu_chr_fe_write_buffer(s, buf, len, &offset);
314 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
315 replay_char_write_event_save(res, offset);
324 int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len)
326 CharDriverState *s = be->chr;
328 return qemu_chr_write_all(s, buf, len);
331 int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len)
333 CharDriverState *s = be->chr;
334 int offset = 0, counter = 10;
337 if (!s->chr_sync_read) {
341 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
342 return replay_char_read_all_load(buf);
345 while (offset < len) {
347 res = s->chr_sync_read(s, buf + offset, len - offset);
348 if (res == -1 && errno == EAGAIN) {
358 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
359 replay_char_read_all_save_error(res);
371 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
372 replay_char_read_all_save_buf(buf, offset);
377 int qemu_chr_fe_ioctl(CharBackend *be, int cmd, void *arg)
379 CharDriverState *s = be->chr;
381 if (!s->chr_ioctl || s->replay) {
384 res = s->chr_ioctl(s, cmd, arg);
390 int qemu_chr_be_can_write(CharDriverState *s)
392 if (!s->chr_can_read)
394 return s->chr_can_read(s->handler_opaque);
397 void qemu_chr_be_write_impl(CharDriverState *s, uint8_t *buf, int len)
400 s->chr_read(s->handler_opaque, buf, len);
404 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
407 if (replay_mode == REPLAY_MODE_PLAY) {
410 replay_chr_be_write(s, buf, len);
412 qemu_chr_be_write_impl(s, buf, len);
416 int qemu_chr_fe_get_msgfd(CharBackend *be)
418 CharDriverState *s = be->chr;
420 int res = (qemu_chr_fe_get_msgfds(be, &fd, 1) == 1) ? fd : -1;
423 "Replay: get msgfd is not supported for serial devices yet\n");
429 int qemu_chr_fe_get_msgfds(CharBackend *be, int *fds, int len)
431 CharDriverState *s = be->chr;
433 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
436 int qemu_chr_fe_set_msgfds(CharBackend *be, int *fds, int num)
438 CharDriverState *s = be->chr;
440 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
443 int qemu_chr_add_client(CharDriverState *s, int fd)
445 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
448 void qemu_chr_fe_accept_input(CharBackend *be)
450 CharDriverState *s = be->chr;
452 if (s->chr_accept_input)
453 s->chr_accept_input(s);
457 void qemu_chr_fe_printf(CharBackend *be, const char *fmt, ...)
459 char buf[READ_BUF_LEN];
462 vsnprintf(buf, sizeof(buf), fmt, ap);
463 /* XXX this blocks entire thread. Rewrite to use
464 * qemu_chr_fe_write and background I/O callbacks */
465 qemu_chr_fe_write_all(be, (uint8_t *)buf, strlen(buf));
469 static void remove_fd_in_watch(CharDriverState *chr);
470 static int mux_chr_new_handler_tag(CharDriverState *chr, Error **errp);
471 static void mux_chr_set_handlers(CharDriverState *chr, GMainContext *context);
472 static void mux_set_focus(MuxDriver *d, int focus);
474 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
479 static CharDriverState *qemu_chr_open_null(const char *id,
480 ChardevBackend *backend,
484 CharDriverState *chr;
485 ChardevCommon *common = backend->u.null.data;
487 chr = qemu_chr_alloc(common, errp);
491 chr->chr_write = null_chr_write;
492 chr->explicit_be_open = true;
496 /* MUX driver for serial I/O splitting */
498 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
499 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
501 IOCanReadHandler *chr_can_read[MAX_MUX];
502 IOReadHandler *chr_read[MAX_MUX];
503 IOEventHandler *chr_event[MAX_MUX];
504 void *ext_opaque[MAX_MUX];
510 /* Intermediate input buffer allows to catch escape sequences even if the
511 currently active device is not accepting any input - but only until it
513 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
518 /* Protected by the CharDriverState chr_write_lock. */
520 int64_t timestamps_start;
523 /* Called with chr_write_lock held. */
524 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
526 MuxDriver *d = chr->opaque;
528 if (!d->timestamps) {
529 ret = qemu_chr_fe_write(&d->chr, buf, len);
534 for (i = 0; i < len; i++) {
540 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
541 if (d->timestamps_start == -1)
542 d->timestamps_start = ti;
543 ti -= d->timestamps_start;
545 snprintf(buf1, sizeof(buf1),
546 "[%02d:%02d:%02d.%03d] ",
551 /* XXX this blocks entire thread. Rewrite to use
552 * qemu_chr_fe_write and background I/O callbacks */
553 qemu_chr_fe_write_all(&d->chr,
554 (uint8_t *)buf1, strlen(buf1));
557 ret += qemu_chr_fe_write(&d->chr, buf + i, 1);
558 if (buf[i] == '\n') {
566 static const char * const mux_help[] = {
567 "% h print this help\n\r",
568 "% x exit emulator\n\r",
569 "% s save disk data back to file (if -snapshot)\n\r",
570 "% t toggle console timestamps\n\r",
571 "% b send break (magic sysrq)\n\r",
572 "% c switch between console and monitor\n\r",
577 int term_escape_char = 0x01; /* ctrl-a is used for escape */
578 static void mux_print_help(CharDriverState *chr)
581 char ebuf[15] = "Escape-Char";
582 char cbuf[50] = "\n\r";
584 if (term_escape_char > 0 && term_escape_char < 26) {
585 snprintf(cbuf, sizeof(cbuf), "\n\r");
586 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
588 snprintf(cbuf, sizeof(cbuf),
589 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
592 /* XXX this blocks entire thread. Rewrite to use
593 * qemu_chr_fe_write and background I/O callbacks */
594 qemu_chr_write_all(chr, (uint8_t *)cbuf, strlen(cbuf));
595 for (i = 0; mux_help[i] != NULL; i++) {
596 for (j=0; mux_help[i][j] != '\0'; j++) {
597 if (mux_help[i][j] == '%')
598 qemu_chr_write_all(chr, (uint8_t *)ebuf, strlen(ebuf));
600 qemu_chr_write_all(chr, (uint8_t *)&mux_help[i][j], 1);
605 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
607 if (d->chr_event[mux_nr])
608 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
611 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
613 if (d->term_got_escape) {
614 d->term_got_escape = 0;
615 if (ch == term_escape_char)
624 const char *term = "QEMU: Terminated\n\r";
625 qemu_chr_write_all(chr, (uint8_t *)term, strlen(term));
633 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
636 assert(d->mux_cnt > 0); /* handler registered with first fe */
637 /* Switch to the next registered device */
638 mux_set_focus(d, (d->focus + 1) % d->mux_cnt);
641 d->timestamps = !d->timestamps;
642 d->timestamps_start = -1;
646 } else if (ch == term_escape_char) {
647 d->term_got_escape = 1;
655 static void mux_chr_accept_input(CharDriverState *chr)
657 MuxDriver *d = chr->opaque;
660 while (d->prod[m] != d->cons[m] &&
661 d->chr_can_read[m] &&
662 d->chr_can_read[m](d->ext_opaque[m])) {
663 d->chr_read[m](d->ext_opaque[m],
664 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
668 static int mux_chr_can_read(void *opaque)
670 CharDriverState *chr = opaque;
671 MuxDriver *d = chr->opaque;
674 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
676 if (d->chr_can_read[m])
677 return d->chr_can_read[m](d->ext_opaque[m]);
681 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
683 CharDriverState *chr = opaque;
684 MuxDriver *d = chr->opaque;
688 mux_chr_accept_input (opaque);
690 for(i = 0; i < size; i++)
691 if (mux_proc_byte(chr, d, buf[i])) {
692 if (d->prod[m] == d->cons[m] &&
693 d->chr_can_read[m] &&
694 d->chr_can_read[m](d->ext_opaque[m]))
695 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
697 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
701 static void mux_chr_event(void *opaque, int event)
703 CharDriverState *chr = opaque;
704 MuxDriver *d = chr->opaque;
707 /* Send the event to all registered listeners */
708 for (i = 0; i < d->mux_cnt; i++)
709 mux_chr_send_event(d, i, event);
712 static void mux_chr_update_read_handler(CharDriverState *chr,
713 GMainContext *context,
716 MuxDriver *d = chr->opaque;
719 assert(tag < d->mux_cnt);
721 d->ext_opaque[tag] = chr->handler_opaque;
722 d->chr_can_read[tag] = chr->chr_can_read;
723 d->chr_read[tag] = chr->chr_read;
724 d->chr_event[tag] = chr->chr_event;
727 static bool muxes_realized;
730 * Called after processing of default and command-line-specified
731 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
732 * to a mux chardev. This is done here to ensure that
733 * output/prompts/banners are only displayed for the FE that has
734 * focus when initial command-line processing/machine init is
737 * After this point, any new FE attached to any new or existing
738 * mux will receive CHR_EVENT_OPENED notifications for the BE
741 static void muxes_realize_done(Notifier *notifier, void *unused)
743 CharDriverState *chr;
745 QTAILQ_FOREACH(chr, &chardevs, next) {
747 MuxDriver *d = chr->opaque;
750 /* send OPENED to all already-attached FEs */
751 for (i = 0; i < d->mux_cnt; i++) {
752 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
754 /* mark mux as OPENED so any new FEs will immediately receive
757 qemu_chr_be_generic_open(chr);
760 muxes_realized = true;
763 static Notifier muxes_realize_notify = {
764 .notify = muxes_realize_done,
767 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
769 MuxDriver *d = s->opaque;
770 CharDriverState *chr = qemu_chr_fe_get_driver(&d->chr);
772 return chr->chr_add_watch(chr, cond);
775 static void mux_chr_close(struct CharDriverState *chr)
777 MuxDriver *d = chr->opaque;
782 static int mux_chr_new_handler_tag(CharDriverState *chr, Error **errp)
784 MuxDriver *d = chr->opaque;
786 if (d->mux_cnt >= MAX_MUX) {
787 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
794 static void mux_chr_set_handlers(CharDriverState *chr, GMainContext *context)
796 MuxDriver *d = chr->opaque;
798 /* Fix up the real driver with mux routines */
799 qemu_chr_fe_set_handlers(&d->chr,
807 static void mux_set_focus(MuxDriver *d, int focus)
810 assert(focus < d->mux_cnt);
812 if (d->focus != -1) {
813 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
817 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
820 static CharDriverState *qemu_chr_open_mux(const char *id,
821 ChardevBackend *backend,
822 ChardevReturn *ret, Error **errp)
824 ChardevMux *mux = backend->u.mux.data;
825 CharDriverState *chr, *drv;
827 ChardevCommon *common = qapi_ChardevMux_base(mux);
829 drv = qemu_chr_find(mux->chardev);
831 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
835 chr = qemu_chr_alloc(common, errp);
839 d = g_new0(MuxDriver, 1);
843 chr->chr_close = mux_chr_close;
844 chr->chr_write = mux_chr_write;
845 chr->chr_update_read_handler = mux_chr_update_read_handler;
846 chr->chr_accept_input = mux_chr_accept_input;
847 /* Frontend guest-open / -close notification is not support with muxes */
848 chr->chr_set_fe_open = NULL;
849 if (drv->chr_add_watch) {
850 chr->chr_add_watch = mux_chr_add_watch;
852 /* only default to opened state if we've realized the initial
855 chr->explicit_be_open = muxes_realized ? 0 : 1;
857 if (!qemu_chr_fe_init(&d->chr, drv, errp)) {
865 CharDriverState *qemu_chr_fe_get_driver(CharBackend *be)
870 bool qemu_chr_fe_init(CharBackend *b, CharDriverState *s, Error **errp)
875 tag = mux_chr_new_handler_tag(s, errp);
887 void qemu_chr_fe_set_handlers(CharBackend *b,
888 IOCanReadHandler *fd_can_read,
889 IOReadHandler *fd_read,
890 IOEventHandler *fd_event,
892 GMainContext *context)
902 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
904 remove_fd_in_watch(s);
908 s->chr_can_read = fd_can_read;
909 s->chr_read = fd_read;
910 s->chr_event = fd_event;
911 s->handler_opaque = opaque;
912 if (s->chr_update_read_handler) {
913 s->chr_update_read_handler(s, context, b->tag);
916 if (!s->explicit_fe_open) {
917 qemu_chr_fe_set_open(b, fe_open);
921 qemu_chr_fe_take_focus(b);
922 /* We're connecting to an already opened device, so let's make sure we
923 also get the open event */
925 qemu_chr_be_generic_open(s);
930 mux_chr_set_handlers(s, context);
934 void qemu_chr_fe_take_focus(CharBackend *b)
936 if (b->chr->is_mux) {
937 mux_set_focus(b->chr->opaque, b->tag);
941 typedef struct IOWatchPoll
948 IOCanReadHandler *fd_can_read;
951 GMainContext *context;
954 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
956 return container_of(source, IOWatchPoll, parent);
959 static gboolean io_watch_poll_prepare(GSource *source,
962 IOWatchPoll *iwp = io_watch_poll_from_source(source);
963 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
964 bool was_active = iwp->src != NULL;
965 if (was_active == now_active) {
970 iwp->src = qio_channel_create_watch(
971 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
972 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
973 g_source_attach(iwp->src, iwp->context);
975 g_source_destroy(iwp->src);
976 g_source_unref(iwp->src);
982 static gboolean io_watch_poll_check(GSource *source)
987 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
993 static void io_watch_poll_finalize(GSource *source)
995 /* Due to a glib bug, removing the last reference to a source
996 * inside a finalize callback causes recursive locking (and a
997 * deadlock). This is not a problem inside other callbacks,
998 * including dispatch callbacks, so we call io_remove_watch_poll
999 * to remove this source. At this point, iwp->src must
1000 * be NULL, or we would leak it.
1002 * This would be solved much more elegantly by child sources,
1003 * but we support older glib versions that do not have them.
1005 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1006 assert(iwp->src == NULL);
1009 static GSourceFuncs io_watch_poll_funcs = {
1010 .prepare = io_watch_poll_prepare,
1011 .check = io_watch_poll_check,
1012 .dispatch = io_watch_poll_dispatch,
1013 .finalize = io_watch_poll_finalize,
1016 /* Can only be used for read */
1017 static guint io_add_watch_poll(QIOChannel *ioc,
1018 IOCanReadHandler *fd_can_read,
1019 QIOChannelFunc fd_read,
1021 GMainContext *context)
1026 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs,
1027 sizeof(IOWatchPoll));
1028 iwp->fd_can_read = fd_can_read;
1029 iwp->opaque = user_data;
1031 iwp->fd_read = (GSourceFunc) fd_read;
1033 iwp->context = context;
1035 tag = g_source_attach(&iwp->parent, context);
1036 g_source_unref(&iwp->parent);
1040 static void io_remove_watch_poll(guint tag)
1045 g_return_if_fail (tag > 0);
1047 source = g_main_context_find_source_by_id(NULL, tag);
1048 g_return_if_fail (source != NULL);
1050 iwp = io_watch_poll_from_source(source);
1052 g_source_destroy(iwp->src);
1053 g_source_unref(iwp->src);
1056 g_source_destroy(&iwp->parent);
1059 static void remove_fd_in_watch(CharDriverState *chr)
1061 if (chr->fd_in_tag) {
1062 io_remove_watch_poll(chr->fd_in_tag);
1068 static int io_channel_send_full(QIOChannel *ioc,
1069 const void *buf, size_t len,
1070 int *fds, size_t nfds)
1074 while (offset < len) {
1076 struct iovec iov = { .iov_base = (char *)buf + offset,
1077 .iov_len = len - offset };
1079 ret = qio_channel_writev_full(
1082 if (ret == QIO_CHANNEL_ERR_BLOCK) {
1089 } else if (ret < 0) {
1102 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
1104 return io_channel_send_full(ioc, buf, len, NULL, 0);
1108 typedef struct FDCharDriver {
1109 CharDriverState *chr;
1110 QIOChannel *ioc_in, *ioc_out;
1114 /* Called with chr_write_lock held. */
1115 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1117 FDCharDriver *s = chr->opaque;
1119 return io_channel_send(s->ioc_out, buf, len);
1122 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1124 CharDriverState *chr = opaque;
1125 FDCharDriver *s = chr->opaque;
1127 uint8_t buf[READ_BUF_LEN];
1131 if (len > s->max_size) {
1138 ret = qio_channel_read(
1139 chan, (gchar *)buf, len, NULL);
1141 remove_fd_in_watch(chr);
1142 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1146 qemu_chr_be_write(chr, buf, ret);
1152 static int fd_chr_read_poll(void *opaque)
1154 CharDriverState *chr = opaque;
1155 FDCharDriver *s = chr->opaque;
1157 s->max_size = qemu_chr_be_can_write(chr);
1161 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1163 FDCharDriver *s = chr->opaque;
1164 return qio_channel_create_watch(s->ioc_out, cond);
1167 static void fd_chr_update_read_handler(CharDriverState *chr,
1168 GMainContext *context,
1171 FDCharDriver *s = chr->opaque;
1173 remove_fd_in_watch(chr);
1175 chr->fd_in_tag = io_add_watch_poll(s->ioc_in,
1182 static void fd_chr_close(struct CharDriverState *chr)
1184 FDCharDriver *s = chr->opaque;
1186 remove_fd_in_watch(chr);
1188 object_unref(OBJECT(s->ioc_in));
1191 object_unref(OBJECT(s->ioc_out));
1195 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1198 /* open a character device to a unix fd */
1199 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out,
1200 ChardevCommon *backend, Error **errp)
1202 CharDriverState *chr;
1205 chr = qemu_chr_alloc(backend, errp);
1209 s = g_new0(FDCharDriver, 1);
1210 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1211 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1212 qemu_set_nonblock(fd_out);
1215 chr->chr_add_watch = fd_chr_add_watch;
1216 chr->chr_write = fd_chr_write;
1217 chr->chr_update_read_handler = fd_chr_update_read_handler;
1218 chr->chr_close = fd_chr_close;
1223 static CharDriverState *qemu_chr_open_pipe(const char *id,
1224 ChardevBackend *backend,
1228 ChardevHostdev *opts = backend->u.pipe.data;
1232 const char *filename = opts->device;
1233 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
1236 filename_in = g_strdup_printf("%s.in", filename);
1237 filename_out = g_strdup_printf("%s.out", filename);
1238 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1239 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1240 g_free(filename_in);
1241 g_free(filename_out);
1242 if (fd_in < 0 || fd_out < 0) {
1247 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1249 error_setg_file_open(errp, errno, filename);
1253 return qemu_chr_open_fd(fd_in, fd_out, common, errp);
1256 /* init terminal so that we can grab keys */
1257 static struct termios oldtty;
1258 static int old_fd0_flags;
1259 static bool stdio_in_use;
1260 static bool stdio_allow_signal;
1261 static bool stdio_echo_state;
1263 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1265 static void term_exit(void)
1267 tcsetattr (0, TCSANOW, &oldtty);
1268 fcntl(0, F_SETFL, old_fd0_flags);
1271 static void term_stdio_handler(int sig)
1273 /* restore echo after resume from suspend. */
1274 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1277 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1281 stdio_echo_state = echo;
1284 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1285 |INLCR|IGNCR|ICRNL|IXON);
1286 tty.c_oflag |= OPOST;
1287 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1288 tty.c_cflag &= ~(CSIZE|PARENB);
1291 tty.c_cc[VTIME] = 0;
1293 if (!stdio_allow_signal)
1294 tty.c_lflag &= ~ISIG;
1296 tcsetattr (0, TCSANOW, &tty);
1299 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1305 static CharDriverState *qemu_chr_open_stdio(const char *id,
1306 ChardevBackend *backend,
1310 ChardevStdio *opts = backend->u.stdio.data;
1311 CharDriverState *chr;
1312 struct sigaction act;
1313 ChardevCommon *common = qapi_ChardevStdio_base(opts);
1315 if (is_daemonized()) {
1316 error_setg(errp, "cannot use stdio with -daemonize");
1321 error_setg(errp, "cannot use stdio by multiple character devices");
1325 stdio_in_use = true;
1326 old_fd0_flags = fcntl(0, F_GETFL);
1327 tcgetattr(0, &oldtty);
1328 qemu_set_nonblock(0);
1331 memset(&act, 0, sizeof(act));
1332 act.sa_handler = term_stdio_handler;
1333 sigaction(SIGCONT, &act, NULL);
1335 chr = qemu_chr_open_fd(0, 1, common, errp);
1339 chr->chr_close = qemu_chr_close_stdio;
1340 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1341 if (opts->has_signal) {
1342 stdio_allow_signal = opts->signal;
1344 qemu_chr_set_echo_stdio(chr, false);
1349 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1350 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1351 || defined(__GLIBC__)
1353 #define HAVE_CHARDEV_SERIAL 1
1354 #define HAVE_CHARDEV_PTY 1
1360 /* Protected by the CharDriverState chr_write_lock. */
1366 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1367 static void pty_chr_state(CharDriverState *chr, int connected);
1369 static gboolean pty_chr_timer(gpointer opaque)
1371 struct CharDriverState *chr = opaque;
1372 PtyCharDriver *s = chr->opaque;
1374 qemu_mutex_lock(&chr->chr_write_lock);
1377 if (!s->connected) {
1379 pty_chr_update_read_handler_locked(chr);
1381 qemu_mutex_unlock(&chr->chr_write_lock);
1385 /* Called with chr_write_lock held. */
1386 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1388 PtyCharDriver *s = chr->opaque;
1391 g_source_remove(s->timer_tag);
1396 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1398 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1402 /* Called with chr_write_lock held. */
1403 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1405 PtyCharDriver *s = chr->opaque;
1408 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1411 pfd.events = G_IO_OUT;
1414 rc = g_poll(&pfd, 1, 0);
1415 } while (rc == -1 && errno == EINTR);
1418 if (pfd.revents & G_IO_HUP) {
1419 pty_chr_state(chr, 0);
1421 pty_chr_state(chr, 1);
1425 static void pty_chr_update_read_handler(CharDriverState *chr,
1426 GMainContext *context,
1429 qemu_mutex_lock(&chr->chr_write_lock);
1430 pty_chr_update_read_handler_locked(chr);
1431 qemu_mutex_unlock(&chr->chr_write_lock);
1434 /* Called with chr_write_lock held. */
1435 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1437 PtyCharDriver *s = chr->opaque;
1439 if (!s->connected) {
1440 /* guest sends data, check for (re-)connect */
1441 pty_chr_update_read_handler_locked(chr);
1442 if (!s->connected) {
1446 return io_channel_send(s->ioc, buf, len);
1449 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1451 PtyCharDriver *s = chr->opaque;
1452 if (!s->connected) {
1455 return qio_channel_create_watch(s->ioc, cond);
1458 static int pty_chr_read_poll(void *opaque)
1460 CharDriverState *chr = opaque;
1461 PtyCharDriver *s = chr->opaque;
1463 s->read_bytes = qemu_chr_be_can_write(chr);
1464 return s->read_bytes;
1467 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1469 CharDriverState *chr = opaque;
1470 PtyCharDriver *s = chr->opaque;
1472 uint8_t buf[READ_BUF_LEN];
1476 if (len > s->read_bytes)
1477 len = s->read_bytes;
1481 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1483 pty_chr_state(chr, 0);
1486 pty_chr_state(chr, 1);
1487 qemu_chr_be_write(chr, buf, ret);
1492 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1494 CharDriverState *chr = opaque;
1495 PtyCharDriver *s = chr->opaque;
1498 qemu_chr_be_generic_open(chr);
1502 /* Called with chr_write_lock held. */
1503 static void pty_chr_state(CharDriverState *chr, int connected)
1505 PtyCharDriver *s = chr->opaque;
1509 g_source_remove(s->open_tag);
1512 remove_fd_in_watch(chr);
1514 /* (re-)connect poll interval for idle guests: once per second.
1515 * We check more frequently in case the guests sends data to
1516 * the virtual device linked to our pty. */
1517 pty_chr_rearm_timer(chr, 1000);
1520 g_source_remove(s->timer_tag);
1523 if (!s->connected) {
1524 g_assert(s->open_tag == 0);
1526 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1528 if (!chr->fd_in_tag) {
1529 chr->fd_in_tag = io_add_watch_poll(s->ioc,
1537 static void pty_chr_close(struct CharDriverState *chr)
1539 PtyCharDriver *s = chr->opaque;
1541 qemu_mutex_lock(&chr->chr_write_lock);
1542 pty_chr_state(chr, 0);
1543 object_unref(OBJECT(s->ioc));
1545 g_source_remove(s->timer_tag);
1548 qemu_mutex_unlock(&chr->chr_write_lock);
1550 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1553 static CharDriverState *qemu_chr_open_pty(const char *id,
1554 ChardevBackend *backend,
1558 CharDriverState *chr;
1560 int master_fd, slave_fd;
1561 char pty_name[PATH_MAX];
1562 ChardevCommon *common = backend->u.pty.data;
1564 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1565 if (master_fd < 0) {
1566 error_setg_errno(errp, errno, "Failed to create PTY");
1571 qemu_set_nonblock(master_fd);
1573 chr = qemu_chr_alloc(common, errp);
1579 chr->filename = g_strdup_printf("pty:%s", pty_name);
1580 ret->pty = g_strdup(pty_name);
1581 ret->has_pty = true;
1583 fprintf(stderr, "char device redirected to %s (label %s)\n",
1586 s = g_new0(PtyCharDriver, 1);
1588 chr->chr_write = pty_chr_write;
1589 chr->chr_update_read_handler = pty_chr_update_read_handler;
1590 chr->chr_close = pty_chr_close;
1591 chr->chr_add_watch = pty_chr_add_watch;
1592 chr->explicit_be_open = true;
1594 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1600 static void tty_serial_init(int fd, int speed,
1601 int parity, int data_bits, int stop_bits)
1607 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1608 speed, parity, data_bits, stop_bits);
1610 tcgetattr (fd, &tty);
1612 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1613 speed = speed * 10 / 11;
1630 /* Non-Posix values follow. They may be unsupported on some systems. */
1632 check_speed(115200);
1634 check_speed(230400);
1637 check_speed(460800);
1640 check_speed(500000);
1643 check_speed(576000);
1646 check_speed(921600);
1649 check_speed(1000000);
1652 check_speed(1152000);
1655 check_speed(1500000);
1658 check_speed(2000000);
1661 check_speed(2500000);
1664 check_speed(3000000);
1667 check_speed(3500000);
1670 check_speed(4000000);
1675 cfsetispeed(&tty, spd);
1676 cfsetospeed(&tty, spd);
1678 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1679 |INLCR|IGNCR|ICRNL|IXON);
1680 tty.c_oflag |= OPOST;
1681 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1682 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1703 tty.c_cflag |= PARENB;
1706 tty.c_cflag |= PARENB | PARODD;
1710 tty.c_cflag |= CSTOPB;
1712 tcsetattr (fd, TCSANOW, &tty);
1715 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1717 FDCharDriver *s = chr->opaque;
1718 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1721 case CHR_IOCTL_SERIAL_SET_PARAMS:
1723 QEMUSerialSetParams *ssp = arg;
1724 tty_serial_init(fioc->fd,
1725 ssp->speed, ssp->parity,
1726 ssp->data_bits, ssp->stop_bits);
1729 case CHR_IOCTL_SERIAL_SET_BREAK:
1731 int enable = *(int *)arg;
1733 tcsendbreak(fioc->fd, 1);
1737 case CHR_IOCTL_SERIAL_GET_TIOCM:
1740 int *targ = (int *)arg;
1741 ioctl(fioc->fd, TIOCMGET, &sarg);
1743 if (sarg & TIOCM_CTS)
1744 *targ |= CHR_TIOCM_CTS;
1745 if (sarg & TIOCM_CAR)
1746 *targ |= CHR_TIOCM_CAR;
1747 if (sarg & TIOCM_DSR)
1748 *targ |= CHR_TIOCM_DSR;
1749 if (sarg & TIOCM_RI)
1750 *targ |= CHR_TIOCM_RI;
1751 if (sarg & TIOCM_DTR)
1752 *targ |= CHR_TIOCM_DTR;
1753 if (sarg & TIOCM_RTS)
1754 *targ |= CHR_TIOCM_RTS;
1757 case CHR_IOCTL_SERIAL_SET_TIOCM:
1759 int sarg = *(int *)arg;
1761 ioctl(fioc->fd, TIOCMGET, &targ);
1762 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1763 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1764 if (sarg & CHR_TIOCM_CTS)
1766 if (sarg & CHR_TIOCM_CAR)
1768 if (sarg & CHR_TIOCM_DSR)
1770 if (sarg & CHR_TIOCM_RI)
1772 if (sarg & CHR_TIOCM_DTR)
1774 if (sarg & CHR_TIOCM_RTS)
1776 ioctl(fioc->fd, TIOCMSET, &targ);
1785 static void qemu_chr_close_tty(CharDriverState *chr)
1790 static CharDriverState *qemu_chr_open_tty_fd(int fd,
1791 ChardevCommon *backend,
1794 CharDriverState *chr;
1796 tty_serial_init(fd, 115200, 'N', 8, 1);
1797 chr = qemu_chr_open_fd(fd, fd, backend, errp);
1801 chr->chr_ioctl = tty_serial_ioctl;
1802 chr->chr_close = qemu_chr_close_tty;
1805 #endif /* __linux__ || __sun__ */
1807 #if defined(__linux__)
1809 #define HAVE_CHARDEV_PARPORT 1
1814 } ParallelCharDriver;
1816 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1818 if (s->mode != mode) {
1820 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1827 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1829 ParallelCharDriver *drv = chr->opaque;
1834 case CHR_IOCTL_PP_READ_DATA:
1835 if (ioctl(fd, PPRDATA, &b) < 0)
1837 *(uint8_t *)arg = b;
1839 case CHR_IOCTL_PP_WRITE_DATA:
1840 b = *(uint8_t *)arg;
1841 if (ioctl(fd, PPWDATA, &b) < 0)
1844 case CHR_IOCTL_PP_READ_CONTROL:
1845 if (ioctl(fd, PPRCONTROL, &b) < 0)
1847 /* Linux gives only the lowest bits, and no way to know data
1848 direction! For better compatibility set the fixed upper
1850 *(uint8_t *)arg = b | 0xc0;
1852 case CHR_IOCTL_PP_WRITE_CONTROL:
1853 b = *(uint8_t *)arg;
1854 if (ioctl(fd, PPWCONTROL, &b) < 0)
1857 case CHR_IOCTL_PP_READ_STATUS:
1858 if (ioctl(fd, PPRSTATUS, &b) < 0)
1860 *(uint8_t *)arg = b;
1862 case CHR_IOCTL_PP_DATA_DIR:
1863 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1866 case CHR_IOCTL_PP_EPP_READ_ADDR:
1867 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1868 struct ParallelIOArg *parg = arg;
1869 int n = read(fd, parg->buffer, parg->count);
1870 if (n != parg->count) {
1875 case CHR_IOCTL_PP_EPP_READ:
1876 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1877 struct ParallelIOArg *parg = arg;
1878 int n = read(fd, parg->buffer, parg->count);
1879 if (n != parg->count) {
1884 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1885 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1886 struct ParallelIOArg *parg = arg;
1887 int n = write(fd, parg->buffer, parg->count);
1888 if (n != parg->count) {
1893 case CHR_IOCTL_PP_EPP_WRITE:
1894 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1895 struct ParallelIOArg *parg = arg;
1896 int n = write(fd, parg->buffer, parg->count);
1897 if (n != parg->count) {
1908 static void pp_close(CharDriverState *chr)
1910 ParallelCharDriver *drv = chr->opaque;
1913 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1914 ioctl(fd, PPRELEASE);
1917 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1920 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1921 ChardevCommon *backend,
1924 CharDriverState *chr;
1925 ParallelCharDriver *drv;
1927 if (ioctl(fd, PPCLAIM) < 0) {
1928 error_setg_errno(errp, errno, "not a parallel port");
1933 chr = qemu_chr_alloc(backend, errp);
1938 drv = g_new0(ParallelCharDriver, 1);
1940 chr->chr_write = null_chr_write;
1941 chr->chr_ioctl = pp_ioctl;
1942 chr->chr_close = pp_close;
1945 drv->mode = IEEE1284_MODE_COMPAT;
1949 #endif /* __linux__ */
1951 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1953 #define HAVE_CHARDEV_PARPORT 1
1955 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1957 int fd = (int)(intptr_t)chr->opaque;
1961 case CHR_IOCTL_PP_READ_DATA:
1962 if (ioctl(fd, PPIGDATA, &b) < 0)
1964 *(uint8_t *)arg = b;
1966 case CHR_IOCTL_PP_WRITE_DATA:
1967 b = *(uint8_t *)arg;
1968 if (ioctl(fd, PPISDATA, &b) < 0)
1971 case CHR_IOCTL_PP_READ_CONTROL:
1972 if (ioctl(fd, PPIGCTRL, &b) < 0)
1974 *(uint8_t *)arg = b;
1976 case CHR_IOCTL_PP_WRITE_CONTROL:
1977 b = *(uint8_t *)arg;
1978 if (ioctl(fd, PPISCTRL, &b) < 0)
1981 case CHR_IOCTL_PP_READ_STATUS:
1982 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1984 *(uint8_t *)arg = b;
1992 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1993 ChardevCommon *backend,
1996 CharDriverState *chr;
1998 chr = qemu_chr_alloc(backend, errp);
2002 chr->opaque = (void *)(intptr_t)fd;
2003 chr->chr_write = null_chr_write;
2004 chr->chr_ioctl = pp_ioctl;
2005 chr->explicit_be_open = true;
2012 #define HAVE_CHARDEV_SERIAL 1
2016 HANDLE hcom, hrecv, hsend;
2021 /* Protected by the CharDriverState chr_write_lock. */
2027 HANDLE hInputReadyEvent;
2028 HANDLE hInputDoneEvent;
2029 HANDLE hInputThread;
2030 uint8_t win_stdio_buf;
2031 } WinStdioCharState;
2033 #define NSENDBUF 2048
2034 #define NRECVBUF 2048
2035 #define MAXCONNECT 1
2036 #define NTIMEOUT 5000
2038 static int win_chr_poll(void *opaque);
2039 static int win_chr_pipe_poll(void *opaque);
2041 static void win_chr_close(CharDriverState *chr)
2043 WinCharState *s = chr->opaque;
2046 CloseHandle(s->hsend);
2050 CloseHandle(s->hrecv);
2054 CloseHandle(s->hcom);
2058 qemu_del_polling_cb(win_chr_pipe_poll, chr);
2060 qemu_del_polling_cb(win_chr_poll, chr);
2062 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2065 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
2067 WinCharState *s = chr->opaque;
2069 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
2074 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2076 error_setg(errp, "Failed CreateEvent");
2079 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2081 error_setg(errp, "Failed CreateEvent");
2085 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
2086 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
2087 if (s->hcom == INVALID_HANDLE_VALUE) {
2088 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
2093 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
2094 error_setg(errp, "Failed SetupComm");
2098 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
2099 size = sizeof(COMMCONFIG);
2100 GetDefaultCommConfig(filename, &comcfg, &size);
2101 comcfg.dcb.DCBlength = sizeof(DCB);
2102 CommConfigDialog(filename, NULL, &comcfg);
2104 if (!SetCommState(s->hcom, &comcfg.dcb)) {
2105 error_setg(errp, "Failed SetCommState");
2109 if (!SetCommMask(s->hcom, EV_ERR)) {
2110 error_setg(errp, "Failed SetCommMask");
2114 cto.ReadIntervalTimeout = MAXDWORD;
2115 if (!SetCommTimeouts(s->hcom, &cto)) {
2116 error_setg(errp, "Failed SetCommTimeouts");
2120 if (!ClearCommError(s->hcom, &err, &comstat)) {
2121 error_setg(errp, "Failed ClearCommError");
2124 qemu_add_polling_cb(win_chr_poll, chr);
2132 /* Called with chr_write_lock held. */
2133 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
2135 WinCharState *s = chr->opaque;
2136 DWORD len, ret, size, err;
2139 ZeroMemory(&s->osend, sizeof(s->osend));
2140 s->osend.hEvent = s->hsend;
2143 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
2145 ret = WriteFile(s->hcom, buf, len, &size, NULL);
2147 err = GetLastError();
2148 if (err == ERROR_IO_PENDING) {
2149 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
2167 static int win_chr_read_poll(CharDriverState *chr)
2169 WinCharState *s = chr->opaque;
2171 s->max_size = qemu_chr_be_can_write(chr);
2175 static void win_chr_readfile(CharDriverState *chr)
2177 WinCharState *s = chr->opaque;
2179 uint8_t buf[READ_BUF_LEN];
2182 ZeroMemory(&s->orecv, sizeof(s->orecv));
2183 s->orecv.hEvent = s->hrecv;
2184 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2186 err = GetLastError();
2187 if (err == ERROR_IO_PENDING) {
2188 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2193 qemu_chr_be_write(chr, buf, size);
2197 static void win_chr_read(CharDriverState *chr)
2199 WinCharState *s = chr->opaque;
2201 if (s->len > s->max_size)
2202 s->len = s->max_size;
2206 win_chr_readfile(chr);
2209 static int win_chr_poll(void *opaque)
2211 CharDriverState *chr = opaque;
2212 WinCharState *s = chr->opaque;
2216 ClearCommError(s->hcom, &comerr, &status);
2217 if (status.cbInQue > 0) {
2218 s->len = status.cbInQue;
2219 win_chr_read_poll(chr);
2226 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2227 ChardevCommon *backend,
2230 CharDriverState *chr;
2233 chr = qemu_chr_alloc(backend, errp);
2237 s = g_new0(WinCharState, 1);
2239 chr->chr_write = win_chr_write;
2240 chr->chr_close = win_chr_close;
2242 if (win_chr_init(chr, filename, errp) < 0) {
2244 qemu_chr_free_common(chr);
2250 static int win_chr_pipe_poll(void *opaque)
2252 CharDriverState *chr = opaque;
2253 WinCharState *s = chr->opaque;
2256 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2259 win_chr_read_poll(chr);
2266 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2269 WinCharState *s = chr->opaque;
2277 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2279 error_setg(errp, "Failed CreateEvent");
2282 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2284 error_setg(errp, "Failed CreateEvent");
2288 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2289 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2290 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2292 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2294 if (s->hcom == INVALID_HANDLE_VALUE) {
2295 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2300 ZeroMemory(&ov, sizeof(ov));
2301 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2302 ret = ConnectNamedPipe(s->hcom, &ov);
2304 error_setg(errp, "Failed ConnectNamedPipe");
2308 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2310 error_setg(errp, "Failed GetOverlappedResult");
2312 CloseHandle(ov.hEvent);
2319 CloseHandle(ov.hEvent);
2322 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2331 static CharDriverState *qemu_chr_open_pipe(const char *id,
2332 ChardevBackend *backend,
2336 ChardevHostdev *opts = backend->u.pipe.data;
2337 const char *filename = opts->device;
2338 CharDriverState *chr;
2340 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
2342 chr = qemu_chr_alloc(common, errp);
2346 s = g_new0(WinCharState, 1);
2348 chr->chr_write = win_chr_write;
2349 chr->chr_close = win_chr_close;
2351 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2353 qemu_chr_free_common(chr);
2359 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out,
2360 ChardevCommon *backend,
2363 CharDriverState *chr;
2366 chr = qemu_chr_alloc(backend, errp);
2370 s = g_new0(WinCharState, 1);
2373 chr->chr_write = win_chr_write;
2377 static CharDriverState *qemu_chr_open_win_con(const char *id,
2378 ChardevBackend *backend,
2382 ChardevCommon *common = backend->u.console.data;
2383 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE),
2387 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2389 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2396 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2406 static void win_stdio_wait_func(void *opaque)
2408 CharDriverState *chr = opaque;
2409 WinStdioCharState *stdio = chr->opaque;
2410 INPUT_RECORD buf[4];
2415 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2418 /* Avoid error storm */
2419 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2423 for (i = 0; i < dwSize; i++) {
2424 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2426 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2428 if (kev->uChar.AsciiChar != 0) {
2429 for (j = 0; j < kev->wRepeatCount; j++) {
2430 if (qemu_chr_be_can_write(chr)) {
2431 uint8_t c = kev->uChar.AsciiChar;
2432 qemu_chr_be_write(chr, &c, 1);
2440 static DWORD WINAPI win_stdio_thread(LPVOID param)
2442 CharDriverState *chr = param;
2443 WinStdioCharState *stdio = chr->opaque;
2449 /* Wait for one byte */
2450 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2452 /* Exit in case of error, continue if nothing read */
2460 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2461 if (stdio->win_stdio_buf == '\r') {
2465 /* Signal the main thread and wait until the byte was eaten */
2466 if (!SetEvent(stdio->hInputReadyEvent)) {
2469 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2475 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2479 static void win_stdio_thread_wait_func(void *opaque)
2481 CharDriverState *chr = opaque;
2482 WinStdioCharState *stdio = chr->opaque;
2484 if (qemu_chr_be_can_write(chr)) {
2485 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2488 SetEvent(stdio->hInputDoneEvent);
2491 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2493 WinStdioCharState *stdio = chr->opaque;
2496 GetConsoleMode(stdio->hStdIn, &dwMode);
2499 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2501 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2505 static void win_stdio_close(CharDriverState *chr)
2507 WinStdioCharState *stdio = chr->opaque;
2509 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2510 CloseHandle(stdio->hInputReadyEvent);
2512 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2513 CloseHandle(stdio->hInputDoneEvent);
2515 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2516 TerminateThread(stdio->hInputThread, 0);
2519 g_free(chr->opaque);
2522 static CharDriverState *qemu_chr_open_stdio(const char *id,
2523 ChardevBackend *backend,
2527 CharDriverState *chr;
2528 WinStdioCharState *stdio;
2531 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio.data);
2533 chr = qemu_chr_alloc(common, errp);
2537 stdio = g_new0(WinStdioCharState, 1);
2539 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2540 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2541 error_setg(errp, "cannot open stdio: invalid handle");
2545 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2547 chr->opaque = stdio;
2548 chr->chr_write = win_stdio_write;
2549 chr->chr_close = win_stdio_close;
2552 if (qemu_add_wait_object(stdio->hStdIn,
2553 win_stdio_wait_func, chr)) {
2554 error_setg(errp, "qemu_add_wait_object: failed");
2560 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2561 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2562 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2563 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2564 error_setg(errp, "cannot create event");
2567 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2568 win_stdio_thread_wait_func, chr)) {
2569 error_setg(errp, "qemu_add_wait_object: failed");
2572 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2575 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2576 error_setg(errp, "cannot create stdio thread");
2581 dwMode |= ENABLE_LINE_INPUT;
2584 /* set the terminal in raw mode */
2585 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2586 dwMode |= ENABLE_PROCESSED_INPUT;
2589 SetConsoleMode(stdio->hStdIn, dwMode);
2591 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2592 qemu_chr_set_echo_win_stdio(chr, false);
2597 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2599 CloseHandle(stdio->hInputReadyEvent);
2600 CloseHandle(stdio->hInputDoneEvent);
2602 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2605 #endif /* !_WIN32 */
2607 /***********************************************************/
2608 /* UDP Net console */
2612 uint8_t buf[READ_BUF_LEN];
2618 /* Called with chr_write_lock held. */
2619 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2621 NetCharDriver *s = chr->opaque;
2623 return qio_channel_write(
2624 s->ioc, (const char *)buf, len, NULL);
2627 static int udp_chr_read_poll(void *opaque)
2629 CharDriverState *chr = opaque;
2630 NetCharDriver *s = chr->opaque;
2632 s->max_size = qemu_chr_be_can_write(chr);
2634 /* If there were any stray characters in the queue process them
2637 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2638 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2640 s->max_size = qemu_chr_be_can_write(chr);
2645 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2647 CharDriverState *chr = opaque;
2648 NetCharDriver *s = chr->opaque;
2651 if (s->max_size == 0) {
2654 ret = qio_channel_read(
2655 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2657 remove_fd_in_watch(chr);
2663 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2664 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2666 s->max_size = qemu_chr_be_can_write(chr);
2672 static void udp_chr_update_read_handler(CharDriverState *chr,
2673 GMainContext *context,
2676 NetCharDriver *s = chr->opaque;
2678 remove_fd_in_watch(chr);
2680 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2687 static void udp_chr_close(CharDriverState *chr)
2689 NetCharDriver *s = chr->opaque;
2691 remove_fd_in_watch(chr);
2693 object_unref(OBJECT(s->ioc));
2696 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2699 static CharDriverState *qemu_chr_open_udp(QIOChannelSocket *sioc,
2700 ChardevCommon *backend,
2703 CharDriverState *chr = NULL;
2704 NetCharDriver *s = NULL;
2706 chr = qemu_chr_alloc(backend, errp);
2710 s = g_new0(NetCharDriver, 1);
2712 s->ioc = QIO_CHANNEL(sioc);
2716 chr->chr_write = udp_chr_write;
2717 chr->chr_update_read_handler = udp_chr_update_read_handler;
2718 chr->chr_close = udp_chr_close;
2719 /* be isn't opened until we get a connection */
2720 chr->explicit_be_open = true;
2724 /***********************************************************/
2725 /* TCP Net console */
2728 QIOChannel *ioc; /* Client I/O channel */
2729 QIOChannelSocket *sioc; /* Client master channel */
2730 QIOChannelSocket *listen_ioc;
2732 QCryptoTLSCreds *tls_creds;
2739 size_t read_msgfds_num;
2741 size_t write_msgfds_num;
2743 SocketAddress *addr;
2747 guint reconnect_timer;
2748 int64_t reconnect_time;
2749 bool connect_err_reported;
2752 static gboolean socket_reconnect_timeout(gpointer opaque);
2754 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2756 TCPCharDriver *s = chr->opaque;
2757 assert(s->connected == 0);
2758 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2759 socket_reconnect_timeout, chr);
2762 static void check_report_connect_error(CharDriverState *chr,
2765 TCPCharDriver *s = chr->opaque;
2767 if (!s->connect_err_reported) {
2768 error_report("Unable to connect character device %s: %s",
2769 chr->label, error_get_pretty(err));
2770 s->connect_err_reported = true;
2772 qemu_chr_socket_restart_timer(chr);
2775 static gboolean tcp_chr_accept(QIOChannel *chan,
2779 /* Called with chr_write_lock held. */
2780 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2782 TCPCharDriver *s = chr->opaque;
2784 int ret = io_channel_send_full(s->ioc, buf, len,
2786 s->write_msgfds_num);
2788 /* free the written msgfds, no matter what */
2789 if (s->write_msgfds_num) {
2790 g_free(s->write_msgfds);
2791 s->write_msgfds = 0;
2792 s->write_msgfds_num = 0;
2797 /* XXX: indicate an error ? */
2802 static int tcp_chr_read_poll(void *opaque)
2804 CharDriverState *chr = opaque;
2805 TCPCharDriver *s = chr->opaque;
2808 s->max_size = qemu_chr_be_can_write(chr);
2813 #define IAC_BREAK 243
2814 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2816 uint8_t *buf, int *size)
2818 /* Handle any telnet client's basic IAC options to satisfy char by
2819 * char mode with no echo. All IAC options will be removed from
2820 * the buf and the do_telnetopt variable will be used to track the
2821 * state of the width of the IAC information.
2823 * IAC commands come in sets of 3 bytes with the exception of the
2824 * "IAC BREAK" command and the double IAC.
2830 for (i = 0; i < *size; i++) {
2831 if (s->do_telnetopt > 1) {
2832 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2833 /* Double IAC means send an IAC */
2837 s->do_telnetopt = 1;
2839 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2840 /* Handle IAC break commands by sending a serial break */
2841 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2846 if (s->do_telnetopt >= 4) {
2847 s->do_telnetopt = 1;
2850 if ((unsigned char)buf[i] == IAC) {
2851 s->do_telnetopt = 2;
2862 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2864 TCPCharDriver *s = chr->opaque;
2865 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2867 assert(num <= TCP_MAX_FDS);
2872 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2874 /* Close unused fds */
2875 for (i = to_copy; i < s->read_msgfds_num; i++) {
2876 close(s->read_msgfds[i]);
2879 g_free(s->read_msgfds);
2881 s->read_msgfds_num = 0;
2887 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2889 TCPCharDriver *s = chr->opaque;
2891 /* clear old pending fd array */
2892 g_free(s->write_msgfds);
2893 s->write_msgfds = NULL;
2894 s->write_msgfds_num = 0;
2896 if (!s->connected ||
2897 !qio_channel_has_feature(s->ioc,
2898 QIO_CHANNEL_FEATURE_FD_PASS)) {
2903 s->write_msgfds = g_new(int, num);
2904 memcpy(s->write_msgfds, fds, num * sizeof(int));
2907 s->write_msgfds_num = num;
2912 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2914 TCPCharDriver *s = chr->opaque;
2915 struct iovec iov = { .iov_base = buf, .iov_len = len };
2919 size_t msgfds_num = 0;
2921 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2922 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2923 &msgfds, &msgfds_num,
2926 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2931 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2934 } else if (ret == -1) {
2939 /* close and clean read_msgfds */
2940 for (i = 0; i < s->read_msgfds_num; i++) {
2941 close(s->read_msgfds[i]);
2944 if (s->read_msgfds_num) {
2945 g_free(s->read_msgfds);
2948 s->read_msgfds = msgfds;
2949 s->read_msgfds_num = msgfds_num;
2952 for (i = 0; i < s->read_msgfds_num; i++) {
2953 int fd = s->read_msgfds[i];
2958 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2961 #ifndef MSG_CMSG_CLOEXEC
2962 qemu_set_cloexec(fd);
2969 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2971 TCPCharDriver *s = chr->opaque;
2972 return qio_channel_create_watch(s->ioc, cond);
2975 static void tcp_chr_free_connection(CharDriverState *chr)
2977 TCPCharDriver *s = chr->opaque;
2980 if (!s->connected) {
2984 if (s->read_msgfds_num) {
2985 for (i = 0; i < s->read_msgfds_num; i++) {
2986 close(s->read_msgfds[i]);
2988 g_free(s->read_msgfds);
2989 s->read_msgfds = NULL;
2990 s->read_msgfds_num = 0;
2993 tcp_set_msgfds(chr, NULL, 0);
2994 remove_fd_in_watch(chr);
2995 object_unref(OBJECT(s->sioc));
2997 object_unref(OBJECT(s->ioc));
2999 g_free(chr->filename);
3000 chr->filename = NULL;
3004 static void tcp_chr_disconnect(CharDriverState *chr)
3006 TCPCharDriver *s = chr->opaque;
3008 if (!s->connected) {
3012 tcp_chr_free_connection(chr);
3014 if (s->listen_ioc) {
3015 s->listen_tag = qio_channel_add_watch(
3016 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
3018 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
3019 s->is_listen, s->is_telnet);
3020 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3021 if (s->reconnect_time) {
3022 qemu_chr_socket_restart_timer(chr);
3026 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
3028 CharDriverState *chr = opaque;
3029 TCPCharDriver *s = chr->opaque;
3030 uint8_t buf[READ_BUF_LEN];
3033 if (!s->connected || s->max_size <= 0) {
3037 if (len > s->max_size)
3039 size = tcp_chr_recv(chr, (void *)buf, len);
3040 if (size == 0 || size == -1) {
3041 /* connection closed */
3042 tcp_chr_disconnect(chr);
3043 } else if (size > 0) {
3044 if (s->do_telnetopt)
3045 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
3047 qemu_chr_be_write(chr, buf, size);
3053 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
3055 TCPCharDriver *s = chr->opaque;
3058 if (!s->connected) {
3062 size = tcp_chr_recv(chr, (void *) buf, len);
3064 /* connection closed */
3065 tcp_chr_disconnect(chr);
3071 static void tcp_chr_connect(void *opaque)
3073 CharDriverState *chr = opaque;
3074 TCPCharDriver *s = chr->opaque;
3076 g_free(chr->filename);
3077 chr->filename = sockaddr_to_str(
3078 &s->sioc->localAddr, s->sioc->localAddrLen,
3079 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
3080 s->is_listen, s->is_telnet);
3084 chr->fd_in_tag = io_add_watch_poll(s->ioc,
3089 qemu_chr_be_generic_open(chr);
3092 static void tcp_chr_update_read_handler(CharDriverState *chr,
3093 GMainContext *context,
3096 TCPCharDriver *s = chr->opaque;
3098 if (!s->connected) {
3102 remove_fd_in_watch(chr);
3104 chr->fd_in_tag = io_add_watch_poll(s->ioc,
3112 CharDriverState *chr;
3115 } TCPCharDriverTelnetInit;
3117 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
3118 GIOCondition cond G_GNUC_UNUSED,
3121 TCPCharDriverTelnetInit *init = user_data;
3124 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
3126 if (ret == QIO_CHANNEL_ERR_BLOCK) {
3129 tcp_chr_disconnect(init->chr);
3133 init->buflen -= ret;
3135 if (init->buflen == 0) {
3136 tcp_chr_connect(init->chr);
3140 memmove(init->buf, init->buf + ret, init->buflen);
3145 static void tcp_chr_telnet_init(CharDriverState *chr)
3147 TCPCharDriver *s = chr->opaque;
3148 TCPCharDriverTelnetInit *init =
3149 g_new0(TCPCharDriverTelnetInit, 1);
3155 #define IACSET(x, a, b, c) \
3162 /* Prep the telnet negotion to put telnet in binary,
3163 * no echo, single char mode */
3164 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3165 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3166 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3167 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3171 qio_channel_add_watch(
3173 tcp_chr_telnet_init_io,
3178 static void tcp_chr_tls_handshake(Object *source,
3182 CharDriverState *chr = user_data;
3183 TCPCharDriver *s = chr->opaque;
3186 tcp_chr_disconnect(chr);
3188 if (s->do_telnetopt) {
3189 tcp_chr_telnet_init(chr);
3191 tcp_chr_connect(chr);
3197 static void tcp_chr_tls_init(CharDriverState *chr)
3199 TCPCharDriver *s = chr->opaque;
3200 QIOChannelTLS *tioc;
3204 tioc = qio_channel_tls_new_server(
3205 s->ioc, s->tls_creds,
3206 NULL, /* XXX Use an ACL */
3209 tioc = qio_channel_tls_new_client(
3210 s->ioc, s->tls_creds,
3211 s->addr->u.inet.data->host,
3216 tcp_chr_disconnect(chr);
3219 object_unref(OBJECT(s->ioc));
3220 s->ioc = QIO_CHANNEL(tioc);
3222 qio_channel_tls_handshake(tioc,
3223 tcp_chr_tls_handshake,
3229 static int tcp_chr_new_client(CharDriverState *chr, QIOChannelSocket *sioc)
3231 TCPCharDriver *s = chr->opaque;
3232 if (s->ioc != NULL) {
3236 s->ioc = QIO_CHANNEL(sioc);
3237 object_ref(OBJECT(sioc));
3239 object_ref(OBJECT(sioc));
3241 qio_channel_set_blocking(s->ioc, false, NULL);
3243 if (s->do_nodelay) {
3244 qio_channel_set_delay(s->ioc, false);
3246 if (s->listen_tag) {
3247 g_source_remove(s->listen_tag);
3252 tcp_chr_tls_init(chr);
3254 if (s->do_telnetopt) {
3255 tcp_chr_telnet_init(chr);
3257 tcp_chr_connect(chr);
3265 static int tcp_chr_add_client(CharDriverState *chr, int fd)
3268 QIOChannelSocket *sioc;
3270 sioc = qio_channel_socket_new_fd(fd, NULL);
3274 ret = tcp_chr_new_client(chr, sioc);
3275 object_unref(OBJECT(sioc));
3279 static gboolean tcp_chr_accept(QIOChannel *channel,
3283 CharDriverState *chr = opaque;
3284 QIOChannelSocket *sioc;
3286 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3292 tcp_chr_new_client(chr, sioc);
3294 object_unref(OBJECT(sioc));
3299 static int tcp_chr_wait_connected(CharDriverState *chr, Error **errp)
3301 TCPCharDriver *s = chr->opaque;
3302 QIOChannelSocket *sioc;
3304 /* It can't wait on s->connected, since it is set asynchronously
3305 * in TLS and telnet cases, only wait for an accepted socket */
3308 fprintf(stderr, "QEMU waiting for connection on: %s\n",
3310 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), true, NULL);
3311 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
3312 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
3314 sioc = qio_channel_socket_new();
3315 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
3316 object_unref(OBJECT(sioc));
3319 tcp_chr_new_client(chr, sioc);
3320 object_unref(OBJECT(sioc));
3327 static int qemu_chr_wait_connected(CharDriverState *chr, Error **errp)
3329 if (chr->chr_wait_connected) {
3330 return chr->chr_wait_connected(chr, errp);
3336 int qemu_chr_fe_wait_connected(CharBackend *be, Error **errp)
3338 return qemu_chr_wait_connected(be->chr, errp);
3341 static void tcp_chr_close(CharDriverState *chr)
3343 TCPCharDriver *s = chr->opaque;
3345 tcp_chr_free_connection(chr);
3347 if (s->reconnect_timer) {
3348 g_source_remove(s->reconnect_timer);
3349 s->reconnect_timer = 0;
3351 qapi_free_SocketAddress(s->addr);
3352 if (s->listen_tag) {
3353 g_source_remove(s->listen_tag);
3356 if (s->listen_ioc) {
3357 object_unref(OBJECT(s->listen_ioc));
3360 object_unref(OBJECT(s->tls_creds));
3363 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3367 static void qemu_chr_socket_connected(Object *src, Error *err, void *opaque)
3369 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(src);
3370 CharDriverState *chr = opaque;
3371 TCPCharDriver *s = chr->opaque;
3374 check_report_connect_error(chr, err);
3379 s->connect_err_reported = false;
3380 tcp_chr_new_client(chr, sioc);
3381 object_unref(OBJECT(sioc));
3385 /*********************************************************/
3386 /* Ring buffer chardev */
3393 } RingBufCharDriver;
3395 static size_t ringbuf_count(const CharDriverState *chr)
3397 const RingBufCharDriver *d = chr->opaque;
3399 return d->prod - d->cons;
3402 /* Called with chr_write_lock held. */
3403 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3405 RingBufCharDriver *d = chr->opaque;
3408 if (!buf || (len < 0)) {
3412 for (i = 0; i < len; i++ ) {
3413 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3414 if (d->prod - d->cons > d->size) {
3415 d->cons = d->prod - d->size;
3422 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3424 RingBufCharDriver *d = chr->opaque;
3427 qemu_mutex_lock(&chr->chr_write_lock);
3428 for (i = 0; i < len && d->cons != d->prod; i++) {
3429 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3431 qemu_mutex_unlock(&chr->chr_write_lock);
3436 static void ringbuf_chr_close(struct CharDriverState *chr)
3438 RingBufCharDriver *d = chr->opaque;
3445 static CharDriverState *qemu_chr_open_ringbuf(const char *id,
3446 ChardevBackend *backend,
3450 ChardevRingbuf *opts = backend->u.ringbuf.data;
3451 ChardevCommon *common = qapi_ChardevRingbuf_base(opts);
3452 CharDriverState *chr;
3453 RingBufCharDriver *d;
3455 chr = qemu_chr_alloc(common, errp);
3459 d = g_malloc(sizeof(*d));
3461 d->size = opts->has_size ? opts->size : 65536;
3463 /* The size must be power of 2 */
3464 if (d->size & (d->size - 1)) {
3465 error_setg(errp, "size of ringbuf chardev must be power of two");
3471 d->cbuf = g_malloc0(d->size);
3474 chr->chr_write = ringbuf_chr_write;
3475 chr->chr_close = ringbuf_chr_close;
3481 qemu_chr_free_common(chr);
3485 bool chr_is_ringbuf(const CharDriverState *chr)
3487 return chr->chr_write == ringbuf_chr_write;
3490 void qmp_ringbuf_write(const char *device, const char *data,
3491 bool has_format, enum DataFormat format,
3494 CharDriverState *chr;
3495 const uint8_t *write_data;
3499 chr = qemu_chr_find(device);
3501 error_setg(errp, "Device '%s' not found", device);
3505 if (!chr_is_ringbuf(chr)) {
3506 error_setg(errp,"%s is not a ringbuf device", device);
3510 if (has_format && (format == DATA_FORMAT_BASE64)) {
3511 write_data = qbase64_decode(data, -1,
3518 write_data = (uint8_t *)data;
3519 write_count = strlen(data);
3522 ret = ringbuf_chr_write(chr, write_data, write_count);
3524 if (write_data != (uint8_t *)data) {
3525 g_free((void *)write_data);
3529 error_setg(errp, "Failed to write to device %s", device);
3534 char *qmp_ringbuf_read(const char *device, int64_t size,
3535 bool has_format, enum DataFormat format,
3538 CharDriverState *chr;
3543 chr = qemu_chr_find(device);
3545 error_setg(errp, "Device '%s' not found", device);
3549 if (!chr_is_ringbuf(chr)) {
3550 error_setg(errp,"%s is not a ringbuf device", device);
3555 error_setg(errp, "size must be greater than zero");
3559 count = ringbuf_count(chr);
3560 size = size > count ? count : size;
3561 read_data = g_malloc(size + 1);
3563 ringbuf_chr_read(chr, read_data, size);
3565 if (has_format && (format == DATA_FORMAT_BASE64)) {
3566 data = g_base64_encode(read_data, size);
3570 * FIXME should read only complete, valid UTF-8 characters up
3571 * to @size bytes. Invalid sequences should be replaced by a
3572 * suitable replacement character. Except when (and only
3573 * when) ring buffer lost characters since last read, initial
3574 * continuation characters should be dropped.
3576 read_data[size] = 0;
3577 data = (char *)read_data;
3583 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3585 char host[65], port[33], width[8], height[8];
3589 Error *local_err = NULL;
3591 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3593 error_report_err(local_err);
3597 if (strstart(filename, "mon:", &p)) {
3599 qemu_opt_set(opts, "mux", "on", &error_abort);
3600 if (strcmp(filename, "stdio") == 0) {
3601 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3602 * but pass it to the guest. Handle this only for compat syntax,
3603 * for -chardev syntax we have special option for this.
3604 * This is what -nographic did, redirecting+muxing serial+monitor
3605 * to stdio causing Ctrl+C to be passed to guest. */
3606 qemu_opt_set(opts, "signal", "off", &error_abort);
3610 if (strcmp(filename, "null") == 0 ||
3611 strcmp(filename, "pty") == 0 ||
3612 strcmp(filename, "msmouse") == 0 ||
3613 strcmp(filename, "braille") == 0 ||
3614 strcmp(filename, "testdev") == 0 ||
3615 strcmp(filename, "stdio") == 0) {
3616 qemu_opt_set(opts, "backend", filename, &error_abort);
3619 if (strstart(filename, "vc", &p)) {
3620 qemu_opt_set(opts, "backend", "vc", &error_abort);
3622 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3624 qemu_opt_set(opts, "width", width, &error_abort);
3625 qemu_opt_set(opts, "height", height, &error_abort);
3626 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3628 qemu_opt_set(opts, "cols", width, &error_abort);
3629 qemu_opt_set(opts, "rows", height, &error_abort);
3636 if (strcmp(filename, "con:") == 0) {
3637 qemu_opt_set(opts, "backend", "console", &error_abort);
3640 if (strstart(filename, "COM", NULL)) {
3641 qemu_opt_set(opts, "backend", "serial", &error_abort);
3642 qemu_opt_set(opts, "path", filename, &error_abort);
3645 if (strstart(filename, "file:", &p)) {
3646 qemu_opt_set(opts, "backend", "file", &error_abort);
3647 qemu_opt_set(opts, "path", p, &error_abort);
3650 if (strstart(filename, "pipe:", &p)) {
3651 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3652 qemu_opt_set(opts, "path", p, &error_abort);
3655 if (strstart(filename, "tcp:", &p) ||
3656 strstart(filename, "telnet:", &p)) {
3657 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3659 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3662 qemu_opt_set(opts, "backend", "socket", &error_abort);
3663 qemu_opt_set(opts, "host", host, &error_abort);
3664 qemu_opt_set(opts, "port", port, &error_abort);
3665 if (p[pos] == ',') {
3666 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3668 error_report_err(local_err);
3672 if (strstart(filename, "telnet:", &p))
3673 qemu_opt_set(opts, "telnet", "on", &error_abort);
3676 if (strstart(filename, "udp:", &p)) {
3677 qemu_opt_set(opts, "backend", "udp", &error_abort);
3678 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3680 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3684 qemu_opt_set(opts, "host", host, &error_abort);
3685 qemu_opt_set(opts, "port", port, &error_abort);
3686 if (p[pos] == '@') {
3688 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3690 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3694 qemu_opt_set(opts, "localaddr", host, &error_abort);
3695 qemu_opt_set(opts, "localport", port, &error_abort);
3699 if (strstart(filename, "unix:", &p)) {
3700 qemu_opt_set(opts, "backend", "socket", &error_abort);
3701 qemu_opts_do_parse(opts, p, "path", &local_err);
3703 error_report_err(local_err);
3708 if (strstart(filename, "/dev/parport", NULL) ||
3709 strstart(filename, "/dev/ppi", NULL)) {
3710 qemu_opt_set(opts, "backend", "parport", &error_abort);
3711 qemu_opt_set(opts, "path", filename, &error_abort);
3714 if (strstart(filename, "/dev/", NULL)) {
3715 qemu_opt_set(opts, "backend", "tty", &error_abort);
3716 qemu_opt_set(opts, "path", filename, &error_abort);
3721 qemu_opts_del(opts);
3725 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3727 const char *logfile = qemu_opt_get(opts, "logfile");
3729 backend->has_logfile = logfile != NULL;
3730 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3732 backend->has_logappend = true;
3733 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3737 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3740 const char *path = qemu_opt_get(opts, "path");
3744 error_setg(errp, "chardev: file: no filename given");
3747 file = backend->u.file.data = g_new0(ChardevFile, 1);
3748 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3749 file->out = g_strdup(path);
3751 file->has_append = true;
3752 file->append = qemu_opt_get_bool(opts, "append", false);
3755 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3758 ChardevStdio *stdio;
3760 stdio = backend->u.stdio.data = g_new0(ChardevStdio, 1);
3761 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3762 stdio->has_signal = true;
3763 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3766 #ifdef HAVE_CHARDEV_SERIAL
3767 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3770 const char *device = qemu_opt_get(opts, "path");
3771 ChardevHostdev *serial;
3773 if (device == NULL) {
3774 error_setg(errp, "chardev: serial/tty: no device path given");
3777 serial = backend->u.serial.data = g_new0(ChardevHostdev, 1);
3778 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3779 serial->device = g_strdup(device);
3783 #ifdef HAVE_CHARDEV_PARPORT
3784 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3787 const char *device = qemu_opt_get(opts, "path");
3788 ChardevHostdev *parallel;
3790 if (device == NULL) {
3791 error_setg(errp, "chardev: parallel: no device path given");
3794 parallel = backend->u.parallel.data = g_new0(ChardevHostdev, 1);
3795 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3796 parallel->device = g_strdup(device);
3800 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3803 const char *device = qemu_opt_get(opts, "path");
3804 ChardevHostdev *dev;
3806 if (device == NULL) {
3807 error_setg(errp, "chardev: pipe: no device path given");
3810 dev = backend->u.pipe.data = g_new0(ChardevHostdev, 1);
3811 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3812 dev->device = g_strdup(device);
3815 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3819 ChardevRingbuf *ringbuf;
3821 ringbuf = backend->u.ringbuf.data = g_new0(ChardevRingbuf, 1);
3822 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3824 val = qemu_opt_get_size(opts, "size", 0);
3826 ringbuf->has_size = true;
3827 ringbuf->size = val;
3831 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3834 const char *chardev = qemu_opt_get(opts, "chardev");
3837 if (chardev == NULL) {
3838 error_setg(errp, "chardev: mux: no chardev given");
3841 mux = backend->u.mux.data = g_new0(ChardevMux, 1);
3842 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
3843 mux->chardev = g_strdup(chardev);
3846 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3849 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3850 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3851 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3852 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3853 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3854 const char *path = qemu_opt_get(opts, "path");
3855 const char *host = qemu_opt_get(opts, "host");
3856 const char *port = qemu_opt_get(opts, "port");
3857 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
3858 SocketAddress *addr;
3859 ChardevSocket *sock;
3863 error_setg(errp, "chardev: socket: no host given");
3867 error_setg(errp, "chardev: socket: no port given");
3872 error_setg(errp, "TLS can only be used over TCP socket");
3877 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
3878 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
3880 sock->has_nodelay = true;
3881 sock->nodelay = do_nodelay;
3882 sock->has_server = true;
3883 sock->server = is_listen;
3884 sock->has_telnet = true;
3885 sock->telnet = is_telnet;
3886 sock->has_wait = true;
3887 sock->wait = is_waitconnect;
3888 sock->has_reconnect = true;
3889 sock->reconnect = reconnect;
3890 sock->tls_creds = g_strdup(tls_creds);
3892 addr = g_new0(SocketAddress, 1);
3894 UnixSocketAddress *q_unix;
3895 addr->type = SOCKET_ADDRESS_KIND_UNIX;
3896 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
3897 q_unix->path = g_strdup(path);
3899 addr->type = SOCKET_ADDRESS_KIND_INET;
3900 addr->u.inet.data = g_new(InetSocketAddress, 1);
3901 *addr->u.inet.data = (InetSocketAddress) {
3902 .host = g_strdup(host),
3903 .port = g_strdup(port),
3904 .has_to = qemu_opt_get(opts, "to"),
3905 .to = qemu_opt_get_number(opts, "to", 0),
3906 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3907 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3908 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3909 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3915 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3918 const char *host = qemu_opt_get(opts, "host");
3919 const char *port = qemu_opt_get(opts, "port");
3920 const char *localaddr = qemu_opt_get(opts, "localaddr");
3921 const char *localport = qemu_opt_get(opts, "localport");
3922 bool has_local = false;
3923 SocketAddress *addr;
3926 if (host == NULL || strlen(host) == 0) {
3929 if (port == NULL || strlen(port) == 0) {
3930 error_setg(errp, "chardev: udp: remote port not specified");
3933 if (localport == NULL || strlen(localport) == 0) {
3938 if (localaddr == NULL || strlen(localaddr) == 0) {
3944 udp = backend->u.udp.data = g_new0(ChardevUdp, 1);
3945 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
3947 addr = g_new0(SocketAddress, 1);
3948 addr->type = SOCKET_ADDRESS_KIND_INET;
3949 addr->u.inet.data = g_new(InetSocketAddress, 1);
3950 *addr->u.inet.data = (InetSocketAddress) {
3951 .host = g_strdup(host),
3952 .port = g_strdup(port),
3953 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3954 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3955 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3956 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3961 udp->has_local = true;
3962 addr = g_new0(SocketAddress, 1);
3963 addr->type = SOCKET_ADDRESS_KIND_INET;
3964 addr->u.inet.data = g_new(InetSocketAddress, 1);
3965 *addr->u.inet.data = (InetSocketAddress) {
3966 .host = g_strdup(localaddr),
3967 .port = g_strdup(localport),
3973 typedef struct CharDriver {
3975 ChardevBackendKind kind;
3976 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3977 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3978 ChardevReturn *ret, Error **errp);
3981 static GSList *backends;
3983 void register_char_driver(const char *name, ChardevBackendKind kind,
3984 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
3985 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3986 ChardevReturn *ret, Error **errp))
3990 s = g_malloc0(sizeof(*s));
3991 s->name = g_strdup(name);
3996 backends = g_slist_append(backends, s);
3999 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
4002 Error *local_err = NULL;
4004 CharDriverState *chr;
4006 ChardevReturn *ret = NULL;
4007 ChardevBackend *backend;
4008 const char *id = qemu_opts_id(opts);
4011 if (qemu_opt_get(opts, "backend") == NULL) {
4012 error_setg(errp, "chardev: \"%s\" missing backend",
4013 qemu_opts_id(opts));
4017 if (is_help_option(qemu_opt_get(opts, "backend"))) {
4018 fprintf(stderr, "Available chardev backend types:\n");
4019 for (i = backends; i; i = i->next) {
4021 fprintf(stderr, "%s\n", cd->name);
4023 exit(!is_help_option(qemu_opt_get(opts, "backend")));
4027 error_setg(errp, "chardev: no id specified");
4031 for (i = backends; i; i = i->next) {
4034 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
4039 error_setg(errp, "chardev: backend \"%s\" not found",
4040 qemu_opt_get(opts, "backend"));
4044 backend = g_new0(ChardevBackend, 1);
4046 if (qemu_opt_get_bool(opts, "mux", 0)) {
4047 bid = g_strdup_printf("%s-base", id);
4051 backend->type = cd->kind;
4053 cd->parse(opts, backend, &local_err);
4055 error_propagate(errp, local_err);
4059 ChardevCommon *cc = g_new0(ChardevCommon, 1);
4060 qemu_chr_parse_common(opts, cc);
4061 backend->u.null.data = cc; /* Any ChardevCommon member would work */
4064 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
4070 qapi_free_ChardevBackend(backend);
4071 qapi_free_ChardevReturn(ret);
4072 backend = g_new0(ChardevBackend, 1);
4073 backend->u.mux.data = g_new0(ChardevMux, 1);
4074 backend->type = CHARDEV_BACKEND_KIND_MUX;
4075 backend->u.mux.data->chardev = g_strdup(bid);
4076 ret = qmp_chardev_add(id, backend, errp);
4078 chr = qemu_chr_find(bid);
4079 qemu_chr_delete(chr);
4085 chr = qemu_chr_find(id);
4088 qapi_free_ChardevBackend(backend);
4089 qapi_free_ChardevReturn(ret);
4097 CharDriverState *qemu_chr_new_noreplay(const char *label, const char *filename)
4100 CharDriverState *chr;
4104 if (strstart(filename, "chardev:", &p)) {
4105 return qemu_chr_find(p);
4108 opts = qemu_chr_parse_compat(label, filename);
4112 chr = qemu_chr_new_from_opts(opts, &err);
4114 error_report_err(err);
4116 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
4117 qemu_chr_fe_claim_no_fail(chr);
4118 monitor_init(chr, MONITOR_USE_READLINE);
4120 qemu_opts_del(opts);
4124 CharDriverState *qemu_chr_new(const char *label, const char *filename)
4126 CharDriverState *chr;
4127 chr = qemu_chr_new_noreplay(label, filename);
4129 chr->replay = replay_mode != REPLAY_MODE_NONE;
4130 if (chr->replay && chr->chr_ioctl) {
4132 "Replay: ioctl is not supported for serial devices yet\n");
4134 replay_register_char_driver(chr);
4139 void qemu_chr_fe_set_echo(CharBackend *be, bool echo)
4141 CharDriverState *chr = be->chr;
4143 if (chr->chr_set_echo) {
4144 chr->chr_set_echo(chr, echo);
4148 void qemu_chr_fe_set_open(CharBackend *be, int fe_open)
4150 CharDriverState *chr = be->chr;
4152 if (chr->fe_open == fe_open) {
4155 chr->fe_open = fe_open;
4156 if (chr->chr_set_fe_open) {
4157 chr->chr_set_fe_open(chr, fe_open);
4161 void qemu_chr_fe_event(CharBackend *be, int event)
4163 CharDriverState *chr = be->chr;
4165 if (chr->chr_fe_event) {
4166 chr->chr_fe_event(chr, event);
4170 guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
4171 GIOFunc func, void *user_data)
4173 CharDriverState *s = be->chr;
4177 if (s->chr_add_watch == NULL) {
4181 src = s->chr_add_watch(s, cond);
4186 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
4187 tag = g_source_attach(src, NULL);
4188 g_source_unref(src);
4193 int qemu_chr_fe_claim(CharDriverState *s)
4195 if (s->avail_connections < 1) {
4198 s->avail_connections--;
4202 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
4204 if (qemu_chr_fe_claim(s) != 0) {
4205 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
4206 __func__, s->label);
4211 void qemu_chr_fe_release(CharDriverState *s)
4213 s->avail_connections++;
4216 void qemu_chr_fe_disconnect(CharBackend *be)
4218 CharDriverState *chr = be->chr;
4220 if (chr->chr_disconnect) {
4221 chr->chr_disconnect(chr);
4225 static void qemu_chr_free_common(CharDriverState *chr)
4227 g_free(chr->filename);
4229 if (chr->logfd != -1) {
4232 qemu_mutex_destroy(&chr->chr_write_lock);
4236 void qemu_chr_free(CharDriverState *chr)
4238 if (chr->chr_close) {
4239 chr->chr_close(chr);
4241 qemu_chr_free_common(chr);
4244 void qemu_chr_delete(CharDriverState *chr)
4246 QTAILQ_REMOVE(&chardevs, chr, next);
4250 ChardevInfoList *qmp_query_chardev(Error **errp)
4252 ChardevInfoList *chr_list = NULL;
4253 CharDriverState *chr;
4255 QTAILQ_FOREACH(chr, &chardevs, next) {
4256 ChardevInfoList *info = g_malloc0(sizeof(*info));
4257 info->value = g_malloc0(sizeof(*info->value));
4258 info->value->label = g_strdup(chr->label);
4259 info->value->filename = g_strdup(chr->filename);
4260 info->value->frontend_open = chr->fe_open;
4262 info->next = chr_list;
4269 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
4271 ChardevBackendInfoList *backend_list = NULL;
4272 CharDriver *c = NULL;
4275 for (i = backends; i; i = i->next) {
4276 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
4278 info->value = g_malloc0(sizeof(*info->value));
4279 info->value->name = g_strdup(c->name);
4281 info->next = backend_list;
4282 backend_list = info;
4285 return backend_list;
4288 CharDriverState *qemu_chr_find(const char *name)
4290 CharDriverState *chr;
4292 QTAILQ_FOREACH(chr, &chardevs, next) {
4293 if (strcmp(chr->label, name) != 0)
4300 QemuOptsList qemu_chardev_opts = {
4302 .implied_opt_name = "backend",
4303 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4307 .type = QEMU_OPT_STRING,
4310 .type = QEMU_OPT_STRING,
4313 .type = QEMU_OPT_STRING,
4316 .type = QEMU_OPT_STRING,
4318 .name = "localaddr",
4319 .type = QEMU_OPT_STRING,
4321 .name = "localport",
4322 .type = QEMU_OPT_STRING,
4325 .type = QEMU_OPT_NUMBER,
4328 .type = QEMU_OPT_BOOL,
4331 .type = QEMU_OPT_BOOL,
4334 .type = QEMU_OPT_BOOL,
4337 .type = QEMU_OPT_BOOL,
4340 .type = QEMU_OPT_BOOL,
4342 .name = "reconnect",
4343 .type = QEMU_OPT_NUMBER,
4346 .type = QEMU_OPT_BOOL,
4348 .name = "tls-creds",
4349 .type = QEMU_OPT_STRING,
4352 .type = QEMU_OPT_NUMBER,
4355 .type = QEMU_OPT_NUMBER,
4358 .type = QEMU_OPT_NUMBER,
4361 .type = QEMU_OPT_NUMBER,
4364 .type = QEMU_OPT_BOOL,
4367 .type = QEMU_OPT_BOOL,
4370 .type = QEMU_OPT_STRING,
4373 .type = QEMU_OPT_NUMBER,
4376 .type = QEMU_OPT_SIZE,
4379 .type = QEMU_OPT_STRING,
4382 .type = QEMU_OPT_BOOL,
4385 .type = QEMU_OPT_STRING,
4387 .name = "logappend",
4388 .type = QEMU_OPT_BOOL,
4390 { /* end of list */ }
4396 static CharDriverState *qmp_chardev_open_file(const char *id,
4397 ChardevBackend *backend,
4401 ChardevFile *file = backend->u.file.data;
4402 ChardevCommon *common = qapi_ChardevFile_base(file);
4408 error_setg(errp, "input file not supported");
4412 if (file->has_append && file->append) {
4413 /* Append to file if it already exists. */
4414 accessmode = FILE_GENERIC_WRITE & ~FILE_WRITE_DATA;
4415 flags = OPEN_ALWAYS;
4417 /* Truncate file if it already exists. */
4418 accessmode = GENERIC_WRITE;
4419 flags = CREATE_ALWAYS;
4422 out = CreateFile(file->out, accessmode, FILE_SHARE_READ, NULL, flags,
4423 FILE_ATTRIBUTE_NORMAL, NULL);
4424 if (out == INVALID_HANDLE_VALUE) {
4425 error_setg(errp, "open %s failed", file->out);
4428 return qemu_chr_open_win_file(out, common, errp);
4431 static CharDriverState *qmp_chardev_open_serial(const char *id,
4432 ChardevBackend *backend,
4436 ChardevHostdev *serial = backend->u.serial.data;
4437 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4438 return qemu_chr_open_win_path(serial->device, common, errp);
4443 static int qmp_chardev_open_file_source(char *src, int flags,
4448 TFR(fd = qemu_open(src, flags, 0666));
4450 error_setg_file_open(errp, errno, src);
4455 static CharDriverState *qmp_chardev_open_file(const char *id,
4456 ChardevBackend *backend,
4460 ChardevFile *file = backend->u.file.data;
4461 ChardevCommon *common = qapi_ChardevFile_base(file);
4462 int flags, in = -1, out;
4464 flags = O_WRONLY | O_CREAT | O_BINARY;
4465 if (file->has_append && file->append) {
4471 out = qmp_chardev_open_file_source(file->out, flags, errp);
4478 in = qmp_chardev_open_file_source(file->in, flags, errp);
4485 return qemu_chr_open_fd(in, out, common, errp);
4488 #ifdef HAVE_CHARDEV_SERIAL
4489 static CharDriverState *qmp_chardev_open_serial(const char *id,
4490 ChardevBackend *backend,
4494 ChardevHostdev *serial = backend->u.serial.data;
4495 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4498 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4502 qemu_set_nonblock(fd);
4503 return qemu_chr_open_tty_fd(fd, common, errp);
4507 #ifdef HAVE_CHARDEV_PARPORT
4508 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4509 ChardevBackend *backend,
4513 ChardevHostdev *parallel = backend->u.parallel.data;
4514 ChardevCommon *common = qapi_ChardevHostdev_base(parallel);
4517 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4521 return qemu_chr_open_pp_fd(fd, common, errp);
4527 static gboolean socket_reconnect_timeout(gpointer opaque)
4529 CharDriverState *chr = opaque;
4530 TCPCharDriver *s = chr->opaque;
4531 QIOChannelSocket *sioc;
4533 s->reconnect_timer = 0;
4539 sioc = qio_channel_socket_new();
4540 qio_channel_socket_connect_async(sioc, s->addr,
4541 qemu_chr_socket_connected,
4547 static CharDriverState *qmp_chardev_open_socket(const char *id,
4548 ChardevBackend *backend,
4552 CharDriverState *chr;
4554 ChardevSocket *sock = backend->u.socket.data;
4555 SocketAddress *addr = sock->addr;
4556 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4557 bool is_listen = sock->has_server ? sock->server : true;
4558 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4559 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4560 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4561 ChardevCommon *common = qapi_ChardevSocket_base(sock);
4562 QIOChannelSocket *sioc = NULL;
4564 chr = qemu_chr_alloc(common, errp);
4568 s = g_new0(TCPCharDriver, 1);
4570 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4571 s->is_listen = is_listen;
4572 s->is_telnet = is_telnet;
4573 s->do_nodelay = do_nodelay;
4574 if (sock->tls_creds) {
4576 creds = object_resolve_path_component(
4577 object_get_objects_root(), sock->tls_creds);
4579 error_setg(errp, "No TLS credentials with id '%s'",
4583 s->tls_creds = (QCryptoTLSCreds *)
4584 object_dynamic_cast(creds,
4585 TYPE_QCRYPTO_TLS_CREDS);
4586 if (!s->tls_creds) {
4587 error_setg(errp, "Object with id '%s' is not TLS credentials",
4591 object_ref(OBJECT(s->tls_creds));
4593 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4594 error_setg(errp, "%s",
4595 "Expected TLS credentials for server endpoint");
4599 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4600 error_setg(errp, "%s",
4601 "Expected TLS credentials for client endpoint");
4607 s->addr = QAPI_CLONE(SocketAddress, sock->addr);
4609 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
4611 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
4615 chr->chr_wait_connected = tcp_chr_wait_connected;
4616 chr->chr_write = tcp_chr_write;
4617 chr->chr_sync_read = tcp_chr_sync_read;
4618 chr->chr_close = tcp_chr_close;
4619 chr->chr_disconnect = tcp_chr_disconnect;
4620 chr->get_msgfds = tcp_get_msgfds;
4621 chr->set_msgfds = tcp_set_msgfds;
4622 chr->chr_add_client = tcp_chr_add_client;
4623 chr->chr_add_watch = tcp_chr_add_watch;
4624 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4625 /* be isn't opened until we get a connection */
4626 chr->explicit_be_open = true;
4628 chr->filename = SocketAddress_to_str("disconnected:",
4629 addr, is_listen, is_telnet);
4633 s->do_telnetopt = 1;
4635 } else if (reconnect > 0) {
4636 s->reconnect_time = reconnect;
4639 if (s->reconnect_time) {
4640 sioc = qio_channel_socket_new();
4641 qio_channel_socket_connect_async(sioc, s->addr,
4642 qemu_chr_socket_connected,
4646 sioc = qio_channel_socket_new();
4647 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4650 s->listen_ioc = sioc;
4651 if (is_waitconnect &&
4652 qemu_chr_wait_connected(chr, errp) < 0) {
4656 s->listen_tag = qio_channel_add_watch(
4657 QIO_CHANNEL(s->listen_ioc), G_IO_IN,
4658 tcp_chr_accept, chr, NULL);
4660 } else if (qemu_chr_wait_connected(chr, errp) < 0) {
4669 object_unref(OBJECT(sioc));
4672 object_unref(OBJECT(s->tls_creds));
4675 qemu_chr_free_common(chr);
4679 static CharDriverState *qmp_chardev_open_udp(const char *id,
4680 ChardevBackend *backend,
4684 ChardevUdp *udp = backend->u.udp.data;
4685 ChardevCommon *common = qapi_ChardevUdp_base(udp);
4686 QIOChannelSocket *sioc = qio_channel_socket_new();
4688 if (qio_channel_socket_dgram_sync(sioc,
4689 udp->local, udp->remote,
4691 object_unref(OBJECT(sioc));
4694 return qemu_chr_open_udp(sioc, common, errp);
4698 bool qemu_chr_has_feature(CharDriverState *chr,
4699 CharDriverFeature feature)
4701 return test_bit(feature, chr->features);
4704 void qemu_chr_set_feature(CharDriverState *chr,
4705 CharDriverFeature feature)
4707 return set_bit(feature, chr->features);
4710 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4713 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4714 CharDriverState *chr = NULL;
4715 Error *local_err = NULL;
4719 chr = qemu_chr_find(id);
4721 error_setg(errp, "Chardev '%s' already exists", id);
4726 for (i = backends; i; i = i->next) {
4729 if (cd->kind == backend->type) {
4730 chr = cd->create(id, backend, ret, &local_err);
4732 error_propagate(errp, local_err);
4741 error_setg(errp, "chardev backend not available");
4745 chr->label = g_strdup(id);
4746 chr->avail_connections =
4747 (backend->type == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4748 if (!chr->filename) {
4749 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4751 if (!chr->explicit_be_open) {
4752 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4754 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4762 void qmp_chardev_remove(const char *id, Error **errp)
4764 CharDriverState *chr;
4766 chr = qemu_chr_find(id);
4768 error_setg(errp, "Chardev '%s' not found", id);
4771 if (chr->chr_can_read || chr->chr_read ||
4772 chr->chr_event || chr->handler_opaque) {
4773 error_setg(errp, "Chardev '%s' is busy", id);
4778 "Chardev '%s' cannot be unplugged in record/replay mode", id);
4781 qemu_chr_delete(chr);
4784 void qemu_chr_cleanup(void)
4786 CharDriverState *chr, *tmp;
4788 QTAILQ_FOREACH_SAFE(chr, &chardevs, next, tmp) {
4789 qemu_chr_delete(chr);
4793 static void register_types(void)
4795 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4796 qemu_chr_open_null);
4797 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4798 qemu_chr_parse_socket, qmp_chardev_open_socket);
4799 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4800 qmp_chardev_open_udp);
4801 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4802 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4803 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4804 qemu_chr_parse_file_out, qmp_chardev_open_file);
4805 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4806 qemu_chr_parse_stdio, qemu_chr_open_stdio);
4807 #if defined HAVE_CHARDEV_SERIAL
4808 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4809 qemu_chr_parse_serial, qmp_chardev_open_serial);
4810 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4811 qemu_chr_parse_serial, qmp_chardev_open_serial);
4813 #ifdef HAVE_CHARDEV_PARPORT
4814 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4815 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4816 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4817 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4819 #ifdef HAVE_CHARDEV_PTY
4820 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4824 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4825 qemu_chr_open_win_con);
4827 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4828 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4829 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4831 /* Bug-compatibility: */
4832 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4833 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4834 /* this must be done after machine init, since we register FEs with muxes
4835 * as part of realize functions like serial_isa_realizefn when -nographic
4838 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4841 type_init(register_types);