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.h"
  28 #include "mesh_protocol.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_relative_multiply(\
  38                                     GNUNET_TIME_UNIT_MILLISECONDS, 250)
  39 #define MESH_RETRANSMIT_MARGIN  4
  40
  41
  42 /**
  43  * All the states a connection can be in.
  44  */
  45 enum MeshChannelState
  46 {
  47   /**
  48    * Uninitialized status, should never appear in operation.
  49    */
  50   MESH_CHANNEL_NEW,
  51
  52   /**
  53    * Connection create message sent, waiting for ACK.
  54    */
  55   MESH_CHANNEL_SENT,
  56
  57   /**
  58    * Connection confirmed, ready to carry traffic.
  59    */
  60   MESH_CHANNEL_READY,
  61 };
  62
  63
  64 /**
  65  * Info holder for channel messages in queues.
  66  */
  67 struct MeshChannelQueue
  68 {
  69   /**
  70    * Tunnel Queue.
  71    */
  72   struct MeshTunnel3Queue *q;
  73
  74   /**
  75    * Message type (DATA/DATA_ACK)
  76    */
  77   uint16_t type;
  78
  79   /**
  80    * Message copy (for DATAs, to start retransmission timer)
  81    */
  82   struct MeshReliableMessage *copy;
  83
  84   /**
  85    * Reliability (for DATA_ACKs, to access rel->ack_q)
  86    */
  87   struct MeshChannelReliability *rel;
  88 };
  89
  90
  91 /**
  92  * Info needed to retry a message in case it gets lost.
  93  */
  94 struct MeshReliableMessage
  95 {
  96     /**
  97      * Double linked list, FIFO style
  98      */
  99   struct MeshReliableMessage    *next;
 100   struct MeshReliableMessage    *prev;
 101
 102     /**
 103      * Type of message (payload, channel management).
 104      */
 105   int16_t type;
 106
 107     /**
 108      * Tunnel Reliability queue this message is in.
 109      */
 110   struct MeshChannelReliability  *rel;
 111
 112     /**
 113      * ID of the message (ACK needed to free)
 114      */
 115   uint32_t                      mid;
 116
 117   /**
 118    * Tunnel Queue.
 119    */
 120   struct MeshChannelQueue       *q;
 121
 122     /**
 123      * When was this message issued (to calculate ACK delay)
 124      */
 125   struct GNUNET_TIME_Absolute   timestamp;
 126
 127   /* struct GNUNET_MESH_Data with payload */
 128 };
 129
 130
 131 /**
 132  * Info about the traffic state for a client in a channel.
 133  */
 134 struct MeshChannelReliability
 135 {
 136     /**
 137      * Channel this is about.
 138      */
 139   struct MeshChannel *ch;
 140
 141     /**
 142      * DLL of messages sent and not yet ACK'd.
 143      */
 144   struct MeshReliableMessage        *head_sent;
 145   struct MeshReliableMessage        *tail_sent;
 146
 147     /**
 148      * DLL of messages received out of order.
 149      */
 150   struct MeshReliableMessage        *head_recv;
 151   struct MeshReliableMessage        *tail_recv;
 152
 153     /**
 154      * Messages received.
 155      */
 156   unsigned int                      n_recv;
 157
 158     /**
 159      * Next MID to use for outgoing traffic.
 160      */
 161   uint32_t                          mid_send;
 162
 163     /**
 164      * Next MID expected for incoming traffic.
 165      */
 166   uint32_t                          mid_recv;
 167
 168     /**
 169      * Handle for queued unique data CREATE, DATA_ACK.
 170      */
 171   struct MeshChannelQueue           *uniq;
 172
 173     /**
 174      * Can we send data to the client?
 175      */
 176   int                               client_ready;
 177
 178   /**
 179    * Can the client send data to us?
 180    */
 181   int                               client_allowed;
 182
 183     /**
 184      * Task to resend/poll in case no ACK is received.
 185      */
 186   GNUNET_SCHEDULER_TaskIdentifier   retry_task;
 187
 188     /**
 189      * Counter for exponential backoff.
 190      */
 191   struct GNUNET_TIME_Relative       retry_timer;
 192
 193     /**
 194      * How long does it usually take to get an ACK.
 195      */
 196   struct GNUNET_TIME_Relative       expected_delay;
 197 };
 198
 199
 200 /**
 201  * Struct containing all information regarding a channel to a remote client.
 202  */
 203 struct MeshChannel
 204 {
 205     /**
 206      * Tunnel this channel is in.
 207      */
 208   struct MeshTunnel3 *t;
 209
 210     /**
 211      * Destination port of the channel.
 212      */
 213   uint32_t port;
 214
 215     /**
 216      * Global channel number ( < GNUNET_MESH_LOCAL_CHANNEL_ID_CLI)
 217      */
 218   MESH_ChannelNumber gid;
 219
 220     /**
 221      * Local tunnel number for root (owner) client.
 222      * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_CLI or 0 )
 223      */
 224   MESH_ChannelNumber lid_root;
 225
 226     /**
 227      * Local tunnel number for local destination clients (incoming number)
 228      * ( >= GNUNET_MESH_LOCAL_CHANNEL_ID_SERV or 0).
 229      */
 230   MESH_ChannelNumber lid_dest;
 231
 232     /**
 233      * Channel state.
 234      */
 235   enum MeshChannelState state;
 236
 237     /**
 238      * Is the tunnel bufferless (minimum latency)?
 239      */
 240   int nobuffer;
 241
 242     /**
 243      * Is the tunnel reliable?
 244      */
 245   int reliable;
 246
 247     /**
 248      * Last time the channel was used
 249      */
 250   struct GNUNET_TIME_Absolute timestamp;
 251
 252     /**
 253      * Client owner of the tunnel, if any
 254      */
 255   struct MeshClient *root;
 256
 257     /**
 258      * Client destination of the tunnel, if any.
 259      */
 260   struct MeshClient *dest;
 261
 262     /**
 263      * Flag to signal the destruction of the channel.
 264      * If this is set GNUNET_YES the channel will be destroyed
 265      * when the queue is empty.
 266      */
 267   int destroy;
 268
 269     /**
 270      * Total (reliable) messages pending ACK for this channel.
 271      */
 272   unsigned int pending_messages;
 273
 274     /**
 275      * Reliability data.
 276      * Only present (non-NULL) at the owner of a tunnel.
 277      */
 278   struct MeshChannelReliability *root_rel;
 279
 280     /**
 281      * Reliability data.
 282      * Only present (non-NULL) at the destination of a tunnel.
 283      */
 284   struct MeshChannelReliability *dest_rel;
 285
 286 };
 287
 288
 289 /******************************************************************************/
 290 /*******************************   GLOBALS  ***********************************/
 291 /******************************************************************************/
 292
 293 /**
 294  * Global handle to the statistics service.
 295  */
 296 extern struct GNUNET_STATISTICS_Handle *stats;
 297
 298 /**
 299  * Local peer own ID (memory efficient handle).
 300  */
 301 extern GNUNET_PEER_Id myid;
 302
 303
 304 /******************************************************************************/
 305 /********************************   STATIC  ***********************************/
 306 /******************************************************************************/
 307
 308 /**
 309  * Destroy a reliable message after it has been acknowledged, either by
 310  * direct mid ACK or bitfield. Updates the appropriate data structures and
 311  * timers and frees all memory.
 312  *
 313  * @param copy Message that is no longer needed: remote peer got it.
 314  * @param update_time Is the timing information relevant?
 315  *                    If this message is ACK in a batch the timing information
 316  *                    is skewed by the retransmission, count only for the
 317  *                    retransmitted message.
 318  */
 319 static int
 320 rel_message_free (struct MeshReliableMessage *copy, int update_time);
 321
 322 /**
 323  * send a channel create message.
 324  *
 325  * @param ch Channel for which to send.
 326  */
 327 static void
 328 send_create (struct MeshChannel *ch);
 329
 330 /**
 331  * Confirm we got a channel create, FWD ack.
 332  *
 333  * @param ch The channel to confirm.
 334  * @param fwd Should we send a FWD ACK? (going dest->root)
 335  */
 336 static void
 337 send_ack (struct MeshChannel *ch, int fwd);
 338
 339
 340
 341 /**
 342  * Test if the channel is loopback: both root and dest are on the local peer.
 343  *
 344  * @param ch Channel to test.
 345  *
 346  * @return #GNUNET_YES if channel is loopback, #GNUNET_NO otherwise.
 347  */
 348 static int
 349 is_loopback (const struct MeshChannel *ch)
 350 {
 351   if (NULL != ch->t)
 352     return GMT_is_loopback (ch->t);
 353
 354   return (NULL != ch->root && NULL != ch->dest);
 355 }
 356
 357
 358 /**
 359  * We have received a message out of order, or the client is not ready.
 360  * Buffer it until we receive an ACK from the client or the missing
 361  * message from the channel.
 362  *
 363  * @param msg Message to buffer (MUST be of type MESH_DATA).
 364  * @param rel Reliability data to the corresponding direction.
 365  */
 366 static void
 367 add_buffered_data (const struct GNUNET_MESH_Data *msg,
 368                    struct MeshChannelReliability *rel)
 369 {
 370   struct MeshReliableMessage *copy;
 371   struct MeshReliableMessage *prev;
 372   uint32_t mid;
 373   uint16_t size;
 374
 375   size = ntohs (msg->header.size);
 376   mid = ntohl (msg->mid);
 377
 378   LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data %u\n", mid);
 379
 380   copy = GNUNET_malloc (sizeof (*copy) + size);
 381   copy->mid = mid;
 382   copy->rel = rel;
 383   copy->type = GNUNET_MESSAGE_TYPE_MESH_DATA;
 384   memcpy (&copy[1], msg, size);
 385
 386   rel->n_recv++;
 387
 388   // FIXME do something better than O(n), although n < 64...
 389   // FIXME start from the end (most messages are the latest ones)
 390   for (prev = rel->head_recv; NULL != prev; prev = prev->next)
 391   {
 392     LOG (GNUNET_ERROR_TYPE_DEBUG, " prev %u\n", prev->mid);
 393     if (GM_is_pid_bigger (prev->mid, mid))
 394     {
 395       LOG (GNUNET_ERROR_TYPE_DEBUG, " bingo!\n");
 396       GNUNET_CONTAINER_DLL_insert_before (rel->head_recv, rel->tail_recv,
 397                                           prev, copy);
 398       return;
 399     }
 400   }
 401     LOG (GNUNET_ERROR_TYPE_DEBUG, " insert at tail!\n");
 402     GNUNET_CONTAINER_DLL_insert_tail (rel->head_recv, rel->tail_recv, copy);
 403     LOG (GNUNET_ERROR_TYPE_DEBUG, "add_buffered_data END\n");
 404 }
 405
 406
 407 /**
 408  * Add a destination client to a channel, initializing all data structures
 409  * in the channel and the client.
 410  *
 411  * @param ch Channel to which add the destination.
 412  * @param c Client which to add to the channel.
 413  */
 414 static void
 415 add_destination (struct MeshChannel *ch, struct MeshClient *c)
 416 {
 417   if (NULL != ch->dest)
 418   {
 419     GNUNET_break (0);
 420     return;
 421   }
 422
 423   /* Assign local id as destination */
 424   ch->lid_dest = GML_get_next_chid (c);
 425
 426   /* Store in client's hashmap */
 427   GML_channel_add (c, ch->lid_dest, ch);
 428
 429   GNUNET_break (NULL == ch->dest_rel);
 430   ch->dest_rel = GNUNET_new (struct MeshChannelReliability);
 431   ch->dest_rel->ch = ch;
 432   ch->dest_rel->expected_delay.rel_value_us = 0;
 433   ch->dest_rel->retry_timer = MESH_RETRANSMIT_TIME;
 434
 435   ch->dest = c;
 436 }
 437
 438
 439 /**
 440  * Set options in a channel, extracted from a bit flag field.
 441  *
 442  * @param ch Channel to set options to.
 443  * @param options Bit array in host byte order.
 444  */
 445 static void
 446 channel_set_options (struct MeshChannel *ch, uint32_t options)
 447 {
 448   ch->nobuffer = (options & GNUNET_MESH_OPTION_NOBUFFER) != 0 ?
 449   GNUNET_YES : GNUNET_NO;
 450   ch->reliable = (options & GNUNET_MESH_OPTION_RELIABLE) != 0 ?
 451   GNUNET_YES : GNUNET_NO;
 452 }
 453
 454
 455 /**
 456  * Get a bit flag field with the options of a channel.
 457  *
 458  * @param ch Channel to get options from.
 459  *
 460  * @return Bit array in host byte order.
 461  */
 462 static uint32_t
 463 channel_get_options (struct MeshChannel *ch)
 464 {
 465   uint32_t options;
 466
 467   options = 0;
 468   if (ch->nobuffer)
 469     options |= GNUNET_MESH_OPTION_NOBUFFER;
 470   if (ch->reliable)
 471     options |= GNUNET_MESH_OPTION_RELIABLE;
 472
 473   return options;
 474 }
 475
 476
 477 /**
 478  * Notify the destination client that a new incoming channel was created.
 479  *
 480  * @param ch Channel that was created.
 481  */
 482 static void
 483 send_client_create (struct MeshChannel *ch)
 484 {
 485   uint32_t opt;
 486
 487   if (NULL == ch->dest)
 488     return;
 489
 490   opt = 0;
 491   opt |= GNUNET_YES == ch->reliable ? GNUNET_MESH_OPTION_RELIABLE : 0;
 492   opt |= GNUNET_YES == ch->nobuffer ? GNUNET_MESH_OPTION_NOBUFFER : 0;
 493   GML_send_channel_create (ch->dest, ch->lid_dest, ch->port, opt,
 494                            GMT_get_destination (ch->t));
 495
 496 }
 497
 498
 499 /**
 500  * Send data to a client.
 501  *
 502  * If the client is ready, send directly, otherwise buffer while listening
 503  * for a local ACK.
 504  *
 505  * @param ch Channel
 506  * @param msg Message.
 507  * @param fwd Is this a fwd (root->dest) message?
 508  */
 509 static void
 510 send_client_data (struct MeshChannel *ch,
 511                   const struct GNUNET_MESH_Data *msg,
 512                   int fwd)
 513 {
 514   if (fwd)
 515   {
 516     if (ch->dest_rel->client_ready)
 517       GML_send_data (ch->dest, msg, ch->lid_dest);
 518     else
 519       add_buffered_data (msg, ch->dest_rel);
 520   }
 521   else
 522   {
 523     if (ch->root_rel->client_ready)
 524       GML_send_data (ch->root, msg, ch->lid_root);
 525     else
 526       add_buffered_data (msg, ch->root_rel);
 527   }
 528 }
 529
 530
 531 /**
 532  * Send a buffered message to the client, for in order delivery or
 533  * as result of client ACK.
 534  *
 535  * @param ch Channel on which to empty the message buffer.
 536  * @param c Client to send to.
 537  * @param fwd Is this to send FWD data?.
 538  */
 539 static void
 540 send_client_buffered_data (struct MeshChannel *ch,
 541                            struct MeshClient *c,
 542                            int fwd)
 543 {
 544   struct MeshReliableMessage *copy;
 545   struct MeshChannelReliability *rel;
 546
 547   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data\n");
 548   rel = fwd ? ch->dest_rel : ch->root_rel;
 549   if (GNUNET_NO == rel->client_ready)
 550   {
 551     LOG (GNUNET_ERROR_TYPE_DEBUG, "client not ready\n");
 552     return;
 553   }
 554
 555   copy = rel->head_recv;
 556   /* We never buffer channel management messages */
 557   if (NULL != copy)
 558   {
 559     if (copy->mid == rel->mid_recv || GNUNET_NO == ch->reliable)
 560     {
 561       struct GNUNET_MESH_Data *msg = (struct GNUNET_MESH_Data *) &copy[1];
 562
 563       LOG (GNUNET_ERROR_TYPE_DEBUG,
 564            " have %u! now expecting %u\n",
 565            copy->mid, rel->mid_recv + 1);
 566       send_client_data (ch, msg, fwd);
 567       rel->n_recv--;
 568       rel->mid_recv++;
 569       GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
 570       LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE RECV %p\n", copy);
 571       GNUNET_free (copy);
 572     }
 573     else
 574     {
 575       LOG (GNUNET_ERROR_TYPE_DEBUG,
 576            " reliable && don't have %u, next is %u\n",
 577            rel->mid_recv,
 578            copy->mid);
 579       return;
 580     }
 581   }
 582   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_buffered_data END\n");
 583 }
 584
 585
 586 /**
 587  * Allow a client to send more data.
 588  *
 589  * In case the client was already allowed to send data, do nothing.
 590  *
 591  * @param ch Channel.
 592  * @param fwd Is this a FWD ACK? (FWD ACKs are sent to root)
 593  */
 594 static void
 595 send_client_ack (struct MeshChannel *ch, int fwd)
 596 {
 597   struct MeshChannelReliability *rel = fwd ? ch->root_rel : ch->dest_rel;
 598
 599   LOG (GNUNET_ERROR_TYPE_DEBUG,
 600        "  sending %s ack to client on channel %s\n",
 601        GM_f2s (fwd), GMCH_2s (ch));
 602
 603   if (NULL == rel)
 604   {
 605     GNUNET_break (0);
 606     return;
 607   }
 608
 609   if (GNUNET_YES == rel->client_allowed)
 610   {
 611     LOG (GNUNET_ERROR_TYPE_DEBUG, "  already allowed\n");
 612     return;
 613   }
 614   rel->client_allowed = GNUNET_YES;
 615
 616   GML_send_ack (fwd ? ch->root : ch->dest, fwd ? ch->lid_root : ch->lid_dest);
 617 }
 618
 619
 620 /**
 621  * Notify the root that the destination rejected the channel.
 622  *
 623  * @param ch Rejected channel.
 624  */
 625 static void
 626 send_client_nack (struct MeshChannel *ch)
 627 {
 628   if (NULL == ch->root)
 629   {
 630     GNUNET_break (0);
 631     return;
 632   }
 633   GML_send_nack (ch->root, ch->lid_root);
 634 }
 635
 636
 637 /**
 638  * We haven't received an ACK after a certain time: restransmit the message.
 639  *
 640  * @param cls Closure (MeshChannelReliability with the message to restransmit)
 641  * @param tc TaskContext.
 642  */
 643 static void
 644 channel_retransmit_message (void *cls,
 645                             const struct GNUNET_SCHEDULER_TaskContext *tc)
 646 {
 647   struct MeshChannelReliability *rel = cls;
 648   struct MeshReliableMessage *copy;
 649   struct MeshChannel *ch;
 650   struct GNUNET_MESH_Data *payload;
 651   int fwd;
 652
 653   rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
 654   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 655     return;
 656
 657   ch = rel->ch;
 658   copy = rel->head_sent;
 659   if (NULL == copy)
 660   {
 661     GNUNET_break (0);
 662     return;
 663   }
 664
 665   payload = (struct GNUNET_MESH_Data *) &copy[1];
 666   fwd = (rel == ch->root_rel);
 667
 668   /* Message not found in the queue that we are going to use. */
 669   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RETRANSMIT %u\n", copy->mid);
 670
 671   GMCH_send_prebuilt_message (&payload->header, ch, fwd, copy);
 672   GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
 673 }
 674
 675
 676 /**
 677  * We haven't received an Channel ACK after a certain time: resend the CREATE.
 678  *
 679  * @param cls Closure (MeshChannelReliability of the channel to recreate)
 680  * @param tc TaskContext.
 681  */
 682 static void
 683 channel_recreate (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 684 {
 685   struct MeshChannelReliability *rel = cls;
 686
 687   rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
 688   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 689     return;
 690
 691   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RE-CREATE\n");
 692   GNUNET_STATISTICS_update (stats, "# data retransmitted", 1, GNUNET_NO);
 693
 694   if (rel == rel->ch->root_rel)
 695   {
 696     send_create (rel->ch);
 697   }
 698   else if (rel == rel->ch->dest_rel)
 699   {
 700     send_ack (rel->ch, GNUNET_YES);
 701   }
 702   else
 703   {
 704     GNUNET_break (0);
 705   }
 706
 707 }
 708
 709
 710 /**
 711  * Message has been sent: start retransmission timer.
 712  *
 713  * @param cls Closure (queue structure).
 714  * @param t Tunnel.
 715  * @param q Queue handler (no longer valid).
 716  * @param type Type of message.
 717  * @param size Size of the message.
 718  */
 719 static void
 720 ch_message_sent (void *cls,
 721                  struct MeshTunnel3 *t,
 722                  struct MeshTunnel3Queue *q,
 723                  uint16_t type, size_t size)
 724 {
 725   struct MeshChannelQueue *ch_q = cls;
 726   struct MeshReliableMessage *copy = ch_q->copy;
 727   struct MeshChannelReliability *rel;
 728
 729   switch (ch_q->type)
 730   {
 731     case GNUNET_MESSAGE_TYPE_MESH_DATA:
 732       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT DATA MID %u\n", copy->mid);
 733       GNUNET_assert (ch_q == copy->q);
 734       copy->timestamp = GNUNET_TIME_absolute_get ();
 735       rel = copy->rel;
 736       if (GNUNET_SCHEDULER_NO_TASK == rel->retry_task)
 737       {
 738         LOG (GNUNET_ERROR_TYPE_DEBUG, "!! scheduling retry in %s\n",
 739              GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
 740                                                      GNUNET_YES));
 741         if (0 != rel->expected_delay.rel_value_us)
 742         {
 743           LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay != 0\n");
 744           rel->retry_timer =
 745           GNUNET_TIME_relative_multiply (rel->expected_delay,
 746                                          MESH_RETRANSMIT_MARGIN);
 747         }
 748         else
 749         {
 750           LOG (GNUNET_ERROR_TYPE_DEBUG, "!! delay reset\n");
 751           rel->retry_timer = MESH_RETRANSMIT_TIME;
 752         }
 753         LOG (GNUNET_ERROR_TYPE_DEBUG, "!! using delay %s\n",
 754              GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
 755                                                      GNUNET_NO));
 756         rel->retry_task =
 757             GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
 758                                           &channel_retransmit_message, rel);
 759       }
 760       else
 761       {
 762         LOG (GNUNET_ERROR_TYPE_DEBUG, "!! retry task %u\n", rel->retry_task);
 763       }
 764       copy->q = NULL;
 765       break;
 766
 767
 768     case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
 769     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
 770     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
 771       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SENT %s\n", GM_m2s (ch_q->type));
 772       rel = ch_q->rel;
 773       GNUNET_assert (rel->uniq == ch_q);
 774       rel->uniq = NULL;
 775
 776       if (MESH_CHANNEL_READY != rel->ch->state
 777           && GNUNET_MESSAGE_TYPE_MESH_DATA_ACK != type)
 778       {
 779         GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == rel->retry_task);
 780         LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! STD BACKOFF %s\n",
 781              GNUNET_STRINGS_relative_time_to_string (rel->retry_timer,
 782                                                      GNUNET_NO));
 783         rel->retry_timer = GNUNET_TIME_STD_BACKOFF (rel->retry_timer);
 784         rel->retry_task = GNUNET_SCHEDULER_add_delayed (rel->retry_timer,
 785                                                         &channel_recreate, rel);
 786       }
 787       break;
 788
 789
 790     default:
 791       GNUNET_break (0);
 792   }
 793
 794   GNUNET_free (ch_q);
 795 }
 796
 797
 798 /**
 799  * send a channel create message.
 800  *
 801  * @param ch Channel for which to send.
 802  */
 803 static void
 804 send_create (struct MeshChannel *ch)
 805 {
 806   struct GNUNET_MESH_ChannelCreate msgcc;
 807
 808   msgcc.header.size = htons (sizeof (msgcc));
 809   msgcc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE);
 810   msgcc.chid = htonl (ch->gid);
 811   msgcc.port = htonl (ch->port);
 812   msgcc.opt = htonl (channel_get_options (ch));
 813
 814   GMCH_send_prebuilt_message (&msgcc.header, ch, GNUNET_YES, NULL);
 815 }
 816
 817
 818 /**
 819  * Confirm we got a channel create or FWD ack.
 820  *
 821  * @param ch The channel to confirm.
 822  * @param fwd Should we send a FWD ACK? (going dest->root)
 823  */
 824 static void
 825 send_ack (struct MeshChannel *ch, int fwd)
 826 {
 827   struct GNUNET_MESH_ChannelManage msg;
 828
 829   msg.header.size = htons (sizeof (msg));
 830   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK);
 831   LOG (GNUNET_ERROR_TYPE_DEBUG,
 832        "  sending channel %s ack for channel %s\n",
 833        GM_f2s (fwd), GMCH_2s (ch));
 834
 835   msg.chid = htonl (ch->gid);
 836   GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
 837 }
 838
 839
 840 /**
 841  * Send a message and don't keep any info about it: we won't need to cancel it
 842  * or resend it.
 843  *
 844  * @param msg Header of the message to fire away.
 845  * @param ch Channel on which the message should go.
 846  * @param force Is this a forced (undroppable) message?
 847  */
 848 static void
 849 fire_and_forget (const struct GNUNET_MessageHeader *msg,
 850                  struct MeshChannel *ch,
 851                  int force)
 852 {
 853   GNUNET_break (NULL == GMT_send_prebuilt_message (msg, ch->t, force,
 854                                                    NULL, NULL));
 855 }
 856
 857
 858 /**
 859  * Notify that a channel create didn't succeed.
 860  *
 861  * @param ch The channel to reject.
 862  */
 863 static void
 864 send_nack (struct MeshChannel *ch)
 865 {
 866   struct GNUNET_MESH_ChannelManage msg;
 867
 868   msg.header.size = htons (sizeof (msg));
 869   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK);
 870   LOG (GNUNET_ERROR_TYPE_DEBUG,
 871        "  sending channel NACK for channel %s\n",
 872        GMCH_2s (ch));
 873
 874   msg.chid = htonl (ch->gid);
 875   GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
 876 }
 877
 878
 879 /**
 880  * Notify a client that the channel is no longer valid.
 881  *
 882  * @param ch Channel that is destroyed.
 883  * @param local_only Should we avoid sending it to other peers?
 884  */
 885 static void
 886 send_destroy (struct MeshChannel *ch, int local_only)
 887 {
 888   struct GNUNET_MESH_ChannelManage msg;
 889
 890   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY);
 891   msg.header.size = htons (sizeof (msg));
 892   msg.chid = htonl (ch->gid);
 893
 894   /* If root is not NULL, notify.
 895    * If it's NULL, check lid_root. When a local destroy comes in, root
 896    * is set to NULL but lid_root is left untouched. In this case, do nothing,
 897    * the client is the one who reuqested the channel to be destroyed.
 898    */
 899   if (NULL != ch->root)
 900     GML_send_channel_destroy (ch->root, ch->lid_root);
 901   else if (0 == ch->lid_root && GNUNET_NO == local_only)
 902     GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_NO, NULL);
 903
 904   if (NULL != ch->dest)
 905     GML_send_channel_destroy (ch->dest, ch->lid_dest);
 906   else if (0 == ch->lid_dest && GNUNET_NO == local_only)
 907     GMCH_send_prebuilt_message (&msg.header, ch, GNUNET_YES, NULL);
 908 }
 909
 910
 911 /**
 912  * Destroy all reliable messages queued for a channel,
 913  * during a channel destruction.
 914  * Frees the reliability structure itself.
 915  *
 916  * @param rel Reliability data for a channel.
 917  */
 918 static void
 919 channel_rel_free_all (struct MeshChannelReliability *rel)
 920 {
 921   struct MeshReliableMessage *copy;
 922   struct MeshReliableMessage *next;
 923
 924   if (NULL == rel)
 925     return;
 926
 927   for (copy = rel->head_recv; NULL != copy; copy = next)
 928   {
 929     next = copy->next;
 930     GNUNET_CONTAINER_DLL_remove (rel->head_recv, rel->tail_recv, copy);
 931     LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH RECV %p\n", copy);
 932     GNUNET_break (NULL == copy->q);
 933     GNUNET_free (copy);
 934   }
 935   for (copy = rel->head_sent; NULL != copy; copy = next)
 936   {
 937     next = copy->next;
 938     GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
 939     LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE BATCH %p\n", copy);
 940     if (NULL != copy->q)
 941     {
 942       if (NULL != copy->q->q)
 943       {
 944         GMT_cancel (copy->q->q);
 945         /* ch_message_sent will free copy->q */
 946       }
 947       else
 948       {
 949         GNUNET_free (copy->q);
 950         GNUNET_break (0);
 951       }
 952     }
 953     GNUNET_free (copy);
 954   }
 955   if (NULL != rel->uniq && NULL != rel->uniq->q)
 956   {
 957     GMT_cancel (rel->uniq->q);
 958     /* ch_message_sent is called freeing uniq */
 959   }
 960   if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
 961   {
 962     GNUNET_SCHEDULER_cancel (rel->retry_task);
 963     rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
 964   }
 965   GNUNET_free (rel);
 966 }
 967
 968
 969 /**
 970  * Mark future messages as ACK'd.
 971  *
 972  * @param rel Reliability data.
 973  * @param msg DataACK message with a bitfield of future ACK'd messages.
 974  */
 975 static void
 976 channel_rel_free_sent (struct MeshChannelReliability *rel,
 977                        const struct GNUNET_MESH_DataACK *msg)
 978 {
 979   struct MeshReliableMessage *copy;
 980   struct MeshReliableMessage *next;
 981   uint64_t bitfield;
 982   uint64_t mask;
 983   uint32_t mid;
 984   uint32_t target;
 985   unsigned int i;
 986
 987   bitfield = msg->futures;
 988   mid = ntohl (msg->mid);
 989   LOG (GNUNET_ERROR_TYPE_DEBUG,
 990               "!!! free_sent_reliable %u %llX\n",
 991               mid, bitfield);
 992   LOG (GNUNET_ERROR_TYPE_DEBUG,
 993               " rel %p, head %p\n",
 994               rel, rel->head_sent);
 995   for (i = 0, copy = rel->head_sent;
 996        i < 64 && NULL != copy && 0 != bitfield;
 997        i++)
 998   {
 999     LOG (GNUNET_ERROR_TYPE_DEBUG,
1000                 " trying bit %u (mid %u)\n",
1001                 i, mid + i + 1);
1002     mask = 0x1LL << i;
1003     if (0 == (bitfield & mask))
1004      continue;
1005
1006     LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
1007     /* Bit was set, clear the bit from the bitfield */
1008     bitfield &= ~mask;
1009
1010     /* The i-th bit was set. Do we have that copy? */
1011     /* Skip copies with mid < target */
1012     target = mid + i + 1;
1013     LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
1014     while (NULL != copy && GM_is_pid_bigger (target, copy->mid))
1015      copy = copy->next;
1016
1017     /* Did we run out of copies? (previously freed, it's ok) */
1018     if (NULL == copy)
1019     {
1020      LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
1021      return;
1022     }
1023
1024     /* Did we overshoot the target? (previously freed, it's ok) */
1025     if (GM_is_pid_bigger (copy->mid, target))
1026     {
1027      LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
1028      continue;
1029     }
1030
1031     /* Now copy->mid == target, free it */
1032     next = copy->next;
1033     GNUNET_break (GNUNET_YES != rel_message_free (copy, GNUNET_YES));
1034     copy = next;
1035   }
1036   LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
1037 }
1038
1039
1040 /**
1041  * Destroy a reliable message after it has been acknowledged, either by
1042  * direct mid ACK or bitfield. Updates the appropriate data structures and
1043  * timers and frees all memory.
1044  *
1045  * @param copy Message that is no longer needed: remote peer got it.
1046  * @param update_time Is the timing information relevant?
1047  *                    If this message is ACK in a batch the timing information
1048  *                    is skewed by the retransmission, count only for the
1049  *                    retransmitted message.
1050  *
1051  * @return #GNUNET_YES if channel was destroyed as a result of the call,
1052  *         #GNUNET_NO otherwise.
1053  */
1054 static int
1055 rel_message_free (struct MeshReliableMessage *copy, int update_time)
1056 {
1057   struct MeshChannelReliability *rel;
1058   struct GNUNET_TIME_Relative time;
1059
1060   rel = copy->rel;
1061   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
1062   if (update_time)
1063   {
1064     time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
1065     if (0 == rel->expected_delay.rel_value_us)
1066       rel->expected_delay = time;
1067     else
1068     {
1069       rel->expected_delay.rel_value_us *= 7;
1070       rel->expected_delay.rel_value_us += time.rel_value_us;
1071       rel->expected_delay.rel_value_us /= 8;
1072     }
1073     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  took %s\n",
1074                 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
1075     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  new expected delay %s\n",
1076                 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
1077                                                         GNUNET_NO));
1078     rel->retry_timer = rel->expected_delay;
1079   }
1080   else
1081   {
1082     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! batch free, ignoring timing\n");
1083   }
1084   rel->ch->pending_messages--;
1085   if (NULL != copy->q)
1086   {
1087     GMT_cancel (copy->q->q);
1088     /* copy->q is set to NULL by ch_message_sent */
1089   }
1090   GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
1091   LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE %p\n", copy);
1092   GNUNET_free (copy);
1093
1094   if (GNUNET_NO != rel->ch->destroy && 0 == rel->ch->pending_messages)
1095   {
1096     struct MeshTunnel3 *t = rel->ch->t;
1097     GMCH_destroy (rel->ch);
1098     GMT_destroy_if_empty (t);
1099     return GNUNET_YES;
1100   }
1101   return GNUNET_NO;
1102 }
1103
1104
1105 /**
1106  * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
1107  *
1108  * @param ch Channel to mark as ready.
1109  * @param fwd Was the ACK message a FWD ACK? (dest->root, SYNACK)
1110  */
1111 static void
1112 channel_confirm (struct MeshChannel *ch, int fwd)
1113 {
1114   struct MeshChannelReliability *rel;
1115   enum MeshChannelState oldstate;
1116
1117   LOG (GNUNET_ERROR_TYPE_DEBUG,
1118               "  channel confirm %s %s\n",
1119               GM_f2s (fwd), GMCH_2s (ch));
1120   oldstate = ch->state;
1121   ch->state = MESH_CHANNEL_READY;
1122
1123   rel = fwd ? ch->root_rel : ch->dest_rel;
1124   rel->client_ready = GNUNET_YES;
1125   LOG (GNUNET_ERROR_TYPE_DEBUG,
1126        "  !! retry timer confirm %s\n",
1127        GNUNET_STRINGS_relative_time_to_string (rel->retry_timer, GNUNET_NO));
1128   rel->expected_delay = rel->retry_timer;
1129   if (GMT_get_connections_buffer (ch->t) > 0 || GMT_is_loopback (ch->t))
1130     send_client_ack (ch, fwd);
1131
1132   if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1133   {
1134     GNUNET_SCHEDULER_cancel (rel->retry_task);
1135     rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1136   }
1137   else if (NULL != rel->uniq)
1138   {
1139     GMT_cancel (rel->uniq->q);
1140     /* ch_message_sent will free and NULL uniq */
1141   }
1142   else
1143   {
1144     if (GNUNET_NO == is_loopback (ch))
1145     {
1146       /* We SHOULD have been trying to retransmit this! */
1147       GNUNET_break (oldstate == MESH_CHANNEL_READY);
1148     }
1149   }
1150
1151   /* In case of a FWD ACK (SYNACK) send a BCK ACK (ACK). */
1152   if (GNUNET_YES == fwd)
1153     send_ack (ch, GNUNET_NO);
1154 }
1155
1156
1157 /**
1158  * Save a copy to retransmit in case it gets lost.
1159  *
1160  * Initializes all needed callbacks and timers.
1161  *
1162  * @param ch Channel this message goes on.
1163  * @param msg Message to copy.
1164  * @param fwd Is this fwd traffic?
1165  */
1166 static struct MeshReliableMessage *
1167 channel_save_copy (struct MeshChannel *ch,
1168                    const struct GNUNET_MessageHeader *msg,
1169                    int fwd)
1170 {
1171   struct MeshChannelReliability *rel;
1172   struct MeshReliableMessage *copy;
1173   uint32_t mid;
1174   uint16_t type;
1175   uint16_t size;
1176
1177   rel = fwd ? ch->root_rel : ch->dest_rel;
1178   mid = rel->mid_send - 1;
1179   type = ntohs (msg->type);
1180   size = ntohs (msg->size);
1181
1182   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u %s\n", mid, GM_m2s (type));
1183   copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
1184   LOG (GNUNET_ERROR_TYPE_DEBUG, "  at %p\n", copy);
1185   copy->mid = mid;
1186   copy->rel = rel;
1187   copy->type = type;
1188   memcpy (&copy[1], msg, size);
1189   GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
1190   ch->pending_messages++;
1191
1192   return copy;
1193 }
1194
1195
1196 /**
1197  * Create a new channel.
1198  *
1199  * @param t Tunnel this channel is in.
1200  * @param owner Client that owns the channel, NULL for foreign channels.
1201  * @param lid_root Local ID for root client.
1202  *
1203  * @return A new initialized channel. NULL on error.
1204  */
1205 static struct MeshChannel *
1206 channel_new (struct MeshTunnel3 *t,
1207              struct MeshClient *owner,
1208              MESH_ChannelNumber lid_root)
1209 {
1210   struct MeshChannel *ch;
1211
1212   ch = GNUNET_new (struct MeshChannel);
1213   ch->root = owner;
1214   ch->lid_root = lid_root;
1215   ch->t = t;
1216
1217   GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
1218
1219   if (NULL != owner)
1220   {
1221     ch->gid = GMT_get_next_chid (t);
1222     GML_channel_add (owner, lid_root, ch);
1223   }
1224   GMT_add_channel (t, ch);
1225
1226   return ch;
1227 }
1228
1229
1230 /**
1231  * Handle a loopback message: call the appropriate handler for the message type.
1232  *
1233  * @param ch Channel this message is on.
1234  * @param msgh Message header.
1235  * @param fwd Is this FWD traffic?
1236  */
1237 void
1238 handle_loopback (struct MeshChannel *ch,
1239                  const struct GNUNET_MessageHeader *msgh,
1240                  int fwd)
1241 {
1242   uint16_t type;
1243
1244   type = ntohs (msgh->type);
1245   LOG (GNUNET_ERROR_TYPE_DEBUG,
1246        "Loopback %s %s message!\n",
1247        GM_f2s (fwd), GM_m2s (type));
1248
1249   switch (type)
1250   {
1251     case GNUNET_MESSAGE_TYPE_MESH_DATA:
1252       /* Don't send hop ACK, wait for client to ACK */
1253       GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
1254       break;
1255
1256     case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1257       GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1258       break;
1259
1260     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1261       GMCH_handle_create (ch->t,
1262                           (struct GNUNET_MESH_ChannelCreate *) msgh);
1263       break;
1264
1265     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1266       GMCH_handle_ack (ch,
1267                        (struct GNUNET_MESH_ChannelManage *) msgh,
1268                        fwd);
1269       break;
1270
1271     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1272       GMCH_handle_nack (ch);
1273       break;
1274
1275     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1276       GMCH_handle_destroy (ch,
1277                            (struct GNUNET_MESH_ChannelManage *) msgh,
1278                            fwd);
1279       break;
1280
1281     default:
1282       GNUNET_break_op (0);
1283       LOG (GNUNET_ERROR_TYPE_DEBUG,
1284            "end-to-end message not known (%u)\n",
1285            ntohs (msgh->type));
1286   }
1287 }
1288
1289
1290
1291 /******************************************************************************/
1292 /********************************    API    ***********************************/
1293 /******************************************************************************/
1294
1295 /**
1296  * Destroy a channel and free all resources.
1297  *
1298  * @param ch Channel to destroy.
1299  */
1300 void
1301 GMCH_destroy (struct MeshChannel *ch)
1302 {
1303   struct MeshClient *c;
1304
1305   if (NULL == ch)
1306     return;
1307   if (2 == ch->destroy)
1308     return; /* recursive call */
1309   ch->destroy = 2;
1310
1311   LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
1312               GMT_2s (ch->t), ch->gid);
1313   GMCH_debug (ch);
1314
1315   c = ch->root;
1316   if (NULL != c)
1317   {
1318     GML_channel_remove (c, ch->lid_root, ch);
1319   }
1320
1321   c = ch->dest;
1322   if (NULL != c)
1323   {
1324     GML_channel_remove (c, ch->lid_dest, ch);
1325   }
1326
1327   channel_rel_free_all (ch->root_rel);
1328   channel_rel_free_all (ch->dest_rel);
1329
1330   GMT_remove_channel (ch->t, ch);
1331   GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
1332
1333   GNUNET_free (ch);
1334 }
1335
1336
1337 /**
1338  * Get channel ID.
1339  *
1340  * @param ch Channel.
1341  *
1342  * @return ID
1343  */
1344 MESH_ChannelNumber
1345 GMCH_get_id (const struct MeshChannel *ch)
1346 {
1347   return ch->gid;
1348 }
1349
1350
1351 /**
1352  * Get the channel tunnel.
1353  *
1354  * @param ch Channel to get the tunnel from.
1355  *
1356  * @return tunnel of the channel.
1357  */
1358 struct MeshTunnel3 *
1359 GMCH_get_tunnel (const struct MeshChannel *ch)
1360 {
1361   return ch->t;
1362 }
1363
1364
1365 /**
1366  * Get free buffer space towards the client on a specific channel.
1367  *
1368  * @param ch Channel.
1369  * @param fwd Is query about FWD traffic?
1370  *
1371  * @return Free buffer space [0 - 64]
1372  */
1373 unsigned int
1374 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1375 {
1376   struct MeshChannelReliability *rel;
1377
1378   rel = fwd ? ch->dest_rel : ch->root_rel;
1379
1380   /* If rel is NULL it means that the end is not yet created,
1381    * most probably is a loopback channel at the point of sending
1382    * the ChannelCreate to itself.
1383    */
1384   if (NULL == rel)
1385     return 64;
1386
1387   return (64 - rel->n_recv);
1388 }
1389
1390
1391 /**
1392  * Get flow control status of end point: is client allow to send?
1393  *
1394  * @param ch Channel.
1395  * @param fwd Is query about FWD traffic? (Request root status).
1396  *
1397  * @return #GNUNET_YES if client is allowed to send us data.
1398  */
1399 int
1400 GMCH_get_allowed (struct MeshChannel *ch, int fwd)
1401 {
1402   struct MeshChannelReliability *rel;
1403
1404   rel = fwd ? ch->root_rel : ch->dest_rel;
1405
1406   if (NULL == rel)
1407   {
1408     /* Probably shutting down: root/dest NULL'ed to mark disconnection */
1409     GNUNET_break (GNUNET_NO != ch->destroy);
1410     return 0;
1411   }
1412
1413   return rel->client_allowed;
1414 }
1415
1416
1417 /**
1418  * Is the root client for this channel on this peer?
1419  *
1420  * @param ch Channel.
1421  * @param fwd Is this for fwd traffic?
1422  *
1423  * @return #GNUNET_YES in case it is.
1424  */
1425 int
1426 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1427 {
1428   struct MeshClient *c;
1429
1430   c = fwd ? ch->root : ch->dest;
1431   return NULL != c;
1432 }
1433
1434
1435 /**
1436  * Is the destination client for this channel on this peer?
1437  *
1438  * @param ch Channel.
1439  * @param fwd Is this for fwd traffic?
1440  *
1441  * @return #GNUNET_YES in case it is.
1442  */
1443 int
1444 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1445 {
1446   struct MeshClient *c;
1447
1448   c = fwd ? ch->dest : ch->root;
1449   return NULL != c;
1450 }
1451
1452
1453 /**
1454  * Send an end-to-end ACK message for the most recent in-sequence payload.
1455  *
1456  * If channel is not reliable, do nothing.
1457  *
1458  * @param ch Channel this is about.
1459  * @param fwd Is for FWD traffic? (ACK dest->owner)
1460  */
1461 void
1462 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1463 {
1464   struct GNUNET_MESH_DataACK msg;
1465   struct MeshChannelReliability *rel;
1466   struct MeshReliableMessage *copy;
1467   unsigned int delta;
1468   uint64_t mask;
1469   uint32_t ack;
1470
1471   if (GNUNET_NO == ch->reliable)
1472   {
1473     return;
1474   }
1475   rel = fwd ? ch->dest_rel : ch->root_rel;
1476   ack = rel->mid_recv - 1;
1477   LOG (GNUNET_ERROR_TYPE_DEBUG,
1478               " !! Send DATA_ACK for %u\n",
1479               ack);
1480
1481   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA_ACK);
1482   msg.header.size = htons (sizeof (msg));
1483   msg.chid = htonl (ch->gid);
1484   msg.futures = 0;
1485   for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1486   {
1487     if (copy->type != GNUNET_MESSAGE_TYPE_MESH_DATA)
1488     {
1489       LOG (GNUNET_ERROR_TYPE_DEBUG,
1490            "!!  Type %s, expected DATA\n",
1491            GM_m2s (copy->type));
1492       continue;
1493     }
1494     if (copy->mid == ack + 1)
1495     {
1496       ack++;
1497       continue;
1498     }
1499     delta = copy->mid - (ack + 1);
1500     if (63 < delta)
1501       break;
1502     mask = 0x1LL << delta;
1503     msg.futures |= mask;
1504     LOG (GNUNET_ERROR_TYPE_DEBUG,
1505          " !! setting bit for %u (delta %u) (%llX) -> %llX\n",
1506          copy->mid, delta, mask, msg.futures);
1507   }
1508   msg.mid = htonl (ack);
1509   LOG (GNUNET_ERROR_TYPE_DEBUG,
1510        "!!! ACK for %u, futures %llX\n",
1511        ack, msg.futures);
1512
1513   GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
1514   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1515 }
1516
1517
1518 /**
1519  * Allow a client to send us more data, in case it was choked.
1520  *
1521  * @param ch Channel.
1522  * @param fwd Is this about FWD traffic? (Root client).
1523  */
1524 void
1525 GMCH_allow_client (struct MeshChannel *ch, int fwd)
1526 {
1527   struct MeshChannelReliability *rel;
1528   unsigned int buffer;
1529
1530   LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH allow\n");
1531
1532   if (MESH_CHANNEL_READY != ch->state)
1533   {
1534     LOG (GNUNET_ERROR_TYPE_DEBUG, " channel not ready yet!\n");
1535     return;
1536   }
1537
1538   if (GNUNET_YES == ch->reliable)
1539   {
1540     rel = fwd ? ch->root_rel : ch->dest_rel;
1541     if (NULL == rel)
1542     {
1543       GNUNET_break (GNUNET_NO != ch->destroy);
1544       return;
1545     }
1546     if (NULL != rel->head_sent)
1547     {
1548       if (64 <= rel->mid_send - rel->head_sent->mid)
1549       {
1550         LOG (GNUNET_ERROR_TYPE_DEBUG, " too big MID gap! Wait for ACK.\n");
1551         return;
1552       }
1553       else
1554         LOG (GNUNET_ERROR_TYPE_DEBUG, " gap ok: %u - %u\n",
1555              rel->head_sent->mid, rel->mid_send);
1556     }
1557     else
1558     {
1559       LOG (GNUNET_ERROR_TYPE_DEBUG, " head sent is NULL\n");
1560     }
1561   }
1562
1563   if (is_loopback (ch))
1564     buffer = GMCH_get_buffer (ch, fwd);
1565   else
1566     buffer = GMT_get_connections_buffer (ch->t);
1567
1568   if (0 == buffer)
1569   {
1570     LOG (GNUNET_ERROR_TYPE_DEBUG, " no buffer space.\n");
1571     return;
1572   }
1573
1574   LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space %u, allowing\n", buffer);
1575   send_client_ack (ch, fwd);
1576 }
1577
1578
1579 /**
1580  * Log channel info.
1581  *
1582  * @param ch Channel.
1583  */
1584 void
1585 GMCH_debug (struct MeshChannel *ch)
1586 {
1587   if (NULL == ch)
1588   {
1589     LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1590     return;
1591   }
1592   LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1593               GMT_2s (ch->t), ch->gid, ch);
1594   LOG (GNUNET_ERROR_TYPE_DEBUG, "  root %p/%p\n",
1595               ch->root, ch->root_rel);
1596   if (NULL != ch->root)
1597   {
1598     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cli %s\n", GML_2s (ch->root));
1599     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ready %s\n",
1600                 ch->root_rel->client_ready ? "YES" : "NO");
1601     LOG (GNUNET_ERROR_TYPE_DEBUG, "  id %X\n", ch->lid_root);
1602   }
1603   LOG (GNUNET_ERROR_TYPE_DEBUG, "  dest %p/%p\n",
1604               ch->dest, ch->dest_rel);
1605   if (NULL != ch->dest)
1606   {
1607     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cli %s\n", GML_2s (ch->dest));
1608     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ready %s\n",
1609                 ch->dest_rel->client_ready ? "YES" : "NO");
1610     LOG (GNUNET_ERROR_TYPE_DEBUG, "  id %X\n", ch->lid_dest);
1611   }
1612 }
1613
1614
1615 /**
1616  * Handle an ACK given by a client.
1617  *
1618  * Mark client as ready and send him any buffered data we could have for him.
1619  *
1620  * @param ch Channel.
1621  * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by dest and go BCK)
1622  */
1623 void
1624 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1625 {
1626   struct MeshChannelReliability *rel;
1627   struct MeshClient *c;
1628
1629   rel = fwd ? ch->dest_rel : ch->root_rel;
1630   c   = fwd ? ch->dest     : ch->root;
1631
1632   rel->client_ready = GNUNET_YES;
1633   send_client_buffered_data (ch, c, fwd);
1634   if (is_loopback (ch))
1635   {
1636     unsigned int buffer;
1637
1638     buffer = GMCH_get_buffer (ch, fwd);
1639     if (0 < buffer)
1640       GMCH_allow_client (ch, fwd);
1641
1642     return;
1643   }
1644   GMT_send_connection_acks (ch->t);
1645 }
1646
1647
1648 /**
1649  * Handle data given by a client.
1650  *
1651  * Check whether the client is allowed to send in this tunnel, save if channel
1652  * is reliable and send an ACK to the client if there is still buffer space
1653  * in the tunnel.
1654  *
1655  * @param ch Channel.
1656  * @param c Client which sent the data.
1657  * @param message Message.
1658  * @param fwd Is this a FWD data?
1659  *
1660  * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1661  */
1662 int
1663 GMCH_handle_local_data (struct MeshChannel *ch,
1664                         struct MeshClient *c,
1665                         struct GNUNET_MessageHeader *message,
1666                         int fwd)
1667 {
1668   struct MeshChannelReliability *rel;
1669   struct GNUNET_MESH_Data *payload;
1670   size_t size = ntohs (message->size);
1671   uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1672   unsigned char cbuf[p2p_size];
1673
1674   /* Is the client in the channel? */
1675   if ( !( (fwd &&
1676            ch->root == c)
1677          ||
1678           (!fwd &&
1679            ch->dest == c) ) )
1680   {
1681     GNUNET_break_op (0);
1682     return GNUNET_SYSERR;
1683   }
1684
1685   rel = fwd ? ch->root_rel : ch->dest_rel;
1686
1687   if (GNUNET_NO == rel->client_allowed)
1688   {
1689     GNUNET_break_op (0);
1690     return GNUNET_SYSERR;
1691   }
1692
1693   rel->client_allowed = GNUNET_NO;
1694
1695   /* Ok, everything is correct, send the message. */
1696   payload = (struct GNUNET_MESH_Data *) cbuf;
1697   payload->mid = htonl (rel->mid_send);
1698   rel->mid_send++;
1699   memcpy (&payload[1], message, size);
1700   payload->header.size = htons (p2p_size);
1701   payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1702   payload->chid = htonl (ch->gid);
1703   LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on channel...\n");
1704   GMCH_send_prebuilt_message (&payload->header, ch, fwd, NULL);
1705
1706   if (is_loopback (ch))
1707   {
1708     if (GMCH_get_buffer (ch, fwd) > 0)
1709       GMCH_allow_client (ch, fwd);
1710
1711     return GNUNET_OK;
1712   }
1713
1714   if (GMT_get_connections_buffer (ch->t) > 0)
1715   {
1716     GMCH_allow_client (ch, fwd);
1717   }
1718
1719   return GNUNET_OK;
1720 }
1721
1722
1723 /**
1724  * Handle a channel destroy requested by a client.
1725  *
1726  * Destroy the channel and the tunnel in case this was the last channel.
1727  *
1728  * @param ch Channel.
1729  * @param c Client that requested the destruction (to avoid notifying him).
1730  * @param is_root Is the request coming from root?
1731  */
1732 void
1733 GMCH_handle_local_destroy (struct MeshChannel *ch,
1734                            struct MeshClient *c,
1735                            int is_root)
1736 {
1737   struct MeshTunnel3 *t;
1738
1739   ch->destroy = GNUNET_YES;
1740   /* Cleanup after the tunnel */
1741   if (GNUNET_NO == is_root && c == ch->dest)
1742   {
1743     LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1744     GML_client_delete_channel (c, ch, ch->lid_dest);
1745     ch->dest = NULL;
1746   }
1747   if (GNUNET_YES == is_root && c == ch->root)
1748   {
1749     LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1750     GML_client_delete_channel (c, ch, ch->lid_root);
1751     ch->root = NULL;
1752   }
1753
1754   t = ch->t;
1755   send_destroy (ch, GNUNET_NO);
1756   if (0 == ch->pending_messages)
1757   {
1758     GMCH_destroy (ch);
1759     GMT_destroy_if_empty (t);
1760   }
1761 }
1762
1763
1764 /**
1765  * Handle a channel create requested by a client.
1766  *
1767  * Create the channel and the tunnel in case this was the first0 channel.
1768  *
1769  * @param c Client that requested the creation (will be the root).
1770  * @param msg Create Channel message.
1771  *
1772  * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1773  */
1774 int
1775 GMCH_handle_local_create (struct MeshClient *c,
1776                           struct GNUNET_MESH_ChannelMessage *msg)
1777 {
1778   struct MeshChannel *ch;
1779   struct MeshTunnel3 *t;
1780   struct MeshPeer *peer;
1781   MESH_ChannelNumber chid;
1782
1783   LOG (GNUNET_ERROR_TYPE_DEBUG, "  towards %s:%u\n",
1784               GNUNET_i2s (&msg->peer), ntohl (msg->port));
1785   chid = ntohl (msg->channel_id);
1786
1787   /* Sanity check for duplicate channel IDs */
1788   if (NULL != GML_channel_get (c, chid))
1789   {
1790     GNUNET_break (0);
1791     return GNUNET_SYSERR;
1792   }
1793
1794   peer = GMP_get (&msg->peer);
1795   GMP_add_tunnel (peer);
1796   t = GMP_get_tunnel (peer);
1797
1798   if (GMP_get_short_id (peer) == myid)
1799   {
1800     GMT_change_cstate (t, MESH_TUNNEL3_READY);
1801   }
1802   else
1803   {
1804     GMP_connect (peer);
1805   }
1806
1807   /* Create channel */
1808   ch = channel_new (t, c, chid);
1809   if (NULL == ch)
1810   {
1811     GNUNET_break (0);
1812     return GNUNET_SYSERR;
1813   }
1814   ch->port = ntohl (msg->port);
1815   channel_set_options (ch, ntohl (msg->opt));
1816
1817   /* In unreliable channels, we'll use the DLL to buffer BCK data */
1818   ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1819   ch->root_rel->ch = ch;
1820   ch->root_rel->retry_timer = MESH_RETRANSMIT_TIME;
1821   ch->root_rel->expected_delay.rel_value_us = 0;
1822
1823   LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1824
1825   send_create (ch);
1826
1827   return GNUNET_OK;
1828 }
1829
1830
1831 /**
1832  * Handler for mesh network payload traffic.
1833  *
1834  * @param ch Channel for the message.
1835  * @param msg Unencryted data message.
1836  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1837  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1838  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1839  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1840  */
1841 void
1842 GMCH_handle_data (struct MeshChannel *ch,
1843                   const struct GNUNET_MESH_Data *msg,
1844                   int fwd)
1845 {
1846   struct MeshChannelReliability *rel;
1847   struct MeshClient *c;
1848   uint32_t mid;
1849
1850   /* If this is a remote (non-loopback) channel, find 'fwd'. */
1851   if (GNUNET_SYSERR == fwd)
1852   {
1853     if (is_loopback (ch))
1854     {
1855       /* It is a loopback channel after all... */
1856       GNUNET_break (0);
1857       return;
1858     }
1859     fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
1860   }
1861
1862   /*  Initialize FWD/BCK data */
1863   c   = fwd ? ch->dest     : ch->root;
1864   rel = fwd ? ch->dest_rel : ch->root_rel;
1865
1866   if (NULL == c)
1867   {
1868     GNUNET_break (0);
1869     return;
1870   }
1871
1872   if (MESH_CHANNEL_READY != ch->state)
1873   {
1874     if (GNUNET_NO == fwd)
1875     {
1876       /* If we are the root, this means the other peer has sent traffic before
1877        * receiving our ACK. Even if the SYNACK goes missing, no traffic should
1878        * be sent before the ACK.
1879        */
1880       GNUNET_break_op (0);
1881       return;
1882     }
1883     /* If we are the dest, this means that the SYNACK got to the root but
1884      * the ACK went missing. Treat this as an ACK.
1885      */
1886     channel_confirm (ch, GNUNET_NO);
1887   }
1888
1889   GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1890
1891   mid = ntohl (msg->mid);
1892   LOG (GNUNET_ERROR_TYPE_DEBUG, "!! got mid %u\n", mid);
1893
1894   if (GNUNET_NO == ch->reliable ||
1895       ( !GM_is_pid_bigger (rel->mid_recv, mid) &&
1896         GM_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1897   {
1898     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1899     if (GNUNET_YES == ch->reliable)
1900     {
1901       /* Is this the exact next expected messasge? */
1902       if (mid == rel->mid_recv)
1903       {
1904         LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1905         rel->mid_recv++;
1906         send_client_data (ch, msg, fwd);
1907       }
1908       else
1909       {
1910         LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1911         add_buffered_data (msg, rel);
1912       }
1913     }
1914     else
1915     {
1916       /* Tunnel is unreliable: send to clients directly */
1917       /* FIXME: accept Out Of Order traffic */
1918       rel->mid_recv = mid + 1;
1919       send_client_data (ch, msg, fwd);
1920     }
1921   }
1922   else
1923   {
1924     GNUNET_break_op (GM_is_pid_bigger (rel->mid_recv, mid));
1925     LOG (GNUNET_ERROR_TYPE_DEBUG,
1926                 " !!! MID %u not expected (%u - %u), dropping!\n",
1927                 mid, rel->mid_recv, rel->mid_recv + 63);
1928   }
1929
1930   GMCH_send_data_ack (ch, fwd);
1931 }
1932
1933
1934 /**
1935  * Handler for mesh network traffic end-to-end ACKs.
1936  *
1937  * @param ch Channel on which we got this message.
1938  * @param msg Data message.
1939  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1940  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1941  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1942  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1943  */
1944 void
1945 GMCH_handle_data_ack (struct MeshChannel *ch,
1946                       const struct GNUNET_MESH_DataACK *msg,
1947                       int fwd)
1948 {
1949   struct MeshChannelReliability *rel;
1950   struct MeshReliableMessage *copy;
1951   struct MeshReliableMessage *next;
1952   uint32_t ack;
1953   int work;
1954
1955   /* If this is a remote (non-loopback) channel, find 'fwd'. */
1956   if (GNUNET_SYSERR == fwd)
1957   {
1958     if (is_loopback (ch))
1959     {
1960       /* It is a loopback channel after all... */
1961       GNUNET_break (0);
1962       return;
1963     }
1964     /* Inverted: if message came 'FWD' is a 'BCK ACK'. */
1965     fwd = (NULL != ch->dest) ? GNUNET_NO : GNUNET_YES;
1966   }
1967
1968   ack = ntohl (msg->mid);
1969   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1970        (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1971
1972   if (GNUNET_YES == fwd)
1973   {
1974     rel = ch->root_rel;
1975   }
1976   else
1977   {
1978     rel = ch->dest_rel;
1979   }
1980   if (NULL == rel)
1981   {
1982     GNUNET_break_op (0);
1983     return;
1984   }
1985
1986   /* Free ACK'd copies: no need to retransmit those anymore */
1987   for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
1988   {
1989     if (GM_is_pid_bigger (copy->mid, ack))
1990     {
1991       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  head %u, out!\n", copy->mid);
1992       channel_rel_free_sent (rel, msg);
1993       break;
1994     }
1995     work = GNUNET_YES;
1996     LOG (GNUNET_ERROR_TYPE_DEBUG, " !!  id %u\n", copy->mid);
1997     next = copy->next;
1998     if (GNUNET_YES == rel_message_free (copy, GNUNET_YES))
1999       return;
2000   }
2001
2002   /* ACK client if needed */
2003   GMCH_allow_client (ch, fwd);
2004
2005   /* If some message was free'd, update the retransmission delay */
2006   if (GNUNET_YES == work)
2007   {
2008     if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
2009     {
2010       GNUNET_SCHEDULER_cancel (rel->retry_task);
2011       rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
2012       if (NULL != rel->head_sent && NULL == rel->head_sent->q)
2013       {
2014         struct GNUNET_TIME_Absolute new_target;
2015         struct GNUNET_TIME_Relative delay;
2016
2017         delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
2018                                                MESH_RETRANSMIT_MARGIN);
2019         new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
2020                                                delay);
2021         delay = GNUNET_TIME_absolute_get_remaining (new_target);
2022         rel->retry_task =
2023             GNUNET_SCHEDULER_add_delayed (delay,
2024                                           &channel_retransmit_message,
2025                                           rel);
2026       }
2027     }
2028     else /* work was done but no task was pending? shouldn't happen! */
2029     {
2030       GNUNET_break (0);
2031     }
2032   }
2033 }
2034
2035
2036 /**
2037  * Handler for channel create messages.
2038  *
2039  * Does not have fwd parameter because it's always 'FWD': channel is incoming.
2040  *
2041  * @param t Tunnel this channel will be in.
2042  * @param msg Channel crate message.
2043  */
2044 struct MeshChannel *
2045 GMCH_handle_create (struct MeshTunnel3 *t,
2046                     const struct GNUNET_MESH_ChannelCreate *msg)
2047 {
2048   MESH_ChannelNumber chid;
2049   struct MeshChannel *ch;
2050   struct MeshClient *c;
2051   int new_channel;
2052
2053   chid = ntohl (msg->chid);
2054   ch = GMT_get_channel (t, chid);
2055   if (NULL == ch)
2056   {
2057     /* Create channel */
2058     ch = channel_new (t, NULL, 0);
2059     ch->gid = chid;
2060     channel_set_options (ch, ntohl (msg->opt));
2061     new_channel = GNUNET_YES;
2062   }
2063   else
2064   {
2065     new_channel = GNUNET_NO;
2066   }
2067
2068   if (GNUNET_YES == new_channel || GMT_is_loopback (t))
2069   {
2070     /* Find a destination client */
2071     ch->port = ntohl (msg->port);
2072     LOG (GNUNET_ERROR_TYPE_DEBUG, "   port %u\n", ch->port);
2073     c = GML_client_get_by_port (ch->port);
2074     if (NULL == c)
2075     {
2076       LOG (GNUNET_ERROR_TYPE_DEBUG, "  no client has port registered\n");
2077       if (is_loopback (ch))
2078       {
2079         LOG (GNUNET_ERROR_TYPE_DEBUG, "  loopback: destroy on handler\n");
2080         send_nack (ch);
2081       }
2082       else
2083       {
2084         LOG (GNUNET_ERROR_TYPE_DEBUG, "  not loopback: destroy now\n");
2085         send_nack (ch);
2086         GMCH_destroy (ch);
2087       }
2088       return NULL;
2089     }
2090     else
2091     {
2092       LOG (GNUNET_ERROR_TYPE_DEBUG, "  client %p has port registered\n", c);
2093     }
2094
2095     add_destination (ch, c);
2096     if (GNUNET_YES == ch->reliable)
2097       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
2098     else
2099       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Not Reliable\n");
2100
2101     send_client_create (ch);
2102     ch->state =  MESH_CHANNEL_SENT;
2103   }
2104   else
2105   {
2106     LOG (GNUNET_ERROR_TYPE_DEBUG, "  duplicate create channel\n");
2107   }
2108   send_ack (ch, GNUNET_YES);
2109
2110   return ch;
2111 }
2112
2113
2114 /**
2115  * Handler for channel NACK messages.
2116  *
2117  * NACK messages always go dest -> root, no need for 'fwd' or 'msg' parameter.
2118  *
2119  * @param ch Channel.
2120  */
2121 void
2122 GMCH_handle_nack (struct MeshChannel *ch)
2123 {
2124   send_client_nack (ch);
2125   GMCH_destroy (ch);
2126 }
2127
2128
2129 /**
2130  * Handler for channel ack messages.
2131  *
2132  * @param ch Channel.
2133  * @param msg Message.
2134  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2135  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
2136  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
2137  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
2138  */
2139 void
2140 GMCH_handle_ack (struct MeshChannel *ch,
2141                  const struct GNUNET_MESH_ChannelManage *msg,
2142                  int fwd)
2143 {
2144   /* If this is a remote (non-loopback) channel, find 'fwd'. */
2145   if (GNUNET_SYSERR == fwd)
2146   {
2147     if (is_loopback (ch))
2148     {
2149       /* It is a loopback channel after all... */
2150       GNUNET_break (0);
2151       return;
2152     }
2153     fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2154   }
2155
2156   channel_confirm (ch, !fwd);
2157 }
2158
2159
2160 /**
2161  * Handler for channel destroy messages.
2162  *
2163  * @param ch Channel to be destroyed of.
2164  * @param msg Message.
2165  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2166  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
2167  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
2168  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
2169  */
2170 void
2171 GMCH_handle_destroy (struct MeshChannel *ch,
2172                      const struct GNUNET_MESH_ChannelManage *msg,
2173                      int fwd)
2174 {
2175   struct MeshTunnel3 *t;
2176
2177   /* If this is a remote (non-loopback) channel, find 'fwd'. */
2178   if (GNUNET_SYSERR == fwd)
2179   {
2180     if (is_loopback (ch))
2181     {
2182       /* It is a loopback channel after all... */
2183       GNUNET_break (0);
2184       return;
2185     }
2186     fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2187   }
2188
2189   GMCH_debug (ch);
2190   if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
2191   {
2192     /* Not for us (don't destroy twice a half-open loopback channel) */
2193     return;
2194   }
2195
2196   t = ch->t;
2197   send_destroy (ch, GNUNET_YES);
2198   GMCH_destroy (ch);
2199   GMT_destroy_if_empty (t);
2200 }
2201
2202
2203 /**
2204  * Sends an already built message on a channel.
2205  *
2206  * If the channel is on a loopback tunnel, notifies the appropriate destination
2207  * client locally.
2208  *
2209  * On a normal channel passes the message to the tunnel for encryption and
2210  * sending on a connection.
2211  *
2212  * This function DOES NOT save the message for retransmission.
2213  *
2214  * @param message Message to send. Function makes a copy of it.
2215  * @param ch Channel on which this message is transmitted.
2216  * @param fwd Is this a fwd message?
2217  * @param existing_copy This is a retransmission, don't save a copy.
2218  */
2219 void
2220 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2221                             struct MeshChannel *ch, int fwd,
2222                             void *existing_copy)
2223 {
2224   struct MeshChannelQueue *q;
2225   uint16_t type;
2226
2227   type = ntohs (message->type);
2228   LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH Send %s %s on channel %s\n",
2229        GM_f2s (fwd), GM_m2s (type),
2230        GMCH_2s (ch));
2231
2232   if (GMT_is_loopback (ch->t))
2233   {
2234     handle_loopback (ch, message, fwd);
2235     return;
2236   }
2237
2238   switch (type)
2239   {
2240     case GNUNET_MESSAGE_TYPE_MESH_DATA:
2241
2242       if (GNUNET_YES == ch->reliable)
2243       {
2244         q = GNUNET_new (struct MeshChannelQueue);
2245         q->type = type;
2246         if (NULL == existing_copy)
2247           q->copy = channel_save_copy (ch, message, fwd);
2248         else
2249         {
2250           q->copy = (struct MeshReliableMessage *) existing_copy;
2251           if (NULL != q->copy->q)
2252           {
2253             /* Last retransmission was queued but not yet sent!
2254              * This retransmission was scheduled by a ch_message_sent which
2255              * followed a very fast RTT, so the tiny delay made the
2256              * retransmission function to execute before the previous
2257              * retransmitted message even had a chance to leave the peer.
2258              * Cancel this message and wait until the pending
2259              * retransmission leaves the peer and ch_message_sent starts
2260              * the timer for the next one.
2261              */
2262             GNUNET_free (q);
2263             LOG (GNUNET_ERROR_TYPE_DEBUG,
2264                  "  exisitng copy not yet transmitted!\n");
2265             return;
2266           }
2267           LOG (GNUNET_ERROR_TYPE_DEBUG,
2268                "  using existing copy: %p {r:%p q:%p t:%u}\n",
2269                existing_copy,
2270                q->copy->rel, q->copy->q, q->copy->type);
2271         }
2272         LOG (GNUNET_ERROR_TYPE_DEBUG, "  new q: %p\n", q);
2273         q->copy->q = q;
2274         q->q = GMT_send_prebuilt_message (message, ch->t,
2275                                           NULL != existing_copy,
2276                                           &ch_message_sent, q);
2277         /* q itself is stored in copy */
2278         GNUNET_assert (NULL != q->q || GNUNET_NO != ch->destroy);
2279       }
2280       else
2281       {
2282         fire_and_forget (message, ch, GNUNET_NO);
2283       }
2284       break;
2285
2286
2287     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
2288       if (GNUNET_YES == fwd)
2289       {
2290         /* BCK ACK (going FWD) is just a response for a SYNACK, don't keep*/
2291         fire_and_forget (message, ch, GNUNET_YES);
2292         break;
2293       }
2294       /* fall-trough */
2295     case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
2296     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
2297       q = GNUNET_new (struct MeshChannelQueue);
2298       q->type = type;
2299       q->rel = fwd ? ch->root_rel : ch->dest_rel;
2300       if (NULL != q->rel->uniq)
2301       {
2302         if (NULL != q->rel->uniq->q)
2303         {
2304           GMT_cancel (q->rel->uniq->q);
2305           /* ch_message_sent is called, freeing and NULLing uniq */
2306         }
2307         else
2308         {
2309           GNUNET_free (q->rel->uniq);
2310         }
2311       }
2312       q->q = GMT_send_prebuilt_message (message, ch->t, GNUNET_YES,
2313                                         &ch_message_sent, q);
2314       q->rel->uniq = q;
2315       break;
2316
2317
2318     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
2319     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
2320       fire_and_forget (message, ch, GNUNET_YES);
2321       break;
2322
2323
2324     default:
2325       GNUNET_break (0);
2326       LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s unknown!\n", GM_m2s (type));
2327       fire_and_forget (message, ch, GNUNET_YES);
2328   }
2329 }
2330
2331
2332 /**
2333  * Get the static string for identification of the channel.
2334  *
2335  * @param ch Channel.
2336  *
2337  * @return Static string with the channel IDs.
2338  */
2339 const char *
2340 GMCH_2s (const struct MeshChannel *ch)
2341 {
2342   static char buf[64];
2343
2344   if (NULL == ch)
2345     return "(NULL Channel)";
2346
2347   sprintf (buf, "%s:%u gid:%X (%X / %X)",
2348            GMT_2s (ch->t), ch->port, ch->gid, ch->lid_root, ch->lid_dest);
2349
2350   return buf;
2351 }