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