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