util: move declarations out of qemu-common.h
[qemu/ar7.git] / qemu-char.c
blob97aaaae4390612a51e4f1bd1412765092de56958
1 /*
2 * QEMU System Emulator
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
24 #include "qemu/osdep.h"
25 #include "qemu-common.h"
26 #include "qemu/cutils.h"
27 #include "monitor/monitor.h"
28 #include "sysemu/sysemu.h"
29 #include "sysemu/block-backend.h"
30 #include "qemu/error-report.h"
31 #include "qemu/timer.h"
32 #include "sysemu/char.h"
33 #include "hw/usb.h"
34 #include "qmp-commands.h"
35 #include "qapi/qmp-input-visitor.h"
36 #include "qapi/qmp-output-visitor.h"
37 #include "qapi-visit.h"
38 #include "qemu/base64.h"
39 #include "io/channel-socket.h"
40 #include "io/channel-file.h"
41 #include "io/channel-tls.h"
42 #include "sysemu/replay.h"
44 #include <zlib.h>
46 #ifndef _WIN32
47 #include <sys/times.h>
48 #include <sys/wait.h>
49 #include <termios.h>
50 #include <sys/mman.h>
51 #include <sys/ioctl.h>
52 #include <sys/resource.h>
53 #include <sys/socket.h>
54 #include <netinet/in.h>
55 #include <net/if.h>
56 #include <arpa/inet.h>
57 #include <netdb.h>
58 #include <sys/select.h>
59 #ifdef CONFIG_BSD
60 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
61 #include <dev/ppbus/ppi.h>
62 #include <dev/ppbus/ppbconf.h>
63 #elif defined(__DragonFly__)
64 #include <dev/misc/ppi/ppi.h>
65 #include <bus/ppbus/ppbconf.h>
66 #endif
67 #else
68 #ifdef __linux__
69 #include <linux/ppdev.h>
70 #include <linux/parport.h>
71 #endif
72 #ifdef __sun__
73 #include <sys/ethernet.h>
74 #include <sys/sockio.h>
75 #include <netinet/arp.h>
76 #include <netinet/in.h>
77 #include <netinet/in_systm.h>
78 #include <netinet/ip.h>
79 #include <netinet/ip_icmp.h> // must come after ip.h
80 #include <netinet/udp.h>
81 #include <netinet/tcp.h>
82 #endif
83 #endif
84 #endif
86 #include "qemu/sockets.h"
87 #include "ui/qemu-spice.h"
89 #define READ_BUF_LEN 4096
90 #define READ_RETRIES 10
91 #define TCP_MAX_FDS 16
93 /***********************************************************/
94 /* Socket address helpers */
96 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
97 bool is_listen, bool is_telnet)
99 switch (addr->type) {
100 case SOCKET_ADDRESS_KIND_INET:
101 return g_strdup_printf("%s%s:%s:%s%s", prefix,
102 is_telnet ? "telnet" : "tcp",
103 addr->u.inet.data->host,
104 addr->u.inet.data->port,
105 is_listen ? ",server" : "");
106 break;
107 case SOCKET_ADDRESS_KIND_UNIX:
108 return g_strdup_printf("%sunix:%s%s", prefix,
109 addr->u.q_unix.data->path,
110 is_listen ? ",server" : "");
111 break;
112 case SOCKET_ADDRESS_KIND_FD:
113 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.data->str,
114 is_listen ? ",server" : "");
115 break;
116 default:
117 abort();
121 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
122 struct sockaddr_storage *ps, socklen_t ps_len,
123 bool is_listen, bool is_telnet)
125 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
126 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
127 const char *left = "", *right = "";
129 switch (ss->ss_family) {
130 #ifndef _WIN32
131 case AF_UNIX:
132 return g_strdup_printf("unix:%s%s",
133 ((struct sockaddr_un *)(ss))->sun_path,
134 is_listen ? ",server" : "");
135 #endif
136 case AF_INET6:
137 left = "[";
138 right = "]";
139 /* fall through */
140 case AF_INET:
141 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
142 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
143 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
144 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
145 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
146 is_telnet ? "telnet" : "tcp",
147 left, shost, right, sserv,
148 is_listen ? ",server" : "",
149 left, phost, right, pserv);
151 default:
152 return g_strdup_printf("unknown");
156 /***********************************************************/
157 /* character device */
159 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
160 QTAILQ_HEAD_INITIALIZER(chardevs);
162 static void qemu_chr_free_common(CharDriverState *chr);
164 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp)
166 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
167 qemu_mutex_init(&chr->chr_write_lock);
169 if (backend->has_logfile) {
170 int flags = O_WRONLY | O_CREAT;
171 if (backend->has_logappend &&
172 backend->logappend) {
173 flags |= O_APPEND;
174 } else {
175 flags |= O_TRUNC;
177 chr->logfd = qemu_open(backend->logfile, flags, 0666);
178 if (chr->logfd < 0) {
179 error_setg_errno(errp, errno,
180 "Unable to open logfile %s",
181 backend->logfile);
182 g_free(chr);
183 return NULL;
185 } else {
186 chr->logfd = -1;
189 return chr;
192 void qemu_chr_be_event(CharDriverState *s, int event)
194 /* Keep track if the char device is open */
195 switch (event) {
196 case CHR_EVENT_OPENED:
197 s->be_open = 1;
198 break;
199 case CHR_EVENT_CLOSED:
200 s->be_open = 0;
201 break;
204 if (!s->chr_event)
205 return;
206 s->chr_event(s->handler_opaque, event);
209 void qemu_chr_be_generic_open(CharDriverState *s)
211 qemu_chr_be_event(s, CHR_EVENT_OPENED);
215 /* Not reporting errors from writing to logfile, as logs are
216 * defined to be "best effort" only */
217 static void qemu_chr_fe_write_log(CharDriverState *s,
218 const uint8_t *buf, size_t len)
220 size_t done = 0;
221 ssize_t ret;
223 if (s->logfd < 0) {
224 return;
227 while (done < len) {
228 do {
229 ret = write(s->logfd, buf + done, len - done);
230 if (ret == -1 && errno == EAGAIN) {
231 g_usleep(100);
233 } while (ret == -1 && errno == EAGAIN);
235 if (ret <= 0) {
236 return;
238 done += ret;
242 static int qemu_chr_fe_write_buffer(CharDriverState *s, const uint8_t *buf, int len, int *offset)
244 int res = 0;
245 *offset = 0;
247 qemu_mutex_lock(&s->chr_write_lock);
248 while (*offset < len) {
249 do {
250 res = s->chr_write(s, buf + *offset, len - *offset);
251 if (res == -1 && errno == EAGAIN) {
252 g_usleep(100);
254 } while (res == -1 && errno == EAGAIN);
256 if (res <= 0) {
257 break;
260 *offset += res;
262 if (*offset > 0) {
263 qemu_chr_fe_write_log(s, buf, *offset);
265 qemu_mutex_unlock(&s->chr_write_lock);
267 return res;
270 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len)
272 int ret;
274 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
275 int offset;
276 replay_char_write_event_load(&ret, &offset);
277 assert(offset <= len);
278 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
279 return ret;
282 qemu_mutex_lock(&s->chr_write_lock);
283 ret = s->chr_write(s, buf, len);
285 if (ret > 0) {
286 qemu_chr_fe_write_log(s, buf, ret);
289 qemu_mutex_unlock(&s->chr_write_lock);
291 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
292 replay_char_write_event_save(ret, ret < 0 ? 0 : ret);
295 return ret;
298 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len)
300 int offset;
301 int res;
303 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
304 replay_char_write_event_load(&res, &offset);
305 assert(offset <= len);
306 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
307 return res;
310 res = qemu_chr_fe_write_buffer(s, buf, len, &offset);
312 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
313 replay_char_write_event_save(res, offset);
316 if (res < 0) {
317 return res;
319 return offset;
322 int qemu_chr_fe_read_all(CharDriverState *s, uint8_t *buf, int len)
324 int offset = 0, counter = 10;
325 int res;
327 if (!s->chr_sync_read) {
328 return 0;
331 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
332 return replay_char_read_all_load(buf);
335 while (offset < len) {
336 do {
337 res = s->chr_sync_read(s, buf + offset, len - offset);
338 if (res == -1 && errno == EAGAIN) {
339 g_usleep(100);
341 } while (res == -1 && errno == EAGAIN);
343 if (res == 0) {
344 break;
347 if (res < 0) {
348 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
349 replay_char_read_all_save_error(res);
351 return res;
354 offset += res;
356 if (!counter--) {
357 break;
361 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
362 replay_char_read_all_save_buf(buf, offset);
364 return offset;
367 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg)
369 int res;
370 if (!s->chr_ioctl || s->replay) {
371 res = -ENOTSUP;
372 } else {
373 res = s->chr_ioctl(s, cmd, arg);
376 return res;
379 int qemu_chr_be_can_write(CharDriverState *s)
381 if (!s->chr_can_read)
382 return 0;
383 return s->chr_can_read(s->handler_opaque);
386 void qemu_chr_be_write_impl(CharDriverState *s, uint8_t *buf, int len)
388 if (s->chr_read) {
389 s->chr_read(s->handler_opaque, buf, len);
393 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
395 if (s->replay) {
396 if (replay_mode == REPLAY_MODE_PLAY) {
397 return;
399 replay_chr_be_write(s, buf, len);
400 } else {
401 qemu_chr_be_write_impl(s, buf, len);
405 int qemu_chr_fe_get_msgfd(CharDriverState *s)
407 int fd;
408 int res = (qemu_chr_fe_get_msgfds(s, &fd, 1) == 1) ? fd : -1;
409 if (s->replay) {
410 fprintf(stderr,
411 "Replay: get msgfd is not supported for serial devices yet\n");
412 exit(1);
414 return res;
417 int qemu_chr_fe_get_msgfds(CharDriverState *s, int *fds, int len)
419 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
422 int qemu_chr_fe_set_msgfds(CharDriverState *s, int *fds, int num)
424 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
427 int qemu_chr_add_client(CharDriverState *s, int fd)
429 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
432 void qemu_chr_accept_input(CharDriverState *s)
434 if (s->chr_accept_input)
435 s->chr_accept_input(s);
436 qemu_notify_event();
439 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
441 char buf[READ_BUF_LEN];
442 va_list ap;
443 va_start(ap, fmt);
444 vsnprintf(buf, sizeof(buf), fmt, ap);
445 qemu_chr_fe_write(s, (uint8_t *)buf, strlen(buf));
446 va_end(ap);
449 static void remove_fd_in_watch(CharDriverState *chr);
451 void qemu_chr_add_handlers(CharDriverState *s,
452 IOCanReadHandler *fd_can_read,
453 IOReadHandler *fd_read,
454 IOEventHandler *fd_event,
455 void *opaque)
457 int fe_open;
459 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
460 fe_open = 0;
461 remove_fd_in_watch(s);
462 } else {
463 fe_open = 1;
465 s->chr_can_read = fd_can_read;
466 s->chr_read = fd_read;
467 s->chr_event = fd_event;
468 s->handler_opaque = opaque;
469 if (fe_open && s->chr_update_read_handler)
470 s->chr_update_read_handler(s);
472 if (!s->explicit_fe_open) {
473 qemu_chr_fe_set_open(s, fe_open);
476 /* We're connecting to an already opened device, so let's make sure we
477 also get the open event */
478 if (fe_open && s->be_open) {
479 qemu_chr_be_generic_open(s);
483 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
485 return len;
488 static CharDriverState *qemu_chr_open_null(const char *id,
489 ChardevBackend *backend,
490 ChardevReturn *ret,
491 Error **errp)
493 CharDriverState *chr;
494 ChardevCommon *common = backend->u.null.data;
496 chr = qemu_chr_alloc(common, errp);
497 if (!chr) {
498 return NULL;
500 chr->chr_write = null_chr_write;
501 chr->explicit_be_open = true;
502 return chr;
505 /* MUX driver for serial I/O splitting */
506 #define MAX_MUX 4
507 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
508 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
509 typedef struct {
510 IOCanReadHandler *chr_can_read[MAX_MUX];
511 IOReadHandler *chr_read[MAX_MUX];
512 IOEventHandler *chr_event[MAX_MUX];
513 void *ext_opaque[MAX_MUX];
514 CharDriverState *drv;
515 int focus;
516 int mux_cnt;
517 int term_got_escape;
518 int max_size;
519 /* Intermediate input buffer allows to catch escape sequences even if the
520 currently active device is not accepting any input - but only until it
521 is full as well. */
522 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
523 int prod[MAX_MUX];
524 int cons[MAX_MUX];
525 int timestamps;
527 /* Protected by the CharDriverState chr_write_lock. */
528 int linestart;
529 int64_t timestamps_start;
530 } MuxDriver;
533 /* Called with chr_write_lock held. */
534 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
536 MuxDriver *d = chr->opaque;
537 int ret;
538 if (!d->timestamps) {
539 ret = qemu_chr_fe_write(d->drv, buf, len);
540 } else {
541 int i;
543 ret = 0;
544 for (i = 0; i < len; i++) {
545 if (d->linestart) {
546 char buf1[64];
547 int64_t ti;
548 int secs;
550 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
551 if (d->timestamps_start == -1)
552 d->timestamps_start = ti;
553 ti -= d->timestamps_start;
554 secs = ti / 1000;
555 snprintf(buf1, sizeof(buf1),
556 "[%02d:%02d:%02d.%03d] ",
557 secs / 3600,
558 (secs / 60) % 60,
559 secs % 60,
560 (int)(ti % 1000));
561 qemu_chr_fe_write(d->drv, (uint8_t *)buf1, strlen(buf1));
562 d->linestart = 0;
564 ret += qemu_chr_fe_write(d->drv, buf+i, 1);
565 if (buf[i] == '\n') {
566 d->linestart = 1;
570 return ret;
573 static const char * const mux_help[] = {
574 "% h print this help\n\r",
575 "% x exit emulator\n\r",
576 "% s save disk data back to file (if -snapshot)\n\r",
577 "% t toggle console timestamps\n\r",
578 "% b send break (magic sysrq)\n\r",
579 "% c switch between console and monitor\n\r",
580 "% % sends %\n\r",
581 NULL
584 int term_escape_char = 0x01; /* ctrl-a is used for escape */
585 static void mux_print_help(CharDriverState *chr)
587 int i, j;
588 char ebuf[15] = "Escape-Char";
589 char cbuf[50] = "\n\r";
591 if (term_escape_char > 0 && term_escape_char < 26) {
592 snprintf(cbuf, sizeof(cbuf), "\n\r");
593 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
594 } else {
595 snprintf(cbuf, sizeof(cbuf),
596 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
597 term_escape_char);
599 qemu_chr_fe_write(chr, (uint8_t *)cbuf, strlen(cbuf));
600 for (i = 0; mux_help[i] != NULL; i++) {
601 for (j=0; mux_help[i][j] != '\0'; j++) {
602 if (mux_help[i][j] == '%')
603 qemu_chr_fe_write(chr, (uint8_t *)ebuf, strlen(ebuf));
604 else
605 qemu_chr_fe_write(chr, (uint8_t *)&mux_help[i][j], 1);
610 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
612 if (d->chr_event[mux_nr])
613 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
616 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
618 if (d->term_got_escape) {
619 d->term_got_escape = 0;
620 if (ch == term_escape_char)
621 goto send_char;
622 switch(ch) {
623 case '?':
624 case 'h':
625 mux_print_help(chr);
626 break;
627 case 'x':
629 const char *term = "QEMU: Terminated\n\r";
630 qemu_chr_fe_write(chr, (uint8_t *)term, strlen(term));
631 exit(0);
632 break;
634 case 's':
635 blk_commit_all();
636 break;
637 case 'b':
638 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
639 break;
640 case 'c':
641 /* Switch to the next registered device */
642 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
643 d->focus++;
644 if (d->focus >= d->mux_cnt)
645 d->focus = 0;
646 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
647 break;
648 case 't':
649 d->timestamps = !d->timestamps;
650 d->timestamps_start = -1;
651 d->linestart = 0;
652 break;
654 } else if (ch == term_escape_char) {
655 d->term_got_escape = 1;
656 } else {
657 send_char:
658 return 1;
660 return 0;
663 static void mux_chr_accept_input(CharDriverState *chr)
665 MuxDriver *d = chr->opaque;
666 int m = d->focus;
668 while (d->prod[m] != d->cons[m] &&
669 d->chr_can_read[m] &&
670 d->chr_can_read[m](d->ext_opaque[m])) {
671 d->chr_read[m](d->ext_opaque[m],
672 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
676 static int mux_chr_can_read(void *opaque)
678 CharDriverState *chr = opaque;
679 MuxDriver *d = chr->opaque;
680 int m = d->focus;
682 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
683 return 1;
684 if (d->chr_can_read[m])
685 return d->chr_can_read[m](d->ext_opaque[m]);
686 return 0;
689 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
691 CharDriverState *chr = opaque;
692 MuxDriver *d = chr->opaque;
693 int m = d->focus;
694 int i;
696 mux_chr_accept_input (opaque);
698 for(i = 0; i < size; i++)
699 if (mux_proc_byte(chr, d, buf[i])) {
700 if (d->prod[m] == d->cons[m] &&
701 d->chr_can_read[m] &&
702 d->chr_can_read[m](d->ext_opaque[m]))
703 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
704 else
705 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
709 static void mux_chr_event(void *opaque, int event)
711 CharDriverState *chr = opaque;
712 MuxDriver *d = chr->opaque;
713 int i;
715 /* Send the event to all registered listeners */
716 for (i = 0; i < d->mux_cnt; i++)
717 mux_chr_send_event(d, i, event);
720 static void mux_chr_update_read_handler(CharDriverState *chr)
722 MuxDriver *d = chr->opaque;
724 if (d->mux_cnt >= MAX_MUX) {
725 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
726 return;
728 d->ext_opaque[d->mux_cnt] = chr->handler_opaque;
729 d->chr_can_read[d->mux_cnt] = chr->chr_can_read;
730 d->chr_read[d->mux_cnt] = chr->chr_read;
731 d->chr_event[d->mux_cnt] = chr->chr_event;
732 /* Fix up the real driver with mux routines */
733 if (d->mux_cnt == 0) {
734 qemu_chr_add_handlers(d->drv, mux_chr_can_read, mux_chr_read,
735 mux_chr_event, chr);
737 if (d->focus != -1) {
738 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
740 d->focus = d->mux_cnt;
741 d->mux_cnt++;
742 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
745 static bool muxes_realized;
748 * Called after processing of default and command-line-specified
749 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
750 * to a mux chardev. This is done here to ensure that
751 * output/prompts/banners are only displayed for the FE that has
752 * focus when initial command-line processing/machine init is
753 * completed.
755 * After this point, any new FE attached to any new or existing
756 * mux will receive CHR_EVENT_OPENED notifications for the BE
757 * immediately.
759 static void muxes_realize_done(Notifier *notifier, void *unused)
761 CharDriverState *chr;
763 QTAILQ_FOREACH(chr, &chardevs, next) {
764 if (chr->is_mux) {
765 MuxDriver *d = chr->opaque;
766 int i;
768 /* send OPENED to all already-attached FEs */
769 for (i = 0; i < d->mux_cnt; i++) {
770 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
772 /* mark mux as OPENED so any new FEs will immediately receive
773 * OPENED event
775 qemu_chr_be_generic_open(chr);
778 muxes_realized = true;
781 static Notifier muxes_realize_notify = {
782 .notify = muxes_realize_done,
785 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
787 MuxDriver *d = s->opaque;
788 return d->drv->chr_add_watch(d->drv, cond);
791 static CharDriverState *qemu_chr_open_mux(const char *id,
792 ChardevBackend *backend,
793 ChardevReturn *ret, Error **errp)
795 ChardevMux *mux = backend->u.mux.data;
796 CharDriverState *chr, *drv;
797 MuxDriver *d;
798 ChardevCommon *common = qapi_ChardevMux_base(mux);
800 drv = qemu_chr_find(mux->chardev);
801 if (drv == NULL) {
802 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
803 return NULL;
806 chr = qemu_chr_alloc(common, errp);
807 if (!chr) {
808 return NULL;
810 d = g_new0(MuxDriver, 1);
812 chr->opaque = d;
813 d->drv = drv;
814 d->focus = -1;
815 chr->chr_write = mux_chr_write;
816 chr->chr_update_read_handler = mux_chr_update_read_handler;
817 chr->chr_accept_input = mux_chr_accept_input;
818 /* Frontend guest-open / -close notification is not support with muxes */
819 chr->chr_set_fe_open = NULL;
820 if (drv->chr_add_watch) {
821 chr->chr_add_watch = mux_chr_add_watch;
823 /* only default to opened state if we've realized the initial
824 * set of muxes
826 chr->explicit_be_open = muxes_realized ? 0 : 1;
827 chr->is_mux = 1;
829 return chr;
833 typedef struct IOWatchPoll
835 GSource parent;
837 QIOChannel *ioc;
838 GSource *src;
840 IOCanReadHandler *fd_can_read;
841 GSourceFunc fd_read;
842 void *opaque;
843 } IOWatchPoll;
845 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
847 return container_of(source, IOWatchPoll, parent);
850 static gboolean io_watch_poll_prepare(GSource *source, gint *timeout_)
852 IOWatchPoll *iwp = io_watch_poll_from_source(source);
853 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
854 bool was_active = iwp->src != NULL;
855 if (was_active == now_active) {
856 return FALSE;
859 if (now_active) {
860 iwp->src = qio_channel_create_watch(
861 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
862 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
863 g_source_attach(iwp->src, NULL);
864 } else {
865 g_source_destroy(iwp->src);
866 g_source_unref(iwp->src);
867 iwp->src = NULL;
869 return FALSE;
872 static gboolean io_watch_poll_check(GSource *source)
874 return FALSE;
877 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
878 gpointer user_data)
880 abort();
883 static void io_watch_poll_finalize(GSource *source)
885 /* Due to a glib bug, removing the last reference to a source
886 * inside a finalize callback causes recursive locking (and a
887 * deadlock). This is not a problem inside other callbacks,
888 * including dispatch callbacks, so we call io_remove_watch_poll
889 * to remove this source. At this point, iwp->src must
890 * be NULL, or we would leak it.
892 * This would be solved much more elegantly by child sources,
893 * but we support older glib versions that do not have them.
895 IOWatchPoll *iwp = io_watch_poll_from_source(source);
896 assert(iwp->src == NULL);
899 static GSourceFuncs io_watch_poll_funcs = {
900 .prepare = io_watch_poll_prepare,
901 .check = io_watch_poll_check,
902 .dispatch = io_watch_poll_dispatch,
903 .finalize = io_watch_poll_finalize,
906 /* Can only be used for read */
907 static guint io_add_watch_poll(QIOChannel *ioc,
908 IOCanReadHandler *fd_can_read,
909 QIOChannelFunc fd_read,
910 gpointer user_data)
912 IOWatchPoll *iwp;
913 int tag;
915 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs, sizeof(IOWatchPoll));
916 iwp->fd_can_read = fd_can_read;
917 iwp->opaque = user_data;
918 iwp->ioc = ioc;
919 iwp->fd_read = (GSourceFunc) fd_read;
920 iwp->src = NULL;
922 tag = g_source_attach(&iwp->parent, NULL);
923 g_source_unref(&iwp->parent);
924 return tag;
927 static void io_remove_watch_poll(guint tag)
929 GSource *source;
930 IOWatchPoll *iwp;
932 g_return_if_fail (tag > 0);
934 source = g_main_context_find_source_by_id(NULL, tag);
935 g_return_if_fail (source != NULL);
937 iwp = io_watch_poll_from_source(source);
938 if (iwp->src) {
939 g_source_destroy(iwp->src);
940 g_source_unref(iwp->src);
941 iwp->src = NULL;
943 g_source_destroy(&iwp->parent);
946 static void remove_fd_in_watch(CharDriverState *chr)
948 if (chr->fd_in_tag) {
949 io_remove_watch_poll(chr->fd_in_tag);
950 chr->fd_in_tag = 0;
955 static int io_channel_send_full(QIOChannel *ioc,
956 const void *buf, size_t len,
957 int *fds, size_t nfds)
959 size_t offset = 0;
961 while (offset < len) {
962 ssize_t ret = 0;
963 struct iovec iov = { .iov_base = (char *)buf + offset,
964 .iov_len = len - offset };
966 ret = qio_channel_writev_full(
967 ioc, &iov, 1,
968 fds, nfds, NULL);
969 if (ret == QIO_CHANNEL_ERR_BLOCK) {
970 if (offset) {
971 return offset;
974 errno = EAGAIN;
975 return -1;
976 } else if (ret < 0) {
977 errno = EINVAL;
978 return -1;
981 offset += ret;
984 return offset;
988 #ifndef _WIN32
989 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
991 return io_channel_send_full(ioc, buf, len, NULL, 0);
995 typedef struct FDCharDriver {
996 CharDriverState *chr;
997 QIOChannel *ioc_in, *ioc_out;
998 int max_size;
999 } FDCharDriver;
1001 /* Called with chr_write_lock held. */
1002 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1004 FDCharDriver *s = chr->opaque;
1006 return io_channel_send(s->ioc_out, buf, len);
1009 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1011 CharDriverState *chr = opaque;
1012 FDCharDriver *s = chr->opaque;
1013 int len;
1014 uint8_t buf[READ_BUF_LEN];
1015 ssize_t ret;
1017 len = sizeof(buf);
1018 if (len > s->max_size) {
1019 len = s->max_size;
1021 if (len == 0) {
1022 return TRUE;
1025 ret = qio_channel_read(
1026 chan, (gchar *)buf, len, NULL);
1027 if (ret == 0) {
1028 remove_fd_in_watch(chr);
1029 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1030 return FALSE;
1032 if (ret > 0) {
1033 qemu_chr_be_write(chr, buf, ret);
1036 return TRUE;
1039 static int fd_chr_read_poll(void *opaque)
1041 CharDriverState *chr = opaque;
1042 FDCharDriver *s = chr->opaque;
1044 s->max_size = qemu_chr_be_can_write(chr);
1045 return s->max_size;
1048 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1050 FDCharDriver *s = chr->opaque;
1051 return qio_channel_create_watch(s->ioc_out, cond);
1054 static void fd_chr_update_read_handler(CharDriverState *chr)
1056 FDCharDriver *s = chr->opaque;
1058 remove_fd_in_watch(chr);
1059 if (s->ioc_in) {
1060 chr->fd_in_tag = io_add_watch_poll(s->ioc_in,
1061 fd_chr_read_poll,
1062 fd_chr_read, chr);
1066 static void fd_chr_close(struct CharDriverState *chr)
1068 FDCharDriver *s = chr->opaque;
1070 remove_fd_in_watch(chr);
1071 if (s->ioc_in) {
1072 object_unref(OBJECT(s->ioc_in));
1074 if (s->ioc_out) {
1075 object_unref(OBJECT(s->ioc_out));
1078 g_free(s);
1079 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1082 /* open a character device to a unix fd */
1083 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out,
1084 ChardevCommon *backend, Error **errp)
1086 CharDriverState *chr;
1087 FDCharDriver *s;
1089 chr = qemu_chr_alloc(backend, errp);
1090 if (!chr) {
1091 return NULL;
1093 s = g_new0(FDCharDriver, 1);
1094 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1095 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1096 qemu_set_nonblock(fd_out);
1097 s->chr = chr;
1098 chr->opaque = s;
1099 chr->chr_add_watch = fd_chr_add_watch;
1100 chr->chr_write = fd_chr_write;
1101 chr->chr_update_read_handler = fd_chr_update_read_handler;
1102 chr->chr_close = fd_chr_close;
1104 return chr;
1107 static CharDriverState *qemu_chr_open_pipe(const char *id,
1108 ChardevBackend *backend,
1109 ChardevReturn *ret,
1110 Error **errp)
1112 ChardevHostdev *opts = backend->u.pipe.data;
1113 int fd_in, fd_out;
1114 char *filename_in;
1115 char *filename_out;
1116 const char *filename = opts->device;
1117 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
1120 filename_in = g_strdup_printf("%s.in", filename);
1121 filename_out = g_strdup_printf("%s.out", filename);
1122 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1123 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1124 g_free(filename_in);
1125 g_free(filename_out);
1126 if (fd_in < 0 || fd_out < 0) {
1127 if (fd_in >= 0)
1128 close(fd_in);
1129 if (fd_out >= 0)
1130 close(fd_out);
1131 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1132 if (fd_in < 0) {
1133 error_setg_file_open(errp, errno, filename);
1134 return NULL;
1137 return qemu_chr_open_fd(fd_in, fd_out, common, errp);
1140 /* init terminal so that we can grab keys */
1141 static struct termios oldtty;
1142 static int old_fd0_flags;
1143 static bool stdio_in_use;
1144 static bool stdio_allow_signal;
1145 static bool stdio_echo_state;
1147 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1149 static void term_exit(void)
1151 tcsetattr (0, TCSANOW, &oldtty);
1152 fcntl(0, F_SETFL, old_fd0_flags);
1155 static void term_stdio_handler(int sig)
1157 /* restore echo after resume from suspend. */
1158 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1161 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1163 struct termios tty;
1165 stdio_echo_state = echo;
1166 tty = oldtty;
1167 if (!echo) {
1168 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1169 |INLCR|IGNCR|ICRNL|IXON);
1170 tty.c_oflag |= OPOST;
1171 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1172 tty.c_cflag &= ~(CSIZE|PARENB);
1173 tty.c_cflag |= CS8;
1174 tty.c_cc[VMIN] = 1;
1175 tty.c_cc[VTIME] = 0;
1177 if (!stdio_allow_signal)
1178 tty.c_lflag &= ~ISIG;
1180 tcsetattr (0, TCSANOW, &tty);
1183 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1185 term_exit();
1186 fd_chr_close(chr);
1189 static CharDriverState *qemu_chr_open_stdio(const char *id,
1190 ChardevBackend *backend,
1191 ChardevReturn *ret,
1192 Error **errp)
1194 ChardevStdio *opts = backend->u.stdio.data;
1195 CharDriverState *chr;
1196 struct sigaction act;
1197 ChardevCommon *common = qapi_ChardevStdio_base(opts);
1199 if (is_daemonized()) {
1200 error_setg(errp, "cannot use stdio with -daemonize");
1201 return NULL;
1204 if (stdio_in_use) {
1205 error_setg(errp, "cannot use stdio by multiple character devices");
1206 return NULL;
1209 stdio_in_use = true;
1210 old_fd0_flags = fcntl(0, F_GETFL);
1211 tcgetattr(0, &oldtty);
1212 qemu_set_nonblock(0);
1213 atexit(term_exit);
1215 memset(&act, 0, sizeof(act));
1216 act.sa_handler = term_stdio_handler;
1217 sigaction(SIGCONT, &act, NULL);
1219 chr = qemu_chr_open_fd(0, 1, common, errp);
1220 chr->chr_close = qemu_chr_close_stdio;
1221 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1222 if (opts->has_signal) {
1223 stdio_allow_signal = opts->signal;
1225 qemu_chr_fe_set_echo(chr, false);
1227 return chr;
1230 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1231 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1232 || defined(__GLIBC__)
1234 #define HAVE_CHARDEV_SERIAL 1
1235 #define HAVE_CHARDEV_PTY 1
1237 typedef struct {
1238 QIOChannel *ioc;
1239 int read_bytes;
1241 /* Protected by the CharDriverState chr_write_lock. */
1242 int connected;
1243 guint timer_tag;
1244 guint open_tag;
1245 } PtyCharDriver;
1247 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1248 static void pty_chr_state(CharDriverState *chr, int connected);
1250 static gboolean pty_chr_timer(gpointer opaque)
1252 struct CharDriverState *chr = opaque;
1253 PtyCharDriver *s = chr->opaque;
1255 qemu_mutex_lock(&chr->chr_write_lock);
1256 s->timer_tag = 0;
1257 s->open_tag = 0;
1258 if (!s->connected) {
1259 /* Next poll ... */
1260 pty_chr_update_read_handler_locked(chr);
1262 qemu_mutex_unlock(&chr->chr_write_lock);
1263 return FALSE;
1266 /* Called with chr_write_lock held. */
1267 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1269 PtyCharDriver *s = chr->opaque;
1271 if (s->timer_tag) {
1272 g_source_remove(s->timer_tag);
1273 s->timer_tag = 0;
1276 if (ms == 1000) {
1277 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1278 } else {
1279 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1283 /* Called with chr_write_lock held. */
1284 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1286 PtyCharDriver *s = chr->opaque;
1287 GPollFD pfd;
1288 int rc;
1289 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1291 pfd.fd = fioc->fd;
1292 pfd.events = G_IO_OUT;
1293 pfd.revents = 0;
1294 do {
1295 rc = g_poll(&pfd, 1, 0);
1296 } while (rc == -1 && errno == EINTR);
1297 assert(rc >= 0);
1299 if (pfd.revents & G_IO_HUP) {
1300 pty_chr_state(chr, 0);
1301 } else {
1302 pty_chr_state(chr, 1);
1306 static void pty_chr_update_read_handler(CharDriverState *chr)
1308 qemu_mutex_lock(&chr->chr_write_lock);
1309 pty_chr_update_read_handler_locked(chr);
1310 qemu_mutex_unlock(&chr->chr_write_lock);
1313 /* Called with chr_write_lock held. */
1314 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1316 PtyCharDriver *s = chr->opaque;
1318 if (!s->connected) {
1319 /* guest sends data, check for (re-)connect */
1320 pty_chr_update_read_handler_locked(chr);
1321 if (!s->connected) {
1322 return 0;
1325 return io_channel_send(s->ioc, buf, len);
1328 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1330 PtyCharDriver *s = chr->opaque;
1331 if (!s->connected) {
1332 return NULL;
1334 return qio_channel_create_watch(s->ioc, cond);
1337 static int pty_chr_read_poll(void *opaque)
1339 CharDriverState *chr = opaque;
1340 PtyCharDriver *s = chr->opaque;
1342 s->read_bytes = qemu_chr_be_can_write(chr);
1343 return s->read_bytes;
1346 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1348 CharDriverState *chr = opaque;
1349 PtyCharDriver *s = chr->opaque;
1350 gsize len;
1351 uint8_t buf[READ_BUF_LEN];
1352 ssize_t ret;
1354 len = sizeof(buf);
1355 if (len > s->read_bytes)
1356 len = s->read_bytes;
1357 if (len == 0) {
1358 return TRUE;
1360 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1361 if (ret <= 0) {
1362 pty_chr_state(chr, 0);
1363 return FALSE;
1364 } else {
1365 pty_chr_state(chr, 1);
1366 qemu_chr_be_write(chr, buf, ret);
1368 return TRUE;
1371 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1373 CharDriverState *chr = opaque;
1374 PtyCharDriver *s = chr->opaque;
1376 s->open_tag = 0;
1377 qemu_chr_be_generic_open(chr);
1378 return FALSE;
1381 /* Called with chr_write_lock held. */
1382 static void pty_chr_state(CharDriverState *chr, int connected)
1384 PtyCharDriver *s = chr->opaque;
1386 if (!connected) {
1387 if (s->open_tag) {
1388 g_source_remove(s->open_tag);
1389 s->open_tag = 0;
1391 remove_fd_in_watch(chr);
1392 s->connected = 0;
1393 /* (re-)connect poll interval for idle guests: once per second.
1394 * We check more frequently in case the guests sends data to
1395 * the virtual device linked to our pty. */
1396 pty_chr_rearm_timer(chr, 1000);
1397 } else {
1398 if (s->timer_tag) {
1399 g_source_remove(s->timer_tag);
1400 s->timer_tag = 0;
1402 if (!s->connected) {
1403 g_assert(s->open_tag == 0);
1404 s->connected = 1;
1405 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1407 if (!chr->fd_in_tag) {
1408 chr->fd_in_tag = io_add_watch_poll(s->ioc,
1409 pty_chr_read_poll,
1410 pty_chr_read, chr);
1415 static void pty_chr_close(struct CharDriverState *chr)
1417 PtyCharDriver *s = chr->opaque;
1419 qemu_mutex_lock(&chr->chr_write_lock);
1420 pty_chr_state(chr, 0);
1421 object_unref(OBJECT(s->ioc));
1422 if (s->timer_tag) {
1423 g_source_remove(s->timer_tag);
1424 s->timer_tag = 0;
1426 qemu_mutex_unlock(&chr->chr_write_lock);
1427 g_free(s);
1428 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1431 static CharDriverState *qemu_chr_open_pty(const char *id,
1432 ChardevBackend *backend,
1433 ChardevReturn *ret,
1434 Error **errp)
1436 CharDriverState *chr;
1437 PtyCharDriver *s;
1438 int master_fd, slave_fd;
1439 char pty_name[PATH_MAX];
1440 ChardevCommon *common = backend->u.pty.data;
1442 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1443 if (master_fd < 0) {
1444 error_setg_errno(errp, errno, "Failed to create PTY");
1445 return NULL;
1448 close(slave_fd);
1449 qemu_set_nonblock(master_fd);
1451 chr = qemu_chr_alloc(common, errp);
1452 if (!chr) {
1453 close(master_fd);
1454 return NULL;
1457 chr->filename = g_strdup_printf("pty:%s", pty_name);
1458 ret->pty = g_strdup(pty_name);
1459 ret->has_pty = true;
1461 fprintf(stderr, "char device redirected to %s (label %s)\n",
1462 pty_name, id);
1464 s = g_new0(PtyCharDriver, 1);
1465 chr->opaque = s;
1466 chr->chr_write = pty_chr_write;
1467 chr->chr_update_read_handler = pty_chr_update_read_handler;
1468 chr->chr_close = pty_chr_close;
1469 chr->chr_add_watch = pty_chr_add_watch;
1470 chr->explicit_be_open = true;
1472 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1473 s->timer_tag = 0;
1475 return chr;
1478 static void tty_serial_init(int fd, int speed,
1479 int parity, int data_bits, int stop_bits)
1481 struct termios tty;
1482 speed_t spd;
1484 #if 0
1485 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1486 speed, parity, data_bits, stop_bits);
1487 #endif
1488 tcgetattr (fd, &tty);
1490 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1491 speed = speed * 10 / 11;
1492 do {
1493 check_speed(50);
1494 check_speed(75);
1495 check_speed(110);
1496 check_speed(134);
1497 check_speed(150);
1498 check_speed(200);
1499 check_speed(300);
1500 check_speed(600);
1501 check_speed(1200);
1502 check_speed(1800);
1503 check_speed(2400);
1504 check_speed(4800);
1505 check_speed(9600);
1506 check_speed(19200);
1507 check_speed(38400);
1508 /* Non-Posix values follow. They may be unsupported on some systems. */
1509 check_speed(57600);
1510 check_speed(115200);
1511 #ifdef B230400
1512 check_speed(230400);
1513 #endif
1514 #ifdef B460800
1515 check_speed(460800);
1516 #endif
1517 #ifdef B500000
1518 check_speed(500000);
1519 #endif
1520 #ifdef B576000
1521 check_speed(576000);
1522 #endif
1523 #ifdef B921600
1524 check_speed(921600);
1525 #endif
1526 #ifdef B1000000
1527 check_speed(1000000);
1528 #endif
1529 #ifdef B1152000
1530 check_speed(1152000);
1531 #endif
1532 #ifdef B1500000
1533 check_speed(1500000);
1534 #endif
1535 #ifdef B2000000
1536 check_speed(2000000);
1537 #endif
1538 #ifdef B2500000
1539 check_speed(2500000);
1540 #endif
1541 #ifdef B3000000
1542 check_speed(3000000);
1543 #endif
1544 #ifdef B3500000
1545 check_speed(3500000);
1546 #endif
1547 #ifdef B4000000
1548 check_speed(4000000);
1549 #endif
1550 spd = B115200;
1551 } while (0);
1553 cfsetispeed(&tty, spd);
1554 cfsetospeed(&tty, spd);
1556 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1557 |INLCR|IGNCR|ICRNL|IXON);
1558 tty.c_oflag |= OPOST;
1559 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1560 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1561 switch(data_bits) {
1562 default:
1563 case 8:
1564 tty.c_cflag |= CS8;
1565 break;
1566 case 7:
1567 tty.c_cflag |= CS7;
1568 break;
1569 case 6:
1570 tty.c_cflag |= CS6;
1571 break;
1572 case 5:
1573 tty.c_cflag |= CS5;
1574 break;
1576 switch(parity) {
1577 default:
1578 case 'N':
1579 break;
1580 case 'E':
1581 tty.c_cflag |= PARENB;
1582 break;
1583 case 'O':
1584 tty.c_cflag |= PARENB | PARODD;
1585 break;
1587 if (stop_bits == 2)
1588 tty.c_cflag |= CSTOPB;
1590 tcsetattr (fd, TCSANOW, &tty);
1593 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1595 FDCharDriver *s = chr->opaque;
1596 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1598 switch(cmd) {
1599 case CHR_IOCTL_SERIAL_SET_PARAMS:
1601 QEMUSerialSetParams *ssp = arg;
1602 tty_serial_init(fioc->fd,
1603 ssp->speed, ssp->parity,
1604 ssp->data_bits, ssp->stop_bits);
1606 break;
1607 case CHR_IOCTL_SERIAL_SET_BREAK:
1609 int enable = *(int *)arg;
1610 if (enable) {
1611 tcsendbreak(fioc->fd, 1);
1614 break;
1615 case CHR_IOCTL_SERIAL_GET_TIOCM:
1617 int sarg = 0;
1618 int *targ = (int *)arg;
1619 ioctl(fioc->fd, TIOCMGET, &sarg);
1620 *targ = 0;
1621 if (sarg & TIOCM_CTS)
1622 *targ |= CHR_TIOCM_CTS;
1623 if (sarg & TIOCM_CAR)
1624 *targ |= CHR_TIOCM_CAR;
1625 if (sarg & TIOCM_DSR)
1626 *targ |= CHR_TIOCM_DSR;
1627 if (sarg & TIOCM_RI)
1628 *targ |= CHR_TIOCM_RI;
1629 if (sarg & TIOCM_DTR)
1630 *targ |= CHR_TIOCM_DTR;
1631 if (sarg & TIOCM_RTS)
1632 *targ |= CHR_TIOCM_RTS;
1634 break;
1635 case CHR_IOCTL_SERIAL_SET_TIOCM:
1637 int sarg = *(int *)arg;
1638 int targ = 0;
1639 ioctl(fioc->fd, TIOCMGET, &targ);
1640 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1641 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1642 if (sarg & CHR_TIOCM_CTS)
1643 targ |= TIOCM_CTS;
1644 if (sarg & CHR_TIOCM_CAR)
1645 targ |= TIOCM_CAR;
1646 if (sarg & CHR_TIOCM_DSR)
1647 targ |= TIOCM_DSR;
1648 if (sarg & CHR_TIOCM_RI)
1649 targ |= TIOCM_RI;
1650 if (sarg & CHR_TIOCM_DTR)
1651 targ |= TIOCM_DTR;
1652 if (sarg & CHR_TIOCM_RTS)
1653 targ |= TIOCM_RTS;
1654 ioctl(fioc->fd, TIOCMSET, &targ);
1656 break;
1657 default:
1658 return -ENOTSUP;
1660 return 0;
1663 static void qemu_chr_close_tty(CharDriverState *chr)
1665 fd_chr_close(chr);
1668 static CharDriverState *qemu_chr_open_tty_fd(int fd,
1669 ChardevCommon *backend,
1670 Error **errp)
1672 CharDriverState *chr;
1674 tty_serial_init(fd, 115200, 'N', 8, 1);
1675 chr = qemu_chr_open_fd(fd, fd, backend, errp);
1676 chr->chr_ioctl = tty_serial_ioctl;
1677 chr->chr_close = qemu_chr_close_tty;
1678 return chr;
1680 #endif /* __linux__ || __sun__ */
1682 #if defined(__linux__)
1684 #define HAVE_CHARDEV_PARPORT 1
1686 typedef struct {
1687 int fd;
1688 int mode;
1689 } ParallelCharDriver;
1691 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1693 if (s->mode != mode) {
1694 int m = mode;
1695 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1696 return 0;
1697 s->mode = mode;
1699 return 1;
1702 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1704 ParallelCharDriver *drv = chr->opaque;
1705 int fd = drv->fd;
1706 uint8_t b;
1708 switch(cmd) {
1709 case CHR_IOCTL_PP_READ_DATA:
1710 if (ioctl(fd, PPRDATA, &b) < 0)
1711 return -ENOTSUP;
1712 *(uint8_t *)arg = b;
1713 break;
1714 case CHR_IOCTL_PP_WRITE_DATA:
1715 b = *(uint8_t *)arg;
1716 if (ioctl(fd, PPWDATA, &b) < 0)
1717 return -ENOTSUP;
1718 break;
1719 case CHR_IOCTL_PP_READ_CONTROL:
1720 if (ioctl(fd, PPRCONTROL, &b) < 0)
1721 return -ENOTSUP;
1722 /* Linux gives only the lowest bits, and no way to know data
1723 direction! For better compatibility set the fixed upper
1724 bits. */
1725 *(uint8_t *)arg = b | 0xc0;
1726 break;
1727 case CHR_IOCTL_PP_WRITE_CONTROL:
1728 b = *(uint8_t *)arg;
1729 if (ioctl(fd, PPWCONTROL, &b) < 0)
1730 return -ENOTSUP;
1731 break;
1732 case CHR_IOCTL_PP_READ_STATUS:
1733 if (ioctl(fd, PPRSTATUS, &b) < 0)
1734 return -ENOTSUP;
1735 *(uint8_t *)arg = b;
1736 break;
1737 case CHR_IOCTL_PP_DATA_DIR:
1738 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1739 return -ENOTSUP;
1740 break;
1741 case CHR_IOCTL_PP_EPP_READ_ADDR:
1742 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1743 struct ParallelIOArg *parg = arg;
1744 int n = read(fd, parg->buffer, parg->count);
1745 if (n != parg->count) {
1746 return -EIO;
1749 break;
1750 case CHR_IOCTL_PP_EPP_READ:
1751 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1752 struct ParallelIOArg *parg = arg;
1753 int n = read(fd, parg->buffer, parg->count);
1754 if (n != parg->count) {
1755 return -EIO;
1758 break;
1759 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1760 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1761 struct ParallelIOArg *parg = arg;
1762 int n = write(fd, parg->buffer, parg->count);
1763 if (n != parg->count) {
1764 return -EIO;
1767 break;
1768 case CHR_IOCTL_PP_EPP_WRITE:
1769 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1770 struct ParallelIOArg *parg = arg;
1771 int n = write(fd, parg->buffer, parg->count);
1772 if (n != parg->count) {
1773 return -EIO;
1776 break;
1777 default:
1778 return -ENOTSUP;
1780 return 0;
1783 static void pp_close(CharDriverState *chr)
1785 ParallelCharDriver *drv = chr->opaque;
1786 int fd = drv->fd;
1788 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1789 ioctl(fd, PPRELEASE);
1790 close(fd);
1791 g_free(drv);
1792 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1795 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1796 ChardevCommon *backend,
1797 Error **errp)
1799 CharDriverState *chr;
1800 ParallelCharDriver *drv;
1802 if (ioctl(fd, PPCLAIM) < 0) {
1803 error_setg_errno(errp, errno, "not a parallel port");
1804 close(fd);
1805 return NULL;
1808 chr = qemu_chr_alloc(backend, errp);
1809 if (!chr) {
1810 return NULL;
1813 drv = g_new0(ParallelCharDriver, 1);
1814 chr->opaque = drv;
1815 chr->chr_write = null_chr_write;
1816 chr->chr_ioctl = pp_ioctl;
1817 chr->chr_close = pp_close;
1819 drv->fd = fd;
1820 drv->mode = IEEE1284_MODE_COMPAT;
1822 return chr;
1824 #endif /* __linux__ */
1826 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1828 #define HAVE_CHARDEV_PARPORT 1
1830 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1832 int fd = (int)(intptr_t)chr->opaque;
1833 uint8_t b;
1835 switch(cmd) {
1836 case CHR_IOCTL_PP_READ_DATA:
1837 if (ioctl(fd, PPIGDATA, &b) < 0)
1838 return -ENOTSUP;
1839 *(uint8_t *)arg = b;
1840 break;
1841 case CHR_IOCTL_PP_WRITE_DATA:
1842 b = *(uint8_t *)arg;
1843 if (ioctl(fd, PPISDATA, &b) < 0)
1844 return -ENOTSUP;
1845 break;
1846 case CHR_IOCTL_PP_READ_CONTROL:
1847 if (ioctl(fd, PPIGCTRL, &b) < 0)
1848 return -ENOTSUP;
1849 *(uint8_t *)arg = b;
1850 break;
1851 case CHR_IOCTL_PP_WRITE_CONTROL:
1852 b = *(uint8_t *)arg;
1853 if (ioctl(fd, PPISCTRL, &b) < 0)
1854 return -ENOTSUP;
1855 break;
1856 case CHR_IOCTL_PP_READ_STATUS:
1857 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1858 return -ENOTSUP;
1859 *(uint8_t *)arg = b;
1860 break;
1861 default:
1862 return -ENOTSUP;
1864 return 0;
1867 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1868 ChardevCommon *backend,
1869 Error **errp)
1871 CharDriverState *chr;
1873 chr = qemu_chr_alloc(backend, errp);
1874 if (!chr) {
1875 return NULL;
1877 chr->opaque = (void *)(intptr_t)fd;
1878 chr->chr_write = null_chr_write;
1879 chr->chr_ioctl = pp_ioctl;
1880 chr->explicit_be_open = true;
1881 return chr;
1883 #endif
1885 #else /* _WIN32 */
1887 #define HAVE_CHARDEV_SERIAL 1
1889 typedef struct {
1890 int max_size;
1891 HANDLE hcom, hrecv, hsend;
1892 OVERLAPPED orecv;
1893 BOOL fpipe;
1894 DWORD len;
1896 /* Protected by the CharDriverState chr_write_lock. */
1897 OVERLAPPED osend;
1898 } WinCharState;
1900 typedef struct {
1901 HANDLE hStdIn;
1902 HANDLE hInputReadyEvent;
1903 HANDLE hInputDoneEvent;
1904 HANDLE hInputThread;
1905 uint8_t win_stdio_buf;
1906 } WinStdioCharState;
1908 #define NSENDBUF 2048
1909 #define NRECVBUF 2048
1910 #define MAXCONNECT 1
1911 #define NTIMEOUT 5000
1913 static int win_chr_poll(void *opaque);
1914 static int win_chr_pipe_poll(void *opaque);
1916 static void win_chr_close(CharDriverState *chr)
1918 WinCharState *s = chr->opaque;
1920 if (s->hsend) {
1921 CloseHandle(s->hsend);
1922 s->hsend = NULL;
1924 if (s->hrecv) {
1925 CloseHandle(s->hrecv);
1926 s->hrecv = NULL;
1928 if (s->hcom) {
1929 CloseHandle(s->hcom);
1930 s->hcom = NULL;
1932 if (s->fpipe)
1933 qemu_del_polling_cb(win_chr_pipe_poll, chr);
1934 else
1935 qemu_del_polling_cb(win_chr_poll, chr);
1937 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1940 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
1942 WinCharState *s = chr->opaque;
1943 COMMCONFIG comcfg;
1944 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
1945 COMSTAT comstat;
1946 DWORD size;
1947 DWORD err;
1949 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
1950 if (!s->hsend) {
1951 error_setg(errp, "Failed CreateEvent");
1952 goto fail;
1954 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
1955 if (!s->hrecv) {
1956 error_setg(errp, "Failed CreateEvent");
1957 goto fail;
1960 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
1961 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
1962 if (s->hcom == INVALID_HANDLE_VALUE) {
1963 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
1964 s->hcom = NULL;
1965 goto fail;
1968 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
1969 error_setg(errp, "Failed SetupComm");
1970 goto fail;
1973 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
1974 size = sizeof(COMMCONFIG);
1975 GetDefaultCommConfig(filename, &comcfg, &size);
1976 comcfg.dcb.DCBlength = sizeof(DCB);
1977 CommConfigDialog(filename, NULL, &comcfg);
1979 if (!SetCommState(s->hcom, &comcfg.dcb)) {
1980 error_setg(errp, "Failed SetCommState");
1981 goto fail;
1984 if (!SetCommMask(s->hcom, EV_ERR)) {
1985 error_setg(errp, "Failed SetCommMask");
1986 goto fail;
1989 cto.ReadIntervalTimeout = MAXDWORD;
1990 if (!SetCommTimeouts(s->hcom, &cto)) {
1991 error_setg(errp, "Failed SetCommTimeouts");
1992 goto fail;
1995 if (!ClearCommError(s->hcom, &err, &comstat)) {
1996 error_setg(errp, "Failed ClearCommError");
1997 goto fail;
1999 qemu_add_polling_cb(win_chr_poll, chr);
2000 return 0;
2002 fail:
2003 win_chr_close(chr);
2004 return -1;
2007 /* Called with chr_write_lock held. */
2008 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
2010 WinCharState *s = chr->opaque;
2011 DWORD len, ret, size, err;
2013 len = len1;
2014 ZeroMemory(&s->osend, sizeof(s->osend));
2015 s->osend.hEvent = s->hsend;
2016 while (len > 0) {
2017 if (s->hsend)
2018 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
2019 else
2020 ret = WriteFile(s->hcom, buf, len, &size, NULL);
2021 if (!ret) {
2022 err = GetLastError();
2023 if (err == ERROR_IO_PENDING) {
2024 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
2025 if (ret) {
2026 buf += size;
2027 len -= size;
2028 } else {
2029 break;
2031 } else {
2032 break;
2034 } else {
2035 buf += size;
2036 len -= size;
2039 return len1 - len;
2042 static int win_chr_read_poll(CharDriverState *chr)
2044 WinCharState *s = chr->opaque;
2046 s->max_size = qemu_chr_be_can_write(chr);
2047 return s->max_size;
2050 static void win_chr_readfile(CharDriverState *chr)
2052 WinCharState *s = chr->opaque;
2053 int ret, err;
2054 uint8_t buf[READ_BUF_LEN];
2055 DWORD size;
2057 ZeroMemory(&s->orecv, sizeof(s->orecv));
2058 s->orecv.hEvent = s->hrecv;
2059 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2060 if (!ret) {
2061 err = GetLastError();
2062 if (err == ERROR_IO_PENDING) {
2063 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2067 if (size > 0) {
2068 qemu_chr_be_write(chr, buf, size);
2072 static void win_chr_read(CharDriverState *chr)
2074 WinCharState *s = chr->opaque;
2076 if (s->len > s->max_size)
2077 s->len = s->max_size;
2078 if (s->len == 0)
2079 return;
2081 win_chr_readfile(chr);
2084 static int win_chr_poll(void *opaque)
2086 CharDriverState *chr = opaque;
2087 WinCharState *s = chr->opaque;
2088 COMSTAT status;
2089 DWORD comerr;
2091 ClearCommError(s->hcom, &comerr, &status);
2092 if (status.cbInQue > 0) {
2093 s->len = status.cbInQue;
2094 win_chr_read_poll(chr);
2095 win_chr_read(chr);
2096 return 1;
2098 return 0;
2101 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2102 ChardevCommon *backend,
2103 Error **errp)
2105 CharDriverState *chr;
2106 WinCharState *s;
2108 chr = qemu_chr_alloc(backend, errp);
2109 if (!chr) {
2110 return NULL;
2112 s = g_new0(WinCharState, 1);
2113 chr->opaque = s;
2114 chr->chr_write = win_chr_write;
2115 chr->chr_close = win_chr_close;
2117 if (win_chr_init(chr, filename, errp) < 0) {
2118 g_free(s);
2119 qemu_chr_free_common(chr);
2120 return NULL;
2122 return chr;
2125 static int win_chr_pipe_poll(void *opaque)
2127 CharDriverState *chr = opaque;
2128 WinCharState *s = chr->opaque;
2129 DWORD size;
2131 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2132 if (size > 0) {
2133 s->len = size;
2134 win_chr_read_poll(chr);
2135 win_chr_read(chr);
2136 return 1;
2138 return 0;
2141 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2142 Error **errp)
2144 WinCharState *s = chr->opaque;
2145 OVERLAPPED ov;
2146 int ret;
2147 DWORD size;
2148 char *openname;
2150 s->fpipe = TRUE;
2152 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2153 if (!s->hsend) {
2154 error_setg(errp, "Failed CreateEvent");
2155 goto fail;
2157 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2158 if (!s->hrecv) {
2159 error_setg(errp, "Failed CreateEvent");
2160 goto fail;
2163 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2164 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2165 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2166 PIPE_WAIT,
2167 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2168 g_free(openname);
2169 if (s->hcom == INVALID_HANDLE_VALUE) {
2170 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2171 s->hcom = NULL;
2172 goto fail;
2175 ZeroMemory(&ov, sizeof(ov));
2176 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2177 ret = ConnectNamedPipe(s->hcom, &ov);
2178 if (ret) {
2179 error_setg(errp, "Failed ConnectNamedPipe");
2180 goto fail;
2183 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2184 if (!ret) {
2185 error_setg(errp, "Failed GetOverlappedResult");
2186 if (ov.hEvent) {
2187 CloseHandle(ov.hEvent);
2188 ov.hEvent = NULL;
2190 goto fail;
2193 if (ov.hEvent) {
2194 CloseHandle(ov.hEvent);
2195 ov.hEvent = NULL;
2197 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2198 return 0;
2200 fail:
2201 win_chr_close(chr);
2202 return -1;
2206 static CharDriverState *qemu_chr_open_pipe(const char *id,
2207 ChardevBackend *backend,
2208 ChardevReturn *ret,
2209 Error **errp)
2211 ChardevHostdev *opts = backend->u.pipe.data;
2212 const char *filename = opts->device;
2213 CharDriverState *chr;
2214 WinCharState *s;
2215 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
2217 chr = qemu_chr_alloc(common, errp);
2218 if (!chr) {
2219 return NULL;
2221 s = g_new0(WinCharState, 1);
2222 chr->opaque = s;
2223 chr->chr_write = win_chr_write;
2224 chr->chr_close = win_chr_close;
2226 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2227 g_free(s);
2228 qemu_chr_free_common(chr);
2229 return NULL;
2231 return chr;
2234 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out,
2235 ChardevCommon *backend,
2236 Error **errp)
2238 CharDriverState *chr;
2239 WinCharState *s;
2241 chr = qemu_chr_alloc(backend, errp);
2242 if (!chr) {
2243 return NULL;
2245 s = g_new0(WinCharState, 1);
2246 s->hcom = fd_out;
2247 chr->opaque = s;
2248 chr->chr_write = win_chr_write;
2249 return chr;
2252 static CharDriverState *qemu_chr_open_win_con(const char *id,
2253 ChardevBackend *backend,
2254 ChardevReturn *ret,
2255 Error **errp)
2257 ChardevCommon *common = backend->u.console.data;
2258 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE),
2259 common, errp);
2262 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2264 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2265 DWORD dwSize;
2266 int len1;
2268 len1 = len;
2270 while (len1 > 0) {
2271 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2272 break;
2274 buf += dwSize;
2275 len1 -= dwSize;
2278 return len - len1;
2281 static void win_stdio_wait_func(void *opaque)
2283 CharDriverState *chr = opaque;
2284 WinStdioCharState *stdio = chr->opaque;
2285 INPUT_RECORD buf[4];
2286 int ret;
2287 DWORD dwSize;
2288 int i;
2290 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2292 if (!ret) {
2293 /* Avoid error storm */
2294 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2295 return;
2298 for (i = 0; i < dwSize; i++) {
2299 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2301 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2302 int j;
2303 if (kev->uChar.AsciiChar != 0) {
2304 for (j = 0; j < kev->wRepeatCount; j++) {
2305 if (qemu_chr_be_can_write(chr)) {
2306 uint8_t c = kev->uChar.AsciiChar;
2307 qemu_chr_be_write(chr, &c, 1);
2315 static DWORD WINAPI win_stdio_thread(LPVOID param)
2317 CharDriverState *chr = param;
2318 WinStdioCharState *stdio = chr->opaque;
2319 int ret;
2320 DWORD dwSize;
2322 while (1) {
2324 /* Wait for one byte */
2325 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2327 /* Exit in case of error, continue if nothing read */
2328 if (!ret) {
2329 break;
2331 if (!dwSize) {
2332 continue;
2335 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2336 if (stdio->win_stdio_buf == '\r') {
2337 continue;
2340 /* Signal the main thread and wait until the byte was eaten */
2341 if (!SetEvent(stdio->hInputReadyEvent)) {
2342 break;
2344 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2345 != WAIT_OBJECT_0) {
2346 break;
2350 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2351 return 0;
2354 static void win_stdio_thread_wait_func(void *opaque)
2356 CharDriverState *chr = opaque;
2357 WinStdioCharState *stdio = chr->opaque;
2359 if (qemu_chr_be_can_write(chr)) {
2360 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2363 SetEvent(stdio->hInputDoneEvent);
2366 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2368 WinStdioCharState *stdio = chr->opaque;
2369 DWORD dwMode = 0;
2371 GetConsoleMode(stdio->hStdIn, &dwMode);
2373 if (echo) {
2374 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2375 } else {
2376 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2380 static void win_stdio_close(CharDriverState *chr)
2382 WinStdioCharState *stdio = chr->opaque;
2384 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2385 CloseHandle(stdio->hInputReadyEvent);
2387 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2388 CloseHandle(stdio->hInputDoneEvent);
2390 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2391 TerminateThread(stdio->hInputThread, 0);
2394 g_free(chr->opaque);
2395 g_free(chr);
2398 static CharDriverState *qemu_chr_open_stdio(const char *id,
2399 ChardevBackend *backend,
2400 ChardevReturn *ret,
2401 Error **errp)
2403 CharDriverState *chr;
2404 WinStdioCharState *stdio;
2405 DWORD dwMode;
2406 int is_console = 0;
2407 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio.data);
2409 chr = qemu_chr_alloc(common, errp);
2410 if (!chr) {
2411 return NULL;
2413 stdio = g_new0(WinStdioCharState, 1);
2415 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2416 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2417 error_setg(errp, "cannot open stdio: invalid handle");
2418 return NULL;
2421 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2423 chr->opaque = stdio;
2424 chr->chr_write = win_stdio_write;
2425 chr->chr_close = win_stdio_close;
2427 if (is_console) {
2428 if (qemu_add_wait_object(stdio->hStdIn,
2429 win_stdio_wait_func, chr)) {
2430 error_setg(errp, "qemu_add_wait_object: failed");
2431 goto err1;
2433 } else {
2434 DWORD dwId;
2436 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2437 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2438 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2439 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2440 error_setg(errp, "cannot create event");
2441 goto err2;
2443 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2444 win_stdio_thread_wait_func, chr)) {
2445 error_setg(errp, "qemu_add_wait_object: failed");
2446 goto err2;
2448 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2449 chr, 0, &dwId);
2451 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2452 error_setg(errp, "cannot create stdio thread");
2453 goto err3;
2457 dwMode |= ENABLE_LINE_INPUT;
2459 if (is_console) {
2460 /* set the terminal in raw mode */
2461 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2462 dwMode |= ENABLE_PROCESSED_INPUT;
2465 SetConsoleMode(stdio->hStdIn, dwMode);
2467 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2468 qemu_chr_fe_set_echo(chr, false);
2470 return chr;
2472 err3:
2473 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2474 err2:
2475 CloseHandle(stdio->hInputReadyEvent);
2476 CloseHandle(stdio->hInputDoneEvent);
2477 err1:
2478 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2479 return NULL;
2481 #endif /* !_WIN32 */
2484 /***********************************************************/
2485 /* UDP Net console */
2487 typedef struct {
2488 QIOChannel *ioc;
2489 uint8_t buf[READ_BUF_LEN];
2490 int bufcnt;
2491 int bufptr;
2492 int max_size;
2493 } NetCharDriver;
2495 /* Called with chr_write_lock held. */
2496 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2498 NetCharDriver *s = chr->opaque;
2500 return qio_channel_write(
2501 s->ioc, (const char *)buf, len, NULL);
2504 static int udp_chr_read_poll(void *opaque)
2506 CharDriverState *chr = opaque;
2507 NetCharDriver *s = chr->opaque;
2509 s->max_size = qemu_chr_be_can_write(chr);
2511 /* If there were any stray characters in the queue process them
2512 * first
2514 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2515 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2516 s->bufptr++;
2517 s->max_size = qemu_chr_be_can_write(chr);
2519 return s->max_size;
2522 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2524 CharDriverState *chr = opaque;
2525 NetCharDriver *s = chr->opaque;
2526 ssize_t ret;
2528 if (s->max_size == 0) {
2529 return TRUE;
2531 ret = qio_channel_read(
2532 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2533 if (ret <= 0) {
2534 remove_fd_in_watch(chr);
2535 return FALSE;
2537 s->bufcnt = ret;
2539 s->bufptr = 0;
2540 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2541 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2542 s->bufptr++;
2543 s->max_size = qemu_chr_be_can_write(chr);
2546 return TRUE;
2549 static void udp_chr_update_read_handler(CharDriverState *chr)
2551 NetCharDriver *s = chr->opaque;
2553 remove_fd_in_watch(chr);
2554 if (s->ioc) {
2555 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2556 udp_chr_read_poll,
2557 udp_chr_read, chr);
2561 static void udp_chr_close(CharDriverState *chr)
2563 NetCharDriver *s = chr->opaque;
2565 remove_fd_in_watch(chr);
2566 if (s->ioc) {
2567 object_unref(OBJECT(s->ioc));
2569 g_free(s);
2570 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2573 static CharDriverState *qemu_chr_open_udp(QIOChannelSocket *sioc,
2574 ChardevCommon *backend,
2575 Error **errp)
2577 CharDriverState *chr = NULL;
2578 NetCharDriver *s = NULL;
2580 chr = qemu_chr_alloc(backend, errp);
2581 if (!chr) {
2582 return NULL;
2584 s = g_new0(NetCharDriver, 1);
2586 s->ioc = QIO_CHANNEL(sioc);
2587 s->bufcnt = 0;
2588 s->bufptr = 0;
2589 chr->opaque = s;
2590 chr->chr_write = udp_chr_write;
2591 chr->chr_update_read_handler = udp_chr_update_read_handler;
2592 chr->chr_close = udp_chr_close;
2593 /* be isn't opened until we get a connection */
2594 chr->explicit_be_open = true;
2595 return chr;
2598 /***********************************************************/
2599 /* TCP Net console */
2601 typedef struct {
2602 QIOChannel *ioc; /* Client I/O channel */
2603 QIOChannelSocket *sioc; /* Client master channel */
2604 QIOChannelSocket *listen_ioc;
2605 guint listen_tag;
2606 QCryptoTLSCreds *tls_creds;
2607 int connected;
2608 int max_size;
2609 int do_telnetopt;
2610 int do_nodelay;
2611 int is_unix;
2612 int *read_msgfds;
2613 size_t read_msgfds_num;
2614 int *write_msgfds;
2615 size_t write_msgfds_num;
2617 SocketAddress *addr;
2618 bool is_listen;
2619 bool is_telnet;
2621 guint reconnect_timer;
2622 int64_t reconnect_time;
2623 bool connect_err_reported;
2624 } TCPCharDriver;
2626 static gboolean socket_reconnect_timeout(gpointer opaque);
2628 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2630 TCPCharDriver *s = chr->opaque;
2631 assert(s->connected == 0);
2632 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2633 socket_reconnect_timeout, chr);
2636 static void check_report_connect_error(CharDriverState *chr,
2637 Error *err)
2639 TCPCharDriver *s = chr->opaque;
2641 if (!s->connect_err_reported) {
2642 error_report("Unable to connect character device %s: %s",
2643 chr->label, error_get_pretty(err));
2644 s->connect_err_reported = true;
2646 qemu_chr_socket_restart_timer(chr);
2649 static gboolean tcp_chr_accept(QIOChannel *chan,
2650 GIOCondition cond,
2651 void *opaque);
2653 /* Called with chr_write_lock held. */
2654 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2656 TCPCharDriver *s = chr->opaque;
2657 if (s->connected) {
2658 int ret = io_channel_send_full(s->ioc, buf, len,
2659 s->write_msgfds,
2660 s->write_msgfds_num);
2662 /* free the written msgfds, no matter what */
2663 if (s->write_msgfds_num) {
2664 g_free(s->write_msgfds);
2665 s->write_msgfds = 0;
2666 s->write_msgfds_num = 0;
2669 return ret;
2670 } else {
2671 /* XXX: indicate an error ? */
2672 return len;
2676 static int tcp_chr_read_poll(void *opaque)
2678 CharDriverState *chr = opaque;
2679 TCPCharDriver *s = chr->opaque;
2680 if (!s->connected)
2681 return 0;
2682 s->max_size = qemu_chr_be_can_write(chr);
2683 return s->max_size;
2686 #define IAC 255
2687 #define IAC_BREAK 243
2688 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2689 TCPCharDriver *s,
2690 uint8_t *buf, int *size)
2692 /* Handle any telnet client's basic IAC options to satisfy char by
2693 * char mode with no echo. All IAC options will be removed from
2694 * the buf and the do_telnetopt variable will be used to track the
2695 * state of the width of the IAC information.
2697 * IAC commands come in sets of 3 bytes with the exception of the
2698 * "IAC BREAK" command and the double IAC.
2701 int i;
2702 int j = 0;
2704 for (i = 0; i < *size; i++) {
2705 if (s->do_telnetopt > 1) {
2706 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2707 /* Double IAC means send an IAC */
2708 if (j != i)
2709 buf[j] = buf[i];
2710 j++;
2711 s->do_telnetopt = 1;
2712 } else {
2713 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2714 /* Handle IAC break commands by sending a serial break */
2715 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2716 s->do_telnetopt++;
2718 s->do_telnetopt++;
2720 if (s->do_telnetopt >= 4) {
2721 s->do_telnetopt = 1;
2723 } else {
2724 if ((unsigned char)buf[i] == IAC) {
2725 s->do_telnetopt = 2;
2726 } else {
2727 if (j != i)
2728 buf[j] = buf[i];
2729 j++;
2733 *size = j;
2736 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2738 TCPCharDriver *s = chr->opaque;
2739 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2741 assert(num <= TCP_MAX_FDS);
2743 if (to_copy) {
2744 int i;
2746 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2748 /* Close unused fds */
2749 for (i = to_copy; i < s->read_msgfds_num; i++) {
2750 close(s->read_msgfds[i]);
2753 g_free(s->read_msgfds);
2754 s->read_msgfds = 0;
2755 s->read_msgfds_num = 0;
2758 return to_copy;
2761 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2763 TCPCharDriver *s = chr->opaque;
2765 if (!qio_channel_has_feature(s->ioc,
2766 QIO_CHANNEL_FEATURE_FD_PASS)) {
2767 return -1;
2769 /* clear old pending fd array */
2770 g_free(s->write_msgfds);
2771 s->write_msgfds = NULL;
2773 if (num) {
2774 s->write_msgfds = g_new(int, num);
2775 memcpy(s->write_msgfds, fds, num * sizeof(int));
2778 s->write_msgfds_num = num;
2780 return 0;
2783 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2785 TCPCharDriver *s = chr->opaque;
2786 struct iovec iov = { .iov_base = buf, .iov_len = len };
2787 int ret;
2788 size_t i;
2789 int *msgfds = NULL;
2790 size_t msgfds_num = 0;
2792 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2793 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2794 &msgfds, &msgfds_num,
2795 NULL);
2796 } else {
2797 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2798 NULL, NULL,
2799 NULL);
2802 if (msgfds_num) {
2803 /* close and clean read_msgfds */
2804 for (i = 0; i < s->read_msgfds_num; i++) {
2805 close(s->read_msgfds[i]);
2808 if (s->read_msgfds_num) {
2809 g_free(s->read_msgfds);
2812 s->read_msgfds = msgfds;
2813 s->read_msgfds_num = msgfds_num;
2816 for (i = 0; i < s->read_msgfds_num; i++) {
2817 int fd = s->read_msgfds[i];
2818 if (fd < 0) {
2819 continue;
2822 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2823 qemu_set_block(fd);
2825 #ifndef MSG_CMSG_CLOEXEC
2826 qemu_set_cloexec(fd);
2827 #endif
2830 return ret;
2833 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2835 TCPCharDriver *s = chr->opaque;
2836 return qio_channel_create_watch(s->ioc, cond);
2839 static void tcp_chr_disconnect(CharDriverState *chr)
2841 TCPCharDriver *s = chr->opaque;
2843 if (!s->connected) {
2844 return;
2847 s->connected = 0;
2848 if (s->listen_ioc) {
2849 s->listen_tag = qio_channel_add_watch(
2850 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
2852 tcp_set_msgfds(chr, NULL, 0);
2853 remove_fd_in_watch(chr);
2854 object_unref(OBJECT(s->sioc));
2855 s->sioc = NULL;
2856 object_unref(OBJECT(s->ioc));
2857 s->ioc = NULL;
2858 g_free(chr->filename);
2859 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
2860 s->is_listen, s->is_telnet);
2861 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2862 if (s->reconnect_time) {
2863 qemu_chr_socket_restart_timer(chr);
2867 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2869 CharDriverState *chr = opaque;
2870 TCPCharDriver *s = chr->opaque;
2871 uint8_t buf[READ_BUF_LEN];
2872 int len, size;
2874 if (!s->connected || s->max_size <= 0) {
2875 return TRUE;
2877 len = sizeof(buf);
2878 if (len > s->max_size)
2879 len = s->max_size;
2880 size = tcp_chr_recv(chr, (void *)buf, len);
2881 if (size == 0 || size == -1) {
2882 /* connection closed */
2883 tcp_chr_disconnect(chr);
2884 } else if (size > 0) {
2885 if (s->do_telnetopt)
2886 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
2887 if (size > 0)
2888 qemu_chr_be_write(chr, buf, size);
2891 return TRUE;
2894 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
2896 TCPCharDriver *s = chr->opaque;
2897 int size;
2899 if (!s->connected) {
2900 return 0;
2903 size = tcp_chr_recv(chr, (void *) buf, len);
2904 if (size == 0) {
2905 /* connection closed */
2906 tcp_chr_disconnect(chr);
2909 return size;
2912 static void tcp_chr_connect(void *opaque)
2914 CharDriverState *chr = opaque;
2915 TCPCharDriver *s = chr->opaque;
2917 g_free(chr->filename);
2918 chr->filename = sockaddr_to_str(
2919 &s->sioc->localAddr, s->sioc->localAddrLen,
2920 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
2921 s->is_listen, s->is_telnet);
2923 s->connected = 1;
2924 if (s->ioc) {
2925 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2926 tcp_chr_read_poll,
2927 tcp_chr_read, chr);
2929 qemu_chr_be_generic_open(chr);
2932 static void tcp_chr_update_read_handler(CharDriverState *chr)
2934 TCPCharDriver *s = chr->opaque;
2936 if (!s->connected) {
2937 return;
2940 remove_fd_in_watch(chr);
2941 if (s->ioc) {
2942 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2943 tcp_chr_read_poll,
2944 tcp_chr_read, chr);
2948 typedef struct {
2949 CharDriverState *chr;
2950 char buf[12];
2951 size_t buflen;
2952 } TCPCharDriverTelnetInit;
2954 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
2955 GIOCondition cond G_GNUC_UNUSED,
2956 gpointer user_data)
2958 TCPCharDriverTelnetInit *init = user_data;
2959 ssize_t ret;
2961 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
2962 if (ret < 0) {
2963 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2964 ret = 0;
2965 } else {
2966 tcp_chr_disconnect(init->chr);
2967 return FALSE;
2970 init->buflen -= ret;
2972 if (init->buflen == 0) {
2973 tcp_chr_connect(init->chr);
2974 return FALSE;
2977 memmove(init->buf, init->buf + ret, init->buflen);
2979 return TRUE;
2982 static void tcp_chr_telnet_init(CharDriverState *chr)
2984 TCPCharDriver *s = chr->opaque;
2985 TCPCharDriverTelnetInit *init =
2986 g_new0(TCPCharDriverTelnetInit, 1);
2987 size_t n = 0;
2989 init->chr = chr;
2990 init->buflen = 12;
2992 #define IACSET(x, a, b, c) \
2993 do { \
2994 x[n++] = a; \
2995 x[n++] = b; \
2996 x[n++] = c; \
2997 } while (0)
2999 /* Prep the telnet negotion to put telnet in binary,
3000 * no echo, single char mode */
3001 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3002 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3003 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3004 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3006 #undef IACSET
3008 qio_channel_add_watch(
3009 s->ioc, G_IO_OUT,
3010 tcp_chr_telnet_init_io,
3011 init, NULL);
3015 static void tcp_chr_tls_handshake(Object *source,
3016 Error *err,
3017 gpointer user_data)
3019 CharDriverState *chr = user_data;
3020 TCPCharDriver *s = chr->opaque;
3022 if (err) {
3023 tcp_chr_disconnect(chr);
3024 } else {
3025 if (s->do_telnetopt) {
3026 tcp_chr_telnet_init(chr);
3027 } else {
3028 tcp_chr_connect(chr);
3034 static void tcp_chr_tls_init(CharDriverState *chr)
3036 TCPCharDriver *s = chr->opaque;
3037 QIOChannelTLS *tioc;
3038 Error *err = NULL;
3040 if (s->is_listen) {
3041 tioc = qio_channel_tls_new_server(
3042 s->ioc, s->tls_creds,
3043 NULL, /* XXX Use an ACL */
3044 &err);
3045 } else {
3046 tioc = qio_channel_tls_new_client(
3047 s->ioc, s->tls_creds,
3048 s->addr->u.inet.data->host,
3049 &err);
3051 if (tioc == NULL) {
3052 error_free(err);
3053 tcp_chr_disconnect(chr);
3055 object_unref(OBJECT(s->ioc));
3056 s->ioc = QIO_CHANNEL(tioc);
3058 qio_channel_tls_handshake(tioc,
3059 tcp_chr_tls_handshake,
3060 chr,
3061 NULL);
3065 static int tcp_chr_new_client(CharDriverState *chr, QIOChannelSocket *sioc)
3067 TCPCharDriver *s = chr->opaque;
3068 if (s->ioc != NULL) {
3069 return -1;
3072 s->ioc = QIO_CHANNEL(sioc);
3073 object_ref(OBJECT(sioc));
3074 s->sioc = sioc;
3075 object_ref(OBJECT(sioc));
3077 if (s->do_nodelay) {
3078 qio_channel_set_delay(s->ioc, false);
3080 if (s->listen_tag) {
3081 g_source_remove(s->listen_tag);
3082 s->listen_tag = 0;
3085 if (s->tls_creds) {
3086 tcp_chr_tls_init(chr);
3087 } else {
3088 if (s->do_telnetopt) {
3089 tcp_chr_telnet_init(chr);
3090 } else {
3091 tcp_chr_connect(chr);
3095 return 0;
3099 static int tcp_chr_add_client(CharDriverState *chr, int fd)
3101 int ret;
3102 QIOChannelSocket *sioc;
3104 sioc = qio_channel_socket_new_fd(fd, NULL);
3105 if (!sioc) {
3106 return -1;
3108 qio_channel_set_blocking(QIO_CHANNEL(sioc), false, NULL);
3109 ret = tcp_chr_new_client(chr, sioc);
3110 object_unref(OBJECT(sioc));
3111 return ret;
3114 static gboolean tcp_chr_accept(QIOChannel *channel,
3115 GIOCondition cond,
3116 void *opaque)
3118 CharDriverState *chr = opaque;
3119 QIOChannelSocket *sioc;
3121 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3122 NULL);
3123 if (!sioc) {
3124 return TRUE;
3127 tcp_chr_new_client(chr, sioc);
3129 object_unref(OBJECT(sioc));
3131 return TRUE;
3134 static void tcp_chr_close(CharDriverState *chr)
3136 TCPCharDriver *s = chr->opaque;
3137 int i;
3139 if (s->reconnect_timer) {
3140 g_source_remove(s->reconnect_timer);
3141 s->reconnect_timer = 0;
3143 qapi_free_SocketAddress(s->addr);
3144 remove_fd_in_watch(chr);
3145 if (s->ioc) {
3146 object_unref(OBJECT(s->ioc));
3148 if (s->listen_tag) {
3149 g_source_remove(s->listen_tag);
3150 s->listen_tag = 0;
3152 if (s->listen_ioc) {
3153 object_unref(OBJECT(s->listen_ioc));
3155 if (s->read_msgfds_num) {
3156 for (i = 0; i < s->read_msgfds_num; i++) {
3157 close(s->read_msgfds[i]);
3159 g_free(s->read_msgfds);
3161 if (s->tls_creds) {
3162 object_unref(OBJECT(s->tls_creds));
3164 if (s->write_msgfds_num) {
3165 g_free(s->write_msgfds);
3167 g_free(s);
3168 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3172 static void qemu_chr_socket_connected(Object *src, Error *err, void *opaque)
3174 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(src);
3175 CharDriverState *chr = opaque;
3176 TCPCharDriver *s = chr->opaque;
3178 if (err) {
3179 check_report_connect_error(chr, err);
3180 object_unref(src);
3181 return;
3184 s->connect_err_reported = false;
3185 tcp_chr_new_client(chr, sioc);
3186 object_unref(OBJECT(sioc));
3190 /*********************************************************/
3191 /* Ring buffer chardev */
3193 typedef struct {
3194 size_t size;
3195 size_t prod;
3196 size_t cons;
3197 uint8_t *cbuf;
3198 } RingBufCharDriver;
3200 static size_t ringbuf_count(const CharDriverState *chr)
3202 const RingBufCharDriver *d = chr->opaque;
3204 return d->prod - d->cons;
3207 /* Called with chr_write_lock held. */
3208 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3210 RingBufCharDriver *d = chr->opaque;
3211 int i;
3213 if (!buf || (len < 0)) {
3214 return -1;
3217 for (i = 0; i < len; i++ ) {
3218 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3219 if (d->prod - d->cons > d->size) {
3220 d->cons = d->prod - d->size;
3224 return 0;
3227 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3229 RingBufCharDriver *d = chr->opaque;
3230 int i;
3232 qemu_mutex_lock(&chr->chr_write_lock);
3233 for (i = 0; i < len && d->cons != d->prod; i++) {
3234 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3236 qemu_mutex_unlock(&chr->chr_write_lock);
3238 return i;
3241 static void ringbuf_chr_close(struct CharDriverState *chr)
3243 RingBufCharDriver *d = chr->opaque;
3245 g_free(d->cbuf);
3246 g_free(d);
3247 chr->opaque = NULL;
3250 static CharDriverState *qemu_chr_open_ringbuf(const char *id,
3251 ChardevBackend *backend,
3252 ChardevReturn *ret,
3253 Error **errp)
3255 ChardevRingbuf *opts = backend->u.ringbuf.data;
3256 ChardevCommon *common = qapi_ChardevRingbuf_base(opts);
3257 CharDriverState *chr;
3258 RingBufCharDriver *d;
3260 chr = qemu_chr_alloc(common, errp);
3261 if (!chr) {
3262 return NULL;
3264 d = g_malloc(sizeof(*d));
3266 d->size = opts->has_size ? opts->size : 65536;
3268 /* The size must be power of 2 */
3269 if (d->size & (d->size - 1)) {
3270 error_setg(errp, "size of ringbuf chardev must be power of two");
3271 goto fail;
3274 d->prod = 0;
3275 d->cons = 0;
3276 d->cbuf = g_malloc0(d->size);
3278 chr->opaque = d;
3279 chr->chr_write = ringbuf_chr_write;
3280 chr->chr_close = ringbuf_chr_close;
3282 return chr;
3284 fail:
3285 g_free(d);
3286 qemu_chr_free_common(chr);
3287 return NULL;
3290 bool chr_is_ringbuf(const CharDriverState *chr)
3292 return chr->chr_write == ringbuf_chr_write;
3295 void qmp_ringbuf_write(const char *device, const char *data,
3296 bool has_format, enum DataFormat format,
3297 Error **errp)
3299 CharDriverState *chr;
3300 const uint8_t *write_data;
3301 int ret;
3302 gsize write_count;
3304 chr = qemu_chr_find(device);
3305 if (!chr) {
3306 error_setg(errp, "Device '%s' not found", device);
3307 return;
3310 if (!chr_is_ringbuf(chr)) {
3311 error_setg(errp,"%s is not a ringbuf device", device);
3312 return;
3315 if (has_format && (format == DATA_FORMAT_BASE64)) {
3316 write_data = qbase64_decode(data, -1,
3317 &write_count,
3318 errp);
3319 if (!write_data) {
3320 return;
3322 } else {
3323 write_data = (uint8_t *)data;
3324 write_count = strlen(data);
3327 ret = ringbuf_chr_write(chr, write_data, write_count);
3329 if (write_data != (uint8_t *)data) {
3330 g_free((void *)write_data);
3333 if (ret < 0) {
3334 error_setg(errp, "Failed to write to device %s", device);
3335 return;
3339 char *qmp_ringbuf_read(const char *device, int64_t size,
3340 bool has_format, enum DataFormat format,
3341 Error **errp)
3343 CharDriverState *chr;
3344 uint8_t *read_data;
3345 size_t count;
3346 char *data;
3348 chr = qemu_chr_find(device);
3349 if (!chr) {
3350 error_setg(errp, "Device '%s' not found", device);
3351 return NULL;
3354 if (!chr_is_ringbuf(chr)) {
3355 error_setg(errp,"%s is not a ringbuf device", device);
3356 return NULL;
3359 if (size <= 0) {
3360 error_setg(errp, "size must be greater than zero");
3361 return NULL;
3364 count = ringbuf_count(chr);
3365 size = size > count ? count : size;
3366 read_data = g_malloc(size + 1);
3368 ringbuf_chr_read(chr, read_data, size);
3370 if (has_format && (format == DATA_FORMAT_BASE64)) {
3371 data = g_base64_encode(read_data, size);
3372 g_free(read_data);
3373 } else {
3375 * FIXME should read only complete, valid UTF-8 characters up
3376 * to @size bytes. Invalid sequences should be replaced by a
3377 * suitable replacement character. Except when (and only
3378 * when) ring buffer lost characters since last read, initial
3379 * continuation characters should be dropped.
3381 read_data[size] = 0;
3382 data = (char *)read_data;
3385 return data;
3388 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3390 char host[65], port[33], width[8], height[8];
3391 int pos;
3392 const char *p;
3393 QemuOpts *opts;
3394 Error *local_err = NULL;
3396 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3397 if (local_err) {
3398 error_report_err(local_err);
3399 return NULL;
3402 if (strstart(filename, "mon:", &p)) {
3403 filename = p;
3404 qemu_opt_set(opts, "mux", "on", &error_abort);
3405 if (strcmp(filename, "stdio") == 0) {
3406 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3407 * but pass it to the guest. Handle this only for compat syntax,
3408 * for -chardev syntax we have special option for this.
3409 * This is what -nographic did, redirecting+muxing serial+monitor
3410 * to stdio causing Ctrl+C to be passed to guest. */
3411 qemu_opt_set(opts, "signal", "off", &error_abort);
3415 if (strcmp(filename, "null") == 0 ||
3416 strcmp(filename, "pty") == 0 ||
3417 strcmp(filename, "msmouse") == 0 ||
3418 strcmp(filename, "braille") == 0 ||
3419 strcmp(filename, "testdev") == 0 ||
3420 strcmp(filename, "stdio") == 0) {
3421 qemu_opt_set(opts, "backend", filename, &error_abort);
3422 return opts;
3424 if (strstart(filename, "vc", &p)) {
3425 qemu_opt_set(opts, "backend", "vc", &error_abort);
3426 if (*p == ':') {
3427 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3428 /* pixels */
3429 qemu_opt_set(opts, "width", width, &error_abort);
3430 qemu_opt_set(opts, "height", height, &error_abort);
3431 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3432 /* chars */
3433 qemu_opt_set(opts, "cols", width, &error_abort);
3434 qemu_opt_set(opts, "rows", height, &error_abort);
3435 } else {
3436 goto fail;
3439 return opts;
3441 if (strcmp(filename, "con:") == 0) {
3442 qemu_opt_set(opts, "backend", "console", &error_abort);
3443 return opts;
3445 if (strstart(filename, "COM", NULL)) {
3446 qemu_opt_set(opts, "backend", "serial", &error_abort);
3447 qemu_opt_set(opts, "path", filename, &error_abort);
3448 return opts;
3450 if (strstart(filename, "file:", &p)) {
3451 qemu_opt_set(opts, "backend", "file", &error_abort);
3452 qemu_opt_set(opts, "path", p, &error_abort);
3453 return opts;
3455 if (strstart(filename, "pipe:", &p)) {
3456 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3457 qemu_opt_set(opts, "path", p, &error_abort);
3458 return opts;
3460 if (strstart(filename, "tcp:", &p) ||
3461 strstart(filename, "telnet:", &p)) {
3462 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3463 host[0] = 0;
3464 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3465 goto fail;
3467 qemu_opt_set(opts, "backend", "socket", &error_abort);
3468 qemu_opt_set(opts, "host", host, &error_abort);
3469 qemu_opt_set(opts, "port", port, &error_abort);
3470 if (p[pos] == ',') {
3471 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3472 if (local_err) {
3473 error_report_err(local_err);
3474 goto fail;
3477 if (strstart(filename, "telnet:", &p))
3478 qemu_opt_set(opts, "telnet", "on", &error_abort);
3479 return opts;
3481 if (strstart(filename, "udp:", &p)) {
3482 qemu_opt_set(opts, "backend", "udp", &error_abort);
3483 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3484 host[0] = 0;
3485 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3486 goto fail;
3489 qemu_opt_set(opts, "host", host, &error_abort);
3490 qemu_opt_set(opts, "port", port, &error_abort);
3491 if (p[pos] == '@') {
3492 p += pos + 1;
3493 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3494 host[0] = 0;
3495 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3496 goto fail;
3499 qemu_opt_set(opts, "localaddr", host, &error_abort);
3500 qemu_opt_set(opts, "localport", port, &error_abort);
3502 return opts;
3504 if (strstart(filename, "unix:", &p)) {
3505 qemu_opt_set(opts, "backend", "socket", &error_abort);
3506 qemu_opts_do_parse(opts, p, "path", &local_err);
3507 if (local_err) {
3508 error_report_err(local_err);
3509 goto fail;
3511 return opts;
3513 if (strstart(filename, "/dev/parport", NULL) ||
3514 strstart(filename, "/dev/ppi", NULL)) {
3515 qemu_opt_set(opts, "backend", "parport", &error_abort);
3516 qemu_opt_set(opts, "path", filename, &error_abort);
3517 return opts;
3519 if (strstart(filename, "/dev/", NULL)) {
3520 qemu_opt_set(opts, "backend", "tty", &error_abort);
3521 qemu_opt_set(opts, "path", filename, &error_abort);
3522 return opts;
3525 fail:
3526 qemu_opts_del(opts);
3527 return NULL;
3530 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3532 const char *logfile = qemu_opt_get(opts, "logfile");
3534 backend->has_logfile = logfile != NULL;
3535 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3537 backend->has_logappend = true;
3538 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3542 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3543 Error **errp)
3545 const char *path = qemu_opt_get(opts, "path");
3546 ChardevFile *file;
3548 if (path == NULL) {
3549 error_setg(errp, "chardev: file: no filename given");
3550 return;
3552 file = backend->u.file.data = g_new0(ChardevFile, 1);
3553 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3554 file->out = g_strdup(path);
3556 file->has_append = true;
3557 file->append = qemu_opt_get_bool(opts, "append", false);
3560 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3561 Error **errp)
3563 ChardevStdio *stdio;
3565 stdio = backend->u.stdio.data = g_new0(ChardevStdio, 1);
3566 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3567 stdio->has_signal = true;
3568 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3571 #ifdef HAVE_CHARDEV_SERIAL
3572 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3573 Error **errp)
3575 const char *device = qemu_opt_get(opts, "path");
3576 ChardevHostdev *serial;
3578 if (device == NULL) {
3579 error_setg(errp, "chardev: serial/tty: no device path given");
3580 return;
3582 serial = backend->u.serial.data = g_new0(ChardevHostdev, 1);
3583 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3584 serial->device = g_strdup(device);
3586 #endif
3588 #ifdef HAVE_CHARDEV_PARPORT
3589 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3590 Error **errp)
3592 const char *device = qemu_opt_get(opts, "path");
3593 ChardevHostdev *parallel;
3595 if (device == NULL) {
3596 error_setg(errp, "chardev: parallel: no device path given");
3597 return;
3599 parallel = backend->u.parallel.data = g_new0(ChardevHostdev, 1);
3600 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3601 parallel->device = g_strdup(device);
3603 #endif
3605 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3606 Error **errp)
3608 const char *device = qemu_opt_get(opts, "path");
3609 ChardevHostdev *dev;
3611 if (device == NULL) {
3612 error_setg(errp, "chardev: pipe: no device path given");
3613 return;
3615 dev = backend->u.pipe.data = g_new0(ChardevHostdev, 1);
3616 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3617 dev->device = g_strdup(device);
3620 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3621 Error **errp)
3623 int val;
3624 ChardevRingbuf *ringbuf;
3626 ringbuf = backend->u.ringbuf.data = g_new0(ChardevRingbuf, 1);
3627 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3629 val = qemu_opt_get_size(opts, "size", 0);
3630 if (val != 0) {
3631 ringbuf->has_size = true;
3632 ringbuf->size = val;
3636 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3637 Error **errp)
3639 const char *chardev = qemu_opt_get(opts, "chardev");
3640 ChardevMux *mux;
3642 if (chardev == NULL) {
3643 error_setg(errp, "chardev: mux: no chardev given");
3644 return;
3646 mux = backend->u.mux.data = g_new0(ChardevMux, 1);
3647 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
3648 mux->chardev = g_strdup(chardev);
3651 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3652 Error **errp)
3654 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3655 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3656 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3657 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3658 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3659 const char *path = qemu_opt_get(opts, "path");
3660 const char *host = qemu_opt_get(opts, "host");
3661 const char *port = qemu_opt_get(opts, "port");
3662 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
3663 SocketAddress *addr;
3664 ChardevSocket *sock;
3666 if (!path) {
3667 if (!host) {
3668 error_setg(errp, "chardev: socket: no host given");
3669 return;
3671 if (!port) {
3672 error_setg(errp, "chardev: socket: no port given");
3673 return;
3675 } else {
3676 if (tls_creds) {
3677 error_setg(errp, "TLS can only be used over TCP socket");
3678 return;
3682 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
3683 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
3685 sock->has_nodelay = true;
3686 sock->nodelay = do_nodelay;
3687 sock->has_server = true;
3688 sock->server = is_listen;
3689 sock->has_telnet = true;
3690 sock->telnet = is_telnet;
3691 sock->has_wait = true;
3692 sock->wait = is_waitconnect;
3693 sock->has_reconnect = true;
3694 sock->reconnect = reconnect;
3695 sock->tls_creds = g_strdup(tls_creds);
3697 addr = g_new0(SocketAddress, 1);
3698 if (path) {
3699 UnixSocketAddress *q_unix;
3700 addr->type = SOCKET_ADDRESS_KIND_UNIX;
3701 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
3702 q_unix->path = g_strdup(path);
3703 } else {
3704 addr->type = SOCKET_ADDRESS_KIND_INET;
3705 addr->u.inet.data = g_new(InetSocketAddress, 1);
3706 *addr->u.inet.data = (InetSocketAddress) {
3707 .host = g_strdup(host),
3708 .port = g_strdup(port),
3709 .has_to = qemu_opt_get(opts, "to"),
3710 .to = qemu_opt_get_number(opts, "to", 0),
3711 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3712 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3713 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3714 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3717 sock->addr = addr;
3720 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3721 Error **errp)
3723 const char *host = qemu_opt_get(opts, "host");
3724 const char *port = qemu_opt_get(opts, "port");
3725 const char *localaddr = qemu_opt_get(opts, "localaddr");
3726 const char *localport = qemu_opt_get(opts, "localport");
3727 bool has_local = false;
3728 SocketAddress *addr;
3729 ChardevUdp *udp;
3731 if (host == NULL || strlen(host) == 0) {
3732 host = "localhost";
3734 if (port == NULL || strlen(port) == 0) {
3735 error_setg(errp, "chardev: udp: remote port not specified");
3736 return;
3738 if (localport == NULL || strlen(localport) == 0) {
3739 localport = "0";
3740 } else {
3741 has_local = true;
3743 if (localaddr == NULL || strlen(localaddr) == 0) {
3744 localaddr = "";
3745 } else {
3746 has_local = true;
3749 udp = backend->u.udp.data = g_new0(ChardevUdp, 1);
3750 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
3752 addr = g_new0(SocketAddress, 1);
3753 addr->type = SOCKET_ADDRESS_KIND_INET;
3754 addr->u.inet.data = g_new(InetSocketAddress, 1);
3755 *addr->u.inet.data = (InetSocketAddress) {
3756 .host = g_strdup(host),
3757 .port = g_strdup(port),
3758 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3759 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3760 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3761 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3763 udp->remote = addr;
3765 if (has_local) {
3766 udp->has_local = true;
3767 addr = g_new0(SocketAddress, 1);
3768 addr->type = SOCKET_ADDRESS_KIND_INET;
3769 addr->u.inet.data = g_new(InetSocketAddress, 1);
3770 *addr->u.inet.data = (InetSocketAddress) {
3771 .host = g_strdup(localaddr),
3772 .port = g_strdup(localport),
3774 udp->local = addr;
3778 typedef struct CharDriver {
3779 const char *name;
3780 ChardevBackendKind kind;
3781 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3782 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3783 ChardevReturn *ret, Error **errp);
3784 } CharDriver;
3786 static GSList *backends;
3788 void register_char_driver(const char *name, ChardevBackendKind kind,
3789 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
3790 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3791 ChardevReturn *ret, Error **errp))
3793 CharDriver *s;
3795 s = g_malloc0(sizeof(*s));
3796 s->name = g_strdup(name);
3797 s->kind = kind;
3798 s->parse = parse;
3799 s->create = create;
3801 backends = g_slist_append(backends, s);
3804 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
3805 void (*init)(struct CharDriverState *s),
3806 Error **errp)
3808 Error *local_err = NULL;
3809 CharDriver *cd;
3810 CharDriverState *chr;
3811 GSList *i;
3812 ChardevReturn *ret = NULL;
3813 ChardevBackend *backend;
3814 const char *id = qemu_opts_id(opts);
3815 char *bid = NULL;
3817 if (id == NULL) {
3818 error_setg(errp, "chardev: no id specified");
3819 goto err;
3822 if (qemu_opt_get(opts, "backend") == NULL) {
3823 error_setg(errp, "chardev: \"%s\" missing backend",
3824 qemu_opts_id(opts));
3825 goto err;
3827 for (i = backends; i; i = i->next) {
3828 cd = i->data;
3830 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
3831 break;
3834 if (i == NULL) {
3835 error_setg(errp, "chardev: backend \"%s\" not found",
3836 qemu_opt_get(opts, "backend"));
3837 goto err;
3840 backend = g_new0(ChardevBackend, 1);
3842 if (qemu_opt_get_bool(opts, "mux", 0)) {
3843 bid = g_strdup_printf("%s-base", id);
3846 chr = NULL;
3847 backend->type = cd->kind;
3848 if (cd->parse) {
3849 cd->parse(opts, backend, &local_err);
3850 if (local_err) {
3851 error_propagate(errp, local_err);
3852 goto qapi_out;
3854 } else {
3855 ChardevCommon *cc = g_new0(ChardevCommon, 1);
3856 qemu_chr_parse_common(opts, cc);
3857 backend->u.null.data = cc; /* Any ChardevCommon member would work */
3860 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
3861 if (!ret) {
3862 goto qapi_out;
3865 if (bid) {
3866 qapi_free_ChardevBackend(backend);
3867 qapi_free_ChardevReturn(ret);
3868 backend = g_new0(ChardevBackend, 1);
3869 backend->u.mux.data = g_new0(ChardevMux, 1);
3870 backend->type = CHARDEV_BACKEND_KIND_MUX;
3871 backend->u.mux.data->chardev = g_strdup(bid);
3872 ret = qmp_chardev_add(id, backend, errp);
3873 if (!ret) {
3874 chr = qemu_chr_find(bid);
3875 qemu_chr_delete(chr);
3876 chr = NULL;
3877 goto qapi_out;
3881 chr = qemu_chr_find(id);
3882 chr->opts = opts;
3884 qapi_out:
3885 qapi_free_ChardevBackend(backend);
3886 qapi_free_ChardevReturn(ret);
3887 g_free(bid);
3888 return chr;
3890 err:
3891 qemu_opts_del(opts);
3892 return NULL;
3895 CharDriverState *qemu_chr_new_noreplay(const char *label, const char *filename,
3896 void (*init)(struct CharDriverState *s))
3898 const char *p;
3899 CharDriverState *chr;
3900 QemuOpts *opts;
3901 Error *err = NULL;
3903 if (strstart(filename, "chardev:", &p)) {
3904 return qemu_chr_find(p);
3907 opts = qemu_chr_parse_compat(label, filename);
3908 if (!opts)
3909 return NULL;
3911 chr = qemu_chr_new_from_opts(opts, init, &err);
3912 if (err) {
3913 error_report_err(err);
3915 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
3916 qemu_chr_fe_claim_no_fail(chr);
3917 monitor_init(chr, MONITOR_USE_READLINE);
3919 return chr;
3922 CharDriverState *qemu_chr_new(const char *label, const char *filename, void (*init)(struct CharDriverState *s))
3924 CharDriverState *chr;
3925 chr = qemu_chr_new_noreplay(label, filename, init);
3926 if (chr) {
3927 chr->replay = replay_mode != REPLAY_MODE_NONE;
3928 if (chr->replay && chr->chr_ioctl) {
3929 fprintf(stderr,
3930 "Replay: ioctl is not supported for serial devices yet\n");
3932 replay_register_char_driver(chr);
3934 return chr;
3937 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo)
3939 if (chr->chr_set_echo) {
3940 chr->chr_set_echo(chr, echo);
3944 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open)
3946 if (chr->fe_open == fe_open) {
3947 return;
3949 chr->fe_open = fe_open;
3950 if (chr->chr_set_fe_open) {
3951 chr->chr_set_fe_open(chr, fe_open);
3955 void qemu_chr_fe_event(struct CharDriverState *chr, int event)
3957 if (chr->chr_fe_event) {
3958 chr->chr_fe_event(chr, event);
3962 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
3963 GIOFunc func, void *user_data)
3965 GSource *src;
3966 guint tag;
3968 if (s->chr_add_watch == NULL) {
3969 return -ENOSYS;
3972 src = s->chr_add_watch(s, cond);
3973 if (!src) {
3974 return -EINVAL;
3977 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
3978 tag = g_source_attach(src, NULL);
3979 g_source_unref(src);
3981 return tag;
3984 int qemu_chr_fe_claim(CharDriverState *s)
3986 if (s->avail_connections < 1) {
3987 return -1;
3989 s->avail_connections--;
3990 return 0;
3993 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
3995 if (qemu_chr_fe_claim(s) != 0) {
3996 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
3997 __func__, s->label);
3998 exit(1);
4002 void qemu_chr_fe_release(CharDriverState *s)
4004 s->avail_connections++;
4007 static void qemu_chr_free_common(CharDriverState *chr)
4009 g_free(chr->filename);
4010 g_free(chr->label);
4011 qemu_opts_del(chr->opts);
4012 if (chr->logfd != -1) {
4013 close(chr->logfd);
4015 qemu_mutex_destroy(&chr->chr_write_lock);
4016 g_free(chr);
4019 void qemu_chr_free(CharDriverState *chr)
4021 if (chr->chr_close) {
4022 chr->chr_close(chr);
4024 qemu_chr_free_common(chr);
4027 void qemu_chr_delete(CharDriverState *chr)
4029 QTAILQ_REMOVE(&chardevs, chr, next);
4030 qemu_chr_free(chr);
4033 ChardevInfoList *qmp_query_chardev(Error **errp)
4035 ChardevInfoList *chr_list = NULL;
4036 CharDriverState *chr;
4038 QTAILQ_FOREACH(chr, &chardevs, next) {
4039 ChardevInfoList *info = g_malloc0(sizeof(*info));
4040 info->value = g_malloc0(sizeof(*info->value));
4041 info->value->label = g_strdup(chr->label);
4042 info->value->filename = g_strdup(chr->filename);
4043 info->value->frontend_open = chr->fe_open;
4045 info->next = chr_list;
4046 chr_list = info;
4049 return chr_list;
4052 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
4054 ChardevBackendInfoList *backend_list = NULL;
4055 CharDriver *c = NULL;
4056 GSList *i = NULL;
4058 for (i = backends; i; i = i->next) {
4059 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
4060 c = i->data;
4061 info->value = g_malloc0(sizeof(*info->value));
4062 info->value->name = g_strdup(c->name);
4064 info->next = backend_list;
4065 backend_list = info;
4068 return backend_list;
4071 CharDriverState *qemu_chr_find(const char *name)
4073 CharDriverState *chr;
4075 QTAILQ_FOREACH(chr, &chardevs, next) {
4076 if (strcmp(chr->label, name) != 0)
4077 continue;
4078 return chr;
4080 return NULL;
4083 /* Get a character (serial) device interface. */
4084 CharDriverState *qemu_char_get_next_serial(void)
4086 static int next_serial;
4087 CharDriverState *chr;
4089 /* FIXME: This function needs to go away: use chardev properties! */
4091 while (next_serial < MAX_SERIAL_PORTS && serial_hds[next_serial]) {
4092 chr = serial_hds[next_serial++];
4093 qemu_chr_fe_claim_no_fail(chr);
4094 return chr;
4096 return NULL;
4099 QemuOptsList qemu_chardev_opts = {
4100 .name = "chardev",
4101 .implied_opt_name = "backend",
4102 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4103 .desc = {
4105 .name = "backend",
4106 .type = QEMU_OPT_STRING,
4108 .name = "path",
4109 .type = QEMU_OPT_STRING,
4111 .name = "host",
4112 .type = QEMU_OPT_STRING,
4114 .name = "port",
4115 .type = QEMU_OPT_STRING,
4117 .name = "localaddr",
4118 .type = QEMU_OPT_STRING,
4120 .name = "localport",
4121 .type = QEMU_OPT_STRING,
4123 .name = "to",
4124 .type = QEMU_OPT_NUMBER,
4126 .name = "ipv4",
4127 .type = QEMU_OPT_BOOL,
4129 .name = "ipv6",
4130 .type = QEMU_OPT_BOOL,
4132 .name = "wait",
4133 .type = QEMU_OPT_BOOL,
4135 .name = "server",
4136 .type = QEMU_OPT_BOOL,
4138 .name = "delay",
4139 .type = QEMU_OPT_BOOL,
4141 .name = "reconnect",
4142 .type = QEMU_OPT_NUMBER,
4144 .name = "telnet",
4145 .type = QEMU_OPT_BOOL,
4147 .name = "tls-creds",
4148 .type = QEMU_OPT_STRING,
4150 .name = "width",
4151 .type = QEMU_OPT_NUMBER,
4153 .name = "height",
4154 .type = QEMU_OPT_NUMBER,
4156 .name = "cols",
4157 .type = QEMU_OPT_NUMBER,
4159 .name = "rows",
4160 .type = QEMU_OPT_NUMBER,
4162 .name = "mux",
4163 .type = QEMU_OPT_BOOL,
4165 .name = "signal",
4166 .type = QEMU_OPT_BOOL,
4168 .name = "name",
4169 .type = QEMU_OPT_STRING,
4171 .name = "debug",
4172 .type = QEMU_OPT_NUMBER,
4174 .name = "size",
4175 .type = QEMU_OPT_SIZE,
4177 .name = "chardev",
4178 .type = QEMU_OPT_STRING,
4180 .name = "append",
4181 .type = QEMU_OPT_BOOL,
4183 .name = "logfile",
4184 .type = QEMU_OPT_STRING,
4186 .name = "logappend",
4187 .type = QEMU_OPT_BOOL,
4189 { /* end of list */ }
4193 #ifdef _WIN32
4195 static CharDriverState *qmp_chardev_open_file(const char *id,
4196 ChardevBackend *backend,
4197 ChardevReturn *ret,
4198 Error **errp)
4200 ChardevFile *file = backend->u.file.data;
4201 ChardevCommon *common = qapi_ChardevFile_base(file);
4202 HANDLE out;
4204 if (file->has_in) {
4205 error_setg(errp, "input file not supported");
4206 return NULL;
4209 out = CreateFile(file->out, GENERIC_WRITE, FILE_SHARE_READ, NULL,
4210 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
4211 if (out == INVALID_HANDLE_VALUE) {
4212 error_setg(errp, "open %s failed", file->out);
4213 return NULL;
4215 return qemu_chr_open_win_file(out, common, errp);
4218 static CharDriverState *qmp_chardev_open_serial(const char *id,
4219 ChardevBackend *backend,
4220 ChardevReturn *ret,
4221 Error **errp)
4223 ChardevHostdev *serial = backend->u.serial.data;
4224 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4225 return qemu_chr_open_win_path(serial->device, common, errp);
4228 #else /* WIN32 */
4230 static int qmp_chardev_open_file_source(char *src, int flags,
4231 Error **errp)
4233 int fd = -1;
4235 TFR(fd = qemu_open(src, flags, 0666));
4236 if (fd == -1) {
4237 error_setg_file_open(errp, errno, src);
4239 return fd;
4242 static CharDriverState *qmp_chardev_open_file(const char *id,
4243 ChardevBackend *backend,
4244 ChardevReturn *ret,
4245 Error **errp)
4247 ChardevFile *file = backend->u.file.data;
4248 ChardevCommon *common = qapi_ChardevFile_base(file);
4249 int flags, in = -1, out;
4251 flags = O_WRONLY | O_CREAT | O_BINARY;
4252 if (file->has_append && file->append) {
4253 flags |= O_APPEND;
4254 } else {
4255 flags |= O_TRUNC;
4258 out = qmp_chardev_open_file_source(file->out, flags, errp);
4259 if (out < 0) {
4260 return NULL;
4263 if (file->has_in) {
4264 flags = O_RDONLY;
4265 in = qmp_chardev_open_file_source(file->in, flags, errp);
4266 if (in < 0) {
4267 qemu_close(out);
4268 return NULL;
4272 return qemu_chr_open_fd(in, out, common, errp);
4275 #ifdef HAVE_CHARDEV_SERIAL
4276 static CharDriverState *qmp_chardev_open_serial(const char *id,
4277 ChardevBackend *backend,
4278 ChardevReturn *ret,
4279 Error **errp)
4281 ChardevHostdev *serial = backend->u.serial.data;
4282 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4283 int fd;
4285 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4286 if (fd < 0) {
4287 return NULL;
4289 qemu_set_nonblock(fd);
4290 return qemu_chr_open_tty_fd(fd, common, errp);
4292 #endif
4294 #ifdef HAVE_CHARDEV_PARPORT
4295 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4296 ChardevBackend *backend,
4297 ChardevReturn *ret,
4298 Error **errp)
4300 ChardevHostdev *parallel = backend->u.parallel.data;
4301 ChardevCommon *common = qapi_ChardevHostdev_base(parallel);
4302 int fd;
4304 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4305 if (fd < 0) {
4306 return NULL;
4308 return qemu_chr_open_pp_fd(fd, common, errp);
4310 #endif
4312 #endif /* WIN32 */
4314 static gboolean socket_reconnect_timeout(gpointer opaque)
4316 CharDriverState *chr = opaque;
4317 TCPCharDriver *s = chr->opaque;
4318 QIOChannelSocket *sioc;
4320 s->reconnect_timer = 0;
4322 if (chr->be_open) {
4323 return false;
4326 sioc = qio_channel_socket_new();
4327 qio_channel_socket_connect_async(sioc, s->addr,
4328 qemu_chr_socket_connected,
4329 chr, NULL);
4331 return false;
4334 static CharDriverState *qmp_chardev_open_socket(const char *id,
4335 ChardevBackend *backend,
4336 ChardevReturn *ret,
4337 Error **errp)
4339 CharDriverState *chr;
4340 TCPCharDriver *s;
4341 ChardevSocket *sock = backend->u.socket.data;
4342 SocketAddress *addr = sock->addr;
4343 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4344 bool is_listen = sock->has_server ? sock->server : true;
4345 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4346 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4347 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4348 ChardevCommon *common = qapi_ChardevSocket_base(sock);
4349 QIOChannelSocket *sioc = NULL;
4351 chr = qemu_chr_alloc(common, errp);
4352 if (!chr) {
4353 return NULL;
4355 s = g_new0(TCPCharDriver, 1);
4357 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4358 s->is_listen = is_listen;
4359 s->is_telnet = is_telnet;
4360 s->do_nodelay = do_nodelay;
4361 if (sock->tls_creds) {
4362 Object *creds;
4363 creds = object_resolve_path_component(
4364 object_get_objects_root(), sock->tls_creds);
4365 if (!creds) {
4366 error_setg(errp, "No TLS credentials with id '%s'",
4367 sock->tls_creds);
4368 goto error;
4370 s->tls_creds = (QCryptoTLSCreds *)
4371 object_dynamic_cast(creds,
4372 TYPE_QCRYPTO_TLS_CREDS);
4373 if (!s->tls_creds) {
4374 error_setg(errp, "Object with id '%s' is not TLS credentials",
4375 sock->tls_creds);
4376 goto error;
4378 object_ref(OBJECT(s->tls_creds));
4379 if (is_listen) {
4380 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4381 error_setg(errp, "%s",
4382 "Expected TLS credentials for server endpoint");
4383 goto error;
4385 } else {
4386 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4387 error_setg(errp, "%s",
4388 "Expected TLS credentials for client endpoint");
4389 goto error;
4394 qapi_copy_SocketAddress(&s->addr, sock->addr);
4396 chr->opaque = s;
4397 chr->chr_write = tcp_chr_write;
4398 chr->chr_sync_read = tcp_chr_sync_read;
4399 chr->chr_close = tcp_chr_close;
4400 chr->get_msgfds = tcp_get_msgfds;
4401 chr->set_msgfds = tcp_set_msgfds;
4402 chr->chr_add_client = tcp_chr_add_client;
4403 chr->chr_add_watch = tcp_chr_add_watch;
4404 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4405 /* be isn't opened until we get a connection */
4406 chr->explicit_be_open = true;
4408 chr->filename = SocketAddress_to_str("disconnected:",
4409 addr, is_listen, is_telnet);
4411 if (is_listen) {
4412 if (is_telnet) {
4413 s->do_telnetopt = 1;
4415 } else if (reconnect > 0) {
4416 s->reconnect_time = reconnect;
4419 sioc = qio_channel_socket_new();
4420 if (s->reconnect_time) {
4421 qio_channel_socket_connect_async(sioc, s->addr,
4422 qemu_chr_socket_connected,
4423 chr, NULL);
4424 } else if (s->is_listen) {
4425 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4426 goto error;
4428 s->listen_ioc = sioc;
4429 if (is_waitconnect) {
4430 fprintf(stderr, "QEMU waiting for connection on: %s\n",
4431 chr->filename);
4432 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
4434 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
4435 if (!s->ioc) {
4436 s->listen_tag = qio_channel_add_watch(
4437 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
4439 } else {
4440 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
4441 goto error;
4443 tcp_chr_new_client(chr, sioc);
4444 object_unref(OBJECT(sioc));
4447 return chr;
4449 error:
4450 if (sioc) {
4451 object_unref(OBJECT(sioc));
4453 if (s->tls_creds) {
4454 object_unref(OBJECT(s->tls_creds));
4456 g_free(s);
4457 qemu_chr_free_common(chr);
4458 return NULL;
4461 static CharDriverState *qmp_chardev_open_udp(const char *id,
4462 ChardevBackend *backend,
4463 ChardevReturn *ret,
4464 Error **errp)
4466 ChardevUdp *udp = backend->u.udp.data;
4467 ChardevCommon *common = qapi_ChardevUdp_base(udp);
4468 QIOChannelSocket *sioc = qio_channel_socket_new();
4470 if (qio_channel_socket_dgram_sync(sioc,
4471 udp->local, udp->remote,
4472 errp) < 0) {
4473 object_unref(OBJECT(sioc));
4474 return NULL;
4476 return qemu_chr_open_udp(sioc, common, errp);
4479 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4480 Error **errp)
4482 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4483 CharDriverState *chr = NULL;
4484 Error *local_err = NULL;
4485 GSList *i;
4486 CharDriver *cd;
4488 chr = qemu_chr_find(id);
4489 if (chr) {
4490 error_setg(errp, "Chardev '%s' already exists", id);
4491 g_free(ret);
4492 return NULL;
4495 for (i = backends; i; i = i->next) {
4496 cd = i->data;
4498 if (cd->kind == backend->type) {
4499 chr = cd->create(id, backend, ret, &local_err);
4500 if (local_err) {
4501 error_propagate(errp, local_err);
4502 goto out_error;
4504 break;
4508 if (chr == NULL) {
4509 assert(!i);
4510 error_setg(errp, "chardev backend not available");
4511 goto out_error;
4514 chr->label = g_strdup(id);
4515 chr->avail_connections =
4516 (backend->type == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4517 if (!chr->filename) {
4518 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4520 if (!chr->explicit_be_open) {
4521 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4523 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4524 return ret;
4526 out_error:
4527 g_free(ret);
4528 return NULL;
4531 void qmp_chardev_remove(const char *id, Error **errp)
4533 CharDriverState *chr;
4535 chr = qemu_chr_find(id);
4536 if (chr == NULL) {
4537 error_setg(errp, "Chardev '%s' not found", id);
4538 return;
4540 if (chr->chr_can_read || chr->chr_read ||
4541 chr->chr_event || chr->handler_opaque) {
4542 error_setg(errp, "Chardev '%s' is busy", id);
4543 return;
4545 if (chr->replay) {
4546 error_setg(errp,
4547 "Chardev '%s' cannot be unplugged in record/replay mode", id);
4548 return;
4550 qemu_chr_delete(chr);
4553 static void register_types(void)
4555 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4556 qemu_chr_open_null);
4557 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4558 qemu_chr_parse_socket, qmp_chardev_open_socket);
4559 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4560 qmp_chardev_open_udp);
4561 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4562 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4563 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4564 qemu_chr_parse_file_out, qmp_chardev_open_file);
4565 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4566 qemu_chr_parse_stdio, qemu_chr_open_stdio);
4567 #if defined HAVE_CHARDEV_SERIAL
4568 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4569 qemu_chr_parse_serial, qmp_chardev_open_serial);
4570 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4571 qemu_chr_parse_serial, qmp_chardev_open_serial);
4572 #endif
4573 #ifdef HAVE_CHARDEV_PARPORT
4574 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4575 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4576 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4577 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4578 #endif
4579 #ifdef HAVE_CHARDEV_PTY
4580 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4581 qemu_chr_open_pty);
4582 #endif
4583 #ifdef _WIN32
4584 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4585 qemu_chr_open_win_con);
4586 #endif
4587 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4588 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4589 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4590 qemu_chr_open_mux);
4591 /* Bug-compatibility: */
4592 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4593 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4594 /* this must be done after machine init, since we register FEs with muxes
4595 * as part of realize functions like serial_isa_realizefn when -nographic
4596 * is specified
4598 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4601 type_init(register_types);