char-fd: convert to finalize
[qemu/ar7.git] / qemu-char.c
blob3d0d69099913bb7432c93ef86d4849f690973972
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 void qemu_chr_be_event(Chardev *s, int event)
165 CharBackend *be = s->be;
167 /* Keep track if the char device is open */
168 switch (event) {
169 case CHR_EVENT_OPENED:
170 s->be_open = 1;
171 break;
172 case CHR_EVENT_CLOSED:
173 s->be_open = 0;
174 break;
177 if (!be || !be->chr_event) {
178 return;
181 be->chr_event(be->opaque, event);
184 void qemu_chr_be_generic_open(Chardev *s)
186 qemu_chr_be_event(s, CHR_EVENT_OPENED);
190 /* Not reporting errors from writing to logfile, as logs are
191 * defined to be "best effort" only */
192 static void qemu_chr_fe_write_log(Chardev *s,
193 const uint8_t *buf, size_t len)
195 size_t done = 0;
196 ssize_t ret;
198 if (s->logfd < 0) {
199 return;
202 while (done < len) {
203 retry:
204 ret = write(s->logfd, buf + done, len - done);
205 if (ret == -1 && errno == EAGAIN) {
206 g_usleep(100);
207 goto retry;
210 if (ret <= 0) {
211 return;
213 done += ret;
217 static int qemu_chr_fe_write_buffer(Chardev *s,
218 const uint8_t *buf, int len, int *offset)
220 ChardevClass *cc = CHARDEV_GET_CLASS(s);
221 int res = 0;
222 *offset = 0;
224 qemu_mutex_lock(&s->chr_write_lock);
225 while (*offset < len) {
226 retry:
227 res = cc->chr_write(s, buf + *offset, len - *offset);
228 if (res < 0 && errno == EAGAIN) {
229 g_usleep(100);
230 goto retry;
233 if (res <= 0) {
234 break;
237 *offset += res;
239 if (*offset > 0) {
240 qemu_chr_fe_write_log(s, buf, *offset);
242 qemu_mutex_unlock(&s->chr_write_lock);
244 return res;
247 static bool qemu_chr_replay(Chardev *chr)
249 return qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_REPLAY);
252 int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len)
254 Chardev *s = be->chr;
255 ChardevClass *cc;
256 int ret;
258 if (!s) {
259 return 0;
262 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
263 int offset;
264 replay_char_write_event_load(&ret, &offset);
265 assert(offset <= len);
266 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
267 return ret;
270 cc = CHARDEV_GET_CLASS(s);
271 qemu_mutex_lock(&s->chr_write_lock);
272 ret = cc->chr_write(s, buf, len);
274 if (ret > 0) {
275 qemu_chr_fe_write_log(s, buf, ret);
278 qemu_mutex_unlock(&s->chr_write_lock);
280 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
281 replay_char_write_event_save(ret, ret < 0 ? 0 : ret);
284 return ret;
287 static int qemu_chr_write_all(Chardev *s, const uint8_t *buf, int len)
289 int offset;
290 int res;
292 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
293 replay_char_write_event_load(&res, &offset);
294 assert(offset <= len);
295 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
296 return res;
299 res = qemu_chr_fe_write_buffer(s, buf, len, &offset);
301 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
302 replay_char_write_event_save(res, offset);
305 if (res < 0) {
306 return res;
308 return offset;
311 int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len)
313 Chardev *s = be->chr;
315 if (!s) {
316 return 0;
319 return qemu_chr_write_all(s, buf, len);
322 int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len)
324 Chardev *s = be->chr;
325 int offset = 0, counter = 10;
326 int res;
328 if (!s || !CHARDEV_GET_CLASS(s)->chr_sync_read) {
329 return 0;
332 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_PLAY) {
333 return replay_char_read_all_load(buf);
336 while (offset < len) {
337 retry:
338 res = CHARDEV_GET_CLASS(s)->chr_sync_read(s, buf + offset,
339 len - offset);
340 if (res == -1 && errno == EAGAIN) {
341 g_usleep(100);
342 goto retry;
345 if (res == 0) {
346 break;
349 if (res < 0) {
350 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
351 replay_char_read_all_save_error(res);
353 return res;
356 offset += res;
358 if (!counter--) {
359 break;
363 if (qemu_chr_replay(s) && replay_mode == REPLAY_MODE_RECORD) {
364 replay_char_read_all_save_buf(buf, offset);
366 return offset;
369 int qemu_chr_fe_ioctl(CharBackend *be, int cmd, void *arg)
371 Chardev *s = be->chr;
372 int res;
374 if (!s || !CHARDEV_GET_CLASS(s)->chr_ioctl || qemu_chr_replay(s)) {
375 res = -ENOTSUP;
376 } else {
377 res = CHARDEV_GET_CLASS(s)->chr_ioctl(s, cmd, arg);
380 return res;
383 int qemu_chr_be_can_write(Chardev *s)
385 CharBackend *be = s->be;
387 if (!be || !be->chr_can_read) {
388 return 0;
391 return be->chr_can_read(be->opaque);
394 void qemu_chr_be_write_impl(Chardev *s, uint8_t *buf, int len)
396 CharBackend *be = s->be;
398 if (be && be->chr_read) {
399 be->chr_read(be->opaque, buf, len);
403 void qemu_chr_be_write(Chardev *s, uint8_t *buf, int len)
405 if (qemu_chr_replay(s)) {
406 if (replay_mode == REPLAY_MODE_PLAY) {
407 return;
409 replay_chr_be_write(s, buf, len);
410 } else {
411 qemu_chr_be_write_impl(s, buf, len);
415 int qemu_chr_fe_get_msgfd(CharBackend *be)
417 Chardev *s = be->chr;
418 int fd;
419 int res = (qemu_chr_fe_get_msgfds(be, &fd, 1) == 1) ? fd : -1;
420 if (s && qemu_chr_replay(s)) {
421 error_report("Replay: get msgfd is not supported "
422 "for serial devices yet");
423 exit(1);
425 return res;
428 int qemu_chr_fe_get_msgfds(CharBackend *be, int *fds, int len)
430 Chardev *s = be->chr;
432 if (!s) {
433 return -1;
436 return CHARDEV_GET_CLASS(s)->get_msgfds ?
437 CHARDEV_GET_CLASS(s)->get_msgfds(s, fds, len) : -1;
440 int qemu_chr_fe_set_msgfds(CharBackend *be, int *fds, int num)
442 Chardev *s = be->chr;
444 if (!s) {
445 return -1;
448 return CHARDEV_GET_CLASS(s)->set_msgfds ?
449 CHARDEV_GET_CLASS(s)->set_msgfds(s, fds, num) : -1;
452 int qemu_chr_add_client(Chardev *s, int fd)
454 return CHARDEV_GET_CLASS(s)->chr_add_client ?
455 CHARDEV_GET_CLASS(s)->chr_add_client(s, fd) : -1;
458 void qemu_chr_fe_accept_input(CharBackend *be)
460 Chardev *s = be->chr;
462 if (!s) {
463 return;
466 if (CHARDEV_GET_CLASS(s)->chr_accept_input) {
467 CHARDEV_GET_CLASS(s)->chr_accept_input(s);
469 qemu_notify_event();
472 void qemu_chr_fe_printf(CharBackend *be, const char *fmt, ...)
474 char buf[READ_BUF_LEN];
475 va_list ap;
476 va_start(ap, fmt);
477 vsnprintf(buf, sizeof(buf), fmt, ap);
478 /* XXX this blocks entire thread. Rewrite to use
479 * qemu_chr_fe_write and background I/O callbacks */
480 qemu_chr_fe_write_all(be, (uint8_t *)buf, strlen(buf));
481 va_end(ap);
484 static void remove_fd_in_watch(Chardev *chr);
485 static void mux_chr_set_handlers(Chardev *chr, GMainContext *context);
486 static void mux_set_focus(Chardev *chr, int focus);
488 static void qemu_char_open(Chardev *chr, ChardevBackend *backend,
489 bool *be_opened, Error **errp)
491 ChardevClass *cc = CHARDEV_GET_CLASS(chr);
492 /* Any ChardevCommon member would work */
493 ChardevCommon *common = backend ? backend->u.null.data : NULL;
495 if (common && common->has_logfile) {
496 int flags = O_WRONLY | O_CREAT;
497 if (common->has_logappend &&
498 common->logappend) {
499 flags |= O_APPEND;
500 } else {
501 flags |= O_TRUNC;
503 chr->logfd = qemu_open(common->logfile, flags, 0666);
504 if (chr->logfd < 0) {
505 error_setg_errno(errp, errno,
506 "Unable to open logfile %s",
507 common->logfile);
508 return;
512 if (cc->open) {
513 cc->open(chr, backend, be_opened, errp);
517 static void char_init(Object *obj)
519 Chardev *chr = CHARDEV(obj);
521 chr->logfd = -1;
522 qemu_mutex_init(&chr->chr_write_lock);
525 static void char_finalize(Object *obj)
527 Chardev *chr = CHARDEV(obj);
529 if (chr->be) {
530 chr->be->chr = NULL;
532 g_free(chr->filename);
533 g_free(chr->label);
534 if (chr->logfd != -1) {
535 close(chr->logfd);
537 qemu_mutex_destroy(&chr->chr_write_lock);
540 static const TypeInfo char_type_info = {
541 .name = TYPE_CHARDEV,
542 .parent = TYPE_OBJECT,
543 .instance_size = sizeof(Chardev),
544 .instance_init = char_init,
545 .instance_finalize = char_finalize,
546 .abstract = true,
547 .class_size = sizeof(ChardevClass),
550 static int null_chr_write(Chardev *chr, const uint8_t *buf, int len)
552 return len;
555 static void null_chr_open(Chardev *chr,
556 ChardevBackend *backend,
557 bool *be_opened,
558 Error **errp)
560 *be_opened = false;
563 static const CharDriver null_driver = {
564 .kind = CHARDEV_BACKEND_KIND_NULL,
567 static void char_null_class_init(ObjectClass *oc, void *data)
569 ChardevClass *cc = CHARDEV_CLASS(oc);
571 cc->open = null_chr_open;
572 cc->chr_write = null_chr_write;
575 static const TypeInfo char_null_type_info = {
576 .name = TYPE_CHARDEV_NULL,
577 .parent = TYPE_CHARDEV,
578 .instance_size = sizeof(Chardev),
579 .class_init = char_null_class_init,
582 /* MUX driver for serial I/O splitting */
583 #define MAX_MUX 4
584 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
585 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
586 struct MuxChardev {
587 Chardev parent;
588 CharBackend *backends[MAX_MUX];
589 CharBackend chr;
590 int focus;
591 int mux_cnt;
592 int term_got_escape;
593 int max_size;
594 /* Intermediate input buffer allows to catch escape sequences even if the
595 currently active device is not accepting any input - but only until it
596 is full as well. */
597 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
598 int prod[MAX_MUX];
599 int cons[MAX_MUX];
600 int timestamps;
602 /* Protected by the Chardev chr_write_lock. */
603 int linestart;
604 int64_t timestamps_start;
607 #define MUX_CHARDEV(obj) OBJECT_CHECK(MuxChardev, (obj), TYPE_CHARDEV_MUX)
609 /* Called with chr_write_lock held. */
610 static int mux_chr_write(Chardev *chr, const uint8_t *buf, int len)
612 MuxChardev *d = MUX_CHARDEV(chr);
613 int ret;
614 if (!d->timestamps) {
615 ret = qemu_chr_fe_write(&d->chr, buf, len);
616 } else {
617 int i;
619 ret = 0;
620 for (i = 0; i < len; i++) {
621 if (d->linestart) {
622 char buf1[64];
623 int64_t ti;
624 int secs;
626 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
627 if (d->timestamps_start == -1)
628 d->timestamps_start = ti;
629 ti -= d->timestamps_start;
630 secs = ti / 1000;
631 snprintf(buf1, sizeof(buf1),
632 "[%02d:%02d:%02d.%03d] ",
633 secs / 3600,
634 (secs / 60) % 60,
635 secs % 60,
636 (int)(ti % 1000));
637 /* XXX this blocks entire thread. Rewrite to use
638 * qemu_chr_fe_write and background I/O callbacks */
639 qemu_chr_fe_write_all(&d->chr,
640 (uint8_t *)buf1, strlen(buf1));
641 d->linestart = 0;
643 ret += qemu_chr_fe_write(&d->chr, buf + i, 1);
644 if (buf[i] == '\n') {
645 d->linestart = 1;
649 return ret;
652 static const char * const mux_help[] = {
653 "% h print this help\n\r",
654 "% x exit emulator\n\r",
655 "% s save disk data back to file (if -snapshot)\n\r",
656 "% t toggle console timestamps\n\r",
657 "% b send break (magic sysrq)\n\r",
658 "% c switch between console and monitor\n\r",
659 "% % sends %\n\r",
660 NULL
663 int term_escape_char = 0x01; /* ctrl-a is used for escape */
664 static void mux_print_help(Chardev *chr)
666 int i, j;
667 char ebuf[15] = "Escape-Char";
668 char cbuf[50] = "\n\r";
670 if (term_escape_char > 0 && term_escape_char < 26) {
671 snprintf(cbuf, sizeof(cbuf), "\n\r");
672 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
673 } else {
674 snprintf(cbuf, sizeof(cbuf),
675 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
676 term_escape_char);
678 /* XXX this blocks entire thread. Rewrite to use
679 * qemu_chr_fe_write and background I/O callbacks */
680 qemu_chr_write_all(chr, (uint8_t *)cbuf, strlen(cbuf));
681 for (i = 0; mux_help[i] != NULL; i++) {
682 for (j=0; mux_help[i][j] != '\0'; j++) {
683 if (mux_help[i][j] == '%')
684 qemu_chr_write_all(chr, (uint8_t *)ebuf, strlen(ebuf));
685 else
686 qemu_chr_write_all(chr, (uint8_t *)&mux_help[i][j], 1);
691 static void mux_chr_send_event(MuxChardev *d, int mux_nr, int event)
693 CharBackend *be = d->backends[mux_nr];
695 if (be && be->chr_event) {
696 be->chr_event(be->opaque, event);
700 static int mux_proc_byte(Chardev *chr, MuxChardev *d, int ch)
702 if (d->term_got_escape) {
703 d->term_got_escape = 0;
704 if (ch == term_escape_char)
705 goto send_char;
706 switch(ch) {
707 case '?':
708 case 'h':
709 mux_print_help(chr);
710 break;
711 case 'x':
713 const char *term = "QEMU: Terminated\n\r";
714 qemu_chr_write_all(chr, (uint8_t *)term, strlen(term));
715 exit(0);
716 break;
718 case 's':
719 blk_commit_all();
720 break;
721 case 'b':
722 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
723 break;
724 case 'c':
725 assert(d->mux_cnt > 0); /* handler registered with first fe */
726 /* Switch to the next registered device */
727 mux_set_focus(chr, (d->focus + 1) % d->mux_cnt);
728 break;
729 case 't':
730 d->timestamps = !d->timestamps;
731 d->timestamps_start = -1;
732 d->linestart = 0;
733 break;
735 } else if (ch == term_escape_char) {
736 d->term_got_escape = 1;
737 } else {
738 send_char:
739 return 1;
741 return 0;
744 static void mux_chr_accept_input(Chardev *chr)
746 MuxChardev *d = MUX_CHARDEV(chr);
747 int m = d->focus;
748 CharBackend *be = d->backends[m];
750 while (be && d->prod[m] != d->cons[m] &&
751 be->chr_can_read && be->chr_can_read(be->opaque)) {
752 be->chr_read(be->opaque,
753 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
757 static int mux_chr_can_read(void *opaque)
759 MuxChardev *d = MUX_CHARDEV(opaque);
760 int m = d->focus;
761 CharBackend *be = d->backends[m];
763 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE) {
764 return 1;
767 if (be && be->chr_can_read) {
768 return be->chr_can_read(be->opaque);
771 return 0;
774 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
776 Chardev *chr = CHARDEV(opaque);
777 MuxChardev *d = MUX_CHARDEV(opaque);
778 int m = d->focus;
779 CharBackend *be = d->backends[m];
780 int i;
782 mux_chr_accept_input(opaque);
784 for (i = 0; i < size; i++)
785 if (mux_proc_byte(chr, d, buf[i])) {
786 if (d->prod[m] == d->cons[m] &&
787 be && be->chr_can_read &&
788 be->chr_can_read(be->opaque))
789 be->chr_read(be->opaque, &buf[i], 1);
790 else
791 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
795 static bool muxes_realized;
797 static void mux_chr_event(void *opaque, int event)
799 MuxChardev *d = MUX_CHARDEV(opaque);
800 int i;
802 if (!muxes_realized) {
803 return;
806 /* Send the event to all registered listeners */
807 for (i = 0; i < d->mux_cnt; i++)
808 mux_chr_send_event(d, i, event);
812 * Called after processing of default and command-line-specified
813 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
814 * to a mux chardev. This is done here to ensure that
815 * output/prompts/banners are only displayed for the FE that has
816 * focus when initial command-line processing/machine init is
817 * completed.
819 * After this point, any new FE attached to any new or existing
820 * mux will receive CHR_EVENT_OPENED notifications for the BE
821 * immediately.
823 static void muxes_realize_done(Notifier *notifier, void *unused)
825 Chardev *chr;
827 QTAILQ_FOREACH(chr, &chardevs, next) {
828 if (CHARDEV_IS_MUX(chr)) {
829 MuxChardev *d = MUX_CHARDEV(chr);
830 int i;
832 /* send OPENED to all already-attached FEs */
833 for (i = 0; i < d->mux_cnt; i++) {
834 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
836 /* mark mux as OPENED so any new FEs will immediately receive
837 * OPENED event
839 qemu_chr_be_generic_open(chr);
842 muxes_realized = true;
845 static Notifier muxes_realize_notify = {
846 .notify = muxes_realize_done,
849 static GSource *mux_chr_add_watch(Chardev *s, GIOCondition cond)
851 MuxChardev *d = MUX_CHARDEV(s);
852 Chardev *chr = qemu_chr_fe_get_driver(&d->chr);
853 ChardevClass *cc = CHARDEV_GET_CLASS(chr);
855 if (!cc->chr_add_watch) {
856 return NULL;
859 return cc->chr_add_watch(chr, cond);
862 static void char_mux_finalize(Object *obj)
864 MuxChardev *d = MUX_CHARDEV(obj);
865 int i;
867 for (i = 0; i < d->mux_cnt; i++) {
868 CharBackend *be = d->backends[i];
869 if (be) {
870 be->chr = NULL;
873 qemu_chr_fe_deinit(&d->chr);
876 static void mux_chr_set_handlers(Chardev *chr, GMainContext *context)
878 MuxChardev *d = MUX_CHARDEV(chr);
880 /* Fix up the real driver with mux routines */
881 qemu_chr_fe_set_handlers(&d->chr,
882 mux_chr_can_read,
883 mux_chr_read,
884 mux_chr_event,
885 chr,
886 context, true);
889 static void mux_set_focus(Chardev *chr, int focus)
891 MuxChardev *d = MUX_CHARDEV(chr);
893 assert(focus >= 0);
894 assert(focus < d->mux_cnt);
896 if (d->focus != -1) {
897 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
900 d->focus = focus;
901 chr->be = d->backends[focus];
902 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
905 static void qemu_chr_open_mux(Chardev *chr,
906 ChardevBackend *backend,
907 bool *be_opened,
908 Error **errp)
910 ChardevMux *mux = backend->u.mux.data;
911 Chardev *drv;
912 MuxChardev *d = MUX_CHARDEV(chr);
914 drv = qemu_chr_find(mux->chardev);
915 if (drv == NULL) {
916 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
917 return;
920 d->focus = -1;
921 /* only default to opened state if we've realized the initial
922 * set of muxes
924 *be_opened = muxes_realized;
925 qemu_chr_fe_init(&d->chr, drv, errp);
928 Chardev *qemu_chr_fe_get_driver(CharBackend *be)
930 return be->chr;
933 bool qemu_chr_fe_init(CharBackend *b, Chardev *s, Error **errp)
935 int tag = 0;
937 if (CHARDEV_IS_MUX(s)) {
938 MuxChardev *d = MUX_CHARDEV(s);
940 if (d->mux_cnt >= MAX_MUX) {
941 goto unavailable;
944 d->backends[d->mux_cnt] = b;
945 tag = d->mux_cnt++;
946 } else if (s->be) {
947 goto unavailable;
948 } else {
949 s->be = b;
952 b->fe_open = false;
953 b->tag = tag;
954 b->chr = s;
955 return true;
957 unavailable:
958 error_setg(errp, QERR_DEVICE_IN_USE, s->label);
959 return false;
962 static bool qemu_chr_is_busy(Chardev *s)
964 if (CHARDEV_IS_MUX(s)) {
965 MuxChardev *d = MUX_CHARDEV(s);
966 return d->mux_cnt >= 0;
967 } else {
968 return s->be != NULL;
972 void qemu_chr_fe_deinit(CharBackend *b)
974 assert(b);
976 if (b->chr) {
977 qemu_chr_fe_set_handlers(b, NULL, NULL, NULL, NULL, NULL, true);
978 if (b->chr->be == b) {
979 b->chr->be = NULL;
981 if (CHARDEV_IS_MUX(b->chr)) {
982 MuxChardev *d = MUX_CHARDEV(b->chr);
983 d->backends[b->tag] = NULL;
985 b->chr = NULL;
989 void qemu_chr_fe_set_handlers(CharBackend *b,
990 IOCanReadHandler *fd_can_read,
991 IOReadHandler *fd_read,
992 IOEventHandler *fd_event,
993 void *opaque,
994 GMainContext *context,
995 bool set_open)
997 Chardev *s;
998 ChardevClass *cc;
999 int fe_open;
1001 s = b->chr;
1002 if (!s) {
1003 return;
1006 cc = CHARDEV_GET_CLASS(s);
1007 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
1008 fe_open = 0;
1009 remove_fd_in_watch(s);
1010 } else {
1011 fe_open = 1;
1013 b->chr_can_read = fd_can_read;
1014 b->chr_read = fd_read;
1015 b->chr_event = fd_event;
1016 b->opaque = opaque;
1017 if (cc->chr_update_read_handler) {
1018 cc->chr_update_read_handler(s, context);
1021 if (set_open) {
1022 qemu_chr_fe_set_open(b, fe_open);
1025 if (fe_open) {
1026 qemu_chr_fe_take_focus(b);
1027 /* We're connecting to an already opened device, so let's make sure we
1028 also get the open event */
1029 if (s->be_open) {
1030 qemu_chr_be_generic_open(s);
1034 if (CHARDEV_IS_MUX(s)) {
1035 mux_chr_set_handlers(s, context);
1039 void qemu_chr_fe_take_focus(CharBackend *b)
1041 if (!b->chr) {
1042 return;
1045 if (CHARDEV_IS_MUX(b->chr)) {
1046 mux_set_focus(b->chr, b->tag);
1050 typedef struct IOWatchPoll
1052 GSource parent;
1054 QIOChannel *ioc;
1055 GSource *src;
1057 IOCanReadHandler *fd_can_read;
1058 GSourceFunc fd_read;
1059 void *opaque;
1060 GMainContext *context;
1061 } IOWatchPoll;
1063 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
1065 return container_of(source, IOWatchPoll, parent);
1068 static gboolean io_watch_poll_prepare(GSource *source,
1069 gint *timeout_)
1071 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1072 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
1073 bool was_active = iwp->src != NULL;
1074 if (was_active == now_active) {
1075 return FALSE;
1078 if (now_active) {
1079 iwp->src = qio_channel_create_watch(
1080 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
1081 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
1082 g_source_attach(iwp->src, iwp->context);
1083 } else {
1084 g_source_destroy(iwp->src);
1085 g_source_unref(iwp->src);
1086 iwp->src = NULL;
1088 return FALSE;
1091 static gboolean io_watch_poll_check(GSource *source)
1093 return FALSE;
1096 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
1097 gpointer user_data)
1099 abort();
1102 static void io_watch_poll_finalize(GSource *source)
1104 /* Due to a glib bug, removing the last reference to a source
1105 * inside a finalize callback causes recursive locking (and a
1106 * deadlock). This is not a problem inside other callbacks,
1107 * including dispatch callbacks, so we call io_remove_watch_poll
1108 * to remove this source. At this point, iwp->src must
1109 * be NULL, or we would leak it.
1111 * This would be solved much more elegantly by child sources,
1112 * but we support older glib versions that do not have them.
1114 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1115 assert(iwp->src == NULL);
1118 static GSourceFuncs io_watch_poll_funcs = {
1119 .prepare = io_watch_poll_prepare,
1120 .check = io_watch_poll_check,
1121 .dispatch = io_watch_poll_dispatch,
1122 .finalize = io_watch_poll_finalize,
1125 /* Can only be used for read */
1126 static guint io_add_watch_poll(Chardev *chr,
1127 QIOChannel *ioc,
1128 IOCanReadHandler *fd_can_read,
1129 QIOChannelFunc fd_read,
1130 gpointer user_data,
1131 GMainContext *context)
1133 IOWatchPoll *iwp;
1134 int tag;
1135 char *name;
1137 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs,
1138 sizeof(IOWatchPoll));
1139 iwp->fd_can_read = fd_can_read;
1140 iwp->opaque = user_data;
1141 iwp->ioc = ioc;
1142 iwp->fd_read = (GSourceFunc) fd_read;
1143 iwp->src = NULL;
1144 iwp->context = context;
1146 name = g_strdup_printf("chardev-iowatch-%s", chr->label);
1147 g_source_set_name((GSource *)iwp, name);
1148 g_free(name);
1150 tag = g_source_attach(&iwp->parent, context);
1151 g_source_unref(&iwp->parent);
1152 return tag;
1155 static void io_remove_watch_poll(guint tag)
1157 GSource *source;
1158 IOWatchPoll *iwp;
1160 g_return_if_fail (tag > 0);
1162 source = g_main_context_find_source_by_id(NULL, tag);
1163 g_return_if_fail (source != NULL);
1165 iwp = io_watch_poll_from_source(source);
1166 if (iwp->src) {
1167 g_source_destroy(iwp->src);
1168 g_source_unref(iwp->src);
1169 iwp->src = NULL;
1171 g_source_destroy(&iwp->parent);
1174 static void remove_fd_in_watch(Chardev *chr)
1176 if (chr->fd_in_tag) {
1177 io_remove_watch_poll(chr->fd_in_tag);
1178 chr->fd_in_tag = 0;
1183 static int io_channel_send_full(QIOChannel *ioc,
1184 const void *buf, size_t len,
1185 int *fds, size_t nfds)
1187 size_t offset = 0;
1189 while (offset < len) {
1190 ssize_t ret = 0;
1191 struct iovec iov = { .iov_base = (char *)buf + offset,
1192 .iov_len = len - offset };
1194 ret = qio_channel_writev_full(
1195 ioc, &iov, 1,
1196 fds, nfds, NULL);
1197 if (ret == QIO_CHANNEL_ERR_BLOCK) {
1198 if (offset) {
1199 return offset;
1202 errno = EAGAIN;
1203 return -1;
1204 } else if (ret < 0) {
1205 errno = EINVAL;
1206 return -1;
1209 offset += ret;
1212 return offset;
1216 #ifndef _WIN32
1217 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
1219 return io_channel_send_full(ioc, buf, len, NULL, 0);
1222 typedef struct FDChardev {
1223 Chardev parent;
1224 Chardev *chr;
1225 QIOChannel *ioc_in, *ioc_out;
1226 int max_size;
1227 } FDChardev;
1229 #define TYPE_CHARDEV_FD "chardev-fd"
1230 #define FD_CHARDEV(obj) OBJECT_CHECK(FDChardev, (obj), TYPE_CHARDEV_FD)
1232 /* Called with chr_write_lock held. */
1233 static int fd_chr_write(Chardev *chr, const uint8_t *buf, int len)
1235 FDChardev *s = FD_CHARDEV(chr);
1237 return io_channel_send(s->ioc_out, buf, len);
1240 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1242 Chardev *chr = CHARDEV(opaque);
1243 FDChardev *s = FD_CHARDEV(opaque);
1244 int len;
1245 uint8_t buf[READ_BUF_LEN];
1246 ssize_t ret;
1248 len = sizeof(buf);
1249 if (len > s->max_size) {
1250 len = s->max_size;
1252 if (len == 0) {
1253 return TRUE;
1256 ret = qio_channel_read(
1257 chan, (gchar *)buf, len, NULL);
1258 if (ret == 0) {
1259 remove_fd_in_watch(chr);
1260 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1261 return FALSE;
1263 if (ret > 0) {
1264 qemu_chr_be_write(chr, buf, ret);
1267 return TRUE;
1270 static int fd_chr_read_poll(void *opaque)
1272 Chardev *chr = CHARDEV(opaque);
1273 FDChardev *s = FD_CHARDEV(opaque);
1275 s->max_size = qemu_chr_be_can_write(chr);
1276 return s->max_size;
1279 static GSource *fd_chr_add_watch(Chardev *chr, GIOCondition cond)
1281 FDChardev *s = FD_CHARDEV(chr);
1282 return qio_channel_create_watch(s->ioc_out, cond);
1285 static void fd_chr_update_read_handler(Chardev *chr,
1286 GMainContext *context)
1288 FDChardev *s = FD_CHARDEV(chr);
1290 remove_fd_in_watch(chr);
1291 if (s->ioc_in) {
1292 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc_in,
1293 fd_chr_read_poll,
1294 fd_chr_read, chr,
1295 context);
1299 static void char_fd_finalize(Object *obj)
1301 Chardev *chr = CHARDEV(obj);
1302 FDChardev *s = FD_CHARDEV(obj);
1304 remove_fd_in_watch(chr);
1305 if (s->ioc_in) {
1306 object_unref(OBJECT(s->ioc_in));
1308 if (s->ioc_out) {
1309 object_unref(OBJECT(s->ioc_out));
1312 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1315 /* open a character device to a unix fd */
1316 static void qemu_chr_open_fd(Chardev *chr,
1317 int fd_in, int fd_out)
1319 FDChardev *s = FD_CHARDEV(chr);
1320 char *name;
1322 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1323 name = g_strdup_printf("chardev-file-in-%s", chr->label);
1324 qio_channel_set_name(QIO_CHANNEL(s->ioc_in), name);
1325 g_free(name);
1326 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1327 name = g_strdup_printf("chardev-file-out-%s", chr->label);
1328 qio_channel_set_name(QIO_CHANNEL(s->ioc_out), name);
1329 g_free(name);
1330 qemu_set_nonblock(fd_out);
1331 s->chr = chr;
1334 static void char_fd_class_init(ObjectClass *oc, void *data)
1336 ChardevClass *cc = CHARDEV_CLASS(oc);
1338 cc->chr_add_watch = fd_chr_add_watch;
1339 cc->chr_write = fd_chr_write;
1340 cc->chr_update_read_handler = fd_chr_update_read_handler;
1343 static const TypeInfo char_fd_type_info = {
1344 .name = TYPE_CHARDEV_FD,
1345 .parent = TYPE_CHARDEV,
1346 .instance_size = sizeof(FDChardev),
1347 .instance_finalize = char_fd_finalize,
1348 .class_init = char_fd_class_init,
1349 .abstract = true,
1352 static void qemu_chr_open_pipe(Chardev *chr,
1353 ChardevBackend *backend,
1354 bool *be_opened,
1355 Error **errp)
1357 ChardevHostdev *opts = backend->u.pipe.data;
1358 int fd_in, fd_out;
1359 char *filename_in;
1360 char *filename_out;
1361 const char *filename = opts->device;
1363 filename_in = g_strdup_printf("%s.in", filename);
1364 filename_out = g_strdup_printf("%s.out", filename);
1365 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1366 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1367 g_free(filename_in);
1368 g_free(filename_out);
1369 if (fd_in < 0 || fd_out < 0) {
1370 if (fd_in >= 0)
1371 close(fd_in);
1372 if (fd_out >= 0)
1373 close(fd_out);
1374 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1375 if (fd_in < 0) {
1376 error_setg_file_open(errp, errno, filename);
1377 return;
1380 qemu_chr_open_fd(chr, fd_in, fd_out);
1383 /* init terminal so that we can grab keys */
1384 static struct termios oldtty;
1385 static int old_fd0_flags;
1386 static bool stdio_in_use;
1387 static bool stdio_allow_signal;
1388 static bool stdio_echo_state;
1390 static void qemu_chr_set_echo_stdio(Chardev *chr, bool echo);
1392 static void term_exit(void)
1394 tcsetattr (0, TCSANOW, &oldtty);
1395 fcntl(0, F_SETFL, old_fd0_flags);
1398 static void term_stdio_handler(int sig)
1400 /* restore echo after resume from suspend. */
1401 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1404 static void qemu_chr_set_echo_stdio(Chardev *chr, bool echo)
1406 struct termios tty;
1408 stdio_echo_state = echo;
1409 tty = oldtty;
1410 if (!echo) {
1411 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1412 |INLCR|IGNCR|ICRNL|IXON);
1413 tty.c_oflag |= OPOST;
1414 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1415 tty.c_cflag &= ~(CSIZE|PARENB);
1416 tty.c_cflag |= CS8;
1417 tty.c_cc[VMIN] = 1;
1418 tty.c_cc[VTIME] = 0;
1420 if (!stdio_allow_signal)
1421 tty.c_lflag &= ~ISIG;
1423 tcsetattr (0, TCSANOW, &tty);
1426 static void char_stdio_finalize(Object *obj)
1428 term_exit();
1431 static void qemu_chr_open_stdio(Chardev *chr,
1432 ChardevBackend *backend,
1433 bool *be_opened,
1434 Error **errp)
1436 ChardevStdio *opts = backend->u.stdio.data;
1437 struct sigaction act;
1439 if (is_daemonized()) {
1440 error_setg(errp, "cannot use stdio with -daemonize");
1441 return;
1444 if (stdio_in_use) {
1445 error_setg(errp, "cannot use stdio by multiple character devices");
1446 return;
1449 stdio_in_use = true;
1450 old_fd0_flags = fcntl(0, F_GETFL);
1451 tcgetattr(0, &oldtty);
1452 qemu_set_nonblock(0);
1453 atexit(term_exit);
1455 memset(&act, 0, sizeof(act));
1456 act.sa_handler = term_stdio_handler;
1457 sigaction(SIGCONT, &act, NULL);
1459 qemu_chr_open_fd(chr, 0, 1);
1461 if (opts->has_signal) {
1462 stdio_allow_signal = opts->signal;
1464 qemu_chr_set_echo_stdio(chr, false);
1467 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1468 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1469 || defined(__GLIBC__)
1471 #define HAVE_CHARDEV_SERIAL 1
1472 #define HAVE_CHARDEV_PTY 1
1474 typedef struct {
1475 Chardev parent;
1476 QIOChannel *ioc;
1477 int read_bytes;
1479 /* Protected by the Chardev chr_write_lock. */
1480 int connected;
1481 guint timer_tag;
1482 guint open_tag;
1483 } PtyChardev;
1485 #define PTY_CHARDEV(obj) OBJECT_CHECK(PtyChardev, (obj), TYPE_CHARDEV_PTY)
1487 static void pty_chr_update_read_handler_locked(Chardev *chr);
1488 static void pty_chr_state(Chardev *chr, int connected);
1490 static gboolean pty_chr_timer(gpointer opaque)
1492 struct Chardev *chr = CHARDEV(opaque);
1493 PtyChardev *s = PTY_CHARDEV(opaque);
1495 qemu_mutex_lock(&chr->chr_write_lock);
1496 s->timer_tag = 0;
1497 s->open_tag = 0;
1498 if (!s->connected) {
1499 /* Next poll ... */
1500 pty_chr_update_read_handler_locked(chr);
1502 qemu_mutex_unlock(&chr->chr_write_lock);
1503 return FALSE;
1506 /* Called with chr_write_lock held. */
1507 static void pty_chr_rearm_timer(Chardev *chr, int ms)
1509 PtyChardev *s = PTY_CHARDEV(chr);
1510 char *name;
1512 if (s->timer_tag) {
1513 g_source_remove(s->timer_tag);
1514 s->timer_tag = 0;
1517 if (ms == 1000) {
1518 name = g_strdup_printf("pty-timer-secs-%s", chr->label);
1519 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1520 } else {
1521 name = g_strdup_printf("pty-timer-ms-%s", chr->label);
1522 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1524 g_source_set_name_by_id(s->timer_tag, name);
1525 g_free(name);
1528 /* Called with chr_write_lock held. */
1529 static void pty_chr_update_read_handler_locked(Chardev *chr)
1531 PtyChardev *s = PTY_CHARDEV(chr);
1532 GPollFD pfd;
1533 int rc;
1534 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1536 pfd.fd = fioc->fd;
1537 pfd.events = G_IO_OUT;
1538 pfd.revents = 0;
1539 do {
1540 rc = g_poll(&pfd, 1, 0);
1541 } while (rc == -1 && errno == EINTR);
1542 assert(rc >= 0);
1544 if (pfd.revents & G_IO_HUP) {
1545 pty_chr_state(chr, 0);
1546 } else {
1547 pty_chr_state(chr, 1);
1551 static void pty_chr_update_read_handler(Chardev *chr,
1552 GMainContext *context)
1554 qemu_mutex_lock(&chr->chr_write_lock);
1555 pty_chr_update_read_handler_locked(chr);
1556 qemu_mutex_unlock(&chr->chr_write_lock);
1559 /* Called with chr_write_lock held. */
1560 static int char_pty_chr_write(Chardev *chr, const uint8_t *buf, int len)
1562 PtyChardev *s = PTY_CHARDEV(chr);
1564 if (!s->connected) {
1565 /* guest sends data, check for (re-)connect */
1566 pty_chr_update_read_handler_locked(chr);
1567 if (!s->connected) {
1568 return 0;
1571 return io_channel_send(s->ioc, buf, len);
1574 static GSource *pty_chr_add_watch(Chardev *chr, GIOCondition cond)
1576 PtyChardev *s = PTY_CHARDEV(chr);
1577 if (!s->connected) {
1578 return NULL;
1580 return qio_channel_create_watch(s->ioc, cond);
1583 static int pty_chr_read_poll(void *opaque)
1585 Chardev *chr = CHARDEV(opaque);
1586 PtyChardev *s = PTY_CHARDEV(opaque);
1588 s->read_bytes = qemu_chr_be_can_write(chr);
1589 return s->read_bytes;
1592 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1594 Chardev *chr = CHARDEV(opaque);
1595 PtyChardev *s = PTY_CHARDEV(opaque);
1596 gsize len;
1597 uint8_t buf[READ_BUF_LEN];
1598 ssize_t ret;
1600 len = sizeof(buf);
1601 if (len > s->read_bytes)
1602 len = s->read_bytes;
1603 if (len == 0) {
1604 return TRUE;
1606 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1607 if (ret <= 0) {
1608 pty_chr_state(chr, 0);
1609 return FALSE;
1610 } else {
1611 pty_chr_state(chr, 1);
1612 qemu_chr_be_write(chr, buf, ret);
1614 return TRUE;
1617 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1619 Chardev *chr = CHARDEV(opaque);
1620 PtyChardev *s = PTY_CHARDEV(opaque);
1622 s->open_tag = 0;
1623 qemu_chr_be_generic_open(chr);
1624 return FALSE;
1627 /* Called with chr_write_lock held. */
1628 static void pty_chr_state(Chardev *chr, int connected)
1630 PtyChardev *s = PTY_CHARDEV(chr);
1632 if (!connected) {
1633 if (s->open_tag) {
1634 g_source_remove(s->open_tag);
1635 s->open_tag = 0;
1637 remove_fd_in_watch(chr);
1638 s->connected = 0;
1639 /* (re-)connect poll interval for idle guests: once per second.
1640 * We check more frequently in case the guests sends data to
1641 * the virtual device linked to our pty. */
1642 pty_chr_rearm_timer(chr, 1000);
1643 } else {
1644 if (s->timer_tag) {
1645 g_source_remove(s->timer_tag);
1646 s->timer_tag = 0;
1648 if (!s->connected) {
1649 g_assert(s->open_tag == 0);
1650 s->connected = 1;
1651 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1653 if (!chr->fd_in_tag) {
1654 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
1655 pty_chr_read_poll,
1656 pty_chr_read,
1657 chr, NULL);
1662 static void char_pty_finalize(Object *obj)
1664 Chardev *chr = CHARDEV(obj);
1665 PtyChardev *s = PTY_CHARDEV(obj);
1667 qemu_mutex_lock(&chr->chr_write_lock);
1668 pty_chr_state(chr, 0);
1669 object_unref(OBJECT(s->ioc));
1670 if (s->timer_tag) {
1671 g_source_remove(s->timer_tag);
1672 s->timer_tag = 0;
1674 qemu_mutex_unlock(&chr->chr_write_lock);
1675 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1678 static void char_pty_open(Chardev *chr,
1679 ChardevBackend *backend,
1680 bool *be_opened,
1681 Error **errp)
1683 PtyChardev *s;
1684 int master_fd, slave_fd;
1685 char pty_name[PATH_MAX];
1686 char *name;
1688 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1689 if (master_fd < 0) {
1690 error_setg_errno(errp, errno, "Failed to create PTY");
1691 return;
1694 close(slave_fd);
1695 qemu_set_nonblock(master_fd);
1697 chr->filename = g_strdup_printf("pty:%s", pty_name);
1698 error_report("char device redirected to %s (label %s)",
1699 pty_name, chr->label);
1701 s = PTY_CHARDEV(chr);
1702 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1703 name = g_strdup_printf("chardev-pty-%s", chr->label);
1704 qio_channel_set_name(QIO_CHANNEL(s->ioc), name);
1705 g_free(name);
1706 s->timer_tag = 0;
1707 *be_opened = false;
1710 static const CharDriver pty_driver = {
1711 .kind = CHARDEV_BACKEND_KIND_PTY,
1714 static void char_pty_class_init(ObjectClass *oc, void *data)
1716 ChardevClass *cc = CHARDEV_CLASS(oc);
1718 cc->open = char_pty_open;
1719 cc->chr_write = char_pty_chr_write;
1720 cc->chr_update_read_handler = pty_chr_update_read_handler;
1721 cc->chr_add_watch = pty_chr_add_watch;
1724 static const TypeInfo char_pty_type_info = {
1725 .name = TYPE_CHARDEV_PTY,
1726 .parent = TYPE_CHARDEV,
1727 .instance_size = sizeof(PtyChardev),
1728 .instance_finalize = char_pty_finalize,
1729 .class_init = char_pty_class_init,
1732 static void tty_serial_init(int fd, int speed,
1733 int parity, int data_bits, int stop_bits)
1735 struct termios tty;
1736 speed_t spd;
1738 #if 0
1739 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1740 speed, parity, data_bits, stop_bits);
1741 #endif
1742 tcgetattr (fd, &tty);
1744 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1745 speed = speed * 10 / 11;
1746 do {
1747 check_speed(50);
1748 check_speed(75);
1749 check_speed(110);
1750 check_speed(134);
1751 check_speed(150);
1752 check_speed(200);
1753 check_speed(300);
1754 check_speed(600);
1755 check_speed(1200);
1756 check_speed(1800);
1757 check_speed(2400);
1758 check_speed(4800);
1759 check_speed(9600);
1760 check_speed(19200);
1761 check_speed(38400);
1762 /* Non-Posix values follow. They may be unsupported on some systems. */
1763 check_speed(57600);
1764 check_speed(115200);
1765 #ifdef B230400
1766 check_speed(230400);
1767 #endif
1768 #ifdef B460800
1769 check_speed(460800);
1770 #endif
1771 #ifdef B500000
1772 check_speed(500000);
1773 #endif
1774 #ifdef B576000
1775 check_speed(576000);
1776 #endif
1777 #ifdef B921600
1778 check_speed(921600);
1779 #endif
1780 #ifdef B1000000
1781 check_speed(1000000);
1782 #endif
1783 #ifdef B1152000
1784 check_speed(1152000);
1785 #endif
1786 #ifdef B1500000
1787 check_speed(1500000);
1788 #endif
1789 #ifdef B2000000
1790 check_speed(2000000);
1791 #endif
1792 #ifdef B2500000
1793 check_speed(2500000);
1794 #endif
1795 #ifdef B3000000
1796 check_speed(3000000);
1797 #endif
1798 #ifdef B3500000
1799 check_speed(3500000);
1800 #endif
1801 #ifdef B4000000
1802 check_speed(4000000);
1803 #endif
1804 spd = B115200;
1805 } while (0);
1807 cfsetispeed(&tty, spd);
1808 cfsetospeed(&tty, spd);
1810 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1811 |INLCR|IGNCR|ICRNL|IXON);
1812 tty.c_oflag |= OPOST;
1813 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1814 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1815 switch(data_bits) {
1816 default:
1817 case 8:
1818 tty.c_cflag |= CS8;
1819 break;
1820 case 7:
1821 tty.c_cflag |= CS7;
1822 break;
1823 case 6:
1824 tty.c_cflag |= CS6;
1825 break;
1826 case 5:
1827 tty.c_cflag |= CS5;
1828 break;
1830 switch(parity) {
1831 default:
1832 case 'N':
1833 break;
1834 case 'E':
1835 tty.c_cflag |= PARENB;
1836 break;
1837 case 'O':
1838 tty.c_cflag |= PARENB | PARODD;
1839 break;
1841 if (stop_bits == 2)
1842 tty.c_cflag |= CSTOPB;
1844 tcsetattr (fd, TCSANOW, &tty);
1847 static int tty_serial_ioctl(Chardev *chr, int cmd, void *arg)
1849 FDChardev *s = FD_CHARDEV(chr);
1850 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1852 switch(cmd) {
1853 case CHR_IOCTL_SERIAL_SET_PARAMS:
1855 QEMUSerialSetParams *ssp = arg;
1856 tty_serial_init(fioc->fd,
1857 ssp->speed, ssp->parity,
1858 ssp->data_bits, ssp->stop_bits);
1860 break;
1861 case CHR_IOCTL_SERIAL_SET_BREAK:
1863 int enable = *(int *)arg;
1864 if (enable) {
1865 tcsendbreak(fioc->fd, 1);
1868 break;
1869 case CHR_IOCTL_SERIAL_GET_TIOCM:
1871 int sarg = 0;
1872 int *targ = (int *)arg;
1873 ioctl(fioc->fd, TIOCMGET, &sarg);
1874 *targ = 0;
1875 if (sarg & TIOCM_CTS)
1876 *targ |= CHR_TIOCM_CTS;
1877 if (sarg & TIOCM_CAR)
1878 *targ |= CHR_TIOCM_CAR;
1879 if (sarg & TIOCM_DSR)
1880 *targ |= CHR_TIOCM_DSR;
1881 if (sarg & TIOCM_RI)
1882 *targ |= CHR_TIOCM_RI;
1883 if (sarg & TIOCM_DTR)
1884 *targ |= CHR_TIOCM_DTR;
1885 if (sarg & TIOCM_RTS)
1886 *targ |= CHR_TIOCM_RTS;
1888 break;
1889 case CHR_IOCTL_SERIAL_SET_TIOCM:
1891 int sarg = *(int *)arg;
1892 int targ = 0;
1893 ioctl(fioc->fd, TIOCMGET, &targ);
1894 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1895 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1896 if (sarg & CHR_TIOCM_CTS)
1897 targ |= TIOCM_CTS;
1898 if (sarg & CHR_TIOCM_CAR)
1899 targ |= TIOCM_CAR;
1900 if (sarg & CHR_TIOCM_DSR)
1901 targ |= TIOCM_DSR;
1902 if (sarg & CHR_TIOCM_RI)
1903 targ |= TIOCM_RI;
1904 if (sarg & CHR_TIOCM_DTR)
1905 targ |= TIOCM_DTR;
1906 if (sarg & CHR_TIOCM_RTS)
1907 targ |= TIOCM_RTS;
1908 ioctl(fioc->fd, TIOCMSET, &targ);
1910 break;
1911 default:
1912 return -ENOTSUP;
1914 return 0;
1916 #endif /* __linux__ || __sun__ */
1918 #if defined(__linux__)
1920 #define HAVE_CHARDEV_PARPORT 1
1922 typedef struct {
1923 Chardev parent;
1924 int fd;
1925 int mode;
1926 } ParallelChardev;
1928 #define PARALLEL_CHARDEV(obj) \
1929 OBJECT_CHECK(ParallelChardev, (obj), TYPE_CHARDEV_PARALLEL)
1931 static int pp_hw_mode(ParallelChardev *s, uint16_t mode)
1933 if (s->mode != mode) {
1934 int m = mode;
1935 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1936 return 0;
1937 s->mode = mode;
1939 return 1;
1942 static int pp_ioctl(Chardev *chr, int cmd, void *arg)
1944 ParallelChardev *drv = PARALLEL_CHARDEV(chr);
1945 int fd = drv->fd;
1946 uint8_t b;
1948 switch(cmd) {
1949 case CHR_IOCTL_PP_READ_DATA:
1950 if (ioctl(fd, PPRDATA, &b) < 0)
1951 return -ENOTSUP;
1952 *(uint8_t *)arg = b;
1953 break;
1954 case CHR_IOCTL_PP_WRITE_DATA:
1955 b = *(uint8_t *)arg;
1956 if (ioctl(fd, PPWDATA, &b) < 0)
1957 return -ENOTSUP;
1958 break;
1959 case CHR_IOCTL_PP_READ_CONTROL:
1960 if (ioctl(fd, PPRCONTROL, &b) < 0)
1961 return -ENOTSUP;
1962 /* Linux gives only the lowest bits, and no way to know data
1963 direction! For better compatibility set the fixed upper
1964 bits. */
1965 *(uint8_t *)arg = b | 0xc0;
1966 break;
1967 case CHR_IOCTL_PP_WRITE_CONTROL:
1968 b = *(uint8_t *)arg;
1969 if (ioctl(fd, PPWCONTROL, &b) < 0)
1970 return -ENOTSUP;
1971 break;
1972 case CHR_IOCTL_PP_READ_STATUS:
1973 if (ioctl(fd, PPRSTATUS, &b) < 0)
1974 return -ENOTSUP;
1975 *(uint8_t *)arg = b;
1976 break;
1977 case CHR_IOCTL_PP_DATA_DIR:
1978 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1979 return -ENOTSUP;
1980 break;
1981 case CHR_IOCTL_PP_EPP_READ_ADDR:
1982 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1983 struct ParallelIOArg *parg = arg;
1984 int n = read(fd, parg->buffer, parg->count);
1985 if (n != parg->count) {
1986 return -EIO;
1989 break;
1990 case CHR_IOCTL_PP_EPP_READ:
1991 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1992 struct ParallelIOArg *parg = arg;
1993 int n = read(fd, parg->buffer, parg->count);
1994 if (n != parg->count) {
1995 return -EIO;
1998 break;
1999 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
2000 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
2001 struct ParallelIOArg *parg = arg;
2002 int n = write(fd, parg->buffer, parg->count);
2003 if (n != parg->count) {
2004 return -EIO;
2007 break;
2008 case CHR_IOCTL_PP_EPP_WRITE:
2009 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
2010 struct ParallelIOArg *parg = arg;
2011 int n = write(fd, parg->buffer, parg->count);
2012 if (n != parg->count) {
2013 return -EIO;
2016 break;
2017 default:
2018 return -ENOTSUP;
2020 return 0;
2023 static void qemu_chr_open_pp_fd(Chardev *chr,
2024 int fd,
2025 bool *be_opened,
2026 Error **errp)
2028 ParallelChardev *drv = PARALLEL_CHARDEV(chr);
2030 if (ioctl(fd, PPCLAIM) < 0) {
2031 error_setg_errno(errp, errno, "not a parallel port");
2032 close(fd);
2033 return;
2036 drv->fd = fd;
2037 drv->mode = IEEE1284_MODE_COMPAT;
2039 #endif /* __linux__ */
2041 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
2043 #define HAVE_CHARDEV_PARPORT 1
2045 typedef struct {
2046 Chardev parent;
2047 int fd;
2048 } ParallelChardev;
2050 #define PARALLEL_CHARDEV(obj) \
2051 OBJECT_CHECK(ParallelChardev, (obj), TYPE_CHARDEV_PARALLEL)
2053 static int pp_ioctl(Chardev *chr, int cmd, void *arg)
2055 ParallelChardev *drv = PARALLEL_CHARDEV(chr);
2056 uint8_t b;
2058 switch (cmd) {
2059 case CHR_IOCTL_PP_READ_DATA:
2060 if (ioctl(drv->fd, PPIGDATA, &b) < 0) {
2061 return -ENOTSUP;
2063 *(uint8_t *)arg = b;
2064 break;
2065 case CHR_IOCTL_PP_WRITE_DATA:
2066 b = *(uint8_t *)arg;
2067 if (ioctl(drv->fd, PPISDATA, &b) < 0) {
2068 return -ENOTSUP;
2070 break;
2071 case CHR_IOCTL_PP_READ_CONTROL:
2072 if (ioctl(drv->fd, PPIGCTRL, &b) < 0) {
2073 return -ENOTSUP;
2075 *(uint8_t *)arg = b;
2076 break;
2077 case CHR_IOCTL_PP_WRITE_CONTROL:
2078 b = *(uint8_t *)arg;
2079 if (ioctl(drv->fd, PPISCTRL, &b) < 0) {
2080 return -ENOTSUP;
2082 break;
2083 case CHR_IOCTL_PP_READ_STATUS:
2084 if (ioctl(drv->fd, PPIGSTATUS, &b) < 0) {
2085 return -ENOTSUP;
2087 *(uint8_t *)arg = b;
2088 break;
2089 default:
2090 return -ENOTSUP;
2092 return 0;
2095 static void qemu_chr_open_pp_fd(Chardev *chr,
2096 int fd,
2097 bool *be_opened,
2098 Error **errp)
2100 ParallelChardev *drv = PARALLEL_CHARDEV(chr);
2101 drv->fd = fd;
2102 *be_opened = false;
2104 #endif
2106 #else /* _WIN32 */
2108 #define HAVE_CHARDEV_SERIAL 1
2110 typedef struct {
2111 Chardev parent;
2112 int max_size;
2113 HANDLE hcom, hrecv, hsend;
2114 OVERLAPPED orecv;
2115 BOOL fpipe;
2116 DWORD len;
2118 /* Protected by the Chardev chr_write_lock. */
2119 OVERLAPPED osend;
2120 /* FIXME: file/console do not finalize */
2121 bool skip_free;
2122 } WinChardev;
2124 #define TYPE_CHARDEV_WIN "chardev-win"
2125 #define WIN_CHARDEV(obj) OBJECT_CHECK(WinChardev, (obj), TYPE_CHARDEV_WIN)
2127 typedef struct {
2128 Chardev parent;
2129 HANDLE hStdIn;
2130 HANDLE hInputReadyEvent;
2131 HANDLE hInputDoneEvent;
2132 HANDLE hInputThread;
2133 uint8_t win_stdio_buf;
2134 } WinStdioChardev;
2136 #define TYPE_CHARDEV_WIN_STDIO "chardev-win-stdio"
2137 #define WIN_STDIO_CHARDEV(obj) \
2138 OBJECT_CHECK(WinStdioChardev, (obj), TYPE_CHARDEV_WIN_STDIO)
2140 #define NSENDBUF 2048
2141 #define NRECVBUF 2048
2142 #define MAXCONNECT 1
2143 #define NTIMEOUT 5000
2145 static int win_chr_poll(void *opaque);
2146 static int win_chr_pipe_poll(void *opaque);
2148 static void char_win_finalize(Object *obj)
2150 Chardev *chr = CHARDEV(obj);
2151 WinChardev *s = WIN_CHARDEV(chr);
2153 if (s->skip_free) {
2154 return;
2157 if (s->hsend) {
2158 CloseHandle(s->hsend);
2160 if (s->hrecv) {
2161 CloseHandle(s->hrecv);
2163 if (s->hcom) {
2164 CloseHandle(s->hcom);
2166 if (s->fpipe)
2167 qemu_del_polling_cb(win_chr_pipe_poll, chr);
2168 else
2169 qemu_del_polling_cb(win_chr_poll, chr);
2171 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2174 static int win_chr_init(Chardev *chr, const char *filename, Error **errp)
2176 WinChardev *s = WIN_CHARDEV(chr);
2177 COMMCONFIG comcfg;
2178 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
2179 COMSTAT comstat;
2180 DWORD size;
2181 DWORD err;
2183 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2184 if (!s->hsend) {
2185 error_setg(errp, "Failed CreateEvent");
2186 goto fail;
2188 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2189 if (!s->hrecv) {
2190 error_setg(errp, "Failed CreateEvent");
2191 goto fail;
2194 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
2195 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
2196 if (s->hcom == INVALID_HANDLE_VALUE) {
2197 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
2198 s->hcom = NULL;
2199 goto fail;
2202 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
2203 error_setg(errp, "Failed SetupComm");
2204 goto fail;
2207 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
2208 size = sizeof(COMMCONFIG);
2209 GetDefaultCommConfig(filename, &comcfg, &size);
2210 comcfg.dcb.DCBlength = sizeof(DCB);
2211 CommConfigDialog(filename, NULL, &comcfg);
2213 if (!SetCommState(s->hcom, &comcfg.dcb)) {
2214 error_setg(errp, "Failed SetCommState");
2215 goto fail;
2218 if (!SetCommMask(s->hcom, EV_ERR)) {
2219 error_setg(errp, "Failed SetCommMask");
2220 goto fail;
2223 cto.ReadIntervalTimeout = MAXDWORD;
2224 if (!SetCommTimeouts(s->hcom, &cto)) {
2225 error_setg(errp, "Failed SetCommTimeouts");
2226 goto fail;
2229 if (!ClearCommError(s->hcom, &err, &comstat)) {
2230 error_setg(errp, "Failed ClearCommError");
2231 goto fail;
2233 qemu_add_polling_cb(win_chr_poll, chr);
2234 return 0;
2236 fail:
2237 return -1;
2240 /* Called with chr_write_lock held. */
2241 static int win_chr_write(Chardev *chr, const uint8_t *buf, int len1)
2243 WinChardev *s = WIN_CHARDEV(chr);
2244 DWORD len, ret, size, err;
2246 len = len1;
2247 ZeroMemory(&s->osend, sizeof(s->osend));
2248 s->osend.hEvent = s->hsend;
2249 while (len > 0) {
2250 if (s->hsend)
2251 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
2252 else
2253 ret = WriteFile(s->hcom, buf, len, &size, NULL);
2254 if (!ret) {
2255 err = GetLastError();
2256 if (err == ERROR_IO_PENDING) {
2257 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
2258 if (ret) {
2259 buf += size;
2260 len -= size;
2261 } else {
2262 break;
2264 } else {
2265 break;
2267 } else {
2268 buf += size;
2269 len -= size;
2272 return len1 - len;
2275 static int win_chr_read_poll(Chardev *chr)
2277 WinChardev *s = WIN_CHARDEV(chr);
2279 s->max_size = qemu_chr_be_can_write(chr);
2280 return s->max_size;
2283 static void win_chr_readfile(Chardev *chr)
2285 WinChardev *s = WIN_CHARDEV(chr);
2287 int ret, err;
2288 uint8_t buf[READ_BUF_LEN];
2289 DWORD size;
2291 ZeroMemory(&s->orecv, sizeof(s->orecv));
2292 s->orecv.hEvent = s->hrecv;
2293 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2294 if (!ret) {
2295 err = GetLastError();
2296 if (err == ERROR_IO_PENDING) {
2297 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2301 if (size > 0) {
2302 qemu_chr_be_write(chr, buf, size);
2306 static void win_chr_read(Chardev *chr)
2308 WinChardev *s = WIN_CHARDEV(chr);
2310 if (s->len > s->max_size)
2311 s->len = s->max_size;
2312 if (s->len == 0)
2313 return;
2315 win_chr_readfile(chr);
2318 static int win_chr_poll(void *opaque)
2320 Chardev *chr = CHARDEV(opaque);
2321 WinChardev *s = WIN_CHARDEV(opaque);
2322 COMSTAT status;
2323 DWORD comerr;
2325 ClearCommError(s->hcom, &comerr, &status);
2326 if (status.cbInQue > 0) {
2327 s->len = status.cbInQue;
2328 win_chr_read_poll(chr);
2329 win_chr_read(chr);
2330 return 1;
2332 return 0;
2335 static int win_chr_pipe_poll(void *opaque)
2337 Chardev *chr = CHARDEV(opaque);
2338 WinChardev *s = WIN_CHARDEV(opaque);
2339 DWORD size;
2341 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2342 if (size > 0) {
2343 s->len = size;
2344 win_chr_read_poll(chr);
2345 win_chr_read(chr);
2346 return 1;
2348 return 0;
2351 static int win_chr_pipe_init(Chardev *chr, const char *filename,
2352 Error **errp)
2354 WinChardev *s = WIN_CHARDEV(chr);
2355 OVERLAPPED ov;
2356 int ret;
2357 DWORD size;
2358 char *openname;
2360 s->fpipe = TRUE;
2362 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2363 if (!s->hsend) {
2364 error_setg(errp, "Failed CreateEvent");
2365 goto fail;
2367 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2368 if (!s->hrecv) {
2369 error_setg(errp, "Failed CreateEvent");
2370 goto fail;
2373 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2374 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2375 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2376 PIPE_WAIT,
2377 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2378 g_free(openname);
2379 if (s->hcom == INVALID_HANDLE_VALUE) {
2380 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2381 s->hcom = NULL;
2382 goto fail;
2385 ZeroMemory(&ov, sizeof(ov));
2386 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2387 ret = ConnectNamedPipe(s->hcom, &ov);
2388 if (ret) {
2389 error_setg(errp, "Failed ConnectNamedPipe");
2390 goto fail;
2393 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2394 if (!ret) {
2395 error_setg(errp, "Failed GetOverlappedResult");
2396 if (ov.hEvent) {
2397 CloseHandle(ov.hEvent);
2398 ov.hEvent = NULL;
2400 goto fail;
2403 if (ov.hEvent) {
2404 CloseHandle(ov.hEvent);
2405 ov.hEvent = NULL;
2407 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2408 return 0;
2410 fail:
2411 return -1;
2415 static void qemu_chr_open_pipe(Chardev *chr,
2416 ChardevBackend *backend,
2417 bool *be_opened,
2418 Error **errp)
2420 ChardevHostdev *opts = backend->u.pipe.data;
2421 const char *filename = opts->device;
2423 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2424 return;
2428 static void qemu_chr_open_win_file(Chardev *chr, HANDLE fd_out)
2430 WinChardev *s = WIN_CHARDEV(chr);
2432 s->skip_free = true;
2433 s->hcom = fd_out;
2436 static void char_win_class_init(ObjectClass *oc, void *data)
2438 ChardevClass *cc = CHARDEV_CLASS(oc);
2440 cc->chr_write = win_chr_write;
2443 static const TypeInfo char_win_type_info = {
2444 .name = TYPE_CHARDEV_WIN,
2445 .parent = TYPE_CHARDEV,
2446 .instance_size = sizeof(WinChardev),
2447 .instance_finalize = char_win_finalize,
2448 .class_init = char_win_class_init,
2449 .abstract = true,
2452 static void qemu_chr_open_win_con(Chardev *chr,
2453 ChardevBackend *backend,
2454 bool *be_opened,
2455 Error **errp)
2457 qemu_chr_open_win_file(chr, GetStdHandle(STD_OUTPUT_HANDLE));
2460 static const CharDriver console_driver = {
2461 .kind = CHARDEV_BACKEND_KIND_CONSOLE,
2464 static void char_console_class_init(ObjectClass *oc, void *data)
2466 ChardevClass *cc = CHARDEV_CLASS(oc);
2468 cc->open = qemu_chr_open_win_con;
2471 static const TypeInfo char_console_type_info = {
2472 .name = TYPE_CHARDEV_CONSOLE,
2473 .parent = TYPE_CHARDEV_WIN,
2474 .class_init = char_console_class_init,
2477 static int win_stdio_write(Chardev *chr, const uint8_t *buf, int len)
2479 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2480 DWORD dwSize;
2481 int len1;
2483 len1 = len;
2485 while (len1 > 0) {
2486 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2487 break;
2489 buf += dwSize;
2490 len1 -= dwSize;
2493 return len - len1;
2496 static void win_stdio_wait_func(void *opaque)
2498 Chardev *chr = CHARDEV(opaque);
2499 WinStdioChardev *stdio = WIN_STDIO_CHARDEV(opaque);
2500 INPUT_RECORD buf[4];
2501 int ret;
2502 DWORD dwSize;
2503 int i;
2505 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2507 if (!ret) {
2508 /* Avoid error storm */
2509 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2510 return;
2513 for (i = 0; i < dwSize; i++) {
2514 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2516 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2517 int j;
2518 if (kev->uChar.AsciiChar != 0) {
2519 for (j = 0; j < kev->wRepeatCount; j++) {
2520 if (qemu_chr_be_can_write(chr)) {
2521 uint8_t c = kev->uChar.AsciiChar;
2522 qemu_chr_be_write(chr, &c, 1);
2530 static DWORD WINAPI win_stdio_thread(LPVOID param)
2532 WinStdioChardev *stdio = WIN_STDIO_CHARDEV(param);
2533 int ret;
2534 DWORD dwSize;
2536 while (1) {
2538 /* Wait for one byte */
2539 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2541 /* Exit in case of error, continue if nothing read */
2542 if (!ret) {
2543 break;
2545 if (!dwSize) {
2546 continue;
2549 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2550 if (stdio->win_stdio_buf == '\r') {
2551 continue;
2554 /* Signal the main thread and wait until the byte was eaten */
2555 if (!SetEvent(stdio->hInputReadyEvent)) {
2556 break;
2558 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2559 != WAIT_OBJECT_0) {
2560 break;
2564 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2565 return 0;
2568 static void win_stdio_thread_wait_func(void *opaque)
2570 Chardev *chr = CHARDEV(opaque);
2571 WinStdioChardev *stdio = WIN_STDIO_CHARDEV(opaque);
2573 if (qemu_chr_be_can_write(chr)) {
2574 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2577 SetEvent(stdio->hInputDoneEvent);
2580 static void qemu_chr_set_echo_win_stdio(Chardev *chr, bool echo)
2582 WinStdioChardev *stdio = WIN_STDIO_CHARDEV(chr);
2583 DWORD dwMode = 0;
2585 GetConsoleMode(stdio->hStdIn, &dwMode);
2587 if (echo) {
2588 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2589 } else {
2590 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2594 static void char_win_stdio_finalize(Object *obj)
2596 WinStdioChardev *stdio = WIN_STDIO_CHARDEV(obj);
2598 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2599 CloseHandle(stdio->hInputReadyEvent);
2601 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2602 CloseHandle(stdio->hInputDoneEvent);
2604 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2605 TerminateThread(stdio->hInputThread, 0);
2609 static const TypeInfo char_win_stdio_type_info = {
2610 .name = TYPE_CHARDEV_WIN_STDIO,
2611 .parent = TYPE_CHARDEV,
2612 .instance_size = sizeof(WinStdioChardev),
2613 .instance_finalize = char_win_stdio_finalize,
2614 .abstract = true,
2617 static void qemu_chr_open_stdio(Chardev *chr,
2618 ChardevBackend *backend,
2619 bool *be_opened,
2620 Error **errp)
2622 WinStdioChardev *stdio = WIN_STDIO_CHARDEV(chr);
2623 DWORD dwMode;
2624 int is_console = 0;
2626 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2627 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2628 error_setg(errp, "cannot open stdio: invalid handle");
2629 return;
2632 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2634 if (is_console) {
2635 if (qemu_add_wait_object(stdio->hStdIn,
2636 win_stdio_wait_func, chr)) {
2637 error_setg(errp, "qemu_add_wait_object: failed");
2638 goto err1;
2640 } else {
2641 DWORD dwId;
2643 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2644 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2645 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2646 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2647 error_setg(errp, "cannot create event");
2648 goto err2;
2650 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2651 win_stdio_thread_wait_func, chr)) {
2652 error_setg(errp, "qemu_add_wait_object: failed");
2653 goto err2;
2655 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2656 chr, 0, &dwId);
2658 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2659 error_setg(errp, "cannot create stdio thread");
2660 goto err3;
2664 dwMode |= ENABLE_LINE_INPUT;
2666 if (is_console) {
2667 /* set the terminal in raw mode */
2668 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2669 dwMode |= ENABLE_PROCESSED_INPUT;
2672 SetConsoleMode(stdio->hStdIn, dwMode);
2674 qemu_chr_set_echo_win_stdio(chr, false);
2676 return;
2678 err3:
2679 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2680 err2:
2681 CloseHandle(stdio->hInputReadyEvent);
2682 CloseHandle(stdio->hInputDoneEvent);
2683 err1:
2684 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2686 #endif /* !_WIN32 */
2688 /***********************************************************/
2689 /* UDP Net console */
2691 typedef struct {
2692 Chardev parent;
2693 QIOChannel *ioc;
2694 uint8_t buf[READ_BUF_LEN];
2695 int bufcnt;
2696 int bufptr;
2697 int max_size;
2698 } UdpChardev;
2700 #define UDP_CHARDEV(obj) OBJECT_CHECK(UdpChardev, (obj), TYPE_CHARDEV_UDP)
2702 /* Called with chr_write_lock held. */
2703 static int udp_chr_write(Chardev *chr, const uint8_t *buf, int len)
2705 UdpChardev *s = UDP_CHARDEV(chr);
2707 return qio_channel_write(
2708 s->ioc, (const char *)buf, len, NULL);
2711 static int udp_chr_read_poll(void *opaque)
2713 Chardev *chr = CHARDEV(opaque);
2714 UdpChardev *s = UDP_CHARDEV(opaque);
2716 s->max_size = qemu_chr_be_can_write(chr);
2718 /* If there were any stray characters in the queue process them
2719 * first
2721 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2722 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2723 s->bufptr++;
2724 s->max_size = qemu_chr_be_can_write(chr);
2726 return s->max_size;
2729 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2731 Chardev *chr = CHARDEV(opaque);
2732 UdpChardev *s = UDP_CHARDEV(opaque);
2733 ssize_t ret;
2735 if (s->max_size == 0) {
2736 return TRUE;
2738 ret = qio_channel_read(
2739 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2740 if (ret <= 0) {
2741 remove_fd_in_watch(chr);
2742 return FALSE;
2744 s->bufcnt = ret;
2746 s->bufptr = 0;
2747 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2748 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2749 s->bufptr++;
2750 s->max_size = qemu_chr_be_can_write(chr);
2753 return TRUE;
2756 static void udp_chr_update_read_handler(Chardev *chr,
2757 GMainContext *context)
2759 UdpChardev *s = UDP_CHARDEV(chr);
2761 remove_fd_in_watch(chr);
2762 if (s->ioc) {
2763 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
2764 udp_chr_read_poll,
2765 udp_chr_read, chr,
2766 context);
2770 static void char_udp_finalize(Object *obj)
2772 Chardev *chr = CHARDEV(obj);
2773 UdpChardev *s = UDP_CHARDEV(obj);
2775 remove_fd_in_watch(chr);
2776 if (s->ioc) {
2777 object_unref(OBJECT(s->ioc));
2779 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2782 /***********************************************************/
2783 /* TCP Net console */
2785 typedef struct {
2786 Chardev parent;
2787 QIOChannel *ioc; /* Client I/O channel */
2788 QIOChannelSocket *sioc; /* Client master channel */
2789 QIOChannelSocket *listen_ioc;
2790 guint listen_tag;
2791 QCryptoTLSCreds *tls_creds;
2792 int connected;
2793 int max_size;
2794 int do_telnetopt;
2795 int do_nodelay;
2796 int is_unix;
2797 int *read_msgfds;
2798 size_t read_msgfds_num;
2799 int *write_msgfds;
2800 size_t write_msgfds_num;
2802 SocketAddress *addr;
2803 bool is_listen;
2804 bool is_telnet;
2806 guint reconnect_timer;
2807 int64_t reconnect_time;
2808 bool connect_err_reported;
2809 } SocketChardev;
2811 #define SOCKET_CHARDEV(obj) \
2812 OBJECT_CHECK(SocketChardev, (obj), TYPE_CHARDEV_SOCKET)
2814 static gboolean socket_reconnect_timeout(gpointer opaque);
2816 static void qemu_chr_socket_restart_timer(Chardev *chr)
2818 SocketChardev *s = SOCKET_CHARDEV(chr);
2819 char *name;
2821 assert(s->connected == 0);
2822 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2823 socket_reconnect_timeout, chr);
2824 name = g_strdup_printf("chardev-socket-reconnect-%s", chr->label);
2825 g_source_set_name_by_id(s->reconnect_timer, name);
2826 g_free(name);
2829 static void check_report_connect_error(Chardev *chr,
2830 Error *err)
2832 SocketChardev *s = SOCKET_CHARDEV(chr);
2834 if (!s->connect_err_reported) {
2835 error_report("Unable to connect character device %s: %s",
2836 chr->label, error_get_pretty(err));
2837 s->connect_err_reported = true;
2839 qemu_chr_socket_restart_timer(chr);
2842 static gboolean tcp_chr_accept(QIOChannel *chan,
2843 GIOCondition cond,
2844 void *opaque);
2846 /* Called with chr_write_lock held. */
2847 static int tcp_chr_write(Chardev *chr, const uint8_t *buf, int len)
2849 SocketChardev *s = SOCKET_CHARDEV(chr);
2851 if (s->connected) {
2852 int ret = io_channel_send_full(s->ioc, buf, len,
2853 s->write_msgfds,
2854 s->write_msgfds_num);
2856 /* free the written msgfds, no matter what */
2857 if (s->write_msgfds_num) {
2858 g_free(s->write_msgfds);
2859 s->write_msgfds = 0;
2860 s->write_msgfds_num = 0;
2863 return ret;
2864 } else {
2865 /* XXX: indicate an error ? */
2866 return len;
2870 static int tcp_chr_read_poll(void *opaque)
2872 Chardev *chr = CHARDEV(opaque);
2873 SocketChardev *s = SOCKET_CHARDEV(opaque);
2874 if (!s->connected)
2875 return 0;
2876 s->max_size = qemu_chr_be_can_write(chr);
2877 return s->max_size;
2880 #define IAC 255
2881 #define IAC_BREAK 243
2882 static void tcp_chr_process_IAC_bytes(Chardev *chr,
2883 SocketChardev *s,
2884 uint8_t *buf, int *size)
2886 /* Handle any telnet client's basic IAC options to satisfy char by
2887 * char mode with no echo. All IAC options will be removed from
2888 * the buf and the do_telnetopt variable will be used to track the
2889 * state of the width of the IAC information.
2891 * IAC commands come in sets of 3 bytes with the exception of the
2892 * "IAC BREAK" command and the double IAC.
2895 int i;
2896 int j = 0;
2898 for (i = 0; i < *size; i++) {
2899 if (s->do_telnetopt > 1) {
2900 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2901 /* Double IAC means send an IAC */
2902 if (j != i)
2903 buf[j] = buf[i];
2904 j++;
2905 s->do_telnetopt = 1;
2906 } else {
2907 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2908 /* Handle IAC break commands by sending a serial break */
2909 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2910 s->do_telnetopt++;
2912 s->do_telnetopt++;
2914 if (s->do_telnetopt >= 4) {
2915 s->do_telnetopt = 1;
2917 } else {
2918 if ((unsigned char)buf[i] == IAC) {
2919 s->do_telnetopt = 2;
2920 } else {
2921 if (j != i)
2922 buf[j] = buf[i];
2923 j++;
2927 *size = j;
2930 static int tcp_get_msgfds(Chardev *chr, int *fds, int num)
2932 SocketChardev *s = SOCKET_CHARDEV(chr);
2934 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2936 assert(num <= TCP_MAX_FDS);
2938 if (to_copy) {
2939 int i;
2941 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2943 /* Close unused fds */
2944 for (i = to_copy; i < s->read_msgfds_num; i++) {
2945 close(s->read_msgfds[i]);
2948 g_free(s->read_msgfds);
2949 s->read_msgfds = 0;
2950 s->read_msgfds_num = 0;
2953 return to_copy;
2956 static int tcp_set_msgfds(Chardev *chr, int *fds, int num)
2958 SocketChardev *s = SOCKET_CHARDEV(chr);
2960 /* clear old pending fd array */
2961 g_free(s->write_msgfds);
2962 s->write_msgfds = NULL;
2963 s->write_msgfds_num = 0;
2965 if (!s->connected ||
2966 !qio_channel_has_feature(s->ioc,
2967 QIO_CHANNEL_FEATURE_FD_PASS)) {
2968 return -1;
2971 if (num) {
2972 s->write_msgfds = g_new(int, num);
2973 memcpy(s->write_msgfds, fds, num * sizeof(int));
2976 s->write_msgfds_num = num;
2978 return 0;
2981 static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
2983 SocketChardev *s = SOCKET_CHARDEV(chr);
2984 struct iovec iov = { .iov_base = buf, .iov_len = len };
2985 int ret;
2986 size_t i;
2987 int *msgfds = NULL;
2988 size_t msgfds_num = 0;
2990 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2991 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2992 &msgfds, &msgfds_num,
2993 NULL);
2994 } else {
2995 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2996 NULL, NULL,
2997 NULL);
3000 if (ret == QIO_CHANNEL_ERR_BLOCK) {
3001 errno = EAGAIN;
3002 ret = -1;
3003 } else if (ret == -1) {
3004 errno = EIO;
3007 if (msgfds_num) {
3008 /* close and clean read_msgfds */
3009 for (i = 0; i < s->read_msgfds_num; i++) {
3010 close(s->read_msgfds[i]);
3013 if (s->read_msgfds_num) {
3014 g_free(s->read_msgfds);
3017 s->read_msgfds = msgfds;
3018 s->read_msgfds_num = msgfds_num;
3021 for (i = 0; i < s->read_msgfds_num; i++) {
3022 int fd = s->read_msgfds[i];
3023 if (fd < 0) {
3024 continue;
3027 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
3028 qemu_set_block(fd);
3030 #ifndef MSG_CMSG_CLOEXEC
3031 qemu_set_cloexec(fd);
3032 #endif
3035 return ret;
3038 static GSource *tcp_chr_add_watch(Chardev *chr, GIOCondition cond)
3040 SocketChardev *s = SOCKET_CHARDEV(chr);
3041 return qio_channel_create_watch(s->ioc, cond);
3044 static void tcp_chr_free_connection(Chardev *chr)
3046 SocketChardev *s = SOCKET_CHARDEV(chr);
3047 int i;
3049 if (!s->connected) {
3050 return;
3053 if (s->read_msgfds_num) {
3054 for (i = 0; i < s->read_msgfds_num; i++) {
3055 close(s->read_msgfds[i]);
3057 g_free(s->read_msgfds);
3058 s->read_msgfds = NULL;
3059 s->read_msgfds_num = 0;
3062 tcp_set_msgfds(chr, NULL, 0);
3063 remove_fd_in_watch(chr);
3064 object_unref(OBJECT(s->sioc));
3065 s->sioc = NULL;
3066 object_unref(OBJECT(s->ioc));
3067 s->ioc = NULL;
3068 g_free(chr->filename);
3069 chr->filename = NULL;
3070 s->connected = 0;
3073 static void tcp_chr_disconnect(Chardev *chr)
3075 SocketChardev *s = SOCKET_CHARDEV(chr);
3077 if (!s->connected) {
3078 return;
3081 tcp_chr_free_connection(chr);
3083 if (s->listen_ioc) {
3084 s->listen_tag = qio_channel_add_watch(
3085 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
3087 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
3088 s->is_listen, s->is_telnet);
3089 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3090 if (s->reconnect_time) {
3091 qemu_chr_socket_restart_timer(chr);
3095 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
3097 Chardev *chr = CHARDEV(opaque);
3098 SocketChardev *s = SOCKET_CHARDEV(opaque);
3099 uint8_t buf[READ_BUF_LEN];
3100 int len, size;
3102 if (!s->connected || s->max_size <= 0) {
3103 return TRUE;
3105 len = sizeof(buf);
3106 if (len > s->max_size)
3107 len = s->max_size;
3108 size = tcp_chr_recv(chr, (void *)buf, len);
3109 if (size == 0 || size == -1) {
3110 /* connection closed */
3111 tcp_chr_disconnect(chr);
3112 } else if (size > 0) {
3113 if (s->do_telnetopt)
3114 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
3115 if (size > 0)
3116 qemu_chr_be_write(chr, buf, size);
3119 return TRUE;
3122 static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len)
3124 SocketChardev *s = SOCKET_CHARDEV(chr);
3125 int size;
3127 if (!s->connected) {
3128 return 0;
3131 size = tcp_chr_recv(chr, (void *) buf, len);
3132 if (size == 0) {
3133 /* connection closed */
3134 tcp_chr_disconnect(chr);
3137 return size;
3140 static void tcp_chr_connect(void *opaque)
3142 Chardev *chr = CHARDEV(opaque);
3143 SocketChardev *s = SOCKET_CHARDEV(opaque);
3145 g_free(chr->filename);
3146 chr->filename = sockaddr_to_str(
3147 &s->sioc->localAddr, s->sioc->localAddrLen,
3148 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
3149 s->is_listen, s->is_telnet);
3151 s->connected = 1;
3152 if (s->ioc) {
3153 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
3154 tcp_chr_read_poll,
3155 tcp_chr_read,
3156 chr, NULL);
3158 qemu_chr_be_generic_open(chr);
3161 static void tcp_chr_update_read_handler(Chardev *chr,
3162 GMainContext *context)
3164 SocketChardev *s = SOCKET_CHARDEV(chr);
3166 if (!s->connected) {
3167 return;
3170 remove_fd_in_watch(chr);
3171 if (s->ioc) {
3172 chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
3173 tcp_chr_read_poll,
3174 tcp_chr_read, chr,
3175 context);
3179 typedef struct {
3180 Chardev *chr;
3181 char buf[12];
3182 size_t buflen;
3183 } TCPCharDriverTelnetInit;
3185 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
3186 GIOCondition cond G_GNUC_UNUSED,
3187 gpointer user_data)
3189 TCPCharDriverTelnetInit *init = user_data;
3190 ssize_t ret;
3192 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
3193 if (ret < 0) {
3194 if (ret == QIO_CHANNEL_ERR_BLOCK) {
3195 ret = 0;
3196 } else {
3197 tcp_chr_disconnect(init->chr);
3198 return FALSE;
3201 init->buflen -= ret;
3203 if (init->buflen == 0) {
3204 tcp_chr_connect(init->chr);
3205 return FALSE;
3208 memmove(init->buf, init->buf + ret, init->buflen);
3210 return TRUE;
3213 static void tcp_chr_telnet_init(Chardev *chr)
3215 SocketChardev *s = SOCKET_CHARDEV(chr);
3216 TCPCharDriverTelnetInit *init =
3217 g_new0(TCPCharDriverTelnetInit, 1);
3218 size_t n = 0;
3220 init->chr = chr;
3221 init->buflen = 12;
3223 #define IACSET(x, a, b, c) \
3224 do { \
3225 x[n++] = a; \
3226 x[n++] = b; \
3227 x[n++] = c; \
3228 } while (0)
3230 /* Prep the telnet negotion to put telnet in binary,
3231 * no echo, single char mode */
3232 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3233 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3234 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3235 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3237 #undef IACSET
3239 qio_channel_add_watch(
3240 s->ioc, G_IO_OUT,
3241 tcp_chr_telnet_init_io,
3242 init, NULL);
3246 static void tcp_chr_tls_handshake(QIOTask *task,
3247 gpointer user_data)
3249 Chardev *chr = user_data;
3250 SocketChardev *s = user_data;
3252 if (qio_task_propagate_error(task, NULL)) {
3253 tcp_chr_disconnect(chr);
3254 } else {
3255 if (s->do_telnetopt) {
3256 tcp_chr_telnet_init(chr);
3257 } else {
3258 tcp_chr_connect(chr);
3264 static void tcp_chr_tls_init(Chardev *chr)
3266 SocketChardev *s = SOCKET_CHARDEV(chr);
3267 QIOChannelTLS *tioc;
3268 Error *err = NULL;
3269 gchar *name;
3271 if (s->is_listen) {
3272 tioc = qio_channel_tls_new_server(
3273 s->ioc, s->tls_creds,
3274 NULL, /* XXX Use an ACL */
3275 &err);
3276 } else {
3277 tioc = qio_channel_tls_new_client(
3278 s->ioc, s->tls_creds,
3279 s->addr->u.inet.data->host,
3280 &err);
3282 if (tioc == NULL) {
3283 error_free(err);
3284 tcp_chr_disconnect(chr);
3285 return;
3287 name = g_strdup_printf("chardev-tls-%s-%s",
3288 s->is_listen ? "server" : "client",
3289 chr->label);
3290 qio_channel_set_name(QIO_CHANNEL(tioc), name);
3291 g_free(name);
3292 object_unref(OBJECT(s->ioc));
3293 s->ioc = QIO_CHANNEL(tioc);
3295 qio_channel_tls_handshake(tioc,
3296 tcp_chr_tls_handshake,
3297 chr,
3298 NULL);
3302 static void tcp_chr_set_client_ioc_name(Chardev *chr,
3303 QIOChannelSocket *sioc)
3305 SocketChardev *s = SOCKET_CHARDEV(chr);
3306 char *name;
3307 name = g_strdup_printf("chardev-tcp-%s-%s",
3308 s->is_listen ? "server" : "client",
3309 chr->label);
3310 qio_channel_set_name(QIO_CHANNEL(sioc), name);
3311 g_free(name);
3315 static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc)
3317 SocketChardev *s = SOCKET_CHARDEV(chr);
3319 if (s->ioc != NULL) {
3320 return -1;
3323 s->ioc = QIO_CHANNEL(sioc);
3324 object_ref(OBJECT(sioc));
3325 s->sioc = sioc;
3326 object_ref(OBJECT(sioc));
3328 qio_channel_set_blocking(s->ioc, false, NULL);
3330 if (s->do_nodelay) {
3331 qio_channel_set_delay(s->ioc, false);
3333 if (s->listen_tag) {
3334 g_source_remove(s->listen_tag);
3335 s->listen_tag = 0;
3338 if (s->tls_creds) {
3339 tcp_chr_tls_init(chr);
3340 } else {
3341 if (s->do_telnetopt) {
3342 tcp_chr_telnet_init(chr);
3343 } else {
3344 tcp_chr_connect(chr);
3348 return 0;
3352 static int tcp_chr_add_client(Chardev *chr, int fd)
3354 int ret;
3355 QIOChannelSocket *sioc;
3357 sioc = qio_channel_socket_new_fd(fd, NULL);
3358 if (!sioc) {
3359 return -1;
3361 tcp_chr_set_client_ioc_name(chr, sioc);
3362 ret = tcp_chr_new_client(chr, sioc);
3363 object_unref(OBJECT(sioc));
3364 return ret;
3367 static gboolean tcp_chr_accept(QIOChannel *channel,
3368 GIOCondition cond,
3369 void *opaque)
3371 Chardev *chr = CHARDEV(opaque);
3372 QIOChannelSocket *sioc;
3374 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3375 NULL);
3376 if (!sioc) {
3377 return TRUE;
3380 tcp_chr_new_client(chr, sioc);
3382 object_unref(OBJECT(sioc));
3384 return TRUE;
3387 static int tcp_chr_wait_connected(Chardev *chr, Error **errp)
3389 SocketChardev *s = SOCKET_CHARDEV(chr);
3390 QIOChannelSocket *sioc;
3392 /* It can't wait on s->connected, since it is set asynchronously
3393 * in TLS and telnet cases, only wait for an accepted socket */
3394 while (!s->ioc) {
3395 if (s->is_listen) {
3396 error_report("QEMU waiting for connection on: %s",
3397 chr->filename);
3398 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), true, NULL);
3399 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
3400 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
3401 } else {
3402 sioc = qio_channel_socket_new();
3403 tcp_chr_set_client_ioc_name(chr, sioc);
3404 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
3405 object_unref(OBJECT(sioc));
3406 return -1;
3408 tcp_chr_new_client(chr, sioc);
3409 object_unref(OBJECT(sioc));
3413 return 0;
3416 static int qemu_chr_wait_connected(Chardev *chr, Error **errp)
3418 ChardevClass *cc = CHARDEV_GET_CLASS(chr);
3420 if (cc->chr_wait_connected) {
3421 return cc->chr_wait_connected(chr, errp);
3424 return 0;
3427 int qemu_chr_fe_wait_connected(CharBackend *be, Error **errp)
3429 if (!be->chr) {
3430 error_setg(errp, "missing associated backend");
3431 return -1;
3434 return qemu_chr_wait_connected(be->chr, errp);
3437 static void char_socket_finalize(Object *obj)
3439 Chardev *chr = CHARDEV(obj);
3440 SocketChardev *s = SOCKET_CHARDEV(obj);
3442 tcp_chr_free_connection(chr);
3444 if (s->reconnect_timer) {
3445 g_source_remove(s->reconnect_timer);
3446 s->reconnect_timer = 0;
3448 qapi_free_SocketAddress(s->addr);
3449 if (s->listen_tag) {
3450 g_source_remove(s->listen_tag);
3451 s->listen_tag = 0;
3453 if (s->listen_ioc) {
3454 object_unref(OBJECT(s->listen_ioc));
3456 if (s->tls_creds) {
3457 object_unref(OBJECT(s->tls_creds));
3460 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3464 static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
3466 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
3467 Chardev *chr = CHARDEV(opaque);
3468 SocketChardev *s = SOCKET_CHARDEV(chr);
3469 Error *err = NULL;
3471 if (qio_task_propagate_error(task, &err)) {
3472 check_report_connect_error(chr, err);
3473 error_free(err);
3474 goto cleanup;
3477 s->connect_err_reported = false;
3478 tcp_chr_new_client(chr, sioc);
3480 cleanup:
3481 object_unref(OBJECT(sioc));
3485 /*********************************************************/
3486 /* Ring buffer chardev */
3488 typedef struct {
3489 Chardev parent;
3490 size_t size;
3491 size_t prod;
3492 size_t cons;
3493 uint8_t *cbuf;
3494 } RingBufChardev;
3496 #define RINGBUF_CHARDEV(obj) \
3497 OBJECT_CHECK(RingBufChardev, (obj), TYPE_CHARDEV_RINGBUF)
3499 static size_t ringbuf_count(const Chardev *chr)
3501 const RingBufChardev *d = RINGBUF_CHARDEV(chr);
3503 return d->prod - d->cons;
3506 /* Called with chr_write_lock held. */
3507 static int ringbuf_chr_write(Chardev *chr, const uint8_t *buf, int len)
3509 RingBufChardev *d = RINGBUF_CHARDEV(chr);
3510 int i;
3512 if (!buf || (len < 0)) {
3513 return -1;
3516 for (i = 0; i < len; i++ ) {
3517 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3518 if (d->prod - d->cons > d->size) {
3519 d->cons = d->prod - d->size;
3523 return len;
3526 static int ringbuf_chr_read(Chardev *chr, uint8_t *buf, int len)
3528 RingBufChardev *d = RINGBUF_CHARDEV(chr);
3529 int i;
3531 qemu_mutex_lock(&chr->chr_write_lock);
3532 for (i = 0; i < len && d->cons != d->prod; i++) {
3533 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3535 qemu_mutex_unlock(&chr->chr_write_lock);
3537 return i;
3540 static void char_ringbuf_finalize(Object *obj)
3542 RingBufChardev *d = RINGBUF_CHARDEV(obj);
3544 g_free(d->cbuf);
3547 static void qemu_chr_open_ringbuf(Chardev *chr,
3548 ChardevBackend *backend,
3549 bool *be_opened,
3550 Error **errp)
3552 ChardevRingbuf *opts = backend->u.ringbuf.data;
3553 RingBufChardev *d = RINGBUF_CHARDEV(chr);
3555 d->size = opts->has_size ? opts->size : 65536;
3557 /* The size must be power of 2 */
3558 if (d->size & (d->size - 1)) {
3559 error_setg(errp, "size of ringbuf chardev must be power of two");
3560 return;
3563 d->prod = 0;
3564 d->cons = 0;
3565 d->cbuf = g_malloc0(d->size);
3568 void qmp_ringbuf_write(const char *device, const char *data,
3569 bool has_format, enum DataFormat format,
3570 Error **errp)
3572 Chardev *chr;
3573 const uint8_t *write_data;
3574 int ret;
3575 gsize write_count;
3577 chr = qemu_chr_find(device);
3578 if (!chr) {
3579 error_setg(errp, "Device '%s' not found", device);
3580 return;
3583 if (!CHARDEV_IS_RINGBUF(chr)) {
3584 error_setg(errp,"%s is not a ringbuf device", device);
3585 return;
3588 if (has_format && (format == DATA_FORMAT_BASE64)) {
3589 write_data = qbase64_decode(data, -1,
3590 &write_count,
3591 errp);
3592 if (!write_data) {
3593 return;
3595 } else {
3596 write_data = (uint8_t *)data;
3597 write_count = strlen(data);
3600 ret = ringbuf_chr_write(chr, write_data, write_count);
3602 if (write_data != (uint8_t *)data) {
3603 g_free((void *)write_data);
3606 if (ret < 0) {
3607 error_setg(errp, "Failed to write to device %s", device);
3608 return;
3612 char *qmp_ringbuf_read(const char *device, int64_t size,
3613 bool has_format, enum DataFormat format,
3614 Error **errp)
3616 Chardev *chr;
3617 uint8_t *read_data;
3618 size_t count;
3619 char *data;
3621 chr = qemu_chr_find(device);
3622 if (!chr) {
3623 error_setg(errp, "Device '%s' not found", device);
3624 return NULL;
3627 if (!CHARDEV_IS_RINGBUF(chr)) {
3628 error_setg(errp,"%s is not a ringbuf device", device);
3629 return NULL;
3632 if (size <= 0) {
3633 error_setg(errp, "size must be greater than zero");
3634 return NULL;
3637 count = ringbuf_count(chr);
3638 size = size > count ? count : size;
3639 read_data = g_malloc(size + 1);
3641 ringbuf_chr_read(chr, read_data, size);
3643 if (has_format && (format == DATA_FORMAT_BASE64)) {
3644 data = g_base64_encode(read_data, size);
3645 g_free(read_data);
3646 } else {
3648 * FIXME should read only complete, valid UTF-8 characters up
3649 * to @size bytes. Invalid sequences should be replaced by a
3650 * suitable replacement character. Except when (and only
3651 * when) ring buffer lost characters since last read, initial
3652 * continuation characters should be dropped.
3654 read_data[size] = 0;
3655 data = (char *)read_data;
3658 return data;
3661 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3663 char host[65], port[33], width[8], height[8];
3664 int pos;
3665 const char *p;
3666 QemuOpts *opts;
3667 Error *local_err = NULL;
3669 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3670 if (local_err) {
3671 error_report_err(local_err);
3672 return NULL;
3675 if (strstart(filename, "mon:", &p)) {
3676 filename = p;
3677 qemu_opt_set(opts, "mux", "on", &error_abort);
3678 if (strcmp(filename, "stdio") == 0) {
3679 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3680 * but pass it to the guest. Handle this only for compat syntax,
3681 * for -chardev syntax we have special option for this.
3682 * This is what -nographic did, redirecting+muxing serial+monitor
3683 * to stdio causing Ctrl+C to be passed to guest. */
3684 qemu_opt_set(opts, "signal", "off", &error_abort);
3688 if (strcmp(filename, "null") == 0 ||
3689 strcmp(filename, "pty") == 0 ||
3690 strcmp(filename, "msmouse") == 0 ||
3691 strcmp(filename, "braille") == 0 ||
3692 strcmp(filename, "testdev") == 0 ||
3693 strcmp(filename, "stdio") == 0) {
3694 qemu_opt_set(opts, "backend", filename, &error_abort);
3695 return opts;
3697 if (strstart(filename, "vc", &p)) {
3698 qemu_opt_set(opts, "backend", "vc", &error_abort);
3699 if (*p == ':') {
3700 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3701 /* pixels */
3702 qemu_opt_set(opts, "width", width, &error_abort);
3703 qemu_opt_set(opts, "height", height, &error_abort);
3704 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3705 /* chars */
3706 qemu_opt_set(opts, "cols", width, &error_abort);
3707 qemu_opt_set(opts, "rows", height, &error_abort);
3708 } else {
3709 goto fail;
3712 return opts;
3714 if (strcmp(filename, "con:") == 0) {
3715 qemu_opt_set(opts, "backend", "console", &error_abort);
3716 return opts;
3718 if (strstart(filename, "COM", NULL)) {
3719 qemu_opt_set(opts, "backend", "serial", &error_abort);
3720 qemu_opt_set(opts, "path", filename, &error_abort);
3721 return opts;
3723 if (strstart(filename, "file:", &p)) {
3724 qemu_opt_set(opts, "backend", "file", &error_abort);
3725 qemu_opt_set(opts, "path", p, &error_abort);
3726 return opts;
3728 if (strstart(filename, "pipe:", &p)) {
3729 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3730 qemu_opt_set(opts, "path", p, &error_abort);
3731 return opts;
3733 if (strstart(filename, "tcp:", &p) ||
3734 strstart(filename, "telnet:", &p)) {
3735 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3736 host[0] = 0;
3737 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3738 goto fail;
3740 qemu_opt_set(opts, "backend", "socket", &error_abort);
3741 qemu_opt_set(opts, "host", host, &error_abort);
3742 qemu_opt_set(opts, "port", port, &error_abort);
3743 if (p[pos] == ',') {
3744 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3745 if (local_err) {
3746 error_report_err(local_err);
3747 goto fail;
3750 if (strstart(filename, "telnet:", &p))
3751 qemu_opt_set(opts, "telnet", "on", &error_abort);
3752 return opts;
3754 if (strstart(filename, "udp:", &p)) {
3755 qemu_opt_set(opts, "backend", "udp", &error_abort);
3756 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3757 host[0] = 0;
3758 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3759 goto fail;
3762 qemu_opt_set(opts, "host", host, &error_abort);
3763 qemu_opt_set(opts, "port", port, &error_abort);
3764 if (p[pos] == '@') {
3765 p += pos + 1;
3766 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3767 host[0] = 0;
3768 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3769 goto fail;
3772 qemu_opt_set(opts, "localaddr", host, &error_abort);
3773 qemu_opt_set(opts, "localport", port, &error_abort);
3775 return opts;
3777 if (strstart(filename, "unix:", &p)) {
3778 qemu_opt_set(opts, "backend", "socket", &error_abort);
3779 qemu_opts_do_parse(opts, p, "path", &local_err);
3780 if (local_err) {
3781 error_report_err(local_err);
3782 goto fail;
3784 return opts;
3786 if (strstart(filename, "/dev/parport", NULL) ||
3787 strstart(filename, "/dev/ppi", NULL)) {
3788 qemu_opt_set(opts, "backend", "parport", &error_abort);
3789 qemu_opt_set(opts, "path", filename, &error_abort);
3790 return opts;
3792 if (strstart(filename, "/dev/", NULL)) {
3793 qemu_opt_set(opts, "backend", "tty", &error_abort);
3794 qemu_opt_set(opts, "path", filename, &error_abort);
3795 return opts;
3798 fail:
3799 qemu_opts_del(opts);
3800 return NULL;
3803 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3805 const char *logfile = qemu_opt_get(opts, "logfile");
3807 backend->has_logfile = logfile != NULL;
3808 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3810 backend->has_logappend = true;
3811 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3815 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3816 Error **errp)
3818 const char *path = qemu_opt_get(opts, "path");
3819 ChardevFile *file;
3821 if (path == NULL) {
3822 error_setg(errp, "chardev: file: no filename given");
3823 return;
3825 file = backend->u.file.data = g_new0(ChardevFile, 1);
3826 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3827 file->out = g_strdup(path);
3829 file->has_append = true;
3830 file->append = qemu_opt_get_bool(opts, "append", false);
3833 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3834 Error **errp)
3836 ChardevStdio *stdio;
3838 stdio = backend->u.stdio.data = g_new0(ChardevStdio, 1);
3839 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3840 stdio->has_signal = true;
3841 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3844 static const CharDriver stdio_driver = {
3845 .kind = CHARDEV_BACKEND_KIND_STDIO,
3846 .parse = qemu_chr_parse_stdio,
3849 static void char_stdio_class_init(ObjectClass *oc, void *data)
3851 ChardevClass *cc = CHARDEV_CLASS(oc);
3853 cc->open = qemu_chr_open_stdio;
3854 #ifdef _WIN32
3855 cc->chr_write = win_stdio_write;
3856 cc->chr_set_echo = qemu_chr_set_echo_win_stdio;
3857 #else
3858 cc->chr_set_echo = qemu_chr_set_echo_stdio;
3859 #endif
3862 static const TypeInfo char_stdio_type_info = {
3863 .name = TYPE_CHARDEV_STDIO,
3864 #ifdef _WIN32
3865 .parent = TYPE_CHARDEV_WIN_STDIO,
3866 #else
3867 .parent = TYPE_CHARDEV_FD,
3868 .instance_finalize = char_stdio_finalize,
3869 #endif
3870 .class_init = char_stdio_class_init,
3873 #ifdef HAVE_CHARDEV_SERIAL
3874 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3875 Error **errp)
3877 const char *device = qemu_opt_get(opts, "path");
3878 ChardevHostdev *serial;
3880 if (device == NULL) {
3881 error_setg(errp, "chardev: serial/tty: no device path given");
3882 return;
3884 serial = backend->u.serial.data = g_new0(ChardevHostdev, 1);
3885 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3886 serial->device = g_strdup(device);
3888 #endif
3890 #ifdef HAVE_CHARDEV_PARPORT
3891 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3892 Error **errp)
3894 const char *device = qemu_opt_get(opts, "path");
3895 ChardevHostdev *parallel;
3897 if (device == NULL) {
3898 error_setg(errp, "chardev: parallel: no device path given");
3899 return;
3901 parallel = backend->u.parallel.data = g_new0(ChardevHostdev, 1);
3902 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3903 parallel->device = g_strdup(device);
3905 #endif
3907 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3908 Error **errp)
3910 const char *device = qemu_opt_get(opts, "path");
3911 ChardevHostdev *dev;
3913 if (device == NULL) {
3914 error_setg(errp, "chardev: pipe: no device path given");
3915 return;
3917 dev = backend->u.pipe.data = g_new0(ChardevHostdev, 1);
3918 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3919 dev->device = g_strdup(device);
3922 static const CharDriver pipe_driver = {
3923 .kind = CHARDEV_BACKEND_KIND_PIPE,
3924 .parse = qemu_chr_parse_pipe,
3927 static void char_pipe_class_init(ObjectClass *oc, void *data)
3929 ChardevClass *cc = CHARDEV_CLASS(oc);
3931 cc->open = qemu_chr_open_pipe;
3934 static const TypeInfo char_pipe_type_info = {
3935 .name = TYPE_CHARDEV_PIPE,
3936 #ifdef _WIN32
3937 .parent = TYPE_CHARDEV_WIN,
3938 #else
3939 .parent = TYPE_CHARDEV_FD,
3940 #endif
3941 .class_init = char_pipe_class_init,
3944 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3945 Error **errp)
3947 int val;
3948 ChardevRingbuf *ringbuf;
3950 ringbuf = backend->u.ringbuf.data = g_new0(ChardevRingbuf, 1);
3951 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3953 val = qemu_opt_get_size(opts, "size", 0);
3954 if (val != 0) {
3955 ringbuf->has_size = true;
3956 ringbuf->size = val;
3960 static const CharDriver ringbuf_driver = {
3961 .kind = CHARDEV_BACKEND_KIND_RINGBUF,
3962 .parse = qemu_chr_parse_ringbuf,
3965 static void char_ringbuf_class_init(ObjectClass *oc, void *data)
3967 ChardevClass *cc = CHARDEV_CLASS(oc);
3969 cc->open = qemu_chr_open_ringbuf;
3970 cc->chr_write = ringbuf_chr_write;
3973 static const TypeInfo char_ringbuf_type_info = {
3974 .name = TYPE_CHARDEV_RINGBUF,
3975 .parent = TYPE_CHARDEV,
3976 .class_init = char_ringbuf_class_init,
3977 .instance_size = sizeof(RingBufChardev),
3978 .instance_finalize = char_ringbuf_finalize,
3981 /* Bug-compatibility: */
3982 static const CharDriver memory_driver = {
3983 .kind = CHARDEV_BACKEND_KIND_MEMORY,
3984 .parse = qemu_chr_parse_ringbuf,
3987 static const TypeInfo char_memory_type_info = {
3988 .name = TYPE_CHARDEV_MEMORY,
3989 .parent = TYPE_CHARDEV_RINGBUF,
3992 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3993 Error **errp)
3995 const char *chardev = qemu_opt_get(opts, "chardev");
3996 ChardevMux *mux;
3998 if (chardev == NULL) {
3999 error_setg(errp, "chardev: mux: no chardev given");
4000 return;
4002 mux = backend->u.mux.data = g_new0(ChardevMux, 1);
4003 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
4004 mux->chardev = g_strdup(chardev);
4007 static const CharDriver mux_driver = {
4008 .kind = CHARDEV_BACKEND_KIND_MUX,
4009 .parse = qemu_chr_parse_mux,
4012 static void char_mux_class_init(ObjectClass *oc, void *data)
4014 ChardevClass *cc = CHARDEV_CLASS(oc);
4016 cc->open = qemu_chr_open_mux;
4017 cc->chr_write = mux_chr_write;
4018 cc->chr_accept_input = mux_chr_accept_input;
4019 cc->chr_add_watch = mux_chr_add_watch;
4022 static const TypeInfo char_mux_type_info = {
4023 .name = TYPE_CHARDEV_MUX,
4024 .parent = TYPE_CHARDEV,
4025 .class_init = char_mux_class_init,
4026 .instance_size = sizeof(MuxChardev),
4027 .instance_finalize = char_mux_finalize,
4030 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
4031 Error **errp)
4033 bool is_listen = qemu_opt_get_bool(opts, "server", false);
4034 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
4035 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
4036 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
4037 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
4038 const char *path = qemu_opt_get(opts, "path");
4039 const char *host = qemu_opt_get(opts, "host");
4040 const char *port = qemu_opt_get(opts, "port");
4041 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
4042 SocketAddress *addr;
4043 ChardevSocket *sock;
4045 if (!path) {
4046 if (!host) {
4047 error_setg(errp, "chardev: socket: no host given");
4048 return;
4050 if (!port) {
4051 error_setg(errp, "chardev: socket: no port given");
4052 return;
4054 } else {
4055 if (tls_creds) {
4056 error_setg(errp, "TLS can only be used over TCP socket");
4057 return;
4061 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
4062 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
4064 sock->has_nodelay = true;
4065 sock->nodelay = do_nodelay;
4066 sock->has_server = true;
4067 sock->server = is_listen;
4068 sock->has_telnet = true;
4069 sock->telnet = is_telnet;
4070 sock->has_wait = true;
4071 sock->wait = is_waitconnect;
4072 sock->has_reconnect = true;
4073 sock->reconnect = reconnect;
4074 sock->tls_creds = g_strdup(tls_creds);
4076 addr = g_new0(SocketAddress, 1);
4077 if (path) {
4078 UnixSocketAddress *q_unix;
4079 addr->type = SOCKET_ADDRESS_KIND_UNIX;
4080 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
4081 q_unix->path = g_strdup(path);
4082 } else {
4083 addr->type = SOCKET_ADDRESS_KIND_INET;
4084 addr->u.inet.data = g_new(InetSocketAddress, 1);
4085 *addr->u.inet.data = (InetSocketAddress) {
4086 .host = g_strdup(host),
4087 .port = g_strdup(port),
4088 .has_to = qemu_opt_get(opts, "to"),
4089 .to = qemu_opt_get_number(opts, "to", 0),
4090 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
4091 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
4092 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
4093 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
4096 sock->addr = addr;
4099 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
4100 Error **errp)
4102 const char *host = qemu_opt_get(opts, "host");
4103 const char *port = qemu_opt_get(opts, "port");
4104 const char *localaddr = qemu_opt_get(opts, "localaddr");
4105 const char *localport = qemu_opt_get(opts, "localport");
4106 bool has_local = false;
4107 SocketAddress *addr;
4108 ChardevUdp *udp;
4110 if (host == NULL || strlen(host) == 0) {
4111 host = "localhost";
4113 if (port == NULL || strlen(port) == 0) {
4114 error_setg(errp, "chardev: udp: remote port not specified");
4115 return;
4117 if (localport == NULL || strlen(localport) == 0) {
4118 localport = "0";
4119 } else {
4120 has_local = true;
4122 if (localaddr == NULL || strlen(localaddr) == 0) {
4123 localaddr = "";
4124 } else {
4125 has_local = true;
4128 udp = backend->u.udp.data = g_new0(ChardevUdp, 1);
4129 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
4131 addr = g_new0(SocketAddress, 1);
4132 addr->type = SOCKET_ADDRESS_KIND_INET;
4133 addr->u.inet.data = g_new(InetSocketAddress, 1);
4134 *addr->u.inet.data = (InetSocketAddress) {
4135 .host = g_strdup(host),
4136 .port = g_strdup(port),
4137 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
4138 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
4139 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
4140 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
4142 udp->remote = addr;
4144 if (has_local) {
4145 udp->has_local = true;
4146 addr = g_new0(SocketAddress, 1);
4147 addr->type = SOCKET_ADDRESS_KIND_INET;
4148 addr->u.inet.data = g_new(InetSocketAddress, 1);
4149 *addr->u.inet.data = (InetSocketAddress) {
4150 .host = g_strdup(localaddr),
4151 .port = g_strdup(localport),
4153 udp->local = addr;
4157 static const CharDriver *backends[CHARDEV_BACKEND_KIND__MAX];
4159 void register_char_driver(const CharDriver *driver)
4161 backends[driver->kind] = driver;
4164 Chardev *qemu_chr_new_from_opts(QemuOpts *opts,
4165 Error **errp)
4167 Error *local_err = NULL;
4168 const CharDriver *cd = NULL;
4169 Chardev *chr;
4170 int i;
4171 ChardevReturn *ret = NULL;
4172 ChardevBackend *backend;
4173 const char *name = qemu_opt_get(opts, "backend");
4174 const char *id = qemu_opts_id(opts);
4175 char *bid = NULL;
4177 if (name == NULL) {
4178 error_setg(errp, "chardev: \"%s\" missing backend",
4179 qemu_opts_id(opts));
4180 goto err;
4183 if (is_help_option(name)) {
4184 GString *str = g_string_new("");
4185 for (i = 0; i < ARRAY_SIZE(backends); i++) {
4186 cd = backends[i];
4187 if (cd) {
4188 g_string_append_printf(str, "\n%s", ChardevBackendKind_lookup[cd->kind]);
4189 if (cd->alias) {
4190 g_string_append_printf(str, "\n%s", cd->alias);
4195 error_report("Available chardev backend types: %s", str->str);
4196 g_string_free(str, true);
4197 exit(0);
4200 if (id == NULL) {
4201 error_setg(errp, "chardev: no id specified");
4202 goto err;
4205 for (i = 0; i < ARRAY_SIZE(backends); i++) {
4206 cd = backends[i];
4207 if (!cd) {
4208 continue;
4210 if (g_strcmp0(ChardevBackendKind_lookup[cd->kind], name) == 0 ||
4211 g_strcmp0(cd->alias, name) == 0) {
4212 break;
4215 if (i == ARRAY_SIZE(backends)) {
4216 error_setg(errp, "chardev: backend \"%s\" not found", name);
4217 goto err;
4220 backend = g_new0(ChardevBackend, 1);
4222 if (qemu_opt_get_bool(opts, "mux", 0)) {
4223 bid = g_strdup_printf("%s-base", id);
4226 chr = NULL;
4227 backend->type = cd->kind;
4228 if (cd->parse) {
4229 cd->parse(opts, backend, &local_err);
4230 if (local_err) {
4231 error_propagate(errp, local_err);
4232 goto qapi_out;
4234 } else {
4235 ChardevCommon *cc = g_new0(ChardevCommon, 1);
4236 qemu_chr_parse_common(opts, cc);
4237 backend->u.null.data = cc; /* Any ChardevCommon member would work */
4240 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
4241 if (!ret) {
4242 goto qapi_out;
4245 if (bid) {
4246 qapi_free_ChardevBackend(backend);
4247 qapi_free_ChardevReturn(ret);
4248 backend = g_new0(ChardevBackend, 1);
4249 backend->u.mux.data = g_new0(ChardevMux, 1);
4250 backend->type = CHARDEV_BACKEND_KIND_MUX;
4251 backend->u.mux.data->chardev = g_strdup(bid);
4252 ret = qmp_chardev_add(id, backend, errp);
4253 if (!ret) {
4254 chr = qemu_chr_find(bid);
4255 qemu_chr_delete(chr);
4256 chr = NULL;
4257 goto qapi_out;
4261 chr = qemu_chr_find(id);
4263 qapi_out:
4264 qapi_free_ChardevBackend(backend);
4265 qapi_free_ChardevReturn(ret);
4266 g_free(bid);
4267 return chr;
4269 err:
4270 return NULL;
4273 Chardev *qemu_chr_new_noreplay(const char *label, const char *filename)
4275 const char *p;
4276 Chardev *chr;
4277 QemuOpts *opts;
4278 Error *err = NULL;
4280 if (strstart(filename, "chardev:", &p)) {
4281 return qemu_chr_find(p);
4284 opts = qemu_chr_parse_compat(label, filename);
4285 if (!opts)
4286 return NULL;
4288 chr = qemu_chr_new_from_opts(opts, &err);
4289 if (err) {
4290 error_report_err(err);
4292 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
4293 monitor_init(chr, MONITOR_USE_READLINE);
4295 qemu_opts_del(opts);
4296 return chr;
4299 Chardev *qemu_chr_new(const char *label, const char *filename)
4301 Chardev *chr;
4302 chr = qemu_chr_new_noreplay(label, filename);
4303 if (chr) {
4304 if (replay_mode != REPLAY_MODE_NONE) {
4305 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_REPLAY);
4307 if (qemu_chr_replay(chr) && CHARDEV_GET_CLASS(chr)->chr_ioctl) {
4308 error_report("Replay: ioctl is not supported "
4309 "for serial devices yet");
4311 replay_register_char_driver(chr);
4313 return chr;
4316 void qemu_chr_fe_set_echo(CharBackend *be, bool echo)
4318 Chardev *chr = be->chr;
4320 if (chr && CHARDEV_GET_CLASS(chr)->chr_set_echo) {
4321 CHARDEV_GET_CLASS(chr)->chr_set_echo(chr, echo);
4325 void qemu_chr_fe_set_open(CharBackend *be, int fe_open)
4327 Chardev *chr = be->chr;
4329 if (!chr) {
4330 return;
4333 if (be->fe_open == fe_open) {
4334 return;
4336 be->fe_open = fe_open;
4337 if (CHARDEV_GET_CLASS(chr)->chr_set_fe_open) {
4338 CHARDEV_GET_CLASS(chr)->chr_set_fe_open(chr, fe_open);
4342 guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
4343 GIOFunc func, void *user_data)
4345 Chardev *s = be->chr;
4346 GSource *src;
4347 guint tag;
4349 if (!s || CHARDEV_GET_CLASS(s)->chr_add_watch == NULL) {
4350 return 0;
4353 src = CHARDEV_GET_CLASS(s)->chr_add_watch(s, cond);
4354 if (!src) {
4355 return 0;
4358 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
4359 tag = g_source_attach(src, NULL);
4360 g_source_unref(src);
4362 return tag;
4365 void qemu_chr_fe_disconnect(CharBackend *be)
4367 Chardev *chr = be->chr;
4369 if (chr && CHARDEV_GET_CLASS(chr)->chr_disconnect) {
4370 CHARDEV_GET_CLASS(chr)->chr_disconnect(chr);
4374 void qemu_chr_free(Chardev *chr)
4376 if (CHARDEV_GET_CLASS(chr)->chr_free) {
4377 CHARDEV_GET_CLASS(chr)->chr_free(chr);
4379 object_unref(OBJECT(chr));
4382 void qemu_chr_delete(Chardev *chr)
4384 QTAILQ_REMOVE(&chardevs, chr, next);
4385 qemu_chr_free(chr);
4388 ChardevInfoList *qmp_query_chardev(Error **errp)
4390 ChardevInfoList *chr_list = NULL;
4391 Chardev *chr;
4393 QTAILQ_FOREACH(chr, &chardevs, next) {
4394 ChardevInfoList *info = g_malloc0(sizeof(*info));
4395 info->value = g_malloc0(sizeof(*info->value));
4396 info->value->label = g_strdup(chr->label);
4397 info->value->filename = g_strdup(chr->filename);
4398 info->value->frontend_open = chr->be && chr->be->fe_open;
4400 info->next = chr_list;
4401 chr_list = info;
4404 return chr_list;
4407 static ChardevBackendInfoList *
4408 qmp_prepend_backend(ChardevBackendInfoList *list, const char *name)
4410 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
4411 info->value = g_malloc0(sizeof(*info->value));
4412 info->value->name = g_strdup(name);
4413 info->next = list;
4414 return info;
4417 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
4419 ChardevBackendInfoList *backend_list = NULL;
4420 const CharDriver *c;
4421 int i;
4423 for (i = 0; i < ARRAY_SIZE(backends); i++) {
4424 c = backends[i];
4425 if (!c) {
4426 continue;
4429 backend_list = qmp_prepend_backend(backend_list,
4430 ChardevBackendKind_lookup[c->kind]);
4431 if (c->alias) {
4432 backend_list = qmp_prepend_backend(backend_list, c->alias);
4436 return backend_list;
4439 Chardev *qemu_chr_find(const char *name)
4441 Chardev *chr;
4443 QTAILQ_FOREACH(chr, &chardevs, next) {
4444 if (strcmp(chr->label, name) != 0)
4445 continue;
4446 return chr;
4448 return NULL;
4451 QemuOptsList qemu_chardev_opts = {
4452 .name = "chardev",
4453 .implied_opt_name = "backend",
4454 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4455 .desc = {
4457 .name = "backend",
4458 .type = QEMU_OPT_STRING,
4460 .name = "path",
4461 .type = QEMU_OPT_STRING,
4463 .name = "host",
4464 .type = QEMU_OPT_STRING,
4466 .name = "port",
4467 .type = QEMU_OPT_STRING,
4469 .name = "localaddr",
4470 .type = QEMU_OPT_STRING,
4472 .name = "localport",
4473 .type = QEMU_OPT_STRING,
4475 .name = "to",
4476 .type = QEMU_OPT_NUMBER,
4478 .name = "ipv4",
4479 .type = QEMU_OPT_BOOL,
4481 .name = "ipv6",
4482 .type = QEMU_OPT_BOOL,
4484 .name = "wait",
4485 .type = QEMU_OPT_BOOL,
4487 .name = "server",
4488 .type = QEMU_OPT_BOOL,
4490 .name = "delay",
4491 .type = QEMU_OPT_BOOL,
4493 .name = "reconnect",
4494 .type = QEMU_OPT_NUMBER,
4496 .name = "telnet",
4497 .type = QEMU_OPT_BOOL,
4499 .name = "tls-creds",
4500 .type = QEMU_OPT_STRING,
4502 .name = "width",
4503 .type = QEMU_OPT_NUMBER,
4505 .name = "height",
4506 .type = QEMU_OPT_NUMBER,
4508 .name = "cols",
4509 .type = QEMU_OPT_NUMBER,
4511 .name = "rows",
4512 .type = QEMU_OPT_NUMBER,
4514 .name = "mux",
4515 .type = QEMU_OPT_BOOL,
4517 .name = "signal",
4518 .type = QEMU_OPT_BOOL,
4520 .name = "name",
4521 .type = QEMU_OPT_STRING,
4523 .name = "debug",
4524 .type = QEMU_OPT_NUMBER,
4526 .name = "size",
4527 .type = QEMU_OPT_SIZE,
4529 .name = "chardev",
4530 .type = QEMU_OPT_STRING,
4532 .name = "append",
4533 .type = QEMU_OPT_BOOL,
4535 .name = "logfile",
4536 .type = QEMU_OPT_STRING,
4538 .name = "logappend",
4539 .type = QEMU_OPT_BOOL,
4541 { /* end of list */ }
4545 #ifdef _WIN32
4547 static void qmp_chardev_open_file(Chardev *chr,
4548 ChardevBackend *backend,
4549 bool *be_opened,
4550 Error **errp)
4552 ChardevFile *file = backend->u.file.data;
4553 HANDLE out;
4554 DWORD accessmode;
4555 DWORD flags;
4557 if (file->has_in) {
4558 error_setg(errp, "input file not supported");
4559 return;
4562 if (file->has_append && file->append) {
4563 /* Append to file if it already exists. */
4564 accessmode = FILE_GENERIC_WRITE & ~FILE_WRITE_DATA;
4565 flags = OPEN_ALWAYS;
4566 } else {
4567 /* Truncate file if it already exists. */
4568 accessmode = GENERIC_WRITE;
4569 flags = CREATE_ALWAYS;
4572 out = CreateFile(file->out, accessmode, FILE_SHARE_READ, NULL, flags,
4573 FILE_ATTRIBUTE_NORMAL, NULL);
4574 if (out == INVALID_HANDLE_VALUE) {
4575 error_setg(errp, "open %s failed", file->out);
4576 return;
4579 qemu_chr_open_win_file(chr, out);
4582 static void qmp_chardev_open_serial(Chardev *chr,
4583 ChardevBackend *backend,
4584 bool *be_opened,
4585 Error **errp)
4587 ChardevHostdev *serial = backend->u.serial.data;
4589 win_chr_init(chr, serial->device, errp);
4592 #else /* WIN32 */
4594 static int qmp_chardev_open_file_source(char *src, int flags,
4595 Error **errp)
4597 int fd = -1;
4599 TFR(fd = qemu_open(src, flags, 0666));
4600 if (fd == -1) {
4601 error_setg_file_open(errp, errno, src);
4603 return fd;
4606 static void qmp_chardev_open_file(Chardev *chr,
4607 ChardevBackend *backend,
4608 bool *be_opened,
4609 Error **errp)
4611 ChardevFile *file = backend->u.file.data;
4612 int flags, in = -1, out;
4614 flags = O_WRONLY | O_CREAT | O_BINARY;
4615 if (file->has_append && file->append) {
4616 flags |= O_APPEND;
4617 } else {
4618 flags |= O_TRUNC;
4621 out = qmp_chardev_open_file_source(file->out, flags, errp);
4622 if (out < 0) {
4623 return;
4626 if (file->has_in) {
4627 flags = O_RDONLY;
4628 in = qmp_chardev_open_file_source(file->in, flags, errp);
4629 if (in < 0) {
4630 qemu_close(out);
4631 return;
4635 qemu_chr_open_fd(chr, in, out);
4638 #ifdef HAVE_CHARDEV_SERIAL
4639 static void qmp_chardev_open_serial(Chardev *chr,
4640 ChardevBackend *backend,
4641 bool *be_opened,
4642 Error **errp)
4644 ChardevHostdev *serial = backend->u.serial.data;
4645 int fd;
4647 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4648 if (fd < 0) {
4649 return;
4651 qemu_set_nonblock(fd);
4652 tty_serial_init(fd, 115200, 'N', 8, 1);
4654 qemu_chr_open_fd(chr, fd, fd);
4656 #endif
4658 #ifdef HAVE_CHARDEV_PARPORT
4659 static void qmp_chardev_open_parallel(Chardev *chr,
4660 ChardevBackend *backend,
4661 bool *be_opened,
4662 Error **errp)
4664 ChardevHostdev *parallel = backend->u.parallel.data;
4665 int fd;
4667 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4668 if (fd < 0) {
4669 return;
4671 qemu_chr_open_pp_fd(chr, fd, be_opened, errp);
4674 static const CharDriver parallel_driver = {
4675 .kind = CHARDEV_BACKEND_KIND_PARALLEL,
4676 .alias = "parport",
4677 .parse = qemu_chr_parse_parallel,
4680 static void char_parallel_class_init(ObjectClass *oc, void *data)
4682 ChardevClass *cc = CHARDEV_CLASS(oc);
4684 cc->open = qmp_chardev_open_parallel;
4685 #if defined(__linux__)
4686 cc->chr_write = null_chr_write;
4687 cc->chr_ioctl = pp_ioctl;
4688 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4689 cc->chr_write = null_chr_write;
4690 cc->chr_ioctl = pp_ioctl;
4691 #endif
4694 static void char_parallel_finalize(Object *obj)
4696 #if defined(__linux__)
4697 Chardev *chr = CHARDEV(obj);
4698 ParallelChardev *drv = PARALLEL_CHARDEV(chr);
4699 int fd = drv->fd;
4701 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
4702 ioctl(fd, PPRELEASE);
4703 close(fd);
4704 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
4705 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
4706 /* FIXME: close fd? */
4707 #endif
4710 static const TypeInfo char_parallel_type_info = {
4711 .name = TYPE_CHARDEV_PARALLEL,
4712 .parent = TYPE_CHARDEV,
4713 .instance_size = sizeof(ParallelChardev),
4714 .instance_finalize = char_parallel_finalize,
4715 .class_init = char_parallel_class_init,
4717 #endif
4719 #endif /* WIN32 */
4721 static const CharDriver file_driver = {
4722 .kind = CHARDEV_BACKEND_KIND_FILE,
4723 .parse = qemu_chr_parse_file_out,
4726 static void char_file_class_init(ObjectClass *oc, void *data)
4728 ChardevClass *cc = CHARDEV_CLASS(oc);
4730 cc->open = qmp_chardev_open_file;
4733 static const TypeInfo char_file_type_info = {
4734 .name = TYPE_CHARDEV_FILE,
4735 #ifdef _WIN32
4736 .parent = TYPE_CHARDEV_WIN,
4737 #else
4738 .parent = TYPE_CHARDEV_FD,
4739 #endif
4740 .class_init = char_file_class_init,
4743 #ifdef HAVE_CHARDEV_SERIAL
4745 static const CharDriver serial_driver = {
4746 .kind = CHARDEV_BACKEND_KIND_SERIAL,
4747 .alias = "tty",
4748 .parse = qemu_chr_parse_serial,
4751 static void char_serial_class_init(ObjectClass *oc, void *data)
4753 ChardevClass *cc = CHARDEV_CLASS(oc);
4755 cc->open = qmp_chardev_open_serial;
4756 #ifndef _WIN32
4757 cc->chr_ioctl = tty_serial_ioctl;
4758 #endif
4761 static const TypeInfo char_serial_type_info = {
4762 .name = TYPE_CHARDEV_SERIAL,
4763 #ifdef _WIN32
4764 .parent = TYPE_CHARDEV_WIN,
4765 #else
4766 .parent = TYPE_CHARDEV_FD,
4767 #endif
4768 .class_init = char_serial_class_init,
4770 #endif
4772 static gboolean socket_reconnect_timeout(gpointer opaque)
4774 Chardev *chr = CHARDEV(opaque);
4775 SocketChardev *s = SOCKET_CHARDEV(opaque);
4776 QIOChannelSocket *sioc;
4778 s->reconnect_timer = 0;
4780 if (chr->be_open) {
4781 return false;
4784 sioc = qio_channel_socket_new();
4785 tcp_chr_set_client_ioc_name(chr, sioc);
4786 qio_channel_socket_connect_async(sioc, s->addr,
4787 qemu_chr_socket_connected,
4788 chr, NULL);
4790 return false;
4793 static void qmp_chardev_open_socket(Chardev *chr,
4794 ChardevBackend *backend,
4795 bool *be_opened,
4796 Error **errp)
4798 SocketChardev *s = SOCKET_CHARDEV(chr);
4799 ChardevSocket *sock = backend->u.socket.data;
4800 SocketAddress *addr = sock->addr;
4801 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4802 bool is_listen = sock->has_server ? sock->server : true;
4803 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4804 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4805 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4806 QIOChannelSocket *sioc = NULL;
4808 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4809 s->is_listen = is_listen;
4810 s->is_telnet = is_telnet;
4811 s->do_nodelay = do_nodelay;
4812 if (sock->tls_creds) {
4813 Object *creds;
4814 creds = object_resolve_path_component(
4815 object_get_objects_root(), sock->tls_creds);
4816 if (!creds) {
4817 error_setg(errp, "No TLS credentials with id '%s'",
4818 sock->tls_creds);
4819 goto error;
4821 s->tls_creds = (QCryptoTLSCreds *)
4822 object_dynamic_cast(creds,
4823 TYPE_QCRYPTO_TLS_CREDS);
4824 if (!s->tls_creds) {
4825 error_setg(errp, "Object with id '%s' is not TLS credentials",
4826 sock->tls_creds);
4827 goto error;
4829 object_ref(OBJECT(s->tls_creds));
4830 if (is_listen) {
4831 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4832 error_setg(errp, "%s",
4833 "Expected TLS credentials for server endpoint");
4834 goto error;
4836 } else {
4837 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4838 error_setg(errp, "%s",
4839 "Expected TLS credentials for client endpoint");
4840 goto error;
4845 s->addr = QAPI_CLONE(SocketAddress, sock->addr);
4847 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
4848 if (s->is_unix) {
4849 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
4852 /* be isn't opened until we get a connection */
4853 *be_opened = false;
4855 chr->filename = SocketAddress_to_str("disconnected:",
4856 addr, is_listen, is_telnet);
4858 if (is_listen) {
4859 if (is_telnet) {
4860 s->do_telnetopt = 1;
4862 } else if (reconnect > 0) {
4863 s->reconnect_time = reconnect;
4866 if (s->reconnect_time) {
4867 sioc = qio_channel_socket_new();
4868 tcp_chr_set_client_ioc_name(chr, sioc);
4869 qio_channel_socket_connect_async(sioc, s->addr,
4870 qemu_chr_socket_connected,
4871 chr, NULL);
4872 } else {
4873 if (s->is_listen) {
4874 char *name;
4875 sioc = qio_channel_socket_new();
4877 name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
4878 qio_channel_set_name(QIO_CHANNEL(sioc), name);
4879 g_free(name);
4881 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4882 goto error;
4884 s->listen_ioc = sioc;
4885 if (is_waitconnect &&
4886 qemu_chr_wait_connected(chr, errp) < 0) {
4887 return;
4889 if (!s->ioc) {
4890 s->listen_tag = qio_channel_add_watch(
4891 QIO_CHANNEL(s->listen_ioc), G_IO_IN,
4892 tcp_chr_accept, chr, NULL);
4894 } else if (qemu_chr_wait_connected(chr, errp) < 0) {
4895 goto error;
4899 return;
4901 error:
4902 if (sioc) {
4903 object_unref(OBJECT(sioc));
4907 static const CharDriver socket_driver = {
4908 .kind = CHARDEV_BACKEND_KIND_SOCKET,
4909 .parse = qemu_chr_parse_socket,
4912 static void char_socket_class_init(ObjectClass *oc, void *data)
4914 ChardevClass *cc = CHARDEV_CLASS(oc);
4916 cc->open = qmp_chardev_open_socket;
4917 cc->chr_wait_connected = tcp_chr_wait_connected;
4918 cc->chr_write = tcp_chr_write;
4919 cc->chr_sync_read = tcp_chr_sync_read;
4920 cc->chr_disconnect = tcp_chr_disconnect;
4921 cc->get_msgfds = tcp_get_msgfds;
4922 cc->set_msgfds = tcp_set_msgfds;
4923 cc->chr_add_client = tcp_chr_add_client;
4924 cc->chr_add_watch = tcp_chr_add_watch;
4925 cc->chr_update_read_handler = tcp_chr_update_read_handler;
4928 static const TypeInfo char_socket_type_info = {
4929 .name = TYPE_CHARDEV_SOCKET,
4930 .parent = TYPE_CHARDEV,
4931 .instance_size = sizeof(SocketChardev),
4932 .instance_finalize = char_socket_finalize,
4933 .class_init = char_socket_class_init,
4936 static void qmp_chardev_open_udp(Chardev *chr,
4937 ChardevBackend *backend,
4938 bool *be_opened,
4939 Error **errp)
4941 ChardevUdp *udp = backend->u.udp.data;
4942 QIOChannelSocket *sioc = qio_channel_socket_new();
4943 char *name;
4944 UdpChardev *s = UDP_CHARDEV(chr);
4946 if (qio_channel_socket_dgram_sync(sioc,
4947 udp->local, udp->remote,
4948 errp) < 0) {
4949 object_unref(OBJECT(sioc));
4950 return;
4953 name = g_strdup_printf("chardev-udp-%s", chr->label);
4954 qio_channel_set_name(QIO_CHANNEL(sioc), name);
4955 g_free(name);
4957 s->ioc = QIO_CHANNEL(sioc);
4958 /* be isn't opened until we get a connection */
4959 *be_opened = false;
4962 static const CharDriver udp_driver = {
4963 .kind = CHARDEV_BACKEND_KIND_UDP,
4964 .parse = qemu_chr_parse_udp,
4967 static void char_udp_class_init(ObjectClass *oc, void *data)
4969 ChardevClass *cc = CHARDEV_CLASS(oc);
4971 cc->open = qmp_chardev_open_udp;
4972 cc->chr_write = udp_chr_write;
4973 cc->chr_update_read_handler = udp_chr_update_read_handler;
4976 static const TypeInfo char_udp_type_info = {
4977 .name = TYPE_CHARDEV_UDP,
4978 .parent = TYPE_CHARDEV,
4979 .instance_size = sizeof(UdpChardev),
4980 .instance_finalize = char_udp_finalize,
4981 .class_init = char_udp_class_init,
4984 bool qemu_chr_has_feature(Chardev *chr,
4985 CharDriverFeature feature)
4987 return test_bit(feature, chr->features);
4990 void qemu_chr_set_feature(Chardev *chr,
4991 CharDriverFeature feature)
4993 return set_bit(feature, chr->features);
4996 static const ChardevClass *char_get_class(const char *driver, Error **errp)
4998 ObjectClass *oc;
4999 const ChardevClass *cc;
5000 char *typename = g_strdup_printf("chardev-%s", driver);
5002 oc = object_class_by_name(typename);
5003 g_free(typename);
5005 if (!object_class_dynamic_cast(oc, TYPE_CHARDEV)) {
5006 error_setg(errp, "'%s' is not a valid char driver name", driver);
5007 return NULL;
5010 if (object_class_is_abstract(oc)) {
5011 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "driver",
5012 "abstract device type");
5013 return NULL;
5016 cc = CHARDEV_CLASS(oc);
5017 if (cc->internal) {
5018 error_setg(errp, "'%s' is not a valid char driver name", driver);
5019 return NULL;
5022 return cc;
5025 Chardev *qemu_chardev_new(const char *id, const char *typename,
5026 ChardevBackend *backend, Error **errp)
5028 Chardev *chr = NULL;
5029 Error *local_err = NULL;
5030 bool be_opened = true;
5032 assert(g_str_has_prefix(typename, "chardev-"));
5034 chr = CHARDEV(object_new(typename));
5035 chr->label = g_strdup(id);
5037 qemu_char_open(chr, backend, &be_opened, &local_err);
5038 if (local_err) {
5039 error_propagate(errp, local_err);
5040 object_unref(OBJECT(chr));
5041 return NULL;
5044 if (!chr->filename) {
5045 chr->filename = g_strdup(typename + 8);
5047 if (be_opened) {
5048 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
5051 return chr;
5054 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
5055 Error **errp)
5057 const ChardevClass *cc;
5058 ChardevReturn *ret;
5059 Chardev *chr;
5061 chr = qemu_chr_find(id);
5062 if (chr) {
5063 error_setg(errp, "Chardev '%s' already exists", id);
5064 return NULL;
5067 cc = char_get_class(ChardevBackendKind_lookup[backend->type], errp);
5068 if (!cc) {
5069 return NULL;
5072 chr = qemu_chardev_new(id, object_class_get_name(OBJECT_CLASS(cc)),
5073 backend, errp);
5074 if (!chr) {
5075 return NULL;
5078 ret = g_new0(ChardevReturn, 1);
5079 if (CHARDEV_IS_PTY(chr)) {
5080 ret->pty = g_strdup(chr->filename + 4);
5081 ret->has_pty = true;
5084 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
5085 return ret;
5088 void qmp_chardev_remove(const char *id, Error **errp)
5090 Chardev *chr;
5092 chr = qemu_chr_find(id);
5093 if (chr == NULL) {
5094 error_setg(errp, "Chardev '%s' not found", id);
5095 return;
5097 if (qemu_chr_is_busy(chr)) {
5098 error_setg(errp, "Chardev '%s' is busy", id);
5099 return;
5101 if (qemu_chr_replay(chr)) {
5102 error_setg(errp,
5103 "Chardev '%s' cannot be unplugged in record/replay mode", id);
5104 return;
5106 qemu_chr_delete(chr);
5109 void qemu_chr_cleanup(void)
5111 Chardev *chr, *tmp;
5113 QTAILQ_FOREACH_SAFE(chr, &chardevs, next, tmp) {
5114 qemu_chr_delete(chr);
5118 static void register_types(void)
5120 static const struct {
5121 const CharDriver *driver;
5122 const TypeInfo *type;
5123 } chardevs[] = {
5124 { &null_driver, &char_null_type_info },
5125 { &socket_driver, &char_socket_type_info },
5126 { &udp_driver, &char_udp_type_info },
5127 { &ringbuf_driver, &char_ringbuf_type_info },
5128 { &file_driver, &char_file_type_info },
5129 { &stdio_driver, &char_stdio_type_info },
5130 #ifdef HAVE_CHARDEV_SERIAL
5131 { &serial_driver, &char_serial_type_info },
5132 #endif
5133 #ifdef HAVE_CHARDEV_PARPORT
5134 { &parallel_driver, &char_parallel_type_info },
5135 #endif
5136 #ifdef HAVE_CHARDEV_PTY
5137 { &pty_driver, &char_pty_type_info },
5138 #endif
5139 #ifdef _WIN32
5140 { &console_driver, &char_console_type_info },
5141 #endif
5142 { &pipe_driver, &char_pipe_type_info },
5143 { &mux_driver, &char_mux_type_info },
5144 { &memory_driver, &char_memory_type_info }
5146 int i;
5148 type_register_static(&char_type_info);
5149 #ifndef _WIN32
5150 type_register_static(&char_fd_type_info);
5151 #else
5152 type_register_static(&char_win_type_info);
5153 type_register_static(&char_win_stdio_type_info);
5154 #endif
5155 for (i = 0; i < ARRAY_SIZE(chardevs); i++) {
5156 type_register_static(chardevs[i].type);
5157 register_char_driver(chardevs[i].driver);
5160 /* this must be done after machine init, since we register FEs with muxes
5161 * as part of realize functions like serial_isa_realizefn when -nographic
5162 * is specified
5164 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
5167 type_init(register_types);