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   sock->recv_ok = 1;
 162
 163   sock->sd     = -1;
 164   sock->port      = -1;
 165   sock->peer_port = -1;
 166   sock->peer_name = NULL;
 167   sock->peer_proc = NULL;
 168
 169   sock->data   = NULL;
 170   sock->bufdata = NULL;
 171
 172   *dst = sock;
 173
 174   xbt_dynar_push(((gras_trp_procdata_t)
 175                      gras_libdata_by_id(gras_trp_libdata_id))->sockets,dst);
 176   XBT_OUT;
 177 }
 178
 179 /**
 180  * @brief Opens a server socket and makes it ready to be listened to.
 181  * @param port: port on which you want to listen
 182  * @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)
 183  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
 184  *
 185  * In real life, you'll get a TCP socket.
 186  */
 187 gras_socket_t
 188 gras_socket_server_ext(unsigned short port,
 189
 190                        unsigned long int buf_size,
 191                        int measurement) {
 192
 193   xbt_ex_t e;
 194   gras_trp_plugin_t trp;
 195   gras_socket_t sock;
 196
 197   DEBUG2("Create a server socket from plugin %s on port %d",
 198          gras_if_RL() ? "tcp" : "sg",
 199          port);
 200   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
 201
 202   /* defaults settings */
 203   gras_trp_socket_new(1,&sock);
 204   sock->plugin= trp;
 205   sock->port=port;
 206   sock->buf_size = buf_size>0 ? buf_size : 32*1024;
 207   sock->meas = measurement;
 208
 209   /* Call plugin socket creation function */
 210   DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
 211   TRY {
 212     trp->socket_server(trp, sock);
 213     DEBUG3("in=%c out=%c accept=%c",
 214            sock->incoming?'y':'n',
 215            sock->outgoing?'y':'n',
 216            sock->accepting?'y':'n');
 217   } CATCH(e) {
 218     int cursor;
 219     gras_socket_t sock_iter;
 220     xbt_dynar_t socks = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
 221     xbt_dynar_foreach(socks, cursor, sock_iter) {
 222        if (sock_iter==sock)
 223          xbt_dynar_cursor_rm(socks,&cursor);
 224     }
 225     free(sock);
 226     RETHROW;
 227   }
 228
 229   if (!measurement)
 230      ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport = port;
 231   return sock;
 232 }
 233 /**
 234  * @brief Opens a server socket on any port in the given range
 235  *
 236  * @param minport: first port we will try
 237  * @param maxport: last port we will try
 238  * @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)
 239  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
 240  *
 241  * If none of the provided ports works, raises the exception got when trying the last possibility
 242  */
 243 gras_socket_t
 244 gras_socket_server_range(unsigned short minport, unsigned short maxport,
 245                          unsigned long int buf_size, int measurement) {
 246
 247   int port;
 248   gras_socket_t res=NULL;
 249   xbt_ex_t e;
 250
 251   for (port=minport; port<maxport;port ++) {
 252     TRY {
 253       res=gras_socket_server_ext(port,buf_size,measurement);
 254     } CATCH(e) {
 255       if (port==maxport)
 256         RETHROW;
 257       xbt_ex_free(e);
 258     }
 259     if (res)
 260       return res;
 261   }
 262   THROW_IMPOSSIBLE;
 263 }
 264
 265 /**
 266  * @brief Opens a client socket to a remote host.
 267  * @param host: who you want to connect to
 268  * @param port: where you want to connect to on this host
 269  * @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)
 270  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
 271  *
 272  * In real life, you'll get a TCP socket.
 273  */
 274 gras_socket_t
 275 gras_socket_client_ext(const char *host,
 276                        unsigned short port,
 277
 278                        unsigned long int buf_size,
 279                        int measurement) {
 280
 281   xbt_ex_t e;
 282   gras_trp_plugin_t trp;
 283   gras_socket_t sock;
 284
 285   trp = gras_trp_plugin_get_by_name(gras_if_SG() ? "sg":"tcp");
 286
 287   DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
 288   /* defaults settings */
 289   gras_trp_socket_new(0,&sock);
 290   sock->plugin= trp;
 291   sock->peer_port = port;
 292   sock->peer_name = (char*)strdup(host?host:"localhost");
 293   sock->buf_size = buf_size>0 ? buf_size: 32*1024;
 294   sock->meas = measurement;
 295
 296   /* plugin-specific */
 297   TRY {
 298     (*trp->socket_client)(trp, sock);
 299     DEBUG3("in=%c out=%c accept=%c",
 300            sock->incoming?'y':'n',
 301            sock->outgoing?'y':'n',
 302            sock->accepting?'y':'n');
 303   } CATCH(e) {
 304     free(sock);
 305     RETHROW;
 306   }
 307
 308   return sock;
 309 }
 310
 311 /**
 312  * gras_socket_server:
 313  *
 314  * Opens a server socket and make it ready to be listened to.
 315  * In real life, you'll get a TCP socket.
 316  */
 317 gras_socket_t
 318 gras_socket_server(unsigned short port) {
 319    return gras_socket_server_ext(port,32*1024,0);
 320 }
 321
 322 /** @brief Opens a client socket to a remote host */
 323 gras_socket_t
 324 gras_socket_client(const char *host,
 325                    unsigned short port) {
 326    return gras_socket_client_ext(host,port,0,0);
 327 }
 328
 329 /** @brief Opens a client socket to a remote host specified as '\a host:\a port' */
 330 gras_socket_t
 331 gras_socket_client_from_string(const char *host) {
 332    xbt_host_t h = xbt_host_from_string(host);
 333    gras_socket_t res = gras_socket_client_ext(h->name,h->port,0,0);
 334    xbt_host_free(h);
 335    return res;
 336 }
 337
 338 /** \brief Close socket */
 339 void gras_socket_close(gras_socket_t sock) {
 340   xbt_dynar_t sockets = ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->sockets;
 341   gras_socket_t sock_iter;
 342   int cursor;
 343
 344   XBT_IN;
 345   /* FIXME: Issue an event when the socket is closed */
 346   if (sock) {
 347     xbt_dynar_foreach(sockets,cursor,sock_iter) {
 348       if (sock == sock_iter) {
 349         xbt_dynar_cursor_rm(sockets,&cursor);
 350         if (sock->plugin->socket_close)
 351           (* sock->plugin->socket_close)(sock);
 352
 353         /* free the memory */
 354         if (sock->peer_name)
 355           free(sock->peer_name);
 356         free(sock);
 357         XBT_OUT;
 358         return;
 359       }
 360     }
 361     WARN1("Ignoring request to free an unknown socket (%p). Execution stack:",sock);
 362     xbt_backtrace_display();
 363   }
 364   XBT_OUT;
 365 }
 366
 367 /**
 368  * gras_trp_send:
 369  *
 370  * Send a bunch of bytes from on socket
 371  * (stable if we know the storage will keep as is until the next trp_flush)
 372  */
 373 void
 374 gras_trp_send(gras_socket_t sd, char *data, long int size, int stable) {
 375   xbt_assert0(sd->outgoing,"Socket not suited for data send");
 376   (*sd->plugin->send)(sd,data,size,stable);
 377 }
 378 /**
 379  * gras_trp_chunk_recv:
 380  *
 381  * Receive a bunch of bytes from a socket
 382  */
 383 void
 384 gras_trp_recv(gras_socket_t sd, char *data, long int size) {
 385   xbt_assert0(sd->incoming,"Socket not suited for data receive");
 386   (sd->plugin->recv)(sd,data,size);
 387 }
 388
 389 /**
 390  * gras_trp_flush:
 391  *
 392  * Make sure all pending communications are done
 393  */
 394 void
 395 gras_trp_flush(gras_socket_t sd) {
 396   if (sd->plugin->flush)
 397     (sd->plugin->flush)(sd);
 398 }
 399
 400 gras_trp_plugin_t
 401 gras_trp_plugin_get_by_name(const char *name){
 402   return xbt_dict_get(_gras_trp_plugins,name);
 403 }
 404
 405 int gras_socket_my_port  (gras_socket_t sock) {
 406   return sock->port;
 407 }
 408 int   gras_socket_peer_port(gras_socket_t sock) {
 409   return sock->peer_port;
 410 }
 411 char *gras_socket_peer_name(gras_socket_t sock) {
 412   return sock->peer_name;
 413 }
 414 char *gras_socket_peer_proc(gras_socket_t sock) {
 415   return sock->peer_proc;
 416 }
 417
 418 void gras_socket_peer_proc_set(gras_socket_t sock,char*peer_proc) {
 419   sock->peer_proc = peer_proc;
 420 }
 421
 422 /** \brief Check if the provided socket is a measurement one (or a regular one) */
 423 int gras_socket_is_meas(gras_socket_t sock) {
 424   return sock->meas;
 425 }
 426
 427 /** \brief Send a chunk of (random) data over a measurement socket
 428  *
 429  * @param peer measurement socket to use for the experiment
 430  * @param timeout timeout (in seconds)
 431  * @param exp_size total amount of data to send (in bytes).
 432  * @param msg_size size of each chunk sent over the socket (in bytes).
 433  *
 434  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
 435  * each side of the socket should be paired.
 436  *
 437  * The exchanged data is zeroed to make sure it's initialized, but
 438  * there is no way to control what is sent (ie, you cannot use these
 439  * functions to exchange data out of band).
 440  */
 441 void gras_socket_meas_send(gras_socket_t peer,
 442                            unsigned int timeout,
 443                            unsigned long int exp_size,
 444                            unsigned long int msg_size) {
 445   char *chunk=NULL;
 446   unsigned long int exp_sofar;
 447
 448   XBT_IN;
 449
 450   if (gras_if_RL())
 451     chunk=xbt_malloc0(msg_size);
 452
 453   xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
 454   xbt_assert0(peer->outgoing,"Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
 455
 456   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 457      CDEBUG5(gras_trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
 458              exp_sofar,exp_size,msg_size,
 459              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 460      (*peer->plugin->raw_send)(peer,chunk,msg_size);
 461   }
 462   CDEBUG5(gras_trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
 463           exp_sofar,exp_size,msg_size,
 464           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 465
 466   if (gras_if_RL())
 467     free(chunk);
 468
 469   XBT_OUT;
 470 }
 471
 472 /** \brief Receive a chunk of data over a measurement socket
 473  *
 474  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
 475  * each side of the socket should be paired.
 476  */
 477 void gras_socket_meas_recv(gras_socket_t peer,
 478                            unsigned int timeout,
 479                            unsigned long int exp_size,
 480                            unsigned long int msg_size){
 481
 482   char *chunk=NULL;
 483   unsigned long int exp_sofar;
 484
 485   XBT_IN;
 486
 487   if (gras_if_RL())
 488     chunk = xbt_malloc(msg_size);
 489
 490   xbt_assert0(peer->meas,
 491               "Asked to receive measurement data on a regular socket");
 492   xbt_assert0(peer->incoming,"Socket not suited for data receive");
 493
 494   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 495      CDEBUG5(gras_trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
 496              exp_sofar,exp_size,msg_size,
 497              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 498      (peer->plugin->raw_recv)(peer,chunk,msg_size);
 499   }
 500   CDEBUG5(gras_trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
 501           exp_sofar,exp_size,msg_size,
 502           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 503
 504   if (gras_if_RL())
 505     free(chunk);
 506   XBT_OUT;
 507 }
 508
 509 /**
 510  * \brief Something similar to the good old accept system call.
 511  *
 512  * Make sure that there is someone speaking to the provided server socket.
 513  * In RL, it does an accept(2) and return the result as last argument.
 514  * In SG, as accepts are useless, it returns the provided argument as result.
 515  * You should thus test whether (peer != accepted) before closing both of them.
 516  *
 517  * You should only call this on measurement sockets. It is automatically
 518  * done for regular sockets, but you usually want more control about
 519  * what's going on with measurement sockets.
 520  */
 521 gras_socket_t gras_socket_meas_accept(gras_socket_t peer){
 522   gras_socket_t res;
 523
 524   xbt_assert0(peer->meas,
 525               "No need to accept on non-measurement sockets (it's automatic)");
 526
 527   if (!peer->accepting) {
 528     /* nothing to accept here (must be in SG) */
 529     /* BUG: FIXME: this is BAD! it makes tricky to free the accepted socket*/
 530     return peer;
 531   }
 532
 533   res = (peer->plugin->socket_accept)(peer);
 534   res->meas = peer->meas;
 535   CDEBUG1(gras_trp_meas,"meas_accepted onto %d",res->sd);
 536
 537   return res;
 538 }
 539
 540
 541 /*
 542  * Creating procdata for this module
 543  */
 544 static void *gras_trp_procdata_new() {
 545    gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
 546
 547    res->name = xbt_strdup("gras_trp");
 548    res->name_len = 0;
 549    res->sockets   = xbt_dynar_new(sizeof(gras_socket_t*), NULL);
 550    res->myport = 0;
 551
 552    return (void*)res;
 553 }
 554
 555 /*
 556  * Freeing procdata for this module
 557  */
 558 static void gras_trp_procdata_free(void *data) {
 559    gras_trp_procdata_t res = (gras_trp_procdata_t)data;
 560
 561    xbt_dynar_free(&( res->sockets ));
 562    free(res->name);
 563    free(res);
 564 }
 565
 566 /*
 567  * Module registration
 568  */
 569 int gras_trp_libdata_id;
 570 void gras_trp_register() {
 571    gras_trp_libdata_id = gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
 572 }
 573
 574 int gras_os_myport(void)  {
 575    return ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport;
 576 }
 577