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 ph 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, const struct GNUNET_SCHEDULER_TaskContext *tc)
185 struct GNUNET_ATS_PerformanceHandle *ph = cls;
187 ph->task = GNUNET_SCHEDULER_NO_TASK;
193 * Transmit messages from the message queue to the service
194 * (if there are any, and if we are not already trying).
196 * @param ph handle to use
199 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
203 * We can now transmit a message to ATS. Do it.
205 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
206 * @param size number of bytes we can transmit to ATS
207 * @param buf where to copy the messages
208 * @return number of bytes copied into buf
211 transmit_message_to_ats (void *cls, size_t size, void *buf)
213 struct GNUNET_ATS_PerformanceHandle *ph = cls;
214 struct PendingMessage *p;
221 while ((NULL != (p = ph->pending_head)) && (p->size <= size))
223 memcpy (&cbuf[ret], &p[1], p->size);
226 GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->pending_tail, p);
235 * Transmit messages from the message queue to the service
236 * (if there are any, and if we are not already trying).
238 * @param ph handle to use
241 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph)
243 struct PendingMessage *p;
247 if (NULL == (p = ph->pending_head))
249 if (NULL == ph->client)
250 return; /* currently reconnecting */
252 GNUNET_CLIENT_notify_transmit_ready (ph->client, p->size,
253 GNUNET_TIME_UNIT_FOREVER_REL,
254 GNUNET_YES, &transmit_message_to_ats,
260 * We received a peer information message. Validate and process it.
262 * @param ph our context with the callback
263 * @param msg the message
264 * @return GNUNET_OK if the message was well-formed
267 process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
268 const struct GNUNET_MessageHeader *msg)
270 const struct PeerInformationMessage *pi;
271 const struct GNUNET_ATS_Information *atsi;
272 const char *plugin_address;
273 const char *plugin_name;
274 struct GNUNET_HELLO_Address address;
275 uint16_t plugin_address_length;
276 uint16_t plugin_name_length;
279 if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
282 return GNUNET_SYSERR;
284 pi = (const struct PeerInformationMessage *) msg;
285 ats_count = ntohl (pi->ats_count);
286 plugin_address_length = ntohs (pi->address_length);
287 plugin_name_length = ntohs (pi->plugin_name_length);
288 atsi = (const struct GNUNET_ATS_Information *) &pi[1];
289 plugin_address = (const char *) &atsi[ats_count];
290 plugin_name = &plugin_address[plugin_address_length];
291 if ((plugin_address_length + plugin_name_length +
292 ats_count * sizeof (struct GNUNET_ATS_Information) +
293 sizeof (struct PeerInformationMessage) != ntohs (msg->size)) ||
295 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
296 || (plugin_name[plugin_name_length - 1] != '\0'))
299 return GNUNET_SYSERR;
301 if (ph->infocb == NULL)
305 address.peer = pi->peer;
306 address.address = plugin_address;
307 address.address_length = plugin_address_length;
308 address.transport_name = plugin_name;
309 ph->infocb (ph->infocb_cls, &address, pi->bandwidth_out, pi->bandwidth_in,
316 * We received a reservation result message. Validate and process it.
318 * @param ph our context with the callback
319 * @param msg the message
320 * @return GNUNET_OK if the message was well-formed
323 process_rr_message (struct GNUNET_ATS_PerformanceHandle *ph,
324 const struct GNUNET_MessageHeader *msg)
326 const struct ReservationResultMessage *rr;
327 struct GNUNET_ATS_ReservationContext *rc;
330 if (ntohs (msg->size) < sizeof (struct ReservationResultMessage))
333 return GNUNET_SYSERR;
335 rr = (const struct ReservationResultMessage *) msg;
336 amount = ntohl (rr->amount);
337 rc = ph->reservation_head;
338 if (0 != memcmp (&rr->peer, &rc->peer, sizeof (struct GNUNET_PeerIdentity)))
341 return GNUNET_SYSERR;
343 GNUNET_CONTAINER_DLL_remove (ph->reservation_head, ph->reservation_tail, rc);
344 if ((amount == 0) || (rc->rcb != NULL))
346 /* tell client if not cancelled */
348 rc->rcb (rc->rcb_cls, &rr->peer, amount,
349 GNUNET_TIME_relative_ntoh (rr->res_delay));
353 /* amount non-zero, but client cancelled, consider undo! */
354 if (GNUNET_YES != rc->undo)
357 return GNUNET_OK; /* do not try to undo failed undos or negative amounts */
360 (void) GNUNET_ATS_reserve_bandwidth (ph, &rr->peer, -amount, NULL, NULL);
366 * Type of a function to call when we receive a message
369 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
370 * @param msg message received, NULL on timeout or fatal error
373 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
375 struct GNUNET_ATS_PerformanceHandle *ph = cls;
379 switch (ntohs (msg->type))
381 case GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION:
382 if (GNUNET_OK != process_pi_message (ph, msg))
385 case GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT:
386 if (GNUNET_OK != process_rr_message (ph, msg))
393 GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
394 GNUNET_TIME_UNIT_FOREVER_REL);
399 GNUNET_CLIENT_notify_transmit_ready_cancel (ph->th);
402 GNUNET_CLIENT_disconnect (ph->client);
405 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &reconnect_task,
411 * Re-establish the connection to the ATS service.
413 * @param ph handle to use to re-connect.
416 reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
418 struct PendingMessage *p;
419 struct ClientStartMessage *init;
421 GNUNET_assert (NULL == ph->client);
422 ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
423 GNUNET_assert (NULL != ph->client);
424 GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
425 GNUNET_TIME_UNIT_FOREVER_REL);
426 if ((NULL == (p = ph->pending_head)) || (GNUNET_YES != p->is_init))
428 p = GNUNET_malloc (sizeof (struct PendingMessage) +
429 sizeof (struct ClientStartMessage));
430 p->size = sizeof (struct ClientStartMessage);
431 p->is_init = GNUNET_YES;
432 init = (struct ClientStartMessage *) &p[1];
433 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
434 init->header.size = htons (sizeof (struct ClientStartMessage));
436 htonl ((ph->infocb ==
437 NULL) ? START_FLAG_PERFORMANCE_NO_PIC :
438 START_FLAG_PERFORMANCE_WITH_PIC);
439 GNUNET_CONTAINER_DLL_insert (ph->pending_head, ph->pending_tail, p);
447 * Get handle to access performance API of the ATS subsystem.
449 * @param cfg configuration to use
450 * @param infocb function to call on allocation changes, can be NULL
451 * @param infocb_cls closure for infocb
452 * @return ats performance context
454 struct GNUNET_ATS_PerformanceHandle *
455 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
456 GNUNET_ATS_PeerInformationCallback infocb,
459 struct GNUNET_ATS_PerformanceHandle *ph;
461 ph = GNUNET_malloc (sizeof (struct GNUNET_ATS_PerformanceHandle));
464 ph->infocb_cls = infocb_cls;
471 * Client is done using the ATS performance subsystem, release resources.
476 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
478 struct PendingMessage *p;
479 struct GNUNET_ATS_ReservationContext *rc;
481 while (NULL != (p = ph->pending_head))
483 GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->pending_tail, p);
486 while (NULL != (rc = ph->reservation_head))
488 GNUNET_CONTAINER_DLL_remove (ph->reservation_head, ph->reservation_tail,
490 GNUNET_break (NULL == rc->rcb);
493 if (GNUNET_SCHEDULER_NO_TASK != ph->task)
495 GNUNET_SCHEDULER_cancel (ph->task);
496 ph->task = GNUNET_SCHEDULER_NO_TASK;
498 if (NULL != ph->client)
500 GNUNET_CLIENT_disconnect (ph->client);
508 * Reserve inbound bandwidth from the given peer. ATS will look at
509 * the current amount of traffic we receive from the peer and ensure
510 * that the peer could add 'amount' of data to its stream.
512 * @param ph performance handle
513 * @param peer identifies the peer
514 * @param amount reserve N bytes for receiving, negative
515 * amounts can be used to undo a (recent) reservation;
516 * @param rcb function to call with the resulting reservation information
517 * @param rcb_cls closure for info
518 * @return NULL on error
519 * @deprecated will be replaced soon
521 struct GNUNET_ATS_ReservationContext *
522 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
523 const struct GNUNET_PeerIdentity *peer,
525 GNUNET_ATS_ReservationCallback rcb, void *rcb_cls)
527 struct GNUNET_ATS_ReservationContext *rc;
528 struct PendingMessage *p;
529 struct ReservationRequestMessage *m;
531 rc = GNUNET_malloc (sizeof (struct GNUNET_ATS_ReservationContext));
535 rc->rcb_cls = rcb_cls;
536 if ((rcb != NULL) && (amount > 0))
537 rc->undo = GNUNET_YES;
538 GNUNET_CONTAINER_DLL_insert_tail (ph->reservation_head, ph->reservation_tail,
541 p = GNUNET_malloc (sizeof (struct PendingMessage) +
542 sizeof (struct ReservationRequestMessage));
543 p->size = sizeof (struct ReservationRequestMessage);
544 p->is_init = GNUNET_NO;
545 m = (struct ReservationRequestMessage *) &p[1];
546 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST);
547 m->header.size = htons (sizeof (struct ReservationRequestMessage));
548 m->amount = htonl (amount);
550 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
557 * Cancel request for reserving bandwidth.
559 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
562 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc)
569 * Change preferences for the given peer. Preference changes are forgotten if peers
572 * @param ph performance handle
573 * @param peer identifies the peer
574 * @param ... 0-terminated specification of the desired changes
577 GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
578 const struct GNUNET_PeerIdentity *peer, ...)
580 struct PendingMessage *p;
581 struct ChangePreferenceMessage *m;
584 struct PreferenceInformation *pi;
586 enum GNUNET_ATS_PreferenceKind kind;
590 while (GNUNET_ATS_PREFERENCE_END !=
591 (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
595 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
597 (void) va_arg (ap, double);
600 case GNUNET_ATS_PREFERENCE_LATENCY:
602 (void) va_arg (ap, double);
611 count * sizeof (struct PreferenceInformation) +
612 sizeof (struct ChangePreferenceMessage);
613 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
615 p->is_init = GNUNET_NO;
616 m = (struct ChangePreferenceMessage *) &p[1];
617 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE);
618 m->header.size = htons (msize);
619 m->num_preferences = htonl (count);
621 pi = (struct PreferenceInformation *) &m[1];
624 while (GNUNET_ATS_PREFERENCE_END !=
625 (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
627 pi[count].preference_kind = htonl (kind);
630 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
631 pi[count].preference_value = (float) va_arg (ap, double);
635 case GNUNET_ATS_PREFERENCE_LATENCY:
636 pi[count].preference_value = (float) va_arg (ap, double);
645 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
649 /* end of ats_api_performance.c */