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))
449 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection %s is origin in %s\n",
450 GMC_2s (c), GM_f2s (fwd));
455 next_fc = fwd ? &c->fwd_fc : &c->bck_fc;
456 prev_fc = fwd ? &c->bck_fc : &c->fwd_fc;
458 LOG (GNUNET_ERROR_TYPE_DEBUG, "connection send %s ack on %s\n",
459 GM_f2s (fwd), GMC_2s (c));
461 /* Check if we need to transmit the ACK. */
462 delta = prev_fc->last_ack_sent - prev_fc->last_pid_recv;
463 if (3 < delta && buffer < delta && GNUNET_NO == force)
465 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending ACK, buffer > 3\n");
466 LOG (GNUNET_ERROR_TYPE_DEBUG,
467 " last pid recv: %u, last ack sent: %u\n",
468 prev_fc->last_pid_recv, prev_fc->last_ack_sent);
472 /* Ok, ACK might be necessary, what PID to ACK? */
473 ack = prev_fc->last_pid_recv + buffer;
474 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u\n", ack);
475 LOG (GNUNET_ERROR_TYPE_DEBUG,
476 " last pid %u, last ack %u, qmax %u, q %u\n",
477 prev_fc->last_pid_recv, prev_fc->last_ack_sent,
478 next_fc->queue_max, next_fc->queue_n);
479 if (ack == prev_fc->last_ack_sent && GNUNET_NO == force)
481 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not sending FWD ACK, not needed\n");
485 /* Check if message is already in queue */
486 if (NULL != prev_fc->ack_msg)
488 if (GM_is_pid_bigger (ack, prev_fc->last_ack_sent))
490 LOG (GNUNET_ERROR_TYPE_DEBUG, " canceling old ACK\n");
491 GMC_cancel (prev_fc->ack_msg);
492 /* GMC_cancel triggers ack_sent(), which clears fc->ack_msg */
496 LOG (GNUNET_ERROR_TYPE_DEBUG, " same ACK already in queue\n");
501 prev_fc->last_ack_sent = ack;
503 /* Build ACK message and send on connection */
504 msg.header.size = htons (sizeof (msg));
505 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_ACK);
506 msg.ack = htonl (ack);
509 prev_fc->ack_msg = GMC_send_prebuilt_message (&msg.header, c,
516 * Callback called when a queued message is sent.
518 * Calculates the average time and connection packet tracking.
520 * @param cls Closure (ConnectionQueue Handle).
521 * @param c Connection this message was on.
522 * @param type Type of message sent.
523 * @param fwd Was this a FWD going message?
524 * @param size Size of the message.
525 * @param wait Time spent waiting for core (only the time for THIS message)
528 message_sent (void *cls,
529 struct MeshConnection *c, uint16_t type,
530 int fwd, size_t size,
531 struct GNUNET_TIME_Relative wait)
533 struct MeshConnectionPerformance *p;
534 struct MeshFlowControl *fc;
535 struct MeshConnectionQueue *q = cls;
539 fc = fwd ? &c->fwd_fc : &c->bck_fc;
540 LOG (GNUNET_ERROR_TYPE_DEBUG,
544 LOG (GNUNET_ERROR_TYPE_DEBUG, "! C_P- %p %u\n", c, c->pending_messages);
550 LOG (GNUNET_ERROR_TYPE_DEBUG, "! calling cont\n");
551 q->cont (q->cont_cls, c, q, type, fwd, size);
555 else if (type == GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED)
557 /* If NULL == q and ENCRYPTED == type, message must have been ch_mngmnt */
564 c->pending_messages--;
565 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
567 LOG (GNUNET_ERROR_TYPE_DEBUG, "! destroying connection!\n");
571 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
574 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
576 LOG (GNUNET_ERROR_TYPE_DEBUG, "! Q_N- %p %u\n", fc, fc->queue_n);
577 if (GNUNET_NO == forced)
580 LOG (GNUNET_ERROR_TYPE_DEBUG,
581 "! accounting pid %u\n",
586 LOG (GNUNET_ERROR_TYPE_DEBUG,
587 "! forced, Q_N not accounting pid %u\n",
590 GMC_send_ack (c, fwd, GNUNET_NO);
593 case GNUNET_MESSAGE_TYPE_MESH_POLL:
597 case GNUNET_MESSAGE_TYPE_MESH_ACK:
604 LOG (GNUNET_ERROR_TYPE_DEBUG, "! message sent!\n");
607 return; /* Only endpoints are interested in timing. */
610 usecsperbyte = ((double) wait.rel_value_us) / size;
611 if (p->size == AVG_MSGS)
613 /* Array is full. Substract oldest value, add new one and store. */
614 p->avg -= (p->usecsperbyte[p->idx] / AVG_MSGS);
615 p->usecsperbyte[p->idx] = usecsperbyte;
616 p->avg += (p->usecsperbyte[p->idx] / AVG_MSGS);
620 /* Array not yet full. Add current value to avg and store. */
621 p->usecsperbyte[p->idx] = usecsperbyte;
623 p->avg += p->usecsperbyte[p->idx];
627 p->idx = (p->idx + 1) % AVG_MSGS;
632 * Get the previous hop in a connection
634 * @param c Connection.
636 * @return Previous peer in the connection.
638 static struct MeshPeer *
639 get_prev_hop (const struct MeshConnection *c)
643 if (0 == c->own_pos || c->path->length < 2)
644 id = c->path->peers[0];
646 id = c->path->peers[c->own_pos - 1];
648 return GMP_get_short (id);
653 * Get the next hop in a connection
655 * @param c Connection.
657 * @return Next peer in the connection.
659 static struct MeshPeer *
660 get_next_hop (const struct MeshConnection *c)
664 if ((c->path->length - 1) == c->own_pos || c->path->length < 2)
665 id = c->path->peers[c->path->length - 1];
667 id = c->path->peers[c->own_pos + 1];
669 return GMP_get_short (id);
674 * Get the hop in a connection.
676 * @param c Connection.
677 * @param fwd Next hop?
679 * @return Next peer in the connection.
681 static struct MeshPeer *
682 get_hop (struct MeshConnection *c, int fwd)
685 return get_next_hop (c);
686 return get_prev_hop (c);
691 * Is traffic coming from this sender 'FWD' traffic?
693 * @param c Connection to check.
694 * @param sender Peer identity of neighbor.
696 * @return #GNUNET_YES in case the sender is the 'prev' hop and therefore
697 * the traffic is 'FWD'.
698 * #GNUNET_NO for BCK.
699 * #GNUNET_SYSERR for errors.
702 is_fwd (const struct MeshConnection *c,
703 const struct GNUNET_PeerIdentity *sender)
707 id = GNUNET_PEER_search (sender);
708 if (GMP_get_short_id (get_prev_hop (c)) == id)
711 if (GMP_get_short_id (get_next_hop (c)) == id)
715 return GNUNET_SYSERR;
720 * Sends a CONNECTION ACK message in reponse to a received CONNECTION_CREATE
721 * or a first CONNECTION_ACK directed to us.
723 * @param connection Connection to confirm.
724 * @param fwd Should we send it FWD? (root->dest)
725 * (First (~SYNACK) goes BCK, second (~ACK) goes FWD)
728 send_connection_ack (struct MeshConnection *connection, int fwd)
730 struct MeshTunnel3 *t;
733 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection %s ACK\n",
735 GMP_queue_add (get_hop (connection, fwd), NULL,
736 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
737 sizeof (struct GNUNET_MESH_ConnectionACK),
738 connection, fwd, &message_sent, NULL);
739 connection->pending_messages++;
740 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
741 GMT_change_cstate (t, MESH_TUNNEL3_WAITING);
742 if (MESH_CONNECTION_READY != connection->state)
743 connection_change_state (connection, MESH_CONNECTION_SENT);
748 * Send a notification that a connection is broken.
750 * @param c Connection that is broken.
751 * @param id1 Peer that has disconnected.
752 * @param id2 Peer that has disconnected.
753 * @param fwd Direction towards which to send it.
756 send_broken (struct MeshConnection *c,
757 const struct GNUNET_PeerIdentity *id1,
758 const struct GNUNET_PeerIdentity *id2,
761 struct GNUNET_MESH_ConnectionBroken msg;
763 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectionBroken));
764 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN);
768 GMC_send_prebuilt_message (&msg.header, c, fwd, GNUNET_YES, NULL, NULL);
773 * Send keepalive packets for a connection.
775 * @param c Connection to keep alive..
776 * @param fwd Is this a FWD keepalive? (owner -> dest).
779 connection_keepalive (struct MeshConnection *c, int fwd)
781 struct GNUNET_MESH_ConnectionKeepAlive *msg;
782 size_t size = sizeof (struct GNUNET_MESH_ConnectionKeepAlive);
785 LOG (GNUNET_ERROR_TYPE_DEBUG,
786 "sending %s keepalive for connection %s]\n",
787 GM_f2s (fwd), GMC_2s (c));
789 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) cbuf;
790 msg->header.size = htons (size);
791 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE);
793 msg->reserved = htonl (0);
795 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_YES, NULL, NULL);
800 * Send CONNECTION_{CREATE/ACK} packets for a connection.
802 * @param c Connection for which to send the message.
803 * @param fwd If #GNUNET_YES, send CREATE, otherwise send ACK.
806 connection_recreate (struct MeshConnection *c, int fwd)
808 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending connection recreate\n");
812 send_connection_ack (c, GNUNET_NO);
817 * Generic connection timer management.
818 * Depending on the role of the peer in the connection will send the
819 * appropriate message (build or keepalive)
821 * @param c Conncetion to maintain.
825 connection_maintain (struct MeshConnection *c, int fwd)
827 if (GNUNET_NO != c->destroy)
830 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (c->t))
832 /* TODO DHT GET with RO_BART */
837 case MESH_CONNECTION_NEW:
840 case MESH_CONNECTION_SENT:
841 connection_recreate (c, fwd);
843 case MESH_CONNECTION_READY:
844 connection_keepalive (c, fwd);
853 connection_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
855 struct MeshConnection *c = cls;
856 struct GNUNET_TIME_Relative delay;
858 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
859 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
862 connection_maintain (c, GNUNET_YES);
863 delay = c->state == MESH_CONNECTION_READY ?
864 refresh_connection_time : create_connection_time;
865 c->fwd_maintenance_task = GNUNET_SCHEDULER_add_delayed (delay,
866 &connection_fwd_keepalive,
872 connection_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
874 struct MeshConnection *c = cls;
875 struct GNUNET_TIME_Relative delay;
877 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
878 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
881 connection_maintain (c, GNUNET_NO);
882 delay = c->state == MESH_CONNECTION_READY ?
883 refresh_connection_time : create_connection_time;
884 c->bck_maintenance_task = GNUNET_SCHEDULER_add_delayed (delay,
885 &connection_bck_keepalive,
891 * @brief Re-initiate traffic on this connection if necessary.
893 * Check if there is traffic queued towards this peer
894 * and the core transmit handle is NULL (traffic was stalled).
895 * If so, call core tmt rdy.
897 * @param c Connection on which initiate traffic.
898 * @param fwd Is this about fwd traffic?
901 connection_unlock_queue (struct MeshConnection *c, int fwd)
903 struct MeshPeer *peer;
905 LOG (GNUNET_ERROR_TYPE_DEBUG,
906 "connection_unlock_queue %s on %s\n",
907 GM_f2s (fwd), GMC_2s (c));
909 if (GMC_is_terminal (c, fwd))
911 LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
915 peer = get_hop (c, fwd);
916 GMP_queue_unlock (peer, c);
921 * Cancel all transmissions that belong to a certain connection.
923 * If the connection is scheduled for destruction and no more messages are left,
924 * the connection will be destroyed by the continuation call.
926 * @param c Connection which to cancel. Might be destroyed during this call.
927 * @param fwd Cancel fwd traffic?
930 connection_cancel_queues (struct MeshConnection *c, int fwd)
932 struct MeshFlowControl *fc;
933 struct MeshPeer *peer;
935 LOG (GNUNET_ERROR_TYPE_DEBUG,
936 " *** Cancel %s queues for connection %s\n",
937 GM_f2s (fwd), GMC_2s (c));
944 fc = fwd ? &c->fwd_fc : &c->bck_fc;
945 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
947 GNUNET_SCHEDULER_cancel (fc->poll_task);
948 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
949 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Cancel POLL in ccq for fc %p\n", fc);
951 peer = get_hop (c, fwd);
952 GMP_queue_cancel (peer, c);
957 * Function called if a connection has been stalled for a while,
958 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
960 * @param cls Closure (poll ctx).
961 * @param tc TaskContext.
964 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
968 * Callback called when a queued POLL message is sent.
970 * @param cls Closure (FC).
971 * @param c Connection this message was on.
972 * @param q Queue handler this call invalidates.
973 * @param type Type of message sent.
974 * @param fwd Was this a FWD going message?
975 * @param size Size of the message.
978 poll_sent (void *cls,
979 struct MeshConnection *c,
980 struct MeshConnectionQueue *q,
981 uint16_t type, int fwd, size_t size)
983 struct MeshFlowControl *fc = cls;
987 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL canceled on shutdown\n");
990 LOG (GNUNET_ERROR_TYPE_DEBUG,
991 " *** POLL sent for , scheduling new one!\n");
993 fc->poll_time = GNUNET_TIME_STD_BACKOFF (fc->poll_time);
994 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
995 &connection_poll, fc);
996 LOG (GNUNET_ERROR_TYPE_DEBUG, " task %u\n", fc->poll_task);
1001 * Function called if a connection has been stalled for a while,
1002 * possibly due to a missed ACK. Poll the neighbor about its ACK status.
1004 * @param cls Closure (poll ctx).
1005 * @param tc TaskContext.
1008 connection_poll (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1010 struct MeshFlowControl *fc = cls;
1011 struct GNUNET_MESH_Poll msg;
1012 struct MeshConnection *c;
1014 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1015 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1021 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** Polling!\n");
1022 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** connection [%s]\n", GMC_2s (c));
1023 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** %s\n",
1024 fc == &c->fwd_fc ? "FWD" : "BCK");
1026 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_POLL);
1027 msg.header.size = htons (sizeof (msg));
1028 msg.pid = htonl (fc->last_pid_sent);
1029 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** last pid sent: %u!\n", fc->last_pid_sent);
1030 fc->poll_msg = GMC_send_prebuilt_message (&msg.header, c,
1031 fc == &c->fwd_fc, GNUNET_YES,
1037 * Timeout function due to lack of keepalive/traffic from the owner.
1038 * Destroys connection if called.
1040 * @param cls Closure (connection to destroy).
1041 * @param tc TaskContext.
1044 connection_fwd_timeout (void *cls,
1045 const struct GNUNET_SCHEDULER_TaskContext *tc)
1047 struct MeshConnection *c = cls;
1049 c->fwd_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1050 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1053 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s FWD timed out. Destroying.\n",
1055 if (GMC_is_origin (c, GNUNET_YES)) /* If local, leave. */
1066 * Timeout function due to lack of keepalive/traffic from the destination.
1067 * Destroys connection if called.
1069 * @param cls Closure (connection to destroy).
1070 * @param tc TaskContext
1073 connection_bck_timeout (void *cls,
1074 const struct GNUNET_SCHEDULER_TaskContext *tc)
1076 struct MeshConnection *c = cls;
1078 c->bck_maintenance_task = GNUNET_SCHEDULER_NO_TASK;
1079 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1082 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s BCK timed out. Destroying.\n",
1085 if (GMC_is_origin (c, GNUNET_NO)) /* If local, leave. */
1096 * Resets the connection timeout task, some other message has done the
1098 * - For the first peer on the direction this means to send
1099 * a keepalive or a path confirmation message (either create or ACK).
1100 * - For all other peers, this means to destroy the connection,
1101 * due to lack of activity.
1102 * Starts the timeout if no timeout was running (connection just created).
1104 * @param c Connection whose timeout to reset.
1105 * @param fwd Is this forward?
1107 * TODO use heap to improve efficiency of scheduler.
1110 connection_reset_timeout (struct MeshConnection *c, int fwd)
1112 GNUNET_SCHEDULER_TaskIdentifier *ti;
1113 GNUNET_SCHEDULER_Task f;
1115 ti = fwd ? &c->fwd_maintenance_task : &c->bck_maintenance_task;
1117 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connection %s reset timeout\n", GM_f2s (fwd));
1119 if (GNUNET_SCHEDULER_NO_TASK != *ti)
1120 GNUNET_SCHEDULER_cancel (*ti);
1122 if (GMC_is_origin (c, fwd)) /* Startpoint */
1124 f = fwd ? &connection_fwd_keepalive : &connection_bck_keepalive;
1125 *ti = GNUNET_SCHEDULER_add_delayed (refresh_connection_time, f, c);
1127 else /* Relay, endpoint. */
1129 struct GNUNET_TIME_Relative delay;
1131 delay = GNUNET_TIME_relative_multiply (refresh_connection_time, 4);
1132 f = fwd ? &connection_fwd_timeout : &connection_bck_timeout;
1133 *ti = GNUNET_SCHEDULER_add_delayed (delay, f, c);
1139 * Add the connection to the list of both neighbors.
1141 * @param c Connection.
1143 * @return #GNUNET_OK if everything went fine
1144 * #GNUNET_SYSERR if the was an error and @c c is malformed.
1147 register_neighbors (struct MeshConnection *c)
1149 struct MeshPeer *next_peer;
1150 struct MeshPeer *prev_peer;
1152 next_peer = get_next_hop (c);
1153 prev_peer = get_prev_hop (c);
1155 if (GNUNET_NO == GMP_is_neighbor (next_peer)
1156 || GNUNET_NO == GMP_is_neighbor (prev_peer))
1158 if (GMC_is_origin (c, GNUNET_YES))
1159 GNUNET_STATISTICS_update (stats, "# local bad paths", 1, GNUNET_NO);
1160 GNUNET_STATISTICS_update (stats, "# bad paths", 1, GNUNET_NO);
1162 LOG (GNUNET_ERROR_TYPE_DEBUG, " register neighbors failed\n");
1163 LOG (GNUNET_ERROR_TYPE_DEBUG, " prev: %s, neighbor?: %d\n",
1164 GMP_2s (prev_peer), GMP_is_neighbor (prev_peer));
1165 LOG (GNUNET_ERROR_TYPE_DEBUG, " next: %s, neighbor?: %d\n",
1166 GMP_2s (next_peer), GMP_is_neighbor (next_peer));
1167 return GNUNET_SYSERR;
1170 GMP_add_connection (next_peer, c);
1171 GMP_add_connection (prev_peer, c);
1178 * Remove the connection from the list of both neighbors.
1180 * @param c Connection.
1183 unregister_neighbors (struct MeshConnection *c)
1185 struct MeshPeer *peer;
1187 peer = get_next_hop (c);
1188 if (GNUNET_OK != GMP_remove_connection (peer, c))
1190 GNUNET_break (MESH_CONNECTION_NEW == c->state
1191 || MESH_CONNECTION_DESTROYED == c->state);
1192 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1193 if (NULL != c->t) GMT_debug (c->t);
1196 peer = get_prev_hop (c);
1197 if (GNUNET_OK != GMP_remove_connection (peer, c))
1199 GNUNET_break (MESH_CONNECTION_NEW == c->state
1200 || MESH_CONNECTION_DESTROYED == c->state);
1201 LOG (GNUNET_ERROR_TYPE_DEBUG, " cstate: %u\n", c->state);
1202 if (NULL != c->t) GMT_debug (c->t);
1208 * Bind the connection to the peer and the tunnel to that peer.
1210 * If the peer has no tunnel, create one. Update tunnel and connection
1211 * data structres to reflect new status.
1213 * @param c Connection.
1217 add_to_peer (struct MeshConnection *c, struct MeshPeer *peer)
1219 GMP_add_tunnel (peer);
1220 c->t = GMP_get_tunnel (peer);
1221 GMT_add_connection (c->t, c);
1224 /******************************************************************************/
1225 /******************************** API ***********************************/
1226 /******************************************************************************/
1229 * Core handler for connection creation.
1231 * @param cls Closure (unused).
1232 * @param peer Sender (neighbor).
1233 * @param message Message.
1235 * @return GNUNET_OK to keep the connection open,
1236 * GNUNET_SYSERR to close it (signal serious error)
1239 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
1240 const struct GNUNET_MessageHeader *message)
1242 struct GNUNET_MESH_ConnectionCreate *msg;
1243 struct GNUNET_PeerIdentity *id;
1244 struct GNUNET_HashCode *cid;
1245 struct MeshPeerPath *path;
1246 struct MeshPeer *dest_peer;
1247 struct MeshPeer *orig_peer;
1248 struct MeshConnection *c;
1249 unsigned int own_pos;
1253 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1254 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection create msg\n");
1257 size = ntohs (message->size);
1258 if (size < sizeof (struct GNUNET_MESH_ConnectionCreate))
1260 GNUNET_break_op (0);
1264 /* Calculate hops */
1265 size -= sizeof (struct GNUNET_MESH_ConnectionCreate);
1266 if (size % sizeof (struct GNUNET_PeerIdentity))
1268 GNUNET_break_op (0);
1271 size /= sizeof (struct GNUNET_PeerIdentity);
1274 GNUNET_break_op (0);
1277 LOG (GNUNET_ERROR_TYPE_DEBUG, " path has %u hops.\n", size);
1279 /* Get parameters */
1280 msg = (struct GNUNET_MESH_ConnectionCreate *) message;
1282 id = (struct GNUNET_PeerIdentity *) &msg[1];
1283 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection %s (%s->).\n",
1284 GNUNET_h2s (cid), GNUNET_i2s (id));
1286 /* Create connection */
1287 c = connection_get (cid);
1291 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating path...\n");
1292 path = path_new (size);
1294 for (i = 0; i < size; i++)
1296 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... adding %s\n",
1297 GNUNET_i2s (&id[i]));
1298 path->peers[i] = GNUNET_PEER_intern (&id[i]);
1299 if (path->peers[i] == myid)
1302 if (own_pos == 0 && path->peers[own_pos] != myid)
1304 /* create path: self not found in path through self */
1305 GNUNET_break_op (0);
1306 path_destroy (path);
1309 LOG (GNUNET_ERROR_TYPE_DEBUG, " Own position: %u\n", own_pos);
1310 GMP_add_path_to_all (path, GNUNET_NO);
1311 LOG (GNUNET_ERROR_TYPE_DEBUG, " Creating connection\n");
1312 c = GMC_new (cid, NULL, path_duplicate (path), own_pos);
1315 path_destroy (path);
1318 connection_reset_timeout (c, GNUNET_YES);
1322 path = path_duplicate (c->path);
1324 if (MESH_CONNECTION_NEW == c->state)
1325 connection_change_state (c, MESH_CONNECTION_SENT);
1327 /* Remember peers */
1328 dest_peer = GMP_get (&id[size - 1]);
1329 orig_peer = GMP_get (&id[0]);
1331 /* Is it a connection to us? */
1332 if (c->own_pos == size - 1)
1334 LOG (GNUNET_ERROR_TYPE_DEBUG, " It's for us!\n");
1335 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_YES);
1337 add_to_peer (c, orig_peer);
1338 if (MESH_TUNNEL3_NEW == GMT_get_cstate (c->t))
1339 GMT_change_cstate (c->t, MESH_TUNNEL3_WAITING);
1341 send_connection_ack (c, GNUNET_NO);
1342 if (MESH_CONNECTION_SENT == c->state)
1343 connection_change_state (c, MESH_CONNECTION_ACK);
1345 /* Keep tunnel alive in direction dest->owner*/
1346 if (GNUNET_SCHEDULER_NO_TASK == c->bck_maintenance_task)
1348 c->bck_maintenance_task =
1349 GNUNET_SCHEDULER_add_delayed (create_connection_time,
1350 &connection_bck_keepalive, c);
1355 /* It's for somebody else! Retransmit. */
1356 LOG (GNUNET_ERROR_TYPE_DEBUG, " Retransmitting.\n");
1357 GMP_add_path (dest_peer, path_duplicate (path), GNUNET_NO);
1358 GMP_add_path_to_origin (orig_peer, path_duplicate (path), GNUNET_NO);
1359 GMC_send_prebuilt_message (message, c, GNUNET_YES, GNUNET_YES,
1362 path_destroy (path);
1368 * Core handler for path confirmations.
1370 * @param cls closure
1371 * @param message message
1372 * @param peer peer identity this notification is about
1374 * @return GNUNET_OK to keep the connection open,
1375 * GNUNET_SYSERR to close it (signal serious error)
1378 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
1379 const struct GNUNET_MessageHeader *message)
1381 struct GNUNET_MESH_ConnectionACK *msg;
1382 struct MeshConnection *c;
1383 struct MeshPeerPath *p;
1384 struct MeshPeer *pi;
1385 enum MeshConnectionState oldstate;
1388 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1389 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a connection ACK msg\n");
1390 msg = (struct GNUNET_MESH_ConnectionACK *) message;
1391 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n",
1392 GNUNET_h2s (&msg->cid));
1393 c = connection_get (&msg->cid);
1396 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1398 LOG (GNUNET_ERROR_TYPE_DEBUG, " don't know the connection!\n");
1402 if (GNUNET_NO != c->destroy)
1404 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection being destroyed\n");
1408 oldstate = c->state;
1409 LOG (GNUNET_ERROR_TYPE_DEBUG, " via peer %s\n", GNUNET_i2s (peer));
1410 pi = GMP_get (peer);
1411 if (get_next_hop (c) == pi)
1413 LOG (GNUNET_ERROR_TYPE_DEBUG, " SYNACK\n");
1415 if (MESH_CONNECTION_SENT == oldstate)
1416 connection_change_state (c, MESH_CONNECTION_ACK);
1418 else if (get_prev_hop (c) == pi)
1420 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK\n");
1422 connection_change_state (c, MESH_CONNECTION_READY);
1426 GNUNET_break_op (0);
1430 connection_reset_timeout (c, fwd);
1432 /* Add path to peers? */
1436 GMP_add_path_to_all (p, GNUNET_YES);
1443 /* Message for us as creator? */
1444 if (GMC_is_origin (c, GNUNET_YES))
1446 if (GNUNET_NO != fwd)
1448 GNUNET_break_op (0);
1451 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection (SYN)ACK for us!\n");
1453 /* If just created, cancel the short timeout and start a long one */
1454 if (MESH_CONNECTION_SENT == oldstate)
1455 connection_reset_timeout (c, GNUNET_YES);
1457 /* Change connection state */
1458 connection_change_state (c, MESH_CONNECTION_READY);
1459 send_connection_ack (c, GNUNET_YES);
1461 /* Change tunnel state, trigger KX */
1462 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1463 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1468 /* Message for us as destination? */
1469 if (GMC_is_terminal (c, GNUNET_YES))
1471 if (GNUNET_YES != fwd)
1473 GNUNET_break_op (0);
1476 LOG (GNUNET_ERROR_TYPE_DEBUG, " Connection ACK for us!\n");
1478 /* If just created, cancel the short timeout and start a long one */
1479 if (MESH_CONNECTION_ACK == oldstate)
1480 connection_reset_timeout (c, GNUNET_NO);
1482 /* Change tunnel state */
1483 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1484 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1489 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1490 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1496 * Core handler for notifications of broken paths
1498 * @param cls Closure (unused).
1499 * @param id Peer identity of sending neighbor.
1500 * @param message Message.
1502 * @return GNUNET_OK to keep the connection open,
1503 * GNUNET_SYSERR to close it (signal serious error)
1506 GMC_handle_broken (void* cls,
1507 const struct GNUNET_PeerIdentity* id,
1508 const struct GNUNET_MessageHeader* message)
1510 struct GNUNET_MESH_ConnectionBroken *msg;
1511 struct MeshConnection *c;
1514 LOG (GNUNET_ERROR_TYPE_DEBUG,
1515 "Received a CONNECTION BROKEN msg from %s\n", GNUNET_i2s (id));
1516 msg = (struct GNUNET_MESH_ConnectionBroken *) message;
1517 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1518 GNUNET_i2s (&msg->peer1));
1519 LOG (GNUNET_ERROR_TYPE_DEBUG, " regarding %s\n",
1520 GNUNET_i2s (&msg->peer2));
1521 c = connection_get (&msg->cid);
1524 GNUNET_break_op (0);
1528 fwd = is_fwd (c, id);
1529 if (GMC_is_terminal (c, fwd))
1531 if (0 < c->pending_messages)
1532 c->destroy = GNUNET_YES;
1538 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1539 c->destroy = GNUNET_YES;
1540 connection_cancel_queues (c, !fwd);
1549 * Core handler for tunnel destruction
1551 * @param cls Closure (unused).
1552 * @param peer Peer identity of sending neighbor.
1553 * @param message Message.
1555 * @return GNUNET_OK to keep the connection open,
1556 * GNUNET_SYSERR to close it (signal serious error)
1559 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
1560 const struct GNUNET_MessageHeader *message)
1562 struct GNUNET_MESH_ConnectionDestroy *msg;
1563 struct MeshConnection *c;
1566 msg = (struct GNUNET_MESH_ConnectionDestroy *) message;
1567 LOG (GNUNET_ERROR_TYPE_DEBUG,
1568 "Got a CONNECTION DESTROY message from %s\n",
1570 LOG (GNUNET_ERROR_TYPE_DEBUG,
1571 " for connection %s\n",
1572 GNUNET_h2s (&msg->cid));
1573 c = connection_get (&msg->cid);
1576 /* Probably already got the message from another path,
1577 * destroyed the tunnel and retransmitted to children.
1580 GNUNET_STATISTICS_update (stats, "# control on unknown connection",
1582 LOG (GNUNET_ERROR_TYPE_DEBUG, " connection unknown: already destroyed?\n");
1585 fwd = is_fwd (c, peer);
1586 if (GNUNET_SYSERR == fwd)
1588 GNUNET_break_op (0);
1591 if (GNUNET_NO == GMC_is_terminal (c, fwd))
1592 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
1593 else if (0 == c->pending_messages)
1595 LOG (GNUNET_ERROR_TYPE_DEBUG, "! directly destroying connection!\n");
1599 c->destroy = GNUNET_YES;
1600 c->state = MESH_CONNECTION_DESTROYED;
1603 GMT_remove_connection (c->t, c);
1611 * Generic handler for mesh network encrypted traffic.
1613 * @param peer Peer identity this notification is about.
1614 * @param msg Encrypted message.
1616 * @return GNUNET_OK to keep the connection open,
1617 * GNUNET_SYSERR to close it (signal serious error)
1620 handle_mesh_encrypted (const struct GNUNET_PeerIdentity *peer,
1621 const struct GNUNET_MESH_Encrypted *msg)
1623 struct MeshConnection *c;
1624 struct MeshPeer *neighbor;
1625 struct MeshFlowControl *fc;
1626 GNUNET_PEER_Id peer_id;
1634 size = ntohs (msg->header.size);
1636 sizeof (struct GNUNET_MESH_Encrypted) +
1637 sizeof (struct GNUNET_MessageHeader))
1639 GNUNET_break_op (0);
1642 type = ntohs (msg->header.type);
1643 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1644 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message (#%u) from %s\n",
1645 GM_m2s (type), ntohl (msg->pid), GNUNET_i2s (peer));
1647 /* Check connection */
1648 c = connection_get (&msg->cid);
1651 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1652 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING enc on unknown connection %s\n",
1653 GNUNET_h2s (&msg->cid));
1657 /* Check if origin is as expected */
1658 neighbor = get_prev_hop (c);
1659 peer_id = GNUNET_PEER_search (peer);
1660 if (peer_id == GMP_get_short_id (neighbor))
1666 neighbor = get_next_hop (c);
1667 if (peer_id == GMP_get_short_id (neighbor))
1673 /* Unexpected peer sending traffic on a connection. */
1674 GNUNET_break_op (0);
1680 fc = fwd ? &c->bck_fc : &c->fwd_fc;
1681 pid = ntohl (msg->pid);
1682 if (GM_is_pid_bigger (pid, fc->last_ack_sent))
1684 GNUNET_STATISTICS_update (stats, "# unsolicited message", 1, GNUNET_NO);
1685 LOG (GNUNET_ERROR_TYPE_DEBUG,
1686 "WARNING Received PID %u, (prev %u), ACK %u\n",
1687 pid, fc->last_pid_recv, fc->last_ack_sent);
1690 if (GNUNET_NO == GM_is_pid_bigger (pid, fc->last_pid_recv))
1692 GNUNET_STATISTICS_update (stats, "# duplicate PID", 1, GNUNET_NO);
1693 LOG (GNUNET_ERROR_TYPE_DEBUG,
1694 " Pid %u not expected (%u+), dropping!\n",
1695 pid, fc->last_pid_recv + 1);
1698 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1699 connection_change_state (c, MESH_CONNECTION_READY);
1700 connection_reset_timeout (c, fwd);
1701 fc->last_pid_recv = pid;
1703 /* Is this message for us? */
1704 if (GMC_is_terminal (c, fwd))
1706 /* TODO signature verification */
1707 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1708 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1715 fc->last_pid_recv = pid;
1716 GMT_handle_encrypted (c->t, msg);
1717 GMC_send_ack (c, fwd, GNUNET_NO);
1721 /* Message not for us: forward to next hop */
1722 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1723 ttl = ntohl (msg->ttl);
1724 LOG (GNUNET_ERROR_TYPE_DEBUG, " ttl: %u\n", ttl);
1727 GNUNET_STATISTICS_update (stats, "# TTL drops", 1, GNUNET_NO);
1728 LOG (GNUNET_ERROR_TYPE_WARNING, " TTL is 0, DROPPING!\n");
1729 GMC_send_ack (c, fwd, GNUNET_NO);
1733 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1734 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1740 * Generic handler for mesh network encrypted traffic.
1742 * @param peer Peer identity this notification is about.
1743 * @param msg Encrypted message.
1745 * @return GNUNET_OK to keep the connection open,
1746 * GNUNET_SYSERR to close it (signal serious error)
1749 handle_mesh_kx (const struct GNUNET_PeerIdentity *peer,
1750 const struct GNUNET_MESH_KX *msg)
1752 struct MeshConnection *c;
1753 struct MeshPeer *neighbor;
1754 GNUNET_PEER_Id peer_id;
1760 size = ntohs (msg->header.size);
1762 sizeof (struct GNUNET_MESH_Encrypted) +
1763 sizeof (struct GNUNET_MessageHeader))
1765 GNUNET_break_op (0);
1768 type = ntohs (msg->header.type);
1769 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1770 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a %s message from %s\n",
1771 GM_m2s (type), GNUNET_i2s (peer));
1773 /* Check connection */
1774 c = connection_get (&msg->cid);
1777 GNUNET_STATISTICS_update (stats, "# unknown connection", 1, GNUNET_NO);
1778 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING kx on unknown connection %s\n",
1779 GNUNET_h2s (&msg->cid));
1782 LOG (GNUNET_ERROR_TYPE_DEBUG, " on connection %s\n", GMC_2s (c));
1784 /* Check if origin is as expected */
1785 neighbor = get_prev_hop (c);
1786 peer_id = GNUNET_PEER_search (peer);
1787 if (peer_id == GMP_get_short_id (neighbor))
1793 neighbor = get_next_hop (c);
1794 if (peer_id == GMP_get_short_id (neighbor))
1800 /* Unexpected peer sending traffic on a connection. */
1801 GNUNET_break_op (0);
1806 /* Count as connection confirmation. */
1807 if (MESH_CONNECTION_SENT == c->state || MESH_CONNECTION_ACK == c->state)
1809 connection_change_state (c, MESH_CONNECTION_READY);
1812 if (MESH_TUNNEL3_WAITING == GMT_get_cstate (c->t))
1813 GMT_change_cstate (c->t, MESH_TUNNEL3_READY);
1816 connection_reset_timeout (c, fwd);
1818 /* Is this message for us? */
1819 if (GMC_is_terminal (c, fwd))
1821 LOG (GNUNET_ERROR_TYPE_DEBUG, " message for us!\n");
1822 GNUNET_STATISTICS_update (stats, "# messages received", 1, GNUNET_NO);
1828 GMT_handle_kx (c->t, &msg[1].header);
1832 /* Message not for us: forward to next hop */
1833 LOG (GNUNET_ERROR_TYPE_DEBUG, " not for us, retransmitting...\n");
1834 GNUNET_STATISTICS_update (stats, "# messages forwarded", 1, GNUNET_NO);
1835 GMC_send_prebuilt_message (&msg->header, c, fwd, GNUNET_NO, NULL, NULL);
1842 * Core handler for encrypted mesh network traffic (channel mgmt, data).
1844 * @param cls Closure (unused).
1845 * @param message Message received.
1846 * @param peer Peer who sent the message.
1848 * @return GNUNET_OK to keep the connection open,
1849 * GNUNET_SYSERR to close it (signal serious error)
1852 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
1853 const struct GNUNET_MessageHeader *message)
1855 return handle_mesh_encrypted (peer,
1856 (struct GNUNET_MESH_Encrypted *)message);
1861 * Core handler for key exchange traffic (ephemeral key, ping, pong).
1863 * @param cls Closure (unused).
1864 * @param message Message received.
1865 * @param peer Peer who sent the message.
1867 * @return GNUNET_OK to keep the connection open,
1868 * GNUNET_SYSERR to close it (signal serious error)
1871 GMC_handle_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
1872 const struct GNUNET_MessageHeader *message)
1874 return handle_mesh_kx (peer,
1875 (struct GNUNET_MESH_KX *) message);
1880 * Core handler for mesh network traffic point-to-point acks.
1882 * @param cls closure
1883 * @param message message
1884 * @param peer peer identity this notification is about
1886 * @return GNUNET_OK to keep the connection open,
1887 * GNUNET_SYSERR to close it (signal serious error)
1890 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
1891 const struct GNUNET_MessageHeader *message)
1893 struct GNUNET_MESH_ACK *msg;
1894 struct MeshConnection *c;
1895 struct MeshFlowControl *fc;
1900 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1901 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK packet from %s!\n",
1903 msg = (struct GNUNET_MESH_ACK *) message;
1905 c = connection_get (&msg->cid);
1909 GNUNET_STATISTICS_update (stats, "# ack on unknown connection", 1,
1914 /* Is this a forward or backward ACK? */
1915 id = GNUNET_PEER_search (peer);
1916 if (GMP_get_short_id (get_next_hop (c)) == id)
1918 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD ACK\n");
1922 else if (GMP_get_short_id (get_prev_hop (c)) == id)
1924 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK ACK\n");
1930 GNUNET_break_op (0);
1934 ack = ntohl (msg->ack);
1935 LOG (GNUNET_ERROR_TYPE_DEBUG, " ACK %u (was %u)\n",
1936 ack, fc->last_ack_recv);
1937 if (GM_is_pid_bigger (ack, fc->last_ack_recv))
1938 fc->last_ack_recv = ack;
1940 /* Cancel polling if the ACK is big enough. */
1941 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task &&
1942 GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
1944 LOG (GNUNET_ERROR_TYPE_DEBUG, " Cancel poll\n");
1945 GNUNET_SCHEDULER_cancel (fc->poll_task);
1946 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
1947 fc->poll_time = GNUNET_TIME_UNIT_SECONDS;
1950 connection_unlock_queue (c, fwd);
1957 * Core handler for mesh network traffic point-to-point ack polls.
1959 * @param cls closure
1960 * @param message message
1961 * @param peer peer identity this notification is about
1963 * @return GNUNET_OK to keep the connection open,
1964 * GNUNET_SYSERR to close it (signal serious error)
1967 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
1968 const struct GNUNET_MessageHeader *message)
1970 struct GNUNET_MESH_Poll *msg;
1971 struct MeshConnection *c;
1972 struct MeshFlowControl *fc;
1977 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n\n");
1978 LOG (GNUNET_ERROR_TYPE_DEBUG,
1979 "Got a POLL message from %s!\n",
1982 msg = (struct GNUNET_MESH_Poll *) message;
1984 c = connection_get (&msg->cid);
1988 GNUNET_STATISTICS_update (stats, "# poll on unknown connection", 1,
1990 LOG (GNUNET_ERROR_TYPE_DEBUG,
1991 "WARNING POLL message on unknown connection %s!\n",
1992 GNUNET_h2s (&msg->cid));
1996 /* Is this a forward or backward ACK?
1997 * Note: a poll should never be needed in a loopback case,
1998 * since there is no possiblility of packet loss there, so
1999 * this way of discerining FWD/BCK should not be a problem.
2001 id = GNUNET_PEER_search (peer);
2002 if (GMP_get_short_id (get_next_hop (c)) == id)
2004 LOG (GNUNET_ERROR_TYPE_DEBUG, " FWD FC\n");
2007 else if (GMP_get_short_id (get_prev_hop (c)) == id)
2009 LOG (GNUNET_ERROR_TYPE_DEBUG, " BCK FC\n");
2014 GNUNET_break_op (0);
2018 pid = ntohl (msg->pid);
2019 LOG (GNUNET_ERROR_TYPE_DEBUG, " PID %u, OLD %u\n", pid, fc->last_pid_recv);
2020 fc->last_pid_recv = pid;
2021 fwd = fc == &c->bck_fc;
2022 GMC_send_ack (c, fwd, GNUNET_YES);
2029 * Core handler for mesh keepalives.
2031 * @param cls closure
2032 * @param message message
2033 * @param peer peer identity this notification is about
2034 * @return GNUNET_OK to keep the connection open,
2035 * GNUNET_SYSERR to close it (signal serious error)
2037 * TODO: Check who we got this from, to validate route.
2040 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
2041 const struct GNUNET_MessageHeader *message)
2043 struct GNUNET_MESH_ConnectionKeepAlive *msg;
2044 struct MeshConnection *c;
2045 struct MeshPeer *neighbor;
2046 GNUNET_PEER_Id peer_id;
2049 msg = (struct GNUNET_MESH_ConnectionKeepAlive *) message;
2050 LOG (GNUNET_ERROR_TYPE_DEBUG, "got a keepalive packet from %s\n",
2053 c = connection_get (&msg->cid);
2056 GNUNET_STATISTICS_update (stats, "# keepalive on unknown connection", 1,
2061 /* Check if origin is as expected TODO refactor and reuse */
2062 peer_id = GNUNET_PEER_search (peer);
2063 neighbor = get_prev_hop (c);
2064 if (peer_id == GMP_get_short_id (neighbor))
2070 neighbor = get_next_hop (c);
2071 if (peer_id == GMP_get_short_id (neighbor))
2077 GNUNET_break_op (0);
2082 connection_change_state (c, MESH_CONNECTION_READY);
2083 connection_reset_timeout (c, fwd);
2085 if (GMC_is_terminal (c, fwd))
2088 GNUNET_STATISTICS_update (stats, "# keepalives forwarded", 1, GNUNET_NO);
2089 GMC_send_prebuilt_message (message, c, fwd, GNUNET_YES, NULL, NULL);
2096 * Send an ACK on the appropriate connection/channel, depending on
2097 * the direction and the position of the peer.
2099 * @param c Which connection to send the hop-by-hop ACK.
2100 * @param fwd Is this a fwd ACK? (will go dest->root).
2101 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
2104 GMC_send_ack (struct MeshConnection *c, int fwd, int force)
2106 unsigned int buffer;
2108 LOG (GNUNET_ERROR_TYPE_DEBUG,
2109 "GMC send %s ACK on %s\n",
2110 GM_f2s (fwd), GMC_2s (c));
2118 if (GNUNET_NO != c->destroy)
2120 LOG (GNUNET_ERROR_TYPE_DEBUG, " being destroyed, why bother...\n");
2124 /* Get available buffer space */
2125 if (GMC_is_terminal (c, fwd))
2127 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from all channels\n");
2128 buffer = GMT_get_channels_buffer (c->t);
2132 LOG (GNUNET_ERROR_TYPE_DEBUG, " getting from one connection\n");
2133 buffer = GMC_get_buffer (c, fwd);
2135 LOG (GNUNET_ERROR_TYPE_DEBUG, " buffer available: %u\n", buffer);
2136 if (0 == buffer && GNUNET_NO == force)
2139 /* Send available buffer space */
2140 if (GMC_is_origin (c, fwd))
2142 GNUNET_assert (NULL != c->t);
2143 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on channels...\n");
2144 GMT_unchoke_channels (c->t);
2148 LOG (GNUNET_ERROR_TYPE_DEBUG, " sending on connection\n");
2149 send_ack (c, buffer, fwd, force);
2155 * Initialize the connections subsystem
2157 * @param c Configuration handle.
2160 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c)
2162 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
2164 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_MSGS_QUEUE",
2167 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2168 "MESH", "MAX_MSGS_QUEUE", "MISSING");
2169 GNUNET_SCHEDULER_shutdown ();
2174 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_CONNECTIONS",
2177 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2178 "MESH", "MAX_CONNECTIONS", "MISSING");
2179 GNUNET_SCHEDULER_shutdown ();
2184 GNUNET_CONFIGURATION_get_value_time (c, "MESH", "REFRESH_CONNECTION_TIME",
2185 &refresh_connection_time))
2187 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_ERROR,
2188 "MESH", "REFRESH_CONNECTION_TIME", "MISSING");
2189 GNUNET_SCHEDULER_shutdown ();
2192 create_connection_time = GNUNET_TIME_UNIT_SECONDS;
2193 connections = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
2198 * Destroy each connection on shutdown.
2200 * @param cls Closure (unused).
2201 * @param key Current key code (CID, unused).
2202 * @param value Value in the hash map (connection)
2204 * @return #GNUNET_YES, because we should continue to iterate,
2207 shutdown_iterator (void *cls,
2208 const struct GNUNET_HashCode *key,
2211 struct MeshConnection *c = value;
2219 * Shut down the connections subsystem.
2224 GNUNET_CONTAINER_multihashmap_iterate (connections, &shutdown_iterator, NULL);
2225 GNUNET_CONTAINER_multihashmap_destroy (connections);
2230 struct MeshConnection *
2231 GMC_new (const struct GNUNET_HashCode *cid,
2232 struct MeshTunnel3 *t,
2233 struct MeshPeerPath *p,
2234 unsigned int own_pos)
2236 struct MeshConnection *c;
2238 c = GNUNET_new (struct MeshConnection);
2240 GNUNET_assert (GNUNET_OK ==
2241 GNUNET_CONTAINER_multihashmap_put (connections,
2243 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2244 fc_init (&c->fwd_fc);
2245 fc_init (&c->bck_fc);
2250 GNUNET_assert (own_pos <= p->length - 1);
2251 c->own_pos = own_pos;
2254 if (GNUNET_OK != register_neighbors (c))
2258 GMT_remove_path (c->t, p);
2268 c->fwd_maintenance_task =
2269 GNUNET_SCHEDULER_add_delayed (create_connection_time,
2270 &connection_fwd_keepalive, c);
2278 GMC_destroy (struct MeshConnection *c)
2286 if (2 == c->destroy) /* cancel queues -> GMP_queue_cancel -> q_destroy -> */
2287 return; /* -> message_sent -> GMC_destroy. Don't loop. */
2290 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroying connection %s\n", GMC_2s (c));
2291 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc's f: %p, b: %p\n",
2292 &c->fwd_fc, &c->bck_fc);
2293 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2294 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2296 /* Cancel all traffic */
2297 if (NULL != c->path)
2299 connection_cancel_queues (c, GNUNET_YES);
2300 connection_cancel_queues (c, GNUNET_NO);
2301 unregister_neighbors (c);
2304 LOG (GNUNET_ERROR_TYPE_DEBUG, " fc tasks f: %u, b: %u\n",
2305 c->fwd_fc.poll_task, c->bck_fc.poll_task);
2307 /* Cancel maintainance task (keepalive/timeout) */
2308 if (NULL != c->fwd_fc.poll_msg)
2310 GMC_cancel (c->fwd_fc.poll_msg);
2311 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg FWD canceled\n");
2313 if (NULL != c->bck_fc.poll_msg)
2315 GMC_cancel (c->bck_fc.poll_msg);
2316 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL msg BCK canceled\n");
2319 /* Delete from tunnel */
2321 GMT_remove_connection (c->t, c);
2323 if (GNUNET_NO == GMC_is_origin (c, GNUNET_YES) && NULL != c->path)
2324 path_destroy (c->path);
2325 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_maintenance_task)
2326 GNUNET_SCHEDULER_cancel (c->fwd_maintenance_task);
2327 if (GNUNET_SCHEDULER_NO_TASK != c->bck_maintenance_task)
2328 GNUNET_SCHEDULER_cancel (c->bck_maintenance_task);
2329 if (GNUNET_SCHEDULER_NO_TASK != c->fwd_fc.poll_task)
2331 GNUNET_SCHEDULER_cancel (c->fwd_fc.poll_task);
2332 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL FWD canceled\n");
2334 if (GNUNET_SCHEDULER_NO_TASK != c->bck_fc.poll_task)
2336 GNUNET_SCHEDULER_cancel (c->bck_fc.poll_task);
2337 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL BCK canceled\n");
2340 GNUNET_break (GNUNET_YES ==
2341 GNUNET_CONTAINER_multihashmap_remove (connections, &c->id, c));
2343 GNUNET_STATISTICS_update (stats, "# connections", -1, GNUNET_NO);
2348 * Get the connection ID.
2350 * @param c Connection to get the ID from.
2352 * @return ID of the connection.
2354 const struct GNUNET_HashCode *
2355 GMC_get_id (const struct MeshConnection *c)
2362 * Get the connection path.
2364 * @param c Connection to get the path from.
2366 * @return path used by the connection.
2368 const struct MeshPeerPath *
2369 GMC_get_path (const struct MeshConnection *c)
2371 if (GNUNET_NO == c->destroy)
2378 * Get the connection state.
2380 * @param c Connection to get the state from.
2382 * @return state of the connection.
2384 enum MeshConnectionState
2385 GMC_get_state (const struct MeshConnection *c)
2391 * Get the connection tunnel.
2393 * @param c Connection to get the tunnel from.
2395 * @return tunnel of the connection.
2397 struct MeshTunnel3 *
2398 GMC_get_tunnel (const struct MeshConnection *c)
2405 * Get free buffer space in a connection.
2407 * @param c Connection.
2408 * @param fwd Is query about FWD traffic?
2410 * @return Free buffer space [0 - max_msgs_queue/max_connections]
2413 GMC_get_buffer (struct MeshConnection *c, int fwd)
2415 struct MeshFlowControl *fc;
2417 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2419 return (fc->queue_max - fc->queue_n);
2423 * Get how many messages have we allowed to send to us from a direction.
2425 * @param c Connection.
2426 * @param fwd Are we asking about traffic from FWD (BCK messages)?
2428 * @return last_ack_sent - last_pid_recv
2431 GMC_get_allowed (struct MeshConnection *c, int fwd)
2433 struct MeshFlowControl *fc;
2435 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2436 if (GM_is_pid_bigger(fc->last_pid_recv, fc->last_ack_sent))
2440 return (fc->last_ack_sent - fc->last_pid_recv);
2444 * Get messages queued in a connection.
2446 * @param c Connection.
2447 * @param fwd Is query about FWD traffic?
2449 * @return Number of messages queued.
2452 GMC_get_qn (struct MeshConnection *c, int fwd)
2454 struct MeshFlowControl *fc;
2456 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2463 * Allow the connection to advertise a buffer of the given size.
2465 * The connection will send an @c fwd ACK message (so: in direction !fwd)
2466 * allowing up to last_pid_recv + buffer.
2468 * @param c Connection.
2469 * @param buffer How many more messages the connection can accept.
2470 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
2473 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd)
2475 LOG (GNUNET_ERROR_TYPE_DEBUG, " allowing %s %u messages %s\n",
2476 GMC_2s (c), buffer, GM_f2s (fwd));
2477 send_ack (c, buffer, fwd, GNUNET_NO);
2482 * Notify other peers on a connection of a broken link. Mark connections
2483 * to destroy after all traffic has been sent.
2485 * @param c Connection on which there has been a disconnection.
2486 * @param peer Peer that disconnected.
2489 GMC_notify_broken (struct MeshConnection *c,
2490 struct MeshPeer *peer)
2494 LOG (GNUNET_ERROR_TYPE_DEBUG,
2495 " notify broken on %s due to %s disconnect\n",
2496 GMC_2s (c), GMP_2s (peer));
2498 fwd = peer == get_prev_hop (c);
2500 if (GNUNET_YES == GMC_is_terminal (c, fwd))
2502 /* Local shutdown, no one to notify about this. */
2506 if (GNUNET_NO == c->destroy)
2507 send_broken (c, &my_full_id, GMP_get_id (peer), fwd);
2509 /* Connection will have at least one pending message
2510 * (the one we just scheduled), so no point in checking whether to
2511 * destroy immediately. */
2512 c->destroy = GNUNET_YES;
2513 c->state = MESH_CONNECTION_DESTROYED;
2516 * Cancel all queues, if no message is left, connection will be destroyed.
2518 connection_cancel_queues (c, !fwd);
2525 * Is this peer the first one on the connection?
2527 * @param c Connection.
2528 * @param fwd Is this about fwd traffic?
2530 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
2533 GMC_is_origin (struct MeshConnection *c, int fwd)
2535 if (!fwd && c->path->length - 1 == c->own_pos )
2537 if (fwd && 0 == c->own_pos)
2544 * Is this peer the last one on the connection?
2546 * @param c Connection.
2547 * @param fwd Is this about fwd traffic?
2548 * Note that the ROOT is the terminal for BCK traffic!
2550 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
2553 GMC_is_terminal (struct MeshConnection *c, int fwd)
2555 return GMC_is_origin (c, !fwd);
2560 * See if we are allowed to send by the next hop in the given direction.
2562 * @param c Connection.
2563 * @param fwd Is this about fwd traffic?
2565 * @return #GNUNET_YES in case it's OK to send.
2568 GMC_is_sendable (struct MeshConnection *c, int fwd)
2570 struct MeshFlowControl *fc;
2572 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2573 if (GM_is_pid_bigger (fc->last_ack_recv, fc->last_pid_sent))
2579 * Sends an already built message on a connection, properly registering
2580 * all used resources.
2582 * @param message Message to send. Function makes a copy of it.
2583 * If message is not hop-by-hop, decrements TTL of copy.
2584 * @param c Connection on which this message is transmitted.
2585 * @param fwd Is this a fwd message?
2586 * @param force Force the connection to accept the message (buffer overfill).
2587 * @param cont Continuation called once message is sent. Can be NULL.
2588 * @param cont_cls Closure for @c cont.
2590 * @return Handle to cancel the message before it's sent.
2591 * NULL on error or if @c cont is NULL.
2592 * Invalid on @c cont call.
2594 struct MeshConnectionQueue *
2595 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
2596 struct MeshConnection *c, int fwd, int force,
2597 GMC_sent cont, void *cont_cls)
2599 struct MeshFlowControl *fc;
2600 struct MeshConnectionQueue *q;
2606 size = ntohs (message->size);
2607 data = GNUNET_malloc (size);
2608 memcpy (data, message, size);
2609 type = ntohs (message->type);
2610 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send %s (%u bytes) on connection %s\n",
2611 GM_m2s (type), size, GMC_2s (c));
2613 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2614 droppable = GNUNET_NO == force;
2617 struct GNUNET_MESH_Encrypted *emsg;
2618 struct GNUNET_MESH_KX *kmsg;
2619 struct GNUNET_MESH_ACK *amsg;
2620 struct GNUNET_MESH_Poll *pmsg;
2621 struct GNUNET_MESH_ConnectionDestroy *dmsg;
2622 struct GNUNET_MESH_ConnectionBroken *bmsg;
2625 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
2626 emsg = (struct GNUNET_MESH_Encrypted *) data;
2627 ttl = ntohl (emsg->ttl);
2630 GNUNET_break_op (0);
2635 emsg->ttl = htonl (ttl - 1);
2636 emsg->pid = htonl (fc->next_pid++);
2637 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
2638 if (GNUNET_YES == droppable)
2641 LOG (GNUNET_ERROR_TYPE_DEBUG, "pid %u\n", ntohl (emsg->pid));
2642 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid sent %u\n", fc->last_pid_sent);
2643 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack recv %u\n", fc->last_ack_recv);
2647 LOG (GNUNET_ERROR_TYPE_DEBUG, " not droppable, Q_N stays the same\n");
2649 if (GM_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
2651 GMC_start_poll (c, fwd);
2655 case GNUNET_MESSAGE_TYPE_MESH_KX:
2656 kmsg = (struct GNUNET_MESH_KX *) data;
2660 case GNUNET_MESSAGE_TYPE_MESH_ACK:
2661 amsg = (struct GNUNET_MESH_ACK *) data;
2663 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", ntohl (amsg->ack));
2664 droppable = GNUNET_NO;
2667 case GNUNET_MESSAGE_TYPE_MESH_POLL:
2668 pmsg = (struct GNUNET_MESH_Poll *) data;
2670 LOG (GNUNET_ERROR_TYPE_DEBUG, " poll %u\n", ntohl (pmsg->pid));
2671 droppable = GNUNET_NO;
2674 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
2675 dmsg = (struct GNUNET_MESH_ConnectionDestroy *) data;
2680 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
2681 bmsg = (struct GNUNET_MESH_ConnectionBroken *) data;
2686 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
2687 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
2688 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
2697 if (fc->queue_n > fc->queue_max && droppable)
2699 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
2702 LOG (GNUNET_ERROR_TYPE_DEBUG,
2703 "queue full: %u/%u\n",
2704 fc->queue_n, fc->queue_max);
2705 if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == type)
2711 return NULL; /* Drop this message */
2714 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u\n", c, c->pending_messages);
2715 c->pending_messages++;
2717 q = GNUNET_new (struct MeshConnectionQueue);
2718 q->forced = !droppable;
2719 q->q = GMP_queue_add (get_hop (c, fwd), data, type, size, c, fwd,
2723 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING dropping msg on %s\n", GMC_2s (c));
2729 q->cont_cls = cont_cls;
2735 * Cancel a previously sent message while it's in the queue.
2737 * ONLY can be called before the continuation given to the send function
2738 * is called. Once the continuation is called, the message is no longer in the
2741 * @param q Handle to the queue.
2744 GMC_cancel (struct MeshConnectionQueue *q)
2746 LOG (GNUNET_ERROR_TYPE_DEBUG, "! GMC cancel message\n");
2748 /* queue destroy calls message_sent, which calls q->cont and frees q */
2749 GMP_queue_destroy (q->q, GNUNET_YES);
2754 * Sends a CREATE CONNECTION message for a path to a peer.
2755 * Changes the connection and tunnel states if necessary.
2757 * @param connection Connection to create.
2760 GMC_send_create (struct MeshConnection *connection)
2762 enum MeshTunnel3CState state;
2765 size = sizeof (struct GNUNET_MESH_ConnectionCreate);
2766 size += connection->path->length * sizeof (struct GNUNET_PeerIdentity);
2768 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send connection create\n");
2769 LOG (GNUNET_ERROR_TYPE_DEBUG, " C_P+ %p %u (create)\n",
2770 connection, connection->pending_messages);
2771 connection->pending_messages++;
2773 GMP_queue_add (get_next_hop (connection), NULL,
2774 GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
2775 size, connection, GNUNET_YES, &message_sent, NULL);
2777 state = GMT_get_cstate (connection->t);
2778 if (MESH_TUNNEL3_SEARCHING == state || MESH_TUNNEL3_NEW == state)
2779 GMT_change_cstate (connection->t, MESH_TUNNEL3_WAITING);
2780 if (MESH_CONNECTION_NEW == connection->state)
2781 connection_change_state (connection, MESH_CONNECTION_SENT);
2786 * Send a message to all peers in this connection that the connection
2787 * is no longer valid.
2789 * If some peer should not receive the message, it should be zero'ed out
2790 * before calling this function.
2792 * @param c The connection whose peers to notify.
2795 GMC_send_destroy (struct MeshConnection *c)
2797 struct GNUNET_MESH_ConnectionDestroy msg;
2799 if (GNUNET_YES == c->destroy)
2802 msg.header.size = htons (sizeof (msg));
2803 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY);;
2805 LOG (GNUNET_ERROR_TYPE_DEBUG,
2806 " sending connection destroy for connection %s\n",
2809 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_YES))
2810 GMC_send_prebuilt_message (&msg.header, c,
2811 GNUNET_YES, GNUNET_YES, NULL, NULL);
2812 if (GNUNET_NO == GMC_is_terminal (c, GNUNET_NO))
2813 GMC_send_prebuilt_message (&msg.header, c,
2814 GNUNET_NO, GNUNET_YES, NULL, NULL);
2815 c->destroy = GNUNET_YES;
2816 c->state = MESH_CONNECTION_DESTROYED;
2821 * @brief Start a polling timer for the connection.
2823 * When a neighbor does not accept more traffic on the connection it could be
2824 * caused by a simple congestion or by a lost ACK. Polling enables to check
2825 * for the lastest ACK status for a connection.
2827 * @param c Connection.
2828 * @param fwd Should we poll in the FWD direction?
2831 GMC_start_poll (struct MeshConnection *c, int fwd)
2833 struct MeshFlowControl *fc;
2835 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2836 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL %s requested\n",
2838 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task || NULL != fc->poll_msg)
2840 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** not needed (%u, %p)\n",
2841 fc->poll_task, fc->poll_msg);
2844 LOG (GNUNET_ERROR_TYPE_DEBUG, " *** POLL started on request\n");
2845 fc->poll_task = GNUNET_SCHEDULER_add_delayed (fc->poll_time,
2852 * @brief Stop polling a connection for ACKs.
2854 * Once we have enough ACKs for future traffic, polls are no longer necessary.
2856 * @param c Connection.
2857 * @param fwd Should we stop the poll in the FWD direction?
2860 GMC_stop_poll (struct MeshConnection *c, int fwd)
2862 struct MeshFlowControl *fc;
2864 fc = fwd ? &c->fwd_fc : &c->bck_fc;
2865 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
2867 GNUNET_SCHEDULER_cancel (fc->poll_task);
2868 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
2873 * Get a (static) string for a connection.
2875 * @param c Connection.
2878 GMC_2s (struct MeshConnection *c)
2885 static char buf[128];
2887 sprintf (buf, "%s (->%s)", GNUNET_h2s (&c->id), GMT_2s (c->t));
2890 return GNUNET_h2s (&c->id);