src/cadet/gnunet-service-cadet_connection.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2015 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file cadet/gnunet-service-cadet_connection.c
  22  * @brief GNUnet CADET service connection handling
  23  * @author Bartlomiej Polot
  24  */
  25 #include "platform.h"
  26 #include "gnunet_util_lib.h"
  27 #include "gnunet_statistics_service.h"
  28 #include "cadet_path.h"
  29 #include "cadet_protocol.h"
  30 #include "cadet.h"
  31 #include "gnunet-service-cadet_connection.h"
  32 #include "gnunet-service-cadet_peer.h"
  33 #include "gnunet-service-cadet_tunnel.h"
  34
  35
  36 /**
  37  * Should we run somewhat expensive checks on our invariants?
  38  */
  39 #define CHECK_INVARIANTS 0
  40
  41
  42 #define LOG(level, ...) GNUNET_log_from (level,"cadet-con",__VA_ARGS__)
  43 #define LOG2(level, ...) GNUNET_log_from_nocheck(level,"cadet-con",__VA_ARGS__)
  44
  45
  46 #define CADET_MAX_POLL_TIME      GNUNET_TIME_relative_multiply (\
  47                                   GNUNET_TIME_UNIT_MINUTES,\
  48                                   10)
  49 #define AVG_MSGS                32
  50
  51
  52 /******************************************************************************/
  53 /********************************   STRUCTS  **********************************/
  54 /******************************************************************************/
  55
  56 /**
  57  * Handle for messages queued but not yet sent.
  58  */
  59 struct CadetConnectionQueue
  60 {
  61
  62   struct CadetConnectionQueue *next;
  63   struct CadetConnectionQueue *prev;
  64
  65   /**
  66    * Peer queue handle, to cancel if necessary.
  67    */
  68   struct CadetPeerQueue *peer_q;
  69
  70   /**
  71    * Continuation to call once sent.
  72    */
  73   GCC_sent cont;
  74
  75   /**
  76    * Closure for @e cont.
  77    */
  78   void *cont_cls;
  79
  80   /**
  81    * Was this a forced message? (Do not account for it)
  82    */
  83   int forced;
  84 };
  85
  86
  87 /**
  88  * Struct to encapsulate all the Flow Control information to a peer to which
  89  * we are directly connected (on a core level).
  90  */
  91 struct CadetFlowControl
  92 {
  93   /**
  94    * Connection this controls.
  95    */
  96   struct CadetConnection *c;
  97
  98   struct CadetConnectionQueue *q_head;
  99   struct CadetConnectionQueue *q_tail;
 100
 101   /**
 102    * How many messages are in the queue on this connection.
 103    */
 104   unsigned int queue_n;
 105
 106   /**
 107    * How many messages do we accept in the queue.
 108    * If 0, the connection is broken in this direction (next hop disconnected).
 109    */
 110   unsigned int queue_max;
 111
 112   /**
 113    * ID of the next packet to send.
 114    */
 115   uint32_t next_pid;
 116
 117   /**
 118    * ID of the last packet sent towards the peer.
 119    */
 120   uint32_t last_pid_sent;
 121
 122   /**
 123    * ID of the last packet received from the peer.
 124    */
 125   uint32_t last_pid_recv;
 126
 127   /**
 128    * Bitmap of past 32 messages received:
 129    * - LSB being @c last_pid_recv.
 130    * - MSB being @c last_pid_recv - 31 (mod UINTMAX).
 131    */
 132   uint32_t recv_bitmap;
 133
 134   /**
 135    * Last ACK sent to the peer (peer can't send more than this PID).
 136    */
 137   uint32_t last_ack_sent;
 138
 139   /**
 140    * Last ACK sent towards the origin (for traffic towards leaf node).
 141    */
 142   uint32_t last_ack_recv;
 143
 144   /**
 145    * Task to poll the peer in case of a lost ACK causes stall.
 146    */
 147   struct GNUNET_SCHEDULER_Task *poll_task;
 148
 149   /**
 150    * How frequently to poll for ACKs.
 151    */
 152   struct GNUNET_TIME_Relative poll_time;
 153
 154   /**
 155    * Queued poll message, to cancel if not necessary anymore (got ACK).
 156    */
 157   struct CadetConnectionQueue *poll_msg;
 158
 159   /**
 160    * Queued poll message, to cancel if not necessary anymore (got ACK).
 161    */
 162   struct CadetConnectionQueue *ack_msg;
 163 };
 164
 165 /**
 166  * Keep a record of the last messages sent on this connection.
 167  */
 168 struct CadetConnectionPerformance
 169 {
 170   /**
 171    * Circular buffer for storing measurements.
 172    */
 173   double usecsperbyte[AVG_MSGS];
 174
 175   /**
 176    * Running average of @c usecsperbyte.
 177    */
 178   double avg;
 179
 180   /**
 181    * How many values of @c usecsperbyte are valid.
 182    */
 183   uint16_t size;
 184
 185   /**
 186    * Index of the next "free" position in @c usecsperbyte.
 187    */
 188   uint16_t idx;
 189 };
 190
 191
 192 /**
 193  * Struct containing all information regarding a connection to a peer.
 194  */
 195 struct CadetConnection
 196 {
 197   /**
 198    * Tunnel this connection is part of.
 199    */
 200   struct CadetTunnel *t;
 201
 202   /**
 203    * Flow control information for traffic fwd.
 204    */
 205   struct CadetFlowControl fwd_fc;
 206
 207   /**
 208    * Flow control information for traffic bck.
 209    */
 210   struct CadetFlowControl bck_fc;
 211
 212   /**
 213    * Measure connection performance on the endpoint.
 214    */
 215   struct CadetConnectionPerformance *perf;
 216
 217   /**
 218    * ID of the connection.
 219    */
 220   struct GNUNET_CADET_Hash id;
 221
 222   /**
 223    * Path being used for the tunnel. At the origin of the connection
 224    * it's a pointer to the destination's path pool, otherwise just a copy.
 225    */
 226   struct CadetPeerPath *path;
 227
 228   /**
 229    * Task to keep the used paths alive at the owner,
 230    * time tunnel out on all the other peers.
 231    */
 232   struct GNUNET_SCHEDULER_Task *fwd_maintenance_task;
 233
 234   /**
 235    * Task to keep the used paths alive at the destination,
 236    * time tunnel out on all the other peers.
 237    */
 238   struct GNUNET_SCHEDULER_Task *bck_maintenance_task;
 239
 240   /**
 241    * Queue handle for maintainance traffic. One handle for FWD and BCK since
 242    * one peer never needs to maintain both directions (no loopback connections).
 243    */
 244   struct CadetPeerQueue *maintenance_q;
 245
 246   /**
 247    * Should equal #get_next_hop(), or NULL if that peer disconnected.
 248    */
 249   struct CadetPeer *next_peer;
 250
 251   /**
 252    * Should equal #get_prev_hop(), or NULL if that peer disconnected.
 253    */
 254   struct CadetPeer *prev_peer;
 255
 256   /**
 257    * State of the connection.
 258    */
 259   enum CadetConnectionState state;
 260
 261   /**
 262    * Position of the local peer in the path.
 263    */
 264   unsigned int own_pos;
 265
 266   /**
 267    * Pending message count.
 268    */
 269   unsigned int pending_messages;
 270
 271   /**
 272    * Destroy flag:
 273    * - if 0, connection in use.
 274    * - if 1, destroy on last message.
 275    * - if 2, connection is being destroyed don't re-enter.
 276    */
 277   int destroy;
 278
 279   /**
 280    * In-connection-map flag. Sometimes, when @e destroy is set but
 281    * actual destruction is delayed to enable us to finish processing
 282    * queues (i.e. in the direction that is still working), we remove
 283    * the connection from the map to prevent it from still being
 284    * found (and used) by accident. This flag is set to #GNUNET_YES
 285    * for a connection that is not in the #connections map.  Should
 286    * only be #GNUNET_YES if #destroy is also non-zero.
 287    */
 288   int was_removed;
 289
 290   /**
 291    * Counter to do exponential backoff when creating a connection (max 64).
 292    */
 293   unsigned short create_retry;
 294
 295   /**
 296    * Task to check if connection has duplicates.
 297    */
 298   struct GNUNET_SCHEDULER_Task *check_duplicates_task;
 299 };
 300
 301
 302 /******************************************************************************/
 303 /*******************************   GLOBALS  ***********************************/
 304 /******************************************************************************/
 305
 306 /**
 307  * Global handle to the statistics service.
 308  */
 309 extern struct GNUNET_STATISTICS_Handle *stats;
 310
 311 /**
 312  * Local peer own ID (memory efficient handle).
 313  */
 314 extern GNUNET_PEER_Id myid;
 315
 316 /**
 317  * Local peer own ID (full value).
 318  */
 319 extern struct GNUNET_PeerIdentity my_full_id;
 320
 321 /**
 322  * Connections known, indexed by cid (CadetConnection).
 323  */
 324 static struct GNUNET_CONTAINER_MultiHashMap *connections;
 325
 326 /**
 327  * How many connections are we willing to maintain.
 328  *  Local connections are always allowed,
 329  * even if there are more connections than max.
 330  */
 331 static unsigned long long max_connections;
 332
 333 /**
 334  * How many messages *in total* are we willing to queue, divide by number of
 335  * connections to get connection queue size.
 336  */
 337 static unsigned long long max_msgs_queue;
 338
 339 /**
 340  * How often to send path keepalives. Paths timeout after 4 missed.
 341  */
 342 static struct GNUNET_TIME_Relative refresh_connection_time;
 343
 344 /**
 345  * How often to send path create / ACKs.
 346  */
 347 static struct GNUNET_TIME_Relative create_connection_time;
 348
 349
 350 /******************************************************************************/
 351 /********************************   STATIC  ***********************************/
 352 /******************************************************************************/
 353
 354
 355
 356 #if 0 // avoid compiler warning for unused static function
 357 static void
 358 fc_debug (struct CadetFlowControl *fc)
 359 {
 360   LOG (GNUNET_ERROR_TYPE_DEBUG, "    IN: %u/%u\n",
 361               fc->last_pid_recv, fc->last_ack_sent);
 362   LOG (GNUNET_ERROR_TYPE_DEBUG, "    OUT: %u/%u\n",
 363               fc->last_pid_sent, fc->last_ack_recv);
 364   LOG (GNUNET_ERROR_TYPE_DEBUG, "    QUEUE: %u/%u\n",
 365               fc->queue_n, fc->queue_max);
 366 }
 367
 368 static void
 369 connection_debug (struct CadetConnection *c)
 370 {
 371   if (NULL == c)
 372   {
 373     LOG (GNUNET_ERROR_TYPE_INFO, "DEBUG NULL CONNECTION\n");
 374     return;
 375   }
 376   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s:%X\n",
 377               peer2s (c->t->peer), GCC_2s (c));
 378   LOG (GNUNET_ERROR_TYPE_DEBUG, "  state: %u, pending msgs: %u\n",
 379               c->state, c->pending_messages);
 380   LOG (GNUNET_ERROR_TYPE_DEBUG, "  FWD FC\n");
 381   fc_debug (&c->fwd_fc);
 382   LOG (GNUNET_ERROR_TYPE_DEBUG, "  BCK FC\n");
 383   fc_debug (&c->bck_fc);
 384 }
 385 #endif
 386
 387
 388 /**
 389  * Schedule next keepalive task, taking in consideration
 390  * the connection state and number of retries.
 391  *
 392  * @param c Connection for which to schedule the next keepalive.
 393  * @param fwd Direction for the next keepalive.
 394  */
 395 static void
 396 schedule_next_keepalive (struct CadetConnection *c, int fwd);
 397
 398
 399 /**
 400  * Resets the connection timeout task, some other message has done the
 401  * task's job.
 402  * - For the first peer on the direction this means to send
 403  *   a keepalive or a path confirmation message (either create or ACK).
 404  * - For all other peers, this means to destroy the connection,
 405  *   due to lack of activity.
 406  * Starts the timeout if no timeout was running (connection just created).
 407  *
 408  * @param c Connection whose timeout to reset.
 409  * @param fwd Is this forward?
 410  */
 411 static void
 412 connection_reset_timeout (struct CadetConnection *c, int fwd);
 413
 414
 415 /**
 416  * Get string description for tunnel state. Reentrant.
 417  *
 418  * @param s Tunnel state.
 419  *
 420  * @return String representation.
 421  */
 422 static const char *
 423 GCC_state2s (enum CadetConnectionState s)
 424 {
 425   switch (s)
 426   {
 427     case CADET_CONNECTION_NEW:
 428       return "CADET_CONNECTION_NEW";
 429     case CADET_CONNECTION_SENT:
 430       return "CADET_CONNECTION_SENT";
 431     case CADET_CONNECTION_ACK:
 432       return "CADET_CONNECTION_ACK";
 433     case CADET_CONNECTION_READY:
 434       return "CADET_CONNECTION_READY";
 435     case CADET_CONNECTION_DESTROYED:
 436       return "CADET_CONNECTION_DESTROYED";
 437     case CADET_CONNECTION_BROKEN:
 438       return "CADET_CONNECTION_BROKEN";
 439     default:
 440       GNUNET_break (0);
 441       LOG (GNUNET_ERROR_TYPE_ERROR, " conn state %u unknown!\n", s);
 442       return "CADET_CONNECTION_STATE_ERROR";
 443   }
 444 }
 445
 446
 447 /**
 448  * Initialize a Flow Control structure to the initial state.
 449  *
 450  * @param fc Flow Control structure to initialize.
 451  */
 452 static void
 453 fc_init (struct CadetFlowControl *fc)
 454 {
 455   fc->next_pid = (uint32_t) 0;
 456   fc->last_pid_sent = (uint32_t) -1;
 457   fc->last_pid_recv = (uint32_t) -1;
 458   fc->last_ack_sent = (uint32_t) 0;
 459   fc->last_ack_recv = (uint32_t) 0;
 460   fc->poll_task = NULL;
 461   fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
 462   fc->queue_n = 0;
 463   fc->queue_max = (max_msgs_queue / max_connections) + 1;
 464 }
 465
 466
 467 /**
 468  * Find a connection.
 469  *
 470  * @param cid Connection ID.
 471  *
 472  * @return conntection with the given ID @cid or NULL if not found.
 473  */
 474 static struct CadetConnection *
 475 connection_get (const struct GNUNET_CADET_Hash *cid)
 476 {
 477   return GNUNET_CONTAINER_multihashmap_get (connections, GC_h2hc (cid));
 478 }
 479
 480
 481 /**
 482  * Change the connection state. Cannot change a connection marked as destroyed.
 483  *
 484  * @param c Connection to change.
 485  * @param state New state to set.
 486  */
 487 static void
 488 connection_change_state (struct CadetConnection* c,
 489                          enum CadetConnectionState state)
 490 {
 491   LOG (GNUNET_ERROR_TYPE_DEBUG,
 492        "Connection %s state %s -> %s\n",
 493        GCC_2s (c), GCC_state2s (c->state), GCC_state2s (state));
 494   if (CADET_CONNECTION_DESTROYED <= c->state) /* Destroyed or broken. */
 495   {
 496     LOG (GNUNET_ERROR_TYPE_DEBUG, "state not changing anymore\n");
 497     return;
 498   }
 499   c->state = state;
 500   if (CADET_CONNECTION_READY == state)
 501     c->create_retry = 1;
 502 }
 503
 504
 505 /**
 506  * Mark a connection as "destroyed", to send all pending traffic and freeing
 507  * all associated resources, without accepting new status changes on it.
 508  *
 509  * @param c Connection to mark as destroyed.
 510  */
 511 static void
 512 mark_destroyed (struct CadetConnection *c)
 513 {
 514   c->destroy = GNUNET_YES;
 515   connection_change_state (c, CADET_CONNECTION_DESTROYED);
 516 }
 517
 518
 519 /**
 520  * Callback called when a queued ACK message is sent.
 521  *
 522  * @param cls Closure (FC).
 523  * @param c Connection this message was on.
 524  * @param q Queue handler this call invalidates.
 525  * @param type Type of message sent.
 526  * @param fwd Was this a FWD going message?
 527  * @param size Size of the message.
 528  */
 529 static void
 530 ack_sent (void *cls,
 531           struct CadetConnection *c,
 532           struct CadetConnectionQueue *q,
 533           uint16_t type, int fwd, size_t size)
 534 {
 535   struct CadetFlowControl *fc = cls;
 536
 537   fc->ack_msg = NULL;
 538 }
 539
 540
 541 /**
 542  * Send an ACK on the connection, informing the predecessor about
 543  * the available buffer space. Should not be called in case the peer
 544  * is origin (no predecessor) in the @c fwd direction.
 545  *
 546  * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
 547  * the ACK itself goes "back" (dest->root).
 548  *
 549  * @param c Connection on which to send the ACK.
 550  * @param buffer How much space free to advertise?
 551  * @param fwd Is this FWD ACK? (Going dest -> root)
 552  * @param force Don't optimize out.
 553  */
 554 static void
 555 send_ack (struct CadetConnection *c, unsigned int buffer, int fwd, int force)
 556 {
 557   struct CadetFlowControl *next_fc;
 558   struct CadetFlowControl *prev_fc;
 559   struct GNUNET_CADET_ACK msg;
 560   uint32_t ack;
 561   int delta;
 562
 563   /* If origin, there is no connection to send ACKs. Wrong function! */
 564   GCC_check_connections ();
 565   if (GCC_is_origin (c, fwd))
 566   {
 567     LOG (GNUNET_ERROR_TYPE_DEBUG, "connection %s is origin in %s\n",
 568          GCC_2s (c), GC_f2s (fwd));
 569     GNUNET_break (0);
 570     return;
 571   }
 572
 573   next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
 574   prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
 575
 576   LOG (GNUNET_ERROR_TYPE_DEBUG, "connection send %s ack on %s\n",
 577        GC_f2s (fwd), GCC_2s (c));
 578
 579   /* Check if we need to transmit the ACK. */
 580   delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
 581   if (3 < delta && buffer < delta && GNUNET_NO == force)
 582   {
 583     LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
 584     LOG (GNUNET_ERROR_TYPE_DEBUG,
 585          "  last pid recv: %u, last ack sent: %u\n",
 586          prev_fc->last_pid_recv, prev_fc->last_ack_sent);
 587     GCC_check_connections ();
 588     return;
 589   }
 590
 591   /* Ok, ACK might be necessary, what PID to ACK? */
 592   ack = prev_fc->last_pid_recv + buffer;
 593   LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
 594   LOG (GNUNET_ERROR_TYPE_DEBUG,
 595        " last pid %u, last ack %u, qmax %u, q %u\n",
 596        prev_fc->last_pid_recv, prev_fc->last_ack_sent,
 597        next_fc->queue_max, next_fc->queue_n);
 598   if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
 599   {
 600     LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
 601     GCC_check_connections ();
 602     return;
 603   }
 604
 605   /* Check if message is already in queue */
 606   if (NULL != prev_fc->ack_msg)
 607   {
 608     if (GC_is_pid_bigger (ack, prev_fc->last_ack_sent))
 609     {
 610       LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
 611       GCC_cancel (prev_fc->ack_msg);
 612       /* GCC_cancel triggers ack_sent(), which clears fc->ack_msg */
 613     }
 614     else
 615     {
 616       LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
 617       GCC_check_connections ();
 618       return;
 619     }
 620   }
 621
 622   prev_fc->last_ack_sent = ack;
 623
 624   /* Build ACK message and send on conn */
 625   msg.header.size = htons (sizeof (msg));
 626   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_ACK);
 627   msg.ack = htonl (ack);
 628   msg.cid = c->id;
 629
 630   prev_fc->ack_msg = GCC_send_prebuilt_message (&msg.header, UINT16_MAX, ack,
 631                                                 c, !fwd, GNUNET_YES,
 632                                                 &ack_sent, prev_fc);
 633   GNUNET_assert (NULL != prev_fc->ack_msg);
 634   GCC_check_connections ();
 635 }
 636
 637
 638 /**
 639  * Update performance information if we are a connection's endpoint.
 640  *
 641  * @param c Connection to update.
 642  * @param wait How much time did we wait to send the last message.
 643  * @param size Size of the last message.
 644  */
 645 static void
 646 update_perf (struct CadetConnection *c,
 647              struct GNUNET_TIME_Relative wait,
 648              uint16_t size)
 649 {
 650   struct CadetConnectionPerformance *p;
 651   double usecsperbyte;
 652
 653   if (NULL == c->perf)
 654     return; /* Only endpoints are interested in timing. */
 655
 656   p = c->perf;
 657   usecsperbyte = ((double) wait.rel_value_us) / size;
 658   if (p->size == AVG_MSGS)
 659   {
 660     /* Array is full. Substract oldest value, add new one and store. */
 661     p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
 662     p->usecsperbyte[p->idx] = usecsperbyte;
 663     p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
 664   }
 665   else
 666   {
 667     /* Array not yet full. Add current value to avg and store. */
 668     p->usecsperbyte[p->idx] = usecsperbyte;
 669     p->avg *= p->size;
 670     p->avg += p->usecsperbyte[p->idx];
 671     p->size++;
 672     p->avg /= p->size;
 673   }
 674   p->idx = (p->idx + 1) % AVG_MSGS;
 675 }
 676
 677
 678 /**
 679  * Callback called when a connection queued message is sent.
 680  *
 681  * Calculates the average time and connection packet tracking.
 682  *
 683  * @param cls Closure (ConnectionQueue Handle), can be NULL.
 684  * @param c Connection this message was on.
 685  * @param fwd Was this a FWD going message?
 686  * @param sent Was it really sent? (Could have been canceled)
 687  * @param type Type of message sent.
 688  * @param payload_type Type of payload, if applicable.
 689  * @param pid Message ID, or 0 if not applicable (create, destroy, etc).
 690  * @param size Size of the message.
 691  * @param wait Time spent waiting for core (only the time for THIS message)
 692  */
 693 static void
 694 conn_message_sent (void *cls,
 695                    struct CadetConnection *c, int fwd, int sent,
 696                    uint16_t type, uint16_t payload_type, uint32_t pid,
 697                    size_t size,
 698                    struct GNUNET_TIME_Relative wait)
 699 {
 700   struct CadetConnectionQueue *q = cls;
 701   struct CadetFlowControl *fc;
 702   int forced;
 703
 704   GCC_check_connections ();
 705   LOG (GNUNET_ERROR_TYPE_DEBUG, "connection message_sent\n");
 706
 707   /* If c is NULL, nothing to update. */
 708   if (NULL == c)
 709   {
 710     if (type != GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN
 711         && type != GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY)
 712     {
 713       LOG (GNUNET_ERROR_TYPE_ERROR, "Message %s sent on NULL connection!\n",
 714            GC_m2s (type));
 715     }
 716     GCC_check_connections ();
 717     return;
 718   }
 719
 720   LOG (GNUNET_ERROR_TYPE_DEBUG, " %ssent %s %s pid %u\n",
 721        sent ? "" : "not ", GC_f2s (fwd),
 722        GC_m2s (type), GC_m2s (payload_type), pid);
 723   GCC_debug (c, GNUNET_ERROR_TYPE_DEBUG);
 724
 725   /* Update flow control info. */
 726   fc = fwd ? &c->fwd_fc : &c->bck_fc;
 727
 728   if (NULL != q)
 729   {
 730     GNUNET_CONTAINER_DLL_remove (fc->q_head, fc->q_tail, q);
 731     forced = q->forced;
 732     if (NULL != q->cont)
 733     {
 734       LOG (GNUNET_ERROR_TYPE_DEBUG, " calling cont\n");
 735       q->cont (q->cont_cls, c, q, type, fwd, size);
 736     }
 737     GNUNET_free (q);
 738   }
 739   else if (type == GNUNET_MESSAGE_TYPE_CADET_AX)
 740   {
 741     /* SHOULD NO LONGER HAPPEN FIXME: REMOVE CASE */
 742     // If NULL == q and ENCRYPTED == type, message must have been ch_mngmnt
 743     forced = GNUNET_YES;
 744     GNUNET_assert (0); // FIXME
 745   }
 746   else /* CONN_CREATE or CONN_ACK */
 747   {
 748     forced = GNUNET_YES;
 749   }
 750
 751   LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P- %p %u\n", c, c->pending_messages);
 752   c->pending_messages--;
 753   if ( (GNUNET_YES == c->destroy) &&
 754        (0 == c->pending_messages) )
 755   {
 756     LOG (GNUNET_ERROR_TYPE_DEBUG,
 757          "!  destroying connection!\n");
 758     GCC_destroy (c);
 759     GCC_check_connections ();
 760     return;
 761   }
 762
 763   /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
 764   switch (type)
 765   {
 766     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE:
 767     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK:
 768       c->maintenance_q = NULL;
 769       /* Don't trigger a keepalive for sent ACKs, only SYN and SYNACKs */
 770       if (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE == type || !fwd)
 771         schedule_next_keepalive (c, fwd);
 772       break;
 773
 774     case GNUNET_MESSAGE_TYPE_CADET_AX:
 775       if (GNUNET_YES == sent)
 776       {
 777         GNUNET_assert (NULL != q);
 778         fc->last_pid_sent = pid;
 779         if (GC_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
 780           GCC_start_poll (c, fwd);
 781         GCC_send_ack (c, fwd, GNUNET_NO);
 782         connection_reset_timeout (c, fwd);
 783       }
 784
 785       LOG (GNUNET_ERROR_TYPE_DEBUG, "!  Q_N- %p %u\n", fc, fc->queue_n);
 786       if (GNUNET_NO == forced)
 787       {
 788         fc->queue_n--;
 789         LOG (GNUNET_ERROR_TYPE_DEBUG,
 790             "!   accounting pid %u\n",
 791             fc->last_pid_sent);
 792       }
 793       else
 794       {
 795         LOG (GNUNET_ERROR_TYPE_DEBUG,
 796              "!   forced, Q_N not accounting pid %u\n",
 797              fc->last_pid_sent);
 798       }
 799       break;
 800
 801     case GNUNET_MESSAGE_TYPE_CADET_KX:
 802       if (GNUNET_YES == sent)
 803         connection_reset_timeout (c, fwd);
 804       break;
 805
 806     case GNUNET_MESSAGE_TYPE_CADET_POLL:
 807       fc->poll_msg = NULL;
 808       break;
 809
 810     case GNUNET_MESSAGE_TYPE_CADET_ACK:
 811       fc->ack_msg = NULL;
 812       break;
 813
 814     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN:
 815     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY:
 816       break;
 817
 818     default:
 819       LOG (GNUNET_ERROR_TYPE_ERROR, "%s unknown\n", GC_m2s (type));
 820       GNUNET_break (0);
 821       break;
 822   }
 823   LOG (GNUNET_ERROR_TYPE_DEBUG, "!  message sent!\n");
 824
 825   update_perf (c, wait, size);
 826   GCC_check_connections ();
 827 }
 828
 829
 830 /**
 831  * Get the previous hop in a connection
 832  *
 833  * @param c Connection.
 834  *
 835  * @return Previous peer in the connection.
 836  */
 837 static struct CadetPeer *
 838 get_prev_hop (const struct CadetConnection *c)
 839 {
 840   GNUNET_PEER_Id id;
 841
 842   if (NULL == c->path)
 843     return NULL;
 844   LOG (GNUNET_ERROR_TYPE_DEBUG,
 845        " get prev hop %s [%u/%u]\n",
 846        GCC_2s (c), c->own_pos, c->path->length);
 847   if (0 == c->own_pos || c->path->length < 2)
 848     id = c->path->peers[0];
 849   else
 850     id = c->path->peers[c->own_pos - 1];
 851
 852   LOG (GNUNET_ERROR_TYPE_DEBUG, "  ID: %s (%u)\n",
 853        GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
 854
 855   return GCP_get_short (id, GNUNET_YES);
 856 }
 857
 858
 859 /**
 860  * Get the next hop in a connection
 861  *
 862  * @param c Connection.
 863  *
 864  * @return Next peer in the connection.
 865  */
 866 static struct CadetPeer *
 867 get_next_hop (const struct CadetConnection *c)
 868 {
 869   GNUNET_PEER_Id id;
 870
 871   if (NULL == c->path)
 872     return NULL;
 873
 874   LOG (GNUNET_ERROR_TYPE_DEBUG, " get next hop %s [%u/%u]\n",
 875        GCC_2s (c), c->own_pos, c->path->length);
 876   if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
 877     id = c->path->peers[c->path->length - 1];
 878   else
 879     id = c->path->peers[c->own_pos + 1];
 880
 881   LOG (GNUNET_ERROR_TYPE_DEBUG, "  ID: %s (%u)\n",
 882        GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
 883
 884   return GCP_get_short (id, GNUNET_YES);
 885 }
 886
 887
 888 /**
 889  * Check that the direct neighbours (previous and next hop)
 890  * are properly associated with this connection.
 891  *
 892  * @param c connection to check
 893  */
 894 static void
 895 check_neighbours (const struct CadetConnection *c)
 896 {
 897   if (NULL == c->path)
 898     return; /* nothing to check */
 899   GCP_check_connection (get_next_hop (c), c);
 900   GCP_check_connection (get_prev_hop (c), c);
 901 }
 902
 903
 904 /**
 905  * Helper for #GCC_check_connections().  Calls #check_neighbours().
 906  *
 907  * @param cls NULL
 908  * @param key ignored
 909  * @param value the `struct CadetConnection` to check
 910  * @return #GNUNET_OK (continue to iterate)
 911  */
 912 static int
 913 check_connection (void *cls,
 914                   const struct GNUNET_HashCode *key,
 915                   void *value)
 916 {
 917   struct CadetConnection *c = value;
 918
 919   check_neighbours (c);
 920   return GNUNET_OK;
 921 }
 922
 923
 924 /**
 925  * Check invariants for all connections using #check_neighbours().
 926  */
 927 void
 928 GCC_check_connections ()
 929 {
 930   if (0 == CHECK_INVARIANTS)
 931     return;
 932   if (NULL == connections)
 933     return;
 934   GNUNET_CONTAINER_multihashmap_iterate (connections,
 935                                          &check_connection,
 936                                          NULL);
 937 }
 938
 939
 940 /**
 941  * Get the hop in a connection.
 942  *
 943  * @param c Connection.
 944  * @param fwd Next in the FWD direction?
 945  *
 946  * @return Next peer in the connection.
 947  */
 948 static struct CadetPeer *
 949 get_hop (struct CadetConnection *c, int fwd)
 950 {
 951   return (fwd) ? get_next_hop (c) : get_prev_hop (c);
 952 }
 953
 954
 955 /**
 956  * Get a bit mask for a message received out-of-order.
 957  *
 958  * @param last_pid_recv Last PID we received prior to the out-of-order.
 959  * @param ooo_pid PID of the out-of-order message.
 960  */
 961 static uint32_t
 962 get_recv_bitmask (uint32_t last_pid_recv, uint32_t ooo_pid)
 963 {
 964   return 1 << (last_pid_recv - ooo_pid);
 965 }
 966
 967
 968 /**
 969  * Check is an out-of-order message is ok:
 970  * - at most 31 messages behind.
 971  * - not duplicate.
 972  *
 973  * @param last_pid_recv Last in-order PID received.
 974  */
 975 static int
 976 is_ooo_ok (uint32_t last_pid_recv, uint32_t ooo_pid, uint32_t ooo_bitmap)
 977 {
 978   uint32_t mask;
 979
 980   if (GC_is_pid_bigger (last_pid_recv - 31, ooo_pid))
 981     return GNUNET_NO;
 982
 983   mask = get_recv_bitmask (last_pid_recv, ooo_pid);
 984   if (0 != (ooo_bitmap & mask))
 985     return GNUNET_NO;
 986
 987   return GNUNET_YES;
 988 }
 989
 990
 991 /**
 992  * Is traffic coming from this sender 'FWD' traffic?
 993  *
 994  * @param c Connection to check.
 995  * @param sender Short peer identity of neighbor.
 996  *
 997  * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
 998  *         the traffic is 'FWD'.
 999  *         #GNUNET_NO for BCK.
1000  *         #GNUNET_SYSERR for errors (sender isn't a hop in the connection).
1001  */
1002 static int
1003 is_fwd (const struct CadetConnection *c,
1004         const struct CadetPeer *sender)
1005 {
1006   GNUNET_PEER_Id id;
1007
1008   id = GCP_get_short_id (sender);
1009   if (GCP_get_short_id (get_prev_hop (c)) == id)
1010     return GNUNET_YES;
1011
1012   if (GCP_get_short_id (get_next_hop (c)) == id)
1013     return GNUNET_NO;
1014
1015   return GNUNET_SYSERR;
1016 }
1017
1018
1019 /**
1020  * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
1021  * or a first CONNECTION_ACK directed to us.
1022  *
1023  * @param c Connection to confirm.
1024  * @param fwd Should we send it FWD? (root->dest)
1025  *            (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
1026  */
1027 static void
1028 send_connection_ack (struct CadetConnection *c, int fwd)
1029 {
1030   struct GNUNET_CADET_ConnectionACK msg;
1031   struct CadetTunnel *t;
1032   size_t size = sizeof (struct GNUNET_CADET_ConnectionACK);
1033
1034   GCC_check_connections ();
1035   t = c->t;
1036   LOG (GNUNET_ERROR_TYPE_INFO,
1037        "==> { C %s ACK} %19s on conn %s (%p) %s [%5u]\n",
1038        GC_f2s (!fwd), "", GCC_2s (c), c, GC_f2s (fwd), size);
1039
1040   msg.header.size = htons (sizeof (struct GNUNET_CADET_ConnectionACK));
1041   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK);
1042   msg.reserved = htonl (0);
1043   msg.cid = c->id;
1044
1045   GNUNET_assert (NULL == c->maintenance_q);
1046   c->maintenance_q = GCP_send (get_hop (c, fwd), &msg.header,
1047                                GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK, 0,
1048                                c, fwd,
1049                                &conn_message_sent, NULL);
1050   LOG (GNUNET_ERROR_TYPE_DEBUG, "  C_P+ %p %u (conn`ACK)\n",
1051        c, c->pending_messages);
1052   c->pending_messages++;
1053
1054   if (CADET_TUNNEL_NEW == GCT_get_cstate (t))
1055     GCT_change_cstate (t, CADET_TUNNEL_WAITING);
1056   if (CADET_CONNECTION_READY != c->state)
1057     connection_change_state (c, CADET_CONNECTION_SENT);
1058   GCC_check_connections ();
1059 }
1060
1061
1062 /**
1063  * Send a notification that a connection is broken.
1064  *
1065  * @param c Connection that is broken.
1066  * @param id1 Peer that has disconnected.
1067  * @param id2 Peer that has disconnected.
1068  * @param fwd Direction towards which to send it.
1069  */
1070 static void
1071 send_broken (struct CadetConnection *c,
1072              const struct GNUNET_PeerIdentity *id1,
1073              const struct GNUNET_PeerIdentity *id2,
1074              int fwd)
1075 {
1076   struct GNUNET_CADET_ConnectionBroken msg;
1077
1078   GCC_check_connections ();
1079   msg.header.size = htons (sizeof (struct GNUNET_CADET_ConnectionBroken));
1080   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN);
1081   msg.cid = c->id;
1082   msg.peer1 = *id1;
1083   msg.peer2 = *id2;
1084   GNUNET_assert (NULL ==
1085                  GCC_send_prebuilt_message (&msg.header, UINT16_MAX, 0, c, fwd,
1086                                             GNUNET_YES, NULL, NULL));
1087   GCC_check_connections ();
1088 }
1089
1090
1091 /**
1092  * Send a notification that a connection is broken, when a connection
1093  * isn't even known to the local peer or soon to be destroyed.
1094  *
1095  * @param connection_id Connection ID.
1096  * @param id1 Peer that has disconnected, probably local peer.
1097  * @param id2 Peer that has disconnected can be NULL if unknown.
1098  * @param neighbor Peer to notify (neighbor who sent the connection).
1099  */
1100 static void
1101 send_broken_unknown (const struct GNUNET_CADET_Hash *connection_id,
1102                      const struct GNUNET_PeerIdentity *id1,
1103                      const struct GNUNET_PeerIdentity *id2,
1104                      struct CadetPeer *neighbor)
1105 {
1106   struct GNUNET_CADET_ConnectionBroken msg;
1107
1108   GCC_check_connections ();
1109   LOG (GNUNET_ERROR_TYPE_INFO, "--> BROKEN on unknown connection %s\n",
1110        GNUNET_h2s (GC_h2hc (connection_id)));
1111
1112   msg.header.size = htons (sizeof (struct GNUNET_CADET_ConnectionBroken));
1113   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN);
1114   msg.cid = *connection_id;
1115   msg.peer1 = *id1;
1116   if (NULL != id2)
1117     msg.peer2 = *id2;
1118   else
1119     memset (&msg.peer2, 0, sizeof (msg.peer2));
1120   GNUNET_assert (NULL != GCP_send (neighbor, &msg.header,
1121                                    UINT16_MAX, 2,
1122                                    NULL, GNUNET_SYSERR, /* connection, fwd */
1123                                    NULL, NULL)); /* continuation */
1124   GCC_check_connections ();
1125 }
1126
1127
1128 /**
1129  * Send keepalive packets for a connection.
1130  *
1131  * @param c Connection to keep alive..
1132  * @param fwd Is this a FWD keepalive? (owner -> dest).
1133  */
1134 static void
1135 send_connection_keepalive (struct CadetConnection *c, int fwd)
1136 {
1137   struct GNUNET_MessageHeader msg;
1138   struct CadetFlowControl *fc;
1139
1140   GCC_check_connections ();
1141   LOG (GNUNET_ERROR_TYPE_INFO,
1142        "keepalive %s for connection %s\n",
1143        GC_f2s (fwd), GCC_2s (c));
1144
1145   GNUNET_assert (NULL != c->t);
1146   fc = fwd ? &c->fwd_fc : &c->bck_fc;
1147   if (0 < fc->queue_n || GNUNET_YES == GCT_has_queued_traffic (c->t))
1148   {
1149     LOG (GNUNET_ERROR_TYPE_INFO, "not sending keepalive, traffic in queue\n");
1150     return;
1151   }
1152
1153   GNUNET_STATISTICS_update (stats, "# keepalives sent", 1, GNUNET_NO);
1154
1155   GNUNET_assert (NULL != c->t);
1156   msg.size = htons (sizeof (msg));
1157   msg.type = htons (GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE);
1158
1159   GNUNET_assert (NULL ==
1160                  GCT_send_prebuilt_message (&msg, c->t, c,
1161                                             GNUNET_NO, NULL, NULL));
1162   GCC_check_connections ();
1163 }
1164
1165
1166 /**
1167  * Send CONNECTION_{CREATE/ACK} packets for a connection.
1168  *
1169  * @param c Connection for which to send the message.
1170  * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
1171  */
1172 static void
1173 connection_recreate (struct CadetConnection *c, int fwd)
1174 {
1175   LOG (GNUNET_ERROR_TYPE_DEBUG,
1176        "sending connection recreate\n");
1177   if (fwd)
1178     GCC_send_create (c);
1179   else
1180     send_connection_ack (c, GNUNET_NO);
1181 }
1182
1183
1184 /**
1185  * Generic connection timer management.
1186  * Depending on the role of the peer in the connection will send the
1187  * appropriate message (build or keepalive)
1188  *
1189  * @param c Conncetion to maintain.
1190  * @param fwd Is FWD?
1191  */
1192 static void
1193 connection_maintain (struct CadetConnection *c, int fwd)
1194 {
1195   if (GNUNET_NO != c->destroy)
1196   {
1197     LOG (GNUNET_ERROR_TYPE_INFO, "not sending keepalive, being destroyed\n");
1198     return;
1199   }
1200
1201   if (NULL == c->t)
1202   {
1203     GNUNET_break (0);
1204     GCC_debug (c, GNUNET_ERROR_TYPE_ERROR);
1205     return;
1206   }
1207
1208   if (CADET_TUNNEL_SEARCHING == GCT_get_cstate (c->t))
1209   {
1210     /* If status is SEARCHING, why is there a connection? Should be WAITING */
1211     GNUNET_break (0);
1212     GCT_debug (c->t, GNUNET_ERROR_TYPE_ERROR);
1213     LOG (GNUNET_ERROR_TYPE_INFO, "not sending keepalive, tunnel SEARCHING\n");
1214     schedule_next_keepalive (c, fwd);
1215     return;
1216   }
1217   switch (c->state)
1218   {
1219     case CADET_CONNECTION_NEW:
1220       GNUNET_break (0);
1221       /* fall-through */
1222     case CADET_CONNECTION_SENT:
1223       connection_recreate (c, fwd);
1224       break;
1225     case CADET_CONNECTION_READY:
1226       send_connection_keepalive (c, fwd);
1227       break;
1228     default:
1229       break;
1230   }
1231 }
1232
1233
1234 /**
1235  * Keep the connection alive.
1236  *
1237  * @param c Connection to keep alive.
1238  * @param fwd Direction.
1239  */
1240 static void
1241 connection_keepalive (struct CadetConnection *c,
1242                       int fwd)
1243 {
1244   GCC_check_connections ();
1245   LOG (GNUNET_ERROR_TYPE_DEBUG,
1246        "%s keepalive for %s\n",
1247        GC_f2s (fwd), GCC_2s (c));
1248
1249   if (fwd)
1250     c->fwd_maintenance_task = NULL;
1251   else
1252     c->bck_maintenance_task = NULL;
1253   connection_maintain (c, fwd);
1254   GCC_check_connections ();
1255   /* Next execution will be scheduled by message_sent or _maintain*/
1256 }
1257
1258
1259 /**
1260  * Keep the connection alive in the FWD direction.
1261  *
1262  * @param cls Closure (connection to keepalive).
1263  */
1264 static void
1265 connection_fwd_keepalive (void *cls)
1266 {
1267   struct CadetConnection *c = cls;
1268
1269   GCC_check_connections ();
1270   connection_keepalive (c,
1271                         GNUNET_YES);
1272   GCC_check_connections ();
1273 }
1274
1275
1276 /**
1277  * Keep the connection alive in the BCK direction.
1278  *
1279  * @param cls Closure (connection to keepalive).
1280  */
1281 static void
1282 connection_bck_keepalive (void *cls)
1283 {
1284   struct CadetConnection *c = cls;
1285
1286   GCC_check_connections ();
1287   connection_keepalive (c,
1288                         GNUNET_NO);
1289   GCC_check_connections ();
1290 }
1291
1292
1293 /**
1294  * Schedule next keepalive task, taking in consideration
1295  * the connection state and number of retries.
1296  *
1297  * If the peer is not the origin, do nothing.
1298  *
1299  * @param c Connection for which to schedule the next keepalive.
1300  * @param fwd Direction for the next keepalive.
1301  */
1302 static void
1303 schedule_next_keepalive (struct CadetConnection *c, int fwd)
1304 {
1305   struct GNUNET_TIME_Relative delay;
1306   struct GNUNET_SCHEDULER_Task * *task_id;
1307   GNUNET_SCHEDULER_TaskCallback keepalive_task;
1308
1309   GCC_check_connections ();
1310   if (GNUNET_NO == GCC_is_origin (c, fwd))
1311     return;
1312
1313   /* Calculate delay to use, depending on the state of the connection */
1314   if (CADET_CONNECTION_READY == c->state)
1315   {
1316     delay = refresh_connection_time;
1317   }
1318   else
1319   {
1320     if (1 > c->create_retry)
1321       c->create_retry = 1;
1322     delay = GNUNET_TIME_relative_multiply (create_connection_time,
1323                                            c->create_retry);
1324     if (c->create_retry < 64) // TODO make configurable
1325       c->create_retry *= 2;
1326   }
1327
1328   /* Select direction-dependent parameters */
1329   if (GNUNET_YES == fwd)
1330   {
1331     task_id = &c->fwd_maintenance_task;
1332     keepalive_task = &connection_fwd_keepalive;
1333   }
1334   else
1335   {
1336     task_id = &c->bck_maintenance_task;
1337     keepalive_task = &connection_bck_keepalive;
1338   }
1339
1340   /* Check that no one scheduled it before us */
1341   if (NULL != *task_id)
1342   {
1343     /* No need for a _break. It can happen for instance when sending a SYNACK
1344      * for a duplicate SYN: the first SYNACK scheduled the task. */
1345     GNUNET_SCHEDULER_cancel (*task_id);
1346   }
1347
1348   /* Schedule the task */
1349   *task_id = GNUNET_SCHEDULER_add_delayed (delay,
1350                                            keepalive_task,
1351                                            c);
1352   LOG (GNUNET_ERROR_TYPE_DEBUG,
1353        "next keepalive in %s\n",
1354        GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1355   GCC_check_connections ();
1356 }
1357
1358
1359 /**
1360  * Cancel all transmissions that belong to a certain connection.
1361  *
1362  * If the connection is scheduled for destruction and no more messages are left,
1363  * the connection will be destroyed by the continuation call.
1364  *
1365  * @param c Connection which to cancel. Might be destroyed during this call.
1366  * @param fwd Cancel fwd traffic?
1367  */
1368 static void
1369 connection_cancel_queues (struct CadetConnection *c,
1370                           int fwd)
1371 {
1372   struct CadetFlowControl *fc;
1373
1374   GCC_check_connections ();
1375   LOG (GNUNET_ERROR_TYPE_DEBUG,
1376        "Cancel %s queues for connection %s\n",
1377        GC_f2s (fwd), GCC_2s (c));
1378   if (NULL == c)
1379   {
1380     GNUNET_break (0);
1381     return;
1382   }
1383
1384   fc = fwd ? &c->fwd_fc : &c->bck_fc;
1385   if (NULL != fc->poll_task)
1386   {
1387     GNUNET_SCHEDULER_cancel (fc->poll_task);
1388     fc->poll_task = NULL;
1389     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cancelled POLL task for fc %p\n", fc);
1390   }
1391   if (NULL != fc->poll_msg)
1392   {
1393     GCC_cancel (fc->poll_msg);
1394     LOG (GNUNET_ERROR_TYPE_DEBUG, "  cancelled POLL msg for fc %p\n", fc);
1395   }
1396
1397   while (NULL != fc->q_head)
1398   {
1399     GCC_cancel (fc->q_head);
1400   }
1401   GCC_check_connections ();
1402 }
1403
1404
1405 /**
1406  * Function called if a connection has been stalled for a while,
1407  * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1408  *
1409  * @param cls Closure (poll ctx).
1410  */
1411 static void
1412 connection_poll (void *cls);
1413
1414
1415 /**
1416  * Callback called when a queued POLL message is sent.
1417  *
1418  * @param cls Closure (flow control context).
1419  * @param c Connection this message was on.
1420  * @param q Queue handler this call invalidates.
1421  * @param type Type of message sent.
1422  * @param fwd Was this a FWD going message?
1423  * @param size Size of the message.
1424  */
1425 static void
1426 poll_sent (void *cls,
1427            struct CadetConnection *c,
1428            struct CadetConnectionQueue *q,
1429            uint16_t type, int fwd, size_t size)
1430 {
1431   struct CadetFlowControl *fc = cls;
1432
1433   GNUNET_assert (fc->poll_msg == q);
1434   fc->poll_msg = NULL;
1435   if (2 == c->destroy)
1436   {
1437     LOG (GNUNET_ERROR_TYPE_DEBUG, "POLL canceled on shutdown\n");
1438     return;
1439   }
1440   if (0 == fc->queue_max)
1441   {
1442     LOG (GNUNET_ERROR_TYPE_DEBUG, "POLL cancelled: neighbor disconnected\n");
1443     return;
1444   }
1445   LOG (GNUNET_ERROR_TYPE_DEBUG, "POLL sent for %s, scheduling new one!\n",
1446        GCC_2s (c));
1447   GNUNET_assert (NULL == fc->poll_task);
1448   fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
1449   fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
1450                                                 &connection_poll,
1451                                                 fc);
1452   LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1453 }
1454
1455
1456 /**
1457  * Function called if a connection has been stalled for a while,
1458  * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1459  *
1460  * @param cls Closure (poll ctx).
1461  */
1462 static void
1463 connection_poll (void *cls)
1464 {
1465   struct CadetFlowControl *fc = cls;
1466   struct GNUNET_CADET_Poll msg;
1467   struct CadetConnection *c;
1468   int fwd;
1469
1470   fc->poll_task = NULL;
1471   GCC_check_connections ();
1472   c = fc->c;
1473   fwd = fc == &c->fwd_fc;
1474   LOG (GNUNET_ERROR_TYPE_DEBUG, "Polling connection %s %s\n",
1475        GCC_2s (c),  GC_f2s (fwd));
1476
1477   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_POLL);
1478   msg.header.size = htons (sizeof (msg));
1479   msg.pid = htonl (fc->last_pid_sent);
1480   LOG (GNUNET_ERROR_TYPE_DEBUG, " last pid sent: %u\n", fc->last_pid_sent);
1481   fc->poll_msg =
1482       GCC_send_prebuilt_message (&msg.header, UINT16_MAX, fc->last_pid_sent, c,
1483                                  fc == &c->fwd_fc, GNUNET_YES, &poll_sent, fc);
1484   GNUNET_assert (NULL != fc->poll_msg);
1485   GCC_check_connections ();
1486 }
1487
1488
1489 /**
1490  * Generic connection timeout implementation.
1491  *
1492  * Timeout function due to lack of keepalive/traffic from an endpoint.
1493  * Destroys connection if called.
1494  *
1495  * @param c Connection to destroy.
1496  * @param fwd Was the timeout from the origin? (FWD timeout)
1497  */
1498 static void
1499 connection_timeout (struct CadetConnection *c, int fwd)
1500 {
1501   GCC_check_connections ();
1502
1503   LOG (GNUNET_ERROR_TYPE_INFO,
1504        "Connection %s %s timed out. Destroying.\n",
1505        GCC_2s (c),
1506        GC_f2s (fwd));
1507   GCC_debug (c, GNUNET_ERROR_TYPE_DEBUG);
1508
1509   if (GCC_is_origin (c, fwd)) /* Loopback? Something is wrong! */
1510   {
1511     GNUNET_break (0);
1512     return;
1513   }
1514
1515   /* If dest, send "broken" notification. */
1516   if (GCC_is_terminal (c, fwd))
1517   {
1518     struct CadetPeer *next_hop;
1519
1520     next_hop = fwd ? get_prev_hop (c) : get_next_hop (c);
1521     send_broken_unknown (&c->id, &my_full_id, NULL, next_hop);
1522   }
1523
1524   GCC_destroy (c);
1525   GCC_check_connections ();
1526 }
1527
1528
1529 /**
1530  * Timeout function due to lack of keepalive/traffic from the owner.
1531  * Destroys connection if called.
1532  *
1533  * @param cls Closure (connection to destroy).
1534  */
1535 static void
1536 connection_fwd_timeout (void *cls)
1537 {
1538   struct CadetConnection *c = cls;
1539
1540   c->fwd_maintenance_task = NULL;
1541   GCC_check_connections ();
1542   connection_timeout (c, GNUNET_YES);
1543   GCC_check_connections ();
1544 }
1545
1546
1547 /**
1548  * Timeout function due to lack of keepalive/traffic from the destination.
1549  * Destroys connection if called.
1550  *
1551  * @param cls Closure (connection to destroy).
1552  */
1553 static void
1554 connection_bck_timeout (void *cls)
1555 {
1556   struct CadetConnection *c = cls;
1557
1558   c->bck_maintenance_task = NULL;
1559   GCC_check_connections ();
1560   connection_timeout (c, GNUNET_NO);
1561   GCC_check_connections ();
1562 }
1563
1564
1565 /**
1566  * Resets the connection timeout task, some other message has done the
1567  * task's job.
1568  * - For the first peer on the direction this means to send
1569  *   a keepalive or a path confirmation message (either create or ACK).
1570  * - For all other peers, this means to destroy the connection,
1571  *   due to lack of activity.
1572  * Starts the timeout if no timeout was running (connection just created).
1573  *
1574  * @param c Connection whose timeout to reset.
1575  * @param fwd Is this forward?
1576  *
1577  * TODO use heap to improve efficiency of scheduler.
1578  */
1579 static void
1580 connection_reset_timeout (struct CadetConnection *c, int fwd)
1581 {
1582   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GC_f2s (fwd));
1583   if (GCC_is_origin (c, fwd)) /* Startpoint */
1584   {
1585     schedule_next_keepalive (c, fwd);
1586     if (NULL != c->maintenance_q)
1587     {
1588       GCP_send_cancel (c->maintenance_q);
1589       c->maintenance_q = NULL; /* Is set to NULL by conn_message_sent anyway */
1590     }
1591   }
1592   else /* Relay, endpoint. */
1593   {
1594     struct GNUNET_TIME_Relative delay;
1595     struct GNUNET_SCHEDULER_Task * *ti;
1596     GNUNET_SCHEDULER_TaskCallback f;
1597
1598     ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1599
1600     if (NULL != *ti)
1601       GNUNET_SCHEDULER_cancel (*ti);
1602     delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1603     LOG (GNUNET_ERROR_TYPE_DEBUG,
1604          "  timing out in %s\n",
1605          GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_NO));
1606     f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1607     *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1608   }
1609 }
1610
1611
1612 /**
1613  * Iterator to compare each connection's path with the path of a new connection.
1614  *
1615  * If the connection coincides, the c member of path is set to the connection
1616  * and the destroy flag of the connection is set.
1617  *
1618  * @param cls Closure (new path).
1619  * @param c Connection in the tunnel to check.
1620  */
1621 static void
1622 check_path (void *cls, struct CadetConnection *c)
1623 {
1624   struct CadetConnection *new_conn = cls;
1625   struct CadetPeerPath *path = new_conn->path;
1626
1627   LOG (GNUNET_ERROR_TYPE_DEBUG, "  checking %s (%p), length %u\n",
1628        GCC_2s (c), c, c->path->length);
1629
1630   if (c != new_conn
1631       && GNUNET_NO == c->destroy
1632       && CADET_CONNECTION_BROKEN != c->state
1633       && CADET_CONNECTION_DESTROYED != c->state
1634       && path_equivalent (path, c->path))
1635   {
1636     new_conn->destroy = GNUNET_YES; /* Do not mark_destroyed, */
1637     new_conn->path->c = c;          /* this is only a flag for the Iterator. */
1638     LOG (GNUNET_ERROR_TYPE_DEBUG, "  MATCH!\n");
1639   }
1640 }
1641
1642
1643 /**
1644  * Finds out if this path is already being used by an existing connection.
1645  *
1646  * Checks the tunnel towards the destination to see if it contains
1647  * any connection with the same path.
1648  *
1649  * If the existing connection is ready, it is kept.
1650  * Otherwise if the sender has a smaller ID that ours, we accept it (and
1651  * the peer will eventually reject our attempt).
1652  *
1653  * @param path Path to check.
1654  * @return #GNUNET_YES if the tunnel has a connection with the same path,
1655  *         #GNUNET_NO otherwise.
1656  */
1657 static int
1658 does_connection_exist (struct CadetConnection *conn)
1659 {
1660   struct CadetPeer *p;
1661   struct CadetTunnel *t;
1662   struct CadetConnection *c;
1663
1664   p = GCP_get_short (conn->path->peers[0], GNUNET_NO);
1665   if (NULL == p)
1666     return GNUNET_NO;
1667   t = GCP_get_tunnel (p);
1668   if (NULL == t)
1669     return GNUNET_NO;
1670
1671   LOG (GNUNET_ERROR_TYPE_DEBUG, "Checking for duplicates\n");
1672
1673   GCT_iterate_connections (t, &check_path, conn);
1674
1675   if (GNUNET_YES == conn->destroy)
1676   {
1677     c = conn->path->c;
1678     conn->destroy = GNUNET_NO;
1679     conn->path->c = conn;
1680     LOG (GNUNET_ERROR_TYPE_DEBUG, " found duplicate of %s\n", GCC_2s (conn));
1681     LOG (GNUNET_ERROR_TYPE_DEBUG, " duplicate: %s\n", GCC_2s (c));
1682     GCC_debug (c, GNUNET_ERROR_TYPE_DEBUG);
1683     if (CADET_CONNECTION_READY == c->state)
1684     {
1685       /* The other peer confirmed a live connection with this path,
1686        * why are they trying to duplicate it? */
1687       GNUNET_STATISTICS_update (stats, "# duplicate connections", 1, GNUNET_NO);
1688       return GNUNET_YES;
1689     }
1690     LOG (GNUNET_ERROR_TYPE_DEBUG, " duplicate not ready, connection unique\n");
1691     return GNUNET_NO;
1692   }
1693   else
1694   {
1695     LOG (GNUNET_ERROR_TYPE_DEBUG, " %s has no duplicates\n", GCC_2s (conn));
1696     return GNUNET_NO;
1697   }
1698 }
1699
1700
1701 /**
1702  * @brief Check if the tunnel this connection belongs to has any other
1703  * connection with the same path, and destroy one if so.
1704  *
1705  * @param cls Closure (connection to check).
1706  */
1707 static void
1708 check_duplicates (void *cls)
1709 {
1710   struct CadetConnection *c = cls;
1711
1712   c->check_duplicates_task = NULL;
1713   if (GNUNET_YES == does_connection_exist (c))
1714   {
1715     GCT_debug (c->t, GNUNET_ERROR_TYPE_DEBUG);
1716     send_broken (c, &my_full_id, &my_full_id, GCC_is_origin (c, GNUNET_YES));
1717     GCC_destroy (c);
1718   }
1719 }
1720
1721
1722 /**
1723  * Wait for enough time to let any dead connections time out and check for
1724  * any remaining duplicates.
1725  *
1726  * @param c Connection that is a potential duplicate.
1727  */
1728 static void
1729 schedule_check_duplicates (struct CadetConnection *c)
1730 {
1731   struct GNUNET_TIME_Relative delay;
1732
1733   if (NULL != c->check_duplicates_task)
1734     return;
1735   delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 5);
1736   c->check_duplicates_task = GNUNET_SCHEDULER_add_delayed (delay,
1737                                                            &check_duplicates,
1738                                                            c);
1739 }
1740
1741
1742 /**
1743  * Add the connection to the list of both neighbors.
1744  *
1745  * @param c Connection.
1746  *
1747  * @return #GNUNET_OK if everything went fine
1748  *         #GNUNET_SYSERR if the was an error and @c c is malformed.
1749  */
1750 static int
1751 register_neighbors (struct CadetConnection *c)
1752 {
1753   c->next_peer = get_next_hop (c);
1754   c->prev_peer = get_prev_hop (c);
1755   GNUNET_assert (c->next_peer != c->prev_peer);
1756   LOG (GNUNET_ERROR_TYPE_DEBUG,
1757        "register neighbors for connection %s\n",
1758        GCC_2s (c));
1759   path_debug (c->path);
1760   LOG (GNUNET_ERROR_TYPE_DEBUG,
1761        "own pos %u\n", c->own_pos);
1762   LOG (GNUNET_ERROR_TYPE_DEBUG,
1763        "putting connection %s to next peer %p\n",
1764        GCC_2s (c),
1765        c->next_peer);
1766   LOG (GNUNET_ERROR_TYPE_DEBUG, "next peer %p %s\n",
1767        c->next_peer,
1768        GCP_2s (c->next_peer));
1769   LOG (GNUNET_ERROR_TYPE_DEBUG,
1770        "putting connection %s to prev peer %p\n",
1771        GCC_2s (c),
1772        c->prev_peer);
1773   LOG (GNUNET_ERROR_TYPE_DEBUG,
1774        "prev peer %p %s\n",
1775        c->prev_peer,
1776        GCP_2s (c->prev_peer));
1777
1778   if ( (GNUNET_NO == GCP_is_neighbor (c->next_peer)) ||
1779        (GNUNET_NO == GCP_is_neighbor (c->prev_peer)) )
1780   {
1781     if (GCC_is_origin (c, GNUNET_YES))
1782       GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1783     GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1784
1785     LOG (GNUNET_ERROR_TYPE_DEBUG,
1786          "  register neighbors failed\n");
1787     LOG (GNUNET_ERROR_TYPE_DEBUG,
1788          "  prev: %s, neighbor?: %d\n",
1789          GCP_2s (c->prev_peer),
1790          GCP_is_neighbor (c->prev_peer));
1791     LOG (GNUNET_ERROR_TYPE_DEBUG,
1792          "  next: %s, neighbor?: %d\n",
1793          GCP_2s (c->next_peer),
1794          GCP_is_neighbor (c->next_peer));
1795     return GNUNET_SYSERR;
1796   }
1797   GCP_add_connection (c->next_peer, c, GNUNET_NO);
1798   GCP_add_connection (c->prev_peer, c, GNUNET_YES);
1799
1800   return GNUNET_OK;
1801 }
1802
1803
1804 /**
1805  * Remove the connection from the list of both neighbors.
1806  *
1807  * @param c Connection.
1808  */
1809 static void
1810 unregister_neighbors (struct CadetConnection *c)
1811 {
1812 //  struct CadetPeer *peer; FIXME dont use next_peer, prev_peer
1813   /* Either already unregistered or never got registered, it's ok either way. */
1814   if (NULL == c->path)
1815     return;
1816   if (NULL != c->next_peer)
1817   {
1818     GCP_remove_connection (c->next_peer, c);
1819     c->next_peer = NULL;
1820   }
1821   if (NULL != c->prev_peer)
1822   {
1823     GCP_remove_connection (c->prev_peer, c);
1824     c->prev_peer = NULL;
1825   }
1826 }
1827
1828
1829 /**
1830  * Invalidates all paths towards all peers that comprise the connection which
1831  * rely on the disconnected peer.
1832  *
1833  * ~O(n^3) (peers in connection * paths/peer * links/path)
1834  *
1835  * @param c Connection whose peers' paths to clean.
1836  * @param disconnected Peer that disconnected.
1837  */
1838 static void
1839 invalidate_paths (struct CadetConnection *c,
1840                   struct CadetPeer *disconnected)
1841 {
1842   struct CadetPeer *peer;
1843   unsigned int i;
1844
1845   for (i = 0; i < c->path->length; i++)
1846   {
1847     peer = GCP_get_short (c->path->peers[i], GNUNET_NO);
1848     if (NULL != peer)
1849       GCP_notify_broken_link (peer, &my_full_id, GCP_get_id (disconnected));
1850   }
1851 }
1852
1853
1854 /**
1855  * Bind the connection to the peer and the tunnel to that peer.
1856  *
1857  * If the peer has no tunnel, create one. Update tunnel and connection
1858  * data structres to reflect new status.
1859  *
1860  * @param c Connection.
1861  * @param peer Peer.
1862  */
1863 static void
1864 add_to_peer (struct CadetConnection *c,
1865              struct CadetPeer *peer)
1866 {
1867   GCP_add_tunnel (peer);
1868   c->t = GCP_get_tunnel (peer);
1869   GCT_add_connection (c->t, c);
1870 }
1871
1872
1873 /**
1874  * Log receipt of message on stderr (INFO level).
1875  *
1876  * @param message Message received.
1877  * @param peer    Peer who sent the message.
1878  * @param conn_id Connection ID of the message.
1879  */
1880 static void
1881 log_message (const struct GNUNET_MessageHeader *message,
1882              const struct CadetPeer *peer,
1883              const struct GNUNET_CADET_Hash *conn_id)
1884 {
1885   uint16_t size;
1886   uint16_t type;
1887   char *arrow;
1888
1889   size = ntohs (message->size);
1890   type = ntohs (message->type);
1891   switch (type)
1892   {
1893     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE:
1894     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK:
1895     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN:
1896     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY:
1897       arrow = "==";
1898       break;
1899     default:
1900       arrow = "--";
1901   }
1902   LOG (GNUNET_ERROR_TYPE_INFO, "<%s %s on conn %s from %s, %6u bytes\n",
1903        arrow, GC_m2s (type), GNUNET_h2s (GC_h2hc (conn_id)),
1904        GCP_2s(peer), (unsigned int) size);
1905 }
1906
1907 /******************************************************************************/
1908 /********************************    API    ***********************************/
1909 /******************************************************************************/
1910
1911 /**
1912  * Handler for connection creation.
1913  *
1914  * @param peer Message sender (neighbor).
1915  * @param msg Message itself.
1916  */
1917 void
1918 GCC_handle_create (struct CadetPeer *peer,
1919                    const struct GNUNET_CADET_ConnectionCreate *msg)
1920 {
1921   const struct GNUNET_CADET_Hash *cid;
1922   struct GNUNET_PeerIdentity *id;
1923   struct CadetPeerPath *path;
1924   struct CadetPeer *dest_peer;
1925   struct CadetPeer *orig_peer;
1926   struct CadetConnection *c;
1927   unsigned int own_pos;
1928   uint16_t size;
1929
1930   GCC_check_connections ();
1931   size = ntohs (msg->header.size);
1932
1933   /* Calculate hops */
1934   size -= sizeof (struct GNUNET_CADET_ConnectionCreate);
1935   if (0 != size % sizeof (struct GNUNET_PeerIdentity))
1936   {
1937     GNUNET_break_op (0);
1938     return;
1939   }
1940   size /= sizeof (struct GNUNET_PeerIdentity);
1941   if (1 > size)
1942   {
1943     GNUNET_break_op (0);
1944     return;
1945   }
1946   LOG (GNUNET_ERROR_TYPE_DEBUG, "    path has %u hops.\n", size);
1947
1948   /* Get parameters */
1949   cid = &msg->cid;
1950   log_message (&msg->header, peer, cid);
1951   id = (struct GNUNET_PeerIdentity *) &msg[1];
1952   LOG (GNUNET_ERROR_TYPE_DEBUG, "    origin: %s\n", GNUNET_i2s (id));
1953
1954   /* Create connection */
1955   c = connection_get (cid);
1956   if (NULL == c)
1957   {
1958     path = path_build_from_peer_ids ((struct GNUNET_PeerIdentity *) &msg[1],
1959                                      size, myid, &own_pos);
1960     if (NULL == path)
1961     {
1962       /* Path was malformed, probably our own ID was not in it. */
1963       GNUNET_STATISTICS_update (stats, "# malformed paths", 1, GNUNET_NO);
1964       GNUNET_break_op (0);
1965       return;
1966     }
1967     if (0 == own_pos)
1968     {
1969       /* We received this request from a neighbor, we cannot be origin */
1970       GNUNET_STATISTICS_update (stats, "# fake paths", 1, GNUNET_NO);
1971       GNUNET_break_op (0);
1972       path_destroy (path);
1973       return;
1974     }
1975
1976     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Own position: %u\n", own_pos);
1977     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Creating connection\n");
1978     c = GCC_new (cid, NULL, path, own_pos);
1979     if (NULL == c)
1980     {
1981       if (path->length - 1 == own_pos)
1982       {
1983         /* If we are destination, why did the creation fail? */
1984         GNUNET_break (0);
1985         path_destroy (path);
1986         GCC_check_connections ();
1987         return;
1988       }
1989       send_broken_unknown (cid, &my_full_id,
1990                            GNUNET_PEER_resolve2 (path->peers[own_pos + 1]),
1991                            peer);
1992       path_destroy (path);
1993       GCC_check_connections ();
1994       return;
1995     }
1996     GCP_add_path_to_all (path, GNUNET_NO);
1997     connection_reset_timeout (c, GNUNET_YES);
1998   }
1999   else
2000   {
2001     path = path_duplicate (c->path);
2002   }
2003   if (CADET_CONNECTION_NEW == c->state)
2004     connection_change_state (c, CADET_CONNECTION_SENT);
2005
2006   /* Remember peers */
2007   dest_peer = GCP_get (&id[size - 1], GNUNET_YES);
2008   orig_peer = GCP_get (&id[0], GNUNET_YES);
2009
2010   /* Is it a connection to us? */
2011   if (c->own_pos == path->length - 1)
2012   {
2013     LOG (GNUNET_ERROR_TYPE_DEBUG, "  It's for us!\n");
2014     GCP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
2015
2016     add_to_peer (c, orig_peer);
2017     if (GNUNET_YES == does_connection_exist (c))
2018     {
2019       /* Peer created a connection equal to one we think exists
2020        * and is fine.
2021        * Solution: Keep both and postpone disambiguation. In the meantime
2022        * the connection will time out or peer will inform us it is broken.
2023        *
2024        * Other options:
2025        * - Use explicit duplicate.
2026        * - Accept new conn and destroy the old. (interruption in higher level)
2027        * - Keep the one with higher ID / created by peer with higher ID. */
2028        schedule_check_duplicates (c);
2029     }
2030
2031     if (CADET_TUNNEL_NEW == GCT_get_cstate (c->t))
2032       GCT_change_cstate (c->t,  CADET_TUNNEL_WAITING);
2033
2034     send_connection_ack (c, GNUNET_NO);
2035     if (CADET_CONNECTION_SENT == c->state)
2036       connection_change_state (c, CADET_CONNECTION_ACK);
2037   }
2038   else
2039   {
2040     /* It's for somebody else! Retransmit. */
2041     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Retransmitting.\n");
2042     GCP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
2043     GCP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
2044     GNUNET_assert (NULL ==
2045                    GCC_send_prebuilt_message (&msg->header, 0, 0, c,
2046                                               GNUNET_YES, GNUNET_YES,
2047                                               NULL, NULL));
2048   }
2049   path_destroy (path);
2050   GCC_check_connections ();
2051 }
2052
2053
2054 /**
2055  * Handler for connection confirmations.
2056  *
2057  * @param peer Message sender (neighbor).
2058  * @param msg Message itself.
2059  */
2060 void
2061 GCC_handle_confirm (struct CadetPeer *peer,
2062                     const struct GNUNET_CADET_ConnectionACK *msg)
2063 {
2064   struct CadetConnection *c;
2065   enum CadetConnectionState oldstate;
2066   int fwd;
2067
2068   GCC_check_connections ();
2069   log_message (&msg->header, peer, &msg->cid);
2070   c = connection_get (&msg->cid);
2071   if (NULL == c)
2072   {
2073     GNUNET_STATISTICS_update (stats, "# control on unknown connection",
2074                               1, GNUNET_NO);
2075     LOG (GNUNET_ERROR_TYPE_DEBUG,
2076          "  don't know the connection!\n");
2077     send_broken_unknown (&msg->cid, &my_full_id, NULL, peer);
2078     GCC_check_connections ();
2079     return;
2080   }
2081   if (GNUNET_NO != c->destroy)
2082   {
2083     GNUNET_assert (CADET_CONNECTION_DESTROYED == c->state);
2084     GNUNET_STATISTICS_update (stats, "# control on dying connection",
2085                               1, GNUNET_NO);
2086     LOG (GNUNET_ERROR_TYPE_DEBUG,
2087          "connection %s being destroyed, ignoring confirm\n",
2088          GCC_2s (c));
2089     GCC_check_connections ();
2090     return;
2091   }
2092
2093   oldstate = c->state;
2094   LOG (GNUNET_ERROR_TYPE_DEBUG, "  via peer %s\n", GCP_2s (peer));
2095   if (get_next_hop (c) == peer)
2096   {
2097     LOG (GNUNET_ERROR_TYPE_DEBUG, "  SYNACK\n");
2098     fwd = GNUNET_NO;
2099     if (CADET_CONNECTION_SENT == oldstate)
2100       connection_change_state (c, CADET_CONNECTION_ACK);
2101   }
2102   else if (get_prev_hop (c) == peer)
2103   {
2104     LOG (GNUNET_ERROR_TYPE_DEBUG, "  FINAL ACK\n");
2105     fwd = GNUNET_YES;
2106     connection_change_state (c, CADET_CONNECTION_READY);
2107   }
2108   else
2109   {
2110     GNUNET_STATISTICS_update (stats, "# control on connection from wrong peer",
2111                               1, GNUNET_NO);
2112     GNUNET_break_op (0);
2113     return;
2114   }
2115
2116   connection_reset_timeout (c, fwd);
2117
2118   /* Add path to peers? */
2119   if (NULL != c->path)
2120   {
2121     GCP_add_path_to_all (c->path, GNUNET_YES);
2122   }
2123   else
2124   {
2125     GNUNET_break (0);
2126   }
2127
2128   /* Message for us as creator? */
2129   if (GNUNET_YES == GCC_is_origin (c, GNUNET_YES))
2130   {
2131     if (GNUNET_NO != fwd)
2132     {
2133       GNUNET_break (0);
2134       return;
2135     }
2136     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Connection (SYN)ACK for us!\n");
2137
2138     /* If just created, cancel the short timeout and start a long one */
2139     if (CADET_CONNECTION_SENT == oldstate)
2140       connection_reset_timeout (c, GNUNET_YES);
2141
2142     /* Change connection state, send ACK */
2143     connection_change_state (c, CADET_CONNECTION_READY);
2144     send_connection_ack (c, GNUNET_YES);
2145
2146     /* Change tunnel state, trigger KX */
2147     if (CADET_TUNNEL_WAITING == GCT_get_cstate (c->t))
2148       GCT_change_cstate (c->t, CADET_TUNNEL_READY);
2149     GCC_check_connections ();
2150     return;
2151   }
2152
2153   /* Message for us as destination? */
2154   if (GCC_is_terminal (c, GNUNET_YES))
2155   {
2156     if (GNUNET_YES != fwd)
2157     {
2158       GNUNET_break (0);
2159       return;
2160     }
2161     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Connection ACK for us!\n");
2162
2163     /* If just created, cancel the short timeout and start a long one */
2164     if (CADET_CONNECTION_ACK == oldstate)
2165       connection_reset_timeout (c, GNUNET_NO);
2166
2167     /* Change tunnel state */
2168     if (CADET_TUNNEL_WAITING == GCT_get_cstate (c->t))
2169       GCT_change_cstate (c->t, CADET_TUNNEL_READY);
2170     GCC_check_connections ();
2171     return;
2172   }
2173
2174   LOG (GNUNET_ERROR_TYPE_DEBUG, "  not for us, retransmitting...\n");
2175   GNUNET_assert (NULL ==
2176                  GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2177                                             GNUNET_YES, NULL, NULL));
2178   GCC_check_connections ();
2179   return;
2180 }
2181
2182
2183 /**
2184  * Handler for notifications of broken connections.
2185  *
2186  * @param peer Message sender (neighbor).
2187  * @param msg Message itself.
2188  */
2189 void
2190 GCC_handle_broken (struct CadetPeer *peer,
2191                    const struct GNUNET_CADET_ConnectionBroken *msg)
2192 {
2193   struct CadetConnection *c;
2194   struct CadetTunnel *t;
2195   int fwd;
2196
2197   GCC_check_connections ();
2198   log_message (&msg->header, peer, &msg->cid);
2199   LOG (GNUNET_ERROR_TYPE_DEBUG, "  regarding %s\n",
2200               GNUNET_i2s (&msg->peer1));
2201   LOG (GNUNET_ERROR_TYPE_DEBUG, "  regarding %s\n",
2202               GNUNET_i2s (&msg->peer2));
2203   c = connection_get (&msg->cid);
2204   if (NULL == c)
2205   {
2206     LOG (GNUNET_ERROR_TYPE_DEBUG, "  duplicate CONNECTION_BROKEN\n");
2207     GNUNET_STATISTICS_update (stats, "# duplicate CONNECTION_BROKEN",
2208                               1, GNUNET_NO);
2209     GCC_check_connections ();
2210     return;
2211   }
2212
2213   t = c->t;
2214
2215   fwd = is_fwd (c, peer);
2216   if (GNUNET_SYSERR == fwd)
2217   {
2218     GNUNET_break_op (0);
2219     GCC_check_connections ();
2220     return;
2221   }
2222   mark_destroyed (c);
2223   if (GCC_is_terminal (c, fwd))
2224   {
2225     struct CadetPeer *endpoint;
2226
2227     if (NULL == t)
2228     {
2229       /* A terminal connection should not have 't' set to NULL. */
2230       GNUNET_break (0);
2231       GCC_debug (c, GNUNET_ERROR_TYPE_ERROR);
2232       return;
2233     }
2234     endpoint = GCP_get_short (c->path->peers[c->path->length - 1], GNUNET_YES);
2235     if (2 < c->path->length)
2236       path_invalidate (c->path);
2237     GCP_notify_broken_link (endpoint, &msg->peer1, &msg->peer2);
2238
2239     connection_change_state (c, CADET_CONNECTION_BROKEN);
2240     GCT_remove_connection (t, c);
2241     c->t = NULL;
2242
2243     GCC_destroy (c);
2244   }
2245   else
2246   {
2247     GNUNET_assert (NULL ==
2248                    GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2249                                               GNUNET_YES, NULL, NULL));
2250     connection_cancel_queues (c, !fwd);
2251   }
2252   GCC_check_connections ();
2253   return;
2254 }
2255
2256
2257 /**
2258  * Handler for notifications of destroyed connections.
2259  *
2260  * @param peer Message sender (neighbor).
2261  * @param msg Message itself.
2262  */
2263 void
2264 GCC_handle_destroy (struct CadetPeer *peer,
2265                     const struct GNUNET_CADET_ConnectionDestroy *msg)
2266 {
2267   struct CadetConnection *c;
2268   int fwd;
2269
2270   GCC_check_connections ();
2271   log_message (&msg->header, peer, &msg->cid);
2272   c = connection_get (&msg->cid);
2273   if (NULL == c)
2274   {
2275     /* Probably already got the message from another path,
2276      * destroyed the tunnel and retransmitted to children.
2277      * Safe to ignore.
2278      */
2279     GNUNET_STATISTICS_update (stats,
2280                               "# control on unknown connection",
2281                               1, GNUNET_NO);
2282     LOG (GNUNET_ERROR_TYPE_DEBUG,
2283          "  connection unknown destroyed: previously destroyed?\n");
2284     GCC_check_connections ();
2285     return;
2286   }
2287
2288   fwd = is_fwd (c, peer);
2289   if (GNUNET_SYSERR == fwd)
2290   {
2291     GNUNET_break_op (0);
2292     GCC_check_connections ();
2293     return;
2294   }
2295
2296   if (GNUNET_NO == GCC_is_terminal (c, fwd))
2297   {
2298     GNUNET_assert (NULL ==
2299                    GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2300                                               GNUNET_YES, NULL, NULL));
2301   }
2302   else if (0 == c->pending_messages)
2303   {
2304     LOG (GNUNET_ERROR_TYPE_DEBUG, "  directly destroying connection!\n");
2305     GCC_destroy (c);
2306     GCC_check_connections ();
2307     return;
2308   }
2309   mark_destroyed (c);
2310   if (NULL != c->t)
2311   {
2312     GCT_remove_connection (c->t, c);
2313     c->t = NULL;
2314   }
2315   GCC_check_connections ();
2316   return;
2317 }
2318
2319
2320 /**
2321  * Handler for cadet network traffic hop-by-hop acks.
2322  *
2323  * @param peer Message sender (neighbor).
2324  * @param msg Message itself.
2325  */
2326 void
2327 GCC_handle_ack (struct CadetPeer *peer,
2328                 const struct GNUNET_CADET_ACK *msg)
2329 {
2330   struct CadetConnection *c;
2331   struct CadetFlowControl *fc;
2332   uint32_t ack;
2333   int fwd;
2334
2335   GCC_check_connections ();
2336   log_message (&msg->header, peer, &msg->cid);
2337   c = connection_get (&msg->cid);
2338   if (NULL == c)
2339   {
2340     GNUNET_STATISTICS_update (stats,
2341                               "# ack on unknown connection",
2342                               1,
2343                               GNUNET_NO);
2344     send_broken_unknown (&msg->cid,
2345                          &my_full_id,
2346                          NULL,
2347                          peer);
2348     GCC_check_connections ();
2349     return;
2350   }
2351
2352   /* Is this a forward or backward ACK? */
2353   if (get_next_hop (c) == peer)
2354   {
2355     fc = &c->fwd_fc;
2356     fwd = GNUNET_YES;
2357   }
2358   else if (get_prev_hop (c) == peer)
2359   {
2360     fc = &c->bck_fc;
2361     fwd = GNUNET_NO;
2362   }
2363   else
2364   {
2365     GNUNET_break_op (0);
2366     return;
2367   }
2368
2369   ack = ntohl (msg->ack);
2370   LOG (GNUNET_ERROR_TYPE_DEBUG, " %s ACK %u (was %u)\n",
2371        GC_f2s (fwd), ack, fc->last_ack_recv);
2372   if (GC_is_pid_bigger (ack, fc->last_ack_recv))
2373     fc->last_ack_recv = ack;
2374
2375   /* Cancel polling if the ACK is big enough. */
2376   if (NULL != fc->poll_task &&
2377       GC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2378   {
2379     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Cancel poll\n");
2380     GNUNET_SCHEDULER_cancel (fc->poll_task);
2381     fc->poll_task = NULL;
2382     fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
2383   }
2384
2385   GCC_check_connections ();
2386 }
2387
2388
2389 /**
2390  * Handler for cadet network traffic hop-by-hop data counter polls.
2391  *
2392  * @param peer Message sender (neighbor).
2393  * @param msg Message itself.
2394  */
2395 void
2396 GCC_handle_poll (struct CadetPeer *peer,
2397                  const struct GNUNET_CADET_Poll *msg)
2398 {
2399   struct CadetConnection *c;
2400   struct CadetFlowControl *fc;
2401   uint32_t pid;
2402   int fwd;
2403
2404   GCC_check_connections ();
2405   log_message (&msg->header, peer, &msg->cid);
2406   c = connection_get (&msg->cid);
2407   if (NULL == c)
2408   {
2409     GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
2410                               GNUNET_NO);
2411     LOG (GNUNET_ERROR_TYPE_DEBUG,
2412          "POLL message on unknown connection %s!\n",
2413          GNUNET_h2s (GC_h2hc (&msg->cid)));
2414     send_broken_unknown (&msg->cid,
2415                          &my_full_id,
2416                          NULL,
2417                          peer);
2418     GCC_check_connections ();
2419     return;
2420   }
2421
2422   /* Is this a forward or backward ACK?
2423    * Note: a poll should never be needed in a loopback case,
2424    * since there is no possiblility of packet loss there, so
2425    * this way of discerining FWD/BCK should not be a problem.
2426    */
2427   if (get_next_hop (c) == peer)
2428   {
2429     LOG (GNUNET_ERROR_TYPE_DEBUG, "  FWD FC\n");
2430     fc = &c->fwd_fc;
2431   }
2432   else if (get_prev_hop (c) == peer)
2433   {
2434     LOG (GNUNET_ERROR_TYPE_DEBUG, "  BCK FC\n");
2435     fc = &c->bck_fc;
2436   }
2437   else
2438   {
2439     GNUNET_break_op (0);
2440     return;
2441   }
2442
2443   pid = ntohl (msg->pid);
2444   LOG (GNUNET_ERROR_TYPE_DEBUG, "  PID %u, OLD %u\n", pid, fc->last_pid_recv);
2445   fc->last_pid_recv = pid;
2446   fwd = fc == &c->bck_fc;
2447   GCC_send_ack (c, fwd, GNUNET_YES);
2448   GCC_check_connections ();
2449 }
2450
2451
2452 /**
2453  * Check the message against internal state and test if it goes FWD or BCK.
2454  *
2455  * Updates the PID, state and timeout values for the connection.
2456  *
2457  * @param message Message to check. It must belong to an existing connection.
2458  * @param cid Connection ID (even if @a c is NULL, the ID is still needed).
2459  * @param c Connection this message should belong. If NULL, check fails.
2460  * @param sender Neighbor that sent the message.
2461  *
2462  * @return #GNUNET_YES if the message goes FWD.
2463  *         #GNUNET_NO if it goes BCK.
2464  *         #GNUNET_SYSERR if there is an error (unauthorized sender, ...).
2465  */
2466 static int
2467 check_message (const struct GNUNET_MessageHeader *message,
2468                const struct GNUNET_CADET_Hash* cid,
2469                struct CadetConnection *c,
2470                struct CadetPeer *sender,
2471                uint32_t pid)
2472 {
2473   struct CadetFlowControl *fc;
2474   struct CadetPeer *hop;
2475   int fwd;
2476   uint16_t type;
2477
2478   /* Check connection */
2479   if (NULL == c)
2480   {
2481     GNUNET_STATISTICS_update (stats,
2482                               "# unknown connection",
2483                               1, GNUNET_NO);
2484     LOG (GNUNET_ERROR_TYPE_DEBUG,
2485          "%s on unknown connection %s\n",
2486          GC_m2s (ntohs (message->type)),
2487          GNUNET_h2s (GC_h2hc (cid)));
2488     send_broken_unknown (cid,
2489                          &my_full_id,
2490                          NULL,
2491                          sender);
2492     return GNUNET_SYSERR;
2493   }
2494
2495   /* Check if origin is as expected */
2496   hop = get_prev_hop (c);
2497   if (sender == hop)
2498   {
2499     fwd = GNUNET_YES;
2500   }
2501   else
2502   {
2503     hop = get_next_hop (c);
2504     GNUNET_break (hop == c->next_peer);
2505     if (sender == hop)
2506     {
2507       fwd = GNUNET_NO;
2508     }
2509     else
2510     {
2511       /* Unexpected peer sending traffic on a connection. */
2512       GNUNET_break_op (0);
2513       return GNUNET_SYSERR;
2514     }
2515   }
2516
2517   /* Check PID for payload messages */
2518   type = ntohs (message->type);
2519   if (GNUNET_MESSAGE_TYPE_CADET_AX == type)
2520   {
2521     fc = fwd ? &c->bck_fc : &c->fwd_fc;
2522     LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u (expected %u - %u)\n",
2523          pid, fc->last_pid_recv + 1, fc->last_ack_sent);
2524     if (GC_is_pid_bigger (pid, fc->last_ack_sent))
2525     {
2526       GNUNET_break_op (0);
2527       GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
2528       LOG (GNUNET_ERROR_TYPE_WARNING, "Received PID %u, (prev %u), ACK %u\n",
2529           pid, fc->last_pid_recv, fc->last_ack_sent);
2530       return GNUNET_SYSERR;
2531     }
2532     if (GC_is_pid_bigger (pid, fc->last_pid_recv))
2533     {
2534       unsigned int delta;
2535
2536       delta = pid - fc->last_pid_recv;
2537       fc->last_pid_recv = pid;
2538       fc->recv_bitmap <<= delta;
2539       fc->recv_bitmap |= 1;
2540     }
2541     else
2542     {
2543       GNUNET_STATISTICS_update (stats, "# out of order PID", 1, GNUNET_NO);
2544       if (GNUNET_NO == is_ooo_ok (fc->last_pid_recv, pid, fc->recv_bitmap))
2545       {
2546         LOG (GNUNET_ERROR_TYPE_WARNING, "PID %u unexpected (%u+), dropping!\n",
2547              pid, fc->last_pid_recv - 31);
2548         return GNUNET_SYSERR;
2549       }
2550       fc->recv_bitmap |= get_recv_bitmask (fc->last_pid_recv, pid);
2551     }
2552   }
2553
2554   /* Count as connection confirmation. */
2555   if (CADET_CONNECTION_SENT == c->state || CADET_CONNECTION_ACK == c->state)
2556   {
2557     connection_change_state (c, CADET_CONNECTION_READY);
2558     if (NULL != c->t)
2559     {
2560       if (CADET_TUNNEL_WAITING == GCT_get_cstate (c->t))
2561         GCT_change_cstate (c->t, CADET_TUNNEL_READY);
2562     }
2563   }
2564   connection_reset_timeout (c, fwd);
2565
2566   return fwd;
2567 }
2568
2569
2570 /**
2571  * Handler for key exchange traffic (Axolotl KX).
2572  *
2573  * @param peer Message sender (neighbor).
2574  * @param msg Message itself.
2575  */
2576 void
2577 GCC_handle_kx (struct CadetPeer *peer,
2578                const struct GNUNET_CADET_KX *msg)
2579 {
2580   const struct GNUNET_CADET_Hash* cid;
2581   struct CadetConnection *c;
2582   int fwd;
2583
2584   GCC_check_connections ();
2585   cid = &msg->cid;
2586   log_message (&msg->header, peer, cid);
2587
2588   c = connection_get (cid);
2589   fwd = check_message (&msg->header,
2590                        cid,
2591                        c,
2592                        peer,
2593                        0);
2594
2595   /* If something went wrong, discard message. */
2596   if (GNUNET_SYSERR == fwd)
2597   {
2598     GNUNET_break_op (0);
2599     GCC_check_connections ();
2600     return;
2601   }
2602
2603   /* Is this message for us? */
2604   if (GCC_is_terminal (c, fwd))
2605   {
2606     LOG (GNUNET_ERROR_TYPE_DEBUG, "  message for us!\n");
2607     GNUNET_STATISTICS_update (stats, "# received KX", 1, GNUNET_NO);
2608     if (NULL == c->t)
2609     {
2610       GNUNET_break (0);
2611       return;
2612     }
2613     GCT_handle_kx (c->t, &msg[1].header);
2614     GCC_check_connections ();
2615     return;
2616   }
2617
2618   /* Message not for us: forward to next hop */
2619   LOG (GNUNET_ERROR_TYPE_DEBUG, "  not for us, retransmitting...\n");
2620   GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2621   GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2622                                                     GNUNET_NO, NULL, NULL));
2623   GCC_check_connections ();
2624 }
2625
2626
2627 /**
2628  * Handler for encrypted cadet network traffic (channel mgmt, data).
2629  *
2630  * @param peer Message sender (neighbor).
2631  * @param msg Message itself.
2632  */
2633 void
2634 GCC_handle_encrypted (struct CadetPeer *peer,
2635                       const struct GNUNET_CADET_AX *msg)
2636 {
2637   const struct GNUNET_CADET_Hash* cid;
2638   struct CadetConnection *c;
2639   uint32_t pid;
2640   int fwd;
2641
2642   GCC_check_connections ();
2643   cid = &msg->cid;
2644   pid = ntohl (msg->pid);
2645   log_message (&msg->header, peer, cid);
2646
2647   c = connection_get (cid);
2648   fwd = check_message (&msg->header,
2649                        cid,
2650                        c,
2651                        peer,
2652                        pid);
2653
2654   /* If something went wrong, discard message. */
2655   if (GNUNET_SYSERR == fwd)
2656   {
2657     GNUNET_break_op (0);
2658     GCC_check_connections ();
2659     return;
2660   }
2661
2662   /* Is this message for us? */
2663   if (GCC_is_terminal (c, fwd))
2664   {
2665     GNUNET_STATISTICS_update (stats, "# received encrypted", 1, GNUNET_NO);
2666
2667     if (NULL == c->t)
2668     {
2669       GNUNET_break (GNUNET_NO != c->destroy);
2670       return;
2671     }
2672     GCT_handle_encrypted (c->t, &msg->header);
2673     GCC_send_ack (c, fwd, GNUNET_NO);
2674     GCC_check_connections ();
2675     return;
2676   }
2677
2678   /* Message not for us: forward to next hop */
2679   LOG (GNUNET_ERROR_TYPE_DEBUG, "  not for us, retransmitting...\n");
2680   GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2681   GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2682                                                     GNUNET_NO, NULL, NULL));
2683   GCC_check_connections ();
2684 }
2685
2686
2687 /**
2688  * Initialize the connections subsystem
2689  *
2690  * @param c Configuration handle.
2691  */
2692 void
2693 GCC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2694 {
2695   LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2696   if (GNUNET_OK !=
2697       GNUNET_CONFIGURATION_get_value_number (c, "CADET", "MAX_MSGS_QUEUE",
2698                                              &max_msgs_queue))
2699   {
2700     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2701                                "CADET", "MAX_MSGS_QUEUE", "MISSING");
2702     GNUNET_SCHEDULER_shutdown ();
2703     return;
2704   }
2705
2706   if (GNUNET_OK !=
2707       GNUNET_CONFIGURATION_get_value_number (c, "CADET", "MAX_CONNECTIONS",
2708                                              &max_connections))
2709   {
2710     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2711                                "CADET", "MAX_CONNECTIONS", "MISSING");
2712     GNUNET_SCHEDULER_shutdown ();
2713     return;
2714   }
2715
2716   if (GNUNET_OK !=
2717       GNUNET_CONFIGURATION_get_value_time (c, "CADET", "REFRESH_CONNECTION_TIME",
2718                                            &refresh_connection_time))
2719   {
2720     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2721                                "CADET", "REFRESH_CONNECTION_TIME", "MISSING");
2722     GNUNET_SCHEDULER_shutdown ();
2723     return;
2724   }
2725   create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2726   connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
2727 }
2728
2729
2730 /**
2731  * Destroy each connection on shutdown.
2732  *
2733  * @param cls Closure (unused).
2734  * @param key Current key code (CID, unused).
2735  * @param value Value in the hash map (`struct CadetConnection`)
2736  *
2737  * @return #GNUNET_YES, because we should continue to iterate
2738  */
2739 static int
2740 shutdown_iterator (void *cls,
2741                    const struct GNUNET_HashCode *key,
2742                    void *value)
2743 {
2744   struct CadetConnection *c = value;
2745
2746   c->state = CADET_CONNECTION_DESTROYED;
2747   GCC_destroy (c);
2748   return GNUNET_YES;
2749 }
2750
2751
2752 /**
2753  * Shut down the connections subsystem.
2754  */
2755 void
2756 GCC_shutdown (void)
2757 {
2758   LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutting down connections\n");
2759   GCC_check_connections ();
2760   GNUNET_CONTAINER_multihashmap_iterate (connections,
2761                                          &shutdown_iterator,
2762                                          NULL);
2763   GNUNET_CONTAINER_multihashmap_destroy (connections);
2764   connections = NULL;
2765 }
2766
2767
2768 /**
2769  * Create a connection.
2770  *
2771  * @param cid Connection ID (either created locally or imposed remotely).
2772  * @param t Tunnel this connection belongs to (or NULL for transit connections);
2773  * @param path Path this connection has to use (copy is made).
2774  * @param own_pos Own position in the @c path path.
2775  *
2776  * @return Newly created connection.
2777  *         NULL in case of error: own id not in path, wrong neighbors, ...
2778 */
2779 struct CadetConnection *
2780 GCC_new (const struct GNUNET_CADET_Hash *cid,
2781          struct CadetTunnel *t,
2782          struct CadetPeerPath *path,
2783          unsigned int own_pos)
2784 {
2785   struct CadetConnection *c;
2786   struct CadetPeerPath *cpath;
2787
2788   GCC_check_connections ();
2789   cpath = path_duplicate (path);
2790   GNUNET_assert (NULL != cpath);
2791   c = GNUNET_new (struct CadetConnection);
2792   c->id = *cid;
2793   GNUNET_assert (GNUNET_OK ==
2794                  GNUNET_CONTAINER_multihashmap_put (connections,
2795                                                     GCC_get_h (c), c,
2796                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2797   fc_init (&c->fwd_fc);
2798   fc_init (&c->bck_fc);
2799   c->fwd_fc.c = c;
2800   c->bck_fc.c = c;
2801
2802   c->t = t;
2803   GNUNET_assert (own_pos <= cpath->length - 1);
2804   c->own_pos = own_pos;
2805   c->path = cpath;
2806   cpath->c = c;
2807   if (GNUNET_OK != register_neighbors (c))
2808   {
2809     if (0 == own_pos)
2810     {
2811       /* We were the origin of this request, this means we have invalid
2812        * info about the paths to reach the destination. We must invalidate
2813        * the *original* path to avoid trying it again in the next minute.
2814        */
2815       if (2 < path->length)
2816         path_invalidate (path);
2817       else
2818       {
2819         GNUNET_break (0);
2820         GCT_debug(t, GNUNET_ERROR_TYPE_WARNING);
2821       }
2822       c->t = NULL;
2823     }
2824     path_destroy (c->path);
2825     c->path = NULL;
2826     GCC_destroy (c);
2827     return NULL;
2828   }
2829   LOG (GNUNET_ERROR_TYPE_INFO, "New connection %s\n", GCC_2s (c));
2830   GCC_check_connections ();
2831   return c;
2832 }
2833
2834
2835 /**
2836  * Connection is no longer needed: destroy it.
2837  *
2838  * Cancels all pending traffic (including possible DESTROY messages), all
2839  * maintenance tasks and removes the connection from neighbor peers and tunnel.
2840  *
2841  * @param c Connection to destroy.
2842  */
2843 void
2844 GCC_destroy (struct CadetConnection *c)
2845 {
2846   GCC_check_connections ();
2847   if (NULL == c)
2848   {
2849     GNUNET_break (0);
2850     return;
2851   }
2852
2853   if (2 == c->destroy) /* cancel queues -> GCP_queue_cancel -> q_destroy -> */
2854     return;            /* -> message_sent -> GCC_destroy. Don't loop. */
2855   c->destroy = 2;
2856
2857   LOG (GNUNET_ERROR_TYPE_DEBUG,
2858        "destroying connection %s\n",
2859        GCC_2s (c));
2860   LOG (GNUNET_ERROR_TYPE_DEBUG,
2861        " fc's f: %p, b: %p\n",
2862        &c->fwd_fc, &c->bck_fc);
2863   LOG (GNUNET_ERROR_TYPE_DEBUG,
2864        " fc tasks f: %u, b: %u\n",
2865        c->fwd_fc.poll_task,
2866        c->bck_fc.poll_task);
2867
2868   /* Cancel all traffic */
2869   if (NULL != c->path)
2870   {
2871     connection_cancel_queues (c, GNUNET_YES);
2872     connection_cancel_queues (c, GNUNET_NO);
2873     if (NULL != c->maintenance_q)
2874     {
2875       GCP_send_cancel (c->maintenance_q);
2876       c->maintenance_q = NULL;
2877     }
2878   }
2879   unregister_neighbors (c);
2880   path_destroy (c->path);
2881   c->path = NULL;
2882
2883   /* Delete from tunnel */
2884   if (NULL != c->t)
2885     GCT_remove_connection (c->t, c);
2886
2887   if (NULL != c->check_duplicates_task)
2888     GNUNET_SCHEDULER_cancel (c->check_duplicates_task);
2889   if (NULL != c->fwd_maintenance_task)
2890     GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2891   if (NULL != c->bck_maintenance_task)
2892     GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2893
2894   if (GNUNET_NO == c->was_removed)
2895   {
2896     GNUNET_break (GNUNET_YES ==
2897                   GNUNET_CONTAINER_multihashmap_remove (connections,
2898                                                         GCC_get_h (c),
2899                                                         c));
2900   }
2901   GNUNET_STATISTICS_update (stats,
2902                             "# connections",
2903                             -1,
2904                             GNUNET_NO);
2905   GNUNET_free (c);
2906   GCC_check_connections ();
2907 }
2908
2909
2910 /**
2911  * Get the connection ID.
2912  *
2913  * @param c Connection to get the ID from.
2914  *
2915  * @return ID of the connection.
2916  */
2917 const struct GNUNET_CADET_Hash *
2918 GCC_get_id (const struct CadetConnection *c)
2919 {
2920   return &c->id;
2921 }
2922
2923
2924 /**
2925  * Get the connection ID.
2926  *
2927  * @param c Connection to get the ID from.
2928  *
2929  * @return ID of the connection.
2930  */
2931 const struct GNUNET_HashCode *
2932 GCC_get_h (const struct CadetConnection *c)
2933 {
2934   return GC_h2hc (&c->id);
2935 }
2936
2937
2938 /**
2939  * Get the connection path.
2940  *
2941  * @param c Connection to get the path from.
2942  *
2943  * @return path used by the connection.
2944  */
2945 const struct CadetPeerPath *
2946 GCC_get_path (const struct CadetConnection *c)
2947 {
2948   if (GNUNET_NO == c->destroy)
2949     return c->path;
2950   return NULL;
2951 }
2952
2953
2954 /**
2955  * Get the connection state.
2956  *
2957  * @param c Connection to get the state from.
2958  *
2959  * @return state of the connection.
2960  */
2961 enum CadetConnectionState
2962 GCC_get_state (const struct CadetConnection *c)
2963 {
2964   return c->state;
2965 }
2966
2967 /**
2968  * Get the connection tunnel.
2969  *
2970  * @param c Connection to get the tunnel from.
2971  *
2972  * @return tunnel of the connection.
2973  */
2974 struct CadetTunnel *
2975 GCC_get_tunnel (const struct CadetConnection *c)
2976 {
2977   return c->t;
2978 }
2979
2980
2981 /**
2982  * Get free buffer space in a connection.
2983  *
2984  * @param c Connection.
2985  * @param fwd Is query about FWD traffic?
2986  *
2987  * @return Free buffer space [0 - max_msgs_queue/max_connections]
2988  */
2989 unsigned int
2990 GCC_get_buffer (struct CadetConnection *c, int fwd)
2991 {
2992   struct CadetFlowControl *fc;
2993
2994   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2995
2996   LOG (GNUNET_ERROR_TYPE_DEBUG, "  Get %s buffer on %s: %u - %u\n",
2997        GC_f2s (fwd), GCC_2s (c), fc->queue_max, fc->queue_n);
2998   GCC_debug (c, GNUNET_ERROR_TYPE_DEBUG);
2999
3000   return (fc->queue_max - fc->queue_n);
3001 }
3002
3003
3004 /**
3005  * Get how many messages have we allowed to send to us from a direction.
3006  *
3007  * @param c Connection.
3008  * @param fwd Are we asking about traffic from FWD (BCK messages)?
3009  *
3010  * @return last_ack_sent - last_pid_recv
3011  */
3012 unsigned int
3013 GCC_get_allowed (struct CadetConnection *c, int fwd)
3014 {
3015   struct CadetFlowControl *fc;
3016
3017   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3018   if (CADET_CONNECTION_READY != c->state
3019       || GC_is_pid_bigger (fc->last_pid_recv, fc->last_ack_sent))
3020   {
3021     return 0;
3022   }
3023   return (fc->last_ack_sent - fc->last_pid_recv);
3024 }
3025
3026
3027 /**
3028  * Get messages queued in a connection.
3029  *
3030  * @param c Connection.
3031  * @param fwd Is query about FWD traffic?
3032  *
3033  * @return Number of messages queued.
3034  */
3035 unsigned int
3036 GCC_get_qn (struct CadetConnection *c, int fwd)
3037 {
3038   struct CadetFlowControl *fc;
3039
3040   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3041
3042   return fc->queue_n;
3043 }
3044
3045
3046 /**
3047  * Get next PID to use.
3048  *
3049  * @param c Connection.
3050  * @param fwd Is query about FWD traffic?
3051  *
3052  * @return Next PID to use.
3053  */
3054 uint32_t
3055 GCC_get_pid (struct CadetConnection *c, int fwd)
3056 {
3057   struct CadetFlowControl *fc;
3058   uint32_t pid;
3059
3060   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3061   pid = fc->next_pid;
3062   fc->next_pid++;
3063   return pid;
3064 }
3065
3066
3067 /**
3068  * Allow the connection to advertise a buffer of the given size.
3069  *
3070  * The connection will send an @c fwd ACK message (so: in direction !fwd)
3071  * allowing up to last_pid_recv + buffer.
3072  *
3073  * @param c Connection.
3074  * @param buffer How many more messages the connection can accept.
3075  * @param fwd Is this about FWD traffic? (The ack will go dest->root).
3076  */
3077 void
3078 GCC_allow (struct CadetConnection *c, unsigned int buffer, int fwd)
3079 {
3080   LOG (GNUNET_ERROR_TYPE_DEBUG, "  allowing %s %u messages %s\n",
3081        GCC_2s (c), buffer, GC_f2s (fwd));
3082   send_ack (c, buffer, fwd, GNUNET_NO);
3083 }
3084
3085
3086 /**
3087  * Notify other peers on a connection of a broken link. Mark connections
3088  * to destroy after all traffic has been sent.
3089  *
3090  * @param c Connection on which there has been a disconnection.
3091  * @param peer Peer that disconnected.
3092  */
3093 void
3094 GCC_neighbor_disconnected (struct CadetConnection *c, struct CadetPeer *peer)
3095 {
3096   struct CadetFlowControl *fc;
3097   char peer_name[16];
3098   int fwd;
3099
3100   GCC_check_connections ();
3101   strncpy (peer_name, GCP_2s (peer), 16);
3102   peer_name[15] = '\0';
3103   LOG (GNUNET_ERROR_TYPE_DEBUG,
3104        "shutting down %s, %s disconnected\n",
3105        GCC_2s (c), peer_name);
3106
3107   invalidate_paths (c, peer);
3108
3109   fwd = is_fwd (c, peer);
3110   if (GNUNET_SYSERR == fwd)
3111   {
3112     GNUNET_break (0);
3113     return;
3114   }
3115   if ( (GNUNET_YES == GCC_is_terminal (c, fwd)) ||
3116        (GNUNET_NO != c->destroy) )
3117   {
3118     /* Local shutdown, or other peer already down (hence 'c->destroy');
3119        so there is no one to notify about this, just clean up. */
3120     GCC_destroy (c);
3121     GCC_check_connections ();
3122     return;
3123   }
3124   /* Mark FlowControl towards the peer as unavaliable. */
3125   fc = fwd ? &c->bck_fc : &c->fwd_fc;
3126   fc->queue_max = 0;
3127
3128   send_broken (c, &my_full_id, GCP_get_id (peer), fwd);
3129
3130   /* Connection will have at least one pending message
3131    * (the one we just scheduled), so delay destruction
3132    * and remove from map so we don't use accidentally. */
3133   mark_destroyed (c);
3134   GNUNET_assert (GNUNET_NO == c->was_removed);
3135   c->was_removed = GNUNET_YES;
3136   GNUNET_break (GNUNET_YES ==
3137                 GNUNET_CONTAINER_multihashmap_remove (connections,
3138                                                       GCC_get_h (c),
3139                                                       c));
3140   /* Cancel queue in the direction that just died. */
3141   connection_cancel_queues (c, ! fwd);
3142   GCC_stop_poll (c, ! fwd);
3143   unregister_neighbors (c);
3144   GCC_check_connections ();
3145 }
3146
3147
3148 /**
3149  * Is this peer the first one on the connection?
3150  *
3151  * @param c Connection.
3152  * @param fwd Is this about fwd traffic?
3153  *
3154  * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
3155  */
3156 int
3157 GCC_is_origin (struct CadetConnection *c, int fwd)
3158 {
3159   if (!fwd && c->path->length - 1 == c->own_pos )
3160     return GNUNET_YES;
3161   if (fwd && 0 == c->own_pos)
3162     return GNUNET_YES;
3163   return GNUNET_NO;
3164 }
3165
3166
3167 /**
3168  * Is this peer the last one on the connection?
3169  *
3170  * @param c Connection.
3171  * @param fwd Is this about fwd traffic?
3172  *            Note that the ROOT is the terminal for BCK traffic!
3173  *
3174  * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
3175  */
3176 int
3177 GCC_is_terminal (struct CadetConnection *c, int fwd)
3178 {
3179   return GCC_is_origin (c, ! fwd);
3180 }
3181
3182
3183 /**
3184  * See if we are allowed to send by the next hop in the given direction.
3185  *
3186  * @param c Connection.
3187  * @param fwd Is this about fwd traffic?
3188  *
3189  * @return #GNUNET_YES in case it's OK to send.
3190  */
3191 int
3192 GCC_is_sendable (struct CadetConnection *c, int fwd)
3193 {
3194   struct CadetFlowControl *fc;
3195
3196   LOG (GNUNET_ERROR_TYPE_DEBUG,
3197        " checking sendability of %s traffic on %s\n",
3198        GC_f2s (fwd), GCC_2s (c));
3199   if (NULL == c)
3200   {
3201     GNUNET_break (0);
3202     return GNUNET_YES;
3203   }
3204   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3205   LOG (GNUNET_ERROR_TYPE_DEBUG,
3206        " last ack recv: %u, last pid sent: %u\n",
3207        fc->last_ack_recv, fc->last_pid_sent);
3208   if (GC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
3209   {
3210     LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable\n");
3211     return GNUNET_YES;
3212   }
3213   LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
3214   return GNUNET_NO;
3215 }
3216
3217
3218 /**
3219  * Check if this connection is a direct one (never trim a direct connection).
3220  *
3221  * @param c Connection.
3222  *
3223  * @return #GNUNET_YES in case it's a direct connection, #GNUNET_NO otherwise.
3224  */
3225 int
3226 GCC_is_direct (struct CadetConnection *c)
3227 {
3228   return (c->path->length == 2) ? GNUNET_YES : GNUNET_NO;
3229 }
3230
3231
3232 /**
3233  * Sends an already built message on a connection, properly registering
3234  * all used resources.
3235  *
3236  * @param message Message to send. Function makes a copy of it.
3237  *                If message is not hop-by-hop, decrements TTL of copy.
3238  * @param payload_type Type of payload, in case the message is encrypted.
3239  * @param payload_id ID of the payload (PID, ACK, ...).
3240  * @param c Connection on which this message is transmitted.
3241  * @param fwd Is this a fwd message?
3242  * @param force Force the connection to accept the message (buffer overfill).
3243  * @param cont Continuation called once message is sent. Can be NULL.
3244  * @param cont_cls Closure for @c cont.
3245  *
3246  * @return Handle to cancel the message before it's sent.
3247  *         NULL on error or if @c cont is NULL.
3248  *         Invalid on @c cont call.
3249  */
3250 struct CadetConnectionQueue *
3251 GCC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
3252                            uint16_t payload_type, uint32_t payload_id,
3253                            struct CadetConnection *c, int fwd, int force,
3254                            GCC_sent cont, void *cont_cls)
3255 {
3256   struct GNUNET_CADET_AX        *axmsg;
3257   struct GNUNET_CADET_KX        *kmsg;
3258   struct GNUNET_CADET_ACK       *amsg;
3259   struct GNUNET_CADET_Poll      *pmsg;
3260   struct GNUNET_CADET_ConnectionDestroy *dmsg;
3261   struct GNUNET_CADET_ConnectionBroken  *bmsg;
3262   struct CadetFlowControl *fc;
3263   struct CadetConnectionQueue *q;
3264   struct GNUNET_MessageHeader *copy;
3265   size_t size;
3266   uint16_t type;
3267   int droppable;
3268
3269   GCC_check_connections ();
3270   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3271   if (0 == fc->queue_max)
3272   {
3273     GNUNET_break (0);
3274     return NULL;
3275   }
3276
3277   size = ntohs (message->size);
3278   copy = GNUNET_malloc (size);
3279   GNUNET_memcpy (copy, message, size);
3280   type = ntohs (message->type);
3281   LOG (GNUNET_ERROR_TYPE_INFO,
3282        "--> %s (%s %4u) on conn %s (%p) %s [%5u]\n",
3283        GC_m2s (type), GC_m2s (payload_type), payload_id, GCC_2s (c), c,
3284        GC_f2s(fwd), size);
3285   droppable = (GNUNET_NO == force);
3286   switch (type)
3287   {
3288     case GNUNET_MESSAGE_TYPE_CADET_AX:
3289       axmsg = (struct GNUNET_CADET_AX *) copy;
3290       axmsg->cid = c->id;
3291       axmsg->pid = htonl (GCC_get_pid (c, fwd));
3292       LOG (GNUNET_ERROR_TYPE_DEBUG, "  Q_N+ %p %u\n", fc, fc->queue_n);
3293       LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
3294       LOG (GNUNET_ERROR_TYPE_DEBUG, "     ack recv %u\n", fc->last_ack_recv);
3295       if (GNUNET_YES == droppable)
3296       {
3297         fc->queue_n++;
3298       }
3299       else
3300       {
3301         LOG (GNUNET_ERROR_TYPE_DEBUG, "  not droppable, Q_N stays the same\n");
3302       }
3303       break;
3304
3305     case GNUNET_MESSAGE_TYPE_CADET_KX:
3306       kmsg = (struct GNUNET_CADET_KX *) copy;
3307       kmsg->reserved = htonl (0);
3308       kmsg->cid = c->id;
3309       break;
3310
3311     case GNUNET_MESSAGE_TYPE_CADET_ACK:
3312       amsg = (struct GNUNET_CADET_ACK *) copy;
3313       amsg->cid = c->id;
3314       LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
3315       droppable = GNUNET_NO;
3316       break;
3317
3318     case GNUNET_MESSAGE_TYPE_CADET_POLL:
3319       pmsg = (struct GNUNET_CADET_Poll *) copy;
3320       pmsg->cid = c->id;
3321       LOG (GNUNET_ERROR_TYPE_DEBUG, " POLL %u\n", ntohl (pmsg->pid));
3322       droppable = GNUNET_NO;
3323       break;
3324
3325     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY:
3326       dmsg = (struct GNUNET_CADET_ConnectionDestroy *) copy;
3327       dmsg->reserved = htonl (0);
3328       dmsg->cid = c->id;
3329       break;
3330
3331     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN:
3332       bmsg = (struct GNUNET_CADET_ConnectionBroken *) copy;
3333       bmsg->reserved = htonl (0);
3334       bmsg->cid = c->id;
3335       break;
3336
3337     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE:
3338     case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK:
3339       GNUNET_break (0); /* Should've used specific functions. */
3340       break;
3341
3342     default:
3343       GNUNET_break (0);
3344       GNUNET_free (copy);
3345       return NULL;
3346   }
3347
3348   if (fc->queue_n > fc->queue_max && droppable)
3349   {
3350     GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
3351                               1, GNUNET_NO);
3352     GNUNET_break (0);
3353     LOG (GNUNET_ERROR_TYPE_DEBUG, "queue full: %u/%u\n",
3354          fc->queue_n, fc->queue_max);
3355     if (GNUNET_MESSAGE_TYPE_CADET_AX == type)
3356     {
3357       fc->queue_n--;
3358     }
3359     GNUNET_free (copy);
3360     return NULL; /* Drop this message */
3361   }
3362
3363   LOG (GNUNET_ERROR_TYPE_DEBUG, "  C_P+ %s %u\n",
3364        GCC_2s (c), c->pending_messages);
3365   c->pending_messages++;
3366
3367   q = GNUNET_new (struct CadetConnectionQueue);
3368   q->forced = !droppable;
3369   q->peer_q = GCP_send (get_hop (c, fwd), copy,
3370                         payload_type, payload_id,
3371                         c, fwd,
3372                         &conn_message_sent, q);
3373   if (NULL == q->peer_q)
3374   {
3375     LOG (GNUNET_ERROR_TYPE_DEBUG, "dropping msg on %s, NULL q\n", GCC_2s (c));
3376     GNUNET_free (copy);
3377     GNUNET_free (q);
3378     GCC_check_connections ();
3379     return NULL;
3380   }
3381   q->cont = cont;
3382   q->cont_cls = cont_cls;
3383   GNUNET_CONTAINER_DLL_insert (fc->q_head, fc->q_tail, q);
3384   GCC_check_connections ();
3385   return (NULL == cont) ? NULL : q;
3386 }
3387
3388
3389 /**
3390  * Cancel a previously sent message while it's in the queue.
3391  *
3392  * ONLY can be called before the continuation given to the send function
3393  * is called. Once the continuation is called, the message is no longer in the
3394  * queue.
3395  *
3396  * @param q Handle to the queue.
3397  */
3398 void
3399 GCC_cancel (struct CadetConnectionQueue *q)
3400 {
3401   LOG (GNUNET_ERROR_TYPE_DEBUG, "!  GCC cancel message\n");
3402
3403   /* send_cancel calls message_sent, which calls q->cont and frees q */
3404   GCP_send_cancel (q->peer_q);
3405   GCC_check_connections ();
3406 }
3407
3408
3409 /**
3410  * Sends a CREATE CONNECTION message for a path to a peer.
3411  * Changes the connection and tunnel states if necessary.
3412  *
3413  * @param c Connection to create.
3414  */
3415 void
3416 GCC_send_create (struct CadetConnection *c)
3417 {
3418   enum CadetTunnelCState state;
3419   size_t size;
3420
3421   GCC_check_connections ();
3422   size = sizeof (struct GNUNET_CADET_ConnectionCreate);
3423   size += c->path->length * sizeof (struct GNUNET_PeerIdentity);
3424   {
3425     /* Allocate message on the stack */
3426     unsigned char cbuf[size];
3427     struct GNUNET_CADET_ConnectionCreate *msg;
3428     struct GNUNET_PeerIdentity *peers;
3429
3430     msg = (struct GNUNET_CADET_ConnectionCreate *) cbuf;
3431     msg->header.size = htons (size);
3432     msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE);
3433     msg->reserved = htonl (0);
3434     msg->cid = *GCC_get_id (c);
3435     peers = (struct GNUNET_PeerIdentity *) &msg[1];
3436     for (int i = 0; i < c->path->length; i++)
3437     {
3438       GNUNET_PEER_resolve (c->path->peers[i], peers++);
3439     }
3440     GNUNET_assert (NULL == c->maintenance_q);
3441     c->maintenance_q = GCP_send (get_next_hop (c),
3442                                  &msg->header,
3443                                  GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE, 0,
3444                                  c, GNUNET_YES,
3445                                  &conn_message_sent, NULL);
3446   }
3447
3448   LOG (GNUNET_ERROR_TYPE_INFO, "==> %s %19s on conn %s (%p) FWD [%5u]\n",
3449        GC_m2s (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE), "",
3450        GCC_2s (c), c, size);
3451   LOG (GNUNET_ERROR_TYPE_DEBUG, "  C_P+ %p %u (create)\n",
3452          c, c->pending_messages);
3453   c->pending_messages++;
3454
3455   state = GCT_get_cstate (c->t);
3456   if (CADET_TUNNEL_SEARCHING == state || CADET_TUNNEL_NEW == state)
3457     GCT_change_cstate (c->t, CADET_TUNNEL_WAITING);
3458   if (CADET_CONNECTION_NEW == c->state)
3459     connection_change_state (c, CADET_CONNECTION_SENT);
3460   GCC_check_connections ();
3461 }
3462
3463
3464 /**
3465  * Send an ACK on the appropriate connection/channel, depending on
3466  * the direction and the position of the peer.
3467  *
3468  * @param c Which connection to send the hop-by-hop ACK.
3469  * @param fwd Is this a fwd ACK? (will go dest->root).
3470  * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
3471  */
3472 void
3473 GCC_send_ack (struct CadetConnection *c, int fwd, int force)
3474 {
3475   unsigned int buffer;
3476
3477   GCC_check_connections ();
3478   LOG (GNUNET_ERROR_TYPE_DEBUG, "GCC send %s ACK on %s\n",
3479        GC_f2s (fwd), GCC_2s (c));
3480
3481   if (NULL == c)
3482   {
3483     GNUNET_break (0);
3484     return;
3485   }
3486
3487   if (GNUNET_NO != c->destroy)
3488   {
3489     LOG (GNUNET_ERROR_TYPE_DEBUG, "  being destroyed, why bother...\n");
3490     GCC_check_connections ();
3491     return;
3492   }
3493
3494   /* Get available buffer space */
3495   if (GCC_is_terminal (c, fwd))
3496   {
3497     LOG (GNUNET_ERROR_TYPE_DEBUG, "  getting from all channels\n");
3498     buffer = GCT_get_channels_buffer (c->t);
3499   }
3500   else
3501   {
3502     LOG (GNUNET_ERROR_TYPE_DEBUG, "  getting from one connection\n");
3503     buffer = GCC_get_buffer (c, fwd);
3504   }
3505   LOG (GNUNET_ERROR_TYPE_DEBUG, "  buffer available: %u\n", buffer);
3506   if (0 == buffer && GNUNET_NO == force)
3507   {
3508     GCC_check_connections ();
3509     return;
3510   }
3511
3512   /* Send available buffer space */
3513   if (GNUNET_YES == GCC_is_origin (c, fwd))
3514   {
3515     GNUNET_assert (NULL != c->t);
3516     LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on channels...\n");
3517     GCT_unchoke_channels (c->t);
3518   }
3519   else
3520   {
3521     LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on connection\n");
3522     send_ack (c, buffer, fwd, force);
3523   }
3524   GCC_check_connections ();
3525 }
3526
3527
3528 /**
3529  * Send a message to all peers in this connection that the connection
3530  * is no longer valid.
3531  *
3532  * If some peer should not receive the message, it should be zero'ed out
3533  * before calling this function.
3534  *
3535  * @param c The connection whose peers to notify.
3536  */
3537 void
3538 GCC_send_destroy (struct CadetConnection *c)
3539 {
3540   struct GNUNET_CADET_ConnectionDestroy msg;
3541
3542   if (GNUNET_YES == c->destroy)
3543     return;
3544   GCC_check_connections ();
3545   msg.header.size = htons (sizeof (msg));
3546   msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY);
3547   msg.cid = c->id;
3548   LOG (GNUNET_ERROR_TYPE_DEBUG,
3549               "  sending connection destroy for connection %s\n",
3550               GCC_2s (c));
3551
3552   if (GNUNET_NO == GCC_is_terminal (c, GNUNET_YES))
3553     GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg.header, UINT16_MAX,
3554                                                       0, c, GNUNET_YES,
3555                                                       GNUNET_YES, NULL, NULL));
3556   if (GNUNET_NO == GCC_is_terminal (c, GNUNET_NO))
3557     GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg.header, UINT16_MAX,
3558                                                       0, c, GNUNET_NO,
3559                                                       GNUNET_YES, NULL, NULL));
3560   mark_destroyed (c);
3561   GCC_check_connections ();
3562 }
3563
3564
3565 /**
3566  * @brief Start a polling timer for the connection.
3567  *
3568  * When a neighbor does not accept more traffic on the connection it could be
3569  * caused by a simple congestion or by a lost ACK. Polling enables to check
3570  * for the lastest ACK status for a connection.
3571  *
3572  * @param c Connection.
3573  * @param fwd Should we poll in the FWD direction?
3574  */
3575 void
3576 GCC_start_poll (struct CadetConnection *c, int fwd)
3577 {
3578   struct CadetFlowControl *fc;
3579
3580   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3581   LOG (GNUNET_ERROR_TYPE_DEBUG, "POLL %s requested\n",
3582        GC_f2s (fwd));
3583   if (NULL != fc->poll_task || NULL != fc->poll_msg)
3584   {
3585     LOG (GNUNET_ERROR_TYPE_DEBUG, "  POLL already in progress (t: %p, m: %p)\n",
3586          fc->poll_task, fc->poll_msg);
3587     return;
3588   }
3589   if (0 == fc->queue_max)
3590   {
3591     /* Should not be needed, traffic should've been cancelled. */
3592     GNUNET_break (0);
3593     LOG (GNUNET_ERROR_TYPE_DEBUG, "  POLL not possible, peer disconnected\n");
3594     return;
3595   }
3596   LOG (GNUNET_ERROR_TYPE_DEBUG, "POLL started on request\n");
3597   fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
3598                                                 &connection_poll,
3599                                                 fc);
3600 }
3601
3602
3603 /**
3604  * @brief Stop polling a connection for ACKs.
3605  *
3606  * Once we have enough ACKs for future traffic, polls are no longer necessary.
3607  *
3608  * @param c Connection.
3609  * @param fwd Should we stop the poll in the FWD direction?
3610  */
3611 void
3612 GCC_stop_poll (struct CadetConnection *c, int fwd)
3613 {
3614   struct CadetFlowControl *fc;
3615
3616   fc = fwd ? &c->fwd_fc : &c->bck_fc;
3617   if (NULL != fc->poll_task)
3618   {
3619     GNUNET_SCHEDULER_cancel (fc->poll_task);
3620     fc->poll_task = NULL;
3621   }
3622   if (NULL != fc->poll_msg)
3623   {
3624     GCC_cancel (fc->poll_msg);
3625     fc->poll_msg = NULL;
3626   }
3627 }
3628
3629
3630 /**
3631  * Get a (static) string for a connection.
3632  *
3633  * @param c Connection.
3634  */
3635 const char *
3636 GCC_2s (const struct CadetConnection *c)
3637 {
3638   if (NULL == c)
3639     return "NULL";
3640
3641   if (NULL != c->t)
3642   {
3643     static char buf[128];
3644
3645     SPRINTF (buf, "%s (->%s)",
3646              GNUNET_h2s (GC_h2hc (GCC_get_id (c))), GCT_2s (c->t));
3647     return buf;
3648   }
3649   return GNUNET_h2s (GC_h2hc (&c->id));
3650 }
3651
3652
3653 /**
3654  * Log all possible info about the connection state.
3655  *
3656  * @param c Connection to debug.
3657  * @param level Debug level to use.
3658  */
3659 void
3660 GCC_debug (const struct CadetConnection *c, enum GNUNET_ErrorType level)
3661 {
3662   int do_log;
3663   char *s;
3664
3665   do_log = GNUNET_get_log_call_status (level & (~GNUNET_ERROR_TYPE_BULK),
3666                                        "cadet-con",
3667                                        __FILE__, __FUNCTION__, __LINE__);
3668   if (0 == do_log)
3669     return;
3670
3671   if (NULL == c)
3672   {
3673     LOG2 (level, "CCC DEBUG NULL CONNECTION\n");
3674     return;
3675   }
3676
3677   LOG2 (level, "CCC DEBUG CONNECTION %s\n", GCC_2s (c));
3678   s = path_2s (c->path);
3679   LOG2 (level, "CCC  path %s, own pos: %u\n", s, c->own_pos);
3680   GNUNET_free (s);
3681   LOG2 (level, "CCC  state: %s, destroy: %u\n",
3682         GCC_state2s (c->state), c->destroy);
3683   LOG2 (level, "CCC  pending messages: %u\n", c->pending_messages);
3684   if (NULL != c->perf)
3685     LOG2 (level, "CCC  us/byte: %f\n", c->perf->avg);
3686
3687   LOG2 (level, "CCC  FWD flow control:\n");
3688   LOG2 (level, "CCC   queue: %u/%u\n", c->fwd_fc.queue_n, c->fwd_fc.queue_max);
3689   LOG2 (level, "CCC   last PID sent: %5u, recv: %5u\n",
3690         c->fwd_fc.last_pid_sent, c->fwd_fc.last_pid_recv);
3691   LOG2 (level, "CCC   last ACK sent: %5u, recv: %5u\n",
3692         c->fwd_fc.last_ack_sent, c->fwd_fc.last_ack_recv);
3693   LOG2 (level, "CCC   recv PID bitmap: %X\n", c->fwd_fc.recv_bitmap);
3694   LOG2 (level, "CCC   poll: task %d, msg  %p, msg_ack %p)\n",
3695         c->fwd_fc.poll_task, c->fwd_fc.poll_msg, c->fwd_fc.ack_msg);
3696
3697   LOG2 (level, "CCC  BCK flow control:\n");
3698   LOG2 (level, "CCC   queue: %u/%u\n", c->bck_fc.queue_n, c->bck_fc.queue_max);
3699   LOG2 (level, "CCC   last PID sent: %5u, recv: %5u\n",
3700         c->bck_fc.last_pid_sent, c->bck_fc.last_pid_recv);
3701   LOG2 (level, "CCC   last ACK sent: %5u, recv: %5u\n",
3702         c->bck_fc.last_ack_sent, c->bck_fc.last_ack_recv);
3703   LOG2 (level, "CCC   recv PID bitmap: %X\n", c->bck_fc.recv_bitmap);
3704   LOG2 (level, "CCC   poll: task %d, msg  %p, msg_ack %p)\n",
3705         c->bck_fc.poll_task, c->bck_fc.poll_msg, c->bck_fc.ack_msg);
3706
3707   LOG2 (level, "CCC DEBUG CONNECTION END\n");
3708 }