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