src/gras/Transport/transport.c

   1 /* transport - low level communication                                      */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 /***
  10  *** Options
  11  ***/
  12 int gras_opt_trp_nomoredata_on_close = 0;
  13
  14 #include "xbt/ex.h"
  15 #include "xbt/peer.h"
  16 #include "portable.h"
  17 #include "gras/Transport/transport_private.h"
  18 #include "gras/Msg/msg_interface.h"
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_trp, gras,
  21                                 "Conveying bytes over the network");
  22 XBT_LOG_NEW_SUBCATEGORY(gras_trp_meas, gras_trp,
  23                         "Conveying bytes over the network without formating for perf measurements");
  24 static short int _gras_trp_started = 0;
  25
  26 static xbt_dict_t _gras_trp_plugins;    /* All registered plugins */
  27 static void gras_trp_plugin_free(void *p);      /* free one of the plugins */
  28
  29 static void gras_trp_plugin_new(const char *name, gras_trp_setup_t setup)
  30 {
  31   xbt_ex_t e;
  32
  33   gras_trp_plugin_t plug = xbt_new0(s_gras_trp_plugin_t, 1);
  34
  35   DEBUG1("Create plugin %s", name);
  36
  37   plug->name = xbt_strdup(name);
  38
  39   TRY {
  40     setup(plug);
  41   } CATCH(e) {
  42     if (e.category == mismatch_error) {
  43       /* SG plugin raise mismatch when in RL mode (and vice versa) */
  44       free(plug->name);
  45       free(plug);
  46       plug = NULL;
  47       xbt_ex_free(e);
  48     } else {
  49       RETHROW;
  50     }
  51   }
  52
  53   if (plug)
  54     xbt_dict_set(_gras_trp_plugins, name, plug, gras_trp_plugin_free);
  55 }
  56
  57 void gras_trp_init(void)
  58 {
  59   if (!_gras_trp_started) {
  60     /* make room for all plugins */
  61     _gras_trp_plugins = xbt_dict_new();
  62
  63 #ifdef HAVE_WINSOCK2_H
  64     /* initialize the windows mechanism */
  65     {
  66       WORD wVersionRequested;
  67       WSADATA wsaData;
  68
  69       wVersionRequested = MAKEWORD(2, 0);
  70       xbt_assert0(WSAStartup(wVersionRequested, &wsaData) == 0,
  71                   "Cannot find a usable WinSock DLL");
  72
  73       /* Confirm that the WinSock DLL supports 2.0. */
  74       /* Note that if the DLL supports versions greater    */
  75       /* than 2.0 in addition to 2.0, it will still return */
  76       /* 2.0 in wVersion since that is the version we      */
  77       /* requested.                                        */
  78
  79       xbt_assert0(LOBYTE(wsaData.wVersion) == 2 &&
  80                   HIBYTE(wsaData.wVersion) == 0,
  81                   "Cannot find a usable WinSock DLL");
  82       INFO0("Found and initialized winsock2");
  83     }                           /* The WinSock DLL is acceptable. Proceed. */
  84 #elif HAVE_WINSOCK_H
  85     {
  86       WSADATA wsaData;
  87       xbt_assert0(WSAStartup(0x0101, &wsaData) == 0,
  88                   "Cannot find a usable WinSock DLL");
  89       INFO0("Found and initialized winsock");
  90     }
  91 #endif
  92
  93     /* Add plugins */
  94     gras_trp_plugin_new("file", gras_trp_file_setup);
  95     gras_trp_plugin_new("sg", gras_trp_sg_setup);
  96     gras_trp_plugin_new("tcp", gras_trp_tcp_setup);
  97   }
  98
  99   _gras_trp_started++;
 100 }
 101
 102 void gras_trp_exit(void)
 103 {
 104   DEBUG1("gras_trp value %d", _gras_trp_started);
 105   if (_gras_trp_started == 0) {
 106     return;
 107   }
 108
 109   if (--_gras_trp_started == 0) {
 110 #ifdef HAVE_WINSOCK_H
 111     if (WSACleanup() == SOCKET_ERROR) {
 112       if (WSAGetLastError() == WSAEINPROGRESS) {
 113         WSACancelBlockingCall();
 114         WSACleanup();
 115       }
 116     }
 117 #endif
 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 {
 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, gras_socket_t * dst)
 149 {
 150
 151   gras_socket_t sock = xbt_new0(s_gras_socket_t, 1);
 152
 153   VERB1("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->recvd = 0;
 162   sock->valid = 1;
 163   sock->moredata = 0;
 164
 165   sock->sd = -1;
 166   sock->port = -1;
 167   sock->peer_port = -1;
 168   sock->peer_name = NULL;
 169   sock->peer_proc = NULL;
 170
 171   sock->data = NULL;
 172   sock->bufdata = NULL;
 173
 174   *dst = sock;
 175
 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                        unsigned long int buf_size, int measurement)
 190 {
 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", port);
 198   trp = gras_trp_plugin_get_by_name(gras_if_SG()? "sg" : "tcp");
 199
 200   /* defaults settings */
 201   gras_trp_socket_new(1, &sock);
 202   sock->plugin = trp;
 203   sock->port = port;
 204   sock->buf_size = buf_size > 0 ? buf_size : 32 * 1024;
 205   sock->meas = measurement;
 206
 207   /* Call plugin socket creation function */
 208   DEBUG1("Prepare socket with plugin (fct=%p)", trp->socket_server);
 209   TRY {
 210     trp->socket_server(trp, sock);
 211     DEBUG3("in=%c out=%c accept=%c",
 212            sock->incoming ? 'y' : 'n',
 213            sock->outgoing ? 'y' : 'n', sock->accepting ? 'y' : 'n');
 214   } CATCH(e) {
 215
 216     free(sock);
 217     RETHROW;
 218   }
 219
 220   if (!measurement)
 221     ((gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id))->myport
 222         = port;
 223   xbt_dynar_push(((gras_trp_procdata_t)
 224                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,
 225                  &sock);
 226
 227   gras_msg_listener_awake();
 228   return sock;
 229 }
 230
 231 /**
 232  * @brief Opens a server socket on any port in the given range
 233  *
 234  * @param minport: first port we will try
 235  * @param maxport: last port we will try
 236  * @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)
 237  * @param measurement: whether this socket is meant to convey measurement (if you don't know, use 0 to exchange regular messages)
 238  *
 239  * If none of the provided ports works, raises the exception got when trying the last possibility
 240  */
 241 gras_socket_t
 242 gras_socket_server_range(unsigned short minport, unsigned short maxport,
 243                          unsigned long int buf_size, int measurement)
 244 {
 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     }
 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                        unsigned long int buf_size, int measurement)
 278 {
 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",
 287          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', sock->accepting ? 'y' : 'n');
 302   } CATCH(e) {
 303     free(sock);
 304     RETHROW;
 305   }
 306   xbt_dynar_push(((gras_trp_procdata_t)
 307                   gras_libdata_by_id(gras_trp_libdata_id))->sockets,
 308                  &sock);
 309   gras_msg_listener_awake();
 310   return sock;
 311 }
 312
 313 /**
 314  * @brief Opens a server socket and make it ready to be listened to.
 315  *
 316  * In real life, you'll get a TCP socket.
 317  */
 318 gras_socket_t gras_socket_server(unsigned short port)
 319 {
 320   return gras_socket_server_ext(port, 32 * 1024, 0);
 321 }
 322
 323 /** @brief Opens a client socket to a remote host */
 324 gras_socket_t gras_socket_client(const char *host, unsigned short port)
 325 {
 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 gras_socket_client_from_string(const char *host)
 331 {
 332   xbt_peer_t p = xbt_peer_from_string(host);
 333   gras_socket_t res = gras_socket_client_ext(p->name, p->port, 0, 0);
 334   xbt_peer_free(p);
 335   return res;
 336 }
 337
 338 void gras_socket_close_voidp(void *sock)
 339 {
 340   gras_socket_close((gras_socket_t) sock);
 341 }
 342
 343 /** \brief Close socket */
 344 void gras_socket_close(gras_socket_t sock)
 345 {
 346   xbt_dynar_t sockets =
 347       ((gras_trp_procdata_t)
 348        gras_libdata_by_id(gras_trp_libdata_id))->sockets;
 349   gras_socket_t sock_iter = NULL;
 350   unsigned int cursor;
 351
 352   XBT_IN;
 353   VERB1("Close %p", sock);
 354   if (sock == _gras_lastly_selected_socket) {
 355     xbt_assert0(!gras_opt_trp_nomoredata_on_close || !sock->moredata,
 356                 "Closing a socket having more data in buffer while the nomoredata_on_close option is activated");
 357
 358     if (sock->moredata)
 359       CRITICAL0
 360           ("Closing a socket having more data in buffer. Option nomoredata_on_close disabled, so continuing.");
 361     _gras_lastly_selected_socket = NULL;
 362   }
 363
 364   /* FIXME: Issue an event when the socket is closed */
 365   DEBUG1("sockets pointer before %p", sockets);
 366   if (sock) {
 367     /* FIXME: Cannot get the dynar mutex, because it can be already locked */
 368 //              _xbt_dynar_foreach(sockets,cursor,sock_iter) {
 369     for (cursor = 0; cursor < xbt_dynar_length(sockets); cursor++) {
 370       _xbt_dynar_cursor_get(sockets, cursor, &sock_iter);
 371       if (sock == sock_iter) {
 372         DEBUG2("remove sock cursor %d dize %lu\n", cursor,
 373                xbt_dynar_length(sockets));
 374         xbt_dynar_cursor_rm(sockets, &cursor);
 375         if (sock->plugin->socket_close)
 376           (*sock->plugin->socket_close) (sock);
 377
 378         /* free the memory */
 379         if (sock->peer_name)
 380           free(sock->peer_name);
 381         free(sock);
 382         XBT_OUT;
 383         return;
 384       }
 385     }
 386     WARN1
 387         ("Ignoring request to free an unknown socket (%p). Execution stack:",
 388          sock);
 389     xbt_backtrace_display_current();
 390   }
 391   XBT_OUT;
 392 }
 393
 394 /**
 395  * gras_trp_send:
 396  *
 397  * Send a bunch of bytes from on socket
 398  * (stable if we know the storage will keep as is until the next trp_flush)
 399  */
 400 void gras_trp_send(gras_socket_t sd, char *data, long int size, int stable)
 401 {
 402   xbt_assert0(sd->outgoing, "Socket not suited for data send");
 403   (*sd->plugin->send) (sd, data, size, stable);
 404 }
 405
 406 /**
 407  * gras_trp_chunk_recv:
 408  *
 409  * Receive a bunch of bytes from a socket
 410  */
 411 void gras_trp_recv(gras_socket_t sd, char *data, long int size)
 412 {
 413   xbt_assert0(sd->incoming, "Socket not suited for data receive");
 414   (sd->plugin->recv) (sd, data, size);
 415 }
 416
 417 /**
 418  * gras_trp_flush:
 419  *
 420  * Make sure all pending communications are done
 421  */
 422 void gras_trp_flush(gras_socket_t sd)
 423 {
 424   if (sd->plugin->flush)
 425     (sd->plugin->flush) (sd);
 426 }
 427
 428 gras_trp_plugin_t gras_trp_plugin_get_by_name(const char *name)
 429 {
 430   return xbt_dict_get(_gras_trp_plugins, name);
 431 }
 432
 433 int gras_socket_my_port(gras_socket_t sock)
 434 {
 435   return sock->port;
 436 }
 437
 438 int gras_socket_peer_port(gras_socket_t sock)
 439 {
 440   return sock->peer_port;
 441 }
 442
 443 char *gras_socket_peer_name(gras_socket_t sock)
 444 {
 445   return sock->peer_name;
 446 }
 447
 448 char *gras_socket_peer_proc(gras_socket_t sock)
 449 {
 450   return sock->peer_proc;
 451 }
 452
 453 void gras_socket_peer_proc_set(gras_socket_t sock, char *peer_proc)
 454 {
 455   sock->peer_proc = peer_proc;
 456 }
 457
 458 /** \brief Check if the provided socket is a measurement one (or a regular one) */
 459 int gras_socket_is_meas(gras_socket_t sock)
 460 {
 461   return sock->meas;
 462 }
 463
 464 /** \brief Send a chunk of (random) data over a measurement socket
 465  *
 466  * @param peer measurement socket to use for the experiment
 467  * @param timeout timeout (in seconds)
 468  * @param msg_size size of each chunk sent over the socket (in bytes).
 469  * @param msg_amount how many of these packets you want to send.
 470  *
 471  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
 472  * each side of the socket should be paired.
 473  *
 474  * The exchanged data is zeroed to make sure it's initialized, but
 475  * there is no way to control what is sent (ie, you cannot use these
 476  * functions to exchange data out of band).
 477  *
 478  * @warning: in SimGrid version 3.1 and previous, the numerical arguments
 479  *           were the total amount of data to send and the msg_size. This
 480  *           was changed for the fool wanting to send more than MAXINT
 481  *           bytes in a fat pipe.
 482  */
 483 void gras_socket_meas_send(gras_socket_t peer,
 484                            unsigned int timeout,
 485                            unsigned long int msg_size,
 486                            unsigned long int msg_amount)
 487 {
 488   char *chunk = NULL;
 489   unsigned long int sent_sofar;
 490
 491   XBT_IN;
 492
 493   if (gras_if_RL())
 494     chunk = xbt_malloc0(msg_size);
 495
 496   xbt_assert0(peer->meas,
 497               "Asked to send measurement data on a regular socket");
 498   xbt_assert0(peer->outgoing,
 499               "Socket not suited for data send (was created with gras_socket_server(), not gras_socket_client())");
 500
 501   for (sent_sofar = 0; sent_sofar < msg_amount; sent_sofar++) {
 502     CDEBUG5(gras_trp_meas,
 503             "Sent %lu msgs of %lu (size of each: %ld) to %s:%d",
 504             sent_sofar, msg_amount, msg_size, gras_socket_peer_name(peer),
 505             gras_socket_peer_port(peer));
 506     (*peer->plugin->raw_send) (peer, chunk, msg_size);
 507   }
 508   CDEBUG5(gras_trp_meas,
 509           "Sent %lu msgs of %lu (size of each: %ld) to %s:%d", sent_sofar,
 510           msg_amount, msg_size, gras_socket_peer_name(peer),
 511           gras_socket_peer_port(peer));
 512
 513   if (gras_if_RL())
 514     free(chunk);
 515
 516   XBT_OUT;
 517 }
 518
 519 /** \brief Receive a chunk of data over a measurement socket
 520  *
 521  * Calls to gras_socket_meas_send() and gras_socket_meas_recv() on
 522  * each side of the socket should be paired.
 523  *
 524  * @warning: in SimGrid version 3.1 and previous, the numerical arguments
 525  *           were the total amount of data to send and the msg_size. This
 526  *           was changed for the fool wanting to send more than MAXINT
 527  *           bytes in a fat pipe.
 528  */
 529 void gras_socket_meas_recv(gras_socket_t peer,
 530                            unsigned int timeout,
 531                            unsigned long int msg_size,
 532                            unsigned long int msg_amount)
 533 {
 534
 535   char *chunk = NULL;
 536   unsigned long int got_sofar;
 537
 538   XBT_IN;
 539
 540   if (gras_if_RL())
 541     chunk = xbt_malloc(msg_size);
 542
 543   xbt_assert0(peer->meas,
 544               "Asked to receive measurement data on a regular socket");
 545   xbt_assert0(peer->incoming, "Socket not suited for data receive");
 546
 547   for (got_sofar = 0; got_sofar < msg_amount; got_sofar++) {
 548     CDEBUG5(gras_trp_meas,
 549             "Recvd %ld msgs of %lu (size of each: %ld) from %s:%d",
 550             got_sofar, msg_amount, msg_size, gras_socket_peer_name(peer),
 551             gras_socket_peer_port(peer));
 552     (peer->plugin->raw_recv) (peer, chunk, msg_size);
 553   }
 554   CDEBUG5(gras_trp_meas,
 555           "Recvd %ld msgs of %lu (size of each: %ld) from %s:%d",
 556           got_sofar, msg_amount, msg_size, gras_socket_peer_name(peer),
 557           gras_socket_peer_port(peer));
 558
 559   if (gras_if_RL())
 560     free(chunk);
 561   XBT_OUT;
 562 }
 563
 564 /**
 565  * \brief Something similar to the good old accept system call.
 566  *
 567  * Make sure that there is someone speaking to the provided server socket.
 568  * In RL, it does an accept(2) and return the result as last argument.
 569  * In SG, as accepts are useless, it returns the provided argument as result.
 570  * You should thus test whether (peer != accepted) before closing both of them.
 571  *
 572  * You should only call this on measurement sockets. It is automatically
 573  * done for regular sockets, but you usually want more control about
 574  * what's going on with measurement sockets.
 575  */
 576 gras_socket_t gras_socket_meas_accept(gras_socket_t peer)
 577 {
 578   gras_socket_t res;
 579
 580   xbt_assert0(peer->meas,
 581               "No need to accept on non-measurement sockets (it's automatic)");
 582
 583   if (!peer->accepting) {
 584     /* nothing to accept here (must be in SG) */
 585     /* BUG: FIXME: this is BAD! it makes tricky to free the accepted socket */
 586     return peer;
 587   }
 588
 589   res = (peer->plugin->socket_accept) (peer);
 590   res->meas = peer->meas;
 591   CDEBUG1(gras_trp_meas, "meas_accepted onto %d", res->sd);
 592
 593   return res;
 594 }
 595
 596
 597 /*
 598  * Creating procdata for this module
 599  */
 600 static void *gras_trp_procdata_new(void)
 601 {
 602   gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t, 1);
 603
 604   res->name = xbt_strdup("gras_trp");
 605   res->name_len = 0;
 606   res->sockets = xbt_dynar_new_sync(sizeof(gras_socket_t *), NULL);
 607   res->myport = 0;
 608
 609   return (void *) res;
 610 }
 611
 612 /*
 613  * Freeing procdata for this module
 614  */
 615 static void gras_trp_procdata_free(void *data)
 616 {
 617   gras_trp_procdata_t res = (gras_trp_procdata_t) data;
 618
 619   xbt_dynar_free(&(res->sockets));
 620   free(res->name);
 621   free(res);
 622 }
 623
 624 void gras_trp_socketset_dump(const char *name)
 625 {
 626   gras_trp_procdata_t procdata =
 627       (gras_trp_procdata_t) gras_libdata_by_id(gras_trp_libdata_id);
 628
 629   unsigned int it;
 630   gras_socket_t s;
 631
 632   INFO1("** Dump the socket set %s", name);
 633   xbt_dynar_foreach(procdata->sockets, it, s) {
 634     INFO4("  %p -> %s:%d %s",
 635           s, gras_socket_peer_name(s), gras_socket_peer_port(s),
 636           s->valid ? "(valid)" : "(peer dead)");
 637   }
 638   INFO1("** End of socket set %s", name);
 639 }
 640
 641 /*
 642  * Module registration
 643  */
 644 int gras_trp_libdata_id;
 645 void gras_trp_register()
 646 {
 647   gras_trp_libdata_id =
 648       gras_procdata_add("gras_trp", gras_trp_procdata_new,
 649                         gras_trp_procdata_free);
 650 }
 651
 652 int gras_os_myport(void)
 653 {
 654   return ((gras_trp_procdata_t)
 655           gras_libdata_by_id(gras_trp_libdata_id))->myport;
 656 }