2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 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.
21 * @file ats/ats_api_scheduling.c
22 * @brief automatic transport selection and outbound bandwidth determination
23 * @author Christian Grothoff
24 * @author Matthias Wachs
27 * - we could avoid a linear scan over the
28 * active addresses in some cases, so if
29 * there is need, we can still optimize here
30 * - we might want to split off the logic to
31 * determine LAN vs. WAN, as it has nothing
32 * to do with accessing the ATS service.
35 #include "gnunet_ats_service.h"
39 * How frequently do we scan the interfaces for changes to the addresses?
41 #define INTERFACE_PROCESSING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
43 #define LOG(kind,...) GNUNET_log_from(kind, "ats-scheduling-api", __VA_ARGS__)
46 * Session ID we use if there is no session / slot.
52 * Information we track per address, incoming or outgoing. It also
53 * doesn't matter if we have a session, any address that ATS is
54 * allowed to suggest right now should be tracked.
56 struct GNUNET_ATS_AddressRecord
60 * Scheduling handle this address record belongs to.
62 struct GNUNET_ATS_SchedulingHandle *sh;
67 struct GNUNET_HELLO_Address *address;
70 * Session handle. NULL if we have an address but no
71 * active session for this address.
73 struct Session *session;
76 * Performance data about the address.
78 struct GNUNET_ATS_PropertiesNBO properties;
81 * Which slot (index) in the session array does
82 * this record correspond to? FIXME:
83 * FIXME: a linear search on this is really crappy!
84 * Maybe switch to a 64-bit global counter and be
85 * done with it? Or does that then cause too much
86 * trouble on the ATS-service side?
91 * We're about to destroy this address record, just ATS does
92 * not know this yet. Once ATS confirms its destruction,
100 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
102 struct GNUNET_ATS_SchedulingHandle
108 const struct GNUNET_CONFIGURATION_Handle *cfg;
111 * Callback to invoke on suggestions.
113 GNUNET_ATS_AddressSuggestionCallback suggest_cb;
116 * Closure for @e suggest_cb.
118 void *suggest_cb_cls;
121 * Connection to ATS service.
123 struct GNUNET_CLIENT_Connection *client;
126 * Message queue for sending requests to the ATS service.
128 struct GNUNET_MQ_Handle *mq;
131 * Array of session objects (we need to translate them to numbers and back
132 * for the protocol; the offset in the array is the session number on the
133 * network). Index 0 is always NULL and reserved to represent the NULL pointer.
134 * Unused entries are also NULL.
136 struct GNUNET_ATS_AddressRecord **session_array;
139 * Task to trigger reconnect.
141 struct GNUNET_SCHEDULER_Task *task;
144 * Reconnect backoff delay.
146 struct GNUNET_TIME_Relative backoff;
149 * Size of the @e session_array.
151 unsigned int session_array_size;
157 * Re-establish the connection to the ATS service.
159 * @param sh handle to use to re-connect.
162 reconnect (struct GNUNET_ATS_SchedulingHandle *sh);
166 * Re-establish the connection to the ATS service.
168 * @param cls handle to use to re-connect.
169 * @param tc scheduler context
172 reconnect_task (void *cls,
173 const struct GNUNET_SCHEDULER_TaskContext *tc)
175 struct GNUNET_ATS_SchedulingHandle *sh = cls;
183 * Disconnect from ATS and then reconnect.
185 * @param sh our handle
188 force_reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
192 GNUNET_MQ_destroy (sh->mq);
195 if (NULL != sh->client)
197 GNUNET_CLIENT_disconnect (sh->client);
200 sh->suggest_cb (sh->suggest_cb_cls,
202 GNUNET_BANDWIDTH_ZERO,
203 GNUNET_BANDWIDTH_ZERO);
204 sh->backoff = GNUNET_TIME_STD_BACKOFF (sh->backoff);
205 sh->task = GNUNET_SCHEDULER_add_delayed (sh->backoff,
212 * Find the session object corresponding to the given session ID.
214 * @param sh our handle
215 * @param session_id current session ID
216 * @param peer peer the session belongs to
217 * @return the session object (or NULL)
219 static struct GNUNET_ATS_AddressRecord *
220 find_session (struct GNUNET_ATS_SchedulingHandle *sh,
222 const struct GNUNET_PeerIdentity *peer)
224 struct GNUNET_ATS_AddressRecord *ar;
226 if (session_id >= sh->session_array_size)
233 ar = sh->session_array[session_id];
239 if (NULL == ar->address)
241 /* address was destroyed in the meantime, this can happen
242 as we communicate asynchronously with the ATS service. */
245 if (0 != memcmp (peer,
247 sizeof (struct GNUNET_PeerIdentity)))
250 force_reconnect (sh);
258 * Get an available session ID.
260 * @param sh our handle
261 * @return an unused slot, but never NOT_FOUND (0)
264 find_empty_session_slot (struct GNUNET_ATS_SchedulingHandle *sh)
270 while ( ( (NOT_FOUND == off) ||
271 (NULL != sh->session_array[off % sh->session_array_size]) ) &&
272 (i < sh->session_array_size) )
277 if ( (NOT_FOUND != off % sh->session_array_size) &&
278 (NULL == sh->session_array[off % sh->session_array_size]) )
280 i = sh->session_array_size;
281 GNUNET_array_grow (sh->session_array,
282 sh->session_array_size,
283 sh->session_array_size * 2);
289 * Get the ID for the given session object.
291 * @param sh our handle
292 * @param session session object
293 * @param address the address we are looking for
294 * @return the session id or NOT_FOUND for error
297 find_session_id (struct GNUNET_ATS_SchedulingHandle *sh,
298 struct Session *session,
299 const struct GNUNET_HELLO_Address *address)
308 for (i = 1; i < sh->session_array_size; i++)
309 if ( (NULL != sh->session_array[i]) &&
310 (GNUNET_NO == sh->session_array[i]->in_destroy) &&
311 ( (session == sh->session_array[i]->session) ||
312 (NULL == sh->session_array[i]->session) ) &&
313 (0 == memcmp (&address->peer,
314 &sh->session_array[i]->address->peer,
315 sizeof (struct GNUNET_PeerIdentity))) &&
316 (0 == GNUNET_HELLO_address_cmp (address,
317 sh->session_array[i]->address)) )
324 * Release the session slot from the session table (ATS service is
325 * also done using it).
327 * @param sh our handle
328 * @param session_id identifies session that is no longer valid
331 release_session (struct GNUNET_ATS_SchedulingHandle *sh,
334 struct GNUNET_ATS_AddressRecord *ar;
336 if (NOT_FOUND == session_id)
338 if (session_id >= sh->session_array_size)
341 force_reconnect (sh);
344 /* this slot should have been removed from remove_session before */
345 ar = sh->session_array[session_id];
346 if (NULL != ar->session)
349 force_reconnect (sh);
352 GNUNET_HELLO_address_free (ar->address);
354 sh->session_array[session_id] = NULL;
359 * Type of a function to call when we receive a session release
360 * message from the service.
362 * @param cls the `struct GNUNET_ATS_SchedulingHandle`
363 * @param msg message received, NULL on timeout or fatal error
366 process_ats_session_release_message (void *cls,
367 const struct GNUNET_MessageHeader *msg)
369 struct GNUNET_ATS_SchedulingHandle *sh = cls;
370 const struct SessionReleaseMessage *srm;
372 srm = (const struct SessionReleaseMessage *) msg;
373 /* Note: peer field in srm not necessary right now,
374 but might be good to have in the future */
376 ntohl (srm->session_id));
381 * Type of a function to call when we receive a address suggestion
382 * message from the service.
384 * @param cls the `struct GNUNET_ATS_SchedulingHandle`
385 * @param msg message received, NULL on timeout or fatal error
388 process_ats_address_suggestion_message (void *cls,
389 const struct GNUNET_MessageHeader *msg)
391 struct GNUNET_ATS_SchedulingHandle *sh = cls;
392 const struct AddressSuggestionMessage *m;
393 struct GNUNET_ATS_AddressRecord *ar;
396 m = (const struct AddressSuggestionMessage *) msg;
397 session_id = ntohl (m->session_id);
401 force_reconnect (sh);
404 ar = find_session (sh,
410 force_reconnect (sh);
413 if (NULL == sh->suggest_cb)
415 if (GNUNET_YES == ar->in_destroy)
417 /* ignore suggestion, as this address is dying, unless BW is 0,
418 in that case signal 'disconnect' via BW 0 */
419 if ( (0 == ntohl (m->bandwidth_out.value__)) &&
420 (0 == ntohl (m->bandwidth_in.value__)) )
422 LOG (GNUNET_ERROR_TYPE_DEBUG,
423 "ATS suggests disconnect from peer `%s' with BW %u/%u\n",
424 GNUNET_i2s (&ar->address->peer),
425 (unsigned int) ntohl (m->bandwidth_out.value__),
426 (unsigned int) ntohl (m->bandwidth_in.value__));
427 sh->suggest_cb (sh->suggest_cb_cls,
436 if ( (NULL == ar->session) &&
437 (GNUNET_HELLO_address_check_option (ar->address,
438 GNUNET_HELLO_ADDRESS_INFO_INBOUND)) )
443 sh->backoff = GNUNET_TIME_UNIT_ZERO;
444 LOG (GNUNET_ERROR_TYPE_DEBUG,
445 "ATS suggests address slot %u for peer `%s' using plugin %s\n",
447 GNUNET_i2s (&ar->address->peer),
448 ar->address->transport_name);
449 sh->suggest_cb (sh->suggest_cb_cls,
459 * We encountered an error handling the MQ to the
460 * ATS service. Reconnect.
462 * @param cls the `struct GNUNET_ATS_SchedulingHandle`
463 * @param error details about the error
466 error_handler (void *cls,
467 enum GNUNET_MQ_Error error)
469 struct GNUNET_ATS_SchedulingHandle *sh = cls;
471 LOG (GNUNET_ERROR_TYPE_ERROR,
472 "ATS connection died (code %d), reconnecting\n",
474 force_reconnect (sh);
479 * Generate and transmit the `struct AddressAddMessage` for the given
482 * @param sh the scheduling handle to use for transmission
483 * @param ar the address to inform the ATS service about
486 send_add_address_message (struct GNUNET_ATS_SchedulingHandle *sh,
487 const struct GNUNET_ATS_AddressRecord *ar)
489 struct GNUNET_MQ_Envelope *ev;
490 struct AddressAddMessage *m;
496 return; /* disconnected, skip for now */
497 namelen = strlen (ar->address->transport_name) + 1;
498 msize = ar->address->address_length + namelen;
499 ev = GNUNET_MQ_msg_extra (m, msize, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
500 m->peer = ar->address->peer;
501 m->address_length = htons (ar->address->address_length);
502 m->address_local_info = htonl ((uint32_t) ar->address->local_info);
503 m->plugin_name_length = htons (namelen);
504 m->session_id = htonl (ar->slot);
505 m->properties = ar->properties;
507 LOG (GNUNET_ERROR_TYPE_DEBUG,
508 "Adding address for peer `%s', plugin `%s', session %p slot %u\n",
509 GNUNET_i2s (&ar->address->peer),
510 ar->address->transport_name,
515 ar->address->address,
516 ar->address->address_length);
517 if (NULL != ar->address->transport_name)
518 memcpy (&pm[ar->address->address_length],
519 ar->address->transport_name,
521 GNUNET_MQ_send (sh->mq, ev);
526 * Re-establish the connection to the ATS service.
528 * @param sh handle to use to re-connect.
531 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
533 static const struct GNUNET_MQ_MessageHandler handlers[] =
534 { { &process_ats_session_release_message,
535 GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE,
536 sizeof (struct SessionReleaseMessage) },
537 { &process_ats_address_suggestion_message,
538 GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION,
539 sizeof (struct AddressSuggestionMessage) },
541 struct GNUNET_MQ_Envelope *ev;
542 struct ClientStartMessage *init;
544 struct GNUNET_ATS_AddressRecord *ar;
546 GNUNET_assert (NULL == sh->client);
547 sh->client = GNUNET_CLIENT_connect ("ats",
549 if (NULL == sh->client)
552 force_reconnect (sh);
555 sh->mq = GNUNET_MQ_queue_for_connection_client (sh->client,
559 ev = GNUNET_MQ_msg (init,
560 GNUNET_MESSAGE_TYPE_ATS_START);
561 init->start_flag = htonl (START_FLAG_SCHEDULING);
562 GNUNET_MQ_send (sh->mq, ev);
565 for (i=0;i<sh->session_array_size;i++)
567 ar = sh->session_array[i];
570 send_add_address_message (sh, ar);
578 * Initialize the ATS subsystem.
580 * @param cfg configuration to use
581 * @param suggest_cb notification to call whenever the suggestation changed
582 * @param suggest_cb_cls closure for @a suggest_cb
583 * @return ats context
585 struct GNUNET_ATS_SchedulingHandle *
586 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
587 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
588 void *suggest_cb_cls)
590 struct GNUNET_ATS_SchedulingHandle *sh;
592 sh = GNUNET_new (struct GNUNET_ATS_SchedulingHandle);
594 sh->suggest_cb = suggest_cb;
595 sh->suggest_cb_cls = suggest_cb_cls;
596 GNUNET_array_grow (sh->session_array,
597 sh->session_array_size,
605 * Client is done with ATS scheduling, release resources.
607 * @param sh handle to release
610 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
612 struct GNUNET_ATS_AddressRecord *ar;
617 GNUNET_MQ_destroy (sh->mq);
620 if (NULL != sh->client)
622 GNUNET_CLIENT_disconnect (sh->client);
625 if (NULL != sh->task)
627 GNUNET_SCHEDULER_cancel (sh->task);
630 for (i=0;i<sh->session_array_size;i++)
632 if (NULL != (ar = sh->session_array[i]))
634 GNUNET_HELLO_address_free (ar->address);
636 sh->session_array[i] = NULL;
639 GNUNET_array_grow (sh->session_array,
640 sh->session_array_size,
647 * We have a new address ATS should know. Addresses have to be added
648 * with this function before they can be: updated, set in use and
652 * @param address the address
653 * @param session session handle, can be NULL
654 * @param prop performance data for the address
655 * @return handle to the address representation inside ATS, NULL
656 * on error (i.e. ATS knows this exact address already)
658 struct GNUNET_ATS_AddressRecord *
659 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
660 const struct GNUNET_HELLO_Address *address,
661 struct Session *session,
662 const struct GNUNET_ATS_Properties *prop)
664 struct GNUNET_ATS_AddressRecord *ar;
671 /* we need a valid address */
675 namelen = strlen (address->transport_name) + 1;
676 msize = address->address_length + namelen;
677 if ((msize + sizeof (struct AddressUpdateMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
678 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
679 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) )
681 /* address too large for us, this should not happen */
691 /* Already existing, nothing todo, but this should not happen */
695 s = find_empty_session_slot (sh);
696 ar = GNUNET_new (struct GNUNET_ATS_AddressRecord);
699 ar->session = session;
700 ar->address = GNUNET_HELLO_address_copy (address);
701 GNUNET_ATS_properties_hton (&ar->properties,
703 sh->session_array[s] = ar;
704 send_add_address_message (sh, ar);
710 * An address was used to initiate a session.
712 * @param ar address record to update information for
713 * @param session session handle
716 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
717 struct Session *session)
719 GNUNET_break (NULL == ar->session);
720 ar->session = session;
725 * A session was destroyed, disassociate it from the
726 * given address record. If this was an incoming
727 * addess, destroy the address as well.
729 * @param ar address record to update information for
730 * @param session session handle
731 * @return #GNUNET_YES if the @a ar was destroyed because
732 * it was an incoming address,
733 * #GNUNET_NO if the @ar was kept because we can
734 * use it still to establish a new session
737 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
738 struct Session *session)
740 GNUNET_assert (session == ar->session);
742 if (GNUNET_HELLO_address_check_option (ar->address,
743 GNUNET_HELLO_ADDRESS_INFO_INBOUND))
745 GNUNET_ATS_address_destroy (ar);
753 * We have updated performance statistics for a given address. Note
754 * that this function can be called for addresses that are currently
755 * in use as well as addresses that are valid but not actively in use.
756 * Furthermore, the peer may not even be connected to us right now (in
757 * which case the call may be ignored or the information may be stored
758 * for later use). Update bandwidth assignments.
760 * @param ar address record to update information for
761 * @param prop performance data for the address
764 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
765 const struct GNUNET_ATS_Properties *prop)
767 struct GNUNET_ATS_SchedulingHandle *sh = ar->sh;
768 struct GNUNET_MQ_Envelope *ev;
769 struct AddressUpdateMessage *m;
771 LOG (GNUNET_ERROR_TYPE_DEBUG,
772 "Updating address for peer `%s', plugin `%s', session %p slot %u\n",
773 GNUNET_i2s (&ar->address->peer),
774 ar->address->transport_name,
777 GNUNET_ATS_properties_hton (&ar->properties,
780 return; /* disconnected, skip for now */
781 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
782 m->session_id = htonl (ar->slot);
783 m->peer = ar->address->peer;
784 m->properties = ar->properties;
785 GNUNET_MQ_send (sh->mq,
792 * An address got destroyed, stop using it as a valid address.
794 * @param ar address to destroy
797 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar)
799 struct GNUNET_ATS_SchedulingHandle *sh = ar->sh;
800 struct GNUNET_MQ_Envelope *ev;
801 struct AddressDestroyedMessage *m;
803 LOG (GNUNET_ERROR_TYPE_DEBUG,
804 "Deleting address for peer `%s', plugin `%s', slot %u session %p\n",
805 GNUNET_i2s (&ar->address->peer),
806 ar->address->transport_name,
809 GNUNET_break (NULL == ar->session);
811 ar->in_destroy = GNUNET_YES;
814 ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
815 m->session_id = htonl (ar->slot);
816 m->peer = ar->address->peer;
817 GNUNET_MQ_send (sh->mq, ev);
821 /* end of ats_api_scheduling.c */