src/mesh/gnunet-service-mesh_channel.c

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