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 "portable.h"
  11 #include "gras/Transport/transport_private.h"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(transport,gras,"Conveying bytes over the network");
  14 XBT_LOG_NEW_SUBCATEGORY(trp_meas,transport,"Conveying bytes over the network without formating for perf measurements");
  15 static short int _gras_trp_started = 0;
  16
  17 static xbt_dict_t _gras_trp_plugins;      /* All registered plugins */
  18 static void gras_trp_plugin_free(void *p); /* free one of the plugins */
  19
  20 static void
  21 gras_trp_plugin_new(const char *name, gras_trp_setup_t setup) {
  22   xbt_error_t errcode;
  23
  24   gras_trp_plugin_t *plug = xbt_new0(gras_trp_plugin_t, 1);
  25
  26   DEBUG1("Create plugin %s",name);
  27
  28   plug->name=xbt_strdup(name);
  29
  30   errcode = setup(plug);
  31   switch (errcode) {
  32   case mismatch_error:
  33     /* SG plugin return mismatch when in RL mode (and vice versa) */
  34     free(plug->name);
  35     free(plug);
  36     break;
  37
  38   case no_error:
  39     xbt_dict_set(_gras_trp_plugins,
  40                   name, plug, gras_trp_plugin_free);
  41     break;
  42
  43   default:
  44     DIE_IMPOSSIBLE;
  45   }
  46
  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("tcp", gras_trp_tcp_setup);
  85      gras_trp_plugin_new("file",gras_trp_file_setup);
  86      gras_trp_plugin_new("sg",gras_trp_sg_setup);
  87
  88      /* buf is composed, so it must come after the others */
  89      gras_trp_plugin_new("buf", gras_trp_buf_setup);
  90   }
  91
  92   _gras_trp_started++;
  93 }
  94
  95 void
  96 gras_trp_exit(void){
  97   xbt_dynar_t sockets = gras_socketset_get();
  98   gras_socket_t sock_iter;
  99   int cursor;
 100
 101    if (_gras_trp_started == 0) {
 102       return;
 103    }
 104
 105    if ( --_gras_trp_started == 0 ) {
 106 #ifdef HAVE_WINSOCK_H
 107       if ( WSACleanup() == SOCKET_ERROR ) {
 108          if ( WSAGetLastError() == WSAEINPROGRESS ) {
 109             WSACancelBlockingCall();
 110             WSACleanup();
 111          }
 112         }
 113 #endif
 114
 115       /* Close all the sockets */
 116       xbt_dynar_foreach(sockets,cursor,sock_iter) {
 117         VERB1("Closing the socket %p left open on exit. Maybe a socket leak?",
 118               sock_iter);
 119         gras_socket_close(sock_iter);
 120       }
 121
 122       /* Delete the plugins */
 123       xbt_dict_free(&_gras_trp_plugins);
 124    }
 125 }
 126
 127
 128 void gras_trp_plugin_free(void *p) {
 129   gras_trp_plugin_t *plug = p;
 130
 131   if (plug) {
 132     if (plug->exit) {
 133       plug->exit(plug);
 134     } else if (plug->data) {
 135       DEBUG1("Plugin %s lacks exit(). Free data anyway.",plug->name);
 136       free(plug->data);
 137     }
 138
 139     free(plug->name);
 140     free(plug);
 141   }
 142 }
 143
 144
 145 /**
 146  * gras_trp_socket_new:
 147  *
 148  * Malloc a new socket, and initialize it with defaults
 149  */
 150 void gras_trp_socket_new(int incoming,
 151                          gras_socket_t *dst) {
 152
 153   gras_socket_t sock=xbt_new0(s_gras_socket_t,1);
 154
 155   DEBUG1("Create a new socket (%p)", (void*)sock);
 156
 157   sock->plugin = NULL;
 158   sock->sd     = -1;
 159   sock->data   = NULL;
 160
 161   sock->incoming  = incoming ? 1:0;
 162   sock->outgoing  = incoming ? 0:1;
 163   sock->accepting = incoming ? 1:0;
 164
 165   sock->port      = -1;
 166   sock->peer_port = -1;
 167   sock->peer_name = NULL;
 168   sock->meas = 0;
 169
 170   *dst = sock;
 171
 172   xbt_dynar_push(gras_socketset_get(),dst);
 173   XBT_OUT;
 174 }
 175
 176
 177 /**
 178  * gras_socket_server_ext:
 179  *
 180  * Opens a server socket and make it ready to be listened to.
 181  * In real life, you'll get a TCP socket.
 182  */
 183 xbt_error_t
 184 gras_socket_server_ext(unsigned short port,
 185
 186                        unsigned long int bufSize,
 187                        int measurement,
 188
 189                        /* OUT */ gras_socket_t *dst) {
 190
 191   xbt_error_t errcode;
 192   gras_trp_plugin_t *trp;
 193   gras_socket_t sock;
 194
 195   *dst = NULL;
 196
 197   DEBUG2("Create a server socket from plugin %s on port %d",
 198          gras_if_RL() ? "tcp" : "sg",
 199          port);
 200   TRY(gras_trp_plugin_get_by_name((measurement? (gras_if_RL() ? "tcp" : "sg")
 201                                               :"buf"),
 202                                   &trp));
 203
 204   /* defaults settings */
 205   gras_trp_socket_new(1,&sock);
 206   sock->plugin= trp;
 207   sock->port=port;
 208   sock->bufSize = bufSize;
 209   sock->meas = measurement;
 210
 211   /* Call plugin socket creation function */
 212   DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
 213   errcode = trp->socket_server(trp, sock);
 214   DEBUG3("in=%c out=%c accept=%c",
 215          sock->incoming?'y':'n',
 216          sock->outgoing?'y':'n',
 217          sock->accepting?'y':'n');
 218
 219   if (errcode != no_error) {
 220     free(sock);
 221     return errcode;
 222   }
 223
 224   *dst = sock;
 225
 226   return no_error;
 227 }
 228
 229 /**
 230  * gras_socket_client_ext:
 231  *
 232  * Opens a client socket to a remote host.
 233  * In real life, you'll get a TCP socket.
 234  */
 235 xbt_error_t
 236 gras_socket_client_ext(const char *host,
 237                        unsigned short port,
 238
 239                        unsigned long int bufSize,
 240                        int measurement,
 241
 242                        /* OUT */ gras_socket_t *dst) {
 243
 244   xbt_error_t errcode;
 245   gras_trp_plugin_t *trp;
 246   gras_socket_t sock;
 247
 248   *dst = NULL;
 249
 250   TRY(gras_trp_plugin_get_by_name((measurement? (gras_if_RL() ? "tcp" : "sg")
 251                                               :"buf"),
 252                                   &trp));
 253
 254   DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
 255   /* defaults settings */
 256   gras_trp_socket_new(0,&sock);
 257   sock->plugin= trp;
 258   sock->peer_port = port;
 259   sock->peer_name = (char*)strdup(host?host:"localhost");
 260   sock->bufSize = bufSize;
 261   sock->meas = measurement;
 262
 263   /* plugin-specific */
 264   errcode= (*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
 270   if (errcode != no_error) {
 271     free(sock);
 272     return errcode;
 273   }
 274
 275   *dst = sock;
 276
 277   return no_error;
 278 }
 279
 280 /**
 281  * gras_socket_server:
 282  *
 283  * Opens a server socket and make it ready to be listened to.
 284  * In real life, you'll get a TCP socket.
 285  */
 286 xbt_error_t
 287 gras_socket_server(unsigned short port,
 288                    /* OUT */ gras_socket_t *dst) {
 289    return gras_socket_server_ext(port,32,0,dst);
 290 }
 291
 292 /**
 293  * gras_socket_client:
 294  *
 295  * Opens a client socket to a remote host.
 296  * In real life, you'll get a TCP socket.
 297  */
 298 xbt_error_t
 299 gras_socket_client(const char *host,
 300                    unsigned short port,
 301                    /* OUT */ gras_socket_t *dst) {
 302    return gras_socket_client_ext(host,port,32,0,dst);
 303 }
 304
 305
 306 void gras_socket_close(gras_socket_t sock) {
 307   xbt_dynar_t sockets = gras_socketset_get();
 308   gras_socket_t sock_iter;
 309   int cursor;
 310
 311   XBT_IN;
 312   /* FIXME: Issue an event when the socket is closed */
 313   if (sock) {
 314     xbt_dynar_foreach(sockets,cursor,sock_iter) {
 315       if (sock == sock_iter) {
 316         xbt_dynar_cursor_rm(sockets,&cursor);
 317         if (sock->plugin->socket_close)
 318           (* sock->plugin->socket_close)(sock);
 319
 320         /* free the memory */
 321         if (sock->peer_name)
 322           free(sock->peer_name);
 323         free(sock);
 324         XBT_OUT;
 325         return;
 326       }
 327     }
 328     WARN1("Ignoring request to free an unknown socket (%p)",sock);
 329   }
 330   XBT_OUT;
 331 }
 332
 333 /**
 334  * gras_trp_chunk_send:
 335  *
 336  * Send a bunch of bytes from on socket
 337  */
 338 xbt_error_t
 339 gras_trp_chunk_send(gras_socket_t sd,
 340                     char *data,
 341                     long int size) {
 342   xbt_assert1(sd->outgoing,
 343                "Socket not suited for data send (outgoing=%c)",
 344                sd->outgoing?'y':'n');
 345   xbt_assert1(sd->plugin->chunk_send,
 346                "No function chunk_send on transport plugin %s",
 347                sd->plugin->name);
 348   return (*sd->plugin->chunk_send)(sd,data,size);
 349 }
 350 /**
 351  * gras_trp_chunk_recv:
 352  *
 353  * Receive a bunch of bytes from a socket
 354  */
 355 xbt_error_t
 356 gras_trp_chunk_recv(gras_socket_t sd,
 357                     char *data,
 358                     long int size) {
 359   xbt_assert0(sd->incoming,
 360                "Socket not suited for data receive");
 361   xbt_assert1(sd->plugin->chunk_recv,
 362                "No function chunk_recv on transport plugin %s",
 363                sd->plugin->name);
 364   return (sd->plugin->chunk_recv)(sd,data,size);
 365 }
 366
 367 /**
 368  * gras_trp_flush:
 369  *
 370  * Make sure all pending communications are done
 371  */
 372 xbt_error_t
 373 gras_trp_flush(gras_socket_t sd) {
 374   return (sd->plugin->flush)(sd);
 375 }
 376
 377 xbt_error_t
 378 gras_trp_plugin_get_by_name(const char *name,
 379                             gras_trp_plugin_t **dst){
 380
 381   return xbt_dict_get(_gras_trp_plugins,name,(void**)dst);
 382 }
 383
 384 int   gras_socket_my_port  (gras_socket_t sock) {
 385   return sock->port;
 386 }
 387 int   gras_socket_peer_port(gras_socket_t sock) {
 388   return sock->peer_port;
 389 }
 390 char *gras_socket_peer_name(gras_socket_t sock) {
 391   return sock->peer_name;
 392 }
 393
 394 xbt_error_t gras_socket_meas_send(gras_socket_t peer,
 395                                   unsigned int timeout,
 396                                   unsigned long int exp_size,
 397                                   unsigned long int msg_size) {
 398   xbt_error_t errcode;
 399   char *chunk = xbt_malloc0(msg_size);
 400   unsigned long int exp_sofar;
 401
 402   XBT_CIN(trp_meas);
 403
 404   xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
 405
 406   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 407      CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
 408              exp_sofar,exp_size,msg_size,
 409              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 410      TRY(gras_trp_chunk_send(peer,chunk,msg_size));
 411   }
 412   CDEBUG5(trp_meas,"Sent %lu of %lu (msg_size=%ld) to %s:%d",
 413           exp_sofar,exp_size,msg_size,
 414           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 415
 416   free(chunk);
 417
 418   XBT_COUT(trp_meas);
 419   return no_error;
 420 }
 421
 422 xbt_error_t gras_socket_meas_recv(gras_socket_t peer,
 423                                   unsigned int timeout,
 424                                   unsigned long int exp_size,
 425                                   unsigned long int msg_size){
 426
 427   xbt_error_t errcode;
 428   char *chunk = xbt_malloc(msg_size);
 429   unsigned long int exp_sofar;
 430
 431   XBT_CIN(trp_meas);
 432
 433   xbt_assert0(peer->meas,"Asked to receive measurement data on a regular socket\n");
 434
 435   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 436      CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
 437              exp_sofar,exp_size,msg_size,
 438              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 439      TRY(gras_trp_chunk_recv(peer,chunk,msg_size));
 440   }
 441   CDEBUG5(trp_meas,"Recvd %ld of %lu (msg_size=%ld) from %s:%d",
 442           exp_sofar,exp_size,msg_size,
 443           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 444
 445   free(chunk);
 446   XBT_COUT(trp_meas);
 447
 448   return no_error;
 449 }
 450
 451 /**
 452  * \brief Something similar to the good old accept system call.
 453  *
 454  * Make sure that there is someone speaking to the provided server socket.
 455  * In RL, it does an accept(2), close the master socket, and put the accepted
 456  * socket in place of the provided one. In SG, it does not do anything for
 457  *
 458  * You should only call this on measurement sockets. It is automatically
 459  * done for regular sockets, but you usually want more control about
 460  * what's going on with measurement sockets.
 461  *
 462  *
 463  */
 464 xbt_error_t gras_socket_meas_accept(gras_socket_t peer, gras_socket_t *accepted){
 465   xbt_error_t errcode;
 466   gras_socket_t res;
 467
 468   xbt_assert0(peer->meas,
 469               "No need to accept on non-measurement sockets (it's automatic)");
 470
 471   if (!peer->accepting) {
 472     /* nothing to accept here */
 473     *accepted=peer;
 474     return no_error;
 475   }
 476
 477   TRY((peer->plugin->socket_accept)(peer,accepted));
 478   (*accepted)->meas = peer->meas;
 479   CDEBUG1(trp_meas,"meas_accepted onto %d",(*accepted)->sd);
 480
 481   return no_error;
 482 }
 483
 484
 485 /*
 486  * Creating procdata for this module
 487  */
 488 static void *gras_trp_procdata_new() {
 489    gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
 490
 491    res->sockets   = xbt_dynar_new(sizeof(gras_socket_t*), NULL);
 492
 493    return (void*)res;
 494 }
 495
 496 /*
 497  * Freeing procdata for this module
 498  */
 499 static void gras_trp_procdata_free(void *data) {
 500    gras_trp_procdata_t res = (gras_trp_procdata_t)data;
 501
 502    xbt_dynar_free(&( res->sockets ));
 503    free(res);
 504 }
 505
 506 /*
 507  * Module registration
 508  */
 509 void gras_trp_register() {
 510    gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
 511 }
 512
 513
 514 xbt_dynar_t
 515 gras_socketset_get(void) {
 516    /* FIXME: KILLME */
 517    return ((gras_trp_procdata_t) gras_libdata_get("gras_trp"))->sockets;
 518 }