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"
38 #define VERBOSE GNUNET_NO
40 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
45 * Assign each peer an equal amount of bandwidth (bw)
47 * bw_per_peer = bw_total / #active addresses
52 * Use MLP solver to assign bandwidth
57 static struct GNUNET_CONTAINER_MultiHashMap *addresses;
60 static struct GAS_MLP_Handle *mlp;
63 static unsigned long long wan_quota_in;
65 static unsigned long long wan_quota_out;
67 static unsigned int active_addr_count;
75 send_bw_notification (struct ATS_Address *aa)
77 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "New bandwidth for peer %s is %u/%u\n",
78 GNUNET_i2s (&aa->peer), ntohl (aa->assigned_bw_in.value__),
79 ntohl (aa->assigned_bw_out.value__));
80 GAS_scheduling_transmit_address_suggestion (&aa->peer, aa->plugin, aa->addr,
81 aa->addr_len, aa->session_id,
82 aa->ats, aa->ats_count,
85 GAS_reservations_set_bandwidth (&aa->peer, aa->assigned_bw_in);
86 GAS_performance_notify_clients (&aa->peer, aa->plugin, aa->addr, aa->addr_len,
87 aa->ats, aa->ats_count, aa->assigned_bw_out,
92 * Update a bandwidth assignment for a peer. This trivial method currently
93 * simply assigns the same share to all active connections.
97 * @param value the 'struct ATS_Address'
98 * @return GNUNET_OK (continue to iterate)
101 update_bw_simple_it (void *cls, const GNUNET_HashCode * key, void *value)
103 struct ATS_Address *aa = value;
105 if (GNUNET_YES != aa->active)
107 GNUNET_assert (active_addr_count > 0);
111 aa->assigned_bw_in.value__ = htonl (wan_quota_in / active_addr_count);
112 aa->assigned_bw_out.value__ = htonl (wan_quota_out / active_addr_count);
114 send_bw_notification (aa);
121 * Some (significant) input changed, recalculate bandwidth assignment
125 recalculate_assigned_bw ()
127 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
128 "Recalculating bandwidth for all active connections\n");
129 GNUNET_STATISTICS_update (GSA_stats, "# bandwidth recalculations performed",
131 GNUNET_STATISTICS_set (GSA_stats, "# active addresses", active_addr_count,
134 GNUNET_CONTAINER_multihashmap_iterate (addresses, &update_bw_simple_it, NULL);
138 * Free the given address
139 * @param addr address to destroy
142 free_address (struct ATS_Address *addr)
144 GNUNET_free_non_null (addr->ats);
145 GNUNET_free (addr->plugin);
150 * Create a ATS_address with the given information
152 * @param plugin_name plugin
153 * @param plugin_addr address
154 * @param plugin_addr_len address length
155 * @param session_id session
156 * @return the ATS_Address
158 static struct ATS_Address *
159 create_address (const struct GNUNET_PeerIdentity *peer,
160 const char *plugin_name,
161 const void *plugin_addr, size_t plugin_addr_len,
164 struct ATS_Address *aa = NULL;
166 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
168 aa->addr_len = plugin_addr_len;
170 memcpy (&aa[1], plugin_addr, plugin_addr_len);
171 aa->plugin = GNUNET_strdup (plugin_name);
172 aa->session_id = session_id;
173 aa->mlp_information = NULL;
174 aa->blocked_until = GNUNET_TIME_absolute_get_zero();
175 aa->block_interval = GNUNET_TIME_relative_get_zero();
183 * Destroy the given address.
185 * @param addr address to destroy
186 * @return GNUNET_YES if bandwidth allocations should be recalcualted
189 destroy_address (struct ATS_Address *addr)
194 GNUNET_assert (GNUNET_YES ==
195 GNUNET_CONTAINER_multihashmap_remove (addresses,
196 &addr->peer.hashPubKey,
201 GAS_mlp_address_delete (mlp, addresses, addr);
204 if (GNUNET_YES == addr->active)
207 addr->active = GNUNET_NO;
215 struct CompareAddressContext
217 const struct ATS_Address *search;
219 /* exact_address != NULL if address and session is equal */
220 struct ATS_Address *exact_address;
221 /* exact_address != NULL if address and session is 0 */
222 struct ATS_Address *base_address;
227 compare_address_it (void *cls, const GNUNET_HashCode * key, void *value)
229 struct CompareAddressContext *cac = cls;
230 struct ATS_Address *aa = value;
232 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
233 "Comparing to: %s %s %u session %u\n",
234 GNUNET_i2s (&aa->peer), aa->plugin, aa->addr_len, aa->session_id);
237 /* find an exact matching address: aa->addr == cac->search->addr && aa->session == cac->search->session */
238 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
240 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
242 cac->exact_address = aa;
246 /* find an matching address: aa->addr == cac->search->addr && aa->session == 0 */
247 /* this address can be used to be updated */
248 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
250 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
252 cac->base_address = aa;
256 if (cac->exact_address == NULL)
264 * Find an existing equivalent address record.
265 * Compares by peer identity and network address OR by session ID
266 * (one of the two must match).
268 * @param peer peer to lookup addresses for
269 * @param addr existing address record
270 * @return existing address record, NULL for none
273 find_address (const struct GNUNET_PeerIdentity *peer,
274 const struct ATS_Address *addr)
276 struct CompareAddressContext cac;
278 cac.exact_address = NULL;
279 cac.base_address = NULL;
281 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
282 &compare_address_it, &cac);
285 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
286 "exact address: %s base address: %s\n",
287 (cac.exact_address != NULL) ? "YES" : "NO",
288 (cac.base_address != NULL) ? "YES" : "NO");
290 if (cac.exact_address == NULL)
291 return cac.base_address;
292 return cac.exact_address;
297 compare_address_session_it (void *cls, const GNUNET_HashCode * key, void *value)
299 struct CompareAddressContext *cac = cls;
300 struct ATS_Address *aa = value;
302 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
304 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
306 cac->exact_address = aa;
315 * Find an existing equivalent address record.
316 * Compares by peer identity and network address AND by session ID
317 * (one of the two must match).
319 * @param peer peer to lookup addresses for
320 * @param addr existing address record
321 * @return existing address record, NULL for none
324 find_exact_address (const struct GNUNET_PeerIdentity *peer,
325 const struct ATS_Address *addr)
327 struct CompareAddressContext cac;
329 cac.exact_address = NULL;
331 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
332 &compare_address_session_it, &cac);
333 return cac.exact_address;
338 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
339 const char *plugin_name, const void *plugin_addr,
340 size_t plugin_addr_len, uint32_t session_id,
341 const struct GNUNET_ATS_Information *atsi,
344 struct ATS_Address *aa;
345 struct ATS_Address *old;
348 if (GNUNET_NO == running)
351 GNUNET_assert (NULL != addresses);
353 aa = create_address (peer,
355 plugin_addr, plugin_addr_len,
358 aa->mlp_information = NULL;
359 aa->ats = GNUNET_malloc (atsi_count * sizeof (struct GNUNET_ATS_Information));
360 aa->ats_count = atsi_count;
361 memcpy (aa->ats, atsi, atsi_count * sizeof (struct GNUNET_ATS_Information));
364 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating address for peer `%s' %u\n",
368 /* Get existing address or address with session == 0 */
369 old = find_address (peer, aa);
372 GNUNET_assert (GNUNET_OK ==
373 GNUNET_CONTAINER_multihashmap_put (addresses,
374 &peer->hashPubKey, aa,
375 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
377 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' %X\n",
378 GNUNET_i2s (peer), aa);
385 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
386 "Updated existing address for peer `%s' %p old session %u new session %u\n",
387 GNUNET_i2s (peer), old,
388 old->session_id, session_id);
390 GNUNET_free_non_null (old->ats);
391 old->session_id = session_id;
395 old->ats_count = aa->ats_count;
396 GNUNET_free (aa->plugin);
399 for (i = 0; i < atsi_count; i++)
400 switch (ntohl (atsi[i].type))
402 case GNUNET_ATS_UTILIZATION_UP:
403 old->atsp_utilization_out.value__ = atsi[i].value;
405 case GNUNET_ATS_UTILIZATION_DOWN:
406 old->atsp_utilization_in.value__ = atsi[i].value;
408 case GNUNET_ATS_QUALITY_NET_DELAY:
409 old->atsp_latency.rel_value = ntohl (atsi[i].value);
411 case GNUNET_ATS_QUALITY_NET_DISTANCE:
412 old->atsp_distance = ntohl (atsi[i].value);
414 case GNUNET_ATS_COST_WAN:
415 old->atsp_cost_wan = ntohl (atsi[i].value);
417 case GNUNET_ATS_COST_LAN:
418 old->atsp_cost_lan = ntohl (atsi[i].value);
420 case GNUNET_ATS_COST_WLAN:
421 old->atsp_cost_wlan = ntohl (atsi[i].value);
423 case GNUNET_ATS_NETWORK_TYPE:
424 old->atsp_network_type = ntohl (atsi[i].value);
428 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
429 "Received unsupported ATS type %u\n", ntohl (atsi[i].type));
435 GAS_mlp_address_update (mlp, addresses, old);
443 * If session != 0, just the session is deleted, the address itself still exists
444 * If session == 0, remove full address
445 * If session == 0 and addrlen == 0, destroy inbound address
449 * @param value the 'struct ATS_Address'
450 * @return GNUNET_OK (continue to iterate)
453 destroy_by_session_id (void *cls, const GNUNET_HashCode * key, void *value)
455 const struct ATS_Address *info = cls;
456 struct ATS_Address *aa = value;
459 memcmp (&aa->peer, &info->peer,
460 sizeof (struct GNUNET_PeerIdentity)));
461 /* session == 0, remove full address */
462 if ((info->session_id == 0) && (0 == strcmp (info->plugin, aa->plugin)) &&
463 (aa->addr_len == info->addr_len) &&
464 (0 == memcmp (info->addr, aa->addr, aa->addr_len)))
467 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
468 "Deleting address for peer `%s': `%s' %u\n",
469 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
471 if (GNUNET_YES == destroy_address (aa))
472 recalculate_assigned_bw ();
475 /* session != 0, just remove session */
476 if (aa->session_id != info->session_id)
477 return GNUNET_OK; /* irrelevant */
478 if (aa->session_id != 0)
479 GNUNET_break (0 == strcmp (info->plugin, aa->plugin));
482 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
483 "Deleting session for peer `%s': `%s' %u\n",
484 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
488 if (GNUNET_YES == aa->active)
490 aa->active = GNUNET_NO;
492 recalculate_assigned_bw ();
495 /* session == 0 and addrlen == 0 : destroy address */
496 if (aa->addr_len == 0)
499 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
500 "Deleting session and address for peer `%s': `%s' %u\n",
501 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
503 (void) destroy_address (aa);
507 /* session was set to 0, update address */
510 GAS_mlp_address_update (mlp, addresses, aa);
518 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
519 const char *plugin_name, const void *plugin_addr,
520 size_t plugin_addr_len, uint32_t session_id)
522 struct ATS_Address *aa;
524 if (GNUNET_NO == running)
527 GNUNET_break (0 < strlen (plugin_name));
528 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
530 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
531 &destroy_by_session_id, aa);
538 * Find a "good" address to use for a peer. If we already have an existing
539 * address, we stick to it. Otherwise, we pick by lowest distance and then
542 * @param cls the 'struct ATS_Address**' where we store the result
544 * @param value another 'struct ATS_Address*' to consider using
545 * @return GNUNET_OK (continue to iterate)
548 find_address_it (void *cls, const GNUNET_HashCode * key, void *value)
550 struct ATS_Address **ap = cls;
551 struct ATS_Address *aa = (struct ATS_Address *) value;
552 struct ATS_Address *ab = *ap;
553 struct GNUNET_TIME_Absolute now;
555 now = GNUNET_TIME_absolute_get();
557 if (aa->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, aa->blocked_until).abs_value)
559 /* This address is blocked for suggestion */
560 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
561 "Address %p blocked for suggestion for %llu ms \n",
563 GNUNET_TIME_absolute_get_difference(now, aa->blocked_until).rel_value);
568 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
569 aa->blocked_until = GNUNET_TIME_absolute_add (now, aa->block_interval);
571 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
572 "Address %p ready for suggestion, block interval now %llu \n", aa, aa->block_interval);
579 if ((ntohl (ab->assigned_bw_in.value__) == 0) &&
580 (ntohl (aa->assigned_bw_in.value__) > 0))
582 /* stick to existing connection */
586 if (ab->atsp_distance > aa->atsp_distance)
588 /* user shorter distance */
592 if (ab->atsp_latency.rel_value > aa->atsp_latency.rel_value)
594 /* user lower latency */
604 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
605 const char *plugin_name, const void *plugin_addr,
606 size_t plugin_addr_len, uint32_t session_id, int in_use)
609 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
610 "Received `%s' message for peer `%s': %i\n", "ADDRESS_IN_USE",
611 GNUNET_i2s (peer), in_use);
614 struct ATS_Address *aa;
615 struct ATS_Address *old;
617 if (GNUNET_NO == running)
618 return GNUNET_SYSERR;
620 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
621 old = find_exact_address (peer, aa);
627 return GNUNET_SYSERR;
629 if (old->used == in_use)
632 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
633 "Address in use called multiple times for peer `%s': %s -> %s \n",
635 (GNUNET_NO == old->used) ? "NO" : "YES",
636 (GNUNET_NO == in_use) ? "NO" : "YES");
637 return GNUNET_SYSERR;
642 GAS_mlp_address_update (mlp, addresses, old);
648 void request_address_mlp (const struct GNUNET_PeerIdentity *peer)
650 struct ATS_Address *aa;
654 /* Get preferred address from MLP */
655 struct ATS_PreferedAddress * paddr = NULL;
656 paddr = GAS_mlp_get_preferred_address (mlp, addresses, peer);
658 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(paddr->bandwidth_out);
659 /* FIXME use bw in value */
660 paddr->bandwidth_in = paddr->bandwidth_out;
661 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init (paddr->bandwidth_in);
667 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
668 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
671 if (aa->active == GNUNET_NO)
673 aa->active = GNUNET_YES;
676 send_bw_notification (aa);
680 /* just to be sure... */
681 GAS_scheduling_transmit_address_suggestion (peer, aa->plugin, aa->addr,
682 aa->addr_len, aa->session_id,
683 aa->ats, aa->ats_count,
690 void request_address_simple (const struct GNUNET_PeerIdentity *peer)
692 struct ATS_Address *aa;
695 /* Get address with: stick to current address, lower distance, lower latency */
696 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
697 &find_address_it, &aa);
700 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
701 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
705 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
706 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
708 if (aa->active == GNUNET_NO)
710 aa->active = GNUNET_YES;
712 if (ats_mode == SIMPLE)
714 recalculate_assigned_bw ();
719 /* just to be sure... */
720 GAS_scheduling_transmit_address_suggestion (peer, aa->plugin, aa->addr,
721 aa->addr_len, aa->session_id,
722 aa->ats, aa->ats_count,
730 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer)
732 if (GNUNET_NO == running)
735 if (ats_mode == SIMPLE)
737 request_address_simple (peer);
741 request_address_mlp(peer);
746 // FIXME: this function should likely end up in the LP-subsystem and
747 // not with 'addresses' in the future...
749 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
750 enum GNUNET_ATS_PreferenceKind kind,
753 if (GNUNET_NO == running)
757 GAS_mlp_address_change_preference (mlp, peer, kind, score);
764 * Initialize address subsystem.
766 * @param cfg configuration to use
767 * @param stats the statistics handle to use
770 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
771 const struct GNUNET_STATISTICS_Handle *stats)
775 char *quota_wan_in_str;
776 char *quota_wan_out_str;
780 addresses = GNUNET_CONTAINER_multihashmap_create (128);
781 GNUNET_assert (NULL != addresses);
783 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", "WAN_QUOTA_IN", "a_wan_in_str))
785 if (0 == strcmp(quota_wan_in_str, "unlimited") ||
786 (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_wan_in_str, &wan_quota_in)))
787 wan_quota_in = (UINT32_MAX) /10;
789 GNUNET_free (quota_wan_in_str);
790 quota_wan_in_str = NULL;
794 wan_quota_in = (UINT32_MAX) /10;
797 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", "WAN_QUOTA_OUT", "a_wan_out_str))
799 if (0 == strcmp(quota_wan_out_str, "unlimited") ||
800 (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_wan_out_str, &wan_quota_out)))
801 wan_quota_out = (UINT32_MAX) /10;
803 GNUNET_free (quota_wan_out_str);
804 quota_wan_out_str = NULL;
808 wan_quota_out = (UINT32_MAX) /10;
811 mode = GNUNET_CONFIGURATION_get_value_yesno (cfg, "ats", "MLP");
812 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MLP mode %u", mode);
819 /* Init the MLP solver with default values */
820 mlp = GAS_mlp_init (cfg, stats, MLP_MAX_EXEC_DURATION, MLP_MAX_ITERATIONS);
823 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "MLP mode was configured, but libglpk is not installed, switching to simple mode\n");
824 GNUNET_STATISTICS_update (GSA_stats, "MLP mode enabled", 0, GNUNET_NO);
829 GNUNET_STATISTICS_update (GSA_stats, "MLP enabled", 1, GNUNET_NO);
833 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "MLP mode was configured, but libglpk is not installed, switching to simple mode");
834 GNUNET_STATISTICS_update (GSA_stats, "MLP enabled", 0, GNUNET_NO);
840 GNUNET_STATISTICS_update (GSA_stats, "MLP enabled", 0, GNUNET_NO);
843 /* No configuration value */
845 GNUNET_STATISTICS_update (GSA_stats, "MLP enabled", 0, GNUNET_NO);
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started with %s mode\n", (SIMPLE == ats_mode) ? "SIMPLE" : "MLP");
852 running = GNUNET_YES;
857 * Free memory of address.
860 * @param key peer identity (unused)
861 * @param value the 'struct ATS_Address' to free
862 * @return GNUNET_OK (continue to iterate)
865 free_address_it (void *cls, const GNUNET_HashCode * key, void *value)
867 struct ATS_Address *aa = value;
869 destroy_address (aa);
875 GAS_addresses_destroy_all ()
877 if (GNUNET_NO == running)
880 if (addresses != NULL)
881 GNUNET_CONTAINER_multihashmap_iterate (addresses, &free_address_it, NULL);
882 GNUNET_assert (active_addr_count == 0);
887 * Shutdown address subsystem.
890 GAS_addresses_done ()
892 GAS_addresses_destroy_all ();
894 GNUNET_CONTAINER_multihashmap_destroy (addresses);
906 /* end of gnunet-service-ats_addresses.c */