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_MESH_Hash 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 * Resets the connection timeout task, some other message has done the
349 * - For the first peer on the direction this means to send
350 * a keepalive or a path confirmation message (either create or ACK).
351 * - For all other peers, this means to destroy the connection,
352 * due to lack of activity.
353 * Starts the timeout if no timeout was running (connection just created).
355 * @param c Connection whose timeout to reset.
356 * @param fwd Is this forward?
359 connection_reset_timeout (struct MeshConnection *c, int fwd);
363 * Get string description for tunnel state. Reentrant.
365 * @param s Tunnel state.
367 * @return String representation.
370 GMC_state2s (enum MeshConnectionState s)
374 case MESH_CONNECTION_NEW:
375 return "MESH_CONNECTION_NEW";
376 case MESH_CONNECTION_SENT:
377 return "MESH_CONNECTION_SENT";
378 case MESH_CONNECTION_ACK:
379 return "MESH_CONNECTION_ACK";
380 case MESH_CONNECTION_READY:
381 return "MESH_CONNECTION_READY";
382 case MESH_CONNECTION_DESTROYED:
383 return "MESH_CONNECTION_DESTROYED";
385 return "MESH_CONNECTION_STATE_ERROR";
391 * Initialize a Flow Control structure to the initial state.
393 * @param fc Flow Control structure to initialize.
396 fc_init (struct MeshFlowControl *fc)
399 fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
400 fc->last_pid_recv = (uint32_t) -1;
401 fc->last_ack_sent = (uint32_t) 0;
402 fc->last_ack_recv = (uint32_t) 0;
403 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
404 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
406 fc->queue_max = (max_msgs_queue / max_connections) + 1;
413 * @param cid Connection ID.
415 static struct MeshConnection *
416 connection_get (const struct GNUNET_MESH_Hash *cid)
418 return GNUNET_CONTAINER_multihashmap_get (connections, GM_h2hc (cid));
423 connection_change_state (struct MeshConnection* c,
424 enum MeshConnectionState state)
426 LOG (GNUNET_ERROR_TYPE_DEBUG,
427 "Connection %s state %s -> %s\n",
428 GMC_2s (c), GMC_state2s (c->state), GMC_state2s (state));
429 if (MESH_CONNECTION_DESTROYED == c->state)
431 LOG (GNUNET_ERROR_TYPE_DEBUG, "state not changing anymore\n");
435 if (MESH_CONNECTION_READY == state)
441 * Callback called when a queued ACK message is sent.
443 * @param cls Closure (FC).
444 * @param c Connection this message was on.
445 * @param q Queue handler this call invalidates.
446 * @param type Type of message sent.
447 * @param fwd Was this a FWD going message?
448 * @param size Size of the message.
452 struct MeshConnection *c,
453 struct MeshConnectionQueue *q,
454 uint16_t type, int fwd, size_t size)
456 struct MeshFlowControl *fc = cls;
463 * Send an ACK on the connection, informing the predecessor about
464 * the available buffer space. Should not be called in case the peer
465 * is origin (no predecessor) in the @c fwd direction.
467 * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
468 * the ACK itself goes "back" (dest->root).
470 * @param c Connection on which to send the ACK.
471 * @param buffer How much space free to advertise?
472 * @param fwd Is this FWD ACK? (Going dest -> root)
473 * @param force Don't optimize out.
476 send_ack (struct MeshConnection *c, unsigned int buffer, int fwd, int force)
478 struct MeshFlowControl *next_fc;
479 struct MeshFlowControl *prev_fc;
480 struct GNUNET_MESH_ACK msg;
484 /* If origin, there is no connection to send ACKs. Wrong function! */
485 if (GMC_is_origin (c, fwd))
487 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection %s is origin in %s\n",
488 GMC_2s (c), GM_f2s (fwd));
493 next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
494 prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
496 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection send %s ack on %s\n",
497 GM_f2s (fwd), GMC_2s (c));
499 /* Check if we need to transmit the ACK. */
500 delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
501 if (3 < delta && buffer < delta && GNUNET_NO == force)
503 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
504 LOG (GNUNET_ERROR_TYPE_DEBUG,
505 " last pid recv: %u, last ack sent: %u\n",
506 prev_fc->last_pid_recv, prev_fc->last_ack_sent);
510 /* Ok, ACK might be necessary, what PID to ACK? */
511 ack = prev_fc->last_pid_recv + buffer;
512 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
513 LOG (GNUNET_ERROR_TYPE_DEBUG,
514 " last pid %u, last ack %u, qmax %u, q %u\n",
515 prev_fc->last_pid_recv, prev_fc->last_ack_sent,
516 next_fc->queue_max, next_fc->queue_n);
517 if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
519 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
523 /* Check if message is already in queue */
524 if (NULL != prev_fc->ack_msg)
526 if (GM_is_pid_bigger (ack, prev_fc->last_ack_sent))
528 LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
529 GMC_cancel (prev_fc->ack_msg);
530 /* GMC_cancel triggers ack_sent(), which clears fc->ack_msg */
534 LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
539 prev_fc->last_ack_sent = ack;
541 /* Build ACK message and send on connection */
542 msg.header.size = htons (sizeof (msg));
543 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
544 msg.ack = htonl (ack);
547 prev_fc->ack_msg = GMC_send_prebuilt_message (&msg.header, c,
554 * Callback called when a queued message is sent.
556 * Calculates the average time and connection packet tracking.
558 * @param cls Closure (ConnectionQueue Handle).
559 * @param c Connection this message was on.
560 * @param sent Was it really sent? (Could have been canceled)
561 * @param type Type of message sent.
562 * @param fwd Was this a FWD going message?
563 * @param size Size of the message.
564 * @param wait Time spent waiting for core (only the time for THIS message)
567 message_sent (void *cls,
568 struct MeshConnection *c, int sent,
569 uint16_t type, int fwd, size_t size,
570 struct GNUNET_TIME_Relative wait)
572 struct MeshConnectionPerformance *p;
573 struct MeshFlowControl *fc;
574 struct MeshConnectionQueue *q = cls;
578 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection message_sent\n");
580 fc = fwd ? &c->fwd_fc : &c->bck_fc;
581 LOG (GNUNET_ERROR_TYPE_DEBUG, " %ssent %s %s\n",
582 sent ? "" : "not ", GM_f2s (fwd), GM_m2s (type));
583 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P- %p %u\n", c, c->pending_messages);
589 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling cont\n");
590 q->cont (q->cont_cls, c, q, type, fwd, size);
594 else if (type == GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED)
596 /* If NULL == q and ENCRYPTED == type, message must have been ch_mngmnt */
603 c->pending_messages--;
604 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
606 LOG (GNUNET_ERROR_TYPE_DEBUG, "! destroying connection!\n");
610 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
613 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
614 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
615 c->maintenance_q = NULL;
616 /* Don't trigger a keepalive for sent ACKs, only SYN and SYNACKs */
617 if (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE == type || !fwd)
618 schedule_next_keepalive (c, fwd);
621 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
622 if (GNUNET_YES == sent)
625 LOG (GNUNET_ERROR_TYPE_DEBUG, "! Q_N- %p %u\n", fc, fc->queue_n);
626 if (GNUNET_NO == forced)
629 LOG (GNUNET_ERROR_TYPE_DEBUG,
630 "! accounting pid %u\n",
635 LOG (GNUNET_ERROR_TYPE_DEBUG,
636 "! forced, Q_N not accounting pid %u\n",
639 if (GNUNET_YES == sent)
641 GMC_send_ack (c, fwd, GNUNET_NO);
642 connection_reset_timeout (c, fwd);
646 case GNUNET_MESSAGE_TYPE_MESH_POLL:
650 case GNUNET_MESSAGE_TYPE_MESH_ACK:
657 LOG (GNUNET_ERROR_TYPE_DEBUG, "! message sent!\n");
660 return; /* Only endpoints are interested in timing. */
663 usecsperbyte = ((double) wait.rel_value_us) / size;
664 if (p->size == AVG_MSGS)
666 /* Array is full. Substract oldest value, add new one and store. */
667 p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
668 p->usecsperbyte[p->idx] = usecsperbyte;
669 p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
673 /* Array not yet full. Add current value to avg and store. */
674 p->usecsperbyte[p->idx] = usecsperbyte;
676 p->avg += p->usecsperbyte[p->idx];
680 p->idx = (p->idx + 1) % AVG_MSGS;
685 * Get the previous hop in a connection
687 * @param c Connection.
689 * @return Previous peer in the connection.
691 static struct MeshPeer *
692 get_prev_hop (const struct MeshConnection *c)
696 LOG (GNUNET_ERROR_TYPE_DEBUG, " get prev hop %s [%u/%u]\n",
697 GMC_2s (c), c->own_pos, c->path->length);
698 if (0 == c->own_pos || c->path->length < 2)
699 id = c->path->peers[0];
701 id = c->path->peers[c->own_pos - 1];
703 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s (%u)\n",
704 GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
706 return GMP_get_short (id);
711 * Get the next hop in a connection
713 * @param c Connection.
715 * @return Next peer in the connection.
717 static struct MeshPeer *
718 get_next_hop (const struct MeshConnection *c)
722 LOG (GNUNET_ERROR_TYPE_DEBUG, " get next hop %s [%u/%u]\n",
723 GMC_2s (c), c->own_pos, c->path->length);
724 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
725 id = c->path->peers[c->path->length - 1];
727 id = c->path->peers[c->own_pos + 1];
729 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s (%u)\n",
730 GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
732 return GMP_get_short (id);
737 * Get the hop in a connection.
739 * @param c Connection.
740 * @param fwd Next hop?
742 * @return Next peer in the connection.
744 static struct MeshPeer *
745 get_hop (struct MeshConnection *c, int fwd)
748 return get_next_hop (c);
749 return get_prev_hop (c);
754 * Is traffic coming from this sender 'FWD' traffic?
756 * @param c Connection to check.
757 * @param sender Peer identity of neighbor.
759 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
760 * the traffic is 'FWD'.
761 * #GNUNET_NO for BCK.
762 * #GNUNET_SYSERR for errors.
765 is_fwd (const struct MeshConnection *c,
766 const struct GNUNET_PeerIdentity *sender)
770 id = GNUNET_PEER_search (sender);
771 if (GMP_get_short_id (get_prev_hop (c)) == id)
774 if (GMP_get_short_id (get_next_hop (c)) == id)
778 return GNUNET_SYSERR;
783 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
784 * or a first CONNECTION_ACK directed to us.
786 * @param connection Connection to confirm.
787 * @param fwd Should we send it FWD? (root->dest)
788 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
791 send_connection_ack (struct MeshConnection *connection, int fwd)
793 struct MeshTunnel3 *t;
796 LOG (GNUNET_ERROR_TYPE_INFO, "=> {%18s ACK} on connection %s\n",
797 GM_f2s (!fwd), GMC_2s (connection));
798 GMP_queue_add (get_hop (connection, fwd), NULL,
799 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
800 sizeof (struct GNUNET_MESH_ConnectionACK),
801 connection, fwd, &message_sent, NULL);
802 connection->pending_messages++;
803 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
804 GMT_change_cstate (t, MESH_TUNNEL3_WAITING);
805 if (MESH_CONNECTION_READY != connection->state)
806 connection_change_state (connection, MESH_CONNECTION_SENT);
811 * Send a notification that a connection is broken.
813 * @param c Connection that is broken.
814 * @param id1 Peer that has disconnected.
815 * @param id2 Peer that has disconnected.
816 * @param fwd Direction towards which to send it.
819 send_broken (struct MeshConnection *c,
820 const struct GNUNET_PeerIdentity *id1,
821 const struct GNUNET_PeerIdentity *id2,
824 struct GNUNET_MESH_ConnectionBroken msg;
826 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
827 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
831 GMC_send_prebuilt_message (&msg.header, c, fwd, GNUNET_YES, NULL, NULL);
836 * Send a notification that a connection is broken, when a connection
837 * isn't even created.
839 * @param connection_id Connection ID.
840 * @param id1 Peer that has disconnected.
841 * @param id2 Peer that has disconnected.
842 * @param peer Peer to notify (neighbor who sent the connection).
845 send_broken2 (struct GNUNET_MESH_Hash *connection_id,
846 const struct GNUNET_PeerIdentity *id1,
847 const struct GNUNET_PeerIdentity *id2,
848 GNUNET_PEER_Id peer_id)
850 struct GNUNET_MESH_ConnectionBroken *msg;
851 struct MeshPeer *neighbor;
853 LOG (GNUNET_ERROR_TYPE_INFO, "=> BROKEN on unknown connection %s\n",
854 GNUNET_h2s (GM_h2hc (connection_id)));
856 msg = GNUNET_new (struct GNUNET_MESH_ConnectionBroken);
857 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
858 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
859 msg->cid = *connection_id;
862 neighbor = GMP_get_short (peer_id);
863 GMP_queue_add (neighbor, msg,
864 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
865 sizeof (struct GNUNET_MESH_ConnectionBroken),
866 NULL, GNUNET_SYSERR, /* connection, fwd */
867 NULL, NULL); /* continuation */
872 * Send keepalive packets for a connection.
874 * @param c Connection to keep alive..
875 * @param fwd Is this a FWD keepalive? (owner -> dest).
878 send_connection_keepalive (struct MeshConnection *c, int fwd)
880 struct GNUNET_MessageHeader msg;
882 LOG (GNUNET_ERROR_TYPE_INFO,
883 "keepalive %s for connection %s\n",
884 GM_f2s (fwd), GMC_2s (c));
885 GNUNET_STATISTICS_update (stats, "# keepalives sent", 1, GNUNET_NO);
887 GNUNET_assert (NULL != c->t);
888 msg.size = htons (sizeof (msg));
889 msg.type = htons (GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE);
891 GNUNET_assert (NULL ==
892 GMT_send_prebuilt_message (&msg, c->t, c,
893 GNUNET_NO, NULL, NULL));
898 * Send CONNECTION_{CREATE/ACK} packets for a connection.
900 * @param c Connection for which to send the message.
901 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
904 connection_recreate (struct MeshConnection *c, int fwd)
906 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
910 send_connection_ack (c, GNUNET_NO);
915 * Generic connection timer management.
916 * Depending on the role of the peer in the connection will send the
917 * appropriate message (build or keepalive)
919 * @param c Conncetion to maintain.
923 connection_maintain (struct MeshConnection *c, int fwd)
925 if (GNUNET_NO != c->destroy)
928 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (c->t))
930 /* TODO DHT GET with RO_BART */
935 case MESH_CONNECTION_NEW:
938 case MESH_CONNECTION_SENT:
939 connection_recreate (c, fwd);
941 case MESH_CONNECTION_READY:
942 send_connection_keepalive (c, fwd);
952 * Keep the connection alive.
954 * @param c Connection to keep alive.
955 * @param fwd Direction.
956 * @param shutdown Are we shutting down? (Don't send traffic)
957 * Non-zero value for true, not necessarily GNUNET_YES.
960 connection_keepalive (struct MeshConnection *c, int fwd, int shutdown)
962 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s keepalive for %s\n",
963 GM_f2s (fwd), GMC_2s (c));
966 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
968 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
970 if (GNUNET_NO != shutdown)
973 connection_maintain (c, fwd);
975 /* Next execution will be scheduled by message_sent */
980 * Keep the connection alive in the FWD direction.
982 * @param cls Closure (connection to keepalive).
983 * @param tc TaskContext.
986 connection_fwd_keepalive (void *cls,
987 const struct GNUNET_SCHEDULER_TaskContext *tc)
989 connection_keepalive ((struct MeshConnection *) cls,
991 tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN);
996 * Keep the connection alive in the BCK direction.
998 * @param cls Closure (connection to keepalive).
999 * @param tc TaskContext.
1002 connection_bck_keepalive (void *cls,
1003 const struct GNUNET_SCHEDULER_TaskContext *tc)
1005 connection_keepalive ((struct MeshConnection *) cls,
1007 tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN);
1012 * Schedule next keepalive task, taking in consideration
1013 * the connection state and number of retries.
1015 * If the peer is not the origin, do nothing.
1017 * @param c Connection for which to schedule the next keepalive.
1018 * @param fwd Direction for the next keepalive.
1021 schedule_next_keepalive (struct MeshConnection *c, int fwd)
1023 struct GNUNET_TIME_Relative delay;
1024 GNUNET_SCHEDULER_TaskIdentifier *task_id;
1025 GNUNET_SCHEDULER_Task keepalive_task;
1027 if (GNUNET_NO == GMC_is_origin (c, fwd))
1030 /* Calculate delay to use, depending on the state of the connection */
1031 if (MESH_CONNECTION_READY == c->state)
1033 delay = refresh_connection_time;
1037 if (1 > c->create_retry)
1038 c->create_retry = 1;
1039 delay = GNUNET_TIME_relative_multiply (create_connection_time,
1041 if (c->create_retry < 64)
1042 c->create_retry *= 2;
1045 /* Select direction-dependent parameters */
1046 if (GNUNET_YES == fwd)
1048 task_id = &c->fwd_maintenance_task;
1049 keepalive_task = &connection_fwd_keepalive;
1053 task_id = &c->bck_maintenance_task;
1054 keepalive_task = &connection_bck_keepalive;
1057 /* Check that no one scheduled it before us */
1058 if (GNUNET_SCHEDULER_NO_TASK != *task_id)
1060 /* No need for a _break. It can happen for instance when sending a SYNACK
1061 * for a duplicate SYN: the first SYNACK scheduled the task. */
1062 GNUNET_SCHEDULER_cancel (*task_id);
1065 /* Schedule the task */
1066 *task_id = GNUNET_SCHEDULER_add_delayed (delay, keepalive_task, c);
1067 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "next keepalive in %s\n",
1068 GNUNET_STRINGS_relative_time_to_string (delay, GNUNET_YES));
1073 * @brief Re-initiate traffic on this connection if necessary.
1075 * Check if there is traffic queued towards this peer
1076 * and the core transmit handle is NULL (traffic was stalled).
1077 * If so, call core tmt rdy.
1079 * @param c Connection on which initiate traffic.
1080 * @param fwd Is this about fwd traffic?
1083 connection_unlock_queue (struct MeshConnection *c, int fwd)
1085 struct MeshPeer *peer;
1087 LOG (GNUNET_ERROR_TYPE_DEBUG,
1088 "connection_unlock_queue %s on %s\n",
1089 GM_f2s (fwd), GMC_2s (c));
1091 if (GMC_is_terminal (c, fwd))
1093 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
1097 peer = get_hop (c, fwd);
1098 GMP_queue_unlock (peer, c);
1103 * Cancel all transmissions that belong to a certain connection.
1105 * If the connection is scheduled for destruction and no more messages are left,
1106 * the connection will be destroyed by the continuation call.
1108 * @param c Connection which to cancel. Might be destroyed during this call.
1109 * @param fwd Cancel fwd traffic?
1112 connection_cancel_queues (struct MeshConnection *c, int fwd)
1114 struct MeshFlowControl *fc;
1115 struct MeshPeer *peer;
1117 LOG (GNUNET_ERROR_TYPE_DEBUG,
1118 " *** Cancel %s queues for connection %s\n",
1119 GM_f2s (fwd), GMC_2s (c));
1126 fc = fwd ? &c->fwd_fc : &c->bck_fc;
1127 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
1129 GNUNET_SCHEDULER_cancel (fc->poll_task);
1130 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1131 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
1133 peer = get_hop (c, fwd);
1134 GMP_queue_cancel (peer, c);
1139 * Function called if a connection has been stalled for a while,
1140 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1142 * @param cls Closure (poll ctx).
1143 * @param tc TaskContext.
1146 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1150 * Callback called when a queued POLL message is sent.
1152 * @param cls Closure (FC).
1153 * @param c Connection this message was on.
1154 * @param q Queue handler this call invalidates.
1155 * @param type Type of message sent.
1156 * @param fwd Was this a FWD going message?
1157 * @param size Size of the message.
1160 poll_sent (void *cls,
1161 struct MeshConnection *c,
1162 struct MeshConnectionQueue *q,
1163 uint16_t type, int fwd, size_t size)
1165 struct MeshFlowControl *fc = cls;
1167 if (2 == c->destroy)
1169 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
1172 LOG (GNUNET_ERROR_TYPE_DEBUG,
1173 " *** POLL sent for , scheduling new one!\n");
1174 fc->poll_msg = NULL;
1175 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
1176 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
1177 &connection_poll, fc);
1178 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1183 * Function called if a connection has been stalled for a while,
1184 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1186 * @param cls Closure (poll ctx).
1187 * @param tc TaskContext.
1190 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1192 struct MeshFlowControl *fc = cls;
1193 struct GNUNET_MESH_Poll msg;
1194 struct MeshConnection *c;
1196 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1197 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1203 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
1204 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
1205 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
1206 fc == &c->fwd_fc ? "FWD" : "BCK");
1208 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
1209 msg.header.size = htons (sizeof (msg));
1210 msg.pid = htonl (fc->last_pid_sent);
1211 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1212 fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c,
1213 fc == &c->fwd_fc, GNUNET_YES,
1219 * Timeout function due to lack of keepalive/traffic from the owner.
1220 * Destroys connection if called.
1222 * @param cls Closure (connection to destroy).
1223 * @param tc TaskContext.
1226 connection_fwd_timeout (void *cls,
1227 const struct GNUNET_SCHEDULER_TaskContext *tc)
1229 struct MeshConnection *c = cls;
1231 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1232 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1235 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1237 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1248 * Timeout function due to lack of keepalive/traffic from the destination.
1249 * Destroys connection if called.
1251 * @param cls Closure (connection to destroy).
1252 * @param tc TaskContext
1255 connection_bck_timeout (void *cls,
1256 const struct GNUNET_SCHEDULER_TaskContext *tc)
1258 struct MeshConnection *c = cls;
1260 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1261 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1264 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1267 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1278 * Resets the connection timeout task, some other message has done the
1280 * - For the first peer on the direction this means to send
1281 * a keepalive or a path confirmation message (either create or ACK).
1282 * - For all other peers, this means to destroy the connection,
1283 * due to lack of activity.
1284 * Starts the timeout if no timeout was running (connection just created).
1286 * @param c Connection whose timeout to reset.
1287 * @param fwd Is this forward?
1289 * TODO use heap to improve efficiency of scheduler.
1292 connection_reset_timeout (struct MeshConnection *c, int fwd)
1294 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GM_f2s (fwd));
1296 if (GMC_is_origin (c, fwd)) /* Startpoint */
1298 schedule_next_keepalive (c, fwd);
1300 else /* Relay, endpoint. */
1302 struct GNUNET_TIME_Relative delay;
1303 GNUNET_SCHEDULER_TaskIdentifier *ti;
1304 GNUNET_SCHEDULER_Task f;
1306 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1308 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1309 GNUNET_SCHEDULER_cancel (*ti);
1310 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1311 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1312 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1318 * Add the connection to the list of both neighbors.
1320 * @param c Connection.
1322 * @return #GNUNET_OK if everything went fine
1323 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1326 register_neighbors (struct MeshConnection *c)
1328 struct MeshPeer *next_peer;
1329 struct MeshPeer *prev_peer;
1331 next_peer = get_next_hop (c);
1332 prev_peer = get_prev_hop (c);
1334 LOG (GNUNET_ERROR_TYPE_DEBUG, "register neighbors for connection %s\n",
1336 path_debug (c->path);
1337 LOG (GNUNET_ERROR_TYPE_DEBUG, "own pos %u\n", c->own_pos);
1338 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to next peer %p\n",
1339 GMC_2s (c), next_peer);
1340 LOG (GNUNET_ERROR_TYPE_DEBUG, "next peer %p %s\n", next_peer, GMP_2s (next_peer));
1341 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to prev peer %p\n",
1342 GMC_2s (c), prev_peer);
1343 LOG (GNUNET_ERROR_TYPE_DEBUG, "prev peer %p %s\n", prev_peer, GMP_2s (prev_peer));
1345 if (GNUNET_NO == GMP_is_neighbor (next_peer)
1346 || GNUNET_NO == GMP_is_neighbor (prev_peer))
1348 if (GMC_is_origin (c, GNUNET_YES))
1349 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1350 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1352 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1353 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1354 GMP_2s (prev_peer), GMP_is_neighbor (prev_peer));
1355 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1356 GMP_2s (next_peer), GMP_is_neighbor (next_peer));
1357 return GNUNET_SYSERR;
1360 GMP_add_connection (next_peer, c);
1361 GMP_add_connection (prev_peer, c);
1368 * Remove the connection from the list of both neighbors.
1370 * @param c Connection.
1373 unregister_neighbors (struct MeshConnection *c)
1375 struct MeshPeer *peer;
1377 peer = get_next_hop (c);
1378 if (GNUNET_OK != GMP_remove_connection (peer, c))
1380 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1381 || MESH_CONNECTION_DESTROYED == c->state);
1382 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1383 if (NULL != c->t) GMT_debug (c->t);
1386 peer = get_prev_hop (c);
1387 if (GNUNET_OK != GMP_remove_connection (peer, c))
1389 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1390 || MESH_CONNECTION_DESTROYED == c->state);
1391 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1392 if (NULL != c->t) GMT_debug (c->t);
1398 * Bind the connection to the peer and the tunnel to that peer.
1400 * If the peer has no tunnel, create one. Update tunnel and connection
1401 * data structres to reflect new status.
1403 * @param c Connection.
1407 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1409 GMP_add_tunnel (peer);
1410 c->t = GMP_get_tunnel (peer);
1411 GMT_add_connection (c->t, c);
1416 * Builds a path from a PeerIdentity array.
1418 * @param peers PeerIdentity array.
1419 * @param size Size of the @c peers array.
1420 * @param own_pos Output parameter: own position in the path.
1422 * @return Fixed and shortened path.
1424 static struct MeshPeerPath *
1425 build_path_from_peer_ids (struct GNUNET_PeerIdentity *peers,
1427 unsigned int *own_pos)
1429 struct MeshPeerPath *path;
1430 GNUNET_PEER_Id shortid;
1433 unsigned int offset;
1436 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1437 path = path_new (size);
1440 for (i = 0; i < size; i++)
1442 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %u: taking %s\n",
1443 i, GNUNET_i2s (&peers[i]));
1444 shortid = GNUNET_PEER_intern (&peers[i]);
1446 /* Check for loops / duplicates */
1447 for (j = 0; j < i - offset; j++)
1449 if (path->peers[j] == shortid)
1451 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists at pos %u\n", j);
1453 LOG (GNUNET_ERROR_TYPE_DEBUG, " offset now %u\n", offset);
1454 GNUNET_PEER_change_rc (shortid, -1);
1457 LOG (GNUNET_ERROR_TYPE_DEBUG, " storing at %u\n", i - offset);
1458 path->peers[i - offset] = shortid;
1459 if (path->peers[i - offset] == myid)
1460 *own_pos = i - offset;
1462 path->length -= offset;
1464 if (path->peers[*own_pos] != myid)
1466 /* create path: self not found in path through self */
1467 GNUNET_break_op (0);
1468 path_destroy (path);
1477 * Log receipt of message on stderr (INFO level).
1479 * @param message Message received.
1480 * @param peer Peer who sent the message.
1481 * @param hash Connection ID.
1484 log_message (const struct GNUNET_MessageHeader *message,
1485 const struct GNUNET_PeerIdentity *peer,
1486 const struct GNUNET_MESH_Hash *hash)
1488 LOG (GNUNET_ERROR_TYPE_INFO, "<- %s on connection %s from %s\n",
1489 GM_m2s (ntohs (message->type)), GNUNET_h2s (GM_h2hc (hash)),
1493 /******************************************************************************/
1494 /******************************** API ***********************************/
1495 /******************************************************************************/
1498 * Core handler for connection creation.
1500 * @param cls Closure (unused).
1501 * @param peer Sender (neighbor).
1502 * @param message Message.
1504 * @return GNUNET_OK to keep the connection open,
1505 * GNUNET_SYSERR to close it (signal serious error)
1508 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1509 const struct GNUNET_MessageHeader *message)
1511 struct GNUNET_MESH_ConnectionCreate *msg;
1512 struct GNUNET_PeerIdentity *id;
1513 struct GNUNET_MESH_Hash *cid;
1514 struct MeshPeerPath *path;
1515 struct MeshPeer *dest_peer;
1516 struct MeshPeer *orig_peer;
1517 struct MeshConnection *c;
1518 unsigned int own_pos;
1522 size = ntohs (message->size);
1523 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1525 GNUNET_break_op (0);
1529 /* Calculate hops */
1530 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1531 if (size % sizeof (struct GNUNET_PeerIdentity))
1533 GNUNET_break_op (0);
1536 size /= sizeof (struct GNUNET_PeerIdentity);
1539 GNUNET_break_op (0);
1542 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1544 /* Get parameters */
1545 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1547 log_message (message, peer, cid);
1548 id = (struct GNUNET_PeerIdentity *) &msg[1];
1549 LOG (GNUNET_ERROR_TYPE_DEBUG, " origin: %s\n", GNUNET_i2s (id));
1551 /* Create connection */
1552 c = connection_get (cid);
1555 path = build_path_from_peer_ids ((struct GNUNET_PeerIdentity *) &msg[1],
1561 GNUNET_break_op (0);
1562 path_destroy (path);
1565 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1566 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1567 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1570 if (path->length - 1 == own_pos)
1572 /* If we are destination, why did the creation fail? */
1576 send_broken2 (cid, &my_full_id,
1577 GNUNET_PEER_resolve2 (path->peers[own_pos + 1]),
1578 path->peers[own_pos - 1]);
1579 path_destroy (path);
1582 GMP_add_path_to_all (path, GNUNET_NO);
1583 connection_reset_timeout (c, GNUNET_YES);
1587 path = path_duplicate (c->path);
1589 if (MESH_CONNECTION_NEW == c->state)
1590 connection_change_state (c, MESH_CONNECTION_SENT);
1592 /* Remember peers */
1593 dest_peer = GMP_get (&id[size - 1]);
1594 orig_peer = GMP_get (&id[0]);
1596 /* Is it a connection to us? */
1597 if (c->own_pos == path->length - 1)
1599 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1600 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1602 add_to_peer (c, orig_peer);
1603 if (MESH_TUNNEL3_NEW == GMT_get_cstate (c->t))
1604 GMT_change_cstate (c->t, MESH_TUNNEL3_WAITING);
1606 send_connection_ack (c, GNUNET_NO);
1607 if (MESH_CONNECTION_SENT == c->state)
1608 connection_change_state (c, MESH_CONNECTION_ACK);
1612 /* It's for somebody else! Retransmit. */
1613 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1614 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1615 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1616 GMC_send_prebuilt_message (message, c, GNUNET_YES, GNUNET_YES,
1619 path_destroy (path);
1625 * Core handler for path confirmations.
1627 * @param cls closure
1628 * @param message message
1629 * @param peer peer identity this notification is about
1631 * @return GNUNET_OK to keep the connection open,
1632 * GNUNET_SYSERR to close it (signal serious error)
1635 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1636 const struct GNUNET_MessageHeader *message)
1638 struct GNUNET_MESH_ConnectionACK *msg;
1639 struct MeshConnection *c;
1640 struct MeshPeerPath *p;
1641 struct MeshPeer *pi;
1642 enum MeshConnectionState oldstate;
1645 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1646 log_message (message, peer, &msg->cid);
1647 c = connection_get (&msg->cid);
1650 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1652 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1656 if (GNUNET_NO != c->destroy)
1658 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1662 oldstate = c->state;
1663 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1664 pi = GMP_get (peer);
1665 if (get_next_hop (c) == pi)
1667 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1669 if (MESH_CONNECTION_SENT == oldstate)
1670 connection_change_state (c, MESH_CONNECTION_ACK);
1672 else if (get_prev_hop (c) == pi)
1674 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1676 connection_change_state (c, MESH_CONNECTION_READY);
1680 GNUNET_break_op (0);
1684 connection_reset_timeout (c, fwd);
1686 /* Add path to peers? */
1690 GMP_add_path_to_all (p, GNUNET_YES);
1697 /* Message for us as creator? */
1698 if (GMC_is_origin (c, GNUNET_YES))
1700 if (GNUNET_NO != fwd)
1702 GNUNET_break_op (0);
1705 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1707 /* If just created, cancel the short timeout and start a long one */
1708 if (MESH_CONNECTION_SENT == oldstate)
1709 connection_reset_timeout (c, GNUNET_YES);
1711 /* Change connection state */
1712 connection_change_state (c, MESH_CONNECTION_READY);
1713 send_connection_ack (c, GNUNET_YES);
1715 /* Change tunnel state, trigger KX */
1716 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1717 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1722 /* Message for us as destination? */
1723 if (GMC_is_terminal (c, GNUNET_YES))
1725 if (GNUNET_YES != fwd)
1727 GNUNET_break_op (0);
1730 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1732 /* If just created, cancel the short timeout and start a long one */
1733 if (MESH_CONNECTION_ACK == oldstate)
1734 connection_reset_timeout (c, GNUNET_NO);
1736 /* Change tunnel state */
1737 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1738 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1743 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1744 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1750 * Core handler for notifications of broken connections.
1752 * @param cls Closure (unused).
1753 * @param id Peer identity of sending neighbor.
1754 * @param message Message.
1756 * @return GNUNET_OK to keep the connection open,
1757 * GNUNET_SYSERR to close it (signal serious error)
1760 GMC_handle_broken (void* cls,
1761 const struct GNUNET_PeerIdentity* id,
1762 const struct GNUNET_MessageHeader* message)
1764 struct GNUNET_MESH_ConnectionBroken *msg;
1765 struct MeshConnection *c;
1768 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1769 log_message (message, id, &msg->cid);
1770 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1771 GNUNET_i2s (&msg->peer1));
1772 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1773 GNUNET_i2s (&msg->peer2));
1774 c = connection_get (&msg->cid);
1777 LOG (GNUNET_ERROR_TYPE_DEBUG, " duplicate CONNECTION_BROKEN\n");
1781 fwd = is_fwd (c, id);
1782 if (GMC_is_terminal (c, fwd))
1784 struct GNUNET_MessageHeader *out_msg;
1785 struct MeshPeer *neighbor;
1786 struct MeshPeer *endpoint;
1788 neighbor = get_hop (c, !fwd);
1789 endpoint = GMP_get_short (c->path->peers[c->path->length - 1]);
1790 path_invalidate (c->path);
1791 GMP_notify_broken_link (endpoint, &msg->peer1, &msg->peer2);
1792 c->state = MESH_CONNECTION_DESTROYED;
1793 while (NULL != (out_msg = GMP_connection_pop (neighbor, c)))
1795 GNUNET_assert (NULL ==
1796 GMT_send_prebuilt_message (out_msg, c->t, NULL, GNUNET_YES,
1804 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1805 c->destroy = GNUNET_YES;
1806 connection_cancel_queues (c, !fwd);
1815 * Core handler for tunnel destruction
1817 * @param cls Closure (unused).
1818 * @param peer Peer identity of sending neighbor.
1819 * @param message Message.
1821 * @return GNUNET_OK to keep the connection open,
1822 * GNUNET_SYSERR to close it (signal serious error)
1825 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1826 const struct GNUNET_MessageHeader *message)
1828 struct GNUNET_MESH_ConnectionDestroy *msg;
1829 struct MeshConnection *c;
1832 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1833 log_message (message, peer, &msg->cid);
1834 c = connection_get (&msg->cid);
1837 /* Probably already got the message from another path,
1838 * destroyed the tunnel and retransmitted to children.
1841 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1843 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1846 fwd = is_fwd (c, peer);
1847 if (GNUNET_SYSERR == fwd)
1849 GNUNET_break_op (0); /* FIXME */
1852 if (GNUNET_NO == GMC_is_terminal (c, fwd))
1853 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1854 else if (0 == c->pending_messages)
1856 LOG (GNUNET_ERROR_TYPE_DEBUG, "! directly destroying connection!\n");
1860 c->destroy = GNUNET_YES;
1861 c->state = MESH_CONNECTION_DESTROYED;
1864 GMT_remove_connection (c->t, c);
1872 * Generic handler for mesh network encrypted traffic.
1874 * @param peer Peer identity this notification is about.
1875 * @param msg Encrypted message.
1877 * @return GNUNET_OK to keep the connection open,
1878 * GNUNET_SYSERR to close it (signal serious error)
1881 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1882 const struct GNUNET_MESH_Encrypted *msg)
1884 struct MeshConnection *c;
1885 struct MeshPeer *neighbor;
1886 struct MeshFlowControl *fc;
1887 GNUNET_PEER_Id peer_id;
1893 log_message (&msg->header, peer, &msg->cid);
1896 size = ntohs (msg->header.size);
1898 sizeof (struct GNUNET_MESH_Encrypted) +
1899 sizeof (struct GNUNET_MessageHeader))
1901 GNUNET_break_op (0);
1905 /* Check connection */
1906 c = connection_get (&msg->cid);
1909 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1910 LOG (GNUNET_ERROR_TYPE_DEBUG, "enc on unknown connection %s\n",
1911 GNUNET_h2s (GM_h2hc (&msg->cid)));
1915 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s\n", GMC_2s (c));
1917 /* Check if origin is as expected */
1918 neighbor = get_prev_hop (c);
1919 peer_id = GNUNET_PEER_search (peer);
1920 if (peer_id == GMP_get_short_id (neighbor))
1926 neighbor = get_next_hop (c);
1927 if (peer_id == GMP_get_short_id (neighbor))
1933 /* Unexpected peer sending traffic on a connection. */
1934 GNUNET_break_op (0);
1940 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1941 pid = ntohl (msg->pid);
1942 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u (expected %u+)\n",
1943 pid, fc->last_pid_recv + 1);
1944 if (GM_is_pid_bigger (pid, fc->last_ack_sent))
1946 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1947 LOG (GNUNET_ERROR_TYPE_DEBUG,
1948 "WARNING Received PID %u, (prev %u), ACK %u\n",
1949 pid, fc->last_pid_recv, fc->last_ack_sent);
1952 if (GNUNET_NO == GM_is_pid_bigger (pid, fc->last_pid_recv))
1954 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1955 LOG (GNUNET_ERROR_TYPE_DEBUG,
1956 " PID %u not expected (%u+), dropping!\n",
1957 pid, fc->last_pid_recv + 1);
1960 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1961 connection_change_state (c, MESH_CONNECTION_READY);
1962 connection_reset_timeout (c, fwd);
1963 fc->last_pid_recv = pid;
1965 /* Is this message for us? */
1966 if (GMC_is_terminal (c, fwd))
1968 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1969 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1973 GNUNET_break (GNUNET_NO != c->destroy);
1976 fc->last_pid_recv = pid;
1977 GMT_handle_encrypted (c->t, msg);
1978 GMC_send_ack (c, fwd, GNUNET_NO);
1982 /* Message not for us: forward to next hop */
1983 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1984 ttl = ntohl (msg->ttl);
1985 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1988 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1989 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1990 GMC_send_ack (c, fwd, GNUNET_NO);
1994 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1995 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
2001 * Generic handler for mesh network encrypted traffic.
2003 * @param peer Peer identity this notification is about.
2004 * @param msg Encrypted message.
2006 * @return GNUNET_OK to keep the connection open,
2007 * GNUNET_SYSERR to close it (signal serious error)
2010 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
2011 const struct GNUNET_MESH_KX *msg)
2013 struct MeshConnection *c;
2014 struct MeshPeer *neighbor;
2015 GNUNET_PEER_Id peer_id;
2019 log_message (&msg->header, peer, &msg->cid);
2022 size = ntohs (msg->header.size);
2024 sizeof (struct GNUNET_MESH_KX) +
2025 sizeof (struct GNUNET_MessageHeader))
2027 GNUNET_break_op (0);
2031 /* Check connection */
2032 c = connection_get (&msg->cid);
2035 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
2036 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx on unknown connection %s\n",
2037 GNUNET_h2s (GM_h2hc (&msg->cid)));
2040 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
2042 /* Check if origin is as expected */
2043 neighbor = get_prev_hop (c);
2044 peer_id = GNUNET_PEER_search (peer);
2045 if (peer_id == GMP_get_short_id (neighbor))
2051 neighbor = get_next_hop (c);
2052 if (peer_id == GMP_get_short_id (neighbor))
2058 /* Unexpected peer sending traffic on a connection. */
2059 GNUNET_break_op (0);
2064 /* Count as connection confirmation. */
2065 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
2067 connection_change_state (c, MESH_CONNECTION_READY);
2070 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
2071 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
2074 connection_reset_timeout (c, fwd);
2076 /* Is this message for us? */
2077 if (GMC_is_terminal (c, fwd))
2079 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
2080 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
2086 GMT_handle_kx (c->t, &msg[1].header);
2090 /* Message not for us: forward to next hop */
2091 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
2092 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2093 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
2100 * Core handler for encrypted mesh network traffic (channel mgmt, data).
2102 * @param cls Closure (unused).
2103 * @param message Message received.
2104 * @param peer Peer who sent the message.
2106 * @return GNUNET_OK to keep the connection open,
2107 * GNUNET_SYSERR to close it (signal serious error)
2110 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
2111 const struct GNUNET_MessageHeader *message)
2113 return handle_mesh_encrypted (peer,
2114 (struct GNUNET_MESH_Encrypted *)message);
2119 * Core handler for key exchange traffic (ephemeral key, ping, pong).
2121 * @param cls Closure (unused).
2122 * @param message Message received.
2123 * @param peer Peer who sent the message.
2125 * @return GNUNET_OK to keep the connection open,
2126 * GNUNET_SYSERR to close it (signal serious error)
2129 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
2130 const struct GNUNET_MessageHeader *message)
2132 return handle_mesh_kx (peer,
2133 (struct GNUNET_MESH_KX *) message);
2138 * Core handler for mesh network traffic point-to-point acks.
2140 * @param cls closure
2141 * @param message message
2142 * @param peer peer identity this notification is about
2144 * @return GNUNET_OK to keep the connection open,
2145 * GNUNET_SYSERR to close it (signal serious error)
2148 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
2149 const struct GNUNET_MessageHeader *message)
2151 struct GNUNET_MESH_ACK *msg;
2152 struct MeshConnection *c;
2153 struct MeshFlowControl *fc;
2158 msg = (struct GNUNET_MESH_ACK *) message;
2159 log_message (message, peer, &msg->cid);
2160 c = connection_get (&msg->cid);
2163 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
2168 /* Is this a forward or backward ACK? */
2169 id = GNUNET_PEER_search (peer);
2170 if (GMP_get_short_id (get_next_hop (c)) == id)
2172 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
2176 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2178 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
2184 GNUNET_break_op (0);
2188 ack = ntohl (msg->ack);
2189 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
2190 ack, fc->last_ack_recv);
2191 if (GM_is_pid_bigger (ack, fc->last_ack_recv))
2192 fc->last_ack_recv = ack;
2194 /* Cancel polling if the ACK is big enough. */
2195 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
2196 GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2198 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
2199 GNUNET_SCHEDULER_cancel (fc->poll_task);
2200 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2201 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
2204 connection_unlock_queue (c, fwd);
2211 * Core handler for mesh network traffic point-to-point ack polls.
2213 * @param cls closure
2214 * @param message message
2215 * @param peer peer identity this notification is about
2217 * @return GNUNET_OK to keep the connection open,
2218 * GNUNET_SYSERR to close it (signal serious error)
2221 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
2222 const struct GNUNET_MessageHeader *message)
2224 struct GNUNET_MESH_Poll *msg;
2225 struct MeshConnection *c;
2226 struct MeshFlowControl *fc;
2231 msg = (struct GNUNET_MESH_Poll *) message;
2232 log_message (message, peer, &msg->cid);
2233 c = connection_get (&msg->cid);
2236 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
2238 LOG (GNUNET_ERROR_TYPE_DEBUG,
2239 "WARNING POLL message on unknown connection %s!\n",
2240 GNUNET_h2s (GM_h2hc (&msg->cid)));
2244 /* Is this a forward or backward ACK?
2245 * Note: a poll should never be needed in a loopback case,
2246 * since there is no possiblility of packet loss there, so
2247 * this way of discerining FWD/BCK should not be a problem.
2249 id = GNUNET_PEER_search (peer);
2250 if (GMP_get_short_id (get_next_hop (c)) == id)
2252 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2255 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2257 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2262 GNUNET_break_op (0);
2266 pid = ntohl (msg->pid);
2267 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2268 fc->last_pid_recv = pid;
2269 fwd = fc == &c->bck_fc;
2270 GMC_send_ack (c, fwd, GNUNET_YES);
2277 * Send an ACK on the appropriate connection/channel, depending on
2278 * the direction and the position of the peer.
2280 * @param c Which connection to send the hop-by-hop ACK.
2281 * @param fwd Is this a fwd ACK? (will go dest->root).
2282 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2285 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
2287 unsigned int buffer;
2289 LOG (GNUNET_ERROR_TYPE_DEBUG,
2290 "GMC send %s ACK on %s\n",
2291 GM_f2s (fwd), GMC_2s (c));
2299 if (GNUNET_NO != c->destroy)
2301 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2305 /* Get available buffer space */
2306 if (GMC_is_terminal (c, fwd))
2308 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2309 buffer = GMT_get_channels_buffer (c->t);
2313 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2314 buffer = GMC_get_buffer (c, fwd);
2316 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2317 if (0 == buffer && GNUNET_NO == force)
2320 /* Send available buffer space */
2321 if (GMC_is_origin (c, fwd))
2323 GNUNET_assert (NULL != c->t);
2324 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2325 GMT_unchoke_channels (c->t);
2329 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2330 send_ack (c, buffer, fwd, force);
2336 * Initialize the connections subsystem
2338 * @param c Configuration handle.
2341 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2343 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2345 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2348 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2349 "MESH", "MAX_MSGS_QUEUE", "MISSING");
2350 GNUNET_SCHEDULER_shutdown ();
2355 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2358 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2359 "MESH", "MAX_CONNECTIONS", "MISSING");
2360 GNUNET_SCHEDULER_shutdown ();
2365 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2366 &refresh_connection_time))
2368 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2369 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2370 GNUNET_SCHEDULER_shutdown ();
2373 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2374 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
2379 * Destroy each connection on shutdown.
2381 * @param cls Closure (unused).
2382 * @param key Current key code (CID, unused).
2383 * @param value Value in the hash map (connection)
2385 * @return #GNUNET_YES, because we should continue to iterate,
2388 shutdown_iterator (void *cls,
2389 const struct GNUNET_HashCode *key,
2392 struct MeshConnection *c = value;
2400 * Shut down the connections subsystem.
2405 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2406 GNUNET_CONTAINER_multihashmap_destroy (connections);
2411 struct MeshConnection *
2412 GMC_new (const struct GNUNET_MESH_Hash *cid,
2413 struct MeshTunnel3 *t,
2414 struct MeshPeerPath *p,
2415 unsigned int own_pos)
2417 struct MeshConnection *c;
2419 c = GNUNET_new (struct MeshConnection);
2421 GNUNET_assert (GNUNET_OK ==
2422 GNUNET_CONTAINER_multihashmap_put (connections,
2424 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2425 fc_init (&c->fwd_fc);
2426 fc_init (&c->bck_fc);
2431 GNUNET_assert (own_pos <= p->length - 1);
2432 c->own_pos = own_pos;
2435 if (GNUNET_OK != register_neighbors (c))
2439 path_invalidate (c->path);
2452 GMC_destroy (struct MeshConnection *c)
2460 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2461 return; /* -> message_sent -> GMC_destroy. Don't loop. */
2464 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2465 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2466 &c->fwd_fc, &c->bck_fc);
2467 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2468 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2470 /* Cancel all traffic */
2471 if (NULL != c->path)
2473 connection_cancel_queues (c, GNUNET_YES);
2474 connection_cancel_queues (c, GNUNET_NO);
2475 unregister_neighbors (c);
2478 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2479 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2481 /* Cancel maintainance task (keepalive/timeout) */
2482 if (NULL != c->fwd_fc.poll_msg)
2484 GMC_cancel (c->fwd_fc.poll_msg);
2485 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2487 if (NULL != c->bck_fc.poll_msg)
2489 GMC_cancel (c->bck_fc.poll_msg);
2490 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2493 /* Delete from tunnel */
2495 GMT_remove_connection (c->t, c);
2497 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES) && NULL != c->path)
2498 path_destroy (c->path);
2499 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2500 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2501 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2502 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2503 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2505 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2506 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2508 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2510 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2511 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2514 GNUNET_break (GNUNET_YES ==
2515 GNUNET_CONTAINER_multihashmap_remove (connections,
2518 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2523 * Get the connection ID.
2525 * @param c Connection to get the ID from.
2527 * @return ID of the connection.
2529 const struct GNUNET_MESH_Hash *
2530 GMC_get_id (const struct MeshConnection *c)
2537 * Get the connection ID.
2539 * @param c Connection to get the ID from.
2541 * @return ID of the connection.
2543 const struct GNUNET_HashCode *
2544 GMC_get_h (const struct MeshConnection *c)
2546 return GM_h2hc (&c->id);
2551 * Get the connection path.
2553 * @param c Connection to get the path from.
2555 * @return path used by the connection.
2557 const struct MeshPeerPath *
2558 GMC_get_path (const struct MeshConnection *c)
2560 if (GNUNET_NO == c->destroy)
2567 * Get the connection state.
2569 * @param c Connection to get the state from.
2571 * @return state of the connection.
2573 enum MeshConnectionState
2574 GMC_get_state (const struct MeshConnection *c)
2580 * Get the connection tunnel.
2582 * @param c Connection to get the tunnel from.
2584 * @return tunnel of the connection.
2586 struct MeshTunnel3 *
2587 GMC_get_tunnel (const struct MeshConnection *c)
2594 * Get free buffer space in a connection.
2596 * @param c Connection.
2597 * @param fwd Is query about FWD traffic?
2599 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2602 GMC_get_buffer (struct MeshConnection *c, int fwd)
2604 struct MeshFlowControl *fc;
2606 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2608 return (fc->queue_max - fc->queue_n);
2612 * Get how many messages have we allowed to send to us from a direction.
2614 * @param c Connection.
2615 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2617 * @return last_ack_sent - last_pid_recv
2620 GMC_get_allowed (struct MeshConnection *c, int fwd)
2622 struct MeshFlowControl *fc;
2624 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2625 if (GM_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2629 return (fc->last_ack_sent - fc->last_pid_recv);
2633 * Get messages queued in a connection.
2635 * @param c Connection.
2636 * @param fwd Is query about FWD traffic?
2638 * @return Number of messages queued.
2641 GMC_get_qn (struct MeshConnection *c, int fwd)
2643 struct MeshFlowControl *fc;
2645 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2652 * Allow the connection to advertise a buffer of the given size.
2654 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2655 * allowing up to last_pid_recv + buffer.
2657 * @param c Connection.
2658 * @param buffer How many more messages the connection can accept.
2659 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2662 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2664 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowing %s %u messages %s\n",
2665 GMC_2s (c), buffer, GM_f2s (fwd));
2666 send_ack (c, buffer, fwd, GNUNET_NO);
2671 * Notify other peers on a connection of a broken link. Mark connections
2672 * to destroy after all traffic has been sent.
2674 * @param c Connection on which there has been a disconnection.
2675 * @param peer Peer that disconnected.
2678 GMC_notify_broken (struct MeshConnection *c,
2679 struct MeshPeer *peer)
2683 LOG (GNUNET_ERROR_TYPE_DEBUG,
2684 " notify broken on %s due to %s disconnect\n",
2685 GMC_2s (c), GMP_2s (peer));
2687 fwd = peer == get_prev_hop (c);
2689 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2691 /* Local shutdown, no one to notify about this. */
2695 if (GNUNET_NO == c->destroy)
2696 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2698 /* Connection will have at least one pending message
2699 * (the one we just scheduled), so no point in checking whether to
2700 * destroy immediately. */
2701 c->destroy = GNUNET_YES;
2702 c->state = MESH_CONNECTION_DESTROYED;
2705 * Cancel all queues, if no message is left, connection will be destroyed.
2707 connection_cancel_queues (c, !fwd);
2714 * Is this peer the first one on the connection?
2716 * @param c Connection.
2717 * @param fwd Is this about fwd traffic?
2719 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2722 GMC_is_origin (struct MeshConnection *c, int fwd)
2724 if (!fwd && c->path->length - 1 == c->own_pos )
2726 if (fwd && 0 == c->own_pos)
2733 * Is this peer the last one on the connection?
2735 * @param c Connection.
2736 * @param fwd Is this about fwd traffic?
2737 * Note that the ROOT is the terminal for BCK traffic!
2739 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2742 GMC_is_terminal (struct MeshConnection *c, int fwd)
2744 return GMC_is_origin (c, !fwd);
2749 * See if we are allowed to send by the next hop in the given direction.
2751 * @param c Connection.
2752 * @param fwd Is this about fwd traffic?
2754 * @return #GNUNET_YES in case it's OK to send.
2757 GMC_is_sendable (struct MeshConnection *c, int fwd)
2759 struct MeshFlowControl *fc;
2761 LOG (GNUNET_ERROR_TYPE_DEBUG, " checking sendability of %s traffic on %s\n",
2762 GM_f2s (fwd), GMC_2s (c));
2768 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2769 LOG (GNUNET_ERROR_TYPE_DEBUG, " last ack recv: %u, last pid sent: %u\n",
2770 fc->last_ack_recv, fc->last_pid_sent);
2771 if (GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2777 * Sends an already built message on a connection, properly registering
2778 * all used resources.
2780 * @param message Message to send. Function makes a copy of it.
2781 * If message is not hop-by-hop, decrements TTL of copy.
2782 * @param c Connection on which this message is transmitted.
2783 * @param fwd Is this a fwd message?
2784 * @param force Force the connection to accept the message (buffer overfill).
2785 * @param cont Continuation called once message is sent. Can be NULL.
2786 * @param cont_cls Closure for @c cont.
2788 * @return Handle to cancel the message before it's sent.
2789 * NULL on error or if @c cont is NULL.
2790 * Invalid on @c cont call.
2792 struct MeshConnectionQueue *
2793 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2794 struct MeshConnection *c, int fwd, int force,
2795 GMC_sent cont, void *cont_cls)
2797 struct MeshFlowControl *fc;
2798 struct MeshConnectionQueue *q;
2804 size = ntohs (message->size);
2805 data = GNUNET_malloc (size);
2806 memcpy (data, message, size);
2807 type = ntohs (message->type);
2808 LOG (GNUNET_ERROR_TYPE_INFO, "-> %s on connection %s (%u bytes)\n",
2809 GM_m2s (type), GMC_2s (c), size);
2811 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2812 droppable = GNUNET_NO == force;
2815 struct GNUNET_MESH_Encrypted *emsg;
2816 struct GNUNET_MESH_KX *kmsg;
2817 struct GNUNET_MESH_ACK *amsg;
2818 struct GNUNET_MESH_Poll *pmsg;
2819 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2820 struct GNUNET_MESH_ConnectionBroken *bmsg;
2823 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2824 emsg = (struct GNUNET_MESH_Encrypted *) data;
2825 ttl = ntohl (emsg->ttl);
2828 GNUNET_break_op (0);
2833 emsg->ttl = htonl (ttl - 1);
2834 emsg->pid = htonl (fc->next_pid++);
2835 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2836 if (GNUNET_YES == droppable)
2839 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2840 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2841 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2845 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2847 if (GM_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2849 GMC_start_poll (c, fwd);
2853 case GNUNET_MESSAGE_TYPE_MESH_KX:
2854 kmsg = (struct GNUNET_MESH_KX *) data;
2858 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2859 amsg = (struct GNUNET_MESH_ACK *) data;
2861 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2862 droppable = GNUNET_NO;
2865 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2866 pmsg = (struct GNUNET_MESH_Poll *) data;
2868 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2869 droppable = GNUNET_NO;
2872 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2873 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2877 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2878 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2882 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
2885 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2886 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2895 if (fc->queue_n > fc->queue_max && droppable)
2897 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2900 LOG (GNUNET_ERROR_TYPE_DEBUG,
2901 "queue full: %u/%u\n",
2902 fc->queue_n, fc->queue_max);
2903 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2909 return NULL; /* Drop this message */
2912 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2913 c->pending_messages++;
2915 q = GNUNET_new (struct MeshConnectionQueue);
2916 q->forced = !droppable;
2917 q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2921 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING dropping msg on %s\n", GMC_2s (c));
2927 q->cont_cls = cont_cls;
2933 * Cancel a previously sent message while it's in the queue.
2935 * ONLY can be called before the continuation given to the send function
2936 * is called. Once the continuation is called, the message is no longer in the
2939 * @param q Handle to the queue.
2942 GMC_cancel (struct MeshConnectionQueue *q)
2944 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
2946 /* queue destroy calls message_sent, which calls q->cont and frees q */
2947 GMP_queue_destroy (q->q, GNUNET_YES, GNUNET_NO);
2952 * Sends a CREATE CONNECTION message for a path to a peer.
2953 * Changes the connection and tunnel states if necessary.
2955 * @param connection Connection to create.
2958 GMC_send_create (struct MeshConnection *connection)
2960 enum MeshTunnel3CState state;
2963 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2964 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2966 LOG (GNUNET_ERROR_TYPE_INFO, "=> %s on connection %s (%u bytes)\n",
2967 GM_m2s (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE),
2968 GMC_2s (connection), size);
2969 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2970 connection, connection->pending_messages);
2971 connection->pending_messages++;
2973 connection->maintenance_q =
2974 GMP_queue_add (get_next_hop (connection), NULL,
2975 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2976 size, connection, GNUNET_YES, &message_sent, NULL);
2978 state = GMT_get_cstate (connection->t);
2979 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2980 GMT_change_cstate (connection->t, MESH_TUNNEL3_WAITING);
2981 if (MESH_CONNECTION_NEW == connection->state)
2982 connection_change_state (connection, MESH_CONNECTION_SENT);
2987 * Send a message to all peers in this connection that the connection
2988 * is no longer valid.
2990 * If some peer should not receive the message, it should be zero'ed out
2991 * before calling this function.
2993 * @param c The connection whose peers to notify.
2996 GMC_send_destroy (struct MeshConnection *c)
2998 struct GNUNET_MESH_ConnectionDestroy msg;
3000 if (GNUNET_YES == c->destroy)
3003 msg.header.size = htons (sizeof (msg));
3004 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
3006 LOG (GNUNET_ERROR_TYPE_DEBUG,
3007 " sending connection destroy for connection %s\n",
3010 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
3011 GMC_send_prebuilt_message (&msg.header, c,
3012 GNUNET_YES, GNUNET_YES, NULL, NULL);
3013 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
3014 GMC_send_prebuilt_message (&msg.header, c,
3015 GNUNET_NO, GNUNET_YES, NULL, NULL);
3016 c->destroy = GNUNET_YES;
3017 c->state = MESH_CONNECTION_DESTROYED;
3022 * @brief Start a polling timer for the connection.
3024 * When a neighbor does not accept more traffic on the connection it could be
3025 * caused by a simple congestion or by a lost ACK. Polling enables to check
3026 * for the lastest ACK status for a connection.
3028 * @param c Connection.
3029 * @param fwd Should we poll in the FWD direction?
3032 GMC_start_poll (struct MeshConnection *c, int fwd)
3034 struct MeshFlowControl *fc;
3036 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3037 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
3039 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
3041 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
3042 fc->poll_task, fc->poll_msg);
3045 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
3046 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
3053 * @brief Stop polling a connection for ACKs.
3055 * Once we have enough ACKs for future traffic, polls are no longer necessary.
3057 * @param c Connection.
3058 * @param fwd Should we stop the poll in the FWD direction?
3061 GMC_stop_poll (struct MeshConnection *c, int fwd)
3063 struct MeshFlowControl *fc;
3065 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3066 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
3068 GNUNET_SCHEDULER_cancel (fc->poll_task);
3069 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
3074 * Get a (static) string for a connection.
3076 * @param c Connection.
3079 GMC_2s (const struct MeshConnection *c)
3086 static char buf[128];
3088 sprintf (buf, "%s (->%s)", GNUNET_h2s (GM_h2hc (GMC_get_id(c))), GMT_2s (c->t));
3091 return GNUNET_h2s (GM_h2hc (&c->id));