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