Merge remote-tracking branch 'remotes/qmp-unstable/queue/qmp' into staging
[qemu/qmp-unstable.git] / qemu-char.c
blob8159462fc0bbd973481b8dcefa7b980c2ff6d103
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-common.h"
25 #include "monitor/monitor.h"
26 #include "sysemu/sysemu.h"
27 #include "qemu/timer.h"
28 #include "sysemu/char.h"
29 #include "hw/usb.h"
30 #include "qmp-commands.h"
31 #include "qapi/qmp-input-visitor.h"
32 #include "qapi/qmp-output-visitor.h"
33 #include "qapi-visit.h"
35 #include <unistd.h>
36 #include <fcntl.h>
37 #include <time.h>
38 #include <errno.h>
39 #include <sys/time.h>
40 #include <zlib.h>
42 #ifndef _WIN32
43 #include <sys/times.h>
44 #include <sys/wait.h>
45 #include <termios.h>
46 #include <sys/mman.h>
47 #include <sys/ioctl.h>
48 #include <sys/resource.h>
49 #include <sys/socket.h>
50 #include <netinet/in.h>
51 #include <net/if.h>
52 #include <arpa/inet.h>
53 #include <dirent.h>
54 #include <netdb.h>
55 #include <sys/select.h>
56 #ifdef CONFIG_BSD
57 #include <sys/stat.h>
58 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
59 #include <dev/ppbus/ppi.h>
60 #include <dev/ppbus/ppbconf.h>
61 #elif defined(__DragonFly__)
62 #include <dev/misc/ppi/ppi.h>
63 #include <bus/ppbus/ppbconf.h>
64 #endif
65 #else
66 #ifdef __linux__
67 #include <linux/ppdev.h>
68 #include <linux/parport.h>
69 #endif
70 #ifdef __sun__
71 #include <sys/stat.h>
72 #include <sys/ethernet.h>
73 #include <sys/sockio.h>
74 #include <netinet/arp.h>
75 #include <netinet/in.h>
76 #include <netinet/in_systm.h>
77 #include <netinet/ip.h>
78 #include <netinet/ip_icmp.h> // must come after ip.h
79 #include <netinet/udp.h>
80 #include <netinet/tcp.h>
81 #endif
82 #endif
83 #endif
85 #include "qemu/sockets.h"
86 #include "ui/qemu-spice.h"
88 #define READ_BUF_LEN 4096
89 #define READ_RETRIES 10
90 #define CHR_MAX_FILENAME_SIZE 256
91 #define TCP_MAX_FDS 16
93 /***********************************************************/
94 /* Socket address helpers */
95 static void qapi_copy_SocketAddress(SocketAddress **p_dest,
96 SocketAddress *src)
98 QmpOutputVisitor *qov;
99 QmpInputVisitor *qiv;
100 Visitor *ov, *iv;
101 QObject *obj;
103 *p_dest = NULL;
105 qov = qmp_output_visitor_new();
106 ov = qmp_output_get_visitor(qov);
107 visit_type_SocketAddress(ov, &src, NULL, &error_abort);
108 obj = qmp_output_get_qobject(qov);
109 qmp_output_visitor_cleanup(qov);
110 if (!obj) {
111 return;
114 qiv = qmp_input_visitor_new(obj);
115 iv = qmp_input_get_visitor(qiv);
116 visit_type_SocketAddress(iv, p_dest, NULL, &error_abort);
117 qmp_input_visitor_cleanup(qiv);
118 qobject_decref(obj);
121 static int SocketAddress_to_str(char *dest, int max_len,
122 const char *prefix, SocketAddress *addr,
123 bool is_listen, bool is_telnet)
125 switch (addr->kind) {
126 case SOCKET_ADDRESS_KIND_INET:
127 return snprintf(dest, max_len, "%s%s:%s:%s%s", prefix,
128 is_telnet ? "telnet" : "tcp", addr->inet->host,
129 addr->inet->port, is_listen ? ",server" : "");
130 break;
131 case SOCKET_ADDRESS_KIND_UNIX:
132 return snprintf(dest, max_len, "%sunix:%s%s", prefix,
133 addr->q_unix->path, is_listen ? ",server" : "");
134 break;
135 case SOCKET_ADDRESS_KIND_FD:
136 return snprintf(dest, max_len, "%sfd:%s%s", prefix, addr->fd->str,
137 is_listen ? ",server" : "");
138 break;
139 default:
140 abort();
144 static int sockaddr_to_str(char *dest, int max_len,
145 struct sockaddr_storage *ss, socklen_t ss_len,
146 struct sockaddr_storage *ps, socklen_t ps_len,
147 bool is_listen, bool is_telnet)
149 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
150 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
151 const char *left = "", *right = "";
153 switch (ss->ss_family) {
154 #ifndef _WIN32
155 case AF_UNIX:
156 return snprintf(dest, max_len, "unix:%s%s",
157 ((struct sockaddr_un *)(ss))->sun_path,
158 is_listen ? ",server" : "");
159 #endif
160 case AF_INET6:
161 left = "[";
162 right = "]";
163 /* fall through */
164 case AF_INET:
165 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
166 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
167 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
168 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
169 return snprintf(dest, max_len, "%s:%s%s%s:%s%s <-> %s%s%s:%s",
170 is_telnet ? "telnet" : "tcp",
171 left, shost, right, sserv,
172 is_listen ? ",server" : "",
173 left, phost, right, pserv);
175 default:
176 return snprintf(dest, max_len, "unknown");
180 /***********************************************************/
181 /* character device */
183 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
184 QTAILQ_HEAD_INITIALIZER(chardevs);
186 CharDriverState *qemu_chr_alloc(void)
188 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
189 qemu_mutex_init(&chr->chr_write_lock);
190 return chr;
193 void qemu_chr_be_event(CharDriverState *s, int event)
195 /* Keep track if the char device is open */
196 switch (event) {
197 case CHR_EVENT_OPENED:
198 s->be_open = 1;
199 break;
200 case CHR_EVENT_CLOSED:
201 s->be_open = 0;
202 break;
205 if (!s->chr_event)
206 return;
207 s->chr_event(s->handler_opaque, event);
210 void qemu_chr_be_generic_open(CharDriverState *s)
212 qemu_chr_be_event(s, CHR_EVENT_OPENED);
215 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len)
217 int ret;
219 qemu_mutex_lock(&s->chr_write_lock);
220 ret = s->chr_write(s, buf, len);
221 qemu_mutex_unlock(&s->chr_write_lock);
222 return ret;
225 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len)
227 int offset = 0;
228 int res = 0;
230 qemu_mutex_lock(&s->chr_write_lock);
231 while (offset < len) {
232 do {
233 res = s->chr_write(s, buf + offset, len - offset);
234 if (res == -1 && errno == EAGAIN) {
235 g_usleep(100);
237 } while (res == -1 && errno == EAGAIN);
239 if (res <= 0) {
240 break;
243 offset += res;
245 qemu_mutex_unlock(&s->chr_write_lock);
247 if (res < 0) {
248 return res;
250 return offset;
253 int qemu_chr_fe_read_all(CharDriverState *s, uint8_t *buf, int len)
255 int offset = 0, counter = 10;
256 int res;
258 if (!s->chr_sync_read) {
259 return 0;
262 while (offset < len) {
263 do {
264 res = s->chr_sync_read(s, buf + offset, len - offset);
265 if (res == -1 && errno == EAGAIN) {
266 g_usleep(100);
268 } while (res == -1 && errno == EAGAIN);
270 if (res == 0) {
271 break;
274 if (res < 0) {
275 return res;
278 offset += res;
280 if (!counter--) {
281 break;
285 return offset;
288 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg)
290 if (!s->chr_ioctl)
291 return -ENOTSUP;
292 return s->chr_ioctl(s, cmd, arg);
295 int qemu_chr_be_can_write(CharDriverState *s)
297 if (!s->chr_can_read)
298 return 0;
299 return s->chr_can_read(s->handler_opaque);
302 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
304 if (s->chr_read) {
305 s->chr_read(s->handler_opaque, buf, len);
309 int qemu_chr_fe_get_msgfd(CharDriverState *s)
311 int fd;
312 return (qemu_chr_fe_get_msgfds(s, &fd, 1) == 1) ? fd : -1;
315 int qemu_chr_fe_get_msgfds(CharDriverState *s, int *fds, int len)
317 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
320 int qemu_chr_fe_set_msgfds(CharDriverState *s, int *fds, int num)
322 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
325 int qemu_chr_add_client(CharDriverState *s, int fd)
327 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
330 void qemu_chr_accept_input(CharDriverState *s)
332 if (s->chr_accept_input)
333 s->chr_accept_input(s);
334 qemu_notify_event();
337 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
339 char buf[READ_BUF_LEN];
340 va_list ap;
341 va_start(ap, fmt);
342 vsnprintf(buf, sizeof(buf), fmt, ap);
343 qemu_chr_fe_write(s, (uint8_t *)buf, strlen(buf));
344 va_end(ap);
347 static void remove_fd_in_watch(CharDriverState *chr);
349 void qemu_chr_add_handlers(CharDriverState *s,
350 IOCanReadHandler *fd_can_read,
351 IOReadHandler *fd_read,
352 IOEventHandler *fd_event,
353 void *opaque)
355 int fe_open;
357 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
358 fe_open = 0;
359 remove_fd_in_watch(s);
360 } else {
361 fe_open = 1;
363 s->chr_can_read = fd_can_read;
364 s->chr_read = fd_read;
365 s->chr_event = fd_event;
366 s->handler_opaque = opaque;
367 if (fe_open && s->chr_update_read_handler)
368 s->chr_update_read_handler(s);
370 if (!s->explicit_fe_open) {
371 qemu_chr_fe_set_open(s, fe_open);
374 /* We're connecting to an already opened device, so let's make sure we
375 also get the open event */
376 if (fe_open && s->be_open) {
377 qemu_chr_be_generic_open(s);
381 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
383 return len;
386 static CharDriverState *qemu_chr_open_null(void)
388 CharDriverState *chr;
390 chr = qemu_chr_alloc();
391 chr->chr_write = null_chr_write;
392 chr->explicit_be_open = true;
393 return chr;
396 /* MUX driver for serial I/O splitting */
397 #define MAX_MUX 4
398 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
399 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
400 typedef struct {
401 IOCanReadHandler *chr_can_read[MAX_MUX];
402 IOReadHandler *chr_read[MAX_MUX];
403 IOEventHandler *chr_event[MAX_MUX];
404 void *ext_opaque[MAX_MUX];
405 CharDriverState *drv;
406 int focus;
407 int mux_cnt;
408 int term_got_escape;
409 int max_size;
410 /* Intermediate input buffer allows to catch escape sequences even if the
411 currently active device is not accepting any input - but only until it
412 is full as well. */
413 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
414 int prod[MAX_MUX];
415 int cons[MAX_MUX];
416 int timestamps;
418 /* Protected by the CharDriverState chr_write_lock. */
419 int linestart;
420 int64_t timestamps_start;
421 } MuxDriver;
424 /* Called with chr_write_lock held. */
425 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
427 MuxDriver *d = chr->opaque;
428 int ret;
429 if (!d->timestamps) {
430 ret = qemu_chr_fe_write(d->drv, buf, len);
431 } else {
432 int i;
434 ret = 0;
435 for (i = 0; i < len; i++) {
436 if (d->linestart) {
437 char buf1[64];
438 int64_t ti;
439 int secs;
441 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
442 if (d->timestamps_start == -1)
443 d->timestamps_start = ti;
444 ti -= d->timestamps_start;
445 secs = ti / 1000;
446 snprintf(buf1, sizeof(buf1),
447 "[%02d:%02d:%02d.%03d] ",
448 secs / 3600,
449 (secs / 60) % 60,
450 secs % 60,
451 (int)(ti % 1000));
452 qemu_chr_fe_write(d->drv, (uint8_t *)buf1, strlen(buf1));
453 d->linestart = 0;
455 ret += qemu_chr_fe_write(d->drv, buf+i, 1);
456 if (buf[i] == '\n') {
457 d->linestart = 1;
461 return ret;
464 static const char * const mux_help[] = {
465 "% h print this help\n\r",
466 "% x exit emulator\n\r",
467 "% s save disk data back to file (if -snapshot)\n\r",
468 "% t toggle console timestamps\n\r",
469 "% b send break (magic sysrq)\n\r",
470 "% c switch between console and monitor\n\r",
471 "% % sends %\n\r",
472 NULL
475 int term_escape_char = 0x01; /* ctrl-a is used for escape */
476 static void mux_print_help(CharDriverState *chr)
478 int i, j;
479 char ebuf[15] = "Escape-Char";
480 char cbuf[50] = "\n\r";
482 if (term_escape_char > 0 && term_escape_char < 26) {
483 snprintf(cbuf, sizeof(cbuf), "\n\r");
484 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
485 } else {
486 snprintf(cbuf, sizeof(cbuf),
487 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
488 term_escape_char);
490 qemu_chr_fe_write(chr, (uint8_t *)cbuf, strlen(cbuf));
491 for (i = 0; mux_help[i] != NULL; i++) {
492 for (j=0; mux_help[i][j] != '\0'; j++) {
493 if (mux_help[i][j] == '%')
494 qemu_chr_fe_write(chr, (uint8_t *)ebuf, strlen(ebuf));
495 else
496 qemu_chr_fe_write(chr, (uint8_t *)&mux_help[i][j], 1);
501 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
503 if (d->chr_event[mux_nr])
504 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
507 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
509 if (d->term_got_escape) {
510 d->term_got_escape = 0;
511 if (ch == term_escape_char)
512 goto send_char;
513 switch(ch) {
514 case '?':
515 case 'h':
516 mux_print_help(chr);
517 break;
518 case 'x':
520 const char *term = "QEMU: Terminated\n\r";
521 qemu_chr_fe_write(chr, (uint8_t *)term, strlen(term));
522 exit(0);
523 break;
525 case 's':
526 bdrv_commit_all();
527 break;
528 case 'b':
529 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
530 break;
531 case 'c':
532 /* Switch to the next registered device */
533 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
534 d->focus++;
535 if (d->focus >= d->mux_cnt)
536 d->focus = 0;
537 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
538 break;
539 case 't':
540 d->timestamps = !d->timestamps;
541 d->timestamps_start = -1;
542 d->linestart = 0;
543 break;
545 } else if (ch == term_escape_char) {
546 d->term_got_escape = 1;
547 } else {
548 send_char:
549 return 1;
551 return 0;
554 static void mux_chr_accept_input(CharDriverState *chr)
556 MuxDriver *d = chr->opaque;
557 int m = d->focus;
559 while (d->prod[m] != d->cons[m] &&
560 d->chr_can_read[m] &&
561 d->chr_can_read[m](d->ext_opaque[m])) {
562 d->chr_read[m](d->ext_opaque[m],
563 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
567 static int mux_chr_can_read(void *opaque)
569 CharDriverState *chr = opaque;
570 MuxDriver *d = chr->opaque;
571 int m = d->focus;
573 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
574 return 1;
575 if (d->chr_can_read[m])
576 return d->chr_can_read[m](d->ext_opaque[m]);
577 return 0;
580 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
582 CharDriverState *chr = opaque;
583 MuxDriver *d = chr->opaque;
584 int m = d->focus;
585 int i;
587 mux_chr_accept_input (opaque);
589 for(i = 0; i < size; i++)
590 if (mux_proc_byte(chr, d, buf[i])) {
591 if (d->prod[m] == d->cons[m] &&
592 d->chr_can_read[m] &&
593 d->chr_can_read[m](d->ext_opaque[m]))
594 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
595 else
596 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
600 static void mux_chr_event(void *opaque, int event)
602 CharDriverState *chr = opaque;
603 MuxDriver *d = chr->opaque;
604 int i;
606 /* Send the event to all registered listeners */
607 for (i = 0; i < d->mux_cnt; i++)
608 mux_chr_send_event(d, i, event);
611 static void mux_chr_update_read_handler(CharDriverState *chr)
613 MuxDriver *d = chr->opaque;
615 if (d->mux_cnt >= MAX_MUX) {
616 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
617 return;
619 d->ext_opaque[d->mux_cnt] = chr->handler_opaque;
620 d->chr_can_read[d->mux_cnt] = chr->chr_can_read;
621 d->chr_read[d->mux_cnt] = chr->chr_read;
622 d->chr_event[d->mux_cnt] = chr->chr_event;
623 /* Fix up the real driver with mux routines */
624 if (d->mux_cnt == 0) {
625 qemu_chr_add_handlers(d->drv, mux_chr_can_read, mux_chr_read,
626 mux_chr_event, chr);
628 if (d->focus != -1) {
629 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
631 d->focus = d->mux_cnt;
632 d->mux_cnt++;
633 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
636 static bool muxes_realized;
639 * Called after processing of default and command-line-specified
640 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
641 * to a mux chardev. This is done here to ensure that
642 * output/prompts/banners are only displayed for the FE that has
643 * focus when initial command-line processing/machine init is
644 * completed.
646 * After this point, any new FE attached to any new or existing
647 * mux will receive CHR_EVENT_OPENED notifications for the BE
648 * immediately.
650 static void muxes_realize_done(Notifier *notifier, void *unused)
652 CharDriverState *chr;
654 QTAILQ_FOREACH(chr, &chardevs, next) {
655 if (chr->is_mux) {
656 MuxDriver *d = chr->opaque;
657 int i;
659 /* send OPENED to all already-attached FEs */
660 for (i = 0; i < d->mux_cnt; i++) {
661 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
663 /* mark mux as OPENED so any new FEs will immediately receive
664 * OPENED event
666 qemu_chr_be_generic_open(chr);
669 muxes_realized = true;
672 static Notifier muxes_realize_notify = {
673 .notify = muxes_realize_done,
676 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
678 MuxDriver *d = s->opaque;
679 return d->drv->chr_add_watch(d->drv, cond);
682 static CharDriverState *qemu_chr_open_mux(CharDriverState *drv)
684 CharDriverState *chr;
685 MuxDriver *d;
687 chr = qemu_chr_alloc();
688 d = g_malloc0(sizeof(MuxDriver));
690 chr->opaque = d;
691 d->drv = drv;
692 d->focus = -1;
693 chr->chr_write = mux_chr_write;
694 chr->chr_update_read_handler = mux_chr_update_read_handler;
695 chr->chr_accept_input = mux_chr_accept_input;
696 /* Frontend guest-open / -close notification is not support with muxes */
697 chr->chr_set_fe_open = NULL;
698 if (drv->chr_add_watch) {
699 chr->chr_add_watch = mux_chr_add_watch;
701 /* only default to opened state if we've realized the initial
702 * set of muxes
704 chr->explicit_be_open = muxes_realized ? 0 : 1;
705 chr->is_mux = 1;
707 return chr;
711 #ifdef _WIN32
712 int send_all(int fd, const void *buf, int len1)
714 int ret, len;
716 len = len1;
717 while (len > 0) {
718 ret = send(fd, buf, len, 0);
719 if (ret < 0) {
720 errno = WSAGetLastError();
721 if (errno != WSAEWOULDBLOCK) {
722 return -1;
724 } else if (ret == 0) {
725 break;
726 } else {
727 buf += ret;
728 len -= ret;
731 return len1 - len;
734 #else
736 int send_all(int fd, const void *_buf, int len1)
738 int ret, len;
739 const uint8_t *buf = _buf;
741 len = len1;
742 while (len > 0) {
743 ret = write(fd, buf, len);
744 if (ret < 0) {
745 if (errno != EINTR && errno != EAGAIN)
746 return -1;
747 } else if (ret == 0) {
748 break;
749 } else {
750 buf += ret;
751 len -= ret;
754 return len1 - len;
757 int recv_all(int fd, void *_buf, int len1, bool single_read)
759 int ret, len;
760 uint8_t *buf = _buf;
762 len = len1;
763 while ((len > 0) && (ret = read(fd, buf, len)) != 0) {
764 if (ret < 0) {
765 if (errno != EINTR && errno != EAGAIN) {
766 return -1;
768 continue;
769 } else {
770 if (single_read) {
771 return ret;
773 buf += ret;
774 len -= ret;
777 return len1 - len;
780 #endif /* !_WIN32 */
782 typedef struct IOWatchPoll
784 GSource parent;
786 GIOChannel *channel;
787 GSource *src;
789 IOCanReadHandler *fd_can_read;
790 GSourceFunc fd_read;
791 void *opaque;
792 } IOWatchPoll;
794 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
796 return container_of(source, IOWatchPoll, parent);
799 static gboolean io_watch_poll_prepare(GSource *source, gint *timeout_)
801 IOWatchPoll *iwp = io_watch_poll_from_source(source);
802 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
803 bool was_active = iwp->src != NULL;
804 if (was_active == now_active) {
805 return FALSE;
808 if (now_active) {
809 iwp->src = g_io_create_watch(iwp->channel, G_IO_IN | G_IO_ERR | G_IO_HUP);
810 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
811 g_source_attach(iwp->src, NULL);
812 } else {
813 g_source_destroy(iwp->src);
814 g_source_unref(iwp->src);
815 iwp->src = NULL;
817 return FALSE;
820 static gboolean io_watch_poll_check(GSource *source)
822 return FALSE;
825 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
826 gpointer user_data)
828 abort();
831 static void io_watch_poll_finalize(GSource *source)
833 /* Due to a glib bug, removing the last reference to a source
834 * inside a finalize callback causes recursive locking (and a
835 * deadlock). This is not a problem inside other callbacks,
836 * including dispatch callbacks, so we call io_remove_watch_poll
837 * to remove this source. At this point, iwp->src must
838 * be NULL, or we would leak it.
840 * This would be solved much more elegantly by child sources,
841 * but we support older glib versions that do not have them.
843 IOWatchPoll *iwp = io_watch_poll_from_source(source);
844 assert(iwp->src == NULL);
847 static GSourceFuncs io_watch_poll_funcs = {
848 .prepare = io_watch_poll_prepare,
849 .check = io_watch_poll_check,
850 .dispatch = io_watch_poll_dispatch,
851 .finalize = io_watch_poll_finalize,
854 /* Can only be used for read */
855 static guint io_add_watch_poll(GIOChannel *channel,
856 IOCanReadHandler *fd_can_read,
857 GIOFunc fd_read,
858 gpointer user_data)
860 IOWatchPoll *iwp;
861 int tag;
863 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs, sizeof(IOWatchPoll));
864 iwp->fd_can_read = fd_can_read;
865 iwp->opaque = user_data;
866 iwp->channel = channel;
867 iwp->fd_read = (GSourceFunc) fd_read;
868 iwp->src = NULL;
870 tag = g_source_attach(&iwp->parent, NULL);
871 g_source_unref(&iwp->parent);
872 return tag;
875 static void io_remove_watch_poll(guint tag)
877 GSource *source;
878 IOWatchPoll *iwp;
880 g_return_if_fail (tag > 0);
882 source = g_main_context_find_source_by_id(NULL, tag);
883 g_return_if_fail (source != NULL);
885 iwp = io_watch_poll_from_source(source);
886 if (iwp->src) {
887 g_source_destroy(iwp->src);
888 g_source_unref(iwp->src);
889 iwp->src = NULL;
891 g_source_destroy(&iwp->parent);
894 static void remove_fd_in_watch(CharDriverState *chr)
896 if (chr->fd_in_tag) {
897 io_remove_watch_poll(chr->fd_in_tag);
898 chr->fd_in_tag = 0;
902 #ifndef _WIN32
903 static GIOChannel *io_channel_from_fd(int fd)
905 GIOChannel *chan;
907 if (fd == -1) {
908 return NULL;
911 chan = g_io_channel_unix_new(fd);
913 g_io_channel_set_encoding(chan, NULL, NULL);
914 g_io_channel_set_buffered(chan, FALSE);
916 return chan;
918 #endif
920 static GIOChannel *io_channel_from_socket(int fd)
922 GIOChannel *chan;
924 if (fd == -1) {
925 return NULL;
928 #ifdef _WIN32
929 chan = g_io_channel_win32_new_socket(fd);
930 #else
931 chan = g_io_channel_unix_new(fd);
932 #endif
934 g_io_channel_set_encoding(chan, NULL, NULL);
935 g_io_channel_set_buffered(chan, FALSE);
937 return chan;
940 static int io_channel_send(GIOChannel *fd, const void *buf, size_t len)
942 size_t offset = 0;
943 GIOStatus status = G_IO_STATUS_NORMAL;
945 while (offset < len && status == G_IO_STATUS_NORMAL) {
946 gsize bytes_written = 0;
948 status = g_io_channel_write_chars(fd, buf + offset, len - offset,
949 &bytes_written, NULL);
950 offset += bytes_written;
953 if (offset > 0) {
954 return offset;
956 switch (status) {
957 case G_IO_STATUS_NORMAL:
958 g_assert(len == 0);
959 return 0;
960 case G_IO_STATUS_AGAIN:
961 errno = EAGAIN;
962 return -1;
963 default:
964 break;
966 errno = EINVAL;
967 return -1;
970 #ifndef _WIN32
972 typedef struct FDCharDriver {
973 CharDriverState *chr;
974 GIOChannel *fd_in, *fd_out;
975 int max_size;
976 QTAILQ_ENTRY(FDCharDriver) node;
977 } FDCharDriver;
979 /* Called with chr_write_lock held. */
980 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
982 FDCharDriver *s = chr->opaque;
984 return io_channel_send(s->fd_out, buf, len);
987 static gboolean fd_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
989 CharDriverState *chr = opaque;
990 FDCharDriver *s = chr->opaque;
991 int len;
992 uint8_t buf[READ_BUF_LEN];
993 GIOStatus status;
994 gsize bytes_read;
996 len = sizeof(buf);
997 if (len > s->max_size) {
998 len = s->max_size;
1000 if (len == 0) {
1001 return TRUE;
1004 status = g_io_channel_read_chars(chan, (gchar *)buf,
1005 len, &bytes_read, NULL);
1006 if (status == G_IO_STATUS_EOF) {
1007 remove_fd_in_watch(chr);
1008 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1009 return FALSE;
1011 if (status == G_IO_STATUS_NORMAL) {
1012 qemu_chr_be_write(chr, buf, bytes_read);
1015 return TRUE;
1018 static int fd_chr_read_poll(void *opaque)
1020 CharDriverState *chr = opaque;
1021 FDCharDriver *s = chr->opaque;
1023 s->max_size = qemu_chr_be_can_write(chr);
1024 return s->max_size;
1027 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1029 FDCharDriver *s = chr->opaque;
1030 return g_io_create_watch(s->fd_out, cond);
1033 static void fd_chr_update_read_handler(CharDriverState *chr)
1035 FDCharDriver *s = chr->opaque;
1037 remove_fd_in_watch(chr);
1038 if (s->fd_in) {
1039 chr->fd_in_tag = io_add_watch_poll(s->fd_in, fd_chr_read_poll,
1040 fd_chr_read, chr);
1044 static void fd_chr_close(struct CharDriverState *chr)
1046 FDCharDriver *s = chr->opaque;
1048 remove_fd_in_watch(chr);
1049 if (s->fd_in) {
1050 g_io_channel_unref(s->fd_in);
1052 if (s->fd_out) {
1053 g_io_channel_unref(s->fd_out);
1056 g_free(s);
1057 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1060 /* open a character device to a unix fd */
1061 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out)
1063 CharDriverState *chr;
1064 FDCharDriver *s;
1066 chr = qemu_chr_alloc();
1067 s = g_malloc0(sizeof(FDCharDriver));
1068 s->fd_in = io_channel_from_fd(fd_in);
1069 s->fd_out = io_channel_from_fd(fd_out);
1070 qemu_set_nonblock(fd_out);
1071 s->chr = chr;
1072 chr->opaque = s;
1073 chr->chr_add_watch = fd_chr_add_watch;
1074 chr->chr_write = fd_chr_write;
1075 chr->chr_update_read_handler = fd_chr_update_read_handler;
1076 chr->chr_close = fd_chr_close;
1078 return chr;
1081 static CharDriverState *qemu_chr_open_pipe(ChardevHostdev *opts)
1083 int fd_in, fd_out;
1084 char filename_in[CHR_MAX_FILENAME_SIZE];
1085 char filename_out[CHR_MAX_FILENAME_SIZE];
1086 const char *filename = opts->device;
1088 if (filename == NULL) {
1089 fprintf(stderr, "chardev: pipe: no filename given\n");
1090 return NULL;
1093 snprintf(filename_in, CHR_MAX_FILENAME_SIZE, "%s.in", filename);
1094 snprintf(filename_out, CHR_MAX_FILENAME_SIZE, "%s.out", filename);
1095 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1096 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1097 if (fd_in < 0 || fd_out < 0) {
1098 if (fd_in >= 0)
1099 close(fd_in);
1100 if (fd_out >= 0)
1101 close(fd_out);
1102 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1103 if (fd_in < 0) {
1104 return NULL;
1107 return qemu_chr_open_fd(fd_in, fd_out);
1110 /* init terminal so that we can grab keys */
1111 static struct termios oldtty;
1112 static int old_fd0_flags;
1113 static bool stdio_in_use;
1114 static bool stdio_allow_signal;
1115 static bool stdio_echo_state;
1117 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1119 static void term_exit(void)
1121 tcsetattr (0, TCSANOW, &oldtty);
1122 fcntl(0, F_SETFL, old_fd0_flags);
1125 static void term_stdio_handler(int sig)
1127 /* restore echo after resume from suspend. */
1128 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1131 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1133 struct termios tty;
1135 stdio_echo_state = echo;
1136 tty = oldtty;
1137 if (!echo) {
1138 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1139 |INLCR|IGNCR|ICRNL|IXON);
1140 tty.c_oflag |= OPOST;
1141 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1142 tty.c_cflag &= ~(CSIZE|PARENB);
1143 tty.c_cflag |= CS8;
1144 tty.c_cc[VMIN] = 1;
1145 tty.c_cc[VTIME] = 0;
1147 if (!stdio_allow_signal)
1148 tty.c_lflag &= ~ISIG;
1150 tcsetattr (0, TCSANOW, &tty);
1153 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1155 term_exit();
1156 fd_chr_close(chr);
1159 static CharDriverState *qemu_chr_open_stdio(ChardevStdio *opts)
1161 CharDriverState *chr;
1162 struct sigaction act;
1164 if (is_daemonized()) {
1165 error_report("cannot use stdio with -daemonize");
1166 return NULL;
1169 if (stdio_in_use) {
1170 error_report("cannot use stdio by multiple character devices");
1171 exit(1);
1174 stdio_in_use = true;
1175 old_fd0_flags = fcntl(0, F_GETFL);
1176 tcgetattr(0, &oldtty);
1177 qemu_set_nonblock(0);
1178 atexit(term_exit);
1180 memset(&act, 0, sizeof(act));
1181 act.sa_handler = term_stdio_handler;
1182 sigaction(SIGCONT, &act, NULL);
1184 chr = qemu_chr_open_fd(0, 1);
1185 chr->chr_close = qemu_chr_close_stdio;
1186 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1187 if (opts->has_signal) {
1188 stdio_allow_signal = opts->signal;
1190 qemu_chr_fe_set_echo(chr, false);
1192 return chr;
1195 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1196 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1197 || defined(__GLIBC__)
1199 #define HAVE_CHARDEV_TTY 1
1201 typedef struct {
1202 GIOChannel *fd;
1203 int read_bytes;
1205 /* Protected by the CharDriverState chr_write_lock. */
1206 int connected;
1207 guint timer_tag;
1208 guint open_tag;
1209 } PtyCharDriver;
1211 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1212 static void pty_chr_state(CharDriverState *chr, int connected);
1214 static gboolean pty_chr_timer(gpointer opaque)
1216 struct CharDriverState *chr = opaque;
1217 PtyCharDriver *s = chr->opaque;
1219 qemu_mutex_lock(&chr->chr_write_lock);
1220 s->timer_tag = 0;
1221 s->open_tag = 0;
1222 if (!s->connected) {
1223 /* Next poll ... */
1224 pty_chr_update_read_handler_locked(chr);
1226 qemu_mutex_unlock(&chr->chr_write_lock);
1227 return FALSE;
1230 /* Called with chr_write_lock held. */
1231 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1233 PtyCharDriver *s = chr->opaque;
1235 if (s->timer_tag) {
1236 g_source_remove(s->timer_tag);
1237 s->timer_tag = 0;
1240 if (ms == 1000) {
1241 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1242 } else {
1243 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1247 /* Called with chr_write_lock held. */
1248 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1250 PtyCharDriver *s = chr->opaque;
1251 GPollFD pfd;
1253 pfd.fd = g_io_channel_unix_get_fd(s->fd);
1254 pfd.events = G_IO_OUT;
1255 pfd.revents = 0;
1256 g_poll(&pfd, 1, 0);
1257 if (pfd.revents & G_IO_HUP) {
1258 pty_chr_state(chr, 0);
1259 } else {
1260 pty_chr_state(chr, 1);
1264 static void pty_chr_update_read_handler(CharDriverState *chr)
1266 qemu_mutex_lock(&chr->chr_write_lock);
1267 pty_chr_update_read_handler_locked(chr);
1268 qemu_mutex_unlock(&chr->chr_write_lock);
1271 /* Called with chr_write_lock held. */
1272 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1274 PtyCharDriver *s = chr->opaque;
1276 if (!s->connected) {
1277 /* guest sends data, check for (re-)connect */
1278 pty_chr_update_read_handler_locked(chr);
1279 if (!s->connected) {
1280 return 0;
1283 return io_channel_send(s->fd, buf, len);
1286 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1288 PtyCharDriver *s = chr->opaque;
1289 if (!s->connected) {
1290 return NULL;
1292 return g_io_create_watch(s->fd, cond);
1295 static int pty_chr_read_poll(void *opaque)
1297 CharDriverState *chr = opaque;
1298 PtyCharDriver *s = chr->opaque;
1300 s->read_bytes = qemu_chr_be_can_write(chr);
1301 return s->read_bytes;
1304 static gboolean pty_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
1306 CharDriverState *chr = opaque;
1307 PtyCharDriver *s = chr->opaque;
1308 gsize size, len;
1309 uint8_t buf[READ_BUF_LEN];
1310 GIOStatus status;
1312 len = sizeof(buf);
1313 if (len > s->read_bytes)
1314 len = s->read_bytes;
1315 if (len == 0) {
1316 return TRUE;
1318 status = g_io_channel_read_chars(s->fd, (gchar *)buf, len, &size, NULL);
1319 if (status != G_IO_STATUS_NORMAL) {
1320 pty_chr_state(chr, 0);
1321 return FALSE;
1322 } else {
1323 pty_chr_state(chr, 1);
1324 qemu_chr_be_write(chr, buf, size);
1326 return TRUE;
1329 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1331 CharDriverState *chr = opaque;
1332 PtyCharDriver *s = chr->opaque;
1334 s->open_tag = 0;
1335 qemu_chr_be_generic_open(chr);
1336 return FALSE;
1339 /* Called with chr_write_lock held. */
1340 static void pty_chr_state(CharDriverState *chr, int connected)
1342 PtyCharDriver *s = chr->opaque;
1344 if (!connected) {
1345 if (s->open_tag) {
1346 g_source_remove(s->open_tag);
1347 s->open_tag = 0;
1349 remove_fd_in_watch(chr);
1350 s->connected = 0;
1351 /* (re-)connect poll interval for idle guests: once per second.
1352 * We check more frequently in case the guests sends data to
1353 * the virtual device linked to our pty. */
1354 pty_chr_rearm_timer(chr, 1000);
1355 } else {
1356 if (s->timer_tag) {
1357 g_source_remove(s->timer_tag);
1358 s->timer_tag = 0;
1360 if (!s->connected) {
1361 g_assert(s->open_tag == 0);
1362 s->connected = 1;
1363 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1365 if (!chr->fd_in_tag) {
1366 chr->fd_in_tag = io_add_watch_poll(s->fd, pty_chr_read_poll,
1367 pty_chr_read, chr);
1372 static void pty_chr_close(struct CharDriverState *chr)
1374 PtyCharDriver *s = chr->opaque;
1375 int fd;
1377 qemu_mutex_lock(&chr->chr_write_lock);
1378 pty_chr_state(chr, 0);
1379 fd = g_io_channel_unix_get_fd(s->fd);
1380 g_io_channel_unref(s->fd);
1381 close(fd);
1382 if (s->timer_tag) {
1383 g_source_remove(s->timer_tag);
1384 s->timer_tag = 0;
1386 qemu_mutex_unlock(&chr->chr_write_lock);
1387 g_free(s);
1388 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1391 static CharDriverState *qemu_chr_open_pty(const char *id,
1392 ChardevReturn *ret)
1394 CharDriverState *chr;
1395 PtyCharDriver *s;
1396 int master_fd, slave_fd;
1397 char pty_name[PATH_MAX];
1399 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1400 if (master_fd < 0) {
1401 return NULL;
1404 close(slave_fd);
1405 qemu_set_nonblock(master_fd);
1407 chr = qemu_chr_alloc();
1409 chr->filename = g_strdup_printf("pty:%s", pty_name);
1410 ret->pty = g_strdup(pty_name);
1411 ret->has_pty = true;
1413 fprintf(stderr, "char device redirected to %s (label %s)\n",
1414 pty_name, id);
1416 s = g_malloc0(sizeof(PtyCharDriver));
1417 chr->opaque = s;
1418 chr->chr_write = pty_chr_write;
1419 chr->chr_update_read_handler = pty_chr_update_read_handler;
1420 chr->chr_close = pty_chr_close;
1421 chr->chr_add_watch = pty_chr_add_watch;
1422 chr->explicit_be_open = true;
1424 s->fd = io_channel_from_fd(master_fd);
1425 s->timer_tag = 0;
1427 return chr;
1430 static void tty_serial_init(int fd, int speed,
1431 int parity, int data_bits, int stop_bits)
1433 struct termios tty;
1434 speed_t spd;
1436 #if 0
1437 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1438 speed, parity, data_bits, stop_bits);
1439 #endif
1440 tcgetattr (fd, &tty);
1442 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1443 speed = speed * 10 / 11;
1444 do {
1445 check_speed(50);
1446 check_speed(75);
1447 check_speed(110);
1448 check_speed(134);
1449 check_speed(150);
1450 check_speed(200);
1451 check_speed(300);
1452 check_speed(600);
1453 check_speed(1200);
1454 check_speed(1800);
1455 check_speed(2400);
1456 check_speed(4800);
1457 check_speed(9600);
1458 check_speed(19200);
1459 check_speed(38400);
1460 /* Non-Posix values follow. They may be unsupported on some systems. */
1461 check_speed(57600);
1462 check_speed(115200);
1463 #ifdef B230400
1464 check_speed(230400);
1465 #endif
1466 #ifdef B460800
1467 check_speed(460800);
1468 #endif
1469 #ifdef B500000
1470 check_speed(500000);
1471 #endif
1472 #ifdef B576000
1473 check_speed(576000);
1474 #endif
1475 #ifdef B921600
1476 check_speed(921600);
1477 #endif
1478 #ifdef B1000000
1479 check_speed(1000000);
1480 #endif
1481 #ifdef B1152000
1482 check_speed(1152000);
1483 #endif
1484 #ifdef B1500000
1485 check_speed(1500000);
1486 #endif
1487 #ifdef B2000000
1488 check_speed(2000000);
1489 #endif
1490 #ifdef B2500000
1491 check_speed(2500000);
1492 #endif
1493 #ifdef B3000000
1494 check_speed(3000000);
1495 #endif
1496 #ifdef B3500000
1497 check_speed(3500000);
1498 #endif
1499 #ifdef B4000000
1500 check_speed(4000000);
1501 #endif
1502 spd = B115200;
1503 } while (0);
1505 cfsetispeed(&tty, spd);
1506 cfsetospeed(&tty, spd);
1508 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1509 |INLCR|IGNCR|ICRNL|IXON);
1510 tty.c_oflag |= OPOST;
1511 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1512 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1513 switch(data_bits) {
1514 default:
1515 case 8:
1516 tty.c_cflag |= CS8;
1517 break;
1518 case 7:
1519 tty.c_cflag |= CS7;
1520 break;
1521 case 6:
1522 tty.c_cflag |= CS6;
1523 break;
1524 case 5:
1525 tty.c_cflag |= CS5;
1526 break;
1528 switch(parity) {
1529 default:
1530 case 'N':
1531 break;
1532 case 'E':
1533 tty.c_cflag |= PARENB;
1534 break;
1535 case 'O':
1536 tty.c_cflag |= PARENB | PARODD;
1537 break;
1539 if (stop_bits == 2)
1540 tty.c_cflag |= CSTOPB;
1542 tcsetattr (fd, TCSANOW, &tty);
1545 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1547 FDCharDriver *s = chr->opaque;
1549 switch(cmd) {
1550 case CHR_IOCTL_SERIAL_SET_PARAMS:
1552 QEMUSerialSetParams *ssp = arg;
1553 tty_serial_init(g_io_channel_unix_get_fd(s->fd_in),
1554 ssp->speed, ssp->parity,
1555 ssp->data_bits, ssp->stop_bits);
1557 break;
1558 case CHR_IOCTL_SERIAL_SET_BREAK:
1560 int enable = *(int *)arg;
1561 if (enable) {
1562 tcsendbreak(g_io_channel_unix_get_fd(s->fd_in), 1);
1565 break;
1566 case CHR_IOCTL_SERIAL_GET_TIOCM:
1568 int sarg = 0;
1569 int *targ = (int *)arg;
1570 ioctl(g_io_channel_unix_get_fd(s->fd_in), TIOCMGET, &sarg);
1571 *targ = 0;
1572 if (sarg & TIOCM_CTS)
1573 *targ |= CHR_TIOCM_CTS;
1574 if (sarg & TIOCM_CAR)
1575 *targ |= CHR_TIOCM_CAR;
1576 if (sarg & TIOCM_DSR)
1577 *targ |= CHR_TIOCM_DSR;
1578 if (sarg & TIOCM_RI)
1579 *targ |= CHR_TIOCM_RI;
1580 if (sarg & TIOCM_DTR)
1581 *targ |= CHR_TIOCM_DTR;
1582 if (sarg & TIOCM_RTS)
1583 *targ |= CHR_TIOCM_RTS;
1585 break;
1586 case CHR_IOCTL_SERIAL_SET_TIOCM:
1588 int sarg = *(int *)arg;
1589 int targ = 0;
1590 ioctl(g_io_channel_unix_get_fd(s->fd_in), TIOCMGET, &targ);
1591 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1592 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1593 if (sarg & CHR_TIOCM_CTS)
1594 targ |= TIOCM_CTS;
1595 if (sarg & CHR_TIOCM_CAR)
1596 targ |= TIOCM_CAR;
1597 if (sarg & CHR_TIOCM_DSR)
1598 targ |= TIOCM_DSR;
1599 if (sarg & CHR_TIOCM_RI)
1600 targ |= TIOCM_RI;
1601 if (sarg & CHR_TIOCM_DTR)
1602 targ |= TIOCM_DTR;
1603 if (sarg & CHR_TIOCM_RTS)
1604 targ |= TIOCM_RTS;
1605 ioctl(g_io_channel_unix_get_fd(s->fd_in), TIOCMSET, &targ);
1607 break;
1608 default:
1609 return -ENOTSUP;
1611 return 0;
1614 static void qemu_chr_close_tty(CharDriverState *chr)
1616 FDCharDriver *s = chr->opaque;
1617 int fd = -1;
1619 if (s) {
1620 fd = g_io_channel_unix_get_fd(s->fd_in);
1623 fd_chr_close(chr);
1625 if (fd >= 0) {
1626 close(fd);
1630 static CharDriverState *qemu_chr_open_tty_fd(int fd)
1632 CharDriverState *chr;
1634 tty_serial_init(fd, 115200, 'N', 8, 1);
1635 chr = qemu_chr_open_fd(fd, fd);
1636 chr->chr_ioctl = tty_serial_ioctl;
1637 chr->chr_close = qemu_chr_close_tty;
1638 return chr;
1640 #endif /* __linux__ || __sun__ */
1642 #if defined(__linux__)
1644 #define HAVE_CHARDEV_PARPORT 1
1646 typedef struct {
1647 int fd;
1648 int mode;
1649 } ParallelCharDriver;
1651 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1653 if (s->mode != mode) {
1654 int m = mode;
1655 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1656 return 0;
1657 s->mode = mode;
1659 return 1;
1662 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1664 ParallelCharDriver *drv = chr->opaque;
1665 int fd = drv->fd;
1666 uint8_t b;
1668 switch(cmd) {
1669 case CHR_IOCTL_PP_READ_DATA:
1670 if (ioctl(fd, PPRDATA, &b) < 0)
1671 return -ENOTSUP;
1672 *(uint8_t *)arg = b;
1673 break;
1674 case CHR_IOCTL_PP_WRITE_DATA:
1675 b = *(uint8_t *)arg;
1676 if (ioctl(fd, PPWDATA, &b) < 0)
1677 return -ENOTSUP;
1678 break;
1679 case CHR_IOCTL_PP_READ_CONTROL:
1680 if (ioctl(fd, PPRCONTROL, &b) < 0)
1681 return -ENOTSUP;
1682 /* Linux gives only the lowest bits, and no way to know data
1683 direction! For better compatibility set the fixed upper
1684 bits. */
1685 *(uint8_t *)arg = b | 0xc0;
1686 break;
1687 case CHR_IOCTL_PP_WRITE_CONTROL:
1688 b = *(uint8_t *)arg;
1689 if (ioctl(fd, PPWCONTROL, &b) < 0)
1690 return -ENOTSUP;
1691 break;
1692 case CHR_IOCTL_PP_READ_STATUS:
1693 if (ioctl(fd, PPRSTATUS, &b) < 0)
1694 return -ENOTSUP;
1695 *(uint8_t *)arg = b;
1696 break;
1697 case CHR_IOCTL_PP_DATA_DIR:
1698 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1699 return -ENOTSUP;
1700 break;
1701 case CHR_IOCTL_PP_EPP_READ_ADDR:
1702 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1703 struct ParallelIOArg *parg = arg;
1704 int n = read(fd, parg->buffer, parg->count);
1705 if (n != parg->count) {
1706 return -EIO;
1709 break;
1710 case CHR_IOCTL_PP_EPP_READ:
1711 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1712 struct ParallelIOArg *parg = arg;
1713 int n = read(fd, parg->buffer, parg->count);
1714 if (n != parg->count) {
1715 return -EIO;
1718 break;
1719 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1720 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1721 struct ParallelIOArg *parg = arg;
1722 int n = write(fd, parg->buffer, parg->count);
1723 if (n != parg->count) {
1724 return -EIO;
1727 break;
1728 case CHR_IOCTL_PP_EPP_WRITE:
1729 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1730 struct ParallelIOArg *parg = arg;
1731 int n = write(fd, parg->buffer, parg->count);
1732 if (n != parg->count) {
1733 return -EIO;
1736 break;
1737 default:
1738 return -ENOTSUP;
1740 return 0;
1743 static void pp_close(CharDriverState *chr)
1745 ParallelCharDriver *drv = chr->opaque;
1746 int fd = drv->fd;
1748 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1749 ioctl(fd, PPRELEASE);
1750 close(fd);
1751 g_free(drv);
1752 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1755 static CharDriverState *qemu_chr_open_pp_fd(int fd)
1757 CharDriverState *chr;
1758 ParallelCharDriver *drv;
1760 if (ioctl(fd, PPCLAIM) < 0) {
1761 close(fd);
1762 return NULL;
1765 drv = g_malloc0(sizeof(ParallelCharDriver));
1766 drv->fd = fd;
1767 drv->mode = IEEE1284_MODE_COMPAT;
1769 chr = qemu_chr_alloc();
1770 chr->chr_write = null_chr_write;
1771 chr->chr_ioctl = pp_ioctl;
1772 chr->chr_close = pp_close;
1773 chr->opaque = drv;
1775 return chr;
1777 #endif /* __linux__ */
1779 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1781 #define HAVE_CHARDEV_PARPORT 1
1783 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1785 int fd = (int)(intptr_t)chr->opaque;
1786 uint8_t b;
1788 switch(cmd) {
1789 case CHR_IOCTL_PP_READ_DATA:
1790 if (ioctl(fd, PPIGDATA, &b) < 0)
1791 return -ENOTSUP;
1792 *(uint8_t *)arg = b;
1793 break;
1794 case CHR_IOCTL_PP_WRITE_DATA:
1795 b = *(uint8_t *)arg;
1796 if (ioctl(fd, PPISDATA, &b) < 0)
1797 return -ENOTSUP;
1798 break;
1799 case CHR_IOCTL_PP_READ_CONTROL:
1800 if (ioctl(fd, PPIGCTRL, &b) < 0)
1801 return -ENOTSUP;
1802 *(uint8_t *)arg = b;
1803 break;
1804 case CHR_IOCTL_PP_WRITE_CONTROL:
1805 b = *(uint8_t *)arg;
1806 if (ioctl(fd, PPISCTRL, &b) < 0)
1807 return -ENOTSUP;
1808 break;
1809 case CHR_IOCTL_PP_READ_STATUS:
1810 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1811 return -ENOTSUP;
1812 *(uint8_t *)arg = b;
1813 break;
1814 default:
1815 return -ENOTSUP;
1817 return 0;
1820 static CharDriverState *qemu_chr_open_pp_fd(int fd)
1822 CharDriverState *chr;
1824 chr = qemu_chr_alloc();
1825 chr->opaque = (void *)(intptr_t)fd;
1826 chr->chr_write = null_chr_write;
1827 chr->chr_ioctl = pp_ioctl;
1828 chr->explicit_be_open = true;
1829 return chr;
1831 #endif
1833 #else /* _WIN32 */
1835 typedef struct {
1836 int max_size;
1837 HANDLE hcom, hrecv, hsend;
1838 OVERLAPPED orecv;
1839 BOOL fpipe;
1840 DWORD len;
1842 /* Protected by the CharDriverState chr_write_lock. */
1843 OVERLAPPED osend;
1844 } WinCharState;
1846 typedef struct {
1847 HANDLE hStdIn;
1848 HANDLE hInputReadyEvent;
1849 HANDLE hInputDoneEvent;
1850 HANDLE hInputThread;
1851 uint8_t win_stdio_buf;
1852 } WinStdioCharState;
1854 #define NSENDBUF 2048
1855 #define NRECVBUF 2048
1856 #define MAXCONNECT 1
1857 #define NTIMEOUT 5000
1859 static int win_chr_poll(void *opaque);
1860 static int win_chr_pipe_poll(void *opaque);
1862 static void win_chr_close(CharDriverState *chr)
1864 WinCharState *s = chr->opaque;
1866 if (s->hsend) {
1867 CloseHandle(s->hsend);
1868 s->hsend = NULL;
1870 if (s->hrecv) {
1871 CloseHandle(s->hrecv);
1872 s->hrecv = NULL;
1874 if (s->hcom) {
1875 CloseHandle(s->hcom);
1876 s->hcom = NULL;
1878 if (s->fpipe)
1879 qemu_del_polling_cb(win_chr_pipe_poll, chr);
1880 else
1881 qemu_del_polling_cb(win_chr_poll, chr);
1883 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1886 static int win_chr_init(CharDriverState *chr, const char *filename)
1888 WinCharState *s = chr->opaque;
1889 COMMCONFIG comcfg;
1890 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
1891 COMSTAT comstat;
1892 DWORD size;
1893 DWORD err;
1895 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
1896 if (!s->hsend) {
1897 fprintf(stderr, "Failed CreateEvent\n");
1898 goto fail;
1900 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
1901 if (!s->hrecv) {
1902 fprintf(stderr, "Failed CreateEvent\n");
1903 goto fail;
1906 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
1907 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
1908 if (s->hcom == INVALID_HANDLE_VALUE) {
1909 fprintf(stderr, "Failed CreateFile (%lu)\n", GetLastError());
1910 s->hcom = NULL;
1911 goto fail;
1914 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
1915 fprintf(stderr, "Failed SetupComm\n");
1916 goto fail;
1919 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
1920 size = sizeof(COMMCONFIG);
1921 GetDefaultCommConfig(filename, &comcfg, &size);
1922 comcfg.dcb.DCBlength = sizeof(DCB);
1923 CommConfigDialog(filename, NULL, &comcfg);
1925 if (!SetCommState(s->hcom, &comcfg.dcb)) {
1926 fprintf(stderr, "Failed SetCommState\n");
1927 goto fail;
1930 if (!SetCommMask(s->hcom, EV_ERR)) {
1931 fprintf(stderr, "Failed SetCommMask\n");
1932 goto fail;
1935 cto.ReadIntervalTimeout = MAXDWORD;
1936 if (!SetCommTimeouts(s->hcom, &cto)) {
1937 fprintf(stderr, "Failed SetCommTimeouts\n");
1938 goto fail;
1941 if (!ClearCommError(s->hcom, &err, &comstat)) {
1942 fprintf(stderr, "Failed ClearCommError\n");
1943 goto fail;
1945 qemu_add_polling_cb(win_chr_poll, chr);
1946 return 0;
1948 fail:
1949 win_chr_close(chr);
1950 return -1;
1953 /* Called with chr_write_lock held. */
1954 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
1956 WinCharState *s = chr->opaque;
1957 DWORD len, ret, size, err;
1959 len = len1;
1960 ZeroMemory(&s->osend, sizeof(s->osend));
1961 s->osend.hEvent = s->hsend;
1962 while (len > 0) {
1963 if (s->hsend)
1964 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
1965 else
1966 ret = WriteFile(s->hcom, buf, len, &size, NULL);
1967 if (!ret) {
1968 err = GetLastError();
1969 if (err == ERROR_IO_PENDING) {
1970 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
1971 if (ret) {
1972 buf += size;
1973 len -= size;
1974 } else {
1975 break;
1977 } else {
1978 break;
1980 } else {
1981 buf += size;
1982 len -= size;
1985 return len1 - len;
1988 static int win_chr_read_poll(CharDriverState *chr)
1990 WinCharState *s = chr->opaque;
1992 s->max_size = qemu_chr_be_can_write(chr);
1993 return s->max_size;
1996 static void win_chr_readfile(CharDriverState *chr)
1998 WinCharState *s = chr->opaque;
1999 int ret, err;
2000 uint8_t buf[READ_BUF_LEN];
2001 DWORD size;
2003 ZeroMemory(&s->orecv, sizeof(s->orecv));
2004 s->orecv.hEvent = s->hrecv;
2005 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2006 if (!ret) {
2007 err = GetLastError();
2008 if (err == ERROR_IO_PENDING) {
2009 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2013 if (size > 0) {
2014 qemu_chr_be_write(chr, buf, size);
2018 static void win_chr_read(CharDriverState *chr)
2020 WinCharState *s = chr->opaque;
2022 if (s->len > s->max_size)
2023 s->len = s->max_size;
2024 if (s->len == 0)
2025 return;
2027 win_chr_readfile(chr);
2030 static int win_chr_poll(void *opaque)
2032 CharDriverState *chr = opaque;
2033 WinCharState *s = chr->opaque;
2034 COMSTAT status;
2035 DWORD comerr;
2037 ClearCommError(s->hcom, &comerr, &status);
2038 if (status.cbInQue > 0) {
2039 s->len = status.cbInQue;
2040 win_chr_read_poll(chr);
2041 win_chr_read(chr);
2042 return 1;
2044 return 0;
2047 static CharDriverState *qemu_chr_open_win_path(const char *filename)
2049 CharDriverState *chr;
2050 WinCharState *s;
2052 chr = qemu_chr_alloc();
2053 s = g_malloc0(sizeof(WinCharState));
2054 chr->opaque = s;
2055 chr->chr_write = win_chr_write;
2056 chr->chr_close = win_chr_close;
2058 if (win_chr_init(chr, filename) < 0) {
2059 g_free(s);
2060 g_free(chr);
2061 return NULL;
2063 return chr;
2066 static int win_chr_pipe_poll(void *opaque)
2068 CharDriverState *chr = opaque;
2069 WinCharState *s = chr->opaque;
2070 DWORD size;
2072 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2073 if (size > 0) {
2074 s->len = size;
2075 win_chr_read_poll(chr);
2076 win_chr_read(chr);
2077 return 1;
2079 return 0;
2082 static int win_chr_pipe_init(CharDriverState *chr, const char *filename)
2084 WinCharState *s = chr->opaque;
2085 OVERLAPPED ov;
2086 int ret;
2087 DWORD size;
2088 char openname[CHR_MAX_FILENAME_SIZE];
2090 s->fpipe = TRUE;
2092 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2093 if (!s->hsend) {
2094 fprintf(stderr, "Failed CreateEvent\n");
2095 goto fail;
2097 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2098 if (!s->hrecv) {
2099 fprintf(stderr, "Failed CreateEvent\n");
2100 goto fail;
2103 snprintf(openname, sizeof(openname), "\\\\.\\pipe\\%s", filename);
2104 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2105 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2106 PIPE_WAIT,
2107 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2108 if (s->hcom == INVALID_HANDLE_VALUE) {
2109 fprintf(stderr, "Failed CreateNamedPipe (%lu)\n", GetLastError());
2110 s->hcom = NULL;
2111 goto fail;
2114 ZeroMemory(&ov, sizeof(ov));
2115 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2116 ret = ConnectNamedPipe(s->hcom, &ov);
2117 if (ret) {
2118 fprintf(stderr, "Failed ConnectNamedPipe\n");
2119 goto fail;
2122 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2123 if (!ret) {
2124 fprintf(stderr, "Failed GetOverlappedResult\n");
2125 if (ov.hEvent) {
2126 CloseHandle(ov.hEvent);
2127 ov.hEvent = NULL;
2129 goto fail;
2132 if (ov.hEvent) {
2133 CloseHandle(ov.hEvent);
2134 ov.hEvent = NULL;
2136 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2137 return 0;
2139 fail:
2140 win_chr_close(chr);
2141 return -1;
2145 static CharDriverState *qemu_chr_open_pipe(ChardevHostdev *opts)
2147 const char *filename = opts->device;
2148 CharDriverState *chr;
2149 WinCharState *s;
2151 chr = qemu_chr_alloc();
2152 s = g_malloc0(sizeof(WinCharState));
2153 chr->opaque = s;
2154 chr->chr_write = win_chr_write;
2155 chr->chr_close = win_chr_close;
2157 if (win_chr_pipe_init(chr, filename) < 0) {
2158 g_free(s);
2159 g_free(chr);
2160 return NULL;
2162 return chr;
2165 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out)
2167 CharDriverState *chr;
2168 WinCharState *s;
2170 chr = qemu_chr_alloc();
2171 s = g_malloc0(sizeof(WinCharState));
2172 s->hcom = fd_out;
2173 chr->opaque = s;
2174 chr->chr_write = win_chr_write;
2175 return chr;
2178 static CharDriverState *qemu_chr_open_win_con(void)
2180 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE));
2183 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2185 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2186 DWORD dwSize;
2187 int len1;
2189 len1 = len;
2191 while (len1 > 0) {
2192 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2193 break;
2195 buf += dwSize;
2196 len1 -= dwSize;
2199 return len - len1;
2202 static void win_stdio_wait_func(void *opaque)
2204 CharDriverState *chr = opaque;
2205 WinStdioCharState *stdio = chr->opaque;
2206 INPUT_RECORD buf[4];
2207 int ret;
2208 DWORD dwSize;
2209 int i;
2211 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2213 if (!ret) {
2214 /* Avoid error storm */
2215 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2216 return;
2219 for (i = 0; i < dwSize; i++) {
2220 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2222 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2223 int j;
2224 if (kev->uChar.AsciiChar != 0) {
2225 for (j = 0; j < kev->wRepeatCount; j++) {
2226 if (qemu_chr_be_can_write(chr)) {
2227 uint8_t c = kev->uChar.AsciiChar;
2228 qemu_chr_be_write(chr, &c, 1);
2236 static DWORD WINAPI win_stdio_thread(LPVOID param)
2238 CharDriverState *chr = param;
2239 WinStdioCharState *stdio = chr->opaque;
2240 int ret;
2241 DWORD dwSize;
2243 while (1) {
2245 /* Wait for one byte */
2246 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2248 /* Exit in case of error, continue if nothing read */
2249 if (!ret) {
2250 break;
2252 if (!dwSize) {
2253 continue;
2256 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2257 if (stdio->win_stdio_buf == '\r') {
2258 continue;
2261 /* Signal the main thread and wait until the byte was eaten */
2262 if (!SetEvent(stdio->hInputReadyEvent)) {
2263 break;
2265 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2266 != WAIT_OBJECT_0) {
2267 break;
2271 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2272 return 0;
2275 static void win_stdio_thread_wait_func(void *opaque)
2277 CharDriverState *chr = opaque;
2278 WinStdioCharState *stdio = chr->opaque;
2280 if (qemu_chr_be_can_write(chr)) {
2281 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2284 SetEvent(stdio->hInputDoneEvent);
2287 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2289 WinStdioCharState *stdio = chr->opaque;
2290 DWORD dwMode = 0;
2292 GetConsoleMode(stdio->hStdIn, &dwMode);
2294 if (echo) {
2295 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2296 } else {
2297 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2301 static void win_stdio_close(CharDriverState *chr)
2303 WinStdioCharState *stdio = chr->opaque;
2305 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2306 CloseHandle(stdio->hInputReadyEvent);
2308 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2309 CloseHandle(stdio->hInputDoneEvent);
2311 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2312 TerminateThread(stdio->hInputThread, 0);
2315 g_free(chr->opaque);
2316 g_free(chr);
2319 static CharDriverState *qemu_chr_open_stdio(ChardevStdio *opts)
2321 CharDriverState *chr;
2322 WinStdioCharState *stdio;
2323 DWORD dwMode;
2324 int is_console = 0;
2326 chr = qemu_chr_alloc();
2327 stdio = g_malloc0(sizeof(WinStdioCharState));
2329 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2330 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2331 fprintf(stderr, "cannot open stdio: invalid handle\n");
2332 exit(1);
2335 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2337 chr->opaque = stdio;
2338 chr->chr_write = win_stdio_write;
2339 chr->chr_close = win_stdio_close;
2341 if (is_console) {
2342 if (qemu_add_wait_object(stdio->hStdIn,
2343 win_stdio_wait_func, chr)) {
2344 fprintf(stderr, "qemu_add_wait_object: failed\n");
2346 } else {
2347 DWORD dwId;
2349 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2350 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2351 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2352 chr, 0, &dwId);
2354 if (stdio->hInputThread == INVALID_HANDLE_VALUE
2355 || stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2356 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2357 fprintf(stderr, "cannot create stdio thread or event\n");
2358 exit(1);
2360 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2361 win_stdio_thread_wait_func, chr)) {
2362 fprintf(stderr, "qemu_add_wait_object: failed\n");
2366 dwMode |= ENABLE_LINE_INPUT;
2368 if (is_console) {
2369 /* set the terminal in raw mode */
2370 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2371 dwMode |= ENABLE_PROCESSED_INPUT;
2374 SetConsoleMode(stdio->hStdIn, dwMode);
2376 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2377 qemu_chr_fe_set_echo(chr, false);
2379 return chr;
2381 #endif /* !_WIN32 */
2384 /***********************************************************/
2385 /* UDP Net console */
2387 typedef struct {
2388 int fd;
2389 GIOChannel *chan;
2390 uint8_t buf[READ_BUF_LEN];
2391 int bufcnt;
2392 int bufptr;
2393 int max_size;
2394 } NetCharDriver;
2396 /* Called with chr_write_lock held. */
2397 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2399 NetCharDriver *s = chr->opaque;
2400 gsize bytes_written;
2401 GIOStatus status;
2403 status = g_io_channel_write_chars(s->chan, (const gchar *)buf, len, &bytes_written, NULL);
2404 if (status == G_IO_STATUS_EOF) {
2405 return 0;
2406 } else if (status != G_IO_STATUS_NORMAL) {
2407 return -1;
2410 return bytes_written;
2413 static int udp_chr_read_poll(void *opaque)
2415 CharDriverState *chr = opaque;
2416 NetCharDriver *s = chr->opaque;
2418 s->max_size = qemu_chr_be_can_write(chr);
2420 /* If there were any stray characters in the queue process them
2421 * first
2423 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2424 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2425 s->bufptr++;
2426 s->max_size = qemu_chr_be_can_write(chr);
2428 return s->max_size;
2431 static gboolean udp_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
2433 CharDriverState *chr = opaque;
2434 NetCharDriver *s = chr->opaque;
2435 gsize bytes_read = 0;
2436 GIOStatus status;
2438 if (s->max_size == 0) {
2439 return TRUE;
2441 status = g_io_channel_read_chars(s->chan, (gchar *)s->buf, sizeof(s->buf),
2442 &bytes_read, NULL);
2443 s->bufcnt = bytes_read;
2444 s->bufptr = s->bufcnt;
2445 if (status != G_IO_STATUS_NORMAL) {
2446 remove_fd_in_watch(chr);
2447 return FALSE;
2450 s->bufptr = 0;
2451 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2452 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2453 s->bufptr++;
2454 s->max_size = qemu_chr_be_can_write(chr);
2457 return TRUE;
2460 static void udp_chr_update_read_handler(CharDriverState *chr)
2462 NetCharDriver *s = chr->opaque;
2464 remove_fd_in_watch(chr);
2465 if (s->chan) {
2466 chr->fd_in_tag = io_add_watch_poll(s->chan, udp_chr_read_poll,
2467 udp_chr_read, chr);
2471 static void udp_chr_close(CharDriverState *chr)
2473 NetCharDriver *s = chr->opaque;
2475 remove_fd_in_watch(chr);
2476 if (s->chan) {
2477 g_io_channel_unref(s->chan);
2478 closesocket(s->fd);
2480 g_free(s);
2481 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2484 static CharDriverState *qemu_chr_open_udp_fd(int fd)
2486 CharDriverState *chr = NULL;
2487 NetCharDriver *s = NULL;
2489 chr = qemu_chr_alloc();
2490 s = g_malloc0(sizeof(NetCharDriver));
2492 s->fd = fd;
2493 s->chan = io_channel_from_socket(s->fd);
2494 s->bufcnt = 0;
2495 s->bufptr = 0;
2496 chr->opaque = s;
2497 chr->chr_write = udp_chr_write;
2498 chr->chr_update_read_handler = udp_chr_update_read_handler;
2499 chr->chr_close = udp_chr_close;
2500 /* be isn't opened until we get a connection */
2501 chr->explicit_be_open = true;
2502 return chr;
2505 /***********************************************************/
2506 /* TCP Net console */
2508 typedef struct {
2510 GIOChannel *chan, *listen_chan;
2511 guint listen_tag;
2512 int fd, listen_fd;
2513 int connected;
2514 int max_size;
2515 int do_telnetopt;
2516 int do_nodelay;
2517 int is_unix;
2518 int *read_msgfds;
2519 int read_msgfds_num;
2520 int *write_msgfds;
2521 int write_msgfds_num;
2523 SocketAddress *addr;
2524 bool is_listen;
2525 bool is_telnet;
2527 guint reconnect_timer;
2528 int64_t reconnect_time;
2529 bool connect_err_reported;
2530 } TCPCharDriver;
2532 static gboolean socket_reconnect_timeout(gpointer opaque);
2534 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2536 TCPCharDriver *s = chr->opaque;
2537 assert(s->connected == 0);
2538 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2539 socket_reconnect_timeout, chr);
2542 static void check_report_connect_error(CharDriverState *chr,
2543 Error *err)
2545 TCPCharDriver *s = chr->opaque;
2547 if (!s->connect_err_reported) {
2548 error_report("Unable to connect character device %s: %s",
2549 chr->label, error_get_pretty(err));
2550 s->connect_err_reported = true;
2552 qemu_chr_socket_restart_timer(chr);
2555 static gboolean tcp_chr_accept(GIOChannel *chan, GIOCondition cond, void *opaque);
2557 #ifndef _WIN32
2558 static int unix_send_msgfds(CharDriverState *chr, const uint8_t *buf, int len)
2560 TCPCharDriver *s = chr->opaque;
2561 struct msghdr msgh;
2562 struct iovec iov;
2563 int r;
2565 size_t fd_size = s->write_msgfds_num * sizeof(int);
2566 char control[CMSG_SPACE(fd_size)];
2567 struct cmsghdr *cmsg;
2569 memset(&msgh, 0, sizeof(msgh));
2570 memset(control, 0, sizeof(control));
2572 /* set the payload */
2573 iov.iov_base = (uint8_t *) buf;
2574 iov.iov_len = len;
2576 msgh.msg_iov = &iov;
2577 msgh.msg_iovlen = 1;
2579 msgh.msg_control = control;
2580 msgh.msg_controllen = sizeof(control);
2582 cmsg = CMSG_FIRSTHDR(&msgh);
2584 cmsg->cmsg_len = CMSG_LEN(fd_size);
2585 cmsg->cmsg_level = SOL_SOCKET;
2586 cmsg->cmsg_type = SCM_RIGHTS;
2587 memcpy(CMSG_DATA(cmsg), s->write_msgfds, fd_size);
2589 do {
2590 r = sendmsg(s->fd, &msgh, 0);
2591 } while (r < 0 && errno == EINTR);
2593 /* free the written msgfds, no matter what */
2594 if (s->write_msgfds_num) {
2595 g_free(s->write_msgfds);
2596 s->write_msgfds = 0;
2597 s->write_msgfds_num = 0;
2600 return r;
2602 #endif
2604 /* Called with chr_write_lock held. */
2605 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2607 TCPCharDriver *s = chr->opaque;
2608 if (s->connected) {
2609 #ifndef _WIN32
2610 if (s->is_unix && s->write_msgfds_num) {
2611 return unix_send_msgfds(chr, buf, len);
2612 } else
2613 #endif
2615 return io_channel_send(s->chan, buf, len);
2617 } else {
2618 /* XXX: indicate an error ? */
2619 return len;
2623 static int tcp_chr_read_poll(void *opaque)
2625 CharDriverState *chr = opaque;
2626 TCPCharDriver *s = chr->opaque;
2627 if (!s->connected)
2628 return 0;
2629 s->max_size = qemu_chr_be_can_write(chr);
2630 return s->max_size;
2633 #define IAC 255
2634 #define IAC_BREAK 243
2635 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2636 TCPCharDriver *s,
2637 uint8_t *buf, int *size)
2639 /* Handle any telnet client's basic IAC options to satisfy char by
2640 * char mode with no echo. All IAC options will be removed from
2641 * the buf and the do_telnetopt variable will be used to track the
2642 * state of the width of the IAC information.
2644 * IAC commands come in sets of 3 bytes with the exception of the
2645 * "IAC BREAK" command and the double IAC.
2648 int i;
2649 int j = 0;
2651 for (i = 0; i < *size; i++) {
2652 if (s->do_telnetopt > 1) {
2653 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2654 /* Double IAC means send an IAC */
2655 if (j != i)
2656 buf[j] = buf[i];
2657 j++;
2658 s->do_telnetopt = 1;
2659 } else {
2660 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2661 /* Handle IAC break commands by sending a serial break */
2662 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2663 s->do_telnetopt++;
2665 s->do_telnetopt++;
2667 if (s->do_telnetopt >= 4) {
2668 s->do_telnetopt = 1;
2670 } else {
2671 if ((unsigned char)buf[i] == IAC) {
2672 s->do_telnetopt = 2;
2673 } else {
2674 if (j != i)
2675 buf[j] = buf[i];
2676 j++;
2680 *size = j;
2683 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2685 TCPCharDriver *s = chr->opaque;
2686 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2688 assert(num <= TCP_MAX_FDS);
2690 if (to_copy) {
2691 int i;
2693 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2695 /* Close unused fds */
2696 for (i = to_copy; i < s->read_msgfds_num; i++) {
2697 close(s->read_msgfds[i]);
2700 g_free(s->read_msgfds);
2701 s->read_msgfds = 0;
2702 s->read_msgfds_num = 0;
2705 return to_copy;
2708 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2710 TCPCharDriver *s = chr->opaque;
2712 /* clear old pending fd array */
2713 if (s->write_msgfds) {
2714 g_free(s->write_msgfds);
2717 if (num) {
2718 s->write_msgfds = g_malloc(num * sizeof(int));
2719 memcpy(s->write_msgfds, fds, num * sizeof(int));
2722 s->write_msgfds_num = num;
2724 return 0;
2727 #ifndef _WIN32
2728 static void unix_process_msgfd(CharDriverState *chr, struct msghdr *msg)
2730 TCPCharDriver *s = chr->opaque;
2731 struct cmsghdr *cmsg;
2733 for (cmsg = CMSG_FIRSTHDR(msg); cmsg; cmsg = CMSG_NXTHDR(msg, cmsg)) {
2734 int fd_size, i;
2736 if (cmsg->cmsg_len < CMSG_LEN(sizeof(int)) ||
2737 cmsg->cmsg_level != SOL_SOCKET ||
2738 cmsg->cmsg_type != SCM_RIGHTS) {
2739 continue;
2742 fd_size = cmsg->cmsg_len - CMSG_LEN(0);
2744 if (!fd_size) {
2745 continue;
2748 /* close and clean read_msgfds */
2749 for (i = 0; i < s->read_msgfds_num; i++) {
2750 close(s->read_msgfds[i]);
2753 if (s->read_msgfds_num) {
2754 g_free(s->read_msgfds);
2757 s->read_msgfds_num = fd_size / sizeof(int);
2758 s->read_msgfds = g_malloc(fd_size);
2759 memcpy(s->read_msgfds, CMSG_DATA(cmsg), fd_size);
2761 for (i = 0; i < s->read_msgfds_num; i++) {
2762 int fd = s->read_msgfds[i];
2763 if (fd < 0) {
2764 continue;
2767 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2768 qemu_set_block(fd);
2770 #ifndef MSG_CMSG_CLOEXEC
2771 qemu_set_cloexec(fd);
2772 #endif
2777 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2779 TCPCharDriver *s = chr->opaque;
2780 struct msghdr msg = { NULL, };
2781 struct iovec iov[1];
2782 union {
2783 struct cmsghdr cmsg;
2784 char control[CMSG_SPACE(sizeof(int) * TCP_MAX_FDS)];
2785 } msg_control;
2786 int flags = 0;
2787 ssize_t ret;
2789 iov[0].iov_base = buf;
2790 iov[0].iov_len = len;
2792 msg.msg_iov = iov;
2793 msg.msg_iovlen = 1;
2794 msg.msg_control = &msg_control;
2795 msg.msg_controllen = sizeof(msg_control);
2797 #ifdef MSG_CMSG_CLOEXEC
2798 flags |= MSG_CMSG_CLOEXEC;
2799 #endif
2800 ret = recvmsg(s->fd, &msg, flags);
2801 if (ret > 0 && s->is_unix) {
2802 unix_process_msgfd(chr, &msg);
2805 return ret;
2807 #else
2808 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2810 TCPCharDriver *s = chr->opaque;
2811 return qemu_recv(s->fd, buf, len, 0);
2813 #endif
2815 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2817 TCPCharDriver *s = chr->opaque;
2818 return g_io_create_watch(s->chan, cond);
2821 static void tcp_chr_disconnect(CharDriverState *chr)
2823 TCPCharDriver *s = chr->opaque;
2825 s->connected = 0;
2826 if (s->listen_chan) {
2827 s->listen_tag = g_io_add_watch(s->listen_chan, G_IO_IN,
2828 tcp_chr_accept, chr);
2830 remove_fd_in_watch(chr);
2831 g_io_channel_unref(s->chan);
2832 s->chan = NULL;
2833 closesocket(s->fd);
2834 s->fd = -1;
2835 SocketAddress_to_str(chr->filename, CHR_MAX_FILENAME_SIZE,
2836 "disconnected:", s->addr, s->is_listen, s->is_telnet);
2837 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2838 if (s->reconnect_time) {
2839 qemu_chr_socket_restart_timer(chr);
2843 static gboolean tcp_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
2845 CharDriverState *chr = opaque;
2846 TCPCharDriver *s = chr->opaque;
2847 uint8_t buf[READ_BUF_LEN];
2848 int len, size;
2850 if (cond & G_IO_HUP) {
2851 /* connection closed */
2852 tcp_chr_disconnect(chr);
2853 return TRUE;
2856 if (!s->connected || s->max_size <= 0) {
2857 return TRUE;
2859 len = sizeof(buf);
2860 if (len > s->max_size)
2861 len = s->max_size;
2862 size = tcp_chr_recv(chr, (void *)buf, len);
2863 if (size == 0) {
2864 /* connection closed */
2865 tcp_chr_disconnect(chr);
2866 } else if (size > 0) {
2867 if (s->do_telnetopt)
2868 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
2869 if (size > 0)
2870 qemu_chr_be_write(chr, buf, size);
2873 return TRUE;
2876 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
2878 TCPCharDriver *s = chr->opaque;
2879 int size;
2881 if (!s->connected) {
2882 return 0;
2885 size = tcp_chr_recv(chr, (void *) buf, len);
2886 if (size == 0) {
2887 /* connection closed */
2888 tcp_chr_disconnect(chr);
2891 return size;
2894 #ifndef _WIN32
2895 CharDriverState *qemu_chr_open_eventfd(int eventfd)
2897 CharDriverState *chr = qemu_chr_open_fd(eventfd, eventfd);
2899 if (chr) {
2900 chr->avail_connections = 1;
2903 return chr;
2905 #endif
2907 static void tcp_chr_connect(void *opaque)
2909 CharDriverState *chr = opaque;
2910 TCPCharDriver *s = chr->opaque;
2911 struct sockaddr_storage ss, ps;
2912 socklen_t ss_len = sizeof(ss), ps_len = sizeof(ps);
2914 memset(&ss, 0, ss_len);
2915 if (getsockname(s->fd, (struct sockaddr *) &ss, &ss_len) != 0) {
2916 snprintf(chr->filename, CHR_MAX_FILENAME_SIZE,
2917 "Error in getsockname: %s\n", strerror(errno));
2918 } else if (getpeername(s->fd, (struct sockaddr *) &ps, &ps_len) != 0) {
2919 snprintf(chr->filename, CHR_MAX_FILENAME_SIZE,
2920 "Error in getpeername: %s\n", strerror(errno));
2921 } else {
2922 sockaddr_to_str(chr->filename, CHR_MAX_FILENAME_SIZE,
2923 &ss, ss_len, &ps, ps_len,
2924 s->is_listen, s->is_telnet);
2927 s->connected = 1;
2928 if (s->chan) {
2929 chr->fd_in_tag = io_add_watch_poll(s->chan, tcp_chr_read_poll,
2930 tcp_chr_read, chr);
2932 qemu_chr_be_generic_open(chr);
2935 static void tcp_chr_update_read_handler(CharDriverState *chr)
2937 TCPCharDriver *s = chr->opaque;
2939 remove_fd_in_watch(chr);
2940 if (s->chan) {
2941 chr->fd_in_tag = io_add_watch_poll(s->chan, tcp_chr_read_poll,
2942 tcp_chr_read, chr);
2946 #define IACSET(x,a,b,c) x[0] = a; x[1] = b; x[2] = c;
2947 static void tcp_chr_telnet_init(int fd)
2949 char buf[3];
2950 /* Send the telnet negotion to put telnet in binary, no echo, single char mode */
2951 IACSET(buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
2952 send(fd, (char *)buf, 3, 0);
2953 IACSET(buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
2954 send(fd, (char *)buf, 3, 0);
2955 IACSET(buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
2956 send(fd, (char *)buf, 3, 0);
2957 IACSET(buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
2958 send(fd, (char *)buf, 3, 0);
2961 static int tcp_chr_add_client(CharDriverState *chr, int fd)
2963 TCPCharDriver *s = chr->opaque;
2964 if (s->fd != -1)
2965 return -1;
2967 qemu_set_nonblock(fd);
2968 if (s->do_nodelay)
2969 socket_set_nodelay(fd);
2970 s->fd = fd;
2971 s->chan = io_channel_from_socket(fd);
2972 if (s->listen_tag) {
2973 g_source_remove(s->listen_tag);
2974 s->listen_tag = 0;
2976 tcp_chr_connect(chr);
2978 return 0;
2981 static gboolean tcp_chr_accept(GIOChannel *channel, GIOCondition cond, void *opaque)
2983 CharDriverState *chr = opaque;
2984 TCPCharDriver *s = chr->opaque;
2985 struct sockaddr_in saddr;
2986 #ifndef _WIN32
2987 struct sockaddr_un uaddr;
2988 #endif
2989 struct sockaddr *addr;
2990 socklen_t len;
2991 int fd;
2993 for(;;) {
2994 #ifndef _WIN32
2995 if (s->is_unix) {
2996 len = sizeof(uaddr);
2997 addr = (struct sockaddr *)&uaddr;
2998 } else
2999 #endif
3001 len = sizeof(saddr);
3002 addr = (struct sockaddr *)&saddr;
3004 fd = qemu_accept(s->listen_fd, addr, &len);
3005 if (fd < 0 && errno != EINTR) {
3006 s->listen_tag = 0;
3007 return FALSE;
3008 } else if (fd >= 0) {
3009 if (s->do_telnetopt)
3010 tcp_chr_telnet_init(fd);
3011 break;
3014 if (tcp_chr_add_client(chr, fd) < 0)
3015 close(fd);
3017 return TRUE;
3020 static void tcp_chr_close(CharDriverState *chr)
3022 TCPCharDriver *s = chr->opaque;
3023 int i;
3025 if (s->reconnect_timer) {
3026 g_source_remove(s->reconnect_timer);
3027 s->reconnect_timer = 0;
3029 qapi_free_SocketAddress(s->addr);
3030 if (s->fd >= 0) {
3031 remove_fd_in_watch(chr);
3032 if (s->chan) {
3033 g_io_channel_unref(s->chan);
3035 closesocket(s->fd);
3037 if (s->listen_fd >= 0) {
3038 if (s->listen_tag) {
3039 g_source_remove(s->listen_tag);
3040 s->listen_tag = 0;
3042 if (s->listen_chan) {
3043 g_io_channel_unref(s->listen_chan);
3045 closesocket(s->listen_fd);
3047 if (s->read_msgfds_num) {
3048 for (i = 0; i < s->read_msgfds_num; i++) {
3049 close(s->read_msgfds[i]);
3051 g_free(s->read_msgfds);
3053 if (s->write_msgfds_num) {
3054 g_free(s->write_msgfds);
3056 g_free(s);
3057 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3060 static void qemu_chr_finish_socket_connection(CharDriverState *chr, int fd)
3062 TCPCharDriver *s = chr->opaque;
3064 if (s->is_listen) {
3065 s->listen_fd = fd;
3066 s->listen_chan = io_channel_from_socket(s->listen_fd);
3067 s->listen_tag = g_io_add_watch(s->listen_chan, G_IO_IN,
3068 tcp_chr_accept, chr);
3069 } else {
3070 s->connected = 1;
3071 s->fd = fd;
3072 socket_set_nodelay(fd);
3073 s->chan = io_channel_from_socket(s->fd);
3074 tcp_chr_connect(chr);
3078 static void qemu_chr_socket_connected(int fd, Error *err, void *opaque)
3080 CharDriverState *chr = opaque;
3081 TCPCharDriver *s = chr->opaque;
3083 if (fd < 0) {
3084 check_report_connect_error(chr, err);
3085 return;
3088 s->connect_err_reported = false;
3089 qemu_chr_finish_socket_connection(chr, fd);
3092 static bool qemu_chr_open_socket_fd(CharDriverState *chr, Error **errp)
3094 TCPCharDriver *s = chr->opaque;
3095 int fd;
3097 if (s->is_listen) {
3098 fd = socket_listen(s->addr, errp);
3099 } else if (s->reconnect_time) {
3100 fd = socket_connect(s->addr, errp, qemu_chr_socket_connected, chr);
3101 return fd >= 0;
3102 } else {
3103 fd = socket_connect(s->addr, errp, NULL, NULL);
3105 if (fd < 0) {
3106 return false;
3109 qemu_chr_finish_socket_connection(chr, fd);
3110 return true;
3113 /*********************************************************/
3114 /* Ring buffer chardev */
3116 typedef struct {
3117 size_t size;
3118 size_t prod;
3119 size_t cons;
3120 uint8_t *cbuf;
3121 } RingBufCharDriver;
3123 static size_t ringbuf_count(const CharDriverState *chr)
3125 const RingBufCharDriver *d = chr->opaque;
3127 return d->prod - d->cons;
3130 /* Called with chr_write_lock held. */
3131 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3133 RingBufCharDriver *d = chr->opaque;
3134 int i;
3136 if (!buf || (len < 0)) {
3137 return -1;
3140 for (i = 0; i < len; i++ ) {
3141 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3142 if (d->prod - d->cons > d->size) {
3143 d->cons = d->prod - d->size;
3147 return 0;
3150 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3152 RingBufCharDriver *d = chr->opaque;
3153 int i;
3155 qemu_mutex_lock(&chr->chr_write_lock);
3156 for (i = 0; i < len && d->cons != d->prod; i++) {
3157 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3159 qemu_mutex_unlock(&chr->chr_write_lock);
3161 return i;
3164 static void ringbuf_chr_close(struct CharDriverState *chr)
3166 RingBufCharDriver *d = chr->opaque;
3168 g_free(d->cbuf);
3169 g_free(d);
3170 chr->opaque = NULL;
3173 static CharDriverState *qemu_chr_open_ringbuf(ChardevRingbuf *opts,
3174 Error **errp)
3176 CharDriverState *chr;
3177 RingBufCharDriver *d;
3179 chr = qemu_chr_alloc();
3180 d = g_malloc(sizeof(*d));
3182 d->size = opts->has_size ? opts->size : 65536;
3184 /* The size must be power of 2 */
3185 if (d->size & (d->size - 1)) {
3186 error_setg(errp, "size of ringbuf chardev must be power of two");
3187 goto fail;
3190 d->prod = 0;
3191 d->cons = 0;
3192 d->cbuf = g_malloc0(d->size);
3194 chr->opaque = d;
3195 chr->chr_write = ringbuf_chr_write;
3196 chr->chr_close = ringbuf_chr_close;
3198 return chr;
3200 fail:
3201 g_free(d);
3202 g_free(chr);
3203 return NULL;
3206 bool chr_is_ringbuf(const CharDriverState *chr)
3208 return chr->chr_write == ringbuf_chr_write;
3211 void qmp_ringbuf_write(const char *device, const char *data,
3212 bool has_format, enum DataFormat format,
3213 Error **errp)
3215 CharDriverState *chr;
3216 const uint8_t *write_data;
3217 int ret;
3218 gsize write_count;
3220 chr = qemu_chr_find(device);
3221 if (!chr) {
3222 error_setg(errp, "Device '%s' not found", device);
3223 return;
3226 if (!chr_is_ringbuf(chr)) {
3227 error_setg(errp,"%s is not a ringbuf device", device);
3228 return;
3231 if (has_format && (format == DATA_FORMAT_BASE64)) {
3232 write_data = g_base64_decode(data, &write_count);
3233 } else {
3234 write_data = (uint8_t *)data;
3235 write_count = strlen(data);
3238 ret = ringbuf_chr_write(chr, write_data, write_count);
3240 if (write_data != (uint8_t *)data) {
3241 g_free((void *)write_data);
3244 if (ret < 0) {
3245 error_setg(errp, "Failed to write to device %s", device);
3246 return;
3250 char *qmp_ringbuf_read(const char *device, int64_t size,
3251 bool has_format, enum DataFormat format,
3252 Error **errp)
3254 CharDriverState *chr;
3255 uint8_t *read_data;
3256 size_t count;
3257 char *data;
3259 chr = qemu_chr_find(device);
3260 if (!chr) {
3261 error_setg(errp, "Device '%s' not found", device);
3262 return NULL;
3265 if (!chr_is_ringbuf(chr)) {
3266 error_setg(errp,"%s is not a ringbuf device", device);
3267 return NULL;
3270 if (size <= 0) {
3271 error_setg(errp, "size must be greater than zero");
3272 return NULL;
3275 count = ringbuf_count(chr);
3276 size = size > count ? count : size;
3277 read_data = g_malloc(size + 1);
3279 ringbuf_chr_read(chr, read_data, size);
3281 if (has_format && (format == DATA_FORMAT_BASE64)) {
3282 data = g_base64_encode(read_data, size);
3283 g_free(read_data);
3284 } else {
3286 * FIXME should read only complete, valid UTF-8 characters up
3287 * to @size bytes. Invalid sequences should be replaced by a
3288 * suitable replacement character. Except when (and only
3289 * when) ring buffer lost characters since last read, initial
3290 * continuation characters should be dropped.
3292 read_data[size] = 0;
3293 data = (char *)read_data;
3296 return data;
3299 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3301 char host[65], port[33], width[8], height[8];
3302 int pos;
3303 const char *p;
3304 QemuOpts *opts;
3305 Error *local_err = NULL;
3307 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3308 if (local_err) {
3309 error_report_err(local_err);
3310 return NULL;
3313 if (strstart(filename, "mon:", &p)) {
3314 filename = p;
3315 qemu_opt_set(opts, "mux", "on");
3316 if (strcmp(filename, "stdio") == 0) {
3317 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3318 * but pass it to the guest. Handle this only for compat syntax,
3319 * for -chardev syntax we have special option for this.
3320 * This is what -nographic did, redirecting+muxing serial+monitor
3321 * to stdio causing Ctrl+C to be passed to guest. */
3322 qemu_opt_set(opts, "signal", "off");
3326 if (strcmp(filename, "null") == 0 ||
3327 strcmp(filename, "pty") == 0 ||
3328 strcmp(filename, "msmouse") == 0 ||
3329 strcmp(filename, "braille") == 0 ||
3330 strcmp(filename, "testdev") == 0 ||
3331 strcmp(filename, "stdio") == 0) {
3332 qemu_opt_set(opts, "backend", filename);
3333 return opts;
3335 if (strstart(filename, "vc", &p)) {
3336 qemu_opt_set(opts, "backend", "vc");
3337 if (*p == ':') {
3338 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3339 /* pixels */
3340 qemu_opt_set(opts, "width", width);
3341 qemu_opt_set(opts, "height", height);
3342 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3343 /* chars */
3344 qemu_opt_set(opts, "cols", width);
3345 qemu_opt_set(opts, "rows", height);
3346 } else {
3347 goto fail;
3350 return opts;
3352 if (strcmp(filename, "con:") == 0) {
3353 qemu_opt_set(opts, "backend", "console");
3354 return opts;
3356 if (strstart(filename, "COM", NULL)) {
3357 qemu_opt_set(opts, "backend", "serial");
3358 qemu_opt_set(opts, "path", filename);
3359 return opts;
3361 if (strstart(filename, "file:", &p)) {
3362 qemu_opt_set(opts, "backend", "file");
3363 qemu_opt_set(opts, "path", p);
3364 return opts;
3366 if (strstart(filename, "pipe:", &p)) {
3367 qemu_opt_set(opts, "backend", "pipe");
3368 qemu_opt_set(opts, "path", p);
3369 return opts;
3371 if (strstart(filename, "tcp:", &p) ||
3372 strstart(filename, "telnet:", &p)) {
3373 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3374 host[0] = 0;
3375 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3376 goto fail;
3378 qemu_opt_set(opts, "backend", "socket");
3379 qemu_opt_set(opts, "host", host);
3380 qemu_opt_set(opts, "port", port);
3381 if (p[pos] == ',') {
3382 if (qemu_opts_do_parse(opts, p+pos+1, NULL) != 0)
3383 goto fail;
3385 if (strstart(filename, "telnet:", &p))
3386 qemu_opt_set(opts, "telnet", "on");
3387 return opts;
3389 if (strstart(filename, "udp:", &p)) {
3390 qemu_opt_set(opts, "backend", "udp");
3391 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3392 host[0] = 0;
3393 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3394 goto fail;
3397 qemu_opt_set(opts, "host", host);
3398 qemu_opt_set(opts, "port", port);
3399 if (p[pos] == '@') {
3400 p += pos + 1;
3401 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3402 host[0] = 0;
3403 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3404 goto fail;
3407 qemu_opt_set(opts, "localaddr", host);
3408 qemu_opt_set(opts, "localport", port);
3410 return opts;
3412 if (strstart(filename, "unix:", &p)) {
3413 qemu_opt_set(opts, "backend", "socket");
3414 if (qemu_opts_do_parse(opts, p, "path") != 0)
3415 goto fail;
3416 return opts;
3418 if (strstart(filename, "/dev/parport", NULL) ||
3419 strstart(filename, "/dev/ppi", NULL)) {
3420 qemu_opt_set(opts, "backend", "parport");
3421 qemu_opt_set(opts, "path", filename);
3422 return opts;
3424 if (strstart(filename, "/dev/", NULL)) {
3425 qemu_opt_set(opts, "backend", "tty");
3426 qemu_opt_set(opts, "path", filename);
3427 return opts;
3430 fail:
3431 qemu_opts_del(opts);
3432 return NULL;
3435 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3436 Error **errp)
3438 const char *path = qemu_opt_get(opts, "path");
3440 if (path == NULL) {
3441 error_setg(errp, "chardev: file: no filename given");
3442 return;
3444 backend->file = g_new0(ChardevFile, 1);
3445 backend->file->out = g_strdup(path);
3448 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3449 Error **errp)
3451 backend->stdio = g_new0(ChardevStdio, 1);
3452 backend->stdio->has_signal = true;
3453 backend->stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3456 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3457 Error **errp)
3459 const char *device = qemu_opt_get(opts, "path");
3461 if (device == NULL) {
3462 error_setg(errp, "chardev: serial/tty: no device path given");
3463 return;
3465 backend->serial = g_new0(ChardevHostdev, 1);
3466 backend->serial->device = g_strdup(device);
3469 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3470 Error **errp)
3472 const char *device = qemu_opt_get(opts, "path");
3474 if (device == NULL) {
3475 error_setg(errp, "chardev: parallel: no device path given");
3476 return;
3478 backend->parallel = g_new0(ChardevHostdev, 1);
3479 backend->parallel->device = g_strdup(device);
3482 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3483 Error **errp)
3485 const char *device = qemu_opt_get(opts, "path");
3487 if (device == NULL) {
3488 error_setg(errp, "chardev: pipe: no device path given");
3489 return;
3491 backend->pipe = g_new0(ChardevHostdev, 1);
3492 backend->pipe->device = g_strdup(device);
3495 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3496 Error **errp)
3498 int val;
3500 backend->ringbuf = g_new0(ChardevRingbuf, 1);
3502 val = qemu_opt_get_size(opts, "size", 0);
3503 if (val != 0) {
3504 backend->ringbuf->has_size = true;
3505 backend->ringbuf->size = val;
3509 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3510 Error **errp)
3512 const char *chardev = qemu_opt_get(opts, "chardev");
3514 if (chardev == NULL) {
3515 error_setg(errp, "chardev: mux: no chardev given");
3516 return;
3518 backend->mux = g_new0(ChardevMux, 1);
3519 backend->mux->chardev = g_strdup(chardev);
3522 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3523 Error **errp)
3525 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3526 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3527 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3528 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3529 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3530 const char *path = qemu_opt_get(opts, "path");
3531 const char *host = qemu_opt_get(opts, "host");
3532 const char *port = qemu_opt_get(opts, "port");
3533 SocketAddress *addr;
3535 if (!path) {
3536 if (!host) {
3537 error_setg(errp, "chardev: socket: no host given");
3538 return;
3540 if (!port) {
3541 error_setg(errp, "chardev: socket: no port given");
3542 return;
3546 backend->socket = g_new0(ChardevSocket, 1);
3548 backend->socket->has_nodelay = true;
3549 backend->socket->nodelay = do_nodelay;
3550 backend->socket->has_server = true;
3551 backend->socket->server = is_listen;
3552 backend->socket->has_telnet = true;
3553 backend->socket->telnet = is_telnet;
3554 backend->socket->has_wait = true;
3555 backend->socket->wait = is_waitconnect;
3556 backend->socket->has_reconnect = true;
3557 backend->socket->reconnect = reconnect;
3559 addr = g_new0(SocketAddress, 1);
3560 if (path) {
3561 addr->kind = SOCKET_ADDRESS_KIND_UNIX;
3562 addr->q_unix = g_new0(UnixSocketAddress, 1);
3563 addr->q_unix->path = g_strdup(path);
3564 } else {
3565 addr->kind = SOCKET_ADDRESS_KIND_INET;
3566 addr->inet = g_new0(InetSocketAddress, 1);
3567 addr->inet->host = g_strdup(host);
3568 addr->inet->port = g_strdup(port);
3569 addr->inet->has_to = qemu_opt_get(opts, "to");
3570 addr->inet->to = qemu_opt_get_number(opts, "to", 0);
3571 addr->inet->has_ipv4 = qemu_opt_get(opts, "ipv4");
3572 addr->inet->ipv4 = qemu_opt_get_bool(opts, "ipv4", 0);
3573 addr->inet->has_ipv6 = qemu_opt_get(opts, "ipv6");
3574 addr->inet->ipv6 = qemu_opt_get_bool(opts, "ipv6", 0);
3576 backend->socket->addr = addr;
3579 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3580 Error **errp)
3582 const char *host = qemu_opt_get(opts, "host");
3583 const char *port = qemu_opt_get(opts, "port");
3584 const char *localaddr = qemu_opt_get(opts, "localaddr");
3585 const char *localport = qemu_opt_get(opts, "localport");
3586 bool has_local = false;
3587 SocketAddress *addr;
3589 if (host == NULL || strlen(host) == 0) {
3590 host = "localhost";
3592 if (port == NULL || strlen(port) == 0) {
3593 error_setg(errp, "chardev: udp: remote port not specified");
3594 return;
3596 if (localport == NULL || strlen(localport) == 0) {
3597 localport = "0";
3598 } else {
3599 has_local = true;
3601 if (localaddr == NULL || strlen(localaddr) == 0) {
3602 localaddr = "";
3603 } else {
3604 has_local = true;
3607 backend->udp = g_new0(ChardevUdp, 1);
3609 addr = g_new0(SocketAddress, 1);
3610 addr->kind = SOCKET_ADDRESS_KIND_INET;
3611 addr->inet = g_new0(InetSocketAddress, 1);
3612 addr->inet->host = g_strdup(host);
3613 addr->inet->port = g_strdup(port);
3614 addr->inet->has_ipv4 = qemu_opt_get(opts, "ipv4");
3615 addr->inet->ipv4 = qemu_opt_get_bool(opts, "ipv4", 0);
3616 addr->inet->has_ipv6 = qemu_opt_get(opts, "ipv6");
3617 addr->inet->ipv6 = qemu_opt_get_bool(opts, "ipv6", 0);
3618 backend->udp->remote = addr;
3620 if (has_local) {
3621 backend->udp->has_local = true;
3622 addr = g_new0(SocketAddress, 1);
3623 addr->kind = SOCKET_ADDRESS_KIND_INET;
3624 addr->inet = g_new0(InetSocketAddress, 1);
3625 addr->inet->host = g_strdup(localaddr);
3626 addr->inet->port = g_strdup(localport);
3627 backend->udp->local = addr;
3631 typedef struct CharDriver {
3632 const char *name;
3633 ChardevBackendKind kind;
3634 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3635 } CharDriver;
3637 static GSList *backends;
3639 void register_char_driver(const char *name, ChardevBackendKind kind,
3640 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp))
3642 CharDriver *s;
3644 s = g_malloc0(sizeof(*s));
3645 s->name = g_strdup(name);
3646 s->kind = kind;
3647 s->parse = parse;
3649 backends = g_slist_append(backends, s);
3652 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
3653 void (*init)(struct CharDriverState *s),
3654 Error **errp)
3656 Error *local_err = NULL;
3657 CharDriver *cd;
3658 CharDriverState *chr;
3659 GSList *i;
3660 ChardevReturn *ret = NULL;
3661 ChardevBackend *backend;
3662 const char *id = qemu_opts_id(opts);
3663 char *bid = NULL;
3665 if (id == NULL) {
3666 error_setg(errp, "chardev: no id specified");
3667 goto err;
3670 if (qemu_opt_get(opts, "backend") == NULL) {
3671 error_setg(errp, "chardev: \"%s\" missing backend",
3672 qemu_opts_id(opts));
3673 goto err;
3675 for (i = backends; i; i = i->next) {
3676 cd = i->data;
3678 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
3679 break;
3682 if (i == NULL) {
3683 error_setg(errp, "chardev: backend \"%s\" not found",
3684 qemu_opt_get(opts, "backend"));
3685 goto err;
3688 backend = g_new0(ChardevBackend, 1);
3690 if (qemu_opt_get_bool(opts, "mux", 0)) {
3691 bid = g_strdup_printf("%s-base", id);
3694 chr = NULL;
3695 backend->kind = cd->kind;
3696 if (cd->parse) {
3697 cd->parse(opts, backend, &local_err);
3698 if (local_err) {
3699 error_propagate(errp, local_err);
3700 goto qapi_out;
3703 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
3704 if (!ret) {
3705 goto qapi_out;
3708 if (bid) {
3709 qapi_free_ChardevBackend(backend);
3710 qapi_free_ChardevReturn(ret);
3711 backend = g_new0(ChardevBackend, 1);
3712 backend->mux = g_new0(ChardevMux, 1);
3713 backend->kind = CHARDEV_BACKEND_KIND_MUX;
3714 backend->mux->chardev = g_strdup(bid);
3715 ret = qmp_chardev_add(id, backend, errp);
3716 if (!ret) {
3717 chr = qemu_chr_find(bid);
3718 qemu_chr_delete(chr);
3719 chr = NULL;
3720 goto qapi_out;
3724 chr = qemu_chr_find(id);
3725 chr->opts = opts;
3727 qapi_out:
3728 qapi_free_ChardevBackend(backend);
3729 qapi_free_ChardevReturn(ret);
3730 g_free(bid);
3731 return chr;
3733 err:
3734 qemu_opts_del(opts);
3735 return NULL;
3738 CharDriverState *qemu_chr_new(const char *label, const char *filename, void (*init)(struct CharDriverState *s))
3740 const char *p;
3741 CharDriverState *chr;
3742 QemuOpts *opts;
3743 Error *err = NULL;
3745 if (strstart(filename, "chardev:", &p)) {
3746 return qemu_chr_find(p);
3749 opts = qemu_chr_parse_compat(label, filename);
3750 if (!opts)
3751 return NULL;
3753 chr = qemu_chr_new_from_opts(opts, init, &err);
3754 if (err) {
3755 error_report_err(err);
3757 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
3758 qemu_chr_fe_claim_no_fail(chr);
3759 monitor_init(chr, MONITOR_USE_READLINE);
3761 return chr;
3764 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo)
3766 if (chr->chr_set_echo) {
3767 chr->chr_set_echo(chr, echo);
3771 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open)
3773 if (chr->fe_open == fe_open) {
3774 return;
3776 chr->fe_open = fe_open;
3777 if (chr->chr_set_fe_open) {
3778 chr->chr_set_fe_open(chr, fe_open);
3782 void qemu_chr_fe_event(struct CharDriverState *chr, int event)
3784 if (chr->chr_fe_event) {
3785 chr->chr_fe_event(chr, event);
3789 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
3790 GIOFunc func, void *user_data)
3792 GSource *src;
3793 guint tag;
3795 if (s->chr_add_watch == NULL) {
3796 return -ENOSYS;
3799 src = s->chr_add_watch(s, cond);
3800 if (!src) {
3801 return -EINVAL;
3804 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
3805 tag = g_source_attach(src, NULL);
3806 g_source_unref(src);
3808 return tag;
3811 int qemu_chr_fe_claim(CharDriverState *s)
3813 if (s->avail_connections < 1) {
3814 return -1;
3816 s->avail_connections--;
3817 return 0;
3820 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
3822 if (qemu_chr_fe_claim(s) != 0) {
3823 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
3824 __func__, s->label);
3825 exit(1);
3829 void qemu_chr_fe_release(CharDriverState *s)
3831 s->avail_connections++;
3834 void qemu_chr_delete(CharDriverState *chr)
3836 QTAILQ_REMOVE(&chardevs, chr, next);
3837 if (chr->chr_close) {
3838 chr->chr_close(chr);
3840 g_free(chr->filename);
3841 g_free(chr->label);
3842 qemu_opts_del(chr->opts);
3843 g_free(chr);
3846 ChardevInfoList *qmp_query_chardev(Error **errp)
3848 ChardevInfoList *chr_list = NULL;
3849 CharDriverState *chr;
3851 QTAILQ_FOREACH(chr, &chardevs, next) {
3852 ChardevInfoList *info = g_malloc0(sizeof(*info));
3853 info->value = g_malloc0(sizeof(*info->value));
3854 info->value->label = g_strdup(chr->label);
3855 info->value->filename = g_strdup(chr->filename);
3856 info->value->frontend_open = chr->fe_open;
3858 info->next = chr_list;
3859 chr_list = info;
3862 return chr_list;
3865 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
3867 ChardevBackendInfoList *backend_list = NULL;
3868 CharDriver *c = NULL;
3869 GSList *i = NULL;
3871 for (i = backends; i; i = i->next) {
3872 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
3873 c = i->data;
3874 info->value = g_malloc0(sizeof(*info->value));
3875 info->value->name = g_strdup(c->name);
3877 info->next = backend_list;
3878 backend_list = info;
3881 return backend_list;
3884 CharDriverState *qemu_chr_find(const char *name)
3886 CharDriverState *chr;
3888 QTAILQ_FOREACH(chr, &chardevs, next) {
3889 if (strcmp(chr->label, name) != 0)
3890 continue;
3891 return chr;
3893 return NULL;
3896 /* Get a character (serial) device interface. */
3897 CharDriverState *qemu_char_get_next_serial(void)
3899 static int next_serial;
3900 CharDriverState *chr;
3902 /* FIXME: This function needs to go away: use chardev properties! */
3904 while (next_serial < MAX_SERIAL_PORTS && serial_hds[next_serial]) {
3905 chr = serial_hds[next_serial++];
3906 qemu_chr_fe_claim_no_fail(chr);
3907 return chr;
3909 return NULL;
3912 QemuOptsList qemu_chardev_opts = {
3913 .name = "chardev",
3914 .implied_opt_name = "backend",
3915 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
3916 .desc = {
3918 .name = "backend",
3919 .type = QEMU_OPT_STRING,
3921 .name = "path",
3922 .type = QEMU_OPT_STRING,
3924 .name = "host",
3925 .type = QEMU_OPT_STRING,
3927 .name = "port",
3928 .type = QEMU_OPT_STRING,
3930 .name = "localaddr",
3931 .type = QEMU_OPT_STRING,
3933 .name = "localport",
3934 .type = QEMU_OPT_STRING,
3936 .name = "to",
3937 .type = QEMU_OPT_NUMBER,
3939 .name = "ipv4",
3940 .type = QEMU_OPT_BOOL,
3942 .name = "ipv6",
3943 .type = QEMU_OPT_BOOL,
3945 .name = "wait",
3946 .type = QEMU_OPT_BOOL,
3948 .name = "server",
3949 .type = QEMU_OPT_BOOL,
3951 .name = "delay",
3952 .type = QEMU_OPT_BOOL,
3954 .name = "reconnect",
3955 .type = QEMU_OPT_NUMBER,
3957 .name = "telnet",
3958 .type = QEMU_OPT_BOOL,
3960 .name = "width",
3961 .type = QEMU_OPT_NUMBER,
3963 .name = "height",
3964 .type = QEMU_OPT_NUMBER,
3966 .name = "cols",
3967 .type = QEMU_OPT_NUMBER,
3969 .name = "rows",
3970 .type = QEMU_OPT_NUMBER,
3972 .name = "mux",
3973 .type = QEMU_OPT_BOOL,
3975 .name = "signal",
3976 .type = QEMU_OPT_BOOL,
3978 .name = "name",
3979 .type = QEMU_OPT_STRING,
3981 .name = "debug",
3982 .type = QEMU_OPT_NUMBER,
3984 .name = "size",
3985 .type = QEMU_OPT_SIZE,
3987 .name = "chardev",
3988 .type = QEMU_OPT_STRING,
3990 { /* end of list */ }
3994 #ifdef _WIN32
3996 static CharDriverState *qmp_chardev_open_file(ChardevFile *file, Error **errp)
3998 HANDLE out;
4000 if (file->has_in) {
4001 error_setg(errp, "input file not supported");
4002 return NULL;
4005 out = CreateFile(file->out, GENERIC_WRITE, FILE_SHARE_READ, NULL,
4006 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
4007 if (out == INVALID_HANDLE_VALUE) {
4008 error_setg(errp, "open %s failed", file->out);
4009 return NULL;
4011 return qemu_chr_open_win_file(out);
4014 static CharDriverState *qmp_chardev_open_serial(ChardevHostdev *serial,
4015 Error **errp)
4017 return qemu_chr_open_win_path(serial->device);
4020 static CharDriverState *qmp_chardev_open_parallel(ChardevHostdev *parallel,
4021 Error **errp)
4023 error_setg(errp, "character device backend type 'parallel' not supported");
4024 return NULL;
4027 #else /* WIN32 */
4029 static int qmp_chardev_open_file_source(char *src, int flags,
4030 Error **errp)
4032 int fd = -1;
4034 TFR(fd = qemu_open(src, flags, 0666));
4035 if (fd == -1) {
4036 error_setg_file_open(errp, errno, src);
4038 return fd;
4041 static CharDriverState *qmp_chardev_open_file(ChardevFile *file, Error **errp)
4043 int flags, in = -1, out;
4045 flags = O_WRONLY | O_TRUNC | O_CREAT | O_BINARY;
4046 out = qmp_chardev_open_file_source(file->out, flags, errp);
4047 if (out < 0) {
4048 return NULL;
4051 if (file->has_in) {
4052 flags = O_RDONLY;
4053 in = qmp_chardev_open_file_source(file->in, flags, errp);
4054 if (in < 0) {
4055 qemu_close(out);
4056 return NULL;
4060 return qemu_chr_open_fd(in, out);
4063 static CharDriverState *qmp_chardev_open_serial(ChardevHostdev *serial,
4064 Error **errp)
4066 #ifdef HAVE_CHARDEV_TTY
4067 int fd;
4069 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4070 if (fd < 0) {
4071 return NULL;
4073 qemu_set_nonblock(fd);
4074 return qemu_chr_open_tty_fd(fd);
4075 #else
4076 error_setg(errp, "character device backend type 'serial' not supported");
4077 return NULL;
4078 #endif
4081 static CharDriverState *qmp_chardev_open_parallel(ChardevHostdev *parallel,
4082 Error **errp)
4084 #ifdef HAVE_CHARDEV_PARPORT
4085 int fd;
4087 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4088 if (fd < 0) {
4089 return NULL;
4091 return qemu_chr_open_pp_fd(fd);
4092 #else
4093 error_setg(errp, "character device backend type 'parallel' not supported");
4094 return NULL;
4095 #endif
4098 #endif /* WIN32 */
4100 static void socket_try_connect(CharDriverState *chr)
4102 Error *err = NULL;
4104 if (!qemu_chr_open_socket_fd(chr, &err)) {
4105 check_report_connect_error(chr, err);
4109 static gboolean socket_reconnect_timeout(gpointer opaque)
4111 CharDriverState *chr = opaque;
4112 TCPCharDriver *s = chr->opaque;
4114 s->reconnect_timer = 0;
4116 if (chr->be_open) {
4117 return false;
4120 socket_try_connect(chr);
4122 return false;
4125 static CharDriverState *qmp_chardev_open_socket(ChardevSocket *sock,
4126 Error **errp)
4128 CharDriverState *chr;
4129 TCPCharDriver *s;
4130 SocketAddress *addr = sock->addr;
4131 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4132 bool is_listen = sock->has_server ? sock->server : true;
4133 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4134 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4135 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4137 chr = qemu_chr_alloc();
4138 s = g_malloc0(sizeof(TCPCharDriver));
4140 s->fd = -1;
4141 s->listen_fd = -1;
4142 s->is_unix = addr->kind == SOCKET_ADDRESS_KIND_UNIX;
4143 s->is_listen = is_listen;
4144 s->is_telnet = is_telnet;
4145 s->do_nodelay = do_nodelay;
4146 qapi_copy_SocketAddress(&s->addr, sock->addr);
4148 chr->opaque = s;
4149 chr->chr_write = tcp_chr_write;
4150 chr->chr_sync_read = tcp_chr_sync_read;
4151 chr->chr_close = tcp_chr_close;
4152 chr->get_msgfds = tcp_get_msgfds;
4153 chr->set_msgfds = tcp_set_msgfds;
4154 chr->chr_add_client = tcp_chr_add_client;
4155 chr->chr_add_watch = tcp_chr_add_watch;
4156 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4157 /* be isn't opened until we get a connection */
4158 chr->explicit_be_open = true;
4160 chr->filename = g_malloc(CHR_MAX_FILENAME_SIZE);
4161 SocketAddress_to_str(chr->filename, CHR_MAX_FILENAME_SIZE, "disconnected:",
4162 addr, is_listen, is_telnet);
4164 if (is_listen) {
4165 if (is_telnet) {
4166 s->do_telnetopt = 1;
4168 } else if (reconnect > 0) {
4169 s->reconnect_time = reconnect;
4172 if (s->reconnect_time) {
4173 socket_try_connect(chr);
4174 } else if (!qemu_chr_open_socket_fd(chr, errp)) {
4175 g_free(s);
4176 g_free(chr->filename);
4177 g_free(chr);
4178 return NULL;
4181 if (is_listen && is_waitconnect) {
4182 fprintf(stderr, "QEMU waiting for connection on: %s\n",
4183 chr->filename);
4184 tcp_chr_accept(s->listen_chan, G_IO_IN, chr);
4185 qemu_set_nonblock(s->listen_fd);
4188 return chr;
4191 static CharDriverState *qmp_chardev_open_udp(ChardevUdp *udp,
4192 Error **errp)
4194 int fd;
4196 fd = socket_dgram(udp->remote, udp->local, errp);
4197 if (fd < 0) {
4198 return NULL;
4200 return qemu_chr_open_udp_fd(fd);
4203 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4204 Error **errp)
4206 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4207 CharDriverState *base, *chr = NULL;
4209 chr = qemu_chr_find(id);
4210 if (chr) {
4211 error_setg(errp, "Chardev '%s' already exists", id);
4212 g_free(ret);
4213 return NULL;
4216 switch (backend->kind) {
4217 case CHARDEV_BACKEND_KIND_FILE:
4218 chr = qmp_chardev_open_file(backend->file, errp);
4219 break;
4220 case CHARDEV_BACKEND_KIND_SERIAL:
4221 chr = qmp_chardev_open_serial(backend->serial, errp);
4222 break;
4223 case CHARDEV_BACKEND_KIND_PARALLEL:
4224 chr = qmp_chardev_open_parallel(backend->parallel, errp);
4225 break;
4226 case CHARDEV_BACKEND_KIND_PIPE:
4227 chr = qemu_chr_open_pipe(backend->pipe);
4228 break;
4229 case CHARDEV_BACKEND_KIND_SOCKET:
4230 chr = qmp_chardev_open_socket(backend->socket, errp);
4231 break;
4232 case CHARDEV_BACKEND_KIND_UDP:
4233 chr = qmp_chardev_open_udp(backend->udp, errp);
4234 break;
4235 #ifdef HAVE_CHARDEV_TTY
4236 case CHARDEV_BACKEND_KIND_PTY:
4237 chr = qemu_chr_open_pty(id, ret);
4238 break;
4239 #endif
4240 case CHARDEV_BACKEND_KIND_NULL:
4241 chr = qemu_chr_open_null();
4242 break;
4243 case CHARDEV_BACKEND_KIND_MUX:
4244 base = qemu_chr_find(backend->mux->chardev);
4245 if (base == NULL) {
4246 error_setg(errp, "mux: base chardev %s not found",
4247 backend->mux->chardev);
4248 break;
4250 chr = qemu_chr_open_mux(base);
4251 break;
4252 case CHARDEV_BACKEND_KIND_MSMOUSE:
4253 chr = qemu_chr_open_msmouse();
4254 break;
4255 #ifdef CONFIG_BRLAPI
4256 case CHARDEV_BACKEND_KIND_BRAILLE:
4257 chr = chr_baum_init();
4258 break;
4259 #endif
4260 case CHARDEV_BACKEND_KIND_TESTDEV:
4261 chr = chr_testdev_init();
4262 break;
4263 case CHARDEV_BACKEND_KIND_STDIO:
4264 chr = qemu_chr_open_stdio(backend->stdio);
4265 break;
4266 #ifdef _WIN32
4267 case CHARDEV_BACKEND_KIND_CONSOLE:
4268 chr = qemu_chr_open_win_con();
4269 break;
4270 #endif
4271 #ifdef CONFIG_SPICE
4272 case CHARDEV_BACKEND_KIND_SPICEVMC:
4273 chr = qemu_chr_open_spice_vmc(backend->spicevmc->type);
4274 break;
4275 case CHARDEV_BACKEND_KIND_SPICEPORT:
4276 chr = qemu_chr_open_spice_port(backend->spiceport->fqdn);
4277 break;
4278 #endif
4279 case CHARDEV_BACKEND_KIND_VC:
4280 chr = vc_init(backend->vc);
4281 break;
4282 case CHARDEV_BACKEND_KIND_RINGBUF:
4283 case CHARDEV_BACKEND_KIND_MEMORY:
4284 chr = qemu_chr_open_ringbuf(backend->ringbuf, errp);
4285 break;
4286 default:
4287 error_setg(errp, "unknown chardev backend (%d)", backend->kind);
4288 break;
4292 * Character backend open hasn't been fully converted to the Error
4293 * API. Some opens fail without setting an error. Set a generic
4294 * error then.
4295 * TODO full conversion to Error API
4297 if (chr == NULL && errp && !*errp) {
4298 error_setg(errp, "Failed to create chardev");
4300 if (chr) {
4301 chr->label = g_strdup(id);
4302 chr->avail_connections =
4303 (backend->kind == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4304 if (!chr->filename) {
4305 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->kind]);
4307 if (!chr->explicit_be_open) {
4308 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4310 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4311 return ret;
4312 } else {
4313 g_free(ret);
4314 return NULL;
4318 void qmp_chardev_remove(const char *id, Error **errp)
4320 CharDriverState *chr;
4322 chr = qemu_chr_find(id);
4323 if (chr == NULL) {
4324 error_setg(errp, "Chardev '%s' not found", id);
4325 return;
4327 if (chr->chr_can_read || chr->chr_read ||
4328 chr->chr_event || chr->handler_opaque) {
4329 error_setg(errp, "Chardev '%s' is busy", id);
4330 return;
4332 qemu_chr_delete(chr);
4335 static void register_types(void)
4337 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL);
4338 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4339 qemu_chr_parse_socket);
4340 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp);
4341 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4342 qemu_chr_parse_ringbuf);
4343 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4344 qemu_chr_parse_file_out);
4345 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4346 qemu_chr_parse_stdio);
4347 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4348 qemu_chr_parse_serial);
4349 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4350 qemu_chr_parse_serial);
4351 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4352 qemu_chr_parse_parallel);
4353 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4354 qemu_chr_parse_parallel);
4355 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL);
4356 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL);
4357 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4358 qemu_chr_parse_pipe);
4359 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux);
4360 /* Bug-compatibility: */
4361 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4362 qemu_chr_parse_ringbuf);
4363 /* this must be done after machine init, since we register FEs with muxes
4364 * as part of realize functions like serial_isa_realizefn when -nographic
4365 * is specified
4367 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4370 type_init(register_types);