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