src/ats/gnunet-service-ats_addresses.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_addresses.h
  23  * @brief ats service address management
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
  28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_ats_service.h"
  32 #include "gnunet_statistics_service.h"
  33 #include "ats.h"
  34
  35 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
  36
  37
  38 struct ATS_Address
  39 {
  40   struct ATS_Address *next;
  41
  42   struct ATS_Address *prev;
  43
  44   struct GNUNET_PeerIdentity peer;
  45
  46   size_t addr_len;
  47
  48   uint32_t session_id;
  49
  50   uint32_t ats_count;
  51
  52   const void *addr;
  53
  54   char *plugin;
  55
  56   void *mlp_information;
  57
  58   struct GNUNET_ATS_Information *ats;
  59
  60   struct GNUNET_TIME_Relative atsp_latency;
  61
  62   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
  63
  64   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
  65
  66   uint32_t atsp_distance;
  67
  68   uint32_t atsp_cost_wan;
  69
  70   uint32_t atsp_cost_lan;
  71
  72   uint32_t atsp_cost_wlan;
  73
  74   uint32_t atsp_network_type;
  75
  76   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
  77
  78   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
  79
  80   /**
  81    * Blocking interval
  82    */
  83   struct GNUNET_TIME_Relative block_interval;
  84
  85   /**
  86    * Time when address can be suggested again
  87    */
  88   struct GNUNET_TIME_Absolute blocked_until;
  89
  90   /**
  91    * Is this the active address for this peer?
  92    */
  93   int active;
  94
  95   /**
  96    * Is this the address for this peer in use?
  97    */
  98   int used;
  99 };
 100
 101
 102 typedef void *
 103  (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
 104                      const struct GNUNET_STATISTICS_Handle *stats,
 105                      int *network,
 106                      unsigned long long *out_dest,
 107                      unsigned long long *in_dest,
 108                      int dest_length);
 109
 110 typedef void
 111 (*GAS_solver_address_change_preference) (void *solver,
 112                                          const struct GNUNET_PeerIdentity *peer,
 113                                          enum GNUNET_ATS_PreferenceKind kind,
 114                                          float score);
 115
 116 typedef void
 117  (*GAS_solver_address_delete) (void *solver,
 118                                struct GNUNET_CONTAINER_MultiHashMap *addresses,
 119                                struct ATS_Address *address);
 120
 121 typedef void
 122 (*GAS_solver_address_update) (void *solver,
 123                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 124                               struct ATS_Address *address);
 125
 126
 127 typedef struct ATS_Address *
 128 (*GAS_solver_get_preferred_address) (void *solver,
 129                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 130                                      const struct GNUNET_PeerIdentity *peer);
 131
 132
 133 typedef void
 134  (*GAS_solver_done) (void *solver);
 135
 136
 137 /**
 138  * Initialize address subsystem.
 139  *
 140  * @param cfg configuration to use
 141  * @param stats the statistics handle to use
 142  */
 143 struct GAS_Addresses_Handle *
 144 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 145                     const struct GNUNET_STATISTICS_Handle *stats);
 146
 147 /**
 148  * Shutdown address subsystem.
 149  */
 150 void
 151 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
 152
 153 void
 154 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
 155
 156 /**
 157  * This address is now used or not used anymore
 158  */
 159 int
 160 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
 161                       const char *plugin_name, const void *plugin_addr,
 162                       size_t plugin_addr_len, uint32_t session_id, int in_use);
 163
 164 void
 165 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 166                       const char *plugin_name, const void *plugin_addr,
 167                       size_t plugin_addr_len, uint32_t session_id,
 168                       const struct GNUNET_ATS_Information *atsi,
 169                       uint32_t atsi_count);
 170
 171
 172 void
 173 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 174                        const char *plugin_name, const void *plugin_addr,
 175                        size_t plugin_addr_len, uint32_t session_id);
 176
 177
 178 void
 179 GAS_addresses_destroy_all (void);
 180
 181
 182 /**
 183  * Cancel address suggestions for a peer
 184  *
 185  * @param peer the respective peer
 186  */
 187 void
 188 GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer);
 189
 190 void
 191 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 192
 193 void
 194 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
 195                                  enum GNUNET_ATS_PreferenceKind kind,
 196                                  float score);
 197
 198 void
 199 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
 200                       const char *plugin_name, const void *plugin_addr,
 201                       size_t plugin_addr_len, uint32_t session_id,
 202                       const struct GNUNET_ATS_Information *atsi,
 203                       uint32_t atsi_count);
 204
 205
 206 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
 207                                           const struct GNUNET_PeerIdentity *id);
 208
 209 /**
 210  * Return all peers currently known to ATS
 211  *
 212  * @param p_it the iterator to call for every peer
 213  * @param p_it_cls the closure for the iterator
 214  */
 215 void
 216 GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
 217
 218 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 219     const struct GNUNET_PeerIdentity *id,
 220     const char *plugin_name,
 221     const void *plugin_addr, size_t plugin_addr_len,
 222     const int address_active,
 223     const struct GNUNET_ATS_Information *atsi,
 224     uint32_t atsi_count,
 225     struct GNUNET_BANDWIDTH_Value32NBO
 226     bandwidth_out,
 227     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 228
 229 /**
 230  * Return information all peers currently known to ATS
 231  *
 232  * @param peer the respective peer
 233  * @param pi_it the iterator to call for every peer
 234  * @param pi_it_cls the closure for the iterator
 235  */
 236 void
 237 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it, void *pi_it_cls);
 238
 239 #endif
 240
 241 /* end of gnunet-service-ats_addresses.h */