flush peer respect value on disconnect
[oweals/gnunet.git] / src / fs / gnunet-service-fs_cp.c
index 08737621884aa3e0382683cc7ff20055886774e9..91102af6e10703b26b33ea9ef517f8b42fd4839d 100644 (file)
@@ -31,6 +31,7 @@
 #include "gnunet-service-fs_pe.h"
 #include "gnunet-service-fs_pr.h"
 #include "gnunet-service-fs_push.h"
+#include "gnunet_peerstore_service.h"
 
 
 /**
@@ -302,6 +303,21 @@ struct GSF_ConnectedPeer
    */
   int did_reserve;
 
+  /**
+   * Function called when the creation of this record is complete.
+   */
+  GSF_ConnectedPeerCreationCallback creation_cb;
+
+  /**
+   * Closure for @e creation_cb
+   */
+  void *creation_cb_cls;
+
+  /**
+   * Handle to the PEERSTORE iterate request for peer respect value
+   */
+  struct GNUNET_PEERSTORE_IterateContext *respect_iterate_req;
+
 };
 
 
@@ -311,30 +327,9 @@ struct GSF_ConnectedPeer
 static struct GNUNET_CONTAINER_MultiPeerMap *cp_map;
 
 /**
- * Where do we store respect information?
+ * Handle to peerstore service.
  */
-static char *respectDirectory;
-
-
-/**
- * Get the filename under which we would store respect
- * for the given peer.
- *
- * @param id peer to get the filename for
- * @return filename of the form DIRECTORY/PEERID
- */
-static char *
-get_respect_filename (const struct GNUNET_PeerIdentity *id)
-{
-  char *fn;
-
-  GNUNET_asprintf (&fn,
-                  "%s%s%s",
-                  respectDirectory,
-                  DIR_SEPARATOR_STR,
-                  GNUNET_i2s_full (id));
-  return fn;
-}
+static struct GNUNET_PEERSTORE_Handle *peerstore;
 
 
 /**
@@ -373,13 +368,15 @@ GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp)
 /**
  * Core is ready to transmit to a peer, get the message.
  *
- * @param cls the 'struct GSF_PeerTransmitHandle' of the message
+ * @param cls the `struct GSF_PeerTransmitHandle` of the message
  * @param size number of bytes core is willing to take
  * @param buf where to copy the message
- * @return number of bytes copied to buf
+ * @return number of bytes copied to @a buf
  */
 static size_t
-peer_transmit_ready_cb (void *cls, size_t size, void *buf);
+peer_transmit_ready_cb (void *cls,
+                        size_t size,
+                        void *buf);
 
 
 /**
@@ -393,8 +390,10 @@ peer_transmit_ready_cb (void *cls, size_t size, void *buf);
  *        long should the client wait until re-trying?
  */
 static void
-ats_reserve_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
-                      int32_t amount, struct GNUNET_TIME_Relative res_delay);
+ats_reserve_callback (void *cls,
+                      const struct GNUNET_PeerIdentity *peer,
+                      int32_t amount,
+                      struct GNUNET_TIME_Relative res_delay);
 
 
 /**
@@ -452,10 +451,10 @@ schedule_transmission (struct GSF_PeerTransmitHandle *pth)
 /**
  * Core is ready to transmit to a peer, get the message.
  *
- * @param cls the 'struct GSF_PeerTransmitHandle' of the message
+ * @param cls the `struct GSF_PeerTransmitHandle` of the message
  * @param size number of bytes core is willing to take
  * @param buf where to copy the message
- * @return number of bytes copied to buf
+ * @return number of bytes copied to @a buf
  */
 static size_t
 peer_transmit_ready_cb (void *cls, size_t size, void *buf)
@@ -507,7 +506,7 @@ peer_transmit_ready_cb (void *cls, size_t size, void *buf)
 /**
  * (re)try to reserve bandwidth from the given peer.
  *
- * @param cls the 'struct GSF_ConnectedPeer' to reserve from
+ * @param cls the `struct GSF_ConnectedPeer` to reserve from
  * @param tc scheduler context
  */
 static void
@@ -570,21 +569,48 @@ ats_reserve_callback (void *cls, const struct GNUNET_PeerIdentity *peer,
 }
 
 
+/**
+ * Function called by PEERSTORE with peer respect record
+ *
+ * @param cls handle to connected peer entry
+ * @param record peerstore record information
+ * @param emsg error message, or NULL if no errors
+ * @return #GNUNET_NO to stop iterating since we only expect 0 or 1 records
+ */
+static int
+peer_respect_cb (void *cls,
+                 const struct GNUNET_PEERSTORE_Record *record,
+                 const char *emsg)
+{
+  struct GSF_ConnectedPeer *cp = cls;
+
+  cp->respect_iterate_req = NULL;
+  if ((NULL != record) && (sizeof (cp->disk_respect) == record->value_size))
+    cp->disk_respect = cp->ppd.respect = *((uint32_t *)record->value);
+  GSF_push_start_ (cp);
+  if (NULL != cp->creation_cb)
+    cp->creation_cb (cp->creation_cb_cls, cp);
+  return GNUNET_NO;
+}
+
+
 /**
  * A peer connected to us.  Setup the connected peer
  * records.
  *
  * @param peer identity of peer that connected
- * @return handle to connected peer entry
+ * @param creation_cb callback function when the record is created.
+ * @param creation_cb_cls closure for @creation_cb
  */
-struct GSF_ConnectedPeer *
-GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer)
+void
+GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
+                           GSF_ConnectedPeerCreationCallback creation_cb,
+                           void *creation_cb_cls)
 {
   struct GSF_ConnectedPeer *cp;
-  char *fn;
-  uint32_t respect;
 
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connected to peer %s\n",
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Connected to peer %s\n",
               GNUNET_i2s (peer));
   cp = GNUNET_new (struct GSF_ConnectedPeer);
   cp->ppd.pid = GNUNET_PEER_intern (peer);
@@ -592,22 +618,21 @@ GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer)
   cp->rc =
       GNUNET_ATS_reserve_bandwidth (GSF_ats, peer, DBLOCK_SIZE,
                                     &ats_reserve_callback, cp);
-  fn = get_respect_filename (peer);
-  if ((GNUNET_YES == GNUNET_DISK_file_test (fn)) &&
-      (sizeof (respect) == GNUNET_DISK_fn_read (fn, &respect, sizeof (respect))))
-    cp->disk_respect = cp->ppd.respect = ntohl (respect);
-  GNUNET_free (fn);
   cp->request_map = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
   GNUNET_break (GNUNET_OK ==
                 GNUNET_CONTAINER_multipeermap_put (cp_map,
-                                                  GSF_connected_peer_get_identity2_ (cp),
+               GSF_connected_peer_get_identity2_ (cp),
                                                    cp,
                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
   GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# peers connected"),
                          GNUNET_CONTAINER_multipeermap_size (cp_map),
                          GNUNET_NO);
-  GSF_push_start_ (cp);
-  return cp;
+  cp->creation_cb = creation_cb;
+  cp->creation_cb_cls = creation_cb_cls;
+  cp->respect_iterate_req =
+      GNUNET_PEERSTORE_iterate (peerstore, "fs", peer, "respect",
+                                GNUNET_TIME_UNIT_FOREVER_REL, &peer_respect_cb,
+                                cp);
 }
 
 
@@ -615,11 +640,12 @@ GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer)
  * It may be time to re-start migrating content to this
  * peer.  Check, and if so, restart migration.
  *
- * @param cls the 'struct GSF_ConnectedPeer'
+ * @param cls the `struct GSF_ConnectedPeer`
  * @param tc scheduler context
  */
 static void
-revive_migration (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+revive_migration (void *cls,
+                  const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GSF_ConnectedPeer *cp = cls;
   struct GNUNET_TIME_Relative bt;
@@ -659,8 +685,8 @@ GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer)
  * @param other the other peer involved (sender or receiver, NULL
  *        for loopback messages where we are both sender and receiver)
  * @param message the actual message
- * @return GNUNET_OK to keep the connection open,
- *         GNUNET_SYSERR to close it (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ *         #GNUNET_SYSERR to close it (signal serious error)
  */
 int
 GSF_handle_p2p_migration_stop_ (void *cls,
@@ -691,7 +717,8 @@ GSF_handle_p2p_migration_stop_ (void *cls,
   {
     GSF_push_stop_ (cp);
     cp->mig_revive_task =
-        GNUNET_SCHEDULER_add_delayed (bt, &revive_migration, cp);
+        GNUNET_SCHEDULER_add_delayed (bt,
+                                      &revive_migration, cp);
   }
   return GNUNET_OK;
 }
@@ -700,8 +727,8 @@ GSF_handle_p2p_migration_stop_ (void *cls,
 /**
  * Copy reply and free put message.
  *
- * @param cls the 'struct PutMessage'
- * @param buf_size number of bytes available in buf
+ * @param cls the `struct PutMessage`
+ * @param buf_size number of bytes available in @a buf
  * @param buf where to copy the message, NULL on error (peer disconnect)
  * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
  */
@@ -763,11 +790,13 @@ free_pending_request (struct PeerRequest *peerreq,
  *
  * @param cls unused
  * @param query hash code of the request
- * @param value the 'struct GSF_PendingRequest'
- * @return GNUNET_YES (continue to iterate)
+ * @param value the `struct GSF_PendingRequest`
+ * @return #GNUNET_YES (continue to iterate)
  */
 static int
-cancel_pending_request (void *cls, const struct GNUNET_HashCode * query, void *value)
+cancel_pending_request (void *cls,
+                        const struct GNUNET_HashCode *query,
+                        void *value)
 {
   struct PeerRequest *peerreq = value;
   struct GSF_PendingRequest *pr = peerreq->pr;
@@ -787,7 +816,8 @@ cancel_pending_request (void *cls, const struct GNUNET_HashCode * query, void *v
  * @param tc task context
  */
 static void
-peer_request_destroy (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+peer_request_destroy (void *cls,
+                      const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct PeerRequest *peerreq = cls;
   struct GSF_PendingRequest *pr = peerreq->pr;
@@ -806,7 +836,8 @@ peer_request_destroy (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @param tc scheduler context
  */
 static void
-transmit_delayed_now (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+transmit_delayed_now (void *cls,
+                      const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GSF_DelayedHandle *dh = cls;
   struct GSF_ConnectedPeer *cp = dh->cp;
@@ -857,22 +888,25 @@ get_randomized_delay ()
  * and will also not be called anymore after a call signalling
  * expiration.
  *
- * @param cls 'struct PeerRequest' this is an answer for
+ * @param cls `struct PeerRequest` this is an answer for
  * @param eval evaluation of the result
  * @param pr handle to the original pending request
  * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
- * @param expiration when does 'data' expire?
+ * @param expiration when does @a data expire?
  * @param last_transmission when did we last transmit a request for this block
  * @param type type of the block
  * @param data response data, NULL on request expiration
- * @param data_len number of bytes in data
+ * @param data_len number of bytes in @a data
  */
 static void
-handle_p2p_reply (void *cls, enum GNUNET_BLOCK_EvaluationResult eval,
-                  struct GSF_PendingRequest *pr, uint32_t reply_anonymity_level,
+handle_p2p_reply (void *cls,
+                  enum GNUNET_BLOCK_EvaluationResult eval,
+                  struct GSF_PendingRequest *pr,
+                  uint32_t reply_anonymity_level,
                   struct GNUNET_TIME_Absolute expiration,
                   struct GNUNET_TIME_Absolute last_transmission,
-                  enum GNUNET_BLOCK_Type type, const void *data,
+                  enum GNUNET_BLOCK_Type type,
+                  const void *data,
                   size_t data_len)
 {
   struct PeerRequest *peerreq = cls;
@@ -1312,7 +1346,8 @@ GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
  * @param tc scheduler context
  */
 static void
-peer_transmit_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+peer_transmit_timeout (void *cls,
+                       const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GSF_PeerTransmitHandle *pth = cls;
   struct GSF_ConnectedPeer *cp;
@@ -1353,9 +1388,12 @@ peer_transmit_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  * @return handle to cancel request
  */
 struct GSF_PeerTransmitHandle *
-GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp, int is_query,
-                    uint32_t priority, struct GNUNET_TIME_Relative timeout,
-                    size_t size, GSF_GetMessageCallback gmc, void *gmc_cls)
+GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
+                    int is_query,
+                    uint32_t priority,
+                    struct GNUNET_TIME_Relative timeout,
+                    size_t size,
+                    GSF_GetMessageCallback gmc, void *gmc_cls)
 {
   struct GSF_PeerTransmitHandle *pth;
   struct GSF_PeerTransmitHandle *pos;
@@ -1476,6 +1514,32 @@ GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
 }
 
 
+/**
+ * Write peer-respect information to a file - flush the buffer entry!
+ *
+ * @param cls unused
+ * @param key peer identity
+ * @param value the 'struct GSF_ConnectedPeer' to flush
+ * @return GNUNET_OK to continue iteration
+ */
+static int
+flush_respect (void *cls, const struct GNUNET_PeerIdentity * key, void *value)
+{
+  struct GSF_ConnectedPeer *cp = value;
+  struct GNUNET_PeerIdentity pid;
+
+  if (cp->ppd.respect == cp->disk_respect)
+    return GNUNET_OK;           /* unchanged */
+  GNUNET_assert (0 != cp->ppd.pid);
+  GNUNET_PEER_resolve (cp->ppd.pid, &pid);
+  GNUNET_PEERSTORE_store (peerstore, "fs", &pid, "respect", &cp->ppd.respect,
+                          sizeof (cp->ppd.respect),
+                          GNUNET_TIME_UNIT_FOREVER_ABS,
+                          GNUNET_PEERSTORE_STOREOPTION_REPLACE, NULL, NULL);
+  return GNUNET_OK;
+}
+
+
 /**
  * A peer disconnected from us.  Tear down the connected peer
  * record.
@@ -1484,7 +1548,8 @@ GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
  * @param peer identity of peer that connected
  */
 void
-GSF_peer_disconnect_handler_ (void *cls, const struct GNUNET_PeerIdentity *peer)
+GSF_peer_disconnect_handler_ (void *cls,
+                              const struct GNUNET_PeerIdentity *peer)
 {
   struct GSF_ConnectedPeer *cp;
   struct GSF_PeerTransmitHandle *pth;
@@ -1494,6 +1559,7 @@ GSF_peer_disconnect_handler_ (void *cls, const struct GNUNET_PeerIdentity *peer)
   if (NULL == cp)
     return;                     /* must have been disconnect from core with
                                  * 'peer' == my_id, ignore */
+  flush_respect (NULL, peer, cp);
   GNUNET_assert (GNUNET_YES ==
                  GNUNET_CONTAINER_multipeermap_remove (cp_map,
                                                        peer,
@@ -1501,6 +1567,11 @@ GSF_peer_disconnect_handler_ (void *cls, const struct GNUNET_PeerIdentity *peer)
   GNUNET_STATISTICS_set (GSF_stats, gettext_noop ("# peers connected"),
                          GNUNET_CONTAINER_multipeermap_size (cp_map),
                          GNUNET_NO);
+  if (NULL != cp->respect_iterate_req)
+  {
+    GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
+    cp->respect_iterate_req = NULL;
+  }
   if (NULL != cp->migration_pth)
   {
     GSF_peer_transmit_cancel_ (cp->migration_pth);
@@ -1560,7 +1631,7 @@ GSF_peer_disconnect_handler_ (void *cls, const struct GNUNET_PeerIdentity *peer)
 
 
 /**
- * Closure for 'call_iterator'.
+ * Closure for #call_iterator().
  */
 struct IterationContext
 {
@@ -1570,7 +1641,7 @@ struct IterationContext
   GSF_ConnectedPeerIterator it;
 
   /**
-   * Closure for 'it'.
+   * Closure for @e it.
    */
   void *it_cls;
 };
@@ -1585,12 +1656,16 @@ struct IterationContext
  * @return #GNUNET_YES to continue iteration
  */
 static int
-call_iterator (void *cls, const struct GNUNET_PeerIdentity * key, void *value)
+call_iterator (void *cls,
+               const struct GNUNET_PeerIdentity *key,
+               void *value)
 {
   struct IterationContext *ic = cls;
   struct GSF_ConnectedPeer *cp = value;
 
-  ic->it (ic->it_cls, (const struct GNUNET_PeerIdentity *) key, cp, &cp->ppd);
+  ic->it (ic->it_cls,
+          key, cp,
+          &cp->ppd);
   return GNUNET_YES;
 }
 
@@ -1602,13 +1677,16 @@ call_iterator (void *cls, const struct GNUNET_PeerIdentity * key, void *value)
  * @param it_cls closure for @a it
  */
 void
-GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it, void *it_cls)
+GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
+                              void *it_cls)
 {
   struct IterationContext ic;
 
   ic.it = it;
   ic.it_cls = it_cls;
-  GNUNET_CONTAINER_multipeermap_iterate (cp_map, &call_iterator, &ic);
+  GNUNET_CONTAINER_multipeermap_iterate (cp_map,
+                                         &call_iterator,
+                                         &ic);
 }
 
 
@@ -1644,13 +1722,15 @@ GSF_connected_peer_get_identity2_ (const struct GSF_ConnectedPeer *cp)
 /**
  * Assemble a migration stop message for transmission.
  *
- * @param cls the 'struct GSF_ConnectedPeer' to use
- * @param size number of bytes we're allowed to write to buf
+ * @param cls the `struct GSF_ConnectedPeer` to use
+ * @param size number of bytes we're allowed to write to @a buf
  * @param buf where to copy the message
- * @return number of bytes copied to buf
+ * @return number of bytes copied to @a buf
  */
 static size_t
-create_migration_stop_message (void *cls, size_t size, void *buf)
+create_migration_stop_message (void *cls,
+                               size_t size,
+                               void *buf)
 {
   struct GSF_ConnectedPeer *cp = cls;
   struct MigrationStopMessage msm;
@@ -1706,49 +1786,6 @@ GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
 }
 
 
-/**
- * Write peer-respect information to a file - flush the buffer entry!
- *
- * @param cls unused
- * @param key peer identity
- * @param value the 'struct GSF_ConnectedPeer' to flush
- * @return GNUNET_OK to continue iteration
- */
-static int
-flush_respect (void *cls, const struct GNUNET_PeerIdentity * key, void *value)
-{
-  struct GSF_ConnectedPeer *cp = value;
-  char *fn;
-  uint32_t respect;
-  struct GNUNET_PeerIdentity pid;
-
-  if (cp->ppd.respect == cp->disk_respect)
-    return GNUNET_OK;           /* unchanged */
-  GNUNET_assert (0 != cp->ppd.pid);
-  GNUNET_PEER_resolve (cp->ppd.pid, &pid);
-  fn = get_respect_filename (&pid);
-  if (cp->ppd.respect == 0)
-  {
-    if ((0 != UNLINK (fn)) && (errno != ENOENT))
-      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
-                                GNUNET_ERROR_TYPE_BULK, "unlink", fn);
-  }
-  else
-  {
-    respect = htonl (cp->ppd.respect);
-    if (sizeof (uint32_t) ==
-        GNUNET_DISK_fn_write (fn, &respect, sizeof (uint32_t),
-                              GNUNET_DISK_PERM_USER_READ |
-                              GNUNET_DISK_PERM_USER_WRITE |
-                              GNUNET_DISK_PERM_GROUP_READ |
-                              GNUNET_DISK_PERM_OTHER_READ))
-      cp->disk_respect = cp->ppd.respect;
-  }
-  GNUNET_free (fn);
-  return GNUNET_OK;
-}
-
-
 /**
  * Notify core about a preference we have for the given peer
  * (to allocate more resources towards it).  The change will
@@ -1796,11 +1833,7 @@ void
 GSF_connected_peer_init_ ()
 {
   cp_map = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
-  GNUNET_assert (GNUNET_OK ==
-                 GNUNET_CONFIGURATION_get_value_filename (GSF_cfg, "fs",
-                                                          "RESPECT",
-                                                          &respectDirectory));
-  GNUNET_break (GNUNET_OK == GNUNET_DISK_directory_create (respectDirectory));
+  peerstore = GNUNET_PEERSTORE_connect (GSF_cfg);
   GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_HIGH,
                                       &cron_flush_respect, NULL);
 }
@@ -1834,8 +1867,7 @@ GSF_connected_peer_done_ ()
   GNUNET_CONTAINER_multipeermap_iterate (cp_map, &clean_peer, NULL);
   GNUNET_CONTAINER_multipeermap_destroy (cp_map);
   cp_map = NULL;
-  GNUNET_free (respectDirectory);
-  respectDirectory = NULL;
+  GNUNET_PEERSTORE_disconnect (peerstore, GNUNET_YES);
 }