[WSHTCPIP][TCPIP] Implement SO_KEEPALIVE, SIO_KEEPALIVE_VALS

Author: MishaProductions

dll/win32/wshtcpip/wshtcpip.c

@@ -167,12 +167,11 @@ GetTdiTypeId(
     switch (Level)
     {
        case SOL_SOCKET:
-          *TdiType = INFO_TYPE_ADDRESS_OBJECT;
+          *TdiType = INFO_TYPE_CONNECTION;
           switch (OptionName)
           {
              case SO_KEEPALIVE:
-                /* FIXME: Return proper option */
-                ASSERT(FALSE);
+                *TdiId = TCP_SOCKET_KEEPALIVE;
                 break;
              default:
                 break;
@@ -352,6 +351,9 @@ WSHIoctl(
     OUT LPBOOL NeedsCompletion)
 {
     INT res;
+    PSOCKET_CONTEXT Context = HelperDllSocketContext;
+    PTCP_REQUEST_SET_INFORMATION_EX Info;
+    PQUEUED_REQUEST Queued, NextQueued;
 
     if (IoControlCode == SIO_GET_INTERFACE_LIST)
     {
@@ -362,6 +364,67 @@ WSHIoctl(
             NeedsCompletion);
         return res;
     }
+    else if (IoControlCode == SIO_KEEPALIVE_VALS)
+    {
+        if (!InputBuffer || InputBufferLength != sizeof(struct tcp_keepalive))
+        {
+            return WSAEINVAL;
+        }
+
+        Info = HeapAlloc(GetProcessHeap(), 0, sizeof(*Info) + InputBufferLength);
+        if (!Info)
+            return WSAENOBUFS;
+
+        Info->ID.toi_entity.tei_entity = Context->AddrFileEntityType;
+        Info->ID.toi_entity.tei_instance = Context->AddrFileInstance;
+        Info->ID.toi_class = INFO_CLASS_PROTOCOL;
+        Info->ID.toi_type = INFO_TYPE_CONNECTION;
+        Info->ID.toi_id = TCP_SOCKET_KEEPALIVEVALS;
+        Info->BufferSize = InputBufferLength;
+        memcpy(Info->Buffer, InputBuffer, InputBufferLength);
+
+        if (Context->SocketState == SocketStateCreated)
+        {
+            if (Context->RequestQueue)
+            {
+                Queued = Context->RequestQueue;
+                while ((NextQueued = Queued->Next))
+                {
+                    Queued = NextQueued;
+                }
+
+                Queued->Next = HeapAlloc(GetProcessHeap(), 0, sizeof(QUEUED_REQUEST));
+                if (!Queued->Next)
+                {
+                    HeapFree(GetProcessHeap(), 0, Info);
+                    return WSAENOBUFS;
+                }
+
+                NextQueued = Queued->Next;
+                NextQueued->Next = NULL;
+                NextQueued->Info = Info;
+            }
+            else
+            {
+                Context->RequestQueue = HeapAlloc(GetProcessHeap(), 0, sizeof(QUEUED_REQUEST));
+                if (!Context->RequestQueue)
+                {
+                    HeapFree(GetProcessHeap(), 0, Info);
+                    return WSAENOBUFS;
+                }
+
+                Context->RequestQueue->Next = NULL;
+                Context->RequestQueue->Info = Info;
+            }
+
+            return 0;
+        }
+
+        res = SendRequest(Info, sizeof(*Info) + Info->BufferSize, IOCTL_TCP_SET_INFORMATION_EX);
+
+        HeapFree(GetProcessHeap(), 0, Info);
+        return res;
+    }
 
     UNIMPLEMENTED;
 
@@ -690,9 +753,11 @@ WSHSetSocketInformation(
                     return 0;
 
                 case SO_KEEPALIVE:
-                    /* FIXME -- We'll send this to TCPIP */
-                    DPRINT1("Set: SO_KEEPALIVE not yet supported\n");
-                    return 0;
+                    if (OptionLength < sizeof(DWORD))
+                    {
+                        return WSAEFAULT;
+                    }
+                    break;
 
                 default:
                     /* Invalid option */

dll/win32/wshtcpip/wshtcpip.h

@@ -21,6 +21,7 @@
 #include <tdilib.h>
 #include <ws2tcpip.h>
 #include <rtlfuncs.h>
+#include <mstcpip.h>
 
 #define EXPORT WINAPI
 
@@ -59,6 +60,12 @@ WSHIoctl_GetInterfaceList(
     OUT LPDWORD NumberOfBytesReturned,
     OUT LPBOOL NeedsCompletion);
 
+INT
+SendRequest(
+    IN PVOID Request,
+    IN DWORD RequestSize,
+    IN DWORD IOCTL);
+
 #endif /* __WSHTCPIP_H */
 
 /* EOF */

drivers/network/tcpip/include/tcp.h

@@ -188,6 +188,10 @@ BOOLEAN TCPRemoveIRP( PCONNECTION_ENDPOINT Connection, PIRP Irp );
 
 NTSTATUS TCPSetNoDelay(PCONNECTION_ENDPOINT Connection, BOOLEAN Set);
 
+NTSTATUS TCPSetKeepAlive(PCONNECTION_ENDPOINT Connection, BOOLEAN Set);
+
+NTSTATUS TCPSetKeepAliveValues(PCONNECTION_ENDPOINT Connection, DWORD KeepAliveTime, DWORD KeepAliveInterval);
+
 VOID
 TCPUpdateInterfaceLinkStatus(PIP_INTERFACE IF);
 

drivers/network/tcpip/ip/lwip_glue/lwip_glue.h

@@ -114,6 +114,8 @@ err_t       LibTCPGetPeerName(PTCP_PCB pcb, ip4_addr_t *const ipaddr, u16_t *con
 err_t       LibTCPGetHostName(PTCP_PCB pcb, ip4_addr_t *const ipaddr, u16_t *const port);
 void        LibTCPAccept(PTCP_PCB pcb, struct tcp_pcb *listen_pcb, void *arg);
 void        LibTCPSetNoDelay(PTCP_PCB pcb, BOOLEAN Set);
+void        LibTCPSetKeepAlive(PTCP_PCB pcb, BOOLEAN Set);
+void        LibTcpSetKeepAliveValues(PTCP_PCB pcb, u32_t KeepAliveTime, u32_t KeepAliveInterval);
 void        LibTCPGetSocketStatus(PTCP_PCB pcb, PULONG State);
 
 /* IP functions */

drivers/network/tcpip/ip/lwip_glue/tcp.c

@@ -875,6 +875,29 @@ LibTCPSetNoDelay(
         pcb->flags &= ~TF_NODELAY;
 }
 
+void
+LibTCPSetKeepAlive(
+    PTCP_PCB pcb,
+    BOOLEAN Set)
+{
+    if (Set)
+        pcb->so_options |= SOF_KEEPALIVE;
+    else
+        pcb->so_options &= ~SOF_KEEPALIVE;
+}
+
+void
+LibTcpSetKeepAliveValues(
+    PTCP_PCB pcb,
+    u32_t KeepAliveTime,
+    u32_t KeepAliveInterval
+)
+{
+    pcb->keep_idle = KeepAliveTime;
+    pcb->keep_intvl = KeepAliveInterval;
+    pcb->keep_cnt = 10;
+}
+
 void
 LibTCPGetSocketStatus(
     PTCP_PCB pcb,

drivers/network/tcpip/ip/transport/tcp/tcp.c

@@ -745,6 +745,37 @@ TCPSetNoDelay(
     return STATUS_SUCCESS;
 }
 
+NTSTATUS
+TCPSetKeepAlive(
+    PCONNECTION_ENDPOINT Connection,
+    BOOLEAN Value)
+{
+    if (!Connection)
+        return STATUS_UNSUCCESSFUL;
+
+    if (Connection->SocketContext == NULL)
+        return STATUS_UNSUCCESSFUL;
+
+    LibTCPSetKeepAlive(Connection->SocketContext, Value);
+    return STATUS_SUCCESS;
+}
+
+NTSTATUS
+TCPSetKeepAliveValues(
+    PCONNECTION_ENDPOINT Connection,
+    DWORD KeepAliveTime,
+    DWORD KeepAliveInterval)
+{
+    if (!Connection)
+        return STATUS_UNSUCCESSFUL;
+
+    if (Connection->SocketContext == NULL)
+        return STATUS_UNSUCCESSFUL;
+
+    LibTcpSetKeepAliveValues(Connection->SocketContext, KeepAliveTime, KeepAliveInterval);
+    return STATUS_SUCCESS;
+}
+
 NTSTATUS
 TCPGetSocketStatus(
     PCONNECTION_ENDPOINT Connection,

drivers/network/tcpip/lwip/src/include/lwip/opt.h

@@ -2045,7 +2045,7 @@
  * in seconds. (does not require sockets.c, and will affect tcp.c)
  */
 #if !defined LWIP_TCP_KEEPALIVE || defined __DOXYGEN__
-#define LWIP_TCP_KEEPALIVE              0
+#define LWIP_TCP_KEEPALIVE              1
 #endif
 
 /**

drivers/network/tcpip/lwip/src/include/lwip/priv/tcp_priv.h

@@ -140,12 +140,22 @@ err_t            tcp_process_refused_data(struct tcp_pcb *pcb);
 #endif
 
 #ifndef  TCP_KEEPINTVL_DEFAULT
+#ifdef __REACTOS__
+/* According to https://learn.microsoft.com/en-us/windows/win32/winsock/sio-keepalive-vals, default keep alive interval is 1 second */
+#define  TCP_KEEPINTVL_DEFAULT    1000UL   /* Default Time between KEEPALIVE probes in milliseconds */
+#else
 #define  TCP_KEEPINTVL_DEFAULT    75000UL   /* Default Time between KEEPALIVE probes in milliseconds */
 #endif
+#endif
 
 #ifndef  TCP_KEEPCNT_DEFAULT
+#ifdef __REACTOS__
+/* According to https://learn.microsoft.com/en-us/windows/win32/winsock/sio-keepalive-vals, default probe count is 10 for vista+ */
+#define  TCP_KEEPCNT_DEFAULT      10U        /* Default Counter for KEEPALIVE probes */
+#else
 #define  TCP_KEEPCNT_DEFAULT      9U        /* Default Counter for KEEPALIVE probes */
 #endif
+#endif
 
 #define  TCP_MAXIDLE              TCP_KEEPCNT_DEFAULT * TCP_KEEPINTVL_DEFAULT  /* Maximum KEEPALIVE probe time */
 

drivers/network/tcpip/tcpip/cinfo.c

@@ -6,13 +6,21 @@
  * PROGRAMMER:  Jérôme Gardou
  */
 
+#include "ntdef.h"
 #include "precomp.h"
 
+typedef struct tcp_keepalive {
+  ULONG onoff;
+  ULONG keepalivetime;
+  ULONG keepaliveinterval;
+} TCP_KEEPALIVE;
+
 TDI_STATUS SetConnectionInfo(TDIObjectID *ID,
                              PCONNECTION_ENDPOINT Connection,
                              PVOID Buffer,
                              UINT BufferSize)
 {
+    NTSTATUS Status;
     ASSERT(ID->toi_type == INFO_TYPE_CONNECTION);
     switch (ID->toi_id)
     {
@@ -24,6 +32,26 @@ TDI_STATUS SetConnectionInfo(TDIObjectID *ID,
             Set = *(BOOLEAN*)Buffer;
             return TCPSetNoDelay(Connection, Set);
         }
+        case TCP_SOCKET_KEEPALIVE:
+        {
+            DWORD Set;
+            if (BufferSize < sizeof(DWORD))
+                return TDI_INVALID_PARAMETER;
+            Set = *(DWORD*)Buffer;
+            return TCPSetKeepAlive(Connection, Set);
+        }
+        case TCP_SOCKET_KEEPALIVEVALS:
+        {
+            TCP_KEEPALIVE Set;
+            if (BufferSize < sizeof(TCP_KEEPALIVE))
+                return TDI_INVALID_PARAMETER;
+            Set = *(TCP_KEEPALIVE*)Buffer;
+            Status = TCPSetKeepAlive(Connection, Set.onoff);
+            if (!NT_SUCCESS(Status))
+                return Status;
+            
+            return TCPSetKeepAliveValues(Connection, Set.keepalivetime, Set.keepaliveinterval);
+        }
         default:
             DbgPrint("TCPIP: Unknown connection info ID: %u.\n", ID->toi_id);
     }

sdk/include/psdk/tcpioctl.h

@@ -105,6 +105,8 @@
 
 /* TCP connection options */
 #define TCP_SOCKET_NODELAY 1
+#define TCP_SOCKET_KEEPALIVE 2
+#define TCP_SOCKET_KEEPALIVEVALS 3
 
 typedef struct IFEntry
 {