Re: ws2_32: WSACleanup cleans up open sockets (OSX only)

[Matt Durgavich]

Here’s my attempt at Bruno’s patch with a fast cache. Comments welcome.
-Matt

diff --git a/dlls/ws2_32/socket.c b/dlls/ws2_32/socket.c
index ca82ec9..65925ba 100644
--- a/dlls/ws2_32/socket.c
+++ b/dlls/ws2_32/socket.c
@@ -1429,6 +1429,15 @@ static int set_ipx_packettype(int sock, int ptype)
 #endif
 }

+#define CACHE_SIZE  256
+#define CACHE_DEPTH 16
+static SOCKET socket_cache[CACHE_SIZE][CACHE_DEPTH];
+
+/* Cache support */
+static void add_to_cache(SOCKET s);
+static BOOL remove_from_cache(SOCKET s);
+static BOOL socket_in_cache(SOCKET s);
+
 /* ----------------------------------- API -----
  *
  * Init / cleanup / error checking.
@@ -1470,8 +1479,24 @@ int WINAPI WSAStartup(WORD wVersionRequested, LPWSADATA lpWSAData)
 INT WINAPI WSACleanup(void)
 {
     if (num_startup) {
-        num_startup--;
-        TRACE("pending cleanups: %d\n", num_startup);
+        /* WS_closesocket needs num_startup to be non-zero, so decrement afterwards */
+        if (num_startup - 1 == 0) {
+            TRACE("cleaning up sockets");
+            int i, j;
+            for (i = 0; i < CACHE_SIZE; ++i) {
+                for (j = 0; j < CACHE_DEPTH; ++j) {
+                    SOCKET s = socket_cache[i][j];
+                    if (s) {
+                        WS_closesocket(s);
+                    }
+                }
+            }
+            num_startup--;
+        } else {
+            num_startup--;
+            TRACE("pending cleanups: %d\n", num_startup);
+        }
+
         return 0;
     }
     SetLastError(WSANOTINITIALISED);
@@ -2595,6 +2620,11 @@ SOCKET WINAPI WS_accept(SOCKET s, struct WS_sockaddr *addr, int *addrlen32)
                 WS_closesocket(as);
                 return SOCKET_ERROR;
             }
+            else 
+            {
+                add_to_cache(as);
+            }
+
             TRACE("\taccepted %04lx\n", as);
             return as;
         }
@@ -2965,15 +2995,21 @@ int WINAPI WS_closesocket(SOCKET s)
     int res = SOCKET_ERROR, fd;
     if (num_startup)
     {
+        BOOL success = FALSE;
         fd = get_sock_fd(s, FILE_READ_DATA, NULL);
         if (fd >= 0)
         {
             release_sock_fd(s, fd);
             if (CloseHandle(SOCKET2HANDLE(s)))
                 res = 0;
+
+            success = remove_from_cache(s);
         }
-        else
+
+        if (!success) {
             SetLastError(WSAENOTSOCK);
+            res = SOCKET_ERROR;
+        }
     }
     else
         SetLastError(WSANOTINITIALISED);
@@ -4987,6 +5023,11 @@ static int WS2_sendto( SOCKET s, LPWSABUF lpBuffers, DWORD dwBufferCount,
     DWORD bytes_sent;
     BOOL is_blocking;

+    if (!socket_in_cache(s)) {
+        SetLastError(WSAENOTSOCK);
+        return SOCKET_ERROR;;
+    }
+
     TRACE("socket %04lx, wsabuf %p, nbufs %d, flags %d, to %p, tolen %d, ovl %p, func %p\n",
           s, lpBuffers, dwBufferCount, dwFlags,
           to, tolen, lpOverlapped, lpCompletionRoutine);
@@ -6706,6 +6747,7 @@ SOCKET WINAPI WSASocketW(int af, int type, int protocol,
     SERVER_END_REQ;
     if (ret)
     {
+        add_to_cache(ret);
         TRACE("\tcreated %04lx\n", ret );
         if (ipxptype > 0)
             set_ipx_packettype(ret, ipxptype);
@@ -8107,3 +8149,73 @@ INT WINAPI WSCEnumProtocols( LPINT protocols, LPWSAPROTOCOL_INFOW buffer, LPDWOR

return ret;
 }
+
+/*****************/
+/* Cache support */
+
+static inline DWORD socket_to_index(SOCKET s)
+{
+    /* Hash to entry using Bernstein function */
+    DWORD h = 52812;
+    BYTE *b = (BYTE*)&s;
+    h = ((h << 5) + h) ^ b[0];
+    h = ((h << 5) + h) ^ b[1];
+    h = ((h << 5) + h) ^ b[2];
+    h = ((h << 5) + h) ^ b[3];
+    return h;
+}
+
+static void add_to_cache(SOCKET s)
+{
+    int index, depth;
+    SOCKET old;
+    LONG *dest;
+    index = socket_to_index(s) % CACHE_SIZE; 
+    for (depth = 0; depth < CACHE_DEPTH; ++depth) {
+        if (socket_cache[index][depth] == 0)
+            break;
+    }
+
+    if (depth == CACHE_DEPTH) {
+        ERR("Socket hash table collision\n");
+    }
+
+    dest = (PLONG)&socket_cache[index][depth]; 
+    old = InterlockedExchange(dest, s);
+
+    if (old != 0) {
+        ERR("Socket hash table internal corruption");
+    }
+}
+
+static BOOL remove_from_cache(SOCKET s)
+{
+    int index,depth;
+    SOCKET old;
+    LONG *dest;
+    index = socket_to_index(s) % CACHE_SIZE;
+    for (depth = 0; depth < CACHE_DEPTH; ++depth) {
+        if (socket_cache[index][depth] == s)
+            break;
+    }
+
+    if (depth == CACHE_DEPTH) {
+        return FALSE;
+    }
+
+    dest = (PLONG)&socket_cache[index][depth];
+    old = InterlockedExchange(dest, 0);
+    return (old == s);
+}
+
+static inline BOOL socket_in_cache(SOCKET s)
+{
+    int index, depth;
+    index = socket_to_index(s) % CACHE_SIZE;
+    for (depth = 0; depth < CACHE_SIZE; ++depth) {
+        if (socket_cache[index][depth] == s)
+            return TRUE;
+    }
+
+    return FALSE; 
+}
diff --git a/dlls/ws2_32/tests/sock.c b/dlls/ws2_32/tests/sock.c
index 2d14496..afa4063 100644
--- a/dlls/ws2_32/tests/sock.c
+++ b/dlls/ws2_32/tests/sock.c
@@ -1119,7 +1119,6 @@ static void test_WithWSAStartup(void)
     ok(res == 0, "WSAStartup() failed unexpectedly: %d\n", res);

/* show that sockets are destroyed automatically after WSACleanup */
-    todo_wine {
     SetLastError(0xdeadbeef);
     res = send(src, "TEST", 4, 0);
     error = WSAGetLastError();
@@ -1131,7 +1130,6 @@ static void test_WithWSAStartup(void)
     error = WSAGetLastError();
     ok(res == SOCKET_ERROR, "closesocket should have failed\n");
     ok(error == WSAENOTSOCK, "expected 10038, got %d\n", error);
-    }

closesocket(src);
     closesocket(dst);