ats service, inbound bandwidth reservation management More...

#include "platform.h"
#include "gnunet-service-ats_reservations.h"
#include "gnunet-service-ats.h"
#include "ats.h"

Include dependency graph for gnunet-service-ats_reservations.c:

Macros
#define	MAX_BANDWIDTH_CARRY_S 5
	Number of seconds that available bandwidth carries over (can accumulate). More...

Functions
static struct GNUNET_TIME_Relative	reservations_reserve (const struct GNUNET_PeerIdentity *peer, int32_t amount)
	Reserve the given amount of incoming bandwidth (in bytes) from the given peer. More...

void	GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer, struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
	Set the amount of bandwidth the other peer could currently transmit to us (as far as we know) to the given value. More...

void	GAS_handle_reservation_request (struct GNUNET_SERVICE_Client client, const struct ReservationRequestMessage msg)
	Handle 'reservation request' messages from clients. More...

void	GAS_reservations_init ()
	Initialize reservations subsystem. More...

static int	free_tracker (void cls, const struct GNUNET_PeerIdentity key, void *value)
	Free memory of bandwidth tracker. More...

void	GAS_reservations_done ()
	Shutdown reservations subsystem. More...

Variables
static struct GNUNET_CONTAINER_MultiPeerMap *	trackers
	Map of peer identities to `struct GNUNET_BANDWIDTH_Tracker *`s. More...

Detailed Description

ats service, inbound bandwidth reservation management

Author: Christian Grothoff

Definition in file gnunet-service-ats_reservations.c.

Macro Definition Documentation

◆ MAX_BANDWIDTH_CARRY_S

#define MAX_BANDWIDTH_CARRY_S 5

Number of seconds that available bandwidth carries over (can accumulate).

Note that the test_ats_reservation_api test depends on this value!

Definition at line 35 of file gnunet-service-ats_reservations.c.

Function Documentation

◆ reservations_reserve()

static struct GNUNET_TIME_Relative reservations_reserve	(	const struct GNUNET_PeerIdentity *	peer,
		int32_t	amount
	)

static

Reserve the given amount of incoming bandwidth (in bytes) from the given peer.

If a reservation is not possible right now, return how long the client should wait before trying again.

Parameters

peer	peer to reserve bandwidth from
amount	number of bytes to reserve

Returns: 0 if the reservation was successful, FOREVER if the peer is not connected, otherwise the time to wait until the reservation might succeed

Definition at line 41 of file gnunet-service-ats_reservations.c.

 {
   struct GNUNET_BANDWIDTH_Tracker *tracker;
   struct GNUNET_TIME_Relative ret;
  
   tracker = GNUNET_CONTAINER_multipeermap_get (trackers,
                                                peer);
   if (NULL == tracker)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                 "Not connected, allowing reservation of %d bytes\n",
                 (int) amount);
     return GNUNET_TIME_UNIT_ZERO;       /* not connected, satisfy now */
   }
   if (amount >= 0)
   {
     ret = GNUNET_BANDWIDTH_tracker_get_delay (tracker, amount);
     if (ret.rel_value_us > 0)
     {
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                   "Delay to satisfy reservation for %d bytes is %s\n",
                   (int) amount,
                   GNUNET_STRINGS_relative_time_to_string (ret,
                                                           GNUNET_YES));
       return ret;
     }
   }
   (void) GNUNET_BANDWIDTH_tracker_consume (tracker, amount);
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Reserved %d bytes\n",
               (int) amount);
   return GNUNET_TIME_UNIT_ZERO;
 }

References GNUNET_BANDWIDTH_tracker_consume(), GNUNET_BANDWIDTH_tracker_get_delay(), GNUNET_CONTAINER_multipeermap_get(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_UNIT_ZERO, GNUNET_YES, peer, ret, and trackers.

Referenced by GAS_handle_reservation_request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GAS_reservations_set_bandwidth()

void GAS_reservations_set_bandwidth	(	const struct GNUNET_PeerIdentity *	peer,
		struct GNUNET_BANDWIDTH_Value32NBO	bandwidth_in
	)

Set the amount of bandwidth the other peer could currently transmit to us (as far as we know) to the given value.

Parameters

peer	identity of the peer
bandwidth_in	currently available bandwidth from that peer to this peer (estimate)

Definition at line 101 of file gnunet-service-ats_reservations.c.

 {
   struct GNUNET_BANDWIDTH_Tracker *tracker;
  
   tracker = GNUNET_CONTAINER_multipeermap_get (trackers, peer);
   if (0 == ntohl (bandwidth_in.value__))
   {
     if (NULL == tracker)
       return;
     GNUNET_assert (GNUNET_YES ==
                    GNUNET_CONTAINER_multipeermap_remove (trackers,
                                                          peer,
                                                          tracker));
     GNUNET_free (tracker);
     return;
   }
   if (NULL == tracker)
   {
     tracker = GNUNET_new (struct GNUNET_BANDWIDTH_Tracker);
     GNUNET_BANDWIDTH_tracker_init (tracker,
                                    NULL,
                                    NULL,
                                    bandwidth_in,
                                    MAX_BANDWIDTH_CARRY_S);
     GNUNET_assert (GNUNET_OK ==
                    GNUNET_CONTAINER_multipeermap_put (trackers,
                                                       peer,
                                                       tracker,
                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
     return;
   }
   GNUNET_BANDWIDTH_tracker_update_quota (tracker,
                                          bandwidth_in);
 }

References GNUNET_assert, GNUNET_BANDWIDTH_tracker_init(), GNUNET_BANDWIDTH_tracker_update_quota(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_put(), GNUNET_CONTAINER_multipeermap_remove(), GNUNET_free, GNUNET_new, GNUNET_OK, GNUNET_YES, MAX_BANDWIDTH_CARRY_S, peer, trackers, and GNUNET_BANDWIDTH_Value32NBO::value__.

Referenced by bandwidth_changed_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GAS_handle_reservation_request()

void GAS_handle_reservation_request	(	struct GNUNET_SERVICE_Client *	client,
		const struct ReservationRequestMessage *	message
	)

Handle 'reservation request' messages from clients.

Parameters

client	client that sent the request
message	the request message

Definition at line 139 of file gnunet-service-ats_reservations.c.

 {
   struct GNUNET_MQ_Envelope *env;
   struct ReservationResultMessage *result;
   int32_t amount;
   struct GNUNET_TIME_Relative res_delay;
  
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Received RESERVATION_REQUEST message\n");
   amount = (int32_t) ntohl (msg->amount);
   res_delay = reservations_reserve (&msg->peer, amount);
   if (res_delay.rel_value_us > 0)
     amount = 0;
   env = GNUNET_MQ_msg (result,
                        GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
   result->amount = htonl (amount);
   result->peer = msg->peer;
   result->res_delay = GNUNET_TIME_relative_hton (res_delay);
   GNUNET_STATISTICS_update (GSA_stats,
                             "# reservation requests processed",
                             1,
                             GNUNET_NO);
   GNUNET_MQ_send (GNUNET_SERVICE_client_get_mq (client),
                   env);
 }

References ReservationResultMessage::amount, env, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_NO, GNUNET_SERVICE_client_get_mq(), GNUNET_STATISTICS_update(), GNUNET_TIME_relative_hton(), GSA_stats, msg, GNUNET_TIME_Relative::rel_value_us, reservations_reserve(), and result.

Referenced by handle_reservation_request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GAS_reservations_init()

void GAS_reservations_init ( void )

Initialize reservations subsystem.

Definition at line 171 of file gnunet-service-ats_reservations.c.

 {
   trackers = GNUNET_CONTAINER_multipeermap_create (128,
                                                    GNUNET_NO);
 }

References GNUNET_CONTAINER_multipeermap_create(), GNUNET_NO, and trackers.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ free_tracker()

static int free_tracker	(	void *	cls,
		const struct GNUNET_PeerIdentity *	key,
		void *	value
	)

static

Free memory of bandwidth tracker.

Parameters

cls	NULL
key	peer identity (unused)
value	the `struct GNUNET_BANDWIDTH_Tracker` to free

Returns: GNUNET_OK (continue to iterate)

Definition at line 187 of file gnunet-service-ats_reservations.c.

 {
   struct GNUNET_BANDWIDTH_Tracker *tracker = value;
  
   GNUNET_free (tracker);
   return GNUNET_OK;
 }

References GNUNET_free, GNUNET_OK, and value.

Referenced by GAS_reservations_done().

Here is the caller graph for this function:

◆ GAS_reservations_done()

void GAS_reservations_done ( void )

Shutdown reservations subsystem.

Definition at line 202 of file gnunet-service-ats_reservations.c.

 {
   GNUNET_CONTAINER_multipeermap_iterate (trackers,
                                          &free_tracker,
                                          NULL);
   GNUNET_CONTAINER_multipeermap_destroy (trackers);
 }