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;
646 address.local_info = ntohl(m->address_local_info);
648 if ((s == NULL) && (0 == address.address_length))
650 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
651 "ATS returned invalid address for peer `%s' transport `%s' address length %i, session_id %i\n",
652 GNUNET_i2s (&address.peer), address.transport_name,
653 plugin_address_length, session_id);
655 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
656 GNUNET_TIME_UNIT_FOREVER_REL);
660 sh->suggest_cb (sh->suggest_cb_cls,
661 (const struct GNUNET_PeerIdentity *) &m->peer,
662 &address, s, m->bandwidth_out,
663 m->bandwidth_in, atsi, ats_count);
665 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
666 GNUNET_TIME_UNIT_FOREVER_REL);
667 if (GNUNET_YES == sh->reconnect)
668 force_reconnect (sh);
673 * Re-establish the connection to the ATS service.
675 * @param sh handle to use to re-connect.
678 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
680 struct PendingMessage *p;
681 struct ClientStartMessage *init;
683 GNUNET_assert (NULL == sh->client);
684 sh->client = GNUNET_CLIENT_connect ("ats", sh->cfg);
685 GNUNET_assert (NULL != sh->client);
686 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
687 GNUNET_TIME_UNIT_FOREVER_REL);
688 if ((NULL == (p = sh->pending_head)) || (GNUNET_YES != p->is_init))
690 p = GNUNET_malloc (sizeof (struct PendingMessage) +
691 sizeof (struct ClientStartMessage));
692 p->size = sizeof (struct ClientStartMessage);
693 p->is_init = GNUNET_YES;
694 init = (struct ClientStartMessage *) &p[1];
695 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
696 init->header.size = htons (sizeof (struct ClientStartMessage));
697 init->start_flag = htonl (START_FLAG_SCHEDULING);
698 GNUNET_CONTAINER_DLL_insert (sh->pending_head, sh->pending_tail, p);
705 * delete the current network list
708 delete_networks (struct GNUNET_ATS_SchedulingHandle *sh)
710 struct ATS_Network * cur = sh->net_head;
713 GNUNET_CONTAINER_DLL_remove(sh->net_head, sh->net_tail, cur);
721 interface_proc (void *cls, const char *name,
723 const struct sockaddr *
725 const struct sockaddr *
727 const struct sockaddr *
728 netmask, socklen_t addrlen)
730 struct GNUNET_ATS_SchedulingHandle * sh = cls;
731 /* Calculate network */
732 struct ATS_Network *net = NULL;
734 /* Skipping IPv4 loopback addresses since we have special check */
735 if (addr->sa_family == AF_INET)
737 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
739 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
742 /* Skipping IPv6 loopback addresses since we have special check */
743 if (addr->sa_family == AF_INET6)
745 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
746 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
750 if (addr->sa_family == AF_INET)
752 struct sockaddr_in *addr4 = (struct sockaddr_in *) addr;
753 struct sockaddr_in *netmask4 = (struct sockaddr_in *) netmask;
754 struct sockaddr_in *tmp = NULL;
755 struct sockaddr_in network4;
757 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in));
758 tmp = (struct sockaddr_in *) &net[1];
759 net->network = (struct sockaddr *) &tmp[0];
760 net->netmask = (struct sockaddr *) &tmp[1];
761 net->length = addrlen;
763 memset (&network4, 0, sizeof (network4));
764 network4.sin_family = AF_INET;
765 #if HAVE_SOCKADDR_IN_SIN_LEN
766 network4.sin_len = sizeof (network4);
768 network4.sin_addr.s_addr = (addr4->sin_addr.s_addr & netmask4->sin_addr.s_addr);
770 memcpy (net->netmask, netmask4, sizeof (struct sockaddr_in));
771 memcpy (net->network, &network4, sizeof (struct sockaddr_in));
774 if (addr->sa_family == AF_INET6)
776 struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) addr;
777 struct sockaddr_in6 *netmask6 = (struct sockaddr_in6 *) netmask;
778 struct sockaddr_in6 * tmp = NULL;
779 struct sockaddr_in6 network6;
781 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in6));
782 tmp = (struct sockaddr_in6 *) &net[1];
783 net->network = (struct sockaddr *) &tmp[0];
784 net->netmask = (struct sockaddr *) &tmp[1];
785 net->length = addrlen;
787 memset (&network6, 0, sizeof (network6));
788 network6.sin6_family = AF_INET6;
789 #if HAVE_SOCKADDR_IN_SIN_LEN
790 network6.sin6_len = sizeof (network6);
793 uint32_t *addr_elem = (uint32_t *) &addr6->sin6_addr;
794 uint32_t *mask_elem = (uint32_t *) &netmask6->sin6_addr;
795 uint32_t *net_elem = (uint32_t *) &network6.sin6_addr;
796 for (c = 0; c < 4; c++)
797 net_elem[c] = addr_elem[c] & mask_elem[c];
799 memcpy (net->netmask, netmask6, sizeof (struct sockaddr_in6));
800 memcpy (net->network, &network6, sizeof (struct sockaddr_in6));
807 char * netmask = GNUNET_strdup (GNUNET_a2s((struct sockaddr *) net->netmask, addrlen));
808 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding network `%s', netmask `%s'\n",
809 GNUNET_a2s((struct sockaddr *) net->network, addrlen),
811 GNUNET_free (netmask);
813 GNUNET_CONTAINER_DLL_insert(sh->net_head, sh->net_tail, net);
820 * Periodically get list of addresses
822 * @param tc Task context
825 get_addresses (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
827 struct GNUNET_ATS_SchedulingHandle * sh = cls;
828 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
829 delete_networks (sh);
830 GNUNET_OS_network_interfaces_list(interface_proc, sh);
831 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
837 * Convert a GNUNET_ATS_NetworkType to a string
839 * @param net the network type
840 * @return a string or NULL if invalid
843 GNUNET_ATS_print_network_type (uint32_t net)
845 char *networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
846 if (net < GNUNET_ATS_NetworkTypeCount)
847 return networks[net];
852 * Convert a ATS property to a string
854 * @param type the atsi type
855 * @return a string or NULL if invalid
858 GNUNET_ATS_print_property_type (uint32_t type)
860 char *props[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
861 if ((type > 0) && (type < GNUNET_ATS_PropertyCount))
868 * Returns where the address is located: LAN or WAN or ...
870 * @param sh the scheduling handle
871 * @param addr address
872 * @param addrlen address length
873 * @return location as GNUNET_ATS_Information
875 struct GNUNET_ATS_Information
876 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle * sh, const struct sockaddr * addr, socklen_t addrlen)
878 GNUNET_assert (sh != NULL);
879 struct ATS_Network * cur = sh->net_head;
881 int type = GNUNET_ATS_NET_UNSPECIFIED;
882 struct GNUNET_ATS_Information ats;
884 if (addr->sa_family == AF_UNIX)
886 type = GNUNET_ATS_NET_LOOPBACK;
889 /* IPv4 loopback check */
890 if (addr->sa_family == AF_INET)
892 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
894 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
895 type = GNUNET_ATS_NET_LOOPBACK;
897 /* IPv6 loopback check */
898 if (addr->sa_family == AF_INET6)
900 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
901 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
902 type = GNUNET_ATS_NET_LOOPBACK;
905 /* Check local networks */
906 while ((cur != NULL) && (type == GNUNET_ATS_NET_UNSPECIFIED))
908 if (addrlen != cur->length)
914 if (addr->sa_family == AF_INET)
916 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
917 struct sockaddr_in * net4 = (struct sockaddr_in *) cur->network;
918 struct sockaddr_in * mask4 = (struct sockaddr_in *) cur->netmask;
920 if (((a4->sin_addr.s_addr & mask4->sin_addr.s_addr)) == net4->sin_addr.s_addr)
921 type = GNUNET_ATS_NET_LAN;
923 if (addr->sa_family == AF_INET6)
925 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
926 struct sockaddr_in6 * net6 = (struct sockaddr_in6 *) cur->network;
927 struct sockaddr_in6 * mask6 = (struct sockaddr_in6 *) cur->netmask;
929 int res = GNUNET_YES;
931 uint32_t *addr_elem = (uint32_t *) &a6->sin6_addr;
932 uint32_t *mask_elem = (uint32_t *) &mask6->sin6_addr;
933 uint32_t *net_elem = (uint32_t *) &net6->sin6_addr;
934 for (c = 0; c < 4; c++)
935 if ((addr_elem[c] & mask_elem[c]) != net_elem[c])
938 if (res == GNUNET_YES)
939 type = GNUNET_ATS_NET_LAN;
944 /* no local network found for this address, default: WAN */
945 if (type == GNUNET_ATS_NET_UNSPECIFIED)
946 type = GNUNET_ATS_NET_WAN;
947 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
948 ats.value = htonl (type);
950 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
951 "`%s' is in network `%s'\n",
952 GNUNET_a2s ((const struct sockaddr *) addr, addrlen),
953 GNUNET_ATS_print_network_type(type));
959 * Initialize the ATS subsystem.
961 * @param cfg configuration to use
962 * @param suggest_cb notification to call whenever the suggestation changed
963 * @param suggest_cb_cls closure for 'suggest_cb'
964 * @return ats context
966 struct GNUNET_ATS_SchedulingHandle *
967 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
968 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
969 void *suggest_cb_cls)
971 struct GNUNET_ATS_SchedulingHandle *sh;
973 sh = GNUNET_new (struct GNUNET_ATS_SchedulingHandle);
975 sh->suggest_cb = suggest_cb;
976 sh->suggest_cb_cls = suggest_cb_cls;
977 GNUNET_array_grow (sh->session_array, sh->session_array_size, 4);
978 GNUNET_OS_network_interfaces_list(interface_proc, sh);
979 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
988 * Client is done with ATS scheduling, release resources.
990 * @param sh handle to release
993 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
995 struct PendingMessage *p;
996 struct GNUNET_ATS_SuggestHandle *cur;
997 struct GNUNET_ATS_SuggestHandle *next;
998 while (NULL != (p = sh->pending_head))
1000 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
1003 if (NULL != sh->client)
1005 GNUNET_CLIENT_disconnect (sh->client);
1008 if (GNUNET_SCHEDULER_NO_TASK != sh->task)
1010 GNUNET_SCHEDULER_cancel (sh->task);
1011 sh->task = GNUNET_SCHEDULER_NO_TASK;
1014 next = sh->sug_head;
1015 while (NULL != (cur = next))
1018 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, cur);
1022 delete_networks (sh);
1023 if (sh->interface_task != GNUNET_SCHEDULER_NO_TASK)
1025 GNUNET_SCHEDULER_cancel(sh->interface_task);
1026 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
1028 GNUNET_array_grow (sh->session_array, sh->session_array_size, 0);
1034 * We would like to reset the address suggestion block time for this
1038 * @param peer identity of the peer we want to reset
1041 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
1042 const struct GNUNET_PeerIdentity *peer)
1044 struct PendingMessage *p;
1045 struct ResetBackoffMessage *m;
1047 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1048 sizeof (struct ResetBackoffMessage));
1049 p->size = sizeof (struct ResetBackoffMessage);
1050 p->is_init = GNUNET_NO;
1051 m = (struct ResetBackoffMessage *) &p[1];
1052 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESET_BACKOFF);
1053 m->header.size = htons (sizeof (struct ResetBackoffMessage));
1054 m->reserved = htonl (0);
1056 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1061 * We would like to receive address suggestions for a peer. ATS will
1062 * respond with a call to the continuation immediately containing an address or
1063 * no address if none is available. ATS can suggest more addresses until we call
1064 * #GNUNET_ATS_suggest_address_cancel.
1068 * @param peer identity of the peer we need an address for
1069 * @param cont the continuation to call with the address
1070 * @param cont_cls the cls for the continuation
1071 * @return suggest handle
1073 struct GNUNET_ATS_SuggestHandle *
1074 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
1075 const struct GNUNET_PeerIdentity *peer,
1076 GNUNET_ATS_AddressSuggestionCallback cont,
1079 struct PendingMessage *p;
1080 struct RequestAddressMessage *m;
1081 struct GNUNET_ATS_SuggestHandle *s;
1083 // FIXME: ATS needs to remember this in case of
1085 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1086 sizeof (struct RequestAddressMessage));
1087 p->size = sizeof (struct RequestAddressMessage);
1088 p->is_init = GNUNET_NO;
1089 m = (struct RequestAddressMessage *) &p[1];
1090 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
1091 m->header.size = htons (sizeof (struct RequestAddressMessage));
1092 m->reserved = htonl (0);
1094 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1096 s = GNUNET_new (struct GNUNET_ATS_SuggestHandle);
1098 GNUNET_CONTAINER_DLL_insert_tail (sh->sug_head, sh->sug_tail, s);
1104 * We would like to stop receiving address updates for this peer
1107 * @param peer identity of the peer
1110 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
1111 const struct GNUNET_PeerIdentity *peer)
1113 struct PendingMessage *p;
1114 struct RequestAddressMessage *m;
1115 struct GNUNET_ATS_SuggestHandle *s;
1117 for (s = sh->sug_head; NULL != s; s = s->next)
1118 if (0 == memcmp(peer, &s->id, sizeof (s->id)))
1127 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, s);
1131 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1132 sizeof (struct RequestAddressMessage));
1133 p->size = sizeof (struct RequestAddressMessage);
1134 p->is_init = GNUNET_NO;
1135 m = (struct RequestAddressMessage *) &p[1];
1136 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
1137 m->header.size = htons (sizeof (struct RequestAddressMessage));
1138 m->reserved = htonl (0);
1140 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1146 * Test if a address and a session is known to ATS
1148 * @param sh the scheduling handle
1149 * @param address the address
1150 * @param session the session
1151 * @return GNUNET_YES or GNUNET_NO
1154 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
1155 const struct GNUNET_HELLO_Address *address,
1156 struct Session *session)
1159 if (NULL != session)
1161 if (NOT_FOUND != (s = find_session_id (sh, session, &address->peer)))
1172 * We have a new address ATS should know. Addresses have to be added with this
1173 * function before they can be: updated, set in use and destroyed
1176 * @param address the address
1177 * @param session session handle, can be NULL
1178 * @param ats performance data for the address
1179 * @param ats_count number of performance records in 'ats'
1180 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1183 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
1184 const struct GNUNET_HELLO_Address *address,
1185 struct Session *session,
1186 const struct GNUNET_ATS_Information *ats,
1190 struct PendingMessage *p;
1191 struct AddressUpdateMessage *m;
1192 struct GNUNET_ATS_Information *am;
1198 if (address == NULL)
1201 return GNUNET_SYSERR;
1204 namelen = (address->transport_name == NULL) ? 0 : strlen (address->transport_name) + 1;
1206 msize = sizeof (struct AddressUpdateMessage) + address->address_length +
1207 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1208 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1209 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1210 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1212 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1215 return GNUNET_SYSERR;
1218 if (NULL != session)
1220 if (NOT_FOUND != (s = find_session_id (sh, session, &address->peer)))
1222 /* Already existing, nothing todo */
1223 return GNUNET_SYSERR;
1225 s = find_empty_session_slot (sh, session, &address->peer);
1226 GNUNET_break (NOT_FOUND != s);
1229 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1231 p->is_init = GNUNET_NO;
1232 m = (struct AddressUpdateMessage *) &p[1];
1233 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
1234 m->header.size = htons (msize);
1235 m->ats_count = htonl (ats_count);
1236 m->peer = address->peer;
1237 m->address_length = htons (address->address_length);
1238 m->address_local_info = htonl ((uint32_t) address->local_info);
1239 m->plugin_name_length = htons (namelen);
1240 m->session_id = htonl (s);
1242 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1243 "Adding address for peer `%s', plugin `%s', session %p id %u\n",
1244 GNUNET_i2s (&address->peer),
1245 address->transport_name, session, s);
1247 am = (struct GNUNET_ATS_Information *) &m[1];
1248 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1249 pm = (char *) &am[ats_count];
1250 memcpy (pm, address->address, address->address_length);
1251 if (NULL != address->transport_name)
1252 memcpy (&pm[address->address_length], address->transport_name, namelen);
1253 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1261 * We have updated performance statistics for a given address. Note
1262 * that this function can be called for addresses that are currently
1263 * in use as well as addresses that are valid but not actively in use.
1264 * Furthermore, the peer may not even be connected to us right now (in
1265 * which case the call may be ignored or the information may be stored
1266 * for later use). Update bandwidth assignments.
1269 * @param address the address
1270 * @param session session handle, can be NULL
1271 * @param ats performance data for the address
1272 * @param ats_count number of performance records in 'ats'
1273 * @return GNUNET_YES on success, GNUNET_NO if address or session are unknown,
1274 * GNUNET_SYSERR on hard failure
1277 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
1278 const struct GNUNET_HELLO_Address *address,
1279 struct Session *session,
1280 const struct GNUNET_ATS_Information *ats,
1283 struct PendingMessage *p;
1284 struct AddressUpdateMessage *m;
1285 struct GNUNET_ATS_Information *am;
1291 if (NULL == address)
1294 return GNUNET_SYSERR;
1299 return GNUNET_SYSERR;
1302 namelen = (address->transport_name ==
1303 NULL) ? 0 : strlen (address->transport_name) + 1;
1305 sizeof (struct AddressUpdateMessage) + address->address_length +
1306 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1307 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1308 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1309 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1311 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1314 return GNUNET_SYSERR;
1317 if (NULL != session)
1319 s = find_session_id (sh, session, &address->peer);
1324 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1326 p->is_init = GNUNET_NO;
1327 m = (struct AddressUpdateMessage *) &p[1];
1328 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
1329 m->header.size = htons (msize);
1330 m->ats_count = htonl (ats_count);
1331 m->peer = address->peer;
1332 m->address_length = htons (address->address_length);
1333 m->address_local_info = htonl ((uint32_t) address->local_info);
1334 m->plugin_name_length = htons (namelen);
1336 m->session_id = htonl (s);
1338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1339 "Updating address for peer `%s', plugin `%s', session %p id %u\n",
1340 GNUNET_i2s (&address->peer),
1341 address->transport_name, session, s);
1343 am = (struct GNUNET_ATS_Information *) &m[1];
1344 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1345 pm = (char *) &am[ats_count];
1346 memcpy (pm, address->address, address->address_length);
1347 memcpy (&pm[address->address_length], address->transport_name, namelen);
1348 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1355 * An address is now in use or not used any more.
1358 * @param address the address
1359 * @param session session handle, can be NULL
1360 * @param in_use GNUNET_YES if this address is now used, GNUNET_NO
1361 * if address is not used any more
1364 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
1365 const struct GNUNET_HELLO_Address *address,
1366 struct Session *session, int in_use)
1368 struct PendingMessage *p;
1369 struct AddressUseMessage *m;
1375 GNUNET_assert (NULL != address);
1377 (address->transport_name ==
1378 NULL) ? 0 : strlen (address->transport_name) + 1;
1379 msize = sizeof (struct AddressUseMessage) + address->address_length + namelen;
1380 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1381 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1382 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1388 if (session != NULL)
1390 s = find_session_id (sh, session, &address->peer);
1391 if ((s == NOT_FOUND) && (GNUNET_NO == in_use))
1393 /* trying to set unknown address to NO */
1394 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1395 "Trying to set unknown address to unused for peer `%s', plugin `%s', session %p\n",
1396 GNUNET_i2s (&address->peer), address->transport_name, session);
1400 if ((s == NOT_FOUND) && (GNUNET_YES == in_use))
1402 /* trying to set new address to YES */
1403 s = find_empty_session_slot (sh, session, &address->peer);
1404 GNUNET_assert (NOT_FOUND != s);
1408 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1410 p->is_init = GNUNET_NO;
1411 m = (struct AddressUseMessage *) &p[1];
1412 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_IN_USE);
1413 m->header.size = htons (msize);
1414 m->peer = address->peer;
1415 m->in_use = htons (in_use);
1416 m->address_length = htons (address->address_length);
1417 m->address_local_info = htonl ((uint32_t) address->local_info);
1418 m->plugin_name_length = htons (namelen);
1420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1421 "Setting address used to %s for peer `%s', plugin `%s', session %p\n",
1422 (GNUNET_YES == in_use) ? "YES" : "NO",
1423 GNUNET_i2s (&address->peer), address->transport_name, session);
1425 m->session_id = htonl (s);
1426 pm = (char *) &m[1];
1427 memcpy (pm, address->address, address->address_length);
1428 memcpy (&pm[address->address_length], address->transport_name, namelen);
1429 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1436 * A session got destroyed, stop including it as a valid address.
1439 * @param address the address
1440 * @param session session handle that is no longer valid, can be NULL
1443 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
1444 const struct GNUNET_HELLO_Address *address,
1445 struct Session *session)
1447 struct PendingMessage *p;
1448 struct AddressDestroyedMessage *m;
1454 if (address == NULL)
1460 GNUNET_assert (address->transport_name != NULL);
1461 namelen = strlen (address->transport_name) + 1;
1462 GNUNET_assert (namelen > 1);
1464 sizeof (struct AddressDestroyedMessage) + address->address_length +
1466 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1467 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1468 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1474 s = find_session_id (sh, session, &address->peer);
1475 if ((NULL != session) && (NOT_FOUND == s))
1477 /* trying to delete unknown address */
1478 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1479 "Trying to delete unknown address for peer `%s', plugin `%s', session %p\n",
1480 GNUNET_i2s (&address->peer), address->transport_name, session);
1484 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1486 p->is_init = GNUNET_NO;
1487 m = (struct AddressDestroyedMessage *) &p[1];
1488 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
1489 m->header.size = htons (msize);
1490 m->reserved = htonl (0);
1491 m->peer = address->peer;
1492 m->address_length = htons (address->address_length);
1493 m->address_local_info = htonl ((uint32_t) address->local_info);
1494 m->plugin_name_length = htons (namelen);
1496 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1497 "Deleting address for peer `%s', plugin `%s', session %p\n",
1498 GNUNET_i2s (&address->peer), address->transport_name, session);
1500 m->session_id = htonl (s);
1501 pm = (char *) &m[1];
1502 memcpy (pm, address->address, address->address_length);
1503 memcpy (&pm[address->address_length], address->transport_name, namelen);
1504 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1506 remove_session (sh, s, &address->peer);
1509 /* end of ats_api_scheduling.c */