Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / rps / gnunet-service-rps_peers.c
index d52a6cfd53b77a47a8b89b02cea4da20a0fdc9a1..e0b278bd00225d9cfc85281cedfe4360409cde47 100644 (file)
@@ -24,6 +24,7 @@
  * @author Julius Bünger
  */
 #include "platform.h"
+#include "gnunet_applications.h"
 #include "gnunet_util_lib.h"
 #include "gnunet_cadet_service.h"
 #include <inttypes.h>
@@ -163,7 +164,7 @@ struct PeerContext
    *
    * To be canceled on shutdown.
    */
-  struct GNUNET_CADET_TransmitHandle *transmit_handle;
+  struct PendingMessage *liveliness_check_pending;
 
   /**
    * Number of pending operations.
@@ -174,7 +175,7 @@ struct PeerContext
    * Identity of the peer
    */
   struct GNUNET_PeerIdentity peer_id;
-  
+
   /**
    * Flags indicating status of peer
    */
@@ -271,6 +272,7 @@ get_peer_ctx (const struct GNUNET_PeerIdentity *peer)
   return ctx;
 }
 
+
 /**
  * @brief Create a new #PeerContext and insert it into the peer map
  *
@@ -296,6 +298,7 @@ create_peer_ctx (const struct GNUNET_PeerIdentity *peer)
   return ctx;
 }
 
+
 /**
  * @brief Create or get a #PeerContext
  *
@@ -313,6 +316,7 @@ create_or_get_peer_ctx (const struct GNUNET_PeerIdentity *peer)
   return get_peer_ctx (peer);
 }
 
+
 /**
  * @brief Check whether we have a connection to this @a peer
  *
@@ -347,6 +351,7 @@ Peers_check_connected (const struct GNUNET_PeerIdentity *peer)
   return GNUNET_YES;
 }
 
+
 /**
  * @brief The closure to #get_rand_peer_iterator.
  */
@@ -365,6 +370,7 @@ struct GetRandPeerIteratorCls
   const struct GNUNET_PeerIdentity *peer;
 };
 
+
 /**
  * @brief Iterator function for #get_random_peer_from_peermap.
  *
@@ -395,6 +401,7 @@ get_rand_peer_iterator (void *cls,
   return GNUNET_YES;
 }
 
+
 /**
  * @brief Get a random peer from @a peer_map
  *
@@ -420,6 +427,7 @@ get_random_peer_from_peermap (const struct
   return ret;
 }
 
+
 /**
  * @brief Add a given @a peer to valid peers.
  *
@@ -448,6 +456,7 @@ add_valid_peer (const struct GNUNET_PeerIdentity *peer)
   return ret;
 }
 
+
 /**
  * @brief Set the peer flag to living and
  *        call the pending operations on this peer.
@@ -462,21 +471,26 @@ set_peer_live (struct PeerContext *peer_ctx)
   struct GNUNET_PeerIdentity *peer;
   unsigned int i;
 
-  /* Cancle cadet transmit_handle if still scheduled */
-  if (NULL != peer_ctx->transmit_handle)
-  {
-    GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->transmit_handle);
-    peer_ctx->transmit_handle = NULL;
-  }
-
   peer = &peer_ctx->peer_id;
-  (void) add_valid_peer (peer);
-  set_peer_flag (peer_ctx, Peers_ONLINE);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Peer %s is live and valid, calling %i pending operations on it\n",
       GNUNET_i2s (peer),
       peer_ctx->num_pending_ops);
 
+  if (NULL != peer_ctx->liveliness_check_pending)
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Removing pending liveliness check for peer %s\n",
+         GNUNET_i2s (&peer_ctx->peer_id));
+    // TODO wait until cadet sets mq->cancel_impl
+    //GNUNET_MQ_send_cancel (peer_ctx->liveliness_check_pending->ev);
+    GNUNET_free (peer_ctx->liveliness_check_pending);
+    peer_ctx->liveliness_check_pending = NULL;
+  }
+
+  (void) add_valid_peer (peer);
+  set_peer_flag (peer_ctx, Peers_ONLINE);
+
   /* Call pending operations */
   for (i = 0; i < peer_ctx->num_pending_ops; i++)
   {
@@ -485,6 +499,7 @@ set_peer_live (struct PeerContext *peer_ctx)
   GNUNET_array_grow (peer_ctx->pending_ops, peer_ctx->num_pending_ops, 0);
 }
 
+
 /**
  * @brief Get the channel of a peer. If not existing, create.
  *
@@ -495,6 +510,7 @@ struct GNUNET_CADET_Channel *
 get_channel (const struct GNUNET_PeerIdentity *peer)
 {
   struct PeerContext *peer_ctx;
+  struct GNUNET_HashCode port;
 
   peer_ctx = get_peer_ctx (peer);
   if (NULL == peer_ctx->send_channel)
@@ -502,23 +518,27 @@ get_channel (const struct GNUNET_PeerIdentity *peer)
     LOG (GNUNET_ERROR_TYPE_DEBUG,
          "Trying to establish channel to peer %s\n",
          GNUNET_i2s (peer));
+    GNUNET_CRYPTO_hash (GNUNET_APPLICATION_PORT_RPS,
+                        strlen (GNUNET_APPLICATION_PORT_RPS),
+                        &port);
     peer_ctx->send_channel =
       GNUNET_CADET_channel_create (cadet_handle,
                                    peer_ctx->send_channel_flags, /* context */
                                    peer,
-                                   GNUNET_RPS_CADET_PORT,
+                                   &port,
                                    GNUNET_CADET_OPTION_RELIABLE);
   }
   GNUNET_assert (NULL != peer_ctx->send_channel);
   return peer_ctx->send_channel;
 }
 
+
 /**
  * Get the message queue (#GNUNET_MQ_Handle) of a specific peer.
  *
  * If we already have a message queue open to this client,
  * simply return it, otherways create one.
- * 
+ *
  * @param peer the peer to get the mq to
  * @return the #GNUNET_MQ_Handle
  */
@@ -528,7 +548,6 @@ get_mq (const struct GNUNET_PeerIdentity *peer)
   struct PeerContext *peer_ctx;
 
   peer_ctx = get_peer_ctx (peer);
-  GNUNET_assert (NULL == peer_ctx->transmit_handle);
 
   if (NULL == peer_ctx->mq)
   {
@@ -538,52 +557,27 @@ get_mq (const struct GNUNET_PeerIdentity *peer)
   return peer_ctx->mq;
 }
 
+
 /**
- * @brief Callback that is called when a channel was effectively established.
- *
- * This is an implementation of #GNUNET_CONNECTION_TransmitReadyNotify and
- * given to #GNUNET_CADET_notify_transmit_ready_cancel and called when the
- * channel was successfully established.
- *
- * This function type was originally ment to be called to provide the data to
- * be sent. This is called when the connection is ready to queue more data.
- * However we use it to get notified about the successful establishement of a
- * cadet channel.
- *
- * @a buf will be NULL and @a size zero if the
- * connection was closed for writing in the meantime.
+ * @brief This is called in response to the first message we sent as a
+ * liveliness check.
  *
- * @param cls closure
- * @param size number of bytes available in @a buf
- * @param buf where the callee should write the message
- * @return number of bytes written to @a buf
+ * @param cls #PeerContext of peer with pending liveliness check
  */
-//TODO
-static size_t
-cadet_notify_transmit_ready_cb (void *cls, size_t size, void *buf)
+static void
+mq_liveliness_check_successful (void *cls)
 {
-  struct PeerContext *peer_ctx = (struct PeerContext *) cls;
-  // TODO make sure the context is not deleted or the establishing of the
-  //      channel is cancelled
-
-  peer_ctx->transmit_handle = NULL;
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Set ->transmit_handle = NULL for peer %s\n",
-       GNUNET_i2s (&peer_ctx->peer_id));
+  struct PeerContext *peer_ctx = cls;
 
-  if ( (NULL != buf) &&
-       (0 != size) )
+  if (NULL != peer_ctx->liveliness_check_pending)
   {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "Liveliness check for peer %s was successfull\n",
+        GNUNET_i2s (&peer_ctx->peer_id));
+    GNUNET_free (peer_ctx->liveliness_check_pending);
+    peer_ctx->liveliness_check_pending = NULL;
     set_peer_live (peer_ctx);
   }
-  else
-  {
-    LOG (GNUNET_ERROR_TYPE_WARNING,
-         "Problems establishing a connection to peer %s in order to check liveliness\n",
-         GNUNET_i2s (&peer_ctx->peer_id));
-    // TODO reschedule? cleanup?
-  }
-  return 0;
 }
 
 /**
@@ -598,32 +592,19 @@ check_peer_live (struct PeerContext *peer_ctx)
        "Get informed about peer %s getting live\n",
        GNUNET_i2s (&peer_ctx->peer_id));
 
-  if (NULL != peer_ctx->transmit_handle)
-  {
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Already waiting for notification\n");
-    return;
-  }
-  if (NULL != peer_ctx->send_channel)
-  {
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Already have established channel to peer\n");
-    return;
-  }
-  (void) get_channel (&peer_ctx->peer_id);
-  peer_ctx->transmit_handle =
-      GNUNET_CADET_notify_transmit_ready (peer_ctx->send_channel,
-                                          GNUNET_NO,
-                                          GNUNET_TIME_UNIT_FOREVER_REL,
-                                          sizeof (struct GNUNET_MessageHeader),
-                                          cadet_notify_transmit_ready_cb,
-                                          peer_ctx);
-  if (NULL == peer_ctx->transmit_handle)
-  {
-    LOG (GNUNET_ERROR_TYPE_WARNING,
-        "Cadet was not able to queue the request (insufficient memory)\n");
-    GNUNET_break (0);
-  }
+  struct GNUNET_MQ_Handle *mq;
+  struct GNUNET_MQ_Envelope *ev;
+
+  ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_CHECK_LIVE);
+  peer_ctx->liveliness_check_pending = GNUNET_new (struct PendingMessage);
+  peer_ctx->liveliness_check_pending->ev = ev;
+  peer_ctx->liveliness_check_pending->peer_ctx = peer_ctx;
+  peer_ctx->liveliness_check_pending->type = "Check liveliness";
+  mq = get_mq (&peer_ctx->peer_id);
+  GNUNET_MQ_notify_sent (ev,
+                         mq_liveliness_check_successful,
+                         peer_ctx);
+  GNUNET_MQ_send (mq, ev);
 }
 
 /**
@@ -653,6 +634,7 @@ insert_pending_message (const struct GNUNET_PeerIdentity *peer,
   return pending_msg;
 }
 
+
 /**
  * @brief Remove a pending message from the respective DLL
  *
@@ -673,6 +655,7 @@ remove_pending_message (struct PendingMessage *pending_msg)
   GNUNET_free (pending_msg);
 }
 
+
 /**
  * @brief Check whether function of type #PeerOp was already scheduled
  *
@@ -699,6 +682,7 @@ check_operation_scheduled (const struct GNUNET_PeerIdentity *peer,
   return GNUNET_NO;
 }
 
+
 /**
  * Iterator over hash map entries. Deletes all contexts of peers.
  *
@@ -717,6 +701,7 @@ peermap_clear_iterator (void *cls,
   return GNUNET_YES;
 }
 
+
 /**
  * @brief This is called once a message is sent.
  *
@@ -734,6 +719,7 @@ mq_notify_sent_cb (void *cls)
   remove_pending_message (pending_msg);
 }
 
+
 /**
  * @brief Iterator function for #store_valid_peers.
  *
@@ -774,6 +760,7 @@ store_peer_presistently_iterator (void *cls,
   return GNUNET_YES;
 }
 
+
 /**
  * @brief Store the peers currently in #valid_peers to disk.
  */
@@ -782,10 +769,26 @@ store_valid_peers ()
 {
   struct GNUNET_DISK_FileHandle *fh;
   uint32_t number_written_peers;
+  int ret;
 
-  if (GNUNET_OK !=
-      GNUNET_DISK_directory_create_for_file (filename_valid_peers))
+  if (0 == strncmp ("DISABLE", filename_valid_peers, 7))
   {
+    return;
+  }
+
+  ret = GNUNET_DISK_directory_create_for_file (filename_valid_peers);
+  if (GNUNET_SYSERR == ret)
+  {
+    LOG (GNUNET_ERROR_TYPE_WARNING,
+        "Not able to create directory for file `%s'\n",
+        filename_valid_peers);
+    GNUNET_break (0);
+  }
+  else if (GNUNET_NO == ret)
+  {
+    LOG (GNUNET_ERROR_TYPE_WARNING,
+        "Directory for file `%s' exists but is not writable for us\n",
+        filename_valid_peers);
     GNUNET_break (0);
   }
   fh = GNUNET_DISK_file_open (filename_valid_peers,
@@ -812,6 +815,7 @@ store_valid_peers ()
       GNUNET_CONTAINER_multipeermap_size (valid_peers));
 }
 
+
 /**
  * @brief Convert string representation of peer id to peer id.
  *
@@ -857,6 +861,7 @@ s2i_full (const char *string_repr)
   return peer;
 }
 
+
 /**
  * @brief Restore the peers on disk to #valid_peers.
  */
@@ -869,9 +874,14 @@ restore_valid_peers ()
   char *buf;
   ssize_t size_read;
   char *iter_buf;
-  const char *str_repr;
+  char *str_repr;
   const struct GNUNET_PeerIdentity *peer;
 
+  if (0 == strncmp ("DISABLE", filename_valid_peers, 7))
+  {
+    return;
+  }
+
   if (GNUNET_OK != GNUNET_DISK_file_test (filename_valid_peers))
   {
     return;
@@ -885,26 +895,38 @@ restore_valid_peers ()
   buf = GNUNET_malloc (file_size);
   size_read = GNUNET_DISK_file_read (fh, buf, file_size);
   GNUNET_assert (size_read == file_size);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+      "Restoring %" PRIu32 " peers from file `%s'\n",
+      num_peers,
+      filename_valid_peers);
   for (iter_buf = buf; iter_buf < buf + file_size - 1; iter_buf += 53)
   {
     str_repr = GNUNET_strndup (iter_buf, 53);
     peer = s2i_full (str_repr);
+    GNUNET_free (str_repr);
     add_valid_peer (peer);
     LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Restored valid peer %s from disk\n",
         GNUNET_i2s_full (peer));
   }
+  iter_buf = NULL;
+  GNUNET_free (buf);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
       "num_peers: %" PRIu32 ", _size (valid_peers): %u\n",
       num_peers,
       GNUNET_CONTAINER_multipeermap_size (valid_peers));
-  GNUNET_assert (num_peers == GNUNET_CONTAINER_multipeermap_size (valid_peers));
+  if (num_peers != GNUNET_CONTAINER_multipeermap_size (valid_peers))
+  {
+    LOG (GNUNET_ERROR_TYPE_WARNING,
+        "Number of restored peers does not match file size. Have probably duplicates.\n");
+  }
   GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
   LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Restored %u valid peers from disk\n",
-      num_peers);
+      GNUNET_CONTAINER_multipeermap_size (valid_peers));
 }
 
+
 /**
  * @brief Initialise storage of peers
  *
@@ -925,6 +947,7 @@ Peers_initialise (char* fn_valid_peers,
   restore_valid_peers ();
 }
 
+
 /**
  * @brief Delete storage of peers that was created with #Peers_initialise ()
  */
@@ -993,6 +1016,7 @@ Peers_get_valid_peers (PeersIterator iterator,
   return ret;
 }
 
+
 /**
  * @brief Add peer to known peers.
  *
@@ -1047,27 +1071,28 @@ Peers_issue_peer_liveliness_check (const struct GNUNET_PeerIdentity *peer)
   return ret;
 }
 
+
 /**
- * @brief Remove unecessary data
+ * @brief Check if peer is removable.
  *
- * If the other peer is not intending to send messages, we have messages pending
- * to be sent to this peer and we are not waiting for a reply, remove the
- * information about it (its #PeerContext).
+ * Check if
+ *  - a recv channel exists
+ *  - there are pending messages
+ *  - there is no pending pull reply
  *
- * @param peer the peer to clean
- * @return #GNUNET_YES if peer was removed
- *         #GNUNET_NO  otherwise
+ * @param peer the peer in question
+ * @return #GNUNET_YES    if peer is removable
+ *         #GNUNET_NO     if peer is NOT removable
+ *         #GNUNET_SYSERR if peer is not known
  */
 int
-Peers_clean_peer (const struct GNUNET_PeerIdentity *peer)
+Peers_check_removable (const struct GNUNET_PeerIdentity *peer)
 {
   struct PeerContext *peer_ctx;
 
-  // TODO actually remove unnecessary data
-
-  if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer)) 
+  if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
   {
-    return GNUNET_NO;
+    return GNUNET_SYSERR;
   }
 
   peer_ctx = get_peer_ctx (peer);
@@ -1077,13 +1102,13 @@ Peers_clean_peer (const struct GNUNET_PeerIdentity *peer)
   {
     return GNUNET_NO;
   }
-  Peers_remove_peer (peer);
   return GNUNET_YES;
 }
 
+
 /**
  * @brief Remove peer
- * 
+ *
  * @param peer the peer to clean
  * @return #GNUNET_YES if peer was removed
  *         #GNUNET_NO  otherwise
@@ -1093,7 +1118,7 @@ Peers_remove_peer (const struct GNUNET_PeerIdentity *peer)
 {
   struct PeerContext *peer_ctx;
 
-  if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer)) 
+  if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
   {
     return GNUNET_NO;
   }
@@ -1106,8 +1131,6 @@ Peers_remove_peer (const struct GNUNET_PeerIdentity *peer)
   Peers_unset_peer_flag (peer, Peers_ONLINE);
 
   GNUNET_array_grow (peer_ctx->pending_ops, peer_ctx->num_pending_ops, 0);
-  // TODO delete struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle
-  /* Cancle messages that have not been sent yet */
   while (NULL != peer_ctx->pending_messages_head)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
@@ -1117,21 +1140,27 @@ Peers_remove_peer (const struct GNUNET_PeerIdentity *peer)
   }
   /* If we are still waiting for notification whether this peer is live
    * cancel the according task */
-  if (NULL != peer_ctx->transmit_handle)
+  if (NULL != peer_ctx->liveliness_check_pending)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-         "Trying to cancle transmit_handle for peer %s\n",
+         "Removing pending liveliness check for peer %s\n",
          GNUNET_i2s (&peer_ctx->peer_id));
-    GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->transmit_handle);
-    peer_ctx->transmit_handle = NULL;
+    // TODO wait until cadet sets mq->cancel_impl
+    //GNUNET_MQ_send_cancel (peer_ctx->liveliness_check_pending->ev);
+    GNUNET_free (peer_ctx->liveliness_check_pending);
+    peer_ctx->liveliness_check_pending = NULL;
   }
   if (NULL != peer_ctx->send_channel)
   {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "Destroying send channel\n");
     GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
     peer_ctx->send_channel = NULL;
   }
   if (NULL != peer_ctx->recv_channel)
   {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "Destroying recv channel\n");
     GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
     peer_ctx->recv_channel = NULL;
   }
@@ -1152,6 +1181,7 @@ Peers_remove_peer (const struct GNUNET_PeerIdentity *peer)
   return GNUNET_YES;
 }
 
+
 /**
  * @brief set flags on a given peer.
  *
@@ -1167,6 +1197,7 @@ Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlag
   set_peer_flag (peer_ctx, flags);
 }
 
+
 /**
  * @brief unset flags on a given peer.
  *
@@ -1182,6 +1213,7 @@ Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFl
   unset_peer_flag (peer_ctx, flags);
 }
 
+
 /**
  * @brief Check whether flags on a peer are set.
  *
@@ -1218,6 +1250,7 @@ Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
   set_channel_flag (channel_flags, flags);
 }
 
+
 /**
  * @brief unset flags on a given channel.
  *
@@ -1230,6 +1263,7 @@ Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags
   unset_channel_flag (channel_flags, flags);
 }
 
+
 /**
  * @brief Check whether flags on a channel are set.
  *
@@ -1245,6 +1279,7 @@ Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags
   return check_channel_flag_set (channel_flags, flags);
 }
 
+
 /**
  * @brief Check whether we have information about the given peer.
  *
@@ -1261,6 +1296,7 @@ Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer)
   return GNUNET_CONTAINER_multipeermap_contains (peer_map, peer);
 }
 
+
 /**
  * @brief Check whether @a peer is actually a peer.
  *
@@ -1277,6 +1313,7 @@ Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer)
   return GNUNET_CONTAINER_multipeermap_contains (valid_peers, peer);
 }
 
+
 /**
  * @brief Indicate that we want to send to the other peer
  *
@@ -1291,6 +1328,7 @@ Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer)
   (void) get_channel (peer);
 }
 
+
 /**
  * @brief Check whether other peer has the intention to send/opened channel
  *        towars us
@@ -1313,6 +1351,7 @@ Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer)
   return GNUNET_NO;
 }
 
+
 /**
  * Handle the channel a peer opens to us.
  *
@@ -1329,7 +1368,7 @@ void *
 Peers_handle_inbound_channel (void *cls,
                               struct GNUNET_CADET_Channel *channel,
                               const struct GNUNET_PeerIdentity *initiator,
-                              uint32_t port,
+                              const struct GNUNET_HashCode *port,
                               enum GNUNET_CADET_ChannelOption options)
 {
   struct PeerContext *peer_ctx;
@@ -1354,6 +1393,7 @@ Peers_handle_inbound_channel (void *cls,
   return peer_ctx->recv_channel_flags;
 }
 
+
 /**
  * @brief Check whether a sending channel towards the given peer exists
  *
@@ -1379,6 +1419,7 @@ Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer)
   return GNUNET_YES;
 }
 
+
 /**
  * @brief check whether the given channel is the sending channel of the given
  *        peer
@@ -1416,6 +1457,7 @@ Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
   return GNUNET_NO;
 }
 
+
 /**
  * @brief Destroy the send channel of a peer e.g. stop indicating a sending
  *        intention to another peer