2 This file is part of GNUnet.
3 (C) 2009 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 * - set_quota with low bandwidth should cause peer
28 * disconnects (currently never does that) (MINOR)
31 #include "gnunet_client_lib.h"
32 #include "gnunet_arm_service.h"
33 #include "gnunet_hello_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_server_lib.h"
36 #include "gnunet_time_lib.h"
37 #include "gnunet_transport_service.h"
38 #include "transport.h"
41 * After how long do we give up on transmitting a HELLO
44 #define OFFER_HELLO_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
47 * After how long do we give automatically retry an unsuccessful
50 #define CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 750)
53 * How long should ARM wait when starting up the
54 * transport service before reporting back?
56 #define START_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
59 * How long should ARM wait when stopping the
60 * transport service before reporting back?
62 #define STOP_SERVICE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
65 * Entry in linked list of all of our current neighbours.
71 * This is a linked list.
73 struct NeighbourList *next;
76 * Active transmit handle, can be NULL. Used to move
77 * from ready to wait list on disconnect and to block
78 * two transmissions to the same peer from being scheduled
81 struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle;
84 * Identity of this neighbour.
86 struct GNUNET_PeerIdentity id;
89 * At what time did we reset last_sent last?
91 struct GNUNET_TIME_Absolute last_quota_update;
94 * How many bytes have we sent since the "last_quota_update"
100 * Quota for outbound traffic to the neighbour in bytes/ms.
105 * Set to GNUNET_YES if we are currently allowed to
106 * transmit a message to the transport service for this
107 * peer, GNUNET_NO otherwise.
112 * Set to GNUNET_YES if we have received an ACK for the
113 * given peer. Peers that receive our HELLO always respond
114 * with an ACK to let us know that we are successfully
115 * communicating. Note that a PING can not be used for this
116 * since PINGs are only send if a HELLO address requires
117 * confirmation (and also, PINGs are not passed to the
118 * transport API itself).
126 * Linked list of requests from clients for our HELLO
127 * that were deferred.
133 * This is a linked list.
135 struct HelloWaitList *next;
138 * Reference back to our transport handle.
140 struct GNUNET_TRANSPORT_Handle *handle;
143 * Callback to call once we got our HELLO.
145 GNUNET_TRANSPORT_ReceiveCallback rec;
153 * When to time out (call rec with NULL).
155 struct GNUNET_TIME_Absolute timeout;
158 * Timeout task (used to trigger timeout,
159 * cancel if we get the HELLO in time).
161 GNUNET_SCHEDULER_TaskIdentifier task;
168 * Opaque handle for a transmission-ready request.
170 struct GNUNET_TRANSPORT_TransmitHandle
174 * We keep the transmit handles that are waiting for
175 * a transport-level connection in a doubly linked list.
177 struct GNUNET_TRANSPORT_TransmitHandle *next;
180 * We keep the transmit handles that are waiting for
181 * a transport-level connection in a doubly linked list.
183 struct GNUNET_TRANSPORT_TransmitHandle *prev;
186 * Handle of the main transport data structure.
188 struct GNUNET_TRANSPORT_Handle *handle;
191 * Neighbour for this handle, can be NULL if the service
192 * is not yet connected to the target.
194 struct NeighbourList *neighbour;
197 * Which peer is this transmission going to be for? All
198 * zeros if it is control-traffic to the service.
200 struct GNUNET_PeerIdentity target;
203 * Function to call when notify_size bytes are available
206 GNUNET_CONNECTION_TransmitReadyNotify notify;
209 * Closure for notify.
214 * transmit_ready task Id. The task is used to introduce the
215 * artificial delay that may be required to maintain the bandwidth
216 * limits. Later, this will be the ID of the "transmit_timeout"
217 * task which is used to signal a timeout if the transmission could
218 * not be done in a timely fashion.
220 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
223 * Timeout for this request.
225 struct GNUNET_TIME_Absolute timeout;
228 * How many bytes is our notify callback waiting for?
233 * How important is this message?
235 unsigned int priority;
241 * Handle for the transport service (includes all of the
242 * state for the transport service).
244 struct GNUNET_TRANSPORT_Handle
248 * Closure for the callbacks.
253 * Function to call for received data.
255 GNUNET_TRANSPORT_ReceiveCallback rec;
258 * function to call on connect events
260 GNUNET_TRANSPORT_NotifyConnect nc_cb;
263 * function to call on disconnect events
265 GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
268 * The current HELLO message for this peer. Updated
269 * whenever transports change their addresses.
271 struct GNUNET_HELLO_Message *my_hello;
274 * My client connection to the transport service.
276 struct GNUNET_CLIENT_Connection *client;
279 * Handle to our registration with the client for notification.
281 struct GNUNET_CONNECTION_TransmitHandle *network_handle;
284 * Linked list of transmit handles that are waiting for the
285 * transport to connect to the respective peer. When we
286 * receive notification that the transport connected to a
287 * peer, we go over this list and check if someone has already
288 * requested a transmission to the new peer; if so, we trigger
291 struct GNUNET_TRANSPORT_TransmitHandle *connect_wait_head;
294 * Linked list of transmit handles that are waiting for the
295 * transport to be ready for transmission to the respective
297 * receive notification that the transport disconnected from
298 * a peer, we go over this list and move the entry back to
299 * the connect_wait list.
301 struct GNUNET_TRANSPORT_TransmitHandle *connect_ready_head;
304 * Linked list of pending requests for our HELLO.
306 struct HelloWaitList *hwl_head;
311 struct GNUNET_SCHEDULER_Handle *sched;
316 const struct GNUNET_CONFIGURATION_Handle *cfg;
319 * Linked list of the current neighbours of this peer.
321 struct NeighbourList *neighbours;
324 * ID of the task trying to reconnect to the
327 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
330 * Delay until we try to reconnect.
332 struct GNUNET_TIME_Relative reconnect_delay;
335 * Do we currently have a transmission pending?
336 * (schedule transmission was called but has not
339 int transmission_scheduled;
343 static struct NeighbourList *
344 find_neighbour (struct GNUNET_TRANSPORT_Handle *h,
345 const struct GNUNET_PeerIdentity *peer)
347 struct NeighbourList *pos;
350 while ((pos != NULL) &&
351 (0 != memcmp (peer, &pos->id, sizeof (struct GNUNET_PeerIdentity))))
358 * Schedule the task to send one message from the
359 * connect_ready list to the service.
361 static void schedule_transmission (struct GNUNET_TRANSPORT_Handle *h);
365 * Transmit message to client...
368 transport_notify_ready (void *cls, size_t size, void *buf)
370 struct GNUNET_TRANSPORT_Handle *h = cls;
371 struct GNUNET_TRANSPORT_TransmitHandle *th;
372 struct NeighbourList *n;
376 h->network_handle = NULL;
377 h->transmission_scheduled = GNUNET_NO;
381 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
382 "Could not transmit to transport service, cancelling pending requests\n");
384 th = h->connect_ready_head;
385 if (th->next != NULL)
386 th->next->prev = NULL;
387 h->connect_ready_head = th->next;
388 if (NULL != (n = th->neighbour))
390 GNUNET_assert (n->transmit_handle == th);
391 n->transmit_handle = NULL;
393 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
395 GNUNET_SCHEDULER_cancel (h->sched,
396 th->notify_delay_task);
397 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
399 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
401 if (h->connect_ready_head != NULL) schedule_transmission (h); /* FIXME: is this ok? */
405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
406 "Ready to transmit %u bytes to transport service\n", size);
410 h->network_handle = NULL;
411 h->transmission_scheduled = GNUNET_NO;
414 th = h->connect_ready_head;
415 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
417 GNUNET_SCHEDULER_cancel (h->sched,
418 th->notify_delay_task);
419 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
421 GNUNET_assert (th->notify_size <= size);
422 if (th->next != NULL)
423 th->next->prev = NULL;
424 h->connect_ready_head = th->next;
425 if (NULL != (n = th->neighbour))
427 GNUNET_assert (n->transmit_handle == th);
428 n->transmit_handle = NULL;
430 ret += th->notify (th->notify_cls, size, &cbuf[ret]);
436 while ((h->connect_ready_head != NULL) &&
437 (h->connect_ready_head->notify_size <= size));
438 if (h->connect_ready_head != NULL)
439 schedule_transmission (h);
441 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
442 "Transmitting %u bytes to transport service\n", ret);
449 * Schedule the task to send one message from the
450 * connect_ready list to the service.
453 schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
455 struct GNUNET_TRANSPORT_TransmitHandle *th;
457 GNUNET_assert (NULL == h->network_handle);
458 if (h->client == NULL)
460 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
461 "Could not yet schedule transmission: we are not yet connected to the transport service!\n");
462 return; /* not yet connected */
464 th = h->connect_ready_head;
466 return; /* no request pending */
467 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
469 /* remove existing time out task, will be integrated
470 with transmit_ready notification! */
471 GNUNET_SCHEDULER_cancel (h->sched,
472 th->notify_delay_task);
473 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
475 h->transmission_scheduled = GNUNET_YES;
476 h->network_handle = GNUNET_CLIENT_notify_transmit_ready (h->client,
478 GNUNET_TIME_absolute_get_remaining
480 &transport_notify_ready,
482 GNUNET_assert (NULL != h->network_handle);
487 * Insert the given transmit handle in the given sorted
488 * doubly linked list based on timeout.
490 * @param head pointer to the head of the linked list
491 * @param th element to insert into the list
494 insert_transmit_handle (struct GNUNET_TRANSPORT_TransmitHandle **head,
495 struct GNUNET_TRANSPORT_TransmitHandle *th)
497 struct GNUNET_TRANSPORT_TransmitHandle *pos;
498 struct GNUNET_TRANSPORT_TransmitHandle *prev;
502 while ((pos != NULL) && (pos->timeout.value < th->timeout.value))
510 if (th->next != NULL)
526 * Cancel a pending notify delay task (if pending) and also remove the
527 * given transmit handle from whatever list is on.
529 * @param th handle for the transmission request to manipulate
532 remove_from_any_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
534 struct GNUNET_TRANSPORT_Handle *h;
537 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
539 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
540 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
542 if (th->prev == NULL)
544 if (th == h->connect_wait_head)
545 h->connect_wait_head = th->next;
547 h->connect_ready_head = th->next;
551 th->prev->next = th->next;
553 if (th->next != NULL)
554 th->next->prev = th->prev;
559 * Schedule a request to connect to the given
560 * neighbour (and if successful, add the specified
561 * handle to the wait list).
563 * @param th handle for a request to transmit once we
567 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th);
571 * Called when our transmit request timed out before any transport
572 * reported success connecting to the desired peer or before the
573 * transport was ready to receive. Signal error and free
577 peer_transmit_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
579 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
581 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
582 if (th->neighbour != NULL)
583 th->neighbour->transmit_handle = NULL;
585 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
586 "Request for transmission to peer `%s' timed out.\n",
587 GNUNET_i2s(&th->target));
589 remove_from_any_list (th);
590 th->notify (th->notify_cls, 0, NULL);
598 * Queue control request for transmission to the transport
601 * @param size number of bytes to be transmitted
602 * @param at_head request must be added to the head of the queue
603 * (otherwise request will be appended)
604 * @param timeout how long this transmission can wait (at most)
605 * @param notify function to call to get the content
606 * @param notify_cls closure for notify
609 schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
612 struct GNUNET_TIME_Relative timeout,
613 GNUNET_CONNECTION_TransmitReadyNotify notify,
616 struct GNUNET_TRANSPORT_TransmitHandle *th;
618 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
621 th->notify_cls = notify_cls;
622 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
623 th->notify_size = size;
624 th->notify_delay_task
625 = GNUNET_SCHEDULER_add_delayed (h->sched,
627 GNUNET_SCHEDULER_PRIORITY_KEEP,
628 GNUNET_SCHEDULER_NO_TASK,
630 &peer_transmit_timeout, th);
633 th->next = h->connect_ready_head;
634 h->connect_ready_head = th;
635 if (th->next != NULL)
640 insert_transmit_handle (&h->connect_ready_head, th);
642 if (GNUNET_NO == h->transmission_scheduled)
643 schedule_transmission (h);
648 * Update the quota values for the given neighbour now.
651 update_quota (struct NeighbourList *n)
653 struct GNUNET_TIME_Relative delta;
657 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
658 allowed = delta.value * n->quota_out;
659 if (n->last_sent < allowed)
661 remaining = allowed - n->last_sent;
662 if (n->quota_out > 0)
663 remaining /= n->quota_out;
666 if (remaining > MAX_BANDWIDTH_CARRY)
667 remaining = MAX_BANDWIDTH_CARRY;
669 n->last_quota_update = GNUNET_TIME_absolute_get ();
670 n->last_quota_update.value -= remaining;
674 n->last_sent -= allowed;
675 n->last_quota_update = GNUNET_TIME_absolute_get ();
680 struct SetQuotaContext
682 struct GNUNET_TRANSPORT_Handle *handle;
684 struct GNUNET_PeerIdentity target;
686 GNUNET_SCHEDULER_Task cont;
690 struct GNUNET_TIME_Absolute timeout;
697 send_set_quota (void *cls, size_t size, void *buf)
699 struct SetQuotaContext *sqc = cls;
700 struct QuotaSetMessage *msg;
704 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
708 GNUNET_SCHEDULER_REASON_TIMEOUT);
713 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
714 "Transmitting `%s' request with respect to `%4s'.\n",
715 "SET_QUOTA", GNUNET_i2s (&sqc->target));
717 GNUNET_assert (size >= sizeof (struct QuotaSetMessage));
719 msg->header.size = htons (sizeof (struct QuotaSetMessage));
720 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
721 msg->quota_in = htonl (sqc->quota_in);
722 memcpy (&msg->peer, &sqc->target, sizeof (struct GNUNET_PeerIdentity));
723 if (sqc->cont != NULL)
724 GNUNET_SCHEDULER_add_continuation (sqc->handle->sched,
728 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
730 return sizeof (struct QuotaSetMessage);
735 * Set the share of incoming bandwidth for the given
736 * peer to the specified amount.
738 * @param handle connection to transport service
739 * @param target who's bandwidth quota is being changed
740 * @param quota_in incoming bandwidth quota in bytes per ms; 0 can
741 * be used to force all traffic to be discarded
742 * @param quota_out outgoing bandwidth quota in bytes per ms; 0 can
743 * be used to force all traffic to be discarded
744 * @param timeout how long to wait until signaling failure if
745 * we can not communicate the quota change
746 * @param cont continuation to call when done, will be called
747 * either with reason "TIMEOUT" or with reason "PREREQ_DONE"
748 * @param cont_cls closure for continuation
751 GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
752 const struct GNUNET_PeerIdentity *target,
755 struct GNUNET_TIME_Relative timeout,
756 GNUNET_SCHEDULER_Task cont, void *cont_cls)
758 struct NeighbourList *n;
759 struct SetQuotaContext *sqc;
761 n = find_neighbour (handle, target);
765 if (n->quota_out < quota_out)
766 n->last_quota_update = GNUNET_TIME_absolute_get ();
767 n->quota_out = quota_out;
769 sqc = GNUNET_malloc (sizeof (struct SetQuotaContext));
770 sqc->handle = handle;
771 sqc->target = *target;
773 sqc->cont_cls = cont_cls;
774 sqc->timeout = GNUNET_TIME_relative_to_absolute (timeout);
775 sqc->quota_in = quota_in;
776 schedule_control_transmit (handle,
777 sizeof (struct QuotaSetMessage),
778 GNUNET_NO, timeout, &send_set_quota, sqc);
783 * A "get_hello" request has timed out. Signal the client
787 hello_wait_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
789 struct HelloWaitList *hwl = cls;
790 struct HelloWaitList *pos;
791 struct HelloWaitList *prev;
793 hwl->task = GNUNET_SCHEDULER_NO_TASK;
794 if (GNUNET_TIME_absolute_get_remaining (hwl->timeout).value > 0)
797 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
798 _("First attempt to obtain `%s' from transport service failed, will try again for %llums.\n"),
800 GNUNET_TIME_absolute_get_remaining (hwl->timeout).value);
802 hwl->task = GNUNET_SCHEDULER_add_delayed (hwl->handle->sched,
804 GNUNET_SCHEDULER_PRIORITY_KEEP,
805 GNUNET_SCHEDULER_NO_TASK,
806 GNUNET_TIME_absolute_get_remaining (hwl->timeout),
807 &hello_wait_timeout, hwl);
811 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
812 _("Timeout trying to obtain `%s' from transport service.\n"),
815 pos = hwl->handle->hwl_head;
818 GNUNET_assert (pos != NULL);
823 hwl->handle->hwl_head = hwl->next;
825 prev->next = hwl->next;
826 if (hwl->rec != NULL)
827 hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
833 * Obtain the HELLO message for this peer.
835 * @param handle connection to transport service
836 * @param timeout how long to wait for the HELLO
837 * @param rec function to call with the HELLO, sender will be our peer
838 * identity; message and sender will be NULL on timeout
839 * (handshake with transport service pending/failed).
840 * cost estimate will be 0.
841 * @param rec_cls closure for rec
844 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
845 struct GNUNET_TIME_Relative timeout,
846 GNUNET_TRANSPORT_ReceiveCallback rec,
849 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
850 struct GNUNET_PeerIdentity me;
851 struct HelloWaitList *hwl;
853 if (handle->my_hello == NULL)
855 hwl = GNUNET_malloc (sizeof (struct HelloWaitList));
856 hwl->next = handle->hwl_head;
857 handle->hwl_head = hwl;
858 hwl->handle = handle;
860 hwl->rec_cls = rec_cls;
861 hwl->timeout = GNUNET_TIME_relative_to_absolute (timeout);
862 hwl->task = GNUNET_SCHEDULER_add_delayed (handle->sched,
864 GNUNET_SCHEDULER_PRIORITY_KEEP,
865 GNUNET_SCHEDULER_NO_TASK,
867 &hello_wait_timeout, hwl);
870 GNUNET_assert (GNUNET_OK == GNUNET_HELLO_get_key (handle->my_hello, &pk));
871 GNUNET_CRYPTO_hash (&pk,
872 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
876 GNUNET_TIME_UNIT_ZERO,
877 &me, (const struct GNUNET_MessageHeader *) handle->my_hello);
882 send_hello (void *cls, size_t size, void *buf)
884 struct GNUNET_MessageHeader *hello = cls;
890 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
891 "Timeout while trying to transmit `%s' request.\n",
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
899 "Transmitting `%s' request.\n", "HELLO");
901 msize = ntohs (hello->size);
902 GNUNET_assert (size >= msize);
903 memcpy (buf, hello, msize);
910 * Offer the transport service the HELLO of another peer. Note that
911 * the transport service may just ignore this message if the HELLO is
912 * malformed or useless due to our local configuration.
914 * @param handle connection to transport service
915 * @param hello the hello message
918 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
919 const struct GNUNET_MessageHeader *hello)
921 struct GNUNET_MessageHeader *hc;
924 if (handle->client == NULL)
927 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
928 "Not connected to transport service, dropping offered HELLO\n");
932 GNUNET_break (ntohs (hello->type) == GNUNET_MESSAGE_TYPE_HELLO);
933 size = ntohs (hello->size);
934 GNUNET_break (size >= sizeof (struct GNUNET_MessageHeader));
935 hc = GNUNET_malloc (size);
936 memcpy (hc, hello, size);
937 schedule_control_transmit (handle,
939 GNUNET_NO, OFFER_HELLO_TIMEOUT, &send_hello, hc);
944 * Function we use for handling incoming messages.
946 static void demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg);
950 send_start (void *cls, size_t size, void *buf)
952 struct GNUNET_MessageHeader *s = buf;
957 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
958 "Timeout while trying to transmit `%s' request.\n",
964 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
965 "Transmitting `%s' request.\n", "START");
967 GNUNET_assert (size >= sizeof (struct GNUNET_MessageHeader));
968 s->size = htons (sizeof (struct GNUNET_MessageHeader));
969 s->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
970 return sizeof (struct GNUNET_MessageHeader);
975 * We're ready to transmit the request that the transport service
976 * should connect to a new peer. In addition to sending the
977 * request, schedule the next phase for the transmission processing
978 * that caused the connect request in the first place.
981 request_connect (void *cls, size_t size, void *buf)
983 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
984 struct TryConnectMessage *tcm;
985 struct GNUNET_TRANSPORT_Handle *h;
987 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
992 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
993 "Failed to transmit `%s' request for `%4s' to service.\n",
995 GNUNET_i2s(&th->target));
997 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
999 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1000 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1002 th->notify (th->notify_cls, 0, NULL);
1007 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1008 "Transmitting `%s' message for `%4s'.\n",
1009 "TRY_CONNECT", GNUNET_i2s (&th->target));
1011 GNUNET_assert (size >= sizeof (struct TryConnectMessage));
1013 tcm->header.size = htons (sizeof (struct TryConnectMessage));
1014 tcm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT);
1015 tcm->reserved = htonl (0);
1016 memcpy (&tcm->peer, &th->target, sizeof (struct GNUNET_PeerIdentity));
1017 th->notify_delay_task
1018 = GNUNET_SCHEDULER_add_delayed (h->sched,
1020 GNUNET_SCHEDULER_PRIORITY_KEEP,
1021 GNUNET_SCHEDULER_NO_TASK,
1022 GNUNET_TIME_absolute_get_remaining
1024 &peer_transmit_timeout, th);
1025 insert_transmit_handle (&h->connect_wait_head, th);
1026 return sizeof (struct TryConnectMessage);
1031 * Schedule a request to connect to the given
1032 * neighbour (and if successful, add the specified
1033 * handle to the wait list).
1035 * @param th handle for a request to transmit once we
1039 try_connect (struct GNUNET_TRANSPORT_TransmitHandle *th)
1041 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1042 schedule_control_transmit (th->handle,
1043 sizeof (struct TryConnectMessage),
1045 GNUNET_TIME_absolute_get_remaining (th->timeout),
1046 &request_connect, th);
1051 * Task for delayed attempts to reconnect to a peer.
1053 * @param cls must be a transmit handle that determines the peer
1054 * to which we will try to connect
1055 * @param tc scheduler information about why we were triggered (not used)
1058 try_connect_task (void *cls,
1059 const struct GNUNET_SCHEDULER_TaskContext *tc)
1061 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1063 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1069 * Remove neighbour from our list. Will automatically
1070 * trigger a re-connect attempt if we have messages pending
1073 * @param h our state
1074 * @param peer the peer to remove
1077 remove_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1078 const struct GNUNET_PeerIdentity *peer)
1080 struct NeighbourList *prev;
1081 struct NeighbourList *pos;
1082 struct GNUNET_TRANSPORT_TransmitHandle *th;
1085 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1086 "Removing neighbour `%s' from list of connected peers.\n",
1090 pos = h->neighbours;
1091 while ((pos != NULL) &&
1094 sizeof (struct GNUNET_PeerIdentity))))
1105 h->neighbours = pos->next;
1107 prev->next = pos->next;
1108 if (NULL != (th = pos->transmit_handle))
1110 pos->transmit_handle = NULL;
1111 th->neighbour = NULL;
1112 remove_from_any_list (th);
1113 if (GNUNET_TIME_absolute_get_remaining (th->timeout).value <= CONNECT_RETRY_TIMEOUT.value)
1116 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1117 peer_transmit_timeout (th, NULL);
1121 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1122 _("Connection with `%4s' failed, will keep trying for %llu ms to deliver message\n"),
1124 GNUNET_TIME_absolute_get_remaining (th->timeout).value);
1125 /* try again in a bit */
1126 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == th->notify_delay_task);
1127 th->notify_delay_task
1128 = GNUNET_SCHEDULER_add_delayed (h->sched,
1130 GNUNET_SCHEDULER_PRIORITY_KEEP,
1131 GNUNET_SCHEDULER_NO_TASK,
1132 CONNECT_RETRY_TIMEOUT,
1137 if (h->nc_cb != NULL)
1138 h->nd_cb (h->cls, peer);
1144 * Try again to connect to transport service.
1147 reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1149 struct GNUNET_TRANSPORT_Handle *h = cls;
1150 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1151 struct NeighbourList *n;
1153 /* Forget about all neighbours that we used to be connected
1155 while (NULL != (n = h->neighbours))
1156 remove_neighbour (h, &n->id);
1158 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
1160 GNUNET_assert (h->client == NULL);
1161 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1162 h->client = GNUNET_CLIENT_connect (h->sched, "transport", h->cfg);
1163 GNUNET_assert (h->client != NULL);
1164 /* make sure we don't send "START" twice,
1165 remove existing entry from queue (if present) */
1166 pos = h->connect_ready_head;
1169 if (pos->notify == &send_start)
1171 if (pos->prev == NULL)
1172 h->connect_ready_head = pos->next;
1174 pos->prev->next = pos->next;
1175 if (pos->next != NULL)
1176 pos->next->prev = pos->prev;
1177 GNUNET_assert (pos->neighbour == NULL);
1178 if (GNUNET_SCHEDULER_NO_TASK != pos->notify_delay_task)
1180 GNUNET_SCHEDULER_cancel (h->sched,
1181 pos->notify_delay_task);
1182 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1189 schedule_control_transmit (h,
1190 sizeof (struct GNUNET_MessageHeader),
1192 GNUNET_TIME_UNIT_FOREVER_REL,
1194 GNUNET_CLIENT_receive (h->client,
1195 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1200 * Function that will schedule the job that will try
1201 * to connect us again to the client.
1204 schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
1207 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1208 "Scheduling task to reconnect to transport service in %llu ms.\n",
1209 h->reconnect_delay.value);
1211 GNUNET_assert (h->client == NULL);
1212 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
1214 = GNUNET_SCHEDULER_add_delayed (h->sched,
1216 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
1217 GNUNET_SCHEDULER_NO_TASK,
1218 h->reconnect_delay, &reconnect, h);
1219 h->reconnect_delay = GNUNET_TIME_UNIT_SECONDS;
1224 * We are connected to the respective peer, check the
1225 * bandwidth limits and schedule the transmission.
1227 static void schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th);
1231 * Function called by the scheduler when the timeout
1232 * for bandwidth availablility for the target
1233 * neighbour is reached.
1236 transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1238 struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
1240 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1241 schedule_request (th);
1246 * Remove the given transmit handle from the wait list. Does NOT free
1250 remove_from_wait_list (struct GNUNET_TRANSPORT_TransmitHandle *th)
1252 if (th->prev == NULL)
1253 th->handle->connect_wait_head = th->next;
1255 th->prev->next = th->next;
1256 if (th->next != NULL)
1257 th->next->prev = th->prev;
1262 * We are connected to the respective peer, check the
1263 * bandwidth limits and schedule the transmission.
1266 schedule_request (struct GNUNET_TRANSPORT_TransmitHandle *th)
1268 struct GNUNET_TRANSPORT_Handle *h;
1269 struct GNUNET_TIME_Relative duration;
1270 struct NeighbourList *n;
1275 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1277 GNUNET_SCHEDULER_cancel (h->sched, th->notify_delay_task);
1278 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1280 /* check outgoing quota */
1281 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1282 if (duration.value > MIN_QUOTA_REFRESH_TIME)
1285 duration = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
1287 available = duration.value * n->quota_out;
1288 if (available < n->last_sent + th->notify_size)
1290 /* calculate how much bandwidth we'd still need to
1291 accumulate and based on that how long we'll have
1293 available = n->last_sent + th->notify_size - available;
1294 duration = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1295 available / n->quota_out);
1296 if (th->timeout.value <
1297 GNUNET_TIME_relative_to_absolute (duration).value)
1299 /* signal timeout! */
1301 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1302 "Would need %llu ms before bandwidth is available for delivery to `%4s', that is too long. Signaling timeout.\n",
1304 GNUNET_i2s(&th->target));
1306 remove_from_wait_list (th);
1307 th->notify (th->notify_cls, 0, NULL);
1312 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1313 "Need more bandwidth, delaying delivery to `%4s' by %llu ms\n",
1314 GNUNET_i2s(&th->target),
1317 th->notify_delay_task
1318 = GNUNET_SCHEDULER_add_delayed (h->sched,
1320 GNUNET_SCHEDULER_PRIORITY_KEEP,
1321 GNUNET_SCHEDULER_NO_TASK,
1322 duration, &transmit_ready, th);
1326 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1327 "Bandwidth available for transmission to `%4s'\n",
1328 GNUNET_i2s (&n->id));
1330 if (GNUNET_NO == n->transmit_ok)
1332 /* we may be ready, but transport service is not;
1333 wait for SendOkMessage or timeout */
1335 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1336 "Need to wait for transport service `%s' message\n",
1339 th->notify_delay_task
1340 = GNUNET_SCHEDULER_add_delayed (h->sched,
1342 GNUNET_SCHEDULER_PRIORITY_KEEP,
1343 GNUNET_SCHEDULER_NO_TASK,
1344 GNUNET_TIME_absolute_get_remaining
1345 (th->timeout), &peer_transmit_timeout, th);
1348 n->transmit_ok = GNUNET_NO;
1349 remove_from_wait_list (th);
1351 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Moving message for `%4s' to ready list\n",
1352 GNUNET_i2s(&n->id));
1354 insert_transmit_handle (&h->connect_ready_head, th);
1355 if (GNUNET_NO == h->transmission_scheduled)
1356 schedule_transmission (h);
1361 * Add neighbour to our list
1364 add_neighbour (struct GNUNET_TRANSPORT_Handle *h,
1366 struct GNUNET_TIME_Relative latency,
1367 const struct GNUNET_PeerIdentity *pid)
1369 struct NeighbourList *n;
1370 struct GNUNET_TRANSPORT_TransmitHandle *prev;
1371 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1372 struct GNUNET_TRANSPORT_TransmitHandle *next;
1374 /* check for duplicates */
1375 if (NULL != find_neighbour (h, pid))
1381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1382 "Creating entry for new neighbour `%4s'.\n", GNUNET_i2s (pid));
1384 n = GNUNET_malloc (sizeof (struct NeighbourList));
1386 n->last_quota_update = GNUNET_TIME_absolute_get ();
1387 n->quota_out = quota_out;
1388 n->next = h->neighbours;
1389 n->transmit_ok = GNUNET_YES;
1391 if (h->nc_cb != NULL)
1392 h->nc_cb (h->cls, &n->id, latency);
1394 pos = h->connect_wait_head;
1398 if (0 == memcmp (pid,
1399 &pos->target, sizeof (struct GNUNET_PeerIdentity)))
1402 GNUNET_assert (NULL == n->transmit_handle);
1403 n->transmit_handle = pos;
1405 h->connect_wait_head = next;
1408 if (GNUNET_YES == n->received_ack)
1411 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1412 "Found pending request for `%4s' will trigger it now.\n",
1413 GNUNET_i2s (&pos->target));
1415 if (pos->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1417 GNUNET_SCHEDULER_cancel (h->sched, pos->notify_delay_task);
1418 pos->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1420 schedule_request (pos);
1425 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1426 "Found pending request for `%4s' but still need `%s' before proceeding.\n",
1427 GNUNET_i2s (&pos->target),
1440 * Connect to the transport service. Note that the connection may
1441 * complete (or fail) asynchronously.
1444 * @param sched scheduler to use
1445 * @param cfg configuration to use
1446 * @param cls closure for the callbacks
1447 * @param rec receive function to call
1448 * @param nc function to call on connect events
1449 * @param dc function to call on disconnect events
1451 struct GNUNET_TRANSPORT_Handle *
1452 GNUNET_TRANSPORT_connect (struct GNUNET_SCHEDULER_Handle *sched,
1453 const struct GNUNET_CONFIGURATION_Handle *cfg,
1455 GNUNET_TRANSPORT_ReceiveCallback rec,
1456 GNUNET_TRANSPORT_NotifyConnect nc,
1457 GNUNET_TRANSPORT_NotifyDisconnect nd)
1459 struct GNUNET_TRANSPORT_Handle *ret;
1461 GNUNET_ARM_start_service ("peerinfo",
1462 cfg, sched, START_SERVICE_TIMEOUT, NULL, NULL);
1463 GNUNET_ARM_start_service ("transport",
1464 cfg, sched, START_SERVICE_TIMEOUT, NULL, NULL);
1465 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Handle));
1472 ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
1473 schedule_reconnect (ret);
1479 * These stop activities must be run in a fresh
1480 * scheduler that is NOT in shutdown mode.
1483 stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1485 struct GNUNET_TRANSPORT_Handle *handle = cls;
1486 GNUNET_ARM_stop_service ("transport",
1488 tc->sched, STOP_SERVICE_TIMEOUT, NULL, NULL);
1489 GNUNET_ARM_stop_service ("peerinfo",
1491 tc->sched, STOP_SERVICE_TIMEOUT, NULL, NULL);
1496 * Disconnect from the transport service.
1499 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
1501 struct GNUNET_TRANSPORT_TransmitHandle *th;
1502 struct NeighbourList *n;
1503 struct HelloWaitList *hwl;
1504 struct GNUNET_CLIENT_Connection *client;
1507 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1508 "Transport disconnect called!\n");
1510 while (NULL != (th = handle->connect_ready_head))
1512 handle->connect_ready_head = th->next;
1513 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1515 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1516 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1518 th->notify (th->notify_cls, 0, NULL);
1521 while (NULL != (th = handle->connect_wait_head))
1523 handle->connect_wait_head = th->next;
1524 if (th->notify_delay_task != GNUNET_SCHEDULER_NO_TASK)
1526 GNUNET_SCHEDULER_cancel (handle->sched, th->notify_delay_task);
1527 th->notify_delay_task = GNUNET_SCHEDULER_NO_TASK;
1529 th->notify (th->notify_cls, 0, NULL);
1532 while (NULL != (n = handle->neighbours))
1534 handle->neighbours = n->next;
1537 while (NULL != (hwl = handle->hwl_head))
1539 handle->hwl_head = hwl->next;
1540 GNUNET_SCHEDULER_cancel (handle->sched, hwl->task);
1541 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1542 _("Disconnect while trying to obtain `%s' from transport service.\n"),
1544 if (hwl->rec != NULL)
1545 hwl->rec (hwl->rec_cls, GNUNET_TIME_UNIT_ZERO, NULL, NULL);
1548 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1550 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
1551 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1553 GNUNET_free_non_null (handle->my_hello);
1554 handle->my_hello = NULL;
1555 GNUNET_SCHEDULER_run (&stop_task, handle);
1556 if (NULL != (client = handle->client))
1559 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1560 "Disconnecting from transport service for good.\n");
1562 handle->client = NULL;
1563 GNUNET_CLIENT_disconnect (client);
1566 GNUNET_free (handle);
1571 * Type of a function to call when we receive a message
1574 * @param cls closure
1575 * @param msg message received, NULL on timeout or fatal error
1578 demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
1580 struct GNUNET_TRANSPORT_Handle *h = cls;
1581 const struct DisconnectInfoMessage *dim;
1582 const struct ConnectInfoMessage *cim;
1583 const struct InboundMessage *im;
1584 const struct GNUNET_MessageHeader *imm;
1585 const struct SendOkMessage *okm;
1586 struct HelloWaitList *hwl;
1587 struct NeighbourList *n;
1588 struct GNUNET_PeerIdentity me;
1589 struct GNUNET_TRANSPORT_TransmitHandle *th;
1592 if ((msg == NULL) || (h->client == NULL))
1594 if (h->client != NULL)
1597 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1598 "Error receiving from transport service, disconnecting temporarily.\n");
1600 if (h->network_handle != NULL)
1602 GNUNET_CONNECTION_notify_transmit_ready_cancel (h->network_handle);
1603 h->network_handle = NULL;
1604 h->transmission_scheduled = GNUNET_NO;
1605 th = h->connect_ready_head;
1606 /* add timeout again, we cancelled the transmit_ready task! */
1607 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
1608 th->notify_delay_task
1609 = GNUNET_SCHEDULER_add_delayed (h->sched,
1611 GNUNET_SCHEDULER_PRIORITY_KEEP,
1612 GNUNET_SCHEDULER_NO_TASK,
1613 GNUNET_TIME_absolute_get_remaining(th->timeout),
1614 &peer_transmit_timeout,
1617 GNUNET_CLIENT_disconnect (h->client);
1619 schedule_reconnect (h);
1623 /* shutdown initiated from 'GNUNET_TRANSPORT_disconnect',
1624 finish clean up work! */
1629 GNUNET_CLIENT_receive (h->client,
1630 &demultiplexer, h, GNUNET_TIME_UNIT_FOREVER_REL);
1631 size = ntohs (msg->size);
1632 switch (ntohs (msg->type))
1634 case GNUNET_MESSAGE_TYPE_HELLO:
1636 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg,
1643 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1644 "Receiving (my own) `%s' message, I am `%4s'.\n",
1645 "HELLO", GNUNET_i2s (&me));
1647 GNUNET_free_non_null (h->my_hello);
1649 if (size < sizeof (struct GNUNET_MessageHeader))
1654 h->my_hello = GNUNET_malloc (size);
1655 memcpy (h->my_hello, msg, size);
1656 while (NULL != (hwl = h->hwl_head))
1658 h->hwl_head = hwl->next;
1659 GNUNET_SCHEDULER_cancel (h->sched, hwl->task);
1660 GNUNET_TRANSPORT_get_hello (h,
1661 GNUNET_TIME_UNIT_ZERO,
1662 hwl->rec, hwl->rec_cls);
1666 case GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT:
1667 if (size != sizeof (struct ConnectInfoMessage))
1672 cim = (const struct ConnectInfoMessage *) msg;
1674 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1675 "Receiving `%s' message for `%4s'.\n",
1676 "CONNECT", GNUNET_i2s (&cim->id));
1679 ntohl (cim->quota_out),
1680 GNUNET_TIME_relative_ntoh (cim->latency), &cim->id);
1682 case GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT:
1683 if (size != sizeof (struct DisconnectInfoMessage))
1688 dim = (const struct DisconnectInfoMessage *) msg;
1690 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1691 "Receiving `%s' message for `%4s'.\n",
1692 "DISCONNECT", GNUNET_i2s (&dim->peer));
1694 remove_neighbour (h, &dim->peer);
1696 case GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK:
1697 if (size != sizeof (struct SendOkMessage))
1702 okm = (const struct SendOkMessage *) msg;
1704 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1705 "Receiving `%s' message, transmission %s.\n", "SEND_OK",
1706 ntohl(okm->success) == GNUNET_OK ? "succeeded" : "failed");
1708 n = find_neighbour (h, &okm->peer);
1709 GNUNET_assert (n != NULL);
1710 n->transmit_ok = GNUNET_YES;
1711 if (n->transmit_handle != NULL)
1714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1715 "Processing pending message for `%4s'\n",
1716 GNUNET_i2s(&n->id));
1718 GNUNET_SCHEDULER_cancel (h->sched,
1719 n->transmit_handle->notify_delay_task);
1720 n->transmit_handle->notify_delay_task =
1721 GNUNET_SCHEDULER_NO_TASK;
1722 GNUNET_assert (GNUNET_YES == n->received_ack);
1723 schedule_request (n->transmit_handle);
1726 case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
1728 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1729 "Receiving `%s' message.\n", "RECV");
1732 sizeof (struct InboundMessage) +
1733 sizeof (struct GNUNET_MessageHeader))
1738 im = (const struct InboundMessage *) msg;
1739 imm = (const struct GNUNET_MessageHeader *) &im[1];
1740 if (ntohs (imm->size) + sizeof (struct InboundMessage) != size)
1745 switch (ntohs (imm->type))
1747 case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
1749 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1750 "Receiving `%s' message from `%4s'.\n",
1751 "ACK", GNUNET_i2s (&im->peer));
1753 n = find_neighbour (h, &im->peer);
1759 if (n->received_ack == GNUNET_NO)
1761 n->received_ack = GNUNET_YES;
1762 if (NULL != n->transmit_handle)
1765 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1766 "Peer connected, scheduling delayed message for deliverery now.\n");
1768 schedule_request (n->transmit_handle);
1774 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1775 "Received message of type %u from `%4s'.\n",
1776 ntohs (imm->type), GNUNET_i2s (&im->peer));
1780 GNUNET_TIME_relative_ntoh (im->latency), &im->peer, imm);
1785 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1787 ("Received unexpected message of type %u in %s:%u\n"),
1788 ntohs (msg->type), __FILE__, __LINE__);
1795 struct ClientTransmitWrapper
1797 GNUNET_CONNECTION_TransmitReadyNotify notify;
1799 struct GNUNET_TRANSPORT_TransmitHandle *th;
1804 * Transmit message of a client destined for another
1805 * peer to the service.
1808 client_notify_wrapper (void *cls, size_t size, void *buf)
1810 struct ClientTransmitWrapper *ctw = cls;
1811 struct OutboundMessage *obm;
1812 struct GNUNET_MessageHeader *hdr;
1818 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1819 "Transmission request could not be satisfied.\n");
1821 ret = ctw->notify (ctw->notify_cls, 0, NULL);
1822 GNUNET_assert (ret == 0);
1826 GNUNET_assert (size >= sizeof (struct OutboundMessage));
1828 ret = ctw->notify (ctw->notify_cls,
1829 size - sizeof (struct OutboundMessage),
1833 /* Need to reset flag, no SEND means no SEND_OK! */
1834 ctw->th->neighbour->transmit_ok = GNUNET_YES;
1838 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
1839 hdr = (struct GNUNET_MessageHeader *) &obm[1];
1840 GNUNET_assert (ntohs (hdr->size) == ret);
1841 GNUNET_assert (ret + sizeof (struct OutboundMessage) <
1842 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1844 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1845 "Transmitting `%s' message with data for `%4s'\n",
1846 "SEND", GNUNET_i2s (&ctw->th->target));
1848 ret += sizeof (struct OutboundMessage);
1849 obm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
1850 obm->header.size = htons (ret);
1851 obm->priority = htonl (ctw->th->priority);
1852 obm->peer = ctw->th->target;
1860 * Check if we could queue a message of the given size for
1861 * transmission. The transport service will take both its
1862 * internal buffers and bandwidth limits imposed by the
1863 * other peer into consideration when answering this query.
1865 * @param handle connection to transport service
1866 * @param target who should receive the message
1867 * @param size how big is the message we want to transmit?
1868 * @param priority how important is the message?
1869 * @param timeout after how long should we give up (and call
1870 * notify with buf NULL and size 0)?
1871 * @param notify function to call when we are ready to
1872 * send such a message
1873 * @param notify_cls closure for notify
1874 * @return NULL if someone else is already waiting to be notified
1875 * non-NULL if the notify callback was queued (can be used to cancel
1876 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
1878 struct GNUNET_TRANSPORT_TransmitHandle *
1879 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
1881 const struct GNUNET_PeerIdentity
1882 *target, size_t size,
1883 unsigned int priority,
1884 struct GNUNET_TIME_Relative timeout,
1885 GNUNET_CONNECTION_TransmitReadyNotify
1886 notify, void *notify_cls)
1888 struct GNUNET_TRANSPORT_TransmitHandle *pos;
1889 struct GNUNET_TRANSPORT_TransmitHandle *th;
1890 struct NeighbourList *n;
1891 struct ClientTransmitWrapper *ctw;
1893 if (size + sizeof (struct OutboundMessage) >=
1894 GNUNET_SERVER_MAX_MESSAGE_SIZE)
1900 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1901 "Asking transport service for transmission of %u bytes to peer `%4s'.\n",
1902 size, GNUNET_i2s (target));
1904 n = find_neighbour (handle, target);
1906 (n->transmit_handle != NULL) )
1907 return NULL; /* already have a request pending for this peer! */
1908 ctw = GNUNET_malloc (sizeof (struct ClientTransmitWrapper));
1909 th = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TransmitHandle));
1910 ctw->notify = notify;
1911 ctw->notify_cls = notify_cls;
1913 th->handle = handle;
1915 th->target = *target;
1916 th->notify = &client_notify_wrapper;
1917 th->notify_cls = ctw;
1918 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1919 th->notify_size = size + sizeof (struct OutboundMessage);
1920 th->priority = priority;
1923 pos = handle->connect_wait_head;
1926 GNUNET_assert (0 != memcmp (target,
1928 sizeof (struct GNUNET_PeerIdentity)));
1932 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1933 "Will now try to connect to `%4s'.\n", GNUNET_i2s (target));
1940 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1941 "Transmission request queued for transmission to transport service.\n");
1943 GNUNET_assert (NULL == n->transmit_handle);
1944 n->transmit_handle = th;
1945 if (GNUNET_YES != n->received_ack)
1948 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1949 "Connection to `%4s' is not yet confirmed connected, scheduling timeout (%llu ms) only.\n",
1950 GNUNET_i2s (target), timeout.value);
1952 th->notify_delay_task
1953 = GNUNET_SCHEDULER_add_delayed (handle->sched,
1955 GNUNET_SCHEDULER_PRIORITY_KEEP,
1956 GNUNET_SCHEDULER_NO_TASK,
1957 timeout, &peer_transmit_timeout, th);
1962 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1963 "Peer `%4s' is ready to receive, scheduling message for delivery now.\n",
1964 GNUNET_i2s (target));
1966 schedule_request (th);
1972 * Cancel the specified transmission-ready notification.
1975 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
1976 GNUNET_TRANSPORT_TransmitHandle
1979 struct GNUNET_TRANSPORT_Handle *h;
1982 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1983 "Transmission request of %u bytes to `%4s' was cancelled.\n",
1984 th->notify_size - sizeof(struct OutboundMessage),
1985 GNUNET_i2s (&th->target));
1987 GNUNET_assert (th->notify == &client_notify_wrapper);
1988 remove_from_any_list (th);
1990 if ((h->connect_ready_head == NULL) && (h->network_handle != NULL))
1992 GNUNET_CONNECTION_notify_transmit_ready_cancel (h->network_handle);
1993 h->network_handle = NULL;
1994 h->transmission_scheduled = GNUNET_NO;
1996 GNUNET_free (th->notify_cls);
1997 GNUNET_assert (th->notify_delay_task == GNUNET_SCHEDULER_NO_TASK);
2002 /* end of transport_api.c */