bf978ad37e3a8cfdd9838c589bc6f94be7d157f0
[oweals/gnunet.git] / src / ats / plugin_ats_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/plugin_ats_proportional.c
23  * @brief ATS proportional solver
24  * @author Matthias Wachs
25  * @author Christian Grothoff
26  */
27 #include "plugin_ats_proportional.h"
28
29 #define LOG(kind,...) GNUNET_log_from (kind, "ats-proportional",__VA_ARGS__)
30
31
32 /**
33  *
34  * NOTE: Do not change this documentation. This documentation is based
35  * on gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
36  * use build_txt.sh to generate plaintext output
37  *
38  * ATS addresses : proportional solver
39  *
40  *    The proportional solver ("proportional") distributes the available
41  *    bandwidth fair over all the addresses influenced by the
42  *    preference values. For each available network type an in- and
43  *    outbound quota is configured and the bandwidth available in
44  *    these networks is distributed over the addresses.  The solver
45  *    first assigns every addresses the minimum amount of bandwidth
46  *    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the
47  *    remaining bandwidth available according to the preference
48  *    values. For each peer only a single address gets bandwidth
49  *    assigned and only one address marked as active.  The most
50  *    important functionality for the solver is implemented in: *
51  *    find_address_it is an hashmap iterator returning the prefered
52  *    address for an peer * update_quota_per_network distributes
53  *    available bandwidth for a network over active addresses
54  *
55  *    Changes to addresses automatically have an impact on the the
56  *    bandwidth assigned to other addresses in the same network since
57  *    the solver distributes the remaining bandwidth over the
58  *    addresses in the network.  When changes to the addresses occur,
59  *    the solver first performs the changes, like adding or deleting
60  *    addresses, and then updates bandwidth assignment for the
61  *    affected network. Bandwidth assignment is only recalculated on
62  *    demand when an address is requested by a client for a peer or
63  *    when the addresses available have changed or an address changed
64  *    the network it is located in. When the bandwidth assignment has
65  *    changed the callback is called with the new bandwidth
66  *    assignments. The bandwidth distribution for a network is
67  *    recalculated due to: * address suggestion requests * address
68  *    deletions * address switching networks during address update *
69  *    preference changes
70  *
71  *     3.1 Data structures used
72  *
73  *    For each ATS network (e.g. WAN, LAN, loopback) a struct Network
74  *    is used to specify network related information as total adresses
75  *    and active addresses in this network and the configured in- and
76  *    outbound quota. Each network also contains a list of addresses
77  *    added to the solver located in this network. The proportional
78  *    solver uses the addresses' solver_information field to store the
79  *    proportional network it belongs to for each address.
80  *
81  *     3.2 Initializing
82  *
83  *    When the proportional solver is initialized the solver creates a
84  *    new solver handle and initializes the network structures with
85  *    the quotas passed from addresses and returns the handle solver.
86  *
87  *     3.3 Adding an address
88  *
89  *    When a new address is added to the solver using s_add, a lookup
90  *    for the network for this address is done and the address is
91  *    enqueued in in the linked list of the network.
92  *
93  *     3.4 Updating an address
94  *
95  *    The main purpose of address updates is to update the ATS
96  *    information for addresse selection. Important for the proportional
97  *    solver is when an address switches network it is located
98  *    in. This is common because addresses added by transport's
99  *    validation mechanism are commonly located in
100  *    GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located
101  *    in this network type and only if a connection is successful on
102  *    return of payload data transport switches to the real network
103  *    the address is located in.  When an address changes networks it
104  *    is first of all removed from the old network using the solver
105  *    API function GAS_proportional_address_delete and the network in
106  *    the address struct is updated. A lookup for the respective new
107  *    proportional network is done and stored in the addresse's
108  *    solver_information field. Next the address is re-added to the
109  *    solver using the solver API function
110  *    GAS_proportional_address_add. If the address was marked as in
111  *    active, the solver checks if bandwidth is available in the
112  *    network and if yes sets the address to active and updates the
113  *    bandwidth distribution in this network. If no bandwidth is
114  *    available it sets the bandwidth for this address to 0 and tries
115  *    to suggest an alternative address. If an alternative address was
116  *    found, addresses' callback is called for this address.
117  *
118  *     3.5 Deleting an address
119  *
120  *    When an address is removed from the solver, it removes the
121  *    respective address from the network and if the address was
122  *    marked as active, it updates the bandwidth distribution for this
123  *    network.
124  *
125  *     3.6 Requesting addresses
126  *
127  *    When an address is requested for a peer the solver performs a
128  *    lookup for the peer entry in addresses address hashmap and
129  *    selects the best address.  The selection of the most suitable
130  *    address is done in the find_address_it hashmap iterator
131  *    described in detail in section 3.7. If no address is returned,
132  *    no address can be suggested at the moment. If the address
133  *    returned is marked as active, the solver can return this
134  *    address. If the address is not marked as active, the solver
135  *    checks if another address belongign to this peer is marked as
136  *    active and marks the address as inactive, updates the bandwidth
137  *    for this address to 0, call the bandwidth changed callback for
138  *    this address due to the change and updates quota assignment for
139  *    the addresse's network. the now in-active address is belonging
140  *    to. The solver marks the new address as active and updates the
141  *    bandwidth assignment for this network.
142  *
143  *     3.7 Choosing addresses
144  *
145  *    Choosing the best possible address for suggestion is done by
146  *    iterating over all addresses of a peer stored in addresses'
147  *    hashmap and using the hashmap iterator find_address_it to select
148  *    the best available address.  Several checks are done when an
149  *    address is selected. First if this address is currently blocked
150  *    by addresses from being suggested. An address is blocked for the
151  *    duration of ATS_BLOCKING_DELTA when it is suggested to
152  *    transport. Next it is checked if at least
153  *    GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available
154  *    in the addresse's network, because suggesting an address without
155  *    bandwidth does not make sense. This also ensures that all active
156  *    addresses in this network get at least the minimum amount of
157  *    bandwidth assigned. In the next step the solver ensures that for
158  *    tcp connections inbound connections are prefered over outbound
159  *    connections. In the next stet the solver ensures that
160  *    connections are prefered in the following order: * connections
161  *    are already established and have bandwidth assigned *
162  *    connections with a shorter distance * connectes have a shorter
163  *    latency
164  *
165  *     3.8 Changing preferences
166  *
167  *     3.9 Shutdown
168  *
169  *    During shutdown all network entries and aging processes are
170  *    destroyed and freed.
171  *
172  *
173  * OLD DOCUMENTATION
174  *
175  * This solver assigns in and outbound bandwidth equally for all
176  * addresses in specific network type (WAN, LAN) based on configured
177  * in and outbound quota for this network.
178  *
179  * The solver is notified by addresses about changes to the addresses
180  * and recalculates the bandwith assigned if required. The solver
181  * notifies addresses by calling the GAS_bandwidth_changed_cb
182  * callback.
183  *
184  * - Initialization
185  *
186  *
187  *
188  *
189  * For each peer only a single is selected and marked as "active" in the address
190  * struct.
191  *
192  * E.g.:
193  *
194  * You have the networks WAN and LAN and quotas
195  * WAN_TOTAL_IN, WAN_TOTAL_OUT
196  * LAN_TOTAL_IN, LAN_TOTAL_OUT
197  *
198  * If you have x addresses in the network segment LAN, the quotas are
199  * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
200  *
201  * Quotas are automatically recalculated and reported back when addresses are
202  * - requested
203  *
204  */
205
206 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
207 #define PREF_AGING_FACTOR 0.95
208
209 #define DEFAULT_REL_PREFERENCE 1.0
210 #define DEFAULT_ABS_PREFERENCE 0.0
211 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
212
213 /**
214  * A handle for the proportional solver
215  */
216 struct GAS_PROPORTIONAL_Handle
217 {
218    struct GNUNET_ATS_PluginEnvironment *env;
219
220   /**
221    * Statistics handle
222    */
223   struct GNUNET_STATISTICS_Handle *stats;
224
225   /**
226    * Hashmap containing all valid addresses
227    */
228   const struct GNUNET_CONTAINER_MultiPeerMap *addresses;
229
230   /**
231    * Pending address requests
232    */
233   struct GNUNET_CONTAINER_MultiPeerMap *requests;
234
235   /**
236    * Bandwidth changed callback
237    */
238   GAS_bandwidth_changed_cb bw_changed;
239
240   /**
241    * Bandwidth changed callback cls
242    */
243   void *bw_changed_cls;
244
245   /**
246    * ATS function to get preferences
247    */
248   GAS_get_preferences get_preferences;
249
250   /**
251    * Closure for ATS function to get preferences
252    */
253   void *get_preferences_cls;
254
255   /**
256    * ATS function to get properties
257    */
258   GAS_get_properties get_properties;
259
260   /**
261    * Closure for ATS function to get properties
262    */
263   void *get_properties_cls;
264
265   /**
266    * Bulk lock
267    */
268   int bulk_lock;
269
270   /**
271    * Number of changes while solver was locked
272    */
273   int bulk_requests;
274
275   /**
276    * Total number of addresses for solver
277    */
278   unsigned int total_addresses;
279
280   /**
281    * Number of active addresses for solver
282    */
283   unsigned int active_addresses;
284
285   /**
286    * Networks array
287    */
288   struct Network *network_entries;
289
290   /**
291    * Number of networks
292    */
293   unsigned int network_count;
294
295 };
296
297 /**
298  * Representation of a network
299  */
300 struct Network
301 {
302   /**
303    * ATS network type
304    */
305   unsigned int type;
306
307   /**
308    * Network description
309    */
310   char *desc;
311
312   /**
313    * Total inbound quota
314    *
315    */
316   unsigned long long total_quota_in;
317
318   /**
319    * Total outbound quota
320    *
321    */
322   unsigned long long total_quota_out;
323
324   /**
325    * Number of active addresses for this network
326    */
327   unsigned int active_addresses;
328
329   /**
330    * Number of total addresses for this network
331    */
332   unsigned int total_addresses;
333
334   /**
335    * String for statistics total addresses
336    */
337   char *stat_total;
338
339   /**
340    * String for statistics active addresses
341    */
342   char *stat_active;
343
344   struct AddressWrapper *head;
345   struct AddressWrapper *tail;
346 };
347
348 /**
349  * Address information stored in the solver
350  */
351 struct AddressSolverInformation
352 {
353   struct Network *network;
354
355   /**
356    * Inbound quota
357    *
358    */
359   unsigned long long calculated_quota_in_NBO;
360
361   /**
362    * Outbound quota
363    *
364    */
365   unsigned long long calculated_quota_out_NBO;
366
367
368 };
369
370 /**
371  * Wrapper for addresses to store them in network's linked list
372  */
373 struct AddressWrapper
374 {
375   /**
376    * Next in DLL
377    */
378   struct AddressWrapper *next;
379
380   /**
381    * Previous in DLL
382    */
383   struct AddressWrapper *prev;
384
385   /**
386    * The address
387    */
388   struct ATS_Address *addr;
389 };
390
391 /**
392  *  Important solver functions
393  *  ---------------------------
394  */
395
396 void *
397 libgnunet_plugin_ats_proportional_init (void *cls)
398 {
399   struct GNUNET_ATS_PluginEnvironment *env = cls;
400   struct GAS_PROPORTIONAL_Handle *s;
401   struct Network * cur;
402   char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
403   int c;
404
405   GNUNET_assert (NULL != env);
406   GNUNET_assert(NULL != env->cfg);
407   GNUNET_assert(NULL != env->bandwidth_changed_cb);
408   GNUNET_assert(NULL != env->get_preferences);
409   GNUNET_assert(NULL != env->get_property);
410
411   s = GNUNET_new (struct GAS_PROPORTIONAL_Handle);
412   s->env = env;
413   env->sf.s_add = &GAS_proportional_address_add;
414   env->sf.s_address_update_property = &GAS_proportional_address_property_changed;
415   env->sf.s_address_update_session = &GAS_proportional_address_session_changed;
416   env->sf.s_address_update_inuse = &GAS_proportional_address_inuse_changed;
417   env->sf.s_address_update_network = &GAS_proportional_address_change_network;
418   env->sf.s_get = &GAS_proportional_get_preferred_address;
419   env->sf.s_get_stop = &GAS_proportional_stop_get_preferred_address;
420   env->sf.s_pref = &GAS_proportional_address_change_preference;
421   env->sf.s_feedback = &GAS_proportional_address_preference_feedback;
422   env->sf.s_del = &GAS_proportional_address_delete;
423   env->sf.s_bulk_start = &GAS_proportional_bulk_start;
424   env->sf.s_bulk_stop = &GAS_proportional_bulk_stop;
425
426   s->stats = (struct GNUNET_STATISTICS_Handle *) env->stats;
427   s->bw_changed = env->bandwidth_changed_cb;
428   s->bw_changed_cls = env->bw_changed_cb_cls;
429   s->get_preferences = env->get_preferences;
430   s->get_preferences_cls = env->get_preference_cls;
431   s->get_properties = env->get_property;
432   s->get_properties_cls = env->get_property_cls;
433   s->network_count = env->network_count;
434   s->network_entries = GNUNET_malloc (env->network_count * sizeof (struct Network));
435
436   /* Init */
437   s->active_addresses = 0;
438   s->total_addresses = 0;
439   s->bulk_lock = GNUNET_NO;
440   s->addresses = env->addresses;
441   s->requests = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
442
443   for (c = 0; c < env->network_count; c++)
444   {
445     cur = &s->network_entries[c];
446     cur->total_addresses = 0;
447     cur->active_addresses = 0;
448     cur->type = env->networks[c];
449     cur->total_quota_in = env->in_quota[c];
450     cur->total_quota_out = env->out_quota[c];
451     cur->desc = net_str[c];
452     GNUNET_asprintf (&cur->stat_total,
453         "# ATS addresses %s total", cur->desc);
454     GNUNET_asprintf (&cur->stat_active,
455         "# ATS active addresses %s total", cur->desc);
456     LOG (GNUNET_ERROR_TYPE_INFO, "Added network %u `%s' (%llu/%llu)\n",
457         c, cur->desc, cur->total_quota_in, cur->total_quota_out);
458   }
459   return s;
460 }
461
462 void *
463 libgnunet_plugin_ats_proportional_done (void *cls)
464 {
465   struct GAS_PROPORTIONAL_Handle *s = cls;
466   struct AddressWrapper *cur;
467   struct AddressWrapper *next;
468   int c;
469   GNUNET_assert(s != NULL);
470   for (c = 0; c < s->network_count; c++)
471   {
472     if (s->network_entries[c].total_addresses > 0)
473     {
474       LOG(GNUNET_ERROR_TYPE_DEBUG,
475           "Had %u addresses for network `%s' not deleted during shutdown\n",
476           s->network_entries[c].total_addresses, s->network_entries[c].desc);
477       //GNUNET_break(0);
478     }
479
480     if (s->network_entries[c].active_addresses > 0)
481     {
482       LOG(GNUNET_ERROR_TYPE_DEBUG,
483           "Had %u active addresses for network `%s' not deleted during shutdown\n",
484           s->network_entries[c].active_addresses, s->network_entries[c].desc);
485       //GNUNET_break(0);
486     }
487
488     next = s->network_entries[c].head;
489     while (NULL != (cur = next))
490     {
491       next = cur->next;
492       GNUNET_CONTAINER_DLL_remove(s->network_entries[c].head,
493           s->network_entries[c].tail, cur);
494       GNUNET_free_non_null (cur->addr->solver_information);
495       GNUNET_free(cur);
496     }
497     GNUNET_free(s->network_entries[c].stat_total);
498     GNUNET_free(s->network_entries[c].stat_active);
499   }
500   if (s->total_addresses > 0)
501   {
502     LOG(GNUNET_ERROR_TYPE_DEBUG,
503         "Had %u addresses not deleted during shutdown\n", s->total_addresses);
504     // GNUNET_break(0);
505   }
506   if (s->active_addresses > 0)
507   {
508     LOG(GNUNET_ERROR_TYPE_DEBUG,
509         "Had %u active addresses not deleted during shutdown\n",
510         s->active_addresses);
511     // GNUNET_break (0);
512   }
513   GNUNET_free (s->network_entries);
514   GNUNET_CONTAINER_multipeermap_destroy (s->requests);
515   GNUNET_free (s);
516   return NULL;
517 }
518
519
520 /**
521  * Test if bandwidth is available in this network to add an additional address
522  *
523  * @param net the network type to update
524  * @return GNUNET_YES or GNUNET_NO
525  */
526 static int
527 is_bandwidth_available_in_network (struct Network *net)
528 {
529   GNUNET_assert(NULL != net);
530   unsigned int na = net->active_addresses + 1;
531   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
532   if (((net->total_quota_in / na) > min_bw)
533       && ((net->total_quota_out / na) > min_bw))
534   {
535     LOG(GNUNET_ERROR_TYPE_DEBUG,
536         "Enough bandwidth available for %u active addresses in network `%s'\n",
537         na, net->desc);
538
539     return GNUNET_YES;
540   }
541   LOG(GNUNET_ERROR_TYPE_DEBUG,
542       "Not enough bandwidth available for %u active addresses in network `%s'\n",
543       na, net->desc);
544   return GNUNET_NO;
545 }
546
547 /**
548  * Update bandwidth assigned to peers in this network
549  *
550  * @param s the solver handle
551  * @param net the network type to update
552  * @param address_except address excluded from notification, since we suggest
553  * this address
554  */
555 static void
556 distribute_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
557     struct Network *net, struct ATS_Address *address_except)
558 {
559   struct AddressSolverInformation *asi;
560   struct AddressWrapper *cur;
561
562   unsigned long long remaining_quota_in = 0;
563   unsigned long long quota_out_used = 0;
564   unsigned long long remaining_quota_out = 0;
565   unsigned long long quota_in_used = 0;
566   uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
567   double peer_prefs;
568   double total_prefs; /* Important: has to be double not float due to precision */
569   double cur_pref; /* Important: has to be double not float due to precision */
570   const double *t = NULL; /* Important: has to be double not float due to precision */
571   int c;
572   unsigned long long assigned_quota_in = 0;
573   unsigned long long assigned_quota_out = 0;
574
575
576   LOG(GNUNET_ERROR_TYPE_DEBUG,
577       "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
578       net->desc, net->active_addresses, net->total_quota_in,
579       net->total_quota_in);
580
581   if (net->active_addresses == 0)
582     return; /* no addresses to update */
583
584   /* Idea
585    * Assign every peer in network minimum Bandwidth
586    * Distribute bandwidth left according to preference
587    */
588
589   if ((net->active_addresses * min_bw) > net->total_quota_in)
590   {
591     GNUNET_break(0);
592     return;
593   }
594   if ((net->active_addresses * min_bw) > net->total_quota_out)
595   {
596     GNUNET_break(0);
597     return;
598   }
599
600   remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
601   remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
602   LOG(GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
603       remaining_quota_in, remaining_quota_out);
604   total_prefs = 0.0;
605   for (cur = net->head; NULL != cur; cur = cur->next)
606   {
607     if (GNUNET_YES == cur->addr->active)
608     {
609       GNUNET_assert(
610           NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
611
612       peer_prefs = 0.0;
613       for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
614       {
615         if (c != GNUNET_ATS_PREFERENCE_END)
616         {
617           //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
618           peer_prefs += t[c];
619         }
620       }
621       total_prefs += (peer_prefs / (GNUNET_ATS_PreferenceCount - 1));
622     }
623   }
624   for (cur = net->head; NULL != cur; cur = cur->next)
625   {
626     if (GNUNET_YES == cur->addr->active)
627     {
628       cur_pref = 0.0;
629       GNUNET_assert(
630           NULL != (t = s->get_preferences (s->get_preferences_cls, &cur->addr->peer)));
631
632       for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
633       {
634         if (c != GNUNET_ATS_PREFERENCE_END)
635           cur_pref += t[c];
636       }
637       cur_pref /= 2;
638
639       assigned_quota_in = min_bw
640           + ((cur_pref / total_prefs) * remaining_quota_in);
641       assigned_quota_out = min_bw
642           + ((cur_pref / total_prefs) * remaining_quota_out);
643
644       LOG(GNUNET_ERROR_TYPE_DEBUG,
645           "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
646           GNUNET_i2s (&cur->addr->peer), cur_pref, total_prefs,
647           assigned_quota_in, assigned_quota_out);
648     }
649     else
650     {
651       assigned_quota_in = 0;
652       assigned_quota_out = 0;
653     }
654
655     quota_in_used += assigned_quota_in;
656     quota_out_used += assigned_quota_out;
657     /* Prevent overflow due to rounding errors */
658     if (assigned_quota_in > UINT32_MAX)
659       assigned_quota_in = UINT32_MAX;
660     if (assigned_quota_out > UINT32_MAX)
661       assigned_quota_out = UINT32_MAX;
662
663     /* Compare to current bandwidth assigned */
664     asi = cur->addr->solver_information;
665     asi->calculated_quota_in_NBO = htonl (assigned_quota_in);
666     asi->calculated_quota_out_NBO = htonl (assigned_quota_out);
667   }
668   LOG(GNUNET_ERROR_TYPE_DEBUG,
669       "Total bandwidth assigned is (in/out): %llu /%llu\n", quota_in_used,
670       quota_out_used);
671   if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
672   {
673     LOG(GNUNET_ERROR_TYPE_ERROR,
674         "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
675         net->active_addresses, quota_out_used, net->total_quota_out);
676   }
677   if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
678   {
679     LOG(GNUNET_ERROR_TYPE_ERROR,
680         "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
681         net->active_addresses, quota_in_used, net->total_quota_in);
682   }
683 }
684
685 struct FindBestAddressCtx
686 {
687   struct GAS_PROPORTIONAL_Handle *s;
688   struct ATS_Address *best;
689 };
690
691 static int
692 find_property_index (uint32_t type)
693 {
694   int existing_types[] = GNUNET_ATS_QualityProperties;
695   int c;
696   for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
697     if (existing_types[c] == type)
698       return c;
699   return GNUNET_SYSERR;
700 }
701
702 /**
703  * Find a "good" address to use for a peer by iterating over the addresses for this peer.
704  * If we already have an existing address, we stick to it.
705  * Otherwise, we pick by lowest distance and then by lowest latency.
706  *
707  * @param cls the 'struct ATS_Address**' where we store the result
708  * @param key unused
709  * @param value another 'struct ATS_Address*' to consider using
710  * @return GNUNET_OK (continue to iterate)
711  */
712 static int
713 find_best_address_it (void *cls,
714                       const struct GNUNET_PeerIdentity *key,
715                       void *value)
716 {
717   struct FindBestAddressCtx *ctx = (struct FindBestAddressCtx *) cls;
718   struct ATS_Address *current = (struct ATS_Address *) value;
719   struct ATS_Address *current_best = (struct ATS_Address *) value;
720   struct GNUNET_TIME_Absolute now;
721   struct AddressSolverInformation *asi;
722   const double *norm_prop_cur;
723   const double *norm_prop_best;
724   int index;
725
726   current_best = NULL;
727   asi = current->solver_information;
728   now = GNUNET_TIME_absolute_get ();
729
730   if (current->blocked_until.abs_value_us
731       == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value_us)
732   {
733     /* This address is blocked for suggestion */
734     LOG(GNUNET_ERROR_TYPE_DEBUG, "Address %p blocked for suggestion for %s \n",
735         current,
736         GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_difference (now, current->blocked_until), GNUNET_YES));
737     return GNUNET_OK;
738   }
739   if (NULL == asi)
740   {
741     GNUNET_break (0);
742     return GNUNET_OK;
743   }
744
745   if (GNUNET_NO == is_bandwidth_available_in_network (asi->network))
746     return GNUNET_OK; /* There's no bandwidth available in this network */
747
748   if (NULL != ctx->best)
749   {
750     /* Compare current addresses with denominated 'best' address */
751
752     current_best = ctx->best;
753     if ((0 != ctx->best->addr_len) && (0 == current->addr_len))
754     {
755       /* saved address was an outbound address, but we have an inbound address */
756       current_best = current;
757       goto end;
758     }
759     if (ctx->best->t_last_activity.abs_value_us < current->t_last_activity.abs_value_us)
760     {
761       /* Current address is newer */
762       current_best = current;
763     }
764     if (ctx->best->t_added.abs_value_us < current->t_added.abs_value_us)
765     {
766       /* Current address is newer */
767       current_best = current;
768       goto end;
769     }
770   }
771   if (NULL == ctx->best)
772   {
773     /* We do not have a 'best' address so take this address */
774     current_best = current;
775     goto end;
776   }
777
778   if ( (ntohl (ctx->best->assigned_bw_in.value__) == 0) &&
779        (ntohl (current->assigned_bw_in.value__) > 0) )
780   {
781     /* stick to existing connection */
782     current_best = current;
783   }
784
785   /* Now compare ATS information */
786   norm_prop_cur = ctx->s->get_properties (ctx->s->get_properties_cls,
787       (const struct ATS_Address *) current);
788   norm_prop_best = ctx->s->get_properties (ctx->s->get_properties_cls,
789       (const struct ATS_Address *) ctx->best);
790
791   index = find_property_index (GNUNET_ATS_QUALITY_NET_DISTANCE);
792   if (GNUNET_SYSERR != index)
793   {
794     /* user shorter distance */
795     if (norm_prop_cur[index] < norm_prop_best[index])
796       current_best = current;
797     else
798       current_best = ctx->best;
799   }
800
801   index = find_property_index (GNUNET_ATS_QUALITY_NET_DELAY);
802   if (GNUNET_SYSERR != index)
803   {
804     /* User connection with less delay */
805     if (norm_prop_cur[index] < norm_prop_best[index])
806       current_best = current;
807     else
808       current_best = ctx->best;
809   }
810 end:
811   ctx->best = current_best;
812   return GNUNET_OK;
813 }
814
815 /**
816  *  Helper functions
817  *  ---------------------------
818  */
819 static void
820 propagate_bandwidth (struct GAS_PROPORTIONAL_Handle *s,
821     struct Network *net, struct ATS_Address *address_except)
822 {
823   struct AddressWrapper *cur;
824   struct AddressSolverInformation *asi;
825   for (cur = net->head; NULL != cur; cur = cur->next)
826   {
827       asi = cur->addr->solver_information;
828       if ( (cur->addr->assigned_bw_in.value__ != asi->calculated_quota_in_NBO) ||
829            (cur->addr->assigned_bw_out.value__ != asi->calculated_quota_out_NBO) )
830       {
831         cur->addr->assigned_bw_in.value__ = asi->calculated_quota_in_NBO;
832         cur->addr->assigned_bw_out.value__ = asi->calculated_quota_in_NBO;
833         /* Notify on change */
834         if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
835           s->bw_changed (s->bw_changed_cls, cur->addr);
836       }
837   }
838 }
839
840 /**
841  * Distribibute bandwidth
842  *
843  * @param s the solver handle
844  * @param n the network, can be NULL for all network
845  * @param address_except do not notify for this address
846  */
847 static void
848 distribute_bandwidth_in_network (struct GAS_PROPORTIONAL_Handle *s,
849     struct Network *n, struct ATS_Address *address_except)
850 {
851   if (GNUNET_YES == s->bulk_lock)
852   {
853     s->bulk_requests++;
854     return;
855   }
856
857   if (NULL != n)
858   {
859     if (NULL != s->env->info_cb)
860       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
861           GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
862     distribute_bandwidth(s, n, address_except);
863     if (NULL != s->env->info_cb)
864       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
865           GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
866     if (NULL != s->env->info_cb)
867       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
868           GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
869     propagate_bandwidth(s, n, address_except);
870     if (NULL != s->env->info_cb)
871       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
872           GAS_STAT_SUCCESS, GAS_INFO_PROP_SINGLE);
873   }
874   else
875   {
876     int i;
877     if (NULL != s->env->info_cb)
878       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_START,
879           GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
880     for (i = 0; i < s->network_count; i++)
881       distribute_bandwidth(s, &s->network_entries[i], NULL);
882     if (NULL != s->env->info_cb)
883       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_STOP,
884           GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
885     if (NULL != s->env->info_cb)
886       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
887           GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
888     for (i = 0; i < s->network_count; i++)
889     {
890       propagate_bandwidth(s, &s->network_entries[i], address_except);
891     }
892     if (NULL != s->env->info_cb)
893       s->env->info_cb(s->env->info_cb_cls, GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP,
894           GAS_STAT_SUCCESS, GAS_INFO_PROP_ALL);
895   }
896 }
897
898 /**
899  * Lookup network struct by type
900  *
901  * @param s the solver handle
902  * @param type the network type
903  * @return the network struct
904  */
905 static struct Network *
906 get_network (struct GAS_PROPORTIONAL_Handle *s, uint32_t type)
907 {
908   int c;
909   for (c = 0; c < s->network_count; c++)
910   {
911     fprintf (stderr, "%u == %u \n", s->network_entries[c].type,type);
912     if (s->network_entries[c].type == type)
913       return &s->network_entries[c];
914   }
915   return NULL ;
916 }
917
918 /**
919  * Hashmap Iterator to find current active address for peer
920  *
921  * @param cls last active address
922  * @param key peer's key
923  * @param value address to check
924  * @return #GNUNET_NO on double active address else #GNUNET_YES;
925  */
926 static int
927 get_active_address_it (void *cls,
928                        const struct GNUNET_PeerIdentity *key,
929                        void *value)
930 {
931   struct ATS_Address **dest = cls;
932   struct ATS_Address *aa = (struct ATS_Address *) value;
933
934   if (GNUNET_YES == aa->active)
935   {
936
937     if (NULL != (*dest))
938     {
939       /* should never happen */
940       LOG(GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n",
941           GNUNET_i2s (&aa->peer));
942       GNUNET_break(0);
943       return GNUNET_NO;
944     }
945     (*dest) = aa;
946   }
947   return GNUNET_OK;
948 }
949
950 /**
951  * Find current active address for peer
952  *
953  * @param solver the solver handle
954  * @param addresses the address set
955  * @param peer the peer
956  * @return active address or NULL
957  */
958 static struct ATS_Address *
959 get_active_address (void *solver,
960                     const struct GNUNET_CONTAINER_MultiPeerMap * addresses,
961                     const struct GNUNET_PeerIdentity *peer)
962 {
963   struct ATS_Address * dest = NULL;
964
965   GNUNET_CONTAINER_multipeermap_get_multiple (addresses, peer,
966                                               &get_active_address_it, &dest);
967   return dest;
968 }
969
970
971 static void
972 addresse_increment (struct GAS_PROPORTIONAL_Handle *s, struct Network *net,
973     int total, int active)
974 {
975   if (GNUNET_YES == total)
976   {
977     s->total_addresses++;
978     net->total_addresses++;
979     GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
980     GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
981   }
982   if (GNUNET_YES == active)
983   {
984     net->active_addresses++;
985     s->active_addresses++;
986     GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1,
987         GNUNET_NO);
988     GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
989   }
990
991 }
992
993
994 static int
995 addresse_decrement (struct GAS_PROPORTIONAL_Handle *s, struct Network *net,
996     int total, int active)
997 {
998   int res = GNUNET_OK;
999   if (GNUNET_YES == total)
1000   {
1001     if (s->total_addresses < 1)
1002     {
1003       GNUNET_break(0);
1004       res = GNUNET_SYSERR;
1005     }
1006     else
1007     {
1008       s->total_addresses--;
1009       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1010           GNUNET_NO);
1011     }
1012     if (net->total_addresses < 1)
1013     {
1014       GNUNET_break(0);
1015       res = GNUNET_SYSERR;
1016     }
1017     else
1018     {
1019       net->total_addresses--;
1020       GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
1021     }
1022   }
1023
1024   if (GNUNET_YES == active)
1025   {
1026     if (net->active_addresses < 1)
1027     {
1028       GNUNET_break(0);
1029       res = GNUNET_SYSERR;
1030     }
1031     else
1032     {
1033       net->active_addresses--;
1034       GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
1035     }
1036     if (s->active_addresses < 1)
1037     {
1038       GNUNET_break(0);
1039       res = GNUNET_SYSERR;
1040     }
1041     else
1042     {
1043       s->active_addresses--;
1044       GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1,
1045           GNUNET_NO);
1046     }
1047   }
1048   return res;
1049 }
1050
1051 /**
1052  *  Solver API functions
1053  *  ---------------------------
1054  */
1055
1056 /**
1057  * Changes the preferences for a peer in the problem
1058  *
1059  * @param solver the solver handle
1060  * @param peer the peer to change the preference for
1061  * @param kind the kind to change the preference
1062  * @param pref_rel the normalized preference value for this kind over all clients
1063  */
1064 void
1065 GAS_proportional_address_change_preference (void *solver,
1066                                             const struct GNUNET_PeerIdentity *peer,
1067                                             enum GNUNET_ATS_PreferenceKind kind,
1068                                             double pref_rel)
1069 {
1070   struct GAS_PROPORTIONAL_Handle *s = solver;
1071   GNUNET_assert(NULL != solver);
1072   GNUNET_assert(NULL != peer);
1073
1074   distribute_bandwidth_in_network (s, NULL, NULL);
1075 }
1076
1077
1078 /**
1079  * Get application feedback for a peer
1080  *
1081  * @param solver the solver handle
1082  * @param application the application
1083  * @param peer the peer to change the preference for
1084  * @param scope the time interval for this feedback: [now - scope .. now]
1085  * @param kind the kind to change the preference
1086  * @param score the score
1087  */
1088 void
1089 GAS_proportional_address_preference_feedback (void *solver, void *application,
1090     const struct GNUNET_PeerIdentity *peer,
1091     const struct GNUNET_TIME_Relative scope,
1092     enum GNUNET_ATS_PreferenceKind kind, double score)
1093 {
1094   struct GAS_PROPORTIONAL_Handle *s = solver;
1095   GNUNET_assert(NULL != solver);
1096   GNUNET_assert(NULL != peer);
1097
1098   GNUNET_assert(NULL != s);
1099   GNUNET_break(0);
1100 }
1101
1102 /**
1103  * Get the preferred address for a specific peer
1104  *
1105  * @param solver the solver handle
1106  * @param peer the identity of the peer
1107  */
1108 const struct ATS_Address *
1109 GAS_proportional_get_preferred_address (void *solver,
1110     const struct GNUNET_PeerIdentity *peer)
1111 {
1112   struct GAS_PROPORTIONAL_Handle *s = solver;
1113   struct Network *net_prev;
1114   struct Network *net_cur;
1115   struct ATS_Address *prev;
1116   struct FindBestAddressCtx fba_ctx;
1117   struct AddressSolverInformation *asi;
1118   struct AddressSolverInformation *asi_prev;
1119
1120   GNUNET_assert(s != NULL);
1121   GNUNET_assert(peer != NULL);
1122
1123   /* Add to list of pending requests */
1124   if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (s->requests,
1125                                                            peer))
1126   {
1127     GNUNET_assert (GNUNET_OK ==
1128                    GNUNET_CONTAINER_multipeermap_put (s->requests,
1129                                                       peer, NULL,
1130                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1131   }
1132
1133   /* Get address with: stick to current address, lower distance, lower latency */
1134   fba_ctx.s = s;
1135   fba_ctx.best = NULL;
1136
1137   GNUNET_CONTAINER_multipeermap_get_multiple (s->addresses, peer,
1138                                               &find_best_address_it, &fba_ctx);
1139   if (NULL == fba_ctx.best)
1140   {
1141     LOG(GNUNET_ERROR_TYPE_INFO, "Cannot suggest address for peer `%s'\n",
1142         GNUNET_i2s (peer));
1143     return NULL ;
1144   }
1145
1146   LOG(GNUNET_ERROR_TYPE_INFO, "Suggesting %s address %p for peer `%s'\n",
1147       (GNUNET_NO == fba_ctx.best->active) ? "inactive" : "active", fba_ctx.best,
1148       GNUNET_i2s (peer));
1149   asi = fba_ctx.best->solver_information;
1150   net_cur = asi->network ;
1151   if (NULL == fba_ctx.best)
1152   {
1153     LOG(GNUNET_ERROR_TYPE_ERROR,
1154         "Trying to suggesting unknown address peer `%s'\n", GNUNET_i2s (peer));
1155     GNUNET_break(0);
1156     return NULL ;
1157   }
1158   if (GNUNET_YES == fba_ctx.best->active)
1159   {
1160     /* This address was selected previously, so no need to update quotas */
1161     return fba_ctx.best;
1162   }
1163
1164   /* This address was not active, so we have to:
1165    *
1166    * - mark previous active address as not active
1167    * - update quota for previous address network
1168    * - update quota for this address network
1169    */
1170   prev = get_active_address (s, s->addresses, peer);
1171   if (NULL != prev)
1172   {
1173     asi_prev = prev->solver_information;
1174     net_prev = (struct Network *) asi_prev->network;
1175     prev->active = GNUNET_NO; /* No active any longer */
1176     prev->assigned_bw_in = BANDWIDTH_ZERO; /* no bandwidth assigned */
1177     prev->assigned_bw_out = BANDWIDTH_ZERO; /* no bandwidth assigned */
1178     if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
1179       GNUNET_break(0);
1180     distribute_bandwidth_in_network (s, net_prev, NULL);
1181   }
1182
1183   if (GNUNET_NO == (is_bandwidth_available_in_network (net_cur)))
1184   {
1185     GNUNET_break(0); /* This should never happen*/
1186     return NULL ;
1187   }
1188
1189   fba_ctx.best->active = GNUNET_YES;
1190   addresse_increment (s, net_cur, GNUNET_NO, GNUNET_YES);
1191   distribute_bandwidth_in_network (s, net_cur, fba_ctx.best);
1192   return fba_ctx.best;
1193 }
1194
1195 /**
1196  * Stop notifying about address and bandwidth changes for this peer
1197  *
1198  * @param solver the solver handle
1199  * @param peer the peer
1200  */
1201 void
1202 GAS_proportional_stop_get_preferred_address (void *solver,
1203     const struct GNUNET_PeerIdentity *peer)
1204 {
1205   struct GAS_PROPORTIONAL_Handle *s = solver;
1206   struct ATS_Address *cur;
1207   struct AddressSolverInformation *asi;
1208   struct Network *cur_net;
1209
1210   if (GNUNET_YES
1211       == GNUNET_CONTAINER_multipeermap_contains (s->requests,
1212                                                  peer))
1213     GNUNET_assert (GNUNET_OK == GNUNET_CONTAINER_multipeermap_remove (s->requests, peer,
1214                                           NULL));
1215
1216   cur = get_active_address (s,
1217                             s->addresses, peer);
1218   if (NULL != cur)
1219   {
1220     /* Disabling current address */
1221     asi = cur->solver_information;
1222     cur_net = asi->network ;
1223     cur->active = GNUNET_NO; /* No active any longer */
1224     cur->assigned_bw_in = BANDWIDTH_ZERO; /* no bandwidth assigned */
1225     cur->assigned_bw_out = BANDWIDTH_ZERO; /* no bandwidth assigned */
1226     if (GNUNET_SYSERR == addresse_decrement (s, cur_net, GNUNET_NO, GNUNET_YES))
1227       GNUNET_break(0);
1228     distribute_bandwidth_in_network (s, cur_net, NULL );
1229   }
1230   return;
1231 }
1232
1233 /**
1234  * Remove an address from the solver
1235  *
1236  * @param solver the solver handle
1237  * @param address the address to remove
1238  * @param session_only delete only session not whole address
1239  */
1240 void
1241 GAS_proportional_address_delete (void *solver, struct ATS_Address *address,
1242     int session_only)
1243 {
1244   struct GAS_PROPORTIONAL_Handle *s = solver;
1245   struct Network *net;
1246   struct AddressWrapper *aw;
1247   struct AddressSolverInformation *asi;
1248   const struct ATS_Address *new_address;
1249
1250
1251   /* Remove an adress completely, we have to:
1252    * - Remove from specific network
1253    * - Decrease number of total addresses
1254    * - If active:
1255    *   - decrease number of active addreses
1256    *   - update quotas
1257    */
1258   asi = address->solver_information;
1259
1260   if (NULL == asi)
1261   {
1262     GNUNET_break (0);
1263     return;
1264   }
1265
1266   net = asi->network;
1267
1268   if (GNUNET_NO == session_only)
1269   {
1270     LOG(GNUNET_ERROR_TYPE_INFO,
1271         "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1272         (GNUNET_NO == address->active) ? "inactive" : "active", address,
1273         GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1274         net->active_addresses);
1275
1276     /* Remove address */
1277     addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
1278     for (aw = net->head; NULL != aw; aw = aw->next)
1279     {
1280       if (aw->addr == address)
1281         break;
1282     }
1283     if (NULL == aw)
1284     {
1285       GNUNET_break(0);
1286       return;
1287     }
1288     GNUNET_CONTAINER_DLL_remove(net->head, net->tail, aw);
1289     GNUNET_free_non_null (aw->addr->solver_information);
1290     GNUNET_free(aw);
1291   }
1292   else
1293   {
1294     /* Remove session only: remove if active and update */
1295     LOG(GNUNET_ERROR_TYPE_INFO,
1296         "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
1297         (GNUNET_NO == address->active) ? "inactive" : "active", address,
1298         GNUNET_i2s (&address->peer), net->desc, net->total_addresses,
1299         net->active_addresses);
1300   }
1301
1302   if (GNUNET_YES == address->active)
1303   {
1304     /* Address was active, remove from network and update quotas*/
1305     address->active = GNUNET_NO;
1306     address->assigned_bw_in = BANDWIDTH_ZERO;
1307     address->assigned_bw_out = BANDWIDTH_ZERO;
1308
1309     if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
1310       GNUNET_break(0);
1311     distribute_bandwidth_in_network (s, net, NULL);
1312     if (NULL == (new_address = GAS_proportional_get_preferred_address (s, &address->peer)))
1313     {
1314       /* No alternative address found, disconnect peer */
1315       s->bw_changed (s->bw_changed_cls, address);
1316     }
1317     else
1318     {
1319       s->bw_changed (s->bw_changed_cls, (struct ATS_Address *) new_address);
1320     }
1321   }
1322   LOG(GNUNET_ERROR_TYPE_INFO,
1323       "After deleting address now total %u and active %u addresses in network `%s'\n",
1324       net->total_addresses, net->active_addresses, net->desc);
1325
1326 }
1327
1328 /**
1329  * Start a bulk operation
1330  *
1331  * @param solver the solver
1332  */
1333 void
1334 GAS_proportional_bulk_start (void *solver)
1335 {
1336   LOG(GNUNET_ERROR_TYPE_DEBUG, "Locking solver for bulk operation ...\n");
1337   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1338
1339   GNUNET_assert(NULL != solver);
1340   s->bulk_lock++;
1341 }
1342
1343
1344 /**
1345  * Bulk operation done
1346  */
1347 void
1348 GAS_proportional_bulk_stop (void *solver)
1349 {
1350   LOG(GNUNET_ERROR_TYPE_DEBUG, "Unlocking solver from bulk operation ...\n");
1351
1352   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1353   GNUNET_assert(NULL != solver);
1354
1355   if (s->bulk_lock < 1)
1356   {
1357     GNUNET_break(0);
1358     return;
1359   }
1360   s->bulk_lock--;
1361   if ((0 == s->bulk_lock) && (0 < s->bulk_requests))
1362   {
1363     LOG(GNUNET_ERROR_TYPE_DEBUG, "No lock pending, recalculating\n");
1364     distribute_bandwidth_in_network (s, NULL, NULL);
1365     s->bulk_requests = 0;
1366   }
1367 }
1368
1369
1370 /**
1371  * Add a new single address to a network
1372  *
1373  * @param solver the solver Handle
1374  * @param address the address to add
1375  * @param network network type of this address
1376  */
1377 void
1378 GAS_proportional_address_add (void *solver, struct ATS_Address *address,
1379     uint32_t network);
1380
1381 /**
1382  * Transport properties for this address have changed
1383  *
1384  * @param solver solver handle
1385  * @param address the address
1386  * @param type the ATSI type in HBO
1387  * @param abs_value the absolute value of the property
1388  * @param rel_value the normalized value
1389  */
1390 void
1391 GAS_proportional_address_property_changed (void *solver,
1392     struct ATS_Address *address, uint32_t type, uint32_t abs_value,
1393     double rel_value)
1394 {
1395   struct GAS_PROPORTIONAL_Handle *s;
1396   struct Network *n;
1397   struct AddressSolverInformation *asi;
1398
1399   GNUNET_assert(NULL != solver);
1400   GNUNET_assert(NULL != address);
1401
1402   s = (struct GAS_PROPORTIONAL_Handle *) solver;
1403   asi = address->solver_information;
1404   if (NULL == asi)
1405   {
1406     GNUNET_break(0);
1407     return;
1408   }
1409
1410   n = asi->network;
1411
1412   if (NULL == n)
1413   {
1414     GNUNET_break(0);
1415     return;
1416   }
1417
1418   LOG(GNUNET_ERROR_TYPE_DEBUG,
1419       "Property `%s' for peer `%s' address %p changed to %.2f \n",
1420       GNUNET_ATS_print_property_type (type), GNUNET_i2s (&address->peer),
1421       address, rel_value);
1422   switch (type)
1423   {
1424   case GNUNET_ATS_UTILIZATION_OUT:
1425   case GNUNET_ATS_UTILIZATION_IN:
1426   case GNUNET_ATS_UTILIZATION_PAYLOAD_IN:
1427   case GNUNET_ATS_UTILIZATION_PAYLOAD_OUT:
1428   case GNUNET_ATS_QUALITY_NET_DELAY:
1429   case GNUNET_ATS_QUALITY_NET_DISTANCE:
1430   case GNUNET_ATS_COST_WAN:
1431   case GNUNET_ATS_COST_LAN:
1432   case GNUNET_ATS_COST_WLAN:
1433     distribute_bandwidth_in_network (s, n, NULL);
1434     break;
1435   }
1436 }
1437
1438 /**
1439  * Transport session for this address has changed
1440  *
1441  * NOTE: values in addresses are already updated
1442  *
1443  * @param solver solver handle
1444  * @param address the address
1445  * @param cur_session the current session
1446  * @param new_session the new session
1447  */
1448 void
1449 GAS_proportional_address_session_changed (void *solver,
1450     struct ATS_Address *address, uint32_t cur_session, uint32_t new_session)
1451 {
1452   if (cur_session != new_session)
1453   {
1454     LOG(GNUNET_ERROR_TYPE_DEBUG, "Session changed from %u to %u\n", cur_session,
1455         new_session);
1456   }
1457 }
1458
1459 /**
1460  * Usage for this address has changed
1461  *
1462  * NOTE: values in addresses are already updated
1463  *
1464  * @param solver solver handle
1465  * @param address the address
1466  * @param in_use usage state
1467  */
1468 void
1469 GAS_proportional_address_inuse_changed (void *solver,
1470     struct ATS_Address *address, int in_use)
1471 {
1472   LOG(GNUNET_ERROR_TYPE_DEBUG, "Usage changed to %s\n",
1473       (GNUNET_YES == in_use) ? "USED" : "UNUSED");
1474 }
1475
1476 /**
1477  * Network scope for this address has changed
1478  *
1479  * NOTE: values in addresses are already updated
1480  *
1481  * @param solver solver handle
1482  * @param address the address
1483  * @param current_network the current network
1484  * @param new_network the new network
1485  */
1486 void
1487 GAS_proportional_address_change_network (void *solver,
1488     struct ATS_Address *address, uint32_t current_network, uint32_t new_network)
1489 {
1490   struct GAS_PROPORTIONAL_Handle *s = (struct GAS_PROPORTIONAL_Handle *) solver;
1491   struct AddressSolverInformation *asi;
1492   int save_active = GNUNET_NO;
1493
1494   struct Network *new_net = NULL;
1495
1496   if (current_network == new_network)
1497   {
1498     GNUNET_break(0);
1499     return;
1500   }
1501
1502   asi = address->solver_information;
1503   if (NULL == asi)
1504   {
1505     GNUNET_break(0);
1506     return;
1507   }
1508
1509
1510   /* Network changed */
1511   LOG(GNUNET_ERROR_TYPE_DEBUG,
1512       "Network type changed, moving %s address from `%s' to `%s'\n",
1513       (GNUNET_YES == address->active) ? "active" : "inactive",
1514       GNUNET_ATS_print_network_type (current_network),
1515       GNUNET_ATS_print_network_type (new_network));
1516
1517   save_active = address->active;
1518
1519   /* Disable and assign no bandwidth */
1520   address->active = GNUNET_NO;
1521   address->assigned_bw_in = BANDWIDTH_ZERO; /* no bandwidth assigned */
1522   address->assigned_bw_out = BANDWIDTH_ZERO; /* no bandwidth assigned */
1523
1524   /* Remove from old network */
1525   GAS_proportional_address_delete (solver, address, GNUNET_NO);
1526
1527   /* Set new network type */
1528   if (NULL == (new_net = get_network (solver, new_network)))
1529   {
1530     /* Address changed to invalid network... */
1531     LOG(GNUNET_ERROR_TYPE_ERROR,
1532         _("Invalid network type `%u' `%s': Disconnect!\n"), new_network,
1533         GNUNET_ATS_print_network_type (new_network));
1534
1535     /* Find new address to suggest since no bandwidth in network*/
1536     if (NULL == GAS_proportional_get_preferred_address (s, &address->peer))
1537     {
1538       /* No alternative address found, disconnect peer */
1539       s->bw_changed (s->bw_changed_cls, address);
1540     }
1541     return;
1542   }
1543
1544   /* Add to new network and update*/
1545   asi->network = new_net;
1546   GAS_proportional_address_add (solver, address, new_network);
1547   if (GNUNET_YES == save_active)
1548   {
1549     /* check if bandwidth available in new network */
1550     if (GNUNET_YES == (is_bandwidth_available_in_network (new_net)))
1551     {
1552       /* Assign bandwidth to updated address */
1553       address->active = GNUNET_YES;
1554       addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1555       distribute_bandwidth_in_network (solver, new_net, NULL);
1556     }
1557     else
1558     {
1559       LOG(GNUNET_ERROR_TYPE_DEBUG,
1560           "Not enough bandwidth in new network, suggesting alternative address ..\n");
1561       /* Find new address to suggest since no bandwidth in network*/
1562       if (NULL == GAS_proportional_get_preferred_address (s, &address->peer))
1563       {
1564         /* No alternative address found, disconnect peer */
1565         s->bw_changed (s->bw_changed_cls, address);
1566       }
1567     }
1568   }
1569 }
1570
1571 /**
1572  * Add a new single address to a network
1573  *
1574  * @param solver the solver Handle
1575  * @param address the address to add
1576  * @param network network type of this address
1577  */
1578 void
1579 GAS_proportional_address_add (void *solver, struct ATS_Address *address,
1580     uint32_t network)
1581 {
1582   struct GAS_PROPORTIONAL_Handle *s = solver;
1583   struct Network *net = NULL;
1584   struct AddressWrapper *aw = NULL;
1585   struct AddressSolverInformation *asi;
1586
1587   GNUNET_assert(NULL != s);
1588   net = get_network (s, network);
1589   if (NULL == net)
1590   {
1591     GNUNET_break(0);
1592
1593     LOG(GNUNET_ERROR_TYPE_ERROR,
1594         "Unknown network %u `%s' for new address %p for peer `%s'\n",
1595         network, GNUNET_ATS_print_network_type(network),
1596         address, GNUNET_i2s(&address->peer));
1597
1598     return;
1599   }
1600
1601   aw = GNUNET_new (struct AddressWrapper);
1602   aw->addr = address;
1603   GNUNET_CONTAINER_DLL_insert(net->head, net->tail, aw);
1604   addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
1605
1606   asi = GNUNET_new (struct AddressSolverInformation);
1607   asi->network = net;
1608   asi->calculated_quota_in_NBO = 0;
1609   asi->calculated_quota_out_NBO = 0;
1610   aw->addr->solver_information = asi;
1611
1612   if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (s->requests, &address->peer))
1613   {
1614     if (NULL == get_active_address (s, s->addresses, &address->peer))
1615     {
1616       if (NULL != GAS_proportional_get_preferred_address (s, &address->peer))
1617           s->bw_changed (s->bw_changed_cls, (struct ATS_Address *) address);
1618     }
1619   }
1620
1621   LOG(GNUNET_ERROR_TYPE_INFO,
1622       "Adding new address %p for peer `%s', now total %u and active %u addresses in network `%s'\n",
1623       address, GNUNET_i2s(&address->peer), net->total_addresses, net->active_addresses, net->desc);
1624 }
1625
1626
1627 /* end of plugin_ats_proportional.c */