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 * Pending message count.
207 int pending_messages;
210 * Destroy flag: if true, destroy on last message.
216 * Handle for messages queued but not yet sent.
218 struct MeshConnectionQueue
221 * Peer queue handle, to cancel if necessary.
223 struct MeshPeerQueue *q;
226 * Was this a forced message? (Do not account for it)
231 * Continuation to call once sent.
236 * Closure for @c cont.
241 /******************************************************************************/
242 /******************************* GLOBALS ***********************************/
243 /******************************************************************************/
246 * Global handle to the statistics service.
248 extern struct GNUNET_STATISTICS_Handle *stats;
251 * Local peer own ID (memory efficient handle).
253 extern GNUNET_PEER_Id myid;
256 * Local peer own ID (full value).
258 extern struct GNUNET_PeerIdentity my_full_id;
261 * Connections known, indexed by cid (MeshConnection).
263 static struct GNUNET_CONTAINER_MultiHashMap *connections;
266 * How many connections are we willing to maintain.
267 * Local connections are always allowed, even if there are more connections than max.
269 static unsigned long long max_connections;
272 * How many messages *in total* are we willing to queue, divide by number of
273 * connections to get connection queue size.
275 static unsigned long long max_msgs_queue;
278 * How often to send path keepalives. Paths timeout after 4 missed.
280 static struct GNUNET_TIME_Relative refresh_connection_time;
283 * How often to send path create / ACKs.
285 static struct GNUNET_TIME_Relative create_connection_time;
288 /******************************************************************************/
289 /******************************** STATIC ***********************************/
290 /******************************************************************************/
292 #if 0 // avoid compiler warning for unused static function
294 fc_debug (struct MeshFlowControl *fc)
296 LOG (GNUNET_ERROR_TYPE_DEBUG, " IN: %u/%u\n",
297 fc->last_pid_recv, fc->last_ack_sent);
298 LOG (GNUNET_ERROR_TYPE_DEBUG, " OUT: %u/%u\n",
299 fc->last_pid_sent, fc->last_ack_recv);
300 LOG (GNUNET_ERROR_TYPE_DEBUG, " QUEUE: %u/%u\n",
301 fc->queue_n, fc->queue_max);
305 connection_debug (struct MeshConnection *c)
309 LOG (GNUNET_ERROR_TYPE_DEBUG, "*** DEBUG NULL CONNECTION ***\n");
312 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s:%X\n",
313 peer2s (c->t->peer), GMC_2s (c));
314 LOG (GNUNET_ERROR_TYPE_DEBUG, " state: %u, pending msgs: %u\n",
315 c->state, c->pending_messages);
316 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
317 fc_debug (&c->fwd_fc);
318 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
319 fc_debug (&c->bck_fc);
324 * Get string description for tunnel state.
326 * @param s Tunnel state.
328 * @return String representation.
331 GMC_state2s (enum MeshConnectionState s)
335 case MESH_CONNECTION_NEW:
336 return "MESH_CONNECTION_NEW";
337 case MESH_CONNECTION_SENT:
338 return "MESH_CONNECTION_SENT";
339 case MESH_CONNECTION_ACK:
340 return "MESH_CONNECTION_ACK";
341 case MESH_CONNECTION_READY:
342 return "MESH_CONNECTION_READY";
343 case MESH_CONNECTION_DESTROYED:
344 return "MESH_CONNECTION_DESTROYED";
346 return "MESH_CONNECTION_STATE_ERROR";
352 * Initialize a Flow Control structure to the initial state.
354 * @param fc Flow Control structure to initialize.
357 fc_init (struct MeshFlowControl *fc)
360 fc->last_pid_sent = (uint32_t) -1; /* Next (expected) = 0 */
361 fc->last_pid_recv = (uint32_t) -1;
362 fc->last_ack_sent = (uint32_t) 0;
363 fc->last_ack_recv = (uint32_t) 0;
364 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
365 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
367 fc->queue_max = (max_msgs_queue / max_connections) + 1;
374 * @param cid Connection ID.
376 static struct MeshConnection *
377 connection_get (const struct GNUNET_HashCode *cid)
379 return GNUNET_CONTAINER_multihashmap_get (connections, cid);
384 connection_change_state (struct MeshConnection* c,
385 enum MeshConnectionState state)
387 LOG (GNUNET_ERROR_TYPE_DEBUG,
388 "Connection %s state was %s\n",
389 GMC_2s (c), GMC_state2s (c->state));
390 if (MESH_CONNECTION_DESTROYED == c->state)
392 LOG (GNUNET_ERROR_TYPE_DEBUG, "state not changing anymore\n");
395 LOG (GNUNET_ERROR_TYPE_DEBUG,
396 "Connection %s state is now %s\n",
397 GMC_2s (c), GMC_state2s (state));
403 * Callback called when a queued ACK message is sent.
405 * @param cls Closure (FC).
406 * @param c Connection this message was on.
407 * @param q Queue handler this call invalidates.
408 * @param type Type of message sent.
409 * @param fwd Was this a FWD going message?
410 * @param size Size of the message.
414 struct MeshConnection *c,
415 struct MeshConnectionQueue *q,
416 uint16_t type, int fwd, size_t size)
418 struct MeshFlowControl *fc = cls;
425 * Send an ACK on the connection, informing the predecessor about
426 * the available buffer space. Should not be called in case the peer
427 * is origin (no predecessor) in the @c fwd direction.
429 * Note that for fwd ack, the FWD mean forward *traffic* (root->dest),
430 * the ACK itself goes "back" (dest->root).
432 * @param c Connection on which to send the ACK.
433 * @param buffer How much space free to advertise?
434 * @param fwd Is this FWD ACK? (Going dest -> root)
435 * @param force Don't optimize out.
438 send_ack (struct MeshConnection *c, unsigned int buffer, int fwd, int force)
440 struct MeshFlowControl *next_fc;
441 struct MeshFlowControl *prev_fc;
442 struct GNUNET_MESH_ACK msg;
446 /* If origin, there is no connection to send ACKs. Wrong function! */
447 if (GMC_is_origin (c, fwd))
453 next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
454 prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
456 LOG (GNUNET_ERROR_TYPE_DEBUG,
457 "connection send %s ack on %s\n",
458 GM_f2s (fwd), GMC_2s (c));
460 /* Check if we need to transmit the ACK. */
461 delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
462 if (3 < delta && buffer < delta && GNUNET_NO == force)
464 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
465 LOG (GNUNET_ERROR_TYPE_DEBUG,
466 " last pid recv: %u, last ack sent: %u\n",
467 prev_fc->last_pid_recv, prev_fc->last_ack_sent);
471 /* Ok, ACK might be necessary, what PID to ACK? */
472 ack = prev_fc->last_pid_recv + buffer;
473 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
474 LOG (GNUNET_ERROR_TYPE_DEBUG,
475 " last pid %u, last ack %u, qmax %u, q %u\n",
476 prev_fc->last_pid_recv, prev_fc->last_ack_sent,
477 next_fc->queue_max, next_fc->queue_n);
478 if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
480 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
484 /* Check if message is already in queue */
485 if (NULL != prev_fc->ack_msg)
487 if (GM_is_pid_bigger (ack, prev_fc->last_ack_sent))
489 LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
490 GMC_cancel (prev_fc->ack_msg);
491 /* GMC_cancel triggers ack_sent(), which clears fc->ack_msg */
495 LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
500 prev_fc->last_ack_sent = ack;
502 /* Build ACK message and send on connection */
503 msg.header.size = htons (sizeof (msg));
504 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
505 msg.ack = htonl (ack);
508 prev_fc->ack_msg = GMC_send_prebuilt_message (&msg.header, c,
515 * Callback called when a queued message is sent.
517 * Calculates the average time and connection packet tracking.
519 * @param cls Closure (ConnectionQueue Handle).
520 * @param c Connection this message was on.
521 * @param type Type of message sent.
522 * @param fwd Was this a FWD going message?
523 * @param size Size of the message.
524 * @param wait Time spent waiting for core (only the time for THIS message)
527 message_sent (void *cls,
528 struct MeshConnection *c, uint16_t type,
529 int fwd, size_t size,
530 struct GNUNET_TIME_Relative wait)
532 struct MeshConnectionPerformance *p;
533 struct MeshFlowControl *fc;
534 struct MeshConnectionQueue *q = cls;
538 fc = fwd ? &c->fwd_fc : &c->bck_fc;
539 LOG (GNUNET_ERROR_TYPE_DEBUG,
543 LOG (GNUNET_ERROR_TYPE_DEBUG, "! C_P- %p %u\n", c, c->pending_messages);
549 LOG (GNUNET_ERROR_TYPE_DEBUG, "! calling cont\n");
550 q->cont (q->cont_cls, c, q, type, fwd, size);
554 else if (type == GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED)
556 /* If NULL == q and ENCRYPTED == type, message must have been ch_mngmnt */
563 c->pending_messages--;
564 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
566 LOG (GNUNET_ERROR_TYPE_DEBUG, "! destroying connection!\n");
570 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
573 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
575 LOG (GNUNET_ERROR_TYPE_DEBUG, "! Q_N- %p %u\n", fc, fc->queue_n);
576 if (GNUNET_NO == forced)
579 LOG (GNUNET_ERROR_TYPE_DEBUG,
580 "! accounting pid %u\n",
585 LOG (GNUNET_ERROR_TYPE_DEBUG,
586 "! forced, Q_N not accounting pid %u\n",
589 GMC_send_ack (c, fwd, GNUNET_NO);
592 case GNUNET_MESSAGE_TYPE_MESH_POLL:
596 case GNUNET_MESSAGE_TYPE_MESH_ACK:
603 LOG (GNUNET_ERROR_TYPE_DEBUG, "! message sent!\n");
606 return; /* Only endpoints are interested in timing. */
609 usecsperbyte = ((double) wait.rel_value_us) / size;
610 if (p->size == AVG_MSGS)
612 /* Array is full. Substract oldest value, add new one and store. */
613 p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
614 p->usecsperbyte[p->idx] = usecsperbyte;
615 p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
619 /* Array not yet full. Add current value to avg and store. */
620 p->usecsperbyte[p->idx] = usecsperbyte;
622 p->avg += p->usecsperbyte[p->idx];
626 p->idx = (p->idx + 1) % AVG_MSGS;
631 * Get the previous hop in a connection
633 * @param c Connection.
635 * @return Previous peer in the connection.
637 static struct MeshPeer *
638 get_prev_hop (const struct MeshConnection *c)
642 if (0 == c->own_pos || c->path->length < 2)
643 id = c->path->peers[0];
645 id = c->path->peers[c->own_pos - 1];
647 return GMP_get_short (id);
652 * Get the next hop in a connection
654 * @param c Connection.
656 * @return Next peer in the connection.
658 static struct MeshPeer *
659 get_next_hop (const struct MeshConnection *c)
663 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
664 id = c->path->peers[c->path->length - 1];
666 id = c->path->peers[c->own_pos + 1];
668 return GMP_get_short (id);
673 * Get the hop in a connection.
675 * @param c Connection.
676 * @param fwd Next hop?
678 * @return Next peer in the connection.
680 static struct MeshPeer *
681 get_hop (struct MeshConnection *c, int fwd)
684 return get_next_hop (c);
685 return get_prev_hop (c);
690 * Is traffic coming from this sender 'FWD' traffic?
692 * @param c Connection to check.
693 * @param sender Peer identity of neighbor.
695 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
696 * the traffic is 'FWD'.
697 * #GNUNET_NO for BCK.
698 * #GNUNET_SYSERR for errors.
701 is_fwd (const struct MeshConnection *c,
702 const struct GNUNET_PeerIdentity *sender)
706 id = GNUNET_PEER_search (sender);
707 if (GMP_get_short_id (get_prev_hop (c)) == id)
710 if (GMP_get_short_id (get_next_hop (c)) == id)
714 return GNUNET_SYSERR;
719 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
720 * or a first CONNECTION_ACK directed to us.
722 * @param connection Connection to confirm.
723 * @param fwd Should we send it FWD? (root->dest)
724 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
727 send_connection_ack (struct MeshConnection *connection, int fwd)
729 struct MeshTunnel3 *t;
732 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection %s ACK\n",
734 GMP_queue_add (get_hop (connection, fwd), NULL,
735 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
736 sizeof (struct GNUNET_MESH_ConnectionACK),
737 connection, fwd, &message_sent, NULL);
738 connection->pending_messages++;
739 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
740 GMT_change_cstate (t, MESH_TUNNEL3_WAITING);
741 if (MESH_CONNECTION_READY != connection->state)
742 connection_change_state (connection, MESH_CONNECTION_SENT);
747 * Send a notification that a connection is broken.
749 * @param c Connection that is broken.
750 * @param id1 Peer that has disconnected.
751 * @param id2 Peer that has disconnected.
752 * @param fwd Direction towards which to send it.
755 send_broken (struct MeshConnection *c,
756 const struct GNUNET_PeerIdentity *id1,
757 const struct GNUNET_PeerIdentity *id2,
760 struct GNUNET_MESH_ConnectionBroken msg;
762 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
763 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
767 GMC_send_prebuilt_message (&msg.header, c, fwd, GNUNET_YES, NULL, NULL);
772 * Send keepalive packets for a connection.
774 * @param c Connection to keep alive..
775 * @param fwd Is this a FWD keepalive? (owner -> dest).
778 connection_keepalive (struct MeshConnection *c, int fwd)
780 struct GNUNET_MESH_ConnectionKeepAlive *msg;
781 size_t size = sizeof (struct GNUNET_MESH_ConnectionKeepAlive);
784 LOG (GNUNET_ERROR_TYPE_DEBUG,
785 "sending %s keepalive for connection %s]\n",
786 GM_f2s (fwd), GMC_2s (c));
788 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) cbuf;
789 msg->header.size = htons (size);
790 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE);
792 msg->reserved = htonl (0);
794 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_YES, NULL, NULL);
799 * Send CONNECTION_{CREATE/ACK} packets for a connection.
801 * @param c Connection for which to send the message.
802 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
805 connection_recreate (struct MeshConnection *c, int fwd)
807 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
811 send_connection_ack (c, GNUNET_NO);
816 * Generic connection timer management.
817 * Depending on the role of the peer in the connection will send the
818 * appropriate message (build or keepalive)
820 * @param c Conncetion to maintain.
824 connection_maintain (struct MeshConnection *c, int fwd)
826 if (GNUNET_NO != c->destroy)
829 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (c->t))
831 /* TODO DHT GET with RO_BART */
836 case MESH_CONNECTION_NEW:
839 case MESH_CONNECTION_SENT:
840 connection_recreate (c, fwd);
842 case MESH_CONNECTION_READY:
843 connection_keepalive (c, fwd);
852 connection_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
854 struct MeshConnection *c = cls;
855 struct GNUNET_TIME_Relative delay;
857 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
858 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
861 connection_maintain (c, GNUNET_YES);
862 delay = c->state == MESH_CONNECTION_READY ?
863 refresh_connection_time : create_connection_time;
864 c->fwd_maintenance_task = GNUNET_SCHEDULER_add_delayed (delay,
865 &connection_fwd_keepalive,
871 connection_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
873 struct MeshConnection *c = cls;
874 struct GNUNET_TIME_Relative delay;
876 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
877 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
880 connection_maintain (c, GNUNET_NO);
881 delay = c->state == MESH_CONNECTION_READY ?
882 refresh_connection_time : create_connection_time;
883 c->bck_maintenance_task = GNUNET_SCHEDULER_add_delayed (delay,
884 &connection_bck_keepalive,
890 * @brief Re-initiate traffic on this connection if necessary.
892 * Check if there is traffic queued towards this peer
893 * and the core transmit handle is NULL (traffic was stalled).
894 * If so, call core tmt rdy.
896 * @param c Connection on which initiate traffic.
897 * @param fwd Is this about fwd traffic?
900 connection_unlock_queue (struct MeshConnection *c, int fwd)
902 struct MeshPeer *peer;
904 LOG (GNUNET_ERROR_TYPE_DEBUG,
905 "connection_unlock_queue %s on %s\n",
906 GM_f2s (fwd), GMC_2s (c));
908 if (GMC_is_terminal (c, fwd))
910 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
914 peer = get_hop (c, fwd);
915 GMP_queue_unlock (peer, c);
920 * Cancel all transmissions that belong to a certain connection.
922 * If the connection is scheduled for destruction and no more messages are left,
923 * the connection will be destroyed by the continuation call.
925 * @param c Connection which to cancel. Might be destroyed during this call.
926 * @param fwd Cancel fwd traffic?
929 connection_cancel_queues (struct MeshConnection *c, int fwd)
931 struct MeshFlowControl *fc;
932 struct MeshPeer *peer;
934 LOG (GNUNET_ERROR_TYPE_DEBUG,
935 " *** Cancel %s queues for connection %s\n",
936 GM_f2s (fwd), GMC_2s (c));
943 fc = fwd ? &c->fwd_fc : &c->bck_fc;
944 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
946 GNUNET_SCHEDULER_cancel (fc->poll_task);
947 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
948 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
950 peer = get_hop (c, fwd);
951 GMP_queue_cancel (peer, c);
956 * Function called if a connection has been stalled for a while,
957 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
959 * @param cls Closure (poll ctx).
960 * @param tc TaskContext.
963 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
967 * Callback called when a queued POLL message is sent.
969 * @param cls Closure (FC).
970 * @param c Connection this message was on.
971 * @param q Queue handler this call invalidates.
972 * @param type Type of message sent.
973 * @param fwd Was this a FWD going message?
974 * @param size Size of the message.
977 poll_sent (void *cls,
978 struct MeshConnection *c,
979 struct MeshConnectionQueue *q,
980 uint16_t type, int fwd, size_t size)
982 struct MeshFlowControl *fc = cls;
986 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
989 LOG (GNUNET_ERROR_TYPE_DEBUG,
990 " *** POLL sent for , scheduling new one!\n");
992 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
993 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
994 &connection_poll, fc);
995 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1000 * Function called if a connection has been stalled for a while,
1001 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1003 * @param cls Closure (poll ctx).
1004 * @param tc TaskContext.
1007 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1009 struct MeshFlowControl *fc = cls;
1010 struct GNUNET_MESH_Poll msg;
1011 struct MeshConnection *c;
1013 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1014 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1020 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
1021 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
1022 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
1023 fc == &c->fwd_fc ? "FWD" : "BCK");
1025 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
1026 msg.header.size = htons (sizeof (msg));
1027 msg.pid = htonl (fc->last_pid_sent);
1028 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1029 fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c,
1030 fc == &c->fwd_fc, GNUNET_YES,
1036 * Timeout function due to lack of keepalive/traffic from the owner.
1037 * Destroys connection if called.
1039 * @param cls Closure (connection to destroy).
1040 * @param tc TaskContext.
1043 connection_fwd_timeout (void *cls,
1044 const struct GNUNET_SCHEDULER_TaskContext *tc)
1046 struct MeshConnection *c = cls;
1048 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1049 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1052 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1054 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1065 * Timeout function due to lack of keepalive/traffic from the destination.
1066 * Destroys connection if called.
1068 * @param cls Closure (connection to destroy).
1069 * @param tc TaskContext
1072 connection_bck_timeout (void *cls,
1073 const struct GNUNET_SCHEDULER_TaskContext *tc)
1075 struct MeshConnection *c = cls;
1077 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1078 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1081 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1084 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1095 * Resets the connection timeout task, some other message has done the
1097 * - For the first peer on the direction this means to send
1098 * a keepalive or a path confirmation message (either create or ACK).
1099 * - For all other peers, this means to destroy the connection,
1100 * due to lack of activity.
1101 * Starts the timeout if no timeout was running (connection just created).
1103 * @param c Connection whose timeout to reset.
1104 * @param fwd Is this forward?
1106 * TODO use heap to improve efficiency of scheduler.
1109 connection_reset_timeout (struct MeshConnection *c, int fwd)
1111 GNUNET_SCHEDULER_TaskIdentifier *ti;
1112 GNUNET_SCHEDULER_Task f;
1114 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1116 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GM_f2s (fwd));
1118 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1119 GNUNET_SCHEDULER_cancel (*ti);
1121 if (GMC_is_origin (c, fwd)) /* Startpoint */
1123 f = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
1124 *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
1126 else /* Relay, endpoint. */
1128 struct GNUNET_TIME_Relative delay;
1130 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1131 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1132 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1138 * Add the connection to the list of both neighbors.
1140 * @param c Connection.
1142 * @return #GNUNET_OK if everything went fine
1143 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1146 register_neighbors (struct MeshConnection *c)
1148 struct MeshPeer *next_peer;
1149 struct MeshPeer *prev_peer;
1151 next_peer = get_next_hop (c);
1152 prev_peer = get_prev_hop (c);
1154 if (GNUNET_NO == GMP_is_neighbor (next_peer)
1155 || GNUNET_NO == GMP_is_neighbor (prev_peer))
1157 if (GMC_is_origin (c, GNUNET_YES))
1158 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1159 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1161 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1162 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1163 GMP_2s (prev_peer), GMP_is_neighbor (prev_peer));
1164 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1165 GMP_2s (next_peer), GMP_is_neighbor (next_peer));
1166 return GNUNET_SYSERR;
1169 GMP_add_connection (next_peer, c);
1170 GMP_add_connection (prev_peer, c);
1177 * Remove the connection from the list of both neighbors.
1179 * @param c Connection.
1182 unregister_neighbors (struct MeshConnection *c)
1184 struct MeshPeer *peer;
1186 peer = get_next_hop (c);
1187 if (GNUNET_OK != GMP_remove_connection (peer, c))
1189 GNUNET_break (MESH_CONNECTION_NEW == c->state/*
1190 || MESH_CONNECTION_DESTROYED == c->state*/);
1191 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1192 if (NULL != c->t) GMT_debug (c->t);
1195 peer = get_prev_hop (c);
1196 if (GNUNET_OK != GMP_remove_connection (peer, c))
1198 GNUNET_break (MESH_CONNECTION_NEW == c->state/*
1199 || MESH_CONNECTION_DESTROYED == c->state*/);
1200 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1201 if (NULL != c->t) GMT_debug (c->t);
1207 * Bind the connection to the peer and the tunnel to that peer.
1209 * If the peer has no tunnel, create one. Update tunnel and connection
1210 * data structres to reflect new status.
1212 * @param c Connection.
1216 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1218 GMP_add_tunnel (peer);
1219 c->t = GMP_get_tunnel (peer);
1220 GMT_add_connection (c->t, c);
1223 /******************************************************************************/
1224 /******************************** API ***********************************/
1225 /******************************************************************************/
1228 * Core handler for connection creation.
1230 * @param cls Closure (unused).
1231 * @param peer Sender (neighbor).
1232 * @param message Message.
1234 * @return GNUNET_OK to keep the connection open,
1235 * GNUNET_SYSERR to close it (signal serious error)
1238 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1239 const struct GNUNET_MessageHeader *message)
1241 struct GNUNET_MESH_ConnectionCreate *msg;
1242 struct GNUNET_PeerIdentity *id;
1243 struct GNUNET_HashCode *cid;
1244 struct MeshPeerPath *path;
1245 struct MeshPeer *dest_peer;
1246 struct MeshPeer *orig_peer;
1247 struct MeshConnection *c;
1248 unsigned int own_pos;
1252 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1253 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection create msg\n");
1256 size = ntohs (message->size);
1257 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1259 GNUNET_break_op (0);
1263 /* Calculate hops */
1264 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1265 if (size % sizeof (struct GNUNET_PeerIdentity))
1267 GNUNET_break_op (0);
1270 size /= sizeof (struct GNUNET_PeerIdentity);
1273 GNUNET_break_op (0);
1276 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1278 /* Get parameters */
1279 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1281 id = (struct GNUNET_PeerIdentity *) &msg[1];
1282 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s (%s->).\n",
1283 GNUNET_h2s (cid), GNUNET_i2s (id));
1285 /* Create connection */
1286 c = connection_get (cid);
1290 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1291 path = path_new (size);
1293 for (i = 0; i < size; i++)
1295 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... adding %s\n",
1296 GNUNET_i2s (&id[i]));
1297 path->peers[i] = GNUNET_PEER_intern (&id[i]);
1298 if (path->peers[i] == myid)
1301 if (own_pos == 0 && path->peers[own_pos] != myid)
1303 /* create path: self not found in path through self */
1304 GNUNET_break_op (0);
1305 path_destroy (path);
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1309 GMP_add_path_to_all (path, GNUNET_NO);
1310 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1311 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1314 path_destroy (path);
1317 connection_reset_timeout (c, GNUNET_YES);
1321 path = path_duplicate (c->path);
1323 if (MESH_CONNECTION_NEW == c->state)
1324 connection_change_state (c, MESH_CONNECTION_SENT);
1326 /* Remember peers */
1327 dest_peer = GMP_get (&id[size - 1]);
1328 orig_peer = GMP_get (&id[0]);
1330 /* Is it a connection to us? */
1331 if (c->own_pos == size - 1)
1333 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1334 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1336 add_to_peer (c, orig_peer);
1337 if (MESH_TUNNEL3_NEW == GMT_get_cstate (c->t))
1338 GMT_change_cstate (c->t, MESH_TUNNEL3_WAITING);
1340 send_connection_ack (c, GNUNET_NO);
1341 if (MESH_CONNECTION_SENT == c->state)
1342 connection_change_state (c, MESH_CONNECTION_ACK);
1344 /* Keep tunnel alive in direction dest->owner*/
1345 if (GNUNET_SCHEDULER_NO_TASK == c->bck_maintenance_task)
1347 c->bck_maintenance_task =
1348 GNUNET_SCHEDULER_add_delayed (create_connection_time,
1349 &connection_bck_keepalive, c);
1354 /* It's for somebody else! Retransmit. */
1355 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1356 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1357 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1358 GMC_send_prebuilt_message (message, c, GNUNET_YES, GNUNET_YES,
1361 path_destroy (path);
1367 * Core handler for path confirmations.
1369 * @param cls closure
1370 * @param message message
1371 * @param peer peer identity this notification is about
1373 * @return GNUNET_OK to keep the connection open,
1374 * GNUNET_SYSERR to close it (signal serious error)
1377 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1378 const struct GNUNET_MessageHeader *message)
1380 struct GNUNET_MESH_ConnectionACK *msg;
1381 struct MeshConnection *c;
1382 struct MeshPeerPath *p;
1383 struct MeshPeer *pi;
1384 enum MeshConnectionState oldstate;
1387 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1388 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection ACK msg\n");
1389 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1390 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n",
1391 GNUNET_h2s (&msg->cid));
1392 c = connection_get (&msg->cid);
1395 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1397 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1401 if (GNUNET_NO != c->destroy)
1403 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1407 oldstate = c->state;
1408 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1409 pi = GMP_get (peer);
1410 if (get_next_hop (c) == pi)
1412 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1414 if (MESH_CONNECTION_SENT == oldstate)
1415 connection_change_state (c, MESH_CONNECTION_ACK);
1417 else if (get_prev_hop (c) == pi)
1419 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1421 connection_change_state (c, MESH_CONNECTION_READY);
1425 GNUNET_break_op (0);
1429 connection_reset_timeout (c, fwd);
1431 /* Add path to peers? */
1435 GMP_add_path_to_all (p, GNUNET_YES);
1442 /* Message for us as creator? */
1443 if (GMC_is_origin (c, GNUNET_YES))
1445 if (GNUNET_NO != fwd)
1447 GNUNET_break_op (0);
1450 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1452 /* If just created, cancel the short timeout and start a long one */
1453 if (MESH_CONNECTION_SENT == oldstate)
1454 connection_reset_timeout (c, GNUNET_YES);
1456 /* Change connection state */
1457 connection_change_state (c, MESH_CONNECTION_READY);
1458 send_connection_ack (c, GNUNET_YES);
1460 /* Change tunnel state, trigger KX */
1461 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1462 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1467 /* Message for us as destination? */
1468 if (GMC_is_terminal (c, GNUNET_YES))
1470 if (GNUNET_YES != fwd)
1472 GNUNET_break_op (0);
1475 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1477 /* If just created, cancel the short timeout and start a long one */
1478 if (MESH_CONNECTION_ACK == oldstate)
1479 connection_reset_timeout (c, GNUNET_NO);
1481 /* Change tunnel state */
1482 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1483 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1488 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1489 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1495 * Core handler for notifications of broken paths
1497 * @param cls Closure (unused).
1498 * @param id Peer identity of sending neighbor.
1499 * @param message Message.
1501 * @return GNUNET_OK to keep the connection open,
1502 * GNUNET_SYSERR to close it (signal serious error)
1505 GMC_handle_broken (void* cls,
1506 const struct GNUNET_PeerIdentity* id,
1507 const struct GNUNET_MessageHeader* message)
1509 struct GNUNET_MESH_ConnectionBroken *msg;
1510 struct MeshConnection *c;
1513 LOG (GNUNET_ERROR_TYPE_DEBUG,
1514 "Received a CONNECTION BROKEN msg from %s\n", GNUNET_i2s (id));
1515 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1516 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1517 GNUNET_i2s (&msg->peer1));
1518 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1519 GNUNET_i2s (&msg->peer2));
1520 c = connection_get (&msg->cid);
1523 GNUNET_break_op (0);
1527 fwd = is_fwd (c, id);
1528 if (GMC_is_terminal (c, fwd))
1530 if (0 < c->pending_messages)
1531 c->destroy = GNUNET_YES;
1537 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1538 c->destroy = GNUNET_YES;
1539 connection_cancel_queues (c, !fwd);
1548 * Core handler for tunnel destruction
1550 * @param cls Closure (unused).
1551 * @param peer Peer identity of sending neighbor.
1552 * @param message Message.
1554 * @return GNUNET_OK to keep the connection open,
1555 * GNUNET_SYSERR to close it (signal serious error)
1558 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1559 const struct GNUNET_MessageHeader *message)
1561 struct GNUNET_MESH_ConnectionDestroy *msg;
1562 struct MeshConnection *c;
1565 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1566 LOG (GNUNET_ERROR_TYPE_DEBUG,
1567 "Got a CONNECTION DESTROY message from %s\n",
1569 LOG (GNUNET_ERROR_TYPE_DEBUG,
1570 " for connection %s\n",
1571 GNUNET_h2s (&msg->cid));
1572 c = connection_get (&msg->cid);
1575 /* Probably already got the message from another path,
1576 * destroyed the tunnel and retransmitted to children.
1579 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1581 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1584 fwd = is_fwd (c, peer);
1585 if (GNUNET_SYSERR == fwd)
1587 GNUNET_break_op (0);
1590 if (GNUNET_NO == GMC_is_terminal (c, fwd))
1591 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1592 else if (0 == c->pending_messages)
1594 LOG (GNUNET_ERROR_TYPE_DEBUG, "! directly destroying connection!\n");
1598 c->destroy = GNUNET_YES;
1599 c->state = MESH_CONNECTION_DESTROYED;
1602 GMT_remove_connection (c->t, c);
1610 * Generic handler for mesh network encrypted traffic.
1612 * @param peer Peer identity this notification is about.
1613 * @param msg Encrypted message.
1615 * @return GNUNET_OK to keep the connection open,
1616 * GNUNET_SYSERR to close it (signal serious error)
1619 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1620 const struct GNUNET_MESH_Encrypted *msg)
1622 struct MeshConnection *c;
1623 struct MeshPeer *neighbor;
1624 struct MeshFlowControl *fc;
1625 GNUNET_PEER_Id peer_id;
1633 size = ntohs (msg->header.size);
1635 sizeof (struct GNUNET_MESH_Encrypted) +
1636 sizeof (struct GNUNET_MessageHeader))
1638 GNUNET_break_op (0);
1641 type = ntohs (msg->header.type);
1642 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1643 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message (#%u) from %s\n",
1644 GM_m2s (type), ntohl (msg->pid), GNUNET_i2s (peer));
1646 /* Check connection */
1647 c = connection_get (&msg->cid);
1650 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1651 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING enc on unknown connection %s\n",
1652 GNUNET_h2s (&msg->cid));
1656 /* Check if origin is as expected */
1657 neighbor = get_prev_hop (c);
1658 peer_id = GNUNET_PEER_search (peer);
1659 if (peer_id == GMP_get_short_id (neighbor))
1665 neighbor = get_next_hop (c);
1666 if (peer_id == GMP_get_short_id (neighbor))
1672 /* Unexpected peer sending traffic on a connection. */
1673 GNUNET_break_op (0);
1679 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1680 pid = ntohl (msg->pid);
1681 if (GM_is_pid_bigger (pid, fc->last_ack_sent))
1683 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1684 LOG (GNUNET_ERROR_TYPE_DEBUG,
1685 "WARNING Received PID %u, (prev %u), ACK %u\n",
1686 pid, fc->last_pid_recv, fc->last_ack_sent);
1689 if (GNUNET_NO == GM_is_pid_bigger (pid, fc->last_pid_recv))
1691 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1692 LOG (GNUNET_ERROR_TYPE_DEBUG,
1693 " Pid %u not expected (%u+), dropping!\n",
1694 pid, fc->last_pid_recv + 1);
1697 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1698 connection_change_state (c, MESH_CONNECTION_READY);
1699 connection_reset_timeout (c, fwd);
1700 fc->last_pid_recv = pid;
1702 /* Is this message for us? */
1703 if (GMC_is_terminal (c, fwd))
1705 /* TODO signature verification */
1706 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1707 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1714 fc->last_pid_recv = pid;
1715 GMT_handle_encrypted (c->t, msg);
1716 GMC_send_ack (c, fwd, GNUNET_NO);
1720 /* Message not for us: forward to next hop */
1721 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1722 ttl = ntohl (msg->ttl);
1723 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1726 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1727 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1728 GMC_send_ack (c, fwd, GNUNET_NO);
1732 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1733 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1739 * Generic handler for mesh network encrypted traffic.
1741 * @param peer Peer identity this notification is about.
1742 * @param msg Encrypted message.
1744 * @return GNUNET_OK to keep the connection open,
1745 * GNUNET_SYSERR to close it (signal serious error)
1748 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1749 const struct GNUNET_MESH_KX *msg)
1751 struct MeshConnection *c;
1752 struct MeshPeer *neighbor;
1753 GNUNET_PEER_Id peer_id;
1759 size = ntohs (msg->header.size);
1761 sizeof (struct GNUNET_MESH_Encrypted) +
1762 sizeof (struct GNUNET_MessageHeader))
1764 GNUNET_break_op (0);
1767 type = ntohs (msg->header.type);
1768 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1769 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message from %s\n",
1770 GM_m2s (type), GNUNET_i2s (peer));
1772 /* Check connection */
1773 c = connection_get (&msg->cid);
1776 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1777 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING kx on unknown connection %s\n",
1778 GNUNET_h2s (&msg->cid));
1781 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
1783 /* Check if origin is as expected */
1784 neighbor = get_prev_hop (c);
1785 peer_id = GNUNET_PEER_search (peer);
1786 if (peer_id == GMP_get_short_id (neighbor))
1792 neighbor = get_next_hop (c);
1793 if (peer_id == GMP_get_short_id (neighbor))
1799 /* Unexpected peer sending traffic on a connection. */
1800 GNUNET_break_op (0);
1805 /* Count as connection confirmation. */
1806 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1808 connection_change_state (c, MESH_CONNECTION_READY);
1811 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1812 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1815 connection_reset_timeout (c, fwd);
1817 /* Is this message for us? */
1818 if (GMC_is_terminal (c, fwd))
1820 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1821 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1827 GMT_handle_kx (c->t, &msg[1].header);
1831 /* Message not for us: forward to next hop */
1832 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1833 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1834 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1841 * Core handler for encrypted mesh network traffic (channel mgmt, data).
1843 * @param cls Closure (unused).
1844 * @param message Message received.
1845 * @param peer Peer who sent the message.
1847 * @return GNUNET_OK to keep the connection open,
1848 * GNUNET_SYSERR to close it (signal serious error)
1851 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
1852 const struct GNUNET_MessageHeader *message)
1854 return handle_mesh_encrypted (peer,
1855 (struct GNUNET_MESH_Encrypted *)message);
1860 * Core handler for key exchange traffic (ephemeral key, ping, pong).
1862 * @param cls Closure (unused).
1863 * @param message Message received.
1864 * @param peer Peer who sent the message.
1866 * @return GNUNET_OK to keep the connection open,
1867 * GNUNET_SYSERR to close it (signal serious error)
1870 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
1871 const struct GNUNET_MessageHeader *message)
1873 return handle_mesh_kx (peer,
1874 (struct GNUNET_MESH_KX *) message);
1879 * Core handler for mesh network traffic point-to-point acks.
1881 * @param cls closure
1882 * @param message message
1883 * @param peer peer identity this notification is about
1885 * @return GNUNET_OK to keep the connection open,
1886 * GNUNET_SYSERR to close it (signal serious error)
1889 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
1890 const struct GNUNET_MessageHeader *message)
1892 struct GNUNET_MESH_ACK *msg;
1893 struct MeshConnection *c;
1894 struct MeshFlowControl *fc;
1899 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1900 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK packet from %s!\n",
1902 msg = (struct GNUNET_MESH_ACK *) message;
1904 c = connection_get (&msg->cid);
1908 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
1913 /* Is this a forward or backward ACK? */
1914 id = GNUNET_PEER_search (peer);
1915 if (GMP_get_short_id (get_next_hop (c)) == id)
1917 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
1921 else if (GMP_get_short_id (get_prev_hop (c)) == id)
1923 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
1929 GNUNET_break_op (0);
1933 ack = ntohl (msg->ack);
1934 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
1935 ack, fc->last_ack_recv);
1936 if (GM_is_pid_bigger (ack, fc->last_ack_recv))
1937 fc->last_ack_recv = ack;
1939 /* Cancel polling if the ACK is big enough. */
1940 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
1941 GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
1943 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
1944 GNUNET_SCHEDULER_cancel (fc->poll_task);
1945 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1946 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
1949 connection_unlock_queue (c, fwd);
1956 * Core handler for mesh network traffic point-to-point ack polls.
1958 * @param cls closure
1959 * @param message message
1960 * @param peer peer identity this notification is about
1962 * @return GNUNET_OK to keep the connection open,
1963 * GNUNET_SYSERR to close it (signal serious error)
1966 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
1967 const struct GNUNET_MessageHeader *message)
1969 struct GNUNET_MESH_Poll *msg;
1970 struct MeshConnection *c;
1971 struct MeshFlowControl *fc;
1976 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1977 LOG (GNUNET_ERROR_TYPE_DEBUG,
1978 "Got a POLL message from %s!\n",
1981 msg = (struct GNUNET_MESH_Poll *) message;
1983 c = connection_get (&msg->cid);
1987 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
1989 LOG (GNUNET_ERROR_TYPE_DEBUG,
1990 "WARNING POLL message on unknown connection %s!\n",
1991 GNUNET_h2s (&msg->cid));
1995 /* Is this a forward or backward ACK?
1996 * Note: a poll should never be needed in a loopback case,
1997 * since there is no possiblility of packet loss there, so
1998 * this way of discerining FWD/BCK should not be a problem.
2000 id = GNUNET_PEER_search (peer);
2001 if (GMP_get_short_id (get_next_hop (c)) == id)
2003 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2006 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2008 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2013 GNUNET_break_op (0);
2017 pid = ntohl (msg->pid);
2018 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2019 fc->last_pid_recv = pid;
2020 fwd = fc == &c->bck_fc;
2021 GMC_send_ack (c, fwd, GNUNET_YES);
2028 * Core handler for mesh keepalives.
2030 * @param cls closure
2031 * @param message message
2032 * @param peer peer identity this notification is about
2033 * @return GNUNET_OK to keep the connection open,
2034 * GNUNET_SYSERR to close it (signal serious error)
2036 * TODO: Check who we got this from, to validate route.
2039 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
2040 const struct GNUNET_MessageHeader *message)
2042 struct GNUNET_MESH_ConnectionKeepAlive *msg;
2043 struct MeshConnection *c;
2044 struct MeshPeer *neighbor;
2045 GNUNET_PEER_Id peer_id;
2048 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) message;
2049 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a keepalive packet from %s\n",
2052 c = connection_get (&msg->cid);
2055 GNUNET_STATISTICS_update (stats, "# keepalive on unknown connection", 1,
2060 /* Check if origin is as expected TODO refactor and reuse */
2061 peer_id = GNUNET_PEER_search (peer);
2062 neighbor = get_prev_hop (c);
2063 if (peer_id == GMP_get_short_id (neighbor))
2069 neighbor = get_next_hop (c);
2070 if (peer_id == GMP_get_short_id (neighbor))
2076 GNUNET_break_op (0);
2081 connection_change_state (c, MESH_CONNECTION_READY);
2082 connection_reset_timeout (c, fwd);
2084 if (GMC_is_terminal (c, fwd))
2087 GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
2088 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
2095 * Send an ACK on the appropriate connection/channel, depending on
2096 * the direction and the position of the peer.
2098 * @param c Which connection to send the hop-by-hop ACK.
2099 * @param fwd Is this a fwd ACK? (will go dest->root).
2100 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2103 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
2105 unsigned int buffer;
2107 LOG (GNUNET_ERROR_TYPE_DEBUG,
2108 "GMC send %s ACK on %s\n",
2109 GM_f2s (fwd), GMC_2s (c));
2117 if (GNUNET_NO != c->destroy)
2119 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2123 /* Get available buffer space */
2124 if (GMC_is_terminal (c, fwd))
2126 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2127 buffer = GMT_get_channels_buffer (c->t);
2131 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2132 buffer = GMC_get_buffer (c, fwd);
2134 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2135 if (0 == buffer && GNUNET_NO == force)
2138 /* Send available buffer space */
2139 if (GMC_is_origin (c, fwd))
2141 GNUNET_assert (NULL != c->t);
2142 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2143 GMT_unchoke_channels (c->t);
2147 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2148 send_ack (c, buffer, fwd, force);
2154 * Initialize the connections subsystem
2156 * @param c Configuration handle.
2159 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2161 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2163 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2166 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2167 "MESH", "MAX_MSGS_QUEUE", "MISSING");
2168 GNUNET_SCHEDULER_shutdown ();
2173 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2176 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2177 "MESH", "MAX_CONNECTIONS", "MISSING");
2178 GNUNET_SCHEDULER_shutdown ();
2183 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2184 &refresh_connection_time))
2186 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2187 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2188 GNUNET_SCHEDULER_shutdown ();
2191 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2192 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
2197 * Destroy each connection on shutdown.
2199 * @param cls Closure (unused).
2200 * @param key Current key code (CID, unused).
2201 * @param value Value in the hash map (connection)
2203 * @return #GNUNET_YES, because we should continue to iterate,
2206 shutdown_iterator (void *cls,
2207 const struct GNUNET_HashCode *key,
2210 struct MeshConnection *c = value;
2218 * Shut down the connections subsystem.
2223 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2224 GNUNET_CONTAINER_multihashmap_destroy (connections);
2229 struct MeshConnection *
2230 GMC_new (const struct GNUNET_HashCode *cid,
2231 struct MeshTunnel3 *t,
2232 struct MeshPeerPath *p,
2233 unsigned int own_pos)
2235 struct MeshConnection *c;
2237 c = GNUNET_new (struct MeshConnection);
2239 GNUNET_assert (GNUNET_OK ==
2240 GNUNET_CONTAINER_multihashmap_put (connections,
2242 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2243 fc_init (&c->fwd_fc);
2244 fc_init (&c->bck_fc);
2249 GNUNET_assert (own_pos <= p->length - 1);
2250 c->own_pos = own_pos;
2253 if (GNUNET_OK != register_neighbors (c))
2257 GMT_remove_path (c->t, p);
2267 c->fwd_maintenance_task =
2268 GNUNET_SCHEDULER_add_delayed (create_connection_time,
2269 &connection_fwd_keepalive, c);
2277 GMC_destroy (struct MeshConnection *c)
2285 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2286 return; /* -> message_sent -> GMC_destroy. Don't loop. */
2289 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2290 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2291 &c->fwd_fc, &c->bck_fc);
2292 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2293 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2295 /* Cancel all traffic */
2296 if (NULL != c->path)
2298 connection_cancel_queues (c, GNUNET_YES);
2299 connection_cancel_queues (c, GNUNET_NO);
2300 unregister_neighbors (c);
2303 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2304 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2306 /* Cancel maintainance task (keepalive/timeout) */
2307 if (NULL != c->fwd_fc.poll_msg)
2309 GMC_cancel (c->fwd_fc.poll_msg);
2310 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2312 if (NULL != c->bck_fc.poll_msg)
2314 GMC_cancel (c->bck_fc.poll_msg);
2315 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2318 /* Delete from tunnel */
2320 GMT_remove_connection (c->t, c);
2322 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES) && NULL != c->path)
2323 path_destroy (c->path);
2324 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2325 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2326 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2327 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2328 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2330 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2331 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2333 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2335 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2336 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2339 GNUNET_break (GNUNET_YES ==
2340 GNUNET_CONTAINER_multihashmap_remove (connections, &c->id, c));
2342 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2347 * Get the connection ID.
2349 * @param c Connection to get the ID from.
2351 * @return ID of the connection.
2353 const struct GNUNET_HashCode *
2354 GMC_get_id (const struct MeshConnection *c)
2361 * Get the connection path.
2363 * @param c Connection to get the path from.
2365 * @return path used by the connection.
2367 const struct MeshPeerPath *
2368 GMC_get_path (const struct MeshConnection *c)
2370 if (GNUNET_NO == c->destroy)
2377 * Get the connection state.
2379 * @param c Connection to get the state from.
2381 * @return state of the connection.
2383 enum MeshConnectionState
2384 GMC_get_state (const struct MeshConnection *c)
2390 * Get the connection tunnel.
2392 * @param c Connection to get the tunnel from.
2394 * @return tunnel of the connection.
2396 struct MeshTunnel3 *
2397 GMC_get_tunnel (const struct MeshConnection *c)
2404 * Get free buffer space in a connection.
2406 * @param c Connection.
2407 * @param fwd Is query about FWD traffic?
2409 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2412 GMC_get_buffer (struct MeshConnection *c, int fwd)
2414 struct MeshFlowControl *fc;
2416 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2418 return (fc->queue_max - fc->queue_n);
2422 * Get how many messages have we allowed to send to us from a direction.
2424 * @param c Connection.
2425 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2427 * @return last_ack_sent - last_pid_recv
2430 GMC_get_allowed (struct MeshConnection *c, int fwd)
2432 struct MeshFlowControl *fc;
2434 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2435 if (GM_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2439 return (fc->last_ack_sent - fc->last_pid_recv);
2443 * Get messages queued in a connection.
2445 * @param c Connection.
2446 * @param fwd Is query about FWD traffic?
2448 * @return Number of messages queued.
2451 GMC_get_qn (struct MeshConnection *c, int fwd)
2453 struct MeshFlowControl *fc;
2455 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2462 * Allow the connection to advertise a buffer of the given size.
2464 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2465 * allowing up to last_pid_recv + buffer.
2467 * @param c Connection.
2468 * @param buffer How many more messages the connection can accept.
2469 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2472 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2474 send_ack (c, buffer, fwd, GNUNET_NO);
2479 * Notify other peers on a connection of a broken link. Mark connections
2480 * to destroy after all traffic has been sent.
2482 * @param c Connection on which there has been a disconnection.
2483 * @param peer Peer that disconnected.
2486 GMC_notify_broken (struct MeshConnection *c,
2487 struct MeshPeer *peer)
2491 LOG (GNUNET_ERROR_TYPE_DEBUG,
2492 " notify broken on %s due to %s disconnect\n",
2493 GMC_2s (c), GMP_2s (peer));
2495 fwd = peer == get_prev_hop (c);
2497 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2499 /* Local shutdown, no one to notify about this. */
2503 if (GNUNET_NO == c->destroy)
2504 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2506 /* Connection will have at least one pending message
2507 * (the one we just scheduled), so no point in checking whether to
2508 * destroy immediately. */
2509 c->destroy = GNUNET_YES;
2510 c->state = MESH_CONNECTION_DESTROYED;
2513 * Cancel all queues, if no message is left, connection will be destroyed.
2515 connection_cancel_queues (c, !fwd);
2522 * Is this peer the first one on the connection?
2524 * @param c Connection.
2525 * @param fwd Is this about fwd traffic?
2527 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2530 GMC_is_origin (struct MeshConnection *c, int fwd)
2532 if (!fwd && c->path->length - 1 == c->own_pos )
2534 if (fwd && 0 == c->own_pos)
2541 * Is this peer the last one on the connection?
2543 * @param c Connection.
2544 * @param fwd Is this about fwd traffic?
2545 * Note that the ROOT is the terminal for BCK traffic!
2547 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2550 GMC_is_terminal (struct MeshConnection *c, int fwd)
2552 return GMC_is_origin (c, !fwd);
2557 * See if we are allowed to send by the next hop in the given direction.
2559 * @param c Connection.
2560 * @param fwd Is this about fwd traffic?
2562 * @return #GNUNET_YES in case it's OK to send.
2565 GMC_is_sendable (struct MeshConnection *c, int fwd)
2567 struct MeshFlowControl *fc;
2569 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2570 if (GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2576 * Sends an already built message on a connection, properly registering
2577 * all used resources.
2579 * @param message Message to send. Function makes a copy of it.
2580 * If message is not hop-by-hop, decrements TTL of copy.
2581 * @param c Connection on which this message is transmitted.
2582 * @param fwd Is this a fwd message?
2583 * @param force Force the connection to accept the message (buffer overfill).
2584 * @param cont Continuation called once message is sent. Can be NULL.
2585 * @param cont_cls Closure for @c cont.
2587 * @return Handle to cancel the message before it's sent.
2588 * NULL on error or if @c cont is NULL.
2589 * Invalid on @c cont call.
2591 struct MeshConnectionQueue *
2592 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2593 struct MeshConnection *c, int fwd, int force,
2594 GMC_sent cont, void *cont_cls)
2596 struct MeshFlowControl *fc;
2597 struct MeshConnectionQueue *q;
2603 size = ntohs (message->size);
2604 data = GNUNET_malloc (size);
2605 memcpy (data, message, size);
2606 type = ntohs (message->type);
2607 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send %s (%u bytes) on connection %s\n",
2608 GM_m2s (type), size, GMC_2s (c));
2610 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2611 droppable = GNUNET_NO == force;
2614 struct GNUNET_MESH_Encrypted *emsg;
2615 struct GNUNET_MESH_KX *kmsg;
2616 struct GNUNET_MESH_ACK *amsg;
2617 struct GNUNET_MESH_Poll *pmsg;
2618 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2619 struct GNUNET_MESH_ConnectionBroken *bmsg;
2622 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2623 emsg = (struct GNUNET_MESH_Encrypted *) data;
2624 ttl = ntohl (emsg->ttl);
2627 GNUNET_break_op (0);
2632 emsg->ttl = htonl (ttl - 1);
2633 emsg->pid = htonl (fc->next_pid++);
2634 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2635 if (GNUNET_YES == droppable)
2638 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2639 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2640 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2644 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2646 if (GM_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2648 GMC_start_poll (c, fwd);
2652 case GNUNET_MESSAGE_TYPE_MESH_KX:
2653 kmsg = (struct GNUNET_MESH_KX *) data;
2657 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2658 amsg = (struct GNUNET_MESH_ACK *) data;
2660 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2661 droppable = GNUNET_NO;
2664 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2665 pmsg = (struct GNUNET_MESH_Poll *) data;
2667 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2668 droppable = GNUNET_NO;
2671 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2672 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2677 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2678 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2683 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2684 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2685 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
2694 if (fc->queue_n > fc->queue_max && droppable)
2696 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2699 LOG (GNUNET_ERROR_TYPE_DEBUG,
2700 "queue full: %u/%u\n",
2701 fc->queue_n, fc->queue_max);
2702 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2708 return NULL; /* Drop this message */
2711 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2712 c->pending_messages++;
2714 q = GNUNET_new (struct MeshConnectionQueue);
2715 q->forced = !droppable;
2716 q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2720 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING dropping msg on %s\n", GMC_2s (c));
2726 q->cont_cls = cont_cls;
2732 * Cancel a previously sent message while it's in the queue.
2734 * ONLY can be called before the continuation given to the send function
2735 * is called. Once the continuation is called, the message is no longer in the
2738 * @param q Handle to the queue.
2741 GMC_cancel (struct MeshConnectionQueue *q)
2743 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
2745 /* queue destroy calls message_sent, which calls q->cont and frees q */
2746 GMP_queue_destroy (q->q, GNUNET_YES);
2751 * Sends a CREATE CONNECTION message for a path to a peer.
2752 * Changes the connection and tunnel states if necessary.
2754 * @param connection Connection to create.
2757 GMC_send_create (struct MeshConnection *connection)
2759 enum MeshTunnel3CState state;
2762 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2763 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2765 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection create\n");
2766 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2767 connection, connection->pending_messages);
2768 connection->pending_messages++;
2770 GMP_queue_add (get_next_hop (connection), NULL,
2771 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2772 size, connection, GNUNET_YES, &message_sent, NULL);
2774 state = GMT_get_cstate (connection->t);
2775 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2776 GMT_change_cstate (connection->t, MESH_TUNNEL3_WAITING);
2777 if (MESH_CONNECTION_NEW == connection->state)
2778 connection_change_state (connection, MESH_CONNECTION_SENT);
2783 * Send a message to all peers in this connection that the connection
2784 * is no longer valid.
2786 * If some peer should not receive the message, it should be zero'ed out
2787 * before calling this function.
2789 * @param c The connection whose peers to notify.
2792 GMC_send_destroy (struct MeshConnection *c)
2794 struct GNUNET_MESH_ConnectionDestroy msg;
2796 if (GNUNET_YES == c->destroy)
2799 msg.header.size = htons (sizeof (msg));
2800 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
2802 LOG (GNUNET_ERROR_TYPE_DEBUG,
2803 " sending connection destroy for connection %s\n",
2806 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
2807 GMC_send_prebuilt_message (&msg.header, c,
2808 GNUNET_YES, GNUNET_YES, NULL, NULL);
2809 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
2810 GMC_send_prebuilt_message (&msg.header, c,
2811 GNUNET_NO, GNUNET_YES, NULL, NULL);
2812 c->destroy = GNUNET_YES;
2813 c->state = MESH_CONNECTION_DESTROYED;
2818 * @brief Start a polling timer for the connection.
2820 * When a neighbor does not accept more traffic on the connection it could be
2821 * caused by a simple congestion or by a lost ACK. Polling enables to check
2822 * for the lastest ACK status for a connection.
2824 * @param c Connection.
2825 * @param fwd Should we poll in the FWD direction?
2828 GMC_start_poll (struct MeshConnection *c, int fwd)
2830 struct MeshFlowControl *fc;
2832 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2833 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
2835 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
2837 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
2838 fc->poll_task, fc->poll_msg);
2841 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
2842 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
2849 * @brief Stop polling a connection for ACKs.
2851 * Once we have enough ACKs for future traffic, polls are no longer necessary.
2853 * @param c Connection.
2854 * @param fwd Should we stop the poll in the FWD direction?
2857 GMC_stop_poll (struct MeshConnection *c, int fwd)
2859 struct MeshFlowControl *fc;
2861 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2862 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
2864 GNUNET_SCHEDULER_cancel (fc->poll_task);
2865 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2870 * Get a (static) string for a connection.
2872 * @param c Connection.
2875 GMC_2s (struct MeshConnection *c)
2882 static char buf[128];
2884 sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
2887 return GNUNET_h2s (&c->id);