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 * Remove the direct path to the peer.
239 * @param peer Peer to remove the direct path from.
242 static struct MeshPeerPath *
243 pop_direct_path (struct MeshPeer *peer)
245 struct MeshPeerPath *iter;
247 for (iter = peer->path_head; NULL != iter; iter = iter->next)
249 if (2 <= iter->length)
251 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, iter);
261 * Method called whenever a given peer connects.
264 * @param peer peer identity this notification is about
267 core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
270 struct MeshPeerPath *path;
272 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer connected\n");
273 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&my_full_id));
277 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self)\n");
282 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (peer));
284 path->peers[1] = mp->id;
285 GNUNET_PEER_change_rc (mp->id, 1);
286 GNUNET_STATISTICS_update (stats, "# peers", 1, GNUNET_NO);
288 path->peers[0] = myid;
289 GNUNET_PEER_change_rc (myid, 1);
290 GMP_add_path (mp, path, GNUNET_YES);
292 mp->connections = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_YES);
298 * Method called whenever a peer disconnects.
301 * @param peer peer identity this notification is about
304 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
307 struct MeshPeerPath *direct_path;
309 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer disconnected\n");
310 p = GNUNET_CONTAINER_multipeermap_get (peers, peer);
317 LOG (GNUNET_ERROR_TYPE_DEBUG, " (self: %s)\n", GMP_2s (p));
319 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GMP_2s (p));
321 direct_path = pop_direct_path (p);
322 GNUNET_CONTAINER_multihashmap_iterate (p->connections, ¬ify_broken, p);
323 GNUNET_CONTAINER_multihashmap_destroy (p->connections);
324 p->connections = NULL;
325 if (NULL != p->core_transmit)
327 GNUNET_CORE_notify_transmit_ready_cancel (p->core_transmit);
328 p->core_transmit = NULL;
330 GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
332 path_destroy (direct_path);
338 * Functions to handle messages from core
340 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
341 {&GMC_handle_create, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE,
343 {&GMC_handle_confirm, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
344 sizeof (struct GNUNET_MESH_ConnectionACK)},
345 {&GMC_handle_broken, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
346 sizeof (struct GNUNET_MESH_ConnectionBroken)},
347 {&GMC_handle_destroy, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY,
348 sizeof (struct GNUNET_MESH_ConnectionDestroy)},
349 {&GMC_handle_keepalive, GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE,
350 sizeof (struct GNUNET_MESH_ConnectionKeepAlive)},
351 {&GMC_handle_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
352 sizeof (struct GNUNET_MESH_ACK)},
353 {&GMC_handle_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
354 sizeof (struct GNUNET_MESH_Poll)},
355 {&GMC_handle_encrypted, GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED, 0},
356 {&GMC_handle_kx, GNUNET_MESSAGE_TYPE_MESH_KX, 0},
362 * To be called on core init/fail.
364 * @param cls Closure (config)
365 * @param identity the public identity of this peer
368 core_init (void *cls,
369 const struct GNUNET_PeerIdentity *identity)
371 const struct GNUNET_CONFIGURATION_Handle *c = cls;
374 LOG (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
375 if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)))
377 LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
378 LOG (GNUNET_ERROR_TYPE_ERROR, " core id %s\n", GNUNET_i2s (identity));
379 LOG (GNUNET_ERROR_TYPE_ERROR, " my id %s\n", GNUNET_i2s (&my_full_id));
380 GNUNET_CORE_disconnect (core_handle);
381 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
382 NULL, /* Closure passed to MESH functions */
383 &core_init, /* Call core_init once connected */
384 &core_connect, /* Handle connects */
385 &core_disconnect, /* remove peers on disconnects */
386 NULL, /* Don't notify about all incoming messages */
387 GNUNET_NO, /* For header only in notification */
388 NULL, /* Don't notify about all outbound messages */
389 GNUNET_NO, /* For header-only out notification */
390 core_handlers); /* Register these handlers */
399 * Core callback to write a pre-constructed data packet to core buffer
401 * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
402 * @param size Number of bytes available in buf.
403 * @param buf Where the to write the message.
405 * @return number of bytes written to buf
408 send_core_data_raw (void *cls, size_t size, void *buf)
410 struct GNUNET_MessageHeader *msg = cls;
413 GNUNET_assert (NULL != msg);
414 total_size = ntohs (msg->size);
416 if (total_size > size)
421 memcpy (buf, msg, total_size);
428 * Function to send a create connection message to a peer.
430 * @param c Connection to create.
431 * @param size number of bytes available in buf
432 * @param buf where the callee should write the message
433 * @return number of bytes written to buf
436 send_core_connection_create (struct MeshConnection *c, size_t size, void *buf)
438 struct GNUNET_MESH_ConnectionCreate *msg;
439 struct GNUNET_PeerIdentity *peer_ptr;
440 const struct MeshPeerPath *p = GMC_get_path (c);
447 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
449 sizeof (struct GNUNET_MESH_ConnectionCreate) +
450 p->length * sizeof (struct GNUNET_PeerIdentity);
452 if (size < size_needed || NULL == buf)
457 msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
458 msg->header.size = htons (size_needed);
459 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
460 msg->cid = *GMC_get_id (c);
462 peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
463 for (i = 0; i < p->length; i++)
465 GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
468 LOG (GNUNET_ERROR_TYPE_DEBUG,
469 "CONNECTION CREATE (%u bytes long) sent!\n",
476 * Creates a path ack message in buf and frees all unused resources.
478 * @param c Connection to send an ACK on.
479 * @param size number of bytes available in buf
480 * @param buf where the callee should write the message
482 * @return number of bytes written to buf
485 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
487 struct GNUNET_MESH_ConnectionACK *msg = buf;
489 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
490 if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
495 msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
496 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
497 msg->cid = *GMC_get_id (c);
500 /* TODO add signature */
502 LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
503 return sizeof (struct GNUNET_MESH_ConnectionACK);
507 /******************************************************************************/
508 /******************************** STATIC ***********************************/
509 /******************************************************************************/
512 * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
515 * @param key current key code
516 * @param value value in the hash map
517 * @return #GNUNET_YES if we should continue to iterate,
521 shutdown_tunnel (void *cls,
522 const struct GNUNET_PeerIdentity *key,
525 struct MeshPeer *p = value;
526 struct MeshTunnel3 *t = p->tunnel;
536 * Destroy the peer_info and free any allocated resources linked to it
538 * @param peer The peer_info to destroy.
540 * @return GNUNET_OK on success
543 peer_destroy (struct MeshPeer *peer)
545 struct GNUNET_PeerIdentity id;
546 struct MeshPeerPath *p;
547 struct MeshPeerPath *nextp;
549 GNUNET_PEER_resolve (peer->id, &id);
550 GNUNET_PEER_change_rc (peer->id, -1);
552 LOG (GNUNET_ERROR_TYPE_WARNING, "destroying peer %s\n", GNUNET_i2s (&id));
555 GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
558 LOG (GNUNET_ERROR_TYPE_WARNING, " not in peermap!!\n");
560 if (NULL != peer->search_h)
562 GMD_search_stop (peer->search_h);
568 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
572 GMT_destroy_empty (peer->tunnel);
579 * Returns if peer is used (has a tunnel or is neighbor).
581 * @param peer Peer to check.
583 * @return #GNUNET_YES if peer is in use.
586 peer_is_used (struct MeshPeer *peer)
588 struct MeshPeerPath *p;
590 if (NULL != peer->tunnel)
593 for (p = peer->path_head; NULL != p; p = p->next)
603 * Iterator over all the peers to get the oldest timestamp.
605 * @param cls Closure (unsued).
606 * @param key ID of the peer.
607 * @param value Peer_Info of the peer.
610 peer_get_oldest (void *cls,
611 const struct GNUNET_PeerIdentity *key,
614 struct MeshPeer *p = value;
615 struct GNUNET_TIME_Absolute *abs = cls;
617 /* Don't count active peers */
618 if (GNUNET_YES == peer_is_used (p))
621 if (abs->abs_value_us < p->last_contact.abs_value_us)
622 abs->abs_value_us = p->last_contact.abs_value_us;
629 * Iterator over all the peers to remove the oldest entry.
631 * @param cls Closure (unsued).
632 * @param key ID of the peer.
633 * @param value Peer_Info of the peer.
636 peer_timeout (void *cls,
637 const struct GNUNET_PeerIdentity *key,
640 struct MeshPeer *p = value;
641 struct GNUNET_TIME_Absolute *abs = cls;
643 LOG (GNUNET_ERROR_TYPE_WARNING,
644 "peer %s timeout\n", GNUNET_i2s (key));
646 if (p->last_contact.abs_value_us == abs->abs_value_us &&
647 GNUNET_NO == peer_is_used (p))
657 * Delete oldest unused peer.
660 peer_delete_oldest (void)
662 struct GNUNET_TIME_Absolute abs;
664 abs = GNUNET_TIME_UNIT_FOREVER_ABS;
666 GNUNET_CONTAINER_multipeermap_iterate (peers,
669 GNUNET_CONTAINER_multipeermap_iterate (peers,
676 * Choose the best (yet unused) path towards a peer,
677 * considering the tunnel properties.
679 * @param peer The destination peer.
681 * @return Best current known path towards the peer, if any.
683 static struct MeshPeerPath *
684 peer_get_best_path (const struct MeshPeer *peer)
686 struct MeshPeerPath *best_p;
687 struct MeshPeerPath *p;
688 unsigned int best_cost;
691 best_cost = UINT_MAX;
693 for (p = peer->path_head; NULL != p; p = p->next)
695 if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
696 continue; /* If path is already in use, skip it. */
698 if (GNUNET_NO == path_is_valid (p))
699 continue; /* Don't use invalid paths. */
701 if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
712 queue_is_sendable (struct MeshPeerQueue *q)
714 /* Is PID-independent? */
717 case GNUNET_MESSAGE_TYPE_MESH_ACK:
718 case GNUNET_MESSAGE_TYPE_MESH_POLL:
719 case GNUNET_MESSAGE_TYPE_MESH_KX:
720 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
721 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
722 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
723 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
724 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
727 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
734 if (GMC_is_sendable (q->c, q->fwd))
742 * Get first sendable message.
744 * @param peer The destination peer.
746 * @return Best current known path towards the peer, if any.
748 static struct MeshPeerQueue *
749 peer_get_first_message (const struct MeshPeer *peer)
751 struct MeshPeerQueue *q;
753 for (q = peer->queue_head; NULL != q; q = q->next)
755 if (queue_is_sendable (q))
764 * Function to process paths received for a new peer addition. The recorded
765 * paths form the initial tunnel, which can be optimized later.
766 * Called on each result obtained for the DHT search.
772 search_handler (void *cls, const struct MeshPeerPath *path)
774 struct MeshPeer *peer = cls;
775 unsigned int connection_count;
777 GMP_add_path_to_all (path, GNUNET_NO);
779 /* Count connections */
780 connection_count = GMT_count_connections (peer->tunnel);
782 /* If we already have 3 (or more (?!)) connections, it's enough */
783 if (3 <= connection_count)
786 if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (peer->tunnel))
788 LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
796 * Core callback to write a queued packet to core buffer
798 * @param cls Closure (peer info).
799 * @param size Number of bytes available in buf.
800 * @param buf Where the to write the message.
802 * @return number of bytes written to buf
805 queue_send (void *cls, size_t size, void *buf)
807 struct MeshPeer *peer = cls;
808 struct MeshConnection *c;
809 struct MeshPeerQueue *queue;
810 const struct GNUNET_PeerIdentity *dst_id;
813 peer->core_transmit = NULL;
814 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send towards %s (max %u)\n",
815 GMP_2s (peer), size);
817 if (NULL == buf || 0 == size)
819 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
824 queue = peer_get_first_message (peer);
827 GNUNET_break (0); /* Core tmt_rdy should've been canceled */
832 dst_id = GNUNET_PEER_resolve2 (peer->id);
833 LOG (GNUNET_ERROR_TYPE_DEBUG, "* on connection %s\n", GMC_2s (c));
834 /* Check if buffer size is enough for the message */
835 if (queue->size > size)
837 LOG (GNUNET_ERROR_TYPE_DEBUG, "* not enough room, reissue\n");
838 peer->core_transmit =
839 GNUNET_CORE_notify_transmit_ready (core_handle,
842 GNUNET_TIME_UNIT_FOREVER_REL,
849 LOG (GNUNET_ERROR_TYPE_DEBUG, "* size %u ok\n", queue->size);
854 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
855 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
856 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
857 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
858 case GNUNET_MESSAGE_TYPE_MESH_KX:
859 case GNUNET_MESSAGE_TYPE_MESH_ACK:
860 case GNUNET_MESSAGE_TYPE_MESH_POLL:
861 LOG (GNUNET_ERROR_TYPE_DEBUG, "* raw: %s\n", GM_m2s (queue->type));
862 data_size = send_core_data_raw (queue->cls, size, buf);
864 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
865 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path create\n");
866 if (GMC_is_origin (c, GNUNET_YES))
867 data_size = send_core_connection_create (queue->c, size, buf);
869 data_size = send_core_data_raw (queue->cls, size, buf);
871 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
872 LOG (GNUNET_ERROR_TYPE_DEBUG, "* path ack\n");
873 if (GMC_is_origin (c, GNUNET_NO) ||
874 GMC_is_origin (c, GNUNET_YES))
875 data_size = send_core_connection_ack (queue->c, size, buf);
877 data_size = send_core_data_raw (queue->cls, size, buf);
879 case GNUNET_MESSAGE_TYPE_MESH_DATA:
880 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
881 case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
882 /* This should be encapsulted */
888 LOG (GNUNET_ERROR_TYPE_WARNING, "* type unknown: %u\n", queue->type);
892 if (0 < drop_percent &&
893 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
895 LOG (GNUNET_ERROR_TYPE_WARNING,
896 "Dropping message of type %s\n",
897 GM_m2s (queue->type));
901 /* Free queue, but cls was freed by send_core_* */
902 GMP_queue_destroy (queue, GNUNET_NO);
904 /* If more data in queue, send next */
905 queue = peer_get_first_message (peer);
908 LOG (GNUNET_ERROR_TYPE_DEBUG, "* more data!\n");
909 if (NULL == peer->core_transmit)
911 peer->core_transmit =
912 GNUNET_CORE_notify_transmit_ready (core_handle,
914 GNUNET_TIME_UNIT_FOREVER_REL,
919 queue->start_waiting = GNUNET_TIME_absolute_get ();
923 LOG (GNUNET_ERROR_TYPE_DEBUG,
924 "* tmt rdy called somewhere else\n");
926 // GMC_start_poll (); FIXME needed?
930 // GMC_stop_poll(); FIXME needed?
933 LOG (GNUNET_ERROR_TYPE_DEBUG, "* Return %d\n", data_size);
938 /******************************************************************************/
939 /******************************** API ***********************************/
940 /******************************************************************************/
944 * Free a transmission that was already queued with all resources
945 * associated to the request.
947 * @param queue Queue handler to cancel.
948 * @param clear_cls Is it necessary to free associated cls?
951 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
953 struct MeshPeer *peer;
957 if (GNUNET_YES == clear_cls)
959 LOG (GNUNET_ERROR_TYPE_DEBUG, "# queue destroy type %s\n",
960 GM_m2s (queue->type));
963 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
964 LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
966 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
967 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
968 case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
969 case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
970 case GNUNET_MESSAGE_TYPE_MESH_KX:
971 case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
972 case GNUNET_MESSAGE_TYPE_MESH_ACK:
973 case GNUNET_MESSAGE_TYPE_MESH_POLL:
974 GNUNET_free_non_null (queue->cls);
979 LOG (GNUNET_ERROR_TYPE_ERROR, "# type %s unknown!\n",
980 GM_m2s (queue->type));
983 GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
985 if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
986 queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
991 if (NULL != queue->callback)
993 LOG (GNUNET_ERROR_TYPE_DEBUG, "# Calling callback\n");
994 queue->callback (queue->callback_cls,
995 queue->c, queue->type,
996 queue->fwd, queue->size,
997 GNUNET_TIME_absolute_get_duration (queue->start_waiting));
1000 GNUNET_free (queue);
1005 * @brief Queue and pass message to core when possible.
1007 * @param peer Peer towards which to queue the message.
1008 * @param cls Closure (@c type dependant). It will be used by queue_send to
1009 * build the message to be sent if not already prebuilt.
1010 * @param type Type of the message, 0 for a raw message.
1011 * @param size Size of the message.
1012 * @param c Connection this message belongs to (can be NULL).
1013 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
1014 * @param cont Continuation to be called once CORE has taken the message.
1015 * @param cont_cls Closure for @c cont.
1017 * @return Handle to cancel the message before it is sent. Once cont is called
1018 * message has been sent and therefore the handle is no longer valid.
1020 struct MeshPeerQueue *
1021 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
1022 struct MeshConnection *c, int fwd,
1023 GMP_sent cont, void *cont_cls)
1025 struct MeshPeerQueue *queue;
1029 LOG (GNUNET_ERROR_TYPE_DEBUG,
1030 "queue add %s %s towards %s (size %u) on c %p (%s)\n",
1031 GM_f2s (fwd), GM_m2s (type), GMP_2s(peer),
1032 size, c, GMC_2s (c));
1034 if (NULL == peer->connections)
1036 /* We are not connected to this peer, ignore request. */
1037 LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING %s not a neighbor\n", GMP_2s (peer));
1038 GNUNET_STATISTICS_update (stats, "# messages dropped due to wrong hop", 1,
1045 if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1046 GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1051 LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1053 call_core = NULL == c ? GNUNET_YES : GMC_is_sendable (c, fwd);
1054 queue = GNUNET_new (struct MeshPeerQueue);
1061 queue->callback = cont;
1062 queue->callback_cls = cont_cls;
1065 GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1070 GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1071 call_core = GNUNET_YES;
1074 if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1076 LOG (GNUNET_ERROR_TYPE_DEBUG,
1077 "calling core tmt rdy towards %s for %u bytes\n",
1078 GMP_2s (peer), size);
1079 peer->core_transmit =
1080 GNUNET_CORE_notify_transmit_ready (core_handle,
1083 GNUNET_TIME_UNIT_FOREVER_REL,
1084 GNUNET_PEER_resolve2 (peer->id),
1088 queue->start_waiting = GNUNET_TIME_absolute_get ();
1092 LOG (GNUNET_ERROR_TYPE_DEBUG,
1093 "core tmt rdy towards %s already called\n",
1102 * Cancel all queued messages to a peer that belong to a certain connection.
1104 * @param peer Peer towards whom to cancel.
1105 * @param c Connection whose queued messages to cancel. Might be destroyed by
1106 * the sent continuation call.
1109 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1111 struct MeshPeerQueue *q;
1112 struct MeshPeerQueue *next;
1113 struct MeshPeerQueue *prev;
1115 for (q = peer->queue_head; NULL != q; q = next)
1120 LOG (GNUNET_ERROR_TYPE_DEBUG, "GMP_cancel_queue %s\n", GM_m2s (q->type));
1121 GMP_queue_destroy (q, GNUNET_YES);
1123 /* Get next from prev, q->next might be already freed:
1124 * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1127 next = peer->queue_head;
1136 if (NULL == peer->queue_head)
1138 if (NULL != peer->core_transmit)
1140 GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1141 peer->core_transmit = NULL;
1148 * Get the first transmittable message for a connection.
1150 * @param peer Neighboring peer.
1151 * @param c Connection.
1153 * @return First transmittable message.
1155 static struct MeshPeerQueue *
1156 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1158 struct MeshPeerQueue *q;
1160 for (q = peer->queue_head; NULL != q; q = q->next)
1164 if (queue_is_sendable (q))
1166 LOG (GNUNET_ERROR_TYPE_DEBUG, " sendable!!\n");
1169 LOG (GNUNET_ERROR_TYPE_DEBUG, " not sendable\n");
1177 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1179 struct MeshPeerQueue *q;
1182 if (NULL != peer->core_transmit)
1184 LOG (GNUNET_ERROR_TYPE_DEBUG, " already unlocked!\n");
1185 return; /* Already unlocked */
1188 q = connection_get_first_message (peer, c);
1191 LOG (GNUNET_ERROR_TYPE_DEBUG, " queue empty!\n");
1192 return; /* Nothing to transmit */
1196 peer->core_transmit =
1197 GNUNET_CORE_notify_transmit_ready (core_handle,
1200 GNUNET_TIME_UNIT_FOREVER_REL,
1201 GNUNET_PEER_resolve2 (peer->id),
1209 * Initialize the peer subsystem.
1211 * @param c Configuration.
1214 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1216 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1217 peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1219 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1222 GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1223 "MESH", "MAX_PEERS", "USING DEFAULT");
1228 GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1235 LOG (GNUNET_ERROR_TYPE_WARNING,
1236 "\n***************************************\n"
1237 "Mesh is running with drop mode enabled.\n"
1238 "This is NOT a good idea!\n"
1239 "Remove the DROP_PERCENT option from your configuration.\n"
1240 "***************************************\n");
1243 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1244 NULL, /* Closure passed to MESH functions */
1245 &core_init, /* Call core_init once connected */
1246 &core_connect, /* Handle connects */
1247 &core_disconnect, /* remove peers on disconnects */
1248 NULL, /* Don't notify about all incoming messages */
1249 GNUNET_NO, /* For header only in notification */
1250 NULL, /* Don't notify about all outbound messages */
1251 GNUNET_NO, /* For header-only out notification */
1252 core_handlers); /* Register these handlers */
1253 if (NULL == core_handle)
1256 GNUNET_SCHEDULER_shutdown ();
1262 * Shut down the peer subsystem.
1267 GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1269 if (core_handle != NULL)
1271 GNUNET_CORE_disconnect (core_handle);
1274 GNUNET_PEER_change_rc (myid, -1);
1278 * Retrieve the MeshPeer stucture associated with the peer, create one
1279 * and insert it in the appropriate structures if the peer is not known yet.
1281 * @param peer_id Full identity of the peer.
1283 * @return Existing or newly created peer structure.
1286 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1288 struct MeshPeer *peer;
1290 peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1293 peer = GNUNET_new (struct MeshPeer);
1294 if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1296 peer_delete_oldest ();
1298 GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1299 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1300 peer->id = GNUNET_PEER_intern (peer_id);
1302 peer->last_contact = GNUNET_TIME_absolute_get();
1309 * Retrieve the MeshPeer stucture associated with the peer, create one
1310 * and insert it in the appropriate structures if the peer is not known yet.
1312 * @param peer Short identity of the peer.
1314 * @return Existing or newly created peer structure.
1317 GMP_get_short (const GNUNET_PEER_Id peer)
1319 return GMP_get (GNUNET_PEER_resolve2 (peer));
1324 * Try to establish a new connection to this peer (in its tunnel).
1325 * If the peer doesn't have any path to it yet, try to get one.
1326 * If the peer already has some path, send a CREATE CONNECTION towards it.
1328 * @param peer Peer to connect to.
1331 GMP_connect (struct MeshPeer *peer)
1333 struct MeshTunnel3 *t;
1334 struct MeshPeerPath *p;
1335 struct MeshConnection *c;
1338 LOG (GNUNET_ERROR_TYPE_DEBUG, "peer_connect towards %s\n", GMP_2s (peer));
1341 rerun_search = GNUNET_NO;
1343 if (NULL != peer->path_head)
1345 LOG (GNUNET_ERROR_TYPE_DEBUG, " some path exists\n");
1346 p = peer_get_best_path (peer);
1349 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u hops\n", p->length);
1350 c = GMT_use_path (t, p);
1353 /* This case can happen when the path includes a first hop that is
1354 * not yet known to be connected.
1356 * This happens quite often during testing when running mesh
1357 * under valgrind: core connect notifications come very late and the
1358 * DHT result has already come and created a valid path.
1359 * In this case, the peer->connections hashmap will be NULL and
1360 * tunnel_use_path will not be able to create a connection from that
1363 * Re-running the DHT GET should give core time to callback.
1365 * GMT_use_path -> GMC_new -> register_neighbors takes care of
1366 * updating statistics about this issue.
1368 rerun_search = GNUNET_YES;
1372 GMC_send_create (c);
1378 LOG (GNUNET_ERROR_TYPE_DEBUG, " but is NULL, all paths are in use\n");
1382 if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1384 GMD_search_stop (peer->search_h);
1385 peer->search_h = NULL;
1386 LOG (GNUNET_ERROR_TYPE_DEBUG,
1387 " Stopping DHT GET for peer %s\n",
1391 if (NULL == peer->search_h)
1393 const struct GNUNET_PeerIdentity *id;
1395 id = GNUNET_PEER_resolve2 (peer->id);
1396 LOG (GNUNET_ERROR_TYPE_DEBUG,
1397 " Starting DHT GET for peer %s\n", GMP_2s (peer));
1398 peer->search_h = GMD_search (id, &search_handler, peer);
1399 if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
1400 GMT_change_cstate (t, MESH_TUNNEL3_SEARCHING);
1412 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1419 * Chech whether there is a direct (core level) connection to peer.
1421 * @param peer Peer to check.
1423 * @return #GNUNET_YES if there is a direct connection.
1426 GMP_is_neighbor (const struct MeshPeer *peer)
1428 struct MeshPeerPath *path;
1430 if (NULL == peer->connections)
1433 for (path = peer->path_head; NULL != path; path = path->next)
1435 if (3 > path->length)
1439 /* Is not a neighbor but connections is not NULL, probably disconnecting */
1445 * Create and initialize a new tunnel towards a peer, in case it has none.
1446 * In case the peer already has a tunnel, nothing is done.
1448 * Does not generate any traffic, just creates the local data structures.
1450 * @param peer Peer towards which to create the tunnel.
1453 GMP_add_tunnel (struct MeshPeer *peer)
1455 if (NULL != peer->tunnel)
1457 peer->tunnel = GMT_new (peer);
1462 * Add a connection to a neighboring peer.
1464 * Store that the peer is the first hop of the connection in one
1465 * direction and that on peer disconnect the connection must be
1466 * notified and destroyed, for it will no longer be valid.
1468 * @param peer Peer to add connection to.
1469 * @param c Connection to add.
1471 * @return GNUNET_OK on success.
1474 GMP_add_connection (struct MeshPeer *peer,
1475 struct MeshConnection *c)
1478 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding connection %s\n", GMC_2s (c));
1479 LOG (GNUNET_ERROR_TYPE_DEBUG, "to peer %s\n", GMP_2s (peer));
1481 if (NULL == peer->connections)
1484 LOG (GNUNET_ERROR_TYPE_DEBUG,
1485 "Peer %s is not a neighbor!\n",
1487 return GNUNET_SYSERR;
1489 LOG (GNUNET_ERROR_TYPE_DEBUG,
1490 "peer %s ok, has %u connections.\n",
1491 GMP_2s (peer), GNUNET_CONTAINER_multihashmap_size (peer->connections));
1492 result = GNUNET_CONTAINER_multihashmap_put (peer->connections,
1495 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1496 LOG (GNUNET_ERROR_TYPE_DEBUG,
1497 " now has %u connections.\n",
1498 GNUNET_CONTAINER_multihashmap_size (peer->connections));
1499 LOG (GNUNET_ERROR_TYPE_DEBUG, "result %u\n", result);
1506 * Add the path to the peer and update the path used to reach it in case this
1509 * @param peer Destination peer to add the path to.
1510 * @param path New path to add. Last peer must be the peer in arg 1.
1511 * Path will be either used of freed if already known.
1512 * @param trusted Do we trust that this path is real?
1514 * @return path if path was taken, pointer to existing duplicate if exists
1517 struct MeshPeerPath *
1518 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1521 struct MeshPeerPath *aux;
1525 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1526 path->length, GMP_2s (peer));
1528 if ((NULL == peer) || (NULL == path))
1531 path_destroy (path);
1534 if (path->peers[path->length - 1] != peer->id)
1537 path_destroy (path);
1540 if (2 >= path->length && GNUNET_NO == trusted)
1542 /* Only allow CORE to tell us about direct paths */
1543 path_destroy (path);
1546 for (l = 1; l < path->length; l++)
1548 if (path->peers[l] == myid)
1550 LOG (GNUNET_ERROR_TYPE_DEBUG, "shortening path by %u\n", l);
1551 for (l2 = 0; l2 < path->length - l; l2++)
1553 path->peers[l2] = path->peers[l + l2];
1557 path->peers = GNUNET_realloc (path->peers,
1558 path->length * sizeof (GNUNET_PEER_Id));
1562 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u]\n", path->length);
1564 l = path_get_length (path);
1567 path_destroy (path);
1571 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1572 for (aux = peer->path_head; aux != NULL; aux = aux->next)
1574 l2 = path_get_length (aux);
1577 LOG (GNUNET_ERROR_TYPE_DEBUG, " added\n");
1578 GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1579 peer->path_tail, aux, path);
1584 if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1586 LOG (GNUNET_ERROR_TYPE_DEBUG, " already known\n");
1587 path_destroy (path);
1592 GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1594 LOG (GNUNET_ERROR_TYPE_DEBUG, " added last\n");
1600 * Add the path to the origin peer and update the path used to reach it in case
1601 * this is the shortest.
1602 * The path is given in peer_info -> destination, therefore we turn the path
1603 * upside down first.
1605 * @param peer Peer to add the path to, being the origin of the path.
1606 * @param path New path to add after being inversed.
1607 * Path will be either used or freed.
1608 * @param trusted Do we trust that this path is real?
1610 * @return path if path was taken, pointer to existing duplicate if exists
1613 struct MeshPeerPath *
1614 GMP_add_path_to_origin (struct MeshPeer *peer,
1615 struct MeshPeerPath *path,
1621 return GMP_add_path (peer, path, trusted);
1626 * Adds a path to the info of all the peers in the path
1628 * @param p Path to process.
1629 * @param confirmed Whether we know if the path works or not.
1632 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1636 /* TODO: invert and add */
1637 for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1638 for (i++; i < p->length; i++)
1640 struct MeshPeer *aux;
1641 struct MeshPeerPath *copy;
1643 aux = GMP_get_short (p->peers[i]);
1644 copy = path_duplicate (p);
1645 copy->length = i + 1;
1646 GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1652 * Remove any path to the peer that has the extact same peers as the one given.
1654 * @param peer Peer to remove the path from.
1655 * @param path Path to remove. Is always destroyed .
1658 GMP_remove_path (struct MeshPeer *peer, struct MeshPeerPath *path)
1660 struct MeshPeerPath *iter;
1661 struct MeshPeerPath *next;
1663 GNUNET_assert (myid == path->peers[0]);
1664 GNUNET_assert (peer->id == path->peers[path->length - 1]);
1666 for (iter = peer->path_head; NULL != iter; iter = next)
1669 if (0 == memcmp (path->peers, iter->peers,
1670 sizeof (GNUNET_PEER_Id) * path->length))
1672 GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, iter);
1673 path_destroy (iter);
1678 path_destroy (path);
1683 * Remove a connection from a neighboring peer.
1685 * @param peer Peer to remove connection from.
1686 * @param c Connection to remove.
1688 * @return GNUNET_OK on success.
1691 GMP_remove_connection (struct MeshPeer *peer,
1692 const struct MeshConnection *c)
1694 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing connection %s\n", GMC_2s (c));
1695 LOG (GNUNET_ERROR_TYPE_DEBUG, "from peer %s\n", GMP_2s (peer));
1697 if (NULL == peer || NULL == peer->connections)
1699 LOG (GNUNET_ERROR_TYPE_DEBUG,
1700 "Peer %s is not a neighbor!\n",
1702 return GNUNET_SYSERR;
1704 LOG (GNUNET_ERROR_TYPE_DEBUG,
1705 "peer %s ok, has %u connections.\n",
1706 GMP_2s (peer), GNUNET_CONTAINER_multihashmap_size (peer->connections));
1708 return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1714 * Start the DHT search for new paths towards the peer: we don't have
1715 * enough good connections.
1717 * @param peer Destination peer.
1720 GMP_start_search (struct MeshPeer *peer)
1722 if (NULL != peer->search_h)
1728 peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1733 * Stop the DHT search for new paths towards the peer: we already have
1734 * enough good connections.
1736 * @param peer Destination peer.
1739 GMP_stop_search (struct MeshPeer *peer)
1741 if (NULL == peer->search_h)
1747 GMD_search_stop (peer->search_h);
1748 peer->search_h = NULL;
1753 * Get the Full ID of a peer.
1755 * @param peer Peer to get from.
1757 * @return Full ID of peer.
1759 const struct GNUNET_PeerIdentity *
1760 GMP_get_id (const struct MeshPeer *peer)
1762 return GNUNET_PEER_resolve2 (peer->id);
1767 * Get the Short ID of a peer.
1769 * @param peer Peer to get from.
1771 * @return Short ID of peer.
1774 GMP_get_short_id (const struct MeshPeer *peer)
1781 * Get the tunnel towards a peer.
1783 * @param peer Peer to get from.
1785 * @return Tunnel towards peer.
1787 struct MeshTunnel3 *
1788 GMP_get_tunnel (const struct MeshPeer *peer)
1790 GNUNET_assert (NULL != peer->tunnel);
1791 return peer->tunnel;
1796 * Get the static string for a peer ID.
1800 * @return Static string for it's ID.
1803 GMP_2s (const struct MeshPeer *peer)
1807 return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));