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(meas_trp,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("buf",&trp));
 201
 202   /* defaults settings */
 203   gras_trp_socket_new(1,&sock);
 204   sock->plugin= trp;
 205   sock->port=port;
 206   sock->bufSize = bufSize;
 207   sock->meas = measurement;
 208
 209   /* Call plugin socket creation function */
 210   DEBUG1("Prepare socket with plugin (fct=%p)",trp->socket_server);
 211   errcode = 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
 217   if (errcode != no_error) {
 218     free(sock);
 219     return errcode;
 220   }
 221
 222   *dst = sock;
 223
 224   return no_error;
 225 }
 226
 227 /**
 228  * gras_socket_client_ext:
 229  *
 230  * Opens a client socket to a remote host.
 231  * In real life, you'll get a TCP socket.
 232  */
 233 xbt_error_t
 234 gras_socket_client_ext(const char *host,
 235                        unsigned short port,
 236
 237                        unsigned long int bufSize,
 238                        int meas,
 239
 240                        /* OUT */ gras_socket_t *dst) {
 241
 242   xbt_error_t errcode;
 243   gras_trp_plugin_t *trp;
 244   gras_socket_t sock;
 245
 246   *dst = NULL;
 247
 248   TRY(gras_trp_plugin_get_by_name("buf",&trp));
 249
 250   DEBUG1("Create a client socket from plugin %s",gras_if_RL() ? "tcp" : "sg");
 251   /* defaults settings */
 252   gras_trp_socket_new(0,&sock);
 253   sock->plugin= trp;
 254   sock->peer_port = port;
 255   sock->peer_name = (char*)strdup(host?host:"localhost");
 256   sock->bufSize = bufSize;
 257   sock->meas = meas;
 258
 259   /* plugin-specific */
 260   errcode= (*trp->socket_client)(trp, sock);
 261   DEBUG3("in=%c out=%c accept=%c",
 262          sock->incoming?'y':'n',
 263          sock->outgoing?'y':'n',
 264          sock->accepting?'y':'n');
 265
 266   if (errcode != no_error) {
 267     free(sock);
 268     return errcode;
 269   }
 270
 271   *dst = sock;
 272
 273   return no_error;
 274 }
 275
 276 /**
 277  * gras_socket_server:
 278  *
 279  * Opens a server socket and make it ready to be listened to.
 280  * In real life, you'll get a TCP socket.
 281  */
 282 xbt_error_t
 283 gras_socket_server(unsigned short port,
 284                    /* OUT */ gras_socket_t *dst) {
 285    return gras_socket_server_ext(port,32,0,dst);
 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 xbt_error_t
 295 gras_socket_client(const char *host,
 296                    unsigned short port,
 297                    /* OUT */ gras_socket_t *dst) {
 298    return gras_socket_client_ext(host,port,32,0,dst);
 299 }
 300
 301
 302 void gras_socket_close(gras_socket_t sock) {
 303   xbt_dynar_t sockets = gras_socketset_get();
 304   gras_socket_t sock_iter;
 305   int cursor;
 306
 307   XBT_IN;
 308   /* FIXME: Issue an event when the socket is closed */
 309   if (sock) {
 310     xbt_dynar_foreach(sockets,cursor,sock_iter) {
 311       if (sock == sock_iter) {
 312         xbt_dynar_cursor_rm(sockets,&cursor);
 313         if (sock->plugin->socket_close)
 314           (* sock->plugin->socket_close)(sock);
 315
 316         /* free the memory */
 317         if (sock->peer_name)
 318           free(sock->peer_name);
 319         free(sock);
 320         XBT_OUT;
 321         return;
 322       }
 323     }
 324     WARN1("Ignoring request to free an unknown socket (%p)",sock);
 325   }
 326   XBT_OUT;
 327 }
 328
 329 /**
 330  * gras_trp_chunk_send:
 331  *
 332  * Send a bunch of bytes from on socket
 333  */
 334 xbt_error_t
 335 gras_trp_chunk_send(gras_socket_t sd,
 336                     char *data,
 337                     long int size) {
 338   xbt_assert1(sd->outgoing,
 339                "Socket not suited for data send (outgoing=%c)",
 340                sd->outgoing?'y':'n');
 341   xbt_assert1(sd->plugin->chunk_send,
 342                "No function chunk_send on transport plugin %s",
 343                sd->plugin->name);
 344   return (*sd->plugin->chunk_send)(sd,data,size);
 345 }
 346 /**
 347  * gras_trp_chunk_recv:
 348  *
 349  * Receive a bunch of bytes from a socket
 350  */
 351 xbt_error_t
 352 gras_trp_chunk_recv(gras_socket_t sd,
 353                     char *data,
 354                     long int size) {
 355   xbt_assert0(sd->incoming,
 356                "Socket not suited for data receive");
 357   xbt_assert1(sd->plugin->chunk_recv,
 358                "No function chunk_recv on transport plugin %s",
 359                sd->plugin->name);
 360   return (sd->plugin->chunk_recv)(sd,data,size);
 361 }
 362
 363 /**
 364  * gras_trp_flush:
 365  *
 366  * Make sure all pending communications are done
 367  */
 368 xbt_error_t
 369 gras_trp_flush(gras_socket_t sd) {
 370   return (sd->plugin->flush)(sd);
 371 }
 372
 373 xbt_error_t
 374 gras_trp_plugin_get_by_name(const char *name,
 375                             gras_trp_plugin_t **dst){
 376
 377   return xbt_dict_get(_gras_trp_plugins,name,(void**)dst);
 378 }
 379
 380 int   gras_socket_my_port  (gras_socket_t sock) {
 381   return sock->port;
 382 }
 383 int   gras_socket_peer_port(gras_socket_t sock) {
 384   return sock->peer_port;
 385 }
 386 char *gras_socket_peer_name(gras_socket_t sock) {
 387   return sock->peer_name;
 388 }
 389
 390 xbt_error_t gras_socket_meas_send(gras_socket_t peer,
 391                                   unsigned int timeout,
 392                                   unsigned long int exp_size,
 393                                   unsigned long int msg_size) {
 394   xbt_error_t errcode;
 395   char *chunk = xbt_malloc(msg_size);
 396   int exp_sofar;
 397
 398   XBT_IN;
 399   xbt_assert0(peer->meas,"Asked to send measurement data on a regular socket");
 400   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 401      CDEBUG5(meas_trp,"Sent %d of %lu (msg_size=%ld) to %s:%d",
 402              exp_sofar,exp_size,msg_size,
 403              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 404      TRY(gras_trp_chunk_send(peer,chunk,msg_size));
 405   }
 406   CDEBUG5(meas_trp,"Sent %d of %lu (msg_size=%ld) to %s:%d",
 407           exp_sofar,exp_size,msg_size,
 408           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 409
 410   free(chunk);
 411   XBT_OUT;
 412   return no_error;/* gras_socket_meas_exchange(peer,1,timeout,expSize,msgSize);    */
 413 }
 414
 415 xbt_error_t gras_socket_meas_recv(gras_socket_t peer,
 416                                   unsigned int timeout,
 417                                   unsigned long int exp_size,
 418                                   unsigned long int msg_size){
 419
 420   xbt_error_t errcode;
 421   char *chunk = xbt_malloc(msg_size);
 422   int exp_sofar;
 423
 424   XBT_IN;
 425   xbt_assert0(peer->meas,"Asked to receive measurement data on a regular socket\n");
 426   for (exp_sofar=0; exp_sofar < exp_size; exp_sofar += msg_size) {
 427      CDEBUG5(meas_trp,"Recvd %d of %lu (msg_size=%ld) from %s:%d",
 428              exp_sofar,exp_size,msg_size,
 429              gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 430      TRY(gras_trp_chunk_recv(peer,chunk,msg_size));
 431   }
 432   CDEBUG5(meas_trp,"Recvd %d of %lu (msg_size=%ld) from %s:%d",
 433           exp_sofar,exp_size,msg_size,
 434           gras_socket_peer_name(peer), gras_socket_peer_port(peer));
 435
 436   free(chunk);
 437   XBT_OUT;
 438   return no_error;/* gras_socket_meas_exchange(peer,0,timeout,expSize,msgSize);    */
 439 }
 440
 441 /*
 442  * Creating procdata for this module
 443  */
 444 static void *gras_trp_procdata_new() {
 445    gras_trp_procdata_t res = xbt_new(s_gras_trp_procdata_t,1);
 446
 447    res->sockets   = xbt_dynar_new(sizeof(gras_socket_t*), NULL);
 448
 449    return (void*)res;
 450 }
 451
 452 /*
 453  * Freeing procdata for this module
 454  */
 455 static void gras_trp_procdata_free(void *data) {
 456    gras_trp_procdata_t res = (gras_trp_procdata_t)data;
 457
 458    xbt_dynar_free(&( res->sockets ));
 459    free(res);
 460 }
 461
 462 /*
 463  * Module registration
 464  */
 465 void gras_trp_register() {
 466    gras_procdata_add("gras_trp",gras_trp_procdata_new, gras_trp_procdata_free);
 467 }
 468
 469
 470 xbt_dynar_t
 471 gras_socketset_get(void) {
 472    /* FIXME: KILLME */
 473    return ((gras_trp_procdata_t) gras_libdata_get("gras_trp"))->sockets;
 474 }