src/gras/Transport/transport_plugin_buf.c

   1 /* $Id$ */
   2
   3 /* buf trp (transport) - buffered transport using the TCP one            */
   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 <stdlib.h>
  11 #include <string.h>       /* memset */
  12
  13 #include "portable.h"
  14 #include "xbt/misc.h"
  15 #include "xbt/sysdep.h"
  16 #include "transport_private.h"
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(trp_buf,transport,
  19       "Generic buffered transport (works on top of TCP or SG)");
  20
  21
  22 static gras_trp_plugin_t _buf_super;
  23
  24 /***
  25  *** Prototypes
  26  ***/
  27 void hexa_print(const char*name, unsigned char *data, int size);   /* in gras.c */
  28
  29 xbt_error_t gras_trp_buf_socket_client(gras_trp_plugin_t self,
  30                                         gras_socket_t sock);
  31 xbt_error_t gras_trp_buf_socket_server(gras_trp_plugin_t self,
  32                                         gras_socket_t sock);
  33 xbt_error_t gras_trp_buf_socket_accept(gras_socket_t sock,
  34                                         gras_socket_t *dst);
  35
  36 void         gras_trp_buf_socket_close(gras_socket_t sd);
  37
  38 xbt_error_t gras_trp_buf_chunk_send(gras_socket_t sd,
  39                                     const char *data,
  40                                     unsigned long int size);
  41
  42 xbt_error_t gras_trp_buf_chunk_recv(gras_socket_t sd,
  43                                     char *data,
  44                                     unsigned long int size);
  45 xbt_error_t gras_trp_buf_flush(gras_socket_t sock);
  46
  47
  48 /***
  49  *** Specific plugin part
  50  ***/
  51
  52 typedef struct {
  53   int junk;
  54 } gras_trp_buf_plug_data_t;
  55
  56 /***
  57  *** Specific socket part
  58  ***/
  59
  60 typedef struct {
  61   int size;
  62   char *data;
  63   int pos; /* for receive; not exchanged over the net */
  64 } gras_trp_buf_t;
  65
  66 struct gras_trp_bufdata_{
  67   gras_trp_buf_t in;
  68   gras_trp_buf_t out;
  69   int buffsize;
  70 };
  71
  72 void gras_trp_buf_init_sock(gras_socket_t sock) {
  73   gras_trp_bufdata_t *data=xbt_new(gras_trp_bufdata_t,1);
  74
  75   XBT_IN;
  76   data->buffsize = 100 * 1024 ; /* 100k */
  77
  78   data->in.size  = 0;
  79   data->in.data  = xbt_malloc(data->buffsize);
  80   data->in.pos   = 0; /* useless, indeed, since size==pos */
  81
  82    /* In SG, the 4 first bytes are for the chunk size as htonl'ed, so that we can send it in one shoot.
  83     * This is mandatory in SG because all emissions go to the same channel, so if we split them,
  84     * they can get mixed. */
  85   data->out.size = gras_if_RL()?0:4;
  86   data->out.data = xbt_malloc(data->buffsize);
  87   data->out.pos  = data->out.size;
  88
  89   sock->bufdata = data;
  90 }
  91
  92 /***
  93  *** Code
  94  ***/
  95 xbt_error_t
  96 gras_trp_buf_setup(gras_trp_plugin_t plug) {
  97   xbt_error_t errcode;
  98   gras_trp_buf_plug_data_t *data =xbt_new(gras_trp_buf_plug_data_t,1);
  99
 100   XBT_IN;
 101   TRY(gras_trp_plugin_get_by_name(gras_if_RL() ? "tcp" : "sg",
 102                                   &_buf_super));
 103   DEBUG1("Derivate a buffer plugin from %s",gras_if_RL() ? "tcp" : "sg");
 104
 105   plug->socket_client = gras_trp_buf_socket_client;
 106   plug->socket_server = gras_trp_buf_socket_server;
 107   plug->socket_accept = gras_trp_buf_socket_accept;
 108   plug->socket_close  = gras_trp_buf_socket_close;
 109
 110   plug->chunk_send    = gras_trp_buf_chunk_send;
 111   plug->chunk_recv    = gras_trp_buf_chunk_recv;
 112
 113   plug->flush         = gras_trp_buf_flush;
 114
 115   plug->data = (void*)data;
 116   plug->exit = NULL;
 117
 118   return no_error;
 119 }
 120
 121 xbt_error_t gras_trp_buf_socket_client(gras_trp_plugin_t self,
 122                                         /* OUT */ gras_socket_t sock){
 123   xbt_error_t errcode;
 124
 125   XBT_IN;
 126   TRY(_buf_super->socket_client(_buf_super,sock));
 127   sock->plugin = self;
 128   gras_trp_buf_init_sock(sock);
 129
 130   return no_error;
 131 }
 132
 133 /**
 134  * gras_trp_buf_socket_server:
 135  *
 136  * Open a socket used to receive messages.
 137  */
 138 xbt_error_t gras_trp_buf_socket_server(gras_trp_plugin_t self,
 139                                         /* OUT */ gras_socket_t sock){
 140   xbt_error_t errcode;
 141
 142   XBT_IN;
 143   TRY(_buf_super->socket_server(_buf_super,sock));
 144   sock->plugin = self;
 145   gras_trp_buf_init_sock(sock);
 146   return no_error;
 147 }
 148
 149 xbt_error_t
 150 gras_trp_buf_socket_accept(gras_socket_t  sock,
 151                            gras_socket_t *dst) {
 152   xbt_error_t errcode;
 153
 154   XBT_IN;
 155   TRY(_buf_super->socket_accept(sock,dst));
 156   (*dst)->plugin = sock->plugin;
 157   gras_trp_buf_init_sock(*dst);
 158   XBT_OUT;
 159   return no_error;
 160 }
 161
 162 void gras_trp_buf_socket_close(gras_socket_t sock){
 163   xbt_error_t errcode;
 164   gras_trp_bufdata_t *data=sock->bufdata;
 165
 166   XBT_IN;
 167   if (data->in.size!=data->in.pos) {
 168      WARN3("Socket closed, but %d bytes were unread (size=%d,pos=%d)",
 169            data->in.size - data->in.pos,data->in.size, data->in.pos);
 170   }
 171
 172   if (data->out.size!=data->out.pos) {
 173     DEBUG2("Flush the socket before closing (in=%d,out=%d)",data->in.size, data->out.size);
 174     gras_trp_buf_flush(sock);
 175   }
 176
 177   if (data->in.data)
 178     free(data->in.data);
 179   if (data->out.data)
 180     free(data->out.data);
 181   free(data);
 182
 183   _buf_super->socket_close(sock);
 184 }
 185
 186 /**
 187  * gras_trp_buf_chunk_send:
 188  *
 189  * Send data on a buffered socket
 190  */
 191 xbt_error_t
 192 gras_trp_buf_chunk_send(gras_socket_t sock,
 193                         const char *chunk,
 194                         unsigned long int size) {
 195
 196   xbt_error_t errcode;
 197   gras_trp_bufdata_t *data=(gras_trp_bufdata_t*)sock->bufdata;
 198   int chunk_pos=0;
 199
 200   XBT_IN;
 201   /* Let underneath plugin check for direction, we work even in duplex */
 202   xbt_assert0(size >= 0, "Cannot send a negative amount of data");
 203
 204   while (chunk_pos < size) {
 205     /* size of the chunck to receive in that shot */
 206     long int thissize = min(size-chunk_pos,data->buffsize - data->out.size);
 207     DEBUG5("Set the chars %d..%ld into the buffer (size=%ld, ctn='%.*s')",
 208            (int)data->out.size,
 209            ((int)data->out.size) + thissize -1,
 210            size, chunk_pos, chunk);
 211
 212     memcpy(data->out.data + data->out.size, chunk + chunk_pos, thissize);
 213
 214     data->out.size += thissize;
 215     chunk_pos      += thissize;
 216     DEBUG5("New pos = %d; Still to send = %ld of %ld; ctn sofar='%.*s'",
 217            data->out.size,size-chunk_pos,size,(int)chunk_pos,chunk);
 218
 219     if (data->out.size == data->buffsize) /* out of space. Flush it */
 220       TRY(gras_trp_buf_flush(sock));
 221   }
 222
 223   XBT_OUT;
 224   return no_error;
 225 }
 226
 227 /**
 228  * gras_trp_buf_chunk_recv:
 229  *
 230  * Receive data on a buffered socket.
 231  */
 232 xbt_error_t
 233 gras_trp_buf_chunk_recv(gras_socket_t sock,
 234                         char *chunk,
 235                         unsigned long int size) {
 236
 237   xbt_error_t errcode;
 238   gras_trp_bufdata_t *data=sock->bufdata;
 239   long int chunck_pos = 0;
 240
 241   /* Let underneath plugin check for direction, we work even in duplex */
 242   xbt_assert0(sock, "Cannot recv on an NULL socket");
 243   xbt_assert0(size >= 0, "Cannot receive a negative amount of data");
 244
 245   XBT_IN;
 246
 247   while (chunck_pos < size) {
 248     /* size of the chunck to receive in that shot */
 249     long int thissize;
 250
 251     if (data->in.size == data->in.pos) { /* out of data. Get more */
 252       int nextsize;
 253       if (gras_if_RL()) {
 254          DEBUG0("Recv the size");
 255          errcode=_buf_super->chunk_recv(sock,(char*)&nextsize, 4);
 256          if (errcode!=no_error)
 257            RAISE4(errcode,"Got '%s' while trying to get the chunk size on %p (peer = %s:%d)",
 258                   xbt_error_name(errcode),sock,gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 259          data->in.size = (int)ntohl(nextsize);
 260          VERB1("Recv the chunk (size=%d)",data->in.size);
 261       } else {
 262          data->in.size = -1;
 263       }
 264
 265       TRY(_buf_super->chunk_recv(sock, data->in.data, data->in.size));
 266
 267       if (gras_if_RL()) {
 268          data->in.pos=0;
 269       } else {
 270          memcpy((char*)&nextsize,data->in.data,4);
 271          data->in.size = nextsize+4;
 272          data->in.pos=4;
 273          VERB3("Got the chunk (size=%d+4 for the size ifself)='%.*s'",
 274                data->in.size-4, data->in.size,data->in.data);
 275          if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
 276            hexa_print("chunck received",data->in.data,data->in.size);
 277       }
 278
 279     }
 280
 281     thissize = min(size-chunck_pos ,  data->in.size - data->in.pos);
 282     DEBUG2("Get the chars %d..%ld out of the buffer",
 283            data->in.pos,
 284            data->in.pos + thissize - 1);
 285     memcpy(chunk+chunck_pos, data->in.data + data->in.pos, thissize);
 286
 287     data->in.pos += thissize;
 288     chunck_pos   += thissize;
 289     DEBUG5("New pos = %d; Still to receive = %ld of %ld. Ctn so far='%.*s'",
 290            data->in.pos,size - chunck_pos,size,(int)chunck_pos,chunk);
 291   }
 292
 293   XBT_OUT;
 294   return no_error;
 295 }
 296
 297 /**
 298  * gras_trp_buf_flush:
 299  *
 300  * Make sure the data is sent
 301  */
 302 xbt_error_t
 303 gras_trp_buf_flush(gras_socket_t sock) {
 304   xbt_error_t errcode;
 305   int size;
 306   gras_trp_bufdata_t *data=sock->bufdata;
 307   XBT_IN;
 308
 309   DEBUG0("Flush");
 310   if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
 311      hexa_print("chunck to send ",data->out.data,data->out.size);
 312   if ((data->out.size - data->out.pos) == (gras_if_RL()?0:4) ) { /* 4 first bytes=size in SG mode*/
 313      DEBUG2("Nothing to flush (size=%d; pos=%d)",data->out.size,data->out.pos);
 314      return no_error;
 315   }
 316
 317   size = (int)data->out.size - data->out.pos;
 318   DEBUG4("%s the size (=%d) to %s:%d",(gras_if_RL()?"Send":"Embeed"),data->out.size-data->out.pos,
 319          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 320   if (gras_if_RL()) {
 321      size = (int)htonl(size);
 322      TRY(_buf_super->chunk_send(sock,(char*) &size, 4));
 323   } else {
 324      memcpy(data->out.data, &size, 4);
 325   }
 326
 327
 328   DEBUG3("Send the chunk (size=%d) to %s:%d",data->out.size,
 329          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 330   TRY(_buf_super->chunk_send(sock, data->out.data, data->out.size));
 331   VERB1("Chunk sent (size=%d)",data->out.size);
 332   if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
 333      hexa_print("chunck sent    ",data->out.data,data->out.size);
 334   data->out.size = gras_if_RL()?0:4;
 335   return no_error;
 336 }