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"
36 // NOTE: this implementation is simply supposed
37 // to implement a simplistic strategy in-process;
38 // in the future, we plan to replace it with a real
39 // service implementation
42 * Allocation record for a peer's address.
44 struct AllocationRecord
48 * Performance information associated with this address (array).
50 struct GNUNET_TRANSPORT_ATS_Information *ats;
58 * Address this record represents, allocated at the end of this struct.
60 const void *plugin_addr;
63 * Session associated with this record.
65 struct Session *session;
68 * Number of bytes in plugin_addr.
70 size_t plugin_addr_len;
73 * Number of entries in 'ats'.
78 * Bandwidth assigned to this address right now, 0 for none.
80 struct GNUNET_BANDWIDTH_Value32NBO bandwidth;
83 * Set to GNUNET_YES if this is the connected address of a connected peer.
91 * Opaque handle to obtain address suggestions.
93 struct GNUNET_ATS_SuggestionContext
97 * Function to call with our final suggestion.
99 GNUNET_ATS_AddressSuggestionCallback cb;
109 struct GNUNET_ATS_Handle *atc;
112 * Which peer are we monitoring?
114 struct GNUNET_PeerIdentity target;
120 * Handle to the ATS subsystem.
122 struct GNUNET_ATS_Handle
127 const struct GNUNET_CONFIGURATION_Handle *cfg;
130 * Function to call when the allocation changes.
132 GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb;
135 * Closure for 'alloc_cb'.
140 * Information about all connected peers. Maps peer identities
141 * to one or more 'struct AllocationRecord' values.
143 struct GNUNET_CONTAINER_MultiHashMap *peers;
146 * Map of PeerIdentities to 'struct GNUNET_ATS_SuggestionContext's.
148 struct GNUNET_CONTAINER_MultiHashMap *notify_map;
152 * Task scheduled to update our bandwidth assignment.
154 GNUNET_SCHEDULER_TaskIdentifier ba_task;
157 * Total bandwidth per configuration.
159 unsigned long long total_bps;
164 * Count number of connected records.
166 * @param cls pointer to counter
167 * @param key identity of the peer associated with the records
168 * @param value a 'struct AllocationRecord'
169 * @return GNUNET_YES (continue iteration)
172 count_connections (void *cls, const GNUNET_HashCode * key, void *value)
174 unsigned int *ac = cls;
175 struct AllocationRecord *ar = value;
177 if (GNUNET_YES == ar->connected)
184 * Closure for 'set_bw_connections'.
186 struct SetBandwidthContext
191 struct GNUNET_ATS_Handle *atc;
194 * Bandwidth to assign.
196 struct GNUNET_BANDWIDTH_Value32NBO bw;
201 * Set bandwidth based on record.
203 * @param cls 'struct SetBandwidthContext'
204 * @param key identity of the peer associated with the records
205 * @param value a 'struct AllocationRecord'
206 * @return GNUNET_YES (continue iteration)
209 set_bw_connections (void *cls, const GNUNET_HashCode * key, void *value)
211 struct SetBandwidthContext *sbc = cls;
212 struct AllocationRecord *ar = value;
214 if (GNUNET_YES == ar->connected)
216 ar->bandwidth = sbc->bw;
217 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
218 (const struct GNUNET_PeerIdentity *) key,
221 ar->plugin_addr, ar->plugin_addr_len, ar->bandwidth);
223 else if (ntohl (ar->bandwidth.value__) > 0)
225 ar->bandwidth = GNUNET_BANDWIDTH_value_init (0);
226 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
227 (const struct GNUNET_PeerIdentity *) key,
230 ar->plugin_addr, ar->plugin_addr_len, ar->bandwidth);
237 * Task run to update bandwidth assignments.
239 * @param cls the 'struct GNUNET_ATS_Handle'
240 * @param tc scheduler context
243 update_bandwidth_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
245 struct GNUNET_ATS_Handle *atc = cls;
247 struct SetBandwidthContext bwc;
249 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
250 /* FIXME: update calculations NICELY; what follows is a naive version */
251 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &count_connections, &ac);
253 bwc.bw = GNUNET_BANDWIDTH_value_init (atc->total_bps / ac);
254 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &set_bw_connections, &bwc);
259 * Calculate an updated bandwidth assignment and notify.
262 * @param change which allocation record changed?
265 update_bandwidth_assignment (struct GNUNET_ATS_Handle *atc,
266 struct AllocationRecord *change)
268 /* FIXME: based on the 'change', update the LP-problem... */
269 if (atc->ba_task == GNUNET_SCHEDULER_NO_TASK)
270 atc->ba_task = GNUNET_SCHEDULER_add_now (&update_bandwidth_task, atc);
275 * Function called with feasbile addresses we might want to suggest.
277 * @param cls the 'struct GNUNET_ATS_SuggestionContext'
278 * @param key identity of the peer
279 * @param value a 'struct AllocationRecord' for the peer
280 * @return GNUNET_NO if we're done, GNUNET_YES if we did not suggest an address yet
283 suggest_address (void *cls, const GNUNET_HashCode * key, void *value)
285 struct GNUNET_ATS_SuggestionContext *asc = cls;
286 struct AllocationRecord *ar = value;
288 /* trivial strategy: pick first available address... */
289 asc->cb (asc->cb_cls,
294 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps / 32),
295 ar->ats, ar->ats_count);
302 * We would like to establish a new connection with a peer.
303 * ATS should suggest a good address to begin with.
306 * @param peer identity of the new peer
307 * @param cb function to call with the address
308 * @param cb_cls closure for cb
310 struct GNUNET_ATS_SuggestionContext *
311 GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
312 const struct GNUNET_PeerIdentity *peer,
313 GNUNET_ATS_AddressSuggestionCallback cb,
316 struct GNUNET_ATS_SuggestionContext *asc;
318 asc = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestionContext));
320 asc->cb_cls = cb_cls;
323 GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
325 &suggest_address, asc);
331 GNUNET_CONTAINER_multihashmap_put (atc->notify_map,
334 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
340 * Cancel suggestion request.
342 * @param asc handle of the request to cancel
345 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc)
347 GNUNET_assert (GNUNET_OK ==
348 GNUNET_CONTAINER_multihashmap_remove (asc->atc->notify_map,
349 &asc->target.hashPubKey,
356 * Initialize the ATS subsystem.
358 * @param cfg configuration to use
359 * @param alloc_cb notification to call whenever the allocation changed
360 * @param alloc_cb_cls closure for 'alloc_cb'
361 * @return ats context
363 struct GNUNET_ATS_Handle *
364 GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
365 GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
368 struct GNUNET_ATS_Handle *atc;
370 atc = GNUNET_malloc (sizeof (struct GNUNET_ATS_Handle));
372 atc->alloc_cb = alloc_cb;
373 atc->alloc_cb_cls = alloc_cb_cls;
374 atc->peers = GNUNET_CONTAINER_multihashmap_create (256);
375 GNUNET_CONFIGURATION_get_value_number (cfg,
377 "TOTAL_QUOTA_OUT", &atc->total_bps);
383 * Free an allocation record.
386 * @param key identity of the peer associated with the record
387 * @param value the 'struct AllocationRecord' to free
388 * @return GNUNET_OK (continue to iterate)
391 destroy_allocation_record (void *cls, const GNUNET_HashCode * key, void *value)
393 struct AllocationRecord *ar = value;
395 GNUNET_array_grow (ar->ats, ar->ats_count, 0);
396 GNUNET_free (ar->plugin_name);
403 * Shutdown the ATS subsystem.
408 GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc)
410 if (GNUNET_SCHEDULER_NO_TASK != atc->ba_task)
412 GNUNET_SCHEDULER_cancel (atc->ba_task);
413 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
415 GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
416 &destroy_allocation_record, NULL);
417 GNUNET_CONTAINER_multihashmap_destroy (atc->peers);
418 GNUNET_assert (GNUNET_CONTAINER_multihashmap_size (atc->notify_map) == 0);
419 GNUNET_CONTAINER_multihashmap_destroy (atc->notify_map);
420 atc->notify_map = NULL;
426 * Closure for 'update_session'
428 struct UpdateSessionContext
433 struct GNUNET_ATS_Handle *atc;
436 * Allocation record with new information.
438 struct AllocationRecord *arnew;
443 * Update an allocation record, merging with the new information
445 * @param cls a new 'struct AllocationRecord'
446 * @param key identity of the peer associated with the records
447 * @param value the old 'struct AllocationRecord'
448 * @return GNUNET_YES if the records do not match,
449 * GNUNET_NO if the record do match and 'old' was updated
452 update_session (void *cls, const GNUNET_HashCode * key, void *value)
454 struct UpdateSessionContext *usc = cls;
455 struct AllocationRecord *arnew = usc->arnew;
456 struct AllocationRecord *arold = value;
459 if (0 != strcmp (arnew->plugin_name, arold->plugin_name))
461 if ((arnew->session == arold->session) ||
462 ((arold->session == NULL) &&
463 (arold->plugin_addr_len == arnew->plugin_addr_len) &&
464 (0 == memcmp (arold->plugin_addr,
465 arnew->plugin_addr, arnew->plugin_addr_len))))
469 if (arnew->session != arold->session)
471 arold->session = arnew->session;
474 if ((arnew->connected == GNUNET_YES) && (arold->connected == GNUNET_NO))
476 arold->connected = GNUNET_YES;
479 // FIXME: merge ats arrays of (arold, arnew);
481 if (GNUNET_YES == change)
482 update_bandwidth_assignment (usc->atc, arold);
490 * Create an allocation record with the given properties.
492 * @param plugin_name name of the currently used transport plugin
493 * @param session session in use (if available)
494 * @param plugin_addr address in use (if available)
495 * @param plugin_addr_len number of bytes in plugin_addr
496 * @param ats performance data for the connection
497 * @param ats_count number of performance records in 'ats'
499 static struct AllocationRecord *
500 create_allocation_record (const char *plugin_name,
501 struct Session *session,
502 const void *plugin_addr,
503 size_t plugin_addr_len,
504 const struct GNUNET_TRANSPORT_ATS_Information *ats,
507 struct AllocationRecord *ar;
509 ar = GNUNET_malloc (sizeof (struct AllocationRecord) + plugin_addr_len);
510 ar->plugin_name = GNUNET_strdup (plugin_name);
511 ar->plugin_addr = &ar[1];
512 memcpy (&ar[1], plugin_addr, plugin_addr_len);
513 ar->session = session;
514 ar->plugin_addr_len = plugin_addr_len;
515 GNUNET_array_grow (ar->ats, ar->ats_count, ats_count);
517 ats, ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
523 * Mark all matching allocation records as not connected.
525 * @param cls 'struct GTS_AtsHandle'
526 * @param key identity of the peer associated with the record
527 * @param value the 'struct AllocationRecord' to clear the 'connected' flag
528 * @return GNUNET_OK (continue to iterate)
531 disconnect_peer (void *cls, const GNUNET_HashCode * key, void *value)
533 struct GNUNET_ATS_Handle *atc = cls;
534 struct AllocationRecord *ar = value;
536 if (GNUNET_YES == ar->connected)
538 ar->connected = GNUNET_NO;
539 update_bandwidth_assignment (atc, ar);
546 * We established a new connection with a peer (for example, because
547 * core asked for it or because the other peer connected to us).
548 * Calculate bandwidth assignments including the new peer.
551 * @param peer identity of the new peer
552 * @param plugin_name name of the currently used transport plugin
553 * @param session session in use (if available)
554 * @param plugin_addr address in use (if available)
555 * @param plugin_addr_len number of bytes in plugin_addr
556 * @param ats performance data for the connection
557 * @param ats_count number of performance records in 'ats'
560 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
561 const struct GNUNET_PeerIdentity *peer,
562 const char *plugin_name,
563 struct Session *session,
564 const void *plugin_addr,
565 size_t plugin_addr_len,
566 const struct GNUNET_TRANSPORT_ATS_Information *ats,
569 struct AllocationRecord *ar;
570 struct UpdateSessionContext usc;
572 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
573 &disconnect_peer, atc);
574 ar = create_allocation_record (plugin_name,
576 plugin_addr, plugin_addr_len, ats, ats_count);
577 ar->connected = GNUNET_YES;
581 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
583 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
586 GNUNET_assert (GNUNET_OK ==
587 GNUNET_CONTAINER_multihashmap_put (atc->peers,
590 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
595 * We disconnected from the given peer (for example, because ats, core
596 * or blacklist asked for it or because the other peer disconnected).
597 * Calculate bandwidth assignments without the peer.
600 * @param peer identity of the new peer
603 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
604 const struct GNUNET_PeerIdentity *peer)
606 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
608 &disconnect_peer, atc);
613 * Closure for 'destroy_allocation_record'
615 struct SessionDestroyContext
620 struct GNUNET_ATS_Handle *atc;
623 * Session being destroyed.
625 const struct Session *session;
630 * Free an allocation record matching the given session.
632 * @param cls the 'struct SessionDestroyContext'
633 * @param key identity of the peer associated with the record
634 * @param value the 'struct AllocationRecord' to free
635 * @return GNUNET_OK (continue to iterate)
638 destroy_session (void *cls, const GNUNET_HashCode * key, void *value)
640 struct SessionDestroyContext *sdc = cls;
641 struct AllocationRecord *ar = value;
643 if (ar->session != sdc->session)
646 if (ar->plugin_addr != NULL)
648 GNUNET_assert (GNUNET_OK ==
649 GNUNET_CONTAINER_multihashmap_remove (sdc->atc->peers,
651 if (GNUNET_YES == ar->connected) ;
653 /* FIXME: is this supposed to be allowed? What to do then? */
656 destroy_allocation_record (NULL, key, ar);
662 * A session got destroyed, stop including it as a valid address.
665 * @param peer identity of the peer
666 * @param session session handle that is no longer valid
669 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
670 const struct GNUNET_PeerIdentity *peer,
671 const struct Session *session)
673 struct SessionDestroyContext sdc;
676 sdc.session = session;
677 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
678 &destroy_session, &sdc);
683 * Notify validation watcher that an entry is now valid
685 * @param cls 'struct ValidationEntry' that is now valid
686 * @param key peer identity (unused)
687 * @param value a 'GST_ValidationIteratorContext' to notify
688 * @return GNUNET_YES (continue to iterate)
691 notify_valid (void *cls, const GNUNET_HashCode * key, void *value)
693 struct AllocationRecord *ar = cls;
694 struct GNUNET_ATS_SuggestionContext *asc = value;
696 asc->cb (asc->cb_cls,
701 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps / 32),
702 ar->ats, ar->ats_count);
703 GNUNET_ATS_suggest_address_cancel (asc);
709 * We have updated performance statistics for a given address. Note
710 * that this function can be called for addresses that are currently
711 * in use as well as addresses that are valid but not actively in use.
712 * Furthermore, the peer may not even be connected to us right now (in
713 * which case the call may be ignored or the information may be stored
714 * for later use). Update bandwidth assignments.
717 * @param peer identity of the peer
718 * @param valid_until how long is the address valid?
719 * @param plugin_name name of the transport plugin
720 * @param session session handle (if available)
721 * @param plugin_addr address (if available)
722 * @param plugin_addr_len number of bytes in plugin_addr
723 * @param ats performance data for the address
724 * @param ats_count number of performance records in 'ats'
727 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
728 const struct GNUNET_PeerIdentity *peer,
729 struct GNUNET_TIME_Absolute valid_until,
730 const char *plugin_name,
731 struct Session *session,
732 const void *plugin_addr,
733 size_t plugin_addr_len,
734 const struct GNUNET_TRANSPORT_ATS_Information *ats,
737 struct AllocationRecord *ar;
738 struct UpdateSessionContext usc;
740 ar = create_allocation_record (plugin_name,
742 plugin_addr, plugin_addr_len, ats, ats_count);
746 GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
748 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
751 GNUNET_assert (GNUNET_OK ==
752 GNUNET_CONTAINER_multihashmap_put (atc->peers,
755 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
756 GNUNET_CONTAINER_multihashmap_get_multiple (atc->notify_map,
761 /* end of file gnunet-service-transport_ats.c */