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