simgear/io/raw_socket.cxx

   1 /*
   2      simgear::Socket, adapted from PLIB Socket by James Turner
   3      Copyright (C) 2010  James Turner
   4
   5      PLIB - A Suite of Portable Game Libraries
   6      Copyright (C) 1998,2002  Steve Baker
   7
   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.
  12
  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.
  17
  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
  21 */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <simgear_config.h>
  25 #endif
  26
  27 #include <simgear/compiler.h>
  28
  29 #include "sg_socket.hxx"
  30
  31 #if defined(_WIN32) && !defined(__CYGWIN__)
  32 # define WINSOCK // use winsock convetions, otherwise standard POSIX
  33 #endif
  34
  35 #include <cstdlib>
  36 #include <ctime>
  37 #include <cstring>
  38 #include <cassert>
  39 #include <cstdio> // for snprintf
  40
  41 #if defined(WINSOCK)
  42 #  include <winsock.h>
  43 #  include <stdarg.h>
  44 #else
  45 #  include <sys/types.h>
  46 #  include <sys/socket.h>
  47 #  include <netinet/in.h>
  48 #  include <arpa/inet.h>
  49 #  include <sys/time.h>
  50 #  include <unistd.h>
  51 #  include <netdb.h>
  52 #  include <fcntl.h>
  53 #endif
  54
  55 #if defined(_MSC_VER) && !defined(socklen_t)
  56 #define socklen_t int
  57 #endif
  58
  59 #include <simgear/debug/logstream.hxx>
  60 #include <simgear/structure/exception.hxx>
  61
  62 namespace simgear
  63 {
  64
  65 IPAddress::IPAddress ( const char* host, int port )
  66 {
  67   set ( host, port ) ;
  68 }
  69
  70
  71 void IPAddress::set ( const char* host, int port )
  72 {
  73   memset(this, 0, sizeof(IPAddress));
  74
  75   sin_family = AF_INET ;
  76   sin_port = htons (port);
  77
  78   /* Convert a string specifying a host name or one of a few symbolic
  79   ** names to a numeric IP address.  This usually calls gethostbyname()
  80   ** to do the work; the names "" and "<broadcast>" are special.
  81   */
  82
  83   if (!host || host[0] == '\0') {
  84     sin_addr = INADDR_ANY;
  85     return;
  86   }
  87
  88   if (strcmp(host, "<broadcast>") == 0) {
  89     sin_addr = INADDR_BROADCAST;
  90     return;
  91   }
  92
  93   sin_addr = inet_addr ( host ) ;
  94   if (sin_addr != INADDR_NONE) {
  95     return;
  96   }
  97 // finally, try gethostbyname
  98     struct hostent *hp = gethostbyname ( host ) ;
  99     if (!hp) {
 100       SG_LOG(SG_IO, SG_WARN, "gethostbyname failed for " << host);
 101       sin_addr = INADDR_ANY ;
 102       return;
 103     }
 104
 105     memcpy ( (char *) &sin_addr, hp->h_addr, hp->h_length ) ;
 106 }
 107
 108
 109 /* Create a string object representing an IP address.
 110    This is always a string of the form 'dd.dd.dd.dd' (with variable
 111    size numbers). */
 112
 113 const char* IPAddress::getHost () const
 114 {
 115 #if 0
 116   const char* buf = inet_ntoa ( sin_addr ) ;
 117 #else
 118   static char buf [32];
 119         long x = ntohl(sin_addr);
 120         sprintf(buf, "%d.%d.%d.%d",
 121                 (int) (x>>24) & 0xff, (int) (x>>16) & 0xff,
 122                 (int) (x>> 8) & 0xff, (int) (x>> 0) & 0xff );
 123 #endif
 124   return buf;
 125 }
 126
 127 unsigned int IPAddress::getIP () const
 128 {
 129         return sin_addr;
 130 }
 131
 132 unsigned int IPAddress::getPort() const
 133 {
 134   return ntohs(sin_port);
 135 }
 136
 137 unsigned int IPAddress::getFamily () const
 138 {
 139         return sin_family;
 140 }
 141
 142 const char* IPAddress::getLocalHost ()
 143 {
 144   //gethostbyname(gethostname())
 145
 146   char buf[256];
 147   memset(buf, 0, sizeof(buf));
 148   gethostname(buf, sizeof(buf)-1);
 149   const hostent *hp = gethostbyname(buf);
 150
 151   if (hp && *hp->h_addr_list)
 152   {
 153     in_addr     addr = *((in_addr*)*hp->h_addr_list);
 154     const char* host = inet_ntoa(addr);
 155
 156     if ( host )
 157       return host ;
 158   }
 159
 160   return "127.0.0.1" ;
 161 }
 162
 163
 164 bool IPAddress::getBroadcast () const
 165 {
 166   return sin_addr == INADDR_BROADCAST;
 167 }
 168
 169
 170 Socket::Socket ()
 171 {
 172   handle = -1 ;
 173 }
 174
 175
 176 Socket::~Socket ()
 177 {
 178   close () ;
 179 }
 180
 181
 182 void Socket::setHandle (int _handle)
 183 {
 184   close () ;
 185   handle = _handle ;
 186 }
 187
 188
 189 bool Socket::open ( bool stream )
 190 {
 191   close () ;
 192   handle = ::socket ( AF_INET, (stream? SOCK_STREAM: SOCK_DGRAM), 0 ) ;
 193
 194   // Jan 26, 2010: Patch to avoid the problem of the socket resource not
 195   // yet being available if the program is restarted quickly after being
 196   // killed.
 197   //
 198   // Reference: http://www.unixguide.net/network/socketfaq/4.5.shtml
 199   //
 200   if ( stream ) {
 201     int opt_boolean = 1;
 202 #if defined(_WIN32) || defined(__CYGWIN__)
 203     setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, (char *)&opt_boolean,
 204                 sizeof(opt_boolean) );
 205 #else
 206     setsockopt( handle, SOL_SOCKET, SO_REUSEADDR, &opt_boolean,
 207                 sizeof(opt_boolean) );
 208 #endif
 209   }
 210
 211   return (handle != -1);
 212 }
 213
 214
 215 void Socket::setBlocking ( bool blocking )
 216 {
 217   assert ( handle != -1 ) ;
 218
 219 #if defined(WINSOCK)
 220     u_long nblocking = blocking? 0: 1;
 221   ::ioctlsocket(handle, FIONBIO, &nblocking);
 222 #else
 223
 224   int delay_flag = ::fcntl (handle, F_GETFL, 0);
 225
 226   if (blocking)
 227     delay_flag &= (~O_NDELAY);
 228   else
 229     delay_flag |= O_NDELAY;
 230
 231   ::fcntl (handle, F_SETFL, delay_flag);
 232 #endif
 233 }
 234
 235
 236 void Socket::setBroadcast ( bool broadcast )
 237 {
 238   assert ( handle != -1 ) ;
 239   int result;
 240   if ( broadcast ) {
 241       int one = 1;
 242 #if defined(_WIN32) || defined(__CYGWIN__)
 243       result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, (char*)&one, sizeof(one) );
 244 #else
 245       result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, &one, sizeof(one) );
 246 #endif
 247   } else {
 248       result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, NULL, 0 );
 249   }
 250
 251   if ( result < 0 ) {
 252       throw sg_exception("Socket::setBroadcast failed");
 253   }
 254 }
 255
 256
 257 int Socket::bind ( const char* host, int port )
 258 {
 259   assert ( handle != -1 ) ;
 260   IPAddress addr ( host, port ) ;
 261   return ::bind(handle,(const sockaddr*)&addr,sizeof(IPAddress));
 262 }
 263
 264
 265 int Socket::listen ( int backlog )
 266 {
 267   assert ( handle != -1 ) ;
 268   return ::listen(handle,backlog);
 269 }
 270
 271
 272 int Socket::accept ( IPAddress* addr )
 273 {
 274   assert ( handle != -1 ) ;
 275
 276   if ( addr == NULL )
 277   {
 278     return ::accept(handle,NULL,NULL);
 279   }
 280   else
 281   {
 282     socklen_t addr_len = (socklen_t) sizeof(IPAddress) ;
 283     return ::accept(handle,(sockaddr*)addr,&addr_len);
 284   }
 285 }
 286
 287
 288 int Socket::connect ( const char* host, int port )
 289 {
 290   assert ( handle != -1 ) ;
 291   IPAddress addr ( host, port ) ;
 292   if ( addr.getBroadcast() ) {
 293       setBroadcast( true );
 294   }
 295   return ::connect(handle,(const sockaddr*)&addr,sizeof(IPAddress));
 296 }
 297
 298
 299 int Socket::send (const void * buffer, int size, int flags)
 300 {
 301   assert ( handle != -1 ) ;
 302   return ::send (handle, (const char*)buffer, size, flags);
 303 }
 304
 305
 306 int Socket::sendto ( const void * buffer, int size,
 307                         int flags, const IPAddress* to )
 308 {
 309   assert ( handle != -1 ) ;
 310   return ::sendto(handle,(const char*)buffer,size,flags,
 311                          (const sockaddr*)to,sizeof(IPAddress));
 312 }
 313
 314
 315 int Socket::recv (void * buffer, int size, int flags)
 316 {
 317   assert ( handle != -1 ) ;
 318   return ::recv (handle, (char*)buffer, size, flags);
 319 }
 320
 321
 322 int Socket::recvfrom ( void * buffer, int size,
 323                           int flags, IPAddress* from )
 324 {
 325   assert ( handle != -1 ) ;
 326   socklen_t fromlen = (socklen_t) sizeof(IPAddress) ;
 327   return ::recvfrom(handle,(char*)buffer,size,flags,(sockaddr*)from,&fromlen);
 328 }
 329
 330
 331 void Socket::close (void)
 332 {
 333   if ( handle != -1 )
 334   {
 335 #if defined(WINSOCK)
 336     ::closesocket( handle );
 337 #else
 338     ::close( handle );
 339 #endif
 340     handle = -1 ;
 341   }
 342 }
 343
 344
 345 bool Socket::isNonBlockingError ()
 346 {
 347 #if defined(WINSOCK)
 348   int wsa_errno = WSAGetLastError();
 349   if ( wsa_errno != 0 )
 350   {
 351     WSASetLastError(0);
 352         SG_LOG(SG_IO, SG_WARN, "isNonBlockingError: WSAGetLastError():" << wsa_errno);
 353     switch (wsa_errno) {
 354     case WSAEWOULDBLOCK: // always == NET_EAGAIN?
 355     case WSAEALREADY:
 356     case WSAEINPROGRESS:
 357       return true;
 358     }
 359   }
 360   return false;
 361 #else
 362   switch (errno) {
 363   case EWOULDBLOCK: // always == NET_EAGAIN?
 364   case EALREADY:
 365   case EINPROGRESS:
 366     return true;
 367   }
 368   return false;
 369
 370 #endif
 371 }
 372
 373
 374 //////////////////////////////////////////////////////////////////////
 375 //
 376 //      modified version by os
 377 //
 378 //////////////////////////////////////////////////////////////////////
 379 int Socket::select ( Socket** reads, Socket** writes, int timeout )
 380 {
 381   fd_set r,w;
 382   int   retval;
 383
 384   FD_ZERO (&r);
 385   FD_ZERO (&w);
 386
 387   int i, k ;
 388   int num = 0 ;
 389
 390   if ( reads )
 391   {
 392     for ( i=0; reads[i]; i++ )
 393     {
 394       int fd = reads[i]->getHandle();
 395       FD_SET (fd, &r);
 396       num++;
 397     }
 398   }
 399
 400   if ( writes )
 401   {
 402     for ( i=0; writes[i]; i++ )
 403     {
 404       int fd = writes[i]->getHandle();
 405       FD_SET (fd, &w);
 406       num++;
 407     }
 408   }
 409
 410   if (!num)
 411     return num ;
 412
 413   /* Set up the timeout */
 414   struct timeval tv ;
 415   tv.tv_sec = timeout/1000;
 416   tv.tv_usec = (timeout%1000)*1000;
 417
 418   // It bothers me that select()'s first argument does not appear to
 419   // work as advertised... [it hangs like this if called with
 420   // anything less than FD_SETSIZE, which seems wasteful?]
 421
 422   // Note: we ignore the 'exception' fd_set - I have never had a
 423   // need to use it.  The name is somewhat misleading - the only
 424   // thing I have ever seen it used for is to detect urgent data -
 425   // which is an unportable feature anyway.
 426
 427   retval = ::select (FD_SETSIZE, &r, &w, 0, &tv);
 428
 429   //remove sockets that had no activity
 430
 431   num = 0 ;
 432
 433   if ( reads )
 434   {
 435     for ( k=i=0; reads[i]; i++ )
 436     {
 437       int fd = reads[i]->getHandle();
 438       if ( FD_ISSET (fd, &r) )
 439       {
 440         reads[k++] = reads[i];
 441         num++;
 442       }
 443     }
 444     reads[k] = NULL ;
 445   }
 446
 447   if ( writes )
 448   {
 449     for ( k=i=0; writes[i]; i++ )
 450     {
 451       int fd = writes[i]->getHandle();
 452       if ( FD_ISSET (fd, &w) )
 453       {
 454         writes[k++] = writes[i];
 455         num++;
 456       }
 457     }
 458     writes[k] = NULL ;
 459   }
 460
 461   if (retval == 0) // timeout
 462     return (-2);
 463   if (retval == -1)// error
 464     return (-1);
 465
 466   return num ;
 467 }
 468
 469
 470 /* Init/Exit functions */
 471
 472 static void netExit ( void )
 473 {
 474 #if defined(WINSOCK)
 475         /* Clean up windows networking */
 476         if ( WSACleanup() == SOCKET_ERROR ) {
 477                 if ( WSAGetLastError() == WSAEINPROGRESS ) {
 478                         WSACancelBlockingCall();
 479                         WSACleanup();
 480                 }
 481         }
 482 #endif
 483 }
 484
 485 int Socket::initSockets()
 486 {
 487   assert ( sizeof(sockaddr_in) == sizeof(IPAddress) ) ;
 488
 489 #if defined(WINSOCK)
 490         /* Start up the windows networking */
 491         WORD version_wanted = MAKEWORD(1,1);
 492         WSADATA wsaData;
 493
 494         if ( WSAStartup(version_wanted, &wsaData) != 0 ) {
 495                 throw sg_exception("WinSock initialization failed");
 496         }
 497 #endif
 498
 499   atexit( netExit ) ;
 500         return(0);
 501 }
 502
 503
 504 } // of namespace simgear
 505