2 This file is part of GNUnet.
3 (C) 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.
23 #include "gnunet_util_lib.h"
25 #include "gnunet_core_service.h"
26 #include "gnunet_statistics_service.h"
28 #include "mesh_protocol_enc.h"
30 #include "gnunet-service-mesh_peer.h"
31 #include "gnunet-service-mesh_dht.h"
32 #include "gnunet-service-mesh_connection.h"
33 #include "gnunet-service-mesh_local.h"
34 #include "gnunet-service-mesh_tunnel.h"
35 #include "mesh_path.h"
37 #define LOG(level, ...) GNUNET_log_from (level,"mesh-p2p",__VA_ARGS__)
39 /******************************************************************************/
40 /******************************** STRUCTS **********************************/
41 /******************************************************************************/
44 * Struct containing info about a queued transmission to this peer
51 struct MeshPeerQueue *next;
56 struct MeshPeerQueue *prev;
59 * Peer this transmission is directed to.
61 struct MeshPeer *peer;
64 * Connection this message belongs to.
66 struct MeshConnection *c;
74 * Channel this message belongs to, if known.
76 struct MeshChannel *ch;
79 * Pointer to info stucture used as cls.
94 * Set when this message starts waiting for CORE.
96 struct GNUNET_TIME_Absolute start_waiting;
99 * Function to call on sending.
104 * Closure for callback.
110 * Struct containing all information regarding a given peer
120 * Last time we heard from this peer
122 struct GNUNET_TIME_Absolute last_contact;
125 * Paths to reach the peer, ordered by ascending hop count
127 struct MeshPeerPath *path_head;
130 * Paths to reach the peer, ordered by ascending hop count
132 struct MeshPeerPath *path_tail;
135 * Handle to stop the DHT search for paths to this peer
137 struct GMD_search_handle *search_h;
140 * Tunnel to this peer, if any.
142 struct MeshTunnel3 *tunnel;
145 * Connections that go through this peer, indexed by tid;
147 struct GNUNET_CONTAINER_MultiHashMap *connections;
150 * Handle for queued transmissions
152 struct GNUNET_CORE_TransmitHandle *core_transmit;
155 * Transmission queue to core DLL head
157 struct MeshPeerQueue *queue_head;
160 * Transmission queue to core DLL tail
162 struct MeshPeerQueue *queue_tail;
165 * How many messages are in the queue to this peer.
167 unsigned int queue_n;
171 /******************************************************************************/
172 /******************************* GLOBALS ***********************************/
173 /******************************************************************************/
176 * Global handle to the statistics service.
178 extern struct GNUNET_STATISTICS_Handle *stats;
181 * Local peer own ID (full value).
183 extern struct GNUNET_PeerIdentity my_full_id;
186 * Local peer own ID (short)
188 extern GNUNET_PEER_Id myid;
191 * Peers known, indexed by PeerIdentity (MeshPeer).
193 static struct GNUNET_CONTAINER_MultiPeerMap *peers;
196 * How many peers do we want to remember?
198 static unsigned long long max_peers;
201 * Percentage of messages that will be dropped (for test purposes only).
203 static unsigned long long drop_percent;
206 * Handle to communicate with core.
208 static struct GNUNET_CORE_Handle *core_handle;
211 /******************************************************************************/
212 /***************************** CORE CALLBACKS *********************************/
213 /******************************************************************************/
217 * Iterator to notify all connections of a broken link. Mark connections
218 * to destroy after all traffic has been sent.
220 * @param cls Closure (peer disconnected).
221 * @param key Current key code (peer id).
222 * @param value Value in the hash map (connection).
224 * @return GNUNET_YES if we should continue to iterate,
228 notify_broken (void *cls,
229 const struct GNUNET_HashCode *key,
232 struct MeshPeer *peer = cls;
233 struct MeshConnection *c = value;
235 GMC_notify_broken (c, peer, &my_full_id);
242 * Method called whenever a given peer connects.
245 * @param peer peer identity this notification is about
248 core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
251 struct MeshPeerPath *path;
253 LOG ("Peer connected\n");
254 LOG (" %s\n", GNUNET_i2s (&my_full_id));
263 LOG (" %s\n", GNUNET_i2s (peer));
265 path->peers[1] = pi->id;
266 GNUNET_PEER_change_rc (pi->id, 1);
267 GNUNET_STATISTICS_update (stats, "# peers", 1, GNUNET_NO);
269 path->peers[0] = myid;
270 GNUNET_PEER_change_rc (myid, 1);
271 peer_add_path (pi, path, GNUNET_YES);
273 pi->connections = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_YES);
279 * Method called whenever a peer disconnects.
282 * @param peer peer identity this notification is about
285 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
289 LOG ("Peer disconnected\n");
290 pi = GNUNET_CONTAINER_multipeermap_get (peers, peer);
297 GNUNET_CONTAINER_multihashmap_iterate (pi->connections, ¬ify_broken, pi);
298 GNUNET_CONTAINER_multihashmap_destroy (pi->connections);
299 pi->connections = NULL;
300 if (NULL != pi->core_transmit)
302 GNUNET_CORE_notify_transmit_ready_cancel (pi->core_transmit);
303 pi->core_transmit = NULL;
309 GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
316 * Functions to handle messages from core
318 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
319 {&GMC_handle_create, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
321 {&GMC_handle_confirm, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
322 sizeof (struct GNUNET_MESH_ConnectionACK)},
323 {&GMC_handle_broken, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
324 sizeof (struct GNUNET_MESH_ConnectionBroken)},
325 {&GMC_handle_destroy, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY,
326 sizeof (struct GNUNET_MESH_ConnectionDestroy)},
327 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_FWD_KEEPALIVE,
328 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
329 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_BCK_KEEPALIVE,
330 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
331 {&GMC_handle_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
332 sizeof (struct GNUNET_MESH_ACK)},
333 {&GMC_handle_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
334 sizeof (struct GNUNET_MESH_Poll)},
335 {&GMC_handle_fwd, GNUNET_MESSAGE_TYPE_MESH_FWD, 0},
336 {&GMC_handle_bck, GNUNET_MESSAGE_TYPE_MESH_BCK, 0},
342 * To be called on core init/fail.
344 * @param cls Closure (config)
345 * @param identity the public identity of this peer
348 core_init (void *cls,
349 const struct GNUNET_PeerIdentity *identity)
351 const struct GNUNET_CONFIGURATION_Handle *c = cls;
354 LOG (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
355 if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)))
357 LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
358 LOG (GNUNET_ERROR_TYPE_ERROR, " core id %s\n", GNUNET_i2s (identity));
359 LOG (GNUNET_ERROR_TYPE_ERROR, " my id %s\n", GNUNET_i2s (&my_full_id));
360 GNUNET_CORE_disconnect (core_handle);
361 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
362 NULL, /* Closure passed to MESH functions */
363 &core_init, /* Call core_init once connected */
364 &core_connect, /* Handle connects */
365 &core_disconnect, /* remove peers on disconnects */
366 NULL, /* Don't notify about all incoming messages */
367 GNUNET_NO, /* For header only in notification */
368 NULL, /* Don't notify about all outbound messages */
369 GNUNET_NO, /* For header-only out notification */
370 core_handlers); /* Register these handlers */
379 * Core callback to write a pre-constructed data packet to core buffer
381 * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
382 * @param size Number of bytes available in buf.
383 * @param buf Where the to write the message.
385 * @return number of bytes written to buf
388 send_core_data_raw (void *cls, size_t size, void *buf)
390 struct GNUNET_MessageHeader *msg = cls;
393 GNUNET_assert (NULL != msg);
394 total_size = ntohs (msg->size);
396 if (total_size > size)
401 memcpy (buf, msg, total_size);
408 * Function to send a create connection message to a peer.
410 * @param c Connection to create.
411 * @param size number of bytes available in buf
412 * @param buf where the callee should write the message
413 * @return number of bytes written to buf
416 send_core_connection_create (struct MeshConnection *c, size_t size, void *buf)
418 struct GNUNET_MESH_ConnectionCreate *msg;
419 struct GNUNET_PeerIdentity *peer_ptr;
420 struct MeshPeerPath *p = c->path;
424 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
426 sizeof (struct GNUNET_MESH_ConnectionCreate) +
427 p->length * sizeof (struct GNUNET_PeerIdentity);
429 if (size < size_needed || NULL == buf)
434 msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
435 msg->header.size = htons (size_needed);
436 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
439 peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
440 for (i = 0; i < p->length; i++)
442 GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
445 LOG (GNUNET_ERROR_TYPE_DEBUG,
446 "CONNECTION CREATE (%u bytes long) sent!\n", size_needed);
452 * Creates a path ack message in buf and frees all unused resources.
454 * @param c Connection to send an ACK on.
455 * @param size number of bytes available in buf
456 * @param buf where the callee should write the message
458 * @return number of bytes written to buf
461 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
463 struct GNUNET_MESH_ConnectionACK *msg = buf;
464 struct MeshTunnel3 *t = c->t;
466 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
467 GNUNET_assert (NULL != t);
468 if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
473 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
474 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
478 /* TODO add signature */
480 LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
481 return sizeof (struct GNUNET_MESH_ConnectionACK);
485 /******************************************************************************/
486 /******************************** STATIC ***********************************/
487 /******************************************************************************/
490 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
493 * @param key current key code
494 * @param value value in the hash map
495 * @return #GNUNET_YES if we should continue to iterate,
499 shutdown_tunnel (void *cls,
500 const struct GNUNET_PeerIdentity *key,
503 struct MeshPeer *p = value;
504 struct MeshTunnel3 *t = p->tunnel;
514 * Destroy the peer_info and free any allocated resources linked to it
516 * @param peer The peer_info to destroy.
518 * @return GNUNET_OK on success
521 peer_destroy (struct MeshPeer *peer)
523 struct GNUNET_PeerIdentity id;
524 struct MeshPeerPath *p;
525 struct MeshPeerPath *nextp;
527 GNUNET_PEER_resolve (peer->id, &id);
528 GNUNET_PEER_change_rc (peer->id, -1);
531 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
534 LOG (GNUNET_ERROR_TYPE_WARNING,
535 "removing peer %s, not in peermap\n", GNUNET_i2s (&id));
537 if (NULL != peer->search_h)
539 GMD_search_stop (peer->search_h);
545 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
549 tunnel_destroy_empty (peer->tunnel);
556 * Returns if peer is used (has a tunnel, is neighbor).
558 * @peer Peer to check.
560 * @return GNUNET_YES if peer is in use.
563 peer_is_used (struct MeshPeer *peer)
565 struct MeshPeerPath *p;
567 if (NULL != peer->tunnel)
570 for (p = peer->path_head; NULL != p; p = p->next)
580 * Iterator over all the peers to get the oldest timestamp.
582 * @param cls Closure (unsued).
583 * @param key ID of the peer.
584 * @param value Peer_Info of the peer.
587 peer_get_oldest (void *cls,
588 const struct GNUNET_PeerIdentity *key,
591 struct MeshPeer *p = value;
592 struct GNUNET_TIME_Absolute *abs = cls;
594 /* Don't count active peers */
595 if (GNUNET_YES == peer_is_used (p))
598 if (abs->abs_value_us < p->last_contact.abs_value_us)
599 abs->abs_value_us = p->last_contact.abs_value_us;
606 * Iterator over all the peers to remove the oldest entry.
608 * @param cls Closure (unsued).
609 * @param key ID of the peer.
610 * @param value Peer_Info of the peer.
613 peer_timeout (void *cls,
614 const struct GNUNET_PeerIdentity *key,
617 struct MeshPeer *p = value;
618 struct GNUNET_TIME_Absolute *abs = cls;
620 if (p->last_contact.abs_value_us == abs->abs_value_us &&
621 GNUNET_NO == peer_is_used (p))
631 * Delete oldest unused peer.
634 peer_delete_oldest (void)
636 struct GNUNET_TIME_Absolute abs;
638 abs = GNUNET_TIME_UNIT_FOREVER_ABS;
640 GNUNET_CONTAINER_multipeermap_iterate (peers,
643 GNUNET_CONTAINER_multipeermap_iterate (peers,
650 * Get a cost of a path for a peer considering existing tunnel connections.
652 * @param peer Peer towards which the path is considered.
653 * @param path Candidate path.
655 * @return Cost of the path (path length + number of overlapping nodes)
658 peer_get_path_cost (const struct MeshPeer *peer,
659 const struct MeshPeerPath *path)
661 struct MeshConnection *c;
662 unsigned int overlap;
670 GNUNET_assert (NULL != peer->tunnel);
672 for (i = 0; i < path->length; i++)
674 for (c = peer->tunnel->connection_head; NULL != c; c = c->next)
676 for (j = 0; j < c->path->length; j++)
678 if (path->peers[i] == c->path->peers[j])
686 return (path->length + overlap) * (path->score * -1);
691 * Choose the best path towards a peer considering the tunnel properties.
693 * @param peer The destination peer.
695 * @return Best current known path towards the peer, if any.
697 static struct MeshPeerPath *
698 peer_get_best_path (const struct MeshPeer *peer)
700 struct MeshPeerPath *best_p;
701 struct MeshPeerPath *p;
702 struct MeshConnection *c;
703 unsigned int best_cost;
706 best_cost = UINT_MAX;
708 for (p = peer->path_head; NULL != p; p = p->next)
710 for (c = peer->tunnel->connection_head; NULL != c; c = c->next)
714 continue; /* If path is in use in a connection, skip it. */
716 if ((cost = peer_get_path_cost (peer, p)) < best_cost)
727 * Function to process paths received for a new peer addition. The recorded
728 * paths form the initial tunnel, which can be optimized later.
729 * Called on each result obtained for the DHT search.
735 search_handler (void *cls, const struct MeshPeerPath *path)
737 struct MeshPeer *peer = cls;
738 unsigned int connection_count;
740 path_add_to_peers (path, GNUNET_NO);
742 /* Count connections */
743 connection_count = GMC_count (peer->tunnel->connection_head);
745 /* If we already have 3 (or more (?!)) connections, it's enough */
746 if (3 <= connection_count)
749 if (peer->tunnel->state == MESH_TUNNEL3_SEARCHING)
751 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
759 * Core callback to write a queued packet to core buffer
761 * @param cls Closure (peer info).
762 * @param size Number of bytes available in buf.
763 * @param buf Where the to write the message.
765 * @return number of bytes written to buf
768 queue_send (void *cls, size_t size, void *buf)
770 struct MeshPeer *peer = cls;
771 struct MeshFlowControl *fc;
772 struct MeshConnection *c;
773 struct GNUNET_MessageHeader *msg;
774 struct MeshPeerQueue *queue;
775 struct MeshTunnel3 *t;
776 struct MeshChannel *ch;
777 const struct GNUNET_PeerIdentity *dst_id;
783 peer->core_transmit = NULL;
784 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send (max %u)\n", size);
786 if (NULL == buf || 0 == size)
788 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
793 queue = peer_get_first_message (peer);
796 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
801 fc = fwd ? &c->fwd_fc : &c->bck_fc;
803 dst_id = GNUNET_PEER_resolve2 (peer->id);
804 LOG (GNUNET_ERROR_TYPE_DEBUG, "* towards %s\n", GNUNET_i2s (dst_id));
805 /* Check if buffer size is enough for the message */
806 if (queue->size > size)
808 LOG (GNUNET_ERROR_TYPE_DEBUG, "* not enough room, reissue\n");
809 peer->core_transmit =
810 GNUNET_CORE_notify_transmit_ready (core_handle,
813 GNUNET_TIME_UNIT_FOREVER_REL,
820 LOG (GNUNET_ERROR_TYPE_DEBUG, "* size %u ok\n", queue->size);
822 t = (NULL != c) ? c->t : NULL;
828 case GNUNET_MESSAGE_TYPE_MESH_TUNNEL3_DESTROY:
829 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
830 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
831 case GNUNET_MESSAGE_TYPE_MESH_FWD:
832 case GNUNET_MESSAGE_TYPE_MESH_BCK:
833 case GNUNET_MESSAGE_TYPE_MESH_ACK:
834 case GNUNET_MESSAGE_TYPE_MESH_POLL:
835 LOG (GNUNET_ERROR_TYPE_DEBUG,
837 GNUNET_MESH_DEBUG_M2S (queue->type));
838 data_size = send_core_data_raw (queue->cls, size, buf);
839 msg = (struct GNUNET_MessageHeader *) buf;
840 type = ntohs (msg->type);
842 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
843 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
844 if (GMC_is_origin (c, GNUNET_YES))
845 data_size = send_core_connection_create (queue->c, size, buf);
847 data_size = send_core_data_raw (queue->cls, size, buf);
849 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
850 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
851 if (GMC_is_origin (c, GNUNET_NO) ||
852 GMC_is_origin (c, GNUNET_YES))
853 data_size = send_core_connection_ack (queue->c, size, buf);
855 data_size = send_core_data_raw (queue->cls, size, buf);
857 case GNUNET_MESSAGE_TYPE_MESH_DATA:
858 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
859 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
860 /* This should be encapsulted */
866 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n",
871 if (0 < drop_percent &&
872 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
874 LOG (GNUNET_ERROR_TYPE_WARNING,
875 "Dropping message of type %s\n",
876 GNUNET_MESH_DEBUG_M2S (queue->type));
880 if (NULL != queue->callback)
882 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Calling callback\n");
883 queue->callback (queue->callback_cls,
885 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
888 /* Free queue, but cls was freed by send_core_* */
890 GMP_queue_destroy (queue, GNUNET_NO);
892 /* Send ACK if needed, after accounting for sent ID in fc->queue_n */
895 case GNUNET_MESSAGE_TYPE_MESH_FWD:
896 case GNUNET_MESSAGE_TYPE_MESH_BCK:
897 pid = ntohl ( ((struct GNUNET_MESH_Encrypted *) buf)->pid );
898 LOG (GNUNET_ERROR_TYPE_DEBUG, "* accounting pid %u\n", pid);
899 fc->last_pid_sent = pid;
900 send_ack (c, ch, fwd);
906 /* If more data in queue, send next */
907 queue = peer_get_first_message (peer);
910 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
911 if (NULL == peer->core_transmit) {
912 peer->core_transmit =
913 GNUNET_CORE_notify_transmit_ready(core_handle,
916 GNUNET_TIME_UNIT_FOREVER_REL,
921 queue->start_waiting = GNUNET_TIME_absolute_get ();
925 LOG (GNUNET_ERROR_TYPE_DEBUG,
926 "* tmt rdy called somewhere else\n");
928 if (GNUNET_SCHEDULER_NO_TASK == fc->poll_task)
930 LOG (GNUNET_ERROR_TYPE_DEBUG, "* starting poll timeout\n");
932 GNUNET_SCHEDULER_add_delayed (fc->poll_time, &connection_poll, fc);
937 if (GNUNET_SCHEDULER_NO_TASK != fc->poll_task)
939 GNUNET_SCHEDULER_cancel (fc->poll_task);
940 fc->poll_task = GNUNET_SCHEDULER_NO_TASK;
945 c->pending_messages--;
946 if (GNUNET_YES == c->destroy && 0 == c->pending_messages)
948 LOG (GNUNET_ERROR_TYPE_DEBUG, "* destroying connection!\n");
955 t->pending_messages--;
956 if (GNUNET_YES == t->destroy && 0 == t->pending_messages)
958 // LOG (GNUNET_ERROR_TYPE_DEBUG, "* destroying tunnel!\n");
962 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
968 queue_is_sendable (struct MeshPeerQueue *q)
970 /* Is PID-independent? */
973 case GNUNET_MESSAGE_TYPE_MESH_ACK:
974 case GNUNET_MESSAGE_TYPE_MESH_POLL:
978 if (GMC_is_sendable (q->c, q->fwd))
985 * Get first sendable message.
987 * @param peer The destination peer.
989 * @return Best current known path towards the peer, if any.
991 static struct MeshPeerQueue *
992 peer_get_first_message (const struct MeshPeer *peer)
994 struct MeshPeerQueue *q;
996 for (q = peer->queue_head; NULL != q; q = q->next)
998 if (queue_is_sendable (q))
1008 /******************************************************************************/
1009 /******************************** API ***********************************/
1010 /******************************************************************************/
1014 * Free a transmission that was already queued with all resources
1015 * associated to the request.
1017 * @param queue Queue handler to cancel.
1018 * @param clear_cls Is it necessary to free associated cls?
1021 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
1023 struct MeshPeer *peer;
1024 struct MeshFlowControl *fc;
1029 GNUNET_assert (NULL != queue->c);
1030 fc = fwd ? &queue->c->fwd_fc : &queue->c->bck_fc;
1032 if (GNUNET_YES == clear_cls)
1034 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue destroy type %s\n",
1035 GNUNET_MESH_DEBUG_M2S (queue->type));
1036 switch (queue->type)
1038 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
1039 case GNUNET_MESSAGE_TYPE_MESH_TUNNEL3_DESTROY:
1040 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
1041 GNUNET_break (GNUNET_YES == queue->c->destroy);
1043 case GNUNET_MESSAGE_TYPE_MESH_FWD:
1044 case GNUNET_MESSAGE_TYPE_MESH_BCK:
1045 case GNUNET_MESSAGE_TYPE_MESH_ACK:
1046 case GNUNET_MESSAGE_TYPE_MESH_POLL:
1047 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
1048 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
1049 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
1050 LOG (GNUNET_ERROR_TYPE_DEBUG, " prebuilt message\n");;
1051 GNUNET_free_non_null (queue->cls);
1056 LOG (GNUNET_ERROR_TYPE_ERROR, " type %s unknown!\n",
1057 GNUNET_MESH_DEBUG_M2S (queue->type));
1061 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
1063 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
1064 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
1066 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N- %p %u\n", fc, fc->queue_n);
1070 if (NULL != queue->c)
1072 queue->c->pending_messages--;
1073 if (NULL != queue->c->t)
1075 queue->c->t->pending_messages--;
1079 GNUNET_free (queue);
1084 * @brief Queue and pass message to core when possible.
1086 * @param cls Closure (@c type dependant). It will be used by queue_send to
1087 * build the message to be sent if not already prebuilt.
1088 * @param type Type of the message, 0 for a raw message.
1089 * @param size Size of the message.
1090 * @param c Connection this message belongs to (cannot be NULL).
1091 * @param ch Channel this message belongs to, if applicable (otherwise NULL).
1092 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
1093 * @param callback Function to be called once CORE has taken the message.
1094 * @param callback_cls Closure for @c callback.
1097 GMP_queue_add (void *cls, uint16_t type, size_t size,
1098 struct MeshConnection *c,
1099 struct MeshChannel *ch,
1101 GMP_sent callback, void *callback_cls)
1103 struct MeshPeerQueue *queue;
1104 struct MeshFlowControl *fc;
1105 struct MeshPeer *peer;
1109 LOG (GNUNET_ERROR_TYPE_DEBUG,
1110 "queue add %s %s (%u) on c %p, ch %p\n",
1111 fwd ? "FWD" : "BCK", GNUNET_MESH_DEBUG_M2S (type), size, c, ch);
1112 GNUNET_assert (NULL != c);
1114 fc = fwd ? &c->fwd_fc : &c->bck_fc;
1115 peer = fwd ? connection_get_next_hop (c) : connection_get_prev_hop (c);
1123 if (NULL == peer->connections)
1125 /* We are not connected to this peer, ignore request. */
1126 GNUNET_break_op (0);
1132 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1133 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1138 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1139 LOG (GNUNET_ERROR_TYPE_DEBUG, "fc %p\n", fc);
1140 if (fc->queue_n >= fc->queue_max && 0 == priority)
1142 GNUNET_STATISTICS_update (stats, "# messages dropped (buffer full)",
1145 LOG (GNUNET_ERROR_TYPE_DEBUG,
1146 "queue full: %u/%u\n",
1147 fc->queue_n, fc->queue_max);
1148 return; /* Drop this message */
1151 LOG (GNUNET_ERROR_TYPE_DEBUG, "last pid %u\n", fc->last_pid_sent);
1152 LOG (GNUNET_ERROR_TYPE_DEBUG, " ack %u\n", fc->last_ack_recv);
1153 if (GMC_is_pid_bigger (fc->last_pid_sent + 1, fc->last_ack_recv))
1155 call_core = GNUNET_NO;
1156 if (GNUNET_SCHEDULER_NO_TASK == fc->poll_task &&
1157 GNUNET_MESSAGE_TYPE_MESH_POLL != type)
1159 LOG (GNUNET_ERROR_TYPE_DEBUG,
1160 "no buffer space (%u > %u): starting poll\n",
1161 fc->last_pid_sent + 1, fc->last_ack_recv);
1162 GMC_start_poll (c, fwd);
1166 call_core = GNUNET_YES;
1167 queue = GNUNET_malloc (sizeof (struct MeshPeerQueue));
1175 queue->callback = callback;
1176 queue->callback_cls = callback_cls;
1177 if (100 <= priority)
1179 struct MeshPeerQueue *copy;
1180 struct MeshPeerQueue *next;
1182 for (copy = peer->queue_head; NULL != copy; copy = next)
1185 if (copy->type == type && copy->c == c && copy->fwd == fwd)
1187 /* Example: also a FWD ACK for connection XYZ */
1188 GMP_queue_destroy (copy, GNUNET_YES);
1191 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1195 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1196 LOG (GNUNET_ERROR_TYPE_DEBUG, " Q_N+ %p %u\n", fc, fc->queue_n);
1201 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1203 LOG (GNUNET_ERROR_TYPE_DEBUG,
1204 "calling core tmt rdy towards %s for %u bytes\n",
1205 peer2s (peer), size);
1206 peer->core_transmit =
1207 GNUNET_CORE_notify_transmit_ready (core_handle,
1210 GNUNET_TIME_UNIT_FOREVER_REL,
1211 GNUNET_PEER_resolve2 (peer->id),
1215 queue->start_waiting = GNUNET_TIME_absolute_get ();
1219 LOG (GNUNET_ERROR_TYPE_DEBUG,
1220 "core tmt rdy towards %s already called\n",
1224 c->pending_messages++;
1226 c->t->pending_messages++;
1231 * Cancel all queued messages to a peer that belong to a certain connection.
1233 * @param peer Peer towards whom to cancel.
1234 * @param c Connection whose queued messages to cancel.
1237 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1239 struct MeshPeerQueue *q;
1240 struct MeshPeerQueue *next;
1242 for (q = peer->queue_head; NULL != q; q = next)
1247 LOG (GNUNET_ERROR_TYPE_DEBUG,
1248 "connection_cancel_queue %s\n",
1249 GNUNET_MESH_DEBUG_M2S (q->type));
1250 GMP_queue_destroy (q, GNUNET_YES);
1253 if (NULL == peer->queue_head)
1255 if (NULL != peer->core_transmit)
1257 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1258 peer->core_transmit = NULL;
1265 * Get the first transmittable message for a connection.
1267 * @param peer Neighboring peer.
1268 * @param c Connection.
1270 * @return First transmittable message.
1272 static struct MeshPeerQueue *
1273 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1275 struct MeshPeerQueue *q;
1277 for (q = peer->queue_head; NULL != q; q = q->next)
1281 if (queue_is_sendable (q))
1289 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1291 struct MeshPeerQueue *q;
1294 if (NULL != peer->core_transmit)
1296 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1297 return; /* Already unlocked */
1300 q = connection_get_first_message (peer, c);
1303 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1304 return; /* Nothing to transmit */
1308 peer->core_transmit =
1309 GNUNET_CORE_notify_transmit_ready (core_handle,
1312 GNUNET_TIME_UNIT_FOREVER_REL,
1313 GNUNET_PEER_resolve2 (peer->id),
1321 * Initialize the peer subsystem.
1323 * @param c Configuration.
1324 * @param id Peer identity
1327 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1329 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1331 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1334 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1335 "MESH", "MAX_PEERS", "USING DEFAULT");
1340 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1347 LOG (GNUNET_ERROR_TYPE_WARNING,
1348 "\n***************************************\n"
1349 "Mesh is running with drop mode enabled.\n"
1350 "This is NOT a good idea!\n"
1351 "Remove the DROP_PERCENT option from your configuration.\n"
1352 "***************************************\n");
1355 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1356 NULL, /* Closure passed to MESH functions */
1357 &core_init, /* Call core_init once connected */
1358 &core_connect, /* Handle connects */
1359 &core_disconnect, /* remove peers on disconnects */
1360 NULL, /* Don't notify about all incoming messages */
1361 GNUNET_NO, /* For header only in notification */
1362 NULL, /* Don't notify about all outbound messages */
1363 GNUNET_NO, /* For header-only out notification */
1364 core_handlers); /* Register these handlers */
1365 if (NULL == core_handle)
1368 GNUNET_SCHEDULER_shutdown ();
1374 * Shut down the peer subsystem.
1379 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1381 if (core_handle != NULL)
1383 GNUNET_CORE_disconnect (core_handle);
1386 GNUNET_PEER_change_rc (myid, -1);
1390 * Retrieve the MeshPeer stucture associated with the peer, create one
1391 * and insert it in the appropriate structures if the peer is not known yet.
1393 * @param peer Full identity of the peer.
1395 * @return Existing or newly created peer structure.
1398 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1400 struct MeshPeer *peer;
1402 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1405 peer = GNUNET_new (struct MeshPeer);
1406 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1408 peer_delete_oldest ();
1410 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1411 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1412 peer->id = GNUNET_PEER_intern (peer_id);
1414 peer->last_contact = GNUNET_TIME_absolute_get();
1421 * Retrieve the MeshPeer stucture associated with the peer, create one
1422 * and insert it in the appropriate structures if the peer is not known yet.
1424 * @param peer Short identity of the peer.
1426 * @return Existing or newly created peer structure.
1429 GMP_get_short (const GNUNET_PEER_Id peer)
1431 return GMP_get (GNUNET_PEER_resolve2 (peer));
1436 * Try to establish a new connection to this peer (in its tunnel).
1437 * If the peer doesn't have any path to it yet, try to get one.
1438 * If the peer already has some path, send a CREATE CONNECTION towards it.
1440 * @param peer Peer to connect to.
1443 GMP_connect (struct MeshPeer *peer)
1445 struct MeshTunnel3 *t;
1446 struct MeshPeerPath *p;
1447 struct MeshConnection *c;
1450 LOG (GNUNET_ERROR_TYPE_DEBUG,
1451 "peer_connect towards %s\n",
1455 rerun_search = GNUNET_NO;
1457 if (NULL != peer->path_head)
1459 LOG (GNUNET_ERROR_TYPE_DEBUG, "path exists\n");
1460 p = peer_get_best_path (peer);
1463 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1464 c = GMT_use_path (t, p);
1467 /* This case can happen when the path includes a first hop that is
1468 * not yet known to be connected.
1470 * This happens quite often during testing when running mesh
1471 * under valgrind: core connect notifications come very late and the
1472 * DHT result has already come and created a valid path.
1473 * In this case, the peer->connections hashmap will be NULL and
1474 * tunnel_use_path will not be able to create a connection from that
1477 * Re-running the DHT GET should give core time to callback.
1480 rerun_search = GNUNET_YES;
1484 GMC_send_create (c);
1490 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1492 GMD_search_stop (peer->search_h);
1493 peer->search_h = NULL;
1494 LOG (GNUNET_ERROR_TYPE_DEBUG,
1495 " Stopping DHT GET for peer %s\n",
1499 if (NULL == peer->search_h)
1501 const struct GNUNET_PeerIdentity *id;
1503 id = GNUNET_PEER_resolve2 (peer->id);
1504 LOG (GNUNET_ERROR_TYPE_DEBUG,
1505 " Starting DHT GET for peer %s\n", peer2s (peer));
1506 peer->search_h = GMD_search (id, &search_handler, peer);
1507 if (MESH_TUNNEL3_NEW == GMT_get_state (t))
1508 GMT_change_state (t, MESH_TUNNEL3_SEARCHING);
1520 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1527 * Chech whether there is a direct (core level) connection to peer.
1529 * @param peer Peer to check.
1531 * @return GNUNET_YES if there is a direct connection.
1534 GMP_is_neighbor (const struct MeshPeer *peer)
1536 struct MeshPeerPath *path;
1538 if (NULL == peer->connections)
1541 for (path = peer->path_head; NULL != path; path = path->next)
1543 if (3 > path->length)
1547 GNUNET_break (0); /* Is not a neighbor but connections is not NULL */
1553 * Create and initialize a new tunnel towards a peer, in case it has none.
1555 * Does not generate any traffic, just creates the local data structures.
1557 * @param peer Peer towards which to create the tunnel.
1560 GMP_add_tunnel (struct MeshPeer *peer)
1562 if (NULL != peer->tunnel)
1564 peer->tunnel = GMT_new (peer);
1569 * Add a connection to a neighboring peer.
1571 * Store that the peer is the first hop of the connection in one
1572 * direction and that on peer disconnect the connection must be
1573 * notified and destroyed, for it will no longer be valid.
1575 * @param peer Peer to add connection to.
1576 * @param c Connection to add.
1578 * @return GNUNET_OK on success.
1581 GMP_add_connection (struct MeshPeer *peer,
1582 struct MeshConnection *c)
1584 if (NULL == peer->connections)
1587 return GNUNET_SYSERR;
1589 return GNUNET_CONTAINER_multihashmap_put (peer->connections,
1592 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1597 * Add the path to the peer and update the path used to reach it in case this
1600 * @param peer_info Destination peer to add the path to.
1601 * @param path New path to add. Last peer must be the peer in arg 1.
1602 * Path will be either used of freed if already known.
1603 * @param trusted Do we trust that this path is real?
1606 GMP_add_path (struct MeshPeer *peer_info, struct MeshPeerPath *path,
1609 struct MeshPeerPath *aux;
1613 if ((NULL == peer_info) || (NULL == path))
1616 path_destroy (path);
1619 if (path->peers[path->length - 1] != peer_info->id)
1622 path_destroy (path);
1625 if (2 >= path->length && GNUNET_NO == trusted)
1627 /* Only allow CORE to tell us about direct paths */
1628 path_destroy (path);
1631 for (l = 1; l < path->length; l++)
1633 if (path->peers[l] == myid)
1635 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1636 for (l2 = 0; l2 < path->length - l; l2++)
1638 path->peers[l2] = path->peers[l + l2];
1643 GNUNET_realloc (path->peers, path->length * sizeof (GNUNET_PEER_Id));
1647 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1648 path->length, peer2s (peer_info));
1650 l = path_get_length (path);
1653 path_destroy (path);
1657 GNUNET_assert (peer_info->id == path->peers[path->length - 1]);
1658 for (aux = peer_info->path_head; aux != NULL; aux = aux->next)
1660 l2 = path_get_length (aux);
1663 GNUNET_CONTAINER_DLL_insert_before (peer_info->path_head,
1664 peer_info->path_tail, aux, path);
1669 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1671 path_destroy (path);
1676 GNUNET_CONTAINER_DLL_insert_tail (peer_info->path_head, peer_info->path_tail,
1683 * Add the path to the origin peer and update the path used to reach it in case
1684 * this is the shortest.
1685 * The path is given in peer_info -> destination, therefore we turn the path
1686 * upside down first.
1688 * @param peer_info Peer to add the path to, being the origin of the path.
1689 * @param path New path to add after being inversed.
1690 * Path will be either used or freed.
1691 * @param trusted Do we trust that this path is real?
1694 GMP_add_path_to_origin (struct MeshPeer *peer,
1695 struct MeshPeerPath *path,
1701 GMP_add_path (peer, path, trusted);
1706 * Adds a path to the info of all the peers in the path
1708 * @param p Path to process.
1709 * @param confirmed Whether we know if the path works or not.
1712 GMP_add_path_to_all (struct MeshPeerPath *p, int confirmed)
1716 /* TODO: invert and add */
1717 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1718 for (i++; i < p->length; i++)
1720 struct MeshPeer *aux;
1721 struct MeshPeerPath *copy;
1723 aux = GMP_get_short (p->peers[i]);
1724 copy = path_duplicate (p);
1725 copy->length = i + 1;
1726 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1732 * Remove a connection from a neighboring peer.
1734 * @param peer Peer to remove connection from.
1735 * @param c Connection to remove.
1737 * @return GNUNET_OK on success.
1740 GMP_remove_connection (struct MeshPeer *peer,
1741 const struct MeshConnection *c)
1743 if (NULL == peer || NULL == peer->connections)
1746 return GNUNET_SYSERR;
1748 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1754 * Get the Full ID of a peer.
1756 * @param peer Peer to get from.
1758 * @return Full ID of peer.
1760 const struct GNUNET_PeerIdentity *
1761 GMP_get_id (const struct MeshPeer *peer)
1763 return GNUNET_PEER_resolve2 (peer->id);
1768 * Get the Short ID of a peer.
1770 * @param peer Peer to get from.
1772 * @return Short ID of peer.
1775 GMP_get_short_id (const struct MeshPeer *peer)
1782 * Get the static string for a peer ID.
1786 * @return Static string for it's ID.
1789 GMP_2s (const struct MeshPeer *peer)
1793 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));