src/mesh/gnunet-service-mesh_connection.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file mesh/gnunet-service-mesh_connection.c
  23  * @brief GNUnet MESH service connection handling
  24  * @author Bartlomiej Polot
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29
  30 #include "gnunet_statistics_service.h"
  31
  32 #include "mesh_path.h"
  33 #include "mesh_protocol.h"
  34 #include "mesh.h"
  35 #include "gnunet-service-mesh_connection.h"
  36 #include "gnunet-service-mesh_peer.h"
  37 #include "gnunet-service-mesh_tunnel.h"
  38
  39
  40 #define LOG(level, ...) GNUNET_log_from (level,"mesh-con",__VA_ARGS__)
  41
  42 #define MESH_MAX_POLL_TIME      GNUNET_TIME_relative_multiply (\
  43                                   GNUNET_TIME_UNIT_MINUTES,\
  44                                   10)
  45 #define AVG_MSGS                32
  46
  47
  48 /******************************************************************************/
  49 /********************************   STRUCTS  **********************************/
  50 /******************************************************************************/
  51
  52 /**
  53  * Struct to encapsulate all the Flow Control information to a peer to which
  54  * we are directly connected (on a core level).
  55  */
  56 struct MeshFlowControl
  57 {
  58   /**
  59    * Connection this controls.
  60    */
  61   struct MeshConnection *c;
  62
  63   /**
  64    * How many messages are in the queue on this connection.
  65    */
  66   unsigned int queue_n;
  67
  68   /**
  69    * How many messages do we accept in the queue.
  70    */
  71   unsigned int queue_max;
  72
  73   /**
  74    * Next ID to use.
  75    */
  76   uint32_t next_pid;
  77
  78   /**
  79    * ID of the last packet sent towards the peer.
  80    */
  81   uint32_t last_pid_sent;
  82
  83   /**
  84    * ID of the last packet received from the peer.
  85    */
  86   uint32_t last_pid_recv;
  87
  88   /**
  89    * Last ACK sent to the peer (peer can't send more than this PID).
  90    */
  91   uint32_t last_ack_sent;
  92
  93   /**
  94    * Last ACK sent towards the origin (for traffic towards leaf node).
  95    */
  96   uint32_t last_ack_recv;
  97
  98   /**
  99    * Task to poll the peer in case of a lost ACK causes stall.
 100    */
 101   GNUNET_SCHEDULER_TaskIdentifier poll_task;
 102
 103   /**
 104    * How frequently to poll for ACKs.
 105    */
 106   struct GNUNET_TIME_Relative poll_time;
 107
 108   /**
 109    * Queued poll message, to cancel if not necessary anymore (got ACK).
 110    */
 111   struct MeshConnectionQueue *poll_msg;
 112
 113   /**
 114    * Queued poll message, to cancel if not necessary anymore (got ACK).
 115    */
 116   struct MeshConnectionQueue *ack_msg;
 117 };
 118
 119 /**
 120  * Keep a record of the last messages sent on this connection.
 121  */
 122 struct MeshConnectionPerformance
 123 {
 124   /**
 125    * Circular buffer for storing measurements.
 126    */
 127   double usecsperbyte[AVG_MSGS];
 128
 129   /**
 130    * Running average of @c usecsperbyte.
 131    */
 132   double avg;
 133
 134   /**
 135    * How many values of @c usecsperbyte are valid.
 136    */
 137   uint16_t size;
 138
 139   /**
 140    * Index of the next "free" position in @c usecsperbyte.
 141    */
 142   uint16_t idx;
 143 };
 144
 145
 146 /**
 147  * Struct containing all information regarding a connection to a peer.
 148  */
 149 struct MeshConnection
 150 {
 151   /**
 152    * Tunnel this connection is part of.
 153    */
 154   struct MeshTunnel3 *t;
 155
 156   /**
 157    * Flow control information for traffic fwd.
 158    */
 159   struct MeshFlowControl fwd_fc;
 160
 161   /**
 162    * Flow control information for traffic bck.
 163    */
 164   struct MeshFlowControl bck_fc;
 165
 166   /**
 167    * Measure connection performance on the endpoint.
 168    */
 169   struct MeshConnectionPerformance *perf;
 170
 171   /**
 172    * ID of the connection.
 173    */
 174   struct GNUNET_HashCode id;
 175
 176   /**
 177    * State of the connection.
 178    */
 179   enum MeshConnectionState state;
 180
 181   /**
 182    * Path being used for the tunnel.
 183    */
 184   struct MeshPeerPath *path;
 185
 186   /**
 187    * Position of the local peer in the path.
 188    */
 189   unsigned int own_pos;
 190
 191   /**
 192    * Task to keep the used paths alive at the owner,
 193    * time tunnel out on all the other peers.
 194    */
 195   GNUNET_SCHEDULER_TaskIdentifier fwd_maintenance_task;
 196
 197   /**
 198    * Task to keep the used paths alive at the destination,
 199    * time tunnel out on all the other peers.
 200    */
 201   GNUNET_SCHEDULER_TaskIdentifier bck_maintenance_task;
 202
 203   /**
 204    * Pending message count.
 205    */
 206   int pending_messages;
 207
 208   /**
 209    * Destroy flag: if true, destroy on last message.
 210    */
 211   int destroy;
 212 };
 213
 214 /**
 215  * Handle for messages queued but not yet sent.
 216  */
 217 struct MeshConnectionQueue
 218 {
 219   struct MeshPeerQueue *q;
 220   GMC_sent cont;
 221   void *cont_cls;
 222 };
 223
 224 /******************************************************************************/
 225 /*******************************   GLOBALS  ***********************************/
 226 /******************************************************************************/
 227
 228 /**
 229  * Global handle to the statistics service.
 230  */
 231 extern struct GNUNET_STATISTICS_Handle *stats;
 232
 233 /**
 234  * Local peer own ID (memory efficient handle).
 235  */
 236 extern GNUNET_PEER_Id myid;
 237
 238 /**
 239  * Local peer own ID (full value).
 240  */
 241 extern struct GNUNET_PeerIdentity my_full_id;
 242
 243 /**
 244  * Connections known, indexed by cid (MeshConnection).
 245  */
 246 static struct GNUNET_CONTAINER_MultiHashMap *connections;
 247
 248 /**
 249  * How many connections are we willing to maintain.
 250  * Local connections are always allowed, even if there are more connections than max.
 251  */
 252 static unsigned long long max_connections;
 253
 254 /**
 255  * How many messages *in total* are we willing to queue, divide by number of
 256  * connections to get connection queue size.
 257  */
 258 static unsigned long long max_msgs_queue;
 259
 260 /**
 261  * How often to send path keepalives. Paths timeout after 4 missed.
 262  */
 263 static struct GNUNET_TIME_Relative refresh_connection_time;
 264
 265 /**
 266  * How often to send path create / ACKs.
 267  */
 268 static struct GNUNET_TIME_Relative create_connection_time;
 269
 270
 271 /******************************************************************************/
 272 /********************************   STATIC  ***********************************/
 273 /******************************************************************************/
 274
 275 #if 0 // avoid compiler warning for unused static function
 276 static void
 277 fc_debug (struct MeshFlowControl *fc)
 278 {
 279   LOG (GNUNET_ERROR_TYPE_DEBUG, "    IN: %u/%u\n",
 280               fc->last_pid_recv, fc->last_ack_sent);
 281   LOG (GNUNET_ERROR_TYPE_DEBUG, "    OUT: %u/%u\n",
 282               fc->last_pid_sent, fc->last_ack_recv);
 283   LOG (GNUNET_ERROR_TYPE_DEBUG, "    QUEUE: %u/%u\n",
 284               fc->queue_n, fc->queue_max);
 285 }
 286
 287 static void
 288 connection_debug (struct MeshConnection *c)
 289 {
 290   if (NULL == c)
 291   {
 292     LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CONNECTION ***\n");
 293     return;
 294   }
 295   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s:%X\n",
 296               peer2s (c->t->peer), GMC_2s (c));
 297   LOG (GNUNET_ERROR_TYPE_DEBUG, "  state: %u, pending msgs: %u\n",
 298               c->state, c->pending_messages);
 299   LOG (GNUNET_ERROR_TYPE_DEBUG, "  FWD FC\n");
 300   fc_debug (&c->fwd_fc);
 301   LOG (GNUNET_ERROR_TYPE_DEBUG, "  BCK FC\n");
 302   fc_debug (&c->bck_fc);
 303 }
 304 #endif
 305
 306 /**
 307  * Get string description for tunnel state.
 308  *
 309  * @param s Tunnel state.
 310  *
 311  * @return String representation.
 312  */
 313 static const char *
 314 GMC_state2s (enum MeshConnectionState s)
 315 {
 316   switch (s)
 317   {
 318     case MESH_CONNECTION_NEW:
 319       return "MESH_CONNECTION_NEW";
 320     case MESH_CONNECTION_SENT:
 321       return "MESH_CONNECTION_SENT";
 322     case MESH_CONNECTION_ACK:
 323       return "MESH_CONNECTION_ACK";
 324     case MESH_CONNECTION_READY:
 325       return "MESH_CONNECTION_READY";
 326     default:
 327       return "MESH_CONNECTION_STATE_ERROR";
 328   }
 329 }
 330
 331
 332 /**
 333  * Initialize a Flow Control structure to the initial state.
 334  *
 335  * @param fc Flow Control structure to initialize.
 336  */
 337 static void
 338 fc_init (struct MeshFlowControl *fc)
 339 {
 340   fc->next_pid = 0;
 341   fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
 342   fc->last_pid_recv = (uint32_t) -1;
 343   fc->last_ack_sent = (uint32_t) 0;
 344   fc->last_ack_recv = (uint32_t) 0;
 345   fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
 346   fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
 347   fc->queue_n = 0;
 348   fc->queue_max = (max_msgs_queue / max_connections) + 1;
 349 }
 350
 351
 352 /**
 353  * Find a connection.
 354  *
 355  * @param cid Connection ID.
 356  */
 357 static struct MeshConnection *
 358 connection_get (const struct GNUNET_HashCode *cid)
 359 {
 360   return GNUNET_CONTAINER_multihashmap_get (connections, cid);
 361 }
 362
 363
 364 static void
 365 connection_change_state (struct MeshConnection* c,
 366                          enum MeshConnectionState state)
 367 {
 368   LOG (GNUNET_ERROR_TYPE_DEBUG,
 369               "Connection %s state was %s\n",
 370               GMC_2s (c), GMC_state2s (c->state));
 371   LOG (GNUNET_ERROR_TYPE_DEBUG,
 372               "Connection %s state is now %s\n",
 373               GMC_2s (c), GMC_state2s (state));
 374   c->state = state;
 375 }
 376
 377
 378 /**
 379  * Callback called when a queued ACK message is sent.
 380  *
 381  * @param cls Closure (FC).
 382  * @param c Connection this message was on.
 383  * @param q Queue handler this call invalidates.
 384  * @param type Type of message sent.
 385  * @param fwd Was this a FWD going message?
 386  * @param size Size of the message.
 387  */
 388 static void
 389 ack_sent (void *cls,
 390           struct MeshConnection *c,
 391           struct MeshConnectionQueue *q,
 392           uint16_t type, int fwd, size_t size)
 393 {
 394   struct MeshFlowControl *fc = cls;
 395
 396   fc->ack_msg = NULL;
 397 }
 398
 399
 400 /**
 401  * Send an ACK on the connection, informing the predecessor about
 402  * the available buffer space. Should not be called in case the peer
 403  * is origin (no predecessor) in the @c fwd direction.
 404  *
 405  * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
 406  * the ACK itself goes "back" (dest->root).
 407  *
 408  * @param c Connection on which to send the ACK.
 409  * @param buffer How much space free to advertise?
 410  * @param fwd Is this FWD ACK? (Going dest -> root)
 411  * @param force Don't optimize out.
 412  */
 413 static void
 414 send_ack (struct MeshConnection *c, unsigned int buffer, int fwd, int force)
 415 {
 416   struct MeshFlowControl *next_fc;
 417   struct MeshFlowControl *prev_fc;
 418   struct GNUNET_MESH_ACK msg;
 419   uint32_t ack;
 420   int delta;
 421
 422   /* If origin, there is no connection to send ACKs. Wrong function! */
 423   if (GMC_is_origin (c, fwd))
 424   {
 425     GNUNET_break (0);
 426     return;
 427   }
 428
 429   next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
 430   prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
 431
 432   LOG (GNUNET_ERROR_TYPE_DEBUG,
 433               "connection send %s ack on %s\n",
 434               fwd ? "FWD" : "BCK", GMC_2s (c));
 435
 436   /* Check if we need to transmit the ACK. */
 437   delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
 438   if (3 < delta && buffer < delta && GNUNET_NO == force)
 439   {
 440     LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
 441     LOG (GNUNET_ERROR_TYPE_DEBUG,
 442          "  last pid recv: %u, last ack sent: %u\n",
 443          prev_fc->last_pid_recv, prev_fc->last_ack_sent);
 444     return;
 445   }
 446
 447   /* Ok, ACK might be necessary, what PID to ACK? */
 448   ack = prev_fc->last_pid_recv + buffer;
 449   LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
 450   LOG (GNUNET_ERROR_TYPE_DEBUG,
 451        " last pid %u, last ack %u, qmax %u, q %u\n",
 452        prev_fc->last_pid_recv, prev_fc->last_ack_sent,
 453        next_fc->queue_max, next_fc->queue_n);
 454   if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
 455   {
 456     LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
 457     return;
 458   }
 459
 460   /* Check if message is already in queue */
 461   if (NULL != prev_fc->ack_msg)
 462   {
 463     if (GMC_is_pid_bigger (ack, prev_fc->last_ack_sent))
 464     {
 465       LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
 466       GMC_cancel (prev_fc->ack_msg);
 467       /* GMC_cancel triggers ack_sent(), which clears fc->ack_msg */
 468     }
 469     else
 470     {
 471       LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
 472       return;
 473     }
 474   }
 475
 476   prev_fc->last_ack_sent = ack;
 477
 478   /* Build ACK message and send on connection */
 479   msg.header.size = htons (sizeof (msg));
 480   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
 481   msg.ack = htonl (ack);
 482   msg.cid = c->id;
 483
 484   prev_fc->ack_msg = GMC_send_prebuilt_message (&msg.header, c, !fwd,
 485                                                 &ack_sent, prev_fc);
 486 }
 487
 488
 489 /**
 490  * Callback called when a queued message is sent.
 491  *
 492  * Calculates the average time and connection packet tracking.
 493  *
 494  * @param cls Closure (ConnectionQueue Handle).
 495  * @param c Connection this message was on.
 496  * @param type Type of message sent.
 497  * @param fwd Was this a FWD going message?
 498  * @param size Size of the message.
 499  * @param wait Time spent waiting for core (only the time for THIS message)
 500  */
 501 static void
 502 message_sent (void *cls,
 503               struct MeshConnection *c, uint16_t type,
 504               int fwd, size_t size,
 505               struct GNUNET_TIME_Relative wait)
 506 {
 507   struct MeshConnectionPerformance *p;
 508   struct MeshFlowControl *fc;
 509   struct MeshConnectionQueue *q = cls;
 510   double usecsperbyte;
 511
 512   fc = fwd ? &c->fwd_fc : &c->bck_fc;
 513   LOG (GNUNET_ERROR_TYPE_DEBUG,
 514        "!  sent %s %s\n",
 515        fwd ? "FWD" : "BCK",
 516        GNUNET_MESH_DEBUG_M2S (type));
 517   LOG (GNUNET_ERROR_TYPE_DEBUG, "!  C_P- %p %u\n", c, c->pending_messages);
 518   if (NULL != q)
 519   {
 520     if (NULL != q->cont)
 521     {
 522       LOG (GNUNET_ERROR_TYPE_DEBUG, "!  calling cont\n");
 523       q->cont (q->cont_cls, c, q, type, fwd, size);
 524     }
 525     GNUNET_free (q);
 526   }
 527   c->pending_messages--;
 528   if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
 529   {
 530     LOG (GNUNET_ERROR_TYPE_DEBUG, "!  destroying connection!\n");
 531     GMC_destroy (c);
 532     return;
 533   }
 534   /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
 535   switch (type)
 536   {
 537     case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
 538       fc->last_pid_sent++;
 539       LOG (GNUNET_ERROR_TYPE_DEBUG, "!  Q_N- %p %u\n", fc, fc->queue_n);
 540       fc->queue_n--;
 541       LOG (GNUNET_ERROR_TYPE_DEBUG,
 542            "!   accounting pid %u\n",
 543            fc->last_pid_sent);
 544       GMC_send_ack (c, fwd, GNUNET_NO);
 545       break;
 546
 547     case GNUNET_MESSAGE_TYPE_MESH_POLL:
 548       fc->poll_msg = NULL;
 549       break;
 550
 551     case GNUNET_MESSAGE_TYPE_MESH_ACK:
 552       fc->ack_msg = NULL;
 553       break;
 554
 555     default:
 556       break;
 557   }
 558   LOG (GNUNET_ERROR_TYPE_DEBUG, "!  message sent!\n");
 559
 560   if (NULL == c->perf)
 561     return; /* Only endpoints are interested in timing. */
 562
 563   p = c->perf;
 564   usecsperbyte = ((double) wait.rel_value_us) / size;
 565   if (p->size == AVG_MSGS)
 566   {
 567     /* Array is full. Substract oldest value, add new one and store. */
 568     p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
 569     p->usecsperbyte[p->idx] = usecsperbyte;
 570     p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
 571   }
 572   else
 573   {
 574     /* Array not yet full. Add current value to avg and store. */
 575     p->usecsperbyte[p->idx] = usecsperbyte;
 576     p->avg *= p->size;
 577     p->avg += p->usecsperbyte[p->idx];
 578     p->size++;
 579     p->avg /= p->size;
 580   }
 581   p->idx = (p->idx + 1) % AVG_MSGS;
 582 }
 583
 584
 585 /**
 586  * Get the previous hop in a connection
 587  *
 588  * @param c Connection.
 589  *
 590  * @return Previous peer in the connection.
 591  */
 592 static struct MeshPeer *
 593 get_prev_hop (const struct MeshConnection *c)
 594 {
 595   GNUNET_PEER_Id id;
 596
 597   LOG (GNUNET_ERROR_TYPE_DEBUG, "Get prev hop, own pos %u\n", c->own_pos);
 598   if (0 == c->own_pos || c->path->length < 2)
 599     id = c->path->peers[0];
 600   else
 601     id = c->path->peers[c->own_pos - 1];
 602
 603   return GMP_get_short (id);
 604 }
 605
 606
 607 /**
 608  * Get the next hop in a connection
 609  *
 610  * @param c Connection.
 611  *
 612  * @return Next peer in the connection.
 613  */
 614 static struct MeshPeer *
 615 get_next_hop (const struct MeshConnection *c)
 616 {
 617   GNUNET_PEER_Id id;
 618
 619   if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
 620     id = c->path->peers[c->path->length - 1];
 621   else
 622     id = c->path->peers[c->own_pos + 1];
 623
 624   return GMP_get_short (id);
 625 }
 626
 627
 628 /**
 629  * Get the hop in a connection.
 630  *
 631  * @param c Connection.
 632  * @param fwd Next hop?
 633  *
 634  * @return Next peer in the connection.
 635  */
 636 static struct MeshPeer *
 637 get_hop (struct MeshConnection *c, int fwd)
 638 {
 639   if (fwd)
 640     return get_next_hop (c);
 641   return get_prev_hop (c);
 642 }
 643
 644
 645 /**
 646  * Is traffic coming from this sender 'FWD' traffic?
 647  *
 648  * @param c Connection to check.
 649  * @param sender Peer identity of neighbor.
 650  *
 651  * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
 652  *         the traffic is 'FWD'.
 653  *         #GNUNET_NO for BCK.
 654  *         #GNUNET_SYSERR for errors.
 655  */
 656 static int
 657 is_fwd (const struct MeshConnection *c,
 658         const struct GNUNET_PeerIdentity *sender)
 659 {
 660   GNUNET_PEER_Id id;
 661
 662   id = GNUNET_PEER_search (sender);
 663   if (GMP_get_short_id (get_prev_hop (c)) == id)
 664     return GNUNET_YES;
 665
 666   if (GMP_get_short_id (get_next_hop (c)) == id)
 667     return GNUNET_NO;
 668
 669   GNUNET_break (0);
 670   return GNUNET_SYSERR;
 671 }
 672
 673
 674 /**
 675  * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
 676  * or a first CONNECTION_ACK directed to us.
 677  *
 678  * @param connection Connection to confirm.
 679  * @param fwd Should we send it FWD? (root->dest)
 680  *            (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
 681  */
 682 static void
 683 send_connection_ack (struct MeshConnection *connection, int fwd)
 684 {
 685   struct MeshTunnel3 *t;
 686
 687   t = connection->t;
 688   LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection %s ACK\n",
 689        !fwd ? "FWD" : "BCK");
 690   GMP_queue_add (get_hop (connection, fwd), NULL,
 691                  GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
 692                  sizeof (struct GNUNET_MESH_ConnectionACK),
 693                  connection, fwd, &message_sent, NULL);
 694   connection->pending_messages++;
 695   if (MESH_TUNNEL3_NEW == GMT_get_state (t))
 696     GMT_change_state (t, MESH_TUNNEL3_WAITING);
 697   if (MESH_CONNECTION_READY != connection->state)
 698     connection_change_state (connection, MESH_CONNECTION_SENT);
 699 }
 700
 701
 702 /**
 703  * Send a notification that a connection is broken.
 704  *
 705  * @param c Connection that is broken.
 706  * @param id1 Peer that has disconnected.
 707  * @param id2 Peer that has disconnected.
 708  * @param fwd Direction towards which to send it.
 709  */
 710 static void
 711 send_broken (struct MeshConnection *c,
 712              const struct GNUNET_PeerIdentity *id1,
 713              const struct GNUNET_PeerIdentity *id2,
 714              int fwd)
 715 {
 716   struct GNUNET_MESH_ConnectionBroken msg;
 717
 718   msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
 719   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
 720   msg.cid = c->id;
 721   msg.peer1 = *id1;
 722   msg.peer2 = *id2;
 723   GMC_send_prebuilt_message (&msg.header, c, fwd, NULL, NULL);
 724 }
 725
 726
 727
 728 /**
 729  * Send keepalive packets for a connection.
 730  *
 731  * @param c Connection to keep alive..
 732  * @param fwd Is this a FWD keepalive? (owner -> dest).
 733  */
 734 static void
 735 connection_keepalive (struct MeshConnection *c, int fwd)
 736 {
 737   struct GNUNET_MESH_ConnectionKeepAlive *msg;
 738   size_t size = sizeof (struct GNUNET_MESH_ConnectionKeepAlive);
 739   char cbuf[size];
 740   uint16_t type;
 741
 742   type = fwd ? GNUNET_MESSAGE_TYPE_MESH_FWD_KEEPALIVE :
 743                GNUNET_MESSAGE_TYPE_MESH_BCK_KEEPALIVE;
 744
 745   LOG (GNUNET_ERROR_TYPE_DEBUG,
 746        "sending %s keepalive for connection %s]\n",
 747        fwd ? "FWD" : "BCK", GMC_2s (c));
 748
 749   msg = (struct GNUNET_MESH_ConnectionKeepAlive *) cbuf;
 750   msg->header.size = htons (size);
 751   msg->header.type = htons (type);
 752   msg->cid = c->id;
 753
 754   GMC_send_prebuilt_message (&msg->header, c, fwd, NULL, NULL);
 755 }
 756
 757
 758 /**
 759  * Send CONNECTION_{CREATE/ACK} packets for a connection.
 760  *
 761  * @param c Connection for which to send the message.
 762  * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
 763  */
 764 static void
 765 connection_recreate (struct MeshConnection *c, int fwd)
 766 {
 767   LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
 768   if (fwd)
 769     GMC_send_create (c);
 770   else
 771     send_connection_ack (c, GNUNET_NO);
 772 }
 773
 774
 775 /**
 776  * Generic connection timer management.
 777  * Depending on the role of the peer in the connection will send the
 778  * appropriate message (build or keepalive)
 779  *
 780  * @param c Conncetion to maintain.
 781  * @param fwd Is FWD?
 782  */
 783 static void
 784 connection_maintain (struct MeshConnection *c, int fwd)
 785 {
 786   if (MESH_TUNNEL3_SEARCHING == GMT_get_state (c->t))
 787   {
 788     /* TODO DHT GET with RO_BART */
 789     return;
 790   }
 791   switch (c->state)
 792   {
 793     case MESH_CONNECTION_NEW:
 794       GNUNET_break (0);
 795     case MESH_CONNECTION_SENT:
 796       connection_recreate (c, fwd);
 797       break;
 798     case MESH_CONNECTION_READY:
 799       connection_keepalive (c, fwd);
 800       break;
 801     default:
 802       break;
 803   }
 804 }
 805
 806
 807 static void
 808 connection_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 809 {
 810   struct MeshConnection *c = cls;
 811   struct GNUNET_TIME_Relative delay;
 812
 813   c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
 814   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 815     return;
 816
 817   connection_maintain (c, GNUNET_YES);
 818   delay = c->state == MESH_CONNECTION_READY ?
 819           refresh_connection_time : create_connection_time;
 820   c->fwd_maintenance_task = GNUNET_SCHEDULER_add_delayed (delay,
 821                                                           &connection_fwd_keepalive,
 822                                                           c);
 823 }
 824
 825
 826 static void
 827 connection_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 828 {
 829   struct MeshConnection *c = cls;
 830   struct GNUNET_TIME_Relative delay;
 831
 832   c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
 833   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 834     return;
 835
 836   connection_maintain (c, GNUNET_NO);
 837   delay = c->state == MESH_CONNECTION_READY ?
 838           refresh_connection_time : create_connection_time;
 839   c->bck_maintenance_task = GNUNET_SCHEDULER_add_delayed (delay,
 840                                                           &connection_bck_keepalive,
 841                                                           c);
 842 }
 843
 844
 845 /**
 846  * @brief Re-initiate traffic on this connection if necessary.
 847  *
 848  * Check if there is traffic queued towards this peer
 849  * and the core transmit handle is NULL (traffic was stalled).
 850  * If so, call core tmt rdy.
 851  *
 852  * @param c Connection on which initiate traffic.
 853  * @param fwd Is this about fwd traffic?
 854  */
 855 static void
 856 connection_unlock_queue (struct MeshConnection *c, int fwd)
 857 {
 858   struct MeshPeer *peer;
 859
 860   LOG (GNUNET_ERROR_TYPE_DEBUG,
 861               "connection_unlock_queue %s on %s\n",
 862               fwd ? "FWD" : "BCK", GMC_2s (c));
 863
 864   if (GMC_is_terminal (c, fwd))
 865   {
 866     LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
 867     return;
 868   }
 869
 870   peer = get_hop (c, fwd);
 871   GMP_queue_unlock (peer, c);
 872 }
 873
 874
 875 /**
 876  * Cancel all transmissions that belong to a certain connection.
 877  *
 878  * If the connection is scheduled for destruction and no more messages are left,
 879  * the connection will be destroyed by the continuation call.
 880  *
 881  * @param c Connection which to cancel. Might be destroyed during this call.
 882  * @param fwd Cancel fwd traffic?
 883  */
 884 static void
 885 connection_cancel_queues (struct MeshConnection *c, int fwd)
 886 {
 887   struct MeshFlowControl *fc;
 888   struct MeshPeer *peer;
 889
 890   if (NULL == c)
 891   {
 892     GNUNET_break (0);
 893     return;
 894   }
 895
 896   fc = fwd ? &c->fwd_fc : &c->bck_fc;
 897   if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
 898   {
 899     GNUNET_SCHEDULER_cancel (fc->poll_task);
 900     fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
 901   }
 902   peer = get_hop (c, fwd);
 903   GMP_queue_cancel (peer, c);
 904 }
 905
 906
 907 /**
 908  * Function called if a connection has been stalled for a while,
 909  * possibly due to a missed ACK. Poll the neighbor about its ACK status.
 910  *
 911  * @param cls Closure (poll ctx).
 912  * @param tc TaskContext.
 913  */
 914 static void
 915 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 916
 917
 918 /**
 919  * Callback called when a queued POLL message is sent.
 920  *
 921  * @param cls Closure (FC).
 922  * @param c Connection this message was on.
 923  * @param q Queue handler this call invalidates.
 924  * @param type Type of message sent.
 925  * @param fwd Was this a FWD going message?
 926  * @param size Size of the message.
 927  */
 928 static void
 929 poll_sent (void *cls,
 930            struct MeshConnection *c,
 931            struct MeshConnectionQueue *q,
 932            uint16_t type, int fwd, size_t size)
 933 {
 934   struct MeshFlowControl *fc = cls;
 935
 936   LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL sent, scheduling new one!\n");
 937   fc->poll_msg = NULL;
 938   fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
 939   fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
 940                                                 &connection_poll, fc);
 941 }
 942
 943 /**
 944  * Function called if a connection has been stalled for a while,
 945  * possibly due to a missed ACK. Poll the neighbor about its ACK status.
 946  *
 947  * @param cls Closure (poll ctx).
 948  * @param tc TaskContext.
 949  */
 950 static void
 951 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 952 {
 953   struct MeshFlowControl *fc = cls;
 954   struct GNUNET_MESH_Poll msg;
 955   struct MeshConnection *c;
 956
 957   fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
 958   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 959   {
 960     return;
 961   }
 962
 963   c = fc->c;
 964   LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
 965   LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
 966   LOG (GNUNET_ERROR_TYPE_DEBUG, " ***   %s\n",
 967        fc == &c->fwd_fc ? "FWD" : "BCK");
 968
 969   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
 970   msg.header.size = htons (sizeof (msg));
 971   msg.pid = htonl (fc->last_pid_sent);
 972   LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
 973   fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c, fc == &c->fwd_fc,
 974                                             &poll_sent, fc);
 975 }
 976
 977
 978 /**
 979  * Timeout function due to lack of keepalive/traffic from the owner.
 980  * Destroys connection if called.
 981  *
 982  * @param cls Closure (connection to destroy).
 983  * @param tc TaskContext.
 984  */
 985 static void
 986 connection_fwd_timeout (void *cls,
 987                         const struct GNUNET_SCHEDULER_TaskContext *tc)
 988 {
 989   struct MeshConnection *c = cls;
 990
 991   c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
 992   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 993     return;
 994   LOG (GNUNET_ERROR_TYPE_DEBUG,
 995               "Connection %s[%X] FWD timed out. Destroying.\n",
 996               GMT_2s (c->t),
 997               c->id);
 998
 999   if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1000     return;
1001
1002   GMC_destroy (c);
1003 }
1004
1005
1006 /**
1007  * Timeout function due to lack of keepalive/traffic from the destination.
1008  * Destroys connection if called.
1009  *
1010  * @param cls Closure (connection to destroy).
1011  * @param tc TaskContext
1012  */
1013 static void
1014 connection_bck_timeout (void *cls,
1015                         const struct GNUNET_SCHEDULER_TaskContext *tc)
1016 {
1017   struct MeshConnection *c = cls;
1018
1019   c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1020   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1021     return;
1022
1023   LOG (GNUNET_ERROR_TYPE_DEBUG,
1024               "Connection %s[%X] FWD timed out. Destroying.\n",
1025               GMT_2s (c->t), c->id);
1026
1027   if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1028     return;
1029
1030   GMC_destroy (c);
1031 }
1032
1033
1034 /**
1035  * Resets the connection timeout task, some other message has done the
1036  * task's job.
1037  * - For the first peer on the direction this means to send
1038  *   a keepalive or a path confirmation message (either create or ACK).
1039  * - For all other peers, this means to destroy the connection,
1040  *   due to lack of activity.
1041  * Starts the tiemout if no timeout was running (connection just created).
1042  *
1043  * @param c Connection whose timeout to reset.
1044  * @param fwd Is this forward?
1045  *
1046  * TODO use heap to improve efficiency of scheduler.
1047  */
1048 static void
1049 connection_reset_timeout (struct MeshConnection *c, int fwd)
1050 {
1051   GNUNET_SCHEDULER_TaskIdentifier *ti;
1052   GNUNET_SCHEDULER_Task f;
1053
1054   ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1055
1056   if (GNUNET_SCHEDULER_NO_TASK != *ti)
1057     GNUNET_SCHEDULER_cancel (*ti);
1058
1059   if (GMC_is_origin (c, fwd)) /* Startpoint */
1060   {
1061     f  = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
1062     *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
1063   }
1064   else /* Relay, endpoint. */
1065   {
1066     struct GNUNET_TIME_Relative delay;
1067
1068     delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1069     f  = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1070     *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1071   }
1072 }
1073
1074
1075 /**
1076  * Add the connection to the list of both neighbors.
1077  *
1078  * @param c Connection.
1079  */
1080 static void
1081 register_neighbors (struct MeshConnection *c)
1082 {
1083   struct MeshPeer *peer;
1084
1085   peer = get_next_hop (c);
1086   if (GNUNET_NO == GMP_is_neighbor (peer))
1087   {
1088     GMC_destroy (c);
1089     return;
1090   }
1091   GMP_add_connection (peer, c);
1092   peer = get_prev_hop (c);
1093   if (GNUNET_NO == GMP_is_neighbor (peer))
1094   {
1095     GMC_destroy (c);
1096     return;
1097   }
1098   GMP_add_connection (peer, c);
1099 }
1100
1101
1102 /**
1103  * Remove the connection from the list of both neighbors.
1104  *
1105  * @param c Connection.
1106  */
1107 static void
1108 unregister_neighbors (struct MeshConnection *c)
1109 {
1110   struct MeshPeer *peer;
1111
1112   peer = get_next_hop (c);
1113   GMP_remove_connection (peer, c);
1114
1115   peer = get_prev_hop (c);
1116   GMP_remove_connection (peer, c);
1117
1118 }
1119
1120
1121 /**
1122  * Bind the connection to the peer and the tunnel to that peer.
1123  *
1124  * If the peer has no tunnel, create one. Update tunnel and connection
1125  * data structres to reflect new status.
1126  *
1127  * @param c Connection.
1128  * @param peer Peer.
1129  */
1130 static void
1131 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1132 {
1133   GMP_add_tunnel (peer);
1134   c->t = GMP_get_tunnel (peer);
1135   GMT_add_connection (c->t, c);
1136 }
1137
1138 /******************************************************************************/
1139 /********************************    API    ***********************************/
1140 /******************************************************************************/
1141
1142 /**
1143  * Core handler for connection creation.
1144  *
1145  * @param cls Closure (unused).
1146  * @param peer Sender (neighbor).
1147  * @param message Message.
1148  *
1149  * @return GNUNET_OK to keep the connection open,
1150  *         GNUNET_SYSERR to close it (signal serious error)
1151  */
1152 int
1153 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1154                    const struct GNUNET_MessageHeader *message)
1155 {
1156   struct GNUNET_MESH_ConnectionCreate *msg;
1157   struct GNUNET_PeerIdentity *id;
1158   struct GNUNET_HashCode *cid;
1159   struct MeshPeerPath *path;
1160   struct MeshPeer *dest_peer;
1161   struct MeshPeer *orig_peer;
1162   struct MeshConnection *c;
1163   unsigned int own_pos;
1164   uint16_t size;
1165   uint16_t i;
1166
1167   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1168   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection create msg\n");
1169
1170   /* Check size */
1171   size = ntohs (message->size);
1172   if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1173   {
1174     GNUNET_break_op (0);
1175     return GNUNET_OK;
1176   }
1177
1178   /* Calculate hops */
1179   size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1180   if (size % sizeof (struct GNUNET_PeerIdentity))
1181   {
1182     GNUNET_break_op (0);
1183     return GNUNET_OK;
1184   }
1185   size /= sizeof (struct GNUNET_PeerIdentity);
1186   if (1 > size)
1187   {
1188     GNUNET_break_op (0);
1189     return GNUNET_OK;
1190   }
1191   LOG (GNUNET_ERROR_TYPE_DEBUG, "    path has %u hops.\n", size);
1192
1193   /* Get parameters */
1194   msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1195   cid = &msg->cid;
1196   id = (struct GNUNET_PeerIdentity *) &msg[1];
1197   LOG (GNUNET_ERROR_TYPE_DEBUG,
1198               "    connection %s (%s).\n",
1199               GNUNET_h2s (cid), GNUNET_i2s (id));
1200
1201   /* Create connection */
1202   c = connection_get (cid);
1203   if (NULL == c)
1204   {
1205     /* Create path */
1206     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Creating path...\n");
1207     path = path_new (size);
1208     own_pos = 0;
1209     for (i = 0; i < size; i++)
1210     {
1211       LOG (GNUNET_ERROR_TYPE_DEBUG, "  ... adding %s\n",
1212                   GNUNET_i2s (&id[i]));
1213       path->peers[i] = GNUNET_PEER_intern (&id[i]);
1214       if (path->peers[i] == myid)
1215         own_pos = i;
1216     }
1217     if (own_pos == 0 && path->peers[own_pos] != myid)
1218     {
1219       /* create path: self not found in path through self */
1220       GNUNET_break_op (0);
1221       path_destroy (path);
1222       return GNUNET_OK;
1223     }
1224     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Own position: %u\n", own_pos);
1225     GMP_add_path_to_all (path, GNUNET_NO);
1226         LOG (GNUNET_ERROR_TYPE_DEBUG, "  Creating connection\n");
1227     c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1228     if (NULL == c)
1229       return GNUNET_OK;
1230     connection_reset_timeout (c, GNUNET_YES);
1231   }
1232   else
1233   {
1234     path = NULL;
1235   }
1236   if (MESH_CONNECTION_NEW == c->state)
1237     connection_change_state (c, MESH_CONNECTION_SENT);
1238
1239   /* Remember peers */
1240   dest_peer = GMP_get (&id[size - 1]);
1241   orig_peer = GMP_get (&id[0]);
1242
1243   /* Is it a connection to us? */
1244   if (c->own_pos == size - 1)
1245   {
1246     LOG (GNUNET_ERROR_TYPE_DEBUG, "  It's for us!\n");
1247     GMP_add_path_to_origin (orig_peer, path, GNUNET_YES);
1248
1249     add_to_peer (c, orig_peer);
1250     if (MESH_TUNNEL3_NEW == GMT_get_state (c->t))
1251       GMT_change_state (c->t,  MESH_TUNNEL3_WAITING);
1252
1253     send_connection_ack (c, GNUNET_NO);
1254     if (MESH_CONNECTION_SENT == c->state)
1255       connection_change_state (c, MESH_CONNECTION_ACK);
1256
1257     /* Keep tunnel alive in direction dest->owner*/
1258     c->bck_maintenance_task =
1259             GNUNET_SCHEDULER_add_delayed (create_connection_time,
1260                                           &connection_bck_keepalive, c);
1261   }
1262   else
1263   {
1264     /* It's for somebody else! Retransmit. */
1265     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Retransmitting.\n");
1266     GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1267     GMP_add_path_to_origin (orig_peer, path, GNUNET_NO);
1268     GMC_send_prebuilt_message (message, c, GNUNET_YES, NULL, NULL);
1269   }
1270   return GNUNET_OK;
1271 }
1272
1273
1274 /**
1275  * Core handler for path confirmations.
1276  *
1277  * @param cls closure
1278  * @param message message
1279  * @param peer peer identity this notification is about
1280  *
1281  * @return GNUNET_OK to keep the connection open,
1282  *         GNUNET_SYSERR to close it (signal serious error)
1283  */
1284 int
1285 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1286                     const struct GNUNET_MessageHeader *message)
1287 {
1288   struct GNUNET_MESH_ConnectionACK *msg;
1289   struct MeshConnection *c;
1290   struct MeshPeerPath *p;
1291   struct MeshPeer *pi;
1292   enum MeshConnectionState oldstate;
1293   int fwd;
1294
1295   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1296   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection ACK msg\n");
1297   msg = (struct GNUNET_MESH_ConnectionACK *) message;
1298   LOG (GNUNET_ERROR_TYPE_DEBUG, "  on connection %s\n",
1299               GNUNET_h2s (&msg->cid));
1300   c = connection_get (&msg->cid);
1301   if (NULL == c)
1302   {
1303     GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1304                               1, GNUNET_NO);
1305     LOG (GNUNET_ERROR_TYPE_DEBUG, "  don't know the connection!\n");
1306     return GNUNET_OK;
1307   }
1308
1309   oldstate = c->state;
1310   LOG (GNUNET_ERROR_TYPE_DEBUG, "  via peer %s\n", GNUNET_i2s (peer));
1311   pi = GMP_get (peer);
1312   if (get_next_hop (c) == pi)
1313   {
1314     LOG (GNUNET_ERROR_TYPE_DEBUG, "  SYNACK\n");
1315     fwd = GNUNET_NO;
1316     if (MESH_CONNECTION_SENT == oldstate)
1317       connection_change_state (c, MESH_CONNECTION_ACK);
1318   }
1319   else if (get_prev_hop (c) == pi)
1320   {
1321     LOG (GNUNET_ERROR_TYPE_DEBUG, "  ACK\n");
1322     fwd = GNUNET_YES;
1323     connection_change_state (c, MESH_CONNECTION_READY);
1324   }
1325   else
1326   {
1327     GNUNET_break_op (0);
1328     return GNUNET_OK;
1329   }
1330
1331   connection_reset_timeout (c, fwd);
1332
1333   /* Add path to peers? */
1334   p = c->path;
1335   if (NULL != p)
1336   {
1337     GMP_add_path_to_all (p, GNUNET_YES);
1338   }
1339   else
1340   {
1341     GNUNET_break (0);
1342   }
1343
1344   /* Message for us as creator? */
1345   if (GMC_is_origin (c, GNUNET_YES))
1346   {
1347     if (GNUNET_NO != fwd)
1348     {
1349       GNUNET_break_op (0);
1350       return GNUNET_OK;
1351     }
1352     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Connection (SYN)ACK for us!\n");
1353
1354     /* If just created, cancel the short timeout and start a long one */
1355     if (MESH_CONNECTION_SENT == oldstate)
1356       connection_reset_timeout (c, GNUNET_YES);
1357
1358     /* Change tunnel state */
1359     if (MESH_TUNNEL3_WAITING == GMT_get_state (c->t))
1360       GMT_change_state (c->t, MESH_TUNNEL3_READY);
1361
1362     /* Send ACK (~TCP ACK)*/
1363     send_connection_ack (c, GNUNET_YES);
1364   }
1365
1366   /* Message for us as destination? */
1367   if (GMC_is_terminal (c, GNUNET_YES))
1368   {
1369     if (GNUNET_YES != fwd)
1370     {
1371       GNUNET_break_op (0);
1372       return GNUNET_OK;
1373     }
1374     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Connection ACK for us!\n");
1375
1376     /* If just created, cancel the short timeout and start a long one */
1377     if (MESH_CONNECTION_ACK == oldstate)
1378       connection_reset_timeout (c, GNUNET_NO);
1379
1380     /* Change tunnel state */
1381     if (MESH_TUNNEL3_WAITING == GMT_get_state (c->t))
1382       GMT_change_state (c->t, MESH_TUNNEL3_READY);
1383
1384     return GNUNET_OK;
1385   }
1386
1387   LOG (GNUNET_ERROR_TYPE_DEBUG, "  not for us, retransmitting...\n");
1388   GMC_send_prebuilt_message (message, c, fwd, NULL, NULL);
1389   return GNUNET_OK;
1390 }
1391
1392
1393 /**
1394  * Core handler for notifications of broken paths
1395  *
1396  * @param cls Closure (unused).
1397  * @param id Peer identity of sending neighbor.
1398  * @param message Message.
1399  *
1400  * @return GNUNET_OK to keep the connection open,
1401  *         GNUNET_SYSERR to close it (signal serious error)
1402  */
1403 int
1404 GMC_handle_broken (void* cls,
1405                    const struct GNUNET_PeerIdentity* id,
1406                    const struct GNUNET_MessageHeader* message)
1407 {
1408   struct GNUNET_MESH_ConnectionBroken *msg;
1409   struct MeshConnection *c;
1410   int fwd;
1411
1412   LOG (GNUNET_ERROR_TYPE_DEBUG,
1413               "Received a CONNECTION BROKEN msg from %s\n", GNUNET_i2s (id));
1414   msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1415   LOG (GNUNET_ERROR_TYPE_DEBUG, "  regarding %s\n",
1416               GNUNET_i2s (&msg->peer1));
1417   LOG (GNUNET_ERROR_TYPE_DEBUG, "  regarding %s\n",
1418               GNUNET_i2s (&msg->peer2));
1419   c = connection_get (&msg->cid);
1420   if (NULL == c)
1421   {
1422     GNUNET_break_op (0);
1423     return GNUNET_OK;
1424   }
1425
1426   fwd = is_fwd (c, id);
1427   connection_cancel_queues (c, !fwd);
1428   if (GMC_is_terminal (c, fwd))
1429   {
1430     if (0 < c->pending_messages)
1431       c->destroy = GNUNET_YES;
1432     else
1433       GMC_destroy (c);
1434   }
1435   else
1436   {
1437     GMC_send_prebuilt_message (message, c, fwd, NULL, NULL);
1438     c->destroy = GNUNET_YES;
1439   }
1440
1441   return GNUNET_OK;
1442
1443 }
1444
1445
1446 /**
1447  * Core handler for tunnel destruction
1448  *
1449  * @param cls Closure (unused).
1450  * @param peer Peer identity of sending neighbor.
1451  * @param message Message.
1452  *
1453  * @return GNUNET_OK to keep the connection open,
1454  *         GNUNET_SYSERR to close it (signal serious error)
1455  */
1456 int
1457 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1458                     const struct GNUNET_MessageHeader *message)
1459 {
1460   struct GNUNET_MESH_ConnectionDestroy *msg;
1461   struct MeshConnection *c;
1462   int fwd;
1463
1464   msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1465   LOG (GNUNET_ERROR_TYPE_DEBUG,
1466               "Got a CONNECTION DESTROY message from %s\n",
1467               GNUNET_i2s (peer));
1468   LOG (GNUNET_ERROR_TYPE_DEBUG,
1469               "  for connection %s\n",
1470               GNUNET_h2s (&msg->cid));
1471   c = connection_get (&msg->cid);
1472   if (NULL == c)
1473   {
1474     /* Probably already got the message from another path,
1475      * destroyed the tunnel and retransmitted to children.
1476      * Safe to ignore.
1477      */
1478     GNUNET_STATISTICS_update (stats, "# control on unknown tunnel",
1479                               1, GNUNET_NO);
1480     return GNUNET_OK;
1481   }
1482   fwd = is_fwd (c, peer);
1483   if (GNUNET_SYSERR == fwd)
1484   {
1485     GNUNET_break_op (0);
1486     return GNUNET_OK;
1487   }
1488   GMC_send_prebuilt_message (message, c, fwd, NULL, NULL);
1489   c->destroy = GNUNET_YES;
1490
1491   return GNUNET_OK;
1492 }
1493
1494 /**
1495  * Generic handler for mesh network encrypted traffic.
1496  *
1497  * @param peer Peer identity this notification is about.
1498  * @param msg Encrypted message.
1499  *
1500  * @return GNUNET_OK to keep the connection open,
1501  *         GNUNET_SYSERR to close it (signal serious error)
1502  */
1503 static int
1504 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1505                        const struct GNUNET_MESH_Encrypted *msg)
1506 {
1507   struct MeshConnection *c;
1508   struct MeshPeer *neighbor;
1509   struct MeshFlowControl *fc;
1510   GNUNET_PEER_Id peer_id;
1511   uint32_t pid;
1512   uint32_t ttl;
1513   uint16_t type;
1514   size_t size;
1515   int fwd;
1516
1517   /* Check size */
1518   size = ntohs (msg->header.size);
1519   if (size <
1520       sizeof (struct GNUNET_MESH_Encrypted) +
1521       sizeof (struct GNUNET_MessageHeader))
1522   {
1523     GNUNET_break_op (0);
1524     return GNUNET_OK;
1525   }
1526   type = ntohs (msg->header.type);
1527   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1528   LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message (#%u) from %s\n",
1529        GNUNET_MESH_DEBUG_M2S (type), ntohl (msg->pid), GNUNET_i2s (peer));
1530
1531   /* Check connection */
1532   c = connection_get (&msg->cid);
1533   if (NULL == c)
1534   {
1535     GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1536     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING connection unknown\n");
1537     return GNUNET_OK;
1538   }
1539
1540   /* Check if origin is as expected */
1541   neighbor = get_prev_hop (c);
1542   peer_id = GNUNET_PEER_search (peer);
1543   if (peer_id == GMP_get_short_id (neighbor))
1544   {
1545     fwd = GNUNET_YES;
1546   }
1547   else
1548   {
1549     neighbor = get_next_hop (c);
1550     if (peer_id == GMP_get_short_id (neighbor))
1551     {
1552       fwd = GNUNET_NO;
1553     }
1554     else
1555     {
1556       /* Unexpected peer sending traffic on a connection. */
1557       GNUNET_break_op (0);
1558       return GNUNET_OK;
1559     }
1560   }
1561
1562   /* Check PID */
1563   fc = fwd ? &c->bck_fc : &c->fwd_fc;
1564   pid = ntohl (msg->pid);
1565   if (GMC_is_pid_bigger (pid, fc->last_ack_sent))
1566   {
1567     GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1568     LOG (GNUNET_ERROR_TYPE_DEBUG,
1569                 "WARNING Received PID %u, (prev %u), ACK %u\n",
1570                 pid, fc->last_pid_recv, fc->last_ack_sent);
1571     return GNUNET_OK;
1572   }
1573   if (GNUNET_NO == GMC_is_pid_bigger (pid, fc->last_pid_recv))
1574   {
1575     GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1576     LOG (GNUNET_ERROR_TYPE_DEBUG,
1577                 " Pid %u not expected (%u+), dropping!\n",
1578                 pid, fc->last_pid_recv + 1);
1579     return GNUNET_OK;
1580   }
1581   if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1582     connection_change_state (c, MESH_CONNECTION_READY);
1583   connection_reset_timeout (c, fwd);
1584   fc->last_pid_recv = pid;
1585
1586   /* Is this message for us? */
1587   if (GMC_is_terminal (c, fwd))
1588   {
1589     /* TODO signature verification */
1590     LOG (GNUNET_ERROR_TYPE_DEBUG, "  message for us!\n");
1591     GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1592
1593     if (NULL == c->t)
1594     {
1595       GNUNET_break (0);
1596       return GNUNET_OK;
1597     }
1598     fc->last_pid_recv = pid;
1599     GMT_handle_encrypted (c->t, msg);
1600     GMC_send_ack (c, fwd, GNUNET_NO);
1601     return GNUNET_OK;
1602   }
1603
1604   /* Message not for us: forward to next hop */
1605   LOG (GNUNET_ERROR_TYPE_DEBUG, "  not for us, retransmitting...\n");
1606   ttl = ntohl (msg->ttl);
1607   LOG (GNUNET_ERROR_TYPE_DEBUG, "   ttl: %u\n", ttl);
1608   if (ttl == 0)
1609   {
1610     GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1611     LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1612     GMC_send_ack (c, fwd, GNUNET_NO);
1613     return GNUNET_OK;
1614   }
1615
1616   GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1617   GMC_send_prebuilt_message (&msg->header, c, fwd, NULL, NULL);
1618
1619   return GNUNET_OK;
1620 }
1621
1622 /**
1623  * Generic handler for mesh network encrypted traffic.
1624  *
1625  * @param peer Peer identity this notification is about.
1626  * @param msg Encrypted message.
1627  *
1628  * @return GNUNET_OK to keep the connection open,
1629  *         GNUNET_SYSERR to close it (signal serious error)
1630  */
1631 static int
1632 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1633                 const struct GNUNET_MESH_KX *msg)
1634 {
1635   struct MeshConnection *c;
1636   struct MeshPeer *neighbor;
1637   GNUNET_PEER_Id peer_id;
1638   size_t size;
1639   uint16_t type;
1640   int fwd;
1641
1642   /* Check size */
1643   size = ntohs (msg->header.size);
1644   if (size <
1645       sizeof (struct GNUNET_MESH_Encrypted) +
1646       sizeof (struct GNUNET_MessageHeader))
1647   {
1648     GNUNET_break_op (0);
1649     return GNUNET_OK;
1650   }
1651   type = ntohs (msg->header.type);
1652   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1653   LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message from %s\n",
1654               GNUNET_MESH_DEBUG_M2S (type), GNUNET_i2s (peer));
1655
1656   /* Check connection */
1657   c = connection_get (&msg->cid);
1658   if (NULL == c)
1659   {
1660     GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1661     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING connection unknown\n");
1662     return GNUNET_OK;
1663   }
1664
1665   /* Check if origin is as expected */
1666   neighbor = get_prev_hop (c);
1667   peer_id = GNUNET_PEER_search (peer);
1668   if (peer_id == GMP_get_short_id (neighbor))
1669   {
1670     fwd = GNUNET_YES;
1671   }
1672   else
1673   {
1674     neighbor = get_next_hop (c);
1675     if (peer_id == GMP_get_short_id (neighbor))
1676     {
1677       fwd = GNUNET_NO;
1678     }
1679     else
1680     {
1681       /* Unexpected peer sending traffic on a connection. */
1682       GNUNET_break_op (0);
1683       return GNUNET_OK;
1684     }
1685   }
1686
1687   /* Count as connection confirmation. */
1688   if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1689     connection_change_state (c, MESH_CONNECTION_READY);
1690   connection_reset_timeout (c, fwd);
1691   if (NULL != c->t)
1692   {
1693     if (MESH_TUNNEL3_WAITING == GMT_get_state (c->t))
1694       GMT_change_state (c->t, MESH_TUNNEL3_READY);
1695   }
1696
1697   /* Is this message for us? */
1698   if (GMC_is_terminal (c, fwd))
1699   {
1700     LOG (GNUNET_ERROR_TYPE_DEBUG, "  message for us!\n");
1701     GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1702     if (NULL == c->t)
1703     {
1704       GNUNET_break (0);
1705       return GNUNET_OK;
1706     }
1707     GMT_handle_kx (c->t, &msg[1].header);
1708     return GNUNET_OK;
1709   }
1710
1711   /* Message not for us: forward to next hop */
1712   LOG (GNUNET_ERROR_TYPE_DEBUG, "  not for us, retransmitting...\n");
1713   GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1714   GMC_send_prebuilt_message (&msg->header, c, fwd, NULL, NULL);
1715
1716   return GNUNET_OK;
1717 }
1718
1719
1720 /**
1721  * Core handler for encrypted mesh network traffic (channel mgmt, data).
1722  *
1723  * @param cls Closure (unused).
1724  * @param message Message received.
1725  * @param peer Peer who sent the message.
1726  *
1727  * @return GNUNET_OK to keep the connection open,
1728  *         GNUNET_SYSERR to close it (signal serious error)
1729  */
1730 int
1731 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
1732                       const struct GNUNET_MessageHeader *message)
1733 {
1734   return handle_mesh_encrypted (peer,
1735                                 (struct GNUNET_MESH_Encrypted *)message);
1736 }
1737
1738
1739 /**
1740  * Core handler for key exchange traffic (ephemeral key, ping, pong).
1741  *
1742  * @param cls Closure (unused).
1743  * @param message Message received.
1744  * @param peer Peer who sent the message.
1745  *
1746  * @return GNUNET_OK to keep the connection open,
1747  *         GNUNET_SYSERR to close it (signal serious error)
1748  */
1749 int
1750 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
1751                const struct GNUNET_MessageHeader *message)
1752 {
1753   return handle_mesh_kx (peer,
1754                          (struct GNUNET_MESH_KX *) message);
1755 }
1756
1757
1758 /**
1759  * Core handler for mesh network traffic point-to-point acks.
1760  *
1761  * @param cls closure
1762  * @param message message
1763  * @param peer peer identity this notification is about
1764  *
1765  * @return GNUNET_OK to keep the connection open,
1766  *         GNUNET_SYSERR to close it (signal serious error)
1767  */
1768 int
1769 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
1770                 const struct GNUNET_MessageHeader *message)
1771 {
1772   struct GNUNET_MESH_ACK *msg;
1773   struct MeshConnection *c;
1774   struct MeshFlowControl *fc;
1775   GNUNET_PEER_Id id;
1776   uint32_t ack;
1777   int fwd;
1778
1779   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1780   LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK packet from %s!\n",
1781               GNUNET_i2s (peer));
1782   msg = (struct GNUNET_MESH_ACK *) message;
1783
1784   c = connection_get (&msg->cid);
1785
1786   if (NULL == c)
1787   {
1788     GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
1789                               GNUNET_NO);
1790     return GNUNET_OK;
1791   }
1792
1793   /* Is this a forward or backward ACK? */
1794   id = GNUNET_PEER_search (peer);
1795   if (GMP_get_short_id (get_next_hop (c)) == id)
1796   {
1797     LOG (GNUNET_ERROR_TYPE_DEBUG, "  FWD ACK\n");
1798     fc = &c->fwd_fc;
1799     fwd = GNUNET_YES;
1800   }
1801   else if (GMP_get_short_id (get_prev_hop (c)) == id)
1802   {
1803     LOG (GNUNET_ERROR_TYPE_DEBUG, "  BCK ACK\n");
1804     fc = &c->bck_fc;
1805     fwd = GNUNET_NO;
1806   }
1807   else
1808   {
1809     GNUNET_break_op (0);
1810     return GNUNET_OK;
1811   }
1812
1813   ack = ntohl (msg->ack);
1814   LOG (GNUNET_ERROR_TYPE_DEBUG, "  ACK %u (was %u)\n",
1815               ack, fc->last_ack_recv);
1816   if (GMC_is_pid_bigger (ack, fc->last_ack_recv))
1817     fc->last_ack_recv = ack;
1818
1819   /* Cancel polling if the ACK is big enough. */
1820   if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
1821       GMC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
1822   {
1823     LOG (GNUNET_ERROR_TYPE_DEBUG, "  Cancel poll\n");
1824     GNUNET_SCHEDULER_cancel (fc->poll_task);
1825     fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1826     fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
1827   }
1828
1829   connection_unlock_queue (c, fwd);
1830
1831   return GNUNET_OK;
1832 }
1833
1834
1835 /**
1836  * Core handler for mesh network traffic point-to-point ack polls.
1837  *
1838  * @param cls closure
1839  * @param message message
1840  * @param peer peer identity this notification is about
1841  *
1842  * @return GNUNET_OK to keep the connection open,
1843  *         GNUNET_SYSERR to close it (signal serious error)
1844  */
1845 int
1846 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
1847                  const struct GNUNET_MessageHeader *message)
1848 {
1849   struct GNUNET_MESH_Poll *msg;
1850   struct MeshConnection *c;
1851   struct MeshFlowControl *fc;
1852   GNUNET_PEER_Id id;
1853   uint32_t pid;
1854   int fwd;
1855
1856   LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1857   LOG (GNUNET_ERROR_TYPE_DEBUG,
1858        "Got a POLL packet from %s!\n",
1859        GNUNET_i2s (peer));
1860
1861   msg = (struct GNUNET_MESH_Poll *) message;
1862
1863   c = connection_get (&msg->cid);
1864
1865   if (NULL == c)
1866   {
1867     GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
1868                               GNUNET_NO);
1869     GNUNET_break_op (0);
1870     return GNUNET_OK;
1871   }
1872
1873   /* Is this a forward or backward ACK?
1874    * Note: a poll should never be needed in a loopback case,
1875    * since there is no possiblility of packet loss there, so
1876    * this way of discerining FWD/BCK should not be a problem.
1877    */
1878   id = GNUNET_PEER_search (peer);
1879   if (GMP_get_short_id (get_next_hop (c)) == id)
1880   {
1881     LOG (GNUNET_ERROR_TYPE_DEBUG, "  FWD FC\n");
1882     fc = &c->fwd_fc;
1883   }
1884   else if (GMP_get_short_id (get_prev_hop (c)) == id)
1885   {
1886     LOG (GNUNET_ERROR_TYPE_DEBUG, "  BCK FC\n");
1887     fc = &c->bck_fc;
1888   }
1889   else
1890   {
1891     GNUNET_break_op (0);
1892     return GNUNET_OK;
1893   }
1894
1895   pid = ntohl (msg->pid);
1896   LOG (GNUNET_ERROR_TYPE_DEBUG, "  PID %u, OLD %u\n", pid, fc->last_pid_recv);
1897   fc->last_pid_recv = pid;
1898   fwd = fc == &c->bck_fc;
1899   GMC_send_ack (c, fwd, GNUNET_YES);
1900
1901   return GNUNET_OK;
1902 }
1903
1904
1905 /**
1906  * Core handler for mesh keepalives.
1907  *
1908  * @param cls closure
1909  * @param message message
1910  * @param peer peer identity this notification is about
1911  * @return GNUNET_OK to keep the connection open,
1912  *         GNUNET_SYSERR to close it (signal serious error)
1913  *
1914  * TODO: Check who we got this from, to validate route.
1915  */
1916 int
1917 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
1918                       const struct GNUNET_MessageHeader *message)
1919 {
1920   struct GNUNET_MESH_ConnectionKeepAlive *msg;
1921   struct MeshConnection *c;
1922   struct MeshPeer *neighbor;
1923   int fwd;
1924
1925   msg = (struct GNUNET_MESH_ConnectionKeepAlive *) message;
1926   LOG (GNUNET_ERROR_TYPE_DEBUG, "got a keepalive packet from %s\n",
1927               GNUNET_i2s (peer));
1928
1929   c = connection_get (&msg->cid);
1930   if (NULL == c)
1931   {
1932     GNUNET_STATISTICS_update (stats, "# keepalive on unknown connection", 1,
1933                               GNUNET_NO);
1934     return GNUNET_OK;
1935   }
1936
1937   fwd = GNUNET_MESSAGE_TYPE_MESH_FWD_KEEPALIVE == ntohs (message->type) ?
1938         GNUNET_YES : GNUNET_NO;
1939
1940   /* Check if origin is as expected */
1941   neighbor = get_hop (c, fwd);
1942   if (GNUNET_PEER_search (peer) != GMP_get_short_id (neighbor))
1943   {
1944     GNUNET_break_op (0);
1945     return GNUNET_OK;
1946   }
1947
1948   connection_change_state (c, MESH_CONNECTION_READY);
1949   connection_reset_timeout (c, fwd);
1950
1951   if (GMC_is_terminal (c, fwd))
1952     return GNUNET_OK;
1953
1954   GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
1955   GMC_send_prebuilt_message (message, c, fwd, NULL, NULL);
1956
1957   return GNUNET_OK;
1958 }
1959
1960
1961 /**
1962  * Send an ACK on the appropriate connection/channel, depending on
1963  * the direction and the position of the peer.
1964  *
1965  * @param c Which connection to send the hop-by-hop ACK.
1966  * @param fwd Is this a fwd ACK? (will go dest->root).
1967  * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
1968  */
1969 void
1970 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
1971 {
1972   unsigned int buffer;
1973
1974   LOG (GNUNET_ERROR_TYPE_DEBUG,
1975        "GMC send %s ACK on %s\n",
1976        fwd ? "FWD" : "BCK", GMC_2s (c));
1977
1978   if (NULL == c)
1979   {
1980     GNUNET_break (0);
1981     return;
1982   }
1983
1984   /* Get available buffer space */
1985   if (GMC_is_terminal (c, fwd))
1986   {
1987     LOG (GNUNET_ERROR_TYPE_DEBUG, "  getting from all channels\n");
1988     buffer = GMT_get_channels_buffer (c->t);
1989   }
1990   else
1991   {
1992     LOG (GNUNET_ERROR_TYPE_DEBUG, "  getting from one connection\n");
1993     buffer = GMC_get_buffer (c, fwd);
1994   }
1995   LOG (GNUNET_ERROR_TYPE_DEBUG, "  buffer available: %u\n", buffer);
1996   if (0 == buffer && GNUNET_NO == force)
1997     return;
1998
1999   /* Send available buffer space */
2000   if (GMC_is_origin (c, fwd))
2001   {
2002     GNUNET_assert (NULL != c->t);
2003     LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on channels...\n");
2004     GMT_unchoke_channels (c->t);
2005   }
2006   else
2007   {
2008     LOG (GNUNET_ERROR_TYPE_DEBUG, "  sending on connection\n");
2009     send_ack (c, buffer, fwd, force);
2010   }
2011 }
2012
2013
2014 /**
2015  * Initialize the connections subsystem
2016  *
2017  * @param c Configuration handle.
2018  */
2019 void
2020 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2021 {
2022   LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2023   if (GNUNET_OK !=
2024       GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2025                                              &max_msgs_queue))
2026   {
2027     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2028                                "MESH", "MAX_MSGS_QUEUE", "MISSING");
2029     GNUNET_SCHEDULER_shutdown ();
2030     return;
2031   }
2032
2033   if (GNUNET_OK !=
2034       GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2035                                              &max_connections))
2036   {
2037     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2038                                "MESH", "MAX_CONNECTIONS", "MISSING");
2039     GNUNET_SCHEDULER_shutdown ();
2040     return;
2041   }
2042
2043   if (GNUNET_OK !=
2044       GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2045                                            &refresh_connection_time))
2046   {
2047     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2048                                "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2049     GNUNET_SCHEDULER_shutdown ();
2050     return;
2051   }
2052   create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2053   connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
2054 }
2055
2056 /**
2057  * Shut down the connections subsystem.
2058  */
2059 void
2060 GMC_shutdown (void)
2061 {
2062   GNUNET_CONTAINER_multihashmap_destroy (connections);
2063 }
2064
2065
2066 struct MeshConnection *
2067 GMC_new (const struct GNUNET_HashCode *cid,
2068          struct MeshTunnel3 *t,
2069          struct MeshPeerPath *p,
2070          unsigned int own_pos)
2071 {
2072   struct MeshConnection *c;
2073
2074   c = GNUNET_new (struct MeshConnection);
2075   c->id = *cid;
2076   GNUNET_CONTAINER_multihashmap_put (connections, &c->id, c,
2077                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
2078   fc_init (&c->fwd_fc);
2079   fc_init (&c->bck_fc);
2080   c->fwd_fc.c = c;
2081   c->bck_fc.c = c;
2082
2083   c->t = t;
2084   if (own_pos > p->length - 1)
2085   {
2086     GNUNET_break (0);
2087     GMC_destroy (c);
2088     return NULL;
2089   }
2090   c->own_pos = own_pos;
2091   c->path = p;
2092
2093   if (0 == own_pos)
2094   {
2095     c->fwd_maintenance_task =
2096             GNUNET_SCHEDULER_add_delayed (create_connection_time,
2097                                           &connection_fwd_keepalive, c);
2098   }
2099   register_neighbors (c);
2100   return c;
2101 }
2102
2103
2104 void
2105 GMC_destroy (struct MeshConnection *c)
2106 {
2107   if (NULL == c)
2108     return;
2109
2110   if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2111     return;            /* -> message_sent -> GMC_destroy. Don't loop. */
2112   c->destroy = 2;
2113
2114   LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2115
2116   /* Cancel all traffic */
2117   connection_cancel_queues (c, GNUNET_YES);
2118   connection_cancel_queues (c, GNUNET_NO);
2119
2120   /* Cancel maintainance task (keepalive/timeout) */
2121   if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2122     GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2123   if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2124     GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2125
2126   /* Unregister from neighbors */
2127   unregister_neighbors (c);
2128
2129   /* Delete */
2130   GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2131   if (NULL != c->t)
2132     GMT_remove_connection (c->t, c);
2133
2134   if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES))
2135     path_destroy (c->path);
2136
2137   GNUNET_CONTAINER_multihashmap_remove (connections, &c->id, c);
2138
2139   GNUNET_free (c);
2140 }
2141
2142 /**
2143  * Get the connection ID.
2144  *
2145  * @param c Connection to get the ID from.
2146  *
2147  * @return ID of the connection.
2148  */
2149 const struct GNUNET_HashCode *
2150 GMC_get_id (const struct MeshConnection *c)
2151 {
2152   return &c->id;
2153 }
2154
2155
2156 /**
2157  * Get the connection path.
2158  *
2159  * @param c Connection to get the path from.
2160  *
2161  * @return path used by the connection.
2162  */
2163 const struct MeshPeerPath *
2164 GMC_get_path (const struct MeshConnection *c)
2165 {
2166   return c->path;
2167 }
2168
2169
2170 /**
2171  * Get the connection state.
2172  *
2173  * @param c Connection to get the state from.
2174  *
2175  * @return state of the connection.
2176  */
2177 enum MeshConnectionState
2178 GMC_get_state (const struct MeshConnection *c)
2179 {
2180   return c->state;
2181 }
2182
2183 /**
2184  * Get the connection tunnel.
2185  *
2186  * @param c Connection to get the tunnel from.
2187  *
2188  * @return tunnel of the connection.
2189  */
2190 struct MeshTunnel3 *
2191 GMC_get_tunnel (const struct MeshConnection *c)
2192 {
2193   return c->t;
2194 }
2195
2196
2197 /**
2198  * Get free buffer space in a connection.
2199  *
2200  * @param c Connection.
2201  * @param fwd Is query about FWD traffic?
2202  *
2203  * @return Free buffer space [0 - max_msgs_queue/max_connections]
2204  */
2205 unsigned int
2206 GMC_get_buffer (struct MeshConnection *c, int fwd)
2207 {
2208   struct MeshFlowControl *fc;
2209
2210   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2211
2212   return (fc->queue_max - fc->queue_n);
2213 }
2214
2215 /**
2216  * Get how many messages have we allowed to send to us from a direction.
2217  *
2218  * @param c Connection.
2219  * @param fwd Are we asking about traffic from FWD (BCK messages)?
2220  *
2221  * @return last_ack_sent - last_pid_recv
2222  */
2223 unsigned int
2224 GMC_get_allowed (struct MeshConnection *c, int fwd)
2225 {
2226   struct MeshFlowControl *fc;
2227
2228   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2229   if (GMC_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2230   {
2231     return 0;
2232   }
2233   return (fc->last_ack_sent - fc->last_pid_recv);
2234 }
2235
2236 /**
2237  * Get messages queued in a connection.
2238  *
2239  * @param c Connection.
2240  * @param fwd Is query about FWD traffic?
2241  *
2242  * @return Number of messages queued.
2243  */
2244 unsigned int
2245 GMC_get_qn (struct MeshConnection *c, int fwd)
2246 {
2247   struct MeshFlowControl *fc;
2248
2249   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2250
2251   return fc->queue_n;
2252 }
2253
2254
2255 /**
2256  * Allow the connection to advertise a buffer of the given size.
2257  *
2258  * The connection will send an @c fwd ACK message (so: in direction !fwd)
2259  * allowing up to last_pid_recv + buffer.
2260  *
2261  * @param c Connection.
2262  * @param buffer How many more messages the connection can accept.
2263  * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2264  */
2265 void
2266 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2267 {
2268   send_ack (c, buffer, fwd, GNUNET_NO);
2269 }
2270
2271
2272 /**
2273  * Notify other peers on a connection of a broken link. Mark connections
2274  * to destroy after all traffic has been sent.
2275  *
2276  * @param c Connection on which there has been a disconnection.
2277  * @param peer Peer that disconnected.
2278  */
2279 void
2280 GMC_notify_broken (struct MeshConnection *c,
2281                    struct MeshPeer *peer)
2282 {
2283   int fwd;
2284
2285   fwd = peer == get_prev_hop (c);
2286
2287   if (GNUNET_YES == GMC_is_terminal (c, fwd))
2288   {
2289     /* Local shutdown, no one to notify about this. */
2290     GMC_destroy (c);
2291     return;
2292   }
2293   if (GNUNET_NO == c->destroy)
2294     send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2295
2296   /* Connection will have at least one pending message
2297    * (the one we just scheduled), so no point in checking whether to
2298    * destroy immediately. */
2299   c->destroy = GNUNET_YES;
2300
2301   /**
2302    * Cancel all queues, if no message is left, connection will be destroyed.
2303    */
2304   connection_cancel_queues (c, !fwd);
2305
2306   return;
2307 }
2308
2309
2310 /**
2311  * Is this peer the first one on the connection?
2312  *
2313  * @param c Connection.
2314  * @param fwd Is this about fwd traffic?
2315  *
2316  * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2317  */
2318 int
2319 GMC_is_origin (struct MeshConnection *c, int fwd)
2320 {
2321   if (!fwd && c->path->length - 1 == c->own_pos )
2322     return GNUNET_YES;
2323   if (fwd && 0 == c->own_pos)
2324     return GNUNET_YES;
2325   return GNUNET_NO;
2326 }
2327
2328
2329 /**
2330  * Is this peer the last one on the connection?
2331  *
2332  * @param c Connection.
2333  * @param fwd Is this about fwd traffic?
2334  *            Note that the ROOT is the terminal for BCK traffic!
2335  *
2336  * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2337  */
2338 int
2339 GMC_is_terminal (struct MeshConnection *c, int fwd)
2340 {
2341   return GMC_is_origin (c, !fwd);
2342 }
2343
2344
2345 /**
2346  * See if we are allowed to send by the next hop in the given direction.
2347  *
2348  * @param c Connection.
2349  * @param fwd Is this about fwd traffic?
2350  *
2351  * @return #GNUNET_YES in case it's OK to send.
2352  */
2353 int
2354 GMC_is_sendable (struct MeshConnection *c, int fwd)
2355 {
2356   struct MeshFlowControl *fc;
2357
2358   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2359   if (GMC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2360     return GNUNET_YES;
2361   return GNUNET_NO;
2362 }
2363
2364 /**
2365  * Sends an already built message on a connection, properly registering
2366  * all used resources.
2367  *
2368  * @param message Message to send. Function makes a copy of it.
2369  *                If message is not hop-by-hop, decrements TTL of copy.
2370  * @param c Connection on which this message is transmitted.
2371  * @param fwd Is this a fwd message?
2372  * @param cont Continuation called once message is sent. Can be NULL.
2373  * @param cont_cls Closure for @c cont.
2374  *
2375  * @return Handle to cancel the message before it's sent. NULL on error.
2376  *         Invalid on @c cont call.
2377  */
2378 struct MeshConnectionQueue *
2379 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2380                            struct MeshConnection *c, int fwd,
2381                            GMC_sent cont, void *cont_cls)
2382 {
2383   struct MeshFlowControl *fc;
2384   struct MeshConnectionQueue *q;
2385   void *data;
2386   size_t size;
2387   uint16_t type;
2388   int droppable;
2389
2390   size = ntohs (message->size);
2391   data = GNUNET_malloc (size);
2392   memcpy (data, message, size);
2393   type = ntohs (message->type);
2394   LOG (GNUNET_ERROR_TYPE_DEBUG, "Send %s (%u bytes) on connection %s\n",
2395               GNUNET_MESH_DEBUG_M2S (type), size, GMC_2s (c));
2396
2397   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2398   droppable = GNUNET_YES;
2399   switch (type)
2400   {
2401     struct GNUNET_MESH_Encrypted *emsg;
2402     struct GNUNET_MESH_KX        *kmsg;
2403     struct GNUNET_MESH_ACK       *amsg;
2404     struct GNUNET_MESH_Poll      *pmsg;
2405     struct GNUNET_MESH_ConnectionDestroy *dmsg;
2406     struct GNUNET_MESH_ConnectionBroken  *bmsg;
2407     uint32_t ttl;
2408
2409     case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2410       emsg = (struct GNUNET_MESH_Encrypted *) data;
2411       ttl = ntohl (emsg->ttl);
2412       if (0 == ttl)
2413       {
2414         GNUNET_break_op (0);
2415         GNUNET_free (data);
2416         return NULL;
2417       }
2418       emsg->cid = c->id;
2419       emsg->ttl = htonl (ttl - 1);
2420       emsg->pid = htonl (fc->next_pid++);
2421       LOG (GNUNET_ERROR_TYPE_DEBUG, "  Q_N+ %p %u\n", fc, fc->queue_n);
2422       fc->queue_n++;
2423       LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2424       LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2425       LOG (GNUNET_ERROR_TYPE_DEBUG, "     ack recv %u\n", fc->last_ack_recv);
2426       if (GMC_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2427       {
2428         GMC_start_poll (c, fwd);
2429       }
2430       break;
2431
2432     case GNUNET_MESSAGE_TYPE_MESH_KX:
2433       kmsg = (struct GNUNET_MESH_KX *) data;
2434       kmsg->cid = c->id;
2435       break;
2436
2437     case GNUNET_MESSAGE_TYPE_MESH_ACK:
2438       amsg = (struct GNUNET_MESH_ACK *) data;
2439       amsg->cid = c->id;
2440       LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2441       droppable = GNUNET_NO;
2442       break;
2443
2444     case GNUNET_MESSAGE_TYPE_MESH_POLL:
2445       pmsg = (struct GNUNET_MESH_Poll *) data;
2446       pmsg->cid = c->id;
2447       LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2448       droppable = GNUNET_NO;
2449       break;
2450
2451     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2452       dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2453       dmsg->cid = c->id;
2454       dmsg->reserved = 0;
2455       break;
2456
2457     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2458       bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2459       bmsg->cid = c->id;
2460       bmsg->reserved = 0;
2461       break;
2462
2463     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2464     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2465       break;
2466
2467     default:
2468       GNUNET_break (0);
2469   }
2470
2471   if (fc->queue_n > fc->queue_max && droppable)
2472   {
2473     GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2474                               1, GNUNET_NO);
2475     GNUNET_break (0);
2476     LOG (GNUNET_ERROR_TYPE_DEBUG,
2477                 "queue full: %u/%u\n",
2478                 fc->queue_n, fc->queue_max);
2479     if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2480     {
2481       fc->queue_n--;
2482       fc->next_pid--;
2483     }
2484     GNUNET_free (data);
2485     return NULL; /* Drop this message */
2486   }
2487
2488   LOG (GNUNET_ERROR_TYPE_DEBUG, "  C_P+ %p %u\n", c, c->pending_messages);
2489   c->pending_messages++;
2490
2491   q = GNUNET_new (struct MeshConnectionQueue);
2492   q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2493                         &message_sent, q);
2494   if (NULL == q->q)
2495   {
2496     GNUNET_break (0);
2497     GNUNET_free (data);
2498     GNUNET_free (q);
2499     return NULL;
2500   }
2501   q->cont = cont;
2502   q->cont_cls = cont_cls;
2503   return q;
2504 }
2505
2506
2507 /**
2508  * Cancel a previously sent message while it's in the queue.
2509  *
2510  * ONLY can be called before the continuation given to the send function
2511  * is called. Once the continuation is called, the message is no longer in the
2512  * queue.
2513  *
2514  * If the send function was given no continuation, GMC_cancel should
2515  * NOT be called, since it's not possible to determine if the message has
2516  * already been sent.
2517  *
2518  * @param q Handle to the queue.
2519  */
2520 void
2521 GMC_cancel (struct MeshConnectionQueue *q)
2522 {
2523   LOG (GNUNET_ERROR_TYPE_DEBUG, "!  GMC cancel message\n");
2524
2525   /* queue destroy calls message_sent, which calls q->cont and frees q */
2526   GMP_queue_destroy (q->q, GNUNET_YES);
2527 }
2528
2529
2530 /**
2531  * Sends a CREATE CONNECTION message for a path to a peer.
2532  * Changes the connection and tunnel states if necessary.
2533  *
2534  * @param connection Connection to create.
2535  */
2536 void
2537 GMC_send_create (struct MeshConnection *connection)
2538 {
2539   enum MeshTunnel3State state;
2540   size_t size;
2541
2542   size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2543   size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2544   LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection create\n");
2545   GMP_queue_add (get_next_hop (connection), NULL,
2546                  GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2547                  size, connection, GNUNET_YES, &message_sent, NULL);
2548   LOG (GNUNET_ERROR_TYPE_DEBUG, "  C_P+ %p %u (create)\n",
2549        connection, connection->pending_messages);
2550   connection->pending_messages++;
2551   state = GMT_get_state (connection->t);
2552   if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2553     GMT_change_state (connection->t, MESH_TUNNEL3_WAITING);
2554   if (MESH_CONNECTION_NEW == connection->state)
2555     connection_change_state (connection, MESH_CONNECTION_SENT);
2556 }
2557
2558
2559 /**
2560  * Send a message to all peers in this connection that the connection
2561  * is no longer valid.
2562  *
2563  * If some peer should not receive the message, it should be zero'ed out
2564  * before calling this function.
2565  *
2566  * @param c The connection whose peers to notify.
2567  */
2568 void
2569 GMC_send_destroy (struct MeshConnection *c)
2570 {
2571   struct GNUNET_MESH_ConnectionDestroy msg;
2572
2573   if (GNUNET_YES == c->destroy)
2574     return;
2575
2576   msg.header.size = htons (sizeof (msg));
2577   msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
2578   msg.cid = c->id;
2579   LOG (GNUNET_ERROR_TYPE_DEBUG,
2580               "  sending connection destroy for connection %s\n",
2581               GMC_2s (c));
2582
2583   if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
2584     GMC_send_prebuilt_message (&msg.header, c, GNUNET_YES, NULL, NULL);
2585   if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
2586     GMC_send_prebuilt_message (&msg.header, c, GNUNET_NO, NULL, NULL);
2587   c->destroy = GNUNET_YES;
2588 }
2589
2590
2591 /**
2592  * @brief Start a polling timer for the connection.
2593  *
2594  * When a neighbor does not accept more traffic on the connection it could be
2595  * caused by a simple congestion or by a lost ACK. Polling enables to check
2596  * for the lastest ACK status for a connection.
2597  *
2598  * @param c Connection.
2599  * @param fwd Should we poll in the FWD direction?
2600  */
2601 void
2602 GMC_start_poll (struct MeshConnection *c, int fwd)
2603 {
2604   struct MeshFlowControl *fc;
2605
2606   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2607   if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task && NULL != fc->poll_msg)
2608   {
2609     return;
2610   }
2611   fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
2612                                                 &connection_poll,
2613                                                 fc);
2614 }
2615
2616
2617 /**
2618  * @brief Stop polling a connection for ACKs.
2619  *
2620  * Once we have enough ACKs for future traffic, polls are no longer necessary.
2621  *
2622  * @param c Connection.
2623  * @param fwd Should we stop the poll in the FWD direction?
2624  */
2625 void
2626 GMC_stop_poll (struct MeshConnection *c, int fwd)
2627 {
2628   struct MeshFlowControl *fc;
2629
2630   fc = fwd ? &c->fwd_fc : &c->bck_fc;
2631   if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
2632   {
2633     GNUNET_SCHEDULER_cancel (fc->poll_task);
2634     fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2635   }
2636 }
2637
2638 /**
2639  * Get a (static) string for a connection.
2640  *
2641  * @param c Connection.
2642  */
2643 const char *
2644 GMC_2s (struct MeshConnection *c)
2645 {
2646   if (NULL != c->t)
2647   {
2648     static char buf[128];
2649
2650     sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
2651     return buf;
2652   }
2653   return GNUNET_h2s (&c->id);
2654 }