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