- avoid infinite ACK loops when creating loopback channels
[oweals/gnunet.git] / src / mesh / gnunet-service-mesh_channel.c
1 /*
2      This file is part of GNUnet.
3      (C) 2013 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21
22 #include "platform.h"
23 #include "gnunet_util_lib.h"
24
25 #include "gnunet_statistics_service.h"
26
27 #include "mesh_enc.h"
28 #include "mesh_protocol_enc.h"
29
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"
34
35 #define LOG(level, ...) GNUNET_log_from(level,"mesh-chn",__VA_ARGS__)
36
37 #define MESH_RETRANSMIT_TIME    GNUNET_TIME_UNIT_SECONDS
38 #define MESH_RETRANSMIT_MARGIN  4
39
40
41 /**
42  * All the states a connection can be in.
43  */
44 enum MeshChannelState
45 {
46   /**
47    * Uninitialized status, should never appear in operation.
48    */
49   MESH_CHANNEL_NEW,
50
51   /**
52    * Connection create message sent, waiting for ACK.
53    */
54   MESH_CHANNEL_SENT,
55
56   /**
57    * Connection confirmed, ready to carry traffic..
58    */
59   MESH_CHANNEL_READY,
60 };
61
62
63
64 /**
65  * Info needed to retry a message in case it gets lost.
66  */
67 struct MeshReliableMessage
68 {
69     /**
70      * Double linked list, FIFO style
71      */
72   struct MeshReliableMessage    *next;
73   struct MeshReliableMessage    *prev;
74
75     /**
76      * Type of message (payload, channel management).
77      */
78   int16_t type;
79
80     /**
81      * Tunnel Reliability queue this message is in.
82      */
83   struct MeshChannelReliability  *rel;
84
85     /**
86      * ID of the message (ACK needed to free)
87      */
88   uint32_t                      mid;
89
90     /**
91      * When was this message issued (to calculate ACK delay)
92      */
93   struct GNUNET_TIME_Absolute   timestamp;
94
95   /* struct GNUNET_MESH_Data with payload */
96 };
97
98
99 /**
100  * Info about the traffic state for a client in a channel.
101  */
102 struct MeshChannelReliability
103 {
104     /**
105      * Channel this is about.
106      */
107   struct MeshChannel *ch;
108
109     /**
110      * DLL of messages sent and not yet ACK'd.
111      */
112   struct MeshReliableMessage        *head_sent;
113   struct MeshReliableMessage        *tail_sent;
114
115     /**
116      * Messages pending to send.
117      */
118   unsigned int                      n_sent;
119
120     /**
121      * DLL of messages received out of order.
122      */
123   struct MeshReliableMessage        *head_recv;
124   struct MeshReliableMessage        *tail_recv;
125
126     /**
127      * Messages received.
128      */
129   unsigned int                      n_recv;
130
131     /**
132      * Next MID to use for outgoing traffic.
133      */
134   uint32_t                          mid_send;
135
136     /**
137      * Next MID expected for incoming traffic.
138      */
139   uint32_t                          mid_recv;
140
141     /**
142      * Can we send data to the client?
143      */
144   int                               client_ready;
145
146     /**
147      * Task to resend/poll in case no ACK is received.
148      */
149   GNUNET_SCHEDULER_TaskIdentifier   retry_task;
150
151     /**
152      * Counter for exponential backoff.
153      */
154   struct GNUNET_TIME_Relative       retry_timer;
155
156     /**
157      * How long does it usually take to get an ACK.
158      */
159   struct GNUNET_TIME_Relative       expected_delay;
160 };
161
162
163 /**
164  * Struct containing all information regarding a channel to a remote client.
165  */
166 struct MeshChannel
167 {
168     /**
169      * Tunnel this channel is in.
170      */
171   struct MeshTunnel3 *t;
172
173     /**
174      * Destination port of the channel.
175      */
176   uint32_t port;
177
178     /**
179      * Global channel number ( < GNUNET_MESH_LOCAL_CHANNEL_ID_CLI)
180      */
181   MESH_ChannelNumber gid;
182
183     /**
184      * Local tunnel number for root (owner) client.
185      * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_CLI or 0 )
186      */
187   MESH_ChannelNumber lid_root;
188
189     /**
190      * Local tunnel number for local destination clients (incoming number)
191      * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV or 0).
192      */
193   MESH_ChannelNumber lid_dest;
194
195     /**
196      * Channel state.
197      */
198   enum MeshChannelState state;
199
200     /**
201      * Is the tunnel bufferless (minimum latency)?
202      */
203   int nobuffer;
204
205     /**
206      * Is the tunnel reliable?
207      */
208   int reliable;
209
210     /**
211      * Last time the channel was used
212      */
213   struct GNUNET_TIME_Absolute timestamp;
214
215     /**
216      * Client owner of the tunnel, if any
217      */
218   struct MeshClient *root;
219
220     /**
221      * Client destination of the tunnel, if any.
222      */
223   struct MeshClient *dest;
224
225     /**
226      * Flag to signal the destruction of the channel.
227      * If this is set GNUNET_YES the channel will be destroyed
228      * when the queue is empty.
229      */
230   int destroy;
231
232     /**
233      * Total messages pending for this channel, payload or not.
234      */
235   unsigned int pending_messages;
236
237     /**
238      * Reliability data.
239      * Only present (non-NULL) at the owner of a tunnel.
240      */
241   struct MeshChannelReliability *root_rel;
242
243     /**
244      * Reliability data.
245      * Only present (non-NULL) at the destination of a tunnel.
246      */
247   struct MeshChannelReliability *dest_rel;
248
249 };
250
251
252 /******************************************************************************/
253 /*******************************   GLOBALS  ***********************************/
254 /******************************************************************************/
255
256 /**
257  * Global handle to the statistics service.
258  */
259 extern struct GNUNET_STATISTICS_Handle *stats;
260
261 /**
262  * Local peer own ID (memory efficient handle).
263  */
264 extern GNUNET_PEER_Id myid;
265
266
267 /******************************************************************************/
268 /********************************   STATIC  ***********************************/
269 /******************************************************************************/
270
271 /**
272  * Destroy a reliable message after it has been acknowledged, either by
273  * direct mid ACK or bitfield. Updates the appropriate data structures and
274  * timers and frees all memory.
275  *
276  * @param copy Message that is no longer needed: remote peer got it.
277  */
278 static void
279 rel_message_free (struct MeshReliableMessage *copy);
280
281 /**
282  * We have received a message out of order, or the client is not ready.
283  * Buffer it until we receive an ACK from the client or the missing
284  * message from the channel.
285  *
286  * @param msg Message to buffer (MUST be of type MESH_DATA).
287  * @param rel Reliability data to the corresponding direction.
288  */
289 static void
290 add_buffered_data (const struct GNUNET_MESH_Data *msg,
291                    struct MeshChannelReliability *rel)
292 {
293   struct MeshReliableMessage *copy;
294   struct MeshReliableMessage *prev;
295   uint32_t mid;
296   uint16_t size;
297
298   size = ntohs (msg->header.size);
299   mid = ntohl (msg->mid);
300
301   LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
302
303   copy = GNUNET_malloc (sizeof (*copy) + size);
304   copy->mid = mid;
305   copy->rel = rel;
306   memcpy (&copy[1], msg, size);
307
308   rel->n_recv++;
309
310   // FIXME do something better than O(n), although n < 64...
311   // FIXME start from the end (most messages are the latest ones)
312   for (prev = rel->head_recv; NULL != prev; prev = prev->next)
313   {
314     LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
315     if (GMC_is_pid_bigger (prev->mid, mid))
316     {
317       LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
318       GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
319                                           prev, copy);
320       return;
321     }
322   }
323     LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
324     GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
325     LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
326 }
327
328
329 /**
330  * Send data to a client.
331  *
332  * If the client is ready, send directly, otherwise buffer while listening
333  * for a local ACK.
334  *
335  * @param ch Channel
336  * @param msg Message.
337  * @param fwd Is this a fwd (root->dest) message?
338  */
339 static void
340 send_client_data (struct MeshChannel *ch,
341                   const struct GNUNET_MESH_Data *msg,
342                   int fwd)
343 {
344   if (fwd)
345   {
346     if (ch->dest_rel->client_ready)
347       GML_send_data (ch->dest, msg, ch->lid_dest);
348     else
349       add_buffered_data (msg, ch->dest_rel);
350   }
351   else
352   {
353     if (ch->root_rel->client_ready)
354       GML_send_data (ch->root, msg, ch->lid_root);
355     else
356       add_buffered_data (msg, ch->root_rel);
357   }
358 }
359
360
361 /**
362  * Add a client to a channel, initializing all needed data structures.
363  *
364  * @param ch Channel to which add the client.
365  * @param c Client which to add to the channel.
366  */
367 void
368 GMCH_add_client (struct MeshChannel *ch, struct MeshClient *c)
369 {
370   if (NULL != ch->dest)
371   {
372     GNUNET_break (0);
373     return;
374   }
375
376   /* Assign local id as destination */
377   ch->lid_dest = GML_get_next_chid (c);
378
379   /* Store in client's hashmap */
380   GML_channel_add (c, ch->lid_dest, ch);
381
382   GNUNET_break (NULL == ch->dest_rel);
383   ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
384   ch->dest_rel->ch = ch;
385   ch->dest_rel->expected_delay = MESH_RETRANSMIT_TIME;
386
387   ch->dest = c;
388 }
389
390
391 /**
392  * Destroy all reliable messages queued for a channel,
393  * during a channel destruction.
394  * Frees the reliability structure itself.
395  *
396  * @param rel Reliability data for a channel.
397  */
398 static void
399 channel_rel_free_all (struct MeshChannelReliability *rel)
400 {
401   struct MeshReliableMessage *copy;
402   struct MeshReliableMessage *next;
403
404   if (NULL == rel)
405     return;
406
407   for (copy = rel->head_recv; NULL != copy; copy = next)
408   {
409     next = copy->next;
410     GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
411     GNUNET_free (copy);
412   }
413   for (copy = rel->head_sent; NULL != copy; copy = next)
414   {
415     next = copy->next;
416     GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
417     GNUNET_free (copy);
418   }
419   if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
420     GNUNET_SCHEDULER_cancel (rel->retry_task);
421   GNUNET_free (rel);
422 }
423
424
425 /**
426  * Mark future messages as ACK'd.
427  *
428  * @param rel Reliability data.
429  * @param msg DataACK message with a bitfield of future ACK'd messages.
430  */
431 static void
432 channel_rel_free_sent (struct MeshChannelReliability *rel,
433                        const struct GNUNET_MESH_DataACK *msg)
434 {
435   struct MeshReliableMessage *copy;
436   struct MeshReliableMessage *next;
437   uint64_t bitfield;
438   uint64_t mask;
439   uint32_t mid;
440   uint32_t target;
441   unsigned int i;
442
443   bitfield = msg->futures;
444   mid = ntohl (msg->mid);
445   LOG (GNUNET_ERROR_TYPE_DEBUG,
446               "free_sent_reliable %u %llX\n",
447               mid, bitfield);
448   LOG (GNUNET_ERROR_TYPE_DEBUG,
449               " rel %p, head %p\n",
450               rel, rel->head_sent);
451   for (i = 0, copy = rel->head_sent;
452        i < 64 && NULL != copy && 0 != bitfield;
453        i++)
454   {
455     LOG (GNUNET_ERROR_TYPE_DEBUG,
456                 " trying bit %u (mid %u)\n",
457                 i, mid + i + 1);
458     mask = 0x1LL << i;
459     if (0 == (bitfield & mask))
460      continue;
461
462     LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
463     /* Bit was set, clear the bit from the bitfield */
464     bitfield &= ~mask;
465
466     /* The i-th bit was set. Do we have that copy? */
467     /* Skip copies with mid < target */
468     target = mid + i + 1;
469     LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
470     while (NULL != copy && GMC_is_pid_bigger (target, copy->mid))
471      copy = copy->next;
472
473     /* Did we run out of copies? (previously freed, it's ok) */
474     if (NULL == copy)
475     {
476      LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
477      return;
478     }
479
480     /* Did we overshoot the target? (previously freed, it's ok) */
481     if (GMC_is_pid_bigger (copy->mid, target))
482     {
483      LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
484      continue;
485     }
486
487     /* Now copy->mid == target, free it */
488     next = copy->next;
489     rel_message_free (copy);
490     copy = next;
491   }
492   LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
493 }
494
495
496 /**
497  * We haven't received an ACK after a certain time: restransmit the message.
498  *
499  * @param cls Closure (MeshReliableMessage with the message to restransmit)
500  * @param tc TaskContext.
501  */
502 static void
503 channel_retransmit_message (void *cls,
504                             const struct GNUNET_SCHEDULER_TaskContext *tc)
505 {
506   struct MeshChannelReliability *rel = cls;
507   struct MeshReliableMessage *copy;
508   struct MeshChannel *ch;
509   struct GNUNET_MESH_Data *payload;
510   int fwd;
511
512   rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
513   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
514     return;
515
516   ch = rel->ch;
517   copy = rel->head_sent;
518   if (NULL == copy)
519   {
520     GNUNET_break (0);
521     return;
522   }
523
524   /* Search the message to be retransmitted in the outgoing queue.
525    * Check only the queue for the connection that is going to be used,
526    * if the message is stuck in some other connection's queue we shouldn't
527    * act upon it:
528    * - cancelling it and sending the new one doesn't guarantee it's delivery,
529    *   the old connection could be temporary stalled or the queue happened to
530    *   be long at time of insertion.
531    * - not sending the new one could cause terrible delays the old connection
532    *   is stalled.
533    */
534 //   FIXME access to queue elements is limited
535   payload = (struct GNUNET_MESH_Data *) &copy[1];
536   fwd = (rel == ch->root_rel);
537 //   c = GMT_get_connection (ch->t, fwd);
538 //   hop = connection_get_hop (c, fwd);
539 //   for (q = hop->queue_head; NULL != q; q = q->next)
540 //   {
541 //     if (ntohs (payload->header.type) == q->type && ch == q->ch)
542 //     {
543 //       struct GNUNET_MESH_Data *queued_data = q->cls;
544 // 
545 //       if (queued_data->mid == payload->mid)
546 //         break;
547 //     }
548 //   }
549
550   /* Message not found in the queue that we are going to use. */
551 //   if (NULL == q)
552 //   {
553     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
554
555     GMCH_send_prebuilt_message (&payload->header, ch, fwd);
556     GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
557 //   }
558 //   else
559 //   {
560 //     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! ALREADY IN QUEUE %u\n", copy->mid);
561 //   }
562
563   rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
564   rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
565                                                   &channel_retransmit_message,
566                                                   cls);
567 }
568
569
570 /**
571  * Destroy a reliable message after it has been acknowledged, either by
572  * direct mid ACK or bitfield. Updates the appropriate data structures and
573  * timers and frees all memory.
574  *
575  * @param copy Message that is no longer needed: remote peer got it.
576  */
577 static void
578 rel_message_free (struct MeshReliableMessage *copy)
579 {
580   struct MeshChannelReliability *rel;
581   struct GNUNET_TIME_Relative time;
582
583   rel = copy->rel;
584   time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
585   rel->expected_delay.rel_value_us *= 7;
586   rel->expected_delay.rel_value_us += time.rel_value_us;
587   rel->expected_delay.rel_value_us /= 8;
588   rel->n_sent--;
589   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
590   LOG (GNUNET_ERROR_TYPE_DEBUG, "    n_sent %u\n", rel->n_sent);
591   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  took %s\n",
592               GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
593   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  new expected delay %s\n",
594               GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
595                                                       GNUNET_NO));
596   rel->retry_timer = rel->expected_delay;
597   GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
598   GNUNET_free (copy);
599 }
600
601
602 /**
603  * Confirm we got a channel create.
604  *
605  * @param ch The channel to confirm.
606  * @param fwd Should we send a FWD ACK? (going dest->root)
607  */
608 static void
609 channel_send_ack (struct MeshChannel *ch, int fwd)
610 {
611   struct GNUNET_MESH_ChannelManage msg;
612
613   msg.header.size = htons (sizeof (msg));
614   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
615   LOG (GNUNET_ERROR_TYPE_DEBUG,
616               "  sending channel %s ack for channel %s\n",
617               fwd ? "FWD" : "BCK", GMCH_2s (ch));
618
619   msg.chid = htonl (ch->gid);
620   GMCH_send_prebuilt_message (&msg.header, ch, !fwd);
621 }
622
623
624 /**
625  * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
626  *
627  * @param ch Channel to mark as ready.
628  * @param fwd Was the CREATE message sent fwd?
629  */
630 static void
631 channel_confirm (struct MeshChannel *ch, int fwd)
632 {
633   struct MeshChannelReliability *rel;
634   struct MeshReliableMessage *copy;
635   struct MeshReliableMessage *next;
636
637   LOG (GNUNET_ERROR_TYPE_DEBUG,
638               "  channel confirm %s %s:%X\n",
639               fwd ? "FWD" : "BCK", GMT_2s (ch->t), ch->gid);
640   ch->state = MESH_CHANNEL_READY;
641
642   rel = fwd ? ch->root_rel : ch->dest_rel;
643   for (copy = rel->head_sent; NULL != copy; copy = next)
644   {
645     struct GNUNET_MessageHeader *msg;
646
647     next = copy->next;
648     msg = (struct GNUNET_MessageHeader *) &copy[1];
649     if (ntohs (msg->type) == GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE)
650     {
651       rel_message_free (copy);
652       /* TODO return? */
653     }
654   }
655
656   /* In case of a FWD ACk (SYNACK) send a BCK ACK (ACK). */
657   if (fwd)
658     channel_send_ack (ch, !fwd);
659 }
660
661
662 /**
663  * Save a copy to retransmit in case it gets lost.
664  *
665  * Initializes all needed callbacks and timers.
666  *
667  * @param ch Channel this message goes on.
668  * @param msg Message to copy.
669  * @param fwd Is this fwd traffic?
670  */
671 static void
672 channel_save_copy (struct MeshChannel *ch,
673                    const struct GNUNET_MessageHeader *msg,
674                    int fwd)
675 {
676   struct MeshChannelReliability *rel;
677   struct MeshReliableMessage *copy;
678   uint32_t mid;
679   uint16_t type;
680   uint16_t size;
681
682   rel = fwd ? ch->root_rel : ch->dest_rel;
683   mid = rel->mid_send;
684   type = ntohs (msg->type);
685   size = ntohs (msg->size);
686
687   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u\n", mid);
688   copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
689   copy->mid = mid;
690   copy->timestamp = GNUNET_TIME_absolute_get ();
691   copy->rel = rel;
692   copy->type = type;
693   memcpy (&copy[1], msg, size);
694   rel->n_sent++;
695   LOG (GNUNET_ERROR_TYPE_DEBUG, " n_sent %u\n", rel->n_sent);
696   GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
697   if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
698   {
699     rel->retry_timer =
700         GNUNET_TIME_relative_multiply (rel->expected_delay,
701                                         MESH_RETRANSMIT_MARGIN);
702     rel->retry_task =
703         GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
704                                       &channel_retransmit_message,
705                                       rel);
706   }
707 }
708
709
710
711 /**
712  * Send a buffered message to the client, for in order delivery or
713  * as result of client ACK.
714  *
715  * @param ch Channel on which to empty the message buffer.
716  * @param c Client to send to.
717  * @param fwd Is this to send FWD data?.
718  */
719 static void
720 send_client_buffered_data (struct MeshChannel *ch,
721                            struct MeshClient *c,
722                            int fwd)
723 {
724   struct MeshReliableMessage *copy;
725   struct MeshChannelReliability *rel;
726
727   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
728   rel = fwd ? ch->dest_rel : ch->root_rel;
729   if (GNUNET_NO == rel->client_ready)
730   {
731     LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
732     return;
733   }
734
735   copy = rel->head_recv;
736   /* We never buffer channel management messages */
737   if (NULL != copy)
738   {
739     if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
740     {
741       struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) &copy[1];
742
743       LOG (GNUNET_ERROR_TYPE_DEBUG,
744                   " have %u! now expecting %u\n",
745                   copy->mid, rel->mid_recv + 1);
746       send_client_data (ch, msg, fwd);
747       rel->n_recv--;
748       rel->mid_recv++;
749       GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
750       GNUNET_free (copy);
751     }
752     else
753     {
754       LOG (GNUNET_ERROR_TYPE_DEBUG,
755                   " reliable && don't have %u, next is %u\n",
756                   rel->mid_recv,
757                   copy->mid);
758       return;
759     }
760   }
761   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
762 }
763
764
765
766
767 /**
768  * Destroy a channel and free all resources.
769  *
770  * @param ch Channel to destroy.
771  */
772 static void
773 channel_destroy (struct MeshChannel *ch)
774 {
775   struct MeshClient *c;
776
777   if (NULL == ch)
778     return;
779
780   LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
781               GMT_2s (ch->t), ch->gid);
782   GMCH_debug (ch);
783
784   c = ch->root;
785   if (NULL != c)
786   {
787     GML_channel_remove (c, ch->lid_root, ch);
788   }
789
790   c = ch->dest;
791   if (NULL != c)
792   {
793     GML_channel_remove (c, ch->lid_dest, ch);
794   }
795
796   channel_rel_free_all (ch->root_rel);
797   channel_rel_free_all (ch->dest_rel);
798
799   GMT_remove_channel (ch->t, ch);
800   GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
801
802   GNUNET_free (ch);
803 }
804
805
806 /**
807  * Create a new channel.
808  *
809  * @param t Tunnel this channel is in.
810  * @param owner Client that owns the channel, NULL for foreign channels.
811  * @param lid_root Local ID for root client.
812  *
813  * @return A new initialized channel. NULL on error.
814  */
815 static struct MeshChannel *
816 channel_new (struct MeshTunnel3 *t,
817              struct MeshClient *owner,
818              MESH_ChannelNumber lid_root)
819 {
820   struct MeshChannel *ch;
821
822   ch = GNUNET_new (struct MeshChannel);
823   ch->root = owner;
824   ch->lid_root = lid_root;
825   ch->t = t;
826
827   GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
828
829   if (NULL != owner)
830   {
831     ch->gid = GMT_get_next_chid (t);
832     GML_channel_add (owner, lid_root, ch);
833   }
834   GMT_add_channel (t, ch);
835
836   return ch;
837 }
838
839
840 /**
841  * Set options in a channel, extracted from a bit flag field
842  *
843  * @param ch Channel to set options to.
844  * @param options Bit array in host byte order.
845  */
846 static void
847 channel_set_options (struct MeshChannel *ch, uint32_t options)
848 {
849   ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
850                  GNUNET_YES : GNUNET_NO;
851   ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
852                  GNUNET_YES : GNUNET_NO;
853 }
854
855
856 /**
857  * Handle a loopback message: call the appropriate handler for the message type.
858  *
859  * @param ch Channel this message is on.
860  * @param msgh Message header.
861  * @param fwd Is this FWD traffic?
862  */
863 void
864 handle_loopback (struct MeshChannel *ch,
865                  const struct GNUNET_MessageHeader *msgh,
866                  int fwd)
867 {
868   uint16_t type;
869
870   type = ntohs (msgh->type);
871   LOG (GNUNET_ERROR_TYPE_DEBUG,
872        "Loopback %s %s message!\n",
873        fwd ? "FWD" : "BCK", GNUNET_MESH_DEBUG_M2S (type));
874
875   switch (type)
876   {
877     case GNUNET_MESSAGE_TYPE_MESH_DATA:
878       /* Don't send hop ACK, wait for client to ACK */
879       GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
880       break;
881
882     case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
883       GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
884       break;
885
886     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
887       GMCH_handle_create (ch->t,
888                           (struct GNUNET_MESH_ChannelCreate *) msgh,
889                           fwd);
890       break;
891
892     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
893       GMCH_handle_ack (ch,
894                        (struct GNUNET_MESH_ChannelManage *) msgh,
895                        fwd);
896       break;
897
898     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
899       GMCH_handle_destroy (ch,
900                            (struct GNUNET_MESH_ChannelManage *) msgh,
901                            fwd);
902       break;
903
904     default:
905       GNUNET_break_op (0);
906       LOG (GNUNET_ERROR_TYPE_DEBUG,
907            "end-to-end message not known (%u)\n",
908            ntohs (msgh->type));
909   }
910 }
911
912
913
914 /******************************************************************************/
915 /********************************    API    ***********************************/
916 /******************************************************************************/
917
918 /**
919  * Get channel ID.
920  *
921  * @param ch Channel.
922  *
923  * @return ID
924  */
925 MESH_ChannelNumber
926 GMCH_get_id (const struct MeshChannel *ch)
927 {
928   return ch->gid;
929 }
930
931
932 /**
933  * Get the channel tunnel.
934  *
935  * @param ch Channel to get the tunnel from.
936  *
937  * @return tunnel of the channel.
938  */
939 struct MeshTunnel3 *
940 GMCH_get_tunnel (const struct MeshChannel *ch)
941 {
942   return ch->t;
943 }
944
945
946 /**
947  * Get free buffer space towards the client on a specific channel.
948  *
949  * @param ch Channel.
950  * @param fwd Is query about FWD traffic?
951  *
952  * @return Free buffer space [0 - 64]
953  */
954 unsigned int
955 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
956 {
957   struct MeshChannelReliability *rel;
958
959   rel = fwd ? ch->dest_rel : ch->root_rel;
960
961   /* If rel is NULL it means that the end is not yet created,
962    * most probably is a loopback channel at the point of sending
963    * the ChannelCreate to itself.
964    */
965   if (NULL == rel)
966     return 64;
967
968   return (64 - rel->n_recv);
969 }
970
971
972 /**
973  * Is the root client for this channel on this peer?
974  *
975  * @param ch Channel.
976  * @param fwd Is this for fwd traffic?
977  *
978  * @return GNUNET_YES in case it is.
979  */
980 int
981 GMCH_is_origin (struct MeshChannel *ch, int fwd)
982 {
983   struct MeshClient *c;
984
985   c = fwd ? ch->root : ch->dest;
986   return NULL != c;
987 }
988
989
990 /**
991  * Is the destination client for this channel on this peer?
992  *
993  * @param ch Channel.
994  * @param fwd Is this for fwd traffic?
995  *
996  * @return GNUNET_YES in case it is.
997  */
998 int
999 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1000 {
1001   struct MeshClient *c;
1002
1003   c = fwd ? ch->dest : ch->root;
1004   return NULL != c;
1005 }
1006
1007
1008 /**
1009  * Notify the destination client that a new incoming channel was created.
1010  *
1011  * @param ch Channel that was created.
1012  */
1013 void
1014 GMCH_send_create (struct MeshChannel *ch)
1015 {
1016   uint32_t opt;
1017
1018   if (NULL == ch->dest)
1019     return;
1020
1021   opt = 0;
1022   opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
1023   opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
1024   GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
1025                            GMT_get_destination (ch->t));
1026
1027 }
1028
1029 /**
1030  * Notify a client that the channel is no longer valid.
1031  * FIXME send on tunnel if some client == NULL?
1032  *
1033  * @param ch Channel that is destroyed.
1034  */
1035 void
1036 GMCH_send_destroy (struct MeshChannel *ch)
1037 {
1038   if (NULL != ch->root)
1039     GML_send_channel_destroy (ch->root, ch->lid_root);
1040
1041   if (NULL != ch->dest)
1042     GML_send_channel_destroy (ch->dest, ch->lid_dest);
1043 }
1044
1045
1046 /**
1047  * Send data on a channel.
1048  *
1049  * If the destination is local, send it to client, otherwise encrypt and
1050  * send to next hop.
1051  *
1052  * @param ch Channel
1053  * @param msg Message.
1054  * @param fwd Is this a fwd (root->dest) message?
1055  */
1056 void
1057 GMCH_send_data (struct MeshChannel *ch,
1058                 const struct GNUNET_MESH_Data *msg,
1059                 int fwd)
1060 {
1061   if (GMCH_is_terminal (ch, fwd))
1062   {
1063     GML_send_data (fwd ? ch->dest : ch->root,
1064                    msg,
1065                    fwd ? ch->lid_dest : ch->lid_root);
1066   }
1067   else
1068   {
1069     GMT_send_prebuilt_message (&msg->header, ch->t, ch, fwd);
1070   }
1071 }
1072
1073
1074 /**
1075  * Send an end-to-end ACK message for the most recent in-sequence payload.
1076  *
1077  * If channel is not reliable, do nothing.
1078  *
1079  * @param ch Channel this is about.
1080  * @param fwd Is for FWD traffic? (ACK dest->owner)
1081  */
1082 void
1083 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1084 {
1085   struct GNUNET_MESH_DataACK msg;
1086   struct MeshChannelReliability *rel;
1087   struct MeshReliableMessage *copy;
1088   unsigned int delta;
1089   uint64_t mask;
1090   uint16_t type;
1091
1092   if (GNUNET_NO == ch->reliable)
1093   {
1094     return;
1095   }
1096   rel = fwd ? ch->dest_rel : ch->root_rel;
1097   LOG (GNUNET_ERROR_TYPE_DEBUG,
1098               "send_data_ack for %u\n",
1099               rel->mid_recv - 1);
1100
1101   type = GNUNET_MESSAGE_TYPE_MESH_DATA_ACK;
1102   msg.header.type = htons (type);
1103   msg.header.size = htons (sizeof (msg));
1104   msg.chid = htonl (ch->gid);
1105   msg.mid = htonl (rel->mid_recv - 1);
1106   msg.futures = 0;
1107   for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1108   {
1109     if (copy->type != type)
1110       continue;
1111     delta = copy->mid - rel->mid_recv;
1112     if (63 < delta)
1113       break;
1114     mask = 0x1LL << delta;
1115     msg.futures |= mask;
1116     LOG (GNUNET_ERROR_TYPE_DEBUG,
1117                 " setting bit for %u (delta %u) (%llX) -> %llX\n",
1118                 copy->mid, delta, mask, msg.futures);
1119   }
1120   LOG (GNUNET_ERROR_TYPE_DEBUG, " final futures %llX\n", msg.futures);
1121
1122   GMCH_send_prebuilt_message (&msg.header, ch, fwd);
1123   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1124 }
1125
1126
1127 /**
1128  * Log channel info.
1129  *
1130  * @param ch Channel.
1131  */
1132 void
1133 GMCH_debug (struct MeshChannel *ch)
1134 {
1135   if (NULL == ch)
1136   {
1137     LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1138     return;
1139   }
1140   LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1141               GMT_2s (ch->t), ch->gid, ch);
1142   LOG (GNUNET_ERROR_TYPE_DEBUG, "  root %p/%p\n",
1143               ch->root, ch->root_rel);
1144   if (NULL != ch->root)
1145   {
1146     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cli %s\n", GML_2s (ch->root));
1147     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ready %s\n",
1148                 ch->root_rel->client_ready ? "YES" : "NO");
1149     LOG (GNUNET_ERROR_TYPE_DEBUG, "  id %X\n", ch->lid_root);
1150   }
1151   LOG (GNUNET_ERROR_TYPE_DEBUG, "  dest %p/%p\n",
1152               ch->dest, ch->dest_rel);
1153   if (NULL != ch->dest)
1154   {
1155     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cli %s\n", GML_2s (ch->dest));
1156     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ready %s\n",
1157                 ch->dest_rel->client_ready ? "YES" : "NO");
1158     LOG (GNUNET_ERROR_TYPE_DEBUG, "  id %X\n", ch->lid_dest);
1159   }
1160 }
1161
1162
1163 /**
1164  * Handle an ACK given by a client.
1165  *
1166  * Mark client as ready and send him any buffered data we could have for him.
1167  *
1168  * @param ch Channel.
1169  * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by root and go BCK)
1170  */
1171 void
1172 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1173 {
1174   struct MeshChannelReliability *rel;
1175   struct MeshClient *c;
1176
1177   rel = fwd ? ch->dest_rel : ch->root_rel;
1178   c   = fwd ? ch->dest     : ch->root;
1179
1180   rel->client_ready = GNUNET_YES;
1181   send_client_buffered_data (ch, c, fwd);
1182   GMC_send_ack (NULL, ch, fwd);
1183 }
1184
1185
1186 /**
1187  * Handle data given by a client.
1188  *
1189  * Check whether the client is allowed to send in this tunnel, save if channel
1190  * is reliable and send an ACK to the client if there is still buffer space
1191  * in the tunnel.
1192  *
1193  * @param ch Channel.
1194  * @param fwd Is this a FWD data?
1195  *
1196  * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1197  */
1198 int
1199 GMCH_handle_local_data (struct MeshChannel *ch,
1200                         struct MeshClient *c,
1201                         struct GNUNET_MessageHeader *message,
1202                         int fwd)
1203 {
1204   struct MeshChannelReliability *rel;
1205   struct GNUNET_MESH_Data *payload;
1206   size_t size = ntohs (message->size);
1207   uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1208   unsigned char cbuf[p2p_size];
1209
1210   /* Is the client in the channel? */
1211   if ( !( (fwd &&
1212            ch->root == c)
1213          ||
1214           (!fwd &&
1215            ch->dest == c) ) )
1216   {
1217     GNUNET_break (0);
1218     return GNUNET_SYSERR;
1219   }
1220
1221   rel = fwd ? ch->root_rel : ch->dest_rel;
1222
1223   /* Ok, everything is correct, send the message. */
1224   payload = (struct GNUNET_MESH_Data *) cbuf;
1225   payload->mid = htonl (rel->mid_send);
1226   rel->mid_send++;
1227   memcpy (&payload[1], message, size);
1228   payload->header.size = htons (p2p_size);
1229   payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1230   payload->chid = htonl (ch->gid);
1231   LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on channel...\n");
1232   GMCH_send_prebuilt_message (&payload->header, ch, fwd);
1233
1234   if (GNUNET_YES == ch->reliable)
1235     channel_save_copy (ch, &payload->header, fwd);
1236   if (GMT_get_buffer (ch->t, fwd) > 0)
1237     GML_send_ack (c, fwd ? ch->lid_root : ch->lid_dest);
1238
1239   return GNUNET_OK;
1240 }
1241
1242
1243 /**
1244  * Handle a channel destroy requested by a client.
1245  *
1246  * Destroy the channel and the tunnel in case this was the last channel.
1247  *
1248  * @param ch Channel.
1249  * @param c Client that requested the destruction (to avoid notifying him).
1250  */
1251 void
1252 GMCH_handle_local_destroy (struct MeshChannel *ch,
1253                            struct MeshClient *c)
1254 {
1255   struct MeshTunnel3 *t;
1256
1257   /* Cleanup after the tunnel */
1258   if (c == ch->dest)
1259   {
1260     LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1261     GML_client_delete_channel (c, ch, ch->lid_dest);
1262     ch->dest = NULL;
1263   }
1264   if (c == ch->root)
1265   {
1266     LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1267     GML_client_delete_channel (c, ch, ch->lid_root);
1268     ch->root = NULL;
1269   }
1270
1271   t = ch->t;
1272   GMCH_send_destroy (ch);
1273   channel_destroy (ch);
1274   GMT_destroy_if_empty (t);
1275 }
1276
1277
1278 /**
1279  * Handle a channel create requested by a client.
1280  *
1281  * Create the channel and the tunnel in case this was the first0 channel.
1282  *
1283  * @param c Client that requested the creation (will be the root).
1284  * @param msg Create Channel message.
1285  *
1286  * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1287  */
1288 int
1289 GMCH_handle_local_create (struct MeshClient *c,
1290                           struct GNUNET_MESH_ChannelMessage *msg)
1291 {
1292   struct MeshChannel *ch;
1293   struct MeshTunnel3 *t;
1294   struct MeshPeer *peer;
1295   MESH_ChannelNumber chid;
1296
1297   LOG (GNUNET_ERROR_TYPE_DEBUG, "  towards %s:%u\n",
1298               GNUNET_i2s (&msg->peer), ntohl (msg->port));
1299   chid = ntohl (msg->channel_id);
1300
1301   /* Sanity check for duplicate channel IDs */
1302   if (NULL != GML_channel_get (c, chid))
1303   {
1304     GNUNET_break (0);
1305     return GNUNET_SYSERR;
1306   }
1307
1308   peer = GMP_get (&msg->peer);
1309   GMP_add_tunnel (peer);
1310   t = GMP_get_tunnel (peer);
1311
1312   if (GMP_get_short_id (peer) == myid)
1313   {
1314     GMT_change_state (t, MESH_TUNNEL3_READY);
1315   }
1316   else
1317   {
1318     GMP_connect (peer);
1319   }
1320
1321   /* Create channel */
1322   ch = channel_new (t, c, chid);
1323   if (NULL == ch)
1324   {
1325     GNUNET_break (0);
1326     return GNUNET_SYSERR;
1327   }
1328   ch->port = ntohl (msg->port);
1329   channel_set_options (ch, ntohl (msg->opt));
1330
1331   /* In unreliable channels, we'll use the DLL to buffer BCK data */
1332   ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1333   ch->root_rel->ch = ch;
1334   ch->root_rel->expected_delay = MESH_RETRANSMIT_TIME;
1335
1336   LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1337
1338   /* Send create channel */
1339   {
1340     struct GNUNET_MESH_ChannelCreate msgcc;
1341
1342     msgcc.header.size = htons (sizeof (msgcc));
1343     msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE);
1344     msgcc.chid = htonl (ch->gid);
1345     msgcc.port = msg->port;
1346     msgcc.opt = msg->opt;
1347
1348     GMT_queue_data (t, ch, &msgcc.header, GNUNET_YES);
1349   }
1350   return GNUNET_OK;
1351 }
1352
1353 /**
1354  * Handler for mesh network payload traffic.
1355  *
1356  * @param ch Channel for the message.
1357  * @param message Unencryted data message.
1358  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1359  */
1360 void
1361 GMCH_handle_data (struct MeshChannel *ch,
1362                   const struct GNUNET_MESH_Data *msg,
1363                   int fwd)
1364 {
1365   struct MeshChannelReliability *rel;
1366   struct MeshClient *c;
1367   uint32_t mid;
1368
1369   /*  Initialize FWD/BCK data */
1370   c   = fwd ? ch->dest     : ch->root;
1371   rel = fwd ? ch->dest_rel : ch->root_rel;
1372
1373   if (NULL == c)
1374   {
1375     GNUNET_break (0);
1376     return;
1377   }
1378
1379   GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1380
1381   mid = ntohl (msg->mid);
1382   LOG (GNUNET_ERROR_TYPE_DEBUG, " mid %u\n", mid);
1383
1384   if (GNUNET_NO == ch->reliable ||
1385       ( !GMC_is_pid_bigger (rel->mid_recv, mid) &&
1386         GMC_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1387   {
1388     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1389     if (GNUNET_YES == ch->reliable)
1390     {
1391       /* Is this the exact next expected messasge? */
1392       if (mid == rel->mid_recv)
1393       {
1394         LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1395         rel->mid_recv++;
1396         send_client_data (ch, msg, fwd);
1397       }
1398       else
1399       {
1400         LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1401         add_buffered_data (msg, rel);
1402       }
1403     }
1404     else
1405     {
1406       /* Tunnel is unreliable: send to clients directly */
1407       /* FIXME: accept Out Of Order traffic */
1408       rel->mid_recv = mid + 1;
1409       send_client_data (ch, msg, fwd);
1410     }
1411   }
1412   else
1413   {
1414     GNUNET_break_op (0);
1415     LOG (GNUNET_ERROR_TYPE_DEBUG,
1416                 " MID %u not expected (%u - %u), dropping!\n",
1417                 mid, rel->mid_recv, rel->mid_recv + 64);
1418   }
1419
1420   GMCH_send_data_ack (ch, fwd);
1421 }
1422
1423
1424 /**
1425  * Handler for mesh network traffic end-to-end ACKs.
1426  *
1427  * @param t Tunnel on which we got this message.
1428  * @param message Data message.
1429  * @param fwd Is this a fwd ACK? (dest->orig)
1430  */
1431 void
1432 GMCH_handle_data_ack (struct MeshChannel *ch,
1433                       const struct GNUNET_MESH_DataACK *msg,
1434                       int fwd)
1435 {
1436   struct MeshChannelReliability *rel;
1437   struct MeshReliableMessage *copy;
1438   struct MeshReliableMessage *next;
1439   uint32_t ack;
1440   int work;
1441
1442   ack = ntohl (msg->mid);
1443   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1444               (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1445
1446   if (GNUNET_YES == fwd)
1447   {
1448     rel = ch->root_rel;
1449   }
1450   else
1451   {
1452     rel = ch->dest_rel;
1453   }
1454   if (NULL == rel)
1455   {
1456     GNUNET_break (0);
1457     return;
1458   }
1459
1460   for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
1461   {
1462     if (GMC_is_pid_bigger (copy->mid, ack))
1463     {
1464       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  head %u, out!\n", copy->mid);
1465       channel_rel_free_sent (rel, msg);
1466       break;
1467     }
1468     work = GNUNET_YES;
1469     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  id %u\n", copy->mid);
1470     next = copy->next;
1471     rel_message_free (copy);
1472   }
1473   /* ACK client if needed */
1474 //   channel_send_ack (t, type, GNUNET_MESSAGE_TYPE_MESH_UNICAST_ACK == type);
1475
1476   /* If some message was free'd, update the retransmission delay*/
1477   if (GNUNET_YES == work)
1478   {
1479     if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1480     {
1481       GNUNET_SCHEDULER_cancel (rel->retry_task);
1482       if (NULL == rel->head_sent)
1483       {
1484         rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1485       }
1486       else
1487       {
1488         struct GNUNET_TIME_Absolute new_target;
1489         struct GNUNET_TIME_Relative delay;
1490
1491         delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
1492                                                MESH_RETRANSMIT_MARGIN);
1493         new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
1494                                                delay);
1495         delay = GNUNET_TIME_absolute_get_remaining (new_target);
1496         rel->retry_task =
1497             GNUNET_SCHEDULER_add_delayed (delay,
1498                                           &channel_retransmit_message,
1499                                           rel);
1500       }
1501     }
1502     else
1503       GNUNET_break (0);
1504   }
1505 }
1506
1507
1508 /**
1509  * Handler for channel create messages.
1510  *
1511  * @param t Tunnel this channel will be in.
1512  * @param msg Message.
1513  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1514  */
1515 struct MeshChannel *
1516 GMCH_handle_create (struct MeshTunnel3 *t,
1517                     const struct GNUNET_MESH_ChannelCreate *msg,
1518                     int fwd)
1519 {
1520   MESH_ChannelNumber chid;
1521   struct MeshChannel *ch;
1522   struct MeshClient *c;
1523   uint32_t port;
1524
1525   chid = ntohl (msg->chid);
1526
1527   ch = GMT_get_channel (t, chid);
1528   if (NULL == ch)
1529   {
1530     /* Create channel */
1531     ch = channel_new (t, NULL, 0);
1532     ch->gid = chid;
1533   }
1534   channel_set_options (ch, ntohl (msg->opt));
1535
1536   /* Find a destination client */
1537   port = ntohl (msg->port);
1538   LOG (GNUNET_ERROR_TYPE_DEBUG, "   port %u\n", port);
1539   c = GML_client_get_by_port (port);
1540   if (NULL == c)
1541   {
1542     /* TODO send reject */
1543     LOG (GNUNET_ERROR_TYPE_DEBUG, "  no client has port registered\n");
1544     channel_destroy (ch);
1545     return NULL;
1546   }
1547
1548   GMCH_add_client (ch, c);
1549   if (GNUNET_YES == ch->reliable)
1550     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
1551
1552   GMCH_send_create (ch);
1553   channel_send_ack (ch, fwd);
1554   GMCH_send_data_ack (ch, fwd);
1555
1556   if (GNUNET_NO == ch->dest_rel->client_ready)
1557   {
1558     GML_send_ack (ch->dest, ch->lid_dest);
1559     ch->dest_rel->client_ready = GNUNET_YES;
1560   }
1561
1562   return ch;
1563 }
1564
1565
1566 /**
1567  * Handler for channel ack messages.
1568  *
1569  * @param ch Channel.
1570  * @param msg Message.
1571  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1572  */
1573 void
1574 GMCH_handle_ack (struct MeshChannel *ch,
1575                  const struct GNUNET_MESH_ChannelManage *msg,
1576                  int fwd)
1577 {
1578   channel_confirm (ch, !fwd);
1579 }
1580
1581
1582 /**
1583  * Handler for channel destroy messages.
1584  *
1585  * @param ch Channel to be destroyed of.
1586  * @param msg Message.
1587  * @param fwd Is this FWD traffic? GNUNET_YES : GNUNET_NO;
1588  */
1589 void
1590 GMCH_handle_destroy (struct MeshChannel *ch,
1591                      const struct GNUNET_MESH_ChannelManage *msg,
1592                      int fwd)
1593 {
1594   struct MeshTunnel3 *t;
1595
1596   GMCH_debug (ch);
1597   if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
1598   {
1599     /* Not for us (don't destroy twice a half-open loopback channel) */
1600     return;
1601   }
1602
1603   t = ch->t;
1604   GMCH_send_destroy (ch);
1605   channel_destroy (ch);
1606   GMT_destroy_if_empty (t);
1607 }
1608
1609
1610 /**
1611  * Sends an already built message on a channel.
1612  *
1613  * If the channel is on a loopback tunnel, notifies the appropriate destination
1614  * client locally.
1615  *
1616  * On a normal channel passes the message to the tunnel for encryption and
1617  * sending on a connection.
1618  *
1619  * This function DOES NOT save the message for retransmission.
1620  *
1621  * @param message Message to send. Function makes a copy of it.
1622  * @param ch Channel on which this message is transmitted.
1623  * @param fwd Is this a fwd message?
1624  */
1625 void
1626 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
1627                             struct MeshChannel *ch, int fwd)
1628 {
1629   LOG (GNUNET_ERROR_TYPE_DEBUG, "Send %s on channel %s\n",
1630        fwd ? "FWD" : "BCK", GMCH_2s (ch));
1631   LOG (GNUNET_ERROR_TYPE_DEBUG, "  %s\n",
1632        GNUNET_MESH_DEBUG_M2S (ntohs (message->type)));
1633
1634   if (GMT_is_loopback (ch->t))
1635   {
1636     handle_loopback (ch, message, fwd);
1637     return;
1638   }
1639
1640   GMT_send_prebuilt_message (message, ch->t, ch, fwd);
1641 }
1642
1643
1644 /**
1645  * Get the static string for identification of the channel.
1646  *
1647  * @param ch Channel.
1648  *
1649  * @return Static string with the channel IDs.
1650  */
1651 const char *
1652 GMCH_2s (const struct MeshChannel *ch)
1653 {
1654   static char buf[64];
1655
1656   if (NULL == ch)
1657     return "(NULL Channel)";
1658
1659   sprintf (buf, "%s:%X (%X / %X)",
1660            GMT_2s (ch->t), ch->gid, ch->lid_root, ch->lid_dest);
1661
1662   return buf;
1663 }