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     setsockopt( handle, SOL_SOCKET, SO_REUSEADDR,
 203                 (char *)&opt_boolean, sizeof(opt_boolean) );
 204   }
 205
 206   return (handle != -1);
 207 }
 208
 209
 210 void Socket::setBlocking ( bool blocking )
 211 {
 212   assert ( handle != -1 ) ;
 213
 214 #if defined(WINSOCK)
 215     u_long nblocking = blocking? 0: 1;
 216   ::ioctlsocket(handle, FIONBIO, &nblocking);
 217 #else
 218
 219   int delay_flag = ::fcntl (handle, F_GETFL, 0);
 220
 221   if (blocking)
 222     delay_flag &= (~O_NDELAY);
 223   else
 224     delay_flag |= O_NDELAY;
 225
 226   ::fcntl (handle, F_SETFL, delay_flag);
 227 #endif
 228 }
 229
 230
 231 void Socket::setBroadcast ( bool broadcast )
 232 {
 233   assert ( handle != -1 ) ;
 234   int result;
 235   if ( broadcast ) {
 236       int one = 1;
 237 #if defined(_WIN32) || defined(__CYGWIN__)
 238       result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, (char*)&one, sizeof(one) );
 239 #else
 240       result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, &one, sizeof(one) );
 241 #endif
 242   } else {
 243       result = ::setsockopt( handle, SOL_SOCKET, SO_BROADCAST, NULL, 0 );
 244   }
 245
 246   if ( result < 0 ) {
 247       throw sg_exception("Socket::setBroadcast failed");
 248   }
 249 }
 250
 251
 252 int Socket::bind ( const char* host, int port )
 253 {
 254   assert ( handle != -1 ) ;
 255   IPAddress addr ( host, port ) ;
 256   return ::bind(handle,(const sockaddr*)&addr,sizeof(IPAddress));
 257 }
 258
 259
 260 int Socket::listen ( int backlog )
 261 {
 262   assert ( handle != -1 ) ;
 263   return ::listen(handle,backlog);
 264 }
 265
 266
 267 int Socket::accept ( IPAddress* addr )
 268 {
 269   assert ( handle != -1 ) ;
 270
 271   if ( addr == NULL )
 272   {
 273     return ::accept(handle,NULL,NULL);
 274   }
 275   else
 276   {
 277     socklen_t addr_len = (socklen_t) sizeof(IPAddress) ;
 278     return ::accept(handle,(sockaddr*)addr,&addr_len);
 279   }
 280 }
 281
 282
 283 int Socket::connect ( const char* host, int port )
 284 {
 285   assert ( handle != -1 ) ;
 286   IPAddress addr ( host, port ) ;
 287   if ( addr.getBroadcast() ) {
 288       setBroadcast( true );
 289   }
 290   return ::connect(handle,(const sockaddr*)&addr,sizeof(IPAddress));
 291 }
 292
 293
 294 int Socket::send (const void * buffer, int size, int flags)
 295 {
 296   assert ( handle != -1 ) ;
 297   return ::send (handle, (const char*)buffer, size, flags);
 298 }
 299
 300
 301 int Socket::sendto ( const void * buffer, int size,
 302                         int flags, const IPAddress* to )
 303 {
 304   assert ( handle != -1 ) ;
 305   return ::sendto(handle,(const char*)buffer,size,flags,
 306                          (const sockaddr*)to,sizeof(IPAddress));
 307 }
 308
 309
 310 int Socket::recv (void * buffer, int size, int flags)
 311 {
 312   assert ( handle != -1 ) ;
 313   return ::recv (handle, (char*)buffer, size, flags);
 314 }
 315
 316
 317 int Socket::recvfrom ( void * buffer, int size,
 318                           int flags, IPAddress* from )
 319 {
 320   assert ( handle != -1 ) ;
 321   socklen_t fromlen = (socklen_t) sizeof(IPAddress) ;
 322   return ::recvfrom(handle,(char*)buffer,size,flags,(sockaddr*)from,&fromlen);
 323 }
 324
 325
 326 void Socket::close (void)
 327 {
 328   if ( handle != -1 )
 329   {
 330 #if defined(WINSOCK)
 331     ::closesocket( handle );
 332 #else
 333     ::close( handle );
 334 #endif
 335     handle = -1 ;
 336   }
 337 }
 338
 339
 340 bool Socket::isNonBlockingError ()
 341 {
 342 #if defined(WINSOCK)
 343   int wsa_errno = WSAGetLastError();
 344   if ( wsa_errno != 0 )
 345   {
 346     WSASetLastError(0);
 347         SG_LOG(SG_IO, SG_WARN, "isNonBlockingError: WSAGetLastError():" << wsa_errno);
 348     switch (wsa_errno) {
 349     case WSAEWOULDBLOCK: // always == NET_EAGAIN?
 350     case WSAEALREADY:
 351     case WSAEINPROGRESS:
 352       return true;
 353     }
 354   }
 355   return false;
 356 #else
 357   switch (errno) {
 358   case EWOULDBLOCK: // always == NET_EAGAIN?
 359   case EALREADY:
 360   case EINPROGRESS:
 361     return true;
 362   }
 363   return false;
 364
 365 #endif
 366 }
 367
 368
 369 //////////////////////////////////////////////////////////////////////
 370 //
 371 //      modified version by os
 372 //
 373 //////////////////////////////////////////////////////////////////////
 374 int Socket::select ( Socket** reads, Socket** writes, int timeout )
 375 {
 376   fd_set r,w;
 377   int   retval;
 378
 379   FD_ZERO (&r);
 380   FD_ZERO (&w);
 381
 382   int i, k ;
 383   int num = 0 ;
 384
 385   if ( reads )
 386   {
 387     for ( i=0; reads[i]; i++ )
 388     {
 389       int fd = reads[i]->getHandle();
 390       FD_SET (fd, &r);
 391       num++;
 392     }
 393   }
 394
 395   if ( writes )
 396   {
 397     for ( i=0; writes[i]; i++ )
 398     {
 399       int fd = writes[i]->getHandle();
 400       FD_SET (fd, &w);
 401       num++;
 402     }
 403   }
 404
 405   if (!num)
 406     return num ;
 407
 408   /* Set up the timeout */
 409   struct timeval tv ;
 410   tv.tv_sec = timeout/1000;
 411   tv.tv_usec = (timeout%1000)*1000;
 412
 413   // It bothers me that select()'s first argument does not appear to
 414   // work as advertised... [it hangs like this if called with
 415   // anything less than FD_SETSIZE, which seems wasteful?]
 416
 417   // Note: we ignore the 'exception' fd_set - I have never had a
 418   // need to use it.  The name is somewhat misleading - the only
 419   // thing I have ever seen it used for is to detect urgent data -
 420   // which is an unportable feature anyway.
 421
 422   retval = ::select (FD_SETSIZE, &r, &w, 0, &tv);
 423
 424   //remove sockets that had no activity
 425
 426   num = 0 ;
 427
 428   if ( reads )
 429   {
 430     for ( k=i=0; reads[i]; i++ )
 431     {
 432       int fd = reads[i]->getHandle();
 433       if ( FD_ISSET (fd, &r) )
 434       {
 435         reads[k++] = reads[i];
 436         num++;
 437       }
 438     }
 439     reads[k] = NULL ;
 440   }
 441
 442   if ( writes )
 443   {
 444     for ( k=i=0; writes[i]; i++ )
 445     {
 446       int fd = writes[i]->getHandle();
 447       if ( FD_ISSET (fd, &w) )
 448       {
 449         writes[k++] = writes[i];
 450         num++;
 451       }
 452     }
 453     writes[k] = NULL ;
 454   }
 455
 456   if (retval == 0) // timeout
 457     return (-2);
 458   if (retval == -1)// error
 459     return (-1);
 460
 461   return num ;
 462 }
 463
 464
 465 /* Init/Exit functions */
 466
 467 static void netExit ( void )
 468 {
 469 #if defined(WINSOCK)
 470         /* Clean up windows networking */
 471         if ( WSACleanup() == SOCKET_ERROR ) {
 472                 if ( WSAGetLastError() == WSAEINPROGRESS ) {
 473                         WSACancelBlockingCall();
 474                         WSACleanup();
 475                 }
 476         }
 477 #endif
 478 }
 479
 480 int Socket::initSockets()
 481 {
 482   assert ( sizeof(sockaddr_in) == sizeof(IPAddress) ) ;
 483
 484 #if defined(WINSOCK)
 485         /* Start up the windows networking */
 486         WORD version_wanted = MAKEWORD(1,1);
 487         WSADATA wsaData;
 488
 489         if ( WSAStartup(version_wanted, &wsaData) != 0 ) {
 490                 throw sg_exception("WinSock initialization failed");
 491         }
 492 #endif
 493
 494   atexit( netExit ) ;
 495         return(0);
 496 }
 497
 498
 499 } // of namespace simgear
 500