mono/metadata/w32socket-win32.c

   1 /**
   2  * \file
   3  * Windows specific socket code.
   4  *
   5  * Copyright 2016 Microsoft
   6  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
   7  */
   8
   9 #include <config.h>
  10 #include <glib.h>
  11
  12 #include <string.h>
  13 #include <stdlib.h>
  14 #include <ws2tcpip.h>
  15 #ifdef HAVE_UNISTD_H
  16 #include <unistd.h>
  17 #endif
  18 #include <errno.h>
  19
  20 #include <sys/types.h>
  21
  22 #include "w32socket.h"
  23 #include "w32socket-internals.h"
  24
  25 #include "utils/w32api.h"
  26
  27 #define LOGDEBUG(...)
  28
  29 void
  30 mono_w32socket_initialize (void)
  31 {
  32 }
  33
  34 void
  35 mono_w32socket_cleanup (void)
  36 {
  37 }
  38
  39 static gboolean set_blocking (SOCKET sock, gboolean block)
  40 {
  41         u_long non_block = block ? 0 : 1;
  42         return ioctlsocket (sock, FIONBIO, &non_block) != SOCKET_ERROR;
  43 }
  44
  45 static DWORD get_socket_timeout (SOCKET sock, int optname)
  46 {
  47         DWORD timeout = 0;
  48         int optlen = sizeof (DWORD);
  49         if (getsockopt (sock, SOL_SOCKET, optname, (char *)&timeout, &optlen) == SOCKET_ERROR) {
  50                 WSASetLastError (0);
  51                 return WSA_INFINITE;
  52         }
  53         if (timeout == 0)
  54                 timeout = WSA_INFINITE; // 0 means infinite
  55         return timeout;
  56 }
  57
  58 /*
  59 * Performs an alertable wait for the specified event (FD_ACCEPT_BIT,
  60 * FD_CONNECT_BIT, FD_READ_BIT, FD_WRITE_BIT) on the specified socket.
  61 * Returns TRUE if the event is fired without errors. Calls WSASetLastError()
  62 * with WSAEINTR and returns FALSE if the thread is alerted. If the event is
  63 * fired but with an error WSASetLastError() is called to set the error and the
  64 * function returns FALSE.
  65 */
  66 static gboolean alertable_socket_wait (SOCKET sock, int event_bit)
  67 {
  68         static char *EVENT_NAMES[] = { "FD_READ", "FD_WRITE", NULL /*FD_OOB*/, "FD_ACCEPT", "FD_CONNECT", "FD_CLOSE" };
  69         gboolean success = FALSE;
  70         int error = -1;
  71         DWORD timeout = WSA_INFINITE;
  72         if (event_bit == FD_READ_BIT || event_bit == FD_WRITE_BIT) {
  73                 timeout = get_socket_timeout (sock, event_bit == FD_READ_BIT ? SO_RCVTIMEO : SO_SNDTIMEO);
  74         }
  75         WSASetLastError (0);
  76         WSAEVENT event = WSACreateEvent ();
  77         if (event != WSA_INVALID_EVENT) {
  78                 if (WSAEventSelect (sock, event, (1 << event_bit) | FD_CLOSE) != SOCKET_ERROR) {
  79                         LOGDEBUG (g_message ("%06d - Calling WSAWaitForMultipleEvents () on socket %d", GetCurrentThreadId (), sock));
  80                         DWORD ret = WSAWaitForMultipleEvents (1, &event, TRUE, timeout, TRUE);
  81                         if (ret == WSA_WAIT_IO_COMPLETION) {
  82                                 LOGDEBUG (g_message ("%06d - WSAWaitForMultipleEvents () returned WSA_WAIT_IO_COMPLETION for socket %d", GetCurrentThreadId (), sock));
  83                                 error = WSAEINTR;
  84                         } else if (ret == WSA_WAIT_TIMEOUT) {
  85                                 error = WSAETIMEDOUT;
  86                         } else {
  87                                 g_assert (ret == WSA_WAIT_EVENT_0);
  88                                 WSANETWORKEVENTS ne = { 0 };
  89                                 if (WSAEnumNetworkEvents (sock, event, &ne) != SOCKET_ERROR) {
  90                                         if (ne.lNetworkEvents & (1 << event_bit) && ne.iErrorCode[event_bit]) {
  91                                                 LOGDEBUG (g_message ("%06d - %s error %d on socket %d", GetCurrentThreadId (), EVENT_NAMES[event_bit], ne.iErrorCode[event_bit], sock));
  92                                                 error = ne.iErrorCode[event_bit];
  93                                         } else if (ne.lNetworkEvents & FD_CLOSE_BIT && ne.iErrorCode[FD_CLOSE_BIT]) {
  94                                                 LOGDEBUG (g_message ("%06d - FD_CLOSE error %d on socket %d", GetCurrentThreadId (), ne.iErrorCode[FD_CLOSE_BIT], sock));
  95                                                 error = ne.iErrorCode[FD_CLOSE_BIT];
  96                                         } else {
  97                                                 LOGDEBUG (g_message ("%06d - WSAEnumNetworkEvents () finished successfully on socket %d", GetCurrentThreadId (), sock));
  98                                                 success = TRUE;
  99                                                 error = 0;
 100                                         }
 101                                 }
 102                         }
 103                         WSAEventSelect (sock, NULL, 0);
 104                 }
 105                 WSACloseEvent (event);
 106         }
 107         if (error != -1) {
 108                 WSASetLastError (error);
 109         }
 110         return success;
 111 }
 112
 113 #define ALERTABLE_SOCKET_CALL(event_bit, blocking, repeat, ret, op, sock, ...) \
 114         LOGDEBUG (g_message ("%06d - Performing %s " #op " () on socket %d", GetCurrentThreadId (), blocking ? "blocking" : "non-blocking", sock)); \
 115         if (blocking) { \
 116                 if (set_blocking(sock, FALSE)) { \
 117                         while (-1 == (int) (ret = op (sock, __VA_ARGS__))) { \
 118                                 int _error = WSAGetLastError ();\
 119                                 if (_error != WSAEWOULDBLOCK && _error != WSA_IO_PENDING) \
 120                                         break; \
 121                                 if (!alertable_socket_wait (sock, event_bit) || !repeat) \
 122                                         break; \
 123                         } \
 124                         int _saved_error = WSAGetLastError (); \
 125                         set_blocking (sock, TRUE); \
 126                         WSASetLastError (_saved_error); \
 127                 } \
 128         } else { \
 129                 ret = op (sock, __VA_ARGS__); \
 130         } \
 131         int _saved_error = WSAGetLastError (); \
 132         LOGDEBUG (g_message ("%06d - Finished %s " #op " () on socket %d (ret = %d, WSAGetLastError() = %d)", GetCurrentThreadId (), \
 133                 blocking ? "blocking" : "non-blocking", sock, ret, _saved_error)); \
 134         WSASetLastError (_saved_error);
 135
 136 SOCKET mono_w32socket_accept (SOCKET s, struct sockaddr *addr, socklen_t *addrlen, gboolean blocking)
 137 {
 138         MonoInternalThread *curthread = mono_thread_internal_current ();
 139         SOCKET newsock = INVALID_SOCKET;
 140         ALERTABLE_SOCKET_CALL (FD_ACCEPT_BIT, blocking, TRUE, newsock, accept, s, addr, addrlen);
 141         return newsock;
 142 }
 143
 144 int mono_w32socket_connect (SOCKET s, const struct sockaddr *name, int namelen, gboolean blocking)
 145 {
 146         int ret = SOCKET_ERROR;
 147         ALERTABLE_SOCKET_CALL (FD_CONNECT_BIT, blocking, FALSE, ret, connect, s, name, namelen);
 148         ret = WSAGetLastError () != 0 ? SOCKET_ERROR : 0;
 149         return ret;
 150 }
 151
 152 int mono_w32socket_recv (SOCKET s, char *buf, int len, int flags, gboolean blocking)
 153 {
 154         MonoInternalThread *curthread = mono_thread_internal_current ();
 155         int ret = SOCKET_ERROR;
 156         ALERTABLE_SOCKET_CALL (FD_READ_BIT, blocking, TRUE, ret, recv, s, buf, len, flags);
 157         return ret;
 158 }
 159
 160 int mono_w32socket_recvfrom (SOCKET s, char *buf, int len, int flags, struct sockaddr *from, socklen_t *fromlen, gboolean blocking)
 161 {
 162         int ret = SOCKET_ERROR;
 163         ALERTABLE_SOCKET_CALL (FD_READ_BIT, blocking, TRUE, ret, recvfrom, s, buf, len, flags, from, fromlen);
 164         return ret;
 165 }
 166
 167 int mono_w32socket_recvbuffers (SOCKET s, WSABUF *lpBuffers, guint32 dwBufferCount, guint32 *lpNumberOfBytesRecvd, guint32 *lpFlags, gpointer lpOverlapped, gpointer lpCompletionRoutine, gboolean blocking)
 168 {
 169         int ret = SOCKET_ERROR;
 170         ALERTABLE_SOCKET_CALL (FD_READ_BIT, blocking, TRUE, ret, WSARecv, s, lpBuffers, dwBufferCount, lpNumberOfBytesRecvd, lpFlags, lpOverlapped, lpCompletionRoutine);
 171         return ret;
 172 }
 173
 174 int mono_w32socket_send (SOCKET s, char *buf, int len, int flags, gboolean blocking)
 175 {
 176         int ret = SOCKET_ERROR;
 177         ALERTABLE_SOCKET_CALL (FD_WRITE_BIT, blocking, FALSE, ret, send, s, buf, len, flags);
 178         return ret;
 179 }
 180
 181 int mono_w32socket_sendto (SOCKET s, const char *buf, int len, int flags, const struct sockaddr *to, int tolen, gboolean blocking)
 182 {
 183         int ret = SOCKET_ERROR;
 184         ALERTABLE_SOCKET_CALL (FD_WRITE_BIT, blocking, FALSE, ret, sendto, s, buf, len, flags, to, tolen);
 185         return ret;
 186 }
 187
 188 int mono_w32socket_sendbuffers (SOCKET s, WSABUF *lpBuffers, guint32 dwBufferCount, guint32 *lpNumberOfBytesRecvd, guint32 lpFlags, gpointer lpOverlapped, gpointer lpCompletionRoutine, gboolean blocking)
 189 {
 190         int ret = SOCKET_ERROR;
 191         ALERTABLE_SOCKET_CALL (FD_WRITE_BIT, blocking, FALSE, ret, WSASend, s, lpBuffers, dwBufferCount, lpNumberOfBytesRecvd, lpFlags, lpOverlapped, lpCompletionRoutine);
 192         return ret;
 193 }
 194
 195 #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT)
 196 BOOL mono_w32socket_transmit_file (SOCKET hSocket, gpointer hFile, TRANSMIT_FILE_BUFFERS *lpTransmitBuffers, guint32 dwReserved, gboolean blocking)
 197 {
 198         LOGDEBUG (g_message ("%06d - Performing %s TransmitFile () on socket %d", GetCurrentThreadId (), blocking ? "blocking" : "non-blocking", hSocket));
 199
 200         int error = 0;
 201         if (blocking) {
 202                 OVERLAPPED overlapped = { 0 };
 203                 overlapped.hEvent = WSACreateEvent ();
 204                 if (overlapped.hEvent == WSA_INVALID_EVENT)
 205                         return FALSE;
 206                 if (!TransmitFile (hSocket, hFile, 0, 0, &overlapped, lpTransmitBuffers, dwReserved)) {
 207                         error = WSAGetLastError ();
 208                         if (error == WSA_IO_PENDING) {
 209                                 error = 0;
 210                                 // NOTE: .NET's Socket.SendFile() doesn't honor the Socket's SendTimeout so we shouldn't either
 211                                 DWORD ret = WaitForSingleObjectEx (overlapped.hEvent, INFINITE, TRUE);
 212                                 if (ret == WAIT_IO_COMPLETION) {
 213                                         LOGDEBUG (g_message ("%06d - WaitForSingleObjectEx () returned WSA_WAIT_IO_COMPLETION for socket %d", GetCurrentThreadId (), hSocket));
 214                                         error = WSAEINTR;
 215                                 } else if (ret == WAIT_TIMEOUT) {
 216                                         error = WSAETIMEDOUT;
 217                                 } else if (ret != WAIT_OBJECT_0) {
 218                                         error = GetLastError ();
 219                                 }
 220                         }
 221                 }
 222                 WSACloseEvent (overlapped.hEvent);
 223         } else {
 224                 if (!TransmitFile (hSocket, hFile, 0, 0, NULL, lpTransmitBuffers, dwReserved)) {
 225                         error = WSAGetLastError ();
 226                 }
 227         }
 228
 229         LOGDEBUG (g_message ("%06d - Finished %s TransmitFile () on socket %d (ret = %d, WSAGetLastError() = %d)", GetCurrentThreadId (), \
 230                 blocking ? "blocking" : "non-blocking", hSocket, error == 0, error));
 231         WSASetLastError (error);
 232
 233         return error == 0;
 234 }
 235 #endif /* #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT) */
 236
 237 #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT)
 238 gint
 239 mono_w32socket_disconnect (SOCKET sock, gboolean reuse)
 240 {
 241         LPFN_DISCONNECTEX disconnect;
 242         LPFN_TRANSMITFILE transmit_file;
 243         DWORD output_bytes;
 244         gint ret;
 245
 246         /* Use the SIO_GET_EXTENSION_FUNCTION_POINTER to determine
 247          * the address of the disconnect method without taking
 248          * a hard dependency on a single provider
 249          *
 250          * For an explanation of why this is done, you can read the
 251          * article at http://www.codeproject.com/internet/jbsocketserver3.asp
 252          *
 253          * I _think_ the extension function pointers need to be looked
 254          * up for each socket.
 255          *
 256          * FIXME: check the best way to store pointers to functions in
 257          * managed objects that still works on 64bit platforms. */
 258
 259         GUID disconnect_guid = WSAID_DISCONNECTEX;
 260         ret = WSAIoctl (sock, SIO_GET_EXTENSION_FUNCTION_POINTER, &disconnect_guid, sizeof (GUID), &disconnect, sizeof (LPFN_DISCONNECTEX), &output_bytes, NULL, NULL);
 261         if (ret == 0) {
 262                 if (!disconnect (sock, NULL, reuse ? TF_REUSE_SOCKET : 0, 0))
 263                         return WSAGetLastError ();
 264
 265                 return 0;
 266         }
 267
 268         GUID transmit_file_guid = WSAID_TRANSMITFILE;
 269         ret = WSAIoctl (sock, SIO_GET_EXTENSION_FUNCTION_POINTER, &transmit_file_guid, sizeof (GUID), &transmit_file, sizeof (LPFN_TRANSMITFILE), &output_bytes, NULL, NULL);
 270         if (ret == 0) {
 271                 if (!transmit_file (sock, NULL, 0, 0, NULL, NULL, TF_DISCONNECT | (reuse ? TF_REUSE_SOCKET : 0)))
 272                         return WSAGetLastError ();
 273
 274                 return 0;
 275         }
 276
 277         return ERROR_NOT_SUPPORTED;
 278 }
 279 #endif /* #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT) */
 280
 281 gint
 282 mono_w32socket_set_blocking (SOCKET sock, gboolean blocking)
 283 {
 284         gulong nonblocking_long = !blocking;
 285         return ioctlsocket (sock, FIONBIO, &nonblocking_long);
 286 }
 287
 288 gint
 289 mono_w32socket_get_available (SOCKET sock, guint64 *amount)
 290 {
 291         return ioctlsocket (sock, FIONREAD, (int*) amount);
 292 }
 293
 294 void
 295 mono_w32socket_set_last_error (gint32 error)
 296 {
 297         WSASetLastError (error);
 298 }
 299
 300 gint32
 301 mono_w32socket_get_last_error (void)
 302 {
 303         return WSAGetLastError ();
 304 }
 305
 306 gint32
 307 mono_w32socket_convert_error (gint error)
 308 {
 309         return (error > 0 && error < WSABASEERR) ? error + WSABASEERR : error;
 310 }
 311
 312 gboolean
 313 ves_icall_System_Net_Sockets_Socket_SupportPortReuse (MonoProtocolType proto, MonoError *error)
 314 {
 315         error_init (error);
 316         return TRUE;
 317 }