add binding for kcp (alibaba#1541)

add binding for kcp

Author: lihuiba

.github/workflows/ci.linux.arm.yml

@@ -54,6 +54,7 @@ jobs:
                          -D PHOTON_ENABLE_FUSE=ON         \
                          -D PHOTON_ENABLE_URING=ON        \
                          -D PHOTON_ENABLE_LIBCURL=ON      \
+                         -D PHOTON_ENABLE_KCP=ON          \
                          -D PHOTON_ENABLE_EXTFS=ON
           cmake --build build -j $(nproc) -- VERBOSE=1
 

.github/workflows/ci.linux.x86_64.yml

@@ -38,6 +38,7 @@ jobs:
                          -D PHOTON_ENABLE_FUSE=ON         \
                          -D PHOTON_ENABLE_URING=ON        \
                          -D PHOTON_ENABLE_LIBCURL=ON      \
+                         -D PHOTON_ENABLE_KCP=ON          \
                          -D PHOTON_ENABLE_EXTFS=ON
           cmake --build build -j $(nproc)
       - name: Test epoll

.github/workflows/ci.macos.yml

@@ -51,6 +51,7 @@ jobs:
             -D CMAKE_BUILD_TYPE=MinSizeRel \
             -D PHOTON_ENABLE_SASL=ON \
             -D PHOTON_ENABLE_LIBCURL=ON \
+            -D PHOTON_ENABLE_KCP=ON \
             -D OPENSSL_ROOT_DIR=${OPENSSL_DIR}
           cmake --build ${{github.workspace}}/build -j $(sysctl -n hw.logicalcpu)
 

CMake/build-from-src.cmake

@@ -395,6 +395,23 @@ function(build_from_src [dep])
         set(FSTACK_LIBRARIES ${BINARY_DIR}/lib/libfstack.a PARENT_SCOPE)
         set(FSTACK_LIBRARIES ${FSTACK_LIBRARIES} ${DPDK_LIBRARIES} PARENT_SCOPE)
 
+    elseif (dep STREQUAL "kcp")
+        set(BINARY_DIR ${PROJECT_BINARY_DIR}/kcp-build)
+        ExternalProject_Add(
+            kcp
+            URL ${PHOTON_KCP_SOURCE}
+            UPDATE_DISCONNECTED ON
+            BUILD_IN_SOURCE ON
+            CONFIGURE_COMMAND ${CMAKE_COMMAND} -E make_directory ${BINARY_DIR}/lib ${BINARY_DIR}/include
+            BUILD_COMMAND ${CMAKE_C_COMPILER} -c -O2 -fPIC -I<SOURCE_DIR> <SOURCE_DIR>/ikcp.c -o ikcp.o
+                COMMAND ${CMAKE_AR} rcs libikcp.a ikcp.o
+            INSTALL_COMMAND ${CMAKE_COMMAND} -E copy libikcp.a ${BINARY_DIR}/lib/
+                COMMAND ${CMAKE_COMMAND} -E copy <SOURCE_DIR>/ikcp.h ${BINARY_DIR}/include/
+        )
+        ExternalProject_Get_Property(kcp SOURCE_DIR)
+        set(kcp_SOURCE_DIR ${SOURCE_DIR} PARENT_SCOPE)
+        set(kcp_static ${BINARY_DIR}/lib/libikcp.a PARENT_SCOPE)
+
     endif ()
 
     list(APPEND actually_built ${dep})

CMakeLists.txt

@@ -36,6 +36,7 @@ option(PHOTON_ENABLE_RSOCKET "enable rsocket" OFF)
 option(PHOTON_ENABLE_LIBCURL "enable libcurl" ON)
 set(PHOTON_DEFAULT_LOG_LEVEL "0" CACHE STRING "default log level")
 option(PHOTON_BUILD_OCF_CACHE "enable ocf cache" OFF)
+option(PHOTON_ENABLE_KCP "enable kcp" OFF)
 
 option(PHOTON_BUILD_DEPENDENCIES "" OFF)
 set(PHOTON_AIO_SOURCE "https://pagure.io/libaio/archive/libaio-0.3.113/libaio-0.3.113.tar.gz" CACHE STRING "")
@@ -60,6 +61,7 @@ set(PHOTON_RAPIDYAML_SOURCE "https://github.com/biojppm/rapidyaml/releases/downl
 # It's not recommended to build rdmacore from source because it has too many dependencies. Install it to local host.
 # The release version we use is https://github.com/linux-rdma/rdma-core/releases/download/v58.0/rdma-core-58.0.tar.gz
 set(PHOTON_RDMACORE_SOURCE "" CACHE STRING "")
+set(PHOTON_KCP_SOURCE "https://github.com/skywind3000/kcp/archive/refs/tags/2.1.1.tar.gz" CACHE STRING "")
 
 if (NOT (CMAKE_SYSTEM_PROCESSOR STREQUAL x86_64) AND NOT (CMAKE_SYSTEM_PROCESSOR STREQUAL aarch64) AND NOT (CMAKE_SYSTEM_PROCESSOR STREQUAL arm64))
     message(FATAL_ERROR "Unknown CPU architecture ${CMAKE_SYSTEM_PROCESSOR}")
@@ -180,6 +182,9 @@ endif ()
 if (PHOTON_ENABLE_LIBCURL)
     LIST(APPEND dependencies curl)
 endif()
+if (PHOTON_ENABLE_KCP)
+    LIST(APPEND dependencies kcp)
+endif()
 if (PHOTON_BUILD_TESTING)
     LIST(APPEND dependencies gflags googletest)
 endif ()
@@ -188,7 +193,11 @@ FOREACH (dep ${dependencies})
     message(STATUS "Checking dependency ${dep}")
     string(TOUPPER ${dep} DEP)
     set(source_url "${PHOTON_${DEP}_SOURCE}")
-    if (PHOTON_BUILD_DEPENDENCIES AND (NOT source_url STREQUAL ""))
+    if (dep STREQUAL "kcp")
+        message(STATUS "Will build ${dep} from source")
+        message(STATUS "    URL: ${source_url}")
+        build_from_src(dep)
+    elseif (PHOTON_BUILD_DEPENDENCIES AND (NOT source_url STREQUAL ""))
         message(STATUS "Will build ${dep} from source")
         message(STATUS "    URL: ${source_url}")
         build_from_src(dep)
@@ -282,6 +291,9 @@ if (PHOTON_ENABLE_ECOSYSTEM)
     file(GLOB ECOSYSTEM_SRC ecosystem/*.cpp)
     list(APPEND PHOTON_SRC ${ECOSYSTEM_SRC})
 endif ()
+if (NOT PHOTON_ENABLE_KCP)
+    list(REMOVE_ITEM PHOTON_SRC net/kcp.cpp)
+endif ()
 if (PHOTON_ENABLE_RSOCKET)
     list(APPEND PHOTON_SRC net/rsocket/rsocket.cpp)
 endif ()
@@ -338,6 +350,10 @@ endif()
 if (PHOTON_DEFAULT_LOG_LEVEL)
     target_compile_definitions(photon_obj PRIVATE DEFAULT_LOG_LEVEL=${PHOTON_DEFAULT_LOG_LEVEL})
 endif()
+if (PHOTON_ENABLE_KCP)
+    target_include_directories(photon_obj PRIVATE ${kcp_SOURCE_DIR})
+    target_compile_definitions(photon_obj PRIVATE PHOTON_KCP=on)
+endif()
 
 if (actually_built)
     add_dependencies(photon_obj ${actually_built})
@@ -397,6 +413,10 @@ if (PHOTON_BUILD_OCF_CACHE)
 endif()
 list(APPEND static_deps ${OPENSSL_LIBRARIES} ${ZLIB_LIBRARIES})
 
+if (PHOTON_ENABLE_KCP)
+    list(APPEND static_deps ${kcp_static})
+endif()
+
 
 # Find out dynamic libs and append to `shared_deps`.
 # Because if not built from source, we won't know the local packages are static or shared.

include/photon/net/kcp.h

@@ -0,0 +1 @@
+../../../net/kcp.h

net/datagram_socket.cpp

@@ -65,7 +65,7 @@ class DatagramSocketBase : public IDatagramSocket {
     virtual uint64_t max_message_size() override { return m_max_msg_size; }
 
     int do_connect(const sockaddr_storage* s) {
-        return DOIO_ONCE(::connect(fd, s->get_sockaddr(), s->get_socklen()), wait_for_fd_writable(fd));
+        return DOIO_ONCE(::connect(fd, s->get_sockaddr(), s->get_socklen()), wait_for_fd_writable(fd, m_timeout));
     }
 
     int do_bind(const sockaddr_storage* s) {
@@ -84,7 +84,7 @@ class DatagramSocketBase : public IDatagramSocket {
             .msg_flags = 0,
         };
         return DOIO_ONCE(::sendmsg(fd, &hdr, MSG_DONTWAIT | flags),
-                     wait_for_fd_writable(fd));
+                     wait_for_fd_writable(fd, m_timeout));
     }
     ssize_t do_recv(const iovec* iov, int iovcnt, sockaddr* addr,
                     size_t* addrlen, int flags) {
@@ -98,7 +98,7 @@ class DatagramSocketBase : public IDatagramSocket {
             .msg_flags = 0,
         };
         auto ret = DOIO_ONCE(::recvmsg(fd, &hdr, MSG_DONTWAIT | flags),
-                         wait_for_fd_readable(fd));
+                         wait_for_fd_readable(fd, m_timeout));
         if (addrlen) *addrlen = hdr.msg_namelen;
         return ret;
     }

net/datagram_socket.h

@@ -66,6 +66,7 @@ class UDPSocket : public IDatagramSocket {
 public:
     using base::recv;
     using base::send;
+    using base::timeout;
     int connect(const EndPoint& ep)   { return connect((Addr*)&ep, sizeof(ep)); }
     int bind(const EndPoint& ep)      { return bind((Addr*)&ep, sizeof(ep)); }
     int bind(uint16_t port = 0)       { return bind_v4any(0); }