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-solver_proportional.c
23 * @brief ATS proportional solver
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet-service-ats_addresses.h"
30 #include "gnunet_statistics_service.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
36 * NOTE: Do not change this documentation. This documentation is based
37 * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
38 * use build_txt.sh to generate plaintext output
40 * ATS addresses : simplistic solver
42 * The simplistic solver ("simplistic") distributes the available
43 * bandwidth fair over all the addresses influenced by the
44 * preference values. For each available network type an in- and
45 * outbound quota is configured and the bandwidth available in
46 * these networks is distributed over the addresses. The solver
47 * first assigns every addresses the minimum amount of bandwidth
48 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
49 * remaining bandwidth available according to the preference
50 * values. For each peer only a single address gets bandwidth
51 * assigned and only one address marked as active. The most
52 * important functionality for the solver is implemented in: *
53 * find_address_it is an hashmap iterator returning the prefered
54 * address for an peer * update_quota_per_network distributes
55 * available bandwidth for a network over active addresses
57 * Changes to addresses automatically have an impact on the the
58 * bandwidth assigned to other addresses in the same network since
59 * the solver distributes the remaining bandwidth over the
60 * addresses in the network. When changes to the addresses occur,
61 * the solver first performs the changes, like adding or deleting
62 * addresses, and then updates bandwidth assignment for the
63 * affected network. Bandwidth assignment is only recalculated on
64 * demand when an address is requested by a client for a peer or
65 * when the addresses available have changed or an address changed
66 * the network it is located in. When the bandwidth assignment has
67 * changed the callback is called with the new bandwidth
68 * assignments. The bandwidth distribution for a network is
69 * recalculated due to: * address suggestion requests * address
70 * deletions * address switching networks during address update *
73 * 3.1 Data structures used
75 * For each ATS network (e.g. WAN, LAN, loopback) a struct Network
76 * is used to specify network related information as total adresses
77 * and active addresses in this network and the configured in- and
78 * outbound quota. Each network also contains a list of addresses
79 * added to the solver located in this network. The simplistic
80 * solver uses the addresses' solver_information field to store the
81 * simplistic network it belongs to for each address.
85 * When the simplistic solver is initialized the solver creates a
86 * new solver handle and initializes the network structures with
87 * the quotas passed from addresses and returns the handle solver.
89 * 3.3 Adding an address
91 * When a new address is added to the solver using s_add, a lookup
92 * for the network for this address is done and the address is
93 * enqueued in in the linked list of the network.
95 * 3.4 Updating an address
97 * The main purpose of address updates is to update the ATS
98 * information for addresse selection. Important for the simplistic
99 * solver is when an address switches network it is located
100 * in. This is common because addresses added by transport's
101 * validation mechanism are commonly located in
102 * GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
103 * in this network type and only if a connection is successful on
104 * return of payload data transport switches to the real network
105 * the address is located in. When an address changes networks it
106 * is first of all removed from the old network using the solver
107 * API function GAS_simplistic_address_delete and the network in
108 * the address struct is updated. A lookup for the respective new
109 * simplistic network is done and stored in the addresse's
110 * solver_information field. Next the address is re-added to the
111 * solver using the solver API function
112 * GAS_simplistic_address_add. If the address was marked as in
113 * active, the solver checks if bandwidth is available in the
114 * network and if yes sets the address to active and updates the
115 * bandwidth distribution in this network. If no bandwidth is
116 * available it sets the bandwidth for this address to 0 and tries
117 * to suggest an alternative address. If an alternative address was
118 * found, addresses' callback is called for this address.
120 * 3.5 Deleting an address
122 * When an address is removed from the solver, it removes the
123 * respective address from the network and if the address was
124 * marked as active, it updates the bandwidth distribution for this
127 * 3.6 Requesting addresses
129 * When an address is requested for a peer the solver performs a
130 * lookup for the peer entry in addresses address hashmap and
131 * selects the best address. The selection of the most suitable
132 * address is done in the find_address_it hashmap iterator
133 * described in detail in section 3.7. If no address is returned,
134 * no address can be suggested at the moment. If the address
135 * returned is marked as active, the solver can return this
136 * address. If the address is not marked as active, the solver
137 * checks if another address belongign to this peer is marked as
138 * active and marks the address as inactive, updates the bandwidth
139 * for this address to 0, call the bandwidth changed callback for
140 * this address due to the change and updates quota assignment for
141 * the addresse's network. the now in-active address is belonging
142 * to. The solver marks the new address as active and updates the
143 * bandwidth assignment for this network.
145 * 3.7 Choosing addresses
147 * Choosing the best possible address for suggestion is done by
148 * iterating over all addresses of a peer stored in addresses'
149 * hashmap and using the hashmap iterator find_address_it to select
150 * the best available address. Several checks are done when an
151 * address is selected. First if this address is currently blocked
152 * by addresses from being suggested. An address is blocked for the
153 * duration of ATS_BLOCKING_DELTA when it is suggested to
154 * transport. Next it is checked if at least
155 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
156 * in the addresse's network, because suggesting an address without
157 * bandwidth does not make sense. This also ensures that all active
158 * addresses in this network get at least the minimum amount of
159 * bandwidth assigned. In the next step the solver ensures that for
160 * tcp connections inbound connections are prefered over outbound
161 * connections. In the next stet the solver ensures that
162 * connections are prefered in the following order: * connections
163 * are already established and have bandwidth assigned *
164 * connections with a shorter distance * connectes have a shorter
167 * 3.8 Changing preferences
171 * During shutdown all network entries and aging processes are
172 * destroyed and freed.
177 * This solver assigns in and outbound bandwidth equally for all
178 * addresses in specific network type (WAN, LAN) based on configured
179 * in and outbound quota for this network.
181 * The solver is notified by addresses about changes to the addresses
182 * and recalculates the bandwith assigned if required. The solver
183 * notifies addresses by calling the GAS_bandwidth_changed_cb
191 * For each peer only a single is selected and marked as "active" in the address
196 * You have the networks WAN and LAN and quotas
197 * WAN_TOTAL_IN, WAN_TOTAL_OUT
198 * LAN_TOTAL_IN, LAN_TOTAL_OUT
200 * If you have x addresses in the network segment LAN, the quotas are
201 * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
203 * Quotas are automatically recalculated and reported back when addresses are
208 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
209 #define PREF_AGING_FACTOR 0.95
211 #define DEFAULT_REL_PREFERENCE 1.0
212 #define DEFAULT_ABS_PREFERENCE 0.0
213 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
217 * A handle for the proportional solver
219 struct GAS_PROPORTIONAL_Handle
225 struct GNUNET_STATISTICS_Handle *stats;
228 * Total number of addresses for solver
230 unsigned int total_addresses;
233 * Number of active addresses for solver
235 unsigned int active_addresses;
240 struct Network *network_entries;
245 unsigned int networks;
250 GAS_bandwidth_changed_cb bw_changed;
255 void *bw_changed_cls;
258 * ATS function to get preferences
260 GAS_get_preferences get_preferences;
263 * Closure for ATS function to get preferences
265 void *get_preferences_cls;
267 struct PreferenceClient *pc_head;
268 struct PreferenceClient *pc_tail;
273 * Representation of a network
283 * Network description
288 * Total inbound quota
291 unsigned long long total_quota_in;
294 * Total outbound quota
297 unsigned long long total_quota_out;
300 * Number of active addresses for this network
302 unsigned int active_addresses;
305 * Number of total addresses for this network
307 unsigned int total_addresses;
310 * String for statistics total addresses
315 * String for statistics active addresses
319 struct AddressWrapper *head;
320 struct AddressWrapper *tail;
325 * Wrapper for addresses to store them in network's linked list
327 struct AddressWrapper
332 struct AddressWrapper *next;
337 struct AddressWrapper *prev;
342 struct ATS_Address *addr;
348 * Important solver functions
349 * ---------------------------
353 * Test if bandwidth is available in this network to add an additional address
355 * @param net the network type to update
356 * @return GNUNET_YES or GNUNET_NO
359 is_bandwidth_available_in_network (struct Network *net)
361 GNUNET_assert (NULL != net);
362 unsigned int na = net->active_addresses + 1;
363 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
364 if (((net->total_quota_in / na) > min_bw) &&
365 ((net->total_quota_out / na) > min_bw))
367 LOG (GNUNET_ERROR_TYPE_DEBUG,
368 "Enough bandwidth available for %u active addresses in network `%s'\n",
374 LOG (GNUNET_ERROR_TYPE_DEBUG,
375 "Not enough bandwidth available for %u active addresses in network `%s'\n",
383 * Update bandwidth assigned to peers in this network
385 * @param s the solver handle
386 * @param net the network type to update
387 * @param address_except address excluded from notification, since we suggest
391 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
393 struct ATS_Address *address_except)
395 unsigned long long remaining_quota_in = 0;
396 unsigned long long quota_out_used = 0;
398 unsigned long long remaining_quota_out = 0;
399 unsigned long long quota_in_used = 0;
400 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
402 double total_prefs; /* Important: has to be double not float due to precision */
403 double cur_pref; /* Important: has to be double not float due to precision */
404 const double *t = NULL; /* Important: has to be double not float due to precision */
407 unsigned long long assigned_quota_in = 0;
408 unsigned long long assigned_quota_out = 0;
409 struct AddressWrapper *cur;
411 LOG (GNUNET_ERROR_TYPE_DEBUG,
412 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
413 net->desc, net->active_addresses, net->total_quota_in, net->total_quota_in);
415 if (net->active_addresses == 0)
416 return; /* no addresses to update */
419 * Assign every peer in network minimum Bandwidth
420 * Distribute bandwidth left according to preference
423 if ((net->active_addresses * min_bw) > net->total_quota_in)
428 if ((net->active_addresses * min_bw) > net->total_quota_out)
434 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
435 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
436 LOG (GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
437 remaining_quota_in, remaining_quota_out);
439 for (cur = net->head; NULL != cur; cur = cur->next)
441 if (GNUNET_YES == cur->addr->active)
443 GNUNET_assert (NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
446 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
448 if (c != GNUNET_ATS_PREFERENCE_END)
450 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
454 total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount -1));
457 for (cur = net->head; NULL != cur; cur = cur->next)
459 if (GNUNET_YES == cur->addr->active)
462 GNUNET_assert (NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
464 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
466 if (c != GNUNET_ATS_PREFERENCE_END)
471 assigned_quota_in = min_bw + ((cur_pref / total_prefs) * remaining_quota_in);
472 assigned_quota_out = min_bw + ((cur_pref / total_prefs) * remaining_quota_out);
474 LOG (GNUNET_ERROR_TYPE_DEBUG,
475 "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
476 GNUNET_i2s (&cur->addr->peer),
477 cur_pref, total_prefs,
478 assigned_quota_in, assigned_quota_out);
482 assigned_quota_in = 0;
483 assigned_quota_out = 0;
486 quota_in_used += assigned_quota_in;
487 quota_out_used += assigned_quota_out;
488 /* Prevent overflow due to rounding errors */
489 if (assigned_quota_in > UINT32_MAX)
490 assigned_quota_in = UINT32_MAX;
491 if (assigned_quota_out > UINT32_MAX)
492 assigned_quota_out = UINT32_MAX;
494 /* Compare to current bandwidth assigned */
495 if ((assigned_quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
496 (assigned_quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
498 cur->addr->assigned_bw_in.value__ = htonl (assigned_quota_in);
499 cur->addr->assigned_bw_out.value__ = htonl (assigned_quota_out);
500 /* Notify on change */
501 if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
502 s->bw_changed (s->bw_changed_cls, cur->addr);
506 LOG (GNUNET_ERROR_TYPE_DEBUG,
507 "Total bandwidth assigned is (in/out): %llu /%llu\n",
510 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
512 LOG (GNUNET_ERROR_TYPE_ERROR,
513 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
514 net->active_addresses,
516 net->total_quota_out);
518 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
520 LOG (GNUNET_ERROR_TYPE_ERROR,
521 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
522 net->active_addresses,
524 net->total_quota_in);
530 * Extract an ATS performance info from an address
532 * @param address the address
533 * @param type the type to extract in HBO
534 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
537 get_performance_info (struct ATS_Address *address, uint32_t type);
540 * Find a "good" address to use for a peer by iterating over the addresses for this peer.
541 * If we already have an existing address, we stick to it.
542 * Otherwise, we pick by lowest distance and then by lowest latency.
544 * @param cls the 'struct ATS_Address**' where we store the result
546 * @param value another 'struct ATS_Address*' to consider using
547 * @return GNUNET_OK (continue to iterate)
550 find_best_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
552 struct ATS_Address **previous_p = cls;
553 struct ATS_Address *current = (struct ATS_Address *) value;
554 struct ATS_Address *previous = *previous_p;
555 struct GNUNET_TIME_Absolute now;
556 struct Network *net = (struct Network *) current->solver_information;
557 uint32_t p_distance_cur;
558 uint32_t p_distance_prev;
559 uint32_t p_delay_cur;
560 uint32_t p_delay_prev;
562 now = GNUNET_TIME_absolute_get();
564 if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
566 /* This address is blocked for suggestion */
567 LOG (GNUNET_ERROR_TYPE_DEBUG,
568 "Address %p blocked for suggestion for %llu ms \n",
570 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
574 if (GNUNET_NO == is_bandwidth_available_in_network (net))
575 return GNUNET_OK; /* There's no bandwidth available in this network */
577 if (NULL != previous)
579 GNUNET_assert (NULL != previous->plugin);
580 GNUNET_assert (NULL != current->plugin);
581 if (0 == strcmp (previous->plugin, current->plugin))
583 if ((0 != previous->addr_len) &&
584 (0 == current->addr_len))
586 /* saved address was an outbound address, but we have an inbound address */
587 *previous_p = current;
590 if (0 == previous->addr_len)
592 /* saved address was an inbound address, so do not overwrite */
598 if (NULL == previous)
600 *previous_p = current;
603 if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
604 (ntohl (current->assigned_bw_in.value__) > 0))
606 /* stick to existing connection */
607 *previous_p = current;
611 p_distance_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DISTANCE);
612 p_distance_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DISTANCE);
613 if ((p_distance_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_distance_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
614 (p_distance_prev > p_distance_cur))
616 /* user shorter distance */
617 *previous_p = current;
621 p_delay_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DELAY);
622 p_delay_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DELAY);
623 if ((p_delay_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_delay_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
624 (p_delay_prev > p_delay_cur))
626 /* user lower latency */
627 *previous_p = current;
637 * ---------------------------
641 * Update bandwidth assignment for all networks
643 * @param s the solver handle
646 distribute_bandwidth_in_all_networks (struct GAS_PROPORTIONAL_Handle *s)
649 for (i = 0; i < s->networks; i++)
650 distribute_bandwidth_in_network (s, &s->network_entries[i], NULL);
656 * Lookup network struct by type
658 * @param s the solver handle
659 * @param type the network type
660 * @return the network struct
662 static struct Network *
663 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
666 for (c = 0 ; c < s->networks; c++)
668 if (s->network_entries[c].type == type)
669 return &s->network_entries[c];
677 * Hashmap Iterator to find current active address for peer
679 * @param cls last active address
680 * @param key peer's key
681 * @param value address to check
682 * @return GNUNET_NO on double active address else GNUNET_YES
685 get_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
687 struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
688 struct ATS_Address * aa = (struct ATS_Address *) value;
690 if (GNUNET_YES == aa->active)
694 /* should never happen */
695 LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
706 * Find current active address for peer
708 * @param solver the solver handle
709 * @param addresses the address set
710 * @param peer the peer
711 * @return active address or NULL
713 static struct ATS_Address *
714 get_active_address (void *solver,
715 struct GNUNET_CONTAINER_MultiHashMap * addresses,
716 const struct GNUNET_PeerIdentity *peer)
718 struct ATS_Address * dest = NULL;
720 GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
722 &get_active_address_it, &dest);
729 addresse_increment (struct GAS_PROPORTIONAL_Handle *s,
734 if (GNUNET_YES == total)
736 s->total_addresses ++;
737 net->total_addresses ++;
738 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
739 GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
741 if (GNUNET_YES == active)
743 net->active_addresses ++;
744 s->active_addresses ++;
745 GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
746 GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
753 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
759 if (GNUNET_YES == total)
761 if (s->total_addresses < 1)
768 s->total_addresses --;
769 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
771 if (net->total_addresses < 1)
778 net->total_addresses --;
779 GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
783 if (GNUNET_YES == active)
785 if (net->active_addresses < 1)
792 net->active_addresses --;
793 GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
795 if (s->active_addresses < 1)
802 s->active_addresses --;
803 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
811 * Extract an ATS performance info from an address
813 * @param address the address
814 * @param type the type to extract in HBO
815 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
818 get_performance_info (struct ATS_Address *address, uint32_t type)
821 GNUNET_assert (NULL != address);
823 if ((NULL == address->atsi) || (0 == address->atsi_count))
824 return GNUNET_ATS_VALUE_UNDEFINED;
826 for (c1 = 0; c1 < address->atsi_count; c1++)
828 if (ntohl(address->atsi[c1].type) == type)
829 return ntohl(address->atsi[c1].value);
831 return GNUNET_ATS_VALUE_UNDEFINED;
836 * Solver API functions
837 * ---------------------------
841 * Changes the preferences for a peer in the problem
843 * @param solver the solver handle
844 * @param addresses the address hashmap
845 * @param peer the peer to change the preference for
846 * @param kind the kind to change the preference
847 * @param pref_rel the normalized preference value for this kind over all clients
850 GAS_proportional_address_change_preference (void *solver,
851 struct GNUNET_CONTAINER_MultiHashMap *addresses,
852 const struct GNUNET_PeerIdentity *peer,
853 enum GNUNET_ATS_PreferenceKind kind,
856 struct GAS_PROPORTIONAL_Handle *s = solver;
857 GNUNET_assert (NULL != solver);
858 GNUNET_assert (NULL != peer);
859 distribute_bandwidth_in_all_networks (s);
863 * Get the preferred address for a specific peer
865 * @param solver the solver handle
866 * @param addresses the address hashmap containing all addresses
867 * @param peer the identity of the peer
869 const struct ATS_Address *
870 GAS_proportional_get_preferred_address (void *solver,
871 struct GNUNET_CONTAINER_MultiHashMap * addresses,
872 const struct GNUNET_PeerIdentity *peer)
874 struct GAS_PROPORTIONAL_Handle *s = solver;
875 struct Network *net_prev;
876 struct Network *net_cur;
877 struct ATS_Address *cur;
878 struct ATS_Address *prev;
880 GNUNET_assert (s != NULL);
882 /* Get address with: stick to current address, lower distance, lower latency */
883 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
884 &find_best_address_it, &cur);
887 LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
891 LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
892 (GNUNET_NO == cur->active) ? "inactive" : "active",
893 cur, GNUNET_i2s (peer));
894 net_cur = (struct Network *) cur->solver_information;
897 LOG (GNUNET_ERROR_TYPE_ERROR, "Trying to suggesting unknown address peer `%s'\n",
902 if (GNUNET_YES == cur->active)
904 /* This address was selected previously, so no need to update quotas */
908 /* This address was not active, so we have to:
910 * - mark previous active address as not active
911 * - update quota for previous address network
912 * - update quota for this address network
915 prev = get_active_address (s, addresses, peer);
918 net_prev = (struct Network *) prev->solver_information;
919 prev->active = GNUNET_NO; /* No active any longer */
920 prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
921 prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
922 s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
923 if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
925 distribute_bandwidth_in_network (s, net_prev, NULL);
928 if (GNUNET_NO == (is_bandwidth_available_in_network (cur->solver_information)))
930 GNUNET_break (0); /* This should never happen*/
934 cur->active = GNUNET_YES;
935 addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
936 distribute_bandwidth_in_network (s, net_cur, cur);
943 * Stop notifying about address and bandwidth changes for this peer
945 * @param solver the solver handle
946 * @param addresses address hashmap
947 * @param peer the peer
950 GAS_proportional_stop_get_preferred_address (void *solver,
951 struct GNUNET_CONTAINER_MultiHashMap *addresses,
952 const struct GNUNET_PeerIdentity *peer)
959 * Remove an address from the solver
961 * @param solver the solver handle
962 * @param addresses the address hashmap containing all addresses
963 * @param address the address to remove
964 * @param session_only delete only session not whole address
967 GAS_proportional_address_delete (void *solver,
968 struct GNUNET_CONTAINER_MultiHashMap * addresses,
969 struct ATS_Address *address, int session_only)
971 struct GAS_PROPORTIONAL_Handle *s = solver;
973 struct AddressWrapper *aw;
975 /* Remove an adress completely, we have to:
976 * - Remove from specific network
977 * - Decrease number of total addresses
979 * - decrease number of active addreses
983 net = (struct Network *) address->solver_information;
985 if (GNUNET_NO == session_only)
987 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
988 (GNUNET_NO == address->active) ? "inactive" : "active",
989 address, GNUNET_i2s (&address->peer),
990 net->desc, net->total_addresses, net->active_addresses);
993 addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
994 for (aw = net->head; NULL != aw; aw = aw->next)
996 if (aw->addr == address)
1004 GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
1009 /* Remove session only: remove if active and update */
1010 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1011 (GNUNET_NO == address->active) ? "inactive" : "active",
1012 address, GNUNET_i2s (&address->peer),
1013 net->desc, net->total_addresses, net->active_addresses);
1016 if (GNUNET_YES == address->active)
1018 /* Address was active, remove from network and update quotas*/
1019 address->active = GNUNET_NO;
1020 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1022 distribute_bandwidth_in_network (s, net, NULL);
1024 LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
1025 net->total_addresses,
1026 net->active_addresses,
1033 * Add a new single address to a network
1035 * @param solver the solver Handle
1036 * @param addresses the address hashmap containing all addresses
1037 * @param address the address to add
1038 * @param network network type of this address
1041 GAS_proportional_address_add (void *solver,
1042 struct GNUNET_CONTAINER_MultiHashMap *addresses,
1043 struct ATS_Address *address,
1047 * Updates a single address in the solver and checks previous values
1049 * @param solver the solver Handle
1050 * @param addresses the address hashmap containing all addresses
1051 * @param address the update address
1052 * @param session the previous session
1053 * @param in_use the previous address in use state
1054 * @param prev_ats previous ATS information
1055 * @param prev_atsi_count the previous atsi count
1058 GAS_proportional_address_update (void *solver,
1059 struct GNUNET_CONTAINER_MultiHashMap *addresses,
1060 struct ATS_Address *address,
1063 const struct GNUNET_ATS_Information *prev_ats,
1064 uint32_t prev_atsi_count)
1066 struct ATS_Address *new;
1067 struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1069 uint32_t prev_value;
1072 int save_active = GNUNET_NO;
1073 struct Network *new_net = NULL;
1075 /* Check updates to performance information */
1076 for (i = 0; i < prev_atsi_count; i++)
1078 prev_type = ntohl (prev_ats[i].type);
1079 prev_value = ntohl (prev_ats[i].value);
1082 case GNUNET_ATS_UTILIZATION_UP:
1083 case GNUNET_ATS_UTILIZATION_DOWN:
1084 case GNUNET_ATS_QUALITY_NET_DELAY:
1085 case GNUNET_ATS_QUALITY_NET_DISTANCE:
1086 case GNUNET_ATS_COST_WAN:
1087 case GNUNET_ATS_COST_LAN:
1088 case GNUNET_ATS_COST_WLAN:
1089 /* No actions required here*/
1091 case GNUNET_ATS_NETWORK_TYPE:
1093 addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
1094 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
1097 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
1099 if (addr_net != prev_value)
1101 /* Network changed */
1102 LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
1103 (GNUNET_YES == address->active) ? "active" : "inactive",
1104 GNUNET_ATS_print_network_type(prev_value),
1105 GNUNET_ATS_print_network_type(addr_net));
1107 save_active = address->active;
1108 /* remove from old network */
1109 GAS_proportional_address_delete (solver, addresses, address, GNUNET_NO);
1111 /* set new network type */
1112 new_net = get_network (solver, addr_net);
1113 if (NULL == new_net)
1115 /* Address changed to invalid network... */
1116 LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot find network of type `%u' %s\n"),
1117 addr_net, GNUNET_ATS_print_network_type (addr_net));
1118 address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1119 address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1120 s->bw_changed (s->bw_changed_cls, address);
1123 address->solver_information = new_net;
1125 /* Add to new network and update*/
1126 GAS_proportional_address_add (solver, addresses, address, addr_net);
1127 if (GNUNET_YES == save_active)
1129 /* check if bandwidth available in new network */
1130 if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1132 /* Suggest updated address */
1133 address->active = GNUNET_YES;
1134 addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1135 distribute_bandwidth_in_network (solver, new_net, NULL);
1139 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
1141 /* Set old address to zero bw */
1142 address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1143 address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1144 s->bw_changed (s->bw_changed_cls, address);
1146 /* Find new address to suggest since no bandwidth in network*/
1147 new = (struct ATS_Address *) GAS_proportional_get_preferred_address (s, addresses, &address->peer);
1150 /* Have an alternative address to suggest */
1151 s->bw_changed (s->bw_changed_cls, new);
1159 case GNUNET_ATS_ARRAY_TERMINATOR:
1162 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1163 "Received unsupported ATS type %u\n", prev_type);
1170 if (address->session_id != session)
1172 LOG (GNUNET_ERROR_TYPE_DEBUG,
1173 "Session changed from %u to %u\n", session, address->session_id);
1175 if (address->used != in_use)
1177 LOG (GNUNET_ERROR_TYPE_DEBUG,
1178 "Usage changed from %u to %u\n", in_use, address->used);
1185 * Add a new single address to a network
1187 * @param solver the solver Handle
1188 * @param addresses the address hashmap containing all addresses
1189 * @param address the address to add
1190 * @param network network type of this address
1193 GAS_proportional_address_add (void *solver,
1194 struct GNUNET_CONTAINER_MultiHashMap *addresses,
1195 struct ATS_Address *address,
1198 struct GAS_PROPORTIONAL_Handle *s = solver;
1199 struct Network *net = NULL;
1200 struct AddressWrapper *aw = NULL;
1201 GNUNET_assert (NULL != s);
1203 net = get_network (s, network);
1210 aw = GNUNET_malloc (sizeof (struct AddressWrapper));
1212 GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
1213 addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1214 aw->addr->solver_information = net;
1216 LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
1217 net->total_addresses,
1218 net->active_addresses,
1224 * Init the proportional problem solver
1227 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
1228 * out_quota[i] contains outbound quota for network type i
1229 * in_quota[i] contains inbound quota for network type i
1232 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
1233 * network[2] == GNUNET_ATS_NET_LAN
1234 * out_quota[2] == 65353
1235 * in_quota[2] == 65353
1237 * @param cfg configuration handle
1238 * @param stats the GNUNET_STATISTICS handle
1239 * @param network array of GNUNET_ATS_NetworkType with length dest_length
1240 * @param out_quota array of outbound quotas
1241 * @param in_quota array of outbound quota
1242 * @param dest_length array length for quota arrays
1243 * @param bw_changed_cb callback for changed bandwidth amounts
1244 * @param bw_changed_cb_cls cls for callback
1245 * @param get_preference callback to get relative preferences for a peer
1246 * @param get_preference_cls cls for callback to get relative preferences
1247 * @return handle for the solver on success, NULL on fail
1250 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1251 const struct GNUNET_STATISTICS_Handle *stats,
1253 unsigned long long *out_quota,
1254 unsigned long long *in_quota,
1256 GAS_bandwidth_changed_cb bw_changed_cb,
1257 void *bw_changed_cb_cls,
1258 GAS_get_preferences get_preference,
1259 void *get_preference_cls)
1262 struct GAS_PROPORTIONAL_Handle *s = GNUNET_malloc (sizeof (struct GAS_PROPORTIONAL_Handle));
1263 struct Network * cur;
1264 char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1267 s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1268 s->bw_changed = bw_changed_cb;
1269 s->bw_changed_cls = bw_changed_cb_cls;
1270 s->get_preferences = get_preference;
1271 s->get_preferences_cls = get_preference_cls;
1272 s->networks = dest_length;
1273 s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
1274 s->active_addresses = 0;
1275 s->total_addresses = 0;
1277 for (c = 0; c < dest_length; c++)
1279 cur = &s->network_entries[c];
1280 cur->total_addresses = 0;
1281 cur->active_addresses = 0;
1282 cur->type = network[c];
1283 cur->total_quota_in = in_quota[c];
1284 cur->total_quota_out = out_quota[c];
1285 cur->desc = net_str[c];
1286 GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
1287 GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
1294 * Shutdown the proportional problem solver
1296 * @param solver the respective handle to shutdown
1299 GAS_proportional_done (void *solver)
1301 struct GAS_PROPORTIONAL_Handle *s = solver;
1302 struct AddressWrapper *cur;
1303 struct AddressWrapper *next;
1305 GNUNET_assert (s != NULL);
1307 for (c = 0; c < s->networks; c++)
1309 if (s->network_entries[c].total_addresses > 0)
1311 LOG (GNUNET_ERROR_TYPE_ERROR,
1312 "Had %u addresses for network `%s' not deleted during shutdown\n",
1313 s->network_entries[c].total_addresses,
1314 s->network_entries[c].desc);
1318 if (s->network_entries[c].active_addresses > 0)
1320 LOG (GNUNET_ERROR_TYPE_ERROR,
1321 "Had %u active addresses for network `%s' not deleted during shutdown\n",
1322 s->network_entries[c].active_addresses,
1323 s->network_entries[c].desc);
1327 next = s->network_entries[c].head;
1328 while (NULL != (cur = next))
1331 GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1332 s->network_entries[c].tail,
1336 GNUNET_free (s->network_entries[c].stat_total);
1337 GNUNET_free (s->network_entries[c].stat_active);
1339 if (s->total_addresses > 0)
1341 LOG (GNUNET_ERROR_TYPE_ERROR,
1342 "Had %u addresses not deleted during shutdown\n",
1343 s->total_addresses);
1346 if (s->active_addresses > 0)
1348 LOG (GNUNET_ERROR_TYPE_ERROR,
1349 "Had %u active addresses not deleted during shutdown\n",
1350 s->active_addresses);
1353 GNUNET_free (s->network_entries);
1358 /* end of gnunet-service-ats-solver_proportional.c */