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