Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / util / bandwidth.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2010, 2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, 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_util_lib.h"
28
29
30 #define LOG(kind,...) GNUNET_log_from (kind, "util-bandwidth", __VA_ARGS__)
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   ret.value__ = htonl (bytes_per_second);
44   return ret;
45 }
46
47
48 /**
49  * Compute the MIN of two bandwidth values.
50  *
51  * @param b1 first value
52  * @param b2 second value
53  * @return the min of b1 and b2
54  */
55 struct GNUNET_BANDWIDTH_Value32NBO
56 GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
57                             struct GNUNET_BANDWIDTH_Value32NBO b2)
58 {
59   return
60       GNUNET_BANDWIDTH_value_init (GNUNET_MIN
61                                    (ntohl (b1.value__),
62                                     ntohl (b2.value__)));
63 }
64
65
66 /**
67  * Compute the MAX of two bandwidth values.
68  *
69  * @param b1 first value
70  * @param b2 second value
71  * @return the min of b1 and b2
72  */
73 struct GNUNET_BANDWIDTH_Value32NBO
74 GNUNET_BANDWIDTH_value_max (struct GNUNET_BANDWIDTH_Value32NBO b1,
75                             struct GNUNET_BANDWIDTH_Value32NBO b2)
76 {
77   return
78       GNUNET_BANDWIDTH_value_init (GNUNET_MAX
79                                    (ntohl (b1.value__),
80                                     ntohl (b2.value__)));
81 }
82
83
84 /**
85  * At the given bandwidth, calculate how much traffic will be
86  * available until the given deadline.
87  *
88  * @param bps bandwidth
89  * @param deadline when is the deadline
90  * @return number of bytes available at bps until deadline
91  */
92 uint64_t
93 GNUNET_BANDWIDTH_value_get_available_until (struct GNUNET_BANDWIDTH_Value32NBO bps,
94                                             struct GNUNET_TIME_Relative deadline)
95 {
96   uint64_t b;
97
98   b = ntohl (bps.value__);
99   LOG (GNUNET_ERROR_TYPE_DEBUG,
100        "Bandwidth has %llu bytes available until deadline in %s\n",
101        (unsigned long long) ((b * deadline.rel_value_us + 500000LL) / 1000000LL),
102        GNUNET_STRINGS_relative_time_to_string (deadline, GNUNET_YES));
103   return (b * deadline.rel_value_us + 500000LL) / 1000000LL;
104 }
105
106
107 /**
108  * At the given bandwidth, calculate how long it would take for
109  * @a size bytes to be transmitted.
110  *
111  * @param bps bandwidth
112  * @param size number of bytes we want to have available
113  * @return how long it would take
114  */
115 struct GNUNET_TIME_Relative
116 GNUNET_BANDWIDTH_value_get_delay_for (struct GNUNET_BANDWIDTH_Value32NBO bps,
117                                       uint64_t size)
118 {
119   uint64_t b;
120   struct GNUNET_TIME_Relative ret;
121
122   b = ntohl (bps.value__);
123   if (0 == b)
124   {
125     LOG (GNUNET_ERROR_TYPE_DEBUG,
126          "Bandwidth suggests delay of infinity (zero bandwidth)\n");
127     return GNUNET_TIME_UNIT_FOREVER_REL;
128   }
129   ret.rel_value_us = size * 1000LL * 1000LL / b;
130   LOG (GNUNET_ERROR_TYPE_DEBUG,
131        "Bandwidth suggests delay of %s for %llu bytes of traffic\n",
132        GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES),
133        (unsigned long long) size);
134   return ret;
135 }
136
137
138 /**
139  * Task run whenever we hit the bandwidth limit for a tracker.
140  *
141  * @param cls the `struct GNUNET_BANDWIDTH_Tracker`
142  */
143 static void
144 excess_trigger (void *cls)
145 {
146   struct GNUNET_BANDWIDTH_Tracker *av = cls;
147
148   av->excess_task = NULL;
149   if (NULL != av->excess_cb)
150   {
151     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
152                 "Notifying application about excess bandwidth\n");
153     av->excess_cb (av->excess_cb_cls);
154   }
155 }
156
157
158 /**
159  * Recalculate when we might need to call the excess callback.
160  */
161 static void
162 update_excess (struct GNUNET_BANDWIDTH_Tracker *av)
163 {
164   struct GNUNET_TIME_Relative delay;
165   struct GNUNET_TIME_Absolute now;
166   uint64_t delta_time;
167   uint64_t delta_avail;
168   int64_t left_bytes;
169   uint64_t max_carry;
170   int64_t current_consumption;
171
172   if (NULL == av->excess_cb)
173     return; /* nothing to do */
174   now = GNUNET_TIME_absolute_get ();
175   delta_time = now.abs_value_us - av->last_update__.abs_value_us;
176   delta_avail =
177       (delta_time * ((unsigned long long) av->available_bytes_per_s__) +
178        500000LL) / 1000000LL;
179   current_consumption = av->consumption_since_last_update__ - delta_avail;
180   if (current_consumption > av->consumption_since_last_update__)
181   {
182     /* integer underflow, cap! */
183     current_consumption = INT64_MIN;
184   }
185   /* negative current_consumption means that we have savings */
186   max_carry = ((uint64_t) av->available_bytes_per_s__) * av->max_carry_s__;
187   if (max_carry < GNUNET_MAX_MESSAGE_SIZE)
188     max_carry = GNUNET_MAX_MESSAGE_SIZE;
189   if (max_carry > INT64_MAX)
190     max_carry = INT64_MAX;
191   left_bytes = current_consumption + max_carry;
192   if (left_bytes < current_consumption)
193   {
194     /* integer overflow, cap! */
195     left_bytes = INT64_MAX;
196   }
197   /* left_bytes now contains the number of bytes needed until
198      we have more savings than allowed */
199   if (left_bytes < 0)
200   {
201     /* having excess already */
202     delay = GNUNET_TIME_UNIT_ZERO;
203   }
204   else
205   {
206     double factor = 1.0 * left_bytes / (double) av->available_bytes_per_s__; 
207     delay = GNUNET_TIME_relative_saturating_multiply (GNUNET_TIME_UNIT_SECONDS,
208                                                       (unsigned long long) factor);
209   }
210   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
211               "At %llu bps it will take us %s for %lld bytes to reach excess threshold\n",
212               (unsigned long long) av->available_bytes_per_s__,
213               GNUNET_STRINGS_relative_time_to_string (delay,
214                                                       GNUNET_NO),
215               (long long) left_bytes);
216   if (NULL != av->excess_task)
217     GNUNET_SCHEDULER_cancel (av->excess_task);
218   av->excess_task = GNUNET_SCHEDULER_add_delayed (delay,
219                                                   &excess_trigger,
220                                                   av);
221 }
222
223
224 /**
225  * Initialize bandwidth tracker.  Note that in addition to the
226  * 'max_carry_s' limit, we also always allow at least
227  * #GNUNET_MAX_MESSAGE_SIZE to accumulate.  So if the
228  * bytes-per-second limit is so small that within 'max_carry_s' not
229  * even #GNUNET_MAX_MESSAGE_SIZE is allowed to accumulate, it is
230  * ignored and replaced by #GNUNET_MAX_MESSAGE_SIZE (which is in
231  * bytes).
232  *
233  * To stop notifications about updates and excess callbacks use
234  * #GNUNET_BANDWIDTH_tracker_notification_stop().
235  *
236  * @param av tracker to initialize
237  * @param update_cb callback to notify a client about the tracker being updated
238  * @param update_cb_cls cls for the callback
239  * @param bytes_per_second_limit initial limit to assume
240  * @param max_carry_s maximum number of seconds unused bandwidth
241  *        may accumulate before it expires
242  * @param excess_cb callback to notify if we have excess bandwidth
243  * @param excess_cb_cls closure for @a excess_cb
244  */
245 void
246 GNUNET_BANDWIDTH_tracker_init2 (struct GNUNET_BANDWIDTH_Tracker *av,
247                                 GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
248                                 void *update_cb_cls,
249                                 struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
250                                 uint32_t max_carry_s,
251                                 GNUNET_BANDWIDTH_ExcessNotificationCallback excess_cb,
252                                 void *excess_cb_cls)
253 {
254   av->update_cb = update_cb;
255   av->update_cb_cls = update_cb_cls;
256   av->consumption_since_last_update__ = 0;
257   av->last_update__ = GNUNET_TIME_absolute_get ();
258   av->available_bytes_per_s__ = ntohl (bytes_per_second_limit.value__);
259   av->max_carry_s__ = max_carry_s;
260   av->excess_cb = excess_cb;
261   av->excess_cb_cls = excess_cb_cls;
262   LOG (GNUNET_ERROR_TYPE_DEBUG,
263        "Tracker %p initialized with %u Bps and max carry %u\n",
264        av,
265        (unsigned int) av->available_bytes_per_s__,
266        (unsigned int) max_carry_s);
267   update_excess (av);
268 }
269
270
271 /**
272  * Initialize bandwidth tracker.  Note that in addition to the
273  * 'max_carry_s' limit, we also always allow at least
274  * #GNUNET_MAX_MESSAGE_SIZE to accumulate.  So if the
275  * bytes-per-second limit is so small that within 'max_carry_s' not
276  * even #GNUNET_MAX_MESSAGE_SIZE is allowed to accumulate, it is
277  * ignored and replaced by #GNUNET_MAX_MESSAGE_SIZE (which is in
278  * bytes).
279  *
280  * @param av tracker to initialize
281  * @param update_cb callback to notify a client about the tracker being updated
282  * @param update_cb_cls cls for the callback
283  * @param bytes_per_second_limit initial limit to assume
284  * @param max_carry_s maximum number of seconds unused bandwidth
285  *        may accumulate before it expires
286  */
287 void
288 GNUNET_BANDWIDTH_tracker_init (struct GNUNET_BANDWIDTH_Tracker *av,
289                                GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
290                                void *update_cb_cls,
291                                struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
292                                uint32_t max_carry_s)
293 {
294   GNUNET_BANDWIDTH_tracker_init2 (av, update_cb,
295                                   update_cb_cls,
296                                   bytes_per_second_limit,
297                                   max_carry_s,
298                                   NULL, NULL);
299 }
300
301
302 /**
303  * Stop notifying about tracker updates and excess notifications
304  *
305  * @param av the respective trackers
306  */
307 void
308 GNUNET_BANDWIDTH_tracker_notification_stop (struct GNUNET_BANDWIDTH_Tracker *av)
309 {
310   if (NULL != av->excess_task)
311     GNUNET_SCHEDULER_cancel (av->excess_task);
312   av->excess_task = NULL;
313   av->excess_cb = NULL;
314   av->excess_cb_cls = NULL;
315   av->update_cb = NULL;
316   av->update_cb_cls = NULL;
317 }
318
319
320 /**
321  * Update the tracker, looking at the current time and
322  * bandwidth consumption data.
323  *
324  * @param av tracker to update
325  */
326 static void
327 update_tracker (struct GNUNET_BANDWIDTH_Tracker *av)
328 {
329   struct GNUNET_TIME_Absolute now;
330   struct GNUNET_TIME_Relative delta;
331   uint64_t delta_time;
332   uint64_t delta_avail;
333   uint64_t left_bytes;
334   uint64_t max_carry;
335
336   now = GNUNET_TIME_absolute_get ();
337   delta_time = now.abs_value_us - av->last_update__.abs_value_us;
338   delta_avail =
339       (delta_time * ((unsigned long long) av->available_bytes_per_s__) +
340        500000LL) / 1000000LL;
341   av->consumption_since_last_update__ -= delta_avail;
342   av->last_update__ = now;
343   if (av->consumption_since_last_update__ < 0)
344   {
345     left_bytes = - av->consumption_since_last_update__;
346     max_carry = ((unsigned long long) av->available_bytes_per_s__) *
347                 av->max_carry_s__;
348     if (max_carry < GNUNET_MAX_MESSAGE_SIZE)
349       max_carry = GNUNET_MAX_MESSAGE_SIZE;
350     if (max_carry > INT64_MAX)
351       max_carry = INT64_MAX;
352     if (max_carry > left_bytes)
353       av->consumption_since_last_update__ = - left_bytes;
354     else
355       av->consumption_since_last_update__ = - max_carry;
356   }
357   delta.rel_value_us = delta_time;
358   LOG (GNUNET_ERROR_TYPE_DEBUG,
359        "Tracker %p updated, consumption at %lld at %u Bps, last update was %s ago\n",
360        av,
361        (long long) av->consumption_since_last_update__,
362        (unsigned int) av->available_bytes_per_s__,
363        GNUNET_STRINGS_relative_time_to_string (delta,
364                                                GNUNET_YES));
365 }
366
367
368 /**
369  * Notify the tracker that a certain number of bytes of bandwidth have
370  * been consumed.  Note that it is legal to consume bytes even if not
371  * enough bandwidth is available (in that case,
372  * #GNUNET_BANDWIDTH_tracker_get_delay may return non-zero delay values
373  * even for a size of zero for a while).
374  *
375  * @param av tracker to update
376  * @param size number of bytes consumed
377  * @return #GNUNET_YES if this consumption is above the limit
378  */
379 int
380 GNUNET_BANDWIDTH_tracker_consume (struct GNUNET_BANDWIDTH_Tracker *av,
381                                   ssize_t size)
382 {
383   int64_t nc;
384
385   LOG (GNUNET_ERROR_TYPE_DEBUG,
386        "Tracker %p consumes %d bytes\n",
387        av,
388        (int) size);
389   if (size > 0)
390   {
391     nc = av->consumption_since_last_update__ + size;
392     if (nc < av->consumption_since_last_update__)
393     {
394       /* integer overflow, very bad */
395       GNUNET_break (0);
396       return GNUNET_SYSERR;
397     }
398     av->consumption_since_last_update__ = nc;
399     update_tracker (av);
400     update_excess (av);
401     if (av->consumption_since_last_update__ > 0)
402     {
403       LOG (GNUNET_ERROR_TYPE_DEBUG,
404            "Tracker %p consumption %llu bytes above limit\n",
405            av,
406            (unsigned long long) av->consumption_since_last_update__);
407       return GNUNET_YES;
408     }
409   }
410   else
411   {
412     nc = av->consumption_since_last_update__ + size;
413     if (nc > av->consumption_since_last_update__)
414     {
415       /* integer underflow, very bad */
416       GNUNET_break (0);
417       return GNUNET_SYSERR;
418     }
419     av->consumption_since_last_update__ = nc;
420     update_excess (av);
421   }
422   return GNUNET_NO;
423 }
424
425
426 /**
427  * Compute how long we should wait until consuming 'size'
428  * bytes of bandwidth in order to stay within the given
429  * quota.
430  *
431  * @param av tracker to query
432  * @param size number of bytes we would like to consume
433  * @return time in ms to wait for consumption to be OK
434  */
435 struct GNUNET_TIME_Relative
436 GNUNET_BANDWIDTH_tracker_get_delay (struct GNUNET_BANDWIDTH_Tracker *av,
437                                     size_t size)
438 {
439   struct GNUNET_TIME_Relative ret;
440   int64_t bytes_needed;
441
442   if (0 == av->available_bytes_per_s__)
443   {
444     LOG (GNUNET_ERROR_TYPE_DEBUG,
445          "Tracker %p delay is infinity\n", av);
446     return GNUNET_TIME_UNIT_FOREVER_REL;
447   }
448   update_tracker (av);
449   bytes_needed = size + av->consumption_since_last_update__;
450   if (bytes_needed <= 0)
451   {
452     LOG (GNUNET_ERROR_TYPE_DEBUG,
453          "Tracker %p delay for %u bytes is zero\n", av,
454          (unsigned int) size);
455     return GNUNET_TIME_UNIT_ZERO;
456   }
457   ret.rel_value_us =
458       (1000LL * 1000LL * bytes_needed) /
459       (unsigned long long) av->available_bytes_per_s__;
460   LOG (GNUNET_ERROR_TYPE_DEBUG,
461        "Tracker %p delay for %u bytes is %s\n",
462        av,
463        (unsigned int) size,
464        GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES));
465   return ret;
466 }
467
468
469 /**
470  * Compute how many bytes are available for consumption right now.
471  * quota.
472  *
473  * @param av tracker to query
474  * @return number of bytes available for consumption right now
475  */
476 int64_t
477 GNUNET_BANDWIDTH_tracker_get_available (struct GNUNET_BANDWIDTH_Tracker *av)
478 {
479   struct GNUNET_BANDWIDTH_Value32NBO bps;
480   uint64_t avail;
481   int64_t used;
482
483   update_tracker (av);
484   bps = GNUNET_BANDWIDTH_value_init (av->available_bytes_per_s__);
485   avail =
486       GNUNET_BANDWIDTH_value_get_available_until (bps,
487                                                   GNUNET_TIME_absolute_get_duration
488                                                   (av->last_update__));
489   used = av->consumption_since_last_update__;
490   LOG (GNUNET_ERROR_TYPE_DEBUG,
491        "Tracker %p available bandwidth is %lld bytes\n", av,
492        (long long) (int64_t) (avail - used));
493   return (int64_t) (avail - used);
494 }
495
496
497 /**
498  * Update quota of bandwidth tracker.
499  *
500  * @param av tracker to initialize
501  * @param bytes_per_second_limit new limit to assume
502  */
503 void
504 GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av,
505                                        struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit)
506 {
507   uint32_t old_limit;
508   uint32_t new_limit;
509
510   new_limit = ntohl (bytes_per_second_limit.value__);
511   LOG (GNUNET_ERROR_TYPE_DEBUG,
512        "Tracker %p bandwidth changed to %u Bps\n", av,
513        (unsigned int) new_limit);
514   update_tracker (av);
515   old_limit = av->available_bytes_per_s__;
516   av->available_bytes_per_s__ = new_limit;
517   if (NULL != av->update_cb)
518     av->update_cb (av->update_cb_cls);
519   if (old_limit > new_limit)
520     update_tracker (av);        /* maximum excess might be less now */
521   update_excess (av);
522 }
523
524
525 /* end of bandwidth.c */