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