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);
642 if (NULL == sh->suggest_cb)
645 address.peer = m->peer;
646 address.address = plugin_address;
647 address.address_length = plugin_address_length;
648 address.transport_name = plugin_name;
650 if ((s == NULL) && (0 == address.address_length))
652 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
653 "ATS returned invalid address for peer `%s' transport `%s' address length %i, session_id %i\n",
654 GNUNET_i2s (&address.peer), address.transport_name,
655 plugin_address_length, session_id);
657 GNUNET_CLIENT_receive (sh->client, &process_ats_message, sh,
658 GNUNET_TIME_UNIT_FOREVER_REL);
662 sh->suggest_cb (sh->suggest_cb_cls, &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 if ((NULL == (p = sh->pending_head)) || (GNUNET_YES != p->is_init))
688 p = GNUNET_malloc (sizeof (struct PendingMessage) +
689 sizeof (struct ClientStartMessage));
690 p->size = sizeof (struct ClientStartMessage);
691 p->is_init = GNUNET_YES;
692 init = (struct ClientStartMessage *) &p[1];
693 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
694 init->header.size = htons (sizeof (struct ClientStartMessage));
695 init->start_flag = htonl (START_FLAG_SCHEDULING);
696 GNUNET_CONTAINER_DLL_insert (sh->pending_head, sh->pending_tail, p);
703 * delete the current network list
706 delete_networks (struct GNUNET_ATS_SchedulingHandle *sh)
708 struct ATS_Network * cur = sh->net_head;
711 GNUNET_CONTAINER_DLL_remove(sh->net_head, sh->net_tail, cur);
719 interface_proc (void *cls, const char *name,
721 const struct sockaddr *
723 const struct sockaddr *
725 const struct sockaddr *
726 netmask, socklen_t addrlen)
728 struct GNUNET_ATS_SchedulingHandle * sh = cls;
729 /* Calculate network */
730 struct ATS_Network *net = NULL;
732 /* Skipping IPv4 loopback addresses since we have special check */
733 if (addr->sa_family == AF_INET)
735 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
737 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
740 /* Skipping IPv6 loopback addresses since we have special check */
741 if (addr->sa_family == AF_INET6)
743 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
744 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
748 if (addr->sa_family == AF_INET)
750 struct sockaddr_in *addr4 = (struct sockaddr_in *) addr;
751 struct sockaddr_in *netmask4 = (struct sockaddr_in *) netmask;
752 struct sockaddr_in *tmp = NULL;
753 struct sockaddr_in network4;
755 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in));
756 tmp = (struct sockaddr_in *) &net[1];
757 net->network = (struct sockaddr *) &tmp[0];
758 net->netmask = (struct sockaddr *) &tmp[1];
759 net->length = addrlen;
761 memset (&network4, 0, sizeof (network4));
762 network4.sin_family = AF_INET;
763 #if HAVE_SOCKADDR_IN_SIN_LEN
764 network4.sin_len = sizeof (network4);
766 network4.sin_addr.s_addr = (addr4->sin_addr.s_addr & netmask4->sin_addr.s_addr);
768 memcpy (net->netmask, netmask4, sizeof (struct sockaddr_in));
769 memcpy (net->network, &network4, sizeof (struct sockaddr_in));
772 if (addr->sa_family == AF_INET6)
774 struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *) addr;
775 struct sockaddr_in6 *netmask6 = (struct sockaddr_in6 *) netmask;
776 struct sockaddr_in6 * tmp = NULL;
777 struct sockaddr_in6 network6;
779 net = GNUNET_malloc(sizeof (struct ATS_Network) + 2 * sizeof (struct sockaddr_in6));
780 tmp = (struct sockaddr_in6 *) &net[1];
781 net->network = (struct sockaddr *) &tmp[0];
782 net->netmask = (struct sockaddr *) &tmp[1];
783 net->length = addrlen;
785 memset (&network6, 0, sizeof (network6));
786 network6.sin6_family = AF_INET6;
787 #if HAVE_SOCKADDR_IN_SIN_LEN
788 network6.sin6_len = sizeof (network6);
791 uint32_t *addr_elem = (uint32_t *) &addr6->sin6_addr;
792 uint32_t *mask_elem = (uint32_t *) &netmask6->sin6_addr;
793 uint32_t *net_elem = (uint32_t *) &network6.sin6_addr;
794 for (c = 0; c < 4; c++)
795 net_elem[c] = addr_elem[c] & mask_elem[c];
797 memcpy (net->netmask, netmask6, sizeof (struct sockaddr_in6));
798 memcpy (net->network, &network6, sizeof (struct sockaddr_in6));
805 char * netmask = GNUNET_strdup (GNUNET_a2s((struct sockaddr *) net->netmask, addrlen));
806 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding network `%s', netmask `%s'\n",
807 GNUNET_a2s((struct sockaddr *) net->network, addrlen),
809 GNUNET_free (netmask);
811 GNUNET_CONTAINER_DLL_insert(sh->net_head, sh->net_tail, net);
818 * Periodically get list of addresses
820 * @param tc Task context
823 get_addresses (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
825 struct GNUNET_ATS_SchedulingHandle * sh = cls;
826 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
827 delete_networks (sh);
828 GNUNET_OS_network_interfaces_list(interface_proc, sh);
829 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
835 * Convert a GNUNET_ATS_NetworkType to a string
837 * @param net the network type
838 * @return a string or NULL if invalid
841 GNUNET_ATS_print_network_type (uint32_t net)
843 char *networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
844 if (net < GNUNET_ATS_NetworkTypeCount)
845 return networks[net];
850 * Convert a ATS property to a string
852 * @param type the atsi type
853 * @return a string or NULL if invalid
856 GNUNET_ATS_print_property_type (uint32_t type)
858 char *props[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
859 if ((type > 0) && (type < GNUNET_ATS_PropertyCount))
866 * Returns where the address is located: LAN or WAN or ...
868 * @param sh the scheduling handle
869 * @param addr address
870 * @param addrlen address length
871 * @return location as GNUNET_ATS_Information
873 struct GNUNET_ATS_Information
874 GNUNET_ATS_address_get_type (struct GNUNET_ATS_SchedulingHandle * sh, const struct sockaddr * addr, socklen_t addrlen)
876 GNUNET_assert (sh != NULL);
877 struct ATS_Network * cur = sh->net_head;
879 int type = GNUNET_ATS_NET_UNSPECIFIED;
880 struct GNUNET_ATS_Information ats;
882 if (addr->sa_family == AF_UNIX)
884 type = GNUNET_ATS_NET_LOOPBACK;
887 /* IPv4 loopback check */
888 if (addr->sa_family == AF_INET)
890 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
892 if ((a4->sin_addr.s_addr & htonl(0xff000000)) == htonl (0x7f000000))
893 type = GNUNET_ATS_NET_LOOPBACK;
895 /* IPv6 loopback check */
896 if (addr->sa_family == AF_INET6)
898 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
899 if (IN6_IS_ADDR_LOOPBACK (&a6->sin6_addr))
900 type = GNUNET_ATS_NET_LOOPBACK;
903 /* Check local networks */
904 while ((cur != NULL) && (type == GNUNET_ATS_NET_UNSPECIFIED))
906 if (addrlen != cur->length)
912 if (addr->sa_family == AF_INET)
914 struct sockaddr_in * a4 = (struct sockaddr_in *) addr;
915 struct sockaddr_in * net4 = (struct sockaddr_in *) cur->network;
916 struct sockaddr_in * mask4 = (struct sockaddr_in *) cur->netmask;
918 if (((a4->sin_addr.s_addr & mask4->sin_addr.s_addr)) == net4->sin_addr.s_addr)
919 type = GNUNET_ATS_NET_LAN;
921 if (addr->sa_family == AF_INET6)
923 struct sockaddr_in6 * a6 = (struct sockaddr_in6 *) addr;
924 struct sockaddr_in6 * net6 = (struct sockaddr_in6 *) cur->network;
925 struct sockaddr_in6 * mask6 = (struct sockaddr_in6 *) cur->netmask;
927 int res = GNUNET_YES;
929 uint32_t *addr_elem = (uint32_t *) &a6->sin6_addr;
930 uint32_t *mask_elem = (uint32_t *) &mask6->sin6_addr;
931 uint32_t *net_elem = (uint32_t *) &net6->sin6_addr;
932 for (c = 0; c < 4; c++)
933 if ((addr_elem[c] & mask_elem[c]) != net_elem[c])
936 if (res == GNUNET_YES)
937 type = GNUNET_ATS_NET_LAN;
942 /* no local network found for this address, default: WAN */
943 if (type == GNUNET_ATS_NET_UNSPECIFIED)
944 type = GNUNET_ATS_NET_WAN;
945 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
946 ats.value = htonl (type);
948 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-scheduling-api",
949 "`%s' is in network `%s'\n",
950 GNUNET_a2s ((const struct sockaddr *) addr, addrlen),
951 GNUNET_ATS_print_network_type(type));
957 * Initialize the ATS subsystem.
959 * @param cfg configuration to use
960 * @param suggest_cb notification to call whenever the suggestation changed
961 * @param suggest_cb_cls closure for 'suggest_cb'
962 * @return ats context
964 struct GNUNET_ATS_SchedulingHandle *
965 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
966 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
967 void *suggest_cb_cls)
969 struct GNUNET_ATS_SchedulingHandle *sh;
971 sh = GNUNET_malloc (sizeof (struct GNUNET_ATS_SchedulingHandle));
973 sh->suggest_cb = suggest_cb;
974 sh->suggest_cb_cls = suggest_cb_cls;
975 GNUNET_array_grow (sh->session_array, sh->session_array_size, 4);
976 GNUNET_OS_network_interfaces_list(interface_proc, sh);
977 sh->interface_task = GNUNET_SCHEDULER_add_delayed (INTERFACE_PROCESSING_INTERVALL,
986 * Client is done with ATS scheduling, release resources.
988 * @param sh handle to release
991 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
993 struct PendingMessage *p;
994 struct GNUNET_ATS_SuggestHandle *cur;
995 struct GNUNET_ATS_SuggestHandle *next;
996 while (NULL != (p = sh->pending_head))
998 GNUNET_CONTAINER_DLL_remove (sh->pending_head, sh->pending_tail, p);
1001 if (NULL != sh->client)
1003 GNUNET_CLIENT_disconnect (sh->client);
1006 if (GNUNET_SCHEDULER_NO_TASK != sh->task)
1008 GNUNET_SCHEDULER_cancel (sh->task);
1009 sh->task = GNUNET_SCHEDULER_NO_TASK;
1012 next = sh->sug_head;
1013 while (NULL != (cur = next))
1016 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, cur);
1020 delete_networks (sh);
1021 if (sh->interface_task != GNUNET_SCHEDULER_NO_TASK)
1023 GNUNET_SCHEDULER_cancel(sh->interface_task);
1024 sh->interface_task = GNUNET_SCHEDULER_NO_TASK;
1026 GNUNET_array_grow (sh->session_array, sh->session_array_size, 0);
1032 * We would like to reset the address suggestion block time for this
1036 * @param peer identity of the peer we want to reset
1039 GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
1040 const struct GNUNET_PeerIdentity *peer)
1042 struct PendingMessage *p;
1043 struct ResetBackoffMessage *m;
1045 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1046 sizeof (struct ResetBackoffMessage));
1047 p->size = sizeof (struct ResetBackoffMessage);
1048 p->is_init = GNUNET_NO;
1049 m = (struct ResetBackoffMessage *) &p[1];
1050 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESET_BACKOFF);
1051 m->header.size = htons (sizeof (struct ResetBackoffMessage));
1052 m->reserved = htonl (0);
1054 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1059 * We would like to establish a new connection with a peer. ATS
1060 * should suggest a good address to begin with.
1063 * @param peer identity of the peer we need an address for
1064 * @return suggest handle
1066 struct GNUNET_ATS_SuggestHandle *
1067 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
1068 const struct GNUNET_PeerIdentity *peer)
1070 struct PendingMessage *p;
1071 struct RequestAddressMessage *m;
1072 struct GNUNET_ATS_SuggestHandle *s;
1074 // FIXME: ATS needs to remember this in case of
1076 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1077 sizeof (struct RequestAddressMessage));
1078 p->size = sizeof (struct RequestAddressMessage);
1079 p->is_init = GNUNET_NO;
1080 m = (struct RequestAddressMessage *) &p[1];
1081 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
1082 m->header.size = htons (sizeof (struct RequestAddressMessage));
1083 m->reserved = htonl (0);
1085 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1087 s = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestHandle));
1089 GNUNET_CONTAINER_DLL_insert_tail (sh->sug_head, sh->sug_tail, s);
1095 * We would like to stop receiving address updates for this peer
1098 * @param peer identity of the peer
1101 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SchedulingHandle *sh,
1102 const struct GNUNET_PeerIdentity *peer)
1104 struct PendingMessage *p;
1105 struct RequestAddressMessage *m;
1106 struct GNUNET_ATS_SuggestHandle *s;
1108 for (s = sh->sug_head; NULL != s; s = s->next)
1109 if (0 == memcmp(peer, &s->id, sizeof (s->id)))
1118 GNUNET_CONTAINER_DLL_remove (sh->sug_head, sh->sug_tail, s);
1122 p = GNUNET_malloc (sizeof (struct PendingMessage) +
1123 sizeof (struct RequestAddressMessage));
1124 p->size = sizeof (struct RequestAddressMessage);
1125 p->is_init = GNUNET_NO;
1126 m = (struct RequestAddressMessage *) &p[1];
1127 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS_CANCEL);
1128 m->header.size = htons (sizeof (struct RequestAddressMessage));
1129 m->reserved = htonl (0);
1131 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1137 * Test if a address and a session is known to ATS
1139 * @param sh the scheduling handle
1140 * @param address the address
1141 * @param session the session
1142 * @return GNUNET_YES or GNUNET_NO
1145 GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
1146 const struct GNUNET_HELLO_Address *address,
1147 struct Session *session)
1150 if (NULL != session)
1152 if (NOT_FOUND != (s = find_session_id (sh, session, &address->peer)))
1163 * We have a new address ATS should know. Addresses have to be added with this
1164 * function before they can be: updated, set in use and destroyed
1167 * @param address the address
1168 * @param session session handle, can be NULL
1169 * @param ats performance data for the address
1170 * @param ats_count number of performance records in 'ats'
1171 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1174 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
1175 const struct GNUNET_HELLO_Address *address,
1176 struct Session *session,
1177 const struct GNUNET_ATS_Information *ats,
1181 struct PendingMessage *p;
1182 struct AddressUpdateMessage *m;
1183 struct GNUNET_ATS_Information *am;
1189 if (address == NULL)
1192 return GNUNET_SYSERR;
1196 (address->transport_name ==
1197 NULL) ? 0 : strlen (address->transport_name) + 1;
1199 sizeof (struct AddressUpdateMessage) + address->address_length +
1200 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1201 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1202 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1203 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1205 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1208 return GNUNET_SYSERR;
1211 if (NULL != session)
1213 if (NOT_FOUND != (s = find_session_id (sh, session, &address->peer)))
1215 /* Already existing, nothing todo */
1216 return GNUNET_SYSERR;
1218 s = find_empty_session_slot (sh, session, &address->peer);
1219 GNUNET_break (NOT_FOUND != s);
1222 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1224 p->is_init = GNUNET_NO;
1225 m = (struct AddressUpdateMessage *) &p[1];
1226 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
1227 m->header.size = htons (msize);
1228 m->ats_count = htonl (ats_count);
1229 m->peer = address->peer;
1230 m->address_length = htons (address->address_length);
1231 m->plugin_name_length = htons (namelen);
1232 m->session_id = htonl (s);
1234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1235 "Adding address for peer `%s', plugin `%s', session %p id %u\n",
1236 GNUNET_i2s (&address->peer),
1237 address->transport_name, session, s);
1239 am = (struct GNUNET_ATS_Information *) &m[1];
1240 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1241 pm = (char *) &am[ats_count];
1242 memcpy (pm, address->address, address->address_length);
1243 if (NULL != address->transport_name)
1244 memcpy (&pm[address->address_length], address->transport_name, namelen);
1245 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1253 * We have updated performance statistics for a given address. Note
1254 * that this function can be called for addresses that are currently
1255 * in use as well as addresses that are valid but not actively in use.
1256 * Furthermore, the peer may not even be connected to us right now (in
1257 * which case the call may be ignored or the information may be stored
1258 * for later use). Update bandwidth assignments.
1261 * @param address the address
1262 * @param session session handle, can be NULL
1263 * @param ats performance data for the address
1264 * @param ats_count number of performance records in 'ats'
1265 * @return GNUNET_YES on success, GNUNET_NO if address or session are unknown,
1266 * GNUNET_SYSERR on hard failure
1269 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
1270 const struct GNUNET_HELLO_Address *address,
1271 struct Session *session,
1272 const struct GNUNET_ATS_Information *ats,
1275 struct PendingMessage *p;
1276 struct AddressUpdateMessage *m;
1277 struct GNUNET_ATS_Information *am;
1283 if (NULL == address)
1286 return GNUNET_SYSERR;
1291 return GNUNET_SYSERR;
1294 namelen = (address->transport_name ==
1295 NULL) ? 0 : strlen (address->transport_name) + 1;
1297 sizeof (struct AddressUpdateMessage) + address->address_length +
1298 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
1299 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1300 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1301 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1303 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)))
1306 return GNUNET_SYSERR;
1309 if (NULL != session)
1311 s = find_session_id (sh, session, &address->peer);
1316 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1318 p->is_init = GNUNET_NO;
1319 m = (struct AddressUpdateMessage *) &p[1];
1320 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
1321 m->header.size = htons (msize);
1322 m->ats_count = htonl (ats_count);
1323 m->peer = address->peer;
1324 m->address_length = htons (address->address_length);
1325 m->plugin_name_length = htons (namelen);
1327 m->session_id = htonl (s);
1329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1330 "Updating address for peer `%s', plugin `%s', session %p id %u\n",
1331 GNUNET_i2s (&address->peer),
1332 address->transport_name, session, s);
1334 am = (struct GNUNET_ATS_Information *) &m[1];
1335 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
1336 pm = (char *) &am[ats_count];
1337 memcpy (pm, address->address, address->address_length);
1338 memcpy (&pm[address->address_length], address->transport_name, namelen);
1339 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1346 * An address is now in use or not used any more.
1349 * @param address the address
1350 * @param session session handle, can be NULL
1351 * @param in_use GNUNET_YES if this address is now used, GNUNET_NO
1352 * if address is not used any more
1355 GNUNET_ATS_address_in_use (struct GNUNET_ATS_SchedulingHandle *sh,
1356 const struct GNUNET_HELLO_Address *address,
1357 struct Session *session, int in_use)
1359 struct PendingMessage *p;
1360 struct AddressUseMessage *m;
1366 GNUNET_assert (NULL != address);
1368 (address->transport_name ==
1369 NULL) ? 0 : strlen (address->transport_name) + 1;
1370 msize = sizeof (struct AddressUseMessage) + address->address_length + namelen;
1371 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1372 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1373 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1379 if (session != NULL)
1381 s = find_session_id (sh, session, &address->peer);
1382 if ((s == NOT_FOUND) && (GNUNET_NO == in_use))
1384 /* trying to set unknown address to NO */
1385 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1386 "Trying to set unknown address to unused for peer `%s', plugin `%s', session %p\n",
1387 GNUNET_i2s (&address->peer), address->transport_name, session);
1391 if ((s == NOT_FOUND) && (GNUNET_YES == in_use))
1393 /* trying to set new address to YES */
1394 s = find_empty_session_slot (sh, session, &address->peer);
1395 GNUNET_assert (NOT_FOUND != s);
1399 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1401 p->is_init = GNUNET_NO;
1402 m = (struct AddressUseMessage *) &p[1];
1403 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_IN_USE);
1404 m->header.size = htons (msize);
1405 m->peer = address->peer;
1406 m->in_use = htons (in_use);
1407 m->address_length = htons (address->address_length);
1408 m->plugin_name_length = htons (namelen);
1410 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1411 "Setting address used to %s for peer `%s', plugin `%s', session %p\n",
1412 (GNUNET_YES == in_use) ? "YES" : "NO",
1413 GNUNET_i2s (&address->peer), address->transport_name, session);
1415 m->session_id = htonl (s);
1416 pm = (char *) &m[1];
1417 memcpy (pm, address->address, address->address_length);
1418 memcpy (&pm[address->address_length], address->transport_name, namelen);
1419 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1426 * A session got destroyed, stop including it as a valid address.
1429 * @param address the address
1430 * @param session session handle that is no longer valid, can be NULL
1433 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
1434 const struct GNUNET_HELLO_Address *address,
1435 struct Session *session)
1437 struct PendingMessage *p;
1438 struct AddressDestroyedMessage *m;
1444 if (address == NULL)
1450 GNUNET_assert (address->transport_name != NULL);
1451 namelen = strlen (address->transport_name) + 1;
1452 GNUNET_assert (namelen > 1);
1454 sizeof (struct AddressDestroyedMessage) + address->address_length +
1456 if ((msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1457 (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
1458 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
1464 s = find_session_id (sh, session, &address->peer);
1465 if ((NULL != session) && (NOT_FOUND == s))
1467 /* trying to delete unknown address */
1468 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1469 "Trying to delete unknown address for peer `%s', plugin `%s', session %p\n",
1470 GNUNET_i2s (&address->peer), address->transport_name, session);
1474 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
1476 p->is_init = GNUNET_NO;
1477 m = (struct AddressDestroyedMessage *) &p[1];
1478 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
1479 m->header.size = htons (msize);
1480 m->reserved = htonl (0);
1481 m->peer = address->peer;
1482 m->address_length = htons (address->address_length);
1483 m->plugin_name_length = htons (namelen);
1485 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1486 "Deleting address for peer `%s', plugin `%s', session %p\n",
1487 GNUNET_i2s (&address->peer), address->transport_name, session);
1489 m->session_id = htonl (s);
1490 pm = (char *) &m[1];
1491 memcpy (pm, address->address, address->address_length);
1492 memcpy (&pm[address->address_length], address->transport_name, namelen);
1493 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head, sh->pending_tail, p);
1495 remove_session (sh, s, &address->peer);
1498 /* end of ats_api_scheduling.c */