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_statistics_service.h"
36 * NOTE: Do not change this documentation. This documentation is based on
37 * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
38 * use build_txt.sh to generate plaintext output
40 * 1 ATS addresses : ATS address management
42 * This ATS addresses ("addresses") component manages the addresses known to
43 * ATS service and suggests addresses to transport service when it is
44 * interested in address suggestion for a peer. ATS addresses also
45 * instantiates the bandwidth assignment mechanism (solver), notifies it
46 * about changes to addresses and forwards changes to bandwidth assignments
47 * to transport, depending if transport is interested in this change.
53 * Addresses are added by specifying peer ID, plugin, address, address length
54 * and session, if available. ATS information can be specified if available.
58 * ATS specifies a fix set of networks an address can belong to. For each
59 * network an inbound and outbound quota will be specified. The available
60 * networks and addtional helper varaibles are defined in
61 * gnunet_ats_service.h. At the moment 5 networks are defined:
62 * * GNUNET_ATS_NET_UNSPECIFIED
63 * * GNUNET_ATS_NET_LOOPBACK
64 * * GNUNET_ATS_NET_LAN
65 * * GNUNET_ATS_NET_WAN
66 * * GNUNET_ATS_NET_WLAN
68 * The total number of networks defined is stored in
69 * GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
70 * initializer for an int array, while GNUNET_ATS_NetworkType is an
71 * initializer for a char array containing a string description of all
76 * An inbound and outbound quota for each of the networks mentioned in 1.1.2
77 * is loaded from ats configuration during initialization. This quota defines
78 * to total amount of inbound and outbound traffic allowed for a specific
79 * network. The configuration values used are in section ats:
80 * * "NETWORK"_QUOTA_IN = <value>
81 * * "NETWORK"_QUOTA_IN = <value>
83 * You can specify quotas by setting the <value> to a:
84 * * unrestricted: unlimited
85 * * number of bytes: e.g. 10240
86 * * fancy value: e.g. 64 Kib
88 * unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
89 * the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
91 * * GNUNET_ATS_DefaultBandwidth: 65536
92 * * GNUNET_ATS_MaxBandwidth: UINT32_MAX
93 * * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
95 * Details of loading quotas and default values will be described on
97 * 1.1.4 Preference values
99 * 1.2 Data structures used
101 * Addresse uses struct ATS_Address for each address. The structs are stored
102 * in a linked list and provides a pointer void *solver_information for the
103 * solver to store address specific information. It provides the int values
104 * active which is set to GNUNET_YES if the address is select for transport
105 * use and used, representing that transport service is actively using this
106 * address. Address information are stored in peer, addr, addr_len, plugin.
110 * During initialization a hashmap to store addresses is created. The quotas
111 * for all networks defined for ATS are loaded from configuration. For each
112 * network first the logic will check if the string
113 * GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
114 * the configured value as a fancy size and if this fails it will try to use
115 * it as a value_number. If no configuration value is found it will assign
116 * GNUNET_ATS_DefaultBandwidth. The most important step is to load the
117 * configured solver using configuration "[ats]:MODE". Current solvers are
118 * MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
123 * * s_init: init the solver with required information
124 * * s_add: add a new address
125 * * s_update: update ATS values or session for an address
126 * * s_get: get prefered address for a peer
127 * * s_del: delete an address
128 * * s_pref: change preference value for a peer
129 * * s_done: shutdown solver
131 * Callbacks: addresses provides a bandwidth_changed_cb callback to the
132 * solver which is called when bandwidth assigned to peer has changed
136 * During shutdown all addresses are freed and the solver told to shutdown
138 * 1.6 Addresses and sessions
140 * Addresses consist of the address itself and a numerical session. When a
141 * new address without a session is added it has no session, so it gets
142 * session 0 assigned. When an address with a session is added and an address
143 * object with session 0 is found, this object is updated with the session
144 * otherwise a new address object with this session assigned is created.
148 * Addresses a1,a2 with session s1, s2 are "exact" if:
149 * (a1 == a2)&&(s1 == s2)
150 * Addresses a1,a2 with session s1, s2 are "equivalent" if:
151 * (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
153 * 1.7 Address management
155 * Transport service notifies ATS about changes to the addresses known to
158 * 1.7.1 Adding an address
160 * When transport learns a new address it tells ATS and ATS is telling
161 * addresses about it using GAS_address_add. If not known to addresses it
162 * creates a new address object and calls solver's s_add. ATS information are
163 * deserialized and solver is notified about the session and ATS information
166 * 1.7.2 Updating an address
168 * Addresses does an lookup up for the existing address with the given
169 * session. If disassembles included ATS information and notifies the solver
170 * using s_update about the update.
172 * 1.7.3 Deleting an address
174 * Addresses does an lookup for the exact address and session and if removes
175 * this address. If session != 0 the session is set to 0 and the address is
176 * kept. If session == 0, the addresses is removed.
178 * 1.7.4 Requesting an address suggestion
180 * The address client issues a request address message to be notified about
181 * address suggestions for a specific peer. Addresses asks the solver with
182 * s_get. If no address is available, it will not send a response, otherwise
183 * it will respond with the choosen address.
185 * 1.7.5 Address suggestions
187 * Addresses will notify the client automatically on any bandwidth_changed_cb
188 * by the solver if a address suggestion request is pending. If no address is
189 * available it will not respond at all If the client is not interested
190 * anymore, it has to cancel the address suggestion request.
192 * 1.7.6 Suggestions blocks and reset
194 * After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
195 * prevent the client from being thrashed. If the client requires immediately
196 * it can reset this block using GAS_addresses_handle_backoff_reset.
198 * 1.7.7 Marking address in use
200 * The client can notify addresses that it successfully uses an address and
201 * wants this address to be kept by calling GSA_address_in_use. Adresses will
202 * mark the address as used an notify the solver about the use.
204 * 1.7.8 Address lifecycle
207 * * (updated address) || (address in use)
210 * 1.8 Bandwidth assignment
212 * The addresses are used to perform resource allocation operations. ATS
213 * addresses takes care of instantiating the solver configured and notifies
214 * the respective solver about address changes and receives changes to the
215 * bandwidth assignment from the solver. The current bandwidth assignment is
216 * sent to transport. The specific solvers will be described in the specific
219 * 1.9 Changing peer preferences
221 * The bandwidth assigned to a peer can be influenced by setting a preference
222 * for a peer. The prefernce will be given to to the solver with s_pref which
223 * 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)
233 struct GAS_Addresses_Handle;
236 * Address with additional information
241 * Next element in DLL
243 struct ATS_Address *next;
246 * Previous element in DLL
248 struct ATS_Address *prev;
253 struct GNUNET_PeerIdentity peer;
256 * Session ID, 0 if no session is given
276 * Solver specific information for this address
278 void *solver_information;
281 * ATS performance information for this address
283 struct GNUNET_ATS_Information *atsi;
286 * ATS performance information for this address
292 struct GNUNET_TIME_Relative atsp_latency;
295 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
298 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
302 uint32_t atsp_distance;
305 uint32_t atsp_cost_wan;
308 uint32_t atsp_cost_lan;
311 uint32_t atsp_cost_wlan;
314 uint32_t atsp_network_type;
317 * Inbound bandwidth assigned by solver in NBO
319 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
322 * Outbound bandwidth assigned by solver in NBO
324 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
329 struct GNUNET_TIME_Relative block_interval;
332 * Time when address can be suggested again
334 struct GNUNET_TIME_Absolute blocked_until;
337 * Is this the active address for this peer?
342 * Is this the address for this peer in use?
349 * Callback to call from solver when bandwidth for address has changed
351 * @param address the with changed bandwidth assigned
355 (*GAS_bandwidth_changed_cb) (void *cls, struct ATS_Address *address);
363 * Init the simplistic problem solving component
366 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
367 * out_quota[i] contains outbound quota for network type i
368 * in_quota[i] contains inbound quota for network type i
371 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
372 * network[2] == GNUNET_ATS_NET_LAN
373 * out_quota[2] == 65353
374 * in_quota[2] == 65353
376 * @param cfg configuration handle
377 * @param stats the GNUNET_STATISTICS handle
378 * @param network array of GNUNET_ATS_NetworkType with length dest_length
379 * @param out_quota array of outbound quotas
380 * @param in_quota array of outbound quota
381 * @param bw_changed_cb callback to call when assigned changes
382 * @return handle for the solver on success, NULL on fail
385 (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
386 const struct GNUNET_STATISTICS_Handle *stats,
388 unsigned long long *out_quota,
389 unsigned long long *in_quota,
391 GAS_bandwidth_changed_cb bw_changed_cb,
392 void *bw_changed_cb_cls);
396 * Change the preference for a peer
398 * @param handle the solver handle
399 * @param client the client sending this request
400 * @param peer the peer id
401 * @param kind the preference kind to change
402 * @param score the new preference score
405 (*GAS_solver_address_change_preference) (void *solver,
407 const struct GNUNET_PeerIdentity *peer,
408 enum GNUNET_ATS_PreferenceKind kind,
413 * Add a single address within a network to the solver
415 * @param solver the solver Handle
416 * @param addresses the address hashmap containing all addresses
417 * @param address the address to add
418 * @param network network type of this address
421 (*GAS_solver_address_add) (void *solver,
422 struct GNUNET_CONTAINER_MultiHashMap *addresses,
423 struct ATS_Address *address,
428 * Delete an address or just the session from the solver
430 * @param solver the solver Handle
431 * @param addresses the address hashmap containing all addresses
432 * @param address the address to delete
433 * @param session_only remove address or just session
436 (*GAS_solver_address_delete) (void *solver,
437 struct GNUNET_CONTAINER_MultiHashMap *addresses,
438 struct ATS_Address *address,
442 * Notify the solver about an update for an address
444 * @param solver the solver to use
445 * @param addresses the address hashmap containing all addresses
446 * @param address the address
447 * @param session the session
448 * @param in_use address used: yes or no
449 * @param atsi ats performance information
450 * @param atsi_count number of ats performance information
454 (*GAS_solver_address_update) (void *solver,
455 struct GNUNET_CONTAINER_MultiHashMap *addresses,
456 struct ATS_Address *address,
459 const struct GNUNET_ATS_Information *atsi,
460 uint32_t atsi_count);
464 * Get the prefered address for a peer from solver
466 * @param solver the solver to use
467 * @param addresses the address hashmap containing all addresses
468 * @param peer the peer
470 typedef const struct ATS_Address *
471 (*GAS_solver_get_preferred_address) (void *solver,
472 struct GNUNET_CONTAINER_MultiHashMap *addresses,
473 const struct GNUNET_PeerIdentity *peer);
477 * Stop getting the prefered address for a peer from solver
479 * @param solver the solver to use
480 * @param addresses the address hashmap containing all addresses
481 * @param peer the peer
484 (*GAS_solver_stop_get_preferred_address) (void *solver,
485 struct GNUNET_CONTAINER_MultiHashMap *addresses,
486 const struct GNUNET_PeerIdentity *peer);
491 * @param solver the solver to shutdown
495 (*GAS_solver_done) (void *solver);
499 * Initialize address subsystem. The addresses subsystem manages the addresses
500 * known and current performance information. It has a solver component
501 * responsible for the resource allocation. It tells the solver about changes
502 * and receives updates when the solver changes the ressource allocation.
504 * @param cfg configuration to use
505 * @param stats the statistics handle to use
506 * @return an address handle
508 struct GAS_Addresses_Handle *
509 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
510 const struct GNUNET_STATISTICS_Handle *stats);
514 * Shutdown address subsystem.
516 * @param handle the address handle to shutdown
519 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
523 * Add a new address for a peer.
525 * @param handle the address handle to use
527 * @param plugin_name transport plugin name
528 * @param plugin_addr plugin address
529 * @param plugin_addr_len length of the plugin address
530 * @param session_id session id, can be 0
531 * @param atsi performance information for this address
532 * @param atsi_count number of performance information contained
535 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
536 const struct GNUNET_PeerIdentity *peer,
537 const char *plugin_name,
538 const void *plugin_addr,
539 size_t plugin_addr_len,
541 const struct GNUNET_ATS_Information *atsi,
542 uint32_t atsi_count);
546 * Notification about active use of an address.
547 * in_use == GNUNET_YES:
548 * This address is used to maintain an active connection with a peer.
549 * in_use == GNUNET_NO:
550 * This address is no longer used to maintain an active connection with a peer.
552 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
555 * @param handle the address handle to use
557 * @param plugin_name transport plugin name
558 * @param plugin_addr plugin address
559 * @param plugin_addr_len length of the plugin address
560 * @param session_id session id, can be 0
561 * @param in_use GNUNET_YES if GNUNET_NO
562 * @return GNUNET_SYSERR on failure (address unknown ...)
565 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
566 const struct GNUNET_PeerIdentity *peer,
567 const char *plugin_name,
568 const void *plugin_addr,
569 size_t plugin_addr_len,
575 * Update an address with a session or performance information for a peer.
577 * If an address was added without a session it will be updated with the
580 * @param handle the address handle to use
582 * @param plugin_name transport plugin name
583 * @param plugin_addr plugin address
584 * @param plugin_addr_len length of the plugin address
585 * @param session_id session id, can be 0
586 * @param atsi performance information for this address
587 * @param atsi_count number of performance information contained
590 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
591 const struct GNUNET_PeerIdentity *peer,
592 const char *plugin_name,
593 const void *plugin_addr,
594 size_t plugin_addr_len,
596 const struct GNUNET_ATS_Information *atsi,
597 uint32_t atsi_count);
601 * Remove an address or just a session for a peer.
603 * @param handle the address handle to use
605 * @param plugin_name transport plugin name
606 * @param plugin_addr plugin address
607 * @param plugin_addr_len length of the plugin address
608 * @param session_id session id, can be 0
611 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
612 const struct GNUNET_PeerIdentity *peer,
613 const char *plugin_name,
614 const void *plugin_addr,
615 size_t plugin_addr_len,
616 uint32_t session_id);
620 * Remove all addresses
622 * @param handle the address handle to use
625 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
629 * Request address suggestions for a peer
631 * @param handle the address handle
632 * @param peer the peer id
635 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
636 const struct GNUNET_PeerIdentity *peer);
639 * Cancel address suggestions for a peer
641 * @param handle the address handle
642 * @param peer the peer id
645 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
646 const struct GNUNET_PeerIdentity *peer);
650 * Reset suggestion backoff for a peer
652 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
653 * reset using this function
655 * @param handle the address handle
656 * @param peer the peer id
659 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
660 const struct GNUNET_PeerIdentity *peer);
664 * Change the preference for a peer
666 * @param handle the address handle
667 * @param client the client sending this request
668 * @param peer the peer id
669 * @param kind the preference kind to change
670 * @param score the new preference score
673 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
675 const struct GNUNET_PeerIdentity *peer,
676 enum GNUNET_ATS_PreferenceKind kind,
681 * Iterator for GAS_addresses_iterate_peers
683 * @param p_it_cls closure
684 * @param id the peer id
686 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
687 const struct GNUNET_PeerIdentity *id);
691 * Return all peers currently known to ATS
693 * @param handle the address handle to use
694 * @param p_it the iterator to call for every peer
695 * @param p_it_cls the closure for the iterator
698 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
699 GNUNET_ATS_Peer_Iterator p_it,
704 * Iterator for GAS_addresses_get_peer_info
706 * @param p_it_cls closure closure
707 * @param id the peer id
708 * @param plugin_name plugin name
709 * @param plugin_addr address
710 * @param plugin_addr_len address length
711 * @param address_active is address actively used
712 * @param atsi ats performance information
713 * @param atsi_count number of ats performance elements
714 * @param bandwidth_out current outbound bandwidth assigned to address
715 * @param bandwidth_in current inbound bandwidth assigned to address
717 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
718 const struct GNUNET_PeerIdentity *id,
719 const char *plugin_name,
720 const void *plugin_addr,
721 size_t plugin_addr_len,
722 const int address_active,
723 const struct GNUNET_ATS_Information *atsi,
725 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
726 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
730 * Return information all peers currently known to ATS
732 * @param handle the address handle to use
733 * @param peer the respective peer
734 * @param pi_it the iterator to call for every peer
735 * @param pi_it_cls the closure for the iterator
738 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
739 const struct GNUNET_PeerIdentity *peer,
740 GNUNET_ATS_PeerInfo_Iterator pi_it,
745 /* end of gnunet-service-ats_addresses.h */