qemu-char: convert null backend to data-driven creation
[qemu/cris-port.git] / qemu-char.c
blob5bacee8ff6689f1e843185a78b7107401e21d4eb
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/error-report.h"
28 #include "qemu/timer.h"
29 #include "sysemu/char.h"
30 #include "hw/usb.h"
31 #include "qmp-commands.h"
32 #include "qapi/qmp-input-visitor.h"
33 #include "qapi/qmp-output-visitor.h"
34 #include "qapi-visit.h"
36 #include <unistd.h>
37 #include <fcntl.h>
38 #include <time.h>
39 #include <errno.h>
40 #include <sys/time.h>
41 #include <zlib.h>
43 #ifndef _WIN32
44 #include <sys/times.h>
45 #include <sys/wait.h>
46 #include <termios.h>
47 #include <sys/mman.h>
48 #include <sys/ioctl.h>
49 #include <sys/resource.h>
50 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <net/if.h>
53 #include <arpa/inet.h>
54 #include <netdb.h>
55 #include <sys/select.h>
56 #ifdef CONFIG_BSD
57 #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(const char *id,
387 ChardevBackend *backend,
388 ChardevReturn *ret,
389 Error **errp)
391 CharDriverState *chr;
393 chr = qemu_chr_alloc();
394 chr->chr_write = null_chr_write;
395 chr->explicit_be_open = true;
396 return chr;
399 /* MUX driver for serial I/O splitting */
400 #define MAX_MUX 4
401 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
402 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
403 typedef struct {
404 IOCanReadHandler *chr_can_read[MAX_MUX];
405 IOReadHandler *chr_read[MAX_MUX];
406 IOEventHandler *chr_event[MAX_MUX];
407 void *ext_opaque[MAX_MUX];
408 CharDriverState *drv;
409 int focus;
410 int mux_cnt;
411 int term_got_escape;
412 int max_size;
413 /* Intermediate input buffer allows to catch escape sequences even if the
414 currently active device is not accepting any input - but only until it
415 is full as well. */
416 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
417 int prod[MAX_MUX];
418 int cons[MAX_MUX];
419 int timestamps;
421 /* Protected by the CharDriverState chr_write_lock. */
422 int linestart;
423 int64_t timestamps_start;
424 } MuxDriver;
427 /* Called with chr_write_lock held. */
428 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
430 MuxDriver *d = chr->opaque;
431 int ret;
432 if (!d->timestamps) {
433 ret = qemu_chr_fe_write(d->drv, buf, len);
434 } else {
435 int i;
437 ret = 0;
438 for (i = 0; i < len; i++) {
439 if (d->linestart) {
440 char buf1[64];
441 int64_t ti;
442 int secs;
444 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
445 if (d->timestamps_start == -1)
446 d->timestamps_start = ti;
447 ti -= d->timestamps_start;
448 secs = ti / 1000;
449 snprintf(buf1, sizeof(buf1),
450 "[%02d:%02d:%02d.%03d] ",
451 secs / 3600,
452 (secs / 60) % 60,
453 secs % 60,
454 (int)(ti % 1000));
455 qemu_chr_fe_write(d->drv, (uint8_t *)buf1, strlen(buf1));
456 d->linestart = 0;
458 ret += qemu_chr_fe_write(d->drv, buf+i, 1);
459 if (buf[i] == '\n') {
460 d->linestart = 1;
464 return ret;
467 static const char * const mux_help[] = {
468 "% h print this help\n\r",
469 "% x exit emulator\n\r",
470 "% s save disk data back to file (if -snapshot)\n\r",
471 "% t toggle console timestamps\n\r",
472 "% b send break (magic sysrq)\n\r",
473 "% c switch between console and monitor\n\r",
474 "% % sends %\n\r",
475 NULL
478 int term_escape_char = 0x01; /* ctrl-a is used for escape */
479 static void mux_print_help(CharDriverState *chr)
481 int i, j;
482 char ebuf[15] = "Escape-Char";
483 char cbuf[50] = "\n\r";
485 if (term_escape_char > 0 && term_escape_char < 26) {
486 snprintf(cbuf, sizeof(cbuf), "\n\r");
487 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
488 } else {
489 snprintf(cbuf, sizeof(cbuf),
490 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
491 term_escape_char);
493 qemu_chr_fe_write(chr, (uint8_t *)cbuf, strlen(cbuf));
494 for (i = 0; mux_help[i] != NULL; i++) {
495 for (j=0; mux_help[i][j] != '\0'; j++) {
496 if (mux_help[i][j] == '%')
497 qemu_chr_fe_write(chr, (uint8_t *)ebuf, strlen(ebuf));
498 else
499 qemu_chr_fe_write(chr, (uint8_t *)&mux_help[i][j], 1);
504 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
506 if (d->chr_event[mux_nr])
507 d->chr_event[mux_nr](d->ext_opaque[mux_nr], event);
510 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
512 if (d->term_got_escape) {
513 d->term_got_escape = 0;
514 if (ch == term_escape_char)
515 goto send_char;
516 switch(ch) {
517 case '?':
518 case 'h':
519 mux_print_help(chr);
520 break;
521 case 'x':
523 const char *term = "QEMU: Terminated\n\r";
524 qemu_chr_fe_write(chr, (uint8_t *)term, strlen(term));
525 exit(0);
526 break;
528 case 's':
529 bdrv_commit_all();
530 break;
531 case 'b':
532 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
533 break;
534 case 'c':
535 /* Switch to the next registered device */
536 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
537 d->focus++;
538 if (d->focus >= d->mux_cnt)
539 d->focus = 0;
540 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
541 break;
542 case 't':
543 d->timestamps = !d->timestamps;
544 d->timestamps_start = -1;
545 d->linestart = 0;
546 break;
548 } else if (ch == term_escape_char) {
549 d->term_got_escape = 1;
550 } else {
551 send_char:
552 return 1;
554 return 0;
557 static void mux_chr_accept_input(CharDriverState *chr)
559 MuxDriver *d = chr->opaque;
560 int m = d->focus;
562 while (d->prod[m] != d->cons[m] &&
563 d->chr_can_read[m] &&
564 d->chr_can_read[m](d->ext_opaque[m])) {
565 d->chr_read[m](d->ext_opaque[m],
566 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
570 static int mux_chr_can_read(void *opaque)
572 CharDriverState *chr = opaque;
573 MuxDriver *d = chr->opaque;
574 int m = d->focus;
576 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE)
577 return 1;
578 if (d->chr_can_read[m])
579 return d->chr_can_read[m](d->ext_opaque[m]);
580 return 0;
583 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
585 CharDriverState *chr = opaque;
586 MuxDriver *d = chr->opaque;
587 int m = d->focus;
588 int i;
590 mux_chr_accept_input (opaque);
592 for(i = 0; i < size; i++)
593 if (mux_proc_byte(chr, d, buf[i])) {
594 if (d->prod[m] == d->cons[m] &&
595 d->chr_can_read[m] &&
596 d->chr_can_read[m](d->ext_opaque[m]))
597 d->chr_read[m](d->ext_opaque[m], &buf[i], 1);
598 else
599 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
603 static void mux_chr_event(void *opaque, int event)
605 CharDriverState *chr = opaque;
606 MuxDriver *d = chr->opaque;
607 int i;
609 /* Send the event to all registered listeners */
610 for (i = 0; i < d->mux_cnt; i++)
611 mux_chr_send_event(d, i, event);
614 static void mux_chr_update_read_handler(CharDriverState *chr)
616 MuxDriver *d = chr->opaque;
618 if (d->mux_cnt >= MAX_MUX) {
619 fprintf(stderr, "Cannot add I/O handlers, MUX array is full\n");
620 return;
622 d->ext_opaque[d->mux_cnt] = chr->handler_opaque;
623 d->chr_can_read[d->mux_cnt] = chr->chr_can_read;
624 d->chr_read[d->mux_cnt] = chr->chr_read;
625 d->chr_event[d->mux_cnt] = chr->chr_event;
626 /* Fix up the real driver with mux routines */
627 if (d->mux_cnt == 0) {
628 qemu_chr_add_handlers(d->drv, mux_chr_can_read, mux_chr_read,
629 mux_chr_event, chr);
631 if (d->focus != -1) {
632 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
634 d->focus = d->mux_cnt;
635 d->mux_cnt++;
636 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
639 static bool muxes_realized;
642 * Called after processing of default and command-line-specified
643 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
644 * to a mux chardev. This is done here to ensure that
645 * output/prompts/banners are only displayed for the FE that has
646 * focus when initial command-line processing/machine init is
647 * completed.
649 * After this point, any new FE attached to any new or existing
650 * mux will receive CHR_EVENT_OPENED notifications for the BE
651 * immediately.
653 static void muxes_realize_done(Notifier *notifier, void *unused)
655 CharDriverState *chr;
657 QTAILQ_FOREACH(chr, &chardevs, next) {
658 if (chr->is_mux) {
659 MuxDriver *d = chr->opaque;
660 int i;
662 /* send OPENED to all already-attached FEs */
663 for (i = 0; i < d->mux_cnt; i++) {
664 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
666 /* mark mux as OPENED so any new FEs will immediately receive
667 * OPENED event
669 qemu_chr_be_generic_open(chr);
672 muxes_realized = true;
675 static Notifier muxes_realize_notify = {
676 .notify = muxes_realize_done,
679 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
681 MuxDriver *d = s->opaque;
682 return d->drv->chr_add_watch(d->drv, cond);
685 static CharDriverState *qemu_chr_open_mux(CharDriverState *drv)
687 CharDriverState *chr;
688 MuxDriver *d;
690 chr = qemu_chr_alloc();
691 d = g_new0(MuxDriver, 1);
693 chr->opaque = d;
694 d->drv = drv;
695 d->focus = -1;
696 chr->chr_write = mux_chr_write;
697 chr->chr_update_read_handler = mux_chr_update_read_handler;
698 chr->chr_accept_input = mux_chr_accept_input;
699 /* Frontend guest-open / -close notification is not support with muxes */
700 chr->chr_set_fe_open = NULL;
701 if (drv->chr_add_watch) {
702 chr->chr_add_watch = mux_chr_add_watch;
704 /* only default to opened state if we've realized the initial
705 * set of muxes
707 chr->explicit_be_open = muxes_realized ? 0 : 1;
708 chr->is_mux = 1;
710 return chr;
714 #ifdef _WIN32
715 int send_all(int fd, const void *buf, int len1)
717 int ret, len;
719 len = len1;
720 while (len > 0) {
721 ret = send(fd, buf, len, 0);
722 if (ret < 0) {
723 errno = WSAGetLastError();
724 if (errno != WSAEWOULDBLOCK) {
725 return -1;
727 } else if (ret == 0) {
728 break;
729 } else {
730 buf += ret;
731 len -= ret;
734 return len1 - len;
737 #else
739 int send_all(int fd, const void *_buf, int len1)
741 int ret, len;
742 const uint8_t *buf = _buf;
744 len = len1;
745 while (len > 0) {
746 ret = write(fd, buf, len);
747 if (ret < 0) {
748 if (errno != EINTR && errno != EAGAIN)
749 return -1;
750 } else if (ret == 0) {
751 break;
752 } else {
753 buf += ret;
754 len -= ret;
757 return len1 - len;
760 int recv_all(int fd, void *_buf, int len1, bool single_read)
762 int ret, len;
763 uint8_t *buf = _buf;
765 len = len1;
766 while ((len > 0) && (ret = read(fd, buf, len)) != 0) {
767 if (ret < 0) {
768 if (errno != EINTR && errno != EAGAIN) {
769 return -1;
771 continue;
772 } else {
773 if (single_read) {
774 return ret;
776 buf += ret;
777 len -= ret;
780 return len1 - len;
783 #endif /* !_WIN32 */
785 typedef struct IOWatchPoll
787 GSource parent;
789 GIOChannel *channel;
790 GSource *src;
792 IOCanReadHandler *fd_can_read;
793 GSourceFunc fd_read;
794 void *opaque;
795 } IOWatchPoll;
797 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
799 return container_of(source, IOWatchPoll, parent);
802 static gboolean io_watch_poll_prepare(GSource *source, gint *timeout_)
804 IOWatchPoll *iwp = io_watch_poll_from_source(source);
805 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
806 bool was_active = iwp->src != NULL;
807 if (was_active == now_active) {
808 return FALSE;
811 if (now_active) {
812 iwp->src = g_io_create_watch(iwp->channel,
813 G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
814 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
815 g_source_attach(iwp->src, NULL);
816 } else {
817 g_source_destroy(iwp->src);
818 g_source_unref(iwp->src);
819 iwp->src = NULL;
821 return FALSE;
824 static gboolean io_watch_poll_check(GSource *source)
826 return FALSE;
829 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
830 gpointer user_data)
832 abort();
835 static void io_watch_poll_finalize(GSource *source)
837 /* Due to a glib bug, removing the last reference to a source
838 * inside a finalize callback causes recursive locking (and a
839 * deadlock). This is not a problem inside other callbacks,
840 * including dispatch callbacks, so we call io_remove_watch_poll
841 * to remove this source. At this point, iwp->src must
842 * be NULL, or we would leak it.
844 * This would be solved much more elegantly by child sources,
845 * but we support older glib versions that do not have them.
847 IOWatchPoll *iwp = io_watch_poll_from_source(source);
848 assert(iwp->src == NULL);
851 static GSourceFuncs io_watch_poll_funcs = {
852 .prepare = io_watch_poll_prepare,
853 .check = io_watch_poll_check,
854 .dispatch = io_watch_poll_dispatch,
855 .finalize = io_watch_poll_finalize,
858 /* Can only be used for read */
859 static guint io_add_watch_poll(GIOChannel *channel,
860 IOCanReadHandler *fd_can_read,
861 GIOFunc fd_read,
862 gpointer user_data)
864 IOWatchPoll *iwp;
865 int tag;
867 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs, sizeof(IOWatchPoll));
868 iwp->fd_can_read = fd_can_read;
869 iwp->opaque = user_data;
870 iwp->channel = channel;
871 iwp->fd_read = (GSourceFunc) fd_read;
872 iwp->src = NULL;
874 tag = g_source_attach(&iwp->parent, NULL);
875 g_source_unref(&iwp->parent);
876 return tag;
879 static void io_remove_watch_poll(guint tag)
881 GSource *source;
882 IOWatchPoll *iwp;
884 g_return_if_fail (tag > 0);
886 source = g_main_context_find_source_by_id(NULL, tag);
887 g_return_if_fail (source != NULL);
889 iwp = io_watch_poll_from_source(source);
890 if (iwp->src) {
891 g_source_destroy(iwp->src);
892 g_source_unref(iwp->src);
893 iwp->src = NULL;
895 g_source_destroy(&iwp->parent);
898 static void remove_fd_in_watch(CharDriverState *chr)
900 if (chr->fd_in_tag) {
901 io_remove_watch_poll(chr->fd_in_tag);
902 chr->fd_in_tag = 0;
906 #ifndef _WIN32
907 static GIOChannel *io_channel_from_fd(int fd)
909 GIOChannel *chan;
911 if (fd == -1) {
912 return NULL;
915 chan = g_io_channel_unix_new(fd);
917 g_io_channel_set_encoding(chan, NULL, NULL);
918 g_io_channel_set_buffered(chan, FALSE);
920 return chan;
922 #endif
924 static GIOChannel *io_channel_from_socket(int fd)
926 GIOChannel *chan;
928 if (fd == -1) {
929 return NULL;
932 #ifdef _WIN32
933 chan = g_io_channel_win32_new_socket(fd);
934 #else
935 chan = g_io_channel_unix_new(fd);
936 #endif
938 g_io_channel_set_encoding(chan, NULL, NULL);
939 g_io_channel_set_buffered(chan, FALSE);
941 return chan;
944 static int io_channel_send(GIOChannel *fd, const void *buf, size_t len)
946 size_t offset = 0;
947 GIOStatus status = G_IO_STATUS_NORMAL;
949 while (offset < len && status == G_IO_STATUS_NORMAL) {
950 gsize bytes_written = 0;
952 status = g_io_channel_write_chars(fd, buf + offset, len - offset,
953 &bytes_written, NULL);
954 offset += bytes_written;
957 if (offset > 0) {
958 return offset;
960 switch (status) {
961 case G_IO_STATUS_NORMAL:
962 g_assert(len == 0);
963 return 0;
964 case G_IO_STATUS_AGAIN:
965 errno = EAGAIN;
966 return -1;
967 default:
968 break;
970 errno = EINVAL;
971 return -1;
974 #ifndef _WIN32
976 typedef struct FDCharDriver {
977 CharDriverState *chr;
978 GIOChannel *fd_in, *fd_out;
979 int max_size;
980 } FDCharDriver;
982 /* Called with chr_write_lock held. */
983 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
985 FDCharDriver *s = chr->opaque;
987 return io_channel_send(s->fd_out, buf, len);
990 static gboolean fd_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
992 CharDriverState *chr = opaque;
993 FDCharDriver *s = chr->opaque;
994 int len;
995 uint8_t buf[READ_BUF_LEN];
996 GIOStatus status;
997 gsize bytes_read;
999 len = sizeof(buf);
1000 if (len > s->max_size) {
1001 len = s->max_size;
1003 if (len == 0) {
1004 return TRUE;
1007 status = g_io_channel_read_chars(chan, (gchar *)buf,
1008 len, &bytes_read, NULL);
1009 if (status == G_IO_STATUS_EOF) {
1010 remove_fd_in_watch(chr);
1011 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1012 return FALSE;
1014 if (status == G_IO_STATUS_NORMAL) {
1015 qemu_chr_be_write(chr, buf, bytes_read);
1018 return TRUE;
1021 static int fd_chr_read_poll(void *opaque)
1023 CharDriverState *chr = opaque;
1024 FDCharDriver *s = chr->opaque;
1026 s->max_size = qemu_chr_be_can_write(chr);
1027 return s->max_size;
1030 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1032 FDCharDriver *s = chr->opaque;
1033 return g_io_create_watch(s->fd_out, cond);
1036 static void fd_chr_update_read_handler(CharDriverState *chr)
1038 FDCharDriver *s = chr->opaque;
1040 remove_fd_in_watch(chr);
1041 if (s->fd_in) {
1042 chr->fd_in_tag = io_add_watch_poll(s->fd_in, fd_chr_read_poll,
1043 fd_chr_read, chr);
1047 static void fd_chr_close(struct CharDriverState *chr)
1049 FDCharDriver *s = chr->opaque;
1051 remove_fd_in_watch(chr);
1052 if (s->fd_in) {
1053 g_io_channel_unref(s->fd_in);
1055 if (s->fd_out) {
1056 g_io_channel_unref(s->fd_out);
1059 g_free(s);
1060 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1063 /* open a character device to a unix fd */
1064 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out)
1066 CharDriverState *chr;
1067 FDCharDriver *s;
1069 chr = qemu_chr_alloc();
1070 s = g_new0(FDCharDriver, 1);
1071 s->fd_in = io_channel_from_fd(fd_in);
1072 s->fd_out = io_channel_from_fd(fd_out);
1073 qemu_set_nonblock(fd_out);
1074 s->chr = chr;
1075 chr->opaque = s;
1076 chr->chr_add_watch = fd_chr_add_watch;
1077 chr->chr_write = fd_chr_write;
1078 chr->chr_update_read_handler = fd_chr_update_read_handler;
1079 chr->chr_close = fd_chr_close;
1081 return chr;
1084 static CharDriverState *qemu_chr_open_pipe(const char *id,
1085 ChardevBackend *backend,
1086 ChardevReturn *ret,
1087 Error **errp)
1089 ChardevHostdev *opts = backend->pipe;
1090 int fd_in, fd_out;
1091 char filename_in[CHR_MAX_FILENAME_SIZE];
1092 char filename_out[CHR_MAX_FILENAME_SIZE];
1093 const char *filename = opts->device;
1095 snprintf(filename_in, CHR_MAX_FILENAME_SIZE, "%s.in", filename);
1096 snprintf(filename_out, CHR_MAX_FILENAME_SIZE, "%s.out", filename);
1097 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1098 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1099 if (fd_in < 0 || fd_out < 0) {
1100 if (fd_in >= 0)
1101 close(fd_in);
1102 if (fd_out >= 0)
1103 close(fd_out);
1104 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1105 if (fd_in < 0) {
1106 error_setg_file_open(errp, errno, filename);
1107 return NULL;
1110 return qemu_chr_open_fd(fd_in, fd_out);
1113 /* init terminal so that we can grab keys */
1114 static struct termios oldtty;
1115 static int old_fd0_flags;
1116 static bool stdio_in_use;
1117 static bool stdio_allow_signal;
1118 static bool stdio_echo_state;
1120 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1122 static void term_exit(void)
1124 tcsetattr (0, TCSANOW, &oldtty);
1125 fcntl(0, F_SETFL, old_fd0_flags);
1128 static void term_stdio_handler(int sig)
1130 /* restore echo after resume from suspend. */
1131 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1134 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1136 struct termios tty;
1138 stdio_echo_state = echo;
1139 tty = oldtty;
1140 if (!echo) {
1141 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1142 |INLCR|IGNCR|ICRNL|IXON);
1143 tty.c_oflag |= OPOST;
1144 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1145 tty.c_cflag &= ~(CSIZE|PARENB);
1146 tty.c_cflag |= CS8;
1147 tty.c_cc[VMIN] = 1;
1148 tty.c_cc[VTIME] = 0;
1150 if (!stdio_allow_signal)
1151 tty.c_lflag &= ~ISIG;
1153 tcsetattr (0, TCSANOW, &tty);
1156 static void qemu_chr_close_stdio(struct CharDriverState *chr)
1158 term_exit();
1159 fd_chr_close(chr);
1162 static CharDriverState *qemu_chr_open_stdio(ChardevStdio *opts)
1164 CharDriverState *chr;
1165 struct sigaction act;
1167 if (is_daemonized()) {
1168 error_report("cannot use stdio with -daemonize");
1169 return NULL;
1172 if (stdio_in_use) {
1173 error_report("cannot use stdio by multiple character devices");
1174 exit(1);
1177 stdio_in_use = true;
1178 old_fd0_flags = fcntl(0, F_GETFL);
1179 tcgetattr(0, &oldtty);
1180 qemu_set_nonblock(0);
1181 atexit(term_exit);
1183 memset(&act, 0, sizeof(act));
1184 act.sa_handler = term_stdio_handler;
1185 sigaction(SIGCONT, &act, NULL);
1187 chr = qemu_chr_open_fd(0, 1);
1188 chr->chr_close = qemu_chr_close_stdio;
1189 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1190 if (opts->has_signal) {
1191 stdio_allow_signal = opts->signal;
1193 qemu_chr_fe_set_echo(chr, false);
1195 return chr;
1198 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1199 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1200 || defined(__GLIBC__)
1202 #define HAVE_CHARDEV_SERIAL 1
1203 #define HAVE_CHARDEV_PTY 1
1205 typedef struct {
1206 GIOChannel *fd;
1207 int read_bytes;
1209 /* Protected by the CharDriverState chr_write_lock. */
1210 int connected;
1211 guint timer_tag;
1212 guint open_tag;
1213 } PtyCharDriver;
1215 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1216 static void pty_chr_state(CharDriverState *chr, int connected);
1218 static gboolean pty_chr_timer(gpointer opaque)
1220 struct CharDriverState *chr = opaque;
1221 PtyCharDriver *s = chr->opaque;
1223 qemu_mutex_lock(&chr->chr_write_lock);
1224 s->timer_tag = 0;
1225 s->open_tag = 0;
1226 if (!s->connected) {
1227 /* Next poll ... */
1228 pty_chr_update_read_handler_locked(chr);
1230 qemu_mutex_unlock(&chr->chr_write_lock);
1231 return FALSE;
1234 /* Called with chr_write_lock held. */
1235 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1237 PtyCharDriver *s = chr->opaque;
1239 if (s->timer_tag) {
1240 g_source_remove(s->timer_tag);
1241 s->timer_tag = 0;
1244 if (ms == 1000) {
1245 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1246 } else {
1247 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1251 /* Called with chr_write_lock held. */
1252 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1254 PtyCharDriver *s = chr->opaque;
1255 GPollFD pfd;
1257 pfd.fd = g_io_channel_unix_get_fd(s->fd);
1258 pfd.events = G_IO_OUT;
1259 pfd.revents = 0;
1260 g_poll(&pfd, 1, 0);
1261 if (pfd.revents & G_IO_HUP) {
1262 pty_chr_state(chr, 0);
1263 } else {
1264 pty_chr_state(chr, 1);
1268 static void pty_chr_update_read_handler(CharDriverState *chr)
1270 qemu_mutex_lock(&chr->chr_write_lock);
1271 pty_chr_update_read_handler_locked(chr);
1272 qemu_mutex_unlock(&chr->chr_write_lock);
1275 /* Called with chr_write_lock held. */
1276 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1278 PtyCharDriver *s = chr->opaque;
1280 if (!s->connected) {
1281 /* guest sends data, check for (re-)connect */
1282 pty_chr_update_read_handler_locked(chr);
1283 if (!s->connected) {
1284 return 0;
1287 return io_channel_send(s->fd, buf, len);
1290 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1292 PtyCharDriver *s = chr->opaque;
1293 if (!s->connected) {
1294 return NULL;
1296 return g_io_create_watch(s->fd, cond);
1299 static int pty_chr_read_poll(void *opaque)
1301 CharDriverState *chr = opaque;
1302 PtyCharDriver *s = chr->opaque;
1304 s->read_bytes = qemu_chr_be_can_write(chr);
1305 return s->read_bytes;
1308 static gboolean pty_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
1310 CharDriverState *chr = opaque;
1311 PtyCharDriver *s = chr->opaque;
1312 gsize size, len;
1313 uint8_t buf[READ_BUF_LEN];
1314 GIOStatus status;
1316 len = sizeof(buf);
1317 if (len > s->read_bytes)
1318 len = s->read_bytes;
1319 if (len == 0) {
1320 return TRUE;
1322 status = g_io_channel_read_chars(s->fd, (gchar *)buf, len, &size, NULL);
1323 if (status != G_IO_STATUS_NORMAL) {
1324 pty_chr_state(chr, 0);
1325 return FALSE;
1326 } else {
1327 pty_chr_state(chr, 1);
1328 qemu_chr_be_write(chr, buf, size);
1330 return TRUE;
1333 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1335 CharDriverState *chr = opaque;
1336 PtyCharDriver *s = chr->opaque;
1338 s->open_tag = 0;
1339 qemu_chr_be_generic_open(chr);
1340 return FALSE;
1343 /* Called with chr_write_lock held. */
1344 static void pty_chr_state(CharDriverState *chr, int connected)
1346 PtyCharDriver *s = chr->opaque;
1348 if (!connected) {
1349 if (s->open_tag) {
1350 g_source_remove(s->open_tag);
1351 s->open_tag = 0;
1353 remove_fd_in_watch(chr);
1354 s->connected = 0;
1355 /* (re-)connect poll interval for idle guests: once per second.
1356 * We check more frequently in case the guests sends data to
1357 * the virtual device linked to our pty. */
1358 pty_chr_rearm_timer(chr, 1000);
1359 } else {
1360 if (s->timer_tag) {
1361 g_source_remove(s->timer_tag);
1362 s->timer_tag = 0;
1364 if (!s->connected) {
1365 g_assert(s->open_tag == 0);
1366 s->connected = 1;
1367 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1369 if (!chr->fd_in_tag) {
1370 chr->fd_in_tag = io_add_watch_poll(s->fd, pty_chr_read_poll,
1371 pty_chr_read, chr);
1376 static void pty_chr_close(struct CharDriverState *chr)
1378 PtyCharDriver *s = chr->opaque;
1379 int fd;
1381 qemu_mutex_lock(&chr->chr_write_lock);
1382 pty_chr_state(chr, 0);
1383 fd = g_io_channel_unix_get_fd(s->fd);
1384 g_io_channel_unref(s->fd);
1385 close(fd);
1386 if (s->timer_tag) {
1387 g_source_remove(s->timer_tag);
1388 s->timer_tag = 0;
1390 qemu_mutex_unlock(&chr->chr_write_lock);
1391 g_free(s);
1392 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1395 static CharDriverState *qemu_chr_open_pty(const char *id,
1396 ChardevBackend *backend,
1397 ChardevReturn *ret,
1398 Error **errp)
1400 CharDriverState *chr;
1401 PtyCharDriver *s;
1402 int master_fd, slave_fd;
1403 char pty_name[PATH_MAX];
1405 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1406 if (master_fd < 0) {
1407 error_setg_errno(errp, errno, "Failed to create PTY");
1408 return NULL;
1411 close(slave_fd);
1412 qemu_set_nonblock(master_fd);
1414 chr = qemu_chr_alloc();
1416 chr->filename = g_strdup_printf("pty:%s", pty_name);
1417 ret->pty = g_strdup(pty_name);
1418 ret->has_pty = true;
1420 fprintf(stderr, "char device redirected to %s (label %s)\n",
1421 pty_name, id);
1423 s = g_new0(PtyCharDriver, 1);
1424 chr->opaque = s;
1425 chr->chr_write = pty_chr_write;
1426 chr->chr_update_read_handler = pty_chr_update_read_handler;
1427 chr->chr_close = pty_chr_close;
1428 chr->chr_add_watch = pty_chr_add_watch;
1429 chr->explicit_be_open = true;
1431 s->fd = io_channel_from_fd(master_fd);
1432 s->timer_tag = 0;
1434 return chr;
1437 static void tty_serial_init(int fd, int speed,
1438 int parity, int data_bits, int stop_bits)
1440 struct termios tty;
1441 speed_t spd;
1443 #if 0
1444 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1445 speed, parity, data_bits, stop_bits);
1446 #endif
1447 tcgetattr (fd, &tty);
1449 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1450 speed = speed * 10 / 11;
1451 do {
1452 check_speed(50);
1453 check_speed(75);
1454 check_speed(110);
1455 check_speed(134);
1456 check_speed(150);
1457 check_speed(200);
1458 check_speed(300);
1459 check_speed(600);
1460 check_speed(1200);
1461 check_speed(1800);
1462 check_speed(2400);
1463 check_speed(4800);
1464 check_speed(9600);
1465 check_speed(19200);
1466 check_speed(38400);
1467 /* Non-Posix values follow. They may be unsupported on some systems. */
1468 check_speed(57600);
1469 check_speed(115200);
1470 #ifdef B230400
1471 check_speed(230400);
1472 #endif
1473 #ifdef B460800
1474 check_speed(460800);
1475 #endif
1476 #ifdef B500000
1477 check_speed(500000);
1478 #endif
1479 #ifdef B576000
1480 check_speed(576000);
1481 #endif
1482 #ifdef B921600
1483 check_speed(921600);
1484 #endif
1485 #ifdef B1000000
1486 check_speed(1000000);
1487 #endif
1488 #ifdef B1152000
1489 check_speed(1152000);
1490 #endif
1491 #ifdef B1500000
1492 check_speed(1500000);
1493 #endif
1494 #ifdef B2000000
1495 check_speed(2000000);
1496 #endif
1497 #ifdef B2500000
1498 check_speed(2500000);
1499 #endif
1500 #ifdef B3000000
1501 check_speed(3000000);
1502 #endif
1503 #ifdef B3500000
1504 check_speed(3500000);
1505 #endif
1506 #ifdef B4000000
1507 check_speed(4000000);
1508 #endif
1509 spd = B115200;
1510 } while (0);
1512 cfsetispeed(&tty, spd);
1513 cfsetospeed(&tty, spd);
1515 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1516 |INLCR|IGNCR|ICRNL|IXON);
1517 tty.c_oflag |= OPOST;
1518 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1519 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1520 switch(data_bits) {
1521 default:
1522 case 8:
1523 tty.c_cflag |= CS8;
1524 break;
1525 case 7:
1526 tty.c_cflag |= CS7;
1527 break;
1528 case 6:
1529 tty.c_cflag |= CS6;
1530 break;
1531 case 5:
1532 tty.c_cflag |= CS5;
1533 break;
1535 switch(parity) {
1536 default:
1537 case 'N':
1538 break;
1539 case 'E':
1540 tty.c_cflag |= PARENB;
1541 break;
1542 case 'O':
1543 tty.c_cflag |= PARENB | PARODD;
1544 break;
1546 if (stop_bits == 2)
1547 tty.c_cflag |= CSTOPB;
1549 tcsetattr (fd, TCSANOW, &tty);
1552 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1554 FDCharDriver *s = chr->opaque;
1556 switch(cmd) {
1557 case CHR_IOCTL_SERIAL_SET_PARAMS:
1559 QEMUSerialSetParams *ssp = arg;
1560 tty_serial_init(g_io_channel_unix_get_fd(s->fd_in),
1561 ssp->speed, ssp->parity,
1562 ssp->data_bits, ssp->stop_bits);
1564 break;
1565 case CHR_IOCTL_SERIAL_SET_BREAK:
1567 int enable = *(int *)arg;
1568 if (enable) {
1569 tcsendbreak(g_io_channel_unix_get_fd(s->fd_in), 1);
1572 break;
1573 case CHR_IOCTL_SERIAL_GET_TIOCM:
1575 int sarg = 0;
1576 int *targ = (int *)arg;
1577 ioctl(g_io_channel_unix_get_fd(s->fd_in), TIOCMGET, &sarg);
1578 *targ = 0;
1579 if (sarg & TIOCM_CTS)
1580 *targ |= CHR_TIOCM_CTS;
1581 if (sarg & TIOCM_CAR)
1582 *targ |= CHR_TIOCM_CAR;
1583 if (sarg & TIOCM_DSR)
1584 *targ |= CHR_TIOCM_DSR;
1585 if (sarg & TIOCM_RI)
1586 *targ |= CHR_TIOCM_RI;
1587 if (sarg & TIOCM_DTR)
1588 *targ |= CHR_TIOCM_DTR;
1589 if (sarg & TIOCM_RTS)
1590 *targ |= CHR_TIOCM_RTS;
1592 break;
1593 case CHR_IOCTL_SERIAL_SET_TIOCM:
1595 int sarg = *(int *)arg;
1596 int targ = 0;
1597 ioctl(g_io_channel_unix_get_fd(s->fd_in), TIOCMGET, &targ);
1598 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1599 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1600 if (sarg & CHR_TIOCM_CTS)
1601 targ |= TIOCM_CTS;
1602 if (sarg & CHR_TIOCM_CAR)
1603 targ |= TIOCM_CAR;
1604 if (sarg & CHR_TIOCM_DSR)
1605 targ |= TIOCM_DSR;
1606 if (sarg & CHR_TIOCM_RI)
1607 targ |= TIOCM_RI;
1608 if (sarg & CHR_TIOCM_DTR)
1609 targ |= TIOCM_DTR;
1610 if (sarg & CHR_TIOCM_RTS)
1611 targ |= TIOCM_RTS;
1612 ioctl(g_io_channel_unix_get_fd(s->fd_in), TIOCMSET, &targ);
1614 break;
1615 default:
1616 return -ENOTSUP;
1618 return 0;
1621 static void qemu_chr_close_tty(CharDriverState *chr)
1623 FDCharDriver *s = chr->opaque;
1624 int fd = -1;
1626 if (s) {
1627 fd = g_io_channel_unix_get_fd(s->fd_in);
1630 fd_chr_close(chr);
1632 if (fd >= 0) {
1633 close(fd);
1637 static CharDriverState *qemu_chr_open_tty_fd(int fd)
1639 CharDriverState *chr;
1641 tty_serial_init(fd, 115200, 'N', 8, 1);
1642 chr = qemu_chr_open_fd(fd, fd);
1643 chr->chr_ioctl = tty_serial_ioctl;
1644 chr->chr_close = qemu_chr_close_tty;
1645 return chr;
1647 #endif /* __linux__ || __sun__ */
1649 #if defined(__linux__)
1651 #define HAVE_CHARDEV_PARPORT 1
1653 typedef struct {
1654 int fd;
1655 int mode;
1656 } ParallelCharDriver;
1658 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1660 if (s->mode != mode) {
1661 int m = mode;
1662 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1663 return 0;
1664 s->mode = mode;
1666 return 1;
1669 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1671 ParallelCharDriver *drv = chr->opaque;
1672 int fd = drv->fd;
1673 uint8_t b;
1675 switch(cmd) {
1676 case CHR_IOCTL_PP_READ_DATA:
1677 if (ioctl(fd, PPRDATA, &b) < 0)
1678 return -ENOTSUP;
1679 *(uint8_t *)arg = b;
1680 break;
1681 case CHR_IOCTL_PP_WRITE_DATA:
1682 b = *(uint8_t *)arg;
1683 if (ioctl(fd, PPWDATA, &b) < 0)
1684 return -ENOTSUP;
1685 break;
1686 case CHR_IOCTL_PP_READ_CONTROL:
1687 if (ioctl(fd, PPRCONTROL, &b) < 0)
1688 return -ENOTSUP;
1689 /* Linux gives only the lowest bits, and no way to know data
1690 direction! For better compatibility set the fixed upper
1691 bits. */
1692 *(uint8_t *)arg = b | 0xc0;
1693 break;
1694 case CHR_IOCTL_PP_WRITE_CONTROL:
1695 b = *(uint8_t *)arg;
1696 if (ioctl(fd, PPWCONTROL, &b) < 0)
1697 return -ENOTSUP;
1698 break;
1699 case CHR_IOCTL_PP_READ_STATUS:
1700 if (ioctl(fd, PPRSTATUS, &b) < 0)
1701 return -ENOTSUP;
1702 *(uint8_t *)arg = b;
1703 break;
1704 case CHR_IOCTL_PP_DATA_DIR:
1705 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1706 return -ENOTSUP;
1707 break;
1708 case CHR_IOCTL_PP_EPP_READ_ADDR:
1709 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1710 struct ParallelIOArg *parg = arg;
1711 int n = read(fd, parg->buffer, parg->count);
1712 if (n != parg->count) {
1713 return -EIO;
1716 break;
1717 case CHR_IOCTL_PP_EPP_READ:
1718 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1719 struct ParallelIOArg *parg = arg;
1720 int n = read(fd, parg->buffer, parg->count);
1721 if (n != parg->count) {
1722 return -EIO;
1725 break;
1726 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1727 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1728 struct ParallelIOArg *parg = arg;
1729 int n = write(fd, parg->buffer, parg->count);
1730 if (n != parg->count) {
1731 return -EIO;
1734 break;
1735 case CHR_IOCTL_PP_EPP_WRITE:
1736 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1737 struct ParallelIOArg *parg = arg;
1738 int n = write(fd, parg->buffer, parg->count);
1739 if (n != parg->count) {
1740 return -EIO;
1743 break;
1744 default:
1745 return -ENOTSUP;
1747 return 0;
1750 static void pp_close(CharDriverState *chr)
1752 ParallelCharDriver *drv = chr->opaque;
1753 int fd = drv->fd;
1755 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1756 ioctl(fd, PPRELEASE);
1757 close(fd);
1758 g_free(drv);
1759 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1762 static CharDriverState *qemu_chr_open_pp_fd(int fd, Error **errp)
1764 CharDriverState *chr;
1765 ParallelCharDriver *drv;
1767 if (ioctl(fd, PPCLAIM) < 0) {
1768 error_setg_errno(errp, errno, "not a parallel port");
1769 close(fd);
1770 return NULL;
1773 drv = g_new0(ParallelCharDriver, 1);
1774 drv->fd = fd;
1775 drv->mode = IEEE1284_MODE_COMPAT;
1777 chr = qemu_chr_alloc();
1778 chr->chr_write = null_chr_write;
1779 chr->chr_ioctl = pp_ioctl;
1780 chr->chr_close = pp_close;
1781 chr->opaque = drv;
1783 return chr;
1785 #endif /* __linux__ */
1787 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
1789 #define HAVE_CHARDEV_PARPORT 1
1791 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1793 int fd = (int)(intptr_t)chr->opaque;
1794 uint8_t b;
1796 switch(cmd) {
1797 case CHR_IOCTL_PP_READ_DATA:
1798 if (ioctl(fd, PPIGDATA, &b) < 0)
1799 return -ENOTSUP;
1800 *(uint8_t *)arg = b;
1801 break;
1802 case CHR_IOCTL_PP_WRITE_DATA:
1803 b = *(uint8_t *)arg;
1804 if (ioctl(fd, PPISDATA, &b) < 0)
1805 return -ENOTSUP;
1806 break;
1807 case CHR_IOCTL_PP_READ_CONTROL:
1808 if (ioctl(fd, PPIGCTRL, &b) < 0)
1809 return -ENOTSUP;
1810 *(uint8_t *)arg = b;
1811 break;
1812 case CHR_IOCTL_PP_WRITE_CONTROL:
1813 b = *(uint8_t *)arg;
1814 if (ioctl(fd, PPISCTRL, &b) < 0)
1815 return -ENOTSUP;
1816 break;
1817 case CHR_IOCTL_PP_READ_STATUS:
1818 if (ioctl(fd, PPIGSTATUS, &b) < 0)
1819 return -ENOTSUP;
1820 *(uint8_t *)arg = b;
1821 break;
1822 default:
1823 return -ENOTSUP;
1825 return 0;
1828 static CharDriverState *qemu_chr_open_pp_fd(int fd, Error **errp)
1830 CharDriverState *chr;
1832 chr = qemu_chr_alloc();
1833 chr->opaque = (void *)(intptr_t)fd;
1834 chr->chr_write = null_chr_write;
1835 chr->chr_ioctl = pp_ioctl;
1836 chr->explicit_be_open = true;
1837 return chr;
1839 #endif
1841 #else /* _WIN32 */
1843 #define HAVE_CHARDEV_SERIAL 1
1845 typedef struct {
1846 int max_size;
1847 HANDLE hcom, hrecv, hsend;
1848 OVERLAPPED orecv;
1849 BOOL fpipe;
1850 DWORD len;
1852 /* Protected by the CharDriverState chr_write_lock. */
1853 OVERLAPPED osend;
1854 } WinCharState;
1856 typedef struct {
1857 HANDLE hStdIn;
1858 HANDLE hInputReadyEvent;
1859 HANDLE hInputDoneEvent;
1860 HANDLE hInputThread;
1861 uint8_t win_stdio_buf;
1862 } WinStdioCharState;
1864 #define NSENDBUF 2048
1865 #define NRECVBUF 2048
1866 #define MAXCONNECT 1
1867 #define NTIMEOUT 5000
1869 static int win_chr_poll(void *opaque);
1870 static int win_chr_pipe_poll(void *opaque);
1872 static void win_chr_close(CharDriverState *chr)
1874 WinCharState *s = chr->opaque;
1876 if (s->hsend) {
1877 CloseHandle(s->hsend);
1878 s->hsend = NULL;
1880 if (s->hrecv) {
1881 CloseHandle(s->hrecv);
1882 s->hrecv = NULL;
1884 if (s->hcom) {
1885 CloseHandle(s->hcom);
1886 s->hcom = NULL;
1888 if (s->fpipe)
1889 qemu_del_polling_cb(win_chr_pipe_poll, chr);
1890 else
1891 qemu_del_polling_cb(win_chr_poll, chr);
1893 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1896 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
1898 WinCharState *s = chr->opaque;
1899 COMMCONFIG comcfg;
1900 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
1901 COMSTAT comstat;
1902 DWORD size;
1903 DWORD err;
1905 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
1906 if (!s->hsend) {
1907 error_setg(errp, "Failed CreateEvent");
1908 goto fail;
1910 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
1911 if (!s->hrecv) {
1912 error_setg(errp, "Failed CreateEvent");
1913 goto fail;
1916 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
1917 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
1918 if (s->hcom == INVALID_HANDLE_VALUE) {
1919 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
1920 s->hcom = NULL;
1921 goto fail;
1924 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
1925 error_setg(errp, "Failed SetupComm");
1926 goto fail;
1929 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
1930 size = sizeof(COMMCONFIG);
1931 GetDefaultCommConfig(filename, &comcfg, &size);
1932 comcfg.dcb.DCBlength = sizeof(DCB);
1933 CommConfigDialog(filename, NULL, &comcfg);
1935 if (!SetCommState(s->hcom, &comcfg.dcb)) {
1936 error_setg(errp, "Failed SetCommState");
1937 goto fail;
1940 if (!SetCommMask(s->hcom, EV_ERR)) {
1941 error_setg(errp, "Failed SetCommMask");
1942 goto fail;
1945 cto.ReadIntervalTimeout = MAXDWORD;
1946 if (!SetCommTimeouts(s->hcom, &cto)) {
1947 error_setg(errp, "Failed SetCommTimeouts");
1948 goto fail;
1951 if (!ClearCommError(s->hcom, &err, &comstat)) {
1952 error_setg(errp, "Failed ClearCommError");
1953 goto fail;
1955 qemu_add_polling_cb(win_chr_poll, chr);
1956 return 0;
1958 fail:
1959 win_chr_close(chr);
1960 return -1;
1963 /* Called with chr_write_lock held. */
1964 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
1966 WinCharState *s = chr->opaque;
1967 DWORD len, ret, size, err;
1969 len = len1;
1970 ZeroMemory(&s->osend, sizeof(s->osend));
1971 s->osend.hEvent = s->hsend;
1972 while (len > 0) {
1973 if (s->hsend)
1974 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
1975 else
1976 ret = WriteFile(s->hcom, buf, len, &size, NULL);
1977 if (!ret) {
1978 err = GetLastError();
1979 if (err == ERROR_IO_PENDING) {
1980 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
1981 if (ret) {
1982 buf += size;
1983 len -= size;
1984 } else {
1985 break;
1987 } else {
1988 break;
1990 } else {
1991 buf += size;
1992 len -= size;
1995 return len1 - len;
1998 static int win_chr_read_poll(CharDriverState *chr)
2000 WinCharState *s = chr->opaque;
2002 s->max_size = qemu_chr_be_can_write(chr);
2003 return s->max_size;
2006 static void win_chr_readfile(CharDriverState *chr)
2008 WinCharState *s = chr->opaque;
2009 int ret, err;
2010 uint8_t buf[READ_BUF_LEN];
2011 DWORD size;
2013 ZeroMemory(&s->orecv, sizeof(s->orecv));
2014 s->orecv.hEvent = s->hrecv;
2015 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2016 if (!ret) {
2017 err = GetLastError();
2018 if (err == ERROR_IO_PENDING) {
2019 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2023 if (size > 0) {
2024 qemu_chr_be_write(chr, buf, size);
2028 static void win_chr_read(CharDriverState *chr)
2030 WinCharState *s = chr->opaque;
2032 if (s->len > s->max_size)
2033 s->len = s->max_size;
2034 if (s->len == 0)
2035 return;
2037 win_chr_readfile(chr);
2040 static int win_chr_poll(void *opaque)
2042 CharDriverState *chr = opaque;
2043 WinCharState *s = chr->opaque;
2044 COMSTAT status;
2045 DWORD comerr;
2047 ClearCommError(s->hcom, &comerr, &status);
2048 if (status.cbInQue > 0) {
2049 s->len = status.cbInQue;
2050 win_chr_read_poll(chr);
2051 win_chr_read(chr);
2052 return 1;
2054 return 0;
2057 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2058 Error **errp)
2060 CharDriverState *chr;
2061 WinCharState *s;
2063 chr = qemu_chr_alloc();
2064 s = g_new0(WinCharState, 1);
2065 chr->opaque = s;
2066 chr->chr_write = win_chr_write;
2067 chr->chr_close = win_chr_close;
2069 if (win_chr_init(chr, filename, errp) < 0) {
2070 g_free(s);
2071 g_free(chr);
2072 return NULL;
2074 return chr;
2077 static int win_chr_pipe_poll(void *opaque)
2079 CharDriverState *chr = opaque;
2080 WinCharState *s = chr->opaque;
2081 DWORD size;
2083 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2084 if (size > 0) {
2085 s->len = size;
2086 win_chr_read_poll(chr);
2087 win_chr_read(chr);
2088 return 1;
2090 return 0;
2093 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2094 Error **errp)
2096 WinCharState *s = chr->opaque;
2097 OVERLAPPED ov;
2098 int ret;
2099 DWORD size;
2100 char openname[CHR_MAX_FILENAME_SIZE];
2102 s->fpipe = TRUE;
2104 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2105 if (!s->hsend) {
2106 error_setg(errp, "Failed CreateEvent");
2107 goto fail;
2109 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2110 if (!s->hrecv) {
2111 error_setg(errp, "Failed CreateEvent");
2112 goto fail;
2115 snprintf(openname, sizeof(openname), "\\\\.\\pipe\\%s", filename);
2116 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2117 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2118 PIPE_WAIT,
2119 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2120 if (s->hcom == INVALID_HANDLE_VALUE) {
2121 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2122 s->hcom = NULL;
2123 goto fail;
2126 ZeroMemory(&ov, sizeof(ov));
2127 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2128 ret = ConnectNamedPipe(s->hcom, &ov);
2129 if (ret) {
2130 error_setg(errp, "Failed ConnectNamedPipe");
2131 goto fail;
2134 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2135 if (!ret) {
2136 error_setg(errp, "Failed GetOverlappedResult");
2137 if (ov.hEvent) {
2138 CloseHandle(ov.hEvent);
2139 ov.hEvent = NULL;
2141 goto fail;
2144 if (ov.hEvent) {
2145 CloseHandle(ov.hEvent);
2146 ov.hEvent = NULL;
2148 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2149 return 0;
2151 fail:
2152 win_chr_close(chr);
2153 return -1;
2157 static CharDriverState *qemu_chr_open_pipe(const char *id,
2158 ChardevBackend *backend,
2159 ChardevReturn *ret,
2160 Error **errp)
2162 ChardevHostdev *opts = backend->pipe;
2163 const char *filename = opts->device;
2164 CharDriverState *chr;
2165 WinCharState *s;
2167 chr = qemu_chr_alloc();
2168 s = g_new0(WinCharState, 1);
2169 chr->opaque = s;
2170 chr->chr_write = win_chr_write;
2171 chr->chr_close = win_chr_close;
2173 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2174 g_free(s);
2175 g_free(chr);
2176 return NULL;
2178 return chr;
2181 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out)
2183 CharDriverState *chr;
2184 WinCharState *s;
2186 chr = qemu_chr_alloc();
2187 s = g_new0(WinCharState, 1);
2188 s->hcom = fd_out;
2189 chr->opaque = s;
2190 chr->chr_write = win_chr_write;
2191 return chr;
2194 static CharDriverState *qemu_chr_open_win_con(void)
2196 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE));
2199 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2201 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2202 DWORD dwSize;
2203 int len1;
2205 len1 = len;
2207 while (len1 > 0) {
2208 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2209 break;
2211 buf += dwSize;
2212 len1 -= dwSize;
2215 return len - len1;
2218 static void win_stdio_wait_func(void *opaque)
2220 CharDriverState *chr = opaque;
2221 WinStdioCharState *stdio = chr->opaque;
2222 INPUT_RECORD buf[4];
2223 int ret;
2224 DWORD dwSize;
2225 int i;
2227 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2229 if (!ret) {
2230 /* Avoid error storm */
2231 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2232 return;
2235 for (i = 0; i < dwSize; i++) {
2236 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2238 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2239 int j;
2240 if (kev->uChar.AsciiChar != 0) {
2241 for (j = 0; j < kev->wRepeatCount; j++) {
2242 if (qemu_chr_be_can_write(chr)) {
2243 uint8_t c = kev->uChar.AsciiChar;
2244 qemu_chr_be_write(chr, &c, 1);
2252 static DWORD WINAPI win_stdio_thread(LPVOID param)
2254 CharDriverState *chr = param;
2255 WinStdioCharState *stdio = chr->opaque;
2256 int ret;
2257 DWORD dwSize;
2259 while (1) {
2261 /* Wait for one byte */
2262 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2264 /* Exit in case of error, continue if nothing read */
2265 if (!ret) {
2266 break;
2268 if (!dwSize) {
2269 continue;
2272 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2273 if (stdio->win_stdio_buf == '\r') {
2274 continue;
2277 /* Signal the main thread and wait until the byte was eaten */
2278 if (!SetEvent(stdio->hInputReadyEvent)) {
2279 break;
2281 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2282 != WAIT_OBJECT_0) {
2283 break;
2287 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2288 return 0;
2291 static void win_stdio_thread_wait_func(void *opaque)
2293 CharDriverState *chr = opaque;
2294 WinStdioCharState *stdio = chr->opaque;
2296 if (qemu_chr_be_can_write(chr)) {
2297 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2300 SetEvent(stdio->hInputDoneEvent);
2303 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2305 WinStdioCharState *stdio = chr->opaque;
2306 DWORD dwMode = 0;
2308 GetConsoleMode(stdio->hStdIn, &dwMode);
2310 if (echo) {
2311 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2312 } else {
2313 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2317 static void win_stdio_close(CharDriverState *chr)
2319 WinStdioCharState *stdio = chr->opaque;
2321 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2322 CloseHandle(stdio->hInputReadyEvent);
2324 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2325 CloseHandle(stdio->hInputDoneEvent);
2327 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2328 TerminateThread(stdio->hInputThread, 0);
2331 g_free(chr->opaque);
2332 g_free(chr);
2335 static CharDriverState *qemu_chr_open_stdio(ChardevStdio *opts)
2337 CharDriverState *chr;
2338 WinStdioCharState *stdio;
2339 DWORD dwMode;
2340 int is_console = 0;
2342 chr = qemu_chr_alloc();
2343 stdio = g_new0(WinStdioCharState, 1);
2345 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2346 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2347 fprintf(stderr, "cannot open stdio: invalid handle\n");
2348 exit(1);
2351 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2353 chr->opaque = stdio;
2354 chr->chr_write = win_stdio_write;
2355 chr->chr_close = win_stdio_close;
2357 if (is_console) {
2358 if (qemu_add_wait_object(stdio->hStdIn,
2359 win_stdio_wait_func, chr)) {
2360 fprintf(stderr, "qemu_add_wait_object: failed\n");
2362 } else {
2363 DWORD dwId;
2365 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2366 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2367 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2368 chr, 0, &dwId);
2370 if (stdio->hInputThread == INVALID_HANDLE_VALUE
2371 || stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2372 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2373 fprintf(stderr, "cannot create stdio thread or event\n");
2374 exit(1);
2376 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2377 win_stdio_thread_wait_func, chr)) {
2378 fprintf(stderr, "qemu_add_wait_object: failed\n");
2382 dwMode |= ENABLE_LINE_INPUT;
2384 if (is_console) {
2385 /* set the terminal in raw mode */
2386 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2387 dwMode |= ENABLE_PROCESSED_INPUT;
2390 SetConsoleMode(stdio->hStdIn, dwMode);
2392 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2393 qemu_chr_fe_set_echo(chr, false);
2395 return chr;
2397 #endif /* !_WIN32 */
2400 /***********************************************************/
2401 /* UDP Net console */
2403 typedef struct {
2404 int fd;
2405 GIOChannel *chan;
2406 uint8_t buf[READ_BUF_LEN];
2407 int bufcnt;
2408 int bufptr;
2409 int max_size;
2410 } NetCharDriver;
2412 /* Called with chr_write_lock held. */
2413 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2415 NetCharDriver *s = chr->opaque;
2416 gsize bytes_written;
2417 GIOStatus status;
2419 status = g_io_channel_write_chars(s->chan, (const gchar *)buf, len, &bytes_written, NULL);
2420 if (status == G_IO_STATUS_EOF) {
2421 return 0;
2422 } else if (status != G_IO_STATUS_NORMAL) {
2423 return -1;
2426 return bytes_written;
2429 static int udp_chr_read_poll(void *opaque)
2431 CharDriverState *chr = opaque;
2432 NetCharDriver *s = chr->opaque;
2434 s->max_size = qemu_chr_be_can_write(chr);
2436 /* If there were any stray characters in the queue process them
2437 * first
2439 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2440 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2441 s->bufptr++;
2442 s->max_size = qemu_chr_be_can_write(chr);
2444 return s->max_size;
2447 static gboolean udp_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
2449 CharDriverState *chr = opaque;
2450 NetCharDriver *s = chr->opaque;
2451 gsize bytes_read = 0;
2452 GIOStatus status;
2454 if (s->max_size == 0) {
2455 return TRUE;
2457 status = g_io_channel_read_chars(s->chan, (gchar *)s->buf, sizeof(s->buf),
2458 &bytes_read, NULL);
2459 s->bufcnt = bytes_read;
2460 s->bufptr = s->bufcnt;
2461 if (status != G_IO_STATUS_NORMAL) {
2462 remove_fd_in_watch(chr);
2463 return FALSE;
2466 s->bufptr = 0;
2467 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2468 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2469 s->bufptr++;
2470 s->max_size = qemu_chr_be_can_write(chr);
2473 return TRUE;
2476 static void udp_chr_update_read_handler(CharDriverState *chr)
2478 NetCharDriver *s = chr->opaque;
2480 remove_fd_in_watch(chr);
2481 if (s->chan) {
2482 chr->fd_in_tag = io_add_watch_poll(s->chan, udp_chr_read_poll,
2483 udp_chr_read, chr);
2487 static void udp_chr_close(CharDriverState *chr)
2489 NetCharDriver *s = chr->opaque;
2491 remove_fd_in_watch(chr);
2492 if (s->chan) {
2493 g_io_channel_unref(s->chan);
2494 closesocket(s->fd);
2496 g_free(s);
2497 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2500 static CharDriverState *qemu_chr_open_udp_fd(int fd)
2502 CharDriverState *chr = NULL;
2503 NetCharDriver *s = NULL;
2505 chr = qemu_chr_alloc();
2506 s = g_new0(NetCharDriver, 1);
2508 s->fd = fd;
2509 s->chan = io_channel_from_socket(s->fd);
2510 s->bufcnt = 0;
2511 s->bufptr = 0;
2512 chr->opaque = s;
2513 chr->chr_write = udp_chr_write;
2514 chr->chr_update_read_handler = udp_chr_update_read_handler;
2515 chr->chr_close = udp_chr_close;
2516 /* be isn't opened until we get a connection */
2517 chr->explicit_be_open = true;
2518 return chr;
2521 /***********************************************************/
2522 /* TCP Net console */
2524 typedef struct {
2526 GIOChannel *chan, *listen_chan;
2527 guint listen_tag;
2528 int fd, listen_fd;
2529 int connected;
2530 int max_size;
2531 int do_telnetopt;
2532 int do_nodelay;
2533 int is_unix;
2534 int *read_msgfds;
2535 int read_msgfds_num;
2536 int *write_msgfds;
2537 int write_msgfds_num;
2539 SocketAddress *addr;
2540 bool is_listen;
2541 bool is_telnet;
2543 guint reconnect_timer;
2544 int64_t reconnect_time;
2545 bool connect_err_reported;
2546 } TCPCharDriver;
2548 static gboolean socket_reconnect_timeout(gpointer opaque);
2550 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2552 TCPCharDriver *s = chr->opaque;
2553 assert(s->connected == 0);
2554 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2555 socket_reconnect_timeout, chr);
2558 static void check_report_connect_error(CharDriverState *chr,
2559 Error *err)
2561 TCPCharDriver *s = chr->opaque;
2563 if (!s->connect_err_reported) {
2564 error_report("Unable to connect character device %s: %s",
2565 chr->label, error_get_pretty(err));
2566 s->connect_err_reported = true;
2568 qemu_chr_socket_restart_timer(chr);
2571 static gboolean tcp_chr_accept(GIOChannel *chan, GIOCondition cond, void *opaque);
2573 #ifndef _WIN32
2574 static int unix_send_msgfds(CharDriverState *chr, const uint8_t *buf, int len)
2576 TCPCharDriver *s = chr->opaque;
2577 struct msghdr msgh;
2578 struct iovec iov;
2579 int r;
2581 size_t fd_size = s->write_msgfds_num * sizeof(int);
2582 char control[CMSG_SPACE(fd_size)];
2583 struct cmsghdr *cmsg;
2585 memset(&msgh, 0, sizeof(msgh));
2586 memset(control, 0, sizeof(control));
2588 /* set the payload */
2589 iov.iov_base = (uint8_t *) buf;
2590 iov.iov_len = len;
2592 msgh.msg_iov = &iov;
2593 msgh.msg_iovlen = 1;
2595 msgh.msg_control = control;
2596 msgh.msg_controllen = sizeof(control);
2598 cmsg = CMSG_FIRSTHDR(&msgh);
2600 cmsg->cmsg_len = CMSG_LEN(fd_size);
2601 cmsg->cmsg_level = SOL_SOCKET;
2602 cmsg->cmsg_type = SCM_RIGHTS;
2603 memcpy(CMSG_DATA(cmsg), s->write_msgfds, fd_size);
2605 do {
2606 r = sendmsg(s->fd, &msgh, 0);
2607 } while (r < 0 && errno == EINTR);
2609 /* free the written msgfds, no matter what */
2610 if (s->write_msgfds_num) {
2611 g_free(s->write_msgfds);
2612 s->write_msgfds = 0;
2613 s->write_msgfds_num = 0;
2616 return r;
2618 #endif
2620 /* Called with chr_write_lock held. */
2621 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2623 TCPCharDriver *s = chr->opaque;
2624 if (s->connected) {
2625 #ifndef _WIN32
2626 if (s->is_unix && s->write_msgfds_num) {
2627 return unix_send_msgfds(chr, buf, len);
2628 } else
2629 #endif
2631 return io_channel_send(s->chan, buf, len);
2633 } else {
2634 /* XXX: indicate an error ? */
2635 return len;
2639 static int tcp_chr_read_poll(void *opaque)
2641 CharDriverState *chr = opaque;
2642 TCPCharDriver *s = chr->opaque;
2643 if (!s->connected)
2644 return 0;
2645 s->max_size = qemu_chr_be_can_write(chr);
2646 return s->max_size;
2649 #define IAC 255
2650 #define IAC_BREAK 243
2651 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2652 TCPCharDriver *s,
2653 uint8_t *buf, int *size)
2655 /* Handle any telnet client's basic IAC options to satisfy char by
2656 * char mode with no echo. All IAC options will be removed from
2657 * the buf and the do_telnetopt variable will be used to track the
2658 * state of the width of the IAC information.
2660 * IAC commands come in sets of 3 bytes with the exception of the
2661 * "IAC BREAK" command and the double IAC.
2664 int i;
2665 int j = 0;
2667 for (i = 0; i < *size; i++) {
2668 if (s->do_telnetopt > 1) {
2669 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2670 /* Double IAC means send an IAC */
2671 if (j != i)
2672 buf[j] = buf[i];
2673 j++;
2674 s->do_telnetopt = 1;
2675 } else {
2676 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2677 /* Handle IAC break commands by sending a serial break */
2678 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2679 s->do_telnetopt++;
2681 s->do_telnetopt++;
2683 if (s->do_telnetopt >= 4) {
2684 s->do_telnetopt = 1;
2686 } else {
2687 if ((unsigned char)buf[i] == IAC) {
2688 s->do_telnetopt = 2;
2689 } else {
2690 if (j != i)
2691 buf[j] = buf[i];
2692 j++;
2696 *size = j;
2699 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2701 TCPCharDriver *s = chr->opaque;
2702 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2704 assert(num <= TCP_MAX_FDS);
2706 if (to_copy) {
2707 int i;
2709 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2711 /* Close unused fds */
2712 for (i = to_copy; i < s->read_msgfds_num; i++) {
2713 close(s->read_msgfds[i]);
2716 g_free(s->read_msgfds);
2717 s->read_msgfds = 0;
2718 s->read_msgfds_num = 0;
2721 return to_copy;
2724 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2726 TCPCharDriver *s = chr->opaque;
2728 /* clear old pending fd array */
2729 g_free(s->write_msgfds);
2731 if (num) {
2732 s->write_msgfds = g_new(int, num);
2733 memcpy(s->write_msgfds, fds, num * sizeof(int));
2736 s->write_msgfds_num = num;
2738 return 0;
2741 #ifndef _WIN32
2742 static void unix_process_msgfd(CharDriverState *chr, struct msghdr *msg)
2744 TCPCharDriver *s = chr->opaque;
2745 struct cmsghdr *cmsg;
2747 for (cmsg = CMSG_FIRSTHDR(msg); cmsg; cmsg = CMSG_NXTHDR(msg, cmsg)) {
2748 int fd_size, i;
2750 if (cmsg->cmsg_len < CMSG_LEN(sizeof(int)) ||
2751 cmsg->cmsg_level != SOL_SOCKET ||
2752 cmsg->cmsg_type != SCM_RIGHTS) {
2753 continue;
2756 fd_size = cmsg->cmsg_len - CMSG_LEN(0);
2758 if (!fd_size) {
2759 continue;
2762 /* close and clean read_msgfds */
2763 for (i = 0; i < s->read_msgfds_num; i++) {
2764 close(s->read_msgfds[i]);
2767 if (s->read_msgfds_num) {
2768 g_free(s->read_msgfds);
2771 s->read_msgfds_num = fd_size / sizeof(int);
2772 s->read_msgfds = g_malloc(fd_size);
2773 memcpy(s->read_msgfds, CMSG_DATA(cmsg), fd_size);
2775 for (i = 0; i < s->read_msgfds_num; i++) {
2776 int fd = s->read_msgfds[i];
2777 if (fd < 0) {
2778 continue;
2781 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
2782 qemu_set_block(fd);
2784 #ifndef MSG_CMSG_CLOEXEC
2785 qemu_set_cloexec(fd);
2786 #endif
2791 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2793 TCPCharDriver *s = chr->opaque;
2794 struct msghdr msg = { NULL, };
2795 struct iovec iov[1];
2796 union {
2797 struct cmsghdr cmsg;
2798 char control[CMSG_SPACE(sizeof(int) * TCP_MAX_FDS)];
2799 } msg_control;
2800 int flags = 0;
2801 ssize_t ret;
2803 iov[0].iov_base = buf;
2804 iov[0].iov_len = len;
2806 msg.msg_iov = iov;
2807 msg.msg_iovlen = 1;
2808 msg.msg_control = &msg_control;
2809 msg.msg_controllen = sizeof(msg_control);
2811 #ifdef MSG_CMSG_CLOEXEC
2812 flags |= MSG_CMSG_CLOEXEC;
2813 #endif
2814 do {
2815 ret = recvmsg(s->fd, &msg, flags);
2816 } while (ret == -1 && errno == EINTR);
2818 if (ret > 0 && s->is_unix) {
2819 unix_process_msgfd(chr, &msg);
2822 return ret;
2824 #else
2825 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2827 TCPCharDriver *s = chr->opaque;
2828 ssize_t ret;
2830 do {
2831 ret = qemu_recv(s->fd, buf, len, 0);
2832 } while (ret == -1 && socket_error() == EINTR);
2834 return ret;
2836 #endif
2838 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
2840 TCPCharDriver *s = chr->opaque;
2841 return g_io_create_watch(s->chan, cond);
2844 static void tcp_chr_disconnect(CharDriverState *chr)
2846 TCPCharDriver *s = chr->opaque;
2848 s->connected = 0;
2849 if (s->listen_chan) {
2850 s->listen_tag = g_io_add_watch(s->listen_chan, G_IO_IN,
2851 tcp_chr_accept, chr);
2853 remove_fd_in_watch(chr);
2854 g_io_channel_unref(s->chan);
2855 s->chan = NULL;
2856 closesocket(s->fd);
2857 s->fd = -1;
2858 SocketAddress_to_str(chr->filename, CHR_MAX_FILENAME_SIZE,
2859 "disconnected:", s->addr, s->is_listen, s->is_telnet);
2860 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2861 if (s->reconnect_time) {
2862 qemu_chr_socket_restart_timer(chr);
2866 static gboolean tcp_chr_read(GIOChannel *chan, GIOCondition cond, void *opaque)
2868 CharDriverState *chr = opaque;
2869 TCPCharDriver *s = chr->opaque;
2870 uint8_t buf[READ_BUF_LEN];
2871 int len, size;
2873 if (!s->connected || s->max_size <= 0) {
2874 return TRUE;
2876 len = sizeof(buf);
2877 if (len > s->max_size)
2878 len = s->max_size;
2879 size = tcp_chr_recv(chr, (void *)buf, len);
2880 if (size == 0 ||
2881 (size < 0 &&
2882 socket_error() != EAGAIN && socket_error() != EWOULDBLOCK)) {
2883 /* connection closed */
2884 tcp_chr_disconnect(chr);
2885 } else if (size > 0) {
2886 if (s->do_telnetopt)
2887 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
2888 if (size > 0)
2889 qemu_chr_be_write(chr, buf, size);
2892 return TRUE;
2895 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
2897 TCPCharDriver *s = chr->opaque;
2898 int size;
2900 if (!s->connected) {
2901 return 0;
2904 size = tcp_chr_recv(chr, (void *) buf, len);
2905 if (size == 0) {
2906 /* connection closed */
2907 tcp_chr_disconnect(chr);
2910 return size;
2913 #ifndef _WIN32
2914 CharDriverState *qemu_chr_open_eventfd(int eventfd)
2916 CharDriverState *chr = qemu_chr_open_fd(eventfd, eventfd);
2918 if (chr) {
2919 chr->avail_connections = 1;
2922 return chr;
2924 #endif
2926 static void tcp_chr_connect(void *opaque)
2928 CharDriverState *chr = opaque;
2929 TCPCharDriver *s = chr->opaque;
2930 struct sockaddr_storage ss, ps;
2931 socklen_t ss_len = sizeof(ss), ps_len = sizeof(ps);
2933 memset(&ss, 0, ss_len);
2934 if (getsockname(s->fd, (struct sockaddr *) &ss, &ss_len) != 0) {
2935 snprintf(chr->filename, CHR_MAX_FILENAME_SIZE,
2936 "Error in getsockname: %s\n", strerror(errno));
2937 } else if (getpeername(s->fd, (struct sockaddr *) &ps, &ps_len) != 0) {
2938 snprintf(chr->filename, CHR_MAX_FILENAME_SIZE,
2939 "Error in getpeername: %s\n", strerror(errno));
2940 } else {
2941 sockaddr_to_str(chr->filename, CHR_MAX_FILENAME_SIZE,
2942 &ss, ss_len, &ps, ps_len,
2943 s->is_listen, s->is_telnet);
2946 s->connected = 1;
2947 if (s->chan) {
2948 chr->fd_in_tag = io_add_watch_poll(s->chan, tcp_chr_read_poll,
2949 tcp_chr_read, chr);
2951 qemu_chr_be_generic_open(chr);
2954 static void tcp_chr_update_read_handler(CharDriverState *chr)
2956 TCPCharDriver *s = chr->opaque;
2958 remove_fd_in_watch(chr);
2959 if (s->chan) {
2960 chr->fd_in_tag = io_add_watch_poll(s->chan, tcp_chr_read_poll,
2961 tcp_chr_read, chr);
2965 #define IACSET(x,a,b,c) x[0] = a; x[1] = b; x[2] = c;
2966 static void tcp_chr_telnet_init(int fd)
2968 char buf[3];
2969 /* Send the telnet negotion to put telnet in binary, no echo, single char mode */
2970 IACSET(buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
2971 send(fd, (char *)buf, 3, 0);
2972 IACSET(buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
2973 send(fd, (char *)buf, 3, 0);
2974 IACSET(buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
2975 send(fd, (char *)buf, 3, 0);
2976 IACSET(buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
2977 send(fd, (char *)buf, 3, 0);
2980 static int tcp_chr_add_client(CharDriverState *chr, int fd)
2982 TCPCharDriver *s = chr->opaque;
2983 if (s->fd != -1)
2984 return -1;
2986 qemu_set_nonblock(fd);
2987 if (s->do_nodelay)
2988 socket_set_nodelay(fd);
2989 s->fd = fd;
2990 s->chan = io_channel_from_socket(fd);
2991 if (s->listen_tag) {
2992 g_source_remove(s->listen_tag);
2993 s->listen_tag = 0;
2995 tcp_chr_connect(chr);
2997 return 0;
3000 static gboolean tcp_chr_accept(GIOChannel *channel, GIOCondition cond, void *opaque)
3002 CharDriverState *chr = opaque;
3003 TCPCharDriver *s = chr->opaque;
3004 struct sockaddr_in saddr;
3005 #ifndef _WIN32
3006 struct sockaddr_un uaddr;
3007 #endif
3008 struct sockaddr *addr;
3009 socklen_t len;
3010 int fd;
3012 for(;;) {
3013 #ifndef _WIN32
3014 if (s->is_unix) {
3015 len = sizeof(uaddr);
3016 addr = (struct sockaddr *)&uaddr;
3017 } else
3018 #endif
3020 len = sizeof(saddr);
3021 addr = (struct sockaddr *)&saddr;
3023 fd = qemu_accept(s->listen_fd, addr, &len);
3024 if (fd < 0 && errno != EINTR) {
3025 s->listen_tag = 0;
3026 return FALSE;
3027 } else if (fd >= 0) {
3028 if (s->do_telnetopt)
3029 tcp_chr_telnet_init(fd);
3030 break;
3033 if (tcp_chr_add_client(chr, fd) < 0)
3034 close(fd);
3036 return TRUE;
3039 static void tcp_chr_close(CharDriverState *chr)
3041 TCPCharDriver *s = chr->opaque;
3042 int i;
3044 if (s->reconnect_timer) {
3045 g_source_remove(s->reconnect_timer);
3046 s->reconnect_timer = 0;
3048 qapi_free_SocketAddress(s->addr);
3049 if (s->fd >= 0) {
3050 remove_fd_in_watch(chr);
3051 if (s->chan) {
3052 g_io_channel_unref(s->chan);
3054 closesocket(s->fd);
3056 if (s->listen_fd >= 0) {
3057 if (s->listen_tag) {
3058 g_source_remove(s->listen_tag);
3059 s->listen_tag = 0;
3061 if (s->listen_chan) {
3062 g_io_channel_unref(s->listen_chan);
3064 closesocket(s->listen_fd);
3066 if (s->read_msgfds_num) {
3067 for (i = 0; i < s->read_msgfds_num; i++) {
3068 close(s->read_msgfds[i]);
3070 g_free(s->read_msgfds);
3072 if (s->write_msgfds_num) {
3073 g_free(s->write_msgfds);
3075 g_free(s);
3076 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3079 static void qemu_chr_finish_socket_connection(CharDriverState *chr, int fd)
3081 TCPCharDriver *s = chr->opaque;
3083 if (s->is_listen) {
3084 s->listen_fd = fd;
3085 s->listen_chan = io_channel_from_socket(s->listen_fd);
3086 s->listen_tag = g_io_add_watch(s->listen_chan, G_IO_IN,
3087 tcp_chr_accept, chr);
3088 } else {
3089 s->connected = 1;
3090 s->fd = fd;
3091 socket_set_nodelay(fd);
3092 s->chan = io_channel_from_socket(s->fd);
3093 tcp_chr_connect(chr);
3097 static void qemu_chr_socket_connected(int fd, Error *err, void *opaque)
3099 CharDriverState *chr = opaque;
3100 TCPCharDriver *s = chr->opaque;
3102 if (fd < 0) {
3103 check_report_connect_error(chr, err);
3104 return;
3107 s->connect_err_reported = false;
3108 qemu_chr_finish_socket_connection(chr, fd);
3111 static bool qemu_chr_open_socket_fd(CharDriverState *chr, Error **errp)
3113 TCPCharDriver *s = chr->opaque;
3114 int fd;
3116 if (s->is_listen) {
3117 fd = socket_listen(s->addr, errp);
3118 } else if (s->reconnect_time) {
3119 fd = socket_connect(s->addr, errp, qemu_chr_socket_connected, chr);
3120 return fd >= 0;
3121 } else {
3122 fd = socket_connect(s->addr, errp, NULL, NULL);
3124 if (fd < 0) {
3125 return false;
3128 qemu_chr_finish_socket_connection(chr, fd);
3129 return true;
3132 /*********************************************************/
3133 /* Ring buffer chardev */
3135 typedef struct {
3136 size_t size;
3137 size_t prod;
3138 size_t cons;
3139 uint8_t *cbuf;
3140 } RingBufCharDriver;
3142 static size_t ringbuf_count(const CharDriverState *chr)
3144 const RingBufCharDriver *d = chr->opaque;
3146 return d->prod - d->cons;
3149 /* Called with chr_write_lock held. */
3150 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3152 RingBufCharDriver *d = chr->opaque;
3153 int i;
3155 if (!buf || (len < 0)) {
3156 return -1;
3159 for (i = 0; i < len; i++ ) {
3160 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3161 if (d->prod - d->cons > d->size) {
3162 d->cons = d->prod - d->size;
3166 return 0;
3169 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3171 RingBufCharDriver *d = chr->opaque;
3172 int i;
3174 qemu_mutex_lock(&chr->chr_write_lock);
3175 for (i = 0; i < len && d->cons != d->prod; i++) {
3176 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3178 qemu_mutex_unlock(&chr->chr_write_lock);
3180 return i;
3183 static void ringbuf_chr_close(struct CharDriverState *chr)
3185 RingBufCharDriver *d = chr->opaque;
3187 g_free(d->cbuf);
3188 g_free(d);
3189 chr->opaque = NULL;
3192 static CharDriverState *qemu_chr_open_ringbuf(ChardevRingbuf *opts,
3193 Error **errp)
3195 CharDriverState *chr;
3196 RingBufCharDriver *d;
3198 chr = qemu_chr_alloc();
3199 d = g_malloc(sizeof(*d));
3201 d->size = opts->has_size ? opts->size : 65536;
3203 /* The size must be power of 2 */
3204 if (d->size & (d->size - 1)) {
3205 error_setg(errp, "size of ringbuf chardev must be power of two");
3206 goto fail;
3209 d->prod = 0;
3210 d->cons = 0;
3211 d->cbuf = g_malloc0(d->size);
3213 chr->opaque = d;
3214 chr->chr_write = ringbuf_chr_write;
3215 chr->chr_close = ringbuf_chr_close;
3217 return chr;
3219 fail:
3220 g_free(d);
3221 g_free(chr);
3222 return NULL;
3225 bool chr_is_ringbuf(const CharDriverState *chr)
3227 return chr->chr_write == ringbuf_chr_write;
3230 void qmp_ringbuf_write(const char *device, const char *data,
3231 bool has_format, enum DataFormat format,
3232 Error **errp)
3234 CharDriverState *chr;
3235 const uint8_t *write_data;
3236 int ret;
3237 gsize write_count;
3239 chr = qemu_chr_find(device);
3240 if (!chr) {
3241 error_setg(errp, "Device '%s' not found", device);
3242 return;
3245 if (!chr_is_ringbuf(chr)) {
3246 error_setg(errp,"%s is not a ringbuf device", device);
3247 return;
3250 if (has_format && (format == DATA_FORMAT_BASE64)) {
3251 write_data = g_base64_decode(data, &write_count);
3252 } else {
3253 write_data = (uint8_t *)data;
3254 write_count = strlen(data);
3257 ret = ringbuf_chr_write(chr, write_data, write_count);
3259 if (write_data != (uint8_t *)data) {
3260 g_free((void *)write_data);
3263 if (ret < 0) {
3264 error_setg(errp, "Failed to write to device %s", device);
3265 return;
3269 char *qmp_ringbuf_read(const char *device, int64_t size,
3270 bool has_format, enum DataFormat format,
3271 Error **errp)
3273 CharDriverState *chr;
3274 uint8_t *read_data;
3275 size_t count;
3276 char *data;
3278 chr = qemu_chr_find(device);
3279 if (!chr) {
3280 error_setg(errp, "Device '%s' not found", device);
3281 return NULL;
3284 if (!chr_is_ringbuf(chr)) {
3285 error_setg(errp,"%s is not a ringbuf device", device);
3286 return NULL;
3289 if (size <= 0) {
3290 error_setg(errp, "size must be greater than zero");
3291 return NULL;
3294 count = ringbuf_count(chr);
3295 size = size > count ? count : size;
3296 read_data = g_malloc(size + 1);
3298 ringbuf_chr_read(chr, read_data, size);
3300 if (has_format && (format == DATA_FORMAT_BASE64)) {
3301 data = g_base64_encode(read_data, size);
3302 g_free(read_data);
3303 } else {
3305 * FIXME should read only complete, valid UTF-8 characters up
3306 * to @size bytes. Invalid sequences should be replaced by a
3307 * suitable replacement character. Except when (and only
3308 * when) ring buffer lost characters since last read, initial
3309 * continuation characters should be dropped.
3311 read_data[size] = 0;
3312 data = (char *)read_data;
3315 return data;
3318 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3320 char host[65], port[33], width[8], height[8];
3321 int pos;
3322 const char *p;
3323 QemuOpts *opts;
3324 Error *local_err = NULL;
3326 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3327 if (local_err) {
3328 error_report_err(local_err);
3329 return NULL;
3332 if (strstart(filename, "mon:", &p)) {
3333 filename = p;
3334 qemu_opt_set(opts, "mux", "on", &error_abort);
3335 if (strcmp(filename, "stdio") == 0) {
3336 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3337 * but pass it to the guest. Handle this only for compat syntax,
3338 * for -chardev syntax we have special option for this.
3339 * This is what -nographic did, redirecting+muxing serial+monitor
3340 * to stdio causing Ctrl+C to be passed to guest. */
3341 qemu_opt_set(opts, "signal", "off", &error_abort);
3345 if (strcmp(filename, "null") == 0 ||
3346 strcmp(filename, "pty") == 0 ||
3347 strcmp(filename, "msmouse") == 0 ||
3348 strcmp(filename, "braille") == 0 ||
3349 strcmp(filename, "testdev") == 0 ||
3350 strcmp(filename, "stdio") == 0) {
3351 qemu_opt_set(opts, "backend", filename, &error_abort);
3352 return opts;
3354 if (strstart(filename, "vc", &p)) {
3355 qemu_opt_set(opts, "backend", "vc", &error_abort);
3356 if (*p == ':') {
3357 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3358 /* pixels */
3359 qemu_opt_set(opts, "width", width, &error_abort);
3360 qemu_opt_set(opts, "height", height, &error_abort);
3361 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3362 /* chars */
3363 qemu_opt_set(opts, "cols", width, &error_abort);
3364 qemu_opt_set(opts, "rows", height, &error_abort);
3365 } else {
3366 goto fail;
3369 return opts;
3371 if (strcmp(filename, "con:") == 0) {
3372 qemu_opt_set(opts, "backend", "console", &error_abort);
3373 return opts;
3375 if (strstart(filename, "COM", NULL)) {
3376 qemu_opt_set(opts, "backend", "serial", &error_abort);
3377 qemu_opt_set(opts, "path", filename, &error_abort);
3378 return opts;
3380 if (strstart(filename, "file:", &p)) {
3381 qemu_opt_set(opts, "backend", "file", &error_abort);
3382 qemu_opt_set(opts, "path", p, &error_abort);
3383 return opts;
3385 if (strstart(filename, "pipe:", &p)) {
3386 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3387 qemu_opt_set(opts, "path", p, &error_abort);
3388 return opts;
3390 if (strstart(filename, "tcp:", &p) ||
3391 strstart(filename, "telnet:", &p)) {
3392 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3393 host[0] = 0;
3394 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3395 goto fail;
3397 qemu_opt_set(opts, "backend", "socket", &error_abort);
3398 qemu_opt_set(opts, "host", host, &error_abort);
3399 qemu_opt_set(opts, "port", port, &error_abort);
3400 if (p[pos] == ',') {
3401 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3402 if (local_err) {
3403 error_report_err(local_err);
3404 goto fail;
3407 if (strstart(filename, "telnet:", &p))
3408 qemu_opt_set(opts, "telnet", "on", &error_abort);
3409 return opts;
3411 if (strstart(filename, "udp:", &p)) {
3412 qemu_opt_set(opts, "backend", "udp", &error_abort);
3413 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3414 host[0] = 0;
3415 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3416 goto fail;
3419 qemu_opt_set(opts, "host", host, &error_abort);
3420 qemu_opt_set(opts, "port", port, &error_abort);
3421 if (p[pos] == '@') {
3422 p += pos + 1;
3423 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3424 host[0] = 0;
3425 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3426 goto fail;
3429 qemu_opt_set(opts, "localaddr", host, &error_abort);
3430 qemu_opt_set(opts, "localport", port, &error_abort);
3432 return opts;
3434 if (strstart(filename, "unix:", &p)) {
3435 qemu_opt_set(opts, "backend", "socket", &error_abort);
3436 qemu_opts_do_parse(opts, p, "path", &local_err);
3437 if (local_err) {
3438 error_report_err(local_err);
3439 goto fail;
3441 return opts;
3443 if (strstart(filename, "/dev/parport", NULL) ||
3444 strstart(filename, "/dev/ppi", NULL)) {
3445 qemu_opt_set(opts, "backend", "parport", &error_abort);
3446 qemu_opt_set(opts, "path", filename, &error_abort);
3447 return opts;
3449 if (strstart(filename, "/dev/", NULL)) {
3450 qemu_opt_set(opts, "backend", "tty", &error_abort);
3451 qemu_opt_set(opts, "path", filename, &error_abort);
3452 return opts;
3455 fail:
3456 qemu_opts_del(opts);
3457 return NULL;
3460 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3461 Error **errp)
3463 const char *path = qemu_opt_get(opts, "path");
3465 if (path == NULL) {
3466 error_setg(errp, "chardev: file: no filename given");
3467 return;
3469 backend->file = g_new0(ChardevFile, 1);
3470 backend->file->out = g_strdup(path);
3473 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3474 Error **errp)
3476 backend->stdio = g_new0(ChardevStdio, 1);
3477 backend->stdio->has_signal = true;
3478 backend->stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3481 #ifdef HAVE_CHARDEV_SERIAL
3482 static void qemu_chr_parse_serial(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: serial/tty: no device path given");
3489 return;
3491 backend->serial = g_new0(ChardevHostdev, 1);
3492 backend->serial->device = g_strdup(device);
3494 #endif
3496 #ifdef HAVE_CHARDEV_PARPORT
3497 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3498 Error **errp)
3500 const char *device = qemu_opt_get(opts, "path");
3502 if (device == NULL) {
3503 error_setg(errp, "chardev: parallel: no device path given");
3504 return;
3506 backend->parallel = g_new0(ChardevHostdev, 1);
3507 backend->parallel->device = g_strdup(device);
3509 #endif
3511 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3512 Error **errp)
3514 const char *device = qemu_opt_get(opts, "path");
3516 if (device == NULL) {
3517 error_setg(errp, "chardev: pipe: no device path given");
3518 return;
3520 backend->pipe = g_new0(ChardevHostdev, 1);
3521 backend->pipe->device = g_strdup(device);
3524 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3525 Error **errp)
3527 int val;
3529 backend->ringbuf = g_new0(ChardevRingbuf, 1);
3531 val = qemu_opt_get_size(opts, "size", 0);
3532 if (val != 0) {
3533 backend->ringbuf->has_size = true;
3534 backend->ringbuf->size = val;
3538 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3539 Error **errp)
3541 const char *chardev = qemu_opt_get(opts, "chardev");
3543 if (chardev == NULL) {
3544 error_setg(errp, "chardev: mux: no chardev given");
3545 return;
3547 backend->mux = g_new0(ChardevMux, 1);
3548 backend->mux->chardev = g_strdup(chardev);
3551 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3552 Error **errp)
3554 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3555 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3556 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3557 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3558 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3559 const char *path = qemu_opt_get(opts, "path");
3560 const char *host = qemu_opt_get(opts, "host");
3561 const char *port = qemu_opt_get(opts, "port");
3562 SocketAddress *addr;
3564 if (!path) {
3565 if (!host) {
3566 error_setg(errp, "chardev: socket: no host given");
3567 return;
3569 if (!port) {
3570 error_setg(errp, "chardev: socket: no port given");
3571 return;
3575 backend->socket = g_new0(ChardevSocket, 1);
3577 backend->socket->has_nodelay = true;
3578 backend->socket->nodelay = do_nodelay;
3579 backend->socket->has_server = true;
3580 backend->socket->server = is_listen;
3581 backend->socket->has_telnet = true;
3582 backend->socket->telnet = is_telnet;
3583 backend->socket->has_wait = true;
3584 backend->socket->wait = is_waitconnect;
3585 backend->socket->has_reconnect = true;
3586 backend->socket->reconnect = reconnect;
3588 addr = g_new0(SocketAddress, 1);
3589 if (path) {
3590 addr->kind = SOCKET_ADDRESS_KIND_UNIX;
3591 addr->q_unix = g_new0(UnixSocketAddress, 1);
3592 addr->q_unix->path = g_strdup(path);
3593 } else {
3594 addr->kind = SOCKET_ADDRESS_KIND_INET;
3595 addr->inet = g_new0(InetSocketAddress, 1);
3596 addr->inet->host = g_strdup(host);
3597 addr->inet->port = g_strdup(port);
3598 addr->inet->has_to = qemu_opt_get(opts, "to");
3599 addr->inet->to = qemu_opt_get_number(opts, "to", 0);
3600 addr->inet->has_ipv4 = qemu_opt_get(opts, "ipv4");
3601 addr->inet->ipv4 = qemu_opt_get_bool(opts, "ipv4", 0);
3602 addr->inet->has_ipv6 = qemu_opt_get(opts, "ipv6");
3603 addr->inet->ipv6 = qemu_opt_get_bool(opts, "ipv6", 0);
3605 backend->socket->addr = addr;
3608 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3609 Error **errp)
3611 const char *host = qemu_opt_get(opts, "host");
3612 const char *port = qemu_opt_get(opts, "port");
3613 const char *localaddr = qemu_opt_get(opts, "localaddr");
3614 const char *localport = qemu_opt_get(opts, "localport");
3615 bool has_local = false;
3616 SocketAddress *addr;
3618 if (host == NULL || strlen(host) == 0) {
3619 host = "localhost";
3621 if (port == NULL || strlen(port) == 0) {
3622 error_setg(errp, "chardev: udp: remote port not specified");
3623 return;
3625 if (localport == NULL || strlen(localport) == 0) {
3626 localport = "0";
3627 } else {
3628 has_local = true;
3630 if (localaddr == NULL || strlen(localaddr) == 0) {
3631 localaddr = "";
3632 } else {
3633 has_local = true;
3636 backend->udp = g_new0(ChardevUdp, 1);
3638 addr = g_new0(SocketAddress, 1);
3639 addr->kind = SOCKET_ADDRESS_KIND_INET;
3640 addr->inet = g_new0(InetSocketAddress, 1);
3641 addr->inet->host = g_strdup(host);
3642 addr->inet->port = g_strdup(port);
3643 addr->inet->has_ipv4 = qemu_opt_get(opts, "ipv4");
3644 addr->inet->ipv4 = qemu_opt_get_bool(opts, "ipv4", 0);
3645 addr->inet->has_ipv6 = qemu_opt_get(opts, "ipv6");
3646 addr->inet->ipv6 = qemu_opt_get_bool(opts, "ipv6", 0);
3647 backend->udp->remote = addr;
3649 if (has_local) {
3650 backend->udp->has_local = true;
3651 addr = g_new0(SocketAddress, 1);
3652 addr->kind = SOCKET_ADDRESS_KIND_INET;
3653 addr->inet = g_new0(InetSocketAddress, 1);
3654 addr->inet->host = g_strdup(localaddr);
3655 addr->inet->port = g_strdup(localport);
3656 backend->udp->local = addr;
3660 typedef struct CharDriver {
3661 const char *name;
3662 ChardevBackendKind kind;
3663 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
3664 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3665 ChardevReturn *ret, Error **errp);
3666 } CharDriver;
3668 static GSList *backends;
3670 void register_char_driver(const char *name, ChardevBackendKind kind,
3671 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
3672 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
3673 ChardevReturn *ret, Error **errp))
3675 CharDriver *s;
3677 s = g_malloc0(sizeof(*s));
3678 s->name = g_strdup(name);
3679 s->kind = kind;
3680 s->parse = parse;
3681 s->create = create;
3683 backends = g_slist_append(backends, s);
3686 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
3687 void (*init)(struct CharDriverState *s),
3688 Error **errp)
3690 Error *local_err = NULL;
3691 CharDriver *cd;
3692 CharDriverState *chr;
3693 GSList *i;
3694 ChardevReturn *ret = NULL;
3695 ChardevBackend *backend;
3696 const char *id = qemu_opts_id(opts);
3697 char *bid = NULL;
3699 if (id == NULL) {
3700 error_setg(errp, "chardev: no id specified");
3701 goto err;
3704 if (qemu_opt_get(opts, "backend") == NULL) {
3705 error_setg(errp, "chardev: \"%s\" missing backend",
3706 qemu_opts_id(opts));
3707 goto err;
3709 for (i = backends; i; i = i->next) {
3710 cd = i->data;
3712 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
3713 break;
3716 if (i == NULL) {
3717 error_setg(errp, "chardev: backend \"%s\" not found",
3718 qemu_opt_get(opts, "backend"));
3719 goto err;
3722 backend = g_new0(ChardevBackend, 1);
3724 if (qemu_opt_get_bool(opts, "mux", 0)) {
3725 bid = g_strdup_printf("%s-base", id);
3728 chr = NULL;
3729 backend->kind = cd->kind;
3730 if (cd->parse) {
3731 cd->parse(opts, backend, &local_err);
3732 if (local_err) {
3733 error_propagate(errp, local_err);
3734 goto qapi_out;
3737 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
3738 if (!ret) {
3739 goto qapi_out;
3742 if (bid) {
3743 qapi_free_ChardevBackend(backend);
3744 qapi_free_ChardevReturn(ret);
3745 backend = g_new0(ChardevBackend, 1);
3746 backend->mux = g_new0(ChardevMux, 1);
3747 backend->kind = CHARDEV_BACKEND_KIND_MUX;
3748 backend->mux->chardev = g_strdup(bid);
3749 ret = qmp_chardev_add(id, backend, errp);
3750 if (!ret) {
3751 chr = qemu_chr_find(bid);
3752 qemu_chr_delete(chr);
3753 chr = NULL;
3754 goto qapi_out;
3758 chr = qemu_chr_find(id);
3759 chr->opts = opts;
3761 qapi_out:
3762 qapi_free_ChardevBackend(backend);
3763 qapi_free_ChardevReturn(ret);
3764 g_free(bid);
3765 return chr;
3767 err:
3768 qemu_opts_del(opts);
3769 return NULL;
3772 CharDriverState *qemu_chr_new(const char *label, const char *filename, void (*init)(struct CharDriverState *s))
3774 const char *p;
3775 CharDriverState *chr;
3776 QemuOpts *opts;
3777 Error *err = NULL;
3779 if (strstart(filename, "chardev:", &p)) {
3780 return qemu_chr_find(p);
3783 opts = qemu_chr_parse_compat(label, filename);
3784 if (!opts)
3785 return NULL;
3787 chr = qemu_chr_new_from_opts(opts, init, &err);
3788 if (err) {
3789 error_report_err(err);
3791 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
3792 qemu_chr_fe_claim_no_fail(chr);
3793 monitor_init(chr, MONITOR_USE_READLINE);
3795 return chr;
3798 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo)
3800 if (chr->chr_set_echo) {
3801 chr->chr_set_echo(chr, echo);
3805 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open)
3807 if (chr->fe_open == fe_open) {
3808 return;
3810 chr->fe_open = fe_open;
3811 if (chr->chr_set_fe_open) {
3812 chr->chr_set_fe_open(chr, fe_open);
3816 void qemu_chr_fe_event(struct CharDriverState *chr, int event)
3818 if (chr->chr_fe_event) {
3819 chr->chr_fe_event(chr, event);
3823 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
3824 GIOFunc func, void *user_data)
3826 GSource *src;
3827 guint tag;
3829 if (s->chr_add_watch == NULL) {
3830 return -ENOSYS;
3833 src = s->chr_add_watch(s, cond);
3834 if (!src) {
3835 return -EINVAL;
3838 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
3839 tag = g_source_attach(src, NULL);
3840 g_source_unref(src);
3842 return tag;
3845 int qemu_chr_fe_claim(CharDriverState *s)
3847 if (s->avail_connections < 1) {
3848 return -1;
3850 s->avail_connections--;
3851 return 0;
3854 void qemu_chr_fe_claim_no_fail(CharDriverState *s)
3856 if (qemu_chr_fe_claim(s) != 0) {
3857 fprintf(stderr, "%s: error chardev \"%s\" already used\n",
3858 __func__, s->label);
3859 exit(1);
3863 void qemu_chr_fe_release(CharDriverState *s)
3865 s->avail_connections++;
3868 void qemu_chr_delete(CharDriverState *chr)
3870 QTAILQ_REMOVE(&chardevs, chr, next);
3871 if (chr->chr_close) {
3872 chr->chr_close(chr);
3874 g_free(chr->filename);
3875 g_free(chr->label);
3876 qemu_opts_del(chr->opts);
3877 g_free(chr);
3880 ChardevInfoList *qmp_query_chardev(Error **errp)
3882 ChardevInfoList *chr_list = NULL;
3883 CharDriverState *chr;
3885 QTAILQ_FOREACH(chr, &chardevs, next) {
3886 ChardevInfoList *info = g_malloc0(sizeof(*info));
3887 info->value = g_malloc0(sizeof(*info->value));
3888 info->value->label = g_strdup(chr->label);
3889 info->value->filename = g_strdup(chr->filename);
3890 info->value->frontend_open = chr->fe_open;
3892 info->next = chr_list;
3893 chr_list = info;
3896 return chr_list;
3899 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
3901 ChardevBackendInfoList *backend_list = NULL;
3902 CharDriver *c = NULL;
3903 GSList *i = NULL;
3905 for (i = backends; i; i = i->next) {
3906 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
3907 c = i->data;
3908 info->value = g_malloc0(sizeof(*info->value));
3909 info->value->name = g_strdup(c->name);
3911 info->next = backend_list;
3912 backend_list = info;
3915 return backend_list;
3918 CharDriverState *qemu_chr_find(const char *name)
3920 CharDriverState *chr;
3922 QTAILQ_FOREACH(chr, &chardevs, next) {
3923 if (strcmp(chr->label, name) != 0)
3924 continue;
3925 return chr;
3927 return NULL;
3930 /* Get a character (serial) device interface. */
3931 CharDriverState *qemu_char_get_next_serial(void)
3933 static int next_serial;
3934 CharDriverState *chr;
3936 /* FIXME: This function needs to go away: use chardev properties! */
3938 while (next_serial < MAX_SERIAL_PORTS && serial_hds[next_serial]) {
3939 chr = serial_hds[next_serial++];
3940 qemu_chr_fe_claim_no_fail(chr);
3941 return chr;
3943 return NULL;
3946 QemuOptsList qemu_chardev_opts = {
3947 .name = "chardev",
3948 .implied_opt_name = "backend",
3949 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
3950 .desc = {
3952 .name = "backend",
3953 .type = QEMU_OPT_STRING,
3955 .name = "path",
3956 .type = QEMU_OPT_STRING,
3958 .name = "host",
3959 .type = QEMU_OPT_STRING,
3961 .name = "port",
3962 .type = QEMU_OPT_STRING,
3964 .name = "localaddr",
3965 .type = QEMU_OPT_STRING,
3967 .name = "localport",
3968 .type = QEMU_OPT_STRING,
3970 .name = "to",
3971 .type = QEMU_OPT_NUMBER,
3973 .name = "ipv4",
3974 .type = QEMU_OPT_BOOL,
3976 .name = "ipv6",
3977 .type = QEMU_OPT_BOOL,
3979 .name = "wait",
3980 .type = QEMU_OPT_BOOL,
3982 .name = "server",
3983 .type = QEMU_OPT_BOOL,
3985 .name = "delay",
3986 .type = QEMU_OPT_BOOL,
3988 .name = "reconnect",
3989 .type = QEMU_OPT_NUMBER,
3991 .name = "telnet",
3992 .type = QEMU_OPT_BOOL,
3994 .name = "width",
3995 .type = QEMU_OPT_NUMBER,
3997 .name = "height",
3998 .type = QEMU_OPT_NUMBER,
4000 .name = "cols",
4001 .type = QEMU_OPT_NUMBER,
4003 .name = "rows",
4004 .type = QEMU_OPT_NUMBER,
4006 .name = "mux",
4007 .type = QEMU_OPT_BOOL,
4009 .name = "signal",
4010 .type = QEMU_OPT_BOOL,
4012 .name = "name",
4013 .type = QEMU_OPT_STRING,
4015 .name = "debug",
4016 .type = QEMU_OPT_NUMBER,
4018 .name = "size",
4019 .type = QEMU_OPT_SIZE,
4021 .name = "chardev",
4022 .type = QEMU_OPT_STRING,
4024 { /* end of list */ }
4028 #ifdef _WIN32
4030 static CharDriverState *qmp_chardev_open_file(const char *id,
4031 ChardevBackend *backend,
4032 ChardevReturn *ret,
4033 Error **errp)
4035 ChardevFile *file = backend->file;
4036 HANDLE out;
4038 if (file->has_in) {
4039 error_setg(errp, "input file not supported");
4040 return NULL;
4043 out = CreateFile(file->out, GENERIC_WRITE, FILE_SHARE_READ, NULL,
4044 OPEN_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
4045 if (out == INVALID_HANDLE_VALUE) {
4046 error_setg(errp, "open %s failed", file->out);
4047 return NULL;
4049 return qemu_chr_open_win_file(out);
4052 static CharDriverState *qmp_chardev_open_serial(const char *id,
4053 ChardevBackend *backend,
4054 ChardevReturn *ret,
4055 Error **errp)
4057 ChardevHostdev *serial = backend->serial;
4058 return qemu_chr_open_win_path(serial->device, errp);
4061 #else /* WIN32 */
4063 static int qmp_chardev_open_file_source(char *src, int flags,
4064 Error **errp)
4066 int fd = -1;
4068 TFR(fd = qemu_open(src, flags, 0666));
4069 if (fd == -1) {
4070 error_setg_file_open(errp, errno, src);
4072 return fd;
4075 static CharDriverState *qmp_chardev_open_file(const char *id,
4076 ChardevBackend *backend,
4077 ChardevReturn *ret,
4078 Error **errp)
4080 ChardevFile *file = backend->file;
4081 int flags, in = -1, out;
4083 flags = O_WRONLY | O_TRUNC | O_CREAT | O_BINARY;
4084 out = qmp_chardev_open_file_source(file->out, flags, errp);
4085 if (out < 0) {
4086 return NULL;
4089 if (file->has_in) {
4090 flags = O_RDONLY;
4091 in = qmp_chardev_open_file_source(file->in, flags, errp);
4092 if (in < 0) {
4093 qemu_close(out);
4094 return NULL;
4098 return qemu_chr_open_fd(in, out);
4101 #ifdef HAVE_CHARDEV_SERIAL
4102 static CharDriverState *qmp_chardev_open_serial(const char *id,
4103 ChardevBackend *backend,
4104 ChardevReturn *ret,
4105 Error **errp)
4107 ChardevHostdev *serial = backend->serial;
4108 int fd;
4110 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4111 if (fd < 0) {
4112 return NULL;
4114 qemu_set_nonblock(fd);
4115 return qemu_chr_open_tty_fd(fd);
4117 #endif
4119 #ifdef HAVE_CHARDEV_PARPORT
4120 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4121 ChardevBackend *backend,
4122 ChardevReturn *ret,
4123 Error **errp)
4125 ChardevHostdev *parallel = backend->parallel;
4126 int fd;
4128 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4129 if (fd < 0) {
4130 return NULL;
4132 return qemu_chr_open_pp_fd(fd, errp);
4134 #endif
4136 #endif /* WIN32 */
4138 static void socket_try_connect(CharDriverState *chr)
4140 Error *err = NULL;
4142 if (!qemu_chr_open_socket_fd(chr, &err)) {
4143 check_report_connect_error(chr, err);
4147 static gboolean socket_reconnect_timeout(gpointer opaque)
4149 CharDriverState *chr = opaque;
4150 TCPCharDriver *s = chr->opaque;
4152 s->reconnect_timer = 0;
4154 if (chr->be_open) {
4155 return false;
4158 socket_try_connect(chr);
4160 return false;
4163 static CharDriverState *qmp_chardev_open_socket(const char *id,
4164 ChardevBackend *backend,
4165 ChardevReturn *ret,
4166 Error **errp)
4168 CharDriverState *chr;
4169 TCPCharDriver *s;
4170 ChardevSocket *sock = backend->socket;
4171 SocketAddress *addr = sock->addr;
4172 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4173 bool is_listen = sock->has_server ? sock->server : true;
4174 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4175 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4176 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4178 chr = qemu_chr_alloc();
4179 s = g_new0(TCPCharDriver, 1);
4181 s->fd = -1;
4182 s->listen_fd = -1;
4183 s->is_unix = addr->kind == SOCKET_ADDRESS_KIND_UNIX;
4184 s->is_listen = is_listen;
4185 s->is_telnet = is_telnet;
4186 s->do_nodelay = do_nodelay;
4187 qapi_copy_SocketAddress(&s->addr, sock->addr);
4189 chr->opaque = s;
4190 chr->chr_write = tcp_chr_write;
4191 chr->chr_sync_read = tcp_chr_sync_read;
4192 chr->chr_close = tcp_chr_close;
4193 chr->get_msgfds = tcp_get_msgfds;
4194 chr->set_msgfds = tcp_set_msgfds;
4195 chr->chr_add_client = tcp_chr_add_client;
4196 chr->chr_add_watch = tcp_chr_add_watch;
4197 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4198 /* be isn't opened until we get a connection */
4199 chr->explicit_be_open = true;
4201 chr->filename = g_malloc(CHR_MAX_FILENAME_SIZE);
4202 SocketAddress_to_str(chr->filename, CHR_MAX_FILENAME_SIZE, "disconnected:",
4203 addr, is_listen, is_telnet);
4205 if (is_listen) {
4206 if (is_telnet) {
4207 s->do_telnetopt = 1;
4209 } else if (reconnect > 0) {
4210 s->reconnect_time = reconnect;
4213 if (s->reconnect_time) {
4214 socket_try_connect(chr);
4215 } else if (!qemu_chr_open_socket_fd(chr, errp)) {
4216 g_free(s);
4217 g_free(chr->filename);
4218 g_free(chr);
4219 return NULL;
4222 if (is_listen && is_waitconnect) {
4223 fprintf(stderr, "QEMU waiting for connection on: %s\n",
4224 chr->filename);
4225 tcp_chr_accept(s->listen_chan, G_IO_IN, chr);
4226 qemu_set_nonblock(s->listen_fd);
4229 return chr;
4232 static CharDriverState *qmp_chardev_open_udp(const char *id,
4233 ChardevBackend *backend,
4234 ChardevReturn *ret,
4235 Error **errp)
4237 ChardevUdp *udp = backend->udp;
4238 int fd;
4240 fd = socket_dgram(udp->remote, udp->local, errp);
4241 if (fd < 0) {
4242 return NULL;
4244 return qemu_chr_open_udp_fd(fd);
4247 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4248 Error **errp)
4250 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4251 CharDriverState *base, *chr = NULL;
4252 Error *local_err = NULL;
4253 GSList *i;
4254 CharDriver *cd;
4256 chr = qemu_chr_find(id);
4257 if (chr) {
4258 error_setg(errp, "Chardev '%s' already exists", id);
4259 g_free(ret);
4260 return NULL;
4263 for (i = backends; i; i = i->next) {
4264 cd = i->data;
4266 if (cd->kind == backend->kind && cd->create) {
4267 chr = cd->create(id, backend, ret, &local_err);
4268 if (local_err) {
4269 error_propagate(errp, local_err);
4270 goto out_error;
4272 break;
4276 if (chr == NULL) {
4277 switch (backend->kind) {
4278 case CHARDEV_BACKEND_KIND_FILE:
4279 abort();
4280 break;
4281 case CHARDEV_BACKEND_KIND_SERIAL:
4282 abort();
4283 break;
4284 case CHARDEV_BACKEND_KIND_PARALLEL:
4285 abort();
4286 break;
4287 case CHARDEV_BACKEND_KIND_PIPE:
4288 abort();
4289 break;
4290 case CHARDEV_BACKEND_KIND_SOCKET:
4291 abort();
4292 break;
4293 case CHARDEV_BACKEND_KIND_UDP:
4294 abort();
4295 break;
4296 case CHARDEV_BACKEND_KIND_PTY:
4297 abort();
4298 break;
4299 case CHARDEV_BACKEND_KIND_NULL:
4300 abort();
4301 break;
4302 case CHARDEV_BACKEND_KIND_MUX:
4303 base = qemu_chr_find(backend->mux->chardev);
4304 if (base == NULL) {
4305 error_setg(&local_err, "mux: base chardev %s not found",
4306 backend->mux->chardev);
4307 break;
4309 chr = qemu_chr_open_mux(base);
4310 break;
4311 case CHARDEV_BACKEND_KIND_MSMOUSE:
4312 chr = qemu_chr_open_msmouse();
4313 break;
4314 #ifdef CONFIG_BRLAPI
4315 case CHARDEV_BACKEND_KIND_BRAILLE:
4316 chr = chr_baum_init();
4317 break;
4318 #endif
4319 case CHARDEV_BACKEND_KIND_TESTDEV:
4320 chr = chr_testdev_init();
4321 break;
4322 case CHARDEV_BACKEND_KIND_STDIO:
4323 chr = qemu_chr_open_stdio(backend->stdio);
4324 break;
4325 #ifdef _WIN32
4326 case CHARDEV_BACKEND_KIND_CONSOLE:
4327 chr = qemu_chr_open_win_con();
4328 break;
4329 #endif
4330 #ifdef CONFIG_SPICE
4331 case CHARDEV_BACKEND_KIND_SPICEVMC:
4332 chr = qemu_chr_open_spice_vmc(backend->spicevmc->type);
4333 break;
4334 case CHARDEV_BACKEND_KIND_SPICEPORT:
4335 chr = qemu_chr_open_spice_port(backend->spiceport->fqdn);
4336 break;
4337 #endif
4338 case CHARDEV_BACKEND_KIND_VC:
4339 chr = vc_init(backend->vc);
4340 break;
4341 case CHARDEV_BACKEND_KIND_RINGBUF:
4342 case CHARDEV_BACKEND_KIND_MEMORY:
4343 chr = qemu_chr_open_ringbuf(backend->ringbuf, &local_err);
4344 break;
4345 default:
4346 error_setg(errp, "unknown chardev backend (%d)", backend->kind);
4347 goto out_error;
4351 * Character backend open hasn't been fully converted to the Error
4352 * API. Some opens fail without setting an error. Set a generic
4353 * error then.
4354 * TODO full conversion to Error API
4356 if (chr == NULL) {
4357 if (local_err) {
4358 error_propagate(errp, local_err);
4359 } else {
4360 error_setg(errp, "Failed to create chardev");
4362 goto out_error;
4366 chr->label = g_strdup(id);
4367 chr->avail_connections =
4368 (backend->kind == CHARDEV_BACKEND_KIND_MUX) ? MAX_MUX : 1;
4369 if (!chr->filename) {
4370 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->kind]);
4372 if (!chr->explicit_be_open) {
4373 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4375 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4376 return ret;
4378 out_error:
4379 g_free(ret);
4380 return NULL;
4383 void qmp_chardev_remove(const char *id, Error **errp)
4385 CharDriverState *chr;
4387 chr = qemu_chr_find(id);
4388 if (chr == NULL) {
4389 error_setg(errp, "Chardev '%s' not found", id);
4390 return;
4392 if (chr->chr_can_read || chr->chr_read ||
4393 chr->chr_event || chr->handler_opaque) {
4394 error_setg(errp, "Chardev '%s' is busy", id);
4395 return;
4397 qemu_chr_delete(chr);
4400 static void register_types(void)
4402 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4403 qemu_chr_open_null);
4404 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4405 qemu_chr_parse_socket, qmp_chardev_open_socket);
4406 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4407 qmp_chardev_open_udp);
4408 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4409 qemu_chr_parse_ringbuf, NULL);
4410 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4411 qemu_chr_parse_file_out, qmp_chardev_open_file);
4412 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4413 qemu_chr_parse_stdio, NULL);
4414 #if defined HAVE_CHARDEV_SERIAL
4415 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4416 qemu_chr_parse_serial, qmp_chardev_open_serial);
4417 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4418 qemu_chr_parse_serial, qmp_chardev_open_serial);
4419 #endif
4420 #ifdef HAVE_CHARDEV_PARPORT
4421 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4422 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4423 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4424 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4425 #endif
4426 #ifdef HAVE_CHARDEV_PTY
4427 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4428 qemu_chr_open_pty);
4429 #endif
4430 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4431 NULL);
4432 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4433 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4434 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4435 NULL);
4436 /* Bug-compatibility: */
4437 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4438 qemu_chr_parse_ringbuf, NULL);
4439 /* this must be done after machine init, since we register FEs with muxes
4440 * as part of realize functions like serial_isa_realizefn when -nographic
4441 * is specified
4443 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4446 type_init(register_types);