1 #include "qemu/osdep.h"
2 #include <glib/gstdio.h>
4 #include "qemu/config-file.h"
5 #include "qemu/option.h"
6 #include "qemu/sockets.h"
7 #include "chardev/char-fe.h"
8 #include "chardev/char-mux.h"
9 #include "sysemu/sysemu.h"
10 #include "qapi/error.h"
11 #include "qapi/qapi-commands-char.h"
12 #include "qapi/qmp/qdict.h"
13 #include "qom/qom-qobject.h"
17 typedef struct FeHandler
{
23 static void main_loop(void)
27 main_loop_wait(false);
31 static int fe_can_read(void *opaque
)
33 FeHandler
*h
= opaque
;
35 return sizeof(h
->read_buf
) - h
->read_count
;
38 static void fe_read(void *opaque
, const uint8_t *buf
, int size
)
40 FeHandler
*h
= opaque
;
42 g_assert_cmpint(size
, <=, fe_can_read(opaque
));
44 memcpy(h
->read_buf
+ h
->read_count
, buf
, size
);
45 h
->read_count
+= size
;
49 static void fe_event(void *opaque
, int event
)
51 FeHandler
*h
= opaque
;
53 h
->last_event
= event
;
54 if (event
!= CHR_EVENT_BREAK
) {
60 static void char_console_test_subprocess(void)
65 opts
= qemu_opts_create(qemu_find_opts("chardev"), "console-label",
67 qemu_opt_set(opts
, "backend", "console", &error_abort
);
69 chr
= qemu_chr_new_from_opts(opts
, NULL
);
70 g_assert_nonnull(chr
);
72 qemu_chr_write_all(chr
, (const uint8_t *)"CONSOLE", 7);
75 object_unparent(OBJECT(chr
));
78 static void char_console_test(void)
80 g_test_trap_subprocess("/char/console/subprocess", 0, 0);
81 g_test_trap_assert_passed();
82 g_test_trap_assert_stdout("CONSOLE");
85 static void char_stdio_test_subprocess(void)
91 chr
= qemu_chr_new("label", "stdio");
92 g_assert_nonnull(chr
);
94 qemu_chr_fe_init(&be
, chr
, &error_abort
);
95 qemu_chr_fe_set_open(&be
, true);
96 ret
= qemu_chr_fe_write(&be
, (void *)"buf", 4);
97 g_assert_cmpint(ret
, ==, 4);
99 qemu_chr_fe_deinit(&be
, true);
102 static void char_stdio_test(void)
104 g_test_trap_subprocess("/char/stdio/subprocess", 0, 0);
105 g_test_trap_assert_passed();
106 g_test_trap_assert_stdout("buf");
109 static void char_ringbuf_test(void)
117 opts
= qemu_opts_create(qemu_find_opts("chardev"), "ringbuf-label",
119 qemu_opt_set(opts
, "backend", "ringbuf", &error_abort
);
121 qemu_opt_set(opts
, "size", "5", &error_abort
);
122 chr
= qemu_chr_new_from_opts(opts
, NULL
);
126 opts
= qemu_opts_create(qemu_find_opts("chardev"), "ringbuf-label",
128 qemu_opt_set(opts
, "backend", "ringbuf", &error_abort
);
129 qemu_opt_set(opts
, "size", "2", &error_abort
);
130 chr
= qemu_chr_new_from_opts(opts
, &error_abort
);
131 g_assert_nonnull(chr
);
134 qemu_chr_fe_init(&be
, chr
, &error_abort
);
135 ret
= qemu_chr_fe_write(&be
, (void *)"buff", 4);
136 g_assert_cmpint(ret
, ==, 4);
138 data
= qmp_ringbuf_read("ringbuf-label", 4, false, 0, &error_abort
);
139 g_assert_cmpstr(data
, ==, "ff");
142 data
= qmp_ringbuf_read("ringbuf-label", 4, false, 0, &error_abort
);
143 g_assert_cmpstr(data
, ==, "");
146 qemu_chr_fe_deinit(&be
, true);
149 opts
= qemu_opts_create(qemu_find_opts("chardev"), "memory-label",
151 qemu_opt_set(opts
, "backend", "memory", &error_abort
);
152 qemu_opt_set(opts
, "size", "2", &error_abort
);
153 chr
= qemu_chr_new_from_opts(opts
, NULL
);
154 g_assert_nonnull(chr
);
155 object_unparent(OBJECT(chr
));
159 static void char_mux_test(void)
164 FeHandler h1
= { 0, }, h2
= { 0, };
165 CharBackend chr_be1
, chr_be2
;
167 opts
= qemu_opts_create(qemu_find_opts("chardev"), "mux-label",
169 qemu_opt_set(opts
, "backend", "ringbuf", &error_abort
);
170 qemu_opt_set(opts
, "size", "128", &error_abort
);
171 qemu_opt_set(opts
, "mux", "on", &error_abort
);
172 chr
= qemu_chr_new_from_opts(opts
, &error_abort
);
173 g_assert_nonnull(chr
);
176 qemu_chr_fe_init(&chr_be1
, chr
, &error_abort
);
177 qemu_chr_fe_set_handlers(&chr_be1
,
185 qemu_chr_fe_init(&chr_be2
, chr
, &error_abort
);
186 qemu_chr_fe_set_handlers(&chr_be2
,
193 qemu_chr_fe_take_focus(&chr_be2
);
195 base
= qemu_chr_find("mux-label-base");
196 g_assert_cmpint(qemu_chr_be_can_write(base
), !=, 0);
198 qemu_chr_be_write(base
, (void *)"hello", 6);
199 g_assert_cmpint(h1
.read_count
, ==, 0);
200 g_assert_cmpint(h2
.read_count
, ==, 6);
201 g_assert_cmpstr(h2
.read_buf
, ==, "hello");
204 g_assert_cmpint(h1
.last_event
, !=, 42); /* should be MUX_OUT or OPENED */
205 g_assert_cmpint(h2
.last_event
, !=, 42); /* should be MUX_IN or OPENED */
206 /* sending event on the base broadcast to all fe, historical reasons? */
207 qemu_chr_be_event(base
, 42);
208 g_assert_cmpint(h1
.last_event
, ==, 42);
209 g_assert_cmpint(h2
.last_event
, ==, 42);
210 qemu_chr_be_event(chr
, -1);
211 g_assert_cmpint(h1
.last_event
, ==, 42);
212 g_assert_cmpint(h2
.last_event
, ==, -1);
215 qemu_chr_be_write(base
, (void *)"\1b", 2);
216 g_assert_cmpint(h1
.last_event
, ==, 42);
217 g_assert_cmpint(h2
.last_event
, ==, CHR_EVENT_BREAK
);
219 qemu_chr_be_write(base
, (void *)"\1c", 2);
220 g_assert_cmpint(h1
.last_event
, ==, CHR_EVENT_MUX_IN
);
221 g_assert_cmpint(h2
.last_event
, ==, CHR_EVENT_MUX_OUT
);
222 qemu_chr_be_event(chr
, -1);
223 g_assert_cmpint(h1
.last_event
, ==, -1);
224 g_assert_cmpint(h2
.last_event
, ==, CHR_EVENT_MUX_OUT
);
226 qemu_chr_be_write(base
, (void *)"hello", 6);
227 g_assert_cmpint(h2
.read_count
, ==, 0);
228 g_assert_cmpint(h1
.read_count
, ==, 6);
229 g_assert_cmpstr(h1
.read_buf
, ==, "hello");
232 qemu_chr_be_write(base
, (void *)"\1b", 2);
233 g_assert_cmpint(h1
.last_event
, ==, CHR_EVENT_BREAK
);
234 g_assert_cmpint(h2
.last_event
, ==, CHR_EVENT_MUX_OUT
);
236 /* remove first handler */
237 qemu_chr_fe_set_handlers(&chr_be1
, NULL
, NULL
, NULL
, NULL
,
239 qemu_chr_be_write(base
, (void *)"hello", 6);
240 g_assert_cmpint(h1
.read_count
, ==, 0);
241 g_assert_cmpint(h2
.read_count
, ==, 0);
243 qemu_chr_be_write(base
, (void *)"\1c", 2);
244 qemu_chr_be_write(base
, (void *)"hello", 6);
245 g_assert_cmpint(h1
.read_count
, ==, 0);
246 g_assert_cmpint(h2
.read_count
, ==, 6);
247 g_assert_cmpstr(h2
.read_buf
, ==, "hello");
251 qemu_chr_be_write(base
, (void *)"\1?", 2);
252 data
= qmp_ringbuf_read("mux-label-base", 128, false, 0, &error_abort
);
253 g_assert_cmpint(strlen(data
), !=, 0);
256 qemu_chr_fe_deinit(&chr_be1
, false);
257 qemu_chr_fe_deinit(&chr_be2
, true);
260 typedef struct SocketIdleData
{
265 CharBackend
*client_be
;
268 static gboolean
char_socket_test_idle(gpointer user_data
)
270 SocketIdleData
*data
= user_data
;
272 if (object_property_get_bool(OBJECT(data
->chr
), "connected", NULL
)
273 == data
->conn_expected
) {
281 static void socket_read(void *opaque
, const uint8_t *buf
, int size
)
283 SocketIdleData
*data
= opaque
;
285 g_assert_cmpint(size
, ==, 1);
286 g_assert_cmpint(*buf
, ==, 'Z');
288 size
= qemu_chr_fe_write(data
->be
, (const uint8_t *)"hello", 5);
289 g_assert_cmpint(size
, ==, 5);
292 static int socket_can_read(void *opaque
)
297 static void socket_read_hello(void *opaque
, const uint8_t *buf
, int size
)
299 g_assert_cmpint(size
, ==, 5);
300 g_assert(strncmp((char *)buf
, "hello", 5) == 0);
305 static int socket_can_read_hello(void *opaque
)
310 static void char_socket_test_common(Chardev
*chr
)
316 SocketIdleData d
= { .chr
= chr
};
318 CharBackend client_be
;
324 g_assert_nonnull(chr
);
325 g_assert(!object_property_get_bool(OBJECT(chr
), "connected", &error_abort
));
327 addr
= object_property_get_qobject(OBJECT(chr
), "addr", &error_abort
);
328 qdict
= qobject_to(QDict
, addr
);
329 port
= qdict_get_str(qdict
, "port");
330 tmp
= g_strdup_printf("tcp:127.0.0.1:%s", port
);
331 qobject_unref(qdict
);
333 qemu_chr_fe_init(&be
, chr
, &error_abort
);
334 qemu_chr_fe_set_handlers(&be
, socket_can_read
, socket_read
,
335 NULL
, NULL
, &d
, NULL
, true);
337 chr_client
= qemu_chr_new("client", tmp
);
338 qemu_chr_fe_init(&client_be
, chr_client
, &error_abort
);
339 qemu_chr_fe_set_handlers(&client_be
, socket_can_read_hello
,
341 NULL
, NULL
, &d
, NULL
, true);
344 d
.conn_expected
= true;
345 guint id
= g_idle_add(char_socket_test_idle
, &d
);
346 g_source_set_name_by_id(id
, "test-idle");
347 g_assert_cmpint(id
, >, 0);
350 g_assert(object_property_get_bool(OBJECT(chr
), "connected", &error_abort
));
351 g_assert(object_property_get_bool(OBJECT(chr_client
),
352 "connected", &error_abort
));
354 qemu_chr_write_all(chr_client
, (const uint8_t *)"Z", 1);
357 object_unparent(OBJECT(chr_client
));
359 d
.conn_expected
= false;
360 g_idle_add(char_socket_test_idle
, &d
);
363 object_unparent(OBJECT(chr
));
367 static void char_socket_basic_test(void)
369 Chardev
*chr
= qemu_chr_new("server", "tcp:127.0.0.1:0,server,nowait");
371 char_socket_test_common(chr
);
375 static void char_socket_fdpass_test(void)
381 SocketAddress
*addr
= g_new0(SocketAddress
, 1);
383 addr
->type
= SOCKET_ADDRESS_TYPE_INET
;
384 addr
->u
.inet
.host
= g_strdup("127.0.0.1");
385 addr
->u
.inet
.port
= g_strdup("0");
387 fd
= socket_listen(addr
, &error_abort
);
390 qapi_free_SocketAddress(addr
);
392 optstr
= g_strdup_printf("socket,id=cdev,fd=%d,server,nowait", fd
);
394 opts
= qemu_opts_parse_noisily(qemu_find_opts("chardev"),
397 g_assert_nonnull(opts
);
399 chr
= qemu_chr_new_from_opts(opts
, &error_abort
);
403 char_socket_test_common(chr
);
408 static void char_pipe_test(void)
410 gchar
*tmp_path
= g_dir_make_tmp("qemu-test-char.XXXXXX", NULL
);
411 gchar
*tmp
, *in
, *out
, *pipe
= g_build_filename(tmp_path
, "pipe", NULL
);
416 FeHandler fe
= { 0, };
418 in
= g_strdup_printf("%s.in", pipe
);
419 if (mkfifo(in
, 0600) < 0) {
422 out
= g_strdup_printf("%s.out", pipe
);
423 if (mkfifo(out
, 0600) < 0) {
427 tmp
= g_strdup_printf("pipe:%s", pipe
);
428 chr
= qemu_chr_new("pipe", tmp
);
429 g_assert_nonnull(chr
);
432 qemu_chr_fe_init(&be
, chr
, &error_abort
);
434 ret
= qemu_chr_fe_write(&be
, (void *)"pipe-out", 9);
435 g_assert_cmpint(ret
, ==, 9);
437 fd
= open(out
, O_RDWR
);
438 ret
= read(fd
, buf
, sizeof(buf
));
439 g_assert_cmpint(ret
, ==, 9);
440 g_assert_cmpstr(buf
, ==, "pipe-out");
443 fd
= open(in
, O_WRONLY
);
444 ret
= write(fd
, "pipe-in", 8);
445 g_assert_cmpint(ret
, ==, 8);
448 qemu_chr_fe_set_handlers(&be
,
458 g_assert_cmpint(fe
.read_count
, ==, 8);
459 g_assert_cmpstr(fe
.read_buf
, ==, "pipe-in");
461 qemu_chr_fe_deinit(&be
, true);
463 g_assert(g_unlink(in
) == 0);
464 g_assert(g_unlink(out
) == 0);
465 g_assert(g_rmdir(tmp_path
) == 0);
473 static int make_udp_socket(int *port
)
475 struct sockaddr_in addr
= { 0, };
476 socklen_t alen
= sizeof(addr
);
477 int ret
, sock
= qemu_socket(PF_INET
, SOCK_DGRAM
, 0);
479 g_assert_cmpint(sock
, >, 0);
480 addr
.sin_family
= AF_INET
;
481 addr
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
483 ret
= bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
));
484 g_assert_cmpint(ret
, ==, 0);
485 ret
= getsockname(sock
, (struct sockaddr
*)&addr
, &alen
);
486 g_assert_cmpint(ret
, ==, 0);
488 *port
= ntohs(addr
.sin_port
);
492 static void char_udp_test_internal(Chardev
*reuse_chr
, int sock
)
494 struct sockaddr_in other
;
495 SocketIdleData d
= { 0, };
498 socklen_t alen
= sizeof(other
);
508 sock
= make_udp_socket(&port
);
509 tmp
= g_strdup_printf("udp:127.0.0.1:%d", port
);
510 chr
= qemu_chr_new("client", tmp
);
511 g_assert_nonnull(chr
);
513 be
= g_alloca(sizeof(CharBackend
));
514 qemu_chr_fe_init(be
, chr
, &error_abort
);
518 qemu_chr_fe_set_handlers(be
, socket_can_read_hello
, socket_read_hello
,
519 NULL
, NULL
, &d
, NULL
, true);
520 ret
= qemu_chr_write_all(chr
, (uint8_t *)"hello", 5);
521 g_assert_cmpint(ret
, ==, 5);
523 ret
= recvfrom(sock
, buf
, sizeof(buf
), 0,
524 (struct sockaddr
*)&other
, &alen
);
525 g_assert_cmpint(ret
, ==, 5);
526 ret
= sendto(sock
, buf
, 5, 0, (struct sockaddr
*)&other
, alen
);
527 g_assert_cmpint(ret
, ==, 5);
533 qemu_chr_fe_deinit(be
, true);
538 static void char_udp_test(void)
540 char_udp_test_internal(NULL
, 0);
543 #ifdef HAVE_CHARDEV_SERIAL
544 static void char_serial_test(void)
549 opts
= qemu_opts_create(qemu_find_opts("chardev"), "serial-id",
551 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
552 qemu_opt_set(opts
, "path", "/dev/null", &error_abort
);
554 chr
= qemu_chr_new_from_opts(opts
, NULL
);
555 g_assert_nonnull(chr
);
556 /* TODO: add more tests with a pty */
557 object_unparent(OBJECT(chr
));
560 qemu_opt_set(opts
, "backend", "tty", &error_abort
);
561 chr
= qemu_chr_new_from_opts(opts
, NULL
);
562 g_assert_nonnull(chr
);
563 object_unparent(OBJECT(chr
));
570 static void char_file_fifo_test(void)
574 char *tmp_path
= g_dir_make_tmp("qemu-test-char.XXXXXX", NULL
);
575 char *fifo
= g_build_filename(tmp_path
, "fifo", NULL
);
576 char *out
= g_build_filename(tmp_path
, "out", NULL
);
577 ChardevFile file
= { .in
= fifo
,
580 ChardevBackend backend
= { .type
= CHARDEV_BACKEND_KIND_FILE
,
581 .u
.file
.data
= &file
};
582 FeHandler fe
= { 0, };
585 if (mkfifo(fifo
, 0600) < 0) {
589 fd
= open(fifo
, O_RDWR
);
590 ret
= write(fd
, "fifo-in", 8);
591 g_assert_cmpint(ret
, ==, 8);
593 chr
= qemu_chardev_new("label-file", TYPE_CHARDEV_FILE
, &backend
,
596 qemu_chr_fe_init(&be
, chr
, &error_abort
);
597 qemu_chr_fe_set_handlers(&be
,
604 g_assert_cmpint(fe
.last_event
, !=, CHR_EVENT_BREAK
);
605 qmp_chardev_send_break("label-foo", NULL
);
606 g_assert_cmpint(fe
.last_event
, !=, CHR_EVENT_BREAK
);
607 qmp_chardev_send_break("label-file", NULL
);
608 g_assert_cmpint(fe
.last_event
, ==, CHR_EVENT_BREAK
);
614 g_assert_cmpint(fe
.read_count
, ==, 8);
615 g_assert_cmpstr(fe
.read_buf
, ==, "fifo-in");
617 qemu_chr_fe_deinit(&be
, true);
628 static void char_file_test_internal(Chardev
*ext_chr
, const char *filepath
)
630 char *tmp_path
= g_dir_make_tmp("qemu-test-char.XXXXXX", NULL
);
633 char *contents
= NULL
;
634 ChardevFile file
= {};
635 ChardevBackend backend
= { .type
= CHARDEV_BACKEND_KIND_FILE
,
636 .u
.file
.data
= &file
};
642 out
= g_strdup(filepath
);
645 out
= g_build_filename(tmp_path
, "out", NULL
);
647 chr
= qemu_chardev_new(NULL
, TYPE_CHARDEV_FILE
, &backend
,
650 ret
= qemu_chr_write_all(chr
, (uint8_t *)"hello!", 6);
651 g_assert_cmpint(ret
, ==, 6);
653 ret
= g_file_get_contents(out
, &contents
, &length
, NULL
);
654 g_assert(ret
== TRUE
);
655 g_assert_cmpint(length
, ==, 6);
656 g_assert(strncmp(contents
, "hello!", 6) == 0);
659 object_unref(OBJECT(chr
));
668 static void char_file_test(void)
670 char_file_test_internal(NULL
, NULL
);
673 static void char_null_test(void)
680 chr
= qemu_chr_find("label-null");
683 chr
= qemu_chr_new("label-null", "null");
684 chr
= qemu_chr_find("label-null");
685 g_assert_nonnull(chr
);
687 g_assert(qemu_chr_has_feature(chr
,
688 QEMU_CHAR_FEATURE_FD_PASS
) == false);
689 g_assert(qemu_chr_has_feature(chr
,
690 QEMU_CHAR_FEATURE_RECONNECTABLE
) == false);
692 /* check max avail */
693 qemu_chr_fe_init(&be
, chr
, &error_abort
);
694 qemu_chr_fe_init(&be
, chr
, &err
);
695 error_free_or_abort(&err
);
697 /* deinit & reinit */
698 qemu_chr_fe_deinit(&be
, false);
699 qemu_chr_fe_init(&be
, chr
, &error_abort
);
701 qemu_chr_fe_set_open(&be
, true);
703 qemu_chr_fe_set_handlers(&be
,
710 ret
= qemu_chr_fe_write(&be
, (void *)"buf", 4);
711 g_assert_cmpint(ret
, ==, 4);
713 qemu_chr_fe_deinit(&be
, true);
716 static void char_invalid_test(void)
720 chr
= qemu_chr_new("label-invalid", "invalid");
724 static int chardev_change(void *opaque
)
729 static int chardev_change_denied(void *opaque
)
734 static void char_hotswap_test(void)
740 gchar
*tmp_path
= g_dir_make_tmp("qemu-test-char.XXXXXX", NULL
);
741 char *filename
= g_build_filename(tmp_path
, "file", NULL
);
742 ChardevFile file
= { .out
= filename
};
743 ChardevBackend backend
= { .type
= CHARDEV_BACKEND_KIND_FILE
,
744 .u
.file
.data
= &file
};
748 int sock
= make_udp_socket(&port
);
749 g_assert_cmpint(sock
, >, 0);
751 chr_args
= g_strdup_printf("udp:127.0.0.1:%d", port
);
753 chr
= qemu_chr_new("chardev", chr_args
);
754 qemu_chr_fe_init(&be
, chr
, &error_abort
);
756 /* check that chardev operates correctly */
757 char_udp_test_internal(chr
, sock
);
759 /* set the handler that denies the hotswap */
760 qemu_chr_fe_set_handlers(&be
, NULL
, NULL
,
761 NULL
, chardev_change_denied
, NULL
, NULL
, true);
763 /* now, change is denied and has to keep the old backend operating */
764 ret
= qmp_chardev_change("chardev", &backend
, NULL
);
766 g_assert(be
.chr
== chr
);
768 char_udp_test_internal(chr
, sock
);
770 /* now allow the change */
771 qemu_chr_fe_set_handlers(&be
, NULL
, NULL
,
772 NULL
, chardev_change
, NULL
, NULL
, true);
774 /* has to succeed now */
775 ret
= qmp_chardev_change("chardev", &backend
, &error_abort
);
776 g_assert(be
.chr
!= chr
);
781 /* run the file chardev test */
782 char_file_test_internal(chr
, filename
);
784 object_unparent(OBJECT(chr
));
786 qapi_free_ChardevReturn(ret
);
794 int main(int argc
, char **argv
)
796 qemu_init_main_loop(&error_abort
);
799 g_test_init(&argc
, &argv
, NULL
);
801 module_call_init(MODULE_INIT_QOM
);
802 qemu_add_opts(&qemu_chardev_opts
);
804 g_test_add_func("/char/null", char_null_test
);
805 g_test_add_func("/char/invalid", char_invalid_test
);
806 g_test_add_func("/char/ringbuf", char_ringbuf_test
);
807 g_test_add_func("/char/mux", char_mux_test
);
809 g_test_add_func("/char/console/subprocess", char_console_test_subprocess
);
810 g_test_add_func("/char/console", char_console_test
);
812 g_test_add_func("/char/stdio/subprocess", char_stdio_test_subprocess
);
813 g_test_add_func("/char/stdio", char_stdio_test
);
815 g_test_add_func("/char/pipe", char_pipe_test
);
817 g_test_add_func("/char/file", char_file_test
);
819 g_test_add_func("/char/file-fifo", char_file_fifo_test
);
821 g_test_add_func("/char/socket/basic", char_socket_basic_test
);
822 g_test_add_func("/char/socket/fdpass", char_socket_fdpass_test
);
823 g_test_add_func("/char/udp", char_udp_test
);
824 #ifdef HAVE_CHARDEV_SERIAL
825 g_test_add_func("/char/serial", char_serial_test
);
827 g_test_add_func("/char/hotswap", char_hotswap_test
);