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 mesh/gnunet-service-mesh_connection.c
23 * @brief GNUnet MESH service connection handling
24 * @author Bartlomiej Polot
28 #include "gnunet_util_lib.h"
30 #include "gnunet_statistics_service.h"
32 #include "mesh_path.h"
33 #include "mesh_protocol.h"
35 #include "gnunet-service-mesh_connection.h"
36 #include "gnunet-service-mesh_peer.h"
37 #include "gnunet-service-mesh_tunnel.h"
40 #define LOG(level, ...) GNUNET_log_from (level,"mesh-con",__VA_ARGS__)
42 #define MESH_MAX_POLL_TIME GNUNET_TIME_relative_multiply (\
43 GNUNET_TIME_UNIT_MINUTES,\
48 /******************************************************************************/
49 /******************************** STRUCTS **********************************/
50 /******************************************************************************/
53 * Struct to encapsulate all the Flow Control information to a peer to which
54 * we are directly connected (on a core level).
56 struct MeshFlowControl
59 * Connection this controls.
61 struct MeshConnection *c;
64 * How many messages are in the queue on this connection.
69 * How many messages do we accept in the queue.
71 unsigned int queue_max;
79 * ID of the last packet sent towards the peer.
81 uint32_t last_pid_sent;
84 * ID of the last packet received from the peer.
86 uint32_t last_pid_recv;
89 * Last ACK sent to the peer (peer can't send more than this PID).
91 uint32_t last_ack_sent;
94 * Last ACK sent towards the origin (for traffic towards leaf node).
96 uint32_t last_ack_recv;
99 * Task to poll the peer in case of a lost ACK causes stall.
101 GNUNET_SCHEDULER_TaskIdentifier poll_task;
104 * How frequently to poll for ACKs.
106 struct GNUNET_TIME_Relative poll_time;
109 * Queued poll message, to cancel if not necessary anymore (got ACK).
111 struct MeshConnectionQueue *poll_msg;
114 * Queued poll message, to cancel if not necessary anymore (got ACK).
116 struct MeshConnectionQueue *ack_msg;
120 * Keep a record of the last messages sent on this connection.
122 struct MeshConnectionPerformance
125 * Circular buffer for storing measurements.
127 double usecsperbyte[AVG_MSGS];
130 * Running average of @c usecsperbyte.
135 * How many values of @c usecsperbyte are valid.
140 * Index of the next "free" position in @c usecsperbyte.
147 * Struct containing all information regarding a connection to a peer.
149 struct MeshConnection
152 * Tunnel this connection is part of.
154 struct MeshTunnel3 *t;
157 * Flow control information for traffic fwd.
159 struct MeshFlowControl fwd_fc;
162 * Flow control information for traffic bck.
164 struct MeshFlowControl bck_fc;
167 * Measure connection performance on the endpoint.
169 struct MeshConnectionPerformance *perf;
172 * ID of the connection.
174 struct GNUNET_HashCode id;
177 * State of the connection.
179 enum MeshConnectionState state;
182 * Path being used for the tunnel. At the origin of the connection
183 * it's a pointer to the destination's path pool, otherwise just a copy.
185 struct MeshPeerPath *path;
188 * Position of the local peer in the path.
190 unsigned int own_pos;
193 * Task to keep the used paths alive at the owner,
194 * time tunnel out on all the other peers.
196 GNUNET_SCHEDULER_TaskIdentifier fwd_maintenance_task;
199 * Task to keep the used paths alive at the destination,
200 * time tunnel out on all the other peers.
202 GNUNET_SCHEDULER_TaskIdentifier bck_maintenance_task;
205 * Queue handle for maintainance traffic. One handle for FWD and BCK since
206 * one peer never needs to maintain both directions (no loopback connections).
208 struct MeshPeerQueue *maintenance_q;
211 * Counter to do exponential backoff when creating a connection (max 64).
213 unsigned short create_retry;
216 * Pending message count.
218 int pending_messages;
221 * Destroy flag: if true, destroy on last message.
227 * Handle for messages queued but not yet sent.
229 struct MeshConnectionQueue
232 * Peer queue handle, to cancel if necessary.
234 struct MeshPeerQueue *q;
237 * Was this a forced message? (Do not account for it)
242 * Continuation to call once sent.
247 * Closure for @c cont.
252 /******************************************************************************/
253 /******************************* GLOBALS ***********************************/
254 /******************************************************************************/
257 * Global handle to the statistics service.
259 extern struct GNUNET_STATISTICS_Handle *stats;
262 * Local peer own ID (memory efficient handle).
264 extern GNUNET_PEER_Id myid;
267 * Local peer own ID (full value).
269 extern struct GNUNET_PeerIdentity my_full_id;
272 * Connections known, indexed by cid (MeshConnection).
274 static struct GNUNET_CONTAINER_MultiHashMap *connections;
277 * How many connections are we willing to maintain.
278 * Local connections are always allowed, even if there are more connections than max.
280 static unsigned long long max_connections;
283 * How many messages *in total* are we willing to queue, divide by number of
284 * connections to get connection queue size.
286 static unsigned long long max_msgs_queue;
289 * How often to send path keepalives. Paths timeout after 4 missed.
291 static struct GNUNET_TIME_Relative refresh_connection_time;
294 * How often to send path create / ACKs.
296 static struct GNUNET_TIME_Relative create_connection_time;
299 /******************************************************************************/
300 /******************************** STATIC ***********************************/
301 /******************************************************************************/
303 #if 0 // avoid compiler warning for unused static function
305 fc_debug (struct MeshFlowControl *fc)
307 LOG (GNUNET_ERROR_TYPE_DEBUG, " IN: %u/%u\n",
308 fc->last_pid_recv, fc->last_ack_sent);
309 LOG (GNUNET_ERROR_TYPE_DEBUG, " OUT: %u/%u\n",
310 fc->last_pid_sent, fc->last_ack_recv);
311 LOG (GNUNET_ERROR_TYPE_DEBUG, " QUEUE: %u/%u\n",
312 fc->queue_n, fc->queue_max);
316 connection_debug (struct MeshConnection *c)
320 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CONNECTION ***\n");
323 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s:%X\n",
324 peer2s (c->t->peer), GMC_2s (c));
325 LOG (GNUNET_ERROR_TYPE_DEBUG, " state: %u, pending msgs: %u\n",
326 c->state, c->pending_messages);
327 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
328 fc_debug (&c->fwd_fc);
329 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
330 fc_debug (&c->bck_fc);
336 * Schedule next keepalive task, taking in consideration
337 * the connection state and number of retries.
339 * @param c Connection for which to schedule the next keepalive.
340 * @param fwd Direction for the next keepalive.
343 schedule_next_keepalive (struct MeshConnection *c, int fwd);
347 * Get string description for tunnel state.
349 * @param s Tunnel state.
351 * @return String representation.
354 GMC_state2s (enum MeshConnectionState s)
358 case MESH_CONNECTION_NEW:
359 return "MESH_CONNECTION_NEW";
360 case MESH_CONNECTION_SENT:
361 return "MESH_CONNECTION_SENT";
362 case MESH_CONNECTION_ACK:
363 return "MESH_CONNECTION_ACK";
364 case MESH_CONNECTION_READY:
365 return "MESH_CONNECTION_READY";
366 case MESH_CONNECTION_DESTROYED:
367 return "MESH_CONNECTION_DESTROYED";
369 return "MESH_CONNECTION_STATE_ERROR";
375 * Initialize a Flow Control structure to the initial state.
377 * @param fc Flow Control structure to initialize.
380 fc_init (struct MeshFlowControl *fc)
383 fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
384 fc->last_pid_recv = (uint32_t) -1;
385 fc->last_ack_sent = (uint32_t) 0;
386 fc->last_ack_recv = (uint32_t) 0;
387 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
388 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
390 fc->queue_max = (max_msgs_queue / max_connections) + 1;
397 * @param cid Connection ID.
399 static struct MeshConnection *
400 connection_get (const struct GNUNET_HashCode *cid)
402 return GNUNET_CONTAINER_multihashmap_get (connections, cid);
407 connection_change_state (struct MeshConnection* c,
408 enum MeshConnectionState state)
410 LOG (GNUNET_ERROR_TYPE_DEBUG,
411 "Connection %s state was %s\n",
412 GMC_2s (c), GMC_state2s (c->state));
413 if (MESH_CONNECTION_DESTROYED == c->state)
415 LOG (GNUNET_ERROR_TYPE_DEBUG, "state not changing anymore\n");
418 LOG (GNUNET_ERROR_TYPE_DEBUG,
419 "Connection %s state is now %s\n",
420 GMC_2s (c), GMC_state2s (state));
422 if (MESH_CONNECTION_READY == state)
428 * Callback called when a queued ACK message is sent.
430 * @param cls Closure (FC).
431 * @param c Connection this message was on.
432 * @param q Queue handler this call invalidates.
433 * @param type Type of message sent.
434 * @param fwd Was this a FWD going message?
435 * @param size Size of the message.
439 struct MeshConnection *c,
440 struct MeshConnectionQueue *q,
441 uint16_t type, int fwd, size_t size)
443 struct MeshFlowControl *fc = cls;
450 * Send an ACK on the connection, informing the predecessor about
451 * the available buffer space. Should not be called in case the peer
452 * is origin (no predecessor) in the @c fwd direction.
454 * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
455 * the ACK itself goes "back" (dest->root).
457 * @param c Connection on which to send the ACK.
458 * @param buffer How much space free to advertise?
459 * @param fwd Is this FWD ACK? (Going dest -> root)
460 * @param force Don't optimize out.
463 send_ack (struct MeshConnection *c, unsigned int buffer, int fwd, int force)
465 struct MeshFlowControl *next_fc;
466 struct MeshFlowControl *prev_fc;
467 struct GNUNET_MESH_ACK msg;
471 /* If origin, there is no connection to send ACKs. Wrong function! */
472 if (GMC_is_origin (c, fwd))
474 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection %s is origin in %s\n",
475 GMC_2s (c), GM_f2s (fwd));
480 next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
481 prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
483 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection send %s ack on %s\n",
484 GM_f2s (fwd), GMC_2s (c));
486 /* Check if we need to transmit the ACK. */
487 delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
488 if (3 < delta && buffer < delta && GNUNET_NO == force)
490 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
491 LOG (GNUNET_ERROR_TYPE_DEBUG,
492 " last pid recv: %u, last ack sent: %u\n",
493 prev_fc->last_pid_recv, prev_fc->last_ack_sent);
497 /* Ok, ACK might be necessary, what PID to ACK? */
498 ack = prev_fc->last_pid_recv + buffer;
499 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
500 LOG (GNUNET_ERROR_TYPE_DEBUG,
501 " last pid %u, last ack %u, qmax %u, q %u\n",
502 prev_fc->last_pid_recv, prev_fc->last_ack_sent,
503 next_fc->queue_max, next_fc->queue_n);
504 if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
506 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
510 /* Check if message is already in queue */
511 if (NULL != prev_fc->ack_msg)
513 if (GM_is_pid_bigger (ack, prev_fc->last_ack_sent))
515 LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
516 GMC_cancel (prev_fc->ack_msg);
517 /* GMC_cancel triggers ack_sent(), which clears fc->ack_msg */
521 LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
526 prev_fc->last_ack_sent = ack;
528 /* Build ACK message and send on connection */
529 msg.header.size = htons (sizeof (msg));
530 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
531 msg.ack = htonl (ack);
534 prev_fc->ack_msg = GMC_send_prebuilt_message (&msg.header, c,
541 * Callback called when a queued message is sent.
543 * Calculates the average time and connection packet tracking.
545 * @param cls Closure (ConnectionQueue Handle).
546 * @param c Connection this message was on.
547 * @param type Type of message sent.
548 * @param fwd Was this a FWD going message?
549 * @param size Size of the message.
550 * @param wait Time spent waiting for core (only the time for THIS message)
553 message_sent (void *cls,
554 struct MeshConnection *c, uint16_t type,
555 int fwd, size_t size,
556 struct GNUNET_TIME_Relative wait)
558 struct MeshConnectionPerformance *p;
559 struct MeshFlowControl *fc;
560 struct MeshConnectionQueue *q = cls;
564 fc = fwd ? &c->fwd_fc : &c->bck_fc;
565 LOG (GNUNET_ERROR_TYPE_DEBUG,
569 LOG (GNUNET_ERROR_TYPE_DEBUG, "! C_P- %p %u\n", c, c->pending_messages);
575 LOG (GNUNET_ERROR_TYPE_DEBUG, "! calling cont\n");
576 q->cont (q->cont_cls, c, q, type, fwd, size);
580 else if (type == GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED)
582 /* If NULL == q and ENCRYPTED == type, message must have been ch_mngmnt */
589 c->pending_messages--;
590 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
592 LOG (GNUNET_ERROR_TYPE_DEBUG, "! destroying connection!\n");
596 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
599 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
600 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
601 c->maintenance_q = NULL;
602 /* Don't trigger a keepalive for sent ACKs, only SYN and SYNACKs */
603 if (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE == type || !fwd)
604 schedule_next_keepalive (c, fwd);
607 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
609 LOG (GNUNET_ERROR_TYPE_DEBUG, "! Q_N- %p %u\n", fc, fc->queue_n);
610 if (GNUNET_NO == forced)
613 LOG (GNUNET_ERROR_TYPE_DEBUG,
614 "! accounting pid %u\n",
619 LOG (GNUNET_ERROR_TYPE_DEBUG,
620 "! forced, Q_N not accounting pid %u\n",
623 GMC_send_ack (c, fwd, GNUNET_NO);
626 case GNUNET_MESSAGE_TYPE_MESH_POLL:
630 case GNUNET_MESSAGE_TYPE_MESH_ACK:
637 LOG (GNUNET_ERROR_TYPE_DEBUG, "! message sent!\n");
640 return; /* Only endpoints are interested in timing. */
643 usecsperbyte = ((double) wait.rel_value_us) / size;
644 if (p->size == AVG_MSGS)
646 /* Array is full. Substract oldest value, add new one and store. */
647 p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
648 p->usecsperbyte[p->idx] = usecsperbyte;
649 p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
653 /* Array not yet full. Add current value to avg and store. */
654 p->usecsperbyte[p->idx] = usecsperbyte;
656 p->avg += p->usecsperbyte[p->idx];
660 p->idx = (p->idx + 1) % AVG_MSGS;
665 * Get the previous hop in a connection
667 * @param c Connection.
669 * @return Previous peer in the connection.
671 static struct MeshPeer *
672 get_prev_hop (const struct MeshConnection *c)
676 LOG (GNUNET_ERROR_TYPE_DEBUG, " get prev hop %s [%u/%u]\n",
677 GMC_2s (c), c->own_pos, c->path->length);
678 if (0 == c->own_pos || c->path->length < 2)
680 LOG (GNUNET_ERROR_TYPE_DEBUG, " own pos is zero\n");
681 id = c->path->peers[0];
685 LOG (GNUNET_ERROR_TYPE_DEBUG, " own pos is NOT zero\n");
686 id = c->path->peers[c->own_pos - 1];
689 LOG (GNUNET_ERROR_TYPE_DEBUG, " id: %u\n", id);
690 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s\n", GNUNET_i2s (GNUNET_PEER_resolve2 (id)));
691 return GMP_get_short (id);
696 * Get the next hop in a connection
698 * @param c Connection.
700 * @return Next peer in the connection.
702 static struct MeshPeer *
703 get_next_hop (const struct MeshConnection *c)
707 LOG (GNUNET_ERROR_TYPE_DEBUG, " get next hop %s [%u/%u]\n",
708 GMC_2s (c), c->own_pos, c->path->length);
709 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
711 LOG (GNUNET_ERROR_TYPE_DEBUG, " own pos is end\n");
712 id = c->path->peers[c->path->length - 1];
716 LOG (GNUNET_ERROR_TYPE_DEBUG, " own pos is NOT end\n");
717 id = c->path->peers[c->own_pos + 1];
720 LOG (GNUNET_ERROR_TYPE_DEBUG, " id: %u\n", id);
721 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s\n", GNUNET_i2s (GNUNET_PEER_resolve2 (id)));
723 return GMP_get_short (id);
728 * Get the hop in a connection.
730 * @param c Connection.
731 * @param fwd Next hop?
733 * @return Next peer in the connection.
735 static struct MeshPeer *
736 get_hop (struct MeshConnection *c, int fwd)
739 return get_next_hop (c);
740 return get_prev_hop (c);
745 * Is traffic coming from this sender 'FWD' traffic?
747 * @param c Connection to check.
748 * @param sender Peer identity of neighbor.
750 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
751 * the traffic is 'FWD'.
752 * #GNUNET_NO for BCK.
753 * #GNUNET_SYSERR for errors.
756 is_fwd (const struct MeshConnection *c,
757 const struct GNUNET_PeerIdentity *sender)
761 id = GNUNET_PEER_search (sender);
762 if (GMP_get_short_id (get_prev_hop (c)) == id)
765 if (GMP_get_short_id (get_next_hop (c)) == id)
769 return GNUNET_SYSERR;
774 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
775 * or a first CONNECTION_ACK directed to us.
777 * @param connection Connection to confirm.
778 * @param fwd Should we send it FWD? (root->dest)
779 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
782 send_connection_ack (struct MeshConnection *connection, int fwd)
784 struct MeshTunnel3 *t;
787 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection %s ACK\n",
789 GMP_queue_add (get_hop (connection, fwd), NULL,
790 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
791 sizeof (struct GNUNET_MESH_ConnectionACK),
792 connection, fwd, &message_sent, NULL);
793 connection->pending_messages++;
794 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
795 GMT_change_cstate (t, MESH_TUNNEL3_WAITING);
796 if (MESH_CONNECTION_READY != connection->state)
797 connection_change_state (connection, MESH_CONNECTION_SENT);
802 * Send a notification that a connection is broken.
804 * @param c Connection that is broken.
805 * @param id1 Peer that has disconnected.
806 * @param id2 Peer that has disconnected.
807 * @param fwd Direction towards which to send it.
810 send_broken (struct MeshConnection *c,
811 const struct GNUNET_PeerIdentity *id1,
812 const struct GNUNET_PeerIdentity *id2,
815 struct GNUNET_MESH_ConnectionBroken msg;
817 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
818 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
822 GMC_send_prebuilt_message (&msg.header, c, fwd, GNUNET_YES, NULL, NULL);
827 * Send a notification that a connection is broken, when a connection
828 * isn't even created.
830 * @param connection_id Connection ID.
831 * @param id1 Peer that has disconnected.
832 * @param id2 Peer that has disconnected.
833 * @param peer Peer to notify (neighbor who sent the connection).
836 send_broken2 (struct GNUNET_HashCode *connection_id,
837 const struct GNUNET_PeerIdentity *id1,
838 const struct GNUNET_PeerIdentity *id2,
839 GNUNET_PEER_Id peer_id)
841 struct GNUNET_MESH_ConnectionBroken *msg;
842 struct MeshPeer *neighbor;
844 msg = GNUNET_new (struct GNUNET_MESH_ConnectionBroken);
845 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
846 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
847 msg->cid = *connection_id;
850 neighbor = GMP_get_short (peer_id);
851 GMP_queue_add (neighbor, msg,
852 GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED,
853 sizeof (struct GNUNET_MESH_ConnectionBroken),
854 NULL, GNUNET_SYSERR, /* connection, fwd */
855 NULL, NULL); /* continuation */
860 * Send keepalive packets for a connection.
862 * @param c Connection to keep alive..
863 * @param fwd Is this a FWD keepalive? (owner -> dest).
866 connection_keepalive (struct MeshConnection *c, int fwd)
868 struct GNUNET_MESH_ConnectionKeepAlive *msg;
869 size_t size = sizeof (struct GNUNET_MESH_ConnectionKeepAlive);
872 LOG (GNUNET_ERROR_TYPE_DEBUG,
873 "sending %s keepalive for connection %s]\n",
874 GM_f2s (fwd), GMC_2s (c));
876 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) cbuf;
877 msg->header.size = htons (size);
878 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE);
880 msg->reserved = htonl (0);
882 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_YES, NULL, NULL);
887 * Send CONNECTION_{CREATE/ACK} packets for a connection.
889 * @param c Connection for which to send the message.
890 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
893 connection_recreate (struct MeshConnection *c, int fwd)
895 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
899 send_connection_ack (c, GNUNET_NO);
904 * Generic connection timer management.
905 * Depending on the role of the peer in the connection will send the
906 * appropriate message (build or keepalive)
908 * @param c Conncetion to maintain.
912 connection_maintain (struct MeshConnection *c, int fwd)
914 if (GNUNET_NO != c->destroy)
917 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (c->t))
919 /* TODO DHT GET with RO_BART */
924 case MESH_CONNECTION_NEW:
927 case MESH_CONNECTION_SENT:
928 connection_recreate (c, fwd);
930 case MESH_CONNECTION_READY:
931 connection_keepalive (c, fwd);
940 * Keep the connection alive in the FWD direction.
942 * @param cls Closure (connection to keepalive).
943 * @param tc TaskContext.
946 connection_fwd_keepalive (void *cls,
947 const struct GNUNET_SCHEDULER_TaskContext *tc)
949 struct MeshConnection *c = cls;
951 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
952 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
955 connection_maintain (c, GNUNET_YES);
957 /* Next execution will be scheduled by message_sent */
962 * Keep the connection alive in the BCK direction.
964 * TODO refactor and merge with connection_fwd_keepalive.
966 * @param cls Closure (connection to keepalive).
967 * @param tc TaskContext.
970 connection_bck_keepalive (void *cls,
971 const struct GNUNET_SCHEDULER_TaskContext *tc)
973 struct MeshConnection *c = cls;
975 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
976 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
979 connection_maintain (c, GNUNET_NO);
981 /* Next execution will be scheduled by message_sent */
986 * Schedule next keepalive task, taking in consideration
987 * the connection state and number of retries.
989 * If the peer is not the origin, do nothing.
991 * @param c Connection for which to schedule the next keepalive.
992 * @param fwd Direction for the next keepalive.
995 schedule_next_keepalive (struct MeshConnection *c, int fwd)
997 struct GNUNET_TIME_Relative delay;
998 GNUNET_SCHEDULER_TaskIdentifier *task_id;
999 GNUNET_SCHEDULER_Task keepalive_task;
1001 if (GNUNET_NO == GMC_is_origin (c, fwd))
1004 /* Calculate delay to use, depending on the state of the connection */
1005 if (MESH_CONNECTION_READY == c->state)
1007 delay = refresh_connection_time;
1011 if (1 > c->create_retry)
1012 c->create_retry = 1;
1013 delay = GNUNET_TIME_relative_multiply (create_connection_time,
1015 if (c->create_retry < 64)
1016 c->create_retry *= 2;
1019 /* Select direction-dependent parameters */
1020 if (GNUNET_YES == fwd)
1022 task_id = &c->fwd_maintenance_task;
1023 keepalive_task = &connection_fwd_keepalive;
1027 task_id = &c->bck_maintenance_task;
1028 keepalive_task = &connection_bck_keepalive;
1031 /* Check that no one scheduled it before us (and alert in that case) */
1032 if (GNUNET_SCHEDULER_NO_TASK != *task_id)
1035 GNUNET_SCHEDULER_cancel (*task_id);
1038 /* Schedule the task */
1039 *task_id = GNUNET_SCHEDULER_add_delayed (delay, keepalive_task, c);
1044 * @brief Re-initiate traffic on this connection if necessary.
1046 * Check if there is traffic queued towards this peer
1047 * and the core transmit handle is NULL (traffic was stalled).
1048 * If so, call core tmt rdy.
1050 * @param c Connection on which initiate traffic.
1051 * @param fwd Is this about fwd traffic?
1054 connection_unlock_queue (struct MeshConnection *c, int fwd)
1056 struct MeshPeer *peer;
1058 LOG (GNUNET_ERROR_TYPE_DEBUG,
1059 "connection_unlock_queue %s on %s\n",
1060 GM_f2s (fwd), GMC_2s (c));
1062 if (GMC_is_terminal (c, fwd))
1064 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
1068 peer = get_hop (c, fwd);
1069 GMP_queue_unlock (peer, c);
1074 * Cancel all transmissions that belong to a certain connection.
1076 * If the connection is scheduled for destruction and no more messages are left,
1077 * the connection will be destroyed by the continuation call.
1079 * @param c Connection which to cancel. Might be destroyed during this call.
1080 * @param fwd Cancel fwd traffic?
1083 connection_cancel_queues (struct MeshConnection *c, int fwd)
1085 struct MeshFlowControl *fc;
1086 struct MeshPeer *peer;
1088 LOG (GNUNET_ERROR_TYPE_DEBUG,
1089 " *** Cancel %s queues for connection %s\n",
1090 GM_f2s (fwd), GMC_2s (c));
1097 fc = fwd ? &c->fwd_fc : &c->bck_fc;
1098 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
1100 GNUNET_SCHEDULER_cancel (fc->poll_task);
1101 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1102 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
1104 peer = get_hop (c, fwd);
1105 GMP_queue_cancel (peer, c);
1110 * Function called if a connection has been stalled for a while,
1111 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1113 * @param cls Closure (poll ctx).
1114 * @param tc TaskContext.
1117 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1121 * Callback called when a queued POLL message is sent.
1123 * @param cls Closure (FC).
1124 * @param c Connection this message was on.
1125 * @param q Queue handler this call invalidates.
1126 * @param type Type of message sent.
1127 * @param fwd Was this a FWD going message?
1128 * @param size Size of the message.
1131 poll_sent (void *cls,
1132 struct MeshConnection *c,
1133 struct MeshConnectionQueue *q,
1134 uint16_t type, int fwd, size_t size)
1136 struct MeshFlowControl *fc = cls;
1138 if (2 == c->destroy)
1140 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
1143 LOG (GNUNET_ERROR_TYPE_DEBUG,
1144 " *** POLL sent for , scheduling new one!\n");
1145 fc->poll_msg = NULL;
1146 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
1147 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
1148 &connection_poll, fc);
1149 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1154 * Function called if a connection has been stalled for a while,
1155 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1157 * @param cls Closure (poll ctx).
1158 * @param tc TaskContext.
1161 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1163 struct MeshFlowControl *fc = cls;
1164 struct GNUNET_MESH_Poll msg;
1165 struct MeshConnection *c;
1167 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1168 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1174 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
1175 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
1176 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
1177 fc == &c->fwd_fc ? "FWD" : "BCK");
1179 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
1180 msg.header.size = htons (sizeof (msg));
1181 msg.pid = htonl (fc->last_pid_sent);
1182 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1183 fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c,
1184 fc == &c->fwd_fc, GNUNET_YES,
1190 * Timeout function due to lack of keepalive/traffic from the owner.
1191 * Destroys connection if called.
1193 * @param cls Closure (connection to destroy).
1194 * @param tc TaskContext.
1197 connection_fwd_timeout (void *cls,
1198 const struct GNUNET_SCHEDULER_TaskContext *tc)
1200 struct MeshConnection *c = cls;
1202 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1203 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1206 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1208 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1219 * Timeout function due to lack of keepalive/traffic from the destination.
1220 * Destroys connection if called.
1222 * @param cls Closure (connection to destroy).
1223 * @param tc TaskContext
1226 connection_bck_timeout (void *cls,
1227 const struct GNUNET_SCHEDULER_TaskContext *tc)
1229 struct MeshConnection *c = cls;
1231 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1232 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1235 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1238 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1249 * Resets the connection timeout task, some other message has done the
1251 * - For the first peer on the direction this means to send
1252 * a keepalive or a path confirmation message (either create or ACK).
1253 * - For all other peers, this means to destroy the connection,
1254 * due to lack of activity.
1255 * Starts the timeout if no timeout was running (connection just created).
1257 * @param c Connection whose timeout to reset.
1258 * @param fwd Is this forward?
1260 * TODO use heap to improve efficiency of scheduler.
1263 connection_reset_timeout (struct MeshConnection *c, int fwd)
1265 GNUNET_SCHEDULER_TaskIdentifier *ti;
1266 GNUNET_SCHEDULER_Task f;
1268 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1270 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GM_f2s (fwd));
1272 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1273 GNUNET_SCHEDULER_cancel (*ti);
1275 if (GMC_is_origin (c, fwd)) /* Startpoint */
1277 f = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
1278 *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
1280 else /* Relay, endpoint. */
1282 struct GNUNET_TIME_Relative delay;
1284 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1285 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1286 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1292 * Add the connection to the list of both neighbors.
1294 * @param c Connection.
1296 * @return #GNUNET_OK if everything went fine
1297 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1300 register_neighbors (struct MeshConnection *c)
1302 struct MeshPeer *next_peer;
1303 struct MeshPeer *prev_peer;
1305 next_peer = get_next_hop (c);
1306 prev_peer = get_prev_hop (c);
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, "register neighbors for connection %s\n",
1310 path_debug (c->path);
1311 LOG (GNUNET_ERROR_TYPE_DEBUG, "own pos %u\n", c->own_pos);
1312 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to next peer %p\n",
1313 GMC_2s (c), next_peer);
1314 LOG (GNUNET_ERROR_TYPE_DEBUG, "next peer %p %s\n", next_peer, GMP_2s (next_peer));
1315 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to prev peer %p\n",
1316 GMC_2s (c), prev_peer);
1317 LOG (GNUNET_ERROR_TYPE_DEBUG, "prev peer %p %s\n", prev_peer, GMP_2s (prev_peer));
1319 if (GNUNET_NO == GMP_is_neighbor (next_peer)
1320 || GNUNET_NO == GMP_is_neighbor (prev_peer))
1322 if (GMC_is_origin (c, GNUNET_YES))
1323 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1324 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1326 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1327 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1328 GMP_2s (prev_peer), GMP_is_neighbor (prev_peer));
1329 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1330 GMP_2s (next_peer), GMP_is_neighbor (next_peer));
1331 return GNUNET_SYSERR;
1334 GMP_add_connection (next_peer, c);
1335 GMP_add_connection (prev_peer, c);
1342 * Remove the connection from the list of both neighbors.
1344 * @param c Connection.
1347 unregister_neighbors (struct MeshConnection *c)
1349 struct MeshPeer *peer;
1351 peer = get_next_hop (c);
1352 if (GNUNET_OK != GMP_remove_connection (peer, c))
1354 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1355 || MESH_CONNECTION_DESTROYED == c->state);
1356 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1357 if (NULL != c->t) GMT_debug (c->t);
1360 peer = get_prev_hop (c);
1361 if (GNUNET_OK != GMP_remove_connection (peer, c))
1363 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1364 || MESH_CONNECTION_DESTROYED == c->state);
1365 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1366 if (NULL != c->t) GMT_debug (c->t);
1372 * Bind the connection to the peer and the tunnel to that peer.
1374 * If the peer has no tunnel, create one. Update tunnel and connection
1375 * data structres to reflect new status.
1377 * @param c Connection.
1381 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1383 GMP_add_tunnel (peer);
1384 c->t = GMP_get_tunnel (peer);
1385 GMT_add_connection (c->t, c);
1390 * Builds a path from a PeerIdentity array.
1392 * @param peers PeerIdentity array.
1393 * @param size Size of the @c peers array.
1394 * @param own_pos Output parameter: own position in the path.
1396 * @return Fixed and shortened path.
1398 static struct MeshPeerPath *
1399 build_path_from_peer_ids (struct GNUNET_PeerIdentity *peers,
1401 unsigned int *own_pos)
1403 struct MeshPeerPath *path;
1404 GNUNET_PEER_Id shortid;
1407 unsigned int offset;
1410 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1411 path = path_new (size);
1414 for (i = 0; i < size; i++)
1416 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %u: taking %s\n",
1417 i, GNUNET_i2s (&peers[i]));
1418 shortid = GNUNET_PEER_intern (&peers[i]);
1420 /* Check for loops / duplicates */
1421 for (j = 0; j < i - offset; j++)
1423 if (path->peers[j] == shortid)
1425 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists at pos %u\n", j);
1427 LOG (GNUNET_ERROR_TYPE_DEBUG, " offset now\n", offset);
1428 GNUNET_PEER_change_rc (shortid, -1);
1431 LOG (GNUNET_ERROR_TYPE_DEBUG, " storing at %u\n", i - offset);
1432 path->peers[i - offset] = shortid;
1433 if (path->peers[i] == myid)
1436 path->length -= offset;
1438 if (path->peers[*own_pos] != myid)
1440 /* create path: self not found in path through self */
1441 GNUNET_break_op (0);
1442 path_destroy (path);
1449 /******************************************************************************/
1450 /******************************** API ***********************************/
1451 /******************************************************************************/
1454 * Core handler for connection creation.
1456 * @param cls Closure (unused).
1457 * @param peer Sender (neighbor).
1458 * @param message Message.
1460 * @return GNUNET_OK to keep the connection open,
1461 * GNUNET_SYSERR to close it (signal serious error)
1464 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1465 const struct GNUNET_MessageHeader *message)
1467 struct GNUNET_MESH_ConnectionCreate *msg;
1468 struct GNUNET_PeerIdentity *id;
1469 struct GNUNET_HashCode *cid;
1470 struct MeshPeerPath *path;
1471 struct MeshPeer *dest_peer;
1472 struct MeshPeer *orig_peer;
1473 struct MeshConnection *c;
1474 unsigned int own_pos;
1477 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1478 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection create msg\n");
1481 size = ntohs (message->size);
1482 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1484 GNUNET_break_op (0);
1488 /* Calculate hops */
1489 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1490 if (size % sizeof (struct GNUNET_PeerIdentity))
1492 GNUNET_break_op (0);
1495 size /= sizeof (struct GNUNET_PeerIdentity);
1498 GNUNET_break_op (0);
1501 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1503 /* Get parameters */
1504 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1506 id = (struct GNUNET_PeerIdentity *) &msg[1];
1507 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s (%s->).\n",
1508 GNUNET_h2s (cid), GNUNET_i2s (id));
1510 /* Create connection */
1511 c = connection_get (cid);
1514 path = build_path_from_peer_ids ((struct GNUNET_PeerIdentity *) &msg[1],
1520 GNUNET_break_op (0);
1521 path_destroy (path);
1524 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1525 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1526 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1529 if (path->length - 1 == own_pos)
1531 /* If we are destination, why did the creation fail? */
1535 send_broken2 (cid, &my_full_id,
1536 GNUNET_PEER_resolve2 (path->peers[own_pos + 1]),
1537 path->peers[own_pos - 1]);
1538 path_destroy (path);
1541 GMP_add_path_to_all (path, GNUNET_NO);
1542 connection_reset_timeout (c, GNUNET_YES);
1546 path = path_duplicate (c->path);
1548 if (MESH_CONNECTION_NEW == c->state)
1549 connection_change_state (c, MESH_CONNECTION_SENT);
1551 /* Remember peers */
1552 dest_peer = GMP_get (&id[size - 1]);
1553 orig_peer = GMP_get (&id[0]);
1555 /* Is it a connection to us? */
1556 if (c->own_pos == size - 1)
1558 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1559 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1561 add_to_peer (c, orig_peer);
1562 if (MESH_TUNNEL3_NEW == GMT_get_cstate (c->t))
1563 GMT_change_cstate (c->t, MESH_TUNNEL3_WAITING);
1565 send_connection_ack (c, GNUNET_NO);
1566 if (MESH_CONNECTION_SENT == c->state)
1567 connection_change_state (c, MESH_CONNECTION_ACK);
1571 /* It's for somebody else! Retransmit. */
1572 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1573 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1574 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1575 GMC_send_prebuilt_message (message, c, GNUNET_YES, GNUNET_YES,
1578 path_destroy (path);
1584 * Core handler for path confirmations.
1586 * @param cls closure
1587 * @param message message
1588 * @param peer peer identity this notification is about
1590 * @return GNUNET_OK to keep the connection open,
1591 * GNUNET_SYSERR to close it (signal serious error)
1594 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1595 const struct GNUNET_MessageHeader *message)
1597 struct GNUNET_MESH_ConnectionACK *msg;
1598 struct MeshConnection *c;
1599 struct MeshPeerPath *p;
1600 struct MeshPeer *pi;
1601 enum MeshConnectionState oldstate;
1604 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1605 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection ACK msg\n");
1606 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1607 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n",
1608 GNUNET_h2s (&msg->cid));
1609 c = connection_get (&msg->cid);
1612 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1614 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1618 if (GNUNET_NO != c->destroy)
1620 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1624 oldstate = c->state;
1625 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1626 pi = GMP_get (peer);
1627 if (get_next_hop (c) == pi)
1629 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1631 if (MESH_CONNECTION_SENT == oldstate)
1632 connection_change_state (c, MESH_CONNECTION_ACK);
1634 else if (get_prev_hop (c) == pi)
1636 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1638 connection_change_state (c, MESH_CONNECTION_READY);
1642 GNUNET_break_op (0);
1646 connection_reset_timeout (c, fwd);
1648 /* Add path to peers? */
1652 GMP_add_path_to_all (p, GNUNET_YES);
1659 /* Message for us as creator? */
1660 if (GMC_is_origin (c, GNUNET_YES))
1662 if (GNUNET_NO != fwd)
1664 GNUNET_break_op (0);
1667 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1669 /* If just created, cancel the short timeout and start a long one */
1670 if (MESH_CONNECTION_SENT == oldstate)
1671 connection_reset_timeout (c, GNUNET_YES);
1673 /* Change connection state */
1674 connection_change_state (c, MESH_CONNECTION_READY);
1675 send_connection_ack (c, GNUNET_YES);
1677 /* Change tunnel state, trigger KX */
1678 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1679 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1684 /* Message for us as destination? */
1685 if (GMC_is_terminal (c, GNUNET_YES))
1687 if (GNUNET_YES != fwd)
1689 GNUNET_break_op (0);
1692 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1694 /* If just created, cancel the short timeout and start a long one */
1695 if (MESH_CONNECTION_ACK == oldstate)
1696 connection_reset_timeout (c, GNUNET_NO);
1698 /* Change tunnel state */
1699 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1700 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1705 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1706 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1712 * Core handler for notifications of broken paths
1714 * @param cls Closure (unused).
1715 * @param id Peer identity of sending neighbor.
1716 * @param message Message.
1718 * @return GNUNET_OK to keep the connection open,
1719 * GNUNET_SYSERR to close it (signal serious error)
1722 GMC_handle_broken (void* cls,
1723 const struct GNUNET_PeerIdentity* id,
1724 const struct GNUNET_MessageHeader* message)
1726 struct GNUNET_MESH_ConnectionBroken *msg;
1727 struct MeshConnection *c;
1730 LOG (GNUNET_ERROR_TYPE_DEBUG,
1731 "Received a CONNECTION BROKEN msg from %s\n", GNUNET_i2s (id));
1732 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1733 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1734 GNUNET_i2s (&msg->peer1));
1735 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1736 GNUNET_i2s (&msg->peer2));
1737 c = connection_get (&msg->cid);
1740 GNUNET_break_op (0);
1744 fwd = is_fwd (c, id);
1745 if (GMC_is_terminal (c, fwd))
1747 path_invalidate (c->path);
1748 if (0 < c->pending_messages)
1749 c->destroy = GNUNET_YES;
1755 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1756 c->destroy = GNUNET_YES;
1757 connection_cancel_queues (c, !fwd);
1766 * Core handler for tunnel destruction
1768 * @param cls Closure (unused).
1769 * @param peer Peer identity of sending neighbor.
1770 * @param message Message.
1772 * @return GNUNET_OK to keep the connection open,
1773 * GNUNET_SYSERR to close it (signal serious error)
1776 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1777 const struct GNUNET_MessageHeader *message)
1779 struct GNUNET_MESH_ConnectionDestroy *msg;
1780 struct MeshConnection *c;
1783 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1784 LOG (GNUNET_ERROR_TYPE_DEBUG,
1785 "Got a CONNECTION DESTROY message from %s\n",
1787 LOG (GNUNET_ERROR_TYPE_DEBUG,
1788 " for connection %s\n",
1789 GNUNET_h2s (&msg->cid));
1790 c = connection_get (&msg->cid);
1793 /* Probably already got the message from another path,
1794 * destroyed the tunnel and retransmitted to children.
1797 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1799 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1802 fwd = is_fwd (c, peer);
1803 if (GNUNET_SYSERR == fwd)
1805 GNUNET_break_op (0); /* FIXME */
1808 if (GNUNET_NO == GMC_is_terminal (c, fwd))
1809 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1810 else if (0 == c->pending_messages)
1812 LOG (GNUNET_ERROR_TYPE_DEBUG, "! directly destroying connection!\n");
1816 c->destroy = GNUNET_YES;
1817 c->state = MESH_CONNECTION_DESTROYED;
1820 GMT_remove_connection (c->t, c);
1828 * Generic handler for mesh network encrypted traffic.
1830 * @param peer Peer identity this notification is about.
1831 * @param msg Encrypted message.
1833 * @return GNUNET_OK to keep the connection open,
1834 * GNUNET_SYSERR to close it (signal serious error)
1837 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1838 const struct GNUNET_MESH_Encrypted *msg)
1840 struct MeshConnection *c;
1841 struct MeshPeer *neighbor;
1842 struct MeshFlowControl *fc;
1843 GNUNET_PEER_Id peer_id;
1851 size = ntohs (msg->header.size);
1853 sizeof (struct GNUNET_MESH_Encrypted) +
1854 sizeof (struct GNUNET_MessageHeader))
1856 GNUNET_break_op (0);
1859 type = ntohs (msg->header.type);
1860 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1861 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message (#%u) from %s\n",
1862 GM_m2s (type), ntohl (msg->pid), GNUNET_i2s (peer));
1864 /* Check connection */
1865 c = connection_get (&msg->cid);
1868 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1869 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING enc on unknown connection %s\n",
1870 GNUNET_h2s (&msg->cid));
1874 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
1876 /* Check if origin is as expected */
1877 neighbor = get_prev_hop (c);
1878 peer_id = GNUNET_PEER_search (peer);
1879 if (peer_id == GMP_get_short_id (neighbor))
1885 neighbor = get_next_hop (c);
1886 if (peer_id == GMP_get_short_id (neighbor))
1892 /* Unexpected peer sending traffic on a connection. */
1893 GNUNET_break_op (0);
1899 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1900 pid = ntohl (msg->pid);
1901 if (GM_is_pid_bigger (pid, fc->last_ack_sent))
1903 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1904 LOG (GNUNET_ERROR_TYPE_DEBUG,
1905 "WARNING Received PID %u, (prev %u), ACK %u\n",
1906 pid, fc->last_pid_recv, fc->last_ack_sent);
1909 if (GNUNET_NO == GM_is_pid_bigger (pid, fc->last_pid_recv))
1911 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1912 LOG (GNUNET_ERROR_TYPE_DEBUG,
1913 " Pid %u not expected (%u+), dropping!\n",
1914 pid, fc->last_pid_recv + 1);
1917 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1918 connection_change_state (c, MESH_CONNECTION_READY);
1919 connection_reset_timeout (c, fwd);
1920 fc->last_pid_recv = pid;
1922 /* Is this message for us? */
1923 if (GMC_is_terminal (c, fwd))
1925 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1926 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1930 GNUNET_break (GNUNET_NO != c->destroy);
1933 fc->last_pid_recv = pid;
1934 GMT_handle_encrypted (c->t, msg);
1935 GMC_send_ack (c, fwd, GNUNET_NO);
1939 /* Message not for us: forward to next hop */
1940 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1941 ttl = ntohl (msg->ttl);
1942 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1945 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1946 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1947 GMC_send_ack (c, fwd, GNUNET_NO);
1951 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1952 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1958 * Generic handler for mesh network encrypted traffic.
1960 * @param peer Peer identity this notification is about.
1961 * @param msg Encrypted message.
1963 * @return GNUNET_OK to keep the connection open,
1964 * GNUNET_SYSERR to close it (signal serious error)
1967 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1968 const struct GNUNET_MESH_KX *msg)
1970 struct MeshConnection *c;
1971 struct MeshPeer *neighbor;
1972 GNUNET_PEER_Id peer_id;
1978 size = ntohs (msg->header.size);
1980 sizeof (struct GNUNET_MESH_Encrypted) +
1981 sizeof (struct GNUNET_MessageHeader))
1983 GNUNET_break_op (0);
1986 type = ntohs (msg->header.type);
1987 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1988 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message from %s\n",
1989 GM_m2s (type), GNUNET_i2s (peer));
1991 /* Check connection */
1992 c = connection_get (&msg->cid);
1995 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1996 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING kx on unknown connection %s\n",
1997 GNUNET_h2s (&msg->cid));
2000 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
2002 /* Check if origin is as expected */
2003 neighbor = get_prev_hop (c);
2004 peer_id = GNUNET_PEER_search (peer);
2005 if (peer_id == GMP_get_short_id (neighbor))
2011 neighbor = get_next_hop (c);
2012 if (peer_id == GMP_get_short_id (neighbor))
2018 /* Unexpected peer sending traffic on a connection. */
2019 GNUNET_break_op (0);
2024 /* Count as connection confirmation. */
2025 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
2027 connection_change_state (c, MESH_CONNECTION_READY);
2030 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
2031 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
2034 connection_reset_timeout (c, fwd);
2036 /* Is this message for us? */
2037 if (GMC_is_terminal (c, fwd))
2039 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
2040 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
2046 GMT_handle_kx (c->t, &msg[1].header);
2050 /* Message not for us: forward to next hop */
2051 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
2052 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2053 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
2060 * Core handler for encrypted mesh network traffic (channel mgmt, data).
2062 * @param cls Closure (unused).
2063 * @param message Message received.
2064 * @param peer Peer who sent the message.
2066 * @return GNUNET_OK to keep the connection open,
2067 * GNUNET_SYSERR to close it (signal serious error)
2070 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
2071 const struct GNUNET_MessageHeader *message)
2073 return handle_mesh_encrypted (peer,
2074 (struct GNUNET_MESH_Encrypted *)message);
2079 * Core handler for key exchange traffic (ephemeral key, ping, pong).
2081 * @param cls Closure (unused).
2082 * @param message Message received.
2083 * @param peer Peer who sent the message.
2085 * @return GNUNET_OK to keep the connection open,
2086 * GNUNET_SYSERR to close it (signal serious error)
2089 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
2090 const struct GNUNET_MessageHeader *message)
2092 return handle_mesh_kx (peer,
2093 (struct GNUNET_MESH_KX *) message);
2098 * Core handler for mesh network traffic point-to-point acks.
2100 * @param cls closure
2101 * @param message message
2102 * @param peer peer identity this notification is about
2104 * @return GNUNET_OK to keep the connection open,
2105 * GNUNET_SYSERR to close it (signal serious error)
2108 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
2109 const struct GNUNET_MessageHeader *message)
2111 struct GNUNET_MESH_ACK *msg;
2112 struct MeshConnection *c;
2113 struct MeshFlowControl *fc;
2118 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
2119 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK packet from %s!\n",
2121 msg = (struct GNUNET_MESH_ACK *) message;
2123 c = connection_get (&msg->cid);
2127 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
2132 /* Is this a forward or backward ACK? */
2133 id = GNUNET_PEER_search (peer);
2134 if (GMP_get_short_id (get_next_hop (c)) == id)
2136 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
2140 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2142 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
2148 GNUNET_break_op (0);
2152 ack = ntohl (msg->ack);
2153 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
2154 ack, fc->last_ack_recv);
2155 if (GM_is_pid_bigger (ack, fc->last_ack_recv))
2156 fc->last_ack_recv = ack;
2158 /* Cancel polling if the ACK is big enough. */
2159 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
2160 GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2162 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
2163 GNUNET_SCHEDULER_cancel (fc->poll_task);
2164 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2165 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
2168 connection_unlock_queue (c, fwd);
2175 * Core handler for mesh network traffic point-to-point ack polls.
2177 * @param cls closure
2178 * @param message message
2179 * @param peer peer identity this notification is about
2181 * @return GNUNET_OK to keep the connection open,
2182 * GNUNET_SYSERR to close it (signal serious error)
2185 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
2186 const struct GNUNET_MessageHeader *message)
2188 struct GNUNET_MESH_Poll *msg;
2189 struct MeshConnection *c;
2190 struct MeshFlowControl *fc;
2195 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
2196 LOG (GNUNET_ERROR_TYPE_DEBUG,
2197 "Got a POLL message from %s!\n",
2200 msg = (struct GNUNET_MESH_Poll *) message;
2202 c = connection_get (&msg->cid);
2206 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
2208 LOG (GNUNET_ERROR_TYPE_DEBUG,
2209 "WARNING POLL message on unknown connection %s!\n",
2210 GNUNET_h2s (&msg->cid));
2214 /* Is this a forward or backward ACK?
2215 * Note: a poll should never be needed in a loopback case,
2216 * since there is no possiblility of packet loss there, so
2217 * this way of discerining FWD/BCK should not be a problem.
2219 id = GNUNET_PEER_search (peer);
2220 if (GMP_get_short_id (get_next_hop (c)) == id)
2222 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2225 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2227 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2232 GNUNET_break_op (0);
2236 pid = ntohl (msg->pid);
2237 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2238 fc->last_pid_recv = pid;
2239 fwd = fc == &c->bck_fc;
2240 GMC_send_ack (c, fwd, GNUNET_YES);
2247 * Core handler for mesh keepalives.
2249 * @param cls closure
2250 * @param message message
2251 * @param peer peer identity this notification is about
2252 * @return GNUNET_OK to keep the connection open,
2253 * GNUNET_SYSERR to close it (signal serious error)
2255 * TODO: Check who we got this from, to validate route.
2258 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
2259 const struct GNUNET_MessageHeader *message)
2261 struct GNUNET_MESH_ConnectionKeepAlive *msg;
2262 struct MeshConnection *c;
2263 struct MeshPeer *neighbor;
2264 GNUNET_PEER_Id peer_id;
2267 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) message;
2268 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a keepalive packet from %s\n",
2271 c = connection_get (&msg->cid);
2274 GNUNET_STATISTICS_update (stats, "# keepalive on unknown connection", 1,
2279 /* Check if origin is as expected TODO refactor and reuse */
2280 peer_id = GNUNET_PEER_search (peer);
2281 neighbor = get_prev_hop (c);
2282 if (peer_id == GMP_get_short_id (neighbor))
2288 neighbor = get_next_hop (c);
2289 if (peer_id == GMP_get_short_id (neighbor))
2295 GNUNET_break_op (0);
2300 connection_change_state (c, MESH_CONNECTION_READY);
2301 connection_reset_timeout (c, fwd);
2303 if (GMC_is_terminal (c, fwd))
2306 GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
2307 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
2314 * Send an ACK on the appropriate connection/channel, depending on
2315 * the direction and the position of the peer.
2317 * @param c Which connection to send the hop-by-hop ACK.
2318 * @param fwd Is this a fwd ACK? (will go dest->root).
2319 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2322 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
2324 unsigned int buffer;
2326 LOG (GNUNET_ERROR_TYPE_DEBUG,
2327 "GMC send %s ACK on %s\n",
2328 GM_f2s (fwd), GMC_2s (c));
2336 if (GNUNET_NO != c->destroy)
2338 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2342 /* Get available buffer space */
2343 if (GMC_is_terminal (c, fwd))
2345 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2346 buffer = GMT_get_channels_buffer (c->t);
2350 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2351 buffer = GMC_get_buffer (c, fwd);
2353 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2354 if (0 == buffer && GNUNET_NO == force)
2357 /* Send available buffer space */
2358 if (GMC_is_origin (c, fwd))
2360 GNUNET_assert (NULL != c->t);
2361 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2362 GMT_unchoke_channels (c->t);
2366 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2367 send_ack (c, buffer, fwd, force);
2373 * Initialize the connections subsystem
2375 * @param c Configuration handle.
2378 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2380 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2382 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2385 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2386 "MESH", "MAX_MSGS_QUEUE", "MISSING");
2387 GNUNET_SCHEDULER_shutdown ();
2392 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2395 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2396 "MESH", "MAX_CONNECTIONS", "MISSING");
2397 GNUNET_SCHEDULER_shutdown ();
2402 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2403 &refresh_connection_time))
2405 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2406 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2407 GNUNET_SCHEDULER_shutdown ();
2410 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2411 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
2416 * Destroy each connection on shutdown.
2418 * @param cls Closure (unused).
2419 * @param key Current key code (CID, unused).
2420 * @param value Value in the hash map (connection)
2422 * @return #GNUNET_YES, because we should continue to iterate,
2425 shutdown_iterator (void *cls,
2426 const struct GNUNET_HashCode *key,
2429 struct MeshConnection *c = value;
2437 * Shut down the connections subsystem.
2442 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2443 GNUNET_CONTAINER_multihashmap_destroy (connections);
2448 struct MeshConnection *
2449 GMC_new (const struct GNUNET_HashCode *cid,
2450 struct MeshTunnel3 *t,
2451 struct MeshPeerPath *p,
2452 unsigned int own_pos)
2454 struct MeshConnection *c;
2456 c = GNUNET_new (struct MeshConnection);
2458 GNUNET_assert (GNUNET_OK ==
2459 GNUNET_CONTAINER_multihashmap_put (connections,
2461 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2462 fc_init (&c->fwd_fc);
2463 fc_init (&c->bck_fc);
2468 GNUNET_assert (own_pos <= p->length - 1);
2469 c->own_pos = own_pos;
2472 if (GNUNET_OK != register_neighbors (c))
2476 path_invalidate (c->path);
2489 GMC_destroy (struct MeshConnection *c)
2497 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2498 return; /* -> message_sent -> GMC_destroy. Don't loop. */
2501 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2502 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2503 &c->fwd_fc, &c->bck_fc);
2504 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2505 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2507 /* Cancel all traffic */
2508 if (NULL != c->path)
2510 connection_cancel_queues (c, GNUNET_YES);
2511 connection_cancel_queues (c, GNUNET_NO);
2512 unregister_neighbors (c);
2515 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2516 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2518 /* Cancel maintainance task (keepalive/timeout) */
2519 if (NULL != c->fwd_fc.poll_msg)
2521 GMC_cancel (c->fwd_fc.poll_msg);
2522 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2524 if (NULL != c->bck_fc.poll_msg)
2526 GMC_cancel (c->bck_fc.poll_msg);
2527 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2530 /* Delete from tunnel */
2532 GMT_remove_connection (c->t, c);
2534 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES) && NULL != c->path)
2535 path_destroy (c->path);
2536 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2537 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2538 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2539 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2540 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2542 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2543 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2545 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2547 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2548 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2551 GNUNET_break (GNUNET_YES ==
2552 GNUNET_CONTAINER_multihashmap_remove (connections, &c->id, c));
2554 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2559 * Get the connection ID.
2561 * @param c Connection to get the ID from.
2563 * @return ID of the connection.
2565 const struct GNUNET_HashCode *
2566 GMC_get_id (const struct MeshConnection *c)
2573 * Get the connection path.
2575 * @param c Connection to get the path from.
2577 * @return path used by the connection.
2579 const struct MeshPeerPath *
2580 GMC_get_path (const struct MeshConnection *c)
2582 if (GNUNET_NO == c->destroy)
2589 * Get the connection state.
2591 * @param c Connection to get the state from.
2593 * @return state of the connection.
2595 enum MeshConnectionState
2596 GMC_get_state (const struct MeshConnection *c)
2602 * Get the connection tunnel.
2604 * @param c Connection to get the tunnel from.
2606 * @return tunnel of the connection.
2608 struct MeshTunnel3 *
2609 GMC_get_tunnel (const struct MeshConnection *c)
2616 * Get free buffer space in a connection.
2618 * @param c Connection.
2619 * @param fwd Is query about FWD traffic?
2621 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2624 GMC_get_buffer (struct MeshConnection *c, int fwd)
2626 struct MeshFlowControl *fc;
2628 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2630 return (fc->queue_max - fc->queue_n);
2634 * Get how many messages have we allowed to send to us from a direction.
2636 * @param c Connection.
2637 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2639 * @return last_ack_sent - last_pid_recv
2642 GMC_get_allowed (struct MeshConnection *c, int fwd)
2644 struct MeshFlowControl *fc;
2646 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2647 if (GM_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2651 return (fc->last_ack_sent - fc->last_pid_recv);
2655 * Get messages queued in a connection.
2657 * @param c Connection.
2658 * @param fwd Is query about FWD traffic?
2660 * @return Number of messages queued.
2663 GMC_get_qn (struct MeshConnection *c, int fwd)
2665 struct MeshFlowControl *fc;
2667 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2674 * Allow the connection to advertise a buffer of the given size.
2676 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2677 * allowing up to last_pid_recv + buffer.
2679 * @param c Connection.
2680 * @param buffer How many more messages the connection can accept.
2681 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2684 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2686 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowing %s %u messages %s\n",
2687 GMC_2s (c), buffer, GM_f2s (fwd));
2688 send_ack (c, buffer, fwd, GNUNET_NO);
2693 * Notify other peers on a connection of a broken link. Mark connections
2694 * to destroy after all traffic has been sent.
2696 * @param c Connection on which there has been a disconnection.
2697 * @param peer Peer that disconnected.
2700 GMC_notify_broken (struct MeshConnection *c,
2701 struct MeshPeer *peer)
2705 LOG (GNUNET_ERROR_TYPE_DEBUG,
2706 " notify broken on %s due to %s disconnect\n",
2707 GMC_2s (c), GMP_2s (peer));
2709 fwd = peer == get_prev_hop (c);
2711 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2713 /* Local shutdown, no one to notify about this. */
2717 if (GNUNET_NO == c->destroy)
2718 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2720 /* Connection will have at least one pending message
2721 * (the one we just scheduled), so no point in checking whether to
2722 * destroy immediately. */
2723 c->destroy = GNUNET_YES;
2724 c->state = MESH_CONNECTION_DESTROYED;
2727 * Cancel all queues, if no message is left, connection will be destroyed.
2729 connection_cancel_queues (c, !fwd);
2736 * Is this peer the first one on the connection?
2738 * @param c Connection.
2739 * @param fwd Is this about fwd traffic?
2741 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2744 GMC_is_origin (struct MeshConnection *c, int fwd)
2746 if (!fwd && c->path->length - 1 == c->own_pos )
2748 if (fwd && 0 == c->own_pos)
2755 * Is this peer the last one on the connection?
2757 * @param c Connection.
2758 * @param fwd Is this about fwd traffic?
2759 * Note that the ROOT is the terminal for BCK traffic!
2761 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2764 GMC_is_terminal (struct MeshConnection *c, int fwd)
2766 return GMC_is_origin (c, !fwd);
2771 * See if we are allowed to send by the next hop in the given direction.
2773 * @param c Connection.
2774 * @param fwd Is this about fwd traffic?
2776 * @return #GNUNET_YES in case it's OK to send.
2779 GMC_is_sendable (struct MeshConnection *c, int fwd)
2781 struct MeshFlowControl *fc;
2788 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2789 if (GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2795 * Sends an already built message on a connection, properly registering
2796 * all used resources.
2798 * @param message Message to send. Function makes a copy of it.
2799 * If message is not hop-by-hop, decrements TTL of copy.
2800 * @param c Connection on which this message is transmitted.
2801 * @param fwd Is this a fwd message?
2802 * @param force Force the connection to accept the message (buffer overfill).
2803 * @param cont Continuation called once message is sent. Can be NULL.
2804 * @param cont_cls Closure for @c cont.
2806 * @return Handle to cancel the message before it's sent.
2807 * NULL on error or if @c cont is NULL.
2808 * Invalid on @c cont call.
2810 struct MeshConnectionQueue *
2811 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2812 struct MeshConnection *c, int fwd, int force,
2813 GMC_sent cont, void *cont_cls)
2815 struct MeshFlowControl *fc;
2816 struct MeshConnectionQueue *q;
2822 size = ntohs (message->size);
2823 data = GNUNET_malloc (size);
2824 memcpy (data, message, size);
2825 type = ntohs (message->type);
2826 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send %s (%u bytes) on connection %s\n",
2827 GM_m2s (type), size, GMC_2s (c));
2829 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2830 droppable = GNUNET_NO == force;
2833 struct GNUNET_MESH_Encrypted *emsg;
2834 struct GNUNET_MESH_KX *kmsg;
2835 struct GNUNET_MESH_ACK *amsg;
2836 struct GNUNET_MESH_Poll *pmsg;
2837 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2838 struct GNUNET_MESH_ConnectionBroken *bmsg;
2841 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2842 emsg = (struct GNUNET_MESH_Encrypted *) data;
2843 ttl = ntohl (emsg->ttl);
2846 GNUNET_break_op (0);
2851 emsg->ttl = htonl (ttl - 1);
2852 emsg->pid = htonl (fc->next_pid++);
2853 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2854 if (GNUNET_YES == droppable)
2857 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2858 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2859 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2863 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2865 if (GM_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2867 GMC_start_poll (c, fwd);
2871 case GNUNET_MESSAGE_TYPE_MESH_KX:
2872 kmsg = (struct GNUNET_MESH_KX *) data;
2876 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2877 amsg = (struct GNUNET_MESH_ACK *) data;
2879 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2880 droppable = GNUNET_NO;
2883 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2884 pmsg = (struct GNUNET_MESH_Poll *) data;
2886 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2887 droppable = GNUNET_NO;
2890 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2891 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2896 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2897 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2902 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2903 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2904 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
2913 if (fc->queue_n > fc->queue_max && droppable)
2915 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2918 LOG (GNUNET_ERROR_TYPE_DEBUG,
2919 "queue full: %u/%u\n",
2920 fc->queue_n, fc->queue_max);
2921 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2927 return NULL; /* Drop this message */
2930 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2931 c->pending_messages++;
2933 q = GNUNET_new (struct MeshConnectionQueue);
2934 q->forced = !droppable;
2935 q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2939 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING dropping msg on %s\n", GMC_2s (c));
2945 q->cont_cls = cont_cls;
2951 * Cancel a previously sent message while it's in the queue.
2953 * ONLY can be called before the continuation given to the send function
2954 * is called. Once the continuation is called, the message is no longer in the
2957 * @param q Handle to the queue.
2960 GMC_cancel (struct MeshConnectionQueue *q)
2962 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
2964 /* queue destroy calls message_sent, which calls q->cont and frees q */
2965 GMP_queue_destroy (q->q, GNUNET_YES);
2970 * Sends a CREATE CONNECTION message for a path to a peer.
2971 * Changes the connection and tunnel states if necessary.
2973 * @param connection Connection to create.
2976 GMC_send_create (struct MeshConnection *connection)
2978 enum MeshTunnel3CState state;
2981 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2982 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2984 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection create\n");
2985 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2986 connection, connection->pending_messages);
2987 connection->pending_messages++;
2989 connection->maintenance_q =
2990 GMP_queue_add (get_next_hop (connection), NULL,
2991 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2992 size, connection, GNUNET_YES, &message_sent, NULL);
2994 state = GMT_get_cstate (connection->t);
2995 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2996 GMT_change_cstate (connection->t, MESH_TUNNEL3_WAITING);
2997 if (MESH_CONNECTION_NEW == connection->state)
2998 connection_change_state (connection, MESH_CONNECTION_SENT);
3003 * Send a message to all peers in this connection that the connection
3004 * is no longer valid.
3006 * If some peer should not receive the message, it should be zero'ed out
3007 * before calling this function.
3009 * @param c The connection whose peers to notify.
3012 GMC_send_destroy (struct MeshConnection *c)
3014 struct GNUNET_MESH_ConnectionDestroy msg;
3016 if (GNUNET_YES == c->destroy)
3019 msg.header.size = htons (sizeof (msg));
3020 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
3022 LOG (GNUNET_ERROR_TYPE_DEBUG,
3023 " sending connection destroy for connection %s\n",
3026 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
3027 GMC_send_prebuilt_message (&msg.header, c,
3028 GNUNET_YES, GNUNET_YES, NULL, NULL);
3029 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
3030 GMC_send_prebuilt_message (&msg.header, c,
3031 GNUNET_NO, GNUNET_YES, NULL, NULL);
3032 c->destroy = GNUNET_YES;
3033 c->state = MESH_CONNECTION_DESTROYED;
3038 * @brief Start a polling timer for the connection.
3040 * When a neighbor does not accept more traffic on the connection it could be
3041 * caused by a simple congestion or by a lost ACK. Polling enables to check
3042 * for the lastest ACK status for a connection.
3044 * @param c Connection.
3045 * @param fwd Should we poll in the FWD direction?
3048 GMC_start_poll (struct MeshConnection *c, int fwd)
3050 struct MeshFlowControl *fc;
3052 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3053 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
3055 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
3057 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
3058 fc->poll_task, fc->poll_msg);
3061 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
3062 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
3069 * @brief Stop polling a connection for ACKs.
3071 * Once we have enough ACKs for future traffic, polls are no longer necessary.
3073 * @param c Connection.
3074 * @param fwd Should we stop the poll in the FWD direction?
3077 GMC_stop_poll (struct MeshConnection *c, int fwd)
3079 struct MeshFlowControl *fc;
3081 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3082 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
3084 GNUNET_SCHEDULER_cancel (fc->poll_task);
3085 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
3090 * Get a (static) string for a connection.
3092 * @param c Connection.
3095 GMC_2s (const struct MeshConnection *c)
3102 static char buf[128];
3104 sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
3107 return GNUNET_h2s (&c->id);