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_UNIT_SECONDS
38 #define MESH_RETRANSMIT_MARGIN 4
42 * All the states a connection can be in.
47 * Uninitialized status, should never appear in operation.
52 * Connection create message sent, waiting for ACK.
57 * Connection confirmed, ready to carry traffic.
64 * Info holder for channel messages in queues.
66 struct MeshChannelQueue
71 struct MeshTunnel3Queue *q;
74 * Message type (DATA/DATA_ACK)
79 * Message copy (for DATAs, to start retransmission timer)
81 struct MeshReliableMessage *copy;
84 * Reliability (for DATA_ACKs, to access rel->ack_q)
86 struct MeshChannelReliability *rel;
91 * Info needed to retry a message in case it gets lost.
93 struct MeshReliableMessage
96 * Double linked list, FIFO style
98 struct MeshReliableMessage *next;
99 struct MeshReliableMessage *prev;
102 * Type of message (payload, channel management).
107 * Tunnel Reliability queue this message is in.
109 struct MeshChannelReliability *rel;
112 * ID of the message (ACK needed to free)
119 struct MeshChannelQueue *q;
122 * When was this message issued (to calculate ACK delay)
124 struct GNUNET_TIME_Absolute timestamp;
126 /* struct GNUNET_MESH_Data with payload */
131 * Info about the traffic state for a client in a channel.
133 struct MeshChannelReliability
136 * Channel this is about.
138 struct MeshChannel *ch;
141 * DLL of messages sent and not yet ACK'd.
143 struct MeshReliableMessage *head_sent;
144 struct MeshReliableMessage *tail_sent;
147 * DLL of messages received out of order.
149 struct MeshReliableMessage *head_recv;
150 struct MeshReliableMessage *tail_recv;
158 * Next MID to use for outgoing traffic.
163 * Next MID expected for incoming traffic.
168 * Handle for queued unique data CREATE, DATA_ACK.
170 struct MeshChannelQueue *uniq;
173 * Can we send data to the client?
178 * Can the client send data to us?
183 * Task to resend/poll in case no ACK is received.
185 GNUNET_SCHEDULER_TaskIdentifier retry_task;
188 * Counter for exponential backoff.
190 struct GNUNET_TIME_Relative retry_timer;
193 * How long does it usually take to get an ACK.
195 struct GNUNET_TIME_Relative expected_delay;
200 * Struct containing all information regarding a channel to a remote client.
205 * Tunnel this channel is in.
207 struct MeshTunnel3 *t;
210 * Destination port of the channel.
215 * Global channel number ( < GNUNET_MESH_LOCAL_CHANNEL_ID_CLI)
217 MESH_ChannelNumber gid;
220 * Local tunnel number for root (owner) client.
221 * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_CLI or 0 )
223 MESH_ChannelNumber lid_root;
226 * Local tunnel number for local destination clients (incoming number)
227 * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV or 0).
229 MESH_ChannelNumber lid_dest;
234 enum MeshChannelState state;
237 * Is the tunnel bufferless (minimum latency)?
242 * Is the tunnel reliable?
247 * Last time the channel was used
249 struct GNUNET_TIME_Absolute timestamp;
252 * Client owner of the tunnel, if any
254 struct MeshClient *root;
257 * Client destination of the tunnel, if any.
259 struct MeshClient *dest;
262 * Flag to signal the destruction of the channel.
263 * If this is set GNUNET_YES the channel will be destroyed
264 * when the queue is empty.
269 * Total (reliable) messages pending ACK for this channel.
271 unsigned int pending_messages;
275 * Only present (non-NULL) at the owner of a tunnel.
277 struct MeshChannelReliability *root_rel;
281 * Only present (non-NULL) at the destination of a tunnel.
283 struct MeshChannelReliability *dest_rel;
288 /******************************************************************************/
289 /******************************* GLOBALS ***********************************/
290 /******************************************************************************/
293 * Global handle to the statistics service.
295 extern struct GNUNET_STATISTICS_Handle *stats;
298 * Local peer own ID (memory efficient handle).
300 extern GNUNET_PEER_Id myid;
303 /******************************************************************************/
304 /******************************** STATIC ***********************************/
305 /******************************************************************************/
308 * Destroy a reliable message after it has been acknowledged, either by
309 * direct mid ACK or bitfield. Updates the appropriate data structures and
310 * timers and frees all memory.
312 * @param copy Message that is no longer needed: remote peer got it.
313 * @param update_time Is the timing information relevant?
314 * If this message is ACK in a batch the timing information
315 * is skewed by the retransmission, count only for the
316 * retransmitted message.
319 rel_message_free (struct MeshReliableMessage *copy, int update_time);
322 * send a channel create message.
324 * @param ch Channel for which to send.
327 send_create (struct MeshChannel *ch);
330 * Confirm we got a channel create, FWD ack.
332 * @param ch The channel to confirm.
333 * @param fwd Should we send a FWD ACK? (going dest->root)
336 send_ack (struct MeshChannel *ch, int fwd);
341 * We have received a message out of order, or the client is not ready.
342 * Buffer it until we receive an ACK from the client or the missing
343 * message from the channel.
345 * @param msg Message to buffer (MUST be of type MESH_DATA).
346 * @param rel Reliability data to the corresponding direction.
349 add_buffered_data (const struct GNUNET_MESH_Data *msg,
350 struct MeshChannelReliability *rel)
352 struct MeshReliableMessage *copy;
353 struct MeshReliableMessage *prev;
357 size = ntohs (msg->header.size);
358 mid = ntohl (msg->mid);
360 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
362 copy = GNUNET_malloc (sizeof (*copy) + size);
365 copy->type = GNUNET_MESSAGE_TYPE_MESH_DATA;
366 memcpy (©[1], msg, size);
370 // FIXME do something better than O(n), although n < 64...
371 // FIXME start from the end (most messages are the latest ones)
372 for (prev = rel->head_recv; NULL != prev; prev = prev->next)
374 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
375 if (GM_is_pid_bigger (prev->mid, mid))
377 LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
378 GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
383 LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
384 GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
385 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
389 * Add a destination client to a channel, initializing all data structures
390 * in the channel and the client.
392 * @param ch Channel to which add the destination.
393 * @param c Client which to add to the channel.
396 add_destination (struct MeshChannel *ch, struct MeshClient *c)
398 if (NULL != ch->dest)
404 /* Assign local id as destination */
405 ch->lid_dest = GML_get_next_chid (c);
407 /* Store in client's hashmap */
408 GML_channel_add (c, ch->lid_dest, ch);
410 GNUNET_break (NULL == ch->dest_rel);
411 ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
412 ch->dest_rel->ch = ch;
413 ch->dest_rel->expected_delay.rel_value_us = 0;
420 * Set options in a channel, extracted from a bit flag field.
422 * @param ch Channel to set options to.
423 * @param options Bit array in host byte order.
426 channel_set_options (struct MeshChannel *ch, uint32_t options)
428 ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
429 GNUNET_YES : GNUNET_NO;
430 ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
431 GNUNET_YES : GNUNET_NO;
436 * Get a bit flag field with the options of a channel.
438 * @param ch Channel to get options from.
440 * @return Bit array in host byte order.
443 channel_get_options (struct MeshChannel *ch)
449 options |= GNUNET_MESH_OPTION_NOBUFFER;
451 options |= GNUNET_MESH_OPTION_RELIABLE;
458 * Notify the destination client that a new incoming channel was created.
460 * @param ch Channel that was created.
463 send_client_create (struct MeshChannel *ch)
467 if (NULL == ch->dest)
471 opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
472 opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
473 GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
474 GMT_get_destination (ch->t));
480 * Send data to a client.
482 * If the client is ready, send directly, otherwise buffer while listening
486 * @param msg Message.
487 * @param fwd Is this a fwd (root->dest) message?
490 send_client_data (struct MeshChannel *ch,
491 const struct GNUNET_MESH_Data *msg,
496 if (ch->dest_rel->client_ready)
497 GML_send_data (ch->dest, msg, ch->lid_dest);
499 add_buffered_data (msg, ch->dest_rel);
503 if (ch->root_rel->client_ready)
504 GML_send_data (ch->root, msg, ch->lid_root);
506 add_buffered_data (msg, ch->root_rel);
512 * Send a buffered message to the client, for in order delivery or
513 * as result of client ACK.
515 * @param ch Channel on which to empty the message buffer.
516 * @param c Client to send to.
517 * @param fwd Is this to send FWD data?.
520 send_client_buffered_data (struct MeshChannel *ch,
521 struct MeshClient *c,
524 struct MeshReliableMessage *copy;
525 struct MeshChannelReliability *rel;
527 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
528 rel = fwd ? ch->dest_rel : ch->root_rel;
529 if (GNUNET_NO == rel->client_ready)
531 LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
535 copy = rel->head_recv;
536 /* We never buffer channel management messages */
539 if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
541 struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) ©[1];
543 LOG (GNUNET_ERROR_TYPE_DEBUG,
544 " have %u! now expecting %u\n",
545 copy->mid, rel->mid_recv + 1);
546 send_client_data (ch, msg, fwd);
549 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
550 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE RECV %p\n", copy);
555 LOG (GNUNET_ERROR_TYPE_DEBUG,
556 " reliable && don't have %u, next is %u\n",
562 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
567 * Allow a client to send more data.
569 * In case the client was already allowed to send data, do nothing.
572 * @param fwd Is this a FWD ACK? (FWD ACKs are sent to root)
575 send_client_ack (struct MeshChannel *ch, int fwd)
577 struct MeshChannelReliability *rel = fwd ? ch->root_rel : ch->dest_rel;
579 LOG (GNUNET_ERROR_TYPE_DEBUG,
580 " sending %s ack to client on channel %s\n",
581 GM_f2s (fwd), GMCH_2s (ch));
589 if (GNUNET_YES == rel->client_allowed)
591 LOG (GNUNET_ERROR_TYPE_DEBUG, " already allowed\n");
594 rel->client_allowed = GNUNET_YES;
596 GML_send_ack (fwd ? ch->root : ch->dest, fwd ? ch->lid_root : ch->lid_dest);
601 * Notify the root that the destination rejected the channel.
603 * @param ch Rejected channel.
606 send_client_nack (struct MeshChannel *ch)
608 if (NULL == ch->root)
613 GML_send_nack (ch->root, ch->lid_root);
618 * We haven't received an ACK after a certain time: restransmit the message.
620 * @param cls Closure (MeshChannelReliability with the message to restransmit)
621 * @param tc TaskContext.
624 channel_retransmit_message (void *cls,
625 const struct GNUNET_SCHEDULER_TaskContext *tc)
627 struct MeshChannelReliability *rel = cls;
628 struct MeshReliableMessage *copy;
629 struct MeshChannel *ch;
630 struct GNUNET_MESH_Data *payload;
633 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
634 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
638 copy = rel->head_sent;
645 payload = (struct GNUNET_MESH_Data *) ©[1];
646 fwd = (rel == ch->root_rel);
648 /* Message not found in the queue that we are going to use. */
649 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
651 GMCH_send_prebuilt_message (&payload->header, ch, fwd, copy);
652 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
657 * We haven't received an Channel ACK after a certain time: resend the CREATE.
659 * @param cls Closure (MeshChannelReliability of the channel to recreate)
660 * @param tc TaskContext.
663 channel_recreate (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
665 struct MeshChannelReliability *rel = cls;
667 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
668 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
671 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RE-CREATE\n");
672 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
674 if (rel == rel->ch->root_rel)
676 send_create (rel->ch);
678 else if (rel == rel->ch->dest_rel)
680 send_ack (rel->ch, GNUNET_YES);
691 * Message has been sent: start retransmission timer.
693 * @param cls Closure (queue structure).
695 * @param q Queue handler (no longer valid).
696 * @param type Type of message.
697 * @param size Size of the message.
700 ch_message_sent (void *cls,
701 struct MeshTunnel3 *t,
702 struct MeshTunnel3Queue *q,
703 uint16_t type, size_t size)
705 struct MeshChannelQueue *ch_q = cls;
706 struct MeshReliableMessage *copy = ch_q->copy;
707 struct MeshChannelReliability *rel;
711 case GNUNET_MESSAGE_TYPE_MESH_DATA:
712 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT DATA MID %u\n", copy->mid);
713 GNUNET_assert (ch_q == copy->q);
714 copy->timestamp = GNUNET_TIME_absolute_get ();
716 if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
718 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! scheduling retry %u\n");
719 if (0 != rel->expected_delay.rel_value_us)
721 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay != 0\n");
723 GNUNET_TIME_relative_multiply (rel->expected_delay,
724 MESH_RETRANSMIT_MARGIN);
728 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay 0\n");
729 rel->retry_timer = MESH_RETRANSMIT_TIME;
731 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! using delay %s\n",
732 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
735 GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
736 &channel_retransmit_message, rel);
740 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! retry task %u\n", rel->retry_task);
746 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
747 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
748 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
749 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT %s\n", GM_m2s (ch_q->type));
751 GNUNET_assert (rel->uniq == ch_q);
754 if (MESH_CHANNEL_READY != rel->ch->state
755 && GNUNET_MESSAGE_TYPE_MESH_DATA_ACK != type)
757 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rel->retry_task);
758 rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
759 rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
760 &channel_recreate, rel);
774 * send a channel create message.
776 * @param ch Channel for which to send.
779 send_create (struct MeshChannel *ch)
781 struct GNUNET_MESH_ChannelCreate msgcc;
783 msgcc.header.size = htons (sizeof (msgcc));
784 msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE);
785 msgcc.chid = htonl (ch->gid);
786 msgcc.port = htonl (ch->port);
787 msgcc.opt = htonl (channel_get_options (ch));
789 GMCH_send_prebuilt_message (&msgcc.header, ch, GNUNET_YES, NULL);
794 * Confirm we got a channel create, FWD ack.
796 * @param ch The channel to confirm.
797 * @param fwd Should we send a FWD ACK? (going dest->root)
800 send_ack (struct MeshChannel *ch, int fwd)
802 struct GNUNET_MESH_ChannelManage msg;
804 msg.header.size = htons (sizeof (msg));
805 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
806 LOG (GNUNET_ERROR_TYPE_DEBUG,
807 " sending channel %s ack for channel %s\n",
808 GM_f2s (fwd), GMCH_2s (ch));
810 msg.chid = htonl (ch->gid);
811 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
816 * Sent a message and don't keep any info about it: we won't need to cancel it
819 * @param msg Header of the message to fire away.
820 * @param ch Channel on which the message should go.
821 * @param force Is this a forced (undroppable) message?
824 fire_and_forget (const struct GNUNET_MessageHeader *msg,
825 struct MeshChannel *ch,
828 GNUNET_break (NULL == GMT_send_prebuilt_message (msg, ch->t, ch, force,
834 * Notify that a channel create didn't succeed.
836 * @param ch The channel to reject.
839 send_nack (struct MeshChannel *ch)
841 struct GNUNET_MESH_ChannelManage msg;
843 msg.header.size = htons (sizeof (msg));
844 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK);
845 LOG (GNUNET_ERROR_TYPE_DEBUG,
846 " sending channel NACK for channel %s\n",
849 msg.chid = htonl (ch->gid);
850 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
855 * Notify a client that the channel is no longer valid.
857 * @param ch Channel that is destroyed.
858 * @param local_only Should we avoid sending it to other peers?
861 send_destroy (struct MeshChannel *ch, int local_only)
863 struct GNUNET_MESH_ChannelManage msg;
865 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
866 msg.header.size = htons (sizeof (msg));
867 msg.chid = htonl (ch->gid);
869 /* If root is not NULL, notify.
870 * If it's NULL, check lid_root. When a local destroy comes in, root
871 * is set to NULL but lid_root is left untouched. In this case, do nothing,
872 * the client is the one who reuqested the channel to be destroyed.
874 if (NULL != ch->root)
875 GML_send_channel_destroy (ch->root, ch->lid_root);
876 else if (0 == ch->lid_root && GNUNET_NO == local_only)
877 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
879 if (NULL != ch->dest)
880 GML_send_channel_destroy (ch->dest, ch->lid_dest);
881 else if (0 == ch->lid_dest && GNUNET_NO == local_only)
882 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_YES, NULL);
887 * Destroy all reliable messages queued for a channel,
888 * during a channel destruction.
889 * Frees the reliability structure itself.
891 * @param rel Reliability data for a channel.
894 channel_rel_free_all (struct MeshChannelReliability *rel)
896 struct MeshReliableMessage *copy;
897 struct MeshReliableMessage *next;
902 for (copy = rel->head_recv; NULL != copy; copy = next)
905 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
906 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH RECV %p\n", copy);
909 for (copy = rel->head_sent; NULL != copy; copy = next)
912 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
913 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH %p\n", copy);
916 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
918 GNUNET_SCHEDULER_cancel (rel->retry_task);
920 if (NULL != rel->uniq)
921 GMT_cancel (rel->uniq->q);
927 * Mark future messages as ACK'd.
929 * @param rel Reliability data.
930 * @param msg DataACK message with a bitfield of future ACK'd messages.
933 channel_rel_free_sent (struct MeshChannelReliability *rel,
934 const struct GNUNET_MESH_DataACK *msg)
936 struct MeshReliableMessage *copy;
937 struct MeshReliableMessage *next;
944 bitfield = msg->futures;
945 mid = ntohl (msg->mid);
946 LOG (GNUNET_ERROR_TYPE_DEBUG,
947 "!!! free_sent_reliable %u %llX\n",
949 LOG (GNUNET_ERROR_TYPE_DEBUG,
950 " rel %p, head %p\n",
951 rel, rel->head_sent);
952 for (i = 0, copy = rel->head_sent;
953 i < 64 && NULL != copy && 0 != bitfield;
956 LOG (GNUNET_ERROR_TYPE_DEBUG,
957 " trying bit %u (mid %u)\n",
960 if (0 == (bitfield & mask))
963 LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
964 /* Bit was set, clear the bit from the bitfield */
967 /* The i-th bit was set. Do we have that copy? */
968 /* Skip copies with mid < target */
969 target = mid + i + 1;
970 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
971 while (NULL != copy && GM_is_pid_bigger (target, copy->mid))
974 /* Did we run out of copies? (previously freed, it's ok) */
977 LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
981 /* Did we overshoot the target? (previously freed, it's ok) */
982 if (GM_is_pid_bigger (copy->mid, target))
984 LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
988 /* Now copy->mid == target, free it */
990 rel_message_free (copy, GNUNET_YES);
993 LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
998 * Destroy a reliable message after it has been acknowledged, either by
999 * direct mid ACK or bitfield. Updates the appropriate data structures and
1000 * timers and frees all memory.
1002 * @param copy Message that is no longer needed: remote peer got it.
1003 * @param update_time Is the timing information relevant?
1004 * If this message is ACK in a batch the timing information
1005 * is skewed by the retransmission, count only for the
1006 * retransmitted message.
1009 rel_message_free (struct MeshReliableMessage *copy, int update_time)
1011 struct MeshChannelReliability *rel;
1012 struct GNUNET_TIME_Relative time;
1015 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
1018 time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
1019 if (0 == rel->expected_delay.rel_value_us)
1020 rel->expected_delay = time;
1023 rel->expected_delay.rel_value_us *= 7;
1024 rel->expected_delay.rel_value_us += time.rel_value_us;
1025 rel->expected_delay.rel_value_us /= 8;
1027 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! took %s\n",
1028 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
1029 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! new expected delay %s\n",
1030 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
1032 rel->retry_timer = rel->expected_delay;
1036 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! batch free, ignoring timing\n");
1038 rel->ch->pending_messages--;
1039 if (GNUNET_NO != rel->ch->destroy && 0 == rel->ch->pending_messages)
1041 struct MeshTunnel3 *t = rel->ch->t;
1042 GMCH_destroy (rel->ch);
1043 GMT_destroy_if_empty (t);
1045 if (NULL != copy->q)
1047 GMT_cancel (copy->q->q);
1049 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
1050 LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE %p\n", copy);
1056 * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
1058 * @param ch Channel to mark as ready.
1059 * @param fwd Was the ACK message a FWD ACK? (dest->root, SYNACK)
1062 channel_confirm (struct MeshChannel *ch, int fwd)
1064 struct MeshChannelReliability *rel;
1065 enum MeshChannelState oldstate;
1067 LOG (GNUNET_ERROR_TYPE_DEBUG,
1068 " channel confirm %s %s:%X\n",
1069 GM_f2s (fwd), GMT_2s (ch->t), ch->gid);
1070 oldstate = ch->state;
1071 ch->state = MESH_CHANNEL_READY;
1073 rel = fwd ? ch->root_rel : ch->dest_rel;
1074 rel->client_ready = GNUNET_YES;
1075 LOG (GNUNET_ERROR_TYPE_DEBUG,
1076 " !! retry timer confirm %s\n",
1077 GNUNET_STRINGS_relative_time_to_string (rel->retry_timer, GNUNET_NO));
1078 rel->expected_delay = rel->retry_timer;
1079 if (GMT_get_connections_buffer (ch->t) > 0 || GMT_is_loopback (ch->t))
1080 send_client_ack (ch, fwd);
1082 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1084 GNUNET_SCHEDULER_cancel (rel->retry_task);
1085 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1087 else if (NULL != rel->uniq)
1089 GMT_cancel (rel->uniq->q);
1090 /* ch_sent_message will free and NULL uniq */
1094 /* We SHOULD have been trying to retransmit this! */
1095 GNUNET_break (oldstate == MESH_CHANNEL_READY);
1098 /* In case of a FWD ACK (SYNACK) send a BCK ACK (ACK). */
1099 if (GNUNET_YES == fwd)
1100 send_ack (ch, GNUNET_NO);
1105 * Save a copy to retransmit in case it gets lost.
1107 * Initializes all needed callbacks and timers.
1109 * @param ch Channel this message goes on.
1110 * @param msg Message to copy.
1111 * @param fwd Is this fwd traffic?
1113 static struct MeshReliableMessage *
1114 channel_save_copy (struct MeshChannel *ch,
1115 const struct GNUNET_MessageHeader *msg,
1118 struct MeshChannelReliability *rel;
1119 struct MeshReliableMessage *copy;
1124 rel = fwd ? ch->root_rel : ch->dest_rel;
1125 mid = rel->mid_send - 1;
1126 type = ntohs (msg->type);
1127 size = ntohs (msg->size);
1129 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u %s\n", mid, GM_m2s (type));
1130 copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
1131 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", copy);
1135 memcpy (©[1], msg, size);
1136 GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
1137 ch->pending_messages++;
1144 * Create a new channel.
1146 * @param t Tunnel this channel is in.
1147 * @param owner Client that owns the channel, NULL for foreign channels.
1148 * @param lid_root Local ID for root client.
1150 * @return A new initialized channel. NULL on error.
1152 static struct MeshChannel *
1153 channel_new (struct MeshTunnel3 *t,
1154 struct MeshClient *owner,
1155 MESH_ChannelNumber lid_root)
1157 struct MeshChannel *ch;
1159 ch = GNUNET_new (struct MeshChannel);
1161 ch->lid_root = lid_root;
1164 GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
1168 ch->gid = GMT_get_next_chid (t);
1169 GML_channel_add (owner, lid_root, ch);
1171 GMT_add_channel (t, ch);
1178 * Test if the channel is loopback: both root and dest are on the local peer.
1180 * @param ch Channel to test.
1182 * @return #GNUNET_YES if channel is loopback, #NGUNET_NO otherwise.
1185 is_loopback (const struct MeshChannel *ch)
1188 return GMT_is_loopback (ch->t);
1190 return (NULL != ch->root && NULL != ch->dest);
1195 * Handle a loopback message: call the appropriate handler for the message type.
1197 * @param ch Channel this message is on.
1198 * @param msgh Message header.
1199 * @param fwd Is this FWD traffic?
1202 handle_loopback (struct MeshChannel *ch,
1203 const struct GNUNET_MessageHeader *msgh,
1208 type = ntohs (msgh->type);
1209 LOG (GNUNET_ERROR_TYPE_DEBUG,
1210 "Loopback %s %s message!\n",
1211 GM_f2s (fwd), GM_m2s (type));
1215 case GNUNET_MESSAGE_TYPE_MESH_DATA:
1216 /* Don't send hop ACK, wait for client to ACK */
1217 GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
1220 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1221 GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1224 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1225 GMCH_handle_create (ch->t,
1226 (struct GNUNET_MESH_ChannelCreate *) msgh);
1229 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1230 GMCH_handle_ack (ch,
1231 (struct GNUNET_MESH_ChannelManage *) msgh,
1235 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1236 GMCH_handle_nack (ch);
1239 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1240 GMCH_handle_destroy (ch,
1241 (struct GNUNET_MESH_ChannelManage *) msgh,
1246 GNUNET_break_op (0);
1247 LOG (GNUNET_ERROR_TYPE_DEBUG,
1248 "end-to-end message not known (%u)\n",
1249 ntohs (msgh->type));
1255 /******************************************************************************/
1256 /******************************** API ***********************************/
1257 /******************************************************************************/
1260 * Destroy a channel and free all resources.
1262 * @param ch Channel to destroy.
1265 GMCH_destroy (struct MeshChannel *ch)
1267 struct MeshClient *c;
1272 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
1273 GMT_2s (ch->t), ch->gid);
1279 GML_channel_remove (c, ch->lid_root, ch);
1285 GML_channel_remove (c, ch->lid_dest, ch);
1288 channel_rel_free_all (ch->root_rel);
1289 channel_rel_free_all (ch->dest_rel);
1291 GMT_remove_channel (ch->t, ch);
1292 GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
1301 * @param ch Channel.
1306 GMCH_get_id (const struct MeshChannel *ch)
1313 * Get the channel tunnel.
1315 * @param ch Channel to get the tunnel from.
1317 * @return tunnel of the channel.
1319 struct MeshTunnel3 *
1320 GMCH_get_tunnel (const struct MeshChannel *ch)
1327 * Get free buffer space towards the client on a specific channel.
1329 * @param ch Channel.
1330 * @param fwd Is query about FWD traffic?
1332 * @return Free buffer space [0 - 64]
1335 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1337 struct MeshChannelReliability *rel;
1339 rel = fwd ? ch->dest_rel : ch->root_rel;
1341 /* If rel is NULL it means that the end is not yet created,
1342 * most probably is a loopback channel at the point of sending
1343 * the ChannelCreate to itself.
1348 return (64 - rel->n_recv);
1353 * Get flow control status of end point: is client allow to send?
1355 * @param ch Channel.
1356 * @param fwd Is query about FWD traffic? (Request root status).
1358 * @return #GNUNET_YES if client is allowed to send us data.
1361 GMCH_get_allowed (struct MeshChannel *ch, int fwd)
1363 struct MeshChannelReliability *rel;
1365 rel = fwd ? ch->root_rel : ch->dest_rel;
1369 /* Probably shutting down: root/dest NULL'ed to mark disconnection */
1370 GNUNET_break (GNUNET_NO != ch->destroy);
1374 return rel->client_allowed;
1379 * Is the root client for this channel on this peer?
1381 * @param ch Channel.
1382 * @param fwd Is this for fwd traffic?
1384 * @return #GNUNET_YES in case it is.
1387 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1389 struct MeshClient *c;
1391 c = fwd ? ch->root : ch->dest;
1397 * Is the destination client for this channel on this peer?
1399 * @param ch Channel.
1400 * @param fwd Is this for fwd traffic?
1402 * @return #GNUNET_YES in case it is.
1405 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1407 struct MeshClient *c;
1409 c = fwd ? ch->dest : ch->root;
1415 * Send an end-to-end ACK message for the most recent in-sequence payload.
1417 * If channel is not reliable, do nothing.
1419 * @param ch Channel this is about.
1420 * @param fwd Is for FWD traffic? (ACK dest->owner)
1423 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1425 struct GNUNET_MESH_DataACK msg;
1426 struct MeshChannelReliability *rel;
1427 struct MeshReliableMessage *copy;
1432 if (GNUNET_NO == ch->reliable)
1436 rel = fwd ? ch->dest_rel : ch->root_rel;
1437 ack = rel->mid_recv - 1;
1438 LOG (GNUNET_ERROR_TYPE_DEBUG,
1439 " !! Send DATA_ACK for %u\n",
1442 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA_ACK);
1443 msg.header.size = htons (sizeof (msg));
1444 msg.chid = htonl (ch->gid);
1446 for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1448 if (copy->type != GNUNET_MESSAGE_TYPE_MESH_DATA)
1450 LOG (GNUNET_ERROR_TYPE_DEBUG,
1451 "!! Type %s, expected DATA\n",
1452 GM_m2s (copy->type));
1455 if (copy->mid == ack + 1)
1460 delta = copy->mid - (ack + 1);
1463 mask = 0x1LL << delta;
1464 msg.futures |= mask;
1465 LOG (GNUNET_ERROR_TYPE_DEBUG,
1466 " !! setting bit for %u (delta %u) (%llX) -> %llX\n",
1467 copy->mid, delta, mask, msg.futures);
1469 msg.mid = htonl (ack);
1470 LOG (GNUNET_ERROR_TYPE_DEBUG,
1471 "!!! ACK for %u, futures %llX\n",
1474 GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
1475 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1480 * Allow a client to send us more data, in case it was choked.
1482 * @param ch Channel.
1483 * @param fwd Is this about FWD traffic? (Root client).
1486 GMCH_allow_client (struct MeshChannel *ch, int fwd)
1488 struct MeshChannelReliability *rel;
1489 unsigned int buffer;
1491 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH allow\n");
1493 if (MESH_CHANNEL_READY != ch->state)
1495 LOG (GNUNET_ERROR_TYPE_DEBUG, " channel not ready yet!\n");
1499 if (GNUNET_YES == ch->reliable)
1501 rel = fwd ? ch->root_rel : ch->dest_rel;
1504 GNUNET_break (GNUNET_NO != ch->destroy);
1507 if (NULL != rel->head_sent && 64 <= rel->mid_send - rel->head_sent->mid)
1509 LOG (GNUNET_ERROR_TYPE_DEBUG, " too big MID gap! Wait for ACK.\n");
1514 if (is_loopback (ch))
1515 buffer = GMCH_get_buffer (ch, fwd);
1517 buffer = GMT_get_connections_buffer (ch->t);
1521 LOG (GNUNET_ERROR_TYPE_DEBUG, " no buffer space.\n");
1525 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space %u, allowing\n", buffer);
1526 send_client_ack (ch, fwd);
1533 * @param ch Channel.
1536 GMCH_debug (struct MeshChannel *ch)
1540 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1543 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1544 GMT_2s (ch->t), ch->gid, ch);
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, " root %p/%p\n",
1546 ch->root, ch->root_rel);
1547 if (NULL != ch->root)
1549 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->root));
1550 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1551 ch->root_rel->client_ready ? "YES" : "NO");
1552 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_root);
1554 LOG (GNUNET_ERROR_TYPE_DEBUG, " dest %p/%p\n",
1555 ch->dest, ch->dest_rel);
1556 if (NULL != ch->dest)
1558 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %s\n", GML_2s (ch->dest));
1559 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1560 ch->dest_rel->client_ready ? "YES" : "NO");
1561 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_dest);
1567 * Handle an ACK given by a client.
1569 * Mark client as ready and send him any buffered data we could have for him.
1571 * @param ch Channel.
1572 * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by dest and go BCK)
1575 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1577 struct MeshChannelReliability *rel;
1578 struct MeshClient *c;
1580 rel = fwd ? ch->dest_rel : ch->root_rel;
1581 c = fwd ? ch->dest : ch->root;
1583 rel->client_ready = GNUNET_YES;
1584 send_client_buffered_data (ch, c, fwd);
1585 if (is_loopback (ch))
1587 unsigned int buffer;
1589 buffer = GMCH_get_buffer (ch, fwd);
1591 GMCH_allow_client (ch, fwd);
1595 GMT_send_connection_acks (ch->t);
1600 * Handle data given by a client.
1602 * Check whether the client is allowed to send in this tunnel, save if channel
1603 * is reliable and send an ACK to the client if there is still buffer space
1606 * @param ch Channel.
1607 * @param c Client which sent the data.
1608 * @param message Message.
1609 * @param fwd Is this a FWD data?
1611 * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1614 GMCH_handle_local_data (struct MeshChannel *ch,
1615 struct MeshClient *c,
1616 struct GNUNET_MessageHeader *message,
1619 struct MeshChannelReliability *rel;
1620 struct GNUNET_MESH_Data *payload;
1621 size_t size = ntohs (message->size);
1622 uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1623 unsigned char cbuf[p2p_size];
1625 /* Is the client in the channel? */
1632 GNUNET_break_op (0);
1633 return GNUNET_SYSERR;
1636 rel = fwd ? ch->root_rel : ch->dest_rel;
1638 if (GNUNET_NO == rel->client_allowed)
1640 GNUNET_break_op (0);
1641 return GNUNET_SYSERR;
1644 rel->client_allowed = GNUNET_NO;
1646 /* Ok, everything is correct, send the message. */
1647 payload = (struct GNUNET_MESH_Data *) cbuf;
1648 payload->mid = htonl (rel->mid_send);
1650 memcpy (&payload[1], message, size);
1651 payload->header.size = htons (p2p_size);
1652 payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1653 payload->chid = htonl (ch->gid);
1654 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channel...\n");
1655 GMCH_send_prebuilt_message (&payload->header, ch, fwd, NULL);
1657 if (is_loopback (ch))
1659 if (GMCH_get_buffer (ch, fwd) > 0)
1660 send_client_ack (ch, fwd);
1665 if (GMT_get_connections_buffer (ch->t) > 0)
1667 send_client_ack (ch, fwd);
1675 * Handle a channel destroy requested by a client.
1677 * Destroy the channel and the tunnel in case this was the last channel.
1679 * @param ch Channel.
1680 * @param c Client that requested the destruction (to avoid notifying him).
1681 * @param is_root Is the request coming from root?
1684 GMCH_handle_local_destroy (struct MeshChannel *ch,
1685 struct MeshClient *c,
1688 struct MeshTunnel3 *t;
1690 ch->destroy = GNUNET_YES;
1691 /* Cleanup after the tunnel */
1692 if (GNUNET_NO == is_root && c == ch->dest)
1694 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1695 GML_client_delete_channel (c, ch, ch->lid_dest);
1698 if (GNUNET_YES == is_root && c == ch->root)
1700 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1701 GML_client_delete_channel (c, ch, ch->lid_root);
1706 send_destroy (ch, GNUNET_NO);
1707 if (0 == ch->pending_messages)
1710 GMT_destroy_if_empty (t);
1716 * Handle a channel create requested by a client.
1718 * Create the channel and the tunnel in case this was the first0 channel.
1720 * @param c Client that requested the creation (will be the root).
1721 * @param msg Create Channel message.
1723 * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1726 GMCH_handle_local_create (struct MeshClient *c,
1727 struct GNUNET_MESH_ChannelMessage *msg)
1729 struct MeshChannel *ch;
1730 struct MeshTunnel3 *t;
1731 struct MeshPeer *peer;
1732 MESH_ChannelNumber chid;
1734 LOG (GNUNET_ERROR_TYPE_DEBUG, " towards %s:%u\n",
1735 GNUNET_i2s (&msg->peer), ntohl (msg->port));
1736 chid = ntohl (msg->channel_id);
1738 /* Sanity check for duplicate channel IDs */
1739 if (NULL != GML_channel_get (c, chid))
1742 return GNUNET_SYSERR;
1745 peer = GMP_get (&msg->peer);
1746 GMP_add_tunnel (peer);
1747 t = GMP_get_tunnel (peer);
1749 if (GMP_get_short_id (peer) == myid)
1751 GMT_change_cstate (t, MESH_TUNNEL3_READY);
1758 /* Create channel */
1759 ch = channel_new (t, c, chid);
1763 return GNUNET_SYSERR;
1765 ch->port = ntohl (msg->port);
1766 channel_set_options (ch, ntohl (msg->opt));
1768 /* In unreliable channels, we'll use the DLL to buffer BCK data */
1769 ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1770 ch->root_rel->ch = ch;
1771 ch->root_rel->retry_timer = GNUNET_TIME_UNIT_SECONDS;
1772 ch->root_rel->expected_delay.rel_value_us = 0;
1774 LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1783 * Handler for mesh network payload traffic.
1785 * @param ch Channel for the message.
1786 * @param msg Unencryted data message.
1787 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1788 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1789 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1790 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1793 GMCH_handle_data (struct MeshChannel *ch,
1794 const struct GNUNET_MESH_Data *msg,
1797 struct MeshChannelReliability *rel;
1798 struct MeshClient *c;
1801 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1802 if (GNUNET_SYSERR == fwd)
1804 if (is_loopback (ch))
1806 /* It is a loopback channel after all... */
1810 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
1813 /* Initialize FWD/BCK data */
1814 c = fwd ? ch->dest : ch->root;
1815 rel = fwd ? ch->dest_rel : ch->root_rel;
1823 GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1825 mid = ntohl (msg->mid);
1826 LOG (GNUNET_ERROR_TYPE_DEBUG, "!! got mid %u\n", mid);
1828 if (GNUNET_NO == ch->reliable ||
1829 ( !GM_is_pid_bigger (rel->mid_recv, mid) &&
1830 GM_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1832 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1833 if (GNUNET_YES == ch->reliable)
1835 /* Is this the exact next expected messasge? */
1836 if (mid == rel->mid_recv)
1838 LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1840 send_client_data (ch, msg, fwd);
1844 LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1845 add_buffered_data (msg, rel);
1850 /* Tunnel is unreliable: send to clients directly */
1851 /* FIXME: accept Out Of Order traffic */
1852 rel->mid_recv = mid + 1;
1853 send_client_data (ch, msg, fwd);
1858 GNUNET_break_op (GM_is_pid_bigger (rel->mid_recv, mid));
1859 LOG (GNUNET_ERROR_TYPE_DEBUG,
1860 " !!! MID %u not expected (%u - %u), dropping!\n",
1861 mid, rel->mid_recv, rel->mid_recv + 63);
1864 GMCH_send_data_ack (ch, fwd);
1869 * Handler for mesh network traffic end-to-end ACKs.
1871 * @param ch Channel on which we got this message.
1872 * @param msg Data message.
1873 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1874 * #GNUNET_YES if message is FWD on the respective channel (loopback)
1875 * #GNUNET_NO if message is BCK on the respective channel (loopback)
1876 * #GNUNET_SYSERR if message on a one-ended channel (remote)
1879 GMCH_handle_data_ack (struct MeshChannel *ch,
1880 const struct GNUNET_MESH_DataACK *msg,
1883 struct MeshChannelReliability *rel;
1884 struct MeshReliableMessage *copy;
1885 struct MeshReliableMessage *next;
1889 /* If this is a remote (non-loopback) channel, find 'fwd'. */
1890 if (GNUNET_SYSERR == fwd)
1892 if (is_loopback (ch))
1894 /* It is a loopback channel after all... */
1898 /* Inverted: if message came 'FWD' is a 'BCK ACK'. */
1899 fwd = (NULL != ch->dest) ? GNUNET_NO : GNUNET_YES;
1902 ack = ntohl (msg->mid);
1903 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1904 (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1906 if (GNUNET_YES == fwd)
1916 GNUNET_break_op (0);
1920 /* Free ACK'd copies: no need to retransmit those anymore */
1921 for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
1923 if (GM_is_pid_bigger (copy->mid, ack))
1925 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! head %u, out!\n", copy->mid);
1926 channel_rel_free_sent (rel, msg);
1930 LOG (GNUNET_ERROR_TYPE_DEBUG, " !! id %u\n", copy->mid);
1932 rel_message_free (copy, GNUNET_YES);
1935 /* ACK client if needed */
1936 GMCH_allow_client (ch, fwd);
1938 /* If some message was free'd, update the retransmission delay */
1939 if (GNUNET_YES == work)
1941 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1943 GNUNET_SCHEDULER_cancel (rel->retry_task);
1944 if (NULL != rel->head_sent && NULL == rel->head_sent->q)
1946 struct GNUNET_TIME_Absolute new_target;
1947 struct GNUNET_TIME_Relative delay;
1949 delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
1950 MESH_RETRANSMIT_MARGIN);
1951 new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
1953 delay = GNUNET_TIME_absolute_get_remaining (new_target);
1955 GNUNET_SCHEDULER_add_delayed (delay,
1956 &channel_retransmit_message,
1959 else /* either no more traffic to ack or traffic has just been queued */
1961 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1964 else /* work was done but no task was pending? shouldn't happen! */
1973 * Handler for channel create messages.
1975 * Does not have fwd parameter because it's always 'FWD': channel is incoming.
1977 * @param t Tunnel this channel will be in.
1978 * @param msg Channel crate message.
1980 struct MeshChannel *
1981 GMCH_handle_create (struct MeshTunnel3 *t,
1982 const struct GNUNET_MESH_ChannelCreate *msg)
1984 MESH_ChannelNumber chid;
1985 struct MeshChannel *ch;
1986 struct MeshClient *c;
1988 chid = ntohl (msg->chid);
1990 ch = GMT_get_channel (t, chid);
1993 /* Create channel */
1994 ch = channel_new (t, NULL, 0);
1997 channel_set_options (ch, ntohl (msg->opt));
1999 /* Find a destination client */
2000 ch->port = ntohl (msg->port);
2001 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n", ch->port);
2002 c = GML_client_get_by_port (ch->port);
2005 LOG (GNUNET_ERROR_TYPE_DEBUG, " no client has port registered\n");
2006 if (is_loopback (ch))
2008 LOG (GNUNET_ERROR_TYPE_DEBUG, " loopback: destroy on handler\n");
2013 LOG (GNUNET_ERROR_TYPE_DEBUG, " not loopback: destroy now\n");
2021 LOG (GNUNET_ERROR_TYPE_DEBUG, " client %p has port registered\n", c);
2024 add_destination (ch, c);
2025 if (GNUNET_YES == ch->reliable)
2026 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
2028 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Not Reliable\n");
2030 send_client_create (ch);
2031 send_ack (ch, GNUNET_YES);
2038 * Handler for channel NACK messages.
2040 * NACK messages always go dest -> root, no need for 'fwd' or 'msg' parameter.
2042 * @param ch Channel.
2045 GMCH_handle_nack (struct MeshChannel *ch)
2047 send_client_nack (ch);
2053 * Handler for channel ack messages.
2055 * @param ch Channel.
2056 * @param msg Message.
2057 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2058 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2059 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2060 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2063 GMCH_handle_ack (struct MeshChannel *ch,
2064 const struct GNUNET_MESH_ChannelManage *msg,
2067 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2068 if (GNUNET_SYSERR == fwd)
2070 if (is_loopback (ch))
2072 /* It is a loopback channel after all... */
2076 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2079 channel_confirm (ch, !fwd);
2084 * Handler for channel destroy messages.
2086 * @param ch Channel to be destroyed of.
2087 * @param msg Message.
2088 * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2089 * #GNUNET_YES if message is FWD on the respective channel (loopback)
2090 * #GNUNET_NO if message is BCK on the respective channel (loopback)
2091 * #GNUNET_SYSERR if message on a one-ended channel (remote)
2094 GMCH_handle_destroy (struct MeshChannel *ch,
2095 const struct GNUNET_MESH_ChannelManage *msg,
2098 struct MeshTunnel3 *t;
2100 /* If this is a remote (non-loopback) channel, find 'fwd'. */
2101 if (GNUNET_SYSERR == fwd)
2103 if (is_loopback (ch))
2105 /* It is a loopback channel after all... */
2109 fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2113 if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
2115 /* Not for us (don't destroy twice a half-open loopback channel) */
2120 send_destroy (ch, GNUNET_YES);
2122 GMT_destroy_if_empty (t);
2127 * Sends an already built message on a channel.
2129 * If the channel is on a loopback tunnel, notifies the appropriate destination
2132 * On a normal channel passes the message to the tunnel for encryption and
2133 * sending on a connection.
2135 * This function DOES NOT save the message for retransmission.
2137 * @param message Message to send. Function makes a copy of it.
2138 * @param ch Channel on which this message is transmitted.
2139 * @param fwd Is this a fwd message?
2140 * @param existing_copy This is a retransmission, don't save a copy.
2143 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2144 struct MeshChannel *ch, int fwd,
2145 void *existing_copy)
2147 struct MeshChannelQueue *q;
2150 type = ntohs (message->type);
2151 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH Send %s %s on channel %s\n",
2152 GM_f2s (fwd), GM_m2s (type),
2155 if (GMT_is_loopback (ch->t))
2157 handle_loopback (ch, message, fwd);
2163 case GNUNET_MESSAGE_TYPE_MESH_DATA:
2165 if (GNUNET_YES == ch->reliable)
2167 q = GNUNET_new (struct MeshChannelQueue);
2169 if (NULL == existing_copy)
2170 q->copy = channel_save_copy (ch, message, fwd);
2173 q->copy = (struct MeshReliableMessage *) existing_copy;
2174 if (NULL != q->copy->q)
2176 /* Last retransmission was queued but not yet sent!
2177 * This retransmission was scheduled by a ch_message_sent which
2178 * followed a very fast RTT, so the tiny delay made the
2179 * retransmission function to execute before the previous
2180 * retransmitted message even had a chance to leave the peer.
2181 * Cancel this message and wait until the pending
2182 * retransmission leaves the peer and ch_message_sent starts
2183 * the timer for the next one.
2186 LOG (GNUNET_ERROR_TYPE_DEBUG,
2187 " exisitng copy not yet transmitted!\n");
2190 LOG (GNUNET_ERROR_TYPE_DEBUG,
2191 " using existing copy: %p {r:%p q:%p t:%u}\n",
2193 q->copy->rel, q->copy->q, q->copy->type);
2195 LOG (GNUNET_ERROR_TYPE_DEBUG, " new q: %p\n", q);
2197 q->q = GMT_send_prebuilt_message (message, ch->t, ch,
2198 NULL != existing_copy,
2199 &ch_message_sent, q);
2200 /* q itself is stored in copy */
2204 fire_and_forget (message, ch, GNUNET_NO);
2209 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
2210 if (GNUNET_YES == fwd)
2212 /* BCK ACK (going FWD) is just a response for a SYNACK, don't keep*/
2213 fire_and_forget (message, ch, GNUNET_YES);
2217 case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
2218 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
2219 q = GNUNET_new (struct MeshChannelQueue);
2221 q->rel = fwd ? ch->root_rel : ch->dest_rel;
2222 if (NULL != q->rel->uniq)
2224 if (NULL != q->rel->uniq->q)
2226 GMT_cancel (q->rel->uniq->q);
2227 /* ch_message_sent is called, freeing and NULLing uniq */
2231 GNUNET_free (q->rel->uniq);
2234 q->q = GMT_send_prebuilt_message (message, ch->t, ch, GNUNET_YES,
2235 &ch_message_sent, q);
2240 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
2241 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
2242 fire_and_forget (message, ch, GNUNET_YES);
2248 LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s unknown!\n", GM_m2s (type));
2249 fire_and_forget (message, ch, GNUNET_YES);
2255 * Get the static string for identification of the channel.
2257 * @param ch Channel.
2259 * @return Static string with the channel IDs.
2262 GMCH_2s (const struct MeshChannel *ch)
2264 static char buf[64];
2267 return "(NULL Channel)";
2269 sprintf (buf, "%s:%u gid:%X (%X / %X)",
2270 GMT_2s (ch->t), ch->port, ch->gid, ch->lid_root, ch->lid_dest);