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