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;
163 * Re-establish the connection to the ATS service.
165 * @param sh handle to use to re-connect.
168 reconnect (struct GNUNET_ATS_PerformanceHandle *ph);
172 * Transmit messages from the message queue to the service
173 * (if there are any, and if we are not already trying).
175 * @param sh handle to use
178 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
182 * We can now transmit a message to ATS. Do it.
184 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
185 * @param size number of bytes we can transmit to ATS
186 * @param buf where to copy the messages
187 * @return number of bytes copied into buf
190 transmit_message_to_ats (void *cls,
194 struct GNUNET_ATS_PerformanceHandle *ph = cls;
195 struct PendingMessage *p;
202 while ( (NULL != (p = ph->pending_head)) &&
205 memcpy (&cbuf[ret], &p[1], p->size);
208 GNUNET_CONTAINER_DLL_remove (ph->pending_head,
219 * Transmit messages from the message queue to the service
220 * (if there are any, and if we are not already trying).
222 * @param ph handle to use
225 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph)
227 struct PendingMessage *p;
231 if (NULL == (p = ph->pending_head))
233 ph->th = GNUNET_CLIENT_notify_transmit_ready (ph->client,
235 GNUNET_TIME_UNIT_FOREVER_REL,
237 &transmit_message_to_ats, ph);
242 * We received a peer information message. Validate and process it.
244 * @param ph our context with the callback
245 * @param msg the message
246 * @return GNUNET_OK if the message was well-formed
249 process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
250 const struct GNUNET_MessageHeader *msg)
252 const struct PeerInformationMessage *pi;
253 const struct GNUNET_TRANSPORT_ATS_Information *atsi;
255 const char *plugin_name;
256 uint16_t address_length;
257 uint16_t plugin_name_length;
260 if (ph->infocb == NULL)
263 return GNUNET_SYSERR;
265 if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
268 return GNUNET_SYSERR;
270 pi = (const struct PeerInformationMessage*) msg;
271 ats_count = ntohl (pi->ats_count);
272 address_length = ntohs (pi->address_length);
273 plugin_name_length = ntohs (pi->plugin_name_length);
274 atsi = (const struct GNUNET_TRANSPORT_ATS_Information*) &pi[1];
275 address = (const char*) &atsi[ats_count];
276 plugin_name = &address[address_length];
277 if ( (address_length +
279 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) +
280 sizeof (struct PeerInformationMessage) != ntohs (msg->size)) ||
281 (ats_count > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
282 (plugin_name[plugin_name_length - 1] != '\0') )
285 return GNUNET_SYSERR;
287 ph->infocb (ph->infocb_cls,
290 address, address_length,
300 * We received a reservation result message. Validate and process it.
302 * @param ph our context with the callback
303 * @param msg the message
304 * @return GNUNET_OK if the message was well-formed
307 process_rr_message (struct GNUNET_ATS_PerformanceHandle *ph,
308 const struct GNUNET_MessageHeader *msg)
310 const struct ReservationResultMessage *rr;
311 struct GNUNET_ATS_ReservationContext *rc;
314 if (ph->infocb == NULL)
317 return GNUNET_SYSERR;
319 if (ntohs (msg->size) < sizeof (struct ReservationResultMessage))
322 return GNUNET_SYSERR;
324 rr = (const struct ReservationResultMessage*) msg;
325 amount = ntohl (rr->amount);
326 rc = ph->reservation_head;
327 if (0 != memcmp (&rr->peer,
329 sizeof (struct GNUNET_PeerIdentity)))
332 return GNUNET_SYSERR;
334 GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
335 ph->reservation_tail,
337 if ( (amount == 0) ||
340 /* tell client if not cancelled */
342 rc->rcb (rc->rcb_cls,
345 GNUNET_TIME_relative_ntoh (rr->res_delay));
349 /* amount non-zero, but client cancelled, consider undo! */
350 if (GNUNET_YES != rc->undo)
353 return GNUNET_OK; /* do not try to undo failed undos or negative amounts */
356 (void) GNUNET_ATS_reserve_bandwidth (ph, &rr->peer, -amount, NULL, NULL);
362 * Type of a function to call when we receive a message
365 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
366 * @param msg message received, NULL on timeout or fatal error
369 process_ats_message (void *cls,
370 const struct GNUNET_MessageHeader *msg)
372 struct GNUNET_ATS_PerformanceHandle *ph = cls;
376 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
381 switch (ntohs (msg->type))
383 case GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION:
384 if (GNUNET_OK != process_pi_message (ph, msg))
386 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
392 case GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT:
393 if (GNUNET_OK != process_rr_message (ph, msg))
395 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
403 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
408 GNUNET_CLIENT_receive (ph->client,
409 &process_ats_message, ph,
410 GNUNET_TIME_UNIT_FOREVER_REL);
415 * Re-establish the connection to the ATS service.
417 * @param ph handle to use to re-connect.
420 reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
422 struct PendingMessage *p;
423 struct ClientStartMessage *init;
425 GNUNET_assert (NULL == ph->client);
426 ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
427 GNUNET_assert (NULL != ph->client);
428 GNUNET_CLIENT_receive (ph->client,
429 &process_ats_message, ph,
430 GNUNET_TIME_UNIT_FOREVER_REL);
431 if ( (NULL == (p = ph->pending_head)) ||
432 (GNUNET_YES != p->is_init) )
434 p = GNUNET_malloc (sizeof (struct PendingMessage) +
435 sizeof (struct ClientStartMessage));
436 p->size = sizeof (struct ClientStartMessage);
437 p->is_init = GNUNET_YES;
438 init = (struct ClientStartMessage *) &p[1];
439 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
440 init->header.size = htons (sizeof (struct ClientStartMessage));
441 init->start_flag = htonl ((ph->infocb == NULL)
442 ? START_FLAG_PERFORMANCE_NO_PIC
443 : START_FLAG_PERFORMANCE_WITH_PIC);
444 GNUNET_CONTAINER_DLL_insert (ph->pending_head,
454 * Get handle to access performance API of the ATS subsystem.
456 * @param cfg configuration to use
457 * @param infocb function to call on allocation changes, can be NULL
458 * @param infocb_cls closure for infocb
459 * @return ats performance context
461 struct GNUNET_ATS_PerformanceHandle *
462 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
463 GNUNET_ATS_PeerInformationCallback infocb,
466 struct GNUNET_ATS_PerformanceHandle *ph;
468 ph = GNUNET_malloc (sizeof (struct GNUNET_ATS_PerformanceHandle));
471 ph->infocb_cls = infocb_cls;
478 * Client is done using the ATS performance subsystem, release resources.
483 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
485 struct PendingMessage *p;
486 struct GNUNET_ATS_ReservationContext *rc;
488 while (NULL != (p = ph->pending_head))
490 GNUNET_CONTAINER_DLL_remove (ph->pending_head,
495 while (NULL != (rc = ph->reservation_head))
497 GNUNET_CONTAINER_DLL_remove (ph->reservation_head,
498 ph->reservation_tail,
500 GNUNET_break (NULL == rc->rcb);
503 GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
509 * Reserve inbound bandwidth from the given peer. ATS will look at
510 * the current amount of traffic we receive from the peer and ensure
511 * that the peer could add 'amount' of data to its stream.
513 * @param ph performance handle
514 * @param peer identifies the peer
515 * @param amount reserve N bytes for receiving, negative
516 * amounts can be used to undo a (recent) reservation;
517 * @param rcb function to call with the resulting reservation information
518 * @param rcb_cls closure for info
519 * @return NULL on error
520 * @deprecated will be replaced soon
522 struct GNUNET_ATS_ReservationContext *
523 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
524 const struct GNUNET_PeerIdentity *peer,
526 GNUNET_ATS_ReservationCallback rcb,
529 struct GNUNET_ATS_ReservationContext *rc;
530 struct PendingMessage *p;
531 struct ReservationRequestMessage *m;
533 rc = GNUNET_malloc (sizeof (struct GNUNET_ATS_ReservationContext));
537 rc->rcb_cls = rcb_cls;
538 if ( (rcb != NULL) && (amount > 0) )
539 rc->undo = GNUNET_YES;
540 GNUNET_CONTAINER_DLL_insert_tail (ph->reservation_head,
541 ph->reservation_tail,
544 p = GNUNET_malloc (sizeof (struct PendingMessage) +
545 sizeof (struct ReservationRequestMessage));
546 p->size = sizeof (struct ReservationRequestMessage);
547 p->is_init = GNUNET_NO;
548 m = (struct ReservationRequestMessage*) &p[1];
549 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
550 m->header.size = htons (sizeof (struct ReservationRequestMessage));
551 m->amount = htonl (amount);
553 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head,
561 * Cancel request for reserving bandwidth.
563 * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
566 GNUNET_ATS_reserve_bandwidth_cancel (struct
567 GNUNET_ATS_ReservationContext *rc)
574 * Change preferences for the given peer. Preference changes are forgotten if peers
577 * @param ph performance handle
578 * @param peer identifies the peer
579 * @param ... 0-terminated specification of the desired changes
582 GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
583 const struct GNUNET_PeerIdentity *peer,
586 struct PendingMessage *p;
587 struct ChangePreferenceMessage *m;
590 struct PreferenceInformation *pi;
592 enum GNUNET_ATS_PreferenceKind kind;
596 while (GNUNET_ATS_PREFERENCE_END != (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
600 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
602 (void) va_arg (ap, double);
604 case GNUNET_ATS_PREFERENCE_LATENCY:
606 (void) va_arg (ap, double);
613 msize = count * sizeof (struct PreferenceInformation) +
614 sizeof (struct ChangePreferenceMessage);
615 p = GNUNET_malloc (sizeof (struct PendingMessage) +
618 p->is_init = GNUNET_NO;
619 m = (struct ChangePreferenceMessage*) &p[1];
620 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
621 m->header.size = htons (msize);
622 m->num_preferences = htonl (count);
624 pi = (struct PreferenceInformation*) &m[1];
627 while (GNUNET_ATS_PREFERENCE_END != (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
629 pi[count].preference_kind = htonl (kind);
632 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
633 pi[count].preference_value = (float) va_arg (ap, double);
636 case GNUNET_ATS_PREFERENCE_LATENCY:
637 pi[count].preference_value = (float) va_arg (ap, double);
645 GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head,
650 /* end of ats_api_performance.c */