src/util/server_mst.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/server_mst.c
  23  * @brief convenience functions for handling inbound message buffers
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_connection_lib.h"
  30 #include "gnunet_scheduler_lib.h"
  31 #include "gnunet_server_lib.h"
  32 #include "gnunet_time_lib.h"
  33
  34 #define DEBUG_SERVER_MST GNUNET_NO
  35
  36 #if HAVE_UNALIGNED_64_ACCESS
  37 #define ALIGN_FACTOR 4
  38 #else
  39 #define ALIGN_FACTOR 8
  40 #endif
  41
  42
  43 /**
  44  * Handle to a message stream tokenizer.
  45  */
  46 struct GNUNET_SERVER_MessageStreamTokenizer
  47 {
  48
  49   /**
  50    * Function to call on completed messages.
  51    */
  52   GNUNET_SERVER_MessageTokenizerCallback cb;
  53
  54   /**
  55    * Closure for cb.
  56    */
  57   void *cb_cls;
  58
  59   /**
  60    * Size of the buffer (starting at 'hdr').
  61    */
  62   size_t curr_buf;
  63
  64   /**
  65    * How many bytes in buffer have we already processed?
  66    */
  67   size_t off;
  68
  69   /**
  70    * How many bytes in buffer are valid right now?
  71    */
  72   size_t pos;
  73
  74   /**
  75    * Beginning of the buffer.  Typed like this to force alignment.
  76    */
  77   struct GNUNET_MessageHeader *hdr;
  78
  79 };
  80
  81
  82
  83 /**
  84  * Create a message stream tokenizer.
  85  *
  86  * @param cb function to call on completed messages
  87  * @param cb_cls closure for cb
  88  * @return handle to tokenizer
  89  */
  90 struct GNUNET_SERVER_MessageStreamTokenizer *
  91 GNUNET_SERVER_mst_create (GNUNET_SERVER_MessageTokenizerCallback cb,
  92                           void *cb_cls)
  93 {
  94   struct GNUNET_SERVER_MessageStreamTokenizer *ret;
  95
  96   ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_MessageStreamTokenizer));
  97   ret->hdr = GNUNET_malloc(GNUNET_SERVER_MIN_BUFFER_SIZE);
  98   ret->curr_buf = GNUNET_SERVER_MIN_BUFFER_SIZE;
  99   ret->cb = cb;
 100   ret->cb_cls = cb_cls;
 101   return ret;
 102 }
 103
 104
 105 /**
 106  * Add incoming data to the receive buffer and call the
 107  * callback for all complete messages.
 108  *
 109  * @param mst tokenizer to use
 110  * @param client_identity ID of client for which this is a buffer
 111  * @param buf input data to add
 112  * @param size number of bytes in buf
 113  * @param purge should any excess bytes in the buffer be discarded
 114  *       (i.e. for packet-based services like UDP)
 115  * @param one_shot only call callback once, keep rest of message in buffer
 116  * @return GNUNET_OK if we are done processing (need more data)
 117  *         GNUNET_NO if one_shot was set and we have another message ready
 118  *         GNUNET_SYSERR if the data stream is corrupt
 119  */
 120 int
 121 GNUNET_SERVER_mst_receive (struct GNUNET_SERVER_MessageStreamTokenizer *mst,
 122                            void *client_identity,
 123                            const char *buf,
 124                            size_t size,
 125                            int purge,
 126                            int one_shot)
 127 {
 128   const struct GNUNET_MessageHeader *hdr;
 129   size_t delta;
 130   uint16_t want;
 131   char *ibuf;
 132   int need_align;
 133   unsigned long offset;
 134   int ret;
 135   size_t newsize;
 136
 137 #if DEBUG_SERVER_MST
 138   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 139               "Server-mst receives %u bytes with %u bytes already in private buffer\n",
 140               (unsigned int) size,
 141               (unsigned int) (mst->pos - mst->off));
 142 #endif
 143   if ((size > mst->curr_buf) && (size < GNUNET_SERVER_MAX_MESSAGE_SIZE)) /* Received bigger message than we can currently handle! */
 144     {
 145       newsize = mst->curr_buf + size; /* How much space do we need? */
 146       if (newsize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
 147         newsize = GNUNET_SERVER_MAX_MESSAGE_SIZE; /* Check it's not bigger than GNUNET_SERVER_MAX_MESSAGE_SIZE */
 148
 149       mst->hdr = GNUNET_realloc(mst->hdr, newsize);
 150       mst->curr_buf = newsize;
 151     }
 152
 153   ret = GNUNET_OK;
 154   ibuf = (char*)mst->hdr;
 155   while (mst->pos > 0)
 156     {
 157     do_align:
 158       if ( (mst->curr_buf - mst->off < sizeof (struct GNUNET_MessageHeader)) ||
 159            (0 != (mst->off % ALIGN_FACTOR)) )
 160         {
 161           /* need to align or need more space */
 162           mst->pos -= mst->off;
 163           memmove (ibuf,
 164                    &ibuf[mst->off],
 165                    mst->pos);
 166           mst->off = 0;
 167         }
 168       if (mst->pos - mst->off < sizeof (struct GNUNET_MessageHeader))
 169         {
 170           delta = GNUNET_MIN (sizeof (struct GNUNET_MessageHeader) - (mst->pos - mst->off),
 171                               size);
 172           memcpy (&ibuf[mst->pos],
 173                   buf,
 174                   delta);
 175           mst->pos += delta;
 176           buf += delta;
 177           size -= delta;
 178         }
 179       if (mst->pos - mst->off < sizeof (struct GNUNET_MessageHeader))
 180         {
 181           if (purge)
 182             {
 183               mst->off = 0;
 184               mst->pos = 0;
 185             }
 186           return GNUNET_OK;
 187         }
 188       hdr = (const struct GNUNET_MessageHeader*) &ibuf[mst->off];
 189       want = ntohs (hdr->size);
 190       if (want < sizeof (struct GNUNET_MessageHeader))
 191         {
 192           GNUNET_break_op (0);
 193           return GNUNET_SYSERR;
 194         }
 195       if (mst->curr_buf - mst->off < want)
 196         {
 197           /* need more space */
 198           mst->pos -= mst->off;
 199           memmove (ibuf,
 200                    &ibuf[mst->off],
 201                    mst->pos);
 202           mst->off = 0;
 203         }
 204       if (mst->pos - mst->off < want)
 205         {
 206           delta = GNUNET_MIN (want - (mst->pos - mst->off),
 207                               size);
 208           memcpy (&ibuf[mst->pos],
 209                   buf,
 210                   delta);
 211           mst->pos += delta;
 212           buf += delta;
 213           size -= delta;
 214         }
 215       if (mst->pos - mst->off < want)
 216         {
 217           if (purge)
 218             {
 219               mst->off = 0;
 220               mst->pos = 0;
 221             }
 222           return GNUNET_OK;
 223         }
 224       if (one_shot == GNUNET_SYSERR)
 225         {
 226           /* cannot call callback again, but return value saying that
 227              we have another full message in the buffer */
 228           ret = GNUNET_NO;
 229           goto copy;
 230         }
 231       if (one_shot == GNUNET_YES)
 232         one_shot = GNUNET_SYSERR;
 233       mst->cb (mst->cb_cls, client_identity, hdr);
 234       mst->off += want;
 235       if (mst->off == mst->pos)
 236         {
 237           /* reset to beginning of buffer, it's free right now! */
 238           mst->off = 0;
 239           mst->pos = 0;
 240         }
 241     }
 242   while (size > 0)
 243     {
 244 #if DEBUG_SERVER_MST
 245       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 246                   "Server-mst has %u bytes left in inbound buffer\n",
 247                   (unsigned int) size);
 248 #endif
 249       if (size < sizeof (struct GNUNET_MessageHeader))
 250         break;
 251       offset = (unsigned long) buf;
 252       need_align = (0 != offset % ALIGN_FACTOR) ? GNUNET_YES : GNUNET_NO;
 253       if (GNUNET_NO == need_align)
 254         {
 255           /* can try to do zero-copy and process directly from original buffer */
 256           hdr = (const struct GNUNET_MessageHeader *) buf;
 257           want = ntohs (hdr->size);
 258           if (size < want)
 259             break; /* or not, buffer incomplete, so copy to private buffer... */
 260           if (one_shot == GNUNET_SYSERR)
 261             {
 262               /* cannot call callback again, but return value saying that
 263                  we have another full message in the buffer */
 264               ret = GNUNET_NO;
 265               goto copy;
 266             }
 267           if (one_shot == GNUNET_YES)
 268             one_shot = GNUNET_SYSERR;
 269           mst->cb (mst->cb_cls, client_identity, hdr);
 270           buf += want;
 271           size -= want;
 272         }
 273       else
 274         {
 275           /* need to copy to private buffer to align;
 276              yes, we go a bit more spagetti than usual here */
 277           goto do_align;
 278         }
 279     }
 280  copy:
 281   if ( (size > 0) && (! purge) )
 282     {
 283       GNUNET_assert (mst->pos + size <= mst->curr_buf);
 284       memcpy (&ibuf[mst->pos], buf, size);
 285       mst->pos += size;
 286     }
 287   if (purge)
 288     mst->off = 0;
 289 #if DEBUG_SERVER_MST
 290   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 291               "Server-mst leaves %u bytes in private buffer\n",
 292               (unsigned int) (mst->pos - mst->off));
 293 #endif
 294   return ret;
 295 }
 296
 297
 298 /**
 299  * Destroys a tokenizer.
 300  *
 301  * @param mst tokenizer to destroy
 302  */
 303 void
 304 GNUNET_SERVER_mst_destroy (struct GNUNET_SERVER_MessageStreamTokenizer *mst)
 305 {
 306   GNUNET_free (mst);
 307 }
 308
 309
 310
 311 /* end of server_mst.c */