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);
293 if (GNUNET_YES == p->is_init)
294 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
295 GNUNET_TIME_UNIT_FOREVER_REL);
304 * Transmit messages from the message queue to the service
305 * (if there are any, and if we are not already trying).
307 * @param sh handle to use
310 do_transmit (struct GNUNET_ATS_SchedulingHandle *sh)
312 struct PendingMessage *p;
316 if (NULL == (p = sh->pending_head))
318 if (NULL == sh->client)
319 return; /* currently reconnecting */
321 GNUNET_CLIENT_notify_transmit_ready (sh->client, p->size,
322 GNUNET_TIME_UNIT_FOREVER_REL,
323 GNUNET_NO, &transmit_message_to_ats,
329 * Find the session object corresponding to the given session ID.
331 * @param sh our handle
332 * @param session_id current session ID
333 * @param peer peer the session belongs to
334 * @return the session object (or NULL)
336 static struct Session *
337 find_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
338 const struct GNUNET_PeerIdentity *peer)
341 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
342 "Find session %u from peer %s in %p\n",
343 (unsigned int) session_id, GNUNET_i2s (peer), sh);
345 if (session_id >= sh->session_array_size)
352 if (sh->session_array[session_id].session == NULL)
355 memcmp (peer, &sh->session_array[session_id].peer,
356 sizeof (struct GNUNET_PeerIdentity)));
361 memcmp (peer, &sh->session_array[session_id].peer,
362 sizeof (struct GNUNET_PeerIdentity)))
365 sh->reconnect = GNUNET_YES;
368 /* This check exploits the fact that first field of a session object
372 memcmp (peer, sh->session_array[session_id].session,
373 sizeof (struct GNUNET_PeerIdentity)))
375 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
376 "Session %p belongs to peer `%s'\n",
377 sh->session_array[session_id].session, GNUNET_i2s_full ((struct GNUNET_PeerIdentity *) &sh->session_array[session_id].peer));
380 sh->reconnect = GNUNET_YES;
384 return sh->session_array[session_id].session;
389 * Get an available session ID for the given session object.
391 * @param sh our handle
392 * @param session session object
393 * @param peer peer the session belongs to
394 * @return the session id
397 find_empty_session_slot (struct GNUNET_ATS_SchedulingHandle *sh, struct Session *session,
398 const struct GNUNET_PeerIdentity *peer)
403 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
404 "Get session ID for session %p from peer %s in %p\n", session,
405 GNUNET_i2s (peer), sh);
410 for (i = 1; i < sh->session_array_size; i++)
412 if ((f == 0) && (sh->session_array[i].slot_used == GNUNET_NO))
417 f = sh->session_array_size;
418 GNUNET_array_grow (sh->session_array, sh->session_array_size,
419 sh->session_array_size * 2);
421 GNUNET_assert (f > 0);
422 sh->session_array[f].session = session;
423 sh->session_array[f].peer = *peer;
424 sh->session_array[f].slot_used = GNUNET_YES;
426 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
427 "Assigning session ID %u for session %p of peer %s in %p\n", f,
428 session, GNUNET_i2s (peer), sh);
435 * Get the ID for the given session object.
437 * @param sh our handle
438 * @param session session object
439 * @param peer peer the session belongs to
440 * @return the session id or NOT_FOUND for error
443 find_session_id (struct GNUNET_ATS_SchedulingHandle *sh, struct Session *session,
444 const struct GNUNET_PeerIdentity *peer)
449 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
450 "Get session ID for session %p from peer %s in %p\n", session,
451 GNUNET_i2s (peer), sh);
455 for (i = 1; i < sh->session_array_size; i++)
457 if (session == sh->session_array[i].session)
459 if (0 != memcmp (peer, &sh->session_array[i].peer,
460 sizeof (struct GNUNET_PeerIdentity)))
462 p2 = strdup (GNUNET_i2s (&sh->session_array[i].peer));
463 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "ats-scheduling-api",
464 "Session %p did not match: old session was for peer `%s' new session is for `%s'\n",
465 session, GNUNET_i2s (peer), p2);
477 * Remove the session of the given session ID from the session
478 * table (it is no longer valid).
480 * @param sh our handle
481 * @param session_id identifies session that is no longer valid
482 * @param peer peer the session belongs to
485 remove_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
486 const struct GNUNET_PeerIdentity *peer)
488 GNUNET_assert (peer != NULL);
489 GNUNET_assert (sh != NULL);
491 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
492 "Release sessionID %u from peer %s in %p\n",
493 (unsigned int) session_id, GNUNET_i2s (peer), sh);
498 GNUNET_assert (session_id < sh->session_array_size);
499 GNUNET_assert (GNUNET_YES == sh->session_array[session_id].slot_used);
500 GNUNET_assert (0 == memcmp (peer,
501 &sh->session_array[session_id].peer,
502 sizeof (struct GNUNET_PeerIdentity)));
503 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
504 "Session %p for peer `%s' removed from slot %u \n",
505 sh->session_array[session_id].session,
508 sh->session_array[session_id].session = NULL;
514 * Release the session slot from the session table (ATS service is
515 * also done using it).
517 * @param sh our handle
518 * @param session_id identifies session that is no longer valid
519 * @param peer peer the session belongs to
522 release_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id,
523 const struct GNUNET_PeerIdentity *peer)
526 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
527 "Release sessionID %u from peer %s in %p\n",
528 (unsigned int) session_id, GNUNET_i2s (peer), sh);
530 if (session_id >= sh->session_array_size)
533 sh->reconnect = GNUNET_YES;
537 /* this slot should have been removed from remove_session before */
538 GNUNET_assert (sh->session_array[session_id].session == NULL);
541 memcmp (peer, &sh->session_array[session_id].peer,
542 sizeof (struct GNUNET_PeerIdentity)))
545 sh->reconnect = GNUNET_YES;
548 sh->session_array[session_id].slot_used = GNUNET_NO;
549 memset (&sh->session_array[session_id].peer, 0,
550 sizeof (struct GNUNET_PeerIdentity));
555 process_release_message (struct GNUNET_ATS_SchedulingHandle *sh,
556 const struct SessionReleaseMessage *srm)
558 release_session (sh, ntohl (srm->session_id), &srm->peer);
563 * Type of a function to call when we receive a message
566 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
567 * @param msg message received, NULL on timeout or fatal error
570 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
572 struct GNUNET_ATS_SchedulingHandle *sh = cls;
573 const struct AddressSuggestionMessage *m;
574 const struct GNUNET_ATS_Information *atsi;
575 const char *plugin_address;
576 const char *plugin_name;
577 uint16_t plugin_address_length;
578 uint16_t plugin_name_length;
580 struct GNUNET_HELLO_Address address;
585 force_reconnect (sh);
588 if ((ntohs (msg->type) == GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE) &&
589 (ntohs (msg->size) == sizeof (struct SessionReleaseMessage)))
591 process_release_message (sh, (const struct SessionReleaseMessage *) msg);
592 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
593 GNUNET_TIME_UNIT_FOREVER_REL);
594 if (GNUNET_YES == sh->reconnect)
595 force_reconnect (sh);
598 if ((ntohs (msg->type) != GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION) ||
599 (ntohs (msg->size) <= sizeof (struct AddressSuggestionMessage)))
602 force_reconnect (sh);
605 m = (const struct AddressSuggestionMessage *) msg;
606 ats_count = ntohl (m->ats_count);
607 plugin_address_length = ntohs (m->address_length);
608 atsi = (const struct GNUNET_ATS_Information *) &m[1];
609 plugin_address = (const char *) &atsi[ats_count];
610 plugin_name = &plugin_address[plugin_address_length];
611 plugin_name_length = ntohs (m->plugin_name_length);
612 if ((plugin_address_length + plugin_name_length +
613 ats_count * sizeof (struct GNUNET_ATS_Information) +
614 sizeof (struct AddressSuggestionMessage) != ntohs (msg->size)) ||
616 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
617 || (plugin_name[plugin_name_length - 1] != '\0'))
620 force_reconnect (sh);
623 uint32_t session_id = ntohl (m->session_id);
629 s = find_session (sh, session_id, &m->peer);
633 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
634 "ATS tries to use outdated session `%s'\n",
635 GNUNET_i2s (&m->peer));
636 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
637 GNUNET_TIME_UNIT_FOREVER_REL);
641 address.peer = m->peer;
642 address.address = plugin_address;
643 address.address_length = plugin_address_length;
644 address.transport_name = plugin_name;
646 if ((s == NULL) && (0 == address.address_length))
648 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
649 "ATS returned invalid address for peer `%s' transport `%s' address length %i, session_id %i\n",
650 GNUNET_i2s (&address.peer), address.transport_name,
651 plugin_address_length, session_id);
653 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
654 GNUNET_TIME_UNIT_FOREVER_REL);
658 sh->suggest_cb (sh->suggest_cb_cls, &address, s, m->bandwidth_out,
659 m->bandwidth_in, atsi, ats_count);
661 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
662 GNUNET_TIME_UNIT_FOREVER_REL);
663 if (GNUNET_YES == sh->reconnect)
664 force_reconnect (sh);
669 * Re-establish the connection to the ATS service.
671 * @param sh handle to use to re-connect.
674 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
676 struct PendingMessage *p;
677 struct ClientStartMessage *init;
679 GNUNET_assert (NULL == sh->client);
680 sh->client = GNUNET_CLIENT_connect ("ats", sh->cfg);
681 GNUNET_assert (NULL != sh->client);
682 if ((NULL == (p = sh->pending_head)) || (GNUNET_YES != p->is_init))
684 p = GNUNET_malloc (sizeof (struct PendingMessage) +
685 sizeof (struct ClientStartMessage));
686 p->size = sizeof (struct ClientStartMessage);
687 p->is_init = GNUNET_YES;
688 init = (struct ClientStartMessage *) &p[1];
689 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
690 init->header.size = htons (sizeof (struct ClientStartMessage));
691 init->start_flag = htonl (START_FLAG_SCHEDULING);
692 GNUNET_CONTAINER_DLL_insert (sh->pending_head, sh->pending_tail, p);
699 * delete the current network list
702 delete_networks (struct GNUNET_ATS_SchedulingHandle *sh)
704 struct ATS_Network * cur = sh->net_head;
707 GNUNET_CONTAINER_DLL_remove(sh->net_head, sh->net_tail, cur);
715 interface_proc (void *cls, const char *name,
717 const struct sockaddr *
719 const struct sockaddr *
721 const struct sockaddr *
722 netmask, socklen_t addrlen)
724 struct GNUNET_ATS_SchedulingHandle * sh = cls;
725 /* Calculate network */
726 struct ATS_Network *net = NULL;
728 /* Skipping IPv4 loopback addresses since we have special check */
729 if (addr->sa_family == AF_INET)
731 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
733 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
736 /* Skipping IPv6 loopback addresses since we have special check */
737 if (addr->sa_family == AF_INET6)
739 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
740 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
744 if (addr->sa_family == AF_INET)
746 struct sockaddr_in *addr4 = (struct sockaddr_in *) addr;
747 struct sockaddr_in *netmask4 = (struct sockaddr_in *) netmask;
748 struct sockaddr_in *tmp = NULL;
749 struct sockaddr_in network4;
751 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in));
752 tmp = (struct sockaddr_in *) &net[1];
753 net->network = (struct sockaddr *) &tmp[0];
754 net->netmask = (struct sockaddr *) &tmp[1];
755 net->length = addrlen;
757 memset (&network4, 0, sizeof (network4));
758 network4.sin_family = AF_INET;
759 #if HAVE_SOCKADDR_IN_SIN_LEN
760 network4.sin_len = sizeof (network4);
762 network4.sin_addr.s_addr = (addr4->sin_addr.s_addr & netmask4->sin_addr.s_addr);
764 memcpy (net->netmask, netmask4, sizeof (struct sockaddr_in));
765 memcpy (net->network, &network4, sizeof (struct sockaddr_in));
768 if (addr->sa_family == AF_INET6)
770 struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) addr;
771 struct sockaddr_in6 *netmask6 = (struct sockaddr_in6 *) netmask;
772 struct sockaddr_in6 * tmp = NULL;
773 struct sockaddr_in6 network6;
775 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in6));
776 tmp = (struct sockaddr_in6 *) &net[1];
777 net->network = (struct sockaddr *) &tmp[0];
778 net->netmask = (struct sockaddr *) &tmp[1];
779 net->length = addrlen;
781 memset (&network6, 0, sizeof (network6));
782 network6.sin6_family = AF_INET6;
783 #if HAVE_SOCKADDR_IN_SIN_LEN
784 network6.sin6_len = sizeof (network6);
787 uint32_t *addr_elem = (uint32_t *) &addr6->sin6_addr;
788 uint32_t *mask_elem = (uint32_t *) &netmask6->sin6_addr;
789 uint32_t *net_elem = (uint32_t *) &network6.sin6_addr;
790 for (c = 0; c < 4; c++)
791 net_elem[c] = addr_elem[c] & mask_elem[c];
793 memcpy (net->netmask, netmask6, sizeof (struct sockaddr_in6));
794 memcpy (net->network, &network6, sizeof (struct sockaddr_in6));
801 char * netmask = GNUNET_strdup (GNUNET_a2s((struct sockaddr *) net->netmask, addrlen));
802 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding network `%s', netmask `%s'\n",
803 GNUNET_a2s((struct sockaddr *) net->network, addrlen),
805 GNUNET_free (netmask);
807 GNUNET_CONTAINER_DLL_insert(sh->net_head, sh->net_tail, net);
814 * Periodically get list of addresses
816 * @param tc Task context
819 get_addresses (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
821 struct GNUNET_ATS_SchedulingHandle * sh = cls;
822 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
823 delete_networks (sh);
824 GNUNET_OS_network_interfaces_list(interface_proc, sh);
825 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
831 * Convert a GNUNET_ATS_NetworkType to a string
833 * @param net the network type
834 * @return a string or NULL if invalid
837 GNUNET_ATS_print_network_type (uint32_t net)
839 char *networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
840 if (net < GNUNET_ATS_NetworkTypeCount)
841 return networks[net];
847 * Returns where the address is located: LAN or WAN or ...
849 * @param sh the scheduling handle
850 * @param addr address
851 * @param addrlen address length
852 * @return location as GNUNET_ATS_Information
854 struct GNUNET_ATS_Information
855 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle * sh, const struct sockaddr * addr, socklen_t addrlen)
857 GNUNET_assert (sh != NULL);
858 struct ATS_Network * cur = sh->net_head;
860 int type = GNUNET_ATS_NET_UNSPECIFIED;
861 struct GNUNET_ATS_Information ats;
863 if (addr->sa_family == AF_UNIX)
865 type = GNUNET_ATS_NET_LOOPBACK;
868 /* IPv4 loopback check */
869 if (addr->sa_family == AF_INET)
871 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
873 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
874 type = GNUNET_ATS_NET_LOOPBACK;
876 /* IPv6 loopback check */
877 if (addr->sa_family == AF_INET6)
879 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
880 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
881 type = GNUNET_ATS_NET_LOOPBACK;
884 /* Check local networks */
885 while ((cur != NULL) && (type == GNUNET_ATS_NET_UNSPECIFIED))
887 if (addrlen != cur->length)
893 if (addr->sa_family == AF_INET)
895 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
896 struct sockaddr_in * net4 = (struct sockaddr_in *) cur->network;
897 struct sockaddr_in * mask4 = (struct sockaddr_in *) cur->netmask;
899 if (((a4->sin_addr.s_addr & mask4->sin_addr.s_addr)) == net4->sin_addr.s_addr)
900 type = GNUNET_ATS_NET_LAN;
902 if (addr->sa_family == AF_INET6)
904 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
905 struct sockaddr_in6 * net6 = (struct sockaddr_in6 *) cur->network;
906 struct sockaddr_in6 * mask6 = (struct sockaddr_in6 *) cur->netmask;
908 int res = GNUNET_YES;
910 uint32_t *addr_elem = (uint32_t *) &a6->sin6_addr;
911 uint32_t *mask_elem = (uint32_t *) &mask6->sin6_addr;
912 uint32_t *net_elem = (uint32_t *) &net6->sin6_addr;
913 for (c = 0; c < 4; c++)
914 if ((addr_elem[c] & mask_elem[c]) != net_elem[c])
917 if (res == GNUNET_YES)
918 type = GNUNET_ATS_NET_LAN;
923 /* no local network found for this address, default: WAN */
924 if (type == GNUNET_ATS_NET_UNSPECIFIED)
925 type = GNUNET_ATS_NET_WAN;
926 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
927 ats.value = htonl (type);
929 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
930 "`%s' is in network `%s'\n",
931 GNUNET_a2s ((const struct sockaddr *) addr, addrlen),
932 GNUNET_ATS_print_network_type(type));
938 * Initialize the ATS subsystem.
940 * @param cfg configuration to use
941 * @param suggest_cb notification to call whenever the suggestation changed
942 * @param suggest_cb_cls closure for 'suggest_cb'
943 * @return ats context
945 struct GNUNET_ATS_SchedulingHandle *
946 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
947 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
948 void *suggest_cb_cls)
950 struct GNUNET_ATS_SchedulingHandle *sh;
952 sh = GNUNET_malloc (sizeof (struct GNUNET_ATS_SchedulingHandle));
954 sh->suggest_cb = suggest_cb;
955 sh->suggest_cb_cls = suggest_cb_cls;
956 GNUNET_array_grow (sh->session_array, sh->session_array_size, 4);
957 GNUNET_OS_network_interfaces_list(interface_proc, sh);
958 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
967 * Client is done with ATS scheduling, release resources.
969 * @param sh handle to release
972 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
974 struct PendingMessage *p;
975 struct GNUNET_ATS_SuggestHandle *cur;
976 struct GNUNET_ATS_SuggestHandle *next;
977 while (NULL != (p = sh->pending_head))
979 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
982 if (NULL != sh->client)
984 GNUNET_CLIENT_disconnect (sh->client);
987 if (GNUNET_SCHEDULER_NO_TASK != sh->task)
989 GNUNET_SCHEDULER_cancel (sh->task);
990 sh->task = GNUNET_SCHEDULER_NO_TASK;
994 while (NULL != (cur = next))
997 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, cur);
1001 delete_networks (sh);
1002 if (sh->interface_task != GNUNET_SCHEDULER_NO_TASK)
1004 GNUNET_SCHEDULER_cancel(sh->interface_task);
1005 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
1007 GNUNET_array_grow (sh->session_array, sh->session_array_size, 0);
1013 * We would like to reset the address suggestion block time for this
1017 * @param peer identity of the peer we want to reset
1020 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
1021 const struct GNUNET_PeerIdentity *peer)
1023 struct PendingMessage *p;
1024 struct ResetBackoffMessage *m;
1026 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1027 sizeof (struct ResetBackoffMessage));
1028 p->size = sizeof (struct ResetBackoffMessage);
1029 p->is_init = GNUNET_NO;
1030 m = (struct ResetBackoffMessage *) &p[1];
1031 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESET_BACKOFF);
1032 m->header.size = htons (sizeof (struct ResetBackoffMessage));
1033 m->reserved = htonl (0);
1035 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1040 * We would like to establish a new connection with a peer. ATS
1041 * should suggest a good address to begin with.
1044 * @param peer identity of the peer we need an address for
1045 * @return suggest handle
1047 struct GNUNET_ATS_SuggestHandle *
1048 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
1049 const struct GNUNET_PeerIdentity *peer)
1051 struct PendingMessage *p;
1052 struct RequestAddressMessage *m;
1053 struct GNUNET_ATS_SuggestHandle *s;
1055 // FIXME: ATS needs to remember this in case of
1057 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1058 sizeof (struct RequestAddressMessage));
1059 p->size = sizeof (struct RequestAddressMessage);
1060 p->is_init = GNUNET_NO;
1061 m = (struct RequestAddressMessage *) &p[1];
1062 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
1063 m->header.size = htons (sizeof (struct RequestAddressMessage));
1064 m->reserved = htonl (0);
1066 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1068 s = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestHandle));
1070 GNUNET_CONTAINER_DLL_insert_tail (sh->sug_head, sh->sug_tail, s);
1076 * We would like to stop receiving address updates for this peer
1079 * @param peer identity of the peer
1082 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
1083 const struct GNUNET_PeerIdentity *peer)
1085 struct PendingMessage *p;
1086 struct RequestAddressMessage *m;
1087 struct GNUNET_ATS_SuggestHandle *s;
1089 for (s = sh->sug_head; NULL != s; s = s->next)
1090 if (0 == memcmp(peer, &s->id, sizeof (s->id)))
1099 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, s);
1103 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1104 sizeof (struct RequestAddressMessage));
1105 p->size = sizeof (struct RequestAddressMessage);
1106 p->is_init = GNUNET_NO;
1107 m = (struct RequestAddressMessage *) &p[1];
1108 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
1109 m->header.size = htons (sizeof (struct RequestAddressMessage));
1110 m->reserved = htonl (0);
1112 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1118 * We have a new address ATS should know. Addresses have to be added with this
1119 * function before they can be: updated, set in use and destroyed
1122 * @param address the address
1123 * @param session session handle, can be NULL
1124 * @param ats performance data for the address
1125 * @param ats_count number of performance records in 'ats'
1126 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1129 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
1130 const struct GNUNET_HELLO_Address *address,
1131 struct Session *session,
1132 const struct GNUNET_ATS_Information *ats,
1136 struct PendingMessage *p;
1137 struct AddressUpdateMessage *m;
1138 struct GNUNET_ATS_Information *am;
1144 if (address == NULL)
1147 return GNUNET_SYSERR;
1151 (address->transport_name ==
1152 NULL) ? 0 : strlen (address->transport_name) + 1;
1154 sizeof (struct AddressUpdateMessage) + address->address_length +
1155 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1156 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1157 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1158 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1160 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1163 return GNUNET_SYSERR;
1166 if (NULL != session)
1168 s = find_session_id (sh, session, &address->peer);
1171 /* Already existing, nothing todo */
1172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1173 "Adding duplicate address for peer `%s', plugin `%s', session %p id %u\n",
1174 GNUNET_i2s (&address->peer),
1175 address->transport_name, session, s);
1176 return GNUNET_SYSERR;
1178 s = find_empty_session_slot (sh, session, &address->peer);
1179 GNUNET_break (NOT_FOUND != s);
1182 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1184 p->is_init = GNUNET_NO;
1185 m = (struct AddressUpdateMessage *) &p[1];
1186 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
1187 m->header.size = htons (msize);
1188 m->ats_count = htonl (ats_count);
1189 m->peer = address->peer;
1190 m->address_length = htons (address->address_length);
1191 m->plugin_name_length = htons (namelen);
1192 m->session_id = htonl (s);
1194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1195 "Adding address for peer `%s', plugin `%s', session %p id %u\n",
1196 GNUNET_i2s (&address->peer),
1197 address->transport_name, session, s);
1199 am = (struct GNUNET_ATS_Information *) &m[1];
1200 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1201 pm = (char *) &am[ats_count];
1202 memcpy (pm, address->address, address->address_length);
1203 if (NULL != address->transport_name)
1204 memcpy (&pm[address->address_length], address->transport_name, namelen);
1205 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1213 * We have updated performance statistics for a given address. Note
1214 * that this function can be called for addresses that are currently
1215 * in use as well as addresses that are valid but not actively in use.
1216 * Furthermore, the peer may not even be connected to us right now (in
1217 * which case the call may be ignored or the information may be stored
1218 * for later use). Update bandwidth assignments.
1221 * @param address the address
1222 * @param session session handle, can be NULL
1223 * @param ats performance data for the address
1224 * @param ats_count number of performance records in 'ats'
1227 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
1228 const struct GNUNET_HELLO_Address *address,
1229 struct Session *session,
1230 const struct GNUNET_ATS_Information *ats,
1233 struct PendingMessage *p;
1234 struct AddressUpdateMessage *m;
1235 struct GNUNET_ATS_Information *am;
1241 if (address == NULL)
1248 (address->transport_name ==
1249 NULL) ? 0 : strlen (address->transport_name) + 1;
1251 sizeof (struct AddressUpdateMessage) + address->address_length +
1252 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1253 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1254 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1255 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1257 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1263 if (NULL != session)
1265 s = find_session_id (sh, session, &address->peer);
1268 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1269 "Update for unknown address for peer `%s', plugin `%s', session %p id %u\n",
1270 GNUNET_i2s (&address->peer),
1271 address->transport_name, session, s);
1278 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1280 p->is_init = GNUNET_NO;
1281 m = (struct AddressUpdateMessage *) &p[1];
1282 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
1283 m->header.size = htons (msize);
1284 m->ats_count = htonl (ats_count);
1285 m->peer = address->peer;
1286 m->address_length = htons (address->address_length);
1287 m->plugin_name_length = htons (namelen);
1289 m->session_id = htonl (s);
1291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1292 "Updating address for peer `%s', plugin `%s', session %p id %u\n",
1293 GNUNET_i2s (&address->peer),
1294 address->transport_name, session, s);
1296 am = (struct GNUNET_ATS_Information *) &m[1];
1297 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1298 pm = (char *) &am[ats_count];
1299 memcpy (pm, address->address, address->address_length);
1300 memcpy (&pm[address->address_length], address->transport_name, namelen);
1301 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1308 * An address is now in use or not used any more.
1311 * @param address the address
1312 * @param session session handle, can be NULL
1313 * @param in_use GNUNET_YES if this address is now used, GNUNET_NO
1314 * if address is not used any more
1317 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
1318 const struct GNUNET_HELLO_Address *address,
1319 struct Session *session, int in_use)
1321 struct PendingMessage *p;
1322 struct AddressUseMessage *m;
1328 GNUNET_assert (NULL != address);
1330 (address->transport_name ==
1331 NULL) ? 0 : strlen (address->transport_name) + 1;
1332 msize = sizeof (struct AddressUseMessage) + address->address_length + namelen;
1333 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1334 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1335 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1341 if (session != NULL)
1343 s = find_session_id (sh, session, &address->peer);
1344 if ((s == NOT_FOUND) && (GNUNET_NO == in_use))
1346 /* trying to set unknown address to NO */
1347 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1348 "Trying to set unknown address to unused for peer `%s', plugin `%s', session %p\n",
1349 GNUNET_i2s (&address->peer), address->transport_name, session);
1353 if ((s == NOT_FOUND) && (GNUNET_YES == in_use))
1355 /* trying to set new address to YES */
1356 s = find_empty_session_slot (sh, session, &address->peer);
1357 GNUNET_assert (NOT_FOUND != s);
1361 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1363 p->is_init = GNUNET_NO;
1364 m = (struct AddressUseMessage *) &p[1];
1365 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_IN_USE);
1366 m->header.size = htons (msize);
1367 m->peer = address->peer;
1368 m->in_use = htons (in_use);
1369 m->address_length = htons (address->address_length);
1370 m->plugin_name_length = htons (namelen);
1372 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1373 "Setting address used to %s for peer `%s', plugin `%s', session %p\n",
1374 (GNUNET_YES == in_use) ? "YES" : "NO",
1375 GNUNET_i2s (&address->peer), address->transport_name, session);
1377 m->session_id = htonl (s);
1378 pm = (char *) &m[1];
1379 memcpy (pm, address->address, address->address_length);
1380 memcpy (&pm[address->address_length], address->transport_name, namelen);
1381 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1388 * A session got destroyed, stop including it as a valid address.
1391 * @param address the address
1392 * @param session session handle that is no longer valid, can be NULL
1395 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
1396 const struct GNUNET_HELLO_Address *address,
1397 struct Session *session)
1399 struct PendingMessage *p;
1400 struct AddressDestroyedMessage *m;
1406 if (address == NULL)
1412 GNUNET_assert (address->transport_name != NULL);
1413 namelen = strlen (address->transport_name) + 1;
1414 GNUNET_assert (namelen > 1);
1416 sizeof (struct AddressDestroyedMessage) + address->address_length +
1418 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1419 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1420 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1426 s = find_session_id (sh, session, &address->peer);
1427 if ((NULL != session) && (NOT_FOUND == s))
1429 /* trying to delete unknown address */
1430 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1431 "Trying to delete unknown address for peer `%s', plugin `%s', session %p\n",
1432 GNUNET_i2s (&address->peer), address->transport_name, session);
1436 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1438 p->is_init = GNUNET_NO;
1439 m = (struct AddressDestroyedMessage *) &p[1];
1440 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
1441 m->header.size = htons (msize);
1442 m->reserved = htonl (0);
1443 m->peer = address->peer;
1444 m->address_length = htons (address->address_length);
1445 m->plugin_name_length = htons (namelen);
1447 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1448 "Deleting address for peer `%s', plugin `%s', session %p\n",
1449 GNUNET_i2s (&address->peer), address->transport_name, session);
1451 m->session_id = htonl (s);
1452 pm = (char *) &m[1];
1453 memcpy (pm, address->address, address->address_length);
1454 memcpy (&pm[address->address_length], address->transport_name, namelen);
1455 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1457 remove_session (sh, s, &address->peer);
1460 /* end of ats_api_scheduling.c */