src/ats/gnunet-service-ats_reservations.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 /**
  22  * @file ats/gnunet-service-ats_reservations.c
  23  * @brief ats service, inbound bandwidth reservation management
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-ats_reservations.h"
  28
  29 /**
  30  * Number of seconds that available bandwidth carries over
  31  * (can accumulate).
  32  */
  33 #define MAX_BANDWIDTH_CARRY_S 5
  34
  35
  36 /**
  37  * Map of peer identities to 'struct GNUNET_BANDWIDTH_Tracker *'s
  38  */
  39 static struct GNUNET_CONTAINER_MultiHashMap *trackers;
  40
  41
  42 /**
  43  * Reserve the given amount of incoming bandwidth (in bytes) from the
  44  * given peer.  If a reservation is not possible right now, return how
  45  * long the client should wait before trying again.
  46  *
  47  * @param peer peer to reserve bandwidth from
  48  * @param amount number of bytes to reserve
  49  * @return 0 if the reservation was successful, FOREVER if the
  50  *         peer is not connected, otherwise the time to wait
  51  *         until the reservation might succeed
  52  */
  53 struct GNUNET_TIME_Relative
  54 GAS_reservations_reserve (const struct GNUNET_PeerIdentity *peer,
  55                           int32_t amount)
  56 {
  57   struct GNUNET_BANDWIDTH_Tracker *tracker;
  58   struct GNUNET_TIME_Relative ret;
  59
  60   tracker = GNUNET_CONTAINER_multihashmap_get (trackers, &peer->hashPubKey);
  61   if (NULL == tracker)
  62     return GNUNET_TIME_UNIT_ZERO;       /* not connected, satisfy now */
  63   if (amount >= 0)
  64   {
  65     ret = GNUNET_BANDWIDTH_tracker_get_delay (tracker, amount);
  66     if (ret.rel_value_us > 0)
  67     {
  68       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  69                   "Delay to satisfy reservation for %d bytes is %s\n",
  70                   (int) amount,
  71                   GNUNET_STRINGS_relative_time_to_string (ret,
  72                                                           GNUNET_YES));
  73       return ret;
  74     }
  75   }
  76   (void) GNUNET_BANDWIDTH_tracker_consume (tracker, amount);
  77   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Reserved %d bytes\n", (int) amount);
  78   return GNUNET_TIME_UNIT_ZERO;
  79 }
  80
  81
  82 /**
  83  * Set the amount of bandwidth the other peer could currently transmit
  84  * to us (as far as we know) to the given value.
  85  *
  86  * @param peer identity of the peer
  87  * @param bandwidth_in currently available bandwidth from that peer to
  88  *        this peer (estimate)
  89  */
  90 void
  91 GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
  92                                 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
  93 {
  94   struct GNUNET_BANDWIDTH_Tracker *tracker;
  95
  96   tracker = GNUNET_CONTAINER_multihashmap_get (trackers, &peer->hashPubKey);
  97   if (0 == ntohl (bandwidth_in.value__))
  98   {
  99     if (NULL == tracker)
 100       return;
 101     GNUNET_assert (GNUNET_YES ==
 102                    GNUNET_CONTAINER_multihashmap_remove (trackers,
 103                                                          &peer->hashPubKey,
 104                                                          tracker));
 105     GNUNET_free (tracker);
 106     return;
 107   }
 108   if (NULL == tracker)
 109   {
 110     tracker = GNUNET_malloc (sizeof (struct GNUNET_BANDWIDTH_Tracker));
 111     GNUNET_BANDWIDTH_tracker_init (tracker, bandwidth_in,
 112                                    MAX_BANDWIDTH_CARRY_S);
 113     GNUNET_CONTAINER_multihashmap_put (trackers, &peer->hashPubKey, tracker,
 114                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 115     return;
 116   }
 117   GNUNET_BANDWIDTH_tracker_update_quota (tracker, bandwidth_in);
 118 }
 119
 120
 121 /**
 122  * Initialize reservations subsystem.
 123  */
 124 void
 125 GAS_reservations_init ()
 126 {
 127   trackers = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
 128 }
 129
 130
 131 /**
 132  * Free memory of bandwidth tracker.
 133  *
 134  * @param cls NULL
 135  * @param key peer identity (unused)
 136  * @param value the 'struct GNUNET_BANDWIDTH_Tracker' to free
 137  * @return GNUNET_OK (continue to iterate)
 138  */
 139 static int
 140 free_tracker (void *cls, const struct GNUNET_HashCode * key, void *value)
 141 {
 142   struct GNUNET_BANDWIDTH_Tracker *tracker = value;
 143
 144   GNUNET_free (tracker);
 145   return GNUNET_OK;
 146 }
 147
 148
 149 /**
 150  * Shutdown reservations subsystem.
 151  */
 152 void
 153 GAS_reservations_done ()
 154 {
 155   GNUNET_CONTAINER_multihashmap_iterate (trackers, &free_tracker, NULL);
 156   GNUNET_CONTAINER_multihashmap_destroy (trackers);
 157 }
 158
 159 /* end of gnunet-service-ats_reservations.c */