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, "Suggesting address for peer `%s'\n",
233 /* trivial strategy: pick first available address... */
234 asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
235 ar->plugin_addr_len, ar->session,
236 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_out / 32),
237 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_in / 32), ar->ats,
245 map_it (void *cls, const GNUNET_HashCode * key, void *value)
247 LOG (GNUNET_ERROR_TYPE_DEBUG, "Found entry for %s\n", GNUNET_h2s (key));
252 * We would like to establish a new connection with a peer.
253 * ATS should suggest a good address to begin with.
256 * @param peer identity of the new peer
257 * @param cb function to call with the address
258 * @param cb_cls closure for cb
260 struct GNUNET_ATS_SuggestionContext *
261 GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
262 const struct GNUNET_PeerIdentity *peer,
263 GNUNET_ATS_AddressSuggestionCallback cb,
266 struct GNUNET_ATS_SuggestionContext *asc;
269 LOG (GNUNET_ERROR_TYPE_DEBUG,
270 "Looking up suggested address for peer `%s'\n", GNUNET_i2s (peer));
272 asc = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestionContext));
274 asc->cb_cls = cb_cls;
277 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
279 &suggest_address, asc);
286 GNUNET_CONTAINER_multihashmap_put (atc->notify_map, &peer->hashPubKey, asc,
287 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
293 * Cancel suggestion request.
295 * @param asc handle of the request to cancel
298 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc)
300 GNUNET_assert (GNUNET_OK ==
301 GNUNET_CONTAINER_multihashmap_remove (asc->atc->notify_map,
302 &asc->target.hashPubKey,
309 * Initialize the ATS subsystem.
311 * @param cfg configuration to use
312 * @param alloc_cb notification to call whenever the allocation changed
313 * @param alloc_cb_cls closure for 'alloc_cb'
314 * @return ats context
316 struct GNUNET_ATS_Handle *
317 GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
318 GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
321 struct GNUNET_ATS_Handle *atc;
324 LOG (GNUNET_ERROR_TYPE_DEBUG, "ATS init\n");
326 atc = GNUNET_malloc (sizeof (struct GNUNET_ATS_Handle));
328 atc->alloc_cb = alloc_cb;
329 atc->alloc_cb_cls = alloc_cb_cls;
330 atc->peers = GNUNET_CONTAINER_multihashmap_create (256);
331 atc->notify_map = GNUNET_CONTAINER_multihashmap_create (256);
332 GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_OUT",
333 &atc->total_bps_out);
334 GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_IN",
341 * Free an allocation record.
344 * @param key identity of the peer associated with the record
345 * @param value the 'struct AllocationRecord' to free
346 * @return GNUNET_OK (continue to iterate)
349 destroy_allocation_record (void *cls, const GNUNET_HashCode * key, void *value)
351 struct AllocationRecord *ar = value;
353 GNUNET_array_grow (ar->ats, ar->ats_count, 0);
354 GNUNET_free (ar->plugin_name);
361 * Shutdown the ATS subsystem.
366 GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc)
369 LOG (GNUNET_ERROR_TYPE_DEBUG, "ATS shutdown\n");
371 if (GNUNET_SCHEDULER_NO_TASK != atc->ba_task)
373 GNUNET_SCHEDULER_cancel (atc->ba_task);
374 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
376 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_allocation_record,
378 GNUNET_CONTAINER_multihashmap_destroy (atc->peers);
379 GNUNET_assert (GNUNET_CONTAINER_multihashmap_size (atc->notify_map) == 0);
380 GNUNET_CONTAINER_multihashmap_destroy (atc->notify_map);
381 atc->notify_map = NULL;
387 * Closure for 'update_session'
389 struct UpdateSessionContext
394 struct GNUNET_ATS_Handle *atc;
397 * Allocation record with new information.
399 struct AllocationRecord *arnew;
404 * Update an allocation record, merging with the new information
406 * @param cls a new 'struct AllocationRecord'
407 * @param key identity of the peer associated with the records
408 * @param value the old 'struct AllocationRecord'
409 * @return GNUNET_YES if the records do not match,
410 * GNUNET_NO if the record do match and 'old' was updated
413 update_session (void *cls, const GNUNET_HashCode * key, void *value)
415 struct UpdateSessionContext *usc = cls;
416 struct AllocationRecord *arnew = usc->arnew;
417 struct AllocationRecord *arold = value;
425 LOG (GNUNET_ERROR_TYPE_DEBUG,
426 "Updating session for peer `%s' plugin `%s'\n", GNUNET_h2s (key),
430 if (0 != strcmp (arnew->plugin_name, arold->plugin_name))
432 if (((arnew->session == arold->session) && (arnew->session != NULL)) ||
433 ((arold->session == NULL) &&
434 (arold->plugin_addr_len == arnew->plugin_addr_len) &&
436 memcmp (arold->plugin_addr, arnew->plugin_addr,
437 arnew->plugin_addr_len))))
441 if (arnew->session != arold->session)
443 arold->session = arnew->session;
446 if ((arnew->connected == GNUNET_YES) && (arold->connected == GNUNET_NO))
448 arold->connected = GNUNET_YES;
452 /* Update existing value */
454 while (c_new < arnew->ats_count)
458 while (c_old < arold->ats_count)
460 if (arold->ats[c_old].type == arnew->ats[c_new].type)
463 LOG (GNUNET_ERROR_TYPE_DEBUG,
464 "Found type %i, old value=%i new value=%i\n",
465 ntohl (arold->ats[c_old].type), ntohl (arold->ats[c_old].value),
466 ntohl (arnew->ats[c_new].value));
468 arold->ats[c_old].value = arnew->ats[c_new].value;
474 if (found == GNUNET_NO)
477 LOG (GNUNET_ERROR_TYPE_DEBUG, "Added new type %i new value=%i\n",
478 ntohl (arnew->ats[c_new].type), ntohl (arnew->ats[c_new].value));
479 LOG (GNUNET_ERROR_TYPE_DEBUG, "Old array size: %u\n", arold->ats_count);
481 GNUNET_array_grow (arold->ats, arold->ats_count, arold->ats_count + 1);
482 GNUNET_assert (arold->ats_count >= 2);
483 arold->ats[arold->ats_count - 2].type = arnew->ats[c_new].type;
484 arold->ats[arold->ats_count - 2].value = arnew->ats[c_new].value;
485 arold->ats[arold->ats_count - 1].type = htonl (0);
486 arold->ats[arold->ats_count - 1].value = htonl (0);
488 LOG (GNUNET_ERROR_TYPE_DEBUG, "New array size: %i\n", arold->ats_count);
494 if (GNUNET_YES == change)
495 update_bandwidth_assignment (usc->atc, arold);
503 * Create an allocation record with the given properties.
505 * @param plugin_name name of the currently used transport plugin
506 * @param session session in use (if available)
507 * @param plugin_addr address in use (if available)
508 * @param plugin_addr_len number of bytes in plugin_addr
509 * @param ats performance data for the connection
510 * @param ats_count number of performance records in 'ats'
512 static struct AllocationRecord *
513 create_allocation_record (const char *plugin_name, struct Session *session,
514 const void *plugin_addr, size_t plugin_addr_len,
515 const struct GNUNET_TRANSPORT_ATS_Information *ats,
518 struct AllocationRecord *ar;
520 ar = GNUNET_malloc (sizeof (struct AllocationRecord) + plugin_addr_len);
521 ar->plugin_name = GNUNET_strdup (plugin_name);
522 ar->plugin_addr = &ar[1];
523 memcpy (&ar[1], plugin_addr, plugin_addr_len);
524 ar->session = session;
525 ar->plugin_addr_len = plugin_addr_len;
526 GNUNET_BANDWIDTH_tracker_init (&ar->available_recv_window, ar->bandwidth_in,
528 GNUNET_assert (ats_count > 0);
529 GNUNET_array_grow (ar->ats, ar->ats_count, ats_count);
530 memcpy (ar->ats, ats,
531 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
537 * Mark all matching allocation records as not connected.
539 * @param cls 'struct GTS_AtsHandle'
540 * @param key identity of the peer associated with the record
541 * @param value the 'struct AllocationRecord' to clear the 'connected' flag
542 * @return GNUNET_OK (continue to iterate)
545 disconnect_peer (void *cls, const GNUNET_HashCode * key, void *value)
547 struct GNUNET_ATS_Handle *atc = cls;
548 struct AllocationRecord *ar = value;
550 if (GNUNET_YES == ar->connected)
552 ar->connected = GNUNET_NO;
553 update_bandwidth_assignment (atc, ar);
560 * We established a new connection with a peer (for example, because
561 * core asked for it or because the other peer connected to us).
562 * Calculate bandwidth assignments including the new peer.
565 * @param peer identity of the new peer
566 * @param plugin_name name of the currently used transport plugin
567 * @param session session in use (if available)
568 * @param plugin_addr address in use (if available)
569 * @param plugin_addr_len number of bytes in plugin_addr
570 * @param ats performance data for the connection
571 * @param ats_count number of performance records in 'ats'
574 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
575 const struct GNUNET_PeerIdentity *peer,
576 const char *plugin_name, struct Session *session,
577 const void *plugin_addr, size_t plugin_addr_len,
578 const struct GNUNET_TRANSPORT_ATS_Information *ats,
581 struct AllocationRecord *ar;
582 struct UpdateSessionContext usc;
584 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &disconnect_peer,
586 ar = create_allocation_record (plugin_name, session, plugin_addr,
587 plugin_addr_len, ats, ats_count);
588 ar->connected = GNUNET_YES;
592 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
594 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
597 GNUNET_assert (GNUNET_OK ==
598 GNUNET_CONTAINER_multihashmap_put (atc->peers,
599 &peer->hashPubKey, ar,
600 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
605 * We disconnected from the given peer (for example, because ats, core
606 * or blacklist asked for it or because the other peer disconnected).
607 * Calculate bandwidth assignments without the peer.
610 * @param peer identity of the new peer
613 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
614 const struct GNUNET_PeerIdentity *peer)
616 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
618 &disconnect_peer, atc);
623 * Closure for 'destroy_allocation_record'
625 struct SessionDestroyContext
630 struct GNUNET_ATS_Handle *atc;
633 * Session being destroyed.
635 const struct Session *session;
640 * Free an allocation record matching the given session.
642 * @param cls the 'struct SessionDestroyContext'
643 * @param key identity of the peer associated with the record
644 * @param value the 'struct AllocationRecord' to free
645 * @return GNUNET_OK (continue to iterate)
648 destroy_session (void *cls, const GNUNET_HashCode * key, void *value)
650 struct SessionDestroyContext *sdc = cls;
651 struct AllocationRecord *ar = value;
653 if (ar->session != sdc->session)
656 if (ar->plugin_addr != NULL)
658 GNUNET_assert (GNUNET_OK ==
659 GNUNET_CONTAINER_multihashmap_remove (sdc->atc->peers, key,
661 if (GNUNET_YES == ar->connected) ;
663 /* FIXME: is this supposed to be allowed? What to do then? */
666 destroy_allocation_record (NULL, key, ar);
672 * A session got destroyed, stop including it as a valid address.
675 * @param peer identity of the peer
676 * @param session session handle that is no longer valid
679 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
680 const struct GNUNET_PeerIdentity *peer,
681 const struct Session *session)
683 struct SessionDestroyContext sdc;
686 sdc.session = session;
687 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_session,
693 * Notify validation watcher that an entry is now valid
695 * @param cls 'struct ValidationEntry' that is now valid
696 * @param key peer identity (unused)
697 * @param value a 'GST_ValidationIteratorContext' to notify
698 * @return GNUNET_YES (continue to iterate)
701 notify_valid (void *cls, const GNUNET_HashCode * key, void *value)
703 struct AllocationRecord *ar = cls;
704 struct GNUNET_ATS_SuggestionContext *asc = value;
706 asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
707 ar->plugin_addr_len, ar->session,
708 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_out / 32),
709 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps_in / 32), ar->ats,
711 GNUNET_ATS_suggest_address_cancel (asc);
718 * We have updated performance statistics for a given address. Note
719 * that this function can be called for addresses that are currently
720 * in use as well as addresses that are valid but not actively in use.
721 * Furthermore, the peer may not even be connected to us right now (in
722 * which case the call may be ignored or the information may be stored
723 * for later use). Update bandwidth assignments.
726 * @param peer identity of the peer
727 * @param valid_until how long is the address valid?
728 * @param plugin_name name of the transport plugin
729 * @param session session handle (if available)
730 * @param plugin_addr address (if available)
731 * @param plugin_addr_len number of bytes in plugin_addr
732 * @param ats performance data for the address
733 * @param ats_count number of performance records in 'ats'
736 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
737 const struct GNUNET_PeerIdentity *peer,
738 struct GNUNET_TIME_Absolute valid_until,
739 const char *plugin_name, struct Session *session,
740 const void *plugin_addr, size_t plugin_addr_len,
741 const struct GNUNET_TRANSPORT_ATS_Information *ats,
744 struct AllocationRecord *ar;
745 struct UpdateSessionContext usc;
748 LOG (GNUNET_ERROR_TYPE_DEBUG,
749 "Updating address for peer `%s', plugin `%s'\n", GNUNET_i2s (peer),
752 ar = create_allocation_record (plugin_name, session, plugin_addr,
753 plugin_addr_len, ats, ats_count);
757 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
759 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
763 LOG (GNUNET_ERROR_TYPE_DEBUG,
764 "Adding new address for peer `%s', plugin `%s'\n", GNUNET_i2s (peer),
767 GNUNET_assert (GNUNET_OK ==
768 GNUNET_CONTAINER_multihashmap_put (atc->peers,
769 &peer->hashPubKey, ar,
770 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
771 GNUNET_CONTAINER_multihashmap_get_multiple (atc->notify_map,
772 &peer->hashPubKey, ¬ify_valid,
776 /* end of file gnunet-service-transport_ats.c */