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
  33 #define DEFAULT_REL_PREFERENCE 1.0
  34 #define DEFAULT_ABS_PREFERENCE 0.0
  35
  36 #define DEFAULT_REL_QUALITY 1.0
  37
  38 typedef void
  39 (*GAS_Normalization_preference_changed_cb) (void *cls,
  40                                                                                                                                                                                 const struct GNUNET_PeerIdentity *peer,
  41                                                                                                                                                                                 enum GNUNET_ATS_PreferenceKind kind,
  42                                                                                                                                                                                 double pref_rel);
  43
  44 typedef void
  45 (*GAS_Normalization_property_changed_cb) (void *cls,
  46                                                                                                                                                                  struct ATS_Address *peer,
  47                                                                                                                                                                  uint32_t type,
  48                                                                                                                                                                  double prop_rel);
  49
  50 /**
  51  * Get the normalized preference values for a specific peer
  52  *
  53  * @param id the peer
  54  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind, NULL if peer does not exist
  55  */
  56 const double *
  57 GAS_normalization_get_preferences (const struct GNUNET_PeerIdentity *id);
  58
  59
  60 /**
  61  * Get the normalized properties values for a specific peer or
  62  * the default values if
  63  *
  64  * @param address the address
  65  * @return pointer to the values, can be indexed with GNUNET_ATS_PreferenceKind,
  66  * default preferences if peer does not exist
  67  */
  68 const double *
  69 GAS_normalization_get_properties (struct ATS_Address *address);
  70
  71 /**
  72  * Normalize an updated preference value
  73  *
  74  * @param src the client with this preference
  75  * @param peer the peer to change the preference for
  76  * @param kind the kind to change the preference
  77  * @param score_abs the normalized score
  78  */
  79 void
  80 GAS_normalization_normalize_preference (void *src,
  81                                          const struct GNUNET_PeerIdentity *peer,
  82                                          enum GNUNET_ATS_PreferenceKind kind,
  83                                          float score_abs);
  84
  85 /**
  86  * Update and normalize a atsi performance information
  87  *
  88  * @param addresses hashmap containing all addresses
  89  * @param address the address to update
  90  * @param atsi the array of performance information
  91  * @param atsi_count the number of atsi information in the array
  92  */
  93 void
  94 GAS_normalization_normalize_property (struct GNUNET_CONTAINER_MultiHashMap *addresses,
  95                                                                                                                                                         struct ATS_Address *address,
  96                                                                                                                                                         const struct GNUNET_ATS_Information *atsi,
  97                                                                                                                                                         uint32_t atsi_count);
  98
  99
 100 /**
 101  * Start the normalization component
 102  *
 103  * @param pref_ch_cb callback to call on relative preference changing
 104  * @param pref_ch_cb_cls cls for the preference callback
 105  * @param property_ch_cb callback to call on relative property changing
 106  * @param property_ch_cb_cls cls for the property callback
 107  */
 108 void
 109 GAS_normalization_start (GAS_Normalization_preference_changed_cb pref_ch_cb,
 110                 void *pref_ch_cb_cls,
 111                 GAS_Normalization_property_changed_cb property_ch_cb,
 112                 void *property_ch_cb_cls);
 113
 114
 115 /**
 116  * Stop the normalization component and free all items
 117  */
 118 void
 119 GAS_normalization_stop ();
 120
 121
 122 /* end of gnunet-service-ats_normalization.h */