proportional solver uses normalizationy
[oweals/gnunet.git] / src / ats / gnunet-service-ats-solver_proportional.c
1 /*
2      This file is part of GNUnet.
3      (C) 2011 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/gnunet-service-ats-solver_proportional.c
23  * @brief ATS proportional solver
24  * @author Matthias Wachs
25  * @author Christian Grothoff
26  */
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet-service-ats_addresses.h"
30 #include "gnunet-service-ats_normalization.h"
31 #include "gnunet_statistics_service.h"
32
33 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
34
35 /**
36  *
37  * NOTE: Do not change this documentation. This documentation is based
38  * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
39  * use build_txt.sh to generate plaintext output
40  *
41  * ATS addresses : simplistic solver
42  *
43  *    The simplistic solver ("simplistic") distributes the available
44  *    bandwidth fair over all the addresses influenced by the
45  *    preference values. For each available network type an in- and
46  *    outbound quota is configured and the bandwidth available in
47  *    these networks is distributed over the addresses.  The solver
48  *    first assigns every addresses the minimum amount of bandwidth
49  *    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
50  *    remaining bandwidth available according to the preference
51  *    values. For each peer only a single address gets bandwidth
52  *    assigned and only one address marked as active.  The most
53  *    important functionality for the solver is implemented in: *
54  *    find_address_it is an hashmap iterator returning the prefered
55  *    address for an peer * update_quota_per_network distributes
56  *    available bandwidth for a network over active addresses
57  *
58  *    Changes to addresses automatically have an impact on the the
59  *    bandwidth assigned to other addresses in the same network since
60  *    the solver distributes the remaining bandwidth over the
61  *    addresses in the network.  When changes to the addresses occur,
62  *    the solver first performs the changes, like adding or deleting
63  *    addresses, and then updates bandwidth assignment for the
64  *    affected network. Bandwidth assignment is only recalculated on
65  *    demand when an address is requested by a client for a peer or
66  *    when the addresses available have changed or an address changed
67  *    the network it is located in. When the bandwidth assignment has
68  *    changed the callback is called with the new bandwidth
69  *    assignments. The bandwidth distribution for a network is
70  *    recalculated due to: * address suggestion requests * address
71  *    deletions * address switching networks during address update *
72  *    preference changes
73  *
74  *     3.1 Data structures used
75  *
76  *    For each ATS network (e.g. WAN, LAN, loopback) a struct Network
77  *    is used to specify network related information as total adresses
78  *    and active addresses in this network and the configured in- and
79  *    outbound quota. Each network also contains a list of addresses
80  *    added to the solver located in this network. The simplistic
81  *    solver uses the addresses' solver_information field to store the
82  *    simplistic network it belongs to for each address.
83  *
84  *     3.2 Initializing
85  *
86  *    When the simplistic solver is initialized the solver creates a
87  *    new solver handle and initializes the network structures with
88  *    the quotas passed from addresses and returns the handle solver.
89  *
90  *     3.3 Adding an address
91  *
92  *    When a new address is added to the solver using s_add, a lookup
93  *    for the network for this address is done and the address is
94  *    enqueued in in the linked list of the network.
95  *
96  *     3.4 Updating an address
97  *
98  *    The main purpose of address updates is to update the ATS
99  *    information for addresse selection. Important for the simplistic
100  *    solver is when an address switches network it is located
101  *    in. This is common because addresses added by transport's
102  *    validation mechanism are commonly located in
103  *    GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
104  *    in this network type and only if a connection is successful on
105  *    return of payload data transport switches to the real network
106  *    the address is located in.  When an address changes networks it
107  *    is first of all removed from the old network using the solver
108  *    API function GAS_simplistic_address_delete and the network in
109  *    the address struct is updated. A lookup for the respective new
110  *    simplistic network is done and stored in the addresse's
111  *    solver_information field. Next the address is re-added to the
112  *    solver using the solver API function
113  *    GAS_simplistic_address_add. If the address was marked as in
114  *    active, the solver checks if bandwidth is available in the
115  *    network and if yes sets the address to active and updates the
116  *    bandwidth distribution in this network. If no bandwidth is
117  *    available it sets the bandwidth for this address to 0 and tries
118  *    to suggest an alternative address. If an alternative address was
119  *    found, addresses' callback is called for this address.
120  *
121  *     3.5 Deleting an address
122  *
123  *    When an address is removed from the solver, it removes the
124  *    respective address from the network and if the address was
125  *    marked as active, it updates the bandwidth distribution for this
126  *    network.
127  *
128  *     3.6 Requesting addresses
129  *
130  *    When an address is requested for a peer the solver performs a
131  *    lookup for the peer entry in addresses address hashmap and
132  *    selects the best address.  The selection of the most suitable
133  *    address is done in the find_address_it hashmap iterator
134  *    described in detail in section 3.7. If no address is returned,
135  *    no address can be suggested at the moment. If the address
136  *    returned is marked as active, the solver can return this
137  *    address. If the address is not marked as active, the solver
138  *    checks if another address belongign to this peer is marked as
139  *    active and marks the address as inactive, updates the bandwidth
140  *    for this address to 0, call the bandwidth changed callback for
141  *    this address due to the change and updates quota assignment for
142  *    the addresse's network. the now in-active address is belonging
143  *    to. The solver marks the new address as active and updates the
144  *    bandwidth assignment for this network.
145  *
146  *     3.7 Choosing addresses
147  *
148  *    Choosing the best possible address for suggestion is done by
149  *    iterating over all addresses of a peer stored in addresses'
150  *    hashmap and using the hashmap iterator find_address_it to select
151  *    the best available address.  Several checks are done when an
152  *    address is selected. First if this address is currently blocked
153  *    by addresses from being suggested. An address is blocked for the
154  *    duration of ATS_BLOCKING_DELTA when it is suggested to
155  *    transport. Next it is checked if at least
156  *    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
157  *    in the addresse's network, because suggesting an address without
158  *    bandwidth does not make sense. This also ensures that all active
159  *    addresses in this network get at least the minimum amount of
160  *    bandwidth assigned. In the next step the solver ensures that for
161  *    tcp connections inbound connections are prefered over outbound
162  *    connections. In the next stet the solver ensures that
163  *    connections are prefered in the following order: * connections
164  *    are already established and have bandwidth assigned *
165  *    connections with a shorter distance * connectes have a shorter
166  *    latency
167  *
168  *     3.8 Changing preferences
169  *
170  *     3.9 Shutdown
171  *
172  *    During shutdown all network entries and aging processes are
173  *    destroyed and freed.
174  *
175  *
176  * OLD DOCUMENTATION
177  *
178  * This solver assigns in and outbound bandwidth equally for all
179  * addresses in specific network type (WAN, LAN) based on configured
180  * in and outbound quota for this network.
181  *
182  * The solver is notified by addresses about changes to the addresses
183  * and recalculates the bandwith assigned if required. The solver
184  * notifies addresses by calling the GAS_bandwidth_changed_cb
185  * callback.
186  *
187  * - Initialization
188  *
189  *
190  *
191  *
192  * For each peer only a single is selected and marked as "active" in the address
193  * struct.
194  *
195  * E.g.:
196  *
197  * You have the networks WAN and LAN and quotas
198  * WAN_TOTAL_IN, WAN_TOTAL_OUT
199  * LAN_TOTAL_IN, LAN_TOTAL_OUT
200  *
201  * If you have x addresses in the network segment LAN, the quotas are
202  * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
203  *
204  * Quotas are automatically recalculated and reported back when addresses are
205  * - requested
206  *
207  */
208
209 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
210 #define PREF_AGING_FACTOR 0.95
211
212 #define DEFAULT_REL_PREFERENCE 1.0
213 #define DEFAULT_ABS_PREFERENCE 0.0
214 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
215
216
217 /**
218  * A handle for the proportional solver
219  */
220 struct GAS_PROPORTIONAL_Handle
221 {
222   /**
223    * Statistics handle
224    */
225
226   struct GNUNET_STATISTICS_Handle *stats;
227
228   /**
229    * Total number of addresses for solver
230    */
231   unsigned int total_addresses;
232
233   /**
234    * Number of active addresses for solver
235    */
236   unsigned int active_addresses;
237
238   /**
239    * Networks array
240    */
241   struct Network *network_entries;
242
243   /**
244    * Number of networks
245    */
246   unsigned int networks;
247
248   /**
249    * Callback
250    */
251   GAS_bandwidth_changed_cb bw_changed;
252
253   /**
254    * Callback cls
255    */
256   void *bw_changed_cls;
257
258   struct GNUNET_CONTAINER_MultiHashMap *prefs;
259
260   struct PreferenceClient *pc_head;
261   struct PreferenceClient *pc_tail;
262 };
263
264
265 /**
266  * Representation of a network
267  */
268 struct Network
269 {
270   /**
271    * ATS network type
272    */
273   unsigned int type;
274
275   /**
276    * Network description
277    */
278   char *desc;
279
280   /**
281    * Total inbound quota
282    *
283    */
284   unsigned long long total_quota_in;
285
286   /**
287    * Total outbound quota
288    *
289    */
290   unsigned long long total_quota_out;
291
292   /**
293    * Number of active addresses for this network
294    */
295   unsigned int active_addresses;
296
297   /**
298    * Number of total addresses for this network
299    */
300   unsigned int total_addresses;
301
302   /**
303    * String for statistics total addresses
304    */
305   char *stat_total;
306
307   /**
308    * String for statistics active addresses
309    */
310   char *stat_active;
311
312   struct AddressWrapper *head;
313   struct AddressWrapper *tail;
314 };
315
316
317 /**
318  * Wrapper for addresses to store them in network's linked list
319  */
320 struct AddressWrapper
321 {
322   /**
323    * Next in DLL
324    */
325   struct AddressWrapper *next;
326
327   /**
328    * Previous in DLL
329    */
330   struct AddressWrapper *prev;
331
332   /**
333    * The address
334    */
335   struct ATS_Address *addr;
336 };
337
338
339
340 /**
341  *  Important solver functions
342  *  ---------------------------
343  */
344
345 /**
346  * Test if bandwidth is available in this network to add an additional address
347  *
348  * @param net the network type to update
349  * @return GNUNET_YES or GNUNET_NO
350  */
351 static int
352 is_bandwidth_available_in_network (struct Network *net)
353 {
354   unsigned int na = net->active_addresses + 1;
355   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
356   if (((net->total_quota_in / na) > min_bw) &&
357       ((net->total_quota_out / na) > min_bw))
358   {
359     LOG (GNUNET_ERROR_TYPE_DEBUG,
360          "Enough bandwidth available for %u active addresses in network `%s'\n",
361          na,
362          net->desc);
363
364     return GNUNET_YES;
365   }
366     LOG (GNUNET_ERROR_TYPE_DEBUG,
367          "Not enough bandwidth available for %u active addresses in network `%s'\n",
368          na,
369          net->desc);
370   return GNUNET_NO;
371 }
372
373
374 /**
375  * Update bandwidth assigned to peers in this network
376  *
377  * @param s the solver handle
378  * @param net the network type to update
379  * @param address_except address excluded from notification, since we suggest
380  * this address
381  */
382 static void
383 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
384                           struct Network *net,
385                           struct ATS_Address *address_except)
386 {
387   unsigned long long remaining_quota_in = 0;
388   unsigned long long quota_out_used = 0;
389
390   unsigned long long remaining_quota_out = 0;
391   unsigned long long quota_in_used = 0;
392   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
393   double peer_prefs;
394   double total_prefs; /* Important: has to be double not float due to precision */
395   double cur_pref; /* Important: has to be double not float due to precision */
396   const double *t = NULL; /* Important: has to be double not float due to precision */
397   int c;
398
399   unsigned long long assigned_quota_in = 0;
400   unsigned long long assigned_quota_out = 0;
401   struct AddressWrapper *cur;
402
403   LOG (GNUNET_ERROR_TYPE_DEBUG,
404               "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
405               net->desc, net->active_addresses, net->total_quota_in, net->total_quota_in);
406
407   if (net->active_addresses == 0)
408     return; /* no addresses to update */
409
410   /* Idea
411    * Assign every peer in network minimum Bandwidth
412    * Distribute bandwidth left according to preference
413    */
414
415   if ((net->active_addresses * min_bw) > net->total_quota_in)
416   {
417     GNUNET_break (0);
418     return;
419   }
420   if ((net->active_addresses * min_bw) > net->total_quota_out)
421   {
422     GNUNET_break (0);
423     return;
424   }
425
426   remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
427   remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
428   LOG (GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
429               remaining_quota_in, remaining_quota_out);
430   total_prefs = 0.0;
431   for (cur = net->head; NULL != cur; cur = cur->next)
432   {
433       if (GNUNET_YES == cur->addr->active)
434       {
435         t = GAS_normalization_get_preferences (&cur->addr->peer);
436         if (NULL == t)
437                 total_prefs += DEFAULT_REL_PREFERENCE;
438         else
439         {
440                 peer_prefs = 0.0;
441                 for (c = 1; c < GNUNET_ATS_PreferenceCount; c++)
442                         peer_prefs += t[c];
443                 total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount -1));
444         }
445       }
446   }
447   for (cur = net->head; NULL != cur; cur = cur->next)
448   {
449      if (GNUNET_YES == cur->addr->active)
450      {
451        cur_pref = 0.0;
452        t = GAS_normalization_get_preferences (&cur->addr->peer);
453        if (NULL != t)
454        {
455          for (c = 1; c < GNUNET_ATS_PreferenceCount; c++)
456                  cur_pref += t[c];
457          cur_pref /= 2;
458        }
459        else
460          cur_pref = DEFAULT_REL_PREFERENCE;
461
462        assigned_quota_in = min_bw + ((cur_pref / total_prefs) * remaining_quota_in);
463        assigned_quota_out = min_bw + ((cur_pref / total_prefs) * remaining_quota_out);
464
465        LOG (GNUNET_ERROR_TYPE_DEBUG,
466                    "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
467                    GNUNET_i2s (&cur->addr->peer),
468                    cur_pref, total_prefs,
469                    assigned_quota_in, assigned_quota_out);
470      }
471      else
472      {
473        assigned_quota_in = 0;
474        assigned_quota_out = 0;
475      }
476
477      quota_in_used += assigned_quota_in;
478      quota_out_used += assigned_quota_out;
479      /* Prevent overflow due to rounding errors */
480      if (assigned_quota_in > UINT32_MAX)
481        assigned_quota_in = UINT32_MAX;
482      if (assigned_quota_out > UINT32_MAX)
483        assigned_quota_out = UINT32_MAX;
484
485      /* Compare to current bandwidth assigned */
486      if ((assigned_quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
487          (assigned_quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
488      {
489        cur->addr->assigned_bw_in.value__ = htonl (assigned_quota_in);
490        cur->addr->assigned_bw_out.value__ = htonl (assigned_quota_out);
491        /* Notify on change */
492        if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
493          s->bw_changed (s->bw_changed_cls, cur->addr);
494      }
495
496   }
497   LOG (GNUNET_ERROR_TYPE_DEBUG,
498                           "Total bandwidth assigned is (in/out): %llu /%llu\n",
499                           quota_in_used,
500                           quota_out_used);
501   if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
502   {
503       LOG (GNUNET_ERROR_TYPE_ERROR,
504                             "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
505                             net->active_addresses,
506                             quota_out_used,
507                             net->total_quota_out);
508   }
509   if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
510   {
511       LOG (GNUNET_ERROR_TYPE_ERROR,
512                             "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
513                             net->active_addresses,
514                             quota_in_used,
515                             net->total_quota_in);
516   }
517 }
518
519
520 /**
521  * Extract an ATS performance info from an address
522  *
523  * @param address the address
524  * @param type the type to extract in HBO
525  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
526  */
527 static int
528 get_performance_info (struct ATS_Address *address, uint32_t type);
529
530 /**
531  * Find a "good" address to use for a peer by iterating over the addresses for this peer.
532  * If we already have an existing address, we stick to it.
533  * Otherwise, we pick by lowest distance and then by lowest latency.
534  *
535  * @param cls the 'struct ATS_Address**' where we store the result
536  * @param key unused
537  * @param value another 'struct ATS_Address*' to consider using
538  * @return GNUNET_OK (continue to iterate)
539  */
540 static int
541 find_best_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
542 {
543   struct ATS_Address **previous_p = cls;
544   struct ATS_Address *current = (struct ATS_Address *) value;
545   struct ATS_Address *previous = *previous_p;
546   struct GNUNET_TIME_Absolute now;
547   struct Network *net = (struct Network *) current->solver_information;
548   uint32_t p_distance_cur;
549   uint32_t p_distance_prev;
550   uint32_t p_delay_cur;
551   uint32_t p_delay_prev;
552
553   now = GNUNET_TIME_absolute_get();
554
555   if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
556   {
557     /* This address is blocked for suggestion */
558     LOG (GNUNET_ERROR_TYPE_DEBUG,
559                 "Address %p blocked for suggestion for %llu ms \n",
560                 current,
561                 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
562     return GNUNET_OK;
563   }
564
565   if (GNUNET_NO == is_bandwidth_available_in_network (net))
566     return GNUNET_OK; /* There's no bandwidth available in this network */
567
568   if (NULL != previous)
569   {
570         GNUNET_assert (NULL != previous->plugin);
571         GNUNET_assert (NULL != current->plugin);
572     if (0 == strcmp (previous->plugin, current->plugin))
573     {
574       if ((0 != previous->addr_len) &&
575           (0 == current->addr_len))
576       {
577         /* saved address was an outbound address, but we have an inbound address */
578         *previous_p = current;
579         return GNUNET_OK;
580       }
581       if (0 == previous->addr_len)
582       {
583         /* saved address was an inbound address, so do not overwrite */
584         return GNUNET_OK;
585       }
586     }
587   }
588
589   if (NULL == previous)
590   {
591     *previous_p = current;
592     return GNUNET_OK;
593   }
594   if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
595       (ntohl (current->assigned_bw_in.value__) > 0))
596   {
597     /* stick to existing connection */
598     *previous_p = current;
599     return GNUNET_OK;
600   }
601
602   p_distance_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DISTANCE);
603   p_distance_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DISTANCE);
604   if ((p_distance_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_distance_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
605                 (p_distance_prev > p_distance_cur))
606   {
607     /* user shorter distance */
608     *previous_p = current;
609     return GNUNET_OK;
610   }
611
612   p_delay_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DELAY);
613   p_delay_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DELAY);
614   if ((p_delay_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_delay_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
615                 (p_delay_prev > p_delay_cur))
616   {
617     /* user lower latency */
618     *previous_p = current;
619     return GNUNET_OK;
620   }
621
622   /* don't care */
623   return GNUNET_OK;
624 }
625
626 /**
627  *  Helper functions
628  *  ---------------------------
629  */
630
631 /**
632  * Update bandwidth assignment for all networks
633  *
634  * @param s the solver handle
635  */
636 static void
637 distribute_bandwidth_in_all_networks (struct GAS_PROPORTIONAL_Handle *s)
638 {
639         int i;
640         for (i = 0; i < s->networks; i++)
641                 distribute_bandwidth_in_network (s, &s->network_entries[i], NULL);
642
643 }
644
645
646 /**
647  * Lookup network struct by type
648  *
649  * @param s the solver handle
650  * @param type the network type
651  * @return the network struct
652  */
653 static struct Network *
654 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
655 {
656   int c;
657   for (c = 0 ; c < s->networks; c++)
658   {
659       if (s->network_entries[c].type == type)
660         return &s->network_entries[c];
661   }
662   return NULL;
663 }
664
665
666 /**
667  * Hashmap Iterator to find current active address for peer
668  *
669  * @param cls last active address
670  * @param key peer's key
671  * @param value address to check
672  * @return GNUNET_NO on double active address else GNUNET_YES
673  */
674 static int
675 get_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
676 {
677   struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
678   struct ATS_Address * aa = (struct ATS_Address *) value;
679
680   if (GNUNET_YES == aa->active)
681   {
682       if (dest != NULL)
683       {
684           /* should never happen */
685           LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
686           GNUNET_break (0);
687           return GNUNET_NO;
688       }
689       dest = aa;
690   }
691   return GNUNET_OK;
692 }
693
694
695 /**
696  * Find current active address for peer
697  *
698  * @param solver the solver handle
699  * @param addresses the address set
700  * @param peer the peer
701  * @return active address or NULL
702  */
703 static struct ATS_Address *
704 get_active_address (void *solver,
705                      struct GNUNET_CONTAINER_MultiHashMap * addresses,
706                      const struct GNUNET_PeerIdentity *peer)
707 {
708   struct ATS_Address * dest = NULL;
709
710   GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
711        &peer->hashPubKey,
712        &get_active_address_it, &dest);
713   return dest;
714 }
715
716
717
718 static void
719 addresse_increment (struct GAS_PROPORTIONAL_Handle *s,
720                                 struct Network *net,
721                                 int total,
722                                 int active)
723 {
724   if (GNUNET_YES == total)
725   {
726       s->total_addresses ++;
727       net->total_addresses ++;
728       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
729       GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
730   }
731   if (GNUNET_YES == active)
732   {
733     net->active_addresses ++;
734     s->active_addresses ++;
735     GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
736     GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
737   }
738
739 }
740
741
742 static int
743 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
744                     struct Network *net,
745                     int total,
746                     int active)
747 {
748   int res = GNUNET_OK;
749   if (GNUNET_YES == total)
750   {
751     if (s->total_addresses < 1)
752     {
753       GNUNET_break (0);
754       res = GNUNET_SYSERR;
755     }
756     else
757     {
758       s->total_addresses --;
759       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
760     }
761     if (net->total_addresses < 1)
762     {
763       GNUNET_break (0);
764       res = GNUNET_SYSERR;
765     }
766     else
767     {
768       net->total_addresses --;
769       GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
770     }
771   }
772
773   if (GNUNET_YES == active)
774   {
775     if (net->active_addresses < 1)
776     {
777       GNUNET_break (0);
778       res = GNUNET_SYSERR;
779     }
780     else
781     {
782       net->active_addresses --;
783       GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
784     }
785     if (s->active_addresses < 1)
786     {
787       GNUNET_break (0);
788       res = GNUNET_SYSERR;
789     }
790     else
791     {
792       s->active_addresses --;
793       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
794     }
795   }
796   return res;
797 }
798
799
800 /**
801  * Extract an ATS performance info from an address
802  *
803  * @param address the address
804  * @param type the type to extract in HBO
805  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
806  */
807 static int
808 get_performance_info (struct ATS_Address *address, uint32_t type)
809 {
810         int c1;
811         GNUNET_assert (NULL != address);
812
813         if ((NULL == address->atsi) || (0 == address->atsi_count))
814                         return GNUNET_ATS_VALUE_UNDEFINED;
815
816         for (c1 = 0; c1 < address->atsi_count; c1++)
817         {
818                         if (ntohl(address->atsi[c1].type) == type)
819                                 return ntohl(address->atsi[c1].value);
820         }
821         return GNUNET_ATS_VALUE_UNDEFINED;
822 }
823
824
825 /**
826  *  Solver API functions
827  *  ---------------------------
828  */
829
830 /**
831  * Changes the preferences for a peer in the problem
832  *
833  * @param solver the solver handle
834  * @param client the client with this preference
835  * @param peer the peer to change the preference for
836  * @param kind the kind to change the preference
837  * @param pref_rel the normalized preference value for this kind over all clients
838  * @param score the score
839  */
840 void
841 GAS_proportional_address_change_preference (void *solver,
842                                                                   void *client,
843                                                                   const struct GNUNET_PeerIdentity *peer,
844                                                                   enum GNUNET_ATS_PreferenceKind kind,
845                                                                   float score_abs,
846                                                                   double pref_rel)
847 {
848   struct GAS_PROPORTIONAL_Handle *s = solver;
849   GNUNET_assert (NULL != solver);
850   GNUNET_assert (NULL != client);
851   GNUNET_assert (NULL != peer);
852
853   distribute_bandwidth_in_all_networks (s);
854
855 }
856
857 /**
858  * Get the preferred address for a specific peer
859  *
860  * @param solver the solver handle
861  * @param addresses the address hashmap containing all addresses
862  * @param peer the identity of the peer
863  */
864 const struct ATS_Address *
865 GAS_proportional_get_preferred_address (void *solver,
866                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
867                                const struct GNUNET_PeerIdentity *peer)
868 {
869   struct GAS_PROPORTIONAL_Handle *s = solver;
870   struct Network *net_prev;
871   struct Network *net_cur;
872   struct ATS_Address *cur;
873   struct ATS_Address *prev;
874
875   GNUNET_assert (s != NULL);
876   cur = NULL;
877   /* Get address with: stick to current address, lower distance, lower latency */
878   GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
879                                               &find_best_address_it, &cur);
880   if (NULL == cur)
881   {
882     LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
883     return NULL;
884   }
885
886   LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
887       (GNUNET_NO == cur->active) ? "inactive" : "active",
888       cur, GNUNET_i2s (peer));
889   net_cur = (struct Network *) cur->solver_information;
890   if (GNUNET_YES == cur->active)
891   {
892       /* This address was selected previously, so no need to update quotas */
893       return cur;
894   }
895
896   /* This address was not active, so we have to:
897    *
898    * - mark previous active address as not active
899    * - update quota for previous address network
900    * - update quota for this address network
901    */
902
903   prev = get_active_address (s, addresses, peer);
904   if (NULL != prev)
905   {
906       net_prev = (struct Network *) prev->solver_information;
907       prev->active = GNUNET_NO; /* No active any longer */
908       prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
909       prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
910       s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
911       if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
912         GNUNET_break (0);
913       distribute_bandwidth_in_network (s, net_prev, NULL);
914   }
915
916   if (GNUNET_NO == (is_bandwidth_available_in_network (cur->solver_information)))
917   {
918     GNUNET_break (0); /* This should never happen*/
919     return NULL;
920   }
921
922   cur->active = GNUNET_YES;
923   addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
924   distribute_bandwidth_in_network (s, net_cur, cur);
925
926   return cur;
927 }
928
929
930 /**
931  * Stop notifying about address and bandwidth changes for this peer
932  *
933  * @param solver the solver handle
934  * @param addresses address hashmap
935  * @param peer the peer
936  */
937 void
938 GAS_proportional_stop_get_preferred_address (void *solver,
939                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
940                                      const struct GNUNET_PeerIdentity *peer)
941 {
942         return;
943 }
944
945
946 /**
947  * Remove an address from the solver
948  *
949  * @param solver the solver handle
950  * @param addresses the address hashmap containing all addresses
951  * @param address the address to remove
952  * @param session_only delete only session not whole address
953  */
954 void
955 GAS_proportional_address_delete (void *solver,
956     struct GNUNET_CONTAINER_MultiHashMap * addresses,
957     struct ATS_Address *address, int session_only)
958 {
959   struct GAS_PROPORTIONAL_Handle *s = solver;
960   struct Network *net;
961   struct AddressWrapper *aw;
962
963   /* Remove an adress completely, we have to:
964    * - Remove from specific network
965    * - Decrease number of total addresses
966    * - If active:
967    *   - decrease number of active addreses
968    *   - update quotas
969    */
970
971   net = (struct Network *) address->solver_information;
972
973   if (GNUNET_NO == session_only)
974   {
975     LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
976         (GNUNET_NO == address->active) ? "inactive" : "active",
977         address, GNUNET_i2s (&address->peer),
978         net->desc, net->total_addresses, net->active_addresses);
979
980     /* Remove address */
981     addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
982     for (aw = net->head; NULL != aw; aw = aw->next)
983     {
984         if (aw->addr == address)
985           break;
986     }
987     if (NULL == aw )
988     {
989         GNUNET_break (0);
990         return;
991     }
992     GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
993     GNUNET_free (aw);
994   }
995   else
996   {
997       /* Remove session only: remove if active and update */
998       LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
999           (GNUNET_NO == address->active) ? "inactive" : "active",
1000           address, GNUNET_i2s (&address->peer),
1001           net->desc, net->total_addresses, net->active_addresses);
1002   }
1003
1004   if (GNUNET_YES == address->active)
1005   {
1006       /* Address was active, remove from network and update quotas*/
1007       address->active = GNUNET_NO;
1008       if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1009         GNUNET_break (0);
1010       distribute_bandwidth_in_network (s, net, NULL);
1011   }
1012   LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
1013       net->total_addresses,
1014       net->active_addresses,
1015       net->desc);
1016
1017 }
1018
1019
1020 /**
1021  * Add a new single address to a network
1022  *
1023  * @param solver the solver Handle
1024  * @param addresses the address hashmap containing all addresses
1025  * @param address the address to add
1026  * @param network network type of this address
1027  */
1028 void
1029 GAS_proportional_address_add (void *solver,
1030                                                         struct GNUNET_CONTAINER_MultiHashMap *addresses,
1031                                                         struct ATS_Address *address,
1032                                                         uint32_t network);
1033
1034 /**
1035  * Updates a single address in the solver and checks previous values
1036  *
1037  * @param solver the solver Handle
1038  * @param addresses the address hashmap containing all addresses
1039  * @param address the update address
1040  * @param session the previous session
1041  * @param in_use the previous address in use state
1042  * @param prev_ats previous ATS information
1043  * @param prev_atsi_count the previous atsi count
1044  */
1045 void
1046 GAS_proportional_address_update (void *solver,
1047                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
1048                               struct ATS_Address *address,
1049                               uint32_t session,
1050                               int in_use,
1051                               const struct GNUNET_ATS_Information *prev_ats,
1052                               uint32_t prev_atsi_count)
1053 {
1054   struct ATS_Address *new;
1055   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1056   int i;
1057   uint32_t prev_value;
1058   uint32_t prev_type;
1059   uint32_t addr_net;
1060   int save_active = GNUNET_NO;
1061   struct Network *new_net = NULL;
1062
1063   /* Check updates to performance information */
1064   for (i = 0; i < prev_atsi_count; i++)
1065   {
1066     prev_type = ntohl (prev_ats[i].type);
1067     prev_value = ntohl (prev_ats[i].value);
1068     switch (prev_type)
1069     {
1070     case GNUNET_ATS_UTILIZATION_UP:
1071     case GNUNET_ATS_UTILIZATION_DOWN:
1072     case GNUNET_ATS_QUALITY_NET_DELAY:
1073     case GNUNET_ATS_QUALITY_NET_DISTANCE:
1074     case GNUNET_ATS_COST_WAN:
1075     case GNUNET_ATS_COST_LAN:
1076     case GNUNET_ATS_COST_WLAN:
1077         /* No actions required here*/
1078         break;
1079     case GNUNET_ATS_NETWORK_TYPE:
1080
1081       addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
1082       if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
1083       {
1084         GNUNET_break (0);
1085         addr_net = GNUNET_ATS_NET_UNSPECIFIED;
1086       }
1087       if (addr_net != prev_value)
1088       {
1089         /* Network changed */
1090         LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
1091             (GNUNET_YES == address->active) ? "active" : "inactive",
1092              GNUNET_ATS_print_network_type(prev_value),
1093              GNUNET_ATS_print_network_type(addr_net));
1094
1095         save_active = address->active;
1096         /* remove from old network */
1097         GAS_proportional_address_delete (solver, addresses, address, GNUNET_NO);
1098
1099         /* set new network type */
1100         new_net = get_network (solver, addr_net);
1101         address->solver_information = new_net;
1102
1103         /* Add to new network and update*/
1104         GAS_proportional_address_add (solver, addresses, address, addr_net);
1105         if (GNUNET_YES == save_active)
1106         {
1107           /* check if bandwidth available in new network */
1108           if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1109           {
1110               /* Suggest updated address */
1111               address->active = GNUNET_YES;
1112               addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1113               distribute_bandwidth_in_network (solver, new_net, NULL);
1114           }
1115           else
1116           {
1117             LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
1118
1119             /* Set old address to zero bw */
1120             address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1121             address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1122             s->bw_changed  (s->bw_changed_cls, address);
1123
1124             /* Find new address to suggest since no bandwidth in network*/
1125             new = (struct ATS_Address *) GAS_proportional_get_preferred_address (s, addresses, &address->peer);
1126             if (NULL != new)
1127             {
1128                 /* Have an alternative address to suggest */
1129                 s->bw_changed  (s->bw_changed_cls, new);
1130             }
1131
1132           }
1133         }
1134       }
1135
1136       break;
1137     case GNUNET_ATS_ARRAY_TERMINATOR:
1138       break;
1139     default:
1140       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1141                   "Received unsupported ATS type %u\n", prev_type);
1142       GNUNET_break (0);
1143       break;
1144
1145     }
1146
1147   }
1148   if (address->session_id != session)
1149   {
1150       LOG (GNUNET_ERROR_TYPE_DEBUG,
1151                   "Session changed from %u to %u\n", session, address->session_id);
1152   }
1153   if (address->used != in_use)
1154   {
1155       LOG (GNUNET_ERROR_TYPE_DEBUG,
1156                   "Usage changed from %u to %u\n", in_use, address->used);
1157   }
1158
1159 }
1160
1161
1162 /**
1163  * Add a new single address to a network
1164  *
1165  * @param solver the solver Handle
1166  * @param addresses the address hashmap containing all addresses
1167  * @param address the address to add
1168  * @param network network type of this address
1169  */
1170 void
1171 GAS_proportional_address_add (void *solver,
1172                                                         struct GNUNET_CONTAINER_MultiHashMap *addresses,
1173                                                         struct ATS_Address *address,
1174                                                         uint32_t network)
1175 {
1176   struct GAS_PROPORTIONAL_Handle *s = solver;
1177   struct Network *net = NULL;
1178   struct AddressWrapper *aw = NULL;
1179   GNUNET_assert (NULL != s);
1180
1181   net = get_network (s, network);
1182   if (NULL == net)
1183   {
1184     GNUNET_break (0);
1185     return;
1186   }
1187
1188   aw = GNUNET_malloc (sizeof (struct AddressWrapper));
1189   aw->addr = address;
1190   GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
1191   addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1192   aw->addr->solver_information = net;
1193
1194   LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
1195       net->total_addresses,
1196       net->active_addresses,
1197       net->desc);
1198 }
1199
1200
1201 /**
1202  * Init the proportional problem solver
1203  *
1204  * Quotas:
1205  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
1206  * out_quota[i] contains outbound quota for network type i
1207  * in_quota[i] contains inbound quota for network type i
1208  *
1209  * Example
1210  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
1211  * network[2]   == GNUNET_ATS_NET_LAN
1212  * out_quota[2] == 65353
1213  * in_quota[2]  == 65353
1214  *
1215  * @param cfg configuration handle
1216  * @param stats the GNUNET_STATISTICS handle
1217  * @param network array of GNUNET_ATS_NetworkType with length dest_length
1218  * @param out_quota array of outbound quotas
1219  * @param in_quota array of outbound quota
1220  * @param dest_length array length for quota arrays
1221  * @param bw_changed_cb callback for changed bandwidth amounts
1222  * @param bw_changed_cb_cls cls for callback
1223  * @return handle for the solver on success, NULL on fail
1224  */
1225 void *
1226 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1227                        const struct GNUNET_STATISTICS_Handle *stats,
1228                        int *network,
1229                        unsigned long long *out_quota,
1230                        unsigned long long *in_quota,
1231                        int dest_length,
1232                        GAS_bandwidth_changed_cb bw_changed_cb,
1233                        void *bw_changed_cb_cls)
1234 {
1235   int c;
1236   struct GAS_PROPORTIONAL_Handle *s = GNUNET_malloc (sizeof (struct GAS_PROPORTIONAL_Handle));
1237   struct Network * cur;
1238   char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1239
1240
1241   s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1242   s->bw_changed = bw_changed_cb;
1243   s->bw_changed_cls = bw_changed_cb_cls;
1244   s->networks = dest_length;
1245   s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
1246   s->active_addresses = 0;
1247   s->total_addresses = 0;
1248   s->prefs = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1249
1250   for (c = 0; c < dest_length; c++)
1251   {
1252       cur = &s->network_entries[c];
1253       cur->total_addresses = 0;
1254       cur->active_addresses = 0;
1255       cur->type = network[c];
1256       cur->total_quota_in = in_quota[c];
1257       cur->total_quota_out = out_quota[c];
1258       cur->desc = net_str[c];
1259       GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
1260       GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
1261   }
1262   return s;
1263 }
1264
1265
1266 /**
1267  * Shutdown the proportional problem solver
1268  *
1269  * @param solver the respective handle to shutdown
1270  */
1271 void
1272 GAS_proportional_done (void *solver)
1273 {
1274   struct GAS_PROPORTIONAL_Handle *s = solver;
1275   struct AddressWrapper *cur;
1276   struct AddressWrapper *next;
1277   int c;
1278   GNUNET_assert (s != NULL);
1279
1280   for (c = 0; c < s->networks; c++)
1281   {
1282       if (s->network_entries[c].total_addresses > 0)
1283       {
1284         LOG (GNUNET_ERROR_TYPE_ERROR,
1285                     "Had %u addresses for network `%s' not deleted during shutdown\n",
1286                     s->network_entries[c].total_addresses,
1287                     s->network_entries[c].desc);
1288         GNUNET_break (0);
1289       }
1290
1291       if (s->network_entries[c].active_addresses > 0)
1292       {
1293         LOG (GNUNET_ERROR_TYPE_ERROR,
1294                     "Had %u active addresses for network `%s' not deleted during shutdown\n",
1295                     s->network_entries[c].active_addresses,
1296                     s->network_entries[c].desc);
1297         GNUNET_break (0);
1298       }
1299
1300       next = s->network_entries[c].head;
1301       while (NULL != (cur = next))
1302       {
1303           next = cur->next;
1304           GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1305                                        s->network_entries[c].tail,
1306                                        cur);
1307           GNUNET_free (cur);
1308       }
1309       GNUNET_free (s->network_entries[c].stat_total);
1310       GNUNET_free (s->network_entries[c].stat_active);
1311   }
1312   if (s->total_addresses > 0)
1313   {
1314     LOG (GNUNET_ERROR_TYPE_ERROR,
1315                 "Had %u addresses not deleted during shutdown\n",
1316                 s->total_addresses);
1317     GNUNET_break (0);
1318   }
1319   if (s->active_addresses > 0)
1320   {
1321     LOG (GNUNET_ERROR_TYPE_ERROR,
1322                 "Had %u active addresses not deleted during shutdown\n",
1323                 s->active_addresses);
1324     GNUNET_break (0);
1325   }
1326   GNUNET_free (s->network_entries);
1327   GNUNET_free (s);
1328 }
1329
1330
1331 /* end of gnunet-service-ats-solver_proportional.c */