/*- * BSD LICENSE * * Copyright (c) Intel Corporation. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * Neither the name of Intel Corporation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "spdk/stdinc.h" #include "spdk/util.h" #include "spdk_cunit.h" #include "sock/sock.c" #include "sock/posix/posix.c" #define UT_IP "test_ip" #define UT_PORT 1234 bool g_read_data_called; ssize_t g_bytes_read; char g_buf[256]; struct spdk_sock *g_server_sock_read; int g_ut_accept_count; struct spdk_ut_sock *g_ut_listen_sock; struct spdk_ut_sock *g_ut_client_sock; struct spdk_ut_sock { struct spdk_sock base; struct spdk_ut_sock *peer; size_t bytes_avail; char buf[256]; }; struct spdk_ut_sock_group_impl { struct spdk_sock_group_impl base; struct spdk_ut_sock *sock; }; #define __ut_sock(sock) (struct spdk_ut_sock *)sock #define __ut_group(group) (struct spdk_ut_sock_group_impl *)group static int spdk_ut_sock_getaddr(struct spdk_sock *_sock, char *saddr, int slen, uint16_t *sport, char *caddr, int clen, uint16_t *cport) { return 0; } static struct spdk_sock * spdk_ut_sock_listen(const char *ip, int port) { struct spdk_ut_sock *sock; if (strcmp(ip, UT_IP) || port != UT_PORT) { return NULL; } CU_ASSERT(g_ut_listen_sock == NULL); sock = calloc(1, sizeof(*sock)); SPDK_CU_ASSERT_FATAL(sock != NULL); g_ut_listen_sock = sock; return &sock->base; } static struct spdk_sock * spdk_ut_sock_connect(const char *ip, int port) { struct spdk_ut_sock *sock; if (strcmp(ip, UT_IP) || port != UT_PORT) { return NULL; } sock = calloc(1, sizeof(*sock)); SPDK_CU_ASSERT_FATAL(sock != NULL); g_ut_accept_count++; CU_ASSERT(g_ut_client_sock == NULL); g_ut_client_sock = sock; return &sock->base; } static struct spdk_sock * spdk_ut_sock_accept(struct spdk_sock *_sock) { struct spdk_ut_sock *sock = __ut_sock(_sock); struct spdk_ut_sock *new_sock; CU_ASSERT(sock == g_ut_listen_sock); if (g_ut_accept_count == 0) { errno = EAGAIN; return NULL; } g_ut_accept_count--; new_sock = calloc(1, sizeof(*sock)); if (new_sock == NULL) { SPDK_ERRLOG("sock allocation failed\n"); return NULL; } SPDK_CU_ASSERT_FATAL(g_ut_client_sock != NULL); g_ut_client_sock->peer = new_sock; return &new_sock->base; } static int spdk_ut_sock_close(struct spdk_sock *_sock) { struct spdk_ut_sock *sock = __ut_sock(_sock); if (sock == g_ut_listen_sock) { g_ut_listen_sock = NULL; } if (sock == g_ut_client_sock) { g_ut_client_sock = NULL; } free(_sock); return 0; } static ssize_t spdk_ut_sock_recv(struct spdk_sock *_sock, void *buf, size_t len) { struct spdk_ut_sock *sock = __ut_sock(_sock); char tmp[256]; len = spdk_min(len, sock->bytes_avail); if (len == 0) { errno = EAGAIN; return -1; } memcpy(buf, sock->buf, len); memcpy(tmp, &sock->buf[len], sock->bytes_avail - len); memcpy(sock->buf, tmp, sock->bytes_avail - len); sock->bytes_avail -= len; return len; } static ssize_t spdk_ut_sock_readv(struct spdk_sock *_sock, struct iovec *iov, int iovcnt) { struct spdk_ut_sock *sock = __ut_sock(_sock); size_t len; char tmp[256]; /* Test implementation only supports single iov for now. */ CU_ASSERT(iovcnt == 1); len = spdk_min(iov[0].iov_len, sock->bytes_avail); if (len == 0) { errno = EAGAIN; return -1; } memcpy(iov[0].iov_base, sock->buf, len); memcpy(tmp, &sock->buf[len], sock->bytes_avail - len); memcpy(sock->buf, tmp, sock->bytes_avail - len); sock->bytes_avail -= len; return len; } static ssize_t spdk_ut_sock_writev(struct spdk_sock *_sock, struct iovec *iov, int iovcnt) { struct spdk_ut_sock *sock = __ut_sock(_sock); struct spdk_ut_sock *peer; SPDK_CU_ASSERT_FATAL(sock->peer != NULL); peer = sock->peer; /* Test implementation only supports single iov for now. */ CU_ASSERT(iovcnt == 1); memcpy(&peer->buf[peer->bytes_avail], iov[0].iov_base, iov[0].iov_len); peer->bytes_avail += iov[0].iov_len; return iov[0].iov_len; } static int spdk_ut_sock_set_recvlowat(struct spdk_sock *_sock, int nbytes) { return 0; } static int spdk_ut_sock_set_recvbuf(struct spdk_sock *_sock, int sz) { return 0; } static int spdk_ut_sock_set_sendbuf(struct spdk_sock *_sock, int sz) { return 0; } static bool spdk_ut_sock_is_ipv6(struct spdk_sock *_sock) { return false; } static bool spdk_ut_sock_is_ipv4(struct spdk_sock *_sock) { return true; } static struct spdk_sock_group_impl * spdk_ut_sock_group_impl_create(void) { struct spdk_ut_sock_group_impl *group_impl; group_impl = calloc(1, sizeof(*group_impl)); SPDK_CU_ASSERT_FATAL(group_impl != NULL); return &group_impl->base; } static int spdk_ut_sock_group_impl_add_sock(struct spdk_sock_group_impl *_group, struct spdk_sock *_sock) { struct spdk_ut_sock_group_impl *group = __ut_group(_group); struct spdk_ut_sock *sock = __ut_sock(_sock); group->sock = sock; return 0; } static int spdk_ut_sock_group_impl_remove_sock(struct spdk_sock_group_impl *_group, struct spdk_sock *_sock) { struct spdk_ut_sock_group_impl *group = __ut_group(_group); struct spdk_ut_sock *sock = __ut_sock(_sock); CU_ASSERT(group->sock == sock); group->sock = NULL; return 0; } static int spdk_ut_sock_group_impl_poll(struct spdk_sock_group_impl *_group, int max_events, struct spdk_sock **socks) { struct spdk_ut_sock_group_impl *group = __ut_group(_group); if (group->sock != NULL && group->sock->bytes_avail > 0) { socks[0] = &group->sock->base; return 1; } return 0; } static int spdk_ut_sock_group_impl_close(struct spdk_sock_group_impl *_group) { struct spdk_ut_sock_group_impl *group = __ut_group(_group); CU_ASSERT(group->sock == NULL); return 0; } static struct spdk_net_impl g_ut_net_impl = { .name = "ut", .getaddr = spdk_ut_sock_getaddr, .connect = spdk_ut_sock_connect, .listen = spdk_ut_sock_listen, .accept = spdk_ut_sock_accept, .close = spdk_ut_sock_close, .recv = spdk_ut_sock_recv, .readv = spdk_ut_sock_readv, .writev = spdk_ut_sock_writev, .set_recvlowat = spdk_ut_sock_set_recvlowat, .set_recvbuf = spdk_ut_sock_set_recvbuf, .set_sendbuf = spdk_ut_sock_set_sendbuf, .is_ipv6 = spdk_ut_sock_is_ipv6, .is_ipv4 = spdk_ut_sock_is_ipv4, .group_impl_create = spdk_ut_sock_group_impl_create, .group_impl_add_sock = spdk_ut_sock_group_impl_add_sock, .group_impl_remove_sock = spdk_ut_sock_group_impl_remove_sock, .group_impl_poll = spdk_ut_sock_group_impl_poll, .group_impl_close = spdk_ut_sock_group_impl_close, }; SPDK_NET_IMPL_REGISTER(ut, &g_ut_net_impl); static void _sock(const char *ip, int port) { struct spdk_sock *listen_sock; struct spdk_sock *server_sock; struct spdk_sock *client_sock; char *test_string = "abcdef"; char buffer[64]; ssize_t bytes_read, bytes_written; struct iovec iov; int rc; listen_sock = spdk_sock_listen(ip, port); SPDK_CU_ASSERT_FATAL(listen_sock != NULL); server_sock = spdk_sock_accept(listen_sock); CU_ASSERT(server_sock == NULL); CU_ASSERT(errno == EAGAIN || errno == EWOULDBLOCK); client_sock = spdk_sock_connect(ip, port); SPDK_CU_ASSERT_FATAL(client_sock != NULL); /* * Delay a bit here before checking if server socket is * ready. */ usleep(1000); server_sock = spdk_sock_accept(listen_sock); SPDK_CU_ASSERT_FATAL(server_sock != NULL); /* Test spdk_sock_recv */ iov.iov_base = test_string; iov.iov_len = 7; bytes_written = spdk_sock_writev(client_sock, &iov, 1); CU_ASSERT(bytes_written == 7); usleep(1000); bytes_read = spdk_sock_recv(server_sock, buffer, 2); CU_ASSERT(bytes_read == 2); usleep(1000); bytes_read += spdk_sock_recv(server_sock, buffer + 2, 5); CU_ASSERT(bytes_read == 7); CU_ASSERT(strncmp(test_string, buffer, 7) == 0); /* Test spdk_sock_readv */ iov.iov_base = test_string; iov.iov_len = 7; bytes_written = spdk_sock_writev(client_sock, &iov, 1); CU_ASSERT(bytes_written == 7); usleep(1000); iov.iov_base = buffer; iov.iov_len = 2; bytes_read = spdk_sock_readv(server_sock, &iov, 1); CU_ASSERT(bytes_read == 2); usleep(1000); iov.iov_base = buffer + 2; iov.iov_len = 5; bytes_read += spdk_sock_readv(server_sock, &iov, 1); CU_ASSERT(bytes_read == 7); usleep(1000); CU_ASSERT(strncmp(test_string, buffer, 7) == 0); rc = spdk_sock_close(&client_sock); CU_ASSERT(client_sock == NULL); CU_ASSERT(rc == 0); rc = spdk_sock_close(&server_sock); CU_ASSERT(server_sock == NULL); CU_ASSERT(rc == 0); rc = spdk_sock_close(&listen_sock); CU_ASSERT(listen_sock == NULL); CU_ASSERT(rc == 0); } static void posix_sock(void) { _sock("127.0.0.1", UT_PORT); } static void ut_sock(void) { _sock(UT_IP, UT_PORT); } static void read_data(void *cb_arg, struct spdk_sock_group *group, struct spdk_sock *sock) { struct spdk_sock *server_sock = cb_arg; CU_ASSERT(server_sock == sock); g_read_data_called = true; g_bytes_read += spdk_sock_recv(server_sock, g_buf + g_bytes_read, sizeof(g_buf) - g_bytes_read); } static void _sock_group(const char *ip, int port) { struct spdk_sock_group *group; struct spdk_sock *listen_sock; struct spdk_sock *server_sock; struct spdk_sock *client_sock; char *test_string = "abcdef"; ssize_t bytes_written; struct iovec iov; int rc; listen_sock = spdk_sock_listen(ip, port); SPDK_CU_ASSERT_FATAL(listen_sock != NULL); server_sock = spdk_sock_accept(listen_sock); CU_ASSERT(server_sock == NULL); CU_ASSERT(errno == EAGAIN || errno == EWOULDBLOCK); client_sock = spdk_sock_connect(ip, port); SPDK_CU_ASSERT_FATAL(client_sock != NULL); usleep(1000); server_sock = spdk_sock_accept(listen_sock); SPDK_CU_ASSERT_FATAL(server_sock != NULL); group = spdk_sock_group_create(); SPDK_CU_ASSERT_FATAL(group != NULL); /* pass null cb_fn */ rc = spdk_sock_group_add_sock(group, server_sock, NULL, NULL); CU_ASSERT(rc == -1); CU_ASSERT(errno == EINVAL); rc = spdk_sock_group_add_sock(group, server_sock, read_data, server_sock); CU_ASSERT(rc == 0); /* try adding sock a second time */ rc = spdk_sock_group_add_sock(group, server_sock, read_data, server_sock); CU_ASSERT(rc == -1); CU_ASSERT(errno == EBUSY); g_read_data_called = false; g_bytes_read = 0; rc = spdk_sock_group_poll(group); CU_ASSERT(rc == 0); CU_ASSERT(g_read_data_called == false); iov.iov_base = test_string; iov.iov_len = 7; bytes_written = spdk_sock_writev(client_sock, &iov, 1); CU_ASSERT(bytes_written == 7); usleep(1000); g_read_data_called = false; g_bytes_read = 0; rc = spdk_sock_group_poll(group); CU_ASSERT(rc == 0); CU_ASSERT(g_read_data_called == true); CU_ASSERT(g_bytes_read == 7); CU_ASSERT(strncmp(test_string, g_buf, 7) == 0); rc = spdk_sock_close(&client_sock); CU_ASSERT(client_sock == NULL); CU_ASSERT(rc == 0); /* Try to close sock_group while it still has sockets. */ rc = spdk_sock_group_close(&group); CU_ASSERT(rc == -1); CU_ASSERT(errno == EBUSY); /* Try to close sock while it is still part of a sock_group. */ rc = spdk_sock_close(&server_sock); CU_ASSERT(rc == -1); CU_ASSERT(errno == EBUSY); rc = spdk_sock_group_remove_sock(group, server_sock); CU_ASSERT(rc == 0); rc = spdk_sock_group_close(&group); CU_ASSERT(group == NULL); CU_ASSERT(rc == 0); rc = spdk_sock_close(&server_sock); CU_ASSERT(server_sock == NULL); CU_ASSERT(rc == 0); rc = spdk_sock_close(&listen_sock); CU_ASSERT(listen_sock == NULL); CU_ASSERT(rc == 0); } static void posix_sock_group(void) { _sock_group("127.0.0.1", UT_PORT); } static void ut_sock_group(void) { _sock_group(UT_IP, UT_PORT); } static void read_data_fairness(void *cb_arg, struct spdk_sock_group *group, struct spdk_sock *sock) { struct spdk_sock *server_sock = cb_arg; ssize_t bytes_read; char buf[1]; CU_ASSERT(g_server_sock_read == NULL); CU_ASSERT(server_sock == sock); g_server_sock_read = server_sock; bytes_read = spdk_sock_recv(server_sock, buf, 1); CU_ASSERT(bytes_read == 1); } static void posix_sock_group_fairness(void) { struct spdk_sock_group *group; struct spdk_sock *listen_sock; struct spdk_sock *server_sock[3]; struct spdk_sock *client_sock[3]; char test_char = 'a'; ssize_t bytes_written; struct iovec iov; int i, rc; listen_sock = spdk_sock_listen("127.0.0.1", UT_PORT); SPDK_CU_ASSERT_FATAL(listen_sock != NULL); group = spdk_sock_group_create(); SPDK_CU_ASSERT_FATAL(group != NULL); for (i = 0; i < 3; i++) { client_sock[i] = spdk_sock_connect("127.0.0.1", UT_PORT); SPDK_CU_ASSERT_FATAL(client_sock[i] != NULL); usleep(1000); server_sock[i] = spdk_sock_accept(listen_sock); SPDK_CU_ASSERT_FATAL(server_sock[i] != NULL); rc = spdk_sock_group_add_sock(group, server_sock[i], read_data_fairness, server_sock[i]); CU_ASSERT(rc == 0); } iov.iov_base = &test_char; iov.iov_len = 1; for (i = 0; i < 3; i++) { bytes_written = spdk_sock_writev(client_sock[i], &iov, 1); CU_ASSERT(bytes_written == 1); } usleep(1000); /* * Poll for just one event - this should be server sock 0, since that * is the peer of the first client sock that we wrote to. */ g_server_sock_read = NULL; rc = spdk_sock_group_poll_count(group, 1); CU_ASSERT(rc == 0); CU_ASSERT(g_server_sock_read == server_sock[0]); /* * Now write another byte to client sock 0. We want to ensure that * the sock group does not unfairly process the event for this sock * before the socks that were written to earlier. */ bytes_written = spdk_sock_writev(client_sock[0], &iov, 1); CU_ASSERT(bytes_written == 1); usleep(1000); g_server_sock_read = NULL; rc = spdk_sock_group_poll_count(group, 1); CU_ASSERT(rc == 0); CU_ASSERT(g_server_sock_read == server_sock[1]); g_server_sock_read = NULL; rc = spdk_sock_group_poll_count(group, 1); CU_ASSERT(rc == 0); CU_ASSERT(g_server_sock_read == server_sock[2]); g_server_sock_read = NULL; rc = spdk_sock_group_poll_count(group, 1); CU_ASSERT(rc == 0); CU_ASSERT(g_server_sock_read == server_sock[0]); for (i = 0; i < 3; i++) { rc = spdk_sock_group_remove_sock(group, server_sock[i]); CU_ASSERT(rc == 0); rc = spdk_sock_close(&client_sock[i]); CU_ASSERT(client_sock[i] == NULL); CU_ASSERT(rc == 0); rc = spdk_sock_close(&server_sock[i]); CU_ASSERT(server_sock[i] == NULL); CU_ASSERT(rc == 0); } rc = spdk_sock_group_close(&group); CU_ASSERT(group == NULL); CU_ASSERT(rc == 0); rc = spdk_sock_close(&listen_sock); CU_ASSERT(listen_sock == NULL); CU_ASSERT(rc == 0); } int main(int argc, char **argv) { CU_pSuite suite = NULL; unsigned int num_failures; if (CU_initialize_registry() != CUE_SUCCESS) { return CU_get_error(); } suite = CU_add_suite("sock", NULL, NULL); if (suite == NULL) { CU_cleanup_registry(); return CU_get_error(); } if ( CU_add_test(suite, "posix_sock", posix_sock) == NULL || CU_add_test(suite, "ut_sock", ut_sock) == NULL || CU_add_test(suite, "posix_sock_group", posix_sock_group) == NULL || CU_add_test(suite, "ut_sock_group", ut_sock_group) == NULL || CU_add_test(suite, "posix_sock_group_fairness", posix_sock_group_fairness) == NULL) { CU_cleanup_registry(); return CU_get_error(); } CU_basic_set_mode(CU_BRM_VERBOSE); CU_basic_run_tests(); num_failures = CU_get_number_of_failures(); CU_cleanup_registry(); return num_failures; }