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 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2004 Martin Quinson.                                       */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9    under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #include <unistd.h>       /* close() pipe() read() write() */
  12 #include <signal.h>       /* close() pipe() read() write() */
  13 #include <netinet/in.h>   /* sometimes required for #include <arpa/inet.h> */
  14 #include <netinet/tcp.h>  /* TCP_NODELAY */
  15 #include <arpa/inet.h>    /* inet_ntoa() */
  16 #include <netdb.h>        /* getprotobyname() */
  17 #include <sys/time.h>     /* struct timeval */
  18 #include <errno.h>        /* errno */
  19 #include <sys/wait.h>     /* waitpid() */
  20 #include <sys/socket.h>   /* getpeername() socket() */
  21 #include <stdlib.h>
  22 #include <string.h>       /* memset */
  23
  24 #include "gras_private.h"
  25 #include "transport_private.h"
  26
  27 GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(trp_tcp,transport);
  28
  29 typedef struct {
  30   int buffsize;
  31 } gras_trp_tcp_sock_specific_t;
  32
  33 /***
  34  *** Prototypes
  35  ***/
  36 gras_error_t gras_trp_tcp_socket_client(gras_trp_plugin_t *self,
  37                                         const char *host,
  38                                         unsigned short port,
  39                                         /* OUT */ gras_socket_t *sock);
  40 gras_error_t gras_trp_tcp_socket_server(gras_trp_plugin_t *self,
  41                                         unsigned short port,
  42                                         /* OUT */ gras_socket_t *sock);
  43 gras_error_t gras_trp_tcp_socket_accept(gras_socket_t  *sock,
  44                                         gras_socket_t **dst);
  45
  46 void         gras_trp_tcp_socket_close(gras_socket_t *sd);
  47
  48 gras_error_t gras_trp_tcp_chunk_send(gras_socket_t *sd,
  49                                      char *data,
  50                                      size_t size);
  51
  52 gras_error_t gras_trp_tcp_chunk_recv(gras_socket_t *sd,
  53                                      char *data,
  54                                      size_t size);
  55
  56 void         gras_trp_tcp_free_specific(void *s);
  57
  58
  59 static int TcpProtoNumber(void);
  60 /***
  61  *** Specific plugin part
  62  ***/
  63
  64 typedef struct {
  65   fd_set incoming_socks;
  66 } gras_trp_tcp_specific_t;
  67
  68 /***
  69  *** Specific socket part
  70  ***/
  71
  72
  73 /***
  74  *** Code
  75  ***/
  76 gras_error_t
  77 gras_trp_tcp_init(gras_trp_plugin_t **dst) {
  78
  79   gras_trp_plugin_t *res=malloc(sizeof(gras_trp_plugin_t));
  80   gras_trp_tcp_specific_t *tcp = malloc(sizeof(gras_trp_tcp_specific_t));
  81   if (!res || !tcp)
  82     RAISE_MALLOC;
  83
  84   FD_ZERO(&(tcp->incoming_socks));
  85
  86   res->name = strdup("TCP");
  87   res->socket_client = gras_trp_tcp_socket_client;
  88   res->socket_server = gras_trp_tcp_socket_server;
  89   res->socket_accept = gras_trp_tcp_socket_accept;
  90   res->socket_close  = gras_trp_tcp_socket_close;
  91
  92   res->chunk_send    = gras_trp_tcp_chunk_send;
  93   res->chunk_recv    = gras_trp_tcp_chunk_recv;
  94
  95   res->specific      = (void*)tcp;
  96   res->free_specific = gras_trp_tcp_free_specific;
  97
  98   *dst = res;
  99   return no_error;
 100 }
 101
 102 void gras_trp_tcp_free_specific(void *s) {
 103   gras_trp_tcp_specific_t *specific = s;
 104   free(specific);
 105 }
 106
 107 gras_error_t gras_trp_tcp_socket_client(gras_trp_plugin_t *self,
 108                                         const char *host,
 109                                         unsigned short port,
 110                                         /* OUT */ gras_socket_t *sock){
 111
 112   struct sockaddr_in addr;
 113   struct hostent *he;
 114   struct in_addr *haddr;
 115
 116   sock->incoming = 1; /* TCP sockets are duplex'ed */
 117
 118   sock->sd = socket (AF_INET, SOCK_STREAM, 0);
 119
 120   if (sock->sd < 0) {
 121     RAISE1(system_error,
 122            "Failed to create socket: %s",
 123            strerror (errno));
 124   }
 125
 126   he = gethostbyname (host);
 127   if (he == NULL) {
 128     RAISE2(system_error,
 129            "Failed to lookup hostname %s: %s",
 130            host, strerror (errno));
 131   }
 132
 133   haddr = ((struct in_addr *) (he->h_addr_list)[0]);
 134
 135   memset(&addr, 0, sizeof(struct sockaddr_in));
 136   memcpy (&addr.sin_addr, haddr, sizeof(struct in_addr));
 137   addr.sin_family = AF_INET;
 138   addr.sin_port = htons (port);
 139
 140   if (connect (sock->sd, (struct sockaddr*) &addr, sizeof (addr)) < 0) {
 141     close(sock->sd);
 142     RAISE3(system_error,
 143            "Failed to connect socket to %s:%d (%s)",
 144            host, port, strerror (errno));
 145   }
 146
 147   return no_error;
 148 }
 149
 150 /**
 151  * gras_trp_tcp_socket_server:
 152  *
 153  * Open a socket used to receive messages.
 154  */
 155 gras_error_t gras_trp_tcp_socket_server(gras_trp_plugin_t *self,
 156                                         unsigned short port,
 157                                         /* OUT */ gras_socket_t *sock){
 158 //  int size = bufSize * 1024;
 159   int on = 1;
 160   struct sockaddr_in server;
 161
 162   gras_trp_tcp_specific_t *data=(gras_trp_tcp_specific_t*)self -> specific;
 163
 164   sock->outgoing  = 1; /* TCP => duplex mode */
 165
 166   server.sin_port = htons((u_short)port);
 167   server.sin_addr.s_addr = INADDR_ANY;
 168   server.sin_family = AF_INET;
 169   if((sock->sd = socket(AF_INET, SOCK_STREAM, 0)) < 0) {
 170     RAISE1(system_error,"socket allocation failed: %s", strerror(errno));
 171   }
 172
 173   (void)setsockopt(sock->sd, SOL_SOCKET, SO_REUSEADDR,
 174                    (char *)&on, sizeof(on));
 175    /*
 176   (void)setsockopt(sd, SOL_SOCKET, SO_RCVBUF, (char *)&size, sizeof(size));
 177   (void)setsockopt(sd, SOL_SOCKET, SO_SNDBUF, (char *)&size, sizeof(size));
 178     */
 179   if (bind(sock->sd, (struct sockaddr *)&server, sizeof(server)) == -1) {
 180     close(sock->sd);
 181     RAISE2(system_error,"Cannot bind to port %d: %s",port, strerror(errno));
 182   }
 183
 184   if (listen(sock->sd, 5) < 0) {
 185     close(sock->sd);
 186     RAISE2(system_error,"Cannot listen to port %d: %s",port,strerror(errno));
 187   }
 188
 189   FD_SET(sock->sd, &(data->incoming_socks));
 190
 191   DEBUG2("Openned a server socket on port %d (sock %d)",port,sock->sd);
 192
 193   return no_error;
 194 }
 195
 196 gras_error_t
 197 gras_trp_tcp_socket_accept(gras_socket_t  *sock,
 198                            gras_socket_t **dst) {
 199   gras_socket_t *res;
 200
 201   struct sockaddr_in peer_in;
 202   socklen_t peer_in_len = sizeof(peer_in);
 203
 204   int sd;
 205   int tmp_errno;
 206
 207   res=malloc(sizeof(gras_socket_t));
 208   if (!res)
 209     RAISE_MALLOC;
 210
 211   sd = accept(sock->sd, (struct sockaddr *)&peer_in, &peer_in_len);
 212   tmp_errno = errno;
 213
 214   if(sd == -1) {
 215     gras_socket_close(&sock);
 216     RAISE1(system_error,
 217            "Accept failed (%s). Droping server socket.", strerror(tmp_errno));
 218   } else {
 219     int i = 1;
 220     socklen_t s = sizeof(int);
 221
 222     if (setsockopt(sd, SOL_SOCKET, SO_KEEPALIVE, (char *)&i, s)
 223         || setsockopt(sd, TcpProtoNumber(), TCP_NODELAY, (char *)&i, s)) {
 224       WARNING0("setsockopt failed, cannot condition the accepted socket");
 225     }
 226
 227      /* FIXME: bufSize removed until we can have optionsets
 228     i = ((gras_trp_tcp_sock_specific_t*)sock->specific)->buffsize;
 229     if (setsockopt(sd, SOL_SOCKET, SO_RCVBUF, (char *)&i, s)
 230         || setsockopt(sd, SOL_SOCKET, SO_SNDBUF, (char *)&i, s)) {
 231       WARNING0("setsockopt failed, cannot set buffsize");
 232     }
 233       */
 234
 235     res->plugin    = sock->plugin;
 236     res->incoming  = sock->incoming;
 237     res->outgoing  = sock->outgoing;
 238     res->accepting = 0;
 239     res->sd        = sd;
 240     res->port      = -1;
 241     res->peer_port = peer_in.sin_port;
 242
 243     /* FIXME: Lock to protect inet_ntoa */
 244     if (((struct sockaddr *)&peer_in)->sa_family != AF_INET) {
 245       res->peer_name = strdup("unknown");
 246     } else {
 247       struct in_addr addrAsInAddr;
 248       char *tmp;
 249
 250       addrAsInAddr.s_addr = peer_in.sin_addr.s_addr;
 251
 252       tmp = inet_ntoa(addrAsInAddr);
 253       if (tmp != NULL) {
 254         res->peer_name = strdup(tmp);
 255       } else {
 256         res->peer_name = strdup("unknown");
 257       }
 258     }
 259
 260     VERB3("accepted socket %d to %s:%d\n", sd, res->peer_name,res->peer_port);
 261
 262     *dst = res;
 263
 264     return no_error;
 265   }
 266 }
 267
 268 void gras_trp_tcp_socket_close(gras_socket_t *sock){
 269   gras_trp_tcp_specific_t *tcp;
 270
 271   if (!sock) return; /* close only once */
 272   tcp=sock->plugin->specific;
 273
 274   DEBUG1("close tcp connection %d\n", sock->sd);
 275
 276   /* FIXME: no pipe in GRAS so far
 277   if(!FD_ISSET(sd, &connectedPipes)) {
 278     if(shutdown(sd, 2) < 0) {
 279       GetNWSLock(&lock);
 280       tmp_errno = errno;
 281       ReleaseNWSLock(&lock);
 282
 283       / * The other side may have beaten us to the reset. * /
 284       if ((tmp_errno!=ENOTCONN) && (tmp_errno!=ECONNRESET)) {
 285         WARN1("CloseSocket: shutdown error %d\n", tmp_errno);
 286       }
 287     }
 288   } */
 289
 290   /* forget about the socket */
 291   FD_CLR(sock->sd, &(tcp->incoming_socks));
 292
 293   /* close the socket */
 294   if(close(sock->sd) < 0) {
 295     WARNING3("error while closing tcp socket %d: %d (%s)\n",
 296              sock->sd, errno, strerror(errno));
 297   }
 298 }
 299
 300 /**
 301  * gras_trp_tcp_chunk_send:
 302  *
 303  * Send data on a TCP socket
 304  */
 305 gras_error_t
 306 gras_trp_tcp_chunk_send(gras_socket_t *sock,
 307                     char *data,
 308                     size_t size) {
 309
 310   /* TCP sockets are in duplex mode, don't check direction */
 311   gras_assert0(size >= 0, "Cannot send a negative amount of data");
 312
 313   while (size) {
 314     int status = 0;
 315
 316     status = write(sock->sd, data, (size_t)size);
 317     DEBUG3("write(%d, %p, %ld);\n", sock->sd, data, size);
 318
 319     if (status == -1) {
 320       RAISE4(system_error,"write(%d,%p,%d) failed: %s",
 321              sock->sd, data, (int)size,
 322              strerror(errno));
 323     }
 324
 325     if (status) {
 326       size  -= status;
 327       data  += status;
 328     } else {
 329       RAISE0(system_error,"file descriptor closed");
 330     }
 331   }
 332
 333   return no_error;
 334 }
 335 /**
 336  * gras_trp_tcp_chunk_recv:
 337  *
 338  * Receive data on a TCP socket.
 339  */
 340 gras_error_t
 341 gras_trp_tcp_chunk_recv(gras_socket_t *sock,
 342                         char *data,
 343                         size_t size) {
 344
 345   /* TCP sockets are in duplex mode, don't check direction */
 346   gras_assert0(sock, "Cannot recv on an NULL socket");
 347   gras_assert0(size >= 0, "Cannot receive a negative amount of data");
 348
 349   while (size) {
 350     int status = 0;
 351
 352     status = read(sock->sd, data, (size_t)size);
 353     DEBUG3("read(%d, %p, %ld);\n", sock->sd, data, size);
 354
 355     if (status == -1) {
 356       RAISE4(system_error,"read(%d,%p,%d) failed: %s",
 357              sock->sd, data, (int)size,
 358              strerror(errno));
 359     }
 360
 361     if (status) {
 362       size  -= status;
 363       data  += status;
 364     } else {
 365       RAISE0(system_error,"file descriptor closed");
 366     }
 367   }
 368
 369   return no_error;
 370 }
 371
 372
 373 /*
 374  * Returns the tcp protocol number from the network protocol data base.
 375  *
 376  * getprotobyname() is not thread safe. We need to lock it.
 377  */
 378 static int TcpProtoNumber(void) {
 379   struct protoent *fetchedEntry;
 380   static int returnValue = 0;
 381
 382   if(returnValue == 0) {
 383     fetchedEntry = getprotobyname("tcp");
 384     gras_assert0(fetchedEntry, "getprotobyname(tcp) gave NULL");
 385     returnValue = fetchedEntry->p_proto;
 386   }
 387
 388   return returnValue;
 389 }