/*
This file is part of GNUnet.
- Copyright (C) 2010, 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010, 2013 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Affero General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
#include "gnunet_util_lib.h"
-#define LOG(kind,...) GNUNET_log_from (kind, "util-bandwidth", __VA_ARGS__)
+#define LOG(kind, ...) GNUNET_log_from (kind, "util-bandwidth", __VA_ARGS__)
/**
* Create a new bandwidth value.
{
struct GNUNET_BANDWIDTH_Value32NBO ret;
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Initializing bandwidth of %u Bps\n",
- (unsigned int) bytes_per_second);
ret.value__ = htonl (bytes_per_second);
return ret;
}
GNUNET_BANDWIDTH_value_min (struct GNUNET_BANDWIDTH_Value32NBO b1,
struct GNUNET_BANDWIDTH_Value32NBO b2)
{
- return
- GNUNET_BANDWIDTH_value_init (GNUNET_MIN
- (ntohl (b1.value__),
- ntohl (b2.value__)));
+ return GNUNET_BANDWIDTH_value_init (
+ GNUNET_MIN (ntohl (b1.value__), ntohl (b2.value__)));
}
GNUNET_BANDWIDTH_value_max (struct GNUNET_BANDWIDTH_Value32NBO b1,
struct GNUNET_BANDWIDTH_Value32NBO b2)
{
- return
- GNUNET_BANDWIDTH_value_init (GNUNET_MAX
- (ntohl (b1.value__),
- ntohl (b2.value__)));
+ return GNUNET_BANDWIDTH_value_init (
+ GNUNET_MAX (ntohl (b1.value__), ntohl (b2.value__)));
+}
+
+
+/**
+ * Compute the SUM of two bandwidth values.
+ *
+ * @param b1 first value
+ * @param b2 second value
+ * @return the sum of b1 and b2
+ */
+struct GNUNET_BANDWIDTH_Value32NBO
+GNUNET_BANDWIDTH_value_sum (struct GNUNET_BANDWIDTH_Value32NBO b1,
+ struct GNUNET_BANDWIDTH_Value32NBO b2)
+{
+ return GNUNET_BANDWIDTH_value_init (ntohl (b1.value__) + ntohl (b2.value__));
}
* @return number of bytes available at bps until deadline
*/
uint64_t
-GNUNET_BANDWIDTH_value_get_available_until (struct GNUNET_BANDWIDTH_Value32NBO bps,
- struct GNUNET_TIME_Relative deadline)
+GNUNET_BANDWIDTH_value_get_available_until (
+ struct GNUNET_BANDWIDTH_Value32NBO bps,
+ struct GNUNET_TIME_Relative deadline)
{
uint64_t b;
b = ntohl (bps.value__);
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Bandwidth has %llu bytes available until deadline in %s\n",
- (unsigned long long) ((b * deadline.rel_value_us + 500000LL) / 1000000LL),
+ (unsigned long long) ((b * deadline.rel_value_us + 500000LL) /
+ 1000000LL),
GNUNET_STRINGS_relative_time_to_string (deadline, GNUNET_YES));
return (b * deadline.rel_value_us + 500000LL) / 1000000LL;
}
* Task run whenever we hit the bandwidth limit for a tracker.
*
* @param cls the `struct GNUNET_BANDWIDTH_Tracker`
- * @param tc scheduler context
*/
static void
-excess_trigger (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext *tc)
+excess_trigger (void *cls)
{
struct GNUNET_BANDWIDTH_Tracker *av = cls;
av->excess_task = NULL;
-
if (NULL != av->excess_cb)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Notifying application about excess bandwidth\n");
av->excess_cb (av->excess_cb_cls);
+ }
}
now = GNUNET_TIME_absolute_get ();
delta_time = now.abs_value_us - av->last_update__.abs_value_us;
delta_avail =
- (delta_time * ((unsigned long long) av->available_bytes_per_s__) +
- 500000LL) / 1000000LL;
+ (delta_time * ((unsigned long long) av->available_bytes_per_s__) +
+ 500000LL) /
+ 1000000LL;
current_consumption = av->consumption_since_last_update__ - delta_avail;
+ if (current_consumption > av->consumption_since_last_update__)
+ {
+ /* integer underflow, cap! */
+ current_consumption = INT64_MIN;
+ }
/* negative current_consumption means that we have savings */
- max_carry = av->available_bytes_per_s__ * av->max_carry_s__;
- if (max_carry < GNUNET_SERVER_MAX_MESSAGE_SIZE)
- max_carry = GNUNET_SERVER_MAX_MESSAGE_SIZE;
- left_bytes = max_carry + current_consumption;
+ max_carry = ((uint64_t) av->available_bytes_per_s__) * av->max_carry_s__;
+ if (max_carry < GNUNET_MAX_MESSAGE_SIZE)
+ max_carry = GNUNET_MAX_MESSAGE_SIZE;
+ if (max_carry > INT64_MAX)
+ max_carry = INT64_MAX;
+ left_bytes = current_consumption + max_carry;
+ if (left_bytes < current_consumption)
+ {
+ /* integer overflow, cap! */
+ left_bytes = INT64_MAX;
+ }
/* left_bytes now contains the number of bytes needed until
we have more savings than allowed */
if (left_bytes < 0)
}
else
{
- delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
- left_bytes);
- delay = GNUNET_TIME_relative_divide (delay,
- av->available_bytes_per_s__);
+ double factor = 1.0 * left_bytes / (double) av->available_bytes_per_s__;
+ delay =
+ GNUNET_TIME_relative_saturating_multiply (GNUNET_TIME_UNIT_SECONDS,
+ (unsigned long long) factor);
}
+ GNUNET_log (
+ GNUNET_ERROR_TYPE_DEBUG,
+ "At %llu bps it will take us %s for %lld bytes to reach excess threshold\n",
+ (unsigned long long) av->available_bytes_per_s__,
+ GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_NO),
+ (long long) left_bytes);
if (NULL != av->excess_task)
GNUNET_SCHEDULER_cancel (av->excess_task);
- av->excess_task = GNUNET_SCHEDULER_add_delayed (delay,
- &excess_trigger,
- av);
+ av->excess_task = GNUNET_SCHEDULER_add_delayed (delay, &excess_trigger, av);
}
/**
* Initialize bandwidth tracker. Note that in addition to the
* 'max_carry_s' limit, we also always allow at least
- * #GNUNET_SERVER_MAX_MESSAGE_SIZE to accumulate. So if the
+ * #GNUNET_MAX_MESSAGE_SIZE to accumulate. So if the
* bytes-per-second limit is so small that within 'max_carry_s' not
- * even #GNUNET_SERVER_MAX_MESSAGE_SIZE is allowed to accumulate, it is
- * ignored and replaced by #GNUNET_SERVER_MAX_MESSAGE_SIZE (which is in
+ * even #GNUNET_MAX_MESSAGE_SIZE is allowed to accumulate, it is
+ * ignored and replaced by #GNUNET_MAX_MESSAGE_SIZE (which is in
* bytes).
*
* To stop notifications about updates and excess callbacks use
- * #GNUNET_BANDWIDTH_tracker_notification_stop
+ * #GNUNET_BANDWIDTH_tracker_notification_stop().
*
* @param av tracker to initialize
* @param update_cb callback to notify a client about the tracker being updated
* @param excess_cb_cls closure for @a excess_cb
*/
void
-GNUNET_BANDWIDTH_tracker_init2 (struct GNUNET_BANDWIDTH_Tracker *av,
- GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
- void *update_cb_cls,
- struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
- uint32_t max_carry_s,
- GNUNET_BANDWIDTH_ExcessNotificationCallback excess_cb,
- void *excess_cb_cls)
+GNUNET_BANDWIDTH_tracker_init2 (
+ struct GNUNET_BANDWIDTH_Tracker *av,
+ GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
+ void *update_cb_cls,
+ struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
+ uint32_t max_carry_s,
+ GNUNET_BANDWIDTH_ExcessNotificationCallback excess_cb,
+ void *excess_cb_cls)
{
av->update_cb = update_cb;
av->update_cb_cls = update_cb_cls;
/**
* Initialize bandwidth tracker. Note that in addition to the
* 'max_carry_s' limit, we also always allow at least
- * GNUNET_SERVER_MAX_MESSAGE_SIZE to accumulate. So if the
+ * #GNUNET_MAX_MESSAGE_SIZE to accumulate. So if the
* bytes-per-second limit is so small that within 'max_carry_s' not
- * even GNUNET_SERVER_MAX_MESSAGE_SIZE is allowed to accumulate, it is
- * ignored and replaced by GNUNET_SERVER_MAX_MESSAGE_SIZE (which is in
+ * even #GNUNET_MAX_MESSAGE_SIZE is allowed to accumulate, it is
+ * ignored and replaced by #GNUNET_MAX_MESSAGE_SIZE (which is in
* bytes).
*
* @param av tracker to initialize
* may accumulate before it expires
*/
void
-GNUNET_BANDWIDTH_tracker_init (struct GNUNET_BANDWIDTH_Tracker *av,
- GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
- void *update_cb_cls,
- struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
- uint32_t max_carry_s)
+GNUNET_BANDWIDTH_tracker_init (
+ struct GNUNET_BANDWIDTH_Tracker *av,
+ GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb,
+ void *update_cb_cls,
+ struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit,
+ uint32_t max_carry_s)
{
- GNUNET_BANDWIDTH_tracker_init2 (av, update_cb,
+ GNUNET_BANDWIDTH_tracker_init2 (av,
+ update_cb,
update_cb_cls,
bytes_per_second_limit,
max_carry_s,
- NULL, NULL);
+ NULL,
+ NULL);
}
}
-
/**
* Update the tracker, looking at the current time and
* bandwidth consumption data.
update_tracker (struct GNUNET_BANDWIDTH_Tracker *av)
{
struct GNUNET_TIME_Absolute now;
- struct GNUNET_TIME_Relative delta;
uint64_t delta_time;
uint64_t delta_avail;
uint64_t left_bytes;
now = GNUNET_TIME_absolute_get ();
delta_time = now.abs_value_us - av->last_update__.abs_value_us;
delta_avail =
- (delta_time * ((unsigned long long) av->available_bytes_per_s__) +
- 500000LL) / 1000000LL;
+ (delta_time * ((unsigned long long) av->available_bytes_per_s__) +
+ 500000LL) /
+ 1000000LL;
av->consumption_since_last_update__ -= delta_avail;
av->last_update__ = now;
if (av->consumption_since_last_update__ < 0)
{
left_bytes = -av->consumption_since_last_update__;
- max_carry = av->available_bytes_per_s__ * av->max_carry_s__;
- if (max_carry < GNUNET_SERVER_MAX_MESSAGE_SIZE)
- max_carry = GNUNET_SERVER_MAX_MESSAGE_SIZE;
+ max_carry =
+ ((unsigned long long) av->available_bytes_per_s__) * av->max_carry_s__;
+ if (max_carry < GNUNET_MAX_MESSAGE_SIZE)
+ max_carry = GNUNET_MAX_MESSAGE_SIZE;
+ if (max_carry > INT64_MAX)
+ max_carry = INT64_MAX;
if (max_carry > left_bytes)
av->consumption_since_last_update__ = -left_bytes;
else
av->consumption_since_last_update__ = -max_carry;
}
- delta.rel_value_us = delta_time;
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Tracker %p updated, have %u Bps, last update was %s ago\n", av,
- (unsigned int) av->available_bytes_per_s__,
- GNUNET_STRINGS_relative_time_to_string (delta, GNUNET_YES));
+#if ! defined(GNUNET_CULL_LOGGING)
+ {
+ struct GNUNET_TIME_Relative delta;
+
+ delta.rel_value_us = delta_time;
+ LOG (GNUNET_ERROR_TYPE_DEBUG,
+ "Tracker %p updated, consumption at %lld at %u Bps, last update was %s ago\n",
+ av,
+ (long long) av->consumption_since_last_update__,
+ (unsigned int) av->available_bytes_per_s__,
+ GNUNET_STRINGS_relative_time_to_string (delta, GNUNET_YES));
+ }
+#endif
}
nc = av->consumption_since_last_update__ + size;
if (nc < av->consumption_since_last_update__)
{
+ /* integer overflow, very bad */
GNUNET_break (0);
return GNUNET_SYSERR;
}
if (av->consumption_since_last_update__ > 0)
{
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Tracker %p consumption %llu bytes above limit\n", av,
+ "Tracker %p consumption %llu bytes above limit\n",
+ av,
(unsigned long long) av->consumption_since_last_update__);
return GNUNET_YES;
}
}
else
{
- av->consumption_since_last_update__ += size;
+ nc = av->consumption_since_last_update__ + size;
+ if (nc > av->consumption_since_last_update__)
+ {
+ /* integer underflow, very bad */
+ GNUNET_break (0);
+ return GNUNET_SYSERR;
+ }
+ av->consumption_since_last_update__ = nc;
update_excess (av);
}
return GNUNET_NO;
if (0 == av->available_bytes_per_s__)
{
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Tracker %p delay is infinity\n", av);
+ LOG (GNUNET_ERROR_TYPE_DEBUG, "Tracker %p delay is infinity\n", av);
return GNUNET_TIME_UNIT_FOREVER_REL;
}
update_tracker (av);
if (bytes_needed <= 0)
{
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Tracker %p delay for %u bytes is zero\n", av,
+ "Tracker %p delay for %u bytes is zero\n",
+ av,
(unsigned int) size);
return GNUNET_TIME_UNIT_ZERO;
}
- ret.rel_value_us =
- (1000LL * 1000LL * bytes_needed) /
- (unsigned long long) av->available_bytes_per_s__;
+ ret.rel_value_us = (1000LL * 1000LL * bytes_needed) /
+ (unsigned long long) av->available_bytes_per_s__;
LOG (GNUNET_ERROR_TYPE_DEBUG,
"Tracker %p delay for %u bytes is %s\n",
- av, (unsigned int) size,
+ av,
+ (unsigned int) size,
GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES));
return ret;
}
update_tracker (av);
bps = GNUNET_BANDWIDTH_value_init (av->available_bytes_per_s__);
avail =
- GNUNET_BANDWIDTH_value_get_available_until (bps,
- GNUNET_TIME_absolute_get_duration
- (av->last_update__));
+ GNUNET_BANDWIDTH_value_get_available_until (bps,
+ GNUNET_TIME_absolute_get_duration (
+ av->last_update__));
used = av->consumption_since_last_update__;
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Tracker %p available bandwidth is %lld bytes\n", av,
+ "Tracker %p available bandwidth is %lld bytes\n",
+ av,
(long long) (int64_t) (avail - used));
return (int64_t) (avail - used);
}
* @param bytes_per_second_limit new limit to assume
*/
void
-GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av,
- struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit)
+GNUNET_BANDWIDTH_tracker_update_quota (
+ struct GNUNET_BANDWIDTH_Tracker *av,
+ struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit)
{
uint32_t old_limit;
uint32_t new_limit;
new_limit = ntohl (bytes_per_second_limit.value__);
LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Tracker %p bandwidth changed to %u Bps\n", av,
+ "Tracker %p bandwidth changed to %u Bps\n",
+ av,
(unsigned int) new_limit);
update_tracker (av);
old_limit = av->available_bytes_per_s__;
if (NULL != av->update_cb)
av->update_cb (av->update_cb_cls);
if (old_limit > new_limit)
- update_tracker (av); /* maximum excess might be less now */
+ update_tracker (av); /* maximum excess might be less now */
update_excess (av);
}