src/ats/gnunet-service-ats_addresses.h

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