2 This file is part of GNUnet.
3 Copyright (C) 2011-2015 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
28 #include "gnunet_statistics_service.h"
29 #include "gnunet_ats_plugin.h"
30 #include "gnunet_ats_service.h"
31 #include "gnunet-service-ats_addresses.h"
33 #define PROP_STABILITY_FACTOR 1.25
36 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
41 * NOTE: Do not change this documentation. This documentation is based
42 * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
43 * use build_txt.sh to generate plaintext output
45 * ATS addresses : proportional solver
47 * The proportional solver ("proportional") distributes the available
48 * bandwidth fair over all the addresses influenced by the
49 * preference values. For each available network type an in- and
50 * outbound quota is configured and the bandwidth available in
51 * these networks is distributed over the addresses. The solver
52 * first assigns every addresses the minimum amount of bandwidth
53 * #GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
54 * remaining bandwidth available according to the preference
55 * values. For each peer only a single address gets bandwidth
56 * assigned and only one address marked as active. The most
57 * important functionality for the solver is implemented in: *
58 * find_address_it is an hashmap iterator returning the prefered
59 * address for an peer * update_quota_per_network distributes
60 * available bandwidth for a network over active addresses
62 * Changes to addresses automatically have an impact on the the
63 * bandwidth assigned to other addresses in the same network since
64 * the solver distributes the remaining bandwidth over the
65 * addresses in the network. When changes to the addresses occur,
66 * the solver first performs the changes, like adding or deleting
67 * addresses, and then updates bandwidth assignment for the
68 * affected network. Bandwidth assignment is only recalculated on
69 * demand when an address is requested by a client for a peer or
70 * when the addresses available have changed or an address changed
71 * the network it is located in. When the bandwidth assignment has
72 * changed the callback is called with the new bandwidth
73 * assignments. The bandwidth distribution for a network is
74 * recalculated due to: * address suggestion requests * address
75 * deletions * address switching networks during address update *
78 * 3.1 Data structures used
80 * For each ATS network (e.g. WAN, LAN, loopback) a struct Network
81 * is used to specify network related information as total adresses
82 * and active addresses in this network and the configured in- and
83 * outbound quota. Each network also contains a list of addresses
84 * added to the solver located in this network. The proportional
85 * solver uses the addresses' solver_information field to store the
86 * proportional network it belongs to for each address.
90 * When the proportional solver is initialized the solver creates a
91 * new solver handle and initializes the network structures with
92 * the quotas passed from addresses and returns the handle solver.
94 * 3.3 Adding an address
96 * When a new address is added to the solver using s_add, a lookup
97 * for the network for this address is done and the address is
98 * enqueued in in the linked list of the network.
100 * 3.4 Updating an address
102 * The main purpose of address updates is to update the ATS
103 * information for addresse selection. Important for the proportional
104 * solver is when an address switches network it is located
105 * in. This is common because addresses added by transport's
106 * validation mechanism are commonly located in
107 * #GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
108 * in this network type and only if a connection is successful on
109 * return of payload data transport switches to the real network
110 * the address is located in. When an address changes networks it
111 * is first of all removed from the old network using the solver
112 * API function #GAS_proportional_address_delete() and the network in
113 * the address struct is updated. A lookup for the respective new
114 * proportional network is done and stored in the addresse's
115 * solver_information field. Next the address is re-added to the
116 * solver using the solver API function
117 * #GAS_proportional_address_add(). If the address was marked as in
118 * active, the solver checks if bandwidth is available in the
119 * network and if yes sets the address to active and updates the
120 * bandwidth distribution in this network. If no bandwidth is
121 * available it sets the bandwidth for this address to 0 and tries
122 * to suggest an alternative address. If an alternative address was
123 * found, addresses' callback is called for this address.
125 * 3.5 Deleting an address
127 * When an address is removed from the solver, it removes the
128 * respective address from the network and if the address was
129 * marked as active, it updates the bandwidth distribution for this
132 * 3.6 Requesting addresses
134 * When an address is requested for a peer the solver performs a
135 * lookup for the peer entry in addresses address hashmap and
136 * selects the best address. The selection of the most suitable
137 * address is done in the find_address_it hashmap iterator
138 * described in detail in section 3.7. If no address is returned,
139 * no address can be suggested at the moment. If the address
140 * returned is marked as active, the solver can return this
141 * address. If the address is not marked as active, the solver
142 * checks if another address belongign to this peer is marked as
143 * active and marks the address as inactive, updates the bandwidth
144 * for this address to 0, call the bandwidth changed callback for
145 * this address due to the change and updates quota assignment for
146 * the addresse's network. the now in-active address is belonging
147 * to. The solver marks the new address as active and updates the
148 * bandwidth assignment for this network.
150 * 3.7 Choosing addresses
152 * Choosing the best possible address for suggestion is done by
153 * iterating over all addresses of a peer stored in addresses'
154 * hashmap and using the hashmap iterator find_address_it to select
155 * the best available address. Several checks are done when an
156 * address is selected. First if this address is currently blocked
157 * by addresses from being suggested. An address is blocked for the
158 * duration of #ATS_BLOCKING_DELTA when it is suggested to
159 * transport. Next it is checked if at least
160 * #GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
161 * in the addresse's network, because suggesting an address without
162 * bandwidth does not make sense. This also ensures that all active
163 * addresses in this network get at least the minimum amount of
164 * bandwidth assigned. In the next step the solver ensures that for
165 * tcp connections inbound connections are prefered over outbound
166 * connections. In the next stet the solver ensures that
167 * connections are prefered in the following order: * connections
168 * are already established and have bandwidth assigned *
169 * connections with a shorter distance * connectes have a shorter
172 * 3.8 Changing preferences
176 * During shutdown all network entries and aging processes are
177 * destroyed and freed.
182 * This solver assigns in and outbound bandwidth equally for all
183 * addresses in specific network type (WAN, LAN) based on configured
184 * in and outbound quota for this network.
186 * The solver is notified by addresses about changes to the addresses
187 * and recalculates the bandwith assigned if required. The solver
188 * notifies addresses by calling the GAS_bandwidth_changed_cb
196 * For each peer only a single is selected and marked as "active" in the address
201 * You have the networks WAN and LAN and quotas
202 * WAN_TOTAL_IN, WAN_TOTAL_OUT
203 * LAN_TOTAL_IN, LAN_TOTAL_OUT
205 * If you have x addresses in the network segment LAN, the quotas are
206 * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
208 * Quotas are automatically recalculated and reported back when addresses are
214 * Default value to assume for the proportionality factor,
215 * if none is given in the configuration.
217 #define PROPORTIONALITY_FACTOR 2.0
221 * Address information stored for the proportional solver in the
222 * `solver_information` member of `struct GNUNET_ATS_Address`.
224 * They are also stored in the respective `struct Network`'s linked
227 struct AddressWrapper
232 struct AddressWrapper *next;
237 struct AddressWrapper *prev;
242 struct ATS_Address *addr;
245 * Network scope this address is in
247 struct Network *network;
252 uint32_t calculated_quota_in;
257 uint32_t calculated_quota_out;
260 * When was this address activated
262 struct GNUNET_TIME_Absolute activated;
268 * Representation of a network
273 * Network description
278 * String for statistics total addresses
283 * String for statistics active addresses
288 * Linked list of addresses in this network: head
290 struct AddressWrapper *head;
293 * Linked list of addresses in this network: tail
295 struct AddressWrapper *tail;
298 * Total inbound quota
300 unsigned long long total_quota_in;
303 * Total outbound quota
305 unsigned long long total_quota_out;
310 enum GNUNET_ATS_Network_Type type;
313 * Number of active addresses for this network
315 unsigned int active_addresses;
318 * Number of total addresses for this network
320 unsigned int total_addresses;
326 * A handle for the proportional solver
328 struct GAS_PROPORTIONAL_Handle
332 * Our execution environment.
334 struct GNUNET_ATS_PluginEnvironment *env;
339 struct Network *network_entries;
342 * Proportionality factor
349 double stability_factor;
352 * Bulk lock counter. If zero, we are not locked.
354 unsigned int bulk_lock;
357 * Number of changes made while solver was locked. We really only
358 * use 0/non-zero to check on unlock if we have to run the update.
360 unsigned int bulk_requests;
363 * Number of active addresses for solver
365 unsigned int active_addresses;
368 * Number of networks in @a network_entries
370 unsigned int network_count;
375 * Test if bandwidth is available in this network to add an additional address
377 * @param net the network type to update
378 * @return #GNUNET_YES or #GNUNET_NO
381 is_bandwidth_available_in_network (struct Network *net)
383 unsigned int na = net->active_addresses + 1;
384 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
386 if ( ((net->total_quota_in / na) > min_bw) &&
387 ((net->total_quota_out / na) > min_bw) )
389 LOG (GNUNET_ERROR_TYPE_DEBUG,
390 "Enough bandwidth available for %u active addresses in network `%s'\n",
396 LOG (GNUNET_ERROR_TYPE_DEBUG,
397 "Not enough bandwidth available for %u active addresses in network `%s'\n",
405 * Update bandwidth assigned to peers in this network
407 * @param s the solver handle
408 * @param net the network type to update
412 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
415 struct AddressWrapper *aw;
416 unsigned long long remaining_quota_in = 0;
417 unsigned long long quota_out_used = 0;
418 unsigned long long remaining_quota_out = 0;
419 unsigned long long quota_in_used = 0;
421 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
422 double relative_peer_prefence;
423 double sum_relative_peer_prefences; /* Important: has to be double not float due to precision */
424 double cur_pref; /* Important: has to be double not float due to precision */
427 const double *peer_relative_prefs = NULL; /* Important: has to be double not float due to precision */
429 uint32_t assigned_quota_in = 0;
430 uint32_t assigned_quota_out = 0;
433 LOG (GNUNET_ERROR_TYPE_INFO,
434 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
436 net->active_addresses,
438 net->total_quota_in);
440 if (net->active_addresses == 0)
442 return; /* no addresses to update */
446 * Assign every peer in network minimum Bandwidth
447 * Distribute bandwidth left according to preference
450 if ((net->active_addresses * min_bw) > net->total_quota_in)
455 if ((net->active_addresses * min_bw) > net->total_quota_out)
461 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
462 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
463 LOG(GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
464 remaining_quota_in, remaining_quota_out);
465 sum_relative_peer_prefences = 0.0;
467 /* Calculate sum of relative preference for active addresses in this network */
469 for (aw = net->head; NULL != aw; aw = aw->next)
471 if (GNUNET_YES != aw->addr->active)
474 peer_relative_prefs = s->env->get_preferences (s->env->cls,
476 relative_peer_prefence = 0.0;
477 relative_peer_prefence += peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
478 sum_relative_peer_prefences += relative_peer_prefence;
482 if (count_addresses != net->active_addresses)
485 LOG (GNUNET_ERROR_TYPE_WARNING,
486 "%s: Counted %u active addresses, but network says to have %u active addresses\n",
489 net->active_addresses);
490 for (aw = net->head; NULL != aw; aw = aw->next)
492 if (GNUNET_YES != aw->addr->active)
495 LOG (GNUNET_ERROR_TYPE_WARNING,
496 "Active: `%s' `%s' length %u\n",
497 GNUNET_i2s (&aw->addr->peer),
503 LOG (GNUNET_ERROR_TYPE_INFO,
504 "Total relative preference %.3f for %u addresses in network %s\n",
505 sum_relative_peer_prefences,
506 net->active_addresses,
509 for (aw = net->head; NULL != aw; aw = aw->next)
511 if (GNUNET_YES == aw->addr->active)
513 peer_relative_prefs = s->env->get_preferences (s->env->cls,
516 cur_pref = peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
517 total_weight = net->active_addresses +
518 s->prop_factor * sum_relative_peer_prefences;
519 peer_weight = (1.0 + (s->prop_factor * cur_pref));
521 assigned_quota_in = min_bw
522 + ((peer_weight / total_weight) * remaining_quota_in);
523 assigned_quota_out = min_bw
524 + ((peer_weight / total_weight) * remaining_quota_out);
526 LOG (GNUNET_ERROR_TYPE_INFO,
527 "New quota for peer `%s' with weight (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
528 GNUNET_i2s (&aw->addr->peer),
536 assigned_quota_in = 0;
537 assigned_quota_out = 0;
540 quota_in_used += assigned_quota_in;
541 quota_out_used += assigned_quota_out;
542 /* Prevent overflow due to rounding errors */
543 if (assigned_quota_in > UINT32_MAX)
544 assigned_quota_in = UINT32_MAX;
545 if (assigned_quota_out > UINT32_MAX)
546 assigned_quota_out = UINT32_MAX;
548 /* Store for later propagation */
549 aw->calculated_quota_in = assigned_quota_in;
550 aw->calculated_quota_out = assigned_quota_out;
552 LOG (GNUNET_ERROR_TYPE_DEBUG,
553 "Total bandwidth assigned is (in/out): %llu /%llu\n",
556 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
558 LOG (GNUNET_ERROR_TYPE_ERROR,
559 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
560 net->active_addresses,
562 net->total_quota_out);
564 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
566 LOG (GNUNET_ERROR_TYPE_ERROR,
567 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
568 net->active_addresses,
570 net->total_quota_in);
576 * Notify ATS service of bandwidth changes to addresses.
578 * @param s solver handle
579 * @param net the network to propagate changes in
582 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
585 struct AddressWrapper *cur;
587 for (cur = net->head; NULL != cur; cur = cur->next)
589 if ( (cur->addr->assigned_bw_in == cur->calculated_quota_in) &&
590 (cur->addr->assigned_bw_out == cur->calculated_quota_out) )
592 cur->addr->assigned_bw_in = cur->calculated_quota_in;
593 cur->addr->assigned_bw_out = cur->calculated_quota_out;
595 LOG (GNUNET_ERROR_TYPE_DEBUG,
596 "Bandwidth for %s address %p for peer `%s' changed to %u/%u\n",
597 (GNUNET_NO == cur->addr->active) ? "inactive" : "active",
599 GNUNET_i2s (&cur->addr->peer),
600 cur->addr->assigned_bw_in,
601 cur->addr->assigned_bw_out);
603 /* Notify on change */
604 if (GNUNET_YES == cur->addr->active)
605 s->env->bandwidth_changed_cb (s->env->cls,
612 * Distribute bandwidth. The addresses have already been selected,
613 * this is merely distributed the bandwidth among the addresses.
615 * @param s the solver handle
616 * @param n the network, can be NULL for all networks
619 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
624 if (GNUNET_YES == s->bulk_lock)
631 LOG (GNUNET_ERROR_TYPE_DEBUG,
632 "Redistributing bandwidth in network %s with %u active and %u total addresses\n",
633 GNUNET_ATS_print_network_type(n->type),
636 s->env->info_cb (s->env->cls,
639 GAS_INFO_PROP_SINGLE);
640 distribute_bandwidth(s,
642 s->env->info_cb (s->env->cls,
645 GAS_INFO_PROP_SINGLE);
646 s->env->info_cb (s->env->cls,
647 GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
649 GAS_INFO_PROP_SINGLE);
650 propagate_bandwidth (s,
653 s->env->info_cb (s->env->cls,
654 GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
656 GAS_INFO_PROP_SINGLE);
660 s->env->info_cb (s->env->cls,
664 for (i = 0; i < s->network_count; i++)
665 distribute_bandwidth (s,
666 &s->network_entries[i]);
667 s->env->info_cb (s->env->cls,
671 s->env->info_cb (s->env->cls,
672 GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
675 for (i = 0; i < s->network_count; i++)
676 propagate_bandwidth (s,
677 &s->network_entries[i]);
678 s->env->info_cb (s->env->cls,
679 GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
687 * Context for finding the best address* Linked list of addresses in this network: head
689 struct FindBestAddressCtx
694 struct GAS_PROPORTIONAL_Handle *s;
697 * The currently best address
699 struct ATS_Address *best;
704 * Find index of a ATS property type in the quality properties array.
706 * @param type ATS property type
707 * @return index in the quality array, #GNUNET_SYSERR if the type
708 * was not a quality property
711 find_quality_property_index (enum GNUNET_ATS_Property type)
713 enum GNUNET_ATS_Property existing_types[] = GNUNET_ATS_QualityProperties;
716 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
717 if (existing_types[c] == type)
720 return GNUNET_SYSERR;
725 * Find a "good" address to use for a peer by iterating over the
726 * addresses for this peer. If we already have an existing address,
727 * we stick to it. Otherwise, we pick by lowest distance and then by
730 * @param cls the `struct FindBestAddressCtx *' where we store the result
731 * @param key the peer we are trying to find the best address for
732 * @param value another `struct ATS_Address*` to consider using
733 * @return #GNUNET_OK (continue to iterate)
736 find_best_address_it (void *cls,
737 const struct GNUNET_PeerIdentity *key,
740 struct FindBestAddressCtx *ctx = cls;
741 struct ATS_Address *current = value;
742 struct AddressWrapper *asi = current->solver_information;
743 struct GNUNET_TIME_Relative active_time;
745 double best_distance;
751 is_bandwidth_available_in_network (asi->network))
753 /* There's no bandwidth available in this network,
754 so we cannot use this address. */
757 if (GNUNET_YES == current->active)
759 active_time = GNUNET_TIME_absolute_get_duration (asi->activated);
760 if (active_time.rel_value_us <=
761 ((double) GNUNET_TIME_UNIT_SECONDS.rel_value_us) * ctx->s->stability_factor)
763 /* Keep active address for stability reasons */
768 if (NULL == ctx->best)
770 /* We so far have nothing else, so go with it! */
775 /* Now compare ATS information */
776 index = find_quality_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
777 cur_distance = current->atsin[index].norm;
778 best_distance = ctx->best->atsin[index].norm;
779 index = find_quality_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
780 cur_delay = current->atsin[index].norm;
781 best_delay = ctx->best->atsin[index].norm;
783 /* user shorter distance */
784 if (cur_distance < best_distance)
786 if (GNUNET_NO == ctx->best->active)
788 /* Activity doesn't influence the equation, use current */
791 else if ((best_distance / cur_distance) > ctx->s->stability_factor)
793 /* Distance change is significant, switch active address! */
798 /* User connection with less delay */
799 if (cur_delay < best_delay)
801 if (GNUNET_NO == ctx->best->active)
803 /* Activity doesn't influence the equation, use current */
806 else if ((best_delay / cur_delay) > ctx->s->stability_factor)
808 /* Latency change is significant, switch active address! */
817 * Find the currently best address for a peer from the set of
818 * addresses available or return NULL of no address is available.
820 * @param s the proportional handle
821 * @param addresses the address hashmap
822 * @param id the peer id
823 * @return the address or NULL
826 get_best_address (struct GAS_PROPORTIONAL_Handle *s,
827 struct GNUNET_CONTAINER_MultiPeerMap *addresses,
828 const struct GNUNET_PeerIdentity *id)
830 struct FindBestAddressCtx fba_ctx;
834 GNUNET_CONTAINER_multipeermap_get_multiple (addresses,
836 &find_best_address_it,
843 * Decrease number of active addresses in network.
845 * @param s the solver handle
846 * @param net the network type
849 address_decrement_active (struct GAS_PROPORTIONAL_Handle *s,
852 GNUNET_assert (net->active_addresses > 0);
853 net->active_addresses--;
854 GNUNET_STATISTICS_update (s->env->stats,
858 GNUNET_assert (s->active_addresses > 0);
859 s->active_addresses--;
860 GNUNET_STATISTICS_update (s->env->stats,
861 "# ATS addresses total",
868 * Address map iterator to find current active address for peer.
869 * Asserts that only one address is active per peer.
871 * @param cls last active address
872 * @param key peer's key
873 * @param value address to check
874 * @return #GNUNET_NO on double active address else #GNUNET_YES;
877 get_active_address_it (void *cls,
878 const struct GNUNET_PeerIdentity *key,
881 struct ATS_Address **dest = cls;
882 struct ATS_Address *aa = value;
884 if (GNUNET_YES != aa->active)
886 GNUNET_assert (NULL == (*dest));
893 * Find current active address for peer
895 * @param s the solver handle
896 * @param peer the peer
897 * @return active address or NULL
899 static struct ATS_Address *
900 get_active_address (struct GAS_PROPORTIONAL_Handle *s,
901 const struct GNUNET_PeerIdentity *peer)
903 struct ATS_Address *dest;
906 GNUNET_CONTAINER_multipeermap_get_multiple (s->env->addresses,
908 &get_active_address_it,
915 * Update active address for a peer:
916 * Check if active address exists and what the best address is, if addresses
917 * are different switch
919 * @param s solver handle
920 * @param peer the peer to check
921 * return the new address or NULL if no update was performed
923 static struct ATS_Address *
924 update_active_address (struct GAS_PROPORTIONAL_Handle *s,
925 const struct GNUNET_PeerIdentity *peer)
927 struct ATS_Address *best_address;
928 struct ATS_Address *current_address;
929 struct AddressWrapper *asi;
932 LOG (GNUNET_ERROR_TYPE_INFO,
933 "Updating active address for peer `%s'\n",
936 /* Find active address */
937 current_address = get_active_address (s,
940 LOG (GNUNET_ERROR_TYPE_INFO,
941 "Peer `%s' has active address %p\n",
945 /* Find best address */
946 best_address = get_best_address (s,
949 LOG (GNUNET_ERROR_TYPE_INFO,
950 "Peer `%s' has best address %p\n",
954 if (NULL != current_address)
956 GNUNET_assert (GNUNET_YES == current_address->active);
957 if ( (NULL == best_address) ||
958 ( (NULL != best_address) &&
959 (current_address != best_address) ) )
961 /* We switch to a new address (or to none),
962 mark old address as inactive */
963 LOG (GNUNET_ERROR_TYPE_INFO,
964 "Disabling previous %s address %p for peer `%s'\n",
965 (GNUNET_NO == current_address->active) ? "inactive" : "active",
969 asi = current_address->solver_information;
971 asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
972 current_address->active = GNUNET_NO; /* No active any longer */
973 current_address->assigned_bw_in = 0; /* no bandwidth assigned */
974 current_address->assigned_bw_out = 0; /* no bandwidth assigned */
975 address_decrement_active (s, net);
976 distribute_bandwidth_in_network (s, net);
978 if (NULL == best_address)
980 /* We previously had an active address, but now we cannot suggest one
981 * Therefore we have to disconnect the peer */
982 LOG (GNUNET_ERROR_TYPE_INFO,
983 "Disconnecting peer `%s' with previous address %p\n",
986 s->env->bandwidth_changed_cb (s->env->cls,
990 if (NULL == best_address)
992 LOG (GNUNET_ERROR_TYPE_INFO,
993 "Cannot suggest address for peer `%s'\n",
998 LOG (GNUNET_ERROR_TYPE_INFO,
999 "Suggesting new address %p for peer `%s'\n",
1003 if ( (NULL != current_address) &&
1004 (best_address == current_address) )
1006 GNUNET_break (GNUNET_NO != current_address->active);
1007 return best_address; /* Same same */
1010 asi = best_address->solver_information;
1011 GNUNET_assert (NULL != asi);
1014 /* Mark address as active */
1015 asi->activated = GNUNET_TIME_absolute_get ();
1016 best_address->active = GNUNET_YES;
1018 net->active_addresses++;
1019 s->active_addresses++;
1020 GNUNET_STATISTICS_update (s->env->stats,
1021 "# ATS active addresses total",
1024 GNUNET_STATISTICS_update (s->env->stats,
1028 LOG (GNUNET_ERROR_TYPE_INFO,
1029 "Address %p for peer `%s' is now active\n",
1032 /* Distribute bandwidth */
1033 distribute_bandwidth_in_network (s, net);
1034 return best_address;
1039 * Changes the preferences for a peer in the problem
1041 * @param solver the solver handle
1042 * @param peer the peer to change the preference for
1043 * @param kind the kind to change the preference
1044 * @param pref_rel the normalized preference value for this kind over all clients
1047 GAS_proportional_address_change_preference (void *solver,
1048 const struct GNUNET_PeerIdentity *peer,
1049 enum GNUNET_ATS_PreferenceKind kind,
1052 struct GAS_PROPORTIONAL_Handle *s = solver;
1053 struct ATS_Address *best_address;
1054 struct ATS_Address *active_address;
1055 struct AddressWrapper *asi;
1058 s->env->get_connectivity (s->env->cls,
1060 return; /* Peer is not requested */
1062 /* This peer is requested, find best address */
1063 active_address = get_active_address (s,
1065 best_address = update_active_address (s, peer);
1067 if ( (NULL != best_address) &&
1068 (active_address == best_address) )
1070 asi = best_address->solver_information;
1071 GNUNET_assert (NULL != asi);
1073 /* We sticked to the same address, therefore redistribute */
1074 distribute_bandwidth_in_network (s, asi->network);
1080 * Get application feedback for a peer
1082 * @param solver the solver handle
1083 * @param application the application
1084 * @param peer the peer to change the preference for
1085 * @param scope the time interval for this feedback: [now - scope .. now]
1086 * @param kind the kind to change the preference
1087 * @param score the score
1090 GAS_proportional_address_preference_feedback (void *solver,
1091 struct GNUNET_SERVER_Client *application,
1092 const struct GNUNET_PeerIdentity *peer,
1093 const struct GNUNET_TIME_Relative scope,
1094 enum GNUNET_ATS_PreferenceKind kind,
1097 struct GAS_PROPORTIONAL_Handle *s = solver;
1099 GNUNET_assert(NULL != peer);
1100 GNUNET_assert(NULL != s);
1105 * Get the preferred address for a specific peer
1107 * @param solver the solver handle
1108 * @param peer the identity of the peer
1109 * @return best address
1111 static const struct ATS_Address *
1112 GAS_proportional_get_preferred_address (void *solver,
1113 const struct GNUNET_PeerIdentity *peer)
1115 struct GAS_PROPORTIONAL_Handle *s = solver;
1116 const struct ATS_Address *best_address;
1118 best_address = update_active_address (s, peer);
1119 if (s->bulk_lock > 0)
1121 return best_address;
1126 * Stop notifying about address and bandwidth changes for this peer
1128 * @param solver the solver handle
1129 * @param peer the peer
1132 GAS_proportional_stop_get_preferred_address (void *solver,
1133 const struct GNUNET_PeerIdentity *peer)
1135 struct GAS_PROPORTIONAL_Handle *s = solver;
1136 struct ATS_Address *cur;
1137 struct AddressWrapper *asi;
1138 struct Network *cur_net;
1140 cur = get_active_address (s,
1144 LOG (GNUNET_ERROR_TYPE_INFO,
1145 "Disabling %s address %p for peer `%s'\n",
1146 (GNUNET_NO == cur->active) ? "inactive" : "active",
1148 GNUNET_i2s (&cur->peer));
1150 /* Disabling current address */
1151 asi = cur->solver_information;
1152 cur_net = asi->network;
1153 asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
1154 cur->active = GNUNET_NO; /* No active any longer */
1155 cur->assigned_bw_in = 0; /* no bandwidth assigned */
1156 cur->assigned_bw_out = 0; /* no bandwidth assigned */
1158 address_decrement_active (s, cur_net);
1160 distribute_bandwidth_in_network (s, cur_net);
1166 * Start a bulk operation
1168 * @param solver the solver
1171 GAS_proportional_bulk_start (void *solver)
1173 struct GAS_PROPORTIONAL_Handle *s = solver;
1175 LOG (GNUNET_ERROR_TYPE_DEBUG,
1176 "Locking solver for bulk operation ...\n");
1177 GNUNET_assert (NULL != solver);
1183 * Bulk operation done.
1185 * @param solver our `struct GAS_PROPORTIONAL_Handle *`
1188 GAS_proportional_bulk_stop (void *solver)
1190 struct GAS_PROPORTIONAL_Handle *s = solver;
1192 LOG (GNUNET_ERROR_TYPE_DEBUG,
1193 "Unlocking solver from bulk operation ...\n");
1194 if (s->bulk_lock < 1)
1200 if ((0 == s->bulk_lock) && (0 < s->bulk_requests))
1202 LOG (GNUNET_ERROR_TYPE_INFO,
1203 "No lock pending, recalculating\n");
1204 distribute_bandwidth_in_network (s, NULL);
1205 s->bulk_requests = 0;
1211 * Transport properties for this address have changed
1213 * @param solver solver handle
1214 * @param address the address
1215 * @param type the ATSI type in HBO
1216 * @param abs_value the absolute value of the property
1217 * @param rel_value the normalized value
1220 GAS_proportional_address_property_changed (void *solver,
1221 struct ATS_Address *address,
1222 enum GNUNET_ATS_Property type,
1226 struct GAS_PROPORTIONAL_Handle *s = solver;
1227 struct AddressWrapper *asi;
1228 struct ATS_Address *best_address;
1229 struct ATS_Address *active_address;
1231 asi = address->solver_information;
1232 LOG (GNUNET_ERROR_TYPE_INFO,
1233 "Property `%s' for peer `%s' address %p changed to %.2f\n",
1234 GNUNET_ATS_print_property_type (type),
1235 GNUNET_i2s (&address->peer),
1240 s->env->get_connectivity (s->env->cls,
1242 return; /* Peer is not requested */
1244 /* This peer is requested, find active and best address */
1245 active_address = get_active_address (s,
1247 best_address = update_active_address (s,
1249 if (active_address == best_address)
1251 /* We stuck to the same address, therefore redistribute
1252 (NOTE: because otherwise update_active_address() already
1253 calls distribute_bandwidth_in_network() )*/
1254 distribute_bandwidth_in_network (s, asi->network);
1260 * Add a new single address to a network
1262 * @param solver the solver Handle
1263 * @param address the address to add
1264 * @param network network type of this address
1267 GAS_proportional_address_add (void *solver,
1268 struct ATS_Address *address,
1269 enum GNUNET_ATS_Network_Type network)
1271 struct GAS_PROPORTIONAL_Handle *s = solver;
1272 struct Network *net;
1273 struct AddressWrapper *aw;
1275 GNUNET_assert (network < s->env->network_count);
1276 net = &s->network_entries[network];
1277 net->total_addresses++;
1279 aw = GNUNET_new (struct AddressWrapper);
1282 address->solver_information = aw;
1283 GNUNET_CONTAINER_DLL_insert (net->head,
1286 GNUNET_STATISTICS_update (s->env->stats,
1287 "# ATS addresses total",
1290 GNUNET_STATISTICS_update (s->env->stats,
1295 LOG (GNUNET_ERROR_TYPE_INFO,
1296 "Adding new address %p for peer `%s', now total %u and active %u addresses in network `%s'\n",
1298 GNUNET_i2s (&address->peer),
1299 net->total_addresses,
1300 net->active_addresses,
1304 s->env->get_connectivity (s->env->cls,
1306 return; /* Peer is not requested */
1308 /* This peer is requested, find best address */
1309 update_active_address (s,
1315 * Remove an address from the solver. To do so, we:
1316 * - Removed it from specific network
1317 * - Decrease the number of total addresses
1319 * - decrease number of active addreses
1322 * @param solver the solver handle
1323 * @param address the address to remove
1326 GAS_proportional_address_delete (void *solver,
1327 struct ATS_Address *address)
1329 struct GAS_PROPORTIONAL_Handle *s = solver;
1330 struct AddressWrapper *aw = address->solver_information;
1331 struct Network *net = aw->network;
1333 LOG (GNUNET_ERROR_TYPE_DEBUG,
1334 "Deleting %s address for peer `%s' from network `%s' (total: %u/active: %u)\n",
1335 (GNUNET_NO == address->active) ? "inactive" : "active",
1336 GNUNET_i2s (&address->peer),
1338 net->total_addresses,
1339 net->active_addresses);
1341 GNUNET_CONTAINER_DLL_remove (net->head,
1344 GNUNET_assert (net->total_addresses > 0);
1345 net->total_addresses--;
1346 GNUNET_STATISTICS_update (s->env->stats,
1350 if (GNUNET_YES == address->active)
1352 /* Address was active, remove from network and update quotas*/
1353 address->active = GNUNET_NO;
1354 address->assigned_bw_in = 0;
1355 address->assigned_bw_out = 0;
1356 address_decrement_active (s, net);
1357 /* FIXME: this may trigger the solver unnecessarily,
1358 especially if update_active_address() succeeds! */
1359 distribute_bandwidth_in_network (s, net);
1362 update_active_address (s,
1365 /* No alternative address found, disconnect peer */
1366 LOG (GNUNET_ERROR_TYPE_INFO,
1367 "Disconnecting peer `%s' after deleting previous address %p\n",
1368 GNUNET_i2s (&address->peer),
1370 s->env->bandwidth_changed_cb (s->env->cls,
1375 address->solver_information = NULL;
1376 LOG (GNUNET_ERROR_TYPE_DEBUG,
1377 "After deleting address now total %u and active %u addresses in network `%s'\n",
1378 net->total_addresses,
1379 net->active_addresses,
1385 * Function invoked when the plugin is loaded.
1387 * @param[in,out] cls the `struct GNUNET_ATS_PluginEnvironment *` to use;
1388 * modified to return the API functions (ugh).
1389 * @return the `struct GAS_PROPORTIONAL_Handle` to pass as a closure
1392 libgnunet_plugin_ats_proportional_init (void *cls)
1394 static struct GNUNET_ATS_SolverFunctions sf;
1395 struct GNUNET_ATS_PluginEnvironment *env = cls;
1396 struct GAS_PROPORTIONAL_Handle *s;
1397 struct Network * cur;
1401 s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
1404 sf.s_add = &GAS_proportional_address_add;
1405 sf.s_address_update_property = &GAS_proportional_address_property_changed;
1406 sf.s_get = &GAS_proportional_get_preferred_address;
1407 sf.s_get_stop = &GAS_proportional_stop_get_preferred_address;
1408 sf.s_pref = &GAS_proportional_address_change_preference;
1409 sf.s_feedback = &GAS_proportional_address_preference_feedback;
1410 sf.s_del = &GAS_proportional_address_delete;
1411 sf.s_bulk_start = &GAS_proportional_bulk_start;
1412 sf.s_bulk_stop = &GAS_proportional_bulk_stop;
1413 s->stability_factor = PROP_STABILITY_FACTOR;
1414 if (GNUNET_SYSERR !=
1415 GNUNET_CONFIGURATION_get_value_float (env->cfg,
1417 "PROP_STABILITY_FACTOR",
1420 if ((f_tmp < 1.0) || (f_tmp > 2.0))
1422 LOG (GNUNET_ERROR_TYPE_ERROR,
1423 _("Invalid %s configuration %f \n"),
1424 "PROP_STABILITY_FACTOR",
1429 s->stability_factor = f_tmp;
1430 LOG (GNUNET_ERROR_TYPE_INFO,
1431 "Using %s of %.3f\n",
1432 "PROP_STABILITY_FACTOR",
1436 s->prop_factor = PROPORTIONALITY_FACTOR;
1437 if (GNUNET_SYSERR !=
1438 GNUNET_CONFIGURATION_get_value_float (env->cfg,
1440 "PROP_PROPORTIONALITY_FACTOR",
1445 LOG (GNUNET_ERROR_TYPE_ERROR,
1446 _("Invalid %s configuration %f\n"),
1447 "PROP_PROPORTIONALITY_FACTOR",
1452 s->prop_factor = f_tmp;
1453 LOG (GNUNET_ERROR_TYPE_INFO,
1454 "Using %s of %.3f\n",
1455 "PROP_PROPORTIONALITY_FACTOR",
1460 s->network_entries = GNUNET_malloc (env->network_count *
1461 sizeof (struct Network));
1462 for (c = 0; c < env->network_count; c++)
1464 cur = &s->network_entries[c];
1466 cur->total_quota_in = env->in_quota[c];
1467 cur->total_quota_out = env->out_quota[c];
1468 cur->desc = GNUNET_ATS_print_network_type (c);
1469 GNUNET_asprintf (&cur->stat_total,
1470 "# ATS addresses %s total",
1472 GNUNET_asprintf (&cur->stat_active,
1473 "# ATS active addresses %s total",
1475 LOG (GNUNET_ERROR_TYPE_INFO,
1476 "Added network %u `%s' (%llu/%llu)\n",
1479 cur->total_quota_in,
1480 cur->total_quota_out);
1487 * Function used to unload the plugin.
1489 * @param cls return value from #libgnunet_plugin_ats_proportional_init()
1492 libgnunet_plugin_ats_proportional_done (void *cls)
1494 struct GNUNET_ATS_SolverFunctions *sf = cls;
1495 struct GAS_PROPORTIONAL_Handle *s = sf->cls;
1496 struct AddressWrapper *cur;
1497 struct AddressWrapper *next;
1500 for (c = 0; c < s->network_count; c++)
1502 GNUNET_break (0 == s->network_entries[c].total_addresses);
1503 GNUNET_break (0 == s->network_entries[c].active_addresses);
1504 next = s->network_entries[c].head;
1505 while (NULL != (cur = next))
1508 GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1509 s->network_entries[c].tail,
1511 GNUNET_free_non_null (cur->addr->solver_information);
1514 GNUNET_free (s->network_entries[c].stat_total);
1515 GNUNET_free (s->network_entries[c].stat_active);
1517 GNUNET_break (0 == s->active_addresses);
1518 GNUNET_free (s->network_entries);
1524 /* end of plugin_ats_proportional.c */