Skip to content

Commit de7b196

Browse files
committed
mingw: make sure errno is set correctly when socket operations fail
The winsock2 library provides functions that work on different data types than file descriptors, therefore we wrap them. But that is not the only difference: they also do not set `errno` but expect the callers to enquire about errors via `WSAGetLastError()`. Let's translate that into appropriate `errno` values whenever the socket operations fail so that Git's code base does not have to change its expectations. This closes #2404 Helped-by: Jeff Hostetler <[email protected]> Signed-off-by: Johannes Schindelin <[email protected]>
1 parent f305fce commit de7b196

File tree

1 file changed

+147
-10
lines changed

1 file changed

+147
-10
lines changed

compat/mingw.c

Lines changed: 147 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2029,26 +2029,158 @@ static void ensure_socket_initialization(void)
20292029
initialized = 1;
20302030
}
20312031

2032+
static int winsock_error_to_errno(DWORD err)
2033+
{
2034+
switch (err) {
2035+
case WSAEINTR: return EINTR;
2036+
case WSAEBADF: return EBADF;
2037+
case WSAEACCES: return EACCES;
2038+
case WSAEFAULT: return EFAULT;
2039+
case WSAEINVAL: return EINVAL;
2040+
case WSAEMFILE: return EMFILE;
2041+
case WSAEWOULDBLOCK: return EWOULDBLOCK;
2042+
case WSAEINPROGRESS: return EINPROGRESS;
2043+
case WSAEALREADY: return EALREADY;
2044+
case WSAENOTSOCK: return ENOTSOCK;
2045+
case WSAEDESTADDRREQ: return EDESTADDRREQ;
2046+
case WSAEMSGSIZE: return EMSGSIZE;
2047+
case WSAEPROTOTYPE: return EPROTOTYPE;
2048+
case WSAENOPROTOOPT: return ENOPROTOOPT;
2049+
case WSAEPROTONOSUPPORT: return EPROTONOSUPPORT;
2050+
case WSAEOPNOTSUPP: return EOPNOTSUPP;
2051+
case WSAEAFNOSUPPORT: return EAFNOSUPPORT;
2052+
case WSAEADDRINUSE: return EADDRINUSE;
2053+
case WSAEADDRNOTAVAIL: return EADDRNOTAVAIL;
2054+
case WSAENETDOWN: return ENETDOWN;
2055+
case WSAENETUNREACH: return ENETUNREACH;
2056+
case WSAENETRESET: return ENETRESET;
2057+
case WSAECONNABORTED: return ECONNABORTED;
2058+
case WSAECONNRESET: return ECONNRESET;
2059+
case WSAENOBUFS: return ENOBUFS;
2060+
case WSAEISCONN: return EISCONN;
2061+
case WSAENOTCONN: return ENOTCONN;
2062+
case WSAETIMEDOUT: return ETIMEDOUT;
2063+
case WSAECONNREFUSED: return ECONNREFUSED;
2064+
case WSAELOOP: return ELOOP;
2065+
case WSAENAMETOOLONG: return ENAMETOOLONG;
2066+
case WSAEHOSTUNREACH: return EHOSTUNREACH;
2067+
case WSAENOTEMPTY: return ENOTEMPTY;
2068+
/* No errno equivalent; default to EIO */
2069+
case WSAESOCKTNOSUPPORT:
2070+
case WSAEPFNOSUPPORT:
2071+
case WSAESHUTDOWN:
2072+
case WSAETOOMANYREFS:
2073+
case WSAEHOSTDOWN:
2074+
case WSAEPROCLIM:
2075+
case WSAEUSERS:
2076+
case WSAEDQUOT:
2077+
case WSAESTALE:
2078+
case WSAEREMOTE:
2079+
case WSASYSNOTREADY:
2080+
case WSAVERNOTSUPPORTED:
2081+
case WSANOTINITIALISED:
2082+
case WSAEDISCON:
2083+
case WSAENOMORE:
2084+
case WSAECANCELLED:
2085+
case WSAEINVALIDPROCTABLE:
2086+
case WSAEINVALIDPROVIDER:
2087+
case WSAEPROVIDERFAILEDINIT:
2088+
case WSASYSCALLFAILURE:
2089+
case WSASERVICE_NOT_FOUND:
2090+
case WSATYPE_NOT_FOUND:
2091+
case WSA_E_NO_MORE:
2092+
case WSA_E_CANCELLED:
2093+
case WSAEREFUSED:
2094+
case WSAHOST_NOT_FOUND:
2095+
case WSATRY_AGAIN:
2096+
case WSANO_RECOVERY:
2097+
case WSANO_DATA:
2098+
case WSA_QOS_RECEIVERS:
2099+
case WSA_QOS_SENDERS:
2100+
case WSA_QOS_NO_SENDERS:
2101+
case WSA_QOS_NO_RECEIVERS:
2102+
case WSA_QOS_REQUEST_CONFIRMED:
2103+
case WSA_QOS_ADMISSION_FAILURE:
2104+
case WSA_QOS_POLICY_FAILURE:
2105+
case WSA_QOS_BAD_STYLE:
2106+
case WSA_QOS_BAD_OBJECT:
2107+
case WSA_QOS_TRAFFIC_CTRL_ERROR:
2108+
case WSA_QOS_GENERIC_ERROR:
2109+
case WSA_QOS_ESERVICETYPE:
2110+
case WSA_QOS_EFLOWSPEC:
2111+
case WSA_QOS_EPROVSPECBUF:
2112+
case WSA_QOS_EFILTERSTYLE:
2113+
case WSA_QOS_EFILTERTYPE:
2114+
case WSA_QOS_EFILTERCOUNT:
2115+
case WSA_QOS_EOBJLENGTH:
2116+
case WSA_QOS_EFLOWCOUNT:
2117+
#ifndef _MSC_VER
2118+
case WSA_QOS_EUNKNOWNPSOBJ:
2119+
#endif
2120+
case WSA_QOS_EPOLICYOBJ:
2121+
case WSA_QOS_EFLOWDESC:
2122+
case WSA_QOS_EPSFLOWSPEC:
2123+
case WSA_QOS_EPSFILTERSPEC:
2124+
case WSA_QOS_ESDMODEOBJ:
2125+
case WSA_QOS_ESHAPERATEOBJ:
2126+
case WSA_QOS_RESERVED_PETYPE:
2127+
default: return EIO;
2128+
}
2129+
}
2130+
2131+
/*
2132+
* On Windows, `errno` is a global macro to a function call.
2133+
* This makes it difficult to debug and single-step our mappings.
2134+
*/
2135+
static inline void set_wsa_errno(void)
2136+
{
2137+
DWORD wsa = WSAGetLastError();
2138+
int e = winsock_error_to_errno(wsa);
2139+
errno = e;
2140+
2141+
#ifdef DEBUG_WSA_ERRNO
2142+
fprintf(stderr, "winsock error: %d -> %d\n", wsa, e);
2143+
fflush(stderr);
2144+
#endif
2145+
}
2146+
2147+
static inline int winsock_return(int ret)
2148+
{
2149+
if (ret < 0)
2150+
set_wsa_errno();
2151+
2152+
return ret;
2153+
}
2154+
2155+
#define WINSOCK_RETURN(x) do { return winsock_return(x); } while (0)
2156+
20322157
#undef gethostname
20332158
int mingw_gethostname(char *name, int namelen)
20342159
{
2035-
ensure_socket_initialization();
2036-
return gethostname(name, namelen);
2160+
ensure_socket_initialization();
2161+
WINSOCK_RETURN(gethostname(name, namelen));
20372162
}
20382163

20392164
#undef gethostbyname
20402165
struct hostent *mingw_gethostbyname(const char *host)
20412166
{
2167+
struct hostent *ret;
2168+
20422169
ensure_socket_initialization();
2043-
return gethostbyname(host);
2170+
2171+
ret = gethostbyname(host);
2172+
if (!ret)
2173+
set_wsa_errno();
2174+
2175+
return ret;
20442176
}
20452177

20462178
#undef getaddrinfo
20472179
int mingw_getaddrinfo(const char *node, const char *service,
20482180
const struct addrinfo *hints, struct addrinfo **res)
20492181
{
20502182
ensure_socket_initialization();
2051-
return getaddrinfo(node, service, hints, res);
2183+
WINSOCK_RETURN(getaddrinfo(node, service, hints, res));
20522184
}
20532185

20542186
int mingw_socket(int domain, int type, int protocol)
@@ -2068,7 +2200,7 @@ int mingw_socket(int domain, int type, int protocol)
20682200
* in errno so that _if_ someone looks up the code somewhere,
20692201
* then it is at least the number that are usually listed.
20702202
*/
2071-
errno = WSAGetLastError();
2203+
set_wsa_errno();
20722204
return -1;
20732205
}
20742206
/* convert into a file descriptor */
@@ -2084,35 +2216,35 @@ int mingw_socket(int domain, int type, int protocol)
20842216
int mingw_connect(int sockfd, struct sockaddr *sa, size_t sz)
20852217
{
20862218
SOCKET s = (SOCKET)_get_osfhandle(sockfd);
2087-
return connect(s, sa, sz);
2219+
WINSOCK_RETURN(connect(s, sa, sz));
20882220
}
20892221

20902222
#undef bind
20912223
int mingw_bind(int sockfd, struct sockaddr *sa, size_t sz)
20922224
{
20932225
SOCKET s = (SOCKET)_get_osfhandle(sockfd);
2094-
return bind(s, sa, sz);
2226+
WINSOCK_RETURN(bind(s, sa, sz));
20952227
}
20962228

20972229
#undef setsockopt
20982230
int mingw_setsockopt(int sockfd, int lvl, int optname, void *optval, int optlen)
20992231
{
21002232
SOCKET s = (SOCKET)_get_osfhandle(sockfd);
2101-
return setsockopt(s, lvl, optname, (const char*)optval, optlen);
2233+
WINSOCK_RETURN(setsockopt(s, lvl, optname, (const char*)optval, optlen));
21022234
}
21032235

21042236
#undef shutdown
21052237
int mingw_shutdown(int sockfd, int how)
21062238
{
21072239
SOCKET s = (SOCKET)_get_osfhandle(sockfd);
2108-
return shutdown(s, how);
2240+
WINSOCK_RETURN(shutdown(s, how));
21092241
}
21102242

21112243
#undef listen
21122244
int mingw_listen(int sockfd, int backlog)
21132245
{
21142246
SOCKET s = (SOCKET)_get_osfhandle(sockfd);
2115-
return listen(s, backlog);
2247+
WINSOCK_RETURN(listen(s, backlog));
21162248
}
21172249

21182250
#undef accept
@@ -2123,6 +2255,11 @@ int mingw_accept(int sockfd1, struct sockaddr *sa, socklen_t *sz)
21232255
SOCKET s1 = (SOCKET)_get_osfhandle(sockfd1);
21242256
SOCKET s2 = accept(s1, sa, sz);
21252257

2258+
if (s2 == INVALID_SOCKET) {
2259+
set_wsa_errno();
2260+
return -1;
2261+
}
2262+
21262263
/* convert into a file descriptor */
21272264
if ((sockfd2 = _open_osfhandle(s2, O_RDWR|O_BINARY)) < 0) {
21282265
int err = errno;

0 commit comments

Comments
 (0)