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 send_connection_keepalive (struct MeshConnection *c, int fwd)
860 struct GNUNET_MessageHeader msg;
862 LOG (GNUNET_ERROR_TYPE_INFO,
863 "keepalive %s for connection %s\n",
864 GM_f2s (fwd), GMC_2s (c));
865 GNUNET_STATISTICS_update (stats, "# keepalives sent", 1, GNUNET_NO);
867 GNUNET_assert (NULL != c->t);
868 msg.size = htons (sizeof (msg));
869 msg.type = htons (GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE);
871 GNUNET_assert (NULL ==
872 GMT_send_prebuilt_message (&msg, c->t, c,
873 GNUNET_NO, NULL, NULL));
878 * Send CONNECTION_{CREATE/ACK} packets for a connection.
880 * @param c Connection for which to send the message.
881 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
884 connection_recreate (struct MeshConnection *c, int fwd)
886 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
890 send_connection_ack (c, GNUNET_NO);
895 * Generic connection timer management.
896 * Depending on the role of the peer in the connection will send the
897 * appropriate message (build or keepalive)
899 * @param c Conncetion to maintain.
903 connection_maintain (struct MeshConnection *c, int fwd)
905 if (GNUNET_NO != c->destroy)
908 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (c->t))
910 /* TODO DHT GET with RO_BART */
915 case MESH_CONNECTION_NEW:
918 case MESH_CONNECTION_SENT:
919 connection_recreate (c, fwd);
921 case MESH_CONNECTION_READY:
922 send_connection_keepalive (c, fwd);
932 * Keep the connection alive.
934 * @param c Connection to keep alive.
935 * @param fwd Direction.
936 * @param shutdown Are we shutting down? (Don't send traffic)
937 * Non-zero value for true, not necessarily GNUNET_YES.
940 connection_keepalive (struct MeshConnection *c, int fwd, int shutdown)
942 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s keepalive for %s\n",
943 GM_f2s (fwd), GMC_2s (c));
946 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
948 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
950 if (GNUNET_NO != shutdown)
953 connection_maintain (c, fwd);
955 /* Next execution will be scheduled by message_sent */
960 * Keep the connection alive in the FWD direction.
962 * @param cls Closure (connection to keepalive).
963 * @param tc TaskContext.
966 connection_fwd_keepalive (void *cls,
967 const struct GNUNET_SCHEDULER_TaskContext *tc)
969 connection_keepalive ((struct MeshConnection *) cls,
971 tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN);
976 * Keep the connection alive in the BCK direction.
978 * @param cls Closure (connection to keepalive).
979 * @param tc TaskContext.
982 connection_bck_keepalive (void *cls,
983 const struct GNUNET_SCHEDULER_TaskContext *tc)
985 connection_keepalive ((struct MeshConnection *) cls,
987 tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN);
992 * Schedule next keepalive task, taking in consideration
993 * the connection state and number of retries.
995 * If the peer is not the origin, do nothing.
997 * @param c Connection for which to schedule the next keepalive.
998 * @param fwd Direction for the next keepalive.
1001 schedule_next_keepalive (struct MeshConnection *c, int fwd)
1003 struct GNUNET_TIME_Relative delay;
1004 GNUNET_SCHEDULER_TaskIdentifier *task_id;
1005 GNUNET_SCHEDULER_Task keepalive_task;
1007 if (GNUNET_NO == GMC_is_origin (c, fwd))
1010 /* Calculate delay to use, depending on the state of the connection */
1011 if (MESH_CONNECTION_READY == c->state)
1013 delay = refresh_connection_time;
1017 if (1 > c->create_retry)
1018 c->create_retry = 1;
1019 delay = GNUNET_TIME_relative_multiply (create_connection_time,
1021 if (c->create_retry < 64)
1022 c->create_retry *= 2;
1025 /* Select direction-dependent parameters */
1026 if (GNUNET_YES == fwd)
1028 task_id = &c->fwd_maintenance_task;
1029 keepalive_task = &connection_fwd_keepalive;
1033 task_id = &c->bck_maintenance_task;
1034 keepalive_task = &connection_bck_keepalive;
1037 /* Check that no one scheduled it before us */
1038 if (GNUNET_SCHEDULER_NO_TASK != *task_id)
1040 /* No need for a _break. It can happen for instance when sending a SYNACK
1041 * for a duplicate SYN: the first SYNACK scheduled the task. */
1042 GNUNET_SCHEDULER_cancel (*task_id);
1045 /* Schedule the task */
1046 *task_id = GNUNET_SCHEDULER_add_delayed (delay, keepalive_task, c);
1051 * @brief Re-initiate traffic on this connection if necessary.
1053 * Check if there is traffic queued towards this peer
1054 * and the core transmit handle is NULL (traffic was stalled).
1055 * If so, call core tmt rdy.
1057 * @param c Connection on which initiate traffic.
1058 * @param fwd Is this about fwd traffic?
1061 connection_unlock_queue (struct MeshConnection *c, int fwd)
1063 struct MeshPeer *peer;
1065 LOG (GNUNET_ERROR_TYPE_DEBUG,
1066 "connection_unlock_queue %s on %s\n",
1067 GM_f2s (fwd), GMC_2s (c));
1069 if (GMC_is_terminal (c, fwd))
1071 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
1075 peer = get_hop (c, fwd);
1076 GMP_queue_unlock (peer, c);
1081 * Cancel all transmissions that belong to a certain connection.
1083 * If the connection is scheduled for destruction and no more messages are left,
1084 * the connection will be destroyed by the continuation call.
1086 * @param c Connection which to cancel. Might be destroyed during this call.
1087 * @param fwd Cancel fwd traffic?
1090 connection_cancel_queues (struct MeshConnection *c, int fwd)
1092 struct MeshFlowControl *fc;
1093 struct MeshPeer *peer;
1095 LOG (GNUNET_ERROR_TYPE_DEBUG,
1096 " *** Cancel %s queues for connection %s\n",
1097 GM_f2s (fwd), GMC_2s (c));
1104 fc = fwd ? &c->fwd_fc : &c->bck_fc;
1105 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
1107 GNUNET_SCHEDULER_cancel (fc->poll_task);
1108 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1109 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
1111 peer = get_hop (c, fwd);
1112 GMP_queue_cancel (peer, c);
1117 * Function called if a connection has been stalled for a while,
1118 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1120 * @param cls Closure (poll ctx).
1121 * @param tc TaskContext.
1124 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
1128 * Callback called when a queued POLL message is sent.
1130 * @param cls Closure (FC).
1131 * @param c Connection this message was on.
1132 * @param q Queue handler this call invalidates.
1133 * @param type Type of message sent.
1134 * @param fwd Was this a FWD going message?
1135 * @param size Size of the message.
1138 poll_sent (void *cls,
1139 struct MeshConnection *c,
1140 struct MeshConnectionQueue *q,
1141 uint16_t type, int fwd, size_t size)
1143 struct MeshFlowControl *fc = cls;
1145 if (2 == c->destroy)
1147 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
1150 LOG (GNUNET_ERROR_TYPE_DEBUG,
1151 " *** POLL sent for , scheduling new one!\n");
1152 fc->poll_msg = NULL;
1153 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
1154 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
1155 &connection_poll, fc);
1156 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1161 * Function called if a connection has been stalled for a while,
1162 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1164 * @param cls Closure (poll ctx).
1165 * @param tc TaskContext.
1168 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1170 struct MeshFlowControl *fc = cls;
1171 struct GNUNET_MESH_Poll msg;
1172 struct MeshConnection *c;
1174 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1175 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1181 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
1182 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
1183 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
1184 fc == &c->fwd_fc ? "FWD" : "BCK");
1186 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
1187 msg.header.size = htons (sizeof (msg));
1188 msg.pid = htonl (fc->last_pid_sent);
1189 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1190 fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c,
1191 fc == &c->fwd_fc, GNUNET_YES,
1197 * Timeout function due to lack of keepalive/traffic from the owner.
1198 * Destroys connection if called.
1200 * @param cls Closure (connection to destroy).
1201 * @param tc TaskContext.
1204 connection_fwd_timeout (void *cls,
1205 const struct GNUNET_SCHEDULER_TaskContext *tc)
1207 struct MeshConnection *c = cls;
1209 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1210 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1213 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1215 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1226 * Timeout function due to lack of keepalive/traffic from the destination.
1227 * Destroys connection if called.
1229 * @param cls Closure (connection to destroy).
1230 * @param tc TaskContext
1233 connection_bck_timeout (void *cls,
1234 const struct GNUNET_SCHEDULER_TaskContext *tc)
1236 struct MeshConnection *c = cls;
1238 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1239 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1242 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1245 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1256 * Resets the connection timeout task, some other message has done the
1258 * - For the first peer on the direction this means to send
1259 * a keepalive or a path confirmation message (either create or ACK).
1260 * - For all other peers, this means to destroy the connection,
1261 * due to lack of activity.
1262 * Starts the timeout if no timeout was running (connection just created).
1264 * @param c Connection whose timeout to reset.
1265 * @param fwd Is this forward?
1267 * TODO use heap to improve efficiency of scheduler.
1270 connection_reset_timeout (struct MeshConnection *c, int fwd)
1272 GNUNET_SCHEDULER_TaskIdentifier *ti;
1273 GNUNET_SCHEDULER_Task f;
1275 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1277 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GM_f2s (fwd));
1279 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1280 GNUNET_SCHEDULER_cancel (*ti);
1282 if (GMC_is_origin (c, fwd)) /* Startpoint */
1284 f = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
1285 *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
1287 else /* Relay, endpoint. */
1289 struct GNUNET_TIME_Relative delay;
1291 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1292 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1293 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1299 * Add the connection to the list of both neighbors.
1301 * @param c Connection.
1303 * @return #GNUNET_OK if everything went fine
1304 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1307 register_neighbors (struct MeshConnection *c)
1309 struct MeshPeer *next_peer;
1310 struct MeshPeer *prev_peer;
1312 next_peer = get_next_hop (c);
1313 prev_peer = get_prev_hop (c);
1315 LOG (GNUNET_ERROR_TYPE_DEBUG, "register neighbors for connection %s\n",
1317 path_debug (c->path);
1318 LOG (GNUNET_ERROR_TYPE_DEBUG, "own pos %u\n", c->own_pos);
1319 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to next peer %p\n",
1320 GMC_2s (c), next_peer);
1321 LOG (GNUNET_ERROR_TYPE_DEBUG, "next peer %p %s\n", next_peer, GMP_2s (next_peer));
1322 LOG (GNUNET_ERROR_TYPE_DEBUG, "putting connection %s to prev peer %p\n",
1323 GMC_2s (c), prev_peer);
1324 LOG (GNUNET_ERROR_TYPE_DEBUG, "prev peer %p %s\n", prev_peer, GMP_2s (prev_peer));
1326 if (GNUNET_NO == GMP_is_neighbor (next_peer)
1327 || GNUNET_NO == GMP_is_neighbor (prev_peer))
1329 if (GMC_is_origin (c, GNUNET_YES))
1330 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1331 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1333 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1334 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1335 GMP_2s (prev_peer), GMP_is_neighbor (prev_peer));
1336 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1337 GMP_2s (next_peer), GMP_is_neighbor (next_peer));
1338 return GNUNET_SYSERR;
1341 GMP_add_connection (next_peer, c);
1342 GMP_add_connection (prev_peer, c);
1349 * Remove the connection from the list of both neighbors.
1351 * @param c Connection.
1354 unregister_neighbors (struct MeshConnection *c)
1356 struct MeshPeer *peer;
1358 peer = get_next_hop (c);
1359 if (GNUNET_OK != GMP_remove_connection (peer, c))
1361 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1362 || MESH_CONNECTION_DESTROYED == c->state);
1363 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1364 if (NULL != c->t) GMT_debug (c->t);
1367 peer = get_prev_hop (c);
1368 if (GNUNET_OK != GMP_remove_connection (peer, c))
1370 GNUNET_assert (MESH_CONNECTION_NEW == c->state
1371 || MESH_CONNECTION_DESTROYED == c->state);
1372 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1373 if (NULL != c->t) GMT_debug (c->t);
1379 * Bind the connection to the peer and the tunnel to that peer.
1381 * If the peer has no tunnel, create one. Update tunnel and connection
1382 * data structres to reflect new status.
1384 * @param c Connection.
1388 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1390 GMP_add_tunnel (peer);
1391 c->t = GMP_get_tunnel (peer);
1392 GMT_add_connection (c->t, c);
1397 * Builds a path from a PeerIdentity array.
1399 * @param peers PeerIdentity array.
1400 * @param size Size of the @c peers array.
1401 * @param own_pos Output parameter: own position in the path.
1403 * @return Fixed and shortened path.
1405 static struct MeshPeerPath *
1406 build_path_from_peer_ids (struct GNUNET_PeerIdentity *peers,
1408 unsigned int *own_pos)
1410 struct MeshPeerPath *path;
1411 GNUNET_PEER_Id shortid;
1414 unsigned int offset;
1417 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1418 path = path_new (size);
1421 for (i = 0; i < size; i++)
1423 LOG (GNUNET_ERROR_TYPE_DEBUG, " - %u: taking %s\n",
1424 i, GNUNET_i2s (&peers[i]));
1425 shortid = GNUNET_PEER_intern (&peers[i]);
1427 /* Check for loops / duplicates */
1428 for (j = 0; j < i - offset; j++)
1430 if (path->peers[j] == shortid)
1432 LOG (GNUNET_ERROR_TYPE_DEBUG, " already exists at pos %u\n", j);
1434 LOG (GNUNET_ERROR_TYPE_DEBUG, " offset now\n", offset);
1435 GNUNET_PEER_change_rc (shortid, -1);
1438 LOG (GNUNET_ERROR_TYPE_DEBUG, " storing at %u\n", i - offset);
1439 path->peers[i - offset] = shortid;
1440 if (path->peers[i] == myid)
1443 path->length -= offset;
1445 if (path->peers[*own_pos] != myid)
1447 /* create path: self not found in path through self */
1448 GNUNET_break_op (0);
1449 path_destroy (path);
1458 * Log receipt of message on stderr (INFO level).
1460 * @param message Message received.
1461 * @param peer Peer who sent the message.
1462 * @param hash Connection ID.
1465 log_message (const struct GNUNET_MessageHeader *message,
1466 const struct GNUNET_PeerIdentity *peer,
1467 const struct GNUNET_HashCode *hash)
1469 LOG (GNUNET_ERROR_TYPE_INFO, "<- %s on connection %s from %s\n",
1470 GM_m2s (ntohs (message->type)), GNUNET_h2s (hash), GNUNET_i2s (peer));
1473 /******************************************************************************/
1474 /******************************** API ***********************************/
1475 /******************************************************************************/
1478 * Core handler for connection creation.
1480 * @param cls Closure (unused).
1481 * @param peer Sender (neighbor).
1482 * @param message Message.
1484 * @return GNUNET_OK to keep the connection open,
1485 * GNUNET_SYSERR to close it (signal serious error)
1488 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1489 const struct GNUNET_MessageHeader *message)
1491 struct GNUNET_MESH_ConnectionCreate *msg;
1492 struct GNUNET_PeerIdentity *id;
1493 struct GNUNET_HashCode *cid;
1494 struct MeshPeerPath *path;
1495 struct MeshPeer *dest_peer;
1496 struct MeshPeer *orig_peer;
1497 struct MeshConnection *c;
1498 unsigned int own_pos;
1502 size = ntohs (message->size);
1503 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1505 GNUNET_break_op (0);
1509 /* Calculate hops */
1510 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1511 if (size % sizeof (struct GNUNET_PeerIdentity))
1513 GNUNET_break_op (0);
1516 size /= sizeof (struct GNUNET_PeerIdentity);
1519 GNUNET_break_op (0);
1522 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1524 /* Get parameters */
1525 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1527 log_message (message, peer, cid);
1528 id = (struct GNUNET_PeerIdentity *) &msg[1];
1529 LOG (GNUNET_ERROR_TYPE_DEBUG, " origin: %s\n", GNUNET_i2s (id));
1531 /* Create connection */
1532 c = connection_get (cid);
1535 path = build_path_from_peer_ids ((struct GNUNET_PeerIdentity *) &msg[1],
1541 GNUNET_break_op (0);
1542 path_destroy (path);
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1546 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1547 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1550 if (path->length - 1 == own_pos)
1552 /* If we are destination, why did the creation fail? */
1556 send_broken2 (cid, &my_full_id,
1557 GNUNET_PEER_resolve2 (path->peers[own_pos + 1]),
1558 path->peers[own_pos - 1]);
1559 path_destroy (path);
1562 GMP_add_path_to_all (path, GNUNET_NO);
1563 connection_reset_timeout (c, GNUNET_YES);
1567 path = path_duplicate (c->path);
1569 if (MESH_CONNECTION_NEW == c->state)
1570 connection_change_state (c, MESH_CONNECTION_SENT);
1572 /* Remember peers */
1573 dest_peer = GMP_get (&id[size - 1]);
1574 orig_peer = GMP_get (&id[0]);
1576 /* Is it a connection to us? */
1577 if (c->own_pos == size - 1)
1579 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1580 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1582 add_to_peer (c, orig_peer);
1583 if (MESH_TUNNEL3_NEW == GMT_get_cstate (c->t))
1584 GMT_change_cstate (c->t, MESH_TUNNEL3_WAITING);
1586 send_connection_ack (c, GNUNET_NO);
1587 if (MESH_CONNECTION_SENT == c->state)
1588 connection_change_state (c, MESH_CONNECTION_ACK);
1592 /* It's for somebody else! Retransmit. */
1593 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1594 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1595 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1596 GMC_send_prebuilt_message (message, c, GNUNET_YES, GNUNET_YES,
1599 path_destroy (path);
1605 * Core handler for path confirmations.
1607 * @param cls closure
1608 * @param message message
1609 * @param peer peer identity this notification is about
1611 * @return GNUNET_OK to keep the connection open,
1612 * GNUNET_SYSERR to close it (signal serious error)
1615 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1616 const struct GNUNET_MessageHeader *message)
1618 struct GNUNET_MESH_ConnectionACK *msg;
1619 struct MeshConnection *c;
1620 struct MeshPeerPath *p;
1621 struct MeshPeer *pi;
1622 enum MeshConnectionState oldstate;
1625 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1626 log_message (message, peer, &msg->cid);
1627 c = connection_get (&msg->cid);
1630 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1632 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1636 if (GNUNET_NO != c->destroy)
1638 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1642 oldstate = c->state;
1643 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1644 pi = GMP_get (peer);
1645 if (get_next_hop (c) == pi)
1647 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1649 if (MESH_CONNECTION_SENT == oldstate)
1650 connection_change_state (c, MESH_CONNECTION_ACK);
1652 else if (get_prev_hop (c) == pi)
1654 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1656 connection_change_state (c, MESH_CONNECTION_READY);
1660 GNUNET_break_op (0);
1664 connection_reset_timeout (c, fwd);
1666 /* Add path to peers? */
1670 GMP_add_path_to_all (p, GNUNET_YES);
1677 /* Message for us as creator? */
1678 if (GMC_is_origin (c, GNUNET_YES))
1680 if (GNUNET_NO != fwd)
1682 GNUNET_break_op (0);
1685 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1687 /* If just created, cancel the short timeout and start a long one */
1688 if (MESH_CONNECTION_SENT == oldstate)
1689 connection_reset_timeout (c, GNUNET_YES);
1691 /* Change connection state */
1692 connection_change_state (c, MESH_CONNECTION_READY);
1693 send_connection_ack (c, GNUNET_YES);
1695 /* Change tunnel state, trigger KX */
1696 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1697 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1702 /* Message for us as destination? */
1703 if (GMC_is_terminal (c, GNUNET_YES))
1705 if (GNUNET_YES != fwd)
1707 GNUNET_break_op (0);
1710 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1712 /* If just created, cancel the short timeout and start a long one */
1713 if (MESH_CONNECTION_ACK == oldstate)
1714 connection_reset_timeout (c, GNUNET_NO);
1716 /* Change tunnel state */
1717 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1718 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1723 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1724 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1730 * Core handler for notifications of broken paths
1732 * @param cls Closure (unused).
1733 * @param id Peer identity of sending neighbor.
1734 * @param message Message.
1736 * @return GNUNET_OK to keep the connection open,
1737 * GNUNET_SYSERR to close it (signal serious error)
1740 GMC_handle_broken (void* cls,
1741 const struct GNUNET_PeerIdentity* id,
1742 const struct GNUNET_MessageHeader* message)
1744 struct GNUNET_MESH_ConnectionBroken *msg;
1745 struct MeshConnection *c;
1748 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1749 log_message (message, id, &msg->cid);
1750 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1751 GNUNET_i2s (&msg->peer1));
1752 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1753 GNUNET_i2s (&msg->peer2));
1754 c = connection_get (&msg->cid);
1757 GNUNET_break_op (0);
1761 fwd = is_fwd (c, id);
1762 if (GMC_is_terminal (c, fwd))
1764 path_invalidate (c->path);
1765 if (0 < c->pending_messages)
1766 c->destroy = GNUNET_YES;
1772 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1773 c->destroy = GNUNET_YES;
1774 connection_cancel_queues (c, !fwd);
1783 * Core handler for tunnel destruction
1785 * @param cls Closure (unused).
1786 * @param peer Peer identity of sending neighbor.
1787 * @param message Message.
1789 * @return GNUNET_OK to keep the connection open,
1790 * GNUNET_SYSERR to close it (signal serious error)
1793 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1794 const struct GNUNET_MessageHeader *message)
1796 struct GNUNET_MESH_ConnectionDestroy *msg;
1797 struct MeshConnection *c;
1800 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1801 log_message (message, peer, &msg->cid);
1802 c = connection_get (&msg->cid);
1805 /* Probably already got the message from another path,
1806 * destroyed the tunnel and retransmitted to children.
1809 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1811 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1814 fwd = is_fwd (c, peer);
1815 if (GNUNET_SYSERR == fwd)
1817 GNUNET_break_op (0); /* FIXME */
1820 if (GNUNET_NO == GMC_is_terminal (c, fwd))
1821 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1822 else if (0 == c->pending_messages)
1824 LOG (GNUNET_ERROR_TYPE_DEBUG, "! directly destroying connection!\n");
1828 c->destroy = GNUNET_YES;
1829 c->state = MESH_CONNECTION_DESTROYED;
1832 GMT_remove_connection (c->t, c);
1840 * Generic handler for mesh network encrypted traffic.
1842 * @param peer Peer identity this notification is about.
1843 * @param msg Encrypted message.
1845 * @return GNUNET_OK to keep the connection open,
1846 * GNUNET_SYSERR to close it (signal serious error)
1849 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1850 const struct GNUNET_MESH_Encrypted *msg)
1852 struct MeshConnection *c;
1853 struct MeshPeer *neighbor;
1854 struct MeshFlowControl *fc;
1855 GNUNET_PEER_Id peer_id;
1861 log_message (&msg->header, peer, &msg->cid);
1864 size = ntohs (msg->header.size);
1866 sizeof (struct GNUNET_MESH_Encrypted) +
1867 sizeof (struct GNUNET_MessageHeader))
1869 GNUNET_break_op (0);
1873 /* Check connection */
1874 c = connection_get (&msg->cid);
1877 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1878 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING enc on unknown connection %s\n",
1879 GNUNET_h2s (&msg->cid));
1883 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s\n", GMC_2s (c));
1885 /* Check if origin is as expected */
1886 neighbor = get_prev_hop (c);
1887 peer_id = GNUNET_PEER_search (peer);
1888 if (peer_id == GMP_get_short_id (neighbor))
1894 neighbor = get_next_hop (c);
1895 if (peer_id == GMP_get_short_id (neighbor))
1901 /* Unexpected peer sending traffic on a connection. */
1902 GNUNET_break_op (0);
1908 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1909 pid = ntohl (msg->pid);
1910 if (GM_is_pid_bigger (pid, fc->last_ack_sent))
1912 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1913 LOG (GNUNET_ERROR_TYPE_DEBUG,
1914 "WARNING Received PID %u, (prev %u), ACK %u\n",
1915 pid, fc->last_pid_recv, fc->last_ack_sent);
1918 if (GNUNET_NO == GM_is_pid_bigger (pid, fc->last_pid_recv))
1920 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1921 LOG (GNUNET_ERROR_TYPE_DEBUG,
1922 " Pid %u not expected (%u+), dropping!\n",
1923 pid, fc->last_pid_recv + 1);
1926 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1927 connection_change_state (c, MESH_CONNECTION_READY);
1928 connection_reset_timeout (c, fwd);
1929 fc->last_pid_recv = pid;
1931 /* Is this message for us? */
1932 if (GMC_is_terminal (c, fwd))
1934 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1935 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1939 GNUNET_break (GNUNET_NO != c->destroy);
1942 fc->last_pid_recv = pid;
1943 GMT_handle_encrypted (c->t, msg);
1944 GMC_send_ack (c, fwd, GNUNET_NO);
1948 /* Message not for us: forward to next hop */
1949 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1950 ttl = ntohl (msg->ttl);
1951 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1954 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1955 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1956 GMC_send_ack (c, fwd, GNUNET_NO);
1960 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1961 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1967 * Generic handler for mesh network encrypted traffic.
1969 * @param peer Peer identity this notification is about.
1970 * @param msg Encrypted message.
1972 * @return GNUNET_OK to keep the connection open,
1973 * GNUNET_SYSERR to close it (signal serious error)
1976 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1977 const struct GNUNET_MESH_KX *msg)
1979 struct MeshConnection *c;
1980 struct MeshPeer *neighbor;
1981 GNUNET_PEER_Id peer_id;
1985 log_message (&msg->header, peer, &msg->cid);
1988 size = ntohs (msg->header.size);
1990 sizeof (struct GNUNET_MESH_KX) +
1991 sizeof (struct GNUNET_MessageHeader))
1993 GNUNET_break_op (0);
1997 /* Check connection */
1998 c = connection_get (&msg->cid);
2001 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
2002 LOG (GNUNET_ERROR_TYPE_DEBUG, "kx on unknown connection %s\n",
2003 GNUNET_h2s (&msg->cid));
2006 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
2008 /* Check if origin is as expected */
2009 neighbor = get_prev_hop (c);
2010 peer_id = GNUNET_PEER_search (peer);
2011 if (peer_id == GMP_get_short_id (neighbor))
2017 neighbor = get_next_hop (c);
2018 if (peer_id == GMP_get_short_id (neighbor))
2024 /* Unexpected peer sending traffic on a connection. */
2025 GNUNET_break_op (0);
2030 /* Count as connection confirmation. */
2031 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
2033 connection_change_state (c, MESH_CONNECTION_READY);
2036 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
2037 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
2040 connection_reset_timeout (c, fwd);
2042 /* Is this message for us? */
2043 if (GMC_is_terminal (c, fwd))
2045 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
2046 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
2052 GMT_handle_kx (c->t, &msg[1].header);
2056 /* Message not for us: forward to next hop */
2057 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
2058 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
2059 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
2066 * Core handler for encrypted mesh network traffic (channel mgmt, data).
2068 * @param cls Closure (unused).
2069 * @param message Message received.
2070 * @param peer Peer who sent the message.
2072 * @return GNUNET_OK to keep the connection open,
2073 * GNUNET_SYSERR to close it (signal serious error)
2076 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
2077 const struct GNUNET_MessageHeader *message)
2079 return handle_mesh_encrypted (peer,
2080 (struct GNUNET_MESH_Encrypted *)message);
2085 * Core handler for key exchange traffic (ephemeral key, ping, pong).
2087 * @param cls Closure (unused).
2088 * @param message Message received.
2089 * @param peer Peer who sent the message.
2091 * @return GNUNET_OK to keep the connection open,
2092 * GNUNET_SYSERR to close it (signal serious error)
2095 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
2096 const struct GNUNET_MessageHeader *message)
2098 return handle_mesh_kx (peer,
2099 (struct GNUNET_MESH_KX *) message);
2104 * Core handler for mesh network traffic point-to-point acks.
2106 * @param cls closure
2107 * @param message message
2108 * @param peer peer identity this notification is about
2110 * @return GNUNET_OK to keep the connection open,
2111 * GNUNET_SYSERR to close it (signal serious error)
2114 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
2115 const struct GNUNET_MessageHeader *message)
2117 struct GNUNET_MESH_ACK *msg;
2118 struct MeshConnection *c;
2119 struct MeshFlowControl *fc;
2124 msg = (struct GNUNET_MESH_ACK *) message;
2125 log_message (message, peer, &msg->cid);
2126 c = connection_get (&msg->cid);
2129 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
2134 /* Is this a forward or backward ACK? */
2135 id = GNUNET_PEER_search (peer);
2136 if (GMP_get_short_id (get_next_hop (c)) == id)
2138 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
2142 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2144 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
2150 GNUNET_break_op (0);
2154 ack = ntohl (msg->ack);
2155 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
2156 ack, fc->last_ack_recv);
2157 if (GM_is_pid_bigger (ack, fc->last_ack_recv))
2158 fc->last_ack_recv = ack;
2160 /* Cancel polling if the ACK is big enough. */
2161 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
2162 GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2164 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
2165 GNUNET_SCHEDULER_cancel (fc->poll_task);
2166 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2167 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
2170 connection_unlock_queue (c, fwd);
2177 * Core handler for mesh network traffic point-to-point ack polls.
2179 * @param cls closure
2180 * @param message message
2181 * @param peer peer identity this notification is about
2183 * @return GNUNET_OK to keep the connection open,
2184 * GNUNET_SYSERR to close it (signal serious error)
2187 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
2188 const struct GNUNET_MessageHeader *message)
2190 struct GNUNET_MESH_Poll *msg;
2191 struct MeshConnection *c;
2192 struct MeshFlowControl *fc;
2197 msg = (struct GNUNET_MESH_Poll *) message;
2198 log_message (message, peer, &msg->cid);
2199 c = connection_get (&msg->cid);
2202 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
2204 LOG (GNUNET_ERROR_TYPE_DEBUG,
2205 "WARNING POLL message on unknown connection %s!\n",
2206 GNUNET_h2s (&msg->cid));
2210 /* Is this a forward or backward ACK?
2211 * Note: a poll should never be needed in a loopback case,
2212 * since there is no possiblility of packet loss there, so
2213 * this way of discerining FWD/BCK should not be a problem.
2215 id = GNUNET_PEER_search (peer);
2216 if (GMP_get_short_id (get_next_hop (c)) == id)
2218 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2221 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2223 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2228 GNUNET_break_op (0);
2232 pid = ntohl (msg->pid);
2233 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2234 fc->last_pid_recv = pid;
2235 fwd = fc == &c->bck_fc;
2236 GMC_send_ack (c, fwd, GNUNET_YES);
2243 * Send an ACK on the appropriate connection/channel, depending on
2244 * the direction and the position of the peer.
2246 * @param c Which connection to send the hop-by-hop ACK.
2247 * @param fwd Is this a fwd ACK? (will go dest->root).
2248 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2251 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
2253 unsigned int buffer;
2255 LOG (GNUNET_ERROR_TYPE_DEBUG,
2256 "GMC send %s ACK on %s\n",
2257 GM_f2s (fwd), GMC_2s (c));
2265 if (GNUNET_NO != c->destroy)
2267 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2271 /* Get available buffer space */
2272 if (GMC_is_terminal (c, fwd))
2274 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2275 buffer = GMT_get_channels_buffer (c->t);
2279 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2280 buffer = GMC_get_buffer (c, fwd);
2282 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2283 if (0 == buffer && GNUNET_NO == force)
2286 /* Send available buffer space */
2287 if (GMC_is_origin (c, fwd))
2289 GNUNET_assert (NULL != c->t);
2290 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2291 GMT_unchoke_channels (c->t);
2295 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2296 send_ack (c, buffer, fwd, force);
2302 * Initialize the connections subsystem
2304 * @param c Configuration handle.
2307 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2309 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2311 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2314 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2315 "MESH", "MAX_MSGS_QUEUE", "MISSING");
2316 GNUNET_SCHEDULER_shutdown ();
2321 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2324 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2325 "MESH", "MAX_CONNECTIONS", "MISSING");
2326 GNUNET_SCHEDULER_shutdown ();
2331 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2332 &refresh_connection_time))
2334 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2335 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2336 GNUNET_SCHEDULER_shutdown ();
2339 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2340 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
2345 * Destroy each connection on shutdown.
2347 * @param cls Closure (unused).
2348 * @param key Current key code (CID, unused).
2349 * @param value Value in the hash map (connection)
2351 * @return #GNUNET_YES, because we should continue to iterate,
2354 shutdown_iterator (void *cls,
2355 const struct GNUNET_HashCode *key,
2358 struct MeshConnection *c = value;
2366 * Shut down the connections subsystem.
2371 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2372 GNUNET_CONTAINER_multihashmap_destroy (connections);
2377 struct MeshConnection *
2378 GMC_new (const struct GNUNET_HashCode *cid,
2379 struct MeshTunnel3 *t,
2380 struct MeshPeerPath *p,
2381 unsigned int own_pos)
2383 struct MeshConnection *c;
2385 c = GNUNET_new (struct MeshConnection);
2387 GNUNET_assert (GNUNET_OK ==
2388 GNUNET_CONTAINER_multihashmap_put (connections,
2390 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2391 fc_init (&c->fwd_fc);
2392 fc_init (&c->bck_fc);
2397 GNUNET_assert (own_pos <= p->length - 1);
2398 c->own_pos = own_pos;
2401 if (GNUNET_OK != register_neighbors (c))
2405 path_invalidate (c->path);
2418 GMC_destroy (struct MeshConnection *c)
2426 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2427 return; /* -> message_sent -> GMC_destroy. Don't loop. */
2430 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2431 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2432 &c->fwd_fc, &c->bck_fc);
2433 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2434 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2436 /* Cancel all traffic */
2437 if (NULL != c->path)
2439 connection_cancel_queues (c, GNUNET_YES);
2440 connection_cancel_queues (c, GNUNET_NO);
2441 unregister_neighbors (c);
2444 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2445 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2447 /* Cancel maintainance task (keepalive/timeout) */
2448 if (NULL != c->fwd_fc.poll_msg)
2450 GMC_cancel (c->fwd_fc.poll_msg);
2451 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2453 if (NULL != c->bck_fc.poll_msg)
2455 GMC_cancel (c->bck_fc.poll_msg);
2456 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2459 /* Delete from tunnel */
2461 GMT_remove_connection (c->t, c);
2463 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES) && NULL != c->path)
2464 path_destroy (c->path);
2465 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2466 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2467 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2468 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2469 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2471 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2472 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2474 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2476 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2477 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2480 GNUNET_break (GNUNET_YES ==
2481 GNUNET_CONTAINER_multihashmap_remove (connections, &c->id, c));
2483 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2488 * Get the connection ID.
2490 * @param c Connection to get the ID from.
2492 * @return ID of the connection.
2494 const struct GNUNET_HashCode *
2495 GMC_get_id (const struct MeshConnection *c)
2502 * Get the connection path.
2504 * @param c Connection to get the path from.
2506 * @return path used by the connection.
2508 const struct MeshPeerPath *
2509 GMC_get_path (const struct MeshConnection *c)
2511 if (GNUNET_NO == c->destroy)
2518 * Get the connection state.
2520 * @param c Connection to get the state from.
2522 * @return state of the connection.
2524 enum MeshConnectionState
2525 GMC_get_state (const struct MeshConnection *c)
2531 * Get the connection tunnel.
2533 * @param c Connection to get the tunnel from.
2535 * @return tunnel of the connection.
2537 struct MeshTunnel3 *
2538 GMC_get_tunnel (const struct MeshConnection *c)
2545 * Get free buffer space in a connection.
2547 * @param c Connection.
2548 * @param fwd Is query about FWD traffic?
2550 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2553 GMC_get_buffer (struct MeshConnection *c, int fwd)
2555 struct MeshFlowControl *fc;
2557 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2559 return (fc->queue_max - fc->queue_n);
2563 * Get how many messages have we allowed to send to us from a direction.
2565 * @param c Connection.
2566 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2568 * @return last_ack_sent - last_pid_recv
2571 GMC_get_allowed (struct MeshConnection *c, int fwd)
2573 struct MeshFlowControl *fc;
2575 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2576 if (GM_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2580 return (fc->last_ack_sent - fc->last_pid_recv);
2584 * Get messages queued in a connection.
2586 * @param c Connection.
2587 * @param fwd Is query about FWD traffic?
2589 * @return Number of messages queued.
2592 GMC_get_qn (struct MeshConnection *c, int fwd)
2594 struct MeshFlowControl *fc;
2596 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2603 * Allow the connection to advertise a buffer of the given size.
2605 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2606 * allowing up to last_pid_recv + buffer.
2608 * @param c Connection.
2609 * @param buffer How many more messages the connection can accept.
2610 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2613 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2615 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowing %s %u messages %s\n",
2616 GMC_2s (c), buffer, GM_f2s (fwd));
2617 send_ack (c, buffer, fwd, GNUNET_NO);
2622 * Notify other peers on a connection of a broken link. Mark connections
2623 * to destroy after all traffic has been sent.
2625 * @param c Connection on which there has been a disconnection.
2626 * @param peer Peer that disconnected.
2629 GMC_notify_broken (struct MeshConnection *c,
2630 struct MeshPeer *peer)
2634 LOG (GNUNET_ERROR_TYPE_DEBUG,
2635 " notify broken on %s due to %s disconnect\n",
2636 GMC_2s (c), GMP_2s (peer));
2638 fwd = peer == get_prev_hop (c);
2640 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2642 /* Local shutdown, no one to notify about this. */
2646 if (GNUNET_NO == c->destroy)
2647 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2649 /* Connection will have at least one pending message
2650 * (the one we just scheduled), so no point in checking whether to
2651 * destroy immediately. */
2652 c->destroy = GNUNET_YES;
2653 c->state = MESH_CONNECTION_DESTROYED;
2656 * Cancel all queues, if no message is left, connection will be destroyed.
2658 connection_cancel_queues (c, !fwd);
2665 * Is this peer the first one on the connection?
2667 * @param c Connection.
2668 * @param fwd Is this about fwd traffic?
2670 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2673 GMC_is_origin (struct MeshConnection *c, int fwd)
2675 if (!fwd && c->path->length - 1 == c->own_pos )
2677 if (fwd && 0 == c->own_pos)
2684 * Is this peer the last one on the connection?
2686 * @param c Connection.
2687 * @param fwd Is this about fwd traffic?
2688 * Note that the ROOT is the terminal for BCK traffic!
2690 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2693 GMC_is_terminal (struct MeshConnection *c, int fwd)
2695 return GMC_is_origin (c, !fwd);
2700 * See if we are allowed to send by the next hop in the given direction.
2702 * @param c Connection.
2703 * @param fwd Is this about fwd traffic?
2705 * @return #GNUNET_YES in case it's OK to send.
2708 GMC_is_sendable (struct MeshConnection *c, int fwd)
2710 struct MeshFlowControl *fc;
2717 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2718 if (GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2724 * Sends an already built message on a connection, properly registering
2725 * all used resources.
2727 * @param message Message to send. Function makes a copy of it.
2728 * If message is not hop-by-hop, decrements TTL of copy.
2729 * @param c Connection on which this message is transmitted.
2730 * @param fwd Is this a fwd message?
2731 * @param force Force the connection to accept the message (buffer overfill).
2732 * @param cont Continuation called once message is sent. Can be NULL.
2733 * @param cont_cls Closure for @c cont.
2735 * @return Handle to cancel the message before it's sent.
2736 * NULL on error or if @c cont is NULL.
2737 * Invalid on @c cont call.
2739 struct MeshConnectionQueue *
2740 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2741 struct MeshConnection *c, int fwd, int force,
2742 GMC_sent cont, void *cont_cls)
2744 struct MeshFlowControl *fc;
2745 struct MeshConnectionQueue *q;
2751 size = ntohs (message->size);
2752 data = GNUNET_malloc (size);
2753 memcpy (data, message, size);
2754 type = ntohs (message->type);
2755 LOG (GNUNET_ERROR_TYPE_INFO, "-> %s on connection %s (%u bytes)\n",
2756 GM_m2s (type), GMC_2s (c), size);
2758 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2759 droppable = GNUNET_NO == force;
2762 struct GNUNET_MESH_Encrypted *emsg;
2763 struct GNUNET_MESH_KX *kmsg;
2764 struct GNUNET_MESH_ACK *amsg;
2765 struct GNUNET_MESH_Poll *pmsg;
2766 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2767 struct GNUNET_MESH_ConnectionBroken *bmsg;
2770 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2771 emsg = (struct GNUNET_MESH_Encrypted *) data;
2772 ttl = ntohl (emsg->ttl);
2775 GNUNET_break_op (0);
2780 emsg->ttl = htonl (ttl - 1);
2781 emsg->pid = htonl (fc->next_pid++);
2782 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2783 if (GNUNET_YES == droppable)
2786 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2787 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2788 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2792 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2794 if (GM_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2796 GMC_start_poll (c, fwd);
2800 case GNUNET_MESSAGE_TYPE_MESH_KX:
2801 kmsg = (struct GNUNET_MESH_KX *) data;
2805 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2806 amsg = (struct GNUNET_MESH_ACK *) data;
2808 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2809 droppable = GNUNET_NO;
2812 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2813 pmsg = (struct GNUNET_MESH_Poll *) data;
2815 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2816 droppable = GNUNET_NO;
2819 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2820 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2824 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2825 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2829 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2830 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2831 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
2840 if (fc->queue_n > fc->queue_max && droppable)
2842 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2845 LOG (GNUNET_ERROR_TYPE_DEBUG,
2846 "queue full: %u/%u\n",
2847 fc->queue_n, fc->queue_max);
2848 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2854 return NULL; /* Drop this message */
2857 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2858 c->pending_messages++;
2860 q = GNUNET_new (struct MeshConnectionQueue);
2861 q->forced = !droppable;
2862 q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2866 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING dropping msg on %s\n", GMC_2s (c));
2872 q->cont_cls = cont_cls;
2878 * Cancel a previously sent message while it's in the queue.
2880 * ONLY can be called before the continuation given to the send function
2881 * is called. Once the continuation is called, the message is no longer in the
2884 * @param q Handle to the queue.
2887 GMC_cancel (struct MeshConnectionQueue *q)
2889 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
2891 /* queue destroy calls message_sent, which calls q->cont and frees q */
2892 GMP_queue_destroy (q->q, GNUNET_YES);
2897 * Sends a CREATE CONNECTION message for a path to a peer.
2898 * Changes the connection and tunnel states if necessary.
2900 * @param connection Connection to create.
2903 GMC_send_create (struct MeshConnection *connection)
2905 enum MeshTunnel3CState state;
2908 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2909 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2911 LOG (GNUNET_ERROR_TYPE_INFO, "=> %s on connection %s (%u bytes)\n",
2912 GM_m2s (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE),
2913 GMC_2s (connection), size);
2914 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2915 connection, connection->pending_messages);
2916 connection->pending_messages++;
2918 connection->maintenance_q =
2919 GMP_queue_add (get_next_hop (connection), NULL,
2920 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2921 size, connection, GNUNET_YES, &message_sent, NULL);
2923 state = GMT_get_cstate (connection->t);
2924 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2925 GMT_change_cstate (connection->t, MESH_TUNNEL3_WAITING);
2926 if (MESH_CONNECTION_NEW == connection->state)
2927 connection_change_state (connection, MESH_CONNECTION_SENT);
2932 * Send a message to all peers in this connection that the connection
2933 * is no longer valid.
2935 * If some peer should not receive the message, it should be zero'ed out
2936 * before calling this function.
2938 * @param c The connection whose peers to notify.
2941 GMC_send_destroy (struct MeshConnection *c)
2943 struct GNUNET_MESH_ConnectionDestroy msg;
2945 if (GNUNET_YES == c->destroy)
2948 msg.header.size = htons (sizeof (msg));
2949 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
2951 LOG (GNUNET_ERROR_TYPE_DEBUG,
2952 " sending connection destroy for connection %s\n",
2955 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
2956 GMC_send_prebuilt_message (&msg.header, c,
2957 GNUNET_YES, GNUNET_YES, NULL, NULL);
2958 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
2959 GMC_send_prebuilt_message (&msg.header, c,
2960 GNUNET_NO, GNUNET_YES, NULL, NULL);
2961 c->destroy = GNUNET_YES;
2962 c->state = MESH_CONNECTION_DESTROYED;
2967 * @brief Start a polling timer for the connection.
2969 * When a neighbor does not accept more traffic on the connection it could be
2970 * caused by a simple congestion or by a lost ACK. Polling enables to check
2971 * for the lastest ACK status for a connection.
2973 * @param c Connection.
2974 * @param fwd Should we poll in the FWD direction?
2977 GMC_start_poll (struct MeshConnection *c, int fwd)
2979 struct MeshFlowControl *fc;
2981 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2982 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
2984 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
2986 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
2987 fc->poll_task, fc->poll_msg);
2990 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
2991 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
2998 * @brief Stop polling a connection for ACKs.
3000 * Once we have enough ACKs for future traffic, polls are no longer necessary.
3002 * @param c Connection.
3003 * @param fwd Should we stop the poll in the FWD direction?
3006 GMC_stop_poll (struct MeshConnection *c, int fwd)
3008 struct MeshFlowControl *fc;
3010 fc = fwd ? &c->fwd_fc : &c->bck_fc;
3011 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
3013 GNUNET_SCHEDULER_cancel (fc->poll_task);
3014 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
3019 * Get a (static) string for a connection.
3021 * @param c Connection.
3024 GMC_2s (const struct MeshConnection *c)
3031 static char buf[128];
3033 sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
3036 return GNUNET_h2s (&c->id);