2 This file is part of GNUnet.
3 (C) 2009, 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.
22 * @file transport/transport_api.c
23 * @brief library to access the low-level P2P IO service
24 * @author Christian Grothoff
27 * - adjust testcases to use new 'try connect' style (should be easy, breaks API compatibility!)
28 * - adjust core service to use new 'try connect' style (should be MUCH nicer there as well!)
32 #include "gnunet_bandwidth_lib.h"
33 #include "gnunet_client_lib.h"
34 #include "gnunet_constants.h"
35 #include "gnunet_container_lib.h"
36 #include "gnunet_arm_service.h"
37 #include "gnunet_hello_lib.h"
38 #include "gnunet_protocols.h"
39 #include "gnunet_server_lib.h"
40 #include "gnunet_time_lib.h"
41 #include "gnunet_transport_service.h"
42 #include "transport.h"
45 * How large to start with for the hashmap of neighbours.
47 #define STARTING_NEIGHBOURS_SIZE 16
51 * Handle for a message that should be transmitted to the service.
52 * Used for both control messages and normal messages.
54 struct GNUNET_TRANSPORT_TransmitHandle
58 * We keep all requests in a DLL.
60 struct GNUNET_TRANSPORT_TransmitHandle *next;
63 * We keep all requests in a DLL.
65 struct GNUNET_TRANSPORT_TransmitHandle *prev;
68 * Neighbour for this handle, NULL for control messages.
70 struct Neighbour *neighbour;
73 * Function to call when notify_size bytes are available
76 GNUNET_CONNECTION_TransmitReadyNotify notify;
84 * Timeout for this request, 0 for control messages.
86 struct GNUNET_TIME_Absolute timeout;
89 * Task to trigger request timeout if the request is stalled due to
92 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
95 * How many bytes is our notify callback waiting for?
100 * How important is this message? Not used for control messages.
108 * Entry in hash table of all of our current neighbours.
113 * Overall transport handle.
115 struct GNUNET_TRANSPORT_Handle *h;
118 * Active transmit handle or NULL.
120 struct GNUNET_TRANSPORT_TransmitHandle *th;
123 * Identity of this neighbour.
125 struct GNUNET_PeerIdentity id;
128 * Outbound bandwidh tracker.
130 struct GNUNET_BANDWIDTH_Tracker out_tracker;
133 * Entry in our readyness heap (which is sorted by 'next_ready'
134 * value). NULL if there is no pending transmission request for
135 * this neighbour or if we're waiting for 'is_ready' to become
136 * true AFTER the 'out_tracker' suggested that this peer's quota
137 * has been satisfied (so once 'is_ready' goes to GNUNET_YES,
138 * we should immediately go back into the heap).
140 struct GNUNET_CONTAINER_HeapNode *hn;
143 * Is this peer currently ready to receive a message?
151 * Linked list of functions to call whenever our HELLO is updated.
157 * This is a doubly linked list.
159 struct HelloWaitList *next;
162 * This is a doubly linked list.
164 struct HelloWaitList *prev;
167 * Callback to call once we got our HELLO.
169 GNUNET_TRANSPORT_HelloUpdateCallback rec;
180 * Handle for the transport service (includes all of the
181 * state for the transport service).
183 struct GNUNET_TRANSPORT_Handle
187 * Closure for the callbacks.
192 * Function to call for received data.
194 GNUNET_TRANSPORT_ReceiveCallback rec;
197 * function to call on connect events
199 GNUNET_TRANSPORT_NotifyConnect nc_cb;
202 * function to call on disconnect events
204 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
207 * Head of DLL of control messages.
209 struct GNUNET_TRANSPORT_TransmitHandle *control_head;
212 * Tail of DLL of control messages.
214 struct GNUNET_TRANSPORT_TransmitHandle *control_tail;
217 * The current HELLO message for this peer. Updated
218 * whenever transports change their addresses.
220 struct GNUNET_HELLO_Message *my_hello;
223 * My client connection to the transport service.
225 struct GNUNET_CLIENT_Connection *client;
228 * Handle to our registration with the client for notification.
230 struct GNUNET_CLIENT_TransmitHandle *cth;
233 * Linked list of pending requests for our HELLO.
235 struct HelloWaitList *hwl_head;
238 * Linked list of pending requests for our HELLO.
240 struct HelloWaitList *hwl_tail;
245 const struct GNUNET_CONFIGURATION_Handle *cfg;
248 * Hash map of the current connected neighbours of this peer.
249 * Maps peer identities to 'struct Neighbour' entries.
251 struct GNUNET_CONTAINER_MultiHashMap *neighbours;
254 * Heap sorting peers with pending messages by the timestamps that
255 * specify when we could next send a message to the respective peer.
256 * Excludes control messages (which can always go out immediately).
257 * Maps time stamps to 'struct Neighbour' entries.
259 struct GNUNET_CONTAINER_Heap *ready_heap;
262 * Peer identity as assumed by this process, or all zeros.
264 struct GNUNET_PeerIdentity self;
267 * ID of the task trying to reconnect to the service.
269 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
272 * ID of the task trying to trigger transmission for a peer while
273 * maintaining bandwidth quotas. In use if there are no control
274 * messages and the smallest entry in the 'ready_heap' has a time
275 * stamp in the future.
277 GNUNET_SCHEDULER_TaskIdentifier quota_task;
280 * Delay until we try to reconnect.
282 struct GNUNET_TIME_Relative reconnect_delay;
285 * Should we check that 'self' matches what the service thinks?
286 * (if GNUNET_NO, then 'self' is all zeros!).
293 * Schedule the task to send one message, either from the control
294 * list or the peer message queues to the service.
296 * @param h transport service to schedule a transmission for
299 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
303 * Function that will schedule the job that will try
304 * to connect us again to the client.
306 * @param h transport service to reconnect
309 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h);
313 * Get the neighbour list entry for the given peer
315 * @param h our context
316 * @param peer peer to look up
317 * @return NULL if no such peer entry exists
319 static struct Neighbour *
320 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
321 const struct GNUNET_PeerIdentity *peer)
323 return GNUNET_CONTAINER_multihashmap_get(h->neighbours, &peer->hashPubKey);
328 * Add neighbour to our list
330 * @return NULL if this API is currently disconnecting from the service
332 static struct Neighbour *
333 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
334 const struct GNUNET_PeerIdentity *pid)
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
340 "Creating entry for neighbour `%4s'.\n",
343 n = GNUNET_malloc (sizeof (struct Neighbour));
346 n->is_ready = GNUNET_YES;
347 GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
348 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
349 MAX_BANDWIDTH_CARRY_S);
350 GNUNET_assert (GNUNET_OK ==
351 GNUNET_CONTAINER_multihashmap_put (h->neighbours,
354 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
360 * Iterator over hash map entries, for deleting state of a neighbour.
362 * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
363 * @param key peer identity
364 * @param value value in the hash map, the neighbour entry to delete
365 * @return GNUNET_YES if we should continue to
370 neighbour_delete (void *cls,
371 const GNUNET_HashCode * key,
374 struct GNUNET_TRANSPORT_Handle *handle = cls;
375 struct Neighbour *n = value;
377 if (NULL != handle->nd_cb)
378 handle->nd_cb (handle->cls,
380 GNUNET_assert (NULL == n->th);
381 GNUNET_assert (NULL == n->hn);
382 GNUNET_assert (GNUNET_YES ==
383 GNUNET_CONTAINER_multihashmap_remove (handle->neighbours,
392 * Function we use for handling incoming messages.
394 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
395 * @param msg message received, NULL on timeout or fatal error
398 demultiplexer (void *cls,
399 const struct GNUNET_MessageHeader *msg)
401 struct GNUNET_TRANSPORT_Handle *h = cls;
402 const struct DisconnectInfoMessage *dim;
403 const struct ConnectInfoMessage *cim;
404 const struct InboundMessage *im;
405 const struct GNUNET_MessageHeader *imm;
406 const struct SendOkMessage *okm;
407 struct HelloWaitList *hwl;
408 struct HelloWaitList *next_hwl;
410 struct GNUNET_PeerIdentity me;
414 GNUNET_assert (h->client != NULL);
418 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
419 "Error receiving from transport service, disconnecting temporarily.\n");
421 disconnect_and_schedule_reconnect (h);
424 GNUNET_CLIENT_receive (h->client,
426 GNUNET_TIME_UNIT_FOREVER_REL);
427 size = ntohs (msg->size);
428 switch (ntohs (msg->type))
430 case GNUNET_MESSAGE_TYPE_HELLO:
432 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
439 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
440 "Receiving (my own) `%s' message, I am `%4s'.\n",
441 "HELLO", GNUNET_i2s (&me));
443 GNUNET_free_non_null (h->my_hello);
445 if (size < sizeof (struct GNUNET_MessageHeader))
450 h->my_hello = GNUNET_malloc (size);
451 memcpy (h->my_hello, msg, size);
455 next_hwl = hwl->next;
456 hwl->rec (hwl->rec_cls,
457 (const struct GNUNET_MessageHeader *) h->my_hello);
461 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
462 if (size < sizeof (struct ConnectInfoMessage))
467 cim = (const struct ConnectInfoMessage *) msg;
468 ats_count = ntohl (cim->ats_count);
469 if (size != sizeof (struct ConnectInfoMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information))
475 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
476 "Receiving `%s' message for `%4s'.\n",
477 "CONNECT", GNUNET_i2s (&cim->id));
479 n = neighbour_find (h, &cim->id);
485 n = neighbour_add (h, &cim->id);
486 if (h->nc_cb != NULL)
487 h->nc_cb (h->cls, &n->id,
488 &cim->ats, ats_count);
490 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
491 if (size != sizeof (struct DisconnectInfoMessage))
496 dim = (const struct DisconnectInfoMessage *) msg;
497 GNUNET_break (ntohl (dim->reserved) == 0);
498 #if DEBUG_TRANSPORT_DISCONNECT
499 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
500 "Receiving `%s' message for `%4s'.\n",
502 GNUNET_i2s (&dim->peer));
504 n = neighbour_find (h, &dim->peer);
510 neighbour_delete (h, &dim->peer.hashPubKey, n);
512 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
513 if (size != sizeof (struct SendOkMessage))
518 okm = (const struct SendOkMessage *) msg;
520 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
521 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
522 ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
524 n = neighbour_find (h, &okm->peer);
527 GNUNET_break (GNUNET_NO == n->is_ready);
528 n->is_ready = GNUNET_YES;
529 if ( (n->th != NULL) &&
532 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != n->th->timeout_task);
533 GNUNET_SCHEDULER_cancel (n->th->timeout_task);
534 n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
535 /* we've been waiting for this (congestion, not quota,
536 caused delayed transmission) */
537 n->hn = GNUNET_CONTAINER_heap_insert (h->ready_heap,
539 schedule_transmission (h);
542 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
544 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
545 "Receiving `%s' message.\n", "RECV");
548 sizeof (struct InboundMessage) +
549 sizeof (struct GNUNET_MessageHeader))
554 im = (const struct InboundMessage *) msg;
555 GNUNET_break (0 == ntohl (im->reserved));
556 ats_count = ntohl(im->ats_count);
557 imm = (const struct GNUNET_MessageHeader *) &((&(im->ats))[ats_count+1]);
559 if (ntohs (imm->size) + sizeof (struct InboundMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) != size)
565 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
566 "Received message of type %u from `%4s'.\n",
567 ntohs (imm->type), GNUNET_i2s (&im->peer));
569 n = neighbour_find (h, &im->peer);
576 h->rec (h->cls, &im->peer, imm,
577 &im->ats, ats_count);
580 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
582 ("Received unexpected message of type %u in %s:%u\n"),
583 ntohs (msg->type), __FILE__, __LINE__);
591 * A transmission request could not be satisfied because of
592 * network congestion. Notify the initiator and clean up.
594 * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle'
595 * @param tc scheduler context
598 timeout_request_due_to_congestion (void *cls,
599 const struct GNUNET_SCHEDULER_TaskContext *tc)
601 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
602 struct Neighbour *n = th->neighbour;
604 n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
605 GNUNET_assert (th == n->th);
606 GNUNET_assert (NULL == n->hn);
608 th->notify (th->notify_cls, 0, NULL);
614 * Transmit message(s) to service.
616 * @param cls handle to transport
617 * @param size number of bytes available in buf
618 * @param buf where to copy the message
619 * @return number of bytes copied to buf
622 transport_notify_ready (void *cls, size_t size, void *buf)
624 struct GNUNET_TRANSPORT_Handle *h = cls;
625 struct GNUNET_TRANSPORT_TransmitHandle *th;
628 struct OutboundMessage obm;
633 GNUNET_assert (NULL != h->client);
637 /* transmission failed */
638 disconnect_and_schedule_reconnect (h);
644 /* first send control messages */
645 while ( (NULL != (th = h->control_head)) &&
646 (th->notify_size <= size) )
648 GNUNET_CONTAINER_DLL_remove (h->control_head,
651 nret = th->notify (th->notify_cls, size, &cbuf[ret]);
653 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
654 "Added %u bytes of control message at %u\n",
663 /* then, if possible and no control messages pending, send data messages */
664 while ( (NULL == h->control_head) &&
665 (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) )
667 if (GNUNET_YES != n->is_ready)
669 /* peer not ready, wait for notification! */
670 GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
672 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->th->timeout_task);
673 n->th->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (n->th->timeout),
674 &timeout_request_due_to_congestion,
679 if (th->notify_size + sizeof (struct OutboundMessage) > size)
680 break; /* does not fit */
681 if (GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, th->notify_size).rel_value > 0)
682 break; /* too early */
683 GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
686 n->is_ready = GNUNET_NO;
687 GNUNET_assert (size >= sizeof (struct OutboundMessage));
688 mret = th->notify (th->notify_cls,
689 size - sizeof (struct OutboundMessage),
690 &cbuf[ret + sizeof (struct OutboundMessage)]);
691 GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
694 GNUNET_assert (mret + sizeof (struct OutboundMessage) < GNUNET_SERVER_MAX_MESSAGE_SIZE);
695 obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
696 obm.header.size = htons (mret + sizeof (struct OutboundMessage));
697 obm.priority = htonl (th->priority);
698 obm.timeout = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (th->timeout));
700 memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
701 ret += (mret + sizeof (struct OutboundMessage));
702 size -= (mret + sizeof (struct OutboundMessage));
703 GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
707 /* if there are more pending messages, try to schedule those */
708 schedule_transmission (h);
710 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
711 "Transmitting %u bytes to transport service\n", ret);
718 * Schedule the task to send one message, either from the control
719 * list or the peer message queues to the service.
721 * @param cls transport service to schedule a transmission for
722 * @param tc scheduler context
725 schedule_transmission_task (void *cls,
726 const struct GNUNET_SCHEDULER_TaskContext *tc)
728 struct GNUNET_TRANSPORT_Handle *h = cls;
730 struct GNUNET_TRANSPORT_TransmitHandle *th;
733 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
734 GNUNET_assert (NULL != h->client);
735 /* destroy all requests that have timed out */
736 while ( (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) &&
737 (GNUNET_TIME_absolute_get_remaining (n->th->timeout).rel_value == 0) )
739 /* notify client that the request could not be satisfied within
740 the given time constraints */
743 GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
746 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
747 "Signalling timeout for transmission to peer %s due to congestion\n",
748 GNUNET_i2s (&n->id));
751 th->notify (th->notify_cls, 0, NULL));
756 if (NULL != h->control_head)
758 size = h->control_head->notify_size;
762 n = GNUNET_CONTAINER_heap_peek (h->ready_heap);
764 return; /* no pending messages */
765 size = n->th->notify_size + sizeof (struct OutboundMessage);
768 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
769 "Calling notify_transmit_ready\n");
772 GNUNET_CLIENT_notify_transmit_ready (h->client,
774 GNUNET_TIME_UNIT_FOREVER_REL,
776 &transport_notify_ready,
778 GNUNET_assert (NULL != h->cth);
783 * Schedule the task to send one message, either from the control
784 * list or the peer message queues to the service.
786 * @param h transport service to schedule a transmission for
789 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
791 struct GNUNET_TIME_Relative delay;
794 GNUNET_assert (NULL != h->client);
795 if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
797 GNUNET_SCHEDULER_cancel (h->quota_task);
798 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
800 if (NULL != h->control_head)
801 delay = GNUNET_TIME_UNIT_ZERO;
802 else if (NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap)))
803 delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, n->th->notify_size);
805 return; /* no work to be done */
806 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
807 "Scheduling next transmission to service in %llu ms\n",
808 (unsigned long long) delay.rel_value);
809 h->quota_task = GNUNET_SCHEDULER_add_delayed (delay,
810 &schedule_transmission_task,
816 * Queue control request for transmission to the transport
819 * @param h handle to the transport service
820 * @param size number of bytes to be transmitted
821 * @param notify function to call to get the content
822 * @param notify_cls closure for notify
825 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
827 GNUNET_CONNECTION_TransmitReadyNotify notify,
830 struct GNUNET_TRANSPORT_TransmitHandle *th;
833 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
834 "Control transmit of %u bytes requested\n",
837 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
839 th->notify_cls = notify_cls;
840 th->notify_size = size;
841 GNUNET_CONTAINER_DLL_insert_tail (h->control_head,
844 schedule_transmission (h);
849 * Transmit START message to service.
852 * @param size number of bytes available in buf
853 * @param buf where to copy the message
854 * @return number of bytes copied to buf
857 send_start (void *cls, size_t size, void *buf)
859 struct GNUNET_TRANSPORT_Handle *h = cls;
860 struct StartMessage s;
864 /* Can only be shutdown, just give up */
866 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
867 "Shutdown while trying to transmit `%s' request.\n",
873 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
874 "Transmitting `%s' request.\n", "START");
876 GNUNET_assert (size >= sizeof (struct StartMessage));
877 s.header.size = htons (sizeof (struct StartMessage));
878 s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
879 s.do_check = htonl (h->check_self);
881 memcpy (buf, &s, sizeof (struct StartMessage));
882 GNUNET_CLIENT_receive (h->client,
883 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
884 return sizeof (struct StartMessage);
889 * Try again to connect to transport service.
891 * @param cls the handle to the transport service
892 * @param tc scheduler context
895 reconnect (void *cls,
896 const struct GNUNET_SCHEDULER_TaskContext *tc)
898 struct GNUNET_TRANSPORT_Handle *h = cls;
900 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
901 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
903 /* shutdown, just give up */
907 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
908 "Connecting to transport service.\n");
910 GNUNET_assert (h->client == NULL);
911 GNUNET_assert (h->control_head == NULL);
912 GNUNET_assert (h->control_tail == NULL);
913 h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
914 GNUNET_assert (h->client != NULL);
915 schedule_control_transmit (h,
916 sizeof (struct StartMessage),
922 * Function that will schedule the job that will try
923 * to connect us again to the client.
925 * @param h transport service to reconnect
928 disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
930 struct GNUNET_TRANSPORT_TransmitHandle *th;
932 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
933 /* Forget about all neighbours that we used to be connected to */
934 GNUNET_CONTAINER_multihashmap_iterate(h->neighbours,
939 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
942 if (NULL != h->client)
944 GNUNET_CLIENT_disconnect (h->client, GNUNET_YES);
947 if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
949 GNUNET_SCHEDULER_cancel (h->quota_task);
950 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
952 while ( (NULL != (th = h->control_head)))
954 GNUNET_CONTAINER_DLL_remove (h->control_head,
957 th->notify (th->notify_cls, 0, NULL);
961 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
962 "Scheduling task to reconnect to transport service in %llu ms.\n",
963 h->reconnect_delay.rel_value);
966 = GNUNET_SCHEDULER_add_delayed (h->reconnect_delay,
968 if (h->reconnect_delay.rel_value == 0)
970 h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
974 h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
975 h->reconnect_delay = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
982 * Closure for 'send_set_quota'.
984 struct SetQuotaContext
988 * Identity of the peer impacted by the quota change.
990 struct GNUNET_PeerIdentity target;
995 struct GNUNET_BANDWIDTH_Value32NBO quota_in;
1000 * Send SET_QUOTA message to the service.
1002 * @param cls the 'struct SetQuotaContext'
1003 * @param size number of bytes available in buf
1004 * @param buf where to copy the message
1005 * @return number of bytes copied to buf
1008 send_set_quota (void *cls, size_t size, void *buf)
1010 struct SetQuotaContext *sqc = cls;
1011 struct QuotaSetMessage msg;
1019 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1020 "Transmitting `%s' request with respect to `%4s'.\n",
1022 GNUNET_i2s (&sqc->target));
1024 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
1025 msg.header.size = htons (sizeof (struct QuotaSetMessage));
1026 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
1027 msg.quota = sqc->quota_in;
1028 msg.peer = sqc->target;
1029 memcpy (buf, &msg, sizeof (msg));
1031 return sizeof (struct QuotaSetMessage);
1036 * Set the share of incoming bandwidth for the given
1037 * peer to the specified amount.
1039 * @param handle connection to transport service
1040 * @param target who's bandwidth quota is being changed
1041 * @param quota_in incoming bandwidth quota in bytes per ms
1042 * @param quota_out outgoing bandwidth quota in bytes per ms
1045 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
1046 const struct GNUNET_PeerIdentity *target,
1047 struct GNUNET_BANDWIDTH_Value32NBO quota_in,
1048 struct GNUNET_BANDWIDTH_Value32NBO quota_out)
1050 struct Neighbour *n;
1051 struct SetQuotaContext *sqc;
1053 n = neighbour_find (handle, target);
1056 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1057 "Quota changed to %u for peer `%s', but I have no such neighbour!\n",
1058 (unsigned int) ntohl (quota_out.value__),
1059 GNUNET_i2s (target));
1062 GNUNET_assert (NULL != handle->client);
1064 if (ntohl (quota_out.value__) != n->out_tracker.available_bytes_per_s__)
1065 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1066 "Quota changed from %u to %u for peer `%s'\n",
1067 (unsigned int) n->out_tracker.available_bytes_per_s__,
1068 (unsigned int) ntohl (quota_out.value__),
1069 GNUNET_i2s (target));
1071 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1072 "Quota remains at %u for peer `%s'\n",
1073 (unsigned int) n->out_tracker.available_bytes_per_s__,
1074 GNUNET_i2s (target));
1076 GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker,
1078 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
1079 sqc->target = *target;
1080 sqc->quota_in = quota_in;
1081 schedule_control_transmit (handle,
1082 sizeof (struct QuotaSetMessage),
1083 &send_set_quota, sqc);
1088 * Send REQUEST_CONNECT message to the service.
1090 * @param cls the 'struct GNUNET_PeerIdentity'
1091 * @param size number of bytes available in buf
1092 * @param buf where to copy the message
1093 * @return number of bytes copied to buf
1096 send_try_connect (void *cls, size_t size, void *buf)
1098 struct GNUNET_PeerIdentity *pid = cls;
1099 struct TransportRequestConnectMessage msg;
1107 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1108 "Transmitting `%s' request with respect to `%4s'.\n",
1112 GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
1113 msg.header.size = htons (sizeof (struct TransportRequestConnectMessage));
1114 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
1115 msg.reserved = htonl (0);
1117 memcpy (buf, &msg, sizeof (msg));
1119 return sizeof (struct TransportRequestConnectMessage);
1124 * Ask the transport service to establish a connection to
1127 * @param handle connection to transport service
1128 * @param target who we should try to connect to
1131 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
1132 const struct GNUNET_PeerIdentity *target)
1134 struct GNUNET_PeerIdentity *pid;
1136 if (NULL == handle->client)
1138 pid = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
1140 schedule_control_transmit (handle,
1141 sizeof (struct TransportRequestConnectMessage),
1142 &send_try_connect, pid);
1147 * Send HELLO message to the service.
1149 * @param cls the HELLO message to send
1150 * @param size number of bytes available in buf
1151 * @param buf where to copy the message
1152 * @return number of bytes copied to buf
1155 send_hello (void *cls, size_t size, void *buf)
1157 struct GNUNET_MessageHeader *msg = cls;
1162 #if DEBUG_TRANSPORT_TIMEOUT
1163 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1164 "Timeout while trying to transmit `%s' request.\n",
1171 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1172 "Transmitting `%s' request.\n", "HELLO");
1174 ssize = ntohs (msg->size);
1175 GNUNET_assert (size >= ssize);
1176 memcpy (buf, msg, ssize);
1183 * Offer the transport service the HELLO of another peer. Note that
1184 * the transport service may just ignore this message if the HELLO is
1185 * malformed or useless due to our local configuration.
1187 * @param handle connection to transport service
1188 * @param hello the hello message
1189 * @param cont continuation to call when HELLO has been sent
1190 * @param cls closure for continuation
1194 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1195 const struct GNUNET_MessageHeader *hello,
1196 GNUNET_SCHEDULER_Task cont,
1200 struct GNUNET_PeerIdentity peer;
1201 struct GNUNET_MessageHeader *msg;
1203 if (NULL == handle->client)
1205 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1206 size = ntohs (hello->size);
1207 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1208 if (GNUNET_OK != GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message*) hello,
1214 msg = GNUNET_malloc(size);
1215 memcpy (msg, hello, size);
1217 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1218 "Offering `%s' message of `%4s' to transport for validation.\n",
1220 GNUNET_i2s (&peer));
1222 schedule_control_transmit (handle,
1229 * Obtain the HELLO message for this peer.
1231 * @param handle connection to transport service
1232 * @param rec function to call with the HELLO, sender will be our peer
1233 * identity; message and sender will be NULL on timeout
1234 * (handshake with transport service pending/failed).
1235 * cost estimate will be 0.
1236 * @param rec_cls closure for rec
1239 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
1240 GNUNET_TRANSPORT_HelloUpdateCallback rec,
1243 struct HelloWaitList *hwl;
1245 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
1247 hwl->rec_cls = rec_cls;
1248 GNUNET_CONTAINER_DLL_insert (handle->hwl_head,
1251 if (handle->my_hello == NULL)
1253 rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
1258 * Stop receiving updates about changes to our HELLO message.
1260 * @param handle connection to transport service
1261 * @param rec function previously registered to be called with the HELLOs
1262 * @param rec_cls closure for rec
1265 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
1266 GNUNET_TRANSPORT_HelloUpdateCallback rec,
1269 struct HelloWaitList *pos;
1271 pos = handle->hwl_head;
1274 if ( (pos->rec == rec) &&
1275 (pos->rec_cls == rec_cls) )
1279 GNUNET_break (pos != NULL);
1282 GNUNET_CONTAINER_DLL_remove (handle->hwl_head,
1290 * Connect to the transport service. Note that the connection may
1291 * complete (or fail) asynchronously.
1293 * @param cfg configuration to use
1294 * @param self our own identity (API should check that it matches
1295 * the identity found by transport), or NULL (no check)
1296 * @param cls closure for the callbacks
1297 * @param rec receive function to call
1298 * @param nc function to call on connect events
1299 * @param nd function to call on disconnect events
1301 struct GNUNET_TRANSPORT_Handle *
1302 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1303 const struct GNUNET_PeerIdentity *self,
1305 GNUNET_TRANSPORT_ReceiveCallback rec,
1306 GNUNET_TRANSPORT_NotifyConnect nc,
1307 GNUNET_TRANSPORT_NotifyDisconnect nd)
1309 struct GNUNET_TRANSPORT_Handle *ret;
1311 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1315 ret->check_self = GNUNET_YES;
1322 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1323 ret->neighbours = GNUNET_CONTAINER_multihashmap_create(STARTING_NEIGHBOURS_SIZE);
1324 ret->ready_heap = GNUNET_CONTAINER_heap_create (GNUNET_CONTAINER_HEAP_ORDER_MIN);
1325 ret->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, ret);
1331 * Disconnect from the transport service.
1333 * @param handle handle to the service as returned from GNUNET_TRANSPORT_connect
1336 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1340 "Transport disconnect called!\n");
1342 /* this disconnects all neighbours... */
1343 if (handle->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1344 disconnect_and_schedule_reconnect (handle);
1345 /* and now we stop trying to connect again... */
1346 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1348 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1349 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1351 GNUNET_CONTAINER_multihashmap_destroy (handle->neighbours);
1352 handle->neighbours = NULL;
1353 if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1355 GNUNET_SCHEDULER_cancel (handle->quota_task);
1356 handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1358 GNUNET_free_non_null (handle->my_hello);
1359 handle->my_hello = NULL;
1360 GNUNET_assert (handle->hwl_head == NULL);
1361 GNUNET_assert (handle->hwl_tail == NULL);
1362 GNUNET_CONTAINER_heap_destroy (handle->ready_heap);
1363 handle->ready_heap = NULL;
1364 GNUNET_free (handle);
1369 * Check if we could queue a message of the given size for
1370 * transmission. The transport service will take both its
1371 * internal buffers and bandwidth limits imposed by the
1372 * other peer into consideration when answering this query.
1374 * @param handle connection to transport service
1375 * @param target who should receive the message
1376 * @param size how big is the message we want to transmit?
1377 * @param priority how important is the message?
1378 * @param timeout after how long should we give up (and call
1379 * notify with buf NULL and size 0)?
1380 * @param notify function to call when we are ready to
1381 * send such a message
1382 * @param notify_cls closure for notify
1383 * @return NULL if someone else is already waiting to be notified
1384 * non-NULL if the notify callback was queued (can be used to cancel
1385 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1387 struct GNUNET_TRANSPORT_TransmitHandle *
1388 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
1389 const struct GNUNET_PeerIdentity *target,
1392 struct GNUNET_TIME_Relative timeout,
1393 GNUNET_CONNECTION_TransmitReadyNotify notify,
1396 struct Neighbour *n;
1397 struct GNUNET_TRANSPORT_TransmitHandle *th;
1398 struct GNUNET_TIME_Relative delay;
1400 n = neighbour_find (handle, target);
1403 /* use GNUNET_TRANSPORT_try_connect first, only use this function
1404 once a connection has been established */
1410 /* attempt to send two messages at the same time to the same peer */
1414 GNUNET_assert (NULL == n->hn);
1415 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1417 th->notify = notify;
1418 th->notify_cls = notify_cls;
1419 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1420 th->notify_size = size;
1421 th->priority = priority;
1423 /* calculate when our transmission should be ready */
1424 delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker, size);
1425 if (delay.rel_value > timeout.rel_value)
1426 delay.rel_value = 0; /* notify immediately (with failure) */
1428 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1429 "Bandwidth tracker allows next transmission to peer %s in %llu ms\n",
1430 GNUNET_i2s (target),
1431 (unsigned long long) delay.rel_value);
1433 n->hn = GNUNET_CONTAINER_heap_insert (handle->ready_heap,
1436 schedule_transmission (handle);
1442 * Cancel the specified transmission-ready notification.
1444 * @param th handle returned from GNUNET_TRANSPORT_notify_transmit_ready
1447 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitHandle *th)
1449 struct Neighbour *n;
1451 GNUNET_assert (NULL == th->next);
1452 GNUNET_assert (NULL == th->prev);
1454 GNUNET_assert (th == n->th);
1458 GNUNET_CONTAINER_heap_remove_node (n->hn);
1463 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != th->timeout_task);
1464 GNUNET_SCHEDULER_cancel (th->timeout_task);
1465 th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1471 /* end of transport_api.c */