-cleanup
[oweals/gnunet.git] / src / ats / gnunet-service-ats_addresses.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_addresses.c
23  * @brief ats service address management
24  * @author Matthias Wachs
25  * @author Christian Grothoff
26  */
27 #include "platform.h"
28 #include "gnunet_ats_service.h"
29 #include "gnunet-service-ats.h"
30 #include "gnunet-service-ats_addresses.h"
31 #include "gnunet-service-ats_performance.h"
32 #include "gnunet-service-ats_scheduling.h"
33 #include "gnunet-service-ats_reservations.h"
34 #if HAVE_LIBGLPK
35 #include "gnunet-service-ats_addresses_mlp.h"
36 #endif
37 #include "gnunet-service-ats_addresses_simplistic.h"
38
39 /**
40  * NOTE: Do not change this documentation. This documentation is based on
41  * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
42  * use build_txt.sh to generate plaintext output
43  *
44  *   1 ATS addresses : ATS address management
45  *
46  *    This ATS addresses ("addresses") component manages the addresses known to
47  *    ATS service and suggests addresses to transport service when it is
48  *    interested in address suggestion for a peer. ATS addresses also
49  *    instantiates the bandwidth assignment mechanism (solver), notifies it
50  *    about changes to addresses and forwards changes to bandwidth assignments
51  *    to transport, depending if transport is interested in this change.
52  *
53  *     1.1 Input data
54  *
55  *       1.1.1 Addresses
56  *
57  *    Addresses are added by specifying peer ID, plugin, address, address length
58  *    and session, if available. ATS information can be specified if available.
59  *
60  *       1.1.2 Networks
61  *
62  *    ATS specifies a fix set of networks an address can belong to. For each
63  *    network an inbound and outbound quota will be specified. The available
64  *    networks and addtional helper varaibles are defined in
65  *    gnunet_ats_service.h. At the moment 5 networks are defined:
66  *      * GNUNET_ATS_NET_UNSPECIFIED
67  *      * GNUNET_ATS_NET_LOOPBACK
68  *      * GNUNET_ATS_NET_LAN
69  *      * GNUNET_ATS_NET_WAN
70  *      * GNUNET_ATS_NET_WLAN
71  *
72  *    The total number of networks defined is stored in
73  *    GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
74  *    initializer for an int array, while GNUNET_ATS_NetworkType is an
75  *    initializer for a char array containing a string description of all
76  *    networks
77  *
78  *       1.1.3 Quotas
79  *
80  *    An inbound and outbound quota for each of the networks mentioned in 1.1.2
81  *    is loaded from ats configuration during initialization. This quota defines
82  *    to total amount of inbound and outbound traffic allowed for a specific
83  *    network. The configuration values used are in section ats:
84  *      * "NETWORK"_QUOTA_IN = <value>
85  *      * "NETWORK"_QUOTA_IN = <value>
86  *
87  *    You can specify quotas by setting the <value> to a:
88  *      * unrestricted: unlimited
89  *      * number of bytes: e.g. 10240
90  *      * fancy value: e.g. 64 Kib
91  *
92  *    unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
93  *    the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
94  *    are:
95  *      * GNUNET_ATS_DefaultBandwidth: 65536
96  *      * GNUNET_ATS_MaxBandwidth: UINT32_MAX
97  *      * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
98  *
99  *    Details of loading quotas and default values will be described on
100  *
101  *       1.1.4 Preference values
102  *
103  *     1.2 Data structures used
104  *
105  *    Addresse uses struct ATS_Address for each address. The structs are stored
106  *    in a linked list and provides a pointer void *solver_information for the
107  *    solver to store address specific information. It provides the int values
108  *    active which is set to GNUNET_YES if the address is select for transport
109  *    use and used, representing that transport service is actively using this
110  *    address. Address information are stored in peer, addr, addr_len, plugin.
111  *
112  *     1.3 Initialization
113  *
114  *    During initialization a hashmap to store addresses is created. The quotas
115  *    for all networks defined for ATS are loaded from configuration. For each
116  *    network first the logic will check if the string
117  *    GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
118  *    the configured value as a fancy size and if this fails it will try to use
119  *    it as a value_number. If no configuration value is found it will assign
120  *    GNUNET_ATS_DefaultBandwidth. The most important step is to load the
121  *    configured solver using configuration "[ats]:MODE". Current solvers are
122  *    MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
123  *
124  *     1.4 Solver API
125  *
126  *    Solver functions:
127  *      * s_init: init the solver with required information
128  *      * s_add: add a new address
129  *      * s_update: update ATS values or session for an address
130  *      * s_get: get prefered address for a peer
131  *      * s_del: delete an address
132  *      * s_pref: change preference value for a peer
133  *      * s_done: shutdown solver
134  *
135  *    Callbacks: addresses provides a bandwidth_changed_cb callback to the
136  *    solver which is called when bandwidth assigned to peer has changed
137  *
138  *     1.5 Shutdown
139  *
140  *    During shutdown all addresses are freed and the solver told to shutdown
141  *
142  *     1.6 Addresses and sessions
143  *
144  *    Addresses consist of the address itself and a numerical session. When a
145  *    new address without a session is added it has no session, so it gets
146  *    session 0 assigned. When an address with a session is added and an address
147  *    object with session 0 is found, this object is updated with the session
148  *    otherwise a new address object with this session assigned is created.
149  *
150  *       1.6.1 Terminology
151  *
152  *    Addresses a1,a2 with session s1, s2 are "exact" if:
153  *    (a1 == a2)&&(s1 == s2)
154  *    Addresses a1,a2 with session s1, s2 are "equivalent" if:
155  *    (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
156  *
157  *     1.7 Address management
158  *
159  *    Transport service notifies ATS about changes to the addresses known to
160  *    him.
161  *
162  *       1.7.1 Adding an address
163  *
164  *    When transport learns a new address it tells ATS and ATS is telling
165  *    addresses about it using GAS_address_add. If not known to addresses it
166  *    creates a new address object and calls solver's s_add. ATS information are
167  *    deserialized and solver is notified about the session and ATS information
168  *    using s_update.
169  *
170  *       1.7.2 Updating an address
171  *
172  *    Addresses does an lookup up for the existing address with the given
173  *    session. If disassembles included ATS information and notifies the solver
174  *    using s_update about the update.
175  *
176  *       1.7.3 Deleting an address
177  *
178  *    Addresses does an lookup for the exact address and session and if removes
179  *    this address. If session != 0 the session is set to 0 and the address is
180  *    kept. If session == 0, the addresses is removed.
181  *
182  *       1.7.4 Requesting an address suggestion
183  *
184  *    The address client issues a request address message to be notified about
185  *    address suggestions for a specific peer. Addresses asks the solver with
186  *    s_get. If no address is available, it will not send a response, otherwise
187  *    it will respond with the choosen address.
188  *
189  *       1.7.5 Address suggestions
190  *
191  *    Addresses will notify the client automatically on any bandwidth_changed_cb
192  *    by the solver if a address suggestion request is pending. If no address is
193  *    available it will not respond at all If the client is not interested
194  *    anymore, it has to cancel the address suggestion request.
195  *
196  *       1.7.6 Suggestions blocks and reset
197  *
198  *    After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
199  *    prevent the client from being thrashed. If the client requires immediately
200  *    it can reset this block using GAS_addresses_handle_backoff_reset.
201  *
202  *       1.7.7 Marking address in use
203  *
204  *    The client can notify addresses that it successfully uses an address and
205  *    wants this address to be kept by calling GSA_address_in_use. Adresses will
206  *    mark the address as used an notify the solver about the use.
207  *
208  *       1.7.8 Address lifecycle
209  *
210  *      * (add address)
211  *      * (updated address) || (address in use)
212  *      * (delete address)
213  *
214  *     1.8 Bandwidth assignment
215  *
216  *    The addresses are used to perform resource allocation operations. ATS
217  *    addresses takes care of instantiating the solver configured and notifies
218  *    the respective solver about address changes and receives changes to the
219  *    bandwidth assignment from the solver. The current bandwidth assignment is
220  *    sent to transport. The specific solvers will be described in the specific
221  *    section.
222  *
223  *     1.9 Changing peer preferences
224  *
225  *    The bandwidth assigned to a peer can be influenced by setting a preference
226  *    for a peer. The prefernce will be given to to the solver with s_pref which
227  *    has to take care of the preference value
228
229  */
230
231
232 /**
233  * Available ressource assignment modes
234  */
235 enum ATS_Mode
236 {
237   /*
238    * Simplistic mode:
239    *
240    * Assign each peer an equal amount of bandwidth (bw)
241    *
242    * bw_per_peer = bw_total / #active addresses
243    */
244   MODE_SIMPLISTIC,
245
246   /*
247    * MLP mode:
248    *
249    * Solve ressource assignment as an optimization problem
250    * Uses an mixed integer programming solver
251    */
252   MODE_MLP
253 };
254
255
256 /**
257  * Pending Address suggestion requests
258  */
259 struct GAS_Addresses_Suggestion_Requests
260 {
261   /**
262    * Next in DLL
263    */
264   struct GAS_Addresses_Suggestion_Requests *next;
265
266   /**
267    * Previous in DLL
268    */
269   struct GAS_Addresses_Suggestion_Requests *prev;
270
271   /**
272    * Peer ID
273    */
274   struct GNUNET_PeerIdentity id;
275 };
276
277
278 /**
279  * Handle for ATS address component
280  */
281 struct GAS_Addresses_Handle
282 {
283   /**
284    *
285    */
286   struct GNUNET_STATISTICS_Handle *stat;
287
288   /**
289    * A multihashmap to store all addresses
290    */
291   struct GNUNET_CONTAINER_MultiHashMap *addresses;
292
293   /**
294    * Configure WAN quota in
295    */
296   unsigned long long wan_quota_in;
297
298   /**
299    * Configure WAN quota out
300    */
301   unsigned long long wan_quota_out;
302
303   /**
304    * Is ATS addresses running
305    */
306   int running;
307
308   /**
309    * Configured ATS solver
310    */
311   int ats_mode;
312
313   /**
314    *  Solver handle
315    */
316   void *solver;
317
318   /**
319    * Address suggestion requests DLL head
320    */
321   struct GAS_Addresses_Suggestion_Requests *r_head;
322
323   /**
324    * Address suggestion requests DLL tail
325    */
326   struct GAS_Addresses_Suggestion_Requests *r_tail;
327
328   /* Solver functions */
329
330   /**
331    * Initialize solver
332    */
333   GAS_solver_init s_init;
334
335   /**
336    * Add an address to the solver
337    */
338   GAS_solver_address_add s_add;
339
340   /**
341    * Update address in solver
342    */
343   GAS_solver_address_update s_update;
344
345   /**
346    * Get address from solver
347    */
348   GAS_solver_get_preferred_address s_get;
349
350   /**
351    * Get address from solver
352    */
353   GAS_solver_stop_get_preferred_address s_get_stop;
354
355   /**
356    * Delete address in solver
357    */
358   GAS_solver_address_delete s_del;
359
360   /**
361    * Change preference for quality in solver
362    */
363   GAS_solver_address_change_preference s_pref;
364
365   /**
366    * Shutdown solver
367    */
368   GAS_solver_done s_done;
369 };
370
371
372 /**
373  * Assemble ATS information from address
374  *
375  * @param aa source address
376  * @param dest destination
377  * @return number of elements
378  */
379 static unsigned int
380 assemble_ats_information (const struct ATS_Address *aa,  struct GNUNET_ATS_Information **dest)
381 {
382   unsigned int ats_count = GNUNET_ATS_PropertyCount - 1;
383   struct GNUNET_ATS_Information *ats;
384
385   ats = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
386   (*dest) = ats;
387
388   ats[0].type = ntohl(GNUNET_ATS_UTILIZATION_UP);
389   ats[0].value = aa->atsp_utilization_out.value__;
390   ats[1].type = ntohl(GNUNET_ATS_UTILIZATION_DOWN);
391   ats[1].value = aa->atsp_utilization_in.value__;
392   ats[2].type = ntohl(GNUNET_ATS_NETWORK_TYPE);
393   ats[2].value = ntohl(aa->atsp_network_type);
394   ats[3].type = ntohl(GNUNET_ATS_QUALITY_NET_DELAY);
395   ats[3].value = ntohl(aa->atsp_latency.rel_value);
396   ats[4].type = ntohl(GNUNET_ATS_QUALITY_NET_DISTANCE);
397   ats[4].value = ntohl(aa->atsp_distance);
398   ats[5].type = ntohl(GNUNET_ATS_COST_WAN);
399   ats[5].value = ntohl (aa->atsp_cost_wan);
400   ats[6].type = ntohl(GNUNET_ATS_COST_LAN);
401   ats[6].value = ntohl (aa->atsp_cost_lan);
402   ats[7].type = ntohl(GNUNET_ATS_COST_WLAN);
403   ats[7].value = ntohl (aa->atsp_cost_wlan);
404   return ats_count;
405 }
406
407
408 /**
409  * Disassemble ATS information and update address
410  *
411  * @param src source ATS information
412  * @param ats_count number of ATS information
413  * @param dest destination address
414  * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
415  */
416 static unsigned int
417 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
418                              uint32_t ats_count,
419                              struct ATS_Address *dest)
420 {
421   int i;
422   int change = GNUNET_NO;
423   int res = 0;
424   for (i = 0; i < ats_count; i++)
425     switch (ntohl (src[i].type))
426     {
427     case GNUNET_ATS_UTILIZATION_UP:
428         if (dest->atsp_utilization_out.value__ != src[i].value)
429                 change = GNUNET_YES;
430       dest->atsp_utilization_out.value__ = src[i].value;
431       res ++;
432       break;
433     case GNUNET_ATS_UTILIZATION_DOWN:
434         if (dest->atsp_utilization_in.value__ != src[i].value)
435                 change = GNUNET_YES;
436       dest->atsp_utilization_in.value__ = src[i].value;
437       res ++;
438       break;
439     case GNUNET_ATS_QUALITY_NET_DELAY:
440         if (dest->atsp_latency.rel_value  != src[i].value)
441                 change = GNUNET_YES;
442       dest->atsp_latency.rel_value = ntohl (src[i].value);
443       res ++;
444       break;
445     case GNUNET_ATS_QUALITY_NET_DISTANCE:
446         if (dest->atsp_distance!= src[i].value)
447                 change = GNUNET_YES;
448       dest->atsp_distance = ntohl (src[i].value);
449       res ++;
450       break;
451     case GNUNET_ATS_COST_WAN:
452         if (dest->atsp_cost_wan != src[i].value)
453                 change = GNUNET_YES;
454       dest->atsp_cost_wan = ntohl (src[i].value);
455       res ++;
456       break;
457     case GNUNET_ATS_COST_LAN:
458         if (dest->atsp_cost_lan != src[i].value)
459                 change = GNUNET_YES;
460       dest->atsp_cost_lan = ntohl (src[i].value);
461       res ++;
462       break;
463     case GNUNET_ATS_COST_WLAN:
464         if (dest->atsp_cost_wlan != src[i].value)
465                 change = GNUNET_YES;
466       dest->atsp_cost_wlan = ntohl (src[i].value);
467       res ++;
468       break;
469     case GNUNET_ATS_NETWORK_TYPE:
470         if (dest->atsp_network_type != src[i].value)
471                 change = GNUNET_YES;
472       dest->atsp_network_type = ntohl (src[i].value);
473       res ++;
474       break;
475     case GNUNET_ATS_ARRAY_TERMINATOR:
476       break;
477     default:
478       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
479                   "Received unsupported ATS type %u\n", ntohl (src[i].type));
480       GNUNET_break (0);
481       break;
482     }
483   return change;
484 }
485
486 /**
487  * Free the given address
488  * @param addr address to destroy
489  */
490 static void
491 free_address (struct ATS_Address *addr)
492 {
493   GNUNET_free (addr->plugin);
494   GNUNET_free (addr);
495 }
496
497 /**
498  * Create a ATS_address with the given information
499  * @param peer peer
500  * @param plugin_name plugin
501  * @param plugin_addr address
502  * @param plugin_addr_len address length
503  * @param session_id session
504  * @return the ATS_Address
505  */
506 static struct ATS_Address *
507 create_address (const struct GNUNET_PeerIdentity *peer,
508                 const char *plugin_name,
509                 const void *plugin_addr, size_t plugin_addr_len,
510                 uint32_t session_id)
511 {
512   struct ATS_Address *aa = NULL;
513
514   aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
515   aa->peer = *peer;
516   aa->addr_len = plugin_addr_len;
517   aa->addr = &aa[1];
518   memcpy (&aa[1], plugin_addr, plugin_addr_len);
519   aa->plugin = GNUNET_strdup (plugin_name);
520   aa->session_id = session_id;
521   aa->active = GNUNET_NO;
522   aa->used = GNUNET_NO;
523   aa->solver_information = NULL;
524   aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
525   aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
526   return aa;
527 }
528
529
530 /**
531  * Destroy the given address.
532  *
533  * @param handle the address handle
534  * @param addr address to destroy
535  * @return GNUNET_YES if bandwidth allocations should be recalcualted
536  */
537 static int
538 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
539 {
540   int ret;
541
542   ret = GNUNET_NO;
543   GNUNET_assert (GNUNET_YES ==
544                  GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
545                                                        &addr->peer.hashPubKey,
546                                                        addr));
547   free_address (addr);
548   return ret;
549 }
550
551
552 struct CompareAddressContext
553 {
554   const struct ATS_Address *search;
555
556   /* exact_address != NULL if address and session is equal */
557   struct ATS_Address *exact_address;
558   /* exact_address != NULL if address and session is 0 */
559   struct ATS_Address *base_address;
560 };
561
562
563 static int
564 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
565 {
566   struct CompareAddressContext *cac = cls;
567   struct ATS_Address *aa = value;
568
569   /* Find an matching exact address:
570    *
571    * Compare by:
572    * aa->addr_len == cac->search->addr_len
573    * aa->plugin == cac->search->plugin
574    * aa->addr == cac->search->addr
575    * aa->session == cac->search->session
576    *
577    * return as exact address
578    */
579   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
580   {
581       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
582         cac->exact_address = aa;
583   }
584
585   /* Find an matching base address:
586    *
587    * Properties:
588    *
589    * aa->session_id == 0
590    *
591    * Compare by:
592    * aa->addr_len == cac->search->addr_len
593    * aa->plugin == cac->search->plugin
594    * aa->addr == cac->search->addr
595    *
596    * return as base address
597    */
598   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
599   {
600       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
601         cac->base_address = aa;
602   }
603
604   /* Find an matching exact address based on session:
605    *
606    * Properties:
607    *
608    * cac->search->addr_len == 0
609    *
610    * Compare by:
611    * aa->plugin == cac->search->plugin
612    * aa->session_id == cac->search->session_id
613    *
614    * return as exact address
615    */
616   if (0 == cac->search->addr_len)
617   {
618       if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
619         cac->exact_address = aa;
620   }
621
622   if (cac->exact_address == NULL)
623     return GNUNET_YES; /* Continue iteration to find exact address */
624   else
625     return GNUNET_NO; /* Stop iteration since we have an exact address */
626 }
627
628
629 /**
630  * Find an existing equivalent address record.
631  * Compares by peer identity and network address OR by session ID
632  * (one of the two must match).
633  *
634  * @param handle the address handle
635  * @param peer peer to lookup addresses for
636  * @param addr existing address record
637  * @return existing address record, NULL for none
638  */
639 struct ATS_Address *
640 find_equivalent_address (struct GAS_Addresses_Handle *handle,
641                          const struct GNUNET_PeerIdentity *peer,
642                          const struct ATS_Address *addr)
643 {
644   struct CompareAddressContext cac;
645
646   cac.exact_address = NULL;
647   cac.base_address = NULL;
648   cac.search = addr;
649   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
650                                               &compare_address_it, &cac);
651
652   if (cac.exact_address == NULL)
653     return cac.base_address;
654   return cac.exact_address;
655 }
656
657
658 static struct ATS_Address *
659 lookup_address (struct GAS_Addresses_Handle *handle,
660                 const struct GNUNET_PeerIdentity *peer,
661                 const char *plugin_name,
662                 const void *plugin_addr,
663                 size_t plugin_addr_len,
664                 uint32_t session_id,
665                 const struct GNUNET_ATS_Information *atsi,
666                 uint32_t atsi_count)
667 {
668   struct ATS_Address *aa;
669   struct ATS_Address *ea;
670
671   aa = create_address (peer,
672                        plugin_name,
673                        plugin_addr, plugin_addr_len,
674                        session_id);
675
676   /* Get existing address or address with session == 0 */
677   ea = find_equivalent_address (handle, peer, aa);
678   free_address (aa);
679   if (ea == NULL)
680   {
681     return NULL;
682   }
683   else if (ea->session_id != session_id)
684   {
685     return NULL;
686   }
687   return ea;
688 }
689
690
691 void
692 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
693                    const struct GNUNET_PeerIdentity *peer,
694                    const char *plugin_name, const void *plugin_addr,
695                    size_t plugin_addr_len, uint32_t session_id,
696                    const struct GNUNET_ATS_Information *atsi,
697                    uint32_t atsi_count)
698 {
699   struct ATS_Address *aa;
700   struct ATS_Address *ea;
701   struct GNUNET_ATS_Information *ats_new;
702   uint32_t ats_count_new;
703   unsigned int ats_res;
704
705   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
706               "Received `%s' for peer `%s'\n",
707               "ADDRESS ADD",
708               GNUNET_i2s (peer));
709
710   if (GNUNET_NO == handle->running)
711     return;
712
713   GNUNET_assert (NULL != handle->addresses);
714
715   aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
716                        session_id);
717
718   if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, aa)))
719   {
720       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
721                 "While adding address: had %u ATS elements to add, could only add %u\n",
722                 atsi_count, ats_res);
723   }
724
725   /* Get existing address or address with session == 0 */
726   ea = find_equivalent_address (handle, peer, aa);
727   if (ea == NULL)
728   {
729     /* We have a new address */
730     GNUNET_assert (GNUNET_OK ==
731                    GNUNET_CONTAINER_multihashmap_put (handle->addresses,
732                                                       &peer->hashPubKey, aa,
733                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
734     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
735                 GNUNET_i2s (peer), session_id, aa);
736     /* Tell solver about new address */
737     handle->s_add (handle->solver, handle->addresses, aa);
738     /* Notify performance clients about new address */
739     ats_count_new = assemble_ats_information (aa, &ats_new);
740     GAS_performance_notify_all_clients (&aa->peer,
741         aa->plugin,
742         aa->addr, aa->addr_len,
743         aa->session_id,
744         ats_new, ats_count_new,
745         aa->assigned_bw_out,
746         aa->assigned_bw_in);
747     GNUNET_free (ats_new);
748     return;
749   }
750   GNUNET_free (aa->plugin);
751   GNUNET_free (aa);
752
753   if (ea->session_id != 0)
754   {
755       /* This address with the same session is already existing
756        * Should not happen */
757       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
758                 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
759                 GNUNET_i2s (peer), plugin_name, session_id);
760       GNUNET_break (0);
761       return;
762   }
763
764   /* We have an address without an session, update this address */
765
766   /* Notify solver about update with atsi information and session */
767   handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
768
769   /* Do the update */
770   ea->session_id = session_id;
771   if (GNUNET_YES == disassemble_ats_information(atsi, atsi_count, ea))
772   {
773                 ats_count_new = assemble_ats_information (aa, &ats_new);
774                 GAS_performance_notify_all_clients (&aa->peer,
775                                 aa->plugin,
776                                 aa->addr, aa->addr_len,
777                                 aa->session_id,
778                                 ats_new, ats_count_new,
779                                 aa->assigned_bw_out,
780                                 aa->assigned_bw_in);
781                 GNUNET_free (ats_new);
782   }
783   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
784            "Updated existing address for peer `%s' %p with new session %u\n",
785            GNUNET_i2s (peer), ea, session_id);
786 }
787
788
789 void
790 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
791                       const struct GNUNET_PeerIdentity *peer,
792                       const char *plugin_name, const void *plugin_addr,
793                       size_t plugin_addr_len, uint32_t session_id,
794                       const struct GNUNET_ATS_Information *atsi,
795                       uint32_t atsi_count)
796 {
797   struct ATS_Address *aa;
798   struct GNUNET_ATS_Information *ats_new;
799   uint32_t ats_count_new;
800
801   if (GNUNET_NO == handle->running)
802     return;
803
804   GNUNET_assert (NULL != handle->addresses);
805
806   /* Get existing address */
807   aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
808                        session_id, atsi, atsi_count);
809   if (aa == NULL)
810   {
811     /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
812     /*             GNUNET_i2s (peer), plugin_name, session_id); */
813     /* GNUNET_break (0); */
814     return;
815   }
816
817   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
818                 "Received `%s' for peer `%s' address \n",
819                 "ADDRESS UPDATE",
820                 GNUNET_i2s (peer), aa);
821
822   /* Tell solver about update */
823   handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
824
825   /* Update address */
826   if (GNUNET_YES == disassemble_ats_information (atsi, atsi_count, aa))
827   {
828                 ats_count_new = assemble_ats_information (aa, &ats_new);
829                 /* Notify performance clients about updated address */
830                 GAS_performance_notify_all_clients (&aa->peer,
831                                 aa->plugin,
832                                 aa->addr, aa->addr_len,
833                                 aa->session_id,
834                                 ats_new, ats_count_new,
835                                 aa->assigned_bw_out,
836                                 aa->assigned_bw_in);
837                 GNUNET_free (ats_new);
838   }
839 }
840
841
842 struct DestroyContext
843 {
844   struct ATS_Address *aa;
845
846   struct GAS_Addresses_Handle *handle;
847
848   /**
849    * GNUNET_NO  : full address
850    * GNUNET_YES : just session
851    */
852   int result;
853 };
854
855
856 /**
857  * Delete an address
858  *
859  * If session != 0, just the session is deleted, the address itself still exists
860  * If session == 0, remove full address
861  * If session == 0 and addrlen == 0, destroy inbound address
862  *
863  * @param cls unused
864  * @param key unused
865  * @param value the 'struct ATS_Address'
866  * @return GNUNET_OK (continue to iterate)
867  */
868 static int
869 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
870 {
871   struct DestroyContext *dc = cls;
872   struct GAS_Addresses_Handle *handle = dc->handle;
873   const struct ATS_Address *des = dc->aa;
874   struct ATS_Address *aa = value;
875
876   GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
877                               sizeof (struct GNUNET_PeerIdentity)));
878
879
880   if (des->session_id == 0)
881   {
882     /* Session == 0, remove full address  */
883     if ((0 == strcmp (des->plugin, aa->plugin)) &&
884         (aa->addr_len == des->addr_len) &&
885         (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
886     {
887
888       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
889                   "Deleting full address for peer `%s' session %u %p\n",
890                   GNUNET_i2s (&aa->peer), aa->session_id, aa);
891
892       /* Notify solver about deletion */
893       handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
894       destroy_address (handle, aa);
895       dc->result = GNUNET_NO;
896       return GNUNET_OK; /* Continue iteration */
897     }
898   }
899   else
900   {
901     /* Session != 0, just remove session */
902     if (aa->session_id != des->session_id)
903       return GNUNET_OK; /* irrelevant */
904
905     if ((aa->session_id != 0) &&
906         (0 != strcmp (des->plugin, aa->plugin)))
907     {
908         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
909                     "Different plugins during removal: `%s' vs `%s' \n",
910                     des->plugin, aa->plugin);
911         GNUNET_break (0);
912         return GNUNET_OK;
913     }
914
915     if (aa->addr_len == 0)
916     {
917         /* Inbound connection died, delete full address */
918         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
919                     "Deleting inbound address for peer `%s': `%s' session %u\n",
920                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
921
922         /* Notify solver about deletion */
923         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
924         destroy_address (handle, aa);
925         dc->result = GNUNET_NO;
926         return GNUNET_OK; /* Continue iteration */
927     }
928     else
929     {
930         /* Session died */
931         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
932                     "Deleting session for peer `%s': `%s' %u\n",
933                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
934         /* Notify solver to delete session */
935         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
936         aa->session_id = 0;
937         return GNUNET_OK;
938     }
939   }
940   return GNUNET_OK;
941 }
942
943 void
944 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
945                        const struct GNUNET_PeerIdentity *peer,
946                        const char *plugin_name, const void *plugin_addr,
947                        size_t plugin_addr_len, uint32_t session_id)
948 {
949   struct ATS_Address *ea;
950   struct DestroyContext dc;
951
952   if (GNUNET_NO == handle->running)
953     return;
954
955   /* Get existing address */
956   ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
957                        session_id, NULL, 0);
958
959   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
960               "Received `%s' for peer `%s' address %p session %u\n",
961               "ADDRESS DESTROY",
962               GNUNET_i2s (peer), ea, session_id);
963
964   if (ea == NULL)
965   {
966     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
967                 GNUNET_i2s (peer), plugin_name, session_id);
968     return;
969   }
970
971   GNUNET_break (0 < strlen (plugin_name));
972   dc.handle = handle;
973   dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
974
975   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
976                                               &destroy_by_session_id, &dc);
977   free_address (dc.aa);
978 }
979
980
981 int
982 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
983                       const struct GNUNET_PeerIdentity *peer,
984                       const char *plugin_name, const void *plugin_addr,
985                       size_t plugin_addr_len, uint32_t session_id, int in_use)
986 {
987   struct ATS_Address *ea;
988
989   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
990                 "Received `%s' for peer `%s'\n",
991                 "ADDRESS IN USE",
992                 GNUNET_i2s (peer));
993
994   if (GNUNET_NO == handle->running)
995     return GNUNET_SYSERR;
996
997   ea = lookup_address (handle, peer, plugin_name,
998                         plugin_addr, plugin_addr_len,
999                         session_id, NULL, 0);
1000   if (NULL == ea)
1001   {
1002     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1003                 "Trying to set unknown address `%s', %s %u %s \n",
1004                 GNUNET_i2s (peer),
1005                 plugin_name, session_id,
1006                 (GNUNET_NO == in_use) ? "NO" : "YES");
1007     GNUNET_break (0);
1008     return GNUNET_SYSERR;
1009   }
1010   if (ea->used == in_use)
1011   {
1012     GNUNET_break (0);
1013     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1014                 "Address in use called multiple times for peer `%s': %s -> %s \n",
1015                 GNUNET_i2s (peer),
1016                 (GNUNET_NO == ea->used) ? "NO" : "YES",
1017                 (GNUNET_NO == in_use) ? "NO" : "YES");
1018     return GNUNET_SYSERR;
1019   }
1020
1021   /* Tell solver about update */
1022   handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
1023   ea->used = in_use;
1024
1025   return GNUNET_OK;
1026 }
1027
1028
1029 /**
1030  * Cancel address suggestions for a peer
1031  *
1032  * @param handle the address handle
1033  * @param peer the respective peer
1034  */
1035 void
1036 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1037                                       const struct GNUNET_PeerIdentity *peer)
1038 {
1039   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1040
1041   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1042               "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1043
1044   while (NULL != cur)
1045   {
1046       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1047         break; /* found */
1048       cur = cur->next;
1049   }
1050
1051   if (NULL == cur)
1052   {
1053       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1054                   "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1055       return;
1056   }
1057   handle->s_get_stop (handle->solver, handle->addresses, peer);
1058   GAS_addresses_handle_backoff_reset (handle, peer);
1059   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1060               "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1061   GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1062   GNUNET_free (cur);
1063 }
1064
1065
1066 /**
1067  * Add an address suggestions for a peer
1068  *
1069  * @param handle the address handle
1070  * @param peer the respective peer
1071  */
1072 void
1073 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1074                                const struct GNUNET_PeerIdentity *peer)
1075 {
1076   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1077   struct ATS_Address *aa;
1078   struct GNUNET_ATS_Information *ats;
1079   unsigned int ats_count;
1080
1081   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1082               "Received `%s' for peer `%s'\n",
1083               "REQUEST ADDRESS",
1084               GNUNET_i2s (peer));
1085
1086   if (GNUNET_NO == handle->running)
1087     return;
1088   while (NULL != cur)
1089   {
1090       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1091         break; /* already suggesting */
1092       cur = cur->next;
1093   }
1094   if (NULL == cur)
1095   {
1096       cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1097       cur->id = (*peer);
1098       GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1099   }
1100
1101   /* Get prefered address from solver */
1102   aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1103   if (NULL == aa)
1104   {
1105     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1106                 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1107     return;
1108   }
1109
1110   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1111               "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1112
1113   ats_count = assemble_ats_information (aa, &ats);
1114   GAS_scheduling_transmit_address_suggestion (peer,
1115                                               aa->plugin,
1116                                               aa->addr, aa->addr_len,
1117                                               aa->session_id,
1118                                               ats, ats_count,
1119                                               aa->assigned_bw_out,
1120                                               aa->assigned_bw_in);
1121
1122   aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1123   aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1124
1125   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1126        "Address %p ready for suggestion, block interval now %llu \n",
1127        aa, aa->block_interval);
1128
1129   GNUNET_free (ats);
1130 }
1131
1132
1133 static int
1134 reset_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1135 {
1136   struct ATS_Address *aa = value;
1137
1138   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1139               "Resetting interval for peer `%s' address %p from %llu to 0\n",
1140               GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1141
1142   aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1143   aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1144   return GNUNET_OK;
1145 }
1146
1147
1148 void
1149 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1150                                     const struct GNUNET_PeerIdentity *peer)
1151 {
1152   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1153               "Received `%s' for peer `%s'\n",
1154               "RESET BACKOFF",
1155               GNUNET_i2s (peer));
1156
1157   GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1158                                               &peer->hashPubKey,
1159                                               &reset_address_it,
1160                                               NULL));
1161 }
1162
1163
1164 void
1165 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1166                                  void *client,
1167                                  const struct GNUNET_PeerIdentity *peer,
1168                                  enum GNUNET_ATS_PreferenceKind kind,
1169                                  float score)
1170 {
1171   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1172               "Received `%s' for peer `%s' for client %p\n",
1173               "CHANGE PREFERENCE",
1174               GNUNET_i2s (peer), client);
1175
1176   if (GNUNET_NO == handle->running)
1177     return;
1178
1179   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1180                                                           &peer->hashPubKey))
1181   {
1182       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1183                   "Received `%s' for unknown peer `%s' from client %p\n",
1184                   "CHANGE PREFERENCE",
1185                   GNUNET_i2s (peer), client);
1186       return;
1187   }
1188
1189   /* Tell solver about update */
1190   handle->s_pref (handle->solver, client, peer, kind, score);
1191 }
1192
1193
1194 /**
1195  * Load quotas for networks from configuration
1196  *
1197  * @param cfg configuration handle
1198  * @param out_dest where to write outbound quotas
1199  * @param in_dest where to write inbound quotas
1200  * @param dest_length length of inbound and outbound arrays
1201  * @return number of networks loaded
1202  */
1203 static unsigned int
1204 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1205 {
1206   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1207   char * entry_in = NULL;
1208   char * entry_out = NULL;
1209   char * quota_out_str;
1210   char * quota_in_str;
1211   int c;
1212   int res;
1213
1214   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1215   {
1216     in_dest[c] = 0;
1217     out_dest[c] = 0;
1218     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1219     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1220
1221     /* quota out */
1222     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
1223     {
1224       res = GNUNET_NO;
1225       if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1226       {
1227         out_dest[c] = GNUNET_ATS_MaxBandwidth;
1228         res = GNUNET_YES;
1229       }
1230       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1231         res = GNUNET_YES;
1232       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out,  &out_dest[c])))
1233          res = GNUNET_YES;
1234
1235       if (GNUNET_NO == res)
1236       {
1237           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1238               network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1239           out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1240       }
1241       else
1242       {
1243           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1244               network_str[c], out_dest[c]);
1245       }
1246       GNUNET_free (quota_out_str);
1247     }
1248     else
1249     {
1250       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1251           network_str[c], GNUNET_ATS_DefaultBandwidth);
1252       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1253     }
1254
1255     /* quota in */
1256     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
1257     {
1258       res = GNUNET_NO;
1259       if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1260       {
1261         in_dest[c] = GNUNET_ATS_MaxBandwidth;
1262         res = GNUNET_YES;
1263       }
1264       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1265         res = GNUNET_YES;
1266       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in,  &in_dest[c])))
1267          res = GNUNET_YES;
1268
1269       if (GNUNET_NO == res)
1270       {
1271           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1272               network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1273           in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1274       }
1275       else
1276       {
1277           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1278               network_str[c], in_dest[c]);
1279       }
1280       GNUNET_free (quota_in_str);
1281     }
1282     else
1283     {
1284       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1285           network_str[c], GNUNET_ATS_DefaultBandwidth);
1286       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1287     }
1288     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Loaded quota for network `%s' (in/out): %llu %llu\n", network_str[c], in_dest[c], out_dest[c]);
1289     GNUNET_free (entry_out);
1290     GNUNET_free (entry_in);
1291   }
1292   return GNUNET_ATS_NetworkTypeCount;
1293 }
1294
1295
1296 static void
1297 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1298 {
1299   struct GAS_Addresses_Handle *handle = cls;
1300   struct GAS_Addresses_Suggestion_Requests *cur;
1301   struct GNUNET_ATS_Information *ats;
1302   unsigned int ats_count;
1303
1304   GNUNET_assert (handle != NULL);
1305   GNUNET_assert (address != NULL);
1306
1307   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1308
1309
1310   ats_count = assemble_ats_information (address, &ats);
1311
1312   /* Notify performance clients about changes to address */
1313   GAS_performance_notify_all_clients (&address->peer,
1314       address->plugin,
1315       address->addr, address->addr_len,
1316       address->session_id,
1317       ats, ats_count,
1318       address->assigned_bw_out,
1319       address->assigned_bw_in);
1320   cur = handle->r_head;
1321   while (NULL != cur)
1322   {
1323       if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1324         break; /* we have an address request pending*/
1325       cur = cur->next;
1326   }
1327   if (NULL == cur)
1328   {
1329       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1330                   "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1331       GNUNET_free (ats);
1332       return;
1333   }
1334
1335   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1336               "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1337
1338   /* *Notify scheduling clients about suggestion */
1339   GAS_scheduling_transmit_address_suggestion (&address->peer,
1340                                               address->plugin,
1341                                               address->addr, address->addr_len,
1342                                               address->session_id,
1343                                               ats, ats_count,
1344                                               address->assigned_bw_out,
1345                                               address->assigned_bw_in);
1346   GNUNET_free (ats);
1347 }
1348
1349
1350 /**
1351  * Initialize address subsystem.
1352  *
1353  * @param cfg configuration to use
1354  * @param stats the statistics handle to use
1355  */
1356 struct GAS_Addresses_Handle *
1357 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1358                     const struct GNUNET_STATISTICS_Handle *stats)
1359 {
1360   struct GAS_Addresses_Handle *ah;
1361   int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1362   unsigned long long  quotas_in[GNUNET_ATS_NetworkTypeCount];
1363   unsigned long long  quotas_out[GNUNET_ATS_NetworkTypeCount];
1364   int quota_count;
1365   char *mode_str;
1366   int c;
1367
1368   ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1369   ah->running = GNUNET_NO;
1370
1371   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1372   /* Initialize the addresses database */
1373   ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1374   GNUNET_assert (NULL != ah->addresses);
1375
1376   /* Figure out configured solution method */
1377   if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1378   {
1379       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1380       ah->ats_mode = MODE_SIMPLISTIC;
1381   }
1382   else
1383   {
1384       for (c = 0; c < strlen (mode_str); c++)
1385         mode_str[c] = toupper (mode_str[c]);
1386       if (0 == strcmp (mode_str, "SIMPLISTIC"))
1387       {
1388           ah->ats_mode = MODE_SIMPLISTIC;
1389       }
1390       else if (0 == strcmp (mode_str, "MLP"))
1391       {
1392           ah->ats_mode = MODE_MLP;
1393 #if !HAVE_LIBGLPK
1394           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1395           ah->ats_mode = MODE_SIMPLISTIC;
1396 #endif
1397       }
1398       else
1399       {
1400           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1401           ah->ats_mode = MODE_SIMPLISTIC;
1402       }
1403       GNUNET_free (mode_str);
1404   }
1405   /* Start configured solution method */
1406   switch (ah->ats_mode)
1407   {
1408     case MODE_MLP:
1409       /* Init the MLP solver with default values */
1410 #if HAVE_LIBGLPK
1411       ah->ats_mode = MODE_MLP;
1412       ah->s_init = &GAS_mlp_init;
1413       ah->s_add = &GAS_mlp_address_add;
1414       ah->s_update = &GAS_mlp_address_update;
1415       ah->s_get = &GAS_mlp_get_preferred_address;
1416       ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1417       ah->s_pref = &GAS_mlp_address_change_preference;
1418       ah->s_del =  &GAS_mlp_address_delete;
1419       ah->s_done = &GAS_mlp_done;
1420 #else
1421       GNUNET_free (ah);
1422       return NULL;
1423 #endif
1424       break;
1425     case MODE_SIMPLISTIC:
1426       /* Init the simplistic solver with default values */
1427       ah->ats_mode = MODE_SIMPLISTIC;
1428       ah->s_init = &GAS_simplistic_init;
1429       ah->s_add = &GAS_simplistic_address_add;
1430       ah->s_update = &GAS_simplistic_address_update;
1431       ah->s_get = &GAS_simplistic_get_preferred_address;
1432       ah->s_get_stop = &GAS_simplistic_stop_get_preferred_address;
1433       ah->s_pref = &GAS_simplistic_address_change_preference;
1434       ah->s_del  = &GAS_simplistic_address_delete;
1435       ah->s_done = &GAS_simplistic_done;
1436       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1437       break;
1438     default:
1439       return NULL;
1440       break;
1441   }
1442
1443   GNUNET_assert (NULL != ah->s_init);
1444   GNUNET_assert (NULL != ah->s_add);
1445   GNUNET_assert (NULL != ah->s_update);
1446   GNUNET_assert (NULL != ah->s_get);
1447   GNUNET_assert (NULL != ah->s_get_stop);
1448   GNUNET_assert (NULL != ah->s_pref);
1449   GNUNET_assert (NULL != ah->s_del);
1450   GNUNET_assert (NULL != ah->s_done);
1451
1452   quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1453
1454   ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1455   if (NULL == ah->solver)
1456   {
1457     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1458     GNUNET_free (ah);
1459     return NULL;
1460   }
1461
1462   /* up and running */
1463   ah->running = GNUNET_YES;
1464   return ah;
1465 }
1466
1467
1468 /**
1469  * Free memory of address.
1470  *
1471  * @param cls NULL
1472  * @param key peer identity (unused)
1473  * @param value the 'struct ATS_Address' to free
1474  * @return GNUNET_OK (continue to iterate)
1475  */
1476 static int
1477 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1478 {
1479   struct GAS_Addresses_Handle *handle = cls;
1480   struct ATS_Address *aa = value;
1481   handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1482   destroy_address (handle, aa);
1483   return GNUNET_OK;
1484 }
1485
1486
1487 void
1488 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1489 {
1490   if (GNUNET_NO == handle->running)
1491     return;
1492
1493   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1494               "Received `%s'\n",
1495               "DESTROY ALL");
1496
1497   if (handle->addresses != NULL)
1498     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1499 }
1500
1501
1502 /**
1503  * Shutdown address subsystem.
1504  */
1505 void
1506 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1507 {
1508   struct GAS_Addresses_Suggestion_Requests *cur;
1509
1510   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1511               "Shutting down addresses\n");
1512   GNUNET_assert (NULL != handle);
1513   GAS_addresses_destroy_all (handle);
1514   handle->running = GNUNET_NO;
1515   GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1516   handle->addresses = NULL;
1517   while (NULL != (cur = handle->r_head))
1518   {
1519       GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1520       GNUNET_free (cur);
1521   }
1522   handle->s_done (handle->solver);
1523   GNUNET_free (handle);
1524   /* Stop configured solution method */
1525
1526 }
1527
1528 struct PeerIteratorContext
1529 {
1530   GNUNET_ATS_Peer_Iterator it;
1531   void *it_cls;
1532   struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1533 };
1534
1535 static int
1536 peer_it (void *cls,
1537          const struct GNUNET_HashCode * key,
1538          void *value)
1539 {
1540   struct PeerIteratorContext *ip_ctx = cls;
1541   struct GNUNET_PeerIdentity tmp;
1542
1543   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1544   {
1545       GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1546       tmp.hashPubKey = (*key);
1547       ip_ctx->it (ip_ctx->it_cls, &tmp);
1548   }
1549
1550   return GNUNET_OK;
1551 }
1552
1553 /**
1554  * Return all peers currently known to ATS
1555  *
1556  * @param handle the address handle
1557  * @param p_it the iterator to call for every peer, callbach with id == NULL
1558  *        when done
1559  * @param p_it_cls the closure for the iterator
1560  */
1561 void
1562 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle, GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls)
1563 {
1564   struct PeerIteratorContext ip_ctx;
1565   unsigned int size;
1566
1567   if (NULL == p_it)
1568       return;
1569   GNUNET_assert (NULL != handle->addresses);
1570
1571   size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1572   if (0 != size)
1573   {
1574     ip_ctx.it = p_it;
1575     ip_ctx.it_cls = p_it_cls;
1576     ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1577     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1578     GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1579   }
1580   p_it (p_it_cls, NULL);
1581 }
1582
1583 struct PeerInfoIteratorContext
1584 {
1585   GNUNET_ATS_PeerInfo_Iterator it;
1586   void *it_cls;
1587 };
1588
1589
1590 static int 
1591 peerinfo_it (void *cls,
1592              const struct GNUNET_HashCode * key,
1593              void *value)
1594 {
1595   struct PeerInfoIteratorContext *pi_ctx = cls;
1596   struct ATS_Address *addr = (struct ATS_Address *)  value;
1597   struct GNUNET_ATS_Information *ats;
1598   uint32_t ats_count;
1599
1600   if (NULL != pi_ctx->it)
1601   {
1602     ats_count = assemble_ats_information (addr, &ats);
1603
1604     pi_ctx->it (pi_ctx->it_cls,
1605                 &addr->peer,
1606                 addr->plugin,
1607                 addr->addr, addr->addr_len,
1608                 addr->active,
1609                 ats, ats_count,
1610                 addr->assigned_bw_out,
1611                 addr->assigned_bw_in);
1612     GNUNET_free (ats);
1613   }
1614   return GNUNET_YES;
1615 }
1616
1617
1618 /**
1619  * Return all peers currently known to ATS
1620  *
1621  * @param handle the address handle
1622  * @param peer the respective peer
1623  * @param pi_it the iterator to call for every peer
1624  * @param pi_it_cls the closure for the iterator
1625  */
1626 void
1627 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1628                              const struct GNUNET_PeerIdentity *peer,
1629                              GNUNET_ATS_PeerInfo_Iterator pi_it,
1630                              void *pi_it_cls)
1631 {
1632   struct PeerInfoIteratorContext pi_ctx;
1633   struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1634   GNUNET_assert (NULL != peer);
1635   GNUNET_assert (NULL != handle->addresses);
1636   if (NULL == pi_it)
1637     return; /* does not make sense without callback */
1638
1639   zero_bw = GNUNET_BANDWIDTH_value_init (0);
1640   pi_ctx.it = pi_it;
1641   pi_ctx.it_cls = pi_it_cls;
1642
1643   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1644
1645   if (NULL != pi_it)
1646     pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1647
1648 }
1649
1650
1651 /* end of gnunet-service-ats_addresses.c */