]> git.proxmox.com Git - mirror_qemu.git/blob - qemu-char.c
projects / mirror_qemu.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
char: use common error path in qmp_chardev_add
[mirror_qemu.git] / qemu-char.c
1 /*
2 * QEMU System Emulator
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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.
23 */
24 #include "qemu/osdep.h"
25 #include "qemu-common.h"
26 #include "qemu/cutils.h"
27 #include "monitor/monitor.h"
28 #include "sysemu/sysemu.h"
29 #include "sysemu/block-backend.h"
30 #include "qemu/error-report.h"
31 #include "qemu/timer.h"
32 #include "sysemu/char.h"
33 #include "hw/usb.h"
34 #include "qmp-commands.h"
35 #include "qapi/clone-visitor.h"
36 #include "qapi-visit.h"
37 #include "qemu/base64.h"
38 #include "io/channel-socket.h"
39 #include "io/channel-file.h"
40 #include "io/channel-tls.h"
41 #include "sysemu/replay.h"
42 #include "qemu/help_option.h"
43
44 #include <zlib.h>
45
46 #ifndef _WIN32
47 #include <sys/times.h>
48 #include <sys/wait.h>
49 #include <termios.h>
50 #include <sys/ioctl.h>
51 #include <sys/resource.h>
52 #include <sys/socket.h>
53 #include <netinet/in.h>
54 #include <net/if.h>
55 #include <arpa/inet.h>
56 #include <netdb.h>
57 #include <sys/select.h>
58 #ifdef CONFIG_BSD
59 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
60 #include <dev/ppbus/ppi.h>
61 #include <dev/ppbus/ppbconf.h>
62 #elif defined(__DragonFly__)
63 #include <dev/misc/ppi/ppi.h>
64 #include <bus/ppbus/ppbconf.h>
65 #endif
66 #else
67 #ifdef __linux__
68 #include <linux/ppdev.h>
69 #include <linux/parport.h>
70 #endif
71 #ifdef __sun__
72 #include <sys/ethernet.h>
73 #include <sys/sockio.h>
74 #include <netinet/arp.h>
75 #include <netinet/in.h>
76 #include <netinet/in_systm.h>
77 #include <netinet/ip.h>
78 #include <netinet/ip_icmp.h> // must come after ip.h
79 #include <netinet/udp.h>
80 #include <netinet/tcp.h>
81 #endif
82 #endif
83 #endif
84
85 #include "qemu/sockets.h"
86 #include "ui/qemu-spice.h"
87
88 #define READ_BUF_LEN 4096
89 #define READ_RETRIES 10
90 #define TCP_MAX_FDS 16
91
92 typedef struct MuxDriver MuxDriver;
93
94 /***********************************************************/
95 /* Socket address helpers */
96
97 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
98 bool is_listen, bool is_telnet)
99 {
100 switch (addr->type) {
101 case SOCKET_ADDRESS_KIND_INET:
102 return g_strdup_printf("%s%s:%s:%s%s", prefix,
103 is_telnet ? "telnet" : "tcp",
104 addr->u.inet.data->host,
105 addr->u.inet.data->port,
106 is_listen ? ",server" : "");
107 break;
108 case SOCKET_ADDRESS_KIND_UNIX:
109 return g_strdup_printf("%sunix:%s%s", prefix,
110 addr->u.q_unix.data->path,
111 is_listen ? ",server" : "");
112 break;
113 case SOCKET_ADDRESS_KIND_FD:
114 return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.data->str,
115 is_listen ? ",server" : "");
116 break;
117 default:
118 abort();
119 }
120 }
121
122 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
123 struct sockaddr_storage *ps, socklen_t ps_len,
124 bool is_listen, bool is_telnet)
125 {
126 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
127 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
128 const char *left = "", *right = "";
129
130 switch (ss->ss_family) {
131 #ifndef _WIN32
132 case AF_UNIX:
133 return g_strdup_printf("unix:%s%s",
134 ((struct sockaddr_un *)(ss))->sun_path,
135 is_listen ? ",server" : "");
136 #endif
137 case AF_INET6:
138 left = "[";
139 right = "]";
140 /* fall through */
141 case AF_INET:
142 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
143 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
144 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
145 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
146 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
147 is_telnet ? "telnet" : "tcp",
148 left, shost, right, sserv,
149 is_listen ? ",server" : "",
150 left, phost, right, pserv);
151
152 default:
153 return g_strdup_printf("unknown");
154 }
155 }
156
157 /***********************************************************/
158 /* character device */
159
160 static QTAILQ_HEAD(CharDriverStateHead, CharDriverState) chardevs =
161 QTAILQ_HEAD_INITIALIZER(chardevs);
162
163 static void qemu_chr_free_common(CharDriverState *chr);
164
165 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp)
166 {
167 CharDriverState *chr = g_malloc0(sizeof(CharDriverState));
168 qemu_mutex_init(&chr->chr_write_lock);
169
170 if (backend->has_logfile) {
171 int flags = O_WRONLY | O_CREAT;
172 if (backend->has_logappend &&
173 backend->logappend) {
174 flags |= O_APPEND;
175 } else {
176 flags |= O_TRUNC;
177 }
178 chr->logfd = qemu_open(backend->logfile, flags, 0666);
179 if (chr->logfd < 0) {
180 error_setg_errno(errp, errno,
181 "Unable to open logfile %s",
182 backend->logfile);
183 g_free(chr);
184 return NULL;
185 }
186 } else {
187 chr->logfd = -1;
188 }
189
190 return chr;
191 }
192
193 void qemu_chr_be_event(CharDriverState *s, int event)
194 {
195 CharBackend *be = s->be;
196
197 /* Keep track if the char device is open */
198 switch (event) {
199 case CHR_EVENT_OPENED:
200 s->be_open = 1;
201 break;
202 case CHR_EVENT_CLOSED:
203 s->be_open = 0;
204 break;
205 }
206
207 if (!be || !be->chr_event) {
208 return;
209 }
210
211 be->chr_event(be->opaque, event);
212 }
213
214 void qemu_chr_be_generic_open(CharDriverState *s)
215 {
216 qemu_chr_be_event(s, CHR_EVENT_OPENED);
217 }
218
219
220 /* Not reporting errors from writing to logfile, as logs are
221 * defined to be "best effort" only */
222 static void qemu_chr_fe_write_log(CharDriverState *s,
223 const uint8_t *buf, size_t len)
224 {
225 size_t done = 0;
226 ssize_t ret;
227
228 if (s->logfd < 0) {
229 return;
230 }
231
232 while (done < len) {
233 retry:
234 ret = write(s->logfd, buf + done, len - done);
235 if (ret == -1 && errno == EAGAIN) {
236 g_usleep(100);
237 goto retry;
238 }
239
240 if (ret <= 0) {
241 return;
242 }
243 done += ret;
244 }
245 }
246
247 static int qemu_chr_fe_write_buffer(CharDriverState *s, const uint8_t *buf, int len, int *offset)
248 {
249 int res = 0;
250 *offset = 0;
251
252 qemu_mutex_lock(&s->chr_write_lock);
253 while (*offset < len) {
254 retry:
255 res = s->chr_write(s, buf + *offset, len - *offset);
256 if (res < 0 && errno == EAGAIN) {
257 g_usleep(100);
258 goto retry;
259 }
260
261 if (res <= 0) {
262 break;
263 }
264
265 *offset += res;
266 }
267 if (*offset > 0) {
268 qemu_chr_fe_write_log(s, buf, *offset);
269 }
270 qemu_mutex_unlock(&s->chr_write_lock);
271
272 return res;
273 }
274
275 int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len)
276 {
277 CharDriverState *s = be->chr;
278 int ret;
279
280 if (!s) {
281 return 0;
282 }
283
284 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
285 int offset;
286 replay_char_write_event_load(&ret, &offset);
287 assert(offset <= len);
288 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
289 return ret;
290 }
291
292 qemu_mutex_lock(&s->chr_write_lock);
293 ret = s->chr_write(s, buf, len);
294
295 if (ret > 0) {
296 qemu_chr_fe_write_log(s, buf, ret);
297 }
298
299 qemu_mutex_unlock(&s->chr_write_lock);
300
301 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
302 replay_char_write_event_save(ret, ret < 0 ? 0 : ret);
303 }
304
305 return ret;
306 }
307
308 static int qemu_chr_write_all(CharDriverState *s, const uint8_t *buf, int len)
309 {
310 int offset;
311 int res;
312
313 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
314 replay_char_write_event_load(&res, &offset);
315 assert(offset <= len);
316 qemu_chr_fe_write_buffer(s, buf, offset, &offset);
317 return res;
318 }
319
320 res = qemu_chr_fe_write_buffer(s, buf, len, &offset);
321
322 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
323 replay_char_write_event_save(res, offset);
324 }
325
326 if (res < 0) {
327 return res;
328 }
329 return offset;
330 }
331
332 int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len)
333 {
334 CharDriverState *s = be->chr;
335
336 if (!s) {
337 return 0;
338 }
339
340 return qemu_chr_write_all(s, buf, len);
341 }
342
343 int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len)
344 {
345 CharDriverState *s = be->chr;
346 int offset = 0, counter = 10;
347 int res;
348
349 if (!s || !s->chr_sync_read) {
350 return 0;
351 }
352
353 if (s->replay && replay_mode == REPLAY_MODE_PLAY) {
354 return replay_char_read_all_load(buf);
355 }
356
357 while (offset < len) {
358 retry:
359 res = s->chr_sync_read(s, buf + offset, len - offset);
360 if (res == -1 && errno == EAGAIN) {
361 g_usleep(100);
362 goto retry;
363 }
364
365 if (res == 0) {
366 break;
367 }
368
369 if (res < 0) {
370 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
371 replay_char_read_all_save_error(res);
372 }
373 return res;
374 }
375
376 offset += res;
377
378 if (!counter--) {
379 break;
380 }
381 }
382
383 if (s->replay && replay_mode == REPLAY_MODE_RECORD) {
384 replay_char_read_all_save_buf(buf, offset);
385 }
386 return offset;
387 }
388
389 int qemu_chr_fe_ioctl(CharBackend *be, int cmd, void *arg)
390 {
391 CharDriverState *s = be->chr;
392 int res;
393
394 if (!s || !s->chr_ioctl || s->replay) {
395 res = -ENOTSUP;
396 } else {
397 res = s->chr_ioctl(s, cmd, arg);
398 }
399
400 return res;
401 }
402
403 int qemu_chr_be_can_write(CharDriverState *s)
404 {
405 CharBackend *be = s->be;
406
407 if (!be || !be->chr_can_read) {
408 return 0;
409 }
410
411 return be->chr_can_read(be->opaque);
412 }
413
414 void qemu_chr_be_write_impl(CharDriverState *s, uint8_t *buf, int len)
415 {
416 CharBackend *be = s->be;
417
418 if (be && be->chr_read) {
419 be->chr_read(be->opaque, buf, len);
420 }
421 }
422
423 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len)
424 {
425 if (s->replay) {
426 if (replay_mode == REPLAY_MODE_PLAY) {
427 return;
428 }
429 replay_chr_be_write(s, buf, len);
430 } else {
431 qemu_chr_be_write_impl(s, buf, len);
432 }
433 }
434
435 int qemu_chr_fe_get_msgfd(CharBackend *be)
436 {
437 CharDriverState *s = be->chr;
438 int fd;
439 int res = (qemu_chr_fe_get_msgfds(be, &fd, 1) == 1) ? fd : -1;
440 if (s && s->replay) {
441 fprintf(stderr,
442 "Replay: get msgfd is not supported for serial devices yet\n");
443 exit(1);
444 }
445 return res;
446 }
447
448 int qemu_chr_fe_get_msgfds(CharBackend *be, int *fds, int len)
449 {
450 CharDriverState *s = be->chr;
451
452 if (!s) {
453 return -1;
454 }
455
456 return s->get_msgfds ? s->get_msgfds(s, fds, len) : -1;
457 }
458
459 int qemu_chr_fe_set_msgfds(CharBackend *be, int *fds, int num)
460 {
461 CharDriverState *s = be->chr;
462
463 if (!s) {
464 return -1;
465 }
466
467 return s->set_msgfds ? s->set_msgfds(s, fds, num) : -1;
468 }
469
470 int qemu_chr_add_client(CharDriverState *s, int fd)
471 {
472 return s->chr_add_client ? s->chr_add_client(s, fd) : -1;
473 }
474
475 void qemu_chr_fe_accept_input(CharBackend *be)
476 {
477 CharDriverState *s = be->chr;
478
479 if (!s) {
480 return;
481 }
482
483 if (s->chr_accept_input)
484 s->chr_accept_input(s);
485 qemu_notify_event();
486 }
487
488 void qemu_chr_fe_printf(CharBackend *be, const char *fmt, ...)
489 {
490 char buf[READ_BUF_LEN];
491 va_list ap;
492 va_start(ap, fmt);
493 vsnprintf(buf, sizeof(buf), fmt, ap);
494 /* XXX this blocks entire thread. Rewrite to use
495 * qemu_chr_fe_write and background I/O callbacks */
496 qemu_chr_fe_write_all(be, (uint8_t *)buf, strlen(buf));
497 va_end(ap);
498 }
499
500 static void remove_fd_in_watch(CharDriverState *chr);
501 static void mux_chr_set_handlers(CharDriverState *chr, GMainContext *context);
502 static void mux_set_focus(MuxDriver *d, int focus);
503
504 static int null_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
505 {
506 return len;
507 }
508
509 static CharDriverState *qemu_chr_open_null(const char *id,
510 ChardevBackend *backend,
511 ChardevReturn *ret,
512 Error **errp)
513 {
514 CharDriverState *chr;
515 ChardevCommon *common = backend->u.null.data;
516
517 chr = qemu_chr_alloc(common, errp);
518 if (!chr) {
519 return NULL;
520 }
521 chr->chr_write = null_chr_write;
522 chr->explicit_be_open = true;
523 return chr;
524 }
525
526 /* MUX driver for serial I/O splitting */
527 #define MAX_MUX 4
528 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2. */
529 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
530 struct MuxDriver {
531 CharBackend *backends[MAX_MUX];
532 CharBackend chr;
533 int focus;
534 int mux_cnt;
535 int term_got_escape;
536 int max_size;
537 /* Intermediate input buffer allows to catch escape sequences even if the
538 currently active device is not accepting any input - but only until it
539 is full as well. */
540 unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
541 int prod[MAX_MUX];
542 int cons[MAX_MUX];
543 int timestamps;
544
545 /* Protected by the CharDriverState chr_write_lock. */
546 int linestart;
547 int64_t timestamps_start;
548 };
549
550 /* Called with chr_write_lock held. */
551 static int mux_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
552 {
553 MuxDriver *d = chr->opaque;
554 int ret;
555 if (!d->timestamps) {
556 ret = qemu_chr_fe_write(&d->chr, buf, len);
557 } else {
558 int i;
559
560 ret = 0;
561 for (i = 0; i < len; i++) {
562 if (d->linestart) {
563 char buf1[64];
564 int64_t ti;
565 int secs;
566
567 ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
568 if (d->timestamps_start == -1)
569 d->timestamps_start = ti;
570 ti -= d->timestamps_start;
571 secs = ti / 1000;
572 snprintf(buf1, sizeof(buf1),
573 "[%02d:%02d:%02d.%03d] ",
574 secs / 3600,
575 (secs / 60) % 60,
576 secs % 60,
577 (int)(ti % 1000));
578 /* XXX this blocks entire thread. Rewrite to use
579 * qemu_chr_fe_write and background I/O callbacks */
580 qemu_chr_fe_write_all(&d->chr,
581 (uint8_t *)buf1, strlen(buf1));
582 d->linestart = 0;
583 }
584 ret += qemu_chr_fe_write(&d->chr, buf + i, 1);
585 if (buf[i] == '\n') {
586 d->linestart = 1;
587 }
588 }
589 }
590 return ret;
591 }
592
593 static const char * const mux_help[] = {
594 "% h print this help\n\r",
595 "% x exit emulator\n\r",
596 "% s save disk data back to file (if -snapshot)\n\r",
597 "% t toggle console timestamps\n\r",
598 "% b send break (magic sysrq)\n\r",
599 "% c switch between console and monitor\n\r",
600 "% % sends %\n\r",
601 NULL
602 };
603
604 int term_escape_char = 0x01; /* ctrl-a is used for escape */
605 static void mux_print_help(CharDriverState *chr)
606 {
607 int i, j;
608 char ebuf[15] = "Escape-Char";
609 char cbuf[50] = "\n\r";
610
611 if (term_escape_char > 0 && term_escape_char < 26) {
612 snprintf(cbuf, sizeof(cbuf), "\n\r");
613 snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
614 } else {
615 snprintf(cbuf, sizeof(cbuf),
616 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
617 term_escape_char);
618 }
619 /* XXX this blocks entire thread. Rewrite to use
620 * qemu_chr_fe_write and background I/O callbacks */
621 qemu_chr_write_all(chr, (uint8_t *)cbuf, strlen(cbuf));
622 for (i = 0; mux_help[i] != NULL; i++) {
623 for (j=0; mux_help[i][j] != '\0'; j++) {
624 if (mux_help[i][j] == '%')
625 qemu_chr_write_all(chr, (uint8_t *)ebuf, strlen(ebuf));
626 else
627 qemu_chr_write_all(chr, (uint8_t *)&mux_help[i][j], 1);
628 }
629 }
630 }
631
632 static void mux_chr_send_event(MuxDriver *d, int mux_nr, int event)
633 {
634 CharBackend *be = d->backends[mux_nr];
635
636 if (be && be->chr_event) {
637 be->chr_event(be->opaque, event);
638 }
639 }
640
641 static int mux_proc_byte(CharDriverState *chr, MuxDriver *d, int ch)
642 {
643 if (d->term_got_escape) {
644 d->term_got_escape = 0;
645 if (ch == term_escape_char)
646 goto send_char;
647 switch(ch) {
648 case '?':
649 case 'h':
650 mux_print_help(chr);
651 break;
652 case 'x':
653 {
654 const char *term = "QEMU: Terminated\n\r";
655 qemu_chr_write_all(chr, (uint8_t *)term, strlen(term));
656 exit(0);
657 break;
658 }
659 case 's':
660 blk_commit_all();
661 break;
662 case 'b':
663 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
664 break;
665 case 'c':
666 assert(d->mux_cnt > 0); /* handler registered with first fe */
667 /* Switch to the next registered device */
668 mux_set_focus(d, (d->focus + 1) % d->mux_cnt);
669 break;
670 case 't':
671 d->timestamps = !d->timestamps;
672 d->timestamps_start = -1;
673 d->linestart = 0;
674 break;
675 }
676 } else if (ch == term_escape_char) {
677 d->term_got_escape = 1;
678 } else {
679 send_char:
680 return 1;
681 }
682 return 0;
683 }
684
685 static void mux_chr_accept_input(CharDriverState *chr)
686 {
687 MuxDriver *d = chr->opaque;
688 int m = d->focus;
689 CharBackend *be = d->backends[m];
690
691 while (be && d->prod[m] != d->cons[m] &&
692 be->chr_can_read && be->chr_can_read(be->opaque)) {
693 be->chr_read(be->opaque,
694 &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
695 }
696 }
697
698 static int mux_chr_can_read(void *opaque)
699 {
700 CharDriverState *chr = opaque;
701 MuxDriver *d = chr->opaque;
702 int m = d->focus;
703 CharBackend *be = d->backends[m];
704
705 if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE) {
706 return 1;
707 }
708
709 if (be && be->chr_can_read) {
710 return be->chr_can_read(be->opaque);
711 }
712
713 return 0;
714 }
715
716 static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
717 {
718 CharDriverState *chr = opaque;
719 MuxDriver *d = chr->opaque;
720 int m = d->focus;
721 CharBackend *be = d->backends[m];
722 int i;
723
724 mux_chr_accept_input(opaque);
725
726 for (i = 0; i < size; i++)
727 if (mux_proc_byte(chr, d, buf[i])) {
728 if (d->prod[m] == d->cons[m] &&
729 be && be->chr_can_read &&
730 be->chr_can_read(be->opaque))
731 be->chr_read(be->opaque, &buf[i], 1);
732 else
733 d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
734 }
735 }
736
737 static void mux_chr_event(void *opaque, int event)
738 {
739 CharDriverState *chr = opaque;
740 MuxDriver *d = chr->opaque;
741 int i;
742
743 /* Send the event to all registered listeners */
744 for (i = 0; i < d->mux_cnt; i++)
745 mux_chr_send_event(d, i, event);
746 }
747
748 static bool muxes_realized;
749
750 /**
751 * Called after processing of default and command-line-specified
752 * chardevs to deliver CHR_EVENT_OPENED events to any FEs attached
753 * to a mux chardev. This is done here to ensure that
754 * output/prompts/banners are only displayed for the FE that has
755 * focus when initial command-line processing/machine init is
756 * completed.
757 *
758 * After this point, any new FE attached to any new or existing
759 * mux will receive CHR_EVENT_OPENED notifications for the BE
760 * immediately.
761 */
762 static void muxes_realize_done(Notifier *notifier, void *unused)
763 {
764 CharDriverState *chr;
765
766 QTAILQ_FOREACH(chr, &chardevs, next) {
767 if (chr->is_mux) {
768 MuxDriver *d = chr->opaque;
769 int i;
770
771 /* send OPENED to all already-attached FEs */
772 for (i = 0; i < d->mux_cnt; i++) {
773 mux_chr_send_event(d, i, CHR_EVENT_OPENED);
774 }
775 /* mark mux as OPENED so any new FEs will immediately receive
776 * OPENED event
777 */
778 qemu_chr_be_generic_open(chr);
779 }
780 }
781 muxes_realized = true;
782 }
783
784 static Notifier muxes_realize_notify = {
785 .notify = muxes_realize_done,
786 };
787
788 static GSource *mux_chr_add_watch(CharDriverState *s, GIOCondition cond)
789 {
790 MuxDriver *d = s->opaque;
791 CharDriverState *chr = qemu_chr_fe_get_driver(&d->chr);
792
793 return chr->chr_add_watch(chr, cond);
794 }
795
796 static void mux_chr_free(struct CharDriverState *chr)
797 {
798 MuxDriver *d = chr->opaque;
799 int i;
800
801 for (i = 0; i < d->mux_cnt; i++) {
802 CharBackend *be = d->backends[i];
803 if (be) {
804 be->chr = NULL;
805 }
806 }
807 qemu_chr_fe_deinit(&d->chr);
808 g_free(d);
809 }
810
811 static void mux_chr_set_handlers(CharDriverState *chr, GMainContext *context)
812 {
813 MuxDriver *d = chr->opaque;
814
815 /* Fix up the real driver with mux routines */
816 qemu_chr_fe_set_handlers(&d->chr,
817 mux_chr_can_read,
818 mux_chr_read,
819 mux_chr_event,
820 chr,
821 context, true);
822 }
823
824 static void mux_set_focus(MuxDriver *d, int focus)
825 {
826 assert(focus >= 0);
827 assert(focus < d->mux_cnt);
828
829 if (d->focus != -1) {
830 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
831 }
832
833 d->focus = focus;
834 mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
835 }
836
837 static CharDriverState *qemu_chr_open_mux(const char *id,
838 ChardevBackend *backend,
839 ChardevReturn *ret, Error **errp)
840 {
841 ChardevMux *mux = backend->u.mux.data;
842 CharDriverState *chr, *drv;
843 MuxDriver *d;
844 ChardevCommon *common = qapi_ChardevMux_base(mux);
845
846 drv = qemu_chr_find(mux->chardev);
847 if (drv == NULL) {
848 error_setg(errp, "mux: base chardev %s not found", mux->chardev);
849 return NULL;
850 }
851
852 chr = qemu_chr_alloc(common, errp);
853 if (!chr) {
854 return NULL;
855 }
856 d = g_new0(MuxDriver, 1);
857
858 chr->opaque = d;
859 d->focus = -1;
860 chr->chr_free = mux_chr_free;
861 chr->chr_write = mux_chr_write;
862 chr->chr_accept_input = mux_chr_accept_input;
863 /* Frontend guest-open / -close notification is not support with muxes */
864 chr->chr_set_fe_open = NULL;
865 if (drv->chr_add_watch) {
866 chr->chr_add_watch = mux_chr_add_watch;
867 }
868 /* only default to opened state if we've realized the initial
869 * set of muxes
870 */
871 chr->explicit_be_open = muxes_realized ? 0 : 1;
872 chr->is_mux = 1;
873 if (!qemu_chr_fe_init(&d->chr, drv, errp)) {
874 qemu_chr_free(chr);
875 return NULL;
876 }
877
878 return chr;
879 }
880
881 CharDriverState *qemu_chr_fe_get_driver(CharBackend *be)
882 {
883 return be->chr;
884 }
885
886 bool qemu_chr_fe_init(CharBackend *b, CharDriverState *s, Error **errp)
887 {
888 int tag = 0;
889
890 if (s->is_mux) {
891 MuxDriver *d = s->opaque;
892
893 if (d->mux_cnt >= MAX_MUX) {
894 goto unavailable;
895 }
896
897 d->backends[d->mux_cnt] = b;
898 tag = d->mux_cnt++;
899 } else if (s->be) {
900 goto unavailable;
901 } else {
902 s->be = b;
903 }
904
905 b->fe_open = false;
906 b->tag = tag;
907 b->chr = s;
908 return true;
909
910 unavailable:
911 error_setg(errp, QERR_DEVICE_IN_USE, s->label);
912 return false;
913 }
914
915 static bool qemu_chr_is_busy(CharDriverState *s)
916 {
917 if (s->is_mux) {
918 MuxDriver *d = s->opaque;
919 return d->mux_cnt >= 0;
920 } else {
921 return s->be != NULL;
922 }
923 }
924
925 void qemu_chr_fe_deinit(CharBackend *b)
926 {
927 assert(b);
928
929 if (b->chr) {
930 qemu_chr_fe_set_handlers(b, NULL, NULL, NULL, NULL, NULL, true);
931 b->chr->be = NULL;
932 if (b->chr->is_mux) {
933 MuxDriver *d = b->chr->opaque;
934 d->backends[b->tag] = NULL;
935 }
936 b->chr = NULL;
937 }
938 }
939
940 void qemu_chr_fe_set_handlers(CharBackend *b,
941 IOCanReadHandler *fd_can_read,
942 IOReadHandler *fd_read,
943 IOEventHandler *fd_event,
944 void *opaque,
945 GMainContext *context,
946 bool set_open)
947 {
948 CharDriverState *s;
949 int fe_open;
950
951 s = b->chr;
952 if (!s) {
953 return;
954 }
955
956 if (!opaque && !fd_can_read && !fd_read && !fd_event) {
957 fe_open = 0;
958 remove_fd_in_watch(s);
959 } else {
960 fe_open = 1;
961 }
962 b->chr_can_read = fd_can_read;
963 b->chr_read = fd_read;
964 b->chr_event = fd_event;
965 b->opaque = opaque;
966 if (s->chr_update_read_handler) {
967 s->chr_update_read_handler(s, context);
968 }
969
970 if (set_open) {
971 qemu_chr_fe_set_open(b, fe_open);
972 }
973
974 if (fe_open) {
975 qemu_chr_fe_take_focus(b);
976 /* We're connecting to an already opened device, so let's make sure we
977 also get the open event */
978 if (s->be_open) {
979 qemu_chr_be_generic_open(s);
980 }
981 }
982
983 if (s->is_mux) {
984 mux_chr_set_handlers(s, context);
985 }
986 }
987
988 void qemu_chr_fe_take_focus(CharBackend *b)
989 {
990 if (!b->chr) {
991 return;
992 }
993
994 if (b->chr->is_mux) {
995 mux_set_focus(b->chr->opaque, b->tag);
996 }
997 }
998
999 typedef struct IOWatchPoll
1000 {
1001 GSource parent;
1002
1003 QIOChannel *ioc;
1004 GSource *src;
1005
1006 IOCanReadHandler *fd_can_read;
1007 GSourceFunc fd_read;
1008 void *opaque;
1009 GMainContext *context;
1010 } IOWatchPoll;
1011
1012 static IOWatchPoll *io_watch_poll_from_source(GSource *source)
1013 {
1014 return container_of(source, IOWatchPoll, parent);
1015 }
1016
1017 static gboolean io_watch_poll_prepare(GSource *source,
1018 gint *timeout_)
1019 {
1020 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1021 bool now_active = iwp->fd_can_read(iwp->opaque) > 0;
1022 bool was_active = iwp->src != NULL;
1023 if (was_active == now_active) {
1024 return FALSE;
1025 }
1026
1027 if (now_active) {
1028 iwp->src = qio_channel_create_watch(
1029 iwp->ioc, G_IO_IN | G_IO_ERR | G_IO_HUP | G_IO_NVAL);
1030 g_source_set_callback(iwp->src, iwp->fd_read, iwp->opaque, NULL);
1031 g_source_attach(iwp->src, iwp->context);
1032 } else {
1033 g_source_destroy(iwp->src);
1034 g_source_unref(iwp->src);
1035 iwp->src = NULL;
1036 }
1037 return FALSE;
1038 }
1039
1040 static gboolean io_watch_poll_check(GSource *source)
1041 {
1042 return FALSE;
1043 }
1044
1045 static gboolean io_watch_poll_dispatch(GSource *source, GSourceFunc callback,
1046 gpointer user_data)
1047 {
1048 abort();
1049 }
1050
1051 static void io_watch_poll_finalize(GSource *source)
1052 {
1053 /* Due to a glib bug, removing the last reference to a source
1054 * inside a finalize callback causes recursive locking (and a
1055 * deadlock). This is not a problem inside other callbacks,
1056 * including dispatch callbacks, so we call io_remove_watch_poll
1057 * to remove this source. At this point, iwp->src must
1058 * be NULL, or we would leak it.
1059 *
1060 * This would be solved much more elegantly by child sources,
1061 * but we support older glib versions that do not have them.
1062 */
1063 IOWatchPoll *iwp = io_watch_poll_from_source(source);
1064 assert(iwp->src == NULL);
1065 }
1066
1067 static GSourceFuncs io_watch_poll_funcs = {
1068 .prepare = io_watch_poll_prepare,
1069 .check = io_watch_poll_check,
1070 .dispatch = io_watch_poll_dispatch,
1071 .finalize = io_watch_poll_finalize,
1072 };
1073
1074 /* Can only be used for read */
1075 static guint io_add_watch_poll(QIOChannel *ioc,
1076 IOCanReadHandler *fd_can_read,
1077 QIOChannelFunc fd_read,
1078 gpointer user_data,
1079 GMainContext *context)
1080 {
1081 IOWatchPoll *iwp;
1082 int tag;
1083
1084 iwp = (IOWatchPoll *) g_source_new(&io_watch_poll_funcs,
1085 sizeof(IOWatchPoll));
1086 iwp->fd_can_read = fd_can_read;
1087 iwp->opaque = user_data;
1088 iwp->ioc = ioc;
1089 iwp->fd_read = (GSourceFunc) fd_read;
1090 iwp->src = NULL;
1091 iwp->context = context;
1092
1093 tag = g_source_attach(&iwp->parent, context);
1094 g_source_unref(&iwp->parent);
1095 return tag;
1096 }
1097
1098 static void io_remove_watch_poll(guint tag)
1099 {
1100 GSource *source;
1101 IOWatchPoll *iwp;
1102
1103 g_return_if_fail (tag > 0);
1104
1105 source = g_main_context_find_source_by_id(NULL, tag);
1106 g_return_if_fail (source != NULL);
1107
1108 iwp = io_watch_poll_from_source(source);
1109 if (iwp->src) {
1110 g_source_destroy(iwp->src);
1111 g_source_unref(iwp->src);
1112 iwp->src = NULL;
1113 }
1114 g_source_destroy(&iwp->parent);
1115 }
1116
1117 static void remove_fd_in_watch(CharDriverState *chr)
1118 {
1119 if (chr->fd_in_tag) {
1120 io_remove_watch_poll(chr->fd_in_tag);
1121 chr->fd_in_tag = 0;
1122 }
1123 }
1124
1125
1126 static int io_channel_send_full(QIOChannel *ioc,
1127 const void *buf, size_t len,
1128 int *fds, size_t nfds)
1129 {
1130 size_t offset = 0;
1131
1132 while (offset < len) {
1133 ssize_t ret = 0;
1134 struct iovec iov = { .iov_base = (char *)buf + offset,
1135 .iov_len = len - offset };
1136
1137 ret = qio_channel_writev_full(
1138 ioc, &iov, 1,
1139 fds, nfds, NULL);
1140 if (ret == QIO_CHANNEL_ERR_BLOCK) {
1141 if (offset) {
1142 return offset;
1143 }
1144
1145 errno = EAGAIN;
1146 return -1;
1147 } else if (ret < 0) {
1148 errno = EINVAL;
1149 return -1;
1150 }
1151
1152 offset += ret;
1153 }
1154
1155 return offset;
1156 }
1157
1158
1159 #ifndef _WIN32
1160 static int io_channel_send(QIOChannel *ioc, const void *buf, size_t len)
1161 {
1162 return io_channel_send_full(ioc, buf, len, NULL, 0);
1163 }
1164
1165
1166 typedef struct FDCharDriver {
1167 CharDriverState *chr;
1168 QIOChannel *ioc_in, *ioc_out;
1169 int max_size;
1170 } FDCharDriver;
1171
1172 /* Called with chr_write_lock held. */
1173 static int fd_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1174 {
1175 FDCharDriver *s = chr->opaque;
1176
1177 return io_channel_send(s->ioc_out, buf, len);
1178 }
1179
1180 static gboolean fd_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1181 {
1182 CharDriverState *chr = opaque;
1183 FDCharDriver *s = chr->opaque;
1184 int len;
1185 uint8_t buf[READ_BUF_LEN];
1186 ssize_t ret;
1187
1188 len = sizeof(buf);
1189 if (len > s->max_size) {
1190 len = s->max_size;
1191 }
1192 if (len == 0) {
1193 return TRUE;
1194 }
1195
1196 ret = qio_channel_read(
1197 chan, (gchar *)buf, len, NULL);
1198 if (ret == 0) {
1199 remove_fd_in_watch(chr);
1200 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1201 return FALSE;
1202 }
1203 if (ret > 0) {
1204 qemu_chr_be_write(chr, buf, ret);
1205 }
1206
1207 return TRUE;
1208 }
1209
1210 static int fd_chr_read_poll(void *opaque)
1211 {
1212 CharDriverState *chr = opaque;
1213 FDCharDriver *s = chr->opaque;
1214
1215 s->max_size = qemu_chr_be_can_write(chr);
1216 return s->max_size;
1217 }
1218
1219 static GSource *fd_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1220 {
1221 FDCharDriver *s = chr->opaque;
1222 return qio_channel_create_watch(s->ioc_out, cond);
1223 }
1224
1225 static void fd_chr_update_read_handler(CharDriverState *chr,
1226 GMainContext *context)
1227 {
1228 FDCharDriver *s = chr->opaque;
1229
1230 remove_fd_in_watch(chr);
1231 if (s->ioc_in) {
1232 chr->fd_in_tag = io_add_watch_poll(s->ioc_in,
1233 fd_chr_read_poll,
1234 fd_chr_read, chr,
1235 context);
1236 }
1237 }
1238
1239 static void fd_chr_free(struct CharDriverState *chr)
1240 {
1241 FDCharDriver *s = chr->opaque;
1242
1243 remove_fd_in_watch(chr);
1244 if (s->ioc_in) {
1245 object_unref(OBJECT(s->ioc_in));
1246 }
1247 if (s->ioc_out) {
1248 object_unref(OBJECT(s->ioc_out));
1249 }
1250
1251 g_free(s);
1252 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1253 }
1254
1255 /* open a character device to a unix fd */
1256 static CharDriverState *qemu_chr_open_fd(int fd_in, int fd_out,
1257 ChardevCommon *backend, Error **errp)
1258 {
1259 CharDriverState *chr;
1260 FDCharDriver *s;
1261
1262 chr = qemu_chr_alloc(backend, errp);
1263 if (!chr) {
1264 return NULL;
1265 }
1266 s = g_new0(FDCharDriver, 1);
1267 s->ioc_in = QIO_CHANNEL(qio_channel_file_new_fd(fd_in));
1268 s->ioc_out = QIO_CHANNEL(qio_channel_file_new_fd(fd_out));
1269 qemu_set_nonblock(fd_out);
1270 s->chr = chr;
1271 chr->opaque = s;
1272 chr->chr_add_watch = fd_chr_add_watch;
1273 chr->chr_write = fd_chr_write;
1274 chr->chr_update_read_handler = fd_chr_update_read_handler;
1275 chr->chr_free = fd_chr_free;
1276
1277 return chr;
1278 }
1279
1280 static CharDriverState *qemu_chr_open_pipe(const char *id,
1281 ChardevBackend *backend,
1282 ChardevReturn *ret,
1283 Error **errp)
1284 {
1285 ChardevHostdev *opts = backend->u.pipe.data;
1286 int fd_in, fd_out;
1287 char *filename_in;
1288 char *filename_out;
1289 const char *filename = opts->device;
1290 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
1291
1292
1293 filename_in = g_strdup_printf("%s.in", filename);
1294 filename_out = g_strdup_printf("%s.out", filename);
1295 TFR(fd_in = qemu_open(filename_in, O_RDWR | O_BINARY));
1296 TFR(fd_out = qemu_open(filename_out, O_RDWR | O_BINARY));
1297 g_free(filename_in);
1298 g_free(filename_out);
1299 if (fd_in < 0 || fd_out < 0) {
1300 if (fd_in >= 0)
1301 close(fd_in);
1302 if (fd_out >= 0)
1303 close(fd_out);
1304 TFR(fd_in = fd_out = qemu_open(filename, O_RDWR | O_BINARY));
1305 if (fd_in < 0) {
1306 error_setg_file_open(errp, errno, filename);
1307 return NULL;
1308 }
1309 }
1310 return qemu_chr_open_fd(fd_in, fd_out, common, errp);
1311 }
1312
1313 /* init terminal so that we can grab keys */
1314 static struct termios oldtty;
1315 static int old_fd0_flags;
1316 static bool stdio_in_use;
1317 static bool stdio_allow_signal;
1318 static bool stdio_echo_state;
1319
1320 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo);
1321
1322 static void term_exit(void)
1323 {
1324 tcsetattr (0, TCSANOW, &oldtty);
1325 fcntl(0, F_SETFL, old_fd0_flags);
1326 }
1327
1328 static void term_stdio_handler(int sig)
1329 {
1330 /* restore echo after resume from suspend. */
1331 qemu_chr_set_echo_stdio(NULL, stdio_echo_state);
1332 }
1333
1334 static void qemu_chr_set_echo_stdio(CharDriverState *chr, bool echo)
1335 {
1336 struct termios tty;
1337
1338 stdio_echo_state = echo;
1339 tty = oldtty;
1340 if (!echo) {
1341 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1342 |INLCR|IGNCR|ICRNL|IXON);
1343 tty.c_oflag |= OPOST;
1344 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
1345 tty.c_cflag &= ~(CSIZE|PARENB);
1346 tty.c_cflag |= CS8;
1347 tty.c_cc[VMIN] = 1;
1348 tty.c_cc[VTIME] = 0;
1349 }
1350 if (!stdio_allow_signal)
1351 tty.c_lflag &= ~ISIG;
1352
1353 tcsetattr (0, TCSANOW, &tty);
1354 }
1355
1356 static void qemu_chr_free_stdio(struct CharDriverState *chr)
1357 {
1358 term_exit();
1359 fd_chr_free(chr);
1360 }
1361
1362 static CharDriverState *qemu_chr_open_stdio(const char *id,
1363 ChardevBackend *backend,
1364 ChardevReturn *ret,
1365 Error **errp)
1366 {
1367 ChardevStdio *opts = backend->u.stdio.data;
1368 CharDriverState *chr;
1369 struct sigaction act;
1370 ChardevCommon *common = qapi_ChardevStdio_base(opts);
1371
1372 if (is_daemonized()) {
1373 error_setg(errp, "cannot use stdio with -daemonize");
1374 return NULL;
1375 }
1376
1377 if (stdio_in_use) {
1378 error_setg(errp, "cannot use stdio by multiple character devices");
1379 return NULL;
1380 }
1381
1382 stdio_in_use = true;
1383 old_fd0_flags = fcntl(0, F_GETFL);
1384 tcgetattr(0, &oldtty);
1385 qemu_set_nonblock(0);
1386 atexit(term_exit);
1387
1388 memset(&act, 0, sizeof(act));
1389 act.sa_handler = term_stdio_handler;
1390 sigaction(SIGCONT, &act, NULL);
1391
1392 chr = qemu_chr_open_fd(0, 1, common, errp);
1393 if (!chr) {
1394 return NULL;
1395 }
1396 chr->chr_free = qemu_chr_free_stdio;
1397 chr->chr_set_echo = qemu_chr_set_echo_stdio;
1398 if (opts->has_signal) {
1399 stdio_allow_signal = opts->signal;
1400 }
1401 qemu_chr_set_echo_stdio(chr, false);
1402
1403 return chr;
1404 }
1405
1406 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1407 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
1408 || defined(__GLIBC__)
1409
1410 #define HAVE_CHARDEV_SERIAL 1
1411 #define HAVE_CHARDEV_PTY 1
1412
1413 typedef struct {
1414 QIOChannel *ioc;
1415 int read_bytes;
1416
1417 /* Protected by the CharDriverState chr_write_lock. */
1418 int connected;
1419 guint timer_tag;
1420 guint open_tag;
1421 } PtyCharDriver;
1422
1423 static void pty_chr_update_read_handler_locked(CharDriverState *chr);
1424 static void pty_chr_state(CharDriverState *chr, int connected);
1425
1426 static gboolean pty_chr_timer(gpointer opaque)
1427 {
1428 struct CharDriverState *chr = opaque;
1429 PtyCharDriver *s = chr->opaque;
1430
1431 qemu_mutex_lock(&chr->chr_write_lock);
1432 s->timer_tag = 0;
1433 s->open_tag = 0;
1434 if (!s->connected) {
1435 /* Next poll ... */
1436 pty_chr_update_read_handler_locked(chr);
1437 }
1438 qemu_mutex_unlock(&chr->chr_write_lock);
1439 return FALSE;
1440 }
1441
1442 /* Called with chr_write_lock held. */
1443 static void pty_chr_rearm_timer(CharDriverState *chr, int ms)
1444 {
1445 PtyCharDriver *s = chr->opaque;
1446
1447 if (s->timer_tag) {
1448 g_source_remove(s->timer_tag);
1449 s->timer_tag = 0;
1450 }
1451
1452 if (ms == 1000) {
1453 s->timer_tag = g_timeout_add_seconds(1, pty_chr_timer, chr);
1454 } else {
1455 s->timer_tag = g_timeout_add(ms, pty_chr_timer, chr);
1456 }
1457 }
1458
1459 /* Called with chr_write_lock held. */
1460 static void pty_chr_update_read_handler_locked(CharDriverState *chr)
1461 {
1462 PtyCharDriver *s = chr->opaque;
1463 GPollFD pfd;
1464 int rc;
1465 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc);
1466
1467 pfd.fd = fioc->fd;
1468 pfd.events = G_IO_OUT;
1469 pfd.revents = 0;
1470 do {
1471 rc = g_poll(&pfd, 1, 0);
1472 } while (rc == -1 && errno == EINTR);
1473 assert(rc >= 0);
1474
1475 if (pfd.revents & G_IO_HUP) {
1476 pty_chr_state(chr, 0);
1477 } else {
1478 pty_chr_state(chr, 1);
1479 }
1480 }
1481
1482 static void pty_chr_update_read_handler(CharDriverState *chr,
1483 GMainContext *context)
1484 {
1485 qemu_mutex_lock(&chr->chr_write_lock);
1486 pty_chr_update_read_handler_locked(chr);
1487 qemu_mutex_unlock(&chr->chr_write_lock);
1488 }
1489
1490 /* Called with chr_write_lock held. */
1491 static int pty_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
1492 {
1493 PtyCharDriver *s = chr->opaque;
1494
1495 if (!s->connected) {
1496 /* guest sends data, check for (re-)connect */
1497 pty_chr_update_read_handler_locked(chr);
1498 if (!s->connected) {
1499 return 0;
1500 }
1501 }
1502 return io_channel_send(s->ioc, buf, len);
1503 }
1504
1505 static GSource *pty_chr_add_watch(CharDriverState *chr, GIOCondition cond)
1506 {
1507 PtyCharDriver *s = chr->opaque;
1508 if (!s->connected) {
1509 return NULL;
1510 }
1511 return qio_channel_create_watch(s->ioc, cond);
1512 }
1513
1514 static int pty_chr_read_poll(void *opaque)
1515 {
1516 CharDriverState *chr = opaque;
1517 PtyCharDriver *s = chr->opaque;
1518
1519 s->read_bytes = qemu_chr_be_can_write(chr);
1520 return s->read_bytes;
1521 }
1522
1523 static gboolean pty_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
1524 {
1525 CharDriverState *chr = opaque;
1526 PtyCharDriver *s = chr->opaque;
1527 gsize len;
1528 uint8_t buf[READ_BUF_LEN];
1529 ssize_t ret;
1530
1531 len = sizeof(buf);
1532 if (len > s->read_bytes)
1533 len = s->read_bytes;
1534 if (len == 0) {
1535 return TRUE;
1536 }
1537 ret = qio_channel_read(s->ioc, (char *)buf, len, NULL);
1538 if (ret <= 0) {
1539 pty_chr_state(chr, 0);
1540 return FALSE;
1541 } else {
1542 pty_chr_state(chr, 1);
1543 qemu_chr_be_write(chr, buf, ret);
1544 }
1545 return TRUE;
1546 }
1547
1548 static gboolean qemu_chr_be_generic_open_func(gpointer opaque)
1549 {
1550 CharDriverState *chr = opaque;
1551 PtyCharDriver *s = chr->opaque;
1552
1553 s->open_tag = 0;
1554 qemu_chr_be_generic_open(chr);
1555 return FALSE;
1556 }
1557
1558 /* Called with chr_write_lock held. */
1559 static void pty_chr_state(CharDriverState *chr, int connected)
1560 {
1561 PtyCharDriver *s = chr->opaque;
1562
1563 if (!connected) {
1564 if (s->open_tag) {
1565 g_source_remove(s->open_tag);
1566 s->open_tag = 0;
1567 }
1568 remove_fd_in_watch(chr);
1569 s->connected = 0;
1570 /* (re-)connect poll interval for idle guests: once per second.
1571 * We check more frequently in case the guests sends data to
1572 * the virtual device linked to our pty. */
1573 pty_chr_rearm_timer(chr, 1000);
1574 } else {
1575 if (s->timer_tag) {
1576 g_source_remove(s->timer_tag);
1577 s->timer_tag = 0;
1578 }
1579 if (!s->connected) {
1580 g_assert(s->open_tag == 0);
1581 s->connected = 1;
1582 s->open_tag = g_idle_add(qemu_chr_be_generic_open_func, chr);
1583 }
1584 if (!chr->fd_in_tag) {
1585 chr->fd_in_tag = io_add_watch_poll(s->ioc,
1586 pty_chr_read_poll,
1587 pty_chr_read,
1588 chr, NULL);
1589 }
1590 }
1591 }
1592
1593 static void pty_chr_free(struct CharDriverState *chr)
1594 {
1595 PtyCharDriver *s = chr->opaque;
1596
1597 qemu_mutex_lock(&chr->chr_write_lock);
1598 pty_chr_state(chr, 0);
1599 object_unref(OBJECT(s->ioc));
1600 if (s->timer_tag) {
1601 g_source_remove(s->timer_tag);
1602 s->timer_tag = 0;
1603 }
1604 qemu_mutex_unlock(&chr->chr_write_lock);
1605 g_free(s);
1606 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1607 }
1608
1609 static CharDriverState *qemu_chr_open_pty(const char *id,
1610 ChardevBackend *backend,
1611 ChardevReturn *ret,
1612 Error **errp)
1613 {
1614 CharDriverState *chr;
1615 PtyCharDriver *s;
1616 int master_fd, slave_fd;
1617 char pty_name[PATH_MAX];
1618 ChardevCommon *common = backend->u.pty.data;
1619
1620 master_fd = qemu_openpty_raw(&slave_fd, pty_name);
1621 if (master_fd < 0) {
1622 error_setg_errno(errp, errno, "Failed to create PTY");
1623 return NULL;
1624 }
1625
1626 close(slave_fd);
1627 qemu_set_nonblock(master_fd);
1628
1629 chr = qemu_chr_alloc(common, errp);
1630 if (!chr) {
1631 close(master_fd);
1632 return NULL;
1633 }
1634
1635 chr->filename = g_strdup_printf("pty:%s", pty_name);
1636 ret->pty = g_strdup(pty_name);
1637 ret->has_pty = true;
1638
1639 fprintf(stderr, "char device redirected to %s (label %s)\n",
1640 pty_name, id);
1641
1642 s = g_new0(PtyCharDriver, 1);
1643 chr->opaque = s;
1644 chr->chr_write = pty_chr_write;
1645 chr->chr_update_read_handler = pty_chr_update_read_handler;
1646 chr->chr_free = pty_chr_free;
1647 chr->chr_add_watch = pty_chr_add_watch;
1648 chr->explicit_be_open = true;
1649
1650 s->ioc = QIO_CHANNEL(qio_channel_file_new_fd(master_fd));
1651 s->timer_tag = 0;
1652
1653 return chr;
1654 }
1655
1656 static void tty_serial_init(int fd, int speed,
1657 int parity, int data_bits, int stop_bits)
1658 {
1659 struct termios tty;
1660 speed_t spd;
1661
1662 #if 0
1663 printf("tty_serial_init: speed=%d parity=%c data=%d stop=%d\n",
1664 speed, parity, data_bits, stop_bits);
1665 #endif
1666 tcgetattr (fd, &tty);
1667
1668 #define check_speed(val) if (speed <= val) { spd = B##val; break; }
1669 speed = speed * 10 / 11;
1670 do {
1671 check_speed(50);
1672 check_speed(75);
1673 check_speed(110);
1674 check_speed(134);
1675 check_speed(150);
1676 check_speed(200);
1677 check_speed(300);
1678 check_speed(600);
1679 check_speed(1200);
1680 check_speed(1800);
1681 check_speed(2400);
1682 check_speed(4800);
1683 check_speed(9600);
1684 check_speed(19200);
1685 check_speed(38400);
1686 /* Non-Posix values follow. They may be unsupported on some systems. */
1687 check_speed(57600);
1688 check_speed(115200);
1689 #ifdef B230400
1690 check_speed(230400);
1691 #endif
1692 #ifdef B460800
1693 check_speed(460800);
1694 #endif
1695 #ifdef B500000
1696 check_speed(500000);
1697 #endif
1698 #ifdef B576000
1699 check_speed(576000);
1700 #endif
1701 #ifdef B921600
1702 check_speed(921600);
1703 #endif
1704 #ifdef B1000000
1705 check_speed(1000000);
1706 #endif
1707 #ifdef B1152000
1708 check_speed(1152000);
1709 #endif
1710 #ifdef B1500000
1711 check_speed(1500000);
1712 #endif
1713 #ifdef B2000000
1714 check_speed(2000000);
1715 #endif
1716 #ifdef B2500000
1717 check_speed(2500000);
1718 #endif
1719 #ifdef B3000000
1720 check_speed(3000000);
1721 #endif
1722 #ifdef B3500000
1723 check_speed(3500000);
1724 #endif
1725 #ifdef B4000000
1726 check_speed(4000000);
1727 #endif
1728 spd = B115200;
1729 } while (0);
1730
1731 cfsetispeed(&tty, spd);
1732 cfsetospeed(&tty, spd);
1733
1734 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
1735 |INLCR|IGNCR|ICRNL|IXON);
1736 tty.c_oflag |= OPOST;
1737 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN|ISIG);
1738 tty.c_cflag &= ~(CSIZE|PARENB|PARODD|CRTSCTS|CSTOPB);
1739 switch(data_bits) {
1740 default:
1741 case 8:
1742 tty.c_cflag |= CS8;
1743 break;
1744 case 7:
1745 tty.c_cflag |= CS7;
1746 break;
1747 case 6:
1748 tty.c_cflag |= CS6;
1749 break;
1750 case 5:
1751 tty.c_cflag |= CS5;
1752 break;
1753 }
1754 switch(parity) {
1755 default:
1756 case 'N':
1757 break;
1758 case 'E':
1759 tty.c_cflag |= PARENB;
1760 break;
1761 case 'O':
1762 tty.c_cflag |= PARENB | PARODD;
1763 break;
1764 }
1765 if (stop_bits == 2)
1766 tty.c_cflag |= CSTOPB;
1767
1768 tcsetattr (fd, TCSANOW, &tty);
1769 }
1770
1771 static int tty_serial_ioctl(CharDriverState *chr, int cmd, void *arg)
1772 {
1773 FDCharDriver *s = chr->opaque;
1774 QIOChannelFile *fioc = QIO_CHANNEL_FILE(s->ioc_in);
1775
1776 switch(cmd) {
1777 case CHR_IOCTL_SERIAL_SET_PARAMS:
1778 {
1779 QEMUSerialSetParams *ssp = arg;
1780 tty_serial_init(fioc->fd,
1781 ssp->speed, ssp->parity,
1782 ssp->data_bits, ssp->stop_bits);
1783 }
1784 break;
1785 case CHR_IOCTL_SERIAL_SET_BREAK:
1786 {
1787 int enable = *(int *)arg;
1788 if (enable) {
1789 tcsendbreak(fioc->fd, 1);
1790 }
1791 }
1792 break;
1793 case CHR_IOCTL_SERIAL_GET_TIOCM:
1794 {
1795 int sarg = 0;
1796 int *targ = (int *)arg;
1797 ioctl(fioc->fd, TIOCMGET, &sarg);
1798 *targ = 0;
1799 if (sarg & TIOCM_CTS)
1800 *targ |= CHR_TIOCM_CTS;
1801 if (sarg & TIOCM_CAR)
1802 *targ |= CHR_TIOCM_CAR;
1803 if (sarg & TIOCM_DSR)
1804 *targ |= CHR_TIOCM_DSR;
1805 if (sarg & TIOCM_RI)
1806 *targ |= CHR_TIOCM_RI;
1807 if (sarg & TIOCM_DTR)
1808 *targ |= CHR_TIOCM_DTR;
1809 if (sarg & TIOCM_RTS)
1810 *targ |= CHR_TIOCM_RTS;
1811 }
1812 break;
1813 case CHR_IOCTL_SERIAL_SET_TIOCM:
1814 {
1815 int sarg = *(int *)arg;
1816 int targ = 0;
1817 ioctl(fioc->fd, TIOCMGET, &targ);
1818 targ &= ~(CHR_TIOCM_CTS | CHR_TIOCM_CAR | CHR_TIOCM_DSR
1819 | CHR_TIOCM_RI | CHR_TIOCM_DTR | CHR_TIOCM_RTS);
1820 if (sarg & CHR_TIOCM_CTS)
1821 targ |= TIOCM_CTS;
1822 if (sarg & CHR_TIOCM_CAR)
1823 targ |= TIOCM_CAR;
1824 if (sarg & CHR_TIOCM_DSR)
1825 targ |= TIOCM_DSR;
1826 if (sarg & CHR_TIOCM_RI)
1827 targ |= TIOCM_RI;
1828 if (sarg & CHR_TIOCM_DTR)
1829 targ |= TIOCM_DTR;
1830 if (sarg & CHR_TIOCM_RTS)
1831 targ |= TIOCM_RTS;
1832 ioctl(fioc->fd, TIOCMSET, &targ);
1833 }
1834 break;
1835 default:
1836 return -ENOTSUP;
1837 }
1838 return 0;
1839 }
1840
1841 static void qemu_chr_free_tty(CharDriverState *chr)
1842 {
1843 fd_chr_free(chr);
1844 }
1845
1846 static CharDriverState *qemu_chr_open_tty_fd(int fd,
1847 ChardevCommon *backend,
1848 Error **errp)
1849 {
1850 CharDriverState *chr;
1851
1852 tty_serial_init(fd, 115200, 'N', 8, 1);
1853 chr = qemu_chr_open_fd(fd, fd, backend, errp);
1854 if (!chr) {
1855 return NULL;
1856 }
1857 chr->chr_ioctl = tty_serial_ioctl;
1858 chr->chr_free = qemu_chr_free_tty;
1859 return chr;
1860 }
1861 #endif /* __linux__ || __sun__ */
1862
1863 #if defined(__linux__)
1864
1865 #define HAVE_CHARDEV_PARPORT 1
1866
1867 typedef struct {
1868 int fd;
1869 int mode;
1870 } ParallelCharDriver;
1871
1872 static int pp_hw_mode(ParallelCharDriver *s, uint16_t mode)
1873 {
1874 if (s->mode != mode) {
1875 int m = mode;
1876 if (ioctl(s->fd, PPSETMODE, &m) < 0)
1877 return 0;
1878 s->mode = mode;
1879 }
1880 return 1;
1881 }
1882
1883 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
1884 {
1885 ParallelCharDriver *drv = chr->opaque;
1886 int fd = drv->fd;
1887 uint8_t b;
1888
1889 switch(cmd) {
1890 case CHR_IOCTL_PP_READ_DATA:
1891 if (ioctl(fd, PPRDATA, &b) < 0)
1892 return -ENOTSUP;
1893 *(uint8_t *)arg = b;
1894 break;
1895 case CHR_IOCTL_PP_WRITE_DATA:
1896 b = *(uint8_t *)arg;
1897 if (ioctl(fd, PPWDATA, &b) < 0)
1898 return -ENOTSUP;
1899 break;
1900 case CHR_IOCTL_PP_READ_CONTROL:
1901 if (ioctl(fd, PPRCONTROL, &b) < 0)
1902 return -ENOTSUP;
1903 /* Linux gives only the lowest bits, and no way to know data
1904 direction! For better compatibility set the fixed upper
1905 bits. */
1906 *(uint8_t *)arg = b | 0xc0;
1907 break;
1908 case CHR_IOCTL_PP_WRITE_CONTROL:
1909 b = *(uint8_t *)arg;
1910 if (ioctl(fd, PPWCONTROL, &b) < 0)
1911 return -ENOTSUP;
1912 break;
1913 case CHR_IOCTL_PP_READ_STATUS:
1914 if (ioctl(fd, PPRSTATUS, &b) < 0)
1915 return -ENOTSUP;
1916 *(uint8_t *)arg = b;
1917 break;
1918 case CHR_IOCTL_PP_DATA_DIR:
1919 if (ioctl(fd, PPDATADIR, (int *)arg) < 0)
1920 return -ENOTSUP;
1921 break;
1922 case CHR_IOCTL_PP_EPP_READ_ADDR:
1923 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1924 struct ParallelIOArg *parg = arg;
1925 int n = read(fd, parg->buffer, parg->count);
1926 if (n != parg->count) {
1927 return -EIO;
1928 }
1929 }
1930 break;
1931 case CHR_IOCTL_PP_EPP_READ:
1932 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1933 struct ParallelIOArg *parg = arg;
1934 int n = read(fd, parg->buffer, parg->count);
1935 if (n != parg->count) {
1936 return -EIO;
1937 }
1938 }
1939 break;
1940 case CHR_IOCTL_PP_EPP_WRITE_ADDR:
1941 if (pp_hw_mode(drv, IEEE1284_MODE_EPP|IEEE1284_ADDR)) {
1942 struct ParallelIOArg *parg = arg;
1943 int n = write(fd, parg->buffer, parg->count);
1944 if (n != parg->count) {
1945 return -EIO;
1946 }
1947 }
1948 break;
1949 case CHR_IOCTL_PP_EPP_WRITE:
1950 if (pp_hw_mode(drv, IEEE1284_MODE_EPP)) {
1951 struct ParallelIOArg *parg = arg;
1952 int n = write(fd, parg->buffer, parg->count);
1953 if (n != parg->count) {
1954 return -EIO;
1955 }
1956 }
1957 break;
1958 default:
1959 return -ENOTSUP;
1960 }
1961 return 0;
1962 }
1963
1964 static void pp_free(CharDriverState *chr)
1965 {
1966 ParallelCharDriver *drv = chr->opaque;
1967 int fd = drv->fd;
1968
1969 pp_hw_mode(drv, IEEE1284_MODE_COMPAT);
1970 ioctl(fd, PPRELEASE);
1971 close(fd);
1972 g_free(drv);
1973 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1974 }
1975
1976 static CharDriverState *qemu_chr_open_pp_fd(int fd,
1977 ChardevCommon *backend,
1978 Error **errp)
1979 {
1980 CharDriverState *chr;
1981 ParallelCharDriver *drv;
1982
1983 if (ioctl(fd, PPCLAIM) < 0) {
1984 error_setg_errno(errp, errno, "not a parallel port");
1985 close(fd);
1986 return NULL;
1987 }
1988
1989 chr = qemu_chr_alloc(backend, errp);
1990 if (!chr) {
1991 return NULL;
1992 }
1993
1994 drv = g_new0(ParallelCharDriver, 1);
1995 chr->opaque = drv;
1996 chr->chr_write = null_chr_write;
1997 chr->chr_ioctl = pp_ioctl;
1998 chr->chr_free = pp_free;
1999
2000 drv->fd = fd;
2001 drv->mode = IEEE1284_MODE_COMPAT;
2002
2003 return chr;
2004 }
2005 #endif /* __linux__ */
2006
2007 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
2008
2009 #define HAVE_CHARDEV_PARPORT 1
2010
2011 static int pp_ioctl(CharDriverState *chr, int cmd, void *arg)
2012 {
2013 int fd = (int)(intptr_t)chr->opaque;
2014 uint8_t b;
2015
2016 switch(cmd) {
2017 case CHR_IOCTL_PP_READ_DATA:
2018 if (ioctl(fd, PPIGDATA, &b) < 0)
2019 return -ENOTSUP;
2020 *(uint8_t *)arg = b;
2021 break;
2022 case CHR_IOCTL_PP_WRITE_DATA:
2023 b = *(uint8_t *)arg;
2024 if (ioctl(fd, PPISDATA, &b) < 0)
2025 return -ENOTSUP;
2026 break;
2027 case CHR_IOCTL_PP_READ_CONTROL:
2028 if (ioctl(fd, PPIGCTRL, &b) < 0)
2029 return -ENOTSUP;
2030 *(uint8_t *)arg = b;
2031 break;
2032 case CHR_IOCTL_PP_WRITE_CONTROL:
2033 b = *(uint8_t *)arg;
2034 if (ioctl(fd, PPISCTRL, &b) < 0)
2035 return -ENOTSUP;
2036 break;
2037 case CHR_IOCTL_PP_READ_STATUS:
2038 if (ioctl(fd, PPIGSTATUS, &b) < 0)
2039 return -ENOTSUP;
2040 *(uint8_t *)arg = b;
2041 break;
2042 default:
2043 return -ENOTSUP;
2044 }
2045 return 0;
2046 }
2047
2048 static CharDriverState *qemu_chr_open_pp_fd(int fd,
2049 ChardevCommon *backend,
2050 Error **errp)
2051 {
2052 CharDriverState *chr;
2053
2054 chr = qemu_chr_alloc(backend, errp);
2055 if (!chr) {
2056 return NULL;
2057 }
2058 chr->opaque = (void *)(intptr_t)fd;
2059 chr->chr_write = null_chr_write;
2060 chr->chr_ioctl = pp_ioctl;
2061 chr->explicit_be_open = true;
2062 return chr;
2063 }
2064 #endif
2065
2066 #else /* _WIN32 */
2067
2068 #define HAVE_CHARDEV_SERIAL 1
2069
2070 typedef struct {
2071 int max_size;
2072 HANDLE hcom, hrecv, hsend;
2073 OVERLAPPED orecv;
2074 BOOL fpipe;
2075 DWORD len;
2076
2077 /* Protected by the CharDriverState chr_write_lock. */
2078 OVERLAPPED osend;
2079 } WinCharState;
2080
2081 typedef struct {
2082 HANDLE hStdIn;
2083 HANDLE hInputReadyEvent;
2084 HANDLE hInputDoneEvent;
2085 HANDLE hInputThread;
2086 uint8_t win_stdio_buf;
2087 } WinStdioCharState;
2088
2089 #define NSENDBUF 2048
2090 #define NRECVBUF 2048
2091 #define MAXCONNECT 1
2092 #define NTIMEOUT 5000
2093
2094 static int win_chr_poll(void *opaque);
2095 static int win_chr_pipe_poll(void *opaque);
2096
2097 static void win_chr_free(CharDriverState *chr)
2098 {
2099 WinCharState *s = chr->opaque;
2100
2101 if (s->hsend) {
2102 CloseHandle(s->hsend);
2103 s->hsend = NULL;
2104 }
2105 if (s->hrecv) {
2106 CloseHandle(s->hrecv);
2107 s->hrecv = NULL;
2108 }
2109 if (s->hcom) {
2110 CloseHandle(s->hcom);
2111 s->hcom = NULL;
2112 }
2113 if (s->fpipe)
2114 qemu_del_polling_cb(win_chr_pipe_poll, chr);
2115 else
2116 qemu_del_polling_cb(win_chr_poll, chr);
2117
2118 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2119 }
2120
2121 static int win_chr_init(CharDriverState *chr, const char *filename, Error **errp)
2122 {
2123 WinCharState *s = chr->opaque;
2124 COMMCONFIG comcfg;
2125 COMMTIMEOUTS cto = { 0, 0, 0, 0, 0};
2126 COMSTAT comstat;
2127 DWORD size;
2128 DWORD err;
2129
2130 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2131 if (!s->hsend) {
2132 error_setg(errp, "Failed CreateEvent");
2133 goto fail;
2134 }
2135 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2136 if (!s->hrecv) {
2137 error_setg(errp, "Failed CreateEvent");
2138 goto fail;
2139 }
2140
2141 s->hcom = CreateFile(filename, GENERIC_READ|GENERIC_WRITE, 0, NULL,
2142 OPEN_EXISTING, FILE_FLAG_OVERLAPPED, 0);
2143 if (s->hcom == INVALID_HANDLE_VALUE) {
2144 error_setg(errp, "Failed CreateFile (%lu)", GetLastError());
2145 s->hcom = NULL;
2146 goto fail;
2147 }
2148
2149 if (!SetupComm(s->hcom, NRECVBUF, NSENDBUF)) {
2150 error_setg(errp, "Failed SetupComm");
2151 goto fail;
2152 }
2153
2154 ZeroMemory(&comcfg, sizeof(COMMCONFIG));
2155 size = sizeof(COMMCONFIG);
2156 GetDefaultCommConfig(filename, &comcfg, &size);
2157 comcfg.dcb.DCBlength = sizeof(DCB);
2158 CommConfigDialog(filename, NULL, &comcfg);
2159
2160 if (!SetCommState(s->hcom, &comcfg.dcb)) {
2161 error_setg(errp, "Failed SetCommState");
2162 goto fail;
2163 }
2164
2165 if (!SetCommMask(s->hcom, EV_ERR)) {
2166 error_setg(errp, "Failed SetCommMask");
2167 goto fail;
2168 }
2169
2170 cto.ReadIntervalTimeout = MAXDWORD;
2171 if (!SetCommTimeouts(s->hcom, &cto)) {
2172 error_setg(errp, "Failed SetCommTimeouts");
2173 goto fail;
2174 }
2175
2176 if (!ClearCommError(s->hcom, &err, &comstat)) {
2177 error_setg(errp, "Failed ClearCommError");
2178 goto fail;
2179 }
2180 qemu_add_polling_cb(win_chr_poll, chr);
2181 return 0;
2182
2183 fail:
2184 win_chr_free(chr);
2185 return -1;
2186 }
2187
2188 /* Called with chr_write_lock held. */
2189 static int win_chr_write(CharDriverState *chr, const uint8_t *buf, int len1)
2190 {
2191 WinCharState *s = chr->opaque;
2192 DWORD len, ret, size, err;
2193
2194 len = len1;
2195 ZeroMemory(&s->osend, sizeof(s->osend));
2196 s->osend.hEvent = s->hsend;
2197 while (len > 0) {
2198 if (s->hsend)
2199 ret = WriteFile(s->hcom, buf, len, &size, &s->osend);
2200 else
2201 ret = WriteFile(s->hcom, buf, len, &size, NULL);
2202 if (!ret) {
2203 err = GetLastError();
2204 if (err == ERROR_IO_PENDING) {
2205 ret = GetOverlappedResult(s->hcom, &s->osend, &size, TRUE);
2206 if (ret) {
2207 buf += size;
2208 len -= size;
2209 } else {
2210 break;
2211 }
2212 } else {
2213 break;
2214 }
2215 } else {
2216 buf += size;
2217 len -= size;
2218 }
2219 }
2220 return len1 - len;
2221 }
2222
2223 static int win_chr_read_poll(CharDriverState *chr)
2224 {
2225 WinCharState *s = chr->opaque;
2226
2227 s->max_size = qemu_chr_be_can_write(chr);
2228 return s->max_size;
2229 }
2230
2231 static void win_chr_readfile(CharDriverState *chr)
2232 {
2233 WinCharState *s = chr->opaque;
2234 int ret, err;
2235 uint8_t buf[READ_BUF_LEN];
2236 DWORD size;
2237
2238 ZeroMemory(&s->orecv, sizeof(s->orecv));
2239 s->orecv.hEvent = s->hrecv;
2240 ret = ReadFile(s->hcom, buf, s->len, &size, &s->orecv);
2241 if (!ret) {
2242 err = GetLastError();
2243 if (err == ERROR_IO_PENDING) {
2244 ret = GetOverlappedResult(s->hcom, &s->orecv, &size, TRUE);
2245 }
2246 }
2247
2248 if (size > 0) {
2249 qemu_chr_be_write(chr, buf, size);
2250 }
2251 }
2252
2253 static void win_chr_read(CharDriverState *chr)
2254 {
2255 WinCharState *s = chr->opaque;
2256
2257 if (s->len > s->max_size)
2258 s->len = s->max_size;
2259 if (s->len == 0)
2260 return;
2261
2262 win_chr_readfile(chr);
2263 }
2264
2265 static int win_chr_poll(void *opaque)
2266 {
2267 CharDriverState *chr = opaque;
2268 WinCharState *s = chr->opaque;
2269 COMSTAT status;
2270 DWORD comerr;
2271
2272 ClearCommError(s->hcom, &comerr, &status);
2273 if (status.cbInQue > 0) {
2274 s->len = status.cbInQue;
2275 win_chr_read_poll(chr);
2276 win_chr_read(chr);
2277 return 1;
2278 }
2279 return 0;
2280 }
2281
2282 static CharDriverState *qemu_chr_open_win_path(const char *filename,
2283 ChardevCommon *backend,
2284 Error **errp)
2285 {
2286 CharDriverState *chr;
2287 WinCharState *s;
2288
2289 chr = qemu_chr_alloc(backend, errp);
2290 if (!chr) {
2291 return NULL;
2292 }
2293 s = g_new0(WinCharState, 1);
2294 chr->opaque = s;
2295 chr->chr_write = win_chr_write;
2296 chr->chr_free = win_chr_free;
2297
2298 if (win_chr_init(chr, filename, errp) < 0) {
2299 g_free(s);
2300 qemu_chr_free_common(chr);
2301 return NULL;
2302 }
2303 return chr;
2304 }
2305
2306 static int win_chr_pipe_poll(void *opaque)
2307 {
2308 CharDriverState *chr = opaque;
2309 WinCharState *s = chr->opaque;
2310 DWORD size;
2311
2312 PeekNamedPipe(s->hcom, NULL, 0, NULL, &size, NULL);
2313 if (size > 0) {
2314 s->len = size;
2315 win_chr_read_poll(chr);
2316 win_chr_read(chr);
2317 return 1;
2318 }
2319 return 0;
2320 }
2321
2322 static int win_chr_pipe_init(CharDriverState *chr, const char *filename,
2323 Error **errp)
2324 {
2325 WinCharState *s = chr->opaque;
2326 OVERLAPPED ov;
2327 int ret;
2328 DWORD size;
2329 char *openname;
2330
2331 s->fpipe = TRUE;
2332
2333 s->hsend = CreateEvent(NULL, TRUE, FALSE, NULL);
2334 if (!s->hsend) {
2335 error_setg(errp, "Failed CreateEvent");
2336 goto fail;
2337 }
2338 s->hrecv = CreateEvent(NULL, TRUE, FALSE, NULL);
2339 if (!s->hrecv) {
2340 error_setg(errp, "Failed CreateEvent");
2341 goto fail;
2342 }
2343
2344 openname = g_strdup_printf("\\\\.\\pipe\\%s", filename);
2345 s->hcom = CreateNamedPipe(openname, PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
2346 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE |
2347 PIPE_WAIT,
2348 MAXCONNECT, NSENDBUF, NRECVBUF, NTIMEOUT, NULL);
2349 g_free(openname);
2350 if (s->hcom == INVALID_HANDLE_VALUE) {
2351 error_setg(errp, "Failed CreateNamedPipe (%lu)", GetLastError());
2352 s->hcom = NULL;
2353 goto fail;
2354 }
2355
2356 ZeroMemory(&ov, sizeof(ov));
2357 ov.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
2358 ret = ConnectNamedPipe(s->hcom, &ov);
2359 if (ret) {
2360 error_setg(errp, "Failed ConnectNamedPipe");
2361 goto fail;
2362 }
2363
2364 ret = GetOverlappedResult(s->hcom, &ov, &size, TRUE);
2365 if (!ret) {
2366 error_setg(errp, "Failed GetOverlappedResult");
2367 if (ov.hEvent) {
2368 CloseHandle(ov.hEvent);
2369 ov.hEvent = NULL;
2370 }
2371 goto fail;
2372 }
2373
2374 if (ov.hEvent) {
2375 CloseHandle(ov.hEvent);
2376 ov.hEvent = NULL;
2377 }
2378 qemu_add_polling_cb(win_chr_pipe_poll, chr);
2379 return 0;
2380
2381 fail:
2382 win_chr_free(chr);
2383 return -1;
2384 }
2385
2386
2387 static CharDriverState *qemu_chr_open_pipe(const char *id,
2388 ChardevBackend *backend,
2389 ChardevReturn *ret,
2390 Error **errp)
2391 {
2392 ChardevHostdev *opts = backend->u.pipe.data;
2393 const char *filename = opts->device;
2394 CharDriverState *chr;
2395 WinCharState *s;
2396 ChardevCommon *common = qapi_ChardevHostdev_base(opts);
2397
2398 chr = qemu_chr_alloc(common, errp);
2399 if (!chr) {
2400 return NULL;
2401 }
2402 s = g_new0(WinCharState, 1);
2403 chr->opaque = s;
2404 chr->chr_write = win_chr_write;
2405 chr->chr_free = win_chr_free;
2406
2407 if (win_chr_pipe_init(chr, filename, errp) < 0) {
2408 g_free(s);
2409 qemu_chr_free_common(chr);
2410 return NULL;
2411 }
2412 return chr;
2413 }
2414
2415 static CharDriverState *qemu_chr_open_win_file(HANDLE fd_out,
2416 ChardevCommon *backend,
2417 Error **errp)
2418 {
2419 CharDriverState *chr;
2420 WinCharState *s;
2421
2422 chr = qemu_chr_alloc(backend, errp);
2423 if (!chr) {
2424 return NULL;
2425 }
2426 s = g_new0(WinCharState, 1);
2427 s->hcom = fd_out;
2428 chr->opaque = s;
2429 chr->chr_write = win_chr_write;
2430 return chr;
2431 }
2432
2433 static CharDriverState *qemu_chr_open_win_con(const char *id,
2434 ChardevBackend *backend,
2435 ChardevReturn *ret,
2436 Error **errp)
2437 {
2438 ChardevCommon *common = backend->u.console.data;
2439 return qemu_chr_open_win_file(GetStdHandle(STD_OUTPUT_HANDLE),
2440 common, errp);
2441 }
2442
2443 static int win_stdio_write(CharDriverState *chr, const uint8_t *buf, int len)
2444 {
2445 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
2446 DWORD dwSize;
2447 int len1;
2448
2449 len1 = len;
2450
2451 while (len1 > 0) {
2452 if (!WriteFile(hStdOut, buf, len1, &dwSize, NULL)) {
2453 break;
2454 }
2455 buf += dwSize;
2456 len1 -= dwSize;
2457 }
2458
2459 return len - len1;
2460 }
2461
2462 static void win_stdio_wait_func(void *opaque)
2463 {
2464 CharDriverState *chr = opaque;
2465 WinStdioCharState *stdio = chr->opaque;
2466 INPUT_RECORD buf[4];
2467 int ret;
2468 DWORD dwSize;
2469 int i;
2470
2471 ret = ReadConsoleInput(stdio->hStdIn, buf, ARRAY_SIZE(buf), &dwSize);
2472
2473 if (!ret) {
2474 /* Avoid error storm */
2475 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2476 return;
2477 }
2478
2479 for (i = 0; i < dwSize; i++) {
2480 KEY_EVENT_RECORD *kev = &buf[i].Event.KeyEvent;
2481
2482 if (buf[i].EventType == KEY_EVENT && kev->bKeyDown) {
2483 int j;
2484 if (kev->uChar.AsciiChar != 0) {
2485 for (j = 0; j < kev->wRepeatCount; j++) {
2486 if (qemu_chr_be_can_write(chr)) {
2487 uint8_t c = kev->uChar.AsciiChar;
2488 qemu_chr_be_write(chr, &c, 1);
2489 }
2490 }
2491 }
2492 }
2493 }
2494 }
2495
2496 static DWORD WINAPI win_stdio_thread(LPVOID param)
2497 {
2498 CharDriverState *chr = param;
2499 WinStdioCharState *stdio = chr->opaque;
2500 int ret;
2501 DWORD dwSize;
2502
2503 while (1) {
2504
2505 /* Wait for one byte */
2506 ret = ReadFile(stdio->hStdIn, &stdio->win_stdio_buf, 1, &dwSize, NULL);
2507
2508 /* Exit in case of error, continue if nothing read */
2509 if (!ret) {
2510 break;
2511 }
2512 if (!dwSize) {
2513 continue;
2514 }
2515
2516 /* Some terminal emulator returns \r\n for Enter, just pass \n */
2517 if (stdio->win_stdio_buf == '\r') {
2518 continue;
2519 }
2520
2521 /* Signal the main thread and wait until the byte was eaten */
2522 if (!SetEvent(stdio->hInputReadyEvent)) {
2523 break;
2524 }
2525 if (WaitForSingleObject(stdio->hInputDoneEvent, INFINITE)
2526 != WAIT_OBJECT_0) {
2527 break;
2528 }
2529 }
2530
2531 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2532 return 0;
2533 }
2534
2535 static void win_stdio_thread_wait_func(void *opaque)
2536 {
2537 CharDriverState *chr = opaque;
2538 WinStdioCharState *stdio = chr->opaque;
2539
2540 if (qemu_chr_be_can_write(chr)) {
2541 qemu_chr_be_write(chr, &stdio->win_stdio_buf, 1);
2542 }
2543
2544 SetEvent(stdio->hInputDoneEvent);
2545 }
2546
2547 static void qemu_chr_set_echo_win_stdio(CharDriverState *chr, bool echo)
2548 {
2549 WinStdioCharState *stdio = chr->opaque;
2550 DWORD dwMode = 0;
2551
2552 GetConsoleMode(stdio->hStdIn, &dwMode);
2553
2554 if (echo) {
2555 SetConsoleMode(stdio->hStdIn, dwMode | ENABLE_ECHO_INPUT);
2556 } else {
2557 SetConsoleMode(stdio->hStdIn, dwMode & ~ENABLE_ECHO_INPUT);
2558 }
2559 }
2560
2561 static void win_stdio_free(CharDriverState *chr)
2562 {
2563 WinStdioCharState *stdio = chr->opaque;
2564
2565 if (stdio->hInputReadyEvent != INVALID_HANDLE_VALUE) {
2566 CloseHandle(stdio->hInputReadyEvent);
2567 }
2568 if (stdio->hInputDoneEvent != INVALID_HANDLE_VALUE) {
2569 CloseHandle(stdio->hInputDoneEvent);
2570 }
2571 if (stdio->hInputThread != INVALID_HANDLE_VALUE) {
2572 TerminateThread(stdio->hInputThread, 0);
2573 }
2574
2575 g_free(chr->opaque);
2576 }
2577
2578 static CharDriverState *qemu_chr_open_stdio(const char *id,
2579 ChardevBackend *backend,
2580 ChardevReturn *ret,
2581 Error **errp)
2582 {
2583 CharDriverState *chr;
2584 WinStdioCharState *stdio;
2585 DWORD dwMode;
2586 int is_console = 0;
2587 ChardevCommon *common = qapi_ChardevStdio_base(backend->u.stdio.data);
2588
2589 chr = qemu_chr_alloc(common, errp);
2590 if (!chr) {
2591 return NULL;
2592 }
2593 stdio = g_new0(WinStdioCharState, 1);
2594
2595 stdio->hStdIn = GetStdHandle(STD_INPUT_HANDLE);
2596 if (stdio->hStdIn == INVALID_HANDLE_VALUE) {
2597 error_setg(errp, "cannot open stdio: invalid handle");
2598 return NULL;
2599 }
2600
2601 is_console = GetConsoleMode(stdio->hStdIn, &dwMode) != 0;
2602
2603 chr->opaque = stdio;
2604 chr->chr_write = win_stdio_write;
2605 chr->chr_free = win_stdio_free;
2606
2607 if (is_console) {
2608 if (qemu_add_wait_object(stdio->hStdIn,
2609 win_stdio_wait_func, chr)) {
2610 error_setg(errp, "qemu_add_wait_object: failed");
2611 goto err1;
2612 }
2613 } else {
2614 DWORD dwId;
2615
2616 stdio->hInputReadyEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2617 stdio->hInputDoneEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
2618 if (stdio->hInputReadyEvent == INVALID_HANDLE_VALUE
2619 || stdio->hInputDoneEvent == INVALID_HANDLE_VALUE) {
2620 error_setg(errp, "cannot create event");
2621 goto err2;
2622 }
2623 if (qemu_add_wait_object(stdio->hInputReadyEvent,
2624 win_stdio_thread_wait_func, chr)) {
2625 error_setg(errp, "qemu_add_wait_object: failed");
2626 goto err2;
2627 }
2628 stdio->hInputThread = CreateThread(NULL, 0, win_stdio_thread,
2629 chr, 0, &dwId);
2630
2631 if (stdio->hInputThread == INVALID_HANDLE_VALUE) {
2632 error_setg(errp, "cannot create stdio thread");
2633 goto err3;
2634 }
2635 }
2636
2637 dwMode |= ENABLE_LINE_INPUT;
2638
2639 if (is_console) {
2640 /* set the terminal in raw mode */
2641 /* ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS */
2642 dwMode |= ENABLE_PROCESSED_INPUT;
2643 }
2644
2645 SetConsoleMode(stdio->hStdIn, dwMode);
2646
2647 chr->chr_set_echo = qemu_chr_set_echo_win_stdio;
2648 qemu_chr_set_echo_win_stdio(chr, false);
2649
2650 return chr;
2651
2652 err3:
2653 qemu_del_wait_object(stdio->hInputReadyEvent, NULL, NULL);
2654 err2:
2655 CloseHandle(stdio->hInputReadyEvent);
2656 CloseHandle(stdio->hInputDoneEvent);
2657 err1:
2658 qemu_del_wait_object(stdio->hStdIn, NULL, NULL);
2659 return NULL;
2660 }
2661 #endif /* !_WIN32 */
2662
2663 /***********************************************************/
2664 /* UDP Net console */
2665
2666 typedef struct {
2667 QIOChannel *ioc;
2668 uint8_t buf[READ_BUF_LEN];
2669 int bufcnt;
2670 int bufptr;
2671 int max_size;
2672 } NetCharDriver;
2673
2674 /* Called with chr_write_lock held. */
2675 static int udp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2676 {
2677 NetCharDriver *s = chr->opaque;
2678
2679 return qio_channel_write(
2680 s->ioc, (const char *)buf, len, NULL);
2681 }
2682
2683 static int udp_chr_read_poll(void *opaque)
2684 {
2685 CharDriverState *chr = opaque;
2686 NetCharDriver *s = chr->opaque;
2687
2688 s->max_size = qemu_chr_be_can_write(chr);
2689
2690 /* If there were any stray characters in the queue process them
2691 * first
2692 */
2693 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2694 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2695 s->bufptr++;
2696 s->max_size = qemu_chr_be_can_write(chr);
2697 }
2698 return s->max_size;
2699 }
2700
2701 static gboolean udp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
2702 {
2703 CharDriverState *chr = opaque;
2704 NetCharDriver *s = chr->opaque;
2705 ssize_t ret;
2706
2707 if (s->max_size == 0) {
2708 return TRUE;
2709 }
2710 ret = qio_channel_read(
2711 s->ioc, (char *)s->buf, sizeof(s->buf), NULL);
2712 if (ret <= 0) {
2713 remove_fd_in_watch(chr);
2714 return FALSE;
2715 }
2716 s->bufcnt = ret;
2717
2718 s->bufptr = 0;
2719 while (s->max_size > 0 && s->bufptr < s->bufcnt) {
2720 qemu_chr_be_write(chr, &s->buf[s->bufptr], 1);
2721 s->bufptr++;
2722 s->max_size = qemu_chr_be_can_write(chr);
2723 }
2724
2725 return TRUE;
2726 }
2727
2728 static void udp_chr_update_read_handler(CharDriverState *chr,
2729 GMainContext *context)
2730 {
2731 NetCharDriver *s = chr->opaque;
2732
2733 remove_fd_in_watch(chr);
2734 if (s->ioc) {
2735 chr->fd_in_tag = io_add_watch_poll(s->ioc,
2736 udp_chr_read_poll,
2737 udp_chr_read, chr,
2738 context);
2739 }
2740 }
2741
2742 static void udp_chr_free(CharDriverState *chr)
2743 {
2744 NetCharDriver *s = chr->opaque;
2745
2746 remove_fd_in_watch(chr);
2747 if (s->ioc) {
2748 object_unref(OBJECT(s->ioc));
2749 }
2750 g_free(s);
2751 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
2752 }
2753
2754 static CharDriverState *qemu_chr_open_udp(QIOChannelSocket *sioc,
2755 ChardevCommon *backend,
2756 Error **errp)
2757 {
2758 CharDriverState *chr = NULL;
2759 NetCharDriver *s = NULL;
2760
2761 chr = qemu_chr_alloc(backend, errp);
2762 if (!chr) {
2763 return NULL;
2764 }
2765 s = g_new0(NetCharDriver, 1);
2766
2767 s->ioc = QIO_CHANNEL(sioc);
2768 s->bufcnt = 0;
2769 s->bufptr = 0;
2770 chr->opaque = s;
2771 chr->chr_write = udp_chr_write;
2772 chr->chr_update_read_handler = udp_chr_update_read_handler;
2773 chr->chr_free = udp_chr_free;
2774 /* be isn't opened until we get a connection */
2775 chr->explicit_be_open = true;
2776 return chr;
2777 }
2778
2779 /***********************************************************/
2780 /* TCP Net console */
2781
2782 typedef struct {
2783 QIOChannel *ioc; /* Client I/O channel */
2784 QIOChannelSocket *sioc; /* Client master channel */
2785 QIOChannelSocket *listen_ioc;
2786 guint listen_tag;
2787 QCryptoTLSCreds *tls_creds;
2788 int connected;
2789 int max_size;
2790 int do_telnetopt;
2791 int do_nodelay;
2792 int is_unix;
2793 int *read_msgfds;
2794 size_t read_msgfds_num;
2795 int *write_msgfds;
2796 size_t write_msgfds_num;
2797
2798 SocketAddress *addr;
2799 bool is_listen;
2800 bool is_telnet;
2801
2802 guint reconnect_timer;
2803 int64_t reconnect_time;
2804 bool connect_err_reported;
2805 } TCPCharDriver;
2806
2807 static gboolean socket_reconnect_timeout(gpointer opaque);
2808
2809 static void qemu_chr_socket_restart_timer(CharDriverState *chr)
2810 {
2811 TCPCharDriver *s = chr->opaque;
2812 assert(s->connected == 0);
2813 s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
2814 socket_reconnect_timeout, chr);
2815 }
2816
2817 static void check_report_connect_error(CharDriverState *chr,
2818 Error *err)
2819 {
2820 TCPCharDriver *s = chr->opaque;
2821
2822 if (!s->connect_err_reported) {
2823 error_report("Unable to connect character device %s: %s",
2824 chr->label, error_get_pretty(err));
2825 s->connect_err_reported = true;
2826 }
2827 qemu_chr_socket_restart_timer(chr);
2828 }
2829
2830 static gboolean tcp_chr_accept(QIOChannel *chan,
2831 GIOCondition cond,
2832 void *opaque);
2833
2834 /* Called with chr_write_lock held. */
2835 static int tcp_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
2836 {
2837 TCPCharDriver *s = chr->opaque;
2838 if (s->connected) {
2839 int ret = io_channel_send_full(s->ioc, buf, len,
2840 s->write_msgfds,
2841 s->write_msgfds_num);
2842
2843 /* free the written msgfds, no matter what */
2844 if (s->write_msgfds_num) {
2845 g_free(s->write_msgfds);
2846 s->write_msgfds = 0;
2847 s->write_msgfds_num = 0;
2848 }
2849
2850 return ret;
2851 } else {
2852 /* XXX: indicate an error ? */
2853 return len;
2854 }
2855 }
2856
2857 static int tcp_chr_read_poll(void *opaque)
2858 {
2859 CharDriverState *chr = opaque;
2860 TCPCharDriver *s = chr->opaque;
2861 if (!s->connected)
2862 return 0;
2863 s->max_size = qemu_chr_be_can_write(chr);
2864 return s->max_size;
2865 }
2866
2867 #define IAC 255
2868 #define IAC_BREAK 243
2869 static void tcp_chr_process_IAC_bytes(CharDriverState *chr,
2870 TCPCharDriver *s,
2871 uint8_t *buf, int *size)
2872 {
2873 /* Handle any telnet client's basic IAC options to satisfy char by
2874 * char mode with no echo. All IAC options will be removed from
2875 * the buf and the do_telnetopt variable will be used to track the
2876 * state of the width of the IAC information.
2877 *
2878 * IAC commands come in sets of 3 bytes with the exception of the
2879 * "IAC BREAK" command and the double IAC.
2880 */
2881
2882 int i;
2883 int j = 0;
2884
2885 for (i = 0; i < *size; i++) {
2886 if (s->do_telnetopt > 1) {
2887 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
2888 /* Double IAC means send an IAC */
2889 if (j != i)
2890 buf[j] = buf[i];
2891 j++;
2892 s->do_telnetopt = 1;
2893 } else {
2894 if ((unsigned char)buf[i] == IAC_BREAK && s->do_telnetopt == 2) {
2895 /* Handle IAC break commands by sending a serial break */
2896 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
2897 s->do_telnetopt++;
2898 }
2899 s->do_telnetopt++;
2900 }
2901 if (s->do_telnetopt >= 4) {
2902 s->do_telnetopt = 1;
2903 }
2904 } else {
2905 if ((unsigned char)buf[i] == IAC) {
2906 s->do_telnetopt = 2;
2907 } else {
2908 if (j != i)
2909 buf[j] = buf[i];
2910 j++;
2911 }
2912 }
2913 }
2914 *size = j;
2915 }
2916
2917 static int tcp_get_msgfds(CharDriverState *chr, int *fds, int num)
2918 {
2919 TCPCharDriver *s = chr->opaque;
2920 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
2921
2922 assert(num <= TCP_MAX_FDS);
2923
2924 if (to_copy) {
2925 int i;
2926
2927 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
2928
2929 /* Close unused fds */
2930 for (i = to_copy; i < s->read_msgfds_num; i++) {
2931 close(s->read_msgfds[i]);
2932 }
2933
2934 g_free(s->read_msgfds);
2935 s->read_msgfds = 0;
2936 s->read_msgfds_num = 0;
2937 }
2938
2939 return to_copy;
2940 }
2941
2942 static int tcp_set_msgfds(CharDriverState *chr, int *fds, int num)
2943 {
2944 TCPCharDriver *s = chr->opaque;
2945
2946 /* clear old pending fd array */
2947 g_free(s->write_msgfds);
2948 s->write_msgfds = NULL;
2949 s->write_msgfds_num = 0;
2950
2951 if (!s->connected ||
2952 !qio_channel_has_feature(s->ioc,
2953 QIO_CHANNEL_FEATURE_FD_PASS)) {
2954 return -1;
2955 }
2956
2957 if (num) {
2958 s->write_msgfds = g_new(int, num);
2959 memcpy(s->write_msgfds, fds, num * sizeof(int));
2960 }
2961
2962 s->write_msgfds_num = num;
2963
2964 return 0;
2965 }
2966
2967 static ssize_t tcp_chr_recv(CharDriverState *chr, char *buf, size_t len)
2968 {
2969 TCPCharDriver *s = chr->opaque;
2970 struct iovec iov = { .iov_base = buf, .iov_len = len };
2971 int ret;
2972 size_t i;
2973 int *msgfds = NULL;
2974 size_t msgfds_num = 0;
2975
2976 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
2977 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2978 &msgfds, &msgfds_num,
2979 NULL);
2980 } else {
2981 ret = qio_channel_readv_full(s->ioc, &iov, 1,
2982 NULL, NULL,
2983 NULL);
2984 }
2985
2986 if (ret == QIO_CHANNEL_ERR_BLOCK) {
2987 errno = EAGAIN;
2988 ret = -1;
2989 } else if (ret == -1) {
2990 errno = EIO;
2991 }
2992
2993 if (msgfds_num) {
2994 /* close and clean read_msgfds */
2995 for (i = 0; i < s->read_msgfds_num; i++) {
2996 close(s->read_msgfds[i]);
2997 }
2998
2999 if (s->read_msgfds_num) {
3000 g_free(s->read_msgfds);
3001 }
3002
3003 s->read_msgfds = msgfds;
3004 s->read_msgfds_num = msgfds_num;
3005 }
3006
3007 for (i = 0; i < s->read_msgfds_num; i++) {
3008 int fd = s->read_msgfds[i];
3009 if (fd < 0) {
3010 continue;
3011 }
3012
3013 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
3014 qemu_set_block(fd);
3015
3016 #ifndef MSG_CMSG_CLOEXEC
3017 qemu_set_cloexec(fd);
3018 #endif
3019 }
3020
3021 return ret;
3022 }
3023
3024 static GSource *tcp_chr_add_watch(CharDriverState *chr, GIOCondition cond)
3025 {
3026 TCPCharDriver *s = chr->opaque;
3027 return qio_channel_create_watch(s->ioc, cond);
3028 }
3029
3030 static void tcp_chr_free_connection(CharDriverState *chr)
3031 {
3032 TCPCharDriver *s = chr->opaque;
3033 int i;
3034
3035 if (!s->connected) {
3036 return;
3037 }
3038
3039 if (s->read_msgfds_num) {
3040 for (i = 0; i < s->read_msgfds_num; i++) {
3041 close(s->read_msgfds[i]);
3042 }
3043 g_free(s->read_msgfds);
3044 s->read_msgfds = NULL;
3045 s->read_msgfds_num = 0;
3046 }
3047
3048 tcp_set_msgfds(chr, NULL, 0);
3049 remove_fd_in_watch(chr);
3050 object_unref(OBJECT(s->sioc));
3051 s->sioc = NULL;
3052 object_unref(OBJECT(s->ioc));
3053 s->ioc = NULL;
3054 g_free(chr->filename);
3055 chr->filename = NULL;
3056 s->connected = 0;
3057 }
3058
3059 static void tcp_chr_disconnect(CharDriverState *chr)
3060 {
3061 TCPCharDriver *s = chr->opaque;
3062
3063 if (!s->connected) {
3064 return;
3065 }
3066
3067 tcp_chr_free_connection(chr);
3068
3069 if (s->listen_ioc) {
3070 s->listen_tag = qio_channel_add_watch(
3071 QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
3072 }
3073 chr->filename = SocketAddress_to_str("disconnected:", s->addr,
3074 s->is_listen, s->is_telnet);
3075 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3076 if (s->reconnect_time) {
3077 qemu_chr_socket_restart_timer(chr);
3078 }
3079 }
3080
3081 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
3082 {
3083 CharDriverState *chr = opaque;
3084 TCPCharDriver *s = chr->opaque;
3085 uint8_t buf[READ_BUF_LEN];
3086 int len, size;
3087
3088 if (!s->connected || s->max_size <= 0) {
3089 return TRUE;
3090 }
3091 len = sizeof(buf);
3092 if (len > s->max_size)
3093 len = s->max_size;
3094 size = tcp_chr_recv(chr, (void *)buf, len);
3095 if (size == 0 || size == -1) {
3096 /* connection closed */
3097 tcp_chr_disconnect(chr);
3098 } else if (size > 0) {
3099 if (s->do_telnetopt)
3100 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
3101 if (size > 0)
3102 qemu_chr_be_write(chr, buf, size);
3103 }
3104
3105 return TRUE;
3106 }
3107
3108 static int tcp_chr_sync_read(CharDriverState *chr, const uint8_t *buf, int len)
3109 {
3110 TCPCharDriver *s = chr->opaque;
3111 int size;
3112
3113 if (!s->connected) {
3114 return 0;
3115 }
3116
3117 size = tcp_chr_recv(chr, (void *) buf, len);
3118 if (size == 0) {
3119 /* connection closed */
3120 tcp_chr_disconnect(chr);
3121 }
3122
3123 return size;
3124 }
3125
3126 static void tcp_chr_connect(void *opaque)
3127 {
3128 CharDriverState *chr = opaque;
3129 TCPCharDriver *s = chr->opaque;
3130
3131 g_free(chr->filename);
3132 chr->filename = sockaddr_to_str(
3133 &s->sioc->localAddr, s->sioc->localAddrLen,
3134 &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
3135 s->is_listen, s->is_telnet);
3136
3137 s->connected = 1;
3138 if (s->ioc) {
3139 chr->fd_in_tag = io_add_watch_poll(s->ioc,
3140 tcp_chr_read_poll,
3141 tcp_chr_read,
3142 chr, NULL);
3143 }
3144 qemu_chr_be_generic_open(chr);
3145 }
3146
3147 static void tcp_chr_update_read_handler(CharDriverState *chr,
3148 GMainContext *context)
3149 {
3150 TCPCharDriver *s = chr->opaque;
3151
3152 if (!s->connected) {
3153 return;
3154 }
3155
3156 remove_fd_in_watch(chr);
3157 if (s->ioc) {
3158 chr->fd_in_tag = io_add_watch_poll(s->ioc,
3159 tcp_chr_read_poll,
3160 tcp_chr_read, chr,
3161 context);
3162 }
3163 }
3164
3165 typedef struct {
3166 CharDriverState *chr;
3167 char buf[12];
3168 size_t buflen;
3169 } TCPCharDriverTelnetInit;
3170
3171 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
3172 GIOCondition cond G_GNUC_UNUSED,
3173 gpointer user_data)
3174 {
3175 TCPCharDriverTelnetInit *init = user_data;
3176 ssize_t ret;
3177
3178 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
3179 if (ret < 0) {
3180 if (ret == QIO_CHANNEL_ERR_BLOCK) {
3181 ret = 0;
3182 } else {
3183 tcp_chr_disconnect(init->chr);
3184 return FALSE;
3185 }
3186 }
3187 init->buflen -= ret;
3188
3189 if (init->buflen == 0) {
3190 tcp_chr_connect(init->chr);
3191 return FALSE;
3192 }
3193
3194 memmove(init->buf, init->buf + ret, init->buflen);
3195
3196 return TRUE;
3197 }
3198
3199 static void tcp_chr_telnet_init(CharDriverState *chr)
3200 {
3201 TCPCharDriver *s = chr->opaque;
3202 TCPCharDriverTelnetInit *init =
3203 g_new0(TCPCharDriverTelnetInit, 1);
3204 size_t n = 0;
3205
3206 init->chr = chr;
3207 init->buflen = 12;
3208
3209 #define IACSET(x, a, b, c) \
3210 do { \
3211 x[n++] = a; \
3212 x[n++] = b; \
3213 x[n++] = c; \
3214 } while (0)
3215
3216 /* Prep the telnet negotion to put telnet in binary,
3217 * no echo, single char mode */
3218 IACSET(init->buf, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
3219 IACSET(init->buf, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
3220 IACSET(init->buf, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
3221 IACSET(init->buf, 0xff, 0xfd, 0x00); /* IAC DO Binary */
3222
3223 #undef IACSET
3224
3225 qio_channel_add_watch(
3226 s->ioc, G_IO_OUT,
3227 tcp_chr_telnet_init_io,
3228 init, NULL);
3229 }
3230
3231
3232 static void tcp_chr_tls_handshake(Object *source,
3233 Error *err,
3234 gpointer user_data)
3235 {
3236 CharDriverState *chr = user_data;
3237 TCPCharDriver *s = chr->opaque;
3238
3239 if (err) {
3240 tcp_chr_disconnect(chr);
3241 } else {
3242 if (s->do_telnetopt) {
3243 tcp_chr_telnet_init(chr);
3244 } else {
3245 tcp_chr_connect(chr);
3246 }
3247 }
3248 }
3249
3250
3251 static void tcp_chr_tls_init(CharDriverState *chr)
3252 {
3253 TCPCharDriver *s = chr->opaque;
3254 QIOChannelTLS *tioc;
3255 Error *err = NULL;
3256
3257 if (s->is_listen) {
3258 tioc = qio_channel_tls_new_server(
3259 s->ioc, s->tls_creds,
3260 NULL, /* XXX Use an ACL */
3261 &err);
3262 } else {
3263 tioc = qio_channel_tls_new_client(
3264 s->ioc, s->tls_creds,
3265 s->addr->u.inet.data->host,
3266 &err);
3267 }
3268 if (tioc == NULL) {
3269 error_free(err);
3270 tcp_chr_disconnect(chr);
3271 return;
3272 }
3273 object_unref(OBJECT(s->ioc));
3274 s->ioc = QIO_CHANNEL(tioc);
3275
3276 qio_channel_tls_handshake(tioc,
3277 tcp_chr_tls_handshake,
3278 chr,
3279 NULL);
3280 }
3281
3282
3283 static int tcp_chr_new_client(CharDriverState *chr, QIOChannelSocket *sioc)
3284 {
3285 TCPCharDriver *s = chr->opaque;
3286 if (s->ioc != NULL) {
3287 return -1;
3288 }
3289
3290 s->ioc = QIO_CHANNEL(sioc);
3291 object_ref(OBJECT(sioc));
3292 s->sioc = sioc;
3293 object_ref(OBJECT(sioc));
3294
3295 qio_channel_set_blocking(s->ioc, false, NULL);
3296
3297 if (s->do_nodelay) {
3298 qio_channel_set_delay(s->ioc, false);
3299 }
3300 if (s->listen_tag) {
3301 g_source_remove(s->listen_tag);
3302 s->listen_tag = 0;
3303 }
3304
3305 if (s->tls_creds) {
3306 tcp_chr_tls_init(chr);
3307 } else {
3308 if (s->do_telnetopt) {
3309 tcp_chr_telnet_init(chr);
3310 } else {
3311 tcp_chr_connect(chr);
3312 }
3313 }
3314
3315 return 0;
3316 }
3317
3318
3319 static int tcp_chr_add_client(CharDriverState *chr, int fd)
3320 {
3321 int ret;
3322 QIOChannelSocket *sioc;
3323
3324 sioc = qio_channel_socket_new_fd(fd, NULL);
3325 if (!sioc) {
3326 return -1;
3327 }
3328 ret = tcp_chr_new_client(chr, sioc);
3329 object_unref(OBJECT(sioc));
3330 return ret;
3331 }
3332
3333 static gboolean tcp_chr_accept(QIOChannel *channel,
3334 GIOCondition cond,
3335 void *opaque)
3336 {
3337 CharDriverState *chr = opaque;
3338 QIOChannelSocket *sioc;
3339
3340 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
3341 NULL);
3342 if (!sioc) {
3343 return TRUE;
3344 }
3345
3346 tcp_chr_new_client(chr, sioc);
3347
3348 object_unref(OBJECT(sioc));
3349
3350 return TRUE;
3351 }
3352
3353 static int tcp_chr_wait_connected(CharDriverState *chr, Error **errp)
3354 {
3355 TCPCharDriver *s = chr->opaque;
3356 QIOChannelSocket *sioc;
3357
3358 /* It can't wait on s->connected, since it is set asynchronously
3359 * in TLS and telnet cases, only wait for an accepted socket */
3360 while (!s->ioc) {
3361 if (s->is_listen) {
3362 fprintf(stderr, "QEMU waiting for connection on: %s\n",
3363 chr->filename);
3364 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), true, NULL);
3365 tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
3366 qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
3367 } else {
3368 sioc = qio_channel_socket_new();
3369 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
3370 object_unref(OBJECT(sioc));
3371 return -1;
3372 }
3373 tcp_chr_new_client(chr, sioc);
3374 object_unref(OBJECT(sioc));
3375 }
3376 }
3377
3378 return 0;
3379 }
3380
3381 static int qemu_chr_wait_connected(CharDriverState *chr, Error **errp)
3382 {
3383 if (chr->chr_wait_connected) {
3384 return chr->chr_wait_connected(chr, errp);
3385 }
3386
3387 return 0;
3388 }
3389
3390 int qemu_chr_fe_wait_connected(CharBackend *be, Error **errp)
3391 {
3392 if (!be->chr) {
3393 error_setg(errp, "missing associated backend");
3394 return -1;
3395 }
3396
3397 return qemu_chr_wait_connected(be->chr, errp);
3398 }
3399
3400 static void tcp_chr_free(CharDriverState *chr)
3401 {
3402 TCPCharDriver *s = chr->opaque;
3403
3404 tcp_chr_free_connection(chr);
3405
3406 if (s->reconnect_timer) {
3407 g_source_remove(s->reconnect_timer);
3408 s->reconnect_timer = 0;
3409 }
3410 qapi_free_SocketAddress(s->addr);
3411 if (s->listen_tag) {
3412 g_source_remove(s->listen_tag);
3413 s->listen_tag = 0;
3414 }
3415 if (s->listen_ioc) {
3416 object_unref(OBJECT(s->listen_ioc));
3417 }
3418 if (s->tls_creds) {
3419 object_unref(OBJECT(s->tls_creds));
3420 }
3421 g_free(s);
3422 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
3423 }
3424
3425
3426 static void qemu_chr_socket_connected(Object *src, Error *err, void *opaque)
3427 {
3428 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(src);
3429 CharDriverState *chr = opaque;
3430 TCPCharDriver *s = chr->opaque;
3431
3432 if (err) {
3433 check_report_connect_error(chr, err);
3434 object_unref(src);
3435 return;
3436 }
3437
3438 s->connect_err_reported = false;
3439 tcp_chr_new_client(chr, sioc);
3440 object_unref(OBJECT(sioc));
3441 }
3442
3443
3444 /*********************************************************/
3445 /* Ring buffer chardev */
3446
3447 typedef struct {
3448 size_t size;
3449 size_t prod;
3450 size_t cons;
3451 uint8_t *cbuf;
3452 } RingBufCharDriver;
3453
3454 static size_t ringbuf_count(const CharDriverState *chr)
3455 {
3456 const RingBufCharDriver *d = chr->opaque;
3457
3458 return d->prod - d->cons;
3459 }
3460
3461 /* Called with chr_write_lock held. */
3462 static int ringbuf_chr_write(CharDriverState *chr, const uint8_t *buf, int len)
3463 {
3464 RingBufCharDriver *d = chr->opaque;
3465 int i;
3466
3467 if (!buf || (len < 0)) {
3468 return -1;
3469 }
3470
3471 for (i = 0; i < len; i++ ) {
3472 d->cbuf[d->prod++ & (d->size - 1)] = buf[i];
3473 if (d->prod - d->cons > d->size) {
3474 d->cons = d->prod - d->size;
3475 }
3476 }
3477
3478 return len;
3479 }
3480
3481 static int ringbuf_chr_read(CharDriverState *chr, uint8_t *buf, int len)
3482 {
3483 RingBufCharDriver *d = chr->opaque;
3484 int i;
3485
3486 qemu_mutex_lock(&chr->chr_write_lock);
3487 for (i = 0; i < len && d->cons != d->prod; i++) {
3488 buf[i] = d->cbuf[d->cons++ & (d->size - 1)];
3489 }
3490 qemu_mutex_unlock(&chr->chr_write_lock);
3491
3492 return i;
3493 }
3494
3495 static void ringbuf_chr_free(struct CharDriverState *chr)
3496 {
3497 RingBufCharDriver *d = chr->opaque;
3498
3499 g_free(d->cbuf);
3500 g_free(d);
3501 chr->opaque = NULL;
3502 }
3503
3504 static CharDriverState *qemu_chr_open_ringbuf(const char *id,
3505 ChardevBackend *backend,
3506 ChardevReturn *ret,
3507 Error **errp)
3508 {
3509 ChardevRingbuf *opts = backend->u.ringbuf.data;
3510 ChardevCommon *common = qapi_ChardevRingbuf_base(opts);
3511 CharDriverState *chr;
3512 RingBufCharDriver *d;
3513
3514 chr = qemu_chr_alloc(common, errp);
3515 if (!chr) {
3516 return NULL;
3517 }
3518 d = g_malloc(sizeof(*d));
3519
3520 d->size = opts->has_size ? opts->size : 65536;
3521
3522 /* The size must be power of 2 */
3523 if (d->size & (d->size - 1)) {
3524 error_setg(errp, "size of ringbuf chardev must be power of two");
3525 goto fail;
3526 }
3527
3528 d->prod = 0;
3529 d->cons = 0;
3530 d->cbuf = g_malloc0(d->size);
3531
3532 chr->opaque = d;
3533 chr->chr_write = ringbuf_chr_write;
3534 chr->chr_free = ringbuf_chr_free;
3535
3536 return chr;
3537
3538 fail:
3539 g_free(d);
3540 qemu_chr_free_common(chr);
3541 return NULL;
3542 }
3543
3544 bool chr_is_ringbuf(const CharDriverState *chr)
3545 {
3546 return chr->chr_write == ringbuf_chr_write;
3547 }
3548
3549 void qmp_ringbuf_write(const char *device, const char *data,
3550 bool has_format, enum DataFormat format,
3551 Error **errp)
3552 {
3553 CharDriverState *chr;
3554 const uint8_t *write_data;
3555 int ret;
3556 gsize write_count;
3557
3558 chr = qemu_chr_find(device);
3559 if (!chr) {
3560 error_setg(errp, "Device '%s' not found", device);
3561 return;
3562 }
3563
3564 if (!chr_is_ringbuf(chr)) {
3565 error_setg(errp,"%s is not a ringbuf device", device);
3566 return;
3567 }
3568
3569 if (has_format && (format == DATA_FORMAT_BASE64)) {
3570 write_data = qbase64_decode(data, -1,
3571 &write_count,
3572 errp);
3573 if (!write_data) {
3574 return;
3575 }
3576 } else {
3577 write_data = (uint8_t *)data;
3578 write_count = strlen(data);
3579 }
3580
3581 ret = ringbuf_chr_write(chr, write_data, write_count);
3582
3583 if (write_data != (uint8_t *)data) {
3584 g_free((void *)write_data);
3585 }
3586
3587 if (ret < 0) {
3588 error_setg(errp, "Failed to write to device %s", device);
3589 return;
3590 }
3591 }
3592
3593 char *qmp_ringbuf_read(const char *device, int64_t size,
3594 bool has_format, enum DataFormat format,
3595 Error **errp)
3596 {
3597 CharDriverState *chr;
3598 uint8_t *read_data;
3599 size_t count;
3600 char *data;
3601
3602 chr = qemu_chr_find(device);
3603 if (!chr) {
3604 error_setg(errp, "Device '%s' not found", device);
3605 return NULL;
3606 }
3607
3608 if (!chr_is_ringbuf(chr)) {
3609 error_setg(errp,"%s is not a ringbuf device", device);
3610 return NULL;
3611 }
3612
3613 if (size <= 0) {
3614 error_setg(errp, "size must be greater than zero");
3615 return NULL;
3616 }
3617
3618 count = ringbuf_count(chr);
3619 size = size > count ? count : size;
3620 read_data = g_malloc(size + 1);
3621
3622 ringbuf_chr_read(chr, read_data, size);
3623
3624 if (has_format && (format == DATA_FORMAT_BASE64)) {
3625 data = g_base64_encode(read_data, size);
3626 g_free(read_data);
3627 } else {
3628 /*
3629 * FIXME should read only complete, valid UTF-8 characters up
3630 * to @size bytes. Invalid sequences should be replaced by a
3631 * suitable replacement character. Except when (and only
3632 * when) ring buffer lost characters since last read, initial
3633 * continuation characters should be dropped.
3634 */
3635 read_data[size] = 0;
3636 data = (char *)read_data;
3637 }
3638
3639 return data;
3640 }
3641
3642 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename)
3643 {
3644 char host[65], port[33], width[8], height[8];
3645 int pos;
3646 const char *p;
3647 QemuOpts *opts;
3648 Error *local_err = NULL;
3649
3650 opts = qemu_opts_create(qemu_find_opts("chardev"), label, 1, &local_err);
3651 if (local_err) {
3652 error_report_err(local_err);
3653 return NULL;
3654 }
3655
3656 if (strstart(filename, "mon:", &p)) {
3657 filename = p;
3658 qemu_opt_set(opts, "mux", "on", &error_abort);
3659 if (strcmp(filename, "stdio") == 0) {
3660 /* Monitor is muxed to stdio: do not exit on Ctrl+C by default
3661 * but pass it to the guest. Handle this only for compat syntax,
3662 * for -chardev syntax we have special option for this.
3663 * This is what -nographic did, redirecting+muxing serial+monitor
3664 * to stdio causing Ctrl+C to be passed to guest. */
3665 qemu_opt_set(opts, "signal", "off", &error_abort);
3666 }
3667 }
3668
3669 if (strcmp(filename, "null") == 0 ||
3670 strcmp(filename, "pty") == 0 ||
3671 strcmp(filename, "msmouse") == 0 ||
3672 strcmp(filename, "braille") == 0 ||
3673 strcmp(filename, "testdev") == 0 ||
3674 strcmp(filename, "stdio") == 0) {
3675 qemu_opt_set(opts, "backend", filename, &error_abort);
3676 return opts;
3677 }
3678 if (strstart(filename, "vc", &p)) {
3679 qemu_opt_set(opts, "backend", "vc", &error_abort);
3680 if (*p == ':') {
3681 if (sscanf(p+1, "%7[0-9]x%7[0-9]", width, height) == 2) {
3682 /* pixels */
3683 qemu_opt_set(opts, "width", width, &error_abort);
3684 qemu_opt_set(opts, "height", height, &error_abort);
3685 } else if (sscanf(p+1, "%7[0-9]Cx%7[0-9]C", width, height) == 2) {
3686 /* chars */
3687 qemu_opt_set(opts, "cols", width, &error_abort);
3688 qemu_opt_set(opts, "rows", height, &error_abort);
3689 } else {
3690 goto fail;
3691 }
3692 }
3693 return opts;
3694 }
3695 if (strcmp(filename, "con:") == 0) {
3696 qemu_opt_set(opts, "backend", "console", &error_abort);
3697 return opts;
3698 }
3699 if (strstart(filename, "COM", NULL)) {
3700 qemu_opt_set(opts, "backend", "serial", &error_abort);
3701 qemu_opt_set(opts, "path", filename, &error_abort);
3702 return opts;
3703 }
3704 if (strstart(filename, "file:", &p)) {
3705 qemu_opt_set(opts, "backend", "file", &error_abort);
3706 qemu_opt_set(opts, "path", p, &error_abort);
3707 return opts;
3708 }
3709 if (strstart(filename, "pipe:", &p)) {
3710 qemu_opt_set(opts, "backend", "pipe", &error_abort);
3711 qemu_opt_set(opts, "path", p, &error_abort);
3712 return opts;
3713 }
3714 if (strstart(filename, "tcp:", &p) ||
3715 strstart(filename, "telnet:", &p)) {
3716 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3717 host[0] = 0;
3718 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1)
3719 goto fail;
3720 }
3721 qemu_opt_set(opts, "backend", "socket", &error_abort);
3722 qemu_opt_set(opts, "host", host, &error_abort);
3723 qemu_opt_set(opts, "port", port, &error_abort);
3724 if (p[pos] == ',') {
3725 qemu_opts_do_parse(opts, p+pos+1, NULL, &local_err);
3726 if (local_err) {
3727 error_report_err(local_err);
3728 goto fail;
3729 }
3730 }
3731 if (strstart(filename, "telnet:", &p))
3732 qemu_opt_set(opts, "telnet", "on", &error_abort);
3733 return opts;
3734 }
3735 if (strstart(filename, "udp:", &p)) {
3736 qemu_opt_set(opts, "backend", "udp", &error_abort);
3737 if (sscanf(p, "%64[^:]:%32[^@,]%n", host, port, &pos) < 2) {
3738 host[0] = 0;
3739 if (sscanf(p, ":%32[^@,]%n", port, &pos) < 1) {
3740 goto fail;
3741 }
3742 }
3743 qemu_opt_set(opts, "host", host, &error_abort);
3744 qemu_opt_set(opts, "port", port, &error_abort);
3745 if (p[pos] == '@') {
3746 p += pos + 1;
3747 if (sscanf(p, "%64[^:]:%32[^,]%n", host, port, &pos) < 2) {
3748 host[0] = 0;
3749 if (sscanf(p, ":%32[^,]%n", port, &pos) < 1) {
3750 goto fail;
3751 }
3752 }
3753 qemu_opt_set(opts, "localaddr", host, &error_abort);
3754 qemu_opt_set(opts, "localport", port, &error_abort);
3755 }
3756 return opts;
3757 }
3758 if (strstart(filename, "unix:", &p)) {
3759 qemu_opt_set(opts, "backend", "socket", &error_abort);
3760 qemu_opts_do_parse(opts, p, "path", &local_err);
3761 if (local_err) {
3762 error_report_err(local_err);
3763 goto fail;
3764 }
3765 return opts;
3766 }
3767 if (strstart(filename, "/dev/parport", NULL) ||
3768 strstart(filename, "/dev/ppi", NULL)) {
3769 qemu_opt_set(opts, "backend", "parport", &error_abort);
3770 qemu_opt_set(opts, "path", filename, &error_abort);
3771 return opts;
3772 }
3773 if (strstart(filename, "/dev/", NULL)) {
3774 qemu_opt_set(opts, "backend", "tty", &error_abort);
3775 qemu_opt_set(opts, "path", filename, &error_abort);
3776 return opts;
3777 }
3778
3779 fail:
3780 qemu_opts_del(opts);
3781 return NULL;
3782 }
3783
3784 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend)
3785 {
3786 const char *logfile = qemu_opt_get(opts, "logfile");
3787
3788 backend->has_logfile = logfile != NULL;
3789 backend->logfile = logfile ? g_strdup(logfile) : NULL;
3790
3791 backend->has_logappend = true;
3792 backend->logappend = qemu_opt_get_bool(opts, "logappend", false);
3793 }
3794
3795
3796 static void qemu_chr_parse_file_out(QemuOpts *opts, ChardevBackend *backend,
3797 Error **errp)
3798 {
3799 const char *path = qemu_opt_get(opts, "path");
3800 ChardevFile *file;
3801
3802 if (path == NULL) {
3803 error_setg(errp, "chardev: file: no filename given");
3804 return;
3805 }
3806 file = backend->u.file.data = g_new0(ChardevFile, 1);
3807 qemu_chr_parse_common(opts, qapi_ChardevFile_base(file));
3808 file->out = g_strdup(path);
3809
3810 file->has_append = true;
3811 file->append = qemu_opt_get_bool(opts, "append", false);
3812 }
3813
3814 static void qemu_chr_parse_stdio(QemuOpts *opts, ChardevBackend *backend,
3815 Error **errp)
3816 {
3817 ChardevStdio *stdio;
3818
3819 stdio = backend->u.stdio.data = g_new0(ChardevStdio, 1);
3820 qemu_chr_parse_common(opts, qapi_ChardevStdio_base(stdio));
3821 stdio->has_signal = true;
3822 stdio->signal = qemu_opt_get_bool(opts, "signal", true);
3823 }
3824
3825 #ifdef HAVE_CHARDEV_SERIAL
3826 static void qemu_chr_parse_serial(QemuOpts *opts, ChardevBackend *backend,
3827 Error **errp)
3828 {
3829 const char *device = qemu_opt_get(opts, "path");
3830 ChardevHostdev *serial;
3831
3832 if (device == NULL) {
3833 error_setg(errp, "chardev: serial/tty: no device path given");
3834 return;
3835 }
3836 serial = backend->u.serial.data = g_new0(ChardevHostdev, 1);
3837 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(serial));
3838 serial->device = g_strdup(device);
3839 }
3840 #endif
3841
3842 #ifdef HAVE_CHARDEV_PARPORT
3843 static void qemu_chr_parse_parallel(QemuOpts *opts, ChardevBackend *backend,
3844 Error **errp)
3845 {
3846 const char *device = qemu_opt_get(opts, "path");
3847 ChardevHostdev *parallel;
3848
3849 if (device == NULL) {
3850 error_setg(errp, "chardev: parallel: no device path given");
3851 return;
3852 }
3853 parallel = backend->u.parallel.data = g_new0(ChardevHostdev, 1);
3854 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(parallel));
3855 parallel->device = g_strdup(device);
3856 }
3857 #endif
3858
3859 static void qemu_chr_parse_pipe(QemuOpts *opts, ChardevBackend *backend,
3860 Error **errp)
3861 {
3862 const char *device = qemu_opt_get(opts, "path");
3863 ChardevHostdev *dev;
3864
3865 if (device == NULL) {
3866 error_setg(errp, "chardev: pipe: no device path given");
3867 return;
3868 }
3869 dev = backend->u.pipe.data = g_new0(ChardevHostdev, 1);
3870 qemu_chr_parse_common(opts, qapi_ChardevHostdev_base(dev));
3871 dev->device = g_strdup(device);
3872 }
3873
3874 static void qemu_chr_parse_ringbuf(QemuOpts *opts, ChardevBackend *backend,
3875 Error **errp)
3876 {
3877 int val;
3878 ChardevRingbuf *ringbuf;
3879
3880 ringbuf = backend->u.ringbuf.data = g_new0(ChardevRingbuf, 1);
3881 qemu_chr_parse_common(opts, qapi_ChardevRingbuf_base(ringbuf));
3882
3883 val = qemu_opt_get_size(opts, "size", 0);
3884 if (val != 0) {
3885 ringbuf->has_size = true;
3886 ringbuf->size = val;
3887 }
3888 }
3889
3890 static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
3891 Error **errp)
3892 {
3893 const char *chardev = qemu_opt_get(opts, "chardev");
3894 ChardevMux *mux;
3895
3896 if (chardev == NULL) {
3897 error_setg(errp, "chardev: mux: no chardev given");
3898 return;
3899 }
3900 mux = backend->u.mux.data = g_new0(ChardevMux, 1);
3901 qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
3902 mux->chardev = g_strdup(chardev);
3903 }
3904
3905 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
3906 Error **errp)
3907 {
3908 bool is_listen = qemu_opt_get_bool(opts, "server", false);
3909 bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
3910 bool is_telnet = qemu_opt_get_bool(opts, "telnet", false);
3911 bool do_nodelay = !qemu_opt_get_bool(opts, "delay", true);
3912 int64_t reconnect = qemu_opt_get_number(opts, "reconnect", 0);
3913 const char *path = qemu_opt_get(opts, "path");
3914 const char *host = qemu_opt_get(opts, "host");
3915 const char *port = qemu_opt_get(opts, "port");
3916 const char *tls_creds = qemu_opt_get(opts, "tls-creds");
3917 SocketAddress *addr;
3918 ChardevSocket *sock;
3919
3920 if (!path) {
3921 if (!host) {
3922 error_setg(errp, "chardev: socket: no host given");
3923 return;
3924 }
3925 if (!port) {
3926 error_setg(errp, "chardev: socket: no port given");
3927 return;
3928 }
3929 } else {
3930 if (tls_creds) {
3931 error_setg(errp, "TLS can only be used over TCP socket");
3932 return;
3933 }
3934 }
3935
3936 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
3937 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
3938
3939 sock->has_nodelay = true;
3940 sock->nodelay = do_nodelay;
3941 sock->has_server = true;
3942 sock->server = is_listen;
3943 sock->has_telnet = true;
3944 sock->telnet = is_telnet;
3945 sock->has_wait = true;
3946 sock->wait = is_waitconnect;
3947 sock->has_reconnect = true;
3948 sock->reconnect = reconnect;
3949 sock->tls_creds = g_strdup(tls_creds);
3950
3951 addr = g_new0(SocketAddress, 1);
3952 if (path) {
3953 UnixSocketAddress *q_unix;
3954 addr->type = SOCKET_ADDRESS_KIND_UNIX;
3955 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
3956 q_unix->path = g_strdup(path);
3957 } else {
3958 addr->type = SOCKET_ADDRESS_KIND_INET;
3959 addr->u.inet.data = g_new(InetSocketAddress, 1);
3960 *addr->u.inet.data = (InetSocketAddress) {
3961 .host = g_strdup(host),
3962 .port = g_strdup(port),
3963 .has_to = qemu_opt_get(opts, "to"),
3964 .to = qemu_opt_get_number(opts, "to", 0),
3965 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
3966 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
3967 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
3968 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
3969 };
3970 }
3971 sock->addr = addr;
3972 }
3973
3974 static void qemu_chr_parse_udp(QemuOpts *opts, ChardevBackend *backend,
3975 Error **errp)
3976 {
3977 const char *host = qemu_opt_get(opts, "host");
3978 const char *port = qemu_opt_get(opts, "port");
3979 const char *localaddr = qemu_opt_get(opts, "localaddr");
3980 const char *localport = qemu_opt_get(opts, "localport");
3981 bool has_local = false;
3982 SocketAddress *addr;
3983 ChardevUdp *udp;
3984
3985 if (host == NULL || strlen(host) == 0) {
3986 host = "localhost";
3987 }
3988 if (port == NULL || strlen(port) == 0) {
3989 error_setg(errp, "chardev: udp: remote port not specified");
3990 return;
3991 }
3992 if (localport == NULL || strlen(localport) == 0) {
3993 localport = "0";
3994 } else {
3995 has_local = true;
3996 }
3997 if (localaddr == NULL || strlen(localaddr) == 0) {
3998 localaddr = "";
3999 } else {
4000 has_local = true;
4001 }
4002
4003 udp = backend->u.udp.data = g_new0(ChardevUdp, 1);
4004 qemu_chr_parse_common(opts, qapi_ChardevUdp_base(udp));
4005
4006 addr = g_new0(SocketAddress, 1);
4007 addr->type = SOCKET_ADDRESS_KIND_INET;
4008 addr->u.inet.data = g_new(InetSocketAddress, 1);
4009 *addr->u.inet.data = (InetSocketAddress) {
4010 .host = g_strdup(host),
4011 .port = g_strdup(port),
4012 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
4013 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
4014 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
4015 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
4016 };
4017 udp->remote = addr;
4018
4019 if (has_local) {
4020 udp->has_local = true;
4021 addr = g_new0(SocketAddress, 1);
4022 addr->type = SOCKET_ADDRESS_KIND_INET;
4023 addr->u.inet.data = g_new(InetSocketAddress, 1);
4024 *addr->u.inet.data = (InetSocketAddress) {
4025 .host = g_strdup(localaddr),
4026 .port = g_strdup(localport),
4027 };
4028 udp->local = addr;
4029 }
4030 }
4031
4032 typedef struct CharDriver {
4033 const char *name;
4034 ChardevBackendKind kind;
4035 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp);
4036 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
4037 ChardevReturn *ret, Error **errp);
4038 } CharDriver;
4039
4040 static GSList *backends;
4041
4042 void register_char_driver(const char *name, ChardevBackendKind kind,
4043 void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
4044 CharDriverState *(*create)(const char *id, ChardevBackend *backend,
4045 ChardevReturn *ret, Error **errp))
4046 {
4047 CharDriver *s;
4048
4049 s = g_malloc0(sizeof(*s));
4050 s->name = g_strdup(name);
4051 s->kind = kind;
4052 s->parse = parse;
4053 s->create = create;
4054
4055 backends = g_slist_append(backends, s);
4056 }
4057
4058 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
4059 Error **errp)
4060 {
4061 Error *local_err = NULL;
4062 CharDriver *cd;
4063 CharDriverState *chr;
4064 GSList *i;
4065 ChardevReturn *ret = NULL;
4066 ChardevBackend *backend;
4067 const char *id = qemu_opts_id(opts);
4068 char *bid = NULL;
4069
4070 if (qemu_opt_get(opts, "backend") == NULL) {
4071 error_setg(errp, "chardev: \"%s\" missing backend",
4072 qemu_opts_id(opts));
4073 goto err;
4074 }
4075
4076 if (is_help_option(qemu_opt_get(opts, "backend"))) {
4077 fprintf(stderr, "Available chardev backend types:\n");
4078 for (i = backends; i; i = i->next) {
4079 cd = i->data;
4080 fprintf(stderr, "%s\n", cd->name);
4081 }
4082 exit(!is_help_option(qemu_opt_get(opts, "backend")));
4083 }
4084
4085 if (id == NULL) {
4086 error_setg(errp, "chardev: no id specified");
4087 goto err;
4088 }
4089
4090 for (i = backends; i; i = i->next) {
4091 cd = i->data;
4092
4093 if (strcmp(cd->name, qemu_opt_get(opts, "backend")) == 0) {
4094 break;
4095 }
4096 }
4097 if (i == NULL) {
4098 error_setg(errp, "chardev: backend \"%s\" not found",
4099 qemu_opt_get(opts, "backend"));
4100 goto err;
4101 }
4102
4103 backend = g_new0(ChardevBackend, 1);
4104
4105 if (qemu_opt_get_bool(opts, "mux", 0)) {
4106 bid = g_strdup_printf("%s-base", id);
4107 }
4108
4109 chr = NULL;
4110 backend->type = cd->kind;
4111 if (cd->parse) {
4112 cd->parse(opts, backend, &local_err);
4113 if (local_err) {
4114 error_propagate(errp, local_err);
4115 goto qapi_out;
4116 }
4117 } else {
4118 ChardevCommon *cc = g_new0(ChardevCommon, 1);
4119 qemu_chr_parse_common(opts, cc);
4120 backend->u.null.data = cc; /* Any ChardevCommon member would work */
4121 }
4122
4123 ret = qmp_chardev_add(bid ? bid : id, backend, errp);
4124 if (!ret) {
4125 goto qapi_out;
4126 }
4127
4128 if (bid) {
4129 qapi_free_ChardevBackend(backend);
4130 qapi_free_ChardevReturn(ret);
4131 backend = g_new0(ChardevBackend, 1);
4132 backend->u.mux.data = g_new0(ChardevMux, 1);
4133 backend->type = CHARDEV_BACKEND_KIND_MUX;
4134 backend->u.mux.data->chardev = g_strdup(bid);
4135 ret = qmp_chardev_add(id, backend, errp);
4136 if (!ret) {
4137 chr = qemu_chr_find(bid);
4138 qemu_chr_delete(chr);
4139 chr = NULL;
4140 goto qapi_out;
4141 }
4142 }
4143
4144 chr = qemu_chr_find(id);
4145
4146 qapi_out:
4147 qapi_free_ChardevBackend(backend);
4148 qapi_free_ChardevReturn(ret);
4149 g_free(bid);
4150 return chr;
4151
4152 err:
4153 return NULL;
4154 }
4155
4156 CharDriverState *qemu_chr_new_noreplay(const char *label, const char *filename)
4157 {
4158 const char *p;
4159 CharDriverState *chr;
4160 QemuOpts *opts;
4161 Error *err = NULL;
4162
4163 if (strstart(filename, "chardev:", &p)) {
4164 return qemu_chr_find(p);
4165 }
4166
4167 opts = qemu_chr_parse_compat(label, filename);
4168 if (!opts)
4169 return NULL;
4170
4171 chr = qemu_chr_new_from_opts(opts, &err);
4172 if (err) {
4173 error_report_err(err);
4174 }
4175 if (chr && qemu_opt_get_bool(opts, "mux", 0)) {
4176 monitor_init(chr, MONITOR_USE_READLINE);
4177 }
4178 qemu_opts_del(opts);
4179 return chr;
4180 }
4181
4182 CharDriverState *qemu_chr_new(const char *label, const char *filename)
4183 {
4184 CharDriverState *chr;
4185 chr = qemu_chr_new_noreplay(label, filename);
4186 if (chr) {
4187 chr->replay = replay_mode != REPLAY_MODE_NONE;
4188 if (chr->replay && chr->chr_ioctl) {
4189 fprintf(stderr,
4190 "Replay: ioctl is not supported for serial devices yet\n");
4191 }
4192 replay_register_char_driver(chr);
4193 }
4194 return chr;
4195 }
4196
4197 void qemu_chr_fe_set_echo(CharBackend *be, bool echo)
4198 {
4199 CharDriverState *chr = be->chr;
4200
4201 if (chr && chr->chr_set_echo) {
4202 chr->chr_set_echo(chr, echo);
4203 }
4204 }
4205
4206 void qemu_chr_fe_set_open(CharBackend *be, int fe_open)
4207 {
4208 CharDriverState *chr = be->chr;
4209
4210 if (!chr) {
4211 return;
4212 }
4213
4214 if (be->fe_open == fe_open) {
4215 return;
4216 }
4217 be->fe_open = fe_open;
4218 if (chr->chr_set_fe_open) {
4219 chr->chr_set_fe_open(chr, fe_open);
4220 }
4221 }
4222
4223 guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
4224 GIOFunc func, void *user_data)
4225 {
4226 CharDriverState *s = be->chr;
4227 GSource *src;
4228 guint tag;
4229
4230 if (!s || s->chr_add_watch == NULL) {
4231 return 0;
4232 }
4233
4234 src = s->chr_add_watch(s, cond);
4235 if (!src) {
4236 return 0;
4237 }
4238
4239 g_source_set_callback(src, (GSourceFunc)func, user_data, NULL);
4240 tag = g_source_attach(src, NULL);
4241 g_source_unref(src);
4242
4243 return tag;
4244 }
4245
4246 void qemu_chr_fe_disconnect(CharBackend *be)
4247 {
4248 CharDriverState *chr = be->chr;
4249
4250 if (chr && chr->chr_disconnect) {
4251 chr->chr_disconnect(chr);
4252 }
4253 }
4254
4255 static void qemu_chr_free_common(CharDriverState *chr)
4256 {
4257 if (chr->be) {
4258 chr->be->chr = NULL;
4259 }
4260 g_free(chr->filename);
4261 g_free(chr->label);
4262 if (chr->logfd != -1) {
4263 close(chr->logfd);
4264 }
4265 qemu_mutex_destroy(&chr->chr_write_lock);
4266 g_free(chr);
4267 }
4268
4269 void qemu_chr_free(CharDriverState *chr)
4270 {
4271 if (chr->chr_free) {
4272 chr->chr_free(chr);
4273 }
4274 qemu_chr_free_common(chr);
4275 }
4276
4277 void qemu_chr_delete(CharDriverState *chr)
4278 {
4279 QTAILQ_REMOVE(&chardevs, chr, next);
4280 qemu_chr_free(chr);
4281 }
4282
4283 ChardevInfoList *qmp_query_chardev(Error **errp)
4284 {
4285 ChardevInfoList *chr_list = NULL;
4286 CharDriverState *chr;
4287
4288 QTAILQ_FOREACH(chr, &chardevs, next) {
4289 ChardevInfoList *info = g_malloc0(sizeof(*info));
4290 info->value = g_malloc0(sizeof(*info->value));
4291 info->value->label = g_strdup(chr->label);
4292 info->value->filename = g_strdup(chr->filename);
4293 info->value->frontend_open = chr->be && chr->be->fe_open;
4294
4295 info->next = chr_list;
4296 chr_list = info;
4297 }
4298
4299 return chr_list;
4300 }
4301
4302 ChardevBackendInfoList *qmp_query_chardev_backends(Error **errp)
4303 {
4304 ChardevBackendInfoList *backend_list = NULL;
4305 CharDriver *c = NULL;
4306 GSList *i = NULL;
4307
4308 for (i = backends; i; i = i->next) {
4309 ChardevBackendInfoList *info = g_malloc0(sizeof(*info));
4310 c = i->data;
4311 info->value = g_malloc0(sizeof(*info->value));
4312 info->value->name = g_strdup(c->name);
4313
4314 info->next = backend_list;
4315 backend_list = info;
4316 }
4317
4318 return backend_list;
4319 }
4320
4321 CharDriverState *qemu_chr_find(const char *name)
4322 {
4323 CharDriverState *chr;
4324
4325 QTAILQ_FOREACH(chr, &chardevs, next) {
4326 if (strcmp(chr->label, name) != 0)
4327 continue;
4328 return chr;
4329 }
4330 return NULL;
4331 }
4332
4333 QemuOptsList qemu_chardev_opts = {
4334 .name = "chardev",
4335 .implied_opt_name = "backend",
4336 .head = QTAILQ_HEAD_INITIALIZER(qemu_chardev_opts.head),
4337 .desc = {
4338 {
4339 .name = "backend",
4340 .type = QEMU_OPT_STRING,
4341 },{
4342 .name = "path",
4343 .type = QEMU_OPT_STRING,
4344 },{
4345 .name = "host",
4346 .type = QEMU_OPT_STRING,
4347 },{
4348 .name = "port",
4349 .type = QEMU_OPT_STRING,
4350 },{
4351 .name = "localaddr",
4352 .type = QEMU_OPT_STRING,
4353 },{
4354 .name = "localport",
4355 .type = QEMU_OPT_STRING,
4356 },{
4357 .name = "to",
4358 .type = QEMU_OPT_NUMBER,
4359 },{
4360 .name = "ipv4",
4361 .type = QEMU_OPT_BOOL,
4362 },{
4363 .name = "ipv6",
4364 .type = QEMU_OPT_BOOL,
4365 },{
4366 .name = "wait",
4367 .type = QEMU_OPT_BOOL,
4368 },{
4369 .name = "server",
4370 .type = QEMU_OPT_BOOL,
4371 },{
4372 .name = "delay",
4373 .type = QEMU_OPT_BOOL,
4374 },{
4375 .name = "reconnect",
4376 .type = QEMU_OPT_NUMBER,
4377 },{
4378 .name = "telnet",
4379 .type = QEMU_OPT_BOOL,
4380 },{
4381 .name = "tls-creds",
4382 .type = QEMU_OPT_STRING,
4383 },{
4384 .name = "width",
4385 .type = QEMU_OPT_NUMBER,
4386 },{
4387 .name = "height",
4388 .type = QEMU_OPT_NUMBER,
4389 },{
4390 .name = "cols",
4391 .type = QEMU_OPT_NUMBER,
4392 },{
4393 .name = "rows",
4394 .type = QEMU_OPT_NUMBER,
4395 },{
4396 .name = "mux",
4397 .type = QEMU_OPT_BOOL,
4398 },{
4399 .name = "signal",
4400 .type = QEMU_OPT_BOOL,
4401 },{
4402 .name = "name",
4403 .type = QEMU_OPT_STRING,
4404 },{
4405 .name = "debug",
4406 .type = QEMU_OPT_NUMBER,
4407 },{
4408 .name = "size",
4409 .type = QEMU_OPT_SIZE,
4410 },{
4411 .name = "chardev",
4412 .type = QEMU_OPT_STRING,
4413 },{
4414 .name = "append",
4415 .type = QEMU_OPT_BOOL,
4416 },{
4417 .name = "logfile",
4418 .type = QEMU_OPT_STRING,
4419 },{
4420 .name = "logappend",
4421 .type = QEMU_OPT_BOOL,
4422 },
4423 { /* end of list */ }
4424 },
4425 };
4426
4427 #ifdef _WIN32
4428
4429 static CharDriverState *qmp_chardev_open_file(const char *id,
4430 ChardevBackend *backend,
4431 ChardevReturn *ret,
4432 Error **errp)
4433 {
4434 ChardevFile *file = backend->u.file.data;
4435 ChardevCommon *common = qapi_ChardevFile_base(file);
4436 HANDLE out;
4437 DWORD accessmode;
4438 DWORD flags;
4439
4440 if (file->has_in) {
4441 error_setg(errp, "input file not supported");
4442 return NULL;
4443 }
4444
4445 if (file->has_append && file->append) {
4446 /* Append to file if it already exists. */
4447 accessmode = FILE_GENERIC_WRITE & ~FILE_WRITE_DATA;
4448 flags = OPEN_ALWAYS;
4449 } else {
4450 /* Truncate file if it already exists. */
4451 accessmode = GENERIC_WRITE;
4452 flags = CREATE_ALWAYS;
4453 }
4454
4455 out = CreateFile(file->out, accessmode, FILE_SHARE_READ, NULL, flags,
4456 FILE_ATTRIBUTE_NORMAL, NULL);
4457 if (out == INVALID_HANDLE_VALUE) {
4458 error_setg(errp, "open %s failed", file->out);
4459 return NULL;
4460 }
4461 return qemu_chr_open_win_file(out, common, errp);
4462 }
4463
4464 static CharDriverState *qmp_chardev_open_serial(const char *id,
4465 ChardevBackend *backend,
4466 ChardevReturn *ret,
4467 Error **errp)
4468 {
4469 ChardevHostdev *serial = backend->u.serial.data;
4470 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4471 return qemu_chr_open_win_path(serial->device, common, errp);
4472 }
4473
4474 #else /* WIN32 */
4475
4476 static int qmp_chardev_open_file_source(char *src, int flags,
4477 Error **errp)
4478 {
4479 int fd = -1;
4480
4481 TFR(fd = qemu_open(src, flags, 0666));
4482 if (fd == -1) {
4483 error_setg_file_open(errp, errno, src);
4484 }
4485 return fd;
4486 }
4487
4488 static CharDriverState *qmp_chardev_open_file(const char *id,
4489 ChardevBackend *backend,
4490 ChardevReturn *ret,
4491 Error **errp)
4492 {
4493 ChardevFile *file = backend->u.file.data;
4494 ChardevCommon *common = qapi_ChardevFile_base(file);
4495 int flags, in = -1, out;
4496
4497 flags = O_WRONLY | O_CREAT | O_BINARY;
4498 if (file->has_append && file->append) {
4499 flags |= O_APPEND;
4500 } else {
4501 flags |= O_TRUNC;
4502 }
4503
4504 out = qmp_chardev_open_file_source(file->out, flags, errp);
4505 if (out < 0) {
4506 return NULL;
4507 }
4508
4509 if (file->has_in) {
4510 flags = O_RDONLY;
4511 in = qmp_chardev_open_file_source(file->in, flags, errp);
4512 if (in < 0) {
4513 qemu_close(out);
4514 return NULL;
4515 }
4516 }
4517
4518 return qemu_chr_open_fd(in, out, common, errp);
4519 }
4520
4521 #ifdef HAVE_CHARDEV_SERIAL
4522 static CharDriverState *qmp_chardev_open_serial(const char *id,
4523 ChardevBackend *backend,
4524 ChardevReturn *ret,
4525 Error **errp)
4526 {
4527 ChardevHostdev *serial = backend->u.serial.data;
4528 ChardevCommon *common = qapi_ChardevHostdev_base(serial);
4529 int fd;
4530
4531 fd = qmp_chardev_open_file_source(serial->device, O_RDWR, errp);
4532 if (fd < 0) {
4533 return NULL;
4534 }
4535 qemu_set_nonblock(fd);
4536 return qemu_chr_open_tty_fd(fd, common, errp);
4537 }
4538 #endif
4539
4540 #ifdef HAVE_CHARDEV_PARPORT
4541 static CharDriverState *qmp_chardev_open_parallel(const char *id,
4542 ChardevBackend *backend,
4543 ChardevReturn *ret,
4544 Error **errp)
4545 {
4546 ChardevHostdev *parallel = backend->u.parallel.data;
4547 ChardevCommon *common = qapi_ChardevHostdev_base(parallel);
4548 int fd;
4549
4550 fd = qmp_chardev_open_file_source(parallel->device, O_RDWR, errp);
4551 if (fd < 0) {
4552 return NULL;
4553 }
4554 return qemu_chr_open_pp_fd(fd, common, errp);
4555 }
4556 #endif
4557
4558 #endif /* WIN32 */
4559
4560 static gboolean socket_reconnect_timeout(gpointer opaque)
4561 {
4562 CharDriverState *chr = opaque;
4563 TCPCharDriver *s = chr->opaque;
4564 QIOChannelSocket *sioc;
4565
4566 s->reconnect_timer = 0;
4567
4568 if (chr->be_open) {
4569 return false;
4570 }
4571
4572 sioc = qio_channel_socket_new();
4573 qio_channel_socket_connect_async(sioc, s->addr,
4574 qemu_chr_socket_connected,
4575 chr, NULL);
4576
4577 return false;
4578 }
4579
4580 static CharDriverState *qmp_chardev_open_socket(const char *id,
4581 ChardevBackend *backend,
4582 ChardevReturn *ret,
4583 Error **errp)
4584 {
4585 CharDriverState *chr;
4586 TCPCharDriver *s;
4587 ChardevSocket *sock = backend->u.socket.data;
4588 SocketAddress *addr = sock->addr;
4589 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
4590 bool is_listen = sock->has_server ? sock->server : true;
4591 bool is_telnet = sock->has_telnet ? sock->telnet : false;
4592 bool is_waitconnect = sock->has_wait ? sock->wait : false;
4593 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
4594 ChardevCommon *common = qapi_ChardevSocket_base(sock);
4595 QIOChannelSocket *sioc = NULL;
4596
4597 chr = qemu_chr_alloc(common, errp);
4598 if (!chr) {
4599 return NULL;
4600 }
4601 s = g_new0(TCPCharDriver, 1);
4602
4603 s->is_unix = addr->type == SOCKET_ADDRESS_KIND_UNIX;
4604 s->is_listen = is_listen;
4605 s->is_telnet = is_telnet;
4606 s->do_nodelay = do_nodelay;
4607 if (sock->tls_creds) {
4608 Object *creds;
4609 creds = object_resolve_path_component(
4610 object_get_objects_root(), sock->tls_creds);
4611 if (!creds) {
4612 error_setg(errp, "No TLS credentials with id '%s'",
4613 sock->tls_creds);
4614 goto error;
4615 }
4616 s->tls_creds = (QCryptoTLSCreds *)
4617 object_dynamic_cast(creds,
4618 TYPE_QCRYPTO_TLS_CREDS);
4619 if (!s->tls_creds) {
4620 error_setg(errp, "Object with id '%s' is not TLS credentials",
4621 sock->tls_creds);
4622 goto error;
4623 }
4624 object_ref(OBJECT(s->tls_creds));
4625 if (is_listen) {
4626 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
4627 error_setg(errp, "%s",
4628 "Expected TLS credentials for server endpoint");
4629 goto error;
4630 }
4631 } else {
4632 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
4633 error_setg(errp, "%s",
4634 "Expected TLS credentials for client endpoint");
4635 goto error;
4636 }
4637 }
4638 }
4639
4640 s->addr = QAPI_CLONE(SocketAddress, sock->addr);
4641
4642 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
4643 if (s->is_unix) {
4644 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
4645 }
4646
4647 chr->opaque = s;
4648 chr->chr_wait_connected = tcp_chr_wait_connected;
4649 chr->chr_write = tcp_chr_write;
4650 chr->chr_sync_read = tcp_chr_sync_read;
4651 chr->chr_free = tcp_chr_free;
4652 chr->chr_disconnect = tcp_chr_disconnect;
4653 chr->get_msgfds = tcp_get_msgfds;
4654 chr->set_msgfds = tcp_set_msgfds;
4655 chr->chr_add_client = tcp_chr_add_client;
4656 chr->chr_add_watch = tcp_chr_add_watch;
4657 chr->chr_update_read_handler = tcp_chr_update_read_handler;
4658 /* be isn't opened until we get a connection */
4659 chr->explicit_be_open = true;
4660
4661 chr->filename = SocketAddress_to_str("disconnected:",
4662 addr, is_listen, is_telnet);
4663
4664 if (is_listen) {
4665 if (is_telnet) {
4666 s->do_telnetopt = 1;
4667 }
4668 } else if (reconnect > 0) {
4669 s->reconnect_time = reconnect;
4670 }
4671
4672 if (s->reconnect_time) {
4673 sioc = qio_channel_socket_new();
4674 qio_channel_socket_connect_async(sioc, s->addr,
4675 qemu_chr_socket_connected,
4676 chr, NULL);
4677 } else {
4678 if (s->is_listen) {
4679 sioc = qio_channel_socket_new();
4680 if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
4681 goto error;
4682 }
4683 s->listen_ioc = sioc;
4684 if (is_waitconnect &&
4685 qemu_chr_wait_connected(chr, errp) < 0) {
4686 goto error;
4687 }
4688 if (!s->ioc) {
4689 s->listen_tag = qio_channel_add_watch(
4690 QIO_CHANNEL(s->listen_ioc), G_IO_IN,
4691 tcp_chr_accept, chr, NULL);
4692 }
4693 } else if (qemu_chr_wait_connected(chr, errp) < 0) {
4694 goto error;
4695 }
4696 }
4697
4698 return chr;
4699
4700 error:
4701 if (sioc) {
4702 object_unref(OBJECT(sioc));
4703 }
4704 if (s->tls_creds) {
4705 object_unref(OBJECT(s->tls_creds));
4706 }
4707 g_free(s);
4708 qemu_chr_free_common(chr);
4709 return NULL;
4710 }
4711
4712 static CharDriverState *qmp_chardev_open_udp(const char *id,
4713 ChardevBackend *backend,
4714 ChardevReturn *ret,
4715 Error **errp)
4716 {
4717 ChardevUdp *udp = backend->u.udp.data;
4718 ChardevCommon *common = qapi_ChardevUdp_base(udp);
4719 QIOChannelSocket *sioc = qio_channel_socket_new();
4720
4721 if (qio_channel_socket_dgram_sync(sioc,
4722 udp->local, udp->remote,
4723 errp) < 0) {
4724 object_unref(OBJECT(sioc));
4725 return NULL;
4726 }
4727 return qemu_chr_open_udp(sioc, common, errp);
4728 }
4729
4730
4731 bool qemu_chr_has_feature(CharDriverState *chr,
4732 CharDriverFeature feature)
4733 {
4734 return test_bit(feature, chr->features);
4735 }
4736
4737 void qemu_chr_set_feature(CharDriverState *chr,
4738 CharDriverFeature feature)
4739 {
4740 return set_bit(feature, chr->features);
4741 }
4742
4743 ChardevReturn *qmp_chardev_add(const char *id, ChardevBackend *backend,
4744 Error **errp)
4745 {
4746 ChardevReturn *ret = g_new0(ChardevReturn, 1);
4747 CharDriverState *chr = NULL;
4748 Error *local_err = NULL;
4749 GSList *i;
4750 CharDriver *cd;
4751
4752 chr = qemu_chr_find(id);
4753 if (chr) {
4754 error_setg(errp, "Chardev '%s' already exists", id);
4755 goto out_error;
4756 }
4757
4758 for (i = backends; i; i = i->next) {
4759 cd = i->data;
4760
4761 if (cd->kind == backend->type) {
4762 chr = cd->create(id, backend, ret, &local_err);
4763 if (local_err) {
4764 error_propagate(errp, local_err);
4765 goto out_error;
4766 }
4767 break;
4768 }
4769 }
4770
4771 if (chr == NULL) {
4772 assert(!i);
4773 error_setg(errp, "chardev backend not available");
4774 goto out_error;
4775 }
4776
4777 chr->label = g_strdup(id);
4778 if (!chr->filename) {
4779 chr->filename = g_strdup(ChardevBackendKind_lookup[backend->type]);
4780 }
4781 if (!chr->explicit_be_open) {
4782 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
4783 }
4784 QTAILQ_INSERT_TAIL(&chardevs, chr, next);
4785 return ret;
4786
4787 out_error:
4788 g_free(ret);
4789 return NULL;
4790 }
4791
4792 void qmp_chardev_remove(const char *id, Error **errp)
4793 {
4794 CharDriverState *chr;
4795
4796 chr = qemu_chr_find(id);
4797 if (chr == NULL) {
4798 error_setg(errp, "Chardev '%s' not found", id);
4799 return;
4800 }
4801 if (qemu_chr_is_busy(chr)) {
4802 error_setg(errp, "Chardev '%s' is busy", id);
4803 return;
4804 }
4805 if (chr->replay) {
4806 error_setg(errp,
4807 "Chardev '%s' cannot be unplugged in record/replay mode", id);
4808 return;
4809 }
4810 qemu_chr_delete(chr);
4811 }
4812
4813 void qemu_chr_cleanup(void)
4814 {
4815 CharDriverState *chr, *tmp;
4816
4817 QTAILQ_FOREACH_SAFE(chr, &chardevs, next, tmp) {
4818 qemu_chr_delete(chr);
4819 }
4820 }
4821
4822 static void register_types(void)
4823 {
4824 register_char_driver("null", CHARDEV_BACKEND_KIND_NULL, NULL,
4825 qemu_chr_open_null);
4826 register_char_driver("socket", CHARDEV_BACKEND_KIND_SOCKET,
4827 qemu_chr_parse_socket, qmp_chardev_open_socket);
4828 register_char_driver("udp", CHARDEV_BACKEND_KIND_UDP, qemu_chr_parse_udp,
4829 qmp_chardev_open_udp);
4830 register_char_driver("ringbuf", CHARDEV_BACKEND_KIND_RINGBUF,
4831 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4832 register_char_driver("file", CHARDEV_BACKEND_KIND_FILE,
4833 qemu_chr_parse_file_out, qmp_chardev_open_file);
4834 register_char_driver("stdio", CHARDEV_BACKEND_KIND_STDIO,
4835 qemu_chr_parse_stdio, qemu_chr_open_stdio);
4836 #if defined HAVE_CHARDEV_SERIAL
4837 register_char_driver("serial", CHARDEV_BACKEND_KIND_SERIAL,
4838 qemu_chr_parse_serial, qmp_chardev_open_serial);
4839 register_char_driver("tty", CHARDEV_BACKEND_KIND_SERIAL,
4840 qemu_chr_parse_serial, qmp_chardev_open_serial);
4841 #endif
4842 #ifdef HAVE_CHARDEV_PARPORT
4843 register_char_driver("parallel", CHARDEV_BACKEND_KIND_PARALLEL,
4844 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4845 register_char_driver("parport", CHARDEV_BACKEND_KIND_PARALLEL,
4846 qemu_chr_parse_parallel, qmp_chardev_open_parallel);
4847 #endif
4848 #ifdef HAVE_CHARDEV_PTY
4849 register_char_driver("pty", CHARDEV_BACKEND_KIND_PTY, NULL,
4850 qemu_chr_open_pty);
4851 #endif
4852 #ifdef _WIN32
4853 register_char_driver("console", CHARDEV_BACKEND_KIND_CONSOLE, NULL,
4854 qemu_chr_open_win_con);
4855 #endif
4856 register_char_driver("pipe", CHARDEV_BACKEND_KIND_PIPE,
4857 qemu_chr_parse_pipe, qemu_chr_open_pipe);
4858 register_char_driver("mux", CHARDEV_BACKEND_KIND_MUX, qemu_chr_parse_mux,
4859 qemu_chr_open_mux);
4860 /* Bug-compatibility: */
4861 register_char_driver("memory", CHARDEV_BACKEND_KIND_MEMORY,
4862 qemu_chr_parse_ringbuf, qemu_chr_open_ringbuf);
4863 /* this must be done after machine init, since we register FEs with muxes
4864 * as part of realize functions like serial_isa_realizefn when -nographic
4865 * is specified
4866 */
4867 qemu_add_machine_init_done_notifier(&muxes_realize_notify);
4868 }
4869
4870 type_init(register_types);
QEMU mirror