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