src/fragmentation/fragmentation.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/fragmentation.c
  22  * @brief library to help fragment messages
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_fragmentation_lib.h"
  27 #include "gnunet_protocols.h"
  28 #include "fragmentation.h"
  29
  30
  31 /**
  32  * Fragmentation context.
  33  */
  34 struct GNUNET_FRAGMENT_Context
  35 {
  36   /**
  37    * Statistics to use.
  38    */
  39   struct GNUNET_STATISTICS_Handle *stats;
  40
  41   /**
  42    * Tracker for flow control.
  43    */
  44   struct GNUNET_BANDWIDTH_Tracker *tracker;
  45
  46   /**
  47    * Current expected delay for ACKs.
  48    */
  49   struct GNUNET_TIME_Relative delay;
  50
  51   /**
  52    * Next allowed transmission time.
  53    */
  54   struct GNUNET_TIME_Absolute delay_until;
  55
  56   /**
  57    * Time we transmitted the last message of the last round.
  58    */
  59   struct GNUNET_TIME_Absolute last_round;
  60
  61   /**
  62    * Message to fragment (allocated at the end of this struct).
  63    */
  64   const struct GNUNET_MessageHeader *msg;
  65
  66   /**
  67    * Function to call for transmissions.
  68    */
  69   GNUNET_FRAGMENT_MessageProcessor proc;
  70
  71   /**
  72    * Closure for 'proc'.
  73    */
  74   void *proc_cls;
  75
  76   /**
  77    * Bitfield, set to 1 for each unacknowledged fragment.
  78    */
  79   uint64_t acks;
  80
  81   /**
  82    * Bitfield with all possible bits for 'acks' (used to mask the
  83    * ack we get back).
  84    */
  85   uint64_t acks_mask;
  86
  87   /**
  88    * Task performing work for the fragmenter.
  89    */
  90   GNUNET_SCHEDULER_TaskIdentifier task;
  91
  92   /**
  93    * Our fragmentation ID. (chosen at random)
  94    */
  95   uint32_t fragment_id;
  96
  97   /**
  98    * Round-robin selector for the next transmission.
  99    */
 100   unsigned int next_transmission;
 101
 102   /**
 103    * GNUNET_YES if we called 'proc' and are now waiting for 'GNUNET_FRAGMENT_transmission_done'
 104    */
 105   int8_t proc_busy;
 106
 107   /**
 108    * GNUNET_YES if we are waiting for an ACK.
 109    */
 110   int8_t wack;
 111
 112   /**
 113    * Target fragment size.
 114    */
 115   uint16_t mtu;
 116
 117 };
 118
 119
 120 /**
 121  * Transmit the next fragment to the other peer.
 122  *
 123  * @param cls the 'struct GNUNET_FRAGMENT_Context'
 124  * @param tc scheduler context
 125  */
 126 static void
 127 transmit_next (void *cls,
 128                const struct GNUNET_SCHEDULER_TaskContext *tc)
 129 {
 130   struct GNUNET_FRAGMENT_Context *fc = cls;
 131   char msg[fc->mtu];
 132   const char *mbuf;
 133   struct FragmentHeader *fh;
 134   struct GNUNET_TIME_Relative delay;
 135   unsigned int bit;
 136   size_t size;
 137   size_t fsize;
 138   int wrap;
 139
 140   fc->task = GNUNET_SCHEDULER_NO_TASK;
 141   GNUNET_assert (GNUNET_NO == fc->proc_busy);
 142   if (0 == fc->acks)
 143     return; /* all done */
 144
 145   /* calculate delay */
 146   wrap = 0;
 147   while (0 == (fc->acks & (1LL << fc->next_transmission)))
 148     {
 149       fc->next_transmission = (fc->next_transmission + 1) % 64;
 150       wrap |= (fc->next_transmission == 0);
 151     }
 152   bit = fc->next_transmission;
 153   size = ntohs (fc->msg->size);
 154   if (bit == size / (fc->mtu - sizeof (struct FragmentHeader)))
 155     fsize = size % (fc->mtu - sizeof (struct FragmentHeader)) + sizeof (struct FragmentHeader);
 156   else
 157     fsize = fc->mtu;
 158   if (fc->tracker != NULL)
 159     delay = GNUNET_BANDWIDTH_tracker_get_delay (fc->tracker,
 160                                                 fsize);
 161   else
 162     delay = GNUNET_TIME_UNIT_ZERO;
 163   if (delay.rel_value > 0)
 164     {
 165       fc->task = GNUNET_SCHEDULER_add_delayed (delay,
 166                                                &transmit_next,
 167                                                fc);
 168       return;
 169     }
 170   fc->next_transmission = (fc->next_transmission + 1) % 64;
 171   wrap |= (fc->next_transmission == 0);
 172
 173   /* assemble fragmentation message */
 174   mbuf = (const char*) &fc[1];
 175   fh = (struct FragmentHeader*) msg;
 176   fh->header.size = htons (fsize);
 177   fh->header.type = htons (GNUNET_MESSAGE_TYPE_FRAGMENT);
 178   fh->fragment_id = htonl (fc->fragment_id);
 179   fh->total_size = fc->msg->size; /* already in big-endian */
 180   fh->offset = htons ((fc->mtu - sizeof (struct FragmentHeader)) * bit);
 181   memcpy (&fh[1],
 182           &mbuf[bit * (fc->mtu - sizeof (struct FragmentHeader))],
 183           fsize - sizeof (struct FragmentHeader));
 184   if (NULL != fc->tracker)
 185     GNUNET_BANDWIDTH_tracker_consume (fc->tracker, fsize);
 186   GNUNET_STATISTICS_update (fc->stats,
 187                             _("# fragments transmitted"),
 188                             1, GNUNET_NO);
 189   if (0 != fc->last_round.abs_value)
 190     GNUNET_STATISTICS_update (fc->stats,
 191                               _("# fragments retransmitted"),
 192                               1, GNUNET_NO);
 193
 194   /* select next message to calculate delay */
 195   bit = fc->next_transmission;
 196   size = ntohs (fc->msg->size);
 197   if (bit == size / (fc->mtu - sizeof (struct FragmentHeader)))
 198     fsize = size % (fc->mtu - sizeof (struct FragmentHeader));
 199   else
 200     fsize = fc->mtu;
 201   if (NULL != fc->tracker)
 202     delay = GNUNET_BANDWIDTH_tracker_get_delay (fc->tracker,
 203                                                 fsize);
 204   else
 205     delay = GNUNET_TIME_UNIT_ZERO;
 206   if (wrap)
 207     {
 208       /* full round transmitted wait 2x delay for ACK before going again */
 209       delay = GNUNET_TIME_relative_max (GNUNET_TIME_relative_multiply (delay, 2),
 210                                         fc->delay);
 211       /* never use zero, need some time for ACK always */
 212       delay = GNUNET_TIME_relative_max (GNUNET_TIME_UNIT_MILLISECONDS,
 213                                         delay);
 214       fc->last_round = GNUNET_TIME_absolute_get ();
 215       fc->wack = GNUNET_YES;
 216     }
 217   fc->proc_busy = GNUNET_YES;
 218   fc->delay_until = GNUNET_TIME_relative_to_absolute (delay);
 219   fc->proc (fc->proc_cls, &fh->header);
 220 }
 221
 222
 223 /**
 224  * Create a fragmentation context for the given message.
 225  * Fragments the message into fragments of size "mtu" or
 226  * less.  Calls 'proc' on each un-acknowledged fragment,
 227  * using both the expected 'delay' between messages and
 228  * acknowledgements and the given 'tracker' to guide the
 229  * frequency of calls to 'proc'.
 230  *
 231  * @param stats statistics context
 232  * @param mtu the maximum message size for each fragment
 233  * @param tracker bandwidth tracker to use for flow control (can be NULL)
 234  * @param delay expected delay between fragment transmission
 235  *              and ACK based on previous messages
 236  * @param msg the message to fragment
 237  * @param proc function to call for each fragment to transmit
 238  * @param proc_cls closure for proc
 239  * @return the fragmentation context
 240  */
 241 struct GNUNET_FRAGMENT_Context *
 242 GNUNET_FRAGMENT_context_create (struct GNUNET_STATISTICS_Handle *stats,
 243                                 uint16_t mtu,
 244                                 struct GNUNET_BANDWIDTH_Tracker *tracker,
 245                                 struct GNUNET_TIME_Relative delay,
 246                                 const struct GNUNET_MessageHeader *msg,
 247                                 GNUNET_FRAGMENT_MessageProcessor proc,
 248                                 void *proc_cls)
 249 {
 250   struct GNUNET_FRAGMENT_Context *fc;
 251   size_t size;
 252   uint64_t bits;
 253
 254   GNUNET_STATISTICS_update (stats,
 255                             _("# messages fragmented"),
 256                             1, GNUNET_NO);
 257   GNUNET_assert (mtu >= 1024 + sizeof (struct FragmentHeader));
 258   size = ntohs (msg->size);
 259   GNUNET_STATISTICS_update (stats,
 260                             _("# total size of fragmented messages"),
 261                             size, GNUNET_NO);
 262   GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
 263   fc = GNUNET_malloc (sizeof (struct GNUNET_FRAGMENT_Context) + size);
 264   fc->stats = stats;
 265   fc->mtu = mtu;
 266   fc->tracker = tracker;
 267   fc->delay = delay;
 268   fc->msg = (const struct GNUNET_MessageHeader*)&fc[1];
 269   fc->proc = proc;
 270   fc->proc_cls = proc_cls;
 271   fc->fragment_id = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 272                                               UINT32_MAX);
 273   memcpy (&fc[1], msg, size);
 274   bits = (size + mtu - sizeof (struct FragmentHeader) - 1) / (mtu - sizeof (struct FragmentHeader));
 275   GNUNET_assert (bits <= 64);
 276   if (bits == 64)
 277     fc->acks_mask = UINT64_MAX;      /* set all 64 bit */
 278   else
 279     fc->acks_mask = (1LL << bits) - 1; /* set lowest 'bits' bit */
 280   fc->acks = fc->acks_mask;
 281   fc->task = GNUNET_SCHEDULER_add_now (&transmit_next,
 282                                        fc);
 283   return fc;
 284 }
 285
 286
 287 /**
 288  * Continuation to call from the 'proc' function after the fragment
 289  * has been transmitted (and hence the next fragment can now be
 290  * given to proc).
 291  *
 292  * @param fc fragmentation context
 293  */
 294 void
 295 GNUNET_FRAGMENT_context_transmission_done (struct GNUNET_FRAGMENT_Context *fc)
 296 {
 297   GNUNET_assert (fc->proc_busy == GNUNET_YES);
 298   fc->proc_busy = GNUNET_NO;
 299   GNUNET_assert (fc->task == GNUNET_SCHEDULER_NO_TASK);
 300   fc->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (fc->delay_until),
 301                                            &transmit_next,
 302                                            fc);
 303 }
 304
 305
 306 /**
 307  * Process an acknowledgement message we got from the other
 308  * side (to control re-transmits).
 309  *
 310  * @param fc fragmentation context
 311  * @param msg acknowledgement message we received
 312  * @return GNUNET_OK if this ack completes the work of the 'fc'
 313  *                   (all fragments have been received);
 314  *         GNUNET_NO if more messages are pending
 315  *         GNUNET_SYSERR if this ack is not valid for this fc
 316  */
 317 int
 318 GNUNET_FRAGMENT_process_ack (struct GNUNET_FRAGMENT_Context *fc,
 319                              const struct GNUNET_MessageHeader *msg)
 320 {
 321   const struct FragmentAcknowledgement *fa;
 322   uint64_t abits;
 323   struct GNUNET_TIME_Relative ndelay;
 324
 325   if (sizeof (struct FragmentAcknowledgement) !=
 326       ntohs (msg->size))
 327     {
 328       GNUNET_break_op (0);
 329       return GNUNET_SYSERR;
 330     }
 331   fa = (const struct FragmentAcknowledgement *) msg;
 332   if (ntohl (fa->fragment_id) != fc->fragment_id)
 333     return GNUNET_SYSERR; /* not our ACK */
 334   abits = GNUNET_ntohll (fa->bits);
 335   if (GNUNET_YES == fc->wack)
 336     {
 337       /* normal ACK, can update running average of delay... */
 338       fc->wack = GNUNET_NO;
 339       ndelay = GNUNET_TIME_absolute_get_duration (fc->last_round);
 340       fc->delay.rel_value = (ndelay.rel_value + 3 * fc->delay.rel_value) / 4;
 341     }
 342   GNUNET_STATISTICS_update (fc->stats,
 343                             _("# fragment acknowledgements received"),
 344                             1,
 345                             GNUNET_NO);
 346   if (abits != (fc->acks & abits))
 347     {
 348       /* ID collission or message reordering, count! This should be rare! */
 349       GNUNET_STATISTICS_update (fc->stats,
 350                                 _("# bits removed from fragmentation ACKs"),
 351                                 1, GNUNET_NO);
 352     }
 353   fc->acks = abits & fc->acks_mask;
 354   if (0 != fc->acks)
 355     {
 356       /* more to transmit, do so right now (if tracker permits...) */
 357       if (fc->task != GNUNET_SCHEDULER_NO_TASK)
 358         {
 359           /* schedule next transmission now, no point in waiting... */
 360           GNUNET_SCHEDULER_cancel (fc->task);
 361           fc->task = GNUNET_SCHEDULER_add_now (&transmit_next,
 362                                                fc);
 363         }
 364       else
 365         {
 366           /* only case where there is no task should be if we're waiting
 367              for the right to transmit again (proc_busy set to YES) */
 368           GNUNET_assert (GNUNET_YES == fc->proc_busy);
 369         }
 370       return GNUNET_NO;
 371     }
 372
 373   /* all done */
 374   GNUNET_STATISTICS_update (fc->stats,
 375                             _("# fragmentation transmissions completed"),
 376                             1,
 377                             GNUNET_NO);
 378   if (fc->task != GNUNET_SCHEDULER_NO_TASK)
 379     {
 380       GNUNET_SCHEDULER_cancel (fc->task);
 381       fc->task = GNUNET_SCHEDULER_NO_TASK;
 382     }
 383   return GNUNET_OK;
 384 }
 385
 386
 387 /**
 388  * Destroy the given fragmentation context (stop calling 'proc', free
 389  * resources).
 390  *
 391  * @param fc fragmentation context
 392  * @return average delay between transmission and ACK for the
 393  *         last message, FOREVER if the message was not fully transmitted
 394  */
 395 struct GNUNET_TIME_Relative
 396 GNUNET_FRAGMENT_context_destroy (struct GNUNET_FRAGMENT_Context *fc)
 397 {
 398   struct GNUNET_TIME_Relative ret;
 399
 400   if (fc->task != GNUNET_SCHEDULER_NO_TASK)
 401     GNUNET_SCHEDULER_cancel (fc->task);
 402   ret = fc->delay;
 403   GNUNET_free (fc);
 404   return ret;
 405 }
 406
 407
 408 /* end of fragmentation.c */
 409