first batch of license fixes (boring)
[oweals/gnunet.git] / src / ats / gnunet-service-ats_reservations.c
index 249e44bfa1b82096a44e7fc03d86b8b9b2456df6..176fc8f19b7e5bd850f5bd6236e1d24b20234af0 100644 (file)
@@ -1,23 +1,17 @@
 /*
      This file is part of GNUnet.
-     (C) 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011 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 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.
-
-     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.
+     Affero General Public License for more details.
 */
-
 /**
  * @file ats/gnunet-service-ats_reservations.c
  * @brief ats service, inbound bandwidth reservation management
  */
 #include "platform.h"
 #include "gnunet-service-ats_reservations.h"
+#include "gnunet-service-ats.h"
+#include "ats.h"
 
 /**
- * Number of seconds that available bandwidth carries over 
- * (can accumulate).
+ * Number of seconds that available bandwidth carries over
+ * (can accumulate).  Note that the
+ * test_ats_reservation_api test depends on this value!
  */
 #define MAX_BANDWIDTH_CARRY_S 5
 
 
 /**
- * Map of peer identities to 'struct GNUNET_BANDWIDTH_Tracker *'s
+ * Map of peer identities to `struct GNUNET_BANDWIDTH_Tracker *`s
  */
-static struct GNUNET_CONTAINER_MultiHashMap *trackers;
+static struct GNUNET_CONTAINER_MultiPeerMap *trackers;
 
 
 /**
@@ -50,26 +47,39 @@ static struct GNUNET_CONTAINER_MultiHashMap *trackers;
  *         peer is not connected, otherwise the time to wait
  *         until the reservation might succeed
  */
-struct GNUNET_TIME_Relative
-GAS_reservations_reserve (const struct GNUNET_PeerIdentity *peer,
-                         int32_t amount)
+static struct GNUNET_TIME_Relative
+reservations_reserve (const struct GNUNET_PeerIdentity *peer,
+                      int32_t amount)
 {
   struct GNUNET_BANDWIDTH_Tracker *tracker;
   struct GNUNET_TIME_Relative ret;
 
-  tracker = GNUNET_CONTAINER_multihashmap_get (trackers,
-                                              &peer->hashPubKey);
+  tracker = GNUNET_CONTAINER_multipeermap_get (trackers,
+                                               peer);
   if (NULL == tracker)
-    return GNUNET_TIME_UNIT_FOREVER_REL;
+  {
+    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 > 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;
+    }
   }
-  GNUNET_break (GNUNET_NO == /* no == not above limit */
-               GNUNET_BANDWIDTH_tracker_consume (tracker, amount));
+  (void) GNUNET_BANDWIDTH_tracker_consume (tracker, amount);
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Reserved %d bytes\n",
+              (int) amount);
   return GNUNET_TIME_UNIT_ZERO;
 }
 
@@ -77,42 +87,81 @@ GAS_reservations_reserve (const struct GNUNET_PeerIdentity *peer,
 /**
  * Set the amount of bandwidth the other peer could currently transmit
  * to us (as far as we know) to the given value.
- * 
+ *
  * @param peer identity of the peer
  * @param bandwidth_in currently available bandwidth from that peer to
  *        this peer (estimate)
  */
 void
 GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
-                               struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
+                                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 {
   struct GNUNET_BANDWIDTH_Tracker *tracker;
 
-  tracker = GNUNET_CONTAINER_multihashmap_get (trackers,
-                                              &peer->hashPubKey);
+  tracker = GNUNET_CONTAINER_multipeermap_get (trackers, peer);
   if (0 == ntohl (bandwidth_in.value__))
   {
+    if (NULL == tracker)
+      return;
     GNUNET_assert (GNUNET_YES ==
-                  GNUNET_CONTAINER_multihashmap_remove (trackers,
-                                                        &peer->hashPubKey,
-                                                        tracker));
+                   GNUNET_CONTAINER_multipeermap_remove (trackers,
+                                                         peer,
+                                                         tracker));
     GNUNET_free (tracker);
     return;
   }
   if (NULL == tracker)
   {
-    tracker = GNUNET_malloc (sizeof (struct GNUNET_BANDWIDTH_Tracker));
+    tracker = GNUNET_new (struct GNUNET_BANDWIDTH_Tracker);
     GNUNET_BANDWIDTH_tracker_init (tracker,
-                                  bandwidth_in,
-                                  MAX_BANDWIDTH_CARRY_S);
-    GNUNET_CONTAINER_multihashmap_put (trackers,
-                                      &peer->hashPubKey,
-                                      tracker,
-                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
+                                   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);
+                                         bandwidth_in);
+}
+
+
+/**
+ * Handle 'reservation request' messages from clients.
+ *
+ * @param client client that sent the request
+ * @param msg the request message
+ */
+void
+GAS_handle_reservation_request (struct GNUNET_SERVICE_Client *client,
+                                const struct ReservationRequestMessage *msg)
+{
+  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);
 }
 
 
@@ -122,7 +171,8 @@ GAS_reservations_set_bandwidth (const struct GNUNET_PeerIdentity *peer,
 void
 GAS_reservations_init ()
 {
-  trackers = GNUNET_CONTAINER_multihashmap_create(128);
+  trackers = GNUNET_CONTAINER_multipeermap_create (128,
+                                                   GNUNET_NO);
 }
 
 
@@ -131,15 +181,16 @@ GAS_reservations_init ()
  *
  * @param cls NULL
  * @param key peer identity (unused)
- * @param value the 'struct GNUNET_BANDWIDTH_Tracker' to free
- * @return GNUNET_OK (continue to iterate)
+ * @param value the `struct GNUNET_BANDWIDTH_Tracker` to free
+ * @return #GNUNET_OK (continue to iterate)
  */
-static int 
+static int
 free_tracker (void *cls,
-             const GNUNET_HashCode * key,
+             const struct GNUNET_PeerIdentity *key,
              void *value)
 {
-  struct GNUNET_BANDWIDTH_Tracker *tracker = cls;
+  struct GNUNET_BANDWIDTH_Tracker *tracker = value;
+
   GNUNET_free (tracker);
   return GNUNET_OK;
 }
@@ -151,8 +202,10 @@ free_tracker (void *cls,
 void
 GAS_reservations_done ()
 {
-  GNUNET_CONTAINER_multihashmap_iterate (trackers, &free_tracker, NULL);
-  GNUNET_CONTAINER_multihashmap_destroy (trackers);
+  GNUNET_CONTAINER_multipeermap_iterate (trackers,
+                                         &free_tracker,
+                                         NULL);
+  GNUNET_CONTAINER_multipeermap_destroy (trackers);
 }
 
 /* end of gnunet-service-ats_reservations.c */