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-service-ats_normalization.h"
31 #include "gnunet_statistics_service.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
37 * NOTE: Do not change this documentation. This documentation is based
38 * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
39 * use build_txt.sh to generate plaintext output
41 * ATS addresses : simplistic solver
43 * The simplistic solver ("simplistic") distributes the available
44 * bandwidth fair over all the addresses influenced by the
45 * preference values. For each available network type an in- and
46 * outbound quota is configured and the bandwidth available in
47 * these networks is distributed over the addresses. The solver
48 * first assigns every addresses the minimum amount of bandwidth
49 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
50 * remaining bandwidth available according to the preference
51 * values. For each peer only a single address gets bandwidth
52 * assigned and only one address marked as active. The most
53 * important functionality for the solver is implemented in: *
54 * find_address_it is an hashmap iterator returning the prefered
55 * address for an peer * update_quota_per_network distributes
56 * available bandwidth for a network over active addresses
58 * Changes to addresses automatically have an impact on the the
59 * bandwidth assigned to other addresses in the same network since
60 * the solver distributes the remaining bandwidth over the
61 * addresses in the network. When changes to the addresses occur,
62 * the solver first performs the changes, like adding or deleting
63 * addresses, and then updates bandwidth assignment for the
64 * affected network. Bandwidth assignment is only recalculated on
65 * demand when an address is requested by a client for a peer or
66 * when the addresses available have changed or an address changed
67 * the network it is located in. When the bandwidth assignment has
68 * changed the callback is called with the new bandwidth
69 * assignments. The bandwidth distribution for a network is
70 * recalculated due to: * address suggestion requests * address
71 * deletions * address switching networks during address update *
74 * 3.1 Data structures used
76 * For each ATS network (e.g. WAN, LAN, loopback) a struct Network
77 * is used to specify network related information as total adresses
78 * and active addresses in this network and the configured in- and
79 * outbound quota. Each network also contains a list of addresses
80 * added to the solver located in this network. The simplistic
81 * solver uses the addresses' solver_information field to store the
82 * simplistic network it belongs to for each address.
86 * When the simplistic solver is initialized the solver creates a
87 * new solver handle and initializes the network structures with
88 * the quotas passed from addresses and returns the handle solver.
90 * 3.3 Adding an address
92 * When a new address is added to the solver using s_add, a lookup
93 * for the network for this address is done and the address is
94 * enqueued in in the linked list of the network.
96 * 3.4 Updating an address
98 * The main purpose of address updates is to update the ATS
99 * information for addresse selection. Important for the simplistic
100 * solver is when an address switches network it is located
101 * in. This is common because addresses added by transport's
102 * validation mechanism are commonly located in
103 * GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
104 * in this network type and only if a connection is successful on
105 * return of payload data transport switches to the real network
106 * the address is located in. When an address changes networks it
107 * is first of all removed from the old network using the solver
108 * API function GAS_simplistic_address_delete and the network in
109 * the address struct is updated. A lookup for the respective new
110 * simplistic network is done and stored in the addresse's
111 * solver_information field. Next the address is re-added to the
112 * solver using the solver API function
113 * GAS_simplistic_address_add. If the address was marked as in
114 * active, the solver checks if bandwidth is available in the
115 * network and if yes sets the address to active and updates the
116 * bandwidth distribution in this network. If no bandwidth is
117 * available it sets the bandwidth for this address to 0 and tries
118 * to suggest an alternative address. If an alternative address was
119 * found, addresses' callback is called for this address.
121 * 3.5 Deleting an address
123 * When an address is removed from the solver, it removes the
124 * respective address from the network and if the address was
125 * marked as active, it updates the bandwidth distribution for this
128 * 3.6 Requesting addresses
130 * When an address is requested for a peer the solver performs a
131 * lookup for the peer entry in addresses address hashmap and
132 * selects the best address. The selection of the most suitable
133 * address is done in the find_address_it hashmap iterator
134 * described in detail in section 3.7. If no address is returned,
135 * no address can be suggested at the moment. If the address
136 * returned is marked as active, the solver can return this
137 * address. If the address is not marked as active, the solver
138 * checks if another address belongign to this peer is marked as
139 * active and marks the address as inactive, updates the bandwidth
140 * for this address to 0, call the bandwidth changed callback for
141 * this address due to the change and updates quota assignment for
142 * the addresse's network. the now in-active address is belonging
143 * to. The solver marks the new address as active and updates the
144 * bandwidth assignment for this network.
146 * 3.7 Choosing addresses
148 * Choosing the best possible address for suggestion is done by
149 * iterating over all addresses of a peer stored in addresses'
150 * hashmap and using the hashmap iterator find_address_it to select
151 * the best available address. Several checks are done when an
152 * address is selected. First if this address is currently blocked
153 * by addresses from being suggested. An address is blocked for the
154 * duration of ATS_BLOCKING_DELTA when it is suggested to
155 * transport. Next it is checked if at least
156 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
157 * in the addresse's network, because suggesting an address without
158 * bandwidth does not make sense. This also ensures that all active
159 * addresses in this network get at least the minimum amount of
160 * bandwidth assigned. In the next step the solver ensures that for
161 * tcp connections inbound connections are prefered over outbound
162 * connections. In the next stet the solver ensures that
163 * connections are prefered in the following order: * connections
164 * are already established and have bandwidth assigned *
165 * connections with a shorter distance * connectes have a shorter
168 * 3.8 Changing preferences
172 * During shutdown all network entries and aging processes are
173 * destroyed and freed.
178 * This solver assigns in and outbound bandwidth equally for all
179 * addresses in specific network type (WAN, LAN) based on configured
180 * in and outbound quota for this network.
182 * The solver is notified by addresses about changes to the addresses
183 * and recalculates the bandwith assigned if required. The solver
184 * notifies addresses by calling the GAS_bandwidth_changed_cb
192 * For each peer only a single is selected and marked as "active" in the address
197 * You have the networks WAN and LAN and quotas
198 * WAN_TOTAL_IN, WAN_TOTAL_OUT
199 * LAN_TOTAL_IN, LAN_TOTAL_OUT
201 * If you have x addresses in the network segment LAN, the quotas are
202 * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
204 * Quotas are automatically recalculated and reported back when addresses are
209 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
210 #define PREF_AGING_FACTOR 0.95
212 #define DEFAULT_REL_PREFERENCE 1.0
213 #define DEFAULT_ABS_PREFERENCE 0.0
214 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
218 * A handle for the proportional solver
220 struct GAS_PROPORTIONAL_Handle
226 struct GNUNET_STATISTICS_Handle *stats;
229 * Total number of addresses for solver
231 unsigned int total_addresses;
234 * Number of active addresses for solver
236 unsigned int active_addresses;
241 struct Network *network_entries;
246 unsigned int networks;
251 GAS_bandwidth_changed_cb bw_changed;
256 void *bw_changed_cls;
258 struct GNUNET_CONTAINER_MultiHashMap *prefs;
260 struct PreferenceClient *pc_head;
261 struct PreferenceClient *pc_tail;
266 * Representation of a network
276 * Network description
281 * Total inbound quota
284 unsigned long long total_quota_in;
287 * Total outbound quota
290 unsigned long long total_quota_out;
293 * Number of active addresses for this network
295 unsigned int active_addresses;
298 * Number of total addresses for this network
300 unsigned int total_addresses;
303 * String for statistics total addresses
308 * String for statistics active addresses
312 struct AddressWrapper *head;
313 struct AddressWrapper *tail;
318 * Wrapper for addresses to store them in network's linked list
320 struct AddressWrapper
325 struct AddressWrapper *next;
330 struct AddressWrapper *prev;
335 struct ATS_Address *addr;
341 * Important solver functions
342 * ---------------------------
346 * Test if bandwidth is available in this network to add an additional address
348 * @param net the network type to update
349 * @return GNUNET_YES or GNUNET_NO
352 is_bandwidth_available_in_network (struct Network *net)
354 unsigned int na = net->active_addresses + 1;
355 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
356 if (((net->total_quota_in / na) > min_bw) &&
357 ((net->total_quota_out / na) > min_bw))
359 LOG (GNUNET_ERROR_TYPE_DEBUG,
360 "Enough bandwidth available for %u active addresses in network `%s'\n",
366 LOG (GNUNET_ERROR_TYPE_DEBUG,
367 "Not enough bandwidth available for %u active addresses in network `%s'\n",
375 * Update bandwidth assigned to peers in this network
377 * @param s the solver handle
378 * @param net the network type to update
379 * @param address_except address excluded from notification, since we suggest
383 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
385 struct ATS_Address *address_except)
387 unsigned long long remaining_quota_in = 0;
388 unsigned long long quota_out_used = 0;
390 unsigned long long remaining_quota_out = 0;
391 unsigned long long quota_in_used = 0;
392 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
394 double total_prefs; /* Important: has to be double not float due to precision */
395 double cur_pref; /* Important: has to be double not float due to precision */
396 const double *t = NULL; /* Important: has to be double not float due to precision */
399 unsigned long long assigned_quota_in = 0;
400 unsigned long long assigned_quota_out = 0;
401 struct AddressWrapper *cur;
403 LOG (GNUNET_ERROR_TYPE_DEBUG,
404 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
405 net->desc, net->active_addresses, net->total_quota_in, net->total_quota_in);
407 if (net->active_addresses == 0)
408 return; /* no addresses to update */
411 * Assign every peer in network minimum Bandwidth
412 * Distribute bandwidth left according to preference
415 if ((net->active_addresses * min_bw) > net->total_quota_in)
420 if ((net->active_addresses * min_bw) > net->total_quota_out)
426 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
427 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
428 LOG (GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
429 remaining_quota_in, remaining_quota_out);
431 for (cur = net->head; NULL != cur; cur = cur->next)
433 if (GNUNET_YES == cur->addr->active)
435 t = GAS_normalization_get_preferences (&cur->addr->peer);
438 total_prefs += DEFAULT_REL_PREFERENCE;
443 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
445 if (c != GNUNET_ATS_PREFERENCE_END)
447 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
451 total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount -1));
455 for (cur = net->head; NULL != cur; cur = cur->next)
457 if (GNUNET_YES == cur->addr->active)
460 t = GAS_normalization_get_preferences (&cur->addr->peer);
463 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
465 if (c != GNUNET_ATS_PREFERENCE_END)
472 cur_pref = DEFAULT_REL_PREFERENCE;
475 assigned_quota_in = min_bw + ((cur_pref / total_prefs) * remaining_quota_in);
476 assigned_quota_out = min_bw + ((cur_pref / total_prefs) * remaining_quota_out);
478 LOG (GNUNET_ERROR_TYPE_DEBUG,
479 "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
480 GNUNET_i2s (&cur->addr->peer),
481 cur_pref, total_prefs,
482 assigned_quota_in, assigned_quota_out);
486 assigned_quota_in = 0;
487 assigned_quota_out = 0;
490 quota_in_used += assigned_quota_in;
491 quota_out_used += assigned_quota_out;
492 /* Prevent overflow due to rounding errors */
493 if (assigned_quota_in > UINT32_MAX)
494 assigned_quota_in = UINT32_MAX;
495 if (assigned_quota_out > UINT32_MAX)
496 assigned_quota_out = UINT32_MAX;
498 /* Compare to current bandwidth assigned */
499 if ((assigned_quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
500 (assigned_quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
502 cur->addr->assigned_bw_in.value__ = htonl (assigned_quota_in);
503 cur->addr->assigned_bw_out.value__ = htonl (assigned_quota_out);
504 /* Notify on change */
505 if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
506 s->bw_changed (s->bw_changed_cls, cur->addr);
510 LOG (GNUNET_ERROR_TYPE_DEBUG,
511 "Total bandwidth assigned is (in/out): %llu /%llu\n",
514 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
516 LOG (GNUNET_ERROR_TYPE_ERROR,
517 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
518 net->active_addresses,
520 net->total_quota_out);
522 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
524 LOG (GNUNET_ERROR_TYPE_ERROR,
525 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
526 net->active_addresses,
528 net->total_quota_in);
534 * Extract an ATS performance info from an address
536 * @param address the address
537 * @param type the type to extract in HBO
538 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
541 get_performance_info (struct ATS_Address *address, uint32_t type);
544 * Find a "good" address to use for a peer by iterating over the addresses for this peer.
545 * If we already have an existing address, we stick to it.
546 * Otherwise, we pick by lowest distance and then by lowest latency.
548 * @param cls the 'struct ATS_Address**' where we store the result
550 * @param value another 'struct ATS_Address*' to consider using
551 * @return GNUNET_OK (continue to iterate)
554 find_best_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
556 struct ATS_Address **previous_p = cls;
557 struct ATS_Address *current = (struct ATS_Address *) value;
558 struct ATS_Address *previous = *previous_p;
559 struct GNUNET_TIME_Absolute now;
560 struct Network *net = (struct Network *) current->solver_information;
561 uint32_t p_distance_cur;
562 uint32_t p_distance_prev;
563 uint32_t p_delay_cur;
564 uint32_t p_delay_prev;
566 now = GNUNET_TIME_absolute_get();
568 if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
570 /* This address is blocked for suggestion */
571 LOG (GNUNET_ERROR_TYPE_DEBUG,
572 "Address %p blocked for suggestion for %llu ms \n",
574 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
578 if (GNUNET_NO == is_bandwidth_available_in_network (net))
579 return GNUNET_OK; /* There's no bandwidth available in this network */
581 if (NULL != previous)
583 GNUNET_assert (NULL != previous->plugin);
584 GNUNET_assert (NULL != current->plugin);
585 if (0 == strcmp (previous->plugin, current->plugin))
587 if ((0 != previous->addr_len) &&
588 (0 == current->addr_len))
590 /* saved address was an outbound address, but we have an inbound address */
591 *previous_p = current;
594 if (0 == previous->addr_len)
596 /* saved address was an inbound address, so do not overwrite */
602 if (NULL == previous)
604 *previous_p = current;
607 if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
608 (ntohl (current->assigned_bw_in.value__) > 0))
610 /* stick to existing connection */
611 *previous_p = current;
615 p_distance_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DISTANCE);
616 p_distance_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DISTANCE);
617 if ((p_distance_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_distance_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
618 (p_distance_prev > p_distance_cur))
620 /* user shorter distance */
621 *previous_p = current;
625 p_delay_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DELAY);
626 p_delay_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DELAY);
627 if ((p_delay_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_delay_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
628 (p_delay_prev > p_delay_cur))
630 /* user lower latency */
631 *previous_p = current;
641 * ---------------------------
645 * Update bandwidth assignment for all networks
647 * @param s the solver handle
650 distribute_bandwidth_in_all_networks (struct GAS_PROPORTIONAL_Handle *s)
653 for (i = 0; i < s->networks; i++)
654 distribute_bandwidth_in_network (s, &s->network_entries[i], NULL);
660 * Lookup network struct by type
662 * @param s the solver handle
663 * @param type the network type
664 * @return the network struct
666 static struct Network *
667 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
670 for (c = 0 ; c < s->networks; c++)
672 if (s->network_entries[c].type == type)
673 return &s->network_entries[c];
680 * Hashmap Iterator to find current active address for peer
682 * @param cls last active address
683 * @param key peer's key
684 * @param value address to check
685 * @return GNUNET_NO on double active address else GNUNET_YES
688 get_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
690 struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
691 struct ATS_Address * aa = (struct ATS_Address *) value;
693 if (GNUNET_YES == aa->active)
697 /* should never happen */
698 LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
709 * Find current active address for peer
711 * @param solver the solver handle
712 * @param addresses the address set
713 * @param peer the peer
714 * @return active address or NULL
716 static struct ATS_Address *
717 get_active_address (void *solver,
718 struct GNUNET_CONTAINER_MultiHashMap * addresses,
719 const struct GNUNET_PeerIdentity *peer)
721 struct ATS_Address * dest = NULL;
723 GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
725 &get_active_address_it, &dest);
732 addresse_increment (struct GAS_PROPORTIONAL_Handle *s,
737 if (GNUNET_YES == total)
739 s->total_addresses ++;
740 net->total_addresses ++;
741 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
742 GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
744 if (GNUNET_YES == active)
746 net->active_addresses ++;
747 s->active_addresses ++;
748 GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
749 GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
756 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
762 if (GNUNET_YES == total)
764 if (s->total_addresses < 1)
771 s->total_addresses --;
772 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
774 if (net->total_addresses < 1)
781 net->total_addresses --;
782 GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
786 if (GNUNET_YES == active)
788 if (net->active_addresses < 1)
795 net->active_addresses --;
796 GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
798 if (s->active_addresses < 1)
805 s->active_addresses --;
806 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
814 * Extract an ATS performance info from an address
816 * @param address the address
817 * @param type the type to extract in HBO
818 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
821 get_performance_info (struct ATS_Address *address, uint32_t type)
824 GNUNET_assert (NULL != address);
826 if ((NULL == address->atsi) || (0 == address->atsi_count))
827 return GNUNET_ATS_VALUE_UNDEFINED;
829 for (c1 = 0; c1 < address->atsi_count; c1++)
831 if (ntohl(address->atsi[c1].type) == type)
832 return ntohl(address->atsi[c1].value);
834 return GNUNET_ATS_VALUE_UNDEFINED;
839 * Solver API functions
840 * ---------------------------
844 * Changes the preferences for a peer in the problem
846 * @param solver the solver handle
847 * @param client the client with this preference
848 * @param peer the peer to change the preference for
849 * @param kind the kind to change the preference
850 * @param pref_rel the normalized preference value for this kind over all clients
851 * @param score the score
854 GAS_proportional_address_change_preference (void *solver,
856 const struct GNUNET_PeerIdentity *peer,
857 enum GNUNET_ATS_PreferenceKind kind,
860 struct GAS_PROPORTIONAL_Handle *s = solver;
861 GNUNET_assert (NULL != solver);
862 GNUNET_assert (NULL != client);
863 GNUNET_assert (NULL != peer);
865 distribute_bandwidth_in_all_networks (s);
870 * Get the preferred address for a specific peer
872 * @param solver the solver handle
873 * @param addresses the address hashmap containing all addresses
874 * @param peer the identity of the peer
876 const struct ATS_Address *
877 GAS_proportional_get_preferred_address (void *solver,
878 struct GNUNET_CONTAINER_MultiHashMap * addresses,
879 const struct GNUNET_PeerIdentity *peer)
881 struct GAS_PROPORTIONAL_Handle *s = solver;
882 struct Network *net_prev;
883 struct Network *net_cur;
884 struct ATS_Address *cur;
885 struct ATS_Address *prev;
887 GNUNET_assert (s != NULL);
889 /* Get address with: stick to current address, lower distance, lower latency */
890 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
891 &find_best_address_it, &cur);
894 LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
898 LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
899 (GNUNET_NO == cur->active) ? "inactive" : "active",
900 cur, GNUNET_i2s (peer));
901 net_cur = (struct Network *) cur->solver_information;
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 address->solver_information = new_net;
1115 /* Add to new network and update*/
1116 GAS_proportional_address_add (solver, addresses, address, addr_net);
1117 if (GNUNET_YES == save_active)
1119 /* check if bandwidth available in new network */
1120 if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1122 /* Suggest updated address */
1123 address->active = GNUNET_YES;
1124 addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1125 distribute_bandwidth_in_network (solver, new_net, NULL);
1129 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
1131 /* Set old address to zero bw */
1132 address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1133 address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1134 s->bw_changed (s->bw_changed_cls, address);
1136 /* Find new address to suggest since no bandwidth in network*/
1137 new = (struct ATS_Address *) GAS_proportional_get_preferred_address (s, addresses, &address->peer);
1140 /* Have an alternative address to suggest */
1141 s->bw_changed (s->bw_changed_cls, new);
1149 case GNUNET_ATS_ARRAY_TERMINATOR:
1152 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1153 "Received unsupported ATS type %u\n", prev_type);
1160 if (address->session_id != session)
1162 LOG (GNUNET_ERROR_TYPE_DEBUG,
1163 "Session changed from %u to %u\n", session, address->session_id);
1165 if (address->used != in_use)
1167 LOG (GNUNET_ERROR_TYPE_DEBUG,
1168 "Usage changed from %u to %u\n", in_use, address->used);
1175 * Add a new single address to a network
1177 * @param solver the solver Handle
1178 * @param addresses the address hashmap containing all addresses
1179 * @param address the address to add
1180 * @param network network type of this address
1183 GAS_proportional_address_add (void *solver,
1184 struct GNUNET_CONTAINER_MultiHashMap *addresses,
1185 struct ATS_Address *address,
1188 struct GAS_PROPORTIONAL_Handle *s = solver;
1189 struct Network *net = NULL;
1190 struct AddressWrapper *aw = NULL;
1191 GNUNET_assert (NULL != s);
1193 net = get_network (s, network);
1200 aw = GNUNET_malloc (sizeof (struct AddressWrapper));
1202 GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
1203 addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1204 aw->addr->solver_information = net;
1206 LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
1207 net->total_addresses,
1208 net->active_addresses,
1214 * Init the proportional problem solver
1217 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
1218 * out_quota[i] contains outbound quota for network type i
1219 * in_quota[i] contains inbound quota for network type i
1222 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
1223 * network[2] == GNUNET_ATS_NET_LAN
1224 * out_quota[2] == 65353
1225 * in_quota[2] == 65353
1227 * @param cfg configuration handle
1228 * @param stats the GNUNET_STATISTICS handle
1229 * @param network array of GNUNET_ATS_NetworkType with length dest_length
1230 * @param out_quota array of outbound quotas
1231 * @param in_quota array of outbound quota
1232 * @param dest_length array length for quota arrays
1233 * @param bw_changed_cb callback for changed bandwidth amounts
1234 * @param bw_changed_cb_cls cls for callback
1235 * @return handle for the solver on success, NULL on fail
1238 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1239 const struct GNUNET_STATISTICS_Handle *stats,
1241 unsigned long long *out_quota,
1242 unsigned long long *in_quota,
1244 GAS_bandwidth_changed_cb bw_changed_cb,
1245 void *bw_changed_cb_cls)
1248 struct GAS_PROPORTIONAL_Handle *s = GNUNET_malloc (sizeof (struct GAS_PROPORTIONAL_Handle));
1249 struct Network * cur;
1250 char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1253 s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1254 s->bw_changed = bw_changed_cb;
1255 s->bw_changed_cls = bw_changed_cb_cls;
1256 s->networks = dest_length;
1257 s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
1258 s->active_addresses = 0;
1259 s->total_addresses = 0;
1260 s->prefs = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1262 for (c = 0; c < dest_length; c++)
1264 cur = &s->network_entries[c];
1265 cur->total_addresses = 0;
1266 cur->active_addresses = 0;
1267 cur->type = network[c];
1268 cur->total_quota_in = in_quota[c];
1269 cur->total_quota_out = out_quota[c];
1270 cur->desc = net_str[c];
1271 GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
1272 GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
1279 * Shutdown the proportional problem solver
1281 * @param solver the respective handle to shutdown
1284 GAS_proportional_done (void *solver)
1286 struct GAS_PROPORTIONAL_Handle *s = solver;
1287 struct AddressWrapper *cur;
1288 struct AddressWrapper *next;
1290 GNUNET_assert (s != NULL);
1292 for (c = 0; c < s->networks; c++)
1294 if (s->network_entries[c].total_addresses > 0)
1296 LOG (GNUNET_ERROR_TYPE_ERROR,
1297 "Had %u addresses for network `%s' not deleted during shutdown\n",
1298 s->network_entries[c].total_addresses,
1299 s->network_entries[c].desc);
1303 if (s->network_entries[c].active_addresses > 0)
1305 LOG (GNUNET_ERROR_TYPE_ERROR,
1306 "Had %u active addresses for network `%s' not deleted during shutdown\n",
1307 s->network_entries[c].active_addresses,
1308 s->network_entries[c].desc);
1312 next = s->network_entries[c].head;
1313 while (NULL != (cur = next))
1316 GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1317 s->network_entries[c].tail,
1321 GNUNET_free (s->network_entries[c].stat_total);
1322 GNUNET_free (s->network_entries[c].stat_active);
1324 if (s->total_addresses > 0)
1326 LOG (GNUNET_ERROR_TYPE_ERROR,
1327 "Had %u addresses not deleted during shutdown\n",
1328 s->total_addresses);
1331 if (s->active_addresses > 0)
1333 LOG (GNUNET_ERROR_TYPE_ERROR,
1334 "Had %u active addresses not deleted during shutdown\n",
1335 s->active_addresses);
1338 GNUNET_free (s->network_entries);
1343 /* end of gnunet-service-ats-solver_proportional.c */