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