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_client_lib.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_container_lib.h"
30 #include "gnunet_arm_service.h"
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_protocols.h"
33 #include "gnunet_server_lib.h"
34 #include "gnunet_time_lib.h"
35 #include "gnunet_transport_service.h"
36 #include "transport.h"
39 * After how long do we give up on transmitting a HELLO
42 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
45 * After how long do we automatically retry an unsuccessful
48 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
51 * How long should ARM wait when starting up the
52 * transport service before reporting back?
54 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
57 * How long should ARM wait when stopping the
58 * transport service before reporting back?
60 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
64 * What stage are we in for transmission processing?
74 * Message in local queue, not given to service.
79 * Message given to service, not confirmed (no SEND_OK).
84 * One message was given to service and before it was confirmed,
85 * another one was already queued (waiting for SEND_OK to pass on
88 TS_TRANSMITTED_QUEUED = 3
93 * Handle for a transmission-ready request.
95 struct GNUNET_TRANSPORT_TransmitHandle
99 * Neighbour for this handle, NULL for control-traffic.
101 struct NeighbourList *neighbour;
104 * Function to call when notify_size bytes are available
107 GNUNET_CONNECTION_TransmitReadyNotify notify;
110 * Closure for notify.
115 * transmit_ready task Id. The task is used to introduce the
116 * artificial delay that may be required to maintain the bandwidth
117 * limits. Later, this will be the ID of the "transmit_timeout"
118 * task which is used to signal a timeout if the transmission could
119 * not be done in a timely fashion.
121 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
124 * Timeout for this request.
126 struct GNUNET_TIME_Absolute timeout;
129 * How many bytes is our notify callback waiting for?
134 * How important is this message?
136 unsigned int priority;
142 * Handle for a control message queue entry.
144 struct ControlMessage
148 * This is a doubly-linked list.
150 struct ControlMessage *next;
153 * This is a doubly-linked list.
155 struct ControlMessage *prev;
158 * Overall transport handle.
160 struct GNUNET_TRANSPORT_Handle *h;
163 * Function to call when notify_size bytes are available
166 GNUNET_CONNECTION_TransmitReadyNotify notify;
169 * Closure for notify.
174 * transmit_ready task Id. The task is used to introduce the
175 * artificial delay that may be required to maintain the bandwidth
176 * limits. Later, this will be the ID of the "transmit_timeout"
177 * task which is used to signal a timeout if the transmission could
178 * not be done in a timely fashion.
180 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
183 * How many bytes is our notify callback waiting for?
191 * Entry in linked list of all of our current neighbours.
197 * This is a linked list.
199 struct NeighbourList *next;
202 * Overall transport handle.
204 struct GNUNET_TRANSPORT_Handle *h;
207 * Active transmit handle; available if 'transmit_forbidden'
210 struct GNUNET_TRANSPORT_TransmitHandle transmit_handle;
213 * Identity of this neighbour.
215 struct GNUNET_PeerIdentity id;
218 * At what time did we reset last_sent last?
220 struct GNUNET_TIME_Absolute last_quota_update;
223 * How many bytes have we sent since the "last_quota_update"
229 * Quota for outbound traffic to the neighbour in bytes/ms.
234 * Set to GNUNET_NO if we are currently allowed to accept a
235 * message to the transport service for this peer, GNUNET_YES
236 * if we have one and are waiting for transmission, GNUNET_SYSERR
237 * if we are waiting for confirmation AND have already accepted
238 * yet another message.
240 enum TransmitStage transmit_stage;
243 * Have we received a notification that this peer is connected
252 * Linked list of requests from clients for our HELLO that were
259 * This is a linked list.
261 struct HelloWaitList *next;
264 * Reference back to our transport handle.
266 struct GNUNET_TRANSPORT_Handle *handle;
269 * Callback to call once we got our HELLO.
271 GNUNET_TRANSPORT_HelloUpdateCallback rec;
282 * Handle for the transport service (includes all of the
283 * state for the transport service).
285 struct GNUNET_TRANSPORT_Handle
289 * Closure for the callbacks.
294 * Function to call for received data.
296 GNUNET_TRANSPORT_ReceiveCallback rec;
299 * function to call on connect events
301 GNUNET_TRANSPORT_NotifyConnect nc_cb;
304 * function to call on disconnect events
306 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
309 * Head of DLL of control messages.
311 struct ControlMessage *control_head;
314 * Tail of DLL of control messages.
316 struct ControlMessage *control_tail;
319 * The current HELLO message for this peer. Updated
320 * whenever transports change their addresses.
322 struct GNUNET_HELLO_Message *my_hello;
325 * My client connection to the transport service.
327 struct GNUNET_CLIENT_Connection *client;
330 * Handle to our registration with the client for notification.
332 struct GNUNET_CLIENT_TransmitHandle *network_handle;
335 * Linked list of pending requests for our HELLO.
337 struct HelloWaitList *hwl_head;
342 struct GNUNET_SCHEDULER_Handle *sched;
347 const struct GNUNET_CONFIGURATION_Handle *cfg;
350 * Linked list of the current neighbours of this peer.
352 struct NeighbourList *neighbours;
355 * ID of the task trying to reconnect to the service.
357 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
360 * ID of the task trying to trigger transmission for a peer
361 * while maintaining bandwidth quotas.
363 GNUNET_SCHEDULER_TaskIdentifier quota_task;
366 * Delay until we try to reconnect.
368 struct GNUNET_TIME_Relative reconnect_delay;
373 // FIXME: replace with hash map!
375 * Get the neighbour list entry for the given peer
377 * @param h our context
378 * @param peer peer to look up
379 * @return NULL if no such peer entry exists
381 static struct NeighbourList *
382 neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
383 const struct GNUNET_PeerIdentity *peer)
385 struct NeighbourList *pos;
388 while ((pos != NULL) &&
389 (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
396 * Schedule the task to send one message, either from the control
397 * list or the peer message queues to the service.
399 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
403 * Function called by the scheduler when the timeout for bandwidth
404 * availablility for the target neighbour is reached.
406 * @param cls the 'struct GNUNET_TRANSPORT_Handle*'
407 * @param tc scheduler context
410 quota_transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
412 struct GNUNET_TRANSPORT_Handle *h = cls;
414 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
415 schedule_transmission (h);
420 * Update the quota values for the given neighbour now.
422 * @param n neighbour to update
425 update_quota (struct NeighbourList *n)
427 struct GNUNET_TIME_Relative delta;
431 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
432 allowed = delta.value * n->quota_out;
433 if (n->last_sent < allowed)
435 remaining = allowed - n->last_sent;
436 if (n->quota_out > 0)
437 remaining /= n->quota_out;
440 if (remaining > MAX_BANDWIDTH_CARRY)
441 remaining = MAX_BANDWIDTH_CARRY;
443 n->last_quota_update = GNUNET_TIME_absolute_get ();
444 n->last_quota_update.value -= remaining;
448 n->last_sent -= allowed;
449 n->last_quota_update = GNUNET_TIME_absolute_get ();
455 * Figure out which transmission to a peer can be done right now.
456 * If none can, schedule a task to call 'schedule_transmission'
457 * whenever a peer transmission can be done in the future and
458 * return NULL. Otherwise return the next transmission to be
461 * @param h handle to transport
462 * @return NULL to wait longer before doing any peer transmissions
464 static struct GNUNET_TRANSPORT_TransmitHandle *
465 schedule_peer_transmission (struct GNUNET_TRANSPORT_Handle *h)
467 struct GNUNET_TRANSPORT_TransmitHandle *ret;
468 struct GNUNET_TRANSPORT_TransmitHandle *th;
469 struct NeighbourList *n;
470 struct NeighbourList *next;
471 struct GNUNET_TIME_Relative retry_time;
472 struct GNUNET_TIME_Relative duration;
475 if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
477 GNUNET_SCHEDULER_cancel (h->sched,
479 h->quota_task = GNUNET_SCHEDULER_NO_TASK;
481 retry_time = GNUNET_TIME_UNIT_FOREVER_REL;
483 next = h->neighbours;
484 while (NULL != (n = next))
487 if (n->transmit_stage != TS_QUEUED)
488 continue; /* not eligible */
489 th = &n->transmit_handle;
490 /* check outgoing quota */
491 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
492 if (duration.value > MIN_QUOTA_REFRESH_TIME)
495 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
497 available = duration.value * n->quota_out;
498 if (available < n->last_sent + th->notify_size)
500 /* calculate how much bandwidth we'd still need to
501 accumulate and based on that how long we'll have
503 available = n->last_sent + th->notify_size - available;
504 duration = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
505 available / n->quota_out);
506 if (duration.value == 0)
507 duration = GNUNET_TIME_UNIT_MILLISECONDS;
508 if (th->timeout.value <
509 GNUNET_TIME_relative_to_absolute (duration).value)
511 /* signal timeout! */
513 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
514 "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long. Signaling timeout.\n",
515 duration.value, GNUNET_i2s (&n->id));
517 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
519 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
520 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
522 n->transmit_stage = TS_NEW;
523 if (NULL != th->notify)
524 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
529 "Need more bandwidth, delaying delivery to `%4s' by %llu ms\n",
530 GNUNET_i2s (&n->id), duration.value);
532 retry_time = GNUNET_TIME_relative_min (retry_time,
537 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
538 "Have %u bytes of bandwidth available for transmission to `%4s' right now\n",
540 GNUNET_i2s (&n->id));
542 if ( (ret == NULL) ||
543 (ret->priority < th->priority) )
547 h->quota_task = GNUNET_SCHEDULER_add_delayed (h->sched,
549 "a_transmit_ready,
556 * Transmit message(s) to service.
558 * @param cls handle to transport
559 * @param size number of bytes available in buf
560 * @param buf where to copy the message
561 * @return number of bytes copied to buf
564 transport_notify_ready (void *cls, size_t size, void *buf)
566 struct GNUNET_TRANSPORT_Handle *h = cls;
567 struct ControlMessage *cm;
568 struct GNUNET_TRANSPORT_TransmitHandle *th;
569 struct NeighbourList *n;
570 struct OutboundMessage obm;
575 h->network_handle = NULL;
578 schedule_transmission (h);
582 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
583 "Ready to transmit %u bytes to transport service\n", size);
587 while ( (NULL != (cm = h->control_head)) &&
588 (cm->notify_size <= size) )
590 if (cm->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
592 GNUNET_SCHEDULER_cancel (h->sched, cm->notify_delay_task);
593 cm->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
595 GNUNET_CONTAINER_DLL_remove (h->control_head,
598 ret += cm->notify (cm->notify_cls, size, &cbuf[ret]);
602 while ( (NULL != (th = schedule_peer_transmission (h))) &&
603 (th->notify_size <= size) )
605 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
607 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
608 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
611 switch (n->transmit_stage)
617 n->transmit_stage = TS_TRANSMITTED;
622 case TS_TRANSMITTED_QUEUED:
628 GNUNET_assert (size >= sizeof (struct OutboundMessage));
629 mret = th->notify (th->notify_cls,
630 size - sizeof (struct OutboundMessage),
631 &cbuf[ret + sizeof (struct OutboundMessage)]);
632 GNUNET_assert (mret <= size - sizeof (struct OutboundMessage));
635 obm.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
636 obm.header.size = htons (mret + sizeof (struct OutboundMessage));
637 obm.priority = htonl (th->priority);
638 obm.timeout = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (th->timeout));
640 memcpy (&cbuf[ret], &obm, sizeof (struct OutboundMessage));
641 ret += (mret + sizeof (struct OutboundMessage));
642 size -= (mret + sizeof (struct OutboundMessage));
646 switch (n->transmit_stage)
655 n->transmit_stage = TS_NEW;
657 case TS_TRANSMITTED_QUEUED:
665 schedule_transmission (h);
667 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
668 "Transmitting %u bytes to transport service\n", ret);
675 * Schedule the task to send one message, either from the control
676 * list or the peer message queues to the service.
679 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
682 struct GNUNET_TIME_Relative timeout;
683 struct GNUNET_TRANSPORT_TransmitHandle *th;
685 if (NULL != h->network_handle)
687 if (h->client == NULL)
689 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
690 "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
691 return; /* not yet connected */
693 if (NULL != h->control_head)
695 size = h->control_head->notify_size;
696 timeout = GNUNET_TIME_UNIT_FOREVER_REL;
700 th = schedule_peer_transmission (h);
703 /* no transmission ready right now */
706 size = th->notify_size;
707 timeout = GNUNET_TIME_absolute_get_remaining (th->timeout);
710 GNUNET_CLIENT_notify_transmit_ready (h->client,
714 &transport_notify_ready,
716 GNUNET_assert (NULL != h->network_handle);
721 * Called when our transmit request timed out before any transport
722 * reported success connecting to the desired peer or before the
723 * transport was ready to receive. Signal error and free
727 control_transmit_timeout (void *cls,
728 const struct GNUNET_SCHEDULER_TaskContext *tc)
730 struct ControlMessage *th = cls;
732 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
733 if (NULL != th->notify)
734 th->notify (th->notify_cls, 0, NULL);
735 GNUNET_CONTAINER_DLL_remove (th->h->control_head,
743 * Queue control request for transmission to the transport
746 * @param h handle to the transport service
747 * @param size number of bytes to be transmitted
748 * @param at_head request must be added to the head of the queue
749 * (otherwise request will be appended)
750 * @param timeout how long this transmission can wait (at most)
751 * @param notify function to call to get the content
752 * @param notify_cls closure for notify
755 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
758 struct GNUNET_TIME_Relative timeout,
759 GNUNET_CONNECTION_TransmitReadyNotify notify,
762 struct ControlMessage *th;
765 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
766 "Control transmit of %u bytes within %llums requested\n",
767 size, (unsigned long long) timeout.value);
769 th = GNUNET_malloc (sizeof (struct ControlMessage));
772 th->notify_cls = notify_cls;
773 th->notify_size = size;
774 th->notify_delay_task
775 = GNUNET_SCHEDULER_add_delayed (h->sched,
776 timeout, &control_transmit_timeout, th);
778 GNUNET_CONTAINER_DLL_insert (h->control_head,
782 GNUNET_CONTAINER_DLL_insert_after (h->control_head,
786 schedule_transmission (h);
790 struct SetQuotaContext
792 struct GNUNET_TRANSPORT_Handle *handle;
794 struct GNUNET_PeerIdentity target;
796 GNUNET_SCHEDULER_Task cont;
800 struct GNUNET_TIME_Absolute timeout;
807 * Send SET_QUOTA message to the service.
809 * @param cls the 'struct SetQuotaContext'
810 * @param size number of bytes available in buf
811 * @param buf where to copy the message
812 * @return number of bytes copied to buf
815 send_set_quota (void *cls, size_t size, void *buf)
817 struct SetQuotaContext *sqc = cls;
818 struct QuotaSetMessage *msg;
822 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
825 GNUNET_SCHEDULER_REASON_TIMEOUT);
830 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
831 "Transmitting `%s' request with respect to `%4s'.\n",
833 GNUNET_i2s (&sqc->target));
835 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
837 msg->header.size = htons (sizeof (struct QuotaSetMessage));
838 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
839 msg->quota_in = htonl (sqc->quota_in);
840 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
841 if (sqc->cont != NULL)
842 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
845 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
847 return sizeof (struct QuotaSetMessage);
852 * Set the share of incoming bandwidth for the given
853 * peer to the specified amount.
855 * @param handle connection to transport service
856 * @param target who's bandwidth quota is being changed
857 * @param quota_in incoming bandwidth quota in bytes per ms
858 * @param quota_out outgoing bandwidth quota in bytes per ms
859 * @param timeout how long to wait until signaling failure if
860 * we can not communicate the quota change
861 * @param cont continuation to call when done, will be called
862 * either with reason "TIMEOUT" or with reason "PREREQ_DONE"
863 * @param cont_cls closure for continuation
866 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
867 const struct GNUNET_PeerIdentity *target,
870 struct GNUNET_TIME_Relative timeout,
871 GNUNET_SCHEDULER_Task cont, void *cont_cls)
873 struct NeighbourList *n;
874 struct SetQuotaContext *sqc;
876 n = neighbour_find (handle, target);
880 if (n->quota_out < quota_out)
881 n->last_quota_update = GNUNET_TIME_absolute_get ();
882 n->quota_out = quota_out;
884 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
885 sqc->handle = handle;
886 sqc->target = *target;
888 sqc->cont_cls = cont_cls;
889 sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
890 sqc->quota_in = quota_in;
891 schedule_control_transmit (handle,
892 sizeof (struct QuotaSetMessage),
893 GNUNET_NO, timeout, &send_set_quota, sqc);
898 * Obtain the HELLO message for this peer.
900 * @param handle connection to transport service
901 * @param rec function to call with the HELLO, sender will be our peer
902 * identity; message and sender will be NULL on timeout
903 * (handshake with transport service pending/failed).
904 * cost estimate will be 0.
905 * @param rec_cls closure for rec
908 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
909 GNUNET_TRANSPORT_HelloUpdateCallback rec,
912 struct HelloWaitList *hwl;
914 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
915 hwl->next = handle->hwl_head;
916 handle->hwl_head = hwl;
917 hwl->handle = handle;
919 hwl->rec_cls = rec_cls;
920 if (handle->my_hello == NULL)
922 rec (rec_cls, (const struct GNUNET_MessageHeader *) handle->my_hello);
928 * Stop receiving updates about changes to our HELLO message.
930 * @param handle connection to transport service
931 * @param rec function previously registered to be called with the HELLOs
932 * @param rec_cls closure for rec
935 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_Handle *handle,
936 GNUNET_TRANSPORT_HelloUpdateCallback rec,
939 struct HelloWaitList *pos;
940 struct HelloWaitList *prev;
943 pos = handle->hwl_head;
946 if ( (pos->rec == rec) &&
947 (pos->rec_cls == rec_cls) )
952 GNUNET_break (pos != NULL);
956 handle->hwl_head = pos->next;
958 prev->next = pos->next;
964 * Send HELLO message to the service.
966 * @param cls the HELLO message to send
967 * @param size number of bytes available in buf
968 * @param buf where to copy the message
969 * @return number of bytes copied to buf
972 send_hello (void *cls, size_t size, void *buf)
974 struct GNUNET_MessageHeader *hello = cls;
980 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
981 "Timeout while trying to transmit `%s' request.\n",
988 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
989 "Transmitting `%s' request.\n", "HELLO");
991 msize = ntohs (hello->size);
992 GNUNET_assert (size >= msize);
993 memcpy (buf, hello, msize);
1000 * Offer the transport service the HELLO of another peer. Note that
1001 * the transport service may just ignore this message if the HELLO is
1002 * malformed or useless due to our local configuration.
1004 * @param handle connection to transport service
1005 * @param hello the hello message
1008 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
1009 const struct GNUNET_MessageHeader *hello)
1011 struct GNUNET_MessageHeader *hc;
1014 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
1015 size = ntohs (hello->size);
1016 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
1017 hc = GNUNET_malloc (size);
1018 memcpy (hc, hello, size);
1019 schedule_control_transmit (handle,
1021 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
1026 * Transmit START message to service.
1029 * @param size number of bytes available in buf
1030 * @param buf where to copy the message
1031 * @return number of bytes copied to buf
1034 send_start (void *cls, size_t size, void *buf)
1036 struct GNUNET_MessageHeader *s = buf;
1040 /* Can only be shutdown, just give up */
1042 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1043 "Shutdown while trying to transmit `%s' request.\n",
1049 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1050 "Transmitting `%s' request.\n", "START");
1052 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
1053 s->size = htons (sizeof (struct GNUNET_MessageHeader));
1054 s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
1055 return sizeof (struct GNUNET_MessageHeader);
1062 * @param n the entry to free
1065 neighbour_free (struct NeighbourList *n)
1067 struct GNUNET_TRANSPORT_Handle *h;
1068 struct NeighbourList *prev;
1069 struct NeighbourList *pos;
1073 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1074 "Removing neighbour `%s' from list of connected peers.\n",
1075 GNUNET_i2s (&n->id));
1077 GNUNET_break (n->is_connected == GNUNET_NO);
1078 GNUNET_break (n->transmit_stage == TS_NEW);
1081 pos = h->neighbours;
1088 h->neighbours = n->next;
1090 prev->next = n->next;
1096 * Mark neighbour as disconnected.
1098 * @param n the entry to mark as disconnected
1101 neighbour_disconnect (struct NeighbourList *n)
1103 struct GNUNET_TRANSPORT_Handle *h = n->h;
1105 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1106 "Removing neighbour `%s' from list of connected peers.\n",
1107 GNUNET_i2s (&n->id));
1109 GNUNET_break (n->is_connected == GNUNET_YES);
1110 n->is_connected = GNUNET_NO;
1111 if (h->nc_cb != NULL)
1112 h->nd_cb (h->cls, &n->id);
1113 if (n->transmit_stage == TS_NEW)
1119 * Function we use for handling incoming messages.
1121 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1122 * @param msg message received, NULL on timeout or fatal error
1124 static void demultiplexer (void *cls,
1125 const struct GNUNET_MessageHeader *msg);
1129 * Try again to connect to transport service.
1131 * @param cls the handle to the transport service
1132 * @param tc scheduler context
1135 reconnect (void *cls,
1136 const struct GNUNET_SCHEDULER_TaskContext *tc)
1138 struct GNUNET_TRANSPORT_Handle *h = cls;
1139 struct ControlMessage *pos;
1140 struct NeighbourList *n;
1142 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1143 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1145 /* shutdown, just give up */
1148 /* Forget about all neighbours that we used to be connected to */
1152 if (n->is_connected)
1153 neighbour_disconnect (n);
1157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1159 GNUNET_assert (h->client == NULL);
1160 h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1161 GNUNET_assert (h->client != NULL);
1162 /* make sure we don't send "START" twice, remove existing entry from
1163 queue (if present) */
1164 pos = h->control_head;
1167 if (pos->notify == &send_start)
1169 GNUNET_CONTAINER_DLL_remove (h->control_head,
1172 if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1174 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1175 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1182 schedule_control_transmit (h,
1183 sizeof (struct GNUNET_MessageHeader),
1185 GNUNET_TIME_UNIT_FOREVER_REL, &send_start, NULL);
1186 GNUNET_CLIENT_receive (h->client,
1187 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1192 * Function that will schedule the job that will try
1193 * to connect us again to the client.
1195 * @param h transport service to reconnect
1198 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1201 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1202 "Scheduling task to reconnect to transport service in %llu ms.\n",
1203 h->reconnect_delay.value);
1205 GNUNET_assert (h->client == NULL);
1206 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1208 = GNUNET_SCHEDULER_add_delayed (h->sched,
1209 h->reconnect_delay, &reconnect, h);
1210 if (h->reconnect_delay.value == 0)
1212 h->reconnect_delay = GNUNET_TIME_UNIT_MILLISECONDS;
1216 h->reconnect_delay = GNUNET_TIME_relative_multiply (h->reconnect_delay, 2);
1217 h->reconnect_delay = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
1218 h->reconnect_delay);
1224 * Add neighbour to our list
1226 static struct NeighbourList *
1227 neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
1228 const struct GNUNET_PeerIdentity *pid)
1230 struct NeighbourList *n;
1232 /* check for duplicates */
1233 if (NULL != (n = neighbour_find (h, pid)))
1239 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1240 "Creating entry for neighbour `%4s'.\n",
1243 n = GNUNET_malloc (sizeof (struct NeighbourList));
1245 n->last_quota_update = GNUNET_TIME_absolute_get ();
1246 n->next = h->neighbours;
1247 n->quota_out = GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT;
1255 * Connect to the transport service. Note that the connection may
1256 * complete (or fail) asynchronously.
1258 * @param sched scheduler to use
1259 * @param cfg configuration to use
1260 * @param cls closure for the callbacks
1261 * @param rec receive function to call
1262 * @param nc function to call on connect events
1263 * @param nd function to call on disconnect events
1265 struct GNUNET_TRANSPORT_Handle *
1266 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1267 const struct GNUNET_CONFIGURATION_Handle *cfg,
1269 GNUNET_TRANSPORT_ReceiveCallback rec,
1270 GNUNET_TRANSPORT_NotifyConnect nc,
1271 GNUNET_TRANSPORT_NotifyDisconnect nd)
1273 struct GNUNET_TRANSPORT_Handle *ret;
1275 GNUNET_ARM_start_services (cfg, sched, "peerinfo", "transport", NULL);
1276 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1283 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1284 schedule_reconnect (ret);
1290 * Disconnect from the transport service.
1293 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1295 struct GNUNET_TRANSPORT_TransmitHandle *th;
1296 struct NeighbourList *n;
1297 struct HelloWaitList *hwl;
1298 struct GNUNET_CLIENT_Connection *client;
1301 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Transport disconnect called!\n");
1303 while (NULL != (n = handle->neighbours))
1305 handle->neighbours = n->next;
1306 switch (n->transmit_stage)
1309 case TS_TRANSMITTED:
1313 case TS_TRANSMITTED_QUEUED:
1314 th = &n->transmit_handle;
1315 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1317 GNUNET_SCHEDULER_cancel (handle->sched,
1318 th->notify_delay_task);
1319 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1321 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
1328 while (NULL != (hwl = handle->hwl_head))
1330 handle->hwl_head = hwl->next;
1331 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1333 ("Disconnect while notification for `%s' still registered.\n"),
1335 if (hwl->rec != NULL)
1336 hwl->rec (hwl->rec_cls, NULL);
1339 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1341 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1342 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1344 if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
1346 GNUNET_SCHEDULER_cancel (handle->sched, handle->quota_task);
1347 handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
1349 GNUNET_free_non_null (handle->my_hello);
1350 handle->my_hello = NULL;
1351 GNUNET_ARM_stop_services (handle->cfg, handle->sched, "transport",
1353 if (NULL != handle->network_handle)
1355 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->network_handle);
1356 handle->network_handle = NULL;
1358 if (NULL != (client = handle->client))
1361 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1362 "Disconnecting from transport service for good.\n");
1364 handle->client = NULL;
1365 GNUNET_CLIENT_disconnect (client);
1367 GNUNET_free (handle);
1372 * Function we use for handling incoming messages.
1374 * @param cls closure (struct GNUNET_TRANSPORT_Handle *)
1375 * @param msg message received, NULL on timeout or fatal error
1378 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1380 struct GNUNET_TRANSPORT_Handle *h = cls;
1381 const struct DisconnectInfoMessage *dim;
1382 const struct ConnectInfoMessage *cim;
1383 const struct InboundMessage *im;
1384 const struct GNUNET_MessageHeader *imm;
1385 const struct SendOkMessage *okm;
1386 struct HelloWaitList *hwl;
1387 struct HelloWaitList *next_hwl;
1388 struct NeighbourList *n;
1389 struct GNUNET_PeerIdentity me;
1392 if (h->client == NULL)
1394 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1395 finish clean up work! */
1402 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1403 "Error receiving from transport service, disconnecting temporarily.\n");
1405 if (h->network_handle != NULL)
1407 GNUNET_CLIENT_notify_transmit_ready_cancel (h->network_handle);
1408 h->network_handle = NULL;
1410 GNUNET_CLIENT_disconnect (h->client);
1412 schedule_reconnect (h);
1415 GNUNET_CLIENT_receive (h->client,
1416 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1417 size = ntohs (msg->size);
1418 switch (ntohs (msg->type))
1420 case GNUNET_MESSAGE_TYPE_HELLO:
1422 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1429 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1430 "Receiving (my own) `%s' message, I am `%4s'.\n",
1431 "HELLO", GNUNET_i2s (&me));
1433 GNUNET_free_non_null (h->my_hello);
1435 if (size < sizeof (struct GNUNET_MessageHeader))
1440 h->my_hello = GNUNET_malloc (size);
1441 memcpy (h->my_hello, msg, size);
1445 next_hwl = hwl->next;
1446 hwl->rec (hwl->rec_cls,
1447 (const struct GNUNET_MessageHeader *) h->my_hello);
1451 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1452 if (size != sizeof (struct ConnectInfoMessage))
1457 cim = (const struct ConnectInfoMessage *) msg;
1459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1460 "Receiving `%s' message for `%4s'.\n",
1461 "CONNECT", GNUNET_i2s (&cim->id));
1463 n = neighbour_find (h, &cim->id);
1465 n = neighbour_add (h,
1467 GNUNET_break (n->is_connected == GNUNET_NO);
1468 n->is_connected = GNUNET_YES;
1469 if (h->nc_cb != NULL)
1470 h->nc_cb (h->cls, &n->id,
1471 GNUNET_TIME_relative_ntoh (cim->latency),
1472 ntohs (cim->distance));
1474 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1475 if (size != sizeof (struct DisconnectInfoMessage))
1480 dim = (const struct DisconnectInfoMessage *) msg;
1482 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1483 "Receiving `%s' message for `%4s'.\n",
1485 GNUNET_i2s (&dim->peer));
1487 n = neighbour_find (h, &dim->peer);
1488 GNUNET_break (n != NULL);
1490 neighbour_disconnect (n);
1492 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1493 if (size != sizeof (struct SendOkMessage))
1498 okm = (const struct SendOkMessage *) msg;
1500 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1501 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1502 ntohl (okm->success) == GNUNET_OK ? "succeeded" : "failed");
1504 n = neighbour_find (h, &okm->peer);
1505 GNUNET_assert (n != NULL);
1506 switch (n->transmit_stage)
1514 case TS_TRANSMITTED:
1515 n->transmit_stage = TS_NEW;
1517 case TS_TRANSMITTED_QUEUED:
1518 n->transmit_stage = TS_QUEUED;
1519 schedule_transmission (h);
1525 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1528 "Receiving `%s' message.\n", "RECV");
1531 sizeof (struct InboundMessage) +
1532 sizeof (struct GNUNET_MessageHeader))
1537 im = (const struct InboundMessage *) msg;
1538 imm = (const struct GNUNET_MessageHeader *) &im[1];
1539 if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1545 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1546 "Received message of type %u from `%4s'.\n",
1547 ntohs (imm->type), GNUNET_i2s (&im->peer));
1549 n = neighbour_find (h, &im->peer);
1551 n = neighbour_add (h, &im->peer);
1555 h->rec (h->cls, &im->peer, imm,
1556 GNUNET_TIME_relative_ntoh (im->latency), ntohs(im->distance));
1559 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1561 ("Received unexpected message of type %u in %s:%u\n"),
1562 ntohs (msg->type), __FILE__, __LINE__);
1570 * Called when our transmit request timed out before any transport
1571 * reported success connecting to the desired peer or before the
1572 * transport was ready to receive. Signal error and free
1575 * @param cls the 'struct GNUNET_TRANSPORT_TransmitHandle*' that is timing out
1576 * @param tc scheduler context
1579 peer_transmit_timeout (void *cls,
1580 const struct GNUNET_SCHEDULER_TaskContext *tc)
1582 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1583 struct NeighbourList *n;
1584 GNUNET_CONNECTION_TransmitReadyNotify notify;
1587 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1590 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1591 "Triggering timeout for request to transmit to `%4s' (%d)\n",
1592 GNUNET_i2s (&n->id),
1595 notify = th->notify;
1596 notify_cls = th->notify_cls;
1597 switch (n->transmit_stage)
1603 n->transmit_stage = TS_NEW;
1604 if (n->is_connected == GNUNET_NO)
1607 case TS_TRANSMITTED:
1610 case TS_TRANSMITTED_QUEUED:
1611 n->transmit_stage = TS_TRANSMITTED;
1617 notify (notify_cls, 0, NULL);
1622 * Check if we could queue a message of the given size for
1623 * transmission. The transport service will take both its
1624 * internal buffers and bandwidth limits imposed by the
1625 * other peer into consideration when answering this query.
1627 * @param handle connection to transport service
1628 * @param target who should receive the message
1629 * @param size how big is the message we want to transmit?
1630 * @param priority how important is the message?
1631 * @param timeout after how long should we give up (and call
1632 * notify with buf NULL and size 0)?
1633 * @param notify function to call when we are ready to
1634 * send such a message
1635 * @param notify_cls closure for notify
1636 * @return NULL if someone else is already waiting to be notified
1637 * non-NULL if the notify callback was queued (can be used to cancel
1638 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1640 struct GNUNET_TRANSPORT_TransmitHandle *
1641 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1643 const struct GNUNET_PeerIdentity
1644 *target, size_t size,
1645 unsigned int priority,
1646 struct GNUNET_TIME_Relative timeout,
1647 GNUNET_CONNECTION_TransmitReadyNotify
1648 notify, void *notify_cls)
1650 struct GNUNET_TRANSPORT_TransmitHandle *th;
1651 struct NeighbourList *n;
1653 if (size + sizeof (struct OutboundMessage) >=
1654 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1657 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1658 "Message size is %d, max allowed is %d.\n",
1659 size + sizeof (struct OutboundMessage), GNUNET_SERVER_MAX_MESSAGE_SIZE);
1665 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1666 "Asking transport service for transmission of %u bytes to peer `%4s'.\n",
1667 size, GNUNET_i2s (target));
1669 n = neighbour_find (handle, target);
1671 n = neighbour_add (handle, target);
1674 switch (n->transmit_stage)
1677 n->transmit_stage = TS_QUEUED;
1682 case TS_TRANSMITTED:
1683 n->transmit_stage = TS_TRANSMITTED_QUEUED;
1685 case TS_TRANSMITTED_QUEUED:
1692 th = &n->transmit_handle;
1694 th->notify = notify;
1695 th->notify_cls = notify_cls;
1696 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1697 th->notify_size = size + sizeof (struct OutboundMessage);
1698 th->priority = priority;
1699 th->notify_delay_task
1700 = GNUNET_SCHEDULER_add_delayed (handle->sched, timeout,
1701 &peer_transmit_timeout, th);
1702 schedule_transmission (handle);
1708 * Cancel the specified transmission-ready notification.
1711 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1712 GNUNET_TRANSPORT_TransmitHandle
1715 struct NeighbourList *n;
1719 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1720 "Transmission request of %u bytes to `%4s' was cancelled.\n",
1721 th->notify_size - sizeof (struct OutboundMessage),
1722 GNUNET_i2s (&n->id));
1724 switch (n->transmit_stage)
1730 n->transmit_stage = TS_NEW;
1731 if (n->is_connected == GNUNET_NO)
1734 case TS_TRANSMITTED:
1737 case TS_TRANSMITTED_QUEUED:
1738 n->transmit_stage = TS_TRANSMITTED;
1746 /* end of transport_api.c */