2 This file is part of GNUnet.
3 (C) 2009, 2010 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 2, 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 #include "gnunet_bandwidth_lib.h"
28 #include "gnunet_client_lib.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_container_lib.h"
31 #include "gnunet_arm_service.h"
32 #include "gnunet_hello_lib.h"
33 #include "gnunet_protocols.h"
34 #include "gnunet_server_lib.h"
35 #include "gnunet_time_lib.h"
36 #include "gnunet_transport_service.h"
37 #include "transport.h"
40 * After how long do we give up on transmitting a HELLO
43 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
46 * After how long do we automatically retry an unsuccessful
49 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
52 * How long should ARM wait when starting up the
53 * transport service before reporting back?
55 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
58 * How long should ARM wait when stopping the
59 * transport service before reporting back?
61 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
65 * What stage are we in for transmission processing?
75 * Message in local queue, not given to service.
80 * Message given to service, not confirmed (no SEND_OK).
85 * One message was given to service and before it was confirmed,
86 * another one was already queued (waiting for SEND_OK to pass on
89 TS_TRANSMITTED_QUEUED = 3
94 * Handle for a transmission-ready request.
96 struct GNUNET_TRANSPORT_TransmitHandle
100 * Neighbour for this handle, NULL for control-traffic.
102 struct NeighbourList *neighbour;
105 * Function to call when notify_size bytes are available
108 GNUNET_CONNECTION_TransmitReadyNotify notify;
111 * Closure for notify.
116 * transmit_ready task Id. The task is used to introduce the
117 * artificial delay that may be required to maintain the bandwidth
118 * limits. Later, this will be the ID of the "transmit_timeout"
119 * task which is used to signal a timeout if the transmission could
120 * not be done in a timely fashion.
122 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
125 * Timeout for this request.
127 struct GNUNET_TIME_Absolute timeout;
130 * How many bytes is our notify callback waiting for?
135 * How important is this message?
137 unsigned int priority;
143 * Handle for a control message queue entry.
145 struct ControlMessage
149 * This is a doubly-linked list.
151 struct ControlMessage *next;
154 * This is a doubly-linked list.
156 struct ControlMessage *prev;
159 * Overall transport handle.
161 struct GNUNET_TRANSPORT_Handle *h;
164 * Function to call when notify_size bytes are available
167 GNUNET_CONNECTION_TransmitReadyNotify notify;
170 * Closure for notify.
175 * transmit_ready task Id. The task is used to introduce the
176 * artificial delay that may be required to maintain the bandwidth
177 * limits. Later, this will be the ID of the "transmit_timeout"
178 * task which is used to signal a timeout if the transmission could
179 * not be done in a timely fashion.
181 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
184 * How many bytes is our notify callback waiting for?
192 * Entry in linked list of all of our current neighbours.
198 * This is a linked list.
200 struct NeighbourList *next;
203 * Overall transport handle.
205 struct GNUNET_TRANSPORT_Handle *h;
208 * Active transmit handle; available if 'transmit_forbidden'
211 struct GNUNET_TRANSPORT_TransmitHandle transmit_handle;
214 * Identity of this neighbour.
216 struct GNUNET_PeerIdentity id;
219 * Outbound bandwidh tracker.
221 struct GNUNET_BANDWIDTH_Tracker out_tracker;
224 * Set to GNUNET_NO if we are currently allowed to accept a
225 * message to the transport service for this peer, GNUNET_YES
226 * if we have one and are waiting for transmission, GNUNET_SYSERR
227 * if we are waiting for confirmation AND have already accepted
228 * yet another message.
230 enum TransmitStage transmit_stage;
233 * Have we received a notification that this peer is connected
242 * Linked list of requests from clients for our HELLO that were
249 * This is a linked list.
251 struct HelloWaitList *next;
254 * Reference back to our transport handle.
256 struct GNUNET_TRANSPORT_Handle *handle;
259 * Callback to call once we got our HELLO.
261 GNUNET_TRANSPORT_HelloUpdateCallback rec;
272 * Handle for the transport service (includes all of the
273 * state for the transport service).
275 struct GNUNET_TRANSPORT_Handle
279 * Closure for the callbacks.
284 * Function to call for received data.
286 GNUNET_TRANSPORT_ReceiveCallback rec;
289 * function to call on connect events
291 GNUNET_TRANSPORT_NotifyConnect nc_cb;
294 * function to call on disconnect events
296 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
299 * Head of DLL of control messages.
301 struct ControlMessage *control_head;
304 * Tail of DLL of control messages.
306 struct ControlMessage *control_tail;
309 * The current HELLO message for this peer. Updated
310 * whenever transports change their addresses.
312 struct GNUNET_HELLO_Message *my_hello;
315 * My client connection to the transport service.
317 struct GNUNET_CLIENT_Connection *client;
320 * Handle to our registration with the client for notification.
322 struct GNUNET_CLIENT_TransmitHandle *network_handle;
325 * Linked list of pending requests for our HELLO.
327 struct HelloWaitList *hwl_head;
332 struct GNUNET_SCHEDULER_Handle *sched;
337 const struct GNUNET_CONFIGURATION_Handle *cfg;
340 * Linked list of the current neighbours of this peer.
342 struct NeighbourList *neighbours;
345 * ID of the task trying to reconnect to the service.
347 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
350 * ID of the task trying to trigger transmission for a peer
351 * while maintaining bandwidth quotas.
353 GNUNET_SCHEDULER_TaskIdentifier quota_task;
356 * Delay until we try to reconnect.
358 struct GNUNET_TIME_Relative reconnect_delay;
361 * Set once we are in the process of disconnecting from the
369 // FIXME: replace with hash map!
371 * Get the neighbour list entry for the given peer
373 * @param h our context
374 * @param peer peer to look up
375 * @return NULL if no such peer entry exists
377 static struct NeighbourList *
378 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
379 const struct GNUNET_PeerIdentity *peer)
381 struct NeighbourList *pos;
384 while ((pos != NULL) &&
385 (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
392 * Schedule the task to send one message, either from the control
393 * list or the peer message queues to the service.
395 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
399 * Function called by the scheduler when the timeout for bandwidth
400 * availablility for the target neighbour is reached.
402 * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
403 * @param tc scheduler context
406 quota_transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
408 struct GNUNET_TRANSPORT_Handle *h = cls;
410 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
411 schedule_transmission (h);
416 * Figure out which transmission to a peer can be done right now.
417 * If none can, schedule a task to call 'schedule_transmission'
418 * whenever a peer transmission can be done in the future and
419 * return NULL. Otherwise return the next transmission to be
422 * @param h handle to transport
423 * @return NULL to wait longer before doing any peer transmissions
425 static struct GNUNET_TRANSPORT_TransmitHandle *
426 schedule_peer_transmission (struct GNUNET_TRANSPORT_Handle *h)
428 struct GNUNET_TRANSPORT_TransmitHandle *ret;
429 struct GNUNET_TRANSPORT_TransmitHandle *th;
430 struct NeighbourList *n;
431 struct NeighbourList *next;
432 struct GNUNET_TIME_Relative retry_time;
433 struct GNUNET_TIME_Relative duration;
435 if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
437 GNUNET_SCHEDULER_cancel (h->sched,
439 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
441 retry_time = GNUNET_TIME_UNIT_FOREVER_REL;
443 next = h->neighbours;
444 while (NULL != (n = next))
447 if (n->transmit_stage != TS_QUEUED)
448 continue; /* not eligible */
449 th = &n->transmit_handle;
450 GNUNET_break (n == th->neighbour);
451 /* check outgoing quota */
452 duration = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
453 th->notify_size - sizeof (struct OutboundMessage));
454 if (th->timeout.value < duration.value)
456 /* signal timeout! */
458 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
459 "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long. Signaling timeout.\n",
461 GNUNET_i2s (&n->id));
463 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
465 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
466 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
468 n->transmit_stage = TS_NEW;
469 if (NULL != th->notify)
470 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
473 if (duration.value > 0)
476 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
477 "Need more bandwidth (%u b/s allowed, %u b needed), delaying delivery to `%4s' by %llu ms\n",
478 (unsigned int) n->out_tracker.available_bytes_per_s__,
479 (unsigned int) th->notify_size - sizeof (struct OutboundMessage),
483 retry_time = GNUNET_TIME_relative_min (retry_time,
488 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
489 "Have %u bytes of bandwidth available for transmission to `%4s' right now\n",
490 th->notify_size - sizeof (struct OutboundMessage),
491 GNUNET_i2s (&n->id));
493 if ( (ret == NULL) ||
494 (ret->priority < th->priority) )
498 h->quota_task = GNUNET_SCHEDULER_add_delayed (h->sched,
500 "a_transmit_ready,
507 * Transmit message(s) to service.
509 * @param cls handle to transport
510 * @param size number of bytes available in buf
511 * @param buf where to copy the message
512 * @return number of bytes copied to buf
515 transport_notify_ready (void *cls, size_t size, void *buf)
517 struct GNUNET_TRANSPORT_Handle *h = cls;
518 struct ControlMessage *cm;
519 struct GNUNET_TRANSPORT_TransmitHandle *th;
520 struct NeighbourList *n;
521 struct OutboundMessage obm;
526 h->network_handle = NULL;
529 schedule_transmission (h);
533 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
534 "Ready to transmit %u bytes to transport service\n", size);
538 while ( (NULL != (cm = h->control_head)) &&
539 (cm->notify_size <= size) )
541 if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
543 GNUNET_SCHEDULER_cancel (h->sched, cm->notify_delay_task);
544 cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
546 GNUNET_CONTAINER_DLL_remove (h->control_head,
549 ret += cm->notify (cm->notify_cls, size, &cbuf[ret]);
553 while ( (NULL != (th = schedule_peer_transmission (h))) &&
554 (th->notify_size <= size) )
556 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
558 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
559 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
562 switch (n->transmit_stage)
568 n->transmit_stage = TS_TRANSMITTED;
573 case TS_TRANSMITTED_QUEUED:
579 GNUNET_assert (size >= sizeof (struct OutboundMessage));
580 mret = th->notify (th->notify_cls,
581 size - sizeof (struct OutboundMessage),
582 &cbuf[ret + sizeof (struct OutboundMessage)]);
583 GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
585 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
586 "Message of %u bytes with timeout %llums constructed for `%4s'\n",
588 (unsigned long long) GNUNET_TIME_absolute_get_remaining (th->timeout).value,
589 GNUNET_i2s (&n->id));
593 obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
594 obm.header.size = htons (mret + sizeof (struct OutboundMessage));
595 obm.priority = htonl (th->priority);
596 obm.timeout = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (th->timeout));
598 memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
599 ret += (mret + sizeof (struct OutboundMessage));
600 size -= (mret + sizeof (struct OutboundMessage));
601 GNUNET_BANDWIDTH_tracker_consume (&n->out_tracker, mret);
605 switch (n->transmit_stage)
614 n->transmit_stage = TS_NEW;
616 case TS_TRANSMITTED_QUEUED:
617 n->transmit_stage = TS_QUEUED;
624 schedule_transmission (h);
626 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
627 "Transmitting %u bytes to transport service\n", ret);
634 * Schedule the task to send one message, either from the control
635 * list or the peer message queues to the service.
638 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
641 struct GNUNET_TIME_Relative timeout;
642 struct GNUNET_TRANSPORT_TransmitHandle *th;
644 if (NULL != h->network_handle)
646 if (h->client == NULL)
648 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
649 "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
650 return; /* not yet connected */
652 if (NULL != h->control_head)
654 size = h->control_head->notify_size;
655 timeout = GNUNET_TIME_UNIT_FOREVER_REL;
659 th = schedule_peer_transmission (h);
662 /* no transmission ready right now */
665 size = th->notify_size;
666 timeout = GNUNET_TIME_absolute_get_remaining (th->timeout);
669 GNUNET_CLIENT_notify_transmit_ready (h->client,
673 &transport_notify_ready,
675 GNUNET_assert (NULL != h->network_handle);
680 * Called when our transmit request timed out before any transport
681 * reported success connecting to the desired peer or before the
682 * transport was ready to receive. Signal error and free
686 control_transmit_timeout (void *cls,
687 const struct GNUNET_SCHEDULER_TaskContext *tc)
689 struct ControlMessage *th = cls;
691 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
692 if (NULL != th->notify)
693 th->notify (th->notify_cls, 0, NULL);
694 GNUNET_CONTAINER_DLL_remove (th->h->control_head,
702 * Queue control request for transmission to the transport
705 * @param h handle to the transport service
706 * @param size number of bytes to be transmitted
707 * @param at_head request must be added to the head of the queue
708 * (otherwise request will be appended)
709 * @param timeout how long this transmission can wait (at most)
710 * @param notify function to call to get the content
711 * @param notify_cls closure for notify
714 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
717 struct GNUNET_TIME_Relative timeout,
718 GNUNET_CONNECTION_TransmitReadyNotify notify,
721 struct ControlMessage *th;
724 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
725 "Control transmit of %u bytes within %llums requested\n",
726 size, (unsigned long long) timeout.value);
728 th = GNUNET_malloc (sizeof (struct ControlMessage));
731 th->notify_cls = notify_cls;
732 th->notify_size = size;
733 th->notify_delay_task
734 = GNUNET_SCHEDULER_add_delayed (h->sched,
735 timeout, &control_transmit_timeout, th);
737 GNUNET_CONTAINER_DLL_insert (h->control_head,
741 GNUNET_CONTAINER_DLL_insert_after (h->control_head,
745 schedule_transmission (h);
749 struct SetQuotaContext
751 struct GNUNET_TRANSPORT_Handle *handle;
753 struct GNUNET_PeerIdentity target;
755 GNUNET_SCHEDULER_Task cont;
759 struct GNUNET_TIME_Absolute timeout;
761 struct GNUNET_BANDWIDTH_Value32NBO quota_in;
766 * Send SET_QUOTA message to the service.
768 * @param cls the 'struct SetQuotaContext'
769 * @param size number of bytes available in buf
770 * @param buf where to copy the message
771 * @return number of bytes copied to buf
774 send_set_quota (void *cls, size_t size, void *buf)
776 struct SetQuotaContext *sqc = cls;
777 struct QuotaSetMessage *msg;
781 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
784 GNUNET_SCHEDULER_REASON_TIMEOUT);
789 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
790 "Transmitting `%s' request with respect to `%4s'.\n",
792 GNUNET_i2s (&sqc->target));
794 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
796 msg->header.size = htons (sizeof (struct QuotaSetMessage));
797 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
798 msg->quota = sqc->quota_in;
799 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
800 if (sqc->cont != NULL)
801 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
804 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
806 return sizeof (struct QuotaSetMessage);
811 * Set the share of incoming bandwidth for the given
812 * peer to the specified amount.
814 * @param handle connection to transport service
815 * @param target who's bandwidth quota is being changed
816 * @param quota_in incoming bandwidth quota in bytes per ms
817 * @param quota_out outgoing bandwidth quota in bytes per ms
818 * @param timeout how long to wait until signaling failure if
819 * we can not communicate the quota change
820 * @param cont continuation to call when done, will be called
821 * either with reason "TIMEOUT" or with reason "PREREQ_DONE"
822 * @param cont_cls closure for continuation
825 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
826 const struct GNUNET_PeerIdentity *target,
827 struct GNUNET_BANDWIDTH_Value32NBO quota_in,
828 struct GNUNET_BANDWIDTH_Value32NBO quota_out,
829 struct GNUNET_TIME_Relative timeout,
830 GNUNET_SCHEDULER_Task cont, void *cont_cls)
832 struct NeighbourList *n;
833 struct SetQuotaContext *sqc;
835 n = neighbour_find (handle, target);
839 if (ntohl (quota_out.value__) != n->out_tracker.available_bytes_per_s__)
840 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
841 "Quota changed from %u to %u for peer `%s'\n",
842 (unsigned int) n->out_tracker.available_bytes_per_s__,
843 (unsigned int) ntohl (quota_out.value__),
844 GNUNET_i2s (target));
846 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
847 "Quota remains at %u for peer `%s'\n",
848 (unsigned int) n->out_tracker.available_bytes_per_s__,
849 GNUNET_i2s (target));
851 GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker,
857 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
858 "Quota changed to %u for peer `%s', but I have no such neighbour!\n",
859 (unsigned int) ntohl (quota_out.value__),
860 GNUNET_i2s (target));
863 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
864 sqc->handle = handle;
865 sqc->target = *target;
867 sqc->cont_cls = cont_cls;
868 sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
869 sqc->quota_in = quota_in;
870 schedule_control_transmit (handle,
871 sizeof (struct QuotaSetMessage),
872 GNUNET_NO, timeout, &send_set_quota, sqc);
877 * Obtain the HELLO message for this peer.
879 * @param handle connection to transport service
880 * @param rec function to call with the HELLO, sender will be our peer
881 * identity; message and sender will be NULL on timeout
882 * (handshake with transport service pending/failed).
883 * cost estimate will be 0.
884 * @param rec_cls closure for rec
887 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
888 GNUNET_TRANSPORT_HelloUpdateCallback rec,
891 struct HelloWaitList *hwl;
893 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
894 hwl->next = handle->hwl_head;
895 handle->hwl_head = hwl;
896 hwl->handle = handle;
898 hwl->rec_cls = rec_cls;
899 if (handle->my_hello == NULL)
901 rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
907 * Stop receiving updates about changes to our HELLO message.
909 * @param handle connection to transport service
910 * @param rec function previously registered to be called with the HELLOs
911 * @param rec_cls closure for rec
914 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
915 GNUNET_TRANSPORT_HelloUpdateCallback rec,
918 struct HelloWaitList *pos;
919 struct HelloWaitList *prev;
922 pos = handle->hwl_head;
925 if ( (pos->rec == rec) &&
926 (pos->rec_cls == rec_cls) )
931 GNUNET_break (pos != NULL);
935 handle->hwl_head = pos->next;
937 prev->next = pos->next;
943 * Send HELLO message to the service.
945 * @param cls the HELLO message to send
946 * @param size number of bytes available in buf
947 * @param buf where to copy the message
948 * @return number of bytes copied to buf
951 send_hello (void *cls, size_t size, void *buf)
953 struct GNUNET_MessageHeader *hello = cls;
958 #if DEBUG_TRANSPORT_TIMEOUT
959 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
960 "Timeout while trying to transmit `%s' request.\n",
967 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
968 "Transmitting `%s' request.\n", "HELLO");
970 msize = ntohs (hello->size);
971 GNUNET_assert (size >= msize);
972 memcpy (buf, hello, msize);
979 * Offer the transport service the HELLO of another peer. Note that
980 * the transport service may just ignore this message if the HELLO is
981 * malformed or useless due to our local configuration.
983 * @param handle connection to transport service
984 * @param hello the hello message
987 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
988 const struct GNUNET_MessageHeader *hello)
990 struct GNUNET_MessageHeader *hc;
992 struct GNUNET_PeerIdentity peer;
994 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
995 size = ntohs (hello->size);
996 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
997 if (GNUNET_OK != GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message*) hello,
1004 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1005 "Offering `%s' message of `%4s' to transport for validation.\n",
1007 GNUNET_i2s (&peer));
1009 hc = GNUNET_malloc (size);
1010 memcpy (hc, hello, size);
1011 schedule_control_transmit (handle,
1013 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
1018 * Transmit START message to service.
1021 * @param size number of bytes available in buf
1022 * @param buf where to copy the message
1023 * @return number of bytes copied to buf
1026 send_start (void *cls, size_t size, void *buf)
1028 struct GNUNET_MessageHeader *s = buf;
1032 /* Can only be shutdown, just give up */
1034 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1035 "Shutdown while trying to transmit `%s' request.\n",
1041 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1042 "Transmitting `%s' request.\n", "START");
1044 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
1045 s->size = htons (sizeof (struct GNUNET_MessageHeader));
1046 s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
1047 return sizeof (struct GNUNET_MessageHeader);
1054 * @param n the entry to free
1057 neighbour_free (struct NeighbourList *n)
1059 struct GNUNET_TRANSPORT_Handle *h;
1060 struct NeighbourList *prev;
1061 struct NeighbourList *pos;
1065 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1066 "Removing neighbour `%s' from list of connected peers.\n",
1067 GNUNET_i2s (&n->id));
1069 GNUNET_break (n->is_connected == GNUNET_NO);
1070 GNUNET_break (n->transmit_stage == TS_NEW);
1073 pos = h->neighbours;
1080 h->neighbours = n->next;
1082 prev->next = n->next;
1088 * Mark neighbour as disconnected.
1090 * @param n the entry to mark as disconnected
1093 neighbour_disconnect (struct NeighbourList *n)
1095 struct GNUNET_TRANSPORT_Handle *h = n->h;
1097 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1098 "Removing neighbour `%s' from list of connected peers.\n",
1099 GNUNET_i2s (&n->id));
1101 GNUNET_break (n->is_connected == GNUNET_YES);
1102 n->is_connected = GNUNET_NO;
1103 if (h->nc_cb != NULL)
1104 h->nd_cb (h->cls, &n->id);
1105 if (n->transmit_stage == TS_NEW)
1111 * Function we use for handling incoming messages.
1113 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1114 * @param msg message received, NULL on timeout or fatal error
1116 static void demultiplexer (void *cls,
1117 const struct GNUNET_MessageHeader *msg);
1121 * Try again to connect to transport service.
1123 * @param cls the handle to the transport service
1124 * @param tc scheduler context
1127 reconnect (void *cls,
1128 const struct GNUNET_SCHEDULER_TaskContext *tc)
1130 struct GNUNET_TRANSPORT_Handle *h = cls;
1131 struct ControlMessage *pos;
1132 struct NeighbourList *n;
1133 struct NeighbourList *next;
1135 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1136 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1138 /* shutdown, just give up */
1141 /* Forget about all neighbours that we used to be connected to */
1145 #if DEBUG_TRANSPORT_DISCONNECT
1146 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1147 "Disconnecting due to reconnect being called\n");
1150 if (n->is_connected)
1151 neighbour_disconnect (n);
1155 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1156 "Connecting to transport service.\n");
1158 GNUNET_assert (h->client == NULL);
1159 h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1160 GNUNET_assert (h->client != NULL);
1161 /* make sure we don't send "START" twice, remove existing entry from
1162 queue (if present) */
1163 pos = h->control_head;
1166 if (pos->notify == &send_start)
1168 GNUNET_CONTAINER_DLL_remove (h->control_head,
1171 if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1173 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1174 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1181 schedule_control_transmit (h,
1182 sizeof (struct GNUNET_MessageHeader),
1184 GNUNET_TIME_UNIT_FOREVER_REL, &send_start, NULL);
1185 GNUNET_CLIENT_receive (h->client,
1186 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1191 * Function that will schedule the job that will try
1192 * to connect us again to the client.
1194 * @param h transport service to reconnect
1197 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1200 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1201 "Scheduling task to reconnect to transport service in %llu ms.\n",
1202 h->reconnect_delay.value);
1204 GNUNET_assert (h->client == NULL);
1205 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1207 = GNUNET_SCHEDULER_add_delayed (h->sched,
1208 h->reconnect_delay, &reconnect, h);
1209 if (h->reconnect_delay.value == 0)
1211 h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
1215 h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
1216 h->reconnect_delay = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
1217 h->reconnect_delay);
1223 * Add neighbour to our list
1225 * @return NULL if this API is currently disconnecting from the service
1227 static struct NeighbourList *
1228 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
1229 const struct GNUNET_PeerIdentity *pid)
1231 struct NeighbourList *n;
1233 if (GNUNET_YES == h->in_disconnect)
1235 /* check for duplicates */
1236 if (NULL != (n = neighbour_find (h, pid)))
1242 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1243 "Creating entry for neighbour `%4s'.\n",
1246 n = GNUNET_malloc (sizeof (struct NeighbourList));
1248 GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
1249 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1250 MAX_BANDWIDTH_CARRY_S);
1251 n->next = h->neighbours;
1259 * Connect to the transport service. Note that the connection may
1260 * complete (or fail) asynchronously.
1262 * @param sched scheduler to use
1263 * @param cfg configuration to use
1264 * @param cls closure for the callbacks
1265 * @param rec receive function to call
1266 * @param nc function to call on connect events
1267 * @param nd function to call on disconnect events
1269 struct GNUNET_TRANSPORT_Handle *
1270 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1271 const struct GNUNET_CONFIGURATION_Handle *cfg,
1273 GNUNET_TRANSPORT_ReceiveCallback rec,
1274 GNUNET_TRANSPORT_NotifyConnect nc,
1275 GNUNET_TRANSPORT_NotifyDisconnect nd)
1277 struct GNUNET_TRANSPORT_Handle *ret;
1279 GNUNET_ARM_start_services (cfg, sched, "peerinfo", "transport", NULL);
1280 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1287 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1288 schedule_reconnect (ret);
1294 * Disconnect from the transport service.
1297 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1299 struct GNUNET_TRANSPORT_TransmitHandle *th;
1300 struct NeighbourList *n;
1301 struct HelloWaitList *hwl;
1302 struct GNUNET_CLIENT_Connection *client;
1303 struct ControlMessage *cm;
1306 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1308 handle->in_disconnect = GNUNET_YES;
1309 while (NULL != (n = handle->neighbours))
1311 handle->neighbours = n->next;
1312 switch (n->transmit_stage)
1315 case TS_TRANSMITTED:
1319 case TS_TRANSMITTED_QUEUED:
1320 th = &n->transmit_handle;
1321 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1323 GNUNET_SCHEDULER_cancel (handle->sched,
1324 th->notify_delay_task);
1325 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1327 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1334 while (NULL != (hwl = handle->hwl_head))
1336 handle->hwl_head = hwl->next;
1337 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1339 ("Disconnect while notification for `%s' still registered.\n"),
1341 if (hwl->rec != NULL)
1342 hwl->rec (hwl->rec_cls, NULL);
1346 /* Check for still scheduled control messages, cancel delay tasks if so */
1347 /* Added because somehow a notify_delay_task is remaining scheduled and is ever so annoying */
1348 while ( (NULL != (cm = handle->control_head)))
1350 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1351 _("Disconnect before control message sent!\n"));
1352 if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1354 GNUNET_SCHEDULER_cancel (handle->sched, cm->notify_delay_task);
1355 cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1357 GNUNET_CONTAINER_DLL_remove (handle->control_head,
1358 handle->control_tail,
1364 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1366 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1367 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1369 if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1371 GNUNET_SCHEDULER_cancel (handle->sched, handle->quota_task);
1372 handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1374 GNUNET_free_non_null (handle->my_hello);
1375 handle->my_hello = NULL;
1376 GNUNET_ARM_stop_services (handle->cfg, handle->sched, "transport",
1378 if (NULL != handle->network_handle)
1380 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->network_handle);
1381 handle->network_handle = NULL;
1383 if (NULL != (client = handle->client))
1386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1387 "Disconnecting from transport service for good.\n");
1389 handle->client = NULL;
1390 GNUNET_CLIENT_disconnect (client, GNUNET_NO);
1392 GNUNET_free (handle);
1397 * Function we use for handling incoming messages.
1399 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1400 * @param msg message received, NULL on timeout or fatal error
1403 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1405 struct GNUNET_TRANSPORT_Handle *h = cls;
1406 const struct DisconnectInfoMessage *dim;
1407 const struct ConnectInfoMessage *cim;
1408 const struct InboundMessage *im;
1409 const struct GNUNET_MessageHeader *imm;
1410 const struct SendOkMessage *okm;
1411 struct HelloWaitList *hwl;
1412 struct HelloWaitList *next_hwl;
1413 struct NeighbourList *n;
1414 struct GNUNET_PeerIdentity me;
1417 if (h->client == NULL)
1419 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1420 finish clean up work! */
1427 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1428 "Error receiving from transport service, disconnecting temporarily.\n");
1430 if (h->network_handle != NULL)
1432 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1433 h->network_handle = NULL;
1435 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
1437 schedule_reconnect (h);
1440 GNUNET_CLIENT_receive (h->client,
1441 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1442 size = ntohs (msg->size);
1443 switch (ntohs (msg->type))
1445 case GNUNET_MESSAGE_TYPE_HELLO:
1447 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1455 "Receiving (my own) `%s' message, I am `%4s'.\n",
1456 "HELLO", GNUNET_i2s (&me));
1458 GNUNET_free_non_null (h->my_hello);
1460 if (size < sizeof (struct GNUNET_MessageHeader))
1465 h->my_hello = GNUNET_malloc (size);
1466 memcpy (h->my_hello, msg, size);
1470 next_hwl = hwl->next;
1471 hwl->rec (hwl->rec_cls,
1472 (const struct GNUNET_MessageHeader *) h->my_hello);
1476 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1477 if (size != sizeof (struct ConnectInfoMessage))
1482 cim = (const struct ConnectInfoMessage *) msg;
1484 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1485 "Receiving `%s' message for `%4s'.\n",
1486 "CONNECT", GNUNET_i2s (&cim->id));
1488 n = neighbour_find (h, &cim->id);
1490 n = neighbour_add (h,
1494 GNUNET_break (n->is_connected == GNUNET_NO);
1495 n->is_connected = GNUNET_YES;
1496 if (h->nc_cb != NULL)
1497 h->nc_cb (h->cls, &n->id,
1498 GNUNET_TIME_relative_ntoh (cim->latency),
1499 ntohs (cim->distance));
1501 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1502 if (size != sizeof (struct DisconnectInfoMessage))
1507 dim = (const struct DisconnectInfoMessage *) msg;
1508 #if DEBUG_TRANSPORT_DISCONNECT
1509 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1510 "Receiving `%s' message for `%4s'.\n",
1512 GNUNET_i2s (&dim->peer));
1514 n = neighbour_find (h, &dim->peer);
1515 GNUNET_break (n != NULL);
1517 neighbour_disconnect (n);
1519 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1520 if (size != sizeof (struct SendOkMessage))
1525 okm = (const struct SendOkMessage *) msg;
1527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1528 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1529 ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
1531 n = neighbour_find (h, &okm->peer);
1532 GNUNET_assert (n != NULL);
1533 switch (n->transmit_stage)
1541 case TS_TRANSMITTED:
1542 n->transmit_stage = TS_NEW;
1544 case TS_TRANSMITTED_QUEUED:
1545 n->transmit_stage = TS_QUEUED;
1546 schedule_transmission (h);
1552 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1554 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1555 "Receiving `%s' message.\n", "RECV");
1558 sizeof (struct InboundMessage) +
1559 sizeof (struct GNUNET_MessageHeader))
1564 im = (const struct InboundMessage *) msg;
1565 imm = (const struct GNUNET_MessageHeader *) &im[1];
1566 if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1572 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1573 "Received message of type %u from `%4s'.\n",
1574 ntohs (imm->type), GNUNET_i2s (&im->peer));
1576 n = neighbour_find (h, &im->peer);
1578 n = neighbour_add (h, &im->peer);
1582 h->rec (h->cls, &im->peer, imm,
1583 GNUNET_TIME_relative_ntoh (im->latency), ntohs(im->distance));
1586 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1588 ("Received unexpected message of type %u in %s:%u\n"),
1589 ntohs (msg->type), __FILE__, __LINE__);
1597 * Called when our transmit request timed out before any transport
1598 * reported success connecting to the desired peer or before the
1599 * transport was ready to receive. Signal error and free
1602 * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle*' that is timing out
1603 * @param tc scheduler context
1606 peer_transmit_timeout (void *cls,
1607 const struct GNUNET_SCHEDULER_TaskContext *tc)
1609 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1610 struct NeighbourList *n;
1611 GNUNET_CONNECTION_TransmitReadyNotify notify;
1614 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1617 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1618 "Triggering timeout for request to transmit to `%4s' (%d)\n",
1619 GNUNET_i2s (&n->id),
1622 notify = th->notify;
1623 notify_cls = th->notify_cls;
1624 switch (n->transmit_stage)
1630 n->transmit_stage = TS_NEW;
1631 if (n->is_connected == GNUNET_NO)
1634 case TS_TRANSMITTED:
1637 case TS_TRANSMITTED_QUEUED:
1638 n->transmit_stage = TS_TRANSMITTED;
1644 notify (notify_cls, 0, NULL);
1649 * Check if we could queue a message of the given size for
1650 * transmission. The transport service will take both its
1651 * internal buffers and bandwidth limits imposed by the
1652 * other peer into consideration when answering this query.
1654 * @param handle connection to transport service
1655 * @param target who should receive the message
1656 * @param size how big is the message we want to transmit?
1657 * @param priority how important is the message?
1658 * @param timeout after how long should we give up (and call
1659 * notify with buf NULL and size 0)?
1660 * @param notify function to call when we are ready to
1661 * send such a message
1662 * @param notify_cls closure for notify
1663 * @return NULL if someone else is already waiting to be notified
1664 * non-NULL if the notify callback was queued (can be used to cancel
1665 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1667 struct GNUNET_TRANSPORT_TransmitHandle *
1668 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1670 const struct GNUNET_PeerIdentity
1671 *target, size_t size,
1672 unsigned int priority,
1673 struct GNUNET_TIME_Relative timeout,
1674 GNUNET_CONNECTION_TransmitReadyNotify
1675 notify, void *notify_cls)
1677 struct GNUNET_TRANSPORT_TransmitHandle *th;
1678 struct NeighbourList *n;
1680 if (size + sizeof (struct OutboundMessage) >=
1681 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1684 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1685 "Message size is %d, max allowed is %d.\n",
1686 size + sizeof (struct OutboundMessage), GNUNET_SERVER_MAX_MESSAGE_SIZE);
1692 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1693 "Asking transport service for transmission of %u bytes to peer `%4s' within %llu ms.\n",
1694 size, GNUNET_i2s (target),
1695 (unsigned long long) timeout.value);
1697 n = neighbour_find (handle, target);
1699 n = neighbour_add (handle, target);
1702 switch (n->transmit_stage)
1705 n->transmit_stage = TS_QUEUED;
1710 case TS_TRANSMITTED:
1711 n->transmit_stage = TS_TRANSMITTED_QUEUED;
1713 case TS_TRANSMITTED_QUEUED:
1720 th = &n->transmit_handle;
1722 th->notify = notify;
1723 th->notify_cls = notify_cls;
1724 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1725 th->notify_size = size + sizeof (struct OutboundMessage);
1726 th->priority = priority;
1727 th->notify_delay_task
1728 = GNUNET_SCHEDULER_add_delayed (handle->sched, timeout,
1729 &peer_transmit_timeout, th);
1730 schedule_transmission (handle);
1736 * Cancel the specified transmission-ready notification.
1739 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1740 GNUNET_TRANSPORT_TransmitHandle
1743 struct NeighbourList *n;
1747 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1748 "Transmission request of %u bytes to `%4s' was cancelled.\n",
1749 th->notify_size - sizeof (struct OutboundMessage),
1750 GNUNET_i2s (&n->id));
1752 switch (n->transmit_stage)
1758 n->transmit_stage = TS_NEW;
1759 if (n->is_connected == GNUNET_NO)
1762 case TS_TRANSMITTED:
1765 case TS_TRANSMITTED_QUEUED:
1766 n->transmit_stage = TS_TRANSMITTED;
1774 /* end of transport_api.c */