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  *** Prototypes
  23  ***/
  24 hexa_print(const char*name, unsigned char *data, int size);   /* in gras.c */
  25
  26 xbt_error_t gras_trp_buf_socket_client(gras_trp_plugin_t *self,
  27                                         gras_socket_t sock);
  28 xbt_error_t gras_trp_buf_socket_server(gras_trp_plugin_t *self,
  29                                         gras_socket_t sock);
  30 xbt_error_t gras_trp_buf_socket_accept(gras_socket_t sock,
  31                                         gras_socket_t *dst);
  32
  33 void         gras_trp_buf_socket_close(gras_socket_t sd);
  34
  35 xbt_error_t gras_trp_buf_chunk_send(gras_socket_t sd,
  36                                      const char *data,
  37                                      long int size);
  38
  39 xbt_error_t gras_trp_buf_chunk_recv(gras_socket_t sd,
  40                                      char *data,
  41                                      long int size);
  42 xbt_error_t gras_trp_buf_flush(gras_socket_t sock);
  43
  44
  45 /***
  46  *** Specific plugin part
  47  ***/
  48
  49 typedef struct {
  50   gras_trp_plugin_t *super;
  51 } gras_trp_buf_plug_data_t;
  52
  53 /***
  54  *** Specific socket part
  55  ***/
  56
  57 typedef struct {
  58   int size;
  59   char *data;
  60   int pos; /* for receive; not exchanged over the net */
  61 } gras_trp_buf_t;
  62
  63 struct gras_trp_bufdata_{
  64   gras_trp_buf_t in;
  65   gras_trp_buf_t out;
  66   int buffsize;
  67 };
  68
  69 void gras_trp_buf_init_sock(gras_socket_t sock) {
  70   gras_trp_bufdata_t *data=xbt_new(gras_trp_bufdata_t,1);
  71
  72   XBT_IN;
  73   data->buffsize = 100 * 1024 ; /* 100k */
  74
  75   data->in.size  = 0;
  76   data->in.data  = xbt_malloc(data->buffsize);
  77   data->in.pos   = 0; /* useless, indeed, since size==pos */
  78
  79    /* In SG, the 4 first bytes are for the chunk size as htonl'ed, so that we can send it in one shoot.
  80     * This is mandatory in SG because all emissions go to the same channel, so if we split them,
  81     * they can get mixed. */
  82   data->out.size = gras_if_RL()?0:4;
  83   data->out.data = xbt_malloc(data->buffsize);
  84   data->out.pos  = data->out.size;
  85
  86   sock->bufdata = data;
  87 }
  88
  89
  90 /***
  91  *** Code
  92  ***/
  93 xbt_error_t
  94 gras_trp_buf_setup(gras_trp_plugin_t *plug) {
  95   xbt_error_t errcode;
  96   gras_trp_buf_plug_data_t *data =xbt_new(gras_trp_buf_plug_data_t,1);
  97
  98   XBT_IN;
  99   TRY(gras_trp_plugin_get_by_name(gras_if_RL() ? "tcp" : "sg",
 100                                   &(data->super)));
 101   DEBUG1("Derivate a buffer plugin from %s",gras_if_RL() ? "tcp" : "sg");
 102
 103   plug->socket_client = gras_trp_buf_socket_client;
 104   plug->socket_server = gras_trp_buf_socket_server;
 105   plug->socket_accept = gras_trp_buf_socket_accept;
 106   plug->socket_close  = gras_trp_buf_socket_close;
 107
 108   plug->chunk_send    = gras_trp_buf_chunk_send;
 109   plug->chunk_recv    = gras_trp_buf_chunk_recv;
 110
 111   plug->flush         = gras_trp_buf_flush;
 112
 113   plug->data = (void*)data;
 114   plug->exit = NULL;
 115
 116   return no_error;
 117 }
 118
 119 xbt_error_t gras_trp_buf_socket_client(gras_trp_plugin_t *self,
 120                                         /* OUT */ gras_socket_t sock){
 121   xbt_error_t errcode;
 122   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)self->data)->super;
 123
 124   XBT_IN;
 125   TRY(super->socket_client(super,sock));
 126   sock->plugin = self;
 127   gras_trp_buf_init_sock(sock);
 128
 129   return no_error;
 130 }
 131
 132 /**
 133  * gras_trp_buf_socket_server:
 134  *
 135  * Open a socket used to receive messages.
 136  */
 137 xbt_error_t gras_trp_buf_socket_server(gras_trp_plugin_t *self,
 138                                         /* OUT */ gras_socket_t sock){
 139   xbt_error_t errcode;
 140   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)self->data)->super;
 141
 142   XBT_IN;
 143   TRY(super->socket_server(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   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 154
 155   XBT_IN;
 156   TRY(super->socket_accept(sock,dst));
 157   (*dst)->plugin = sock->plugin;
 158   gras_trp_buf_init_sock(*dst);
 159   XBT_OUT;
 160   return no_error;
 161 }
 162
 163 void gras_trp_buf_socket_close(gras_socket_t sock){
 164   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 165   gras_trp_bufdata_t *data=sock->bufdata;
 166
 167   XBT_IN;
 168   if (data->in.size!=data->in.pos) {
 169      WARN1("Socket closed, but %d bytes were unread",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   super->socket_close(sock);
 184 }
 185
 186 /**
 187  * gras_trp_buf_chunk_send:
 188  *
 189  * Send data on a TCP socket
 190  */
 191 xbt_error_t
 192 gras_trp_buf_chunk_send(gras_socket_t sock,
 193                         const char *chunk,
 194                         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 TCP socket.
 231  */
 232 xbt_error_t
 233 gras_trp_buf_chunk_recv(gras_socket_t sock,
 234                         char *chunk,
 235                         long int size) {
 236
 237   xbt_error_t errcode;
 238   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 239   gras_trp_bufdata_t *data=sock->bufdata;
 240   long int chunck_pos = 0;
 241
 242   /* Let underneath plugin check for direction, we work even in duplex */
 243   xbt_assert0(sock, "Cannot recv on an NULL socket");
 244   xbt_assert0(size >= 0, "Cannot receive a negative amount of data");
 245
 246   XBT_IN;
 247
 248   while (chunck_pos < size) {
 249     /* size of the chunck to receive in that shot */
 250     long int thissize;
 251
 252     if (data->in.size == data->in.pos) { /* out of data. Get more */
 253       int nextsize;
 254       if (gras_if_RL()) {
 255          DEBUG0("Recv the size");
 256          TRY(super->chunk_recv(sock,(char*)&nextsize, 4));
 257          data->in.size = (int)ntohl(nextsize);
 258          VERB1("Recv the chunk (size=%d)",data->in.size);
 259       } else {
 260          data->in.size = -1;
 261       }
 262
 263       TRY(super->chunk_recv(sock, data->in.data, data->in.size));
 264
 265       if (gras_if_RL()) {
 266          data->in.pos=0;
 267       } else {
 268          memcpy((char*)&nextsize,data->in.data,4);
 269          data->in.size = (int)ntohl(nextsize)+4;
 270          data->in.pos=4;
 271          VERB3("Got the chunk (size=%d+4 for the size ifself)='%.*s'",data->in.size-4,
 272                data->in.size,data->in.data);
 273          if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
 274            hexa_print("chunck received",data->in.data,data->in.size);
 275       }
 276
 277     }
 278
 279     thissize = min(size-chunck_pos ,  data->in.size - data->in.pos);
 280     DEBUG2("Get the chars %d..%ld out of the buffer",
 281            data->in.pos,
 282            data->in.pos + thissize - 1);
 283     memcpy(chunk+chunck_pos, data->in.data + data->in.pos, thissize);
 284
 285     data->in.pos += thissize;
 286     chunck_pos   += thissize;
 287     DEBUG5("New pos = %d; Still to receive = %ld of %ld. Ctn so far='%.*s'",
 288            data->in.pos,size - chunck_pos,size,(int)chunck_pos,chunk);
 289   }
 290
 291   XBT_OUT;
 292   return no_error;
 293 }
 294
 295 /**
 296  * gras_trp_buf_flush:
 297  *
 298  * Make sure the data is sent
 299  */
 300 xbt_error_t
 301 gras_trp_buf_flush(gras_socket_t sock) {
 302   xbt_error_t errcode;
 303   int size;
 304   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 305   gras_trp_bufdata_t *data=sock->bufdata;
 306
 307   XBT_IN;
 308   DEBUG0("Flush");
 309   if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
 310      hexa_print("chunck to send",data->out.data,data->out.size);
 311   if ((data->out.size - data->out.pos) == (gras_if_RL()?0:4) ) { /* 4 first bytes=size in SG mode*/
 312      DEBUG2("Nothing to flush (size=%d; pos=%d)",data->out.size,data->out.pos);
 313      return no_error;
 314   }
 315
 316   size = (int)htonl(data->out.size - data->out.pos);
 317   DEBUG4("%s the size (=%d) to %s:%d",(gras_if_RL()?"Send":"Embeed"),data->out.size-data->out.pos,
 318          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 319   if (gras_if_RL()) {
 320      TRY(super->chunk_send(sock,(char*) &size, 4));
 321   } else {
 322      memcpy(data->out.data, &size, 4);
 323   }
 324
 325
 326   DEBUG3("Send the chunk (size=%d) to %s:%d",data->out.size,
 327          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 328   TRY(super->chunk_send(sock, data->out.data, data->out.size));
 329   VERB1("Chunk sent (size=%d)",data->out.size);
 330   if (XBT_LOG_ISENABLED(trp_buf,xbt_log_priority_debug))
 331      hexa_print("chunck sent",data->out.data,data->out.size);
 332   data->out.size = 0;
 333   return no_error;
 334 }