net: add sock.h

The socket-related code was already broken out into
lib/net/sock.c, so break out the header portions
from include/spdk/net.h into its own sock.h.

This prepares for some upcoming changes in how
TCP sockets are abstracted, to enable alternative
userspace TCP stack implementations to be used with
SPDK.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I40b162e72ea80c235b49f10b17c2085fcfb385d4
Reviewed-on: https://review.gerrithub.io/398851
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Ziye Yang <optimistyzy@gmail.com>
Reviewed-by: <shuhei.matsumoto.xt@hitachi.com>

include/spdk/net.h

@@ -69,23 +69,8 @@ int spdk_interface_add_ip_address(int ifc_index, char *ip_addr);
 int spdk_interface_delete_ip_address(int ifc_index, char *ip_addr);
 void *spdk_interface_get_list(void);
 
-int spdk_sock_getaddr(int sock, char *saddr, int slen, char *caddr, int clen);
-int spdk_sock_connect(const char *ip, int port);
-int spdk_sock_listen(const char *ip, int port);
-int spdk_sock_accept(int sock);
-int spdk_sock_close(int sock);
-ssize_t spdk_sock_recv(int sock, void *buf, size_t len);
-ssize_t spdk_sock_writev(int sock, struct iovec *iov, int iovcnt);
-
-int spdk_sock_set_recvlowat(int sock, int nbytes);
-int spdk_sock_set_recvbuf(int sock, int sz);
-int spdk_sock_set_sendbuf(int sock, int sz);
-
-bool spdk_sock_is_ipv6(int sock);
-bool spdk_sock_is_ipv4(int sock);
-
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* SPDK_NET_FRAMEWORK_H */
+#endif /* SPDK_NET_H */

include/spdk/sock.h

@@ -0,0 +1,66 @@
+/*-
+ *   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.
+ */
+
+/** \file
+ * TCP socket abstraction layer
+ */
+
+#ifndef SPDK_SOCK_H
+#define SPDK_SOCK_H
+
+#include "spdk/stdinc.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+int spdk_sock_getaddr(int sock, char *saddr, int slen, char *caddr, int clen);
+int spdk_sock_connect(const char *ip, int port);
+int spdk_sock_listen(const char *ip, int port);
+int spdk_sock_accept(int sock);
+int spdk_sock_close(int sock);
+ssize_t spdk_sock_recv(int sock, void *buf, size_t len);
+ssize_t spdk_sock_writev(int sock, struct iovec *iov, int iovcnt);
+
+int spdk_sock_set_recvlowat(int sock, int nbytes);
+int spdk_sock_set_recvbuf(int sock, int sz);
+int spdk_sock_set_sendbuf(int sock, int sz);
+
+bool spdk_sock_is_ipv6(int sock);
+bool spdk_sock_is_ipv4(int sock);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* SPDK_SOCK_H */

lib/iscsi/acceptor.c

@@ -37,7 +37,7 @@
 #include "spdk/env.h"
 #include "spdk/io_channel.h"
 #include "spdk/log.h"
-#include "spdk/net.h"
+#include "spdk/sock.h"
 #include "spdk/string.h"
 #include "iscsi/acceptor.h"
 #include "iscsi/conn.h"

lib/iscsi/conn.c

@@ -47,6 +47,7 @@
 #include "spdk/queue.h"
 #include "spdk/trace.h"
 #include "spdk/net.h"
+#include "spdk/sock.h"
 #include "spdk/string.h"
 
 #include "spdk_internal/log.h"

lib/iscsi/portal_grp.c

@@ -35,7 +35,7 @@
 #include "spdk/stdinc.h"
 
 #include "spdk/conf.h"
-#include "spdk/net.h"
+#include "spdk/sock.h"
 #include "spdk/event.h"
 #include "spdk/string.h"
 

lib/iscsi/tgt_node.c

@@ -35,7 +35,7 @@
 #include "spdk/stdinc.h"
 
 #include "spdk/conf.h"
-#include "spdk/net.h"
+#include "spdk/sock.h"
 #include "spdk/scsi.h"
 
 #include "spdk_internal/log.h"

lib/net/sock.c

@@ -34,7 +34,7 @@
 #include "spdk/stdinc.h"
 
 #include "spdk/log.h"
-#include "spdk/net.h"
+#include "spdk/sock.h"
 
 #define MAX_TMPBUF 1024
 #define PORTNUMLEN 32

test/unit/lib/iscsi/common.c

@@ -5,7 +5,7 @@
 
 #include "spdk/env.h"
 #include "spdk/event.h"
-#include "spdk/net.h"
+#include "spdk/sock.h"
 
 #include "spdk_internal/log.h"