2 simgear::Socket, adapted from PLIB Socket by James Turner
3 Copyright (C) 2010 James Turner
5 PLIB - A Suite of Portable Game Libraries
6 Copyright (C) 1998,2002 Steve Baker
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Library General Public
10 License as published by the Free Software Foundation; either
11 version 2 of the License, or (at your option) any later version.
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Library General Public License for more details.
18 You should have received a copy of the GNU Library General Public
19 License along with this library; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 # include <simgear_config.h>
27 #include <simgear/compiler.h>
28 #include "raw_socket.hxx"
30 #if defined(_WIN32) && !defined(__CYGWIN__)
31 # define WINSOCK // use winsock convetions, otherwise standard POSIX
38 #include <cstdio> // for snprintf
42 # include <winsock2.h>
43 # include <ws2tcpip.h>
46 # include <sys/types.h>
47 # include <sys/socket.h>
48 # include <netinet/in.h>
49 # include <arpa/inet.h>
50 # include <sys/time.h>
56 #if defined(_MSC_VER) && !defined(socklen_t)
62 #include <simgear/debug/logstream.hxx>
63 #include <simgear/structure/exception.hxx>
65 #include <OpenThreads/Thread>
66 #include <OpenThreads/Mutex>
67 #include <OpenThreads/Condition>
71 class Resolver : public OpenThreads::Thread
74 static Resolver* instance()
76 if (!static_instance) {
77 OpenThreads::Thread::Init();
79 static_instance = new Resolver;
80 atexit(&Resolver::cleanup);
81 static_instance->start();
84 return static_instance;
89 static_instance->cancel();
94 // take the lock initially, thread will wait upon it once running
98 simgear::IPAddress* lookup(const string& host)
100 simgear::IPAddress* result = NULL;
102 AddressCache::iterator it = _cache.find(host);
103 if (it == _cache.end()) {
104 _cache[host] = NULL; // mark as needing looked up
105 _wait.signal(); // if the thread was sleeping, poke it
113 simgear::IPAddress* lookupSync(const string& host)
115 simgear::IPAddress* result = NULL;
117 AddressCache::iterator it = _cache.find(host);
118 if (it == _cache.end()) {
120 result = new simgear::IPAddress;
121 bool ok = lookupHost(host.c_str(), *result);
124 _cache[host] = result; // mark as needing looked up
129 } else { // found in cache, easy
137 * run method waits on a condition (_wait), and when awoken,
138 * finds any unresolved entries in _cache, resolves them, and goes
145 AddressCache::iterator it;
147 for (it = _cache.begin(); it != _cache.end(); ++it) {
148 if (it->second == NULL) {
149 string h = it->first;
152 simgear::IPAddress* addr = new simgear::IPAddress;
153 // may take seconds or even minutes!
154 lookupHost(h.c_str(), *addr);
157 // cahce may have changed while we had the lock released -
158 // so iterators may be invalid: restart the traversal
161 } // of found un-resolved entry
162 } // of un-resolved address iteration
163 } // of thread run loop
166 static Resolver* static_instance;
169 * The actual synchronous, blocking host lookup function
170 * do *not* call this with any locks (mutexs) held, since depending
171 * on local system configuration / network availability, it
172 * may block for seconds or minutes.
174 bool lookupHost(const char* host, simgear::IPAddress& addr)
176 struct addrinfo hints;
177 memset(&hints, 0, sizeof(struct addrinfo));
178 hints.ai_family = AF_INET;
181 struct addrinfo* result0 = NULL;
182 int err = getaddrinfo(host, NULL, &hints, &result0);
184 SG_LOG(SG_IO, SG_WARN, "getaddrinfo failed for '" << host << "' : " << gai_strerror(err));
187 struct addrinfo* result;
188 for (result = result0; result != NULL; result = result->ai_next) {
189 if (result->ai_family != AF_INET) { // only accept IP4 for the moment
193 if (result->ai_addrlen != addr.getAddrLen()) {
194 SG_LOG(SG_IO, SG_ALERT, "mismatch in socket address sizes: got " <<
195 result->ai_addrlen << ", expected " << addr.getAddrLen());
199 memcpy(addr.getAddr(), result->ai_addr, result->ai_addrlen);
202 } // of getaddrinfo results iteration
203 } // of getaddrinfo succeeded
205 freeaddrinfo(result0);
209 OpenThreads::Mutex _lock;
210 OpenThreads::Condition _wait;
212 typedef std::map<string, simgear::IPAddress*> AddressCache;
216 Resolver* Resolver::static_instance = NULL;
218 } // of anonymous namespace
223 IPAddress::IPAddress ( const char* host, int port )
228 IPAddress::IPAddress( const IPAddress& other ) :
232 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
233 memcpy(addr, other.addr, sizeof(struct sockaddr_in));
237 const IPAddress& IPAddress::operator=(const IPAddress& other)
245 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
246 memcpy(addr, other.addr, sizeof(struct sockaddr_in));
252 void IPAddress::set ( const char* host, int port )
254 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
255 memset(addr, 0, sizeof(struct sockaddr_in));
257 addr->sin_family = AF_INET ;
258 addr->sin_port = htons (port);
260 /* Convert a string specifying a host name or one of a few symbolic
261 ** names to a numeric IP address. This usually calls getaddrinfo()
262 ** to do the work; the names "" and "<broadcast>" are special.
265 if (!host || host[0] == '\0') {
266 addr->sin_addr.s_addr = INADDR_ANY;
270 if (strcmp(host, "<broadcast>") == 0) {
271 addr->sin_addr.s_addr = INADDR_BROADCAST;
276 IPAddress* cached = Resolver::instance()->lookupSync(host);
278 memcpy(addr, cached->getAddr(), cached->getAddrLen());
281 addr->sin_port = htons (port); // fix up port after getaddrinfo
284 IPAddress::~IPAddress()
291 bool IPAddress::lookupNonblocking(const char* host, IPAddress& addr)
293 IPAddress* cached = Resolver::instance()->lookup(host);
302 /* Create a string object representing an IP address.
303 This is always a string of the form 'dd.dd.dd.dd' (with variable
306 const char* IPAddress::getHost () const
308 static char buf [32];
309 long x = ntohl(addr->sin_addr.s_addr);
310 sprintf(buf, "%d.%d.%d.%d",
311 (int) (x>>24) & 0xff, (int) (x>>16) & 0xff,
312 (int) (x>> 8) & 0xff, (int) (x>> 0) & 0xff );
316 unsigned int IPAddress::getIP () const
318 return addr->sin_addr.s_addr;
321 unsigned int IPAddress::getPort() const
323 return ntohs(addr->sin_port);
326 void IPAddress::setPort(int port)
328 addr->sin_port = htons(port);
331 unsigned int IPAddress::getFamily () const
333 return addr->sin_family;
336 const char* IPAddress::getLocalHost ()
338 //gethostbyname(gethostname())
341 memset(buf, 0, sizeof(buf));
342 gethostname(buf, sizeof(buf)-1);
343 const hostent *hp = gethostbyname(buf);
345 if (hp && *hp->h_addr_list)
347 in_addr addr = *((in_addr*)*hp->h_addr_list);
348 const char* host = inet_ntoa(addr);
358 bool IPAddress::getBroadcast () const
360 return (addr->sin_addr.s_addr == INADDR_BROADCAST);
363 unsigned int IPAddress::getAddrLen() const
365 return sizeof(struct sockaddr_in);
368 struct sockaddr* IPAddress::getAddr() const
371 addr = (struct sockaddr_in*) malloc(sizeof(struct sockaddr_in));
372 memset(addr, 0, sizeof(struct sockaddr_in));
375 return (struct sockaddr*) addr;
390 void Socket::setHandle (int _handle)
397 bool Socket::open ( bool stream )
400 handle = ::socket ( AF_INET, (stream? SOCK_STREAM: SOCK_DGRAM), 0 ) ;
402 // Jan 26, 2010: Patch to avoid the problem of the socket resource not
403 // yet being available if the program is restarted quickly after being
406 // Reference: http://www.unixguide.net/network/socketfaq/4.5.shtml
408 // Also required for joining multicast domains
411 #if defined(_WIN32) || defined(__CYGWIN__)
412 setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, (char *)&opt_boolean,
413 sizeof(opt_boolean) );
415 setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, &opt_boolean,
416 sizeof(opt_boolean) );
420 return (handle != -1);
424 void Socket::setBlocking ( bool blocking )
426 assert ( handle != -1 ) ;
429 u_long nblocking = blocking? 0: 1;
430 ::ioctlsocket(handle, FIONBIO, &nblocking);
433 int delay_flag = ::fcntl (handle, F_GETFL, 0);
436 delay_flag &= (~O_NDELAY);
438 delay_flag |= O_NDELAY;
440 ::fcntl (handle, F_SETFL, delay_flag);
445 void Socket::setBroadcast ( bool broadcast )
447 assert ( handle != -1 ) ;
451 #if defined(_WIN32) || defined(__CYGWIN__)
452 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, (char*)&one, sizeof(one) );
454 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, &one, sizeof(one) );
457 result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, NULL, 0 );
461 throw sg_exception("Socket::setBroadcast failed");
466 int Socket::bind ( const char* host, int port )
469 assert ( handle != -1 ) ;
470 IPAddress addr ( host, port ) ;
472 #if !defined(WINSOCK)
473 if( (result = ::bind(handle, addr.getAddr(), addr.getAddrLen() ) ) < 0 ) {
474 SG_LOG(SG_IO, SG_ALERT, "bind(" << addr.getHost() << ":" << addr.getPort() << ") failed. Errno " << errno << " (" << strerror(errno) << ")");
479 // 224.0.0.0 - 239.255.255.255 are multicast
480 // Usage of 239.x.x.x is recommended for local scope
481 // Reference: http://tools.ietf.org/html/rfc5771
482 if( ntohl(addr.getIP()) >= 0xe0000000 && ntohl(addr.getIP()) <= 0xefffffff ) {
485 struct sockaddr_in a;
486 a.sin_addr.S_un.S_addr = INADDR_ANY;
487 a.sin_family = AF_INET;
488 a.sin_port = htons(port);
490 if( (result = ::bind(handle,(const sockaddr*)&a,sizeof(a))) < 0 ) {
491 SG_LOG(SG_IO, SG_ALERT, "bind(any:" << port << ") failed. Errno " << errno << " (" << strerror(errno) << ")");
497 mreq.imr_multiaddr.s_addr = addr.getIP();
498 mreq.imr_interface.s_addr = htonl(INADDR_ANY);
499 if( (result=::setsockopt(getHandle(), IPPROTO_IP, IP_ADD_MEMBERSHIP, (const char *)&mreq, sizeof(mreq))) != 0 ) {
500 SG_LOG(SG_IO, SG_ALERT, "setsockopt(IP_ADD_MEMBERSHIP) failed. Errno " << errno << " (" << strerror(errno) << ")");
505 else if( (result = ::bind(handle,addr.getAddr(), addr.getAddrLen())) < 0 ) {
506 SG_LOG(SG_IO, SG_ALERT, "bind(" << host << ":" << port << ") failed. Errno " << errno << " (" << strerror(errno) << ")");
515 int Socket::listen ( int backlog )
517 assert ( handle != -1 ) ;
518 return ::listen(handle,backlog);
522 int Socket::accept ( IPAddress* addr )
524 assert ( handle != -1 ) ;
528 return ::accept(handle,NULL,NULL);
532 socklen_t addr_len = addr->getAddrLen(); ;
533 return ::accept(handle, addr->getAddr(), &addr_len);
538 int Socket::connect ( const char* host, int port )
540 IPAddress addr ( host, port ) ;
541 return connect ( &addr );
545 int Socket::connect ( IPAddress* addr )
547 assert ( handle != -1 ) ;
548 if ( addr->getBroadcast() ) {
549 setBroadcast( true );
551 return ::connect(handle, addr->getAddr(), addr->getAddrLen() );
555 int Socket::send (const void * buffer, int size, int flags)
557 assert ( handle != -1 ) ;
558 return ::send (handle, (const char*)buffer, size, flags);
562 int Socket::sendto ( const void * buffer, int size,
563 int flags, const IPAddress* to )
565 assert ( handle != -1 ) ;
566 return ::sendto(handle,(const char*)buffer,size,flags,
567 (const sockaddr*) to->getAddr(), to->getAddrLen());
571 int Socket::recv (void * buffer, int size, int flags)
573 assert ( handle != -1 ) ;
574 return ::recv (handle, (char*)buffer, size, flags);
578 int Socket::recvfrom ( void * buffer, int size,
579 int flags, IPAddress* from )
581 assert ( handle != -1 ) ;
582 socklen_t fromlen = (socklen_t) from->getAddrLen() ;
583 return ::recvfrom(handle,(char*)buffer,size,flags, from->getAddr(),&fromlen);
587 void Socket::close (void)
592 ::closesocket( handle );
601 bool Socket::isNonBlockingError ()
604 int wsa_errno = WSAGetLastError();
605 if ( wsa_errno != 0 )
608 SG_LOG(SG_IO, SG_WARN, "isNonBlockingError: WSAGetLastError():" << wsa_errno);
610 case WSAEWOULDBLOCK: // always == NET_EAGAIN?
619 case EWOULDBLOCK: // always == NET_EAGAIN?
630 //////////////////////////////////////////////////////////////////////
632 // modified version by os
634 //////////////////////////////////////////////////////////////////////
635 int Socket::select ( Socket** reads, Socket** writes, int timeout )
648 for ( i=0; reads[i]; i++ )
650 int fd = reads[i]->getHandle();
658 for ( i=0; writes[i]; i++ )
660 int fd = writes[i]->getHandle();
669 /* Set up the timeout */
671 tv.tv_sec = timeout/1000;
672 tv.tv_usec = (timeout%1000)*1000;
674 // It bothers me that select()'s first argument does not appear to
675 // work as advertised... [it hangs like this if called with
676 // anything less than FD_SETSIZE, which seems wasteful?]
678 // Note: we ignore the 'exception' fd_set - I have never had a
679 // need to use it. The name is somewhat misleading - the only
680 // thing I have ever seen it used for is to detect urgent data -
681 // which is an unportable feature anyway.
683 retval = ::select (FD_SETSIZE, &r, &w, 0, &tv);
685 //remove sockets that had no activity
691 for ( k=i=0; reads[i]; i++ )
693 int fd = reads[i]->getHandle();
694 if ( FD_ISSET (fd, &r) )
696 reads[k++] = reads[i];
705 for ( k=i=0; writes[i]; i++ )
707 int fd = writes[i]->getHandle();
708 if ( FD_ISSET (fd, &w) )
710 writes[k++] = writes[i];
717 if (retval == 0) // timeout
719 if (retval == -1)// error
726 /* Init/Exit functions */
728 static void netExit ( void )
731 /* Clean up windows networking */
732 if ( WSACleanup() == SOCKET_ERROR ) {
733 if ( WSAGetLastError() == WSAEINPROGRESS ) {
734 WSACancelBlockingCall();
741 int Socket::initSockets()
744 /* Start up the windows networking */
745 WORD version_wanted = MAKEWORD(1,1);
748 if ( WSAStartup(version_wanted, &wsaData) != 0 ) {
749 throw sg_exception("WinSock initialization failed");
758 } // of namespace simgear