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