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,
173 const GNUNET_HashCode *key,
176 unsigned int *ac = cls;
177 struct AllocationRecord *ar = value;
179 if (GNUNET_YES == ar->connected)
186 * Closure for 'set_bw_connections'.
188 struct SetBandwidthContext
193 struct GNUNET_ATS_Handle *atc;
196 * Bandwidth to assign.
198 struct GNUNET_BANDWIDTH_Value32NBO bw;
203 * Set bandwidth based on record.
205 * @param cls 'struct SetBandwidthContext'
206 * @param key identity of the peer associated with the records
207 * @param value a 'struct AllocationRecord'
208 * @return GNUNET_YES (continue iteration)
211 set_bw_connections (void *cls,
212 const GNUNET_HashCode *key,
215 struct SetBandwidthContext *sbc = cls;
216 struct AllocationRecord *ar = value;
218 if (GNUNET_YES == ar->connected)
220 ar->bandwidth = sbc->bw;
221 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
222 (const struct GNUNET_PeerIdentity*) key,
229 else if (ntohl(ar->bandwidth.value__) > 0)
231 ar->bandwidth = GNUNET_BANDWIDTH_value_init (0);
232 sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
233 (const struct GNUNET_PeerIdentity*) key,
245 * Task run to update bandwidth assignments.
247 * @param cls the 'struct GNUNET_ATS_Handle'
248 * @param tc scheduler context
251 update_bandwidth_task (void *cls,
252 const struct GNUNET_SCHEDULER_TaskContext *tc)
254 struct GNUNET_ATS_Handle *atc = cls;
256 struct SetBandwidthContext bwc;
258 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
259 /* FIXME: update calculations NICELY; what follows is a naive version */
260 GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
264 bwc.bw = GNUNET_BANDWIDTH_value_init (atc->total_bps / ac);
265 GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
272 * Calculate an updated bandwidth assignment and notify.
275 * @param change which allocation record changed?
278 update_bandwidth_assignment (struct GNUNET_ATS_Handle *atc,
279 struct AllocationRecord *change)
281 /* FIXME: based on the 'change', update the LP-problem... */
282 if (atc->ba_task == GNUNET_SCHEDULER_NO_TASK)
283 atc->ba_task = GNUNET_SCHEDULER_add_now (&update_bandwidth_task,
289 * Function called with feasbile addresses we might want to suggest.
291 * @param cls the 'struct GNUNET_ATS_SuggestionContext'
292 * @param key identity of the peer
293 * @param value a 'struct AllocationRecord' for the peer
294 * @return GNUNET_NO if we're done, GNUNET_YES if we did not suggest an address yet
297 suggest_address (void *cls,
298 const GNUNET_HashCode *key,
301 struct GNUNET_ATS_SuggestionContext *asc = cls;
302 struct AllocationRecord *ar = value;
304 /* trivial strategy: pick first available address... */
305 asc->cb (asc->cb_cls,
310 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps / 32),
311 ar->ats, ar->ats_count);
318 * We would like to establish a new connection with a peer.
319 * ATS should suggest a good address to begin with.
322 * @param peer identity of the new peer
323 * @param cb function to call with the address
324 * @param cb_cls closure for cb
326 struct GNUNET_ATS_SuggestionContext *
327 GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
328 const struct GNUNET_PeerIdentity *peer,
329 GNUNET_ATS_AddressSuggestionCallback cb,
332 struct GNUNET_ATS_SuggestionContext *asc;
334 asc = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestionContext));
336 asc->cb_cls = cb_cls;
339 GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
348 GNUNET_CONTAINER_multihashmap_put (atc->notify_map,
351 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
357 * Cancel suggestion request.
359 * @param asc handle of the request to cancel
362 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc)
364 GNUNET_assert (GNUNET_OK ==
365 GNUNET_CONTAINER_multihashmap_remove (asc->atc->notify_map,
366 &asc->target.hashPubKey,
373 * Initialize the ATS subsystem.
375 * @param cfg configuration to use
376 * @param alloc_cb notification to call whenever the allocation changed
377 * @param alloc_cb_cls closure for 'alloc_cb'
378 * @return ats context
380 struct GNUNET_ATS_Handle *
381 GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
382 GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
385 struct GNUNET_ATS_Handle *atc;
387 atc = GNUNET_malloc (sizeof (struct GNUNET_ATS_Handle));
389 atc->alloc_cb = alloc_cb;
390 atc->alloc_cb_cls = alloc_cb_cls;
391 atc->peers = GNUNET_CONTAINER_multihashmap_create (256);
392 GNUNET_CONFIGURATION_get_value_number (cfg,
401 * Free an allocation record.
404 * @param key identity of the peer associated with the record
405 * @param value the 'struct AllocationRecord' to free
406 * @return GNUNET_OK (continue to iterate)
409 destroy_allocation_record (void *cls,
410 const GNUNET_HashCode *key,
413 struct AllocationRecord *ar = value;
415 GNUNET_array_grow (ar->ats, ar->ats_count, 0);
416 GNUNET_free (ar->plugin_name);
423 * Shutdown the ATS subsystem.
428 GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc)
430 if (GNUNET_SCHEDULER_NO_TASK != atc->ba_task)
432 GNUNET_SCHEDULER_cancel (atc->ba_task);
433 atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
435 GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
436 &destroy_allocation_record,
438 GNUNET_CONTAINER_multihashmap_destroy (atc->peers);
439 GNUNET_assert (GNUNET_CONTAINER_multihashmap_size (atc->notify_map) == 0);
440 GNUNET_CONTAINER_multihashmap_destroy (atc->notify_map);
441 atc->notify_map = NULL;
447 * Closure for 'update_session'
449 struct UpdateSessionContext
454 struct GNUNET_ATS_Handle *atc;
457 * Allocation record with new information.
459 struct AllocationRecord *arnew;
464 * Update an allocation record, merging with the new information
466 * @param cls a new 'struct AllocationRecord'
467 * @param key identity of the peer associated with the records
468 * @param value the old 'struct AllocationRecord'
469 * @return GNUNET_YES if the records do not match,
470 * GNUNET_NO if the record do match and 'old' was updated
473 update_session (void *cls,
474 const GNUNET_HashCode *key,
477 struct UpdateSessionContext *usc = cls;
478 struct AllocationRecord *arnew = usc->arnew;
479 struct AllocationRecord *arold = value;
482 if (0 != strcmp (arnew->plugin_name, arold->plugin_name))
484 if ( (arnew->session == arold->session) ||
485 ( (arold->session == NULL) &&
486 (arold->plugin_addr_len == arnew->plugin_addr_len) &&
487 (0 == memcmp (arold->plugin_addr,
489 arnew->plugin_addr_len)) ) )
493 if (arnew->session != arold->session)
495 arold->session = arnew->session;
498 if ( (arnew->connected == GNUNET_YES) &&
499 (arold->connected == GNUNET_NO) )
501 arold->connected = GNUNET_YES;
504 // FIXME: merge ats arrays of (arold, arnew);
506 if (GNUNET_YES == change)
507 update_bandwidth_assignment (usc->atc, arold);
515 * Create an allocation record with the given properties.
517 * @param plugin_name name of the currently used transport plugin
518 * @param session session in use (if available)
519 * @param plugin_addr address in use (if available)
520 * @param plugin_addr_len number of bytes in plugin_addr
521 * @param ats performance data for the connection
522 * @param ats_count number of performance records in 'ats'
524 static struct AllocationRecord *
525 create_allocation_record (const char *plugin_name,
526 struct Session *session,
527 const void *plugin_addr,
528 size_t plugin_addr_len,
529 const struct GNUNET_TRANSPORT_ATS_Information *ats,
532 struct AllocationRecord *ar;
534 ar = GNUNET_malloc (sizeof (struct AllocationRecord) + plugin_addr_len);
535 ar->plugin_name = GNUNET_strdup (plugin_name);
536 ar->plugin_addr = &ar[1];
537 memcpy (&ar[1], plugin_addr, plugin_addr_len);
538 ar->session = session;
539 ar->plugin_addr_len = plugin_addr_len;
540 GNUNET_array_grow (ar->ats,
545 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
551 * Mark all matching allocation records as not connected.
553 * @param cls 'struct GTS_AtsHandle'
554 * @param key identity of the peer associated with the record
555 * @param value the 'struct AllocationRecord' to clear the 'connected' flag
556 * @return GNUNET_OK (continue to iterate)
559 disconnect_peer (void *cls,
560 const GNUNET_HashCode *key,
563 struct GNUNET_ATS_Handle *atc = cls;
564 struct AllocationRecord *ar = value;
566 if (GNUNET_YES == ar->connected)
568 ar->connected = GNUNET_NO;
569 update_bandwidth_assignment (atc, ar);
576 * We established a new connection with a peer (for example, because
577 * core asked for it or because the other peer connected to us).
578 * Calculate bandwidth assignments including the new peer.
581 * @param peer identity of the new peer
582 * @param plugin_name name of the currently used transport plugin
583 * @param session session in use (if available)
584 * @param plugin_addr address in use (if available)
585 * @param plugin_addr_len number of bytes in plugin_addr
586 * @param ats performance data for the connection
587 * @param ats_count number of performance records in 'ats'
590 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
591 const struct GNUNET_PeerIdentity *peer,
592 const char *plugin_name,
593 struct Session *session,
594 const void *plugin_addr,
595 size_t plugin_addr_len,
596 const struct GNUNET_TRANSPORT_ATS_Information *ats,
599 struct AllocationRecord *ar;
600 struct UpdateSessionContext usc;
602 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
605 ar = create_allocation_record (plugin_name,
611 ar->connected = GNUNET_YES;
615 GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
619 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
622 GNUNET_assert (GNUNET_OK ==
623 GNUNET_CONTAINER_multihashmap_put (atc->peers,
626 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
631 * We disconnected from the given peer (for example, because ats, core
632 * or blacklist asked for it or because the other peer disconnected).
633 * Calculate bandwidth assignments without the peer.
636 * @param peer identity of the new peer
639 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
640 const struct GNUNET_PeerIdentity *peer)
642 (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
650 * Closure for 'destroy_allocation_record'
652 struct SessionDestroyContext
657 struct GNUNET_ATS_Handle *atc;
660 * Session being destroyed.
662 const struct Session *session;
667 * Free an allocation record matching the given session.
669 * @param cls the 'struct SessionDestroyContext'
670 * @param key identity of the peer associated with the record
671 * @param value the 'struct AllocationRecord' to free
672 * @return GNUNET_OK (continue to iterate)
675 destroy_session (void *cls,
676 const GNUNET_HashCode *key,
679 struct SessionDestroyContext *sdc = cls;
680 struct AllocationRecord *ar = value;
682 if (ar->session != sdc->session)
685 if (ar->plugin_addr != NULL)
687 GNUNET_assert (GNUNET_OK ==
688 GNUNET_CONTAINER_multihashmap_remove (sdc->atc->peers,
691 if (GNUNET_YES == ar->connected);
693 /* FIXME: is this supposed to be allowed? What to do then? */
696 destroy_allocation_record (NULL, key, ar);
702 * A session got destroyed, stop including it as a valid address.
705 * @param peer identity of the peer
706 * @param session session handle that is no longer valid
709 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
710 const struct GNUNET_PeerIdentity *peer,
711 const struct Session *session)
713 struct SessionDestroyContext sdc;
716 sdc.session = session;
717 (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
724 * Notify validation watcher that an entry is now valid
726 * @param cls 'struct ValidationEntry' that is now valid
727 * @param key peer identity (unused)
728 * @param value a 'GST_ValidationIteratorContext' to notify
729 * @return GNUNET_YES (continue to iterate)
732 notify_valid (void *cls,
733 const GNUNET_HashCode *key,
736 struct AllocationRecord *ar = cls;
737 struct GNUNET_ATS_SuggestionContext *asc = value;
739 asc->cb (asc->cb_cls,
744 GNUNET_BANDWIDTH_value_init (asc->atc->total_bps / 32),
745 ar->ats, ar->ats_count);
746 GNUNET_ATS_suggest_address_cancel (asc);
752 * We have updated performance statistics for a given address. Note
753 * that this function can be called for addresses that are currently
754 * in use as well as addresses that are valid but not actively in use.
755 * Furthermore, the peer may not even be connected to us right now (in
756 * which case the call may be ignored or the information may be stored
757 * for later use). Update bandwidth assignments.
760 * @param peer identity of the peer
761 * @param valid_until how long is the address valid?
762 * @param plugin_name name of the transport plugin
763 * @param session session handle (if available)
764 * @param plugin_addr address (if available)
765 * @param plugin_addr_len number of bytes in plugin_addr
766 * @param ats performance data for the address
767 * @param ats_count number of performance records in 'ats'
770 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
771 const struct GNUNET_PeerIdentity *peer,
772 struct GNUNET_TIME_Absolute valid_until,
773 const char *plugin_name,
774 struct Session *session,
775 const void *plugin_addr,
776 size_t plugin_addr_len,
777 const struct GNUNET_TRANSPORT_ATS_Information *ats,
780 struct AllocationRecord *ar;
781 struct UpdateSessionContext usc;
783 ar = create_allocation_record (plugin_name,
792 GNUNET_CONTAINER_multihashmap_iterate (atc->peers,
796 destroy_allocation_record (NULL, &peer->hashPubKey, ar);
799 GNUNET_assert (GNUNET_OK ==
800 GNUNET_CONTAINER_multihashmap_put (atc->peers,
803 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
804 GNUNET_CONTAINER_multihashmap_get_multiple (atc->notify_map,
810 /* end of file gnunet-service-transport_ats.c */