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 *tq;
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 *chq;
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)
335 * @param reaction This ACK is a reaction to a duplicate CREATE, don't save.
338 send_ack (struct MeshChannel *ch, int fwd, int reaction);
343 * Test if the channel is loopback: both root and dest are on the local peer.
345 * @param ch Channel to test.
347 * @return #GNUNET_YES if channel is loopback, #GNUNET_NO otherwise.
350 is_loopback (const struct MeshChannel *ch)
353 return GMT_is_loopback (ch->t);
355 return (NULL != ch->root && NULL != ch->dest);
360 * We have received a message out of order, or the client is not ready.
361 * Buffer it until we receive an ACK from the client or the missing
362 * message from the channel.
364 * @param msg Message to buffer (MUST be of type MESH_DATA).
365 * @param rel Reliability data to the corresponding direction.
368 add_buffered_data (const struct GNUNET_MESH_Data *msg,
369 struct MeshChannelReliability *rel)
371 struct MeshReliableMessage *copy;
372 struct MeshReliableMessage *prev;
376 size = ntohs (msg->header.size);
377 mid = ntohl (msg->mid);
379 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
381 copy = GNUNET_malloc (sizeof (*copy) + size);
384 copy->type = GNUNET_MESSAGE_TYPE_MESH_DATA;
385 memcpy (©[1], msg, size);
389 // FIXME do something better than O(n), although n < 64...
390 // FIXME start from the end (most messages are the latest ones)
391 for (prev = rel->head_recv; NULL != prev; prev = prev->next)
393 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
394 if (GM_is_pid_bigger (prev->mid, mid))
396 LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
397 GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
402 LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
403 GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
404 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
409 * Add a destination client to a channel, initializing all data structures
410 * in the channel and the client.
412 * @param ch Channel to which add the destination.
413 * @param c Client which to add to the channel.
416 add_destination (struct MeshChannel *ch, struct MeshClient *c)
418 if (NULL != ch->dest)
424 /* Assign local id as destination */
425 ch->lid_dest = GML_get_next_chid (c);
427 /* Store in client's hashmap */
428 GML_channel_add (c, ch->lid_dest, ch);
430 GNUNET_break (NULL == ch->dest_rel);
431 ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
432 ch->dest_rel->ch = ch;
433 ch->dest_rel->expected_delay.rel_value_us = 0;
434 ch->dest_rel->retry_timer = MESH_RETRANSMIT_TIME;
441 * Set options in a channel, extracted from a bit flag field.
443 * @param ch Channel to set options to.
444 * @param options Bit array in host byte order.
447 channel_set_options (struct MeshChannel *ch, uint32_t options)
449 ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
450 GNUNET_YES : GNUNET_NO;
451 ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
452 GNUNET_YES : GNUNET_NO;
457 * Get a bit flag field with the options of a channel.
459 * @param ch Channel to get options from.
461 * @return Bit array in host byte order.
464 channel_get_options (struct MeshChannel *ch)
470 options |= GNUNET_MESH_OPTION_NOBUFFER;
472 options |= GNUNET_MESH_OPTION_RELIABLE;
479 * Notify the destination client that a new incoming channel was created.
481 * @param ch Channel that was created.
484 send_client_create (struct MeshChannel *ch)
488 if (NULL == ch->dest)
492 opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
493 opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
494 GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
495 GMT_get_destination (ch->t));
501 * Send data to a client.
503 * If the client is ready, send directly, otherwise buffer while listening
507 * @param msg Message.
508 * @param fwd Is this a fwd (root->dest) message?
511 send_client_data (struct MeshChannel *ch,
512 const struct GNUNET_MESH_Data *msg,
517 if (ch->dest_rel->client_ready)
518 GML_send_data (ch->dest, msg, ch->lid_dest);
520 add_buffered_data (msg, ch->dest_rel);
524 if (ch->root_rel->client_ready)
525 GML_send_data (ch->root, msg, ch->lid_root);
527 add_buffered_data (msg, ch->root_rel);
533 * Send a buffered message to the client, for in order delivery or
534 * as result of client ACK.
536 * @param ch Channel on which to empty the message buffer.
537 * @param c Client to send to.
538 * @param fwd Is this to send FWD data?.
541 send_client_buffered_data (struct MeshChannel *ch,
542 struct MeshClient *c,
545 struct MeshReliableMessage *copy;
546 struct MeshChannelReliability *rel;
548 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
549 rel = fwd ? ch->dest_rel : ch->root_rel;
550 if (GNUNET_NO == rel->client_ready)
552 LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
556 copy = rel->head_recv;
557 /* We never buffer channel management messages */
560 if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
562 struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) ©[1];
564 LOG (GNUNET_ERROR_TYPE_DEBUG,
565 " have %u! now expecting %u\n",
566 copy->mid, rel->mid_recv + 1);
567 send_client_data (ch, msg, fwd);
570 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
571 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE RECV %p\n", copy);
576 LOG (GNUNET_ERROR_TYPE_DEBUG,
577 " reliable && don't have %u, next is %u\n",
583 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
588 * Allow a client to send more data.
590 * In case the client was already allowed to send data, do nothing.
593 * @param fwd Is this a FWD ACK? (FWD ACKs are sent to root)
596 send_client_ack (struct MeshChannel *ch, int fwd)
598 struct MeshChannelReliability *rel = fwd ? ch->root_rel : ch->dest_rel;
599 struct MeshClient *c = fwd ? ch->root : ch->dest;
603 GNUNET_break (GNUNET_NO != ch->destroy);
606 LOG (GNUNET_ERROR_TYPE_DEBUG,
607 " sending %s ack to client on channel %s\n",
608 GM_f2s (fwd), GMCH_2s (ch));
616 if (GNUNET_YES == rel->client_allowed)
618 LOG (GNUNET_ERROR_TYPE_DEBUG, " already allowed\n");
621 rel->client_allowed = GNUNET_YES;
623 GML_send_ack (c, fwd ? ch->lid_root : ch->lid_dest);
628 * Notify the root that the destination rejected the channel.
630 * @param ch Rejected channel.
633 send_client_nack (struct MeshChannel *ch)
635 if (NULL == ch->root)
640 GML_send_channel_nack (ch->root, ch->lid_root);
645 * We haven't received an ACK after a certain time: restransmit the message.
647 * @param cls Closure (MeshChannelReliability with the message to restransmit)
648 * @param tc TaskContext.
651 channel_retransmit_message (void *cls,
652 const struct GNUNET_SCHEDULER_TaskContext *tc)
654 struct MeshChannelReliability *rel = cls;
655 struct MeshReliableMessage *copy;
656 struct MeshChannel *ch;
657 struct GNUNET_MESH_Data *payload;
660 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
661 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
665 copy = rel->head_sent;
672 payload = (struct GNUNET_MESH_Data *) ©[1];
673 fwd = (rel == ch->root_rel);
675 /* Message not found in the queue that we are going to use. */
676 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
678 GMCH_send_prebuilt_message (&payload->header, ch, fwd, copy);
679 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
684 * We haven't received an Channel ACK after a certain time: resend the CREATE.
686 * @param cls Closure (MeshChannelReliability of the channel to recreate)
687 * @param tc TaskContext.
690 channel_recreate (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
692 struct MeshChannelReliability *rel = cls;
694 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
695 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
698 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RE-CREATE\n");
699 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
701 if (rel == rel->ch->root_rel)
703 send_create (rel->ch);
705 else if (rel == rel->ch->dest_rel)
707 send_ack (rel->ch, GNUNET_YES, GNUNET_NO);
718 * Message has been sent: start retransmission timer.
720 * @param cls Closure (queue structure).
722 * @param q Queue handler (no longer valid).
723 * @param type Type of message.
724 * @param size Size of the message.
727 ch_message_sent (void *cls,
728 struct MeshTunnel3 *t,
729 struct MeshTunnel3Queue *q,
730 uint16_t type, size_t size)
732 struct MeshChannelQueue *chq = cls;
733 struct MeshReliableMessage *copy = chq->copy;
734 struct MeshChannelReliability *rel;
736 LOG (GNUNET_ERROR_TYPE_DEBUG, "channel message sent callback %s\n",
741 case GNUNET_MESSAGE_TYPE_MESH_DATA:
742 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT DATA MID %u\n", copy->mid);
743 GNUNET_assert (chq == copy->chq);
744 copy->timestamp = GNUNET_TIME_absolute_get ();
746 if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
748 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! scheduling retry in 4 * %s\n",
749 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
751 if (0 != rel->expected_delay.rel_value_us)
753 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay != 0\n");
755 GNUNET_TIME_relative_multiply (rel->expected_delay,
756 MESH_RETRANSMIT_MARGIN);
760 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay reset\n");
761 rel->retry_timer = MESH_RETRANSMIT_TIME;
763 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! using delay %s\n",
764 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
767 GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
768 &channel_retransmit_message, rel);
772 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! retry task %u\n", rel->retry_task);
778 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
779 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
780 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
781 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT %s\n", GM_m2s (chq->type));
783 GNUNET_assert (rel->uniq == chq);
786 if (MESH_CHANNEL_READY != rel->ch->state
787 && GNUNET_MESSAGE_TYPE_MESH_DATA_ACK != type
788 && GNUNET_NO == rel->ch->destroy)
790 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rel->retry_task);
791 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! STD BACKOFF %s\n",
792 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
794 rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
795 rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
796 &channel_recreate, rel);
810 * send a channel create message.
812 * @param ch Channel for which to send.
815 send_create (struct MeshChannel *ch)
817 struct GNUNET_MESH_ChannelCreate msgcc;
819 msgcc.header.size = htons (sizeof (msgcc));
820 msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE);
821 msgcc.chid = htonl (ch->gid);
822 msgcc.port = htonl (ch->port);
823 msgcc.opt = htonl (channel_get_options (ch));
825 GMCH_send_prebuilt_message (&msgcc.header, ch, GNUNET_YES, NULL);
830 * Confirm we got a channel create or FWD ack.
832 * @param ch The channel to confirm.
833 * @param fwd Should we send a FWD ACK? (going dest->root)
834 * @param reaction This ACK is a reaction to a duplicate CREATE, don't save.
837 send_ack (struct MeshChannel *ch, int fwd, int reaction)
839 struct GNUNET_MESH_ChannelManage msg;
841 msg.header.size = htons (sizeof (msg));
842 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
843 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending channel %s ack for channel %s\n",
844 GM_f2s (fwd), GMCH_2s (ch));
846 msg.chid = htonl (ch->gid);
847 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, reaction ? &msg : NULL);
852 * Send a message and don't keep any info about it: we won't need to cancel it
855 * @param msg Header of the message to fire away.
856 * @param ch Channel on which the message should go.
857 * @param force Is this a forced (undroppable) message?
860 fire_and_forget (const struct GNUNET_MessageHeader *msg,
861 struct MeshChannel *ch,
864 GNUNET_break (NULL == GMT_send_prebuilt_message (msg, ch->t, NULL,
870 * Notify that a channel create didn't succeed.
872 * @param ch The channel to reject.
875 send_nack (struct MeshChannel *ch)
877 struct GNUNET_MESH_ChannelManage msg;
879 msg.header.size = htons (sizeof (msg));
880 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK);
881 LOG (GNUNET_ERROR_TYPE_DEBUG,
882 " sending channel NACK for channel %s\n",
885 msg.chid = htonl (ch->gid);
886 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
891 * Notify a client that the channel is no longer valid.
893 * @param ch Channel that is destroyed.
894 * @param local_only Should we avoid sending it to other peers?
897 send_destroy (struct MeshChannel *ch, int local_only)
899 struct GNUNET_MESH_ChannelManage msg;
901 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
902 msg.header.size = htons (sizeof (msg));
903 msg.chid = htonl (ch->gid);
905 /* If root is not NULL, notify.
906 * If it's NULL, check lid_root. When a local destroy comes in, root
907 * is set to NULL but lid_root is left untouched. In this case, do nothing,
908 * the client is the one who reuqested the channel to be destroyed.
910 if (NULL != ch->root)
911 GML_send_channel_destroy (ch->root, ch->lid_root);
912 else if (0 == ch->lid_root && GNUNET_NO == local_only)
913 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
915 if (NULL != ch->dest)
916 GML_send_channel_destroy (ch->dest, ch->lid_dest);
917 else if (0 == ch->lid_dest && GNUNET_NO == local_only)
918 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_YES, NULL);
923 * Destroy all reliable messages queued for a channel,
924 * during a channel destruction.
925 * Frees the reliability structure itself.
927 * @param rel Reliability data for a channel.
930 channel_rel_free_all (struct MeshChannelReliability *rel)
932 struct MeshReliableMessage *copy;
933 struct MeshReliableMessage *next;
938 for (copy = rel->head_recv; NULL != copy; copy = next)
941 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
942 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH RECV %p\n", copy);
943 GNUNET_break (NULL == copy->chq);
946 for (copy = rel->head_sent; NULL != copy; copy = next)
949 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
950 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH %p\n", copy);
951 if (NULL != copy->chq)
953 if (NULL != copy->chq->tq)
955 GMT_cancel (copy->chq->tq);
956 /* ch_message_sent will free copy->q */
960 GNUNET_free (copy->chq);
966 if (NULL != rel->uniq && NULL != rel->uniq->tq)
968 GMT_cancel (rel->uniq->tq);
969 /* ch_message_sent is called freeing uniq */
971 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
973 GNUNET_SCHEDULER_cancel (rel->retry_task);
974 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
981 * Mark future messages as ACK'd.
983 * @param rel Reliability data.
984 * @param msg DataACK message with a bitfield of future ACK'd messages.
987 channel_rel_free_sent (struct MeshChannelReliability *rel,
988 const struct GNUNET_MESH_DataACK *msg)
990 struct MeshReliableMessage *copy;
991 struct MeshReliableMessage *next;
998 bitfield = msg->futures;
999 mid = ntohl (msg->mid);
1000 LOG (GNUNET_ERROR_TYPE_DEBUG,
1001 "!!! free_sent_reliable %u %llX\n",
1003 LOG (GNUNET_ERROR_TYPE_DEBUG,
1004 " rel %p, head %p\n",
1005 rel, rel->head_sent);
1006 for (i = 0, copy = rel->head_sent;
1007 i < 64 && NULL != copy && 0 != bitfield;
1010 LOG (GNUNET_ERROR_TYPE_DEBUG,
1011 " trying bit %u (mid %u)\n",
1014 if (0 == (bitfield & mask))
1017 LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
1018 /* Bit was set, clear the bit from the bitfield */
1021 /* The i-th bit was set. Do we have that copy? */
1022 /* Skip copies with mid < target */
1023 target = mid + i + 1;
1024 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
1025 while (NULL != copy && GM_is_pid_bigger (target, copy->mid))
1028 /* Did we run out of copies? (previously freed, it's ok) */
1031 LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
1035 /* Did we overshoot the target? (previously freed, it's ok) */
1036 if (GM_is_pid_bigger (copy->mid, target))
1038 LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
1042 /* Now copy->mid == target, free it */
1044 GNUNET_break (GNUNET_YES != rel_message_free (copy, GNUNET_YES));
1047 LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
1052 * Destroy a reliable message after it has been acknowledged, either by
1053 * direct mid ACK or bitfield. Updates the appropriate data structures and
1054 * timers and frees all memory.
1056 * @param copy Message that is no longer needed: remote peer got it.
1057 * @param update_time Is the timing information relevant?
1058 * If this message is ACK in a batch the timing information
1059 * is skewed by the retransmission, count only for the
1060 * retransmitted message.
1062 * @return #GNUNET_YES if channel was destroyed as a result of the call,
1063 * #GNUNET_NO otherwise.
1066 rel_message_free (struct MeshReliableMessage *copy, int update_time)
1068 struct MeshChannelReliability *rel;
1069 struct GNUNET_TIME_Relative time;
1072 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
1075 time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
1076 if (0 == rel->expected_delay.rel_value_us)
1077 rel->expected_delay = time;
1080 rel->expected_delay.rel_value_us *= 7;
1081 rel->expected_delay.rel_value_us += time.rel_value_us;
1082 rel->expected_delay.rel_value_us /= 8;
1084 LOG (GNUNET_ERROR_TYPE_INFO, "!!! took %s, new delay %s\n",
1085 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO),
1086 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
1088 rel->retry_timer = rel->expected_delay;
1092 LOG (GNUNET_ERROR_TYPE_INFO, "!!! batch free, ignoring timing\n");
1094 rel->ch->pending_messages--;
1095 if (NULL != copy->chq)
1097 GMT_cancel (copy->chq->tq);
1098 /* copy->q is set to NULL by ch_message_sent */
1100 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
1101 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE %p\n", copy);
1104 if (GNUNET_NO != rel->ch->destroy && 0 == rel->ch->pending_messages)
1106 struct MeshTunnel3 *t = rel->ch->t;
1107 GMCH_destroy (rel->ch);
1108 GMT_destroy_if_empty (t);
1116 * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
1118 * @param ch Channel to mark as ready.
1119 * @param fwd Was the ACK message a FWD ACK? (dest->root, SYNACK)
1122 channel_confirm (struct MeshChannel *ch, int fwd)
1124 struct MeshChannelReliability *rel;
1125 enum MeshChannelState oldstate;
1127 rel = fwd ? ch->root_rel : ch->dest_rel;
1130 GNUNET_break (GNUNET_NO != ch->destroy);
1133 LOG (GNUNET_ERROR_TYPE_DEBUG, " channel confirm %s %s\n",
1134 GM_f2s (fwd), GMCH_2s (ch));
1135 oldstate = ch->state;
1136 ch->state = MESH_CHANNEL_READY;
1138 if (MESH_CHANNEL_READY != oldstate || GNUNET_YES == is_loopback (ch))
1140 rel->client_ready = GNUNET_YES;
1141 rel->expected_delay = rel->retry_timer;
1142 LOG (GNUNET_ERROR_TYPE_DEBUG, " !! retry timer confirm %s\n",
1143 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer, GNUNET_NO));
1144 if (GMT_get_connections_buffer (ch->t) > 0 || GMT_is_loopback (ch->t))
1145 send_client_ack (ch, fwd);
1147 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1149 GNUNET_SCHEDULER_cancel (rel->retry_task);
1150 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1152 else if (NULL != rel->uniq)
1154 GMT_cancel (rel->uniq->tq);
1155 /* ch_message_sent will free and NULL uniq */
1159 if (GNUNET_NO == is_loopback (ch))
1161 /* We SHOULD have been trying to retransmit this! */
1167 /* In case of a FWD ACK (SYNACK) send a BCK ACK (ACK). */
1168 if (GNUNET_YES == fwd)
1169 send_ack (ch, GNUNET_NO, GNUNET_NO);
1174 * Save a copy to retransmit in case it gets lost.
1176 * Initializes all needed callbacks and timers.
1178 * @param ch Channel this message goes on.
1179 * @param msg Message to copy.
1180 * @param fwd Is this fwd traffic?
1182 static struct MeshReliableMessage *
1183 channel_save_copy (struct MeshChannel *ch,
1184 const struct GNUNET_MessageHeader *msg,
1187 struct MeshChannelReliability *rel;
1188 struct MeshReliableMessage *copy;
1193 rel = fwd ? ch->root_rel : ch->dest_rel;
1194 mid = rel->mid_send - 1;
1195 type = ntohs (msg->type);
1196 size = ntohs (msg->size);
1198 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u %s\n", mid, GM_m2s (type));
1199 copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
1200 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", copy);
1204 memcpy (©[1], msg, size);
1205 GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
1206 ch->pending_messages++;
1213 * Create a new channel.
1215 * @param t Tunnel this channel is in.
1216 * @param owner Client that owns the channel, NULL for foreign channels.
1217 * @param lid_root Local ID for root client.
1219 * @return A new initialized channel. NULL on error.
1221 static struct MeshChannel *
1222 channel_new (struct MeshTunnel3 *t,
1223 struct MeshClient *owner,
1224 MESH_ChannelNumber lid_root)
1226 struct MeshChannel *ch;
1228 ch = GNUNET_new (struct MeshChannel);
1230 ch->lid_root = lid_root;
1233 GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
1237 ch->gid = GMT_get_next_chid (t);
1238 GML_channel_add (owner, lid_root, ch);
1240 GMT_add_channel (t, ch);
1247 * Handle a loopback message: call the appropriate handler for the message type.
1249 * @param ch Channel this message is on.
1250 * @param msgh Message header.
1251 * @param fwd Is this FWD traffic?
1254 handle_loopback (struct MeshChannel *ch,
1255 const struct GNUNET_MessageHeader *msgh,
1260 type = ntohs (msgh->type);
1261 LOG (GNUNET_ERROR_TYPE_DEBUG,
1262 "Loopback %s %s message!\n",
1263 GM_f2s (fwd), GM_m2s (type));
1267 case GNUNET_MESSAGE_TYPE_MESH_DATA:
1268 /* Don't send hop ACK, wait for client to ACK */
1269 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SEND loopback %u (%u)\n",
1270 ntohl (((struct GNUNET_MESH_Data *) msgh)->mid), ntohs (msgh->size));
1271 GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
1274 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1275 GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1278 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1279 GMCH_handle_create (ch->t,
1280 (struct GNUNET_MESH_ChannelCreate *) msgh);
1283 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1284 GMCH_handle_ack (ch,
1285 (struct GNUNET_MESH_ChannelManage *) msgh,
1289 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1290 GMCH_handle_nack (ch);
1293 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1294 GMCH_handle_destroy (ch,
1295 (struct GNUNET_MESH_ChannelManage *) msgh,
1300 GNUNET_break_op (0);
1301 LOG (GNUNET_ERROR_TYPE_DEBUG,
1302 "end-to-end message not known (%u)\n",
1303 ntohs (msgh->type));
1309 /******************************************************************************/
1310 /******************************** API ***********************************/
1311 /******************************************************************************/
1314 * Destroy a channel and free all resources.
1316 * @param ch Channel to destroy.
1319 GMCH_destroy (struct MeshChannel *ch)
1321 struct MeshClient *c;
1325 if (2 == ch->destroy)
1326 return; /* recursive call */
1329 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
1330 GMT_2s (ch->t), ch->gid);
1336 GML_channel_remove (c, ch->lid_root, ch);
1342 GML_channel_remove (c, ch->lid_dest, ch);
1345 channel_rel_free_all (ch->root_rel);
1346 channel_rel_free_all (ch->dest_rel);
1348 GMT_remove_channel (ch->t, ch);
1349 GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
1356 * Get the channel's public ID.
1358 * @param ch Channel.
1360 * @return ID used to identify the channel with the remote peer.
1363 GMCH_get_id (const struct MeshChannel *ch)
1370 * Get the channel tunnel.
1372 * @param ch Channel to get the tunnel from.
1374 * @return tunnel of the channel.
1376 struct MeshTunnel3 *
1377 GMCH_get_tunnel (const struct MeshChannel *ch)
1384 * Get free buffer space towards the client on a specific channel.
1386 * @param ch Channel.
1387 * @param fwd Is query about FWD traffic?
1389 * @return Free buffer space [0 - 64]
1392 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1394 struct MeshChannelReliability *rel;
1396 rel = fwd ? ch->dest_rel : ch->root_rel;
1398 /* If rel is NULL it means that the end is not yet created,
1399 * most probably is a loopback channel at the point of sending
1400 * the ChannelCreate to itself.
1405 return (64 - rel->n_recv);
1410 * Get flow control status of end point: is client allow to send?
1412 * @param ch Channel.
1413 * @param fwd Is query about FWD traffic? (Request root status).
1415 * @return #GNUNET_YES if client is allowed to send us data.
1418 GMCH_get_allowed (struct MeshChannel *ch, int fwd)
1420 struct MeshChannelReliability *rel;
1422 rel = fwd ? ch->root_rel : ch->dest_rel;
1426 /* Probably shutting down: root/dest NULL'ed to mark disconnection */
1427 GNUNET_break (GNUNET_NO != ch->destroy);
1431 return rel->client_allowed;
1436 * Is the root client for this channel on this peer?
1438 * @param ch Channel.
1439 * @param fwd Is this for fwd traffic?
1441 * @return #GNUNET_YES in case it is.
1444 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1446 struct MeshClient *c;
1448 c = fwd ? ch->root : ch->dest;
1454 * Is the destination client for this channel on this peer?
1456 * @param ch Channel.
1457 * @param fwd Is this for fwd traffic?
1459 * @return #GNUNET_YES in case it is.
1462 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1464 struct MeshClient *c;
1466 c = fwd ? ch->dest : ch->root;
1472 * Send an end-to-end ACK message for the most recent in-sequence payload.
1474 * If channel is not reliable, do nothing.
1476 * @param ch Channel this is about.
1477 * @param fwd Is for FWD traffic? (ACK dest->owner)
1480 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1482 struct GNUNET_MESH_DataACK msg;
1483 struct MeshChannelReliability *rel;
1484 struct MeshReliableMessage *copy;
1489 if (GNUNET_NO == ch->reliable)
1493 rel = fwd ? ch->dest_rel : ch->root_rel;
1494 ack = rel->mid_recv - 1;
1495 LOG (GNUNET_ERROR_TYPE_INFO, "=> DATA_ACK for %u\n", ack);
1497 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA_ACK);
1498 msg.header.size = htons (sizeof (msg));
1499 msg.chid = htonl (ch->gid);
1501 for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1503 if (copy->type != GNUNET_MESSAGE_TYPE_MESH_DATA)
1505 LOG (GNUNET_ERROR_TYPE_DEBUG,
1506 "!! Type %s, expected DATA\n",
1507 GM_m2s (copy->type));
1510 if (copy->mid == ack + 1)
1515 delta = copy->mid - (ack + 1);
1518 mask = 0x1LL << delta;
1519 msg.futures |= mask;
1520 LOG (GNUNET_ERROR_TYPE_DEBUG,
1521 " !! setting bit for %u (delta %u) (%llX) -> %llX\n",
1522 copy->mid, delta, mask, msg.futures);
1524 msg.mid = htonl (ack);
1525 LOG (GNUNET_ERROR_TYPE_DEBUG,
1526 "!!! ACK for %u, futures %llX\n",
1529 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
1530 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1535 * Allow a client to send us more data, in case it was choked.
1537 * @param ch Channel.
1538 * @param fwd Is this about FWD traffic? (Root client).
1541 GMCH_allow_client (struct MeshChannel *ch, int fwd)
1543 struct MeshChannelReliability *rel;
1544 unsigned int buffer;
1546 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH allow\n");
1548 if (MESH_CHANNEL_READY != ch->state)
1550 LOG (GNUNET_ERROR_TYPE_DEBUG, " channel not ready yet!\n");
1554 if (GNUNET_YES == ch->reliable)
1556 rel = fwd ? ch->root_rel : ch->dest_rel;
1559 GNUNET_break (GNUNET_NO != ch->destroy);
1562 if (NULL != rel->head_sent)
1564 if (64 <= rel->mid_send - rel->head_sent->mid)
1566 LOG (GNUNET_ERROR_TYPE_DEBUG, " too big MID gap! Wait for ACK.\n");
1570 LOG (GNUNET_ERROR_TYPE_DEBUG, " gap ok: %u - %u\n",
1571 rel->head_sent->mid, rel->mid_send);
1575 LOG (GNUNET_ERROR_TYPE_DEBUG, " head sent is NULL\n");
1579 if (is_loopback (ch))
1580 buffer = GMCH_get_buffer (ch, fwd);
1582 buffer = GMT_get_connections_buffer (ch->t);
1586 LOG (GNUNET_ERROR_TYPE_DEBUG, " no buffer space.\n");
1590 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space %u, allowing\n", buffer);
1591 send_client_ack (ch, fwd);
1598 * @param ch Channel.
1601 GMCH_debug (struct MeshChannel *ch)
1605 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1608 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1609 GMT_2s (ch->t), ch->gid, ch);
1610 LOG (GNUNET_ERROR_TYPE_DEBUG, " root %p/%p\n",
1611 ch->root, ch->root_rel);
1612 if (NULL != ch->root)
1614 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->root));
1615 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1616 ch->root_rel->client_ready ? "YES" : "NO");
1617 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_root);
1619 LOG (GNUNET_ERROR_TYPE_DEBUG, " dest %p/%p\n",
1620 ch->dest, ch->dest_rel);
1621 if (NULL != ch->dest)
1623 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->dest));
1624 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1625 ch->dest_rel->client_ready ? "YES" : "NO");
1626 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_dest);
1632 * Handle an ACK given by a client.
1634 * Mark client as ready and send him any buffered data we could have for him.
1636 * @param ch Channel.
1637 * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by dest and go BCK)
1640 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1642 struct MeshChannelReliability *rel;
1643 struct MeshClient *c;
1645 rel = fwd ? ch->dest_rel : ch->root_rel;
1646 c = fwd ? ch->dest : ch->root;
1648 rel->client_ready = GNUNET_YES;
1649 send_client_buffered_data (ch, c, fwd);
1650 if (is_loopback (ch))
1652 unsigned int buffer;
1654 buffer = GMCH_get_buffer (ch, fwd);
1656 GMCH_allow_client (ch, fwd);
1660 GMT_send_connection_acks (ch->t);
1665 * Handle data given by a client.
1667 * Check whether the client is allowed to send in this tunnel, save if channel
1668 * is reliable and send an ACK to the client if there is still buffer space
1671 * @param ch Channel.
1672 * @param c Client which sent the data.
1673 * @param message Message.
1674 * @param fwd Is this a FWD data?
1676 * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1679 GMCH_handle_local_data (struct MeshChannel *ch,
1680 struct MeshClient *c,
1681 struct GNUNET_MessageHeader *message,
1684 struct MeshChannelReliability *rel;
1685 struct GNUNET_MESH_Data *payload;
1686 size_t size = ntohs (message->size);
1687 uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1688 unsigned char cbuf[p2p_size];
1690 /* Is the client in the channel? */
1697 GNUNET_break_op (0);
1698 return GNUNET_SYSERR;
1701 rel = fwd ? ch->root_rel : ch->dest_rel;
1703 if (GNUNET_NO == rel->client_allowed)
1705 GNUNET_break_op (0);
1706 return GNUNET_SYSERR;
1709 rel->client_allowed = GNUNET_NO;
1711 /* Ok, everything is correct, send the message. */
1712 payload = (struct GNUNET_MESH_Data *) cbuf;
1713 payload->mid = htonl (rel->mid_send);
1715 memcpy (&payload[1], message, size);
1716 payload->header.size = htons (p2p_size);
1717 payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1718 payload->chid = htonl (ch->gid);
1719 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channel...\n");
1720 GMCH_send_prebuilt_message (&payload->header, ch, fwd, NULL);
1722 if (is_loopback (ch))
1724 if (GMCH_get_buffer (ch, fwd) > 0)
1725 GMCH_allow_client (ch, fwd);
1730 if (GMT_get_connections_buffer (ch->t) > 0)
1732 GMCH_allow_client (ch, fwd);
1740 * Handle a channel destroy requested by a client.
1742 * Destroy the channel and the tunnel in case this was the last channel.
1744 * @param ch Channel.
1745 * @param c Client that requested the destruction (to avoid notifying him).
1746 * @param is_root Is the request coming from root?
1749 GMCH_handle_local_destroy (struct MeshChannel *ch,
1750 struct MeshClient *c,
1753 struct MeshTunnel3 *t;
1755 ch->destroy = GNUNET_YES;
1756 /* Cleanup after the tunnel */
1757 if (GNUNET_NO == is_root && c == ch->dest)
1759 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1760 GML_client_delete_channel (c, ch, ch->lid_dest);
1763 if (GNUNET_YES == is_root && c == ch->root)
1765 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1766 GML_client_delete_channel (c, ch, ch->lid_root);
1771 send_destroy (ch, GNUNET_NO);
1772 if (0 == ch->pending_messages)
1775 GMT_destroy_if_empty (t);
1781 * Handle a channel create requested by a client.
1783 * Create the channel and the tunnel in case this was the first0 channel.
1785 * @param c Client that requested the creation (will be the root).
1786 * @param msg Create Channel message.
1788 * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1791 GMCH_handle_local_create (struct MeshClient *c,
1792 struct GNUNET_MESH_ChannelMessage *msg)
1794 struct MeshChannel *ch;
1795 struct MeshTunnel3 *t;
1796 struct MeshPeer *peer;
1797 MESH_ChannelNumber chid;
1799 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s:%u\n",
1800 GNUNET_i2s (&msg->peer), ntohl (msg->port));
1801 chid = ntohl (msg->channel_id);
1803 /* Sanity check for duplicate channel IDs */
1804 if (NULL != GML_channel_get (c, chid))
1807 return GNUNET_SYSERR;
1810 peer = GMP_get (&msg->peer);
1811 GMP_add_tunnel (peer);
1812 t = GMP_get_tunnel (peer);
1814 if (GMP_get_short_id (peer) == myid)
1816 GMT_change_cstate (t, MESH_TUNNEL3_READY);
1820 /* FIXME change to a tunnel API, eliminate ch <-> peer connection */
1824 /* Create channel */
1825 ch = channel_new (t, c, chid);
1829 return GNUNET_SYSERR;
1831 ch->port = ntohl (msg->port);
1832 channel_set_options (ch, ntohl (msg->opt));
1834 /* In unreliable channels, we'll use the DLL to buffer BCK data */
1835 ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1836 ch->root_rel->ch = ch;
1837 ch->root_rel->retry_timer = MESH_RETRANSMIT_TIME;
1838 ch->root_rel->expected_delay.rel_value_us = 0;
1840 LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1849 * Handler for mesh network payload traffic.
1851 * @param ch Channel for the message.
1852 * @param msg Unencryted data message.
1853 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1854 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1855 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1856 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1859 GMCH_handle_data (struct MeshChannel *ch,
1860 const struct GNUNET_MESH_Data *msg,
1863 struct MeshChannelReliability *rel;
1864 struct MeshClient *c;
1867 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1868 if (GNUNET_SYSERR == fwd)
1870 if (is_loopback (ch))
1872 /* It is a loopback channel after all... */
1876 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
1879 /* Initialize FWD/BCK data */
1880 c = fwd ? ch->dest : ch->root;
1881 rel = fwd ? ch->dest_rel : ch->root_rel;
1885 GNUNET_break (GNUNET_NO != ch->destroy);
1889 if (MESH_CHANNEL_READY != ch->state)
1891 if (GNUNET_NO == fwd)
1893 /* If we are the root, this means the other peer has sent traffic before
1894 * receiving our ACK. Even if the SYNACK goes missing, no traffic should
1895 * be sent before the ACK.
1897 GNUNET_break_op (0);
1900 /* If we are the dest, this means that the SYNACK got to the root but
1901 * the ACK went missing. Treat this as an ACK.
1903 channel_confirm (ch, GNUNET_NO);
1906 GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1908 mid = ntohl (msg->mid);
1909 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! got mid %u\n", mid);
1911 if (GNUNET_NO == ch->reliable ||
1912 ( !GM_is_pid_bigger (rel->mid_recv, mid) &&
1913 GM_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1915 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u (%u)\n",
1916 mid, ntohs (msg->header.size));
1917 if (GNUNET_YES == ch->reliable)
1919 /* Is this the exact next expected messasge? */
1920 if (mid == rel->mid_recv)
1922 LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1924 send_client_data (ch, msg, fwd);
1928 LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1929 add_buffered_data (msg, rel);
1934 /* Tunnel is unreliable: send to clients directly */
1935 /* FIXME: accept Out Of Order traffic */
1936 rel->mid_recv = mid + 1;
1937 send_client_data (ch, msg, fwd);
1942 GNUNET_break_op (GM_is_pid_bigger (rel->mid_recv, mid));
1943 LOG (GNUNET_ERROR_TYPE_WARNING,
1944 "MID %u not expected (%u - %u), dropping!\n",
1945 mid, rel->mid_recv, rel->mid_recv + 63);
1948 GMCH_send_data_ack (ch, fwd);
1953 * Handler for mesh network traffic end-to-end ACKs.
1955 * @param ch Channel on which we got this message.
1956 * @param msg Data message.
1957 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1958 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1959 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1960 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1963 GMCH_handle_data_ack (struct MeshChannel *ch,
1964 const struct GNUNET_MESH_DataACK *msg,
1967 struct MeshChannelReliability *rel;
1968 struct MeshReliableMessage *copy;
1969 struct MeshReliableMessage *next;
1973 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1974 if (GNUNET_SYSERR == fwd)
1976 if (is_loopback (ch))
1978 /* It is a loopback channel after all... */
1982 /* Inverted: if message came 'FWD' is a 'BCK ACK'. */
1983 fwd = (NULL != ch->dest) ? GNUNET_NO : GNUNET_YES;
1986 ack = ntohl (msg->mid);
1987 LOG (GNUNET_ERROR_TYPE_INFO, "<= %s ACK %u\n", GM_f2s (fwd), ack);
1989 if (GNUNET_YES == fwd)
1999 GNUNET_break_op (GNUNET_NO != ch->destroy);
2003 /* Free ACK'd copies: no need to retransmit those anymore FIXME refactor */
2004 for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
2006 if (GM_is_pid_bigger (copy->mid, ack))
2008 LOG (GNUNET_ERROR_TYPE_DEBUG, " head %u, out!\n", copy->mid);
2009 channel_rel_free_sent (rel, msg);
2013 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %u\n", copy->mid);
2015 if (GNUNET_YES == rel_message_free (copy, GNUNET_YES))
2019 /* ACK client if needed and possible */
2020 GMCH_allow_client (ch, fwd);
2022 /* If some message was free'd, update the retransmission delay */
2023 if (GNUNET_YES == work)
2025 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
2027 GNUNET_SCHEDULER_cancel (rel->retry_task);
2028 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
2029 if (NULL != rel->head_sent && NULL == rel->head_sent->chq)
2031 struct GNUNET_TIME_Absolute new_target;
2032 struct GNUNET_TIME_Relative delay;
2034 delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
2035 MESH_RETRANSMIT_MARGIN);
2036 new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
2038 delay = GNUNET_TIME_absolute_get_remaining (new_target);
2040 GNUNET_SCHEDULER_add_delayed (delay,
2041 &channel_retransmit_message,
2047 /* Work was done but no task was pending? Shouldn't happen! */
2055 * Handler for channel create messages.
2057 * Does not have fwd parameter because it's always 'FWD': channel is incoming.
2059 * @param t Tunnel this channel will be in.
2060 * @param msg Channel crate message.
2062 struct MeshChannel *
2063 GMCH_handle_create (struct MeshTunnel3 *t,
2064 const struct GNUNET_MESH_ChannelCreate *msg)
2066 MESH_ChannelNumber chid;
2067 struct MeshChannel *ch;
2068 struct MeshClient *c;
2072 reaction = GNUNET_NO;
2073 chid = ntohl (msg->chid);
2074 ch = GMT_get_channel (t, chid);
2077 /* Create channel */
2078 ch = channel_new (t, NULL, 0);
2080 channel_set_options (ch, ntohl (msg->opt));
2081 new_channel = GNUNET_YES;
2085 new_channel = GNUNET_NO;
2088 if (GNUNET_YES == new_channel || GMT_is_loopback (t))
2090 /* Find a destination client */
2091 ch->port = ntohl (msg->port);
2092 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n", ch->port);
2093 c = GML_client_get_by_port (ch->port);
2096 LOG (GNUNET_ERROR_TYPE_DEBUG, " no client has port registered\n");
2097 if (is_loopback (ch))
2099 LOG (GNUNET_ERROR_TYPE_DEBUG, " loopback: destroy on handler\n");
2104 LOG (GNUNET_ERROR_TYPE_DEBUG, " not loopback: destroy now\n");
2112 LOG (GNUNET_ERROR_TYPE_DEBUG, " client %p has port registered\n", c);
2115 add_destination (ch, c);
2116 if (GNUNET_YES == ch->reliable)
2117 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
2119 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Not Reliable\n");
2121 send_client_create (ch);
2122 ch->state = MESH_CHANNEL_SENT;
2126 LOG (GNUNET_ERROR_TYPE_DEBUG, " duplicate create channel\n");
2127 reaction = GNUNET_YES;
2128 if (GNUNET_SCHEDULER_NO_TASK != ch->dest_rel->retry_task)
2130 LOG (GNUNET_ERROR_TYPE_DEBUG, " clearing retry task\n");
2131 /* we were waiting to re-send our 'SYNACK', wait no more! */
2132 GNUNET_SCHEDULER_cancel (ch->dest_rel->retry_task);
2133 ch->dest_rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
2136 send_ack (ch, GNUNET_YES, reaction);
2143 * Handler for channel NACK messages.
2145 * NACK messages always go dest -> root, no need for 'fwd' or 'msg' parameter.
2147 * @param ch Channel.
2150 GMCH_handle_nack (struct MeshChannel *ch)
2152 send_client_nack (ch);
2158 * Handler for channel ack messages.
2160 * @param ch Channel.
2161 * @param msg Message.
2162 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2163 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2164 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2165 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2168 GMCH_handle_ack (struct MeshChannel *ch,
2169 const struct GNUNET_MESH_ChannelManage *msg,
2172 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2173 if (GNUNET_SYSERR == fwd)
2175 if (is_loopback (ch))
2177 /* It is a loopback channel after all... */
2181 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2184 channel_confirm (ch, !fwd);
2189 * Handler for channel destroy messages.
2191 * @param ch Channel to be destroyed of.
2192 * @param msg Message.
2193 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2194 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2195 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2196 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2199 GMCH_handle_destroy (struct MeshChannel *ch,
2200 const struct GNUNET_MESH_ChannelManage *msg,
2203 struct MeshTunnel3 *t;
2205 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2206 if (GNUNET_SYSERR == fwd)
2208 if (is_loopback (ch))
2210 /* It is a loopback channel after all... */
2214 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2218 if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
2220 /* Not for us (don't destroy twice a half-open loopback channel) */
2225 send_destroy (ch, GNUNET_YES);
2227 GMT_destroy_if_empty (t);
2232 * Sends an already built message on a channel.
2234 * If the channel is on a loopback tunnel, notifies the appropriate destination
2237 * On a normal channel passes the message to the tunnel for encryption and
2238 * sending on a connection.
2240 * This function DOES NOT save the message for retransmission.
2242 * @param message Message to send. Function makes a copy of it.
2243 * @param ch Channel on which this message is transmitted.
2244 * @param fwd Is this a fwd message?
2245 * @param existing_copy This is a retransmission, don't save a copy.
2248 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2249 struct MeshChannel *ch, int fwd,
2250 void *existing_copy)
2252 struct MeshChannelQueue *chq;
2255 type = ntohs (message->type);
2256 LOG (GNUNET_ERROR_TYPE_INFO, "=> %s %s on channel %s\n",
2257 GM_m2s (type), GM_f2s (fwd), GMCH_2s (ch));
2259 if (GMT_is_loopback (ch->t))
2261 handle_loopback (ch, message, fwd);
2267 struct GNUNET_MESH_Data *payload;
2268 case GNUNET_MESSAGE_TYPE_MESH_DATA:
2270 payload = (struct GNUNET_MESH_Data *) message;
2271 LOG (GNUNET_ERROR_TYPE_INFO, "=> %s %u\n",
2272 GM_m2s (type), ntohl (payload->mid));
2273 if (GNUNET_YES == ch->reliable)
2275 chq = GNUNET_new (struct MeshChannelQueue);
2277 if (NULL == existing_copy)
2278 chq->copy = channel_save_copy (ch, message, fwd);
2281 chq->copy = (struct MeshReliableMessage *) existing_copy;
2282 if (NULL != chq->copy->chq)
2284 /* Last retransmission was queued but not yet sent!
2285 * This retransmission was scheduled by a ch_message_sent which
2286 * followed a very fast RTT, so the tiny delay made the
2287 * retransmission function to execute before the previous
2288 * retransmitted message even had a chance to leave the peer.
2289 * Cancel this message and wait until the pending
2290 * retransmission leaves the peer and ch_message_sent starts
2291 * the timer for the next one.
2294 LOG (GNUNET_ERROR_TYPE_DEBUG,
2295 " exisitng copy not yet transmitted!\n");
2298 LOG (GNUNET_ERROR_TYPE_DEBUG,
2299 " using existing copy: %p {r:%p q:%p t:%u}\n",
2301 chq->copy->rel, chq->copy->chq, chq->copy->type);
2303 LOG (GNUNET_ERROR_TYPE_DEBUG, " new chq: %p\n", chq);
2304 chq->copy->chq = chq;
2305 chq->tq = GMT_send_prebuilt_message (message, ch->t, NULL,
2306 NULL != existing_copy,
2307 &ch_message_sent, chq);
2308 /* q itself is stored in copy */
2309 GNUNET_assert (NULL != chq->tq || GNUNET_NO != ch->destroy);
2313 fire_and_forget (message, ch, GNUNET_NO);
2318 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
2319 if (GNUNET_YES == fwd || NULL != existing_copy)
2321 /* BCK ACK (going FWD) is just a response for a SYNACK, don't keep*/
2322 fire_and_forget (message, ch, GNUNET_YES);
2326 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
2327 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
2328 chq = GNUNET_new (struct MeshChannelQueue);
2330 chq->rel = fwd ? ch->root_rel : ch->dest_rel;
2331 if (NULL != chq->rel->uniq)
2333 if (NULL != chq->rel->uniq->tq)
2335 GMT_cancel (chq->rel->uniq->tq);
2336 /* ch_message_sent is called, freeing and NULLing uniq */
2341 GNUNET_free (chq->rel->uniq);
2344 chq->tq = GMT_send_prebuilt_message (message, ch->t, NULL, GNUNET_YES,
2345 &ch_message_sent, chq);
2346 if (NULL == chq->tq)
2353 chq->rel->uniq = chq;
2357 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
2358 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
2359 fire_and_forget (message, ch, GNUNET_YES);
2365 LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s unknown!\n", GM_m2s (type));
2366 fire_and_forget (message, ch, GNUNET_YES);
2372 * Get the static string for identification of the channel.
2374 * @param ch Channel.
2376 * @return Static string with the channel IDs.
2379 GMCH_2s (const struct MeshChannel *ch)
2381 static char buf[64];
2384 return "(NULL Channel)";
2386 sprintf (buf, "%s:%u gid:%X (%X / %X)",
2387 GMT_2s (ch->t), ch->port, ch->gid, ch->lid_root, ch->lid_dest);