/*
- This file is part of GNUnet.
- (C) 2011 Christian Grothoff (and other contributing authors)
-
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
-
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- 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.
-*/
+ This file is part of GNUnet.
+ (C) 2011 Christian Grothoff (and other contributing authors)
+
+ GNUnet is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published
+ by the Free Software Foundation; either version 3, or (at your
+ option) any later version.
+
+ GNUnet is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ 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.
+ */
/**
* @file ats/gnunet-service-ats_addresses.h
#include "gnunet_util_lib.h"
#include "gnunet_ats_service.h"
+#include "gnunet-service-ats.h"
#include "gnunet_statistics_service.h"
#include "ats.h"
* it as a value_number. If no configuration value is found it will assign
* GNUNET_ATS_DefaultBandwidth. The most important step is to load the
* configured solver using configuration "[ats]:MODE". Current solvers are
- * MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
+ * MODE_PROPORTIONAL, MODE_MLP. Interaction is done using a solver API
*
* 1.4 Solver API
*
*/
-
/*
* How long will address suggestions blocked after a suggestion
*/
#define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
-struct GAS_Addresses_Handle;
+/**
+ * Information provided by ATS normalization
+ */
+struct GAS_NormalizationInfo
+{
+ /**
+ * Next index to use in averaging queue
+ */
+ unsigned int avg_queue_index;
+
+ /**
+ * Averaging queue
+ */
+ uint32_t atsi_abs[GAS_normalization_queue_length];
+
+ /**
+ * Averaged ATSI values from queue
+ */
+ uint32_t avg;
+
+ /**
+ * Normalized values from queue to a range of values [1.0...2.0]
+ */
+ double norm;
+};
/**
* Address with additional information
*/
void *solver_information;
- /* CHECK USAGE */
- struct GNUNET_TIME_Relative atsp_latency;
-
- /* CHECK USAGE */
- struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
-
- /* CHECK USAGE */
- struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
-
-
- /* CHECK USAGE */
- uint32_t atsp_distance;
-
- /* CHECK USAGE */
- uint32_t atsp_cost_wan;
-
- /* CHECK USAGE */
- uint32_t atsp_cost_lan;
-
- /* CHECK USAGE */
- uint32_t atsp_cost_wlan;
+ /**
+ * ATS performance information for this address
+ */
+ struct GNUNET_ATS_Information *atsi;
- /* CHECK USAGE */
- uint32_t atsp_network_type;
+ /**
+ * ATS performance information for this address
+ */
+ uint32_t atsi_count;
/**
* Inbound bandwidth assigned by solver in NBO
* Is this the address for this peer in use?
*/
int used;
-};
+ /**
+ * Normalized ATS performance information for this address
+ * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
+ */
+ struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
+};
/**
* Callback to call from solver when bandwidth for address has changed
*
* @param address the with changed bandwidth assigned
*/
-
typedef void
- (*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
+(*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
+
+/**
+ * Callback to call from solver to obtain application preference values for a
+ * peer
+ *
+ * @param cls the cls
+ * @param id the peer id
+ * @return carry of double values containing the preferences with
+ * GNUNET_ATS_PreferenceCount elements
+ */
+typedef const double *
+(*GAS_get_preferences) (void *cls, const struct GNUNET_PeerIdentity *id);
+
+/**
+ * Callback to call from solver to obtain transport properties for an
+ * address
+ *
+ * @param cls the cls
+ * @param address the address
+ * @return carry of double values containing the preferences with
+ * GNUNET_ATS_PreferenceCount elements
+ */
+typedef const double *
+(*GAS_get_properties) (void *cls, const struct ATS_Address *address);
/*
* Solver API
*/
/**
- * Init the simplistic problem solving component
+ * Init the problem solving component
*
* Quotas:
* network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
*
* @param cfg configuration handle
* @param stats the GNUNET_STATISTICS handle
+ * @param addresses hashmap containing all addresses
* @param network array of GNUNET_ATS_NetworkType with length dest_length
* @param out_quota array of outbound quotas
* @param in_quota array of outbound quota
* @return handle for the solver on success, NULL on fail
*/
typedef void *
- (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_STATISTICS_Handle *stats,
- int *network,
- unsigned long long *out_quota,
- unsigned long long *in_quota,
- int dest_length,
- GAS_bandwidth_changed_cb bw_changed_cb,
- void *bw_changed_cb_cls);
-
+(*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_STATISTICS_Handle *stats,
+ const struct GNUNET_CONTAINER_MultiHashMap *addresses, int *network,
+ unsigned long long *out_quota, unsigned long long *in_quota,
+ int dest_length, GAS_bandwidth_changed_cb bw_changed_cb,
+ void *bw_changed_cb_cls, GAS_get_preferences get_preference,
+ void *get_preference_cls, GAS_get_properties get_properties,
+ void *get_properties_cls);
/**
* Change the preference for a peer
* @param peer the peer id
* @param kind the preference kind to change
* @param score the new preference score
+ * @param pref_rel the normalized preference value for this kind over all clients
*/
typedef void
(*GAS_solver_address_change_preference) (void *solver,
- void *client,
- const struct GNUNET_PeerIdentity *peer,
- enum GNUNET_ATS_PreferenceKind kind,
- float score);
+ const struct GNUNET_PeerIdentity *peer, enum GNUNET_ATS_PreferenceKind kind,
+ double pref_rel);
+
+/**
+ * Give feedback about the current assignment
+ *
+ * @param handle the solver handle
+ * @param application the application sending this request
+ * @param peer the peer id
+ * @param scope the time interval for this feedback: [now - scope .. now]
+ * @param kind the preference kind for this feedback
+ * @param score the feedback score
+ */
+typedef void
+(*GAS_solver_address_feedback_preference) (void *solver, void *application,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_TIME_Relative scope,
+ enum GNUNET_ATS_PreferenceKind kind, double score);
+
+/**
+ * Notify the solver about a bulk operation changing possibly a lot of values
+ * Solver will not resolve until all bulk operations are marked as done
+ *
+ * @param solver the solver
+ */
+typedef void
+(*GAS_solver_bulk_start) (void *solver);
+
+/**
+ * Mark a bulk operation as done
+ * Solver will resolve if values have changed
+ *
+ * @param solver the solver
+ */
+typedef void
+(*GAS_solver_bulk_stop) (void *solver);
/**
- * Add a single address to the solver
+ * Add a single address within a network to the solver
*
* @param solver the solver Handle
* @param addresses the address hashmap containing all addresses
* @param address the address to add
+ * @param network network type of this address
*/
typedef void
-(*GAS_solver_address_add) (void *solver,
- struct GNUNET_CONTAINER_MultiHashMap * addresses,
- struct ATS_Address *address);
-
+(*GAS_solver_address_add) (void *solver, struct ATS_Address *address,
+ uint32_t network);
/**
* Delete an address or just the session from the solver
* @param session_only remove address or just session
*/
typedef void
- (*GAS_solver_address_delete) (void *solver,
- struct GNUNET_CONTAINER_MultiHashMap *addresses,
- struct ATS_Address *address,
- int session_only);
+(*GAS_solver_address_delete) (void *solver, struct ATS_Address *address,
+ int session_only);
/**
- * Notify the solver about an update for an address
+ * Transport properties for this address have changed
*
- * @param solver the solver to use
- * @param addresses the address hashmap containing all addresses
+ * @param solver solver handle
* @param address the address
- * @param session the session
- * @param in_use address used: yes or no
- * @param atsi ats performance information
- * @param atsi_count number of ats performance information
+ * @param type the ATSI type in HBO
+ * @param abs_value the absolute value of the property
+ * @param rel_value the normalized value
+ */
+typedef void
+(*GAS_solver_address_property_changed) (void *solver,
+ struct ATS_Address *address, uint32_t type, uint32_t abs_value,
+ double rel_value);
+
+/**
+ * Transport session for this address has changed
+ *
+ * NOTE: values in addresses are already updated
+ *
+ * @param solver solver handle
+ * @param address the address
+ * @param cur_session the current session
+ * @param new_session the new session
+ */
+typedef void
+(*GAS_solver_address_session_changed) (void *solver,
+ struct ATS_Address *address, uint32_t cur_session, uint32_t new_session);
+
+/**
+ * Transport session for this address has changed
*
+ * NOTE: values in addresses are already updated
+ *
+ * @param solver solver handle
+ * @param address the address
+ * @param in_use usage state
*/
typedef void
-(*GAS_solver_address_update) (void *solver,
- struct GNUNET_CONTAINER_MultiHashMap *addresses,
- struct ATS_Address *address,
- uint32_t session,
- int in_use,
- const struct GNUNET_ATS_Information *atsi,
- uint32_t atsi_count);
+(*GAS_solver_address_inuse_changed) (void *solver, struct ATS_Address *address,
+ int in_use);
+/**
+ * Network scope for this address has changed
+ *
+ * NOTE: values in addresses are already updated
+ *
+ * @param solver solver handle
+ * @param address the address
+ * @param current_network the current network
+ * @param new_network the new network
+ */
+typedef void
+(*GAS_solver_address_network_changed) (void *solver,
+ struct ATS_Address *address, uint32_t current_network, uint32_t new_network);
/**
* Get the prefered address for a peer from solver
*/
typedef const struct ATS_Address *
(*GAS_solver_get_preferred_address) (void *solver,
- struct GNUNET_CONTAINER_MultiHashMap *addresses,
- const struct GNUNET_PeerIdentity *peer);
-
+ const struct GNUNET_PeerIdentity *peer);
/**
* Stop getting the prefered address for a peer from solver
*/
typedef void
(*GAS_solver_stop_get_preferred_address) (void *solver,
- struct GNUNET_CONTAINER_MultiHashMap *addresses,
- const struct GNUNET_PeerIdentity *peer);
+ const struct GNUNET_PeerIdentity *peer);
/**
* Shutdown solver
*/
typedef void
- (*GAS_solver_done) (void *solver);
-
+(*GAS_solver_done) (void *solver);
/**
* Initialize address subsystem. The addresses subsystem manages the addresses
*/
struct GAS_Addresses_Handle *
GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_STATISTICS_Handle *stats);
-
+ const struct GNUNET_STATISTICS_Handle *stats);
/**
* Shutdown address subsystem.
void
GAS_addresses_done (struct GAS_Addresses_Handle *handle);
-
/**
* Add a new address for a peer.
*
*/
void
GAS_addresses_add (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer,
- const char *plugin_name,
- const void *plugin_addr,
- size_t plugin_addr_len,
- uint32_t session_id,
- const struct GNUNET_ATS_Information *atsi,
- uint32_t atsi_count);
-
+ const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
+ const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
+ const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count);
/**
* Notification about active use of an address.
*/
int
GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer,
- const char *plugin_name,
- const void *plugin_addr,
- size_t plugin_addr_len,
- uint32_t session_id,
- int in_use);
-
+ const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
+ const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
+ int in_use);
/**
* Update an address with a session or performance information for a peer.
*/
void
GAS_addresses_update (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer,
- const char *plugin_name,
- const void *plugin_addr,
- size_t plugin_addr_len,
- uint32_t session_id,
- const struct GNUNET_ATS_Information *atsi,
- uint32_t atsi_count);
-
+ const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
+ const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
+ const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count);
/**
* Remove an address or just a session for a peer.
*/
void
GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer,
- const char *plugin_name,
- const void *plugin_addr,
- size_t plugin_addr_len,
- uint32_t session_id);
-
+ const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
+ const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id);
/**
* Remove all addresses
void
GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
-
/**
* Request address suggestions for a peer
*
*/
void
GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer);
+ const struct GNUNET_PeerIdentity *peer);
/**
* Cancel address suggestions for a peer
*/
void
GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer);
-
+ const struct GNUNET_PeerIdentity *peer);
/**
* Reset suggestion backoff for a peer
*/
void
GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer);
-
+ const struct GNUNET_PeerIdentity *peer);
/**
* Change the preference for a peer
* @param client the client sending this request
* @param peer the peer id
* @param kind the preference kind to change
- * @param score the new preference score
+ * @param score_abs the new preference score
*/
void
GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
- void *client,
- const struct GNUNET_PeerIdentity *peer,
- enum GNUNET_ATS_PreferenceKind kind,
- float score);
+ void *client, const struct GNUNET_PeerIdentity *peer,
+ enum GNUNET_ATS_PreferenceKind kind, float score_abs);
+/**
+ * Change the preference for a peer
+ *
+ * @param handle the address handle
+ * @param application the client sending this request
+ * @param peer the peer id
+ * @param scope the time interval this valid for: [now - scope .. now]
+ * @param kind the preference kind to change
+ * @param score_abs the new preference score
+ */
+void
+GAS_addresses_preference_feedback (struct GAS_Addresses_Handle *handle,
+ void *application, const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_TIME_Relative scope,
+ enum GNUNET_ATS_PreferenceKind kind, float score_abs);
/**
* Iterator for GAS_addresses_iterate_peers
* @param p_it_cls closure
* @param id the peer id
*/
-typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
- const struct GNUNET_PeerIdentity *id);
-
+typedef void
+(*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
+ const struct GNUNET_PeerIdentity *id);
/**
* Return all peers currently known to ATS
*/
void
GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
- GNUNET_ATS_Peer_Iterator p_it,
- void *p_it_cls);
-
+ GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
/**
* Iterator for GAS_addresses_get_peer_info
* @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,
- 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,
+typedef void
+(*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_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,
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
-
/**
* Return information all peers currently known to ATS
*
*/
void
GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
- const struct GNUNET_PeerIdentity *peer,
- GNUNET_ATS_PeerInfo_Iterator pi_it,
- void *pi_it_cls);
+ const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it,
+ void *pi_it_cls);
#endif