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)
679 id = c->path->peers[0];
681 id = c->path->peers[c->own_pos - 1];
683 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s (%u)\n",
684 GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
686 return GMP_get_short (id);
691 * Get the next hop in a connection
693 * @param c Connection.
695 * @return Next peer in the connection.
697 static struct MeshPeer *
698 get_next_hop (const struct MeshConnection *c)
702 LOG (GNUNET_ERROR_TYPE_DEBUG, " get next hop %s [%u/%u]\n",
703 GMC_2s (c), c->own_pos, c->path->length);
704 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
705 id = c->path->peers[c->path->length - 1];
707 id = c->path->peers[c->own_pos + 1];
709 LOG (GNUNET_ERROR_TYPE_DEBUG, " ID: %s (%u)\n",
710 GNUNET_i2s (GNUNET_PEER_resolve2 (id)), id);
712 return GMP_get_short (id);
717 * Get the hop in a connection.
719 * @param c Connection.
720 * @param fwd Next hop?
722 * @return Next peer in the connection.
724 static struct MeshPeer *
725 get_hop (struct MeshConnection *c, int fwd)
728 return get_next_hop (c);
729 return get_prev_hop (c);
734 * Is traffic coming from this sender 'FWD' traffic?
736 * @param c Connection to check.
737 * @param sender Peer identity of neighbor.
739 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
740 * the traffic is 'FWD'.
741 * #GNUNET_NO for BCK.
742 * #GNUNET_SYSERR for errors.
745 is_fwd (const struct MeshConnection *c,
746 const struct GNUNET_PeerIdentity *sender)
750 id = GNUNET_PEER_search (sender);
751 if (GMP_get_short_id (get_prev_hop (c)) == id)
754 if (GMP_get_short_id (get_next_hop (c)) == id)
758 return GNUNET_SYSERR;
763 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
764 * or a first CONNECTION_ACK directed to us.
766 * @param connection Connection to confirm.
767 * @param fwd Should we send it FWD? (root->dest)
768 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
771 send_connection_ack (struct MeshConnection *connection, int fwd)
773 struct MeshTunnel3 *t;
776 LOG (GNUNET_ERROR_TYPE_INFO, "=> {%18s ACK} on connection %s\n",
777 GM_f2s (!fwd), GMC_2s (connection));
778 GMP_queue_add (get_hop (connection, fwd), NULL,
779 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
780 sizeof (struct GNUNET_MESH_ConnectionACK),
781 connection, fwd, &message_sent, NULL);
782 connection->pending_messages++;
783 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
784 GMT_change_cstate (t, MESH_TUNNEL3_WAITING);
785 if (MESH_CONNECTION_READY != connection->state)
786 connection_change_state (connection, MESH_CONNECTION_SENT);
791 * Send a notification that a connection is broken.
793 * @param c Connection that is broken.
794 * @param id1 Peer that has disconnected.
795 * @param id2 Peer that has disconnected.
796 * @param fwd Direction towards which to send it.
799 send_broken (struct MeshConnection *c,
800 const struct GNUNET_PeerIdentity *id1,
801 const struct GNUNET_PeerIdentity *id2,
804 struct GNUNET_MESH_ConnectionBroken msg;
806 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
807 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
811 GMC_send_prebuilt_message (&msg.header, c, fwd, GNUNET_YES, NULL, NULL);
816 * Send a notification that a connection is broken, when a connection
817 * isn't even created.
819 * @param connection_id Connection ID.
820 * @param id1 Peer that has disconnected.
821 * @param id2 Peer that has disconnected.
822 * @param peer Peer to notify (neighbor who sent the connection).
825 send_broken2 (struct GNUNET_HashCode *connection_id,
826 const struct GNUNET_PeerIdentity *id1,
827 const struct GNUNET_PeerIdentity *id2,
828 GNUNET_PEER_Id peer_id)
830 struct GNUNET_MESH_ConnectionBroken *msg;
831 struct MeshPeer *neighbor;
833 LOG (GNUNET_ERROR_TYPE_INFO,
834 "Send BROKEN on unknown connection %s\n", GNUNET_h2s (connection_id));
836 msg = GNUNET_new (struct GNUNET_MESH_ConnectionBroken);
837 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
838 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
839 msg->cid = *connection_id;
842 neighbor = GMP_get_short (peer_id);
843 GMP_queue_add (neighbor, msg,
844 GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED,
845 sizeof (struct GNUNET_MESH_ConnectionBroken),
846 NULL, GNUNET_SYSERR, /* connection, fwd */
847 NULL, NULL); /* continuation */
852 * Send keepalive packets for a connection.
854 * @param c Connection to keep alive..
855 * @param fwd Is this a FWD keepalive? (owner -> dest).
858 connection_keepalive (struct MeshConnection *c, int fwd)
860 struct GNUNET_MESH_ConnectionKeepAlive *msg;
861 size_t size = sizeof (struct GNUNET_MESH_ConnectionKeepAlive);
864 LOG (GNUNET_ERROR_TYPE_DEBUG,
865 "sending %s keepalive for connection %s]\n",
866 GM_f2s (fwd), GMC_2s (c));
868 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) cbuf;
869 msg->header.size = htons (size);
870 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE);
872 msg->reserved = htonl (0);
874 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_YES, NULL, NULL);
879 * Send CONNECTION_{CREATE/ACK} packets for a connection.
881 * @param c Connection for which to send the message.
882 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
885 connection_recreate (struct MeshConnection *c, int fwd)
887 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
891 send_connection_ack (c, GNUNET_NO);
896 * Generic connection timer management.
897 * Depending on the role of the peer in the connection will send the
898 * appropriate message (build or keepalive)
900 * @param c Conncetion to maintain.
904 connection_maintain (struct MeshConnection *c, int fwd)
906 if (GNUNET_NO != c->destroy)
909 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (c->t))
911 /* TODO DHT GET with RO_BART */
916 case MESH_CONNECTION_NEW:
919 case MESH_CONNECTION_SENT:
920 connection_recreate (c, fwd);
922 case MESH_CONNECTION_READY:
923 connection_keepalive (c, fwd);
932 * Keep the connection alive in the FWD direction.
934 * @param cls Closure (connection to keepalive).
935 * @param tc TaskContext.
938 connection_fwd_keepalive (void *cls,
939 const struct GNUNET_SCHEDULER_TaskContext *tc)
941 struct MeshConnection *c = cls;
943 LOG (GNUNET_ERROR_TYPE_DEBUG, "FWD keepalive for %s\n", GMC_2s (c));
944 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
945 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
948 connection_maintain (c, GNUNET_YES);
950 /* Next execution will be scheduled by message_sent */
955 * Keep the connection alive in the BCK direction.
957 * TODO refactor and merge with connection_fwd_keepalive.
959 * @param cls Closure (connection to keepalive).
960 * @param tc TaskContext.
963 connection_bck_keepalive (void *cls,
964 const struct GNUNET_SCHEDULER_TaskContext *tc)
966 struct MeshConnection *c = cls;
968 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
969 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
972 connection_maintain (c, GNUNET_NO);
974 /* Next execution will be scheduled by message_sent */
979 * Schedule next keepalive task, taking in consideration
980 * the connection state and number of retries.
982 * If the peer is not the origin, do nothing.
984 * @param c Connection for which to schedule the next keepalive.
985 * @param fwd Direction for the next keepalive.
988 schedule_next_keepalive (struct MeshConnection *c, int fwd)
990 struct GNUNET_TIME_Relative delay;
991 GNUNET_SCHEDULER_TaskIdentifier *task_id;
992 GNUNET_SCHEDULER_Task keepalive_task;
994 if (GNUNET_NO == GMC_is_origin (c, fwd))
997 /* Calculate delay to use, depending on the state of the connection */
998 if (MESH_CONNECTION_READY == c->state)
1000 delay = refresh_connection_time;
1004 if (1 > c->create_retry)
1005 c->create_retry = 1;
1006 delay = GNUNET_TIME_relative_multiply (create_connection_time,
1008 if (c->create_retry < 64)
1009 c->create_retry *= 2;
1012 /* Select direction-dependent parameters */
1013 if (GNUNET_YES == fwd)
1015 task_id = &c->fwd_maintenance_task;
1016 keepalive_task = &connection_fwd_keepalive;
1020 task_id = &c->bck_maintenance_task;
1021 keepalive_task = &connection_bck_keepalive;
1024 /* Check that no one scheduled it before us */
1025 if (GNUNET_SCHEDULER_NO_TASK != *task_id)
1027 /* No need for a _break. It can happen for instance when sending a SYNACK
1028 * for a duplicate SYN: the first SYNACK scheduled the task. */
1029 GNUNET_SCHEDULER_cancel (*task_id);
1032 /* Schedule the task */
1033 *task_id = GNUNET_SCHEDULER_add_delayed (delay, keepalive_task, c);
1038 * @brief Re-initiate traffic on this connection if necessary.
1040 * Check if there is traffic queued towards this peer
1041 * and the core transmit handle is NULL (traffic was stalled).
1042 * If so, call core tmt rdy.
1044 * @param c Connection on which initiate traffic.
1045 * @param fwd Is this about fwd traffic?
1048 connection_unlock_queue (struct MeshConnection *c, int fwd)
1050 struct MeshPeer *peer;
1052 LOG (GNUNET_ERROR_TYPE_DEBUG,
1053 "connection_unlock_queue %s on %s\n",
1054 GM_f2s (fwd), GMC_2s (c));
1056 if (GMC_is_terminal (c, fwd))
1058 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
1062 peer = get_hop (c, fwd);
1063 GMP_queue_unlock (peer, c);
1068 * Cancel all transmissions that belong to a certain connection.
1070 * If the connection is scheduled for destruction and no more messages are left,
1071 * the connection will be destroyed by the continuation call.
1073 * @param c Connection which to cancel. Might be destroyed during this call.
1074 * @param fwd Cancel fwd traffic?
1077 connection_cancel_queues (struct MeshConnection *c, int fwd)
1079 struct MeshFlowControl *fc;
1080 struct MeshPeer *peer;
1082 LOG (GNUNET_ERROR_TYPE_DEBUG,
1083 " *** Cancel %s queues for connection %s\n",
1084 GM_f2s (fwd), GMC_2s (c));
1091 fc = fwd ? &c->fwd_fc : &c->bck_fc;
1092 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
1094 GNUNET_SCHEDULER_cancel (fc->poll_task);
1095 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1096 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
1098 peer = get_hop (c, fwd);
1099 GMP_queue_cancel (peer, c);
1104 * Function called if a connection has been stalled for a while,
1105 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1107 * @param cls Closure (poll ctx).
1108 * @param tc TaskContext.
1111 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1115 * Callback called when a queued POLL message is sent.
1117 * @param cls Closure (FC).
1118 * @param c Connection this message was on.
1119 * @param q Queue handler this call invalidates.
1120 * @param type Type of message sent.
1121 * @param fwd Was this a FWD going message?
1122 * @param size Size of the message.
1125 poll_sent (void *cls,
1126 struct MeshConnection *c,
1127 struct MeshConnectionQueue *q,
1128 uint16_t type, int fwd, size_t size)
1130 struct MeshFlowControl *fc = cls;
1132 if (2 == c->destroy)
1134 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
1137 LOG (GNUNET_ERROR_TYPE_DEBUG,
1138 " *** POLL sent for , scheduling new one!\n");
1139 fc->poll_msg = NULL;
1140 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
1141 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
1142 &connection_poll, fc);
1143 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1148 * Function called if a connection has been stalled for a while,
1149 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1151 * @param cls Closure (poll ctx).
1152 * @param tc TaskContext.
1155 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1157 struct MeshFlowControl *fc = cls;
1158 struct GNUNET_MESH_Poll msg;
1159 struct MeshConnection *c;
1161 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1162 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1168 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
1169 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
1170 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
1171 fc == &c->fwd_fc ? "FWD" : "BCK");
1173 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
1174 msg.header.size = htons (sizeof (msg));
1175 msg.pid = htonl (fc->last_pid_sent);
1176 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1177 fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c,
1178 fc == &c->fwd_fc, GNUNET_YES,
1184 * Timeout function due to lack of keepalive/traffic from the owner.
1185 * Destroys connection if called.
1187 * @param cls Closure (connection to destroy).
1188 * @param tc TaskContext.
1191 connection_fwd_timeout (void *cls,
1192 const struct GNUNET_SCHEDULER_TaskContext *tc)
1194 struct MeshConnection *c = cls;
1196 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1197 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1200 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1202 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1213 * Timeout function due to lack of keepalive/traffic from the destination.
1214 * Destroys connection if called.
1216 * @param cls Closure (connection to destroy).
1217 * @param tc TaskContext
1220 connection_bck_timeout (void *cls,
1221 const struct GNUNET_SCHEDULER_TaskContext *tc)
1223 struct MeshConnection *c = cls;
1225 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1226 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1229 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1232 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1243 * Resets the connection timeout task, some other message has done the
1245 * - For the first peer on the direction this means to send
1246 * a keepalive or a path confirmation message (either create or ACK).
1247 * - For all other peers, this means to destroy the connection,
1248 * due to lack of activity.
1249 * Starts the timeout if no timeout was running (connection just created).
1251 * @param c Connection whose timeout to reset.
1252 * @param fwd Is this forward?
1254 * TODO use heap to improve efficiency of scheduler.
1257 connection_reset_timeout (struct MeshConnection *c, int fwd)
1259 GNUNET_SCHEDULER_TaskIdentifier *ti;
1260 GNUNET_SCHEDULER_Task f;
1262 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1264 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GM_f2s (fwd));
1266 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1267 GNUNET_SCHEDULER_cancel (*ti);
1269 if (GMC_is_origin (c, fwd)) /* Startpoint */
1271 f = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
1272 *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
1274 else /* Relay, endpoint. */
1276 struct GNUNET_TIME_Relative delay;
1278 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1279 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1280 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1286 * Add the connection to the list of both neighbors.
1288 * @param c Connection.
1290 * @return #GNUNET_OK if everything went fine
1291 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1294 register_neighbors (struct MeshConnection *c)
1296 struct MeshPeer *next_peer;
1297 struct MeshPeer *prev_peer;
1299 next_peer = get_next_hop (c);
1300 prev_peer = get_prev_hop (c);
1302 LOG (GNUNET_ERROR_TYPE_DEBUG, "register neighbors for connection %s\n",
1304 path_debug (c->path);
1305 LOG (GNUNET_ERROR_TYPE_DEBUG, "own pos %u\n", c->own_pos);
1306 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to next peer %p\n",
1307 GMC_2s (c), next_peer);
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, "next peer %p %s\n", next_peer, GMP_2s (next_peer));
1309 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to prev peer %p\n",
1310 GMC_2s (c), prev_peer);
1311 LOG (GNUNET_ERROR_TYPE_DEBUG, "prev peer %p %s\n", prev_peer, GMP_2s (prev_peer));
1313 if (GNUNET_NO == GMP_is_neighbor (next_peer)
1314 || GNUNET_NO == GMP_is_neighbor (prev_peer))
1316 if (GMC_is_origin (c, GNUNET_YES))
1317 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1318 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1320 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1321 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1322 GMP_2s (prev_peer), GMP_is_neighbor (prev_peer));
1323 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1324 GMP_2s (next_peer), GMP_is_neighbor (next_peer));
1325 return GNUNET_SYSERR;
1328 GMP_add_connection (next_peer, c);
1329 GMP_add_connection (prev_peer, c);
1336 * Remove the connection from the list of both neighbors.
1338 * @param c Connection.
1341 unregister_neighbors (struct MeshConnection *c)
1343 struct MeshPeer *peer;
1345 peer = get_next_hop (c);
1346 if (GNUNET_OK != GMP_remove_connection (peer, c))
1348 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1349 || MESH_CONNECTION_DESTROYED == c->state);
1350 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1351 if (NULL != c->t) GMT_debug (c->t);
1354 peer = get_prev_hop (c);
1355 if (GNUNET_OK != GMP_remove_connection (peer, c))
1357 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1358 || MESH_CONNECTION_DESTROYED == c->state);
1359 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1360 if (NULL != c->t) GMT_debug (c->t);
1366 * Bind the connection to the peer and the tunnel to that peer.
1368 * If the peer has no tunnel, create one. Update tunnel and connection
1369 * data structres to reflect new status.
1371 * @param c Connection.
1375 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1377 GMP_add_tunnel (peer);
1378 c->t = GMP_get_tunnel (peer);
1379 GMT_add_connection (c->t, c);
1384 * Builds a path from a PeerIdentity array.
1386 * @param peers PeerIdentity array.
1387 * @param size Size of the @c peers array.
1388 * @param own_pos Output parameter: own position in the path.
1390 * @return Fixed and shortened path.
1392 static struct MeshPeerPath *
1393 build_path_from_peer_ids (struct GNUNET_PeerIdentity *peers,
1395 unsigned int *own_pos)
1397 struct MeshPeerPath *path;
1398 GNUNET_PEER_Id shortid;
1401 unsigned int offset;
1404 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1405 path = path_new (size);
1408 for (i = 0; i < size; i++)
1410 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %u: taking %s\n",
1411 i, GNUNET_i2s (&peers[i]));
1412 shortid = GNUNET_PEER_intern (&peers[i]);
1414 /* Check for loops / duplicates */
1415 for (j = 0; j < i - offset; j++)
1417 if (path->peers[j] == shortid)
1419 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists at pos %u\n", j);
1421 LOG (GNUNET_ERROR_TYPE_DEBUG, " offset now\n", offset);
1422 GNUNET_PEER_change_rc (shortid, -1);
1425 LOG (GNUNET_ERROR_TYPE_DEBUG, " storing at %u\n", i - offset);
1426 path->peers[i - offset] = shortid;
1427 if (path->peers[i] == myid)
1430 path->length -= offset;
1432 if (path->peers[*own_pos] != myid)
1434 /* create path: self not found in path through self */
1435 GNUNET_break_op (0);
1436 path_destroy (path);
1445 * Log receipt of message on stderr (INFO level).
1447 * @param message Message received.
1448 * @param peer Peer who sent the message.
1449 * @param hash Connection ID.
1452 log_message (const struct GNUNET_MessageHeader *message,
1453 const struct GNUNET_PeerIdentity *peer,
1454 const struct GNUNET_HashCode *hash)
1456 LOG (GNUNET_ERROR_TYPE_INFO, "<- %s on connection %s from %s\n",
1457 GM_m2s (ntohs (message->type)), GNUNET_h2s (hash), GNUNET_i2s (peer));
1460 /******************************************************************************/
1461 /******************************** API ***********************************/
1462 /******************************************************************************/
1465 * Core handler for connection creation.
1467 * @param cls Closure (unused).
1468 * @param peer Sender (neighbor).
1469 * @param message Message.
1471 * @return GNUNET_OK to keep the connection open,
1472 * GNUNET_SYSERR to close it (signal serious error)
1475 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1476 const struct GNUNET_MessageHeader *message)
1478 struct GNUNET_MESH_ConnectionCreate *msg;
1479 struct GNUNET_PeerIdentity *id;
1480 struct GNUNET_HashCode *cid;
1481 struct MeshPeerPath *path;
1482 struct MeshPeer *dest_peer;
1483 struct MeshPeer *orig_peer;
1484 struct MeshConnection *c;
1485 unsigned int own_pos;
1489 size = ntohs (message->size);
1490 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1492 GNUNET_break_op (0);
1496 /* Calculate hops */
1497 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1498 if (size % sizeof (struct GNUNET_PeerIdentity))
1500 GNUNET_break_op (0);
1503 size /= sizeof (struct GNUNET_PeerIdentity);
1506 GNUNET_break_op (0);
1509 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1511 /* Get parameters */
1512 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1514 log_message (message, peer, cid);
1515 id = (struct GNUNET_PeerIdentity *) &msg[1];
1516 LOG (GNUNET_ERROR_TYPE_DEBUG, " origin: %s\n", GNUNET_i2s (id));
1518 /* Create connection */
1519 c = connection_get (cid);
1522 path = build_path_from_peer_ids ((struct GNUNET_PeerIdentity *) &msg[1],
1528 GNUNET_break_op (0);
1529 path_destroy (path);
1532 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1533 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1534 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1537 if (path->length - 1 == own_pos)
1539 /* If we are destination, why did the creation fail? */
1543 send_broken2 (cid, &my_full_id,
1544 GNUNET_PEER_resolve2 (path->peers[own_pos + 1]),
1545 path->peers[own_pos - 1]);
1546 path_destroy (path);
1549 GMP_add_path_to_all (path, GNUNET_NO);
1550 connection_reset_timeout (c, GNUNET_YES);
1554 path = path_duplicate (c->path);
1556 if (MESH_CONNECTION_NEW == c->state)
1557 connection_change_state (c, MESH_CONNECTION_SENT);
1559 /* Remember peers */
1560 dest_peer = GMP_get (&id[size - 1]);
1561 orig_peer = GMP_get (&id[0]);
1563 /* Is it a connection to us? */
1564 if (c->own_pos == size - 1)
1566 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1567 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1569 add_to_peer (c, orig_peer);
1570 if (MESH_TUNNEL3_NEW == GMT_get_cstate (c->t))
1571 GMT_change_cstate (c->t, MESH_TUNNEL3_WAITING);
1573 send_connection_ack (c, GNUNET_NO);
1574 if (MESH_CONNECTION_SENT == c->state)
1575 connection_change_state (c, MESH_CONNECTION_ACK);
1579 /* It's for somebody else! Retransmit. */
1580 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1581 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1582 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1583 GMC_send_prebuilt_message (message, c, GNUNET_YES, GNUNET_YES,
1586 path_destroy (path);
1592 * Core handler for path confirmations.
1594 * @param cls closure
1595 * @param message message
1596 * @param peer peer identity this notification is about
1598 * @return GNUNET_OK to keep the connection open,
1599 * GNUNET_SYSERR to close it (signal serious error)
1602 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1603 const struct GNUNET_MessageHeader *message)
1605 struct GNUNET_MESH_ConnectionACK *msg;
1606 struct MeshConnection *c;
1607 struct MeshPeerPath *p;
1608 struct MeshPeer *pi;
1609 enum MeshConnectionState oldstate;
1612 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1613 log_message (message, peer, &msg->cid);
1614 c = connection_get (&msg->cid);
1617 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1619 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1623 if (GNUNET_NO != c->destroy)
1625 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1629 oldstate = c->state;
1630 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1631 pi = GMP_get (peer);
1632 if (get_next_hop (c) == pi)
1634 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1636 if (MESH_CONNECTION_SENT == oldstate)
1637 connection_change_state (c, MESH_CONNECTION_ACK);
1639 else if (get_prev_hop (c) == pi)
1641 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1643 connection_change_state (c, MESH_CONNECTION_READY);
1647 GNUNET_break_op (0);
1651 connection_reset_timeout (c, fwd);
1653 /* Add path to peers? */
1657 GMP_add_path_to_all (p, GNUNET_YES);
1664 /* Message for us as creator? */
1665 if (GMC_is_origin (c, GNUNET_YES))
1667 if (GNUNET_NO != fwd)
1669 GNUNET_break_op (0);
1672 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1674 /* If just created, cancel the short timeout and start a long one */
1675 if (MESH_CONNECTION_SENT == oldstate)
1676 connection_reset_timeout (c, GNUNET_YES);
1678 /* Change connection state */
1679 connection_change_state (c, MESH_CONNECTION_READY);
1680 send_connection_ack (c, GNUNET_YES);
1682 /* Change tunnel state, trigger KX */
1683 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1684 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1689 /* Message for us as destination? */
1690 if (GMC_is_terminal (c, GNUNET_YES))
1692 if (GNUNET_YES != fwd)
1694 GNUNET_break_op (0);
1697 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1699 /* If just created, cancel the short timeout and start a long one */
1700 if (MESH_CONNECTION_ACK == oldstate)
1701 connection_reset_timeout (c, GNUNET_NO);
1703 /* Change tunnel state */
1704 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1705 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1710 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1711 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1717 * Core handler for notifications of broken paths
1719 * @param cls Closure (unused).
1720 * @param id Peer identity of sending neighbor.
1721 * @param message Message.
1723 * @return GNUNET_OK to keep the connection open,
1724 * GNUNET_SYSERR to close it (signal serious error)
1727 GMC_handle_broken (void* cls,
1728 const struct GNUNET_PeerIdentity* id,
1729 const struct GNUNET_MessageHeader* message)
1731 struct GNUNET_MESH_ConnectionBroken *msg;
1732 struct MeshConnection *c;
1735 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1736 log_message (message, id, &msg->cid);
1737 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1738 GNUNET_i2s (&msg->peer1));
1739 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1740 GNUNET_i2s (&msg->peer2));
1741 c = connection_get (&msg->cid);
1744 GNUNET_break_op (0);
1748 fwd = is_fwd (c, id);
1749 if (GMC_is_terminal (c, fwd))
1751 path_invalidate (c->path);
1752 if (0 < c->pending_messages)
1753 c->destroy = GNUNET_YES;
1759 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1760 c->destroy = GNUNET_YES;
1761 connection_cancel_queues (c, !fwd);
1770 * Core handler for tunnel destruction
1772 * @param cls Closure (unused).
1773 * @param peer Peer identity of sending neighbor.
1774 * @param message Message.
1776 * @return GNUNET_OK to keep the connection open,
1777 * GNUNET_SYSERR to close it (signal serious error)
1780 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1781 const struct GNUNET_MessageHeader *message)
1783 struct GNUNET_MESH_ConnectionDestroy *msg;
1784 struct MeshConnection *c;
1787 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1788 log_message (message, peer, &msg->cid);
1789 c = connection_get (&msg->cid);
1792 /* Probably already got the message from another path,
1793 * destroyed the tunnel and retransmitted to children.
1796 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1798 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1801 fwd = is_fwd (c, peer);
1802 if (GNUNET_SYSERR == fwd)
1804 GNUNET_break_op (0); /* FIXME */
1807 if (GNUNET_NO == GMC_is_terminal (c, fwd))
1808 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1809 else if (0 == c->pending_messages)
1811 LOG (GNUNET_ERROR_TYPE_DEBUG, "! directly destroying connection!\n");
1815 c->destroy = GNUNET_YES;
1816 c->state = MESH_CONNECTION_DESTROYED;
1819 GMT_remove_connection (c->t, c);
1827 * Generic handler for mesh network encrypted traffic.
1829 * @param peer Peer identity this notification is about.
1830 * @param msg Encrypted message.
1832 * @return GNUNET_OK to keep the connection open,
1833 * GNUNET_SYSERR to close it (signal serious error)
1836 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1837 const struct GNUNET_MESH_Encrypted *msg)
1839 struct MeshConnection *c;
1840 struct MeshPeer *neighbor;
1841 struct MeshFlowControl *fc;
1842 GNUNET_PEER_Id peer_id;
1848 log_message (&msg->header, peer, &msg->cid);
1851 size = ntohs (msg->header.size);
1853 sizeof (struct GNUNET_MESH_Encrypted) +
1854 sizeof (struct GNUNET_MessageHeader))
1856 GNUNET_break_op (0);
1860 /* Check connection */
1861 c = connection_get (&msg->cid);
1864 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1865 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING enc on unknown connection %s\n",
1866 GNUNET_h2s (&msg->cid));
1870 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s\n", GMC_2s (c));
1872 /* Check if origin is as expected */
1873 neighbor = get_prev_hop (c);
1874 peer_id = GNUNET_PEER_search (peer);
1875 if (peer_id == GMP_get_short_id (neighbor))
1881 neighbor = get_next_hop (c);
1882 if (peer_id == GMP_get_short_id (neighbor))
1888 /* Unexpected peer sending traffic on a connection. */
1889 GNUNET_break_op (0);
1895 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1896 pid = ntohl (msg->pid);
1897 if (GM_is_pid_bigger (pid, fc->last_ack_sent))
1899 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1900 LOG (GNUNET_ERROR_TYPE_DEBUG,
1901 "WARNING Received PID %u, (prev %u), ACK %u\n",
1902 pid, fc->last_pid_recv, fc->last_ack_sent);
1905 if (GNUNET_NO == GM_is_pid_bigger (pid, fc->last_pid_recv))
1907 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1908 LOG (GNUNET_ERROR_TYPE_DEBUG,
1909 " Pid %u not expected (%u+), dropping!\n",
1910 pid, fc->last_pid_recv + 1);
1913 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1914 connection_change_state (c, MESH_CONNECTION_READY);
1915 connection_reset_timeout (c, fwd);
1916 fc->last_pid_recv = pid;
1918 /* Is this message for us? */
1919 if (GMC_is_terminal (c, fwd))
1921 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1922 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1926 GNUNET_break (GNUNET_NO != c->destroy);
1929 fc->last_pid_recv = pid;
1930 GMT_handle_encrypted (c->t, msg);
1931 GMC_send_ack (c, fwd, GNUNET_NO);
1935 /* Message not for us: forward to next hop */
1936 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1937 ttl = ntohl (msg->ttl);
1938 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1941 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1942 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1943 GMC_send_ack (c, fwd, GNUNET_NO);
1947 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1948 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1954 * Generic handler for mesh network encrypted traffic.
1956 * @param peer Peer identity this notification is about.
1957 * @param msg Encrypted message.
1959 * @return GNUNET_OK to keep the connection open,
1960 * GNUNET_SYSERR to close it (signal serious error)
1963 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1964 const struct GNUNET_MESH_KX *msg)
1966 struct MeshConnection *c;
1967 struct MeshPeer *neighbor;
1968 GNUNET_PEER_Id peer_id;
1972 log_message (&msg->header, peer, &msg->cid);
1975 size = ntohs (msg->header.size);
1977 sizeof (struct GNUNET_MESH_Encrypted) +
1978 sizeof (struct GNUNET_MessageHeader))
1980 GNUNET_break_op (0);
1984 /* Check connection */
1985 c = connection_get (&msg->cid);
1988 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1989 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING kx on unknown connection %s\n",
1990 GNUNET_h2s (&msg->cid));
1993 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
1995 /* Check if origin is as expected */
1996 neighbor = get_prev_hop (c);
1997 peer_id = GNUNET_PEER_search (peer);
1998 if (peer_id == GMP_get_short_id (neighbor))
2004 neighbor = get_next_hop (c);
2005 if (peer_id == GMP_get_short_id (neighbor))
2011 /* Unexpected peer sending traffic on a connection. */
2012 GNUNET_break_op (0);
2017 /* Count as connection confirmation. */
2018 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
2020 connection_change_state (c, MESH_CONNECTION_READY);
2023 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
2024 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
2027 connection_reset_timeout (c, fwd);
2029 /* Is this message for us? */
2030 if (GMC_is_terminal (c, fwd))
2032 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
2033 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
2039 GMT_handle_kx (c->t, &msg[1].header);
2043 /* Message not for us: forward to next hop */
2044 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
2045 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2046 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
2053 * Core handler for encrypted mesh network traffic (channel mgmt, data).
2055 * @param cls Closure (unused).
2056 * @param message Message received.
2057 * @param peer Peer who sent the message.
2059 * @return GNUNET_OK to keep the connection open,
2060 * GNUNET_SYSERR to close it (signal serious error)
2063 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
2064 const struct GNUNET_MessageHeader *message)
2066 return handle_mesh_encrypted (peer,
2067 (struct GNUNET_MESH_Encrypted *)message);
2072 * Core handler for key exchange traffic (ephemeral key, ping, pong).
2074 * @param cls Closure (unused).
2075 * @param message Message received.
2076 * @param peer Peer who sent the message.
2078 * @return GNUNET_OK to keep the connection open,
2079 * GNUNET_SYSERR to close it (signal serious error)
2082 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
2083 const struct GNUNET_MessageHeader *message)
2085 return handle_mesh_kx (peer,
2086 (struct GNUNET_MESH_KX *) message);
2091 * Core handler for mesh network traffic point-to-point acks.
2093 * @param cls closure
2094 * @param message message
2095 * @param peer peer identity this notification is about
2097 * @return GNUNET_OK to keep the connection open,
2098 * GNUNET_SYSERR to close it (signal serious error)
2101 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
2102 const struct GNUNET_MessageHeader *message)
2104 struct GNUNET_MESH_ACK *msg;
2105 struct MeshConnection *c;
2106 struct MeshFlowControl *fc;
2111 msg = (struct GNUNET_MESH_ACK *) message;
2112 log_message (message, peer, &msg->cid);
2113 c = connection_get (&msg->cid);
2116 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
2121 /* Is this a forward or backward ACK? */
2122 id = GNUNET_PEER_search (peer);
2123 if (GMP_get_short_id (get_next_hop (c)) == id)
2125 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
2129 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2131 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
2137 GNUNET_break_op (0);
2141 ack = ntohl (msg->ack);
2142 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
2143 ack, fc->last_ack_recv);
2144 if (GM_is_pid_bigger (ack, fc->last_ack_recv))
2145 fc->last_ack_recv = ack;
2147 /* Cancel polling if the ACK is big enough. */
2148 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
2149 GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2151 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
2152 GNUNET_SCHEDULER_cancel (fc->poll_task);
2153 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2154 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
2157 connection_unlock_queue (c, fwd);
2164 * Core handler for mesh network traffic point-to-point ack polls.
2166 * @param cls closure
2167 * @param message message
2168 * @param peer peer identity this notification is about
2170 * @return GNUNET_OK to keep the connection open,
2171 * GNUNET_SYSERR to close it (signal serious error)
2174 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
2175 const struct GNUNET_MessageHeader *message)
2177 struct GNUNET_MESH_Poll *msg;
2178 struct MeshConnection *c;
2179 struct MeshFlowControl *fc;
2184 msg = (struct GNUNET_MESH_Poll *) message;
2185 log_message (message, peer, &msg->cid);
2186 c = connection_get (&msg->cid);
2189 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
2191 LOG (GNUNET_ERROR_TYPE_DEBUG,
2192 "WARNING POLL message on unknown connection %s!\n",
2193 GNUNET_h2s (&msg->cid));
2197 /* Is this a forward or backward ACK?
2198 * Note: a poll should never be needed in a loopback case,
2199 * since there is no possiblility of packet loss there, so
2200 * this way of discerining FWD/BCK should not be a problem.
2202 id = GNUNET_PEER_search (peer);
2203 if (GMP_get_short_id (get_next_hop (c)) == id)
2205 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2208 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2210 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2215 GNUNET_break_op (0);
2219 pid = ntohl (msg->pid);
2220 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2221 fc->last_pid_recv = pid;
2222 fwd = fc == &c->bck_fc;
2223 GMC_send_ack (c, fwd, GNUNET_YES);
2230 * Core handler for mesh keepalives.
2232 * @param cls closure
2233 * @param message message
2234 * @param peer peer identity this notification is about
2235 * @return GNUNET_OK to keep the connection open,
2236 * GNUNET_SYSERR to close it (signal serious error)
2238 * TODO: Check who we got this from, to validate route.
2241 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
2242 const struct GNUNET_MessageHeader *message)
2244 struct GNUNET_MESH_ConnectionKeepAlive *msg;
2245 struct MeshConnection *c;
2246 struct MeshPeer *neighbor;
2247 GNUNET_PEER_Id peer_id;
2250 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) message;
2251 log_message (message, peer, &msg->cid);
2252 c = connection_get (&msg->cid);
2255 GNUNET_STATISTICS_update (stats, "# keepalive on unknown connection", 1,
2260 /* Check if origin is as expected TODO refactor and reuse */
2261 peer_id = GNUNET_PEER_search (peer);
2262 neighbor = get_prev_hop (c);
2263 if (peer_id == GMP_get_short_id (neighbor))
2269 neighbor = get_next_hop (c);
2270 if (peer_id == GMP_get_short_id (neighbor))
2276 GNUNET_break_op (0);
2281 connection_change_state (c, MESH_CONNECTION_READY);
2282 connection_reset_timeout (c, fwd);
2284 if (GMC_is_terminal (c, fwd))
2287 GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
2288 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
2295 * Send an ACK on the appropriate connection/channel, depending on
2296 * the direction and the position of the peer.
2298 * @param c Which connection to send the hop-by-hop ACK.
2299 * @param fwd Is this a fwd ACK? (will go dest->root).
2300 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2303 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
2305 unsigned int buffer;
2307 LOG (GNUNET_ERROR_TYPE_DEBUG,
2308 "GMC send %s ACK on %s\n",
2309 GM_f2s (fwd), GMC_2s (c));
2317 if (GNUNET_NO != c->destroy)
2319 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2323 /* Get available buffer space */
2324 if (GMC_is_terminal (c, fwd))
2326 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2327 buffer = GMT_get_channels_buffer (c->t);
2331 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2332 buffer = GMC_get_buffer (c, fwd);
2334 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2335 if (0 == buffer && GNUNET_NO == force)
2338 /* Send available buffer space */
2339 if (GMC_is_origin (c, fwd))
2341 GNUNET_assert (NULL != c->t);
2342 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2343 GMT_unchoke_channels (c->t);
2347 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2348 send_ack (c, buffer, fwd, force);
2354 * Initialize the connections subsystem
2356 * @param c Configuration handle.
2359 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2361 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2363 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2366 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2367 "MESH", "MAX_MSGS_QUEUE", "MISSING");
2368 GNUNET_SCHEDULER_shutdown ();
2373 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2376 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2377 "MESH", "MAX_CONNECTIONS", "MISSING");
2378 GNUNET_SCHEDULER_shutdown ();
2383 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2384 &refresh_connection_time))
2386 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2387 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2388 GNUNET_SCHEDULER_shutdown ();
2391 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2392 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
2397 * Destroy each connection on shutdown.
2399 * @param cls Closure (unused).
2400 * @param key Current key code (CID, unused).
2401 * @param value Value in the hash map (connection)
2403 * @return #GNUNET_YES, because we should continue to iterate,
2406 shutdown_iterator (void *cls,
2407 const struct GNUNET_HashCode *key,
2410 struct MeshConnection *c = value;
2418 * Shut down the connections subsystem.
2423 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2424 GNUNET_CONTAINER_multihashmap_destroy (connections);
2429 struct MeshConnection *
2430 GMC_new (const struct GNUNET_HashCode *cid,
2431 struct MeshTunnel3 *t,
2432 struct MeshPeerPath *p,
2433 unsigned int own_pos)
2435 struct MeshConnection *c;
2437 c = GNUNET_new (struct MeshConnection);
2439 GNUNET_assert (GNUNET_OK ==
2440 GNUNET_CONTAINER_multihashmap_put (connections,
2442 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2443 fc_init (&c->fwd_fc);
2444 fc_init (&c->bck_fc);
2449 GNUNET_assert (own_pos <= p->length - 1);
2450 c->own_pos = own_pos;
2453 if (GNUNET_OK != register_neighbors (c))
2457 path_invalidate (c->path);
2470 GMC_destroy (struct MeshConnection *c)
2478 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2479 return; /* -> message_sent -> GMC_destroy. Don't loop. */
2482 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2483 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2484 &c->fwd_fc, &c->bck_fc);
2485 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2486 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2488 /* Cancel all traffic */
2489 if (NULL != c->path)
2491 connection_cancel_queues (c, GNUNET_YES);
2492 connection_cancel_queues (c, GNUNET_NO);
2493 unregister_neighbors (c);
2496 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2497 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2499 /* Cancel maintainance task (keepalive/timeout) */
2500 if (NULL != c->fwd_fc.poll_msg)
2502 GMC_cancel (c->fwd_fc.poll_msg);
2503 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2505 if (NULL != c->bck_fc.poll_msg)
2507 GMC_cancel (c->bck_fc.poll_msg);
2508 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2511 /* Delete from tunnel */
2513 GMT_remove_connection (c->t, c);
2515 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES) && NULL != c->path)
2516 path_destroy (c->path);
2517 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2518 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2519 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2520 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2521 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2523 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2524 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2526 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2528 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2529 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2532 GNUNET_break (GNUNET_YES ==
2533 GNUNET_CONTAINER_multihashmap_remove (connections, &c->id, c));
2535 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2540 * Get the connection ID.
2542 * @param c Connection to get the ID from.
2544 * @return ID of the connection.
2546 const struct GNUNET_HashCode *
2547 GMC_get_id (const struct MeshConnection *c)
2554 * Get the connection path.
2556 * @param c Connection to get the path from.
2558 * @return path used by the connection.
2560 const struct MeshPeerPath *
2561 GMC_get_path (const struct MeshConnection *c)
2563 if (GNUNET_NO == c->destroy)
2570 * Get the connection state.
2572 * @param c Connection to get the state from.
2574 * @return state of the connection.
2576 enum MeshConnectionState
2577 GMC_get_state (const struct MeshConnection *c)
2583 * Get the connection tunnel.
2585 * @param c Connection to get the tunnel from.
2587 * @return tunnel of the connection.
2589 struct MeshTunnel3 *
2590 GMC_get_tunnel (const struct MeshConnection *c)
2597 * Get free buffer space in a connection.
2599 * @param c Connection.
2600 * @param fwd Is query about FWD traffic?
2602 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2605 GMC_get_buffer (struct MeshConnection *c, int fwd)
2607 struct MeshFlowControl *fc;
2609 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2611 return (fc->queue_max - fc->queue_n);
2615 * Get how many messages have we allowed to send to us from a direction.
2617 * @param c Connection.
2618 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2620 * @return last_ack_sent - last_pid_recv
2623 GMC_get_allowed (struct MeshConnection *c, int fwd)
2625 struct MeshFlowControl *fc;
2627 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2628 if (GM_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2632 return (fc->last_ack_sent - fc->last_pid_recv);
2636 * Get messages queued in a connection.
2638 * @param c Connection.
2639 * @param fwd Is query about FWD traffic?
2641 * @return Number of messages queued.
2644 GMC_get_qn (struct MeshConnection *c, int fwd)
2646 struct MeshFlowControl *fc;
2648 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2655 * Allow the connection to advertise a buffer of the given size.
2657 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2658 * allowing up to last_pid_recv + buffer.
2660 * @param c Connection.
2661 * @param buffer How many more messages the connection can accept.
2662 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2665 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2667 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowing %s %u messages %s\n",
2668 GMC_2s (c), buffer, GM_f2s (fwd));
2669 send_ack (c, buffer, fwd, GNUNET_NO);
2674 * Notify other peers on a connection of a broken link. Mark connections
2675 * to destroy after all traffic has been sent.
2677 * @param c Connection on which there has been a disconnection.
2678 * @param peer Peer that disconnected.
2681 GMC_notify_broken (struct MeshConnection *c,
2682 struct MeshPeer *peer)
2686 LOG (GNUNET_ERROR_TYPE_DEBUG,
2687 " notify broken on %s due to %s disconnect\n",
2688 GMC_2s (c), GMP_2s (peer));
2690 fwd = peer == get_prev_hop (c);
2692 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2694 /* Local shutdown, no one to notify about this. */
2698 if (GNUNET_NO == c->destroy)
2699 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2701 /* Connection will have at least one pending message
2702 * (the one we just scheduled), so no point in checking whether to
2703 * destroy immediately. */
2704 c->destroy = GNUNET_YES;
2705 c->state = MESH_CONNECTION_DESTROYED;
2708 * Cancel all queues, if no message is left, connection will be destroyed.
2710 connection_cancel_queues (c, !fwd);
2717 * Is this peer the first one on the connection?
2719 * @param c Connection.
2720 * @param fwd Is this about fwd traffic?
2722 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2725 GMC_is_origin (struct MeshConnection *c, int fwd)
2727 if (!fwd && c->path->length - 1 == c->own_pos )
2729 if (fwd && 0 == c->own_pos)
2736 * Is this peer the last one on the connection?
2738 * @param c Connection.
2739 * @param fwd Is this about fwd traffic?
2740 * Note that the ROOT is the terminal for BCK traffic!
2742 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2745 GMC_is_terminal (struct MeshConnection *c, int fwd)
2747 return GMC_is_origin (c, !fwd);
2752 * See if we are allowed to send by the next hop in the given direction.
2754 * @param c Connection.
2755 * @param fwd Is this about fwd traffic?
2757 * @return #GNUNET_YES in case it's OK to send.
2760 GMC_is_sendable (struct MeshConnection *c, int fwd)
2762 struct MeshFlowControl *fc;
2769 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2770 if (GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2776 * Sends an already built message on a connection, properly registering
2777 * all used resources.
2779 * @param message Message to send. Function makes a copy of it.
2780 * If message is not hop-by-hop, decrements TTL of copy.
2781 * @param c Connection on which this message is transmitted.
2782 * @param fwd Is this a fwd message?
2783 * @param force Force the connection to accept the message (buffer overfill).
2784 * @param cont Continuation called once message is sent. Can be NULL.
2785 * @param cont_cls Closure for @c cont.
2787 * @return Handle to cancel the message before it's sent.
2788 * NULL on error or if @c cont is NULL.
2789 * Invalid on @c cont call.
2791 struct MeshConnectionQueue *
2792 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2793 struct MeshConnection *c, int fwd, int force,
2794 GMC_sent cont, void *cont_cls)
2796 struct MeshFlowControl *fc;
2797 struct MeshConnectionQueue *q;
2803 size = ntohs (message->size);
2804 data = GNUNET_malloc (size);
2805 memcpy (data, message, size);
2806 type = ntohs (message->type);
2807 LOG (GNUNET_ERROR_TYPE_INFO, "-> %s on connection %s (%u bytes)\n",
2808 GM_m2s (type), GMC_2s (c), size);
2810 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2811 droppable = GNUNET_NO == force;
2814 struct GNUNET_MESH_Encrypted *emsg;
2815 struct GNUNET_MESH_KX *kmsg;
2816 struct GNUNET_MESH_ACK *amsg;
2817 struct GNUNET_MESH_Poll *pmsg;
2818 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2819 struct GNUNET_MESH_ConnectionBroken *bmsg;
2822 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2823 emsg = (struct GNUNET_MESH_Encrypted *) data;
2824 ttl = ntohl (emsg->ttl);
2827 GNUNET_break_op (0);
2832 emsg->ttl = htonl (ttl - 1);
2833 emsg->pid = htonl (fc->next_pid++);
2834 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2835 if (GNUNET_YES == droppable)
2838 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2839 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2840 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2844 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2846 if (GM_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2848 GMC_start_poll (c, fwd);
2852 case GNUNET_MESSAGE_TYPE_MESH_KX:
2853 kmsg = (struct GNUNET_MESH_KX *) data;
2857 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2858 amsg = (struct GNUNET_MESH_ACK *) data;
2860 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2861 droppable = GNUNET_NO;
2864 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2865 pmsg = (struct GNUNET_MESH_Poll *) data;
2867 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2868 droppable = GNUNET_NO;
2871 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2872 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2877 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2878 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2883 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2884 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2885 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
2894 if (fc->queue_n > fc->queue_max && droppable)
2896 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2899 LOG (GNUNET_ERROR_TYPE_DEBUG,
2900 "queue full: %u/%u\n",
2901 fc->queue_n, fc->queue_max);
2902 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2908 return NULL; /* Drop this message */
2911 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2912 c->pending_messages++;
2914 q = GNUNET_new (struct MeshConnectionQueue);
2915 q->forced = !droppable;
2916 q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2920 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING dropping msg on %s\n", GMC_2s (c));
2926 q->cont_cls = cont_cls;
2932 * Cancel a previously sent message while it's in the queue.
2934 * ONLY can be called before the continuation given to the send function
2935 * is called. Once the continuation is called, the message is no longer in the
2938 * @param q Handle to the queue.
2941 GMC_cancel (struct MeshConnectionQueue *q)
2943 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
2945 /* queue destroy calls message_sent, which calls q->cont and frees q */
2946 GMP_queue_destroy (q->q, GNUNET_YES);
2951 * Sends a CREATE CONNECTION message for a path to a peer.
2952 * Changes the connection and tunnel states if necessary.
2954 * @param connection Connection to create.
2957 GMC_send_create (struct MeshConnection *connection)
2959 enum MeshTunnel3CState state;
2962 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2963 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2965 LOG (GNUNET_ERROR_TYPE_INFO, "=> %s on connection %s (%u bytes)\n",
2966 GM_m2s (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE),
2967 GMC_2s (connection), size);
2968 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2969 connection, connection->pending_messages);
2970 connection->pending_messages++;
2972 connection->maintenance_q =
2973 GMP_queue_add (get_next_hop (connection), NULL,
2974 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2975 size, connection, GNUNET_YES, &message_sent, NULL);
2977 state = GMT_get_cstate (connection->t);
2978 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2979 GMT_change_cstate (connection->t, MESH_TUNNEL3_WAITING);
2980 if (MESH_CONNECTION_NEW == connection->state)
2981 connection_change_state (connection, MESH_CONNECTION_SENT);
2986 * Send a message to all peers in this connection that the connection
2987 * is no longer valid.
2989 * If some peer should not receive the message, it should be zero'ed out
2990 * before calling this function.
2992 * @param c The connection whose peers to notify.
2995 GMC_send_destroy (struct MeshConnection *c)
2997 struct GNUNET_MESH_ConnectionDestroy msg;
2999 if (GNUNET_YES == c->destroy)
3002 msg.header.size = htons (sizeof (msg));
3003 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
3005 LOG (GNUNET_ERROR_TYPE_DEBUG,
3006 " sending connection destroy for connection %s\n",
3009 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
3010 GMC_send_prebuilt_message (&msg.header, c,
3011 GNUNET_YES, GNUNET_YES, NULL, NULL);
3012 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
3013 GMC_send_prebuilt_message (&msg.header, c,
3014 GNUNET_NO, GNUNET_YES, NULL, NULL);
3015 c->destroy = GNUNET_YES;
3016 c->state = MESH_CONNECTION_DESTROYED;
3021 * @brief Start a polling timer for the connection.
3023 * When a neighbor does not accept more traffic on the connection it could be
3024 * caused by a simple congestion or by a lost ACK. Polling enables to check
3025 * for the lastest ACK status for a connection.
3027 * @param c Connection.
3028 * @param fwd Should we poll in the FWD direction?
3031 GMC_start_poll (struct MeshConnection *c, int fwd)
3033 struct MeshFlowControl *fc;
3035 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3036 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
3038 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
3040 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
3041 fc->poll_task, fc->poll_msg);
3044 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
3045 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
3052 * @brief Stop polling a connection for ACKs.
3054 * Once we have enough ACKs for future traffic, polls are no longer necessary.
3056 * @param c Connection.
3057 * @param fwd Should we stop the poll in the FWD direction?
3060 GMC_stop_poll (struct MeshConnection *c, int fwd)
3062 struct MeshFlowControl *fc;
3064 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3065 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
3067 GNUNET_SCHEDULER_cancel (fc->poll_task);
3068 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
3073 * Get a (static) string for a connection.
3075 * @param c Connection.
3078 GMC_2s (const struct MeshConnection *c)
3085 static char buf[128];
3087 sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
3090 return GNUNET_h2s (&c->id);