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 * ATS Handle to obtain and/or modify performance information.
111 struct GNUNET_ATS_PerformanceHandle
117 const struct GNUNET_CONFIGURATION_Handle *cfg;
120 * Callback to invoke on performance changes.
122 GNUNET_ATS_PeerInformationCallback infocb;
125 * Closure for 'infocb'.
130 * Connection to ATS service.
132 struct GNUNET_CLIENT_Connection *client;
135 * Head of list of messages for the ATS service.
137 struct PendingMessage *pending_head;
140 * Tail of list of messages for the ATS service
142 struct PendingMessage *pending_tail;
145 * Head of linked list of pending reservation requests.
147 struct GNUNET_ATS_ReservationContext *reservation_head;
150 * Tail of linked list of pending reservation requests.
152 struct GNUNET_ATS_ReservationContext *reservation_tail;
155 * Current request for transmission to ATS.
157 struct GNUNET_CLIENT_TransmitHandle *th;
160 * Task to trigger reconnect.
162 GNUNET_SCHEDULER_TaskIdentifier task;
168 * Re-establish the connection to the ATS service.
170 * @param sh handle to use to re-connect.
173 reconnect (struct GNUNET_ATS_PerformanceHandle *ph);
177 * Re-establish the connection to the ATS service.
179 * @param cls handle to use to re-connect.
180 * @param tc scheduler context
183 reconnect_task (void *cls,
184 const struct GNUNET_SCHEDULER_TaskContext *tc)
186 struct GNUNET_ATS_PerformanceHandle *ph = cls;
188 ph->task = GNUNET_SCHEDULER_NO_TASK;
194 * Transmit messages from the message queue to the service
195 * (if there are any, and if we are not already trying).
197 * @param sh handle to use
200 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
204 * We can now transmit a message to ATS. Do it.
206 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
207 * @param size number of bytes we can transmit to ATS
208 * @param buf where to copy the messages
209 * @return number of bytes copied into buf
212 transmit_message_to_ats (void *cls,
216 struct GNUNET_ATS_PerformanceHandle *ph = cls;
217 struct PendingMessage *p;
224 while ( (NULL != (p = ph->pending_head)) &&
227 memcpy (&cbuf[ret], &p[1], p->size);
230 GNUNET_CONTAINER_DLL_remove (ph->pending_head,
241 * Transmit messages from the message queue to the service
242 * (if there are any, and if we are not already trying).
244 * @param ph handle to use
247 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph)
249 struct PendingMessage *p;
253 if (NULL == (p = ph->pending_head))
255 if (NULL == ph->client)
256 return; /* currently reconnecting */
257 ph->th = GNUNET_CLIENT_notify_transmit_ready (ph->client,
259 GNUNET_TIME_UNIT_FOREVER_REL,
261 &transmit_message_to_ats, ph);
266 * We received a peer information message. Validate and process it.
268 * @param ph our context with the callback
269 * @param msg the message
270 * @return GNUNET_OK if the message was well-formed
273 process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
274 const struct GNUNET_MessageHeader *msg)
276 const struct PeerInformationMessage *pi;
277 const struct GNUNET_ATS_Information *atsi;
279 const char *plugin_name;
280 uint16_t address_length;
281 uint16_t plugin_name_length;
284 if (ph->infocb == NULL)
287 return GNUNET_SYSERR;
289 if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
292 return GNUNET_SYSERR;
294 pi = (const struct PeerInformationMessage*) msg;
295 ats_count = ntohl (pi->ats_count);
296 address_length = ntohs (pi->address_length);
297 plugin_name_length = ntohs (pi->plugin_name_length);
298 atsi = (const struct GNUNET_ATS_Information*) &pi[1];
299 address = (const char*) &atsi[ats_count];
300 plugin_name = &address[address_length];
301 if ( (address_length +
303 ats_count * sizeof (struct GNUNET_ATS_Information) +
304 sizeof (struct PeerInformationMessage) != ntohs (msg->size)) ||
305 (ats_count > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
306 (plugin_name[plugin_name_length - 1] != '\0') )
309 return GNUNET_SYSERR;
311 ph->infocb (ph->infocb_cls,
314 address, address_length,
324 * We received a reservation result message. Validate and process it.
326 * @param ph our context with the callback
327 * @param msg the message
328 * @return GNUNET_OK if the message was well-formed
331 process_rr_message (struct GNUNET_ATS_PerformanceHandle *ph,
332 const struct GNUNET_MessageHeader *msg)
334 const struct ReservationResultMessage *rr;
335 struct GNUNET_ATS_ReservationContext *rc;
338 if (ntohs (msg->size) < sizeof (struct ReservationResultMessage))
341 return GNUNET_SYSERR;
343 rr = (const struct ReservationResultMessage*) msg;
344 amount = ntohl (rr->amount);
345 rc = ph->reservation_head;
346 if (0 != memcmp (&rr->peer,
348 sizeof (struct GNUNET_PeerIdentity)))
351 return GNUNET_SYSERR;
353 GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
354 ph->reservation_tail,
356 if ( (amount == 0) ||
359 /* tell client if not cancelled */
361 rc->rcb (rc->rcb_cls,
364 GNUNET_TIME_relative_ntoh (rr->res_delay));
368 /* amount non-zero, but client cancelled, consider undo! */
369 if (GNUNET_YES != rc->undo)
372 return GNUNET_OK; /* do not try to undo failed undos or negative amounts */
375 (void) GNUNET_ATS_reserve_bandwidth (ph, &rr->peer, -amount, NULL, NULL);
381 * Type of a function to call when we receive a message
384 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
385 * @param msg message received, NULL on timeout or fatal error
388 process_ats_message (void *cls,
389 const struct GNUNET_MessageHeader *msg)
391 struct GNUNET_ATS_PerformanceHandle *ph = cls;
395 switch (ntohs (msg->type))
397 case GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION:
398 if (GNUNET_OK != process_pi_message (ph, msg))
401 case GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT:
402 if (GNUNET_OK != process_rr_message (ph, msg))
410 GNUNET_CLIENT_receive (ph->client,
411 &process_ats_message, ph,
412 GNUNET_TIME_UNIT_FOREVER_REL);
415 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
417 ph->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
418 &reconnect_task, ph);
423 * Re-establish the connection to the ATS service.
425 * @param ph handle to use to re-connect.
428 reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
430 struct PendingMessage *p;
431 struct ClientStartMessage *init;
433 GNUNET_assert (NULL == ph->client);
434 ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
435 GNUNET_assert (NULL != ph->client);
436 GNUNET_CLIENT_receive (ph->client,
437 &process_ats_message, ph,
438 GNUNET_TIME_UNIT_FOREVER_REL);
439 if ( (NULL == (p = ph->pending_head)) ||
440 (GNUNET_YES != p->is_init) )
442 p = GNUNET_malloc (sizeof (struct PendingMessage) +
443 sizeof (struct ClientStartMessage));
444 p->size = sizeof (struct ClientStartMessage);
445 p->is_init = GNUNET_YES;
446 init = (struct ClientStartMessage *) &p[1];
447 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
448 init->header.size = htons (sizeof (struct ClientStartMessage));
449 init->start_flag = htonl ((ph->infocb == NULL)
450 ? START_FLAG_PERFORMANCE_NO_PIC
451 : START_FLAG_PERFORMANCE_WITH_PIC);
452 GNUNET_CONTAINER_DLL_insert (ph->pending_head,
462 * Get handle to access performance API of the ATS subsystem.
464 * @param cfg configuration to use
465 * @param infocb function to call on allocation changes, can be NULL
466 * @param infocb_cls closure for infocb
467 * @return ats performance context
469 struct GNUNET_ATS_PerformanceHandle *
470 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
471 GNUNET_ATS_PeerInformationCallback infocb,
474 struct GNUNET_ATS_PerformanceHandle *ph;
476 ph = GNUNET_malloc (sizeof (struct GNUNET_ATS_PerformanceHandle));
479 ph->infocb_cls = infocb_cls;
486 * Client is done using the ATS performance subsystem, release resources.
491 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
493 struct PendingMessage *p;
494 struct GNUNET_ATS_ReservationContext *rc;
496 while (NULL != (p = ph->pending_head))
498 GNUNET_CONTAINER_DLL_remove (ph->pending_head,
503 while (NULL != (rc = ph->reservation_head))
505 GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
506 ph->reservation_tail,
508 GNUNET_break (NULL == rc->rcb);
511 if (GNUNET_SCHEDULER_NO_TASK != ph->task)
513 GNUNET_SCHEDULER_cancel (ph->task);
514 ph->task = GNUNET_SCHEDULER_NO_TASK;
516 if (NULL != ph->client)
518 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
526 * Reserve inbound bandwidth from the given peer. ATS will look at
527 * the current amount of traffic we receive from the peer and ensure
528 * that the peer could add 'amount' of data to its stream.
530 * @param ph performance handle
531 * @param peer identifies the peer
532 * @param amount reserve N bytes for receiving, negative
533 * amounts can be used to undo a (recent) reservation;
534 * @param rcb function to call with the resulting reservation information
535 * @param rcb_cls closure for info
536 * @return NULL on error
537 * @deprecated will be replaced soon
539 struct GNUNET_ATS_ReservationContext *
540 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
541 const struct GNUNET_PeerIdentity *peer,
543 GNUNET_ATS_ReservationCallback rcb,
546 struct GNUNET_ATS_ReservationContext *rc;
547 struct PendingMessage *p;
548 struct ReservationRequestMessage *m;
550 rc = GNUNET_malloc (sizeof (struct GNUNET_ATS_ReservationContext));
554 rc->rcb_cls = rcb_cls;
555 if ( (rcb != NULL) && (amount > 0) )
556 rc->undo = GNUNET_YES;
557 GNUNET_CONTAINER_DLL_insert_tail (ph->reservation_head,
558 ph->reservation_tail,
561 p = GNUNET_malloc (sizeof (struct PendingMessage) +
562 sizeof (struct ReservationRequestMessage));
563 p->size = sizeof (struct ReservationRequestMessage);
564 p->is_init = GNUNET_NO;
565 m = (struct ReservationRequestMessage*) &p[1];
566 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST);
567 m->header.size = htons (sizeof (struct ReservationRequestMessage));
568 m->amount = htonl (amount);
570 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head,
579 * Cancel request for reserving bandwidth.
581 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
584 GNUNET_ATS_reserve_bandwidth_cancel (struct
585 GNUNET_ATS_ReservationContext *rc)
592 * Change preferences for the given peer. Preference changes are forgotten if peers
595 * @param ph performance handle
596 * @param peer identifies the peer
597 * @param ... 0-terminated specification of the desired changes
600 GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
601 const struct GNUNET_PeerIdentity *peer,
604 struct PendingMessage *p;
605 struct ChangePreferenceMessage *m;
608 struct PreferenceInformation *pi;
610 enum GNUNET_ATS_PreferenceKind kind;
614 while (GNUNET_ATS_PREFERENCE_END != (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
618 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
620 (void) va_arg (ap, double);
622 case GNUNET_ATS_PREFERENCE_LATENCY:
624 (void) va_arg (ap, double);
631 msize = count * sizeof (struct PreferenceInformation) +
632 sizeof (struct ChangePreferenceMessage);
633 p = GNUNET_malloc (sizeof (struct PendingMessage) +
636 p->is_init = GNUNET_NO;
637 m = (struct ChangePreferenceMessage*) &p[1];
638 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE);
639 m->header.size = htons (msize);
640 m->num_preferences = htonl (count);
642 pi = (struct PreferenceInformation*) &m[1];
645 while (GNUNET_ATS_PREFERENCE_END != (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
647 pi[count].preference_kind = htonl (kind);
650 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
651 pi[count].preference_value = (float) va_arg (ap, double);
654 case GNUNET_ATS_PREFERENCE_LATENCY:
655 pi[count].preference_value = (float) va_arg (ap, double);
663 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head,
669 /* end of ats_api_performance.c */