src/ats/gnunet-service-ats_addresses.h

   1 /*
   2  This file is part of GNUnet.
   3  (C) 2011-2014 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-service-ats.h"
  33 #include "gnunet_statistics_service.h"
  34 #include "ats.h"
  35
  36 /**
  37  * NOTE: Do not change this documentation. This documentation is based on
  38  * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
  39  * use build_txt.sh to generate plaintext output
  40  *
  41  *   1 ATS addresses : ATS address management
  42  *
  43  *    This ATS addresses ("addresses") component manages the addresses known to
  44  *    ATS service and suggests addresses to transport service when it is
  45  *    interested in address suggestion for a peer. ATS addresses also
  46  *    instantiates the bandwidth assignment mechanism (solver), notifies it
  47  *    about changes to addresses and forwards changes to bandwidth assignments
  48  *    to transport, depending if transport is interested in this change.
  49  *
  50  *     1.1 Input data
  51  *
  52  *       1.1.1 Addresses
  53  *
  54  *    Addresses are added by specifying peer ID, plugin, address, address length
  55  *    and session, if available. ATS information can be specified if available.
  56  *
  57  *       1.1.2 Networks
  58  *
  59  *    ATS specifies a fix set of networks an address can belong to. For each
  60  *    network an inbound and outbound quota will be specified. The available
  61  *    networks and addtional helper varaibles are defined in
  62  *    gnunet_ats_service.h. At the moment 5 networks are defined:
  63  *      * GNUNET_ATS_NET_UNSPECIFIED
  64  *      * GNUNET_ATS_NET_LOOPBACK
  65  *      * GNUNET_ATS_NET_LAN
  66  *      * GNUNET_ATS_NET_WAN
  67  *      * GNUNET_ATS_NET_WLAN
  68  *
  69  *    The total number of networks defined is stored in
  70  *    GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
  71  *    initializer for an int array, while GNUNET_ATS_NetworkType is an
  72  *    initializer for a char array containing a string description of all
  73  *    networks
  74  *
  75  *       1.1.3 Quotas
  76  *
  77  *    An inbound and outbound quota for each of the networks mentioned in 1.1.2
  78  *    is loaded from ats configuration during initialization. This quota defines
  79  *    to total amount of inbound and outbound traffic allowed for a specific
  80  *    network. The configuration values used are in section ats:
  81  *      * "NETWORK"_QUOTA_IN = <value>
  82  *      * "NETWORK"_QUOTA_IN = <value>
  83  *
  84  *    You can specify quotas by setting the <value> to a:
  85  *      * unrestricted: unlimited
  86  *      * number of bytes: e.g. 10240
  87  *      * fancy value: e.g. 64 Kib
  88  *
  89  *    unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
  90  *    the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
  91  *    are:
  92  *      * GNUNET_ATS_DefaultBandwidth: 65536
  93  *      * GNUNET_ATS_MaxBandwidth: UINT32_MAX
  94  *      * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
  95  *
  96  *    Details of loading quotas and default values will be described on
  97  *
  98  *       1.1.4 Preference values
  99  *
 100  *     1.2 Data structures used
 101  *
 102  *    Addresse uses struct ATS_Address for each address. The structs are stored
 103  *    in a linked list and provides a pointer void *solver_information for the
 104  *    solver to store address specific information. It provides the int values
 105  *    active which is set to GNUNET_YES if the address is select for transport
 106  *    use and used, representing that transport service is actively using this
 107  *    address. Address information are stored in peer, addr, addr_len, plugin.
 108  *
 109  *     1.3 Initialization
 110  *
 111  *    During initialization a hashmap to store addresses is created. The quotas
 112  *    for all networks defined for ATS are loaded from configuration. For each
 113  *    network first the logic will check if the string
 114  *    GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
 115  *    the configured value as a fancy size and if this fails it will try to use
 116  *    it as a value_number. If no configuration value is found it will assign
 117  *    GNUNET_ATS_DefaultBandwidth. The most important step is to load the
 118  *    configured solver using configuration "[ats]:MODE". Current solvers are
 119  *    MODE_PROPORTIONAL, MODE_MLP. Interaction is done using a solver API
 120  *
 121  *     1.4 Solver API
 122  *
 123  *    Solver functions:
 124  *      * s_init: init the solver with required information
 125  *      * s_add: add a new address
 126  *      * s_update: update ATS values or session for an address
 127  *      * s_get: get prefered address for a peer
 128  *      * s_del: delete an address
 129  *      * s_pref: change preference value for a peer
 130  *      * s_done: shutdown solver
 131  *
 132  *    Callbacks: addresses provides a bandwidth_changed_cb callback to the
 133  *    solver which is called when bandwidth assigned to peer has changed
 134  *
 135  *     1.5 Shutdown
 136  *
 137  *    During shutdown all addresses are freed and the solver told to shutdown
 138  *
 139  *     1.6 Addresses and sessions
 140  *
 141  *    Addresses consist of the address itself and a numerical session. When a
 142  *    new address without a session is added it has no session, so it gets
 143  *    session 0 assigned. When an address with a session is added and an address
 144  *    object with session 0 is found, this object is updated with the session
 145  *    otherwise a new address object with this session assigned is created.
 146  *
 147  *       1.6.1 Terminology
 148  *
 149  *    Addresses a1,a2 with session s1, s2 are "exact" if:
 150  *    (a1 == a2)&&(s1 == s2)
 151  *    Addresses a1,a2 with session s1, s2 are "equivalent" if:
 152  *    (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
 153  *
 154  *     1.7 Address management
 155  *
 156  *    Transport service notifies ATS about changes to the addresses known to
 157  *    him.
 158  *
 159  *       1.7.1 Adding an address
 160  *
 161  *    When transport learns a new address it tells ATS and ATS is telling
 162  *    addresses about it using GAS_address_add. If not known to addresses it
 163  *    creates a new address object and calls solver's s_add. ATS information are
 164  *    deserialized and solver is notified about the session and ATS information
 165  *    using s_update.
 166  *
 167  *       1.7.2 Updating an address
 168  *
 169  *    Addresses does an lookup up for the existing address with the given
 170  *    session. If disassembles included ATS information and notifies the solver
 171  *    using s_update about the update.
 172  *
 173  *       1.7.3 Deleting an address
 174  *
 175  *    Addresses does an lookup for the exact address and session and if removes
 176  *    this address. If session != 0 the session is set to 0 and the address is
 177  *    kept. If session == 0, the addresses is removed.
 178  *
 179  *       1.7.4 Requesting an address suggestion
 180  *
 181  *    The address client issues a request address message to be notified about
 182  *    address suggestions for a specific peer. Addresses asks the solver with
 183  *    s_get. If no address is available, it will not send a response, otherwise
 184  *    it will respond with the choosen address.
 185  *
 186  *       1.7.5 Address suggestions
 187  *
 188  *    Addresses will notify the client automatically on any bandwidth_changed_cb
 189  *    by the solver if a address suggestion request is pending. If no address is
 190  *    available it will not respond at all If the client is not interested
 191  *    anymore, it has to cancel the address suggestion request.
 192  *
 193  *       1.7.6 Suggestions blocks and reset
 194  *
 195  *    After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
 196  *    prevent the client from being thrashed. If the client requires immediately
 197  *    it can reset this block using GAS_addresses_handle_backoff_reset.
 198  *
 199  *       1.7.7 Address lifecycle
 200  *
 201  *      * (add address)
 202  *      * (updated address)
 203  *      * (delete address)
 204  *
 205  *     1.8 Bandwidth assignment
 206  *
 207  *    The addresses are used to perform resource allocation operations. ATS
 208  *    addresses takes care of instantiating the solver configured and notifies
 209  *    the respective solver about address changes and receives changes to the
 210  *    bandwidth assignment from the solver. The current bandwidth assignment is
 211  *    sent to transport. The specific solvers will be described in the specific
 212  *    section.
 213  *
 214  *     1.9 Changing peer preferences
 215  *
 216  *    The bandwidth assigned to a peer can be influenced by setting a preference
 217  *    for a peer. The prefernce will be given to to the solver with s_pref which
 218  *    has to take care of the preference value
 219  */
 220
 221
 222 /*
 223  * How long will address suggestions blocked after a suggestion
 224  */
 225 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
 226
 227 /**
 228  * Information provided by ATS normalization
 229  */
 230 struct GAS_NormalizationInfo
 231 {
 232   /**
 233    * Next index to use in averaging queue
 234    */
 235   unsigned int avg_queue_index;
 236
 237   /**
 238    * Averaging queue
 239    */
 240   uint32_t atsi_abs[GAS_normalization_queue_length];
 241
 242   /**
 243    * Averaged ATSI values from queue
 244    */
 245   uint32_t avg;
 246
 247   /**
 248    * Normalized values from queue to a range of values [1.0...2.0]
 249    */
 250   double norm;
 251 };
 252
 253
 254 /**
 255  * Address with additional information
 256  */
 257 struct ATS_Address
 258 {
 259   /**
 260    * Peer ID this address is for.
 261    */
 262   struct GNUNET_PeerIdentity peer;
 263
 264   /**
 265    * Address (in plugin-specific binary format).
 266    */
 267   const void *addr;
 268
 269   /**
 270    * Plugin name
 271    */
 272   char *plugin;
 273
 274   /**
 275    * Solver specific information for this address
 276    */
 277   void *solver_information;
 278
 279   /**
 280    * ATS performance information for this address
 281    */
 282   struct GNUNET_ATS_Information *atsi;
 283
 284   /**
 285    * Time when address had last activity (update, in uses)
 286    */
 287   struct GNUNET_TIME_Absolute t_last_activity;
 288
 289   /**
 290    * Time when address was added
 291    */
 292   struct GNUNET_TIME_Absolute t_added;
 293
 294   /**
 295    * Address length, number of bytes in @e addr.
 296    */
 297   size_t addr_len;
 298
 299   /**
 300    * Session ID, can never be 0.
 301    */
 302   uint32_t session_id;
 303
 304   /**
 305    * Field to store local flags
 306    */
 307   uint32_t local_address_info;
 308
 309   /**
 310    * ATS performance information for this address, size of the @e atsi array.
 311    */
 312   uint32_t atsi_count;
 313
 314   /**
 315    * Inbound bandwidth assigned by solver
 316    */
 317   uint32_t assigned_bw_in;
 318
 319   /**
 320    * Outbound bandwidth assigned by solver
 321    */
 322   uint32_t assigned_bw_out;
 323
 324   /**
 325    * Inbound bandwidth assigned by solver in NBO
 326    */
 327   uint32_t last_notified_bw_in;
 328
 329   /**
 330    * Outbound bandwidth assigned by solver in NBO
 331    */
 332   uint32_t last_notified_bw_out;
 333
 334   /**
 335    * Is this the active address for this peer?
 336    */
 337   int active;
 338
 339   /**
 340    * Is this the address for this peer in use?
 341    */
 342   int used;
 343
 344   /**
 345    * Normalized ATS performance information for this address
 346    * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
 347    */
 348   struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
 349 };
 350
 351
 352 /**
 353  * A multipeermap mapping peer identities to `struct ATS_Address`.
 354  */
 355 extern struct GNUNET_CONTAINER_MultiPeerMap *GSA_addresses;
 356
 357
 358
 359 /**
 360  * Initialize address subsystem. The addresses subsystem manages the addresses
 361  * known and current performance information.
 362  *
 363  * @param server handle to our server
 364  */
 365 void
 366 GAS_addresses_init (struct GNUNET_SERVER_Handle *server);
 367
 368
 369 /**
 370  * Shutdown address subsystem.
 371  */
 372 void
 373 GAS_addresses_done (void);
 374
 375
 376 /**
 377  * Add a new address for a peer.
 378  *
 379  * @param peer peer
 380  * @param plugin_name transport plugin name
 381  * @param plugin_addr plugin address
 382  * @param plugin_addr_len length of the plugin address
 383  * @param local_address_info the local address for the address
 384  * @param session_id session id, can never be 0.
 385  * @param atsi performance information for this address
 386  * @param atsi_count number of performance information contained in @a atsi
 387  */
 388 void
 389 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
 390                    const char *plugin_name,
 391                    const void *plugin_addr,
 392                    size_t plugin_addr_len,
 393                    uint32_t local_address_info,
 394                    uint32_t session_id,
 395                    const struct GNUNET_ATS_Information *atsi,
 396                    uint32_t atsi_count);
 397
 398
 399 /**
 400  * Update an address with new performance information for a peer.
 401  *
 402  * @param peer peer
 403  * @param session_id session id, can never be 0
 404  * @param atsi performance information for this address
 405  * @param atsi_count number of performance information contained in @a atsi
 406  */
 407 void
 408 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 409                       uint32_t session_id,
 410                       const struct GNUNET_ATS_Information *atsi,
 411                       uint32_t atsi_count);
 412
 413
 414 /**
 415  * Remove an address or just a session for a peer.
 416  *
 417  * @param peer peer
 418  * @param session_id session id, can never be 0
 419  */
 420 void
 421 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 422                        uint32_t session_id);
 423
 424
 425 /**
 426  * Remove all addresses.
 427  */
 428 void
 429 GAS_addresses_destroy_all (void);
 430
 431
 432 /**
 433  * Iterator for #GAS_addresses_get_peer_info()
 434  *
 435  * @param p_it_cls closure closure
 436  * @param id the peer id
 437  * @param plugin_name plugin name
 438  * @param plugin_addr address
 439  * @param plugin_addr_len length of @a plugin_addr
 440  * @param address_active is address actively used
 441  * @param atsi ats performance information
 442  * @param atsi_count number of ats performance elements in @a atsi
 443  * @param bandwidth_out current outbound bandwidth assigned to address
 444  * @param bandwidth_in current inbound bandwidth assigned to address
 445  */
 446 typedef void
 447 (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 448                                  const struct GNUNET_PeerIdentity *id,
 449                                  const char *plugin_name,
 450                                  const void *plugin_addr,
 451                                  size_t plugin_addr_len,
 452                                  const int address_active,
 453                                  const struct GNUNET_ATS_Information *atsi,
 454                                  uint32_t atsi_count,
 455                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 456                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 457
 458
 459 /**
 460  * Return information all peers currently known to ATS
 461  *
 462  * @param peer the respective peer
 463  * @param pi_it the iterator to call for every peer
 464  * @param pi_it_cls the closure for @a pi_it
 465  */
 466 void
 467 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer,
 468                              GNUNET_ATS_PeerInfo_Iterator pi_it,
 469                              void *pi_it_cls);
 470
 471
 472 /**
 473  * Handle 'address list request' messages from clients.
 474  *
 475  * @param cls unused, NULL
 476  * @param client client that sent the request
 477  * @param message the request message
 478  */
 479 void
 480 GAS_handle_request_address_list (void *cls,
 481                                  struct GNUNET_SERVER_Client *client,
 482                                  const struct GNUNET_MessageHeader *message);
 483
 484
 485 #endif
 486
 487 /* end of gnunet-service-ats_addresses.h */