2 This file is part of GNUnet.
3 Copyright (C) 2011-2015 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
21 * @file ats/plugin_ats_proportional.c
22 * @brief ATS proportional solver
23 * @author Matthias Wachs
24 * @author Christian Grothoff
27 #include "gnunet_statistics_service.h"
28 #include "gnunet_ats_plugin.h"
29 #include "gnunet_ats_service.h"
30 #include "gnunet-service-ats_addresses.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
35 * How much do we value stability over adaptation by default. A low
36 * value (close to 1.0) means we adapt as soon as possible, a larger
37 * value means that we have to have the respective factor of an
38 * advantage (or delay) before we adapt and sacrifice stability.
40 #define PROP_STABILITY_FACTOR 1.25
44 * Default value to assume for the proportionality factor, if none is
45 * given in the configuration. This factor determines how strong the
46 * bandwidth allocation will orient itself on the application
47 * preferences. A lower factor means a more balanced bandwidth
48 * distribution while a larger number means a distribution more in
49 * line with application (bandwidth) preferences.
51 #define PROPORTIONALITY_FACTOR 2.0
55 * Address information stored for the proportional solver in the
56 * `solver_information` member of `struct GNUNET_ATS_Address`.
58 * They are also stored in the respective `struct Network`'s linked
66 struct AddressWrapper *next;
71 struct AddressWrapper *prev;
76 struct ATS_Address *addr;
79 * Network scope this address is in
81 struct Network *network;
86 uint32_t calculated_quota_in;
91 uint32_t calculated_quota_out;
94 * When was this address activated
96 struct GNUNET_TIME_Absolute activated;
102 * Representation of a network
107 * Network description
112 * String for statistics total addresses
117 * String for statistics active addresses
122 * Linked list of addresses in this network: head
124 struct AddressWrapper *head;
127 * Linked list of addresses in this network: tail
129 struct AddressWrapper *tail;
132 * Total inbound quota
134 unsigned long long total_quota_in;
137 * Total outbound quota
139 unsigned long long total_quota_out;
144 enum GNUNET_ATS_Network_Type type;
147 * Number of active addresses for this network
149 unsigned int active_addresses;
152 * Number of total addresses for this network
154 unsigned int total_addresses;
160 * A handle for the proportional solver
162 struct GAS_PROPORTIONAL_Handle
166 * Our execution environment.
168 struct GNUNET_ATS_PluginEnvironment *env;
173 struct Network *network_entries;
176 * Proportionality factor
183 double stability_factor;
186 * Bulk lock counter. If zero, we are not locked.
188 unsigned int bulk_lock;
191 * Number of changes made while solver was locked. We really only
192 * use 0/non-zero to check on unlock if we have to run the update.
194 unsigned int bulk_requests;
197 * Number of active addresses for solver
199 unsigned int active_addresses;
202 * Number of networks in @a network_entries
204 unsigned int network_count;
209 * Test if bandwidth is available in this network to add an additional address.
211 * @param net the network type to check
212 * @param extra for how many extra addresses do we check?
213 * @return #GNUNET_YES or #GNUNET_NO
216 is_bandwidth_available_in_network (struct Network *net,
220 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
222 GNUNET_assert (net->active_addresses + extra >= 0);
223 na = net->active_addresses + extra;
226 if ( ((net->total_quota_in / na) > min_bw) &&
227 ((net->total_quota_out / na) > min_bw) )
234 * Test if all peers in this network require connectivity at level at
237 * @param s the solver handle
238 * @param net the network type to check
239 * @param con connection return value threshold to check
240 * @return #GNUNET_YES or #GNUNET_NO
243 all_require_connectivity (struct GAS_PROPORTIONAL_Handle *s,
247 struct AddressWrapper *aw;
249 for (aw = net->head; NULL != aw; aw = aw->next)
251 s->env->get_connectivity (s->env->cls,
259 * Update bandwidth assigned to peers in this network. The basic idea
260 * is to assign every peer in the network the minimum bandwidth, and
261 * then distribute the remaining bandwidth proportional to application
264 * @param s the solver handle
265 * @param net the network type to update
268 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
271 const uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
272 struct AddressWrapper *aw;
273 unsigned long long remaining_quota_in;
274 unsigned long long quota_out_used;
275 unsigned long long remaining_quota_out;
276 unsigned long long quota_in_used;
277 unsigned int count_addresses;
278 double sum_relative_peer_prefences;
281 const double *peer_relative_prefs;
283 LOG (GNUNET_ERROR_TYPE_INFO,
284 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
286 net->active_addresses,
288 net->total_quota_in);
290 if (0 == net->active_addresses)
291 return; /* no addresses to update */
294 if ((net->active_addresses * min_bw) > net->total_quota_in)
299 if ((net->active_addresses * min_bw) > net->total_quota_out)
305 /* Calculate sum of relative preference for active addresses in this
307 sum_relative_peer_prefences = 0.0;
309 for (aw = net->head; NULL != aw; aw = aw->next)
311 if (GNUNET_YES != aw->addr->active)
313 peer_relative_prefs = s->env->get_preferences (s->env->cls,
315 sum_relative_peer_prefences += peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
318 if (count_addresses != net->active_addresses)
321 LOG (GNUNET_ERROR_TYPE_WARNING,
322 "%s: Counted %u active addresses, expected %u active addresses\n",
325 net->active_addresses);
327 net->active_addresses = count_addresses;
329 LOG (GNUNET_ERROR_TYPE_INFO,
330 "Total relative preference %.3f for %u addresses in network %s\n",
331 sum_relative_peer_prefences,
332 net->active_addresses,
335 /* check how much we have to distribute */
336 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
337 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
338 LOG (GNUNET_ERROR_TYPE_DEBUG,
339 "Proportionally distributable bandwidth (in/out): %llu/%llu\n",
341 remaining_quota_out);
343 /* distribute remaining quota; we do not do it exactly proportional,
344 but balance "even" distribution ("net->active_addresses") with
345 the preference sum using the "prop_factor". */
346 total_weight = net->active_addresses +
347 s->prop_factor * sum_relative_peer_prefences;
350 for (aw = net->head; NULL != aw; aw = aw->next)
352 if (GNUNET_YES != aw->addr->active)
354 /* set to 0, just to be sure */
355 aw->calculated_quota_in = 0;
356 aw->calculated_quota_out = 0;
359 peer_relative_prefs = s->env->get_preferences (s->env->cls,
362 + s->prop_factor * peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
364 aw->calculated_quota_in = min_bw
365 + (peer_weight / total_weight) * remaining_quota_in;
366 aw->calculated_quota_out = min_bw
367 + (peer_weight / total_weight) * remaining_quota_out;
369 LOG (GNUNET_ERROR_TYPE_INFO,
370 "New quotas for peer `%s' with weight (cur/total) %.3f/%.3f (in/out) are: %u/%u\n",
371 GNUNET_i2s (&aw->addr->peer),
374 (unsigned int) aw->calculated_quota_in,
375 (unsigned int) aw->calculated_quota_out);
376 quota_in_used += aw->calculated_quota_in;
377 quota_out_used += aw->calculated_quota_out;
379 LOG (GNUNET_ERROR_TYPE_DEBUG,
380 "Total bandwidth assigned is (in/out): %llu /%llu\n",
383 /* +1 due to possible rounding errors */
384 GNUNET_break (quota_out_used <= net->total_quota_out + 1);
385 GNUNET_break (quota_in_used <= net->total_quota_in + 1);
390 * Notify ATS service of bandwidth changes to addresses.
392 * @param s solver handle
393 * @param net the network to propagate changes in
396 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
399 struct AddressWrapper *cur;
401 for (cur = net->head; NULL != cur; cur = cur->next)
403 if ( (cur->addr->assigned_bw_in == cur->calculated_quota_in) &&
404 (cur->addr->assigned_bw_out == cur->calculated_quota_out) )
406 cur->addr->assigned_bw_in = cur->calculated_quota_in;
407 cur->addr->assigned_bw_out = cur->calculated_quota_out;
408 if (GNUNET_YES == cur->addr->active)
409 s->env->bandwidth_changed_cb (s->env->cls,
416 * Distribute bandwidth. The addresses have already been selected,
417 * this is merely distributed the bandwidth among the addresses.
419 * @param s the solver handle
420 * @param n the network, can be NULL for all networks
423 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
428 if (GNUNET_YES == s->bulk_lock)
435 LOG (GNUNET_ERROR_TYPE_DEBUG,
436 "Redistributing bandwidth in network %s with %u active and %u total addresses\n",
437 GNUNET_ATS_print_network_type(n->type),
440 s->env->info_cb (s->env->cls,
443 GAS_INFO_PROP_SINGLE);
444 distribute_bandwidth(s,
446 s->env->info_cb (s->env->cls,
449 GAS_INFO_PROP_SINGLE);
450 s->env->info_cb (s->env->cls,
451 GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
453 GAS_INFO_PROP_SINGLE);
454 propagate_bandwidth (s,
457 s->env->info_cb (s->env->cls,
458 GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
460 GAS_INFO_PROP_SINGLE);
464 s->env->info_cb (s->env->cls,
468 for (i = 0; i < s->network_count; i++)
469 distribute_bandwidth (s,
470 &s->network_entries[i]);
471 s->env->info_cb (s->env->cls,
475 s->env->info_cb (s->env->cls,
476 GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
479 for (i = 0; i < s->network_count; i++)
480 propagate_bandwidth (s,
481 &s->network_entries[i]);
482 s->env->info_cb (s->env->cls,
483 GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
491 * Context for finding the best address* Linked list of addresses in this network: head
493 struct FindBestAddressCtx
498 struct GAS_PROPORTIONAL_Handle *s;
501 * The currently best address
503 struct ATS_Address *best;
508 * Find index of a ATS property type in the quality properties array.
510 * @param type ATS property type
511 * @return index in the quality array, #GNUNET_SYSERR if the type
512 * was not a quality property
515 find_quality_property_index (enum GNUNET_ATS_Property type)
517 enum GNUNET_ATS_Property existing_types[] = GNUNET_ATS_QualityProperties;
520 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
521 if (existing_types[c] == type)
524 return GNUNET_SYSERR;
529 * Find a "good" address to use for a peer by iterating over the
530 * addresses for this peer. If we already have an existing address,
531 * we stick to it. Otherwise, we pick by lowest distance and then by
534 * @param cls the `struct FindBestAddressCtx *' where we store the result
535 * @param key the peer we are trying to find the best address for
536 * @param value another `struct ATS_Address*` to consider using
537 * @return #GNUNET_OK (continue to iterate)
540 find_best_address_it (void *cls,
541 const struct GNUNET_PeerIdentity *key,
544 struct FindBestAddressCtx *ctx = cls;
545 struct ATS_Address *current = value;
546 struct AddressWrapper *asi = current->solver_information;
547 struct GNUNET_TIME_Relative active_time;
549 double best_distance;
557 /* we need +1 slot if 'current' is not yet active */
558 need = (GNUNET_YES == current->active) ? 0 : 1;
559 /* we save -1 slot if 'best' is active and belongs
560 to the same network (as we would replace it) */
561 if ( (NULL != ctx->best) &&
562 (GNUNET_YES == ctx->best->active) &&
563 (((struct AddressWrapper *) ctx->best->solver_information)->network ==
566 /* we can gain -1 slot if this peers connectivity
567 requirement is higher than that of another peer
568 in that network scope */
569 con = ctx->s->env->get_connectivity (ctx->s->env->cls,
572 all_require_connectivity (ctx->s,
576 /* test if minimum bandwidth for 'current' would be available */
578 = is_bandwidth_available_in_network (asi->network,
582 /* Bandwidth for this address is unavailable, so we cannot use
586 if (GNUNET_YES == current->active)
588 active_time = GNUNET_TIME_absolute_get_duration (asi->activated);
589 if (active_time.rel_value_us <=
590 ((double) GNUNET_TIME_UNIT_SECONDS.rel_value_us) * ctx->s->stability_factor)
592 /* Keep active address for stability reasons */
597 if (NULL == ctx->best)
599 /* We so far have nothing else, so go with it! */
604 /* Now compare ATS information */
605 index = find_quality_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
606 cur_distance = current->atsin[index].norm;
607 best_distance = ctx->best->atsin[index].norm;
608 index = find_quality_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
609 cur_delay = current->atsin[index].norm;
610 best_delay = ctx->best->atsin[index].norm;
612 /* user shorter distance */
613 if (cur_distance < best_distance)
615 if (GNUNET_NO == ctx->best->active)
617 /* Activity doesn't influence the equation, use current */
620 else if ((best_distance / cur_distance) > ctx->s->stability_factor)
622 /* Distance change is significant, switch active address! */
627 /* User connection with less delay */
628 if (cur_delay < best_delay)
630 if (GNUNET_NO == ctx->best->active)
632 /* Activity doesn't influence the equation, use current */
635 else if ((best_delay / cur_delay) > ctx->s->stability_factor)
637 /* Latency change is significant, switch active address! */
646 * Find the currently best address for a peer from the set of
647 * addresses available or return NULL of no address is available.
649 * @param s the proportional handle
650 * @param addresses the address hashmap
651 * @param id the peer id
652 * @return the address or NULL
655 get_best_address (struct GAS_PROPORTIONAL_Handle *s,
656 struct GNUNET_CONTAINER_MultiPeerMap *addresses,
657 const struct GNUNET_PeerIdentity *id)
659 struct FindBestAddressCtx fba_ctx;
663 GNUNET_CONTAINER_multipeermap_get_multiple (addresses,
665 &find_best_address_it,
672 * Decrease number of active addresses in network.
674 * @param s the solver handle
675 * @param net the network type
678 address_decrement_active (struct GAS_PROPORTIONAL_Handle *s,
681 GNUNET_assert (net->active_addresses > 0);
682 net->active_addresses--;
683 GNUNET_STATISTICS_update (s->env->stats,
687 GNUNET_assert (s->active_addresses > 0);
688 s->active_addresses--;
689 GNUNET_STATISTICS_update (s->env->stats,
690 "# ATS addresses total",
697 * Address map iterator to find current active address for peer.
698 * Asserts that only one address is active per peer.
700 * @param cls last active address
701 * @param key peer's key
702 * @param value address to check
703 * @return #GNUNET_NO on double active address else #GNUNET_YES;
706 get_active_address_it (void *cls,
707 const struct GNUNET_PeerIdentity *key,
710 struct ATS_Address **dest = cls;
711 struct ATS_Address *aa = value;
713 if (GNUNET_YES != aa->active)
715 GNUNET_assert (NULL == (*dest));
722 * Find current active address for peer
724 * @param s the solver handle
725 * @param peer the peer
726 * @return active address or NULL
728 static struct ATS_Address *
729 get_active_address (struct GAS_PROPORTIONAL_Handle *s,
730 const struct GNUNET_PeerIdentity *peer)
732 struct ATS_Address *dest;
735 GNUNET_CONTAINER_multipeermap_get_multiple (s->env->addresses,
737 &get_active_address_it,
744 * Update active address for a peer. Check if active address exists
745 * and what the best address is, if addresses are different switch.
746 * Then reallocate bandwidth within the affected network scopes.
748 * @param s solver handle
749 * @param current_address the address currently active for the peer,
751 * @param peer the peer to check
754 update_active_address (struct GAS_PROPORTIONAL_Handle *s,
755 struct ATS_Address *current_address,
756 const struct GNUNET_PeerIdentity *peer)
758 struct ATS_Address *best_address;
759 struct AddressWrapper *asi_cur;
760 struct AddressWrapper *asi_best;
761 struct AddressWrapper *aw;
762 struct AddressWrapper *aw_min;
764 unsigned int con_min;
766 best_address = get_best_address (s,
769 if (NULL != best_address)
770 asi_best = best_address->solver_information;
773 if (current_address == best_address)
774 return; /* no changes */
775 if (NULL != current_address)
777 /* We switch to a new address (or to none);
778 mark old address as inactive. */
779 asi_cur = current_address->solver_information;
780 GNUNET_assert (GNUNET_YES == current_address->active);
781 LOG (GNUNET_ERROR_TYPE_INFO,
782 "Disabling previous active address for peer `%s'\n",
784 asi_cur->activated = GNUNET_TIME_UNIT_ZERO_ABS;
785 current_address->active = GNUNET_NO;
786 current_address->assigned_bw_in = 0;
787 current_address->assigned_bw_out = 0;
788 address_decrement_active (s,
790 if ( (NULL == best_address) ||
791 (asi_best->network != asi_cur->network) )
792 distribute_bandwidth_in_network (s,
794 if (NULL == best_address)
796 /* We previously had an active address, but now we cannot
797 * suggest one. Therefore we have to disconnect the peer.
798 * The above call to "distribute_bandwidth_in_network()
799 * does not see 'current_address' so we need to trigger
800 * the update here. */
801 LOG (GNUNET_ERROR_TYPE_DEBUG,
802 "Disconnecting peer `%s'.\n",
804 s->env->bandwidth_changed_cb (s->env->cls,
809 if (NULL == best_address)
811 /* We do not have a new address, so we are done. */
812 LOG (GNUNET_ERROR_TYPE_DEBUG,
813 "Cannot suggest address for peer `%s'\n",
817 /* We do have a new address, activate it */
818 LOG (GNUNET_ERROR_TYPE_DEBUG,
819 "Suggesting new address %p for peer `%s'\n",
822 /* Mark address as active */
823 best_address->active = GNUNET_YES;
824 asi_best->activated = GNUNET_TIME_absolute_get ();
825 asi_best->network->active_addresses++;
826 s->active_addresses++;
827 GNUNET_STATISTICS_update (s->env->stats,
828 "# ATS active addresses total",
831 GNUNET_STATISTICS_update (s->env->stats,
832 asi_best->network->stat_active,
835 LOG (GNUNET_ERROR_TYPE_INFO,
836 "Address %p for peer `%s' is now active\n",
842 is_bandwidth_available_in_network (asi_best->network,
845 /* we went over the maximum number of addresses for
846 this scope; remove the address with the smallest
847 connectivity requirement */
848 con_min = UINT32_MAX;
850 for (aw = asi_best->network->head; NULL != aw; aw = aw->next)
853 (a_con = s->env->get_connectivity (s->env->cls,
862 update_active_address (s,
866 distribute_bandwidth_in_network (s,
872 * The preferences for a peer in the problem changed.
874 * @param solver the solver handle
875 * @param peer the peer to change the preference for
876 * @param kind the kind to change the preference
877 * @param pref_rel the normalized preference value for this kind over all clients
880 GAS_proportional_change_preference (void *solver,
881 const struct GNUNET_PeerIdentity *peer,
882 enum GNUNET_ATS_PreferenceKind kind,
885 struct GAS_PROPORTIONAL_Handle *s = solver;
887 if (GNUNET_ATS_PREFERENCE_BANDWIDTH != kind)
888 return; /* we do not care */
889 distribute_bandwidth_in_network (s,
895 * Get application feedback for a peer
897 * @param solver the solver handle
898 * @param application the application
899 * @param peer the peer to change the preference for
900 * @param scope the time interval for this feedback: [now - scope .. now]
901 * @param kind the kind to change the preference
902 * @param score the score
905 GAS_proportional_feedback (void *solver,
906 struct GNUNET_SERVER_Client *application,
907 const struct GNUNET_PeerIdentity *peer,
908 const struct GNUNET_TIME_Relative scope,
909 enum GNUNET_ATS_PreferenceKind kind,
912 /* Proportional does not care about feedback */
917 * Get the preferred address for a specific peer
919 * @param solver the solver handle
920 * @param peer the identity of the peer
923 GAS_proportional_start_get_address (void *solver,
924 const struct GNUNET_PeerIdentity *peer)
926 struct GAS_PROPORTIONAL_Handle *s = solver;
928 update_active_address (s,
929 get_active_address (s,
936 * Stop notifying about address and bandwidth changes for this peer
938 * @param solver the solver handle
939 * @param peer the peer
942 GAS_proportional_stop_get_address (void *solver,
943 const struct GNUNET_PeerIdentity *peer)
945 struct GAS_PROPORTIONAL_Handle *s = solver;
946 struct ATS_Address *cur;
947 struct AddressWrapper *asi;
949 cur = get_active_address (s,
953 asi = cur->solver_information;
954 distribute_bandwidth_in_network (s,
960 * Start a bulk operation
962 * @param solver the solver
965 GAS_proportional_bulk_start (void *solver)
967 struct GAS_PROPORTIONAL_Handle *s = solver;
969 LOG (GNUNET_ERROR_TYPE_DEBUG,
970 "Locking solver for bulk operation ...\n");
971 GNUNET_assert (NULL != solver);
977 * Bulk operation done.
979 * @param solver our `struct GAS_PROPORTIONAL_Handle *`
982 GAS_proportional_bulk_stop (void *solver)
984 struct GAS_PROPORTIONAL_Handle *s = solver;
986 LOG (GNUNET_ERROR_TYPE_DEBUG,
987 "Unlocking solver from bulk operation ...\n");
988 if (s->bulk_lock < 1)
994 if ( (0 == s->bulk_lock) &&
995 (0 < s->bulk_requests) )
997 LOG (GNUNET_ERROR_TYPE_INFO,
998 "No lock pending, recalculating\n");
999 distribute_bandwidth_in_network (s,
1001 s->bulk_requests = 0;
1007 * Transport properties for this address have changed
1009 * @param solver solver handle
1010 * @param address the address
1011 * @param type the ATSI type
1012 * @param abs_value the absolute value of the property
1013 * @param rel_value the normalized value
1016 GAS_proportional_address_property_changed (void *solver,
1017 struct ATS_Address *address,
1018 enum GNUNET_ATS_Property type,
1022 struct GAS_PROPORTIONAL_Handle *s = solver;
1023 struct AddressWrapper *asi = address->solver_information;
1025 distribute_bandwidth_in_network (s,
1031 * Add a new single address to a network
1033 * @param solver the solver Handle
1034 * @param address the address to add
1035 * @param network network type of this address
1038 GAS_proportional_address_add (void *solver,
1039 struct ATS_Address *address,
1040 enum GNUNET_ATS_Network_Type network)
1042 struct GAS_PROPORTIONAL_Handle *s = solver;
1043 struct Network *net;
1044 struct AddressWrapper *aw;
1046 GNUNET_assert (network < s->env->network_count);
1047 net = &s->network_entries[network];
1048 net->total_addresses++;
1050 aw = GNUNET_new (struct AddressWrapper);
1053 address->solver_information = aw;
1054 GNUNET_CONTAINER_DLL_insert (net->head,
1057 GNUNET_STATISTICS_update (s->env->stats,
1058 "# ATS addresses total",
1061 GNUNET_STATISTICS_update (s->env->stats,
1065 update_active_address (s,
1066 get_active_address (s,
1069 LOG (GNUNET_ERROR_TYPE_INFO,
1070 "Added new address for `%s', now total %u and active %u addresses in network `%s'\n",
1071 GNUNET_i2s (&address->peer),
1072 net->total_addresses,
1073 net->active_addresses,
1079 * Remove an address from the solver. To do so, we:
1080 * - Removed it from specific network
1081 * - Decrease the number of total addresses
1083 * - decrease number of active addreses
1086 * @param solver the solver handle
1087 * @param address the address to remove
1090 GAS_proportional_address_delete (void *solver,
1091 struct ATS_Address *address)
1093 struct GAS_PROPORTIONAL_Handle *s = solver;
1094 struct AddressWrapper *aw = address->solver_information;
1095 struct Network *net = aw->network;
1097 LOG (GNUNET_ERROR_TYPE_DEBUG,
1098 "Deleting %s address for peer `%s' from network `%s' (total: %u/active: %u)\n",
1099 (GNUNET_NO == address->active) ? "inactive" : "active",
1100 GNUNET_i2s (&address->peer),
1102 net->total_addresses,
1103 net->active_addresses);
1105 GNUNET_CONTAINER_DLL_remove (net->head,
1108 GNUNET_assert (net->total_addresses > 0);
1109 net->total_addresses--;
1110 GNUNET_STATISTICS_update (s->env->stats,
1114 if (GNUNET_YES == address->active)
1116 /* Address was active, remove from network and update quotas */
1117 update_active_address (s,
1120 distribute_bandwidth_in_network (s, net);
1123 address->solver_information = NULL;
1124 LOG (GNUNET_ERROR_TYPE_DEBUG,
1125 "After deleting address now total %u and active %u addresses in network `%s'\n",
1126 net->total_addresses,
1127 net->active_addresses,
1133 * Function invoked when the plugin is loaded.
1135 * @param[in,out] cls the `struct GNUNET_ATS_PluginEnvironment *` to use;
1136 * modified to return the API functions (ugh).
1137 * @return the `struct GAS_PROPORTIONAL_Handle` to pass as a closure
1140 libgnunet_plugin_ats_proportional_init (void *cls)
1142 static struct GNUNET_ATS_SolverFunctions sf;
1143 struct GNUNET_ATS_PluginEnvironment *env = cls;
1144 struct GAS_PROPORTIONAL_Handle *s;
1145 struct Network * cur;
1149 s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
1152 sf.s_add = &GAS_proportional_address_add;
1153 sf.s_address_update_property = &GAS_proportional_address_property_changed;
1154 sf.s_get = &GAS_proportional_start_get_address;
1155 sf.s_get_stop = &GAS_proportional_stop_get_address;
1156 sf.s_pref = &GAS_proportional_change_preference;
1157 sf.s_feedback = &GAS_proportional_feedback;
1158 sf.s_del = &GAS_proportional_address_delete;
1159 sf.s_bulk_start = &GAS_proportional_bulk_start;
1160 sf.s_bulk_stop = &GAS_proportional_bulk_stop;
1161 s->stability_factor = PROP_STABILITY_FACTOR;
1162 if (GNUNET_SYSERR !=
1163 GNUNET_CONFIGURATION_get_value_float (env->cfg,
1165 "PROP_STABILITY_FACTOR",
1168 if ((f_tmp < 1.0) || (f_tmp > 2.0))
1170 LOG (GNUNET_ERROR_TYPE_ERROR,
1171 _("Invalid %s configuration %f \n"),
1172 "PROP_STABILITY_FACTOR",
1177 s->stability_factor = f_tmp;
1178 LOG (GNUNET_ERROR_TYPE_INFO,
1179 "Using %s of %.3f\n",
1180 "PROP_STABILITY_FACTOR",
1184 s->prop_factor = PROPORTIONALITY_FACTOR;
1185 if (GNUNET_SYSERR !=
1186 GNUNET_CONFIGURATION_get_value_float (env->cfg,
1188 "PROP_PROPORTIONALITY_FACTOR",
1193 LOG (GNUNET_ERROR_TYPE_ERROR,
1194 _("Invalid %s configuration %f\n"),
1195 "PROP_PROPORTIONALITY_FACTOR",
1200 s->prop_factor = f_tmp;
1201 LOG (GNUNET_ERROR_TYPE_INFO,
1202 "Using %s of %.3f\n",
1203 "PROP_PROPORTIONALITY_FACTOR",
1208 s->network_entries = GNUNET_malloc (env->network_count *
1209 sizeof (struct Network));
1210 for (c = 0; c < env->network_count; c++)
1212 cur = &s->network_entries[c];
1214 cur->total_quota_in = env->in_quota[c];
1215 cur->total_quota_out = env->out_quota[c];
1216 cur->desc = GNUNET_ATS_print_network_type (c);
1217 GNUNET_asprintf (&cur->stat_total,
1218 "# ATS addresses %s total",
1220 GNUNET_asprintf (&cur->stat_active,
1221 "# ATS active addresses %s total",
1223 LOG (GNUNET_ERROR_TYPE_INFO,
1224 "Added network %u `%s' (%llu/%llu)\n",
1227 cur->total_quota_in,
1228 cur->total_quota_out);
1235 * Function used to unload the plugin.
1237 * @param cls return value from #libgnunet_plugin_ats_proportional_init()
1240 libgnunet_plugin_ats_proportional_done (void *cls)
1242 struct GNUNET_ATS_SolverFunctions *sf = cls;
1243 struct GAS_PROPORTIONAL_Handle *s = sf->cls;
1244 struct AddressWrapper *cur;
1245 struct AddressWrapper *next;
1248 for (c = 0; c < s->network_count; c++)
1250 GNUNET_break (0 == s->network_entries[c].total_addresses);
1251 GNUNET_break (0 == s->network_entries[c].active_addresses);
1252 next = s->network_entries[c].head;
1253 while (NULL != (cur = next))
1256 GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1257 s->network_entries[c].tail,
1259 GNUNET_free_non_null (cur->addr->solver_information);
1262 GNUNET_free (s->network_entries[c].stat_total);
1263 GNUNET_free (s->network_entries[c].stat_active);
1265 GNUNET_break (0 == s->active_addresses);
1266 GNUNET_free (s->network_entries);
1272 /* end of plugin_ats_proportional.c */