REST: nothing triggers rest
[oweals/gnunet.git] / src / ats / gnunet-service-ats_connectivity.c
index 4aee2ddb88f62251afed1099c11d9e153eba9695..3853aeb0eb0a3ae1f5b6e66ab7f3e6a5a67eae7f 100644 (file)
@@ -1,21 +1,21 @@
 /*
      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
-     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 Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     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.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
  * @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
-   */
-  struct GAS_Addresses_Suggestion_Requests *next;
-
-  /**
-   * Previous in DLL
+   * Client that made the request.
    */
-  struct GAS_Addresses_Suggestion_Requests *prev;
+  struct GNUNET_SERVICE_Client *client;
 
-  /**
-   * 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)!!!
+ * Address suggestion requests by peer.
  */
-static struct GAS_Addresses_Suggestion_Requests *pending_requests_head;
+static struct GNUNET_CONTAINER_MultiPeerMap *connection_requests;
+
 
 /**
- * Address suggestion requests DLL tail
+ * Is the given peer in the list of peers for which we
+ * have an address request?
+ *
+ * @param cls unused, NULL
+ * @param peer peer to query for
+ * @return #GNUNET_YES if so, #GNUNET_NO if not
  */
-static struct GAS_Addresses_Suggestion_Requests *pending_requests_tail;
-
-
+unsigned int
+GAS_connectivity_has_peer (void *cls,
+                           const struct GNUNET_PeerIdentity *peer)
+{
+  if (NULL == connection_requests)
+    return 0;
+  /* TODO: return sum of 'strength's of connectivity requests */
+  return GNUNET_CONTAINER_multipeermap_contains (connection_requests,
+                                                 peer);
+}
 
 
 /**
- * Cancel address suggestions for a peer
+ * Handle #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS messages from clients.
  *
- * @param peer the peer id
+ * @param client client that sent the request
+ * @param message the request message
  */
 void
-GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer)
+GAS_handle_request_address (struct GNUNET_SERVICE_Client *client,
+                           const struct RequestAddressMessage *msg)
 {
-  struct GAS_Addresses_Suggestion_Requests *cur = pending_requests_head;
+  struct ConnectionRequest *cr;
 
   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);
+              "Received `%s' message\n",
+              "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);
 }
 
 
 /**
- * Request address suggestions for a peer
+ * Free the connection request from the map if the
+ * closure matches the client.
  *
- * @param peer the peer id
+ * @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)
  */
-void
-GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer)
+static int
+free_matching_requests (void *cls,
+                        const struct GNUNET_PeerIdentity *pid,
+                        void *value)
 {
-  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));
+  struct GNUNET_SERVICE_Client *client = cls;
+  struct ConnectionRequest *cr = value;
 
-  while (NULL != cur)
+  if (cr->client == client)
   {
-    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;
+    GAS_plugin_request_connect_stop (pid);
     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);
+                "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);
   }
-  GAS_plugin_request_connect_start (peer);
+  return GNUNET_OK;
 }
 
 
-
 /**
- * Handle 'request address' messages from clients.
+ * Handle #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL messages
+ * from clients.
  *
- * @param cls unused, NULL
- * @param client client that sent the request
- * @param message the request message
+ * @param client the client that sent the request
+ * @param msg the request message
  */
 void
-GAS_handle_request_address (void *cls,
-                            struct GNUNET_SERVER_Client *client,
-                            const struct GNUNET_MessageHeader *message)
+GAS_handle_request_address_cancel (struct GNUNET_SERVICE_Client *client,
+                                  const struct RequestAddressMessage *msg)
 {
-  const struct RequestAddressMessage *msg =
-      (const struct RequestAddressMessage *) message;
-
   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_SERVER_receive_done (client, GNUNET_OK);
+              "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);
 }
 
 
 /**
- * Handle 'request address' messages from clients.
+ * Unregister a client (which may have been a connectivity client,
+ * but this is not assured).
  *
- * @param cls unused, NULL
- * @param client client that sent the request
- * @param message the request message
+ * @param client handle of the (now dead) client
  */
 void
-GAS_handle_request_address_cancel (void *cls,
-                                   struct GNUNET_SERVER_Client *client,
-                                   const struct GNUNET_MessageHeader *message)
+GAS_connectivity_remove_client (struct GNUNET_SERVICE_Client *client)
 {
-  const struct RequestAddressMessage *msg =
-      (const struct RequestAddressMessage *) message;
+  GNUNET_CONTAINER_multipeermap_iterate (connection_requests,
+                                         &free_matching_requests,
+                                         client);
+}
 
-  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);
-  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+
+/**
+ * Shutdown connectivity subsystem.
+ */
+void
+GAS_connectivity_init ()
+{
+  connection_requests
+    = GNUNET_CONTAINER_multipeermap_create (32,
+                                           GNUNET_NO);
 }
 
 
 /**
- * Unregister a client (which may have been a connectivity client,
- * but this is not assured).
+ * Free the connection request from the map.
  *
- * @param client handle of the (now dead) client
+ * @param cls NULL
+ * @param pid peer for which the request was made
+ * @param value the `struct ConnectionRequest`
+ * @return #GNUNET_OK (continue to iterate)
  */
-void
-GAS_connectivity_remove_client (struct GNUNET_SERVER_Client *client)
+static int
+free_request (void *cls,
+              const struct GNUNET_PeerIdentity *pid,
+              void *value)
 {
-  // FIXME
+  struct ConnectionRequest *cr = value;
+
+  free_matching_requests (cr->client,
+                          pid,
+                          cr);
+  return GNUNET_OK;
 }
 
 
@@ -219,15 +208,13 @@ GAS_connectivity_remove_client (struct GNUNET_SERVER_Client *client)
 void
 GAS_connectivity_done ()
 {
-  struct GAS_Addresses_Suggestion_Requests *cur;
-
-  while (NULL != (cur = pending_requests_head))
-  {
-    GNUNET_CONTAINER_DLL_remove (pending_requests_head,
-                                 pending_requests_tail,
-                                 cur);
-    GNUNET_free(cur);
-  }
+  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;
 }