-only trigger check config if we actually need it
[oweals/gnunet.git] / src / ats / gnunet-service-ats_connectivity.c
index 4aee2ddb88f62251afed1099c11d9e153eba9695..2cf434c70b7024f054d37530a1ba138744528e33 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011-2015 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011-2015 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
@@ -14,8 +14,8 @@
 
      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.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
  * @brief ats service, interaction with 'connecivity' API
  * @author Matthias Wachs
  * @author Christian Grothoff
- *
- * FIXME:
- * - we should track requests by client, and if a client
- *   disconnects cancel all associated requests; right
- *   now, they will persist forever unless the client
- *   explicitly sends us a cancel before disconnecting!
  */
 #include "platform.h"
 #include "gnunet-service-ats.h"
 
 
 /**
- * Pending Address suggestion requests
+ * Active connection requests.
  */
-struct GAS_Addresses_Suggestion_Requests
+struct ConnectionRequest
 {
   /**
-   * Next in DLL
+   * Client that made the request.
    */
-  struct GAS_Addresses_Suggestion_Requests *next;
+  struct GNUNET_SERVER_Client *client;
 
-  /**
-   * Previous in DLL
-   */
-  struct GAS_Addresses_Suggestion_Requests *prev;
-
-  /**
-   * Peer ID
-   */
-  struct GNUNET_PeerIdentity id;
+  /* TODO: allow client to express a 'strength' for this request */
 };
 
 
 /**
- * Address suggestion requests DLL head.
- * FIXME: This must become a Multipeermap! O(n) operations
- * galore instead of O(1)!!!
- */
-static struct GAS_Addresses_Suggestion_Requests *pending_requests_head;
-
-/**
- * Address suggestion requests DLL tail
+ * Address suggestion requests by peer.
  */
-static struct GAS_Addresses_Suggestion_Requests *pending_requests_tail;
-
-
+static struct GNUNET_CONTAINER_MultiPeerMap *connection_requests;
 
 
 /**
- * Cancel address suggestions for a peer
+ * Is the given peer in the list of peers for which we
+ * have an address request?
  *
- * @param peer the peer id
- */
-void
-GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer)
-{
-  struct GAS_Addresses_Suggestion_Requests *cur = pending_requests_head;
-
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Received request: `%s' for peer %s\n",
-             "request_address_cancel",
-             GNUNET_i2s (peer));
-
-  while (NULL != cur)
-  {
-    if (0 == memcmp (peer, &cur->id, sizeof(cur->id)))
-      break; /* found */
-    cur = cur->next;
-  }
-
-  if (NULL == cur)
-  {
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "No address requests pending for peer `%s', cannot remove!\n",
-                GNUNET_i2s (peer));
-    return;
-  }
-  GAS_plugin_request_connect_stop (peer);
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Removed request pending for peer `%s\n",
-              GNUNET_i2s (peer));
-  GNUNET_CONTAINER_DLL_remove (pending_requests_head,
-                               pending_requests_tail,
-                               cur);
-  GNUNET_free (cur);
-}
-
-
-/**
- * Request address suggestions for a peer
- *
- * @param peer the peer id
+ * @param cls unused, NULL
+ * @param peer peer to query for
+ * @return #GNUNET_YES if so, #GNUNET_NO if not
  */
-void
-GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer)
+unsigned int
+GAS_connectivity_has_peer (void *cls,
+                           const struct GNUNET_PeerIdentity *peer)
 {
-  struct GAS_Addresses_Suggestion_Requests *cur = pending_requests_head;
-
-  GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
-             "Received `%s' for peer `%s'\n",
-             "REQUEST ADDRESS",
-             GNUNET_i2s (peer));
-
-  while (NULL != cur)
-  {
-    if (0 == memcmp (peer, &cur->id, sizeof(cur->id)))
-      break; /* already suggesting */
-    cur = cur->next;
-  }
-  if (NULL == cur)
-  {
-    cur = GNUNET_new (struct GAS_Addresses_Suggestion_Requests);
-    cur->id = *peer;
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                "Adding new address suggestion request for `%s'\n",
-                GNUNET_i2s (peer));
-    GNUNET_CONTAINER_DLL_insert (pending_requests_head,
-                                 pending_requests_tail,
-                                 cur);
-  }
-  GAS_plugin_request_connect_start (peer);
+  if (NULL == connection_requests)
+    return 0;
+  /* TODO: return sum of 'strength's of connectivity requests */
+  return GNUNET_CONTAINER_multipeermap_contains (connection_requests,
+                                                 peer);
 }
 
 
-
 /**
- * Handle 'request address' messages from clients.
+ * Handle #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS messages from clients.
  *
  * @param cls unused, NULL
  * @param client client that sent the request
@@ -166,18 +86,59 @@ GAS_handle_request_address (void *cls,
 {
   const struct RequestAddressMessage *msg =
       (const struct RequestAddressMessage *) message;
+  struct ConnectionRequest *cr;
 
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
               "Received `%s' message\n",
-              "REQUEST_ADDRESS");
-  GNUNET_break (0 == ntohl (msg->reserved));
-  GAS_addresses_request_address (&msg->peer);
+              "GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS");
+  /* FIXME: should not ignore "msg->strength" */
+  cr = GNUNET_new (struct ConnectionRequest);
+  cr->client = client;
+  (void) GNUNET_CONTAINER_multipeermap_put (connection_requests,
+                                            &msg->peer,
+                                            cr,
+                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
+  GAS_plugin_request_connect_start (&msg->peer);
   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
 
 /**
- * Handle 'request address' messages from clients.
+ * Free the connection request from the map if the
+ * closure matches the client.
+ *
+ * @param cls the client to match
+ * @param pid peer for which the request was made
+ * @param value the `struct ConnectionRequest`
+ * @return #GNUNET_OK (continue to iterate)
+ */
+static int
+free_matching_requests (void *cls,
+                        const struct GNUNET_PeerIdentity *pid,
+                        void *value)
+{
+  struct GNUNET_SERVER_Client *client = cls;
+  struct ConnectionRequest *cr = value;
+
+  if (cr->client == client)
+  {
+    GAS_plugin_request_connect_stop (pid);
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "Removed request pending for peer `%s\n",
+                GNUNET_i2s (pid));
+    GNUNET_assert (GNUNET_YES ==
+                   GNUNET_CONTAINER_multipeermap_remove (connection_requests,
+                                                         pid,
+                                                         cr));
+    GNUNET_free (cr);
+  }
+  return GNUNET_OK;
+}
+
+
+/**
+ * Handle #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL messages
+ * from clients.
  *
  * @param cls unused, NULL
  * @param client client that sent the request
@@ -192,10 +153,13 @@ GAS_handle_request_address_cancel (void *cls,
       (const struct RequestAddressMessage *) message;
 
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "Received `%s' message\n",
-              "REQUEST_ADDRESS_CANCEL");
-  GNUNET_break (0 == ntohl (msg->reserved));
-  GAS_addresses_request_address_cancel (&msg->peer);
+              "Received GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL message for peer %s\n",
+              GNUNET_i2s (&msg->peer));
+  GNUNET_break (0 == ntohl (msg->strength));
+  GNUNET_CONTAINER_multipeermap_get_multiple (connection_requests,
+                                              &msg->peer,
+                                              &free_matching_requests,
+                                              client);
   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
@@ -209,7 +173,9 @@ GAS_handle_request_address_cancel (void *cls,
 void
 GAS_connectivity_remove_client (struct GNUNET_SERVER_Client *client)
 {
-  // FIXME
+  GNUNET_CONTAINER_multipeermap_iterate (connection_requests,
+                                         &free_matching_requests,
+                                         client);
 }
 
 
@@ -217,17 +183,47 @@ GAS_connectivity_remove_client (struct GNUNET_SERVER_Client *client)
  * Shutdown connectivity subsystem.
  */
 void
-GAS_connectivity_done ()
+GAS_connectivity_init ()
 {
-  struct GAS_Addresses_Suggestion_Requests *cur;
+  connection_requests = GNUNET_CONTAINER_multipeermap_create (32, GNUNET_NO);
+}
 
-  while (NULL != (cur = pending_requests_head))
-  {
-    GNUNET_CONTAINER_DLL_remove (pending_requests_head,
-                                 pending_requests_tail,
-                                 cur);
-    GNUNET_free(cur);
-  }
+
+/**
+ * Free the connection request from the map.
+ *
+ * @param cls NULL
+ * @param pid peer for which the request was made
+ * @param value the `struct ConnectionRequest`
+ * @return #GNUNET_OK (continue to iterate)
+ */
+static int
+free_request (void *cls,
+              const struct GNUNET_PeerIdentity *pid,
+              void *value)
+{
+  struct ConnectionRequest *cr = value;
+
+  free_matching_requests (cr->client,
+                          pid,
+                          cr);
+  return GNUNET_OK;
+}
+
+
+/**
+ * Shutdown connectivity subsystem.
+ */
+void
+GAS_connectivity_done ()
+{
+  GAS_plugin_solver_lock ();
+  GNUNET_CONTAINER_multipeermap_iterate (connection_requests,
+                                         &free_request,
+                                         NULL);
+  GAS_plugin_solver_unlock ();
+  GNUNET_CONTAINER_multipeermap_destroy (connection_requests);
+  connection_requests = NULL;
 }