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)
236 * Information provided by ATS normalization
238 struct GAS_NormalizationInfo
241 * Next index to use in averaging queue
243 unsigned int avg_queue_index;
248 uint32_t atsi_abs[GAS_normalization_queue_length];
251 * Averaged ATSI values from queue
256 * Normalized values from queue to a range of values [1.0...2.0]
263 * Address with additional information
268 * Next element in DLL
270 struct ATS_Address *next;
273 * Previous element in DLL
275 struct ATS_Address *prev;
280 struct GNUNET_PeerIdentity peer;
283 * Session ID, 0 if no session is given
303 * Solver specific information for this address
305 void *solver_information;
308 * ATS performance information for this address
310 struct GNUNET_ATS_Information *atsi;
313 * ATS performance information for this address
318 * Inbound bandwidth assigned by solver in NBO
320 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
323 * Outbound bandwidth assigned by solver in NBO
325 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
330 struct GNUNET_TIME_Relative block_interval;
333 * Time when address can be suggested again
335 struct GNUNET_TIME_Absolute blocked_until;
338 * Is this the active address for this peer?
343 * Is this the address for this peer in use?
348 * Normalized ATS performance information for this address
349 * Each entry can be accessed using the GNUNET_ATS_QualityProperties avg_queue_index
351 struct GAS_NormalizationInfo atsin[GNUNET_ATS_QualityPropertiesCount];
356 * Callback to call from solver when bandwidth for address has changed
358 * @param address the with changed bandwidth assigned
361 (*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
365 * Callback to call from solver to obtain application preference values for a
369 * @param id the peer id
370 * @return carry of double values containing the preferences with
371 * GNUNET_ATS_PreferenceCount elements
373 typedef const double *
374 (*GAS_get_preferences) (void *cls, const struct GNUNET_PeerIdentity *id);
378 * Callback to call from solver to obtain transport properties for an
382 * @param address the address
383 * @return carry of double values containing the preferences with
384 * GNUNET_ATS_PreferenceCount elements
386 typedef const double *
387 (*GAS_get_properties) (void *cls, const struct ATS_Address *address);
397 * Init the problem solving component
400 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
401 * out_quota[i] contains outbound quota for network type i
402 * in_quota[i] contains inbound quota for network type i
405 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
406 * network[2] == GNUNET_ATS_NET_LAN
407 * out_quota[2] == 65353
408 * in_quota[2] == 65353
410 * @param cfg configuration handle
411 * @param stats the GNUNET_STATISTICS handle
412 * @param addresses hashmap containing all addresses
413 * @param network array of GNUNET_ATS_NetworkType with length dest_length
414 * @param out_quota array of outbound quotas
415 * @param in_quota array of outbound quota
416 * @param bw_changed_cb callback to call when assigned changes
417 * @return handle for the solver on success, NULL on fail
420 (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
421 const struct GNUNET_STATISTICS_Handle *stats,
422 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
424 unsigned long long *out_quota,
425 unsigned long long *in_quota,
427 GAS_bandwidth_changed_cb bw_changed_cb,
428 void *bw_changed_cb_cls,
429 GAS_get_preferences get_preference,
430 void *get_preference_cls,
431 GAS_get_properties get_properties,
432 void *get_properties_cls);
436 * Change the preference for a peer
438 * @param handle the solver handle
439 * @param client the client sending this request
440 * @param peer the peer id
441 * @param kind the preference kind to change
442 * @param score the new preference score
443 * @param pref_rel the normalized preference value for this kind over all clients
446 (*GAS_solver_address_change_preference) (void *solver,
447 const struct GNUNET_PeerIdentity *peer,
448 enum GNUNET_ATS_PreferenceKind kind,
452 * Notify the solver about a bulk operation changing possibly a lot of values
453 * Solver will not resolve until all bulk operations are marked as done
455 * @param solver the solver
458 (*GAS_solver_bulk_start) (void *solver);
462 * Mark a bulk operation as done
463 * Solver will resolve if values have changed
465 * @param solver the solver
468 (*GAS_solver_bulk_stop) (void *solver);
472 * Add a single address within a network to the solver
474 * @param solver the solver Handle
475 * @param addresses the address hashmap containing all addresses
476 * @param address the address to add
477 * @param network network type of this address
480 (*GAS_solver_address_add) (void *solver,
481 struct ATS_Address *address,
486 * Delete an address or just the session from the solver
488 * @param solver the solver Handle
489 * @param addresses the address hashmap containing all addresses
490 * @param address the address to delete
491 * @param session_only remove address or just session
494 (*GAS_solver_address_delete) (void *solver,
495 struct ATS_Address *address,
500 * Transport properties for this address have changed
502 * @param solver solver handle
503 * @param address the address
504 * @param type the ATSI type in HBO
505 * @param abs_value the absolute value of the property
506 * @param rel_value the normalized value
509 (*GAS_solver_address_property_changed) (void *solver,
510 struct ATS_Address *address,
517 * Transport session for this address has changed
519 * NOTE: values in addresses are already updated
521 * @param solver solver handle
522 * @param address the address
523 * @param cur_session the current session
524 * @param new_session the new session
527 (*GAS_solver_address_session_changed) (void *solver,
528 struct ATS_Address *address,
529 uint32_t cur_session,
530 uint32_t new_session);
533 * Transport session for this address has changed
535 * NOTE: values in addresses are already updated
537 * @param solver solver handle
538 * @param address the address
539 * @param in_use usage state
542 (*GAS_solver_address_inuse_changed) (void *solver,
543 struct ATS_Address *address,
547 * Network scope for this address has changed
549 * NOTE: values in addresses are already updated
551 * @param solver solver handle
552 * @param address the address
553 * @param current_network the current network
554 * @param new_network the new network
557 (*GAS_solver_address_network_changed) (void *solver,
558 struct ATS_Address *address,
559 uint32_t current_network,
560 uint32_t new_network);
564 * Get the prefered address for a peer from solver
566 * @param solver the solver to use
567 * @param addresses the address hashmap containing all addresses
568 * @param peer the peer
570 typedef const struct ATS_Address *
571 (*GAS_solver_get_preferred_address) (void *solver,
572 const struct GNUNET_PeerIdentity *peer);
576 * Stop getting the prefered address for a peer from solver
578 * @param solver the solver to use
579 * @param addresses the address hashmap containing all addresses
580 * @param peer the peer
583 (*GAS_solver_stop_get_preferred_address) (void *solver,
584 const struct GNUNET_PeerIdentity *peer);
589 * @param solver the solver to shutdown
593 (*GAS_solver_done) (void *solver);
597 * Initialize address subsystem. The addresses subsystem manages the addresses
598 * known and current performance information. It has a solver component
599 * responsible for the resource allocation. It tells the solver about changes
600 * and receives updates when the solver changes the ressource allocation.
602 * @param cfg configuration to use
603 * @param stats the statistics handle to use
604 * @return an address handle
606 struct GAS_Addresses_Handle *
607 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
608 const struct GNUNET_STATISTICS_Handle *stats);
612 * Shutdown address subsystem.
614 * @param handle the address handle to shutdown
617 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
621 * Add a new address 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
629 * @param atsi performance information for this address
630 * @param atsi_count number of performance information contained
633 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
634 const struct GNUNET_PeerIdentity *peer,
635 const char *plugin_name,
636 const void *plugin_addr,
637 size_t plugin_addr_len,
639 const struct GNUNET_ATS_Information *atsi,
640 uint32_t atsi_count);
644 * Notification about active use of an address.
645 * in_use == GNUNET_YES:
646 * This address is used to maintain an active connection with a peer.
647 * in_use == GNUNET_NO:
648 * This address is no longer used to maintain an active connection with a peer.
650 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
653 * @param handle the address handle to use
655 * @param plugin_name transport plugin name
656 * @param plugin_addr plugin address
657 * @param plugin_addr_len length of the plugin address
658 * @param session_id session id, can be 0
659 * @param in_use GNUNET_YES if GNUNET_NO
660 * @return GNUNET_SYSERR on failure (address unknown ...)
663 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
664 const struct GNUNET_PeerIdentity *peer,
665 const char *plugin_name,
666 const void *plugin_addr,
667 size_t plugin_addr_len,
673 * Update an address with a session or performance information for a peer.
675 * If an address was added without a session it will be updated with the
678 * @param handle the address handle to use
680 * @param plugin_name transport plugin name
681 * @param plugin_addr plugin address
682 * @param plugin_addr_len length of the plugin address
683 * @param session_id session id, can be 0
684 * @param atsi performance information for this address
685 * @param atsi_count number of performance information contained
688 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
689 const struct GNUNET_PeerIdentity *peer,
690 const char *plugin_name,
691 const void *plugin_addr,
692 size_t plugin_addr_len,
694 const struct GNUNET_ATS_Information *atsi,
695 uint32_t atsi_count);
699 * Remove an address or just a session for a peer.
701 * @param handle the address handle to use
703 * @param plugin_name transport plugin name
704 * @param plugin_addr plugin address
705 * @param plugin_addr_len length of the plugin address
706 * @param session_id session id, can be 0
709 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
710 const struct GNUNET_PeerIdentity *peer,
711 const char *plugin_name,
712 const void *plugin_addr,
713 size_t plugin_addr_len,
714 uint32_t session_id);
718 * Remove all addresses
720 * @param handle the address handle to use
723 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
727 * Request address suggestions for a peer
729 * @param handle the address handle
730 * @param peer the peer id
733 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
734 const struct GNUNET_PeerIdentity *peer);
737 * Cancel address suggestions for a peer
739 * @param handle the address handle
740 * @param peer the peer id
743 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
744 const struct GNUNET_PeerIdentity *peer);
748 * Reset suggestion backoff for a peer
750 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
751 * reset using this function
753 * @param handle the address handle
754 * @param peer the peer id
757 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
758 const struct GNUNET_PeerIdentity *peer);
762 * Change the preference for a peer
764 * @param handle the address handle
765 * @param client the client sending this request
766 * @param peer the peer id
767 * @param kind the preference kind to change
768 * @param score_abs the new preference score
771 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
773 const struct GNUNET_PeerIdentity *peer,
774 enum GNUNET_ATS_PreferenceKind kind,
779 * Iterator for GAS_addresses_iterate_peers
781 * @param p_it_cls closure
782 * @param id the peer id
784 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
785 const struct GNUNET_PeerIdentity *id);
789 * Return all peers currently known to ATS
791 * @param handle the address handle to use
792 * @param p_it the iterator to call for every peer
793 * @param p_it_cls the closure for the iterator
796 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
797 GNUNET_ATS_Peer_Iterator p_it,
802 * Iterator for GAS_addresses_get_peer_info
804 * @param p_it_cls closure closure
805 * @param id the peer id
806 * @param plugin_name plugin name
807 * @param plugin_addr address
808 * @param plugin_addr_len address length
809 * @param address_active is address actively used
810 * @param atsi ats performance information
811 * @param atsi_count number of ats performance elements
812 * @param bandwidth_out current outbound bandwidth assigned to address
813 * @param bandwidth_in current inbound bandwidth assigned to address
815 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
816 const struct GNUNET_PeerIdentity *id,
817 const char *plugin_name,
818 const void *plugin_addr,
819 size_t plugin_addr_len,
820 const int address_active,
821 const struct GNUNET_ATS_Information *atsi,
823 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
824 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
828 * Return information all peers currently known to ATS
830 * @param handle the address handle to use
831 * @param peer the respective peer
832 * @param pi_it the iterator to call for every peer
833 * @param pi_it_cls the closure for the iterator
836 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
837 const struct GNUNET_PeerIdentity *peer,
838 GNUNET_ATS_PeerInfo_Iterator pi_it,
843 /* end of gnunet-service-ats_addresses.h */