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