xref: /qemu/tests/unit/test-io-channel-socket.c (revision dfd100f242370886bb6732f70f1f7cbd8eb9fedc)
1 /*
2  * QEMU I/O channel sockets test
3  *
4  * Copyright (c) 2015-2016 Red Hat, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18  *
19  */
20 
21 #include "qemu/osdep.h"
22 #include "io/channel-socket.h"
23 #include "io/channel-util.h"
24 #include "io-channel-helpers.h"
25 #include "qapi/error.h"
26 
27 #ifndef AI_ADDRCONFIG
28 # define AI_ADDRCONFIG 0
29 #endif
30 #ifndef EAI_ADDRFAMILY
31 # define EAI_ADDRFAMILY 0
32 #endif
33 
34 static int check_bind(const char *hostname, bool *has_proto)
35 {
36     int fd = -1;
37     struct addrinfo ai, *res = NULL;
38     int rc;
39     int ret = -1;
40 
41     memset(&ai, 0, sizeof(ai));
42     ai.ai_flags = AI_CANONNAME | AI_ADDRCONFIG;
43     ai.ai_family = AF_UNSPEC;
44     ai.ai_socktype = SOCK_STREAM;
45 
46     /* lookup */
47     rc = getaddrinfo(hostname, NULL, &ai, &res);
48     if (rc != 0) {
49         if (rc == EAI_ADDRFAMILY ||
50             rc == EAI_FAMILY) {
51             *has_proto = false;
52             goto done;
53         }
54         goto cleanup;
55     }
56 
57     fd = qemu_socket(res->ai_family, res->ai_socktype, res->ai_protocol);
58     if (fd < 0) {
59         goto cleanup;
60     }
61 
62     if (bind(fd, res->ai_addr, res->ai_addrlen) < 0) {
63         if (errno == EADDRNOTAVAIL) {
64             *has_proto = false;
65             goto done;
66         }
67         goto cleanup;
68     }
69 
70     *has_proto = true;
71  done:
72     ret = 0;
73 
74  cleanup:
75     if (fd != -1) {
76         close(fd);
77     }
78     if (res) {
79         freeaddrinfo(res);
80     }
81     return ret;
82 }
83 
84 static int check_protocol_support(bool *has_ipv4, bool *has_ipv6)
85 {
86     if (check_bind("127.0.0.1", has_ipv4) < 0) {
87         return -1;
88     }
89     if (check_bind("::1", has_ipv6) < 0) {
90         return -1;
91     }
92 
93     return 0;
94 }
95 
96 
97 static void test_io_channel_set_socket_bufs(QIOChannel *src,
98                                             QIOChannel *dst)
99 {
100     int buflen = 64 * 1024;
101 
102     /*
103      * Make the socket buffers small so that we see
104      * the effects of partial reads/writes
105      */
106     setsockopt(((QIOChannelSocket *)src)->fd,
107                SOL_SOCKET, SO_SNDBUF,
108                (char *)&buflen,
109                sizeof(buflen));
110 
111     setsockopt(((QIOChannelSocket *)dst)->fd,
112                SOL_SOCKET, SO_SNDBUF,
113                (char *)&buflen,
114                sizeof(buflen));
115 }
116 
117 
118 static void test_io_channel_setup_sync(SocketAddressLegacy *listen_addr,
119                                        SocketAddressLegacy *connect_addr,
120                                        QIOChannel **src,
121                                        QIOChannel **dst)
122 {
123     QIOChannelSocket *lioc;
124 
125     lioc = qio_channel_socket_new();
126     qio_channel_socket_listen_sync(lioc, listen_addr, &error_abort);
127 
128     if (listen_addr->type == SOCKET_ADDRESS_LEGACY_KIND_INET) {
129         SocketAddressLegacy *laddr = qio_channel_socket_get_local_address(
130             lioc, &error_abort);
131 
132         g_free(connect_addr->u.inet.data->port);
133         connect_addr->u.inet.data->port = g_strdup(laddr->u.inet.data->port);
134 
135         qapi_free_SocketAddressLegacy(laddr);
136     }
137 
138     *src = QIO_CHANNEL(qio_channel_socket_new());
139     qio_channel_socket_connect_sync(
140         QIO_CHANNEL_SOCKET(*src), connect_addr, &error_abort);
141     qio_channel_set_delay(*src, false);
142 
143     qio_channel_wait(QIO_CHANNEL(lioc), G_IO_IN);
144     *dst = QIO_CHANNEL(qio_channel_socket_accept(lioc, &error_abort));
145     g_assert(*dst);
146 
147     test_io_channel_set_socket_bufs(*src, *dst);
148 
149     object_unref(OBJECT(lioc));
150 }
151 
152 
153 struct TestIOChannelData {
154     bool err;
155     GMainLoop *loop;
156 };
157 
158 
159 static void test_io_channel_complete(QIOTask *task,
160                                      gpointer opaque)
161 {
162     struct TestIOChannelData *data = opaque;
163     data->err = qio_task_propagate_error(task, NULL);
164     g_main_loop_quit(data->loop);
165 }
166 
167 
168 static void test_io_channel_setup_async(SocketAddressLegacy *listen_addr,
169                                         SocketAddressLegacy *connect_addr,
170                                         QIOChannel **src,
171                                         QIOChannel **dst)
172 {
173     QIOChannelSocket *lioc;
174     struct TestIOChannelData data;
175 
176     data.loop = g_main_loop_new(g_main_context_default(),
177                                 TRUE);
178 
179     lioc = qio_channel_socket_new();
180     qio_channel_socket_listen_async(
181         lioc, listen_addr,
182         test_io_channel_complete, &data, NULL);
183 
184     g_main_loop_run(data.loop);
185     g_main_context_iteration(g_main_context_default(), FALSE);
186 
187     g_assert(!data.err);
188 
189     if (listen_addr->type == SOCKET_ADDRESS_LEGACY_KIND_INET) {
190         SocketAddressLegacy *laddr = qio_channel_socket_get_local_address(
191             lioc, &error_abort);
192 
193         g_free(connect_addr->u.inet.data->port);
194         connect_addr->u.inet.data->port = g_strdup(laddr->u.inet.data->port);
195 
196         qapi_free_SocketAddressLegacy(laddr);
197     }
198 
199     *src = QIO_CHANNEL(qio_channel_socket_new());
200 
201     qio_channel_socket_connect_async(
202         QIO_CHANNEL_SOCKET(*src), connect_addr,
203         test_io_channel_complete, &data, NULL);
204 
205     g_main_loop_run(data.loop);
206     g_main_context_iteration(g_main_context_default(), FALSE);
207 
208     g_assert(!data.err);
209 
210     qio_channel_wait(QIO_CHANNEL(lioc), G_IO_IN);
211     *dst = QIO_CHANNEL(qio_channel_socket_accept(lioc, &error_abort));
212     g_assert(*dst);
213 
214     qio_channel_set_delay(*src, false);
215     test_io_channel_set_socket_bufs(*src, *dst);
216 
217     object_unref(OBJECT(lioc));
218 
219     g_main_loop_unref(data.loop);
220 }
221 
222 
223 static void test_io_channel(bool async,
224                             SocketAddressLegacy *listen_addr,
225                             SocketAddressLegacy *connect_addr,
226                             bool passFD)
227 {
228     QIOChannel *src, *dst;
229     QIOChannelTest *test;
230     if (async) {
231         test_io_channel_setup_async(listen_addr, connect_addr, &src, &dst);
232 
233         g_assert(!passFD ||
234                  qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_FD_PASS));
235         g_assert(!passFD ||
236                  qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_FD_PASS));
237         g_assert(qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_SHUTDOWN));
238         g_assert(qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_SHUTDOWN));
239 
240         test = qio_channel_test_new();
241         qio_channel_test_run_threads(test, true, src, dst);
242         qio_channel_test_validate(test);
243 
244         object_unref(OBJECT(src));
245         object_unref(OBJECT(dst));
246 
247         test_io_channel_setup_async(listen_addr, connect_addr, &src, &dst);
248 
249         g_assert(!passFD ||
250                  qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_FD_PASS));
251         g_assert(!passFD ||
252                  qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_FD_PASS));
253         g_assert(qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_SHUTDOWN));
254         g_assert(qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_SHUTDOWN));
255 
256         test = qio_channel_test_new();
257         qio_channel_test_run_threads(test, false, src, dst);
258         qio_channel_test_validate(test);
259 
260         object_unref(OBJECT(src));
261         object_unref(OBJECT(dst));
262     } else {
263         test_io_channel_setup_sync(listen_addr, connect_addr, &src, &dst);
264 
265         g_assert(!passFD ||
266                  qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_FD_PASS));
267         g_assert(!passFD ||
268                  qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_FD_PASS));
269         g_assert(qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_SHUTDOWN));
270         g_assert(qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_SHUTDOWN));
271 
272         test = qio_channel_test_new();
273         qio_channel_test_run_threads(test, true, src, dst);
274         qio_channel_test_validate(test);
275 
276         object_unref(OBJECT(src));
277         object_unref(OBJECT(dst));
278 
279         test_io_channel_setup_sync(listen_addr, connect_addr, &src, &dst);
280 
281         g_assert(!passFD ||
282                  qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_FD_PASS));
283         g_assert(!passFD ||
284                  qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_FD_PASS));
285         g_assert(qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_SHUTDOWN));
286         g_assert(qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_SHUTDOWN));
287 
288         test = qio_channel_test_new();
289         qio_channel_test_run_threads(test, false, src, dst);
290         qio_channel_test_validate(test);
291 
292         object_unref(OBJECT(src));
293         object_unref(OBJECT(dst));
294     }
295 }
296 
297 
298 static void test_io_channel_ipv4(bool async)
299 {
300     SocketAddressLegacy *listen_addr = g_new0(SocketAddressLegacy, 1);
301     SocketAddressLegacy *connect_addr = g_new0(SocketAddressLegacy, 1);
302 
303     listen_addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
304     listen_addr->u.inet.data = g_new(InetSocketAddress, 1);
305     *listen_addr->u.inet.data = (InetSocketAddress) {
306         .host = g_strdup("127.0.0.1"),
307         .port = NULL, /* Auto-select */
308     };
309 
310     connect_addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
311     connect_addr->u.inet.data = g_new(InetSocketAddress, 1);
312     *connect_addr->u.inet.data = (InetSocketAddress) {
313         .host = g_strdup("127.0.0.1"),
314         .port = NULL, /* Filled in later */
315     };
316 
317     test_io_channel(async, listen_addr, connect_addr, false);
318 
319     qapi_free_SocketAddressLegacy(listen_addr);
320     qapi_free_SocketAddressLegacy(connect_addr);
321 }
322 
323 
324 static void test_io_channel_ipv4_sync(void)
325 {
326     return test_io_channel_ipv4(false);
327 }
328 
329 
330 static void test_io_channel_ipv4_async(void)
331 {
332     return test_io_channel_ipv4(true);
333 }
334 
335 
336 static void test_io_channel_ipv6(bool async)
337 {
338     SocketAddressLegacy *listen_addr = g_new0(SocketAddressLegacy, 1);
339     SocketAddressLegacy *connect_addr = g_new0(SocketAddressLegacy, 1);
340 
341     listen_addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
342     listen_addr->u.inet.data = g_new(InetSocketAddress, 1);
343     *listen_addr->u.inet.data = (InetSocketAddress) {
344         .host = g_strdup("::1"),
345         .port = NULL, /* Auto-select */
346     };
347 
348     connect_addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
349     connect_addr->u.inet.data = g_new(InetSocketAddress, 1);
350     *connect_addr->u.inet.data = (InetSocketAddress) {
351         .host = g_strdup("::1"),
352         .port = NULL, /* Filled in later */
353     };
354 
355     test_io_channel(async, listen_addr, connect_addr, false);
356 
357     qapi_free_SocketAddressLegacy(listen_addr);
358     qapi_free_SocketAddressLegacy(connect_addr);
359 }
360 
361 
362 static void test_io_channel_ipv6_sync(void)
363 {
364     return test_io_channel_ipv6(false);
365 }
366 
367 
368 static void test_io_channel_ipv6_async(void)
369 {
370     return test_io_channel_ipv6(true);
371 }
372 
373 
374 #ifndef _WIN32
375 static void test_io_channel_unix(bool async)
376 {
377     SocketAddressLegacy *listen_addr = g_new0(SocketAddressLegacy, 1);
378     SocketAddressLegacy *connect_addr = g_new0(SocketAddressLegacy, 1);
379 
380 #define TEST_SOCKET "test-io-channel-socket.sock"
381     listen_addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
382     listen_addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
383     listen_addr->u.q_unix.data->path = g_strdup(TEST_SOCKET);
384 
385     connect_addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
386     connect_addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
387     connect_addr->u.q_unix.data->path = g_strdup(TEST_SOCKET);
388 
389     test_io_channel(async, listen_addr, connect_addr, true);
390 
391     qapi_free_SocketAddressLegacy(listen_addr);
392     qapi_free_SocketAddressLegacy(connect_addr);
393     g_assert(g_file_test(TEST_SOCKET, G_FILE_TEST_EXISTS) == FALSE);
394 }
395 
396 
397 static void test_io_channel_unix_sync(void)
398 {
399     return test_io_channel_unix(false);
400 }
401 
402 
403 static void test_io_channel_unix_async(void)
404 {
405     return test_io_channel_unix(true);
406 }
407 
408 static void test_io_channel_unix_fd_pass(void)
409 {
410     SocketAddressLegacy *listen_addr = g_new0(SocketAddressLegacy, 1);
411     SocketAddressLegacy *connect_addr = g_new0(SocketAddressLegacy, 1);
412     QIOChannel *src, *dst;
413     int testfd;
414     int fdsend[3];
415     int *fdrecv = NULL;
416     size_t nfdrecv = 0;
417     size_t i;
418     char bufsend[12], bufrecv[12];
419     struct iovec iosend[1], iorecv[1];
420 
421 #define TEST_SOCKET "test-io-channel-socket.sock"
422 #define TEST_FILE "test-io-channel-socket.txt"
423 
424     testfd = open(TEST_FILE, O_RDWR|O_TRUNC|O_CREAT, 0700);
425     g_assert(testfd != -1);
426     fdsend[0] = testfd;
427     fdsend[1] = testfd;
428     fdsend[2] = testfd;
429 
430     listen_addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
431     listen_addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
432     listen_addr->u.q_unix.data->path = g_strdup(TEST_SOCKET);
433 
434     connect_addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
435     connect_addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
436     connect_addr->u.q_unix.data->path = g_strdup(TEST_SOCKET);
437 
438     test_io_channel_setup_sync(listen_addr, connect_addr, &src, &dst);
439 
440     memcpy(bufsend, "Hello World", G_N_ELEMENTS(bufsend));
441 
442     iosend[0].iov_base = bufsend;
443     iosend[0].iov_len = G_N_ELEMENTS(bufsend);
444 
445     iorecv[0].iov_base = bufrecv;
446     iorecv[0].iov_len = G_N_ELEMENTS(bufrecv);
447 
448     g_assert(qio_channel_has_feature(src, QIO_CHANNEL_FEATURE_FD_PASS));
449     g_assert(qio_channel_has_feature(dst, QIO_CHANNEL_FEATURE_FD_PASS));
450 
451     qio_channel_writev_full(src,
452                             iosend,
453                             G_N_ELEMENTS(iosend),
454                             fdsend,
455                             G_N_ELEMENTS(fdsend),
456                             &error_abort);
457 
458     qio_channel_readv_full(dst,
459                            iorecv,
460                            G_N_ELEMENTS(iorecv),
461                            &fdrecv,
462                            &nfdrecv,
463                            &error_abort);
464 
465     g_assert(nfdrecv == G_N_ELEMENTS(fdsend));
466     /* Each recvd FD should be different from sent FD */
467     for (i = 0; i < nfdrecv; i++) {
468         g_assert_cmpint(fdrecv[i], !=, testfd);
469     }
470     /* Each recvd FD should be different from each other */
471     g_assert_cmpint(fdrecv[0], !=, fdrecv[1]);
472     g_assert_cmpint(fdrecv[0], !=, fdrecv[2]);
473     g_assert_cmpint(fdrecv[1], !=, fdrecv[2]);
474 
475     /* Check the I/O buf we sent at the same time matches */
476     g_assert(memcmp(bufsend, bufrecv, G_N_ELEMENTS(bufsend)) == 0);
477 
478     /* Write some data into the FD we received */
479     g_assert(write(fdrecv[0], bufsend, G_N_ELEMENTS(bufsend)) ==
480              G_N_ELEMENTS(bufsend));
481 
482     /* Read data from the original FD and make sure it matches */
483     memset(bufrecv, 0, G_N_ELEMENTS(bufrecv));
484     g_assert(lseek(testfd, 0, SEEK_SET) == 0);
485     g_assert(read(testfd, bufrecv, G_N_ELEMENTS(bufrecv)) ==
486              G_N_ELEMENTS(bufrecv));
487     g_assert(memcmp(bufsend, bufrecv, G_N_ELEMENTS(bufsend)) == 0);
488 
489     object_unref(OBJECT(src));
490     object_unref(OBJECT(dst));
491     qapi_free_SocketAddressLegacy(listen_addr);
492     qapi_free_SocketAddressLegacy(connect_addr);
493     unlink(TEST_SOCKET);
494     unlink(TEST_FILE);
495     close(testfd);
496     for (i = 0; i < nfdrecv; i++) {
497         close(fdrecv[i]);
498     }
499     g_free(fdrecv);
500 }
501 
502 static void test_io_channel_unix_listen_cleanup(void)
503 {
504     QIOChannelSocket *ioc;
505     struct sockaddr_un un;
506     int sock;
507 
508 #define TEST_SOCKET "test-io-channel-socket.sock"
509 
510     ioc = qio_channel_socket_new();
511 
512     /* Manually bind ioc without calling the qio api to avoid setting
513      * the LISTEN feature */
514     sock = qemu_socket(PF_UNIX, SOCK_STREAM, 0);
515     memset(&un, 0, sizeof(un));
516     un.sun_family = AF_UNIX;
517     snprintf(un.sun_path, sizeof(un.sun_path), "%s", TEST_SOCKET);
518     unlink(TEST_SOCKET);
519     bind(sock, (struct sockaddr *)&un, sizeof(un));
520     ioc->fd = sock;
521     ioc->localAddrLen = sizeof(ioc->localAddr);
522     getsockname(sock, (struct sockaddr *)&ioc->localAddr,
523                 &ioc->localAddrLen);
524 
525     g_assert(g_file_test(TEST_SOCKET, G_FILE_TEST_EXISTS));
526     object_unref(OBJECT(ioc));
527     g_assert(g_file_test(TEST_SOCKET, G_FILE_TEST_EXISTS));
528 
529     unlink(TEST_SOCKET);
530 }
531 
532 #endif /* _WIN32 */
533 
534 
535 static void test_io_channel_ipv4_fd(void)
536 {
537     QIOChannel *ioc;
538     int fd = -1;
539     struct sockaddr_in sa = {
540         .sin_family = AF_INET,
541         .sin_addr = {
542             .s_addr =  htonl(INADDR_LOOPBACK),
543         }
544         /* Leave port unset for auto-assign */
545     };
546     socklen_t salen = sizeof(sa);
547 
548     fd = socket(AF_INET, SOCK_STREAM, 0);
549     g_assert_cmpint(fd, >, -1);
550 
551     g_assert_cmpint(bind(fd, (struct sockaddr *)&sa, salen), ==, 0);
552 
553     ioc = qio_channel_new_fd(fd, &error_abort);
554 
555     g_assert_cmpstr(object_get_typename(OBJECT(ioc)),
556                     ==,
557                     TYPE_QIO_CHANNEL_SOCKET);
558 
559     object_unref(OBJECT(ioc));
560 }
561 
562 
563 int main(int argc, char **argv)
564 {
565     bool has_ipv4, has_ipv6;
566 
567     module_call_init(MODULE_INIT_QOM);
568     socket_init();
569 
570     g_test_init(&argc, &argv, NULL);
571 
572     /* We're creating actual IPv4/6 sockets, so we should
573      * check if the host running tests actually supports
574      * each protocol to avoid breaking tests on machines
575      * with either IPv4 or IPv6 disabled.
576      */
577     if (check_protocol_support(&has_ipv4, &has_ipv6) < 0) {
578         return 1;
579     }
580 
581     if (has_ipv4) {
582         g_test_add_func("/io/channel/socket/ipv4-sync",
583                         test_io_channel_ipv4_sync);
584         g_test_add_func("/io/channel/socket/ipv4-async",
585                         test_io_channel_ipv4_async);
586         g_test_add_func("/io/channel/socket/ipv4-fd",
587                         test_io_channel_ipv4_fd);
588     }
589     if (has_ipv6) {
590         g_test_add_func("/io/channel/socket/ipv6-sync",
591                         test_io_channel_ipv6_sync);
592         g_test_add_func("/io/channel/socket/ipv6-async",
593                         test_io_channel_ipv6_async);
594     }
595 
596 #ifndef _WIN32
597     g_test_add_func("/io/channel/socket/unix-sync",
598                     test_io_channel_unix_sync);
599     g_test_add_func("/io/channel/socket/unix-async",
600                     test_io_channel_unix_async);
601     g_test_add_func("/io/channel/socket/unix-fd-pass",
602                     test_io_channel_unix_fd_pass);
603     g_test_add_func("/io/channel/socket/unix-listen-cleanup",
604                     test_io_channel_unix_listen_cleanup);
605 #endif /* _WIN32 */
606 
607     return g_test_run();
608 }
609