src/ats/gnunet-service-ats_normalization.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_normalization.h
  23  * @brief ats service address: management of ATS properties and preferences normalization
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_ats_service.h"
  29
  30 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  31 #define PREF_AGING_FACTOR 0.95
  32 #define PREF_EPSILON 0.01
  33
  34 #define DEFAULT_REL_PREFERENCE 0.0
  35 #define DEFAULT_ABS_PREFERENCE 0.0
  36
  37 #define DEFAULT_REL_QUALITY 1.0
  38
  39 typedef void
  40 (*GAS_Normalization_preference_changed_cb) (void *cls,
  41     const struct GNUNET_PeerIdentity *peer,
  42     enum GNUNET_ATS_PreferenceKind kind,
  43     double pref_rel);
  44
  45 typedef void
  46 (*GAS_Normalization_property_changed_cb) (void *cls,
  47     struct ATS_Address *peer,
  48     uint32_t type,
  49     double prop_rel);
  50
  51
  52 /**
  53  * Get the normalized preference values for a specific peer
  54  *
  55  * @param id the peer @return pointer to the values, can be indexed
  56  * with GNUNET_ATS_PreferenceKind, NULL if peer does not exist
  57  */
  58 const double *
  59 GAS_normalization_get_preferences_by_peer (const struct GNUNET_PeerIdentity *id);
  60
  61
  62 /**
  63  * Get the normalized properties values for a specific peer or
  64  * the default values if
  65  *
  66  * @param address the address
  67  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind,
  68  * default preferences if peer does not exist
  69  */
  70 const double *
  71 GAS_normalization_get_properties (struct ATS_Address *address);
  72
  73
  74 /**
  75  * Get the normalized preference values for a specific client and peer
  76  *
  77  * @param client client
  78  * @param peer the peer
  79  * @param pref the preference type
  80  * @return the value
  81  */
  82 double
  83 GAS_normalization_get_preferences_by_client (const void *client,
  84                                              const struct GNUNET_PeerIdentity *peer,
  85                                              enum GNUNET_ATS_PreferenceKind pref);
  86
  87 /**
  88  * Normalize an updated preference value
  89  *
  90  * @param client the client with this preference
  91  * @param peer the peer to change the preference for
  92  * @param kind the kind to change the preference
  93  * @param score_abs the normalized score
  94  */
  95 void
  96 GAS_normalization_normalize_preference (void *client,
  97                                         const struct GNUNET_PeerIdentity *peer,
  98                                         enum GNUNET_ATS_PreferenceKind kind,
  99                                         float score_abs);
 100
 101 /**
 102  * Update and normalize a atsi performance information
 103  *
 104  * @param addresses hashmap containing all addresses
 105  * @param address the address to update
 106  * @param atsi the array of performance information
 107  * @param atsi_count the number of atsi information in the array
 108  */
 109 void
 110 GAS_normalization_normalize_property (struct GNUNET_CONTAINER_MultiPeerMap *addresses,
 111                                       struct ATS_Address *address,
 112                                       const struct GNUNET_ATS_Information *atsi,
 113                                       uint32_t atsi_count);
 114
 115
 116 /**
 117  * A performance client disconnected
 118  *
 119  * @param client the disconnecting client
 120  */
 121 void
 122 GAS_normalization_preference_client_disconnect (void *client);
 123
 124
 125 /**
 126  * Start the normalization component
 127  *
 128  * @param pref_ch_cb callback to call on relative preference changing
 129  * @param pref_ch_cb_cls cls for the preference callback
 130  * @param property_ch_cb callback to call on relative property changing
 131  * @param property_ch_cb_cls cls for the property callback
 132  */
 133 void
 134 GAS_normalization_start (GAS_Normalization_preference_changed_cb pref_ch_cb,
 135                          void *pref_ch_cb_cls,
 136                          GAS_Normalization_property_changed_cb property_ch_cb,
 137                          void *property_ch_cb_cls);
 138
 139
 140 /**
 141  * Stop the normalization component and free all items
 142  */
 143 void
 144 GAS_normalization_stop ();
 145
 146
 147 /* end of gnunet-service-ats_normalization.h */