2 * w32socket-win32.c: Windows specific socket code.
4 * Copyright 2016 Microsoft
5 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
19 #include <sys/types.h>
21 #include "w32socket.h"
22 #include "w32socket-internals.h"
24 #include "utils/w32api.h"
29 mono_w32socket_initialize (void)
34 mono_w32socket_cleanup (void)
38 static gboolean set_blocking (SOCKET sock, gboolean block)
40 u_long non_block = block ? 0 : 1;
41 return ioctlsocket (sock, FIONBIO, &non_block) != SOCKET_ERROR;
44 static DWORD get_socket_timeout (SOCKET sock, int optname)
47 int optlen = sizeof (DWORD);
48 if (getsockopt (sock, SOL_SOCKET, optname, (char *)&timeout, &optlen) == SOCKET_ERROR) {
53 timeout = WSA_INFINITE; // 0 means infinite
58 * Performs an alertable wait for the specified event (FD_ACCEPT_BIT,
59 * FD_CONNECT_BIT, FD_READ_BIT, FD_WRITE_BIT) on the specified socket.
60 * Returns TRUE if the event is fired without errors. Calls WSASetLastError()
61 * with WSAEINTR and returns FALSE if the thread is alerted. If the event is
62 * fired but with an error WSASetLastError() is called to set the error and the
63 * function returns FALSE.
65 static gboolean alertable_socket_wait (SOCKET sock, int event_bit)
67 static char *EVENT_NAMES[] = { "FD_READ", "FD_WRITE", NULL /*FD_OOB*/, "FD_ACCEPT", "FD_CONNECT", "FD_CLOSE" };
68 gboolean success = FALSE;
70 DWORD timeout = WSA_INFINITE;
71 if (event_bit == FD_READ_BIT || event_bit == FD_WRITE_BIT) {
72 timeout = get_socket_timeout (sock, event_bit == FD_READ_BIT ? SO_RCVTIMEO : SO_SNDTIMEO);
75 WSAEVENT event = WSACreateEvent ();
76 if (event != WSA_INVALID_EVENT) {
77 if (WSAEventSelect (sock, event, (1 << event_bit) | FD_CLOSE) != SOCKET_ERROR) {
78 LOGDEBUG (g_message ("%06d - Calling WSAWaitForMultipleEvents () on socket %d", GetCurrentThreadId (), sock));
79 DWORD ret = WSAWaitForMultipleEvents (1, &event, TRUE, timeout, TRUE);
80 if (ret == WSA_WAIT_IO_COMPLETION) {
81 LOGDEBUG (g_message ("%06d - WSAWaitForMultipleEvents () returned WSA_WAIT_IO_COMPLETION for socket %d", GetCurrentThreadId (), sock));
83 } else if (ret == WSA_WAIT_TIMEOUT) {
86 g_assert (ret == WSA_WAIT_EVENT_0);
87 WSANETWORKEVENTS ne = { 0 };
88 if (WSAEnumNetworkEvents (sock, event, &ne) != SOCKET_ERROR) {
89 if (ne.lNetworkEvents & (1 << event_bit) && ne.iErrorCode[event_bit]) {
90 LOGDEBUG (g_message ("%06d - %s error %d on socket %d", GetCurrentThreadId (), EVENT_NAMES[event_bit], ne.iErrorCode[event_bit], sock));
91 error = ne.iErrorCode[event_bit];
92 } else if (ne.lNetworkEvents & FD_CLOSE_BIT && ne.iErrorCode[FD_CLOSE_BIT]) {
93 LOGDEBUG (g_message ("%06d - FD_CLOSE error %d on socket %d", GetCurrentThreadId (), ne.iErrorCode[FD_CLOSE_BIT], sock));
94 error = ne.iErrorCode[FD_CLOSE_BIT];
96 LOGDEBUG (g_message ("%06d - WSAEnumNetworkEvents () finished successfully on socket %d", GetCurrentThreadId (), sock));
102 WSAEventSelect (sock, NULL, 0);
104 WSACloseEvent (event);
107 WSASetLastError (error);
112 #define ALERTABLE_SOCKET_CALL(event_bit, blocking, repeat, ret, op, sock, ...) \
113 LOGDEBUG (g_message ("%06d - Performing %s " #op " () on socket %d", GetCurrentThreadId (), blocking ? "blocking" : "non-blocking", sock)); \
115 if (set_blocking(sock, FALSE)) { \
116 while (-1 == (int) (ret = op (sock, __VA_ARGS__))) { \
117 int _error = WSAGetLastError ();\
118 if (_error != WSAEWOULDBLOCK && _error != WSA_IO_PENDING) \
120 if (!alertable_socket_wait (sock, event_bit) || !repeat) \
123 int _saved_error = WSAGetLastError (); \
124 set_blocking (sock, TRUE); \
125 WSASetLastError (_saved_error); \
128 ret = op (sock, __VA_ARGS__); \
130 int _saved_error = WSAGetLastError (); \
131 LOGDEBUG (g_message ("%06d - Finished %s " #op " () on socket %d (ret = %d, WSAGetLastError() = %d)", GetCurrentThreadId (), \
132 blocking ? "blocking" : "non-blocking", sock, ret, _saved_error)); \
133 WSASetLastError (_saved_error);
135 SOCKET mono_w32socket_accept (SOCKET s, struct sockaddr *addr, socklen_t *addrlen, gboolean blocking)
137 MonoInternalThread *curthread = mono_thread_internal_current ();
138 SOCKET newsock = INVALID_SOCKET;
139 ALERTABLE_SOCKET_CALL (FD_ACCEPT_BIT, blocking, TRUE, newsock, accept, s, addr, addrlen);
143 int mono_w32socket_connect (SOCKET s, const struct sockaddr *name, int namelen, gboolean blocking)
145 int ret = SOCKET_ERROR;
146 ALERTABLE_SOCKET_CALL (FD_CONNECT_BIT, blocking, FALSE, ret, connect, s, name, namelen);
147 ret = WSAGetLastError () != 0 ? SOCKET_ERROR : 0;
151 int mono_w32socket_recv (SOCKET s, char *buf, int len, int flags, gboolean blocking)
153 MonoInternalThread *curthread = mono_thread_internal_current ();
154 int ret = SOCKET_ERROR;
155 ALERTABLE_SOCKET_CALL (FD_READ_BIT, blocking, TRUE, ret, recv, s, buf, len, flags);
159 int mono_w32socket_recvfrom (SOCKET s, char *buf, int len, int flags, struct sockaddr *from, socklen_t *fromlen, gboolean blocking)
161 int ret = SOCKET_ERROR;
162 ALERTABLE_SOCKET_CALL (FD_READ_BIT, blocking, TRUE, ret, recvfrom, s, buf, len, flags, from, fromlen);
166 int mono_w32socket_recvbuffers (SOCKET s, WSABUF *lpBuffers, guint32 dwBufferCount, guint32 *lpNumberOfBytesRecvd, guint32 *lpFlags, gpointer lpOverlapped, gpointer lpCompletionRoutine, gboolean blocking)
168 int ret = SOCKET_ERROR;
169 ALERTABLE_SOCKET_CALL (FD_READ_BIT, blocking, TRUE, ret, WSARecv, s, lpBuffers, dwBufferCount, lpNumberOfBytesRecvd, lpFlags, lpOverlapped, lpCompletionRoutine);
173 int mono_w32socket_send (SOCKET s, char *buf, int len, int flags, gboolean blocking)
175 int ret = SOCKET_ERROR;
176 ALERTABLE_SOCKET_CALL (FD_WRITE_BIT, blocking, FALSE, ret, send, s, buf, len, flags);
180 int mono_w32socket_sendto (SOCKET s, const char *buf, int len, int flags, const struct sockaddr *to, int tolen, gboolean blocking)
182 int ret = SOCKET_ERROR;
183 ALERTABLE_SOCKET_CALL (FD_WRITE_BIT, blocking, FALSE, ret, sendto, s, buf, len, flags, to, tolen);
187 int mono_w32socket_sendbuffers (SOCKET s, WSABUF *lpBuffers, guint32 dwBufferCount, guint32 *lpNumberOfBytesRecvd, guint32 lpFlags, gpointer lpOverlapped, gpointer lpCompletionRoutine, gboolean blocking)
189 int ret = SOCKET_ERROR;
190 ALERTABLE_SOCKET_CALL (FD_WRITE_BIT, blocking, FALSE, ret, WSASend, s, lpBuffers, dwBufferCount, lpNumberOfBytesRecvd, lpFlags, lpOverlapped, lpCompletionRoutine);
194 #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT)
195 BOOL mono_w32socket_transmit_file (SOCKET hSocket, gpointer hFile, TRANSMIT_FILE_BUFFERS *lpTransmitBuffers, guint32 dwReserved, gboolean blocking)
197 LOGDEBUG (g_message ("%06d - Performing %s TransmitFile () on socket %d", GetCurrentThreadId (), blocking ? "blocking" : "non-blocking", hSocket));
201 OVERLAPPED overlapped = { 0 };
202 overlapped.hEvent = WSACreateEvent ();
203 if (overlapped.hEvent == WSA_INVALID_EVENT)
205 if (!TransmitFile (hSocket, hFile, 0, 0, &overlapped, lpTransmitBuffers, dwReserved)) {
206 error = WSAGetLastError ();
207 if (error == WSA_IO_PENDING) {
209 // NOTE: .NET's Socket.SendFile() doesn't honor the Socket's SendTimeout so we shouldn't either
210 DWORD ret = WaitForSingleObjectEx (overlapped.hEvent, INFINITE, TRUE);
211 if (ret == WAIT_IO_COMPLETION) {
212 LOGDEBUG (g_message ("%06d - WaitForSingleObjectEx () returned WSA_WAIT_IO_COMPLETION for socket %d", GetCurrentThreadId (), hSocket));
214 } else if (ret == WAIT_TIMEOUT) {
215 error = WSAETIMEDOUT;
216 } else if (ret != WAIT_OBJECT_0) {
217 error = GetLastError ();
221 WSACloseEvent (overlapped.hEvent);
223 if (!TransmitFile (hSocket, hFile, 0, 0, NULL, lpTransmitBuffers, dwReserved)) {
224 error = WSAGetLastError ();
228 LOGDEBUG (g_message ("%06d - Finished %s TransmitFile () on socket %d (ret = %d, WSAGetLastError() = %d)", GetCurrentThreadId (), \
229 blocking ? "blocking" : "non-blocking", hSocket, error == 0, error));
230 WSASetLastError (error);
234 #endif /* #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT) */
236 #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT)
238 mono_w32socket_disconnect (SOCKET sock, gboolean reuse)
240 LPFN_DISCONNECTEX disconnect;
241 LPFN_TRANSMITFILE transmit_file;
245 /* Use the SIO_GET_EXTENSION_FUNCTION_POINTER to determine
246 * the address of the disconnect method without taking
247 * a hard dependency on a single provider
249 * For an explanation of why this is done, you can read the
250 * article at http://www.codeproject.com/internet/jbsocketserver3.asp
252 * I _think_ the extension function pointers need to be looked
253 * up for each socket.
255 * FIXME: check the best way to store pointers to functions in
256 * managed objects that still works on 64bit platforms. */
258 GUID disconnect_guid = WSAID_DISCONNECTEX;
259 ret = WSAIoctl (sock, SIO_GET_EXTENSION_FUNCTION_POINTER, &disconnect_guid, sizeof (GUID), &disconnect, sizeof (LPFN_DISCONNECTEX), &output_bytes, NULL, NULL);
261 if (!disconnect (sock, NULL, reuse ? TF_REUSE_SOCKET : 0, 0))
262 return WSAGetLastError ();
267 GUID transmit_file_guid = WSAID_TRANSMITFILE;
268 ret = WSAIoctl (sock, SIO_GET_EXTENSION_FUNCTION_POINTER, &transmit_file_guid, sizeof (GUID), &transmit_file, sizeof (LPFN_TRANSMITFILE), &output_bytes, NULL, NULL);
270 if (!transmit_file (sock, NULL, 0, 0, NULL, NULL, TF_DISCONNECT | (reuse ? TF_REUSE_SOCKET : 0)))
271 return WSAGetLastError ();
276 return ERROR_NOT_SUPPORTED;
278 #endif /* #if G_HAVE_API_SUPPORT(HAVE_CLASSIC_WINAPI_SUPPORT | HAVE_UWP_WINAPI_SUPPORT) */
281 mono_w32socket_set_blocking (SOCKET sock, gboolean blocking)
283 gulong nonblocking_long = !blocking;
284 return ioctlsocket (sock, FIONBIO, &nonblocking_long);
288 mono_w32socket_get_available (SOCKET sock, guint64 *amount)
290 return ioctlsocket (sock, FIONREAD, (int*) amount);
294 mono_w32socket_set_last_error (gint32 error)
296 WSASetLastError (error);
300 mono_w32socket_get_last_error (void)
302 return WSAGetLastError ();
306 mono_w32socket_convert_error (gint error)
308 return (error > 0 && error < WSABASEERR) ? error + WSABASEERR : error;
312 ves_icall_System_Net_Sockets_Socket_SupportPortReuse (MonoProtocolType proto)