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 GNUNET_assert (GNUNET_SYSERR != ar->connected);
140 /* FIXME: ||1 because we currently NEVER get 'connected' events... */
141 if ( (GNUNET_YES == ar->connected) || 1)
143 ar->bandwidth_in = sbc->bw_in;
144 ar->bandwidth_out = sbc->bw_out;
145 GNUNET_BANDWIDTH_tracker_update_quota (&ar->available_recv_window,
147 LOG (GNUNET_ERROR_TYPE_DEBUG,
148 "Bandwidth assigned to peer %s is i:%u/o:%u bytes/s\n",
149 GNUNET_i2s ((const struct GNUNET_PeerIdentity *) key),
150 ntohl (ar->bandwidth_in.value__),
151 ntohl (ar->bandwidth_out.value__));
152 if (NULL != sbc->atc->alloc_cb)
153 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
154 (const struct GNUNET_PeerIdentity *) key,
155 ar->plugin_name, ar->session, ar->plugin_addr,
156 ar->plugin_addr_len, ar->bandwidth_out,
159 else if (ntohl (ar->bandwidth_out.value__) > 0)
161 ar->bandwidth_in = GNUNET_BANDWIDTH_value_init (0);
162 ar->bandwidth_out = GNUNET_BANDWIDTH_value_init (0);
163 if (NULL != sbc->atc->alloc_cb)
164 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
165 (const struct GNUNET_PeerIdentity *) key,
166 ar->plugin_name, ar->session, ar->plugin_addr,
167 ar->plugin_addr_len, ar->bandwidth_out,
171 LOG (GNUNET_ERROR_TYPE_DEBUG,
172 "Not communicating bandwidth assigned to peer %s: not connected and bw is: i:%u/o:%u bytes/s\n",
173 GNUNET_i2s ((const struct GNUNET_PeerIdentity *) key),
174 ntohl (ar->bandwidth_in.value__),
175 ntohl (ar->bandwidth_out.value__));
182 * Task run to update bandwidth assignments.
184 * @param cls the 'struct GNUNET_ATS_Handle'
185 * @param tc scheduler context
188 update_bandwidth_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
190 struct GNUNET_ATS_Handle *atc = cls;
192 struct SetBandwidthContext bwc;
194 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
195 /* FIXME: update calculations NICELY; what follows is a naive version */
196 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &count_connections, &ac);
200 GNUNET_assert (ac > 0);
201 bwc.bw_in = GNUNET_BANDWIDTH_value_init (atc->total_bps_in / ac);
202 bwc.bw_out = GNUNET_BANDWIDTH_value_init (atc->total_bps_out / ac);
203 LOG (GNUNET_ERROR_TYPE_DEBUG,
204 "Trivial implementation: bandwidth assigned to each peer is i:%u/o:%u bytes/s\n",
205 ntohl (bwc.bw_in.value__),
206 ntohl (bwc.bw_out.value__));
207 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &set_bw_connections, &bwc);
212 * Calculate an updated bandwidth assignment and notify.
215 * @param change which allocation record changed?
218 update_bandwidth_assignment (struct GNUNET_ATS_Handle *atc,
219 struct AllocationRecord *change)
221 /* FIXME: based on the 'change', update the LP-problem... */
222 if (atc->ba_task == GNUNET_SCHEDULER_NO_TASK)
223 atc->ba_task = GNUNET_SCHEDULER_add_now (&update_bandwidth_task, atc);
228 * Function called with feasbile addresses we might want to suggest.
230 * @param cls the 'struct GNUNET_ATS_SuggestionContext'
231 * @param key identity of the peer
232 * @param value a 'struct AllocationRecord' for the peer
233 * @return GNUNET_NO if we're done, GNUNET_YES if we did not suggest an address yet
236 suggest_address (void *cls, const GNUNET_HashCode * key, void *value)
238 struct GNUNET_ATS_SuggestionContext *asc = cls;
239 struct AllocationRecord *ar = value;
242 LOG (GNUNET_ERROR_TYPE_DEBUG,
243 "Suggesting address for peer `%s', starting with i:%u/o:%u bytes/s\n",
245 asc->atc->total_bps_in/32,
246 asc->atc->total_bps_out/32);
249 /* trivial strategy: pick first available address... */
250 asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
251 ar->plugin_addr_len, ar->session,
252 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_out / 32),
253 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_in / 32), ar->ats,
261 map_it (void *cls, const GNUNET_HashCode * key, void *value)
263 LOG (GNUNET_ERROR_TYPE_DEBUG, "Found entry for %s\n", GNUNET_h2s (key));
268 * We would like to establish a new connection with a peer.
269 * ATS should suggest a good address to begin with.
272 * @param peer identity of the new peer
273 * @param cb function to call with the address
274 * @param cb_cls closure for cb
276 struct GNUNET_ATS_SuggestionContext *
277 GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
278 const struct GNUNET_PeerIdentity *peer,
279 GNUNET_ATS_AddressSuggestionCallback cb,
282 struct GNUNET_ATS_SuggestionContext *asc;
285 LOG (GNUNET_ERROR_TYPE_DEBUG,
286 "Looking up suggested address for peer `%s'\n", GNUNET_i2s (peer));
288 asc = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestionContext));
290 asc->cb_cls = cb_cls;
293 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
295 &suggest_address, asc);
302 GNUNET_CONTAINER_multihashmap_put (atc->notify_map, &peer->hashPubKey, asc,
303 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
309 * Cancel suggestion request.
311 * @param asc handle of the request to cancel
314 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc)
316 GNUNET_assert (GNUNET_OK ==
317 GNUNET_CONTAINER_multihashmap_remove (asc->atc->notify_map,
318 &asc->target.hashPubKey,
325 * Initialize the ATS subsystem.
327 * @param cfg configuration to use
328 * @param alloc_cb notification to call whenever the allocation changed
329 * @param alloc_cb_cls closure for 'alloc_cb'
330 * @return ats context
332 struct GNUNET_ATS_Handle *
333 GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
334 GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
337 struct GNUNET_ATS_Handle *atc;
340 LOG (GNUNET_ERROR_TYPE_DEBUG, "ATS init\n");
342 atc = GNUNET_malloc (sizeof (struct GNUNET_ATS_Handle));
344 atc->alloc_cb = alloc_cb;
345 atc->alloc_cb_cls = alloc_cb_cls;
346 atc->peers = GNUNET_CONTAINER_multihashmap_create (256);
347 atc->notify_map = GNUNET_CONTAINER_multihashmap_create (256);
348 GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_OUT",
349 &atc->total_bps_out);
350 GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_IN",
357 * Free an allocation record.
360 * @param key identity of the peer associated with the record
361 * @param value the 'struct AllocationRecord' to free
362 * @return GNUNET_OK (continue to iterate)
365 destroy_allocation_record (void *cls, const GNUNET_HashCode * key, void *value)
367 struct AllocationRecord *ar = value;
369 GNUNET_array_grow (ar->ats, ar->ats_count, 0);
370 GNUNET_free (ar->plugin_name);
377 * Shutdown the ATS subsystem.
382 GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc)
385 LOG (GNUNET_ERROR_TYPE_DEBUG, "ATS shutdown\n");
387 if (GNUNET_SCHEDULER_NO_TASK != atc->ba_task)
389 GNUNET_SCHEDULER_cancel (atc->ba_task);
390 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
392 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_allocation_record,
394 GNUNET_CONTAINER_multihashmap_destroy (atc->peers);
395 GNUNET_assert (GNUNET_CONTAINER_multihashmap_size (atc->notify_map) == 0);
396 GNUNET_CONTAINER_multihashmap_destroy (atc->notify_map);
397 atc->notify_map = NULL;
403 * Closure for 'update_session'
405 struct UpdateSessionContext
410 struct GNUNET_ATS_Handle *atc;
413 * Allocation record with new information.
415 struct AllocationRecord *arnew;
420 * Update an allocation record, merging with the new information
422 * @param cls a new 'struct AllocationRecord'
423 * @param key identity of the peer associated with the records
424 * @param value the old 'struct AllocationRecord'
425 * @return GNUNET_YES if the records do not match,
426 * GNUNET_NO if the record do match and 'old' was updated
429 update_session (void *cls, const GNUNET_HashCode * key, void *value)
431 struct UpdateSessionContext *usc = cls;
432 struct AllocationRecord *arnew = usc->arnew;
433 struct AllocationRecord *arold = value;
439 if (0 != strcmp (arnew->plugin_name, arold->plugin_name))
441 if (! (((arnew->session == arold->session) && (arnew->session != NULL)) ||
442 ((arold->session == NULL) &&
443 (arold->plugin_addr_len == arnew->plugin_addr_len) &&
445 memcmp (arold->plugin_addr, arnew->plugin_addr,
446 arnew->plugin_addr_len)))))
447 return GNUNET_YES; /* no match */
450 LOG (GNUNET_ERROR_TYPE_DEBUG,
451 "Updating session for peer `%s' plugin `%s'\n", GNUNET_h2s (key),
454 if (arnew->session != arold->session)
456 arold->session = arnew->session;
458 if ((arnew->connected == GNUNET_YES) && (arold->connected == GNUNET_NO))
460 arold->connected = GNUNET_YES;
463 /* Update existing value */
465 while (c_new < arnew->ats_count)
469 while (c_old < arold->ats_count)
471 if (arold->ats[c_old].type == arnew->ats[c_new].type)
474 LOG (GNUNET_ERROR_TYPE_DEBUG,
475 "Found type %i, old value=%i new value=%i\n",
476 ntohl (arold->ats[c_old].type), ntohl (arold->ats[c_old].value),
477 ntohl (arnew->ats[c_new].value));
479 arold->ats[c_old].value = arnew->ats[c_new].value;
485 if (found == GNUNET_NO)
488 LOG (GNUNET_ERROR_TYPE_DEBUG, "Added new type %i new value=%i\n",
489 ntohl (arnew->ats[c_new].type), ntohl (arnew->ats[c_new].value));
490 LOG (GNUNET_ERROR_TYPE_DEBUG, "Old array size: %u\n", arold->ats_count);
492 GNUNET_array_grow (arold->ats, arold->ats_count, arold->ats_count + 1);
493 GNUNET_assert (arold->ats_count >= 2);
494 arold->ats[arold->ats_count - 2].type = arnew->ats[c_new].type;
495 arold->ats[arold->ats_count - 2].value = arnew->ats[c_new].value;
496 arold->ats[arold->ats_count - 1].type = htonl (0);
497 arold->ats[arold->ats_count - 1].value = htonl (0);
499 LOG (GNUNET_ERROR_TYPE_DEBUG, "New array size: %i\n", arold->ats_count);
505 update_bandwidth_assignment (usc->atc, arold);
511 * Create an allocation record with the given properties.
513 * @param plugin_name name of the currently used transport plugin
514 * @param session session in use (if available)
515 * @param plugin_addr address in use (if available)
516 * @param plugin_addr_len number of bytes in plugin_addr
517 * @param ats performance data for the connection
518 * @param ats_count number of performance records in 'ats'
520 static struct AllocationRecord *
521 create_allocation_record (const char *plugin_name, struct Session *session,
522 const void *plugin_addr, size_t plugin_addr_len,
523 const struct GNUNET_TRANSPORT_ATS_Information *ats,
526 struct AllocationRecord *ar;
528 ar = GNUNET_malloc (sizeof (struct AllocationRecord) + plugin_addr_len);
529 ar->plugin_name = GNUNET_strdup (plugin_name);
530 ar->plugin_addr = &ar[1];
531 memcpy (&ar[1], plugin_addr, plugin_addr_len);
532 ar->session = session;
533 ar->plugin_addr_len = plugin_addr_len;
534 GNUNET_BANDWIDTH_tracker_init (&ar->available_recv_window, ar->bandwidth_in,
536 GNUNET_assert (ats_count > 0);
537 GNUNET_array_grow (ar->ats, ar->ats_count, ats_count);
538 memcpy (ar->ats, ats,
539 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
540 ar->connected = GNUNET_SYSERR; /* aka: not known / no change */
546 * Mark all matching allocation records as not connected.
548 * @param cls 'struct GTS_AtsHandle'
549 * @param key identity of the peer associated with the record
550 * @param value the 'struct AllocationRecord' to clear the 'connected' flag
551 * @return GNUNET_OK (continue to iterate)
554 disconnect_peer (void *cls, const GNUNET_HashCode * key, void *value)
556 struct GNUNET_ATS_Handle *atc = cls;
557 struct AllocationRecord *ar = value;
559 if (GNUNET_YES == ar->connected)
561 ar->connected = GNUNET_NO;
562 update_bandwidth_assignment (atc, ar);
569 * We established a new connection with a peer (for example, because
570 * core asked for it or because the other peer connected to us).
571 * Calculate bandwidth assignments including the new peer.
574 * @param peer identity of the new peer
575 * @param plugin_name name of the currently used transport plugin
576 * @param session session in use (if available)
577 * @param plugin_addr address in use (if available)
578 * @param plugin_addr_len number of bytes in plugin_addr
579 * @param ats performance data for the connection
580 * @param ats_count number of performance records in 'ats'
583 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
584 const struct GNUNET_PeerIdentity *peer,
585 const char *plugin_name, struct Session *session,
586 const void *plugin_addr, size_t plugin_addr_len,
587 const struct GNUNET_TRANSPORT_ATS_Information *ats,
590 struct AllocationRecord *ar;
591 struct UpdateSessionContext usc;
594 LOG (GNUNET_ERROR_TYPE_DEBUG,
595 "Connected to peer %s\n",
599 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &disconnect_peer,
601 ar = create_allocation_record (plugin_name, session, plugin_addr,
602 plugin_addr_len, ats, ats_count);
603 ar->connected = GNUNET_YES;
607 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
609 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
612 GNUNET_assert (GNUNET_OK ==
613 GNUNET_CONTAINER_multihashmap_put (atc->peers,
614 &peer->hashPubKey, ar,
615 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
620 * We disconnected from the given peer (for example, because ats, core
621 * or blacklist asked for it or because the other peer disconnected).
622 * Calculate bandwidth assignments without the peer.
625 * @param peer identity of the new peer
628 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
629 const struct GNUNET_PeerIdentity *peer)
632 LOG (GNUNET_ERROR_TYPE_DEBUG,
633 "Disconnected from peer %s\n",
636 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
638 &disconnect_peer, atc);
643 * Closure for 'destroy_allocation_record'
645 struct SessionDestroyContext
650 struct GNUNET_ATS_Handle *atc;
653 * Session being destroyed.
655 const struct Session *session;
660 * Free an allocation record matching the given session.
662 * @param cls the 'struct SessionDestroyContext'
663 * @param key identity of the peer associated with the record
664 * @param value the 'struct AllocationRecord' to free
665 * @return GNUNET_OK (continue to iterate)
668 destroy_session (void *cls, const GNUNET_HashCode * key, void *value)
670 struct SessionDestroyContext *sdc = cls;
671 struct AllocationRecord *ar = value;
673 if (ar->session != sdc->session)
676 if (ar->plugin_addr != NULL)
678 GNUNET_assert (GNUNET_OK ==
679 GNUNET_CONTAINER_multihashmap_remove (sdc->atc->peers, key,
681 if (GNUNET_YES == ar->connected) ;
683 /* FIXME: is this supposed to be allowed? What to do then? */
686 destroy_allocation_record (NULL, key, ar);
692 * A session got destroyed, stop including it as a valid address.
695 * @param peer identity of the peer
696 * @param session session handle that is no longer valid
699 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
700 const struct GNUNET_PeerIdentity *peer,
701 const struct Session *session)
703 struct SessionDestroyContext sdc;
706 sdc.session = session;
707 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_session,
713 * Notify validation watcher that an entry is now valid
715 * @param cls 'struct ValidationEntry' that is now valid
716 * @param key peer identity (unused)
717 * @param value a 'GST_ValidationIteratorContext' to notify
718 * @return GNUNET_YES (continue to iterate)
721 notify_valid (void *cls, const GNUNET_HashCode * key, void *value)
723 struct AllocationRecord *ar = cls;
724 struct GNUNET_ATS_SuggestionContext *asc = value;
726 asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
727 ar->plugin_addr_len, ar->session,
728 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_out / 32),
729 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_in / 32), ar->ats,
731 GNUNET_ATS_suggest_address_cancel (asc);
738 * We have updated performance statistics for a given address. Note
739 * that this function can be called for addresses that are currently
740 * in use as well as addresses that are valid but not actively in use.
741 * Furthermore, the peer may not even be connected to us right now (in
742 * which case the call may be ignored or the information may be stored
743 * for later use). Update bandwidth assignments.
746 * @param peer identity of the peer
747 * @param valid_until how long is the address valid?
748 * @param plugin_name name of the transport plugin
749 * @param session session handle (if available)
750 * @param plugin_addr address (if available)
751 * @param plugin_addr_len number of bytes in plugin_addr
752 * @param ats performance data for the address
753 * @param ats_count number of performance records in 'ats'
756 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
757 const struct GNUNET_PeerIdentity *peer,
758 struct GNUNET_TIME_Absolute valid_until,
759 const char *plugin_name, struct Session *session,
760 const void *plugin_addr, size_t plugin_addr_len,
761 const struct GNUNET_TRANSPORT_ATS_Information *ats,
764 struct AllocationRecord *ar;
765 struct UpdateSessionContext usc;
768 LOG (GNUNET_ERROR_TYPE_DEBUG,
769 "Updating address for peer `%s', plugin `%s'\n", GNUNET_i2s (peer),
772 ar = create_allocation_record (plugin_name, session, plugin_addr,
773 plugin_addr_len, ats, ats_count);
777 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
779 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
783 LOG (GNUNET_ERROR_TYPE_DEBUG,
784 "Adding new address for peer `%s', plugin `%s'\n", GNUNET_i2s (peer),
787 ar->connected = GNUNET_NO;
788 GNUNET_assert (GNUNET_OK ==
789 GNUNET_CONTAINER_multihashmap_put (atc->peers,
790 &peer->hashPubKey, ar,
791 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
792 GNUNET_CONTAINER_multihashmap_get_multiple (atc->notify_map,
793 &peer->hashPubKey, ¬ify_valid,
797 /* end of file gnunet-service-transport_ats.c */