changing solver api: remove address hashmap from functions and pass instead with...
[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     handle->s_bulk_start (handle->solver);
823     GAS_normalization_normalize_property (handle->addresses, aa, atsi, atsi_count);
824     handle->s_bulk_stop (handle->solver);
825     handle->s_add (handle->solver, aa, addr_net);
826     /* Notify performance clients about new address */
827     GAS_performance_notify_all_clients (&aa->peer,
828         aa->plugin,
829         aa->addr, aa->addr_len,
830         aa->session_id,
831         aa->atsi, aa->atsi_count,
832         aa->assigned_bw_out,
833         aa->assigned_bw_in);
834     return;
835   }
836
837   GNUNET_free (aa->plugin);
838   GNUNET_free_non_null (aa->atsi);
839   GNUNET_free (aa);
840   aa = NULL;
841
842   if (ea->session_id != 0)
843   {
844       /* This address with the same session is already existing
845        * Should not happen */
846       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
847                 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
848                 GNUNET_i2s (peer), plugin_name, session_id);
849       GNUNET_break (0);
850       return;
851   }
852
853   /* We have an address without an session, update this address */
854   atsi_delta = NULL;
855   atsi_delta_count = 0;
856   if (GNUNET_YES == disassemble_ats_information (ea, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
857   {
858                 GAS_performance_notify_all_clients (&ea->peer,
859                                 ea->plugin,
860                                 ea->addr, ea->addr_len,
861                                 ea->session_id,
862                                 ea->atsi, ea->atsi_count,
863                                 ea->assigned_bw_out,
864                                 ea->assigned_bw_in);
865   }
866
867   /* Notify solver about update with atsi information and session */
868   handle->s_bulk_start (handle->solver);
869   GAS_normalization_normalize_property (handle->addresses, ea, atsi, atsi_count);
870   handle->s_bulk_stop (handle->solver);
871   handle->s_update (handle->solver, ea, session_id, ea->used, atsi_delta, atsi_delta_count);
872   GNUNET_free_non_null (atsi_delta);
873
874   /* Do the update */
875   ea->session_id = session_id;
876   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
877            "Updated existing address for peer `%s' %p with new session %u\n",
878            GNUNET_i2s (peer), ea, session_id);
879 }
880
881
882 /**
883  * Update an address with a session or performance information for a peer.
884  *
885  * If an address was added without a session it will be updated with the
886  * session
887  *
888  * @param handle the address handle to use
889  * @param peer peer
890  * @param plugin_name transport plugin name
891  * @param plugin_addr plugin address
892  * @param plugin_addr_len length of the plugin address
893  * @param session_id session id, can be 0
894  * @param atsi performance information for this address
895  * @param atsi_count number of performance information contained
896  */
897 void
898 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
899                       const struct GNUNET_PeerIdentity *peer,
900                       const char *plugin_name, const void *plugin_addr,
901                       size_t plugin_addr_len, uint32_t session_id,
902                       const struct GNUNET_ATS_Information *atsi,
903                       uint32_t atsi_count)
904 {
905   struct ATS_Address *aa;
906   struct GNUNET_ATS_Information *atsi_delta;
907   uint32_t atsi_delta_count;
908   uint32_t prev_session;
909
910   if (GNUNET_NO == handle->running)
911     return;
912
913   GNUNET_assert (NULL != handle->addresses);
914
915   /* Get existing address */
916   aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
917                        session_id, atsi, atsi_count);
918   if (aa == NULL)
919   {
920     /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
921     /*             GNUNET_i2s (peer), plugin_name, session_id); */
922     /* GNUNET_break (0); */
923     return;
924   }
925
926   if (NULL == aa->solver_information)
927   {
928     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
929                  GNUNET_i2s (peer), plugin_name, session_id);
930     return;
931   }
932
933   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
934                 "Received `%s' for peer `%s' address \n",
935                 "ADDRESS UPDATE",
936                 GNUNET_i2s (peer), aa);
937
938   /* Update address */
939   atsi_delta = NULL;
940   atsi_delta_count = 0;
941   if (GNUNET_YES == disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
942   {
943                 /* Notify performance clients about updated address */
944                 GAS_performance_notify_all_clients (&aa->peer,
945                                 aa->plugin,
946                                 aa->addr, aa->addr_len,
947                                 aa->session_id,
948                                 aa->atsi, aa->atsi_count,
949                                 aa->assigned_bw_out,
950                                 aa->assigned_bw_in);
951   }
952   prev_session = aa->session_id;
953   aa->session_id = session_id;
954
955   handle->s_bulk_start (handle->solver);
956   GAS_normalization_normalize_property (handle->addresses, aa, atsi, atsi_count);
957   handle->s_bulk_stop (handle->solver);
958
959   /* Tell solver about update */
960   handle->s_update (handle->solver, aa, prev_session, aa->used, atsi_delta, atsi_delta_count);
961   GNUNET_free_non_null (atsi_delta);
962 }
963
964
965 struct DestroyContext
966 {
967   struct ATS_Address *aa;
968
969   struct GAS_Addresses_Handle *handle;
970
971   /**
972    * GNUNET_NO  : full address
973    * GNUNET_YES : just session
974    */
975   int result;
976 };
977
978
979 /**
980  * Delete an address
981  *
982  * If session != 0, just the session is deleted, the address itself still exists
983  * If session == 0, remove full address
984  * If session == 0 and addrlen == 0, destroy inbound address
985  *
986  * @param cls unused
987  * @param key unused
988  * @param value the 'struct ATS_Address'
989  * @return GNUNET_OK (continue to iterate)
990  */
991 static int
992 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
993 {
994   struct DestroyContext *dc = cls;
995   struct GAS_Addresses_Handle *handle = dc->handle;
996   const struct ATS_Address *des = dc->aa;
997   struct ATS_Address *aa = value;
998
999   GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
1000                               sizeof (struct GNUNET_PeerIdentity)));
1001
1002
1003   if (des->session_id == 0)
1004   {
1005     /* Session == 0, remove full address  */
1006     if ((0 == strcmp (des->plugin, aa->plugin)) &&
1007         (aa->addr_len == des->addr_len) &&
1008         (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
1009     {
1010
1011       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1012                   "Deleting full address for peer `%s' session %u %p\n",
1013                   GNUNET_i2s (&aa->peer), aa->session_id, aa);
1014
1015       /* Notify solver about deletion */
1016       handle->s_del (handle->solver, aa, GNUNET_NO);
1017       destroy_address (handle, aa);
1018       dc->result = GNUNET_NO;
1019       return GNUNET_OK; /* Continue iteration */
1020     }
1021   }
1022   else
1023   {
1024     /* Session != 0, just remove session */
1025     if (aa->session_id != des->session_id)
1026       return GNUNET_OK; /* irrelevant */
1027
1028     if ((aa->session_id != 0) &&
1029         (0 != strcmp (des->plugin, aa->plugin)))
1030     {
1031         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1032                     "Different plugins during removal: `%s' vs `%s' \n",
1033                     des->plugin, aa->plugin);
1034         GNUNET_break (0);
1035         return GNUNET_OK;
1036     }
1037
1038     if (aa->addr_len == 0)
1039     {
1040         /* Inbound connection died, delete full address */
1041         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1042                     "Deleting inbound address for peer `%s': `%s' session %u\n",
1043                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1044
1045         /* Notify solver about deletion */
1046         handle->s_del (handle->solver, aa, GNUNET_NO);
1047         destroy_address (handle, aa);
1048         dc->result = GNUNET_NO;
1049         return GNUNET_OK; /* Continue iteration */
1050     }
1051     else
1052     {
1053         /* Session died */
1054         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1055                     "Deleting session for peer `%s': `%s' %u\n",
1056                     GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1057         /* Notify solver to delete session */
1058         handle->s_del (handle->solver, aa, GNUNET_YES);
1059         aa->session_id = 0;
1060         return GNUNET_OK;
1061     }
1062   }
1063   return GNUNET_OK;
1064 }
1065
1066
1067 /**
1068  * Remove an address or just a session for a peer.
1069  *
1070  * @param handle the address handle to use
1071  * @param peer peer
1072  * @param plugin_name transport plugin name
1073  * @param plugin_addr plugin address
1074  * @param plugin_addr_len length of the plugin address
1075  * @param session_id session id, can be 0
1076  */
1077 void
1078 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
1079                        const struct GNUNET_PeerIdentity *peer,
1080                        const char *plugin_name,
1081                        const void *plugin_addr,
1082                        size_t plugin_addr_len,
1083                        uint32_t session_id)
1084 {
1085   struct ATS_Address *ea;
1086   struct DestroyContext dc;
1087
1088   if (GNUNET_NO == handle->running)
1089     return;
1090
1091   /* Get existing address */
1092   ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
1093                        session_id, NULL, 0);
1094
1095   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1096               "Received `%s' for peer `%s' address %p session %u\n",
1097               "ADDRESS DESTROY",
1098               GNUNET_i2s (peer), ea, session_id);
1099
1100   if (ea == NULL)
1101   {
1102     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1103                 GNUNET_i2s (peer), plugin_name, session_id);
1104     return;
1105   }
1106
1107   GNUNET_break (0 < strlen (plugin_name));
1108   dc.handle = handle;
1109   dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1110
1111   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1112                                               &destroy_by_session_id, &dc);
1113   free_address (dc.aa);
1114 }
1115
1116
1117 /**
1118  * Notification about active use of an address.
1119  * in_use == GNUNET_YES:
1120  *      This address is used to maintain an active connection with a peer.
1121  * in_use == GNUNET_NO:
1122  *      This address is no longer used to maintain an active connection with a peer.
1123  *
1124  * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1125  * before
1126  *
1127  * @param handle the address handle to use
1128  * @param peer peer
1129  * @param plugin_name transport plugin name
1130  * @param plugin_addr plugin address
1131  * @param plugin_addr_len length of the plugin address
1132  * @param session_id session id, can be 0
1133  * @param in_use GNUNET_YES if GNUNET_NO
1134  * @return GNUNET_SYSERR on failure (address unknown ...)
1135  */
1136 int
1137 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1138                       const struct GNUNET_PeerIdentity *peer,
1139                       const char *plugin_name,
1140                       const void *plugin_addr,
1141                       size_t plugin_addr_len,
1142                       uint32_t session_id,
1143                       int in_use)
1144 {
1145   struct ATS_Address *ea;
1146   int prev_inuse;
1147
1148   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1149                 "Received `%s' for peer `%s'\n",
1150                 "ADDRESS IN USE",
1151                 GNUNET_i2s (peer));
1152
1153   if (GNUNET_NO == handle->running)
1154     return GNUNET_SYSERR;
1155
1156   ea = lookup_address (handle, peer, plugin_name,
1157                         plugin_addr, plugin_addr_len,
1158                         session_id, NULL, 0);
1159   if (NULL == ea)
1160   {
1161     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1162                 "Trying to set unknown address `%s', %s %u %s \n",
1163                 GNUNET_i2s (peer),
1164                 plugin_name, session_id,
1165                 (GNUNET_NO == in_use) ? "NO" : "YES");
1166     GNUNET_break (0);
1167     return GNUNET_SYSERR;
1168   }
1169   if (ea->used == in_use)
1170   {
1171     GNUNET_break (0);
1172     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1173                 "Address in use called multiple times for peer `%s': %s -> %s \n",
1174                 GNUNET_i2s (peer),
1175                 (GNUNET_NO == ea->used) ? "NO" : "YES",
1176                 (GNUNET_NO == in_use) ? "NO" : "YES");
1177     return GNUNET_SYSERR;
1178   }
1179
1180   /* Tell solver about update */
1181   prev_inuse = ea->used;
1182   ea->used = in_use;
1183   handle->s_update (handle->solver, ea, session_id, prev_inuse, NULL, 0);
1184
1185
1186   return GNUNET_OK;
1187 }
1188
1189
1190 /**
1191  * Cancel address suggestions for a peer
1192  *
1193  * @param handle the address handle
1194  * @param peer the peer id
1195  */
1196 void
1197 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1198                                       const struct GNUNET_PeerIdentity *peer)
1199 {
1200   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1201
1202   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1203               "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1204
1205   while (NULL != cur)
1206   {
1207       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1208         break; /* found */
1209       cur = cur->next;
1210   }
1211
1212   if (NULL == cur)
1213   {
1214       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1215                   "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1216       return;
1217   }
1218   handle->s_get_stop (handle->solver, peer);
1219   GAS_addresses_handle_backoff_reset (handle, peer);
1220   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1221               "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1222   GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1223   GNUNET_free (cur);
1224 }
1225
1226
1227 /**
1228  * Request address suggestions for a peer
1229  *
1230  * @param handle the address handle
1231  * @param peer the peer id
1232  */
1233 void
1234 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1235                                const struct GNUNET_PeerIdentity *peer)
1236 {
1237   struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1238   struct ATS_Address *aa;
1239
1240   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1241               "Received `%s' for peer `%s'\n",
1242               "REQUEST ADDRESS",
1243               GNUNET_i2s (peer));
1244
1245   if (GNUNET_NO == handle->running)
1246     return;
1247   while (NULL != cur)
1248   {
1249       if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1250         break; /* already suggesting */
1251       cur = cur->next;
1252   }
1253   if (NULL == cur)
1254   {
1255       cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1256       cur->id = (*peer);
1257       GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1258   }
1259
1260   /* Get prefered address from solver */
1261   aa = (struct ATS_Address *) handle->s_get (handle->solver, peer);
1262   if (NULL == aa)
1263   {
1264     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1265                 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1266     return;
1267   }
1268
1269   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1270               "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1271
1272   GAS_scheduling_transmit_address_suggestion (peer,
1273                                               aa->plugin,
1274                                               aa->addr, aa->addr_len,
1275                                               aa->session_id,
1276                                               aa->atsi, aa->atsi_count,
1277                                               aa->assigned_bw_out,
1278                                               aa->assigned_bw_in);
1279
1280   aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1281   aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1282
1283   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1284        "Address %p ready for suggestion, block interval now %llu \n",
1285        aa, aa->block_interval);
1286 }
1287
1288
1289 /**
1290  * Iterator to reset address blocking
1291  *
1292  * @param cls not used
1293  * @param key the peer
1294  * @param value the address to reset
1295  * @return GNUNET_OK to continue
1296  */
1297 static int
1298 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1299 {
1300   struct ATS_Address *aa = value;
1301
1302   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1303               "Resetting interval for peer `%s' address %p from %llu to 0\n",
1304               GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1305
1306   aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1307   aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1308   return GNUNET_OK;
1309 }
1310
1311
1312 /**
1313  * Reset suggestion backoff for a peer
1314  *
1315  * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1316  * reset using this function
1317  *
1318  * @param handle the address handle
1319  * @param peer the peer id
1320  */
1321 void
1322 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1323                                     const struct GNUNET_PeerIdentity *peer)
1324 {
1325   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1326               "Received `%s' for peer `%s'\n",
1327               "RESET BACKOFF",
1328               GNUNET_i2s (peer));
1329
1330   GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1331                                               &peer->hashPubKey,
1332                                               &reset_address_it,
1333                                               NULL));
1334 }
1335
1336
1337 /**
1338  * The preference changed for a peer
1339  *
1340  * @param cls the address handle
1341  * @param peer the peer
1342  * @param kind the ATS kind
1343  * @param pref_rel the new relative preference value
1344  */
1345 static void
1346 normalized_preference_changed_cb (void *cls,
1347                                                                   const struct GNUNET_PeerIdentity *peer,
1348                                                                   enum GNUNET_ATS_PreferenceKind kind,
1349                                                                   double pref_rel)
1350 {
1351         GNUNET_assert (NULL != cls);
1352         struct GAS_Addresses_Handle *handle = cls;
1353   /* Tell solver about update */
1354   handle->s_pref (handle->solver, peer, kind, pref_rel);
1355 }
1356
1357
1358 /**
1359  * The relative value for a property changed
1360  *
1361  * @param cls the address handle
1362  * @param peer the peer
1363  * @param type the ATS type
1364  * @param prop_rel the new relative preference value
1365  */
1366 static void
1367 normalized_property_changed_cb (void *cls,
1368                                                                                                                  const struct ATS_Address *peer,
1369                                                                                                                  uint32_t type,
1370                                                                                                                  double prop_rel)
1371 {
1372         GNUNET_assert (NULL != cls);
1373         //struct GAS_Addresses_Handle *handle = cls;
1374   /* Tell solver about update */
1375         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1376               "Normalized property %s for peer `%s' changed to %.3f \n",
1377               GNUNET_ATS_print_property_type (type),
1378               GNUNET_i2s (&peer->peer),
1379               prop_rel);
1380 }
1381
1382
1383 /**
1384  * Function allowing the solver to obtain normalized preference
1385  * values from solver
1386  *
1387  * @param cls unused
1388  * @param id the peer to return the normalized properties for
1389  * @return array of double values with |GNUNET_ATS_PreferenceCount| elements
1390  */
1391 const double *
1392 get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
1393 {
1394         return GAS_normalization_get_preferences (id);
1395 }
1396
1397 /**
1398  * Function allowing the solver to obtain normalized property
1399  * values for an address from solver
1400  *
1401  * @param cls unused
1402  * @param id the peer to return the normalized properties for
1403  * @return array of double values with |GNUNET_ATS_QualityPropertiesCount| elements
1404  */
1405 const double *
1406 get_property_cb (void *cls, const struct ATS_Address *address)
1407 {
1408         return GAS_normalization_get_properties ((struct ATS_Address *) address);
1409 }
1410
1411 /**
1412  * Change the preference for a peer
1413  *
1414  * @param handle the address handle
1415  * @param client the client sending this request
1416  * @param peer the peer id
1417  * @param kind the preference kind to change
1418  * @param score_abs the new preference score
1419  */
1420 void
1421 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1422                                  void *client,
1423                                  const struct GNUNET_PeerIdentity *peer,
1424                                  enum GNUNET_ATS_PreferenceKind kind,
1425                                  float score_abs)
1426 {
1427         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1428               "Received `%s' for peer `%s' for client %p\n",
1429               "CHANGE PREFERENCE",
1430               GNUNET_i2s (peer), client);
1431
1432   if (GNUNET_NO == handle->running)
1433     return;
1434
1435   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1436                                                           &peer->hashPubKey))
1437   {
1438       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1439                   "Received `%s' for unknown peer `%s' from client %p\n",
1440                   "CHANGE PREFERENCE",
1441                   GNUNET_i2s (peer), client);
1442       return;
1443   }
1444
1445   handle->s_bulk_start (handle->solver);
1446   /* Tell normalization about change, normalization will call callback if preference changed */
1447   GAS_normalization_normalize_preference (client, peer, kind, score_abs);
1448   handle->s_bulk_stop (handle->solver);
1449 }
1450
1451
1452 /**
1453  * Load quotas for networks from configuration
1454  *
1455  * @param cfg configuration handle
1456  * @param out_dest where to write outbound quotas
1457  * @param in_dest where to write inbound quotas
1458  * @param dest_length length of inbound and outbound arrays
1459  * @return number of networks loaded
1460  */
1461 static unsigned int
1462 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1463 {
1464   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1465   char * entry_in = NULL;
1466   char * entry_out = NULL;
1467   char * quota_out_str;
1468   char * quota_in_str;
1469   int c;
1470   int res;
1471
1472   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1473   {
1474     in_dest[c] = 0;
1475     out_dest[c] = 0;
1476     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1477     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1478
1479     /* quota out */
1480     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
1481     {
1482       res = GNUNET_NO;
1483       if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1484       {
1485         out_dest[c] = GNUNET_ATS_MaxBandwidth;
1486         res = GNUNET_YES;
1487       }
1488       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1489         res = GNUNET_YES;
1490       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out,  &out_dest[c])))
1491          res = GNUNET_YES;
1492
1493       if (GNUNET_NO == res)
1494       {
1495           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1496               network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1497           out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1498       }
1499       else
1500       {
1501           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1502               network_str[c], out_dest[c]);
1503       }
1504       GNUNET_free (quota_out_str);
1505     }
1506     else
1507     {
1508       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1509           network_str[c], GNUNET_ATS_DefaultBandwidth);
1510       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1511     }
1512
1513     /* quota in */
1514     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
1515     {
1516       res = GNUNET_NO;
1517       if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1518       {
1519         in_dest[c] = GNUNET_ATS_MaxBandwidth;
1520         res = GNUNET_YES;
1521       }
1522       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1523         res = GNUNET_YES;
1524       if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in,  &in_dest[c])))
1525          res = GNUNET_YES;
1526
1527       if (GNUNET_NO == res)
1528       {
1529           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s':  `%s', assigning default bandwidth %llu\n"),
1530               network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1531           in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1532       }
1533       else
1534       {
1535           GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1536               network_str[c], in_dest[c]);
1537       }
1538       GNUNET_free (quota_in_str);
1539     }
1540     else
1541     {
1542       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1543           network_str[c], GNUNET_ATS_DefaultBandwidth);
1544       out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1545     }
1546     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]);
1547     GNUNET_free (entry_out);
1548     GNUNET_free (entry_in);
1549   }
1550   return GNUNET_ATS_NetworkTypeCount;
1551 }
1552
1553
1554 /**
1555  * Callback for solver to notify about assignment changes
1556  *
1557  * @param cls the GAS_Addresses_Handle
1558  * @param address the address with changes
1559  */
1560 static void
1561 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1562 {
1563   struct GAS_Addresses_Handle *handle = cls;
1564   struct GAS_Addresses_Suggestion_Requests *cur;
1565
1566   GNUNET_assert (handle != NULL);
1567   GNUNET_assert (address != NULL);
1568
1569   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1570
1571   /* Notify performance clients about changes to address */
1572   GAS_performance_notify_all_clients (&address->peer,
1573       address->plugin,
1574       address->addr, address->addr_len,
1575       address->session_id,
1576       address->atsi, address->atsi_count,
1577       address->assigned_bw_out,
1578       address->assigned_bw_in);
1579   cur = handle->r_head;
1580   while (NULL != cur)
1581   {
1582       if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1583         break; /* we have an address request pending*/
1584       cur = cur->next;
1585   }
1586   if (NULL == cur)
1587   {
1588       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1589                   "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1590       return;
1591   }
1592
1593   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1594               "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1595
1596   /* *Notify scheduling clients about suggestion */
1597   GAS_scheduling_transmit_address_suggestion (&address->peer,
1598                                               address->plugin,
1599                                               address->addr, address->addr_len,
1600                                               address->session_id,
1601                                               address->atsi, address->atsi_count,
1602                                               address->assigned_bw_out,
1603                                               address->assigned_bw_in);
1604 }
1605
1606
1607 /**
1608  * Initialize address subsystem. The addresses subsystem manages the addresses
1609  * known and current performance information. It has a solver component
1610  * responsible for the resource allocation. It tells the solver about changes
1611  * and receives updates when the solver changes the ressource allocation.
1612  *
1613  * @param cfg configuration to use
1614  * @param stats the statistics handle to use
1615  * @return an address handle
1616  */
1617 struct GAS_Addresses_Handle *
1618 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1619                     const struct GNUNET_STATISTICS_Handle *stats)
1620 {
1621   struct GAS_Addresses_Handle *ah;
1622   int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1623   unsigned long long  quotas_in[GNUNET_ATS_NetworkTypeCount];
1624   unsigned long long  quotas_out[GNUNET_ATS_NetworkTypeCount];
1625   int quota_count;
1626   char *mode_str;
1627   int c;
1628
1629   ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1630   ah->running = GNUNET_NO;
1631
1632   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1633   /* Initialize the addresses database */
1634   ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1635   GNUNET_assert (NULL != ah->addresses);
1636
1637   /* Figure out configured solution method */
1638   if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1639   {
1640       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1641       ah->ats_mode = MODE_SIMPLISTIC;
1642   }
1643   else
1644   {
1645       for (c = 0; c < strlen (mode_str); c++)
1646         mode_str[c] = toupper (mode_str[c]);
1647       if (0 == strcmp (mode_str, "SIMPLISTIC"))
1648       {
1649           ah->ats_mode = MODE_SIMPLISTIC;
1650       }
1651       else if (0 == strcmp (mode_str, "MLP"))
1652       {
1653           ah->ats_mode = MODE_MLP;
1654 #if !HAVE_LIBGLPK
1655           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1656           ah->ats_mode = MODE_SIMPLISTIC;
1657 #endif
1658       }
1659       else
1660       {
1661           GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1662           ah->ats_mode = MODE_SIMPLISTIC;
1663       }
1664       GNUNET_free (mode_str);
1665   }
1666   /* Start configured solution method */
1667   switch (ah->ats_mode)
1668   {
1669     case MODE_MLP:
1670       /* Init the MLP solver with default values */
1671 #if HAVE_LIBGLPK
1672       ah->ats_mode = MODE_MLP;
1673       ah->s_init = &GAS_mlp_init;
1674       ah->s_add = &GAS_mlp_address_add;
1675       ah->s_update = &GAS_mlp_address_update;
1676       ah->s_get = &GAS_mlp_get_preferred_address;
1677       ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1678       ah->s_pref = &GAS_mlp_address_change_preference;
1679       ah->s_del =  &GAS_mlp_address_delete;
1680       ah->s_bulk_start = &GAS_mlp_bulk_start;
1681       ah->s_bulk_stop = &GAS_mlp_bulk_stop;
1682       ah->s_done = &GAS_mlp_done;
1683 #else
1684
1685       GNUNET_free (ah);
1686       return NULL;
1687 #endif
1688       break;
1689     case MODE_SIMPLISTIC:
1690       /* Init the simplistic solver with default values */
1691       ah->ats_mode = MODE_SIMPLISTIC;
1692       ah->s_init = &GAS_proportional_init;
1693       ah->s_add = &GAS_proportional_address_add;
1694       ah->s_update = &GAS_proportional_address_update;
1695       ah->s_get = &GAS_proportional_get_preferred_address;
1696       ah->s_get_stop = &GAS_proportional_stop_get_preferred_address;
1697       ah->s_pref = &GAS_proportional_address_change_preference;
1698       ah->s_del  = &GAS_proportional_address_delete;
1699       ah->s_bulk_start = &GAS_proportional_bulk_start;
1700       ah->s_bulk_stop = &GAS_proportional_bulk_stop;
1701       ah->s_done = &GAS_proportional_done;
1702       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1703       break;
1704     default:
1705       return NULL;
1706       break;
1707   }
1708
1709   GNUNET_assert (NULL != ah->s_init);
1710   GNUNET_assert (NULL != ah->s_add);
1711   GNUNET_assert (NULL != ah->s_update);
1712   GNUNET_assert (NULL != ah->s_get);
1713   GNUNET_assert (NULL != ah->s_get_stop);
1714   GNUNET_assert (NULL != ah->s_pref);
1715   GNUNET_assert (NULL != ah->s_del);
1716   GNUNET_assert (NULL != ah->s_done);
1717   GNUNET_assert (NULL != ah->s_bulk_start);
1718   GNUNET_assert (NULL != ah->s_bulk_stop);
1719
1720   GAS_normalization_start (&normalized_preference_changed_cb, ah,
1721                                                                                                  &normalized_property_changed_cb, ah);
1722   quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1723
1724   ah->solver = ah->s_init (cfg, stats, ah->addresses,
1725                   quotas, quotas_in, quotas_out, quota_count,
1726                   &bandwidth_changed_cb, ah,
1727                   &get_preferences_cb, NULL,
1728                   &get_property_cb, NULL);
1729   if (NULL == ah->solver)
1730   {
1731     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1732     GNUNET_free (ah);
1733     return NULL;
1734   }
1735
1736   /* up and running */
1737   ah->running = GNUNET_YES;
1738   return ah;
1739 }
1740
1741
1742 /**
1743  * Free memory of address.
1744  *
1745  * @param cls NULL
1746  * @param key peer identity (unused)
1747  * @param value the 'struct ATS_Address' to free
1748  * @return GNUNET_OK (continue to iterate)
1749  */
1750 static int
1751 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1752 {
1753   struct GAS_Addresses_Handle *handle = cls;
1754   struct ATS_Address *aa = value;
1755   handle->s_del (handle->solver, aa, GNUNET_NO);
1756   destroy_address (handle, aa);
1757   return GNUNET_OK;
1758 }
1759
1760
1761 /**
1762  * Remove all addresses
1763  *
1764  * @param handle the address handle to use
1765  */
1766 void
1767 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1768 {
1769   if (GNUNET_NO == handle->running)
1770     return;
1771
1772   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1773               "Received `%s'\n",
1774               "DESTROY ALL");
1775
1776   if (handle->addresses != NULL)
1777     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1778 }
1779
1780
1781 /**
1782  * Shutdown address subsystem.
1783  *
1784  * @param handle the address handle to shutdown
1785  */
1786 void
1787 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1788 {
1789   struct GAS_Addresses_Suggestion_Requests *cur;
1790
1791   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1792               "Shutting down addresses\n");
1793   GNUNET_assert (NULL != handle);
1794   GAS_addresses_destroy_all (handle);
1795   handle->running = GNUNET_NO;
1796   GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1797   handle->addresses = NULL;
1798   while (NULL != (cur = handle->r_head))
1799   {
1800       GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1801       GNUNET_free (cur);
1802   }
1803   handle->s_done (handle->solver);
1804   GNUNET_free (handle);
1805   /* Stop configured solution method */
1806   GAS_normalization_stop ();
1807 }
1808
1809
1810 struct PeerIteratorContext
1811 {
1812   GNUNET_ATS_Peer_Iterator it;
1813   void *it_cls;
1814   struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1815 };
1816
1817
1818 /**
1819  * Iterator to iterate over all peers
1820  *
1821  * @param cls a PeerIteratorContext
1822  * @param key the peer id
1823  * @param value the ATS_address
1824  * @return GNUNET_OK to continue
1825  */
1826 static int
1827 peer_it (void *cls,
1828          const struct GNUNET_HashCode * key,
1829          void *value)
1830 {
1831   struct PeerIteratorContext *ip_ctx = cls;
1832   struct GNUNET_PeerIdentity tmp;
1833
1834   if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1835   {
1836       GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1837       tmp.hashPubKey = (*key);
1838       ip_ctx->it (ip_ctx->it_cls, &tmp);
1839   }
1840
1841   return GNUNET_OK;
1842 }
1843
1844
1845 /**
1846  * Return information all peers currently known to ATS
1847  *
1848  * @param handle the address handle to use
1849  * @param p_it the iterator to call for every peer
1850  * @param p_it_cls the closure for the iterator
1851  */
1852 void
1853 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1854                                                                                                                  GNUNET_ATS_Peer_Iterator p_it,
1855                                                                                                                  void *p_it_cls)
1856 {
1857   struct PeerIteratorContext ip_ctx;
1858   unsigned int size;
1859
1860   if (NULL == p_it)
1861       return;
1862   GNUNET_assert (NULL != handle->addresses);
1863
1864   size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1865   if (0 != size)
1866   {
1867     ip_ctx.it = p_it;
1868     ip_ctx.it_cls = p_it_cls;
1869     ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1870     GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1871     GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1872   }
1873   p_it (p_it_cls, NULL);
1874 }
1875
1876
1877 struct PeerInfoIteratorContext
1878 {
1879   GNUNET_ATS_PeerInfo_Iterator it;
1880   void *it_cls;
1881 };
1882
1883
1884 /**
1885  * Iterator to iterate over a peer's addresses
1886  *
1887  * @param cls a PeerInfoIteratorContext
1888  * @param key the peer id
1889  * @param value the ATS_address
1890  * @return GNUNET_OK to continue
1891  */
1892 static int 
1893 peerinfo_it (void *cls,
1894              const struct GNUNET_HashCode * key,
1895              void *value)
1896 {
1897   struct PeerInfoIteratorContext *pi_ctx = cls;
1898   struct ATS_Address *addr = (struct ATS_Address *)  value;
1899
1900   if (NULL != pi_ctx->it)
1901   {
1902     pi_ctx->it (pi_ctx->it_cls,
1903                 &addr->peer,
1904                 addr->plugin,
1905                 addr->addr, addr->addr_len,
1906                 addr->active,
1907                 addr->atsi, addr->atsi_count,
1908                 addr->assigned_bw_out,
1909                 addr->assigned_bw_in);
1910   }
1911   return GNUNET_YES;
1912 }
1913
1914
1915 /**
1916  * Return information all peers currently known to ATS
1917  *
1918  * @param handle the address handle to use
1919  * @param peer the respective peer
1920  * @param pi_it the iterator to call for every peer
1921  * @param pi_it_cls the closure for the iterator
1922  */
1923 void
1924 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1925                              const struct GNUNET_PeerIdentity *peer,
1926                              GNUNET_ATS_PeerInfo_Iterator pi_it,
1927                              void *pi_it_cls)
1928 {
1929   struct PeerInfoIteratorContext pi_ctx;
1930   struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1931   GNUNET_assert (NULL != peer);
1932   GNUNET_assert (NULL != handle->addresses);
1933   if (NULL == pi_it)
1934     return; /* does not make sense without callback */
1935
1936   zero_bw = GNUNET_BANDWIDTH_value_init (0);
1937   pi_ctx.it = pi_it;
1938   pi_ctx.it_cls = pi_it_cls;
1939
1940   GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1941
1942   if (NULL != pi_it)
1943     pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1944
1945 }
1946
1947
1948 /* end of gnunet-service-ats_addresses.c */