2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 #include "gnunet_util_lib.h"
25 #include "gnunet_statistics_service.h"
28 #include "mesh_protocol.h"
30 #include "gnunet-service-mesh_channel.h"
31 #include "gnunet-service-mesh_local.h"
32 #include "gnunet-service-mesh_tunnel.h"
33 #include "gnunet-service-mesh_peer.h"
35 #define LOG(level, ...) GNUNET_log_from(level,"mesh-chn",__VA_ARGS__)
37 #define MESH_RETRANSMIT_TIME GNUNET_TIME_relative_multiply(\
38 GNUNET_TIME_UNIT_MILLISECONDS, 250)
39 #define MESH_RETRANSMIT_MARGIN 4
43 * All the states a connection can be in.
48 * Uninitialized status, should never appear in operation.
53 * Connection create message sent, waiting for ACK.
58 * Connection confirmed, ready to carry traffic.
65 * Info holder for channel messages in queues.
67 struct MeshChannelQueue
72 struct MeshTunnel3Queue *q;
75 * Message type (DATA/DATA_ACK)
80 * Message copy (for DATAs, to start retransmission timer)
82 struct MeshReliableMessage *copy;
85 * Reliability (for DATA_ACKs, to access rel->ack_q)
87 struct MeshChannelReliability *rel;
92 * Info needed to retry a message in case it gets lost.
94 struct MeshReliableMessage
97 * Double linked list, FIFO style
99 struct MeshReliableMessage *next;
100 struct MeshReliableMessage *prev;
103 * Type of message (payload, channel management).
108 * Tunnel Reliability queue this message is in.
110 struct MeshChannelReliability *rel;
113 * ID of the message (ACK needed to free)
120 struct MeshChannelQueue *q;
123 * When was this message issued (to calculate ACK delay)
125 struct GNUNET_TIME_Absolute timestamp;
127 /* struct GNUNET_MESH_Data with payload */
132 * Info about the traffic state for a client in a channel.
134 struct MeshChannelReliability
137 * Channel this is about.
139 struct MeshChannel *ch;
142 * DLL of messages sent and not yet ACK'd.
144 struct MeshReliableMessage *head_sent;
145 struct MeshReliableMessage *tail_sent;
148 * DLL of messages received out of order.
150 struct MeshReliableMessage *head_recv;
151 struct MeshReliableMessage *tail_recv;
159 * Next MID to use for outgoing traffic.
164 * Next MID expected for incoming traffic.
169 * Handle for queued unique data CREATE, DATA_ACK.
171 struct MeshChannelQueue *uniq;
174 * Can we send data to the client?
179 * Can the client send data to us?
184 * Task to resend/poll in case no ACK is received.
186 GNUNET_SCHEDULER_TaskIdentifier retry_task;
189 * Counter for exponential backoff.
191 struct GNUNET_TIME_Relative retry_timer;
194 * How long does it usually take to get an ACK.
196 struct GNUNET_TIME_Relative expected_delay;
201 * Struct containing all information regarding a channel to a remote client.
206 * Tunnel this channel is in.
208 struct MeshTunnel3 *t;
211 * Destination port of the channel.
216 * Global channel number ( < GNUNET_MESH_LOCAL_CHANNEL_ID_CLI)
218 MESH_ChannelNumber gid;
221 * Local tunnel number for root (owner) client.
222 * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_CLI or 0 )
224 MESH_ChannelNumber lid_root;
227 * Local tunnel number for local destination clients (incoming number)
228 * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV or 0).
230 MESH_ChannelNumber lid_dest;
235 enum MeshChannelState state;
238 * Is the tunnel bufferless (minimum latency)?
243 * Is the tunnel reliable?
248 * Last time the channel was used
250 struct GNUNET_TIME_Absolute timestamp;
253 * Client owner of the tunnel, if any
255 struct MeshClient *root;
258 * Client destination of the tunnel, if any.
260 struct MeshClient *dest;
263 * Flag to signal the destruction of the channel.
264 * If this is set GNUNET_YES the channel will be destroyed
265 * when the queue is empty.
270 * Total (reliable) messages pending ACK for this channel.
272 unsigned int pending_messages;
276 * Only present (non-NULL) at the owner of a tunnel.
278 struct MeshChannelReliability *root_rel;
282 * Only present (non-NULL) at the destination of a tunnel.
284 struct MeshChannelReliability *dest_rel;
289 /******************************************************************************/
290 /******************************* GLOBALS ***********************************/
291 /******************************************************************************/
294 * Global handle to the statistics service.
296 extern struct GNUNET_STATISTICS_Handle *stats;
299 * Local peer own ID (memory efficient handle).
301 extern GNUNET_PEER_Id myid;
304 /******************************************************************************/
305 /******************************** STATIC ***********************************/
306 /******************************************************************************/
309 * Destroy a reliable message after it has been acknowledged, either by
310 * direct mid ACK or bitfield. Updates the appropriate data structures and
311 * timers and frees all memory.
313 * @param copy Message that is no longer needed: remote peer got it.
314 * @param update_time Is the timing information relevant?
315 * If this message is ACK in a batch the timing information
316 * is skewed by the retransmission, count only for the
317 * retransmitted message.
320 rel_message_free (struct MeshReliableMessage *copy, int update_time);
323 * send a channel create message.
325 * @param ch Channel for which to send.
328 send_create (struct MeshChannel *ch);
331 * Confirm we got a channel create, FWD ack.
333 * @param ch The channel to confirm.
334 * @param fwd Should we send a FWD ACK? (going dest->root)
337 send_ack (struct MeshChannel *ch, int fwd);
342 * Test if the channel is loopback: both root and dest are on the local peer.
344 * @param ch Channel to test.
346 * @return #GNUNET_YES if channel is loopback, #GNUNET_NO otherwise.
349 is_loopback (const struct MeshChannel *ch)
352 return GMT_is_loopback (ch->t);
354 return (NULL != ch->root && NULL != ch->dest);
359 * We have received a message out of order, or the client is not ready.
360 * Buffer it until we receive an ACK from the client or the missing
361 * message from the channel.
363 * @param msg Message to buffer (MUST be of type MESH_DATA).
364 * @param rel Reliability data to the corresponding direction.
367 add_buffered_data (const struct GNUNET_MESH_Data *msg,
368 struct MeshChannelReliability *rel)
370 struct MeshReliableMessage *copy;
371 struct MeshReliableMessage *prev;
375 size = ntohs (msg->header.size);
376 mid = ntohl (msg->mid);
378 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
380 copy = GNUNET_malloc (sizeof (*copy) + size);
383 copy->type = GNUNET_MESSAGE_TYPE_MESH_DATA;
384 memcpy (©[1], msg, size);
388 // FIXME do something better than O(n), although n < 64...
389 // FIXME start from the end (most messages are the latest ones)
390 for (prev = rel->head_recv; NULL != prev; prev = prev->next)
392 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
393 if (GM_is_pid_bigger (prev->mid, mid))
395 LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
396 GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
401 LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
402 GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
403 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
408 * Add a destination client to a channel, initializing all data structures
409 * in the channel and the client.
411 * @param ch Channel to which add the destination.
412 * @param c Client which to add to the channel.
415 add_destination (struct MeshChannel *ch, struct MeshClient *c)
417 if (NULL != ch->dest)
423 /* Assign local id as destination */
424 ch->lid_dest = GML_get_next_chid (c);
426 /* Store in client's hashmap */
427 GML_channel_add (c, ch->lid_dest, ch);
429 GNUNET_break (NULL == ch->dest_rel);
430 ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
431 ch->dest_rel->ch = ch;
432 ch->dest_rel->expected_delay.rel_value_us = 0;
433 ch->dest_rel->retry_timer = MESH_RETRANSMIT_TIME;
440 * Set options in a channel, extracted from a bit flag field.
442 * @param ch Channel to set options to.
443 * @param options Bit array in host byte order.
446 channel_set_options (struct MeshChannel *ch, uint32_t options)
448 ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
449 GNUNET_YES : GNUNET_NO;
450 ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
451 GNUNET_YES : GNUNET_NO;
456 * Get a bit flag field with the options of a channel.
458 * @param ch Channel to get options from.
460 * @return Bit array in host byte order.
463 channel_get_options (struct MeshChannel *ch)
469 options |= GNUNET_MESH_OPTION_NOBUFFER;
471 options |= GNUNET_MESH_OPTION_RELIABLE;
478 * Notify the destination client that a new incoming channel was created.
480 * @param ch Channel that was created.
483 send_client_create (struct MeshChannel *ch)
487 if (NULL == ch->dest)
491 opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
492 opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
493 GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
494 GMT_get_destination (ch->t));
500 * Send data to a client.
502 * If the client is ready, send directly, otherwise buffer while listening
506 * @param msg Message.
507 * @param fwd Is this a fwd (root->dest) message?
510 send_client_data (struct MeshChannel *ch,
511 const struct GNUNET_MESH_Data *msg,
516 if (ch->dest_rel->client_ready)
517 GML_send_data (ch->dest, msg, ch->lid_dest);
519 add_buffered_data (msg, ch->dest_rel);
523 if (ch->root_rel->client_ready)
524 GML_send_data (ch->root, msg, ch->lid_root);
526 add_buffered_data (msg, ch->root_rel);
532 * Send a buffered message to the client, for in order delivery or
533 * as result of client ACK.
535 * @param ch Channel on which to empty the message buffer.
536 * @param c Client to send to.
537 * @param fwd Is this to send FWD data?.
540 send_client_buffered_data (struct MeshChannel *ch,
541 struct MeshClient *c,
544 struct MeshReliableMessage *copy;
545 struct MeshChannelReliability *rel;
547 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
548 rel = fwd ? ch->dest_rel : ch->root_rel;
549 if (GNUNET_NO == rel->client_ready)
551 LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
555 copy = rel->head_recv;
556 /* We never buffer channel management messages */
559 if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
561 struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) ©[1];
563 LOG (GNUNET_ERROR_TYPE_DEBUG,
564 " have %u! now expecting %u\n",
565 copy->mid, rel->mid_recv + 1);
566 send_client_data (ch, msg, fwd);
569 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
570 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE RECV %p\n", copy);
575 LOG (GNUNET_ERROR_TYPE_DEBUG,
576 " reliable && don't have %u, next is %u\n",
582 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
587 * Allow a client to send more data.
589 * In case the client was already allowed to send data, do nothing.
592 * @param fwd Is this a FWD ACK? (FWD ACKs are sent to root)
595 send_client_ack (struct MeshChannel *ch, int fwd)
597 struct MeshChannelReliability *rel = fwd ? ch->root_rel : ch->dest_rel;
598 struct MeshClient *c = fwd ? ch->root : ch->dest;
602 GNUNET_break (GNUNET_NO != ch->destroy);
605 LOG (GNUNET_ERROR_TYPE_DEBUG,
606 " sending %s ack to client on channel %s\n",
607 GM_f2s (fwd), GMCH_2s (ch));
615 if (GNUNET_YES == rel->client_allowed)
617 LOG (GNUNET_ERROR_TYPE_DEBUG, " already allowed\n");
620 rel->client_allowed = GNUNET_YES;
622 GML_send_ack (c, fwd ? ch->lid_root : ch->lid_dest);
627 * Notify the root that the destination rejected the channel.
629 * @param ch Rejected channel.
632 send_client_nack (struct MeshChannel *ch)
634 if (NULL == ch->root)
639 GML_send_nack (ch->root, ch->lid_root);
644 * We haven't received an ACK after a certain time: restransmit the message.
646 * @param cls Closure (MeshChannelReliability with the message to restransmit)
647 * @param tc TaskContext.
650 channel_retransmit_message (void *cls,
651 const struct GNUNET_SCHEDULER_TaskContext *tc)
653 struct MeshChannelReliability *rel = cls;
654 struct MeshReliableMessage *copy;
655 struct MeshChannel *ch;
656 struct GNUNET_MESH_Data *payload;
659 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
660 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
664 copy = rel->head_sent;
671 payload = (struct GNUNET_MESH_Data *) ©[1];
672 fwd = (rel == ch->root_rel);
674 /* Message not found in the queue that we are going to use. */
675 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
677 GMCH_send_prebuilt_message (&payload->header, ch, fwd, copy);
678 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
683 * We haven't received an Channel ACK after a certain time: resend the CREATE.
685 * @param cls Closure (MeshChannelReliability of the channel to recreate)
686 * @param tc TaskContext.
689 channel_recreate (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
691 struct MeshChannelReliability *rel = cls;
693 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
694 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
697 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RE-CREATE\n");
698 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
700 if (rel == rel->ch->root_rel)
702 send_create (rel->ch);
704 else if (rel == rel->ch->dest_rel)
706 send_ack (rel->ch, GNUNET_YES);
717 * Message has been sent: start retransmission timer.
719 * @param cls Closure (queue structure).
721 * @param q Queue handler (no longer valid).
722 * @param type Type of message.
723 * @param size Size of the message.
726 ch_message_sent (void *cls,
727 struct MeshTunnel3 *t,
728 struct MeshTunnel3Queue *q,
729 uint16_t type, size_t size)
731 struct MeshChannelQueue *ch_q = cls;
732 struct MeshReliableMessage *copy = ch_q->copy;
733 struct MeshChannelReliability *rel;
737 case GNUNET_MESSAGE_TYPE_MESH_DATA:
738 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT DATA MID %u\n", copy->mid);
739 GNUNET_assert (ch_q == copy->q);
740 copy->timestamp = GNUNET_TIME_absolute_get ();
742 if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
744 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! scheduling retry in %s\n",
745 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
747 if (0 != rel->expected_delay.rel_value_us)
749 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay != 0\n");
751 GNUNET_TIME_relative_multiply (rel->expected_delay,
752 MESH_RETRANSMIT_MARGIN);
756 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay reset\n");
757 rel->retry_timer = MESH_RETRANSMIT_TIME;
759 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! using delay %s\n",
760 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
763 GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
764 &channel_retransmit_message, rel);
768 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! retry task %u\n", rel->retry_task);
774 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
775 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
776 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
777 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT %s\n", GM_m2s (ch_q->type));
779 GNUNET_assert (rel->uniq == ch_q);
782 if (MESH_CHANNEL_READY != rel->ch->state
783 && GNUNET_MESSAGE_TYPE_MESH_DATA_ACK != type)
785 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rel->retry_task);
786 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! STD BACKOFF %s\n",
787 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
789 rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
790 rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
791 &channel_recreate, rel);
805 * send a channel create message.
807 * @param ch Channel for which to send.
810 send_create (struct MeshChannel *ch)
812 struct GNUNET_MESH_ChannelCreate msgcc;
814 msgcc.header.size = htons (sizeof (msgcc));
815 msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE);
816 msgcc.chid = htonl (ch->gid);
817 msgcc.port = htonl (ch->port);
818 msgcc.opt = htonl (channel_get_options (ch));
820 GMCH_send_prebuilt_message (&msgcc.header, ch, GNUNET_YES, NULL);
825 * Confirm we got a channel create or FWD ack.
827 * @param ch The channel to confirm.
828 * @param fwd Should we send a FWD ACK? (going dest->root)
831 send_ack (struct MeshChannel *ch, int fwd)
833 struct GNUNET_MESH_ChannelManage msg;
835 msg.header.size = htons (sizeof (msg));
836 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
837 LOG (GNUNET_ERROR_TYPE_DEBUG,
838 " sending channel %s ack for channel %s\n",
839 GM_f2s (fwd), GMCH_2s (ch));
841 msg.chid = htonl (ch->gid);
842 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
847 * Send a message and don't keep any info about it: we won't need to cancel it
850 * @param msg Header of the message to fire away.
851 * @param ch Channel on which the message should go.
852 * @param force Is this a forced (undroppable) message?
855 fire_and_forget (const struct GNUNET_MessageHeader *msg,
856 struct MeshChannel *ch,
859 GNUNET_break (NULL == GMT_send_prebuilt_message (msg, ch->t, force,
865 * Notify that a channel create didn't succeed.
867 * @param ch The channel to reject.
870 send_nack (struct MeshChannel *ch)
872 struct GNUNET_MESH_ChannelManage msg;
874 msg.header.size = htons (sizeof (msg));
875 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK);
876 LOG (GNUNET_ERROR_TYPE_DEBUG,
877 " sending channel NACK for channel %s\n",
880 msg.chid = htonl (ch->gid);
881 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
886 * Notify a client that the channel is no longer valid.
888 * @param ch Channel that is destroyed.
889 * @param local_only Should we avoid sending it to other peers?
892 send_destroy (struct MeshChannel *ch, int local_only)
894 struct GNUNET_MESH_ChannelManage msg;
896 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
897 msg.header.size = htons (sizeof (msg));
898 msg.chid = htonl (ch->gid);
900 /* If root is not NULL, notify.
901 * If it's NULL, check lid_root. When a local destroy comes in, root
902 * is set to NULL but lid_root is left untouched. In this case, do nothing,
903 * the client is the one who reuqested the channel to be destroyed.
905 if (NULL != ch->root)
906 GML_send_channel_destroy (ch->root, ch->lid_root);
907 else if (0 == ch->lid_root && GNUNET_NO == local_only)
908 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
910 if (NULL != ch->dest)
911 GML_send_channel_destroy (ch->dest, ch->lid_dest);
912 else if (0 == ch->lid_dest && GNUNET_NO == local_only)
913 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_YES, NULL);
918 * Destroy all reliable messages queued for a channel,
919 * during a channel destruction.
920 * Frees the reliability structure itself.
922 * @param rel Reliability data for a channel.
925 channel_rel_free_all (struct MeshChannelReliability *rel)
927 struct MeshReliableMessage *copy;
928 struct MeshReliableMessage *next;
933 for (copy = rel->head_recv; NULL != copy; copy = next)
936 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
937 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH RECV %p\n", copy);
938 GNUNET_break (NULL == copy->q);
941 for (copy = rel->head_sent; NULL != copy; copy = next)
944 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
945 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH %p\n", copy);
948 if (NULL != copy->q->q)
950 GMT_cancel (copy->q->q);
951 /* ch_message_sent will free copy->q */
955 GNUNET_free (copy->q);
961 if (NULL != rel->uniq && NULL != rel->uniq->q)
963 GMT_cancel (rel->uniq->q);
964 /* ch_message_sent is called freeing uniq */
966 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
968 GNUNET_SCHEDULER_cancel (rel->retry_task);
969 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
976 * Mark future messages as ACK'd.
978 * @param rel Reliability data.
979 * @param msg DataACK message with a bitfield of future ACK'd messages.
982 channel_rel_free_sent (struct MeshChannelReliability *rel,
983 const struct GNUNET_MESH_DataACK *msg)
985 struct MeshReliableMessage *copy;
986 struct MeshReliableMessage *next;
993 bitfield = msg->futures;
994 mid = ntohl (msg->mid);
995 LOG (GNUNET_ERROR_TYPE_DEBUG,
996 "!!! free_sent_reliable %u %llX\n",
998 LOG (GNUNET_ERROR_TYPE_DEBUG,
999 " rel %p, head %p\n",
1000 rel, rel->head_sent);
1001 for (i = 0, copy = rel->head_sent;
1002 i < 64 && NULL != copy && 0 != bitfield;
1005 LOG (GNUNET_ERROR_TYPE_DEBUG,
1006 " trying bit %u (mid %u)\n",
1009 if (0 == (bitfield & mask))
1012 LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
1013 /* Bit was set, clear the bit from the bitfield */
1016 /* The i-th bit was set. Do we have that copy? */
1017 /* Skip copies with mid < target */
1018 target = mid + i + 1;
1019 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
1020 while (NULL != copy && GM_is_pid_bigger (target, copy->mid))
1023 /* Did we run out of copies? (previously freed, it's ok) */
1026 LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
1030 /* Did we overshoot the target? (previously freed, it's ok) */
1031 if (GM_is_pid_bigger (copy->mid, target))
1033 LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
1037 /* Now copy->mid == target, free it */
1039 GNUNET_break (GNUNET_YES != rel_message_free (copy, GNUNET_YES));
1042 LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
1047 * Destroy a reliable message after it has been acknowledged, either by
1048 * direct mid ACK or bitfield. Updates the appropriate data structures and
1049 * timers and frees all memory.
1051 * @param copy Message that is no longer needed: remote peer got it.
1052 * @param update_time Is the timing information relevant?
1053 * If this message is ACK in a batch the timing information
1054 * is skewed by the retransmission, count only for the
1055 * retransmitted message.
1057 * @return #GNUNET_YES if channel was destroyed as a result of the call,
1058 * #GNUNET_NO otherwise.
1061 rel_message_free (struct MeshReliableMessage *copy, int update_time)
1063 struct MeshChannelReliability *rel;
1064 struct GNUNET_TIME_Relative time;
1067 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
1070 time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
1071 if (0 == rel->expected_delay.rel_value_us)
1072 rel->expected_delay = time;
1075 rel->expected_delay.rel_value_us *= 7;
1076 rel->expected_delay.rel_value_us += time.rel_value_us;
1077 rel->expected_delay.rel_value_us /= 8;
1079 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! took %s\n",
1080 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
1081 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! new expected delay %s\n",
1082 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
1084 rel->retry_timer = rel->expected_delay;
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! batch free, ignoring timing\n");
1090 rel->ch->pending_messages--;
1091 if (NULL != copy->q)
1093 GMT_cancel (copy->q->q);
1094 /* copy->q is set to NULL by ch_message_sent */
1096 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
1097 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE %p\n", copy);
1100 if (GNUNET_NO != rel->ch->destroy && 0 == rel->ch->pending_messages)
1102 struct MeshTunnel3 *t = rel->ch->t;
1103 GMCH_destroy (rel->ch);
1104 GMT_destroy_if_empty (t);
1112 * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
1114 * @param ch Channel to mark as ready.
1115 * @param fwd Was the ACK message a FWD ACK? (dest->root, SYNACK)
1118 channel_confirm (struct MeshChannel *ch, int fwd)
1120 struct MeshChannelReliability *rel;
1121 enum MeshChannelState oldstate;
1123 rel = fwd ? ch->root_rel : ch->dest_rel;
1126 GNUNET_break (GNUNET_NO != ch->destroy);
1129 LOG (GNUNET_ERROR_TYPE_DEBUG,
1130 " channel confirm %s %s\n",
1131 GM_f2s (fwd), GMCH_2s (ch));
1132 oldstate = ch->state;
1133 ch->state = MESH_CHANNEL_READY;
1135 rel->client_ready = GNUNET_YES;
1136 LOG (GNUNET_ERROR_TYPE_DEBUG,
1137 " !! retry timer confirm %s\n",
1138 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer, GNUNET_NO));
1139 rel->expected_delay = rel->retry_timer;
1140 if (GMT_get_connections_buffer (ch->t) > 0 || GMT_is_loopback (ch->t))
1141 send_client_ack (ch, fwd);
1143 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1145 GNUNET_SCHEDULER_cancel (rel->retry_task);
1146 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1148 else if (NULL != rel->uniq)
1150 GMT_cancel (rel->uniq->q);
1151 /* ch_message_sent will free and NULL uniq */
1155 if (GNUNET_NO == is_loopback (ch))
1157 /* We SHOULD have been trying to retransmit this! */
1158 GNUNET_break (oldstate == MESH_CHANNEL_READY);
1162 /* In case of a FWD ACK (SYNACK) send a BCK ACK (ACK). */
1163 if (GNUNET_YES == fwd)
1164 send_ack (ch, GNUNET_NO);
1169 * Save a copy to retransmit in case it gets lost.
1171 * Initializes all needed callbacks and timers.
1173 * @param ch Channel this message goes on.
1174 * @param msg Message to copy.
1175 * @param fwd Is this fwd traffic?
1177 static struct MeshReliableMessage *
1178 channel_save_copy (struct MeshChannel *ch,
1179 const struct GNUNET_MessageHeader *msg,
1182 struct MeshChannelReliability *rel;
1183 struct MeshReliableMessage *copy;
1188 rel = fwd ? ch->root_rel : ch->dest_rel;
1189 mid = rel->mid_send - 1;
1190 type = ntohs (msg->type);
1191 size = ntohs (msg->size);
1193 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u %s\n", mid, GM_m2s (type));
1194 copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
1195 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", copy);
1199 memcpy (©[1], msg, size);
1200 GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
1201 ch->pending_messages++;
1208 * Create a new channel.
1210 * @param t Tunnel this channel is in.
1211 * @param owner Client that owns the channel, NULL for foreign channels.
1212 * @param lid_root Local ID for root client.
1214 * @return A new initialized channel. NULL on error.
1216 static struct MeshChannel *
1217 channel_new (struct MeshTunnel3 *t,
1218 struct MeshClient *owner,
1219 MESH_ChannelNumber lid_root)
1221 struct MeshChannel *ch;
1223 ch = GNUNET_new (struct MeshChannel);
1225 ch->lid_root = lid_root;
1228 GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
1232 ch->gid = GMT_get_next_chid (t);
1233 GML_channel_add (owner, lid_root, ch);
1235 GMT_add_channel (t, ch);
1242 * Handle a loopback message: call the appropriate handler for the message type.
1244 * @param ch Channel this message is on.
1245 * @param msgh Message header.
1246 * @param fwd Is this FWD traffic?
1249 handle_loopback (struct MeshChannel *ch,
1250 const struct GNUNET_MessageHeader *msgh,
1255 type = ntohs (msgh->type);
1256 LOG (GNUNET_ERROR_TYPE_DEBUG,
1257 "Loopback %s %s message!\n",
1258 GM_f2s (fwd), GM_m2s (type));
1262 case GNUNET_MESSAGE_TYPE_MESH_DATA:
1263 /* Don't send hop ACK, wait for client to ACK */
1264 GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
1267 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1268 GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1271 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1272 GMCH_handle_create (ch->t,
1273 (struct GNUNET_MESH_ChannelCreate *) msgh);
1276 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1277 GMCH_handle_ack (ch,
1278 (struct GNUNET_MESH_ChannelManage *) msgh,
1282 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1283 GMCH_handle_nack (ch);
1286 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1287 GMCH_handle_destroy (ch,
1288 (struct GNUNET_MESH_ChannelManage *) msgh,
1293 GNUNET_break_op (0);
1294 LOG (GNUNET_ERROR_TYPE_DEBUG,
1295 "end-to-end message not known (%u)\n",
1296 ntohs (msgh->type));
1302 /******************************************************************************/
1303 /******************************** API ***********************************/
1304 /******************************************************************************/
1307 * Destroy a channel and free all resources.
1309 * @param ch Channel to destroy.
1312 GMCH_destroy (struct MeshChannel *ch)
1314 struct MeshClient *c;
1318 if (2 == ch->destroy)
1319 return; /* recursive call */
1322 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
1323 GMT_2s (ch->t), ch->gid);
1329 GML_channel_remove (c, ch->lid_root, ch);
1335 GML_channel_remove (c, ch->lid_dest, ch);
1338 channel_rel_free_all (ch->root_rel);
1339 channel_rel_free_all (ch->dest_rel);
1341 GMT_remove_channel (ch->t, ch);
1342 GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
1351 * @param ch Channel.
1356 GMCH_get_id (const struct MeshChannel *ch)
1363 * Get the channel tunnel.
1365 * @param ch Channel to get the tunnel from.
1367 * @return tunnel of the channel.
1369 struct MeshTunnel3 *
1370 GMCH_get_tunnel (const struct MeshChannel *ch)
1377 * Get free buffer space towards the client on a specific channel.
1379 * @param ch Channel.
1380 * @param fwd Is query about FWD traffic?
1382 * @return Free buffer space [0 - 64]
1385 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1387 struct MeshChannelReliability *rel;
1389 rel = fwd ? ch->dest_rel : ch->root_rel;
1391 /* If rel is NULL it means that the end is not yet created,
1392 * most probably is a loopback channel at the point of sending
1393 * the ChannelCreate to itself.
1398 return (64 - rel->n_recv);
1403 * Get flow control status of end point: is client allow to send?
1405 * @param ch Channel.
1406 * @param fwd Is query about FWD traffic? (Request root status).
1408 * @return #GNUNET_YES if client is allowed to send us data.
1411 GMCH_get_allowed (struct MeshChannel *ch, int fwd)
1413 struct MeshChannelReliability *rel;
1415 rel = fwd ? ch->root_rel : ch->dest_rel;
1419 /* Probably shutting down: root/dest NULL'ed to mark disconnection */
1420 GNUNET_break (GNUNET_NO != ch->destroy);
1424 return rel->client_allowed;
1429 * Is the root client for this channel on this peer?
1431 * @param ch Channel.
1432 * @param fwd Is this for fwd traffic?
1434 * @return #GNUNET_YES in case it is.
1437 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1439 struct MeshClient *c;
1441 c = fwd ? ch->root : ch->dest;
1447 * Is the destination client for this channel on this peer?
1449 * @param ch Channel.
1450 * @param fwd Is this for fwd traffic?
1452 * @return #GNUNET_YES in case it is.
1455 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1457 struct MeshClient *c;
1459 c = fwd ? ch->dest : ch->root;
1465 * Send an end-to-end ACK message for the most recent in-sequence payload.
1467 * If channel is not reliable, do nothing.
1469 * @param ch Channel this is about.
1470 * @param fwd Is for FWD traffic? (ACK dest->owner)
1473 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1475 struct GNUNET_MESH_DataACK msg;
1476 struct MeshChannelReliability *rel;
1477 struct MeshReliableMessage *copy;
1482 if (GNUNET_NO == ch->reliable)
1486 rel = fwd ? ch->dest_rel : ch->root_rel;
1487 ack = rel->mid_recv - 1;
1488 LOG (GNUNET_ERROR_TYPE_DEBUG,
1489 " !! Send DATA_ACK for %u\n",
1492 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA_ACK);
1493 msg.header.size = htons (sizeof (msg));
1494 msg.chid = htonl (ch->gid);
1496 for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1498 if (copy->type != GNUNET_MESSAGE_TYPE_MESH_DATA)
1500 LOG (GNUNET_ERROR_TYPE_DEBUG,
1501 "!! Type %s, expected DATA\n",
1502 GM_m2s (copy->type));
1505 if (copy->mid == ack + 1)
1510 delta = copy->mid - (ack + 1);
1513 mask = 0x1LL << delta;
1514 msg.futures |= mask;
1515 LOG (GNUNET_ERROR_TYPE_DEBUG,
1516 " !! setting bit for %u (delta %u) (%llX) -> %llX\n",
1517 copy->mid, delta, mask, msg.futures);
1519 msg.mid = htonl (ack);
1520 LOG (GNUNET_ERROR_TYPE_DEBUG,
1521 "!!! ACK for %u, futures %llX\n",
1524 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
1525 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1530 * Allow a client to send us more data, in case it was choked.
1532 * @param ch Channel.
1533 * @param fwd Is this about FWD traffic? (Root client).
1536 GMCH_allow_client (struct MeshChannel *ch, int fwd)
1538 struct MeshChannelReliability *rel;
1539 unsigned int buffer;
1541 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH allow\n");
1543 if (MESH_CHANNEL_READY != ch->state)
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, " channel not ready yet!\n");
1549 if (GNUNET_YES == ch->reliable)
1551 rel = fwd ? ch->root_rel : ch->dest_rel;
1554 GNUNET_break (GNUNET_NO != ch->destroy);
1557 if (NULL != rel->head_sent)
1559 if (64 <= rel->mid_send - rel->head_sent->mid)
1561 LOG (GNUNET_ERROR_TYPE_DEBUG, " too big MID gap! Wait for ACK.\n");
1565 LOG (GNUNET_ERROR_TYPE_DEBUG, " gap ok: %u - %u\n",
1566 rel->head_sent->mid, rel->mid_send);
1570 LOG (GNUNET_ERROR_TYPE_DEBUG, " head sent is NULL\n");
1574 if (is_loopback (ch))
1575 buffer = GMCH_get_buffer (ch, fwd);
1577 buffer = GMT_get_connections_buffer (ch->t);
1581 LOG (GNUNET_ERROR_TYPE_DEBUG, " no buffer space.\n");
1585 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space %u, allowing\n", buffer);
1586 send_client_ack (ch, fwd);
1593 * @param ch Channel.
1596 GMCH_debug (struct MeshChannel *ch)
1600 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1603 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1604 GMT_2s (ch->t), ch->gid, ch);
1605 LOG (GNUNET_ERROR_TYPE_DEBUG, " root %p/%p\n",
1606 ch->root, ch->root_rel);
1607 if (NULL != ch->root)
1609 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->root));
1610 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1611 ch->root_rel->client_ready ? "YES" : "NO");
1612 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_root);
1614 LOG (GNUNET_ERROR_TYPE_DEBUG, " dest %p/%p\n",
1615 ch->dest, ch->dest_rel);
1616 if (NULL != ch->dest)
1618 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->dest));
1619 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1620 ch->dest_rel->client_ready ? "YES" : "NO");
1621 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_dest);
1627 * Handle an ACK given by a client.
1629 * Mark client as ready and send him any buffered data we could have for him.
1631 * @param ch Channel.
1632 * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by dest and go BCK)
1635 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1637 struct MeshChannelReliability *rel;
1638 struct MeshClient *c;
1640 rel = fwd ? ch->dest_rel : ch->root_rel;
1641 c = fwd ? ch->dest : ch->root;
1643 rel->client_ready = GNUNET_YES;
1644 send_client_buffered_data (ch, c, fwd);
1645 if (is_loopback (ch))
1647 unsigned int buffer;
1649 buffer = GMCH_get_buffer (ch, fwd);
1651 GMCH_allow_client (ch, fwd);
1655 GMT_send_connection_acks (ch->t);
1660 * Handle data given by a client.
1662 * Check whether the client is allowed to send in this tunnel, save if channel
1663 * is reliable and send an ACK to the client if there is still buffer space
1666 * @param ch Channel.
1667 * @param c Client which sent the data.
1668 * @param message Message.
1669 * @param fwd Is this a FWD data?
1671 * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1674 GMCH_handle_local_data (struct MeshChannel *ch,
1675 struct MeshClient *c,
1676 struct GNUNET_MessageHeader *message,
1679 struct MeshChannelReliability *rel;
1680 struct GNUNET_MESH_Data *payload;
1681 size_t size = ntohs (message->size);
1682 uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1683 unsigned char cbuf[p2p_size];
1685 /* Is the client in the channel? */
1692 GNUNET_break_op (0);
1693 return GNUNET_SYSERR;
1696 rel = fwd ? ch->root_rel : ch->dest_rel;
1698 if (GNUNET_NO == rel->client_allowed)
1700 GNUNET_break_op (0);
1701 return GNUNET_SYSERR;
1704 rel->client_allowed = GNUNET_NO;
1706 /* Ok, everything is correct, send the message. */
1707 payload = (struct GNUNET_MESH_Data *) cbuf;
1708 payload->mid = htonl (rel->mid_send);
1710 memcpy (&payload[1], message, size);
1711 payload->header.size = htons (p2p_size);
1712 payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1713 payload->chid = htonl (ch->gid);
1714 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channel...\n");
1715 GMCH_send_prebuilt_message (&payload->header, ch, fwd, NULL);
1717 if (is_loopback (ch))
1719 if (GMCH_get_buffer (ch, fwd) > 0)
1720 GMCH_allow_client (ch, fwd);
1725 if (GMT_get_connections_buffer (ch->t) > 0)
1727 GMCH_allow_client (ch, fwd);
1735 * Handle a channel destroy requested by a client.
1737 * Destroy the channel and the tunnel in case this was the last channel.
1739 * @param ch Channel.
1740 * @param c Client that requested the destruction (to avoid notifying him).
1741 * @param is_root Is the request coming from root?
1744 GMCH_handle_local_destroy (struct MeshChannel *ch,
1745 struct MeshClient *c,
1748 struct MeshTunnel3 *t;
1750 ch->destroy = GNUNET_YES;
1751 /* Cleanup after the tunnel */
1752 if (GNUNET_NO == is_root && c == ch->dest)
1754 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1755 GML_client_delete_channel (c, ch, ch->lid_dest);
1758 if (GNUNET_YES == is_root && c == ch->root)
1760 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1761 GML_client_delete_channel (c, ch, ch->lid_root);
1766 send_destroy (ch, GNUNET_NO);
1767 if (0 == ch->pending_messages)
1770 GMT_destroy_if_empty (t);
1776 * Handle a channel create requested by a client.
1778 * Create the channel and the tunnel in case this was the first0 channel.
1780 * @param c Client that requested the creation (will be the root).
1781 * @param msg Create Channel message.
1783 * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1786 GMCH_handle_local_create (struct MeshClient *c,
1787 struct GNUNET_MESH_ChannelMessage *msg)
1789 struct MeshChannel *ch;
1790 struct MeshTunnel3 *t;
1791 struct MeshPeer *peer;
1792 MESH_ChannelNumber chid;
1794 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s:%u\n",
1795 GNUNET_i2s (&msg->peer), ntohl (msg->port));
1796 chid = ntohl (msg->channel_id);
1798 /* Sanity check for duplicate channel IDs */
1799 if (NULL != GML_channel_get (c, chid))
1802 return GNUNET_SYSERR;
1805 peer = GMP_get (&msg->peer);
1806 GMP_add_tunnel (peer);
1807 t = GMP_get_tunnel (peer);
1809 if (GMP_get_short_id (peer) == myid)
1811 GMT_change_cstate (t, MESH_TUNNEL3_READY);
1815 /* FIXME change to a tunnel API, eliminate ch <-> peer connection */
1819 /* Create channel */
1820 ch = channel_new (t, c, chid);
1824 return GNUNET_SYSERR;
1826 ch->port = ntohl (msg->port);
1827 channel_set_options (ch, ntohl (msg->opt));
1829 /* In unreliable channels, we'll use the DLL to buffer BCK data */
1830 ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1831 ch->root_rel->ch = ch;
1832 ch->root_rel->retry_timer = MESH_RETRANSMIT_TIME;
1833 ch->root_rel->expected_delay.rel_value_us = 0;
1835 LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1844 * Handler for mesh network payload traffic.
1846 * @param ch Channel for the message.
1847 * @param msg Unencryted data message.
1848 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1849 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1850 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1851 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1854 GMCH_handle_data (struct MeshChannel *ch,
1855 const struct GNUNET_MESH_Data *msg,
1858 struct MeshChannelReliability *rel;
1859 struct MeshClient *c;
1862 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1863 if (GNUNET_SYSERR == fwd)
1865 if (is_loopback (ch))
1867 /* It is a loopback channel after all... */
1871 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
1874 /* Initialize FWD/BCK data */
1875 c = fwd ? ch->dest : ch->root;
1876 rel = fwd ? ch->dest_rel : ch->root_rel;
1884 if (MESH_CHANNEL_READY != ch->state)
1886 if (GNUNET_NO == fwd)
1888 /* If we are the root, this means the other peer has sent traffic before
1889 * receiving our ACK. Even if the SYNACK goes missing, no traffic should
1890 * be sent before the ACK.
1892 GNUNET_break_op (0);
1895 /* If we are the dest, this means that the SYNACK got to the root but
1896 * the ACK went missing. Treat this as an ACK.
1898 channel_confirm (ch, GNUNET_NO);
1901 GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1903 mid = ntohl (msg->mid);
1904 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! got mid %u\n", mid);
1906 if (GNUNET_NO == ch->reliable ||
1907 ( !GM_is_pid_bigger (rel->mid_recv, mid) &&
1908 GM_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1910 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1911 if (GNUNET_YES == ch->reliable)
1913 /* Is this the exact next expected messasge? */
1914 if (mid == rel->mid_recv)
1916 LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1918 send_client_data (ch, msg, fwd);
1922 LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1923 add_buffered_data (msg, rel);
1928 /* Tunnel is unreliable: send to clients directly */
1929 /* FIXME: accept Out Of Order traffic */
1930 rel->mid_recv = mid + 1;
1931 send_client_data (ch, msg, fwd);
1936 GNUNET_break_op (GM_is_pid_bigger (rel->mid_recv, mid));
1937 LOG (GNUNET_ERROR_TYPE_DEBUG,
1938 " !!! MID %u not expected (%u - %u), dropping!\n",
1939 mid, rel->mid_recv, rel->mid_recv + 63);
1942 GMCH_send_data_ack (ch, fwd);
1947 * Handler for mesh network traffic end-to-end ACKs.
1949 * @param ch Channel on which we got this message.
1950 * @param msg Data message.
1951 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1952 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1953 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1954 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1957 GMCH_handle_data_ack (struct MeshChannel *ch,
1958 const struct GNUNET_MESH_DataACK *msg,
1961 struct MeshChannelReliability *rel;
1962 struct MeshReliableMessage *copy;
1963 struct MeshReliableMessage *next;
1967 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1968 if (GNUNET_SYSERR == fwd)
1970 if (is_loopback (ch))
1972 /* It is a loopback channel after all... */
1976 /* Inverted: if message came 'FWD' is a 'BCK ACK'. */
1977 fwd = (NULL != ch->dest) ? GNUNET_NO : GNUNET_YES;
1980 ack = ntohl (msg->mid);
1981 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1982 (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1984 if (GNUNET_YES == fwd)
1994 GNUNET_break_op (0);
1998 /* Free ACK'd copies: no need to retransmit those anymore */
1999 for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
2001 if (GM_is_pid_bigger (copy->mid, ack))
2003 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! head %u, out!\n", copy->mid);
2004 channel_rel_free_sent (rel, msg);
2008 LOG (GNUNET_ERROR_TYPE_DEBUG, " !! id %u\n", copy->mid);
2010 if (GNUNET_YES == rel_message_free (copy, GNUNET_YES))
2014 /* ACK client if needed */
2015 GMCH_allow_client (ch, fwd);
2017 /* If some message was free'd, update the retransmission delay */
2018 if (GNUNET_YES == work)
2020 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
2022 GNUNET_SCHEDULER_cancel (rel->retry_task);
2023 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
2024 if (NULL != rel->head_sent && NULL == rel->head_sent->q)
2026 struct GNUNET_TIME_Absolute new_target;
2027 struct GNUNET_TIME_Relative delay;
2029 delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
2030 MESH_RETRANSMIT_MARGIN);
2031 new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
2033 delay = GNUNET_TIME_absolute_get_remaining (new_target);
2035 GNUNET_SCHEDULER_add_delayed (delay,
2036 &channel_retransmit_message,
2040 else /* work was done but no task was pending? shouldn't happen! */
2049 * Handler for channel create messages.
2051 * Does not have fwd parameter because it's always 'FWD': channel is incoming.
2053 * @param t Tunnel this channel will be in.
2054 * @param msg Channel crate message.
2056 struct MeshChannel *
2057 GMCH_handle_create (struct MeshTunnel3 *t,
2058 const struct GNUNET_MESH_ChannelCreate *msg)
2060 MESH_ChannelNumber chid;
2061 struct MeshChannel *ch;
2062 struct MeshClient *c;
2065 chid = ntohl (msg->chid);
2066 ch = GMT_get_channel (t, chid);
2069 /* Create channel */
2070 ch = channel_new (t, NULL, 0);
2072 channel_set_options (ch, ntohl (msg->opt));
2073 new_channel = GNUNET_YES;
2077 new_channel = GNUNET_NO;
2080 if (GNUNET_YES == new_channel || GMT_is_loopback (t))
2082 /* Find a destination client */
2083 ch->port = ntohl (msg->port);
2084 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n", ch->port);
2085 c = GML_client_get_by_port (ch->port);
2088 LOG (GNUNET_ERROR_TYPE_DEBUG, " no client has port registered\n");
2089 if (is_loopback (ch))
2091 LOG (GNUNET_ERROR_TYPE_DEBUG, " loopback: destroy on handler\n");
2096 LOG (GNUNET_ERROR_TYPE_DEBUG, " not loopback: destroy now\n");
2104 LOG (GNUNET_ERROR_TYPE_DEBUG, " client %p has port registered\n", c);
2107 add_destination (ch, c);
2108 if (GNUNET_YES == ch->reliable)
2109 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
2111 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Not Reliable\n");
2113 send_client_create (ch);
2114 ch->state = MESH_CHANNEL_SENT;
2118 LOG (GNUNET_ERROR_TYPE_DEBUG, " duplicate create channel\n");
2120 send_ack (ch, GNUNET_YES);
2127 * Handler for channel NACK messages.
2129 * NACK messages always go dest -> root, no need for 'fwd' or 'msg' parameter.
2131 * @param ch Channel.
2134 GMCH_handle_nack (struct MeshChannel *ch)
2136 send_client_nack (ch);
2142 * Handler for channel ack messages.
2144 * @param ch Channel.
2145 * @param msg Message.
2146 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2147 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2148 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2149 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2152 GMCH_handle_ack (struct MeshChannel *ch,
2153 const struct GNUNET_MESH_ChannelManage *msg,
2156 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2157 if (GNUNET_SYSERR == fwd)
2159 if (is_loopback (ch))
2161 /* It is a loopback channel after all... */
2165 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2168 channel_confirm (ch, !fwd);
2173 * Handler for channel destroy messages.
2175 * @param ch Channel to be destroyed of.
2176 * @param msg Message.
2177 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2178 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2179 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2180 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2183 GMCH_handle_destroy (struct MeshChannel *ch,
2184 const struct GNUNET_MESH_ChannelManage *msg,
2187 struct MeshTunnel3 *t;
2189 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2190 if (GNUNET_SYSERR == fwd)
2192 if (is_loopback (ch))
2194 /* It is a loopback channel after all... */
2198 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2202 if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
2204 /* Not for us (don't destroy twice a half-open loopback channel) */
2209 send_destroy (ch, GNUNET_YES);
2211 GMT_destroy_if_empty (t);
2216 * Sends an already built message on a channel.
2218 * If the channel is on a loopback tunnel, notifies the appropriate destination
2221 * On a normal channel passes the message to the tunnel for encryption and
2222 * sending on a connection.
2224 * This function DOES NOT save the message for retransmission.
2226 * @param message Message to send. Function makes a copy of it.
2227 * @param ch Channel on which this message is transmitted.
2228 * @param fwd Is this a fwd message?
2229 * @param existing_copy This is a retransmission, don't save a copy.
2232 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2233 struct MeshChannel *ch, int fwd,
2234 void *existing_copy)
2236 struct MeshChannelQueue *q;
2239 type = ntohs (message->type);
2240 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH Send %s %s on channel %s\n",
2241 GM_f2s (fwd), GM_m2s (type),
2244 if (GMT_is_loopback (ch->t))
2246 handle_loopback (ch, message, fwd);
2252 case GNUNET_MESSAGE_TYPE_MESH_DATA:
2254 if (GNUNET_YES == ch->reliable)
2256 q = GNUNET_new (struct MeshChannelQueue);
2258 if (NULL == existing_copy)
2259 q->copy = channel_save_copy (ch, message, fwd);
2262 q->copy = (struct MeshReliableMessage *) existing_copy;
2263 if (NULL != q->copy->q)
2265 /* Last retransmission was queued but not yet sent!
2266 * This retransmission was scheduled by a ch_message_sent which
2267 * followed a very fast RTT, so the tiny delay made the
2268 * retransmission function to execute before the previous
2269 * retransmitted message even had a chance to leave the peer.
2270 * Cancel this message and wait until the pending
2271 * retransmission leaves the peer and ch_message_sent starts
2272 * the timer for the next one.
2275 LOG (GNUNET_ERROR_TYPE_DEBUG,
2276 " exisitng copy not yet transmitted!\n");
2279 LOG (GNUNET_ERROR_TYPE_DEBUG,
2280 " using existing copy: %p {r:%p q:%p t:%u}\n",
2282 q->copy->rel, q->copy->q, q->copy->type);
2284 LOG (GNUNET_ERROR_TYPE_DEBUG, " new q: %p\n", q);
2286 q->q = GMT_send_prebuilt_message (message, ch->t,
2287 NULL != existing_copy,
2288 &ch_message_sent, q);
2289 /* q itself is stored in copy */
2290 GNUNET_assert (NULL != q->q || GNUNET_NO != ch->destroy);
2294 fire_and_forget (message, ch, GNUNET_NO);
2299 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
2300 if (GNUNET_YES == fwd)
2302 /* BCK ACK (going FWD) is just a response for a SYNACK, don't keep*/
2303 fire_and_forget (message, ch, GNUNET_YES);
2307 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
2308 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
2309 q = GNUNET_new (struct MeshChannelQueue);
2311 q->rel = fwd ? ch->root_rel : ch->dest_rel;
2312 if (NULL != q->rel->uniq)
2314 if (NULL != q->rel->uniq->q)
2316 GMT_cancel (q->rel->uniq->q);
2317 /* ch_message_sent is called, freeing and NULLing uniq */
2321 GNUNET_free (q->rel->uniq);
2324 q->q = GMT_send_prebuilt_message (message, ch->t, GNUNET_YES,
2325 &ch_message_sent, q);
2330 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
2331 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
2332 fire_and_forget (message, ch, GNUNET_YES);
2338 LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s unknown!\n", GM_m2s (type));
2339 fire_and_forget (message, ch, GNUNET_YES);
2345 * Get the static string for identification of the channel.
2347 * @param ch Channel.
2349 * @return Static string with the channel IDs.
2352 GMCH_2s (const struct MeshChannel *ch)
2354 static char buf[64];
2357 return "(NULL Channel)";
2359 sprintf (buf, "%s:%u gid:%X (%X / %X)",
2360 GMT_2s (ch->t), ch->port, ch->gid, ch->lid_root, ch->lid_dest);