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
  99 typedef void *
 100  (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
 101                      const struct GNUNET_STATISTICS_Handle *stats);
 102
 103 typedef void
 104 (*GAS_solver_address_change_preference) (void *solver,
 105                                          const struct GNUNET_PeerIdentity *peer,
 106                                          enum GNUNET_ATS_PreferenceKind kind,
 107                                          float score);
 108
 109 typedef void
 110  (*GAS_solver_address_delete) (void *solver,
 111                                struct GNUNET_CONTAINER_MultiHashMap *addresses,
 112                                struct ATS_Address *address);
 113
 114 typedef void
 115 (*GAS_solver_address_update) (void *solver,
 116                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 117                               struct ATS_Address *address);
 118
 119
 120 typedef struct ATS_PreferedAddress *
 121 (*GAS_solver_get_preferred_address) (void *solver,
 122                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 123                                      const struct GNUNET_PeerIdentity *peer);
 124
 125
 126 typedef void
 127  (*GAS_solver_done) (void *solver);
 128
 129
 130 /**
 131  * Initialize address subsystem.
 132  *
 133  * @param cfg configuration to use
 134  * @param stats the statistics handle to use
 135  */
 136 struct GAS_Addresses_Handle *
 137 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 138                     const struct GNUNET_STATISTICS_Handle *stats);
 139
 140 /**
 141  * Shutdown address subsystem.
 142  */
 143 void
 144 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
 145
 146 void
 147 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
 148
 149 /**
 150  * This address is now used or not used anymore
 151  */
 152 int
 153 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
 154                       const char *plugin_name, const void *plugin_addr,
 155                       size_t plugin_addr_len, uint32_t session_id, int in_use);
 156
 157 void
 158 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 159                       const char *plugin_name, const void *plugin_addr,
 160                       size_t plugin_addr_len, uint32_t session_id,
 161                       const struct GNUNET_ATS_Information *atsi,
 162                       uint32_t atsi_count);
 163
 164
 165 void
 166 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 167                        const char *plugin_name, const void *plugin_addr,
 168                        size_t plugin_addr_len, uint32_t session_id);
 169
 170
 171 void
 172 GAS_addresses_destroy_all (void);
 173
 174
 175 /**
 176  * Cancel address suggestions for a peer
 177  *
 178  * @param peer the respective peer
 179  */
 180 void
 181 GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer);
 182
 183 void
 184 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 185
 186 void
 187 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
 188                                  enum GNUNET_ATS_PreferenceKind kind,
 189                                  float score);
 190
 191 void
 192 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
 193                       const char *plugin_name, const void *plugin_addr,
 194                       size_t plugin_addr_len, uint32_t session_id,
 195                       const struct GNUNET_ATS_Information *atsi,
 196                       uint32_t atsi_count);
 197
 198
 199 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
 200                                           const struct GNUNET_PeerIdentity *id);
 201
 202 /**
 203  * Return all peers currently known to ATS
 204  *
 205  * @param p_it the iterator to call for every peer
 206  * @param p_it_cls the closure for the iterator
 207  */
 208 void
 209 GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
 210
 211 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 212     const struct GNUNET_PeerIdentity *id,
 213     const char *plugin_name,
 214     const void *plugin_addr, size_t plugin_addr_len,
 215     const int address_active,
 216     const struct GNUNET_ATS_Information *atsi,
 217     uint32_t atsi_count,
 218     struct GNUNET_BANDWIDTH_Value32NBO
 219     bandwidth_out,
 220     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 221
 222 /**
 223  * Return information all peers currently known to ATS
 224  *
 225  * @param peer the respective peer
 226  * @param pi_it the iterator to call for every peer
 227  * @param pi_it_cls the closure for the iterator
 228  */
 229 void
 230 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it, void *pi_it_cls);
 231
 232 #endif
 233
 234 /* end of gnunet-service-ats_addresses.h */