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_performance.c
22 * @brief automatic transport selection and outbound bandwidth determination
23 * @author Christian Grothoff
24 * @author Matthias Wachs
27 #include "gnunet_ats_service.h"
32 * Message in linked list we should send to the ATS service. The
33 * actual binary message follows this struct.
41 struct PendingMessage *next;
46 struct PendingMessage *prev;
49 * Size of the message.
54 * Is this the 'ATS_START' message?
61 * Linked list of pending reservations.
63 struct GNUNET_ATS_ReservationContext
69 struct GNUNET_ATS_ReservationContext *next;
74 struct GNUNET_ATS_ReservationContext *prev;
79 struct GNUNET_PeerIdentity peer;
87 * Function to call on result.
89 GNUNET_ATS_ReservationCallback rcb;
97 * Do we need to undo this reservation if it succeeded? Set to
98 * GNUNET_YES if a reservation is cancelled. (at that point, 'info'
99 * is also set to NULL; however, info will ALSO be NULL for the
100 * reservation context that is created to undo the original request,
101 * so 'info' being NULL cannot be used to check if undo is
109 * Linked list of pending reservations.
111 struct GNUNET_ATS_AddressListHandle
117 struct GNUNET_ATS_AddressListHandle *next;
122 struct GNUNET_ATS_AddressListHandle *prev;
127 struct GNUNET_ATS_PerformanceHandle *ph;
132 GNUNET_ATS_PeerInformationCallback cb;
142 struct GNUNET_PeerIdentity peer;
145 * Return all or specific peer only
150 * Return all or used address only
155 * Request multiplexing
161 * ATS Handle to obtain and/or modify performance information.
163 struct GNUNET_ATS_PerformanceHandle
169 const struct GNUNET_CONFIGURATION_Handle *cfg;
172 * Callback to invoke on performance changes.
174 GNUNET_ATS_PeerInformationCallback infocb;
177 * Closure for 'infocb'.
182 * Connection to ATS service.
184 struct GNUNET_CLIENT_Connection *client;
187 * Head of list of messages for the ATS service.
189 struct PendingMessage *pending_head;
192 * Tail of list of messages for the ATS service
194 struct PendingMessage *pending_tail;
197 * Head of linked list of pending reservation requests.
199 struct GNUNET_ATS_ReservationContext *reservation_head;
202 * Tail of linked list of pending reservation requests.
204 struct GNUNET_ATS_ReservationContext *reservation_tail;
207 * Head of linked list of pending address list requests.
209 struct GNUNET_ATS_AddressListHandle *addresslist_head;
212 * Tail of linked list of pending address list requests.
214 struct GNUNET_ATS_AddressListHandle *addresslist_tail;
217 * Current request for transmission to ATS.
219 struct GNUNET_CLIENT_TransmitHandle *th;
222 * Task to trigger reconnect.
224 GNUNET_SCHEDULER_TaskIdentifier task;
227 * Request multiplexing
234 * Re-establish the connection to the ATS service.
236 * @param ph handle to use to re-connect.
239 reconnect (struct GNUNET_ATS_PerformanceHandle *ph);
243 * Re-establish the connection to the ATS service.
245 * @param cls handle to use to re-connect.
246 * @param tc scheduler context
249 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
251 struct GNUNET_ATS_PerformanceHandle *ph = cls;
253 ph->task = GNUNET_SCHEDULER_NO_TASK;
259 * Transmit messages from the message queue to the service
260 * (if there are any, and if we are not already trying).
262 * @param ph handle to use
265 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
269 * We can now transmit a message to ATS. Do it.
271 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
272 * @param size number of bytes we can transmit to ATS
273 * @param buf where to copy the messages
274 * @return number of bytes copied into buf
277 transmit_message_to_ats (void *cls, size_t size, void *buf)
279 struct GNUNET_ATS_PerformanceHandle *ph = cls;
280 struct PendingMessage *p;
287 while ((NULL != (p = ph->pending_head)) && (p->size <= size))
289 memcpy (&cbuf[ret], &p[1], p->size);
292 GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->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 ph handle to use
307 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph)
309 struct PendingMessage *p;
313 if (NULL == (p = ph->pending_head))
315 if (NULL == ph->client)
316 return; /* currently reconnecting */
318 GNUNET_CLIENT_notify_transmit_ready (ph->client, p->size,
319 GNUNET_TIME_UNIT_FOREVER_REL,
320 GNUNET_YES, &transmit_message_to_ats,
326 * We received a peer information message. Validate and process it.
328 * @param ph our context with the callback
329 * @param msg the message
330 * @return GNUNET_OK if the message was well-formed
333 process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
334 const struct GNUNET_MessageHeader *msg)
336 const struct PeerInformationMessage *pi;
337 const struct GNUNET_ATS_Information *atsi;
338 const char *plugin_address;
339 const char *plugin_name;
340 struct GNUNET_HELLO_Address address;
341 uint16_t plugin_address_length;
342 uint16_t plugin_name_length;
345 if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
348 return GNUNET_SYSERR;
351 pi = (const struct PeerInformationMessage *) msg;
352 ats_count = ntohl (pi->ats_count);
353 plugin_address_length = ntohs (pi->address_length);
354 plugin_name_length = ntohs (pi->plugin_name_length);
355 atsi = (const struct GNUNET_ATS_Information *) &pi[1];
356 plugin_address = (const char *) &atsi[ats_count];
357 plugin_name = &plugin_address[plugin_address_length];
358 if ((plugin_address_length + plugin_name_length +
359 ats_count * sizeof (struct GNUNET_ATS_Information) +
360 sizeof (struct PeerInformationMessage) != ntohs (msg->size)) ||
362 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
363 || (plugin_name[plugin_name_length - 1] != '\0'))
366 return GNUNET_SYSERR;
368 if (ph->infocb == NULL)
373 address.peer = pi->peer;
374 address.address = plugin_address;
375 address.address_length = plugin_address_length;
376 address.transport_name = plugin_name;
377 ph->infocb (ph->infocb_cls, &address, pi->bandwidth_out, pi->bandwidth_in,
384 * We received a reservation result message. Validate and process it.
386 * @param ph our context with the callback
387 * @param msg the message
388 * @return GNUNET_OK if the message was well-formed
391 process_rr_message (struct GNUNET_ATS_PerformanceHandle *ph,
392 const struct GNUNET_MessageHeader *msg)
394 const struct ReservationResultMessage *rr;
395 struct GNUNET_ATS_ReservationContext *rc;
398 if (ntohs (msg->size) < sizeof (struct ReservationResultMessage))
401 return GNUNET_SYSERR;
403 rr = (const struct ReservationResultMessage *) msg;
404 amount = ntohl (rr->amount);
405 rc = ph->reservation_head;
406 if (0 != memcmp (&rr->peer, &rc->peer, sizeof (struct GNUNET_PeerIdentity)))
409 return GNUNET_SYSERR;
411 GNUNET_CONTAINER_DLL_remove (ph->reservation_head, ph->reservation_tail, rc);
412 if ((amount == 0) || (rc->rcb != NULL))
414 /* tell client if not cancelled */
416 rc->rcb (rc->rcb_cls, &rr->peer, amount,
417 GNUNET_TIME_relative_ntoh (rr->res_delay));
421 /* amount non-zero, but client cancelled, consider undo! */
422 if (GNUNET_YES != rc->undo)
425 return GNUNET_OK; /* do not try to undo failed undos or negative amounts */
428 (void) GNUNET_ATS_reserve_bandwidth (ph, &rr->peer, -amount, NULL, NULL);
434 * We received a reservation result message. Validate and process it.
436 * @param ph our context with the callback
437 * @param msg the message
438 * @return GNUNET_OK if the message was well-formed
441 process_ar_message (struct GNUNET_ATS_PerformanceHandle *ph,
442 const struct GNUNET_MessageHeader *msg)
444 const struct PeerInformationMessage *pi;
445 struct GNUNET_ATS_AddressListHandle *alh;
446 struct GNUNET_ATS_AddressListHandle *next;
447 const struct GNUNET_ATS_Information *atsi;
448 const char *plugin_address;
449 const char *plugin_name;
450 struct GNUNET_HELLO_Address address;
451 struct GNUNET_PeerIdentity allzeros;
452 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
453 uint16_t plugin_address_length;
454 uint16_t plugin_name_length;
459 if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
462 return GNUNET_SYSERR;
464 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
465 _("Received %s message\n"), "ATS_ADDRESSLIST_RESPONSE");
467 pi = (const struct PeerInformationMessage *) msg;
469 ats_count = ntohl (pi->ats_count);
470 active = ntohl (pi->address_active);
471 plugin_address_length = ntohs (pi->address_length);
472 plugin_name_length = ntohs (pi->plugin_name_length);
473 atsi = (const struct GNUNET_ATS_Information *) &pi[1];
474 plugin_address = (const char *) &atsi[ats_count];
475 plugin_name = &plugin_address[plugin_address_length];
476 if ((plugin_address_length + plugin_name_length +
477 ats_count * sizeof (struct GNUNET_ATS_Information) +
478 sizeof (struct PeerInformationMessage) != ntohs (msg->size)) ||
480 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
481 || (plugin_name[plugin_name_length - 1] != '\0'))
484 return GNUNET_SYSERR;
487 next = ph->addresslist_head;
488 while (NULL != (alh = next))
497 return GNUNET_SYSERR;
500 memset (&allzeros, '\0', sizeof (allzeros));
501 if ((0 == memcmp (&allzeros, &pi->peer, sizeof (allzeros))) &&
502 (0 == plugin_name_length) &&
503 (0 == plugin_address_length) &&
507 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
508 _("Received last message for %s \n"), "ATS_ADDRESSLIST_RESPONSE");
509 bandwidth_zero.value__ = htonl (0);
511 alh->cb (ph->infocb_cls,
513 bandwidth_zero, bandwidth_zero,
515 GNUNET_CONTAINER_DLL_remove (ph->addresslist_head, ph->addresslist_tail, alh);
520 address.peer = pi->peer;
521 address.address = plugin_address;
522 address.address_length = plugin_address_length;
523 address.transport_name = plugin_name;
525 if ((GNUNET_YES == alh->all_addresses) || (GNUNET_YES == active))
528 alh->cb (ph->infocb_cls,
530 pi->bandwidth_out, pi->bandwidth_in,
538 * Type of a function to call when we receive a message
541 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
542 * @param msg message received, NULL on timeout or fatal error
545 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
547 struct GNUNET_ATS_PerformanceHandle *ph = cls;
551 switch (ntohs (msg->type))
553 case GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION:
554 if (GNUNET_OK != process_pi_message (ph, msg))
557 case GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT:
558 if (GNUNET_OK != process_rr_message (ph, msg))
561 case GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE:
562 if (GNUNET_OK != process_ar_message (ph, msg))
569 GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
570 GNUNET_TIME_UNIT_FOREVER_REL);
575 GNUNET_CLIENT_notify_transmit_ready_cancel (ph->th);
578 GNUNET_CLIENT_disconnect (ph->client);
581 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &reconnect_task,
587 * Re-establish the connection to the ATS service.
589 * @param ph handle to use to re-connect.
592 reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
594 struct PendingMessage *p;
595 struct ClientStartMessage *init;
597 GNUNET_assert (NULL == ph->client);
598 ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
599 GNUNET_assert (NULL != ph->client);
600 GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
601 GNUNET_TIME_UNIT_FOREVER_REL);
602 if ((NULL == (p = ph->pending_head)) || (GNUNET_YES != p->is_init))
604 p = GNUNET_malloc (sizeof (struct PendingMessage) +
605 sizeof (struct ClientStartMessage));
606 p->size = sizeof (struct ClientStartMessage);
607 p->is_init = GNUNET_YES;
608 init = (struct ClientStartMessage *) &p[1];
609 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
610 init->header.size = htons (sizeof (struct ClientStartMessage));
612 htonl ((ph->infocb ==
613 NULL) ? START_FLAG_PERFORMANCE_NO_PIC :
614 START_FLAG_PERFORMANCE_WITH_PIC);
615 GNUNET_CONTAINER_DLL_insert (ph->pending_head, ph->pending_tail, p);
623 * Get handle to access performance API of the ATS subsystem.
625 * @param cfg configuration to use
626 * @param infocb function to call on allocation changes, can be NULL
627 * @param infocb_cls closure for infocb
628 * @return ats performance context
630 struct GNUNET_ATS_PerformanceHandle *
631 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
632 GNUNET_ATS_PeerInformationCallback infocb,
635 struct GNUNET_ATS_PerformanceHandle *ph;
637 ph = GNUNET_malloc (sizeof (struct GNUNET_ATS_PerformanceHandle));
640 ph->infocb_cls = infocb_cls;
648 * Client is done using the ATS performance subsystem, release resources.
653 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
655 struct PendingMessage *p;
656 struct GNUNET_ATS_ReservationContext *rc;
657 struct GNUNET_ATS_AddressListHandle *alh;
659 while (NULL != (p = ph->pending_head))
661 GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->pending_tail, p);
664 while (NULL != (alh = ph->addresslist_head))
666 GNUNET_CONTAINER_DLL_remove (ph->addresslist_head, ph->addresslist_tail,
670 while (NULL != (rc = ph->reservation_head))
672 GNUNET_CONTAINER_DLL_remove (ph->reservation_head, ph->reservation_tail,
674 GNUNET_break (NULL == rc->rcb);
677 if (GNUNET_SCHEDULER_NO_TASK != ph->task)
679 GNUNET_SCHEDULER_cancel (ph->task);
680 ph->task = GNUNET_SCHEDULER_NO_TASK;
682 if (NULL != ph->client)
684 GNUNET_CLIENT_disconnect (ph->client);
692 * Reserve inbound bandwidth from the given peer. ATS will look at
693 * the current amount of traffic we receive from the peer and ensure
694 * that the peer could add 'amount' of data to its stream.
696 * @param ph performance handle
697 * @param peer identifies the peer
698 * @param amount reserve N bytes for receiving, negative
699 * amounts can be used to undo a (recent) reservation;
700 * @param rcb function to call with the resulting reservation information
701 * @param rcb_cls closure for info
702 * @return NULL on error
703 * @deprecated will be replaced soon
705 struct GNUNET_ATS_ReservationContext *
706 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
707 const struct GNUNET_PeerIdentity *peer,
709 GNUNET_ATS_ReservationCallback rcb, void *rcb_cls)
711 struct GNUNET_ATS_ReservationContext *rc;
712 struct PendingMessage *p;
713 struct ReservationRequestMessage *m;
715 rc = GNUNET_malloc (sizeof (struct GNUNET_ATS_ReservationContext));
719 rc->rcb_cls = rcb_cls;
720 if ((rcb != NULL) && (amount > 0))
721 rc->undo = GNUNET_YES;
722 GNUNET_CONTAINER_DLL_insert_tail (ph->reservation_head, ph->reservation_tail,
725 p = GNUNET_malloc (sizeof (struct PendingMessage) +
726 sizeof (struct ReservationRequestMessage));
727 p->size = sizeof (struct ReservationRequestMessage);
728 p->is_init = GNUNET_NO;
729 m = (struct ReservationRequestMessage *) &p[1];
730 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST);
731 m->header.size = htons (sizeof (struct ReservationRequestMessage));
732 m->amount = htonl (amount);
734 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
741 * Cancel request for reserving bandwidth.
743 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
746 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc)
752 * Get information about addresses known to the ATS subsystem.
754 * @param handle the performance handle to use
755 * @param peer peer idm can be NULL for all peers
756 * @param all GNUNET_YES to get information about all addresses or GNUNET_NO to
757 * get only address currently used
758 * @param infocb callback to call with the addresses,
759 * will callback with address == NULL when done
760 * @param infocb_cls closure for infocb
761 * @return ats performance context
763 struct GNUNET_ATS_AddressListHandle*
764 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
765 const struct GNUNET_PeerIdentity *peer,
767 GNUNET_ATS_PeerInformationCallback infocb,
770 struct GNUNET_ATS_AddressListHandle *alh;
771 struct PendingMessage *p;
772 struct AddressListRequestMessage *m;
774 GNUNET_assert (NULL != handle);
778 alh = GNUNET_malloc (sizeof (struct GNUNET_ATS_AddressListHandle));
779 alh->id = handle->id;
782 alh->cb_cls = infocb_cls;
784 alh->all_addresses = all;
786 alh->all_peers = GNUNET_YES;
789 alh->all_peers = GNUNET_NO;
793 GNUNET_CONTAINER_DLL_insert (handle->addresslist_head, handle->addresslist_tail, alh);
795 p = GNUNET_malloc (sizeof (struct PendingMessage) +
796 sizeof (struct AddressListRequestMessage));
797 p->size = sizeof (struct AddressListRequestMessage);
798 m = (struct AddressListRequestMessage *) &p[1];
799 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_REQUEST);
800 m->header.size = htons (sizeof (struct AddressListRequestMessage));
801 m->all = htonl (all);
802 m->id = htonl (alh->id);
807 memset (&m->peer, '\0', sizeof (struct GNUNET_PeerIdentity));
809 GNUNET_CONTAINER_DLL_insert_tail (handle->pending_head, handle->pending_tail, p);
811 do_transmit (handle);
818 * Cancel a pending address listing operation
820 * @param handle the GNUNET_ATS_AddressListHandle handle to cancel
823 GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle)
825 GNUNET_assert (NULL != handle);
827 GNUNET_CONTAINER_DLL_remove (handle->ph->addresslist_head, handle->ph->addresslist_tail, handle);
828 GNUNET_free (handle);
833 * Convert a GNUNET_ATS_PreferenceType to a string
835 * @param type the preference type
836 * @return a string or NULL if invalid
839 GNUNET_ATS_print_preference_type (uint32_t type)
841 char *prefs[GNUNET_ATS_PreferenceCount] = GNUNET_ATS_PreferenceTypeString;
842 if (type < GNUNET_ATS_PreferenceCount)
849 * Change preferences for the given peer. Preference changes are forgotten if peers
852 * @param ph performance handle
853 * @param peer identifies the peer
854 * @param ... 0-terminated specification of the desired changes
857 GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
858 const struct GNUNET_PeerIdentity *peer, ...)
860 struct PendingMessage *p;
861 struct ChangePreferenceMessage *m;
864 struct PreferenceInformation *pi;
866 enum GNUNET_ATS_PreferenceKind kind;
870 while (GNUNET_ATS_PREFERENCE_END !=
871 (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
875 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
877 (void) va_arg (ap, double);
880 case GNUNET_ATS_PREFERENCE_LATENCY:
882 (void) va_arg (ap, double);
891 count * sizeof (struct PreferenceInformation) +
892 sizeof (struct ChangePreferenceMessage);
893 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
895 p->is_init = GNUNET_NO;
896 m = (struct ChangePreferenceMessage *) &p[1];
897 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE);
898 m->header.size = htons (msize);
899 m->num_preferences = htonl (count);
901 pi = (struct PreferenceInformation *) &m[1];
904 while (GNUNET_ATS_PREFERENCE_END !=
905 (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
907 pi[count].preference_kind = htonl (kind);
910 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
911 pi[count].preference_value = (float) va_arg (ap, double);
915 case GNUNET_ATS_PREFERENCE_LATENCY:
916 pi[count].preference_value = (float) va_arg (ap, double);
925 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
929 /* end of ats_api_performance.c */