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.c
23 * @brief ats service address management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_ats_service.h"
29 #include "gnunet-service-ats.h"
30 #include "gnunet-service-ats_addresses.h"
31 #include "gnunet-service-ats_normalization.h"
32 #include "gnunet-service-ats_performance.h"
33 #include "gnunet-service-ats_scheduling.h"
34 #include "gnunet-service-ats_reservations.h"
36 #include "gnunet-service-ats-solver_mlp.h"
38 #include "gnunet-service-ats-solver_proportional.h"
41 * NOTE: Do not change this documentation. This documentation is based on
42 * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
43 * use build_txt.sh to generate plaintext output
45 * 1 ATS addresses : ATS address management
47 * This ATS addresses ("addresses") component manages the addresses known to
48 * ATS service and suggests addresses to transport service when it is
49 * interested in address suggestion for a peer. ATS addresses also
50 * instantiates the bandwidth assignment mechanism (solver), notifies it
51 * about changes to addresses and forwards changes to bandwidth assignments
52 * to transport, depending if transport is interested in this change.
58 * Addresses are added by specifying peer ID, plugin, address, address length
59 * and session, if available. ATS information can be specified if available.
63 * ATS specifies a fix set of networks an address can belong to. For each
64 * network an inbound and outbound quota will be specified. The available
65 * networks and addtional helper varaibles are defined in
66 * gnunet_ats_service.h. At the moment 5 networks are defined:
67 * * GNUNET_ATS_NET_UNSPECIFIED
68 * * GNUNET_ATS_NET_LOOPBACK
69 * * GNUNET_ATS_NET_LAN
70 * * GNUNET_ATS_NET_WAN
71 * * GNUNET_ATS_NET_WLAN
73 * The total number of networks defined is stored in
74 * GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
75 * initializer for an int array, while GNUNET_ATS_NetworkType is an
76 * initializer for a char array containing a string description of all
81 * An inbound and outbound quota for each of the networks mentioned in 1.1.2
82 * is loaded from ats configuration during initialization. This quota defines
83 * to total amount of inbound and outbound traffic allowed for a specific
84 * network. The configuration values used are in section ats:
85 * * "NETWORK"_QUOTA_IN = <value>
86 * * "NETWORK"_QUOTA_IN = <value>
88 * You can specify quotas by setting the <value> to a:
89 * * unrestricted: unlimited
90 * * number of bytes: e.g. 10240
91 * * fancy value: e.g. 64 Kib
93 * unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
94 * the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
96 * * GNUNET_ATS_DefaultBandwidth: 65536
97 * * GNUNET_ATS_MaxBandwidth: UINT32_MAX
98 * * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
100 * Details of loading quotas and default values will be described on
102 * 1.1.4 Preference values
104 * 1.2 Data structures used
106 * Addresse uses struct ATS_Address for each address. The structs are stored
107 * in a linked list and provides a pointer void *solver_information for the
108 * solver to store address specific information. It provides the int values
109 * active which is set to GNUNET_YES if the address is select for transport
110 * use and used, representing that transport service is actively using this
111 * address. Address information are stored in peer, addr, addr_len, plugin.
115 * During initialization a hashmap to store addresses is created. The quotas
116 * for all networks defined for ATS are loaded from configuration. For each
117 * network first the logic will check if the string
118 * GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
119 * the configured value as a fancy size and if this fails it will try to use
120 * it as a value_number. If no configuration value is found it will assign
121 * GNUNET_ATS_DefaultBandwidth. The most important step is to load the
122 * configured solver using configuration "[ats]:MODE". Current solvers are
123 * MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
128 * * s_init: init the solver with required information
129 * * s_add: add a new address
130 * * s_update: update ATS values or session for an address
131 * * s_get: get prefered address for a peer
132 * * s_del: delete an address
133 * * s_pref: change preference value for a peer
134 * * s_done: shutdown solver
136 * Callbacks: addresses provides a bandwidth_changed_cb callback to the
137 * solver which is called when bandwidth assigned to peer has changed
141 * During shutdown all addresses are freed and the solver told to shutdown
143 * 1.6 Addresses and sessions
145 * Addresses consist of the address itself and a numerical session. When a
146 * new address without a session is added it has no session, so it gets
147 * session 0 assigned. When an address with a session is added and an address
148 * object with session 0 is found, this object is updated with the session
149 * otherwise a new address object with this session assigned is created.
153 * Addresses a1,a2 with session s1, s2 are "exact" if:
154 * (a1 == a2)&&(s1 == s2)
155 * Addresses a1,a2 with session s1, s2 are "equivalent" if:
156 * (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
158 * 1.7 Address management
160 * Transport service notifies ATS about changes to the addresses known to
163 * 1.7.1 Adding an address
165 * When transport learns a new address it tells ATS and ATS is telling
166 * addresses about it using GAS_address_add. If not known to addresses it
167 * creates a new address object and calls solver's s_add. ATS information are
168 * deserialized and solver is notified about the session and ATS information
171 * 1.7.2 Updating an address
173 * Addresses does an lookup up for the existing address with the given
174 * session. If disassembles included ATS information and notifies the solver
175 * using s_update about the update.
177 * 1.7.3 Deleting an address
179 * Addresses does an lookup for the exact address and session and if removes
180 * this address. If session != 0 the session is set to 0 and the address is
181 * kept. If session == 0, the addresses is removed.
183 * 1.7.4 Requesting an address suggestion
185 * The address client issues a request address message to be notified about
186 * address suggestions for a specific peer. Addresses asks the solver with
187 * s_get. If no address is available, it will not send a response, otherwise
188 * it will respond with the choosen address.
190 * 1.7.5 Address suggestions
192 * Addresses will notify the client automatically on any bandwidth_changed_cb
193 * by the solver if a address suggestion request is pending. If no address is
194 * available it will not respond at all If the client is not interested
195 * anymore, it has to cancel the address suggestion request.
197 * 1.7.6 Suggestions blocks and reset
199 * After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
200 * prevent the client from being thrashed. If the client requires immediately
201 * it can reset this block using GAS_addresses_handle_backoff_reset.
203 * 1.7.7 Marking address in use
205 * The client can notify addresses that it successfully uses an address and
206 * wants this address to be kept by calling GSA_address_in_use. Adresses will
207 * mark the address as used an notify the solver about the use.
209 * 1.7.8 Address lifecycle
212 * * (updated address) || (address in use)
215 * 1.8 Bandwidth assignment
217 * The addresses are used to perform resource allocation operations. ATS
218 * addresses takes care of instantiating the solver configured and notifies
219 * the respective solver about address changes and receives changes to the
220 * bandwidth assignment from the solver. The current bandwidth assignment is
221 * sent to transport. The specific solvers will be described in the specific
224 * 1.9 Changing peer preferences
226 * The bandwidth assigned to a peer can be influenced by setting a preference
227 * for a peer. The prefernce will be given to to the solver with s_pref which
228 * has to take care of the preference value
234 * Available ressource assignment modes
241 * Assign each peer an equal amount of bandwidth (bw)
243 * bw_per_peer = bw_total / #active addresses
250 * Solve ressource assignment as an optimization problem
251 * Uses an mixed integer programming solver
258 * Pending Address suggestion requests
260 struct GAS_Addresses_Suggestion_Requests
265 struct GAS_Addresses_Suggestion_Requests *next;
270 struct GAS_Addresses_Suggestion_Requests *prev;
275 struct GNUNET_PeerIdentity id;
280 * Handle for ATS address component
282 struct GAS_Addresses_Handle
287 struct GNUNET_STATISTICS_Handle *stat;
290 * A multihashmap to store all addresses
292 struct GNUNET_CONTAINER_MultiHashMap *addresses;
295 * Configure WAN quota in
297 unsigned long long wan_quota_in;
300 * Configure WAN quota out
302 unsigned long long wan_quota_out;
305 * Is ATS addresses running
310 * Configured ATS solver
320 * Address suggestion requests DLL head
322 struct GAS_Addresses_Suggestion_Requests *r_head;
325 * Address suggestion requests DLL tail
327 struct GAS_Addresses_Suggestion_Requests *r_tail;
329 /* Solver functions */
334 GAS_solver_init s_init;
337 * Add an address to the solver
339 GAS_solver_address_add s_add;
342 GAS_solver_address_property_changed s_address_update_property;
344 GAS_solver_address_session_changed s_address_update_session;
346 GAS_solver_address_inuse_changed s_address_update_inuse;
348 GAS_solver_address_network_changed s_address_update_network;
351 * Get address from solver
353 GAS_solver_get_preferred_address s_get;
356 * Get address from solver
358 GAS_solver_stop_get_preferred_address s_get_stop;
361 * Delete address in solver
363 GAS_solver_address_delete s_del;
366 * Change relative preference for quality in solver
368 GAS_solver_address_change_preference s_pref;
371 * Give feedback about the current assignment
373 GAS_solver_address_feedback_preference s_feedback;
376 * Start a bulk operation
378 GAS_solver_bulk_start s_bulk_start;
381 * Bulk operation done
383 GAS_solver_bulk_stop s_bulk_stop;
388 GAS_solver_done s_done;
393 * Disassemble ATS information and update performance information in address
395 * Updates existing information and adds new information
397 * @param dest destination address
398 * @param update source ATS information
399 * @param update_count number of ATS information
400 * @param delta_dest ats performance information which were updated
401 * including previous value
402 * @param delta_count number of ATS information in the delta
403 * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
406 disassemble_ats_information (struct ATS_Address *dest,
407 const struct GNUNET_ATS_Information *update,
408 uint32_t update_count,
409 struct GNUNET_ATS_Information **delta_dest,
410 uint32_t *delta_count)
418 struct GNUNET_ATS_Information add_atsi[update_count];
419 struct GNUNET_ATS_Information delta_atsi[update_count];
420 struct GNUNET_ATS_Information *tmp_atsi;
421 uint32_t add_atsi_count;
422 uint32_t delta_atsi_count;
426 delta_atsi_count = 0;
428 if (0 == update_count)
431 if (NULL == dest->atsi)
433 /* Create performance information */
434 dest->atsi = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
435 dest->atsi_count = update_count;
436 memcpy (dest->atsi, update, update_count * sizeof (struct GNUNET_ATS_Information));
437 (*delta_dest) = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
438 for (c1 = 0; c1 < update_count; c1 ++)
440 (*delta_dest)[c1].type = update[c1].type;
441 (*delta_dest)[c1].value = htonl(GNUNET_ATS_VALUE_UNDEFINED);
443 (*delta_count) = update_count;
447 for (c1 = 0; c1 < update_count; c1++)
449 /* Update existing performance information */
451 for (c2 = 0; c2 < dest->atsi_count; c2++)
453 if (update[c1].type == dest->atsi[c2].type)
455 if (update[c1].value != dest->atsi[c2].value)
457 /* Save previous value in delta */
458 delta_atsi[delta_atsi_count] = dest->atsi[c2];
461 dest->atsi[c2].value = update[c1].value;
468 if (GNUNET_NO == found)
470 add_atsi[add_atsi_count] = update[c1];
472 delta_atsi[delta_atsi_count].type = update[c1].type;
473 delta_atsi[delta_atsi_count].value = htonl (GNUNET_ATS_VALUE_UNDEFINED);
478 if (add_atsi_count > 0)
480 /* Extend ats performance information */
482 tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
483 (sizeof (struct GNUNET_ATS_Information)));
484 memcpy (tmp_atsi, dest->atsi, dest->atsi_count * sizeof (struct GNUNET_ATS_Information));
485 memcpy (&tmp_atsi[dest->atsi_count], add_atsi, add_atsi_count * sizeof (struct GNUNET_ATS_Information));
486 GNUNET_free (dest->atsi);
487 dest->atsi = tmp_atsi;
488 dest->atsi_count = dest->atsi_count + add_atsi_count;
492 if (delta_atsi_count > 0)
495 (*delta_dest) = GNUNET_malloc (delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
496 memcpy ((*delta_dest), delta_atsi, delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
497 (*delta_count) = delta_atsi_count;
504 * Free the given address
506 * @param addr address to destroy
509 free_address (struct ATS_Address *addr)
511 GNUNET_free (addr->plugin);
512 GNUNET_free_non_null (addr->atsi);
517 * Create a ATS_address with the given information
520 * @param plugin_name plugin
521 * @param plugin_addr address
522 * @param plugin_addr_len address length
523 * @param session_id session
524 * @return the ATS_Address
526 static struct ATS_Address *
527 create_address (const struct GNUNET_PeerIdentity *peer,
528 const char *plugin_name,
529 const void *plugin_addr, size_t plugin_addr_len,
532 struct ATS_Address *aa = NULL;
536 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
538 aa->addr_len = plugin_addr_len;
540 memcpy (&aa[1], plugin_addr, plugin_addr_len);
541 aa->plugin = GNUNET_strdup (plugin_name);
542 aa->session_id = session_id;
543 aa->active = GNUNET_NO;
544 aa->used = GNUNET_NO;
545 aa->solver_information = NULL;
548 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
549 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
551 for (c1 = 0; c1 < GNUNET_ATS_QualityPropertiesCount; c1 ++)
553 aa->atsin[c1].avg_queue_index = 0;
554 for (c2 = 0; c2 < GAS_normalization_queue_length; c2++)
555 aa->atsin[c1].atsi_abs[c2] = GNUNET_ATS_VALUE_UNDEFINED;
562 struct CompareAddressContext
564 const struct ATS_Address *search;
566 /* exact_address != NULL if address and session is equal */
567 struct ATS_Address *exact_address;
568 /* exact_address != NULL if address and session is 0 */
569 struct ATS_Address *base_address;
575 * @param cls a CompareAddressContext containin the source address
577 * @param value the address to compare with
578 * @return GNUNET_YES to continue, GNUNET_NO if address is founce
582 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
584 struct CompareAddressContext *cac = cls;
585 struct ATS_Address *aa = value;
587 /* Find an matching exact address:
590 * aa->addr_len == cac->search->addr_len
591 * aa->plugin == cac->search->plugin
592 * aa->addr == cac->search->addr
593 * aa->session == cac->search->session
595 * return as exact address
597 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
599 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
600 cac->exact_address = aa;
603 /* Find an matching base address:
607 * aa->session_id == 0
610 * aa->addr_len == cac->search->addr_len
611 * aa->plugin == cac->search->plugin
612 * aa->addr == cac->search->addr
614 * return as base address
616 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
618 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
619 cac->base_address = aa;
622 /* Find an matching exact address based on session:
626 * cac->search->addr_len == 0
629 * aa->plugin == cac->search->plugin
630 * aa->session_id == cac->search->session_id
632 * return as exact address
634 if (0 == cac->search->addr_len)
636 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
637 cac->exact_address = aa;
640 if (cac->exact_address == NULL)
641 return GNUNET_YES; /* Continue iteration to find exact address */
643 return GNUNET_NO; /* Stop iteration since we have an exact address */
648 * Find an existing equivalent address record.
649 * Compares by peer identity and network address OR by session ID
650 * (one of the two must match).
652 * @param handle the address handle
653 * @param peer peer to lookup addresses for
654 * @param addr existing address record
655 * @return existing address record, NULL for none
658 find_equivalent_address (struct GAS_Addresses_Handle *handle,
659 const struct GNUNET_PeerIdentity *peer,
660 const struct ATS_Address *addr)
662 struct CompareAddressContext cac;
664 cac.exact_address = NULL;
665 cac.base_address = NULL;
667 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
668 &compare_address_it, &cac);
670 if (cac.exact_address == NULL)
671 return cac.base_address;
672 return cac.exact_address;
677 * Find the exact address
679 * @param handle the address handle to use
681 * @param plugin_name transport plugin name
682 * @param plugin_addr plugin address
683 * @param plugin_addr_len length of the plugin address
684 * @param session_id session id, can be 0
685 * @return an ATS_address or NULL
688 static struct ATS_Address *
689 find_exact_address (struct GAS_Addresses_Handle *handle,
690 const struct GNUNET_PeerIdentity *peer,
691 const char *plugin_name,
692 const void *plugin_addr,
693 size_t plugin_addr_len,
696 struct ATS_Address *aa;
697 struct ATS_Address *ea;
699 aa = create_address (peer,
701 plugin_addr, plugin_addr_len,
704 /* Get existing address or address with session == 0 */
705 ea = find_equivalent_address (handle, peer, aa);
709 else if (ea->session_id != session_id)
716 * Extract an ATS performance info from an address
718 * @param address the address
719 * @param type the type to extract in HBO
720 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
723 get_performance_info (struct ATS_Address *address, uint32_t type)
726 GNUNET_assert (NULL != address);
728 if ((NULL == address->atsi) || (0 == address->atsi_count))
729 return GNUNET_ATS_VALUE_UNDEFINED;
731 for (c1 = 0; c1 < address->atsi_count; c1++)
733 if (ntohl(address->atsi[c1].type) == type)
734 return ntohl(address->atsi[c1].value);
736 return GNUNET_ATS_VALUE_UNDEFINED;
741 * Add a new address for a peer.
743 * @param handle the address handle to use
745 * @param plugin_name transport plugin name
746 * @param plugin_addr plugin address
747 * @param plugin_addr_len length of the plugin address
748 * @param session_id session id, can be 0
749 * @param atsi performance information for this address
750 * @param atsi_count number of performance information contained
753 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
754 const struct GNUNET_PeerIdentity *peer,
755 const char *plugin_name,
756 const void *plugin_addr,
757 size_t plugin_addr_len,
759 const struct GNUNET_ATS_Information *atsi,
762 struct ATS_Address *new_address;
763 struct ATS_Address *existing_address;
764 struct GNUNET_ATS_Information *atsi_delta;
765 uint32_t atsi_delta_count;
767 uint32_t previous_session;
770 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
771 "Received `%s' for peer `%s'\n",
775 if (GNUNET_NO == handle->running)
778 GNUNET_assert (NULL != handle->addresses);
780 new_address = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
783 disassemble_ats_information (new_address, atsi, atsi_count, &atsi_delta, &atsi_delta_count);
784 GNUNET_free_non_null (atsi_delta);
785 addr_net = get_performance_info (new_address, GNUNET_ATS_NETWORK_TYPE);
786 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
787 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
789 /* Get existing address or address with session == 0 */
790 existing_address = find_equivalent_address (handle, peer, new_address);
791 if (existing_address == NULL)
793 /* Add a new address */
794 GNUNET_assert (GNUNET_OK ==
795 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
796 &peer->hashPubKey, new_address,
797 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
799 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding new address %p for peer `%s' session id %u, %s\n",
800 new_address, GNUNET_i2s (peer), session_id, GNUNET_ATS_print_network_type(addr_net));
802 /* Tell solver about new address */
803 handle->s_add (handle->solver, new_address, addr_net);
805 handle->s_bulk_start (handle->solver);
806 GAS_normalization_normalize_property (handle->addresses, new_address, atsi, atsi_count);
807 handle->s_bulk_stop (handle->solver);
809 /* Notify performance clients about new address */
810 GAS_performance_notify_all_clients (&new_address->peer,
812 new_address->addr, new_address->addr_len,
813 new_address->session_id,
814 new_address->atsi, new_address->atsi_count,
815 new_address->assigned_bw_out,
816 new_address->assigned_bw_in);
820 /* We have an existing address we can use, clean up new */
821 GNUNET_free (new_address->plugin);
822 GNUNET_free_non_null (new_address->atsi);
823 GNUNET_free (new_address);
826 if (0 != existing_address->session_id)
828 /* Should not happen */
833 addr_net = get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE);
834 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
835 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
837 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
838 "Found existing address for peer `%s' %p with new session %u in network %s\n",
842 GNUNET_ATS_print_network_type (addr_net));
843 /* We have an address without an session, update this address */
845 atsi_delta_count = 0;
846 if (GNUNET_YES == disassemble_ats_information (existing_address, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
848 /* Notify performance clients about properties */
849 GAS_performance_notify_all_clients (&existing_address->peer,
850 existing_address->plugin,
851 existing_address->addr, existing_address->addr_len,
852 existing_address->session_id,
853 existing_address->atsi, existing_address->atsi_count,
854 existing_address->assigned_bw_out,
855 existing_address->assigned_bw_in);
857 for (c1 = 0; c1 < atsi_delta_count; c1++)
859 if ((GNUNET_ATS_NETWORK_TYPE == ntohl (atsi_delta[c1].type)) &&
860 (addr_net != ntohl (atsi_delta[c1].value)))
862 /* Network type changed */
863 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Address for peer `%s' %p changed from network %s to %s\n",
866 GNUNET_ATS_print_network_type (addr_net),
867 GNUNET_ATS_print_network_type (ntohl (atsi_delta[c1].value)));
868 handle->s_address_update_network (handle->solver, existing_address,
869 ntohl (atsi_delta[c1].value),
870 get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE));
871 addr_net = get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE);
875 /* Notify solver about update with atsi information and session */
876 handle->s_bulk_start (handle->solver);
877 GAS_normalization_normalize_property (handle->addresses, existing_address, atsi, atsi_count);
878 handle->s_bulk_stop (handle->solver);
880 GNUNET_free_non_null (atsi_delta);
882 /* Notify solver about new session */
883 if (existing_address->session_id == session_id)
884 return; /* possible, can both be 0 since address is revalidated */
886 previous_session = existing_address->session_id;
887 existing_address->session_id = session_id;
888 handle->s_address_update_session (handle->solver, existing_address,
889 previous_session, session_id);
891 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
892 "Updated existing address for peer `%s' %p with new session %u in network %s\n",
896 GNUNET_ATS_print_network_type(addr_net));
901 * Update an address with a session or performance information for a peer.
903 * If an address was added without a session it will be updated with the
906 * @param handle the address handle to use
908 * @param plugin_name transport plugin name
909 * @param plugin_addr plugin address
910 * @param plugin_addr_len length of the plugin address
911 * @param session_id session id, can be 0
912 * @param atsi performance information for this address
913 * @param atsi_count number of performance information contained
916 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
917 const struct GNUNET_PeerIdentity *peer,
918 const char *plugin_name, const void *plugin_addr,
919 size_t plugin_addr_len, uint32_t session_id,
920 const struct GNUNET_ATS_Information *atsi,
923 struct ATS_Address *aa;
924 struct GNUNET_ATS_Information *atsi_delta;
925 uint32_t atsi_delta_count;
926 uint32_t prev_session;
929 if (GNUNET_NO == handle->running)
932 GNUNET_assert (NULL != handle->addresses);
934 /* Get existing address */
935 aa = find_exact_address (handle, peer, plugin_name,
936 plugin_addr, plugin_addr_len, session_id);
939 /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
940 /* GNUNET_i2s (peer), plugin_name, session_id); */
941 /* GNUNET_break (0); */
945 if (NULL == aa->solver_information)
947 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
948 GNUNET_i2s (peer), plugin_name, session_id);
952 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
953 "Received `%s' for peer `%s' address \n",
955 GNUNET_i2s (peer), aa);
958 if (session_id != aa->session_id)
960 /* Session changed */
961 prev_session = aa->session_id;
962 aa->session_id = session_id;
963 handle->s_address_update_session (handle->solver, aa, prev_session, aa->session_id);
967 atsi_delta_count = 0;
968 if (GNUNET_YES == disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
970 /* ATS properties changed */
971 for (c1 = 0; c1 < atsi_delta_count; c1++)
973 if (GNUNET_ATS_NETWORK_TYPE == ntohl (atsi_delta[c1].type))
975 /* Network type changed */
976 handle->s_address_update_network (handle->solver, aa,
977 ntohl (atsi_delta[c1].value),
978 get_performance_info (aa, GNUNET_ATS_NETWORK_TYPE));
982 /* Notify performance clients about updated address */
983 GAS_performance_notify_all_clients (&aa->peer,
985 aa->addr, aa->addr_len,
987 aa->atsi, aa->atsi_count,
991 handle->s_bulk_start (handle->solver);
992 GAS_normalization_normalize_property (handle->addresses, aa, atsi, atsi_count);
993 handle->s_bulk_stop (handle->solver);
995 GNUNET_free_non_null (atsi_delta);
999 struct DestroyContext
1001 struct ATS_Address *aa;
1003 struct GAS_Addresses_Handle *handle;
1006 * GNUNET_NO : full address
1007 * GNUNET_YES : just session
1016 * If session != 0, just the session is deleted, the address itself still exists
1017 * If session == 0, remove full address
1018 * If session == 0 and addrlen == 0, destroy inbound address
1022 * @param value the 'struct ATS_Address'
1023 * @return GNUNET_OK (continue to iterate)
1026 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1028 struct DestroyContext *dc = cls;
1029 struct GAS_Addresses_Handle *handle = dc->handle;
1030 const struct ATS_Address *des = dc->aa;
1031 struct ATS_Address *aa = value;
1033 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
1034 sizeof (struct GNUNET_PeerIdentity)));
1037 if (des->session_id == 0)
1039 /* Session == 0, remove full address */
1040 if ((0 == strcmp (des->plugin, aa->plugin)) &&
1041 (aa->addr_len == des->addr_len) &&
1042 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
1045 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1046 "Deleting full address for peer `%s' session %u %p\n",
1047 GNUNET_i2s (&aa->peer), aa->session_id, aa);
1049 /* Notify solver about deletion */
1050 GNUNET_assert (GNUNET_YES ==
1051 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
1052 &aa->peer.hashPubKey, aa));
1053 handle->s_del (handle->solver, aa, GNUNET_NO);
1055 dc->result = GNUNET_NO;
1056 return GNUNET_OK; /* Continue iteration */
1061 /* Session != 0, just remove session */
1062 if (aa->session_id != des->session_id)
1063 return GNUNET_OK; /* irrelevant */
1065 if ((aa->session_id != 0) &&
1066 (0 != strcmp (des->plugin, aa->plugin)))
1068 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1069 "Different plugins during removal: `%s' vs `%s' \n",
1070 des->plugin, aa->plugin);
1075 if (aa->addr_len == 0)
1077 /* Inbound connection died, delete full address */
1078 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1079 "Deleting inbound address for peer `%s': `%s' session %u\n",
1080 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1082 /* Notify solver about deletion */
1083 GNUNET_assert (GNUNET_YES ==
1084 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
1085 &aa->peer.hashPubKey, aa));
1086 handle->s_del (handle->solver, aa, GNUNET_NO);
1088 dc->result = GNUNET_NO;
1089 return GNUNET_OK; /* Continue iteration */
1094 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1095 "Deleting session for peer `%s': `%s' %u\n",
1096 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1097 /* Notify solver to delete session */
1098 handle->s_del (handle->solver, aa, GNUNET_YES);
1108 * Remove an address or just a session for a peer.
1110 * @param handle the address handle to use
1112 * @param plugin_name transport plugin name
1113 * @param plugin_addr plugin address
1114 * @param plugin_addr_len length of the plugin address
1115 * @param session_id session id, can be 0
1118 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
1119 const struct GNUNET_PeerIdentity *peer,
1120 const char *plugin_name,
1121 const void *plugin_addr,
1122 size_t plugin_addr_len,
1123 uint32_t session_id)
1125 struct ATS_Address *ea;
1126 struct DestroyContext dc;
1127 if (GNUNET_NO == handle->running)
1130 /* Get existing address */
1131 ea = find_exact_address (handle, peer, plugin_name, plugin_addr,
1132 plugin_addr_len, session_id);
1135 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1136 GNUNET_i2s (peer), plugin_name, session_id);
1140 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1141 "Received `%s' for peer `%s' address %p session %u\n",
1143 GNUNET_i2s (peer), ea, session_id);
1145 GNUNET_break (0 < strlen (plugin_name));
1147 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1149 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1150 &destroy_by_session_id, &dc);
1151 free_address (dc.aa);
1156 * Notification about active use of an address.
1157 * in_use == GNUNET_YES:
1158 * This address is used to maintain an active connection with a peer.
1159 * in_use == GNUNET_NO:
1160 * This address is no longer used to maintain an active connection with a peer.
1162 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1165 * @param handle the address handle to use
1167 * @param plugin_name transport plugin name
1168 * @param plugin_addr plugin address
1169 * @param plugin_addr_len length of the plugin address
1170 * @param session_id session id, can be 0
1171 * @param in_use GNUNET_YES if GNUNET_NO
1172 * @return GNUNET_SYSERR on failure (address unknown ...)
1175 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1176 const struct GNUNET_PeerIdentity *peer,
1177 const char *plugin_name,
1178 const void *plugin_addr,
1179 size_t plugin_addr_len,
1180 uint32_t session_id,
1183 struct ATS_Address *ea;
1184 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1185 "Received `%s' for peer `%s'\n",
1189 if (GNUNET_NO == handle->running)
1190 return GNUNET_SYSERR;
1192 ea = find_exact_address (handle, peer, plugin_name,
1193 plugin_addr, plugin_addr_len, session_id);
1196 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1197 "Trying to set unknown address `%s', %s %u %s \n",
1199 plugin_name, session_id,
1200 (GNUNET_NO == in_use) ? "NO" : "YES");
1202 return GNUNET_SYSERR;
1204 if (ea->used == in_use)
1207 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1208 "Address in use called multiple times for peer `%s': %s -> %s \n",
1210 (GNUNET_NO == ea->used) ? "NO" : "YES",
1211 (GNUNET_NO == in_use) ? "NO" : "YES");
1212 return GNUNET_SYSERR;
1215 /* Tell solver about update */
1217 handle->s_address_update_inuse (handle->solver, ea, ea->used);
1223 * Cancel address suggestions for a peer
1225 * @param handle the address handle
1226 * @param peer the peer id
1229 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1230 const struct GNUNET_PeerIdentity *peer)
1232 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1235 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1239 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1246 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1247 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1250 handle->s_get_stop (handle->solver, peer);
1251 GAS_addresses_handle_backoff_reset (handle, peer);
1252 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1253 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1254 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1260 * Request address suggestions for a peer
1262 * @param handle the address handle
1263 * @param peer the peer id
1266 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1267 const struct GNUNET_PeerIdentity *peer)
1269 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1270 struct ATS_Address *aa;
1272 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1273 "Received `%s' for peer `%s'\n",
1277 if (GNUNET_NO == handle->running)
1281 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1282 break; /* already suggesting */
1287 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1289 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1292 /* Get prefered address from solver */
1293 aa = (struct ATS_Address *) handle->s_get (handle->solver, peer);
1296 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1297 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1301 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1302 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1304 GAS_scheduling_transmit_address_suggestion (peer,
1306 aa->addr, aa->addr_len,
1308 aa->atsi, aa->atsi_count,
1309 aa->assigned_bw_out,
1310 aa->assigned_bw_in);
1312 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1313 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1315 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1316 "Address %p ready for suggestion, block interval now %llu \n",
1317 aa, aa->block_interval);
1322 * Iterator to reset address blocking
1324 * @param cls not used
1325 * @param key the peer
1326 * @param value the address to reset
1327 * @return GNUNET_OK to continue
1330 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1332 struct ATS_Address *aa = value;
1334 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1335 "Resetting interval for peer `%s' address %p from %llu to 0\n",
1336 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1338 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1339 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1345 * Reset suggestion backoff for a peer
1347 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1348 * reset using this function
1350 * @param handle the address handle
1351 * @param peer the peer id
1354 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1355 const struct GNUNET_PeerIdentity *peer)
1357 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1358 "Received `%s' for peer `%s'\n",
1362 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1370 * The preference changed for a peer
1372 * @param cls the address handle
1373 * @param peer the peer
1374 * @param kind the ATS kind
1375 * @param pref_rel the new relative preference value
1378 normalized_preference_changed_cb (void *cls,
1379 const struct GNUNET_PeerIdentity *peer,
1380 enum GNUNET_ATS_PreferenceKind kind,
1383 GNUNET_assert (NULL != cls);
1384 struct GAS_Addresses_Handle *handle = cls;
1385 /* Tell solver about update */
1386 handle->s_pref (handle->solver, peer, kind, pref_rel);
1391 * The relative value for a property changed
1393 * @param cls the address handle
1394 * @param address the peer
1395 * @param type the ATS type
1396 * @param prop_rel the new relative preference value
1399 normalized_property_changed_cb (void *cls,
1400 struct ATS_Address *address,
1404 struct GAS_Addresses_Handle *ah = (struct GAS_Addresses_Handle *) cls;
1405 GNUNET_assert (NULL != ah);
1407 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1408 "Normalized property %s for peer `%s' changed to %.3f \n",
1409 GNUNET_ATS_print_property_type (type),
1410 GNUNET_i2s (&address->peer),
1413 ah->s_address_update_property (ah->solver,
1422 * Function allowing the solver to obtain normalized preference
1423 * values from solver
1426 * @param id the peer to return the normalized properties for
1427 * @return array of double values with |GNUNET_ATS_PreferenceCount| elements
1430 get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
1432 return GAS_normalization_get_preferences (id);
1436 * Function allowing the solver to obtain normalized property
1437 * values for an address from solver
1440 * @param address the address
1441 * @return array of double values with |GNUNET_ATS_QualityPropertiesCount| elements
1444 get_property_cb (void *cls, const struct ATS_Address *address)
1446 return GAS_normalization_get_properties ((struct ATS_Address *) address);
1450 * Change the preference for a peer
1452 * @param handle the address handle
1453 * @param client the client sending this request
1454 * @param peer the peer id
1455 * @param kind the preference kind to change
1456 * @param score_abs the new preference score
1459 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1461 const struct GNUNET_PeerIdentity *peer,
1462 enum GNUNET_ATS_PreferenceKind kind,
1465 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1466 "Received `%s' for peer `%s' for client %p\n",
1467 "CHANGE PREFERENCE",
1468 GNUNET_i2s (peer), client);
1470 if (GNUNET_NO == handle->running)
1473 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1476 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1477 "Received `%s' for unknown peer `%s' from client %p\n",
1478 "CHANGE PREFERENCE",
1479 GNUNET_i2s (peer), client);
1483 handle->s_bulk_start (handle->solver);
1484 /* Tell normalization about change, normalization will call callback if preference changed */
1485 GAS_normalization_normalize_preference (client, peer, kind, score_abs);
1486 handle->s_bulk_stop (handle->solver);
1490 * Change the preference for a peer
1492 * @param handle the address handle
1493 * @param application the client sending this request
1494 * @param peer the peer id
1495 * @param kind the preference kind to change
1496 * @param score_abs the new preference score
1499 GAS_addresses_preference_feedback (struct GAS_Addresses_Handle *handle,
1501 const struct GNUNET_PeerIdentity *peer,
1502 enum GNUNET_ATS_PreferenceKind kind,
1505 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1506 "Received `%s' for peer `%s' for client %p\n",
1507 "PREFERENCE FEEDBACK",
1508 GNUNET_i2s (peer), application);
1510 if (GNUNET_NO == handle->running)
1513 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1516 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1517 "Received `%s' for unknown peer `%s' from client %p\n",
1518 "PREFERENCE FEEDBACK",
1519 GNUNET_i2s (peer), application);
1523 handle->s_feedback (handle->solver, application, peer, kind, score_abs);
1528 * Load quotas for networks from configuration
1530 * @param cfg configuration handle
1531 * @param out_dest where to write outbound quotas
1532 * @param in_dest where to write inbound quotas
1533 * @param dest_length length of inbound and outbound arrays
1534 * @return number of networks loaded
1537 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1539 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1540 char * entry_in = NULL;
1541 char * entry_out = NULL;
1542 char * quota_out_str;
1543 char * quota_in_str;
1547 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1551 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1552 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1555 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1558 if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1560 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1563 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1565 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1568 if (GNUNET_NO == res)
1570 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1571 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1572 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1576 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1577 network_str[c], out_dest[c]);
1579 GNUNET_free (quota_out_str);
1583 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1584 network_str[c], GNUNET_ATS_DefaultBandwidth);
1585 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1589 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1592 if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1594 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1597 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1599 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1602 if (GNUNET_NO == res)
1604 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1605 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1606 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1610 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1611 network_str[c], in_dest[c]);
1613 GNUNET_free (quota_in_str);
1617 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1618 network_str[c], GNUNET_ATS_DefaultBandwidth);
1619 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1621 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Loaded quota for network `%s' (in/out): %llu %llu\n", network_str[c], in_dest[c], out_dest[c]);
1622 GNUNET_free (entry_out);
1623 GNUNET_free (entry_in);
1625 return GNUNET_ATS_NetworkTypeCount;
1630 * Callback for solver to notify about assignment changes
1632 * @param cls the GAS_Addresses_Handle
1633 * @param address the address with changes
1636 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1638 struct GAS_Addresses_Handle *handle = cls;
1639 struct GAS_Addresses_Suggestion_Requests *cur;
1641 GNUNET_assert (handle != NULL);
1642 GNUNET_assert (address != NULL);
1644 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1646 /* Notify performance clients about changes to address */
1647 GAS_performance_notify_all_clients (&address->peer,
1649 address->addr, address->addr_len,
1650 address->session_id,
1651 address->atsi, address->atsi_count,
1652 address->assigned_bw_out,
1653 address->assigned_bw_in);
1654 cur = handle->r_head;
1657 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1658 break; /* we have an address request pending*/
1663 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1664 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1668 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1669 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1671 /* *Notify scheduling clients about suggestion */
1672 GAS_scheduling_transmit_address_suggestion (&address->peer,
1674 address->addr, address->addr_len,
1675 address->session_id,
1676 address->atsi, address->atsi_count,
1677 address->assigned_bw_out,
1678 address->assigned_bw_in);
1683 * Initialize address subsystem. The addresses subsystem manages the addresses
1684 * known and current performance information. It has a solver component
1685 * responsible for the resource allocation. It tells the solver about changes
1686 * and receives updates when the solver changes the ressource allocation.
1688 * @param cfg configuration to use
1689 * @param stats the statistics handle to use
1690 * @return an address handle
1692 struct GAS_Addresses_Handle *
1693 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1694 const struct GNUNET_STATISTICS_Handle *stats)
1696 struct GAS_Addresses_Handle *ah;
1697 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1698 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1699 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1704 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1705 ah->running = GNUNET_NO;
1707 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1708 /* Initialize the addresses database */
1709 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1710 GNUNET_assert (NULL != ah->addresses);
1712 /* Figure out configured solution method */
1713 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1715 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1716 ah->ats_mode = MODE_SIMPLISTIC;
1720 for (c = 0; c < strlen (mode_str); c++)
1721 mode_str[c] = toupper (mode_str[c]);
1722 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1724 ah->ats_mode = MODE_SIMPLISTIC;
1726 else if (0 == strcmp (mode_str, "MLP"))
1728 ah->ats_mode = MODE_MLP;
1730 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1731 ah->ats_mode = MODE_SIMPLISTIC;
1736 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1737 ah->ats_mode = MODE_SIMPLISTIC;
1739 GNUNET_free (mode_str);
1741 /* Start configured solution method */
1742 switch (ah->ats_mode)
1745 /* Init the MLP solver with default values */
1747 ah->ats_mode = MODE_MLP;
1748 ah->s_init = &GAS_mlp_init;
1749 ah->s_add = &GAS_mlp_address_add;
1750 ah->s_address_update_property = &GAS_mlp_address_property_changed;
1751 ah->s_address_update_session = &GAS_mlp_address_session_changed;
1752 ah->s_address_update_inuse = &GAS_mlp_address_inuse_changed;
1753 ah->s_address_update_network = &GAS_mlp_address_change_network;
1754 ah->s_get = &GAS_mlp_get_preferred_address;
1755 ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1756 ah->s_pref = &GAS_mlp_address_change_preference;
1757 ah->s_feedback = &GAS_mlp_address_preference_feedback;
1758 ah->s_del = &GAS_mlp_address_delete;
1759 ah->s_bulk_start = &GAS_mlp_bulk_start;
1760 ah->s_bulk_stop = &GAS_mlp_bulk_stop;
1761 ah->s_done = &GAS_mlp_done;
1767 case MODE_SIMPLISTIC:
1768 /* Init the simplistic solver with default values */
1769 ah->ats_mode = MODE_SIMPLISTIC;
1770 ah->s_init = &GAS_proportional_init;
1771 ah->s_add = &GAS_proportional_address_add;
1772 ah->s_address_update_property = &GAS_proportional_address_property_changed;
1773 ah->s_address_update_session = &GAS_proportional_address_session_changed;
1774 ah->s_address_update_inuse = &GAS_proportional_address_inuse_changed;
1775 ah->s_address_update_network = &GAS_proportional_address_change_network;
1776 ah->s_get = &GAS_proportional_get_preferred_address;
1777 ah->s_get_stop = &GAS_proportional_stop_get_preferred_address;
1778 ah->s_pref = &GAS_proportional_address_change_preference;
1779 ah->s_feedback = &GAS_proportional_address_preference_feedback;
1780 ah->s_del = &GAS_proportional_address_delete;
1781 ah->s_bulk_start = &GAS_proportional_bulk_start;
1782 ah->s_bulk_stop = &GAS_proportional_bulk_stop;
1783 ah->s_done = &GAS_proportional_done;
1784 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1791 GNUNET_assert (NULL != ah->s_init);
1792 GNUNET_assert (NULL != ah->s_add);
1793 GNUNET_assert (NULL != ah->s_address_update_inuse);
1794 GNUNET_assert (NULL != ah->s_address_update_property);
1795 GNUNET_assert (NULL != ah->s_address_update_session);
1796 GNUNET_assert (NULL != ah->s_address_update_network);
1797 GNUNET_assert (NULL != ah->s_get);
1798 GNUNET_assert (NULL != ah->s_get_stop);
1799 GNUNET_assert (NULL != ah->s_pref);
1800 GNUNET_assert (NULL != ah->s_feedback);
1801 GNUNET_assert (NULL != ah->s_del);
1802 GNUNET_assert (NULL != ah->s_done);
1803 GNUNET_assert (NULL != ah->s_bulk_start);
1804 GNUNET_assert (NULL != ah->s_bulk_stop);
1806 GAS_normalization_start (&normalized_preference_changed_cb, ah,
1807 &normalized_property_changed_cb, ah);
1808 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1810 ah->solver = ah->s_init (cfg, stats, ah->addresses,
1811 quotas, quotas_in, quotas_out, quota_count,
1812 &bandwidth_changed_cb, ah,
1813 &get_preferences_cb, NULL,
1814 &get_property_cb, NULL);
1815 if (NULL == ah->solver)
1817 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Failed to initialize solver!\n"));
1822 /* up and running */
1823 ah->running = GNUNET_YES;
1829 * Destroy all addresses iterator
1832 * @param key peer identity (unused)
1833 * @param value the 'struct ATS_Address' to free
1834 * @return GNUNET_OK (continue to iterate)
1837 destroy_all_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1839 struct GAS_Addresses_Handle *handle = cls;
1840 struct ATS_Address *aa = value;
1843 GNUNET_assert (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (handle->addresses, key, value));
1845 handle->s_del (handle->solver, aa, GNUNET_NO);
1854 * Remove all addresses
1856 * @param handle the address handle to use
1859 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1861 if (GNUNET_NO == handle->running)
1864 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1867 if (handle->addresses != NULL)
1868 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &destroy_all_address_it, handle);
1873 * Shutdown address subsystem.
1875 * @param handle the address handle to shutdown
1878 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1880 struct GAS_Addresses_Suggestion_Requests *cur;
1882 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1883 "Shutting down addresses\n");
1884 GNUNET_assert (NULL != handle);
1885 GAS_addresses_destroy_all (handle);
1886 handle->running = GNUNET_NO;
1887 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1888 handle->addresses = NULL;
1889 while (NULL != (cur = handle->r_head))
1891 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1894 handle->s_done (handle->solver);
1895 GNUNET_free (handle);
1896 /* Stop configured solution method */
1897 GAS_normalization_stop ();
1901 struct PeerIteratorContext
1903 GNUNET_ATS_Peer_Iterator it;
1905 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1910 * Iterator to iterate over all peers
1912 * @param cls a PeerIteratorContext
1913 * @param key the peer id
1914 * @param value the ATS_address
1915 * @return GNUNET_OK to continue
1919 const struct GNUNET_HashCode * key,
1922 struct PeerIteratorContext *ip_ctx = cls;
1923 struct GNUNET_PeerIdentity tmp;
1925 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1927 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1928 tmp.hashPubKey = (*key);
1929 ip_ctx->it (ip_ctx->it_cls, &tmp);
1937 * Return information all peers currently known to ATS
1939 * @param handle the address handle to use
1940 * @param p_it the iterator to call for every peer
1941 * @param p_it_cls the closure for the iterator
1944 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1945 GNUNET_ATS_Peer_Iterator p_it,
1948 struct PeerIteratorContext ip_ctx;
1953 GNUNET_assert (NULL != handle->addresses);
1955 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1959 ip_ctx.it_cls = p_it_cls;
1960 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1961 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1962 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1964 p_it (p_it_cls, NULL);
1968 struct PeerInfoIteratorContext
1970 GNUNET_ATS_PeerInfo_Iterator it;
1976 * Iterator to iterate over a peer's addresses
1978 * @param cls a PeerInfoIteratorContext
1979 * @param key the peer id
1980 * @param value the ATS_address
1981 * @return GNUNET_OK to continue
1984 peerinfo_it (void *cls,
1985 const struct GNUNET_HashCode * key,
1988 struct PeerInfoIteratorContext *pi_ctx = cls;
1989 struct ATS_Address *addr = (struct ATS_Address *) value;
1991 if (NULL != pi_ctx->it)
1993 pi_ctx->it (pi_ctx->it_cls,
1996 addr->addr, addr->addr_len,
1998 addr->atsi, addr->atsi_count,
1999 addr->assigned_bw_out,
2000 addr->assigned_bw_in);
2007 * Return information all peers currently known to ATS
2009 * @param handle the address handle to use
2010 * @param peer the respective peer
2011 * @param pi_it the iterator to call for every peer
2012 * @param pi_it_cls the closure for the iterator
2015 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
2016 const struct GNUNET_PeerIdentity *peer,
2017 GNUNET_ATS_PeerInfo_Iterator pi_it,
2020 struct PeerInfoIteratorContext pi_ctx;
2021 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
2022 GNUNET_assert (NULL != peer);
2023 GNUNET_assert (NULL != handle->addresses);
2025 return; /* does not make sense without callback */
2027 zero_bw = GNUNET_BANDWIDTH_value_init (0);
2029 pi_ctx.it_cls = pi_it_cls;
2031 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
2034 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
2039 /* end of gnunet-service-ats_addresses.c */