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_enc.h"
30 #include "gnunet-service-mesh_channel.h"
31 #include "gnunet-service-mesh_local.h"
32 #include "gnunet-service-mesh_tunnel.h"
34 #define LOG(level, ...) GNUNET_log_from(level,"mesh-chn",__VA_ARGS__)
37 * All the states a connection can be in.
42 * Uninitialized status, should never appear in operation.
47 * Connection create message sent, waiting for ACK.
52 * Connection confirmed, ready to carry traffic..
60 * Info needed to retry a message in case it gets lost.
62 struct MeshReliableMessage
65 * Double linked list, FIFO style
67 struct MeshReliableMessage *next;
68 struct MeshReliableMessage *prev;
71 * Type of message (payload, channel management).
76 * Tunnel Reliability queue this message is in.
78 struct MeshChannelReliability *rel;
81 * ID of the message (ACK needed to free)
86 * When was this message issued (to calculate ACK delay)
88 struct GNUNET_TIME_Absolute timestamp;
90 /* struct GNUNET_MESH_Data with payload */
95 * Info about the traffic state for a client in a channel.
97 struct MeshChannelReliability
100 * Channel this is about.
102 struct MeshChannel *ch;
105 * DLL of messages sent and not yet ACK'd.
107 struct MeshReliableMessage *head_sent;
108 struct MeshReliableMessage *tail_sent;
111 * Messages pending to send.
116 * DLL of messages received out of order.
118 struct MeshReliableMessage *head_recv;
119 struct MeshReliableMessage *tail_recv;
127 * Next MID to use for outgoing traffic.
132 * Next MID expected for incoming traffic.
137 * Can we send data to the client?
142 * Task to resend/poll in case no ACK is received.
144 GNUNET_SCHEDULER_TaskIdentifier retry_task;
147 * Counter for exponential backoff.
149 struct GNUNET_TIME_Relative retry_timer;
152 * How long does it usually take to get an ACK.
154 struct GNUNET_TIME_Relative expected_delay;
159 * Struct containing all information regarding a channel to a remote client.
164 * Tunnel this channel is in.
166 struct MeshTunnel3 *t;
169 * Destination port of the channel.
174 * Global channel number ( < GNUNET_MESH_LOCAL_CHANNEL_ID_CLI)
176 MESH_ChannelNumber gid;
179 * Local tunnel number for root (owner) client.
180 * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_CLI or 0 )
182 MESH_ChannelNumber lid_root;
185 * Local tunnel number for local destination clients (incoming number)
186 * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV or 0).
188 MESH_ChannelNumber lid_dest;
193 enum MeshChannelState state;
196 * Is the tunnel bufferless (minimum latency)?
201 * Is the tunnel reliable?
206 * Last time the channel was used
208 struct GNUNET_TIME_Absolute timestamp;
211 * Client owner of the tunnel, if any
213 struct MeshClient *root;
216 * Client destination of the tunnel, if any.
218 struct MeshClient *dest;
221 * Flag to signal the destruction of the channel.
222 * If this is set GNUNET_YES the channel will be destroyed
223 * when the queue is empty.
228 * Total messages pending for this channel, payload or not.
230 unsigned int pending_messages;
234 * Only present (non-NULL) at the owner of a tunnel.
236 struct MeshChannelReliability *root_rel;
240 * Only present (non-NULL) at the destination of a tunnel.
242 struct MeshChannelReliability *dest_rel;
247 /******************************************************************************/
248 /******************************* GLOBALS ***********************************/
249 /******************************************************************************/
252 * Global handle to the statistics service.
254 extern struct GNUNET_STATISTICS_Handle *stats;
257 /******************************************************************************/
258 /******************************** STATIC ***********************************/
259 /******************************************************************************/
262 * We have received a message out of order, or the client is not ready.
263 * Buffer it until we receive an ACK from the client or the missing
264 * message from the channel.
266 * @param msg Message to buffer (MUST be of type MESH_DATA).
267 * @param rel Reliability data to the corresponding direction.
270 add_buffered_data (const struct GNUNET_MESH_Data *msg,
271 struct MeshChannelReliability *rel)
273 struct MeshReliableMessage *copy;
274 struct MeshReliableMessage *prev;
278 size = ntohs (msg->header.size);
279 mid = ntohl (msg->mid);
281 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
283 copy = GNUNET_malloc (sizeof (*copy) + size);
286 memcpy (©[1], msg, size);
290 // FIXME do something better than O(n), although n < 64...
291 // FIXME start from the end (most messages are the latest ones)
292 for (prev = rel->head_recv; NULL != prev; prev = prev->next)
294 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
295 if (GMC_is_pid_bigger (prev->mid, mid))
297 LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
298 GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
303 LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
304 GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
305 LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
310 * Send data to a client.
312 * If the client is ready, send directly, otherwise buffer while listening
316 * @param msg Message.
317 * @param fwd Is this a fwd (root->dest) message?
320 send_client_data (struct MeshChannel *ch,
321 const struct GNUNET_MESH_Data *msg,
326 if (ch->dest_rel->client_ready)
327 GML_send_data (ch, msg, ch->dest, ch->lid_dest);
329 add_buffered_data (msg, ch->dest_rel);
333 if (ch->root_rel->client_ready)
334 GML_send_data (ch, msg, ch->root, ch->lid_root);
336 add_buffered_data (msg, ch->root_rel);
342 * Search for a channel among the channels for a client
344 * @param c the client whose channels to search in
345 * @param chid the local id of the channel
347 * @return channel handler, NULL if doesn't exist
349 static struct MeshChannel *
350 channel_get_by_local_id (struct MeshClient *c, MESH_ChannelNumber chid)
352 LOG (GNUNET_ERROR_TYPE_DEBUG, " -- get CHID %X\n", chid);
353 if (0 == (chid & GNUNET_MESH_LOCAL_CHANNEL_ID_CLI))
356 LOG (GNUNET_ERROR_TYPE_DEBUG, "CHID %X not a local chid\n", chid);
359 if (chid >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV)
360 return GNUNET_CONTAINER_multihashmap32_get (c->incoming_channels, chid);
361 return GNUNET_CONTAINER_multihashmap32_get (c->own_channels, chid);
366 * Add a client to a channel, initializing all needed data structures.
368 * @param ch Channel to which add the client.
369 * @param c Client which to add to the channel.
372 channel_add_client (struct MeshChannel *ch, struct MeshClient *c)
374 struct MeshTunnel3 *t = ch->t;
376 if (NULL != ch->dest)
382 /* Assign local id as destination */
383 while (NULL != channel_get_by_local_id (c, t->next_local_chid))
384 t->next_local_chid = (t->next_local_chid + 1) | GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
385 ch->lid_dest = t->next_local_chid++;
386 t->next_local_chid = t->next_local_chid | GNUNET_MESH_LOCAL_CHANNEL_ID_SERV;
388 /* Store in client's hashmap */
390 GNUNET_CONTAINER_multihashmap32_put (c->incoming_channels,
392 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
398 GNUNET_break (NULL == ch->dest_rel);
399 ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
400 ch->dest_rel->ch = ch;
401 ch->dest_rel->expected_delay = MESH_RETRANSMIT_TIME;
408 * Destroy all reliable messages queued for a channel,
409 * during a channel destruction.
410 * Frees the reliability structure itself.
412 * @param rel Reliability data for a channel.
415 channel_rel_free_all (struct MeshChannelReliability *rel)
417 struct MeshReliableMessage *copy;
418 struct MeshReliableMessage *next;
423 for (copy = rel->head_recv; NULL != copy; copy = next)
426 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
429 for (copy = rel->head_sent; NULL != copy; copy = next)
432 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
435 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
436 GNUNET_SCHEDULER_cancel (rel->retry_task);
442 * Mark future messages as ACK'd.
444 * @param rel Reliability data.
445 * @param msg DataACK message with a bitfield of future ACK'd messages.
448 channel_rel_free_sent (struct MeshChannelReliability *rel,
449 const struct GNUNET_MESH_DataACK *msg)
451 struct MeshReliableMessage *copy;
452 struct MeshReliableMessage *next;
459 bitfield = msg->futures;
460 mid = ntohl (msg->mid);
461 LOG (GNUNET_ERROR_TYPE_DEBUG,
462 "free_sent_reliable %u %llX\n",
464 LOG (GNUNET_ERROR_TYPE_DEBUG,
465 " rel %p, head %p\n",
466 rel, rel->head_sent);
467 for (i = 0, copy = rel->head_sent;
468 i < 64 && NULL != copy && 0 != bitfield;
471 LOG (GNUNET_ERROR_TYPE_DEBUG,
472 " trying bit %u (mid %u)\n",
475 if (0 == (bitfield & mask))
478 LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
479 /* Bit was set, clear the bit from the bitfield */
482 /* The i-th bit was set. Do we have that copy? */
483 /* Skip copies with mid < target */
484 target = mid + i + 1;
485 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
486 while (NULL != copy && GMC_is_pid_bigger (target, copy->mid))
489 /* Did we run out of copies? (previously freed, it's ok) */
492 LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
496 /* Did we overshoot the target? (previously freed, it's ok) */
497 if (GMC_is_pid_bigger (copy->mid, target))
499 LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
503 /* Now copy->mid == target, free it */
505 rel_message_free (copy);
508 LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
513 * We haven't received an ACK after a certain time: restransmit the message.
515 * @param cls Closure (MeshReliableMessage with the message to restransmit)
516 * @param tc TaskContext.
519 channel_retransmit_message (void *cls,
520 const struct GNUNET_SCHEDULER_TaskContext *tc)
522 struct MeshChannelReliability *rel = cls;
523 struct MeshReliableMessage *copy;
524 struct MeshPeerQueue *q;
525 struct MeshChannel *ch;
526 struct MeshConnection *c;
527 struct GNUNET_MESH_Data *payload;
528 struct MeshPeer *hop;
531 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
532 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
536 copy = rel->head_sent;
543 /* Search the message to be retransmitted in the outgoing queue.
544 * Check only the queue for the connection that is going to be used,
545 * if the message is stuck in some other connection's queue we shouldn't
547 * - cancelling it and sending the new one doesn't guarantee it's delivery,
548 * the old connection could be temporary stalled or the queue happened to
549 * be long at time of insertion.
550 * - not sending the new one could cause terrible delays the old connection
553 payload = (struct GNUNET_MESH_Data *) ©[1];
554 fwd = (rel == ch->root_rel);
555 c = tunnel_get_connection (ch->t, fwd);
556 hop = connection_get_hop (c, fwd);
557 for (q = hop->queue_head; NULL != q; q = q->next)
559 if (ntohs (payload->header.type) == q->type && ch == q->ch)
561 struct GNUNET_MESH_Data *queued_data = q->cls;
563 if (queued_data->mid == payload->mid)
568 /* Message not found in the queue that we are going to use. */
571 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
573 send_prebuilt_message_channel (&payload->header, ch, fwd);
574 GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
578 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! ALREADY IN QUEUE %u\n", copy->mid);
581 rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
582 rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
583 &channel_retransmit_message,
589 * Send ACK on one or more connections due to buffer space to the client.
591 * Iterates all connections of the tunnel and sends ACKs appropriately.
593 * @param ch Channel which has some free buffer space.
594 * @param fwd Is this in for FWD traffic? (ACK goes dest->root)
597 channel_send_connections_ack (struct MeshChannel *ch,
601 struct MeshTunnel3 *t = ch->t;
602 struct MeshConnection *c;
603 struct MeshFlowControl *fc;
606 uint32_t allow_per_connection;
609 LOG (GNUNET_ERROR_TYPE_DEBUG,
610 "Channel send connection %s ack on %s:%X\n",
611 fwd ? "FWD" : "BCK", peer2s (ch->t->peer), ch->gid);
613 /* Count connections, how many messages are already allowed */
614 for (cs = 0, allowed = 0, c = t->connection_head; NULL != c; c = c->next)
616 fc = fwd ? &c->fwd_fc : &c->bck_fc;
617 if (GMC_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
622 allowed += fc->last_ack_sent - fc->last_pid_recv;
626 /* Make sure there is no overflow */
627 if (allowed > buffer)
633 /* Authorize connections to send more data */
634 to_allow = buffer - allowed;
636 for (c = t->connection_head; NULL != c && to_allow > 0; c = c->next)
638 allow_per_connection = to_allow/cs;
639 to_allow -= allow_per_connection;
641 fc = fwd ? &c->fwd_fc : &c->bck_fc;
642 if (fc->last_ack_sent - fc->last_pid_recv > 64 / 3)
646 connection_send_ack (c, allow_per_connection, fwd);
649 LOG (GNUNET_ERROR_TYPE_DEBUG,
650 "Channel send connection %s ack on %s:%X\n",
651 fwd ? "FWD" : "BCK", peer2s (ch->t->peer), ch->gid);
652 GNUNET_break (to_allow == 0);
657 * Destroy a reliable message after it has been acknowledged, either by
658 * direct mid ACK or bitfield. Updates the appropriate data structures and
659 * timers and frees all memory.
661 * @param copy Message that is no longer needed: remote peer got it.
664 rel_message_free (struct MeshReliableMessage *copy)
666 struct MeshChannelReliability *rel;
667 struct GNUNET_TIME_Relative time;
670 time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
671 rel->expected_delay.rel_value_us *= 7;
672 rel->expected_delay.rel_value_us += time.rel_value_us;
673 rel->expected_delay.rel_value_us /= 8;
675 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
676 LOG (GNUNET_ERROR_TYPE_DEBUG, " n_sent %u\n", rel->n_sent);
677 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! took %s\n",
678 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
679 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! new expected delay %s\n",
680 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
682 rel->retry_timer = rel->expected_delay;
683 GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
690 * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
692 * @param ch Channel to mark as ready.
693 * @param fwd Was the CREATE message sent fwd?
696 channel_confirm (struct MeshChannel *ch, int fwd)
698 struct MeshChannelReliability *rel;
699 struct MeshReliableMessage *copy;
700 struct MeshReliableMessage *next;
702 LOG (GNUNET_ERROR_TYPE_DEBUG,
703 " channel confirm %s %s:%X\n",
704 fwd ? "FWD" : "BCK", peer2s (ch->t->peer), ch->gid);
705 ch->state = MESH_CHANNEL_READY;
707 rel = fwd ? ch->root_rel : ch->dest_rel;
708 for (copy = rel->head_sent; NULL != copy; copy = next)
710 struct GNUNET_MessageHeader *msg;
713 msg = (struct GNUNET_MessageHeader *) ©[1];
714 if (ntohs (msg->type) == GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE)
716 rel_message_free (copy);
720 send_ack (NULL, ch, fwd);
725 * Save a copy to retransmit in case it gets lost.
727 * Initializes all needed callbacks and timers.
729 * @param ch Channel this message goes on.
730 * @param msg Message to copy.
731 * @param fwd Is this fwd traffic?
734 channel_save_copy (struct MeshChannel *ch,
735 const struct GNUNET_MessageHeader *msg,
738 struct MeshChannelReliability *rel;
739 struct MeshReliableMessage *copy;
744 rel = fwd ? ch->root_rel : ch->dest_rel;
746 type = ntohs (msg->type);
747 size = ntohs (msg->size);
749 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u\n", mid);
750 copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
752 copy->timestamp = GNUNET_TIME_absolute_get ();
755 memcpy (©[1], msg, size);
757 LOG (GNUNET_ERROR_TYPE_DEBUG, " n_sent %u\n", rel->n_sent);
758 GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
759 if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
762 GNUNET_TIME_relative_multiply (rel->expected_delay,
763 MESH_RETRANSMIT_MARGIN);
765 GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
766 &channel_retransmit_message,
774 * Send a buffered message to the client, for in order delivery or
775 * as result of client ACK.
777 * @param ch Channel on which to empty the message buffer.
778 * @param c Client to send to.
779 * @param rel Reliability structure to corresponding peer.
780 * If rel == bck_rel, this is FWD data.
783 send_client_buffered_data (struct MeshChannel *ch,
784 struct MeshClient *c,
787 struct MeshReliableMessage *copy;
788 struct MeshChannelReliability *rel;
790 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
791 rel = fwd ? ch->dest_rel : ch->root_rel;
792 if (GNUNET_NO == rel->client_ready)
794 LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
798 copy = rel->head_recv;
799 /* We never buffer channel management messages */
802 if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
804 struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) ©[1];
806 LOG (GNUNET_ERROR_TYPE_DEBUG,
807 " have %u! now expecting %u\n",
808 copy->mid, rel->mid_recv + 1);
809 send_client_data (ch, msg, fwd);
812 GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
817 LOG (GNUNET_ERROR_TYPE_DEBUG,
818 " reliable && don't have %u, next is %u\n",
824 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
831 * Destroy a channel and free all resources.
833 * @param ch Channel to destroy.
836 channel_destroy (struct MeshChannel *ch)
838 struct MeshClient *c;
843 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
844 peer2s (ch->t->peer), ch->gid);
850 if (GNUNET_YES != GNUNET_CONTAINER_multihashmap32_remove (c->own_channels,
861 GNUNET_CONTAINER_multihashmap32_remove (c->incoming_channels,
868 channel_rel_free_all (ch->root_rel);
869 channel_rel_free_all (ch->dest_rel);
871 GNUNET_CONTAINER_DLL_remove (ch->t->channel_head, ch->t->channel_tail, ch);
872 GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
879 * Create a new channel.
881 * @param t Tunnel this channel is in.
882 * @param owner Client that owns the channel, NULL for foreign channels.
883 * @param lid_root Local ID for root client.
885 * @return A new initialized channel. NULL on error.
887 static struct MeshChannel *
888 channel_new (struct MeshTunnel3 *t,
889 struct MeshClient *owner, MESH_ChannelNumber lid_root)
891 struct MeshChannel *ch;
893 ch = GNUNET_new (struct MeshChannel);
895 ch->lid_root = lid_root;
898 GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
902 while (NULL != channel_get (t, t->next_chid))
904 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists (%p)...\n",
905 t->next_chid, channel_get (t, t->next_chid));
906 t->next_chid = (t->next_chid + 1) & ~GNUNET_MESH_LOCAL_CHANNEL_ID_CLI;
908 ch->gid = t->next_chid;
909 t->next_chid = (t->next_chid + 1) & ~GNUNET_MESH_LOCAL_CHANNEL_ID_CLI;
912 GNUNET_CONTAINER_multihashmap32_put (owner->own_channels, lid_root, ch,
913 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
916 channel_destroy (ch);
917 GNUNET_SERVER_receive_done (owner->handle, GNUNET_SYSERR);
921 GNUNET_CONTAINER_DLL_insert (t->channel_head, t->channel_tail, ch);
928 * Set options in a channel, extracted from a bit flag field
930 * @param ch Channel to set options to.
931 * @param options Bit array in host byte order.
934 channel_set_options (struct MeshChannel *ch, uint32_t options)
936 ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
937 GNUNET_YES : GNUNET_NO;
938 ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
939 GNUNET_YES : GNUNET_NO;
945 * Confirm we got a channel create.
947 * @param ch The channel to confirm.
948 * @param fwd Should we send the ACK fwd?
951 channel_send_ack (struct MeshChannel *ch, int fwd)
953 struct GNUNET_MESH_ChannelManage msg;
955 msg.header.size = htons (sizeof (msg));
956 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
957 LOG (GNUNET_ERROR_TYPE_DEBUG,
958 " sending channel %s ack for channel %s:%X\n",
959 fwd ? "FWD" : "BCK", peer2s (ch->t->peer),
962 msg.chid = htonl (ch->gid);
963 GMCH_send_prebuilt_message (&msg.header, ch, !fwd);
968 * Send a message to all clients (local and remote) of this channel
969 * notifying that the channel is no longer valid.
971 * If some peer or client should not receive the message,
972 * should be zero'ed out before calling this function.
974 * @param ch The channel whose clients to notify.
977 channel_send_destroy (struct MeshChannel *ch)
979 struct GNUNET_MESH_ChannelManage msg;
981 msg.header.size = htons (sizeof (msg));
982 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
983 LOG (GNUNET_ERROR_TYPE_DEBUG,
984 " sending channel destroy for channel %s:%X\n",
985 peer2s (ch->t->peer),
988 if (channel_is_terminal (ch, GNUNET_NO))
990 if (NULL != ch->root && GNUNET_NO == ch->root->shutting_down)
992 msg.chid = htonl (ch->lid_root);
993 send_local_channel_destroy (ch, GNUNET_NO);
998 msg.chid = htonl (ch->gid);
999 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO);
1002 if (channel_is_terminal (ch, GNUNET_YES))
1004 if (NULL != ch->dest && GNUNET_NO == ch->dest->shutting_down)
1006 msg.chid = htonl (ch->lid_dest);
1007 send_local_channel_destroy (ch, GNUNET_YES);
1012 msg.chid = htonl (ch->gid);
1013 GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_YES);
1019 * Iterator for deleting each channel whose client endpoint disconnected.
1021 * @param cls Closure (client that has disconnected).
1022 * @param key The local channel id (used to access the hashmap).
1023 * @param value The value stored at the key (channel to destroy).
1025 * @return GNUNET_OK, keep iterating.
1028 channel_destroy_iterator (void *cls,
1032 struct MeshChannel *ch = value;
1033 struct MeshClient *c = cls;
1034 struct MeshTunnel3 *t;
1036 LOG (GNUNET_ERROR_TYPE_DEBUG,
1037 " Channel %X (%X / %X) destroy, due to client %u shutdown.\n",
1038 ch->gid, ch->lid_root, ch->lid_dest, c->id);
1043 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %u is destination.\n", c->id);
1047 LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %u is owner.\n", c->id);
1051 GMCH_send_destroy (ch);
1052 channel_send_destroy (ch);
1053 channel_destroy (ch);
1054 tunnel_destroy_if_empty (t);
1060 /******************************************************************************/
1061 /******************************** API ***********************************/
1062 /******************************************************************************/
1067 * @param ch Channel.
1072 GMCH_get_id (const struct MeshChannel *ch)
1079 * Get the channel tunnel.
1081 * @param ch Channel to get the tunnel from.
1083 * @return tunnel of the channel.
1085 struct MeshTunnel3 *
1086 GMCH_get_tunnel (const struct MeshChannel *ch)
1093 * Get free buffer space towards the client on a specific channel.
1095 * @param ch Channel.
1096 * @param fwd Is query about FWD traffic?
1098 * @return Free buffer space [0 - 64]
1101 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1103 struct MeshChannelReliability *rel;
1105 rel = fwd ? ch->dest_rel : ch->root_rel;
1107 /* If rel is NULL it means that the end is not yet created,
1108 * most probably is a loopback channel at the point of sending
1109 * the ChannelCreate to itself.
1114 return (64 - rel->n_recv);
1119 * Is the root client for this channel on this peer?
1121 * @param ch Channel.
1122 * @param fwd Is this for fwd traffic?
1124 * @return GNUNET_YES in case it is.
1127 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1129 struct MeshClient *c;
1131 c = fwd ? ch->root : ch->dest;
1137 * Is the destination client for this channel on this peer?
1139 * @param ch Channel.
1140 * @param fwd Is this for fwd traffic?
1142 * @return GNUNET_YES in case it is.
1145 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1147 struct MeshClient *c;
1149 c = fwd ? ch->dest : ch->root;
1155 * Notify the destination client that a new incoming channel was created.
1157 * @param ch Channel that was created.
1160 GMCH_send_create (struct MeshChannel *ch)
1162 struct GNUNET_MESH_ChannelMessage msg;
1163 struct MeshTunnel3 *t = ch->t;
1166 if (NULL == ch->dest)
1170 opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
1171 opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
1172 GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
1173 GNUNET_PEER_resolve2 (t->peer->id));
1178 * Notify a client that the channel is no longer valid.
1180 * @param ch Channel that is destroyed.
1181 * @param fwd Forward notification (owner->dest)?
1184 GMCH_send_destroy (struct MeshChannel *ch, int fwd)
1186 struct GNUNET_MeshClient *c = fwd ? ch->dest : ch->root;
1187 uint32_t id = fwd ? ch->lid_dest : ch->lid_root;
1191 // TODO: send on connection?
1195 GML_send_channel_destroy (c, id);
1200 * Send data on a channel.
1202 * If the destination is local, send it to client, otherwise encrypt and
1206 * @param msg Message.
1207 * @param fwd Is this a fwd (root->dest) message?
1210 GMCH_send_data (struct MeshChannel *ch,
1211 const struct GNUNET_MESH_Data *msg,
1218 * Send an end-to-end ACK message for the most recent in-sequence payload.
1220 * If channel is not reliable, do nothing.
1222 * @param ch Channel this is about.
1223 * @param fwd Is for FWD traffic? (ACK dest->owner)
1226 GMCH_send_ack (struct MeshChannel *ch, int fwd)
1228 struct GNUNET_MESH_DataACK msg;
1229 struct MeshChannelReliability *rel;
1230 struct MeshReliableMessage *copy;
1235 if (GNUNET_NO == ch->reliable)
1239 rel = fwd ? ch->dest_rel : ch->root_rel;
1240 LOG (GNUNET_ERROR_TYPE_DEBUG,
1241 "send_data_ack for %u\n",
1244 type = GNUNET_MESSAGE_TYPE_MESH_DATA_ACK;
1245 msg.header.type = htons (type);
1246 msg.header.size = htons (sizeof (msg));
1247 msg.chid = htonl (ch->gid);
1248 msg.mid = htonl (rel->mid_recv - 1);
1250 for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1252 if (copy->type != type)
1254 delta = copy->mid - rel->mid_recv;
1257 mask = 0x1LL << delta;
1258 msg.futures |= mask;
1259 LOG (GNUNET_ERROR_TYPE_DEBUG,
1260 " setting bit for %u (delta %u) (%llX) -> %llX\n",
1261 copy->mid, delta, mask, msg.futures);
1263 LOG (GNUNET_ERROR_TYPE_DEBUG, " final futures %llX\n", msg.futures);
1265 send_prebuilt_message_channel (&msg.header, ch, fwd);
1266 LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1273 * @param ch Channel.
1276 GMCH_debug (struct MeshChannel *ch)
1280 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1283 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1284 peer2s (ch->t->peer), ch->gid, ch);
1285 LOG (GNUNET_ERROR_TYPE_DEBUG, " root %p/%p\n",
1286 ch->root, ch->root_rel);
1287 if (NULL != ch->root)
1289 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %u\n", ch->root->id);
1290 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1291 ch->root_rel->client_ready ? "YES" : "NO");
1292 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_root);
1294 LOG (GNUNET_ERROR_TYPE_DEBUG, " dest %p/%p\n",
1295 ch->dest, ch->dest_rel);
1296 if (NULL != ch->dest)
1298 LOG (GNUNET_ERROR_TYPE_DEBUG, " cli %u\n", ch->dest->id);
1299 LOG (GNUNET_ERROR_TYPE_DEBUG, " ready %s\n",
1300 ch->dest_rel->client_ready ? "YES" : "NO");
1301 LOG (GNUNET_ERROR_TYPE_DEBUG, " id %X\n", ch->lid_dest);
1307 * Handler for mesh network payload traffic.
1309 * @param ch Channel for the message.
1310 * @param message Unencryted data message.
1311 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1314 GMCH_handle_data (struct MeshChannel *ch,
1315 const struct GNUNET_MESH_Data *msg,
1318 struct MeshChannelReliability *rel;
1319 struct MeshClient *c;
1324 /* Initialize FWD/BCK data */
1325 c = fwd ? ch->dest : ch->root;
1326 rel = fwd ? ch->dest_rel : ch->root_rel;
1334 GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1336 mid = ntohl (msg->mid);
1337 LOG (GNUNET_ERROR_TYPE_DEBUG, " mid %u\n", mid);
1339 if (GNUNET_NO == ch->reliable ||
1340 ( !GMC_is_pid_bigger (rel->mid_recv, mid) &&
1341 GMC_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1343 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1344 if (GNUNET_YES == ch->reliable)
1346 /* Is this the exact next expected messasge? */
1347 if (mid == rel->mid_recv)
1349 LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1351 send_client_data (ch, msg, fwd);
1355 LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1356 add_buffered_data (msg, rel);
1361 /* Tunnel is unreliable: send to clients directly */
1362 /* FIXME: accept Out Of Order traffic */
1363 rel->mid_recv = mid + 1;
1364 send_client_data (ch, msg, fwd);
1369 GNUNET_break_op (0);
1370 LOG (GNUNET_ERROR_TYPE_DEBUG,
1371 " MID %u not expected (%u - %u), dropping!\n",
1372 mid, rel->mid_recv, rel->mid_recv + 64);
1375 GMCH_send_ack (ch, fwd);
1380 * Handler for mesh network traffic end-to-end ACKs.
1382 * @param t Tunnel on which we got this message.
1383 * @param message Data message.
1384 * @param fwd Is this a fwd ACK? (dest->orig)
1387 GMCH_handle_data_ack (struct MeshChannel *ch,
1388 const struct GNUNET_MESH_DataACK *msg,
1391 struct MeshChannelReliability *rel;
1392 struct MeshReliableMessage *copy;
1393 struct MeshReliableMessage *next;
1397 ack = ntohl (msg->mid);
1398 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1399 (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1401 if (GNUNET_YES == fwd)
1415 for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
1417 if (GMC_is_pid_bigger (copy->mid, ack))
1419 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! head %u, out!\n", copy->mid);
1420 channel_rel_free_sent (rel, msg);
1424 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! id %u\n", copy->mid);
1426 rel_message_free (copy);
1428 /* ACK client if needed */
1429 // channel_send_ack (t, type, GNUNET_MESSAGE_TYPE_MESH_UNICAST_ACK == type);
1431 /* If some message was free'd, update the retransmission delay*/
1432 if (GNUNET_YES == work)
1434 if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1436 GNUNET_SCHEDULER_cancel (rel->retry_task);
1437 if (NULL == rel->head_sent)
1439 rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1443 struct GNUNET_TIME_Absolute new_target;
1444 struct GNUNET_TIME_Relative delay;
1446 delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
1447 MESH_RETRANSMIT_MARGIN);
1448 new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
1450 delay = GNUNET_TIME_absolute_get_remaining (new_target);
1452 GNUNET_SCHEDULER_add_delayed (delay,
1453 &channel_retransmit_message,
1464 * Handler for channel create messages.
1466 * @param t Tunnel this channel is to be created in.
1467 * @param msg Message.
1468 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1470 struct MeshChannel *
1471 GMCH_handle_create (const struct GNUNET_MESH_ChannelCreate *msg,
1474 MESH_ChannelNumber chid;
1475 struct MeshChannel *ch;
1476 struct MeshClient *c;
1479 /* Check if channel exists */
1480 chid = ntohl (msg->chid);
1482 /* Create channel */
1483 ch = channel_new (NULL, NULL, 0); /* FIXME t */
1485 channel_set_options (ch, ntohl (msg->opt));
1487 /* Find a destination client */
1488 port = ntohl (msg->port);
1489 LOG (GNUNET_ERROR_TYPE_DEBUG, " port %u\n", port);
1490 c = GML_client_get_by_port (port);
1493 /* TODO send reject */
1494 LOG (GNUNET_ERROR_TYPE_DEBUG, " no client has port registered\n");
1499 channel_add_client (ch, c);
1500 if (GNUNET_YES == ch->reliable)
1501 LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
1503 GMCH_send_create (ch);
1504 GMCH_send_ack (ch, fwd);
1505 GML_send_ack (ch, !fwd);
1512 * Handler for channel ack messages.
1514 * @param ch Channel.
1515 * @param msg Message.
1516 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1519 GMCH_handle_ack (struct MeshChannel *ch,
1520 const struct GNUNET_MESH_ChannelManage *msg,
1523 channel_confirm (ch, !fwd);
1528 * Handler for channel destroy messages.
1530 * @param ch Channel to be destroyed of.
1531 * @param msg Message.
1532 * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1535 GMCH_handle_destroy (struct MeshChannel *ch,
1536 const struct GNUNET_MESH_ChannelManage *msg,
1539 MESH_ChannelNumber chid;
1541 /* Check if channel exists */
1542 chid = ntohl (msg->chid);
1543 if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
1545 /* Not for us (don't destroy twice a half-open loopback channel) */
1549 GMCH_send_destroy (ch, fwd);
1550 channel_destroy (ch);
1555 * Sends an already built message on a channel, properly registering
1556 * all used resources and encrypting the message with the tunnel's key.
1558 * @param message Message to send. Function makes a copy of it.
1559 * @param ch Channel on which this message is transmitted.
1560 * @param fwd Is this a fwd message?
1563 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
1564 struct MeshChannel *ch, int fwd)
1566 struct GNUNET_MESH_Encrypted *msg;
1567 size_t size = ntohs (message->size);
1568 char *cbuf[sizeof (struct GNUNET_MESH_Encrypted) + size];
1572 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send on Channel %s:%X %s\n",
1573 peer2s (ch->t->peer), ch->gid, fwd ? "FWD" : "BCK");
1574 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n",
1575 GNUNET_MESH_DEBUG_M2S (ntohs (message->type)));
1577 if (channel_is_terminal (ch, fwd) || ch->t->peer->id == myid)
1579 GMT_handle_decrypted (ch->t, message, fwd);
1583 type = fwd ? GNUNET_MESSAGE_TYPE_MESH_FWD : GNUNET_MESSAGE_TYPE_MESH_BCK;
1584 iv = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_NONCE, UINT64_MAX);
1586 msg = (struct GNUNET_MESH_Encrypted *) cbuf;
1587 msg->header.type = htons (type);
1588 msg->header.size = htons (sizeof (struct GNUNET_MESH_Encrypted) + size);
1589 msg->iv = GNUNET_htonll (iv);
1590 GMT_encrypt (ch->t, &msg[1], message, size, iv, fwd);
1591 GMT_send_prebuilt_message (msg, ch->t, ch, fwd);