src/gras/Transport/transport.c

   1 /* $Id$ */
   2
   3 /* transport - low level communication                                      */
   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 "xbt/ex.h"
  11 #include "portable.h"
  12 #include "gras/Transport/transport_private.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(transport,gras,"Conveying bytes over the network");
  15 XBT_LOG_NEW_SUBCATEGORY(trp_meas,transport,"Conveying bytes over the network without formating for perf measurements");
  16 static short int _gras_trp_started = 0;
  17
  18 static xbt_dict_t _gras_trp_plugins;      /* All registered plugins */
  19 static void gras_trp_plugin_free(void *p); /* free one of the plugins */
  20
  21 static void
  22 gras_trp_plugin_new(const char *name, gras_trp_setup_t setup) {
  23   xbt_ex_t e;
  24
  25   gras_trp_plugin_t plug = xbt_new0(s_gras_trp_plugin_t, 1);
  26
  27   DEBUG1("Create plugin %s",name);
  28
  29   plug->name=xbt_strdup(name);
  30
  31   TRY {
  32     setup(plug);
  33   } CATCH(e) {
  34     if (e.category == mismatch_error) {
  35       /* SG plugin raise mismatch when in RL mode (and vice versa) */
  36       free(plug->name);
  37       free(plug);
  38       plug=NULL;
  39       xbt_ex_free(e);
  40     } else {
  41       RETHROW;
  42     }
  43   }
  44
  45   if (plug)
  46     xbt_dict_set(_gras_trp_plugins, name, plug, gras_trp_plugin_free);
  47 }
  48
  49 void gras_trp_init(void){
  50   if (!_gras_trp_started) {
  51      /* make room for all plugins */
  52      _gras_trp_plugins=xbt_dict_new();
  53
  54 #ifdef HAVE_WINSOCK2_H
  55      /* initialize the windows mechanism */
  56      {
  57         WORD wVersionRequested;
  58         WSADATA wsaData;
  59
  60         wVersionRequested = MAKEWORD( 2, 0 );
  61         xbt_assert0(WSAStartup( wVersionRequested, &wsaData ) == 0,
  62                     "Cannot find a usable WinSock DLL");
  63
  64         /* Confirm that the WinSock DLL supports 2.0.*/
  65         /* Note that if the DLL supports versions greater    */
  66         /* than 2.0 in addition to 2.0, it will still return */
  67         /* 2.0 in wVersion since that is the version we      */
  68         /* requested.                                        */
  69
  70         xbt_assert0(LOBYTE( wsaData.wVersion ) == 2 &&
  71                     HIBYTE( wsaData.wVersion ) == 0,
  72                     "Cannot find a usable WinSock DLL");
  73         INFO0("Found and initialized winsock2");
  74      }       /* The WinSock DLL is acceptable. Proceed. */
  75 #elif HAVE_WINSOCK_H
  76      {       WSADATA wsaData;
  77         xbt_assert0(WSAStartup( 0x0101, &wsaData ) == 0,
  78                     "Cannot find a usable WinSock DLL");
  79         INFO0("Found and initialized winsock");
  80      }
  81 #endif
  82
  83      /* Add plugins */
  84      gras_trp_plugin_new("file",gras_trp_file_setup);
  85      gras_trp_plugin_new("sg",gras_trp_sg_setup);
  86      gras_trp_plugin_new("tcp", gras_trp_tcp_setup);
  87   }
  88
  89   _gras_trp_started++;
  90 }
  91
  92 void
  93 gras_trp_exit(void){
  94   xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
  95   gras_socket_t sock_iter;
  96   int cursor;
  97
  98    if (_gras_trp_started == 0) {
  99       return;
 100    }
 101
 102    if ( --_gras_trp_started == 0 ) {
 103 #ifdef HAVE_WINSOCK_H
 104       if ( WSACleanup() == SOCKET_ERROR ) {
 105          if ( WSAGetLastError() == WSAEINPROGRESS ) {
 106             WSACancelBlockingCall();
 107             WSACleanup();
 108          }
 109         }
 110 #endif
 111
 112       /* Close all the sockets */
 113       xbt_dynar_foreach(sockets,cursor,sock_iter) {
 114         VERB1("Closing the socket %p left open on exit. Maybe a socket leak?",
 115               sock_iter);
 116         gras_socket_close(sock_iter);
 117       }
 118
 119       /* Delete the plugins */
 120       xbt_dict_free(&_gras_trp_plugins);
 121    }
 122 }
 123
 124
 125 void gras_trp_plugin_free(void *p) {
 126   gras_trp_plugin_t plug = p;
 127
 128   if (plug) {
 129     if (plug->exit) {
 130       plug->exit(plug);
 131     } else if (plug->data) {
 132       DEBUG1("Plugin %s lacks exit(). Free data anyway.",plug->name);
 133       free(plug->data);
 134     }
 135
 136     free(plug->name);
 137     free(plug);
 138   }
 139 }
 140
 141
 142 /**
 143  * gras_trp_socket_new:
 144  *
 145  * Malloc a new socket, and initialize it with defaults
 146  */
 147 void gras_trp_socket_new(int incoming,
 148                          gras_socket_t *dst) {
 149
 150   gras_socket_t sock=xbt_new0(s_gras_socket_t,1);
 151
 152   DEBUG1("Create a new socket (%p)", (void*)sock);
 153
 154   sock->plugin = NULL;
 155
 156   sock->incoming  = incoming ? 1:0;
 157   sock->outgoing  = incoming ? 0:1;
 158   sock->accepting = incoming ? 1:0;
 159   sock->meas = 0;
 160
 161   sock->sd     = -1;
 162   sock->port      = -1;
 163   sock->peer_port = -1;
 164   sock->peer_name = NULL;
 165
 166   sock->data   = NULL;
 167   sock->bufdata = NULL;
 168
 169   *dst = sock;
 170
 171   xbt_dynar_push(((gras_trp_procdata_t)
 172                      gras_libdata_by_id(gras_trp_libdata_id))->sockets,dst);
 173   XBT_OUT;
 174 }
 175
 176
 177 /**
 178  * @brief Opens a server socket and makes it ready to be listened to.
 179  * @param port: port on which you want to listen
 180  * @param buf_size: size of the buffer (in byte) on the socket (for TCP sockets only). If 0, a sain default is used (32k, but may change)
 181  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
 182  *
 183  * In real life, you'll get a TCP socket.
 184  */
 185 gras_socket_t
 186 gras_socket_server_ext(unsigned short port,
 187
 188                        unsigned long int buf_size,
 189                        int measurement) {
 190
 191   xbt_ex_t e;
 192   gras_trp_plugin_t trp;
 193   gras_socket_t sock;
 194
 195   DEBUG2("Create a server socket from plugin %s on port %d",
 196          gras_if_RL() ? "tcp" : "sg",
 197          port);
 198   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
 199
 200   /* defaults settings */
 201   gras_trp_socket_new(1,&sock);
 202   sock->plugin= trp;
 203   sock->port=port;
 204   sock->buf_size = buf_size>0 ? buf_size : 32*1024;
 205   sock->meas = measurement;
 206
 207   /* Call plugin socket creation function */
 208   DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
 209   TRY {
 210     trp->socket_server(trp, sock);
 211     DEBUG3("in=%c out=%c accept=%c",
 212            sock->incoming?'y':'n',
 213            sock->outgoing?'y':'n',
 214            sock->accepting?'y':'n');
 215   } CATCH(e) {
 216     free(sock);
 217     RETHROW;
 218   }
 219
 220   return sock;
 221 }
 222
 223 /**
 224  * @brief Opens a client socket to a remote host.
 225  * @param host: who you want to connect to
 226  * @param port: where you want to connect to on this host
 227  * @param buf_size: size of the buffer (in bytes) on the socket (for TCP sockets only). If 0, a sain default is used (32k, but may change)
 228  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
 229  *
 230  * In real life, you'll get a TCP socket.
 231  */
 232 gras_socket_t
 233 gras_socket_client_ext(const char *host,
 234                        unsigned short port,
 235
 236                        unsigned long int buf_size,
 237                        int measurement) {
 238
 239   xbt_ex_t e;
 240   gras_trp_plugin_t trp;
 241   gras_socket_t sock;
 242
 243   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
 244
 245   DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
 246   /* defaults settings */
 247   gras_trp_socket_new(0,&sock);
 248   sock->plugin= trp;
 249   sock->peer_port = port;
 250   sock->peer_name = (char*)strdup(host?host:"localhost");
 251   sock->buf_size = buf_size>0 ? buf_size: 32*1024;
 252   sock->meas = measurement;
 253
 254   /* plugin-specific */
 255   TRY {
 256     (*trp->socket_client)(trp, sock);
 257     DEBUG3("in=%c out=%c accept=%c",
 258            sock->incoming?'y':'n',
 259            sock->outgoing?'y':'n',
 260            sock->accepting?'y':'n');
 261   } CATCH(e) {
 262     free(sock);
 263     RETHROW;
 264   }
 265
 266   return sock;
 267 }
 268
 269 /**
 270  * gras_socket_server:
 271  *
 272  * Opens a server socket and make it ready to be listened to.
 273  * In real life, you'll get a TCP socket.
 274  */
 275 gras_socket_t
 276 gras_socket_server(unsigned short port) {
 277    return gras_socket_server_ext(port,32,0);
 278 }
 279
 280 /**
 281  * gras_socket_client:
 282  *
 283  * Opens a client socket to a remote host.
 284  * In real life, you'll get a TCP socket.
 285  */
 286 gras_socket_t
 287 gras_socket_client(const char *host,
 288                    unsigned short port) {
 289    return gras_socket_client_ext(host,port,32,0);
 290 }
 291
 292
 293 void gras_socket_close(gras_socket_t sock) {
 294   xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
 295   gras_socket_t sock_iter;
 296   int cursor;
 297
 298   XBT_IN;
 299   /* FIXME: Issue an event when the socket is closed */
 300   if (sock) {
 301     xbt_dynar_foreach(sockets,cursor,sock_iter) {
 302       if (sock == sock_iter) {
 303         xbt_dynar_cursor_rm(sockets,&cursor);
 304         if (sock->plugin->socket_close)
 305           (* sock->plugin->socket_close)(sock);
 306
 307         /* free the memory */
 308         if (sock->peer_name)
 309           free(sock->peer_name);
 310         free(sock);
 311         XBT_OUT;
 312         return;
 313       }
 314     }
 315     WARN1("Ignoring request to free an unknown socket (%p)",sock);
 316   }
 317   XBT_OUT;
 318 }
 319
 320 /**
 321  * gras_trp_send:
 322  *
 323  * Send a bunch of bytes from on socket
 324  * (stable if we know the storage will keep as is until the next trp_flush)
 325  */
 326 void
 327 gras_trp_send(gras_socket_t sd, char *data, long int size, int stable) {
 328   xbt_assert0(sd->outgoing,"Socket not suited for data send");
 329   (*sd->plugin->send)(sd,data,size,stable);
 330 }
 331 /**
 332  * gras_trp_chunk_recv:
 333  *
 334  * Receive a bunch of bytes from a socket
 335  */
 336 void
 337 gras_trp_recv(gras_socket_t sd, char *data, long int size) {
 338   xbt_assert0(sd->incoming,"Socket not suited for data receive");
 339   (sd->plugin->recv)(sd,data,size);
 340 }
 341
 342 /**
 343  * gras_trp_flush:
 344  *
 345  * Make sure all pending communications are done
 346  */
 347 void
 348 gras_trp_flush(gras_socket_t sd) {
 349   if (sd->plugin->flush)
 350     (sd->plugin->flush)(sd);
 351 }
 352
 353 gras_trp_plugin_t
 354 gras_trp_plugin_get_by_name(const char *name){
 355   return xbt_dict_get(_gras_trp_plugins,name);
 356 }
 357
 358 int gras_socket_my_port  (gras_socket_t sock) {
 359   return sock->port;
 360 }
 361 int   gras_socket_peer_port(gras_socket_t sock) {
 362   return sock->peer_port;
 363 }
 364 char *gras_socket_peer_name(gras_socket_t sock) {
 365   return sock->peer_name;
 366 }
 367
 368 /** \brief Check if the provided socket is a measurement one (or a regular one) */
 369 int gras_socket_is_meas(gras_socket_t sock) {
 370   return sock->meas;
 371 }
 372
 373 /** \brief Send a chunk of (random) data over a measurement socket
 374  *
 375  * @param peer measurement socket to use for the experiment
 376  * @param timeout timeout (in seconds)
 377  * @param exp_size total amount of data to send (in bytes).
 378  * @param msg_size size of each chunk sent over the socket (in bytes).
 379  *
 380  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
 381  * each side of the socket should be paired.
 382  *
 383  * The exchanged data is zeroed to make sure it's initialized, but
 384  * there is no way to control what is sent (ie, you cannot use these
 385  * functions to exchange data out of band).
 386  */
 387 void gras_socket_meas_send(gras_socket_t peer,
 388                            unsigned int timeout,
 389                            unsigned long int exp_size,
 390                            unsigned long int msg_size) {
 391   char *chunk=NULL;
 392   unsigned long int exp_sofar;
 393
 394   XBT_IN;
 395
 396   if (gras_if_RL())
 397     chunk=xbt_malloc0(msg_size);
 398
 399   xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
 400   xbt_assert0(peer->outgoing,"Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
 401
 402   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 403      CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
 404              exp_sofar,exp_size,msg_size,
 405              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 406      (*peer->plugin->raw_send)(peer,chunk,msg_size);
 407   }
 408   CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
 409           exp_sofar,exp_size,msg_size,
 410           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 411
 412   if (gras_if_RL())
 413     free(chunk);
 414
 415   XBT_OUT;
 416 }
 417
 418 /** \brief Receive a chunk of data over a measurement socket
 419  *
 420  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
 421  * each side of the socket should be paired.
 422  */
 423 void gras_socket_meas_recv(gras_socket_t peer,
 424                            unsigned int timeout,
 425                            unsigned long int exp_size,
 426                            unsigned long int msg_size){
 427
 428   char *chunk=NULL;
 429   unsigned long int exp_sofar;
 430
 431   XBT_IN;
 432
 433   if (gras_if_RL())
 434     chunk = xbt_malloc(msg_size);
 435
 436   xbt_assert0(peer->meas,
 437               "Asked to receive measurement data on a regular socket");
 438   xbt_assert0(peer->incoming,"Socket not suited for data receive");
 439
 440   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 441      CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
 442              exp_sofar,exp_size,msg_size,
 443              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 444      (peer->plugin->raw_recv)(peer,chunk,msg_size);
 445   }
 446   CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
 447           exp_sofar,exp_size,msg_size,
 448           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 449
 450   if (gras_if_RL())
 451     free(chunk);
 452   XBT_OUT;
 453 }
 454
 455 /**
 456  * \brief Something similar to the good old accept system call.
 457  *
 458  * Make sure that there is someone speaking to the provided server socket.
 459  * In RL, it does an accept(2) and return the result as last argument.
 460  * In SG, as accepts are useless, it returns the provided argument as result.
 461  * You should thus test whether (peer != accepted) before closing both of them.
 462  *
 463  * You should only call this on measurement sockets. It is automatically
 464  * done for regular sockets, but you usually want more control about
 465  * what's going on with measurement sockets.
 466  */
 467 gras_socket_t gras_socket_meas_accept(gras_socket_t peer){
 468   gras_socket_t res;
 469
 470   xbt_assert0(peer->meas,
 471               "No need to accept on non-measurement sockets (it's automatic)");
 472
 473   if (!peer->accepting) {
 474     /* nothing to accept here (must be in SG) */
 475     /* BUG: FIXME: this is BAD! it makes tricky to free the accepted socket*/
 476     return peer;
 477   }
 478
 479   res = (peer->plugin->socket_accept)(peer);
 480   res->meas = peer->meas;
 481   CDEBUG1(trp_meas,"meas_accepted onto %d",res->sd);
 482
 483   return res;
 484 }
 485
 486
 487 /*
 488  * Creating procdata for this module
 489  */
 490 static void *gras_trp_procdata_new() {
 491    gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
 492
 493    res->name = xbt_strdup("gras_trp");
 494    res->name_len = 0;
 495    res->sockets   = xbt_dynar_new(sizeof(gras_socket_t*), NULL);
 496
 497    return (void*)res;
 498 }
 499
 500 /*
 501  * Freeing procdata for this module
 502  */
 503 static void gras_trp_procdata_free(void *data) {
 504    gras_trp_procdata_t res = (gras_trp_procdata_t)data;
 505
 506    xbt_dynar_free(&( res->sockets ));
 507    free(res->name);
 508    free(res);
 509 }
 510
 511 /*
 512  * Module registration
 513  */
 514 int gras_trp_libdata_id;
 515 void gras_trp_register() {
 516    gras_trp_libdata_id = gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
 517 }
 518