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