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"
31 #define INTERFACE_PROCESSING_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
36 * Message in linked list we should send to the ATS service. The
37 * actual binary message follows this struct.
45 struct PendingMessage *next;
50 struct PendingMessage *prev;
53 * Size of the message.
58 * Is this the 'ATS_START' message?
65 * Information we track per session.
70 * Identity of the peer (just needed for error checking).
72 struct GNUNET_PeerIdentity peer;
77 struct Session *session;
80 * Set to GNUNET_YES if the slot is used.
88 struct ATS_Network * next;
90 struct ATS_Network * prev;
92 struct sockaddr *network;
93 struct sockaddr *netmask;
98 * Handle for address suggestions
100 struct GNUNET_ATS_SuggestHandle
102 struct GNUNET_ATS_SuggestHandle *prev;
103 struct GNUNET_ATS_SuggestHandle *next;
104 struct GNUNET_PeerIdentity id;
109 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
111 struct GNUNET_ATS_SchedulingHandle
117 const struct GNUNET_CONFIGURATION_Handle *cfg;
120 * Callback to invoke on suggestions.
122 GNUNET_ATS_AddressSuggestionCallback suggest_cb;
125 * Closure for 'suggest_cb'.
127 void *suggest_cb_cls;
130 * DLL for suggestions head
132 struct GNUNET_ATS_SuggestHandle *sug_head;
135 * DLL for suggestions tail
137 struct GNUNET_ATS_SuggestHandle *sug_tail;
140 * Connection to ATS service.
142 struct GNUNET_CLIENT_Connection *client;
145 * Head of list of messages for the ATS service.
147 struct PendingMessage *pending_head;
150 * Tail of list of messages for the ATS service
152 struct PendingMessage *pending_tail;
155 * Current request for transmission to ATS.
157 struct GNUNET_CLIENT_TransmitHandle *th;
160 * Head of network list
162 struct ATS_Network * net_head;
165 * Tail of network list
167 struct ATS_Network * net_tail;
170 * Array of session objects (we need to translate them to numbers and back
171 * for the protocol; the offset in the array is the session number on the
172 * network). Index 0 is always NULL and reserved to represent the NULL pointer.
173 * Unused entries are also NULL.
175 struct SessionRecord *session_array;
178 * Task to trigger reconnect.
180 GNUNET_SCHEDULER_TaskIdentifier task;
183 * Task retrieving interfaces from the system
185 GNUNET_SCHEDULER_TaskIdentifier interface_task;
189 * Size of the session array.
191 unsigned int session_array_size;
194 * Should we reconnect to ATS due to some serious error?
201 * Re-establish the connection to the ATS service.
203 * @param sh handle to use to re-connect.
206 reconnect (struct GNUNET_ATS_SchedulingHandle *sh);
210 * Re-establish the connection to the ATS service.
212 * @param cls handle to use to re-connect.
213 * @param tc scheduler context
216 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
218 struct GNUNET_ATS_SchedulingHandle *sh = cls;
220 sh->task = GNUNET_SCHEDULER_NO_TASK;
226 * Disconnect from ATS and then reconnect.
228 * @param sh our handle
231 force_reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
233 sh->reconnect = GNUNET_NO;
234 GNUNET_CLIENT_disconnect (sh->client);
237 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &reconnect_task,
243 * Transmit messages from the message queue to the service
244 * (if there are any, and if we are not already trying).
246 * @param sh handle to use
249 do_transmit (struct GNUNET_ATS_SchedulingHandle *sh);
253 * Type of a function to call when we receive a message
256 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
257 * @param msg message received, NULL on timeout or fatal error
260 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg);
264 * We can now transmit a message to ATS. Do it.
266 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
267 * @param size number of bytes we can transmit to ATS
268 * @param buf where to copy the messages
269 * @return number of bytes copied into buf
272 transmit_message_to_ats (void *cls, size_t size, void *buf)
274 struct GNUNET_ATS_SchedulingHandle *sh = cls;
275 struct PendingMessage *p;
280 if ((size == 0) || (buf == NULL))
282 force_reconnect (sh);
287 while ((NULL != (p = sh->pending_head)) && (p->size <= size))
289 memcpy (&cbuf[ret], &p[1], p->size);
292 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
301 * Transmit messages from the message queue to the service
302 * (if there are any, and if we are not already trying).
304 * @param sh handle to use
307 do_transmit (struct GNUNET_ATS_SchedulingHandle *sh)
309 struct PendingMessage *p;
313 if (NULL == (p = sh->pending_head))
315 if (NULL == sh->client)
316 return; /* currently reconnecting */
318 GNUNET_CLIENT_notify_transmit_ready (sh->client, p->size,
319 GNUNET_TIME_UNIT_FOREVER_REL,
320 GNUNET_NO, &transmit_message_to_ats,
326 * Find the session object corresponding to the given session ID.
328 * @param sh our handle
329 * @param session_id current session ID
330 * @param peer peer the session belongs to
331 * @return the session object (or NULL)
333 static struct Session *
334 find_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
335 const struct GNUNET_PeerIdentity *peer)
338 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
339 "Find session %u from peer %s in %p\n",
340 (unsigned int) session_id, GNUNET_i2s (peer), sh);
342 if (session_id >= sh->session_array_size)
349 if (sh->session_array[session_id].session == NULL)
352 memcmp (peer, &sh->session_array[session_id].peer,
353 sizeof (struct GNUNET_PeerIdentity)));
358 memcmp (peer, &sh->session_array[session_id].peer,
359 sizeof (struct GNUNET_PeerIdentity)))
362 sh->reconnect = GNUNET_YES;
365 /* This check exploits the fact that first field of a session object
369 memcmp (peer, sh->session_array[session_id].session,
370 sizeof (struct GNUNET_PeerIdentity)))
372 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
373 "Session %p belongs to peer `%s'\n",
374 sh->session_array[session_id].session, GNUNET_i2s_full ((struct GNUNET_PeerIdentity *) &sh->session_array[session_id].peer));
377 sh->reconnect = GNUNET_YES;
381 return sh->session_array[session_id].session;
386 * Get an available session ID for the given session object.
388 * @param sh our handle
389 * @param session session object
390 * @param peer peer the session belongs to
391 * @return the session id
394 find_empty_session_slot (struct GNUNET_ATS_SchedulingHandle *sh, struct Session *session,
395 const struct GNUNET_PeerIdentity *peer)
400 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
401 "Get session ID for session %p from peer %s in %p\n", session,
402 GNUNET_i2s (peer), sh);
407 for (i = 1; i < sh->session_array_size; i++)
409 if ((f == 0) && (sh->session_array[i].slot_used == GNUNET_NO))
414 f = sh->session_array_size;
415 GNUNET_array_grow (sh->session_array, sh->session_array_size,
416 sh->session_array_size * 2);
418 GNUNET_assert (f > 0);
419 sh->session_array[f].session = session;
420 sh->session_array[f].peer = *peer;
421 sh->session_array[f].slot_used = GNUNET_YES;
423 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
424 "Assigning session ID %u for session %p of peer %s in %p\n", f,
425 session, GNUNET_i2s (peer), sh);
432 * Get the ID for the given session object.
434 * @param sh our handle
435 * @param session session object
436 * @param peer peer the session belongs to
437 * @return the session id or NOT_FOUND for error
440 find_session_id (struct GNUNET_ATS_SchedulingHandle *sh, struct Session *session,
441 const struct GNUNET_PeerIdentity *peer)
446 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
447 "Get session ID for session %p from peer %s in %p\n", session,
448 GNUNET_i2s (peer), sh);
452 for (i = 1; i < sh->session_array_size; i++)
454 if (session == sh->session_array[i].session)
456 if (0 != memcmp (peer, &sh->session_array[i].peer,
457 sizeof (struct GNUNET_PeerIdentity)))
459 p2 = strdup (GNUNET_i2s (&sh->session_array[i].peer));
460 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "ats-scheduling-api",
461 "Session %p did not match: old session was for peer `%s' new session is for `%s'\n",
462 session, GNUNET_i2s (peer), p2);
474 * Remove the session of the given session ID from the session
475 * table (it is no longer valid).
477 * @param sh our handle
478 * @param session_id identifies session that is no longer valid
479 * @param peer peer the session belongs to
482 remove_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
483 const struct GNUNET_PeerIdentity *peer)
485 GNUNET_assert (peer != NULL);
486 GNUNET_assert (sh != NULL);
488 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
489 "Release sessionID %u from peer %s in %p\n",
490 (unsigned int) session_id, GNUNET_i2s (peer), sh);
495 GNUNET_assert (session_id < sh->session_array_size);
496 GNUNET_assert (GNUNET_YES == sh->session_array[session_id].slot_used);
497 GNUNET_assert (0 == memcmp (peer,
498 &sh->session_array[session_id].peer,
499 sizeof (struct GNUNET_PeerIdentity)));
500 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
501 "Session %p for peer `%s' removed from slot %u \n",
502 sh->session_array[session_id].session,
505 sh->session_array[session_id].session = NULL;
511 * Release the session slot from the session table (ATS service is
512 * also done using it).
514 * @param sh our handle
515 * @param session_id identifies session that is no longer valid
516 * @param peer peer the session belongs to
519 release_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
520 const struct GNUNET_PeerIdentity *peer)
523 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
524 "Release sessionID %u from peer %s in %p\n",
525 (unsigned int) session_id, GNUNET_i2s (peer), sh);
527 if (session_id >= sh->session_array_size)
530 sh->reconnect = GNUNET_YES;
534 /* this slot should have been removed from remove_session before */
535 GNUNET_assert (sh->session_array[session_id].session == NULL);
538 memcmp (peer, &sh->session_array[session_id].peer,
539 sizeof (struct GNUNET_PeerIdentity)))
542 sh->reconnect = GNUNET_YES;
545 sh->session_array[session_id].slot_used = GNUNET_NO;
546 memset (&sh->session_array[session_id].peer, 0,
547 sizeof (struct GNUNET_PeerIdentity));
552 process_release_message (struct GNUNET_ATS_SchedulingHandle *sh,
553 const struct SessionReleaseMessage *srm)
555 release_session (sh, ntohl (srm->session_id), &srm->peer);
560 * Type of a function to call when we receive a message
563 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
564 * @param msg message received, NULL on timeout or fatal error
567 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
569 struct GNUNET_ATS_SchedulingHandle *sh = cls;
570 const struct AddressSuggestionMessage *m;
571 const struct GNUNET_ATS_Information *atsi;
572 const char *plugin_address;
573 const char *plugin_name;
574 uint16_t plugin_address_length;
575 uint16_t plugin_name_length;
577 struct GNUNET_HELLO_Address address;
582 force_reconnect (sh);
585 if ((ntohs (msg->type) == GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE) &&
586 (ntohs (msg->size) == sizeof (struct SessionReleaseMessage)))
588 process_release_message (sh, (const struct SessionReleaseMessage *) msg);
589 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
590 GNUNET_TIME_UNIT_FOREVER_REL);
591 if (GNUNET_YES == sh->reconnect)
592 force_reconnect (sh);
595 if ((ntohs (msg->type) != GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION) ||
596 (ntohs (msg->size) <= sizeof (struct AddressSuggestionMessage)))
599 force_reconnect (sh);
602 m = (const struct AddressSuggestionMessage *) msg;
603 ats_count = ntohl (m->ats_count);
604 plugin_address_length = ntohs (m->address_length);
605 atsi = (const struct GNUNET_ATS_Information *) &m[1];
606 plugin_address = (const char *) &atsi[ats_count];
607 plugin_name = &plugin_address[plugin_address_length];
608 plugin_name_length = ntohs (m->plugin_name_length);
609 if ((plugin_address_length + plugin_name_length +
610 ats_count * sizeof (struct GNUNET_ATS_Information) +
611 sizeof (struct AddressSuggestionMessage) != ntohs (msg->size)) ||
613 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
614 || (plugin_name[plugin_name_length - 1] != '\0'))
617 force_reconnect (sh);
620 uint32_t session_id = ntohl (m->session_id);
626 s = find_session (sh, session_id, &m->peer);
630 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
631 "ATS tries to use outdated session `%s'\n",
632 GNUNET_i2s (&m->peer));
633 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
634 GNUNET_TIME_UNIT_FOREVER_REL);
639 if (NULL == sh->suggest_cb)
642 address.peer = m->peer;
643 address.address = plugin_address;
644 address.address_length = plugin_address_length;
645 address.transport_name = plugin_name;
647 if ((s == NULL) && (0 == address.address_length))
649 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
650 "ATS returned invalid address for peer `%s' transport `%s' address length %i, session_id %i\n",
651 GNUNET_i2s (&address.peer), address.transport_name,
652 plugin_address_length, session_id);
654 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
655 GNUNET_TIME_UNIT_FOREVER_REL);
659 sh->suggest_cb (sh->suggest_cb_cls, &address, s, m->bandwidth_out,
660 m->bandwidth_in, atsi, ats_count);
662 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
663 GNUNET_TIME_UNIT_FOREVER_REL);
664 if (GNUNET_YES == sh->reconnect)
665 force_reconnect (sh);
670 * Re-establish the connection to the ATS service.
672 * @param sh handle to use to re-connect.
675 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
677 struct PendingMessage *p;
678 struct ClientStartMessage *init;
680 GNUNET_assert (NULL == sh->client);
681 sh->client = GNUNET_CLIENT_connect ("ats", sh->cfg);
682 GNUNET_assert (NULL != sh->client);
683 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
684 GNUNET_TIME_UNIT_FOREVER_REL);
685 if ((NULL == (p = sh->pending_head)) || (GNUNET_YES != p->is_init))
687 p = GNUNET_malloc (sizeof (struct PendingMessage) +
688 sizeof (struct ClientStartMessage));
689 p->size = sizeof (struct ClientStartMessage);
690 p->is_init = GNUNET_YES;
691 init = (struct ClientStartMessage *) &p[1];
692 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
693 init->header.size = htons (sizeof (struct ClientStartMessage));
694 init->start_flag = htonl (START_FLAG_SCHEDULING);
695 GNUNET_CONTAINER_DLL_insert (sh->pending_head, sh->pending_tail, p);
702 * delete the current network list
705 delete_networks (struct GNUNET_ATS_SchedulingHandle *sh)
707 struct ATS_Network * cur = sh->net_head;
710 GNUNET_CONTAINER_DLL_remove(sh->net_head, sh->net_tail, cur);
718 interface_proc (void *cls, const char *name,
720 const struct sockaddr *
722 const struct sockaddr *
724 const struct sockaddr *
725 netmask, socklen_t addrlen)
727 struct GNUNET_ATS_SchedulingHandle * sh = cls;
728 /* Calculate network */
729 struct ATS_Network *net = NULL;
731 /* Skipping IPv4 loopback addresses since we have special check */
732 if (addr->sa_family == AF_INET)
734 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
736 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
739 /* Skipping IPv6 loopback addresses since we have special check */
740 if (addr->sa_family == AF_INET6)
742 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
743 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
747 if (addr->sa_family == AF_INET)
749 struct sockaddr_in *addr4 = (struct sockaddr_in *) addr;
750 struct sockaddr_in *netmask4 = (struct sockaddr_in *) netmask;
751 struct sockaddr_in *tmp = NULL;
752 struct sockaddr_in network4;
754 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in));
755 tmp = (struct sockaddr_in *) &net[1];
756 net->network = (struct sockaddr *) &tmp[0];
757 net->netmask = (struct sockaddr *) &tmp[1];
758 net->length = addrlen;
760 memset (&network4, 0, sizeof (network4));
761 network4.sin_family = AF_INET;
762 #if HAVE_SOCKADDR_IN_SIN_LEN
763 network4.sin_len = sizeof (network4);
765 network4.sin_addr.s_addr = (addr4->sin_addr.s_addr & netmask4->sin_addr.s_addr);
767 memcpy (net->netmask, netmask4, sizeof (struct sockaddr_in));
768 memcpy (net->network, &network4, sizeof (struct sockaddr_in));
771 if (addr->sa_family == AF_INET6)
773 struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) addr;
774 struct sockaddr_in6 *netmask6 = (struct sockaddr_in6 *) netmask;
775 struct sockaddr_in6 * tmp = NULL;
776 struct sockaddr_in6 network6;
778 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in6));
779 tmp = (struct sockaddr_in6 *) &net[1];
780 net->network = (struct sockaddr *) &tmp[0];
781 net->netmask = (struct sockaddr *) &tmp[1];
782 net->length = addrlen;
784 memset (&network6, 0, sizeof (network6));
785 network6.sin6_family = AF_INET6;
786 #if HAVE_SOCKADDR_IN_SIN_LEN
787 network6.sin6_len = sizeof (network6);
790 uint32_t *addr_elem = (uint32_t *) &addr6->sin6_addr;
791 uint32_t *mask_elem = (uint32_t *) &netmask6->sin6_addr;
792 uint32_t *net_elem = (uint32_t *) &network6.sin6_addr;
793 for (c = 0; c < 4; c++)
794 net_elem[c] = addr_elem[c] & mask_elem[c];
796 memcpy (net->netmask, netmask6, sizeof (struct sockaddr_in6));
797 memcpy (net->network, &network6, sizeof (struct sockaddr_in6));
804 char * netmask = GNUNET_strdup (GNUNET_a2s((struct sockaddr *) net->netmask, addrlen));
805 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding network `%s', netmask `%s'\n",
806 GNUNET_a2s((struct sockaddr *) net->network, addrlen),
808 GNUNET_free (netmask);
810 GNUNET_CONTAINER_DLL_insert(sh->net_head, sh->net_tail, net);
817 * Periodically get list of addresses
819 * @param tc Task context
822 get_addresses (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
824 struct GNUNET_ATS_SchedulingHandle * sh = cls;
825 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
826 delete_networks (sh);
827 GNUNET_OS_network_interfaces_list(interface_proc, sh);
828 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
834 * Convert a GNUNET_ATS_NetworkType to a string
836 * @param net the network type
837 * @return a string or NULL if invalid
840 GNUNET_ATS_print_network_type (uint32_t net)
842 char *networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
843 if (net < GNUNET_ATS_NetworkTypeCount)
844 return networks[net];
849 * Convert a ATS property to a string
851 * @param type the atsi type
852 * @return a string or NULL if invalid
855 GNUNET_ATS_print_property_type (uint32_t type)
857 char *props[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
858 if ((type > 0) && (type < GNUNET_ATS_PropertyCount))
865 * Returns where the address is located: LAN or WAN or ...
867 * @param sh the scheduling handle
868 * @param addr address
869 * @param addrlen address length
870 * @return location as GNUNET_ATS_Information
872 struct GNUNET_ATS_Information
873 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle * sh, const struct sockaddr * addr, socklen_t addrlen)
875 GNUNET_assert (sh != NULL);
876 struct ATS_Network * cur = sh->net_head;
878 int type = GNUNET_ATS_NET_UNSPECIFIED;
879 struct GNUNET_ATS_Information ats;
881 if (addr->sa_family == AF_UNIX)
883 type = GNUNET_ATS_NET_LOOPBACK;
886 /* IPv4 loopback check */
887 if (addr->sa_family == AF_INET)
889 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
891 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
892 type = GNUNET_ATS_NET_LOOPBACK;
894 /* IPv6 loopback check */
895 if (addr->sa_family == AF_INET6)
897 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
898 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
899 type = GNUNET_ATS_NET_LOOPBACK;
902 /* Check local networks */
903 while ((cur != NULL) && (type == GNUNET_ATS_NET_UNSPECIFIED))
905 if (addrlen != cur->length)
911 if (addr->sa_family == AF_INET)
913 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
914 struct sockaddr_in * net4 = (struct sockaddr_in *) cur->network;
915 struct sockaddr_in * mask4 = (struct sockaddr_in *) cur->netmask;
917 if (((a4->sin_addr.s_addr & mask4->sin_addr.s_addr)) == net4->sin_addr.s_addr)
918 type = GNUNET_ATS_NET_LAN;
920 if (addr->sa_family == AF_INET6)
922 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
923 struct sockaddr_in6 * net6 = (struct sockaddr_in6 *) cur->network;
924 struct sockaddr_in6 * mask6 = (struct sockaddr_in6 *) cur->netmask;
926 int res = GNUNET_YES;
928 uint32_t *addr_elem = (uint32_t *) &a6->sin6_addr;
929 uint32_t *mask_elem = (uint32_t *) &mask6->sin6_addr;
930 uint32_t *net_elem = (uint32_t *) &net6->sin6_addr;
931 for (c = 0; c < 4; c++)
932 if ((addr_elem[c] & mask_elem[c]) != net_elem[c])
935 if (res == GNUNET_YES)
936 type = GNUNET_ATS_NET_LAN;
941 /* no local network found for this address, default: WAN */
942 if (type == GNUNET_ATS_NET_UNSPECIFIED)
943 type = GNUNET_ATS_NET_WAN;
944 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
945 ats.value = htonl (type);
947 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
948 "`%s' is in network `%s'\n",
949 GNUNET_a2s ((const struct sockaddr *) addr, addrlen),
950 GNUNET_ATS_print_network_type(type));
956 * Initialize the ATS subsystem.
958 * @param cfg configuration to use
959 * @param suggest_cb notification to call whenever the suggestation changed
960 * @param suggest_cb_cls closure for 'suggest_cb'
961 * @return ats context
963 struct GNUNET_ATS_SchedulingHandle *
964 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
965 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
966 void *suggest_cb_cls)
968 struct GNUNET_ATS_SchedulingHandle *sh;
970 sh = GNUNET_malloc (sizeof (struct GNUNET_ATS_SchedulingHandle));
972 sh->suggest_cb = suggest_cb;
973 sh->suggest_cb_cls = suggest_cb_cls;
974 GNUNET_array_grow (sh->session_array, sh->session_array_size, 4);
975 GNUNET_OS_network_interfaces_list(interface_proc, sh);
976 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
985 * Client is done with ATS scheduling, release resources.
987 * @param sh handle to release
990 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
992 struct PendingMessage *p;
993 struct GNUNET_ATS_SuggestHandle *cur;
994 struct GNUNET_ATS_SuggestHandle *next;
995 while (NULL != (p = sh->pending_head))
997 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
1000 if (NULL != sh->client)
1002 GNUNET_CLIENT_disconnect (sh->client);
1005 if (GNUNET_SCHEDULER_NO_TASK != sh->task)
1007 GNUNET_SCHEDULER_cancel (sh->task);
1008 sh->task = GNUNET_SCHEDULER_NO_TASK;
1011 next = sh->sug_head;
1012 while (NULL != (cur = next))
1015 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, cur);
1019 delete_networks (sh);
1020 if (sh->interface_task != GNUNET_SCHEDULER_NO_TASK)
1022 GNUNET_SCHEDULER_cancel(sh->interface_task);
1023 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
1025 GNUNET_array_grow (sh->session_array, sh->session_array_size, 0);
1031 * We would like to reset the address suggestion block time for this
1035 * @param peer identity of the peer we want to reset
1038 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
1039 const struct GNUNET_PeerIdentity *peer)
1041 struct PendingMessage *p;
1042 struct ResetBackoffMessage *m;
1044 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1045 sizeof (struct ResetBackoffMessage));
1046 p->size = sizeof (struct ResetBackoffMessage);
1047 p->is_init = GNUNET_NO;
1048 m = (struct ResetBackoffMessage *) &p[1];
1049 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESET_BACKOFF);
1050 m->header.size = htons (sizeof (struct ResetBackoffMessage));
1051 m->reserved = htonl (0);
1053 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1058 * We would like to establish a new connection with a peer. ATS
1059 * should suggest a good address to begin with.
1062 * @param peer identity of the peer we need an address for
1063 * @return suggest handle
1065 struct GNUNET_ATS_SuggestHandle *
1066 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
1067 const struct GNUNET_PeerIdentity *peer)
1069 struct PendingMessage *p;
1070 struct RequestAddressMessage *m;
1071 struct GNUNET_ATS_SuggestHandle *s;
1073 // FIXME: ATS needs to remember this in case of
1075 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1076 sizeof (struct RequestAddressMessage));
1077 p->size = sizeof (struct RequestAddressMessage);
1078 p->is_init = GNUNET_NO;
1079 m = (struct RequestAddressMessage *) &p[1];
1080 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
1081 m->header.size = htons (sizeof (struct RequestAddressMessage));
1082 m->reserved = htonl (0);
1084 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1086 s = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestHandle));
1088 GNUNET_CONTAINER_DLL_insert_tail (sh->sug_head, sh->sug_tail, s);
1094 * We would like to stop receiving address updates for this peer
1097 * @param peer identity of the peer
1100 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
1101 const struct GNUNET_PeerIdentity *peer)
1103 struct PendingMessage *p;
1104 struct RequestAddressMessage *m;
1105 struct GNUNET_ATS_SuggestHandle *s;
1107 for (s = sh->sug_head; NULL != s; s = s->next)
1108 if (0 == memcmp(peer, &s->id, sizeof (s->id)))
1117 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, s);
1121 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1122 sizeof (struct RequestAddressMessage));
1123 p->size = sizeof (struct RequestAddressMessage);
1124 p->is_init = GNUNET_NO;
1125 m = (struct RequestAddressMessage *) &p[1];
1126 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
1127 m->header.size = htons (sizeof (struct RequestAddressMessage));
1128 m->reserved = htonl (0);
1130 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1136 * Test if a address and a session is known to ATS
1138 * @param sh the scheduling handle
1139 * @param address the address
1140 * @param session the session
1141 * @return GNUNET_YES or GNUNET_NO
1144 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
1145 const struct GNUNET_HELLO_Address *address,
1146 struct Session *session)
1149 if (NULL != session)
1151 if (NOT_FOUND != (s = find_session_id (sh, session, &address->peer)))
1162 * We have a new address ATS should know. Addresses have to be added with this
1163 * function before they can be: updated, set in use and destroyed
1166 * @param address the address
1167 * @param session session handle, can be NULL
1168 * @param ats performance data for the address
1169 * @param ats_count number of performance records in 'ats'
1170 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1173 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
1174 const struct GNUNET_HELLO_Address *address,
1175 struct Session *session,
1176 const struct GNUNET_ATS_Information *ats,
1180 struct PendingMessage *p;
1181 struct AddressUpdateMessage *m;
1182 struct GNUNET_ATS_Information *am;
1188 if (address == NULL)
1191 return GNUNET_SYSERR;
1195 (address->transport_name ==
1196 NULL) ? 0 : strlen (address->transport_name) + 1;
1198 sizeof (struct AddressUpdateMessage) + address->address_length +
1199 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1200 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1201 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1202 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1204 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1207 return GNUNET_SYSERR;
1210 if (NULL != session)
1212 if (NOT_FOUND != (s = find_session_id (sh, session, &address->peer)))
1214 /* Already existing, nothing todo */
1215 return GNUNET_SYSERR;
1217 s = find_empty_session_slot (sh, session, &address->peer);
1218 GNUNET_break (NOT_FOUND != s);
1221 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1223 p->is_init = GNUNET_NO;
1224 m = (struct AddressUpdateMessage *) &p[1];
1225 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
1226 m->header.size = htons (msize);
1227 m->ats_count = htonl (ats_count);
1228 m->peer = address->peer;
1229 m->address_length = htons (address->address_length);
1230 m->plugin_name_length = htons (namelen);
1231 m->session_id = htonl (s);
1233 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1234 "Adding address for peer `%s', plugin `%s', session %p id %u\n",
1235 GNUNET_i2s (&address->peer),
1236 address->transport_name, session, s);
1238 am = (struct GNUNET_ATS_Information *) &m[1];
1239 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1240 pm = (char *) &am[ats_count];
1241 memcpy (pm, address->address, address->address_length);
1242 if (NULL != address->transport_name)
1243 memcpy (&pm[address->address_length], address->transport_name, namelen);
1244 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1252 * We have updated performance statistics for a given address. Note
1253 * that this function can be called for addresses that are currently
1254 * in use as well as addresses that are valid but not actively in use.
1255 * Furthermore, the peer may not even be connected to us right now (in
1256 * which case the call may be ignored or the information may be stored
1257 * for later use). Update bandwidth assignments.
1260 * @param address the address
1261 * @param session session handle, can be NULL
1262 * @param ats performance data for the address
1263 * @param ats_count number of performance records in 'ats'
1264 * @return GNUNET_YES on success, GNUNET_NO if address or session are unknown,
1265 * GNUNET_SYSERR on hard failure
1268 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
1269 const struct GNUNET_HELLO_Address *address,
1270 struct Session *session,
1271 const struct GNUNET_ATS_Information *ats,
1274 struct PendingMessage *p;
1275 struct AddressUpdateMessage *m;
1276 struct GNUNET_ATS_Information *am;
1282 if (NULL == address)
1285 return GNUNET_SYSERR;
1290 return GNUNET_SYSERR;
1293 namelen = (address->transport_name ==
1294 NULL) ? 0 : strlen (address->transport_name) + 1;
1296 sizeof (struct AddressUpdateMessage) + address->address_length +
1297 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1298 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1299 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1300 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1302 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1305 return GNUNET_SYSERR;
1308 if (NULL != session)
1310 s = find_session_id (sh, session, &address->peer);
1315 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1317 p->is_init = GNUNET_NO;
1318 m = (struct AddressUpdateMessage *) &p[1];
1319 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
1320 m->header.size = htons (msize);
1321 m->ats_count = htonl (ats_count);
1322 m->peer = address->peer;
1323 m->address_length = htons (address->address_length);
1324 m->plugin_name_length = htons (namelen);
1326 m->session_id = htonl (s);
1328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1329 "Updating address for peer `%s', plugin `%s', session %p id %u\n",
1330 GNUNET_i2s (&address->peer),
1331 address->transport_name, session, s);
1333 am = (struct GNUNET_ATS_Information *) &m[1];
1334 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1335 pm = (char *) &am[ats_count];
1336 memcpy (pm, address->address, address->address_length);
1337 memcpy (&pm[address->address_length], address->transport_name, namelen);
1338 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1345 * An address is now in use or not used any more.
1348 * @param address the address
1349 * @param session session handle, can be NULL
1350 * @param in_use GNUNET_YES if this address is now used, GNUNET_NO
1351 * if address is not used any more
1354 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
1355 const struct GNUNET_HELLO_Address *address,
1356 struct Session *session, int in_use)
1358 struct PendingMessage *p;
1359 struct AddressUseMessage *m;
1365 GNUNET_assert (NULL != address);
1367 (address->transport_name ==
1368 NULL) ? 0 : strlen (address->transport_name) + 1;
1369 msize = sizeof (struct AddressUseMessage) + address->address_length + namelen;
1370 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1371 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1372 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1378 if (session != NULL)
1380 s = find_session_id (sh, session, &address->peer);
1381 if ((s == NOT_FOUND) && (GNUNET_NO == in_use))
1383 /* trying to set unknown address to NO */
1384 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1385 "Trying to set unknown address to unused for peer `%s', plugin `%s', session %p\n",
1386 GNUNET_i2s (&address->peer), address->transport_name, session);
1390 if ((s == NOT_FOUND) && (GNUNET_YES == in_use))
1392 /* trying to set new address to YES */
1393 s = find_empty_session_slot (sh, session, &address->peer);
1394 GNUNET_assert (NOT_FOUND != s);
1398 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1400 p->is_init = GNUNET_NO;
1401 m = (struct AddressUseMessage *) &p[1];
1402 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_IN_USE);
1403 m->header.size = htons (msize);
1404 m->peer = address->peer;
1405 m->in_use = htons (in_use);
1406 m->address_length = htons (address->address_length);
1407 m->plugin_name_length = htons (namelen);
1409 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1410 "Setting address used to %s for peer `%s', plugin `%s', session %p\n",
1411 (GNUNET_YES == in_use) ? "YES" : "NO",
1412 GNUNET_i2s (&address->peer), address->transport_name, session);
1414 m->session_id = htonl (s);
1415 pm = (char *) &m[1];
1416 memcpy (pm, address->address, address->address_length);
1417 memcpy (&pm[address->address_length], address->transport_name, namelen);
1418 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1425 * A session got destroyed, stop including it as a valid address.
1428 * @param address the address
1429 * @param session session handle that is no longer valid, can be NULL
1432 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
1433 const struct GNUNET_HELLO_Address *address,
1434 struct Session *session)
1436 struct PendingMessage *p;
1437 struct AddressDestroyedMessage *m;
1443 if (address == NULL)
1449 GNUNET_assert (address->transport_name != NULL);
1450 namelen = strlen (address->transport_name) + 1;
1451 GNUNET_assert (namelen > 1);
1453 sizeof (struct AddressDestroyedMessage) + address->address_length +
1455 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1456 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1457 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1463 s = find_session_id (sh, session, &address->peer);
1464 if ((NULL != session) && (NOT_FOUND == s))
1466 /* trying to delete unknown address */
1467 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1468 "Trying to delete unknown address for peer `%s', plugin `%s', session %p\n",
1469 GNUNET_i2s (&address->peer), address->transport_name, session);
1473 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1475 p->is_init = GNUNET_NO;
1476 m = (struct AddressDestroyedMessage *) &p[1];
1477 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
1478 m->header.size = htons (msize);
1479 m->reserved = htonl (0);
1480 m->peer = address->peer;
1481 m->address_length = htons (address->address_length);
1482 m->plugin_name_length = htons (namelen);
1484 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1485 "Deleting address for peer `%s', plugin `%s', session %p\n",
1486 GNUNET_i2s (&address->peer), address->transport_name, session);
1488 m->session_id = htonl (s);
1489 pm = (char *) &m[1];
1490 memcpy (pm, address->address, address->address_length);
1491 memcpy (&pm[address->address_length], address->transport_name, namelen);
1492 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1494 remove_session (sh, s, &address->peer);
1497 /* end of ats_api_scheduling.c */