api change, fix and improvements
[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  * Disassemble ATS information and update performance information in address
374  *
375  * Updates existing information and adds new information
376  *
377  * @param src source ATS information
378  * @param ats_count number of ATS information
379  * @param dest destination address
380  * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
381  */
382 static unsigned int
383 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
384                              uint32_t ats_count,
385                              struct ATS_Address *dest)
386 {
387
388   int c1;
389   int c2;
390   int found;
391   int change;
392
393   struct GNUNET_ATS_Information add_atsi[ats_count];
394   struct GNUNET_ATS_Information *tmp_atsi;
395   uint32_t add_atsi_count;
396
397   change = GNUNET_NO;
398   add_atsi_count = 0;
399
400   if (0 == ats_count)
401         return GNUNET_NO;
402
403   if (NULL == dest->atsi)
404   {
405                 /* Create performance information */
406                 dest->atsi = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
407                 dest->atsi_count = ats_count;
408                 memcpy (dest->atsi, src, ats_count * sizeof (struct GNUNET_ATS_Information));
409                 return GNUNET_YES;
410   }
411
412   for (c1 = 0; c1 < ats_count; c1++)
413   {
414         /* Update existing performance information */
415         found = GNUNET_NO;
416         for (c2 = 0; c2 < dest->atsi_count; c2++)
417         {
418                         if (src[c1].type == dest->atsi[c2].type)
419                         {
420                                 if (src[c1].value != dest->atsi[c2].value)
421                                 {
422                                                 dest->atsi[c2].value = src[c1].value;
423                                                 change = GNUNET_YES;
424                                 }
425                                 found = GNUNET_YES;
426                                 break;
427                         }
428         }
429                 if (GNUNET_NO == found)
430                 {
431                                 add_atsi[add_atsi_count] = src[c1];
432                                 add_atsi_count ++;
433                 }
434   }
435
436   if (add_atsi_count > 0)
437   {
438                 /* Extend ats performance information */
439                 tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
440                                 sizeof (sizeof (struct GNUNET_ATS_Information)));
441                 memcpy (tmp_atsi, dest->atsi, dest->atsi_count * sizeof (struct GNUNET_ATS_Information));
442                 memcpy (&tmp_atsi[dest->atsi_count], add_atsi, add_atsi_count * sizeof (struct GNUNET_ATS_Information));
443                 GNUNET_free (dest->atsi);
444                 dest->atsi = tmp_atsi;
445                 dest->atsi_count = dest->atsi_count + add_atsi_count;
446                         change = GNUNET_YES;
447   }
448
449   return change;
450 }
451
452 /**
453  * Free the given address
454  *
455  * @param addr address to destroy
456  */
457 static void
458 free_address (struct ATS_Address *addr)
459 {
460   GNUNET_free (addr->plugin);
461   GNUNET_free_non_null (addr->atsi);
462   GNUNET_free (addr);
463 }
464
465 /**
466  * Create a ATS_address with the given information
467  *
468  * @param peer peer
469  * @param plugin_name plugin
470  * @param plugin_addr address
471  * @param plugin_addr_len address length
472  * @param session_id session
473  * @return the ATS_Address
474  */
475 static struct ATS_Address *
476 create_address (const struct GNUNET_PeerIdentity *peer,
477                 const char *plugin_name,
478                 const void *plugin_addr, size_t plugin_addr_len,
479                 uint32_t session_id)
480 {
481   struct ATS_Address *aa = NULL;
482
483   aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
484   aa->peer = *peer;
485   aa->addr_len = plugin_addr_len;
486   aa->addr = &aa[1];
487   memcpy (&aa[1], plugin_addr, plugin_addr_len);
488   aa->plugin = GNUNET_strdup (plugin_name);
489   aa->session_id = session_id;
490   aa->active = GNUNET_NO;
491   aa->used = GNUNET_NO;
492   aa->solver_information = NULL;
493   aa->atsi = NULL;
494   aa->atsi_count = 0;
495   aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
496   aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
497   return aa;
498 }
499
500
501 /**
502  * Destroy the given address.
503  *
504  * @param handle the address handle
505  * @param addr address to destroy
506  * @return GNUNET_YES if bandwidth allocations should be recalcualted
507  */
508 static int
509 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
510 {
511   int ret;
512
513   ret = GNUNET_NO;
514   GNUNET_assert (GNUNET_YES ==
515                  GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
516                                                        &addr->peer.hashPubKey,
517                                                        addr));
518   free_address (addr);
519   return ret;
520 }
521
522
523 struct CompareAddressContext
524 {
525   const struct ATS_Address *search;
526
527   /* exact_address != NULL if address and session is equal */
528   struct ATS_Address *exact_address;
529   /* exact_address != NULL if address and session is 0 */
530   struct ATS_Address *base_address;
531 };
532
533 /**
534  * Comapre addresses
535  *
536  * @param cls a CompareAddressContext containin the source address
537  * @param key peer id
538  * @param value the address to compare with
539  * @return GNUNET_YES to continue, GNUNET_NO if address is founce
540  */
541
542 static int
543 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
544 {
545   struct CompareAddressContext *cac = cls;
546   struct ATS_Address *aa = value;
547
548   /* Find an matching exact address:
549    *
550    * Compare by:
551    * aa->addr_len == cac->search->addr_len
552    * aa->plugin == cac->search->plugin
553    * aa->addr == cac->search->addr
554    * aa->session == cac->search->session
555    *
556    * return as exact address
557    */
558   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
559   {
560       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
561         cac->exact_address = aa;
562   }
563
564   /* Find an matching base address:
565    *
566    * Properties:
567    *
568    * aa->session_id == 0
569    *
570    * Compare by:
571    * aa->addr_len == cac->search->addr_len
572    * aa->plugin == cac->search->plugin
573    * aa->addr == cac->search->addr
574    *
575    * return as base address
576    */
577   if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
578   {
579       if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
580         cac->base_address = aa;
581   }
582
583   /* Find an matching exact address based on session:
584    *
585    * Properties:
586    *
587    * cac->search->addr_len == 0
588    *
589    * Compare by:
590    * aa->plugin == cac->search->plugin
591    * aa->session_id == cac->search->session_id
592    *
593    * return as exact address
594    */
595   if (0 == cac->search->addr_len)
596   {
597       if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
598         cac->exact_address = aa;
599   }
600
601   if (cac->exact_address == NULL)
602     return GNUNET_YES; /* Continue iteration to find exact address */
603   else
604     return GNUNET_NO; /* Stop iteration since we have an exact address */
605 }
606
607
608 /**
609  * Find an existing equivalent address record.
610  * Compares by peer identity and network address OR by session ID
611  * (one of the two must match).
612  *
613  * @param handle the address handle
614  * @param peer peer to lookup addresses for
615  * @param addr existing address record
616  * @return existing address record, NULL for none
617  */
618 struct ATS_Address *
619 find_equivalent_address (struct GAS_Addresses_Handle *handle,
620                          const struct GNUNET_PeerIdentity *peer,
621                          const struct ATS_Address *addr)
622 {
623   struct CompareAddressContext cac;
624
625   cac.exact_address = NULL;
626   cac.base_address = NULL;
627   cac.search = addr;
628   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
629                                               &compare_address_it, &cac);
630
631   if (cac.exact_address == NULL)
632     return cac.base_address;
633   return cac.exact_address;
634 }
635
636
637 /**
638  * Lookup an ATS address by the address properties and session or return an
639  * equivalent address with a session == 0
640  *
641  * @param handle the address handle to use
642  * @param peer peer
643  * @param plugin_name transport plugin name
644  * @param plugin_addr plugin address
645  * @param plugin_addr_len length of the plugin address
646  * @param session_id session id, can be 0
647  * @param atsi performance information for this address
648  * @param atsi_count number of performance information contained
649  * @return an ATS_address or NULL
650  */
651
652 static struct ATS_Address *
653 lookup_address (struct GAS_Addresses_Handle *handle,
654                 const struct GNUNET_PeerIdentity *peer,
655                 const char *plugin_name,
656                 const void *plugin_addr,
657                 size_t plugin_addr_len,
658                 uint32_t session_id,
659                 const struct GNUNET_ATS_Information *atsi,
660                 uint32_t atsi_count)
661 {
662   struct ATS_Address *aa;
663   struct ATS_Address *ea;
664
665   aa = create_address (peer,
666                        plugin_name,
667                        plugin_addr, plugin_addr_len,
668                        session_id);
669
670   /* Get existing address or address with session == 0 */
671   ea = find_equivalent_address (handle, peer, aa);
672   free_address (aa);
673   if (ea == NULL)
674   {
675     return NULL;
676   }
677   else if (ea->session_id != session_id)
678   {
679     return NULL;
680   }
681   return ea;
682 }
683
684 /**
685  * Extract an ATS performance info from an address
686  *
687  * @param address the address
688  * @param type the type to extract in HBO
689  * @return the value in HBO or UINT32_MAX in HBO if value does not exist
690  */
691 static int
692 get_performance_info (struct ATS_Address *address, uint32_t type)
693 {
694         int c1;
695         GNUNET_assert (NULL != address);
696
697         if ((NULL == address->atsi) || (0 == address->atsi_count))
698                         return UINT32_MAX;
699
700         for (c1 = 0; c1 < address->atsi_count; c1++)
701         {
702                         if (ntohl(address->atsi[c1].type) == type)
703                                 return ntohl(address->atsi[c1].value);
704         }
705         return UINT32_MAX;
706 }
707
708
709 /**
710  * Add a new address for a peer.
711  *
712  * @param handle the address handle to use
713  * @param peer peer
714  * @param plugin_name transport plugin name
715  * @param plugin_addr plugin address
716  * @param plugin_addr_len length of the plugin address
717  * @param session_id session id, can be 0
718  * @param atsi performance information for this address
719  * @param atsi_count number of performance information contained
720  */
721 void
722 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
723                    const struct GNUNET_PeerIdentity *peer,
724                    const char *plugin_name, const void *plugin_addr,
725                    size_t plugin_addr_len, uint32_t session_id,
726                    const struct GNUNET_ATS_Information *atsi,
727                    uint32_t atsi_count)
728 {
729   struct ATS_Address *aa;
730   struct ATS_Address *ea;
731   uint32_t addr_net;
732
733   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
734               "Received `%s' for peer `%s'\n",
735               "ADDRESS ADD",
736               GNUNET_i2s (peer));
737
738   if (GNUNET_NO == handle->running)
739     return;
740
741   GNUNET_assert (NULL != handle->addresses);
742
743   aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
744                        session_id);
745   disassemble_ats_information (atsi, atsi_count, aa);
746
747   /* Get existing address or address with session == 0 */
748   ea = find_equivalent_address (handle, peer, aa);
749   if (ea == NULL)
750   {
751     /* We have a new address */
752     GNUNET_assert (GNUNET_OK ==
753                    GNUNET_CONTAINER_multihashmap_put (handle->addresses,
754                                                       &peer->hashPubKey, aa,
755                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
756     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
757                 GNUNET_i2s (peer), session_id, aa);
758     addr_net = get_performance_info (aa, GNUNET_ATS_NETWORK_TYPE);
759     if (UINT32_MAX == addr_net)
760         addr_net = GNUNET_ATS_NET_UNSPECIFIED;
761     /* Tell solver about new address */
762     handle->s_add (handle->solver, handle->addresses, aa, addr_net);
763     /* Notify performance clients about new address */
764     GAS_performance_notify_all_clients (&aa->peer,
765         aa->plugin,
766         aa->addr, aa->addr_len,
767         aa->session_id,
768         aa->atsi, aa->atsi_count,
769         aa->assigned_bw_out,
770         aa->assigned_bw_in);
771     return;
772   }
773
774   GNUNET_free (aa->plugin);
775   GNUNET_free_non_null (aa->atsi);
776   GNUNET_free (aa);
777
778   if (ea->session_id != 0)
779   {
780       /* This address with the same session is already existing
781        * Should not happen */
782       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
783                 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
784                 GNUNET_i2s (peer), plugin_name, session_id);
785       GNUNET_break (0);
786       return;
787   }
788
789   /* We have an address without an session, update this address */
790
791   /* Notify solver about update with atsi information and session */
792   handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
793
794   /* Do the update */
795   ea->session_id = session_id;
796   if (GNUNET_YES == disassemble_ats_information (atsi, atsi_count, ea))
797   {
798                 GAS_performance_notify_all_clients (&aa->peer,
799                                 aa->plugin,
800                                 aa->addr, aa->addr_len,
801                                 aa->session_id,
802                                 aa->atsi, aa->atsi_count,
803                                 aa->assigned_bw_out,
804                                 aa->assigned_bw_in);
805   }
806   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
807            "Updated existing address for peer `%s' %p with new session %u\n",
808            GNUNET_i2s (peer), ea, session_id);
809 }
810
811
812 /**
813  * Update an address with a session or performance information for a peer.
814  *
815  * If an address was added without a session it will be updated with the
816  * session
817  *
818  * @param handle the address handle to use
819  * @param peer peer
820  * @param plugin_name transport plugin name
821  * @param plugin_addr plugin address
822  * @param plugin_addr_len length of the plugin address
823  * @param session_id session id, can be 0
824  * @param atsi performance information for this address
825  * @param atsi_count number of performance information contained
826  */
827 void
828 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
829                       const struct GNUNET_PeerIdentity *peer,
830                       const char *plugin_name, const void *plugin_addr,
831                       size_t plugin_addr_len, uint32_t session_id,
832                       const struct GNUNET_ATS_Information *atsi,
833                       uint32_t atsi_count)
834 {
835   struct ATS_Address *aa;
836
837   if (GNUNET_NO == handle->running)
838     return;
839
840   GNUNET_assert (NULL != handle->addresses);
841
842   /* Get existing address */
843   aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
844                        session_id, atsi, atsi_count);
845   if (aa == NULL)
846   {
847     /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
848     /*             GNUNET_i2s (peer), plugin_name, session_id); */
849     /* GNUNET_break (0); */
850     return;
851   }
852
853   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
854                 "Received `%s' for peer `%s' address \n",
855                 "ADDRESS UPDATE",
856                 GNUNET_i2s (peer), aa);
857
858   /* Tell solver about update */
859   handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
860
861   /* Update address */
862   if (GNUNET_YES == disassemble_ats_information (atsi, atsi_count, aa))
863   {
864                 /* Notify performance clients about updated address */
865                 GAS_performance_notify_all_clients (&aa->peer,
866                                 aa->plugin,
867                                 aa->addr, aa->addr_len,
868                                 aa->session_id,
869                                 aa->atsi, aa->atsi_count,
870                                 aa->assigned_bw_out,
871                                 aa->assigned_bw_in);
872   }
873 }
874
875
876 struct DestroyContext
877 {
878   struct ATS_Address *aa;
879
880   struct GAS_Addresses_Handle *handle;
881
882   /**
883    * GNUNET_NO  : full address
884    * GNUNET_YES : just session
885    */
886   int result;
887 };
888
889
890 /**
891  * Delete an address
892  *
893  * If session != 0, just the session is deleted, the address itself still exists
894  * If session == 0, remove full address
895  * If session == 0 and addrlen == 0, destroy inbound address
896  *
897  * @param cls unused
898  * @param key unused
899  * @param value the 'struct ATS_Address'
900  * @return GNUNET_OK (continue to iterate)
901  */
902 static int
903 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
904 {
905   struct DestroyContext *dc = cls;
906   struct GAS_Addresses_Handle *handle = dc->handle;
907   const struct ATS_Address *des = dc->aa;
908   struct ATS_Address *aa = value;
909
910   GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
911                               sizeof (struct GNUNET_PeerIdentity)));
912
913
914   if (des->session_id == 0)
915   {
916     /* Session == 0, remove full address  */
917     if ((0 == strcmp (des->plugin, aa->plugin)) &&
918         (aa->addr_len == des->addr_len) &&
919         (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
920     {
921
922       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
923                   "Deleting full address for peer `%s' session %u %p\n",
924                   GNUNET_i2s (&aa->peer), aa->session_id, aa);
925
926       /* Notify solver about deletion */
927       handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
928       destroy_address (handle, aa);
929       dc->result = GNUNET_NO;
930       return GNUNET_OK; /* Continue iteration */
931     }
932   }
933   else
934   {
935     /* Session != 0, just remove session */
936     if (aa->session_id != des->session_id)
937       return GNUNET_OK; /* irrelevant */
938
939     if ((aa->session_id != 0) &&
940         (0 != strcmp (des->plugin, aa->plugin)))
941     {
942         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
943                     "Different plugins during removal: `%s' vs `%s' \n",
944                     des->plugin, aa->plugin);
945         GNUNET_break (0);
946         return GNUNET_OK;
947     }
948
949     if (aa->addr_len == 0)
950     {
951         /* Inbound connection died, delete full address */
952         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
953                     "Deleting inbound address for peer `%s': `%s' session %u\n",
954                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
955
956         /* Notify solver about deletion */
957         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
958         destroy_address (handle, aa);
959         dc->result = GNUNET_NO;
960         return GNUNET_OK; /* Continue iteration */
961     }
962     else
963     {
964         /* Session died */
965         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
966                     "Deleting session for peer `%s': `%s' %u\n",
967                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
968         /* Notify solver to delete session */
969         handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
970         aa->session_id = 0;
971         return GNUNET_OK;
972     }
973   }
974   return GNUNET_OK;
975 }
976
977
978 /**
979  * Remove an address or just a session for a peer.
980  *
981  * @param handle the address handle to use
982  * @param peer peer
983  * @param plugin_name transport plugin name
984  * @param plugin_addr plugin address
985  * @param plugin_addr_len length of the plugin address
986  * @param session_id session id, can be 0
987  */
988 void
989 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
990                        const struct GNUNET_PeerIdentity *peer,
991                        const char *plugin_name,
992                        const void *plugin_addr,
993                        size_t plugin_addr_len,
994                        uint32_t session_id)
995 {
996   struct ATS_Address *ea;
997   struct DestroyContext dc;
998
999   if (GNUNET_NO == handle->running)
1000     return;
1001
1002   /* Get existing address */
1003   ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
1004                        session_id, NULL, 0);
1005
1006   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1007               "Received `%s' for peer `%s' address %p session %u\n",
1008               "ADDRESS DESTROY",
1009               GNUNET_i2s (peer), ea, session_id);
1010
1011   if (ea == NULL)
1012   {
1013     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1014                 GNUNET_i2s (peer), plugin_name, session_id);
1015     return;
1016   }
1017
1018   GNUNET_break (0 < strlen (plugin_name));
1019   dc.handle = handle;
1020   dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1021
1022   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1023                                               &destroy_by_session_id, &dc);
1024   free_address (dc.aa);
1025 }
1026
1027
1028 /**
1029  * Notification about active use of an address.
1030  * in_use == GNUNET_YES:
1031  *      This address is used to maintain an active connection with a peer.
1032  * in_use == GNUNET_NO:
1033  *      This address is no longer used to maintain an active connection with a peer.
1034  *
1035  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1036  * before
1037  *
1038  * @param handle the address handle to use
1039  * @param peer peer
1040  * @param plugin_name transport plugin name
1041  * @param plugin_addr plugin address
1042  * @param plugin_addr_len length of the plugin address
1043  * @param session_id session id, can be 0
1044  * @param in_use GNUNET_YES if GNUNET_NO
1045  * @return GNUNET_SYSERR on failure (address unknown ...)
1046  */
1047 int
1048 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1049                       const struct GNUNET_PeerIdentity *peer,
1050                       const char *plugin_name,
1051                       const void *plugin_addr,
1052                       size_t plugin_addr_len,
1053                       uint32_t session_id,
1054                       int in_use)
1055 {
1056   struct ATS_Address *ea;
1057
1058   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1059                 "Received `%s' for peer `%s'\n",
1060                 "ADDRESS IN USE",
1061                 GNUNET_i2s (peer));
1062
1063   if (GNUNET_NO == handle->running)
1064     return GNUNET_SYSERR;
1065
1066   ea = lookup_address (handle, peer, plugin_name,
1067                         plugin_addr, plugin_addr_len,
1068                         session_id, NULL, 0);
1069   if (NULL == ea)
1070   {
1071     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1072                 "Trying to set unknown address `%s', %s %u %s \n",
1073                 GNUNET_i2s (peer),
1074                 plugin_name, session_id,
1075                 (GNUNET_NO == in_use) ? "NO" : "YES");
1076     GNUNET_break (0);
1077     return GNUNET_SYSERR;
1078   }
1079   if (ea->used == in_use)
1080   {
1081     GNUNET_break (0);
1082     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1083                 "Address in use called multiple times for peer `%s': %s -> %s \n",
1084                 GNUNET_i2s (peer),
1085                 (GNUNET_NO == ea->used) ? "NO" : "YES",
1086                 (GNUNET_NO == in_use) ? "NO" : "YES");
1087     return GNUNET_SYSERR;
1088   }
1089
1090   /* Tell solver about update */
1091   handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
1092   ea->used = in_use;
1093
1094   return GNUNET_OK;
1095 }
1096
1097
1098 /**
1099  * Cancel address suggestions for a peer
1100  *
1101  * @param handle the address handle
1102  * @param peer the peer id
1103  */
1104 void
1105 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1106                                       const struct GNUNET_PeerIdentity *peer)
1107 {
1108   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1109
1110   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1111               "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1112
1113   while (NULL != cur)
1114   {
1115       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1116         break; /* found */
1117       cur = cur->next;
1118   }
1119
1120   if (NULL == cur)
1121   {
1122       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1123                   "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1124       return;
1125   }
1126   handle->s_get_stop (handle->solver, handle->addresses, peer);
1127   GAS_addresses_handle_backoff_reset (handle, peer);
1128   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1129               "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1130   GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1131   GNUNET_free (cur);
1132 }
1133
1134
1135 /**
1136  * Request address suggestions for a peer
1137  *
1138  * @param handle the address handle
1139  * @param peer the peer id
1140  */
1141 void
1142 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1143                                const struct GNUNET_PeerIdentity *peer)
1144 {
1145   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1146   struct ATS_Address *aa;
1147
1148   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1149               "Received `%s' for peer `%s'\n",
1150               "REQUEST ADDRESS",
1151               GNUNET_i2s (peer));
1152
1153   if (GNUNET_NO == handle->running)
1154     return;
1155   while (NULL != cur)
1156   {
1157       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1158         break; /* already suggesting */
1159       cur = cur->next;
1160   }
1161   if (NULL == cur)
1162   {
1163       cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1164       cur->id = (*peer);
1165       GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1166   }
1167
1168   /* Get prefered address from solver */
1169   aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1170   if (NULL == aa)
1171   {
1172     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1173                 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1174     return;
1175   }
1176
1177   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1178               "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1179
1180   GAS_scheduling_transmit_address_suggestion (peer,
1181                                               aa->plugin,
1182                                               aa->addr, aa->addr_len,
1183                                               aa->session_id,
1184                                               aa->atsi, aa->atsi_count,
1185                                               aa->assigned_bw_out,
1186                                               aa->assigned_bw_in);
1187
1188   aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1189   aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1190
1191   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1192        "Address %p ready for suggestion, block interval now %llu \n",
1193        aa, aa->block_interval);
1194 }
1195
1196
1197 /**
1198  * Iterator to reset address blocking
1199  *
1200  * @param cls not used
1201  * @param key the peer
1202  * @param value the address to reset
1203  * @return GNUNET_OK to continue
1204  */
1205 static int
1206 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1207 {
1208   struct ATS_Address *aa = value;
1209
1210   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1211               "Resetting interval for peer `%s' address %p from %llu to 0\n",
1212               GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1213
1214   aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1215   aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1216   return GNUNET_OK;
1217 }
1218
1219
1220 /**
1221  * Reset suggestion backoff for a peer
1222  *
1223  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1224  * reset using this function
1225  *
1226  * @param handle the address handle
1227  * @param peer the peer id
1228  */
1229 void
1230 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1231                                     const struct GNUNET_PeerIdentity *peer)
1232 {
1233   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1234               "Received `%s' for peer `%s'\n",
1235               "RESET BACKOFF",
1236               GNUNET_i2s (peer));
1237
1238   GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1239                                               &peer->hashPubKey,
1240                                               &reset_address_it,
1241                                               NULL));
1242 }
1243
1244
1245 /**
1246  * Change the preference for a peer
1247  *
1248  * @param handle the address handle
1249  * @param client the client sending this request
1250  * @param peer the peer id
1251  * @param kind the preference kind to change
1252  * @param score the new preference score
1253  */
1254 void
1255 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1256                                  void *client,
1257                                  const struct GNUNET_PeerIdentity *peer,
1258                                  enum GNUNET_ATS_PreferenceKind kind,
1259                                  float score)
1260 {
1261   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1262               "Received `%s' for peer `%s' for client %p\n",
1263               "CHANGE PREFERENCE",
1264               GNUNET_i2s (peer), client);
1265
1266   if (GNUNET_NO == handle->running)
1267     return;
1268
1269   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1270                                                           &peer->hashPubKey))
1271   {
1272       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1273                   "Received `%s' for unknown peer `%s' from client %p\n",
1274                   "CHANGE PREFERENCE",
1275                   GNUNET_i2s (peer), client);
1276       return;
1277   }
1278
1279   /* Tell solver about update */
1280   handle->s_pref (handle->solver, client, peer, kind, score);
1281 }
1282
1283
1284 /**
1285  * Load quotas for networks from configuration
1286  *
1287  * @param cfg configuration handle
1288  * @param out_dest where to write outbound quotas
1289  * @param in_dest where to write inbound quotas
1290  * @param dest_length length of inbound and outbound arrays
1291  * @return number of networks loaded
1292  */
1293 static unsigned int
1294 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1295 {
1296   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1297   char * entry_in = NULL;
1298   char * entry_out = NULL;
1299   char * quota_out_str;
1300   char * quota_in_str;
1301   int c;
1302   int res;
1303
1304   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1305   {
1306     in_dest[c] = 0;
1307     out_dest[c] = 0;
1308     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1309     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1310
1311     /* quota out */
1312     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
1313     {
1314       res = GNUNET_NO;
1315       if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1316       {
1317         out_dest[c] = GNUNET_ATS_MaxBandwidth;
1318         res = GNUNET_YES;
1319       }
1320       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1321         res = GNUNET_YES;
1322       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out,  &out_dest[c])))
1323          res = GNUNET_YES;
1324
1325       if (GNUNET_NO == res)
1326       {
1327           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1328               network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1329           out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1330       }
1331       else
1332       {
1333           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1334               network_str[c], out_dest[c]);
1335       }
1336       GNUNET_free (quota_out_str);
1337     }
1338     else
1339     {
1340       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1341           network_str[c], GNUNET_ATS_DefaultBandwidth);
1342       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1343     }
1344
1345     /* quota in */
1346     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
1347     {
1348       res = GNUNET_NO;
1349       if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1350       {
1351         in_dest[c] = GNUNET_ATS_MaxBandwidth;
1352         res = GNUNET_YES;
1353       }
1354       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1355         res = GNUNET_YES;
1356       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in,  &in_dest[c])))
1357          res = GNUNET_YES;
1358
1359       if (GNUNET_NO == res)
1360       {
1361           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1362               network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1363           in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1364       }
1365       else
1366       {
1367           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1368               network_str[c], in_dest[c]);
1369       }
1370       GNUNET_free (quota_in_str);
1371     }
1372     else
1373     {
1374       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1375           network_str[c], GNUNET_ATS_DefaultBandwidth);
1376       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1377     }
1378     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]);
1379     GNUNET_free (entry_out);
1380     GNUNET_free (entry_in);
1381   }
1382   return GNUNET_ATS_NetworkTypeCount;
1383 }
1384
1385
1386 /**
1387  * Callback for solver to notify about assignment changes
1388  *
1389  * @param cls the GAS_Addresses_Handle
1390  * @param address the address with changes
1391  */
1392 static void
1393 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1394 {
1395   struct GAS_Addresses_Handle *handle = cls;
1396   struct GAS_Addresses_Suggestion_Requests *cur;
1397
1398   GNUNET_assert (handle != NULL);
1399   GNUNET_assert (address != NULL);
1400
1401   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1402
1403   /* Notify performance clients about changes to address */
1404   GAS_performance_notify_all_clients (&address->peer,
1405       address->plugin,
1406       address->addr, address->addr_len,
1407       address->session_id,
1408       address->atsi, address->atsi_count,
1409       address->assigned_bw_out,
1410       address->assigned_bw_in);
1411   cur = handle->r_head;
1412   while (NULL != cur)
1413   {
1414       if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1415         break; /* we have an address request pending*/
1416       cur = cur->next;
1417   }
1418   if (NULL == cur)
1419   {
1420       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1421                   "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1422       return;
1423   }
1424
1425   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1426               "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1427
1428   /* *Notify scheduling clients about suggestion */
1429   GAS_scheduling_transmit_address_suggestion (&address->peer,
1430                                               address->plugin,
1431                                               address->addr, address->addr_len,
1432                                               address->session_id,
1433                                               address->atsi, address->atsi_count,
1434                                               address->assigned_bw_out,
1435                                               address->assigned_bw_in);
1436 }
1437
1438
1439 /**
1440  * Initialize address subsystem. The addresses subsystem manages the addresses
1441  * known and current performance information. It has a solver component
1442  * responsible for the resource allocation. It tells the solver about changes
1443  * and receives updates when the solver changes the ressource allocation.
1444  *
1445  * @param cfg configuration to use
1446  * @param stats the statistics handle to use
1447  * @return an address handle
1448  */
1449 struct GAS_Addresses_Handle *
1450 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1451                     const struct GNUNET_STATISTICS_Handle *stats)
1452 {
1453   struct GAS_Addresses_Handle *ah;
1454   int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1455   unsigned long long  quotas_in[GNUNET_ATS_NetworkTypeCount];
1456   unsigned long long  quotas_out[GNUNET_ATS_NetworkTypeCount];
1457   int quota_count;
1458   char *mode_str;
1459   int c;
1460
1461   ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1462   ah->running = GNUNET_NO;
1463
1464   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1465   /* Initialize the addresses database */
1466   ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1467   GNUNET_assert (NULL != ah->addresses);
1468
1469   /* Figure out configured solution method */
1470   if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1471   {
1472       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1473       ah->ats_mode = MODE_SIMPLISTIC;
1474   }
1475   else
1476   {
1477       for (c = 0; c < strlen (mode_str); c++)
1478         mode_str[c] = toupper (mode_str[c]);
1479       if (0 == strcmp (mode_str, "SIMPLISTIC"))
1480       {
1481           ah->ats_mode = MODE_SIMPLISTIC;
1482       }
1483       else if (0 == strcmp (mode_str, "MLP"))
1484       {
1485           ah->ats_mode = MODE_MLP;
1486 #if !HAVE_LIBGLPK
1487           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1488           ah->ats_mode = MODE_SIMPLISTIC;
1489 #endif
1490       }
1491       else
1492       {
1493           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1494           ah->ats_mode = MODE_SIMPLISTIC;
1495       }
1496       GNUNET_free (mode_str);
1497   }
1498   /* Start configured solution method */
1499   switch (ah->ats_mode)
1500   {
1501     case MODE_MLP:
1502       /* Init the MLP solver with default values */
1503 #if HAVE_LIBGLPK
1504       ah->ats_mode = MODE_MLP;
1505       ah->s_init = &GAS_mlp_init;
1506       ah->s_add = &GAS_mlp_address_add;
1507       ah->s_update = &GAS_mlp_address_update;
1508       ah->s_get = &GAS_mlp_get_preferred_address;
1509       ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1510       ah->s_pref = &GAS_mlp_address_change_preference;
1511       ah->s_del =  &GAS_mlp_address_delete;
1512       ah->s_done = &GAS_mlp_done;
1513 #else
1514       GNUNET_free (ah);
1515       return NULL;
1516 #endif
1517       break;
1518     case MODE_SIMPLISTIC:
1519       /* Init the simplistic solver with default values */
1520       ah->ats_mode = MODE_SIMPLISTIC;
1521       ah->s_init = &GAS_simplistic_init;
1522       ah->s_add = &GAS_simplistic_address_add;
1523       ah->s_update = &GAS_simplistic_address_update;
1524       ah->s_get = &GAS_simplistic_get_preferred_address;
1525       ah->s_get_stop = &GAS_simplistic_stop_get_preferred_address;
1526       ah->s_pref = &GAS_simplistic_address_change_preference;
1527       ah->s_del  = &GAS_simplistic_address_delete;
1528       ah->s_done = &GAS_simplistic_done;
1529       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1530       break;
1531     default:
1532       return NULL;
1533       break;
1534   }
1535
1536   GNUNET_assert (NULL != ah->s_init);
1537   GNUNET_assert (NULL != ah->s_add);
1538   GNUNET_assert (NULL != ah->s_update);
1539   GNUNET_assert (NULL != ah->s_get);
1540   GNUNET_assert (NULL != ah->s_get_stop);
1541   GNUNET_assert (NULL != ah->s_pref);
1542   GNUNET_assert (NULL != ah->s_del);
1543   GNUNET_assert (NULL != ah->s_done);
1544
1545   quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1546
1547   ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1548   if (NULL == ah->solver)
1549   {
1550     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1551     GNUNET_free (ah);
1552     return NULL;
1553   }
1554
1555   /* up and running */
1556   ah->running = GNUNET_YES;
1557   return ah;
1558 }
1559
1560
1561 /**
1562  * Free memory of address.
1563  *
1564  * @param cls NULL
1565  * @param key peer identity (unused)
1566  * @param value the 'struct ATS_Address' to free
1567  * @return GNUNET_OK (continue to iterate)
1568  */
1569 static int
1570 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1571 {
1572   struct GAS_Addresses_Handle *handle = cls;
1573   struct ATS_Address *aa = value;
1574   handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1575   destroy_address (handle, aa);
1576   return GNUNET_OK;
1577 }
1578
1579
1580 /**
1581  * Remove all addresses
1582  *
1583  * @param handle the address handle to use
1584  */
1585 void
1586 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1587 {
1588   if (GNUNET_NO == handle->running)
1589     return;
1590
1591   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1592               "Received `%s'\n",
1593               "DESTROY ALL");
1594
1595   if (handle->addresses != NULL)
1596     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1597 }
1598
1599
1600 /**
1601  * Shutdown address subsystem.
1602  *
1603  * @param handle the address handle to shutdown
1604  */
1605 void
1606 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1607 {
1608   struct GAS_Addresses_Suggestion_Requests *cur;
1609
1610   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1611               "Shutting down addresses\n");
1612   GNUNET_assert (NULL != handle);
1613   GAS_addresses_destroy_all (handle);
1614   handle->running = GNUNET_NO;
1615   GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1616   handle->addresses = NULL;
1617   while (NULL != (cur = handle->r_head))
1618   {
1619       GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1620       GNUNET_free (cur);
1621   }
1622   handle->s_done (handle->solver);
1623   GNUNET_free (handle);
1624   /* Stop configured solution method */
1625
1626 }
1627
1628
1629 struct PeerIteratorContext
1630 {
1631   GNUNET_ATS_Peer_Iterator it;
1632   void *it_cls;
1633   struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1634 };
1635
1636
1637 /**
1638  * Iterator to iterate over all peers
1639  *
1640  * @param cls a PeerIteratorContext
1641  * @param key the peer id
1642  * @param value the ATS_address
1643  * @return GNUNET_OK to continue
1644  */
1645 static int
1646 peer_it (void *cls,
1647          const struct GNUNET_HashCode * key,
1648          void *value)
1649 {
1650   struct PeerIteratorContext *ip_ctx = cls;
1651   struct GNUNET_PeerIdentity tmp;
1652
1653   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1654   {
1655       GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1656       tmp.hashPubKey = (*key);
1657       ip_ctx->it (ip_ctx->it_cls, &tmp);
1658   }
1659
1660   return GNUNET_OK;
1661 }
1662
1663
1664 /**
1665  * Return information all peers currently known to ATS
1666  *
1667  * @param handle the address handle to use
1668  * @param p_it the iterator to call for every peer
1669  * @param p_it_cls the closure for the iterator
1670  */
1671 void
1672 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1673                                                                                                                  GNUNET_ATS_Peer_Iterator p_it,
1674                                                                                                                  void *p_it_cls)
1675 {
1676   struct PeerIteratorContext ip_ctx;
1677   unsigned int size;
1678
1679   if (NULL == p_it)
1680       return;
1681   GNUNET_assert (NULL != handle->addresses);
1682
1683   size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1684   if (0 != size)
1685   {
1686     ip_ctx.it = p_it;
1687     ip_ctx.it_cls = p_it_cls;
1688     ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1689     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1690     GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1691   }
1692   p_it (p_it_cls, NULL);
1693 }
1694
1695
1696 struct PeerInfoIteratorContext
1697 {
1698   GNUNET_ATS_PeerInfo_Iterator it;
1699   void *it_cls;
1700 };
1701
1702
1703 /**
1704  * Iterator to iterate over a peer's addresses
1705  *
1706  * @param cls a PeerInfoIteratorContext
1707  * @param key the peer id
1708  * @param value the ATS_address
1709  * @return GNUNET_OK to continue
1710  */
1711 static int 
1712 peerinfo_it (void *cls,
1713              const struct GNUNET_HashCode * key,
1714              void *value)
1715 {
1716   struct PeerInfoIteratorContext *pi_ctx = cls;
1717   struct ATS_Address *addr = (struct ATS_Address *)  value;
1718
1719   if (NULL != pi_ctx->it)
1720   {
1721     pi_ctx->it (pi_ctx->it_cls,
1722                 &addr->peer,
1723                 addr->plugin,
1724                 addr->addr, addr->addr_len,
1725                 addr->active,
1726                 addr->atsi, addr->atsi_count,
1727                 addr->assigned_bw_out,
1728                 addr->assigned_bw_in);
1729   }
1730   return GNUNET_YES;
1731 }
1732
1733
1734 /**
1735  * Return information all peers currently known to ATS
1736  *
1737  * @param handle the address handle to use
1738  * @param peer the respective peer
1739  * @param pi_it the iterator to call for every peer
1740  * @param pi_it_cls the closure for the iterator
1741  */
1742 void
1743 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1744                              const struct GNUNET_PeerIdentity *peer,
1745                              GNUNET_ATS_PeerInfo_Iterator pi_it,
1746                              void *pi_it_cls)
1747 {
1748   struct PeerInfoIteratorContext pi_ctx;
1749   struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1750   GNUNET_assert (NULL != peer);
1751   GNUNET_assert (NULL != handle->addresses);
1752   if (NULL == pi_it)
1753     return; /* does not make sense without callback */
1754
1755   zero_bw = GNUNET_BANDWIDTH_value_init (0);
1756   pi_ctx.it = pi_it;
1757   pi_ctx.it_cls = pi_it_cls;
1758
1759   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1760
1761   if (NULL != pi_it)
1762     pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1763
1764 }
1765
1766
1767 /* end of gnunet-service-ats_addresses.c */