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_enc.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;
110 * Keep a record of the last messages sent on this connection.
112 struct MeshConnectionPerformance
115 * Circular buffer for storing measurements.
117 double usecsperbyte[AVG_MSGS];
120 * Running average of @c usecsperbyte.
125 * How many values of @c usecsperbyte are valid.
130 * Index of the next "free" position in @c usecsperbyte.
137 * Struct containing all information regarding a connection to a peer.
139 struct MeshConnection
142 * Tunnel this connection is part of.
144 struct MeshTunnel3 *t;
147 * Flow control information for traffic fwd.
149 struct MeshFlowControl fwd_fc;
152 * Flow control information for traffic bck.
154 struct MeshFlowControl bck_fc;
157 * Measure connection performance on the endpoint.
159 struct MeshConnectionPerformance *perf;
162 * ID of the connection.
164 struct GNUNET_HashCode id;
167 * State of the connection.
169 enum MeshConnectionState state;
172 * Path being used for the tunnel.
174 struct MeshPeerPath *path;
177 * Position of the local peer in the path.
179 unsigned int own_pos;
182 * Task to keep the used paths alive at the owner,
183 * time tunnel out on all the other peers.
185 GNUNET_SCHEDULER_TaskIdentifier fwd_maintenance_task;
188 * Task to keep the used paths alive at the destination,
189 * time tunnel out on all the other peers.
191 GNUNET_SCHEDULER_TaskIdentifier bck_maintenance_task;
194 * Pending message count.
196 int pending_messages;
199 * Destroy flag: if true, destroy on last message.
204 /******************************************************************************/
205 /******************************* GLOBALS ***********************************/
206 /******************************************************************************/
209 * Global handle to the statistics service.
211 extern struct GNUNET_STATISTICS_Handle *stats;
214 * Local peer own ID (memory efficient handle).
216 extern GNUNET_PEER_Id myid;
219 * Local peer own ID (full value).
221 extern struct GNUNET_PeerIdentity my_full_id;
224 * Connections known, indexed by cid (MeshConnection).
226 static struct GNUNET_CONTAINER_MultiHashMap *connections;
229 * How many connections are we willing to maintain.
230 * Local connections are always allowed, even if there are more connections than max.
232 static unsigned long long max_connections;
235 * How many messages *in total* are we willing to queue, divide by number of
236 * connections to get connection queue size.
238 static unsigned long long max_msgs_queue;
241 * How often to send path keepalives. Paths timeout after 4 missed.
243 static struct GNUNET_TIME_Relative refresh_connection_time;
246 /******************************************************************************/
247 /******************************** STATIC ***********************************/
248 /******************************************************************************/
250 #if 0 // avoid compiler warning for unused static function
252 fc_debug (struct MeshFlowControl *fc)
254 LOG (GNUNET_ERROR_TYPE_DEBUG, " IN: %u/%u\n",
255 fc->last_pid_recv, fc->last_ack_sent);
256 LOG (GNUNET_ERROR_TYPE_DEBUG, " OUT: %u/%u\n",
257 fc->last_pid_sent, fc->last_ack_recv);
258 LOG (GNUNET_ERROR_TYPE_DEBUG, " QUEUE: %u/%u\n",
259 fc->queue_n, fc->queue_max);
263 connection_debug (struct MeshConnection *c)
267 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CONNECTION ***\n");
270 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s:%X\n",
271 peer2s (c->t->peer), GMC_2s (c));
272 LOG (GNUNET_ERROR_TYPE_DEBUG, " state: %u, pending msgs: %u\n",
273 c->state, c->pending_messages);
274 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
275 fc_debug (&c->fwd_fc);
276 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
277 fc_debug (&c->bck_fc);
282 * Get string description for tunnel state.
284 * @param s Tunnel state.
286 * @return String representation.
289 GMC_state2s (enum MeshConnectionState s)
293 case MESH_CONNECTION_NEW:
294 return "MESH_CONNECTION_NEW";
295 case MESH_CONNECTION_SENT:
296 return "MESH_CONNECTION_SENT";
297 case MESH_CONNECTION_ACK:
298 return "MESH_CONNECTION_ACK";
299 case MESH_CONNECTION_READY:
300 return "MESH_CONNECTION_READY";
302 return "MESH_CONNECTION_STATE_ERROR";
308 * Initialize a Flow Control structure to the initial state.
310 * @param fc Flow Control structure to initialize.
313 fc_init (struct MeshFlowControl *fc)
316 fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
317 fc->last_pid_recv = (uint32_t) -1;
318 fc->last_ack_sent = (uint32_t) 0;
319 fc->last_ack_recv = (uint32_t) 0;
320 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
321 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
323 fc->queue_max = (max_msgs_queue / max_connections) + 1;
330 * @param cid Connection ID.
332 static struct MeshConnection *
333 connection_get (const struct GNUNET_HashCode *cid)
335 return GNUNET_CONTAINER_multihashmap_get (connections, cid);
340 connection_change_state (struct MeshConnection* c,
341 enum MeshConnectionState state)
343 LOG (GNUNET_ERROR_TYPE_DEBUG,
344 "Connection %s state was %s\n",
345 GMC_2s (c), GMC_state2s (c->state));
346 LOG (GNUNET_ERROR_TYPE_DEBUG,
347 "Connection %s state is now %s\n",
348 GMC_2s (c), GMC_state2s (state));
354 * Send an ACK on the connection, informing the predecessor about
355 * the available buffer space. Should not be called in case the peer
356 * is origin (no predecessor).
358 * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
359 * the ACK itself goes "back" (dest->root).
361 * @param c Connection on which to send the ACK.
362 * @param buffer How much space free to advertise?
363 * @param fwd Is this FWD ACK? (Going dest->owner)
366 send_ack (struct MeshConnection *c, unsigned int buffer, int fwd)
368 struct MeshFlowControl *next_fc;
369 struct MeshFlowControl *prev_fc;
370 struct GNUNET_MESH_ACK msg;
374 /* If origin, there is no connection to send ACKs. Wrong function! */
375 if (GMC_is_origin (c, fwd))
381 next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
382 prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
384 LOG (GNUNET_ERROR_TYPE_DEBUG,
385 "connection send %s ack on %s\n",
386 fwd ? "FWD" : "BCK", GMC_2s (c));
388 /* Check if we need to transmit the ACK */
389 delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
390 if (3 < delta && buffer < delta)
392 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
393 LOG (GNUNET_ERROR_TYPE_DEBUG,
394 " last pid recv: %u, last ack sent: %u\n",
395 prev_fc->last_pid_recv, prev_fc->last_ack_sent);
399 /* Ok, ACK might be necessary, what PID to ACK? */
400 ack = prev_fc->last_pid_recv + buffer;
401 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
402 LOG (GNUNET_ERROR_TYPE_DEBUG,
403 " last pid %u, last ack %u, qmax %u, q %u\n",
404 prev_fc->last_pid_recv, prev_fc->last_ack_sent,
405 next_fc->queue_max, next_fc->queue_n);
406 if (ack == prev_fc->last_ack_sent)
408 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
412 prev_fc->last_ack_sent = ack;
414 /* Build ACK message and send on connection */
415 msg.header.size = htons (sizeof (msg));
416 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
417 msg.ack = htonl (ack);
420 GMC_send_prebuilt_message (&msg.header, c, !fwd);
425 * Callback called when a queued message is sent.
427 * Calculates the average time and connection packet tracking.
429 * @param cls Closure.
430 * @param c Connection this message was on.
431 * @param type Type of message sent.
432 * @param fwd Was this a FWD going message?
433 * @param size Size of the message.
434 * @param wait Time spent waiting for core (only the time for THIS message)
437 message_sent (void *cls,
438 struct MeshConnection *c, uint16_t type,
439 int fwd, size_t size,
440 struct GNUNET_TIME_Relative wait)
442 struct MeshConnectionPerformance *p;
443 struct MeshFlowControl *fc;
446 fc = fwd ? &c->fwd_fc : &c->bck_fc;
447 LOG (GNUNET_ERROR_TYPE_DEBUG, "! sent %s\n", GNUNET_MESH_DEBUG_M2S (type));
448 LOG (GNUNET_ERROR_TYPE_DEBUG, "! Q_N- %p %u\n", fc, fc->queue_n);
449 LOG (GNUNET_ERROR_TYPE_DEBUG, "! C_P- %p %u\n", c, c->pending_messages);
450 c->pending_messages--;
451 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
453 LOG (GNUNET_ERROR_TYPE_DEBUG, "! destroying connection!\n");
457 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
460 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
463 LOG (GNUNET_ERROR_TYPE_DEBUG,
464 "! accounting pid %u\n",
466 GMC_send_ack (c, fwd);
471 LOG (GNUNET_ERROR_TYPE_DEBUG, "! message sent!\n");
474 return; /* Only endpoints are interested in timing. */
477 usecsperbyte = ((double) wait.rel_value_us) / size;
478 if (p->size == AVG_MSGS)
480 /* Array is full. Substract oldest value, add new one and store. */
481 p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
482 p->usecsperbyte[p->idx] = usecsperbyte;
483 p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
487 /* Array not yet full. Add current value to avg and store. */
488 p->usecsperbyte[p->idx] = usecsperbyte;
490 p->avg += p->usecsperbyte[p->idx];
494 p->idx = (p->idx + 1) % AVG_MSGS;
499 * Get the previous hop in a connection
501 * @param c Connection.
503 * @return Previous peer in the connection.
505 static struct MeshPeer *
506 get_prev_hop (const struct MeshConnection *c)
510 LOG (GNUNET_ERROR_TYPE_DEBUG, "Get prev hop, own pos %u\n", c->own_pos);
511 if (0 == c->own_pos || c->path->length < 2)
512 id = c->path->peers[0];
514 id = c->path->peers[c->own_pos - 1];
516 return GMP_get_short (id);
521 * Get the next hop in a connection
523 * @param c Connection.
525 * @return Next peer in the connection.
527 static struct MeshPeer *
528 get_next_hop (const struct MeshConnection *c)
532 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
533 id = c->path->peers[c->path->length - 1];
535 id = c->path->peers[c->own_pos + 1];
537 return GMP_get_short (id);
542 * Get the hop in a connection.
544 * @param c Connection.
545 * @param fwd Next hop?
547 * @return Next peer in the connection.
549 static struct MeshPeer *
550 get_hop (struct MeshConnection *c, int fwd)
553 return get_next_hop (c);
554 return get_prev_hop (c);
559 * Is traffic coming from this sender 'FWD' traffic?
561 * @param c Connection to check.
562 * @param sender Peer identity of neighbor.
564 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
565 * the traffic is 'FWD'.
566 * #GNUNET_NO for BCK.
567 * #GNUNET_SYSERR for errors.
570 is_fwd (const struct MeshConnection *c,
571 const struct GNUNET_PeerIdentity *sender)
575 id = GNUNET_PEER_search (sender);
576 if (GMP_get_short_id (get_prev_hop (c)) == id)
579 if (GMP_get_short_id (get_next_hop (c)) == id)
583 return GNUNET_SYSERR;
588 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
589 * or a first CONNECTION_ACK directed to us.
591 * @param connection Connection to confirm.
592 * @param fwd Should we send it FWD? (root->dest)
593 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
596 send_connection_ack (struct MeshConnection *connection, int fwd)
598 struct MeshTunnel3 *t;
601 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection %s ACK\n",
602 !fwd ? "FWD" : "BCK");
603 GMP_queue_add (get_hop (connection, fwd), NULL,
604 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
605 sizeof (struct GNUNET_MESH_ConnectionACK),
606 connection, fwd, &message_sent, NULL);
607 if (MESH_TUNNEL3_NEW == GMT_get_state (t))
608 GMT_change_state (t, MESH_TUNNEL3_WAITING);
609 if (MESH_CONNECTION_READY != connection->state)
610 connection_change_state (connection, MESH_CONNECTION_SENT);
615 * Send a notification that a connection is broken.
617 * @param c Connection that is broken.
618 * @param id1 Peer that has disconnected.
619 * @param id2 Peer that has disconnected.
620 * @param fwd Direction towards which to send it.
623 send_broken (struct MeshConnection *c,
624 const struct GNUNET_PeerIdentity *id1,
625 const struct GNUNET_PeerIdentity *id2,
628 struct GNUNET_MESH_ConnectionBroken msg;
630 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
631 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
635 GMC_send_prebuilt_message (&msg.header, c, fwd);
641 * Send keepalive packets for a connection.
643 * @param c Connection to keep alive..
644 * @param fwd Is this a FWD keepalive? (owner -> dest).
647 connection_keepalive (struct MeshConnection *c, int fwd)
649 struct GNUNET_MESH_ConnectionKeepAlive *msg;
650 size_t size = sizeof (struct GNUNET_MESH_ConnectionKeepAlive);
654 type = fwd ? GNUNET_MESSAGE_TYPE_MESH_FWD_KEEPALIVE :
655 GNUNET_MESSAGE_TYPE_MESH_BCK_KEEPALIVE;
657 LOG (GNUNET_ERROR_TYPE_DEBUG,
658 "sending %s keepalive for connection %s]\n",
659 fwd ? "FWD" : "BCK", GMC_2s (c));
661 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) cbuf;
662 msg->header.size = htons (size);
663 msg->header.type = htons (type);
666 GMC_send_prebuilt_message (&msg->header, c, fwd);
671 * Send CONNECTION_{CREATE/ACK} packets for a connection.
673 * @param c Connection for which to send the message.
674 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
677 connection_recreate (struct MeshConnection *c, int fwd)
679 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
683 send_connection_ack (c, GNUNET_NO);
688 * Generic connection timer management.
689 * Depending on the role of the peer in the connection will send the
690 * appropriate message (build or keepalive)
692 * @param c Conncetion to maintain.
696 connection_maintain (struct MeshConnection *c, int fwd)
698 if (MESH_TUNNEL3_SEARCHING == GMT_get_state (c->t))
700 /* TODO DHT GET with RO_BART */
705 case MESH_CONNECTION_NEW:
707 case MESH_CONNECTION_SENT:
708 connection_recreate (c, fwd);
710 case MESH_CONNECTION_READY:
711 connection_keepalive (c, fwd);
720 connection_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
722 struct MeshConnection *c = cls;
724 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
725 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
728 connection_maintain (c, GNUNET_YES);
729 c->fwd_maintenance_task = GNUNET_SCHEDULER_add_delayed (refresh_connection_time,
730 &connection_fwd_keepalive,
736 connection_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
738 struct MeshConnection *c = cls;
740 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
741 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
744 connection_maintain (c, GNUNET_NO);
745 c->bck_maintenance_task = GNUNET_SCHEDULER_add_delayed (refresh_connection_time,
746 &connection_bck_keepalive,
752 * @brief Re-initiate traffic on this connection if necessary.
754 * Check if there is traffic queued towards this peer
755 * and the core transmit handle is NULL (traffic was stalled).
756 * If so, call core tmt rdy.
758 * @param c Connection on which initiate traffic.
759 * @param fwd Is this about fwd traffic?
762 connection_unlock_queue (struct MeshConnection *c, int fwd)
764 struct MeshPeer *peer;
766 LOG (GNUNET_ERROR_TYPE_DEBUG,
767 "connection_unlock_queue %s on %s\n",
768 fwd ? "FWD" : "BCK", GMC_2s (c));
770 if (GMC_is_terminal (c, fwd))
772 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
776 peer = get_hop (c, fwd);
777 GMP_queue_unlock (peer, c);
782 * Cancel all transmissions that belong to a certain connection.
784 * If the connection is scheduled for destruction and no more messages are left,
785 * the connection will be destroyed by the continuation call.
787 * @param c Connection which to cancel. Might be destroyed during this call.
788 * @param fwd Cancel fwd traffic?
791 connection_cancel_queues (struct MeshConnection *c, int fwd)
793 struct MeshFlowControl *fc;
794 struct MeshPeer *peer;
802 fc = fwd ? &c->fwd_fc : &c->bck_fc;
803 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
805 GNUNET_SCHEDULER_cancel (fc->poll_task);
806 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
808 peer = get_hop (c, fwd);
809 GMP_queue_cancel (peer, c);
814 * Function called if a connection has been stalled for a while,
815 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
817 * @param cls Closure (poll ctx).
818 * @param tc TaskContext.
821 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
823 struct MeshFlowControl *fc = cls;
824 struct GNUNET_MESH_Poll msg;
825 struct MeshConnection *c;
827 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
828 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
834 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
835 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
836 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
837 fc == &c->fwd_fc ? "FWD" : "BCK");
839 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
840 msg.header.size = htons (sizeof (msg));
841 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** pid (%u)!\n", fc->last_pid_sent);
842 GMC_send_prebuilt_message (&msg.header, c, fc == &c->fwd_fc);
843 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
844 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
845 &connection_poll, fc);
850 * Timeout function due to lack of keepalive/traffic from the owner.
851 * Destroys connection if called.
853 * @param cls Closure (connection to destroy).
854 * @param tc TaskContext.
857 connection_fwd_timeout (void *cls,
858 const struct GNUNET_SCHEDULER_TaskContext *tc)
860 struct MeshConnection *c = cls;
862 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
863 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
865 LOG (GNUNET_ERROR_TYPE_DEBUG,
866 "Connection %s[%X] FWD timed out. Destroying.\n",
870 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
878 * Timeout function due to lack of keepalive/traffic from the destination.
879 * Destroys connection if called.
881 * @param cls Closure (connection to destroy).
882 * @param tc TaskContext
885 connection_bck_timeout (void *cls,
886 const struct GNUNET_SCHEDULER_TaskContext *tc)
888 struct MeshConnection *c = cls;
890 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
891 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
894 LOG (GNUNET_ERROR_TYPE_DEBUG,
895 "Connection %s[%X] FWD timed out. Destroying.\n",
896 GMT_2s (c->t), c->id);
898 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
906 * Resets the connection timeout task, some other message has done the
908 * - For the first peer on the direction this means to send
909 * a keepalive or a path confirmation message (either create or ACK).
910 * - For all other peers, this means to destroy the connection,
911 * due to lack of activity.
912 * Starts the tiemout if no timeout was running (connection just created).
914 * @param c Connection whose timeout to reset.
915 * @param fwd Is this forward?
917 * TODO use heap to improve efficiency of scheduler.
920 connection_reset_timeout (struct MeshConnection *c, int fwd)
922 GNUNET_SCHEDULER_TaskIdentifier *ti;
923 GNUNET_SCHEDULER_Task f;
925 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
927 if (GNUNET_SCHEDULER_NO_TASK != *ti)
928 GNUNET_SCHEDULER_cancel (*ti);
930 if (GMC_is_origin (c, fwd)) /* Endpoint */
932 f = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
933 *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
937 struct GNUNET_TIME_Relative delay;
939 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
940 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
941 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
947 * Add the connection to the list of both neighbors.
949 * @param c Connection.
952 register_neighbors (struct MeshConnection *c)
954 struct MeshPeer *peer;
956 peer = get_next_hop (c);
957 if (GNUNET_NO == GMP_is_neighbor (peer))
962 GMP_add_connection (peer, c);
963 peer = get_prev_hop (c);
964 if (GNUNET_NO == GMP_is_neighbor (peer))
969 GMP_add_connection (peer, c);
974 * Remove the connection from the list of both neighbors.
976 * @param c Connection.
979 unregister_neighbors (struct MeshConnection *c)
981 struct MeshPeer *peer;
983 peer = get_next_hop (c);
984 GMP_remove_connection (peer, c);
986 peer = get_prev_hop (c);
987 GMP_remove_connection (peer, c);
993 * Bind the connection to the peer and the tunnel to that peer.
995 * If the peer has no tunnel, create one. Update tunnel and connection
996 * data structres to reflect new status.
998 * @param c Connection.
1002 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1004 GMP_add_tunnel (peer);
1005 c->t = GMP_get_tunnel (peer);
1006 GMT_add_connection (c->t, c);
1009 /******************************************************************************/
1010 /******************************** API ***********************************/
1011 /******************************************************************************/
1014 * Core handler for connection creation.
1016 * @param cls Closure (unused).
1017 * @param peer Sender (neighbor).
1018 * @param message Message.
1020 * @return GNUNET_OK to keep the connection open,
1021 * GNUNET_SYSERR to close it (signal serious error)
1024 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1025 const struct GNUNET_MessageHeader *message)
1027 struct GNUNET_MESH_ConnectionCreate *msg;
1028 struct GNUNET_PeerIdentity *id;
1029 struct GNUNET_HashCode *cid;
1030 struct MeshPeerPath *path;
1031 struct MeshPeer *dest_peer;
1032 struct MeshPeer *orig_peer;
1033 struct MeshConnection *c;
1034 unsigned int own_pos;
1038 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1039 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection create msg\n");
1042 size = ntohs (message->size);
1043 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1045 GNUNET_break_op (0);
1049 /* Calculate hops */
1050 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1051 if (size % sizeof (struct GNUNET_PeerIdentity))
1053 GNUNET_break_op (0);
1056 size /= sizeof (struct GNUNET_PeerIdentity);
1059 GNUNET_break_op (0);
1062 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1064 /* Get parameters */
1065 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1067 id = (struct GNUNET_PeerIdentity *) &msg[1];
1068 LOG (GNUNET_ERROR_TYPE_DEBUG,
1069 " connection %s (%s).\n",
1070 GNUNET_h2s (cid), GNUNET_i2s (id));
1072 /* Create connection */
1073 c = connection_get (cid);
1077 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1078 path = path_new (size);
1080 for (i = 0; i < size; i++)
1082 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... adding %s\n",
1083 GNUNET_i2s (&id[i]));
1084 path->peers[i] = GNUNET_PEER_intern (&id[i]);
1085 if (path->peers[i] == myid)
1088 if (own_pos == 0 && path->peers[own_pos] != myid)
1090 /* create path: self not found in path through self */
1091 GNUNET_break_op (0);
1092 path_destroy (path);
1095 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1096 GMP_add_path_to_all (path, GNUNET_NO);
1097 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1098 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1101 connection_reset_timeout (c, GNUNET_YES);
1107 if (MESH_CONNECTION_NEW == c->state)
1108 connection_change_state (c, MESH_CONNECTION_SENT);
1110 /* Remember peers */
1111 dest_peer = GMP_get (&id[size - 1]);
1112 orig_peer = GMP_get (&id[0]);
1114 /* Is it a connection to us? */
1115 if (c->own_pos == size - 1)
1117 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1118 GMP_add_path_to_origin (orig_peer, path, GNUNET_YES);
1120 add_to_peer (c, orig_peer);
1121 if (MESH_TUNNEL3_NEW == GMT_get_state (c->t))
1122 GMT_change_state (c->t, MESH_TUNNEL3_WAITING);
1124 send_connection_ack (c, GNUNET_NO);
1125 if (MESH_CONNECTION_SENT == c->state)
1126 connection_change_state (c, MESH_CONNECTION_ACK);
1128 /* Keep tunnel alive in direction dest->owner*/
1129 connection_reset_timeout (c, GNUNET_NO);
1133 /* It's for somebody else! Retransmit. */
1134 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1135 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1136 GMP_add_path_to_origin (orig_peer, path, GNUNET_NO);
1137 GMC_send_prebuilt_message (message, c, GNUNET_YES);
1144 * Core handler for path confirmations.
1146 * @param cls closure
1147 * @param message message
1148 * @param peer peer identity this notification is about
1150 * @return GNUNET_OK to keep the connection open,
1151 * GNUNET_SYSERR to close it (signal serious error)
1154 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1155 const struct GNUNET_MessageHeader *message)
1157 struct GNUNET_MESH_ConnectionACK *msg;
1158 struct MeshConnection *c;
1159 struct MeshPeerPath *p;
1160 struct MeshPeer *pi;
1163 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1164 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection ACK msg\n");
1165 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1166 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n",
1167 GNUNET_h2s (&msg->cid));
1168 c = connection_get (&msg->cid);
1171 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1173 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1178 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n",
1180 pi = GMP_get (peer);
1181 if (get_next_hop (c) == pi)
1183 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1185 if (MESH_CONNECTION_SENT == c->state)
1186 connection_change_state (c, MESH_CONNECTION_ACK);
1188 else if (get_prev_hop (c) == pi)
1190 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1192 connection_change_state (c, MESH_CONNECTION_READY);
1196 GNUNET_break_op (0);
1199 connection_reset_timeout (c, fwd);
1201 /* Add path to peers? */
1205 GMP_add_path_to_all (p, GNUNET_YES);
1212 /* Message for us as creator? */
1213 if (GMC_is_origin (c, GNUNET_YES))
1215 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1216 connection_change_state (c, MESH_CONNECTION_READY);
1217 GMT_change_state (c->t, MESH_TUNNEL3_READY);
1218 send_connection_ack (c, GNUNET_YES);
1222 /* Message for us as destination? */
1223 if (GMC_is_terminal (c, GNUNET_YES))
1225 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1226 connection_change_state (c, MESH_CONNECTION_READY);
1227 GMT_change_state (c->t, MESH_TUNNEL3_READY);
1231 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1232 GMC_send_prebuilt_message (message, c, fwd);
1238 * Core handler for notifications of broken paths
1240 * @param cls Closure (unused).
1241 * @param id Peer identity of sending neighbor.
1242 * @param message Message.
1244 * @return GNUNET_OK to keep the connection open,
1245 * GNUNET_SYSERR to close it (signal serious error)
1248 GMC_handle_broken (void* cls,
1249 const struct GNUNET_PeerIdentity* id,
1250 const struct GNUNET_MessageHeader* message)
1252 struct GNUNET_MESH_ConnectionBroken *msg;
1253 struct MeshConnection *c;
1256 LOG (GNUNET_ERROR_TYPE_DEBUG,
1257 "Received a CONNECTION BROKEN msg from %s\n", GNUNET_i2s (id));
1258 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1259 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1260 GNUNET_i2s (&msg->peer1));
1261 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1262 GNUNET_i2s (&msg->peer2));
1263 c = connection_get (&msg->cid);
1266 GNUNET_break_op (0);
1270 fwd = is_fwd (c, id);
1271 connection_cancel_queues (c, !fwd);
1272 if (GMC_is_terminal (c, fwd))
1274 if (0 < c->pending_messages)
1275 c->destroy = GNUNET_YES;
1281 GMC_send_prebuilt_message (message, c, fwd);
1282 c->destroy = GNUNET_YES;
1291 * Core handler for tunnel destruction
1293 * @param cls Closure (unused).
1294 * @param peer Peer identity of sending neighbor.
1295 * @param message Message.
1297 * @return GNUNET_OK to keep the connection open,
1298 * GNUNET_SYSERR to close it (signal serious error)
1301 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1302 const struct GNUNET_MessageHeader *message)
1304 struct GNUNET_MESH_ConnectionDestroy *msg;
1305 struct MeshConnection *c;
1308 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1309 LOG (GNUNET_ERROR_TYPE_DEBUG,
1310 "Got a CONNECTION DESTROY message from %s\n",
1312 LOG (GNUNET_ERROR_TYPE_DEBUG,
1313 " for connection %s\n",
1314 GNUNET_h2s (&msg->cid));
1315 c = connection_get (&msg->cid);
1318 /* Probably already got the message from another path,
1319 * destroyed the tunnel and retransmitted to children.
1322 GNUNET_STATISTICS_update (stats, "# control on unknown tunnel",
1326 fwd = is_fwd (c, peer);
1327 if (GNUNET_SYSERR == fwd)
1329 GNUNET_break_op (0);
1332 GMC_send_prebuilt_message (message, c, fwd);
1333 c->destroy = GNUNET_YES;
1339 * Generic handler for mesh network encrypted traffic.
1341 * @param peer Peer identity this notification is about.
1342 * @param msg Encrypted message.
1344 * @return GNUNET_OK to keep the connection open,
1345 * GNUNET_SYSERR to close it (signal serious error)
1348 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1349 const struct GNUNET_MESH_Encrypted *msg)
1351 struct MeshConnection *c;
1352 struct MeshPeer *neighbor;
1353 struct MeshFlowControl *fc;
1354 GNUNET_PEER_Id peer_id;
1362 size = ntohs (msg->header.size);
1364 sizeof (struct GNUNET_MESH_Encrypted) +
1365 sizeof (struct GNUNET_MessageHeader))
1367 GNUNET_break_op (0);
1370 type = ntohs (msg->header.type);
1371 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1372 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message from %s\n",
1373 GNUNET_MESH_DEBUG_M2S (type), GNUNET_i2s (peer));
1375 /* Check connection */
1376 c = connection_get (&msg->cid);
1379 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1380 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING connection unknown\n");
1384 /* Check if origin is as expected */
1385 neighbor = get_prev_hop (c);
1386 peer_id = GNUNET_PEER_search (peer);
1387 if (peer_id == GMP_get_short_id (neighbor))
1393 neighbor = get_next_hop (c);
1394 if (peer_id == GMP_get_short_id (neighbor))
1400 /* Unexpected peer sending traffic on a connection. */
1401 GNUNET_break_op (0);
1407 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1408 pid = ntohl (msg->pid);
1409 if (GMC_is_pid_bigger (pid, fc->last_ack_sent))
1411 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1412 LOG (GNUNET_ERROR_TYPE_DEBUG,
1413 "WARNING Received PID %u, (prev %u), ACK %u\n",
1414 pid, fc->last_pid_recv, fc->last_ack_sent);
1417 if (GNUNET_NO == GMC_is_pid_bigger (pid, fc->last_pid_recv))
1419 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1420 LOG (GNUNET_ERROR_TYPE_DEBUG,
1421 " Pid %u not expected (%u+), dropping!\n",
1422 pid, fc->last_pid_recv + 1);
1425 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1426 connection_change_state (c, MESH_CONNECTION_READY);
1427 connection_reset_timeout (c, fwd);
1428 fc->last_pid_recv = pid;
1430 /* Is this message for us? */
1431 if (GMC_is_terminal (c, fwd))
1433 /* TODO signature verification */
1434 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1435 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1442 fc->last_pid_recv = pid;
1443 GMT_handle_encrypted (c->t, msg);
1444 GMC_send_ack (c, fwd);
1448 /* Message not for us: forward to next hop */
1449 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1450 ttl = ntohl (msg->ttl);
1451 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1454 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1455 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1456 GMC_send_ack (c, fwd);
1459 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1461 GMC_send_prebuilt_message (&msg->header, c, fwd);
1467 * Generic handler for mesh network encrypted traffic.
1469 * @param peer Peer identity this notification is about.
1470 * @param msg Encrypted message.
1472 * @return GNUNET_OK to keep the connection open,
1473 * GNUNET_SYSERR to close it (signal serious error)
1476 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1477 const struct GNUNET_MESH_KX *msg)
1479 struct MeshConnection *c;
1480 struct MeshPeer *neighbor;
1481 GNUNET_PEER_Id peer_id;
1487 size = ntohs (msg->header.size);
1489 sizeof (struct GNUNET_MESH_Encrypted) +
1490 sizeof (struct GNUNET_MessageHeader))
1492 GNUNET_break_op (0);
1495 type = ntohs (msg->header.type);
1496 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1497 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message from %s\n",
1498 GNUNET_MESH_DEBUG_M2S (type), GNUNET_i2s (peer));
1500 /* Check connection */
1501 c = connection_get (&msg->cid);
1504 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1505 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING connection unknown\n");
1509 /* Check if origin is as expected */
1510 neighbor = get_prev_hop (c);
1511 peer_id = GNUNET_PEER_search (peer);
1512 if (peer_id == GMP_get_short_id (neighbor))
1518 neighbor = get_next_hop (c);
1519 if (peer_id == GMP_get_short_id (neighbor))
1525 /* Unexpected peer sending traffic on a connection. */
1526 GNUNET_break_op (0);
1531 if (GMC_is_terminal (c, fwd))
1533 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1534 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1540 GMT_handle_kx (c->t, &msg[1].header);
1544 /* Message not for us: forward to next hop */
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1546 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1548 GMC_send_prebuilt_message (&msg->header, c, fwd);
1555 * Core handler for encrypted mesh network traffic (channel mgmt, data).
1557 * @param cls Closure (unused).
1558 * @param message Message received.
1559 * @param peer Peer who sent the message.
1561 * @return GNUNET_OK to keep the connection open,
1562 * GNUNET_SYSERR to close it (signal serious error)
1565 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
1566 const struct GNUNET_MessageHeader *message)
1568 return handle_mesh_encrypted (peer,
1569 (struct GNUNET_MESH_Encrypted *)message);
1574 * Core handler for key exchange traffic (ephemeral key, ping, pong).
1576 * @param cls Closure (unused).
1577 * @param message Message received.
1578 * @param peer Peer who sent the message.
1580 * @return GNUNET_OK to keep the connection open,
1581 * GNUNET_SYSERR to close it (signal serious error)
1584 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
1585 const struct GNUNET_MessageHeader *message)
1587 return handle_mesh_kx (peer,
1588 (struct GNUNET_MESH_KX *) message);
1593 * Core handler for mesh network traffic point-to-point acks.
1595 * @param cls closure
1596 * @param message message
1597 * @param peer peer identity this notification is about
1599 * @return GNUNET_OK to keep the connection open,
1600 * GNUNET_SYSERR to close it (signal serious error)
1603 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
1604 const struct GNUNET_MessageHeader *message)
1606 struct GNUNET_MESH_ACK *msg;
1607 struct MeshConnection *c;
1608 struct MeshFlowControl *fc;
1613 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1614 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK packet from %s!\n",
1616 msg = (struct GNUNET_MESH_ACK *) message;
1618 c = connection_get (&msg->cid);
1622 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
1627 /* Is this a forward or backward ACK? */
1628 id = GNUNET_PEER_search (peer);
1629 if (GMP_get_short_id (get_next_hop (c)) == id)
1631 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
1635 else if (GMP_get_short_id (get_prev_hop (c)) == id)
1637 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
1643 GNUNET_break_op (0);
1647 ack = ntohl (msg->ack);
1648 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
1649 ack, fc->last_ack_recv);
1650 if (GMC_is_pid_bigger (ack, fc->last_ack_recv))
1651 fc->last_ack_recv = ack;
1653 /* Cancel polling if the ACK is big enough. */
1654 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
1655 GMC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
1657 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
1658 GNUNET_SCHEDULER_cancel (fc->poll_task);
1659 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1660 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
1663 connection_unlock_queue (c, fwd);
1670 * Core handler for mesh network traffic point-to-point ack polls.
1672 * @param cls closure
1673 * @param message message
1674 * @param peer peer identity this notification is about
1676 * @return GNUNET_OK to keep the connection open,
1677 * GNUNET_SYSERR to close it (signal serious error)
1680 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
1681 const struct GNUNET_MessageHeader *message)
1683 struct GNUNET_MESH_Poll *msg;
1684 struct MeshConnection *c;
1685 struct MeshFlowControl *fc;
1690 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1691 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a POLL packet from %s!\n",
1694 msg = (struct GNUNET_MESH_Poll *) message;
1696 c = connection_get (&msg->cid);
1700 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
1702 GNUNET_break_op (0);
1706 /* Is this a forward or backward ACK?
1707 * Note: a poll should never be needed in a loopback case,
1708 * since there is no possiblility of packet loss there, so
1709 * this way of discerining FWD/BCK should not be a problem.
1711 id = GNUNET_PEER_search (peer);
1712 if (GMP_get_short_id (get_next_hop (c)) == id)
1714 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
1717 else if (GMP_get_short_id (get_prev_hop (c)) == id)
1719 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
1724 GNUNET_break_op (0);
1728 pid = ntohl (msg->pid);
1729 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n",
1730 pid, fc->last_pid_recv);
1731 fc->last_pid_recv = pid;
1732 fwd = fc == &c->fwd_fc;
1733 GMC_send_ack (c, fwd);
1740 * Core handler for mesh keepalives.
1742 * @param cls closure
1743 * @param message message
1744 * @param peer peer identity this notification is about
1745 * @return GNUNET_OK to keep the connection open,
1746 * GNUNET_SYSERR to close it (signal serious error)
1748 * TODO: Check who we got this from, to validate route.
1751 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
1752 const struct GNUNET_MessageHeader *message)
1754 struct GNUNET_MESH_ConnectionKeepAlive *msg;
1755 struct MeshConnection *c;
1756 struct MeshPeer *neighbor;
1759 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) message;
1760 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a keepalive packet from %s\n",
1763 c = connection_get (&msg->cid);
1766 GNUNET_STATISTICS_update (stats, "# keepalive on unknown connection", 1,
1771 fwd = GNUNET_MESSAGE_TYPE_MESH_FWD_KEEPALIVE == ntohs (message->type) ?
1772 GNUNET_YES : GNUNET_NO;
1774 /* Check if origin is as expected */
1775 neighbor = get_hop (c, fwd);
1776 if (GNUNET_PEER_search (peer) != GMP_get_short_id (neighbor))
1778 GNUNET_break_op (0);
1782 connection_change_state (c, MESH_CONNECTION_READY);
1783 connection_reset_timeout (c, fwd);
1785 if (GMC_is_terminal (c, fwd))
1788 GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
1789 GMC_send_prebuilt_message (message, c, fwd);
1796 * Send an ACK on the appropriate connection/channel, depending on
1797 * the direction and the position of the peer.
1799 * @param c Which connection to send the hop-by-hop ACK.
1800 * @param fwd Is this a fwd ACK? (will go dest->root)
1803 GMC_send_ack (struct MeshConnection *c, int fwd)
1805 unsigned int buffer;
1807 LOG (GNUNET_ERROR_TYPE_DEBUG,
1808 "GMC send %s ACK on %s\n",
1809 fwd ? "FWD" : "BCK", GMC_2s (c));
1817 /* Get available buffer space */
1818 if (GMC_is_terminal (c, fwd))
1820 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
1821 buffer = GMT_get_channels_buffer (c->t);
1825 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
1826 buffer = GMC_get_buffer (c, fwd);
1828 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
1830 /* Send available buffer space */
1831 if (GMC_is_origin (c, fwd))
1833 GNUNET_assert (NULL != c->t);
1834 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
1837 LOG (GNUNET_ERROR_TYPE_DEBUG, " really sending!\n");
1838 GMT_unchoke_channels (c->t);
1843 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
1844 send_ack (c, buffer, fwd);
1850 * Initialize the connections subsystem
1852 * @param c Configuration handle.
1855 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
1857 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1859 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
1862 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
1863 "MESH", "MAX_MSGS_QUEUE", "MISSING");
1864 GNUNET_SCHEDULER_shutdown ();
1869 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
1872 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
1873 "MESH", "MAX_CONNECTIONS", "MISSING");
1874 GNUNET_SCHEDULER_shutdown ();
1879 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
1880 &refresh_connection_time))
1882 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
1883 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
1884 GNUNET_SCHEDULER_shutdown ();
1887 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
1891 * Shut down the connections subsystem.
1896 GNUNET_CONTAINER_multihashmap_destroy (connections);
1900 struct MeshConnection *
1901 GMC_new (const struct GNUNET_HashCode *cid,
1902 struct MeshTunnel3 *t,
1903 struct MeshPeerPath *p,
1904 unsigned int own_pos)
1906 struct MeshConnection *c;
1908 c = GNUNET_new (struct MeshConnection);
1910 GNUNET_CONTAINER_multihashmap_put (connections, &c->id, c,
1911 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1912 fc_init (&c->fwd_fc);
1913 fc_init (&c->bck_fc);
1918 if (own_pos > p->length - 1)
1924 c->own_pos = own_pos;
1929 c->fwd_maintenance_task =
1930 GNUNET_SCHEDULER_add_delayed (refresh_connection_time,
1931 &connection_fwd_keepalive, c);
1933 register_neighbors (c);
1939 GMC_destroy (struct MeshConnection *c)
1944 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
1945 return; /* -> message_sent -> GMC_destroy. Don't loop. */
1948 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
1950 /* Cancel all traffic */
1951 connection_cancel_queues (c, GNUNET_YES);
1952 connection_cancel_queues (c, GNUNET_NO);
1954 /* Cancel maintainance task (keepalive/timeout) */
1955 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
1956 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
1957 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
1958 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
1960 /* Unregister from neighbors */
1961 unregister_neighbors (c);
1964 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
1966 GMT_remove_connection (c->t, c);
1968 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES))
1969 path_destroy (c->path);
1975 * Get the connection ID.
1977 * @param c Connection to get the ID from.
1979 * @return ID of the connection.
1981 const struct GNUNET_HashCode *
1982 GMC_get_id (const struct MeshConnection *c)
1989 * Get the connection path.
1991 * @param c Connection to get the path from.
1993 * @return path used by the connection.
1995 const struct MeshPeerPath *
1996 GMC_get_path (const struct MeshConnection *c)
2003 * Get the connection state.
2005 * @param c Connection to get the state from.
2007 * @return state of the connection.
2009 enum MeshConnectionState
2010 GMC_get_state (const struct MeshConnection *c)
2016 * Get the connection tunnel.
2018 * @param c Connection to get the tunnel from.
2020 * @return tunnel of the connection.
2022 struct MeshTunnel3 *
2023 GMC_get_tunnel (const struct MeshConnection *c)
2030 * Get free buffer space in a connection.
2032 * @param c Connection.
2033 * @param fwd Is query about FWD traffic?
2035 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2038 GMC_get_buffer (struct MeshConnection *c, int fwd)
2040 struct MeshFlowControl *fc;
2042 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2044 return (fc->queue_max - fc->queue_n);
2048 * Get how many messages have we allowed to send to us from a direction.
2050 * @param c Connection.
2051 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2053 * @return last_ack_sent - last_pid_recv
2056 GMC_get_allowed (struct MeshConnection *c, int fwd)
2058 struct MeshFlowControl *fc;
2060 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2061 if (GMC_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2065 return (fc->last_ack_sent - fc->last_pid_recv);
2069 * Get messages queued in a connection.
2071 * @param c Connection.
2072 * @param fwd Is query about FWD traffic?
2074 * @return Number of messages queued.
2077 GMC_get_qn (struct MeshConnection *c, int fwd)
2079 struct MeshFlowControl *fc;
2081 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2088 * Allow the connection to advertise a buffer of the given size.
2090 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2091 * allowing up to last_pid_recv + buffer.
2093 * @param c Connection.
2094 * @param buffer How many more messages the connection can accept.
2095 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2098 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2100 send_ack (c, buffer, fwd);
2105 * Notify other peers on a connection of a broken link. Mark connections
2106 * to destroy after all traffic has been sent.
2108 * @param c Connection on which there has been a disconnection.
2109 * @param peer Peer that disconnected.
2112 GMC_notify_broken (struct MeshConnection *c,
2113 struct MeshPeer *peer)
2117 fwd = peer == get_prev_hop (c);
2119 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2121 /* Local shutdown, no one to notify about this. */
2125 if (GNUNET_NO == c->destroy)
2126 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2128 /* Connection will have at least one pending message
2129 * (the one we just scheduled), so no point in checking whether to
2130 * destroy immediately. */
2131 c->destroy = GNUNET_YES;
2134 * Cancel all queues, if no message is left, connection will be destroyed.
2136 connection_cancel_queues (c, !fwd);
2143 * Is this peer the first one on the connection?
2145 * @param c Connection.
2146 * @param fwd Is this about fwd traffic?
2148 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2151 GMC_is_origin (struct MeshConnection *c, int fwd)
2153 if (!fwd && c->path->length - 1 == c->own_pos )
2155 if (fwd && 0 == c->own_pos)
2162 * Is this peer the last one on the connection?
2164 * @param c Connection.
2165 * @param fwd Is this about fwd traffic?
2166 * Note that the ROOT is the terminal for BCK traffic!
2168 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2171 GMC_is_terminal (struct MeshConnection *c, int fwd)
2173 return GMC_is_origin (c, !fwd);
2178 * See if we are allowed to send by the next hop in the given direction.
2180 * @param c Connection.
2181 * @param fwd Is this about fwd traffic?
2183 * @return #GNUNET_YES in case it's OK to send.
2186 GMC_is_sendable (struct MeshConnection *c, int fwd)
2188 struct MeshFlowControl *fc;
2190 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2191 if (GMC_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2197 * Sends an already built message on a connection, properly registering
2198 * all used resources.
2200 * @param message Message to send. Function makes a copy of it.
2201 * If message is not hop-by-hop, decrements TTL of copy.
2202 * @param c Connection on which this message is transmitted.
2203 * @param fwd Is this a fwd message?
2206 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2207 struct MeshConnection *c,
2210 struct MeshFlowControl *fc;
2216 size = ntohs (message->size);
2217 data = GNUNET_malloc (size);
2218 memcpy (data, message, size);
2219 type = ntohs (message->type);
2220 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send %s (%u) on connection %s\n",
2221 GNUNET_MESH_DEBUG_M2S (type), size, GMC_2s (c));
2223 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2224 droppable = GNUNET_YES;
2227 struct GNUNET_MESH_Encrypted *emsg;
2228 struct GNUNET_MESH_KX *kmsg;
2229 struct GNUNET_MESH_ACK *amsg;
2230 struct GNUNET_MESH_Poll *pmsg;
2231 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2232 struct GNUNET_MESH_ConnectionBroken *bmsg;
2235 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2236 emsg = (struct GNUNET_MESH_Encrypted *) data;
2237 ttl = ntohl (emsg->ttl);
2240 GNUNET_break_op (0);
2244 emsg->ttl = htonl (ttl - 1);
2245 emsg->pid = htonl (fwd ? c->fwd_fc.next_pid++ : c->bck_fc.next_pid++);
2246 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2248 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2249 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid %u\n", fc->last_pid_sent);
2250 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", fc->last_ack_recv);
2251 if (GMC_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2253 GMC_start_poll (c, fwd);
2257 case GNUNET_MESSAGE_TYPE_MESH_KX:
2258 kmsg = (struct GNUNET_MESH_KX *) data;
2262 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2263 amsg = (struct GNUNET_MESH_ACK *) data;
2265 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2266 droppable = GNUNET_NO;
2269 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2270 pmsg = (struct GNUNET_MESH_Poll *) data;
2272 pmsg->pid = htonl (fwd ? c->fwd_fc.last_pid_sent : c->bck_fc.last_pid_sent);
2273 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2274 droppable = GNUNET_NO;
2277 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2278 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2283 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2284 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2289 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2290 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2297 if (fc->queue_n > fc->queue_max && droppable)
2299 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2302 LOG (GNUNET_ERROR_TYPE_DEBUG,
2303 "queue full: %u/%u\n",
2304 fc->queue_n, fc->queue_max);
2305 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2307 return; /* Drop this message */
2310 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2311 c->pending_messages++;
2313 GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2314 &message_sent, NULL);
2319 * Sends a CREATE CONNECTION message for a path to a peer.
2320 * Changes the connection and tunnel states if necessary.
2322 * @param connection Connection to create.
2325 GMC_send_create (struct MeshConnection *connection)
2327 enum MeshTunnel3State state;
2330 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2331 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2332 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection create\n");
2333 GMP_queue_add (get_next_hop (connection), NULL,
2334 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2335 size, connection, GNUNET_YES, &message_sent, NULL);
2336 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2337 connection, connection->pending_messages);
2338 connection->pending_messages++;
2339 state = GMT_get_state (connection->t);
2340 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2341 GMT_change_state (connection->t, MESH_TUNNEL3_WAITING);
2342 if (MESH_CONNECTION_NEW == connection->state)
2343 connection_change_state (connection, MESH_CONNECTION_SENT);
2348 * Send a message to all peers in this connection that the connection
2349 * is no longer valid.
2351 * If some peer should not receive the message, it should be zero'ed out
2352 * before calling this function.
2354 * @param c The connection whose peers to notify.
2357 GMC_send_destroy (struct MeshConnection *c)
2359 struct GNUNET_MESH_ConnectionDestroy msg;
2361 if (GNUNET_YES == c->destroy)
2364 msg.header.size = htons (sizeof (msg));
2365 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
2367 LOG (GNUNET_ERROR_TYPE_DEBUG,
2368 " sending connection destroy for connection %s\n",
2371 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
2372 GMC_send_prebuilt_message (&msg.header, c, GNUNET_YES);
2373 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
2374 GMC_send_prebuilt_message (&msg.header, c, GNUNET_NO);
2375 c->destroy = GNUNET_YES;
2380 * @brief Start a polling timer for the connection.
2382 * When a neighbor does not accept more traffic on the connection it could be
2383 * caused by a simple congestion or by a lost ACK. Polling enables to check
2384 * for the lastest ACK status for a connection.
2386 * @param c Connection.
2387 * @param fwd Should we poll in the FWD direction?
2390 GMC_start_poll (struct MeshConnection *c, int fwd)
2392 struct MeshFlowControl *fc;
2394 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2395 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
2399 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
2406 * @brief Stop polling a connection for ACKs.
2408 * Once we have enough ACKs for future traffic, polls are no longer necessary.
2410 * @param c Connection.
2411 * @param fwd Should we stop the poll in the FWD direction?
2414 GMC_stop_poll (struct MeshConnection *c, int fwd)
2416 struct MeshFlowControl *fc;
2418 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2419 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
2421 GNUNET_SCHEDULER_cancel (fc->poll_task);
2422 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2427 * Get a (static) string for a connection.
2429 * @param c Connection.
2432 GMC_2s (struct MeshConnection *c)
2436 static char buf[128];
2438 sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
2441 return GNUNET_h2s (&c->id);