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
 136 #if DEBUG_SERVER_MST
 137   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 138               "Server-mst receives %u bytes with %u bytes already in private buffer\n",
 139               (unsigned int) size,
 140               (unsigned int) (mst->pos - mst->off));
 141 #endif
 142   ret = GNUNET_OK;
 143   ibuf = (char*)mst->hdr;
 144   while (mst->pos > 0)
 145     {
 146     do_align:
 147       if ( (mst->curr_buf - mst->off < sizeof (struct GNUNET_MessageHeader)) ||
 148            (0 != (mst->off % ALIGN_FACTOR)) )
 149         {
 150           /* need to align or need more space */
 151           mst->pos -= mst->off;
 152           memmove (ibuf,
 153                    &ibuf[mst->off],
 154                    mst->pos);
 155           mst->off = 0;
 156         }
 157       if (mst->pos - mst->off < sizeof (struct GNUNET_MessageHeader))
 158         {
 159           delta = GNUNET_MIN (sizeof (struct GNUNET_MessageHeader) - (mst->pos - mst->off),
 160                               size);
 161           memcpy (&ibuf[mst->pos],
 162                   buf,
 163                   delta);
 164           mst->pos += delta;
 165           buf += delta;
 166           size -= delta;
 167         }
 168       if (mst->pos - mst->off < sizeof (struct GNUNET_MessageHeader))
 169         {
 170           if (purge)
 171             {
 172               mst->off = 0;
 173               mst->pos = 0;
 174             }
 175           return GNUNET_OK;
 176         }
 177       hdr = (const struct GNUNET_MessageHeader*) &ibuf[mst->off];
 178       want = ntohs (hdr->size);
 179       if (want < sizeof (struct GNUNET_MessageHeader))
 180         {
 181           GNUNET_break_op (0);
 182           return GNUNET_SYSERR;
 183         }
 184       if (mst->curr_buf - mst->off < want)
 185         {
 186           /* need more space */
 187           mst->pos -= mst->off;
 188           memmove (ibuf,
 189                    &ibuf[mst->off],
 190                    mst->pos);
 191           mst->off = 0;
 192         }
 193       if (want > mst->curr_buf)
 194         {
 195           mst->hdr = GNUNET_realloc(mst->hdr, want);
 196           ibuf = (char*)mst->hdr;
 197           mst->curr_buf = want;
 198         }
 199       hdr = (const struct GNUNET_MessageHeader*) &ibuf[mst->off];
 200       if (mst->pos - mst->off < want)
 201         {
 202           delta = GNUNET_MIN (want - (mst->pos - mst->off),
 203                               size);
 204           memcpy (&ibuf[mst->pos],
 205                   buf,
 206                   delta);
 207           mst->pos += delta;
 208           buf += delta;
 209           size -= delta;
 210         }
 211       if (mst->pos - mst->off < want)
 212         {
 213           if (purge)
 214             {
 215               mst->off = 0;
 216               mst->pos = 0;
 217             }
 218           return GNUNET_OK;
 219         }
 220       if (one_shot == GNUNET_SYSERR)
 221         {
 222           /* cannot call callback again, but return value saying that
 223              we have another full message in the buffer */
 224           ret = GNUNET_NO;
 225           goto copy;
 226         }
 227       if (one_shot == GNUNET_YES)
 228         one_shot = GNUNET_SYSERR;
 229       mst->cb (mst->cb_cls, client_identity, hdr);
 230       mst->off += want;
 231       if (mst->off == mst->pos)
 232         {
 233           /* reset to beginning of buffer, it's free right now! */
 234           mst->off = 0;
 235           mst->pos = 0;
 236         }
 237     }
 238   while (size > 0)
 239     {
 240 #if DEBUG_SERVER_MST
 241       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 242                   "Server-mst has %u bytes left in inbound buffer\n",
 243                   (unsigned int) size);
 244 #endif
 245       if (size < sizeof (struct GNUNET_MessageHeader))
 246         break;
 247       offset = (unsigned long) buf;
 248       need_align = (0 != offset % ALIGN_FACTOR) ? GNUNET_YES : GNUNET_NO;
 249       if (GNUNET_NO == need_align)
 250         {
 251           /* can try to do zero-copy and process directly from original buffer */
 252           hdr = (const struct GNUNET_MessageHeader *) buf;
 253           want = ntohs (hdr->size);
 254           if (want < sizeof (struct GNUNET_MessageHeader))
 255             {
 256               GNUNET_break_op (0);
 257               mst->off = 0;
 258               return GNUNET_SYSERR;
 259             }
 260           if (size < want)
 261             break; /* or not, buffer incomplete, so copy to private buffer... */
 262           if (one_shot == GNUNET_SYSERR)
 263             {
 264               /* cannot call callback again, but return value saying that
 265                  we have another full message in the buffer */
 266               ret = GNUNET_NO;
 267               goto copy;
 268             }
 269           if (one_shot == GNUNET_YES)
 270             one_shot = GNUNET_SYSERR;
 271           mst->cb (mst->cb_cls, client_identity, hdr);
 272           buf += want;
 273           size -= want;
 274         }
 275       else
 276         {
 277           /* need to copy to private buffer to align;
 278              yes, we go a bit more spagetti than usual here */
 279           goto do_align;
 280         }
 281     }
 282  copy:
 283   if ( (size > 0) && (! purge) )
 284     {
 285       if (size + mst->pos > mst->curr_buf)
 286         {
 287           mst->hdr = GNUNET_realloc(mst->hdr, size + mst->pos);
 288           ibuf = (char*)mst->hdr;
 289           mst->curr_buf = size + mst->pos;
 290         }
 291       GNUNET_assert (mst->pos + size <= mst->curr_buf);
 292       memcpy (&ibuf[mst->pos], buf, size);
 293       mst->pos += size;
 294     }
 295   if (purge)
 296     mst->off = 0;
 297 #if DEBUG_SERVER_MST
 298   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 299               "Server-mst leaves %u bytes in private buffer\n",
 300               (unsigned int) (mst->pos - mst->off));
 301 #endif
 302   return ret;
 303 }
 304
 305
 306 /**
 307  * Destroys a tokenizer.
 308  *
 309  * @param mst tokenizer to destroy
 310  */
 311 void
 312 GNUNET_SERVER_mst_destroy (struct GNUNET_SERVER_MessageStreamTokenizer *mst)
 313 {
 314   GNUNET_free (mst->hdr);
 315   GNUNET_free (mst);
 316 }
 317
 318
 319
 320 /* end of server_mst.c */