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/plugin_ats_proportional.c
23 * @brief ATS proportional solver
24 * @author Matthias Wachs
25 * @author Christian Grothoff
27 #include "plugin_ats_proportional.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
34 * NOTE: Do not change this documentation. This documentation is based
35 * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
36 * use build_txt.sh to generate plaintext output
38 * ATS addresses : proportional solver
40 * The proportional solver ("proportional") distributes the available
41 * bandwidth fair over all the addresses influenced by the
42 * preference values. For each available network type an in- and
43 * outbound quota is configured and the bandwidth available in
44 * these networks is distributed over the addresses. The solver
45 * first assigns every addresses the minimum amount of bandwidth
46 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
47 * remaining bandwidth available according to the preference
48 * values. For each peer only a single address gets bandwidth
49 * assigned and only one address marked as active. The most
50 * important functionality for the solver is implemented in: *
51 * find_address_it is an hashmap iterator returning the prefered
52 * address for an peer * update_quota_per_network distributes
53 * available bandwidth for a network over active addresses
55 * Changes to addresses automatically have an impact on the the
56 * bandwidth assigned to other addresses in the same network since
57 * the solver distributes the remaining bandwidth over the
58 * addresses in the network. When changes to the addresses occur,
59 * the solver first performs the changes, like adding or deleting
60 * addresses, and then updates bandwidth assignment for the
61 * affected network. Bandwidth assignment is only recalculated on
62 * demand when an address is requested by a client for a peer or
63 * when the addresses available have changed or an address changed
64 * the network it is located in. When the bandwidth assignment has
65 * changed the callback is called with the new bandwidth
66 * assignments. The bandwidth distribution for a network is
67 * recalculated due to: * address suggestion requests * address
68 * deletions * address switching networks during address update *
71 * 3.1 Data structures used
73 * For each ATS network (e.g. WAN, LAN, loopback) a struct Network
74 * is used to specify network related information as total adresses
75 * and active addresses in this network and the configured in- and
76 * outbound quota. Each network also contains a list of addresses
77 * added to the solver located in this network. The proportional
78 * solver uses the addresses' solver_information field to store the
79 * proportional network it belongs to for each address.
83 * When the proportional solver is initialized the solver creates a
84 * new solver handle and initializes the network structures with
85 * the quotas passed from addresses and returns the handle solver.
87 * 3.3 Adding an address
89 * When a new address is added to the solver using s_add, a lookup
90 * for the network for this address is done and the address is
91 * enqueued in in the linked list of the network.
93 * 3.4 Updating an address
95 * The main purpose of address updates is to update the ATS
96 * information for addresse selection. Important for the proportional
97 * solver is when an address switches network it is located
98 * in. This is common because addresses added by transport's
99 * validation mechanism are commonly located in
100 * GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
101 * in this network type and only if a connection is successful on
102 * return of payload data transport switches to the real network
103 * the address is located in. When an address changes networks it
104 * is first of all removed from the old network using the solver
105 * API function GAS_proportional_address_delete and the network in
106 * the address struct is updated. A lookup for the respective new
107 * proportional network is done and stored in the addresse's
108 * solver_information field. Next the address is re-added to the
109 * solver using the solver API function
110 * GAS_proportional_address_add. If the address was marked as in
111 * active, the solver checks if bandwidth is available in the
112 * network and if yes sets the address to active and updates the
113 * bandwidth distribution in this network. If no bandwidth is
114 * available it sets the bandwidth for this address to 0 and tries
115 * to suggest an alternative address. If an alternative address was
116 * found, addresses' callback is called for this address.
118 * 3.5 Deleting an address
120 * When an address is removed from the solver, it removes the
121 * respective address from the network and if the address was
122 * marked as active, it updates the bandwidth distribution for this
125 * 3.6 Requesting addresses
127 * When an address is requested for a peer the solver performs a
128 * lookup for the peer entry in addresses address hashmap and
129 * selects the best address. The selection of the most suitable
130 * address is done in the find_address_it hashmap iterator
131 * described in detail in section 3.7. If no address is returned,
132 * no address can be suggested at the moment. If the address
133 * returned is marked as active, the solver can return this
134 * address. If the address is not marked as active, the solver
135 * checks if another address belongign to this peer is marked as
136 * active and marks the address as inactive, updates the bandwidth
137 * for this address to 0, call the bandwidth changed callback for
138 * this address due to the change and updates quota assignment for
139 * the addresse's network. the now in-active address is belonging
140 * to. The solver marks the new address as active and updates the
141 * bandwidth assignment for this network.
143 * 3.7 Choosing addresses
145 * Choosing the best possible address for suggestion is done by
146 * iterating over all addresses of a peer stored in addresses'
147 * hashmap and using the hashmap iterator find_address_it to select
148 * the best available address. Several checks are done when an
149 * address is selected. First if this address is currently blocked
150 * by addresses from being suggested. An address is blocked for the
151 * duration of ATS_BLOCKING_DELTA when it is suggested to
152 * transport. Next it is checked if at least
153 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
154 * in the addresse's network, because suggesting an address without
155 * bandwidth does not make sense. This also ensures that all active
156 * addresses in this network get at least the minimum amount of
157 * bandwidth assigned. In the next step the solver ensures that for
158 * tcp connections inbound connections are prefered over outbound
159 * connections. In the next stet the solver ensures that
160 * connections are prefered in the following order: * connections
161 * are already established and have bandwidth assigned *
162 * connections with a shorter distance * connectes have a shorter
165 * 3.8 Changing preferences
169 * During shutdown all network entries and aging processes are
170 * destroyed and freed.
175 * This solver assigns in and outbound bandwidth equally for all
176 * addresses in specific network type (WAN, LAN) based on configured
177 * in and outbound quota for this network.
179 * The solver is notified by addresses about changes to the addresses
180 * and recalculates the bandwith assigned if required. The solver
181 * notifies addresses by calling the GAS_bandwidth_changed_cb
189 * For each peer only a single is selected and marked as "active" in the address
194 * You have the networks WAN and LAN and quotas
195 * WAN_TOTAL_IN, WAN_TOTAL_OUT
196 * LAN_TOTAL_IN, LAN_TOTAL_OUT
198 * If you have x addresses in the network segment LAN, the quotas are
199 * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
201 * Quotas are automatically recalculated and reported back when addresses are
206 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
207 #define PREF_AGING_FACTOR 0.95
209 #define DEFAULT_REL_PREFERENCE 1.0
210 #define DEFAULT_ABS_PREFERENCE 0.0
211 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
214 * A handle for the proportional solver
216 struct GAS_PROPORTIONAL_Handle
218 struct GNUNET_ATS_PluginEnvironment *env;
223 struct GNUNET_STATISTICS_Handle *stats;
226 * Hashmap containing all valid addresses
228 const struct GNUNET_CONTAINER_MultiPeerMap *addresses;
231 * Pending address requests
233 struct GNUNET_CONTAINER_MultiPeerMap *requests;
236 * Bandwidth changed callback
238 GAS_bandwidth_changed_cb bw_changed;
241 * Bandwidth changed callback cls
243 void *bw_changed_cls;
246 * ATS function to get preferences
248 GAS_get_preferences get_preferences;
251 * Closure for ATS function to get preferences
253 void *get_preferences_cls;
256 * ATS function to get properties
258 GAS_get_properties get_properties;
261 * Closure for ATS function to get properties
263 void *get_properties_cls;
271 * Number of changes while solver was locked
276 * Total number of addresses for solver
278 unsigned int total_addresses;
281 * Number of active addresses for solver
283 unsigned int active_addresses;
288 struct Network *network_entries;
293 unsigned int network_count;
298 * Representation of a network
308 * Network description
313 * Total inbound quota
316 unsigned long long total_quota_in;
319 * Total outbound quota
322 unsigned long long total_quota_out;
325 * Number of active addresses for this network
327 unsigned int active_addresses;
330 * Number of total addresses for this network
332 unsigned int total_addresses;
335 * String for statistics total addresses
340 * String for statistics active addresses
344 struct AddressWrapper *head;
345 struct AddressWrapper *tail;
349 * Address information stored in the solver
351 struct AddressSolverInformation
353 struct Network *network;
359 unsigned long long calculated_quota_in_NBO;
365 unsigned long long calculated_quota_out_NBO;
371 * Wrapper for addresses to store them in network's linked list
373 struct AddressWrapper
378 struct AddressWrapper *next;
383 struct AddressWrapper *prev;
388 struct ATS_Address *addr;
392 * Important solver functions
393 * ---------------------------
397 libgnunet_plugin_ats_proportional_init (void *cls)
399 struct GNUNET_ATS_PluginEnvironment *env = cls;
400 struct GAS_PROPORTIONAL_Handle *s;
401 struct Network * cur;
402 char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
405 GNUNET_assert (NULL != env);
406 GNUNET_assert(NULL != env->cfg);
407 GNUNET_assert(NULL != env->bandwidth_changed_cb);
408 GNUNET_assert(NULL != env->get_preferences);
409 GNUNET_assert(NULL != env->get_property);
411 s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
413 env->sf.s_add = &GAS_proportional_address_add;
414 env->sf.s_address_update_property = &GAS_proportional_address_property_changed;
415 env->sf.s_address_update_session = &GAS_proportional_address_session_changed;
416 env->sf.s_address_update_inuse = &GAS_proportional_address_inuse_changed;
417 env->sf.s_address_update_network = &GAS_proportional_address_change_network;
418 env->sf.s_get = &GAS_proportional_get_preferred_address;
419 env->sf.s_get_stop = &GAS_proportional_stop_get_preferred_address;
420 env->sf.s_pref = &GAS_proportional_address_change_preference;
421 env->sf.s_feedback = &GAS_proportional_address_preference_feedback;
422 env->sf.s_del = &GAS_proportional_address_delete;
423 env->sf.s_bulk_start = &GAS_proportional_bulk_start;
424 env->sf.s_bulk_stop = &GAS_proportional_bulk_stop;
426 s->stats = (struct GNUNET_STATISTICS_Handle *) env->stats;
427 s->bw_changed = env->bandwidth_changed_cb;
428 s->bw_changed_cls = env->bw_changed_cb_cls;
429 s->get_preferences = env->get_preferences;
430 s->get_preferences_cls = env->get_preference_cls;
431 s->get_properties = env->get_property;
432 s->get_properties_cls = env->get_property_cls;
433 s->network_count = env->network_count;
434 s->network_entries = GNUNET_malloc (env->network_count * sizeof (struct Network));
437 s->active_addresses = 0;
438 s->total_addresses = 0;
439 s->bulk_lock = GNUNET_NO;
440 s->addresses = env->addresses;
441 s->requests = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
443 for (c = 0; c < env->network_count; c++)
445 cur = &s->network_entries[c];
446 cur->total_addresses = 0;
447 cur->active_addresses = 0;
448 cur->type = env->networks[c];
449 cur->total_quota_in = env->in_quota[c];
450 cur->total_quota_out = env->out_quota[c];
451 cur->desc = net_str[c];
452 GNUNET_asprintf (&cur->stat_total,
453 "# ATS addresses %s total", cur->desc);
454 GNUNET_asprintf (&cur->stat_active,
455 "# ATS active addresses %s total", cur->desc);
456 LOG (GNUNET_ERROR_TYPE_INFO, "Added network %u `%s' (%llu/%llu)\n",
457 c, cur->desc, cur->total_quota_in, cur->total_quota_out);
463 libgnunet_plugin_ats_proportional_done (void *cls)
465 struct GAS_PROPORTIONAL_Handle *s = cls;
466 struct AddressWrapper *cur;
467 struct AddressWrapper *next;
469 GNUNET_assert(s != NULL);
470 for (c = 0; c < s->network_count; c++)
472 if (s->network_entries[c].total_addresses > 0)
474 LOG(GNUNET_ERROR_TYPE_DEBUG,
475 "Had %u addresses for network `%s' not deleted during shutdown\n",
476 s->network_entries[c].total_addresses, s->network_entries[c].desc);
480 if (s->network_entries[c].active_addresses > 0)
482 LOG(GNUNET_ERROR_TYPE_DEBUG,
483 "Had %u active addresses for network `%s' not deleted during shutdown\n",
484 s->network_entries[c].active_addresses, s->network_entries[c].desc);
488 next = s->network_entries[c].head;
489 while (NULL != (cur = next))
492 GNUNET_CONTAINER_DLL_remove(s->network_entries[c].head,
493 s->network_entries[c].tail, cur);
494 GNUNET_free_non_null (cur->addr->solver_information);
497 GNUNET_free(s->network_entries[c].stat_total);
498 GNUNET_free(s->network_entries[c].stat_active);
500 if (s->total_addresses > 0)
502 LOG(GNUNET_ERROR_TYPE_DEBUG,
503 "Had %u addresses not deleted during shutdown\n", s->total_addresses);
506 if (s->active_addresses > 0)
508 LOG(GNUNET_ERROR_TYPE_DEBUG,
509 "Had %u active addresses not deleted during shutdown\n",
510 s->active_addresses);
513 GNUNET_free (s->network_entries);
514 GNUNET_CONTAINER_multipeermap_destroy (s->requests);
521 * Test if bandwidth is available in this network to add an additional address
523 * @param net the network type to update
524 * @return GNUNET_YES or GNUNET_NO
527 is_bandwidth_available_in_network (struct Network *net)
529 GNUNET_assert(NULL != net);
530 unsigned int na = net->active_addresses + 1;
531 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
532 if (((net->total_quota_in / na) > min_bw)
533 && ((net->total_quota_out / na) > min_bw))
535 LOG(GNUNET_ERROR_TYPE_DEBUG,
536 "Enough bandwidth available for %u active addresses in network `%s'\n",
541 LOG(GNUNET_ERROR_TYPE_DEBUG,
542 "Not enough bandwidth available for %u active addresses in network `%s'\n",
548 * Update bandwidth assigned to peers in this network
550 * @param s the solver handle
551 * @param net the network type to update
552 * @param address_except address excluded from notification, since we suggest
556 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
557 struct Network *net, struct ATS_Address *address_except)
559 struct AddressSolverInformation *asi;
560 struct AddressWrapper *cur;
562 unsigned long long remaining_quota_in = 0;
563 unsigned long long quota_out_used = 0;
564 unsigned long long remaining_quota_out = 0;
565 unsigned long long quota_in_used = 0;
566 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
568 double total_prefs; /* Important: has to be double not float due to precision */
569 double cur_pref; /* Important: has to be double not float due to precision */
570 const double *t = NULL; /* Important: has to be double not float due to precision */
572 unsigned long long assigned_quota_in = 0;
573 unsigned long long assigned_quota_out = 0;
576 LOG(GNUNET_ERROR_TYPE_DEBUG,
577 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
578 net->desc, net->active_addresses, net->total_quota_in,
579 net->total_quota_in);
581 if (net->active_addresses == 0)
582 return; /* no addresses to update */
585 * Assign every peer in network minimum Bandwidth
586 * Distribute bandwidth left according to preference
589 if ((net->active_addresses * min_bw) > net->total_quota_in)
594 if ((net->active_addresses * min_bw) > net->total_quota_out)
600 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
601 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
602 LOG(GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
603 remaining_quota_in, remaining_quota_out);
605 for (cur = net->head; NULL != cur; cur = cur->next)
607 if (GNUNET_YES == cur->addr->active)
610 NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
613 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
615 if (c != GNUNET_ATS_PREFERENCE_END)
617 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
621 total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount - 1));
624 for (cur = net->head; NULL != cur; cur = cur->next)
626 if (GNUNET_YES == cur->addr->active)
630 NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
632 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
634 if (c != GNUNET_ATS_PREFERENCE_END)
639 assigned_quota_in = min_bw
640 + ((cur_pref / total_prefs) * remaining_quota_in);
641 assigned_quota_out = min_bw
642 + ((cur_pref / total_prefs) * remaining_quota_out);
644 LOG(GNUNET_ERROR_TYPE_DEBUG,
645 "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
646 GNUNET_i2s (&cur->addr->peer), cur_pref, total_prefs,
647 assigned_quota_in, assigned_quota_out);
651 assigned_quota_in = 0;
652 assigned_quota_out = 0;
655 quota_in_used += assigned_quota_in;
656 quota_out_used += assigned_quota_out;
657 /* Prevent overflow due to rounding errors */
658 if (assigned_quota_in > UINT32_MAX)
659 assigned_quota_in = UINT32_MAX;
660 if (assigned_quota_out > UINT32_MAX)
661 assigned_quota_out = UINT32_MAX;
663 /* Compare to current bandwidth assigned */
664 asi = cur->addr->solver_information;
665 asi->calculated_quota_in_NBO = htonl (assigned_quota_in);
666 asi->calculated_quota_out_NBO = htonl (assigned_quota_out);
668 LOG(GNUNET_ERROR_TYPE_DEBUG,
669 "Total bandwidth assigned is (in/out): %llu /%llu\n", quota_in_used,
671 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
673 LOG(GNUNET_ERROR_TYPE_ERROR,
674 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
675 net->active_addresses, quota_out_used, net->total_quota_out);
677 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
679 LOG(GNUNET_ERROR_TYPE_ERROR,
680 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
681 net->active_addresses, quota_in_used, net->total_quota_in);
685 struct FindBestAddressCtx
687 struct GAS_PROPORTIONAL_Handle *s;
688 struct ATS_Address *best;
692 find_property_index (uint32_t type)
694 int existing_types[] = GNUNET_ATS_QualityProperties;
696 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
697 if (existing_types[c] == type)
699 return GNUNET_SYSERR;
703 * Find a "good" address to use for a peer by iterating over the addresses for this peer.
704 * If we already have an existing address, we stick to it.
705 * Otherwise, we pick by lowest distance and then by lowest latency.
707 * @param cls the 'struct ATS_Address**' where we store the result
709 * @param value another 'struct ATS_Address*' to consider using
710 * @return GNUNET_OK (continue to iterate)
713 find_best_address_it (void *cls,
714 const struct GNUNET_PeerIdentity *key,
717 struct FindBestAddressCtx *ctx = (struct FindBestAddressCtx *) cls;
718 struct ATS_Address *current = (struct ATS_Address *) value;
719 struct ATS_Address *current_best = (struct ATS_Address *) value;
720 struct GNUNET_TIME_Absolute now;
721 struct AddressSolverInformation *asi;
722 const double *norm_prop_cur;
723 const double *norm_prop_best;
727 asi = current->solver_information;
728 now = GNUNET_TIME_absolute_get ();
730 if (current->blocked_until.abs_value_us
731 == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value_us)
733 /* This address is blocked for suggestion */
734 LOG(GNUNET_ERROR_TYPE_DEBUG, "Address %p blocked for suggestion for %s \n",
736 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (now, current->blocked_until), GNUNET_YES));
745 if (GNUNET_NO == is_bandwidth_available_in_network (asi->network))
746 return GNUNET_OK; /* There's no bandwidth available in this network */
748 if (NULL != ctx->best)
750 /* Compare current addresses with denominated 'best' address */
752 current_best = ctx->best;
753 if ((0 != ctx->best->addr_len) && (0 == current->addr_len))
755 /* saved address was an outbound address, but we have an inbound address */
756 current_best = current;
759 if (ctx->best->t_last_activity.abs_value_us < current->t_last_activity.abs_value_us)
761 /* Current address is newer */
762 current_best = current;
764 if (ctx->best->t_added.abs_value_us < current->t_added.abs_value_us)
766 /* Current address is newer */
767 current_best = current;
771 if (NULL == ctx->best)
773 /* We do not have a 'best' address so take this address */
774 current_best = current;
778 if ( (ntohl (ctx->best->assigned_bw_in.value__) == 0) &&
779 (ntohl (current->assigned_bw_in.value__) > 0) )
781 /* stick to existing connection */
782 current_best = current;
785 /* Now compare ATS information */
786 norm_prop_cur = ctx->s->get_properties (ctx->s->get_properties_cls,
787 (const struct ATS_Address *) current);
788 norm_prop_best = ctx->s->get_properties (ctx->s->get_properties_cls,
789 (const struct ATS_Address *) ctx->best);
791 index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
792 if (GNUNET_SYSERR != index)
794 /* user shorter distance */
795 if (norm_prop_cur[index] < norm_prop_best[index])
796 current_best = current;
798 current_best = ctx->best;
801 index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
802 if (GNUNET_SYSERR != index)
804 /* User connection with less delay */
805 if (norm_prop_cur[index] < norm_prop_best[index])
806 current_best = current;
808 current_best = ctx->best;
811 ctx->best = current_best;
817 * ---------------------------
820 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
821 struct Network *net, struct ATS_Address *address_except)
823 struct AddressWrapper *cur;
824 struct AddressSolverInformation *asi;
825 for (cur = net->head; NULL != cur; cur = cur->next)
827 asi = cur->addr->solver_information;
828 if ( (cur->addr->assigned_bw_in.value__ != asi->calculated_quota_in_NBO) ||
829 (cur->addr->assigned_bw_out.value__ != asi->calculated_quota_out_NBO) )
831 cur->addr->assigned_bw_in.value__ = asi->calculated_quota_in_NBO;
832 cur->addr->assigned_bw_out.value__ = asi->calculated_quota_in_NBO;
833 /* Notify on change */
834 if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
835 s->bw_changed (s->bw_changed_cls, cur->addr);
841 * Distribibute bandwidth
843 * @param s the solver handle
844 * @param n the network, can be NULL for all network
845 * @param address_except do not notify for this address
848 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
849 struct Network *n, struct ATS_Address *address_except)
851 if (GNUNET_YES == s->bulk_lock)
859 if (NULL != s->env->info_cb)
860 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
861 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
862 distribute_bandwidth(s, n, address_except);
863 if (NULL != s->env->info_cb)
864 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
865 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
866 if (NULL != s->env->info_cb)
867 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
868 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
869 propagate_bandwidth(s, n, address_except);
870 if (NULL != s->env->info_cb)
871 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
872 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
877 if (NULL != s->env->info_cb)
878 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
879 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
880 for (i = 0; i < s->network_count; i++)
881 distribute_bandwidth(s, &s->network_entries[i], NULL);
882 if (NULL != s->env->info_cb)
883 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
884 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
885 if (NULL != s->env->info_cb)
886 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
887 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
888 for (i = 0; i < s->network_count; i++)
890 propagate_bandwidth(s, &s->network_entries[i], address_except);
892 if (NULL != s->env->info_cb)
893 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
894 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
899 * Lookup network struct by type
901 * @param s the solver handle
902 * @param type the network type
903 * @return the network struct
905 static struct Network *
906 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
909 for (c = 0; c < s->network_count; c++)
911 if (s->network_entries[c].type == type)
912 return &s->network_entries[c];
918 * Hashmap Iterator to find current active address for peer
920 * @param cls last active address
921 * @param key peer's key
922 * @param value address to check
923 * @return #GNUNET_NO on double active address else #GNUNET_YES;
926 get_active_address_it (void *cls,
927 const struct GNUNET_PeerIdentity *key,
930 struct ATS_Address **dest = cls;
931 struct ATS_Address *aa = (struct ATS_Address *) value;
933 if (GNUNET_YES == aa->active)
938 /* should never happen */
939 LOG(GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n",
940 GNUNET_i2s (&aa->peer));
950 * Find current active address for peer
952 * @param solver the solver handle
953 * @param addresses the address set
954 * @param peer the peer
955 * @return active address or NULL
957 static struct ATS_Address *
958 get_active_address (void *solver,
959 const struct GNUNET_CONTAINER_MultiPeerMap * addresses,
960 const struct GNUNET_PeerIdentity *peer)
962 struct ATS_Address * dest = NULL;
964 GNUNET_CONTAINER_multipeermap_get_multiple (addresses, peer,
965 &get_active_address_it, &dest);
971 addresse_increment (struct GAS_PROPORTIONAL_Handle *s, struct Network *net,
972 int total, int active)
974 if (GNUNET_YES == total)
976 s->total_addresses++;
977 net->total_addresses++;
978 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
979 GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
981 if (GNUNET_YES == active)
983 net->active_addresses++;
984 s->active_addresses++;
985 GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1,
987 GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
994 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s, struct Network *net,
995 int total, int active)
998 if (GNUNET_YES == total)
1000 if (s->total_addresses < 1)
1003 res = GNUNET_SYSERR;
1007 s->total_addresses--;
1008 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1011 if (net->total_addresses < 1)
1014 res = GNUNET_SYSERR;
1018 net->total_addresses--;
1019 GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
1023 if (GNUNET_YES == active)
1025 if (net->active_addresses < 1)
1028 res = GNUNET_SYSERR;
1032 net->active_addresses--;
1033 GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
1035 if (s->active_addresses < 1)
1038 res = GNUNET_SYSERR;
1042 s->active_addresses--;
1043 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1051 * Solver API functions
1052 * ---------------------------
1056 * Changes the preferences for a peer in the problem
1058 * @param solver the solver handle
1059 * @param peer the peer to change the preference for
1060 * @param kind the kind to change the preference
1061 * @param pref_rel the normalized preference value for this kind over all clients
1064 GAS_proportional_address_change_preference (void *solver,
1065 const struct GNUNET_PeerIdentity *peer,
1066 enum GNUNET_ATS_PreferenceKind kind,
1069 struct GAS_PROPORTIONAL_Handle *s = solver;
1070 GNUNET_assert(NULL != solver);
1071 GNUNET_assert(NULL != peer);
1073 distribute_bandwidth_in_network (s, NULL, NULL);
1078 * Get application feedback for a peer
1080 * @param solver the solver handle
1081 * @param application the application
1082 * @param peer the peer to change the preference for
1083 * @param scope the time interval for this feedback: [now - scope .. now]
1084 * @param kind the kind to change the preference
1085 * @param score the score
1088 GAS_proportional_address_preference_feedback (void *solver, void *application,
1089 const struct GNUNET_PeerIdentity *peer,
1090 const struct GNUNET_TIME_Relative scope,
1091 enum GNUNET_ATS_PreferenceKind kind, double score)
1093 struct GAS_PROPORTIONAL_Handle *s = solver;
1094 GNUNET_assert(NULL != solver);
1095 GNUNET_assert(NULL != peer);
1097 GNUNET_assert(NULL != s);
1102 * Get the preferred address for a specific peer
1104 * @param solver the solver handle
1105 * @param peer the identity of the peer
1107 const struct ATS_Address *
1108 GAS_proportional_get_preferred_address (void *solver,
1109 const struct GNUNET_PeerIdentity *peer)
1111 struct GAS_PROPORTIONAL_Handle *s = solver;
1112 struct Network *net_prev;
1113 struct Network *net_cur;
1114 struct ATS_Address *prev;
1115 struct FindBestAddressCtx fba_ctx;
1116 struct AddressSolverInformation *asi;
1117 struct AddressSolverInformation *asi_prev;
1119 GNUNET_assert(s != NULL);
1120 GNUNET_assert(peer != NULL);
1122 /* Add to list of pending requests */
1123 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests,
1126 GNUNET_assert (GNUNET_OK ==
1127 GNUNET_CONTAINER_multipeermap_put (s->requests,
1129 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1132 /* Get address with: stick to current address, lower distance, lower latency */
1134 fba_ctx.best = NULL;
1136 GNUNET_CONTAINER_multipeermap_get_multiple (s->addresses, peer,
1137 &find_best_address_it, &fba_ctx);
1138 if (NULL == fba_ctx.best)
1140 LOG(GNUNET_ERROR_TYPE_INFO, "Cannot suggest address for peer `%s'\n",
1145 LOG(GNUNET_ERROR_TYPE_INFO, "Suggesting %s address %p for peer `%s'\n",
1146 (GNUNET_NO == fba_ctx.best->active) ? "inactive" : "active", fba_ctx.best,
1148 asi = fba_ctx.best->solver_information;
1149 net_cur = asi->network ;
1150 if (NULL == fba_ctx.best)
1152 LOG(GNUNET_ERROR_TYPE_ERROR,
1153 "Trying to suggesting unknown address peer `%s'\n", GNUNET_i2s (peer));
1157 if (GNUNET_YES == fba_ctx.best->active)
1159 /* This address was selected previously, so no need to update quotas */
1160 return fba_ctx.best;
1163 /* This address was not active, so we have to:
1165 * - mark previous active address as not active
1166 * - update quota for previous address network
1167 * - update quota for this address network
1169 prev = get_active_address (s, s->addresses, peer);
1172 asi_prev = prev->solver_information;
1173 net_prev = (struct Network *) asi_prev->network;
1174 prev->active = GNUNET_NO; /* No active any longer */
1175 prev->assigned_bw_in = BANDWIDTH_ZERO; /* no bandwidth assigned */
1176 prev->assigned_bw_out = BANDWIDTH_ZERO; /* no bandwidth assigned */
1177 if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
1179 distribute_bandwidth_in_network (s, net_prev, NULL);
1182 if (GNUNET_NO == (is_bandwidth_available_in_network (net_cur)))
1184 GNUNET_break(0); /* This should never happen*/
1188 fba_ctx.best->active = GNUNET_YES;
1189 addresse_increment (s, net_cur, GNUNET_NO, GNUNET_YES);
1190 distribute_bandwidth_in_network (s, net_cur, fba_ctx.best);
1191 return fba_ctx.best;
1195 * Stop notifying about address and bandwidth changes for this peer
1197 * @param solver the solver handle
1198 * @param peer the peer
1201 GAS_proportional_stop_get_preferred_address (void *solver,
1202 const struct GNUNET_PeerIdentity *peer)
1204 struct GAS_PROPORTIONAL_Handle *s = solver;
1205 struct ATS_Address *cur;
1206 struct AddressSolverInformation *asi;
1207 struct Network *cur_net;
1210 == GNUNET_CONTAINER_multipeermap_contains (s->requests,
1212 GNUNET_assert (GNUNET_OK == GNUNET_CONTAINER_multipeermap_remove (s->requests, peer,
1215 cur = get_active_address (s,
1216 s->addresses, peer);
1219 /* Disabling current address */
1220 asi = cur->solver_information;
1221 cur_net = asi->network ;
1222 cur->active = GNUNET_NO; /* No active any longer */
1223 cur->assigned_bw_in = BANDWIDTH_ZERO; /* no bandwidth assigned */
1224 cur->assigned_bw_out = BANDWIDTH_ZERO; /* no bandwidth assigned */
1225 if (GNUNET_SYSERR == addresse_decrement (s, cur_net, GNUNET_NO, GNUNET_YES))
1227 distribute_bandwidth_in_network (s, cur_net, NULL );
1233 * Remove an address from the solver
1235 * @param solver the solver handle
1236 * @param address the address to remove
1237 * @param session_only delete only session not whole address
1240 GAS_proportional_address_delete (void *solver, struct ATS_Address *address,
1243 struct GAS_PROPORTIONAL_Handle *s = solver;
1244 struct Network *net;
1245 struct AddressWrapper *aw;
1246 struct AddressSolverInformation *asi;
1247 const struct ATS_Address *new_address;
1250 /* Remove an adress completely, we have to:
1251 * - Remove from specific network
1252 * - Decrease number of total addresses
1254 * - decrease number of active addreses
1257 asi = address->solver_information;
1267 if (GNUNET_NO == session_only)
1269 LOG(GNUNET_ERROR_TYPE_INFO,
1270 "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1271 (GNUNET_NO == address->active) ? "inactive" : "active", address,
1272 GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1273 net->active_addresses);
1275 /* Remove address */
1276 addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
1277 for (aw = net->head; NULL != aw; aw = aw->next)
1279 if (aw->addr == address)
1287 GNUNET_CONTAINER_DLL_remove(net->head, net->tail, aw);
1288 GNUNET_free_non_null (aw->addr->solver_information);
1293 /* Remove session only: remove if active and update */
1294 LOG(GNUNET_ERROR_TYPE_INFO,
1295 "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1296 (GNUNET_NO == address->active) ? "inactive" : "active", address,
1297 GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1298 net->active_addresses);
1301 if (GNUNET_YES == address->active)
1303 /* Address was active, remove from network and update quotas*/
1304 address->active = GNUNET_NO;
1305 address->assigned_bw_in = BANDWIDTH_ZERO;
1306 address->assigned_bw_out = BANDWIDTH_ZERO;
1308 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1310 distribute_bandwidth_in_network (s, net, NULL);
1311 if (NULL == (new_address = GAS_proportional_get_preferred_address (s, &address->peer)))
1313 /* No alternative address found, disconnect peer */
1314 s->bw_changed (s->bw_changed_cls, address);
1318 s->bw_changed (s->bw_changed_cls, (struct ATS_Address *) new_address);
1321 LOG(GNUNET_ERROR_TYPE_INFO,
1322 "After deleting address now total %u and active %u addresses in network `%s'\n",
1323 net->total_addresses, net->active_addresses, net->desc);
1328 * Start a bulk operation
1330 * @param solver the solver
1333 GAS_proportional_bulk_start (void *solver)
1335 LOG(GNUNET_ERROR_TYPE_DEBUG, "Locking solver for bulk operation ...\n");
1336 struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1338 GNUNET_assert(NULL != solver);
1344 * Bulk operation done
1347 GAS_proportional_bulk_stop (void *solver)
1349 LOG(GNUNET_ERROR_TYPE_DEBUG, "Unlocking solver from bulk operation ...\n");
1351 struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1352 GNUNET_assert(NULL != solver);
1354 if (s->bulk_lock < 1)
1360 if ((0 == s->bulk_lock) && (0 < s->bulk_requests))
1362 LOG(GNUNET_ERROR_TYPE_DEBUG, "No lock pending, recalculating\n");
1363 distribute_bandwidth_in_network (s, NULL, NULL);
1364 s->bulk_requests = 0;
1370 * Add a new single address to a network
1372 * @param solver the solver Handle
1373 * @param address the address to add
1374 * @param network network type of this address
1377 GAS_proportional_address_add (void *solver, struct ATS_Address *address,
1381 * Transport properties for this address have changed
1383 * @param solver solver handle
1384 * @param address the address
1385 * @param type the ATSI type in HBO
1386 * @param abs_value the absolute value of the property
1387 * @param rel_value the normalized value
1390 GAS_proportional_address_property_changed (void *solver,
1391 struct ATS_Address *address, uint32_t type, uint32_t abs_value,
1394 struct GAS_PROPORTIONAL_Handle *s;
1396 struct AddressSolverInformation *asi;
1398 GNUNET_assert(NULL != solver);
1399 GNUNET_assert(NULL != address);
1401 s = (struct GAS_PROPORTIONAL_Handle *) solver;
1402 asi = address->solver_information;
1417 LOG(GNUNET_ERROR_TYPE_DEBUG,
1418 "Property `%s' for peer `%s' address %p changed to %.2f \n",
1419 GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1420 address, rel_value);
1423 case GNUNET_ATS_UTILIZATION_OUT:
1424 case GNUNET_ATS_UTILIZATION_IN:
1425 case GNUNET_ATS_UTILIZATION_PAYLOAD_IN:
1426 case GNUNET_ATS_UTILIZATION_PAYLOAD_OUT:
1427 case GNUNET_ATS_QUALITY_NET_DELAY:
1428 case GNUNET_ATS_QUALITY_NET_DISTANCE:
1429 case GNUNET_ATS_COST_WAN:
1430 case GNUNET_ATS_COST_LAN:
1431 case GNUNET_ATS_COST_WLAN:
1432 distribute_bandwidth_in_network (s, n, NULL);
1438 * Transport session for this address has changed
1440 * NOTE: values in addresses are already updated
1442 * @param solver solver handle
1443 * @param address the address
1444 * @param cur_session the current session
1445 * @param new_session the new session
1448 GAS_proportional_address_session_changed (void *solver,
1449 struct ATS_Address *address, uint32_t cur_session, uint32_t new_session)
1451 if (cur_session != new_session)
1453 LOG(GNUNET_ERROR_TYPE_DEBUG, "Session changed from %u to %u\n", cur_session,
1459 * Usage for this address has changed
1461 * NOTE: values in addresses are already updated
1463 * @param solver solver handle
1464 * @param address the address
1465 * @param in_use usage state
1468 GAS_proportional_address_inuse_changed (void *solver,
1469 struct ATS_Address *address, int in_use)
1471 LOG(GNUNET_ERROR_TYPE_DEBUG, "Usage changed to %s\n",
1472 (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1476 * Network scope for this address has changed
1478 * NOTE: values in addresses are already updated
1480 * @param solver solver handle
1481 * @param address the address
1482 * @param current_network the current network
1483 * @param new_network the new network
1486 GAS_proportional_address_change_network (void *solver,
1487 struct ATS_Address *address, uint32_t current_network, uint32_t new_network)
1489 struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1490 struct AddressSolverInformation *asi;
1491 int save_active = GNUNET_NO;
1493 struct Network *new_net = NULL;
1495 if (current_network == new_network)
1501 asi = address->solver_information;
1509 /* Network changed */
1510 LOG(GNUNET_ERROR_TYPE_DEBUG,
1511 "Network type changed, moving %s address from `%s' to `%s'\n",
1512 (GNUNET_YES == address->active) ? "active" : "inactive",
1513 GNUNET_ATS_print_network_type (current_network),
1514 GNUNET_ATS_print_network_type (new_network));
1516 save_active = address->active;
1518 /* Disable and assign no bandwidth */
1519 address->active = GNUNET_NO;
1520 address->assigned_bw_in = BANDWIDTH_ZERO; /* no bandwidth assigned */
1521 address->assigned_bw_out = BANDWIDTH_ZERO; /* no bandwidth assigned */
1523 /* Remove from old network */
1524 GAS_proportional_address_delete (solver, address, GNUNET_NO);
1526 /* Set new network type */
1527 if (NULL == (new_net = get_network (solver, new_network)))
1529 /* Address changed to invalid network... */
1530 LOG(GNUNET_ERROR_TYPE_ERROR,
1531 _("Invalid network type `%u' `%s': Disconnect!\n"), new_network,
1532 GNUNET_ATS_print_network_type (new_network));
1534 /* Find new address to suggest since no bandwidth in network*/
1535 if (NULL == GAS_proportional_get_preferred_address (s, &address->peer))
1537 /* No alternative address found, disconnect peer */
1538 s->bw_changed (s->bw_changed_cls, address);
1543 /* Add to new network and update*/
1544 asi->network = new_net;
1545 GAS_proportional_address_add (solver, address, new_network);
1546 if (GNUNET_YES == save_active)
1548 /* check if bandwidth available in new network */
1549 if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1551 /* Assign bandwidth to updated address */
1552 address->active = GNUNET_YES;
1553 addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1554 distribute_bandwidth_in_network (solver, new_net, NULL);
1558 LOG(GNUNET_ERROR_TYPE_DEBUG,
1559 "Not enough bandwidth in new network, suggesting alternative address ..\n");
1560 /* Find new address to suggest since no bandwidth in network*/
1561 if (NULL == GAS_proportional_get_preferred_address (s, &address->peer))
1563 /* No alternative address found, disconnect peer */
1564 s->bw_changed (s->bw_changed_cls, address);
1571 * Add a new single address to a network
1573 * @param solver the solver Handle
1574 * @param address the address to add
1575 * @param network network type of this address
1578 GAS_proportional_address_add (void *solver, struct ATS_Address *address,
1581 struct GAS_PROPORTIONAL_Handle *s = solver;
1582 struct Network *net = NULL;
1583 struct AddressWrapper *aw = NULL;
1584 struct AddressSolverInformation *asi;
1586 GNUNET_assert(NULL != s);
1587 net = get_network (s, network);
1592 LOG(GNUNET_ERROR_TYPE_ERROR,
1593 "Unknown network %u `%s' for new address %p for peer `%s'\n",
1594 network, GNUNET_ATS_print_network_type(network),
1595 address, GNUNET_i2s(&address->peer));
1600 aw = GNUNET_new (struct AddressWrapper);
1602 GNUNET_CONTAINER_DLL_insert(net->head, net->tail, aw);
1603 addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1605 asi = GNUNET_new (struct AddressSolverInformation);
1607 asi->calculated_quota_in_NBO = 0;
1608 asi->calculated_quota_out_NBO = 0;
1609 aw->addr->solver_information = asi;
1611 if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1613 if (NULL == get_active_address (s, s->addresses, &address->peer))
1615 if (NULL != GAS_proportional_get_preferred_address (s, &address->peer))
1616 s->bw_changed (s->bw_changed_cls, (struct ATS_Address *) address);
1620 LOG(GNUNET_ERROR_TYPE_INFO,
1621 "Adding new address %p for peer `%s', now total %u and active %u addresses in network `%s'\n",
1622 address, GNUNET_i2s(&address->peer), net->total_addresses, net->active_addresses, net->desc);
1626 /* end of plugin_ats_proportional.c */