block/vpc: give option to force the current_size field in .bdrv_create
[qemu/kevin.git] / qemu-char.c
blob3bf30b55642f498275496284cd52ee49a77eb1d4
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 "monitor/monitor.h"
27 #include "sysemu/sysemu.h"
28 #include "qemu/error-report.h"
29 #include "qemu/timer.h"
30 #include "sysemu/char.h"
31 #include "hw/usb.h"
32 #include "qmp-commands.h"
33 #include "qapi/qmp-input-visitor.h"
34 #include "qapi/qmp-output-visitor.h"
35 #include "qapi-visit.h"
36 #include "qemu/base64.h"
37 #include "io/channel-socket.h"
38 #include "io/channel-file.h"
39 #include "io/channel-tls.h"
41 #include <zlib.h>
43 #ifndef _WIN32
44 #include <sys/times.h>
45 #include <sys/wait.h>
46 #include <termios.h>
47 #include <sys/mman.h>
48 #include <sys/ioctl.h>
49 #include <sys/resource.h>
50 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <net/if.h>
53 #include <arpa/inet.h>
54 #include <netdb.h>
55 #include <sys/select.h>
56 #ifdef CONFIG_BSD
57 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
58 #include <dev/ppbus/ppi.h>
59 #include <dev/ppbus/ppbconf.h>
60 #elif defined(__DragonFly__)
61 #include <dev/misc/ppi/ppi.h>
62 #include <bus/ppbus/ppbconf.h>
63 #endif
64 #else
65 #ifdef __linux__
66 #include <linux/ppdev.h>
67 #include <linux/parport.h>
68 #endif
69 #ifdef __sun__
70 #include <sys/ethernet.h>
71 #include <sys/sockio.h>
72 #include <netinet/arp.h>
73 #include <netinet/in.h>
74 #include <netinet/in_systm.h>
75 #include <netinet/ip.h>
76 #include <netinet/ip_icmp.h> // must come after ip.h
77 #include <netinet/udp.h>
78 #include <netinet/tcp.h>
79 #endif
80 #endif
81 #endif
83 #include "qemu/sockets.h"
84 #include "ui/qemu-spice.h"
86 #define READ_BUF_LEN 4096
87 #define READ_RETRIES 10
88 #define TCP_MAX_FDS 16
90 /***********************************************************/
91 /* Socket address helpers */
93 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
94 bool is_listen, bool is_telnet)
96 switch (addr->type) {
97 case SOCKET_ADDRESS_KIND_INET:
98 return g_strdup_printf("%s%s:%s:%s%s", prefix,
99 is_telnet ? "telnet" : "tcp", addr->u.inet->host,
100 addr->u.inet->port, is_listen ? ",server" : "");
101 break;
102 case SOCKET_ADDRESS_KIND_UNIX:
103 return g_strdup_printf("%sunix:%s%s", prefix,
104 addr->u.q_unix->path,
105 is_listen ? ",server" : "");
106 break;
107 case SOCKET_ADDRESS_KIND_FD:
108 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd->str,
109 is_listen ? ",server" : "");
110 break;
111 default:
112 abort();
116 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
117 struct sockaddr_storage *ps, socklen_t ps_len,
118 bool is_listen, bool is_telnet)
120 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
121 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
122 const char *left = "", *right = "";
124 switch (ss->ss_family) {
125 #ifndef _WIN32
126 case AF_UNIX:
127 return g_strdup_printf("unix:%s%s",
128 ((struct sockaddr_un *)(ss))->sun_path,
129 is_listen ? ",server" : "");
130 #endif
131 case AF_INET6:
132 left = "[";
133 right = "]";
134 /* fall through */
135 case AF_INET:
136 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
137 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
138 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
139 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
140 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
141 is_telnet ? "telnet" : "tcp",
142 left, shost, right, sserv,
143 is_listen ? ",server" : "",
144 left, phost, right, pserv);
146 default:
147 return g_strdup_printf("unknown");
151 /***********************************************************/
152 /* character device */
154 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
155 QTAILQ_HEAD_INITIALIZER(chardevs);
157 static void qemu_chr_free_common(CharDriverState *chr);
159 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp)
161 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
162 qemu_mutex_init(&chr->chr_write_lock);
164 if (backend->has_logfile) {
165 int flags = O_WRONLY | O_CREAT;
166 if (backend->has_logappend &&
167 backend->logappend) {
168 flags |= O_APPEND;
169 } else {
170 flags |= O_TRUNC;
172 chr->logfd = qemu_open(backend->logfile, flags, 0666);
173 if (chr->logfd < 0) {
174 error_setg_errno(errp, errno,
175 "Unable to open logfile %s",
176 backend->logfile);
177 g_free(chr);
178 return NULL;
180 } else {
181 chr->logfd = -1;
184 return chr;
187 void qemu_chr_be_event(CharDriverState *s, int event)
189 /* Keep track if the char device is open */
190 switch (event) {
191 case CHR_EVENT_OPENED:
192 s->be_open = 1;
193 break;
194 case CHR_EVENT_CLOSED:
195 s->be_open = 0;
196 break;
199 if (!s->chr_event)
200 return;
201 s->chr_event(s->handler_opaque, event);
204 void qemu_chr_be_generic_open(CharDriverState *s)
206 qemu_chr_be_event(s, CHR_EVENT_OPENED);
210 /* Not reporting errors from writing to logfile, as logs are
211 * defined to be "best effort" only */
212 static void qemu_chr_fe_write_log(CharDriverState *s,
213 const uint8_t *buf, size_t len)
215 size_t done = 0;
216 ssize_t ret;
218 if (s->logfd < 0) {
219 return;
222 while (done < len) {
223 do {
224 ret = write(s->logfd, buf + done, len - done);
225 if (ret == -1 && errno == EAGAIN) {
226 g_usleep(100);
228 } while (ret == -1 && errno == EAGAIN);
230 if (ret <= 0) {
231 return;
233 done += ret;
237 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len)
239 int ret;
241 qemu_mutex_lock(&s->chr_write_lock);
242 ret = s->chr_write(s, buf, len);
244 if (ret > 0) {
245 qemu_chr_fe_write_log(s, buf, ret);
248 qemu_mutex_unlock(&s->chr_write_lock);
249 return ret;
252 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len)
254 int offset = 0;
255 int res = 0;
257 qemu_mutex_lock(&s->chr_write_lock);
258 while (offset < len) {
259 do {
260 res = s->chr_write(s, buf + offset, len - offset);
261 if (res == -1 && errno == EAGAIN) {
262 g_usleep(100);
264 } while (res == -1 && errno == EAGAIN);
266 if (res <= 0) {
267 break;
270 offset += res;
272 if (offset > 0) {
273 qemu_chr_fe_write_log(s, buf, offset);
276 qemu_mutex_unlock(&s->chr_write_lock);
278 if (res < 0) {
279 return res;
281 return offset;
284 int qemu_chr_fe_read_all(CharDriverState *s, uint8_t *buf, int len)
286 int offset = 0, counter = 10;
287 int res;
289 if (!s->chr_sync_read) {
290 return 0;
293 while (offset < len) {
294 do {
295 res = s->chr_sync_read(s, buf + offset, len - offset);
296 if (res == -1 && errno == EAGAIN) {
297 g_usleep(100);
299 } while (res == -1 && errno == EAGAIN);
301 if (res == 0) {
302 break;
305 if (res < 0) {
306 return res;
309 offset += res;
311 if (!counter--) {
312 break;
316 return offset;
319 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg)
321 if (!s->chr_ioctl)
322 return -ENOTSUP;
323 return s->chr_ioctl(s, cmd, arg);
326 int qemu_chr_be_can_write(CharDriverState *s)
328 if (!s->chr_can_read)
329 return 0;
330 return s->chr_can_read(s->handler_opaque);
333 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
335 if (s->chr_read) {
336 s->chr_read(s->handler_opaque, buf, len);
340 int qemu_chr_fe_get_msgfd(CharDriverState *s)
342 int fd;
343 return (qemu_chr_fe_get_msgfds(s, &fd, 1) == 1) ? fd : -1;
346 int qemu_chr_fe_get_msgfds(CharDriverState *s, int *fds, int len)
348 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
351 int qemu_chr_fe_set_msgfds(CharDriverState *s, int *fds, int num)
353 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
356 int qemu_chr_add_client(CharDriverState *s, int fd)
358 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
361 void qemu_chr_accept_input(CharDriverState *s)
363 if (s->chr_accept_input)
364 s->chr_accept_input(s);
365 qemu_notify_event();
368 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
370 char buf[READ_BUF_LEN];
371 va_list ap;
372 va_start(ap, fmt);
373 vsnprintf(buf, sizeof(buf), fmt, ap);
374 qemu_chr_fe_write(s, (uint8_t *)buf, strlen(buf));
375 va_end(ap);
378 static void remove_fd_in_watch(CharDriverState *chr);
380 void qemu_chr_add_handlers(CharDriverState *s,
381 IOCanReadHandler *fd_can_read,
382 IOReadHandler *fd_read,
383 IOEventHandler *fd_event,
384 void *opaque)
386 int fe_open;
388 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
389 fe_open = 0;
390 remove_fd_in_watch(s);
391 } else {
392 fe_open = 1;
394 s->chr_can_read = fd_can_read;
395 s->chr_read = fd_read;
396 s->chr_event = fd_event;
397 s->handler_opaque = opaque;
398 if (fe_open && s->chr_update_read_handler)
399 s->chr_update_read_handler(s);
401 if (!s->explicit_fe_open) {
402 qemu_chr_fe_set_open(s, fe_open);
405 /* We're connecting to an already opened device, so let's make sure we
406 also get the open event */
407 if (fe_open && s->be_open) {
408 qemu_chr_be_generic_open(s);
412 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
414 return len;
417 static CharDriverState *qemu_chr_open_null(const char *id,
418 ChardevBackend *backend,
419 ChardevReturn *ret,
420 Error **errp)
422 CharDriverState *chr;
423 ChardevCommon *common = backend->u.null;
425 chr = qemu_chr_alloc(common, errp);
426 if (!chr) {
427 return NULL;
429 chr->chr_write = null_chr_write;
430 chr->explicit_be_open = true;
431 return chr;
434 /* MUX driver for serial I/O splitting */
435 #define MAX_MUX 4
436 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
437 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
438 typedef struct {
439 IOCanReadHandler *chr_can_read[MAX_MUX];
440 IOReadHandler *chr_read[MAX_MUX];
441 IOEventHandler *chr_event[MAX_MUX];
442 void *ext_opaque[MAX_MUX];
443 CharDriverState *drv;
444 int focus;
445 int mux_cnt;
446 int term_got_escape;
447 int max_size;
448 /* Intermediate input buffer allows to catch escape sequences even if the
449 currently active device is not accepting any input - but only until it
450 is full as well. */
451 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
452 int prod[MAX_MUX];
453 int cons[MAX_MUX];
454 int timestamps;
456 /* Protected by the CharDriverState chr_write_lock. */
457 int linestart;
458 int64_t timestamps_start;
459 } MuxDriver;
462 /* Called with chr_write_lock held. */
463 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
465 MuxDriver *d = chr->opaque;
466 int ret;
467 if (!d->timestamps) {
468 ret = qemu_chr_fe_write(d->drv, buf, len);
469 } else {
470 int i;
472 ret = 0;
473 for (i = 0; i < len; i++) {
474 if (d->linestart) {
475 char buf1[64];
476 int64_t ti;
477 int secs;
479 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
480 if (d->timestamps_start == -1)
481 d->timestamps_start = ti;
482 ti -= d->timestamps_start;
483 secs = ti / 1000;
484 snprintf(buf1, sizeof(buf1),
485 "[%02d:%02d:%02d.%03d] ",
486 secs / 3600,
487 (secs / 60) % 60,
488 secs % 60,
489 (int)(ti % 1000));
490 qemu_chr_fe_write(d->drv, (uint8_t *)buf1, strlen(buf1));
491 d->linestart = 0;
493 ret += qemu_chr_fe_write(d->drv, buf+i, 1);
494 if (buf[i] == '\n') {
495 d->linestart = 1;
499 return ret;
502 static const char * const mux_help[] = {
503 "% h print this help\n\r",
504 "% x exit emulator\n\r",
505 "% s save disk data back to file (if -snapshot)\n\r",
506 "% t toggle console timestamps\n\r",
507 "% b send break (magic sysrq)\n\r",
508 "% c switch between console and monitor\n\r",
509 "% % sends %\n\r",
510 NULL
513 int term_escape_char = 0x01; /* ctrl-a is used for escape */
514 static void mux_print_help(CharDriverState *chr)
516 int i, j;
517 char ebuf[15] = "Escape-Char";
518 char cbuf[50] = "\n\r";
520 if (term_escape_char > 0 && term_escape_char < 26) {
521 snprintf(cbuf, sizeof(cbuf), "\n\r");
522 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
523 } else {
524 snprintf(cbuf, sizeof(cbuf),
525 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
526 term_escape_char);
528 qemu_chr_fe_write(chr, (uint8_t *)cbuf, strlen(cbuf));
529 for (i = 0; mux_help[i] != NULL; i++) {
530 for (j=0; mux_help[i][j] != '\0'; j++) {
531 if (mux_help[i][j] == '%')
532 qemu_chr_fe_write(chr, (uint8_t *)ebuf, strlen(ebuf));
533 else
534 qemu_chr_fe_write(chr, (uint8_t *)&mux_help[i][j], 1);
539 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
541 if (d->chr_event[mux_nr])
542 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
545 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
547 if (d->term_got_escape) {
548 d->term_got_escape = 0;
549 if (ch == term_escape_char)
550 goto send_char;
551 switch(ch) {
552 case '?':
553 case 'h':
554 mux_print_help(chr);
555 break;
556 case 'x':
558 const char *term = "QEMU: Terminated\n\r";
559 qemu_chr_fe_write(chr, (uint8_t *)term, strlen(term));
560 exit(0);
561 break;
563 case 's':
564 bdrv_commit_all();
565 break;
566 case 'b':
567 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
568 break;
569 case 'c':
570 /* Switch to the next registered device */
571 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
572 d->focus++;
573 if (d->focus >= d->mux_cnt)
574 d->focus = 0;
575 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
576 break;
577 case 't':
578 d->timestamps = !d->timestamps;
579 d->timestamps_start = -1;
580 d->linestart = 0;
581 break;
583 } else if (ch == term_escape_char) {
584 d->term_got_escape = 1;
585 } else {
586 send_char:
587 return 1;
589 return 0;
592 static void mux_chr_accept_input(CharDriverState *chr)
594 MuxDriver *d = chr->opaque;
595 int m = d->focus;
597 while (d->prod[m] != d->cons[m] &&
598 d->chr_can_read[m] &&
599 d->chr_can_read[m](d->ext_opaque[m])) {
600 d->chr_read[m](d->ext_opaque[m],
601 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
605 static int mux_chr_can_read(void *opaque)
607 CharDriverState *chr = opaque;
608 MuxDriver *d = chr->opaque;
609 int m = d->focus;
611 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
612 return 1;
613 if (d->chr_can_read[m])
614 return d->chr_can_read[m](d->ext_opaque[m]);
615 return 0;
618 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
620 CharDriverState *chr = opaque;
621 MuxDriver *d = chr->opaque;
622 int m = d->focus;
623 int i;
625 mux_chr_accept_input (opaque);
627 for(i = 0; i < size; i++)
628 if (mux_proc_byte(chr, d, buf[i])) {
629 if (d->prod[m] == d->cons[m] &&
630 d->chr_can_read[m] &&
631 d->chr_can_read[m](d->ext_opaque[m]))
632 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
633 else
634 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
638 static void mux_chr_event(void *opaque, int event)
640 CharDriverState *chr = opaque;
641 MuxDriver *d = chr->opaque;
642 int i;
644 /* Send the event to all registered listeners */
645 for (i = 0; i < d->mux_cnt; i++)
646 mux_chr_send_event(d, i, event);
649 static void mux_chr_update_read_handler(CharDriverState *chr)
651 MuxDriver *d = chr->opaque;
653 if (d->mux_cnt >= MAX_MUX) {
654 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
655 return;
657 d->ext_opaque[d->mux_cnt] = chr->handler_opaque;
658 d->chr_can_read[d->mux_cnt] = chr->chr_can_read;
659 d->chr_read[d->mux_cnt] = chr->chr_read;
660 d->chr_event[d->mux_cnt] = chr->chr_event;
661 /* Fix up the real driver with mux routines */
662 if (d->mux_cnt == 0) {
663 qemu_chr_add_handlers(d->drv, mux_chr_can_read, mux_chr_read,
664 mux_chr_event, chr);
666 if (d->focus != -1) {
667 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
669 d->focus = d->mux_cnt;
670 d->mux_cnt++;
671 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
674 static bool muxes_realized;
677 * Called after processing of default and command-line-specified
678 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
679 * to a mux chardev. This is done here to ensure that
680 * output/prompts/banners are only displayed for the FE that has
681 * focus when initial command-line processing/machine init is
682 * completed.
684 * After this point, any new FE attached to any new or existing
685 * mux will receive CHR_EVENT_OPENED notifications for the BE
686 * immediately.
688 static void muxes_realize_done(Notifier *notifier, void *unused)
690 CharDriverState *chr;
692 QTAILQ_FOREACH(chr, &chardevs, next) {
693 if (chr->is_mux) {
694 MuxDriver *d = chr->opaque;
695 int i;
697 /* send OPENED to all already-attached FEs */
698 for (i = 0; i < d->mux_cnt; i++) {
699 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
701 /* mark mux as OPENED so any new FEs will immediately receive
702 * OPENED event
704 qemu_chr_be_generic_open(chr);
707 muxes_realized = true;
710 static Notifier muxes_realize_notify = {
711 .notify = muxes_realize_done,
714 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
716 MuxDriver *d = s->opaque;
717 return d->drv->chr_add_watch(d->drv, cond);
720 static CharDriverState *qemu_chr_open_mux(const char *id,
721 ChardevBackend *backend,
722 ChardevReturn *ret, Error **errp)
724 ChardevMux *mux = backend->u.mux;
725 CharDriverState *chr, *drv;
726 MuxDriver *d;
727 ChardevCommon *common = qapi_ChardevMux_base(mux);
729 drv = qemu_chr_find(mux->chardev);
730 if (drv == NULL) {
731 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
732 return NULL;
735 chr = qemu_chr_alloc(common, errp);
736 if (!chr) {
737 return NULL;
739 d = g_new0(MuxDriver, 1);
741 chr->opaque = d;
742 d->drv = drv;
743 d->focus = -1;
744 chr->chr_write = mux_chr_write;
745 chr->chr_update_read_handler = mux_chr_update_read_handler;
746 chr->chr_accept_input = mux_chr_accept_input;
747 /* Frontend guest-open / -close notification is not support with muxes */
748 chr->chr_set_fe_open = NULL;
749 if (drv->chr_add_watch) {
750 chr->chr_add_watch = mux_chr_add_watch;
752 /* only default to opened state if we've realized the initial
753 * set of muxes
755 chr->explicit_be_open = muxes_realized ? 0 : 1;
756 chr->is_mux = 1;
758 return chr;
762 typedef struct IOWatchPoll
764 GSource parent;
766 QIOChannel *ioc;
767 GSource *src;
769 IOCanReadHandler *fd_can_read;
770 GSourceFunc fd_read;
771 void *opaque;
772 } IOWatchPoll;
774 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
776 return container_of(source, IOWatchPoll, parent);
779 static gboolean io_watch_poll_prepare(GSource *source, gint *timeout_)
781 IOWatchPoll *iwp = io_watch_poll_from_source(source);
782 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
783 bool was_active = iwp->src != NULL;
784 if (was_active == now_active) {
785 return FALSE;
788 if (now_active) {
789 iwp->src = qio_channel_create_watch(
790 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
791 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
792 g_source_attach(iwp->src, NULL);
793 } else {
794 g_source_destroy(iwp->src);
795 g_source_unref(iwp->src);
796 iwp->src = NULL;
798 return FALSE;
801 static gboolean io_watch_poll_check(GSource *source)
803 return FALSE;
806 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
807 gpointer user_data)
809 abort();
812 static void io_watch_poll_finalize(GSource *source)
814 /* Due to a glib bug, removing the last reference to a source
815 * inside a finalize callback causes recursive locking (and a
816 * deadlock). This is not a problem inside other callbacks,
817 * including dispatch callbacks, so we call io_remove_watch_poll
818 * to remove this source. At this point, iwp->src must
819 * be NULL, or we would leak it.
821 * This would be solved much more elegantly by child sources,
822 * but we support older glib versions that do not have them.
824 IOWatchPoll *iwp = io_watch_poll_from_source(source);
825 assert(iwp->src == NULL);
828 static GSourceFuncs io_watch_poll_funcs = {
829 .prepare = io_watch_poll_prepare,
830 .check = io_watch_poll_check,
831 .dispatch = io_watch_poll_dispatch,
832 .finalize = io_watch_poll_finalize,
835 /* Can only be used for read */
836 static guint io_add_watch_poll(QIOChannel *ioc,
837 IOCanReadHandler *fd_can_read,
838 QIOChannelFunc fd_read,
839 gpointer user_data)
841 IOWatchPoll *iwp;
842 int tag;
844 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs, sizeof(IOWatchPoll));
845 iwp->fd_can_read = fd_can_read;
846 iwp->opaque = user_data;
847 iwp->ioc = ioc;
848 iwp->fd_read = (GSourceFunc) fd_read;
849 iwp->src = NULL;
851 tag = g_source_attach(&iwp->parent, NULL);
852 g_source_unref(&iwp->parent);
853 return tag;
856 static void io_remove_watch_poll(guint tag)
858 GSource *source;
859 IOWatchPoll *iwp;
861 g_return_if_fail (tag > 0);
863 source = g_main_context_find_source_by_id(NULL, tag);
864 g_return_if_fail (source != NULL);
866 iwp = io_watch_poll_from_source(source);
867 if (iwp->src) {
868 g_source_destroy(iwp->src);
869 g_source_unref(iwp->src);
870 iwp->src = NULL;
872 g_source_destroy(&iwp->parent);
875 static void remove_fd_in_watch(CharDriverState *chr)
877 if (chr->fd_in_tag) {
878 io_remove_watch_poll(chr->fd_in_tag);
879 chr->fd_in_tag = 0;
884 static int io_channel_send_full(QIOChannel *ioc,
885 const void *buf, size_t len,
886 int *fds, size_t nfds)
888 size_t offset = 0;
890 while (offset < len) {
891 ssize_t ret = 0;
892 struct iovec iov = { .iov_base = (char *)buf + offset,
893 .iov_len = len - offset };
895 ret = qio_channel_writev_full(
896 ioc, &iov, 1,
897 fds, nfds, NULL);
898 if (ret == QIO_CHANNEL_ERR_BLOCK) {
899 if (offset) {
900 return offset;
903 errno = EAGAIN;
904 return -1;
905 } else if (ret < 0) {
906 errno = EINVAL;
907 return -1;
910 offset += ret;
913 return offset;
917 #ifndef _WIN32
918 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
920 return io_channel_send_full(ioc, buf, len, NULL, 0);
924 typedef struct FDCharDriver {
925 CharDriverState *chr;
926 QIOChannel *ioc_in, *ioc_out;
927 int max_size;
928 } FDCharDriver;
930 /* Called with chr_write_lock held. */
931 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
933 FDCharDriver *s = chr->opaque;
935 return io_channel_send(s->ioc_out, buf, len);
938 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
940 CharDriverState *chr = opaque;
941 FDCharDriver *s = chr->opaque;
942 int len;
943 uint8_t buf[READ_BUF_LEN];
944 ssize_t ret;
946 len = sizeof(buf);
947 if (len > s->max_size) {
948 len = s->max_size;
950 if (len == 0) {
951 return TRUE;
954 ret = qio_channel_read(
955 chan, (gchar *)buf, len, NULL);
956 if (ret == 0) {
957 remove_fd_in_watch(chr);
958 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
959 return FALSE;
961 if (ret > 0) {
962 qemu_chr_be_write(chr, buf, ret);
965 return TRUE;
968 static int fd_chr_read_poll(void *opaque)
970 CharDriverState *chr = opaque;
971 FDCharDriver *s = chr->opaque;
973 s->max_size = qemu_chr_be_can_write(chr);
974 return s->max_size;
977 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
979 FDCharDriver *s = chr->opaque;
980 return qio_channel_create_watch(s->ioc_out, cond);
983 static void fd_chr_update_read_handler(CharDriverState *chr)
985 FDCharDriver *s = chr->opaque;
987 remove_fd_in_watch(chr);
988 if (s->ioc_in) {
989 chr->fd_in_tag = io_add_watch_poll(s->ioc_in,
990 fd_chr_read_poll,
991 fd_chr_read, chr);
995 static void fd_chr_close(struct CharDriverState *chr)
997 FDCharDriver *s = chr->opaque;
999 remove_fd_in_watch(chr);
1000 if (s->ioc_in) {
1001 object_unref(OBJECT(s->ioc_in));
1003 if (s->ioc_out) {
1004 object_unref(OBJECT(s->ioc_out));
1007 g_free(s);
1008 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1011 /* open a character device to a unix fd */
1012 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out,
1013 ChardevCommon *backend, Error **errp)
1015 CharDriverState *chr;
1016 FDCharDriver *s;
1018 chr = qemu_chr_alloc(backend, errp);
1019 if (!chr) {
1020 return NULL;
1022 s = g_new0(FDCharDriver, 1);
1023 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1024 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1025 qemu_set_nonblock(fd_out);
1026 s->chr = chr;
1027 chr->opaque = s;
1028 chr->chr_add_watch = fd_chr_add_watch;
1029 chr->chr_write = fd_chr_write;
1030 chr->chr_update_read_handler = fd_chr_update_read_handler;
1031 chr->chr_close = fd_chr_close;
1033 return chr;
1036 static CharDriverState *qemu_chr_open_pipe(const char *id,
1037 ChardevBackend *backend,
1038 ChardevReturn *ret,
1039 Error **errp)
1041 ChardevHostdev *opts = backend->u.pipe;
1042 int fd_in, fd_out;
1043 char *filename_in;
1044 char *filename_out;
1045 const char *filename = opts->device;
1046 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
1049 filename_in = g_strdup_printf("%s.in", filename);
1050 filename_out = g_strdup_printf("%s.out", filename);
1051 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1052 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1053 g_free(filename_in);
1054 g_free(filename_out);
1055 if (fd_in < 0 || fd_out < 0) {
1056 if (fd_in >= 0)
1057 close(fd_in);
1058 if (fd_out >= 0)
1059 close(fd_out);
1060 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1061 if (fd_in < 0) {
1062 error_setg_file_open(errp, errno, filename);
1063 return NULL;
1066 return qemu_chr_open_fd(fd_in, fd_out, common, errp);
1069 /* init terminal so that we can grab keys */
1070 static struct termios oldtty;
1071 static int old_fd0_flags;
1072 static bool stdio_in_use;
1073 static bool stdio_allow_signal;
1074 static bool stdio_echo_state;
1076 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1078 static void term_exit(void)
1080 tcsetattr (0, TCSANOW, &oldtty);
1081 fcntl(0, F_SETFL, old_fd0_flags);
1084 static void term_stdio_handler(int sig)
1086 /* restore echo after resume from suspend. */
1087 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1090 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1092 struct termios tty;
1094 stdio_echo_state = echo;
1095 tty = oldtty;
1096 if (!echo) {
1097 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1098 |INLCR|IGNCR|ICRNL|IXON);
1099 tty.c_oflag |= OPOST;
1100 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1101 tty.c_cflag &= ~(CSIZE|PARENB);
1102 tty.c_cflag |= CS8;
1103 tty.c_cc[VMIN] = 1;
1104 tty.c_cc[VTIME] = 0;
1106 if (!stdio_allow_signal)
1107 tty.c_lflag &= ~ISIG;
1109 tcsetattr (0, TCSANOW, &tty);
1112 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1114 term_exit();
1115 fd_chr_close(chr);
1118 static CharDriverState *qemu_chr_open_stdio(const char *id,
1119 ChardevBackend *backend,
1120 ChardevReturn *ret,
1121 Error **errp)
1123 ChardevStdio *opts = backend->u.stdio;
1124 CharDriverState *chr;
1125 struct sigaction act;
1126 ChardevCommon *common = qapi_ChardevStdio_base(opts);
1128 if (is_daemonized()) {
1129 error_setg(errp, "cannot use stdio with -daemonize");
1130 return NULL;
1133 if (stdio_in_use) {
1134 error_setg(errp, "cannot use stdio by multiple character devices");
1135 return NULL;
1138 stdio_in_use = true;
1139 old_fd0_flags = fcntl(0, F_GETFL);
1140 tcgetattr(0, &oldtty);
1141 qemu_set_nonblock(0);
1142 atexit(term_exit);
1144 memset(&act, 0, sizeof(act));
1145 act.sa_handler = term_stdio_handler;
1146 sigaction(SIGCONT, &act, NULL);
1148 chr = qemu_chr_open_fd(0, 1, common, errp);
1149 chr->chr_close = qemu_chr_close_stdio;
1150 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1151 if (opts->has_signal) {
1152 stdio_allow_signal = opts->signal;
1154 qemu_chr_fe_set_echo(chr, false);
1156 return chr;
1159 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1160 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1161 || defined(__GLIBC__)
1163 #define HAVE_CHARDEV_SERIAL 1
1164 #define HAVE_CHARDEV_PTY 1
1166 typedef struct {
1167 QIOChannel *ioc;
1168 int read_bytes;
1170 /* Protected by the CharDriverState chr_write_lock. */
1171 int connected;
1172 guint timer_tag;
1173 guint open_tag;
1174 } PtyCharDriver;
1176 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1177 static void pty_chr_state(CharDriverState *chr, int connected);
1179 static gboolean pty_chr_timer(gpointer opaque)
1181 struct CharDriverState *chr = opaque;
1182 PtyCharDriver *s = chr->opaque;
1184 qemu_mutex_lock(&chr->chr_write_lock);
1185 s->timer_tag = 0;
1186 s->open_tag = 0;
1187 if (!s->connected) {
1188 /* Next poll ... */
1189 pty_chr_update_read_handler_locked(chr);
1191 qemu_mutex_unlock(&chr->chr_write_lock);
1192 return FALSE;
1195 /* Called with chr_write_lock held. */
1196 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1198 PtyCharDriver *s = chr->opaque;
1200 if (s->timer_tag) {
1201 g_source_remove(s->timer_tag);
1202 s->timer_tag = 0;
1205 if (ms == 1000) {
1206 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1207 } else {
1208 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1212 /* Called with chr_write_lock held. */
1213 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1215 PtyCharDriver *s = chr->opaque;
1216 GPollFD pfd;
1217 int rc;
1218 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1220 pfd.fd = fioc->fd;
1221 pfd.events = G_IO_OUT;
1222 pfd.revents = 0;
1223 do {
1224 rc = g_poll(&pfd, 1, 0);
1225 } while (rc == -1 && errno == EINTR);
1226 assert(rc >= 0);
1228 if (pfd.revents & G_IO_HUP) {
1229 pty_chr_state(chr, 0);
1230 } else {
1231 pty_chr_state(chr, 1);
1235 static void pty_chr_update_read_handler(CharDriverState *chr)
1237 qemu_mutex_lock(&chr->chr_write_lock);
1238 pty_chr_update_read_handler_locked(chr);
1239 qemu_mutex_unlock(&chr->chr_write_lock);
1242 /* Called with chr_write_lock held. */
1243 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1245 PtyCharDriver *s = chr->opaque;
1247 if (!s->connected) {
1248 /* guest sends data, check for (re-)connect */
1249 pty_chr_update_read_handler_locked(chr);
1250 if (!s->connected) {
1251 return 0;
1254 return io_channel_send(s->ioc, buf, len);
1257 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1259 PtyCharDriver *s = chr->opaque;
1260 if (!s->connected) {
1261 return NULL;
1263 return qio_channel_create_watch(s->ioc, cond);
1266 static int pty_chr_read_poll(void *opaque)
1268 CharDriverState *chr = opaque;
1269 PtyCharDriver *s = chr->opaque;
1271 s->read_bytes = qemu_chr_be_can_write(chr);
1272 return s->read_bytes;
1275 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1277 CharDriverState *chr = opaque;
1278 PtyCharDriver *s = chr->opaque;
1279 gsize len;
1280 uint8_t buf[READ_BUF_LEN];
1281 ssize_t ret;
1283 len = sizeof(buf);
1284 if (len > s->read_bytes)
1285 len = s->read_bytes;
1286 if (len == 0) {
1287 return TRUE;
1289 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1290 if (ret <= 0) {
1291 pty_chr_state(chr, 0);
1292 return FALSE;
1293 } else {
1294 pty_chr_state(chr, 1);
1295 qemu_chr_be_write(chr, buf, ret);
1297 return TRUE;
1300 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1302 CharDriverState *chr = opaque;
1303 PtyCharDriver *s = chr->opaque;
1305 s->open_tag = 0;
1306 qemu_chr_be_generic_open(chr);
1307 return FALSE;
1310 /* Called with chr_write_lock held. */
1311 static void pty_chr_state(CharDriverState *chr, int connected)
1313 PtyCharDriver *s = chr->opaque;
1315 if (!connected) {
1316 if (s->open_tag) {
1317 g_source_remove(s->open_tag);
1318 s->open_tag = 0;
1320 remove_fd_in_watch(chr);
1321 s->connected = 0;
1322 /* (re-)connect poll interval for idle guests: once per second.
1323 * We check more frequently in case the guests sends data to
1324 * the virtual device linked to our pty. */
1325 pty_chr_rearm_timer(chr, 1000);
1326 } else {
1327 if (s->timer_tag) {
1328 g_source_remove(s->timer_tag);
1329 s->timer_tag = 0;
1331 if (!s->connected) {
1332 g_assert(s->open_tag == 0);
1333 s->connected = 1;
1334 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1336 if (!chr->fd_in_tag) {
1337 chr->fd_in_tag = io_add_watch_poll(s->ioc,
1338 pty_chr_read_poll,
1339 pty_chr_read, chr);
1344 static void pty_chr_close(struct CharDriverState *chr)
1346 PtyCharDriver *s = chr->opaque;
1348 qemu_mutex_lock(&chr->chr_write_lock);
1349 pty_chr_state(chr, 0);
1350 object_unref(OBJECT(s->ioc));
1351 if (s->timer_tag) {
1352 g_source_remove(s->timer_tag);
1353 s->timer_tag = 0;
1355 qemu_mutex_unlock(&chr->chr_write_lock);
1356 g_free(s);
1357 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1360 static CharDriverState *qemu_chr_open_pty(const char *id,
1361 ChardevBackend *backend,
1362 ChardevReturn *ret,
1363 Error **errp)
1365 CharDriverState *chr;
1366 PtyCharDriver *s;
1367 int master_fd, slave_fd;
1368 char pty_name[PATH_MAX];
1369 ChardevCommon *common = backend->u.pty;
1371 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1372 if (master_fd < 0) {
1373 error_setg_errno(errp, errno, "Failed to create PTY");
1374 return NULL;
1377 close(slave_fd);
1378 qemu_set_nonblock(master_fd);
1380 chr = qemu_chr_alloc(common, errp);
1381 if (!chr) {
1382 close(master_fd);
1383 return NULL;
1386 chr->filename = g_strdup_printf("pty:%s", pty_name);
1387 ret->pty = g_strdup(pty_name);
1388 ret->has_pty = true;
1390 fprintf(stderr, "char device redirected to %s (label %s)\n",
1391 pty_name, id);
1393 s = g_new0(PtyCharDriver, 1);
1394 chr->opaque = s;
1395 chr->chr_write = pty_chr_write;
1396 chr->chr_update_read_handler = pty_chr_update_read_handler;
1397 chr->chr_close = pty_chr_close;
1398 chr->chr_add_watch = pty_chr_add_watch;
1399 chr->explicit_be_open = true;
1401 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1402 s->timer_tag = 0;
1404 return chr;
1407 static void tty_serial_init(int fd, int speed,
1408 int parity, int data_bits, int stop_bits)
1410 struct termios tty;
1411 speed_t spd;
1413 #if 0
1414 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1415 speed, parity, data_bits, stop_bits);
1416 #endif
1417 tcgetattr (fd, &tty);
1419 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1420 speed = speed * 10 / 11;
1421 do {
1422 check_speed(50);
1423 check_speed(75);
1424 check_speed(110);
1425 check_speed(134);
1426 check_speed(150);
1427 check_speed(200);
1428 check_speed(300);
1429 check_speed(600);
1430 check_speed(1200);
1431 check_speed(1800);
1432 check_speed(2400);
1433 check_speed(4800);
1434 check_speed(9600);
1435 check_speed(19200);
1436 check_speed(38400);
1437 /* Non-Posix values follow. They may be unsupported on some systems. */
1438 check_speed(57600);
1439 check_speed(115200);
1440 #ifdef B230400
1441 check_speed(230400);
1442 #endif
1443 #ifdef B460800
1444 check_speed(460800);
1445 #endif
1446 #ifdef B500000
1447 check_speed(500000);
1448 #endif
1449 #ifdef B576000
1450 check_speed(576000);
1451 #endif
1452 #ifdef B921600
1453 check_speed(921600);
1454 #endif
1455 #ifdef B1000000
1456 check_speed(1000000);
1457 #endif
1458 #ifdef B1152000
1459 check_speed(1152000);
1460 #endif
1461 #ifdef B1500000
1462 check_speed(1500000);
1463 #endif
1464 #ifdef B2000000
1465 check_speed(2000000);
1466 #endif
1467 #ifdef B2500000
1468 check_speed(2500000);
1469 #endif
1470 #ifdef B3000000
1471 check_speed(3000000);
1472 #endif
1473 #ifdef B3500000
1474 check_speed(3500000);
1475 #endif
1476 #ifdef B4000000
1477 check_speed(4000000);
1478 #endif
1479 spd = B115200;
1480 } while (0);
1482 cfsetispeed(&tty, spd);
1483 cfsetospeed(&tty, spd);
1485 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1486 |INLCR|IGNCR|ICRNL|IXON);
1487 tty.c_oflag |= OPOST;
1488 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1489 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1490 switch(data_bits) {
1491 default:
1492 case 8:
1493 tty.c_cflag |= CS8;
1494 break;
1495 case 7:
1496 tty.c_cflag |= CS7;
1497 break;
1498 case 6:
1499 tty.c_cflag |= CS6;
1500 break;
1501 case 5:
1502 tty.c_cflag |= CS5;
1503 break;
1505 switch(parity) {
1506 default:
1507 case 'N':
1508 break;
1509 case 'E':
1510 tty.c_cflag |= PARENB;
1511 break;
1512 case 'O':
1513 tty.c_cflag |= PARENB | PARODD;
1514 break;
1516 if (stop_bits == 2)
1517 tty.c_cflag |= CSTOPB;
1519 tcsetattr (fd, TCSANOW, &tty);
1522 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1524 FDCharDriver *s = chr->opaque;
1525 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1527 switch(cmd) {
1528 case CHR_IOCTL_SERIAL_SET_PARAMS:
1530 QEMUSerialSetParams *ssp = arg;
1531 tty_serial_init(fioc->fd,
1532 ssp->speed, ssp->parity,
1533 ssp->data_bits, ssp->stop_bits);
1535 break;
1536 case CHR_IOCTL_SERIAL_SET_BREAK:
1538 int enable = *(int *)arg;
1539 if (enable) {
1540 tcsendbreak(fioc->fd, 1);
1543 break;
1544 case CHR_IOCTL_SERIAL_GET_TIOCM:
1546 int sarg = 0;
1547 int *targ = (int *)arg;
1548 ioctl(fioc->fd, TIOCMGET, &sarg);
1549 *targ = 0;
1550 if (sarg & TIOCM_CTS)
1551 *targ |= CHR_TIOCM_CTS;
1552 if (sarg & TIOCM_CAR)
1553 *targ |= CHR_TIOCM_CAR;
1554 if (sarg & TIOCM_DSR)
1555 *targ |= CHR_TIOCM_DSR;
1556 if (sarg & TIOCM_RI)
1557 *targ |= CHR_TIOCM_RI;
1558 if (sarg & TIOCM_DTR)
1559 *targ |= CHR_TIOCM_DTR;
1560 if (sarg & TIOCM_RTS)
1561 *targ |= CHR_TIOCM_RTS;
1563 break;
1564 case CHR_IOCTL_SERIAL_SET_TIOCM:
1566 int sarg = *(int *)arg;
1567 int targ = 0;
1568 ioctl(fioc->fd, TIOCMGET, &targ);
1569 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1570 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1571 if (sarg & CHR_TIOCM_CTS)
1572 targ |= TIOCM_CTS;
1573 if (sarg & CHR_TIOCM_CAR)
1574 targ |= TIOCM_CAR;
1575 if (sarg & CHR_TIOCM_DSR)
1576 targ |= TIOCM_DSR;
1577 if (sarg & CHR_TIOCM_RI)
1578 targ |= TIOCM_RI;
1579 if (sarg & CHR_TIOCM_DTR)
1580 targ |= TIOCM_DTR;
1581 if (sarg & CHR_TIOCM_RTS)
1582 targ |= TIOCM_RTS;
1583 ioctl(fioc->fd, TIOCMSET, &targ);
1585 break;
1586 default:
1587 return -ENOTSUP;
1589 return 0;
1592 static void qemu_chr_close_tty(CharDriverState *chr)
1594 fd_chr_close(chr);
1597 static CharDriverState *qemu_chr_open_tty_fd(int fd,
1598 ChardevCommon *backend,
1599 Error **errp)
1601 CharDriverState *chr;
1603 tty_serial_init(fd, 115200, 'N', 8, 1);
1604 chr = qemu_chr_open_fd(fd, fd, backend, errp);
1605 chr->chr_ioctl = tty_serial_ioctl;
1606 chr->chr_close = qemu_chr_close_tty;
1607 return chr;
1609 #endif /* __linux__ || __sun__ */
1611 #if defined(__linux__)
1613 #define HAVE_CHARDEV_PARPORT 1
1615 typedef struct {
1616 int fd;
1617 int mode;
1618 } ParallelCharDriver;
1620 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1622 if (s->mode != mode) {
1623 int m = mode;
1624 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1625 return 0;
1626 s->mode = mode;
1628 return 1;
1631 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1633 ParallelCharDriver *drv = chr->opaque;
1634 int fd = drv->fd;
1635 uint8_t b;
1637 switch(cmd) {
1638 case CHR_IOCTL_PP_READ_DATA:
1639 if (ioctl(fd, PPRDATA, &b) < 0)
1640 return -ENOTSUP;
1641 *(uint8_t *)arg = b;
1642 break;
1643 case CHR_IOCTL_PP_WRITE_DATA:
1644 b = *(uint8_t *)arg;
1645 if (ioctl(fd, PPWDATA, &b) < 0)
1646 return -ENOTSUP;
1647 break;
1648 case CHR_IOCTL_PP_READ_CONTROL:
1649 if (ioctl(fd, PPRCONTROL, &b) < 0)
1650 return -ENOTSUP;
1651 /* Linux gives only the lowest bits, and no way to know data
1652 direction! For better compatibility set the fixed upper
1653 bits. */
1654 *(uint8_t *)arg = b | 0xc0;
1655 break;
1656 case CHR_IOCTL_PP_WRITE_CONTROL:
1657 b = *(uint8_t *)arg;
1658 if (ioctl(fd, PPWCONTROL, &b) < 0)
1659 return -ENOTSUP;
1660 break;
1661 case CHR_IOCTL_PP_READ_STATUS:
1662 if (ioctl(fd, PPRSTATUS, &b) < 0)
1663 return -ENOTSUP;
1664 *(uint8_t *)arg = b;
1665 break;
1666 case CHR_IOCTL_PP_DATA_DIR:
1667 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1668 return -ENOTSUP;
1669 break;
1670 case CHR_IOCTL_PP_EPP_READ_ADDR:
1671 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1672 struct ParallelIOArg *parg = arg;
1673 int n = read(fd, parg->buffer, parg->count);
1674 if (n != parg->count) {
1675 return -EIO;
1678 break;
1679 case CHR_IOCTL_PP_EPP_READ:
1680 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1681 struct ParallelIOArg *parg = arg;
1682 int n = read(fd, parg->buffer, parg->count);
1683 if (n != parg->count) {
1684 return -EIO;
1687 break;
1688 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1689 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1690 struct ParallelIOArg *parg = arg;
1691 int n = write(fd, parg->buffer, parg->count);
1692 if (n != parg->count) {
1693 return -EIO;
1696 break;
1697 case CHR_IOCTL_PP_EPP_WRITE:
1698 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1699 struct ParallelIOArg *parg = arg;
1700 int n = write(fd, parg->buffer, parg->count);
1701 if (n != parg->count) {
1702 return -EIO;
1705 break;
1706 default:
1707 return -ENOTSUP;
1709 return 0;
1712 static void pp_close(CharDriverState *chr)
1714 ParallelCharDriver *drv = chr->opaque;
1715 int fd = drv->fd;
1717 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1718 ioctl(fd, PPRELEASE);
1719 close(fd);
1720 g_free(drv);
1721 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1724 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1725 ChardevCommon *backend,
1726 Error **errp)
1728 CharDriverState *chr;
1729 ParallelCharDriver *drv;
1731 if (ioctl(fd, PPCLAIM) < 0) {
1732 error_setg_errno(errp, errno, "not a parallel port");
1733 close(fd);
1734 return NULL;
1737 chr = qemu_chr_alloc(backend, errp);
1738 if (!chr) {
1739 return NULL;
1742 drv = g_new0(ParallelCharDriver, 1);
1743 chr->opaque = drv;
1744 chr->chr_write = null_chr_write;
1745 chr->chr_ioctl = pp_ioctl;
1746 chr->chr_close = pp_close;
1748 drv->fd = fd;
1749 drv->mode = IEEE1284_MODE_COMPAT;
1751 return chr;
1753 #endif /* __linux__ */
1755 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1757 #define HAVE_CHARDEV_PARPORT 1
1759 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1761 int fd = (int)(intptr_t)chr->opaque;
1762 uint8_t b;
1764 switch(cmd) {
1765 case CHR_IOCTL_PP_READ_DATA:
1766 if (ioctl(fd, PPIGDATA, &b) < 0)
1767 return -ENOTSUP;
1768 *(uint8_t *)arg = b;
1769 break;
1770 case CHR_IOCTL_PP_WRITE_DATA:
1771 b = *(uint8_t *)arg;
1772 if (ioctl(fd, PPISDATA, &b) < 0)
1773 return -ENOTSUP;
1774 break;
1775 case CHR_IOCTL_PP_READ_CONTROL:
1776 if (ioctl(fd, PPIGCTRL, &b) < 0)
1777 return -ENOTSUP;
1778 *(uint8_t *)arg = b;
1779 break;
1780 case CHR_IOCTL_PP_WRITE_CONTROL:
1781 b = *(uint8_t *)arg;
1782 if (ioctl(fd, PPISCTRL, &b) < 0)
1783 return -ENOTSUP;
1784 break;
1785 case CHR_IOCTL_PP_READ_STATUS:
1786 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1787 return -ENOTSUP;
1788 *(uint8_t *)arg = b;
1789 break;
1790 default:
1791 return -ENOTSUP;
1793 return 0;
1796 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1797 ChardevCommon *backend,
1798 Error **errp)
1800 CharDriverState *chr;
1802 chr = qemu_chr_alloc(backend, errp);
1803 if (!chr) {
1804 return NULL;
1806 chr->opaque = (void *)(intptr_t)fd;
1807 chr->chr_write = null_chr_write;
1808 chr->chr_ioctl = pp_ioctl;
1809 chr->explicit_be_open = true;
1810 return chr;
1812 #endif
1814 #else /* _WIN32 */
1816 #define HAVE_CHARDEV_SERIAL 1
1818 typedef struct {
1819 int max_size;
1820 HANDLE hcom, hrecv, hsend;
1821 OVERLAPPED orecv;
1822 BOOL fpipe;
1823 DWORD len;
1825 /* Protected by the CharDriverState chr_write_lock. */
1826 OVERLAPPED osend;
1827 } WinCharState;
1829 typedef struct {
1830 HANDLE hStdIn;
1831 HANDLE hInputReadyEvent;
1832 HANDLE hInputDoneEvent;
1833 HANDLE hInputThread;
1834 uint8_t win_stdio_buf;
1835 } WinStdioCharState;
1837 #define NSENDBUF 2048
1838 #define NRECVBUF 2048
1839 #define MAXCONNECT 1
1840 #define NTIMEOUT 5000
1842 static int win_chr_poll(void *opaque);
1843 static int win_chr_pipe_poll(void *opaque);
1845 static void win_chr_close(CharDriverState *chr)
1847 WinCharState *s = chr->opaque;
1849 if (s->hsend) {
1850 CloseHandle(s->hsend);
1851 s->hsend = NULL;
1853 if (s->hrecv) {
1854 CloseHandle(s->hrecv);
1855 s->hrecv = NULL;
1857 if (s->hcom) {
1858 CloseHandle(s->hcom);
1859 s->hcom = NULL;
1861 if (s->fpipe)
1862 qemu_del_polling_cb(win_chr_pipe_poll, chr);
1863 else
1864 qemu_del_polling_cb(win_chr_poll, chr);
1866 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1869 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
1871 WinCharState *s = chr->opaque;
1872 COMMCONFIG comcfg;
1873 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
1874 COMSTAT comstat;
1875 DWORD size;
1876 DWORD err;
1878 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
1879 if (!s->hsend) {
1880 error_setg(errp, "Failed CreateEvent");
1881 goto fail;
1883 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
1884 if (!s->hrecv) {
1885 error_setg(errp, "Failed CreateEvent");
1886 goto fail;
1889 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
1890 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
1891 if (s->hcom == INVALID_HANDLE_VALUE) {
1892 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
1893 s->hcom = NULL;
1894 goto fail;
1897 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
1898 error_setg(errp, "Failed SetupComm");
1899 goto fail;
1902 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
1903 size = sizeof(COMMCONFIG);
1904 GetDefaultCommConfig(filename, &comcfg, &size);
1905 comcfg.dcb.DCBlength = sizeof(DCB);
1906 CommConfigDialog(filename, NULL, &comcfg);
1908 if (!SetCommState(s->hcom, &comcfg.dcb)) {
1909 error_setg(errp, "Failed SetCommState");
1910 goto fail;
1913 if (!SetCommMask(s->hcom, EV_ERR)) {
1914 error_setg(errp, "Failed SetCommMask");
1915 goto fail;
1918 cto.ReadIntervalTimeout = MAXDWORD;
1919 if (!SetCommTimeouts(s->hcom, &cto)) {
1920 error_setg(errp, "Failed SetCommTimeouts");
1921 goto fail;
1924 if (!ClearCommError(s->hcom, &err, &comstat)) {
1925 error_setg(errp, "Failed ClearCommError");
1926 goto fail;
1928 qemu_add_polling_cb(win_chr_poll, chr);
1929 return 0;
1931 fail:
1932 win_chr_close(chr);
1933 return -1;
1936 /* Called with chr_write_lock held. */
1937 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
1939 WinCharState *s = chr->opaque;
1940 DWORD len, ret, size, err;
1942 len = len1;
1943 ZeroMemory(&s->osend, sizeof(s->osend));
1944 s->osend.hEvent = s->hsend;
1945 while (len > 0) {
1946 if (s->hsend)
1947 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
1948 else
1949 ret = WriteFile(s->hcom, buf, len, &size, NULL);
1950 if (!ret) {
1951 err = GetLastError();
1952 if (err == ERROR_IO_PENDING) {
1953 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
1954 if (ret) {
1955 buf += size;
1956 len -= size;
1957 } else {
1958 break;
1960 } else {
1961 break;
1963 } else {
1964 buf += size;
1965 len -= size;
1968 return len1 - len;
1971 static int win_chr_read_poll(CharDriverState *chr)
1973 WinCharState *s = chr->opaque;
1975 s->max_size = qemu_chr_be_can_write(chr);
1976 return s->max_size;
1979 static void win_chr_readfile(CharDriverState *chr)
1981 WinCharState *s = chr->opaque;
1982 int ret, err;
1983 uint8_t buf[READ_BUF_LEN];
1984 DWORD size;
1986 ZeroMemory(&s->orecv, sizeof(s->orecv));
1987 s->orecv.hEvent = s->hrecv;
1988 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
1989 if (!ret) {
1990 err = GetLastError();
1991 if (err == ERROR_IO_PENDING) {
1992 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
1996 if (size > 0) {
1997 qemu_chr_be_write(chr, buf, size);
2001 static void win_chr_read(CharDriverState *chr)
2003 WinCharState *s = chr->opaque;
2005 if (s->len > s->max_size)
2006 s->len = s->max_size;
2007 if (s->len == 0)
2008 return;
2010 win_chr_readfile(chr);
2013 static int win_chr_poll(void *opaque)
2015 CharDriverState *chr = opaque;
2016 WinCharState *s = chr->opaque;
2017 COMSTAT status;
2018 DWORD comerr;
2020 ClearCommError(s->hcom, &comerr, &status);
2021 if (status.cbInQue > 0) {
2022 s->len = status.cbInQue;
2023 win_chr_read_poll(chr);
2024 win_chr_read(chr);
2025 return 1;
2027 return 0;
2030 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2031 ChardevCommon *backend,
2032 Error **errp)
2034 CharDriverState *chr;
2035 WinCharState *s;
2037 chr = qemu_chr_alloc(backend, errp);
2038 if (!chr) {
2039 return NULL;
2041 s = g_new0(WinCharState, 1);
2042 chr->opaque = s;
2043 chr->chr_write = win_chr_write;
2044 chr->chr_close = win_chr_close;
2046 if (win_chr_init(chr, filename, errp) < 0) {
2047 g_free(s);
2048 qemu_chr_free_common(chr);
2049 return NULL;
2051 return chr;
2054 static int win_chr_pipe_poll(void *opaque)
2056 CharDriverState *chr = opaque;
2057 WinCharState *s = chr->opaque;
2058 DWORD size;
2060 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2061 if (size > 0) {
2062 s->len = size;
2063 win_chr_read_poll(chr);
2064 win_chr_read(chr);
2065 return 1;
2067 return 0;
2070 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2071 Error **errp)
2073 WinCharState *s = chr->opaque;
2074 OVERLAPPED ov;
2075 int ret;
2076 DWORD size;
2077 char *openname;
2079 s->fpipe = TRUE;
2081 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2082 if (!s->hsend) {
2083 error_setg(errp, "Failed CreateEvent");
2084 goto fail;
2086 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2087 if (!s->hrecv) {
2088 error_setg(errp, "Failed CreateEvent");
2089 goto fail;
2092 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2093 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2094 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2095 PIPE_WAIT,
2096 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2097 g_free(openname);
2098 if (s->hcom == INVALID_HANDLE_VALUE) {
2099 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2100 s->hcom = NULL;
2101 goto fail;
2104 ZeroMemory(&ov, sizeof(ov));
2105 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2106 ret = ConnectNamedPipe(s->hcom, &ov);
2107 if (ret) {
2108 error_setg(errp, "Failed ConnectNamedPipe");
2109 goto fail;
2112 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2113 if (!ret) {
2114 error_setg(errp, "Failed GetOverlappedResult");
2115 if (ov.hEvent) {
2116 CloseHandle(ov.hEvent);
2117 ov.hEvent = NULL;
2119 goto fail;
2122 if (ov.hEvent) {
2123 CloseHandle(ov.hEvent);
2124 ov.hEvent = NULL;
2126 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2127 return 0;
2129 fail:
2130 win_chr_close(chr);
2131 return -1;
2135 static CharDriverState *qemu_chr_open_pipe(const char *id,
2136 ChardevBackend *backend,
2137 ChardevReturn *ret,
2138 Error **errp)
2140 ChardevHostdev *opts = backend->u.pipe;
2141 const char *filename = opts->device;
2142 CharDriverState *chr;
2143 WinCharState *s;
2144 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
2146 chr = qemu_chr_alloc(common, errp);
2147 if (!chr) {
2148 return NULL;
2150 s = g_new0(WinCharState, 1);
2151 chr->opaque = s;
2152 chr->chr_write = win_chr_write;
2153 chr->chr_close = win_chr_close;
2155 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2156 g_free(s);
2157 qemu_chr_free_common(chr);
2158 return NULL;
2160 return chr;
2163 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out,
2164 ChardevCommon *backend,
2165 Error **errp)
2167 CharDriverState *chr;
2168 WinCharState *s;
2170 chr = qemu_chr_alloc(backend, errp);
2171 if (!chr) {
2172 return NULL;
2174 s = g_new0(WinCharState, 1);
2175 s->hcom = fd_out;
2176 chr->opaque = s;
2177 chr->chr_write = win_chr_write;
2178 return chr;
2181 static CharDriverState *qemu_chr_open_win_con(const char *id,
2182 ChardevBackend *backend,
2183 ChardevReturn *ret,
2184 Error **errp)
2186 ChardevCommon *common = backend->u.console;
2187 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE),
2188 common, errp);
2191 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2193 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2194 DWORD dwSize;
2195 int len1;
2197 len1 = len;
2199 while (len1 > 0) {
2200 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2201 break;
2203 buf += dwSize;
2204 len1 -= dwSize;
2207 return len - len1;
2210 static void win_stdio_wait_func(void *opaque)
2212 CharDriverState *chr = opaque;
2213 WinStdioCharState *stdio = chr->opaque;
2214 INPUT_RECORD buf[4];
2215 int ret;
2216 DWORD dwSize;
2217 int i;
2219 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2221 if (!ret) {
2222 /* Avoid error storm */
2223 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2224 return;
2227 for (i = 0; i < dwSize; i++) {
2228 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2230 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2231 int j;
2232 if (kev->uChar.AsciiChar != 0) {
2233 for (j = 0; j < kev->wRepeatCount; j++) {
2234 if (qemu_chr_be_can_write(chr)) {
2235 uint8_t c = kev->uChar.AsciiChar;
2236 qemu_chr_be_write(chr, &c, 1);
2244 static DWORD WINAPI win_stdio_thread(LPVOID param)
2246 CharDriverState *chr = param;
2247 WinStdioCharState *stdio = chr->opaque;
2248 int ret;
2249 DWORD dwSize;
2251 while (1) {
2253 /* Wait for one byte */
2254 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2256 /* Exit in case of error, continue if nothing read */
2257 if (!ret) {
2258 break;
2260 if (!dwSize) {
2261 continue;
2264 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2265 if (stdio->win_stdio_buf == '\r') {
2266 continue;
2269 /* Signal the main thread and wait until the byte was eaten */
2270 if (!SetEvent(stdio->hInputReadyEvent)) {
2271 break;
2273 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2274 != WAIT_OBJECT_0) {
2275 break;
2279 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2280 return 0;
2283 static void win_stdio_thread_wait_func(void *opaque)
2285 CharDriverState *chr = opaque;
2286 WinStdioCharState *stdio = chr->opaque;
2288 if (qemu_chr_be_can_write(chr)) {
2289 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2292 SetEvent(stdio->hInputDoneEvent);
2295 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2297 WinStdioCharState *stdio = chr->opaque;
2298 DWORD dwMode = 0;
2300 GetConsoleMode(stdio->hStdIn, &dwMode);
2302 if (echo) {
2303 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2304 } else {
2305 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2309 static void win_stdio_close(CharDriverState *chr)
2311 WinStdioCharState *stdio = chr->opaque;
2313 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2314 CloseHandle(stdio->hInputReadyEvent);
2316 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2317 CloseHandle(stdio->hInputDoneEvent);
2319 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2320 TerminateThread(stdio->hInputThread, 0);
2323 g_free(chr->opaque);
2324 g_free(chr);
2327 static CharDriverState *qemu_chr_open_stdio(const char *id,
2328 ChardevBackend *backend,
2329 ChardevReturn *ret,
2330 Error **errp)
2332 CharDriverState *chr;
2333 WinStdioCharState *stdio;
2334 DWORD dwMode;
2335 int is_console = 0;
2336 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio);
2338 chr = qemu_chr_alloc(common, errp);
2339 if (!chr) {
2340 return NULL;
2342 stdio = g_new0(WinStdioCharState, 1);
2344 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2345 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2346 error_setg(errp, "cannot open stdio: invalid handle");
2347 return NULL;
2350 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2352 chr->opaque = stdio;
2353 chr->chr_write = win_stdio_write;
2354 chr->chr_close = win_stdio_close;
2356 if (is_console) {
2357 if (qemu_add_wait_object(stdio->hStdIn,
2358 win_stdio_wait_func, chr)) {
2359 error_setg(errp, "qemu_add_wait_object: failed");
2360 goto err1;
2362 } else {
2363 DWORD dwId;
2365 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2366 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2367 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2368 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2369 error_setg(errp, "cannot create event");
2370 goto err2;
2372 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2373 win_stdio_thread_wait_func, chr)) {
2374 error_setg(errp, "qemu_add_wait_object: failed");
2375 goto err2;
2377 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2378 chr, 0, &dwId);
2380 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2381 error_setg(errp, "cannot create stdio thread");
2382 goto err3;
2386 dwMode |= ENABLE_LINE_INPUT;
2388 if (is_console) {
2389 /* set the terminal in raw mode */
2390 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2391 dwMode |= ENABLE_PROCESSED_INPUT;
2394 SetConsoleMode(stdio->hStdIn, dwMode);
2396 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2397 qemu_chr_fe_set_echo(chr, false);
2399 return chr;
2401 err3:
2402 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2403 err2:
2404 CloseHandle(stdio->hInputReadyEvent);
2405 CloseHandle(stdio->hInputDoneEvent);
2406 err1:
2407 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2408 return NULL;
2410 #endif /* !_WIN32 */
2413 /***********************************************************/
2414 /* UDP Net console */
2416 typedef struct {
2417 QIOChannel *ioc;
2418 uint8_t buf[READ_BUF_LEN];
2419 int bufcnt;
2420 int bufptr;
2421 int max_size;
2422 } NetCharDriver;
2424 /* Called with chr_write_lock held. */
2425 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2427 NetCharDriver *s = chr->opaque;
2429 return qio_channel_write(
2430 s->ioc, (const char *)buf, len, NULL);
2433 static int udp_chr_read_poll(void *opaque)
2435 CharDriverState *chr = opaque;
2436 NetCharDriver *s = chr->opaque;
2438 s->max_size = qemu_chr_be_can_write(chr);
2440 /* If there were any stray characters in the queue process them
2441 * first
2443 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2444 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2445 s->bufptr++;
2446 s->max_size = qemu_chr_be_can_write(chr);
2448 return s->max_size;
2451 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2453 CharDriverState *chr = opaque;
2454 NetCharDriver *s = chr->opaque;
2455 ssize_t ret;
2457 if (s->max_size == 0) {
2458 return TRUE;
2460 ret = qio_channel_read(
2461 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2462 if (ret <= 0) {
2463 remove_fd_in_watch(chr);
2464 return FALSE;
2466 s->bufcnt = ret;
2468 s->bufptr = 0;
2469 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2470 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2471 s->bufptr++;
2472 s->max_size = qemu_chr_be_can_write(chr);
2475 return TRUE;
2478 static void udp_chr_update_read_handler(CharDriverState *chr)
2480 NetCharDriver *s = chr->opaque;
2482 remove_fd_in_watch(chr);
2483 if (s->ioc) {
2484 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2485 udp_chr_read_poll,
2486 udp_chr_read, chr);
2490 static void udp_chr_close(CharDriverState *chr)
2492 NetCharDriver *s = chr->opaque;
2494 remove_fd_in_watch(chr);
2495 if (s->ioc) {
2496 object_unref(OBJECT(s->ioc));
2498 g_free(s);
2499 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2502 static CharDriverState *qemu_chr_open_udp(QIOChannelSocket *sioc,
2503 ChardevCommon *backend,
2504 Error **errp)
2506 CharDriverState *chr = NULL;
2507 NetCharDriver *s = NULL;
2509 chr = qemu_chr_alloc(backend, errp);
2510 if (!chr) {
2511 return NULL;
2513 s = g_new0(NetCharDriver, 1);
2515 s->ioc = QIO_CHANNEL(sioc);
2516 s->bufcnt = 0;
2517 s->bufptr = 0;
2518 chr->opaque = s;
2519 chr->chr_write = udp_chr_write;
2520 chr->chr_update_read_handler = udp_chr_update_read_handler;
2521 chr->chr_close = udp_chr_close;
2522 /* be isn't opened until we get a connection */
2523 chr->explicit_be_open = true;
2524 return chr;
2527 /***********************************************************/
2528 /* TCP Net console */
2530 typedef struct {
2531 QIOChannel *ioc; /* Client I/O channel */
2532 QIOChannelSocket *sioc; /* Client master channel */
2533 QIOChannelSocket *listen_ioc;
2534 guint listen_tag;
2535 QCryptoTLSCreds *tls_creds;
2536 int connected;
2537 int max_size;
2538 int do_telnetopt;
2539 int do_nodelay;
2540 int is_unix;
2541 int *read_msgfds;
2542 size_t read_msgfds_num;
2543 int *write_msgfds;
2544 size_t write_msgfds_num;
2546 SocketAddress *addr;
2547 bool is_listen;
2548 bool is_telnet;
2550 guint reconnect_timer;
2551 int64_t reconnect_time;
2552 bool connect_err_reported;
2553 } TCPCharDriver;
2555 static gboolean socket_reconnect_timeout(gpointer opaque);
2557 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2559 TCPCharDriver *s = chr->opaque;
2560 assert(s->connected == 0);
2561 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2562 socket_reconnect_timeout, chr);
2565 static void check_report_connect_error(CharDriverState *chr,
2566 Error *err)
2568 TCPCharDriver *s = chr->opaque;
2570 if (!s->connect_err_reported) {
2571 error_report("Unable to connect character device %s: %s",
2572 chr->label, error_get_pretty(err));
2573 s->connect_err_reported = true;
2575 qemu_chr_socket_restart_timer(chr);
2578 static gboolean tcp_chr_accept(QIOChannel *chan,
2579 GIOCondition cond,
2580 void *opaque);
2582 /* Called with chr_write_lock held. */
2583 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2585 TCPCharDriver *s = chr->opaque;
2586 if (s->connected) {
2587 int ret = io_channel_send_full(s->ioc, buf, len,
2588 s->write_msgfds,
2589 s->write_msgfds_num);
2591 /* free the written msgfds, no matter what */
2592 if (s->write_msgfds_num) {
2593 g_free(s->write_msgfds);
2594 s->write_msgfds = 0;
2595 s->write_msgfds_num = 0;
2598 return ret;
2599 } else {
2600 /* XXX: indicate an error ? */
2601 return len;
2605 static int tcp_chr_read_poll(void *opaque)
2607 CharDriverState *chr = opaque;
2608 TCPCharDriver *s = chr->opaque;
2609 if (!s->connected)
2610 return 0;
2611 s->max_size = qemu_chr_be_can_write(chr);
2612 return s->max_size;
2615 #define IAC 255
2616 #define IAC_BREAK 243
2617 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2618 TCPCharDriver *s,
2619 uint8_t *buf, int *size)
2621 /* Handle any telnet client's basic IAC options to satisfy char by
2622 * char mode with no echo. All IAC options will be removed from
2623 * the buf and the do_telnetopt variable will be used to track the
2624 * state of the width of the IAC information.
2626 * IAC commands come in sets of 3 bytes with the exception of the
2627 * "IAC BREAK" command and the double IAC.
2630 int i;
2631 int j = 0;
2633 for (i = 0; i < *size; i++) {
2634 if (s->do_telnetopt > 1) {
2635 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2636 /* Double IAC means send an IAC */
2637 if (j != i)
2638 buf[j] = buf[i];
2639 j++;
2640 s->do_telnetopt = 1;
2641 } else {
2642 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2643 /* Handle IAC break commands by sending a serial break */
2644 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2645 s->do_telnetopt++;
2647 s->do_telnetopt++;
2649 if (s->do_telnetopt >= 4) {
2650 s->do_telnetopt = 1;
2652 } else {
2653 if ((unsigned char)buf[i] == IAC) {
2654 s->do_telnetopt = 2;
2655 } else {
2656 if (j != i)
2657 buf[j] = buf[i];
2658 j++;
2662 *size = j;
2665 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2667 TCPCharDriver *s = chr->opaque;
2668 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2670 assert(num <= TCP_MAX_FDS);
2672 if (to_copy) {
2673 int i;
2675 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2677 /* Close unused fds */
2678 for (i = to_copy; i < s->read_msgfds_num; i++) {
2679 close(s->read_msgfds[i]);
2682 g_free(s->read_msgfds);
2683 s->read_msgfds = 0;
2684 s->read_msgfds_num = 0;
2687 return to_copy;
2690 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2692 TCPCharDriver *s = chr->opaque;
2694 if (!qio_channel_has_feature(s->ioc,
2695 QIO_CHANNEL_FEATURE_FD_PASS)) {
2696 return -1;
2698 /* clear old pending fd array */
2699 g_free(s->write_msgfds);
2701 if (num) {
2702 s->write_msgfds = g_new(int, num);
2703 memcpy(s->write_msgfds, fds, num * sizeof(int));
2706 s->write_msgfds_num = num;
2708 return 0;
2711 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2713 TCPCharDriver *s = chr->opaque;
2714 struct iovec iov = { .iov_base = buf, .iov_len = len };
2715 int ret;
2716 size_t i;
2717 int *msgfds = NULL;
2718 size_t msgfds_num = 0;
2720 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2721 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2722 &msgfds, &msgfds_num,
2723 NULL);
2724 } else {
2725 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2726 NULL, NULL,
2727 NULL);
2730 if (msgfds_num) {
2731 /* close and clean read_msgfds */
2732 for (i = 0; i < s->read_msgfds_num; i++) {
2733 close(s->read_msgfds[i]);
2736 if (s->read_msgfds_num) {
2737 g_free(s->read_msgfds);
2740 s->read_msgfds = msgfds;
2741 s->read_msgfds_num = msgfds_num;
2744 for (i = 0; i < s->read_msgfds_num; i++) {
2745 int fd = s->read_msgfds[i];
2746 if (fd < 0) {
2747 continue;
2750 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2751 qemu_set_block(fd);
2753 #ifndef MSG_CMSG_CLOEXEC
2754 qemu_set_cloexec(fd);
2755 #endif
2758 return ret;
2761 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2763 TCPCharDriver *s = chr->opaque;
2764 return qio_channel_create_watch(s->ioc, cond);
2767 static void tcp_chr_disconnect(CharDriverState *chr)
2769 TCPCharDriver *s = chr->opaque;
2771 s->connected = 0;
2772 if (s->listen_ioc) {
2773 s->listen_tag = qio_channel_add_watch(
2774 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
2776 remove_fd_in_watch(chr);
2777 object_unref(OBJECT(s->sioc));
2778 s->sioc = NULL;
2779 object_unref(OBJECT(s->ioc));
2780 s->ioc = NULL;
2781 g_free(chr->filename);
2782 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
2783 s->is_listen, s->is_telnet);
2784 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2785 if (s->reconnect_time) {
2786 qemu_chr_socket_restart_timer(chr);
2790 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2792 CharDriverState *chr = opaque;
2793 TCPCharDriver *s = chr->opaque;
2794 uint8_t buf[READ_BUF_LEN];
2795 int len, size;
2797 if (!s->connected || s->max_size <= 0) {
2798 return TRUE;
2800 len = sizeof(buf);
2801 if (len > s->max_size)
2802 len = s->max_size;
2803 size = tcp_chr_recv(chr, (void *)buf, len);
2804 if (size == 0 || size == -1) {
2805 /* connection closed */
2806 tcp_chr_disconnect(chr);
2807 } else if (size > 0) {
2808 if (s->do_telnetopt)
2809 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
2810 if (size > 0)
2811 qemu_chr_be_write(chr, buf, size);
2814 return TRUE;
2817 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
2819 TCPCharDriver *s = chr->opaque;
2820 int size;
2822 if (!s->connected) {
2823 return 0;
2826 size = tcp_chr_recv(chr, (void *) buf, len);
2827 if (size == 0) {
2828 /* connection closed */
2829 tcp_chr_disconnect(chr);
2832 return size;
2835 static void tcp_chr_connect(void *opaque)
2837 CharDriverState *chr = opaque;
2838 TCPCharDriver *s = chr->opaque;
2840 g_free(chr->filename);
2841 chr->filename = sockaddr_to_str(
2842 &s->sioc->localAddr, s->sioc->localAddrLen,
2843 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
2844 s->is_listen, s->is_telnet);
2846 s->connected = 1;
2847 if (s->ioc) {
2848 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2849 tcp_chr_read_poll,
2850 tcp_chr_read, chr);
2852 qemu_chr_be_generic_open(chr);
2855 static void tcp_chr_update_read_handler(CharDriverState *chr)
2857 TCPCharDriver *s = chr->opaque;
2859 if (!s->connected) {
2860 return;
2863 remove_fd_in_watch(chr);
2864 if (s->ioc) {
2865 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2866 tcp_chr_read_poll,
2867 tcp_chr_read, chr);
2871 typedef struct {
2872 CharDriverState *chr;
2873 char buf[12];
2874 size_t buflen;
2875 } TCPCharDriverTelnetInit;
2877 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
2878 GIOCondition cond G_GNUC_UNUSED,
2879 gpointer user_data)
2881 TCPCharDriverTelnetInit *init = user_data;
2882 ssize_t ret;
2884 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
2885 if (ret < 0) {
2886 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2887 ret = 0;
2888 } else {
2889 tcp_chr_disconnect(init->chr);
2890 return FALSE;
2893 init->buflen -= ret;
2895 if (init->buflen == 0) {
2896 tcp_chr_connect(init->chr);
2897 return FALSE;
2900 memmove(init->buf, init->buf + ret, init->buflen);
2902 return TRUE;
2905 static void tcp_chr_telnet_init(CharDriverState *chr)
2907 TCPCharDriver *s = chr->opaque;
2908 TCPCharDriverTelnetInit *init =
2909 g_new0(TCPCharDriverTelnetInit, 1);
2910 size_t n = 0;
2912 init->chr = chr;
2913 init->buflen = 12;
2915 #define IACSET(x, a, b, c) \
2916 do { \
2917 x[n++] = a; \
2918 x[n++] = b; \
2919 x[n++] = c; \
2920 } while (0)
2922 /* Prep the telnet negotion to put telnet in binary,
2923 * no echo, single char mode */
2924 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
2925 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
2926 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
2927 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
2929 #undef IACSET
2931 qio_channel_add_watch(
2932 s->ioc, G_IO_OUT,
2933 tcp_chr_telnet_init_io,
2934 init, NULL);
2938 static void tcp_chr_tls_handshake(Object *source,
2939 Error *err,
2940 gpointer user_data)
2942 CharDriverState *chr = user_data;
2943 TCPCharDriver *s = chr->opaque;
2945 if (err) {
2946 tcp_chr_disconnect(chr);
2947 } else {
2948 if (s->do_telnetopt) {
2949 tcp_chr_telnet_init(chr);
2950 } else {
2951 tcp_chr_connect(chr);
2957 static void tcp_chr_tls_init(CharDriverState *chr)
2959 TCPCharDriver *s = chr->opaque;
2960 QIOChannelTLS *tioc;
2961 Error *err = NULL;
2963 if (s->is_listen) {
2964 tioc = qio_channel_tls_new_server(
2965 s->ioc, s->tls_creds,
2966 NULL, /* XXX Use an ACL */
2967 &err);
2968 } else {
2969 tioc = qio_channel_tls_new_client(
2970 s->ioc, s->tls_creds,
2971 s->addr->u.inet->host,
2972 &err);
2974 if (tioc == NULL) {
2975 error_free(err);
2976 tcp_chr_disconnect(chr);
2978 object_unref(OBJECT(s->ioc));
2979 s->ioc = QIO_CHANNEL(tioc);
2981 qio_channel_tls_handshake(tioc,
2982 tcp_chr_tls_handshake,
2983 chr,
2984 NULL);
2988 static int tcp_chr_new_client(CharDriverState *chr, QIOChannelSocket *sioc)
2990 TCPCharDriver *s = chr->opaque;
2991 if (s->ioc != NULL) {
2992 return -1;
2995 s->ioc = QIO_CHANNEL(sioc);
2996 object_ref(OBJECT(sioc));
2997 s->sioc = sioc;
2998 object_ref(OBJECT(sioc));
3000 if (s->do_nodelay) {
3001 qio_channel_set_delay(s->ioc, false);
3003 if (s->listen_tag) {
3004 g_source_remove(s->listen_tag);
3005 s->listen_tag = 0;
3008 if (s->tls_creds) {
3009 tcp_chr_tls_init(chr);
3010 } else {
3011 if (s->do_telnetopt) {
3012 tcp_chr_telnet_init(chr);
3013 } else {
3014 tcp_chr_connect(chr);
3018 return 0;
3022 static int tcp_chr_add_client(CharDriverState *chr, int fd)
3024 int ret;
3025 QIOChannelSocket *sioc;
3027 sioc = qio_channel_socket_new_fd(fd, NULL);
3028 if (!sioc) {
3029 return -1;
3031 qio_channel_set_blocking(QIO_CHANNEL(sioc), false, NULL);
3032 ret = tcp_chr_new_client(chr, sioc);
3033 object_unref(OBJECT(sioc));
3034 return ret;
3037 static gboolean tcp_chr_accept(QIOChannel *channel,
3038 GIOCondition cond,
3039 void *opaque)
3041 CharDriverState *chr = opaque;
3042 QIOChannelSocket *sioc;
3044 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3045 NULL);
3046 if (!sioc) {
3047 return TRUE;
3050 tcp_chr_new_client(chr, sioc);
3052 object_unref(OBJECT(sioc));
3054 return TRUE;
3057 static void tcp_chr_close(CharDriverState *chr)
3059 TCPCharDriver *s = chr->opaque;
3060 int i;
3062 if (s->reconnect_timer) {
3063 g_source_remove(s->reconnect_timer);
3064 s->reconnect_timer = 0;
3066 qapi_free_SocketAddress(s->addr);
3067 remove_fd_in_watch(chr);
3068 if (s->ioc) {
3069 object_unref(OBJECT(s->ioc));
3071 if (s->listen_tag) {
3072 g_source_remove(s->listen_tag);
3073 s->listen_tag = 0;
3075 if (s->listen_ioc) {
3076 object_unref(OBJECT(s->listen_ioc));
3078 if (s->read_msgfds_num) {
3079 for (i = 0; i < s->read_msgfds_num; i++) {
3080 close(s->read_msgfds[i]);
3082 g_free(s->read_msgfds);
3084 if (s->tls_creds) {
3085 object_unref(OBJECT(s->tls_creds));
3087 if (s->write_msgfds_num) {
3088 g_free(s->write_msgfds);
3090 g_free(s);
3091 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3095 static void qemu_chr_socket_connected(Object *src, Error *err, void *opaque)
3097 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(src);
3098 CharDriverState *chr = opaque;
3099 TCPCharDriver *s = chr->opaque;
3101 if (err) {
3102 check_report_connect_error(chr, err);
3103 object_unref(src);
3104 return;
3107 s->connect_err_reported = false;
3108 tcp_chr_new_client(chr, sioc);
3109 object_unref(OBJECT(sioc));
3113 /*********************************************************/
3114 /* Ring buffer chardev */
3116 typedef struct {
3117 size_t size;
3118 size_t prod;
3119 size_t cons;
3120 uint8_t *cbuf;
3121 } RingBufCharDriver;
3123 static size_t ringbuf_count(const CharDriverState *chr)
3125 const RingBufCharDriver *d = chr->opaque;
3127 return d->prod - d->cons;
3130 /* Called with chr_write_lock held. */
3131 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3133 RingBufCharDriver *d = chr->opaque;
3134 int i;
3136 if (!buf || (len < 0)) {
3137 return -1;
3140 for (i = 0; i < len; i++ ) {
3141 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3142 if (d->prod - d->cons > d->size) {
3143 d->cons = d->prod - d->size;
3147 return 0;
3150 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3152 RingBufCharDriver *d = chr->opaque;
3153 int i;
3155 qemu_mutex_lock(&chr->chr_write_lock);
3156 for (i = 0; i < len && d->cons != d->prod; i++) {
3157 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3159 qemu_mutex_unlock(&chr->chr_write_lock);
3161 return i;
3164 static void ringbuf_chr_close(struct CharDriverState *chr)
3166 RingBufCharDriver *d = chr->opaque;
3168 g_free(d->cbuf);
3169 g_free(d);
3170 chr->opaque = NULL;
3173 static CharDriverState *qemu_chr_open_ringbuf(const char *id,
3174 ChardevBackend *backend,
3175 ChardevReturn *ret,
3176 Error **errp)
3178 ChardevRingbuf *opts = backend->u.ringbuf;
3179 ChardevCommon *common = qapi_ChardevRingbuf_base(opts);
3180 CharDriverState *chr;
3181 RingBufCharDriver *d;
3183 chr = qemu_chr_alloc(common, errp);
3184 if (!chr) {
3185 return NULL;
3187 d = g_malloc(sizeof(*d));
3189 d->size = opts->has_size ? opts->size : 65536;
3191 /* The size must be power of 2 */
3192 if (d->size & (d->size - 1)) {
3193 error_setg(errp, "size of ringbuf chardev must be power of two");
3194 goto fail;
3197 d->prod = 0;
3198 d->cons = 0;
3199 d->cbuf = g_malloc0(d->size);
3201 chr->opaque = d;
3202 chr->chr_write = ringbuf_chr_write;
3203 chr->chr_close = ringbuf_chr_close;
3205 return chr;
3207 fail:
3208 g_free(d);
3209 qemu_chr_free_common(chr);
3210 return NULL;
3213 bool chr_is_ringbuf(const CharDriverState *chr)
3215 return chr->chr_write == ringbuf_chr_write;
3218 void qmp_ringbuf_write(const char *device, const char *data,
3219 bool has_format, enum DataFormat format,
3220 Error **errp)
3222 CharDriverState *chr;
3223 const uint8_t *write_data;
3224 int ret;
3225 gsize write_count;
3227 chr = qemu_chr_find(device);
3228 if (!chr) {
3229 error_setg(errp, "Device '%s' not found", device);
3230 return;
3233 if (!chr_is_ringbuf(chr)) {
3234 error_setg(errp,"%s is not a ringbuf device", device);
3235 return;
3238 if (has_format && (format == DATA_FORMAT_BASE64)) {
3239 write_data = qbase64_decode(data, -1,
3240 &write_count,
3241 errp);
3242 if (!write_data) {
3243 return;
3245 } else {
3246 write_data = (uint8_t *)data;
3247 write_count = strlen(data);
3250 ret = ringbuf_chr_write(chr, write_data, write_count);
3252 if (write_data != (uint8_t *)data) {
3253 g_free((void *)write_data);
3256 if (ret < 0) {
3257 error_setg(errp, "Failed to write to device %s", device);
3258 return;
3262 char *qmp_ringbuf_read(const char *device, int64_t size,
3263 bool has_format, enum DataFormat format,
3264 Error **errp)
3266 CharDriverState *chr;
3267 uint8_t *read_data;
3268 size_t count;
3269 char *data;
3271 chr = qemu_chr_find(device);
3272 if (!chr) {
3273 error_setg(errp, "Device '%s' not found", device);
3274 return NULL;
3277 if (!chr_is_ringbuf(chr)) {
3278 error_setg(errp,"%s is not a ringbuf device", device);
3279 return NULL;
3282 if (size <= 0) {
3283 error_setg(errp, "size must be greater than zero");
3284 return NULL;
3287 count = ringbuf_count(chr);
3288 size = size > count ? count : size;
3289 read_data = g_malloc(size + 1);
3291 ringbuf_chr_read(chr, read_data, size);
3293 if (has_format && (format == DATA_FORMAT_BASE64)) {
3294 data = g_base64_encode(read_data, size);
3295 g_free(read_data);
3296 } else {
3298 * FIXME should read only complete, valid UTF-8 characters up
3299 * to @size bytes. Invalid sequences should be replaced by a
3300 * suitable replacement character. Except when (and only
3301 * when) ring buffer lost characters since last read, initial
3302 * continuation characters should be dropped.
3304 read_data[size] = 0;
3305 data = (char *)read_data;
3308 return data;
3311 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3313 char host[65], port[33], width[8], height[8];
3314 int pos;
3315 const char *p;
3316 QemuOpts *opts;
3317 Error *local_err = NULL;
3319 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3320 if (local_err) {
3321 error_report_err(local_err);
3322 return NULL;
3325 if (strstart(filename, "mon:", &p)) {
3326 filename = p;
3327 qemu_opt_set(opts, "mux", "on", &error_abort);
3328 if (strcmp(filename, "stdio") == 0) {
3329 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3330 * but pass it to the guest. Handle this only for compat syntax,
3331 * for -chardev syntax we have special option for this.
3332 * This is what -nographic did, redirecting+muxing serial+monitor
3333 * to stdio causing Ctrl+C to be passed to guest. */
3334 qemu_opt_set(opts, "signal", "off", &error_abort);
3338 if (strcmp(filename, "null") == 0 ||
3339 strcmp(filename, "pty") == 0 ||
3340 strcmp(filename, "msmouse") == 0 ||
3341 strcmp(filename, "braille") == 0 ||
3342 strcmp(filename, "testdev") == 0 ||
3343 strcmp(filename, "stdio") == 0) {
3344 qemu_opt_set(opts, "backend", filename, &error_abort);
3345 return opts;
3347 if (strstart(filename, "vc", &p)) {
3348 qemu_opt_set(opts, "backend", "vc", &error_abort);
3349 if (*p == ':') {
3350 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3351 /* pixels */
3352 qemu_opt_set(opts, "width", width, &error_abort);
3353 qemu_opt_set(opts, "height", height, &error_abort);
3354 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3355 /* chars */
3356 qemu_opt_set(opts, "cols", width, &error_abort);
3357 qemu_opt_set(opts, "rows", height, &error_abort);
3358 } else {
3359 goto fail;
3362 return opts;
3364 if (strcmp(filename, "con:") == 0) {
3365 qemu_opt_set(opts, "backend", "console", &error_abort);
3366 return opts;
3368 if (strstart(filename, "COM", NULL)) {
3369 qemu_opt_set(opts, "backend", "serial", &error_abort);
3370 qemu_opt_set(opts, "path", filename, &error_abort);
3371 return opts;
3373 if (strstart(filename, "file:", &p)) {
3374 qemu_opt_set(opts, "backend", "file", &error_abort);
3375 qemu_opt_set(opts, "path", p, &error_abort);
3376 return opts;
3378 if (strstart(filename, "pipe:", &p)) {
3379 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3380 qemu_opt_set(opts, "path", p, &error_abort);
3381 return opts;
3383 if (strstart(filename, "tcp:", &p) ||
3384 strstart(filename, "telnet:", &p)) {
3385 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3386 host[0] = 0;
3387 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3388 goto fail;
3390 qemu_opt_set(opts, "backend", "socket", &error_abort);
3391 qemu_opt_set(opts, "host", host, &error_abort);
3392 qemu_opt_set(opts, "port", port, &error_abort);
3393 if (p[pos] == ',') {
3394 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3395 if (local_err) {
3396 error_report_err(local_err);
3397 goto fail;
3400 if (strstart(filename, "telnet:", &p))
3401 qemu_opt_set(opts, "telnet", "on", &error_abort);
3402 return opts;
3404 if (strstart(filename, "udp:", &p)) {
3405 qemu_opt_set(opts, "backend", "udp", &error_abort);
3406 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3407 host[0] = 0;
3408 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3409 goto fail;
3412 qemu_opt_set(opts, "host", host, &error_abort);
3413 qemu_opt_set(opts, "port", port, &error_abort);
3414 if (p[pos] == '@') {
3415 p += pos + 1;
3416 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3417 host[0] = 0;
3418 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3419 goto fail;
3422 qemu_opt_set(opts, "localaddr", host, &error_abort);
3423 qemu_opt_set(opts, "localport", port, &error_abort);
3425 return opts;
3427 if (strstart(filename, "unix:", &p)) {
3428 qemu_opt_set(opts, "backend", "socket", &error_abort);
3429 qemu_opts_do_parse(opts, p, "path", &local_err);
3430 if (local_err) {
3431 error_report_err(local_err);
3432 goto fail;
3434 return opts;
3436 if (strstart(filename, "/dev/parport", NULL) ||
3437 strstart(filename, "/dev/ppi", NULL)) {
3438 qemu_opt_set(opts, "backend", "parport", &error_abort);
3439 qemu_opt_set(opts, "path", filename, &error_abort);
3440 return opts;
3442 if (strstart(filename, "/dev/", NULL)) {
3443 qemu_opt_set(opts, "backend", "tty", &error_abort);
3444 qemu_opt_set(opts, "path", filename, &error_abort);
3445 return opts;
3448 fail:
3449 qemu_opts_del(opts);
3450 return NULL;
3453 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3455 const char *logfile = qemu_opt_get(opts, "logfile");
3457 backend->has_logfile = logfile != NULL;
3458 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3460 backend->has_logappend = true;
3461 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3465 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3466 Error **errp)
3468 const char *path = qemu_opt_get(opts, "path");
3469 ChardevFile *file;
3471 if (path == NULL) {
3472 error_setg(errp, "chardev: file: no filename given");
3473 return;
3475 file = backend->u.file = g_new0(ChardevFile, 1);
3476 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3477 file->out = g_strdup(path);
3479 file->has_append = true;
3480 file->append = qemu_opt_get_bool(opts, "append", false);
3483 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3484 Error **errp)
3486 ChardevStdio *stdio;
3488 stdio = backend->u.stdio = g_new0(ChardevStdio, 1);
3489 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3490 stdio->has_signal = true;
3491 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3494 #ifdef HAVE_CHARDEV_SERIAL
3495 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3496 Error **errp)
3498 const char *device = qemu_opt_get(opts, "path");
3499 ChardevHostdev *serial;
3501 if (device == NULL) {
3502 error_setg(errp, "chardev: serial/tty: no device path given");
3503 return;
3505 serial = backend->u.serial = g_new0(ChardevHostdev, 1);
3506 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3507 serial->device = g_strdup(device);
3509 #endif
3511 #ifdef HAVE_CHARDEV_PARPORT
3512 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3513 Error **errp)
3515 const char *device = qemu_opt_get(opts, "path");
3516 ChardevHostdev *parallel;
3518 if (device == NULL) {
3519 error_setg(errp, "chardev: parallel: no device path given");
3520 return;
3522 parallel = backend->u.parallel = g_new0(ChardevHostdev, 1);
3523 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3524 parallel->device = g_strdup(device);
3526 #endif
3528 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3529 Error **errp)
3531 const char *device = qemu_opt_get(opts, "path");
3532 ChardevHostdev *dev;
3534 if (device == NULL) {
3535 error_setg(errp, "chardev: pipe: no device path given");
3536 return;
3538 dev = backend->u.pipe = g_new0(ChardevHostdev, 1);
3539 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3540 dev->device = g_strdup(device);
3543 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3544 Error **errp)
3546 int val;
3547 ChardevRingbuf *ringbuf;
3549 ringbuf = backend->u.ringbuf = g_new0(ChardevRingbuf, 1);
3550 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3552 val = qemu_opt_get_size(opts, "size", 0);
3553 if (val != 0) {
3554 ringbuf->has_size = true;
3555 ringbuf->size = val;
3559 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3560 Error **errp)
3562 const char *chardev = qemu_opt_get(opts, "chardev");
3563 ChardevMux *mux;
3565 if (chardev == NULL) {
3566 error_setg(errp, "chardev: mux: no chardev given");
3567 return;
3569 mux = backend->u.mux = g_new0(ChardevMux, 1);
3570 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
3571 mux->chardev = g_strdup(chardev);
3574 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3575 Error **errp)
3577 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3578 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3579 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3580 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3581 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3582 const char *path = qemu_opt_get(opts, "path");
3583 const char *host = qemu_opt_get(opts, "host");
3584 const char *port = qemu_opt_get(opts, "port");
3585 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
3586 SocketAddress *addr;
3587 ChardevSocket *sock;
3589 if (!path) {
3590 if (!host) {
3591 error_setg(errp, "chardev: socket: no host given");
3592 return;
3594 if (!port) {
3595 error_setg(errp, "chardev: socket: no port given");
3596 return;
3598 } else {
3599 if (tls_creds) {
3600 error_setg(errp, "TLS can only be used over TCP socket");
3601 return;
3605 sock = backend->u.socket = g_new0(ChardevSocket, 1);
3606 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
3608 sock->has_nodelay = true;
3609 sock->nodelay = do_nodelay;
3610 sock->has_server = true;
3611 sock->server = is_listen;
3612 sock->has_telnet = true;
3613 sock->telnet = is_telnet;
3614 sock->has_wait = true;
3615 sock->wait = is_waitconnect;
3616 sock->has_reconnect = true;
3617 sock->reconnect = reconnect;
3618 sock->tls_creds = g_strdup(tls_creds);
3620 addr = g_new0(SocketAddress, 1);
3621 if (path) {
3622 UnixSocketAddress *q_unix;
3623 addr->type = SOCKET_ADDRESS_KIND_UNIX;
3624 q_unix = addr->u.q_unix = g_new0(UnixSocketAddress, 1);
3625 q_unix->path = g_strdup(path);
3626 } else {
3627 addr->type = SOCKET_ADDRESS_KIND_INET;
3628 addr->u.inet = g_new(InetSocketAddress, 1);
3629 *addr->u.inet = (InetSocketAddress) {
3630 .host = g_strdup(host),
3631 .port = g_strdup(port),
3632 .has_to = qemu_opt_get(opts, "to"),
3633 .to = qemu_opt_get_number(opts, "to", 0),
3634 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3635 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3636 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3637 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3640 sock->addr = addr;
3643 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3644 Error **errp)
3646 const char *host = qemu_opt_get(opts, "host");
3647 const char *port = qemu_opt_get(opts, "port");
3648 const char *localaddr = qemu_opt_get(opts, "localaddr");
3649 const char *localport = qemu_opt_get(opts, "localport");
3650 bool has_local = false;
3651 SocketAddress *addr;
3652 ChardevUdp *udp;
3654 if (host == NULL || strlen(host) == 0) {
3655 host = "localhost";
3657 if (port == NULL || strlen(port) == 0) {
3658 error_setg(errp, "chardev: udp: remote port not specified");
3659 return;
3661 if (localport == NULL || strlen(localport) == 0) {
3662 localport = "0";
3663 } else {
3664 has_local = true;
3666 if (localaddr == NULL || strlen(localaddr) == 0) {
3667 localaddr = "";
3668 } else {
3669 has_local = true;
3672 udp = backend->u.udp = g_new0(ChardevUdp, 1);
3673 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
3675 addr = g_new0(SocketAddress, 1);
3676 addr->type = SOCKET_ADDRESS_KIND_INET;
3677 addr->u.inet = g_new(InetSocketAddress, 1);
3678 *addr->u.inet = (InetSocketAddress) {
3679 .host = g_strdup(host),
3680 .port = g_strdup(port),
3681 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3682 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3683 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3684 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3686 udp->remote = addr;
3688 if (has_local) {
3689 udp->has_local = true;
3690 addr = g_new0(SocketAddress, 1);
3691 addr->type = SOCKET_ADDRESS_KIND_INET;
3692 addr->u.inet = g_new(InetSocketAddress, 1);
3693 *addr->u.inet = (InetSocketAddress) {
3694 .host = g_strdup(localaddr),
3695 .port = g_strdup(localport),
3697 udp->local = addr;
3701 typedef struct CharDriver {
3702 const char *name;
3703 ChardevBackendKind kind;
3704 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3705 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3706 ChardevReturn *ret, Error **errp);
3707 } CharDriver;
3709 static GSList *backends;
3711 void register_char_driver(const char *name, ChardevBackendKind kind,
3712 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
3713 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3714 ChardevReturn *ret, Error **errp))
3716 CharDriver *s;
3718 s = g_malloc0(sizeof(*s));
3719 s->name = g_strdup(name);
3720 s->kind = kind;
3721 s->parse = parse;
3722 s->create = create;
3724 backends = g_slist_append(backends, s);
3727 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
3728 void (*init)(struct CharDriverState *s),
3729 Error **errp)
3731 Error *local_err = NULL;
3732 CharDriver *cd;
3733 CharDriverState *chr;
3734 GSList *i;
3735 ChardevReturn *ret = NULL;
3736 ChardevBackend *backend;
3737 const char *id = qemu_opts_id(opts);
3738 char *bid = NULL;
3740 if (id == NULL) {
3741 error_setg(errp, "chardev: no id specified");
3742 goto err;
3745 if (qemu_opt_get(opts, "backend") == NULL) {
3746 error_setg(errp, "chardev: \"%s\" missing backend",
3747 qemu_opts_id(opts));
3748 goto err;
3750 for (i = backends; i; i = i->next) {
3751 cd = i->data;
3753 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
3754 break;
3757 if (i == NULL) {
3758 error_setg(errp, "chardev: backend \"%s\" not found",
3759 qemu_opt_get(opts, "backend"));
3760 goto err;
3763 backend = g_new0(ChardevBackend, 1);
3765 if (qemu_opt_get_bool(opts, "mux", 0)) {
3766 bid = g_strdup_printf("%s-base", id);
3769 chr = NULL;
3770 backend->type = cd->kind;
3771 if (cd->parse) {
3772 cd->parse(opts, backend, &local_err);
3773 if (local_err) {
3774 error_propagate(errp, local_err);
3775 goto qapi_out;
3777 } else {
3778 ChardevCommon *cc = g_new0(ChardevCommon, 1);
3779 qemu_chr_parse_common(opts, cc);
3780 backend->u.null = cc; /* Any ChardevCommon member would work */
3783 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
3784 if (!ret) {
3785 goto qapi_out;
3788 if (bid) {
3789 qapi_free_ChardevBackend(backend);
3790 qapi_free_ChardevReturn(ret);
3791 backend = g_new0(ChardevBackend, 1);
3792 backend->u.mux = g_new0(ChardevMux, 1);
3793 backend->type = CHARDEV_BACKEND_KIND_MUX;
3794 backend->u.mux->chardev = g_strdup(bid);
3795 ret = qmp_chardev_add(id, backend, errp);
3796 if (!ret) {
3797 chr = qemu_chr_find(bid);
3798 qemu_chr_delete(chr);
3799 chr = NULL;
3800 goto qapi_out;
3804 chr = qemu_chr_find(id);
3805 chr->opts = opts;
3807 qapi_out:
3808 qapi_free_ChardevBackend(backend);
3809 qapi_free_ChardevReturn(ret);
3810 g_free(bid);
3811 return chr;
3813 err:
3814 qemu_opts_del(opts);
3815 return NULL;
3818 CharDriverState *qemu_chr_new(const char *label, const char *filename, void (*init)(struct CharDriverState *s))
3820 const char *p;
3821 CharDriverState *chr;
3822 QemuOpts *opts;
3823 Error *err = NULL;
3825 if (strstart(filename, "chardev:", &p)) {
3826 return qemu_chr_find(p);
3829 opts = qemu_chr_parse_compat(label, filename);
3830 if (!opts)
3831 return NULL;
3833 chr = qemu_chr_new_from_opts(opts, init, &err);
3834 if (err) {
3835 error_report_err(err);
3837 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
3838 qemu_chr_fe_claim_no_fail(chr);
3839 monitor_init(chr, MONITOR_USE_READLINE);
3841 return chr;
3844 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo)
3846 if (chr->chr_set_echo) {
3847 chr->chr_set_echo(chr, echo);
3851 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open)
3853 if (chr->fe_open == fe_open) {
3854 return;
3856 chr->fe_open = fe_open;
3857 if (chr->chr_set_fe_open) {
3858 chr->chr_set_fe_open(chr, fe_open);
3862 void qemu_chr_fe_event(struct CharDriverState *chr, int event)
3864 if (chr->chr_fe_event) {
3865 chr->chr_fe_event(chr, event);
3869 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
3870 GIOFunc func, void *user_data)
3872 GSource *src;
3873 guint tag;
3875 if (s->chr_add_watch == NULL) {
3876 return -ENOSYS;
3879 src = s->chr_add_watch(s, cond);
3880 if (!src) {
3881 return -EINVAL;
3884 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
3885 tag = g_source_attach(src, NULL);
3886 g_source_unref(src);
3888 return tag;
3891 int qemu_chr_fe_claim(CharDriverState *s)
3893 if (s->avail_connections < 1) {
3894 return -1;
3896 s->avail_connections--;
3897 return 0;
3900 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
3902 if (qemu_chr_fe_claim(s) != 0) {
3903 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
3904 __func__, s->label);
3905 exit(1);
3909 void qemu_chr_fe_release(CharDriverState *s)
3911 s->avail_connections++;
3914 static void qemu_chr_free_common(CharDriverState *chr)
3916 g_free(chr->filename);
3917 g_free(chr->label);
3918 qemu_opts_del(chr->opts);
3919 if (chr->logfd != -1) {
3920 close(chr->logfd);
3922 qemu_mutex_destroy(&chr->chr_write_lock);
3923 g_free(chr);
3926 void qemu_chr_free(CharDriverState *chr)
3928 if (chr->chr_close) {
3929 chr->chr_close(chr);
3931 qemu_chr_free_common(chr);
3934 void qemu_chr_delete(CharDriverState *chr)
3936 QTAILQ_REMOVE(&chardevs, chr, next);
3937 qemu_chr_free(chr);
3940 ChardevInfoList *qmp_query_chardev(Error **errp)
3942 ChardevInfoList *chr_list = NULL;
3943 CharDriverState *chr;
3945 QTAILQ_FOREACH(chr, &chardevs, next) {
3946 ChardevInfoList *info = g_malloc0(sizeof(*info));
3947 info->value = g_malloc0(sizeof(*info->value));
3948 info->value->label = g_strdup(chr->label);
3949 info->value->filename = g_strdup(chr->filename);
3950 info->value->frontend_open = chr->fe_open;
3952 info->next = chr_list;
3953 chr_list = info;
3956 return chr_list;
3959 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
3961 ChardevBackendInfoList *backend_list = NULL;
3962 CharDriver *c = NULL;
3963 GSList *i = NULL;
3965 for (i = backends; i; i = i->next) {
3966 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
3967 c = i->data;
3968 info->value = g_malloc0(sizeof(*info->value));
3969 info->value->name = g_strdup(c->name);
3971 info->next = backend_list;
3972 backend_list = info;
3975 return backend_list;
3978 CharDriverState *qemu_chr_find(const char *name)
3980 CharDriverState *chr;
3982 QTAILQ_FOREACH(chr, &chardevs, next) {
3983 if (strcmp(chr->label, name) != 0)
3984 continue;
3985 return chr;
3987 return NULL;
3990 /* Get a character (serial) device interface. */
3991 CharDriverState *qemu_char_get_next_serial(void)
3993 static int next_serial;
3994 CharDriverState *chr;
3996 /* FIXME: This function needs to go away: use chardev properties! */
3998 while (next_serial < MAX_SERIAL_PORTS && serial_hds[next_serial]) {
3999 chr = serial_hds[next_serial++];
4000 qemu_chr_fe_claim_no_fail(chr);
4001 return chr;
4003 return NULL;
4006 QemuOptsList qemu_chardev_opts = {
4007 .name = "chardev",
4008 .implied_opt_name = "backend",
4009 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4010 .desc = {
4012 .name = "backend",
4013 .type = QEMU_OPT_STRING,
4015 .name = "path",
4016 .type = QEMU_OPT_STRING,
4018 .name = "host",
4019 .type = QEMU_OPT_STRING,
4021 .name = "port",
4022 .type = QEMU_OPT_STRING,
4024 .name = "localaddr",
4025 .type = QEMU_OPT_STRING,
4027 .name = "localport",
4028 .type = QEMU_OPT_STRING,
4030 .name = "to",
4031 .type = QEMU_OPT_NUMBER,
4033 .name = "ipv4",
4034 .type = QEMU_OPT_BOOL,
4036 .name = "ipv6",
4037 .type = QEMU_OPT_BOOL,
4039 .name = "wait",
4040 .type = QEMU_OPT_BOOL,
4042 .name = "server",
4043 .type = QEMU_OPT_BOOL,
4045 .name = "delay",
4046 .type = QEMU_OPT_BOOL,
4048 .name = "reconnect",
4049 .type = QEMU_OPT_NUMBER,
4051 .name = "telnet",
4052 .type = QEMU_OPT_BOOL,
4054 .name = "tls-creds",
4055 .type = QEMU_OPT_STRING,
4057 .name = "width",
4058 .type = QEMU_OPT_NUMBER,
4060 .name = "height",
4061 .type = QEMU_OPT_NUMBER,
4063 .name = "cols",
4064 .type = QEMU_OPT_NUMBER,
4066 .name = "rows",
4067 .type = QEMU_OPT_NUMBER,
4069 .name = "mux",
4070 .type = QEMU_OPT_BOOL,
4072 .name = "signal",
4073 .type = QEMU_OPT_BOOL,
4075 .name = "name",
4076 .type = QEMU_OPT_STRING,
4078 .name = "debug",
4079 .type = QEMU_OPT_NUMBER,
4081 .name = "size",
4082 .type = QEMU_OPT_SIZE,
4084 .name = "chardev",
4085 .type = QEMU_OPT_STRING,
4087 .name = "append",
4088 .type = QEMU_OPT_BOOL,
4090 .name = "logfile",
4091 .type = QEMU_OPT_STRING,
4093 .name = "logappend",
4094 .type = QEMU_OPT_BOOL,
4096 { /* end of list */ }
4100 #ifdef _WIN32
4102 static CharDriverState *qmp_chardev_open_file(const char *id,
4103 ChardevBackend *backend,
4104 ChardevReturn *ret,
4105 Error **errp)
4107 ChardevFile *file = backend->u.file;
4108 ChardevCommon *common = qapi_ChardevFile_base(file);
4109 HANDLE out;
4111 if (file->has_in) {
4112 error_setg(errp, "input file not supported");
4113 return NULL;
4116 out = CreateFile(file->out, GENERIC_WRITE, FILE_SHARE_READ, NULL,
4117 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
4118 if (out == INVALID_HANDLE_VALUE) {
4119 error_setg(errp, "open %s failed", file->out);
4120 return NULL;
4122 return qemu_chr_open_win_file(out, common, errp);
4125 static CharDriverState *qmp_chardev_open_serial(const char *id,
4126 ChardevBackend *backend,
4127 ChardevReturn *ret,
4128 Error **errp)
4130 ChardevHostdev *serial = backend->u.serial;
4131 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4132 return qemu_chr_open_win_path(serial->device, common, errp);
4135 #else /* WIN32 */
4137 static int qmp_chardev_open_file_source(char *src, int flags,
4138 Error **errp)
4140 int fd = -1;
4142 TFR(fd = qemu_open(src, flags, 0666));
4143 if (fd == -1) {
4144 error_setg_file_open(errp, errno, src);
4146 return fd;
4149 static CharDriverState *qmp_chardev_open_file(const char *id,
4150 ChardevBackend *backend,
4151 ChardevReturn *ret,
4152 Error **errp)
4154 ChardevFile *file = backend->u.file;
4155 ChardevCommon *common = qapi_ChardevFile_base(file);
4156 int flags, in = -1, out;
4158 flags = O_WRONLY | O_CREAT | O_BINARY;
4159 if (file->has_append && file->append) {
4160 flags |= O_APPEND;
4161 } else {
4162 flags |= O_TRUNC;
4165 out = qmp_chardev_open_file_source(file->out, flags, errp);
4166 if (out < 0) {
4167 return NULL;
4170 if (file->has_in) {
4171 flags = O_RDONLY;
4172 in = qmp_chardev_open_file_source(file->in, flags, errp);
4173 if (in < 0) {
4174 qemu_close(out);
4175 return NULL;
4179 return qemu_chr_open_fd(in, out, common, errp);
4182 #ifdef HAVE_CHARDEV_SERIAL
4183 static CharDriverState *qmp_chardev_open_serial(const char *id,
4184 ChardevBackend *backend,
4185 ChardevReturn *ret,
4186 Error **errp)
4188 ChardevHostdev *serial = backend->u.serial;
4189 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4190 int fd;
4192 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4193 if (fd < 0) {
4194 return NULL;
4196 qemu_set_nonblock(fd);
4197 return qemu_chr_open_tty_fd(fd, common, errp);
4199 #endif
4201 #ifdef HAVE_CHARDEV_PARPORT
4202 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4203 ChardevBackend *backend,
4204 ChardevReturn *ret,
4205 Error **errp)
4207 ChardevHostdev *parallel = backend->u.parallel;
4208 ChardevCommon *common = qapi_ChardevHostdev_base(parallel);
4209 int fd;
4211 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4212 if (fd < 0) {
4213 return NULL;
4215 return qemu_chr_open_pp_fd(fd, common, errp);
4217 #endif
4219 #endif /* WIN32 */
4221 static gboolean socket_reconnect_timeout(gpointer opaque)
4223 CharDriverState *chr = opaque;
4224 TCPCharDriver *s = chr->opaque;
4225 QIOChannelSocket *sioc;
4227 s->reconnect_timer = 0;
4229 if (chr->be_open) {
4230 return false;
4233 sioc = qio_channel_socket_new();
4234 qio_channel_socket_connect_async(sioc, s->addr,
4235 qemu_chr_socket_connected,
4236 chr, NULL);
4238 return false;
4241 static CharDriverState *qmp_chardev_open_socket(const char *id,
4242 ChardevBackend *backend,
4243 ChardevReturn *ret,
4244 Error **errp)
4246 CharDriverState *chr;
4247 TCPCharDriver *s;
4248 ChardevSocket *sock = backend->u.socket;
4249 SocketAddress *addr = sock->addr;
4250 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4251 bool is_listen = sock->has_server ? sock->server : true;
4252 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4253 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4254 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4255 ChardevCommon *common = qapi_ChardevSocket_base(sock);
4256 QIOChannelSocket *sioc = NULL;
4258 chr = qemu_chr_alloc(common, errp);
4259 if (!chr) {
4260 return NULL;
4262 s = g_new0(TCPCharDriver, 1);
4264 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4265 s->is_listen = is_listen;
4266 s->is_telnet = is_telnet;
4267 s->do_nodelay = do_nodelay;
4268 if (sock->tls_creds) {
4269 Object *creds;
4270 creds = object_resolve_path_component(
4271 object_get_objects_root(), sock->tls_creds);
4272 if (!creds) {
4273 error_setg(errp, "No TLS credentials with id '%s'",
4274 sock->tls_creds);
4275 goto error;
4277 s->tls_creds = (QCryptoTLSCreds *)
4278 object_dynamic_cast(creds,
4279 TYPE_QCRYPTO_TLS_CREDS);
4280 if (!s->tls_creds) {
4281 error_setg(errp, "Object with id '%s' is not TLS credentials",
4282 sock->tls_creds);
4283 goto error;
4285 object_ref(OBJECT(s->tls_creds));
4286 if (is_listen) {
4287 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4288 error_setg(errp, "%s",
4289 "Expected TLS credentials for server endpoint");
4290 goto error;
4292 } else {
4293 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4294 error_setg(errp, "%s",
4295 "Expected TLS credentials for client endpoint");
4296 goto error;
4301 qapi_copy_SocketAddress(&s->addr, sock->addr);
4303 chr->opaque = s;
4304 chr->chr_write = tcp_chr_write;
4305 chr->chr_sync_read = tcp_chr_sync_read;
4306 chr->chr_close = tcp_chr_close;
4307 chr->get_msgfds = tcp_get_msgfds;
4308 chr->set_msgfds = tcp_set_msgfds;
4309 chr->chr_add_client = tcp_chr_add_client;
4310 chr->chr_add_watch = tcp_chr_add_watch;
4311 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4312 /* be isn't opened until we get a connection */
4313 chr->explicit_be_open = true;
4315 chr->filename = SocketAddress_to_str("disconnected:",
4316 addr, is_listen, is_telnet);
4318 if (is_listen) {
4319 if (is_telnet) {
4320 s->do_telnetopt = 1;
4322 } else if (reconnect > 0) {
4323 s->reconnect_time = reconnect;
4326 sioc = qio_channel_socket_new();
4327 if (s->reconnect_time) {
4328 qio_channel_socket_connect_async(sioc, s->addr,
4329 qemu_chr_socket_connected,
4330 chr, NULL);
4331 } else if (s->is_listen) {
4332 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4333 goto error;
4335 s->listen_ioc = sioc;
4336 if (is_waitconnect) {
4337 fprintf(stderr, "QEMU waiting for connection on: %s\n",
4338 chr->filename);
4339 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
4341 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
4342 if (!s->ioc) {
4343 s->listen_tag = qio_channel_add_watch(
4344 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
4346 } else {
4347 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
4348 goto error;
4350 tcp_chr_new_client(chr, sioc);
4351 object_unref(OBJECT(sioc));
4354 return chr;
4356 error:
4357 if (sioc) {
4358 object_unref(OBJECT(sioc));
4360 if (s->tls_creds) {
4361 object_unref(OBJECT(s->tls_creds));
4363 g_free(s);
4364 qemu_chr_free_common(chr);
4365 return NULL;
4368 static CharDriverState *qmp_chardev_open_udp(const char *id,
4369 ChardevBackend *backend,
4370 ChardevReturn *ret,
4371 Error **errp)
4373 ChardevUdp *udp = backend->u.udp;
4374 ChardevCommon *common = qapi_ChardevUdp_base(udp);
4375 QIOChannelSocket *sioc = qio_channel_socket_new();
4377 if (qio_channel_socket_dgram_sync(sioc,
4378 udp->local, udp->remote,
4379 errp) < 0) {
4380 object_unref(OBJECT(sioc));
4381 return NULL;
4383 return qemu_chr_open_udp(sioc, common, errp);
4386 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4387 Error **errp)
4389 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4390 CharDriverState *chr = NULL;
4391 Error *local_err = NULL;
4392 GSList *i;
4393 CharDriver *cd;
4395 chr = qemu_chr_find(id);
4396 if (chr) {
4397 error_setg(errp, "Chardev '%s' already exists", id);
4398 g_free(ret);
4399 return NULL;
4402 for (i = backends; i; i = i->next) {
4403 cd = i->data;
4405 if (cd->kind == backend->type) {
4406 chr = cd->create(id, backend, ret, &local_err);
4407 if (local_err) {
4408 error_propagate(errp, local_err);
4409 goto out_error;
4411 break;
4415 if (chr == NULL) {
4416 assert(!i);
4417 error_setg(errp, "chardev backend not available");
4418 goto out_error;
4421 chr->label = g_strdup(id);
4422 chr->avail_connections =
4423 (backend->type == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4424 if (!chr->filename) {
4425 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4427 if (!chr->explicit_be_open) {
4428 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4430 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4431 return ret;
4433 out_error:
4434 g_free(ret);
4435 return NULL;
4438 void qmp_chardev_remove(const char *id, Error **errp)
4440 CharDriverState *chr;
4442 chr = qemu_chr_find(id);
4443 if (chr == NULL) {
4444 error_setg(errp, "Chardev '%s' not found", id);
4445 return;
4447 if (chr->chr_can_read || chr->chr_read ||
4448 chr->chr_event || chr->handler_opaque) {
4449 error_setg(errp, "Chardev '%s' is busy", id);
4450 return;
4452 qemu_chr_delete(chr);
4455 static void register_types(void)
4457 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4458 qemu_chr_open_null);
4459 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4460 qemu_chr_parse_socket, qmp_chardev_open_socket);
4461 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4462 qmp_chardev_open_udp);
4463 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4464 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4465 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4466 qemu_chr_parse_file_out, qmp_chardev_open_file);
4467 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4468 qemu_chr_parse_stdio, qemu_chr_open_stdio);
4469 #if defined HAVE_CHARDEV_SERIAL
4470 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4471 qemu_chr_parse_serial, qmp_chardev_open_serial);
4472 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4473 qemu_chr_parse_serial, qmp_chardev_open_serial);
4474 #endif
4475 #ifdef HAVE_CHARDEV_PARPORT
4476 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4477 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4478 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4479 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4480 #endif
4481 #ifdef HAVE_CHARDEV_PTY
4482 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4483 qemu_chr_open_pty);
4484 #endif
4485 #ifdef _WIN32
4486 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4487 qemu_chr_open_win_con);
4488 #endif
4489 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4490 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4491 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4492 qemu_chr_open_mux);
4493 /* Bug-compatibility: */
4494 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4495 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4496 /* this must be done after machine init, since we register FEs with muxes
4497 * as part of realize functions like serial_isa_realizefn when -nographic
4498 * is specified
4500 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4503 type_init(register_types);