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