changes
[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         GNUNET_assert (NULL != (t = GAS_normalization_get_preferences (&cur->addr->peer)));
436
437                                 peer_prefs = 0.0;
438                                 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
439                                 {
440                                         if (c != GNUNET_ATS_PREFERENCE_END)
441                                         {
442                                                 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
443                                                 peer_prefs += t[c];
444                                         }
445                                 }
446                                 total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount -1));
447       }
448   }
449   for (cur = net->head; NULL != cur; cur = cur->next)
450   {
451      if (GNUNET_YES == cur->addr->active)
452      {
453        cur_pref = 0.0;
454        GNUNET_assert (NULL != (t = GAS_normalization_get_preferences (&cur->addr->peer)));
455
456                          for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
457                          {
458                                  if (c != GNUNET_ATS_PREFERENCE_END)
459                                          cur_pref += t[c];
460                          }
461                          cur_pref /= 2;
462
463        assigned_quota_in = min_bw + ((cur_pref / total_prefs) * remaining_quota_in);
464        assigned_quota_out = min_bw + ((cur_pref / total_prefs) * remaining_quota_out);
465
466        LOG (GNUNET_ERROR_TYPE_DEBUG,
467                    "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
468                    GNUNET_i2s (&cur->addr->peer),
469                    cur_pref, total_prefs,
470                    assigned_quota_in, assigned_quota_out);
471      }
472      else
473      {
474        assigned_quota_in = 0;
475        assigned_quota_out = 0;
476      }
477
478      quota_in_used += assigned_quota_in;
479      quota_out_used += assigned_quota_out;
480      /* Prevent overflow due to rounding errors */
481      if (assigned_quota_in > UINT32_MAX)
482        assigned_quota_in = UINT32_MAX;
483      if (assigned_quota_out > UINT32_MAX)
484        assigned_quota_out = UINT32_MAX;
485
486      /* Compare to current bandwidth assigned */
487      if ((assigned_quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
488          (assigned_quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
489      {
490        cur->addr->assigned_bw_in.value__ = htonl (assigned_quota_in);
491        cur->addr->assigned_bw_out.value__ = htonl (assigned_quota_out);
492        /* Notify on change */
493        if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
494          s->bw_changed (s->bw_changed_cls, cur->addr);
495      }
496
497   }
498   LOG (GNUNET_ERROR_TYPE_DEBUG,
499                           "Total bandwidth assigned is (in/out): %llu /%llu\n",
500                           quota_in_used,
501                           quota_out_used);
502   if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
503   {
504       LOG (GNUNET_ERROR_TYPE_ERROR,
505                             "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
506                             net->active_addresses,
507                             quota_out_used,
508                             net->total_quota_out);
509   }
510   if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
511   {
512       LOG (GNUNET_ERROR_TYPE_ERROR,
513                             "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
514                             net->active_addresses,
515                             quota_in_used,
516                             net->total_quota_in);
517   }
518 }
519
520
521 /**
522  * Extract an ATS performance info from an address
523  *
524  * @param address the address
525  * @param type the type to extract in HBO
526  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
527  */
528 static int
529 get_performance_info (struct ATS_Address *address, uint32_t type);
530
531 /**
532  * Find a "good" address to use for a peer by iterating over the addresses for this peer.
533  * If we already have an existing address, we stick to it.
534  * Otherwise, we pick by lowest distance and then by lowest latency.
535  *
536  * @param cls the 'struct ATS_Address**' where we store the result
537  * @param key unused
538  * @param value another 'struct ATS_Address*' to consider using
539  * @return GNUNET_OK (continue to iterate)
540  */
541 static int
542 find_best_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
543 {
544   struct ATS_Address **previous_p = cls;
545   struct ATS_Address *current = (struct ATS_Address *) value;
546   struct ATS_Address *previous = *previous_p;
547   struct GNUNET_TIME_Absolute now;
548   struct Network *net = (struct Network *) current->solver_information;
549   uint32_t p_distance_cur;
550   uint32_t p_distance_prev;
551   uint32_t p_delay_cur;
552   uint32_t p_delay_prev;
553
554   now = GNUNET_TIME_absolute_get();
555
556   if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
557   {
558     /* This address is blocked for suggestion */
559     LOG (GNUNET_ERROR_TYPE_DEBUG,
560                 "Address %p blocked for suggestion for %llu ms \n",
561                 current,
562                 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
563     return GNUNET_OK;
564   }
565
566   if (GNUNET_NO == is_bandwidth_available_in_network (net))
567     return GNUNET_OK; /* There's no bandwidth available in this network */
568
569   if (NULL != previous)
570   {
571         GNUNET_assert (NULL != previous->plugin);
572         GNUNET_assert (NULL != current->plugin);
573     if (0 == strcmp (previous->plugin, current->plugin))
574     {
575       if ((0 != previous->addr_len) &&
576           (0 == current->addr_len))
577       {
578         /* saved address was an outbound address, but we have an inbound address */
579         *previous_p = current;
580         return GNUNET_OK;
581       }
582       if (0 == previous->addr_len)
583       {
584         /* saved address was an inbound address, so do not overwrite */
585         return GNUNET_OK;
586       }
587     }
588   }
589
590   if (NULL == previous)
591   {
592     *previous_p = current;
593     return GNUNET_OK;
594   }
595   if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
596       (ntohl (current->assigned_bw_in.value__) > 0))
597   {
598     /* stick to existing connection */
599     *previous_p = current;
600     return GNUNET_OK;
601   }
602
603   p_distance_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DISTANCE);
604   p_distance_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DISTANCE);
605   if ((p_distance_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_distance_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
606                 (p_distance_prev > p_distance_cur))
607   {
608     /* user shorter distance */
609     *previous_p = current;
610     return GNUNET_OK;
611   }
612
613   p_delay_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DELAY);
614   p_delay_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DELAY);
615   if ((p_delay_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_delay_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
616                 (p_delay_prev > p_delay_cur))
617   {
618     /* user lower latency */
619     *previous_p = current;
620     return GNUNET_OK;
621   }
622
623   /* don't care */
624   return GNUNET_OK;
625 }
626
627 /**
628  *  Helper functions
629  *  ---------------------------
630  */
631
632 /**
633  * Update bandwidth assignment for all networks
634  *
635  * @param s the solver handle
636  */
637 static void
638 distribute_bandwidth_in_all_networks (struct GAS_PROPORTIONAL_Handle *s)
639 {
640         int i;
641         for (i = 0; i < s->networks; i++)
642                 distribute_bandwidth_in_network (s, &s->network_entries[i], NULL);
643
644 }
645
646
647 /**
648  * Lookup network struct by type
649  *
650  * @param s the solver handle
651  * @param type the network type
652  * @return the network struct
653  */
654 static struct Network *
655 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
656 {
657   int c;
658   for (c = 0 ; c < s->networks; c++)
659   {
660       if (s->network_entries[c].type == type)
661         return &s->network_entries[c];
662   }
663   return NULL;
664 }
665
666
667 /**
668  * Hashmap Iterator to find current active address for peer
669  *
670  * @param cls last active address
671  * @param key peer's key
672  * @param value address to check
673  * @return GNUNET_NO on double active address else GNUNET_YES
674  */
675 static int
676 get_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
677 {
678   struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
679   struct ATS_Address * aa = (struct ATS_Address *) value;
680
681   if (GNUNET_YES == aa->active)
682   {
683       if (dest != NULL)
684       {
685           /* should never happen */
686           LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
687           GNUNET_break (0);
688           return GNUNET_NO;
689       }
690       dest = aa;
691   }
692   return GNUNET_OK;
693 }
694
695
696 /**
697  * Find current active address for peer
698  *
699  * @param solver the solver handle
700  * @param addresses the address set
701  * @param peer the peer
702  * @return active address or NULL
703  */
704 static struct ATS_Address *
705 get_active_address (void *solver,
706                      struct GNUNET_CONTAINER_MultiHashMap * addresses,
707                      const struct GNUNET_PeerIdentity *peer)
708 {
709   struct ATS_Address * dest = NULL;
710
711   GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
712        &peer->hashPubKey,
713        &get_active_address_it, &dest);
714   return dest;
715 }
716
717
718
719 static void
720 addresse_increment (struct GAS_PROPORTIONAL_Handle *s,
721                                 struct Network *net,
722                                 int total,
723                                 int active)
724 {
725   if (GNUNET_YES == total)
726   {
727       s->total_addresses ++;
728       net->total_addresses ++;
729       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
730       GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
731   }
732   if (GNUNET_YES == active)
733   {
734     net->active_addresses ++;
735     s->active_addresses ++;
736     GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
737     GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
738   }
739
740 }
741
742
743 static int
744 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s,
745                     struct Network *net,
746                     int total,
747                     int active)
748 {
749   int res = GNUNET_OK;
750   if (GNUNET_YES == total)
751   {
752     if (s->total_addresses < 1)
753     {
754       GNUNET_break (0);
755       res = GNUNET_SYSERR;
756     }
757     else
758     {
759       s->total_addresses --;
760       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
761     }
762     if (net->total_addresses < 1)
763     {
764       GNUNET_break (0);
765       res = GNUNET_SYSERR;
766     }
767     else
768     {
769       net->total_addresses --;
770       GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
771     }
772   }
773
774   if (GNUNET_YES == active)
775   {
776     if (net->active_addresses < 1)
777     {
778       GNUNET_break (0);
779       res = GNUNET_SYSERR;
780     }
781     else
782     {
783       net->active_addresses --;
784       GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
785     }
786     if (s->active_addresses < 1)
787     {
788       GNUNET_break (0);
789       res = GNUNET_SYSERR;
790     }
791     else
792     {
793       s->active_addresses --;
794       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
795     }
796   }
797   return res;
798 }
799
800
801 /**
802  * Extract an ATS performance info from an address
803  *
804  * @param address the address
805  * @param type the type to extract in HBO
806  * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
807  */
808 static int
809 get_performance_info (struct ATS_Address *address, uint32_t type)
810 {
811         int c1;
812         GNUNET_assert (NULL != address);
813
814         if ((NULL == address->atsi) || (0 == address->atsi_count))
815                         return GNUNET_ATS_VALUE_UNDEFINED;
816
817         for (c1 = 0; c1 < address->atsi_count; c1++)
818         {
819                         if (ntohl(address->atsi[c1].type) == type)
820                                 return ntohl(address->atsi[c1].value);
821         }
822         return GNUNET_ATS_VALUE_UNDEFINED;
823 }
824
825
826 /**
827  *  Solver API functions
828  *  ---------------------------
829  */
830
831 /**
832  * Changes the preferences for a peer in the problem
833  *
834  * @param solver the solver handle
835  * @param client the client with this preference
836  * @param peer the peer to change the preference for
837  * @param kind the kind to change the preference
838  * @param pref_rel the normalized preference value for this kind over all clients
839  * @param score the score
840  */
841 void
842 GAS_proportional_address_change_preference  (void *solver,
843                                                                                                                                                                                  struct GNUNET_CONTAINER_MultiHashMap *addresses,
844                                                                    const struct GNUNET_PeerIdentity *peer,
845                                                                    enum GNUNET_ATS_PreferenceKind kind,
846                                                                    double pref_rel)
847 {
848   struct GAS_PROPORTIONAL_Handle *s = solver;
849   GNUNET_assert (NULL != solver);
850   GNUNET_assert (NULL != peer);
851   distribute_bandwidth_in_all_networks (s);
852 }
853
854 /**
855  * Get the preferred address for a specific peer
856  *
857  * @param solver the solver handle
858  * @param addresses the address hashmap containing all addresses
859  * @param peer the identity of the peer
860  */
861 const struct ATS_Address *
862 GAS_proportional_get_preferred_address (void *solver,
863                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
864                                const struct GNUNET_PeerIdentity *peer)
865 {
866   struct GAS_PROPORTIONAL_Handle *s = solver;
867   struct Network *net_prev;
868   struct Network *net_cur;
869   struct ATS_Address *cur;
870   struct ATS_Address *prev;
871
872   GNUNET_assert (s != NULL);
873   cur = NULL;
874   /* Get address with: stick to current address, lower distance, lower latency */
875   GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
876                                               &find_best_address_it, &cur);
877   if (NULL == cur)
878   {
879     LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
880     return NULL;
881   }
882
883   LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
884       (GNUNET_NO == cur->active) ? "inactive" : "active",
885       cur, GNUNET_i2s (peer));
886   net_cur = (struct Network *) cur->solver_information;
887   if (GNUNET_YES == cur->active)
888   {
889       /* This address was selected previously, so no need to update quotas */
890       return cur;
891   }
892
893   /* This address was not active, so we have to:
894    *
895    * - mark previous active address as not active
896    * - update quota for previous address network
897    * - update quota for this address network
898    */
899
900   prev = get_active_address (s, addresses, peer);
901   if (NULL != prev)
902   {
903       net_prev = (struct Network *) prev->solver_information;
904       prev->active = GNUNET_NO; /* No active any longer */
905       prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
906       prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
907       s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
908       if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
909         GNUNET_break (0);
910       distribute_bandwidth_in_network (s, net_prev, NULL);
911   }
912
913   if (GNUNET_NO == (is_bandwidth_available_in_network (cur->solver_information)))
914   {
915     GNUNET_break (0); /* This should never happen*/
916     return NULL;
917   }
918
919   cur->active = GNUNET_YES;
920   addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
921   distribute_bandwidth_in_network (s, net_cur, cur);
922
923   return cur;
924 }
925
926
927 /**
928  * Stop notifying about address and bandwidth changes for this peer
929  *
930  * @param solver the solver handle
931  * @param addresses address hashmap
932  * @param peer the peer
933  */
934 void
935 GAS_proportional_stop_get_preferred_address (void *solver,
936                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
937                                      const struct GNUNET_PeerIdentity *peer)
938 {
939         return;
940 }
941
942
943 /**
944  * Remove an address from the solver
945  *
946  * @param solver the solver handle
947  * @param addresses the address hashmap containing all addresses
948  * @param address the address to remove
949  * @param session_only delete only session not whole address
950  */
951 void
952 GAS_proportional_address_delete (void *solver,
953     struct GNUNET_CONTAINER_MultiHashMap * addresses,
954     struct ATS_Address *address, int session_only)
955 {
956   struct GAS_PROPORTIONAL_Handle *s = solver;
957   struct Network *net;
958   struct AddressWrapper *aw;
959
960   /* Remove an adress completely, we have to:
961    * - Remove from specific network
962    * - Decrease number of total addresses
963    * - If active:
964    *   - decrease number of active addreses
965    *   - update quotas
966    */
967
968   net = (struct Network *) address->solver_information;
969
970   if (GNUNET_NO == session_only)
971   {
972     LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
973         (GNUNET_NO == address->active) ? "inactive" : "active",
974         address, GNUNET_i2s (&address->peer),
975         net->desc, net->total_addresses, net->active_addresses);
976
977     /* Remove address */
978     addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
979     for (aw = net->head; NULL != aw; aw = aw->next)
980     {
981         if (aw->addr == address)
982           break;
983     }
984     if (NULL == aw )
985     {
986         GNUNET_break (0);
987         return;
988     }
989     GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
990     GNUNET_free (aw);
991   }
992   else
993   {
994       /* Remove session only: remove if active and update */
995       LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
996           (GNUNET_NO == address->active) ? "inactive" : "active",
997           address, GNUNET_i2s (&address->peer),
998           net->desc, net->total_addresses, net->active_addresses);
999   }
1000
1001   if (GNUNET_YES == address->active)
1002   {
1003       /* Address was active, remove from network and update quotas*/
1004       address->active = GNUNET_NO;
1005       if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1006         GNUNET_break (0);
1007       distribute_bandwidth_in_network (s, net, NULL);
1008   }
1009   LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
1010       net->total_addresses,
1011       net->active_addresses,
1012       net->desc);
1013
1014 }
1015
1016
1017 /**
1018  * Add a new single address to a network
1019  *
1020  * @param solver the solver Handle
1021  * @param addresses the address hashmap containing all addresses
1022  * @param address the address to add
1023  * @param network network type of this address
1024  */
1025 void
1026 GAS_proportional_address_add (void *solver,
1027                                                         struct GNUNET_CONTAINER_MultiHashMap *addresses,
1028                                                         struct ATS_Address *address,
1029                                                         uint32_t network);
1030
1031 /**
1032  * Updates a single address in the solver and checks previous values
1033  *
1034  * @param solver the solver Handle
1035  * @param addresses the address hashmap containing all addresses
1036  * @param address the update address
1037  * @param session the previous session
1038  * @param in_use the previous address in use state
1039  * @param prev_ats previous ATS information
1040  * @param prev_atsi_count the previous atsi count
1041  */
1042 void
1043 GAS_proportional_address_update (void *solver,
1044                               struct GNUNET_CONTAINER_MultiHashMap *addresses,
1045                               struct ATS_Address *address,
1046                               uint32_t session,
1047                               int in_use,
1048                               const struct GNUNET_ATS_Information *prev_ats,
1049                               uint32_t prev_atsi_count)
1050 {
1051   struct ATS_Address *new;
1052   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1053   int i;
1054   uint32_t prev_value;
1055   uint32_t prev_type;
1056   uint32_t addr_net;
1057   int save_active = GNUNET_NO;
1058   struct Network *new_net = NULL;
1059
1060   /* Check updates to performance information */
1061   for (i = 0; i < prev_atsi_count; i++)
1062   {
1063     prev_type = ntohl (prev_ats[i].type);
1064     prev_value = ntohl (prev_ats[i].value);
1065     switch (prev_type)
1066     {
1067     case GNUNET_ATS_UTILIZATION_UP:
1068     case GNUNET_ATS_UTILIZATION_DOWN:
1069     case GNUNET_ATS_QUALITY_NET_DELAY:
1070     case GNUNET_ATS_QUALITY_NET_DISTANCE:
1071     case GNUNET_ATS_COST_WAN:
1072     case GNUNET_ATS_COST_LAN:
1073     case GNUNET_ATS_COST_WLAN:
1074         /* No actions required here*/
1075         break;
1076     case GNUNET_ATS_NETWORK_TYPE:
1077
1078       addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
1079       if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
1080       {
1081         GNUNET_break (0);
1082         addr_net = GNUNET_ATS_NET_UNSPECIFIED;
1083       }
1084       if (addr_net != prev_value)
1085       {
1086         /* Network changed */
1087         LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
1088             (GNUNET_YES == address->active) ? "active" : "inactive",
1089              GNUNET_ATS_print_network_type(prev_value),
1090              GNUNET_ATS_print_network_type(addr_net));
1091
1092         save_active = address->active;
1093         /* remove from old network */
1094         GAS_proportional_address_delete (solver, addresses, address, GNUNET_NO);
1095
1096         /* set new network type */
1097         new_net = get_network (solver, addr_net);
1098         address->solver_information = new_net;
1099
1100         /* Add to new network and update*/
1101         GAS_proportional_address_add (solver, addresses, address, addr_net);
1102         if (GNUNET_YES == save_active)
1103         {
1104           /* check if bandwidth available in new network */
1105           if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1106           {
1107               /* Suggest updated address */
1108               address->active = GNUNET_YES;
1109               addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1110               distribute_bandwidth_in_network (solver, new_net, NULL);
1111           }
1112           else
1113           {
1114             LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
1115
1116             /* Set old address to zero bw */
1117             address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1118             address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1119             s->bw_changed  (s->bw_changed_cls, address);
1120
1121             /* Find new address to suggest since no bandwidth in network*/
1122             new = (struct ATS_Address *) GAS_proportional_get_preferred_address (s, addresses, &address->peer);
1123             if (NULL != new)
1124             {
1125                 /* Have an alternative address to suggest */
1126                 s->bw_changed  (s->bw_changed_cls, new);
1127             }
1128
1129           }
1130         }
1131       }
1132
1133       break;
1134     case GNUNET_ATS_ARRAY_TERMINATOR:
1135       break;
1136     default:
1137       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1138                   "Received unsupported ATS type %u\n", prev_type);
1139       GNUNET_break (0);
1140       break;
1141
1142     }
1143
1144   }
1145   if (address->session_id != session)
1146   {
1147       LOG (GNUNET_ERROR_TYPE_DEBUG,
1148                   "Session changed from %u to %u\n", session, address->session_id);
1149   }
1150   if (address->used != in_use)
1151   {
1152       LOG (GNUNET_ERROR_TYPE_DEBUG,
1153                   "Usage changed from %u to %u\n", in_use, address->used);
1154   }
1155
1156 }
1157
1158
1159 /**
1160  * Add a new single address to a network
1161  *
1162  * @param solver the solver Handle
1163  * @param addresses the address hashmap containing all addresses
1164  * @param address the address to add
1165  * @param network network type of this address
1166  */
1167 void
1168 GAS_proportional_address_add (void *solver,
1169                                                         struct GNUNET_CONTAINER_MultiHashMap *addresses,
1170                                                         struct ATS_Address *address,
1171                                                         uint32_t network)
1172 {
1173   struct GAS_PROPORTIONAL_Handle *s = solver;
1174   struct Network *net = NULL;
1175   struct AddressWrapper *aw = NULL;
1176   GNUNET_assert (NULL != s);
1177
1178   net = get_network (s, network);
1179   if (NULL == net)
1180   {
1181     GNUNET_break (0);
1182     return;
1183   }
1184
1185   aw = GNUNET_malloc (sizeof (struct AddressWrapper));
1186   aw->addr = address;
1187   GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
1188   addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1189   aw->addr->solver_information = net;
1190
1191   LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
1192       net->total_addresses,
1193       net->active_addresses,
1194       net->desc);
1195 }
1196
1197
1198 /**
1199  * Init the proportional problem solver
1200  *
1201  * Quotas:
1202  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
1203  * out_quota[i] contains outbound quota for network type i
1204  * in_quota[i] contains inbound quota for network type i
1205  *
1206  * Example
1207  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
1208  * network[2]   == GNUNET_ATS_NET_LAN
1209  * out_quota[2] == 65353
1210  * in_quota[2]  == 65353
1211  *
1212  * @param cfg configuration handle
1213  * @param stats the GNUNET_STATISTICS handle
1214  * @param network array of GNUNET_ATS_NetworkType with length dest_length
1215  * @param out_quota array of outbound quotas
1216  * @param in_quota array of outbound quota
1217  * @param dest_length array length for quota arrays
1218  * @param bw_changed_cb callback for changed bandwidth amounts
1219  * @param bw_changed_cb_cls cls for callback
1220  * @return handle for the solver on success, NULL on fail
1221  */
1222 void *
1223 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1224                        const struct GNUNET_STATISTICS_Handle *stats,
1225                        int *network,
1226                        unsigned long long *out_quota,
1227                        unsigned long long *in_quota,
1228                        int dest_length,
1229                        GAS_bandwidth_changed_cb bw_changed_cb,
1230                        void *bw_changed_cb_cls)
1231 {
1232   int c;
1233   struct GAS_PROPORTIONAL_Handle *s = GNUNET_malloc (sizeof (struct GAS_PROPORTIONAL_Handle));
1234   struct Network * cur;
1235   char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1236
1237
1238   s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1239   s->bw_changed = bw_changed_cb;
1240   s->bw_changed_cls = bw_changed_cb_cls;
1241   s->networks = dest_length;
1242   s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
1243   s->active_addresses = 0;
1244   s->total_addresses = 0;
1245   s->prefs = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1246
1247   for (c = 0; c < dest_length; c++)
1248   {
1249       cur = &s->network_entries[c];
1250       cur->total_addresses = 0;
1251       cur->active_addresses = 0;
1252       cur->type = network[c];
1253       cur->total_quota_in = in_quota[c];
1254       cur->total_quota_out = out_quota[c];
1255       cur->desc = net_str[c];
1256       GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
1257       GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
1258   }
1259   return s;
1260 }
1261
1262
1263 /**
1264  * Shutdown the proportional problem solver
1265  *
1266  * @param solver the respective handle to shutdown
1267  */
1268 void
1269 GAS_proportional_done (void *solver)
1270 {
1271   struct GAS_PROPORTIONAL_Handle *s = solver;
1272   struct AddressWrapper *cur;
1273   struct AddressWrapper *next;
1274   int c;
1275   GNUNET_assert (s != NULL);
1276
1277   for (c = 0; c < s->networks; c++)
1278   {
1279       if (s->network_entries[c].total_addresses > 0)
1280       {
1281         LOG (GNUNET_ERROR_TYPE_ERROR,
1282                     "Had %u addresses for network `%s' not deleted during shutdown\n",
1283                     s->network_entries[c].total_addresses,
1284                     s->network_entries[c].desc);
1285         GNUNET_break (0);
1286       }
1287
1288       if (s->network_entries[c].active_addresses > 0)
1289       {
1290         LOG (GNUNET_ERROR_TYPE_ERROR,
1291                     "Had %u active addresses for network `%s' not deleted during shutdown\n",
1292                     s->network_entries[c].active_addresses,
1293                     s->network_entries[c].desc);
1294         GNUNET_break (0);
1295       }
1296
1297       next = s->network_entries[c].head;
1298       while (NULL != (cur = next))
1299       {
1300           next = cur->next;
1301           GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
1302                                        s->network_entries[c].tail,
1303                                        cur);
1304           GNUNET_free (cur);
1305       }
1306       GNUNET_free (s->network_entries[c].stat_total);
1307       GNUNET_free (s->network_entries[c].stat_active);
1308   }
1309   if (s->total_addresses > 0)
1310   {
1311     LOG (GNUNET_ERROR_TYPE_ERROR,
1312                 "Had %u addresses not deleted during shutdown\n",
1313                 s->total_addresses);
1314     GNUNET_break (0);
1315   }
1316   if (s->active_addresses > 0)
1317   {
1318     LOG (GNUNET_ERROR_TYPE_ERROR,
1319                 "Had %u active addresses not deleted during shutdown\n",
1320                 s->active_addresses);
1321     GNUNET_break (0);
1322   }
1323   GNUNET_free (s->network_entries);
1324   GNUNET_free (s);
1325 }
1326
1327
1328 /* end of gnunet-service-ats-solver_proportional.c */