src/gras/Transport/transport_plugin_buf.c

   1 /* $Id$ */
   2
   3 /* buf trp (transport) - buffered transport using the TCP one            */
   4
   5 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2004 Martin Quinson.                                       */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9    under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #include <netinet/in.h>   /* htonl/ntohl */
  12 #include <stdlib.h>
  13 #include <string.h>       /* memset */
  14
  15 #include "gras_private.h"
  16 #include "transport_private.h"
  17
  18 GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(trp_buf,transport);
  19
  20 /***
  21  *** Prototypes
  22  ***/
  23 gras_error_t gras_trp_buf_socket_client(gras_trp_plugin_t *self,
  24                                         const char *host,
  25                                         unsigned short port,
  26                                         /* OUT */ gras_socket_t *sock);
  27 gras_error_t gras_trp_buf_socket_server(gras_trp_plugin_t *self,
  28                                         unsigned short port,
  29                                         /* OUT */ gras_socket_t *sock);
  30 gras_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 gras_error_t gras_trp_buf_chunk_send(gras_socket_t *sd,
  36                                      const char *data,
  37                                      long int size);
  38
  39 gras_error_t gras_trp_buf_chunk_recv(gras_socket_t *sd,
  40                                      char *data,
  41                                      long int size);
  42 gras_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   uint32_t 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 gras_error_t gras_trp_buf_init_sock(gras_socket_t *sock) {
  70   gras_trp_bufdata_t *data=malloc(sizeof(gras_trp_bufdata_t));
  71
  72   GRAS_IN;
  73   if (!data)
  74     RAISE_MALLOC;
  75   data->in.size  = 0;
  76   //  data->buffsize = 32 * 1024 - 4; /* default socket buffsize (32k) - headers */
  77   data->buffsize = 100 * 1024 ; /* 100k */
  78
  79   if (!(data->in.data = malloc(data->buffsize)))
  80     RAISE_MALLOC;
  81   data->in.pos   = 0; /* useless, indeed, since size==pos */
  82   data->out.size = 0;
  83   if (!(data->out.data = malloc(data->buffsize)))
  84     RAISE_MALLOC;
  85   data->out.pos  = 0;
  86   sock->bufdata = data;
  87   return no_error;
  88 }
  89
  90
  91 /***
  92  *** Code
  93  ***/
  94 gras_error_t
  95 gras_trp_buf_setup(gras_trp_plugin_t *plug) {
  96   gras_error_t errcode;
  97   gras_trp_buf_plug_data_t *data =malloc(sizeof(gras_trp_buf_plug_data_t));
  98   if (!data)
  99     RAISE_MALLOC;
 100
 101   GRAS_IN;
 102   TRY(gras_trp_plugin_get_by_name(gras_if_RL() ? "tcp" : "sg",
 103                                   &(data->super)));
 104   DEBUG1("Derivate a buffer plugin from %s",gras_if_RL() ? "tcp" : "sg");
 105
 106   plug->socket_client = gras_trp_buf_socket_client;
 107   plug->socket_server = gras_trp_buf_socket_server;
 108   plug->socket_accept = gras_trp_buf_socket_accept;
 109   plug->socket_close  = gras_trp_buf_socket_close;
 110
 111   plug->chunk_send    = gras_trp_buf_chunk_send;
 112   plug->chunk_recv    = gras_trp_buf_chunk_recv;
 113
 114   plug->flush         = gras_trp_buf_flush;
 115
 116   plug->data = (void*)data;
 117   plug->exit = NULL;
 118
 119   return no_error;
 120 }
 121
 122 gras_error_t gras_trp_buf_socket_client(gras_trp_plugin_t *self,
 123                                         const char *host,
 124                                         unsigned short port,
 125                                         /* OUT */ gras_socket_t *sock){
 126   gras_error_t errcode;
 127   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)self->data)->super;
 128
 129   GRAS_IN;
 130   TRY(super->socket_client(super,host,port,sock));
 131   sock->plugin = self;
 132   TRY(gras_trp_buf_init_sock(sock));
 133
 134   return no_error;
 135 }
 136
 137 /**
 138  * gras_trp_buf_socket_server:
 139  *
 140  * Open a socket used to receive messages.
 141  */
 142 gras_error_t gras_trp_buf_socket_server(gras_trp_plugin_t *self,
 143                                         unsigned short port,
 144                                         /* OUT */ gras_socket_t *sock){
 145   gras_error_t errcode;
 146   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)self->data)->super;
 147
 148   GRAS_IN;
 149   TRY(super->socket_server(super,port,sock));
 150   sock->plugin = self;
 151   TRY(gras_trp_buf_init_sock(sock));
 152   return no_error;
 153 }
 154
 155 gras_error_t
 156 gras_trp_buf_socket_accept(gras_socket_t  *sock,
 157                            gras_socket_t **dst) {
 158   gras_error_t errcode;
 159   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 160
 161   GRAS_IN;
 162   TRY(super->socket_accept(sock,dst));
 163   (*dst)->plugin = sock->plugin;
 164   TRY(gras_trp_buf_init_sock(*dst));
 165   return no_error;
 166 }
 167
 168 void gras_trp_buf_socket_close(gras_socket_t *sock){
 169   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 170   gras_trp_bufdata_t *data=sock->bufdata;
 171
 172   GRAS_IN;
 173   if (data->in.size || data->out.size)
 174     gras_trp_buf_flush(sock);
 175   if (data->in.data)
 176     free(data->in.data);
 177   if (data->out.data)
 178     free(data->out.data);
 179   free(data);
 180
 181   return super->socket_close(sock);
 182 }
 183
 184 /**
 185  * gras_trp_buf_chunk_send:
 186  *
 187  * Send data on a TCP socket
 188  */
 189 gras_error_t
 190 gras_trp_buf_chunk_send(gras_socket_t *sock,
 191                         const char *chunk,
 192                         long int size) {
 193
 194   gras_error_t errcode;
 195   gras_trp_bufdata_t *data=(gras_trp_bufdata_t*)sock->bufdata;
 196   int chunk_pos=0;
 197
 198   GRAS_IN;
 199   /* Let underneath plugin check for direction, we work even in duplex */
 200   gras_assert0(size >= 0, "Cannot send a negative amount of data");
 201
 202   while (chunk_pos < size) {
 203     /* size of the chunck to receive in that shot */
 204     long int thissize = min(size-chunk_pos,data->buffsize - data->out.size);
 205     DEBUG5("Set the chars %d..%ld into the buffer (size=%ld, ctn='%.*s')",
 206            (int)data->out.size,
 207            ((int)data->out.size) + thissize -1,
 208            size, chunk_pos, chunk);
 209
 210     memcpy(data->out.data + data->out.size, chunk + chunk_pos, thissize);
 211
 212     data->out.size += thissize;
 213     chunk_pos      += thissize;
 214     DEBUG5("New pos = %d; Still to send = %ld of %ld; ctn sofar='%.*s'",
 215            data->out.size,size-chunk_pos,size,(int)chunk_pos,chunk);
 216
 217     if (data->out.size == data->buffsize) /* out of space. Flush it */
 218       TRY(gras_trp_buf_flush(sock));
 219   }
 220
 221   GRAS_OUT;
 222   return no_error;
 223 }
 224
 225 /**
 226  * gras_trp_buf_chunk_recv:
 227  *
 228  * Receive data on a TCP socket.
 229  */
 230 gras_error_t
 231 gras_trp_buf_chunk_recv(gras_socket_t *sock,
 232                         char *chunk,
 233                         long int size) {
 234
 235   gras_error_t errcode;
 236   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 237   gras_trp_bufdata_t *data=sock->bufdata;
 238   long int chunck_pos = 0;
 239
 240   /* Let underneath plugin check for direction, we work even in duplex */
 241   gras_assert0(sock, "Cannot recv on an NULL socket");
 242   gras_assert0(size >= 0, "Cannot receive a negative amount of data");
 243
 244   GRAS_IN;
 245
 246   while (chunck_pos < size) {
 247     /* size of the chunck to receive in that shot */
 248     long int thissize;
 249
 250     if (data->in.size == data->in.pos) { /* out of data. Get more */
 251       uint32_t nextsize;
 252       DEBUG0("Recv the size");
 253       TRY(super->chunk_recv(sock,(char*)&nextsize, 4));
 254       data->in.size = ntohl(nextsize);
 255
 256       VERB1("Recv the chunk (size=%d)",data->in.size);
 257       TRY(super->chunk_recv(sock, data->in.data, data->in.size));
 258       data->in.pos=0;
 259     }
 260
 261     thissize = min(size-chunck_pos ,  data->in.size - data->in.pos);
 262     DEBUG2("Get the chars %d..%ld out of the buffer",
 263            data->in.pos,
 264            data->in.pos + thissize - 1);
 265     memcpy(chunk+chunck_pos, data->in.data + data->in.pos, thissize);
 266
 267     data->in.pos += thissize;
 268     chunck_pos   += thissize;
 269     DEBUG5("New pos = %d; Still to receive = %ld of %ld. Ctn so far='%.*s'",
 270            data->in.pos,size - chunck_pos,size,(int)chunck_pos,chunk);
 271   }
 272
 273   GRAS_OUT;
 274   return no_error;
 275 }
 276
 277 /**
 278  * gras_trp_buf_flush:
 279  *
 280  * Make sure the data is sent
 281  */
 282 gras_error_t
 283 gras_trp_buf_flush(gras_socket_t *sock) {
 284   gras_error_t errcode;
 285   uint32_t size;
 286   gras_trp_plugin_t *super=((gras_trp_buf_plug_data_t*)sock->plugin->data)->super;
 287   gras_trp_bufdata_t *data=sock->bufdata;
 288
 289   GRAS_IN;
 290   size = htonl(data->out.size);
 291   DEBUG1("Send the size (=%d)",data->out.size);
 292   TRY(super->chunk_send(sock,(char*) &size, 4));
 293
 294   DEBUG1("Send the chunk (size=%d)",data->out.size);
 295   TRY(super->chunk_send(sock, data->out.data, data->out.size));
 296   VERB1("Chunk sent (size=%d)",data->out.size);
 297   data->out.size = 0;
 298   return no_error;
 299 }