src/fragmentation/defragmentation.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2009, 2011 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 3, 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  * @file src/fragmentation/defragmentation.c
  22  * @brief library to help defragment messages
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_fragmentation_lib.h"
  27 #include "fragmentation.h"
  28
  29 /**
  30  * Timestamps for fragments.
  31  */
  32 struct FragTimes
  33 {
  34   /**
  35    * The time the fragment was received.
  36    */
  37   struct GNUNET_TIME_Absolute time;
  38
  39   /**
  40    * Number of the bit for the fragment (in [0,..,63]).
  41    */
  42   unsigned int bit;
  43 };
  44
  45
  46 /**
  47  * Information we keep for one message that is being assembled.  Note
  48  * that we keep the context around even after the assembly is done to
  49  * handle 'stray' messages that are received 'late'.  A message
  50  * context is ONLY discarded when the queue gets too big.
  51  */
  52 struct MessageContext
  53 {
  54   /**
  55    * This is a DLL.
  56    */
  57   struct MessageContext *next;
  58
  59   /**
  60    * This is a DLL.
  61    */
  62   struct MessageContext *prev;
  63
  64   /**
  65    * Associated defragmentation context.
  66    */
  67   struct GNUNET_DEFRAGMENT_Context *dc;
  68
  69   /**
  70    * Pointer to the assembled message, allocated at the
  71    * end of this struct.
  72    */
  73   const struct GNUNET_MessageHeader *msg;
  74
  75   /**
  76    * Last time we received any update for this message
  77    * (least-recently updated message will be discarded
  78    * if we hit the queue size).
  79    */
  80   struct GNUNET_TIME_Absolute last_update;
  81
  82   /**
  83    * Task scheduled for transmitting the next ACK to the
  84    * other peer.
  85    */
  86   GNUNET_SCHEDULER_TaskIdentifier ack_task;
  87
  88   /**
  89    * When did we receive which fragment? Used to calculate
  90    * the time we should send the ACK.
  91    */
  92   struct FragTimes frag_times[64];
  93
  94   /**
  95    * Which fragments have we gotten yet? bits that are 1
  96    * indicate missing fragments.
  97    */
  98   uint64_t bits;
  99
 100   /**
 101    * Unique ID for this message.
 102    */
 103   uint32_t fragment_id;
 104
 105   /**
 106    * Which 'bit' did the last fragment we received correspond to?
 107    */
 108   unsigned int last_bit;
 109
 110   /**
 111    * For the current ACK round, which is the first relevant
 112    * offset in 'frag_times'?
 113    */
 114   unsigned int frag_times_start_offset;
 115
 116   /**
 117    * Which offset whould we write the next frag value into
 118    * in the 'frag_times' array? All smaller entries are valid.
 119    */
 120   unsigned int frag_times_write_offset;
 121
 122   /**
 123    * Total size of the message that we are assembling.
 124    */
 125   uint16_t total_size;
 126
 127 };
 128
 129
 130 /**
 131  * Defragmentation context (one per connection).
 132  */
 133 struct GNUNET_DEFRAGMENT_Context
 134 {
 135
 136   /**
 137    * For statistics.
 138    */
 139   struct GNUNET_STATISTICS_Handle *stats;
 140
 141   /**
 142    * Head of list of messages we're defragmenting.
 143    */
 144   struct MessageContext *head;
 145
 146   /**
 147    * Tail of list of messages we're defragmenting.
 148    */
 149   struct MessageContext *tail;
 150
 151   /**
 152    * Closure for 'proc' and 'ackp'.
 153    */
 154   void *cls;
 155
 156   /**
 157    * Function to call with defragmented messages.
 158    */
 159   GNUNET_FRAGMENT_MessageProcessor proc;
 160
 161   /**
 162    * Function to call with acknowledgements.
 163    */
 164   GNUNET_DEFRAGMENT_AckProcessor ackp;
 165
 166   /**
 167    * Running average of the latency (delay between messages) for this
 168    * connection.
 169    */
 170   struct GNUNET_TIME_Relative latency;
 171
 172   /**
 173    * num_msgs how many fragmented messages
 174    * to we defragment at most at the same time?
 175    */
 176   unsigned int num_msgs;
 177
 178   /**
 179    * Current number of messages in the 'struct MessageContext'
 180    * DLL (smaller or equal to 'num_msgs').
 181    */
 182   unsigned int list_size;
 183
 184   /**
 185    * Maximum message size for each fragment.
 186    */
 187   uint16_t mtu;
 188 };
 189
 190
 191 /**
 192  * Create a defragmentation context.
 193  *
 194  * @param stats statistics context
 195  * @param mtu the maximum message size for each fragment
 196  * @param num_msgs how many fragmented messages
 197  *                 to we defragment at most at the same time?
 198  * @param cls closure for proc and ackp
 199  * @param proc function to call with defragmented messages
 200  * @param ackp function to call with acknowledgements (to send
 201  *             back to the other side)
 202  * @return the defragmentation context
 203  */
 204 struct GNUNET_DEFRAGMENT_Context *
 205 GNUNET_DEFRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
 206                                   uint16_t mtu,
 207                                   unsigned int num_msgs,
 208                                   void *cls,
 209                                   GNUNET_FRAGMENT_MessageProcessor proc,
 210                                   GNUNET_DEFRAGMENT_AckProcessor ackp)
 211 {
 212   struct GNUNET_DEFRAGMENT_Context *dc;
 213
 214   dc = GNUNET_malloc (sizeof (struct GNUNET_DEFRAGMENT_Context));
 215   dc->stats = stats;
 216   dc->cls = cls;
 217   dc->proc = proc;
 218   dc->ackp = ackp;
 219   dc->num_msgs = num_msgs;
 220   dc->mtu = mtu;
 221   dc->latency = GNUNET_TIME_UNIT_SECONDS; /* start with likely overestimate */
 222   return dc;
 223 }
 224
 225
 226 /**
 227  * Destroy the given defragmentation context.
 228  *
 229  * @param dc defragmentation context
 230  */
 231 void
 232 GNUNET_DEFRAGMENT_context_destroy (struct GNUNET_DEFRAGMENT_Context *dc)
 233 {
 234   struct MessageContext *mc;
 235
 236   while (NULL != (mc = dc->head))
 237     {
 238       GNUNET_CONTAINER_DLL_remove (dc->head,
 239                                    dc->tail,
 240                                    mc);
 241       dc->list_size--;
 242       if (GNUNET_SCHEDULER_NO_TASK != mc->ack_task)
 243         {
 244           GNUNET_SCHEDULER_cancel (mc->ack_task);
 245           mc->ack_task = GNUNET_SCHEDULER_NO_TASK;
 246         }
 247       GNUNET_free (mc);
 248     }
 249   GNUNET_assert (0 == dc->list_size);
 250   GNUNET_free (dc);
 251 }
 252
 253
 254 /**
 255  * Send acknowledgement to the other peer now.
 256  *
 257  * @param cls the message context
 258  * @param tc the scheduler context
 259  */
 260 static void
 261 send_ack (void *cls,
 262           const struct GNUNET_SCHEDULER_TaskContext *tc)
 263 {
 264   struct MessageContext *mc = cls;
 265   struct GNUNET_DEFRAGMENT_Context *dc = mc->dc;
 266   struct FragmentAcknowledgement fa;
 267
 268   mc->ack_task = GNUNET_SCHEDULER_NO_TASK;
 269   fa.header.size = htons (sizeof (struct FragmentAcknowledgement));
 270   fa.header.type = htons (GNUNET_MESSAGE_TYPE_FRAGMENT_ACK);
 271   fa.fragment_id = htonl (mc->fragment_id);
 272   fa.bits = GNUNET_htonll (mc->bits);
 273   GNUNET_STATISTICS_update (mc->dc->stats,
 274                             _("# acknowledgements sent for fragment"),
 275                             1,
 276                             GNUNET_NO);
 277   dc->ackp (dc->cls, mc->fragment_id, &fa.header);
 278 }
 279
 280
 281 /**
 282  * This function is from the GNU Scientific Library, linear/fit.c,
 283  * (C) 2000 Brian Gough
 284  */
 285 static void
 286 gsl_fit_mul (const double *x, const size_t xstride,
 287              const double *y, const size_t ystride,
 288              const size_t n,
 289              double *c1, double *cov_11, double *sumsq)
 290 {
 291   double m_x = 0, m_y = 0, m_dx2 = 0, m_dxdy = 0;
 292
 293   size_t i;
 294
 295   for (i = 0; i < n; i++)
 296     {
 297       m_x += (x[i * xstride] - m_x) / (i + 1.0);
 298       m_y += (y[i * ystride] - m_y) / (i + 1.0);
 299     }
 300
 301   for (i = 0; i < n; i++)
 302     {
 303       const double dx = x[i * xstride] - m_x;
 304       const double dy = y[i * ystride] - m_y;
 305
 306       m_dx2 += (dx * dx - m_dx2) / (i + 1.0);
 307       m_dxdy += (dx * dy - m_dxdy) / (i + 1.0);
 308     }
 309
 310   /* In terms of y =  b x */
 311
 312   {
 313     double s2 = 0, d2 = 0;
 314     double b = (m_x * m_y + m_dxdy) / (m_x * m_x + m_dx2);
 315
 316     *c1 = b;
 317
 318     /* Compute chi^2 = \sum (y_i -  b * x_i)^2 */
 319
 320     for (i = 0; i < n; i++)
 321       {
 322         const double dx = x[i * xstride] - m_x;
 323         const double dy = y[i * ystride] - m_y;
 324         const double d = (m_y - b * m_x) + dy - b * dx;
 325         d2 += d * d;
 326       }
 327
 328     s2 = d2 / (n - 1.0);        /* chisq per degree of freedom */
 329
 330     *cov_11 = s2 * 1.0 / (n * (m_x * m_x + m_dx2));
 331
 332     *sumsq = d2;
 333   }
 334 }
 335
 336
 337 /**
 338  * Estimate the latency between messages based on the most recent
 339  * message time stamps.
 340  *
 341  * @param mc context with time stamps
 342  * @return average delay between time stamps (based on least-squares fit)
 343  */
 344 static struct GNUNET_TIME_Relative
 345 estimate_latency (struct MessageContext *mc)
 346 {
 347   struct FragTimes *first;
 348   size_t total = mc->frag_times_write_offset - mc->frag_times_start_offset;
 349   double x[total];
 350   double y[total];
 351   size_t i;
 352   double c1;
 353   double cov11;
 354   double sumsq;
 355   struct GNUNET_TIME_Relative ret;
 356
 357   first = &mc->frag_times[mc->frag_times_start_offset];
 358   GNUNET_assert (total > 1);
 359   for (i=0;i<total;i++)
 360     {
 361       x[i] = (double) i;
 362       y[i] = (double) (first[i].time.abs_value - first[0].time.abs_value);
 363     }
 364   gsl_fit_mul (x, 1, y, 1, total,  &c1, &cov11, &sumsq);
 365   c1 += sqrt (sumsq); /* add 1 std dev */
 366   ret.rel_value = (uint64_t) c1;
 367   if (ret.rel_value == 0)
 368     ret = GNUNET_TIME_UNIT_MILLISECONDS; /* always at least 1 */
 369   return ret;
 370 };
 371
 372
 373 /**
 374  * Discard the message context that was inactive for the longest time.
 375  *
 376  * @param dc defragmentation context
 377  */
 378 static void
 379 discard_oldest_mc (struct GNUNET_DEFRAGMENT_Context *dc)
 380 {
 381   struct MessageContext *old;
 382   struct MessageContext *pos;
 383
 384   old = NULL;
 385   pos = dc->head;
 386   while (NULL != pos)
 387     {
 388       if ( (old == NULL) ||
 389            (old->last_update.abs_value > pos->last_update.abs_value) )
 390         old = pos;
 391       pos = pos->next;
 392     }
 393   GNUNET_assert (NULL != old);
 394   GNUNET_CONTAINER_DLL_remove (dc->head,
 395                                dc->tail,
 396                                old);
 397   dc->list_size--;
 398   if (GNUNET_SCHEDULER_NO_TASK != old->ack_task)
 399     {
 400       GNUNET_SCHEDULER_cancel (old->ack_task);
 401       old->ack_task = GNUNET_SCHEDULER_NO_TASK;
 402     }
 403   GNUNET_free (old);
 404 }
 405
 406
 407 /**
 408  * We have received a fragment.  Process it.
 409  *
 410  * @param dc the context
 411  * @param msg the message that was received
 412  * @return GNUNET_OK on success, GNUNET_NO if this was a duplicate, GNUNET_SYSERR on error
 413  */
 414 int
 415 GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc,
 416                                     const struct GNUNET_MessageHeader *msg)
 417 {
 418   struct MessageContext *mc;
 419   const struct FragmentHeader *fh;
 420   uint16_t msize;
 421   uint16_t foff;
 422   uint32_t fid;
 423   char *mbuf;
 424   unsigned int bit;
 425   struct GNUNET_TIME_Absolute now;
 426   struct GNUNET_TIME_Relative delay;
 427   unsigned int bc;
 428   unsigned int b;
 429   unsigned int n;
 430   int duplicate;
 431
 432   if (ntohs(msg->size) < sizeof (struct FragmentHeader))
 433     {
 434       GNUNET_break_op (0);
 435       return GNUNET_SYSERR;
 436     }
 437   if (ntohs (msg->size) > dc->mtu)
 438     {
 439       GNUNET_break_op (0);
 440       return GNUNET_SYSERR;
 441     }
 442   fh = (const struct FragmentHeader*) msg;
 443   msize = ntohs (fh->total_size);
 444   if (msize < sizeof (struct GNUNET_MessageHeader))
 445     {
 446       GNUNET_break_op (0);
 447       return GNUNET_SYSERR;
 448     }
 449   fid = ntohl (fh->fragment_id);
 450   foff = ntohs (fh->offset);
 451   if (foff >= msize)
 452     {
 453       GNUNET_break_op (0);
 454       return GNUNET_SYSERR;
 455     }
 456   if (0 != (foff % (dc->mtu - sizeof (struct FragmentHeader))))
 457     {
 458       GNUNET_break_op (0);
 459       return GNUNET_SYSERR;
 460     }
 461   GNUNET_STATISTICS_update (dc->stats,
 462                             _("# fragments received"),
 463                             1,
 464                             GNUNET_NO);
 465   mc = dc->head;
 466   while ( (NULL != mc) &&
 467           (fid != mc->fragment_id) )
 468     mc = mc->next;
 469   bit = foff / (dc->mtu - sizeof (struct FragmentHeader));
 470   if (bit * (dc->mtu - sizeof (struct FragmentHeader)) + ntohs (msg->size)
 471       - sizeof (struct FragmentHeader) > msize)
 472     {
 473       /* payload extends past total message size */
 474       GNUNET_break_op (0);
 475       return GNUNET_SYSERR;
 476     }
 477   if ( (NULL != mc) && (msize != mc->total_size) )
 478     {
 479       /* inconsistent message size */
 480       GNUNET_break_op (0);
 481       return GNUNET_SYSERR;
 482     }
 483   now = GNUNET_TIME_absolute_get ();
 484   if (NULL == mc)
 485     {
 486       mc = GNUNET_malloc (sizeof (struct MessageContext) + msize);
 487       mc->msg = (const struct GNUNET_MessageHeader*) &mc[1];
 488       mc->dc = dc;
 489       mc->total_size = msize;
 490       mc->fragment_id = fid;
 491       mc->last_update = now;
 492       n = (msize + dc->mtu - sizeof (struct FragmentHeader) - 1) / (dc->mtu - sizeof (struct FragmentHeader));
 493       if (n == 64)
 494         mc->bits = UINT64_MAX;      /* set all 64 bit */
 495       else
 496         mc->bits = (1LL << n) - 1; /* set lowest 'bits' bit */
 497       if (dc->list_size >= dc->num_msgs)
 498         discard_oldest_mc (dc);
 499       GNUNET_CONTAINER_DLL_insert (dc->head,
 500                                    dc->tail,
 501                                    mc);
 502       dc->list_size++;
 503     }
 504
 505   /* copy data to 'mc' */
 506   if (0 != (mc->bits & (1LL << bit)))
 507     {
 508       mc->bits -= 1LL << bit;
 509       mbuf = (char* )&mc[1];
 510       memcpy (&mbuf[bit * (dc->mtu - sizeof (struct FragmentHeader))],
 511               &fh[1],
 512               ntohs (msg->size) - sizeof (struct FragmentHeader));
 513       mc->last_update = now;
 514       if (bit < mc->last_bit)
 515         mc->frag_times_start_offset = mc->frag_times_write_offset;
 516       mc->last_bit = bit;
 517       mc->frag_times[mc->frag_times_write_offset].time = now;
 518       mc->frag_times[mc->frag_times_write_offset].bit = bit;
 519       mc->frag_times_write_offset++;
 520       duplicate = GNUNET_NO;
 521     }
 522   else
 523     {
 524       duplicate = GNUNET_YES;
 525       GNUNET_STATISTICS_update (dc->stats,
 526                                 _("# duplicate fragments received"),
 527                                 1,
 528                                 GNUNET_NO);
 529     }
 530
 531   /* count number of missing fragments */
 532   bc = 0;
 533   for (b=0;b<64;b++)
 534     if (0 != (mc->bits & (1LL << b))) bc++;
 535   if (mc->frag_times_write_offset - mc->frag_times_start_offset > 1)
 536     dc->latency = estimate_latency (mc);
 537   delay = GNUNET_TIME_relative_multiply (dc->latency,
 538                                          bc + 1);
 539   if ( (0 == mc->bits) || (GNUNET_YES == duplicate) ) /* message complete or duplicate, ACK now! */
 540     delay = GNUNET_TIME_UNIT_ZERO;
 541   if (GNUNET_SCHEDULER_NO_TASK != mc->ack_task)
 542     GNUNET_SCHEDULER_cancel (mc->ack_task);
 543   mc->ack_task = GNUNET_SCHEDULER_add_delayed (delay,
 544                                                &send_ack,
 545                                                mc);
 546   if ( (duplicate == GNUNET_NO) &&
 547        (0 == mc->bits) )
 548     {
 549       GNUNET_STATISTICS_update (dc->stats,
 550                                 _("# messages defragmented"),
 551                                 1,
 552                                 GNUNET_NO);
 553       /* message complete, notify! */
 554       dc->proc (dc->cls,
 555                 mc->msg);
 556     }
 557   if (duplicate == GNUNET_YES)
 558     return GNUNET_NO;
 559   return GNUNET_YES;
 560 }
 561
 562 /* end of defragmentation.c */
 563