src/gras/Transport/transport_plugin_tcp.c

   1 /* $Id$ */
   2
   3 /* tcp trp (transport) - send/receive a bunch of bytes from a tcp socket    */
   4
   5 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "portable.h"
  11 #include "xbt/ex.h"
  12 #if 0
  13 #  include <signal.h>       /* close() pipe() read() write() */
  14 #  include <sys/wait.h>     /* waitpid() */
  15 #endif
  16
  17
  18 #include "transport_private.h"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(trp_tcp,transport,"TCP transport");
  21
  22 /***
  23  *** Prototypes
  24  ***/
  25 void gras_trp_tcp_socket_client(gras_trp_plugin_t self, gras_socket_t sock);
  26 void gras_trp_tcp_socket_server(gras_trp_plugin_t self, gras_socket_t sock);
  27 gras_socket_t gras_trp_tcp_socket_accept(gras_socket_t  sock);
  28
  29 void          gras_trp_tcp_socket_close(gras_socket_t sd);
  30
  31 void gras_trp_tcp_chunk_send(gras_socket_t sd,
  32                              const char *data,
  33                              unsigned long int size);
  34
  35 void gras_trp_tcp_chunk_recv(gras_socket_t sd,
  36                              char *data,
  37                              unsigned long int size);
  38
  39 void gras_trp_tcp_exit(gras_trp_plugin_t plug);
  40
  41
  42 static int TcpProtoNumber(void);
  43 /***
  44  *** Specific plugin part
  45  ***/
  46
  47 typedef struct {
  48   fd_set msg_socks;
  49   fd_set meas_socks;
  50 } gras_trp_tcp_plug_data_t;
  51
  52 /***
  53  *** Specific socket part
  54  ***/
  55
  56 typedef struct {
  57   int buffsize;
  58 } gras_trp_tcp_sock_data_t;
  59
  60
  61 /***
  62  *** Code
  63  ***/
  64 void gras_trp_tcp_setup(gras_trp_plugin_t plug) {
  65
  66   gras_trp_tcp_plug_data_t *data = xbt_new(gras_trp_tcp_plug_data_t,1);
  67
  68   FD_ZERO(&(data->msg_socks));
  69   FD_ZERO(&(data->meas_socks));
  70
  71   plug->socket_client = gras_trp_tcp_socket_client;
  72   plug->socket_server = gras_trp_tcp_socket_server;
  73   plug->socket_accept = gras_trp_tcp_socket_accept;
  74   plug->socket_close  = gras_trp_tcp_socket_close;
  75
  76   plug->chunk_send    = gras_trp_tcp_chunk_send;
  77   plug->chunk_recv    = gras_trp_tcp_chunk_recv;
  78
  79   plug->flush = NULL; /* nothing's cached */
  80
  81   plug->data = (void*)data;
  82   plug->exit = gras_trp_tcp_exit;
  83 }
  84
  85 void gras_trp_tcp_exit(gras_trp_plugin_t plug) {
  86   DEBUG1("Exit plugin TCP (free %p)", plug->data);
  87   free(plug->data);
  88 }
  89
  90 void gras_trp_tcp_socket_client(gras_trp_plugin_t self, gras_socket_t sock){
  91
  92   struct sockaddr_in addr;
  93   struct hostent *he;
  94   struct in_addr *haddr;
  95   int size = sock->bufSize * 1024;
  96
  97   sock->incoming = 1; /* TCP sockets are duplex'ed */
  98
  99   sock->sd = socket (AF_INET, SOCK_STREAM, 0);
 100
 101   if (sock->sd < 0) {
 102     THROW1(system_error,0, "Failed to create socket: %s", sock_errstr);
 103   }
 104
 105   if (setsockopt(sock->sd, SOL_SOCKET, SO_RCVBUF, (char *)&size, sizeof(size)) ||
 106       setsockopt(sock->sd, SOL_SOCKET, SO_SNDBUF, (char *)&size, sizeof(size))) {
 107      WARN1("setsockopt failed, cannot set buffer size: %s",sock_errstr);
 108   }
 109
 110   he = gethostbyname (sock->peer_name);
 111   if (he == NULL) {
 112     THROW2(system_error,0, "Failed to lookup hostname %s: %s",
 113            sock->peer_name, sock_errstr);
 114   }
 115
 116   haddr = ((struct in_addr *) (he->h_addr_list)[0]);
 117
 118   memset(&addr, 0, sizeof(struct sockaddr_in));
 119   memcpy (&addr.sin_addr, haddr, sizeof(struct in_addr));
 120   addr.sin_family = AF_INET;
 121   addr.sin_port = htons (sock->peer_port);
 122
 123   if (connect (sock->sd, (struct sockaddr*) &addr, sizeof (addr)) < 0) {
 124     tcp_close(sock->sd);
 125     THROW3(system_error,0,
 126            "Failed to connect socket to %s:%d (%s)",
 127            sock->peer_name, sock->peer_port, sock_errstr);
 128   }
 129   VERB4("Connect to %s:%d (sd=%d, port %d here)",sock->peer_name, sock->peer_port, sock->sd, sock->port);
 130 }
 131
 132 /**
 133  * gras_trp_tcp_socket_server:
 134  *
 135  * Open a socket used to receive messages.
 136  */
 137 void gras_trp_tcp_socket_server(gras_trp_plugin_t self, gras_socket_t sock){
 138   int size = sock->bufSize * 1024;
 139   int on = 1;
 140   struct sockaddr_in server;
 141
 142   gras_trp_tcp_plug_data_t *tcp=(gras_trp_tcp_plug_data_t*)self->data;
 143
 144   sock->outgoing  = 1; /* TCP => duplex mode */
 145
 146   server.sin_port = htons((u_short)sock->port);
 147   server.sin_addr.s_addr = INADDR_ANY;
 148   server.sin_family = AF_INET;
 149   if((sock->sd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
 150     THROW1(system_error,0,"Socket allocation failed: %s", sock_errstr);
 151
 152   if (setsockopt(sock->sd, SOL_SOCKET, SO_REUSEADDR, (char *)&on, sizeof(on)))
 153      THROW1(system_error,0,"setsockopt failed, cannot condition the socket: %s",
 154             sock_errstr);
 155
 156   if (setsockopt(sock->sd, SOL_SOCKET, SO_RCVBUF, (char *)&size, sizeof(size)) ||
 157       setsockopt(sock->sd, SOL_SOCKET, SO_SNDBUF, (char *)&size, sizeof(size))) {
 158      WARN1("setsockopt failed, cannot set buffer size: %s",
 159            sock_errstr);
 160   }
 161
 162   if (bind(sock->sd, (struct sockaddr *)&server, sizeof(server)) == -1) {
 163     tcp_close(sock->sd);
 164     THROW2(system_error,0,"Cannot bind to port %d: %s",sock->port, sock_errstr);
 165   }
 166
 167   DEBUG2("Listen on port %d (sd=%d)",sock->port, sock->sd);
 168   if (listen(sock->sd, 5) < 0) {
 169     tcp_close(sock->sd);
 170     THROW2(system_error,0,"Cannot listen on port %d: %s",sock->port,sock_errstr);
 171   }
 172
 173   if (sock->meas)
 174     FD_SET(sock->sd, &(tcp->meas_socks));
 175   else
 176     FD_SET(sock->sd, &(tcp->msg_socks));
 177
 178   VERB2("Openned a server socket on port %d (sd=%d)",sock->port,sock->sd);
 179 }
 180
 181 gras_socket_t gras_trp_tcp_socket_accept(gras_socket_t  sock) {
 182   gras_socket_t res;
 183
 184   struct sockaddr_in peer_in;
 185   socklen_t peer_in_len = sizeof(peer_in);
 186
 187   int sd;
 188   int tmp_errno;
 189   int size;
 190
 191   int i = 1;
 192   socklen_t s = sizeof(int);
 193
 194   XBT_IN;
 195   gras_trp_socket_new(1,&res);
 196
 197   sd = accept(sock->sd, (struct sockaddr *)&peer_in, &peer_in_len);
 198   tmp_errno = errno;
 199
 200   if (sd == -1) {
 201     gras_socket_close(sock);
 202     THROW1(system_error,0,
 203            "Accept failed (%s). Droping server socket.", sock_errstr);
 204   }
 205
 206   if (setsockopt(sd, SOL_SOCKET, SO_KEEPALIVE, (char *)&i, s)
 207       || setsockopt(sd, TcpProtoNumber(), TCP_NODELAY, (char *)&i, s))
 208     THROW1(system_error,0,"setsockopt failed, cannot condition the socket: %s",
 209            sock_errstr);
 210
 211   res->bufSize = sock->bufSize;
 212   size = sock->bufSize * 1024;
 213   if (setsockopt(sd, SOL_SOCKET, SO_RCVBUF, (char *)&size, sizeof(size))
 214       || setsockopt(sd, SOL_SOCKET, SO_SNDBUF, (char *)&size, sizeof(size)))
 215     WARN1("setsockopt failed, cannot set buffer size: %s", sock_errstr);
 216
 217   res->plugin    = sock->plugin;
 218   res->incoming  = sock->incoming;
 219   res->outgoing  = sock->outgoing;
 220   res->accepting = 0;
 221   res->sd        = sd;
 222   res->port      = -1;
 223   res->peer_port = peer_in.sin_port;
 224
 225   /* FIXME: Lock to protect inet_ntoa */
 226   if (((struct sockaddr *)&peer_in)->sa_family != AF_INET) {
 227     res->peer_name = (char*)strdup("unknown");
 228   } else {
 229     struct in_addr addrAsInAddr;
 230     char *tmp;
 231
 232     addrAsInAddr.s_addr = peer_in.sin_addr.s_addr;
 233
 234     tmp = inet_ntoa(addrAsInAddr);
 235     if (tmp != NULL) {
 236       res->peer_name = (char*)strdup(tmp);
 237     } else {
 238       res->peer_name = (char*)strdup("unknown");
 239     }
 240   }
 241
 242   VERB3("Accepted from %s:%d (sd=%d)", res->peer_name,res->peer_port,sd);
 243
 244   XBT_OUT;
 245   return res;
 246 }
 247
 248 void gras_trp_tcp_socket_close(gras_socket_t sock){
 249   gras_trp_tcp_plug_data_t *tcp;
 250
 251   if (!sock) return; /* close only once */
 252   tcp=sock->plugin->data;
 253
 254   VERB1("close tcp connection %d", sock->sd);
 255
 256   /* FIXME: no pipe in GRAS so far
 257   if(!FD_ISSET(sd, &connectedPipes)) {
 258     if(shutdown(sd, 2) < 0) {
 259       GetNWSLock(&lock);
 260       tmp_errno = errno;
 261       ReleaseNWSLock(&lock);
 262
 263       / * The other side may have beaten us to the reset. * /
 264       if ((tmp_errno!=ENOTCONN) && (tmp_errno!=ECONNRESET)) {
 265         WARN1("CloseSocket: shutdown error %d\n", tmp_errno);
 266       }
 267     }
 268   } */
 269
 270 #ifndef HAVE_WINSOCK_H
 271   /* forget about the socket
 272      ... but not when using winsock since accept'ed socket can not fit
 273      into the fd_set*/
 274   if (sock->meas){
 275     FD_CLR(sock->sd, &(tcp->meas_socks));
 276   } else {
 277     FD_CLR(sock->sd, &(tcp->msg_socks));
 278   }
 279 #endif
 280
 281   /* close the socket */
 282   if(tcp_close(sock->sd) < 0) {
 283     WARN3("error while closing tcp socket %d: %d (%s)\n",
 284              sock->sd, sock_errno, sock_errstr);
 285   }
 286
 287 }
 288
 289 /**
 290  * gras_trp_tcp_chunk_send:
 291  *
 292  * Send data on a TCP socket
 293  */
 294 void
 295 gras_trp_tcp_chunk_send(gras_socket_t sock,
 296                         const char *data,
 297                         unsigned long int size) {
 298
 299   /* TCP sockets are in duplex mode, don't check direction */
 300   xbt_assert0(size >= 0, "Cannot send a negative amount of data");
 301
 302   while (size) {
 303     int status = 0;
 304
 305     status = tcp_write(sock->sd, data, (size_t)size);
 306     DEBUG3("write(%d, %p, %ld);", sock->sd, data, size);
 307
 308     if (status < 0) {
 309       THROW4(system_error,0,"write(%d,%p,%ld) failed: %s",
 310              sock->sd, data, size,
 311              sock_errstr);
 312     }
 313
 314     if (status) {
 315       size  -= status;
 316       data  += status;
 317     } else {
 318       THROW1(system_error,0,"file descriptor closed (%s)",
 319              sock_errstr);
 320     }
 321   }
 322 }
 323 /**
 324  * gras_trp_tcp_chunk_recv:
 325  *
 326  * Receive data on a TCP socket.
 327  */
 328 void
 329 gras_trp_tcp_chunk_recv(gras_socket_t sock,
 330                         char *data,
 331                         unsigned long int size) {
 332
 333   /* TCP sockets are in duplex mode, don't check direction */
 334   xbt_assert0(sock, "Cannot recv on an NULL socket");
 335   xbt_assert0(size >= 0, "Cannot receive a negative amount of data");
 336
 337   while (size) {
 338     int status = 0;
 339
 340     DEBUG3("read(%d, %p, %ld);", sock->sd, data, size);
 341     status = tcp_read(sock->sd, data, (size_t)size);
 342
 343     if (status < 0) {
 344       THROW4(system_error,0,"read(%d,%p,%d) failed: %s",
 345              sock->sd, data, (int)size,
 346              sock_errstr);
 347     }
 348
 349     if (status) {
 350       size  -= status;
 351       data  += status;
 352     } else {
 353       THROW3(system_error,0,
 354              "file descriptor closed (nothing read(%d, %p, %ld) on the socket)",
 355              sock->sd, data, size);
 356     }
 357   }
 358 }
 359
 360
 361 /*
 362  * Returns the tcp protocol number from the network protocol data base.
 363  *
 364  * getprotobyname() is not thread safe. We need to lock it.
 365  */
 366 static int TcpProtoNumber(void) {
 367   struct protoent *fetchedEntry;
 368   static int returnValue = 0;
 369
 370   if(returnValue == 0) {
 371     fetchedEntry = getprotobyname("tcp");
 372     xbt_assert0(fetchedEntry, "getprotobyname(tcp) gave NULL");
 373     returnValue = fetchedEntry->p_proto;
 374   }
 375
 376   return returnValue;
 377 }
 378
 379 #ifdef HAVE_WINSOCK_H
 380 #define RETSTR( x ) case x: return #x
 381
 382 const char *gras_wsa_err2string( int err ) {
 383    switch( err ) {
 384       RETSTR( WSAEINTR );
 385       RETSTR( WSAEBADF );
 386       RETSTR( WSAEACCES );
 387       RETSTR( WSAEFAULT );
 388       RETSTR( WSAEINVAL );
 389       RETSTR( WSAEMFILE );
 390       RETSTR( WSAEWOULDBLOCK );
 391       RETSTR( WSAEINPROGRESS );
 392       RETSTR( WSAEALREADY );
 393       RETSTR( WSAENOTSOCK );
 394       RETSTR( WSAEDESTADDRREQ );
 395       RETSTR( WSAEMSGSIZE );
 396       RETSTR( WSAEPROTOTYPE );
 397       RETSTR( WSAENOPROTOOPT );
 398       RETSTR( WSAEPROTONOSUPPORT );
 399       RETSTR( WSAESOCKTNOSUPPORT );
 400       RETSTR( WSAEOPNOTSUPP );
 401       RETSTR( WSAEPFNOSUPPORT );
 402       RETSTR( WSAEAFNOSUPPORT );
 403       RETSTR( WSAEADDRINUSE );
 404       RETSTR( WSAEADDRNOTAVAIL );
 405       RETSTR( WSAENETDOWN );
 406       RETSTR( WSAENETUNREACH );
 407       RETSTR( WSAENETRESET );
 408       RETSTR( WSAECONNABORTED );
 409       RETSTR( WSAECONNRESET );
 410       RETSTR( WSAENOBUFS );
 411       RETSTR( WSAEISCONN );
 412       RETSTR( WSAENOTCONN );
 413       RETSTR( WSAESHUTDOWN );
 414       RETSTR( WSAETOOMANYREFS );
 415       RETSTR( WSAETIMEDOUT );
 416       RETSTR( WSAECONNREFUSED );
 417       RETSTR( WSAELOOP );
 418       RETSTR( WSAENAMETOOLONG );
 419       RETSTR( WSAEHOSTDOWN );
 420       RETSTR( WSAEHOSTUNREACH );
 421       RETSTR( WSAENOTEMPTY );
 422       RETSTR( WSAEPROCLIM );
 423       RETSTR( WSAEUSERS );
 424       RETSTR( WSAEDQUOT );
 425       RETSTR( WSAESTALE );
 426       RETSTR( WSAEREMOTE );
 427       RETSTR( WSASYSNOTREADY );
 428       RETSTR( WSAVERNOTSUPPORTED );
 429       RETSTR( WSANOTINITIALISED );
 430       RETSTR( WSAEDISCON );
 431
 432 #ifdef HAVE_WINSOCK2
 433       RETSTR( WSAENOMORE );
 434       RETSTR( WSAECANCELLED );
 435       RETSTR( WSAEINVALIDPROCTABLE );
 436       RETSTR( WSAEINVALIDPROVIDER );
 437       RETSTR( WSASYSCALLFAILURE );
 438       RETSTR( WSASERVICE_NOT_FOUND );
 439       RETSTR( WSATYPE_NOT_FOUND );
 440       RETSTR( WSA_E_NO_MORE );
 441       RETSTR( WSA_E_CANCELLED );
 442       RETSTR( WSAEREFUSED );
 443 #endif /* HAVE_WINSOCK2 */
 444
 445       RETSTR( WSAHOST_NOT_FOUND );
 446       RETSTR( WSATRY_AGAIN );
 447       RETSTR( WSANO_RECOVERY );
 448       RETSTR( WSANO_DATA );
 449    }
 450    return "unknown WSA error";
 451 }
 452 #endif /* HAVE_WINSOCK_H */