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"
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 * Information we track per session.
66 * Identity of the peer (just needed for error checking).
68 struct GNUNET_PeerIdentity peer;
73 struct Session *session;
76 * Set to GNUNET_YES if the slot is used.
83 * Handle to the ATS subsystem for bandwidth/transport scheduling information.
85 struct GNUNET_ATS_SchedulingHandle
91 const struct GNUNET_CONFIGURATION_Handle *cfg;
94 * Callback to invoke on suggestions.
96 GNUNET_ATS_AddressSuggestionCallback suggest_cb;
99 * Closure for 'suggest_cb'.
101 void *suggest_cb_cls;
104 * Connection to ATS service.
106 struct GNUNET_CLIENT_Connection *client;
109 * Head of list of messages for the ATS service.
111 struct PendingMessage *pending_head;
114 * Tail of list of messages for the ATS service
116 struct PendingMessage *pending_tail;
119 * Current request for transmission to ATS.
121 struct GNUNET_CLIENT_TransmitHandle *th;
124 * Array of session objects (we need to translate them to numbers and back
125 * for the protocol; the offset in the array is the session number on the
126 * network). Index 0 is always NULL and reserved to represent the NULL pointer.
127 * Unused entries are also NULL.
129 struct SessionRecord *session_array;
132 * Task to trigger reconnect.
134 GNUNET_SCHEDULER_TaskIdentifier task;
137 * Size of the session array.
139 unsigned int session_array_size;
145 * Re-establish the connection to the ATS service.
147 * @param sh handle to use to re-connect.
150 reconnect (struct GNUNET_ATS_SchedulingHandle *sh);
155 * Re-establish the connection to the ATS service.
157 * @param cls handle to use to re-connect.
158 * @param tc scheduler context
161 reconnect_task (void *cls,
162 const struct GNUNET_SCHEDULER_TaskContext *tc)
164 struct GNUNET_ATS_SchedulingHandle *sh = cls;
166 sh->task = GNUNET_SCHEDULER_NO_TASK;
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_SchedulingHandle *sh);
182 * Type of a function to call when we receive a message
185 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
186 * @param msg message received, NULL on timeout or fatal error
189 process_ats_message (void *cls,
190 const struct GNUNET_MessageHeader *msg);
194 * We can now transmit a message to ATS. Do it.
196 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
197 * @param size number of bytes we can transmit to ATS
198 * @param buf where to copy the messages
199 * @return number of bytes copied into buf
202 transmit_message_to_ats (void *cls,
206 struct GNUNET_ATS_SchedulingHandle *sh = cls;
207 struct PendingMessage *p;
214 while ( (NULL != (p = sh->pending_head)) &&
217 memcpy (&cbuf[ret], &p[1], p->size);
220 GNUNET_CONTAINER_DLL_remove (sh->pending_head,
223 if (GNUNET_YES == p->is_init)
224 GNUNET_CLIENT_receive (sh->client,
225 &process_ats_message, sh,
226 GNUNET_TIME_UNIT_FOREVER_REL);
235 * Transmit messages from the message queue to the service
236 * (if there are any, and if we are not already trying).
238 * @param sh handle to use
241 do_transmit (struct GNUNET_ATS_SchedulingHandle *sh)
243 struct PendingMessage *p;
247 if (NULL == (p = sh->pending_head))
249 if (NULL == sh->client)
250 return; /* currently reconnecting */
251 sh->th = GNUNET_CLIENT_notify_transmit_ready (sh->client,
253 GNUNET_TIME_UNIT_FOREVER_REL,
255 &transmit_message_to_ats, sh);
260 * Find the session object corresponding to the given session ID.
262 * @param sh our handle
263 * @param session_id current session ID
264 * @param peer peer the session belongs to
265 * @return the session object (or NULL)
267 static struct Session*
268 find_session (struct GNUNET_ATS_SchedulingHandle *sh,
270 const struct GNUNET_PeerIdentity *peer)
272 if (session_id >= sh->session_array_size)
279 GNUNET_assert (0 == memcmp (peer,
280 &sh->session_array[session_id].peer,
281 sizeof (struct GNUNET_PeerIdentity)));
282 return sh->session_array[session_id].session;
287 * Get the ID for the given session object. If we do not have an ID for
288 * the given session object, allocate one.
290 * @param sh our handle
291 * @param session session object
292 * @param peer peer the session belongs to
293 * @return the session id
296 get_session_id (struct GNUNET_ATS_SchedulingHandle *sh,
297 struct Session *session,
298 const struct GNUNET_PeerIdentity *peer)
306 for (i=1;i<sh->session_array_size;i++)
308 if (session == sh->session_array[i].session)
310 GNUNET_assert (0 == memcmp (peer,
311 &sh->session_array[i].peer,
312 sizeof (struct GNUNET_PeerIdentity)));
316 (sh->session_array[i].slot_used == GNUNET_NO) )
321 f = sh->session_array_size;
322 GNUNET_array_grow (sh->session_array,
323 sh->session_array_size,
324 sh->session_array_size * 2);
326 GNUNET_assert (f > 0);
327 sh->session_array[f].session = session;
328 sh->session_array[f].peer = *peer;
329 sh->session_array[f].slot_used = GNUNET_YES;
335 * Remove the session of the given session ID from the session
336 * table (it is no longer valid).
338 * @param sh our handle
339 * @param session_id identifies session that is no longer valid
340 * @param peer peer the session belongs to
343 remove_session (struct GNUNET_ATS_SchedulingHandle *sh,
345 const struct GNUNET_PeerIdentity *peer)
347 GNUNET_assert (session_id < sh->session_array_size);
348 GNUNET_assert (GNUNET_YES == sh->session_array[session_id].slot_used);
349 GNUNET_assert (0 == memcmp (peer,
350 &sh->session_array[session_id].peer,
351 sizeof (struct GNUNET_PeerIdentity)));
352 sh->session_array[session_id].session = NULL;
357 * Release the session slot from the session table (ATS service is
358 * also done using it).
360 * @param sh our handle
361 * @param session_id identifies session that is no longer valid
362 * @param peer peer the session belongs to
365 release_session (struct GNUNET_ATS_SchedulingHandle *sh,
367 const struct GNUNET_PeerIdentity *peer)
369 GNUNET_assert (session_id < sh->session_array_size);
370 GNUNET_assert (0 == memcmp (peer,
371 &sh->session_array[session_id].peer,
372 sizeof (struct GNUNET_PeerIdentity)));
373 sh->session_array[session_id].slot_used = GNUNET_NO;
374 memset (&sh->session_array[session_id].peer,
376 sizeof (struct GNUNET_PeerIdentity));
381 process_release_message (struct GNUNET_ATS_SchedulingHandle *sh,
382 const struct SessionReleaseMessage *srm)
385 ntohl (srm->session_id),
391 * Type of a function to call when we receive a message
394 * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
395 * @param msg message received, NULL on timeout or fatal error
398 process_ats_message (void *cls,
399 const struct GNUNET_MessageHeader *msg)
401 struct GNUNET_ATS_SchedulingHandle *sh = cls;
402 const struct AddressSuggestionMessage *m;
403 const struct GNUNET_ATS_Information *atsi;
405 const char *plugin_name;
406 uint16_t address_length;
407 uint16_t plugin_name_length;
412 GNUNET_CLIENT_disconnect (sh->client, GNUNET_NO);
414 sh->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
415 &reconnect_task, sh);
418 if ( (ntohs (msg->type) == GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE) &&
419 (ntohs (msg->size) == sizeof (struct SessionReleaseMessage)) )
421 process_release_message (sh,
422 (const struct SessionReleaseMessage*) msg);
423 GNUNET_CLIENT_receive (sh->client,
424 &process_ats_message, sh,
425 GNUNET_TIME_UNIT_FOREVER_REL);
428 if ( (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION) ||
429 (ntohs (msg->size) <= sizeof (struct AddressSuggestionMessage)) )
432 GNUNET_CLIENT_disconnect (sh->client, GNUNET_NO);
434 sh->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
435 &reconnect_task, sh);
438 m = (const struct AddressSuggestionMessage*) msg;
439 ats_count = ntohl (m->ats_count);
440 address_length = ntohs (m->address_length);
441 atsi = (const struct GNUNET_ATS_Information*) &m[1];
442 address = (const char*) &atsi[ats_count];
443 plugin_name = &address[address_length];
444 plugin_name_length = ntohs (m->plugin_name_length);
445 if ( (address_length +
447 ats_count * sizeof (struct GNUNET_ATS_Information) +
448 sizeof (struct AddressSuggestionMessage) != ntohs (msg->size)) ||
449 (ats_count > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
450 (plugin_name[plugin_name_length - 1] != '\0') )
453 GNUNET_CLIENT_disconnect (sh->client, GNUNET_NO);
455 sh->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
456 &reconnect_task, sh);
459 sh->suggest_cb (sh->suggest_cb_cls,
462 address, address_length,
463 find_session (sh, ntohl (m->session_id), &m->peer),
468 GNUNET_CLIENT_receive (sh->client,
469 &process_ats_message, sh,
470 GNUNET_TIME_UNIT_FOREVER_REL);
475 * Re-establish the connection to the ATS service.
477 * @param sh handle to use to re-connect.
480 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
482 struct PendingMessage *p;
483 struct ClientStartMessage *init;
485 GNUNET_assert (NULL == sh->client);
486 sh->client = GNUNET_CLIENT_connect ("ats", sh->cfg);
487 GNUNET_assert (NULL != sh->client);
488 if ( (NULL == (p = sh->pending_head)) ||
489 (GNUNET_YES != p->is_init) )
491 p = GNUNET_malloc (sizeof (struct PendingMessage) +
492 sizeof (struct ClientStartMessage));
493 p->size = sizeof (struct ClientStartMessage);
494 p->is_init = GNUNET_YES;
495 init = (struct ClientStartMessage *) &p[1];
496 init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
497 init->header.size = htons (sizeof (struct ClientStartMessage));
498 init->start_flag = htonl (START_FLAG_SCHEDULING);
499 GNUNET_CONTAINER_DLL_insert (sh->pending_head,
508 * Initialize the ATS subsystem.
510 * @param cfg configuration to use
511 * @param suggest_cb notification to call whenever the suggestation changed
512 * @param suggest_cb_cls closure for 'suggest_cb'
513 * @return ats context
515 struct GNUNET_ATS_SchedulingHandle *
516 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
517 GNUNET_ATS_AddressSuggestionCallback suggest_cb,
518 void *suggest_cb_cls)
520 struct GNUNET_ATS_SchedulingHandle *sh;
522 sh = GNUNET_malloc (sizeof (struct GNUNET_ATS_SchedulingHandle));
524 sh->suggest_cb = suggest_cb;
525 sh->suggest_cb_cls = suggest_cb_cls;
526 GNUNET_array_grow (sh->session_array,
527 sh->session_array_size,
535 * Client is done with ATS scheduling, release resources.
537 * @param sh handle to release
540 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
542 struct PendingMessage *p;
544 while (NULL != (p = sh->pending_head))
546 GNUNET_CONTAINER_DLL_remove (sh->pending_head,
551 if (NULL != sh->client)
553 GNUNET_CLIENT_disconnect (sh->client, GNUNET_NO);
556 if (GNUNET_SCHEDULER_NO_TASK != sh->task)
558 GNUNET_SCHEDULER_cancel (sh->task);
559 sh->task = GNUNET_SCHEDULER_NO_TASK;
561 GNUNET_array_grow (sh->session_array,
562 sh->session_array_size,
569 * We would like to establish a new connection with a peer. ATS
570 * should suggest a good address to begin with.
573 * @param peer identity of the peer we need an address for
576 GNUNET_ATS_suggest_address (struct GNUNET_ATS_SchedulingHandle *sh,
577 const struct GNUNET_PeerIdentity *peer)
579 struct PendingMessage *p;
580 struct RequestAddressMessage *m;
582 p = GNUNET_malloc (sizeof (struct PendingMessage) +
583 sizeof (struct RequestAddressMessage));
584 p->size = sizeof (struct RequestAddressMessage);
585 p->is_init = GNUNET_NO;
586 m = (struct RequestAddressMessage*) &p[1];
587 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
588 m->header.size = htons (sizeof (struct RequestAddressMessage));
589 m->reserved = htonl (0);
591 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head,
599 * We have updated performance statistics for a given address. Note
600 * that this function can be called for addresses that are currently
601 * in use as well as addresses that are valid but not actively in use.
602 * Furthermore, the peer may not even be connected to us right now (in
603 * which case the call may be ignored or the information may be stored
604 * for later use). Update bandwidth assignments.
607 * @param peer identity of the new peer
608 * @param plugin_name name of the transport plugin
609 * @param plugin_addr address (if available)
610 * @param plugin_addr_len number of bytes in plugin_addr
611 * @param session session handle (if available)
612 * @param ats performance data for the address
613 * @param ats_count number of performance records in 'ats'
616 GNUNET_ATS_address_update (struct GNUNET_ATS_SchedulingHandle *sh,
617 const struct GNUNET_PeerIdentity *peer,
618 const char *plugin_name,
619 const void *plugin_addr, size_t plugin_addr_len,
620 struct Session *session,
621 const struct GNUNET_ATS_Information *ats,
624 struct PendingMessage *p;
625 struct AddressUpdateMessage *m;
626 struct GNUNET_ATS_Information *am;
631 namelen = (plugin_name == NULL) ? 0 : strlen (plugin_name) + 1;
632 msize = sizeof (struct AddressUpdateMessage) + plugin_addr_len +
633 ats_count * sizeof (struct GNUNET_ATS_Information) + namelen;
634 if ( (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
635 (plugin_addr_len >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
636 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
637 (ats_count >= GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) )
642 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
644 p->is_init = GNUNET_NO;
645 m = (struct AddressUpdateMessage*) &p[1];
646 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
647 m->header.size = htons (msize);
648 m->ats_count = htonl (ats_count);
650 m->address_length = htons (plugin_addr_len);
651 m->plugin_name_length = htons (namelen);
652 m->session_id = htonl (get_session_id (sh, session, peer));
653 am = (struct GNUNET_ATS_Information*) &m[1];
654 memcpy (am, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
655 pm = (char *) &am[ats_count];
656 memcpy (pm, plugin_addr, plugin_addr_len);
657 memcpy (&pm[plugin_addr_len], plugin_name, namelen);
658 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head,
666 * A session got destroyed, stop including it as a valid address.
669 * @param peer identity of the peer
670 * @param plugin_name name of the transport plugin
671 * @param plugin_addr address (if available)
672 * @param plugin_addr_len number of bytes in plugin_addr
673 * @param session session handle that is no longer valid
676 GNUNET_ATS_address_destroyed (struct GNUNET_ATS_SchedulingHandle *sh,
677 const struct GNUNET_PeerIdentity *peer,
678 const char *plugin_name,
679 const void *plugin_addr,
680 size_t plugin_addr_len,
681 struct Session *session)
683 struct PendingMessage *p;
684 struct AddressDestroyedMessage *m;
690 namelen = (plugin_name == NULL) ? 0 : strlen (plugin_name) + 1;
691 msize = sizeof (struct AddressDestroyedMessage) + plugin_addr_len +
693 if ( (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
694 (plugin_addr_len >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
695 (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) )
700 p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
702 p->is_init = GNUNET_NO;
703 m = (struct AddressDestroyedMessage*) &p[1];
704 m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
705 m->header.size = htons (msize);
706 m->reserved = htonl (0);
708 m->address_length = htons (plugin_addr_len);
709 m->plugin_name_length = htons (namelen);
710 m->session_id = htonl (session_id = get_session_id (sh, session, peer));
712 memcpy (pm, plugin_addr, plugin_addr_len);
713 memcpy (&pm[plugin_addr_len], plugin_name, namelen);
714 GNUNET_CONTAINER_DLL_insert_tail (sh->pending_head,
718 remove_session (sh, session_id, peer);
721 /* end of ats_api_scheduling.c */