1 /*-------------------------------------------------------------------------
2 * drawElements Utility Library
3 * ----------------------------
5 * Copyright 2014 The Android Open Source Project
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 * \brief Socket abstraction.
22 *//*--------------------------------------------------------------------*/
29 #if (DE_OS == DE_OS_WIN32)
30 # define DE_USE_WINSOCK
31 #elif (DE_OS == DE_OS_UNIX) || (DE_OS == DE_OS_OSX) || (DE_OS == DE_OS_IOS) || (DE_OS == DE_OS_ANDROID) || (DE_OS == DE_OS_SYMBIAN)
32 # define DE_USE_BERKELEY_SOCKETS
34 # error Implement deSocket for your OS.
37 /* Common utilities. */
39 const char* deGetSocketResultName (deSocketResult result)
43 case DE_SOCKETRESULT_SUCCESS: return "DE_SOCKETRESULT_SUCCESS";
44 case DE_SOCKETRESULT_WOULD_BLOCK: return "DE_SOCKETRESULT_WOULD_BLOCK";
45 case DE_SOCKETRESULT_CONNECTION_CLOSED: return "DE_SOCKETRESULT_CONNECTION_CLOSED";
46 case DE_SOCKETRESULT_CONNECTION_TERMINATED: return "DE_SOCKETRESULT_CONNECTION_TERMINATED";
47 case DE_SOCKETRESULT_ERROR: return "DE_SOCKETRESULT_ERROR";
48 default: return DE_NULL;
52 const char* deGetSocketFamilyName (deSocketFamily family)
56 case DE_SOCKETFAMILY_INET4: return "DE_SOCKETFAMILY_INET4";
57 case DE_SOCKETFAMILY_INET6: return "DE_SOCKETFAMILY_INET6";
58 default: return DE_NULL;
62 #if defined(DE_USE_WINSOCK) || defined(DE_USE_BERKELEY_SOCKETS)
64 /* Common deSocketAddress implementation. */
66 struct deSocketAddress_s
70 deSocketFamily family;
72 deSocketProtocol protocol;
75 deSocketAddress* deSocketAddress_create (void)
77 deSocketAddress* addr = (deSocketAddress*)deCalloc(sizeof(deSocketAddress));
82 addr->family = DE_SOCKETFAMILY_INET4;
83 addr->type = DE_SOCKETTYPE_STREAM;
84 addr->protocol = DE_SOCKETPROTOCOL_TCP;
89 deBool deSocketAddress_setFamily (deSocketAddress* address, deSocketFamily family)
91 address->family = family;
95 deSocketFamily deSocketAddress_getFamily (const deSocketAddress* address)
97 return address->family;
100 void deSocketAddress_destroy (deSocketAddress* address)
102 deFree(address->host);
106 deBool deSocketAddress_setPort (deSocketAddress* address, int port)
108 address->port = port;
112 int deSocketAddress_getPort (const deSocketAddress* address)
114 return address->port;
117 deBool deSocketAddress_setHost (deSocketAddress* address, const char* host)
121 deFree(address->host);
122 address->host = DE_NULL;
125 address->host = deStrdup(host);
126 return address->host != DE_NULL;
129 const char* deSocketAddress_getHost (const deSocketAddress* address)
131 return address->host;
135 deBool deSocketAddress_setType (deSocketAddress* address, deSocketType type)
137 address->type = type;
141 deSocketType deSocketAddress_getType (const deSocketAddress* address)
143 return address->type;
146 deBool deSocketAddress_setProtocol (deSocketAddress* address, deSocketProtocol protocol)
148 address->protocol = protocol;
152 deSocketProtocol deSocketAddress_getProtocol (const deSocketAddress* address)
154 return address->protocol;
159 #if defined(DE_USE_WINSOCK)
161 /* WinSock spesific. */
162 # include <WinSock2.h>
163 # include <WS2tcpip.h>
166 static deBool initWinsock (void)
169 if (WSAStartup(MAKEWORD(2, 2), &wsaData) != 0)
175 #elif defined(DE_USE_BERKELEY_SOCKETS)
177 /* Berkeley Socket includes. */
178 # include <sys/socket.h>
179 # include <netinet/in.h>
180 # include <netinet/tcp.h>
181 # include <arpa/inet.h>
190 #if defined(DE_USE_WINSOCK)
191 /* \note SOCKET is unsigned type! */
192 typedef SOCKET deSocketHandle;
193 typedef int NativeSocklen;
194 typedef int NativeSize;
195 # define DE_INVALID_SOCKET_HANDLE INVALID_SOCKET
197 typedef int deSocketHandle;
198 typedef socklen_t NativeSocklen;
199 typedef size_t NativeSize;
200 # define DE_INVALID_SOCKET_HANDLE -1
203 DE_INLINE deBool deSocketHandleIsValid (deSocketHandle handle)
205 return handle != DE_INVALID_SOCKET_HANDLE;
208 #if defined(DE_USE_WINSOCK) || defined(DE_USE_BERKELEY_SOCKETS)
210 /* Shared berkeley and winsock implementation. */
214 deSocketHandle handle;
217 volatile deSocketState state;
218 volatile deUint32 openChannels;
221 /* Common socket functions. */
223 static deUint16 deHostToNetworkOrder16 (deUint16 v)
225 #if (DE_ENDIANNESS == DE_LITTLE_ENDIAN)
226 return deReverseBytes16(v);
232 static deUint16 deNetworkToHostOrder16 (deUint16 v)
234 #if (DE_ENDIANNESS == DE_LITTLE_ENDIAN)
235 return deReverseBytes16(v);
241 DE_STATIC_ASSERT(sizeof(((struct sockaddr_in*)DE_NULL)->sin_port) == sizeof(deUint16));
242 DE_STATIC_ASSERT(sizeof(((struct sockaddr_in6*)DE_NULL)->sin6_port) == sizeof(deUint16));
244 static int deSocketFamilyToBsdFamily (deSocketFamily family)
248 case DE_SOCKETFAMILY_INET4: return AF_INET;
249 case DE_SOCKETFAMILY_INET6: return AF_INET6;
256 static int deSocketTypeToBsdType (deSocketType type)
260 case DE_SOCKETTYPE_STREAM: return SOCK_STREAM;
261 case DE_SOCKETTYPE_DATAGRAM: return SOCK_DGRAM;
268 static int deSocketProtocolToBsdProtocol (deSocketProtocol protocol)
272 case DE_SOCKETPROTOCOL_TCP: return IPPROTO_TCP;
273 case DE_SOCKETPROTOCOL_UDP: return IPPROTO_UDP;
280 static deBool deSocketAddressToBsdAddress (const deSocketAddress* address, size_t bsdAddrBufSize, struct sockaddr* bsdAddr, NativeSocklen* bsdAddrLen)
282 deMemset(bsdAddr, 0, bsdAddrBufSize);
285 if (address->host != DE_NULL)
287 struct addrinfo* result = DE_NULL;
288 struct addrinfo hints;
290 deMemset(&hints, 0, sizeof(hints));
291 hints.ai_family = deSocketFamilyToBsdFamily(address->family);
292 hints.ai_socktype = deSocketTypeToBsdType(address->type);
293 hints.ai_protocol = deSocketProtocolToBsdProtocol(address->protocol);
295 if (getaddrinfo(address->host, DE_NULL, &hints, &result) != 0 || !result)
298 freeaddrinfo(result);
302 /* \note Always uses first address. */
304 if (bsdAddrBufSize < (size_t)result->ai_addrlen)
306 DE_FATAL("Too small bsdAddr buffer");
307 freeaddrinfo(result);
311 *bsdAddrLen = (NativeSocklen)result->ai_addrlen;
313 deMemcpy(bsdAddr, result->ai_addr, (size_t)result->ai_addrlen);
314 freeaddrinfo(result);
317 if (bsdAddr->sa_family == AF_INET)
319 if (*bsdAddrLen < (NativeSocklen)sizeof(struct sockaddr_in))
321 ((struct sockaddr_in*)bsdAddr)->sin_port = deHostToNetworkOrder16((deUint16)address->port);
323 else if (bsdAddr->sa_family == AF_INET6)
325 if (*bsdAddrLen < (NativeSocklen)sizeof(struct sockaddr_in6))
327 ((struct sockaddr_in6*)bsdAddr)->sin6_port = deHostToNetworkOrder16((deUint16)address->port);
334 else if (address->family == DE_SOCKETFAMILY_INET4)
336 struct sockaddr_in* addr4 = (struct sockaddr_in*)bsdAddr;
338 if (bsdAddrBufSize < sizeof(struct sockaddr_in))
340 DE_FATAL("Too small bsdAddr buffer");
344 addr4->sin_port = deHostToNetworkOrder16((deUint16)address->port);
345 addr4->sin_family = AF_INET;
346 addr4->sin_addr.s_addr = INADDR_ANY;
348 *bsdAddrLen = (NativeSocklen)sizeof(struct sockaddr_in);
352 else if (address->family == DE_SOCKETFAMILY_INET6)
354 struct sockaddr_in6* addr6 = (struct sockaddr_in6*)bsdAddr;
356 if (bsdAddrBufSize < sizeof(struct sockaddr_in6))
358 DE_FATAL("Too small bsdAddr buffer");
362 addr6->sin6_port = deHostToNetworkOrder16((deUint16)address->port);
363 addr6->sin6_family = AF_INET6;
365 *bsdAddrLen = (NativeSocklen)sizeof(struct sockaddr_in6);
373 void deBsdAddressToSocketAddress (deSocketAddress* address, const struct sockaddr* bsdAddr, int addrLen)
375 /* Decode client address info. */
376 if (bsdAddr->sa_family == AF_INET)
378 const struct sockaddr_in* addr4 = (const struct sockaddr_in*)bsdAddr;
379 DE_ASSERT(addrLen >= (int)sizeof(struct sockaddr_in));
382 deSocketAddress_setFamily(address, DE_SOCKETFAMILY_INET4);
383 deSocketAddress_setPort(address, (int)deNetworkToHostOrder16((deUint16)addr4->sin_port));
386 char buf[16]; /* Max valid address takes 3*4 + 3 = 15 chars */
387 inet_ntop(AF_INET, (void*)&addr4->sin_addr, buf, sizeof(buf));
388 deSocketAddress_setHost(address, buf);
391 else if (bsdAddr->sa_family == AF_INET6)
393 const struct sockaddr_in6* addr6 = (const struct sockaddr_in6*)bsdAddr;
394 DE_ASSERT(addrLen >= (int)sizeof(struct sockaddr_in6));
397 deSocketAddress_setFamily(address, DE_SOCKETFAMILY_INET6);
398 deSocketAddress_setPort(address, (int)deNetworkToHostOrder16((deUint16)addr6->sin6_port));
401 char buf[40]; /* Max valid address takes 8*4 + 7 = 39 chars */
402 inet_ntop(AF_INET6, (void*)&addr6->sin6_addr, buf, sizeof(buf));
403 deSocketAddress_setHost(address, buf);
410 deSocket* deSocket_create (void)
412 deSocket* sock = (deSocket*)deCalloc(sizeof(deSocket));
416 #if defined(DE_USE_WINSOCK)
417 /* Make sure WSA is up. */
422 sock->stateLock = deMutex_create(0);
423 sock->handle = DE_INVALID_SOCKET_HANDLE;
424 sock->state = DE_SOCKETSTATE_CLOSED;
429 void deSocket_destroy (deSocket* sock)
431 if (sock->state != DE_SOCKETSTATE_CLOSED)
432 deSocket_close(sock);
434 deMutex_destroy(sock->stateLock);
438 deSocketState deSocket_getState (const deSocket* sock)
443 deUint32 deSocket_getOpenChannels (const deSocket* sock)
445 return sock->openChannels;
448 deBool deSocket_setFlags (deSocket* sock, deUint32 flags)
450 deSocketHandle fd = sock->handle;
452 if (sock->state == DE_SOCKETSTATE_CLOSED)
457 int mode = (flags & DE_SOCKET_KEEPALIVE) ? 1 : 0;
458 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, (const char*)&mode, sizeof(mode)) != 0)
464 int mode = (flags & DE_SOCKET_NODELAY) ? 1 : 0;
465 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (const char*)&mode, sizeof(mode)) != 0)
471 #if defined(DE_USE_WINSOCK)
472 u_long mode = (flags & DE_SOCKET_NONBLOCKING) ? 1 : 0;
473 if (ioctlsocket(fd, FIONBIO, &mode) != 0)
476 int oldFlags = fcntl(fd, F_GETFL, 0);
477 int newFlags = (flags & DE_SOCKET_NONBLOCKING) ? (oldFlags | O_NONBLOCK) : (oldFlags & ~O_NONBLOCK);
478 if (fcntl(fd, F_SETFL, newFlags) != 0)
485 #if defined(DE_USE_BERKELEY_SOCKETS)
486 int oldFlags = fcntl(fd, F_GETFD, 0);
487 int newFlags = (flags & DE_SOCKET_CLOSE_ON_EXEC) ? (oldFlags | FD_CLOEXEC) : (oldFlags & ~FD_CLOEXEC);
488 if (fcntl(fd, F_SETFD, newFlags) != 0)
496 deBool deSocket_listen (deSocket* sock, const deSocketAddress* address)
498 const int backlogSize = 4;
499 deUint8 bsdAddrBuf[sizeof(struct sockaddr_in6)];
500 struct sockaddr* bsdAddr = (struct sockaddr*)&bsdAddrBuf[0];
501 NativeSocklen bsdAddrLen;
503 if (sock->state != DE_SOCKETSTATE_CLOSED)
506 /* Resolve address. */
507 if (!deSocketAddressToBsdAddress(address, sizeof(bsdAddrBuf), bsdAddr, &bsdAddrLen))
511 sock->handle = socket(bsdAddr->sa_family, deSocketTypeToBsdType(address->type), deSocketProtocolToBsdProtocol(address->protocol));
512 if (!deSocketHandleIsValid(sock->handle))
515 sock->state = DE_SOCKETSTATE_DISCONNECTED;
517 /* Allow re-using address. */
520 setsockopt(sock->handle, SOL_SOCKET, SO_REUSEADDR, (const char*)&reuseVal, (int)sizeof(reuseVal));
523 /* Bind to address. */
524 if (bind(sock->handle, bsdAddr, (NativeSocklen)bsdAddrLen) != 0)
526 deSocket_close(sock);
530 /* Start listening. */
531 if (listen(sock->handle, backlogSize) != 0)
533 deSocket_close(sock);
537 sock->state = DE_SOCKETSTATE_LISTENING;
542 deSocket* deSocket_accept (deSocket* sock, deSocketAddress* clientAddress)
544 deSocketHandle newFd = DE_INVALID_SOCKET_HANDLE;
545 deSocket* newSock = DE_NULL;
546 deUint8 bsdAddrBuf[sizeof(struct sockaddr_in6)];
547 struct sockaddr* bsdAddr = (struct sockaddr*)&bsdAddrBuf[0];
548 NativeSocklen bsdAddrLen = (NativeSocklen)sizeof(bsdAddrBuf);
550 deMemset(bsdAddr, 0, (size_t)bsdAddrLen);
552 newFd = accept(sock->handle, bsdAddr, &bsdAddrLen);
553 if (!deSocketHandleIsValid(newFd))
556 newSock = (deSocket*)deCalloc(sizeof(deSocket));
559 #if defined(DE_USE_WINSOCK)
567 newSock->stateLock = deMutex_create(0);
568 newSock->handle = newFd;
569 newSock->state = DE_SOCKETSTATE_CONNECTED;
570 newSock->openChannels = DE_SOCKETCHANNEL_BOTH;
573 deBsdAddressToSocketAddress(clientAddress, bsdAddr, (int)bsdAddrLen);
578 deBool deSocket_connect (deSocket* sock, const deSocketAddress* address)
580 deUint8 bsdAddrBuf[sizeof(struct sockaddr_in6)];
581 struct sockaddr* bsdAddr = (struct sockaddr*)&bsdAddrBuf[0];
582 NativeSocklen bsdAddrLen;
584 /* Resolve address. */
585 if (!deSocketAddressToBsdAddress(address, sizeof(bsdAddrBuf), bsdAddr, &bsdAddrLen))
589 sock->handle = socket(bsdAddr->sa_family, deSocketTypeToBsdType(address->type), deSocketProtocolToBsdProtocol(address->protocol));
590 if (!deSocketHandleIsValid(sock->handle))
594 if (connect(sock->handle, bsdAddr, bsdAddrLen) != 0)
596 #if defined(DE_USE_WINSOCK)
597 closesocket(sock->handle);
601 sock->handle = DE_INVALID_SOCKET_HANDLE;
605 sock->state = DE_SOCKETSTATE_CONNECTED;
606 sock->openChannels = DE_SOCKETCHANNEL_BOTH;
611 deBool deSocket_shutdown (deSocket* sock, deUint32 channels)
613 deUint32 closedChannels = 0;
615 deMutex_lock(sock->stateLock);
617 if (sock->state == DE_SOCKETSTATE_DISCONNECTED ||
618 sock->state == DE_SOCKETSTATE_CLOSED)
620 deMutex_unlock(sock->stateLock);
624 DE_ASSERT(channels != 0 && (channels & ~(deUint32)DE_SOCKETCHANNEL_BOTH) == 0);
626 /* Don't attempt to close already closed channels on partially open socket. */
627 channels &= sock->openChannels;
631 deMutex_unlock(sock->stateLock);
635 #if defined(DE_USE_WINSOCK)
639 if ((channels & DE_SOCKETCHANNEL_BOTH) == DE_SOCKETCHANNEL_BOTH)
641 else if (channels & DE_SOCKETCHANNEL_SEND)
643 else if (channels & DE_SOCKETCHANNEL_RECEIVE)
646 if (shutdown(sock->handle, how) == 0)
647 closedChannels = channels;
650 int err = WSAGetLastError();
652 /* \note Due to asynchronous behavior certain errors are perfectly ok. */
653 if (err == WSAECONNABORTED || err == WSAECONNRESET || err == WSAENOTCONN)
654 closedChannels = DE_SOCKETCHANNEL_BOTH;
657 deMutex_unlock(sock->stateLock);
666 if ((channels & DE_SOCKETCHANNEL_BOTH) == DE_SOCKETCHANNEL_BOTH)
668 else if (channels & DE_SOCKETCHANNEL_SEND)
670 else if (channels & DE_SOCKETCHANNEL_RECEIVE)
673 if (shutdown(sock->handle, how) == 0)
674 closedChannels = channels;
677 if (errno == ENOTCONN)
678 closedChannels = DE_SOCKETCHANNEL_BOTH;
681 deMutex_unlock(sock->stateLock);
688 sock->openChannels &= ~closedChannels;
689 if (sock->openChannels == 0)
690 sock->state = DE_SOCKETSTATE_DISCONNECTED;
692 deMutex_unlock(sock->stateLock);
696 deBool deSocket_close (deSocket* sock)
698 deMutex_lock(sock->stateLock);
700 if (sock->state == DE_SOCKETSTATE_CLOSED)
702 deMutex_unlock(sock->stateLock);
706 #if !defined(DE_USE_WINSOCK)
707 if (sock->state == DE_SOCKETSTATE_LISTENING)
709 /* There can be a thread blockin in accept(). Release it by calling shutdown. */
710 shutdown(sock->handle, SHUT_RDWR);
714 #if defined(DE_USE_WINSOCK)
715 if (closesocket(sock->handle) != 0)
718 if (close(sock->handle) != 0)
721 sock->state = DE_SOCKETSTATE_CLOSED;
722 sock->handle = DE_INVALID_SOCKET_HANDLE;
723 sock->openChannels = 0;
725 deMutex_unlock(sock->stateLock);
729 static deSocketResult mapSendRecvResult (int numBytes)
732 return DE_SOCKETRESULT_SUCCESS;
733 else if (numBytes == 0)
734 return DE_SOCKETRESULT_CONNECTION_CLOSED;
738 #if defined(DE_USE_WINSOCK)
739 int error = WSAGetLastError();
742 case WSAEWOULDBLOCK: return DE_SOCKETRESULT_WOULD_BLOCK;
745 case WSAECONNABORTED:
746 case WSAECONNRESET: return DE_SOCKETRESULT_CONNECTION_TERMINATED;
747 default: return DE_SOCKETRESULT_ERROR;
752 case EAGAIN: return DE_SOCKETRESULT_WOULD_BLOCK;
754 case ECONNRESET: return DE_SOCKETRESULT_CONNECTION_TERMINATED;
755 default: return DE_SOCKETRESULT_ERROR;
761 DE_INLINE void deSocket_setChannelsClosed (deSocket* sock, deUint32 channels)
763 deMutex_lock(sock->stateLock);
765 sock->openChannels &= ~channels;
766 if (sock->openChannels == 0)
767 sock->state = DE_SOCKETSTATE_DISCONNECTED;
769 deMutex_unlock(sock->stateLock);
772 deSocketResult deSocket_send (deSocket* sock, const void* buf, size_t bufSize, size_t* numSentPtr)
774 int numSent = (int)send(sock->handle, (const char*)buf, (NativeSize)bufSize, 0);
775 deSocketResult result = mapSendRecvResult(numSent);
778 *numSentPtr = (numSent > 0) ? ((size_t)numSent) : (0);
781 if (result == DE_SOCKETRESULT_CONNECTION_CLOSED)
782 deSocket_setChannelsClosed(sock, DE_SOCKETCHANNEL_SEND);
783 else if (result == DE_SOCKETRESULT_CONNECTION_TERMINATED)
784 deSocket_setChannelsClosed(sock, DE_SOCKETCHANNEL_BOTH);
789 deSocketResult deSocket_receive (deSocket* sock, void* buf, size_t bufSize, size_t* numReceivedPtr)
791 int numRecv = (int)recv(sock->handle, (char*)buf, (NativeSize)bufSize, 0);
792 deSocketResult result = mapSendRecvResult(numRecv);
795 *numReceivedPtr = (numRecv > 0) ? ((size_t)numRecv) : (0);
798 if (result == DE_SOCKETRESULT_CONNECTION_CLOSED)
799 deSocket_setChannelsClosed(sock, DE_SOCKETCHANNEL_RECEIVE);
800 else if (result == DE_SOCKETRESULT_CONNECTION_TERMINATED)
801 deSocket_setChannelsClosed(sock, DE_SOCKETCHANNEL_BOTH);