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