2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file ats/gnunet-service-ats_addresses.c
23 * @brief ats service address management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_ats_service.h"
29 #include "gnunet-service-ats.h"
30 #include "gnunet-service-ats_addresses.h"
31 #include "gnunet-service-ats_performance.h"
32 #include "gnunet-service-ats_scheduling.h"
33 #include "gnunet-service-ats_reservations.h"
35 #include "gnunet-service-ats_addresses_mlp.h"
37 #include "gnunet-service-ats_addresses_simplistic.h"
40 * ATS addresses : ATS address management
44 * This ATS addresses ("addresses") component manages the addresses known to ATS
45 * service and suggests addresses to transport service when it is interested in
46 * address suggestion for a peer. ATS addresses also instantiates the bandwidth assignment
47 * mechanism (solver), notifies it about changes to addresses and forwards changes
48 * to bandwidth assignments to transport, depending if transport is interested
52 * During initialization a hashmap to store addresses is created. The most
53 * important step is to load the configured solver using configuration
54 * "[ats]:MODE". Current solvers are MODE_SIMPLISTIC, MODE_MLP. Interaction
55 * is done using a solver API
60 * s_init: init the solver with required information
61 * s_add: add a new address
62 * s_update: update an address
63 * s_get: get prefered address for a peer
64 * s_del: delete an address
65 * s_pref: change preference value for a peer
66 * s_done: shutdown solver
68 * addresses provides a bandwidth_changed_cb callback to the solver which is
69 * called when bandwidth assigned to peer has changed
72 * During shutdown all addresses are freed and the solver told to shutdown
74 * - Address management and suggestions:
76 * Transport service notifies ATS about changes to the addresses known to him.
78 * When transport learns a new address it tells ATS about it using
79 * GAS_address_add. It creates a new address object and tells the solver using
81 * add it. ATS informationen are extracted given t
85 * - Bandwidth assignment
87 * The addresses are used to perform resource allocation operations. ATS
88 * addresses takes care of instantiating the solver configured and notifies the
89 * respective solver about address changes and receives changes to the bandwidth
90 * assignment from the solver. The current bandwidth assignment is sent to
99 * - If you add a new address without a session, a new address will be added
100 * - If you add this address again now with a session a, the existing address
101 * will be updated with this session
102 * - If you add this address again now with a session b, a new address object
103 * with this session will be added
105 * Destroying addresses:
107 * - If you destroy an address without a session, the address itself and all
108 * address instances with an session will be removed
109 * - If you destroy an address with a session, the session for this address
113 * Addresses without a session will be updated with a new session and if the
114 * the session is destroyed the session is removed and address itself still
115 * exists for suggestion
121 * Available ressource assignment modes
128 * Assign each peer an equal amount of bandwidth (bw)
130 * bw_per_peer = bw_total / #active addresses
137 * Solve ressource assignment as an optimization problem
138 * Uses an mixed integer programming solver
144 * Pending Address suggestion requests
146 struct GAS_Addresses_Suggestion_Requests
151 struct GAS_Addresses_Suggestion_Requests *next;
156 struct GAS_Addresses_Suggestion_Requests *prev;
161 struct GNUNET_PeerIdentity id;
165 * Handle for ATS address component
167 struct GAS_Addresses_Handle
172 struct GNUNET_STATISTICS_Handle *stat;
175 * A multihashmap to store all addresses
177 struct GNUNET_CONTAINER_MultiHashMap *addresses;
180 * Configure WAN quota in
182 unsigned long long wan_quota_in;
185 * Configure WAN quota out
187 unsigned long long wan_quota_out;
190 * Is ATS addresses running
195 * Configured ATS solver
205 * Address suggestion requests DLL head
207 struct GAS_Addresses_Suggestion_Requests *r_head;
210 * Address suggestion requests DLL tail
212 struct GAS_Addresses_Suggestion_Requests *r_tail;
214 /* Solver functions */
219 GAS_solver_init s_init;
222 * Add an address to the solver
224 GAS_solver_address_add s_add;
227 * Update address in solver
229 GAS_solver_address_update s_update;
232 * Get address from solver
234 GAS_solver_get_preferred_address s_get;
237 * Delete address in solver
239 GAS_solver_address_delete s_del;
242 * Change preference for quality in solver
244 GAS_solver_address_change_preference s_pref;
249 GAS_solver_done s_done;
254 assemble_ats_information (const struct ATS_Address *aa, struct GNUNET_ATS_Information **dest)
256 unsigned int ats_count = GNUNET_ATS_PropertyCount - 1;
257 struct GNUNET_ATS_Information *ats = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
260 ats[0].type = ntohl(GNUNET_ATS_UTILIZATION_UP);
261 ats[0].value = aa->atsp_utilization_out.value__;
262 ats[1].type = ntohl(GNUNET_ATS_UTILIZATION_DOWN);
263 ats[1].value = aa->atsp_utilization_in.value__;
264 ats[2].type = ntohl(GNUNET_ATS_NETWORK_TYPE);
265 ats[2].value = ntohl(aa->atsp_network_type);
266 ats[3].type = ntohl(GNUNET_ATS_QUALITY_NET_DELAY);
267 ats[3].value = ntohl(aa->atsp_latency.rel_value);
268 ats[4].type = ntohl(GNUNET_ATS_QUALITY_NET_DISTANCE);
269 ats[4].value = ntohl(aa->atsp_distance);
270 ats[5].type = ntohl(GNUNET_ATS_COST_WAN);
271 ats[5].value = ntohl (aa->atsp_cost_wan);
272 ats[6].type = ntohl(GNUNET_ATS_COST_LAN);
273 ats[6].value = ntohl (aa->atsp_cost_lan);
274 ats[7].type = ntohl(GNUNET_ATS_COST_WLAN);
275 ats[7].value = ntohl (aa->atsp_cost_wlan);
280 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
282 struct ATS_Address *dest)
286 for (i = 0; i < ats_count; i++)
287 switch (ntohl (src[i].type))
289 case GNUNET_ATS_UTILIZATION_UP:
290 dest->atsp_utilization_out.value__ = src[i].value;
293 case GNUNET_ATS_UTILIZATION_DOWN:
294 dest->atsp_utilization_in.value__ = src[i].value;
297 case GNUNET_ATS_QUALITY_NET_DELAY:
298 dest->atsp_latency.rel_value = ntohl (src[i].value);
301 case GNUNET_ATS_QUALITY_NET_DISTANCE:
302 dest->atsp_distance = ntohl (src[i].value);
305 case GNUNET_ATS_COST_WAN:
306 dest->atsp_cost_wan = ntohl (src[i].value);
309 case GNUNET_ATS_COST_LAN:
310 dest->atsp_cost_lan = ntohl (src[i].value);
313 case GNUNET_ATS_COST_WLAN:
314 dest->atsp_cost_wlan = ntohl (src[i].value);
317 case GNUNET_ATS_NETWORK_TYPE:
318 dest->atsp_network_type = ntohl (src[i].value);
321 case GNUNET_ATS_ARRAY_TERMINATOR:
324 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
325 "Received unsupported ATS type %u\n", ntohl (src[i].type));
333 * Free the given address
334 * @param addr address to destroy
337 free_address (struct ATS_Address *addr)
339 GNUNET_free (addr->plugin);
344 * Create a ATS_address with the given information
346 * @param plugin_name plugin
347 * @param plugin_addr address
348 * @param plugin_addr_len address length
349 * @param session_id session
350 * @return the ATS_Address
352 static struct ATS_Address *
353 create_address (const struct GNUNET_PeerIdentity *peer,
354 const char *plugin_name,
355 const void *plugin_addr, size_t plugin_addr_len,
358 struct ATS_Address *aa = NULL;
360 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
362 aa->addr_len = plugin_addr_len;
364 memcpy (&aa[1], plugin_addr, plugin_addr_len);
365 aa->plugin = GNUNET_strdup (plugin_name);
366 aa->session_id = session_id;
367 aa->active = GNUNET_NO;
368 aa->used = GNUNET_NO;
369 aa->solver_information = NULL;
370 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
371 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
377 * Destroy the given address.
379 * @param handle the address handle
380 * @param addr address to destroy
381 * @return GNUNET_YES if bandwidth allocations should be recalcualted
384 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
389 GNUNET_assert (GNUNET_YES ==
390 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
391 &addr->peer.hashPubKey,
398 struct CompareAddressContext
400 const struct ATS_Address *search;
402 /* exact_address != NULL if address and session is equal */
403 struct ATS_Address *exact_address;
404 /* exact_address != NULL if address and session is 0 */
405 struct ATS_Address *base_address;
410 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
412 struct CompareAddressContext *cac = cls;
413 struct ATS_Address *aa = value;
415 /* Find an matching exact address:
418 * aa->addr_len == cac->search->addr_len
419 * aa->plugin == cac->search->plugin
420 * aa->addr == cac->search->addr
421 * aa->session == cac->search->session
423 * return as exact address
425 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
427 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
428 cac->exact_address = aa;
431 /* Find an matching base address:
435 * aa->session_id == 0
438 * aa->addr_len == cac->search->addr_len
439 * aa->plugin == cac->search->plugin
440 * aa->addr == cac->search->addr
442 * return as base address
444 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
446 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
447 cac->base_address = aa;
450 /* Find an matching exact address based on session:
454 * cac->search->addr_len == 0
457 * aa->plugin == cac->search->plugin
458 * aa->session_id == cac->search->session_id
460 * return as exact address
462 if (0 == cac->search->addr_len)
464 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
465 cac->exact_address = aa;
468 if (cac->exact_address == NULL)
469 return GNUNET_YES; /* Continue iteration to find exact address */
471 return GNUNET_NO; /* Stop iteration since we have an exact address */
476 * Find an existing equivalent address record.
477 * Compares by peer identity and network address OR by session ID
478 * (one of the two must match).
480 * @param handle the address handle
481 * @param peer peer to lookup addresses for
482 * @param addr existing address record
483 * @return existing address record, NULL for none
486 find_equivalent_address (struct GAS_Addresses_Handle *handle,
487 const struct GNUNET_PeerIdentity *peer,
488 const struct ATS_Address *addr)
490 struct CompareAddressContext cac;
492 cac.exact_address = NULL;
493 cac.base_address = NULL;
495 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
496 &compare_address_it, &cac);
498 if (cac.exact_address == NULL)
499 return cac.base_address;
500 return cac.exact_address;
504 static struct ATS_Address *
505 lookup_address (struct GAS_Addresses_Handle *handle,
506 const struct GNUNET_PeerIdentity *peer,
507 const char *plugin_name,
508 const void *plugin_addr,
509 size_t plugin_addr_len,
511 const struct GNUNET_ATS_Information *atsi,
514 struct ATS_Address *aa;
515 struct ATS_Address *ea;
517 aa = create_address (peer,
519 plugin_addr, plugin_addr_len,
522 /* Get existing address or address with session == 0 */
523 ea = find_equivalent_address (handle, peer, aa);
529 else if (ea->session_id != session_id)
538 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
539 const struct GNUNET_PeerIdentity *peer,
540 const char *plugin_name, const void *plugin_addr,
541 size_t plugin_addr_len, uint32_t session_id,
542 const struct GNUNET_ATS_Information *atsi,
545 struct ATS_Address *aa;
546 struct ATS_Address *ea;
547 unsigned int ats_res;
549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
550 "Received `%s' for peer `%s'\n",
554 if (GNUNET_NO == handle->running)
557 GNUNET_assert (NULL != handle->addresses);
559 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
561 if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, aa)))
563 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
564 "While adding address: had %u ATS elements to add, could only add %u\n",
565 atsi_count, ats_res);
568 /* Get existing address or address with session == 0 */
569 ea = find_equivalent_address (handle, peer, aa);
572 /* We have a new address */
573 GNUNET_assert (GNUNET_OK ==
574 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
575 &peer->hashPubKey, aa,
576 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
577 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
578 GNUNET_i2s (peer), session_id, aa);
579 /* Tell solver about new address */
580 handle->s_add (handle->solver, handle->addresses, aa);
583 GNUNET_free (aa->plugin);
586 if (ea->session_id != 0)
588 /* This address with the same session is already existing
589 * Should not happen */
590 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
591 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
592 GNUNET_i2s (peer), plugin_name, session_id);
597 /* We have an address without an session, update this address */
599 /* Notify solver about update with atsi information and session */
600 handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
603 ea->session_id = session_id;
604 if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, ea)))
606 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
607 "While updating address: had %u ATS elements to add, could only add %u\n",
608 atsi_count, ats_res);
610 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
611 "Updated existing address for peer `%s' %p with new session %u\n",
612 GNUNET_i2s (peer), ea, session_id);
617 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
618 const struct GNUNET_PeerIdentity *peer,
619 const char *plugin_name, const void *plugin_addr,
620 size_t plugin_addr_len, uint32_t session_id,
621 const struct GNUNET_ATS_Information *atsi,
624 struct ATS_Address *aa;
627 if (GNUNET_NO == handle->running)
630 GNUNET_assert (NULL != handle->addresses);
632 /* Get existing address */
633 aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
634 session_id, atsi, atsi_count);
637 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
638 GNUNET_i2s (peer), plugin_name, session_id);
643 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
644 "Received `%s' for peer `%s' address \n",
646 GNUNET_i2s (peer), aa);
648 /* Tell solver about update */
649 handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
652 if (atsi_count != (ats_res = disassemble_ats_information (atsi, atsi_count, aa)))
654 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
655 "While adding address: had %u ATS elements to add, could only add %u\n",
656 atsi_count, ats_res);
658 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
659 "Updated %u ATS elements for address %p\n",
664 struct DestroyContext
666 struct ATS_Address *aa;
668 struct GAS_Addresses_Handle *handle;
671 * GNUNET_NO : full address
672 * GNUNET_YES : just session
681 * If session != 0, just the session is deleted, the address itself still exists
682 * If session == 0, remove full address
683 * If session == 0 and addrlen == 0, destroy inbound address
687 * @param value the 'struct ATS_Address'
688 * @return GNUNET_OK (continue to iterate)
691 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
693 struct DestroyContext *dc = cls;
694 struct GAS_Addresses_Handle *handle = dc->handle;
695 const struct ATS_Address *des = dc->aa;
696 struct ATS_Address *aa = value;
698 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
699 sizeof (struct GNUNET_PeerIdentity)));
702 if (des->session_id == 0)
704 /* Session == 0, remove full address */
705 if ((0 == strcmp (des->plugin, aa->plugin)) &&
706 (aa->addr_len == des->addr_len) &&
707 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
710 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
711 "Deleting full address for peer `%s' session %u %p\n",
712 GNUNET_i2s (&aa->peer), aa->session_id, aa);
714 /* Notify solver about deletion */
715 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
716 destroy_address (handle, aa);
717 dc->result = GNUNET_NO;
718 return GNUNET_OK; /* Continue iteration */
723 /* Session != 0, just remove session */
724 if (aa->session_id != des->session_id)
725 return GNUNET_OK; /* irrelevant */
727 if ((aa->session_id != 0) &&
728 (0 != strcmp (des->plugin, aa->plugin)))
730 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
731 "Different plugins during removal: `%s' vs `%s' \n",
732 des->plugin, aa->plugin);
737 if (aa->addr_len == 0)
739 /* Inbound connection died, delete full address */
740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
741 "Deleting inbound address for peer `%s': `%s' session %u\n",
742 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
744 /* Notify solver about deletion */
745 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
746 destroy_address (handle, aa);
747 dc->result = GNUNET_NO;
748 return GNUNET_OK; /* Continue iteration */
753 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
754 "Deleting session for peer `%s': `%s' %u\n",
755 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
756 /* Notify solver to delete session */
757 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
766 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
767 const struct GNUNET_PeerIdentity *peer,
768 const char *plugin_name, const void *plugin_addr,
769 size_t plugin_addr_len, uint32_t session_id)
771 struct ATS_Address *ea;
772 struct DestroyContext dc;
774 if (GNUNET_NO == handle->running)
777 /* Get existing address */
778 ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
779 session_id, NULL, 0);
781 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
782 "Received `%s' for peer `%s' address %p session %u\n",
784 GNUNET_i2s (peer), ea, session_id);
788 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
789 GNUNET_i2s (peer), plugin_name, session_id);
793 GNUNET_break (0 < strlen (plugin_name));
795 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
797 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
798 &destroy_by_session_id, &dc);
799 free_address (dc.aa);
804 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
805 const struct GNUNET_PeerIdentity *peer,
806 const char *plugin_name, const void *plugin_addr,
807 size_t plugin_addr_len, uint32_t session_id, int in_use)
809 struct ATS_Address *ea;
811 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
812 "Received `%s' for peer `%s'\n",
816 if (GNUNET_NO == handle->running)
817 return GNUNET_SYSERR;
819 ea = lookup_address (handle, peer, plugin_name,
820 plugin_addr, plugin_addr_len,
821 session_id, NULL, 0);
824 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
825 "Trying to set unknown address `%s', %s %u %s \n",
827 plugin_name, session_id,
828 (GNUNET_NO == in_use) ? "NO" : "YES");
830 return GNUNET_SYSERR;
832 if (ea->used == in_use)
835 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
836 "Address in use called multiple times for peer `%s': %s -> %s \n",
838 (GNUNET_NO == ea->used) ? "NO" : "YES",
839 (GNUNET_NO == in_use) ? "NO" : "YES");
840 return GNUNET_SYSERR;
843 /* Tell solver about update */
844 handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
852 * Cancel address suggestions for a peer
854 * @param handle the address handle
855 * @param peer the respective peer
858 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
859 const struct GNUNET_PeerIdentity *peer)
861 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
863 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
864 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
868 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
875 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
876 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
879 GAS_addresses_handle_backoff_reset (handle, peer);
880 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
881 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
882 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
888 * Add an address suggestions for a peer
890 * @param handle the address handle
891 * @param peer the respective peer
894 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
895 const struct GNUNET_PeerIdentity *peer)
897 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
898 struct ATS_Address *aa;
899 struct GNUNET_ATS_Information *ats;
900 unsigned int ats_count;
902 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
903 "Received `%s' for peer `%s'\n",
907 if (GNUNET_NO == handle->running)
911 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
912 break; /* already suggesting */
917 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
919 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
922 /* Get prefered address from solver */
923 aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
926 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
927 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
931 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
932 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
934 ats_count = assemble_ats_information (aa, &ats);
935 GAS_scheduling_transmit_address_suggestion (peer,
937 aa->addr, aa->addr_len,
943 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
944 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
946 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
947 "Address %p ready for suggestion, block interval now %llu \n",
948 aa, aa->block_interval);
955 reset_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
957 struct ATS_Address *aa = value;
959 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
960 "Resetting interval for peer `%s' address %p from %llu to 0\n",
961 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
963 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
964 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
970 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
971 const struct GNUNET_PeerIdentity *peer)
973 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
974 "Received `%s' for peer `%s'\n",
978 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
986 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
988 const struct GNUNET_PeerIdentity *peer,
989 enum GNUNET_ATS_PreferenceKind kind,
992 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
993 "Received `%s' for peer `%s' for client %p\n",
995 GNUNET_i2s (peer), client);
997 if (GNUNET_NO == handle->running)
1000 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1003 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1004 "Received `%s' for unknown peer `%s' from client %p\n",
1005 "CHANGE PREFERENCE",
1006 GNUNET_i2s (peer), client);
1010 /* Tell solver about update */
1011 handle->s_pref (handle->solver, client, peer, kind, score);
1016 * Load quotas for networks from configuration
1018 * @param cfg configuration handle
1019 * @param out_dest where to write outbound quotas
1020 * @param in_dest where to write inbound quotas
1021 * @param dest_length length of inbound and outbound arrays
1022 * @return number of networks loaded
1025 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1027 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1028 char * entry_in = NULL;
1029 char * entry_out = NULL;
1030 char * quota_out_str;
1031 char * quota_in_str;
1035 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1039 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1040 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1043 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1046 if (0 == strcmp(quota_out_str, BIG_M_STRING))
1048 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1051 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1053 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1056 if (GNUNET_NO == res)
1058 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1059 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1060 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1064 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1065 network_str[c], out_dest[c]);
1067 GNUNET_free (quota_out_str);
1071 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1072 network_str[c], GNUNET_ATS_DefaultBandwidth);
1073 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1077 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1080 if (0 == strcmp(quota_in_str, BIG_M_STRING))
1082 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1085 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1087 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1090 if (GNUNET_NO == res)
1092 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1093 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1094 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1098 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1099 network_str[c], in_dest[c]);
1101 GNUNET_free (quota_in_str);
1105 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1106 network_str[c], GNUNET_ATS_DefaultBandwidth);
1107 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1109 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]);
1110 GNUNET_free (entry_out);
1111 GNUNET_free (entry_in);
1113 return GNUNET_ATS_NetworkTypeCount;
1118 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1120 struct GAS_Addresses_Handle *handle = cls;
1121 struct GAS_Addresses_Suggestion_Requests *cur;
1123 GNUNET_assert (handle != NULL);
1124 GNUNET_assert (address != NULL);
1126 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1127 struct GNUNET_ATS_Information *ats;
1128 unsigned int ats_count;
1130 cur = handle->r_head;
1133 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1134 break; /* we have an address request pending*/
1139 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1140 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1144 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1145 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1147 ats_count = assemble_ats_information (address, &ats);
1148 GAS_scheduling_transmit_address_suggestion (&address->peer,
1150 address->addr, address->addr_len,
1151 address->session_id,
1153 address->assigned_bw_out,
1154 address->assigned_bw_in);
1160 * Initialize address subsystem.
1162 * @param cfg configuration to use
1163 * @param stats the statistics handle to use
1165 struct GAS_Addresses_Handle *
1166 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1167 const struct GNUNET_STATISTICS_Handle *stats)
1169 struct GAS_Addresses_Handle *ah;
1170 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1171 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1172 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1177 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1178 ah->running = GNUNET_NO;
1180 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1181 /* Initialize the addresses database */
1182 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1183 GNUNET_assert (NULL != ah->addresses);
1185 /* Figure out configured solution method */
1186 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1188 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1189 ah->ats_mode = MODE_SIMPLISTIC;
1193 for (c = 0; c < strlen (mode_str); c++)
1194 mode_str[c] = toupper (mode_str[c]);
1195 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1197 ah->ats_mode = MODE_SIMPLISTIC;
1199 else if (0 == strcmp (mode_str, "MLP"))
1201 ah->ats_mode = MODE_MLP;
1203 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1204 ah->ats_mode = MODE_SIMPLISTIC;
1209 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1210 ah->ats_mode = MODE_SIMPLISTIC;
1212 GNUNET_free (mode_str);
1214 /* Start configured solution method */
1215 switch (ah->ats_mode)
1218 /* Init the MLP solver with default values */
1220 ah->ats_mode = MODE_MLP;
1221 ah->s_init = &GAS_mlp_init;
1222 ah->s_add = &GAS_mlp_address_add;
1223 ah->s_update = &GAS_mlp_address_update;
1224 ah->s_get = &GAS_mlp_get_preferred_address;
1225 ah->s_pref = &GAS_mlp_address_change_preference;
1226 ah->s_del = &GAS_mlp_address_delete;
1227 ah->s_done = &GAS_mlp_done;
1233 case MODE_SIMPLISTIC:
1234 /* Init the simplistic solver with default values */
1235 ah->ats_mode = MODE_SIMPLISTIC;
1236 ah->s_init = &GAS_simplistic_init;
1237 ah->s_add = &GAS_simplistic_address_add;
1238 ah->s_update = &GAS_simplistic_address_update;
1239 ah->s_get = &GAS_simplistic_get_preferred_address;
1240 ah->s_pref = &GAS_simplistic_address_change_preference;
1241 ah->s_del = &GAS_simplistic_address_delete;
1242 ah->s_done = &GAS_simplistic_done;
1243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1250 GNUNET_assert (NULL != ah->s_init);
1251 GNUNET_assert (NULL != ah->s_add);
1252 GNUNET_assert (NULL != ah->s_update);
1253 GNUNET_assert (NULL != ah->s_get);
1254 GNUNET_assert (NULL != ah->s_pref);
1255 GNUNET_assert (NULL != ah->s_del);
1256 GNUNET_assert (NULL != ah->s_done);
1258 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1260 ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1261 if (NULL == ah->solver)
1263 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1268 /* up and running */
1269 ah->running = GNUNET_YES;
1275 * Free memory of address.
1278 * @param key peer identity (unused)
1279 * @param value the 'struct ATS_Address' to free
1280 * @return GNUNET_OK (continue to iterate)
1283 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1285 struct GAS_Addresses_Handle *handle = cls;
1286 struct ATS_Address *aa = value;
1287 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1288 destroy_address (handle, aa);
1294 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1296 if (GNUNET_NO == handle->running)
1299 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1303 if (handle->addresses != NULL)
1304 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1309 * Shutdown address subsystem.
1312 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1314 struct GAS_Addresses_Suggestion_Requests *cur;
1316 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1317 "Shutting down addresses\n");
1318 GNUNET_assert (NULL != handle);
1319 GAS_addresses_destroy_all (handle);
1320 handle->running = GNUNET_NO;
1321 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1322 handle->addresses = NULL;
1323 while (NULL != (cur = handle->r_head))
1325 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1328 handle->s_done (handle->solver);
1329 GNUNET_free (handle);
1330 /* Stop configured solution method */
1334 struct PeerIteratorContext
1336 GNUNET_ATS_Peer_Iterator it;
1338 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1343 const struct GNUNET_HashCode * key,
1346 struct PeerIteratorContext *ip_ctx = cls;
1347 struct GNUNET_PeerIdentity tmp;
1349 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1351 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1352 tmp.hashPubKey = (*key);
1353 ip_ctx->it (ip_ctx->it_cls, &tmp);
1360 * Return all peers currently known to ATS
1362 * @param handle the address handle
1363 * @param p_it the iterator to call for every peer, callbach with id == NULL
1365 * @param p_it_cls the closure for the iterator
1368 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle, GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls)
1370 struct PeerIteratorContext ip_ctx;
1375 GNUNET_assert (NULL != handle->addresses);
1377 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1381 ip_ctx.it_cls = p_it_cls;
1382 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1383 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1384 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1386 p_it (p_it_cls, NULL);
1389 struct PeerInfoIteratorContext
1391 GNUNET_ATS_PeerInfo_Iterator it;
1397 peerinfo_it (void *cls,
1398 const struct GNUNET_HashCode * key,
1401 struct PeerInfoIteratorContext *pi_ctx = cls;
1402 struct ATS_Address *addr = (struct ATS_Address *) value;
1403 struct GNUNET_ATS_Information *ats;
1406 if (NULL != pi_ctx->it)
1408 ats_count = assemble_ats_information (addr, &ats);
1410 pi_ctx->it (pi_ctx->it_cls,
1413 addr->addr, addr->addr_len,
1416 addr->assigned_bw_out,
1417 addr->assigned_bw_in);
1425 * Return all peers currently known to ATS
1427 * @param handle the address handle
1428 * @param peer the respective peer
1429 * @param pi_it the iterator to call for every peer
1430 * @param pi_it_cls the closure for the iterator
1433 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1434 const struct GNUNET_PeerIdentity *peer,
1435 GNUNET_ATS_PeerInfo_Iterator pi_it,
1438 struct PeerInfoIteratorContext pi_ctx;
1439 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1440 GNUNET_assert (NULL != peer);
1441 GNUNET_assert (NULL != handle->addresses);
1443 return; /* does not make sense without callback */
1445 zero_bw = GNUNET_BANDWIDTH_value_init (0);
1447 pi_ctx.it_cls = pi_it_cls;
1449 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1452 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1457 /* end of gnunet-service-ats_addresses.c */