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, 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  * Sent 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 (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
 922   {
 923     GNUNET_SCHEDULER_cancel (rel->retry_task);
 924   }
 925   if (NULL != rel->uniq && NULL != rel->uniq->q)
 926     GMT_cancel (rel->uniq->q);
 927   GNUNET_free (rel);
 928 }
 929
 930
 931 /**
 932  * Mark future messages as ACK'd.
 933  *
 934  * @param rel Reliability data.
 935  * @param msg DataACK message with a bitfield of future ACK'd messages.
 936  */
 937 static void
 938 channel_rel_free_sent (struct MeshChannelReliability *rel,
 939                        const struct GNUNET_MESH_DataACK *msg)
 940 {
 941   struct MeshReliableMessage *copy;
 942   struct MeshReliableMessage *next;
 943   uint64_t bitfield;
 944   uint64_t mask;
 945   uint32_t mid;
 946   uint32_t target;
 947   unsigned int i;
 948
 949   bitfield = msg->futures;
 950   mid = ntohl (msg->mid);
 951   LOG (GNUNET_ERROR_TYPE_DEBUG,
 952               "!!! free_sent_reliable %u %llX\n",
 953               mid, bitfield);
 954   LOG (GNUNET_ERROR_TYPE_DEBUG,
 955               " rel %p, head %p\n",
 956               rel, rel->head_sent);
 957   for (i = 0, copy = rel->head_sent;
 958        i < 64 && NULL != copy && 0 != bitfield;
 959        i++)
 960   {
 961     LOG (GNUNET_ERROR_TYPE_DEBUG,
 962                 " trying bit %u (mid %u)\n",
 963                 i, mid + i + 1);
 964     mask = 0x1LL << i;
 965     if (0 == (bitfield & mask))
 966      continue;
 967
 968     LOG (GNUNET_ERROR_TYPE_DEBUG, " set!\n");
 969     /* Bit was set, clear the bit from the bitfield */
 970     bitfield &= ~mask;
 971
 972     /* The i-th bit was set. Do we have that copy? */
 973     /* Skip copies with mid < target */
 974     target = mid + i + 1;
 975     LOG (GNUNET_ERROR_TYPE_DEBUG, " target %u\n", target);
 976     while (NULL != copy && GM_is_pid_bigger (target, copy->mid))
 977      copy = copy->next;
 978
 979     /* Did we run out of copies? (previously freed, it's ok) */
 980     if (NULL == copy)
 981     {
 982      LOG (GNUNET_ERROR_TYPE_DEBUG, "run out of copies...\n");
 983      return;
 984     }
 985
 986     /* Did we overshoot the target? (previously freed, it's ok) */
 987     if (GM_is_pid_bigger (copy->mid, target))
 988     {
 989      LOG (GNUNET_ERROR_TYPE_DEBUG, " next copy %u\n", copy->mid);
 990      continue;
 991     }
 992
 993     /* Now copy->mid == target, free it */
 994     next = copy->next;
 995     rel_message_free (copy, GNUNET_YES);
 996     copy = next;
 997   }
 998   LOG (GNUNET_ERROR_TYPE_DEBUG, "free_sent_reliable END\n");
 999 }
1000
1001
1002 /**
1003  * Destroy a reliable message after it has been acknowledged, either by
1004  * direct mid ACK or bitfield. Updates the appropriate data structures and
1005  * timers and frees all memory.
1006  *
1007  * @param copy Message that is no longer needed: remote peer got it.
1008  * @param update_time Is the timing information relevant?
1009  *                    If this message is ACK in a batch the timing information
1010  *                    is skewed by the retransmission, count only for the
1011  *                    retransmitted message.
1012  */
1013 static void
1014 rel_message_free (struct MeshReliableMessage *copy, int update_time)
1015 {
1016   struct MeshChannelReliability *rel;
1017   struct GNUNET_TIME_Relative time;
1018
1019   rel = copy->rel;
1020   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Freeing %u\n", copy->mid);
1021   if (update_time)
1022   {
1023     time = GNUNET_TIME_absolute_get_duration (copy->timestamp);
1024     if (0 == rel->expected_delay.rel_value_us)
1025       rel->expected_delay = time;
1026     else
1027     {
1028       rel->expected_delay.rel_value_us *= 7;
1029       rel->expected_delay.rel_value_us += time.rel_value_us;
1030       rel->expected_delay.rel_value_us /= 8;
1031     }
1032     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  took %s\n",
1033                 GNUNET_STRINGS_relative_time_to_string (time, GNUNET_NO));
1034     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  new expected delay %s\n",
1035                 GNUNET_STRINGS_relative_time_to_string (rel->expected_delay,
1036                                                         GNUNET_NO));
1037     rel->retry_timer = rel->expected_delay;
1038   }
1039   else
1040   {
1041     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! batch free, ignoring timing\n");
1042   }
1043   rel->ch->pending_messages--;
1044   if (NULL != copy->q)
1045   {
1046     GMT_cancel (copy->q->q);
1047     /* copy->q is set to NULL by ch_message_sent */
1048   }
1049   GNUNET_CONTAINER_DLL_remove (rel->head_sent, rel->tail_sent, copy);
1050   LOG (GNUNET_ERROR_TYPE_DEBUG, " COPYFREE %p\n", copy);
1051   GNUNET_free (copy);
1052
1053   if (GNUNET_NO != rel->ch->destroy && 0 == rel->ch->pending_messages)
1054   {
1055     struct MeshTunnel3 *t = rel->ch->t;
1056     GMCH_destroy (rel->ch);
1057     GMT_destroy_if_empty (t);
1058   }
1059 }
1060
1061
1062 /**
1063  * Channel was ACK'd by remote peer, mark as ready and cancel retransmission.
1064  *
1065  * @param ch Channel to mark as ready.
1066  * @param fwd Was the ACK message a FWD ACK? (dest->root, SYNACK)
1067  */
1068 static void
1069 channel_confirm (struct MeshChannel *ch, int fwd)
1070 {
1071   struct MeshChannelReliability *rel;
1072   enum MeshChannelState oldstate;
1073
1074   LOG (GNUNET_ERROR_TYPE_DEBUG,
1075               "  channel confirm %s %s:%X\n",
1076               GM_f2s (fwd), GMT_2s (ch->t), ch->gid);
1077   oldstate = ch->state;
1078   ch->state = MESH_CHANNEL_READY;
1079
1080   rel = fwd ? ch->root_rel : ch->dest_rel;
1081   rel->client_ready = GNUNET_YES;
1082   LOG (GNUNET_ERROR_TYPE_DEBUG,
1083        "  !! retry timer confirm %s\n",
1084        GNUNET_STRINGS_relative_time_to_string (rel->retry_timer, GNUNET_NO));
1085   rel->expected_delay = rel->retry_timer;
1086   if (GMT_get_connections_buffer (ch->t) > 0 || GMT_is_loopback (ch->t))
1087     send_client_ack (ch, fwd);
1088
1089   if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1090   {
1091     GNUNET_SCHEDULER_cancel (rel->retry_task);
1092     rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1093   }
1094   else if (NULL != rel->uniq)
1095   {
1096     GMT_cancel (rel->uniq->q);
1097     /* ch_sent_message will free and NULL uniq */
1098   }
1099   else
1100   {
1101     /* We SHOULD have been trying to retransmit this! */
1102     GNUNET_break (oldstate == MESH_CHANNEL_READY);
1103   }
1104
1105   /* In case of a FWD ACK (SYNACK) send a BCK ACK (ACK). */
1106   if (GNUNET_YES == fwd)
1107     send_ack (ch, GNUNET_NO);
1108 }
1109
1110
1111 /**
1112  * Save a copy to retransmit in case it gets lost.
1113  *
1114  * Initializes all needed callbacks and timers.
1115  *
1116  * @param ch Channel this message goes on.
1117  * @param msg Message to copy.
1118  * @param fwd Is this fwd traffic?
1119  */
1120 static struct MeshReliableMessage *
1121 channel_save_copy (struct MeshChannel *ch,
1122                    const struct GNUNET_MessageHeader *msg,
1123                    int fwd)
1124 {
1125   struct MeshChannelReliability *rel;
1126   struct MeshReliableMessage *copy;
1127   uint32_t mid;
1128   uint16_t type;
1129   uint16_t size;
1130
1131   rel = fwd ? ch->root_rel : ch->dest_rel;
1132   mid = rel->mid_send - 1;
1133   type = ntohs (msg->type);
1134   size = ntohs (msg->size);
1135
1136   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! SAVE %u %s\n", mid, GM_m2s (type));
1137   copy = GNUNET_malloc (sizeof (struct MeshReliableMessage) + size);
1138   LOG (GNUNET_ERROR_TYPE_DEBUG, "  at %p\n", copy);
1139   copy->mid = mid;
1140   copy->rel = rel;
1141   copy->type = type;
1142   memcpy (&copy[1], msg, size);
1143   GNUNET_CONTAINER_DLL_insert_tail (rel->head_sent, rel->tail_sent, copy);
1144   ch->pending_messages++;
1145
1146   return copy;
1147 }
1148
1149
1150 /**
1151  * Create a new channel.
1152  *
1153  * @param t Tunnel this channel is in.
1154  * @param owner Client that owns the channel, NULL for foreign channels.
1155  * @param lid_root Local ID for root client.
1156  *
1157  * @return A new initialized channel. NULL on error.
1158  */
1159 static struct MeshChannel *
1160 channel_new (struct MeshTunnel3 *t,
1161              struct MeshClient *owner,
1162              MESH_ChannelNumber lid_root)
1163 {
1164   struct MeshChannel *ch;
1165
1166   ch = GNUNET_new (struct MeshChannel);
1167   ch->root = owner;
1168   ch->lid_root = lid_root;
1169   ch->t = t;
1170
1171   GNUNET_STATISTICS_update (stats, "# channels", 1, GNUNET_NO);
1172
1173   if (NULL != owner)
1174   {
1175     ch->gid = GMT_get_next_chid (t);
1176     GML_channel_add (owner, lid_root, ch);
1177   }
1178   GMT_add_channel (t, ch);
1179
1180   return ch;
1181 }
1182
1183
1184 /**
1185  * Test if the channel is loopback: both root and dest are on the local peer.
1186  *
1187  * @param ch Channel to test.
1188  *
1189  * @return #GNUNET_YES if channel is loopback, #NGUNET_NO otherwise.
1190  */
1191 static int
1192 is_loopback (const struct MeshChannel *ch)
1193 {
1194   if (NULL != ch->t)
1195     return GMT_is_loopback (ch->t);
1196
1197   return (NULL != ch->root && NULL != ch->dest);
1198 }
1199
1200
1201 /**
1202  * Handle a loopback message: call the appropriate handler for the message type.
1203  *
1204  * @param ch Channel this message is on.
1205  * @param msgh Message header.
1206  * @param fwd Is this FWD traffic?
1207  */
1208 void
1209 handle_loopback (struct MeshChannel *ch,
1210                  const struct GNUNET_MessageHeader *msgh,
1211                  int fwd)
1212 {
1213   uint16_t type;
1214
1215   type = ntohs (msgh->type);
1216   LOG (GNUNET_ERROR_TYPE_DEBUG,
1217        "Loopback %s %s message!\n",
1218        GM_f2s (fwd), GM_m2s (type));
1219
1220   switch (type)
1221   {
1222     case GNUNET_MESSAGE_TYPE_MESH_DATA:
1223       /* Don't send hop ACK, wait for client to ACK */
1224       GMCH_handle_data (ch, (struct GNUNET_MESH_Data *) msgh, fwd);
1225       break;
1226
1227     case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
1228       GMCH_handle_data_ack (ch, (struct GNUNET_MESH_DataACK *) msgh, fwd);
1229       break;
1230
1231     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
1232       GMCH_handle_create (ch->t,
1233                           (struct GNUNET_MESH_ChannelCreate *) msgh);
1234       break;
1235
1236     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
1237       GMCH_handle_ack (ch,
1238                        (struct GNUNET_MESH_ChannelManage *) msgh,
1239                        fwd);
1240       break;
1241
1242     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
1243       GMCH_handle_nack (ch);
1244       break;
1245
1246     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
1247       GMCH_handle_destroy (ch,
1248                            (struct GNUNET_MESH_ChannelManage *) msgh,
1249                            fwd);
1250       break;
1251
1252     default:
1253       GNUNET_break_op (0);
1254       LOG (GNUNET_ERROR_TYPE_DEBUG,
1255            "end-to-end message not known (%u)\n",
1256            ntohs (msgh->type));
1257   }
1258 }
1259
1260
1261
1262 /******************************************************************************/
1263 /********************************    API    ***********************************/
1264 /******************************************************************************/
1265
1266 /**
1267  * Destroy a channel and free all resources.
1268  *
1269  * @param ch Channel to destroy.
1270  */
1271 void
1272 GMCH_destroy (struct MeshChannel *ch)
1273 {
1274   struct MeshClient *c;
1275
1276   if (NULL == ch)
1277     return;
1278
1279   LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying channel %s:%u\n",
1280               GMT_2s (ch->t), ch->gid);
1281   GMCH_debug (ch);
1282
1283   c = ch->root;
1284   if (NULL != c)
1285   {
1286     GML_channel_remove (c, ch->lid_root, ch);
1287   }
1288
1289   c = ch->dest;
1290   if (NULL != c)
1291   {
1292     GML_channel_remove (c, ch->lid_dest, ch);
1293   }
1294
1295   channel_rel_free_all (ch->root_rel);
1296   channel_rel_free_all (ch->dest_rel);
1297
1298   GMT_remove_channel (ch->t, ch);
1299   GNUNET_STATISTICS_update (stats, "# channels", -1, GNUNET_NO);
1300
1301   GNUNET_free (ch);
1302 }
1303
1304
1305 /**
1306  * Get channel ID.
1307  *
1308  * @param ch Channel.
1309  *
1310  * @return ID
1311  */
1312 MESH_ChannelNumber
1313 GMCH_get_id (const struct MeshChannel *ch)
1314 {
1315   return ch->gid;
1316 }
1317
1318
1319 /**
1320  * Get the channel tunnel.
1321  *
1322  * @param ch Channel to get the tunnel from.
1323  *
1324  * @return tunnel of the channel.
1325  */
1326 struct MeshTunnel3 *
1327 GMCH_get_tunnel (const struct MeshChannel *ch)
1328 {
1329   return ch->t;
1330 }
1331
1332
1333 /**
1334  * Get free buffer space towards the client on a specific channel.
1335  *
1336  * @param ch Channel.
1337  * @param fwd Is query about FWD traffic?
1338  *
1339  * @return Free buffer space [0 - 64]
1340  */
1341 unsigned int
1342 GMCH_get_buffer (struct MeshChannel *ch, int fwd)
1343 {
1344   struct MeshChannelReliability *rel;
1345
1346   rel = fwd ? ch->dest_rel : ch->root_rel;
1347
1348   /* If rel is NULL it means that the end is not yet created,
1349    * most probably is a loopback channel at the point of sending
1350    * the ChannelCreate to itself.
1351    */
1352   if (NULL == rel)
1353     return 64;
1354
1355   return (64 - rel->n_recv);
1356 }
1357
1358
1359 /**
1360  * Get flow control status of end point: is client allow to send?
1361  *
1362  * @param ch Channel.
1363  * @param fwd Is query about FWD traffic? (Request root status).
1364  *
1365  * @return #GNUNET_YES if client is allowed to send us data.
1366  */
1367 int
1368 GMCH_get_allowed (struct MeshChannel *ch, int fwd)
1369 {
1370   struct MeshChannelReliability *rel;
1371
1372   rel = fwd ? ch->root_rel : ch->dest_rel;
1373
1374   if (NULL == rel)
1375   {
1376     /* Probably shutting down: root/dest NULL'ed to mark disconnection */
1377     GNUNET_break (GNUNET_NO != ch->destroy);
1378     return 0;
1379   }
1380
1381   return rel->client_allowed;
1382 }
1383
1384
1385 /**
1386  * Is the root client for this channel on this peer?
1387  *
1388  * @param ch Channel.
1389  * @param fwd Is this for fwd traffic?
1390  *
1391  * @return #GNUNET_YES in case it is.
1392  */
1393 int
1394 GMCH_is_origin (struct MeshChannel *ch, int fwd)
1395 {
1396   struct MeshClient *c;
1397
1398   c = fwd ? ch->root : ch->dest;
1399   return NULL != c;
1400 }
1401
1402
1403 /**
1404  * Is the destination client for this channel on this peer?
1405  *
1406  * @param ch Channel.
1407  * @param fwd Is this for fwd traffic?
1408  *
1409  * @return #GNUNET_YES in case it is.
1410  */
1411 int
1412 GMCH_is_terminal (struct MeshChannel *ch, int fwd)
1413 {
1414   struct MeshClient *c;
1415
1416   c = fwd ? ch->dest : ch->root;
1417   return NULL != c;
1418 }
1419
1420
1421 /**
1422  * Send an end-to-end ACK message for the most recent in-sequence payload.
1423  *
1424  * If channel is not reliable, do nothing.
1425  *
1426  * @param ch Channel this is about.
1427  * @param fwd Is for FWD traffic? (ACK dest->owner)
1428  */
1429 void
1430 GMCH_send_data_ack (struct MeshChannel *ch, int fwd)
1431 {
1432   struct GNUNET_MESH_DataACK msg;
1433   struct MeshChannelReliability *rel;
1434   struct MeshReliableMessage *copy;
1435   unsigned int delta;
1436   uint64_t mask;
1437   uint32_t ack;
1438
1439   if (GNUNET_NO == ch->reliable)
1440   {
1441     return;
1442   }
1443   rel = fwd ? ch->dest_rel : ch->root_rel;
1444   ack = rel->mid_recv - 1;
1445   LOG (GNUNET_ERROR_TYPE_DEBUG,
1446               " !! Send DATA_ACK for %u\n",
1447               ack);
1448
1449   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA_ACK);
1450   msg.header.size = htons (sizeof (msg));
1451   msg.chid = htonl (ch->gid);
1452   msg.futures = 0;
1453   for (copy = rel->head_recv; NULL != copy; copy = copy->next)
1454   {
1455     if (copy->type != GNUNET_MESSAGE_TYPE_MESH_DATA)
1456     {
1457       LOG (GNUNET_ERROR_TYPE_DEBUG,
1458            "!!  Type %s, expected DATA\n",
1459            GM_m2s (copy->type));
1460       continue;
1461     }
1462     if (copy->mid == ack + 1)
1463     {
1464       ack++;
1465       continue;
1466     }
1467     delta = copy->mid - (ack + 1);
1468     if (63 < delta)
1469       break;
1470     mask = 0x1LL << delta;
1471     msg.futures |= mask;
1472     LOG (GNUNET_ERROR_TYPE_DEBUG,
1473          " !! setting bit for %u (delta %u) (%llX) -> %llX\n",
1474          copy->mid, delta, mask, msg.futures);
1475   }
1476   msg.mid = htonl (ack);
1477   LOG (GNUNET_ERROR_TYPE_DEBUG,
1478        "!!! ACK for %u, futures %llX\n",
1479        ack, msg.futures);
1480
1481   GMCH_send_prebuilt_message (&msg.header, ch, !fwd, NULL);
1482   LOG (GNUNET_ERROR_TYPE_DEBUG, "send_data_ack END\n");
1483 }
1484
1485
1486 /**
1487  * Allow a client to send us more data, in case it was choked.
1488  *
1489  * @param ch Channel.
1490  * @param fwd Is this about FWD traffic? (Root client).
1491  */
1492 void
1493 GMCH_allow_client (struct MeshChannel *ch, int fwd)
1494 {
1495   struct MeshChannelReliability *rel;
1496   unsigned int buffer;
1497
1498   LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH allow\n");
1499
1500   if (MESH_CHANNEL_READY != ch->state)
1501   {
1502     LOG (GNUNET_ERROR_TYPE_DEBUG, " channel not ready yet!\n");
1503     return;
1504   }
1505
1506   if (GNUNET_YES == ch->reliable)
1507   {
1508     rel = fwd ? ch->root_rel : ch->dest_rel;
1509     if (NULL == rel)
1510     {
1511       GNUNET_break (GNUNET_NO != ch->destroy);
1512       return;
1513     }
1514     if (NULL != rel->head_sent && 64 <= rel->mid_send - rel->head_sent->mid)
1515     {
1516       LOG (GNUNET_ERROR_TYPE_DEBUG, " too big MID gap! Wait for ACK.\n");
1517       return;
1518     }
1519   }
1520
1521   if (is_loopback (ch))
1522     buffer = GMCH_get_buffer (ch, fwd);
1523   else
1524     buffer = GMT_get_connections_buffer (ch->t);
1525
1526   if (0 == buffer)
1527   {
1528     LOG (GNUNET_ERROR_TYPE_DEBUG, " no buffer space.\n");
1529     return;
1530   }
1531
1532   LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer space %u, allowing\n", buffer);
1533   send_client_ack (ch, fwd);
1534 }
1535
1536
1537 /**
1538  * Log channel info.
1539  *
1540  * @param ch Channel.
1541  */
1542 void
1543 GMCH_debug (struct MeshChannel *ch)
1544 {
1545   if (NULL == ch)
1546   {
1547     LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CHANNEL ***\n");
1548     return;
1549   }
1550   LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %s:%X (%p)\n",
1551               GMT_2s (ch->t), ch->gid, ch);
1552   LOG (GNUNET_ERROR_TYPE_DEBUG, "  root %p/%p\n",
1553               ch->root, ch->root_rel);
1554   if (NULL != ch->root)
1555   {
1556     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cli %s\n", GML_2s (ch->root));
1557     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ready %s\n",
1558                 ch->root_rel->client_ready ? "YES" : "NO");
1559     LOG (GNUNET_ERROR_TYPE_DEBUG, "  id %X\n", ch->lid_root);
1560   }
1561   LOG (GNUNET_ERROR_TYPE_DEBUG, "  dest %p/%p\n",
1562               ch->dest, ch->dest_rel);
1563   if (NULL != ch->dest)
1564   {
1565     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cli %s\n", GML_2s (ch->dest));
1566     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ready %s\n",
1567                 ch->dest_rel->client_ready ? "YES" : "NO");
1568     LOG (GNUNET_ERROR_TYPE_DEBUG, "  id %X\n", ch->lid_dest);
1569   }
1570 }
1571
1572
1573 /**
1574  * Handle an ACK given by a client.
1575  *
1576  * Mark client as ready and send him any buffered data we could have for him.
1577  *
1578  * @param ch Channel.
1579  * @param fwd Is this a "FWD ACK"? (FWD ACKs are sent by dest and go BCK)
1580  */
1581 void
1582 GMCH_handle_local_ack (struct MeshChannel *ch, int fwd)
1583 {
1584   struct MeshChannelReliability *rel;
1585   struct MeshClient *c;
1586
1587   rel = fwd ? ch->dest_rel : ch->root_rel;
1588   c   = fwd ? ch->dest     : ch->root;
1589
1590   rel->client_ready = GNUNET_YES;
1591   send_client_buffered_data (ch, c, fwd);
1592   if (is_loopback (ch))
1593   {
1594     unsigned int buffer;
1595
1596     buffer = GMCH_get_buffer (ch, fwd);
1597     if (0 < buffer)
1598       GMCH_allow_client (ch, fwd);
1599
1600     return;
1601   }
1602   GMT_send_connection_acks (ch->t);
1603 }
1604
1605
1606 /**
1607  * Handle data given by a client.
1608  *
1609  * Check whether the client is allowed to send in this tunnel, save if channel
1610  * is reliable and send an ACK to the client if there is still buffer space
1611  * in the tunnel.
1612  *
1613  * @param ch Channel.
1614  * @param c Client which sent the data.
1615  * @param message Message.
1616  * @param fwd Is this a FWD data?
1617  *
1618  * @return GNUNET_OK if everything goes well, GNUNET_SYSERR in case of en error.
1619  */
1620 int
1621 GMCH_handle_local_data (struct MeshChannel *ch,
1622                         struct MeshClient *c,
1623                         struct GNUNET_MessageHeader *message,
1624                         int fwd)
1625 {
1626   struct MeshChannelReliability *rel;
1627   struct GNUNET_MESH_Data *payload;
1628   size_t size = ntohs (message->size);
1629   uint16_t p2p_size = sizeof(struct GNUNET_MESH_Data) + size;
1630   unsigned char cbuf[p2p_size];
1631
1632   /* Is the client in the channel? */
1633   if ( !( (fwd &&
1634            ch->root == c)
1635          ||
1636           (!fwd &&
1637            ch->dest == c) ) )
1638   {
1639     GNUNET_break_op (0);
1640     return GNUNET_SYSERR;
1641   }
1642
1643   rel = fwd ? ch->root_rel : ch->dest_rel;
1644
1645   if (GNUNET_NO == rel->client_allowed)
1646   {
1647     GNUNET_break_op (0);
1648     return GNUNET_SYSERR;
1649   }
1650
1651   rel->client_allowed = GNUNET_NO;
1652
1653   /* Ok, everything is correct, send the message. */
1654   payload = (struct GNUNET_MESH_Data *) cbuf;
1655   payload->mid = htonl (rel->mid_send);
1656   rel->mid_send++;
1657   memcpy (&payload[1], message, size);
1658   payload->header.size = htons (p2p_size);
1659   payload->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_DATA);
1660   payload->chid = htonl (ch->gid);
1661   LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on channel...\n");
1662   GMCH_send_prebuilt_message (&payload->header, ch, fwd, NULL);
1663
1664   if (is_loopback (ch))
1665   {
1666     if (GMCH_get_buffer (ch, fwd) > 0)
1667       send_client_ack (ch, fwd);
1668
1669     return GNUNET_OK;
1670   }
1671
1672   if (GMT_get_connections_buffer (ch->t) > 0)
1673   {
1674     send_client_ack (ch, fwd);
1675   }
1676
1677   return GNUNET_OK;
1678 }
1679
1680
1681 /**
1682  * Handle a channel destroy requested by a client.
1683  *
1684  * Destroy the channel and the tunnel in case this was the last channel.
1685  *
1686  * @param ch Channel.
1687  * @param c Client that requested the destruction (to avoid notifying him).
1688  * @param is_root Is the request coming from root?
1689  */
1690 void
1691 GMCH_handle_local_destroy (struct MeshChannel *ch,
1692                            struct MeshClient *c,
1693                            int is_root)
1694 {
1695   struct MeshTunnel3 *t;
1696
1697   ch->destroy = GNUNET_YES;
1698   /* Cleanup after the tunnel */
1699   if (GNUNET_NO == is_root && c == ch->dest)
1700   {
1701     LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is destination.\n", GML_2s (c));
1702     GML_client_delete_channel (c, ch, ch->lid_dest);
1703     ch->dest = NULL;
1704   }
1705   if (GNUNET_YES == is_root && c == ch->root)
1706   {
1707     LOG (GNUNET_ERROR_TYPE_DEBUG, " Client %s is owner.\n", GML_2s (c));
1708     GML_client_delete_channel (c, ch, ch->lid_root);
1709     ch->root = NULL;
1710   }
1711
1712   t = ch->t;
1713   send_destroy (ch, GNUNET_NO);
1714   if (0 == ch->pending_messages)
1715   {
1716     GMCH_destroy (ch);
1717     GMT_destroy_if_empty (t);
1718   }
1719 }
1720
1721
1722 /**
1723  * Handle a channel create requested by a client.
1724  *
1725  * Create the channel and the tunnel in case this was the first0 channel.
1726  *
1727  * @param c Client that requested the creation (will be the root).
1728  * @param msg Create Channel message.
1729  *
1730  * @return GNUNET_OK if everything went fine, GNUNET_SYSERR otherwise.
1731  */
1732 int
1733 GMCH_handle_local_create (struct MeshClient *c,
1734                           struct GNUNET_MESH_ChannelMessage *msg)
1735 {
1736   struct MeshChannel *ch;
1737   struct MeshTunnel3 *t;
1738   struct MeshPeer *peer;
1739   MESH_ChannelNumber chid;
1740
1741   LOG (GNUNET_ERROR_TYPE_DEBUG, "  towards %s:%u\n",
1742               GNUNET_i2s (&msg->peer), ntohl (msg->port));
1743   chid = ntohl (msg->channel_id);
1744
1745   /* Sanity check for duplicate channel IDs */
1746   if (NULL != GML_channel_get (c, chid))
1747   {
1748     GNUNET_break (0);
1749     return GNUNET_SYSERR;
1750   }
1751
1752   peer = GMP_get (&msg->peer);
1753   GMP_add_tunnel (peer);
1754   t = GMP_get_tunnel (peer);
1755
1756   if (GMP_get_short_id (peer) == myid)
1757   {
1758     GMT_change_cstate (t, MESH_TUNNEL3_READY);
1759   }
1760   else
1761   {
1762     GMP_connect (peer);
1763   }
1764
1765   /* Create channel */
1766   ch = channel_new (t, c, chid);
1767   if (NULL == ch)
1768   {
1769     GNUNET_break (0);
1770     return GNUNET_SYSERR;
1771   }
1772   ch->port = ntohl (msg->port);
1773   channel_set_options (ch, ntohl (msg->opt));
1774
1775   /* In unreliable channels, we'll use the DLL to buffer BCK data */
1776   ch->root_rel = GNUNET_new (struct MeshChannelReliability);
1777   ch->root_rel->ch = ch;
1778   ch->root_rel->retry_timer = MESH_RETRANSMIT_TIME;
1779   ch->root_rel->expected_delay.rel_value_us = 0;
1780
1781   LOG (GNUNET_ERROR_TYPE_DEBUG, "CREATED CHANNEL %s\n", GMCH_2s (ch));
1782
1783   send_create (ch);
1784
1785   return GNUNET_OK;
1786 }
1787
1788
1789 /**
1790  * Handler for mesh network payload traffic.
1791  *
1792  * @param ch Channel for the message.
1793  * @param msg Unencryted data message.
1794  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1795  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1796  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1797  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1798  */
1799 void
1800 GMCH_handle_data (struct MeshChannel *ch,
1801                   const struct GNUNET_MESH_Data *msg,
1802                   int fwd)
1803 {
1804   struct MeshChannelReliability *rel;
1805   struct MeshClient *c;
1806   uint32_t mid;
1807
1808   /* If this is a remote (non-loopback) channel, find 'fwd'. */
1809   if (GNUNET_SYSERR == fwd)
1810   {
1811     if (is_loopback (ch))
1812     {
1813       /* It is a loopback channel after all... */
1814       GNUNET_break (0);
1815       return;
1816     }
1817     fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
1818   }
1819
1820   /*  Initialize FWD/BCK data */
1821   c   = fwd ? ch->dest     : ch->root;
1822   rel = fwd ? ch->dest_rel : ch->root_rel;
1823
1824   if (NULL == c)
1825   {
1826     GNUNET_break (0);
1827     return;
1828   }
1829
1830   if (MESH_CHANNEL_READY != ch->state)
1831   {
1832     if (GNUNET_NO == fwd)
1833     {
1834       /* If we are the root, this means the other peer has sent traffic before
1835        * receiving our ACK. Even if the SYNACK goes missing, no traffic should
1836        * be sent before the ACK.
1837        */
1838       GNUNET_break_op (0);
1839       return;
1840     }
1841     /* If we are the dest, this means that the SYNACK got to the root but
1842      * the ACK went missing. Treat this as an ACK.
1843      */
1844     channel_confirm (ch, GNUNET_NO);
1845   }
1846
1847   GNUNET_STATISTICS_update (stats, "# data received", 1, GNUNET_NO);
1848
1849   mid = ntohl (msg->mid);
1850   LOG (GNUNET_ERROR_TYPE_DEBUG, "!! got mid %u\n", mid);
1851
1852   if (GNUNET_NO == ch->reliable ||
1853       ( !GM_is_pid_bigger (rel->mid_recv, mid) &&
1854         GM_is_pid_bigger (rel->mid_recv + 64, mid) ) )
1855   {
1856     LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! RECV %u\n", mid);
1857     if (GNUNET_YES == ch->reliable)
1858     {
1859       /* Is this the exact next expected messasge? */
1860       if (mid == rel->mid_recv)
1861       {
1862         LOG (GNUNET_ERROR_TYPE_DEBUG, "as expected\n");
1863         rel->mid_recv++;
1864         send_client_data (ch, msg, fwd);
1865       }
1866       else
1867       {
1868         LOG (GNUNET_ERROR_TYPE_DEBUG, "save for later\n");
1869         add_buffered_data (msg, rel);
1870       }
1871     }
1872     else
1873     {
1874       /* Tunnel is unreliable: send to clients directly */
1875       /* FIXME: accept Out Of Order traffic */
1876       rel->mid_recv = mid + 1;
1877       send_client_data (ch, msg, fwd);
1878     }
1879   }
1880   else
1881   {
1882     GNUNET_break_op (GM_is_pid_bigger (rel->mid_recv, mid));
1883     LOG (GNUNET_ERROR_TYPE_DEBUG,
1884                 " !!! MID %u not expected (%u - %u), dropping!\n",
1885                 mid, rel->mid_recv, rel->mid_recv + 63);
1886   }
1887
1888   GMCH_send_data_ack (ch, fwd);
1889 }
1890
1891
1892 /**
1893  * Handler for mesh network traffic end-to-end ACKs.
1894  *
1895  * @param ch Channel on which we got this message.
1896  * @param msg Data message.
1897  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
1898  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
1899  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
1900  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
1901  */
1902 void
1903 GMCH_handle_data_ack (struct MeshChannel *ch,
1904                       const struct GNUNET_MESH_DataACK *msg,
1905                       int fwd)
1906 {
1907   struct MeshChannelReliability *rel;
1908   struct MeshReliableMessage *copy;
1909   struct MeshReliableMessage *next;
1910   uint32_t ack;
1911   int work;
1912
1913   /* If this is a remote (non-loopback) channel, find 'fwd'. */
1914   if (GNUNET_SYSERR == fwd)
1915   {
1916     if (is_loopback (ch))
1917     {
1918       /* It is a loopback channel after all... */
1919       GNUNET_break (0);
1920       return;
1921     }
1922     /* Inverted: if message came 'FWD' is a 'BCK ACK'. */
1923     fwd = (NULL != ch->dest) ? GNUNET_NO : GNUNET_YES;
1924   }
1925
1926   ack = ntohl (msg->mid);
1927   LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! %s ACK %u\n",
1928        (GNUNET_YES == fwd) ? "FWD" : "BCK", ack);
1929
1930   if (GNUNET_YES == fwd)
1931   {
1932     rel = ch->root_rel;
1933   }
1934   else
1935   {
1936     rel = ch->dest_rel;
1937   }
1938   if (NULL == rel)
1939   {
1940     GNUNET_break_op (0);
1941     return;
1942   }
1943
1944   /* Free ACK'd copies: no need to retransmit those anymore */
1945   for (work = GNUNET_NO, copy = rel->head_sent; copy != NULL; copy = next)
1946   {
1947     if (GM_is_pid_bigger (copy->mid, ack))
1948     {
1949       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!!  head %u, out!\n", copy->mid);
1950       channel_rel_free_sent (rel, msg);
1951       break;
1952     }
1953     work = GNUNET_YES;
1954     LOG (GNUNET_ERROR_TYPE_DEBUG, " !!  id %u\n", copy->mid);
1955     next = copy->next;
1956     rel_message_free (copy, GNUNET_YES);
1957   }
1958
1959   /* ACK client if needed */
1960   GMCH_allow_client (ch, fwd);
1961
1962   /* If some message was free'd, update the retransmission delay */
1963   if (GNUNET_YES == work)
1964   {
1965     if (GNUNET_SCHEDULER_NO_TASK != rel->retry_task)
1966     {
1967       GNUNET_SCHEDULER_cancel (rel->retry_task);
1968       if (NULL != rel->head_sent && NULL == rel->head_sent->q)
1969       {
1970         struct GNUNET_TIME_Absolute new_target;
1971         struct GNUNET_TIME_Relative delay;
1972
1973         delay = GNUNET_TIME_relative_multiply (rel->retry_timer,
1974                                                MESH_RETRANSMIT_MARGIN);
1975         new_target = GNUNET_TIME_absolute_add (rel->head_sent->timestamp,
1976                                                delay);
1977         delay = GNUNET_TIME_absolute_get_remaining (new_target);
1978         rel->retry_task =
1979             GNUNET_SCHEDULER_add_delayed (delay,
1980                                           &channel_retransmit_message,
1981                                           rel);
1982       }
1983       else /* either no more traffic to ack or traffic has just been queued */
1984       {
1985         rel->retry_task = GNUNET_SCHEDULER_NO_TASK;
1986       }
1987     }
1988     else /* work was done but no task was pending? shouldn't happen! */
1989     {
1990       GNUNET_break (0);
1991     }
1992   }
1993 }
1994
1995
1996 /**
1997  * Handler for channel create messages.
1998  *
1999  * Does not have fwd parameter because it's always 'FWD': channel is incoming.
2000  *
2001  * @param t Tunnel this channel will be in.
2002  * @param msg Channel crate message.
2003  */
2004 struct MeshChannel *
2005 GMCH_handle_create (struct MeshTunnel3 *t,
2006                     const struct GNUNET_MESH_ChannelCreate *msg)
2007 {
2008   MESH_ChannelNumber chid;
2009   struct MeshChannel *ch;
2010   struct MeshClient *c;
2011
2012   chid = ntohl (msg->chid);
2013
2014   ch = GMT_get_channel (t, chid);
2015   if (NULL == ch)
2016   {
2017     /* Create channel */
2018     ch = channel_new (t, NULL, 0);
2019     ch->gid = chid;
2020     channel_set_options (ch, ntohl (msg->opt));
2021
2022     /* Find a destination client */
2023     ch->port = ntohl (msg->port);
2024     LOG (GNUNET_ERROR_TYPE_DEBUG, "   port %u\n", ch->port);
2025     c = GML_client_get_by_port (ch->port);
2026     if (NULL == c)
2027     {
2028       LOG (GNUNET_ERROR_TYPE_DEBUG, "  no client has port registered\n");
2029       if (is_loopback (ch))
2030       {
2031         LOG (GNUNET_ERROR_TYPE_DEBUG, "  loopback: destroy on handler\n");
2032         send_nack (ch);
2033       }
2034       else
2035       {
2036         LOG (GNUNET_ERROR_TYPE_DEBUG, "  not loopback: destroy now\n");
2037         send_nack (ch);
2038         GMCH_destroy (ch);
2039       }
2040       return NULL;
2041     }
2042     else
2043     {
2044       LOG (GNUNET_ERROR_TYPE_DEBUG, "  client %p has port registered\n", c);
2045     }
2046
2047     add_destination (ch, c);
2048     if (GNUNET_YES == ch->reliable)
2049       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Reliable\n");
2050     else
2051       LOG (GNUNET_ERROR_TYPE_DEBUG, "!!! Not Reliable\n");
2052
2053     send_client_create (ch);
2054     ch->state =  MESH_CHANNEL_SENT;
2055   }
2056
2057   send_ack (ch, GNUNET_YES);
2058
2059   return ch;
2060 }
2061
2062
2063 /**
2064  * Handler for channel NACK messages.
2065  *
2066  * NACK messages always go dest -> root, no need for 'fwd' or 'msg' parameter.
2067  *
2068  * @param ch Channel.
2069  */
2070 void
2071 GMCH_handle_nack (struct MeshChannel *ch)
2072 {
2073   send_client_nack (ch);
2074   GMCH_destroy (ch);
2075 }
2076
2077
2078 /**
2079  * Handler for channel ack messages.
2080  *
2081  * @param ch Channel.
2082  * @param msg Message.
2083  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2084  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
2085  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
2086  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
2087  */
2088 void
2089 GMCH_handle_ack (struct MeshChannel *ch,
2090                  const struct GNUNET_MESH_ChannelManage *msg,
2091                  int fwd)
2092 {
2093   /* If this is a remote (non-loopback) channel, find 'fwd'. */
2094   if (GNUNET_SYSERR == fwd)
2095   {
2096     if (is_loopback (ch))
2097     {
2098       /* It is a loopback channel after all... */
2099       GNUNET_break (0);
2100       return;
2101     }
2102     fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2103   }
2104
2105   channel_confirm (ch, !fwd);
2106 }
2107
2108
2109 /**
2110  * Handler for channel destroy messages.
2111  *
2112  * @param ch Channel to be destroyed of.
2113  * @param msg Message.
2114  * @param fwd Is this message fwd? This only is meaningful in loopback channels.
2115  *            #GNUNET_YES if message is FWD on the respective channel (loopback)
2116  *            #GNUNET_NO if message is BCK on the respective channel (loopback)
2117  *            #GNUNET_SYSERR if message on a one-ended channel (remote)
2118  */
2119 void
2120 GMCH_handle_destroy (struct MeshChannel *ch,
2121                      const struct GNUNET_MESH_ChannelManage *msg,
2122                      int fwd)
2123 {
2124   struct MeshTunnel3 *t;
2125
2126   /* If this is a remote (non-loopback) channel, find 'fwd'. */
2127   if (GNUNET_SYSERR == fwd)
2128   {
2129     if (is_loopback (ch))
2130     {
2131       /* It is a loopback channel after all... */
2132       GNUNET_break (0);
2133       return;
2134     }
2135     fwd = (NULL != ch->dest) ? GNUNET_YES : GNUNET_NO;
2136   }
2137
2138   GMCH_debug (ch);
2139   if ( (fwd && NULL == ch->dest) || (!fwd && NULL == ch->root) )
2140   {
2141     /* Not for us (don't destroy twice a half-open loopback channel) */
2142     return;
2143   }
2144
2145   t = ch->t;
2146   send_destroy (ch, GNUNET_YES);
2147   GMCH_destroy (ch);
2148   GMT_destroy_if_empty (t);
2149 }
2150
2151
2152 /**
2153  * Sends an already built message on a channel.
2154  *
2155  * If the channel is on a loopback tunnel, notifies the appropriate destination
2156  * client locally.
2157  *
2158  * On a normal channel passes the message to the tunnel for encryption and
2159  * sending on a connection.
2160  *
2161  * This function DOES NOT save the message for retransmission.
2162  *
2163  * @param message Message to send. Function makes a copy of it.
2164  * @param ch Channel on which this message is transmitted.
2165  * @param fwd Is this a fwd message?
2166  * @param existing_copy This is a retransmission, don't save a copy.
2167  */
2168 void
2169 GMCH_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2170                             struct MeshChannel *ch, int fwd,
2171                             void *existing_copy)
2172 {
2173   struct MeshChannelQueue *q;
2174   uint16_t type;
2175
2176   type = ntohs (message->type);
2177   LOG (GNUNET_ERROR_TYPE_DEBUG, "GMCH Send %s %s on channel %s\n",
2178        GM_f2s (fwd), GM_m2s (type),
2179        GMCH_2s (ch));
2180
2181   if (GMT_is_loopback (ch->t))
2182   {
2183     handle_loopback (ch, message, fwd);
2184     return;
2185   }
2186
2187   switch (type)
2188   {
2189     case GNUNET_MESSAGE_TYPE_MESH_DATA:
2190
2191       if (GNUNET_YES == ch->reliable)
2192       {
2193         q = GNUNET_new (struct MeshChannelQueue);
2194         q->type = type;
2195         if (NULL == existing_copy)
2196           q->copy = channel_save_copy (ch, message, fwd);
2197         else
2198         {
2199           q->copy = (struct MeshReliableMessage *) existing_copy;
2200           if (NULL != q->copy->q)
2201           {
2202             /* Last retransmission was queued but not yet sent!
2203              * This retransmission was scheduled by a ch_message_sent which
2204              * followed a very fast RTT, so the tiny delay made the
2205              * retransmission function to execute before the previous
2206              * retransmitted message even had a chance to leave the peer.
2207              * Cancel this message and wait until the pending
2208              * retransmission leaves the peer and ch_message_sent starts
2209              * the timer for the next one.
2210              */
2211             GNUNET_free (q);
2212             LOG (GNUNET_ERROR_TYPE_DEBUG,
2213                  "  exisitng copy not yet transmitted!\n");
2214             return;
2215           }
2216           LOG (GNUNET_ERROR_TYPE_DEBUG,
2217                "  using existing copy: %p {r:%p q:%p t:%u}\n",
2218                existing_copy,
2219                q->copy->rel, q->copy->q, q->copy->type);
2220         }
2221         LOG (GNUNET_ERROR_TYPE_DEBUG, "  new q: %p\n", q);
2222         q->copy->q = q;
2223         q->q = GMT_send_prebuilt_message (message, ch->t, ch,
2224                                           NULL != existing_copy,
2225                                           &ch_message_sent, q);
2226         /* q itself is stored in copy */
2227       }
2228       else
2229       {
2230         fire_and_forget (message, ch, GNUNET_NO);
2231       }
2232       break;
2233
2234
2235     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_ACK:
2236       if (GNUNET_YES == fwd)
2237       {
2238         /* BCK ACK (going FWD) is just a response for a SYNACK, don't keep*/
2239         fire_and_forget (message, ch, GNUNET_YES);
2240         break;
2241       }
2242       /* fall-trough */
2243     case GNUNET_MESSAGE_TYPE_MESH_DATA_ACK:
2244     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
2245       q = GNUNET_new (struct MeshChannelQueue);
2246       q->type = type;
2247       q->rel = fwd ? ch->root_rel : ch->dest_rel;
2248       if (NULL != q->rel->uniq)
2249       {
2250         if (NULL != q->rel->uniq->q)
2251         {
2252           GMT_cancel (q->rel->uniq->q);
2253           /* ch_message_sent is called, freeing and NULLing uniq */
2254         }
2255         else
2256         {
2257           GNUNET_free (q->rel->uniq);
2258         }
2259       }
2260       q->q = GMT_send_prebuilt_message (message, ch->t, ch, GNUNET_YES,
2261                                         &ch_message_sent, q);
2262       q->rel->uniq = q;
2263       break;
2264
2265
2266     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
2267     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_NACK:
2268       fire_and_forget (message, ch, GNUNET_YES);
2269       break;
2270
2271
2272     default:
2273       GNUNET_break (0);
2274       LOG (GNUNET_ERROR_TYPE_DEBUG, "type %s unknown!\n", GM_m2s (type));
2275       fire_and_forget (message, ch, GNUNET_YES);
2276   }
2277 }
2278
2279
2280 /**
2281  * Get the static string for identification of the channel.
2282  *
2283  * @param ch Channel.
2284  *
2285  * @return Static string with the channel IDs.
2286  */
2287 const char *
2288 GMCH_2s (const struct MeshChannel *ch)
2289 {
2290   static char buf[64];
2291
2292   if (NULL == ch)
2293     return "(NULL Channel)";
2294
2295   sprintf (buf, "%s:%u gid:%X (%X / %X)",
2296            GMT_2s (ch->t), ch->port, ch->gid, ch->lid_root, ch->lid_dest);
2297
2298   return buf;
2299 }