-check return values, fix leak
[oweals/gnunet.git] / src / fs / gnunet-service-fs_cp.h
index 95b2033db2bcb5a591a6dcffa66f19b8fbd7d726..e3c7cd2278259a8525aece2f1dfc30c062483bfd 100644 (file)
 #include "gnunet-service-fs.h"
 
 
+/**
+ * Maximum number of outgoing messages we queue per peer.
+ *
+ * Performance measurements for 2 peer setup for 50 MB file
+ * (with MAX_DATASTORE_QUEUE = 1 and RETRY_PROBABILITY_INV = 1):
+ *
+ *   2: 1700 kb/s, 1372 kb/s
+ *   8: 2117 kb/s, 1284 kb/s, 1112 kb/s
+ *  16: 3500 kb/s, 3200 kb/s, 3388 kb/s
+ *  32: 3441 kb/s, 3163 kb/s, 3277 kb/s
+ * 128: 1700 kb/s; 2010 kb/s, 3383 kb/s, 1156 kb/s
+ *
+ * Conclusion: 16 seems to be a pretty good value (stable
+ * and high performance, no excessive memory use).
+ */
+#define MAX_QUEUE_PER_PEER 16
+
+/**
+ * Length of the P2P success tracker.  Note that having a very long
+ * list can also hurt performance.
+ */
+#define P2P_SUCCESS_LIST_SIZE 8
+
+/**
+ * Length of the CS-2-P success tracker.  Note that
+ * having a very long list can also hurt performance.
+ */
+#define CS2P_SUCCESS_LIST_SIZE 8
+
+
 /**
  * Performance data kept for a peer.
  */
@@ -39,7 +69,7 @@ struct GSF_PeerPerformanceData
   /**
    * Transport performance data.
    */
-  struct GNUNET_TRANSPORT_ATS_Information *atsi;
+  struct GNUNET_ATS_Information *atsi;
 
   /**
    * List of the last clients for which this peer successfully
@@ -59,9 +89,16 @@ struct GSF_PeerPerformanceData
    * getting a reply (only calculated over the requests for
    * which we actually got a reply).   Calculated
    * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
-   */ 
+   */
   struct GNUNET_TIME_Relative avg_reply_delay;
 
+  /**
+   * If we get content we already have from this peer, for how
+   * long do we block him?  Adjusted based on the fraction of
+   * redundant data we receive, between 1s and 1h.
+   */
+  struct GNUNET_TIME_Relative migration_delay;
+
   /**
    * Point in time until which this peer does not want us to migrate content
    * to it.
@@ -121,10 +158,11 @@ struct GSF_PeerPerformanceData
  * @param cp handle to the connected peer record
  * @param perf peer performance data
  */
-typedef void (*GSF_ConnectedPeerIterator)(void *cls,
-                                         const struct GNUNET_PeerIdentity *peer,
-                                         struct GSF_ConnectedPeer *cp,
-                                         const struct GSF_PeerPerformanceData *ppd);
+typedef void (*GSF_ConnectedPeerIterator) (void *cls,
+                                           const struct GNUNET_PeerIdentity *
+                                           peer, struct GSF_ConnectedPeer * cp,
+                                           const struct GSF_PeerPerformanceData
+                                           * ppd);
 
 
 /**
@@ -135,9 +173,8 @@ typedef void (*GSF_ConnectedPeerIterator)(void *cls,
  * @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)
  */
-typedef size_t (*GSF_GetMessageCallback)(void *cls,
-                                        size_t buf_size,
-                                        void *buf);
+typedef size_t (*GSF_GetMessageCallback) (void *cls, size_t buf_size,
+                                          void *buf);
 
 
 /**
@@ -147,9 +184,9 @@ typedef size_t (*GSF_GetMessageCallback)(void *cls,
  * @param cp handle to the connected peer record
  * @param success GNUNET_YES on success, GNUNET_NO on failure
  */
-typedef void (*GSF_PeerReserveCallback)(void *cls,
-                                       struct GSF_ConnectedPeer *cp,
-                                       int success);
+typedef void (*GSF_PeerReserveCallback) (void *cls,
+                                         struct GSF_ConnectedPeer * cp,
+                                         int success);
 
 
 /**
@@ -164,11 +201,23 @@ struct GSF_PeerTransmitHandle;
  *
  * @param peer identity of peer that connected
  * @param atsi performance data for the connection
+ * @param atsi_count number of records in 'atsi'
  * @return handle to connected peer entry
  */
 struct GSF_ConnectedPeer *
 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
-                          const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+                           const struct GNUNET_ATS_Information *atsi,
+                           unsigned int atsi_count);
+
+
+/**
+ * Get a handle for a connected peer.
+ *
+ * @param peer peer's identity
+ * @return NULL if this peer is not currently connected
+ */
+struct GSF_ConnectedPeer *
+GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer);
 
 
 /**
@@ -186,13 +235,9 @@ GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
  * @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);
 
 
 /**
@@ -213,8 +258,8 @@ GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth);
  */
 void
 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
-                             struct GNUNET_TIME_Absolute request_time,
-                             uint32_t request_priority);
+                              struct GNUNET_TIME_Absolute request_time,
+                              uint32_t request_priority);
 
 
 /**
@@ -226,7 +271,7 @@ GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
  */
 void
 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
-                                  struct GSF_LocalClient *initiator_client);
+                                   struct GSF_LocalClient *initiator_client);
 
 
 /**
@@ -238,27 +283,8 @@ GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
  */
 void
 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
-                                const struct GSF_ConnectedPeer *initiator_peer);
-
-
-/**
- * Method called whenever a given peer has a status change.
- *
- * @param cls closure
- * @param peer peer identity this notification is about
- * @param bandwidth_in available amount of inbound bandwidth
- * @param bandwidth_out available amount of outbound bandwidth
- * @param timeout absolute time when this peer will time out
- *        unless we see some further activity from it
- * @param atsi status information
- */
-void
-GSF_peer_status_handler_ (void *cls,
-                         const struct GNUNET_PeerIdentity *peer,
-                         struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
-                         struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
-                         struct GNUNET_TIME_Absolute timeout,
-                         const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+                                 const struct GSF_ConnectedPeer
+                                 *initiator_peer);
 
 
 /**
@@ -269,14 +295,16 @@ GSF_peer_status_handler_ (void *cls,
  *        for loopback messages where we are both sender and receiver)
  * @param message the actual message
  * @param atsi performance information
+ * @param atsi_count number of records in 'atsi'
  * @return GNUNET_OK to keep the connection open,
  *         GNUNET_SYSERR to close it (signal serious error)
  */
 int
 GSF_handle_p2p_migration_stop_ (void *cls,
-                               const struct GNUNET_PeerIdentity *other,
-                               const struct GNUNET_MessageHeader *message,
-                               const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+                                const struct GNUNET_PeerIdentity *other,
+                                const struct GNUNET_MessageHeader *message,
+                                const struct GNUNET_ATS_Information *atsi,
+                                unsigned int atsi_count);
 
 
 /**
@@ -292,12 +320,12 @@ GSF_handle_p2p_migration_stop_ (void *cls,
  */
 struct GSF_PendingRequest *
 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
-                      const struct GNUNET_MessageHeader *message);
+                       const struct GNUNET_MessageHeader *message);
 
 
 /**
  * Return the performance data record for the given peer
- * 
+ *
  * @param cp peer to query
  * @return performance data record for the peer
  */
@@ -308,13 +336,13 @@ GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp);
 /**
  * Ask a peer to stop migrating data to us until the given point
  * in time.
- * 
+ *
  * @param cp peer to ask
  * @param block_time until when to block
  */
 void
 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
-                          struct GNUNET_TIME_Relative block_time);
+                           struct GNUNET_TIME_Absolute block_time);
 
 
 /**
@@ -326,7 +354,7 @@ GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
  */
 void
 GSF_peer_disconnect_handler_ (void *cls,
-                             const struct GNUNET_PeerIdentity *peer);
+                              const struct GNUNET_PeerIdentity *peer);
 
 
 /**
@@ -350,7 +378,7 @@ GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc);
  */
 void
 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
-                                      uint64_t pref);
+                                       uint64_t pref);
 
 
 /**
@@ -361,7 +389,7 @@ GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
  */
 void
 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
-                                 struct GNUNET_PeerIdentity *id);
+                                  struct GNUNET_PeerIdentity *id);
 
 
 /**
@@ -371,17 +399,14 @@ GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
  * @param it_cls closure for it
  */
 void
-GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
-                             void *it_cls);
+GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it, void *it_cls);
 
 
 /**
  * Initialize peer management subsystem.
- *
- * @param cfg configuration to use
  */
 void
-GSF_connected_peer_init_ (struct GNUNET_CONFIGURATION_Handle *cfg);
+GSF_connected_peer_init_ (void);
 
 
 /**