Blame src/wsocket.c

Packit b53373
/*=========================================================================*\
Packit b53373
* Socket compatibilization module for Win32
Packit b53373
* LuaSocket toolkit
Packit b53373
*
Packit b53373
* The penalty of calling select to avoid busy-wait is only paid when
Packit b53373
* the I/O call fail in the first place. 
Packit b53373
\*=========================================================================*/
Packit b53373
#include <string.h>
Packit b53373
Packit b53373
#include "socket.h"
Packit b53373
Packit b53373
/* WinSock doesn't have a strerror... */
Packit b53373
static const char *wstrerror(int err);
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Initializes module 
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_open(void) {
Packit b53373
    WSADATA wsaData;
Packit b53373
    WORD wVersionRequested = MAKEWORD(2, 0); 
Packit b53373
    int err = WSAStartup(wVersionRequested, &wsaData );
Packit b53373
    if (err != 0) return 0;
Packit b53373
    if ((LOBYTE(wsaData.wVersion) != 2 || HIBYTE(wsaData.wVersion) != 0) &&
Packit b53373
        (LOBYTE(wsaData.wVersion) != 1 || HIBYTE(wsaData.wVersion) != 1)) {
Packit b53373
        WSACleanup();
Packit b53373
        return 0; 
Packit b53373
    }
Packit b53373
    return 1;
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Close module 
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_close(void) {
Packit b53373
    WSACleanup();
Packit b53373
    return 1;
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Wait for readable/writable/connected socket with timeout
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
#define WAITFD_R        1
Packit b53373
#define WAITFD_W        2
Packit b53373
#define WAITFD_E        4
Packit b53373
#define WAITFD_C        (WAITFD_E|WAITFD_W)
Packit b53373
Packit b53373
int socket_waitfd(p_socket ps, int sw, p_timeout tm) {
Packit b53373
    int ret;
Packit b53373
    fd_set rfds, wfds, efds, *rp = NULL, *wp = NULL, *ep = NULL;
Packit b53373
    struct timeval tv, *tp = NULL;
Packit b53373
    double t;
Packit b53373
    if (timeout_iszero(tm)) return IO_TIMEOUT;  /* optimize timeout == 0 case */
Packit b53373
    if (sw & WAITFD_R) { 
Packit b53373
        FD_ZERO(&rfds); 
Packit b53373
        FD_SET(*ps, &rfds);
Packit b53373
        rp = &rfd;; 
Packit b53373
    }
Packit b53373
    if (sw & WAITFD_W) { FD_ZERO(&wfds); FD_SET(*ps, &wfds); wp = &wfd;; }
Packit b53373
    if (sw & WAITFD_C) { FD_ZERO(&efds); FD_SET(*ps, &efds); ep = &efd;; }
Packit b53373
    if ((t = timeout_get(tm)) >= 0.0) {
Packit b53373
        tv.tv_sec = (int) t;
Packit b53373
        tv.tv_usec = (int) ((t-tv.tv_sec)*1.0e6);
Packit b53373
        tp = &tv;
Packit b53373
    }
Packit b53373
    ret = select(0, rp, wp, ep, tp);
Packit b53373
    if (ret == -1) return WSAGetLastError();
Packit b53373
    if (ret == 0) return IO_TIMEOUT;
Packit b53373
    if (sw == WAITFD_C && FD_ISSET(*ps, &efds)) return IO_CLOSED;
Packit b53373
    return IO_DONE;
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Select with int timeout in ms
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_select(t_socket n, fd_set *rfds, fd_set *wfds, fd_set *efds, 
Packit b53373
        p_timeout tm) {
Packit b53373
    struct timeval tv; 
Packit b53373
    double t = timeout_get(tm);
Packit b53373
    tv.tv_sec = (int) t;
Packit b53373
    tv.tv_usec = (int) ((t - tv.tv_sec) * 1.0e6);
Packit b53373
    if (n <= 0) {
Packit b53373
        Sleep((DWORD) (1000*t));
Packit b53373
        return 0;
Packit b53373
    } else return select(0, rfds, wfds, efds, t >= 0.0? &tv: NULL);
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Close and inutilize socket
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
void socket_destroy(p_socket ps) {
Packit b53373
    if (*ps != SOCKET_INVALID) {
Packit b53373
        socket_setblocking(ps); /* close can take a long time on WIN32 */
Packit b53373
        closesocket(*ps);
Packit b53373
        *ps = SOCKET_INVALID;
Packit b53373
    }
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* 
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
void socket_shutdown(p_socket ps, int how) {
Packit b53373
    socket_setblocking(ps);
Packit b53373
    shutdown(*ps, how);
Packit b53373
    socket_setnonblocking(ps);
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Creates and sets up a socket
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_create(p_socket ps, int domain, int type, int protocol) {
Packit b53373
    *ps = socket(domain, type, protocol);
Packit b53373
    if (*ps != SOCKET_INVALID) return IO_DONE;
Packit b53373
    else return WSAGetLastError();
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Connects or returns error message
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_connect(p_socket ps, SA *addr, socklen_t len, p_timeout tm) {
Packit b53373
    int err;
Packit b53373
    /* don't call on closed socket */
Packit b53373
    if (*ps == SOCKET_INVALID) return IO_CLOSED;
Packit b53373
    /* ask system to connect */
Packit b53373
    if (connect(*ps, addr, len) == 0) return IO_DONE;
Packit b53373
    /* make sure the system is trying to connect */
Packit b53373
    err = WSAGetLastError();
Packit b53373
    if (err != WSAEWOULDBLOCK && err != WSAEINPROGRESS) return err;
Packit b53373
    /* zero timeout case optimization */
Packit b53373
    if (timeout_iszero(tm)) return IO_TIMEOUT;
Packit b53373
    /* we wait until something happens */
Packit b53373
    err = socket_waitfd(ps, WAITFD_C, tm);
Packit b53373
    if (err == IO_CLOSED) {
Packit b53373
        int len = sizeof(err);
Packit b53373
        /* give windows time to set the error (yes, disgusting) */
Packit b53373
        Sleep(10);
Packit b53373
        /* find out why we failed */
Packit b53373
        getsockopt(*ps, SOL_SOCKET, SO_ERROR, (char *)&err, &len;; 
Packit b53373
        /* we KNOW there was an error. if 'why' is 0, we will return
Packit b53373
        * "unknown error", but it's not really our fault */
Packit b53373
        return err > 0? err: IO_UNKNOWN; 
Packit b53373
    } else return err;
Packit b53373
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Binds or returns error message
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_bind(p_socket ps, SA *addr, socklen_t len) {
Packit b53373
    int err = IO_DONE;
Packit b53373
    socket_setblocking(ps);
Packit b53373
    if (bind(*ps, addr, len) < 0) err = WSAGetLastError();
Packit b53373
    socket_setnonblocking(ps);
Packit b53373
    return err;
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* 
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_listen(p_socket ps, int backlog) {
Packit b53373
    int err = IO_DONE;
Packit b53373
    socket_setblocking(ps);
Packit b53373
    if (listen(*ps, backlog) < 0) err = WSAGetLastError();
Packit b53373
    socket_setnonblocking(ps);
Packit b53373
    return err;
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Accept with timeout
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_accept(p_socket ps, p_socket pa, SA *addr, socklen_t *len, 
Packit b53373
        p_timeout tm) {
Packit b53373
    if (*ps == SOCKET_INVALID) return IO_CLOSED;
Packit b53373
    for ( ;; ) {
Packit b53373
        int err;
Packit b53373
        /* try to get client socket */
Packit b53373
        if ((*pa = accept(*ps, addr, len)) != SOCKET_INVALID) return IO_DONE;
Packit b53373
        /* find out why we failed */
Packit b53373
        err = WSAGetLastError(); 
Packit b53373
        /* if we failed because there was no connectoin, keep trying */
Packit b53373
        if (err != WSAEWOULDBLOCK && err != WSAECONNABORTED) return err;
Packit b53373
        /* call select to avoid busy wait */
Packit b53373
        if ((err = socket_waitfd(ps, WAITFD_R, tm)) != IO_DONE) return err;
Packit b53373
    } 
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Send with timeout
Packit b53373
* On windows, if you try to send 10MB, the OS will buffer EVERYTHING 
Packit b53373
* this can take an awful lot of time and we will end up blocked. 
Packit b53373
* Therefore, whoever calls this function should not pass a huge buffer.
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_send(p_socket ps, const char *data, size_t count, 
Packit b53373
        size_t *sent, p_timeout tm)
Packit b53373
{
Packit b53373
    int err;
Packit b53373
    *sent = 0;
Packit b53373
    /* avoid making system calls on closed sockets */
Packit b53373
    if (*ps == SOCKET_INVALID) return IO_CLOSED;
Packit b53373
    /* loop until we send something or we give up on error */
Packit b53373
    for ( ;; ) {
Packit b53373
        /* try to send something */
Packit b53373
        int put = send(*ps, data, (int) count, 0);
Packit b53373
        /* if we sent something, we are done */
Packit b53373
        if (put > 0) {
Packit b53373
            *sent = put;
Packit b53373
            return IO_DONE;
Packit b53373
        }
Packit b53373
        /* deal with failure */
Packit b53373
        err = WSAGetLastError(); 
Packit b53373
        /* we can only proceed if there was no serious error */
Packit b53373
        if (err != WSAEWOULDBLOCK) return err;
Packit b53373
        /* avoid busy wait */
Packit b53373
        if ((err = socket_waitfd(ps, WAITFD_W, tm)) != IO_DONE) return err;
Packit b53373
    } 
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Sendto with timeout
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_sendto(p_socket ps, const char *data, size_t count, size_t *sent, 
Packit b53373
        SA *addr, socklen_t len, p_timeout tm)
Packit b53373
{
Packit b53373
    int err;
Packit b53373
    *sent = 0;
Packit b53373
    if (*ps == SOCKET_INVALID) return IO_CLOSED;
Packit b53373
    for ( ;; ) {
Packit b53373
        int put = sendto(*ps, data, (int) count, 0, addr, len);
Packit b53373
        if (put > 0) {
Packit b53373
            *sent = put;
Packit b53373
            return IO_DONE;
Packit b53373
        }
Packit b53373
        err = WSAGetLastError(); 
Packit b53373
        if (err != WSAEWOULDBLOCK) return err;
Packit b53373
        if ((err = socket_waitfd(ps, WAITFD_W, tm)) != IO_DONE) return err;
Packit b53373
    } 
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Receive with timeout
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_recv(p_socket ps, char *data, size_t count, size_t *got, 
Packit b53373
        p_timeout tm) 
Packit b53373
{
Packit b53373
    int err, prev = IO_DONE;
Packit b53373
    *got = 0;
Packit b53373
    if (*ps == SOCKET_INVALID) return IO_CLOSED;
Packit b53373
    for ( ;; ) {
Packit b53373
        int taken = recv(*ps, data, (int) count, 0);
Packit b53373
        if (taken > 0) {
Packit b53373
            *got = taken;
Packit b53373
            return IO_DONE;
Packit b53373
        }
Packit b53373
        if (taken == 0) return IO_CLOSED;
Packit b53373
        err = WSAGetLastError();
Packit b53373
        /* On UDP, a connreset simply means the previous send failed. 
Packit b53373
         * So we try again. 
Packit b53373
         * On TCP, it means our socket is now useless, so the error passes. 
Packit b53373
         * (We will loop again, exiting because the same error will happen) */
Packit b53373
        if (err != WSAEWOULDBLOCK) {
Packit b53373
            if (err != WSAECONNRESET || prev == WSAECONNRESET) return err;
Packit b53373
            prev = err;
Packit b53373
        }
Packit b53373
        if ((err = socket_waitfd(ps, WAITFD_R, tm)) != IO_DONE) return err;
Packit b53373
    }
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Recvfrom with timeout
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_recvfrom(p_socket ps, char *data, size_t count, size_t *got, 
Packit b53373
        SA *addr, socklen_t *len, p_timeout tm) 
Packit b53373
{
Packit b53373
    int err, prev = IO_DONE;
Packit b53373
    *got = 0;
Packit b53373
    if (*ps == SOCKET_INVALID) return IO_CLOSED;
Packit b53373
    for ( ;; ) {
Packit b53373
        int taken = recvfrom(*ps, data, (int) count, 0, addr, len);
Packit b53373
        if (taken > 0) {
Packit b53373
            *got = taken;
Packit b53373
            return IO_DONE;
Packit b53373
        }
Packit b53373
        if (taken == 0) return IO_CLOSED;
Packit b53373
        err = WSAGetLastError();
Packit b53373
        /* On UDP, a connreset simply means the previous send failed. 
Packit b53373
         * So we try again. 
Packit b53373
         * On TCP, it means our socket is now useless, so the error passes.
Packit b53373
         * (We will loop again, exiting because the same error will happen) */
Packit b53373
        if (err != WSAEWOULDBLOCK) {
Packit b53373
            if (err != WSAECONNRESET || prev == WSAECONNRESET) return err;
Packit b53373
            prev = err;
Packit b53373
        }
Packit b53373
        if ((err = socket_waitfd(ps, WAITFD_R, tm)) != IO_DONE) return err;
Packit b53373
    }
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Put socket into blocking mode
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
void socket_setblocking(p_socket ps) {
Packit b53373
    u_long argp = 0;
Packit b53373
    ioctlsocket(*ps, FIONBIO, &argp);
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Put socket into non-blocking mode
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
void socket_setnonblocking(p_socket ps) {
Packit b53373
    u_long argp = 1;
Packit b53373
    ioctlsocket(*ps, FIONBIO, &argp);
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* DNS helpers 
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
int socket_gethostbyaddr(const char *addr, socklen_t len, struct hostent **hp) {
Packit b53373
    *hp = gethostbyaddr(addr, len, AF_INET);
Packit b53373
    if (*hp) return IO_DONE;
Packit b53373
    else return WSAGetLastError();
Packit b53373
}
Packit b53373
Packit b53373
int socket_gethostbyname(const char *addr, struct hostent **hp) {
Packit b53373
    *hp = gethostbyname(addr);
Packit b53373
    if (*hp) return IO_DONE;
Packit b53373
    else return  WSAGetLastError();
Packit b53373
}
Packit b53373
Packit b53373
/*-------------------------------------------------------------------------*\
Packit b53373
* Error translation functions
Packit b53373
\*-------------------------------------------------------------------------*/
Packit b53373
const char *socket_hoststrerror(int err) {
Packit b53373
    if (err <= 0) return io_strerror(err);
Packit b53373
    switch (err) {
Packit b53373
        case WSAHOST_NOT_FOUND: return "host not found";
Packit b53373
        default: return wstrerror(err); 
Packit b53373
    }
Packit b53373
}
Packit b53373
Packit b53373
const char *socket_strerror(int err) {
Packit b53373
    if (err <= 0) return io_strerror(err);
Packit b53373
    switch (err) {
Packit b53373
        case WSAEADDRINUSE: return "address already in use";
Packit b53373
        case WSAECONNREFUSED: return "connection refused";
Packit b53373
        case WSAEISCONN: return "already connected";
Packit b53373
        case WSAEACCES: return "permission denied";
Packit b53373
        case WSAECONNABORTED: return "closed";
Packit b53373
        case WSAECONNRESET: return "closed";
Packit b53373
        case WSAETIMEDOUT: return "timeout";
Packit b53373
        default: return wstrerror(err);
Packit b53373
    }
Packit b53373
}
Packit b53373
Packit b53373
const char *socket_ioerror(p_socket ps, int err) {
Packit b53373
    (void) ps;
Packit b53373
    return socket_strerror(err);
Packit b53373
}
Packit b53373
Packit b53373
static const char *wstrerror(int err) {
Packit b53373
    switch (err) {
Packit b53373
        case WSAEINTR: return "Interrupted function call";
Packit b53373
        case WSAEACCES: return "Permission denied";
Packit b53373
        case WSAEFAULT: return "Bad address";
Packit b53373
        case WSAEINVAL: return "Invalid argument";
Packit b53373
        case WSAEMFILE: return "Too many open files";
Packit b53373
        case WSAEWOULDBLOCK: return "Resource temporarily unavailable";
Packit b53373
        case WSAEINPROGRESS: return "Operation now in progress";
Packit b53373
        case WSAEALREADY: return "Operation already in progress";
Packit b53373
        case WSAENOTSOCK: return "Socket operation on nonsocket";
Packit b53373
        case WSAEDESTADDRREQ: return "Destination address required";
Packit b53373
        case WSAEMSGSIZE: return "Message too long";
Packit b53373
        case WSAEPROTOTYPE: return "Protocol wrong type for socket";
Packit b53373
        case WSAENOPROTOOPT: return "Bad protocol option";
Packit b53373
        case WSAEPROTONOSUPPORT: return "Protocol not supported";
Packit b53373
        case WSAESOCKTNOSUPPORT: return "Socket type not supported";
Packit b53373
        case WSAEOPNOTSUPP: return "Operation not supported";
Packit b53373
        case WSAEPFNOSUPPORT: return "Protocol family not supported";
Packit b53373
        case WSAEAFNOSUPPORT: 
Packit b53373
            return "Address family not supported by protocol family"; 
Packit b53373
        case WSAEADDRINUSE: return "Address already in use";
Packit b53373
        case WSAEADDRNOTAVAIL: return "Cannot assign requested address";
Packit b53373
        case WSAENETDOWN: return "Network is down";
Packit b53373
        case WSAENETUNREACH: return "Network is unreachable";
Packit b53373
        case WSAENETRESET: return "Network dropped connection on reset";
Packit b53373
        case WSAECONNABORTED: return "Software caused connection abort";
Packit b53373
        case WSAECONNRESET: return "Connection reset by peer";
Packit b53373
        case WSAENOBUFS: return "No buffer space available";
Packit b53373
        case WSAEISCONN: return "Socket is already connected";
Packit b53373
        case WSAENOTCONN: return "Socket is not connected";
Packit b53373
        case WSAESHUTDOWN: return "Cannot send after socket shutdown";
Packit b53373
        case WSAETIMEDOUT: return "Connection timed out";
Packit b53373
        case WSAECONNREFUSED: return "Connection refused";
Packit b53373
        case WSAEHOSTDOWN: return "Host is down";
Packit b53373
        case WSAEHOSTUNREACH: return "No route to host";
Packit b53373
        case WSAEPROCLIM: return "Too many processes";
Packit b53373
        case WSASYSNOTREADY: return "Network subsystem is unavailable";
Packit b53373
        case WSAVERNOTSUPPORTED: return "Winsock.dll version out of range";
Packit b53373
        case WSANOTINITIALISED: 
Packit b53373
            return "Successful WSAStartup not yet performed";
Packit b53373
        case WSAEDISCON: return "Graceful shutdown in progress";
Packit b53373
        case WSAHOST_NOT_FOUND: return "Host not found";
Packit b53373
        case WSATRY_AGAIN: return "Nonauthoritative host not found";
Packit b53373
        case WSANO_RECOVERY: return "Nonrecoverable name lookup error"; 
Packit b53373
        case WSANO_DATA: return "Valid name, no data record of requested type";
Packit b53373
        default: return "Unknown error";
Packit b53373
    }
Packit b53373
}
Packit b53373
Packit b53373
const char *socket_gaistrerror(int err) {
Packit b53373
    if (err == 0) return NULL; 
Packit b53373
    switch (err) {
Packit b53373
        case EAI_AGAIN: return "temporary failure in name resolution";
Packit b53373
        case EAI_BADFLAGS: return "invalid value for ai_flags";
Packit b53373
#ifdef EAI_BADHINTS
Packit b53373
        case EAI_BADHINTS: return "invalid value for hints";
Packit b53373
#endif
Packit b53373
        case EAI_FAIL: return "non-recoverable failure in name resolution";
Packit b53373
        case EAI_FAMILY: return "ai_family not supported";
Packit b53373
        case EAI_MEMORY: return "memory allocation failure";
Packit b53373
        case EAI_NONAME: 
Packit b53373
            return "host or service not provided, or not known";
Packit b53373
#ifdef EAI_OVERFLOW
Packit b53373
        case EAI_OVERFLOW: return "argument buffer overflow";
Packit b53373
#endif
Packit b53373
#ifdef EAI_PROTOCOL
Packit b53373
        case EAI_PROTOCOL: return "resolved protocol is unknown";
Packit b53373
#endif
Packit b53373
        case EAI_SERVICE: return "service not supported for socket type";
Packit b53373
        case EAI_SOCKTYPE: return "ai_socktype not supported";
Packit b53373
#ifdef EAI_SYSTEM
Packit b53373
        case EAI_SYSTEM: return strerror(errno); 
Packit b53373
#endif
Packit b53373
        default: return gai_strerror(err);
Packit b53373
    }
Packit b53373
}
Packit b53373