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  * Available ressource assignment modes
 224  */
 225 enum ATS_Mode
 226 {
 227   /**
 228    * proportional mode:
 229    *
 230    * Assign each peer an equal amount of bandwidth (bw)
 231    *
 232    * bw_per_peer = bw_total / #active addresses
 233    */
 234   MODE_PROPORTIONAL,
 235
 236   /**
 237    * MLP mode:
 238    *
 239    * Solve ressource assignment as an optimization problem
 240    * Uses an mixed integer programming solver
 241    */
 242   MODE_MLP,
 243
 244   /**
 245    * Reinforcement Learning mode:
 246    *
 247    * Solve resource assignment using a learning agent
 248    */
 249   MODE_RIL
 250 };
 251
 252
 253 /*
 254  * How long will address suggestions blocked after a suggestion
 255  */
 256 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
 257
 258 /**
 259  * Information provided by ATS normalization
 260  */
 261 struct GAS_NormalizationInfo
 262 {
 263   /**
 264    * Next index to use in averaging queue
 265    */
 266   unsigned int avg_queue_index;
 267
 268   /**
 269    * Averaging queue
 270    */
 271   uint32_t atsi_abs[GAS_normalization_queue_length];
 272
 273   /**
 274    * Averaged ATSI values from queue
 275    */
 276   uint32_t avg;
 277
 278   /**
 279    * Normalized values from queue to a range of values [1.0...2.0]
 280    */
 281   double norm;
 282 };
 283
 284
 285 /**
 286  * Address with additional information
 287  */
 288 struct ATS_Address
 289 {
 290   /**
 291    * Next element in DLL
 292    */
 293   struct ATS_Address *next;
 294
 295   /**
 296    * Previous element in DLL
 297    */
 298   struct ATS_Address *prev;
 299
 300   /**
 301    * Peer ID
 302    */
 303   struct GNUNET_PeerIdentity peer;
 304
 305   /**
 306    * Address
 307    */
 308   const void *addr;
 309
 310   /**
 311    * Address length
 312    */
 313   size_t addr_len;
 314
 315   /**
 316    * Session ID, can never be 0.
 317    */
 318   uint32_t session_id;
 319
 320   /**
 321    * Field to store local flags
 322    */
 323   uint32_t local_address_info;
 324
 325   /**
 326    * Plugin name
 327    */
 328   char *plugin;
 329
 330   /**
 331    * Solver specific information for this address
 332    */
 333   void *solver_information;
 334
 335   /**
 336    * ATS performance information for this address
 337    */
 338   struct GNUNET_ATS_Information *atsi;
 339
 340   /**
 341    * ATS performance information for this address
 342    */
 343   uint32_t atsi_count;
 344
 345   /**
 346    * Inbound bandwidth assigned by solver
 347    */
 348   uint32_t assigned_bw_in;
 349
 350   /**
 351    * Outbound bandwidth assigned by solver
 352    */
 353   uint32_t assigned_bw_out;
 354
 355   /**
 356    * Inbound bandwidth assigned by solver in NBO
 357    */
 358   uint32_t last_notified_bw_in;
 359
 360   /**
 361    * Outbound bandwidth assigned by solver in NBO
 362    */
 363   uint32_t last_notified_bw_out;
 364
 365
 366   /**
 367    * Blocking interval
 368    */
 369   struct GNUNET_TIME_Relative block_interval;
 370
 371   /**
 372    * Time when address can be suggested again
 373    */
 374   struct GNUNET_TIME_Absolute blocked_until;
 375
 376   /**
 377    * Time when address had last activity (update, in uses)
 378    */
 379   struct GNUNET_TIME_Absolute t_last_activity;
 380
 381   /**
 382    * Time when address was added
 383    */
 384   struct GNUNET_TIME_Absolute t_added;
 385
 386   /**
 387    * Is this the active address for this peer?
 388    */
 389   int active;
 390
 391   /**
 392    * Is this the address for this peer in use?
 393    */
 394   int used;
 395
 396   /**
 397    * Normalized ATS performance information for this address
 398    * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
 399    */
 400   struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
 401 };
 402
 403
 404 /**
 405  * Initialize address subsystem. The addresses subsystem manages the addresses
 406  * known and current performance information. It has a solver component
 407  * responsible for the resource allocation. It tells the solver about changes
 408  * and receives updates when the solver changes the ressource allocation.
 409  *
 410  * @param cfg configuration to use
 411  * @param stats the statistics handle to use
 412  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (failed to load
 413  *         solver plugin)
 414  */
 415 int
 416 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 417                     struct GNUNET_STATISTICS_Handle *stats);
 418
 419
 420 /**
 421  * Shutdown address subsystem.
 422  */
 423 void
 424 GAS_addresses_done (void);
 425
 426
 427 /**
 428  * Add a new address for a peer.
 429  *
 430  * @param peer peer
 431  * @param plugin_name transport plugin name
 432  * @param plugin_addr plugin address
 433  * @param plugin_addr_len length of the plugin address
 434  * @param local_address_info the local address for the address
 435  * @param session_id session id, can never be 0.
 436  * @param atsi performance information for this address
 437  * @param atsi_count number of performance information contained in @a atsi
 438  */
 439 void
 440 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
 441                    const char *plugin_name,
 442                    const void *plugin_addr,
 443                    size_t plugin_addr_len,
 444                    uint32_t local_address_info,
 445                    uint32_t session_id,
 446                    const struct GNUNET_ATS_Information *atsi,
 447                    uint32_t atsi_count);
 448
 449
 450 /**
 451  * Update an address with new performance information for a peer.
 452  *
 453  * @param peer peer
 454  * @param session_id session id, can never be 0
 455  * @param atsi performance information for this address
 456  * @param atsi_count number of performance information contained in @a atsi
 457  */
 458 void
 459 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 460                       uint32_t session_id,
 461                       const struct GNUNET_ATS_Information *atsi,
 462                       uint32_t atsi_count);
 463
 464
 465 /**
 466  * Remove an address or just a session for a peer.
 467  *
 468  * @param peer peer
 469  * @param session_id session id, can never be 0
 470  */
 471 void
 472 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 473                        uint32_t session_id);
 474
 475
 476 /**
 477  * Remove all addresses
 478  */
 479 void
 480 GAS_addresses_destroy_all (void);
 481
 482
 483 /**
 484  * Request address suggestions for a peer
 485  *
 486  * @param peer the peer id
 487  */
 488 void
 489 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 490
 491
 492 /**
 493  * Cancel address suggestions for a peer
 494  *
 495  * @param peer the peer id
 496  */
 497 void
 498 GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer);
 499
 500
 501 /**
 502  * Reset suggestion backoff for a peer
 503  *
 504  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
 505  * reset using this function
 506  *
 507  * @param peer the peer id
 508  */
 509 void
 510 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
 511
 512
 513 /**
 514  * A performance client disconnected
 515  *
 516  * @param client the client; FIXME: type!?
 517  */
 518 void
 519 GAS_addresses_preference_client_disconnect (void *client);
 520
 521
 522 /**
 523  * Change the preference for a peer
 524  *
 525  * @param client the client sending this request; FIXME: type!?
 526  * @param peer the peer id
 527  * @param kind the preference kind to change
 528  * @param score_abs the new preference score
 529  */
 530 void
 531 GAS_addresses_preference_change (void *client,
 532                                  const struct GNUNET_PeerIdentity *peer,
 533                                  enum GNUNET_ATS_PreferenceKind kind,
 534                                  float score_abs);
 535
 536
 537 /**
 538  * Application feedback on how good preference requirements are fulfilled
 539  * for a specific preference in the given time scope [now - scope .. now]
 540  *
 541  * An application notifies ATS if (and only if) it has feedback information
 542  * for a specific property. This value is valid until the feedback score is
 543  * updated by the application.
 544  *
 545  * If the application has no feedback for this preference kind the application
 546  * will not explicitly call.
 547  *
 548  * @param application the application sending this request; FIXME: type?
 549  * @param peer the peer id
 550  * @param scope the time interval this valid for: [now - scope .. now]
 551  * @param kind the preference kind this feedback is intended for
 552  * @param score_abs the new preference score
 553  */
 554 void
 555 GAS_addresses_preference_feedback (void *application,
 556                                    const struct GNUNET_PeerIdentity *peer,
 557                                    const struct GNUNET_TIME_Relative scope,
 558                                    enum GNUNET_ATS_PreferenceKind kind,
 559                                    float score_abs);
 560
 561
 562 /**
 563  * Iterator for #GAS_addresses_get_peer_info()
 564  *
 565  * @param p_it_cls closure closure
 566  * @param id the peer id
 567  * @param plugin_name plugin name
 568  * @param plugin_addr address
 569  * @param plugin_addr_len length of @a plugin_addr
 570  * @param address_active is address actively used
 571  * @param atsi ats performance information
 572  * @param atsi_count number of ats performance elements in @a atsi
 573  * @param bandwidth_out current outbound bandwidth assigned to address
 574  * @param bandwidth_in current inbound bandwidth assigned to address
 575  */
 576 typedef void
 577 (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
 578                                  const struct GNUNET_PeerIdentity *id,
 579                                  const char *plugin_name,
 580                                  const void *plugin_addr,
 581                                  size_t plugin_addr_len,
 582                                  const int address_active,
 583                                  const struct GNUNET_ATS_Information *atsi,
 584                                  uint32_t atsi_count,
 585                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 586                                  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 587
 588
 589 /**
 590  * Return information all peers currently known to ATS
 591  *
 592  * @param peer the respective peer
 593  * @param pi_it the iterator to call for every peer
 594  * @param pi_it_cls the closure for @a pi_it
 595  */
 596 void
 597 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer,
 598                              GNUNET_ATS_PeerInfo_Iterator pi_it,
 599                              void *pi_it_cls);
 600
 601 #endif
 602
 603 /* end of gnunet-service-ats_addresses.h */