fix
[oweals/gnunet.git] / src / rps / rps_api.c
index 96660ded6c2f097f8911eaf96066d82ea203099a..7d0674aff12d10ccb2240368bd93d6184421c29f 100644 (file)
 #include "gnunet_util_lib.h"
 #include "rps.h"
 #include "gnunet_rps_service.h"
+#include "rps-sampler_client.h"
 
 #include <inttypes.h>
 
 #define LOG(kind,...) GNUNET_log_from (kind, "rps-api",__VA_ARGS__)
 
 /**
- * Handler to handle requests from a client.
+ * Handle for a request to get peers from biased stream of ids
  */
-struct GNUNET_RPS_Handle
+struct GNUNET_RPS_StreamRequestHandle
 {
   /**
-   * The handle to the client configuration.
+   * The client issuing the request.
    */
-  const struct GNUNET_CONFIGURATION_Handle *cfg;
+  struct GNUNET_RPS_Handle *rps_handle;
 
   /**
-   * The message queue to the client.
+   * The number of requested peers.
    */
-  struct GNUNET_MQ_Handle *mq;
+  uint32_t num_peers_left;
 
   /**
-   * Array of Request_Handles.
+   * The callback to be called when we receive an answer.
    */
-  struct GNUNET_CONTAINER_MultiHashMap32 *req_handlers;
+  GNUNET_RPS_NotifyReadyCB ready_cb;
 
   /**
-   * The id of the last request.
+   * The closure for the callback.
+   */
+  void *ready_cb_cls;
+
+  /**
+   * @brief Next element of the DLL
    */
-  uint32_t current_request_id;
+  struct GNUNET_RPS_StreamRequestHandle *next;
+
+  /**
+   * @brief Previous element of the DLL
+   */
+  struct GNUNET_RPS_StreamRequestHandle *prev;
+};
+
+
+/**
+ * Handler to handle requests from a client.
+ */
+struct GNUNET_RPS_Handle
+{
+  /**
+   * The handle to the client configuration.
+   */
+  const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+  /**
+   * The message queue to the client.
+   */
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * @brief Callback called on each update of the view
    */
-  GNUNET_RPS_ViewUpdateCB view_update_cb;
+  GNUNET_RPS_NotifyReadyCB view_update_cb;
 
   /**
    * @brief Closure to each requested update of the view
@@ -66,19 +94,24 @@ struct GNUNET_RPS_Handle
   void *view_update_cls;
 
   /**
-   * @brief Callback called on each peer of the biased input stream
+   * @brief Closure to each requested peer from the biased stream
    */
-  GNUNET_RPS_StreamInputCB stream_input_cb;
+  void *stream_input_cls;
 
   /**
-   * @brief Closure to each requested peer from the biased stream
+   * @brief Head of the DLL of stream requests
    */
-  void *stream_input_cls;
+  struct GNUNET_RPS_StreamRequestHandle *stream_requests_head;
+
+  /**
+   * @brief Tail of the DLL of stream requests
+   */
+  struct GNUNET_RPS_StreamRequestHandle *stream_requests_tail;
 };
 
 
 /**
- * Handler to single requests from the client.
+ * Handler for a single request from a client.
  */
 struct GNUNET_RPS_Request_Handle
 {
@@ -88,14 +121,25 @@ struct GNUNET_RPS_Request_Handle
   struct GNUNET_RPS_Handle *rps_handle;
 
   /**
-   * The id of the request.
+   * The number of requested peers.
    */
-  uint32_t id;
+  uint32_t num_requests;
 
   /**
-   * The number of requested peers.
+   * @brief The Sampler for the client request
+   */
+  struct RPS_Sampler *sampler;
+
+  /**
+   * @brief Request handle of the request to the sampler - needed to cancel the request
+   */
+  struct RPS_SamplerRequestHandle *sampler_rh;
+
+  /**
+   * @brief Request handle of the request of the biased stream of peers -
+   * needed to cancel the request
    */
-  uint32_t num_peers;
+  struct GNUNET_RPS_StreamRequestHandle *srh;
 
   /**
    * The callback to be called when we receive an answer.
@@ -131,128 +175,140 @@ struct cb_cls_pack
  struct GNUNET_CLIENT_Connection *service_conn;
 };
 
+
 /**
- * @brief Send a request to the service.
+ * @brief Create a new handle for a stream request
+ *
+ * @param rps_handle The rps handle
+ * @param num_peers The number of desired peers
+ * @param ready_cb The callback to be called, once all peers are ready
+ * @param cls The colsure to provide to the callback
  *
- * @param h rps handle
- * @param id id of the request
- * @param num_req_peers number of peers
+ * @return The handle to the stream request
  */
-void
-send_request (const struct GNUNET_RPS_Handle *h,
-              uint32_t id,
-              uint32_t num_req_peers)
+static struct GNUNET_RPS_StreamRequestHandle *
+new_stream_request (struct GNUNET_RPS_Handle *rps_handle,
+                    uint64_t num_peers,
+                    GNUNET_RPS_NotifyReadyCB ready_cb,
+                    void *cls)
 {
-  struct GNUNET_MQ_Envelope *ev;
-  struct GNUNET_RPS_CS_RequestMessage *msg;
+  struct GNUNET_RPS_StreamRequestHandle *srh;
 
-  ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST);
-  msg->num_peers = htonl (num_req_peers);
-  msg->id = htonl (id);
-  GNUNET_MQ_send (h->mq, ev);
+  srh = GNUNET_new (struct GNUNET_RPS_StreamRequestHandle);
+
+  srh->rps_handle = rps_handle;
+  srh->num_peers_left = num_peers;
+  srh->ready_cb = ready_cb;
+  srh->ready_cb_cls = cls;
+  GNUNET_CONTAINER_DLL_insert (rps_handle->stream_requests_head,
+                               rps_handle->stream_requests_tail,
+                               srh);
+
+  return srh;
 }
 
+
 /**
- * @brief Iterator function over pending requests
- *
- * Implements #GNUNET_CONTAINER_HashMapIterator32
- *
- * @param cls rps handle
- * @param key id of the request
- * @param value request handle
+ * @brief Remove the given stream request from the list of requests and memory
  *
- * @return GNUNET_YES to continue iteration
+ * @param srh The request to be removed
+ * @param srh_head Head of the DLL to remove request from
+ * @param srh_tail Tail of the DLL to remove request from
  */
-int
-resend_requests_iterator (void *cls, uint32_t key, void *value)
+static void
+remove_stream_request (struct GNUNET_RPS_StreamRequestHandle *srh,
+                       struct GNUNET_RPS_StreamRequestHandle *srh_head,
+                       struct GNUNET_RPS_StreamRequestHandle *srh_tail)
 {
-  const struct GNUNET_RPS_Handle *h = cls;
-  const struct GNUNET_RPS_Request_Handle *req_handle = value;
-  (void) key;
+  GNUNET_CONTAINER_DLL_remove (srh_head,
+                               srh_tail,
+                               srh);
 
-  send_request (h, req_handle->id, req_handle->num_peers);
-  return GNUNET_YES; /* continue iterating */
+  GNUNET_free (srh);
 }
 
+
 /**
- * @brief Resend all pending requests
+ * @brief Called once the sampler has collected all requested peers.
  *
- * This is used to resend all pending requests after the client
- * reconnected to the service, because the service cancels all
- * pending requests after reconnection.
+ * Calls the callback provided by the client with the corresponding cls.
  *
- * @param h rps handle
+ * @param peers The array of @a num_peers that has been returned.
+ * @param num_peers The number of peers that have been returned
+ * @param cls The #GNUNET_RPS_Request_Handle
  */
 void
-resend_requests (struct GNUNET_RPS_Handle *h)
+peers_ready_cb (const struct GNUNET_PeerIdentity *peers,
+                uint32_t num_peers,
+                void *cls)
 {
-  GNUNET_CONTAINER_multihashmap32_iterate (h->req_handlers,
-                                           resend_requests_iterator,
-                                           h);
+  struct GNUNET_RPS_Request_Handle *rh = cls;
+
+  rh->ready_cb (rh->ready_cb_cls,
+                num_peers,
+                peers);
+  // TODO cleanup, sampler, rh, cancel stuff
+  // TODO screw this function. We can give the cb,cls directly to the sampler.
 }
 
 
 /**
- * This function is called, when the service replies to our request.
- * It verifies that @a msg is well-formed.
+ * @brief Callback to collect the peers from the biased stream and put those
+ * into the sampler.
  *
- * @param cls the closure
- * @param msg the message
- * @return #GNUNET_OK if @a msg is well-formed
+ * @param cls The #GNUNET_RPS_Request_Handle
+ * @param num_peers The number of peer that have been returned
+ * @param peers The array of @a num_peers that have been returned
  */
-static int
-check_reply (void *cls,
-             const struct GNUNET_RPS_CS_ReplyMessage *msg)
+void
+collect_peers_cb (void *cls,
+                  uint64_t num_peers,
+                  const struct GNUNET_PeerIdentity *peers)
 {
-  uint16_t msize = ntohs (msg->header.size);
-  uint32_t num_peers = ntohl (msg->num_peers);
-  (void) cls;
+  struct GNUNET_RPS_Request_Handle *rh = cls;
 
-  msize -= sizeof (struct GNUNET_RPS_CS_ReplyMessage);
-  if ( (msize / sizeof (struct GNUNET_PeerIdentity) != num_peers) ||
-       (msize % sizeof (struct GNUNET_PeerIdentity) != 0) )
+  for (uint64_t i = 0; i < num_peers; i++)
   {
-    GNUNET_break (0);
-    return GNUNET_SYSERR;
+    RPS_sampler_update (rh->sampler, &peers[i]);
   }
-  return GNUNET_OK;
 }
 
 
 /**
- * This function is called, when the service replies to our request.
- * It calls the callback the caller gave us with the provided closure
- * and disconnects afterwards.
+ * @brief Create new request handle
  *
- * @param cls the closure
- * @param msg the message
+ * @param rps_handle Handle to the service
+ * @param num_requests Number of requests
+ * @param ready_cb Callback
+ * @param cls Closure
+ *
+ * @return The newly created request handle
  */
-static void
-handle_reply (void *cls,
-              const struct GNUNET_RPS_CS_ReplyMessage *msg)
+static struct GNUNET_RPS_Request_Handle *
+new_request_handle (struct GNUNET_RPS_Handle *rps_handle,
+                    uint64_t num_requests,
+                    GNUNET_RPS_NotifyReadyCB ready_cb,
+                    void *cls)
 {
-  struct GNUNET_RPS_Handle *h = cls;
-  struct GNUNET_PeerIdentity *peers;
   struct GNUNET_RPS_Request_Handle *rh;
-  uint32_t id;
 
-  /* Give the peers back */
-  id = ntohl (msg->id);
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Service replied with %" PRIu32 " peers for id %" PRIu32 "\n",
-       ntohl (msg->num_peers),
-       id);
+  rh = GNUNET_new (struct GNUNET_RPS_Request_Handle);
+  rh->rps_handle = rps_handle;
+  rh->num_requests = num_requests;
+  rh->sampler = RPS_sampler_mod_init (num_requests,
+                                      GNUNET_TIME_UNIT_SECONDS); // TODO remove this time-stuff
+  rh->sampler_rh = RPS_sampler_get_n_rand_peers (rh->sampler,
+                                                 num_requests,
+                                                 peers_ready_cb,
+                                                 rh);
+  rh->srh = GNUNET_RPS_stream_request (rps_handle,
+                                       0, /* infinite updates */
+                                       collect_peers_cb,
+                                       rh); /* cls */
+  rh->ready_cb = ready_cb;
+  rh->ready_cb_cls = cls;
 
-  peers = (struct GNUNET_PeerIdentity *) &msg[1];
-  GNUNET_assert (GNUNET_YES ==
-      GNUNET_CONTAINER_multihashmap32_contains (h->req_handlers, id));
-  rh = GNUNET_CONTAINER_multihashmap32_get (h->req_handlers, id);
-  GNUNET_assert (NULL != rh);
-  GNUNET_assert (rh->num_peers == ntohl (msg->num_peers));
-  GNUNET_CONTAINER_multihashmap32_remove_all (h->req_handlers, id);
-  rh->ready_cb (rh->ready_cb_cls,
-                ntohl (msg->num_peers),
-                peers);
+  return rh;
 }
 
 
@@ -270,7 +326,7 @@ handle_reply (void *cls,
 void
 GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle,
                          uint32_t num_updates,
-                         GNUNET_RPS_ViewUpdateCB view_update_cb,
+                         GNUNET_RPS_NotifyReadyCB view_update_cb,
                          void *cls)
 {
   struct GNUNET_MQ_Envelope *ev;
@@ -288,6 +344,20 @@ GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle,
 }
 
 
+void
+GNUNET_RPS_view_request_cancel (struct GNUNET_RPS_Handle *rps_handle)
+{
+  struct GNUNET_MQ_Envelope *ev;
+
+  GNUNET_assert (NULL != rps_handle->view_update_cb);
+
+  rps_handle->view_update_cb = NULL;
+
+  ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_VIEW_CANCEL);
+  GNUNET_MQ_send (rps_handle->mq, ev);
+}
+
+
 /**
  * Request biased stream of peers that are being put into the sampler
  *
@@ -297,24 +367,27 @@ GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle,
  * @param cls a closure that will be given to the callback
  * @param ready_cb the callback called when the peers are available
  */
-void
+struct GNUNET_RPS_StreamRequestHandle *
 GNUNET_RPS_stream_request (struct GNUNET_RPS_Handle *rps_handle,
                            uint32_t num_peers,
-                           GNUNET_RPS_StreamInputCB stream_input_cb,
+                           GNUNET_RPS_NotifyReadyCB stream_input_cb,
                            void *cls)
 {
+  struct GNUNET_RPS_StreamRequestHandle *srh;
   struct GNUNET_MQ_Envelope *ev;
   struct GNUNET_RPS_CS_DEBUG_StreamRequest *msg;
 
+  srh = new_stream_request (rps_handle,
+                            num_peers, /* num requests */
+                            stream_input_cb,
+                            cls);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Client requests %" PRIu32 " biased stream updates\n",
        num_peers);
-  rps_handle->stream_input_cb = stream_input_cb;
-  rps_handle->stream_input_cls = cls;
 
   ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_STREAM_REQUEST);
-  msg->num_peers = htonl (num_peers);
   GNUNET_MQ_send (rps_handle->mq, ev);
+  return srh;
 }
 
 
@@ -371,6 +444,41 @@ handle_view_update (void *cls,
 }
 
 
+/**
+ * @brief Send message to service that this client does not want to receive
+ * further updates from the biased peer stream
+ *
+ * @param rps_handle The handle representing the service to the client
+ */
+static void
+cancel_stream (struct GNUNET_RPS_Handle *rps_handle)
+{
+  struct GNUNET_MQ_Envelope *ev;
+
+  ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_STREAM_CANCEL);
+  GNUNET_MQ_send (rps_handle->mq, ev);
+}
+
+
+/**
+ * @brief Cancel a specific request for updates from the biased peer stream
+ *
+ * @param srh The request handle to cancel
+ */
+void
+GNUNET_RPS_stream_cancel (struct GNUNET_RPS_StreamRequestHandle *srh)
+{
+  struct GNUNET_RPS_Handle *rps_handle;
+
+  rps_handle = srh->rps_handle;
+  GNUNET_CONTAINER_DLL_remove (rps_handle->stream_requests_head,
+                               rps_handle->stream_requests_tail,
+                               srh);
+  GNUNET_free (srh);
+  if (NULL == rps_handle->stream_requests_head) cancel_stream (rps_handle);
+}
+
+
 /**
  * This function is called, when the service sends another peer from the biased
  * stream.
@@ -413,16 +521,71 @@ handle_stream_input (void *cls,
 {
   struct GNUNET_RPS_Handle *h = cls;
   const struct GNUNET_PeerIdentity *peers;
+  /* The following two pointers are used to prevent that new handles are
+   * inserted into the DLL, that is currently iterated over, from within a call
+   * to that handler_cb, are executed and in turn again add themselves to the
+   * iterated DLL infinitely */
+  struct GNUNET_RPS_StreamRequestHandle *srh_head_tmp;
+  struct GNUNET_RPS_StreamRequestHandle *srh_tail_tmp;
+  uint64_t num_peers;
+  uint64_t num_peers_return;
 
-  /* Give the peers back */
+  peers = (struct GNUNET_PeerIdentity *) &msg[1];
+  num_peers = ntohl (msg->num_peers);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "New peer of %" PRIu64 " biased input stream\n",
-       ntohl (msg->num_peers));
+       "Received %" PRIu64 " peer(s) from stream input.\n",
+       num_peers);
+  srh_head_tmp = h->stream_requests_head;
+  srh_tail_tmp = h->stream_requests_tail;
+  h->stream_requests_head = NULL;
+  h->stream_requests_tail = NULL;
+  for (struct GNUNET_RPS_StreamRequestHandle *srh_iter = srh_head_tmp;
+       NULL != srh_iter;
+       srh_iter = srh_iter->next)
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "Calling srh - left: %" PRIu64 "\n",
+        srh_iter->num_peers_left);
+    if (0 == srh_iter->num_peers_left) /* infinite updates */
+    {
+      num_peers_return = num_peers;
+    }
+    else if (num_peers > srh_iter->num_peers_left)
+    {
+      num_peers_return = num_peers - srh_iter->num_peers_left;
+    }
+    else /* num_peers <= srh_iter->num_peers_left */
+    {
+      num_peers_return = srh_iter->num_peers_left - num_peers;
+    }
+    srh_iter->ready_cb (srh_iter->ready_cb_cls,
+                        num_peers_return,
+                        peers);
+    if (0 == srh_iter->num_peers_left) ;
+    else if (num_peers_return >= srh_iter->num_peers_left)
+    {
+      remove_stream_request (srh_iter,
+                             srh_head_tmp,
+                             srh_tail_tmp);
+    }
+    else
+    {
+      srh_iter->num_peers_left -= num_peers_return;
+    }
+  }
+  for (struct GNUNET_RPS_StreamRequestHandle *srh_iter = srh_head_tmp;
+       NULL != srh_iter;
+       srh_iter = srh_iter->next)
+  {
+      GNUNET_CONTAINER_DLL_insert (h->stream_requests_head,
+                                   h->stream_requests_tail,
+                                   srh_iter);
+  }
 
-  peers = (struct GNUNET_PeerIdentity *) &msg[1];
-  GNUNET_assert (NULL != h);
-  GNUNET_assert (NULL != h->stream_input_cb);
-  h->stream_input_cb (h->stream_input_cb, ntohl (msg->num_peers), peers);
+  if (NULL == h->stream_requests_head)
+  {
+    cancel_stream (h);
+  }
 }
 
 
@@ -456,7 +619,6 @@ mq_error_handler (void *cls,
   reconnect (h);
   /* Resend all pending request as the service destroyed its knowledge
    * about them */
-  resend_requests (h);
 }
 
 
@@ -467,10 +629,6 @@ static void
 reconnect (struct GNUNET_RPS_Handle *h)
 {
   struct GNUNET_MQ_MessageHandler mq_handlers[] = {
-    GNUNET_MQ_hd_var_size (reply,
-                           GNUNET_MESSAGE_TYPE_RPS_CS_REPLY,
-                           struct GNUNET_RPS_CS_ReplyMessage,
-                           h),
     GNUNET_MQ_hd_var_size (view_update,
                            GNUNET_MESSAGE_TYPE_RPS_CS_DEBUG_VIEW_REPLY,
                            struct GNUNET_RPS_CS_DEBUG_ViewReply,
@@ -504,7 +662,6 @@ GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
   struct GNUNET_RPS_Handle *h;
 
   h = GNUNET_new (struct GNUNET_RPS_Handle);
-  h->current_request_id = 0;
   h->cfg = cfg;
   reconnect (h);
   if (NULL == h->mq)
@@ -512,7 +669,6 @@ GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
     GNUNET_free (h);
     return NULL;
   }
-  h->req_handlers = GNUNET_CONTAINER_multihashmap32_create (4);
   return h;
 }
 
@@ -534,22 +690,12 @@ GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *rps_handle,
 {
   struct GNUNET_RPS_Request_Handle *rh;
 
-  rh = GNUNET_new (struct GNUNET_RPS_Request_Handle);
-  rh->rps_handle = rps_handle;
-  rh->id = rps_handle->current_request_id++;
-  rh->num_peers = num_req_peers;
-  rh->ready_cb = ready_cb;
-  rh->ready_cb_cls = cls;
-
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Requesting %" PRIu32 " peers with id %" PRIu32 "\n",
-       num_req_peers,
-       rh->id);
+  rh = new_request_handle (rps_handle,
+                           num_req_peers,
+                           ready_cb,
+                           cls);
 
-  GNUNET_CONTAINER_multihashmap32_put (rps_handle->req_handlers, rh->id, rh,
-      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
 
-  send_request (rps_handle, rh->id, num_req_peers);
   return rh;
 }
 
@@ -717,20 +863,21 @@ void
 GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh)
 {
   struct GNUNET_RPS_Handle *h;
-  struct GNUNET_MQ_Envelope *ev;
-  struct GNUNET_RPS_CS_RequestCancelMessage*msg;
-
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Cancelling request with id %" PRIu32 "\n",
-       rh->id);
 
   h = rh->rps_handle;
-  GNUNET_assert (GNUNET_CONTAINER_multihashmap32_contains (h->req_handlers,
-        rh->id));
-  GNUNET_CONTAINER_multihashmap32_remove_all (h->req_handlers, rh->id);
-  ev = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST_CANCEL);
-  msg->id = htonl (rh->id);
-  GNUNET_MQ_send (rh->rps_handle->mq, ev);
+  if (NULL != rh->srh)
+  {
+    remove_stream_request (rh->srh,
+                           h->stream_requests_head,
+                           h->stream_requests_tail);
+  }
+  if (NULL == h->stream_requests_head) cancel_stream(h);
+  if (NULL != rh->sampler_rh)
+  {
+    RPS_sampler_request_cancel (rh->sampler_rh);
+  }
+  RPS_sampler_destroy (rh->sampler);
+  GNUNET_free (rh);
 }
 
 
@@ -743,10 +890,16 @@ void
 GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h)
 {
   GNUNET_MQ_destroy (h->mq);
-  if (0 < GNUNET_CONTAINER_multihashmap32_size (h->req_handlers))
+  if (NULL != h->stream_requests_head)
+  {
     LOG (GNUNET_ERROR_TYPE_WARNING,
-        "Still waiting for requests\n");
-  GNUNET_CONTAINER_multihashmap32_destroy (h->req_handlers);
+        "Still waiting for replies\n");
+  }
+  if (NULL != h->view_update_cb)
+  {
+    LOG (GNUNET_ERROR_TYPE_WARNING,
+        "Still waiting for view updates\n");
+  }
   GNUNET_free (h);
 }