src/util/bandwidth.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/bandwidth.c
  23  * @brief functions related to bandwidth (unit)
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_bandwidth_lib.h"
  28 #include "gnunet_server_lib.h"
  29
  30 #define DEBUG_BANDWIDTH GNUNET_NO
  31
  32 /**
  33  * Create a new bandwidth value.
  34  *
  35  * @param bytes_per_second value to create
  36  * @return the new bandwidth value
  37  */
  38 struct GNUNET_BANDWIDTH_Value32NBO
  39 GNUNET_BANDWIDTH_value_init (uint32_t bytes_per_second)
  40 {
  41   struct GNUNET_BANDWIDTH_Value32NBO ret;
  42
  43 #if DEBUG_BANDWIDTH
  44   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  45               "Initializing bandwidth of %u bps\n",
  46               (unsigned int) bytes_per_second);
  47 #endif
  48   ret.value__ = htonl (bytes_per_second);
  49   return ret;
  50 }
  51
  52
  53 /**
  54  * Compute the MIN of two bandwidth values.
  55  *
  56  * @param b1 first value
  57  * @param b2 second value
  58  * @return the min of b1 and b2
  59  */
  60 struct GNUNET_BANDWIDTH_Value32NBO
  61 GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
  62                             struct GNUNET_BANDWIDTH_Value32NBO b2)
  63 {
  64   return GNUNET_BANDWIDTH_value_init (GNUNET_MIN (ntohl (b1.value__),
  65                                                   ntohl (b2.value__)));
  66 }
  67
  68
  69 /**
  70  * At the given bandwidth, calculate how much traffic will be
  71  * available until the given deadline.
  72  *
  73  * @param bps bandwidth
  74  * @param deadline when is the deadline
  75  * @return number of bytes available at bps until deadline
  76  */
  77 uint64_t
  78 GNUNET_BANDWIDTH_value_get_available_until (struct GNUNET_BANDWIDTH_Value32NBO bps,
  79                                             struct GNUNET_TIME_Relative deadline)
  80 {
  81   uint64_t b;
  82
  83   b = ntohl (bps.value__);
  84 #if DEBUG_BANDWIDTH
  85   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  86               "Bandwidth has %llu bytes available until deadline in %llums\n",
  87               (unsigned long long) ((b * deadline.value + 500LL) / 1000LL),
  88               deadline.value);
  89 #endif
  90   return (b * deadline.value + 500LL) / 1000LL;
  91 }
  92
  93
  94 /**
  95  * At the given bandwidth, calculate how long it would take for
  96  * 'size' bytes to be transmitted.
  97  *
  98  * @param bps bandwidth
  99  * @param size number of bytes we want to have available
 100  * @return how long it would take
 101  */
 102 struct GNUNET_TIME_Relative
 103 GNUNET_BANDWIDTH_value_get_delay_for (struct GNUNET_BANDWIDTH_Value32NBO bps,
 104                                       uint64_t size)
 105 {
 106   uint64_t b;
 107   struct GNUNET_TIME_Relative ret;
 108
 109   b = ntohl (bps.value__);
 110   if (b == 0)
 111     {
 112 #if DEBUG_BANDWIDTH
 113       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 114                   "Bandwidth suggests delay of infinity (zero bandwidth)\n");
 115 #endif
 116       return GNUNET_TIME_UNIT_FOREVER_REL;
 117     }
 118   ret.value = size * 1000LL / b;
 119 #if DEBUG_BANDWIDTH
 120   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 121               "Bandwidth suggests delay of %llu ms for %llu bytes of traffic\n",
 122               (unsigned long long) ret.value,
 123               (unsigned long long) size);
 124 #endif
 125   return ret;
 126 }
 127
 128
 129 /**
 130  * Initialize bandwidth tracker.  Note that in addition to the
 131  * 'max_carry_s' limit, we also always allow at least
 132  * GNUNET_SERVER_MAX_MESSAGE_SIZE to accumulate.  So if the
 133  * bytes-per-second limit is so small that within 'max_carry_s' not
 134  * even GNUNET_SERVER_MAX_MESSAGE_SIZE is allowed to accumulate, it is
 135  * ignored and replaced by GNUNET_SERVER_MAX_MESSAGE_SIZE (which is in
 136  * bytes).
 137  *
 138  * @param av tracker to initialize
 139  * @param bytes_per_second_limit initial limit to assume
 140  * @param max_carry_s maximum number of seconds unused bandwidth
 141  *        may accumulate before it expires
 142  */
 143 void
 144 GNUNET_BANDWIDTH_tracker_init (struct GNUNET_BANDWIDTH_Tracker *av,
 145                                struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
 146                                uint32_t max_carry_s)
 147 {
 148   av->consumption_since_last_update__ = 0;
 149   av->last_update__ = GNUNET_TIME_absolute_get ();
 150   av->available_bytes_per_s__ = ntohl (bytes_per_second_limit.value__);
 151   av->max_carry_s__ = max_carry_s;
 152 #if DEBUG_BANDWIDTH
 153   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 154               "Tracker %p initialized with %u bps and max carry %u\n",
 155               av,
 156               (unsigned int) av->available_bytes_per_s__,
 157               (unsigned int) max_carry_s);
 158 #endif
 159 }
 160
 161
 162 /**
 163  * Update the tracker, looking at the current time and
 164  * bandwidth consumption data.
 165  *
 166  * @param av tracker to update
 167  */
 168 static void
 169 update_tracker (struct GNUNET_BANDWIDTH_Tracker *av)
 170 {
 171   struct GNUNET_TIME_Absolute now;
 172   uint64_t delta_time;
 173   uint64_t delta_avail;
 174   uint64_t left_bytes;
 175   uint64_t max_carry;
 176
 177   now = GNUNET_TIME_absolute_get ();
 178   delta_time = now.value - av->last_update__.value;
 179   delta_avail = (delta_time * ((unsigned long long) av->available_bytes_per_s__) + 500LL) / 1000LL;
 180   av->consumption_since_last_update__ -= delta_avail;
 181   av->last_update__ = now;
 182   if (av->consumption_since_last_update__ < 0)
 183     {
 184       left_bytes = - av->consumption_since_last_update__;
 185       max_carry = av->available_bytes_per_s__ * av->max_carry_s__;
 186       if (max_carry > left_bytes)
 187         av->consumption_since_last_update__ = -max_carry;
 188     }
 189 #if DEBUG_BANDWIDTH
 190   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 191               "Tracker %p  updated, have %u bps last update was %llu ms ago\n",
 192               av,
 193               (unsigned int) av->available_bytes_per_s__,
 194               (unsigned long long) (now.value - av->last_update__.value));
 195 #endif
 196 }
 197
 198
 199 /**
 200  * Notify the tracker that a certain number of bytes of bandwidth have
 201  * been consumed.  Note that it is legal to consume bytes even if not
 202  * enough bandwidth is available (in that case,
 203  * GNUNET_BANDWIDTH_tracker_get_delay may return non-zero delay values
 204  * even for a size of zero for a while).
 205  *
 206  * @param av tracker to update
 207  * @param size number of bytes consumed
 208  * @return GNUNET_YES if this consumption is above the limit
 209  */
 210 int
 211 GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
 212                                   ssize_t size)
 213 {
 214   int64_t nc;
 215
 216 #if DEBUG_BANDWIDTH
 217   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 218               "Tracker %p consumes %d bytes\n",
 219               av,
 220               (int) size);
 221 #endif
 222   if (size > 0)
 223     {
 224       nc = av->consumption_since_last_update__ + size;
 225       if (nc < av->consumption_since_last_update__)
 226         {
 227           GNUNET_break (0);
 228           return GNUNET_SYSERR;
 229         }
 230       av->consumption_since_last_update__ = nc;
 231       update_tracker (av);
 232       if (av->consumption_since_last_update__ > 0)
 233         {
 234 #if DEBUG_BANDWIDTH
 235           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 236                       "Tracker %p consumption %llu bytes above limit\n",
 237                       av,
 238                       (unsigned long long) av->consumption_since_last_update__);
 239 #endif
 240           return GNUNET_YES;
 241         }
 242     }
 243   else
 244     {
 245       av->consumption_since_last_update__ += size;
 246     }
 247   return GNUNET_NO;
 248 }
 249
 250
 251 /**
 252  * Compute how long we should wait until consuming 'size'
 253  * bytes of bandwidth in order to stay within the given
 254  * quota.
 255  *
 256  * @param av tracker to query
 257  * @param size number of bytes we would like to consume
 258  * @return time in ms to wait for consumption to be OK
 259  */
 260 struct GNUNET_TIME_Relative
 261 GNUNET_BANDWIDTH_tracker_get_delay (struct GNUNET_BANDWIDTH_Tracker *av,
 262                                     size_t size)
 263 {
 264   struct GNUNET_TIME_Relative ret;
 265   int64_t bytes_needed;
 266
 267   if (av->available_bytes_per_s__ == 0)
 268     {
 269 #if DEBUG_BANDWIDTH
 270       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 271                   "Tracker %p delay is infinity\n",
 272                   av);
 273 #endif
 274       return GNUNET_TIME_UNIT_FOREVER_REL;
 275     }
 276   update_tracker (av);
 277   bytes_needed = size + av->consumption_since_last_update__;
 278   if (bytes_needed <= 0)
 279     {
 280 #if DEBUG_BANDWIDTH
 281       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 282                   "Tracker %p delay for %u bytes is zero\n",
 283                   av,
 284                   (unsigned int) size);
 285 #endif
 286       return GNUNET_TIME_UNIT_ZERO;
 287     }
 288   ret.value = 1000LL * bytes_needed / (unsigned long long) av->available_bytes_per_s__;
 289 #if DEBUG_BANDWIDTH
 290   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 291               "Tracker %p delay for %u bytes is %llu ms\n",
 292               av,
 293               (unsigned int) size,
 294               (unsigned long long) ret.value);
 295 #endif
 296   return ret;
 297 }
 298
 299
 300 /**
 301  * Compute how many bytes are available for consumption right now.
 302  * quota.
 303  *
 304  * @param av tracker to query
 305  * @return number of bytes available for consumption right now
 306  */
 307 int64_t
 308 GNUNET_BANDWIDTH_tracker_get_available (struct GNUNET_BANDWIDTH_Tracker *av)
 309 {
 310   struct GNUNET_BANDWIDTH_Value32NBO bps;
 311   uint64_t avail;
 312   int64_t used;
 313
 314   update_tracker (av);
 315   bps = GNUNET_BANDWIDTH_value_init (av->available_bytes_per_s__);
 316   avail = GNUNET_BANDWIDTH_value_get_available_until (bps,
 317                                                       GNUNET_TIME_absolute_get_duration (av->last_update__));
 318   used = av->consumption_since_last_update__;
 319 #if DEBUG_BANDWIDTH
 320   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 321               "Tracker %p  available bandwith is %lld ms\n",
 322               av,
 323               (long long) (int64_t) (avail - used));
 324 #endif
 325   return (int64_t) (avail - used);
 326 }
 327
 328
 329 /**
 330  * Update quota of bandwidth tracker.
 331  *
 332  * @param av tracker to initialize
 333  * @param bytes_per_second_limit new limit to assume
 334  */
 335 void
 336 GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av,
 337                                        struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit)
 338 {
 339   uint32_t old_limit;
 340   uint32_t new_limit;
 341
 342   new_limit = ntohl (bytes_per_second_limit.value__);
 343 #if DEBUG_BANDWIDTH
 344   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 345               "Tracker %p bandwith changed to %u bps\n",
 346               av,
 347               (unsigned int) new_limit);
 348 #endif
 349   update_tracker (av);
 350   old_limit = av->available_bytes_per_s__;
 351   av->available_bytes_per_s__ = new_limit;
 352   if (old_limit > new_limit)
 353     update_tracker (av); /* maximum excess might be less now */
 354 }
 355
 356
 357 /* end of bandwidth.c */