-getting there...
[oweals/gnunet.git] / src / ats / plugin_ats_proportional.c
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2011-2015 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19  */
20
21 /**
22  * @file ats/plugin_ats_proportional.c
23  * @brief ATS proportional solver
24  * @author Matthias Wachs
25  * @author Christian Grothoff
26  */
27 #include "platform.h"
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"
32
33 #define PROP_STABILITY_FACTOR 1.25
34
35
36 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
37
38
39 /**
40  *
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
44  *
45  * ATS addresses : proportional solver
46  *
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
61  *
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 *
76  *    preference changes
77  *
78  *     3.1 Data structures used
79  *
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.
87  *
88  *     3.2 Initializing
89  *
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.
93  *
94  *     3.3 Adding an address
95  *
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.
99  *
100  *     3.4 Updating an address
101  *
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.
124  *
125  *     3.5 Deleting an address
126  *
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
130  *    network.
131  *
132  *     3.6 Requesting addresses
133  *
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.
149  *
150  *     3.7 Choosing addresses
151  *
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
170  *    latency
171  *
172  *     3.8 Changing preferences
173  *
174  *     3.9 Shutdown
175  *
176  *    During shutdown all network entries and aging processes are
177  *    destroyed and freed.
178  *
179  *
180  * OLD DOCUMENTATION
181  *
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.
185  *
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
189  * callback.
190  *
191  * - Initialization
192  *
193  *
194  *
195  *
196  * For each peer only a single is selected and marked as "active" in the address
197  * struct.
198  *
199  * E.g.:
200  *
201  * You have the networks WAN and LAN and quotas
202  * WAN_TOTAL_IN, WAN_TOTAL_OUT
203  * LAN_TOTAL_IN, LAN_TOTAL_OUT
204  *
205  * If you have x addresses in the network segment LAN, the quotas are
206  * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
207  *
208  * Quotas are automatically recalculated and reported back when addresses are
209  * - requested
210  *
211  */
212
213 /**
214  * Default value to assume for the proportionality factor,
215  * if none is given in the configuration.
216  */
217 #define PROPORTIONALITY_FACTOR 2.0
218
219
220 /**
221  * Address information stored for the proportional solver in the
222  * `solver_information` member of `struct GNUNET_ATS_Address`.
223  *
224  * They are also stored in the respective `struct Network`'s linked
225  * list.
226  */
227 struct AddressWrapper
228 {
229   /**
230    * Next in DLL
231    */
232   struct AddressWrapper *next;
233
234   /**
235    * Previous in DLL
236    */
237   struct AddressWrapper *prev;
238
239   /**
240    * The address
241    */
242   struct ATS_Address *addr;
243
244     /**
245    * Network scope this address is in
246    */
247   struct Network *network;
248
249   /**
250    * Inbound quota
251    */
252   uint32_t calculated_quota_in;
253
254   /**
255    * Outbound quota
256    */
257   uint32_t calculated_quota_out;
258
259   /**
260    * When was this address activated
261    */
262   struct GNUNET_TIME_Absolute activated;
263
264 };
265
266
267 /**
268  * Representation of a network
269  */
270 struct Network
271 {
272   /**
273    * Network description
274    */
275   const char *desc;
276
277   /**
278    * String for statistics total addresses
279    */
280   char *stat_total;
281
282   /**
283    * String for statistics active addresses
284    */
285   char *stat_active;
286
287   /**
288    * Linked list of addresses in this network: head
289    */
290   struct AddressWrapper *head;
291
292   /**
293    * Linked list of addresses in this network: tail
294    */
295   struct AddressWrapper *tail;
296
297   /**
298    * Total inbound quota
299    */
300   unsigned long long total_quota_in;
301
302   /**
303    * Total outbound quota
304    */
305   unsigned long long total_quota_out;
306
307   /**
308    * ATS network type
309    */
310   enum GNUNET_ATS_Network_Type type;
311
312   /**
313    * Number of active addresses for this network
314    */
315   unsigned int active_addresses;
316
317   /**
318    * Number of total addresses for this network
319    */
320   unsigned int total_addresses;
321
322 };
323
324
325 /**
326  * A handle for the proportional solver
327  */
328 struct GAS_PROPORTIONAL_Handle
329 {
330
331   /**
332    * Our execution environment.
333    */
334   struct GNUNET_ATS_PluginEnvironment *env;
335
336   /**
337    * Networks array
338    */
339   struct Network *network_entries;
340
341   /**
342    * Proportionality factor
343    */
344   double prop_factor;
345
346   /**
347    * Stability factor
348    */
349   double stability_factor;
350
351   /**
352    * Bulk lock counter. If zero, we are not locked.
353    */
354   unsigned int bulk_lock;
355
356   /**
357    * Number of changes made while solver was locked.  We really only
358    * use 0/non-zero to check on unlock if we have to run the update.
359    */
360   unsigned int bulk_requests;
361
362   /**
363    * Number of active addresses for solver
364    */
365   unsigned int active_addresses;
366
367   /**
368    * Number of networks in @a network_entries
369    */
370   unsigned int network_count;
371 };
372
373
374 /**
375  * Test if bandwidth is available in this network to add an additional address
376  *
377  * @param net the network type to update
378  * @return #GNUNET_YES or #GNUNET_NO
379  */
380 static int
381 is_bandwidth_available_in_network (struct Network *net)
382 {
383   unsigned int na = net->active_addresses + 1;
384   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
385
386   if ( ((net->total_quota_in / na) > min_bw) &&
387        ((net->total_quota_out / na) > min_bw) )
388   {
389     LOG (GNUNET_ERROR_TYPE_DEBUG,
390          "Enough bandwidth available for %u active addresses in network `%s'\n",
391          na,
392          net->desc);
393
394     return GNUNET_YES;
395   }
396   LOG (GNUNET_ERROR_TYPE_DEBUG,
397        "Not enough bandwidth available for %u active addresses in network `%s'\n",
398        na,
399        net->desc);
400   return GNUNET_NO;
401 }
402
403
404 /**
405  * Update bandwidth assigned to peers in this network
406  *
407  * @param s the solver handle
408  * @param net the network type to update
409  * this address
410  */
411 static void
412 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
413                       struct Network *net)
414 {
415   struct AddressWrapper *aw;
416   unsigned long long remaining_quota_in = 0;
417   unsigned long long quota_out_used = 0;
418   unsigned long long remaining_quota_out = 0;
419   unsigned long long quota_in_used = 0;
420   int count_addresses;
421   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
422   double relative_peer_prefence;
423   double sum_relative_peer_prefences; /* Important: has to be double not float due to precision */
424   double cur_pref; /* Important: has to be double not float due to precision */
425   double peer_weight;
426   double total_weight;
427   const double *peer_relative_prefs = NULL; /* Important: has to be double not float due to precision */
428
429   uint32_t assigned_quota_in = 0;
430   uint32_t assigned_quota_out = 0;
431
432
433   LOG (GNUNET_ERROR_TYPE_INFO,
434        "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
435        net->desc,
436        net->active_addresses,
437        net->total_quota_in,
438        net->total_quota_in);
439
440   if (net->active_addresses == 0)
441   {
442     return; /* no addresses to update */
443   }
444
445   /* Idea
446    * Assign every peer in network minimum Bandwidth
447    * Distribute bandwidth left according to preference
448    */
449
450   if ((net->active_addresses * min_bw) > net->total_quota_in)
451   {
452     GNUNET_break(0);
453     return;
454   }
455   if ((net->active_addresses * min_bw) > net->total_quota_out)
456   {
457     GNUNET_break(0);
458     return;
459   }
460
461   remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
462   remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
463   LOG(GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
464       remaining_quota_in, remaining_quota_out);
465   sum_relative_peer_prefences = 0.0;
466
467   /* Calculate sum of relative preference for active addresses in this network */
468   count_addresses = 0;
469   for (aw = net->head; NULL != aw; aw = aw->next)
470   {
471     if (GNUNET_YES != aw->addr->active)
472       continue;
473
474     peer_relative_prefs = s->env->get_preferences (s->env->cls,
475                                                    &aw->addr->peer);
476     relative_peer_prefence = 0.0;
477     relative_peer_prefence += peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
478     sum_relative_peer_prefences += relative_peer_prefence;
479     count_addresses ++;
480   }
481
482   if (count_addresses != net->active_addresses)
483   {
484     GNUNET_break (0);
485     LOG (GNUNET_ERROR_TYPE_WARNING,
486          "%s: Counted %u active addresses, but network says to have %u active addresses\n",
487          net->desc,
488          count_addresses,
489          net->active_addresses);
490     for (aw = net->head; NULL != aw; aw = aw->next)
491     {
492       if (GNUNET_YES != aw->addr->active)
493         continue;
494
495       LOG (GNUNET_ERROR_TYPE_WARNING,
496            "Active: `%s' `%s' length %u\n",
497            GNUNET_i2s (&aw->addr->peer),
498            aw->addr->plugin,
499            aw->addr->addr_len);
500     }
501   }
502
503   LOG (GNUNET_ERROR_TYPE_INFO,
504        "Total relative preference %.3f for %u addresses in network %s\n",
505        sum_relative_peer_prefences,
506        net->active_addresses,
507        net->desc);
508
509   for (aw = net->head; NULL != aw; aw = aw->next)
510   {
511     if (GNUNET_YES == aw->addr->active)
512     {
513       peer_relative_prefs = s->env->get_preferences (s->env->cls,
514                                                      &aw->addr->peer);
515
516       cur_pref = peer_relative_prefs[GNUNET_ATS_PREFERENCE_BANDWIDTH];
517       total_weight = net->active_addresses +
518           s->prop_factor * sum_relative_peer_prefences;
519       peer_weight = (1.0 + (s->prop_factor * cur_pref));
520
521       assigned_quota_in = min_bw
522           + ((peer_weight / total_weight) * remaining_quota_in);
523       assigned_quota_out = min_bw
524           + ((peer_weight / total_weight) * remaining_quota_out);
525
526       LOG (GNUNET_ERROR_TYPE_INFO,
527           "New quota for peer `%s' with weight (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
528           GNUNET_i2s (&aw->addr->peer),
529            peer_weight,
530            total_weight,
531           assigned_quota_in,
532            assigned_quota_out);
533     }
534     else
535     {
536       assigned_quota_in = 0;
537       assigned_quota_out = 0;
538     }
539
540     quota_in_used += assigned_quota_in;
541     quota_out_used += assigned_quota_out;
542     /* Prevent overflow due to rounding errors */
543     if (assigned_quota_in > UINT32_MAX)
544       assigned_quota_in = UINT32_MAX;
545     if (assigned_quota_out > UINT32_MAX)
546       assigned_quota_out = UINT32_MAX;
547
548     /* Store for later propagation */
549     aw->calculated_quota_in = assigned_quota_in;
550     aw->calculated_quota_out = assigned_quota_out;
551   }
552   LOG (GNUNET_ERROR_TYPE_DEBUG,
553        "Total bandwidth assigned is (in/out): %llu /%llu\n",
554        quota_in_used,
555        quota_out_used);
556   if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
557   {
558     LOG (GNUNET_ERROR_TYPE_ERROR,
559          "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
560          net->active_addresses,
561          quota_out_used,
562          net->total_quota_out);
563   }
564   if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
565   {
566     LOG (GNUNET_ERROR_TYPE_ERROR,
567          "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
568          net->active_addresses,
569          quota_in_used,
570          net->total_quota_in);
571   }
572 }
573
574
575 /**
576  * Notify ATS service of bandwidth changes to addresses.
577  *
578  * @param s solver handle
579  * @param net the network to propagate changes in
580  */
581 static void
582 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
583                      struct Network *net)
584 {
585   struct AddressWrapper *cur;
586
587   for (cur = net->head; NULL != cur; cur = cur->next)
588   {
589     if ( (cur->addr->assigned_bw_in == cur->calculated_quota_in) &&
590          (cur->addr->assigned_bw_out == cur->calculated_quota_out) )
591       continue;
592     cur->addr->assigned_bw_in = cur->calculated_quota_in;
593     cur->addr->assigned_bw_out = cur->calculated_quota_out;
594
595     LOG (GNUNET_ERROR_TYPE_DEBUG,
596          "Bandwidth for %s address %p for peer `%s' changed to %u/%u\n",
597          (GNUNET_NO == cur->addr->active) ? "inactive" : "active",
598          cur->addr,
599          GNUNET_i2s (&cur->addr->peer),
600          cur->addr->assigned_bw_in,
601          cur->addr->assigned_bw_out);
602
603     /* Notify on change */
604     if (GNUNET_YES == cur->addr->active)
605       s->env->bandwidth_changed_cb (s->env->cls,
606                                     cur->addr);
607   }
608 }
609
610
611 /**
612  * Distribute bandwidth.  The addresses have already been selected,
613  * this is merely distributed the bandwidth among the addresses.
614  *
615  * @param s the solver handle
616  * @param n the network, can be NULL for all networks
617  */
618 static void
619 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
620                                  struct Network *n)
621 {
622   unsigned int i;
623
624   if (GNUNET_YES == s->bulk_lock)
625   {
626     s->bulk_requests++;
627     return;
628   }
629   if (NULL != n)
630   {
631     LOG (GNUNET_ERROR_TYPE_DEBUG,
632         "Redistributing bandwidth in network %s with %u active and %u total addresses\n",
633          GNUNET_ATS_print_network_type(n->type),
634          n->active_addresses,
635          n->total_addresses);
636     s->env->info_cb (s->env->cls,
637                      GAS_OP_SOLVE_START,
638                      GAS_STAT_SUCCESS,
639                      GAS_INFO_PROP_SINGLE);
640     distribute_bandwidth(s,
641                          n);
642     s->env->info_cb (s->env->cls,
643                      GAS_OP_SOLVE_STOP,
644                      GAS_STAT_SUCCESS,
645                      GAS_INFO_PROP_SINGLE);
646     s->env->info_cb (s->env->cls,
647                      GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
648                      GAS_STAT_SUCCESS,
649                      GAS_INFO_PROP_SINGLE);
650     propagate_bandwidth (s,
651                          n);
652
653     s->env->info_cb (s->env->cls,
654                      GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
655                      GAS_STAT_SUCCESS,
656                      GAS_INFO_PROP_SINGLE);
657   }
658   else
659   {
660     s->env->info_cb (s->env->cls,
661                      GAS_OP_SOLVE_START,
662                      GAS_STAT_SUCCESS,
663                      GAS_INFO_PROP_ALL);
664     for (i = 0; i < s->network_count; i++)
665       distribute_bandwidth (s,
666                             &s->network_entries[i]);
667     s->env->info_cb (s->env->cls,
668                      GAS_OP_SOLVE_STOP,
669                      GAS_STAT_SUCCESS,
670                      GAS_INFO_PROP_ALL);
671     s->env->info_cb (s->env->cls,
672                      GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
673                      GAS_STAT_SUCCESS,
674                      GAS_INFO_PROP_ALL);
675     for (i = 0; i < s->network_count; i++)
676       propagate_bandwidth (s,
677                            &s->network_entries[i]);
678     s->env->info_cb (s->env->cls,
679                      GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
680                      GAS_STAT_SUCCESS,
681                      GAS_INFO_PROP_ALL);
682   }
683 }
684
685
686 /**
687  * Context for finding the best address* Linked list of addresses in this network: head
688  */
689 struct FindBestAddressCtx
690 {
691   /**
692    * The solver handle
693    */
694   struct GAS_PROPORTIONAL_Handle *s;
695
696   /**
697    * The currently best address
698    */
699   struct ATS_Address *best;
700 };
701
702
703 /**
704  * Find index of a ATS property type in the quality properties array.
705  *
706  * @param type ATS property type
707  * @return index in the quality array, #GNUNET_SYSERR if the type
708  *         was not a quality property
709  */
710 static int
711 find_quality_property_index (enum GNUNET_ATS_Property type)
712 {
713   enum GNUNET_ATS_Property existing_types[] = GNUNET_ATS_QualityProperties;
714   unsigned int c;
715
716   for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
717     if (existing_types[c] == type)
718       return c;
719   GNUNET_break (0);
720   return GNUNET_SYSERR;
721 }
722
723
724 /**
725  * Find a "good" address to use for a peer by iterating over the
726  * addresses for this peer.  If we already have an existing address,
727  * we stick to it.  Otherwise, we pick by lowest distance and then by
728  * lowest latency.
729  *
730  * @param cls the `struct FindBestAddressCtx *' where we store the result
731  * @param key the peer we are trying to find the best address for
732  * @param value another `struct ATS_Address*` to consider using
733  * @return #GNUNET_OK (continue to iterate)
734  */
735 static int
736 find_best_address_it (void *cls,
737                       const struct GNUNET_PeerIdentity *key,
738                       void *value)
739 {
740   struct FindBestAddressCtx *ctx = cls;
741   struct ATS_Address *current = value;
742   struct AddressWrapper *asi = current->solver_information;
743   struct GNUNET_TIME_Relative active_time;
744   double best_delay;
745   double best_distance;
746   double cur_delay;
747   double cur_distance;
748   int index;
749
750   if (GNUNET_NO ==
751       is_bandwidth_available_in_network (asi->network))
752   {
753     /* There's no bandwidth available in this network,
754        so we cannot use this address. */
755     return GNUNET_OK;
756   }
757   if (GNUNET_YES == current->active)
758   {
759     active_time = GNUNET_TIME_absolute_get_duration (asi->activated);
760     if (active_time.rel_value_us <=
761         ((double) GNUNET_TIME_UNIT_SECONDS.rel_value_us) * ctx->s->stability_factor)
762     {
763       /* Keep active address for stability reasons */
764       ctx->best = current;
765       return GNUNET_NO;
766     }
767   }
768   if (NULL == ctx->best)
769   {
770     /* We so far have nothing else, so go with it! */
771     ctx->best = current;
772     return GNUNET_OK;
773   }
774
775   /* Now compare ATS information */
776   index = find_quality_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
777   cur_distance = current->atsin[index].norm;
778   best_distance = ctx->best->atsin[index].norm;
779   index = find_quality_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
780   cur_delay = current->atsin[index].norm;
781   best_delay = ctx->best->atsin[index].norm;
782
783   /* user shorter distance */
784   if (cur_distance < best_distance)
785   {
786     if (GNUNET_NO == ctx->best->active)
787     {
788       /* Activity doesn't influence the equation, use current */
789       ctx->best = current;
790     }
791     else if ((best_distance / cur_distance) > ctx->s->stability_factor)
792     {
793       /* Distance change is significant, switch active address! */
794       ctx->best = current;
795     }
796   }
797
798   /* User connection with less delay */
799   if (cur_delay < best_delay)
800   {
801     if (GNUNET_NO == ctx->best->active)
802     {
803       /* Activity doesn't influence the equation, use current */
804       ctx->best = current;
805     }
806     else if ((best_delay / cur_delay) > ctx->s->stability_factor)
807     {
808       /* Latency change is significant, switch active address! */
809       ctx->best = current;
810     }
811   }
812   return GNUNET_OK;
813 }
814
815
816 /**
817  * Find the currently best address for a peer from the set of
818  * addresses available or return NULL of no address is available.
819  *
820  * @param s the proportional handle
821  * @param addresses the address hashmap
822  * @param id the peer id
823  * @return the address or NULL
824  */
825 struct ATS_Address *
826 get_best_address (struct GAS_PROPORTIONAL_Handle *s,
827                   struct GNUNET_CONTAINER_MultiPeerMap *addresses,
828                   const struct GNUNET_PeerIdentity *id)
829 {
830   struct FindBestAddressCtx fba_ctx;
831
832   fba_ctx.best = NULL;
833   fba_ctx.s = s;
834   GNUNET_CONTAINER_multipeermap_get_multiple (addresses,
835                                               id,
836                                               &find_best_address_it,
837                                               &fba_ctx);
838   return fba_ctx.best;
839 }
840
841
842 /**
843  * Decrease number of active addresses in network.
844  *
845  * @param s the solver handle
846  * @param net the network type
847  */
848 static void
849 address_decrement_active (struct GAS_PROPORTIONAL_Handle *s,
850                           struct Network *net)
851 {
852   GNUNET_assert (net->active_addresses > 0);
853   net->active_addresses--;
854   GNUNET_STATISTICS_update (s->env->stats,
855                             net->stat_active,
856                             -1,
857                             GNUNET_NO);
858   GNUNET_assert (s->active_addresses > 0);
859   s->active_addresses--;
860   GNUNET_STATISTICS_update (s->env->stats,
861                             "# ATS addresses total",
862                             -1,
863                             GNUNET_NO);
864 }
865
866
867 /**
868  * Address map iterator to find current active address for peer.
869  * Asserts that only one address is active per peer.
870  *
871  * @param cls last active address
872  * @param key peer's key
873  * @param value address to check
874  * @return #GNUNET_NO on double active address else #GNUNET_YES;
875  */
876 static int
877 get_active_address_it (void *cls,
878                        const struct GNUNET_PeerIdentity *key,
879                        void *value)
880 {
881   struct ATS_Address **dest = cls;
882   struct ATS_Address *aa = value;
883
884   if (GNUNET_YES != aa->active)
885     return GNUNET_OK;
886   GNUNET_assert (NULL == (*dest));
887   (*dest) = aa;
888   return GNUNET_OK;
889 }
890
891
892 /**
893  * Find current active address for peer
894  *
895  * @param s the solver handle
896  * @param peer the peer
897  * @return active address or NULL
898  */
899 static struct ATS_Address *
900 get_active_address (struct GAS_PROPORTIONAL_Handle *s,
901                     const struct GNUNET_PeerIdentity *peer)
902 {
903   struct ATS_Address *dest;
904
905   dest = NULL;
906   GNUNET_CONTAINER_multipeermap_get_multiple (s->env->addresses,
907                                               peer,
908                                               &get_active_address_it,
909                                               &dest);
910   return dest;
911 }
912
913
914 /**
915  * Update active address for a peer:
916  * Check if active address exists and what the best address is, if addresses
917  * are different switch
918  *
919  * @param s solver handle
920  * @param current_address the address currently active for the peer,
921  *        NULL for none
922  * @param peer the peer to check
923  * return the new address or NULL if no update was performed
924   */
925 static struct ATS_Address *
926 update_active_address (struct GAS_PROPORTIONAL_Handle *s,
927                        struct ATS_Address *current_address,
928                        const struct GNUNET_PeerIdentity *peer)
929 {
930   struct ATS_Address *best_address;
931   struct AddressWrapper *asi;
932   struct Network *net;
933
934   best_address = get_best_address (s,
935                                    s->env->addresses,
936                                    peer);
937   if (NULL != current_address)
938   {
939     GNUNET_assert (GNUNET_YES == current_address->active);
940     if ( (NULL == best_address) ||
941          ( (NULL != best_address) &&
942            (current_address != best_address) ) )
943     {
944       /* We switch to a new address (or to none),
945          mark old address as inactive */
946       LOG (GNUNET_ERROR_TYPE_INFO,
947            "Disabling previous active address for peer `%s'\n",
948            GNUNET_i2s (peer));
949
950       asi = current_address->solver_information;
951       net = asi->network;
952       asi->activated = GNUNET_TIME_UNIT_ZERO_ABS;
953       current_address->active = GNUNET_NO; /* No active any longer */
954       current_address->assigned_bw_in = 0; /* no bandwidth assigned */
955       current_address->assigned_bw_out = 0; /* no bandwidth assigned */
956       address_decrement_active (s, net);
957       distribute_bandwidth_in_network (s, net);
958     }
959     if (NULL == best_address)
960     {
961       /* We previously had an active address, but now we cannot suggest one
962        * Therefore we have to disconnect the peer */
963       LOG (GNUNET_ERROR_TYPE_INFO,
964            "Disconnecting peer `%s' with previous address %p\n",
965            GNUNET_i2s (peer),
966            current_address);
967       s->env->bandwidth_changed_cb (s->env->cls,
968                                     current_address);
969     }
970   }
971   if (NULL == best_address)
972   {
973     LOG (GNUNET_ERROR_TYPE_INFO,
974          "Cannot suggest address for peer `%s'\n",
975          GNUNET_i2s (peer));
976     return NULL;
977   }
978
979   LOG (GNUNET_ERROR_TYPE_INFO,
980        "Suggesting new address %p for peer `%s'\n",
981        best_address,
982        GNUNET_i2s (peer));
983
984   if ( (NULL != current_address) &&
985        (best_address == current_address) )
986   {
987     GNUNET_break (GNUNET_NO != current_address->active);
988     return best_address; /* Same same */
989   }
990
991   asi = best_address->solver_information;
992   net = asi->network;
993
994   /* Mark address as active */
995   asi->activated = GNUNET_TIME_absolute_get ();
996   best_address->active = GNUNET_YES;
997
998   net->active_addresses++;
999   s->active_addresses++;
1000   GNUNET_STATISTICS_update (s->env->stats,
1001                             "# ATS active addresses total",
1002                             1,
1003                             GNUNET_NO);
1004   GNUNET_STATISTICS_update (s->env->stats,
1005                             net->stat_active,
1006                             1,
1007                             GNUNET_NO);
1008   LOG (GNUNET_ERROR_TYPE_INFO,
1009        "Address %p for peer `%s' is now active\n",
1010        best_address,
1011        GNUNET_i2s (peer));
1012   /* Distribute bandwidth */
1013   distribute_bandwidth_in_network (s,
1014                                    net);
1015   return best_address;
1016 }
1017
1018
1019 /**
1020  * The preferences for a peer in the problem changed.
1021  *
1022  * @param solver the solver handle
1023  * @param peer the peer to change the preference for
1024  * @param kind the kind to change the preference
1025  * @param pref_rel the normalized preference value for this kind over all clients
1026  */
1027 static void
1028 GAS_proportional_address_change_preference (void *solver,
1029                                             const struct GNUNET_PeerIdentity *peer,
1030                                             enum GNUNET_ATS_PreferenceKind kind,
1031                                             double pref_rel)
1032 {
1033   struct GAS_PROPORTIONAL_Handle *s = solver;
1034
1035   distribute_bandwidth_in_network (s,
1036                                    NULL);
1037 }
1038
1039
1040 /**
1041  * Get application feedback for a peer
1042  *
1043  * @param solver the solver handle
1044  * @param application the application
1045  * @param peer the peer to change the preference for
1046  * @param scope the time interval for this feedback: [now - scope .. now]
1047  * @param kind the kind to change the preference
1048  * @param score the score
1049  */
1050 static void
1051 GAS_proportional_address_preference_feedback (void *solver,
1052                                               struct GNUNET_SERVER_Client *application,
1053                                               const struct GNUNET_PeerIdentity *peer,
1054                                               const struct GNUNET_TIME_Relative scope,
1055                                               enum GNUNET_ATS_PreferenceKind kind,
1056                                               double score)
1057 {
1058   /* Proportional does not care about feedback */
1059 }
1060
1061
1062 /**
1063  * Get the preferred address for a specific peer
1064  *
1065  * @param solver the solver handle
1066  * @param peer the identity of the peer
1067  */
1068 static void
1069 GAS_proportional_get_preferred_address (void *solver,
1070                                         const struct GNUNET_PeerIdentity *peer)
1071 {
1072   struct GAS_PROPORTIONAL_Handle *s = solver;
1073   struct ATS_Address *best_address;
1074   struct AddressWrapper *asi;
1075
1076   best_address = update_active_address (s,
1077                                         get_active_address (s,
1078                                                             peer),
1079                                         peer);
1080   if (NULL == best_address)
1081     return;
1082   if (s->bulk_lock > 0)
1083     return;
1084   asi = best_address->solver_information;
1085   distribute_bandwidth_in_network (s,
1086                                    asi->network);
1087 }
1088
1089
1090 /**
1091  * Stop notifying about address and bandwidth changes for this peer
1092  *
1093  * @param solver the solver handle
1094  * @param peer the peer
1095  */
1096 static void
1097 GAS_proportional_stop_get_preferred_address (void *solver,
1098                                              const struct GNUNET_PeerIdentity *peer)
1099 {
1100   struct GAS_PROPORTIONAL_Handle *s = solver;
1101   struct ATS_Address *cur;
1102   struct AddressWrapper *asi;
1103
1104   cur = get_active_address (s,
1105                             peer);
1106   if (NULL == cur)
1107     return;
1108   asi = cur->solver_information;
1109   distribute_bandwidth_in_network (s,
1110                                    asi->network);
1111 }
1112
1113
1114 /**
1115  * Start a bulk operation
1116  *
1117  * @param solver the solver
1118  */
1119 static void
1120 GAS_proportional_bulk_start (void *solver)
1121 {
1122   struct GAS_PROPORTIONAL_Handle *s = solver;
1123
1124   LOG (GNUNET_ERROR_TYPE_DEBUG,
1125        "Locking solver for bulk operation ...\n");
1126   GNUNET_assert (NULL != solver);
1127   s->bulk_lock++;
1128 }
1129
1130
1131 /**
1132  * Bulk operation done.
1133  *
1134  * @param solver our `struct GAS_PROPORTIONAL_Handle *`
1135  */
1136 static void
1137 GAS_proportional_bulk_stop (void *solver)
1138 {
1139   struct GAS_PROPORTIONAL_Handle *s = solver;
1140
1141   LOG (GNUNET_ERROR_TYPE_DEBUG,
1142        "Unlocking solver from bulk operation ...\n");
1143   if (s->bulk_lock < 1)
1144   {
1145     GNUNET_break(0);
1146     return;
1147   }
1148   s->bulk_lock--;
1149   if ( (0 == s->bulk_lock) &&
1150        (0 < s->bulk_requests) )
1151   {
1152     LOG (GNUNET_ERROR_TYPE_INFO,
1153          "No lock pending, recalculating\n");
1154     distribute_bandwidth_in_network (s,
1155                                      NULL);
1156     s->bulk_requests = 0;
1157   }
1158 }
1159
1160
1161 /**
1162  * Transport properties for this address have changed
1163  *
1164  * @param solver solver handle
1165  * @param address the address
1166  * @param type the ATSI type in HBO
1167  * @param abs_value the absolute value of the property
1168  * @param rel_value the normalized value
1169  */
1170 static void
1171 GAS_proportional_address_property_changed (void *solver,
1172                                            struct ATS_Address *address,
1173                                            enum GNUNET_ATS_Property type,
1174                                            uint32_t abs_value,
1175                                            double rel_value)
1176 {
1177   struct GAS_PROPORTIONAL_Handle *s = solver;
1178   struct AddressWrapper *asi = address->solver_information;
1179
1180   distribute_bandwidth_in_network (s,
1181                                    asi->network);
1182 }
1183
1184
1185 /**
1186  * Add a new single address to a network
1187  *
1188  * @param solver the solver Handle
1189  * @param address the address to add
1190  * @param network network type of this address
1191  */
1192 static void
1193 GAS_proportional_address_add (void *solver,
1194                               struct ATS_Address *address,
1195                               enum GNUNET_ATS_Network_Type network)
1196 {
1197   struct GAS_PROPORTIONAL_Handle *s = solver;
1198   struct Network *net;
1199   struct AddressWrapper *aw;
1200
1201   GNUNET_assert (network < s->env->network_count);
1202   net = &s->network_entries[network];
1203   net->total_addresses++;
1204
1205   aw = GNUNET_new (struct AddressWrapper);
1206   aw->addr = address;
1207   aw->network = net;
1208   address->solver_information = aw;
1209   GNUNET_CONTAINER_DLL_insert (net->head,
1210                                net->tail,
1211                                aw);
1212   GNUNET_STATISTICS_update (s->env->stats,
1213                             "# ATS addresses total",
1214                             1,
1215                             GNUNET_NO);
1216   GNUNET_STATISTICS_update (s->env->stats,
1217                             net->stat_total,
1218                             1,
1219                             GNUNET_NO);
1220
1221   if (0 !=
1222       s->env->get_connectivity (s->env->cls,
1223                                 &address->peer))
1224   {
1225     /* This peer is requested, find best address */
1226     update_active_address (s,
1227                            get_active_address (s,
1228                                                &address->peer),
1229                            &address->peer);
1230   }
1231   LOG (GNUNET_ERROR_TYPE_INFO,
1232        "Added new address for `%s', now total %u and active %u addresses in network `%s'\n",
1233        GNUNET_i2s (&address->peer),
1234        net->total_addresses,
1235        net->active_addresses,
1236        net->desc);
1237
1238
1239 }
1240
1241
1242 /**
1243  * Remove an address from the solver. To do so, we:
1244  * - Removed it from specific network
1245  * - Decrease the number of total addresses
1246  * - If active:
1247  *   - decrease number of active addreses
1248  *   - update quotas
1249  *
1250  * @param solver the solver handle
1251  * @param address the address to remove
1252  */
1253 static void
1254 GAS_proportional_address_delete (void *solver,
1255                                  struct ATS_Address *address)
1256 {
1257   struct GAS_PROPORTIONAL_Handle *s = solver;
1258   struct AddressWrapper *aw = address->solver_information;
1259   struct Network *net = aw->network;
1260
1261   LOG (GNUNET_ERROR_TYPE_DEBUG,
1262        "Deleting %s address for peer `%s' from network `%s' (total: %u/active: %u)\n",
1263        (GNUNET_NO == address->active) ? "inactive" : "active",
1264        GNUNET_i2s (&address->peer),
1265        net->desc,
1266        net->total_addresses,
1267        net->active_addresses);
1268
1269   GNUNET_CONTAINER_DLL_remove (net->head,
1270                                net->tail,
1271                                aw);
1272   GNUNET_assert (net->total_addresses > 0);
1273   net->total_addresses--;
1274   GNUNET_STATISTICS_update (s->env->stats,
1275                             net->stat_total,
1276                             -1,
1277                             GNUNET_NO);
1278   if (GNUNET_YES == address->active)
1279   {
1280     /* Address was active, remove from network and update quotas*/
1281     address->assigned_bw_in = 0;
1282     address->assigned_bw_out = 0;
1283     if (NULL ==
1284         update_active_address (s,
1285                                address,
1286                                &address->peer))
1287     {
1288       /* No alternative address found, disconnect peer */
1289       LOG (GNUNET_ERROR_TYPE_INFO,
1290            "Disconnecting peer `%s' after deleting previous address %p\n",
1291            GNUNET_i2s (&address->peer),
1292            address);
1293       s->env->bandwidth_changed_cb (s->env->cls,
1294                                     address);
1295     }
1296     distribute_bandwidth_in_network (s, net);
1297   }
1298   GNUNET_free (aw);
1299   address->solver_information = NULL;
1300   LOG (GNUNET_ERROR_TYPE_DEBUG,
1301        "After deleting address now total %u and active %u addresses in network `%s'\n",
1302        net->total_addresses,
1303        net->active_addresses,
1304        net->desc);
1305 }
1306
1307
1308 /**
1309  * Function invoked when the plugin is loaded.
1310  *
1311  * @param[in,out] cls the `struct GNUNET_ATS_PluginEnvironment *` to use;
1312  *            modified to return the API functions (ugh).
1313  * @return the `struct GAS_PROPORTIONAL_Handle` to pass as a closure
1314  */
1315 void *
1316 libgnunet_plugin_ats_proportional_init (void *cls)
1317 {
1318   static struct GNUNET_ATS_SolverFunctions sf;
1319   struct GNUNET_ATS_PluginEnvironment *env = cls;
1320   struct GAS_PROPORTIONAL_Handle *s;
1321   struct Network * cur;
1322   float f_tmp;
1323   unsigned int c;
1324
1325   s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
1326   s->env = env;
1327   sf.cls = s;
1328   sf.s_add = &GAS_proportional_address_add;
1329   sf.s_address_update_property = &GAS_proportional_address_property_changed;
1330   sf.s_get = &GAS_proportional_get_preferred_address;
1331   sf.s_get_stop = &GAS_proportional_stop_get_preferred_address;
1332   sf.s_pref = &GAS_proportional_address_change_preference;
1333   sf.s_feedback = &GAS_proportional_address_preference_feedback;
1334   sf.s_del = &GAS_proportional_address_delete;
1335   sf.s_bulk_start = &GAS_proportional_bulk_start;
1336   sf.s_bulk_stop = &GAS_proportional_bulk_stop;
1337   s->stability_factor = PROP_STABILITY_FACTOR;
1338   if (GNUNET_SYSERR !=
1339       GNUNET_CONFIGURATION_get_value_float (env->cfg,
1340                                             "ats",
1341                                             "PROP_STABILITY_FACTOR",
1342                                             &f_tmp))
1343   {
1344     if ((f_tmp < 1.0) || (f_tmp > 2.0))
1345     {
1346       LOG (GNUNET_ERROR_TYPE_ERROR,
1347            _("Invalid %s configuration %f \n"),
1348            "PROP_STABILITY_FACTOR",
1349            f_tmp);
1350     }
1351     else
1352     {
1353       s->stability_factor = f_tmp;
1354       LOG (GNUNET_ERROR_TYPE_INFO,
1355            "Using %s of %.3f\n",
1356            "PROP_STABILITY_FACTOR",
1357            f_tmp);
1358     }
1359   }
1360   s->prop_factor = PROPORTIONALITY_FACTOR;
1361   if (GNUNET_SYSERR !=
1362       GNUNET_CONFIGURATION_get_value_float (env->cfg,
1363                                             "ats",
1364                                             "PROP_PROPORTIONALITY_FACTOR",
1365                                             &f_tmp))
1366   {
1367     if (f_tmp < 1.0)
1368     {
1369       LOG (GNUNET_ERROR_TYPE_ERROR,
1370            _("Invalid %s configuration %f\n"),
1371            "PROP_PROPORTIONALITY_FACTOR",
1372            f_tmp);
1373     }
1374     else
1375     {
1376       s->prop_factor = f_tmp;
1377       LOG (GNUNET_ERROR_TYPE_INFO,
1378            "Using %s of %.3f\n",
1379            "PROP_PROPORTIONALITY_FACTOR",
1380            f_tmp);
1381     }
1382   }
1383
1384   s->network_entries = GNUNET_malloc (env->network_count *
1385                                       sizeof (struct Network));
1386   for (c = 0; c < env->network_count; c++)
1387   {
1388     cur = &s->network_entries[c];
1389     cur->type = c;
1390     cur->total_quota_in = env->in_quota[c];
1391     cur->total_quota_out = env->out_quota[c];
1392     cur->desc = GNUNET_ATS_print_network_type (c);
1393     GNUNET_asprintf (&cur->stat_total,
1394                      "# ATS addresses %s total",
1395                      cur->desc);
1396     GNUNET_asprintf (&cur->stat_active,
1397                      "# ATS active addresses %s total",
1398                      cur->desc);
1399     LOG (GNUNET_ERROR_TYPE_INFO,
1400          "Added network %u `%s' (%llu/%llu)\n",
1401          c,
1402          cur->desc,
1403          cur->total_quota_in,
1404          cur->total_quota_out);
1405   }
1406   return &sf;
1407 }
1408
1409
1410 /**
1411  * Function used to unload the plugin.
1412  *
1413  * @param cls return value from #libgnunet_plugin_ats_proportional_init()
1414  */
1415 void *
1416 libgnunet_plugin_ats_proportional_done (void *cls)
1417 {
1418   struct GNUNET_ATS_SolverFunctions *sf = cls;
1419   struct GAS_PROPORTIONAL_Handle *s = sf->cls;
1420   struct AddressWrapper *cur;
1421   struct AddressWrapper *next;
1422   unsigned int c;
1423
1424   for (c = 0; c < s->network_count; c++)
1425   {
1426     GNUNET_break (0 == s->network_entries[c].total_addresses);
1427     GNUNET_break (0 == s->network_entries[c].active_addresses);
1428     next = s->network_entries[c].head;
1429     while (NULL != (cur = next))
1430     {
1431       next = cur->next;
1432       GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1433                                    s->network_entries[c].tail,
1434                                    cur);
1435       GNUNET_free_non_null (cur->addr->solver_information);
1436       GNUNET_free(cur);
1437     }
1438     GNUNET_free (s->network_entries[c].stat_total);
1439     GNUNET_free (s->network_entries[c].stat_active);
1440   }
1441   GNUNET_break (0 == s->active_addresses);
1442   GNUNET_free (s->network_entries);
1443   GNUNET_free (s);
1444   return NULL;
1445 }
1446
1447
1448 /* end of plugin_ats_proportional.c */