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.
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 #include "gnunet_ats_service.h"
30 #define DEBUG_ATS GNUNET_EXTRA_LOGGING
32 #define INTERFACE_PROCESSING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
35 * Message in linked list we should send to the ATS service. The
36 * actual binary message follows this struct.
44 struct PendingMessage *next;
49 struct PendingMessage *prev;
52 * Size of the message.
57 * Is this the 'ATS_START' message?
64 * Information we track per session.
69 * Identity of the peer (just needed for error checking).
71 struct GNUNET_PeerIdentity peer;
76 struct Session *session;
79 * Set to GNUNET_YES if the slot is used.
87 struct ATS_Network * next;
89 struct ATS_Network * prev;
91 struct sockaddr *network;
92 struct sockaddr *netmask;
99 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
101 struct GNUNET_ATS_SchedulingHandle
107 const struct GNUNET_CONFIGURATION_Handle *cfg;
110 * Callback to invoke on suggestions.
112 GNUNET_ATS_AddressSuggestionCallback suggest_cb;
115 * Closure for 'suggest_cb'.
117 void *suggest_cb_cls;
120 * Connection to ATS service.
122 struct GNUNET_CLIENT_Connection *client;
125 * Head of list of messages for the ATS service.
127 struct PendingMessage *pending_head;
130 * Tail of list of messages for the ATS service
132 struct PendingMessage *pending_tail;
135 * Current request for transmission to ATS.
137 struct GNUNET_CLIENT_TransmitHandle *th;
140 * Head of network list
142 struct ATS_Network * net_head;
145 * Tail of network list
147 struct ATS_Network * net_tail;
151 * Array of session objects (we need to translate them to numbers and back
152 * for the protocol; the offset in the array is the session number on the
153 * network). Index 0 is always NULL and reserved to represent the NULL pointer.
154 * Unused entries are also NULL.
156 struct SessionRecord *session_array;
159 * Task to trigger reconnect.
161 GNUNET_SCHEDULER_TaskIdentifier task;
164 * Task retrieving interfaces from the system
167 GNUNET_SCHEDULER_TaskIdentifier interface_task;
171 * Size of the session array.
173 unsigned int session_array_size;
176 * Should we reconnect to ATS due to some serious error?
183 * Re-establish the connection to the ATS service.
185 * @param sh handle to use to re-connect.
188 reconnect (struct GNUNET_ATS_SchedulingHandle *sh);
192 * Re-establish the connection to the ATS service.
194 * @param cls handle to use to re-connect.
195 * @param tc scheduler context
198 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
200 struct GNUNET_ATS_SchedulingHandle *sh = cls;
202 sh->task = GNUNET_SCHEDULER_NO_TASK;
208 * Disconnect from ATS and then reconnect.
210 * @param sh our handle
213 force_reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
215 sh->reconnect = GNUNET_NO;
216 GNUNET_CLIENT_disconnect (sh->client, GNUNET_NO);
219 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &reconnect_task,
225 * Transmit messages from the message queue to the service
226 * (if there are any, and if we are not already trying).
228 * @param sh handle to use
231 do_transmit (struct GNUNET_ATS_SchedulingHandle *sh);
235 * Type of a function to call when we receive a message
238 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
239 * @param msg message received, NULL on timeout or fatal error
242 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg);
246 * We can now transmit a message to ATS. Do it.
248 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
249 * @param size number of bytes we can transmit to ATS
250 * @param buf where to copy the messages
251 * @return number of bytes copied into buf
254 transmit_message_to_ats (void *cls, size_t size, void *buf)
256 struct GNUNET_ATS_SchedulingHandle *sh = cls;
257 struct PendingMessage *p;
262 if ((size == 0) || (buf == NULL))
264 force_reconnect (sh);
269 while ((NULL != (p = sh->pending_head)) && (p->size <= size))
271 memcpy (&cbuf[ret], &p[1], p->size);
274 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
275 if (GNUNET_YES == p->is_init)
276 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
277 GNUNET_TIME_UNIT_FOREVER_REL);
286 * Transmit messages from the message queue to the service
287 * (if there are any, and if we are not already trying).
289 * @param sh handle to use
292 do_transmit (struct GNUNET_ATS_SchedulingHandle *sh)
294 struct PendingMessage *p;
298 if (NULL == (p = sh->pending_head))
300 if (NULL == sh->client)
301 return; /* currently reconnecting */
303 GNUNET_CLIENT_notify_transmit_ready (sh->client, p->size,
304 GNUNET_TIME_UNIT_FOREVER_REL,
305 GNUNET_NO, &transmit_message_to_ats,
311 * Find the session object corresponding to the given session ID.
313 * @param sh our handle
314 * @param session_id current session ID
315 * @param peer peer the session belongs to
316 * @return the session object (or NULL)
318 static struct Session *
319 find_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
320 const struct GNUNET_PeerIdentity *peer)
323 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Find session %u from peer %s in %p\n",
324 (unsigned int) session_id, GNUNET_i2s (peer), sh);
326 if (session_id >= sh->session_array_size)
333 if (sh->session_array[session_id].session == NULL)
336 memcmp (peer, &sh->session_array[session_id].peer,
337 sizeof (struct GNUNET_PeerIdentity)));
342 memcmp (peer, &sh->session_array[session_id].peer,
343 sizeof (struct GNUNET_PeerIdentity)))
346 sh->reconnect = GNUNET_YES;
349 return sh->session_array[session_id].session;
354 * Get the ID for the given session object. If we do not have an ID for
355 * the given session object, allocate one.
357 * @param sh our handle
358 * @param session session object
359 * @param peer peer the session belongs to
360 * @return the session id
363 get_session_id (struct GNUNET_ATS_SchedulingHandle *sh, struct Session *session,
364 const struct GNUNET_PeerIdentity *peer)
370 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
371 "Get session ID for session %p from peer %s in %p\n", session,
372 GNUNET_i2s (peer), sh);
377 for (i = 1; i < sh->session_array_size; i++)
379 if (session == sh->session_array[i].session)
382 memcmp (peer, &sh->session_array[i].peer,
383 sizeof (struct GNUNET_PeerIdentity)));
386 if ((f == 0) && (sh->session_array[i].slot_used == GNUNET_NO))
391 f = sh->session_array_size;
392 GNUNET_array_grow (sh->session_array, sh->session_array_size,
393 sh->session_array_size * 2);
395 GNUNET_assert (f > 0);
396 sh->session_array[f].session = session;
397 sh->session_array[f].peer = *peer;
398 sh->session_array[f].slot_used = GNUNET_YES;
400 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
401 "Assigning session ID %u for session %p of peer %s in %p\n", f,
402 session, GNUNET_i2s (peer), sh);
409 * Remove the session of the given session ID from the session
410 * table (it is no longer valid).
412 * @param sh our handle
413 * @param session_id identifies session that is no longer valid
414 * @param peer peer the session belongs to
417 remove_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
418 const struct GNUNET_PeerIdentity *peer)
421 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
422 "Remove sessionID %u from peer %s in %p\n",
423 (unsigned int) session_id, GNUNET_i2s (peer), sh);
427 GNUNET_assert (session_id < sh->session_array_size);
428 GNUNET_assert (GNUNET_YES == sh->session_array[session_id].slot_used);
430 memcmp (peer, &sh->session_array[session_id].peer,
431 sizeof (struct GNUNET_PeerIdentity)));
432 sh->session_array[session_id].session = NULL;
437 * Release the session slot from the session table (ATS service is
438 * also done using it).
440 * @param sh our handle
441 * @param session_id identifies session that is no longer valid
442 * @param peer peer the session belongs to
445 release_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
446 const struct GNUNET_PeerIdentity *peer)
449 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
450 "Release sessionID %u from peer %s in %p\n",
451 (unsigned int) session_id, GNUNET_i2s (peer), sh);
453 if (session_id >= sh->session_array_size)
456 sh->reconnect = GNUNET_YES;
460 /* this slot should have been removed from remove_session before */
461 GNUNET_assert (sh->session_array[session_id].session == NULL);
464 memcmp (peer, &sh->session_array[session_id].peer,
465 sizeof (struct GNUNET_PeerIdentity)))
468 sh->reconnect = GNUNET_YES;
471 sh->session_array[session_id].slot_used = GNUNET_NO;
472 memset (&sh->session_array[session_id].peer, 0,
473 sizeof (struct GNUNET_PeerIdentity));
478 process_release_message (struct GNUNET_ATS_SchedulingHandle *sh,
479 const struct SessionReleaseMessage *srm)
481 release_session (sh, ntohl (srm->session_id), &srm->peer);
486 * Type of a function to call when we receive a message
489 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
490 * @param msg message received, NULL on timeout or fatal error
493 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
495 struct GNUNET_ATS_SchedulingHandle *sh = cls;
496 const struct AddressSuggestionMessage *m;
497 const struct GNUNET_ATS_Information *atsi;
498 const char *plugin_address;
499 const char *plugin_name;
500 uint16_t plugin_address_length;
501 uint16_t plugin_name_length;
503 struct GNUNET_HELLO_Address address;
508 force_reconnect (sh);
511 if ((ntohs (msg->type) == GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE) &&
512 (ntohs (msg->size) == sizeof (struct SessionReleaseMessage)))
514 process_release_message (sh, (const struct SessionReleaseMessage *) msg);
515 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
516 GNUNET_TIME_UNIT_FOREVER_REL);
517 if (GNUNET_YES == sh->reconnect)
518 force_reconnect (sh);
521 if ((ntohs (msg->type) != GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION) ||
522 (ntohs (msg->size) <= sizeof (struct AddressSuggestionMessage)))
525 force_reconnect (sh);
528 m = (const struct AddressSuggestionMessage *) msg;
529 ats_count = ntohl (m->ats_count);
530 plugin_address_length = ntohs (m->address_length);
531 atsi = (const struct GNUNET_ATS_Information *) &m[1];
532 plugin_address = (const char *) &atsi[ats_count];
533 plugin_name = &plugin_address[plugin_address_length];
534 plugin_name_length = ntohs (m->plugin_name_length);
535 if ((plugin_address_length + plugin_name_length +
536 ats_count * sizeof (struct GNUNET_ATS_Information) +
537 sizeof (struct AddressSuggestionMessage) != ntohs (msg->size)) ||
539 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
540 || (plugin_name[plugin_name_length - 1] != '\0'))
543 force_reconnect (sh);
546 uint32_t session_id = ntohl (m->session_id);
552 s = find_session (sh, session_id, &m->peer);
556 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
557 "ATS tries to use outdated session `%s'\n",
558 GNUNET_i2s (&m->peer));
560 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
561 GNUNET_TIME_UNIT_FOREVER_REL);
565 address.peer = m->peer;
566 address.address = plugin_address;
567 address.address_length = plugin_address_length;
568 address.transport_name = plugin_name;
570 if ((s == NULL) && (0 == address.address_length))
572 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
573 "ATS returned invalid address for peer `%s' transport `%s' address length %i, session_id %i\n",
574 GNUNET_i2s (&address.peer), address.transport_name,
575 plugin_address_length, session_id);
577 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
578 GNUNET_TIME_UNIT_FOREVER_REL);
582 sh->suggest_cb (sh->suggest_cb_cls, &address, s, m->bandwidth_out,
583 m->bandwidth_in, atsi, ats_count);
585 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
586 GNUNET_TIME_UNIT_FOREVER_REL);
587 if (GNUNET_YES == sh->reconnect)
588 force_reconnect (sh);
593 * Re-establish the connection to the ATS service.
595 * @param sh handle to use to re-connect.
598 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
600 struct PendingMessage *p;
601 struct ClientStartMessage *init;
603 GNUNET_assert (NULL == sh->client);
604 sh->client = GNUNET_CLIENT_connect ("ats", sh->cfg);
605 GNUNET_assert (NULL != sh->client);
606 if ((NULL == (p = sh->pending_head)) || (GNUNET_YES != p->is_init))
608 p = GNUNET_malloc (sizeof (struct PendingMessage) +
609 sizeof (struct ClientStartMessage));
610 p->size = sizeof (struct ClientStartMessage);
611 p->is_init = GNUNET_YES;
612 init = (struct ClientStartMessage *) &p[1];
613 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
614 init->header.size = htons (sizeof (struct ClientStartMessage));
615 init->start_flag = htonl (START_FLAG_SCHEDULING);
616 GNUNET_CONTAINER_DLL_insert (sh->pending_head, sh->pending_tail, p);
622 * delete the current network list
626 delete_networks (struct GNUNET_ATS_SchedulingHandle *sh)
628 struct ATS_Network * cur = sh->net_head;
631 GNUNET_CONTAINER_DLL_remove(sh->net_head, sh->net_tail, cur);
639 interface_proc (void *cls, const char *name,
641 const struct sockaddr *
643 const struct sockaddr *
645 const struct sockaddr *
646 netmask, socklen_t addrlen)
648 struct GNUNET_ATS_SchedulingHandle * sh = cls;
649 /* Calculate network */
650 struct ATS_Network *net = NULL;
652 /* Skipping IPv4 loopback addresses since we have special check */
653 if (addr->sa_family == AF_INET)
655 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
657 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
660 /* Skipping IPv6 loopback addresses since we have special check */
661 if (addr->sa_family == AF_INET6)
663 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
664 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
668 if (addr->sa_family == AF_INET)
670 struct sockaddr_in *addr4 = (struct sockaddr_in *) addr;
671 struct sockaddr_in *netmask4 = (struct sockaddr_in *) netmask;
672 struct sockaddr_in *tmp = NULL;
673 struct sockaddr_in network4;
675 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in));
676 tmp = (struct sockaddr_in *) &net[1];
677 net->network = (struct sockaddr *) &tmp[0];
678 net->netmask = (struct sockaddr *) &tmp[1];
679 net->length = addrlen;
681 memset (&network4, 0, sizeof (network4));
682 network4.sin_family = AF_INET;
683 #if HAVE_SOCKADDR_IN_SIN_LEN
684 network4.sin_len = sizeof (network4);
686 network4.sin_addr.s_addr = (addr4->sin_addr.s_addr & netmask4->sin_addr.s_addr);
688 memcpy (net->netmask, netmask4, sizeof (struct sockaddr_in));
689 memcpy (net->network, &network4, sizeof (struct sockaddr_in));
692 if (addr->sa_family == AF_INET6)
694 struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) addr;
695 struct sockaddr_in6 *netmask6 = (struct sockaddr_in6 *) netmask;
696 struct sockaddr_in6 * tmp = NULL;
697 struct sockaddr_in6 network6;
699 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in6));
700 tmp = (struct sockaddr_in6 *) &net[1];
701 net->network = (struct sockaddr *) &tmp[0];
702 net->netmask = (struct sockaddr *) &tmp[1];
703 net->length = addrlen;
705 memset (&network6, 0, sizeof (network6));
706 network6.sin6_family = AF_INET6;
707 #if HAVE_SOCKADDR_IN_SIN_LEN
708 network6.sin6_len = sizeof (network6);
711 uint32_t *addr_elem = (uint32_t *) &addr6->sin6_addr;
712 uint32_t *mask_elem = (uint32_t *) &netmask6->sin6_addr;
713 uint32_t *net_elem = (uint32_t *) &network6.sin6_addr;
714 for (c = 0; c < 4; c++)
715 net_elem[c] = addr_elem[c] & mask_elem[c];
717 memcpy (net->netmask, netmask6, sizeof (struct sockaddr_in6));
718 memcpy (net->network, &network6, sizeof (struct sockaddr_in6));
725 char * netmask = strdup (GNUNET_a2s((struct sockaddr *) net->netmask, addrlen));
726 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding network `%s', netmask `%s'\n",
727 GNUNET_a2s((struct sockaddr *) net->network, addrlen),
729 GNUNET_free (netmask);
731 GNUNET_CONTAINER_DLL_insert(sh->net_head, sh->net_tail, net);
739 * Periodically get list of addresses
741 * @param tc Task context
744 get_addresses (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
746 struct GNUNET_ATS_SchedulingHandle * sh = cls;
747 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
748 delete_networks (sh);
749 GNUNET_OS_network_interfaces_list(interface_proc, sh);
750 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
756 * Returns where the address is located: LAN or WAN or ...
757 * @param addr address
758 * @param addrlen address length
759 * @return location as GNUNET_ATS_Information
762 struct GNUNET_ATS_Information
763 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle * sh, const struct sockaddr * addr, socklen_t addrlen)
765 GNUNET_assert (sh != NULL);
766 struct GNUNET_ATS_Information ats;
767 struct ATS_Network * cur = sh->net_head;
768 int type = GNUNET_ATS_NET_UNSPECIFIED;
770 if (addr->sa_family == AF_UNIX)
772 type = GNUNET_ATS_NET_LOOPBACK;
775 /* IPv4 loopback check */
776 if (addr->sa_family == AF_INET)
778 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
780 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
781 type = GNUNET_ATS_NET_LOOPBACK;
783 /* IPv6 loopback check */
784 if (addr->sa_family == AF_INET6)
786 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
787 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
788 type = GNUNET_ATS_NET_LOOPBACK;
791 /* Check local networks */
792 while ((cur != NULL) && (type == GNUNET_ATS_NET_UNSPECIFIED))
794 if (addrlen != cur->length)
800 if (addr->sa_family == AF_INET)
802 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
803 struct sockaddr_in * net4 = (struct sockaddr_in *) cur->network;
804 struct sockaddr_in * mask4 = (struct sockaddr_in *) cur->netmask;
806 if (((a4->sin_addr.s_addr & mask4->sin_addr.s_addr)) == net4->sin_addr.s_addr)
808 char * net = strdup (GNUNET_a2s ((const struct sockaddr *) net4, addrlen));
809 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' is in network `%s'\n",
810 GNUNET_a2s ((const struct sockaddr *)a4, addrlen),
813 type = GNUNET_ATS_NET_LAN;
816 if (addr->sa_family == AF_INET6)
818 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
819 struct sockaddr_in6 * net6 = (struct sockaddr_in6 *) cur->network;
820 struct sockaddr_in6 * mask6 = (struct sockaddr_in6 *) cur->netmask;
822 int res = GNUNET_YES;
824 uint32_t *addr_elem = (uint32_t *) &a6->sin6_addr;
825 uint32_t *mask_elem = (uint32_t *) &mask6->sin6_addr;
826 uint32_t *net_elem = (uint32_t *) &net6->sin6_addr;
827 for (c = 0; c < 4; c++)
828 if ((addr_elem[c] & mask_elem[c]) != net_elem[c])
831 if (res == GNUNET_YES)
833 char * net = strdup (GNUNET_a2s ((const struct sockaddr *) net6, addrlen));
834 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' is in network `%s'\n",
835 GNUNET_a2s ((const struct sockaddr *) a6, addrlen),
838 type = GNUNET_ATS_NET_LAN;
844 /* no local network found for this address, default: WAN */
845 if (type == GNUNET_ATS_NET_UNSPECIFIED)
846 type = GNUNET_ATS_NET_WAN;
851 case GNUNET_ATS_NET_WAN:
854 case GNUNET_ATS_NET_LAN:
857 case GNUNET_ATS_NET_LOOPBACK:
864 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "`%s' is in network `%s'\n",
865 GNUNET_a2s ((const struct sockaddr *) addr, addrlen),
869 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
870 ats.value = htonl (type);
875 * Initialize the ATS subsystem.
877 * @param cfg configuration to use
878 * @param suggest_cb notification to call whenever the suggestation changed
879 * @param suggest_cb_cls closure for 'suggest_cb'
880 * @return ats context
882 struct GNUNET_ATS_SchedulingHandle *
883 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
884 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
885 void *suggest_cb_cls)
887 struct GNUNET_ATS_SchedulingHandle *sh;
889 sh = GNUNET_malloc (sizeof (struct GNUNET_ATS_SchedulingHandle));
891 sh->suggest_cb = suggest_cb;
892 sh->suggest_cb_cls = suggest_cb_cls;
893 GNUNET_array_grow (sh->session_array, sh->session_array_size, 4);
894 GNUNET_OS_network_interfaces_list(interface_proc, sh);
895 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
904 * Client is done with ATS scheduling, release resources.
906 * @param sh handle to release
909 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
911 struct PendingMessage *p;
913 while (NULL != (p = sh->pending_head))
915 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
918 if (NULL != sh->client)
920 GNUNET_CLIENT_disconnect (sh->client, GNUNET_NO);
923 if (GNUNET_SCHEDULER_NO_TASK != sh->task)
925 GNUNET_SCHEDULER_cancel (sh->task);
926 sh->task = GNUNET_SCHEDULER_NO_TASK;
929 delete_networks (sh);
930 if (sh->interface_task != GNUNET_SCHEDULER_NO_TASK)
932 GNUNET_SCHEDULER_cancel(sh->interface_task);
933 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
935 GNUNET_array_grow (sh->session_array, sh->session_array_size, 0);
942 * We would like to establish a new connection with a peer. ATS
943 * should suggest a good address to begin with.
946 * @param peer identity of the peer we need an address for
949 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
950 const struct GNUNET_PeerIdentity *peer)
952 struct PendingMessage *p;
953 struct RequestAddressMessage *m;
955 p = GNUNET_malloc (sizeof (struct PendingMessage) +
956 sizeof (struct RequestAddressMessage));
957 p->size = sizeof (struct RequestAddressMessage);
958 p->is_init = GNUNET_NO;
959 m = (struct RequestAddressMessage *) &p[1];
960 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
961 m->header.size = htons (sizeof (struct RequestAddressMessage));
962 m->reserved = htonl (0);
964 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
970 * We would like to stop receiving address updates for this peer
973 * @param peer identity of the peer
976 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
977 const struct GNUNET_PeerIdentity *peer)
979 struct PendingMessage *p;
980 struct RequestAddressMessage *m;
982 p = GNUNET_malloc (sizeof (struct PendingMessage) +
983 sizeof (struct RequestAddressMessage));
984 p->size = sizeof (struct RequestAddressMessage);
985 p->is_init = GNUNET_NO;
986 m = (struct RequestAddressMessage *) &p[1];
987 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
988 m->header.size = htons (sizeof (struct RequestAddressMessage));
989 m->reserved = htonl (0);
991 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
996 * We have updated performance statistics for a given address. Note
997 * that this function can be called for addresses that are currently
998 * in use as well as addresses that are valid but not actively in use.
999 * Furthermore, the peer may not even be connected to us right now (in
1000 * which case the call may be ignored or the information may be stored
1001 * for later use). Update bandwidth assignments.
1004 * @param address the address
1005 * @param session session handle (if available)
1006 * @param ats performance data for the address
1007 * @param ats_count number of performance records in 'ats'
1010 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
1011 const struct GNUNET_HELLO_Address *address,
1012 struct Session *session,
1013 const struct GNUNET_ATS_Information *ats,
1016 struct PendingMessage *p;
1017 struct AddressUpdateMessage *m;
1018 struct GNUNET_ATS_Information *am;
1023 if ((address == NULL) && (session == NULL))
1030 (address->transport_name ==
1031 NULL) ? 0 : strlen (address->transport_name) + 1;
1033 sizeof (struct AddressUpdateMessage) + address->address_length +
1034 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1035 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1036 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1037 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1039 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1045 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1047 p->is_init = GNUNET_NO;
1048 m = (struct AddressUpdateMessage *) &p[1];
1049 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
1050 m->header.size = htons (msize);
1051 m->ats_count = htonl (ats_count);
1052 m->peer = address->peer;
1053 m->address_length = htons (address->address_length);
1054 m->plugin_name_length = htons (namelen);
1055 m->session_id = htonl (get_session_id (sh, session, &address->peer));
1056 am = (struct GNUNET_ATS_Information *) &m[1];
1057 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1058 pm = (char *) &am[ats_count];
1059 memcpy (pm, address->address, address->address_length);
1060 memcpy (&pm[address->address_length], address->transport_name, namelen);
1061 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1067 * An address is now in use or not used any more.
1070 * @param address the address
1071 * @param session session handle
1072 * @param in_use GNUNET_YES if this address is now used, GNUNET_NO
1073 * if address is not used any more
1076 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
1077 const struct GNUNET_HELLO_Address *address,
1078 struct Session *session, int in_use)
1080 struct PendingMessage *p;
1081 struct AddressUseMessage *m;
1086 GNUNET_assert (NULL != address);
1088 (address->transport_name ==
1089 NULL) ? 0 : strlen (address->transport_name) + 1;
1090 msize = sizeof (struct AddressUseMessage) + address->address_length + namelen;
1091 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1092 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1093 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1099 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1101 p->is_init = GNUNET_NO;
1102 m = (struct AddressUseMessage *) &p[1];
1103 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_IN_USE);
1104 m->header.size = htons (msize);
1105 m->peer = address->peer;
1106 m->in_use = htons (in_use);
1107 m->address_length = htons (address->address_length);
1108 m->plugin_name_length = htons (namelen);
1109 m->session_id = htonl (get_session_id (sh, session, &address->peer));
1110 pm = (char *) &m[1];
1111 memcpy (pm, address->address, address->address_length);
1112 memcpy (&pm[address->address_length], address->transport_name, namelen);
1113 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1119 * A session got destroyed, stop including it as a valid address.
1122 * @param address the address
1123 * @param session session handle that is no longer valid
1126 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
1127 const struct GNUNET_HELLO_Address *address,
1128 struct Session *session)
1130 struct PendingMessage *p;
1131 struct AddressDestroyedMessage *m;
1135 uint32_t session_id;
1137 GNUNET_assert (address->transport_name != NULL);
1138 namelen = strlen (address->transport_name) + 1;
1139 GNUNET_assert (namelen > 1);
1141 sizeof (struct AddressDestroyedMessage) + address->address_length +
1143 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1144 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1145 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1151 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1153 p->is_init = GNUNET_NO;
1154 m = (struct AddressDestroyedMessage *) &p[1];
1155 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
1156 m->header.size = htons (msize);
1157 m->reserved = htonl (0);
1158 m->peer = address->peer;
1159 m->address_length = htons (address->address_length);
1160 m->plugin_name_length = htons (namelen);
1161 session_id = get_session_id (sh, session, &address->peer);
1162 m->session_id = htonl (session_id);
1163 pm = (char *) &m[1];
1164 memcpy (pm, address->address, address->address_length);
1165 memcpy (&pm[address->address_length], address->transport_name, namelen);
1166 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1168 remove_session (sh, session_id, &address->peer);
1171 /* end of ats_api_scheduling.c */