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-service-ats_addresses.h"
32 #define PROP_STABILITY_FACTOR 1.25
35 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
40 * NOTE: Do not change this documentation. This documentation is based
41 * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
42 * use build_txt.sh to generate plaintext output
44 * ATS addresses : proportional solver
46 * The proportional solver ("proportional") distributes the available
47 * bandwidth fair over all the addresses influenced by the
48 * preference values. For each available network type an in- and
49 * outbound quota is configured and the bandwidth available in
50 * these networks is distributed over the addresses. The solver
51 * first assigns every addresses the minimum amount of bandwidth
52 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
53 * remaining bandwidth available according to the preference
54 * values. For each peer only a single address gets bandwidth
55 * assigned and only one address marked as active. The most
56 * important functionality for the solver is implemented in: *
57 * find_address_it is an hashmap iterator returning the prefered
58 * address for an peer * update_quota_per_network distributes
59 * available bandwidth for a network over active addresses
61 * Changes to addresses automatically have an impact on the the
62 * bandwidth assigned to other addresses in the same network since
63 * the solver distributes the remaining bandwidth over the
64 * addresses in the network. When changes to the addresses occur,
65 * the solver first performs the changes, like adding or deleting
66 * addresses, and then updates bandwidth assignment for the
67 * affected network. Bandwidth assignment is only recalculated on
68 * demand when an address is requested by a client for a peer or
69 * when the addresses available have changed or an address changed
70 * the network it is located in. When the bandwidth assignment has
71 * changed the callback is called with the new bandwidth
72 * assignments. The bandwidth distribution for a network is
73 * recalculated due to: * address suggestion requests * address
74 * deletions * address switching networks during address update *
77 * 3.1 Data structures used
79 * For each ATS network (e.g. WAN, LAN, loopback) a struct Network
80 * is used to specify network related information as total adresses
81 * and active addresses in this network and the configured in- and
82 * outbound quota. Each network also contains a list of addresses
83 * added to the solver located in this network. The proportional
84 * solver uses the addresses' solver_information field to store the
85 * proportional network it belongs to for each address.
89 * When the proportional solver is initialized the solver creates a
90 * new solver handle and initializes the network structures with
91 * the quotas passed from addresses and returns the handle solver.
93 * 3.3 Adding an address
95 * When a new address is added to the solver using s_add, a lookup
96 * for the network for this address is done and the address is
97 * enqueued in in the linked list of the network.
99 * 3.4 Updating an address
101 * The main purpose of address updates is to update the ATS
102 * information for addresse selection. Important for the proportional
103 * solver is when an address switches network it is located
104 * in. This is common because addresses added by transport's
105 * validation mechanism are commonly located in
106 * GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
107 * in this network type and only if a connection is successful on
108 * return of payload data transport switches to the real network
109 * the address is located in. When an address changes networks it
110 * is first of all removed from the old network using the solver
111 * API function #GAS_proportional_address_delete() and the network in
112 * the address struct is updated. A lookup for the respective new
113 * proportional network is done and stored in the addresse's
114 * solver_information field. Next the address is re-added to the
115 * solver using the solver API function
116 * #GAS_proportional_address_add(). If the address was marked as in
117 * active, the solver checks if bandwidth is available in the
118 * network and if yes sets the address to active and updates the
119 * bandwidth distribution in this network. If no bandwidth is
120 * available it sets the bandwidth for this address to 0 and tries
121 * to suggest an alternative address. If an alternative address was
122 * found, addresses' callback is called for this address.
124 * 3.5 Deleting an address
126 * When an address is removed from the solver, it removes the
127 * respective address from the network and if the address was
128 * marked as active, it updates the bandwidth distribution for this
131 * 3.6 Requesting addresses
133 * When an address is requested for a peer the solver performs a
134 * lookup for the peer entry in addresses address hashmap and
135 * selects the best address. The selection of the most suitable
136 * address is done in the find_address_it hashmap iterator
137 * described in detail in section 3.7. If no address is returned,
138 * no address can be suggested at the moment. If the address
139 * returned is marked as active, the solver can return this
140 * address. If the address is not marked as active, the solver
141 * checks if another address belongign to this peer is marked as
142 * active and marks the address as inactive, updates the bandwidth
143 * for this address to 0, call the bandwidth changed callback for
144 * this address due to the change and updates quota assignment for
145 * the addresse's network. the now in-active address is belonging
146 * to. The solver marks the new address as active and updates the
147 * bandwidth assignment for this network.
149 * 3.7 Choosing addresses
151 * Choosing the best possible address for suggestion is done by
152 * iterating over all addresses of a peer stored in addresses'
153 * hashmap and using the hashmap iterator find_address_it to select
154 * the best available address. Several checks are done when an
155 * address is selected. First if this address is currently blocked
156 * by addresses from being suggested. An address is blocked for the
157 * duration of ATS_BLOCKING_DELTA when it is suggested to
158 * transport. Next it is checked if at least
159 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
160 * in the addresse's network, because suggesting an address without
161 * bandwidth does not make sense. This also ensures that all active
162 * addresses in this network get at least the minimum amount of
163 * bandwidth assigned. In the next step the solver ensures that for
164 * tcp connections inbound connections are prefered over outbound
165 * connections. In the next stet the solver ensures that
166 * connections are prefered in the following order: * connections
167 * are already established and have bandwidth assigned *
168 * connections with a shorter distance * connectes have a shorter
171 * 3.8 Changing preferences
175 * During shutdown all network entries and aging processes are
176 * destroyed and freed.
181 * This solver assigns in and outbound bandwidth equally for all
182 * addresses in specific network type (WAN, LAN) based on configured
183 * in and outbound quota for this network.
185 * The solver is notified by addresses about changes to the addresses
186 * and recalculates the bandwith assigned if required. The solver
187 * notifies addresses by calling the GAS_bandwidth_changed_cb
195 * For each peer only a single is selected and marked as "active" in the address
200 * You have the networks WAN and LAN and quotas
201 * WAN_TOTAL_IN, WAN_TOTAL_OUT
202 * LAN_TOTAL_IN, LAN_TOTAL_OUT
204 * If you have x addresses in the network segment LAN, the quotas are
205 * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
207 * Quotas are automatically recalculated and reported back when addresses are
212 #define PROPORTIONALITY_FACTOR 2.0
215 * A handle for the proportional solver
217 struct GAS_PROPORTIONAL_Handle
219 struct GNUNET_ATS_PluginEnvironment *env;
224 struct GNUNET_STATISTICS_Handle *stats;
227 * Hashmap containing all valid addresses
229 struct GNUNET_CONTAINER_MultiPeerMap *addresses;
232 * Pending address requests
234 struct GNUNET_CONTAINER_MultiPeerMap *requests;
237 * Bandwidth changed callback
239 GAS_bandwidth_changed_cb bw_changed;
242 * Bandwidth changed callback cls
244 void *bw_changed_cls;
247 * ATS function to get preferences
249 GAS_get_preferences get_preferences;
252 * Closure for ATS function to get preferences
254 void *get_preferences_cls;
257 * ATS function to get properties
259 GAS_get_properties get_properties;
262 * Closure for ATS function to get properties
264 void *get_properties_cls;
272 * Number of changes while solver was locked
277 * Total number of addresses for solver
279 unsigned int total_addresses;
282 * Number of active addresses for solver
284 unsigned int active_addresses;
289 struct Network *network_entries;
294 unsigned int network_count;
297 * Proportionality factor
304 double stability_factor;
308 * Representation of a network
318 * Network description
323 * Total inbound quota
326 unsigned long long total_quota_in;
329 * Total outbound quota
332 unsigned long long total_quota_out;
335 * Number of active addresses for this network
337 unsigned int active_addresses;
340 * Number of total addresses for this network
342 unsigned int total_addresses;
345 * String for statistics total addresses
350 * String for statistics active addresses
355 * Linked list of addresses in this network: head
357 struct AddressWrapper *head;
360 * Linked list of addresses in this network: tail
362 struct AddressWrapper *tail;
366 * Address information stored in the solver
368 struct AddressSolverInformation
371 * Network scope this address is in
373 struct Network *network;
379 uint32_t calculated_quota_in;
385 uint32_t calculated_quota_out;
388 * When was this address activated
390 struct GNUNET_TIME_Absolute activated;
395 * Wrapper for addresses to store them in network's linked list
397 struct AddressWrapper
402 struct AddressWrapper *next;
407 struct AddressWrapper *prev;
412 struct ATS_Address *addr;
417 * Function used to unload the plugin.
419 * @param cls return value from #libgnunet_plugin_ats_proportional_init()
422 libgnunet_plugin_ats_proportional_done (void *cls)
424 struct GAS_PROPORTIONAL_Handle *s = cls;
425 struct AddressWrapper *cur;
426 struct AddressWrapper *next;
429 GNUNET_assert(s != NULL);
430 for (c = 0; c < s->network_count; c++)
432 if (s->network_entries[c].total_addresses > 0)
434 LOG(GNUNET_ERROR_TYPE_DEBUG,
435 "Had %u addresses for network `%s' not deleted during shutdown\n",
436 s->network_entries[c].total_addresses, s->network_entries[c].desc);
440 if (s->network_entries[c].active_addresses > 0)
442 LOG(GNUNET_ERROR_TYPE_DEBUG,
443 "Had %u active addresses for network `%s' not deleted during shutdown\n",
444 s->network_entries[c].active_addresses, s->network_entries[c].desc);
448 next = s->network_entries[c].head;
449 while (NULL != (cur = next))
452 GNUNET_CONTAINER_DLL_remove(s->network_entries[c].head,
453 s->network_entries[c].tail, cur);
454 GNUNET_free_non_null (cur->addr->solver_information);
457 GNUNET_free(s->network_entries[c].stat_total);
458 GNUNET_free(s->network_entries[c].stat_active);
460 if (s->total_addresses > 0)
462 LOG(GNUNET_ERROR_TYPE_DEBUG,
463 "Had %u addresses not deleted during shutdown\n", s->total_addresses);
466 if (s->active_addresses > 0)
468 LOG(GNUNET_ERROR_TYPE_DEBUG,
469 "Had %u active addresses not deleted during shutdown\n",
470 s->active_addresses);
473 GNUNET_free (s->network_entries);
474 GNUNET_CONTAINER_multipeermap_destroy (s->requests);
481 * Test if bandwidth is available in this network to add an additional address
483 * @param net the network type to update
484 * @return #GNUNET_YES or #GNUNET_NO
487 is_bandwidth_available_in_network (struct Network *net)
489 GNUNET_assert(NULL != net);
490 unsigned int na = net->active_addresses + 1;
491 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
492 if (((net->total_quota_in / na) > min_bw)
493 && ((net->total_quota_out / na) > min_bw))
495 LOG(GNUNET_ERROR_TYPE_DEBUG,
496 "Enough bandwidth available for %u active addresses in network `%s'\n",
501 LOG(GNUNET_ERROR_TYPE_DEBUG,
502 "Not enough bandwidth available for %u active addresses in network `%s'\n",
509 * Update bandwidth assigned to peers in this network
511 * @param s the solver handle
512 * @param net the network type to update
516 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
519 struct AddressSolverInformation *asi;
520 struct AddressWrapper *cur_address;
522 unsigned long long remaining_quota_in = 0;
523 unsigned long long quota_out_used = 0;
524 unsigned long long remaining_quota_out = 0;
525 unsigned long long quota_in_used = 0;
527 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
528 double relative_peer_prefence;
529 double sum_relative_peer_prefences; /* Important: has to be double not float due to precision */
530 double cur_pref; /* Important: has to be double not float due to precision */
533 const double *peer_relative_prefs = NULL; /* Important: has to be double not float due to precision */
535 uint32_t assigned_quota_in = 0;
536 uint32_t assigned_quota_out = 0;
539 LOG(GNUNET_ERROR_TYPE_INFO,
540 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
541 net->desc, net->active_addresses, net->total_quota_in,
542 net->total_quota_in);
544 if (net->active_addresses == 0)
546 return; /* no addresses to update */
550 * Assign every peer in network minimum Bandwidth
551 * Distribute bandwidth left according to preference
554 if ((net->active_addresses * min_bw) > net->total_quota_in)
559 if ((net->active_addresses * min_bw) > net->total_quota_out)
565 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
566 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
567 LOG(GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
568 remaining_quota_in, remaining_quota_out);
569 sum_relative_peer_prefences = 0.0;
571 /* Calculate sum of relative preference for active addresses in this network */
573 for (cur_address = net->head; NULL != cur_address; cur_address = cur_address->next)
575 if (GNUNET_YES != cur_address->addr->active)
578 GNUNET_assert( NULL != (peer_relative_prefs = s->get_preferences (s->get_preferences_cls,
579 &cur_address->addr->peer)));
580 relative_peer_prefence = 0.0;
581 relative_peer_prefence += peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
582 sum_relative_peer_prefences += relative_peer_prefence;
586 if (count_addresses != net->active_addresses)
589 LOG(GNUNET_ERROR_TYPE_WARNING,
590 "%s: Counted %u active addresses, but network says to have %u active addresses \n",
591 net->desc, count_addresses, net->active_addresses);
592 for (cur_address = net->head; NULL != cur_address; cur_address = cur_address->next)
594 if (GNUNET_YES != cur_address->addr->active)
597 LOG (GNUNET_ERROR_TYPE_WARNING, "Active: `%s' `%s' length %u\n",
598 GNUNET_i2s (&cur_address->addr->peer), cur_address->addr->plugin,
599 cur_address->addr->addr_len);
603 LOG (GNUNET_ERROR_TYPE_INFO,
604 "Total relative preference %.3f for %u addresses in network %s\n",
605 sum_relative_peer_prefences, net->active_addresses, net->desc);
607 for (cur_address = net->head; NULL != cur_address; cur_address = cur_address->next)
609 if (GNUNET_YES == cur_address->addr->active)
611 GNUNET_assert( NULL != (peer_relative_prefs =
612 s->get_preferences (s->get_preferences_cls, &cur_address->addr->peer)));
614 cur_pref = peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
615 total_weight = net->active_addresses +
616 s->prop_factor * sum_relative_peer_prefences;
617 peer_weight = (1.0 + (s->prop_factor * cur_pref));
619 assigned_quota_in = min_bw
620 + ((peer_weight / total_weight) * remaining_quota_in);
621 assigned_quota_out = min_bw
622 + ((peer_weight / total_weight) * remaining_quota_out);
624 LOG (GNUNET_ERROR_TYPE_INFO,
625 "New quota for peer `%s' with weight (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
626 GNUNET_i2s (&cur_address->addr->peer), peer_weight, total_weight,
627 assigned_quota_in, assigned_quota_out);
631 assigned_quota_in = 0;
632 assigned_quota_out = 0;
635 quota_in_used += assigned_quota_in;
636 quota_out_used += assigned_quota_out;
637 /* Prevent overflow due to rounding errors */
638 if (assigned_quota_in > UINT32_MAX)
639 assigned_quota_in = UINT32_MAX;
640 if (assigned_quota_out > UINT32_MAX)
641 assigned_quota_out = UINT32_MAX;
643 /* Compare to current bandwidth assigned */
644 asi = cur_address->addr->solver_information;
645 asi->calculated_quota_in = assigned_quota_in;
646 asi->calculated_quota_out = assigned_quota_out;
648 LOG(GNUNET_ERROR_TYPE_DEBUG,
649 "Total bandwidth assigned is (in/out): %llu /%llu\n", quota_in_used,
651 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
653 LOG(GNUNET_ERROR_TYPE_ERROR,
654 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
655 net->active_addresses, quota_out_used, net->total_quota_out);
657 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
659 LOG(GNUNET_ERROR_TYPE_ERROR,
660 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
661 net->active_addresses, quota_in_used, net->total_quota_in);
667 * Context for finding the best address* Linked list of addresses in this network: head
669 struct FindBestAddressCtx
674 struct GAS_PROPORTIONAL_Handle *s;
677 * The currently best address
679 struct ATS_Address *best;
684 * Find index of a ATS property type in the array.
687 find_property_index (uint32_t type)
689 int existing_types[] = GNUNET_ATS_QualityProperties;
692 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
693 if (existing_types[c] == type)
695 return GNUNET_SYSERR;
700 * Find a "good" address to use for a peer by iterating over the addresses for this peer.
701 * If we already have an existing address, we stick to it.
702 * Otherwise, we pick by lowest distance and then by lowest latency.
704 * @param cls the `struct FindBestAddressCtx *' where we store the result
706 * @param value another `struct ATS_Address*` to consider using
707 * @return #GNUNET_OK (continue to iterate)
710 find_best_address_it (void *cls,
711 const struct GNUNET_PeerIdentity *key,
714 struct FindBestAddressCtx *ctx = cls;
715 struct ATS_Address *current = value;
716 struct ATS_Address *current_best = current;
717 struct GNUNET_TIME_Absolute now;
718 struct AddressSolverInformation *asi;
719 struct GNUNET_TIME_Relative active_time;
720 struct GNUNET_TIME_Relative min_active_time;
721 const double *norm_prop_cur;
722 const double *norm_prop_best;
724 double best_distance;
730 asi = current->solver_information;
731 now = GNUNET_TIME_absolute_get ();
733 if ((current->active == GNUNET_NO)
734 && (current->blocked_until.abs_value_us
735 == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value_us))
737 /* This address is blocked for suggestion */
738 LOG (GNUNET_ERROR_TYPE_DEBUG,
739 "Address %p blocked for suggestion for %s \n",
741 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (now, current->blocked_until),
751 if (GNUNET_NO == is_bandwidth_available_in_network (asi->network))
753 return GNUNET_OK; /* There's no bandwidth available in this network */
756 if (NULL != ctx->best)
758 /* Compare current addresses with denominated 'best' address */
759 current_best = ctx->best;
763 /* We do not have a 'best' address so take this address */
764 LOG (GNUNET_ERROR_TYPE_DEBUG,
765 "Setting initial address %p\n",
767 current_best = current;
771 if (GNUNET_YES == current->active)
773 GNUNET_assert (asi->activated.abs_value_us != GNUNET_TIME_UNIT_ZERO_ABS.abs_value_us);
774 active_time = GNUNET_TIME_absolute_get_duration (asi->activated);
775 min_active_time.rel_value_us = ((double) GNUNET_TIME_UNIT_SECONDS.rel_value_us) *
776 PROP_STABILITY_FACTOR;
777 if (active_time.rel_value_us <= min_active_time.rel_value_us)
779 /* Keep active address for stability reasons */
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 index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
789 cur_distance = norm_prop_cur[index];
790 index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
791 cur_delay = norm_prop_cur[index];
793 norm_prop_best = ctx->s->get_properties (ctx->s->get_properties_cls,
794 (const struct ATS_Address *) ctx->best);
795 index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
796 best_distance = norm_prop_best[index];
797 index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
798 best_delay = norm_prop_best[index];
800 /* user shorter distance */
801 if (cur_distance < best_distance)
804 if (GNUNET_NO == ctx->best->active)
806 current_best = current; /* Use current */
808 else if ((best_distance / cur_distance) > ctx->s->stability_factor)
810 /* Best and active address performs worse */
811 current_best = current;
816 /* Use current best */
817 current_best = ctx->best;
820 /* User connection with less delay */
821 if (cur_delay < best_delay)
824 if (GNUNET_NO == ctx->best->active)
826 current_best = current; /* Use current */
828 else if ((best_delay / cur_delay) > ctx->s->stability_factor)
830 /* Best and active address performs worse */
831 current_best = current;
836 /* Use current best */
837 current_best = ctx->best;
841 ctx->best = current_best;
847 * Find the currently best address for a peer from the set of addresses available
848 * or return NULL of no address is available
850 * @param s the proportional handle
851 * @param addresses the address hashmap
852 * @param id the peer id
853 * @return the address or NULL
856 get_best_address (struct GAS_PROPORTIONAL_Handle *s,
857 struct GNUNET_CONTAINER_MultiPeerMap *addresses,
858 const struct GNUNET_PeerIdentity *id)
860 struct FindBestAddressCtx fba_ctx;
864 GNUNET_CONTAINER_multipeermap_get_multiple (addresses, id,
865 &find_best_address_it, &fba_ctx);
872 * Hashmap Iterator to find current active address for peer
874 * @param cls last active address
875 * @param key peer's key
876 * @param value address to check
877 * @return #GNUNET_NO on double active address else #GNUNET_YES;
880 get_active_address_it (void *cls,
881 const struct GNUNET_PeerIdentity *key,
884 struct ATS_Address **dest = cls;
885 struct ATS_Address *aa = (struct ATS_Address *) value;
887 LOG (GNUNET_ERROR_TYPE_INFO,
888 "Checking address %p\n", aa);
890 if (GNUNET_YES == aa->active)
892 LOG (GNUNET_ERROR_TYPE_INFO,
893 "Address %p is active\n", aa);
896 /* should never happen */
897 LOG (GNUNET_ERROR_TYPE_ERROR,
898 "Multiple active addresses for peer `%s'\n",
899 GNUNET_i2s (&aa->peer));
911 * Find current active address for peer
913 * @param solver the solver handle
914 * @param addresses the address set
915 * @param peer the peer
916 * @return active address or NULL
918 static struct ATS_Address *
919 get_active_address (void *solver,
920 const struct GNUNET_CONTAINER_MultiPeerMap * addresses,
921 const struct GNUNET_PeerIdentity *peer)
923 static struct ATS_Address * dest = NULL;
926 GNUNET_CONTAINER_multipeermap_get_multiple (addresses, peer,
927 &get_active_address_it, &dest);
933 * Lookup network struct by type
935 * @param s the solver handle
936 * @param type the network type
937 * @return the network struct
939 static struct Network *
940 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
943 for (c = 0; c < s->network_count; c++)
945 if (s->network_entries[c].type == type)
946 return &s->network_entries[c];
953 * Increase address count in network
955 * @param s the solver handle
956 * @param net the network type
957 * @param total increase total addresses
958 * @param active increase active addresses
961 address_increment (struct GAS_PROPORTIONAL_Handle *s,
966 if (GNUNET_YES == total)
968 s->total_addresses++;
969 net->total_addresses++;
970 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
971 GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
973 if (GNUNET_YES == active)
975 net->active_addresses++;
976 s->active_addresses++;
977 GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1,
979 GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
986 * Decrease address count in network
988 * @param s the solver handle
989 * @param net the network type
990 * @param total decrease total addresses
991 * @param active decrease active addresses
994 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
1001 if (GNUNET_YES == total)
1003 if (s->total_addresses < 1)
1006 res = GNUNET_SYSERR;
1010 s->total_addresses--;
1011 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1014 if (net->total_addresses < 1)
1017 res = GNUNET_SYSERR;
1021 net->total_addresses--;
1022 GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
1026 if (GNUNET_YES == active)
1028 if (net->active_addresses < 1)
1031 res = GNUNET_SYSERR;
1035 net->active_addresses--;
1036 GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
1038 if (s->active_addresses < 1)
1041 res = GNUNET_SYSERR;
1045 s->active_addresses--;
1046 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1055 * Compares addresses
1057 * @param a address a
1058 * @param b address b
1059 * @return GNUNET_YES if equal, GNUNET_NO else
1062 address_eq (struct ATS_Address *a, struct ATS_Address *b)
1064 GNUNET_assert (NULL != a);
1065 GNUNET_assert (NULL != b);
1066 if (0 != strcmp(a->plugin, b->plugin))
1068 if (a->addr_len != b->addr_len)
1070 if (0 != memcmp (a->addr, b->addr, b->addr_len))
1072 if (a->session_id != b->session_id)
1079 * Notify bandwidth changes to addresses
1081 * @param s solver handle
1082 * @param net the network to propagate changes in
1085 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
1086 struct Network *net)
1088 struct AddressWrapper *cur;
1089 struct AddressSolverInformation *asi;
1090 for (cur = net->head; NULL != cur; cur = cur->next)
1092 asi = cur->addr->solver_information;
1093 if ( (cur->addr->assigned_bw_in != asi->calculated_quota_in) ||
1094 (cur->addr->assigned_bw_out != asi->calculated_quota_out) )
1096 cur->addr->assigned_bw_in = asi->calculated_quota_in;
1097 cur->addr->assigned_bw_out = asi->calculated_quota_out;
1099 /* Reset for next iteration */
1100 asi->calculated_quota_in = 0;
1101 asi->calculated_quota_out = 0;
1102 LOG (GNUNET_ERROR_TYPE_DEBUG,
1103 "Bandwidth for %s address %p for peer `%s' changed to %u/%u\n",
1104 (GNUNET_NO == cur->addr->active) ? "inactive" : "active",
1106 GNUNET_i2s (&cur->addr->peer),
1107 cur->addr->assigned_bw_in,
1108 cur->addr->assigned_bw_out);
1110 /* Notify on change */
1111 if ((GNUNET_YES == cur->addr->active))
1113 s->bw_changed (s->bw_changed_cls, cur->addr);
1121 * Distribibute bandwidth
1123 * @param s the solver handle
1124 * @param n the network, can be NULL for all network
1127 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
1130 if (GNUNET_YES == s->bulk_lock)
1138 LOG (GNUNET_ERROR_TYPE_INFO,
1139 "Redistributing bandwidth in network %s with %u active and %u total addresses\n",
1140 GNUNET_ATS_print_network_type(n->type),
1141 n->active_addresses, n->total_addresses);
1143 if (NULL != s->env->info_cb)
1144 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
1145 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1148 distribute_bandwidth(s, n);
1150 if (NULL != s->env->info_cb)
1151 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
1152 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1153 if (NULL != s->env->info_cb)
1154 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
1155 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1157 /* Do propagation */
1158 propagate_bandwidth (s, n);
1160 if (NULL != s->env->info_cb)
1161 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
1162 GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
1167 if (NULL != s->env->info_cb)
1168 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
1169 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1170 for (i = 0; i < s->network_count; i++)
1173 distribute_bandwidth(s, &s->network_entries[i]);
1176 if (NULL != s->env->info_cb)
1177 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
1178 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1179 if (NULL != s->env->info_cb)
1180 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
1181 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1182 for (i = 0; i < s->network_count; i++)
1184 /* Do propagation */
1185 propagate_bandwidth(s, &s->network_entries[i]);
1187 if (NULL != s->env->info_cb)
1188 s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
1189 GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
1195 * Update active address for a peer:
1196 * Check if active address exists and what the best address is, if addresses
1197 * are different switch
1199 * @param s solver handle
1200 * @param peer the peer to check
1201 * return the new address or NULL if no update was performed
1203 static const struct ATS_Address *
1204 update_active_address (struct GAS_PROPORTIONAL_Handle *s,
1205 const struct GNUNET_PeerIdentity *peer)
1207 struct ATS_Address *best_address;
1208 struct ATS_Address *current_address;
1209 struct AddressSolverInformation *asi;
1210 struct Network *net;
1212 LOG (GNUNET_ERROR_TYPE_INFO,
1213 "Updating active address for peer `%s'\n",
1216 /* Find active address */
1217 current_address = get_active_address (s, s->addresses, peer);
1219 LOG (GNUNET_ERROR_TYPE_INFO, "Peer `%s' has active address %p\n",
1220 GNUNET_i2s (peer), current_address);
1222 /* Find best address */
1223 best_address = get_best_address (s,s->addresses, peer);
1224 LOG (GNUNET_ERROR_TYPE_INFO, "Peer `%s' has best address %p\n",
1225 GNUNET_i2s (peer), best_address);
1227 if (NULL != current_address)
1229 if ((NULL == best_address) || ((NULL != best_address) &&
1230 (GNUNET_NO == address_eq (current_address, best_address))))
1232 /* We switch to a new address, mark old address as inactive */
1233 LOG (GNUNET_ERROR_TYPE_INFO,
1234 "Disabling previous %s address %p for peer `%s'\n",
1235 (GNUNET_NO == current_address->active) ? "inactive" : "active",
1239 asi = current_address->solver_information;
1240 GNUNET_assert (NULL != asi);
1243 asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
1244 current_address->active = GNUNET_NO; /* No active any longer */
1245 current_address->assigned_bw_in = 0; /* no bandwidth assigned */
1246 current_address->assigned_bw_out = 0; /* no bandwidth assigned */
1248 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1251 /* Update network of previous address */
1252 distribute_bandwidth_in_network (s, net);
1254 if (NULL == best_address)
1256 /* We previously had an active address, but now we cannot suggest one
1257 * Therefore we have to disconnect the peer */
1259 LOG (GNUNET_ERROR_TYPE_INFO,
1260 "Disconnecting peer `%s' with previous %s address %p\n",
1262 (GNUNET_NO == current_address->active) ? "inactive" : "active",
1264 s->bw_changed (s->bw_changed_cls, current_address);
1268 if (NULL == best_address)
1270 LOG (GNUNET_ERROR_TYPE_INFO, "Cannot suggest address for peer `%s'\n",
1275 LOG (GNUNET_ERROR_TYPE_INFO, "Suggesting %s address %p for peer `%s'\n",
1276 (GNUNET_NO == best_address->active) ? "inactive" : "active", best_address,
1279 if ((NULL != current_address) &&
1280 (GNUNET_YES == address_eq (best_address, current_address)))
1282 if (current_address->active == GNUNET_NO)
1283 GNUNET_break (0); /* Should never happen */
1284 return best_address; /* Same same */
1287 asi = best_address->solver_information;
1288 GNUNET_assert (NULL != asi);
1291 /* Mark address as active */
1292 asi->activated = GNUNET_TIME_absolute_get();
1293 best_address->active = GNUNET_YES;
1294 address_increment (s, net, GNUNET_NO, GNUNET_YES);
1295 LOG (GNUNET_ERROR_TYPE_INFO, "Address %p for peer `%s' is now active\n",
1296 best_address, GNUNET_i2s (peer));
1297 /* Distribute bandwidth */
1298 distribute_bandwidth_in_network (s, net);
1299 return best_address;
1304 * Changes the preferences for a peer in the problem
1306 * @param solver the solver handle
1307 * @param peer the peer to change the preference for
1308 * @param kind the kind to change the preference
1309 * @param pref_rel the normalized preference value for this kind over all clients
1312 GAS_proportional_address_change_preference (void *solver,
1313 const struct GNUNET_PeerIdentity *peer,
1314 enum GNUNET_ATS_PreferenceKind kind,
1317 struct GAS_PROPORTIONAL_Handle *s = solver;
1318 struct ATS_Address *best_address;
1319 struct ATS_Address *active_address;
1320 struct AddressSolverInformation *asi;
1322 GNUNET_assert(NULL != s);
1323 GNUNET_assert(NULL != peer);
1325 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, peer))
1326 return; /* Peer is not requested */
1328 /* This peer is requested, find best address */
1329 active_address = get_active_address(s, s->addresses, peer);
1330 best_address = (struct ATS_Address *) update_active_address (s, peer);
1332 if ((NULL != best_address) && ((NULL != active_address) &&
1333 (GNUNET_YES == address_eq (active_address, best_address))))
1335 asi = best_address->solver_information;
1336 GNUNET_assert (NULL != asi);
1338 /* We sticked to the same address, therefore redistribute */
1339 distribute_bandwidth_in_network (s, asi->network);
1345 * Get application feedback for a peer
1347 * @param solver the solver handle
1348 * @param application the application
1349 * @param peer the peer to change the preference for
1350 * @param scope the time interval for this feedback: [now - scope .. now]
1351 * @param kind the kind to change the preference
1352 * @param score the score
1355 GAS_proportional_address_preference_feedback (void *solver,
1357 const struct GNUNET_PeerIdentity *peer,
1358 const struct GNUNET_TIME_Relative scope,
1359 enum GNUNET_ATS_PreferenceKind kind,
1362 struct GAS_PROPORTIONAL_Handle *s = solver;
1364 GNUNET_assert(NULL != peer);
1365 GNUNET_assert(NULL != s);
1370 * Get the preferred address for a specific peer
1372 * @param solver the solver handle
1373 * @param peer the identity of the peer
1374 * @return best address
1376 static const struct ATS_Address *
1377 GAS_proportional_get_preferred_address (void *solver,
1378 const struct GNUNET_PeerIdentity *peer)
1380 struct GAS_PROPORTIONAL_Handle *s = solver;
1381 const struct ATS_Address *best_address;
1384 GNUNET_assert(s != NULL);
1385 GNUNET_assert(peer != NULL);
1387 /* Add to list of pending requests */
1388 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, peer))
1391 GNUNET_OK == GNUNET_CONTAINER_multipeermap_put (s->requests, peer, NULL,
1392 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1393 LOG (GNUNET_ERROR_TYPE_INFO, "Start suggesting addresses for peer `%s'\n",
1397 best_address = update_active_address (s, peer);
1398 if (s->bulk_lock > 0)
1399 return NULL; /* Do not suggest since bulk lock is pending */
1401 return best_address;
1406 * Stop notifying about address and bandwidth changes for this peer
1408 * @param solver the solver handle
1409 * @param peer the peer
1412 GAS_proportional_stop_get_preferred_address (void *solver,
1413 const struct GNUNET_PeerIdentity *peer)
1415 struct GAS_PROPORTIONAL_Handle *s = solver;
1416 struct ATS_Address *cur;
1417 struct AddressSolverInformation *asi;
1418 struct Network *cur_net;
1420 if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (s->requests, peer))
1422 GNUNET_assert (GNUNET_OK == GNUNET_CONTAINER_multipeermap_remove (s->requests,
1424 LOG (GNUNET_ERROR_TYPE_INFO, "Stop suggesting addresses for peer `%s'\n",
1428 cur = get_active_address (s, s->addresses, peer);
1431 LOG(GNUNET_ERROR_TYPE_INFO,
1432 "Disabling %s address %p for peer `%s'\n",
1433 (GNUNET_NO == cur->active) ? "inactive" : "active", cur,
1434 GNUNET_i2s (&cur->peer));
1436 /* Disabling current address */
1437 asi = cur->solver_information;
1438 cur_net = asi->network ;
1439 asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
1440 cur->active = GNUNET_NO; /* No active any longer */
1441 cur->assigned_bw_in = 0; /* no bandwidth assigned */
1442 cur->assigned_bw_out = 0; /* no bandwidth assigned */
1444 if (GNUNET_SYSERR == addresse_decrement (s, cur_net, GNUNET_NO, GNUNET_YES))
1447 distribute_bandwidth_in_network (s, cur_net );
1454 * Remove an address from the solver
1456 * @param solver the solver handle
1457 * @param address the address to remove
1458 * @param session_only delete only session not whole address
1461 GAS_proportional_address_delete (void *solver,
1462 struct ATS_Address *address,
1465 struct GAS_PROPORTIONAL_Handle *s = solver;
1466 struct Network *net;
1467 struct AddressWrapper *aw;
1468 struct AddressSolverInformation *asi;
1470 /* Remove an adress completely, we have to:
1471 * - Remove from specific network
1472 * - Decrease number of total addresses
1474 * - decrease number of active addreses
1477 asi = address->solver_information;
1486 if (GNUNET_NO == session_only)
1488 LOG(GNUNET_ERROR_TYPE_INFO,
1489 "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1490 (GNUNET_NO == address->active) ? "inactive" : "active", address,
1491 GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1492 net->active_addresses);
1494 /* Remove address */
1495 addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
1496 for (aw = net->head; NULL != aw; aw = aw->next)
1498 if (aw->addr == address)
1506 GNUNET_CONTAINER_DLL_remove(net->head, net->tail, aw);
1511 /* Remove session only: remove if active and update */
1512 LOG(GNUNET_ERROR_TYPE_INFO,
1513 "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1514 (GNUNET_NO == address->active) ? "inactive" : "active", address,
1515 GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1516 net->active_addresses);
1519 if (GNUNET_YES == address->active)
1521 /* Address was active, remove from network and update quotas*/
1522 address->active = GNUNET_NO;
1524 address->assigned_bw_in = 0;
1525 address->assigned_bw_out = 0;
1526 asi->calculated_quota_in = 0;
1527 asi->calculated_quota_out = 0;
1529 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1531 distribute_bandwidth_in_network (s, net);
1533 if (NULL == update_active_address (s, &address->peer))
1535 /* No alternative address found, disconnect peer */
1536 LOG (GNUNET_ERROR_TYPE_INFO,
1537 "Disconnecting peer `%s' after deleting previous %s address %p\n",
1538 GNUNET_i2s (&address->peer),
1539 (GNUNET_NO == address->active) ? "inactive" : "active",
1541 s->bw_changed (s->bw_changed_cls, address);
1544 if (GNUNET_NO == session_only)
1546 GNUNET_free_non_null (address->solver_information);
1547 address->solver_information = NULL;
1550 LOG(GNUNET_ERROR_TYPE_INFO,
1551 "After deleting address now total %u and active %u addresses in network `%s'\n",
1552 net->total_addresses, net->active_addresses, net->desc);
1558 * Start a bulk operation
1560 * @param solver the solver
1563 GAS_proportional_bulk_start (void *solver)
1565 struct GAS_PROPORTIONAL_Handle *s = solver;
1567 LOG (GNUNET_ERROR_TYPE_DEBUG,
1568 "Locking solver for bulk operation ...\n");
1569 GNUNET_assert(NULL != solver);
1575 * Bulk operation done
1578 GAS_proportional_bulk_stop (void *solver)
1580 struct GAS_PROPORTIONAL_Handle *s = solver;
1582 LOG (GNUNET_ERROR_TYPE_DEBUG,
1583 "Unlocking solver from bulk operation ...\n");
1584 GNUNET_assert(NULL != solver);
1586 if (s->bulk_lock < 1)
1592 if ((0 == s->bulk_lock) && (0 < s->bulk_requests))
1594 LOG(GNUNET_ERROR_TYPE_INFO, "No lock pending, recalculating\n");
1595 distribute_bandwidth_in_network (s, NULL);
1596 s->bulk_requests = 0;
1602 * Add a new single address to a network
1604 * @param solver the solver Handle
1605 * @param address the address to add
1606 * @param network network type of this address
1609 GAS_proportional_address_add (void *solver,
1610 struct ATS_Address *address,
1615 * Transport properties for this address have changed
1617 * @param solver solver handle
1618 * @param address the address
1619 * @param type the ATSI type in HBO
1620 * @param abs_value the absolute value of the property
1621 * @param rel_value the normalized value
1624 GAS_proportional_address_property_changed (void *solver,
1625 struct ATS_Address *address,
1630 struct GAS_PROPORTIONAL_Handle *s = solver;
1632 struct AddressSolverInformation *asi;
1633 struct ATS_Address *best_address;
1634 struct ATS_Address *active_address;
1636 GNUNET_assert(NULL != s);
1637 GNUNET_assert(NULL != address);
1638 asi = address->solver_information;
1652 LOG(GNUNET_ERROR_TYPE_INFO,
1653 "Property `%s' for peer `%s' address %p changed to %.2f \n",
1654 GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1655 address, rel_value);
1657 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1658 return; /* Peer is not requested */
1660 /* This peer is requested, find active and best address */
1661 active_address = get_active_address(s, s->addresses, &address->peer);
1662 best_address = (struct ATS_Address *) update_active_address (s, &address->peer);
1664 if ((NULL != best_address) && ((NULL != active_address) &&
1665 (GNUNET_YES == address_eq (active_address, best_address))))
1667 asi = best_address->solver_information;
1668 GNUNET_assert (NULL != asi);
1670 /* We sticked to the same address, therefore redistribute */
1671 distribute_bandwidth_in_network (s, asi->network);
1676 * Transport session for this address has changed
1678 * NOTE: values in addresses are already updated
1680 * @param solver solver handle
1681 * @param address the address
1682 * @param cur_session the current session
1683 * @param new_session the new session
1686 GAS_proportional_address_session_changed (void *solver,
1687 struct ATS_Address *address,
1688 uint32_t cur_session,
1689 uint32_t new_session)
1691 struct GAS_PROPORTIONAL_Handle *s = solver;
1692 struct ATS_Address *best_address;
1693 struct ATS_Address *active_address;
1694 struct AddressSolverInformation *asi;
1696 if (cur_session != new_session)
1698 LOG (GNUNET_ERROR_TYPE_DEBUG,
1699 "Session changed from %u to %u\n",
1704 if (NULL == address->solver_information)
1710 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1711 return; /* Peer is not requested */
1713 /* This peer is requested, find active and best address */
1714 active_address = get_active_address(s, s->addresses, &address->peer);
1715 best_address = (struct ATS_Address *) update_active_address (s, &address->peer);
1717 if ((NULL != best_address) && ((NULL != active_address) &&
1718 (GNUNET_YES == address_eq (active_address, best_address))))
1720 asi = best_address->solver_information;
1721 GNUNET_assert (NULL != asi);
1723 /* We sticked to the same address, therefore redistribute */
1724 distribute_bandwidth_in_network (s, asi->network);
1730 * Usage for this address has changed
1732 * NOTE: values in addresses are already updated
1734 * @param solver solver handle
1735 * @param address the address
1736 * @param in_use usage state
1739 GAS_proportional_address_inuse_changed (void *solver,
1740 struct ATS_Address *address,
1743 struct GAS_PROPORTIONAL_Handle *s = solver;
1745 struct AddressSolverInformation *asi;
1746 struct ATS_Address *best_address;
1747 struct ATS_Address *active_address;
1749 GNUNET_assert(NULL != s);
1750 GNUNET_assert(NULL != address);
1751 asi = address->solver_information;
1765 LOG(GNUNET_ERROR_TYPE_INFO,
1766 "Usage of peer `%s' address %p changed to %s \n",
1767 GNUNET_i2s (&address->peer), address,
1768 (GNUNET_YES == in_use) ? "YES" : "NO");
1770 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1771 return; /* Peer is not requested */
1773 /* This peer is requested, find active and best address */
1774 active_address = get_active_address(s, s->addresses, &address->peer);
1775 best_address = (struct ATS_Address *) update_active_address (s, &address->peer);
1777 if ((NULL != best_address) && ((NULL != active_address) &&
1778 (GNUNET_YES == address_eq (active_address, best_address))))
1780 asi = best_address->solver_information;
1781 GNUNET_assert (NULL != asi);
1783 /* We sticked to the same address, therefore redistribute */
1784 distribute_bandwidth_in_network (s, asi->network);
1789 * Network scope for this address has changed
1791 * NOTE: values in addresses are already updated
1793 * @param solver solver handle
1794 * @param address the address
1795 * @param current_network the current network
1796 * @param new_network the new network
1799 GAS_proportional_address_change_network (void *solver,
1800 struct ATS_Address *address,
1801 uint32_t current_network,
1802 uint32_t new_network)
1804 struct GAS_PROPORTIONAL_Handle *s = solver;
1805 struct AddressSolverInformation *asi;
1806 int save_active = GNUNET_NO;
1808 if (current_network == new_network)
1814 asi = address->solver_information;
1821 /* Network changed */
1822 LOG(GNUNET_ERROR_TYPE_DEBUG,
1823 "Network type changed, moving %s address from `%s' to `%s'\n",
1824 (GNUNET_YES == address->active) ? "active" : "inactive",
1825 GNUNET_ATS_print_network_type (current_network),
1826 GNUNET_ATS_print_network_type (new_network));
1829 /* Start bulk to prevent disconnect */
1830 GAS_proportional_bulk_start(s);
1832 save_active = address->active;
1834 /* Disable and assign no bandwidth */
1835 address->active = GNUNET_NO;
1836 address->assigned_bw_in = 0; /* no bandwidth assigned */
1837 address->assigned_bw_out = 0; /* no bandwidth assigned */
1839 /* Remove from old network */
1840 GAS_proportional_address_delete (solver, address, GNUNET_NO);
1842 /* Set new network type */
1843 if (NULL == get_network (solver, new_network))
1845 /* Address changed to invalid network... */
1846 LOG(GNUNET_ERROR_TYPE_ERROR,
1847 _("Invalid network type `%u' `%s': Disconnect!\n"), new_network,
1848 GNUNET_ATS_print_network_type (new_network));
1849 s->bw_changed (s->bw_changed_cls, address);
1853 /* Add to new network and update*/
1854 GAS_proportional_address_add (solver, address, new_network);
1856 GAS_proportional_bulk_stop (s);
1858 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1859 return; /* Peer is not requested */
1861 /* Find new address to suggest */
1862 if (GNUNET_YES == save_active)
1864 /* No address available, therefore disconnect */
1865 if (NULL == update_active_address (s, &address->peer))
1866 s->bw_changed (s->bw_changed_cls, address);
1872 * Add a new single address to a network
1874 * @param solver the solver Handle
1875 * @param address the address to add
1876 * @param network network type of this address
1879 GAS_proportional_address_add (void *solver,
1880 struct ATS_Address *address,
1883 struct GAS_PROPORTIONAL_Handle *s = solver;
1884 struct Network *net = NULL;
1885 struct AddressWrapper *aw = NULL;
1886 struct AddressSolverInformation *asi;
1888 GNUNET_assert(NULL != s);
1889 net = get_network (s, network);
1894 LOG(GNUNET_ERROR_TYPE_ERROR,
1895 "Unknown network %u `%s' for new address %p for peer `%s'\n",
1896 network, GNUNET_ATS_print_network_type(network),
1897 address, GNUNET_i2s(&address->peer));
1902 aw = GNUNET_new (struct AddressWrapper);
1904 GNUNET_CONTAINER_DLL_insert(net->head, net->tail, aw);
1905 address_increment (s, net, GNUNET_YES, GNUNET_NO);
1907 asi = GNUNET_new (struct AddressSolverInformation);
1909 asi->calculated_quota_in = 0;
1910 asi->calculated_quota_out = 0;
1911 aw->addr->solver_information = asi;
1913 LOG(GNUNET_ERROR_TYPE_INFO,
1914 "Adding new address %p for peer `%s', now total %u and active %u addresses in network `%s'\n",
1915 address, GNUNET_i2s(&address->peer), net->total_addresses, net->active_addresses, net->desc);
1917 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1918 return; /* Peer is not requested */
1920 /* This peer is requested, find best address */
1921 update_active_address (s, &address->peer);
1927 * Function invoked when the plugin is loaded.
1929 * @param[in,out] cls the `struct GNUNET_ATS_PluginEnvironment *` to use;
1930 * modified to return the API functions (ugh).
1931 * @return the `struct GAS_PROPORTIONAL_Handle` to pass as a closure
1934 libgnunet_plugin_ats_proportional_init (void *cls)
1936 struct GNUNET_ATS_PluginEnvironment *env = cls;
1937 struct GAS_PROPORTIONAL_Handle *s;
1938 struct Network * cur;
1939 char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1943 GNUNET_assert (NULL != env);
1944 GNUNET_assert (NULL != env->cfg);
1945 GNUNET_assert (NULL != env->bandwidth_changed_cb);
1946 GNUNET_assert (NULL != env->get_preferences);
1947 GNUNET_assert (NULL != env->get_property);
1949 s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
1951 env->sf.s_add = &GAS_proportional_address_add;
1952 env->sf.s_address_update_property = &GAS_proportional_address_property_changed;
1953 env->sf.s_address_update_session = &GAS_proportional_address_session_changed;
1954 env->sf.s_address_update_inuse = &GAS_proportional_address_inuse_changed;
1955 env->sf.s_address_update_network = &GAS_proportional_address_change_network;
1956 env->sf.s_get = &GAS_proportional_get_preferred_address;
1957 env->sf.s_get_stop = &GAS_proportional_stop_get_preferred_address;
1958 env->sf.s_pref = &GAS_proportional_address_change_preference;
1959 env->sf.s_feedback = &GAS_proportional_address_preference_feedback;
1960 env->sf.s_del = &GAS_proportional_address_delete;
1961 env->sf.s_bulk_start = &GAS_proportional_bulk_start;
1962 env->sf.s_bulk_stop = &GAS_proportional_bulk_stop;
1964 s->stats = (struct GNUNET_STATISTICS_Handle *) env->stats;
1965 s->bw_changed = env->bandwidth_changed_cb;
1966 s->bw_changed_cls = env->bw_changed_cb_cls;
1967 s->get_preferences = env->get_preferences;
1968 s->get_preferences_cls = env->get_preference_cls;
1969 s->get_properties = env->get_property;
1970 s->get_properties_cls = env->get_property_cls;
1971 s->network_count = env->network_count;
1972 s->network_entries = GNUNET_malloc (env->network_count * sizeof (struct Network));
1975 s->active_addresses = 0;
1976 s->total_addresses = 0;
1977 s->bulk_lock = GNUNET_NO;
1978 s->addresses = env->addresses;
1979 s->requests = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1981 s->stability_factor = PROP_STABILITY_FACTOR;
1982 if (GNUNET_SYSERR !=
1983 GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
1984 "PROP_STABILITY_FACTOR", &f_tmp))
1986 if ((f_tmp < 1.0) || (f_tmp > 2.0))
1988 LOG (GNUNET_ERROR_TYPE_ERROR,
1989 _("Invalid %s configuration %f \n"),
1990 "PROP_STABILITY_FACTOR",
1995 s->stability_factor = f_tmp;
1996 LOG (GNUNET_ERROR_TYPE_INFO,
1997 "Using %s of %.3f\n",
1998 "PROP_STABILITY_FACTOR", f_tmp);
2002 s->prop_factor = PROPORTIONALITY_FACTOR;
2003 if (GNUNET_SYSERR !=
2004 GNUNET_CONFIGURATION_get_value_float (env->cfg, "ats",
2005 "PROP_STABILITY_FACTOR", &f_tmp))
2009 LOG (GNUNET_ERROR_TYPE_ERROR,
2010 _("Invalid %s configuration %f \n"),
2011 "PROP_PROPORTIONALITY_FACTOR", f_tmp);
2015 s->prop_factor = f_tmp;
2016 LOG (GNUNET_ERROR_TYPE_INFO,
2017 "Using %s of %.3f\n",
2018 "PROP_PROPORTIONALITY_FACTOR", f_tmp);
2022 for (c = 0; c < env->network_count; c++)
2024 cur = &s->network_entries[c];
2025 cur->total_addresses = 0;
2026 cur->active_addresses = 0;
2027 cur->type = env->networks[c];
2028 cur->total_quota_in = env->in_quota[c];
2029 cur->total_quota_out = env->out_quota[c];
2030 cur->desc = net_str[c];
2031 GNUNET_asprintf (&cur->stat_total,
2032 "# ATS addresses %s total", cur->desc);
2033 GNUNET_asprintf (&cur->stat_active,
2034 "# ATS active addresses %s total", cur->desc);
2035 LOG (GNUNET_ERROR_TYPE_INFO,
2036 "Added network %u `%s' (%llu/%llu)\n",
2037 c, cur->desc, cur->total_quota_in, cur->total_quota_out);
2043 /* end of plugin_ats_proportional.c */