2 This file is part of GNUnet.
3 Copyright (C) 2001-2017 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file cadet/gnunet-service-cadet_channel.c
22 * @brief logical links between CADET clients
23 * @author Bartlomiej Polot
24 * @author Christian Grothoff
27 * - Congestion/flow control:
28 * + estimate max bandwidth using bursts and use to for CONGESTION CONTROL!
29 * (and figure out how/where to use this!)
30 * + figure out flow control without ACKs (unreliable traffic!)
31 * - revisit handling of 'unbuffered' traffic!
32 * (need to push down through tunnel into connection selection)
33 * - revisit handling of 'buffered' traffic: 4 is a rather small buffer; maybe
34 * reserve more bits in 'options' to allow for buffer size control?
38 #include "gnunet_statistics_service.h"
39 #include "gnunet-service-cadet_channel.h"
40 #include "gnunet-service-cadet_connection.h"
41 #include "gnunet-service-cadet_tunnels.h"
42 #include "gnunet-service-cadet_paths.h"
44 #define LOG(level,...) GNUNET_log_from (level,"cadet-chn",__VA_ARGS__)
47 * How long do we initially wait before retransmitting?
49 #define CADET_INITIAL_RETRANSMIT_TIME GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 250)
52 * How long do we wait before dropping state about incoming
53 * connection to closed port?
55 #define TIMEOUT_CLOSED_PORT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30)
58 * How long do we wait at least before retransmitting ever?
60 #define MIN_RTT_DELAY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 75)
63 * Maximum message ID into the future we accept for out-of-order messages.
64 * If the message is more than this into the future, we drop it. This is
65 * important both to detect values that are actually in the past, as well
66 * as to limit adversarially triggerable memory consumption.
68 * Note that right now we have "max_pending_messages = 4" hard-coded in
69 * the logic below, so a value of 4 would suffice here. But we plan to
70 * allow larger windows in the future...
72 #define MAX_OUT_OF_ORDER_DISTANCE 1024
76 * All the states a channel can be in.
78 enum CadetChannelState
81 * Uninitialized status, should never appear in operation.
86 * Channel is to a port that is not open, we're waiting for the
92 * CHANNEL_OPEN message sent, waiting for CHANNEL_OPEN_ACK.
94 CADET_CHANNEL_OPEN_SENT,
97 * Connection confirmed, ready to carry traffic.
104 * Info needed to retry a message in case it gets lost.
105 * Note that we DO use this structure also for unreliable
108 struct CadetReliableMessage
111 * Double linked list, FIFO style
113 struct CadetReliableMessage *next;
116 * Double linked list, FIFO style
118 struct CadetReliableMessage *prev;
121 * Which channel is this message in?
123 struct CadetChannel *ch;
126 * Entry in the tunnels queue for this message, NULL if it has left
127 * the tunnel. Used to cancel transmission in case we receive an
130 struct CadetTunnelQueueEntry *qe;
133 * Data message we are trying to send.
135 struct GNUNET_CADET_ChannelAppDataMessage *data_message;
138 * How soon should we retry if we fail to get an ACK?
139 * Messages in the queue are sorted by this value.
141 struct GNUNET_TIME_Absolute next_retry;
144 * How long do we wait for an ACK after transmission?
145 * Use for the back-off calculation.
147 struct GNUNET_TIME_Relative retry_delay;
150 * Time when we first successfully transmitted the message
151 * (that is, set @e num_transmissions to 1).
153 struct GNUNET_TIME_Absolute first_transmission_time;
156 * Identifier of the connection that this message took when it
157 * was first transmitted. Only useful if @e num_transmissions is 1.
159 struct GNUNET_CADET_ConnectionTunnelIdentifier connection_taken;
162 * How often was this message transmitted? #GNUNET_SYSERR if there
163 * was an error transmitting the message, #GNUNET_NO if it was not
164 * yet transmitted ever, otherwise the number of (re) transmissions.
166 int num_transmissions;
172 * List of received out-of-order data messages.
174 struct CadetOutOfOrderMessage
177 * Double linked list, FIFO style
179 struct CadetOutOfOrderMessage *next;
182 * Double linked list, FIFO style
184 struct CadetOutOfOrderMessage *prev;
187 * ID of the message (messages up to this point needed
188 * before we give this one to the client).
190 struct ChannelMessageIdentifier mid;
193 * The envelope with the payload of the out-of-order message
195 struct GNUNET_MQ_Envelope *env;
201 * Client endpoint of a `struct CadetChannel`. A channel may be a
202 * loopback channel, in which case it has two of these endpoints.
203 * Note that flow control also is required in both directions.
205 struct CadetChannelClient
208 * Client handle. Not by itself sufficient to designate
209 * the client endpoint, as the same client handle may
210 * be used for both the owner and the destination, and
211 * we thus also need the channel ID to identify the client.
213 struct CadetClient *c;
216 * Head of DLL of messages received out of order or while client was unready.
218 struct CadetOutOfOrderMessage *head_recv;
221 * Tail DLL of messages received out of order or while client was unready.
223 struct CadetOutOfOrderMessage *tail_recv;
226 * Local tunnel number for this client.
227 * (if owner >= #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI,
228 * otherwise < #GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
230 struct GNUNET_CADET_ClientChannelNumber ccn;
233 * Number of entries currently in @a head_recv DLL.
235 unsigned int num_recv;
238 * Can we send data to the client?
246 * Struct containing all information regarding a channel to a remote client.
251 * Tunnel this channel is in.
253 struct CadetTunnel *t;
256 * Client owner of the tunnel, if any.
257 * (Used if this channel represends the initiating end of the tunnel.)
259 struct CadetChannelClient *owner;
262 * Client destination of the tunnel, if any.
263 * (Used if this channel represents the listening end of the tunnel.)
265 struct CadetChannelClient *dest;
268 * Last entry in the tunnel's queue relating to control messages
269 * (#GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN or
270 * #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_ACK). Used to cancel
271 * transmission in case we receive updated information.
273 struct CadetTunnelQueueEntry *last_control_qe;
276 * Head of DLL of messages sent and not yet ACK'd.
278 struct CadetReliableMessage *head_sent;
281 * Tail of DLL of messages sent and not yet ACK'd.
283 struct CadetReliableMessage *tail_sent;
286 * Task to resend/poll in case no ACK is received.
288 struct GNUNET_SCHEDULER_Task *retry_control_task;
291 * Task to resend/poll in case no ACK is received.
293 struct GNUNET_SCHEDULER_Task *retry_data_task;
296 * Last time the channel was used
298 struct GNUNET_TIME_Absolute timestamp;
301 * Destination port of the channel.
303 struct GNUNET_HashCode port;
306 * Hash'ed port of the channel with initiator and destination PID.
308 struct GNUNET_HashCode h_port;
311 * Counter for exponential backoff.
313 struct GNUNET_TIME_Relative retry_time;
316 * Bitfield of already-received messages past @e mid_recv.
318 uint64_t mid_futures;
321 * Next MID expected for incoming traffic.
323 struct ChannelMessageIdentifier mid_recv;
326 * Next MID to use for outgoing traffic.
328 struct ChannelMessageIdentifier mid_send;
331 * Total (reliable) messages pending ACK for this channel.
333 unsigned int pending_messages;
336 * Maximum (reliable) messages pending ACK for this channel
337 * before we throttle the client.
339 unsigned int max_pending_messages;
342 * Number identifying this channel in its tunnel.
344 struct GNUNET_CADET_ChannelTunnelNumber ctn;
349 enum CadetChannelState state;
352 * Count how many ACKs we skipped, used to prevent long
353 * sequences of ACK skipping.
355 unsigned int skip_ack_series;
358 * Is the tunnel bufferless (minimum latency)?
363 * Is the tunnel reliable?
368 * Is the tunnel out-of-order?
373 * Is this channel a loopback channel, where the destination is us again?
378 * Flag to signal the destruction of the channel. If this is set to
379 * #GNUNET_YES the channel will be destroyed once the queue is
388 * Get the static string for identification of the channel.
392 * @return Static string with the channel IDs.
395 GCCH_2s (const struct CadetChannel *ch)
397 static char buf[128];
399 GNUNET_snprintf (buf,
401 "Channel %s:%s ctn:%X(%X/%X)",
402 (GNUNET_YES == ch->is_loopback)
404 : GNUNET_i2s (GCP_get_id (GCT_get_destination (ch->t))),
405 GNUNET_h2s (&ch->port),
407 (NULL == ch->owner) ? 0 : ntohl (ch->owner->ccn.channel_of_client),
408 (NULL == ch->dest) ? 0 : ntohl (ch->dest->ccn.channel_of_client));
414 * Hash the @a port and @a initiator and @a listener to
415 * calculate the "challenge" @a h_port we send to the other
416 * peer on #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN.
418 * @param[out] h_port set to the hash of @a port, @a initiator and @a listener
419 * @param port cadet port, as seen by CADET clients
420 * @param listener peer that is listining on @a port
423 GCCH_hash_port (struct GNUNET_HashCode *h_port,
424 const struct GNUNET_HashCode *port,
425 const struct GNUNET_PeerIdentity *listener)
427 struct GNUNET_HashContext *hc;
429 hc = GNUNET_CRYPTO_hash_context_start ();
430 GNUNET_CRYPTO_hash_context_read (hc,
433 GNUNET_CRYPTO_hash_context_read (hc,
436 GNUNET_CRYPTO_hash_context_finish (hc,
438 LOG (GNUNET_ERROR_TYPE_DEBUG,
439 "Calculated port hash %s\n",
440 GNUNET_h2s (h_port));
445 * Get the channel's public ID.
449 * @return ID used to identify the channel with the remote peer.
451 struct GNUNET_CADET_ChannelTunnelNumber
452 GCCH_get_id (const struct CadetChannel *ch)
459 * Release memory associated with @a ccc
461 * @param ccc data structure to clean up
464 free_channel_client (struct CadetChannelClient *ccc)
466 struct CadetOutOfOrderMessage *com;
468 while (NULL != (com = ccc->head_recv))
470 GNUNET_CONTAINER_DLL_remove (ccc->head_recv,
474 GNUNET_MQ_discard (com->env);
482 * Destroy the given channel.
484 * @param ch channel to destroy
487 channel_destroy (struct CadetChannel *ch)
489 struct CadetReliableMessage *crm;
491 while (NULL != (crm = ch->head_sent))
493 GNUNET_assert (ch == crm->ch);
496 GCT_send_cancel (crm->qe);
499 GNUNET_CONTAINER_DLL_remove (ch->head_sent,
502 GNUNET_free (crm->data_message);
505 if (CADET_CHANNEL_LOOSE == ch->state)
507 GSC_drop_loose_channel (&ch->h_port,
510 if (NULL != ch->owner)
512 free_channel_client (ch->owner);
515 if (NULL != ch->dest)
517 free_channel_client (ch->dest);
520 if (NULL != ch->last_control_qe)
522 GCT_send_cancel (ch->last_control_qe);
523 ch->last_control_qe = NULL;
525 if (NULL != ch->retry_data_task)
527 GNUNET_SCHEDULER_cancel (ch->retry_data_task);
528 ch->retry_data_task = NULL;
530 if (NULL != ch->retry_control_task)
532 GNUNET_SCHEDULER_cancel (ch->retry_control_task);
533 ch->retry_control_task = NULL;
535 if (GNUNET_NO == ch->is_loopback)
537 GCT_remove_channel (ch->t,
547 * Send a channel create message.
549 * @param cls Channel for which to send.
552 send_channel_open (void *cls);
556 * Function called once the tunnel confirms that we sent the
557 * create message. Delays for a bit until we retry.
559 * @param cls our `struct CadetChannel`.
560 * @param cid identifier of the connection within the tunnel, NULL
561 * if transmission failed
564 channel_open_sent_cb (void *cls,
565 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid)
567 struct CadetChannel *ch = cls;
569 GNUNET_assert (NULL != ch->last_control_qe);
570 ch->last_control_qe = NULL;
571 ch->retry_time = GNUNET_TIME_STD_BACKOFF (ch->retry_time);
572 LOG (GNUNET_ERROR_TYPE_DEBUG,
573 "Sent CADET_CHANNEL_OPEN on %s, retrying in %s\n",
575 GNUNET_STRINGS_relative_time_to_string (ch->retry_time,
577 ch->retry_control_task
578 = GNUNET_SCHEDULER_add_delayed (ch->retry_time,
585 * Send a channel open message.
587 * @param cls Channel for which to send.
590 send_channel_open (void *cls)
592 struct CadetChannel *ch = cls;
593 struct GNUNET_CADET_ChannelOpenMessage msgcc;
596 ch->retry_control_task = NULL;
597 LOG (GNUNET_ERROR_TYPE_DEBUG,
598 "Sending CHANNEL_OPEN message for %s\n",
602 options |= GNUNET_CADET_OPTION_NOBUFFER;
604 options |= GNUNET_CADET_OPTION_RELIABLE;
605 if (ch->out_of_order)
606 options |= GNUNET_CADET_OPTION_OUT_OF_ORDER;
607 msgcc.header.size = htons (sizeof (msgcc));
608 msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN);
609 msgcc.opt = htonl (options);
610 msgcc.h_port = ch->h_port;
612 ch->state = CADET_CHANNEL_OPEN_SENT;
613 if (NULL != ch->last_control_qe)
614 GCT_send_cancel (ch->last_control_qe);
615 ch->last_control_qe = GCT_send (ch->t,
617 &channel_open_sent_cb,
619 GNUNET_assert (NULL == ch->retry_control_task);
624 * Function called once and only once after a channel was bound
625 * to its tunnel via #GCT_add_channel() is ready for transmission.
626 * Note that this is only the case for channels that this peer
627 * initiates, as for incoming channels we assume that they are
628 * ready for transmission immediately upon receiving the open
629 * message. Used to bootstrap the #GCT_send() process.
631 * @param ch the channel for which the tunnel is now ready
634 GCCH_tunnel_up (struct CadetChannel *ch)
636 GNUNET_assert (NULL == ch->retry_control_task);
637 LOG (GNUNET_ERROR_TYPE_DEBUG,
638 "Tunnel up, sending CHANNEL_OPEN on %s now\n",
640 ch->retry_control_task
641 = GNUNET_SCHEDULER_add_now (&send_channel_open,
647 * Create a new channel.
649 * @param owner local client owning the channel
650 * @param ccn local number of this channel at the @a owner
651 * @param destination peer to which we should build the channel
652 * @param port desired port at @a destination
653 * @param options options for the channel
654 * @return handle to the new channel
656 struct CadetChannel *
657 GCCH_channel_local_new (struct CadetClient *owner,
658 struct GNUNET_CADET_ClientChannelNumber ccn,
659 struct CadetPeer *destination,
660 const struct GNUNET_HashCode *port,
663 struct CadetChannel *ch;
664 struct CadetChannelClient *ccco;
666 ccco = GNUNET_new (struct CadetChannelClient);
669 ccco->client_ready = GNUNET_YES;
671 ch = GNUNET_new (struct CadetChannel);
672 ch->mid_recv.mid = htonl (1); /* The OPEN_ACK counts as message 0! */
673 ch->nobuffer = (0 != (options & GNUNET_CADET_OPTION_NOBUFFER));
674 ch->reliable = (0 != (options & GNUNET_CADET_OPTION_RELIABLE));
675 ch->out_of_order = (0 != (options & GNUNET_CADET_OPTION_OUT_OF_ORDER));
676 ch->max_pending_messages = (ch->nobuffer) ? 1 : 4; /* FIXME: 4!? Do not hardcode! */
679 GCCH_hash_port (&ch->h_port,
681 GCP_get_id (destination));
682 if (0 == GNUNET_memcmp (&my_full_id,
683 GCP_get_id (destination)))
687 ch->is_loopback = GNUNET_YES;
688 op = GNUNET_CONTAINER_multihashmap_get (open_ports,
692 /* port closed, wait for it to possibly open */
693 ch->state = CADET_CHANNEL_LOOSE;
694 (void) GNUNET_CONTAINER_multihashmap_put (loose_channels,
697 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
698 LOG (GNUNET_ERROR_TYPE_DEBUG,
699 "Created loose incoming loopback channel to port %s\n",
700 GNUNET_h2s (&ch->port));
711 ch->t = GCP_get_tunnel (destination,
713 ch->retry_time = CADET_INITIAL_RETRANSMIT_TIME;
714 ch->ctn = GCT_add_channel (ch->t,
717 GNUNET_STATISTICS_update (stats,
721 LOG (GNUNET_ERROR_TYPE_DEBUG,
722 "Created channel to port %s at peer %s for %s using %s\n",
724 GCP_2s (destination),
726 (GNUNET_YES == ch->is_loopback) ? "loopback" : GCT_2s (ch->t));
732 * We had an incoming channel to a port that is closed.
733 * It has not been opened for a while, drop it.
735 * @param cls the channel to drop
738 timeout_closed_cb (void *cls)
740 struct CadetChannel *ch = cls;
742 ch->retry_control_task = NULL;
743 LOG (GNUNET_ERROR_TYPE_DEBUG,
744 "Closing incoming channel to port %s from peer %s due to timeout\n",
745 GNUNET_h2s (&ch->port),
746 GCP_2s (GCT_get_destination (ch->t)));
747 channel_destroy (ch);
752 * Create a new channel based on a request coming in over the network.
754 * @param t tunnel to the remote peer
755 * @param ctn identifier of this channel in the tunnel
756 * @param h_port desired hash of local port
757 * @param options options for the channel
758 * @return handle to the new channel
760 struct CadetChannel *
761 GCCH_channel_incoming_new (struct CadetTunnel *t,
762 struct GNUNET_CADET_ChannelTunnelNumber ctn,
763 const struct GNUNET_HashCode *h_port,
766 struct CadetChannel *ch;
769 ch = GNUNET_new (struct CadetChannel);
770 ch->h_port = *h_port;
773 ch->retry_time = CADET_INITIAL_RETRANSMIT_TIME;
774 ch->nobuffer = (0 != (options & GNUNET_CADET_OPTION_NOBUFFER));
775 ch->reliable = (0 != (options & GNUNET_CADET_OPTION_RELIABLE));
776 ch->out_of_order = (0 != (options & GNUNET_CADET_OPTION_OUT_OF_ORDER));
777 ch->max_pending_messages = (ch->nobuffer) ? 1 : 4; /* FIXME: 4!? Do not hardcode! */
778 GNUNET_STATISTICS_update (stats,
783 op = GNUNET_CONTAINER_multihashmap_get (open_ports,
787 /* port closed, wait for it to possibly open */
788 ch->state = CADET_CHANNEL_LOOSE;
789 (void) GNUNET_CONTAINER_multihashmap_put (loose_channels,
792 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
793 GNUNET_assert (NULL == ch->retry_control_task);
794 ch->retry_control_task
795 = GNUNET_SCHEDULER_add_delayed (TIMEOUT_CLOSED_PORT,
798 LOG (GNUNET_ERROR_TYPE_DEBUG,
799 "Created loose incoming channel to port %s from peer %s\n",
800 GNUNET_h2s (&ch->port),
801 GCP_2s (GCT_get_destination (ch->t)));
809 GNUNET_STATISTICS_update (stats,
818 * Function called once the tunnel confirms that we sent the
819 * ACK message. Just remembers it was sent, we do not expect
822 * @param cls our `struct CadetChannel`.
823 * @param cid identifier of the connection within the tunnel, NULL
824 * if transmission failed
827 send_ack_cb (void *cls,
828 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid)
830 struct CadetChannel *ch = cls;
832 GNUNET_assert (NULL != ch->last_control_qe);
833 ch->last_control_qe = NULL;
838 * Compute and send the current #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA_ACK to the other peer.
840 * @param ch channel to send the #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA_ACK for
843 send_channel_data_ack (struct CadetChannel *ch)
845 struct GNUNET_CADET_ChannelDataAckMessage msg;
847 if (GNUNET_NO == ch->reliable)
848 return; /* no ACKs */
849 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA_ACK);
850 msg.header.size = htons (sizeof (msg));
852 msg.mid.mid = htonl (ntohl (ch->mid_recv.mid));
853 msg.futures = GNUNET_htonll (ch->mid_futures);
854 LOG (GNUNET_ERROR_TYPE_DEBUG,
855 "Sending DATA_ACK %u:%llX via %s\n",
856 (unsigned int) ntohl (msg.mid.mid),
857 (unsigned long long) ch->mid_futures,
859 if (NULL != ch->last_control_qe)
860 GCT_send_cancel (ch->last_control_qe);
861 ch->last_control_qe = GCT_send (ch->t,
869 * Send our initial #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_ACK to the client confirming that the
872 * @param cls the `struct CadetChannel`
875 send_open_ack (void *cls)
877 struct CadetChannel *ch = cls;
878 struct GNUNET_CADET_ChannelOpenAckMessage msg;
880 ch->retry_control_task = NULL;
881 LOG (GNUNET_ERROR_TYPE_DEBUG,
882 "Sending CHANNEL_OPEN_ACK on %s\n",
884 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_ACK);
885 msg.header.size = htons (sizeof (msg));
886 msg.reserved = htonl (0);
889 if (NULL != ch->last_control_qe)
890 GCT_send_cancel (ch->last_control_qe);
891 ch->last_control_qe = GCT_send (ch->t,
899 * We got a #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN message again for
900 * this channel. If the binding was successful, (re)transmit the
901 * #GNUNET_MESSAGE_TYPE_CADET_CHANNEL_OPEN_ACK.
903 * @param ch channel that got the duplicate open
904 * @param cti identifier of the connection that delivered the message
907 GCCH_handle_duplicate_open (struct CadetChannel *ch,
908 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cti)
910 if (NULL == ch->dest)
912 LOG (GNUNET_ERROR_TYPE_DEBUG,
913 "Ignoring duplicate CHANNEL_OPEN on %s: port is closed\n",
917 if (NULL != ch->retry_control_task)
919 LOG (GNUNET_ERROR_TYPE_DEBUG,
920 "Ignoring duplicate CHANNEL_OPEN on %s: control message is pending\n",
924 LOG (GNUNET_ERROR_TYPE_DEBUG,
925 "Retransmitting CHANNEL_OPEN_ACK on %s\n",
927 ch->retry_control_task
928 = GNUNET_SCHEDULER_add_now (&send_open_ack,
934 * Send a #GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK to the client to solicit more messages.
936 * @param ch channel the ack is for
937 * @param to_owner #GNUNET_YES to send to owner,
938 * #GNUNET_NO to send to dest
941 send_ack_to_client (struct CadetChannel *ch,
944 struct GNUNET_MQ_Envelope *env;
945 struct GNUNET_CADET_LocalAck *ack;
946 struct CadetChannelClient *ccc;
948 ccc = (GNUNET_YES == to_owner) ? ch->owner : ch->dest;
951 /* This can happen if we are just getting ACKs after
952 our local client already disconnected. */
953 GNUNET_assert (GNUNET_YES == ch->destroy);
956 env = GNUNET_MQ_msg (ack,
957 GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
959 LOG (GNUNET_ERROR_TYPE_DEBUG,
960 "Sending CADET_LOCAL_ACK to %s (%s) at ccn %X (%u/%u pending)\n",
962 (GNUNET_YES == to_owner) ? "owner" : "dest",
963 ntohl (ack->ccn.channel_of_client),
964 ch->pending_messages,
965 ch->max_pending_messages);
966 GSC_send_to_client (ccc->c,
972 * A client is bound to the port that we have a channel
973 * open to. Send the acknowledgement for the connection
974 * request and establish the link with the client.
976 * @param ch open incoming channel
977 * @param c client listening on the respective @a port
978 * @param port the port @a is listening on
981 GCCH_bind (struct CadetChannel *ch,
982 struct CadetClient *c,
983 const struct GNUNET_HashCode *port)
986 struct CadetChannelClient *cccd;
988 LOG (GNUNET_ERROR_TYPE_DEBUG,
989 "Binding %s from %s to port %s of %s\n",
992 GNUNET_h2s (&ch->port),
994 if (NULL != ch->retry_control_task)
996 /* there might be a timeout task here */
997 GNUNET_SCHEDULER_cancel (ch->retry_control_task);
998 ch->retry_control_task = NULL;
1002 options |= GNUNET_CADET_OPTION_NOBUFFER;
1004 options |= GNUNET_CADET_OPTION_RELIABLE;
1005 if (ch->out_of_order)
1006 options |= GNUNET_CADET_OPTION_OUT_OF_ORDER;
1007 cccd = GNUNET_new (struct CadetChannelClient);
1008 GNUNET_assert (NULL == ch->dest);
1012 cccd->client_ready = GNUNET_YES;
1013 cccd->ccn = GSC_bind (c,
1015 (GNUNET_YES == ch->is_loopback)
1016 ? GCP_get (&my_full_id,
1018 : GCT_get_destination (ch->t),
1021 GNUNET_assert (ntohl (cccd->ccn.channel_of_client) <
1022 GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1023 ch->mid_recv.mid = htonl (1); /* The OPEN counts as message 0! */
1024 if (GNUNET_YES == ch->is_loopback)
1026 ch->state = CADET_CHANNEL_OPEN_SENT;
1027 GCCH_handle_channel_open_ack (ch,
1033 /* notify other peer that we accepted the connection */
1034 ch->state = CADET_CHANNEL_READY;
1035 ch->retry_control_task
1036 = GNUNET_SCHEDULER_add_now (&send_open_ack,
1039 /* give client it's initial supply of ACKs */
1040 GNUNET_assert (ntohl (cccd->ccn.channel_of_client) <
1041 GNUNET_CADET_LOCAL_CHANNEL_ID_CLI);
1042 for (unsigned int i=0;i<ch->max_pending_messages;i++)
1043 send_ack_to_client (ch,
1049 * One of our clients has disconnected, tell the other one that we
1050 * are finished. Done asynchronously to avoid concurrent modification
1051 * issues if this is the same client.
1053 * @param cls the `struct CadetChannel` where one of the ends is now dead
1056 signal_remote_destroy_cb (void *cls)
1058 struct CadetChannel *ch = cls;
1059 struct CadetChannelClient *ccc;
1061 /* Find which end is left... */
1062 ch->retry_control_task = NULL;
1063 ccc = (NULL != ch->owner) ? ch->owner : ch->dest;
1064 GSC_handle_remote_channel_destroy (ccc->c,
1067 channel_destroy (ch);
1072 * Destroy locally created channel. Called by the local client, so no
1073 * need to tell the client.
1075 * @param ch channel to destroy
1076 * @param c client that caused the destruction
1077 * @param ccn client number of the client @a c
1080 GCCH_channel_local_destroy (struct CadetChannel *ch,
1081 struct CadetClient *c,
1082 struct GNUNET_CADET_ClientChannelNumber ccn)
1084 LOG (GNUNET_ERROR_TYPE_DEBUG,
1085 "%s asks for destruction of %s\n",
1088 GNUNET_assert (NULL != c);
1089 if ( (NULL != ch->owner) &&
1090 (c == ch->owner->c) &&
1091 (ccn.channel_of_client == ch->owner->ccn.channel_of_client) )
1093 free_channel_client (ch->owner);
1096 else if ( (NULL != ch->dest) &&
1097 (c == ch->dest->c) &&
1098 (ccn.channel_of_client == ch->dest->ccn.channel_of_client) )
1100 free_channel_client (ch->dest);
1108 if (GNUNET_YES == ch->destroy)
1110 /* other end already destroyed, with the local client gone, no need
1111 to finish transmissions, just destroy immediately. */
1112 channel_destroy (ch);
1115 if ( (NULL != ch->head_sent) &&
1116 ( (NULL != ch->owner) ||
1117 (NULL != ch->dest) ) )
1119 /* Wait for other end to destroy us as well,
1120 and otherwise allow send queue to be transmitted first */
1121 ch->destroy = GNUNET_YES;
1124 if ( (GNUNET_YES == ch->is_loopback) &&
1125 ( (NULL != ch->owner) ||
1126 (NULL != ch->dest) ) )
1128 if (NULL != ch->retry_control_task)
1129 GNUNET_SCHEDULER_cancel (ch->retry_control_task);
1130 ch->retry_control_task
1131 = GNUNET_SCHEDULER_add_now (&signal_remote_destroy_cb,
1135 if (GNUNET_NO == ch->is_loopback)
1137 /* If the we ever sent the CHANNEL_CREATE, we need to send a destroy message. */
1140 case CADET_CHANNEL_NEW:
1141 /* We gave up on a channel that we created as a client to a remote
1142 target, but that never went anywhere. Nothing to do here. */
1144 case CADET_CHANNEL_LOOSE:
1147 GCT_send_channel_destroy (ch->t,
1151 /* Nothing left to do, just finish destruction */
1152 channel_destroy (ch);
1157 * We got an acknowledgement for the creation of the channel
1158 * (the port is open on the other side). Verify that the
1159 * other end really has the right port, and begin transmissions.
1161 * @param ch channel to destroy
1162 * @param cti identifier of the connection that delivered the message
1163 * @param port port number (needed to verify receiver knows the port)
1166 GCCH_handle_channel_open_ack (struct CadetChannel *ch,
1167 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cti,
1168 const struct GNUNET_HashCode *port)
1172 case CADET_CHANNEL_NEW:
1173 /* this should be impossible */
1176 case CADET_CHANNEL_LOOSE:
1177 /* This makes no sense. */
1178 GNUNET_break_op (0);
1180 case CADET_CHANNEL_OPEN_SENT:
1181 if (NULL == ch->owner)
1183 /* We're not the owner, wrong direction! */
1184 GNUNET_break_op (0);
1187 if (0 != GNUNET_memcmp (&ch->port,
1190 /* Other peer failed to provide the right port,
1191 refuse connection. */
1192 GNUNET_break_op (0);
1195 LOG (GNUNET_ERROR_TYPE_DEBUG,
1196 "Received CHANNEL_OPEN_ACK for waiting %s, entering READY state\n",
1198 if (NULL != ch->retry_control_task) /* can be NULL if ch->is_loopback */
1200 GNUNET_SCHEDULER_cancel (ch->retry_control_task);
1201 ch->retry_control_task = NULL;
1203 ch->state = CADET_CHANNEL_READY;
1204 /* On first connect, send client as many ACKs as we allow messages
1206 for (unsigned int i=0;i<ch->max_pending_messages;i++)
1207 send_ack_to_client (ch,
1210 case CADET_CHANNEL_READY:
1211 /* duplicate ACK, maybe we retried the CREATE. Ignore. */
1212 LOG (GNUNET_ERROR_TYPE_DEBUG,
1213 "Received duplicate channel OPEN_ACK for %s\n",
1215 GNUNET_STATISTICS_update (stats,
1216 "# duplicate CREATE_ACKs",
1225 * Test if element @a e1 comes before element @a e2.
1227 * @param cls closure, to a flag where we indicate duplicate packets
1228 * @param m1 a message of to sort
1229 * @param m2 another message to sort
1230 * @return #GNUNET_YES if @e1 < @e2, otherwise #GNUNET_NO
1233 is_before (void *cls,
1234 struct CadetOutOfOrderMessage *m1,
1235 struct CadetOutOfOrderMessage *m2)
1237 int *duplicate = cls;
1238 uint32_t v1 = ntohl (m1->mid.mid);
1239 uint32_t v2 = ntohl (m2->mid.mid);
1244 *duplicate = GNUNET_YES;
1245 if (delta > (uint32_t) INT_MAX)
1247 /* in overflow range, we can safely assume we wrapped around */
1252 /* result is small, thus v2 > v1, thus m1 < m2 */
1259 * We got payload data for a channel. Pass it on to the client
1260 * and send an ACK to the other end (once flow control allows it!)
1262 * @param ch channel that got data
1263 * @param cti identifier of the connection that delivered the message
1264 * @param msg message that was received
1267 GCCH_handle_channel_plaintext_data (struct CadetChannel *ch,
1268 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cti,
1269 const struct GNUNET_CADET_ChannelAppDataMessage *msg)
1271 struct GNUNET_MQ_Envelope *env;
1272 struct GNUNET_CADET_LocalData *ld;
1273 struct CadetChannelClient *ccc;
1274 size_t payload_size;
1275 struct CadetOutOfOrderMessage *com;
1282 GNUNET_assert (GNUNET_NO == ch->is_loopback);
1283 if ( (NULL == ch->owner) &&
1284 (NULL == ch->dest) )
1286 /* This client is gone, but we still have messages to send to
1287 the other end (which is why @a ch is not yet dead). However,
1288 we cannot pass messages to our client anymore. */
1289 LOG (GNUNET_ERROR_TYPE_DEBUG,
1290 "Dropping incoming payload on %s as this end is already closed\n",
1292 /* send back DESTROY notification to stop further retransmissions! */
1293 if (GNUNET_YES == ch->destroy)
1294 GCT_send_channel_destroy (ch->t,
1298 payload_size = ntohs (msg->header.size) - sizeof (*msg);
1299 env = GNUNET_MQ_msg_extra (ld,
1301 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
1302 ld->ccn = (NULL == ch->dest) ? ch->owner->ccn : ch->dest->ccn;
1303 GNUNET_memcpy (&ld[1],
1306 ccc = (NULL != ch->owner) ? ch->owner : ch->dest;
1307 if (GNUNET_YES == ccc->client_ready)
1310 * We ad-hoc send the message if
1311 * - The channel is out-of-order
1312 * - The channel is reliable and MID matches next expected MID
1313 * - The channel is unreliable and MID is before lowest seen MID
1315 if ( (GNUNET_YES == ch->out_of_order) ||
1316 ((msg->mid.mid == ch->mid_recv.mid) &&
1317 (GNUNET_YES == ch->reliable)) ||
1318 ((GNUNET_NO == ch->reliable) &&
1319 (ntohl (msg->mid.mid) >= ntohl (ch->mid_recv.mid)) &&
1320 ((NULL == ccc->head_recv) ||
1321 (ntohl (msg->mid.mid) < ntohl (ccc->head_recv->mid.mid)))) )
1323 LOG (GNUNET_ERROR_TYPE_DEBUG,
1324 "Giving %u bytes of payload with MID %u from %s to client %s\n",
1325 (unsigned int) payload_size,
1326 ntohl (msg->mid.mid),
1329 ccc->client_ready = GNUNET_NO;
1330 GSC_send_to_client (ccc->c,
1332 if (GNUNET_NO == ch->out_of_order)
1333 ch->mid_recv.mid = htonl (1 + ntohl (msg->mid.mid));
1335 ch->mid_recv.mid = htonl (1 + ntohl (ch->mid_recv.mid));
1336 ch->mid_futures >>= 1;
1337 if ( (GNUNET_YES == ch->out_of_order) &&
1338 (GNUNET_NO == ch->reliable) )
1340 /* possibly shift by more if we skipped messages */
1341 uint64_t delta = htonl (msg->mid.mid) - 1 - ntohl (ch->mid_recv.mid);
1344 ch->mid_futures = 0;
1346 ch->mid_futures >>= delta;
1347 ch->mid_recv.mid = htonl (1 + ntohl (msg->mid.mid));
1349 send_channel_data_ack (ch);
1354 if (GNUNET_YES == ch->reliable)
1356 /* check if message ought to be dropped because it is ancient/too distant/duplicate */
1357 mid_min = ntohl (ch->mid_recv.mid);
1358 mid_max = mid_min + ch->max_pending_messages;
1359 mid_msg = ntohl (msg->mid.mid);
1360 if ( ( (uint32_t) (mid_msg - mid_min) > ch->max_pending_messages) ||
1361 ( (uint32_t) (mid_max - mid_msg) > ch->max_pending_messages) )
1363 LOG (GNUNET_ERROR_TYPE_DEBUG,
1364 "%s at %u drops ancient or far-future message %u\n",
1366 (unsigned int) mid_min,
1367 ntohl (msg->mid.mid));
1369 GNUNET_STATISTICS_update (stats,
1370 "# duplicate DATA (ancient or future)",
1373 GNUNET_MQ_discard (env);
1374 send_channel_data_ack (ch);
1377 /* mark bit for future ACKs */
1378 delta = mid_msg - mid_min - 1; /* overflow/underflow are OK here */
1381 if (0 != (ch->mid_futures & (1LLU << delta)))
1383 /* Duplicate within the queue, drop also */
1384 LOG (GNUNET_ERROR_TYPE_DEBUG,
1385 "Duplicate payload of %u bytes on %s (mid %u) dropped\n",
1386 (unsigned int) payload_size,
1388 ntohl (msg->mid.mid));
1389 GNUNET_STATISTICS_update (stats,
1393 GNUNET_MQ_discard (env);
1394 send_channel_data_ack (ch);
1397 ch->mid_futures |= (1LLU << delta);
1398 LOG (GNUNET_ERROR_TYPE_DEBUG,
1399 "Marked bit %llX for mid %u (base: %u); now: %llX\n",
1406 else /* ! ch->reliable */
1408 struct CadetOutOfOrderMessage *next_msg;
1411 * We always send if possible in this case.
1412 * It is guaranteed that the queued MID < received MID
1414 if ((NULL != ccc->head_recv) &&
1415 (GNUNET_YES == ccc->client_ready))
1417 next_msg = ccc->head_recv;
1418 LOG (GNUNET_ERROR_TYPE_DEBUG,
1419 "Giving queued MID %u from %s to client %s\n",
1420 ntohl (next_msg->mid.mid),
1423 ccc->client_ready = GNUNET_NO;
1424 GSC_send_to_client (ccc->c,
1426 ch->mid_recv.mid = htonl (1 + ntohl (next_msg->mid.mid));
1427 ch->mid_futures >>= 1;
1428 send_channel_data_ack (ch);
1429 GNUNET_CONTAINER_DLL_remove (ccc->head_recv,
1433 /* Do not process duplicate MID */
1434 if (msg->mid.mid == next_msg->mid.mid) /* Duplicate */
1436 /* Duplicate within the queue, drop */
1437 LOG (GNUNET_ERROR_TYPE_DEBUG,
1438 "Message on %s (mid %u) dropped, duplicate\n",
1440 ntohl (msg->mid.mid));
1441 GNUNET_free (next_msg);
1442 GNUNET_MQ_discard (env);
1445 GNUNET_free (next_msg);
1448 if (ntohl (msg->mid.mid) < ntohl (ch->mid_recv.mid)) /* Old */
1450 /* Duplicate within the queue, drop */
1451 LOG (GNUNET_ERROR_TYPE_DEBUG,
1452 "Message on %s (mid %u) dropped, old.\n",
1454 ntohl (msg->mid.mid));
1455 GNUNET_MQ_discard (env);
1459 /* Channel is unreliable, so we do not ACK. But we also cannot
1460 allow buffering everything, so check if we have space... */
1461 if (ccc->num_recv >= ch->max_pending_messages)
1463 struct CadetOutOfOrderMessage *drop;
1465 /* Yep, need to drop. Drop the oldest message in
1467 LOG (GNUNET_ERROR_TYPE_DEBUG,
1468 "Queue full due slow client on %s, dropping oldest message\n",
1470 GNUNET_STATISTICS_update (stats,
1471 "# messages dropped due to slow client",
1474 drop = ccc->head_recv;
1475 GNUNET_CONTAINER_DLL_remove (ccc->head_recv,
1479 GNUNET_MQ_discard (drop->env);
1484 /* Insert message into sorted out-of-order queue */
1485 com = GNUNET_new (struct CadetOutOfOrderMessage);
1486 com->mid = msg->mid;
1488 duplicate = GNUNET_NO;
1489 GNUNET_CONTAINER_DLL_insert_sorted (struct CadetOutOfOrderMessage,
1496 if (GNUNET_YES == duplicate)
1498 /* Duplicate within the queue, drop also (this is not covered by
1499 the case above if "delta" >= 64, which could be the case if
1500 max_pending_messages is also >= 64 or if our client is unready
1501 and we are seeing retransmissions of the message our client is
1503 LOG (GNUNET_ERROR_TYPE_DEBUG,
1504 "Duplicate payload of %u bytes on %s (mid %u) dropped\n",
1505 (unsigned int) payload_size,
1507 ntohl (msg->mid.mid));
1508 GNUNET_STATISTICS_update (stats,
1512 GNUNET_CONTAINER_DLL_remove (ccc->head_recv,
1516 GNUNET_MQ_discard (com->env);
1518 send_channel_data_ack (ch);
1521 LOG (GNUNET_ERROR_TYPE_DEBUG,
1522 "Queued %s payload of %u bytes on %s-%X(%p) (mid %u, need %u first)\n",
1523 (GNUNET_YES == ccc->client_ready)
1525 : "client-not-ready",
1526 (unsigned int) payload_size,
1528 ntohl (ccc->ccn.channel_of_client),
1530 ntohl (msg->mid.mid),
1531 ntohl (ch->mid_recv.mid));
1532 /* NOTE: this ACK we _could_ skip, as the packet is out-of-order and
1533 the sender may already be transmitting the previous one. Needs
1534 experimental evaluation to see if/when this ACK helps or
1535 hurts. (We might even want another option.) */
1536 send_channel_data_ack (ch);
1541 * Function called once the tunnel has sent one of our messages.
1542 * If the message is unreliable, simply frees the `crm`. If the
1543 * message was reliable, calculate retransmission time and
1544 * wait for ACK (or retransmit).
1546 * @param cls the `struct CadetReliableMessage` that was sent
1547 * @param cid identifier of the connection within the tunnel, NULL
1548 * if transmission failed
1551 data_sent_cb (void *cls,
1552 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid);
1556 * We need to retry a transmission, the last one took too long to
1559 * @param cls the `struct CadetChannel` where we need to retransmit
1562 retry_transmission (void *cls)
1564 struct CadetChannel *ch = cls;
1565 struct CadetReliableMessage *crm = ch->head_sent;
1567 ch->retry_data_task = NULL;
1568 GNUNET_assert (NULL == crm->qe);
1569 LOG (GNUNET_ERROR_TYPE_DEBUG,
1570 "Retrying transmission on %s of message %u\n",
1572 (unsigned int) ntohl (crm->data_message->mid.mid));
1573 crm->qe = GCT_send (ch->t,
1574 &crm->data_message->header,
1577 GNUNET_assert (NULL == ch->retry_data_task);
1582 * We got an PLAINTEXT_DATA_ACK for a message in our queue, remove it from
1583 * the queue and tell our client that it can send more.
1585 * @param ch the channel that got the PLAINTEXT_DATA_ACK
1586 * @param cti identifier of the connection that delivered the message
1587 * @param crm the message that got acknowledged
1590 handle_matching_ack (struct CadetChannel *ch,
1591 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cti,
1592 struct CadetReliableMessage *crm)
1594 GNUNET_CONTAINER_DLL_remove (ch->head_sent,
1597 ch->pending_messages--;
1598 GNUNET_assert (ch->pending_messages < ch->max_pending_messages);
1599 LOG (GNUNET_ERROR_TYPE_DEBUG,
1600 "Received DATA_ACK on %s for message %u (%u ACKs pending)\n",
1602 (unsigned int) ntohl (crm->data_message->mid.mid),
1603 ch->pending_messages);
1604 if (NULL != crm->qe)
1606 GCT_send_cancel (crm->qe);
1609 if ( (1 == crm->num_transmissions) &&
1612 GCC_ack_observed (cti);
1613 if (0 == GNUNET_memcmp (cti,
1614 &crm->connection_taken))
1616 GCC_latency_observed (cti,
1617 GNUNET_TIME_absolute_get_duration (crm->first_transmission_time));
1620 GNUNET_free (crm->data_message);
1622 send_ack_to_client (ch,
1630 * We got an acknowledgement for payload data for a channel.
1631 * Possibly resume transmissions.
1633 * @param ch channel that got the ack
1634 * @param cti identifier of the connection that delivered the message
1635 * @param ack details about what was received
1638 GCCH_handle_channel_plaintext_data_ack (struct CadetChannel *ch,
1639 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cti,
1640 const struct GNUNET_CADET_ChannelDataAckMessage *ack)
1642 struct CadetReliableMessage *crm;
1643 struct CadetReliableMessage *crmn;
1649 GNUNET_break (GNUNET_NO == ch->is_loopback);
1650 if (GNUNET_NO == ch->reliable)
1652 /* not expecting ACKs on unreliable channel, odd */
1653 GNUNET_break_op (0);
1656 /* mid_base is the MID of the next message that the
1657 other peer expects (i.e. that is missing!), everything
1658 LOWER (but excluding mid_base itself) was received. */
1659 mid_base = ntohl (ack->mid.mid);
1660 mid_mask = GNUNET_htonll (ack->futures);
1662 for (crm = ch->head_sent;
1667 delta = (unsigned int) (ntohl (crm->data_message->mid.mid) - mid_base);
1668 if (delta >= UINT_MAX - ch->max_pending_messages)
1670 /* overflow, means crm was a bit in the past, so this ACK counts for it. */
1671 LOG (GNUNET_ERROR_TYPE_DEBUG,
1672 "Got DATA_ACK with base %u satisfying past message %u on %s\n",
1673 (unsigned int) mid_base,
1674 ntohl (crm->data_message->mid.mid),
1676 handle_matching_ack (ch,
1685 LOG (GNUNET_ERROR_TYPE_DEBUG,
1686 "Testing bit %llX for mid %u (base: %u)\n",
1688 ntohl (crm->data_message->mid.mid),
1690 if (0 != (mid_mask & (1LLU << delta)))
1692 LOG (GNUNET_ERROR_TYPE_DEBUG,
1693 "Got DATA_ACK with mask for %u on %s\n",
1694 ntohl (crm->data_message->mid.mid),
1696 handle_matching_ack (ch,
1702 if (GNUNET_NO == found)
1704 /* ACK for message we already dropped, might have been a
1705 duplicate ACK? Ignore. */
1706 LOG (GNUNET_ERROR_TYPE_DEBUG,
1707 "Duplicate DATA_ACK on %s, ignoring\n",
1709 GNUNET_STATISTICS_update (stats,
1710 "# duplicate DATA_ACKs",
1715 if (NULL != ch->retry_data_task)
1717 GNUNET_SCHEDULER_cancel (ch->retry_data_task);
1718 ch->retry_data_task = NULL;
1720 if ( (NULL != ch->head_sent) &&
1721 (NULL == ch->head_sent->qe) )
1723 = GNUNET_SCHEDULER_add_at (ch->head_sent->next_retry,
1724 &retry_transmission,
1730 * Destroy channel, based on the other peer closing the
1731 * connection. Also needs to remove this channel from
1734 * @param ch channel to destroy
1735 * @param cti identifier of the connection that delivered the message,
1736 * NULL if we are simulating receiving a destroy due to shutdown
1739 GCCH_handle_remote_destroy (struct CadetChannel *ch,
1740 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cti)
1742 struct CadetChannelClient *ccc;
1744 GNUNET_assert (GNUNET_NO == ch->is_loopback);
1745 LOG (GNUNET_ERROR_TYPE_DEBUG,
1746 "Received remote channel DESTROY for %s\n",
1748 if (GNUNET_YES == ch->destroy)
1750 /* Local client already gone, this is instant-death. */
1751 channel_destroy (ch);
1754 ccc = (NULL != ch->owner) ? ch->owner : ch->dest;
1755 if ( (NULL != ccc) &&
1756 (NULL != ccc->head_recv) )
1758 LOG (GNUNET_ERROR_TYPE_WARNING,
1759 "Lost end of transmission due to remote shutdown on %s\n",
1761 /* FIXME: change API to notify client about truncated transmission! */
1763 ch->destroy = GNUNET_YES;
1765 GSC_handle_remote_channel_destroy (ccc->c,
1768 channel_destroy (ch);
1773 * Test if element @a e1 comes before element @a e2.
1775 * @param cls closure, to a flag where we indicate duplicate packets
1776 * @param crm1 an element of to sort
1777 * @param crm2 another element to sort
1778 * @return #GNUNET_YES if @e1 < @e2, otherwise #GNUNET_NO
1781 cmp_crm_by_next_retry (void *cls,
1782 struct CadetReliableMessage *crm1,
1783 struct CadetReliableMessage *crm2)
1785 if (crm1->next_retry.abs_value_us <
1786 crm2->next_retry.abs_value_us)
1793 * Function called once the tunnel has sent one of our messages.
1794 * If the message is unreliable, simply frees the `crm`. If the
1795 * message was reliable, calculate retransmission time and
1796 * wait for ACK (or retransmit).
1798 * @param cls the `struct CadetReliableMessage` that was sent
1799 * @param cid identifier of the connection within the tunnel, NULL
1800 * if transmission failed
1803 data_sent_cb (void *cls,
1804 const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid)
1806 struct CadetReliableMessage *crm = cls;
1807 struct CadetChannel *ch = crm->ch;
1809 GNUNET_assert (GNUNET_NO == ch->is_loopback);
1810 GNUNET_assert (NULL != crm->qe);
1812 GNUNET_CONTAINER_DLL_remove (ch->head_sent,
1815 if (GNUNET_NO == ch->reliable)
1817 GNUNET_free (crm->data_message);
1819 ch->pending_messages--;
1820 send_ack_to_client (ch,
1828 /* There was an error sending. */
1829 crm->num_transmissions = GNUNET_SYSERR;
1831 else if (GNUNET_SYSERR != crm->num_transmissions)
1833 /* Increment transmission counter, and possibly store @a cid
1834 if this was the first transmission. */
1835 crm->num_transmissions++;
1836 if (1 == crm->num_transmissions)
1838 crm->first_transmission_time = GNUNET_TIME_absolute_get ();
1839 crm->connection_taken = *cid;
1840 GCC_ack_expected (cid);
1843 if ( (0 == crm->retry_delay.rel_value_us) &&
1846 struct CadetConnection *cc = GCC_lookup (cid);
1849 crm->retry_delay = GCC_get_metrics (cc)->aged_latency;
1851 crm->retry_delay = ch->retry_time;
1853 crm->retry_delay = GNUNET_TIME_STD_BACKOFF (crm->retry_delay);
1854 crm->retry_delay = GNUNET_TIME_relative_max (crm->retry_delay,
1856 crm->next_retry = GNUNET_TIME_relative_to_absolute (crm->retry_delay);
1858 GNUNET_CONTAINER_DLL_insert_sorted (struct CadetReliableMessage,
1859 cmp_crm_by_next_retry,
1864 LOG (GNUNET_ERROR_TYPE_DEBUG,
1865 "Message %u sent, next transmission on %s in %s\n",
1866 (unsigned int) ntohl (crm->data_message->mid.mid),
1868 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (ch->head_sent->next_retry),
1870 if (NULL == ch->head_sent->qe)
1872 if (NULL != ch->retry_data_task)
1873 GNUNET_SCHEDULER_cancel (ch->retry_data_task);
1875 = GNUNET_SCHEDULER_add_at (ch->head_sent->next_retry,
1876 &retry_transmission,
1883 * Handle data given by a client.
1885 * Check whether the client is allowed to send in this tunnel, save if
1886 * channel is reliable and send an ACK to the client if there is still
1887 * buffer space in the tunnel.
1889 * @param ch Channel.
1890 * @param sender_ccn ccn of the sender
1891 * @param buf payload to transmit.
1892 * @param buf_len number of bytes in @a buf
1893 * @return #GNUNET_OK if everything goes well,
1894 * #GNUNET_SYSERR in case of an error.
1897 GCCH_handle_local_data (struct CadetChannel *ch,
1898 struct GNUNET_CADET_ClientChannelNumber sender_ccn,
1902 struct CadetReliableMessage *crm;
1904 if (ch->pending_messages >= ch->max_pending_messages)
1906 GNUNET_break (0); /* Fails: #5370 */
1907 return GNUNET_SYSERR;
1909 if (GNUNET_YES == ch->destroy)
1911 /* we are going down, drop messages */
1914 ch->pending_messages++;
1916 if (GNUNET_YES == ch->is_loopback)
1918 struct CadetChannelClient *receiver;
1919 struct GNUNET_MQ_Envelope *env;
1920 struct GNUNET_CADET_LocalData *ld;
1923 env = GNUNET_MQ_msg_extra (ld,
1925 GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
1926 if ( (NULL != ch->owner) &&
1927 (sender_ccn.channel_of_client ==
1928 ch->owner->ccn.channel_of_client) )
1930 receiver = ch->dest;
1931 ack_to_owner = GNUNET_YES;
1933 else if ( (NULL != ch->dest) &&
1934 (sender_ccn.channel_of_client ==
1935 ch->dest->ccn.channel_of_client) )
1937 receiver = ch->owner;
1938 ack_to_owner = GNUNET_NO;
1943 return GNUNET_SYSERR;
1945 GNUNET_assert (NULL != receiver);
1946 ld->ccn = receiver->ccn;
1947 GNUNET_memcpy (&ld[1],
1950 if (GNUNET_YES == receiver->client_ready)
1952 ch->pending_messages--;
1953 GSC_send_to_client (receiver->c,
1955 send_ack_to_client (ch,
1960 struct CadetOutOfOrderMessage *oom;
1962 oom = GNUNET_new (struct CadetOutOfOrderMessage);
1964 GNUNET_CONTAINER_DLL_insert_tail (receiver->head_recv,
1965 receiver->tail_recv,
1967 receiver->num_recv++;
1972 /* Everything is correct, send the message. */
1973 crm = GNUNET_malloc (sizeof (*crm));
1975 crm->data_message = GNUNET_malloc (sizeof (struct GNUNET_CADET_ChannelAppDataMessage)
1977 crm->data_message->header.size = htons (sizeof (struct GNUNET_CADET_ChannelAppDataMessage) + buf_len);
1978 crm->data_message->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_APP_DATA);
1979 ch->mid_send.mid = htonl (ntohl (ch->mid_send.mid) + 1);
1980 crm->data_message->mid = ch->mid_send;
1981 crm->data_message->ctn = ch->ctn;
1982 GNUNET_memcpy (&crm->data_message[1],
1985 GNUNET_CONTAINER_DLL_insert_tail (ch->head_sent,
1988 LOG (GNUNET_ERROR_TYPE_DEBUG,
1989 "Sending message %u from local client to %s with %u bytes\n",
1990 ntohl (crm->data_message->mid.mid),
1993 if (NULL != ch->retry_data_task)
1995 GNUNET_SCHEDULER_cancel (ch->retry_data_task);
1996 ch->retry_data_task = NULL;
1998 crm->qe = GCT_send (ch->t,
1999 &crm->data_message->header,
2002 GNUNET_assert (NULL == ch->retry_data_task);
2008 * Handle ACK from client on local channel. Means the client is ready
2009 * for more data, see if we have any for it.
2011 * @param ch channel to destroy
2012 * @param client_ccn ccn of the client sending the ack
2015 GCCH_handle_local_ack (struct CadetChannel *ch,
2016 struct GNUNET_CADET_ClientChannelNumber client_ccn)
2018 struct CadetChannelClient *ccc;
2019 struct CadetOutOfOrderMessage *com;
2021 if ( (NULL != ch->owner) &&
2022 (ch->owner->ccn.channel_of_client == client_ccn.channel_of_client) )
2024 else if ( (NULL != ch->dest) &&
2025 (ch->dest->ccn.channel_of_client == client_ccn.channel_of_client) )
2029 ccc->client_ready = GNUNET_YES;
2030 com = ccc->head_recv;
2033 LOG (GNUNET_ERROR_TYPE_DEBUG,
2034 "Got LOCAL_ACK, %s-%X ready to receive more data, but none pending on %s-%X(%p)!\n",
2036 ntohl (client_ccn.channel_of_client),
2038 ntohl (ccc->ccn.channel_of_client),
2040 return; /* none pending */
2042 if (GNUNET_YES == ch->is_loopback)
2046 /* Messages are always in-order, just send */
2047 GNUNET_CONTAINER_DLL_remove (ccc->head_recv,
2051 GSC_send_to_client (ccc->c,
2053 /* Notify sender that we can receive more */
2054 if ( (NULL != ch->owner) &&
2055 (ccc->ccn.channel_of_client ==
2056 ch->owner->ccn.channel_of_client) )
2058 to_owner = GNUNET_NO;
2062 GNUNET_assert ( (NULL != ch->dest) &&
2063 (ccc->ccn.channel_of_client ==
2064 ch->dest->ccn.channel_of_client) );
2065 to_owner = GNUNET_YES;
2067 send_ack_to_client (ch,
2073 if ( (com->mid.mid != ch->mid_recv.mid) &&
2074 (GNUNET_NO == ch->out_of_order) &&
2075 (GNUNET_YES == ch->reliable) )
2077 LOG (GNUNET_ERROR_TYPE_DEBUG,
2078 "Got LOCAL_ACK, %s-%X ready to receive more data (but next one is out-of-order %u vs. %u)!\n",
2080 ntohl (ccc->ccn.channel_of_client),
2081 ntohl (com->mid.mid),
2082 ntohl (ch->mid_recv.mid));
2083 return; /* missing next one in-order */
2086 LOG (GNUNET_ERROR_TYPE_DEBUG,
2087 "Got LOCAL_ACK, giving payload message %u to %s-%X on %s\n",
2088 ntohl (com->mid.mid),
2090 ntohl (ccc->ccn.channel_of_client),
2093 /* all good, pass next message to client */
2094 GNUNET_CONTAINER_DLL_remove (ccc->head_recv,
2098 /* FIXME: if unreliable, this is not aggressive
2099 enough, as it would be OK to have lost some! */
2101 ch->mid_recv.mid = htonl (1 + ntohl (com->mid.mid));
2102 ch->mid_futures >>= 1; /* equivalent to division by 2 */
2103 ccc->client_ready = GNUNET_NO;
2104 GSC_send_to_client (ccc->c,
2107 send_channel_data_ack (ch);
2108 if (NULL != ccc->head_recv)
2110 if (GNUNET_NO == ch->destroy)
2112 GCT_send_channel_destroy (ch->t,
2114 channel_destroy (ch);
2118 #define LOG2(level, ...) GNUNET_log_from_nocheck(level,"cadet-chn",__VA_ARGS__)
2124 * @param ch Channel.
2125 * @param level Debug level to use.
2128 GCCH_debug (struct CadetChannel *ch,
2129 enum GNUNET_ErrorType level)
2131 #if !defined(GNUNET_CULL_LOGGING)
2134 do_log = GNUNET_get_log_call_status (level & (~GNUNET_ERROR_TYPE_BULK),
2136 __FILE__, __FUNCTION__, __LINE__);
2142 LOG2 (level, "CHN *** DEBUG NULL CHANNEL ***\n");
2150 if (NULL != ch->owner)
2153 "CHN origin %s ready %s local-id: %u\n",
2154 GSC_2s (ch->owner->c),
2155 ch->owner->client_ready ? "YES" : "NO",
2156 ntohl (ch->owner->ccn.channel_of_client));
2158 if (NULL != ch->dest)
2161 "CHN destination %s ready %s local-id: %u\n",
2162 GSC_2s (ch->dest->c),
2163 ch->dest->client_ready ? "YES" : "NO",
2164 ntohl (ch->dest->ccn.channel_of_client));
2167 "CHN Message IDs recv: %d (%LLX), send: %d\n",
2168 ntohl (ch->mid_recv.mid),
2169 (unsigned long long) ch->mid_futures,
2170 ntohl (ch->mid_send.mid));
2176 /* end of gnunet-service-cadet-new_channel.c */