baum: use a common prefix for chr callbacks
[qemu/ar7.git] / qemu-char.c
blob113c4a859e5a6eaf840c1dd6c38003603a4b6ffb
1 /*
2 * QEMU System Emulator
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
22 * THE SOFTWARE.
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"
33 #include "hw/usb.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"
44 #include <zlib.h>
46 #ifndef _WIN32
47 #include <sys/times.h>
48 #include <sys/wait.h>
49 #include <termios.h>
50 #include <sys/ioctl.h>
51 #include <sys/resource.h>
52 #include <sys/socket.h>
53 #include <netinet/in.h>
54 #include <net/if.h>
55 #include <arpa/inet.h>
56 #include <netdb.h>
57 #include <sys/select.h>
58 #ifdef CONFIG_BSD
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>
65 #endif
66 #else
67 #ifdef __linux__
68 #include <linux/ppdev.h>
69 #include <linux/parport.h>
70 #endif
71 #ifdef __sun__
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>
81 #endif
82 #endif
83 #endif
85 #include "qemu/sockets.h"
86 #include "ui/qemu-spice.h"
88 #define READ_BUF_LEN 4096
89 #define READ_RETRIES 10
90 #define TCP_MAX_FDS 16
92 typedef struct MuxChardev MuxChardev;
94 /***********************************************************/
95 /* Socket address helpers */
97 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
98 bool is_listen, bool is_telnet)
100 switch (addr->type) {
101 case SOCKET_ADDRESS_KIND_INET:
102 return g_strdup_printf("%s%s:%s:%s%s", prefix,
103 is_telnet ? "telnet" : "tcp",
104 addr->u.inet.data->host,
105 addr->u.inet.data->port,
106 is_listen ? ",server" : "");
107 break;
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" : "");
112 break;
113 case SOCKET_ADDRESS_KIND_FD:
114 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.data->str,
115 is_listen ? ",server" : "");
116 break;
117 default:
118 abort();
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) {
131 #ifndef _WIN32
132 case AF_UNIX:
133 return g_strdup_printf("unix:%s%s",
134 ((struct sockaddr_un *)(ss))->sun_path,
135 is_listen ? ",server" : "");
136 #endif
137 case AF_INET6:
138 left = "[";
139 right = "]";
140 /* fall through */
141 case AF_INET:
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);
152 default:
153 return g_strdup_printf("unknown");
157 /***********************************************************/
158 /* character device */
160 static QTAILQ_HEAD(ChardevHead, Chardev) chardevs =
161 QTAILQ_HEAD_INITIALIZER(chardevs);
163 static void qemu_chr_free_common(Chardev *chr);
165 Chardev *qemu_chr_alloc(const CharDriver *driver,
166 ChardevCommon *backend, Error **errp)
168 Chardev *chr;
170 assert(driver);
171 assert(driver->chr_write);
172 assert(driver->instance_size >= sizeof(Chardev));
174 chr = g_malloc0(driver->instance_size);
175 qemu_mutex_init(&chr->chr_write_lock);
176 if (backend->has_logfile) {
177 int flags = O_WRONLY | O_CREAT;
178 if (backend->has_logappend &&
179 backend->logappend) {
180 flags |= O_APPEND;
181 } else {
182 flags |= O_TRUNC;
184 chr->logfd = qemu_open(backend->logfile, flags, 0666);
185 if (chr->logfd < 0) {
186 error_setg_errno(errp, errno,
187 "Unable to open logfile %s",
188 backend->logfile);
189 g_free(chr);
190 return NULL;
192 } else {
193 chr->logfd = -1;
195 chr->driver = driver;
197 return chr;
200 void qemu_chr_be_event(Chardev *s, int event)
202 CharBackend *be = s->be;
204 /* Keep track if the char device is open */
205 switch (event) {
206 case CHR_EVENT_OPENED:
207 s->be_open = 1;
208 break;
209 case CHR_EVENT_CLOSED:
210 s->be_open = 0;
211 break;
214 if (!be || !be->chr_event) {
215 return;
218 be->chr_event(be->opaque, event);
221 void qemu_chr_be_generic_open(Chardev *s)
223 qemu_chr_be_event(s, CHR_EVENT_OPENED);
227 /* Not reporting errors from writing to logfile, as logs are
228 * defined to be "best effort" only */
229 static void qemu_chr_fe_write_log(Chardev *s,
230 const uint8_t *buf, size_t len)
232 size_t done = 0;
233 ssize_t ret;
235 if (s->logfd < 0) {
236 return;
239 while (done < len) {
240 retry:
241 ret = write(s->logfd, buf + done, len - done);
242 if (ret == -1 && errno == EAGAIN) {
243 g_usleep(100);
244 goto retry;
247 if (ret <= 0) {
248 return;
250 done += ret;
254 static int qemu_chr_fe_write_buffer(Chardev *s,
255 const uint8_t *buf, int len, int *offset)
257 int res = 0;
258 *offset = 0;
260 qemu_mutex_lock(&s->chr_write_lock);
261 while (*offset < len) {
262 retry:
263 res = s->driver->chr_write(s, buf + *offset, len - *offset);
264 if (res < 0 && errno == EAGAIN) {
265 g_usleep(100);
266 goto retry;
269 if (res <= 0) {
270 break;
273 *offset += res;
275 if (*offset > 0) {
276 qemu_chr_fe_write_log(s, buf, *offset);
278 qemu_mutex_unlock(&s->chr_write_lock);
280 return res;
283 static bool qemu_chr_replay(Chardev *chr)
285 return qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_REPLAY);
288 int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len)
290 Chardev *s = be->chr;
291 int ret;
293 if (!s) {
294 return 0;
297 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
298 int offset;
299 replay_char_write_event_load(&ret, &offset);
300 assert(offset <= len);
301 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
302 return ret;
305 qemu_mutex_lock(&s->chr_write_lock);
306 ret = s->driver->chr_write(s, buf, len);
308 if (ret > 0) {
309 qemu_chr_fe_write_log(s, buf, ret);
312 qemu_mutex_unlock(&s->chr_write_lock);
314 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
315 replay_char_write_event_save(ret, ret < 0 ? 0 : ret);
318 return ret;
321 static int qemu_chr_write_all(Chardev *s, const uint8_t *buf, int len)
323 int offset;
324 int res;
326 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
327 replay_char_write_event_load(&res, &offset);
328 assert(offset <= len);
329 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
330 return res;
333 res = qemu_chr_fe_write_buffer(s, buf, len, &offset);
335 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
336 replay_char_write_event_save(res, offset);
339 if (res < 0) {
340 return res;
342 return offset;
345 int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len)
347 Chardev *s = be->chr;
349 if (!s) {
350 return 0;
353 return qemu_chr_write_all(s, buf, len);
356 int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len)
358 Chardev *s = be->chr;
359 int offset = 0, counter = 10;
360 int res;
362 if (!s || !s->driver->chr_sync_read) {
363 return 0;
366 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
367 return replay_char_read_all_load(buf);
370 while (offset < len) {
371 retry:
372 res = s->driver->chr_sync_read(s, buf + offset, len - offset);
373 if (res == -1 && errno == EAGAIN) {
374 g_usleep(100);
375 goto retry;
378 if (res == 0) {
379 break;
382 if (res < 0) {
383 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
384 replay_char_read_all_save_error(res);
386 return res;
389 offset += res;
391 if (!counter--) {
392 break;
396 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
397 replay_char_read_all_save_buf(buf, offset);
399 return offset;
402 int qemu_chr_fe_ioctl(CharBackend *be, int cmd, void *arg)
404 Chardev *s = be->chr;
405 int res;
407 if (!s || !s->driver->chr_ioctl || qemu_chr_replay(s)) {
408 res = -ENOTSUP;
409 } else {
410 res = s->driver->chr_ioctl(s, cmd, arg);
413 return res;
416 int qemu_chr_be_can_write(Chardev *s)
418 CharBackend *be = s->be;
420 if (!be || !be->chr_can_read) {
421 return 0;
424 return be->chr_can_read(be->opaque);
427 void qemu_chr_be_write_impl(Chardev *s, uint8_t *buf, int len)
429 CharBackend *be = s->be;
431 if (be && be->chr_read) {
432 be->chr_read(be->opaque, buf, len);
436 void qemu_chr_be_write(Chardev *s, uint8_t *buf, int len)
438 if (qemu_chr_replay(s)) {
439 if (replay_mode == REPLAY_MODE_PLAY) {
440 return;
442 replay_chr_be_write(s, buf, len);
443 } else {
444 qemu_chr_be_write_impl(s, buf, len);
448 int qemu_chr_fe_get_msgfd(CharBackend *be)
450 Chardev *s = be->chr;
451 int fd;
452 int res = (qemu_chr_fe_get_msgfds(be, &fd, 1) == 1) ? fd : -1;
453 if (s && qemu_chr_replay(s)) {
454 error_report("Replay: get msgfd is not supported "
455 "for serial devices yet");
456 exit(1);
458 return res;
461 int qemu_chr_fe_get_msgfds(CharBackend *be, int *fds, int len)
463 Chardev *s = be->chr;
465 if (!s) {
466 return -1;
469 return s->driver->get_msgfds ? s->driver->get_msgfds(s, fds, len) : -1;
472 int qemu_chr_fe_set_msgfds(CharBackend *be, int *fds, int num)
474 Chardev *s = be->chr;
476 if (!s) {
477 return -1;
480 return s->driver->set_msgfds ? s->driver->set_msgfds(s, fds, num) : -1;
483 int qemu_chr_add_client(Chardev *s, int fd)
485 return s->driver->chr_add_client ? s->driver->chr_add_client(s, fd) : -1;
488 void qemu_chr_fe_accept_input(CharBackend *be)
490 Chardev *s = be->chr;
492 if (!s) {
493 return;
496 if (s->driver->chr_accept_input) {
497 s->driver->chr_accept_input(s);
499 qemu_notify_event();
502 void qemu_chr_fe_printf(CharBackend *be, const char *fmt, ...)
504 char buf[READ_BUF_LEN];
505 va_list ap;
506 va_start(ap, fmt);
507 vsnprintf(buf, sizeof(buf), fmt, ap);
508 /* XXX this blocks entire thread. Rewrite to use
509 * qemu_chr_fe_write and background I/O callbacks */
510 qemu_chr_fe_write_all(be, (uint8_t *)buf, strlen(buf));
511 va_end(ap);
514 static void remove_fd_in_watch(Chardev *chr);
515 static void mux_chr_set_handlers(Chardev *chr, GMainContext *context);
516 static void mux_set_focus(Chardev *chr, int focus);
518 static int null_chr_write(Chardev *chr, const uint8_t *buf, int len)
520 return len;
523 static Chardev *qemu_chr_open_null(const CharDriver *driver,
524 const char *id,
525 ChardevBackend *backend,
526 ChardevReturn *ret,
527 bool *be_opened,
528 Error **errp)
530 Chardev *chr;
531 ChardevCommon *common = backend->u.null.data;
533 chr = qemu_chr_alloc(driver, common, errp);
534 if (!chr) {
535 return NULL;
537 *be_opened = false;
538 return chr;
541 static const CharDriver null_driver = {
542 .instance_size = sizeof(Chardev),
543 .kind = CHARDEV_BACKEND_KIND_NULL,
544 .create = qemu_chr_open_null,
545 .chr_write = null_chr_write,
548 /* MUX driver for serial I/O splitting */
549 #define MAX_MUX 4
550 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
551 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
552 struct MuxChardev {
553 Chardev parent;
554 CharBackend *backends[MAX_MUX];
555 CharBackend chr;
556 int focus;
557 int mux_cnt;
558 int term_got_escape;
559 int max_size;
560 /* Intermediate input buffer allows to catch escape sequences even if the
561 currently active device is not accepting any input - but only until it
562 is full as well. */
563 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
564 int prod[MAX_MUX];
565 int cons[MAX_MUX];
566 int timestamps;
568 /* Protected by the Chardev chr_write_lock. */
569 int linestart;
570 int64_t timestamps_start;
573 /* Called with chr_write_lock held. */
574 static int mux_chr_write(Chardev *chr, const uint8_t *buf, int len)
576 MuxChardev *d = (MuxChardev *)chr;
577 int ret;
578 if (!d->timestamps) {
579 ret = qemu_chr_fe_write(&d->chr, buf, len);
580 } else {
581 int i;
583 ret = 0;
584 for (i = 0; i < len; i++) {
585 if (d->linestart) {
586 char buf1[64];
587 int64_t ti;
588 int secs;
590 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
591 if (d->timestamps_start == -1)
592 d->timestamps_start = ti;
593 ti -= d->timestamps_start;
594 secs = ti / 1000;
595 snprintf(buf1, sizeof(buf1),
596 "[%02d:%02d:%02d.%03d] ",
597 secs / 3600,
598 (secs / 60) % 60,
599 secs % 60,
600 (int)(ti % 1000));
601 /* XXX this blocks entire thread. Rewrite to use
602 * qemu_chr_fe_write and background I/O callbacks */
603 qemu_chr_fe_write_all(&d->chr,
604 (uint8_t *)buf1, strlen(buf1));
605 d->linestart = 0;
607 ret += qemu_chr_fe_write(&d->chr, buf + i, 1);
608 if (buf[i] == '\n') {
609 d->linestart = 1;
613 return ret;
616 static const char * const mux_help[] = {
617 "% h print this help\n\r",
618 "% x exit emulator\n\r",
619 "% s save disk data back to file (if -snapshot)\n\r",
620 "% t toggle console timestamps\n\r",
621 "% b send break (magic sysrq)\n\r",
622 "% c switch between console and monitor\n\r",
623 "% % sends %\n\r",
624 NULL
627 int term_escape_char = 0x01; /* ctrl-a is used for escape */
628 static void mux_print_help(Chardev *chr)
630 int i, j;
631 char ebuf[15] = "Escape-Char";
632 char cbuf[50] = "\n\r";
634 if (term_escape_char > 0 && term_escape_char < 26) {
635 snprintf(cbuf, sizeof(cbuf), "\n\r");
636 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
637 } else {
638 snprintf(cbuf, sizeof(cbuf),
639 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
640 term_escape_char);
642 /* XXX this blocks entire thread. Rewrite to use
643 * qemu_chr_fe_write and background I/O callbacks */
644 qemu_chr_write_all(chr, (uint8_t *)cbuf, strlen(cbuf));
645 for (i = 0; mux_help[i] != NULL; i++) {
646 for (j=0; mux_help[i][j] != '\0'; j++) {
647 if (mux_help[i][j] == '%')
648 qemu_chr_write_all(chr, (uint8_t *)ebuf, strlen(ebuf));
649 else
650 qemu_chr_write_all(chr, (uint8_t *)&mux_help[i][j], 1);
655 static void mux_chr_send_event(MuxChardev *d, int mux_nr, int event)
657 CharBackend *be = d->backends[mux_nr];
659 if (be && be->chr_event) {
660 be->chr_event(be->opaque, event);
664 static int mux_proc_byte(Chardev *chr, MuxChardev *d, int ch)
666 if (d->term_got_escape) {
667 d->term_got_escape = 0;
668 if (ch == term_escape_char)
669 goto send_char;
670 switch(ch) {
671 case '?':
672 case 'h':
673 mux_print_help(chr);
674 break;
675 case 'x':
677 const char *term = "QEMU: Terminated\n\r";
678 qemu_chr_write_all(chr, (uint8_t *)term, strlen(term));
679 exit(0);
680 break;
682 case 's':
683 blk_commit_all();
684 break;
685 case 'b':
686 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
687 break;
688 case 'c':
689 assert(d->mux_cnt > 0); /* handler registered with first fe */
690 /* Switch to the next registered device */
691 mux_set_focus(chr, (d->focus + 1) % d->mux_cnt);
692 break;
693 case 't':
694 d->timestamps = !d->timestamps;
695 d->timestamps_start = -1;
696 d->linestart = 0;
697 break;
699 } else if (ch == term_escape_char) {
700 d->term_got_escape = 1;
701 } else {
702 send_char:
703 return 1;
705 return 0;
708 static void mux_chr_accept_input(Chardev *chr)
710 MuxChardev *d = (MuxChardev *)chr;
711 int m = d->focus;
712 CharBackend *be = d->backends[m];
714 while (be && d->prod[m] != d->cons[m] &&
715 be->chr_can_read && be->chr_can_read(be->opaque)) {
716 be->chr_read(be->opaque,
717 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
721 static int mux_chr_can_read(void *opaque)
723 MuxChardev *d = opaque;
724 int m = d->focus;
725 CharBackend *be = d->backends[m];
727 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE) {
728 return 1;
731 if (be && be->chr_can_read) {
732 return be->chr_can_read(be->opaque);
735 return 0;
738 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
740 Chardev *chr = opaque;
741 MuxChardev *d = opaque;
742 int m = d->focus;
743 CharBackend *be = d->backends[m];
744 int i;
746 mux_chr_accept_input(opaque);
748 for (i = 0; i < size; i++)
749 if (mux_proc_byte(chr, d, buf[i])) {
750 if (d->prod[m] == d->cons[m] &&
751 be && be->chr_can_read &&
752 be->chr_can_read(be->opaque))
753 be->chr_read(be->opaque, &buf[i], 1);
754 else
755 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
759 static bool muxes_realized;
761 static void mux_chr_event(void *opaque, int event)
763 MuxChardev *d = opaque;
764 int i;
766 if (!muxes_realized) {
767 return;
770 /* Send the event to all registered listeners */
771 for (i = 0; i < d->mux_cnt; i++)
772 mux_chr_send_event(d, i, event);
776 * Called after processing of default and command-line-specified
777 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
778 * to a mux chardev. This is done here to ensure that
779 * output/prompts/banners are only displayed for the FE that has
780 * focus when initial command-line processing/machine init is
781 * completed.
783 * After this point, any new FE attached to any new or existing
784 * mux will receive CHR_EVENT_OPENED notifications for the BE
785 * immediately.
787 static void muxes_realize_done(Notifier *notifier, void *unused)
789 Chardev *chr;
791 QTAILQ_FOREACH(chr, &chardevs, next) {
792 if (qemu_chr_get_kind(chr) == CHARDEV_BACKEND_KIND_MUX) {
793 MuxChardev *d = (MuxChardev *)chr;
794 int i;
796 /* send OPENED to all already-attached FEs */
797 for (i = 0; i < d->mux_cnt; i++) {
798 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
800 /* mark mux as OPENED so any new FEs will immediately receive
801 * OPENED event
803 qemu_chr_be_generic_open(chr);
806 muxes_realized = true;
809 static Notifier muxes_realize_notify = {
810 .notify = muxes_realize_done,
813 static GSource *mux_chr_add_watch(Chardev *s, GIOCondition cond)
815 MuxChardev *d = (MuxChardev *)s;
816 Chardev *chr = qemu_chr_fe_get_driver(&d->chr);
818 if (!chr->driver->chr_add_watch) {
819 return NULL;
822 return chr->driver->chr_add_watch(chr, cond);
825 static void mux_chr_free(struct Chardev *chr)
827 MuxChardev *d = (MuxChardev *)chr;
828 int i;
830 for (i = 0; i < d->mux_cnt; i++) {
831 CharBackend *be = d->backends[i];
832 if (be) {
833 be->chr = NULL;
836 qemu_chr_fe_deinit(&d->chr);
839 static void mux_chr_set_handlers(Chardev *chr, GMainContext *context)
841 MuxChardev *d = (MuxChardev *)chr;
843 /* Fix up the real driver with mux routines */
844 qemu_chr_fe_set_handlers(&d->chr,
845 mux_chr_can_read,
846 mux_chr_read,
847 mux_chr_event,
848 chr,
849 context, true);
852 static void mux_set_focus(Chardev *chr, int focus)
854 MuxChardev *d = (MuxChardev *)chr;
856 assert(focus >= 0);
857 assert(focus < d->mux_cnt);
859 if (d->focus != -1) {
860 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
863 d->focus = focus;
864 chr->be = d->backends[focus];
865 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
868 static Chardev *qemu_chr_open_mux(const CharDriver *driver,
869 const char *id,
870 ChardevBackend *backend,
871 ChardevReturn *ret,
872 bool *be_opened,
873 Error **errp)
875 ChardevMux *mux = backend->u.mux.data;
876 Chardev *chr, *drv;
877 MuxChardev *d;
878 ChardevCommon *common = qapi_ChardevMux_base(mux);
880 drv = qemu_chr_find(mux->chardev);
881 if (drv == NULL) {
882 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
883 return NULL;
886 chr = qemu_chr_alloc(driver, common, errp);
887 if (!chr) {
888 return NULL;
890 d = (MuxChardev *)chr;
891 d->focus = -1;
892 /* only default to opened state if we've realized the initial
893 * set of muxes
895 *be_opened = muxes_realized;
896 if (!qemu_chr_fe_init(&d->chr, drv, errp)) {
897 qemu_chr_free(chr);
898 return NULL;
901 return chr;
904 Chardev *qemu_chr_fe_get_driver(CharBackend *be)
906 return be->chr;
909 bool qemu_chr_fe_init(CharBackend *b, Chardev *s, Error **errp)
911 int tag = 0;
913 if (qemu_chr_get_kind(s) == CHARDEV_BACKEND_KIND_MUX) {
914 MuxChardev *d = (MuxChardev *)s;
916 if (d->mux_cnt >= MAX_MUX) {
917 goto unavailable;
920 d->backends[d->mux_cnt] = b;
921 tag = d->mux_cnt++;
922 } else if (s->be) {
923 goto unavailable;
924 } else {
925 s->be = b;
928 b->fe_open = false;
929 b->tag = tag;
930 b->chr = s;
931 return true;
933 unavailable:
934 error_setg(errp, QERR_DEVICE_IN_USE, s->label);
935 return false;
938 static bool qemu_chr_is_busy(Chardev *s)
940 if (qemu_chr_get_kind(s) == CHARDEV_BACKEND_KIND_MUX) {
941 MuxChardev *d = (MuxChardev *)s;
942 return d->mux_cnt >= 0;
943 } else {
944 return s->be != NULL;
948 void qemu_chr_fe_deinit(CharBackend *b)
950 assert(b);
952 if (b->chr) {
953 qemu_chr_fe_set_handlers(b, NULL, NULL, NULL, NULL, NULL, true);
954 if (b->chr->be == b) {
955 b->chr->be = NULL;
957 if (qemu_chr_get_kind(b->chr) == CHARDEV_BACKEND_KIND_MUX) {
958 MuxChardev *d = (MuxChardev *)b->chr;
959 d->backends[b->tag] = NULL;
961 b->chr = NULL;
965 void qemu_chr_fe_set_handlers(CharBackend *b,
966 IOCanReadHandler *fd_can_read,
967 IOReadHandler *fd_read,
968 IOEventHandler *fd_event,
969 void *opaque,
970 GMainContext *context,
971 bool set_open)
973 Chardev *s;
974 int fe_open;
976 s = b->chr;
977 if (!s) {
978 return;
981 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
982 fe_open = 0;
983 remove_fd_in_watch(s);
984 } else {
985 fe_open = 1;
987 b->chr_can_read = fd_can_read;
988 b->chr_read = fd_read;
989 b->chr_event = fd_event;
990 b->opaque = opaque;
991 if (s->driver->chr_update_read_handler) {
992 s->driver->chr_update_read_handler(s, context);
995 if (set_open) {
996 qemu_chr_fe_set_open(b, fe_open);
999 if (fe_open) {
1000 qemu_chr_fe_take_focus(b);
1001 /* We're connecting to an already opened device, so let's make sure we
1002 also get the open event */
1003 if (s->be_open) {
1004 qemu_chr_be_generic_open(s);
1008 if (qemu_chr_get_kind(s) == CHARDEV_BACKEND_KIND_MUX) {
1009 mux_chr_set_handlers(s, context);
1013 void qemu_chr_fe_take_focus(CharBackend *b)
1015 if (!b->chr) {
1016 return;
1019 if (qemu_chr_get_kind(b->chr) == CHARDEV_BACKEND_KIND_MUX) {
1020 mux_set_focus(b->chr, b->tag);
1024 typedef struct IOWatchPoll
1026 GSource parent;
1028 QIOChannel *ioc;
1029 GSource *src;
1031 IOCanReadHandler *fd_can_read;
1032 GSourceFunc fd_read;
1033 void *opaque;
1034 GMainContext *context;
1035 } IOWatchPoll;
1037 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
1039 return container_of(source, IOWatchPoll, parent);
1042 static gboolean io_watch_poll_prepare(GSource *source,
1043 gint *timeout_)
1045 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1046 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
1047 bool was_active = iwp->src != NULL;
1048 if (was_active == now_active) {
1049 return FALSE;
1052 if (now_active) {
1053 iwp->src = qio_channel_create_watch(
1054 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
1055 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
1056 g_source_attach(iwp->src, iwp->context);
1057 } else {
1058 g_source_destroy(iwp->src);
1059 g_source_unref(iwp->src);
1060 iwp->src = NULL;
1062 return FALSE;
1065 static gboolean io_watch_poll_check(GSource *source)
1067 return FALSE;
1070 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
1071 gpointer user_data)
1073 abort();
1076 static void io_watch_poll_finalize(GSource *source)
1078 /* Due to a glib bug, removing the last reference to a source
1079 * inside a finalize callback causes recursive locking (and a
1080 * deadlock). This is not a problem inside other callbacks,
1081 * including dispatch callbacks, so we call io_remove_watch_poll
1082 * to remove this source. At this point, iwp->src must
1083 * be NULL, or we would leak it.
1085 * This would be solved much more elegantly by child sources,
1086 * but we support older glib versions that do not have them.
1088 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1089 assert(iwp->src == NULL);
1092 static GSourceFuncs io_watch_poll_funcs = {
1093 .prepare = io_watch_poll_prepare,
1094 .check = io_watch_poll_check,
1095 .dispatch = io_watch_poll_dispatch,
1096 .finalize = io_watch_poll_finalize,
1099 /* Can only be used for read */
1100 static guint io_add_watch_poll(Chardev *chr,
1101 QIOChannel *ioc,
1102 IOCanReadHandler *fd_can_read,
1103 QIOChannelFunc fd_read,
1104 gpointer user_data,
1105 GMainContext *context)
1107 IOWatchPoll *iwp;
1108 int tag;
1109 char *name;
1111 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs,
1112 sizeof(IOWatchPoll));
1113 iwp->fd_can_read = fd_can_read;
1114 iwp->opaque = user_data;
1115 iwp->ioc = ioc;
1116 iwp->fd_read = (GSourceFunc) fd_read;
1117 iwp->src = NULL;
1118 iwp->context = context;
1120 name = g_strdup_printf("chardev-iowatch-%s", chr->label);
1121 g_source_set_name((GSource *)iwp, name);
1122 g_free(name);
1124 tag = g_source_attach(&iwp->parent, context);
1125 g_source_unref(&iwp->parent);
1126 return tag;
1129 static void io_remove_watch_poll(guint tag)
1131 GSource *source;
1132 IOWatchPoll *iwp;
1134 g_return_if_fail (tag > 0);
1136 source = g_main_context_find_source_by_id(NULL, tag);
1137 g_return_if_fail (source != NULL);
1139 iwp = io_watch_poll_from_source(source);
1140 if (iwp->src) {
1141 g_source_destroy(iwp->src);
1142 g_source_unref(iwp->src);
1143 iwp->src = NULL;
1145 g_source_destroy(&iwp->parent);
1148 static void remove_fd_in_watch(Chardev *chr)
1150 if (chr->fd_in_tag) {
1151 io_remove_watch_poll(chr->fd_in_tag);
1152 chr->fd_in_tag = 0;
1157 static int io_channel_send_full(QIOChannel *ioc,
1158 const void *buf, size_t len,
1159 int *fds, size_t nfds)
1161 size_t offset = 0;
1163 while (offset < len) {
1164 ssize_t ret = 0;
1165 struct iovec iov = { .iov_base = (char *)buf + offset,
1166 .iov_len = len - offset };
1168 ret = qio_channel_writev_full(
1169 ioc, &iov, 1,
1170 fds, nfds, NULL);
1171 if (ret == QIO_CHANNEL_ERR_BLOCK) {
1172 if (offset) {
1173 return offset;
1176 errno = EAGAIN;
1177 return -1;
1178 } else if (ret < 0) {
1179 errno = EINVAL;
1180 return -1;
1183 offset += ret;
1186 return offset;
1190 #ifndef _WIN32
1191 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
1193 return io_channel_send_full(ioc, buf, len, NULL, 0);
1197 typedef struct FDChardev {
1198 Chardev parent;
1199 Chardev *chr;
1200 QIOChannel *ioc_in, *ioc_out;
1201 int max_size;
1202 } FDChardev;
1204 /* Called with chr_write_lock held. */
1205 static int fd_chr_write(Chardev *chr, const uint8_t *buf, int len)
1207 FDChardev *s = (FDChardev *)chr;
1209 return io_channel_send(s->ioc_out, buf, len);
1212 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1214 Chardev *chr = opaque;
1215 FDChardev *s = opaque;
1216 int len;
1217 uint8_t buf[READ_BUF_LEN];
1218 ssize_t ret;
1220 len = sizeof(buf);
1221 if (len > s->max_size) {
1222 len = s->max_size;
1224 if (len == 0) {
1225 return TRUE;
1228 ret = qio_channel_read(
1229 chan, (gchar *)buf, len, NULL);
1230 if (ret == 0) {
1231 remove_fd_in_watch(chr);
1232 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1233 return FALSE;
1235 if (ret > 0) {
1236 qemu_chr_be_write(chr, buf, ret);
1239 return TRUE;
1242 static int fd_chr_read_poll(void *opaque)
1244 Chardev *chr = opaque;
1245 FDChardev *s = opaque;
1247 s->max_size = qemu_chr_be_can_write(chr);
1248 return s->max_size;
1251 static GSource *fd_chr_add_watch(Chardev *chr, GIOCondition cond)
1253 FDChardev *s = (FDChardev *)chr;
1254 return qio_channel_create_watch(s->ioc_out, cond);
1257 static void fd_chr_update_read_handler(Chardev *chr,
1258 GMainContext *context)
1260 FDChardev *s = (FDChardev *)chr;
1262 remove_fd_in_watch(chr);
1263 if (s->ioc_in) {
1264 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc_in,
1265 fd_chr_read_poll,
1266 fd_chr_read, chr,
1267 context);
1271 static void fd_chr_free(struct Chardev *chr)
1273 FDChardev *s = (FDChardev *)chr;
1275 remove_fd_in_watch(chr);
1276 if (s->ioc_in) {
1277 object_unref(OBJECT(s->ioc_in));
1279 if (s->ioc_out) {
1280 object_unref(OBJECT(s->ioc_out));
1283 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1286 /* open a character device to a unix fd */
1287 static Chardev *qemu_chr_open_fd(const CharDriver *driver,
1288 int fd_in, int fd_out,
1289 ChardevCommon *backend, Error **errp)
1291 Chardev *chr;
1292 FDChardev *s;
1293 char *name;
1295 chr = qemu_chr_alloc(driver, backend, errp);
1296 if (!chr) {
1297 return NULL;
1299 s = (FDChardev *)chr;
1300 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1301 name = g_strdup_printf("chardev-file-in-%s", chr->label);
1302 qio_channel_set_name(QIO_CHANNEL(s->ioc_in), name);
1303 g_free(name);
1304 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1305 name = g_strdup_printf("chardev-file-out-%s", chr->label);
1306 qio_channel_set_name(QIO_CHANNEL(s->ioc_out), name);
1307 g_free(name);
1308 qemu_set_nonblock(fd_out);
1309 s->chr = chr;
1311 return chr;
1314 static Chardev *qemu_chr_open_pipe(const CharDriver *driver,
1315 const char *id,
1316 ChardevBackend *backend,
1317 ChardevReturn *ret,
1318 bool *be_opened,
1319 Error **errp)
1321 ChardevHostdev *opts = backend->u.pipe.data;
1322 int fd_in, fd_out;
1323 char *filename_in;
1324 char *filename_out;
1325 const char *filename = opts->device;
1326 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
1329 filename_in = g_strdup_printf("%s.in", filename);
1330 filename_out = g_strdup_printf("%s.out", filename);
1331 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1332 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1333 g_free(filename_in);
1334 g_free(filename_out);
1335 if (fd_in < 0 || fd_out < 0) {
1336 if (fd_in >= 0)
1337 close(fd_in);
1338 if (fd_out >= 0)
1339 close(fd_out);
1340 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1341 if (fd_in < 0) {
1342 error_setg_file_open(errp, errno, filename);
1343 return NULL;
1346 return qemu_chr_open_fd(driver, fd_in, fd_out, common, errp);
1349 /* init terminal so that we can grab keys */
1350 static struct termios oldtty;
1351 static int old_fd0_flags;
1352 static bool stdio_in_use;
1353 static bool stdio_allow_signal;
1354 static bool stdio_echo_state;
1356 static void qemu_chr_set_echo_stdio(Chardev *chr, bool echo);
1358 static void term_exit(void)
1360 tcsetattr (0, TCSANOW, &oldtty);
1361 fcntl(0, F_SETFL, old_fd0_flags);
1364 static void term_stdio_handler(int sig)
1366 /* restore echo after resume from suspend. */
1367 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1370 static void qemu_chr_set_echo_stdio(Chardev *chr, bool echo)
1372 struct termios tty;
1374 stdio_echo_state = echo;
1375 tty = oldtty;
1376 if (!echo) {
1377 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1378 |INLCR|IGNCR|ICRNL|IXON);
1379 tty.c_oflag |= OPOST;
1380 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1381 tty.c_cflag &= ~(CSIZE|PARENB);
1382 tty.c_cflag |= CS8;
1383 tty.c_cc[VMIN] = 1;
1384 tty.c_cc[VTIME] = 0;
1386 if (!stdio_allow_signal)
1387 tty.c_lflag &= ~ISIG;
1389 tcsetattr (0, TCSANOW, &tty);
1392 static void qemu_chr_free_stdio(struct Chardev *chr)
1394 term_exit();
1395 fd_chr_free(chr);
1398 static Chardev *qemu_chr_open_stdio(const CharDriver *driver,
1399 const char *id,
1400 ChardevBackend *backend,
1401 ChardevReturn *ret,
1402 bool *be_opened,
1403 Error **errp)
1405 ChardevStdio *opts = backend->u.stdio.data;
1406 Chardev *chr;
1407 struct sigaction act;
1408 ChardevCommon *common = qapi_ChardevStdio_base(opts);
1410 if (is_daemonized()) {
1411 error_setg(errp, "cannot use stdio with -daemonize");
1412 return NULL;
1415 if (stdio_in_use) {
1416 error_setg(errp, "cannot use stdio by multiple character devices");
1417 return NULL;
1420 stdio_in_use = true;
1421 old_fd0_flags = fcntl(0, F_GETFL);
1422 tcgetattr(0, &oldtty);
1423 qemu_set_nonblock(0);
1424 atexit(term_exit);
1426 memset(&act, 0, sizeof(act));
1427 act.sa_handler = term_stdio_handler;
1428 sigaction(SIGCONT, &act, NULL);
1430 chr = qemu_chr_open_fd(driver, 0, 1, common, errp);
1431 if (!chr) {
1432 return NULL;
1434 if (opts->has_signal) {
1435 stdio_allow_signal = opts->signal;
1437 qemu_chr_set_echo_stdio(chr, false);
1439 return chr;
1442 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1443 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1444 || defined(__GLIBC__)
1446 #define HAVE_CHARDEV_SERIAL 1
1447 #define HAVE_CHARDEV_PTY 1
1449 typedef struct {
1450 Chardev parent;
1451 QIOChannel *ioc;
1452 int read_bytes;
1454 /* Protected by the Chardev chr_write_lock. */
1455 int connected;
1456 guint timer_tag;
1457 guint open_tag;
1458 } PtyChardev;
1460 static void pty_chr_update_read_handler_locked(Chardev *chr);
1461 static void pty_chr_state(Chardev *chr, int connected);
1463 static gboolean pty_chr_timer(gpointer opaque)
1465 struct Chardev *chr = opaque;
1466 PtyChardev *s = opaque;
1468 qemu_mutex_lock(&chr->chr_write_lock);
1469 s->timer_tag = 0;
1470 s->open_tag = 0;
1471 if (!s->connected) {
1472 /* Next poll ... */
1473 pty_chr_update_read_handler_locked(chr);
1475 qemu_mutex_unlock(&chr->chr_write_lock);
1476 return FALSE;
1479 /* Called with chr_write_lock held. */
1480 static void pty_chr_rearm_timer(Chardev *chr, int ms)
1482 PtyChardev *s = (PtyChardev *)chr;
1483 char *name;
1485 if (s->timer_tag) {
1486 g_source_remove(s->timer_tag);
1487 s->timer_tag = 0;
1490 if (ms == 1000) {
1491 name = g_strdup_printf("pty-timer-secs-%s", chr->label);
1492 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1493 } else {
1494 name = g_strdup_printf("pty-timer-ms-%s", chr->label);
1495 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1497 g_source_set_name_by_id(s->timer_tag, name);
1498 g_free(name);
1501 /* Called with chr_write_lock held. */
1502 static void pty_chr_update_read_handler_locked(Chardev *chr)
1504 PtyChardev *s = (PtyChardev *)chr;
1505 GPollFD pfd;
1506 int rc;
1507 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1509 pfd.fd = fioc->fd;
1510 pfd.events = G_IO_OUT;
1511 pfd.revents = 0;
1512 do {
1513 rc = g_poll(&pfd, 1, 0);
1514 } while (rc == -1 && errno == EINTR);
1515 assert(rc >= 0);
1517 if (pfd.revents & G_IO_HUP) {
1518 pty_chr_state(chr, 0);
1519 } else {
1520 pty_chr_state(chr, 1);
1524 static void pty_chr_update_read_handler(Chardev *chr,
1525 GMainContext *context)
1527 qemu_mutex_lock(&chr->chr_write_lock);
1528 pty_chr_update_read_handler_locked(chr);
1529 qemu_mutex_unlock(&chr->chr_write_lock);
1532 /* Called with chr_write_lock held. */
1533 static int pty_chr_write(Chardev *chr, const uint8_t *buf, int len)
1535 PtyChardev *s = (PtyChardev *)chr;
1537 if (!s->connected) {
1538 /* guest sends data, check for (re-)connect */
1539 pty_chr_update_read_handler_locked(chr);
1540 if (!s->connected) {
1541 return 0;
1544 return io_channel_send(s->ioc, buf, len);
1547 static GSource *pty_chr_add_watch(Chardev *chr, GIOCondition cond)
1549 PtyChardev *s = (PtyChardev *)chr;
1550 if (!s->connected) {
1551 return NULL;
1553 return qio_channel_create_watch(s->ioc, cond);
1556 static int pty_chr_read_poll(void *opaque)
1558 Chardev *chr = opaque;
1559 PtyChardev *s = opaque;
1561 s->read_bytes = qemu_chr_be_can_write(chr);
1562 return s->read_bytes;
1565 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1567 Chardev *chr = opaque;
1568 PtyChardev *s = opaque;
1569 gsize len;
1570 uint8_t buf[READ_BUF_LEN];
1571 ssize_t ret;
1573 len = sizeof(buf);
1574 if (len > s->read_bytes)
1575 len = s->read_bytes;
1576 if (len == 0) {
1577 return TRUE;
1579 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1580 if (ret <= 0) {
1581 pty_chr_state(chr, 0);
1582 return FALSE;
1583 } else {
1584 pty_chr_state(chr, 1);
1585 qemu_chr_be_write(chr, buf, ret);
1587 return TRUE;
1590 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1592 Chardev *chr = opaque;
1593 PtyChardev *s = opaque;
1595 s->open_tag = 0;
1596 qemu_chr_be_generic_open(chr);
1597 return FALSE;
1600 /* Called with chr_write_lock held. */
1601 static void pty_chr_state(Chardev *chr, int connected)
1603 PtyChardev *s = (PtyChardev *)chr;
1605 if (!connected) {
1606 if (s->open_tag) {
1607 g_source_remove(s->open_tag);
1608 s->open_tag = 0;
1610 remove_fd_in_watch(chr);
1611 s->connected = 0;
1612 /* (re-)connect poll interval for idle guests: once per second.
1613 * We check more frequently in case the guests sends data to
1614 * the virtual device linked to our pty. */
1615 pty_chr_rearm_timer(chr, 1000);
1616 } else {
1617 if (s->timer_tag) {
1618 g_source_remove(s->timer_tag);
1619 s->timer_tag = 0;
1621 if (!s->connected) {
1622 g_assert(s->open_tag == 0);
1623 s->connected = 1;
1624 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1626 if (!chr->fd_in_tag) {
1627 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
1628 pty_chr_read_poll,
1629 pty_chr_read,
1630 chr, NULL);
1635 static void pty_chr_free(struct Chardev *chr)
1637 PtyChardev *s = (PtyChardev *)chr;
1639 qemu_mutex_lock(&chr->chr_write_lock);
1640 pty_chr_state(chr, 0);
1641 object_unref(OBJECT(s->ioc));
1642 if (s->timer_tag) {
1643 g_source_remove(s->timer_tag);
1644 s->timer_tag = 0;
1646 qemu_mutex_unlock(&chr->chr_write_lock);
1647 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1650 static Chardev *qemu_chr_open_pty(const CharDriver *driver,
1651 const char *id,
1652 ChardevBackend *backend,
1653 ChardevReturn *ret,
1654 bool *be_opened,
1655 Error **errp)
1657 Chardev *chr;
1658 PtyChardev *s;
1659 int master_fd, slave_fd;
1660 char pty_name[PATH_MAX];
1661 ChardevCommon *common = backend->u.pty.data;
1662 char *name;
1664 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1665 if (master_fd < 0) {
1666 error_setg_errno(errp, errno, "Failed to create PTY");
1667 return NULL;
1670 close(slave_fd);
1671 qemu_set_nonblock(master_fd);
1673 chr = qemu_chr_alloc(driver, common, errp);
1674 if (!chr) {
1675 close(master_fd);
1676 return NULL;
1679 chr->filename = g_strdup_printf("pty:%s", pty_name);
1680 ret->pty = g_strdup(pty_name);
1681 ret->has_pty = true;
1683 error_report("char device redirected to %s (label %s)",
1684 pty_name, id);
1686 s = (PtyChardev *)chr;
1687 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1688 name = g_strdup_printf("chardev-pty-%s", chr->label);
1689 qio_channel_set_name(QIO_CHANNEL(s->ioc), name);
1690 g_free(name);
1691 s->timer_tag = 0;
1692 *be_opened = false;
1694 return chr;
1697 static const CharDriver pty_driver = {
1698 .instance_size = sizeof(PtyChardev),
1699 .kind = CHARDEV_BACKEND_KIND_PTY,
1700 .create = qemu_chr_open_pty,
1701 .chr_write = pty_chr_write,
1702 .chr_update_read_handler = pty_chr_update_read_handler,
1703 .chr_add_watch = pty_chr_add_watch,
1704 .chr_free = pty_chr_free,
1707 static void tty_serial_init(int fd, int speed,
1708 int parity, int data_bits, int stop_bits)
1710 struct termios tty;
1711 speed_t spd;
1713 #if 0
1714 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1715 speed, parity, data_bits, stop_bits);
1716 #endif
1717 tcgetattr (fd, &tty);
1719 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1720 speed = speed * 10 / 11;
1721 do {
1722 check_speed(50);
1723 check_speed(75);
1724 check_speed(110);
1725 check_speed(134);
1726 check_speed(150);
1727 check_speed(200);
1728 check_speed(300);
1729 check_speed(600);
1730 check_speed(1200);
1731 check_speed(1800);
1732 check_speed(2400);
1733 check_speed(4800);
1734 check_speed(9600);
1735 check_speed(19200);
1736 check_speed(38400);
1737 /* Non-Posix values follow. They may be unsupported on some systems. */
1738 check_speed(57600);
1739 check_speed(115200);
1740 #ifdef B230400
1741 check_speed(230400);
1742 #endif
1743 #ifdef B460800
1744 check_speed(460800);
1745 #endif
1746 #ifdef B500000
1747 check_speed(500000);
1748 #endif
1749 #ifdef B576000
1750 check_speed(576000);
1751 #endif
1752 #ifdef B921600
1753 check_speed(921600);
1754 #endif
1755 #ifdef B1000000
1756 check_speed(1000000);
1757 #endif
1758 #ifdef B1152000
1759 check_speed(1152000);
1760 #endif
1761 #ifdef B1500000
1762 check_speed(1500000);
1763 #endif
1764 #ifdef B2000000
1765 check_speed(2000000);
1766 #endif
1767 #ifdef B2500000
1768 check_speed(2500000);
1769 #endif
1770 #ifdef B3000000
1771 check_speed(3000000);
1772 #endif
1773 #ifdef B3500000
1774 check_speed(3500000);
1775 #endif
1776 #ifdef B4000000
1777 check_speed(4000000);
1778 #endif
1779 spd = B115200;
1780 } while (0);
1782 cfsetispeed(&tty, spd);
1783 cfsetospeed(&tty, spd);
1785 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1786 |INLCR|IGNCR|ICRNL|IXON);
1787 tty.c_oflag |= OPOST;
1788 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1789 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1790 switch(data_bits) {
1791 default:
1792 case 8:
1793 tty.c_cflag |= CS8;
1794 break;
1795 case 7:
1796 tty.c_cflag |= CS7;
1797 break;
1798 case 6:
1799 tty.c_cflag |= CS6;
1800 break;
1801 case 5:
1802 tty.c_cflag |= CS5;
1803 break;
1805 switch(parity) {
1806 default:
1807 case 'N':
1808 break;
1809 case 'E':
1810 tty.c_cflag |= PARENB;
1811 break;
1812 case 'O':
1813 tty.c_cflag |= PARENB | PARODD;
1814 break;
1816 if (stop_bits == 2)
1817 tty.c_cflag |= CSTOPB;
1819 tcsetattr (fd, TCSANOW, &tty);
1822 static int tty_serial_ioctl(Chardev *chr, int cmd, void *arg)
1824 FDChardev *s = (FDChardev *)chr;
1825 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1827 switch(cmd) {
1828 case CHR_IOCTL_SERIAL_SET_PARAMS:
1830 QEMUSerialSetParams *ssp = arg;
1831 tty_serial_init(fioc->fd,
1832 ssp->speed, ssp->parity,
1833 ssp->data_bits, ssp->stop_bits);
1835 break;
1836 case CHR_IOCTL_SERIAL_SET_BREAK:
1838 int enable = *(int *)arg;
1839 if (enable) {
1840 tcsendbreak(fioc->fd, 1);
1843 break;
1844 case CHR_IOCTL_SERIAL_GET_TIOCM:
1846 int sarg = 0;
1847 int *targ = (int *)arg;
1848 ioctl(fioc->fd, TIOCMGET, &sarg);
1849 *targ = 0;
1850 if (sarg & TIOCM_CTS)
1851 *targ |= CHR_TIOCM_CTS;
1852 if (sarg & TIOCM_CAR)
1853 *targ |= CHR_TIOCM_CAR;
1854 if (sarg & TIOCM_DSR)
1855 *targ |= CHR_TIOCM_DSR;
1856 if (sarg & TIOCM_RI)
1857 *targ |= CHR_TIOCM_RI;
1858 if (sarg & TIOCM_DTR)
1859 *targ |= CHR_TIOCM_DTR;
1860 if (sarg & TIOCM_RTS)
1861 *targ |= CHR_TIOCM_RTS;
1863 break;
1864 case CHR_IOCTL_SERIAL_SET_TIOCM:
1866 int sarg = *(int *)arg;
1867 int targ = 0;
1868 ioctl(fioc->fd, TIOCMGET, &targ);
1869 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1870 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1871 if (sarg & CHR_TIOCM_CTS)
1872 targ |= TIOCM_CTS;
1873 if (sarg & CHR_TIOCM_CAR)
1874 targ |= TIOCM_CAR;
1875 if (sarg & CHR_TIOCM_DSR)
1876 targ |= TIOCM_DSR;
1877 if (sarg & CHR_TIOCM_RI)
1878 targ |= TIOCM_RI;
1879 if (sarg & CHR_TIOCM_DTR)
1880 targ |= TIOCM_DTR;
1881 if (sarg & CHR_TIOCM_RTS)
1882 targ |= TIOCM_RTS;
1883 ioctl(fioc->fd, TIOCMSET, &targ);
1885 break;
1886 default:
1887 return -ENOTSUP;
1889 return 0;
1892 static void qemu_chr_free_tty(Chardev *chr)
1894 fd_chr_free(chr);
1896 #endif /* __linux__ || __sun__ */
1898 #if defined(__linux__)
1900 #define HAVE_CHARDEV_PARPORT 1
1902 typedef struct {
1903 Chardev parent;
1904 int fd;
1905 int mode;
1906 } ParallelChardev;
1908 static int pp_hw_mode(ParallelChardev *s, uint16_t mode)
1910 if (s->mode != mode) {
1911 int m = mode;
1912 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1913 return 0;
1914 s->mode = mode;
1916 return 1;
1919 static int pp_ioctl(Chardev *chr, int cmd, void *arg)
1921 ParallelChardev *drv = (ParallelChardev *)chr;
1922 int fd = drv->fd;
1923 uint8_t b;
1925 switch(cmd) {
1926 case CHR_IOCTL_PP_READ_DATA:
1927 if (ioctl(fd, PPRDATA, &b) < 0)
1928 return -ENOTSUP;
1929 *(uint8_t *)arg = b;
1930 break;
1931 case CHR_IOCTL_PP_WRITE_DATA:
1932 b = *(uint8_t *)arg;
1933 if (ioctl(fd, PPWDATA, &b) < 0)
1934 return -ENOTSUP;
1935 break;
1936 case CHR_IOCTL_PP_READ_CONTROL:
1937 if (ioctl(fd, PPRCONTROL, &b) < 0)
1938 return -ENOTSUP;
1939 /* Linux gives only the lowest bits, and no way to know data
1940 direction! For better compatibility set the fixed upper
1941 bits. */
1942 *(uint8_t *)arg = b | 0xc0;
1943 break;
1944 case CHR_IOCTL_PP_WRITE_CONTROL:
1945 b = *(uint8_t *)arg;
1946 if (ioctl(fd, PPWCONTROL, &b) < 0)
1947 return -ENOTSUP;
1948 break;
1949 case CHR_IOCTL_PP_READ_STATUS:
1950 if (ioctl(fd, PPRSTATUS, &b) < 0)
1951 return -ENOTSUP;
1952 *(uint8_t *)arg = b;
1953 break;
1954 case CHR_IOCTL_PP_DATA_DIR:
1955 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1956 return -ENOTSUP;
1957 break;
1958 case CHR_IOCTL_PP_EPP_READ_ADDR:
1959 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1960 struct ParallelIOArg *parg = arg;
1961 int n = read(fd, parg->buffer, parg->count);
1962 if (n != parg->count) {
1963 return -EIO;
1966 break;
1967 case CHR_IOCTL_PP_EPP_READ:
1968 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1969 struct ParallelIOArg *parg = arg;
1970 int n = read(fd, parg->buffer, parg->count);
1971 if (n != parg->count) {
1972 return -EIO;
1975 break;
1976 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1977 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1978 struct ParallelIOArg *parg = arg;
1979 int n = write(fd, parg->buffer, parg->count);
1980 if (n != parg->count) {
1981 return -EIO;
1984 break;
1985 case CHR_IOCTL_PP_EPP_WRITE:
1986 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1987 struct ParallelIOArg *parg = arg;
1988 int n = write(fd, parg->buffer, parg->count);
1989 if (n != parg->count) {
1990 return -EIO;
1993 break;
1994 default:
1995 return -ENOTSUP;
1997 return 0;
2000 static void pp_free(Chardev *chr)
2002 ParallelChardev *drv = (ParallelChardev *)chr;
2003 int fd = drv->fd;
2005 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
2006 ioctl(fd, PPRELEASE);
2007 close(fd);
2008 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2011 static Chardev *qemu_chr_open_pp_fd(const CharDriver *driver,
2012 int fd,
2013 ChardevCommon *backend,
2014 bool *be_opened,
2015 Error **errp)
2017 Chardev *chr;
2018 ParallelChardev *drv;
2020 if (ioctl(fd, PPCLAIM) < 0) {
2021 error_setg_errno(errp, errno, "not a parallel port");
2022 close(fd);
2023 return NULL;
2026 chr = qemu_chr_alloc(driver, backend, errp);
2027 if (!chr) {
2028 return NULL;
2031 drv = (ParallelChardev *)chr;
2032 drv->fd = fd;
2033 drv->mode = IEEE1284_MODE_COMPAT;
2035 return chr;
2037 #endif /* __linux__ */
2039 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
2041 #define HAVE_CHARDEV_PARPORT 1
2043 typedef struct {
2044 Chardev parent;
2045 int fd;
2046 } ParallelChardev;
2048 static int pp_ioctl(Chardev *chr, int cmd, void *arg)
2050 ParallelChardev *drv = (ParallelChardev *)chr;
2051 uint8_t b;
2053 switch (cmd) {
2054 case CHR_IOCTL_PP_READ_DATA:
2055 if (ioctl(drv->fd, PPIGDATA, &b) < 0) {
2056 return -ENOTSUP;
2058 *(uint8_t *)arg = b;
2059 break;
2060 case CHR_IOCTL_PP_WRITE_DATA:
2061 b = *(uint8_t *)arg;
2062 if (ioctl(drv->fd, PPISDATA, &b) < 0) {
2063 return -ENOTSUP;
2065 break;
2066 case CHR_IOCTL_PP_READ_CONTROL:
2067 if (ioctl(drv->fd, PPIGCTRL, &b) < 0) {
2068 return -ENOTSUP;
2070 *(uint8_t *)arg = b;
2071 break;
2072 case CHR_IOCTL_PP_WRITE_CONTROL:
2073 b = *(uint8_t *)arg;
2074 if (ioctl(drv->fd, PPISCTRL, &b) < 0) {
2075 return -ENOTSUP;
2077 break;
2078 case CHR_IOCTL_PP_READ_STATUS:
2079 if (ioctl(drv->fd, PPIGSTATUS, &b) < 0) {
2080 return -ENOTSUP;
2082 *(uint8_t *)arg = b;
2083 break;
2084 default:
2085 return -ENOTSUP;
2087 return 0;
2090 static Chardev *qemu_chr_open_pp_fd(const CharDriver *driver,
2091 int fd,
2092 ChardevCommon *backend,
2093 bool *be_opened,
2094 Error **errp)
2096 Chardev *chr;
2097 ParallelChardev *drv;
2099 chr = qemu_chr_alloc(driver, backend, errp);
2100 if (!chr) {
2101 return NULL;
2103 drv = (ParallelChardev *)chr;
2104 drv->fd = fd;
2105 *be_opened = false;
2106 return chr;
2108 #endif
2110 #else /* _WIN32 */
2112 #define HAVE_CHARDEV_SERIAL 1
2114 typedef struct {
2115 Chardev parent;
2116 int max_size;
2117 HANDLE hcom, hrecv, hsend;
2118 OVERLAPPED orecv;
2119 BOOL fpipe;
2120 DWORD len;
2122 /* Protected by the Chardev chr_write_lock. */
2123 OVERLAPPED osend;
2124 } WinChardev;
2126 typedef struct {
2127 Chardev parent;
2128 HANDLE hStdIn;
2129 HANDLE hInputReadyEvent;
2130 HANDLE hInputDoneEvent;
2131 HANDLE hInputThread;
2132 uint8_t win_stdio_buf;
2133 } WinStdioChardev;
2135 #define NSENDBUF 2048
2136 #define NRECVBUF 2048
2137 #define MAXCONNECT 1
2138 #define NTIMEOUT 5000
2140 static int win_chr_poll(void *opaque);
2141 static int win_chr_pipe_poll(void *opaque);
2143 static void win_chr_free(Chardev *chr)
2145 WinChardev *s = (WinChardev *)chr;
2147 if (s->hsend) {
2148 CloseHandle(s->hsend);
2149 s->hsend = NULL;
2151 if (s->hrecv) {
2152 CloseHandle(s->hrecv);
2153 s->hrecv = NULL;
2155 if (s->hcom) {
2156 CloseHandle(s->hcom);
2157 s->hcom = NULL;
2159 if (s->fpipe)
2160 qemu_del_polling_cb(win_chr_pipe_poll, chr);
2161 else
2162 qemu_del_polling_cb(win_chr_poll, chr);
2164 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2167 static int win_chr_init(Chardev *chr, const char *filename, Error **errp)
2169 WinChardev *s = (WinChardev *)chr;
2170 COMMCONFIG comcfg;
2171 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
2172 COMSTAT comstat;
2173 DWORD size;
2174 DWORD err;
2176 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2177 if (!s->hsend) {
2178 error_setg(errp, "Failed CreateEvent");
2179 goto fail;
2181 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2182 if (!s->hrecv) {
2183 error_setg(errp, "Failed CreateEvent");
2184 goto fail;
2187 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
2188 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
2189 if (s->hcom == INVALID_HANDLE_VALUE) {
2190 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
2191 s->hcom = NULL;
2192 goto fail;
2195 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
2196 error_setg(errp, "Failed SetupComm");
2197 goto fail;
2200 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
2201 size = sizeof(COMMCONFIG);
2202 GetDefaultCommConfig(filename, &comcfg, &size);
2203 comcfg.dcb.DCBlength = sizeof(DCB);
2204 CommConfigDialog(filename, NULL, &comcfg);
2206 if (!SetCommState(s->hcom, &comcfg.dcb)) {
2207 error_setg(errp, "Failed SetCommState");
2208 goto fail;
2211 if (!SetCommMask(s->hcom, EV_ERR)) {
2212 error_setg(errp, "Failed SetCommMask");
2213 goto fail;
2216 cto.ReadIntervalTimeout = MAXDWORD;
2217 if (!SetCommTimeouts(s->hcom, &cto)) {
2218 error_setg(errp, "Failed SetCommTimeouts");
2219 goto fail;
2222 if (!ClearCommError(s->hcom, &err, &comstat)) {
2223 error_setg(errp, "Failed ClearCommError");
2224 goto fail;
2226 qemu_add_polling_cb(win_chr_poll, chr);
2227 return 0;
2229 fail:
2230 win_chr_free(chr);
2231 return -1;
2234 /* Called with chr_write_lock held. */
2235 static int win_chr_write(Chardev *chr, const uint8_t *buf, int len1)
2237 WinChardev *s = (WinChardev *)chr;
2238 DWORD len, ret, size, err;
2240 len = len1;
2241 ZeroMemory(&s->osend, sizeof(s->osend));
2242 s->osend.hEvent = s->hsend;
2243 while (len > 0) {
2244 if (s->hsend)
2245 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
2246 else
2247 ret = WriteFile(s->hcom, buf, len, &size, NULL);
2248 if (!ret) {
2249 err = GetLastError();
2250 if (err == ERROR_IO_PENDING) {
2251 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
2252 if (ret) {
2253 buf += size;
2254 len -= size;
2255 } else {
2256 break;
2258 } else {
2259 break;
2261 } else {
2262 buf += size;
2263 len -= size;
2266 return len1 - len;
2269 static int win_chr_read_poll(Chardev *chr)
2271 WinChardev *s = (WinChardev *)chr;
2273 s->max_size = qemu_chr_be_can_write(chr);
2274 return s->max_size;
2277 static void win_chr_readfile(Chardev *chr)
2279 WinChardev *s = (WinChardev *)chr;
2280 int ret, err;
2281 uint8_t buf[READ_BUF_LEN];
2282 DWORD size;
2284 ZeroMemory(&s->orecv, sizeof(s->orecv));
2285 s->orecv.hEvent = s->hrecv;
2286 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2287 if (!ret) {
2288 err = GetLastError();
2289 if (err == ERROR_IO_PENDING) {
2290 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2294 if (size > 0) {
2295 qemu_chr_be_write(chr, buf, size);
2299 static void win_chr_read(Chardev *chr)
2301 WinChardev *s = (WinChardev *)chr;
2303 if (s->len > s->max_size)
2304 s->len = s->max_size;
2305 if (s->len == 0)
2306 return;
2308 win_chr_readfile(chr);
2311 static int win_chr_poll(void *opaque)
2313 Chardev *chr = opaque;
2314 WinChardev *s = opaque;
2315 COMSTAT status;
2316 DWORD comerr;
2318 ClearCommError(s->hcom, &comerr, &status);
2319 if (status.cbInQue > 0) {
2320 s->len = status.cbInQue;
2321 win_chr_read_poll(chr);
2322 win_chr_read(chr);
2323 return 1;
2325 return 0;
2328 static int win_chr_pipe_poll(void *opaque)
2330 Chardev *chr = opaque;
2331 WinChardev *s = opaque;
2332 DWORD size;
2334 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2335 if (size > 0) {
2336 s->len = size;
2337 win_chr_read_poll(chr);
2338 win_chr_read(chr);
2339 return 1;
2341 return 0;
2344 static int win_chr_pipe_init(Chardev *chr, const char *filename,
2345 Error **errp)
2347 WinChardev *s = (WinChardev *)chr;
2348 OVERLAPPED ov;
2349 int ret;
2350 DWORD size;
2351 char *openname;
2353 s->fpipe = TRUE;
2355 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2356 if (!s->hsend) {
2357 error_setg(errp, "Failed CreateEvent");
2358 goto fail;
2360 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2361 if (!s->hrecv) {
2362 error_setg(errp, "Failed CreateEvent");
2363 goto fail;
2366 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2367 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2368 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2369 PIPE_WAIT,
2370 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2371 g_free(openname);
2372 if (s->hcom == INVALID_HANDLE_VALUE) {
2373 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2374 s->hcom = NULL;
2375 goto fail;
2378 ZeroMemory(&ov, sizeof(ov));
2379 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2380 ret = ConnectNamedPipe(s->hcom, &ov);
2381 if (ret) {
2382 error_setg(errp, "Failed ConnectNamedPipe");
2383 goto fail;
2386 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2387 if (!ret) {
2388 error_setg(errp, "Failed GetOverlappedResult");
2389 if (ov.hEvent) {
2390 CloseHandle(ov.hEvent);
2391 ov.hEvent = NULL;
2393 goto fail;
2396 if (ov.hEvent) {
2397 CloseHandle(ov.hEvent);
2398 ov.hEvent = NULL;
2400 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2401 return 0;
2403 fail:
2404 win_chr_free(chr);
2405 return -1;
2409 static Chardev *qemu_chr_open_pipe(const CharDriver *driver,
2410 const char *id,
2411 ChardevBackend *backend,
2412 ChardevReturn *ret,
2413 bool *be_opened,
2414 Error **errp)
2416 ChardevHostdev *opts = backend->u.pipe.data;
2417 const char *filename = opts->device;
2418 Chardev *chr;
2419 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
2421 chr = qemu_chr_alloc(driver, common, errp);
2422 if (!chr) {
2423 return NULL;
2426 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2427 qemu_chr_free_common(chr);
2428 return NULL;
2430 return chr;
2433 static Chardev *qemu_chr_open_win_file(const CharDriver *driver,
2434 HANDLE fd_out,
2435 ChardevCommon *backend,
2436 Error **errp)
2438 Chardev *chr;
2439 WinChardev *s;
2441 chr = qemu_chr_alloc(driver, backend, errp);
2442 if (!chr) {
2443 return NULL;
2445 s = (WinChardev *)chr;
2446 s->hcom = fd_out;
2447 return chr;
2450 static Chardev *qemu_chr_open_win_con(const CharDriver *driver,
2451 const char *id,
2452 ChardevBackend *backend,
2453 ChardevReturn *ret,
2454 bool *be_opened,
2455 Error **errp)
2457 ChardevCommon *common = backend->u.console.data;
2458 return qemu_chr_open_win_file(driver,
2459 GetStdHandle(STD_OUTPUT_HANDLE),
2460 common, errp);
2463 static const CharDriver console_driver = {
2464 .instance_size = sizeof(WinChardev),
2465 .kind = CHARDEV_BACKEND_KIND_CONSOLE,
2466 .create = qemu_chr_open_win_con,
2467 .chr_write = win_chr_write,
2470 static int win_stdio_write(Chardev *chr, const uint8_t *buf, int len)
2472 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2473 DWORD dwSize;
2474 int len1;
2476 len1 = len;
2478 while (len1 > 0) {
2479 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2480 break;
2482 buf += dwSize;
2483 len1 -= dwSize;
2486 return len - len1;
2489 static void win_stdio_wait_func(void *opaque)
2491 Chardev *chr = opaque;
2492 WinStdioChardev *stdio = opaque;
2493 INPUT_RECORD buf[4];
2494 int ret;
2495 DWORD dwSize;
2496 int i;
2498 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2500 if (!ret) {
2501 /* Avoid error storm */
2502 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2503 return;
2506 for (i = 0; i < dwSize; i++) {
2507 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2509 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2510 int j;
2511 if (kev->uChar.AsciiChar != 0) {
2512 for (j = 0; j < kev->wRepeatCount; j++) {
2513 if (qemu_chr_be_can_write(chr)) {
2514 uint8_t c = kev->uChar.AsciiChar;
2515 qemu_chr_be_write(chr, &c, 1);
2523 static DWORD WINAPI win_stdio_thread(LPVOID param)
2525 WinStdioChardev *stdio = param;
2526 int ret;
2527 DWORD dwSize;
2529 while (1) {
2531 /* Wait for one byte */
2532 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2534 /* Exit in case of error, continue if nothing read */
2535 if (!ret) {
2536 break;
2538 if (!dwSize) {
2539 continue;
2542 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2543 if (stdio->win_stdio_buf == '\r') {
2544 continue;
2547 /* Signal the main thread and wait until the byte was eaten */
2548 if (!SetEvent(stdio->hInputReadyEvent)) {
2549 break;
2551 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2552 != WAIT_OBJECT_0) {
2553 break;
2557 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2558 return 0;
2561 static void win_stdio_thread_wait_func(void *opaque)
2563 Chardev *chr = opaque;
2564 WinStdioChardev *stdio = opaque;
2566 if (qemu_chr_be_can_write(chr)) {
2567 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2570 SetEvent(stdio->hInputDoneEvent);
2573 static void qemu_chr_set_echo_win_stdio(Chardev *chr, bool echo)
2575 WinStdioChardev *stdio = (WinStdioChardev *)chr;
2576 DWORD dwMode = 0;
2578 GetConsoleMode(stdio->hStdIn, &dwMode);
2580 if (echo) {
2581 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2582 } else {
2583 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2587 static void win_stdio_free(Chardev *chr)
2589 WinStdioChardev *stdio = (WinStdioChardev *)chr;
2591 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2592 CloseHandle(stdio->hInputReadyEvent);
2594 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2595 CloseHandle(stdio->hInputDoneEvent);
2597 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2598 TerminateThread(stdio->hInputThread, 0);
2602 static Chardev *qemu_chr_open_stdio(const CharDriver *driver,
2603 const char *id,
2604 ChardevBackend *backend,
2605 ChardevReturn *ret,
2606 bool *be_opened,
2607 Error **errp)
2609 Chardev *chr;
2610 WinStdioChardev *stdio;
2611 DWORD dwMode;
2612 int is_console = 0;
2613 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio.data);
2615 chr = qemu_chr_alloc(driver, common, errp);
2616 if (!chr) {
2617 return NULL;
2619 stdio = (WinStdioChardev *)chr;
2621 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2622 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2623 error_setg(errp, "cannot open stdio: invalid handle");
2624 return NULL;
2627 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2629 if (is_console) {
2630 if (qemu_add_wait_object(stdio->hStdIn,
2631 win_stdio_wait_func, chr)) {
2632 error_setg(errp, "qemu_add_wait_object: failed");
2633 goto err1;
2635 } else {
2636 DWORD dwId;
2638 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2639 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2640 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2641 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2642 error_setg(errp, "cannot create event");
2643 goto err2;
2645 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2646 win_stdio_thread_wait_func, chr)) {
2647 error_setg(errp, "qemu_add_wait_object: failed");
2648 goto err2;
2650 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2651 chr, 0, &dwId);
2653 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2654 error_setg(errp, "cannot create stdio thread");
2655 goto err3;
2659 dwMode |= ENABLE_LINE_INPUT;
2661 if (is_console) {
2662 /* set the terminal in raw mode */
2663 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2664 dwMode |= ENABLE_PROCESSED_INPUT;
2667 SetConsoleMode(stdio->hStdIn, dwMode);
2669 qemu_chr_set_echo_win_stdio(chr, false);
2671 return chr;
2673 err3:
2674 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2675 err2:
2676 CloseHandle(stdio->hInputReadyEvent);
2677 CloseHandle(stdio->hInputDoneEvent);
2678 err1:
2679 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2680 return NULL;
2682 #endif /* !_WIN32 */
2684 /***********************************************************/
2685 /* UDP Net console */
2687 typedef struct {
2688 Chardev parent;
2689 QIOChannel *ioc;
2690 uint8_t buf[READ_BUF_LEN];
2691 int bufcnt;
2692 int bufptr;
2693 int max_size;
2694 } UdpChardev;
2696 /* Called with chr_write_lock held. */
2697 static int udp_chr_write(Chardev *chr, const uint8_t *buf, int len)
2699 UdpChardev *s = (UdpChardev *)chr;
2701 return qio_channel_write(
2702 s->ioc, (const char *)buf, len, NULL);
2705 static int udp_chr_read_poll(void *opaque)
2707 Chardev *chr = opaque;
2708 UdpChardev *s = opaque;
2710 s->max_size = qemu_chr_be_can_write(chr);
2712 /* If there were any stray characters in the queue process them
2713 * first
2715 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2716 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2717 s->bufptr++;
2718 s->max_size = qemu_chr_be_can_write(chr);
2720 return s->max_size;
2723 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2725 Chardev *chr = opaque;
2726 UdpChardev *s = opaque;
2727 ssize_t ret;
2729 if (s->max_size == 0) {
2730 return TRUE;
2732 ret = qio_channel_read(
2733 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2734 if (ret <= 0) {
2735 remove_fd_in_watch(chr);
2736 return FALSE;
2738 s->bufcnt = ret;
2740 s->bufptr = 0;
2741 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2742 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2743 s->bufptr++;
2744 s->max_size = qemu_chr_be_can_write(chr);
2747 return TRUE;
2750 static void udp_chr_update_read_handler(Chardev *chr,
2751 GMainContext *context)
2753 UdpChardev *s = (UdpChardev *)chr;
2755 remove_fd_in_watch(chr);
2756 if (s->ioc) {
2757 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
2758 udp_chr_read_poll,
2759 udp_chr_read, chr,
2760 context);
2764 static void udp_chr_free(Chardev *chr)
2766 UdpChardev *s = (UdpChardev *)chr;
2768 remove_fd_in_watch(chr);
2769 if (s->ioc) {
2770 object_unref(OBJECT(s->ioc));
2772 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2775 /***********************************************************/
2776 /* TCP Net console */
2778 typedef struct {
2779 Chardev parent;
2780 QIOChannel *ioc; /* Client I/O channel */
2781 QIOChannelSocket *sioc; /* Client master channel */
2782 QIOChannelSocket *listen_ioc;
2783 guint listen_tag;
2784 QCryptoTLSCreds *tls_creds;
2785 int connected;
2786 int max_size;
2787 int do_telnetopt;
2788 int do_nodelay;
2789 int is_unix;
2790 int *read_msgfds;
2791 size_t read_msgfds_num;
2792 int *write_msgfds;
2793 size_t write_msgfds_num;
2795 SocketAddress *addr;
2796 bool is_listen;
2797 bool is_telnet;
2799 guint reconnect_timer;
2800 int64_t reconnect_time;
2801 bool connect_err_reported;
2802 } SocketChardev;
2804 static gboolean socket_reconnect_timeout(gpointer opaque);
2806 static void qemu_chr_socket_restart_timer(Chardev *chr)
2808 SocketChardev *s = (SocketChardev *)chr;
2809 char *name;
2811 assert(s->connected == 0);
2812 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2813 socket_reconnect_timeout, chr);
2814 name = g_strdup_printf("chardev-socket-reconnect-%s", chr->label);
2815 g_source_set_name_by_id(s->reconnect_timer, name);
2816 g_free(name);
2819 static void check_report_connect_error(Chardev *chr,
2820 Error *err)
2822 SocketChardev *s = (SocketChardev *)chr;
2824 if (!s->connect_err_reported) {
2825 error_report("Unable to connect character device %s: %s",
2826 chr->label, error_get_pretty(err));
2827 s->connect_err_reported = true;
2829 qemu_chr_socket_restart_timer(chr);
2832 static gboolean tcp_chr_accept(QIOChannel *chan,
2833 GIOCondition cond,
2834 void *opaque);
2836 /* Called with chr_write_lock held. */
2837 static int tcp_chr_write(Chardev *chr, const uint8_t *buf, int len)
2839 SocketChardev *s = (SocketChardev *)chr;
2841 if (s->connected) {
2842 int ret = io_channel_send_full(s->ioc, buf, len,
2843 s->write_msgfds,
2844 s->write_msgfds_num);
2846 /* free the written msgfds, no matter what */
2847 if (s->write_msgfds_num) {
2848 g_free(s->write_msgfds);
2849 s->write_msgfds = 0;
2850 s->write_msgfds_num = 0;
2853 return ret;
2854 } else {
2855 /* XXX: indicate an error ? */
2856 return len;
2860 static int tcp_chr_read_poll(void *opaque)
2862 Chardev *chr = opaque;
2863 SocketChardev *s = opaque;
2864 if (!s->connected)
2865 return 0;
2866 s->max_size = qemu_chr_be_can_write(chr);
2867 return s->max_size;
2870 #define IAC 255
2871 #define IAC_BREAK 243
2872 static void tcp_chr_process_IAC_bytes(Chardev *chr,
2873 SocketChardev *s,
2874 uint8_t *buf, int *size)
2876 /* Handle any telnet client's basic IAC options to satisfy char by
2877 * char mode with no echo. All IAC options will be removed from
2878 * the buf and the do_telnetopt variable will be used to track the
2879 * state of the width of the IAC information.
2881 * IAC commands come in sets of 3 bytes with the exception of the
2882 * "IAC BREAK" command and the double IAC.
2885 int i;
2886 int j = 0;
2888 for (i = 0; i < *size; i++) {
2889 if (s->do_telnetopt > 1) {
2890 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2891 /* Double IAC means send an IAC */
2892 if (j != i)
2893 buf[j] = buf[i];
2894 j++;
2895 s->do_telnetopt = 1;
2896 } else {
2897 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2898 /* Handle IAC break commands by sending a serial break */
2899 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2900 s->do_telnetopt++;
2902 s->do_telnetopt++;
2904 if (s->do_telnetopt >= 4) {
2905 s->do_telnetopt = 1;
2907 } else {
2908 if ((unsigned char)buf[i] == IAC) {
2909 s->do_telnetopt = 2;
2910 } else {
2911 if (j != i)
2912 buf[j] = buf[i];
2913 j++;
2917 *size = j;
2920 static int tcp_get_msgfds(Chardev *chr, int *fds, int num)
2922 SocketChardev *s = (SocketChardev *)chr;
2924 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2926 assert(num <= TCP_MAX_FDS);
2928 if (to_copy) {
2929 int i;
2931 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2933 /* Close unused fds */
2934 for (i = to_copy; i < s->read_msgfds_num; i++) {
2935 close(s->read_msgfds[i]);
2938 g_free(s->read_msgfds);
2939 s->read_msgfds = 0;
2940 s->read_msgfds_num = 0;
2943 return to_copy;
2946 static int tcp_set_msgfds(Chardev *chr, int *fds, int num)
2948 SocketChardev *s = (SocketChardev *)chr;
2950 /* clear old pending fd array */
2951 g_free(s->write_msgfds);
2952 s->write_msgfds = NULL;
2953 s->write_msgfds_num = 0;
2955 if (!s->connected ||
2956 !qio_channel_has_feature(s->ioc,
2957 QIO_CHANNEL_FEATURE_FD_PASS)) {
2958 return -1;
2961 if (num) {
2962 s->write_msgfds = g_new(int, num);
2963 memcpy(s->write_msgfds, fds, num * sizeof(int));
2966 s->write_msgfds_num = num;
2968 return 0;
2971 static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
2973 SocketChardev *s = (SocketChardev *)chr;
2974 struct iovec iov = { .iov_base = buf, .iov_len = len };
2975 int ret;
2976 size_t i;
2977 int *msgfds = NULL;
2978 size_t msgfds_num = 0;
2980 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2981 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2982 &msgfds, &msgfds_num,
2983 NULL);
2984 } else {
2985 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2986 NULL, NULL,
2987 NULL);
2990 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2991 errno = EAGAIN;
2992 ret = -1;
2993 } else if (ret == -1) {
2994 errno = EIO;
2997 if (msgfds_num) {
2998 /* close and clean read_msgfds */
2999 for (i = 0; i < s->read_msgfds_num; i++) {
3000 close(s->read_msgfds[i]);
3003 if (s->read_msgfds_num) {
3004 g_free(s->read_msgfds);
3007 s->read_msgfds = msgfds;
3008 s->read_msgfds_num = msgfds_num;
3011 for (i = 0; i < s->read_msgfds_num; i++) {
3012 int fd = s->read_msgfds[i];
3013 if (fd < 0) {
3014 continue;
3017 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
3018 qemu_set_block(fd);
3020 #ifndef MSG_CMSG_CLOEXEC
3021 qemu_set_cloexec(fd);
3022 #endif
3025 return ret;
3028 static GSource *tcp_chr_add_watch(Chardev *chr, GIOCondition cond)
3030 SocketChardev *s = (SocketChardev *)chr;
3031 return qio_channel_create_watch(s->ioc, cond);
3034 static void tcp_chr_free_connection(Chardev *chr)
3036 SocketChardev *s = (SocketChardev *)chr;
3037 int i;
3039 if (!s->connected) {
3040 return;
3043 if (s->read_msgfds_num) {
3044 for (i = 0; i < s->read_msgfds_num; i++) {
3045 close(s->read_msgfds[i]);
3047 g_free(s->read_msgfds);
3048 s->read_msgfds = NULL;
3049 s->read_msgfds_num = 0;
3052 tcp_set_msgfds(chr, NULL, 0);
3053 remove_fd_in_watch(chr);
3054 object_unref(OBJECT(s->sioc));
3055 s->sioc = NULL;
3056 object_unref(OBJECT(s->ioc));
3057 s->ioc = NULL;
3058 g_free(chr->filename);
3059 chr->filename = NULL;
3060 s->connected = 0;
3063 static void tcp_chr_disconnect(Chardev *chr)
3065 SocketChardev *s = (SocketChardev *)chr;
3067 if (!s->connected) {
3068 return;
3071 tcp_chr_free_connection(chr);
3073 if (s->listen_ioc) {
3074 s->listen_tag = qio_channel_add_watch(
3075 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
3077 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
3078 s->is_listen, s->is_telnet);
3079 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3080 if (s->reconnect_time) {
3081 qemu_chr_socket_restart_timer(chr);
3085 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
3087 Chardev *chr = opaque;
3088 SocketChardev *s = opaque;
3089 uint8_t buf[READ_BUF_LEN];
3090 int len, size;
3092 if (!s->connected || s->max_size <= 0) {
3093 return TRUE;
3095 len = sizeof(buf);
3096 if (len > s->max_size)
3097 len = s->max_size;
3098 size = tcp_chr_recv(chr, (void *)buf, len);
3099 if (size == 0 || size == -1) {
3100 /* connection closed */
3101 tcp_chr_disconnect(chr);
3102 } else if (size > 0) {
3103 if (s->do_telnetopt)
3104 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
3105 if (size > 0)
3106 qemu_chr_be_write(chr, buf, size);
3109 return TRUE;
3112 static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len)
3114 SocketChardev *s = (SocketChardev *)chr;
3115 int size;
3117 if (!s->connected) {
3118 return 0;
3121 size = tcp_chr_recv(chr, (void *) buf, len);
3122 if (size == 0) {
3123 /* connection closed */
3124 tcp_chr_disconnect(chr);
3127 return size;
3130 static void tcp_chr_connect(void *opaque)
3132 Chardev *chr = opaque;
3133 SocketChardev *s = opaque;
3135 g_free(chr->filename);
3136 chr->filename = sockaddr_to_str(
3137 &s->sioc->localAddr, s->sioc->localAddrLen,
3138 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
3139 s->is_listen, s->is_telnet);
3141 s->connected = 1;
3142 if (s->ioc) {
3143 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
3144 tcp_chr_read_poll,
3145 tcp_chr_read,
3146 chr, NULL);
3148 qemu_chr_be_generic_open(chr);
3151 static void tcp_chr_update_read_handler(Chardev *chr,
3152 GMainContext *context)
3154 SocketChardev *s = (SocketChardev *)chr;
3156 if (!s->connected) {
3157 return;
3160 remove_fd_in_watch(chr);
3161 if (s->ioc) {
3162 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
3163 tcp_chr_read_poll,
3164 tcp_chr_read, chr,
3165 context);
3169 typedef struct {
3170 Chardev *chr;
3171 char buf[12];
3172 size_t buflen;
3173 } TCPCharDriverTelnetInit;
3175 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
3176 GIOCondition cond G_GNUC_UNUSED,
3177 gpointer user_data)
3179 TCPCharDriverTelnetInit *init = user_data;
3180 ssize_t ret;
3182 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
3183 if (ret < 0) {
3184 if (ret == QIO_CHANNEL_ERR_BLOCK) {
3185 ret = 0;
3186 } else {
3187 tcp_chr_disconnect(init->chr);
3188 return FALSE;
3191 init->buflen -= ret;
3193 if (init->buflen == 0) {
3194 tcp_chr_connect(init->chr);
3195 return FALSE;
3198 memmove(init->buf, init->buf + ret, init->buflen);
3200 return TRUE;
3203 static void tcp_chr_telnet_init(Chardev *chr)
3205 SocketChardev *s = (SocketChardev *)chr;
3206 TCPCharDriverTelnetInit *init =
3207 g_new0(TCPCharDriverTelnetInit, 1);
3208 size_t n = 0;
3210 init->chr = chr;
3211 init->buflen = 12;
3213 #define IACSET(x, a, b, c) \
3214 do { \
3215 x[n++] = a; \
3216 x[n++] = b; \
3217 x[n++] = c; \
3218 } while (0)
3220 /* Prep the telnet negotion to put telnet in binary,
3221 * no echo, single char mode */
3222 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3223 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3224 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3225 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3227 #undef IACSET
3229 qio_channel_add_watch(
3230 s->ioc, G_IO_OUT,
3231 tcp_chr_telnet_init_io,
3232 init, NULL);
3236 static void tcp_chr_tls_handshake(QIOTask *task,
3237 gpointer user_data)
3239 Chardev *chr = user_data;
3240 SocketChardev *s = user_data;
3242 if (qio_task_propagate_error(task, NULL)) {
3243 tcp_chr_disconnect(chr);
3244 } else {
3245 if (s->do_telnetopt) {
3246 tcp_chr_telnet_init(chr);
3247 } else {
3248 tcp_chr_connect(chr);
3254 static void tcp_chr_tls_init(Chardev *chr)
3256 SocketChardev *s = (SocketChardev *)chr;
3257 QIOChannelTLS *tioc;
3258 Error *err = NULL;
3259 gchar *name;
3261 if (s->is_listen) {
3262 tioc = qio_channel_tls_new_server(
3263 s->ioc, s->tls_creds,
3264 NULL, /* XXX Use an ACL */
3265 &err);
3266 } else {
3267 tioc = qio_channel_tls_new_client(
3268 s->ioc, s->tls_creds,
3269 s->addr->u.inet.data->host,
3270 &err);
3272 if (tioc == NULL) {
3273 error_free(err);
3274 tcp_chr_disconnect(chr);
3275 return;
3277 name = g_strdup_printf("chardev-tls-%s-%s",
3278 s->is_listen ? "server" : "client",
3279 chr->label);
3280 qio_channel_set_name(QIO_CHANNEL(tioc), name);
3281 g_free(name);
3282 object_unref(OBJECT(s->ioc));
3283 s->ioc = QIO_CHANNEL(tioc);
3285 qio_channel_tls_handshake(tioc,
3286 tcp_chr_tls_handshake,
3287 chr,
3288 NULL);
3292 static void tcp_chr_set_client_ioc_name(Chardev *chr,
3293 QIOChannelSocket *sioc)
3295 SocketChardev *s = (SocketChardev *)chr;
3296 char *name;
3297 name = g_strdup_printf("chardev-tcp-%s-%s",
3298 s->is_listen ? "server" : "client",
3299 chr->label);
3300 qio_channel_set_name(QIO_CHANNEL(sioc), name);
3301 g_free(name);
3305 static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc)
3307 SocketChardev *s = (SocketChardev *)chr;
3309 if (s->ioc != NULL) {
3310 return -1;
3313 s->ioc = QIO_CHANNEL(sioc);
3314 object_ref(OBJECT(sioc));
3315 s->sioc = sioc;
3316 object_ref(OBJECT(sioc));
3318 qio_channel_set_blocking(s->ioc, false, NULL);
3320 if (s->do_nodelay) {
3321 qio_channel_set_delay(s->ioc, false);
3323 if (s->listen_tag) {
3324 g_source_remove(s->listen_tag);
3325 s->listen_tag = 0;
3328 if (s->tls_creds) {
3329 tcp_chr_tls_init(chr);
3330 } else {
3331 if (s->do_telnetopt) {
3332 tcp_chr_telnet_init(chr);
3333 } else {
3334 tcp_chr_connect(chr);
3338 return 0;
3342 static int tcp_chr_add_client(Chardev *chr, int fd)
3344 int ret;
3345 QIOChannelSocket *sioc;
3347 sioc = qio_channel_socket_new_fd(fd, NULL);
3348 if (!sioc) {
3349 return -1;
3351 tcp_chr_set_client_ioc_name(chr, sioc);
3352 ret = tcp_chr_new_client(chr, sioc);
3353 object_unref(OBJECT(sioc));
3354 return ret;
3357 static gboolean tcp_chr_accept(QIOChannel *channel,
3358 GIOCondition cond,
3359 void *opaque)
3361 Chardev *chr = opaque;
3362 QIOChannelSocket *sioc;
3364 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3365 NULL);
3366 if (!sioc) {
3367 return TRUE;
3370 tcp_chr_new_client(chr, sioc);
3372 object_unref(OBJECT(sioc));
3374 return TRUE;
3377 static int tcp_chr_wait_connected(Chardev *chr, Error **errp)
3379 SocketChardev *s = (SocketChardev *)chr;
3380 QIOChannelSocket *sioc;
3382 /* It can't wait on s->connected, since it is set asynchronously
3383 * in TLS and telnet cases, only wait for an accepted socket */
3384 while (!s->ioc) {
3385 if (s->is_listen) {
3386 error_report("QEMU waiting for connection on: %s",
3387 chr->filename);
3388 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), true, NULL);
3389 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
3390 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
3391 } else {
3392 sioc = qio_channel_socket_new();
3393 tcp_chr_set_client_ioc_name(chr, sioc);
3394 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
3395 object_unref(OBJECT(sioc));
3396 return -1;
3398 tcp_chr_new_client(chr, sioc);
3399 object_unref(OBJECT(sioc));
3403 return 0;
3406 static int qemu_chr_wait_connected(Chardev *chr, Error **errp)
3408 if (chr->driver->chr_wait_connected) {
3409 return chr->driver->chr_wait_connected(chr, errp);
3412 return 0;
3415 int qemu_chr_fe_wait_connected(CharBackend *be, Error **errp)
3417 if (!be->chr) {
3418 error_setg(errp, "missing associated backend");
3419 return -1;
3422 return qemu_chr_wait_connected(be->chr, errp);
3425 static void tcp_chr_free(Chardev *chr)
3427 SocketChardev *s = (SocketChardev *)chr;
3429 tcp_chr_free_connection(chr);
3431 if (s->reconnect_timer) {
3432 g_source_remove(s->reconnect_timer);
3433 s->reconnect_timer = 0;
3435 qapi_free_SocketAddress(s->addr);
3436 if (s->listen_tag) {
3437 g_source_remove(s->listen_tag);
3438 s->listen_tag = 0;
3440 if (s->listen_ioc) {
3441 object_unref(OBJECT(s->listen_ioc));
3443 if (s->tls_creds) {
3444 object_unref(OBJECT(s->tls_creds));
3447 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3451 static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
3453 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
3454 Chardev *chr = opaque;
3455 SocketChardev *s = (SocketChardev *)chr;
3456 Error *err = NULL;
3458 if (qio_task_propagate_error(task, &err)) {
3459 check_report_connect_error(chr, err);
3460 error_free(err);
3461 goto cleanup;
3464 s->connect_err_reported = false;
3465 tcp_chr_new_client(chr, sioc);
3467 cleanup:
3468 object_unref(OBJECT(sioc));
3472 /*********************************************************/
3473 /* Ring buffer chardev */
3475 typedef struct {
3476 Chardev parent;
3477 size_t size;
3478 size_t prod;
3479 size_t cons;
3480 uint8_t *cbuf;
3481 } RingBufChardev;
3483 static size_t ringbuf_count(const Chardev *chr)
3485 const RingBufChardev *d = (RingBufChardev *)chr;
3487 return d->prod - d->cons;
3490 /* Called with chr_write_lock held. */
3491 static int ringbuf_chr_write(Chardev *chr, const uint8_t *buf, int len)
3493 RingBufChardev *d = (RingBufChardev *)chr;
3494 int i;
3496 if (!buf || (len < 0)) {
3497 return -1;
3500 for (i = 0; i < len; i++ ) {
3501 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3502 if (d->prod - d->cons > d->size) {
3503 d->cons = d->prod - d->size;
3507 return len;
3510 static int ringbuf_chr_read(Chardev *chr, uint8_t *buf, int len)
3512 RingBufChardev *d = (RingBufChardev *)chr;
3513 int i;
3515 qemu_mutex_lock(&chr->chr_write_lock);
3516 for (i = 0; i < len && d->cons != d->prod; i++) {
3517 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3519 qemu_mutex_unlock(&chr->chr_write_lock);
3521 return i;
3524 static void ringbuf_chr_free(struct Chardev *chr)
3526 RingBufChardev *d = (RingBufChardev *)chr;
3528 g_free(d->cbuf);
3531 static Chardev *qemu_chr_open_ringbuf(const CharDriver *driver,
3532 const char *id,
3533 ChardevBackend *backend,
3534 ChardevReturn *ret,
3535 bool *be_opened,
3536 Error **errp)
3538 ChardevRingbuf *opts = backend->u.ringbuf.data;
3539 ChardevCommon *common = qapi_ChardevRingbuf_base(opts);
3540 Chardev *chr;
3541 RingBufChardev *d;
3543 chr = qemu_chr_alloc(driver, common, errp);
3544 if (!chr) {
3545 return NULL;
3547 d = (RingBufChardev *)chr;
3549 d->size = opts->has_size ? opts->size : 65536;
3551 /* The size must be power of 2 */
3552 if (d->size & (d->size - 1)) {
3553 error_setg(errp, "size of ringbuf chardev must be power of two");
3554 goto fail;
3557 d->prod = 0;
3558 d->cons = 0;
3559 d->cbuf = g_malloc0(d->size);
3561 return chr;
3563 fail:
3564 qemu_chr_free_common(chr);
3565 return NULL;
3568 ChardevBackendKind qemu_chr_get_kind(const Chardev *chr)
3570 return chr->driver->kind;
3573 void qmp_ringbuf_write(const char *device, const char *data,
3574 bool has_format, enum DataFormat format,
3575 Error **errp)
3577 Chardev *chr;
3578 const uint8_t *write_data;
3579 int ret;
3580 gsize write_count;
3582 chr = qemu_chr_find(device);
3583 if (!chr) {
3584 error_setg(errp, "Device '%s' not found", device);
3585 return;
3588 if (!qemu_chr_is_ringbuf(chr)) {
3589 error_setg(errp,"%s is not a ringbuf device", device);
3590 return;
3593 if (has_format && (format == DATA_FORMAT_BASE64)) {
3594 write_data = qbase64_decode(data, -1,
3595 &write_count,
3596 errp);
3597 if (!write_data) {
3598 return;
3600 } else {
3601 write_data = (uint8_t *)data;
3602 write_count = strlen(data);
3605 ret = ringbuf_chr_write(chr, write_data, write_count);
3607 if (write_data != (uint8_t *)data) {
3608 g_free((void *)write_data);
3611 if (ret < 0) {
3612 error_setg(errp, "Failed to write to device %s", device);
3613 return;
3617 char *qmp_ringbuf_read(const char *device, int64_t size,
3618 bool has_format, enum DataFormat format,
3619 Error **errp)
3621 Chardev *chr;
3622 uint8_t *read_data;
3623 size_t count;
3624 char *data;
3626 chr = qemu_chr_find(device);
3627 if (!chr) {
3628 error_setg(errp, "Device '%s' not found", device);
3629 return NULL;
3632 if (!qemu_chr_is_ringbuf(chr)) {
3633 error_setg(errp,"%s is not a ringbuf device", device);
3634 return NULL;
3637 if (size <= 0) {
3638 error_setg(errp, "size must be greater than zero");
3639 return NULL;
3642 count = ringbuf_count(chr);
3643 size = size > count ? count : size;
3644 read_data = g_malloc(size + 1);
3646 ringbuf_chr_read(chr, read_data, size);
3648 if (has_format && (format == DATA_FORMAT_BASE64)) {
3649 data = g_base64_encode(read_data, size);
3650 g_free(read_data);
3651 } else {
3653 * FIXME should read only complete, valid UTF-8 characters up
3654 * to @size bytes. Invalid sequences should be replaced by a
3655 * suitable replacement character. Except when (and only
3656 * when) ring buffer lost characters since last read, initial
3657 * continuation characters should be dropped.
3659 read_data[size] = 0;
3660 data = (char *)read_data;
3663 return data;
3666 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3668 char host[65], port[33], width[8], height[8];
3669 int pos;
3670 const char *p;
3671 QemuOpts *opts;
3672 Error *local_err = NULL;
3674 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3675 if (local_err) {
3676 error_report_err(local_err);
3677 return NULL;
3680 if (strstart(filename, "mon:", &p)) {
3681 filename = p;
3682 qemu_opt_set(opts, "mux", "on", &error_abort);
3683 if (strcmp(filename, "stdio") == 0) {
3684 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3685 * but pass it to the guest. Handle this only for compat syntax,
3686 * for -chardev syntax we have special option for this.
3687 * This is what -nographic did, redirecting+muxing serial+monitor
3688 * to stdio causing Ctrl+C to be passed to guest. */
3689 qemu_opt_set(opts, "signal", "off", &error_abort);
3693 if (strcmp(filename, "null") == 0 ||
3694 strcmp(filename, "pty") == 0 ||
3695 strcmp(filename, "msmouse") == 0 ||
3696 strcmp(filename, "braille") == 0 ||
3697 strcmp(filename, "testdev") == 0 ||
3698 strcmp(filename, "stdio") == 0) {
3699 qemu_opt_set(opts, "backend", filename, &error_abort);
3700 return opts;
3702 if (strstart(filename, "vc", &p)) {
3703 qemu_opt_set(opts, "backend", "vc", &error_abort);
3704 if (*p == ':') {
3705 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3706 /* pixels */
3707 qemu_opt_set(opts, "width", width, &error_abort);
3708 qemu_opt_set(opts, "height", height, &error_abort);
3709 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3710 /* chars */
3711 qemu_opt_set(opts, "cols", width, &error_abort);
3712 qemu_opt_set(opts, "rows", height, &error_abort);
3713 } else {
3714 goto fail;
3717 return opts;
3719 if (strcmp(filename, "con:") == 0) {
3720 qemu_opt_set(opts, "backend", "console", &error_abort);
3721 return opts;
3723 if (strstart(filename, "COM", NULL)) {
3724 qemu_opt_set(opts, "backend", "serial", &error_abort);
3725 qemu_opt_set(opts, "path", filename, &error_abort);
3726 return opts;
3728 if (strstart(filename, "file:", &p)) {
3729 qemu_opt_set(opts, "backend", "file", &error_abort);
3730 qemu_opt_set(opts, "path", p, &error_abort);
3731 return opts;
3733 if (strstart(filename, "pipe:", &p)) {
3734 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3735 qemu_opt_set(opts, "path", p, &error_abort);
3736 return opts;
3738 if (strstart(filename, "tcp:", &p) ||
3739 strstart(filename, "telnet:", &p)) {
3740 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3741 host[0] = 0;
3742 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3743 goto fail;
3745 qemu_opt_set(opts, "backend", "socket", &error_abort);
3746 qemu_opt_set(opts, "host", host, &error_abort);
3747 qemu_opt_set(opts, "port", port, &error_abort);
3748 if (p[pos] == ',') {
3749 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3750 if (local_err) {
3751 error_report_err(local_err);
3752 goto fail;
3755 if (strstart(filename, "telnet:", &p))
3756 qemu_opt_set(opts, "telnet", "on", &error_abort);
3757 return opts;
3759 if (strstart(filename, "udp:", &p)) {
3760 qemu_opt_set(opts, "backend", "udp", &error_abort);
3761 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3762 host[0] = 0;
3763 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3764 goto fail;
3767 qemu_opt_set(opts, "host", host, &error_abort);
3768 qemu_opt_set(opts, "port", port, &error_abort);
3769 if (p[pos] == '@') {
3770 p += pos + 1;
3771 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3772 host[0] = 0;
3773 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3774 goto fail;
3777 qemu_opt_set(opts, "localaddr", host, &error_abort);
3778 qemu_opt_set(opts, "localport", port, &error_abort);
3780 return opts;
3782 if (strstart(filename, "unix:", &p)) {
3783 qemu_opt_set(opts, "backend", "socket", &error_abort);
3784 qemu_opts_do_parse(opts, p, "path", &local_err);
3785 if (local_err) {
3786 error_report_err(local_err);
3787 goto fail;
3789 return opts;
3791 if (strstart(filename, "/dev/parport", NULL) ||
3792 strstart(filename, "/dev/ppi", NULL)) {
3793 qemu_opt_set(opts, "backend", "parport", &error_abort);
3794 qemu_opt_set(opts, "path", filename, &error_abort);
3795 return opts;
3797 if (strstart(filename, "/dev/", NULL)) {
3798 qemu_opt_set(opts, "backend", "tty", &error_abort);
3799 qemu_opt_set(opts, "path", filename, &error_abort);
3800 return opts;
3803 fail:
3804 qemu_opts_del(opts);
3805 return NULL;
3808 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3810 const char *logfile = qemu_opt_get(opts, "logfile");
3812 backend->has_logfile = logfile != NULL;
3813 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3815 backend->has_logappend = true;
3816 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3820 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3821 Error **errp)
3823 const char *path = qemu_opt_get(opts, "path");
3824 ChardevFile *file;
3826 if (path == NULL) {
3827 error_setg(errp, "chardev: file: no filename given");
3828 return;
3830 file = backend->u.file.data = g_new0(ChardevFile, 1);
3831 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3832 file->out = g_strdup(path);
3834 file->has_append = true;
3835 file->append = qemu_opt_get_bool(opts, "append", false);
3838 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3839 Error **errp)
3841 ChardevStdio *stdio;
3843 stdio = backend->u.stdio.data = g_new0(ChardevStdio, 1);
3844 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3845 stdio->has_signal = true;
3846 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3849 static const CharDriver stdio_driver = {
3850 .kind = CHARDEV_BACKEND_KIND_STDIO,
3851 .parse = qemu_chr_parse_stdio,
3852 .create = qemu_chr_open_stdio,
3853 #ifdef _WIN32
3854 sizeof(WinStdioChardev),
3855 .chr_write = win_stdio_write,
3856 .chr_set_echo = qemu_chr_set_echo_win_stdio,
3857 .chr_free = win_stdio_free,
3858 #else
3859 sizeof(FDChardev),
3860 .chr_add_watch = fd_chr_add_watch,
3861 .chr_write = fd_chr_write,
3862 .chr_update_read_handler = fd_chr_update_read_handler,
3863 .chr_set_echo = qemu_chr_set_echo_stdio,
3864 .chr_free = qemu_chr_free_stdio,
3865 #endif
3868 #ifdef HAVE_CHARDEV_SERIAL
3869 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3870 Error **errp)
3872 const char *device = qemu_opt_get(opts, "path");
3873 ChardevHostdev *serial;
3875 if (device == NULL) {
3876 error_setg(errp, "chardev: serial/tty: no device path given");
3877 return;
3879 serial = backend->u.serial.data = g_new0(ChardevHostdev, 1);
3880 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3881 serial->device = g_strdup(device);
3883 #endif
3885 #ifdef HAVE_CHARDEV_PARPORT
3886 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3887 Error **errp)
3889 const char *device = qemu_opt_get(opts, "path");
3890 ChardevHostdev *parallel;
3892 if (device == NULL) {
3893 error_setg(errp, "chardev: parallel: no device path given");
3894 return;
3896 parallel = backend->u.parallel.data = g_new0(ChardevHostdev, 1);
3897 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3898 parallel->device = g_strdup(device);
3900 #endif
3902 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3903 Error **errp)
3905 const char *device = qemu_opt_get(opts, "path");
3906 ChardevHostdev *dev;
3908 if (device == NULL) {
3909 error_setg(errp, "chardev: pipe: no device path given");
3910 return;
3912 dev = backend->u.pipe.data = g_new0(ChardevHostdev, 1);
3913 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3914 dev->device = g_strdup(device);
3917 static const CharDriver pipe_driver = {
3918 .kind = CHARDEV_BACKEND_KIND_PIPE,
3919 .parse = qemu_chr_parse_pipe,
3920 .create = qemu_chr_open_pipe,
3921 #ifdef _WIN32
3922 sizeof(WinChardev),
3923 .chr_write = win_chr_write,
3924 .chr_free = win_chr_free,
3925 #else
3926 sizeof(FDChardev),
3927 .chr_add_watch = fd_chr_add_watch,
3928 .chr_write = fd_chr_write,
3929 .chr_update_read_handler = fd_chr_update_read_handler,
3930 .chr_free = fd_chr_free,
3931 #endif
3934 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3935 Error **errp)
3937 int val;
3938 ChardevRingbuf *ringbuf;
3940 ringbuf = backend->u.ringbuf.data = g_new0(ChardevRingbuf, 1);
3941 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3943 val = qemu_opt_get_size(opts, "size", 0);
3944 if (val != 0) {
3945 ringbuf->has_size = true;
3946 ringbuf->size = val;
3950 static const CharDriver ringbuf_driver = {
3951 .instance_size = sizeof(RingBufChardev),
3952 .kind = CHARDEV_BACKEND_KIND_RINGBUF,
3953 .parse = qemu_chr_parse_ringbuf,
3954 .create = qemu_chr_open_ringbuf,
3955 .chr_write = ringbuf_chr_write,
3956 .chr_free = ringbuf_chr_free,
3959 /* Bug-compatibility: */
3960 static const CharDriver memory_driver = {
3961 .instance_size = sizeof(RingBufChardev),
3962 .kind = CHARDEV_BACKEND_KIND_MEMORY,
3963 .parse = qemu_chr_parse_ringbuf,
3964 .create = qemu_chr_open_ringbuf,
3965 .chr_write = ringbuf_chr_write,
3966 .chr_free = ringbuf_chr_free,
3969 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3970 Error **errp)
3972 const char *chardev = qemu_opt_get(opts, "chardev");
3973 ChardevMux *mux;
3975 if (chardev == NULL) {
3976 error_setg(errp, "chardev: mux: no chardev given");
3977 return;
3979 mux = backend->u.mux.data = g_new0(ChardevMux, 1);
3980 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
3981 mux->chardev = g_strdup(chardev);
3984 static const CharDriver mux_driver = {
3985 .instance_size = sizeof(MuxChardev),
3986 .kind = CHARDEV_BACKEND_KIND_MUX,
3987 .parse = qemu_chr_parse_mux,
3988 .create = qemu_chr_open_mux,
3989 .chr_free = mux_chr_free,
3990 .chr_write = mux_chr_write,
3991 .chr_accept_input = mux_chr_accept_input,
3992 .chr_add_watch = mux_chr_add_watch,
3995 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3996 Error **errp)
3998 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3999 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
4000 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
4001 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
4002 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
4003 const char *path = qemu_opt_get(opts, "path");
4004 const char *host = qemu_opt_get(opts, "host");
4005 const char *port = qemu_opt_get(opts, "port");
4006 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
4007 SocketAddress *addr;
4008 ChardevSocket *sock;
4010 if (!path) {
4011 if (!host) {
4012 error_setg(errp, "chardev: socket: no host given");
4013 return;
4015 if (!port) {
4016 error_setg(errp, "chardev: socket: no port given");
4017 return;
4019 } else {
4020 if (tls_creds) {
4021 error_setg(errp, "TLS can only be used over TCP socket");
4022 return;
4026 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
4027 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
4029 sock->has_nodelay = true;
4030 sock->nodelay = do_nodelay;
4031 sock->has_server = true;
4032 sock->server = is_listen;
4033 sock->has_telnet = true;
4034 sock->telnet = is_telnet;
4035 sock->has_wait = true;
4036 sock->wait = is_waitconnect;
4037 sock->has_reconnect = true;
4038 sock->reconnect = reconnect;
4039 sock->tls_creds = g_strdup(tls_creds);
4041 addr = g_new0(SocketAddress, 1);
4042 if (path) {
4043 UnixSocketAddress *q_unix;
4044 addr->type = SOCKET_ADDRESS_KIND_UNIX;
4045 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
4046 q_unix->path = g_strdup(path);
4047 } else {
4048 addr->type = SOCKET_ADDRESS_KIND_INET;
4049 addr->u.inet.data = g_new(InetSocketAddress, 1);
4050 *addr->u.inet.data = (InetSocketAddress) {
4051 .host = g_strdup(host),
4052 .port = g_strdup(port),
4053 .has_to = qemu_opt_get(opts, "to"),
4054 .to = qemu_opt_get_number(opts, "to", 0),
4055 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
4056 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
4057 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
4058 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
4061 sock->addr = addr;
4064 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
4065 Error **errp)
4067 const char *host = qemu_opt_get(opts, "host");
4068 const char *port = qemu_opt_get(opts, "port");
4069 const char *localaddr = qemu_opt_get(opts, "localaddr");
4070 const char *localport = qemu_opt_get(opts, "localport");
4071 bool has_local = false;
4072 SocketAddress *addr;
4073 ChardevUdp *udp;
4075 if (host == NULL || strlen(host) == 0) {
4076 host = "localhost";
4078 if (port == NULL || strlen(port) == 0) {
4079 error_setg(errp, "chardev: udp: remote port not specified");
4080 return;
4082 if (localport == NULL || strlen(localport) == 0) {
4083 localport = "0";
4084 } else {
4085 has_local = true;
4087 if (localaddr == NULL || strlen(localaddr) == 0) {
4088 localaddr = "";
4089 } else {
4090 has_local = true;
4093 udp = backend->u.udp.data = g_new0(ChardevUdp, 1);
4094 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
4096 addr = g_new0(SocketAddress, 1);
4097 addr->type = SOCKET_ADDRESS_KIND_INET;
4098 addr->u.inet.data = g_new(InetSocketAddress, 1);
4099 *addr->u.inet.data = (InetSocketAddress) {
4100 .host = g_strdup(host),
4101 .port = g_strdup(port),
4102 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
4103 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
4104 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
4105 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
4107 udp->remote = addr;
4109 if (has_local) {
4110 udp->has_local = true;
4111 addr = g_new0(SocketAddress, 1);
4112 addr->type = SOCKET_ADDRESS_KIND_INET;
4113 addr->u.inet.data = g_new(InetSocketAddress, 1);
4114 *addr->u.inet.data = (InetSocketAddress) {
4115 .host = g_strdup(localaddr),
4116 .port = g_strdup(localport),
4118 udp->local = addr;
4122 static const CharDriver *backends[CHARDEV_BACKEND_KIND__MAX];
4124 void register_char_driver(const CharDriver *driver)
4126 backends[driver->kind] = driver;
4129 Chardev *qemu_chr_new_from_opts(QemuOpts *opts,
4130 Error **errp)
4132 Error *local_err = NULL;
4133 const CharDriver *cd = NULL;
4134 Chardev *chr;
4135 int i;
4136 ChardevReturn *ret = NULL;
4137 ChardevBackend *backend;
4138 const char *name = qemu_opt_get(opts, "backend");
4139 const char *id = qemu_opts_id(opts);
4140 char *bid = NULL;
4142 if (name == NULL) {
4143 error_setg(errp, "chardev: \"%s\" missing backend",
4144 qemu_opts_id(opts));
4145 goto err;
4148 if (is_help_option(name)) {
4149 GString *str = g_string_new("");
4150 for (i = 0; i < ARRAY_SIZE(backends); i++) {
4151 cd = backends[i];
4152 if (cd) {
4153 g_string_append_printf(str, "\n%s", ChardevBackendKind_lookup[cd->kind]);
4154 if (cd->alias) {
4155 g_string_append_printf(str, "\n%s", cd->alias);
4160 error_report("Available chardev backend types: %s", str->str);
4161 g_string_free(str, true);
4162 exit(0);
4165 if (id == NULL) {
4166 error_setg(errp, "chardev: no id specified");
4167 goto err;
4170 for (i = 0; i < ARRAY_SIZE(backends); i++) {
4171 cd = backends[i];
4172 if (!cd) {
4173 continue;
4175 if (g_strcmp0(ChardevBackendKind_lookup[cd->kind], name) == 0 ||
4176 g_strcmp0(cd->alias, name) == 0) {
4177 break;
4180 if (i == ARRAY_SIZE(backends)) {
4181 error_setg(errp, "chardev: backend \"%s\" not found", name);
4182 goto err;
4185 backend = g_new0(ChardevBackend, 1);
4187 if (qemu_opt_get_bool(opts, "mux", 0)) {
4188 bid = g_strdup_printf("%s-base", id);
4191 chr = NULL;
4192 backend->type = cd->kind;
4193 if (cd->parse) {
4194 cd->parse(opts, backend, &local_err);
4195 if (local_err) {
4196 error_propagate(errp, local_err);
4197 goto qapi_out;
4199 } else {
4200 ChardevCommon *cc = g_new0(ChardevCommon, 1);
4201 qemu_chr_parse_common(opts, cc);
4202 backend->u.null.data = cc; /* Any ChardevCommon member would work */
4205 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
4206 if (!ret) {
4207 goto qapi_out;
4210 if (bid) {
4211 qapi_free_ChardevBackend(backend);
4212 qapi_free_ChardevReturn(ret);
4213 backend = g_new0(ChardevBackend, 1);
4214 backend->u.mux.data = g_new0(ChardevMux, 1);
4215 backend->type = CHARDEV_BACKEND_KIND_MUX;
4216 backend->u.mux.data->chardev = g_strdup(bid);
4217 ret = qmp_chardev_add(id, backend, errp);
4218 if (!ret) {
4219 chr = qemu_chr_find(bid);
4220 qemu_chr_delete(chr);
4221 chr = NULL;
4222 goto qapi_out;
4226 chr = qemu_chr_find(id);
4228 qapi_out:
4229 qapi_free_ChardevBackend(backend);
4230 qapi_free_ChardevReturn(ret);
4231 g_free(bid);
4232 return chr;
4234 err:
4235 return NULL;
4238 Chardev *qemu_chr_new_noreplay(const char *label, const char *filename)
4240 const char *p;
4241 Chardev *chr;
4242 QemuOpts *opts;
4243 Error *err = NULL;
4245 if (strstart(filename, "chardev:", &p)) {
4246 return qemu_chr_find(p);
4249 opts = qemu_chr_parse_compat(label, filename);
4250 if (!opts)
4251 return NULL;
4253 chr = qemu_chr_new_from_opts(opts, &err);
4254 if (err) {
4255 error_report_err(err);
4257 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
4258 monitor_init(chr, MONITOR_USE_READLINE);
4260 qemu_opts_del(opts);
4261 return chr;
4264 Chardev *qemu_chr_new(const char *label, const char *filename)
4266 Chardev *chr;
4267 chr = qemu_chr_new_noreplay(label, filename);
4268 if (chr) {
4269 if (replay_mode != REPLAY_MODE_NONE) {
4270 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_REPLAY);
4272 if (qemu_chr_replay(chr) && chr->driver->chr_ioctl) {
4273 error_report("Replay: ioctl is not supported "
4274 "for serial devices yet");
4276 replay_register_char_driver(chr);
4278 return chr;
4281 void qemu_chr_fe_set_echo(CharBackend *be, bool echo)
4283 Chardev *chr = be->chr;
4285 if (chr && chr->driver->chr_set_echo) {
4286 chr->driver->chr_set_echo(chr, echo);
4290 void qemu_chr_fe_set_open(CharBackend *be, int fe_open)
4292 Chardev *chr = be->chr;
4294 if (!chr) {
4295 return;
4298 if (be->fe_open == fe_open) {
4299 return;
4301 be->fe_open = fe_open;
4302 if (chr->driver->chr_set_fe_open) {
4303 chr->driver->chr_set_fe_open(chr, fe_open);
4307 guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
4308 GIOFunc func, void *user_data)
4310 Chardev *s = be->chr;
4311 GSource *src;
4312 guint tag;
4314 if (!s || s->driver->chr_add_watch == NULL) {
4315 return 0;
4318 src = s->driver->chr_add_watch(s, cond);
4319 if (!src) {
4320 return 0;
4323 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
4324 tag = g_source_attach(src, NULL);
4325 g_source_unref(src);
4327 return tag;
4330 void qemu_chr_fe_disconnect(CharBackend *be)
4332 Chardev *chr = be->chr;
4334 if (chr && chr->driver->chr_disconnect) {
4335 chr->driver->chr_disconnect(chr);
4339 static void qemu_chr_free_common(Chardev *chr)
4341 if (chr->be) {
4342 chr->be->chr = NULL;
4344 g_free(chr->filename);
4345 g_free(chr->label);
4346 if (chr->logfd != -1) {
4347 close(chr->logfd);
4349 qemu_mutex_destroy(&chr->chr_write_lock);
4350 g_free(chr);
4353 void qemu_chr_free(Chardev *chr)
4355 if (chr->driver->chr_free) {
4356 chr->driver->chr_free(chr);
4358 qemu_chr_free_common(chr);
4361 void qemu_chr_delete(Chardev *chr)
4363 QTAILQ_REMOVE(&chardevs, chr, next);
4364 qemu_chr_free(chr);
4367 ChardevInfoList *qmp_query_chardev(Error **errp)
4369 ChardevInfoList *chr_list = NULL;
4370 Chardev *chr;
4372 QTAILQ_FOREACH(chr, &chardevs, next) {
4373 ChardevInfoList *info = g_malloc0(sizeof(*info));
4374 info->value = g_malloc0(sizeof(*info->value));
4375 info->value->label = g_strdup(chr->label);
4376 info->value->filename = g_strdup(chr->filename);
4377 info->value->frontend_open = chr->be && chr->be->fe_open;
4379 info->next = chr_list;
4380 chr_list = info;
4383 return chr_list;
4386 static ChardevBackendInfoList *
4387 qmp_prepend_backend(ChardevBackendInfoList *list, const char *name)
4389 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
4390 info->value = g_malloc0(sizeof(*info->value));
4391 info->value->name = g_strdup(name);
4392 info->next = list;
4393 return info;
4396 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
4398 ChardevBackendInfoList *backend_list = NULL;
4399 const CharDriver *c;
4400 int i;
4402 for (i = 0; i < ARRAY_SIZE(backends); i++) {
4403 c = backends[i];
4404 if (!c) {
4405 continue;
4408 backend_list = qmp_prepend_backend(backend_list,
4409 ChardevBackendKind_lookup[c->kind]);
4410 if (c->alias) {
4411 backend_list = qmp_prepend_backend(backend_list, c->alias);
4415 return backend_list;
4418 Chardev *qemu_chr_find(const char *name)
4420 Chardev *chr;
4422 QTAILQ_FOREACH(chr, &chardevs, next) {
4423 if (strcmp(chr->label, name) != 0)
4424 continue;
4425 return chr;
4427 return NULL;
4430 QemuOptsList qemu_chardev_opts = {
4431 .name = "chardev",
4432 .implied_opt_name = "backend",
4433 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4434 .desc = {
4436 .name = "backend",
4437 .type = QEMU_OPT_STRING,
4439 .name = "path",
4440 .type = QEMU_OPT_STRING,
4442 .name = "host",
4443 .type = QEMU_OPT_STRING,
4445 .name = "port",
4446 .type = QEMU_OPT_STRING,
4448 .name = "localaddr",
4449 .type = QEMU_OPT_STRING,
4451 .name = "localport",
4452 .type = QEMU_OPT_STRING,
4454 .name = "to",
4455 .type = QEMU_OPT_NUMBER,
4457 .name = "ipv4",
4458 .type = QEMU_OPT_BOOL,
4460 .name = "ipv6",
4461 .type = QEMU_OPT_BOOL,
4463 .name = "wait",
4464 .type = QEMU_OPT_BOOL,
4466 .name = "server",
4467 .type = QEMU_OPT_BOOL,
4469 .name = "delay",
4470 .type = QEMU_OPT_BOOL,
4472 .name = "reconnect",
4473 .type = QEMU_OPT_NUMBER,
4475 .name = "telnet",
4476 .type = QEMU_OPT_BOOL,
4478 .name = "tls-creds",
4479 .type = QEMU_OPT_STRING,
4481 .name = "width",
4482 .type = QEMU_OPT_NUMBER,
4484 .name = "height",
4485 .type = QEMU_OPT_NUMBER,
4487 .name = "cols",
4488 .type = QEMU_OPT_NUMBER,
4490 .name = "rows",
4491 .type = QEMU_OPT_NUMBER,
4493 .name = "mux",
4494 .type = QEMU_OPT_BOOL,
4496 .name = "signal",
4497 .type = QEMU_OPT_BOOL,
4499 .name = "name",
4500 .type = QEMU_OPT_STRING,
4502 .name = "debug",
4503 .type = QEMU_OPT_NUMBER,
4505 .name = "size",
4506 .type = QEMU_OPT_SIZE,
4508 .name = "chardev",
4509 .type = QEMU_OPT_STRING,
4511 .name = "append",
4512 .type = QEMU_OPT_BOOL,
4514 .name = "logfile",
4515 .type = QEMU_OPT_STRING,
4517 .name = "logappend",
4518 .type = QEMU_OPT_BOOL,
4520 { /* end of list */ }
4524 #ifdef _WIN32
4526 static Chardev *qmp_chardev_open_file(const CharDriver *driver,
4527 const char *id,
4528 ChardevBackend *backend,
4529 ChardevReturn *ret,
4530 bool *be_opened,
4531 Error **errp)
4533 ChardevFile *file = backend->u.file.data;
4534 ChardevCommon *common = qapi_ChardevFile_base(file);
4535 HANDLE out;
4536 DWORD accessmode;
4537 DWORD flags;
4539 if (file->has_in) {
4540 error_setg(errp, "input file not supported");
4541 return NULL;
4544 if (file->has_append && file->append) {
4545 /* Append to file if it already exists. */
4546 accessmode = FILE_GENERIC_WRITE & ~FILE_WRITE_DATA;
4547 flags = OPEN_ALWAYS;
4548 } else {
4549 /* Truncate file if it already exists. */
4550 accessmode = GENERIC_WRITE;
4551 flags = CREATE_ALWAYS;
4554 out = CreateFile(file->out, accessmode, FILE_SHARE_READ, NULL, flags,
4555 FILE_ATTRIBUTE_NORMAL, NULL);
4556 if (out == INVALID_HANDLE_VALUE) {
4557 error_setg(errp, "open %s failed", file->out);
4558 return NULL;
4560 return qemu_chr_open_win_file(driver, out, common, errp);
4563 static Chardev *qmp_chardev_open_serial(const CharDriver *driver,
4564 const char *id,
4565 ChardevBackend *backend,
4566 ChardevReturn *ret,
4567 bool *be_opened,
4568 Error **errp)
4570 ChardevHostdev *serial = backend->u.serial.data;
4571 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4572 Chardev *chr;
4574 chr = qemu_chr_alloc(driver, common, errp);
4575 if (!chr) {
4576 return NULL;
4579 if (win_chr_init(chr, serial->device, errp) < 0) {
4580 qemu_chr_free_common(chr);
4581 return NULL;
4584 return chr;
4587 #else /* WIN32 */
4589 static int qmp_chardev_open_file_source(char *src, int flags,
4590 Error **errp)
4592 int fd = -1;
4594 TFR(fd = qemu_open(src, flags, 0666));
4595 if (fd == -1) {
4596 error_setg_file_open(errp, errno, src);
4598 return fd;
4601 static Chardev *qmp_chardev_open_file(const CharDriver *driver,
4602 const char *id,
4603 ChardevBackend *backend,
4604 ChardevReturn *ret,
4605 bool *be_opened,
4606 Error **errp)
4608 ChardevFile *file = backend->u.file.data;
4609 ChardevCommon *common = qapi_ChardevFile_base(file);
4610 int flags, in = -1, out;
4612 flags = O_WRONLY | O_CREAT | O_BINARY;
4613 if (file->has_append && file->append) {
4614 flags |= O_APPEND;
4615 } else {
4616 flags |= O_TRUNC;
4619 out = qmp_chardev_open_file_source(file->out, flags, errp);
4620 if (out < 0) {
4621 return NULL;
4624 if (file->has_in) {
4625 flags = O_RDONLY;
4626 in = qmp_chardev_open_file_source(file->in, flags, errp);
4627 if (in < 0) {
4628 qemu_close(out);
4629 return NULL;
4633 return qemu_chr_open_fd(driver, in, out, common, errp);
4636 #ifdef HAVE_CHARDEV_SERIAL
4637 static Chardev *qmp_chardev_open_serial(const CharDriver *driver,
4638 const char *id,
4639 ChardevBackend *backend,
4640 ChardevReturn *ret,
4641 bool *be_opened,
4642 Error **errp)
4644 ChardevHostdev *serial = backend->u.serial.data;
4645 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4646 int fd;
4648 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4649 if (fd < 0) {
4650 return NULL;
4652 qemu_set_nonblock(fd);
4653 tty_serial_init(fd, 115200, 'N', 8, 1);
4655 return qemu_chr_open_fd(driver, fd, fd, common, errp);
4657 #endif
4659 #ifdef HAVE_CHARDEV_PARPORT
4660 static Chardev *qmp_chardev_open_parallel(const CharDriver *driver,
4661 const char *id,
4662 ChardevBackend *backend,
4663 ChardevReturn *ret,
4664 bool *be_opened,
4665 Error **errp)
4667 ChardevHostdev *parallel = backend->u.parallel.data;
4668 ChardevCommon *common = qapi_ChardevHostdev_base(parallel);
4669 int fd;
4671 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4672 if (fd < 0) {
4673 return NULL;
4675 return qemu_chr_open_pp_fd(driver, fd, common, be_opened, errp);
4678 static const CharDriver parallel_driver = {
4679 .instance_size = sizeof(ParallelChardev),
4680 .kind = CHARDEV_BACKEND_KIND_PARALLEL,
4681 .alias = "parport",
4682 .parse = qemu_chr_parse_parallel,
4683 .create = qmp_chardev_open_parallel,
4684 #if defined(__linux__)
4685 .chr_write = null_chr_write,
4686 .chr_ioctl = pp_ioctl,
4687 .chr_free = pp_free,
4688 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4689 .chr_write = null_chr_write,
4690 .chr_ioctl = pp_ioctl,
4691 /* FIXME: no chr_free */
4692 #endif
4694 #endif
4696 #endif /* WIN32 */
4698 static const CharDriver file_driver = {
4699 .kind = CHARDEV_BACKEND_KIND_FILE,
4700 .parse = qemu_chr_parse_file_out,
4701 .create = qmp_chardev_open_file,
4702 #ifdef _WIN32
4703 sizeof(WinChardev),
4704 .chr_write = win_chr_write,
4705 /* FIXME: no chr_free */
4706 #else
4707 sizeof(FDChardev),
4708 .chr_add_watch = fd_chr_add_watch,
4709 .chr_write = fd_chr_write,
4710 .chr_update_read_handler = fd_chr_update_read_handler,
4711 .chr_free = fd_chr_free,
4712 #endif
4715 #ifdef HAVE_CHARDEV_SERIAL
4716 static const CharDriver serial_driver = {
4717 .kind = CHARDEV_BACKEND_KIND_SERIAL,
4718 .alias = "tty",
4719 .parse = qemu_chr_parse_serial,
4720 .create = qmp_chardev_open_serial,
4721 #ifdef _WIN32
4722 sizeof(WinChardev),
4723 .chr_write = win_chr_write,
4724 .chr_free = win_chr_free,
4725 #else
4726 sizeof(FDChardev),
4727 .chr_add_watch = fd_chr_add_watch,
4728 .chr_write = fd_chr_write,
4729 .chr_update_read_handler = fd_chr_update_read_handler,
4730 .chr_ioctl = tty_serial_ioctl,
4731 .chr_free = qemu_chr_free_tty,
4732 #endif
4734 #endif
4736 static gboolean socket_reconnect_timeout(gpointer opaque)
4738 Chardev *chr = opaque;
4739 SocketChardev *s = opaque;
4740 QIOChannelSocket *sioc;
4742 s->reconnect_timer = 0;
4744 if (chr->be_open) {
4745 return false;
4748 sioc = qio_channel_socket_new();
4749 tcp_chr_set_client_ioc_name(chr, sioc);
4750 qio_channel_socket_connect_async(sioc, s->addr,
4751 qemu_chr_socket_connected,
4752 chr, NULL);
4754 return false;
4757 static Chardev *qmp_chardev_open_socket(const CharDriver *driver,
4758 const char *id,
4759 ChardevBackend *backend,
4760 ChardevReturn *ret,
4761 bool *be_opened,
4762 Error **errp)
4764 Chardev *chr;
4765 SocketChardev *s;
4766 ChardevSocket *sock = backend->u.socket.data;
4767 SocketAddress *addr = sock->addr;
4768 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4769 bool is_listen = sock->has_server ? sock->server : true;
4770 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4771 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4772 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4773 ChardevCommon *common = qapi_ChardevSocket_base(sock);
4774 QIOChannelSocket *sioc = NULL;
4776 chr = qemu_chr_alloc(driver, common, errp);
4777 if (!chr) {
4778 return NULL;
4780 s = (SocketChardev *)chr;
4782 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4783 s->is_listen = is_listen;
4784 s->is_telnet = is_telnet;
4785 s->do_nodelay = do_nodelay;
4786 if (sock->tls_creds) {
4787 Object *creds;
4788 creds = object_resolve_path_component(
4789 object_get_objects_root(), sock->tls_creds);
4790 if (!creds) {
4791 error_setg(errp, "No TLS credentials with id '%s'",
4792 sock->tls_creds);
4793 goto error;
4795 s->tls_creds = (QCryptoTLSCreds *)
4796 object_dynamic_cast(creds,
4797 TYPE_QCRYPTO_TLS_CREDS);
4798 if (!s->tls_creds) {
4799 error_setg(errp, "Object with id '%s' is not TLS credentials",
4800 sock->tls_creds);
4801 goto error;
4803 object_ref(OBJECT(s->tls_creds));
4804 if (is_listen) {
4805 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4806 error_setg(errp, "%s",
4807 "Expected TLS credentials for server endpoint");
4808 goto error;
4810 } else {
4811 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4812 error_setg(errp, "%s",
4813 "Expected TLS credentials for client endpoint");
4814 goto error;
4819 s->addr = QAPI_CLONE(SocketAddress, sock->addr);
4821 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
4822 if (s->is_unix) {
4823 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
4826 /* be isn't opened until we get a connection */
4827 *be_opened = false;
4829 chr->filename = SocketAddress_to_str("disconnected:",
4830 addr, is_listen, is_telnet);
4832 if (is_listen) {
4833 if (is_telnet) {
4834 s->do_telnetopt = 1;
4836 } else if (reconnect > 0) {
4837 s->reconnect_time = reconnect;
4840 if (s->reconnect_time) {
4841 sioc = qio_channel_socket_new();
4842 tcp_chr_set_client_ioc_name(chr, sioc);
4843 qio_channel_socket_connect_async(sioc, s->addr,
4844 qemu_chr_socket_connected,
4845 chr, NULL);
4846 } else {
4847 if (s->is_listen) {
4848 char *name;
4849 sioc = qio_channel_socket_new();
4851 name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
4852 qio_channel_set_name(QIO_CHANNEL(sioc), name);
4853 g_free(name);
4855 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4856 goto error;
4858 s->listen_ioc = sioc;
4859 if (is_waitconnect &&
4860 qemu_chr_wait_connected(chr, errp) < 0) {
4861 goto error;
4863 if (!s->ioc) {
4864 s->listen_tag = qio_channel_add_watch(
4865 QIO_CHANNEL(s->listen_ioc), G_IO_IN,
4866 tcp_chr_accept, chr, NULL);
4868 } else if (qemu_chr_wait_connected(chr, errp) < 0) {
4869 goto error;
4873 return chr;
4875 error:
4876 if (sioc) {
4877 object_unref(OBJECT(sioc));
4879 if (s->tls_creds) {
4880 object_unref(OBJECT(s->tls_creds));
4882 qemu_chr_free_common(chr);
4883 return NULL;
4886 static const CharDriver socket_driver = {
4887 .instance_size = sizeof(SocketChardev),
4888 .kind = CHARDEV_BACKEND_KIND_SOCKET,
4889 .parse = qemu_chr_parse_socket,
4890 .create = qmp_chardev_open_socket,
4891 .chr_wait_connected = tcp_chr_wait_connected,
4892 .chr_write = tcp_chr_write,
4893 .chr_sync_read = tcp_chr_sync_read,
4894 .chr_disconnect = tcp_chr_disconnect,
4895 .get_msgfds = tcp_get_msgfds,
4896 .set_msgfds = tcp_set_msgfds,
4897 .chr_add_client = tcp_chr_add_client,
4898 .chr_add_watch = tcp_chr_add_watch,
4899 .chr_update_read_handler = tcp_chr_update_read_handler,
4900 .chr_free = tcp_chr_free,
4903 static Chardev *qmp_chardev_open_udp(const CharDriver *driver,
4904 const char *id,
4905 ChardevBackend *backend,
4906 ChardevReturn *ret,
4907 bool *be_opened,
4908 Error **errp)
4910 ChardevUdp *udp = backend->u.udp.data;
4911 ChardevCommon *common = qapi_ChardevUdp_base(udp);
4912 QIOChannelSocket *sioc = qio_channel_socket_new();
4913 char *name;
4914 Chardev *chr;
4915 UdpChardev *s;
4917 if (qio_channel_socket_dgram_sync(sioc,
4918 udp->local, udp->remote,
4919 errp) < 0) {
4920 object_unref(OBJECT(sioc));
4921 return NULL;
4924 chr = qemu_chr_alloc(driver, common, errp);
4925 if (!chr) {
4926 return NULL;
4929 name = g_strdup_printf("chardev-udp-%s", chr->label);
4930 qio_channel_set_name(QIO_CHANNEL(sioc), name);
4931 g_free(name);
4933 s = (UdpChardev *)chr;
4934 s->ioc = QIO_CHANNEL(sioc);
4935 /* be isn't opened until we get a connection */
4936 *be_opened = false;
4938 return chr;
4941 static const CharDriver udp_driver = {
4942 .instance_size = sizeof(UdpChardev),
4943 .kind = CHARDEV_BACKEND_KIND_UDP,
4944 .parse = qemu_chr_parse_udp,
4945 .create = qmp_chardev_open_udp,
4946 .chr_write = udp_chr_write,
4947 .chr_update_read_handler = udp_chr_update_read_handler,
4948 .chr_free = udp_chr_free,
4951 bool qemu_chr_has_feature(Chardev *chr,
4952 CharDriverFeature feature)
4954 return test_bit(feature, chr->features);
4957 void qemu_chr_set_feature(Chardev *chr,
4958 CharDriverFeature feature)
4960 return set_bit(feature, chr->features);
4963 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4964 Error **errp)
4966 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4967 Chardev *chr = NULL;
4968 const CharDriver *cd;
4969 Error *local_err = NULL;
4970 bool be_opened = true;
4972 chr = qemu_chr_find(id);
4973 if (chr) {
4974 error_setg(errp, "Chardev '%s' already exists", id);
4975 goto out_error;
4978 cd = (int)backend->type >= 0 && backend->type < ARRAY_SIZE(backends) ?
4979 backends[backend->type] : NULL;
4980 if (cd == NULL) {
4981 error_setg(errp, "chardev backend not available");
4982 goto out_error;
4985 chr = cd->create(cd, id, backend, ret, &be_opened, &local_err);
4986 if (local_err) {
4987 error_propagate(errp, local_err);
4988 goto out_error;
4991 chr->label = g_strdup(id);
4992 if (!chr->filename) {
4993 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4995 if (be_opened) {
4996 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4998 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4999 return ret;
5001 out_error:
5002 g_free(ret);
5003 return NULL;
5006 void qmp_chardev_remove(const char *id, Error **errp)
5008 Chardev *chr;
5010 chr = qemu_chr_find(id);
5011 if (chr == NULL) {
5012 error_setg(errp, "Chardev '%s' not found", id);
5013 return;
5015 if (qemu_chr_is_busy(chr)) {
5016 error_setg(errp, "Chardev '%s' is busy", id);
5017 return;
5019 if (qemu_chr_replay(chr)) {
5020 error_setg(errp,
5021 "Chardev '%s' cannot be unplugged in record/replay mode", id);
5022 return;
5024 qemu_chr_delete(chr);
5027 void qemu_chr_cleanup(void)
5029 Chardev *chr, *tmp;
5031 QTAILQ_FOREACH_SAFE(chr, &chardevs, next, tmp) {
5032 qemu_chr_delete(chr);
5036 static void register_types(void)
5038 static const CharDriver *drivers[] = {
5039 &null_driver,
5040 &socket_driver,
5041 &udp_driver,
5042 &ringbuf_driver,
5043 &file_driver,
5044 &stdio_driver,
5045 #ifdef HAVE_CHARDEV_SERIAL
5046 &serial_driver,
5047 #endif
5048 #ifdef HAVE_CHARDEV_PARPORT
5049 &parallel_driver,
5050 #endif
5051 #ifdef HAVE_CHARDEV_PTY
5052 &pty_driver,
5053 #endif
5054 #ifdef _WIN32
5055 &console_driver,
5056 #endif
5057 &pipe_driver,
5058 &mux_driver,
5059 &memory_driver
5061 int i;
5063 for (i = 0; i < ARRAY_SIZE(drivers); i++) {
5064 register_char_driver(drivers[i]);
5067 /* this must be done after machine init, since we register FEs with muxes
5068 * as part of realize functions like serial_isa_realizefn when -nographic
5069 * is specified
5071 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
5074 type_init(register_types);