2 This file is part of GNUnet.
3 (C) 2011-2014 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
213 #define PROPORTIONALITY_FACTOR 2.0
216 * A handle for the proportional solver
218 struct GAS_PROPORTIONAL_Handle
220 struct GNUNET_ATS_PluginEnvironment *env;
225 struct GNUNET_STATISTICS_Handle *stats;
228 * Hashmap containing all valid addresses
230 struct GNUNET_CONTAINER_MultiPeerMap *addresses;
233 * Pending address requests
235 struct GNUNET_CONTAINER_MultiPeerMap *requests;
238 * Bandwidth changed callback
240 GAS_bandwidth_changed_cb bw_changed;
243 * Bandwidth changed callback cls
245 void *bw_changed_cls;
248 * ATS function to get preferences
250 GAS_get_preferences get_preferences;
253 * Closure for ATS function to get preferences
255 void *get_preferences_cls;
258 * ATS function to get properties
260 GAS_get_properties get_properties;
263 * Closure for ATS function to get properties
265 void *get_properties_cls;
273 * Number of changes while solver was locked
278 * Total number of addresses for solver
280 unsigned int total_addresses;
283 * Number of active addresses for solver
285 unsigned int active_addresses;
290 struct Network *network_entries;
295 unsigned int network_count;
298 * Proportionality factor
305 double stability_factor;
309 * Representation of a network
319 * Network description
324 * Total inbound quota
327 unsigned long long total_quota_in;
330 * Total outbound quota
333 unsigned long long total_quota_out;
336 * Number of active addresses for this network
338 unsigned int active_addresses;
341 * Number of total addresses for this network
343 unsigned int total_addresses;
346 * String for statistics total addresses
351 * String for statistics active addresses
356 * Linked list of addresses in this network: head
358 struct AddressWrapper *head;
361 * Linked list of addresses in this network: tail
363 struct AddressWrapper *tail;
367 * Address information stored in the solver
369 struct AddressSolverInformation
372 * Network scope this address is in
374 struct Network *network;
380 uint32_t calculated_quota_in;
386 uint32_t calculated_quota_out;
389 * When was this address activated
391 struct GNUNET_TIME_Absolute activated;
396 * Wrapper for addresses to store them in network's linked list
398 struct AddressWrapper
403 struct AddressWrapper *next;
408 struct AddressWrapper *prev;
413 struct ATS_Address *addr;
418 * Function used to unload the plugin.
420 * @param cls return value from #libgnunet_plugin_ats_proportional_init()
423 libgnunet_plugin_ats_proportional_done (void *cls)
425 struct GAS_PROPORTIONAL_Handle *s = cls;
426 struct AddressWrapper *cur;
427 struct AddressWrapper *next;
430 GNUNET_assert(s != NULL);
431 for (c = 0; c < s->network_count; c++)
433 if (s->network_entries[c].total_addresses > 0)
435 LOG(GNUNET_ERROR_TYPE_DEBUG,
436 "Had %u addresses for network `%s' not deleted during shutdown\n",
437 s->network_entries[c].total_addresses, s->network_entries[c].desc);
441 if (s->network_entries[c].active_addresses > 0)
443 LOG(GNUNET_ERROR_TYPE_DEBUG,
444 "Had %u active addresses for network `%s' not deleted during shutdown\n",
445 s->network_entries[c].active_addresses, s->network_entries[c].desc);
449 next = s->network_entries[c].head;
450 while (NULL != (cur = next))
453 GNUNET_CONTAINER_DLL_remove(s->network_entries[c].head,
454 s->network_entries[c].tail, cur);
455 GNUNET_free_non_null (cur->addr->solver_information);
458 GNUNET_free(s->network_entries[c].stat_total);
459 GNUNET_free(s->network_entries[c].stat_active);
461 if (s->total_addresses > 0)
463 LOG(GNUNET_ERROR_TYPE_DEBUG,
464 "Had %u addresses not deleted during shutdown\n", s->total_addresses);
467 if (s->active_addresses > 0)
469 LOG(GNUNET_ERROR_TYPE_DEBUG,
470 "Had %u active addresses not deleted during shutdown\n",
471 s->active_addresses);
474 GNUNET_free (s->network_entries);
475 GNUNET_CONTAINER_multipeermap_destroy (s->requests);
482 * Test if bandwidth is available in this network to add an additional address
484 * @param net the network type to update
485 * @return #GNUNET_YES or #GNUNET_NO
488 is_bandwidth_available_in_network (struct Network *net)
490 GNUNET_assert(NULL != net);
491 unsigned int na = net->active_addresses + 1;
492 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
493 if (((net->total_quota_in / na) > min_bw)
494 && ((net->total_quota_out / na) > min_bw))
496 LOG(GNUNET_ERROR_TYPE_DEBUG,
497 "Enough bandwidth available for %u active addresses in network `%s'\n",
502 LOG(GNUNET_ERROR_TYPE_DEBUG,
503 "Not enough bandwidth available for %u active addresses in network `%s'\n",
510 * Update bandwidth assigned to peers in this network
512 * @param s the solver handle
513 * @param net the network type to update
517 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
520 struct AddressSolverInformation *asi;
521 struct AddressWrapper *cur_address;
523 unsigned long long remaining_quota_in = 0;
524 unsigned long long quota_out_used = 0;
525 unsigned long long remaining_quota_out = 0;
526 unsigned long long quota_in_used = 0;
528 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
529 double relative_peer_prefence;
530 double sum_relative_peer_prefences; /* Important: has to be double not float due to precision */
531 double cur_pref; /* Important: has to be double not float due to precision */
534 const double *peer_relative_prefs = NULL; /* Important: has to be double not float due to precision */
536 uint32_t assigned_quota_in = 0;
537 uint32_t assigned_quota_out = 0;
540 LOG(GNUNET_ERROR_TYPE_INFO,
541 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
542 net->desc, net->active_addresses, net->total_quota_in,
543 net->total_quota_in);
545 if (net->active_addresses == 0)
547 return; /* no addresses to update */
551 * Assign every peer in network minimum Bandwidth
552 * Distribute bandwidth left according to preference
555 if ((net->active_addresses * min_bw) > net->total_quota_in)
560 if ((net->active_addresses * min_bw) > net->total_quota_out)
566 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
567 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
568 LOG(GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
569 remaining_quota_in, remaining_quota_out);
570 sum_relative_peer_prefences = 0.0;
572 /* Calculate sum of relative preference for active addresses in this network */
574 for (cur_address = net->head; NULL != cur_address; cur_address = cur_address->next)
576 if (GNUNET_YES != cur_address->addr->active)
579 GNUNET_assert( NULL != (peer_relative_prefs = s->get_preferences (s->get_preferences_cls,
580 &cur_address->addr->peer)));
581 relative_peer_prefence = 0.0;
582 relative_peer_prefence += peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
583 sum_relative_peer_prefences += relative_peer_prefence;
587 if (count_addresses != net->active_addresses)
590 LOG (GNUNET_ERROR_TYPE_WARNING,
591 "%s: Counted %u active addresses, but network says to have %u active addresses\n",
592 net->desc, count_addresses, net->active_addresses);
593 for (cur_address = net->head; NULL != cur_address; cur_address = cur_address->next)
595 if (GNUNET_YES != cur_address->addr->active)
598 LOG (GNUNET_ERROR_TYPE_WARNING,
599 "Active: `%s' `%s' length %u\n",
600 GNUNET_i2s (&cur_address->addr->peer),
601 cur_address->addr->plugin,
602 cur_address->addr->addr_len);
606 LOG (GNUNET_ERROR_TYPE_INFO,
607 "Total relative preference %.3f for %u addresses in network %s\n",
608 sum_relative_peer_prefences, net->active_addresses, net->desc);
610 for (cur_address = net->head; NULL != cur_address; cur_address = cur_address->next)
612 if (GNUNET_YES == cur_address->addr->active)
614 GNUNET_assert( NULL != (peer_relative_prefs =
615 s->get_preferences (s->get_preferences_cls, &cur_address->addr->peer)));
617 cur_pref = peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
618 total_weight = net->active_addresses +
619 s->prop_factor * sum_relative_peer_prefences;
620 peer_weight = (1.0 + (s->prop_factor * cur_pref));
622 assigned_quota_in = min_bw
623 + ((peer_weight / total_weight) * remaining_quota_in);
624 assigned_quota_out = min_bw
625 + ((peer_weight / total_weight) * remaining_quota_out);
627 LOG (GNUNET_ERROR_TYPE_INFO,
628 "New quota for peer `%s' with weight (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
629 GNUNET_i2s (&cur_address->addr->peer), peer_weight, total_weight,
630 assigned_quota_in, assigned_quota_out);
634 assigned_quota_in = 0;
635 assigned_quota_out = 0;
638 quota_in_used += assigned_quota_in;
639 quota_out_used += assigned_quota_out;
640 /* Prevent overflow due to rounding errors */
641 if (assigned_quota_in > UINT32_MAX)
642 assigned_quota_in = UINT32_MAX;
643 if (assigned_quota_out > UINT32_MAX)
644 assigned_quota_out = UINT32_MAX;
646 /* Compare to current bandwidth assigned */
647 asi = cur_address->addr->solver_information;
648 asi->calculated_quota_in = assigned_quota_in;
649 asi->calculated_quota_out = assigned_quota_out;
651 LOG(GNUNET_ERROR_TYPE_DEBUG,
652 "Total bandwidth assigned is (in/out): %llu /%llu\n", quota_in_used,
654 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
656 LOG(GNUNET_ERROR_TYPE_ERROR,
657 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
658 net->active_addresses, quota_out_used, net->total_quota_out);
660 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
662 LOG(GNUNET_ERROR_TYPE_ERROR,
663 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
664 net->active_addresses, quota_in_used, net->total_quota_in);
670 * Context for finding the best address* Linked list of addresses in this network: head
672 struct FindBestAddressCtx
677 struct GAS_PROPORTIONAL_Handle *s;
680 * The currently best address
682 struct ATS_Address *best;
687 * Find index of a ATS property type in the array.
690 find_property_index (uint32_t type)
692 int existing_types[] = GNUNET_ATS_QualityProperties;
695 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
696 if (existing_types[c] == type)
698 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 FindBestAddressCtx *' 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 = cls;
718 struct ATS_Address *current = value;
719 struct ATS_Address *current_best = current;
720 struct GNUNET_TIME_Absolute now;
721 struct AddressSolverInformation *asi;
722 struct GNUNET_TIME_Relative active_time;
723 struct GNUNET_TIME_Relative min_active_time;
724 const double *norm_prop_cur;
725 const double *norm_prop_best;
727 double best_distance;
733 asi = current->solver_information;
734 now = GNUNET_TIME_absolute_get ();
736 if ((current->active == GNUNET_NO)
737 && (current->blocked_until.abs_value_us
738 == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value_us))
740 /* This address is blocked for suggestion */
741 LOG (GNUNET_ERROR_TYPE_DEBUG,
742 "Address %p blocked for suggestion for %s \n",
744 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (now, current->blocked_until),
754 if (GNUNET_NO == is_bandwidth_available_in_network (asi->network))
756 return GNUNET_OK; /* There's no bandwidth available in this network */
759 if (NULL != ctx->best)
761 /* Compare current addresses with denominated 'best' address */
762 current_best = ctx->best;
766 /* We do not have a 'best' address so take this address */
767 LOG (GNUNET_ERROR_TYPE_DEBUG,
768 "Setting initial address %p\n",
770 current_best = current;
774 if (GNUNET_YES == current->active)
776 GNUNET_assert (asi->activated.abs_value_us != GNUNET_TIME_UNIT_ZERO_ABS.abs_value_us);
777 active_time = GNUNET_TIME_absolute_get_duration (asi->activated);
778 min_active_time.rel_value_us = ((double) GNUNET_TIME_UNIT_SECONDS.rel_value_us) *
779 ctx->s->stability_factor;
780 if (active_time.rel_value_us <= min_active_time.rel_value_us)
782 /* Keep active address for stability reasons */
788 /* Now compare ATS information */
789 norm_prop_cur = ctx->s->get_properties (ctx->s->get_properties_cls,
790 (const struct ATS_Address *) current);
791 index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
792 cur_distance = norm_prop_cur[index];
793 index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
794 cur_delay = norm_prop_cur[index];
796 norm_prop_best = ctx->s->get_properties (ctx->s->get_properties_cls,
797 (const struct ATS_Address *) ctx->best);
798 index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
799 best_distance = norm_prop_best[index];
800 index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
801 best_delay = norm_prop_best[index];
803 /* user shorter distance */
804 if (cur_distance < best_distance)
807 if (GNUNET_NO == ctx->best->active)
809 current_best = current; /* Use current */
811 else if ((best_distance / cur_distance) > ctx->s->stability_factor)
813 /* Best and active address performs worse */
814 current_best = current;
819 /* Use current best */
820 current_best = ctx->best;
823 /* User connection with less delay */
824 if (cur_delay < best_delay)
827 if (GNUNET_NO == ctx->best->active)
829 current_best = current; /* Use current */
831 else if ((best_delay / cur_delay) > ctx->s->stability_factor)
833 /* Best and active address performs worse */
834 current_best = current;
839 /* Use current best */
840 current_best = ctx->best;
844 ctx->best = current_best;
850 * Find the currently best address for a peer from the set of addresses available
851 * or return NULL of no address is available
853 * @param s the proportional handle
854 * @param addresses the address hashmap
855 * @param id the peer id
856 * @return the address or NULL
859 get_best_address (struct GAS_PROPORTIONAL_Handle *s,
860 struct GNUNET_CONTAINER_MultiPeerMap *addresses,
861 const struct GNUNET_PeerIdentity *id)
863 struct FindBestAddressCtx fba_ctx;
867 GNUNET_CONTAINER_multipeermap_get_multiple (addresses, id,
868 &find_best_address_it, &fba_ctx);
875 * Hashmap Iterator to find current active address for peer
877 * @param cls last active address
878 * @param key peer's key
879 * @param value address to check
880 * @return #GNUNET_NO on double active address else #GNUNET_YES;
883 get_active_address_it (void *cls,
884 const struct GNUNET_PeerIdentity *key,
887 struct ATS_Address **dest = cls;
888 struct ATS_Address *aa = (struct ATS_Address *) value;
890 LOG (GNUNET_ERROR_TYPE_INFO,
891 "Checking address %p\n", aa);
893 if (GNUNET_YES == aa->active)
895 LOG (GNUNET_ERROR_TYPE_INFO,
896 "Address %p is active\n", aa);
899 /* should never happen */
900 LOG (GNUNET_ERROR_TYPE_ERROR,
901 "Multiple active addresses for peer `%s'\n",
902 GNUNET_i2s (&aa->peer));
914 * Find current active address for peer
916 * @param solver the solver handle
917 * @param addresses the address set
918 * @param peer the peer
919 * @return active address or NULL
921 static struct ATS_Address *
922 get_active_address (void *solver,
923 const struct GNUNET_CONTAINER_MultiPeerMap * addresses,
924 const struct GNUNET_PeerIdentity *peer)
926 static struct ATS_Address * dest = NULL;
929 GNUNET_CONTAINER_multipeermap_get_multiple (addresses, peer,
930 &get_active_address_it, &dest);
936 * Lookup network struct by type
938 * @param s the solver handle
939 * @param type the network type
940 * @return the network struct
942 static struct Network *
943 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
946 for (c = 0; c < s->network_count; c++)
948 if (s->network_entries[c].type == type)
949 return &s->network_entries[c];
956 * Increase address count in network
958 * @param s the solver handle
959 * @param net the network type
960 * @param total increase total addresses
961 * @param active increase active addresses
964 address_increment (struct GAS_PROPORTIONAL_Handle *s,
969 if (GNUNET_YES == total)
971 s->total_addresses++;
972 net->total_addresses++;
973 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
974 GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
976 if (GNUNET_YES == active)
978 net->active_addresses++;
979 s->active_addresses++;
980 GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1,
982 GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
989 * Decrease address count in network
991 * @param s the solver handle
992 * @param net the network type
993 * @param total decrease total addresses
994 * @param active decrease active addresses
997 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
1002 int res = GNUNET_OK;
1004 if (GNUNET_YES == total)
1006 if (s->total_addresses < 1)
1009 res = GNUNET_SYSERR;
1013 s->total_addresses--;
1014 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1017 if (net->total_addresses < 1)
1020 res = GNUNET_SYSERR;
1024 net->total_addresses--;
1025 GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
1029 if (GNUNET_YES == active)
1031 if (net->active_addresses < 1)
1034 res = GNUNET_SYSERR;
1038 net->active_addresses--;
1039 GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
1041 if (s->active_addresses < 1)
1044 res = GNUNET_SYSERR;
1048 s->active_addresses--;
1049 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1058 * Compares addresses
1060 * @param a address a
1061 * @param b address b
1062 * @return GNUNET_YES if equal, GNUNET_NO else
1065 address_eq (struct ATS_Address *a, struct ATS_Address *b)
1067 GNUNET_assert (NULL != a);
1068 GNUNET_assert (NULL != b);
1069 if (0 != strcmp(a->plugin, b->plugin))
1071 if (a->addr_len != b->addr_len)
1073 if (0 != memcmp (a->addr, b->addr, b->addr_len))
1075 if (a->session_id != b->session_id)
1082 * Notify bandwidth changes to addresses
1084 * @param s solver handle
1085 * @param net the network to propagate changes in
1088 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
1089 struct Network *net)
1091 struct AddressWrapper *cur;
1092 struct AddressSolverInformation *asi;
1093 for (cur = net->head; NULL != cur; cur = cur->next)
1095 asi = cur->addr->solver_information;
1096 if ( (cur->addr->assigned_bw_in != asi->calculated_quota_in) ||
1097 (cur->addr->assigned_bw_out != asi->calculated_quota_out) )
1099 cur->addr->assigned_bw_in = asi->calculated_quota_in;
1100 cur->addr->assigned_bw_out = asi->calculated_quota_out;
1102 /* Reset for next iteration */
1103 asi->calculated_quota_in = 0;
1104 asi->calculated_quota_out = 0;
1105 LOG (GNUNET_ERROR_TYPE_DEBUG,
1106 "Bandwidth for %s address %p for peer `%s' changed to %u/%u\n",
1107 (GNUNET_NO == cur->addr->active) ? "inactive" : "active",
1109 GNUNET_i2s (&cur->addr->peer),
1110 cur->addr->assigned_bw_in,
1111 cur->addr->assigned_bw_out);
1113 /* Notify on change */
1114 if ((GNUNET_YES == cur->addr->active))
1116 s->bw_changed (s->bw_changed_cls, cur->addr);
1124 * Distribibute bandwidth
1126 * @param s the solver handle
1127 * @param n the network, can be NULL for all network
1130 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
1133 if (GNUNET_YES == s->bulk_lock)
1141 LOG (GNUNET_ERROR_TYPE_INFO,
1142 "Redistributing bandwidth in network %s with %u active and %u total addresses\n",
1143 GNUNET_ATS_print_network_type(n->type),
1144 n->active_addresses, n->total_addresses);
1146 if (NULL != s->env->info_cb)
1147 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
1148 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1151 distribute_bandwidth(s, n);
1153 if (NULL != s->env->info_cb)
1154 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
1155 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1156 if (NULL != s->env->info_cb)
1157 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
1158 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1160 /* Do propagation */
1161 propagate_bandwidth (s, n);
1163 if (NULL != s->env->info_cb)
1164 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
1165 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1170 if (NULL != s->env->info_cb)
1171 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
1172 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1173 for (i = 0; i < s->network_count; i++)
1176 distribute_bandwidth(s, &s->network_entries[i]);
1179 if (NULL != s->env->info_cb)
1180 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
1181 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1182 if (NULL != s->env->info_cb)
1183 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
1184 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1185 for (i = 0; i < s->network_count; i++)
1187 /* Do propagation */
1188 propagate_bandwidth(s, &s->network_entries[i]);
1190 if (NULL != s->env->info_cb)
1191 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
1192 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1198 * Update active address for a peer:
1199 * Check if active address exists and what the best address is, if addresses
1200 * are different switch
1202 * @param s solver handle
1203 * @param peer the peer to check
1204 * return the new address or NULL if no update was performed
1206 static const struct ATS_Address *
1207 update_active_address (struct GAS_PROPORTIONAL_Handle *s,
1208 const struct GNUNET_PeerIdentity *peer)
1210 struct ATS_Address *best_address;
1211 struct ATS_Address *current_address;
1212 struct AddressSolverInformation *asi;
1213 struct Network *net;
1215 LOG (GNUNET_ERROR_TYPE_INFO,
1216 "Updating active address for peer `%s'\n",
1219 /* Find active address */
1220 current_address = get_active_address (s, s->addresses, peer);
1222 LOG (GNUNET_ERROR_TYPE_INFO, "Peer `%s' has active address %p\n",
1223 GNUNET_i2s (peer), current_address);
1225 /* Find best address */
1226 best_address = get_best_address (s,s->addresses, peer);
1227 LOG (GNUNET_ERROR_TYPE_INFO, "Peer `%s' has best address %p\n",
1228 GNUNET_i2s (peer), best_address);
1230 if (NULL != current_address)
1232 if ((NULL == best_address) || ((NULL != best_address) &&
1233 (GNUNET_NO == address_eq (current_address, best_address))))
1235 /* We switch to a new address, mark old address as inactive */
1236 LOG (GNUNET_ERROR_TYPE_INFO,
1237 "Disabling previous %s address %p for peer `%s'\n",
1238 (GNUNET_NO == current_address->active) ? "inactive" : "active",
1242 asi = current_address->solver_information;
1243 GNUNET_assert (NULL != asi);
1246 asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
1247 current_address->active = GNUNET_NO; /* No active any longer */
1248 current_address->assigned_bw_in = 0; /* no bandwidth assigned */
1249 current_address->assigned_bw_out = 0; /* no bandwidth assigned */
1251 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1254 /* Update network of previous address */
1255 distribute_bandwidth_in_network (s, net);
1257 if (NULL == best_address)
1259 /* We previously had an active address, but now we cannot suggest one
1260 * Therefore we have to disconnect the peer */
1262 LOG (GNUNET_ERROR_TYPE_INFO,
1263 "Disconnecting peer `%s' with previous %s address %p\n",
1265 (GNUNET_NO == current_address->active) ? "inactive" : "active",
1267 s->bw_changed (s->bw_changed_cls, current_address);
1271 if (NULL == best_address)
1273 LOG (GNUNET_ERROR_TYPE_INFO, "Cannot suggest address for peer `%s'\n",
1278 LOG (GNUNET_ERROR_TYPE_INFO, "Suggesting %s address %p for peer `%s'\n",
1279 (GNUNET_NO == best_address->active) ? "inactive" : "active", best_address,
1282 if ((NULL != current_address) &&
1283 (GNUNET_YES == address_eq (best_address, current_address)))
1285 if (current_address->active == GNUNET_NO)
1286 GNUNET_break (0); /* Should never happen */
1287 return best_address; /* Same same */
1290 asi = best_address->solver_information;
1291 GNUNET_assert (NULL != asi);
1294 /* Mark address as active */
1295 asi->activated = GNUNET_TIME_absolute_get();
1296 best_address->active = GNUNET_YES;
1297 address_increment (s, net, GNUNET_NO, GNUNET_YES);
1298 LOG (GNUNET_ERROR_TYPE_INFO, "Address %p for peer `%s' is now active\n",
1299 best_address, GNUNET_i2s (peer));
1300 /* Distribute bandwidth */
1301 distribute_bandwidth_in_network (s, net);
1302 return best_address;
1307 * Changes the preferences for a peer in the problem
1309 * @param solver the solver handle
1310 * @param peer the peer to change the preference for
1311 * @param kind the kind to change the preference
1312 * @param pref_rel the normalized preference value for this kind over all clients
1315 GAS_proportional_address_change_preference (void *solver,
1316 const struct GNUNET_PeerIdentity *peer,
1317 enum GNUNET_ATS_PreferenceKind kind,
1320 struct GAS_PROPORTIONAL_Handle *s = solver;
1321 struct ATS_Address *best_address;
1322 struct ATS_Address *active_address;
1323 struct AddressSolverInformation *asi;
1325 GNUNET_assert(NULL != s);
1326 GNUNET_assert(NULL != peer);
1328 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, peer))
1329 return; /* Peer is not requested */
1331 /* This peer is requested, find best address */
1332 active_address = get_active_address(s, s->addresses, peer);
1333 best_address = (struct ATS_Address *) update_active_address (s, peer);
1335 if ((NULL != best_address) && ((NULL != active_address) &&
1336 (GNUNET_YES == address_eq (active_address, best_address))))
1338 asi = best_address->solver_information;
1339 GNUNET_assert (NULL != asi);
1341 /* We sticked to the same address, therefore redistribute */
1342 distribute_bandwidth_in_network (s, asi->network);
1348 * Get application feedback for a peer
1350 * @param solver the solver handle
1351 * @param application the application
1352 * @param peer the peer to change the preference for
1353 * @param scope the time interval for this feedback: [now - scope .. now]
1354 * @param kind the kind to change the preference
1355 * @param score the score
1358 GAS_proportional_address_preference_feedback (void *solver,
1360 const struct GNUNET_PeerIdentity *peer,
1361 const struct GNUNET_TIME_Relative scope,
1362 enum GNUNET_ATS_PreferenceKind kind,
1365 struct GAS_PROPORTIONAL_Handle *s = solver;
1367 GNUNET_assert(NULL != peer);
1368 GNUNET_assert(NULL != s);
1373 * Get the preferred address for a specific peer
1375 * @param solver the solver handle
1376 * @param peer the identity of the peer
1377 * @return best address
1379 static const struct ATS_Address *
1380 GAS_proportional_get_preferred_address (void *solver,
1381 const struct GNUNET_PeerIdentity *peer)
1383 struct GAS_PROPORTIONAL_Handle *s = solver;
1384 const struct ATS_Address *best_address;
1387 GNUNET_assert(s != NULL);
1388 GNUNET_assert(peer != NULL);
1390 /* Add to list of pending requests */
1391 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, peer))
1394 GNUNET_OK == GNUNET_CONTAINER_multipeermap_put (s->requests, peer, NULL,
1395 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1396 LOG (GNUNET_ERROR_TYPE_INFO, "Start suggesting addresses for peer `%s'\n",
1400 best_address = update_active_address (s, peer);
1401 if (s->bulk_lock > 0)
1402 return NULL; /* Do not suggest since bulk lock is pending */
1404 return best_address;
1409 * Stop notifying about address and bandwidth changes for this peer
1411 * @param solver the solver handle
1412 * @param peer the peer
1415 GAS_proportional_stop_get_preferred_address (void *solver,
1416 const struct GNUNET_PeerIdentity *peer)
1418 struct GAS_PROPORTIONAL_Handle *s = solver;
1419 struct ATS_Address *cur;
1420 struct AddressSolverInformation *asi;
1421 struct Network *cur_net;
1423 if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (s->requests, peer))
1425 GNUNET_assert (GNUNET_OK ==
1426 GNUNET_CONTAINER_multipeermap_remove (s->requests,
1428 LOG (GNUNET_ERROR_TYPE_INFO,
1429 "Stop suggesting addresses for peer `%s'\n",
1433 cur = get_active_address (s, s->addresses, peer);
1436 LOG(GNUNET_ERROR_TYPE_INFO,
1437 "Disabling %s address %p for peer `%s'\n",
1438 (GNUNET_NO == cur->active) ? "inactive" : "active", cur,
1439 GNUNET_i2s (&cur->peer));
1441 /* Disabling current address */
1442 asi = cur->solver_information;
1443 cur_net = asi->network ;
1444 asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
1445 cur->active = GNUNET_NO; /* No active any longer */
1446 cur->assigned_bw_in = 0; /* no bandwidth assigned */
1447 cur->assigned_bw_out = 0; /* no bandwidth assigned */
1449 if (GNUNET_SYSERR == addresse_decrement (s, cur_net, GNUNET_NO, GNUNET_YES))
1452 distribute_bandwidth_in_network (s, cur_net );
1459 * Remove an address from the solver
1461 * @param solver the solver handle
1462 * @param address the address to remove
1463 * @param session_only delete only session not whole address
1466 GAS_proportional_address_delete (void *solver,
1467 struct ATS_Address *address,
1470 struct GAS_PROPORTIONAL_Handle *s = solver;
1471 struct Network *net;
1472 struct AddressWrapper *aw;
1473 struct AddressSolverInformation *asi;
1475 /* Remove an adress completely, we have to:
1476 * - Remove from specific network
1477 * - Decrease number of total addresses
1479 * - decrease number of active addreses
1482 asi = address->solver_information;
1491 if (GNUNET_NO == session_only)
1493 LOG(GNUNET_ERROR_TYPE_INFO,
1494 "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1495 (GNUNET_NO == address->active) ? "inactive" : "active", address,
1496 GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1497 net->active_addresses);
1499 /* Remove address */
1500 addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
1501 for (aw = net->head; NULL != aw; aw = aw->next)
1503 if (aw->addr == address)
1511 GNUNET_CONTAINER_DLL_remove(net->head, net->tail, aw);
1516 /* Remove session only: remove if active and update */
1517 LOG(GNUNET_ERROR_TYPE_INFO,
1518 "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1519 (GNUNET_NO == address->active) ? "inactive" : "active", address,
1520 GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1521 net->active_addresses);
1524 if (GNUNET_YES == address->active)
1526 /* Address was active, remove from network and update quotas*/
1527 address->active = GNUNET_NO;
1529 address->assigned_bw_in = 0;
1530 address->assigned_bw_out = 0;
1531 asi->calculated_quota_in = 0;
1532 asi->calculated_quota_out = 0;
1534 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1536 distribute_bandwidth_in_network (s, net);
1538 if (NULL == update_active_address (s, &address->peer))
1540 /* No alternative address found, disconnect peer */
1541 LOG (GNUNET_ERROR_TYPE_INFO,
1542 "Disconnecting peer `%s' after deleting previous %s address %p\n",
1543 GNUNET_i2s (&address->peer),
1544 (GNUNET_NO == address->active) ? "inactive" : "active",
1546 s->bw_changed (s->bw_changed_cls, address);
1549 if (GNUNET_NO == session_only)
1551 GNUNET_free_non_null (address->solver_information);
1552 address->solver_information = NULL;
1555 LOG(GNUNET_ERROR_TYPE_INFO,
1556 "After deleting address now total %u and active %u addresses in network `%s'\n",
1557 net->total_addresses, net->active_addresses, net->desc);
1563 * Start a bulk operation
1565 * @param solver the solver
1568 GAS_proportional_bulk_start (void *solver)
1570 struct GAS_PROPORTIONAL_Handle *s = solver;
1572 LOG (GNUNET_ERROR_TYPE_DEBUG,
1573 "Locking solver for bulk operation ...\n");
1574 GNUNET_assert(NULL != solver);
1580 * Bulk operation done
1583 GAS_proportional_bulk_stop (void *solver)
1585 struct GAS_PROPORTIONAL_Handle *s = solver;
1587 LOG (GNUNET_ERROR_TYPE_DEBUG,
1588 "Unlocking solver from bulk operation ...\n");
1589 GNUNET_assert(NULL != solver);
1591 if (s->bulk_lock < 1)
1597 if ((0 == s->bulk_lock) && (0 < s->bulk_requests))
1599 LOG(GNUNET_ERROR_TYPE_INFO, "No lock pending, recalculating\n");
1600 distribute_bandwidth_in_network (s, NULL);
1601 s->bulk_requests = 0;
1607 * Add a new single address to a network
1609 * @param solver the solver Handle
1610 * @param address the address to add
1611 * @param network network type of this address
1614 GAS_proportional_address_add (void *solver,
1615 struct ATS_Address *address,
1620 * Transport properties for this address have changed
1622 * @param solver solver handle
1623 * @param address the address
1624 * @param type the ATSI type in HBO
1625 * @param abs_value the absolute value of the property
1626 * @param rel_value the normalized value
1629 GAS_proportional_address_property_changed (void *solver,
1630 struct ATS_Address *address,
1635 struct GAS_PROPORTIONAL_Handle *s = solver;
1637 struct AddressSolverInformation *asi;
1638 struct ATS_Address *best_address;
1639 struct ATS_Address *active_address;
1641 GNUNET_assert(NULL != s);
1642 GNUNET_assert(NULL != address);
1643 asi = address->solver_information;
1657 LOG(GNUNET_ERROR_TYPE_INFO,
1658 "Property `%s' for peer `%s' address %p changed to %.2f \n",
1659 GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1660 address, rel_value);
1662 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1663 return; /* Peer is not requested */
1665 /* This peer is requested, find active and best address */
1666 active_address = get_active_address(s, s->addresses, &address->peer);
1667 best_address = (struct ATS_Address *) update_active_address (s, &address->peer);
1669 if ((NULL != best_address) && ((NULL != active_address) &&
1670 (GNUNET_YES == address_eq (active_address, best_address))))
1672 asi = best_address->solver_information;
1673 GNUNET_assert (NULL != asi);
1675 /* We sticked to the same address, therefore redistribute */
1676 distribute_bandwidth_in_network (s, asi->network);
1681 * Transport session for this address has changed
1683 * NOTE: values in addresses are already updated
1685 * @param solver solver handle
1686 * @param address the address
1687 * @param cur_session the current session
1688 * @param new_session the new session
1691 GAS_proportional_address_session_changed (void *solver,
1692 struct ATS_Address *address,
1693 uint32_t cur_session,
1694 uint32_t new_session)
1696 struct GAS_PROPORTIONAL_Handle *s = solver;
1697 struct ATS_Address *best_address;
1698 struct ATS_Address *active_address;
1699 struct AddressSolverInformation *asi;
1701 if (cur_session != new_session)
1703 LOG (GNUNET_ERROR_TYPE_DEBUG,
1704 "Session changed from %u to %u\n",
1709 if (NULL == address->solver_information)
1715 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1716 return; /* Peer is not requested */
1718 /* This peer is requested, find active and best address */
1719 active_address = get_active_address(s, s->addresses, &address->peer);
1720 best_address = (struct ATS_Address *) update_active_address (s, &address->peer);
1722 if ((NULL != best_address) && ((NULL != active_address) &&
1723 (GNUNET_YES == address_eq (active_address, best_address))))
1725 asi = best_address->solver_information;
1726 GNUNET_assert (NULL != asi);
1728 /* We sticked to the same address, therefore redistribute */
1729 distribute_bandwidth_in_network (s, asi->network);
1735 * Usage for this address has changed
1737 * NOTE: values in addresses are already updated
1739 * @param solver solver handle
1740 * @param address the address
1741 * @param in_use usage state
1744 GAS_proportional_address_inuse_changed (void *solver,
1745 struct ATS_Address *address,
1748 struct GAS_PROPORTIONAL_Handle *s = solver;
1750 struct AddressSolverInformation *asi;
1751 struct ATS_Address *best_address;
1752 struct ATS_Address *active_address;
1754 GNUNET_assert(NULL != s);
1755 GNUNET_assert(NULL != address);
1756 asi = address->solver_information;
1770 LOG(GNUNET_ERROR_TYPE_INFO,
1771 "Usage of peer `%s' address %p changed to %s \n",
1772 GNUNET_i2s (&address->peer), address,
1773 (GNUNET_YES == in_use) ? "YES" : "NO");
1775 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1776 return; /* Peer is not requested */
1778 /* This peer is requested, find active and best address */
1779 active_address = get_active_address(s, s->addresses, &address->peer);
1780 best_address = (struct ATS_Address *) update_active_address (s, &address->peer);
1782 if ((NULL != best_address) && ((NULL != active_address) &&
1783 (GNUNET_YES == address_eq (active_address, best_address))))
1785 asi = best_address->solver_information;
1786 GNUNET_assert (NULL != asi);
1788 /* We sticked to the same address, therefore redistribute */
1789 distribute_bandwidth_in_network (s, asi->network);
1794 * Network scope for this address has changed
1796 * NOTE: values in addresses are already updated
1798 * @param solver solver handle
1799 * @param address the address
1800 * @param current_network the current network
1801 * @param new_network the new network
1804 GAS_proportional_address_change_network (void *solver,
1805 struct ATS_Address *address,
1806 uint32_t current_network,
1807 uint32_t new_network)
1809 struct GAS_PROPORTIONAL_Handle *s = solver;
1810 struct AddressSolverInformation *asi;
1811 int save_active = GNUNET_NO;
1813 if (current_network == new_network)
1819 asi = address->solver_information;
1826 /* Network changed */
1827 LOG(GNUNET_ERROR_TYPE_DEBUG,
1828 "Network type changed, moving %s address from `%s' to `%s'\n",
1829 (GNUNET_YES == address->active) ? "active" : "inactive",
1830 GNUNET_ATS_print_network_type (current_network),
1831 GNUNET_ATS_print_network_type (new_network));
1834 /* Start bulk to prevent disconnect */
1835 GAS_proportional_bulk_start(s);
1837 save_active = address->active;
1839 /* Disable and assign no bandwidth */
1840 address->active = GNUNET_NO;
1841 address->assigned_bw_in = 0; /* no bandwidth assigned */
1842 address->assigned_bw_out = 0; /* no bandwidth assigned */
1844 /* Remove from old network */
1845 GAS_proportional_address_delete (solver, address, GNUNET_NO);
1847 /* Set new network type */
1848 if (NULL == get_network (solver, new_network))
1850 /* Address changed to invalid network... */
1851 LOG(GNUNET_ERROR_TYPE_ERROR,
1852 _("Invalid network type `%u' `%s': Disconnect!\n"), new_network,
1853 GNUNET_ATS_print_network_type (new_network));
1854 s->bw_changed (s->bw_changed_cls, address);
1858 /* Add to new network and update*/
1859 GAS_proportional_address_add (solver, address, new_network);
1861 GAS_proportional_bulk_stop (s);
1863 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1864 return; /* Peer is not requested */
1866 /* Find new address to suggest */
1867 if (GNUNET_YES == save_active)
1869 /* No address available, therefore disconnect */
1870 if (NULL == update_active_address (s, &address->peer))
1871 s->bw_changed (s->bw_changed_cls, address);
1877 * Add a new single address to a network
1879 * @param solver the solver Handle
1880 * @param address the address to add
1881 * @param network network type of this address
1884 GAS_proportional_address_add (void *solver,
1885 struct ATS_Address *address,
1888 struct GAS_PROPORTIONAL_Handle *s = solver;
1889 struct Network *net = NULL;
1890 struct AddressWrapper *aw = NULL;
1891 struct AddressSolverInformation *asi;
1893 GNUNET_assert(NULL != s);
1894 net = get_network (s, network);
1899 LOG(GNUNET_ERROR_TYPE_ERROR,
1900 "Unknown network %u `%s' for new address %p for peer `%s'\n",
1901 network, GNUNET_ATS_print_network_type(network),
1902 address, GNUNET_i2s(&address->peer));
1907 aw = GNUNET_new (struct AddressWrapper);
1909 GNUNET_CONTAINER_DLL_insert(net->head, net->tail, aw);
1910 address_increment (s, net, GNUNET_YES, GNUNET_NO);
1912 asi = GNUNET_new (struct AddressSolverInformation);
1914 asi->calculated_quota_in = 0;
1915 asi->calculated_quota_out = 0;
1916 aw->addr->solver_information = asi;
1918 LOG(GNUNET_ERROR_TYPE_INFO,
1919 "Adding new address %p for peer `%s', now total %u and active %u addresses in network `%s'\n",
1920 address, GNUNET_i2s(&address->peer), net->total_addresses, net->active_addresses, net->desc);
1922 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1923 return; /* Peer is not requested */
1925 /* This peer is requested, find best address */
1926 update_active_address (s, &address->peer);
1932 * Function invoked when the plugin is loaded.
1934 * @param[in,out] cls the `struct GNUNET_ATS_PluginEnvironment *` to use;
1935 * modified to return the API functions (ugh).
1936 * @return the `struct GAS_PROPORTIONAL_Handle` to pass as a closure
1939 libgnunet_plugin_ats_proportional_init (void *cls)
1941 struct GNUNET_ATS_PluginEnvironment *env = cls;
1942 struct GAS_PROPORTIONAL_Handle *s;
1943 struct Network * cur;
1947 GNUNET_assert (NULL != env);
1948 GNUNET_assert (NULL != env->cfg);
1949 GNUNET_assert (NULL != env->bandwidth_changed_cb);
1950 GNUNET_assert (NULL != env->get_preferences);
1951 GNUNET_assert (NULL != env->get_property);
1953 s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
1955 env->sf.s_add = &GAS_proportional_address_add;
1956 env->sf.s_address_update_property = &GAS_proportional_address_property_changed;
1957 env->sf.s_address_update_session = &GAS_proportional_address_session_changed;
1958 env->sf.s_address_update_inuse = &GAS_proportional_address_inuse_changed;
1959 env->sf.s_address_update_network = &GAS_proportional_address_change_network;
1960 env->sf.s_get = &GAS_proportional_get_preferred_address;
1961 env->sf.s_get_stop = &GAS_proportional_stop_get_preferred_address;
1962 env->sf.s_pref = &GAS_proportional_address_change_preference;
1963 env->sf.s_feedback = &GAS_proportional_address_preference_feedback;
1964 env->sf.s_del = &GAS_proportional_address_delete;
1965 env->sf.s_bulk_start = &GAS_proportional_bulk_start;
1966 env->sf.s_bulk_stop = &GAS_proportional_bulk_stop;
1968 s->stats = (struct GNUNET_STATISTICS_Handle *) env->stats;
1969 s->bw_changed = env->bandwidth_changed_cb;
1970 s->bw_changed_cls = env->bw_changed_cb_cls;
1971 s->get_preferences = env->get_preferences;
1972 s->get_preferences_cls = env->get_preference_cls;
1973 s->get_properties = env->get_property;
1974 s->get_properties_cls = env->get_property_cls;
1975 s->network_count = env->network_count;
1976 s->network_entries = GNUNET_malloc (env->network_count * sizeof (struct Network));
1979 s->active_addresses = 0;
1980 s->total_addresses = 0;
1981 s->bulk_lock = GNUNET_NO;
1982 s->addresses = env->addresses;
1983 s->requests = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1985 s->stability_factor = PROP_STABILITY_FACTOR;
1986 if (GNUNET_SYSERR !=
1987 GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
1988 "PROP_STABILITY_FACTOR", &f_tmp))
1990 if ((f_tmp < 1.0) || (f_tmp > 2.0))
1992 LOG (GNUNET_ERROR_TYPE_ERROR,
1993 _("Invalid %s configuration %f \n"),
1994 "PROP_STABILITY_FACTOR",
1999 s->stability_factor = f_tmp;
2000 LOG (GNUNET_ERROR_TYPE_INFO,
2001 "Using %s of %.3f\n",
2002 "PROP_STABILITY_FACTOR", f_tmp);
2006 s->prop_factor = PROPORTIONALITY_FACTOR;
2007 if (GNUNET_SYSERR !=
2008 GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2009 "PROP_PROPORTIONALITY_FACTOR",
2014 LOG (GNUNET_ERROR_TYPE_ERROR,
2015 _("Invalid %s configuration %f \n"),
2016 "PROP_PROPORTIONALITY_FACTOR", f_tmp);
2020 s->prop_factor = f_tmp;
2021 LOG (GNUNET_ERROR_TYPE_INFO,
2022 "Using %s of %.3f\n",
2023 "PROP_PROPORTIONALITY_FACTOR", f_tmp);
2027 for (c = 0; c < env->network_count; c++)
2029 cur = &s->network_entries[c];
2030 cur->type = env->networks[c];
2031 cur->total_quota_in = env->in_quota[c];
2032 cur->total_quota_out = env->out_quota[c];
2033 cur->desc = GNUNET_ATS_print_network_type (c);
2034 GNUNET_asprintf (&cur->stat_total,
2035 "# ATS addresses %s total",
2037 GNUNET_asprintf (&cur->stat_active,
2038 "# ATS active addresses %s total",
2040 LOG (GNUNET_ERROR_TYPE_INFO,
2041 "Added network %u `%s' (%llu/%llu)\n",
2044 cur->total_quota_in,
2045 cur->total_quota_out);
2051 /* end of plugin_ats_proportional.c */