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"
37 struct GNUNET_PeerIdentity peer;
49 struct GNUNET_ATS_Information *ats;
51 struct GNUNET_TIME_Relative atsp_latency;
53 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
55 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
57 uint32_t atsp_distance;
59 uint32_t atsp_cost_wan;
61 uint32_t atsp_cost_lan;
63 uint32_t atsp_cost_wlan;
65 uint32_t atsp_network_type;
67 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
69 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
72 * Is this the active address for this peer?
84 static struct GNUNET_CONTAINER_MultiHashMap *addresses;
86 static unsigned long long wan_quota_in;
88 static unsigned long long wan_quota_out;
90 static unsigned int active_addr_count;
95 * Update a bandwidth assignment for a peer. This trivial method currently
96 * simply assigns the same share to all active connections.
100 * @param value the 'struct ATS_Address'
101 * @return GNUNET_OK (continue to iterate)
104 update_bw_it (void *cls, const GNUNET_HashCode * key, void *value)
106 struct ATS_Address *aa = value;
108 if (GNUNET_YES != aa->active)
110 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);
113 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "New bandwidth for peer %s is %u/%u\n",
114 GNUNET_i2s (&aa->peer), ntohl (aa->assigned_bw_in.value__),
115 ntohl (aa->assigned_bw_out.value__));
116 GAS_scheduling_transmit_address_suggestion (&aa->peer, aa->plugin, aa->addr,
117 aa->addr_len, aa->session_id,
118 aa->ats, aa->ats_count,
121 GAS_reservations_set_bandwidth (&aa->peer, aa->assigned_bw_in);
122 GAS_performance_notify_clients (&aa->peer, aa->plugin, aa->addr, aa->addr_len,
123 aa->ats, aa->ats_count, aa->assigned_bw_out,
130 * Some (significant) input changed, recalculate bandwidth assignment
134 recalculate_assigned_bw ()
136 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
137 "Recalculating bandwidth for all active connections\n");
138 GNUNET_STATISTICS_update (GSA_stats, "# bandwidth recalculations performed",
140 GNUNET_STATISTICS_set (GSA_stats, "# active addresses", active_addr_count,
142 GNUNET_CONTAINER_multihashmap_iterate (addresses, &update_bw_it, NULL);
147 * Destroy the given address.
149 * @param addr address to destroy
150 * @return GNUNET_YES if bandwidth allocations should be recalcualted
153 destroy_address (struct ATS_Address *addr)
158 GNUNET_assert (GNUNET_YES ==
159 GNUNET_CONTAINER_multihashmap_remove (addresses,
160 &addr->peer.hashPubKey,
162 if (GNUNET_YES == addr->active)
165 addr->active = GNUNET_NO;
168 GNUNET_free_non_null (addr->ats);
169 GNUNET_free (addr->plugin);
175 struct CompareAddressContext
177 const struct ATS_Address *search;
178 struct ATS_Address *result;
183 compare_address_it (void *cls, const GNUNET_HashCode * key, void *value)
185 struct CompareAddressContext *cac = cls;
186 struct ATS_Address *aa = value;
188 if (((aa->addr_len != cac->search->addr_len) ||
189 (0 != strcmp (aa->plugin, cac->search->plugin)) ||
190 (0 != memcmp (aa->addr, cac->search->addr, aa->addr_len))) &&
191 ((aa->session_id != cac->search->session_id) ||
192 (cac->search->session_id == 0)))
200 * Find an existing equivalent address record.
201 * Compares by peer identity and network address OR by session ID
202 * (one of the two must match).
204 * @param peer peer to lookup addresses for
205 * @param addr existing address record
206 * @return existing address record, NULL for none
209 find_address (const struct GNUNET_PeerIdentity *peer,
210 const struct ATS_Address *addr)
212 struct CompareAddressContext cac;
216 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
217 &compare_address_it, &cac);
223 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
224 const char *plugin_name, const void *plugin_addr,
225 size_t plugin_addr_len, uint32_t session_id,
226 const struct GNUNET_ATS_Information *atsi,
229 struct ATS_Address *aa;
230 struct ATS_Address *old;
233 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
234 aa->ats = GNUNET_malloc (atsi_count * sizeof (struct GNUNET_ATS_Information));
236 aa->addr_len = plugin_addr_len;
237 aa->ats_count = atsi_count;
238 memcpy (aa->ats, atsi, atsi_count * sizeof (struct GNUNET_ATS_Information));
240 memcpy (&aa[1], plugin_addr, plugin_addr_len);
241 aa->plugin = GNUNET_strdup (plugin_name);
242 aa->session_id = session_id;
243 old = find_address (peer, aa);
246 GNUNET_assert (GNUNET_OK ==
247 GNUNET_CONTAINER_multihashmap_put (addresses,
248 &peer->hashPubKey, aa,
249 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
250 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' %X\n",
251 GNUNET_i2s (peer), aa);
256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
257 "Updated existing address for peer `%s' %X \n",
258 GNUNET_i2s (peer), old);
259 GNUNET_free_non_null (old->ats);
260 old->session_id = session_id;
264 old->ats_count = aa->ats_count;
265 GNUNET_free (aa->plugin);
268 for (i = 0; i < atsi_count; i++)
269 switch (ntohl (atsi[i].type))
271 case GNUNET_ATS_UTILIZATION_UP:
272 old->atsp_utilization_out.value__ = atsi[i].value;
274 case GNUNET_ATS_UTILIZATION_DOWN:
275 old->atsp_utilization_in.value__ = atsi[i].value;
277 case GNUNET_ATS_QUALITY_NET_DELAY:
278 old->atsp_latency.rel_value = ntohl (atsi[i].value);
280 case GNUNET_ATS_QUALITY_NET_DISTANCE:
281 old->atsp_distance = ntohl (atsi[i].value);
283 case GNUNET_ATS_COST_WAN:
284 old->atsp_cost_wan = ntohl (atsi[i].value);
286 case GNUNET_ATS_COST_LAN:
287 old->atsp_cost_lan = ntohl (atsi[i].value);
289 case GNUNET_ATS_COST_WLAN:
290 old->atsp_cost_wlan = ntohl (atsi[i].value);
292 case GNUNET_ATS_NETWORK_TYPE:
293 old->atsp_network_type = ntohl (atsi[i].value);
297 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
298 "Received unsupported ATS type %u\n", ntohl (atsi[i].type));
306 * Update a bandwidth assignment for a peer. This trivial method currently
307 * simply assigns the same share to all active connections.
311 * @param value the 'struct ATS_Address'
312 * @return GNUNET_OK (continue to iterate)
315 destroy_by_session_id (void *cls, const GNUNET_HashCode * key, void *value)
317 const struct ATS_Address *info = cls;
318 struct ATS_Address *aa = value;
321 memcmp (&aa->peer, &info->peer,
322 sizeof (struct GNUNET_PeerIdentity)));
323 if ((info->session_id == 0) && (0 == strcmp (info->plugin, aa->plugin)) &&
324 (aa->addr_len == info->addr_len) &&
325 (0 == memcmp (info->addr, aa->addr, aa->addr_len)))
327 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
328 "Deleting address for peer `%s': `%s'\n",
329 GNUNET_i2s (&aa->peer), aa->plugin);
330 if (GNUNET_YES == destroy_address (aa))
331 recalculate_assigned_bw ();
334 if (aa->session_id != info->session_id)
335 return GNUNET_OK; /* irrelevant */
336 if (aa->session_id != 0)
337 GNUNET_break (0 == strcmp (info->plugin, aa->plugin));
341 if (GNUNET_YES == aa->active)
343 aa->active = GNUNET_NO;
345 recalculate_assigned_bw ();
348 /* session == 0 and addrlen == 0 : destroy address */
349 if (aa->addr_len == 0)
350 (void) destroy_address (aa);
357 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
358 const char *plugin_name, const void *plugin_addr,
359 size_t plugin_addr_len, uint32_t session_id)
361 struct ATS_Address aa;
363 GNUNET_break (0 < strlen (plugin_name));
365 aa.addr_len = plugin_addr_len;
366 aa.addr = plugin_addr;
367 aa.plugin = (char *) plugin_name;
368 aa.session_id = session_id;
369 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
370 &destroy_by_session_id, &aa);
375 * Find a "good" address to use for a peer. If we already have an existing
376 * address, we stick to it. Otherwise, we pick by lowest distance and then
379 * @param cls the 'struct ATS_Address**' where we store the result
381 * @param value another 'struct ATS_Address*' to consider using
382 * @return GNUNET_OK (continue to iterate)
385 find_address_it (void *cls, const GNUNET_HashCode * key, void *value)
387 struct ATS_Address **ap = cls;
388 struct ATS_Address *aa = (struct ATS_Address *) value;
389 struct ATS_Address *ab = *ap;
396 if ((ntohl (ab->assigned_bw_in.value__) == 0) &&
397 (ntohl (aa->assigned_bw_in.value__) > 0))
399 /* stick to existing connection */
403 if (ab->atsp_distance > aa->atsp_distance)
405 /* user shorter distance */
409 if (ab->atsp_latency.rel_value > aa->atsp_latency.rel_value)
411 /* user lower latency */
421 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
422 const char *plugin_name, const void *plugin_addr,
423 size_t plugin_addr_len, uint32_t session_id, int in_use)
426 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
427 "Received `%s' message for peer `%s': %i\n", "ADDRESS_IN_USE",
428 GNUNET_i2s (peer), in_use);
432 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer)
434 struct ATS_Address *aa;
437 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
438 &find_address_it, &aa);
441 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
442 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
445 if (aa->active == GNUNET_NO)
447 aa->active = GNUNET_YES;
449 recalculate_assigned_bw ();
453 /* just to be sure... */
454 GAS_scheduling_transmit_address_suggestion (peer, aa->plugin, aa->addr,
455 aa->addr_len, aa->session_id,
456 aa->ats, aa->ats_count,
463 // FIXME: this function should likely end up in the LP-subsystem and
464 // not with 'addresses' in the future...
466 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
467 enum GNUNET_ATS_PreferenceKind kind,
470 // do nothing for now...
476 * Initialize address subsystem.
478 * @param cfg configuration to use
481 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
483 GNUNET_assert (GNUNET_OK ==
484 GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
487 GNUNET_assert (GNUNET_OK ==
488 GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
494 switch (GNUNET_CONFIGURATION_get_value_yesno (cfg, "ats", "MLP"))
499 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "MLP mode was configured, but libglpk is not installed, switching to simple mode");
510 /* No configuration value */
518 addresses = GNUNET_CONTAINER_multihashmap_create (128);
523 * Free memory of address.
526 * @param key peer identity (unused)
527 * @param value the 'struct ATS_Address' to free
528 * @return GNUNET_OK (continue to iterate)
531 free_address_it (void *cls, const GNUNET_HashCode * key, void *value)
533 struct ATS_Address *aa = value;
535 destroy_address (aa);
541 GAS_addresses_destroy_all ()
543 if (addresses != NULL)
544 GNUNET_CONTAINER_multihashmap_iterate (addresses, &free_address_it, NULL);
545 GNUNET_assert (active_addr_count == 0);
550 * Shutdown address subsystem.
553 GAS_addresses_done ()
555 GAS_addresses_destroy_all ();
556 GNUNET_CONTAINER_multihashmap_destroy (addresses);
561 /* end of gnunet-service-ats_addresses.c */