2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file ats/gnunet-service-ats_addresses.h
23 * @brief ats service address management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
30 #include "gnunet_util_lib.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet-service-ats.h"
33 #include "gnunet_statistics_service.h"
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
41 * 1 ATS addresses : ATS address management
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.
54 * Addresses are added by specifying peer ID, plugin, address, address length
55 * and session, if available. ATS information can be specified if available.
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
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
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>
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
89 * unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
90 * the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
92 * * GNUNET_ATS_DefaultBandwidth: 65536
93 * * GNUNET_ATS_MaxBandwidth: UINT32_MAX
94 * * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
96 * Details of loading quotas and default values will be described on
98 * 1.1.4 Preference values
100 * 1.2 Data structures used
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.
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
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
132 * Callbacks: addresses provides a bandwidth_changed_cb callback to the
133 * solver which is called when bandwidth assigned to peer has changed
137 * During shutdown all addresses are freed and the solver told to shutdown
139 * 1.6 Addresses and sessions
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.
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)
154 * 1.7 Address management
156 * Transport service notifies ATS about changes to the addresses known to
159 * 1.7.1 Adding an address
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
167 * 1.7.2 Updating an address
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.
173 * 1.7.3 Deleting an address
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.
179 * 1.7.4 Requesting an address suggestion
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.
186 * 1.7.5 Address suggestions
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.
193 * 1.7.6 Suggestions blocks and reset
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.
199 * 1.7.7 Marking address in use
201 * The client can notify addresses that it successfully uses an address and
202 * wants this address to be kept by calling GSA_address_in_use. Adresses will
203 * mark the address as used an notify the solver about the use.
205 * 1.7.8 Address lifecycle
208 * * (updated address) || (address in use)
211 * 1.8 Bandwidth assignment
213 * The addresses are used to perform resource allocation operations. ATS
214 * addresses takes care of instantiating the solver configured and notifies
215 * the respective solver about address changes and receives changes to the
216 * bandwidth assignment from the solver. The current bandwidth assignment is
217 * sent to transport. The specific solvers will be described in the specific
220 * 1.9 Changing peer preferences
222 * The bandwidth assigned to a peer can be influenced by setting a preference
223 * for a peer. The prefernce will be given to to the solver with s_pref which
224 * has to take care of the preference value
229 * How long will address suggestions blocked after a suggestion
231 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
234 * Information provided by ATS normalization
236 struct GAS_NormalizationInfo
239 * Next index to use in averaging queue
241 unsigned int avg_queue_index;
246 uint32_t atsi_abs[GAS_normalization_queue_length];
249 * Averaged ATSI values from queue
254 * Normalized values from queue to a range of values [1.0...2.0]
260 * Address with additional information
265 * Next element in DLL
267 struct ATS_Address *next;
270 * Previous element in DLL
272 struct ATS_Address *prev;
277 struct GNUNET_PeerIdentity peer;
280 * Session ID, 0 if no session is given
300 * Solver specific information for this address
302 void *solver_information;
305 * ATS performance information for this address
307 struct GNUNET_ATS_Information *atsi;
310 * ATS performance information for this address
315 * Inbound bandwidth assigned by solver in NBO
317 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
320 * Outbound bandwidth assigned by solver in NBO
322 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
327 struct GNUNET_TIME_Relative block_interval;
330 * Time when address can be suggested again
332 struct GNUNET_TIME_Absolute blocked_until;
335 * Is this the active address for this peer?
340 * Is this the address for this peer in use?
345 * Normalized ATS performance information for this address
346 * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
348 struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
354 * Initialize address subsystem. The addresses subsystem manages the addresses
355 * known and current performance information. It has a solver component
356 * responsible for the resource allocation. It tells the solver about changes
357 * and receives updates when the solver changes the ressource allocation.
359 * @param cfg configuration to use
360 * @param stats the statistics handle to use
361 * @return an address handle
363 struct GAS_Addresses_Handle *
364 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
365 const struct GNUNET_STATISTICS_Handle *stats);
368 * Shutdown address subsystem.
370 * @param handle the address handle to shutdown
373 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
376 * Add a new address for a peer.
378 * @param handle the address handle to use
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 session_id session id, can be 0
384 * @param atsi performance information for this address
385 * @param atsi_count number of performance information contained
388 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
389 const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
390 const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
391 const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count);
394 * Notification about active use of an address.
395 * in_use == GNUNET_YES:
396 * This address is used to maintain an active connection with a peer.
397 * in_use == GNUNET_NO:
398 * This address is no longer used to maintain an active connection with a peer.
400 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
403 * @param handle the address handle to use
405 * @param plugin_name transport plugin name
406 * @param plugin_addr plugin address
407 * @param plugin_addr_len length of the plugin address
408 * @param session_id session id, can be 0
409 * @param in_use GNUNET_YES if GNUNET_NO
410 * @return GNUNET_SYSERR on failure (address unknown ...)
413 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
414 const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
415 const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
419 * Update an address with a session or performance information for a peer.
421 * If an address was added without a session it will be updated with the
424 * @param handle the address handle to use
426 * @param plugin_name transport plugin name
427 * @param plugin_addr plugin address
428 * @param plugin_addr_len length of the plugin address
429 * @param session_id session id, can be 0
430 * @param atsi performance information for this address
431 * @param atsi_count number of performance information contained
434 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
435 const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
436 const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id,
437 const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count);
440 * Remove an address or just a session for a peer.
442 * @param handle the address handle to use
444 * @param plugin_name transport plugin name
445 * @param plugin_addr plugin address
446 * @param plugin_addr_len length of the plugin address
447 * @param session_id session id, can be 0
450 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
451 const struct GNUNET_PeerIdentity *peer, const char *plugin_name,
452 const void *plugin_addr, size_t plugin_addr_len, uint32_t session_id);
455 * Remove all addresses
457 * @param handle the address handle to use
460 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
463 * Request address suggestions for a peer
465 * @param handle the address handle
466 * @param peer the peer id
469 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
470 const struct GNUNET_PeerIdentity *peer);
473 * Cancel address suggestions for a peer
475 * @param handle the address handle
476 * @param peer the peer id
479 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
480 const struct GNUNET_PeerIdentity *peer);
483 * Reset suggestion backoff for a peer
485 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
486 * reset using this function
488 * @param handle the address handle
489 * @param peer the peer id
492 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
493 const struct GNUNET_PeerIdentity *peer);
496 * Change the preference for a peer
498 * @param handle the address handle
499 * @param client the client sending this request
500 * @param peer the peer id
501 * @param kind the preference kind to change
502 * @param score_abs the new preference score
505 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
506 void *client, const struct GNUNET_PeerIdentity *peer,
507 enum GNUNET_ATS_PreferenceKind kind, float score_abs);
510 * Application feedback on how good preference requirements are fulfilled
511 * for a specific preference in the given time scope [now - scope .. now]
513 * An application notifies ATS if (and only if) it has feedback information
514 * for a specific property. This value is valid until the feedback score is
515 * updated by the application.
517 * If the application has no feedback for this preference kind the application
518 * will not explicitly call.
520 * @param handle the address handle
521 * @param application the application sending this request
522 * @param peer the peer id
523 * @param scope the time interval this valid for: [now - scope .. now]
524 * @param kind the preference kind this feedback is intended for
525 * @param score_abs the new preference score
528 GAS_addresses_preference_feedback (struct GAS_Addresses_Handle *handle,
529 void *application, const struct GNUNET_PeerIdentity *peer,
530 const struct GNUNET_TIME_Relative scope,
531 enum GNUNET_ATS_PreferenceKind kind, float score_abs);
534 * Iterator for GAS_addresses_iterate_peers
536 * @param p_it_cls closure
537 * @param id the peer id
540 (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
541 const struct GNUNET_PeerIdentity *id);
544 * Return all peers currently known to ATS
546 * @param handle the address handle to use
547 * @param p_it the iterator to call for every peer
548 * @param p_it_cls the closure for the iterator
551 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
552 GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
555 * Iterator for GAS_addresses_get_peer_info
557 * @param p_it_cls closure closure
558 * @param id the peer id
559 * @param plugin_name plugin name
560 * @param plugin_addr address
561 * @param plugin_addr_len address length
562 * @param address_active is address actively used
563 * @param atsi ats performance information
564 * @param atsi_count number of ats performance elements
565 * @param bandwidth_out current outbound bandwidth assigned to address
566 * @param bandwidth_in current inbound bandwidth assigned to address
569 (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
570 const struct GNUNET_PeerIdentity *id, const char *plugin_name,
571 const void *plugin_addr, size_t plugin_addr_len, const int address_active,
572 const struct GNUNET_ATS_Information *atsi, uint32_t atsi_count,
573 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
574 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
577 * Return information all peers currently known to ATS
579 * @param handle the address handle to use
580 * @param peer the respective peer
581 * @param pi_it the iterator to call for every peer
582 * @param pi_it_cls the closure for the iterator
585 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
586 const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it,
591 /* end of gnunet-service-ats_addresses.h */