2 This file is part of GNUnet.
3 (C) 2010,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 * @brief automatic transport selection API
23 * @author Christian Grothoff
24 * @author Matthias Wachs
28 * - extend API to get performance data
29 * - implement simplistic strategy based on say 'lowest latency' or strict ordering
30 * - extend API to get peer preferences, implement proportional bandwidth assignment
31 * - re-implement API against a real ATS service (!)
34 #include "gnunet_ats_service.h"
37 #define DEBUG_ATS GNUNET_EXTRA_LOGGING
39 #define LOG(kind,...) GNUNET_log_from (kind, "ats-api", __VA_ARGS__)
42 * Receive and send buffer windows grow over time. For
43 * how long can 'unused' bandwidth accumulate before we
44 * need to cap it? (specified in seconds).
46 #define MAX_WINDOW_TIME_S (5 * 60)
48 // NOTE: this implementation is simply supposed
49 // to implement a simplistic strategy in-process;
50 // in the future, we plan to replace it with a real
51 // service implementation
55 * Opaque handle to obtain address suggestions.
57 struct GNUNET_ATS_SuggestionContext
61 * Function to call with our final suggestion.
63 GNUNET_ATS_AddressSuggestionCallback cb;
73 struct GNUNET_ATS_Handle *atc;
76 * Which peer are we monitoring?
78 struct GNUNET_PeerIdentity target;
84 * Count number of connected records.
86 * @param cls pointer to counter
87 * @param key identity of the peer associated with the records
88 * @param value a 'struct AllocationRecord'
89 * @return GNUNET_YES (continue iteration)
92 count_connections (void *cls, const GNUNET_HashCode * key, void *value)
94 unsigned int *ac = cls;
95 struct AllocationRecord *ar = value;
97 if (GNUNET_YES == ar->connected)
104 * Closure for 'set_bw_connections'.
106 struct SetBandwidthContext
111 struct GNUNET_ATS_Handle *atc;
114 * Inbound bandwidth to assign.
116 struct GNUNET_BANDWIDTH_Value32NBO bw_in;
119 * Outbound bandwidth to assign.
121 struct GNUNET_BANDWIDTH_Value32NBO bw_out;
126 * Set bandwidth based on record.
128 * @param cls 'struct SetBandwidthContext'
129 * @param key identity of the peer associated with the records
130 * @param value a 'struct AllocationRecord'
131 * @return GNUNET_YES (continue iteration)
134 set_bw_connections (void *cls, const GNUNET_HashCode * key, void *value)
136 struct SetBandwidthContext *sbc = cls;
137 struct AllocationRecord *ar = value;
139 if (GNUNET_YES == ar->connected)
141 ar->bandwidth_in = sbc->bw_in;
142 ar->bandwidth_out = sbc->bw_out;
143 GNUNET_BANDWIDTH_tracker_update_quota (&ar->available_recv_window,
145 LOG (GNUNET_ERROR_TYPE_DEBUG,
146 "Bandwidth assigned to peer %s is i:%u/o:%u bytes/s\n",
147 GNUNET_i2s ((const struct GNUNET_PeerIdentity *) key),
148 ntohl (ar->bandwidth_in.value__),
149 ntohl (ar->bandwidth_out.value__));
150 if (NULL != sbc->atc->alloc_cb)
151 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
152 (const struct GNUNET_PeerIdentity *) key,
153 ar->plugin_name, ar->session, ar->plugin_addr,
154 ar->plugin_addr_len, ar->bandwidth_out,
157 else if (ntohl (ar->bandwidth_out.value__) > 0)
159 ar->bandwidth_in = GNUNET_BANDWIDTH_value_init (0);
160 ar->bandwidth_out = GNUNET_BANDWIDTH_value_init (0);
161 if (NULL != sbc->atc->alloc_cb)
162 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
163 (const struct GNUNET_PeerIdentity *) key,
164 ar->plugin_name, ar->session, ar->plugin_addr,
165 ar->plugin_addr_len, ar->bandwidth_out,
173 * Task run to update bandwidth assignments.
175 * @param cls the 'struct GNUNET_ATS_Handle'
176 * @param tc scheduler context
179 update_bandwidth_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
181 struct GNUNET_ATS_Handle *atc = cls;
183 struct SetBandwidthContext bwc;
185 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
186 /* FIXME: update calculations NICELY; what follows is a naive version */
187 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &count_connections, &ac);
191 GNUNET_assert (ac > 0);
192 bwc.bw_in = GNUNET_BANDWIDTH_value_init (atc->total_bps_in / ac);
193 bwc.bw_out = GNUNET_BANDWIDTH_value_init (atc->total_bps_out / ac);
194 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &set_bw_connections, &bwc);
199 * Calculate an updated bandwidth assignment and notify.
202 * @param change which allocation record changed?
205 update_bandwidth_assignment (struct GNUNET_ATS_Handle *atc,
206 struct AllocationRecord *change)
208 /* FIXME: based on the 'change', update the LP-problem... */
209 if (atc->ba_task == GNUNET_SCHEDULER_NO_TASK)
210 atc->ba_task = GNUNET_SCHEDULER_add_now (&update_bandwidth_task, atc);
215 * Function called with feasbile addresses we might want to suggest.
217 * @param cls the 'struct GNUNET_ATS_SuggestionContext'
218 * @param key identity of the peer
219 * @param value a 'struct AllocationRecord' for the peer
220 * @return GNUNET_NO if we're done, GNUNET_YES if we did not suggest an address yet
223 suggest_address (void *cls, const GNUNET_HashCode * key, void *value)
225 struct GNUNET_ATS_SuggestionContext *asc = cls;
226 struct AllocationRecord *ar = value;
229 LOG (GNUNET_ERROR_TYPE_DEBUG,
230 "Suggesting address for peer `%s', starting with i:%u/o:%u bytes/s\n",
232 asc->atc->total_bps_in/32,
233 asc->atc->total_bps_out/32);
236 /* trivial strategy: pick first available address... */
237 asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
238 ar->plugin_addr_len, ar->session,
239 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_out / 32),
240 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_in / 32), ar->ats,
248 map_it (void *cls, const GNUNET_HashCode * key, void *value)
250 LOG (GNUNET_ERROR_TYPE_DEBUG, "Found entry for %s\n", GNUNET_h2s (key));
255 * We would like to establish a new connection with a peer.
256 * ATS should suggest a good address to begin with.
259 * @param peer identity of the new peer
260 * @param cb function to call with the address
261 * @param cb_cls closure for cb
263 struct GNUNET_ATS_SuggestionContext *
264 GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
265 const struct GNUNET_PeerIdentity *peer,
266 GNUNET_ATS_AddressSuggestionCallback cb,
269 struct GNUNET_ATS_SuggestionContext *asc;
272 LOG (GNUNET_ERROR_TYPE_DEBUG,
273 "Looking up suggested address for peer `%s'\n", GNUNET_i2s (peer));
275 asc = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestionContext));
277 asc->cb_cls = cb_cls;
280 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
282 &suggest_address, asc);
289 GNUNET_CONTAINER_multihashmap_put (atc->notify_map, &peer->hashPubKey, asc,
290 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
296 * Cancel suggestion request.
298 * @param asc handle of the request to cancel
301 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc)
303 GNUNET_assert (GNUNET_OK ==
304 GNUNET_CONTAINER_multihashmap_remove (asc->atc->notify_map,
305 &asc->target.hashPubKey,
312 * Initialize the ATS subsystem.
314 * @param cfg configuration to use
315 * @param alloc_cb notification to call whenever the allocation changed
316 * @param alloc_cb_cls closure for 'alloc_cb'
317 * @return ats context
319 struct GNUNET_ATS_Handle *
320 GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
321 GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
324 struct GNUNET_ATS_Handle *atc;
327 LOG (GNUNET_ERROR_TYPE_DEBUG, "ATS init\n");
329 atc = GNUNET_malloc (sizeof (struct GNUNET_ATS_Handle));
331 atc->alloc_cb = alloc_cb;
332 atc->alloc_cb_cls = alloc_cb_cls;
333 atc->peers = GNUNET_CONTAINER_multihashmap_create (256);
334 atc->notify_map = GNUNET_CONTAINER_multihashmap_create (256);
335 GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_OUT",
336 &atc->total_bps_out);
337 GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_IN",
344 * Free an allocation record.
347 * @param key identity of the peer associated with the record
348 * @param value the 'struct AllocationRecord' to free
349 * @return GNUNET_OK (continue to iterate)
352 destroy_allocation_record (void *cls, const GNUNET_HashCode * key, void *value)
354 struct AllocationRecord *ar = value;
356 GNUNET_array_grow (ar->ats, ar->ats_count, 0);
357 GNUNET_free (ar->plugin_name);
364 * Shutdown the ATS subsystem.
369 GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc)
372 LOG (GNUNET_ERROR_TYPE_DEBUG, "ATS shutdown\n");
374 if (GNUNET_SCHEDULER_NO_TASK != atc->ba_task)
376 GNUNET_SCHEDULER_cancel (atc->ba_task);
377 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
379 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_allocation_record,
381 GNUNET_CONTAINER_multihashmap_destroy (atc->peers);
382 GNUNET_assert (GNUNET_CONTAINER_multihashmap_size (atc->notify_map) == 0);
383 GNUNET_CONTAINER_multihashmap_destroy (atc->notify_map);
384 atc->notify_map = NULL;
390 * Closure for 'update_session'
392 struct UpdateSessionContext
397 struct GNUNET_ATS_Handle *atc;
400 * Allocation record with new information.
402 struct AllocationRecord *arnew;
407 * Update an allocation record, merging with the new information
409 * @param cls a new 'struct AllocationRecord'
410 * @param key identity of the peer associated with the records
411 * @param value the old 'struct AllocationRecord'
412 * @return GNUNET_YES if the records do not match,
413 * GNUNET_NO if the record do match and 'old' was updated
416 update_session (void *cls, const GNUNET_HashCode * key, void *value)
418 struct UpdateSessionContext *usc = cls;
419 struct AllocationRecord *arnew = usc->arnew;
420 struct AllocationRecord *arold = value;
428 LOG (GNUNET_ERROR_TYPE_DEBUG,
429 "Updating session for peer `%s' plugin `%s'\n", GNUNET_h2s (key),
433 if (0 != strcmp (arnew->plugin_name, arold->plugin_name))
435 if (((arnew->session == arold->session) && (arnew->session != NULL)) ||
436 ((arold->session == NULL) &&
437 (arold->plugin_addr_len == arnew->plugin_addr_len) &&
439 memcmp (arold->plugin_addr, arnew->plugin_addr,
440 arnew->plugin_addr_len))))
444 if (arnew->session != arold->session)
446 arold->session = arnew->session;
449 if ((arnew->connected == GNUNET_YES) && (arold->connected == GNUNET_NO))
451 arold->connected = GNUNET_YES;
455 /* Update existing value */
457 while (c_new < arnew->ats_count)
461 while (c_old < arold->ats_count)
463 if (arold->ats[c_old].type == arnew->ats[c_new].type)
466 LOG (GNUNET_ERROR_TYPE_DEBUG,
467 "Found type %i, old value=%i new value=%i\n",
468 ntohl (arold->ats[c_old].type), ntohl (arold->ats[c_old].value),
469 ntohl (arnew->ats[c_new].value));
471 arold->ats[c_old].value = arnew->ats[c_new].value;
477 if (found == GNUNET_NO)
480 LOG (GNUNET_ERROR_TYPE_DEBUG, "Added new type %i new value=%i\n",
481 ntohl (arnew->ats[c_new].type), ntohl (arnew->ats[c_new].value));
482 LOG (GNUNET_ERROR_TYPE_DEBUG, "Old array size: %u\n", arold->ats_count);
484 GNUNET_array_grow (arold->ats, arold->ats_count, arold->ats_count + 1);
485 GNUNET_assert (arold->ats_count >= 2);
486 arold->ats[arold->ats_count - 2].type = arnew->ats[c_new].type;
487 arold->ats[arold->ats_count - 2].value = arnew->ats[c_new].value;
488 arold->ats[arold->ats_count - 1].type = htonl (0);
489 arold->ats[arold->ats_count - 1].value = htonl (0);
491 LOG (GNUNET_ERROR_TYPE_DEBUG, "New array size: %i\n", arold->ats_count);
497 if (GNUNET_YES == change)
498 update_bandwidth_assignment (usc->atc, arold);
506 * Create an allocation record with the given properties.
508 * @param plugin_name name of the currently used transport plugin
509 * @param session session in use (if available)
510 * @param plugin_addr address in use (if available)
511 * @param plugin_addr_len number of bytes in plugin_addr
512 * @param ats performance data for the connection
513 * @param ats_count number of performance records in 'ats'
515 static struct AllocationRecord *
516 create_allocation_record (const char *plugin_name, struct Session *session,
517 const void *plugin_addr, size_t plugin_addr_len,
518 const struct GNUNET_TRANSPORT_ATS_Information *ats,
521 struct AllocationRecord *ar;
523 ar = GNUNET_malloc (sizeof (struct AllocationRecord) + plugin_addr_len);
524 ar->plugin_name = GNUNET_strdup (plugin_name);
525 ar->plugin_addr = &ar[1];
526 memcpy (&ar[1], plugin_addr, plugin_addr_len);
527 ar->session = session;
528 ar->plugin_addr_len = plugin_addr_len;
529 GNUNET_BANDWIDTH_tracker_init (&ar->available_recv_window, ar->bandwidth_in,
531 GNUNET_assert (ats_count > 0);
532 GNUNET_array_grow (ar->ats, ar->ats_count, ats_count);
533 memcpy (ar->ats, ats,
534 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
540 * Mark all matching allocation records as not connected.
542 * @param cls 'struct GTS_AtsHandle'
543 * @param key identity of the peer associated with the record
544 * @param value the 'struct AllocationRecord' to clear the 'connected' flag
545 * @return GNUNET_OK (continue to iterate)
548 disconnect_peer (void *cls, const GNUNET_HashCode * key, void *value)
550 struct GNUNET_ATS_Handle *atc = cls;
551 struct AllocationRecord *ar = value;
553 if (GNUNET_YES == ar->connected)
555 ar->connected = GNUNET_NO;
556 update_bandwidth_assignment (atc, ar);
563 * We established a new connection with a peer (for example, because
564 * core asked for it or because the other peer connected to us).
565 * Calculate bandwidth assignments including the new peer.
568 * @param peer identity of the new peer
569 * @param plugin_name name of the currently used transport plugin
570 * @param session session in use (if available)
571 * @param plugin_addr address in use (if available)
572 * @param plugin_addr_len number of bytes in plugin_addr
573 * @param ats performance data for the connection
574 * @param ats_count number of performance records in 'ats'
577 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
578 const struct GNUNET_PeerIdentity *peer,
579 const char *plugin_name, struct Session *session,
580 const void *plugin_addr, size_t plugin_addr_len,
581 const struct GNUNET_TRANSPORT_ATS_Information *ats,
584 struct AllocationRecord *ar;
585 struct UpdateSessionContext usc;
587 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &disconnect_peer,
589 ar = create_allocation_record (plugin_name, session, plugin_addr,
590 plugin_addr_len, ats, ats_count);
591 ar->connected = GNUNET_YES;
595 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
597 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
600 GNUNET_assert (GNUNET_OK ==
601 GNUNET_CONTAINER_multihashmap_put (atc->peers,
602 &peer->hashPubKey, ar,
603 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
608 * We disconnected from the given peer (for example, because ats, core
609 * or blacklist asked for it or because the other peer disconnected).
610 * Calculate bandwidth assignments without the peer.
613 * @param peer identity of the new peer
616 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
617 const struct GNUNET_PeerIdentity *peer)
619 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
621 &disconnect_peer, atc);
626 * Closure for 'destroy_allocation_record'
628 struct SessionDestroyContext
633 struct GNUNET_ATS_Handle *atc;
636 * Session being destroyed.
638 const struct Session *session;
643 * Free an allocation record matching the given session.
645 * @param cls the 'struct SessionDestroyContext'
646 * @param key identity of the peer associated with the record
647 * @param value the 'struct AllocationRecord' to free
648 * @return GNUNET_OK (continue to iterate)
651 destroy_session (void *cls, const GNUNET_HashCode * key, void *value)
653 struct SessionDestroyContext *sdc = cls;
654 struct AllocationRecord *ar = value;
656 if (ar->session != sdc->session)
659 if (ar->plugin_addr != NULL)
661 GNUNET_assert (GNUNET_OK ==
662 GNUNET_CONTAINER_multihashmap_remove (sdc->atc->peers, key,
664 if (GNUNET_YES == ar->connected) ;
666 /* FIXME: is this supposed to be allowed? What to do then? */
669 destroy_allocation_record (NULL, key, ar);
675 * A session got destroyed, stop including it as a valid address.
678 * @param peer identity of the peer
679 * @param session session handle that is no longer valid
682 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
683 const struct GNUNET_PeerIdentity *peer,
684 const struct Session *session)
686 struct SessionDestroyContext sdc;
689 sdc.session = session;
690 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_session,
696 * Notify validation watcher that an entry is now valid
698 * @param cls 'struct ValidationEntry' that is now valid
699 * @param key peer identity (unused)
700 * @param value a 'GST_ValidationIteratorContext' to notify
701 * @return GNUNET_YES (continue to iterate)
704 notify_valid (void *cls, const GNUNET_HashCode * key, void *value)
706 struct AllocationRecord *ar = cls;
707 struct GNUNET_ATS_SuggestionContext *asc = value;
709 asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
710 ar->plugin_addr_len, ar->session,
711 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_out / 32),
712 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_in / 32), ar->ats,
714 GNUNET_ATS_suggest_address_cancel (asc);
721 * We have updated performance statistics for a given address. Note
722 * that this function can be called for addresses that are currently
723 * in use as well as addresses that are valid but not actively in use.
724 * Furthermore, the peer may not even be connected to us right now (in
725 * which case the call may be ignored or the information may be stored
726 * for later use). Update bandwidth assignments.
729 * @param peer identity of the peer
730 * @param valid_until how long is the address valid?
731 * @param plugin_name name of the transport plugin
732 * @param session session handle (if available)
733 * @param plugin_addr address (if available)
734 * @param plugin_addr_len number of bytes in plugin_addr
735 * @param ats performance data for the address
736 * @param ats_count number of performance records in 'ats'
739 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
740 const struct GNUNET_PeerIdentity *peer,
741 struct GNUNET_TIME_Absolute valid_until,
742 const char *plugin_name, struct Session *session,
743 const void *plugin_addr, size_t plugin_addr_len,
744 const struct GNUNET_TRANSPORT_ATS_Information *ats,
747 struct AllocationRecord *ar;
748 struct UpdateSessionContext usc;
751 LOG (GNUNET_ERROR_TYPE_DEBUG,
752 "Updating address for peer `%s', plugin `%s'\n", GNUNET_i2s (peer),
755 ar = create_allocation_record (plugin_name, session, plugin_addr,
756 plugin_addr_len, ats, ats_count);
760 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
762 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
766 LOG (GNUNET_ERROR_TYPE_DEBUG,
767 "Adding new address for peer `%s', plugin `%s'\n", GNUNET_i2s (peer),
770 GNUNET_assert (GNUNET_OK ==
771 GNUNET_CONTAINER_multihashmap_put (atc->peers,
772 &peer->hashPubKey, ar,
773 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
774 GNUNET_CONTAINER_multihashmap_get_multiple (atc->notify_map,
775 &peer->hashPubKey, ¬ify_valid,
779 /* end of file gnunet-service-transport_ats.c */