1 #include "qemu/osdep.h"
2 #include <glib/gstdio.h>
4 #include "qemu-common.h"
5 #include "qemu/config-file.h"
6 #include "qemu/sockets.h"
7 #include "chardev/char-fe.h"
8 #include "sysemu/sysemu.h"
9 #include "qapi/error.h"
10 #include "qom/qom-qobject.h"
11 #include "qmp-commands.h"
15 typedef struct FeHandler
{
21 static void main_loop(void)
28 nonblocking
= last_io
> 0;
29 last_io
= main_loop_wait(nonblocking
);
33 static int fe_can_read(void *opaque
)
35 FeHandler
*h
= opaque
;
37 return sizeof(h
->read_buf
) - h
->read_count
;
40 static void fe_read(void *opaque
, const uint8_t *buf
, int size
)
42 FeHandler
*h
= opaque
;
44 g_assert_cmpint(size
, <=, fe_can_read(opaque
));
46 memcpy(h
->read_buf
+ h
->read_count
, buf
, size
);
47 h
->read_count
+= size
;
51 static void fe_event(void *opaque
, int event
)
53 FeHandler
*h
= opaque
;
55 h
->last_event
= event
;
59 #ifdef CONFIG_HAS_GLIB_SUBPROCESS_TESTS
61 static void char_console_test_subprocess(void)
66 opts
= qemu_opts_create(qemu_find_opts("chardev"), "console-label",
68 qemu_opt_set(opts
, "backend", "console", &error_abort
);
70 chr
= qemu_chr_new_from_opts(opts
, NULL
);
71 g_assert_nonnull(chr
);
73 qemu_chr_write_all(chr
, (const uint8_t *)"CONSOLE", 7);
76 object_unparent(OBJECT(chr
));
79 static void char_console_test(void)
81 g_test_trap_subprocess("/char/console/subprocess", 0, 0);
82 g_test_trap_assert_passed();
83 g_test_trap_assert_stdout("CONSOLE");
86 static void char_stdio_test_subprocess(void)
92 chr
= qemu_chr_new("label", "stdio");
93 g_assert_nonnull(chr
);
95 qemu_chr_fe_init(&be
, chr
, &error_abort
);
96 qemu_chr_fe_set_open(&be
, true);
97 ret
= qemu_chr_fe_write(&be
, (void *)"buf", 4);
98 g_assert_cmpint(ret
, ==, 4);
100 qemu_chr_fe_deinit(&be
, true);
103 static void char_stdio_test(void)
105 g_test_trap_subprocess("/char/stdio/subprocess", 0, 0);
106 g_test_trap_assert_passed();
107 g_test_trap_assert_stdout("buf");
111 static void char_ringbuf_test(void)
119 opts
= qemu_opts_create(qemu_find_opts("chardev"), "ringbuf-label",
121 qemu_opt_set(opts
, "backend", "ringbuf", &error_abort
);
123 qemu_opt_set(opts
, "size", "5", &error_abort
);
124 chr
= qemu_chr_new_from_opts(opts
, NULL
);
128 opts
= qemu_opts_create(qemu_find_opts("chardev"), "ringbuf-label",
130 qemu_opt_set(opts
, "backend", "ringbuf", &error_abort
);
131 qemu_opt_set(opts
, "size", "2", &error_abort
);
132 chr
= qemu_chr_new_from_opts(opts
, &error_abort
);
133 g_assert_nonnull(chr
);
136 qemu_chr_fe_init(&be
, chr
, &error_abort
);
137 ret
= qemu_chr_fe_write(&be
, (void *)"buff", 4);
138 g_assert_cmpint(ret
, ==, 4);
140 data
= qmp_ringbuf_read("ringbuf-label", 4, false, 0, &error_abort
);
141 g_assert_cmpstr(data
, ==, "ff");
144 data
= qmp_ringbuf_read("ringbuf-label", 4, false, 0, &error_abort
);
145 g_assert_cmpstr(data
, ==, "");
148 qemu_chr_fe_deinit(&be
, true);
151 opts
= qemu_opts_create(qemu_find_opts("chardev"), "memory-label",
153 qemu_opt_set(opts
, "backend", "memory", &error_abort
);
154 qemu_opt_set(opts
, "size", "2", &error_abort
);
155 chr
= qemu_chr_new_from_opts(opts
, NULL
);
156 g_assert_nonnull(chr
);
157 object_unparent(OBJECT(chr
));
161 static void char_mux_test(void)
166 FeHandler h1
= { 0, }, h2
= { 0, };
167 CharBackend chr_be1
, chr_be2
;
169 opts
= qemu_opts_create(qemu_find_opts("chardev"), "mux-label",
171 qemu_opt_set(opts
, "backend", "ringbuf", &error_abort
);
172 qemu_opt_set(opts
, "size", "128", &error_abort
);
173 qemu_opt_set(opts
, "mux", "on", &error_abort
);
174 chr
= qemu_chr_new_from_opts(opts
, &error_abort
);
175 g_assert_nonnull(chr
);
178 qemu_chr_fe_init(&chr_be1
, chr
, &error_abort
);
179 qemu_chr_fe_set_handlers(&chr_be1
,
186 qemu_chr_fe_init(&chr_be2
, chr
, &error_abort
);
187 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");
205 qemu_chr_be_write(base
, (void *)"\1c", 2);
207 qemu_chr_be_write(base
, (void *)"hello", 6);
208 g_assert_cmpint(h2
.read_count
, ==, 0);
209 g_assert_cmpint(h1
.read_count
, ==, 6);
210 g_assert_cmpstr(h1
.read_buf
, ==, "hello");
213 /* remove first handler */
214 qemu_chr_fe_set_handlers(&chr_be1
, NULL
, NULL
, NULL
, NULL
, NULL
, true);
215 qemu_chr_be_write(base
, (void *)"hello", 6);
216 g_assert_cmpint(h1
.read_count
, ==, 0);
217 g_assert_cmpint(h2
.read_count
, ==, 0);
219 qemu_chr_be_write(base
, (void *)"\1c", 2);
220 qemu_chr_be_write(base
, (void *)"hello", 6);
221 g_assert_cmpint(h1
.read_count
, ==, 0);
222 g_assert_cmpint(h2
.read_count
, ==, 6);
223 g_assert_cmpstr(h2
.read_buf
, ==, "hello");
227 qemu_chr_be_write(base
, (void *)"\1?", 2);
228 data
= qmp_ringbuf_read("mux-label-base", 128, false, 0, &error_abort
);
229 g_assert_cmpint(strlen(data
), !=, 0);
232 qemu_chr_fe_deinit(&chr_be1
, false);
233 qemu_chr_fe_deinit(&chr_be2
, true);
236 typedef struct SocketIdleData
{
241 CharBackend
*client_be
;
244 static gboolean
char_socket_test_idle(gpointer user_data
)
246 SocketIdleData
*data
= user_data
;
248 if (object_property_get_bool(OBJECT(data
->chr
), "connected", NULL
)
249 == data
->conn_expected
) {
257 static void socket_read(void *opaque
, const uint8_t *buf
, int size
)
259 SocketIdleData
*data
= opaque
;
261 g_assert_cmpint(size
, ==, 1);
262 g_assert_cmpint(*buf
, ==, 'Z');
264 size
= qemu_chr_fe_write(data
->be
, (const uint8_t *)"hello", 5);
265 g_assert_cmpint(size
, ==, 5);
268 static int socket_can_read(void *opaque
)
273 static void socket_read_hello(void *opaque
, const uint8_t *buf
, int size
)
275 g_assert_cmpint(size
, ==, 5);
276 g_assert(strncmp((char *)buf
, "hello", 5) == 0);
281 static int socket_can_read_hello(void *opaque
)
286 static void char_socket_test(void)
288 Chardev
*chr
= qemu_chr_new("server", "tcp:127.0.0.1:0,server,nowait");
293 SocketIdleData d
= { .chr
= chr
};
295 CharBackend client_be
;
301 g_assert_nonnull(chr
);
302 g_assert(!object_property_get_bool(OBJECT(chr
), "connected", &error_abort
));
304 addr
= object_property_get_qobject(OBJECT(chr
), "addr", &error_abort
);
305 qdict
= qobject_to_qdict(addr
);
306 port
= qdict_get_str(qdict
, "port");
307 tmp
= g_strdup_printf("tcp:127.0.0.1:%s", port
);
310 qemu_chr_fe_init(&be
, chr
, &error_abort
);
311 qemu_chr_fe_set_handlers(&be
, socket_can_read
, socket_read
,
312 NULL
, &d
, NULL
, true);
314 chr_client
= qemu_chr_new("client", tmp
);
315 qemu_chr_fe_init(&client_be
, chr_client
, &error_abort
);
316 qemu_chr_fe_set_handlers(&client_be
, socket_can_read_hello
,
318 NULL
, &d
, NULL
, true);
321 d
.conn_expected
= true;
322 guint id
= g_idle_add(char_socket_test_idle
, &d
);
323 g_source_set_name_by_id(id
, "test-idle");
324 g_assert_cmpint(id
, >, 0);
327 g_assert(object_property_get_bool(OBJECT(chr
), "connected", &error_abort
));
328 g_assert(object_property_get_bool(OBJECT(chr_client
),
329 "connected", &error_abort
));
331 qemu_chr_write_all(chr_client
, (const uint8_t *)"Z", 1);
334 object_unparent(OBJECT(chr_client
));
336 d
.conn_expected
= false;
337 g_idle_add(char_socket_test_idle
, &d
);
340 object_unparent(OBJECT(chr
));
344 static void char_pipe_test(void)
346 gchar
*tmp_path
= g_dir_make_tmp("qemu-test-char.XXXXXX", NULL
);
347 gchar
*tmp
, *in
, *out
, *pipe
= g_build_filename(tmp_path
, "pipe", NULL
);
352 FeHandler fe
= { 0, };
354 in
= g_strdup_printf("%s.in", pipe
);
355 if (mkfifo(in
, 0600) < 0) {
358 out
= g_strdup_printf("%s.out", pipe
);
359 if (mkfifo(out
, 0600) < 0) {
363 tmp
= g_strdup_printf("pipe:%s", pipe
);
364 chr
= qemu_chr_new("pipe", tmp
);
365 g_assert_nonnull(chr
);
368 qemu_chr_fe_init(&be
, chr
, &error_abort
);
370 ret
= qemu_chr_fe_write(&be
, (void *)"pipe-out", 9);
371 g_assert_cmpint(ret
, ==, 9);
373 fd
= open(out
, O_RDWR
);
374 ret
= read(fd
, buf
, sizeof(buf
));
375 g_assert_cmpint(ret
, ==, 9);
376 g_assert_cmpstr(buf
, ==, "pipe-out");
379 fd
= open(in
, O_WRONLY
);
380 ret
= write(fd
, "pipe-in", 8);
381 g_assert_cmpint(ret
, ==, 8);
384 qemu_chr_fe_set_handlers(&be
,
393 g_assert_cmpint(fe
.read_count
, ==, 8);
394 g_assert_cmpstr(fe
.read_buf
, ==, "pipe-in");
396 qemu_chr_fe_deinit(&be
, true);
398 g_assert(g_unlink(in
) == 0);
399 g_assert(g_unlink(out
) == 0);
400 g_assert(g_rmdir(tmp_path
) == 0);
408 static void char_udp_test(void)
410 struct sockaddr_in addr
= { 0, }, other
;
411 SocketIdleData d
= { 0, };
414 socklen_t alen
= sizeof(addr
);
415 int ret
, sock
= qemu_socket(PF_INET
, SOCK_DGRAM
, 0);
419 g_assert_cmpint(sock
, >, 0);
420 addr
.sin_family
= AF_INET
;
421 addr
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
423 ret
= bind(sock
, (struct sockaddr
*)&addr
, sizeof(addr
));
424 g_assert_cmpint(ret
, ==, 0);
425 ret
= getsockname(sock
, (struct sockaddr
*)&addr
, &alen
);
426 g_assert_cmpint(ret
, ==, 0);
428 tmp
= g_strdup_printf("udp:127.0.0.1:%d",
429 ntohs(addr
.sin_port
));
430 chr
= qemu_chr_new("client", tmp
);
431 g_assert_nonnull(chr
);
434 qemu_chr_fe_init(&be
, chr
, &error_abort
);
435 qemu_chr_fe_set_handlers(&be
, socket_can_read_hello
, socket_read_hello
,
436 NULL
, &d
, NULL
, true);
437 ret
= qemu_chr_write_all(chr
, (uint8_t *)"hello", 5);
438 g_assert_cmpint(ret
, ==, 5);
441 ret
= recvfrom(sock
, buf
, sizeof(buf
), 0,
442 (struct sockaddr
*)&other
, &alen
);
443 g_assert_cmpint(ret
, ==, 5);
444 ret
= sendto(sock
, buf
, 5, 0, (struct sockaddr
*)&other
, alen
);
445 g_assert_cmpint(ret
, ==, 5);
453 #ifdef HAVE_CHARDEV_SERIAL
454 static void char_serial_test(void)
459 opts
= qemu_opts_create(qemu_find_opts("chardev"), "serial-id",
461 qemu_opt_set(opts
, "backend", "serial", &error_abort
);
462 qemu_opt_set(opts
, "path", "/dev/null", &error_abort
);
464 chr
= qemu_chr_new_from_opts(opts
, NULL
);
465 g_assert_nonnull(chr
);
466 /* TODO: add more tests with a pty */
467 object_unparent(OBJECT(chr
));
470 qemu_opt_set(opts
, "backend", "tty", &error_abort
);
471 chr
= qemu_chr_new_from_opts(opts
, NULL
);
472 g_assert_nonnull(chr
);
473 object_unparent(OBJECT(chr
));
479 static void char_file_test(void)
481 char *tmp_path
= g_dir_make_tmp("qemu-test-char.XXXXXX", NULL
);
482 char *out
= g_build_filename(tmp_path
, "out", NULL
);
483 char *contents
= NULL
;
484 ChardevFile file
= { .out
= out
};
485 ChardevBackend backend
= { .type
= CHARDEV_BACKEND_KIND_FILE
,
486 .u
.file
.data
= &file
};
491 chr
= qemu_chardev_new(NULL
, TYPE_CHARDEV_FILE
, &backend
,
493 ret
= qemu_chr_write_all(chr
, (uint8_t *)"hello!", 6);
494 g_assert_cmpint(ret
, ==, 6);
495 object_unref(OBJECT(chr
));
497 ret
= g_file_get_contents(out
, &contents
, &length
, NULL
);
498 g_assert(ret
== TRUE
);
499 g_assert_cmpint(length
, ==, 6);
500 g_assert(strncmp(contents
, "hello!", 6) == 0);
506 FeHandler fe
= { 0, };
507 char *fifo
= g_build_filename(tmp_path
, "fifo", NULL
);
510 if (mkfifo(fifo
, 0600) < 0) {
514 fd
= open(fifo
, O_RDWR
);
515 ret
= write(fd
, "fifo-in", 8);
516 g_assert_cmpint(ret
, ==, 8);
520 chr
= qemu_chardev_new(NULL
, TYPE_CHARDEV_FILE
, &backend
,
523 qemu_chr_fe_init(&be
, chr
, &error_abort
);
524 qemu_chr_fe_set_handlers(&be
,
534 g_assert_cmpint(fe
.read_count
, ==, 8);
535 g_assert_cmpstr(fe
.read_buf
, ==, "fifo-in");
536 qemu_chr_fe_deinit(&be
, true);
548 static void char_null_test(void)
555 chr
= qemu_chr_find("label-null");
558 chr
= qemu_chr_new("label-null", "null");
559 chr
= qemu_chr_find("label-null");
560 g_assert_nonnull(chr
);
562 g_assert(qemu_chr_has_feature(chr
,
563 QEMU_CHAR_FEATURE_FD_PASS
) == false);
564 g_assert(qemu_chr_has_feature(chr
,
565 QEMU_CHAR_FEATURE_RECONNECTABLE
) == false);
567 /* check max avail */
568 qemu_chr_fe_init(&be
, chr
, &error_abort
);
569 qemu_chr_fe_init(&be
, chr
, &err
);
570 error_free_or_abort(&err
);
572 /* deinit & reinit */
573 qemu_chr_fe_deinit(&be
, false);
574 qemu_chr_fe_init(&be
, chr
, &error_abort
);
576 qemu_chr_fe_set_open(&be
, true);
578 qemu_chr_fe_set_handlers(&be
,
584 ret
= qemu_chr_fe_write(&be
, (void *)"buf", 4);
585 g_assert_cmpint(ret
, ==, 4);
587 qemu_chr_fe_deinit(&be
, true);
590 static void char_invalid_test(void)
594 chr
= qemu_chr_new("label-invalid", "invalid");
598 int main(int argc
, char **argv
)
600 qemu_init_main_loop(&error_abort
);
603 g_test_init(&argc
, &argv
, NULL
);
605 module_call_init(MODULE_INIT_QOM
);
606 qemu_add_opts(&qemu_chardev_opts
);
608 g_test_add_func("/char/null", char_null_test
);
609 g_test_add_func("/char/invalid", char_invalid_test
);
610 g_test_add_func("/char/ringbuf", char_ringbuf_test
);
611 g_test_add_func("/char/mux", char_mux_test
);
612 #ifdef CONFIG_HAS_GLIB_SUBPROCESS_TESTS
614 g_test_add_func("/char/console/subprocess", char_console_test_subprocess
);
615 g_test_add_func("/char/console", char_console_test
);
617 g_test_add_func("/char/stdio/subprocess", char_stdio_test_subprocess
);
618 g_test_add_func("/char/stdio", char_stdio_test
);
621 g_test_add_func("/char/pipe", char_pipe_test
);
623 g_test_add_func("/char/file", char_file_test
);
624 g_test_add_func("/char/socket", char_socket_test
);
625 g_test_add_func("/char/udp", char_udp_test
);
626 #ifdef HAVE_CHARDEV_SERIAL
627 g_test_add_func("/char/serial", char_serial_test
);