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.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_tunnel.h"
34 #include "mesh_path.h"
36 #define LOG(level, ...) GNUNET_log_from (level,"mesh-p2p",__VA_ARGS__)
38 /******************************************************************************/
39 /******************************** STRUCTS **********************************/
40 /******************************************************************************/
43 * Struct containing info about a queued transmission to this peer
50 struct MeshPeerQueue *next;
55 struct MeshPeerQueue *prev;
58 * Peer this transmission is directed to.
60 struct MeshPeer *peer;
63 * Connection this message belongs to.
65 struct MeshConnection *c;
73 * Pointer to info stucture used as cls.
88 * Set when this message starts waiting for CORE.
90 struct GNUNET_TIME_Absolute start_waiting;
93 * Function to call on sending.
98 * Closure for callback.
104 * Struct containing all information regarding a given peer
114 * Last time we heard from this peer
116 struct GNUNET_TIME_Absolute last_contact;
119 * Paths to reach the peer, ordered by ascending hop count
121 struct MeshPeerPath *path_head;
124 * Paths to reach the peer, ordered by ascending hop count
126 struct MeshPeerPath *path_tail;
129 * Handle to stop the DHT search for paths to this peer
131 struct GMD_search_handle *search_h;
134 * Tunnel to this peer, if any.
136 struct MeshTunnel3 *tunnel;
139 * Connections that go through this peer, indexed by tid;
141 struct GNUNET_CONTAINER_MultiHashMap *connections;
144 * Handle for queued transmissions
146 struct GNUNET_CORE_TransmitHandle *core_transmit;
149 * Transmission queue to core DLL head
151 struct MeshPeerQueue *queue_head;
154 * Transmission queue to core DLL tail
156 struct MeshPeerQueue *queue_tail;
159 * How many messages are in the queue to this peer.
161 unsigned int queue_n;
165 /******************************************************************************/
166 /******************************* GLOBALS ***********************************/
167 /******************************************************************************/
170 * Global handle to the statistics service.
172 extern struct GNUNET_STATISTICS_Handle *stats;
175 * Local peer own ID (full value).
177 extern struct GNUNET_PeerIdentity my_full_id;
180 * Local peer own ID (short)
182 extern GNUNET_PEER_Id myid;
185 * Peers known, indexed by PeerIdentity (MeshPeer).
187 static struct GNUNET_CONTAINER_MultiPeerMap *peers;
190 * How many peers do we want to remember?
192 static unsigned long long max_peers;
195 * Percentage of messages that will be dropped (for test purposes only).
197 static unsigned long long drop_percent;
200 * Handle to communicate with core.
202 static struct GNUNET_CORE_Handle *core_handle;
205 /******************************************************************************/
206 /***************************** CORE CALLBACKS *********************************/
207 /******************************************************************************/
211 * Iterator to notify all connections of a broken link. Mark connections
212 * to destroy after all traffic has been sent.
214 * @param cls Closure (peer disconnected).
215 * @param key Current key code (peer id).
216 * @param value Value in the hash map (connection).
218 * @return #GNUNET_YES to continue to iterate.
221 notify_broken (void *cls,
222 const struct GNUNET_HashCode *key,
225 struct MeshPeer *peer = cls;
226 struct MeshConnection *c = value;
228 LOG (GNUNET_ERROR_TYPE_DEBUG, " notifying %s due to %s\n",
229 GMC_2s (c), GMP_2s (peer));
230 GMC_notify_broken (c, peer);
237 * Method called whenever a given peer connects.
240 * @param peer peer identity this notification is about
243 core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
246 struct MeshPeerPath *path;
248 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer connected\n");
249 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&my_full_id));
253 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self)\n");
258 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (peer));
260 path->peers[1] = mp->id;
261 GNUNET_PEER_change_rc (mp->id, 1);
262 GNUNET_STATISTICS_update (stats, "# peers", 1, GNUNET_NO);
264 path->peers[0] = myid;
265 GNUNET_PEER_change_rc (myid, 1);
266 GMP_add_path (mp, path, GNUNET_YES);
268 mp->connections = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_YES);
274 * Method called whenever a peer disconnects.
277 * @param peer peer identity this notification is about
280 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
284 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer disconnected\n");
285 p = GNUNET_CONTAINER_multipeermap_get (peers, peer);
292 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self: %s)\n", GMP_2s (p));
294 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GMP_2s (p));
297 GNUNET_CONTAINER_multihashmap_iterate (p->connections, ¬ify_broken, p);
298 GNUNET_CONTAINER_multihashmap_destroy (p->connections);
299 p->connections = NULL;
300 if (NULL != p->core_transmit)
302 GNUNET_CORE_notify_transmit_ready_cancel (p->core_transmit);
303 p->core_transmit = NULL;
305 GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
312 * Functions to handle messages from core
314 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
315 {&GMC_handle_create, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
317 {&GMC_handle_confirm, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
318 sizeof (struct GNUNET_MESH_ConnectionACK)},
319 {&GMC_handle_broken, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
320 sizeof (struct GNUNET_MESH_ConnectionBroken)},
321 {&GMC_handle_destroy, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY,
322 sizeof (struct GNUNET_MESH_ConnectionDestroy)},
323 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE,
324 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
325 {&GMC_handle_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
326 sizeof (struct GNUNET_MESH_ACK)},
327 {&GMC_handle_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
328 sizeof (struct GNUNET_MESH_Poll)},
329 {&GMC_handle_encrypted, GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED, 0},
330 {&GMC_handle_kx, GNUNET_MESSAGE_TYPE_MESH_KX, 0},
336 * To be called on core init/fail.
338 * @param cls Closure (config)
339 * @param identity the public identity of this peer
342 core_init (void *cls,
343 const struct GNUNET_PeerIdentity *identity)
345 const struct GNUNET_CONFIGURATION_Handle *c = cls;
348 LOG (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
349 if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)))
351 LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
352 LOG (GNUNET_ERROR_TYPE_ERROR, " core id %s\n", GNUNET_i2s (identity));
353 LOG (GNUNET_ERROR_TYPE_ERROR, " my id %s\n", GNUNET_i2s (&my_full_id));
354 GNUNET_CORE_disconnect (core_handle);
355 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
356 NULL, /* Closure passed to MESH functions */
357 &core_init, /* Call core_init once connected */
358 &core_connect, /* Handle connects */
359 &core_disconnect, /* remove peers on disconnects */
360 NULL, /* Don't notify about all incoming messages */
361 GNUNET_NO, /* For header only in notification */
362 NULL, /* Don't notify about all outbound messages */
363 GNUNET_NO, /* For header-only out notification */
364 core_handlers); /* Register these handlers */
373 * Core callback to write a pre-constructed data packet to core buffer
375 * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
376 * @param size Number of bytes available in buf.
377 * @param buf Where the to write the message.
379 * @return number of bytes written to buf
382 send_core_data_raw (void *cls, size_t size, void *buf)
384 struct GNUNET_MessageHeader *msg = cls;
387 GNUNET_assert (NULL != msg);
388 total_size = ntohs (msg->size);
390 if (total_size > size)
395 memcpy (buf, msg, total_size);
402 * Function to send a create connection message to a peer.
404 * @param c Connection to create.
405 * @param size number of bytes available in buf
406 * @param buf where the callee should write the message
407 * @return number of bytes written to buf
410 send_core_connection_create (struct MeshConnection *c, size_t size, void *buf)
412 struct GNUNET_MESH_ConnectionCreate *msg;
413 struct GNUNET_PeerIdentity *peer_ptr;
414 const struct MeshPeerPath *p = GMC_get_path (c);
421 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
423 sizeof (struct GNUNET_MESH_ConnectionCreate) +
424 p->length * sizeof (struct GNUNET_PeerIdentity);
426 if (size < size_needed || NULL == buf)
431 msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
432 msg->header.size = htons (size_needed);
433 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
434 msg->cid = *GMC_get_id (c);
436 peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
437 for (i = 0; i < p->length; i++)
439 GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
442 LOG (GNUNET_ERROR_TYPE_DEBUG,
443 "CONNECTION CREATE (%u bytes long) sent!\n",
450 * Creates a path ack message in buf and frees all unused resources.
452 * @param c Connection to send an ACK on.
453 * @param size number of bytes available in buf
454 * @param buf where the callee should write the message
456 * @return number of bytes written to buf
459 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
461 struct GNUNET_MESH_ConnectionACK *msg = buf;
463 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
464 if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
469 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
470 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
471 msg->cid = *GMC_get_id (c);
474 /* TODO add signature */
476 LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
477 return sizeof (struct GNUNET_MESH_ConnectionACK);
481 /******************************************************************************/
482 /******************************** STATIC ***********************************/
483 /******************************************************************************/
486 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
489 * @param key current key code
490 * @param value value in the hash map
491 * @return #GNUNET_YES if we should continue to iterate,
495 shutdown_tunnel (void *cls,
496 const struct GNUNET_PeerIdentity *key,
499 struct MeshPeer *p = value;
500 struct MeshTunnel3 *t = p->tunnel;
510 * Destroy the peer_info and free any allocated resources linked to it
512 * @param peer The peer_info to destroy.
514 * @return GNUNET_OK on success
517 peer_destroy (struct MeshPeer *peer)
519 struct GNUNET_PeerIdentity id;
520 struct MeshPeerPath *p;
521 struct MeshPeerPath *nextp;
523 GNUNET_PEER_resolve (peer->id, &id);
524 GNUNET_PEER_change_rc (peer->id, -1);
526 LOG (GNUNET_ERROR_TYPE_WARNING, "destroying peer %s\n", GNUNET_i2s (&id));
529 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
532 LOG (GNUNET_ERROR_TYPE_WARNING, " not in peermap!!\n");
534 if (NULL != peer->search_h)
536 GMD_search_stop (peer->search_h);
542 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
546 GMT_destroy_empty (peer->tunnel);
553 * Returns if peer is used (has a tunnel or is neighbor).
555 * @param peer Peer to check.
557 * @return #GNUNET_YES if peer is in use.
560 peer_is_used (struct MeshPeer *peer)
562 struct MeshPeerPath *p;
564 if (NULL != peer->tunnel)
567 for (p = peer->path_head; NULL != p; p = p->next)
577 * Iterator over all the peers to get the oldest timestamp.
579 * @param cls Closure (unsued).
580 * @param key ID of the peer.
581 * @param value Peer_Info of the peer.
584 peer_get_oldest (void *cls,
585 const struct GNUNET_PeerIdentity *key,
588 struct MeshPeer *p = value;
589 struct GNUNET_TIME_Absolute *abs = cls;
591 /* Don't count active peers */
592 if (GNUNET_YES == peer_is_used (p))
595 if (abs->abs_value_us < p->last_contact.abs_value_us)
596 abs->abs_value_us = p->last_contact.abs_value_us;
603 * Iterator over all the peers to remove the oldest entry.
605 * @param cls Closure (unsued).
606 * @param key ID of the peer.
607 * @param value Peer_Info of the peer.
610 peer_timeout (void *cls,
611 const struct GNUNET_PeerIdentity *key,
614 struct MeshPeer *p = value;
615 struct GNUNET_TIME_Absolute *abs = cls;
617 LOG (GNUNET_ERROR_TYPE_WARNING,
618 "peer %s timeout\n", GNUNET_i2s (key));
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 * Choose the best (yet unused) path towards a peer,
651 * considering the tunnel properties.
653 * @param peer The destination peer.
655 * @return Best current known path towards the peer, if any.
657 static struct MeshPeerPath *
658 peer_get_best_path (const struct MeshPeer *peer)
660 struct MeshPeerPath *best_p;
661 struct MeshPeerPath *p;
662 unsigned int best_cost;
665 best_cost = UINT_MAX;
667 for (p = peer->path_head; NULL != p; p = p->next)
669 if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
670 continue; /* If path is already in use, skip it. */
672 if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
683 queue_is_sendable (struct MeshPeerQueue *q)
685 /* Is PID-independent? */
688 case GNUNET_MESSAGE_TYPE_MESH_ACK:
689 case GNUNET_MESSAGE_TYPE_MESH_POLL:
690 case GNUNET_MESSAGE_TYPE_MESH_KX:
691 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
692 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
693 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
694 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
695 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
698 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
705 if (GMC_is_sendable (q->c, q->fwd))
713 * Get first sendable message.
715 * @param peer The destination peer.
717 * @return Best current known path towards the peer, if any.
719 static struct MeshPeerQueue *
720 peer_get_first_message (const struct MeshPeer *peer)
722 struct MeshPeerQueue *q;
724 for (q = peer->queue_head; NULL != q; q = q->next)
726 if (queue_is_sendable (q))
735 * Function to process paths received for a new peer addition. The recorded
736 * paths form the initial tunnel, which can be optimized later.
737 * Called on each result obtained for the DHT search.
743 search_handler (void *cls, const struct MeshPeerPath *path)
745 struct MeshPeer *peer = cls;
746 unsigned int connection_count;
748 GMP_add_path_to_all (path, GNUNET_NO);
750 /* Count connections */
751 connection_count = GMT_count_connections (peer->tunnel);
753 /* If we already have 3 (or more (?!)) connections, it's enough */
754 if (3 <= connection_count)
757 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (peer->tunnel))
759 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
767 * Core callback to write a queued packet to core buffer
769 * @param cls Closure (peer info).
770 * @param size Number of bytes available in buf.
771 * @param buf Where the to write the message.
773 * @return number of bytes written to buf
776 queue_send (void *cls, size_t size, void *buf)
778 struct MeshPeer *peer = cls;
779 struct MeshConnection *c;
780 struct MeshPeerQueue *queue;
781 const struct GNUNET_PeerIdentity *dst_id;
784 peer->core_transmit = NULL;
785 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send towards %s (max %u)\n",
786 GMP_2s (peer), size);
788 if (NULL == buf || 0 == size)
790 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
795 queue = peer_get_first_message (peer);
798 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
803 dst_id = GNUNET_PEER_resolve2 (peer->id);
804 LOG (GNUNET_ERROR_TYPE_DEBUG, "* on connection %s\n", GMC_2s (c));
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);
825 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
826 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
827 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
828 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
829 case GNUNET_MESSAGE_TYPE_MESH_KX:
830 case GNUNET_MESSAGE_TYPE_MESH_ACK:
831 case GNUNET_MESSAGE_TYPE_MESH_POLL:
832 LOG (GNUNET_ERROR_TYPE_DEBUG,
834 GM_m2s (queue->type));
835 data_size = send_core_data_raw (queue->cls, size, buf);
837 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
838 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
839 if (GMC_is_origin (c, GNUNET_YES))
840 data_size = send_core_connection_create (queue->c, size, buf);
842 data_size = send_core_data_raw (queue->cls, size, buf);
844 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
845 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
846 if (GMC_is_origin (c, GNUNET_NO) ||
847 GMC_is_origin (c, GNUNET_YES))
848 data_size = send_core_connection_ack (queue->c, size, buf);
850 data_size = send_core_data_raw (queue->cls, size, buf);
852 case GNUNET_MESSAGE_TYPE_MESH_DATA:
853 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
854 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
855 /* This should be encapsulted */
861 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n", queue->type);
865 if (0 < drop_percent &&
866 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
868 LOG (GNUNET_ERROR_TYPE_WARNING,
869 "Dropping message of type %s\n",
870 GM_m2s (queue->type));
874 /* Free queue, but cls was freed by send_core_* */
875 GMP_queue_destroy (queue, GNUNET_NO);
877 /* If more data in queue, send next */
878 queue = peer_get_first_message (peer);
881 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
882 if (NULL == peer->core_transmit)
884 peer->core_transmit =
885 GNUNET_CORE_notify_transmit_ready(core_handle,
888 GNUNET_TIME_UNIT_FOREVER_REL,
893 queue->start_waiting = GNUNET_TIME_absolute_get ();
897 LOG (GNUNET_ERROR_TYPE_DEBUG,
898 "* tmt rdy called somewhere else\n");
900 // GMC_start_poll (); FIXME needed?
904 // GMC_stop_poll(); FIXME needed?
907 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
912 /******************************************************************************/
913 /******************************** API ***********************************/
914 /******************************************************************************/
918 * Free a transmission that was already queued with all resources
919 * associated to the request.
921 * @param queue Queue handler to cancel.
922 * @param clear_cls Is it necessary to free associated cls?
925 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
927 struct MeshPeer *peer;
930 GNUNET_assert (NULL != queue->c);
932 if (GNUNET_YES == clear_cls)
934 LOG (GNUNET_ERROR_TYPE_DEBUG, "# queue destroy type %s\n",
935 GM_m2s (queue->type));
938 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
939 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
941 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
942 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
943 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
944 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
945 case GNUNET_MESSAGE_TYPE_MESH_KX:
946 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
947 case GNUNET_MESSAGE_TYPE_MESH_ACK:
948 case GNUNET_MESSAGE_TYPE_MESH_POLL:
949 GNUNET_free_non_null (queue->cls);
954 LOG (GNUNET_ERROR_TYPE_ERROR, "# type %s unknown!\n",
955 GM_m2s (queue->type));
958 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
960 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
961 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
966 if (NULL != queue->callback)
968 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Calling callback\n");
969 queue->callback (queue->callback_cls,
970 queue->c, queue->type,
971 queue->fwd, queue->size,
972 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
980 * @brief Queue and pass message to core when possible.
982 * @param peer Peer towards which to queue the message.
983 * @param cls Closure (@c type dependant). It will be used by queue_send to
984 * build the message to be sent if not already prebuilt.
985 * @param type Type of the message, 0 for a raw message.
986 * @param size Size of the message.
987 * @param c Connection this message belongs to (cannot be NULL).
988 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
989 * @param cont Continuation to be called once CORE has taken the message.
990 * @param cont_cls Closure for @c cont.
992 * @return Handle to cancel the message before it is sent. Once cont is called
993 * message has been sent and therefore the handle is no longer valid.
995 struct MeshPeerQueue *
996 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
997 struct MeshConnection *c, int fwd,
998 GMP_sent cont, void *cont_cls)
1000 struct MeshPeerQueue *queue;
1004 LOG (GNUNET_ERROR_TYPE_DEBUG,
1005 "queue add %s %s towards %s (size %u) on c %p (%s)\n",
1006 GM_f2s (fwd), GM_m2s (type), GMP_2s(peer),
1007 size, c, GMC_2s (c));
1008 GNUNET_assert (NULL != c);
1010 if (NULL == peer->connections)
1012 /* We are not connected to this peer, ignore request. */
1013 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING %s not a neighbor\n", GMP_2s (peer));
1014 GNUNET_STATISTICS_update (stats, "# messages dropped due to wrong hop", 1,
1021 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1022 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1027 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1029 call_core = GMC_is_sendable (c, fwd);
1030 queue = GNUNET_malloc (sizeof (struct MeshPeerQueue));
1037 queue->callback = cont;
1038 queue->callback_cls = cont_cls;
1041 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1046 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1047 call_core = GNUNET_YES;
1050 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1052 LOG (GNUNET_ERROR_TYPE_DEBUG,
1053 "calling core tmt rdy towards %s for %u bytes\n",
1054 GMP_2s (peer), size);
1055 peer->core_transmit =
1056 GNUNET_CORE_notify_transmit_ready (core_handle,
1059 GNUNET_TIME_UNIT_FOREVER_REL,
1060 GNUNET_PEER_resolve2 (peer->id),
1064 queue->start_waiting = GNUNET_TIME_absolute_get ();
1068 LOG (GNUNET_ERROR_TYPE_DEBUG,
1069 "core tmt rdy towards %s already called\n",
1078 * Cancel all queued messages to a peer that belong to a certain connection.
1080 * @param peer Peer towards whom to cancel.
1081 * @param c Connection whose queued messages to cancel. Might be destroyed by
1082 * the sent continuation call.
1085 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1087 struct MeshPeerQueue *q;
1088 struct MeshPeerQueue *next;
1089 struct MeshPeerQueue *prev;
1091 for (q = peer->queue_head; NULL != q; q = next)
1096 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMP_cancel_queue %s\n", GM_m2s (q->type));
1097 GMP_queue_destroy (q, GNUNET_YES);
1099 /* Get next from prev, q->next might be already freed:
1100 * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1103 next = peer->queue_head;
1112 if (NULL == peer->queue_head)
1114 if (NULL != peer->core_transmit)
1116 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1117 peer->core_transmit = NULL;
1124 * Get the first transmittable message for a connection.
1126 * @param peer Neighboring peer.
1127 * @param c Connection.
1129 * @return First transmittable message.
1131 static struct MeshPeerQueue *
1132 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1134 struct MeshPeerQueue *q;
1136 for (q = peer->queue_head; NULL != q; q = q->next)
1140 if (queue_is_sendable (q))
1142 LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable!!\n");
1145 LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
1153 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1155 struct MeshPeerQueue *q;
1158 if (NULL != peer->core_transmit)
1160 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1161 return; /* Already unlocked */
1164 q = connection_get_first_message (peer, c);
1167 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1168 return; /* Nothing to transmit */
1172 peer->core_transmit =
1173 GNUNET_CORE_notify_transmit_ready (core_handle,
1176 GNUNET_TIME_UNIT_FOREVER_REL,
1177 GNUNET_PEER_resolve2 (peer->id),
1185 * Initialize the peer subsystem.
1187 * @param c Configuration.
1190 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1192 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1193 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1195 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1198 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1199 "MESH", "MAX_PEERS", "USING DEFAULT");
1204 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1211 LOG (GNUNET_ERROR_TYPE_WARNING,
1212 "\n***************************************\n"
1213 "Mesh is running with drop mode enabled.\n"
1214 "This is NOT a good idea!\n"
1215 "Remove the DROP_PERCENT option from your configuration.\n"
1216 "***************************************\n");
1219 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1220 NULL, /* Closure passed to MESH functions */
1221 &core_init, /* Call core_init once connected */
1222 &core_connect, /* Handle connects */
1223 &core_disconnect, /* remove peers on disconnects */
1224 NULL, /* Don't notify about all incoming messages */
1225 GNUNET_NO, /* For header only in notification */
1226 NULL, /* Don't notify about all outbound messages */
1227 GNUNET_NO, /* For header-only out notification */
1228 core_handlers); /* Register these handlers */
1229 if (NULL == core_handle)
1232 GNUNET_SCHEDULER_shutdown ();
1238 * Shut down the peer subsystem.
1243 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1245 if (core_handle != NULL)
1247 GNUNET_CORE_disconnect (core_handle);
1250 GNUNET_PEER_change_rc (myid, -1);
1254 * Retrieve the MeshPeer stucture associated with the peer, create one
1255 * and insert it in the appropriate structures if the peer is not known yet.
1257 * @param peer_id Full identity of the peer.
1259 * @return Existing or newly created peer structure.
1262 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1264 struct MeshPeer *peer;
1266 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1269 peer = GNUNET_new (struct MeshPeer);
1270 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1272 peer_delete_oldest ();
1274 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1275 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1276 peer->id = GNUNET_PEER_intern (peer_id);
1278 peer->last_contact = GNUNET_TIME_absolute_get();
1285 * Retrieve the MeshPeer stucture associated with the peer, create one
1286 * and insert it in the appropriate structures if the peer is not known yet.
1288 * @param peer Short identity of the peer.
1290 * @return Existing or newly created peer structure.
1293 GMP_get_short (const GNUNET_PEER_Id peer)
1295 return GMP_get (GNUNET_PEER_resolve2 (peer));
1300 * Try to establish a new connection to this peer (in its tunnel).
1301 * If the peer doesn't have any path to it yet, try to get one.
1302 * If the peer already has some path, send a CREATE CONNECTION towards it.
1304 * @param peer Peer to connect to.
1307 GMP_connect (struct MeshPeer *peer)
1309 struct MeshTunnel3 *t;
1310 struct MeshPeerPath *p;
1311 struct MeshConnection *c;
1314 LOG (GNUNET_ERROR_TYPE_DEBUG, "peer_connect towards %s\n", GMP_2s (peer));
1317 rerun_search = GNUNET_NO;
1319 if (NULL != peer->path_head)
1321 LOG (GNUNET_ERROR_TYPE_DEBUG, " some path exists\n");
1322 p = peer_get_best_path (peer);
1325 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1326 c = GMT_use_path (t, p);
1329 /* This case can happen when the path includes a first hop that is
1330 * not yet known to be connected.
1332 * This happens quite often during testing when running mesh
1333 * under valgrind: core connect notifications come very late and the
1334 * DHT result has already come and created a valid path.
1335 * In this case, the peer->connections hashmap will be NULL and
1336 * tunnel_use_path will not be able to create a connection from that
1339 * Re-running the DHT GET should give core time to callback.
1341 * GMT_use_path -> GMC_new -> register_neighbors takes care of
1342 * updating statistics about this issue.
1344 rerun_search = GNUNET_YES;
1348 GMC_send_create (c);
1354 LOG (GNUNET_ERROR_TYPE_DEBUG, " but is NULL, all paths are in use\n");
1358 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1360 GMD_search_stop (peer->search_h);
1361 peer->search_h = NULL;
1362 LOG (GNUNET_ERROR_TYPE_DEBUG,
1363 " Stopping DHT GET for peer %s\n",
1367 if (NULL == peer->search_h)
1369 const struct GNUNET_PeerIdentity *id;
1371 id = GNUNET_PEER_resolve2 (peer->id);
1372 LOG (GNUNET_ERROR_TYPE_DEBUG,
1373 " Starting DHT GET for peer %s\n", GMP_2s (peer));
1374 peer->search_h = GMD_search (id, &search_handler, peer);
1375 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
1376 GMT_change_cstate (t, MESH_TUNNEL3_SEARCHING);
1388 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1395 * Chech whether there is a direct (core level) connection to peer.
1397 * @param peer Peer to check.
1399 * @return #GNUNET_YES if there is a direct connection.
1402 GMP_is_neighbor (const struct MeshPeer *peer)
1404 struct MeshPeerPath *path;
1406 if (NULL == peer->connections)
1409 for (path = peer->path_head; NULL != path; path = path->next)
1411 if (3 > path->length)
1415 GNUNET_break (0); /* Is not a neighbor but connections is not NULL */
1421 * Create and initialize a new tunnel towards a peer, in case it has none.
1422 * In case the peer already has a tunnel, nothing is done.
1424 * Does not generate any traffic, just creates the local data structures.
1426 * @param peer Peer towards which to create the tunnel.
1429 GMP_add_tunnel (struct MeshPeer *peer)
1431 if (NULL != peer->tunnel)
1433 peer->tunnel = GMT_new (peer);
1438 * Add a connection to a neighboring peer.
1440 * Store that the peer is the first hop of the connection in one
1441 * direction and that on peer disconnect the connection must be
1442 * notified and destroyed, for it will no longer be valid.
1444 * @param peer Peer to add connection to.
1445 * @param c Connection to add.
1447 * @return GNUNET_OK on success.
1450 GMP_add_connection (struct MeshPeer *peer,
1451 struct MeshConnection *c)
1453 if (NULL == peer->connections)
1456 return GNUNET_SYSERR;
1458 return GNUNET_CONTAINER_multihashmap_put (peer->connections,
1461 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1466 * Add the path to the peer and update the path used to reach it in case this
1469 * @param peer Destination peer to add the path to.
1470 * @param path New path to add. Last peer must be the peer in arg 1.
1471 * Path will be either used of freed if already known.
1472 * @param trusted Do we trust that this path is real?
1474 * @return path if path was taken, pointer to existing duplicate if exists
1477 struct MeshPeerPath *
1478 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1481 struct MeshPeerPath *aux;
1485 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1486 path->length, GMP_2s (peer));
1488 if ((NULL == peer) || (NULL == path))
1491 path_destroy (path);
1494 if (path->peers[path->length - 1] != peer->id)
1497 path_destroy (path);
1500 if (2 >= path->length && GNUNET_NO == trusted)
1502 /* Only allow CORE to tell us about direct paths */
1503 path_destroy (path);
1506 for (l = 1; l < path->length; l++)
1508 if (path->peers[l] == myid)
1510 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1511 for (l2 = 0; l2 < path->length - l; l2++)
1513 path->peers[l2] = path->peers[l + l2];
1517 path->peers = GNUNET_realloc (path->peers,
1518 path->length * sizeof (GNUNET_PEER_Id));
1522 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u]\n", path->length);
1524 l = path_get_length (path);
1527 path_destroy (path);
1531 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1532 for (aux = peer->path_head; aux != NULL; aux = aux->next)
1534 l2 = path_get_length (aux);
1537 LOG (GNUNET_ERROR_TYPE_DEBUG, " added\n");
1538 GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1539 peer->path_tail, aux, path);
1544 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1546 LOG (GNUNET_ERROR_TYPE_DEBUG, " already known\n");
1547 path_destroy (path);
1552 GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1554 LOG (GNUNET_ERROR_TYPE_DEBUG, " added last\n");
1560 * Add the path to the origin peer and update the path used to reach it in case
1561 * this is the shortest.
1562 * The path is given in peer_info -> destination, therefore we turn the path
1563 * upside down first.
1565 * @param peer Peer to add the path to, being the origin of the path.
1566 * @param path New path to add after being inversed.
1567 * Path will be either used or freed.
1568 * @param trusted Do we trust that this path is real?
1570 * @return path if path was taken, pointer to existing duplicate if exists
1573 struct MeshPeerPath *
1574 GMP_add_path_to_origin (struct MeshPeer *peer,
1575 struct MeshPeerPath *path,
1581 return GMP_add_path (peer, path, trusted);
1586 * Adds a path to the info of all the peers in the path
1588 * @param p Path to process.
1589 * @param confirmed Whether we know if the path works or not.
1592 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1596 /* TODO: invert and add */
1597 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1598 for (i++; i < p->length; i++)
1600 struct MeshPeer *aux;
1601 struct MeshPeerPath *copy;
1603 aux = GMP_get_short (p->peers[i]);
1604 copy = path_duplicate (p);
1605 copy->length = i + 1;
1606 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1612 * Remove any path to the peer that has the extact same peers as the one given.
1614 * @param peer Peer to remove the path from.
1615 * @param path Path to remove. Is always destroyed .
1618 GMP_remove_path (struct MeshPeer *peer, struct MeshPeerPath *path)
1620 struct MeshPeerPath *iter;
1621 struct MeshPeerPath *next;
1623 GNUNET_assert (myid == path->peers[0]);
1624 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1626 for (iter = peer->path_head; NULL != iter; iter = next)
1629 if (0 == memcmp (path->peers, iter->peers,
1630 sizeof (GNUNET_PEER_Id) * path->length))
1632 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, iter);
1633 path_destroy (iter);
1638 path_destroy (path);
1643 * Remove a connection from a neighboring peer.
1645 * @param peer Peer to remove connection from.
1646 * @param c Connection to remove.
1648 * @return GNUNET_OK on success.
1651 GMP_remove_connection (struct MeshPeer *peer,
1652 const struct MeshConnection *c)
1654 LOG (GNUNET_ERROR_TYPE_DEBUG,
1655 "removing connection %s from peer %s\n",
1656 GMC_2s (c), GMP_2s (peer));
1657 if (NULL == peer || NULL == peer->connections)
1659 LOG (GNUNET_ERROR_TYPE_DEBUG,
1660 "Peer %s is not a neighbor!\n",
1662 return GNUNET_SYSERR;
1664 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1670 * Start the DHT search for new paths towards the peer: we don't have
1671 * enough good connections.
1673 * @param peer Destination peer.
1676 GMP_start_search (struct MeshPeer *peer)
1678 if (NULL != peer->search_h)
1684 peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1689 * Stop the DHT search for new paths towards the peer: we already have
1690 * enough good connections.
1692 * @param peer Destination peer.
1695 GMP_stop_search (struct MeshPeer *peer)
1697 if (NULL == peer->search_h)
1703 GMD_search_stop (peer->search_h);
1704 peer->search_h = NULL;
1709 * Get the Full ID of a peer.
1711 * @param peer Peer to get from.
1713 * @return Full ID of peer.
1715 const struct GNUNET_PeerIdentity *
1716 GMP_get_id (const struct MeshPeer *peer)
1718 return GNUNET_PEER_resolve2 (peer->id);
1723 * Get the Short ID of a peer.
1725 * @param peer Peer to get from.
1727 * @return Short ID of peer.
1730 GMP_get_short_id (const struct MeshPeer *peer)
1737 * Get the tunnel towards a peer.
1739 * @param peer Peer to get from.
1741 * @return Tunnel towards peer.
1743 struct MeshTunnel3 *
1744 GMP_get_tunnel (const struct MeshPeer *peer)
1746 GNUNET_assert (NULL != peer->tunnel);
1747 return peer->tunnel;
1752 * Get the static string for a peer ID.
1756 * @return Static string for it's ID.
1759 GMP_2s (const struct MeshPeer *peer)
1763 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));