guix-env: some update.
[oweals/gnunet.git] / src / ats / gnunet-service-ats_addresses.h
index f26eb779d7ab2261c3471707568a4f04dd8d994f..61de1cd31f38a6fd1d0182e59722d094115dd0f8 100644 (file)
@@ -1,6 +1,6 @@
 /*
  This file is part of GNUnet.
- (C) 2011-2014 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2011-2014 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
@@ -14,8 +14,8 @@
 
  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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
  */
 
 /**
@@ -30,7 +30,6 @@
 #include "gnunet_util_lib.h"
 #include "gnunet_ats_service.h"
 #include "gnunet-service-ats.h"
-#include "gnunet_statistics_service.h"
 #include "ats.h"
 
 /**
@@ -237,12 +236,12 @@ struct GAS_NormalizationInfo
   /**
    * Averaging queue
    */
-  uint32_t atsi_abs[GAS_normalization_queue_length];
+  uint64_t atsi_abs[GAS_normalization_queue_length];
 
   /**
    * Averaged ATSI values from queue
    */
-  uint32_t avg;
+  uint64_t avg;
 
   /**
    * Normalized values from queue to a range of values [1.0...2.0]
@@ -257,57 +256,57 @@ struct GAS_NormalizationInfo
 struct ATS_Address
 {
   /**
-   * Next element in DLL
+   * Peer ID this address is for.
    */
-  struct ATS_Address *next;
+  struct GNUNET_PeerIdentity peer;
 
   /**
-   * Previous element in DLL
+   * Address (in plugin-specific binary format).
    */
-  struct ATS_Address *prev;
+  const void *addr;
 
   /**
-   * Peer ID
+   * Plugin name
    */
-  struct GNUNET_PeerIdentity peer;
+  char *plugin;
 
   /**
-   * Address
+   * Solver-specific information for this address
    */
-  const void *addr;
+  void *solver_information;
 
   /**
-   * Address length
+   * ATS performance information for this address
    */
-  size_t addr_len;
+  struct GNUNET_ATS_Properties properties;
 
   /**
-   * Session ID, can never be 0.
+   * Time when address had last activity (update, in uses)
    */
-  uint32_t session_id;
+  struct GNUNET_TIME_Absolute t_last_activity;
 
   /**
-   * Field to store local flags
+   * Time when address was added
    */
-  uint32_t local_address_info;
+  struct GNUNET_TIME_Absolute t_added;
 
   /**
-   * Plugin name
+   * Address length, number of bytes in @e addr.
    */
-  char *plugin;
+  size_t addr_len;
 
   /**
-   * Solver specific information for this address
+   * Session ID, can never be 0.
    */
-  void *solver_information;
+  uint32_t session_id;
 
   /**
-   * ATS performance information for this address
+   * Field to store local flags.
    */
-  struct GNUNET_ATS_Information *atsi;
+  enum GNUNET_HELLO_AddressInfo local_address_info;
 
   /**
-   * ATS performance information for this address
+   * ATS performance information for this address, size of the @e atsi array.
    */
   uint32_t atsi_count;
 
@@ -332,43 +331,42 @@ struct ATS_Address
   uint32_t last_notified_bw_out;
 
   /**
-   * Time when address had last activity (update, in uses)
+   * Is this the active address for this peer?
    */
-  struct GNUNET_TIME_Absolute t_last_activity;
+  int active;
 
   /**
-   * Time when address was added
+   * Normalized delay information for this address.
    */
-  struct GNUNET_TIME_Absolute t_added;
+  struct GAS_NormalizationInfo norm_delay;
 
   /**
-   * Is this the active address for this peer?
+   * Normalized distance information for this address.
    */
-  int active;
+  struct GAS_NormalizationInfo norm_distance;
 
   /**
-   * Is this the address for this peer in use?
+   * Normalized utilization inbound for this address.
    */
-  int used;
+  struct GAS_NormalizationInfo norm_utilization_in;
 
-  /**
-   * Normalized ATS performance information for this address
-   * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
+    /**
+   * Normalized utilization outbound for this address.
    */
-  struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
+  struct GAS_NormalizationInfo norm_utilization_out;
+
 };
 
 
 /**
- * A multihashmap to store all addresses
+ * A multipeermap mapping peer identities to `struct ATS_Address`.
  */
 extern struct GNUNET_CONTAINER_MultiPeerMap *GSA_addresses;
 
 
-
 /**
  * Initialize address subsystem. The addresses subsystem manages the addresses
- * known and current performance information. 
+ * known and current performance information.
  */
 void
 GAS_addresses_init (void);
@@ -387,11 +385,10 @@ GAS_addresses_done (void);
  * @param peer peer
  * @param plugin_name transport plugin name
  * @param plugin_addr plugin address
- * @param plugin_addr_len length of the plugin address
+ * @param plugin_addr_len length of the @a plugin_addr
  * @param local_address_info the local address for the address
  * @param session_id session id, can never be 0.
- * @param atsi performance information for this address
- * @param atsi_count number of performance information contained in @a atsi
+ * @param prop performance information for this address
  */
 void
 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
@@ -400,8 +397,7 @@ GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
                    size_t plugin_addr_len,
                    uint32_t local_address_info,
                    uint32_t session_id,
-                   const struct GNUNET_ATS_Information *atsi,
-                   uint32_t atsi_count);
+                   const struct GNUNET_ATS_Properties *prop);
 
 
 /**
@@ -409,18 +405,16 @@ GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
  *
  * @param peer peer
  * @param session_id session id, can never be 0
- * @param atsi performance information for this address
- * @param atsi_count number of performance information contained in @a atsi
+ * @param prop performance information for this address
  */
 void
 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
                       uint32_t session_id,
-                      const struct GNUNET_ATS_Information *atsi,
-                      uint32_t atsi_count);
+                      const struct GNUNET_ATS_Properties *prop);
 
 
 /**
- * Remove an address or just a session for a peer.
+ * Remove an address for a peer.
  *
  * @param peer peer
  * @param session_id session id, can never be 0
@@ -431,37 +425,35 @@ GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 
 
 /**
- * Remove all addresses
+ * Remove all addresses.
  */
 void
 GAS_addresses_destroy_all (void);
 
 
-
-
 /**
  * Iterator for #GAS_addresses_get_peer_info()
  *
- * @param p_it_cls closure closure
+ * @param cls closure
  * @param id the peer id
  * @param plugin_name plugin name
  * @param plugin_addr address
  * @param plugin_addr_len length of @a plugin_addr
  * @param address_active is address actively used
  * @param atsi ats performance information
- * @param atsi_count number of ats performance elements in @a atsi
+ * @param local_address_info flags for the address
  * @param bandwidth_out current outbound bandwidth assigned to address
  * @param bandwidth_in current inbound bandwidth assigned to address
  */
 typedef void
-(*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
+(*GNUNET_ATS_PeerInfo_Iterator) (void *cls,
                                  const struct GNUNET_PeerIdentity *id,
                                  const char *plugin_name,
                                  const void *plugin_addr,
                                  size_t plugin_addr_len,
                                  const int address_active,
-                                 const struct GNUNET_ATS_Information *atsi,
-                                 uint32_t atsi_count,
+                                 const struct GNUNET_ATS_Properties *prop,
+                                 enum GNUNET_HELLO_AddressInfo local_address_info,
                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 
@@ -478,6 +470,18 @@ GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer,
                              GNUNET_ATS_PeerInfo_Iterator pi_it,
                              void *pi_it_cls);
 
+
+/**
+ * Handle 'address list request' messages from clients.
+ *
+ * @param client client that sent the request
+ * @param alrm the request message
+ */
+void
+GAS_handle_request_address_list (struct GNUNET_SERVICE_Client *client,
+                                 const struct AddressListRequestMessage *alrm);
+
+
 #endif
 
 /* end of gnunet-service-ats_addresses.h */