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 * We have received a message out of order, or the client is not ready.
343 * Buffer it until we receive an ACK from the client or the missing
344 * message from the channel.
346 * @param msg Message to buffer (MUST be of type MESH_DATA).
347 * @param rel Reliability data to the corresponding direction.
350 add_buffered_data (const struct GNUNET_MESH_Data *msg,
351 struct MeshChannelReliability *rel)
353 struct MeshReliableMessage *copy;
354 struct MeshReliableMessage *prev;
358 size = ntohs (msg->header.size);
359 mid = ntohl (msg->mid);
361 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
363 copy = GNUNET_malloc (sizeof (*copy) + size);
366 copy->type = GNUNET_MESSAGE_TYPE_MESH_DATA;
367 memcpy (©[1], msg, size);
371 // FIXME do something better than O(n), although n < 64...
372 // FIXME start from the end (most messages are the latest ones)
373 for (prev = rel->head_recv; NULL != prev; prev = prev->next)
375 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
376 if (GM_is_pid_bigger (prev->mid, mid))
378 LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
379 GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
384 LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
385 GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
386 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
390 * Add a destination client to a channel, initializing all data structures
391 * in the channel and the client.
393 * @param ch Channel to which add the destination.
394 * @param c Client which to add to the channel.
397 add_destination (struct MeshChannel *ch, struct MeshClient *c)
399 if (NULL != ch->dest)
405 /* Assign local id as destination */
406 ch->lid_dest = GML_get_next_chid (c);
408 /* Store in client's hashmap */
409 GML_channel_add (c, ch->lid_dest, ch);
411 GNUNET_break (NULL == ch->dest_rel);
412 ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
413 ch->dest_rel->ch = ch;
414 ch->dest_rel->expected_delay.rel_value_us = 0;
421 * Set options in a channel, extracted from a bit flag field.
423 * @param ch Channel to set options to.
424 * @param options Bit array in host byte order.
427 channel_set_options (struct MeshChannel *ch, uint32_t options)
429 ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
430 GNUNET_YES : GNUNET_NO;
431 ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
432 GNUNET_YES : GNUNET_NO;
437 * Get a bit flag field with the options of a channel.
439 * @param ch Channel to get options from.
441 * @return Bit array in host byte order.
444 channel_get_options (struct MeshChannel *ch)
450 options |= GNUNET_MESH_OPTION_NOBUFFER;
452 options |= GNUNET_MESH_OPTION_RELIABLE;
459 * Notify the destination client that a new incoming channel was created.
461 * @param ch Channel that was created.
464 send_client_create (struct MeshChannel *ch)
468 if (NULL == ch->dest)
472 opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
473 opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
474 GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
475 GMT_get_destination (ch->t));
481 * Send data to a client.
483 * If the client is ready, send directly, otherwise buffer while listening
487 * @param msg Message.
488 * @param fwd Is this a fwd (root->dest) message?
491 send_client_data (struct MeshChannel *ch,
492 const struct GNUNET_MESH_Data *msg,
497 if (ch->dest_rel->client_ready)
498 GML_send_data (ch->dest, msg, ch->lid_dest);
500 add_buffered_data (msg, ch->dest_rel);
504 if (ch->root_rel->client_ready)
505 GML_send_data (ch->root, msg, ch->lid_root);
507 add_buffered_data (msg, ch->root_rel);
513 * Send a buffered message to the client, for in order delivery or
514 * as result of client ACK.
516 * @param ch Channel on which to empty the message buffer.
517 * @param c Client to send to.
518 * @param fwd Is this to send FWD data?.
521 send_client_buffered_data (struct MeshChannel *ch,
522 struct MeshClient *c,
525 struct MeshReliableMessage *copy;
526 struct MeshChannelReliability *rel;
528 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
529 rel = fwd ? ch->dest_rel : ch->root_rel;
530 if (GNUNET_NO == rel->client_ready)
532 LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
536 copy = rel->head_recv;
537 /* We never buffer channel management messages */
540 if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
542 struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) ©[1];
544 LOG (GNUNET_ERROR_TYPE_DEBUG,
545 " have %u! now expecting %u\n",
546 copy->mid, rel->mid_recv + 1);
547 send_client_data (ch, msg, fwd);
550 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
551 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE RECV %p\n", copy);
556 LOG (GNUNET_ERROR_TYPE_DEBUG,
557 " reliable && don't have %u, next is %u\n",
563 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
568 * Allow a client to send more data.
570 * In case the client was already allowed to send data, do nothing.
573 * @param fwd Is this a FWD ACK? (FWD ACKs are sent to root)
576 send_client_ack (struct MeshChannel *ch, int fwd)
578 struct MeshChannelReliability *rel = fwd ? ch->root_rel : ch->dest_rel;
580 LOG (GNUNET_ERROR_TYPE_DEBUG,
581 " sending %s ack to client on channel %s\n",
582 GM_f2s (fwd), GMCH_2s (ch));
590 if (GNUNET_YES == rel->client_allowed)
592 LOG (GNUNET_ERROR_TYPE_DEBUG, " already allowed\n");
595 rel->client_allowed = GNUNET_YES;
597 GML_send_ack (fwd ? ch->root : ch->dest, fwd ? ch->lid_root : ch->lid_dest);
602 * Notify the root that the destination rejected the channel.
604 * @param ch Rejected channel.
607 send_client_nack (struct MeshChannel *ch)
609 if (NULL == ch->root)
614 GML_send_nack (ch->root, ch->lid_root);
619 * We haven't received an ACK after a certain time: restransmit the message.
621 * @param cls Closure (MeshChannelReliability with the message to restransmit)
622 * @param tc TaskContext.
625 channel_retransmit_message (void *cls,
626 const struct GNUNET_SCHEDULER_TaskContext *tc)
628 struct MeshChannelReliability *rel = cls;
629 struct MeshReliableMessage *copy;
630 struct MeshChannel *ch;
631 struct GNUNET_MESH_Data *payload;
634 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
635 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
639 copy = rel->head_sent;
646 payload = (struct GNUNET_MESH_Data *) ©[1];
647 fwd = (rel == ch->root_rel);
649 /* Message not found in the queue that we are going to use. */
650 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
652 GMCH_send_prebuilt_message (&payload->header, ch, fwd, copy);
653 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
658 * We haven't received an Channel ACK after a certain time: resend the CREATE.
660 * @param cls Closure (MeshChannelReliability of the channel to recreate)
661 * @param tc TaskContext.
664 channel_recreate (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
666 struct MeshChannelReliability *rel = cls;
668 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
669 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
672 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RE-CREATE\n");
673 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
675 if (rel == rel->ch->root_rel)
677 send_create (rel->ch);
679 else if (rel == rel->ch->dest_rel)
681 send_ack (rel->ch, GNUNET_YES);
692 * Message has been sent: start retransmission timer.
694 * @param cls Closure (queue structure).
696 * @param q Queue handler (no longer valid).
697 * @param type Type of message.
698 * @param size Size of the message.
701 ch_message_sent (void *cls,
702 struct MeshTunnel3 *t,
703 struct MeshTunnel3Queue *q,
704 uint16_t type, size_t size)
706 struct MeshChannelQueue *ch_q = cls;
707 struct MeshReliableMessage *copy = ch_q->copy;
708 struct MeshChannelReliability *rel;
712 case GNUNET_MESSAGE_TYPE_MESH_DATA:
713 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT DATA MID %u\n", copy->mid);
714 GNUNET_assert (ch_q == copy->q);
715 copy->timestamp = GNUNET_TIME_absolute_get ();
717 if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
719 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! scheduling retry %u\n");
720 if (0 != rel->expected_delay.rel_value_us)
722 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay != 0\n");
724 GNUNET_TIME_relative_multiply (rel->expected_delay,
725 MESH_RETRANSMIT_MARGIN);
729 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay 0\n");
730 rel->retry_timer = MESH_RETRANSMIT_TIME;
732 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! using delay %s\n",
733 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
736 GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
737 &channel_retransmit_message, rel);
741 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! retry task %u\n", rel->retry_task);
747 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
748 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
749 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
750 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT %s\n", GM_m2s (ch_q->type));
752 GNUNET_assert (rel->uniq == ch_q);
755 if (MESH_CHANNEL_READY != rel->ch->state
756 && GNUNET_MESSAGE_TYPE_MESH_DATA_ACK != type)
758 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rel->retry_task);
759 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! STD BACKOFF %s\n",
760 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
762 rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
763 rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
764 &channel_recreate, rel);
778 * send a channel create message.
780 * @param ch Channel for which to send.
783 send_create (struct MeshChannel *ch)
785 struct GNUNET_MESH_ChannelCreate msgcc;
787 msgcc.header.size = htons (sizeof (msgcc));
788 msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE);
789 msgcc.chid = htonl (ch->gid);
790 msgcc.port = htonl (ch->port);
791 msgcc.opt = htonl (channel_get_options (ch));
793 GMCH_send_prebuilt_message (&msgcc.header, ch, GNUNET_YES, NULL);
798 * Confirm we got a channel create, FWD ack.
800 * @param ch The channel to confirm.
801 * @param fwd Should we send a FWD ACK? (going dest->root)
804 send_ack (struct MeshChannel *ch, int fwd)
806 struct GNUNET_MESH_ChannelManage msg;
808 msg.header.size = htons (sizeof (msg));
809 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
810 LOG (GNUNET_ERROR_TYPE_DEBUG,
811 " sending channel %s ack for channel %s\n",
812 GM_f2s (fwd), GMCH_2s (ch));
814 msg.chid = htonl (ch->gid);
815 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
820 * Sent a message and don't keep any info about it: we won't need to cancel it
823 * @param msg Header of the message to fire away.
824 * @param ch Channel on which the message should go.
825 * @param force Is this a forced (undroppable) message?
828 fire_and_forget (const struct GNUNET_MessageHeader *msg,
829 struct MeshChannel *ch,
832 GNUNET_break (NULL == GMT_send_prebuilt_message (msg, ch->t, ch, force,
838 * Notify that a channel create didn't succeed.
840 * @param ch The channel to reject.
843 send_nack (struct MeshChannel *ch)
845 struct GNUNET_MESH_ChannelManage msg;
847 msg.header.size = htons (sizeof (msg));
848 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK);
849 LOG (GNUNET_ERROR_TYPE_DEBUG,
850 " sending channel NACK for channel %s\n",
853 msg.chid = htonl (ch->gid);
854 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
859 * Notify a client that the channel is no longer valid.
861 * @param ch Channel that is destroyed.
862 * @param local_only Should we avoid sending it to other peers?
865 send_destroy (struct MeshChannel *ch, int local_only)
867 struct GNUNET_MESH_ChannelManage msg;
869 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
870 msg.header.size = htons (sizeof (msg));
871 msg.chid = htonl (ch->gid);
873 /* If root is not NULL, notify.
874 * If it's NULL, check lid_root. When a local destroy comes in, root
875 * is set to NULL but lid_root is left untouched. In this case, do nothing,
876 * the client is the one who reuqested the channel to be destroyed.
878 if (NULL != ch->root)
879 GML_send_channel_destroy (ch->root, ch->lid_root);
880 else if (0 == ch->lid_root && GNUNET_NO == local_only)
881 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
883 if (NULL != ch->dest)
884 GML_send_channel_destroy (ch->dest, ch->lid_dest);
885 else if (0 == ch->lid_dest && GNUNET_NO == local_only)
886 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_YES, NULL);
891 * Destroy all reliable messages queued for a channel,
892 * during a channel destruction.
893 * Frees the reliability structure itself.
895 * @param rel Reliability data for a channel.
898 channel_rel_free_all (struct MeshChannelReliability *rel)
900 struct MeshReliableMessage *copy;
901 struct MeshReliableMessage *next;
906 for (copy = rel->head_recv; NULL != copy; copy = next)
909 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
910 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH RECV %p\n", copy);
913 for (copy = rel->head_sent; NULL != copy; copy = next)
916 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
917 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH %p\n", copy);
920 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
922 GNUNET_SCHEDULER_cancel (rel->retry_task);
924 if (NULL != rel->uniq)
925 GMT_cancel (rel->uniq->q);
931 * Mark future messages as ACK'd.
933 * @param rel Reliability data.
934 * @param msg DataACK message with a bitfield of future ACK'd messages.
937 channel_rel_free_sent (struct MeshChannelReliability *rel,
938 const struct GNUNET_MESH_DataACK *msg)
940 struct MeshReliableMessage *copy;
941 struct MeshReliableMessage *next;
948 bitfield = msg->futures;
949 mid = ntohl (msg->mid);
950 LOG (GNUNET_ERROR_TYPE_DEBUG,
951 "!!! free_sent_reliable %u %llX\n",
953 LOG (GNUNET_ERROR_TYPE_DEBUG,
954 " rel %p, head %p\n",
955 rel, rel->head_sent);
956 for (i = 0, copy = rel->head_sent;
957 i < 64 && NULL != copy && 0 != bitfield;
960 LOG (GNUNET_ERROR_TYPE_DEBUG,
961 " trying bit %u (mid %u)\n",
964 if (0 == (bitfield & mask))
967 LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
968 /* Bit was set, clear the bit from the bitfield */
971 /* The i-th bit was set. Do we have that copy? */
972 /* Skip copies with mid < target */
973 target = mid + i + 1;
974 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
975 while (NULL != copy && GM_is_pid_bigger (target, copy->mid))
978 /* Did we run out of copies? (previously freed, it's ok) */
981 LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
985 /* Did we overshoot the target? (previously freed, it's ok) */
986 if (GM_is_pid_bigger (copy->mid, target))
988 LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
992 /* Now copy->mid == target, free it */
994 rel_message_free (copy, GNUNET_YES);
997 LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
1002 * Destroy a reliable message after it has been acknowledged, either by
1003 * direct mid ACK or bitfield. Updates the appropriate data structures and
1004 * timers and frees all memory.
1006 * @param copy Message that is no longer needed: remote peer got it.
1007 * @param update_time Is the timing information relevant?
1008 * If this message is ACK in a batch the timing information
1009 * is skewed by the retransmission, count only for the
1010 * retransmitted message.
1013 rel_message_free (struct MeshReliableMessage *copy, int update_time)
1015 struct MeshChannelReliability *rel;
1016 struct GNUNET_TIME_Relative time;
1019 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
1022 time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
1023 if (0 == rel->expected_delay.rel_value_us)
1024 rel->expected_delay = time;
1027 rel->expected_delay.rel_value_us *= 7;
1028 rel->expected_delay.rel_value_us += time.rel_value_us;
1029 rel->expected_delay.rel_value_us /= 8;
1031 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! took %s\n",
1032 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
1033 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! new expected delay %s\n",
1034 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
1036 rel->retry_timer = rel->expected_delay;
1040 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! batch free, ignoring timing\n");
1042 rel->ch->pending_messages--;
1043 if (GNUNET_NO != rel->ch->destroy && 0 == rel->ch->pending_messages)
1045 struct MeshTunnel3 *t = rel->ch->t;
1046 GMCH_destroy (rel->ch);
1047 GMT_destroy_if_empty (t);
1049 if (NULL != copy->q)
1051 GMT_cancel (copy->q->q);
1053 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
1054 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE %p\n", copy);
1060 * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
1062 * @param ch Channel to mark as ready.
1063 * @param fwd Was the ACK message a FWD ACK? (dest->root, SYNACK)
1066 channel_confirm (struct MeshChannel *ch, int fwd)
1068 struct MeshChannelReliability *rel;
1069 enum MeshChannelState oldstate;
1071 LOG (GNUNET_ERROR_TYPE_DEBUG,
1072 " channel confirm %s %s:%X\n",
1073 GM_f2s (fwd), GMT_2s (ch->t), ch->gid);
1074 oldstate = ch->state;
1075 ch->state = MESH_CHANNEL_READY;
1077 rel = fwd ? ch->root_rel : ch->dest_rel;
1078 rel->client_ready = GNUNET_YES;
1079 LOG (GNUNET_ERROR_TYPE_DEBUG,
1080 " !! retry timer confirm %s\n",
1081 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer, GNUNET_NO));
1082 rel->expected_delay = rel->retry_timer;
1083 if (GMT_get_connections_buffer (ch->t) > 0 || GMT_is_loopback (ch->t))
1084 send_client_ack (ch, fwd);
1086 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1088 GNUNET_SCHEDULER_cancel (rel->retry_task);
1089 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1091 else if (NULL != rel->uniq)
1093 GMT_cancel (rel->uniq->q);
1094 /* ch_sent_message will free and NULL uniq */
1098 /* We SHOULD have been trying to retransmit this! */
1099 GNUNET_break (oldstate == MESH_CHANNEL_READY);
1102 /* In case of a FWD ACK (SYNACK) send a BCK ACK (ACK). */
1103 if (GNUNET_YES == fwd)
1104 send_ack (ch, GNUNET_NO);
1109 * Save a copy to retransmit in case it gets lost.
1111 * Initializes all needed callbacks and timers.
1113 * @param ch Channel this message goes on.
1114 * @param msg Message to copy.
1115 * @param fwd Is this fwd traffic?
1117 static struct MeshReliableMessage *
1118 channel_save_copy (struct MeshChannel *ch,
1119 const struct GNUNET_MessageHeader *msg,
1122 struct MeshChannelReliability *rel;
1123 struct MeshReliableMessage *copy;
1128 rel = fwd ? ch->root_rel : ch->dest_rel;
1129 mid = rel->mid_send - 1;
1130 type = ntohs (msg->type);
1131 size = ntohs (msg->size);
1133 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u %s\n", mid, GM_m2s (type));
1134 copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
1135 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", copy);
1139 memcpy (©[1], msg, size);
1140 GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
1141 ch->pending_messages++;
1148 * Create a new channel.
1150 * @param t Tunnel this channel is in.
1151 * @param owner Client that owns the channel, NULL for foreign channels.
1152 * @param lid_root Local ID for root client.
1154 * @return A new initialized channel. NULL on error.
1156 static struct MeshChannel *
1157 channel_new (struct MeshTunnel3 *t,
1158 struct MeshClient *owner,
1159 MESH_ChannelNumber lid_root)
1161 struct MeshChannel *ch;
1163 ch = GNUNET_new (struct MeshChannel);
1165 ch->lid_root = lid_root;
1168 GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
1172 ch->gid = GMT_get_next_chid (t);
1173 GML_channel_add (owner, lid_root, ch);
1175 GMT_add_channel (t, ch);
1182 * Test if the channel is loopback: both root and dest are on the local peer.
1184 * @param ch Channel to test.
1186 * @return #GNUNET_YES if channel is loopback, #NGUNET_NO otherwise.
1189 is_loopback (const struct MeshChannel *ch)
1192 return GMT_is_loopback (ch->t);
1194 return (NULL != ch->root && NULL != ch->dest);
1199 * Handle a loopback message: call the appropriate handler for the message type.
1201 * @param ch Channel this message is on.
1202 * @param msgh Message header.
1203 * @param fwd Is this FWD traffic?
1206 handle_loopback (struct MeshChannel *ch,
1207 const struct GNUNET_MessageHeader *msgh,
1212 type = ntohs (msgh->type);
1213 LOG (GNUNET_ERROR_TYPE_DEBUG,
1214 "Loopback %s %s message!\n",
1215 GM_f2s (fwd), GM_m2s (type));
1219 case GNUNET_MESSAGE_TYPE_MESH_DATA:
1220 /* Don't send hop ACK, wait for client to ACK */
1221 GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
1224 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1225 GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1228 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1229 GMCH_handle_create (ch->t,
1230 (struct GNUNET_MESH_ChannelCreate *) msgh);
1233 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1234 GMCH_handle_ack (ch,
1235 (struct GNUNET_MESH_ChannelManage *) msgh,
1239 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1240 GMCH_handle_nack (ch);
1243 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1244 GMCH_handle_destroy (ch,
1245 (struct GNUNET_MESH_ChannelManage *) msgh,
1250 GNUNET_break_op (0);
1251 LOG (GNUNET_ERROR_TYPE_DEBUG,
1252 "end-to-end message not known (%u)\n",
1253 ntohs (msgh->type));
1259 /******************************************************************************/
1260 /******************************** API ***********************************/
1261 /******************************************************************************/
1264 * Destroy a channel and free all resources.
1266 * @param ch Channel to destroy.
1269 GMCH_destroy (struct MeshChannel *ch)
1271 struct MeshClient *c;
1276 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
1277 GMT_2s (ch->t), ch->gid);
1283 GML_channel_remove (c, ch->lid_root, ch);
1289 GML_channel_remove (c, ch->lid_dest, ch);
1292 channel_rel_free_all (ch->root_rel);
1293 channel_rel_free_all (ch->dest_rel);
1295 GMT_remove_channel (ch->t, ch);
1296 GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
1305 * @param ch Channel.
1310 GMCH_get_id (const struct MeshChannel *ch)
1317 * Get the channel tunnel.
1319 * @param ch Channel to get the tunnel from.
1321 * @return tunnel of the channel.
1323 struct MeshTunnel3 *
1324 GMCH_get_tunnel (const struct MeshChannel *ch)
1331 * Get free buffer space towards the client on a specific channel.
1333 * @param ch Channel.
1334 * @param fwd Is query about FWD traffic?
1336 * @return Free buffer space [0 - 64]
1339 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1341 struct MeshChannelReliability *rel;
1343 rel = fwd ? ch->dest_rel : ch->root_rel;
1345 /* If rel is NULL it means that the end is not yet created,
1346 * most probably is a loopback channel at the point of sending
1347 * the ChannelCreate to itself.
1352 return (64 - rel->n_recv);
1357 * Get flow control status of end point: is client allow to send?
1359 * @param ch Channel.
1360 * @param fwd Is query about FWD traffic? (Request root status).
1362 * @return #GNUNET_YES if client is allowed to send us data.
1365 GMCH_get_allowed (struct MeshChannel *ch, int fwd)
1367 struct MeshChannelReliability *rel;
1369 rel = fwd ? ch->root_rel : ch->dest_rel;
1373 /* Probably shutting down: root/dest NULL'ed to mark disconnection */
1374 GNUNET_break (GNUNET_NO != ch->destroy);
1378 return rel->client_allowed;
1383 * Is the root client for this channel on this peer?
1385 * @param ch Channel.
1386 * @param fwd Is this for fwd traffic?
1388 * @return #GNUNET_YES in case it is.
1391 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1393 struct MeshClient *c;
1395 c = fwd ? ch->root : ch->dest;
1401 * Is the destination client for this channel on this peer?
1403 * @param ch Channel.
1404 * @param fwd Is this for fwd traffic?
1406 * @return #GNUNET_YES in case it is.
1409 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1411 struct MeshClient *c;
1413 c = fwd ? ch->dest : ch->root;
1419 * Send an end-to-end ACK message for the most recent in-sequence payload.
1421 * If channel is not reliable, do nothing.
1423 * @param ch Channel this is about.
1424 * @param fwd Is for FWD traffic? (ACK dest->owner)
1427 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1429 struct GNUNET_MESH_DataACK msg;
1430 struct MeshChannelReliability *rel;
1431 struct MeshReliableMessage *copy;
1436 if (GNUNET_NO == ch->reliable)
1440 rel = fwd ? ch->dest_rel : ch->root_rel;
1441 ack = rel->mid_recv - 1;
1442 LOG (GNUNET_ERROR_TYPE_DEBUG,
1443 " !! Send DATA_ACK for %u\n",
1446 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA_ACK);
1447 msg.header.size = htons (sizeof (msg));
1448 msg.chid = htonl (ch->gid);
1450 for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1452 if (copy->type != GNUNET_MESSAGE_TYPE_MESH_DATA)
1454 LOG (GNUNET_ERROR_TYPE_DEBUG,
1455 "!! Type %s, expected DATA\n",
1456 GM_m2s (copy->type));
1459 if (copy->mid == ack + 1)
1464 delta = copy->mid - (ack + 1);
1467 mask = 0x1LL << delta;
1468 msg.futures |= mask;
1469 LOG (GNUNET_ERROR_TYPE_DEBUG,
1470 " !! setting bit for %u (delta %u) (%llX) -> %llX\n",
1471 copy->mid, delta, mask, msg.futures);
1473 msg.mid = htonl (ack);
1474 LOG (GNUNET_ERROR_TYPE_DEBUG,
1475 "!!! ACK for %u, futures %llX\n",
1478 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
1479 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1484 * Allow a client to send us more data, in case it was choked.
1486 * @param ch Channel.
1487 * @param fwd Is this about FWD traffic? (Root client).
1490 GMCH_allow_client (struct MeshChannel *ch, int fwd)
1492 struct MeshChannelReliability *rel;
1493 unsigned int buffer;
1495 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH allow\n");
1497 if (MESH_CHANNEL_READY != ch->state)
1499 LOG (GNUNET_ERROR_TYPE_DEBUG, " channel not ready yet!\n");
1503 if (GNUNET_YES == ch->reliable)
1505 rel = fwd ? ch->root_rel : ch->dest_rel;
1508 GNUNET_break (GNUNET_NO != ch->destroy);
1511 if (NULL != rel->head_sent && 64 <= rel->mid_send - rel->head_sent->mid)
1513 LOG (GNUNET_ERROR_TYPE_DEBUG, " too big MID gap! Wait for ACK.\n");
1518 if (is_loopback (ch))
1519 buffer = GMCH_get_buffer (ch, fwd);
1521 buffer = GMT_get_connections_buffer (ch->t);
1525 LOG (GNUNET_ERROR_TYPE_DEBUG, " no buffer space.\n");
1529 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space %u, allowing\n", buffer);
1530 send_client_ack (ch, fwd);
1537 * @param ch Channel.
1540 GMCH_debug (struct MeshChannel *ch)
1544 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1547 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1548 GMT_2s (ch->t), ch->gid, ch);
1549 LOG (GNUNET_ERROR_TYPE_DEBUG, " root %p/%p\n",
1550 ch->root, ch->root_rel);
1551 if (NULL != ch->root)
1553 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->root));
1554 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1555 ch->root_rel->client_ready ? "YES" : "NO");
1556 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_root);
1558 LOG (GNUNET_ERROR_TYPE_DEBUG, " dest %p/%p\n",
1559 ch->dest, ch->dest_rel);
1560 if (NULL != ch->dest)
1562 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->dest));
1563 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1564 ch->dest_rel->client_ready ? "YES" : "NO");
1565 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_dest);
1571 * Handle an ACK given by a client.
1573 * Mark client as ready and send him any buffered data we could have for him.
1575 * @param ch Channel.
1576 * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by dest and go BCK)
1579 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1581 struct MeshChannelReliability *rel;
1582 struct MeshClient *c;
1584 rel = fwd ? ch->dest_rel : ch->root_rel;
1585 c = fwd ? ch->dest : ch->root;
1587 rel->client_ready = GNUNET_YES;
1588 send_client_buffered_data (ch, c, fwd);
1589 if (is_loopback (ch))
1591 unsigned int buffer;
1593 buffer = GMCH_get_buffer (ch, fwd);
1595 GMCH_allow_client (ch, fwd);
1599 GMT_send_connection_acks (ch->t);
1604 * Handle data given by a client.
1606 * Check whether the client is allowed to send in this tunnel, save if channel
1607 * is reliable and send an ACK to the client if there is still buffer space
1610 * @param ch Channel.
1611 * @param c Client which sent the data.
1612 * @param message Message.
1613 * @param fwd Is this a FWD data?
1615 * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1618 GMCH_handle_local_data (struct MeshChannel *ch,
1619 struct MeshClient *c,
1620 struct GNUNET_MessageHeader *message,
1623 struct MeshChannelReliability *rel;
1624 struct GNUNET_MESH_Data *payload;
1625 size_t size = ntohs (message->size);
1626 uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1627 unsigned char cbuf[p2p_size];
1629 /* Is the client in the channel? */
1636 GNUNET_break_op (0);
1637 return GNUNET_SYSERR;
1640 rel = fwd ? ch->root_rel : ch->dest_rel;
1642 if (GNUNET_NO == rel->client_allowed)
1644 GNUNET_break_op (0);
1645 return GNUNET_SYSERR;
1648 rel->client_allowed = GNUNET_NO;
1650 /* Ok, everything is correct, send the message. */
1651 payload = (struct GNUNET_MESH_Data *) cbuf;
1652 payload->mid = htonl (rel->mid_send);
1654 memcpy (&payload[1], message, size);
1655 payload->header.size = htons (p2p_size);
1656 payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1657 payload->chid = htonl (ch->gid);
1658 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channel...\n");
1659 GMCH_send_prebuilt_message (&payload->header, ch, fwd, NULL);
1661 if (is_loopback (ch))
1663 if (GMCH_get_buffer (ch, fwd) > 0)
1664 send_client_ack (ch, fwd);
1669 if (GMT_get_connections_buffer (ch->t) > 0)
1671 send_client_ack (ch, fwd);
1679 * Handle a channel destroy requested by a client.
1681 * Destroy the channel and the tunnel in case this was the last channel.
1683 * @param ch Channel.
1684 * @param c Client that requested the destruction (to avoid notifying him).
1685 * @param is_root Is the request coming from root?
1688 GMCH_handle_local_destroy (struct MeshChannel *ch,
1689 struct MeshClient *c,
1692 struct MeshTunnel3 *t;
1694 ch->destroy = GNUNET_YES;
1695 /* Cleanup after the tunnel */
1696 if (GNUNET_NO == is_root && c == ch->dest)
1698 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1699 GML_client_delete_channel (c, ch, ch->lid_dest);
1702 if (GNUNET_YES == is_root && c == ch->root)
1704 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1705 GML_client_delete_channel (c, ch, ch->lid_root);
1710 send_destroy (ch, GNUNET_NO);
1711 if (0 == ch->pending_messages)
1714 GMT_destroy_if_empty (t);
1720 * Handle a channel create requested by a client.
1722 * Create the channel and the tunnel in case this was the first0 channel.
1724 * @param c Client that requested the creation (will be the root).
1725 * @param msg Create Channel message.
1727 * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1730 GMCH_handle_local_create (struct MeshClient *c,
1731 struct GNUNET_MESH_ChannelMessage *msg)
1733 struct MeshChannel *ch;
1734 struct MeshTunnel3 *t;
1735 struct MeshPeer *peer;
1736 MESH_ChannelNumber chid;
1738 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s:%u\n",
1739 GNUNET_i2s (&msg->peer), ntohl (msg->port));
1740 chid = ntohl (msg->channel_id);
1742 /* Sanity check for duplicate channel IDs */
1743 if (NULL != GML_channel_get (c, chid))
1746 return GNUNET_SYSERR;
1749 peer = GMP_get (&msg->peer);
1750 GMP_add_tunnel (peer);
1751 t = GMP_get_tunnel (peer);
1753 if (GMP_get_short_id (peer) == myid)
1755 GMT_change_cstate (t, MESH_TUNNEL3_READY);
1762 /* Create channel */
1763 ch = channel_new (t, c, chid);
1767 return GNUNET_SYSERR;
1769 ch->port = ntohl (msg->port);
1770 channel_set_options (ch, ntohl (msg->opt));
1772 /* In unreliable channels, we'll use the DLL to buffer BCK data */
1773 ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1774 ch->root_rel->ch = ch;
1775 ch->root_rel->retry_timer = MESH_RETRANSMIT_TIME;
1776 ch->root_rel->expected_delay.rel_value_us = 0;
1778 LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1787 * Handler for mesh network payload traffic.
1789 * @param ch Channel for the message.
1790 * @param msg Unencryted data message.
1791 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1792 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1793 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1794 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1797 GMCH_handle_data (struct MeshChannel *ch,
1798 const struct GNUNET_MESH_Data *msg,
1801 struct MeshChannelReliability *rel;
1802 struct MeshClient *c;
1805 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1806 if (GNUNET_SYSERR == fwd)
1808 if (is_loopback (ch))
1810 /* It is a loopback channel after all... */
1814 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
1817 /* Initialize FWD/BCK data */
1818 c = fwd ? ch->dest : ch->root;
1819 rel = fwd ? ch->dest_rel : ch->root_rel;
1827 GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1829 mid = ntohl (msg->mid);
1830 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! got mid %u\n", mid);
1832 if (GNUNET_NO == ch->reliable ||
1833 ( !GM_is_pid_bigger (rel->mid_recv, mid) &&
1834 GM_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1836 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1837 if (GNUNET_YES == ch->reliable)
1839 /* Is this the exact next expected messasge? */
1840 if (mid == rel->mid_recv)
1842 LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1844 send_client_data (ch, msg, fwd);
1848 LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1849 add_buffered_data (msg, rel);
1854 /* Tunnel is unreliable: send to clients directly */
1855 /* FIXME: accept Out Of Order traffic */
1856 rel->mid_recv = mid + 1;
1857 send_client_data (ch, msg, fwd);
1862 GNUNET_break_op (GM_is_pid_bigger (rel->mid_recv, mid));
1863 LOG (GNUNET_ERROR_TYPE_DEBUG,
1864 " !!! MID %u not expected (%u - %u), dropping!\n",
1865 mid, rel->mid_recv, rel->mid_recv + 63);
1868 GMCH_send_data_ack (ch, fwd);
1873 * Handler for mesh network traffic end-to-end ACKs.
1875 * @param ch Channel on which we got this message.
1876 * @param msg Data message.
1877 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1878 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1879 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1880 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1883 GMCH_handle_data_ack (struct MeshChannel *ch,
1884 const struct GNUNET_MESH_DataACK *msg,
1887 struct MeshChannelReliability *rel;
1888 struct MeshReliableMessage *copy;
1889 struct MeshReliableMessage *next;
1893 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1894 if (GNUNET_SYSERR == fwd)
1896 if (is_loopback (ch))
1898 /* It is a loopback channel after all... */
1902 /* Inverted: if message came 'FWD' is a 'BCK ACK'. */
1903 fwd = (NULL != ch->dest) ? GNUNET_NO : GNUNET_YES;
1906 ack = ntohl (msg->mid);
1907 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1908 (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1910 if (GNUNET_YES == fwd)
1920 GNUNET_break_op (0);
1924 /* Free ACK'd copies: no need to retransmit those anymore */
1925 for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
1927 if (GM_is_pid_bigger (copy->mid, ack))
1929 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! head %u, out!\n", copy->mid);
1930 channel_rel_free_sent (rel, msg);
1934 LOG (GNUNET_ERROR_TYPE_DEBUG, " !! id %u\n", copy->mid);
1936 rel_message_free (copy, GNUNET_YES);
1939 /* ACK client if needed */
1940 GMCH_allow_client (ch, fwd);
1942 /* If some message was free'd, update the retransmission delay */
1943 if (GNUNET_YES == work)
1945 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1947 GNUNET_SCHEDULER_cancel (rel->retry_task);
1948 if (NULL != rel->head_sent && NULL == rel->head_sent->q)
1950 struct GNUNET_TIME_Absolute new_target;
1951 struct GNUNET_TIME_Relative delay;
1953 delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
1954 MESH_RETRANSMIT_MARGIN);
1955 new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
1957 delay = GNUNET_TIME_absolute_get_remaining (new_target);
1959 GNUNET_SCHEDULER_add_delayed (delay,
1960 &channel_retransmit_message,
1963 else /* either no more traffic to ack or traffic has just been queued */
1965 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1968 else /* work was done but no task was pending? shouldn't happen! */
1977 * Handler for channel create messages.
1979 * Does not have fwd parameter because it's always 'FWD': channel is incoming.
1981 * @param t Tunnel this channel will be in.
1982 * @param msg Channel crate message.
1984 struct MeshChannel *
1985 GMCH_handle_create (struct MeshTunnel3 *t,
1986 const struct GNUNET_MESH_ChannelCreate *msg)
1988 MESH_ChannelNumber chid;
1989 struct MeshChannel *ch;
1990 struct MeshClient *c;
1992 chid = ntohl (msg->chid);
1994 ch = GMT_get_channel (t, chid);
1997 /* Create channel */
1998 ch = channel_new (t, NULL, 0);
2000 channel_set_options (ch, ntohl (msg->opt));
2002 /* Find a destination client */
2003 ch->port = ntohl (msg->port);
2004 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n", ch->port);
2005 c = GML_client_get_by_port (ch->port);
2008 LOG (GNUNET_ERROR_TYPE_DEBUG, " no client has port registered\n");
2009 if (is_loopback (ch))
2011 LOG (GNUNET_ERROR_TYPE_DEBUG, " loopback: destroy on handler\n");
2016 LOG (GNUNET_ERROR_TYPE_DEBUG, " not loopback: destroy now\n");
2024 LOG (GNUNET_ERROR_TYPE_DEBUG, " client %p has port registered\n", c);
2027 add_destination (ch, c);
2028 if (GNUNET_YES == ch->reliable)
2029 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
2031 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Not Reliable\n");
2033 send_client_create (ch);
2036 send_ack (ch, GNUNET_YES);
2043 * Handler for channel NACK messages.
2045 * NACK messages always go dest -> root, no need for 'fwd' or 'msg' parameter.
2047 * @param ch Channel.
2050 GMCH_handle_nack (struct MeshChannel *ch)
2052 send_client_nack (ch);
2058 * Handler for channel ack messages.
2060 * @param ch Channel.
2061 * @param msg Message.
2062 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2063 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2064 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2065 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2068 GMCH_handle_ack (struct MeshChannel *ch,
2069 const struct GNUNET_MESH_ChannelManage *msg,
2072 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2073 if (GNUNET_SYSERR == fwd)
2075 if (is_loopback (ch))
2077 /* It is a loopback channel after all... */
2081 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2084 channel_confirm (ch, !fwd);
2089 * Handler for channel destroy messages.
2091 * @param ch Channel to be destroyed of.
2092 * @param msg Message.
2093 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2094 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2095 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2096 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2099 GMCH_handle_destroy (struct MeshChannel *ch,
2100 const struct GNUNET_MESH_ChannelManage *msg,
2103 struct MeshTunnel3 *t;
2105 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2106 if (GNUNET_SYSERR == fwd)
2108 if (is_loopback (ch))
2110 /* It is a loopback channel after all... */
2114 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2118 if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
2120 /* Not for us (don't destroy twice a half-open loopback channel) */
2125 send_destroy (ch, GNUNET_YES);
2127 GMT_destroy_if_empty (t);
2132 * Sends an already built message on a channel.
2134 * If the channel is on a loopback tunnel, notifies the appropriate destination
2137 * On a normal channel passes the message to the tunnel for encryption and
2138 * sending on a connection.
2140 * This function DOES NOT save the message for retransmission.
2142 * @param message Message to send. Function makes a copy of it.
2143 * @param ch Channel on which this message is transmitted.
2144 * @param fwd Is this a fwd message?
2145 * @param existing_copy This is a retransmission, don't save a copy.
2148 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2149 struct MeshChannel *ch, int fwd,
2150 void *existing_copy)
2152 struct MeshChannelQueue *q;
2155 type = ntohs (message->type);
2156 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH Send %s %s on channel %s\n",
2157 GM_f2s (fwd), GM_m2s (type),
2160 if (GMT_is_loopback (ch->t))
2162 handle_loopback (ch, message, fwd);
2168 case GNUNET_MESSAGE_TYPE_MESH_DATA:
2170 if (GNUNET_YES == ch->reliable)
2172 q = GNUNET_new (struct MeshChannelQueue);
2174 if (NULL == existing_copy)
2175 q->copy = channel_save_copy (ch, message, fwd);
2178 q->copy = (struct MeshReliableMessage *) existing_copy;
2179 if (NULL != q->copy->q)
2181 /* Last retransmission was queued but not yet sent!
2182 * This retransmission was scheduled by a ch_message_sent which
2183 * followed a very fast RTT, so the tiny delay made the
2184 * retransmission function to execute before the previous
2185 * retransmitted message even had a chance to leave the peer.
2186 * Cancel this message and wait until the pending
2187 * retransmission leaves the peer and ch_message_sent starts
2188 * the timer for the next one.
2191 LOG (GNUNET_ERROR_TYPE_DEBUG,
2192 " exisitng copy not yet transmitted!\n");
2195 LOG (GNUNET_ERROR_TYPE_DEBUG,
2196 " using existing copy: %p {r:%p q:%p t:%u}\n",
2198 q->copy->rel, q->copy->q, q->copy->type);
2200 LOG (GNUNET_ERROR_TYPE_DEBUG, " new q: %p\n", q);
2202 q->q = GMT_send_prebuilt_message (message, ch->t, ch,
2203 NULL != existing_copy,
2204 &ch_message_sent, q);
2205 /* q itself is stored in copy */
2209 fire_and_forget (message, ch, GNUNET_NO);
2214 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
2215 if (GNUNET_YES == fwd)
2217 /* BCK ACK (going FWD) is just a response for a SYNACK, don't keep*/
2218 fire_and_forget (message, ch, GNUNET_YES);
2222 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
2223 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
2224 q = GNUNET_new (struct MeshChannelQueue);
2226 q->rel = fwd ? ch->root_rel : ch->dest_rel;
2227 if (NULL != q->rel->uniq)
2229 if (NULL != q->rel->uniq->q)
2231 GMT_cancel (q->rel->uniq->q);
2232 /* ch_message_sent is called, freeing and NULLing uniq */
2236 GNUNET_free (q->rel->uniq);
2239 q->q = GMT_send_prebuilt_message (message, ch->t, ch, GNUNET_YES,
2240 &ch_message_sent, q);
2245 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
2246 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
2247 fire_and_forget (message, ch, GNUNET_YES);
2253 LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s unknown!\n", GM_m2s (type));
2254 fire_and_forget (message, ch, GNUNET_YES);
2260 * Get the static string for identification of the channel.
2262 * @param ch Channel.
2264 * @return Static string with the channel IDs.
2267 GMCH_2s (const struct MeshChannel *ch)
2269 static char buf[64];
2272 return "(NULL Channel)";
2274 sprintf (buf, "%s:%u gid:%X (%X / %X)",
2275 GMT_2s (ch->t), ch->port, ch->gid, ch->lid_root, ch->lid_dest);