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  * Address with additional information
  39  */
  40 struct ATS_Address
  41 {
  42   /**
  43    * Next element in DLL
  44    */
  45   struct ATS_Address *next;
  46
  47   /**
  48    * Previous element in DLL
  49    */
  50   struct ATS_Address *prev;
  51
  52   /**
  53    * Peer ID
  54    */
  55   struct GNUNET_PeerIdentity peer;
  56
  57   /**
  58    * Session ID, 0 if no session is given
  59    */
  60   uint32_t session_id;
  61
  62   /**
  63    * Address
  64    */
  65   const void *addr;
  66
  67   /**
  68    * Address length
  69    */
  70   size_t addr_len;
  71
  72   /**
  73    * Plugin name
  74    */
  75   char *plugin;
  76
  77   /**
  78    * MLP specific information
  79    * TODO remove or rename
  80    */
  81   void *mlp_information;
  82
  83   /**
  84    * ATS information
  85    */
  86   //struct GNUNET_ATS_Information *ats;
  87
  88   /**
  89    * Number of ATS information
  90    */
  91   //uint32_t ats_count;
  92
  93   /* CHECK USAGE */
  94   struct GNUNET_TIME_Relative atsp_latency;
  95
  96   /* CHECK USAGE */
  97   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
  98
  99   /* CHECK USAGE */
 100   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
 101
 102
 103   /* CHECK USAGE */
 104   uint32_t atsp_distance;
 105
 106   /* CHECK USAGE */
 107   uint32_t atsp_cost_wan;
 108
 109   /* CHECK USAGE */
 110   uint32_t atsp_cost_lan;
 111
 112   /* CHECK USAGE */
 113   uint32_t atsp_cost_wlan;
 114
 115   /* CHECK USAGE */
 116   uint32_t atsp_network_type;
 117
 118   /**
 119    * Inbound bandwidth assigned by solver in NBO
 120    */
 121   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
 122
 123   /**
 124    * Outbound bandwidth assigned by solver in NBO
 125    */
 126   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
 127
 128   /**
 129    * Blocking interval
 130    */
 131   struct GNUNET_TIME_Relative block_interval;
 132
 133   /**
 134    * Time when address can be suggested again
 135    */
 136   struct GNUNET_TIME_Absolute blocked_until;
 137
 138   /**
 139    * Is this the active address for this peer?
 140    */
 141   int active;
 142
 143   /**
 144    * Is this the address for this peer in use?
 145    */
 146   int used;
 147 };
 148
 149
 150 /**
 151  * Init the simplistic problem solving component
 152  *
 153  * Quotas:
 154  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
 155  * out_quota[i] contains outbound quota for network type i
 156  * in_quota[i] contains inbound quota for network type i
 157  *
 158  * Example
 159  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
 160  * network[2]   == GNUNET_ATS_NET_LAN
 161  * out_quota[2] == 65353
 162  * in_quota[2]  == 65353
 163  *
 164  * @param cfg configuration handle
 165  * @param stats the GNUNET_STATISTICS handle
 166  * @param network array of GNUNET_ATS_NetworkType with length dest_length
 167  * @param out_quota array of outbound quotas
 168  * param in_quota array of outbound quota
 169  * @return handle for the solver on success, NULL on fail
 170  */
 171 typedef void *
 172  (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
 173                      const struct GNUNET_STATISTICS_Handle *stats,
 174                      int *network,
 175                      unsigned long long *out_quota,
 176                      unsigned long long *in_quota,
 177                      int dest_length);
 178
 179 typedef void
 180 (*GAS_solver_address_change_preference) (void *solver,
 181                                          const struct GNUNET_PeerIdentity *peer,
 182                                          enum GNUNET_ATS_PreferenceKind kind,
 183                                          float score);
 184
 185 typedef void
 186  (*GAS_solver_address_delete) (void *solver,
 187                                struct GNUNET_CONTAINER_MultiHashMap *addresses,
 188                                struct ATS_Address *address);
 189
 190 typedef void
 191 (*GAS_solver_address_update) (void *solver,
 192                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
 193                               struct ATS_Address *address);
 194
 195
 196 typedef const struct ATS_Address *
 197 (*GAS_solver_get_preferred_address) (void *solver,
 198                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 199                                      const struct GNUNET_PeerIdentity *peer);
 200
 201
 202 typedef void
 203  (*GAS_solver_done) (void *solver);
 204
 205
 206 /**
 207  * Initialize address subsystem.
 208  *
 209  * @param cfg configuration to use
 210  * @param stats the statistics handle to use
 211  */
 212 struct GAS_Addresses_Handle *
 213 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 214                     const struct GNUNET_STATISTICS_Handle *stats);
 215
 216 /**
 217  * Shutdown address subsystem.
 218  */
 219 void
 220 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
 221
 222 void
 223 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
 224
 225 /**
 226  * This address is now used or not used anymore
 227  */
 228 int
 229 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
 230                       const char *plugin_name, const void *plugin_addr,
 231                       size_t plugin_addr_len, uint32_t session_id, int in_use);
 232
 233 void
 234 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 235                       const char *plugin_name, const void *plugin_addr,
 236                       size_t plugin_addr_len, uint32_t session_id,
 237                       const struct GNUNET_ATS_Information *atsi,
 238                       uint32_t atsi_count);
 239
 240
 241 void
 242 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 243                        const char *plugin_name, const void *plugin_addr,
 244                        size_t plugin_addr_len, uint32_t session_id);
 245
 246
 247 void
 248 GAS_addresses_destroy_all (void);
 249
 250
 251 /**
 252  * Cancel address suggestions for a peer
 253  *
 254  * @param peer the respective peer
 255  */
 256 void
 257 GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer);
 258
 259 void
 260 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 261
 262 void
 263 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
 264                                  enum GNUNET_ATS_PreferenceKind kind,
 265                                  float score);
 266
 267 void
 268 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
 269                       const char *plugin_name, const void *plugin_addr,
 270                       size_t plugin_addr_len, uint32_t session_id,
 271                       const struct GNUNET_ATS_Information *atsi,
 272                       uint32_t atsi_count);
 273
 274
 275 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
 276                                           const struct GNUNET_PeerIdentity *id);
 277
 278 /**
 279  * Return all peers currently known to ATS
 280  *
 281  * @param p_it the iterator to call for every peer
 282  * @param p_it_cls the closure for the iterator
 283  */
 284 void
 285 GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
 286
 287 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 288     const struct GNUNET_PeerIdentity *id,
 289     const char *plugin_name,
 290     const void *plugin_addr, size_t plugin_addr_len,
 291     const int address_active,
 292     const struct GNUNET_ATS_Information *atsi,
 293     uint32_t atsi_count,
 294     struct GNUNET_BANDWIDTH_Value32NBO
 295     bandwidth_out,
 296     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 297
 298 /**
 299  * Return information all peers currently known to ATS
 300  *
 301  * @param peer the respective peer
 302  * @param pi_it the iterator to call for every peer
 303  * @param pi_it_cls the closure for the iterator
 304  */
 305 void
 306 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it, void *pi_it_cls);
 307
 308 #endif
 309
 310 /* end of gnunet-service-ats_addresses.h */