2 This file is part of GNUnet.
3 (C) 2001-2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file cadet/gnunet-service-cadet_connection.c
23 * @brief GNUnet CADET service connection handling
24 * @author Bartlomiej Polot
28 #include "gnunet_util_lib.h"
30 #include "gnunet_statistics_service.h"
32 #include "cadet_path.h"
33 #include "cadet_protocol.h"
35 #include "gnunet-service-cadet_connection.h"
36 #include "gnunet-service-cadet_peer.h"
37 #include "gnunet-service-cadet_tunnel.h"
40 #define LOG(level, ...) GNUNET_log_from (level,"cadet-con",__VA_ARGS__)
41 #define LOG2(level, ...) GNUNET_log_from_nocheck(level,"cadet-con",__VA_ARGS__)
44 #define CADET_MAX_POLL_TIME GNUNET_TIME_relative_multiply (\
45 GNUNET_TIME_UNIT_MINUTES,\
50 /******************************************************************************/
51 /******************************** STRUCTS **********************************/
52 /******************************************************************************/
55 * Struct to encapsulate all the Flow Control information to a peer to which
56 * we are directly connected (on a core level).
58 struct CadetFlowControl
61 * Connection this controls.
63 struct CadetConnection *c;
66 * How many messages are in the queue on this connection.
71 * How many messages do we accept in the queue.
73 unsigned int queue_max;
76 * ID of the last packet sent towards the peer.
78 uint32_t last_pid_sent;
81 * ID of the last packet received from the peer.
83 uint32_t last_pid_recv;
86 * Last ACK sent to the peer (peer can't send more than this PID).
88 uint32_t last_ack_sent;
91 * Last ACK sent towards the origin (for traffic towards leaf node).
93 uint32_t last_ack_recv;
96 * Task to poll the peer in case of a lost ACK causes stall.
98 GNUNET_SCHEDULER_TaskIdentifier poll_task;
101 * How frequently to poll for ACKs.
103 struct GNUNET_TIME_Relative poll_time;
106 * Queued poll message, to cancel if not necessary anymore (got ACK).
108 struct CadetConnectionQueue *poll_msg;
111 * Queued poll message, to cancel if not necessary anymore (got ACK).
113 struct CadetConnectionQueue *ack_msg;
117 * Keep a record of the last messages sent on this connection.
119 struct CadetConnectionPerformance
122 * Circular buffer for storing measurements.
124 double usecsperbyte[AVG_MSGS];
127 * Running average of @c usecsperbyte.
132 * How many values of @c usecsperbyte are valid.
137 * Index of the next "free" position in @c usecsperbyte.
144 * Struct containing all information regarding a connection to a peer.
146 struct CadetConnection
149 * Tunnel this connection is part of.
151 struct CadetTunnel *t;
154 * Flow control information for traffic fwd.
156 struct CadetFlowControl fwd_fc;
159 * Flow control information for traffic bck.
161 struct CadetFlowControl bck_fc;
164 * Measure connection performance on the endpoint.
166 struct CadetConnectionPerformance *perf;
169 * ID of the connection.
171 struct GNUNET_CADET_Hash id;
174 * State of the connection.
176 enum CadetConnectionState state;
179 * Path being used for the tunnel. At the origin of the connection
180 * it's a pointer to the destination's path pool, otherwise just a copy.
182 struct CadetPeerPath *path;
185 * Position of the local peer in the path.
187 unsigned int own_pos;
190 * Task to keep the used paths alive at the owner,
191 * time tunnel out on all the other peers.
193 GNUNET_SCHEDULER_TaskIdentifier fwd_maintenance_task;
196 * Task to keep the used paths alive at the destination,
197 * time tunnel out on all the other peers.
199 GNUNET_SCHEDULER_TaskIdentifier bck_maintenance_task;
202 * Queue handle for maintainance traffic. One handle for FWD and BCK since
203 * one peer never needs to maintain both directions (no loopback connections).
205 struct CadetPeerQueue *maintenance_q;
208 * Counter to do exponential backoff when creating a connection (max 64).
210 unsigned short create_retry;
213 * Pending message count.
215 int pending_messages;
218 * Destroy flag: if true, destroy on last message.
224 * Handle for messages queued but not yet sent.
226 struct CadetConnectionQueue
229 * Peer queue handle, to cancel if necessary.
231 struct CadetPeerQueue *q;
234 * Was this a forced message? (Do not account for it)
239 * Continuation to call once sent.
244 * Closure for @c cont.
249 /******************************************************************************/
250 /******************************* GLOBALS ***********************************/
251 /******************************************************************************/
254 * Global handle to the statistics service.
256 extern struct GNUNET_STATISTICS_Handle *stats;
259 * Local peer own ID (memory efficient handle).
261 extern GNUNET_PEER_Id myid;
264 * Local peer own ID (full value).
266 extern struct GNUNET_PeerIdentity my_full_id;
269 * Connections known, indexed by cid (CadetConnection).
271 static struct GNUNET_CONTAINER_MultiHashMap *connections;
274 * How many connections are we willing to maintain.
275 * Local connections are always allowed, even if there are more connections than max.
277 static unsigned long long max_connections;
280 * How many messages *in total* are we willing to queue, divide by number of
281 * connections to get connection queue size.
283 static unsigned long long max_msgs_queue;
286 * How often to send path keepalives. Paths timeout after 4 missed.
288 static struct GNUNET_TIME_Relative refresh_connection_time;
291 * How often to send path create / ACKs.
293 static struct GNUNET_TIME_Relative create_connection_time;
296 /******************************************************************************/
297 /******************************** STATIC ***********************************/
298 /******************************************************************************/
300 #if 0 // avoid compiler warning for unused static function
302 fc_debug (struct CadetFlowControl *fc)
304 LOG (GNUNET_ERROR_TYPE_DEBUG, " IN: %u/%u\n",
305 fc->last_pid_recv, fc->last_ack_sent);
306 LOG (GNUNET_ERROR_TYPE_DEBUG, " OUT: %u/%u\n",
307 fc->last_pid_sent, fc->last_ack_recv);
308 LOG (GNUNET_ERROR_TYPE_DEBUG, " QUEUE: %u/%u\n",
309 fc->queue_n, fc->queue_max);
313 connection_debug (struct CadetConnection *c)
317 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CONNECTION ***\n");
320 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s:%X\n",
321 peer2s (c->t->peer), GCC_2s (c));
322 LOG (GNUNET_ERROR_TYPE_DEBUG, " state: %u, pending msgs: %u\n",
323 c->state, c->pending_messages);
324 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
325 fc_debug (&c->fwd_fc);
326 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
327 fc_debug (&c->bck_fc);
333 * Schedule next keepalive task, taking in consideration
334 * the connection state and number of retries.
336 * @param c Connection for which to schedule the next keepalive.
337 * @param fwd Direction for the next keepalive.
340 schedule_next_keepalive (struct CadetConnection *c, int fwd);
344 * Resets the connection timeout task, some other message has done the
346 * - For the first peer on the direction this means to send
347 * a keepalive or a path confirmation message (either create or ACK).
348 * - For all other peers, this means to destroy the connection,
349 * due to lack of activity.
350 * Starts the timeout if no timeout was running (connection just created).
352 * @param c Connection whose timeout to reset.
353 * @param fwd Is this forward?
356 connection_reset_timeout (struct CadetConnection *c, int fwd);
360 * Get string description for tunnel state. Reentrant.
362 * @param s Tunnel state.
364 * @return String representation.
367 GCC_state2s (enum CadetConnectionState s)
371 case CADET_CONNECTION_NEW:
372 return "CADET_CONNECTION_NEW";
373 case CADET_CONNECTION_SENT:
374 return "CADET_CONNECTION_SENT";
375 case CADET_CONNECTION_ACK:
376 return "CADET_CONNECTION_ACK";
377 case CADET_CONNECTION_READY:
378 return "CADET_CONNECTION_READY";
379 case CADET_CONNECTION_DESTROYED:
380 return "CADET_CONNECTION_DESTROYED";
382 return "CADET_CONNECTION_STATE_ERROR";
388 * Initialize a Flow Control structure to the initial state.
390 * @param fc Flow Control structure to initialize.
393 fc_init (struct CadetFlowControl *fc)
395 fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
396 fc->last_pid_recv = (uint32_t) -1;
397 fc->last_ack_sent = (uint32_t) 0;
398 fc->last_ack_recv = (uint32_t) 0;
399 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
400 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
402 fc->queue_max = (max_msgs_queue / max_connections) + 1;
409 * @param cid Connection ID.
411 static struct CadetConnection *
412 connection_get (const struct GNUNET_CADET_Hash *cid)
414 return GNUNET_CONTAINER_multihashmap_get (connections, GC_h2hc (cid));
419 connection_change_state (struct CadetConnection* c,
420 enum CadetConnectionState state)
422 LOG (GNUNET_ERROR_TYPE_DEBUG,
423 "Connection %s state %s -> %s\n",
424 GCC_2s (c), GCC_state2s (c->state), GCC_state2s (state));
425 if (CADET_CONNECTION_DESTROYED == c->state)
427 LOG (GNUNET_ERROR_TYPE_DEBUG, "state not changing anymore\n");
431 if (CADET_CONNECTION_READY == state)
437 * Callback called when a queued ACK message is sent.
439 * @param cls Closure (FC).
440 * @param c Connection this message was on.
441 * @param q Queue handler this call invalidates.
442 * @param type Type of message sent.
443 * @param fwd Was this a FWD going message?
444 * @param size Size of the message.
448 struct CadetConnection *c,
449 struct CadetConnectionQueue *q,
450 uint16_t type, int fwd, size_t size)
452 struct CadetFlowControl *fc = cls;
459 * Send an ACK on the connection, informing the predecessor about
460 * the available buffer space. Should not be called in case the peer
461 * is origin (no predecessor) in the @c fwd direction.
463 * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
464 * the ACK itself goes "back" (dest->root).
466 * @param c Connection on which to send the ACK.
467 * @param buffer How much space free to advertise?
468 * @param fwd Is this FWD ACK? (Going dest -> root)
469 * @param force Don't optimize out.
472 send_ack (struct CadetConnection *c, unsigned int buffer, int fwd, int force)
474 struct CadetFlowControl *next_fc;
475 struct CadetFlowControl *prev_fc;
476 struct GNUNET_CADET_ACK msg;
480 /* If origin, there is no connection to send ACKs. Wrong function! */
481 if (GCC_is_origin (c, fwd))
483 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection %s is origin in %s\n",
484 GCC_2s (c), GC_f2s (fwd));
489 next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
490 prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
492 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection send %s ack on %s\n",
493 GC_f2s (fwd), GCC_2s (c));
495 /* Check if we need to transmit the ACK. */
496 delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
497 if (3 < delta && buffer < delta && GNUNET_NO == force)
499 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
500 LOG (GNUNET_ERROR_TYPE_DEBUG,
501 " last pid recv: %u, last ack sent: %u\n",
502 prev_fc->last_pid_recv, prev_fc->last_ack_sent);
506 /* Ok, ACK might be necessary, what PID to ACK? */
507 ack = prev_fc->last_pid_recv + buffer;
508 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
509 LOG (GNUNET_ERROR_TYPE_DEBUG,
510 " last pid %u, last ack %u, qmax %u, q %u\n",
511 prev_fc->last_pid_recv, prev_fc->last_ack_sent,
512 next_fc->queue_max, next_fc->queue_n);
513 if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
515 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
519 /* Check if message is already in queue */
520 if (NULL != prev_fc->ack_msg)
522 if (GC_is_pid_bigger (ack, prev_fc->last_ack_sent))
524 LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
525 GCC_cancel (prev_fc->ack_msg);
526 /* GCC_cancel triggers ack_sent(), which clears fc->ack_msg */
530 LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
535 prev_fc->last_ack_sent = ack;
537 /* Build ACK message and send on connection */
538 msg.header.size = htons (sizeof (msg));
539 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_ACK);
540 msg.ack = htonl (ack);
543 prev_fc->ack_msg = GCC_send_prebuilt_message (&msg.header, 0, ack, c,
546 GNUNET_assert (NULL != prev_fc->ack_msg);
551 * Callback called when a connection queued message is sent.
553 * Calculates the average time and connection packet tracking.
555 * @param cls Closure (ConnectionQueue Handle).
556 * @param c Connection this message was on.
557 * @param sent Was it really sent? (Could have been canceled)
558 * @param type Type of message sent.
559 * @param pid Packet ID, or 0 if not applicable (create, destroy, etc).
560 * @param fwd Was this a FWD going message?
561 * @param size Size of the message.
562 * @param wait Time spent waiting for core (only the time for THIS message)
565 conn_message_sent (void *cls,
566 struct CadetConnection *c, int sent,
567 uint16_t type, uint32_t pid, int fwd, size_t size,
568 struct GNUNET_TIME_Relative wait)
570 struct CadetConnectionPerformance *p;
571 struct CadetFlowControl *fc;
572 struct CadetConnectionQueue *q = cls;
576 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection message_sent\n");
578 fc = fwd ? &c->fwd_fc : &c->bck_fc;
579 LOG (GNUNET_ERROR_TYPE_DEBUG, " %ssent %s %s\n",
580 sent ? "" : "not ", GC_f2s (fwd), GC_m2s (type));
586 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling cont\n");
587 q->cont (q->cont_cls, c, q, type, fwd, size);
591 else if (type == GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED)
593 /* If NULL == q and ENCRYPTED == type, message must have been ch_mngmnt */
602 if (type != GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN
603 && type != GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY)
605 LOG (GNUNET_ERROR_TYPE_ERROR, "Message %s sent on NULL connection!\n",
610 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P- %p %u\n", c, c->pending_messages);
611 c->pending_messages--;
612 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
614 LOG (GNUNET_ERROR_TYPE_DEBUG, "! destroying connection!\n");
618 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
621 case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE:
622 case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK:
623 c->maintenance_q = NULL;
624 /* Don't trigger a keepalive for sent ACKs, only SYN and SYNACKs */
625 if (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE == type || !fwd)
626 schedule_next_keepalive (c, fwd);
629 case GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED:
630 if (GNUNET_YES == sent)
632 GNUNET_assert (NULL != q);
633 fc->last_pid_sent = pid; // FIXME
634 GCC_send_ack (c, fwd, GNUNET_NO);
635 connection_reset_timeout (c, fwd);
638 LOG (GNUNET_ERROR_TYPE_DEBUG, "! Q_N- %p %u\n", fc, fc->queue_n);
639 if (GNUNET_NO == forced)
642 LOG (GNUNET_ERROR_TYPE_DEBUG,
643 "! accounting pid %u\n",
648 LOG (GNUNET_ERROR_TYPE_DEBUG,
649 "! forced, Q_N not accounting pid %u\n",
654 case GNUNET_MESSAGE_TYPE_CADET_KX:
655 if (GNUNET_YES == sent)
656 connection_reset_timeout (c, fwd);
659 case GNUNET_MESSAGE_TYPE_CADET_POLL:
663 case GNUNET_MESSAGE_TYPE_CADET_ACK:
670 LOG (GNUNET_ERROR_TYPE_DEBUG, "! message sent!\n");
673 return; /* Only endpoints are interested in timing. */
676 usecsperbyte = ((double) wait.rel_value_us) / size;
677 if (p->size == AVG_MSGS)
679 /* Array is full. Substract oldest value, add new one and store. */
680 p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
681 p->usecsperbyte[p->idx] = usecsperbyte;
682 p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
686 /* Array not yet full. Add current value to avg and store. */
687 p->usecsperbyte[p->idx] = usecsperbyte;
689 p->avg += p->usecsperbyte[p->idx];
693 p->idx = (p->idx + 1) % AVG_MSGS;
698 * Get the previous hop in a connection
700 * @param c Connection.
702 * @return Previous peer in the connection.
704 static struct CadetPeer *
705 get_prev_hop (const struct CadetConnection *c)
709 LOG (GNUNET_ERROR_TYPE_DEBUG, " get prev hop %s [%u/%u]\n",
710 GCC_2s (c), c->own_pos, c->path->length);
711 if (0 == c->own_pos || c->path->length < 2)
712 id = c->path->peers[0];
714 id = c->path->peers[c->own_pos - 1];
716 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s (%u)\n",
717 GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
719 return GCP_get_short (id);
724 * Get the next hop in a connection
726 * @param c Connection.
728 * @return Next peer in the connection.
730 static struct CadetPeer *
731 get_next_hop (const struct CadetConnection *c)
735 LOG (GNUNET_ERROR_TYPE_DEBUG, " get next hop %s [%u/%u]\n",
736 GCC_2s (c), c->own_pos, c->path->length);
737 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
738 id = c->path->peers[c->path->length - 1];
740 id = c->path->peers[c->own_pos + 1];
742 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s (%u)\n",
743 GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
745 return GCP_get_short (id);
750 * Get the hop in a connection.
752 * @param c Connection.
753 * @param fwd Next hop?
755 * @return Next peer in the connection.
757 static struct CadetPeer *
758 get_hop (struct CadetConnection *c, int fwd)
761 return get_next_hop (c);
762 return get_prev_hop (c);
767 * Is traffic coming from this sender 'FWD' traffic?
769 * @param c Connection to check.
770 * @param sender Peer identity of neighbor.
772 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
773 * the traffic is 'FWD'.
774 * #GNUNET_NO for BCK.
775 * #GNUNET_SYSERR for errors.
778 is_fwd (const struct CadetConnection *c,
779 const struct GNUNET_PeerIdentity *sender)
783 id = GNUNET_PEER_search (sender);
784 if (GCP_get_short_id (get_prev_hop (c)) == id)
787 if (GCP_get_short_id (get_next_hop (c)) == id)
791 return GNUNET_SYSERR;
796 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
797 * or a first CONNECTION_ACK directed to us.
799 * @param connection Connection to confirm.
800 * @param fwd Should we send it FWD? (root->dest)
801 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
804 send_connection_ack (struct CadetConnection *connection, int fwd)
806 struct CadetTunnel *t;
809 LOG (GNUNET_ERROR_TYPE_INFO, "===> {%14s ACK} on connection %s\n",
810 GC_f2s (!fwd), GCC_2s (connection));
811 GCP_queue_add (get_hop (connection, fwd), NULL,
812 GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK, 0, 0,
813 sizeof (struct GNUNET_CADET_ConnectionACK),
814 connection, fwd, &conn_message_sent, NULL);
815 connection->pending_messages++;
816 if (CADET_TUNNEL_NEW == GCT_get_cstate (t))
817 GCT_change_cstate (t, CADET_TUNNEL_WAITING);
818 if (CADET_CONNECTION_READY != connection->state)
819 connection_change_state (connection, CADET_CONNECTION_SENT);
824 * Send a notification that a connection is broken.
826 * @param c Connection that is broken.
827 * @param id1 Peer that has disconnected.
828 * @param id2 Peer that has disconnected.
829 * @param fwd Direction towards which to send it.
832 send_broken (struct CadetConnection *c,
833 const struct GNUNET_PeerIdentity *id1,
834 const struct GNUNET_PeerIdentity *id2,
837 struct GNUNET_CADET_ConnectionBroken msg;
839 msg.header.size = htons (sizeof (struct GNUNET_CADET_ConnectionBroken));
840 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN);
844 GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg.header, 0, 0, c, fwd,
845 GNUNET_YES, NULL, NULL));
850 * Send a notification that a connection is broken, when a connection
851 * isn't even known to the local peer.
853 * @param connection_id Connection ID.
854 * @param id1 Peer that has disconnected, probably local peer.
855 * @param id2 Peer that has disconnected can be NULL if unknown.
856 * @param peer Peer to notify (neighbor who sent the connection).
859 send_broken_unknown (const struct GNUNET_CADET_Hash *connection_id,
860 const struct GNUNET_PeerIdentity *id1,
861 const struct GNUNET_PeerIdentity *id2,
862 const struct GNUNET_PeerIdentity *peer_id)
864 struct GNUNET_CADET_ConnectionBroken *msg;
865 struct CadetPeer *neighbor;
867 LOG (GNUNET_ERROR_TYPE_INFO, "===> BROKEN on unknown connection %s\n",
868 GNUNET_h2s (GC_h2hc (connection_id)));
870 msg = GNUNET_new (struct GNUNET_CADET_ConnectionBroken);
871 msg->header.size = htons (sizeof (struct GNUNET_CADET_ConnectionBroken));
872 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN);
873 msg->cid = *connection_id;
878 memset (&msg->peer2, 0, sizeof (msg->peer2));
879 neighbor = GCP_get (peer_id);
880 GCP_queue_add (neighbor, msg, GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN,
881 0, 2, sizeof (struct GNUNET_CADET_ConnectionBroken),
882 NULL, GNUNET_SYSERR, /* connection, fwd */
883 NULL, NULL); /* continuation */
888 * Send keepalive packets for a connection.
890 * @param c Connection to keep alive..
891 * @param fwd Is this a FWD keepalive? (owner -> dest).
894 send_connection_keepalive (struct CadetConnection *c, int fwd)
896 struct GNUNET_MessageHeader msg;
897 struct CadetFlowControl *fc;
899 LOG (GNUNET_ERROR_TYPE_INFO,
900 "keepalive %s for connection %s\n",
901 GC_f2s (fwd), GCC_2s (c));
903 fc = fwd ? &c->fwd_fc : &c->bck_fc;
906 LOG (GNUNET_ERROR_TYPE_INFO, "not sending keepalive, traffic in queue\n");
909 GNUNET_STATISTICS_update (stats, "# keepalives sent", 1, GNUNET_NO);
911 GNUNET_assert (NULL != c->t);
912 msg.size = htons (sizeof (msg));
913 msg.type = htons (GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE);
915 GNUNET_assert (NULL ==
916 GCT_send_prebuilt_message (&msg, c->t, c,
917 GNUNET_NO, NULL, NULL));
922 * Send CONNECTION_{CREATE/ACK} packets for a connection.
924 * @param c Connection for which to send the message.
925 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
928 connection_recreate (struct CadetConnection *c, int fwd)
930 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
934 send_connection_ack (c, GNUNET_NO);
939 * Generic connection timer management.
940 * Depending on the role of the peer in the connection will send the
941 * appropriate message (build or keepalive)
943 * @param c Conncetion to maintain.
947 connection_maintain (struct CadetConnection *c, int fwd)
949 if (GNUNET_NO != c->destroy)
958 if (CADET_TUNNEL_SEARCHING == GCT_get_cstate (c->t))
960 /* TODO DHT GET with RO_BART */
965 case CADET_CONNECTION_NEW:
968 case CADET_CONNECTION_SENT:
969 connection_recreate (c, fwd);
971 case CADET_CONNECTION_READY:
972 send_connection_keepalive (c, fwd);
982 * Keep the connection alive.
984 * @param c Connection to keep alive.
985 * @param fwd Direction.
986 * @param shutdown Are we shutting down? (Don't send traffic)
987 * Non-zero value for true, not necessarily GNUNET_YES.
990 connection_keepalive (struct CadetConnection *c, int fwd, int shutdown)
992 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s keepalive for %s\n",
993 GC_f2s (fwd), GCC_2s (c));
996 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
998 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1000 if (GNUNET_NO != shutdown)
1003 connection_maintain (c, fwd);
1005 /* Next execution will be scheduled by message_sent */
1010 * Keep the connection alive in the FWD direction.
1012 * @param cls Closure (connection to keepalive).
1013 * @param tc TaskContext.
1016 connection_fwd_keepalive (void *cls,
1017 const struct GNUNET_SCHEDULER_TaskContext *tc)
1019 connection_keepalive ((struct CadetConnection *) cls,
1021 tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN);
1026 * Keep the connection alive in the BCK direction.
1028 * @param cls Closure (connection to keepalive).
1029 * @param tc TaskContext.
1032 connection_bck_keepalive (void *cls,
1033 const struct GNUNET_SCHEDULER_TaskContext *tc)
1035 connection_keepalive ((struct CadetConnection *) cls,
1037 tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN);
1042 * Schedule next keepalive task, taking in consideration
1043 * the connection state and number of retries.
1045 * If the peer is not the origin, do nothing.
1047 * @param c Connection for which to schedule the next keepalive.
1048 * @param fwd Direction for the next keepalive.
1051 schedule_next_keepalive (struct CadetConnection *c, int fwd)
1053 struct GNUNET_TIME_Relative delay;
1054 GNUNET_SCHEDULER_TaskIdentifier *task_id;
1055 GNUNET_SCHEDULER_Task keepalive_task;
1057 if (GNUNET_NO == GCC_is_origin (c, fwd))
1060 /* Calculate delay to use, depending on the state of the connection */
1061 if (CADET_CONNECTION_READY == c->state)
1063 delay = refresh_connection_time;
1067 if (1 > c->create_retry)
1068 c->create_retry = 1;
1069 delay = GNUNET_TIME_relative_multiply (create_connection_time,
1071 if (c->create_retry < 64)
1072 c->create_retry *= 2;
1075 /* Select direction-dependent parameters */
1076 if (GNUNET_YES == fwd)
1078 task_id = &c->fwd_maintenance_task;
1079 keepalive_task = &connection_fwd_keepalive;
1083 task_id = &c->bck_maintenance_task;
1084 keepalive_task = &connection_bck_keepalive;
1087 /* Check that no one scheduled it before us */
1088 if (GNUNET_SCHEDULER_NO_TASK != *task_id)
1090 /* No need for a _break. It can happen for instance when sending a SYNACK
1091 * for a duplicate SYN: the first SYNACK scheduled the task. */
1092 GNUNET_SCHEDULER_cancel (*task_id);
1095 /* Schedule the task */
1096 *task_id = GNUNET_SCHEDULER_add_delayed (delay, keepalive_task, c);
1097 LOG (GNUNET_ERROR_TYPE_DEBUG, "next keepalive in %s\n",
1098 GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1103 * @brief Re-initiate traffic on this connection if necessary.
1105 * Check if there is traffic queued towards this peer
1106 * and the core transmit handle is NULL (traffic was stalled).
1107 * If so, call core tmt rdy.
1109 * @param c Connection on which initiate traffic.
1110 * @param fwd Is this about fwd traffic?
1113 connection_unlock_queue (struct CadetConnection *c, int fwd)
1115 struct CadetPeer *peer;
1117 LOG (GNUNET_ERROR_TYPE_DEBUG,
1118 "connection_unlock_queue %s on %s\n",
1119 GC_f2s (fwd), GCC_2s (c));
1121 if (GCC_is_terminal (c, fwd))
1123 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
1127 peer = get_hop (c, fwd);
1128 GCP_queue_unlock (peer, c);
1133 * Cancel all transmissions that belong to a certain connection.
1135 * If the connection is scheduled for destruction and no more messages are left,
1136 * the connection will be destroyed by the continuation call.
1138 * @param c Connection which to cancel. Might be destroyed during this call.
1139 * @param fwd Cancel fwd traffic?
1142 connection_cancel_queues (struct CadetConnection *c, int fwd)
1144 struct CadetFlowControl *fc;
1145 struct CadetPeer *peer;
1147 LOG (GNUNET_ERROR_TYPE_DEBUG,
1148 " *** Cancel %s queues for connection %s\n",
1149 GC_f2s (fwd), GCC_2s (c));
1156 fc = fwd ? &c->fwd_fc : &c->bck_fc;
1157 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
1159 GNUNET_SCHEDULER_cancel (fc->poll_task);
1160 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1161 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
1163 peer = get_hop (c, fwd);
1164 GCP_queue_cancel (peer, c);
1169 * Function called if a connection has been stalled for a while,
1170 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1172 * @param cls Closure (poll ctx).
1173 * @param tc TaskContext.
1176 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1180 * Callback called when a queued POLL message is sent.
1182 * @param cls Closure (FC).
1183 * @param c Connection this message was on.
1184 * @param q Queue handler this call invalidates.
1185 * @param type Type of message sent.
1186 * @param fwd Was this a FWD going message?
1187 * @param size Size of the message.
1190 poll_sent (void *cls,
1191 struct CadetConnection *c,
1192 struct CadetConnectionQueue *q,
1193 uint16_t type, int fwd, size_t size)
1195 struct CadetFlowControl *fc = cls;
1197 if (2 == c->destroy)
1199 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
1202 LOG (GNUNET_ERROR_TYPE_DEBUG,
1203 " *** POLL sent for , scheduling new one!\n");
1204 fc->poll_msg = NULL;
1205 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
1206 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
1207 &connection_poll, fc);
1208 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1213 * Function called if a connection has been stalled for a while,
1214 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1216 * @param cls Closure (poll ctx).
1217 * @param tc TaskContext.
1220 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1222 struct CadetFlowControl *fc = cls;
1223 struct GNUNET_CADET_Poll msg;
1224 struct CadetConnection *c;
1226 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1227 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1233 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling connection %s %s\n",
1234 GCC_2s (c), fc == &c->fwd_fc ? "FWD" : "BCK");
1236 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_POLL);
1237 msg.header.size = htons (sizeof (msg));
1238 msg.pid = htonl (fc->last_pid_sent);
1239 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1241 GCC_send_prebuilt_message (&msg.header, 0, fc->last_pid_sent, c,
1242 fc == &c->fwd_fc, GNUNET_YES, &poll_sent, fc);
1243 GNUNET_assert (NULL != fc->poll_msg);
1248 * Timeout function due to lack of keepalive/traffic from the owner.
1249 * Destroys connection if called.
1251 * @param cls Closure (connection to destroy).
1252 * @param tc TaskContext.
1255 connection_fwd_timeout (void *cls,
1256 const struct GNUNET_SCHEDULER_TaskContext *tc)
1258 struct CadetConnection *c = cls;
1260 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1261 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1264 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1266 if (GCC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1277 * Timeout function due to lack of keepalive/traffic from the destination.
1278 * Destroys connection if called.
1280 * @param cls Closure (connection to destroy).
1281 * @param tc TaskContext
1284 connection_bck_timeout (void *cls,
1285 const struct GNUNET_SCHEDULER_TaskContext *tc)
1287 struct CadetConnection *c = cls;
1289 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1290 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1293 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1296 if (GCC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1307 * Resets the connection timeout task, some other message has done the
1309 * - For the first peer on the direction this means to send
1310 * a keepalive or a path confirmation message (either create or ACK).
1311 * - For all other peers, this means to destroy the connection,
1312 * due to lack of activity.
1313 * Starts the timeout if no timeout was running (connection just created).
1315 * @param c Connection whose timeout to reset.
1316 * @param fwd Is this forward?
1318 * TODO use heap to improve efficiency of scheduler.
1321 connection_reset_timeout (struct CadetConnection *c, int fwd)
1323 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GC_f2s (fwd));
1325 if (GCC_is_origin (c, fwd)) /* Startpoint */
1327 schedule_next_keepalive (c, fwd);
1329 else /* Relay, endpoint. */
1331 struct GNUNET_TIME_Relative delay;
1332 GNUNET_SCHEDULER_TaskIdentifier *ti;
1333 GNUNET_SCHEDULER_Task f;
1335 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1337 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1338 GNUNET_SCHEDULER_cancel (*ti);
1339 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1340 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1341 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1347 * Add the connection to the list of both neighbors.
1349 * @param c Connection.
1351 * @return #GNUNET_OK if everything went fine
1352 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1355 register_neighbors (struct CadetConnection *c)
1357 struct CadetPeer *next_peer;
1358 struct CadetPeer *prev_peer;
1360 next_peer = get_next_hop (c);
1361 prev_peer = get_prev_hop (c);
1363 LOG (GNUNET_ERROR_TYPE_DEBUG, "register neighbors for connection %s\n",
1365 path_debug (c->path);
1366 LOG (GNUNET_ERROR_TYPE_DEBUG, "own pos %u\n", c->own_pos);
1367 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to next peer %p\n",
1368 GCC_2s (c), next_peer);
1369 LOG (GNUNET_ERROR_TYPE_DEBUG, "next peer %p %s\n", next_peer, GCP_2s (next_peer));
1370 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to prev peer %p\n",
1371 GCC_2s (c), prev_peer);
1372 LOG (GNUNET_ERROR_TYPE_DEBUG, "prev peer %p %s\n", prev_peer, GCP_2s (prev_peer));
1374 if (GNUNET_NO == GCP_is_neighbor (next_peer)
1375 || GNUNET_NO == GCP_is_neighbor (prev_peer))
1377 if (GCC_is_origin (c, GNUNET_YES))
1378 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1379 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1381 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1382 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1383 GCP_2s (prev_peer), GCP_is_neighbor (prev_peer));
1384 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1385 GCP_2s (next_peer), GCP_is_neighbor (next_peer));
1386 return GNUNET_SYSERR;
1389 GCP_add_connection (next_peer, c);
1390 GCP_add_connection (prev_peer, c);
1397 * Remove the connection from the list of both neighbors.
1399 * @param c Connection.
1402 unregister_neighbors (struct CadetConnection *c)
1404 struct CadetPeer *peer;
1406 peer = get_next_hop (c);
1407 if (GNUNET_OK != GCP_remove_connection (peer, c))
1409 GNUNET_assert (CADET_CONNECTION_NEW == c->state
1410 || CADET_CONNECTION_DESTROYED == c->state);
1411 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1412 if (NULL != c->t) GCT_debug (c->t, GNUNET_ERROR_TYPE_DEBUG);
1415 peer = get_prev_hop (c);
1416 if (GNUNET_OK != GCP_remove_connection (peer, c))
1418 GNUNET_assert (CADET_CONNECTION_NEW == c->state
1419 || CADET_CONNECTION_DESTROYED == c->state);
1420 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1421 if (NULL != c->t) GCT_debug (c->t, GNUNET_ERROR_TYPE_DEBUG);
1427 * Bind the connection to the peer and the tunnel to that peer.
1429 * If the peer has no tunnel, create one. Update tunnel and connection
1430 * data structres to reflect new status.
1432 * @param c Connection.
1436 add_to_peer (struct CadetConnection *c, struct CadetPeer *peer)
1438 GCP_add_tunnel (peer);
1439 c->t = GCP_get_tunnel (peer);
1440 GCT_add_connection (c->t, c);
1445 * Builds a path from a PeerIdentity array.
1447 * @param peers PeerIdentity array.
1448 * @param size Size of the @c peers array.
1449 * @param own_pos Output parameter: own position in the path.
1451 * @return Fixed and shortened path.
1453 static struct CadetPeerPath *
1454 build_path_from_peer_ids (struct GNUNET_PeerIdentity *peers,
1456 unsigned int *own_pos)
1458 struct CadetPeerPath *path;
1459 GNUNET_PEER_Id shortid;
1462 unsigned int offset;
1465 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1466 path = path_new (size);
1469 for (i = 0; i < size; i++)
1471 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %u: taking %s\n",
1472 i, GNUNET_i2s (&peers[i]));
1473 shortid = GNUNET_PEER_intern (&peers[i]);
1475 /* Check for loops / duplicates */
1476 for (j = 0; j < i - offset; j++)
1478 if (path->peers[j] == shortid)
1480 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists at pos %u\n", j);
1482 LOG (GNUNET_ERROR_TYPE_DEBUG, " offset now %u\n", offset);
1483 GNUNET_PEER_change_rc (shortid, -1);
1486 LOG (GNUNET_ERROR_TYPE_DEBUG, " storing at %u\n", i - offset);
1487 path->peers[i - offset] = shortid;
1488 if (path->peers[i - offset] == myid)
1489 *own_pos = i - offset;
1491 path->length -= offset;
1493 if (path->peers[*own_pos] != myid)
1495 /* create path: self not found in path through self */
1496 GNUNET_break_op (0);
1497 path_destroy (path);
1506 * Log receipt of message on stderr (INFO level).
1508 * @param message Message received.
1509 * @param peer Peer who sent the message.
1510 * @param hash Connection ID.
1513 log_message (const struct GNUNET_MessageHeader *message,
1514 const struct GNUNET_PeerIdentity *peer,
1515 const struct GNUNET_CADET_Hash *hash)
1517 LOG (GNUNET_ERROR_TYPE_INFO, "<-- %s on connection %s from %s\n",
1518 GC_m2s (ntohs (message->type)), GNUNET_h2s (GC_h2hc (hash)),
1522 /******************************************************************************/
1523 /******************************** API ***********************************/
1524 /******************************************************************************/
1527 * Core handler for connection creation.
1529 * @param cls Closure (unused).
1530 * @param peer Sender (neighbor).
1531 * @param message Message.
1533 * @return GNUNET_OK to keep the connection open,
1534 * GNUNET_SYSERR to close it (signal serious error)
1537 GCC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1538 const struct GNUNET_MessageHeader *message)
1540 struct GNUNET_CADET_ConnectionCreate *msg;
1541 struct GNUNET_PeerIdentity *id;
1542 struct GNUNET_CADET_Hash *cid;
1543 struct CadetPeerPath *path;
1544 struct CadetPeer *dest_peer;
1545 struct CadetPeer *orig_peer;
1546 struct CadetConnection *c;
1547 unsigned int own_pos;
1551 size = ntohs (message->size);
1552 if (size < sizeof (struct GNUNET_CADET_ConnectionCreate))
1554 GNUNET_break_op (0);
1558 /* Calculate hops */
1559 size -= sizeof (struct GNUNET_CADET_ConnectionCreate);
1560 if (size % sizeof (struct GNUNET_PeerIdentity))
1562 GNUNET_break_op (0);
1565 size /= sizeof (struct GNUNET_PeerIdentity);
1568 GNUNET_break_op (0);
1571 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1573 /* Get parameters */
1574 msg = (struct GNUNET_CADET_ConnectionCreate *) message;
1576 log_message (message, peer, cid);
1577 id = (struct GNUNET_PeerIdentity *) &msg[1];
1578 LOG (GNUNET_ERROR_TYPE_DEBUG, " origin: %s\n", GNUNET_i2s (id));
1580 /* Create connection */
1581 c = connection_get (cid);
1584 path = build_path_from_peer_ids ((struct GNUNET_PeerIdentity *) &msg[1],
1590 GNUNET_break_op (0);
1591 path_destroy (path);
1594 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1595 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1596 c = GCC_new (cid, NULL, path_duplicate (path), own_pos);
1599 if (path->length - 1 == own_pos)
1601 /* If we are destination, why did the creation fail? */
1605 send_broken_unknown (cid, &my_full_id,
1606 GNUNET_PEER_resolve2 (path->peers[own_pos + 1]),
1608 path_destroy (path);
1611 GCP_add_path_to_all (path, GNUNET_NO);
1612 connection_reset_timeout (c, GNUNET_YES);
1616 path = path_duplicate (c->path);
1618 if (CADET_CONNECTION_NEW == c->state)
1619 connection_change_state (c, CADET_CONNECTION_SENT);
1621 /* Remember peers */
1622 dest_peer = GCP_get (&id[size - 1]);
1623 orig_peer = GCP_get (&id[0]);
1625 /* Is it a connection to us? */
1626 if (c->own_pos == path->length - 1)
1628 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1629 GCP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1631 add_to_peer (c, orig_peer);
1632 if (CADET_TUNNEL_NEW == GCT_get_cstate (c->t))
1633 GCT_change_cstate (c->t, CADET_TUNNEL_WAITING);
1635 send_connection_ack (c, GNUNET_NO);
1636 if (CADET_CONNECTION_SENT == c->state)
1637 connection_change_state (c, CADET_CONNECTION_ACK);
1641 /* It's for somebody else! Retransmit. */
1642 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1643 GCP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1644 GCP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1645 GNUNET_assert (NULL == GCC_send_prebuilt_message (message, 0, 0, c,
1646 GNUNET_YES, GNUNET_YES,
1649 path_destroy (path);
1655 * Core handler for path confirmations.
1657 * @param cls closure
1658 * @param message message
1659 * @param peer peer identity this notification is about
1661 * @return GNUNET_OK to keep the connection open,
1662 * GNUNET_SYSERR to close it (signal serious error)
1665 GCC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1666 const struct GNUNET_MessageHeader *message)
1668 struct GNUNET_CADET_ConnectionACK *msg;
1669 struct CadetConnection *c;
1670 struct CadetPeerPath *p;
1671 struct CadetPeer *pi;
1672 enum CadetConnectionState oldstate;
1675 msg = (struct GNUNET_CADET_ConnectionACK *) message;
1676 log_message (message, peer, &msg->cid);
1677 c = connection_get (&msg->cid);
1680 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1682 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1683 send_broken_unknown (&msg->cid, &my_full_id, NULL, peer);
1687 if (GNUNET_NO != c->destroy)
1689 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1693 oldstate = c->state;
1694 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1695 pi = GCP_get (peer);
1696 if (get_next_hop (c) == pi)
1698 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1700 if (CADET_CONNECTION_SENT == oldstate)
1701 connection_change_state (c, CADET_CONNECTION_ACK);
1703 else if (get_prev_hop (c) == pi)
1705 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1707 connection_change_state (c, CADET_CONNECTION_READY);
1711 GNUNET_break_op (0);
1715 connection_reset_timeout (c, fwd);
1717 /* Add path to peers? */
1721 GCP_add_path_to_all (p, GNUNET_YES);
1728 /* Message for us as creator? */
1729 if (GCC_is_origin (c, GNUNET_YES))
1731 if (GNUNET_NO != fwd)
1733 GNUNET_break_op (0);
1736 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1738 /* If just created, cancel the short timeout and start a long one */
1739 if (CADET_CONNECTION_SENT == oldstate)
1740 connection_reset_timeout (c, GNUNET_YES);
1742 /* Change connection state */
1743 connection_change_state (c, CADET_CONNECTION_READY);
1744 send_connection_ack (c, GNUNET_YES);
1746 /* Change tunnel state, trigger KX */
1747 if (CADET_TUNNEL_WAITING == GCT_get_cstate (c->t))
1748 GCT_change_cstate (c->t, CADET_TUNNEL_READY);
1753 /* Message for us as destination? */
1754 if (GCC_is_terminal (c, GNUNET_YES))
1756 if (GNUNET_YES != fwd)
1758 GNUNET_break_op (0);
1761 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1763 /* If just created, cancel the short timeout and start a long one */
1764 if (CADET_CONNECTION_ACK == oldstate)
1765 connection_reset_timeout (c, GNUNET_NO);
1767 /* Change tunnel state */
1768 if (CADET_TUNNEL_WAITING == GCT_get_cstate (c->t))
1769 GCT_change_cstate (c->t, CADET_TUNNEL_READY);
1774 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1775 GNUNET_assert (NULL == GCC_send_prebuilt_message (message, 0, 0, c, fwd,
1776 GNUNET_YES, NULL, NULL));
1782 * Core handler for notifications of broken connections.
1784 * @param cls Closure (unused).
1785 * @param id Peer identity of sending neighbor.
1786 * @param message Message.
1788 * @return GNUNET_OK to keep the connection open,
1789 * GNUNET_SYSERR to close it (signal serious error)
1792 GCC_handle_broken (void* cls,
1793 const struct GNUNET_PeerIdentity* id,
1794 const struct GNUNET_MessageHeader* message)
1796 struct GNUNET_CADET_ConnectionBroken *msg;
1797 struct CadetConnection *c;
1798 struct CadetTunnel *t;
1801 msg = (struct GNUNET_CADET_ConnectionBroken *) message;
1802 log_message (message, id, &msg->cid);
1803 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1804 GNUNET_i2s (&msg->peer1));
1805 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1806 GNUNET_i2s (&msg->peer2));
1807 c = connection_get (&msg->cid);
1810 LOG (GNUNET_ERROR_TYPE_DEBUG, " duplicate CONNECTION_BROKEN\n");
1815 fwd = is_fwd (c, id);
1816 if (GCC_is_terminal (c, fwd))
1818 struct GNUNET_MessageHeader *out_msg;
1819 struct CadetPeer *neighbor;
1820 struct CadetPeer *endpoint;
1825 /* A terminal connection should not have 't' set to NULL. */
1829 neighbor = get_hop (c, !fwd);
1830 endpoint = GCP_get_short (c->path->peers[c->path->length - 1]);
1831 path_invalidate (c->path);
1832 GCP_notify_broken_link (endpoint, &msg->peer1, &msg->peer2);
1833 c->state = CADET_CONNECTION_DESTROYED;
1834 GCT_remove_connection (t, c);
1836 pending_msgs = c->pending_messages;
1838 /* GCP_connection_pop will destroy the connection when the last message
1839 * is popped! Do not use 'c' after the call. */
1840 while (NULL != (out_msg = GCP_connection_pop (neighbor, c)))
1842 GCT_resend_message (out_msg, t);
1846 /* All pending messages should have been popped and the connection
1847 * destroyed. If not, destroy the connection anyway! */
1848 if (0 < pending_msgs)
1854 GNUNET_break (0 == pending_msgs); /* Counter error! */
1858 GNUNET_assert (NULL == GCC_send_prebuilt_message (message, 0, 0, c, fwd,
1859 GNUNET_YES, NULL, NULL));
1860 c->destroy = GNUNET_YES;
1861 connection_cancel_queues (c, !fwd);
1869 * Core handler for tunnel destruction
1871 * @param cls Closure (unused).
1872 * @param peer Peer identity of sending neighbor.
1873 * @param message Message.
1875 * @return GNUNET_OK to keep the connection open,
1876 * GNUNET_SYSERR to close it (signal serious error)
1879 GCC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1880 const struct GNUNET_MessageHeader *message)
1882 struct GNUNET_CADET_ConnectionDestroy *msg;
1883 struct CadetConnection *c;
1886 msg = (struct GNUNET_CADET_ConnectionDestroy *) message;
1887 log_message (message, peer, &msg->cid);
1888 c = connection_get (&msg->cid);
1891 /* Probably already got the message from another path,
1892 * destroyed the tunnel and retransmitted to children.
1895 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1897 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1900 fwd = is_fwd (c, peer);
1901 if (GNUNET_SYSERR == fwd)
1903 GNUNET_break_op (0); /* FIXME */
1906 if (GNUNET_NO == GCC_is_terminal (c, fwd))
1907 GNUNET_assert (NULL == GCC_send_prebuilt_message (message, 0, 0, c, fwd,
1908 GNUNET_YES, NULL, NULL));
1909 else if (0 == c->pending_messages)
1911 LOG (GNUNET_ERROR_TYPE_DEBUG, " directly destroying connection!\n");
1915 c->destroy = GNUNET_YES;
1916 c->state = CADET_CONNECTION_DESTROYED;
1919 GCT_remove_connection (c->t, c);
1927 * Generic handler for cadet network encrypted traffic.
1929 * @param peer Peer identity this notification is about.
1930 * @param msg Encrypted message.
1932 * @return GNUNET_OK to keep the connection open,
1933 * GNUNET_SYSERR to close it (signal serious error)
1936 handle_cadet_encrypted (const struct GNUNET_PeerIdentity *peer,
1937 const struct GNUNET_CADET_Encrypted *msg)
1939 struct CadetConnection *c;
1940 struct CadetPeer *neighbor;
1941 struct CadetFlowControl *fc;
1942 GNUNET_PEER_Id peer_id;
1948 log_message (&msg->header, peer, &msg->cid);
1951 size = ntohs (msg->header.size);
1953 sizeof (struct GNUNET_CADET_Encrypted) +
1954 sizeof (struct GNUNET_MessageHeader))
1956 GNUNET_break_op (0);
1960 /* Check connection */
1961 c = connection_get (&msg->cid);
1964 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1965 LOG (GNUNET_ERROR_TYPE_DEBUG, "enc on unknown connection %s\n",
1966 GNUNET_h2s (GC_h2hc (&msg->cid)));
1967 send_broken_unknown (&msg->cid, &my_full_id, NULL, peer);
1971 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s\n", GCC_2s (c));
1973 /* Check if origin is as expected */
1974 neighbor = get_prev_hop (c);
1975 peer_id = GNUNET_PEER_search (peer);
1976 if (peer_id == GCP_get_short_id (neighbor))
1982 neighbor = get_next_hop (c);
1983 if (peer_id == GCP_get_short_id (neighbor))
1989 /* Unexpected peer sending traffic on a connection. */
1990 GNUNET_break_op (0);
1996 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1997 pid = ntohl (msg->pid);
1998 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u (expected %u+)\n",
1999 pid, fc->last_pid_recv + 1);
2000 if (GC_is_pid_bigger (pid, fc->last_ack_sent))
2002 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
2003 GNUNET_break_op (0);
2004 LOG (GNUNET_ERROR_TYPE_WARNING,
2005 "Received PID %u, (prev %u), ACK %u\n",
2006 pid, fc->last_pid_recv, fc->last_ack_sent);
2009 if (GNUNET_NO == GC_is_pid_bigger (pid, fc->last_pid_recv))
2011 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
2012 LOG (GNUNET_ERROR_TYPE_DEBUG,
2013 " PID %u not expected (%u+), dropping!\n",
2014 pid, fc->last_pid_recv + 1);
2017 if (CADET_CONNECTION_SENT == c->state || CADET_CONNECTION_ACK == c->state)
2018 connection_change_state (c, CADET_CONNECTION_READY);
2019 connection_reset_timeout (c, fwd);
2020 fc->last_pid_recv = pid;
2022 /* Is this message for us? */
2023 if (GCC_is_terminal (c, fwd))
2025 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
2026 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
2030 GNUNET_break (GNUNET_NO != c->destroy);
2033 fc->last_pid_recv = pid;
2034 GCT_handle_encrypted (c->t, msg);
2035 GCC_send_ack (c, fwd, GNUNET_NO);
2039 /* Message not for us: forward to next hop */
2040 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
2041 ttl = ntohl (msg->ttl);
2042 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
2045 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
2046 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
2047 GCC_send_ack (c, fwd, GNUNET_NO);
2051 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2052 GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2053 GNUNET_NO, NULL, NULL));
2059 * Generic handler for cadet network encrypted traffic.
2061 * @param peer Peer identity this notification is about.
2062 * @param msg Encrypted message.
2064 * @return GNUNET_OK to keep the connection open,
2065 * GNUNET_SYSERR to close it (signal serious error)
2068 handle_cadet_kx (const struct GNUNET_PeerIdentity *peer,
2069 const struct GNUNET_CADET_KX *msg)
2071 struct CadetConnection *c;
2072 struct CadetPeer *neighbor;
2073 GNUNET_PEER_Id peer_id;
2077 log_message (&msg->header, peer, &msg->cid);
2080 size = ntohs (msg->header.size);
2082 sizeof (struct GNUNET_CADET_KX) +
2083 sizeof (struct GNUNET_MessageHeader))
2085 GNUNET_break_op (0);
2089 /* Check connection */
2090 c = connection_get (&msg->cid);
2093 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
2094 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx on unknown connection %s\n",
2095 GNUNET_h2s (GC_h2hc (&msg->cid)));
2096 send_broken_unknown (&msg->cid, &my_full_id, NULL, peer);
2099 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GCC_2s (c));
2101 /* Check if origin is as expected */
2102 neighbor = get_prev_hop (c);
2103 peer_id = GNUNET_PEER_search (peer);
2104 if (peer_id == GCP_get_short_id (neighbor))
2110 neighbor = get_next_hop (c);
2111 if (peer_id == GCP_get_short_id (neighbor))
2117 /* Unexpected peer sending traffic on a connection. */
2118 GNUNET_break_op (0);
2123 /* Count as connection confirmation. */
2124 if (CADET_CONNECTION_SENT == c->state || CADET_CONNECTION_ACK == c->state)
2126 connection_change_state (c, CADET_CONNECTION_READY);
2129 if (CADET_TUNNEL_WAITING == GCT_get_cstate (c->t))
2130 GCT_change_cstate (c->t, CADET_TUNNEL_READY);
2133 connection_reset_timeout (c, fwd);
2135 /* Is this message for us? */
2136 if (GCC_is_terminal (c, fwd))
2138 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
2139 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
2145 GCT_handle_kx (c->t, &msg[1].header);
2149 /* Message not for us: forward to next hop */
2150 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
2151 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2152 GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg->header, 0, 0, c, fwd,
2153 GNUNET_NO, NULL, NULL));
2160 * Core handler for encrypted cadet network traffic (channel mgmt, data).
2162 * @param cls Closure (unused).
2163 * @param message Message received.
2164 * @param peer Peer who sent the message.
2166 * @return GNUNET_OK to keep the connection open,
2167 * GNUNET_SYSERR to close it (signal serious error)
2170 GCC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
2171 const struct GNUNET_MessageHeader *message)
2173 return handle_cadet_encrypted (peer,
2174 (struct GNUNET_CADET_Encrypted *)message);
2179 * Core handler for key exchange traffic (ephemeral key, ping, pong).
2181 * @param cls Closure (unused).
2182 * @param message Message received.
2183 * @param peer Peer who sent the message.
2185 * @return GNUNET_OK to keep the connection open,
2186 * GNUNET_SYSERR to close it (signal serious error)
2189 GCC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
2190 const struct GNUNET_MessageHeader *message)
2192 return handle_cadet_kx (peer,
2193 (struct GNUNET_CADET_KX *) message);
2198 * Core handler for cadet network traffic point-to-point acks.
2200 * @param cls closure
2201 * @param message message
2202 * @param peer peer identity this notification is about
2204 * @return GNUNET_OK to keep the connection open,
2205 * GNUNET_SYSERR to close it (signal serious error)
2208 GCC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
2209 const struct GNUNET_MessageHeader *message)
2211 struct GNUNET_CADET_ACK *msg;
2212 struct CadetConnection *c;
2213 struct CadetFlowControl *fc;
2218 msg = (struct GNUNET_CADET_ACK *) message;
2219 log_message (message, peer, &msg->cid);
2220 c = connection_get (&msg->cid);
2223 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
2225 send_broken_unknown (&msg->cid, &my_full_id, NULL, peer);
2229 /* Is this a forward or backward ACK? */
2230 id = GNUNET_PEER_search (peer);
2231 if (GCP_get_short_id (get_next_hop (c)) == id)
2233 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
2237 else if (GCP_get_short_id (get_prev_hop (c)) == id)
2239 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
2245 GNUNET_break_op (0);
2249 ack = ntohl (msg->ack);
2250 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
2251 ack, fc->last_ack_recv);
2252 if (GC_is_pid_bigger (ack, fc->last_ack_recv))
2253 fc->last_ack_recv = ack;
2255 /* Cancel polling if the ACK is big enough. */
2256 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
2257 GC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2259 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
2260 GNUNET_SCHEDULER_cancel (fc->poll_task);
2261 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2262 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
2265 connection_unlock_queue (c, fwd);
2272 * Core handler for cadet network traffic point-to-point ack polls.
2274 * @param cls closure
2275 * @param message message
2276 * @param peer peer identity this notification is about
2278 * @return GNUNET_OK to keep the connection open,
2279 * GNUNET_SYSERR to close it (signal serious error)
2282 GCC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
2283 const struct GNUNET_MessageHeader *message)
2285 struct GNUNET_CADET_Poll *msg;
2286 struct CadetConnection *c;
2287 struct CadetFlowControl *fc;
2292 msg = (struct GNUNET_CADET_Poll *) message;
2293 log_message (message, peer, &msg->cid);
2294 c = connection_get (&msg->cid);
2297 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
2299 LOG (GNUNET_ERROR_TYPE_DEBUG, "POLL message on unknown connection %s!\n",
2300 GNUNET_h2s (GC_h2hc (&msg->cid)));
2301 send_broken_unknown (&msg->cid, &my_full_id, NULL, peer);
2305 /* Is this a forward or backward ACK?
2306 * Note: a poll should never be needed in a loopback case,
2307 * since there is no possiblility of packet loss there, so
2308 * this way of discerining FWD/BCK should not be a problem.
2310 id = GNUNET_PEER_search (peer);
2311 if (GCP_get_short_id (get_next_hop (c)) == id)
2313 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2316 else if (GCP_get_short_id (get_prev_hop (c)) == id)
2318 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2323 GNUNET_break_op (0);
2327 pid = ntohl (msg->pid);
2328 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2329 fc->last_pid_recv = pid;
2330 fwd = fc == &c->bck_fc;
2331 GCC_send_ack (c, fwd, GNUNET_YES);
2338 * Send an ACK on the appropriate connection/channel, depending on
2339 * the direction and the position of the peer.
2341 * @param c Which connection to send the hop-by-hop ACK.
2342 * @param fwd Is this a fwd ACK? (will go dest->root).
2343 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2346 GCC_send_ack (struct CadetConnection *c, int fwd, int force)
2348 unsigned int buffer;
2350 LOG (GNUNET_ERROR_TYPE_DEBUG,
2351 "GMC send %s ACK on %s\n",
2352 GC_f2s (fwd), GCC_2s (c));
2360 if (GNUNET_NO != c->destroy)
2362 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2366 /* Get available buffer space */
2367 if (GCC_is_terminal (c, fwd))
2369 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2370 buffer = GCT_get_channels_buffer (c->t);
2374 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2375 buffer = GCC_get_buffer (c, fwd);
2377 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2378 if (0 == buffer && GNUNET_NO == force)
2381 /* Send available buffer space */
2382 if (GCC_is_origin (c, fwd))
2384 GNUNET_assert (NULL != c->t);
2385 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2386 GCT_unchoke_channels (c->t);
2390 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2391 send_ack (c, buffer, fwd, force);
2397 * Initialize the connections subsystem
2399 * @param c Configuration handle.
2402 GCC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2404 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2406 GNUNET_CONFIGURATION_get_value_number (c, "CADET", "MAX_MSGS_QUEUE",
2409 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2410 "CADET", "MAX_MSGS_QUEUE", "MISSING");
2411 GNUNET_SCHEDULER_shutdown ();
2416 GNUNET_CONFIGURATION_get_value_number (c, "CADET", "MAX_CONNECTIONS",
2419 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2420 "CADET", "MAX_CONNECTIONS", "MISSING");
2421 GNUNET_SCHEDULER_shutdown ();
2426 GNUNET_CONFIGURATION_get_value_time (c, "CADET", "REFRESH_CONNECTION_TIME",
2427 &refresh_connection_time))
2429 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2430 "CADET", "REFRESH_CONNECTION_TIME", "MISSING");
2431 GNUNET_SCHEDULER_shutdown ();
2434 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2435 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
2440 * Destroy each connection on shutdown.
2442 * @param cls Closure (unused).
2443 * @param key Current key code (CID, unused).
2444 * @param value Value in the hash map (connection)
2446 * @return #GNUNET_YES, because we should continue to iterate,
2449 shutdown_iterator (void *cls,
2450 const struct GNUNET_HashCode *key,
2453 struct CadetConnection *c = value;
2461 * Shut down the connections subsystem.
2466 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2467 GNUNET_CONTAINER_multihashmap_destroy (connections);
2472 struct CadetConnection *
2473 GCC_new (const struct GNUNET_CADET_Hash *cid,
2474 struct CadetTunnel *t,
2475 struct CadetPeerPath *p,
2476 unsigned int own_pos)
2478 struct CadetConnection *c;
2480 c = GNUNET_new (struct CadetConnection);
2482 GNUNET_assert (GNUNET_OK ==
2483 GNUNET_CONTAINER_multihashmap_put (connections,
2485 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2486 fc_init (&c->fwd_fc);
2487 fc_init (&c->bck_fc);
2492 GNUNET_assert (own_pos <= p->length - 1);
2493 c->own_pos = own_pos;
2497 if (GNUNET_OK != register_neighbors (c))
2501 path_invalidate (c->path);
2514 GCC_destroy (struct CadetConnection *c)
2522 if (2 == c->destroy) /* cancel queues -> GCP_queue_cancel -> q_destroy -> */
2523 return; /* -> message_sent -> GCC_destroy. Don't loop. */
2526 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GCC_2s (c));
2527 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2528 &c->fwd_fc, &c->bck_fc);
2529 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2530 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2532 /* Cancel all traffic */
2533 if (NULL != c->path)
2535 connection_cancel_queues (c, GNUNET_YES);
2536 connection_cancel_queues (c, GNUNET_NO);
2537 unregister_neighbors (c);
2540 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2541 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2543 /* Cancel maintainance task (keepalive/timeout) */
2544 if (NULL != c->fwd_fc.poll_msg)
2546 GCC_cancel (c->fwd_fc.poll_msg);
2547 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2549 if (NULL != c->bck_fc.poll_msg)
2551 GCC_cancel (c->bck_fc.poll_msg);
2552 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2555 /* Delete from tunnel */
2557 GCT_remove_connection (c->t, c);
2559 if (GNUNET_NO == GCC_is_origin (c, GNUNET_YES) && NULL != c->path)
2560 path_destroy (c->path);
2561 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2562 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2563 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2564 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2565 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2567 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2568 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2570 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2572 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2573 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2576 GNUNET_break (GNUNET_YES ==
2577 GNUNET_CONTAINER_multihashmap_remove (connections,
2580 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2585 * Get the connection ID.
2587 * @param c Connection to get the ID from.
2589 * @return ID of the connection.
2591 const struct GNUNET_CADET_Hash *
2592 GCC_get_id (const struct CadetConnection *c)
2599 * Get the connection ID.
2601 * @param c Connection to get the ID from.
2603 * @return ID of the connection.
2605 const struct GNUNET_HashCode *
2606 GCC_get_h (const struct CadetConnection *c)
2608 return GC_h2hc (&c->id);
2613 * Get the connection path.
2615 * @param c Connection to get the path from.
2617 * @return path used by the connection.
2619 const struct CadetPeerPath *
2620 GCC_get_path (const struct CadetConnection *c)
2622 if (GNUNET_NO == c->destroy)
2629 * Get the connection state.
2631 * @param c Connection to get the state from.
2633 * @return state of the connection.
2635 enum CadetConnectionState
2636 GCC_get_state (const struct CadetConnection *c)
2642 * Get the connection tunnel.
2644 * @param c Connection to get the tunnel from.
2646 * @return tunnel of the connection.
2648 struct CadetTunnel *
2649 GCC_get_tunnel (const struct CadetConnection *c)
2656 * Get free buffer space in a connection.
2658 * @param c Connection.
2659 * @param fwd Is query about FWD traffic?
2661 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2664 GCC_get_buffer (struct CadetConnection *c, int fwd)
2666 struct CadetFlowControl *fc;
2668 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2670 return (fc->queue_max - fc->queue_n);
2674 * Get how many messages have we allowed to send to us from a direction.
2676 * @param c Connection.
2677 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2679 * @return last_ack_sent - last_pid_recv
2682 GCC_get_allowed (struct CadetConnection *c, int fwd)
2684 struct CadetFlowControl *fc;
2686 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2687 if (GC_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2691 return (fc->last_ack_sent - fc->last_pid_recv);
2695 * Get messages queued in a connection.
2697 * @param c Connection.
2698 * @param fwd Is query about FWD traffic?
2700 * @return Number of messages queued.
2703 GCC_get_qn (struct CadetConnection *c, int fwd)
2705 struct CadetFlowControl *fc;
2707 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2714 * Get next PID to use.
2716 * @param c Connection.
2717 * @param fwd Is query about FWD traffic?
2719 * @return Last PID used + 1.
2722 GCC_get_pid (struct CadetConnection *c, int fwd)
2724 struct CadetFlowControl *fc;
2726 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2728 return fc->last_pid_sent + 1;
2733 * Allow the connection to advertise a buffer of the given size.
2735 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2736 * allowing up to last_pid_recv + buffer.
2738 * @param c Connection.
2739 * @param buffer How many more messages the connection can accept.
2740 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2743 GCC_allow (struct CadetConnection *c, unsigned int buffer, int fwd)
2745 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowing %s %u messages %s\n",
2746 GCC_2s (c), buffer, GC_f2s (fwd));
2747 send_ack (c, buffer, fwd, GNUNET_NO);
2752 * Notify other peers on a connection of a broken link. Mark connections
2753 * to destroy after all traffic has been sent.
2755 * @param c Connection on which there has been a disconnection.
2756 * @param peer Peer that disconnected.
2759 GCC_notify_broken (struct CadetConnection *c,
2760 struct CadetPeer *peer)
2764 LOG (GNUNET_ERROR_TYPE_DEBUG,
2765 " notify broken on %s due to %s disconnect\n",
2766 GCC_2s (c), GCP_2s (peer));
2768 fwd = peer == get_prev_hop (c);
2770 if (GNUNET_YES == GCC_is_terminal (c, fwd))
2772 /* Local shutdown, no one to notify about this. */
2776 if (GNUNET_NO == c->destroy)
2777 send_broken (c, &my_full_id, GCP_get_id (peer), fwd);
2779 /* Connection will have at least one pending message
2780 * (the one we just scheduled), so no point in checking whether to
2781 * destroy immediately. */
2782 c->destroy = GNUNET_YES;
2783 c->state = CADET_CONNECTION_DESTROYED;
2786 * Cancel all queues, if no message is left, connection will be destroyed.
2788 connection_cancel_queues (c, !fwd);
2795 * Is this peer the first one on the connection?
2797 * @param c Connection.
2798 * @param fwd Is this about fwd traffic?
2800 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2803 GCC_is_origin (struct CadetConnection *c, int fwd)
2805 if (!fwd && c->path->length - 1 == c->own_pos )
2807 if (fwd && 0 == c->own_pos)
2814 * Is this peer the last one on the connection?
2816 * @param c Connection.
2817 * @param fwd Is this about fwd traffic?
2818 * Note that the ROOT is the terminal for BCK traffic!
2820 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2823 GCC_is_terminal (struct CadetConnection *c, int fwd)
2825 return GCC_is_origin (c, !fwd);
2830 * See if we are allowed to send by the next hop in the given direction.
2832 * @param c Connection.
2833 * @param fwd Is this about fwd traffic?
2835 * @return #GNUNET_YES in case it's OK to send.
2838 GCC_is_sendable (struct CadetConnection *c, int fwd)
2840 struct CadetFlowControl *fc;
2842 LOG (GNUNET_ERROR_TYPE_DEBUG, " checking sendability of %s traffic on %s\n",
2843 GC_f2s (fwd), GCC_2s (c));
2849 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2850 LOG (GNUNET_ERROR_TYPE_DEBUG,
2851 " last ack recv: %u, last pid sent: %u\n",
2852 fc->last_ack_recv, fc->last_pid_sent);
2853 if (GC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2855 LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable\n");
2858 LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
2864 * Check if this connection is a direct one (never trim a direct connection).
2866 * @param c Connection.
2868 * @return #GNUNET_YES in case it's a direct connection, #GNUNET_NO otherwise.
2871 GCC_is_direct (struct CadetConnection *c)
2873 return (c->path->length == 2) ? GNUNET_YES : GNUNET_NO;
2877 * Sends an already built message on a connection, properly registering
2878 * all used resources.
2880 * @param message Message to send. Function makes a copy of it.
2881 * If message is not hop-by-hop, decrements TTL of copy.
2882 * @param payload_type Type of payload, in case the message is encrypted.
2883 * @param c Connection on which this message is transmitted.
2884 * @param fwd Is this a fwd message?
2885 * @param force Force the connection to accept the message (buffer overfill).
2886 * @param cont Continuation called once message is sent. Can be NULL.
2887 * @param cont_cls Closure for @c cont.
2889 * @return Handle to cancel the message before it's sent.
2890 * NULL on error or if @c cont is NULL.
2891 * Invalid on @c cont call.
2893 struct CadetConnectionQueue *
2894 GCC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2895 uint16_t payload_type, uint32_t payload_id,
2896 struct CadetConnection *c, int fwd, int force,
2897 GCC_sent cont, void *cont_cls)
2899 struct CadetFlowControl *fc;
2900 struct CadetConnectionQueue *q;
2906 size = ntohs (message->size);
2907 data = GNUNET_malloc (size);
2908 memcpy (data, message, size);
2909 type = ntohs (message->type);
2910 LOG (GNUNET_ERROR_TYPE_INFO, "--> %s (%s %u) on connection %s (%u bytes)\n",
2911 GC_m2s (type), GC_m2s (payload_type), payload_id, GCC_2s (c), size);
2913 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2914 droppable = GNUNET_NO == force;
2917 struct GNUNET_CADET_Encrypted *emsg;
2918 struct GNUNET_CADET_KX *kmsg;
2919 struct GNUNET_CADET_ACK *amsg;
2920 struct GNUNET_CADET_Poll *pmsg;
2921 struct GNUNET_CADET_ConnectionDestroy *dmsg;
2922 struct GNUNET_CADET_ConnectionBroken *bmsg;
2925 case GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED:
2926 emsg = (struct GNUNET_CADET_Encrypted *) data;
2927 ttl = ntohl (emsg->ttl);
2930 GNUNET_break_op (0);
2935 emsg->ttl = htonl (ttl - 1);
2936 emsg->pid = htonl (0);
2937 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2938 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2939 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2940 if (GNUNET_YES == droppable)
2946 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2948 if (GC_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2950 GCC_start_poll (c, fwd);
2954 case GNUNET_MESSAGE_TYPE_CADET_KX:
2955 kmsg = (struct GNUNET_CADET_KX *) data;
2959 case GNUNET_MESSAGE_TYPE_CADET_ACK:
2960 amsg = (struct GNUNET_CADET_ACK *) data;
2962 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2963 droppable = GNUNET_NO;
2966 case GNUNET_MESSAGE_TYPE_CADET_POLL:
2967 pmsg = (struct GNUNET_CADET_Poll *) data;
2969 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2970 droppable = GNUNET_NO;
2973 case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY:
2974 dmsg = (struct GNUNET_CADET_ConnectionDestroy *) data;
2978 case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN:
2979 bmsg = (struct GNUNET_CADET_ConnectionBroken *) data;
2983 case GNUNET_MESSAGE_TYPE_CADET_KEEPALIVE:
2986 case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE:
2987 case GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK:
2996 if (fc->queue_n > fc->queue_max && droppable)
2998 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
3001 LOG (GNUNET_ERROR_TYPE_DEBUG, "queue full: %u/%u\n",
3002 fc->queue_n, fc->queue_max);
3003 if (GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED == type)
3008 return NULL; /* Drop this message */
3011 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %s %u\n",
3012 GCC_2s (c), c->pending_messages);
3013 c->pending_messages++;
3015 q = GNUNET_new (struct CadetConnectionQueue);
3016 q->forced = !droppable;
3017 q->q = GCP_queue_add (get_hop (c, fwd), data, type, payload_type, payload_id,
3018 size, c, fwd, &conn_message_sent, q);
3021 LOG (GNUNET_ERROR_TYPE_DEBUG, "dropping msg on %s, NULL q\n", GCC_2s (c));
3027 q->cont_cls = cont_cls;
3028 return (NULL == cont) ? NULL : q;
3033 * Cancel a previously sent message while it's in the queue.
3035 * ONLY can be called before the continuation given to the send function
3036 * is called. Once the continuation is called, the message is no longer in the
3039 * @param q Handle to the queue.
3042 GCC_cancel (struct CadetConnectionQueue *q)
3044 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
3046 /* queue destroy calls message_sent, which calls q->cont and frees q */
3047 GCP_queue_destroy (q->q, GNUNET_YES, GNUNET_NO, 0);
3052 * Sends a CREATE CONNECTION message for a path to a peer.
3053 * Changes the connection and tunnel states if necessary.
3055 * @param connection Connection to create.
3058 GCC_send_create (struct CadetConnection *connection)
3060 enum CadetTunnelCState state;
3063 size = sizeof (struct GNUNET_CADET_ConnectionCreate);
3064 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
3066 LOG (GNUNET_ERROR_TYPE_INFO, "===> %s on connection %s (%u bytes)\n",
3067 GC_m2s (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE),
3068 GCC_2s (connection), size);
3069 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
3070 connection, connection->pending_messages);
3071 connection->pending_messages++;
3073 connection->maintenance_q =
3074 GCP_queue_add (get_next_hop (connection), NULL,
3075 GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE, 0, 0,
3076 size, connection, GNUNET_YES, &conn_message_sent, NULL);
3078 state = GCT_get_cstate (connection->t);
3079 if (CADET_TUNNEL_SEARCHING == state || CADET_TUNNEL_NEW == state)
3080 GCT_change_cstate (connection->t, CADET_TUNNEL_WAITING);
3081 if (CADET_CONNECTION_NEW == connection->state)
3082 connection_change_state (connection, CADET_CONNECTION_SENT);
3087 * Send a message to all peers in this connection that the connection
3088 * is no longer valid.
3090 * If some peer should not receive the message, it should be zero'ed out
3091 * before calling this function.
3093 * @param c The connection whose peers to notify.
3096 GCC_send_destroy (struct CadetConnection *c)
3098 struct GNUNET_CADET_ConnectionDestroy msg;
3100 if (GNUNET_YES == c->destroy)
3103 msg.header.size = htons (sizeof (msg));
3104 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY);
3106 LOG (GNUNET_ERROR_TYPE_DEBUG,
3107 " sending connection destroy for connection %s\n",
3110 if (GNUNET_NO == GCC_is_terminal (c, GNUNET_YES))
3111 GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg.header, 0, 0, c,
3112 GNUNET_YES, GNUNET_YES,
3114 if (GNUNET_NO == GCC_is_terminal (c, GNUNET_NO))
3115 GNUNET_assert (NULL == GCC_send_prebuilt_message (&msg.header, 0, 0, c,
3116 GNUNET_NO, GNUNET_YES,
3118 c->destroy = GNUNET_YES;
3119 c->state = CADET_CONNECTION_DESTROYED;
3124 * @brief Start a polling timer for the connection.
3126 * When a neighbor does not accept more traffic on the connection it could be
3127 * caused by a simple congestion or by a lost ACK. Polling enables to check
3128 * for the lastest ACK status for a connection.
3130 * @param c Connection.
3131 * @param fwd Should we poll in the FWD direction?
3134 GCC_start_poll (struct CadetConnection *c, int fwd)
3136 struct CadetFlowControl *fc;
3138 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3139 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
3141 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
3143 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
3144 fc->poll_task, fc->poll_msg);
3147 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
3148 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
3155 * @brief Stop polling a connection for ACKs.
3157 * Once we have enough ACKs for future traffic, polls are no longer necessary.
3159 * @param c Connection.
3160 * @param fwd Should we stop the poll in the FWD direction?
3163 GCC_stop_poll (struct CadetConnection *c, int fwd)
3165 struct CadetFlowControl *fc;
3167 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3168 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
3170 GNUNET_SCHEDULER_cancel (fc->poll_task);
3171 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
3176 * Get a (static) string for a connection.
3178 * @param c Connection.
3181 GCC_2s (const struct CadetConnection *c)
3188 static char buf[128];
3190 sprintf (buf, "%s (->%s)",
3191 GNUNET_h2s (GC_h2hc (GCC_get_id (c))), GCT_2s (c->t));
3194 return GNUNET_h2s (GC_h2hc (&c->id));
3199 * Log all possible info about the connection state.
3201 * @param c Connection to debug.
3202 * @param level Debug level to use.
3205 GCC_debug (const struct CadetConnection *c, enum GNUNET_ErrorType level)
3210 do_log = GNUNET_get_log_call_status (level & (~GNUNET_ERROR_TYPE_BULK),
3212 __FILE__, __FUNCTION__, __LINE__);
3218 LOG2 (level, "CCC DEBUG NULL CONNECTION\n");
3222 LOG2 (level, "CCC DEBUG CONNECTION %s\n", GCC_2s (c));
3223 s = path_2s (c->path);
3224 LOG2 (level, "CCC path %s, own pos: %u\n", s, c->own_pos);
3226 LOG2 (level, "CCC state: %s, destroy: %u\n",
3227 GCC_state2s (c->state), c->destroy);
3228 LOG2 (level, "CCC pending messages: %u\n", c->pending_messages);
3229 if (NULL != c->perf)
3230 LOG2 (level, "CCC us/byte: %f\n", c->perf->avg);
3232 LOG2 (level, "CCC FWD flow control:\n");
3233 LOG2 (level, "CCC queue: %u/%u\n", c->fwd_fc.queue_n, c->fwd_fc.queue_max);
3234 LOG2 (level, "CCC last PID sent: %5u, recv: %5u\n",
3235 c->fwd_fc.last_pid_sent, c->fwd_fc.last_pid_recv);
3236 LOG2 (level, "CCC last ACK sent: %5u, recv: %5u\n",
3237 c->fwd_fc.last_ack_sent, c->fwd_fc.last_ack_recv);
3238 LOG2 (level, "CCC POLL: task %d, msg %p, msg_ack %p)\n",
3239 c->fwd_fc.poll_task, c->fwd_fc.poll_msg, c->fwd_fc.ack_msg);
3241 LOG2 (level, "CCC BCK flow control:\n");
3242 LOG2 (level, "CCC queue: %u/%u\n", c->bck_fc.queue_n, c->bck_fc.queue_max);
3243 LOG2 (level, "CCC last PID sent: %5u, recv: %5u\n",
3244 c->bck_fc.last_pid_sent, c->bck_fc.last_pid_recv);
3245 LOG2 (level, "CCC last ACK sent: %5u, recv: %5u\n",
3246 c->bck_fc.last_ack_sent, c->bck_fc.last_ack_recv);
3247 LOG2 (level, "CCC POLL: task %d, msg %p, msg_ack %p)\n",
3248 c->bck_fc.poll_task, c->bck_fc.poll_msg, c->bck_fc.ack_msg);
3250 LOG2 (level, "CCC DEBUG CONNECTION END\n");