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_SIMPLISTIC, 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
230 * How long will address suggestions blocked after a suggestion
232 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
234 struct GAS_Addresses_Handle;
237 struct GAS_NormalizationInfo
240 uint32_t atsi_abs[GAS_normalization_queue_length];
244 * Address with additional information
249 * Next element in DLL
251 struct ATS_Address *next;
254 * Previous element in DLL
256 struct ATS_Address *prev;
261 struct GNUNET_PeerIdentity peer;
264 * Session ID, 0 if no session is given
284 * Solver specific information for this address
286 void *solver_information;
289 * ATS performance information for this address
291 struct GNUNET_ATS_Information *atsi;
294 * ATS performance information for this address
300 struct GNUNET_TIME_Relative atsp_latency;
303 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
306 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
310 uint32_t atsp_distance;
313 uint32_t atsp_cost_wan;
316 uint32_t atsp_cost_lan;
319 uint32_t atsp_cost_wlan;
322 uint32_t atsp_network_type;
325 * Inbound bandwidth assigned by solver in NBO
327 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
330 * Outbound bandwidth assigned by solver in NBO
332 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
337 struct GNUNET_TIME_Relative block_interval;
340 * Time when address can be suggested again
342 struct GNUNET_TIME_Absolute blocked_until;
345 * Is this the active address for this peer?
350 * Is this the address for this peer in use?
355 * Normalized ATS performance information for this address
356 * Each entry can be accessed using the GNUNET_ATS_QualityProperties index
358 struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
363 * Callback to call from solver when bandwidth for address has changed
365 * @param address the with changed bandwidth assigned
369 (*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
371 typedef const double *
372 (*GAS_get_preferences) (void *cls, const struct GNUNET_PeerIdentity *id);
381 * Init the simplistic problem solving component
384 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
385 * out_quota[i] contains outbound quota for network type i
386 * in_quota[i] contains inbound quota for network type i
389 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
390 * network[2] == GNUNET_ATS_NET_LAN
391 * out_quota[2] == 65353
392 * in_quota[2] == 65353
394 * @param cfg configuration handle
395 * @param stats the GNUNET_STATISTICS handle
396 * @param network array of GNUNET_ATS_NetworkType with length dest_length
397 * @param out_quota array of outbound quotas
398 * @param in_quota array of outbound quota
399 * @param bw_changed_cb callback to call when assigned changes
400 * @return handle for the solver on success, NULL on fail
403 (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
404 const struct GNUNET_STATISTICS_Handle *stats,
406 unsigned long long *out_quota,
407 unsigned long long *in_quota,
409 GAS_bandwidth_changed_cb bw_changed_cb,
410 void *bw_changed_cb_cls,
411 GAS_get_preferences get_preference,
412 void *get_preference_cls);
416 * Change the preference for a peer
418 * @param handle the solver handle
419 * @param client the client sending this request
420 * @param peer the peer id
421 * @param kind the preference kind to change
422 * @param score the new preference score
423 * @param pref_rel the normalized preference value for this kind over all clients
426 (*GAS_solver_address_change_preference) (void *solver,
427 struct GNUNET_CONTAINER_MultiHashMap *addresses,
428 const struct GNUNET_PeerIdentity *peer,
429 enum GNUNET_ATS_PreferenceKind kind,
433 * Add a single address within a network to the solver
435 * @param solver the solver Handle
436 * @param addresses the address hashmap containing all addresses
437 * @param address the address to add
438 * @param network network type of this address
441 (*GAS_solver_address_add) (void *solver,
442 struct GNUNET_CONTAINER_MultiHashMap *addresses,
443 struct ATS_Address *address,
448 * Delete an address or just the session from the solver
450 * @param solver the solver Handle
451 * @param addresses the address hashmap containing all addresses
452 * @param address the address to delete
453 * @param session_only remove address or just session
456 (*GAS_solver_address_delete) (void *solver,
457 struct GNUNET_CONTAINER_MultiHashMap *addresses,
458 struct ATS_Address *address,
462 * Notify the solver about an update for an address
464 * @param solver the solver to use
465 * @param addresses the address hashmap containing all addresses
466 * @param address the address
467 * @param session the previous session
468 * @param in_use previous address used state: yes or no
469 * @param atsi ats previous performance information
470 * @param atsi_count previous number of ats performance information
474 (*GAS_solver_address_update) (void *solver,
475 struct GNUNET_CONTAINER_MultiHashMap *addresses,
476 struct ATS_Address *address,
477 uint32_t prev_session,
479 const struct GNUNET_ATS_Information *prev_atsi,
480 uint32_t prev_atsi_count);
484 * Get the prefered address for a peer from solver
486 * @param solver the solver to use
487 * @param addresses the address hashmap containing all addresses
488 * @param peer the peer
490 typedef const struct ATS_Address *
491 (*GAS_solver_get_preferred_address) (void *solver,
492 struct GNUNET_CONTAINER_MultiHashMap *addresses,
493 const struct GNUNET_PeerIdentity *peer);
497 * Stop getting the prefered address for a peer from solver
499 * @param solver the solver to use
500 * @param addresses the address hashmap containing all addresses
501 * @param peer the peer
504 (*GAS_solver_stop_get_preferred_address) (void *solver,
505 struct GNUNET_CONTAINER_MultiHashMap *addresses,
506 const struct GNUNET_PeerIdentity *peer);
511 * @param solver the solver to shutdown
515 (*GAS_solver_done) (void *solver);
519 * Initialize address subsystem. The addresses subsystem manages the addresses
520 * known and current performance information. It has a solver component
521 * responsible for the resource allocation. It tells the solver about changes
522 * and receives updates when the solver changes the ressource allocation.
524 * @param cfg configuration to use
525 * @param stats the statistics handle to use
526 * @return an address handle
528 struct GAS_Addresses_Handle *
529 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
530 const struct GNUNET_STATISTICS_Handle *stats);
534 * Shutdown address subsystem.
536 * @param handle the address handle to shutdown
539 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
543 * Add a new address for a peer.
545 * @param handle the address handle to use
547 * @param plugin_name transport plugin name
548 * @param plugin_addr plugin address
549 * @param plugin_addr_len length of the plugin address
550 * @param session_id session id, can be 0
551 * @param atsi performance information for this address
552 * @param atsi_count number of performance information contained
555 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
556 const struct GNUNET_PeerIdentity *peer,
557 const char *plugin_name,
558 const void *plugin_addr,
559 size_t plugin_addr_len,
561 const struct GNUNET_ATS_Information *atsi,
562 uint32_t atsi_count);
566 * Notification about active use of an address.
567 * in_use == GNUNET_YES:
568 * This address is used to maintain an active connection with a peer.
569 * in_use == GNUNET_NO:
570 * This address is no longer used to maintain an active connection with a peer.
572 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
575 * @param handle the address handle to use
577 * @param plugin_name transport plugin name
578 * @param plugin_addr plugin address
579 * @param plugin_addr_len length of the plugin address
580 * @param session_id session id, can be 0
581 * @param in_use GNUNET_YES if GNUNET_NO
582 * @return GNUNET_SYSERR on failure (address unknown ...)
585 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
586 const struct GNUNET_PeerIdentity *peer,
587 const char *plugin_name,
588 const void *plugin_addr,
589 size_t plugin_addr_len,
595 * Update an address with a session or performance information for a peer.
597 * If an address was added without a session it will be updated with the
600 * @param handle the address handle to use
602 * @param plugin_name transport plugin name
603 * @param plugin_addr plugin address
604 * @param plugin_addr_len length of the plugin address
605 * @param session_id session id, can be 0
606 * @param atsi performance information for this address
607 * @param atsi_count number of performance information contained
610 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
611 const struct GNUNET_PeerIdentity *peer,
612 const char *plugin_name,
613 const void *plugin_addr,
614 size_t plugin_addr_len,
616 const struct GNUNET_ATS_Information *atsi,
617 uint32_t atsi_count);
621 * Remove an address or just a session for a peer.
623 * @param handle the address handle to use
625 * @param plugin_name transport plugin name
626 * @param plugin_addr plugin address
627 * @param plugin_addr_len length of the plugin address
628 * @param session_id session id, can be 0
631 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
632 const struct GNUNET_PeerIdentity *peer,
633 const char *plugin_name,
634 const void *plugin_addr,
635 size_t plugin_addr_len,
636 uint32_t session_id);
640 * Remove all addresses
642 * @param handle the address handle to use
645 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
649 * Request address suggestions for a peer
651 * @param handle the address handle
652 * @param peer the peer id
655 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
656 const struct GNUNET_PeerIdentity *peer);
659 * Cancel address suggestions for a peer
661 * @param handle the address handle
662 * @param peer the peer id
665 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
666 const struct GNUNET_PeerIdentity *peer);
670 * Reset suggestion backoff for a peer
672 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
673 * reset using this function
675 * @param handle the address handle
676 * @param peer the peer id
679 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
680 const struct GNUNET_PeerIdentity *peer);
684 * Change the preference for a peer
686 * @param handle the address handle
687 * @param client the client sending this request
688 * @param peer the peer id
689 * @param kind the preference kind to change
690 * @param score_abs the new preference score
693 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
695 const struct GNUNET_PeerIdentity *peer,
696 enum GNUNET_ATS_PreferenceKind kind,
701 * Iterator for GAS_addresses_iterate_peers
703 * @param p_it_cls closure
704 * @param id the peer id
706 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
707 const struct GNUNET_PeerIdentity *id);
711 * Return all peers currently known to ATS
713 * @param handle the address handle to use
714 * @param p_it the iterator to call for every peer
715 * @param p_it_cls the closure for the iterator
718 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
719 GNUNET_ATS_Peer_Iterator p_it,
724 * Iterator for GAS_addresses_get_peer_info
726 * @param p_it_cls closure closure
727 * @param id the peer id
728 * @param plugin_name plugin name
729 * @param plugin_addr address
730 * @param plugin_addr_len address length
731 * @param address_active is address actively used
732 * @param atsi ats performance information
733 * @param atsi_count number of ats performance elements
734 * @param bandwidth_out current outbound bandwidth assigned to address
735 * @param bandwidth_in current inbound bandwidth assigned to address
737 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
738 const struct GNUNET_PeerIdentity *id,
739 const char *plugin_name,
740 const void *plugin_addr,
741 size_t plugin_addr_len,
742 const int address_active,
743 const struct GNUNET_ATS_Information *atsi,
745 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
746 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
750 * Return information all peers currently known to ATS
752 * @param handle the address handle to use
753 * @param peer the respective peer
754 * @param pi_it the iterator to call for every peer
755 * @param pi_it_cls the closure for the iterator
758 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
759 const struct GNUNET_PeerIdentity *peer,
760 GNUNET_ATS_PeerInfo_Iterator pi_it,
765 /* end of gnunet-service-ats_addresses.h */